Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 1 | // Copyright 2020 The Pigweed Authors |
| 2 | // |
| 3 | // Licensed under the Apache License, Version 2.0 (the "License"); you may not |
| 4 | // use this file except in compliance with the License. You may obtain a copy of |
| 5 | // the License at |
| 6 | // |
| 7 | // https://www.apache.org/licenses/LICENSE-2.0 |
| 8 | // |
| 9 | // Unless required by applicable law or agreed to in writing, software |
| 10 | // distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| 11 | // WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
| 12 | // License for the specific language governing permissions and limitations under |
| 13 | // the License. |
| 14 | |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 15 | #include "pw_kvs/key_value_store.h" |
| 16 | |
Wyatt Hepler | bab0e20 | 2020-02-04 07:40:08 -0800 | [diff] [blame] | 17 | #include <algorithm> |
Wyatt Hepler | 5a33d8c | 2020-02-06 09:32:58 -0800 | [diff] [blame] | 18 | #include <cinttypes> |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 19 | #include <cstring> |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 20 | #include <type_traits> |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 21 | |
Wyatt Hepler | 22d0d9f | 2020-03-05 14:57:11 -0800 | [diff] [blame] | 22 | #include "pw_kvs/format.h" |
| 23 | |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 24 | #define PW_LOG_USE_ULTRA_SHORT_NAMES 1 |
Wyatt Hepler | bdd8e5a | 2020-02-20 19:27:26 -0800 | [diff] [blame] | 25 | #include "pw_kvs/internal/entry.h" |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 26 | #include "pw_kvs_private/macros.h" |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 27 | #include "pw_log/log.h" |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 28 | |
Wyatt Hepler | 2ad6067 | 2020-01-21 08:00:16 -0800 | [diff] [blame] | 29 | namespace pw::kvs { |
Wyatt Hepler | a00d1ef | 2020-02-14 14:31:26 -0800 | [diff] [blame] | 30 | namespace { |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 31 | |
Wyatt Hepler | acaacf9 | 2020-01-24 10:58:30 -0800 | [diff] [blame] | 32 | using std::byte; |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 33 | using std::string_view; |
Wyatt Hepler | acaacf9 | 2020-01-24 10:58:30 -0800 | [diff] [blame] | 34 | |
Wyatt Hepler | a00d1ef | 2020-02-14 14:31:26 -0800 | [diff] [blame] | 35 | constexpr bool InvalidKey(std::string_view key) { |
Wyatt Hepler | bdd8e5a | 2020-02-20 19:27:26 -0800 | [diff] [blame] | 36 | return key.empty() || (key.size() > internal::Entry::kMaxKeyLength); |
Wyatt Hepler | a00d1ef | 2020-02-14 14:31:26 -0800 | [diff] [blame] | 37 | } |
| 38 | |
| 39 | } // namespace |
| 40 | |
Wyatt Hepler | ad0a793 | 2020-02-06 08:20:38 -0800 | [diff] [blame] | 41 | KeyValueStore::KeyValueStore(FlashPartition* partition, |
Wyatt Hepler | 38ce30f | 2020-02-19 11:48:31 -0800 | [diff] [blame] | 42 | Vector<KeyDescriptor>& key_descriptor_list, |
| 43 | Vector<SectorDescriptor>& sector_descriptor_list, |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 44 | size_t redundancy, |
Wyatt Hepler | 22d0d9f | 2020-03-05 14:57:11 -0800 | [diff] [blame] | 45 | span<const EntryFormat> formats, |
Wyatt Hepler | ad0a793 | 2020-02-06 08:20:38 -0800 | [diff] [blame] | 46 | const Options& options) |
| 47 | : partition_(*partition), |
Wyatt Hepler | 22d0d9f | 2020-03-05 14:57:11 -0800 | [diff] [blame] | 48 | formats_(formats), |
Wyatt Hepler | 38ce30f | 2020-02-19 11:48:31 -0800 | [diff] [blame] | 49 | key_descriptors_(key_descriptor_list), |
Wyatt Hepler | d229828 | 2020-02-20 17:12:45 -0800 | [diff] [blame] | 50 | sectors_(sector_descriptor_list), |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 51 | redundancy_(redundancy), |
Wyatt Hepler | d229828 | 2020-02-20 17:12:45 -0800 | [diff] [blame] | 52 | options_(options) { |
Keir Mierle | bf90481 | 2020-03-11 17:28:22 -0700 | [diff] [blame^] | 53 | initialized_ = false; |
| 54 | last_new_sector_ = nullptr; |
| 55 | last_transaction_id_ = 0; |
Wyatt Hepler | d229828 | 2020-02-20 17:12:45 -0800 | [diff] [blame] | 56 | } |
Wyatt Hepler | ad0a793 | 2020-02-06 08:20:38 -0800 | [diff] [blame] | 57 | |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 58 | Status KeyValueStore::Init() { |
Keir Mierle | bf90481 | 2020-03-11 17:28:22 -0700 | [diff] [blame^] | 59 | initialized_ = false; |
| 60 | last_new_sector_ = nullptr; |
| 61 | last_transaction_id_ = 0; |
| 62 | key_descriptors_.clear(); |
Wyatt Hepler | d229828 | 2020-02-20 17:12:45 -0800 | [diff] [blame] | 63 | |
David Rogers | 2e9e0c8 | 2020-02-13 15:06:06 -0800 | [diff] [blame] | 64 | INF("Initializing key value store"); |
Wyatt Hepler | 38ce30f | 2020-02-19 11:48:31 -0800 | [diff] [blame] | 65 | if (partition_.sector_count() > sectors_.max_size()) { |
David Rogers | 2e9e0c8 | 2020-02-13 15:06:06 -0800 | [diff] [blame] | 66 | ERR("KVS init failed: kMaxUsableSectors (=%zu) must be at least as " |
| 67 | "large as the number of sectors in the flash partition (=%zu)", |
Wyatt Hepler | 38ce30f | 2020-02-19 11:48:31 -0800 | [diff] [blame] | 68 | sectors_.max_size(), |
David Rogers | 2e9e0c8 | 2020-02-13 15:06:06 -0800 | [diff] [blame] | 69 | partition_.sector_count()); |
Wyatt Hepler | ad0a793 | 2020-02-06 08:20:38 -0800 | [diff] [blame] | 70 | return Status::FAILED_PRECONDITION; |
| 71 | } |
| 72 | |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 73 | const size_t sector_size_bytes = partition_.sector_size_bytes(); |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 74 | |
David Rogers | f0a3544 | 2020-02-04 12:16:38 -0800 | [diff] [blame] | 75 | if (working_buffer_.size() < sector_size_bytes) { |
Wyatt Hepler | ce7b8df | 2020-02-21 10:38:39 -0800 | [diff] [blame] | 76 | ERR("KVS init failed: working_buffer_ (%zu B) is smaller than sector size " |
| 77 | "(%zu B)", |
David Rogers | f0a3544 | 2020-02-04 12:16:38 -0800 | [diff] [blame] | 78 | working_buffer_.size(), |
| 79 | sector_size_bytes); |
| 80 | return Status::INVALID_ARGUMENT; |
| 81 | } |
| 82 | |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 83 | DBG("First pass: Read all entries from all sectors"); |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 84 | Address sector_address = 0; |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 85 | |
Wyatt Hepler | d229828 | 2020-02-20 17:12:45 -0800 | [diff] [blame] | 86 | sectors_.assign(partition_.sector_count(), |
| 87 | SectorDescriptor(sector_size_bytes)); |
| 88 | |
Alexei Frolov | d4adf91 | 2020-02-21 13:29:15 -0800 | [diff] [blame] | 89 | size_t total_corrupt_bytes = 0; |
| 90 | int corrupt_entries = 0; |
David Rogers | 9162748 | 2020-02-27 17:38:12 -0800 | [diff] [blame] | 91 | bool empty_sector_found = false; |
Alexei Frolov | d4adf91 | 2020-02-21 13:29:15 -0800 | [diff] [blame] | 92 | |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 93 | for (SectorDescriptor& sector : sectors_) { |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 94 | Address entry_address = sector_address; |
| 95 | |
Alexei Frolov | d4adf91 | 2020-02-21 13:29:15 -0800 | [diff] [blame] | 96 | size_t sector_corrupt_bytes = 0; |
| 97 | |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 98 | for (int num_entries_in_sector = 0; true; num_entries_in_sector++) { |
| 99 | DBG("Load entry: sector=%" PRIx32 ", entry#=%d, address=%" PRIx32, |
| 100 | sector_address, |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 101 | num_entries_in_sector, |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 102 | entry_address); |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 103 | |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 104 | if (!AddressInSector(sector, entry_address)) { |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 105 | DBG("Fell off end of sector; moving to the next sector"); |
| 106 | break; |
| 107 | } |
| 108 | |
| 109 | Address next_entry_address; |
| 110 | Status status = LoadEntry(entry_address, &next_entry_address); |
| 111 | if (status == Status::NOT_FOUND) { |
| 112 | DBG("Hit un-written data in sector; moving to the next sector"); |
| 113 | break; |
| 114 | } |
| 115 | if (status == Status::DATA_LOSS) { |
Alexei Frolov | d4adf91 | 2020-02-21 13:29:15 -0800 | [diff] [blame] | 116 | // The entry could not be read, indicating data corruption within the |
| 117 | // sector. Try to scan the remainder of the sector for other entries. |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 118 | WRN("KVS init: data loss detected in sector %u at address %zu", |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 119 | SectorIndex(§or), |
| 120 | size_t(entry_address)); |
Alexei Frolov | d4adf91 | 2020-02-21 13:29:15 -0800 | [diff] [blame] | 121 | |
| 122 | corrupt_entries++; |
| 123 | |
| 124 | status = ScanForEntry(sector, |
| 125 | entry_address + Entry::kMinAlignmentBytes, |
| 126 | &next_entry_address); |
| 127 | if (status == Status::NOT_FOUND) { |
| 128 | // No further entries in this sector. Mark the remaining bytes in the |
| 129 | // sector as corrupt (since we can't reliably know the size of the |
| 130 | // corrupt entry). |
| 131 | sector_corrupt_bytes += |
| 132 | sector_size_bytes - (entry_address - sector_address); |
| 133 | break; |
| 134 | } |
| 135 | |
| 136 | if (!status.ok()) { |
| 137 | ERR("Unexpected error in KVS initialization: %s", status.str()); |
| 138 | return Status::UNKNOWN; |
| 139 | } |
| 140 | |
| 141 | sector_corrupt_bytes += next_entry_address - entry_address; |
| 142 | } else if (!status.ok()) { |
| 143 | ERR("Unexpected error in KVS initialization: %s", status.str()); |
| 144 | return Status::UNKNOWN; |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 145 | } |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 146 | |
| 147 | // Entry loaded successfully; so get ready to load the next one. |
| 148 | entry_address = next_entry_address; |
| 149 | |
| 150 | // Update of the number of writable bytes in this sector. |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 151 | sector.set_writable_bytes(sector_size_bytes - |
| 152 | (entry_address - sector_address)); |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 153 | } |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 154 | |
Alexei Frolov | d4adf91 | 2020-02-21 13:29:15 -0800 | [diff] [blame] | 155 | if (sector_corrupt_bytes > 0) { |
| 156 | // If the sector contains corrupt data, prevent any further entries from |
| 157 | // being written to it by indicating that it has no space. This should |
| 158 | // also make it a decent GC candidate. Valid keys in the sector are still |
| 159 | // readable as normal. |
| 160 | sector.set_writable_bytes(0); |
| 161 | |
| 162 | WRN("Sector %u contains %zuB of corrupt data", |
| 163 | SectorIndex(§or), |
| 164 | sector_corrupt_bytes); |
| 165 | } |
| 166 | |
David Rogers | 9162748 | 2020-02-27 17:38:12 -0800 | [diff] [blame] | 167 | if (sector.Empty(sector_size_bytes)) { |
| 168 | empty_sector_found = true; |
| 169 | } |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 170 | sector_address += sector_size_bytes; |
Alexei Frolov | d4adf91 | 2020-02-21 13:29:15 -0800 | [diff] [blame] | 171 | total_corrupt_bytes += sector_corrupt_bytes; |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 172 | } |
| 173 | |
| 174 | DBG("Second pass: Count valid bytes in each sector"); |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 175 | const KeyDescriptor* newest_key = nullptr; |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 176 | |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 177 | // For every valid key, increment the valid bytes for that sector. |
Wyatt Hepler | 1c329ca | 2020-02-07 18:07:23 -0800 | [diff] [blame] | 178 | for (KeyDescriptor& key_descriptor : key_descriptors_) { |
David Rogers | f56131c | 2020-03-04 10:19:22 -0800 | [diff] [blame] | 179 | for (auto& address : key_descriptor.addresses()) { |
| 180 | Entry entry; |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 181 | TRY(Entry::Read(partition_, address, formats_, &entry)); |
David Rogers | f56131c | 2020-03-04 10:19:22 -0800 | [diff] [blame] | 182 | SectorFromAddress(address)->AddValidBytes(entry.size()); |
| 183 | } |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 184 | if (key_descriptor.IsNewerThan(last_transaction_id_)) { |
| 185 | last_transaction_id_ = key_descriptor.transaction_id(); |
| 186 | newest_key = &key_descriptor; |
| 187 | } |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 188 | } |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 189 | |
| 190 | if (newest_key == nullptr) { |
| 191 | last_new_sector_ = sectors_.begin(); |
| 192 | } else { |
David Rogers | f56131c | 2020-03-04 10:19:22 -0800 | [diff] [blame] | 193 | last_new_sector_ = SectorFromAddress(newest_key->addresses().back()); |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 194 | } |
| 195 | |
David Rogers | 9162748 | 2020-02-27 17:38:12 -0800 | [diff] [blame] | 196 | if (!empty_sector_found) { |
| 197 | // TODO: Record/report the error condition and recovery result. |
| 198 | Status gc_result = GarbageCollectPartial(); |
| 199 | |
| 200 | if (!gc_result.ok()) { |
| 201 | ERR("KVS init failed: Unable to maintain required free sector"); |
| 202 | return Status::INTERNAL; |
| 203 | } |
| 204 | } |
| 205 | |
Wyatt Hepler | 729f28c | 2020-02-05 09:46:00 -0800 | [diff] [blame] | 206 | initialized_ = true; |
David Rogers | 2e9e0c8 | 2020-02-13 15:06:06 -0800 | [diff] [blame] | 207 | |
Armando Montanez | 5464d5f | 2020-02-20 10:12:20 -0800 | [diff] [blame] | 208 | INF("KeyValueStore init complete: active keys %zu, deleted keys %zu, sectors " |
David Rogers | 2e9e0c8 | 2020-02-13 15:06:06 -0800 | [diff] [blame] | 209 | "%zu, logical sector size %zu bytes", |
| 210 | size(), |
| 211 | (key_descriptors_.size() - size()), |
| 212 | sectors_.size(), |
| 213 | partition_.sector_size_bytes()); |
| 214 | |
Alexei Frolov | d4adf91 | 2020-02-21 13:29:15 -0800 | [diff] [blame] | 215 | if (total_corrupt_bytes > 0) { |
| 216 | WRN("Found %zu corrupt bytes and %d corrupt entries during init process; " |
| 217 | "some keys may be missing", |
| 218 | total_corrupt_bytes, |
| 219 | corrupt_entries); |
| 220 | return Status::DATA_LOSS; |
| 221 | } |
| 222 | |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 223 | return Status::OK; |
| 224 | } |
| 225 | |
Alexei Frolov | 9e23583 | 2020-02-24 12:44:45 -0800 | [diff] [blame] | 226 | KeyValueStore::StorageStats KeyValueStore::GetStorageStats() const { |
| 227 | StorageStats stats{0, 0, 0}; |
| 228 | const size_t sector_size = partition_.sector_size_bytes(); |
| 229 | bool found_empty_sector = false; |
| 230 | |
| 231 | for (const SectorDescriptor& sector : sectors_) { |
| 232 | stats.in_use_bytes += sector.valid_bytes(); |
| 233 | stats.reclaimable_bytes += sector.RecoverableBytes(sector_size); |
| 234 | |
| 235 | if (!found_empty_sector && sector.Empty(sector_size)) { |
| 236 | // The KVS tries to always keep an empty sector for GC, so don't count |
| 237 | // the first empty sector seen as writable space. However, a free sector |
| 238 | // cannot always be assumed to exist; if a GC operation fails, all sectors |
| 239 | // may be partially written, in which case the space reported might be |
| 240 | // inaccurate. |
| 241 | found_empty_sector = true; |
| 242 | continue; |
| 243 | } |
| 244 | |
| 245 | stats.writable_bytes += sector.writable_bytes(); |
| 246 | } |
| 247 | |
| 248 | return stats; |
| 249 | } |
| 250 | |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 251 | Status KeyValueStore::LoadEntry(Address entry_address, |
| 252 | Address* next_entry_address) { |
Wyatt Hepler | e541e07 | 2020-02-14 09:10:53 -0800 | [diff] [blame] | 253 | Entry entry; |
Wyatt Hepler | 22d0d9f | 2020-03-05 14:57:11 -0800 | [diff] [blame] | 254 | TRY(Entry::Read(partition_, entry_address, formats_, &entry)); |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 255 | |
| 256 | // Read the key from flash & validate the entry (which reads the value). |
Wyatt Hepler | a00d1ef | 2020-02-14 14:31:26 -0800 | [diff] [blame] | 257 | Entry::KeyBuffer key_buffer; |
Wyatt Hepler | e541e07 | 2020-02-14 09:10:53 -0800 | [diff] [blame] | 258 | TRY_ASSIGN(size_t key_length, entry.ReadKey(key_buffer)); |
| 259 | const string_view key(key_buffer.data(), key_length); |
Wyatt Hepler | bab0e20 | 2020-02-04 07:40:08 -0800 | [diff] [blame] | 260 | |
Wyatt Hepler | 22d0d9f | 2020-03-05 14:57:11 -0800 | [diff] [blame] | 261 | TRY(entry.VerifyChecksumInFlash()); |
David Rogers | f56131c | 2020-03-04 10:19:22 -0800 | [diff] [blame] | 262 | |
| 263 | // A valid entry was found, so update the next entry address before doing any |
| 264 | // of the checks that happen in AppendNewOrOverwriteStaleExistingDescriptor(). |
| 265 | *next_entry_address = entry.next_address(); |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 266 | TRY(AppendNewOrOverwriteStaleExistingDescriptor(entry.descriptor(key))); |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 267 | |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 268 | return Status::OK; |
| 269 | } |
| 270 | |
Alexei Frolov | d4adf91 | 2020-02-21 13:29:15 -0800 | [diff] [blame] | 271 | // Scans flash memory within a sector to find a KVS entry magic. |
Alexei Frolov | d4adf91 | 2020-02-21 13:29:15 -0800 | [diff] [blame] | 272 | Status KeyValueStore::ScanForEntry(const SectorDescriptor& sector, |
| 273 | Address start_address, |
| 274 | Address* next_entry_address) { |
| 275 | DBG("Scanning sector %u for entries starting from address %zx", |
| 276 | SectorIndex(§or), |
| 277 | size_t(start_address)); |
| 278 | |
| 279 | // Entries must start at addresses which are aligned on a multiple of |
| 280 | // Entry::kMinAlignmentBytes. However, that multiple can vary between entries. |
| 281 | // When scanning, we don't have an entry to tell us what the current alignment |
| 282 | // is, so the minimum alignment is used to be exhaustive. |
| 283 | for (Address address = AlignUp(start_address, Entry::kMinAlignmentBytes); |
| 284 | AddressInSector(sector, address); |
| 285 | address += Entry::kMinAlignmentBytes) { |
Alexei Frolov | d4adf91 | 2020-02-21 13:29:15 -0800 | [diff] [blame] | 286 | uint32_t magic; |
| 287 | TRY(partition_.Read(address, as_writable_bytes(span(&magic, 1)))); |
Wyatt Hepler | 22d0d9f | 2020-03-05 14:57:11 -0800 | [diff] [blame] | 288 | if (formats_.KnownMagic(magic)) { |
Alexei Frolov | d4adf91 | 2020-02-21 13:29:15 -0800 | [diff] [blame] | 289 | DBG("Found entry magic at address %zx", size_t(address)); |
| 290 | *next_entry_address = address; |
| 291 | return Status::OK; |
| 292 | } |
| 293 | } |
| 294 | |
| 295 | return Status::NOT_FOUND; |
| 296 | } |
| 297 | |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 298 | // TODO: This method is the trigger of the O(valid_entries * all_entries) time |
| 299 | // complexity for reading. At some cost to memory, this could be optimized by |
| 300 | // using a hash table instead of scanning, but in practice this should be fine |
| 301 | // for a small number of keys |
| 302 | Status KeyValueStore::AppendNewOrOverwriteStaleExistingDescriptor( |
| 303 | const KeyDescriptor& key_descriptor) { |
| 304 | // With the new key descriptor, either add it to the descriptor table or |
| 305 | // overwrite an existing entry with an older version of the key. |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 306 | KeyDescriptor* existing_descriptor = FindDescriptor(key_descriptor.hash()); |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 307 | |
Wyatt Hepler | 5406a67 | 2020-02-18 15:42:38 -0800 | [diff] [blame] | 308 | // Write a new entry. |
| 309 | if (existing_descriptor == nullptr) { |
| 310 | if (key_descriptors_.full()) { |
| 311 | return Status::RESOURCE_EXHAUSTED; |
| 312 | } |
| 313 | key_descriptors_.push_back(key_descriptor); |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 314 | } else if (key_descriptor.IsNewerThan( |
| 315 | existing_descriptor->transaction_id())) { |
Wyatt Hepler | 5406a67 | 2020-02-18 15:42:38 -0800 | [diff] [blame] | 316 | // Existing entry is old; replace the existing entry with the new one. |
| 317 | *existing_descriptor = key_descriptor; |
David Rogers | f56131c | 2020-03-04 10:19:22 -0800 | [diff] [blame] | 318 | } else if (existing_descriptor->transaction_id() == |
| 319 | key_descriptor.transaction_id()) { |
| 320 | // If the entries have a duplicate transaction ID, add the new (redundant) |
| 321 | // entry to the existing descriptor. |
| 322 | if (existing_descriptor->hash() != key_descriptor.hash()) { |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 323 | ERR("Duplicate entry for key 0x%08" PRIx32 " with transaction ID %" PRIu32 |
David Rogers | f56131c | 2020-03-04 10:19:22 -0800 | [diff] [blame] | 324 | " has non-matching hash", |
| 325 | key_descriptor.hash(), |
| 326 | key_descriptor.transaction_id()); |
Wyatt Hepler | 5406a67 | 2020-02-18 15:42:38 -0800 | [diff] [blame] | 327 | return Status::DATA_LOSS; |
| 328 | } |
David Rogers | f56131c | 2020-03-04 10:19:22 -0800 | [diff] [blame] | 329 | |
| 330 | // Verify that this entry is not in the same sector as an existing copy of |
| 331 | // this same key. |
| 332 | for (auto address : existing_descriptor->addresses()) { |
| 333 | if (SectorFromAddress(address) == |
| 334 | SectorFromAddress(key_descriptor.address())) { |
| 335 | DBG("Multiple Redundant entries in same sector %u", |
| 336 | SectorIndex(SectorFromAddress(address))); |
| 337 | return Status::DATA_LOSS; |
| 338 | } |
| 339 | } |
| 340 | existing_descriptor->addresses().push_back(key_descriptor.address()); |
| 341 | } else { |
Wyatt Hepler | 5406a67 | 2020-02-18 15:42:38 -0800 | [diff] [blame] | 342 | DBG("Found stale entry when appending; ignoring"); |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 343 | } |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 344 | return Status::OK; |
| 345 | } |
| 346 | |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 347 | KeyValueStore::KeyDescriptor* KeyValueStore::FindDescriptor(uint32_t hash) { |
Wyatt Hepler | 1c329ca | 2020-02-07 18:07:23 -0800 | [diff] [blame] | 348 | for (KeyDescriptor& key_descriptor : key_descriptors_) { |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 349 | if (key_descriptor.hash() == hash) { |
Wyatt Hepler | 1c329ca | 2020-02-07 18:07:23 -0800 | [diff] [blame] | 350 | return &key_descriptor; |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 351 | } |
| 352 | } |
| 353 | return nullptr; |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 354 | } |
| 355 | |
| 356 | StatusWithSize KeyValueStore::Get(string_view key, |
Wyatt Hepler | 5f6efc0 | 2020-02-18 16:54:31 -0800 | [diff] [blame] | 357 | span<byte> value_buffer, |
| 358 | size_t offset_bytes) const { |
Wyatt Hepler | 50f7077 | 2020-02-13 11:25:10 -0800 | [diff] [blame] | 359 | TRY_WITH_SIZE(CheckOperation(key)); |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 360 | |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame] | 361 | const KeyDescriptor* key_descriptor; |
Wyatt Hepler | 2d40169 | 2020-02-13 16:01:23 -0800 | [diff] [blame] | 362 | TRY_WITH_SIZE(FindExistingKeyDescriptor(key, &key_descriptor)); |
Wyatt Hepler | 6c24c06 | 2020-02-05 15:30:49 -0800 | [diff] [blame] | 363 | |
Wyatt Hepler | fac8113 | 2020-02-27 17:26:33 -0800 | [diff] [blame] | 364 | return Get(key, *key_descriptor, value_buffer, offset_bytes); |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 365 | } |
| 366 | |
Wyatt Hepler | fac8113 | 2020-02-27 17:26:33 -0800 | [diff] [blame] | 367 | Status KeyValueStore::PutBytes(string_view key, span<const byte> value) { |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 368 | DBG("Writing key/value; key length=%zu, value length=%zu", |
| 369 | key.size(), |
| 370 | value.size()); |
Wyatt Hepler | 729f28c | 2020-02-05 09:46:00 -0800 | [diff] [blame] | 371 | |
| 372 | TRY(CheckOperation(key)); |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 373 | |
Wyatt Hepler | 5406a67 | 2020-02-18 15:42:38 -0800 | [diff] [blame] | 374 | if (Entry::size(partition_, key, value) > partition_.sector_size_bytes()) { |
| 375 | DBG("%zu B value with %zu B key cannot fit in one sector", |
| 376 | value.size(), |
| 377 | key.size()); |
| 378 | return Status::INVALID_ARGUMENT; |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 379 | } |
| 380 | |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame] | 381 | KeyDescriptor* key_descriptor; |
Wyatt Hepler | 2d40169 | 2020-02-13 16:01:23 -0800 | [diff] [blame] | 382 | Status status = FindKeyDescriptor(key, &key_descriptor); |
| 383 | |
| 384 | if (status.ok()) { |
David Rogers | f56131c | 2020-03-04 10:19:22 -0800 | [diff] [blame] | 385 | // TODO: figure out logging how to support multiple addresses. |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 386 | DBG("Overwriting entry for key 0x%08" PRIx32 " in %u sectors including %u", |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 387 | key_descriptor->hash(), |
David Rogers | f56131c | 2020-03-04 10:19:22 -0800 | [diff] [blame] | 388 | unsigned(key_descriptor->addresses().size()), |
| 389 | SectorIndex(SectorFromAddress(key_descriptor->address()))); |
Wyatt Hepler | 5a33d8c | 2020-02-06 09:32:58 -0800 | [diff] [blame] | 390 | return WriteEntryForExistingKey( |
| 391 | key_descriptor, KeyDescriptor::kValid, key, value); |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 392 | } |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame] | 393 | |
Wyatt Hepler | 2d40169 | 2020-02-13 16:01:23 -0800 | [diff] [blame] | 394 | if (status == Status::NOT_FOUND) { |
| 395 | return WriteEntryForNewKey(key, value); |
| 396 | } |
| 397 | |
| 398 | return status; |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 399 | } |
| 400 | |
| 401 | Status KeyValueStore::Delete(string_view key) { |
Wyatt Hepler | 729f28c | 2020-02-05 09:46:00 -0800 | [diff] [blame] | 402 | TRY(CheckOperation(key)); |
| 403 | |
Wyatt Hepler | 6c24c06 | 2020-02-05 15:30:49 -0800 | [diff] [blame] | 404 | KeyDescriptor* key_descriptor; |
Wyatt Hepler | 2d40169 | 2020-02-13 16:01:23 -0800 | [diff] [blame] | 405 | TRY(FindExistingKeyDescriptor(key, &key_descriptor)); |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 406 | |
David Rogers | f56131c | 2020-03-04 10:19:22 -0800 | [diff] [blame] | 407 | // TODO: figure out logging how to support multiple addresses. |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 408 | DBG("Writing tombstone for key 0x%08" PRIx32 " in %u sectors including %u", |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 409 | key_descriptor->hash(), |
David Rogers | f56131c | 2020-03-04 10:19:22 -0800 | [diff] [blame] | 410 | unsigned(key_descriptor->addresses().size()), |
| 411 | SectorIndex(SectorFromAddress(key_descriptor->address()))); |
Wyatt Hepler | 5a33d8c | 2020-02-06 09:32:58 -0800 | [diff] [blame] | 412 | return WriteEntryForExistingKey( |
| 413 | key_descriptor, KeyDescriptor::kDeleted, key, {}); |
Wyatt Hepler | 6c24c06 | 2020-02-05 15:30:49 -0800 | [diff] [blame] | 414 | } |
| 415 | |
Wyatt Hepler | 08d37d8 | 2020-02-27 15:45:37 -0800 | [diff] [blame] | 416 | void KeyValueStore::Item::ReadKey() { |
| 417 | key_buffer_.fill('\0'); |
| 418 | |
| 419 | Entry entry; |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 420 | // TODO: add support for using one of the redundant entries if reading the |
| 421 | // first copy fails. |
Wyatt Hepler | 22d0d9f | 2020-03-05 14:57:11 -0800 | [diff] [blame] | 422 | if (Entry::Read( |
| 423 | kvs_.partition_, descriptor_->address(), kvs_.formats_, &entry) |
| 424 | .ok()) { |
Wyatt Hepler | 08d37d8 | 2020-02-27 15:45:37 -0800 | [diff] [blame] | 425 | entry.ReadKey(key_buffer_); |
| 426 | } |
| 427 | } |
| 428 | |
Wyatt Hepler | 6c24c06 | 2020-02-05 15:30:49 -0800 | [diff] [blame] | 429 | KeyValueStore::iterator& KeyValueStore::iterator::operator++() { |
| 430 | // Skip to the next entry that is valid (not deleted). |
Wyatt Hepler | 08d37d8 | 2020-02-27 15:45:37 -0800 | [diff] [blame] | 431 | while (++item_.descriptor_ != item_.kvs_.key_descriptors_.end() && |
| 432 | item_.descriptor_->deleted()) { |
Wyatt Hepler | 6c24c06 | 2020-02-05 15:30:49 -0800 | [diff] [blame] | 433 | } |
| 434 | return *this; |
| 435 | } |
| 436 | |
Wyatt Hepler | 6c24c06 | 2020-02-05 15:30:49 -0800 | [diff] [blame] | 437 | KeyValueStore::iterator KeyValueStore::begin() const { |
Wyatt Hepler | 08d37d8 | 2020-02-27 15:45:37 -0800 | [diff] [blame] | 438 | const KeyDescriptor* descriptor = key_descriptors_.begin(); |
Wyatt Hepler | 6c24c06 | 2020-02-05 15:30:49 -0800 | [diff] [blame] | 439 | // Skip over any deleted entries at the start of the descriptor list. |
Wyatt Hepler | 08d37d8 | 2020-02-27 15:45:37 -0800 | [diff] [blame] | 440 | while (descriptor != key_descriptors_.end() && descriptor->deleted()) { |
| 441 | ++descriptor; |
Wyatt Hepler | 6c24c06 | 2020-02-05 15:30:49 -0800 | [diff] [blame] | 442 | } |
Wyatt Hepler | 08d37d8 | 2020-02-27 15:45:37 -0800 | [diff] [blame] | 443 | return iterator(*this, descriptor); |
Wyatt Hepler | 6c24c06 | 2020-02-05 15:30:49 -0800 | [diff] [blame] | 444 | } |
| 445 | |
| 446 | // TODO(hepler): The valid entry count could be tracked in the KVS to avoid the |
| 447 | // need for this for-loop. |
| 448 | size_t KeyValueStore::size() const { |
| 449 | size_t valid_entries = 0; |
| 450 | |
Wyatt Hepler | 1c329ca | 2020-02-07 18:07:23 -0800 | [diff] [blame] | 451 | for (const KeyDescriptor& key_descriptor : key_descriptors_) { |
| 452 | if (!key_descriptor.deleted()) { |
Wyatt Hepler | 6c24c06 | 2020-02-05 15:30:49 -0800 | [diff] [blame] | 453 | valid_entries += 1; |
| 454 | } |
| 455 | } |
| 456 | |
| 457 | return valid_entries; |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 458 | } |
| 459 | |
Wyatt Hepler | ed163b0 | 2020-02-03 17:49:32 -0800 | [diff] [blame] | 460 | StatusWithSize KeyValueStore::ValueSize(std::string_view key) const { |
Wyatt Hepler | 50f7077 | 2020-02-13 11:25:10 -0800 | [diff] [blame] | 461 | TRY_WITH_SIZE(CheckOperation(key)); |
Wyatt Hepler | ed163b0 | 2020-02-03 17:49:32 -0800 | [diff] [blame] | 462 | |
| 463 | const KeyDescriptor* key_descriptor; |
Wyatt Hepler | 2d40169 | 2020-02-13 16:01:23 -0800 | [diff] [blame] | 464 | TRY_WITH_SIZE(FindExistingKeyDescriptor(key, &key_descriptor)); |
Wyatt Hepler | 6c24c06 | 2020-02-05 15:30:49 -0800 | [diff] [blame] | 465 | |
Wyatt Hepler | fac8113 | 2020-02-27 17:26:33 -0800 | [diff] [blame] | 466 | return ValueSize(*key_descriptor); |
| 467 | } |
Wyatt Hepler | ed163b0 | 2020-02-03 17:49:32 -0800 | [diff] [blame] | 468 | |
Wyatt Hepler | fac8113 | 2020-02-27 17:26:33 -0800 | [diff] [blame] | 469 | StatusWithSize KeyValueStore::Get(string_view key, |
| 470 | const KeyDescriptor& descriptor, |
| 471 | span<std::byte> value_buffer, |
| 472 | size_t offset_bytes) const { |
| 473 | Entry entry; |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 474 | // TODO: add support for using one of the redundant entries if reading the |
| 475 | // first copy fails. |
Wyatt Hepler | 22d0d9f | 2020-03-05 14:57:11 -0800 | [diff] [blame] | 476 | TRY_WITH_SIZE( |
| 477 | Entry::Read(partition_, descriptor.address(), formats_, &entry)); |
Wyatt Hepler | fac8113 | 2020-02-27 17:26:33 -0800 | [diff] [blame] | 478 | |
| 479 | StatusWithSize result = entry.ReadValue(value_buffer, offset_bytes); |
| 480 | if (result.ok() && options_.verify_on_read && offset_bytes == 0u) { |
Wyatt Hepler | 22d0d9f | 2020-03-05 14:57:11 -0800 | [diff] [blame] | 481 | Status verify_result = |
| 482 | entry.VerifyChecksum(key, value_buffer.first(result.size())); |
Wyatt Hepler | fac8113 | 2020-02-27 17:26:33 -0800 | [diff] [blame] | 483 | if (!verify_result.ok()) { |
| 484 | std::memset(value_buffer.data(), 0, result.size()); |
| 485 | return StatusWithSize(verify_result, 0); |
| 486 | } |
| 487 | |
| 488 | return StatusWithSize(verify_result, result.size()); |
| 489 | } |
| 490 | return result; |
Wyatt Hepler | ed163b0 | 2020-02-03 17:49:32 -0800 | [diff] [blame] | 491 | } |
| 492 | |
Wyatt Hepler | 6e3a83b | 2020-02-04 07:36:45 -0800 | [diff] [blame] | 493 | Status KeyValueStore::FixedSizeGet(std::string_view key, |
Wyatt Hepler | fac8113 | 2020-02-27 17:26:33 -0800 | [diff] [blame] | 494 | void* value, |
| 495 | size_t size_bytes) const { |
| 496 | TRY(CheckOperation(key)); |
| 497 | |
| 498 | const KeyDescriptor* descriptor; |
| 499 | TRY(FindExistingKeyDescriptor(key, &descriptor)); |
| 500 | |
| 501 | return FixedSizeGet(key, *descriptor, value, size_bytes); |
| 502 | } |
| 503 | |
| 504 | Status KeyValueStore::FixedSizeGet(std::string_view key, |
| 505 | const KeyDescriptor& descriptor, |
| 506 | void* value, |
Wyatt Hepler | 6e3a83b | 2020-02-04 07:36:45 -0800 | [diff] [blame] | 507 | size_t size_bytes) const { |
| 508 | // Ensure that the size of the stored value matches the size of the type. |
| 509 | // Otherwise, report error. This check avoids potential memory corruption. |
Wyatt Hepler | fac8113 | 2020-02-27 17:26:33 -0800 | [diff] [blame] | 510 | TRY_ASSIGN(const size_t actual_size, ValueSize(descriptor)); |
| 511 | |
| 512 | if (actual_size != size_bytes) { |
| 513 | DBG("Requested %zu B read, but value is %zu B", size_bytes, actual_size); |
Wyatt Hepler | 6e3a83b | 2020-02-04 07:36:45 -0800 | [diff] [blame] | 514 | return Status::INVALID_ARGUMENT; |
Wyatt Hepler | bab0e20 | 2020-02-04 07:40:08 -0800 | [diff] [blame] | 515 | } |
Wyatt Hepler | fac8113 | 2020-02-27 17:26:33 -0800 | [diff] [blame] | 516 | |
| 517 | StatusWithSize result = |
| 518 | Get(key, descriptor, span(static_cast<byte*>(value), size_bytes), 0); |
| 519 | |
| 520 | return result.status(); |
| 521 | } |
| 522 | |
| 523 | StatusWithSize KeyValueStore::ValueSize(const KeyDescriptor& descriptor) const { |
| 524 | Entry entry; |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 525 | // TODO: add support for using one of the redundant entries if reading the |
| 526 | // first copy fails. |
Wyatt Hepler | 22d0d9f | 2020-03-05 14:57:11 -0800 | [diff] [blame] | 527 | TRY_WITH_SIZE( |
| 528 | Entry::Read(partition_, descriptor.address(), formats_, &entry)); |
Wyatt Hepler | fac8113 | 2020-02-27 17:26:33 -0800 | [diff] [blame] | 529 | |
| 530 | return StatusWithSize(entry.value_size()); |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 531 | } |
| 532 | |
Wyatt Hepler | 729f28c | 2020-02-05 09:46:00 -0800 | [diff] [blame] | 533 | Status KeyValueStore::CheckOperation(string_view key) const { |
Wyatt Hepler | acaacf9 | 2020-01-24 10:58:30 -0800 | [diff] [blame] | 534 | if (InvalidKey(key)) { |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 535 | return Status::INVALID_ARGUMENT; |
| 536 | } |
Wyatt Hepler | d229828 | 2020-02-20 17:12:45 -0800 | [diff] [blame] | 537 | if (!initialized()) { |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 538 | return Status::FAILED_PRECONDITION; |
| 539 | } |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 540 | return Status::OK; |
| 541 | } |
| 542 | |
Wyatt Hepler | 2d40169 | 2020-02-13 16:01:23 -0800 | [diff] [blame] | 543 | // Searches for a KeyDescriptor that matches this key and sets *result to point |
| 544 | // to it if one is found. |
| 545 | // |
| 546 | // OK: there is a matching descriptor and *result is set |
| 547 | // NOT_FOUND: there is no descriptor that matches this key, but this key |
| 548 | // has a unique hash (and could potentially be added to the KVS) |
| 549 | // ALREADY_EXISTS: there is no descriptor that matches this key, but the |
| 550 | // key's hash collides with the hash for an existing descriptor |
| 551 | // |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame] | 552 | Status KeyValueStore::FindKeyDescriptor(string_view key, |
| 553 | const KeyDescriptor** result) const { |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 554 | const uint32_t hash = internal::Hash(key); |
Wyatt Hepler | a00d1ef | 2020-02-14 14:31:26 -0800 | [diff] [blame] | 555 | Entry::KeyBuffer key_buffer; |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 556 | |
Wyatt Hepler | 1c329ca | 2020-02-07 18:07:23 -0800 | [diff] [blame] | 557 | for (auto& descriptor : key_descriptors_) { |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 558 | if (descriptor.hash() == hash) { |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 559 | // TODO: add support for using one of the redundant entries if reading the |
| 560 | // first copy fails. |
Wyatt Hepler | e541e07 | 2020-02-14 09:10:53 -0800 | [diff] [blame] | 561 | TRY(Entry::ReadKey( |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 562 | partition_, descriptor.address(), key.size(), key_buffer.data())); |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 563 | |
Wyatt Hepler | e541e07 | 2020-02-14 09:10:53 -0800 | [diff] [blame] | 564 | if (key == string_view(key_buffer.data(), key.size())) { |
Wyatt Hepler | 5a33d8c | 2020-02-06 09:32:58 -0800 | [diff] [blame] | 565 | DBG("Found match for key hash 0x%08" PRIx32, hash); |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame] | 566 | *result = &descriptor; |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 567 | return Status::OK; |
Wyatt Hepler | 2d40169 | 2020-02-13 16:01:23 -0800 | [diff] [blame] | 568 | } else { |
| 569 | WRN("Found key hash collision for 0x%08" PRIx32, hash); |
| 570 | return Status::ALREADY_EXISTS; |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 571 | } |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 572 | } |
| 573 | } |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 574 | return Status::NOT_FOUND; |
| 575 | } |
| 576 | |
Wyatt Hepler | 2d40169 | 2020-02-13 16:01:23 -0800 | [diff] [blame] | 577 | // Searches for a KeyDescriptor that matches this key and sets *result to point |
| 578 | // to it if one is found. |
| 579 | // |
| 580 | // OK: there is a matching descriptor and *result is set |
| 581 | // NOT_FOUND: there is no descriptor that matches this key |
| 582 | // |
| 583 | Status KeyValueStore::FindExistingKeyDescriptor( |
| 584 | string_view key, const KeyDescriptor** result) const { |
| 585 | Status status = FindKeyDescriptor(key, result); |
| 586 | |
| 587 | // If the key's hash collides with an existing key or if the key is deleted, |
| 588 | // treat it as if it is not in the KVS. |
| 589 | if (status == Status::ALREADY_EXISTS || |
| 590 | (status.ok() && (*result)->deleted())) { |
| 591 | return Status::NOT_FOUND; |
| 592 | } |
| 593 | return status; |
| 594 | } |
| 595 | |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame] | 596 | Status KeyValueStore::WriteEntryForExistingKey(KeyDescriptor* key_descriptor, |
Wyatt Hepler | 5a33d8c | 2020-02-06 09:32:58 -0800 | [diff] [blame] | 597 | KeyDescriptor::State new_state, |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 598 | string_view key, |
| 599 | span<const byte> value) { |
Wyatt Hepler | 30a5215 | 2020-02-12 11:26:05 -0800 | [diff] [blame] | 600 | Entry original_entry; |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 601 | // TODO: add support for using one of the redundant entries if reading the |
| 602 | // first copy fails. |
Wyatt Hepler | 22d0d9f | 2020-03-05 14:57:11 -0800 | [diff] [blame] | 603 | TRY(Entry::Read( |
| 604 | partition_, key_descriptor->address(), formats_, &original_entry)); |
Wyatt Hepler | 6c24c06 | 2020-02-05 15:30:49 -0800 | [diff] [blame] | 605 | |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 606 | // Create a new temporary key descriptor to use while writing the new |
| 607 | // key-value out to flash. Once the writing is done, update the main |
| 608 | // descriptor for this key with the new information. |
| 609 | KeyDescriptor new_key_descriptor(key); |
| 610 | TRY(WriteEntry(&new_key_descriptor, key, value, new_state)); |
David Rogers | 3464d0a | 2020-02-07 11:45:46 -0800 | [diff] [blame] | 611 | |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 612 | // Update the main descriptor for the new key version. |
David Rogers | f56131c | 2020-03-04 10:19:22 -0800 | [diff] [blame] | 613 | KeyDescriptor old_key_descriptor = *key_descriptor; |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 614 | *key_descriptor = new_key_descriptor; |
David Rogers | 3464d0a | 2020-02-07 11:45:46 -0800 | [diff] [blame] | 615 | |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 616 | // Remove all the valid bytes for the old key version, which are now stale. |
David Rogers | f56131c | 2020-03-04 10:19:22 -0800 | [diff] [blame] | 617 | for (auto& address : old_key_descriptor.addresses()) { |
| 618 | SectorFromAddress(address)->RemoveValidBytes(original_entry.size()); |
| 619 | } |
| 620 | |
Wyatt Hepler | 5a33d8c | 2020-02-06 09:32:58 -0800 | [diff] [blame] | 621 | return Status::OK; |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 622 | } |
| 623 | |
| 624 | Status KeyValueStore::WriteEntryForNewKey(string_view key, |
| 625 | span<const byte> value) { |
Wyatt Hepler | 1c329ca | 2020-02-07 18:07:23 -0800 | [diff] [blame] | 626 | if (key_descriptors_.full()) { |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 627 | WRN("KVS full: trying to store a new entry, but can't. Have %zu entries", |
Wyatt Hepler | 1c329ca | 2020-02-07 18:07:23 -0800 | [diff] [blame] | 628 | key_descriptors_.size()); |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 629 | return Status::RESOURCE_EXHAUSTED; |
| 630 | } |
| 631 | |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 632 | // Create the KeyDescriptor that will be added to the list and write it to |
| 633 | // flash. |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 634 | KeyDescriptor key_descriptor(key); |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 635 | TRY(WriteEntry(&key_descriptor, key, value, KeyDescriptor::kValid)); |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 636 | |
Wyatt Hepler | 1c329ca | 2020-02-07 18:07:23 -0800 | [diff] [blame] | 637 | // Only add the entry when we are certain the write succeeded. |
| 638 | key_descriptors_.push_back(key_descriptor); |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 639 | return Status::OK; |
| 640 | } |
| 641 | |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 642 | Status KeyValueStore::WriteEntry(KeyDescriptor* key_descriptor, |
| 643 | string_view key, |
| 644 | span<const byte> value, |
| 645 | KeyDescriptor::State new_state) { |
| 646 | size_t entry_size = Entry::size(partition_, key, value); |
| 647 | |
| 648 | Entry entry = CreateEntry(0, key, value, new_state); |
| 649 | *key_descriptor = entry.descriptor(key); |
| 650 | key_descriptor->addresses().clear(); |
| 651 | |
| 652 | // For number of redundany entries to be written, do the following: |
| 653 | // - Find a sector to write an individual entry to. This optionally will |
| 654 | // include garbage collecting one or more sectors if needed. |
| 655 | // - Write the entry to the sector. |
| 656 | // - Repeat for redundancy number of total entries. |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 657 | for (size_t i = 0; i < redundancy_; i++) { |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 658 | SectorDescriptor* sector; |
| 659 | TRY(GetSectorForWrite(§or, entry_size, key_descriptor)); |
| 660 | |
| 661 | DBG("Writing entry %zu; found sector: %u", i, SectorIndex(sector)); |
| 662 | const Address write_address = NextWritableAddress(sector); |
| 663 | TRY(AppendEntry(write_address, entry, key, value)); |
| 664 | |
| 665 | // Entry copy was written successfully; update the key descriptor to reflect |
| 666 | // the new entry. |
| 667 | key_descriptor->addresses().push_back(write_address); |
| 668 | } |
| 669 | |
| 670 | // Once all the entries are written, add valid bytes to each of the sectors |
| 671 | // that entries were written to. |
| 672 | for (auto new_address : key_descriptor->addresses()) { |
| 673 | SectorFromAddress(new_address)->AddValidBytes(entry.size()); |
| 674 | } |
| 675 | |
| 676 | return Status::OK; |
| 677 | } |
| 678 | |
| 679 | // Find a sector to use for writing a new entry to. Do automatic garbage |
| 680 | // collection if needed and allowed. |
| 681 | // |
| 682 | // OK: Sector found with needed space. |
| 683 | // RESOURCE_EXHAUSTED: No sector available with the needed space. |
| 684 | Status KeyValueStore::GetSectorForWrite(SectorDescriptor** sector, |
| 685 | size_t entry_size, |
| 686 | KeyDescriptor* key_descriptor) { |
| 687 | Status result = FindSectorWithSpace( |
| 688 | sector, entry_size, kAppendEntry, key_descriptor->addresses()); |
| 689 | |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 690 | size_t gc_sector_count = 0; |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 691 | bool do_auto_gc = options_.gc_on_write != GargbageCollectOnWrite::kDisabled; |
| 692 | |
| 693 | // Do garbage collection as needed, so long as policy allows. |
| 694 | while (result == Status::RESOURCE_EXHAUSTED && do_auto_gc) { |
| 695 | if (options_.gc_on_write == GargbageCollectOnWrite::kOneSector) { |
| 696 | // If GC config option is kOneSector clear the flag to not do any more |
| 697 | // GC after this try. |
| 698 | do_auto_gc = false; |
| 699 | } |
| 700 | // Garbage collect and then try again to find the best sector. |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 701 | Status gc_status = GarbageCollectPartial(key_descriptor); |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 702 | if (!gc_status.ok()) { |
| 703 | if (gc_status == Status::NOT_FOUND) { |
| 704 | // Not enough space, and no reclaimable bytes, this KVS is full! |
| 705 | return Status::RESOURCE_EXHAUSTED; |
| 706 | } |
| 707 | return gc_status; |
| 708 | } |
| 709 | |
| 710 | result = FindSectorWithSpace( |
| 711 | sector, entry_size, kAppendEntry, key_descriptor->addresses()); |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 712 | |
| 713 | gc_sector_count++; |
| 714 | // Allow total sectors + 2 number of GC cycles so that once reclaimable |
| 715 | // bytes in all the sectors have been reclaimed can try and free up space by |
| 716 | // moving entries for keys other than the one being worked on in to sectors |
| 717 | // that have copies of the key trying to be written. |
| 718 | if (gc_sector_count > (partition_.sector_count() + 2)) { |
| 719 | ERR("Did more GC sectors than total sectors!!!!"); |
| 720 | return Status::RESOURCE_EXHAUSTED; |
| 721 | } |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 722 | } |
| 723 | |
| 724 | if (!result.ok()) { |
| 725 | WRN("Unable to find sector to write %zu B", entry_size); |
| 726 | } |
| 727 | return result; |
| 728 | } |
| 729 | |
| 730 | Status KeyValueStore::AppendEntry(Address write_address, |
| 731 | Entry& entry, |
| 732 | string_view key, |
| 733 | span<const byte> value) { |
Wyatt Hepler | 1d59456 | 2020-03-10 18:26:02 -0700 | [diff] [blame] | 734 | entry.set_address(write_address); |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 735 | |
| 736 | StatusWithSize result = entry.Write(key, value); |
| 737 | // Remove any bytes that were written, even if the write was not successful. |
| 738 | // This is important to retain the writable space invariant on the sectors. |
| 739 | SectorFromAddress(write_address)->RemoveWritableBytes(result.size()); |
| 740 | |
| 741 | if (!result.ok()) { |
| 742 | ERR("Failed to write %zu bytes at %#zx. %zu actually written", |
| 743 | entry.size(), |
| 744 | size_t(write_address), |
| 745 | result.size()); |
| 746 | return result.status(); |
| 747 | } |
| 748 | |
| 749 | if (options_.verify_on_write) { |
| 750 | TRY(entry.VerifyChecksumInFlash()); |
| 751 | } |
| 752 | |
| 753 | return Status::OK; |
| 754 | } |
| 755 | |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 756 | Status KeyValueStore::RelocateEntry(KeyDescriptor* key_descriptor, |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 757 | KeyValueStore::Address old_address) { |
| 758 | Entry entry; |
| 759 | TRY(Entry::Read(partition_, old_address, formats_, &entry)); |
| 760 | |
| 761 | // Find a new sector for the entry and write it to the new location. For |
| 762 | // relocation the find should not not be a sector already containing the key |
| 763 | // but can be the always empty sector, since this is part of the GC process |
| 764 | // that will result in a new empty sector. Also find a sector that does not |
| 765 | // have reclaimable space (mostly for the full GC, where that would result in |
| 766 | // an immediate extra relocation). |
| 767 | SectorDescriptor* new_sector; |
| 768 | |
| 769 | TRY(FindSectorWithSpace( |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 770 | &new_sector, entry.size(), kGarbageCollect, key_descriptor->addresses())); |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 771 | const Address new_address = NextWritableAddress(new_sector); |
| 772 | TRY(MoveEntry(new_address, entry)); |
| 773 | |
| 774 | // TODO: Perhaps add check that the entry matches the key descriptor (key |
| 775 | // hash, ID, checksum). |
| 776 | |
| 777 | // Entry was written successfully; update the key descriptor and the sector |
| 778 | // descriptors to reflect the new entry. |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 779 | TRY(key_descriptor->UpdateAddress(old_address, new_address)); |
| 780 | |
| 781 | if ((key_descriptor >= key_descriptors_.begin()) && |
| 782 | (key_descriptor < key_descriptors_.end())) { |
| 783 | // If the key_descriptor is in the main key_descriptors_ list, it has been |
| 784 | // accounted for in valid bytes, so only do valid byte updates for those |
| 785 | // descriptors. |
| 786 | new_sector->AddValidBytes(entry.size()); |
| 787 | SectorFromAddress(old_address)->RemoveValidBytes(entry.size()); |
| 788 | } |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 789 | |
| 790 | return Status::OK; |
| 791 | } |
| 792 | |
| 793 | Status KeyValueStore::MoveEntry(Address new_address, Entry& entry) { |
| 794 | // Step 1: Read the old entry. |
David Rogers | f0a3544 | 2020-02-04 12:16:38 -0800 | [diff] [blame] | 795 | struct TempEntry { |
Wyatt Hepler | e541e07 | 2020-02-14 09:10:53 -0800 | [diff] [blame] | 796 | Entry::KeyBuffer key; |
Wyatt Hepler | ce7b8df | 2020-02-21 10:38:39 -0800 | [diff] [blame] | 797 | std::array<byte, sizeof(working_buffer_) - sizeof(key)> value; |
David Rogers | f0a3544 | 2020-02-04 12:16:38 -0800 | [diff] [blame] | 798 | }; |
Wyatt Hepler | ce7b8df | 2020-02-21 10:38:39 -0800 | [diff] [blame] | 799 | auto [key_buffer, value_buffer] = |
| 800 | *std::launder(reinterpret_cast<TempEntry*>(working_buffer_.data())); |
David Rogers | f0a3544 | 2020-02-04 12:16:38 -0800 | [diff] [blame] | 801 | |
Wyatt Hepler | e541e07 | 2020-02-14 09:10:53 -0800 | [diff] [blame] | 802 | // Read the entry to be relocated. Store the entry in a local variable and |
David Rogers | f0a3544 | 2020-02-04 12:16:38 -0800 | [diff] [blame] | 803 | // store the key and value in the TempEntry stored in the static allocated |
| 804 | // working_buffer_. |
Wyatt Hepler | ce7b8df | 2020-02-21 10:38:39 -0800 | [diff] [blame] | 805 | TRY_ASSIGN(size_t key_length, entry.ReadKey(key_buffer)); |
| 806 | string_view key = string_view(key_buffer.data(), key_length); |
| 807 | |
| 808 | StatusWithSize result = entry.ReadValue(value_buffer); |
| 809 | if (!result.ok()) { |
David Rogers | f0a3544 | 2020-02-04 12:16:38 -0800 | [diff] [blame] | 810 | return Status::INTERNAL; |
| 811 | } |
| 812 | |
Wyatt Hepler | ce7b8df | 2020-02-21 10:38:39 -0800 | [diff] [blame] | 813 | const span value = span(value_buffer.data(), result.size()); |
Wyatt Hepler | 22d0d9f | 2020-03-05 14:57:11 -0800 | [diff] [blame] | 814 | TRY(entry.VerifyChecksum(key, value)); |
David Rogers | f0a3544 | 2020-02-04 12:16:38 -0800 | [diff] [blame] | 815 | |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 816 | DBG("Moving %zu B entry with transaction ID %zu to to sector %u address %#zx", |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 817 | entry.size(), |
| 818 | size_t(entry.transaction_id()), |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 819 | SectorIndex(SectorFromAddress(new_address)), |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 820 | size_t(new_address)); |
David Rogers | cd87c32 | 2020-02-27 14:04:08 -0800 | [diff] [blame] | 821 | |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 822 | // Step 2: Write the entry to the new location. |
Wyatt Hepler | 1d59456 | 2020-03-10 18:26:02 -0700 | [diff] [blame] | 823 | entry.set_address(new_address); |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 824 | result = entry.Write(key, value); |
| 825 | |
| 826 | // Remove any bytes that were written, even if the write was not successful. |
| 827 | // This is important to retain the writable space invariant on the sectors. |
| 828 | SectorFromAddress(new_address)->RemoveWritableBytes(result.size()); |
| 829 | |
| 830 | if (!result.ok()) { |
| 831 | ERR("Failed to write %zu bytes at %" PRIx32 ". %zu actually written", |
| 832 | entry.size(), |
| 833 | new_address, |
| 834 | result.size()); |
| 835 | return result.status(); |
David Rogers | f56131c | 2020-03-04 10:19:22 -0800 | [diff] [blame] | 836 | } |
| 837 | |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 838 | // Step 3: Verify write to the new location. |
| 839 | if (options_.verify_on_write) { |
| 840 | TRY(entry.VerifyChecksumInFlash()); |
David Rogers | f56131c | 2020-03-04 10:19:22 -0800 | [diff] [blame] | 841 | } |
David Rogers | df025cd | 2020-02-06 17:05:34 -0800 | [diff] [blame] | 842 | |
| 843 | return Status::OK; |
David Rogers | a12786b | 2020-01-31 16:02:33 -0800 | [diff] [blame] | 844 | } |
| 845 | |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 846 | // Find if search_set contains value. |
| 847 | // TODO: At some point move this to pw_containers, along with adding tests for |
| 848 | // it. |
| 849 | template <typename Container, typename T> |
| 850 | bool Contains(const Container& search_set, const T& value) { |
| 851 | return std::find(std::begin(search_set), std::end(search_set), value) != |
| 852 | std::end(search_set); |
| 853 | } |
| 854 | |
David Rogers | 8db5a72 | 2020-02-03 18:28:34 -0800 | [diff] [blame] | 855 | // Find either an existing sector with enough space that is not the sector to |
| 856 | // skip, or an empty sector. Maintains the invariant that there is always at |
David Rogers | c8fe1f5 | 2020-02-27 14:04:08 -0800 | [diff] [blame] | 857 | // least 1 empty sector except during GC. On GC, skip sectors that have |
| 858 | // reclaimable bytes. |
Wyatt Hepler | 5a33d8c | 2020-02-06 09:32:58 -0800 | [diff] [blame] | 859 | Status KeyValueStore::FindSectorWithSpace( |
| 860 | SectorDescriptor** found_sector, |
| 861 | size_t size, |
David Rogers | c8fe1f5 | 2020-02-27 14:04:08 -0800 | [diff] [blame] | 862 | FindSectorMode find_mode, |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 863 | span<const Address> addresses_to_skip) { |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 864 | SectorDescriptor* first_empty_sector = nullptr; |
David Rogers | c8fe1f5 | 2020-02-27 14:04:08 -0800 | [diff] [blame] | 865 | bool at_least_two_empty_sectors = (find_mode == kGarbageCollect); |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 866 | |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 867 | // Used for the GC reclaimable bytes check |
| 868 | SectorDescriptor* non_empty_least_reclaimable_sector = nullptr; |
| 869 | const size_t sector_size_bytes = partition_.sector_size_bytes(); |
| 870 | |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 871 | // Build a vector of sectors to avoid. |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 872 | Vector<SectorDescriptor*, internal::kEntryRedundancy> sectors_to_skip; |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 873 | for (auto& address : addresses_to_skip) { |
| 874 | sectors_to_skip.push_back(SectorFromAddress(address)); |
| 875 | } |
| 876 | |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 877 | DBG("Find sector with %zu bytes available, starting with sector %u, %s", |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 878 | size, |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 879 | SectorIndex(last_new_sector_), |
| 880 | (find_mode == kAppendEntry) ? "Append" : "GC"); |
David Rogers | cd87c32 | 2020-02-27 14:04:08 -0800 | [diff] [blame] | 881 | for (auto& skip_sector : sectors_to_skip) { |
| 882 | DBG(" Skip sector %u", SectorIndex(skip_sector)); |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 883 | } |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 884 | |
David Rogers | 8ce55cd | 2020-02-04 19:41:48 -0800 | [diff] [blame] | 885 | // The last_new_sector_ is the sector that was last selected as the "new empty |
| 886 | // sector" to write to. This last new sector is used as the starting point for |
| 887 | // the next "find a new empty sector to write to" operation. By using the last |
| 888 | // new sector as the start point we will cycle which empty sector is selected |
| 889 | // next, spreading the wear across all the empty sectors and get a wear |
| 890 | // leveling benefit, rather than putting more wear on the lower number |
| 891 | // sectors. |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 892 | SectorDescriptor* sector = last_new_sector_; |
David Rogers | 67f4b6c | 2020-02-06 16:17:09 -0800 | [diff] [blame] | 893 | |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 894 | // Look for a sector to use with enough space. The search uses a 3 priority |
David Rogers | cd87c32 | 2020-02-27 14:04:08 -0800 | [diff] [blame] | 895 | // tier process. |
| 896 | // |
David Rogers | c8fe1f5 | 2020-02-27 14:04:08 -0800 | [diff] [blame] | 897 | // Tier 1 is sector that already has valid data. During GC only select a |
| 898 | // sector that has no reclaimable bytes. Immediately use the first matching |
| 899 | // sector that is found. |
David Rogers | cd87c32 | 2020-02-27 14:04:08 -0800 | [diff] [blame] | 900 | // |
David Rogers | c8fe1f5 | 2020-02-27 14:04:08 -0800 | [diff] [blame] | 901 | // Tier 2 is find sectors that are empty/erased. While scanning for a partial |
| 902 | // sector, keep track of the first empty sector and if a second empty sector |
| 903 | // was seen. If during GC then count the second empty sector as always seen. |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 904 | // |
| 905 | // Tier 3 is during garbage collection, find sectors with enough space that |
| 906 | // are not empty but have recoverable bytes. Pick the sector with the least |
| 907 | // recoverable bytes to minimize the likelyhood of this sector needing to be |
| 908 | // garbage collected soon. |
Wyatt Hepler | 1c329ca | 2020-02-07 18:07:23 -0800 | [diff] [blame] | 909 | for (size_t j = 0; j < sectors_.size(); j++) { |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 910 | sector += 1; |
| 911 | if (sector == sectors_.end()) { |
| 912 | sector = sectors_.begin(); |
| 913 | } |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 914 | |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 915 | // Skip sectors in the skip list. |
| 916 | if (Contains(sectors_to_skip, sector)) { |
David Rogers | 8db5a72 | 2020-02-03 18:28:34 -0800 | [diff] [blame] | 917 | continue; |
| 918 | } |
| 919 | |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 920 | if (!sector->Empty(sector_size_bytes) && sector->HasSpace(size)) { |
| 921 | if ((find_mode == kAppendEntry) || |
| 922 | (sector->RecoverableBytes(sector_size_bytes) == 0)) { |
| 923 | *found_sector = sector; |
| 924 | return Status::OK; |
| 925 | } else { |
| 926 | if ((non_empty_least_reclaimable_sector == nullptr) || |
| 927 | (non_empty_least_reclaimable_sector->RecoverableBytes( |
| 928 | sector_size_bytes) < |
| 929 | sector->RecoverableBytes(sector_size_bytes))) { |
| 930 | non_empty_least_reclaimable_sector = sector; |
| 931 | } |
| 932 | } |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 933 | } |
| 934 | |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 935 | if (sector->Empty(sector_size_bytes)) { |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 936 | if (first_empty_sector == nullptr) { |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 937 | first_empty_sector = sector; |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 938 | } else { |
| 939 | at_least_two_empty_sectors = true; |
Wyatt Hepler | 2ad6067 | 2020-01-21 08:00:16 -0800 | [diff] [blame] | 940 | } |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 941 | } |
| 942 | } |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 943 | |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 944 | // Tier 2 check: If the scan for a partial sector does not find a suitable |
| 945 | // sector, use the first empty sector that was found. Normally it is required |
| 946 | // to keep 1 empty sector after the sector found here, but that rule does not |
| 947 | // apply during GC. |
| 948 | if (first_empty_sector != nullptr && at_least_two_empty_sectors) { |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 949 | DBG(" Found a usable empty sector; returning the first found (%u)", |
David Rogers | 8ce55cd | 2020-02-04 19:41:48 -0800 | [diff] [blame] | 950 | SectorIndex(first_empty_sector)); |
| 951 | last_new_sector_ = first_empty_sector; |
| 952 | *found_sector = first_empty_sector; |
| 953 | return Status::OK; |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 954 | } |
David Rogers | 8ce55cd | 2020-02-04 19:41:48 -0800 | [diff] [blame] | 955 | |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 956 | // Tier 3 check: If we got this far, use the sector with least recoverable |
| 957 | // bytes |
| 958 | if (non_empty_least_reclaimable_sector != nullptr) { |
| 959 | *found_sector = non_empty_least_reclaimable_sector; |
| 960 | DBG(" Found a usable sector %u, with %zu B recoverable, in GC", |
| 961 | SectorIndex(*found_sector), |
| 962 | (*found_sector)->RecoverableBytes(sector_size_bytes)); |
| 963 | return Status::OK; |
| 964 | } |
| 965 | |
David Rogers | 8ce55cd | 2020-02-04 19:41:48 -0800 | [diff] [blame] | 966 | // No sector was found. |
David Rogers | 67f4b6c | 2020-02-06 16:17:09 -0800 | [diff] [blame] | 967 | DBG(" Unable to find a usable sector"); |
David Rogers | 8ce55cd | 2020-02-04 19:41:48 -0800 | [diff] [blame] | 968 | *found_sector = nullptr; |
| 969 | return Status::RESOURCE_EXHAUSTED; |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 970 | } |
| 971 | |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 972 | // TODO: Break up this function in to smaller sub-chunks including create an |
| 973 | // abstraction for the sector list. Look in to being able to unit test this as |
| 974 | // its own thing |
| 975 | KeyValueStore::SectorDescriptor* KeyValueStore::FindSectorToGarbageCollect( |
| 976 | span<const Address> addresses_to_avoid) { |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 977 | const size_t sector_size_bytes = partition_.sector_size_bytes(); |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame] | 978 | SectorDescriptor* sector_candidate = nullptr; |
David Rogers | a12786b | 2020-01-31 16:02:33 -0800 | [diff] [blame] | 979 | size_t candidate_bytes = 0; |
| 980 | |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 981 | // Build a vector of sectors to avoid. |
| 982 | Vector<const SectorDescriptor*, internal::kEntryRedundancy> sectors_to_skip; |
| 983 | for (auto& address : addresses_to_avoid) { |
| 984 | sectors_to_skip.push_back(SectorFromAddress(address)); |
| 985 | DBG(" Skip sector %u", SectorIndex(SectorFromAddress(address))); |
| 986 | } |
| 987 | |
David Rogers | a12786b | 2020-01-31 16:02:33 -0800 | [diff] [blame] | 988 | // Step 1: Try to find a sectors with stale keys and no valid keys (no |
| 989 | // relocation needed). If any such sectors are found, use the sector with the |
| 990 | // most reclaimable bytes. |
Wyatt Hepler | 1c329ca | 2020-02-07 18:07:23 -0800 | [diff] [blame] | 991 | for (auto& sector : sectors_) { |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 992 | if ((sector.valid_bytes() == 0) && |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 993 | (sector.RecoverableBytes(sector_size_bytes) > candidate_bytes) && |
| 994 | !Contains(sectors_to_skip, §or)) { |
David Rogers | a12786b | 2020-01-31 16:02:33 -0800 | [diff] [blame] | 995 | sector_candidate = §or; |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 996 | candidate_bytes = sector.RecoverableBytes(sector_size_bytes); |
David Rogers | a12786b | 2020-01-31 16:02:33 -0800 | [diff] [blame] | 997 | } |
| 998 | } |
| 999 | |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 1000 | // Step 2a: If step 1 yields no sectors, just find the sector with the most |
| 1001 | // reclaimable bytes but no addresses to avoid. |
| 1002 | if (sector_candidate == nullptr) { |
| 1003 | for (auto& sector : sectors_) { |
| 1004 | if ((sector.RecoverableBytes(sector_size_bytes) > candidate_bytes) && |
| 1005 | !Contains(sectors_to_skip, §or)) { |
| 1006 | sector_candidate = §or; |
| 1007 | candidate_bytes = sector.RecoverableBytes(sector_size_bytes); |
| 1008 | } |
| 1009 | } |
| 1010 | } |
| 1011 | |
| 1012 | // Step 2b: If step 1 yields no sectors, just find the sector with the most |
David Rogers | a12786b | 2020-01-31 16:02:33 -0800 | [diff] [blame] | 1013 | // reclaimable bytes. |
| 1014 | if (sector_candidate == nullptr) { |
Wyatt Hepler | 1c329ca | 2020-02-07 18:07:23 -0800 | [diff] [blame] | 1015 | for (auto& sector : sectors_) { |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 1016 | if (sector.RecoverableBytes(sector_size_bytes) > candidate_bytes) { |
David Rogers | a12786b | 2020-01-31 16:02:33 -0800 | [diff] [blame] | 1017 | sector_candidate = §or; |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 1018 | candidate_bytes = sector.RecoverableBytes(sector_size_bytes); |
David Rogers | a12786b | 2020-01-31 16:02:33 -0800 | [diff] [blame] | 1019 | } |
| 1020 | } |
| 1021 | } |
| 1022 | |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 1023 | // Step 3: If no sectors with reclaimable bytes, select the sector with the |
| 1024 | // most free bytes. This at least will allow entries of existing keys to get |
| 1025 | // spread to other sectors, including sectors that already have copies of the |
| 1026 | // current key being written. |
| 1027 | if (sector_candidate == nullptr) { |
| 1028 | for (auto& sector : sectors_) { |
| 1029 | if ((sector.valid_bytes() > candidate_bytes) && |
| 1030 | !Contains(sectors_to_skip, §or)) { |
| 1031 | sector_candidate = §or; |
| 1032 | candidate_bytes = sector.valid_bytes(); |
| 1033 | DBG(" Doing GC on sector with no reclaimable bytes!"); |
| 1034 | } |
| 1035 | } |
| 1036 | } |
| 1037 | |
David Rogers | 5981f31 | 2020-02-13 13:33:56 -0800 | [diff] [blame] | 1038 | if (sector_candidate != nullptr) { |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 1039 | DBG("Found sector %u to Garbage Collect, %zu recoverable bytes", |
David Rogers | 5981f31 | 2020-02-13 13:33:56 -0800 | [diff] [blame] | 1040 | SectorIndex(sector_candidate), |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 1041 | sector_candidate->RecoverableBytes(sector_size_bytes)); |
David Rogers | 5981f31 | 2020-02-13 13:33:56 -0800 | [diff] [blame] | 1042 | } else { |
| 1043 | DBG("Unable to find sector to garbage collect!"); |
| 1044 | } |
David Rogers | a12786b | 2020-01-31 16:02:33 -0800 | [diff] [blame] | 1045 | return sector_candidate; |
| 1046 | } |
| 1047 | |
David Rogers | cd87c32 | 2020-02-27 14:04:08 -0800 | [diff] [blame] | 1048 | Status KeyValueStore::GarbageCollectFull() { |
| 1049 | DBG("Garbage Collect all sectors"); |
David Rogers | cd87c32 | 2020-02-27 14:04:08 -0800 | [diff] [blame] | 1050 | SectorDescriptor* sector = last_new_sector_; |
| 1051 | |
| 1052 | // TODO: look in to making an iterator method for cycling through sectors |
| 1053 | // starting from last_new_sector_. |
| 1054 | for (size_t j = 0; j < sectors_.size(); j++) { |
| 1055 | sector += 1; |
| 1056 | if (sector == sectors_.end()) { |
| 1057 | sector = sectors_.begin(); |
| 1058 | } |
| 1059 | |
| 1060 | if (sector->RecoverableBytes(partition_.sector_size_bytes()) > 0) { |
| 1061 | TRY(GarbageCollectSector(sector)); |
| 1062 | } |
| 1063 | } |
| 1064 | |
| 1065 | DBG("Garbage Collect all complete"); |
David Rogers | cd87c32 | 2020-02-27 14:04:08 -0800 | [diff] [blame] | 1066 | return Status::OK; |
| 1067 | } |
| 1068 | |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 1069 | Status KeyValueStore::GarbageCollectPartial(KeyDescriptor* key_in_progress) { |
| 1070 | DBG("Garbage Collect a single sector%s", |
| 1071 | (key_in_progress == nullptr) ? "" : ", with key in progress"); |
David Rogers | 67f4b6c | 2020-02-06 16:17:09 -0800 | [diff] [blame] | 1072 | |
David Rogers | a12786b | 2020-01-31 16:02:33 -0800 | [diff] [blame] | 1073 | // Step 1: Find the sector to garbage collect |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 1074 | auto addresses = span<const Address>(); |
| 1075 | if (key_in_progress != nullptr) { |
| 1076 | DBG(" Use addresses to avoid"); |
| 1077 | addresses = key_in_progress->addresses(); |
| 1078 | } |
| 1079 | SectorDescriptor* sector_to_gc = FindSectorToGarbageCollect(addresses); |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 1080 | |
David Rogers | a12786b | 2020-01-31 16:02:33 -0800 | [diff] [blame] | 1081 | if (sector_to_gc == nullptr) { |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 1082 | // Nothing to GC. |
| 1083 | return Status::NOT_FOUND; |
David Rogers | a12786b | 2020-01-31 16:02:33 -0800 | [diff] [blame] | 1084 | } |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 1085 | |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 1086 | TRY(GarbageCollectSector(sector_to_gc, key_in_progress)); |
David Rogers | cd87c32 | 2020-02-27 14:04:08 -0800 | [diff] [blame] | 1087 | return Status::OK; |
| 1088 | } |
| 1089 | |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 1090 | Status KeyValueStore::RelocateKeyAddressesInSector( |
| 1091 | internal::SectorDescriptor* sector_to_gc, |
| 1092 | internal::KeyDescriptor* descriptor) { |
| 1093 | for (auto address : descriptor->addresses()) { |
| 1094 | if (AddressInSector(*sector_to_gc, address)) { |
| 1095 | DBG(" Relocate entry for Key 0x%08zx, address %zu", |
| 1096 | size_t(descriptor->hash()), |
| 1097 | size_t(address)); |
| 1098 | TRY(RelocateEntry(descriptor, address)); |
| 1099 | } |
| 1100 | } |
| 1101 | return Status::OK; |
| 1102 | }; |
| 1103 | |
| 1104 | Status KeyValueStore::GarbageCollectSector(SectorDescriptor* sector_to_gc, |
| 1105 | KeyDescriptor* key_in_progress) { |
| 1106 | // Pre-step: Check if the key in progress has any addresses in the sector to |
| 1107 | // GC. |
| 1108 | bool key_in_progress_in_sector = false; |
| 1109 | if (key_in_progress != nullptr) { |
| 1110 | for (Address address : key_in_progress->addresses()) { |
| 1111 | if (AddressInSector(*sector_to_gc, address)) { |
| 1112 | key_in_progress_in_sector = true; |
| 1113 | break; |
David Rogers | a12786b | 2020-01-31 16:02:33 -0800 | [diff] [blame] | 1114 | } |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 1115 | } |
| 1116 | } |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 1117 | |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 1118 | // Step 1: Move any valid entries in the GC sector to other sectors |
| 1119 | if ((sector_to_gc->valid_bytes() != 0 || key_in_progress_in_sector)) { |
| 1120 | if (key_in_progress != nullptr) { |
| 1121 | TRY(RelocateKeyAddressesInSector(sector_to_gc, key_in_progress)); |
| 1122 | } |
| 1123 | for (auto& descriptor : key_descriptors_) { |
| 1124 | TRY(RelocateKeyAddressesInSector(sector_to_gc, &descriptor)); |
| 1125 | } |
| 1126 | } |
| 1127 | |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 1128 | if (sector_to_gc->valid_bytes() != 0) { |
David Rogers | 67f4b6c | 2020-02-06 16:17:09 -0800 | [diff] [blame] | 1129 | ERR(" Failed to relocate valid entries from sector being garbage " |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 1130 | "collected, %zu valid bytes remain", |
| 1131 | sector_to_gc->valid_bytes()); |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 1132 | return Status::INTERNAL; |
| 1133 | } |
| 1134 | |
David Rogers | cd87c32 | 2020-02-27 14:04:08 -0800 | [diff] [blame] | 1135 | // Step 2: Reinitialize the sector |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 1136 | sector_to_gc->set_writable_bytes(0); |
David Rogers | a12786b | 2020-01-31 16:02:33 -0800 | [diff] [blame] | 1137 | TRY(partition_.Erase(SectorBaseAddress(sector_to_gc), 1)); |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 1138 | sector_to_gc->set_writable_bytes(partition_.sector_size_bytes()); |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 1139 | |
David Rogers | cd87c32 | 2020-02-27 14:04:08 -0800 | [diff] [blame] | 1140 | DBG(" Garbage Collect sector %u complete", SectorIndex(sector_to_gc)); |
David Rogers | a12786b | 2020-01-31 16:02:33 -0800 | [diff] [blame] | 1141 | return Status::OK; |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 1142 | } |
| 1143 | |
Wyatt Hepler | bdd8e5a | 2020-02-20 19:27:26 -0800 | [diff] [blame] | 1144 | KeyValueStore::Entry KeyValueStore::CreateEntry(Address address, |
| 1145 | std::string_view key, |
| 1146 | span<const byte> value, |
| 1147 | KeyDescriptor::State state) { |
Keir Mierle | 9e38b40 | 2020-02-21 13:06:21 -0800 | [diff] [blame] | 1148 | // Always bump the transaction ID when creating a new entry. |
| 1149 | // |
| 1150 | // Burning transaction IDs prevents inconsistencies between flash and memory |
| 1151 | // that which could happen if a write succeeds, but for some reason the read |
| 1152 | // and verify step fails. Here's how this would happen: |
| 1153 | // |
| 1154 | // 1. The entry is written but for some reason the flash reports failure OR |
| 1155 | // The write succeeds, but the read / verify operation fails. |
| 1156 | // 2. The transaction ID is NOT incremented, because of the failure |
| 1157 | // 3. (later) A new entry is written, re-using the transaction ID (oops) |
| 1158 | // |
| 1159 | // By always burning transaction IDs, the above problem can't happen. |
| 1160 | last_transaction_id_ += 1; |
| 1161 | |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 1162 | if (state == KeyDescriptor::kDeleted) { |
Wyatt Hepler | 7465be3 | 2020-02-21 15:30:53 -0800 | [diff] [blame] | 1163 | return Entry::Tombstone( |
Wyatt Hepler | 22d0d9f | 2020-03-05 14:57:11 -0800 | [diff] [blame] | 1164 | partition_, address, formats_.primary(), key, last_transaction_id_); |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 1165 | } |
| 1166 | return Entry::Valid(partition_, |
| 1167 | address, |
Wyatt Hepler | 22d0d9f | 2020-03-05 14:57:11 -0800 | [diff] [blame] | 1168 | formats_.primary(), |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 1169 | key, |
| 1170 | value, |
Keir Mierle | 9e38b40 | 2020-02-21 13:06:21 -0800 | [diff] [blame] | 1171 | last_transaction_id_); |
Wyatt Hepler | d229828 | 2020-02-20 17:12:45 -0800 | [diff] [blame] | 1172 | } |
| 1173 | |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 1174 | void KeyValueStore::LogDebugInfo() { |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 1175 | const size_t sector_size_bytes = partition_.sector_size_bytes(); |
| 1176 | DBG("====================== KEY VALUE STORE DUMP ========================="); |
| 1177 | DBG(" "); |
| 1178 | DBG("Flash partition:"); |
Wyatt Hepler | ad0a793 | 2020-02-06 08:20:38 -0800 | [diff] [blame] | 1179 | DBG(" Sector count = %zu", partition_.sector_count()); |
Wyatt Hepler | 38ce30f | 2020-02-19 11:48:31 -0800 | [diff] [blame] | 1180 | DBG(" Sector max count = %zu", sectors_.max_size()); |
Wyatt Hepler | 1c329ca | 2020-02-07 18:07:23 -0800 | [diff] [blame] | 1181 | DBG(" Sectors in use = %zu", sectors_.size()); |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 1182 | DBG(" Sector size = %zu", sector_size_bytes); |
| 1183 | DBG(" Total size = %zu", partition_.size_bytes()); |
| 1184 | DBG(" Alignment = %zu", partition_.alignment_bytes()); |
| 1185 | DBG(" "); |
| 1186 | DBG("Key descriptors:"); |
Wyatt Hepler | 1c329ca | 2020-02-07 18:07:23 -0800 | [diff] [blame] | 1187 | DBG(" Entry count = %zu", key_descriptors_.size()); |
Wyatt Hepler | 38ce30f | 2020-02-19 11:48:31 -0800 | [diff] [blame] | 1188 | DBG(" Max entry count = %zu", key_descriptors_.max_size()); |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 1189 | DBG(" "); |
| 1190 | DBG(" # hash version address address (hex)"); |
Wyatt Hepler | 1c329ca | 2020-02-07 18:07:23 -0800 | [diff] [blame] | 1191 | for (size_t i = 0; i < key_descriptors_.size(); ++i) { |
| 1192 | const KeyDescriptor& kd = key_descriptors_[i]; |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 1193 | DBG(" |%3zu: | %8zx |%8zu | %8zu | %8zx", |
| 1194 | i, |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 1195 | size_t(kd.hash()), |
| 1196 | size_t(kd.transaction_id()), |
| 1197 | size_t(kd.address()), |
| 1198 | size_t(kd.address())); |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 1199 | } |
| 1200 | DBG(" "); |
| 1201 | |
| 1202 | DBG("Sector descriptors:"); |
| 1203 | DBG(" # tail free valid has_space"); |
Wyatt Hepler | 1c329ca | 2020-02-07 18:07:23 -0800 | [diff] [blame] | 1204 | for (size_t sector_id = 0; sector_id < sectors_.size(); ++sector_id) { |
| 1205 | const SectorDescriptor& sd = sectors_[sector_id]; |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 1206 | DBG(" |%3zu: | %8zu |%8zu | %s", |
| 1207 | sector_id, |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 1208 | size_t(sd.writable_bytes()), |
| 1209 | sd.valid_bytes(), |
| 1210 | sd.writable_bytes() ? "YES" : ""); |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 1211 | } |
| 1212 | DBG(" "); |
| 1213 | |
| 1214 | // TODO: This should stop logging after some threshold. |
| 1215 | // size_t dumped_bytes = 0; |
| 1216 | DBG("Sector raw data:"); |
Wyatt Hepler | 1c329ca | 2020-02-07 18:07:23 -0800 | [diff] [blame] | 1217 | for (size_t sector_id = 0; sector_id < sectors_.size(); ++sector_id) { |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 1218 | // Read sector data. Yes, this will blow the stack on embedded. |
Wyatt Hepler | 1c329ca | 2020-02-07 18:07:23 -0800 | [diff] [blame] | 1219 | std::array<byte, 500> raw_sector_data; // TODO!!! |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 1220 | StatusWithSize sws = |
| 1221 | partition_.Read(sector_id * sector_size_bytes, raw_sector_data); |
| 1222 | DBG("Read: %zu bytes", sws.size()); |
| 1223 | |
| 1224 | DBG(" base addr offs 0 1 2 3 4 5 6 7"); |
| 1225 | for (size_t i = 0; i < sector_size_bytes; i += 8) { |
| 1226 | DBG(" %3zu %8zx %5zu | %02x %02x %02x %02x %02x %02x %02x %02x", |
| 1227 | sector_id, |
| 1228 | (sector_id * sector_size_bytes) + i, |
| 1229 | i, |
| 1230 | static_cast<unsigned int>(raw_sector_data[i + 0]), |
| 1231 | static_cast<unsigned int>(raw_sector_data[i + 1]), |
| 1232 | static_cast<unsigned int>(raw_sector_data[i + 2]), |
| 1233 | static_cast<unsigned int>(raw_sector_data[i + 3]), |
| 1234 | static_cast<unsigned int>(raw_sector_data[i + 4]), |
| 1235 | static_cast<unsigned int>(raw_sector_data[i + 5]), |
| 1236 | static_cast<unsigned int>(raw_sector_data[i + 6]), |
| 1237 | static_cast<unsigned int>(raw_sector_data[i + 7])); |
| 1238 | |
| 1239 | // TODO: Fix exit condition. |
| 1240 | if (i > 128) { |
| 1241 | break; |
| 1242 | } |
| 1243 | } |
| 1244 | DBG(" "); |
| 1245 | } |
| 1246 | |
| 1247 | DBG("////////////////////// KEY VALUE STORE DUMP END /////////////////////"); |
| 1248 | } |
| 1249 | |
David Rogers | cf680ab | 2020-02-12 23:28:32 -0800 | [diff] [blame] | 1250 | void KeyValueStore::LogSectors() const { |
| 1251 | DBG("Sector descriptors: count %zu", sectors_.size()); |
Wyatt Hepler | 1c329ca | 2020-02-07 18:07:23 -0800 | [diff] [blame] | 1252 | for (auto& sector : sectors_) { |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 1253 | DBG(" - Sector %u: valid %zu, recoverable %zu, free %zu", |
David Rogers | 50185ad | 2020-02-07 00:02:46 -0800 | [diff] [blame] | 1254 | SectorIndex(§or), |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 1255 | sector.valid_bytes(), |
| 1256 | sector.RecoverableBytes(partition_.sector_size_bytes()), |
| 1257 | sector.writable_bytes()); |
David Rogers | 50185ad | 2020-02-07 00:02:46 -0800 | [diff] [blame] | 1258 | } |
| 1259 | } |
| 1260 | |
David Rogers | cf680ab | 2020-02-12 23:28:32 -0800 | [diff] [blame] | 1261 | void KeyValueStore::LogKeyDescriptor() const { |
| 1262 | DBG("Key descriptors: count %zu", key_descriptors_.size()); |
| 1263 | for (auto& key : key_descriptors_) { |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 1264 | DBG(" - Key: %s, hash %#zx, transaction ID %zu, address %#zx", |
David Rogers | cf680ab | 2020-02-12 23:28:32 -0800 | [diff] [blame] | 1265 | key.deleted() ? "Deleted" : "Valid", |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 1266 | static_cast<size_t>(key.hash()), |
| 1267 | static_cast<size_t>(key.transaction_id()), |
| 1268 | static_cast<size_t>(key.address())); |
David Rogers | cf680ab | 2020-02-12 23:28:32 -0800 | [diff] [blame] | 1269 | } |
| 1270 | } |
| 1271 | |
Wyatt Hepler | 2ad6067 | 2020-01-21 08:00:16 -0800 | [diff] [blame] | 1272 | } // namespace pw::kvs |