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 | |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 22 | #define PW_LOG_USE_ULTRA_SHORT_NAMES 1 |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 23 | #include "pw_kvs_private/macros.h" |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 24 | #include "pw_log/log.h" |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 25 | |
Wyatt Hepler | 2ad6067 | 2020-01-21 08:00:16 -0800 | [diff] [blame] | 26 | namespace pw::kvs { |
Wyatt Hepler | a00d1ef | 2020-02-14 14:31:26 -0800 | [diff] [blame] | 27 | namespace { |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 28 | |
Wyatt Hepler | acaacf9 | 2020-01-24 10:58:30 -0800 | [diff] [blame] | 29 | using std::byte; |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 30 | using std::string_view; |
Wyatt Hepler | acaacf9 | 2020-01-24 10:58:30 -0800 | [diff] [blame] | 31 | |
Wyatt Hepler | a00d1ef | 2020-02-14 14:31:26 -0800 | [diff] [blame] | 32 | constexpr bool InvalidKey(std::string_view key) { |
Wyatt Hepler | bdd8e5a | 2020-02-20 19:27:26 -0800 | [diff] [blame] | 33 | return key.empty() || (key.size() > internal::Entry::kMaxKeyLength); |
Wyatt Hepler | a00d1ef | 2020-02-14 14:31:26 -0800 | [diff] [blame] | 34 | } |
| 35 | |
| 36 | } // namespace |
| 37 | |
Wyatt Hepler | ad0a793 | 2020-02-06 08:20:38 -0800 | [diff] [blame] | 38 | KeyValueStore::KeyValueStore(FlashPartition* partition, |
Wyatt Hepler | 22d0d9f | 2020-03-05 14:57:11 -0800 | [diff] [blame] | 39 | span<const EntryFormat> formats, |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 40 | const Options& options, |
| 41 | size_t redundancy, |
| 42 | Vector<SectorDescriptor>& sector_descriptor_list, |
| 43 | const SectorDescriptor** temp_sectors_to_skip, |
| 44 | Vector<KeyDescriptor>& key_descriptor_list, |
| 45 | Address* addresses) |
Wyatt Hepler | ad0a793 | 2020-02-06 08:20:38 -0800 | [diff] [blame] | 46 | : partition_(*partition), |
Wyatt Hepler | 22d0d9f | 2020-03-05 14:57:11 -0800 | [diff] [blame] | 47 | formats_(formats), |
Wyatt Hepler | c84393f | 2020-03-20 11:23:24 -0700 | [diff] [blame^] | 48 | sectors_(sector_descriptor_list, *partition, temp_sectors_to_skip), |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 49 | entry_cache_(key_descriptor_list, addresses, redundancy), |
David Rogers | 49766d9 | 2020-03-20 10:55:54 -0700 | [diff] [blame] | 50 | options_(options), |
| 51 | initialized_(false), |
| 52 | error_detected_(false), |
David Rogers | 49766d9 | 2020-03-20 10:55:54 -0700 | [diff] [blame] | 53 | last_transaction_id_(0) {} |
Wyatt Hepler | ad0a793 | 2020-02-06 08:20:38 -0800 | [diff] [blame] | 54 | |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 55 | Status KeyValueStore::Init() { |
Keir Mierle | bf90481 | 2020-03-11 17:28:22 -0700 | [diff] [blame] | 56 | initialized_ = false; |
David Rogers | 49766d9 | 2020-03-20 10:55:54 -0700 | [diff] [blame] | 57 | error_detected_ = false; |
Keir Mierle | bf90481 | 2020-03-11 17:28:22 -0700 | [diff] [blame] | 58 | last_transaction_id_ = 0; |
Wyatt Hepler | c84393f | 2020-03-20 11:23:24 -0700 | [diff] [blame^] | 59 | sectors_.Reset(); |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 60 | entry_cache_.Reset(); |
Wyatt Hepler | d229828 | 2020-02-20 17:12:45 -0800 | [diff] [blame] | 61 | |
David Rogers | 2e9e0c8 | 2020-02-13 15:06:06 -0800 | [diff] [blame] | 62 | INF("Initializing key value store"); |
Wyatt Hepler | 38ce30f | 2020-02-19 11:48:31 -0800 | [diff] [blame] | 63 | if (partition_.sector_count() > sectors_.max_size()) { |
David Rogers | 2e9e0c8 | 2020-02-13 15:06:06 -0800 | [diff] [blame] | 64 | ERR("KVS init failed: kMaxUsableSectors (=%zu) must be at least as " |
| 65 | "large as the number of sectors in the flash partition (=%zu)", |
Wyatt Hepler | 38ce30f | 2020-02-19 11:48:31 -0800 | [diff] [blame] | 66 | sectors_.max_size(), |
David Rogers | 2e9e0c8 | 2020-02-13 15:06:06 -0800 | [diff] [blame] | 67 | partition_.sector_count()); |
Wyatt Hepler | ad0a793 | 2020-02-06 08:20:38 -0800 | [diff] [blame] | 68 | return Status::FAILED_PRECONDITION; |
| 69 | } |
| 70 | |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 71 | const size_t sector_size_bytes = partition_.sector_size_bytes(); |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 72 | |
David Rogers | 49766d9 | 2020-03-20 10:55:54 -0700 | [diff] [blame] | 73 | // TODO: investigate doing this as a static assert/compile-time check. |
| 74 | if (sector_size_bytes > SectorDescriptor::max_sector_size()) { |
| 75 | ERR("KVS init failed: sector_size_bytes (=%zu) is greater than maximum " |
| 76 | "allowed sector size (=%zu)", |
| 77 | sector_size_bytes, |
| 78 | SectorDescriptor::max_sector_size()); |
| 79 | return Status::FAILED_PRECONDITION; |
| 80 | } |
| 81 | |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 82 | DBG("First pass: Read all entries from all sectors"); |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 83 | Address sector_address = 0; |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 84 | |
Alexei Frolov | d4adf91 | 2020-02-21 13:29:15 -0800 | [diff] [blame] | 85 | size_t total_corrupt_bytes = 0; |
| 86 | int corrupt_entries = 0; |
David Rogers | 9162748 | 2020-02-27 17:38:12 -0800 | [diff] [blame] | 87 | bool empty_sector_found = false; |
Alexei Frolov | d4adf91 | 2020-02-21 13:29:15 -0800 | [diff] [blame] | 88 | |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 89 | for (SectorDescriptor& sector : sectors_) { |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 90 | Address entry_address = sector_address; |
| 91 | |
Alexei Frolov | d4adf91 | 2020-02-21 13:29:15 -0800 | [diff] [blame] | 92 | size_t sector_corrupt_bytes = 0; |
| 93 | |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 94 | for (int num_entries_in_sector = 0; true; num_entries_in_sector++) { |
| 95 | DBG("Load entry: sector=%" PRIx32 ", entry#=%d, address=%" PRIx32, |
| 96 | sector_address, |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 97 | num_entries_in_sector, |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 98 | entry_address); |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 99 | |
Wyatt Hepler | c84393f | 2020-03-20 11:23:24 -0700 | [diff] [blame^] | 100 | if (!sectors_.AddressInSector(sector, entry_address)) { |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 101 | DBG("Fell off end of sector; moving to the next sector"); |
| 102 | break; |
| 103 | } |
| 104 | |
| 105 | Address next_entry_address; |
| 106 | Status status = LoadEntry(entry_address, &next_entry_address); |
| 107 | if (status == Status::NOT_FOUND) { |
| 108 | DBG("Hit un-written data in sector; moving to the next sector"); |
| 109 | break; |
| 110 | } |
| 111 | if (status == Status::DATA_LOSS) { |
Alexei Frolov | d4adf91 | 2020-02-21 13:29:15 -0800 | [diff] [blame] | 112 | // The entry could not be read, indicating data corruption within the |
| 113 | // sector. Try to scan the remainder of the sector for other entries. |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 114 | WRN("KVS init: data loss detected in sector %u at address %zu", |
Wyatt Hepler | c84393f | 2020-03-20 11:23:24 -0700 | [diff] [blame^] | 115 | sectors_.Index(sector), |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 116 | size_t(entry_address)); |
Alexei Frolov | d4adf91 | 2020-02-21 13:29:15 -0800 | [diff] [blame] | 117 | |
David Rogers | 49766d9 | 2020-03-20 10:55:54 -0700 | [diff] [blame] | 118 | error_detected_ = true; |
Alexei Frolov | d4adf91 | 2020-02-21 13:29:15 -0800 | [diff] [blame] | 119 | corrupt_entries++; |
| 120 | |
| 121 | status = ScanForEntry(sector, |
| 122 | entry_address + Entry::kMinAlignmentBytes, |
| 123 | &next_entry_address); |
| 124 | if (status == Status::NOT_FOUND) { |
| 125 | // No further entries in this sector. Mark the remaining bytes in the |
| 126 | // sector as corrupt (since we can't reliably know the size of the |
| 127 | // corrupt entry). |
| 128 | sector_corrupt_bytes += |
| 129 | sector_size_bytes - (entry_address - sector_address); |
| 130 | break; |
| 131 | } |
| 132 | |
| 133 | if (!status.ok()) { |
| 134 | ERR("Unexpected error in KVS initialization: %s", status.str()); |
| 135 | return Status::UNKNOWN; |
| 136 | } |
| 137 | |
| 138 | sector_corrupt_bytes += next_entry_address - entry_address; |
| 139 | } else if (!status.ok()) { |
| 140 | ERR("Unexpected error in KVS initialization: %s", status.str()); |
| 141 | return Status::UNKNOWN; |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 142 | } |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 143 | |
| 144 | // Entry loaded successfully; so get ready to load the next one. |
| 145 | entry_address = next_entry_address; |
| 146 | |
| 147 | // Update of the number of writable bytes in this sector. |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 148 | sector.set_writable_bytes(sector_size_bytes - |
| 149 | (entry_address - sector_address)); |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 150 | } |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 151 | |
Alexei Frolov | d4adf91 | 2020-02-21 13:29:15 -0800 | [diff] [blame] | 152 | if (sector_corrupt_bytes > 0) { |
| 153 | // If the sector contains corrupt data, prevent any further entries from |
| 154 | // being written to it by indicating that it has no space. This should |
| 155 | // also make it a decent GC candidate. Valid keys in the sector are still |
| 156 | // readable as normal. |
David Rogers | 49766d9 | 2020-03-20 10:55:54 -0700 | [diff] [blame] | 157 | sector.mark_corrupt(); |
| 158 | error_detected_ = true; |
Alexei Frolov | d4adf91 | 2020-02-21 13:29:15 -0800 | [diff] [blame] | 159 | |
| 160 | WRN("Sector %u contains %zuB of corrupt data", |
Wyatt Hepler | c84393f | 2020-03-20 11:23:24 -0700 | [diff] [blame^] | 161 | sectors_.Index(sector), |
Alexei Frolov | d4adf91 | 2020-02-21 13:29:15 -0800 | [diff] [blame] | 162 | sector_corrupt_bytes); |
| 163 | } |
| 164 | |
David Rogers | 9162748 | 2020-02-27 17:38:12 -0800 | [diff] [blame] | 165 | if (sector.Empty(sector_size_bytes)) { |
| 166 | empty_sector_found = true; |
| 167 | } |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 168 | sector_address += sector_size_bytes; |
Alexei Frolov | d4adf91 | 2020-02-21 13:29:15 -0800 | [diff] [blame] | 169 | total_corrupt_bytes += sector_corrupt_bytes; |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 170 | } |
| 171 | |
| 172 | DBG("Second pass: Count valid bytes in each sector"); |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 173 | Address newest_key = 0; |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 174 | |
Wyatt Hepler | 0294627 | 2020-03-18 10:36:22 -0700 | [diff] [blame] | 175 | // For every valid entry, count the valid bytes in that sector. Track which |
| 176 | // entry has the newest transaction ID for initializing last_new_sector_. |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 177 | for (const EntryMetadata& metadata : entry_cache_) { |
David Rogers | 49766d9 | 2020-03-20 10:55:54 -0700 | [diff] [blame] | 178 | if (metadata.addresses().size() < redundancy()) { |
| 179 | error_detected_ = true; |
| 180 | } |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 181 | for (Address address : metadata.addresses()) { |
David Rogers | f56131c | 2020-03-04 10:19:22 -0800 | [diff] [blame] | 182 | Entry entry; |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 183 | TRY(Entry::Read(partition_, address, formats_, &entry)); |
Wyatt Hepler | c84393f | 2020-03-20 11:23:24 -0700 | [diff] [blame^] | 184 | sectors_.FromAddress(address).AddValidBytes(entry.size()); |
David Rogers | f56131c | 2020-03-04 10:19:22 -0800 | [diff] [blame] | 185 | } |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 186 | if (metadata.IsNewerThan(last_transaction_id_)) { |
| 187 | last_transaction_id_ = metadata.transaction_id(); |
| 188 | newest_key = metadata.addresses().back(); |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 189 | } |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 190 | } |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 191 | |
Wyatt Hepler | c84393f | 2020-03-20 11:23:24 -0700 | [diff] [blame^] | 192 | sectors_.set_last_new_sector(newest_key); |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 193 | |
David Rogers | 49766d9 | 2020-03-20 10:55:54 -0700 | [diff] [blame] | 194 | if (error_detected_) { |
| 195 | Status recovery_status = Repair(); |
| 196 | if (recovery_status.ok()) { |
| 197 | INF("KVS init: Corruption detected and fully repaired"); |
| 198 | } else { |
| 199 | ERR("KVS init: Corruption detected and unable repair"); |
| 200 | } |
| 201 | } |
| 202 | |
David Rogers | 9162748 | 2020-02-27 17:38:12 -0800 | [diff] [blame] | 203 | if (!empty_sector_found) { |
| 204 | // TODO: Record/report the error condition and recovery result. |
| 205 | Status gc_result = GarbageCollectPartial(); |
| 206 | |
| 207 | if (!gc_result.ok()) { |
| 208 | ERR("KVS init failed: Unable to maintain required free sector"); |
| 209 | return Status::INTERNAL; |
| 210 | } |
| 211 | } |
| 212 | |
Wyatt Hepler | 729f28c | 2020-02-05 09:46:00 -0800 | [diff] [blame] | 213 | initialized_ = true; |
David Rogers | 2e9e0c8 | 2020-02-13 15:06:06 -0800 | [diff] [blame] | 214 | |
Armando Montanez | 5464d5f | 2020-02-20 10:12:20 -0800 | [diff] [blame] | 215 | INF("KeyValueStore init complete: active keys %zu, deleted keys %zu, sectors " |
David Rogers | 2e9e0c8 | 2020-02-13 15:06:06 -0800 | [diff] [blame] | 216 | "%zu, logical sector size %zu bytes", |
| 217 | size(), |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 218 | (entry_cache_.total_entries() - size()), |
David Rogers | 2e9e0c8 | 2020-02-13 15:06:06 -0800 | [diff] [blame] | 219 | sectors_.size(), |
| 220 | partition_.sector_size_bytes()); |
| 221 | |
Alexei Frolov | d4adf91 | 2020-02-21 13:29:15 -0800 | [diff] [blame] | 222 | if (total_corrupt_bytes > 0) { |
| 223 | WRN("Found %zu corrupt bytes and %d corrupt entries during init process; " |
| 224 | "some keys may be missing", |
| 225 | total_corrupt_bytes, |
| 226 | corrupt_entries); |
| 227 | return Status::DATA_LOSS; |
| 228 | } |
| 229 | |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 230 | return Status::OK; |
| 231 | } |
| 232 | |
Alexei Frolov | 9e23583 | 2020-02-24 12:44:45 -0800 | [diff] [blame] | 233 | KeyValueStore::StorageStats KeyValueStore::GetStorageStats() const { |
| 234 | StorageStats stats{0, 0, 0}; |
| 235 | const size_t sector_size = partition_.sector_size_bytes(); |
| 236 | bool found_empty_sector = false; |
| 237 | |
| 238 | for (const SectorDescriptor& sector : sectors_) { |
| 239 | stats.in_use_bytes += sector.valid_bytes(); |
| 240 | stats.reclaimable_bytes += sector.RecoverableBytes(sector_size); |
| 241 | |
| 242 | if (!found_empty_sector && sector.Empty(sector_size)) { |
| 243 | // The KVS tries to always keep an empty sector for GC, so don't count |
| 244 | // the first empty sector seen as writable space. However, a free sector |
| 245 | // cannot always be assumed to exist; if a GC operation fails, all sectors |
| 246 | // may be partially written, in which case the space reported might be |
| 247 | // inaccurate. |
| 248 | found_empty_sector = true; |
| 249 | continue; |
| 250 | } |
| 251 | |
| 252 | stats.writable_bytes += sector.writable_bytes(); |
| 253 | } |
| 254 | |
| 255 | return stats; |
| 256 | } |
| 257 | |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 258 | Status KeyValueStore::LoadEntry(Address entry_address, |
| 259 | Address* next_entry_address) { |
Wyatt Hepler | e541e07 | 2020-02-14 09:10:53 -0800 | [diff] [blame] | 260 | Entry entry; |
Wyatt Hepler | 22d0d9f | 2020-03-05 14:57:11 -0800 | [diff] [blame] | 261 | TRY(Entry::Read(partition_, entry_address, formats_, &entry)); |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 262 | |
| 263 | // Read the key from flash & validate the entry (which reads the value). |
Wyatt Hepler | a00d1ef | 2020-02-14 14:31:26 -0800 | [diff] [blame] | 264 | Entry::KeyBuffer key_buffer; |
Wyatt Hepler | e541e07 | 2020-02-14 09:10:53 -0800 | [diff] [blame] | 265 | TRY_ASSIGN(size_t key_length, entry.ReadKey(key_buffer)); |
| 266 | const string_view key(key_buffer.data(), key_length); |
Wyatt Hepler | bab0e20 | 2020-02-04 07:40:08 -0800 | [diff] [blame] | 267 | |
Wyatt Hepler | 22d0d9f | 2020-03-05 14:57:11 -0800 | [diff] [blame] | 268 | TRY(entry.VerifyChecksumInFlash()); |
David Rogers | f56131c | 2020-03-04 10:19:22 -0800 | [diff] [blame] | 269 | |
| 270 | // A valid entry was found, so update the next entry address before doing any |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 271 | // of the checks that happen in AddNewOrUpdateExisting. |
David Rogers | f56131c | 2020-03-04 10:19:22 -0800 | [diff] [blame] | 272 | *next_entry_address = entry.next_address(); |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 273 | return entry_cache_.AddNewOrUpdateExisting( |
| 274 | entry.descriptor(key), entry.address(), partition_.sector_size_bytes()); |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 275 | } |
| 276 | |
Alexei Frolov | d4adf91 | 2020-02-21 13:29:15 -0800 | [diff] [blame] | 277 | // Scans flash memory within a sector to find a KVS entry magic. |
Alexei Frolov | d4adf91 | 2020-02-21 13:29:15 -0800 | [diff] [blame] | 278 | Status KeyValueStore::ScanForEntry(const SectorDescriptor& sector, |
| 279 | Address start_address, |
| 280 | Address* next_entry_address) { |
| 281 | DBG("Scanning sector %u for entries starting from address %zx", |
Wyatt Hepler | c84393f | 2020-03-20 11:23:24 -0700 | [diff] [blame^] | 282 | sectors_.Index(sector), |
Alexei Frolov | d4adf91 | 2020-02-21 13:29:15 -0800 | [diff] [blame] | 283 | size_t(start_address)); |
| 284 | |
| 285 | // Entries must start at addresses which are aligned on a multiple of |
| 286 | // Entry::kMinAlignmentBytes. However, that multiple can vary between entries. |
| 287 | // When scanning, we don't have an entry to tell us what the current alignment |
| 288 | // is, so the minimum alignment is used to be exhaustive. |
| 289 | for (Address address = AlignUp(start_address, Entry::kMinAlignmentBytes); |
Wyatt Hepler | c84393f | 2020-03-20 11:23:24 -0700 | [diff] [blame^] | 290 | sectors_.AddressInSector(sector, address); |
Alexei Frolov | d4adf91 | 2020-02-21 13:29:15 -0800 | [diff] [blame] | 291 | address += Entry::kMinAlignmentBytes) { |
Alexei Frolov | d4adf91 | 2020-02-21 13:29:15 -0800 | [diff] [blame] | 292 | uint32_t magic; |
| 293 | TRY(partition_.Read(address, as_writable_bytes(span(&magic, 1)))); |
Wyatt Hepler | 22d0d9f | 2020-03-05 14:57:11 -0800 | [diff] [blame] | 294 | if (formats_.KnownMagic(magic)) { |
Alexei Frolov | d4adf91 | 2020-02-21 13:29:15 -0800 | [diff] [blame] | 295 | DBG("Found entry magic at address %zx", size_t(address)); |
| 296 | *next_entry_address = address; |
| 297 | return Status::OK; |
| 298 | } |
| 299 | } |
| 300 | |
| 301 | return Status::NOT_FOUND; |
| 302 | } |
| 303 | |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 304 | StatusWithSize KeyValueStore::Get(string_view key, |
Wyatt Hepler | 5f6efc0 | 2020-02-18 16:54:31 -0800 | [diff] [blame] | 305 | span<byte> value_buffer, |
| 306 | size_t offset_bytes) const { |
Wyatt Hepler | 50f7077 | 2020-02-13 11:25:10 -0800 | [diff] [blame] | 307 | TRY_WITH_SIZE(CheckOperation(key)); |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 308 | |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 309 | EntryMetadata metadata; |
| 310 | TRY_WITH_SIZE(entry_cache_.FindExisting(partition_, key, &metadata)); |
Wyatt Hepler | 6c24c06 | 2020-02-05 15:30:49 -0800 | [diff] [blame] | 311 | |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 312 | return Get(key, metadata, value_buffer, offset_bytes); |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 313 | } |
| 314 | |
Wyatt Hepler | fac8113 | 2020-02-27 17:26:33 -0800 | [diff] [blame] | 315 | Status KeyValueStore::PutBytes(string_view key, span<const byte> value) { |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 316 | DBG("Writing key/value; key length=%zu, value length=%zu", |
| 317 | key.size(), |
| 318 | value.size()); |
Wyatt Hepler | 729f28c | 2020-02-05 09:46:00 -0800 | [diff] [blame] | 319 | |
| 320 | TRY(CheckOperation(key)); |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 321 | |
Wyatt Hepler | 5406a67 | 2020-02-18 15:42:38 -0800 | [diff] [blame] | 322 | if (Entry::size(partition_, key, value) > partition_.sector_size_bytes()) { |
| 323 | DBG("%zu B value with %zu B key cannot fit in one sector", |
| 324 | value.size(), |
| 325 | key.size()); |
| 326 | return Status::INVALID_ARGUMENT; |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 327 | } |
| 328 | |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 329 | EntryMetadata metadata; |
| 330 | Status status = entry_cache_.Find(partition_, key, &metadata); |
Wyatt Hepler | 2d40169 | 2020-02-13 16:01:23 -0800 | [diff] [blame] | 331 | |
| 332 | if (status.ok()) { |
David Rogers | f56131c | 2020-03-04 10:19:22 -0800 | [diff] [blame] | 333 | // TODO: figure out logging how to support multiple addresses. |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 334 | DBG("Overwriting entry for key 0x%08" PRIx32 " in %zu sectors including %u", |
| 335 | metadata.hash(), |
| 336 | metadata.addresses().size(), |
Wyatt Hepler | c84393f | 2020-03-20 11:23:24 -0700 | [diff] [blame^] | 337 | sectors_.Index(metadata.first_address())); |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 338 | return WriteEntryForExistingKey(metadata, EntryState::kValid, key, value); |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 339 | } |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame] | 340 | |
Wyatt Hepler | 2d40169 | 2020-02-13 16:01:23 -0800 | [diff] [blame] | 341 | if (status == Status::NOT_FOUND) { |
| 342 | return WriteEntryForNewKey(key, value); |
| 343 | } |
| 344 | |
| 345 | return status; |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 346 | } |
| 347 | |
| 348 | Status KeyValueStore::Delete(string_view key) { |
Wyatt Hepler | 729f28c | 2020-02-05 09:46:00 -0800 | [diff] [blame] | 349 | TRY(CheckOperation(key)); |
| 350 | |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 351 | EntryMetadata metadata; |
| 352 | TRY(entry_cache_.FindExisting(partition_, key, &metadata)); |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 353 | |
David Rogers | f56131c | 2020-03-04 10:19:22 -0800 | [diff] [blame] | 354 | // TODO: figure out logging how to support multiple addresses. |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 355 | DBG("Writing tombstone for key 0x%08" PRIx32 " in %zu sectors including %u", |
| 356 | metadata.hash(), |
| 357 | metadata.addresses().size(), |
Wyatt Hepler | c84393f | 2020-03-20 11:23:24 -0700 | [diff] [blame^] | 358 | sectors_.Index(metadata.first_address())); |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 359 | return WriteEntryForExistingKey(metadata, EntryState::kDeleted, key, {}); |
Wyatt Hepler | 6c24c06 | 2020-02-05 15:30:49 -0800 | [diff] [blame] | 360 | } |
| 361 | |
Wyatt Hepler | 08d37d8 | 2020-02-27 15:45:37 -0800 | [diff] [blame] | 362 | void KeyValueStore::Item::ReadKey() { |
| 363 | key_buffer_.fill('\0'); |
| 364 | |
| 365 | Entry entry; |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 366 | // TODO: add support for using one of the redundant entries if reading the |
| 367 | // first copy fails. |
Wyatt Hepler | 22d0d9f | 2020-03-05 14:57:11 -0800 | [diff] [blame] | 368 | if (Entry::Read( |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 369 | kvs_.partition_, iterator_->first_address(), kvs_.formats_, &entry) |
Wyatt Hepler | 22d0d9f | 2020-03-05 14:57:11 -0800 | [diff] [blame] | 370 | .ok()) { |
Wyatt Hepler | 08d37d8 | 2020-02-27 15:45:37 -0800 | [diff] [blame] | 371 | entry.ReadKey(key_buffer_); |
| 372 | } |
| 373 | } |
| 374 | |
Wyatt Hepler | 6c24c06 | 2020-02-05 15:30:49 -0800 | [diff] [blame] | 375 | KeyValueStore::iterator& KeyValueStore::iterator::operator++() { |
| 376 | // Skip to the next entry that is valid (not deleted). |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 377 | while (++item_.iterator_ != item_.kvs_.entry_cache_.end() && |
Wyatt Hepler | 0294627 | 2020-03-18 10:36:22 -0700 | [diff] [blame] | 378 | item_.iterator_->state() != EntryState::kValid) { |
Wyatt Hepler | 6c24c06 | 2020-02-05 15:30:49 -0800 | [diff] [blame] | 379 | } |
| 380 | return *this; |
| 381 | } |
| 382 | |
Wyatt Hepler | 6c24c06 | 2020-02-05 15:30:49 -0800 | [diff] [blame] | 383 | KeyValueStore::iterator KeyValueStore::begin() const { |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 384 | internal::EntryCache::iterator cache_iterator = entry_cache_.begin(); |
Wyatt Hepler | 6c24c06 | 2020-02-05 15:30:49 -0800 | [diff] [blame] | 385 | // Skip over any deleted entries at the start of the descriptor list. |
Wyatt Hepler | 0294627 | 2020-03-18 10:36:22 -0700 | [diff] [blame] | 386 | while (cache_iterator != entry_cache_.end() && |
| 387 | cache_iterator->state() != EntryState::kValid) { |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 388 | ++cache_iterator; |
Wyatt Hepler | 6c24c06 | 2020-02-05 15:30:49 -0800 | [diff] [blame] | 389 | } |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 390 | return iterator(*this, cache_iterator); |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 391 | } |
| 392 | |
Wyatt Hepler | ab3b249 | 2020-03-11 16:15:16 -0700 | [diff] [blame] | 393 | StatusWithSize KeyValueStore::ValueSize(string_view key) const { |
Wyatt Hepler | 50f7077 | 2020-02-13 11:25:10 -0800 | [diff] [blame] | 394 | TRY_WITH_SIZE(CheckOperation(key)); |
Wyatt Hepler | ed163b0 | 2020-02-03 17:49:32 -0800 | [diff] [blame] | 395 | |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 396 | EntryMetadata metadata; |
| 397 | TRY_WITH_SIZE(entry_cache_.FindExisting(partition_, key, &metadata)); |
Wyatt Hepler | 6c24c06 | 2020-02-05 15:30:49 -0800 | [diff] [blame] | 398 | |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 399 | return ValueSize(metadata); |
Wyatt Hepler | fac8113 | 2020-02-27 17:26:33 -0800 | [diff] [blame] | 400 | } |
Wyatt Hepler | ed163b0 | 2020-02-03 17:49:32 -0800 | [diff] [blame] | 401 | |
Wyatt Hepler | fac8113 | 2020-02-27 17:26:33 -0800 | [diff] [blame] | 402 | StatusWithSize KeyValueStore::Get(string_view key, |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 403 | const EntryMetadata& metadata, |
Wyatt Hepler | fac8113 | 2020-02-27 17:26:33 -0800 | [diff] [blame] | 404 | span<std::byte> value_buffer, |
| 405 | size_t offset_bytes) const { |
| 406 | Entry entry; |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 407 | // TODO: add support for using one of the redundant entries if reading the |
| 408 | // first copy fails. |
Wyatt Hepler | 22d0d9f | 2020-03-05 14:57:11 -0800 | [diff] [blame] | 409 | TRY_WITH_SIZE( |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 410 | Entry::Read(partition_, metadata.first_address(), formats_, &entry)); |
Wyatt Hepler | fac8113 | 2020-02-27 17:26:33 -0800 | [diff] [blame] | 411 | |
| 412 | StatusWithSize result = entry.ReadValue(value_buffer, offset_bytes); |
| 413 | if (result.ok() && options_.verify_on_read && offset_bytes == 0u) { |
Wyatt Hepler | 22d0d9f | 2020-03-05 14:57:11 -0800 | [diff] [blame] | 414 | Status verify_result = |
| 415 | entry.VerifyChecksum(key, value_buffer.first(result.size())); |
Wyatt Hepler | fac8113 | 2020-02-27 17:26:33 -0800 | [diff] [blame] | 416 | if (!verify_result.ok()) { |
| 417 | std::memset(value_buffer.data(), 0, result.size()); |
| 418 | return StatusWithSize(verify_result, 0); |
| 419 | } |
| 420 | |
| 421 | return StatusWithSize(verify_result, result.size()); |
| 422 | } |
| 423 | return result; |
Wyatt Hepler | ed163b0 | 2020-02-03 17:49:32 -0800 | [diff] [blame] | 424 | } |
| 425 | |
Wyatt Hepler | 6e3a83b | 2020-02-04 07:36:45 -0800 | [diff] [blame] | 426 | Status KeyValueStore::FixedSizeGet(std::string_view key, |
Wyatt Hepler | fac8113 | 2020-02-27 17:26:33 -0800 | [diff] [blame] | 427 | void* value, |
| 428 | size_t size_bytes) const { |
| 429 | TRY(CheckOperation(key)); |
| 430 | |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 431 | EntryMetadata metadata; |
| 432 | TRY(entry_cache_.FindExisting(partition_, key, &metadata)); |
Wyatt Hepler | fac8113 | 2020-02-27 17:26:33 -0800 | [diff] [blame] | 433 | |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 434 | return FixedSizeGet(key, metadata, value, size_bytes); |
Wyatt Hepler | fac8113 | 2020-02-27 17:26:33 -0800 | [diff] [blame] | 435 | } |
| 436 | |
| 437 | Status KeyValueStore::FixedSizeGet(std::string_view key, |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 438 | const EntryMetadata& metadata, |
Wyatt Hepler | fac8113 | 2020-02-27 17:26:33 -0800 | [diff] [blame] | 439 | void* value, |
Wyatt Hepler | 6e3a83b | 2020-02-04 07:36:45 -0800 | [diff] [blame] | 440 | size_t size_bytes) const { |
| 441 | // Ensure that the size of the stored value matches the size of the type. |
| 442 | // Otherwise, report error. This check avoids potential memory corruption. |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 443 | TRY_ASSIGN(const size_t actual_size, ValueSize(metadata)); |
Wyatt Hepler | fac8113 | 2020-02-27 17:26:33 -0800 | [diff] [blame] | 444 | |
| 445 | if (actual_size != size_bytes) { |
| 446 | 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] | 447 | return Status::INVALID_ARGUMENT; |
Wyatt Hepler | bab0e20 | 2020-02-04 07:40:08 -0800 | [diff] [blame] | 448 | } |
Wyatt Hepler | fac8113 | 2020-02-27 17:26:33 -0800 | [diff] [blame] | 449 | |
| 450 | StatusWithSize result = |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 451 | Get(key, metadata, span(static_cast<byte*>(value), size_bytes), 0); |
Wyatt Hepler | fac8113 | 2020-02-27 17:26:33 -0800 | [diff] [blame] | 452 | |
| 453 | return result.status(); |
| 454 | } |
| 455 | |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 456 | StatusWithSize KeyValueStore::ValueSize(const EntryMetadata& metadata) const { |
Wyatt Hepler | fac8113 | 2020-02-27 17:26:33 -0800 | [diff] [blame] | 457 | Entry entry; |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 458 | // TODO: add support for using one of the redundant entries if reading the |
| 459 | // first copy fails. |
Wyatt Hepler | 22d0d9f | 2020-03-05 14:57:11 -0800 | [diff] [blame] | 460 | TRY_WITH_SIZE( |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 461 | Entry::Read(partition_, metadata.first_address(), formats_, &entry)); |
Wyatt Hepler | fac8113 | 2020-02-27 17:26:33 -0800 | [diff] [blame] | 462 | |
| 463 | return StatusWithSize(entry.value_size()); |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 464 | } |
| 465 | |
Wyatt Hepler | 729f28c | 2020-02-05 09:46:00 -0800 | [diff] [blame] | 466 | Status KeyValueStore::CheckOperation(string_view key) const { |
Wyatt Hepler | acaacf9 | 2020-01-24 10:58:30 -0800 | [diff] [blame] | 467 | if (InvalidKey(key)) { |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 468 | return Status::INVALID_ARGUMENT; |
| 469 | } |
Wyatt Hepler | d229828 | 2020-02-20 17:12:45 -0800 | [diff] [blame] | 470 | if (!initialized()) { |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 471 | return Status::FAILED_PRECONDITION; |
| 472 | } |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 473 | return Status::OK; |
| 474 | } |
| 475 | |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 476 | Status KeyValueStore::WriteEntryForExistingKey(EntryMetadata& metadata, |
| 477 | EntryState new_state, |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 478 | string_view key, |
| 479 | span<const byte> value) { |
Wyatt Hepler | ab3b249 | 2020-03-11 16:15:16 -0700 | [diff] [blame] | 480 | // Read the original entry to get the size for sector accounting purposes. |
| 481 | Entry entry; |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 482 | // TODO: add support for using one of the redundant entries if reading the |
| 483 | // first copy fails. |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 484 | TRY(Entry::Read(partition_, metadata.first_address(), formats_, &entry)); |
Wyatt Hepler | 6c24c06 | 2020-02-05 15:30:49 -0800 | [diff] [blame] | 485 | |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 486 | return WriteEntry(key, value, new_state, &metadata, entry.size()); |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 487 | } |
| 488 | |
| 489 | Status KeyValueStore::WriteEntryForNewKey(string_view key, |
| 490 | span<const byte> value) { |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 491 | if (entry_cache_.full()) { |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 492 | WRN("KVS full: trying to store a new entry, but can't. Have %zu entries", |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 493 | entry_cache_.total_entries()); |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 494 | return Status::RESOURCE_EXHAUSTED; |
| 495 | } |
| 496 | |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 497 | return WriteEntry(key, value, EntryState::kValid); |
Wyatt Hepler | ab3b249 | 2020-03-11 16:15:16 -0700 | [diff] [blame] | 498 | } |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 499 | |
Wyatt Hepler | ab3b249 | 2020-03-11 16:15:16 -0700 | [diff] [blame] | 500 | Status KeyValueStore::WriteEntry(string_view key, |
| 501 | span<const byte> value, |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 502 | EntryState new_state, |
| 503 | EntryMetadata* prior_metadata, |
Wyatt Hepler | ab3b249 | 2020-03-11 16:15:16 -0700 | [diff] [blame] | 504 | size_t prior_size) { |
| 505 | const size_t entry_size = Entry::size(partition_, key, value); |
| 506 | |
| 507 | // List of addresses for sectors with space for this entry. |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 508 | Address* reserved_addresses = entry_cache_.TempReservedAddressesForWrite(); |
Wyatt Hepler | ab3b249 | 2020-03-11 16:15:16 -0700 | [diff] [blame] | 509 | |
| 510 | // Find sectors to write the entry to. This may involve garbage collecting one |
| 511 | // or more sectors. |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 512 | for (size_t i = 0; i < redundancy(); i++) { |
Wyatt Hepler | ab3b249 | 2020-03-11 16:15:16 -0700 | [diff] [blame] | 513 | SectorDescriptor* sector; |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 514 | TRY(GetSectorForWrite(§or, entry_size, span(reserved_addresses, i))); |
Wyatt Hepler | ab3b249 | 2020-03-11 16:15:16 -0700 | [diff] [blame] | 515 | |
Wyatt Hepler | c84393f | 2020-03-20 11:23:24 -0700 | [diff] [blame^] | 516 | DBG("Found space for entry in sector %u", sectors_.Index(sector)); |
| 517 | reserved_addresses[i] = sectors_.NextWritableAddress(*sector); |
Wyatt Hepler | ab3b249 | 2020-03-11 16:15:16 -0700 | [diff] [blame] | 518 | } |
| 519 | |
| 520 | // Write the entry at the first address that was found. |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 521 | Entry entry = CreateEntry(reserved_addresses[0], key, value, new_state); |
Wyatt Hepler | ab3b249 | 2020-03-11 16:15:16 -0700 | [diff] [blame] | 522 | TRY(AppendEntry(entry, key, value)); |
| 523 | |
| 524 | // After writing the first entry successfully, update the key descriptors. |
| 525 | // Once a single new the entry is written, the old entries are invalidated. |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 526 | EntryMetadata new_metadata = |
| 527 | UpdateKeyDescriptor(entry, key, prior_metadata, prior_size); |
Wyatt Hepler | ab3b249 | 2020-03-11 16:15:16 -0700 | [diff] [blame] | 528 | |
| 529 | // Write the additional copies of the entry, if redundancy is greater than 1. |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 530 | for (size_t i = 1; i < redundancy(); ++i) { |
| 531 | entry.set_address(reserved_addresses[i]); |
Wyatt Hepler | ab3b249 | 2020-03-11 16:15:16 -0700 | [diff] [blame] | 532 | TRY(AppendEntry(entry, key, value)); |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 533 | new_metadata.AddNewAddress(reserved_addresses[i]); |
Wyatt Hepler | ab3b249 | 2020-03-11 16:15:16 -0700 | [diff] [blame] | 534 | } |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 535 | return Status::OK; |
| 536 | } |
| 537 | |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 538 | KeyValueStore::EntryMetadata KeyValueStore::UpdateKeyDescriptor( |
Wyatt Hepler | ab3b249 | 2020-03-11 16:15:16 -0700 | [diff] [blame] | 539 | const Entry& entry, |
| 540 | string_view key, |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 541 | EntryMetadata* prior_metadata, |
Wyatt Hepler | ab3b249 | 2020-03-11 16:15:16 -0700 | [diff] [blame] | 542 | size_t prior_size) { |
| 543 | // If there is no prior descriptor, create a new one. |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 544 | if (prior_metadata == nullptr) { |
| 545 | return entry_cache_.AddNew(entry.descriptor(key), entry.address()); |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 546 | } |
| 547 | |
Wyatt Hepler | ab3b249 | 2020-03-11 16:15:16 -0700 | [diff] [blame] | 548 | // Remove valid bytes for the old entry and its copies, which are now stale. |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 549 | for (Address address : prior_metadata->addresses()) { |
Wyatt Hepler | c84393f | 2020-03-20 11:23:24 -0700 | [diff] [blame^] | 550 | sectors_.FromAddress(address).RemoveValidBytes(prior_size); |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 551 | } |
| 552 | |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 553 | prior_metadata->Reset(entry.descriptor(key), entry.address()); |
| 554 | return *prior_metadata; |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 555 | } |
| 556 | |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 557 | // Finds a sector to use for writing a new entry to. Does automatic garbage |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 558 | // collection if needed and allowed. |
| 559 | // |
| 560 | // OK: Sector found with needed space. |
| 561 | // RESOURCE_EXHAUSTED: No sector available with the needed space. |
| 562 | Status KeyValueStore::GetSectorForWrite(SectorDescriptor** sector, |
| 563 | size_t entry_size, |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 564 | span<const Address> reserved) { |
Wyatt Hepler | c84393f | 2020-03-20 11:23:24 -0700 | [diff] [blame^] | 565 | Status result = sectors_.FindSpace(sector, entry_size, reserved); |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 566 | |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 567 | size_t gc_sector_count = 0; |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 568 | bool do_auto_gc = options_.gc_on_write != GargbageCollectOnWrite::kDisabled; |
| 569 | |
| 570 | // Do garbage collection as needed, so long as policy allows. |
| 571 | while (result == Status::RESOURCE_EXHAUSTED && do_auto_gc) { |
| 572 | if (options_.gc_on_write == GargbageCollectOnWrite::kOneSector) { |
| 573 | // If GC config option is kOneSector clear the flag to not do any more |
| 574 | // GC after this try. |
| 575 | do_auto_gc = false; |
| 576 | } |
| 577 | // Garbage collect and then try again to find the best sector. |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 578 | Status gc_status = GarbageCollectPartial(reserved); |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 579 | if (!gc_status.ok()) { |
| 580 | if (gc_status == Status::NOT_FOUND) { |
| 581 | // Not enough space, and no reclaimable bytes, this KVS is full! |
| 582 | return Status::RESOURCE_EXHAUSTED; |
| 583 | } |
| 584 | return gc_status; |
| 585 | } |
| 586 | |
Wyatt Hepler | c84393f | 2020-03-20 11:23:24 -0700 | [diff] [blame^] | 587 | result = sectors_.FindSpace(sector, entry_size, reserved); |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 588 | |
| 589 | gc_sector_count++; |
| 590 | // Allow total sectors + 2 number of GC cycles so that once reclaimable |
| 591 | // bytes in all the sectors have been reclaimed can try and free up space by |
| 592 | // moving entries for keys other than the one being worked on in to sectors |
| 593 | // that have copies of the key trying to be written. |
| 594 | if (gc_sector_count > (partition_.sector_count() + 2)) { |
| 595 | ERR("Did more GC sectors than total sectors!!!!"); |
| 596 | return Status::RESOURCE_EXHAUSTED; |
| 597 | } |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 598 | } |
| 599 | |
| 600 | if (!result.ok()) { |
| 601 | WRN("Unable to find sector to write %zu B", entry_size); |
| 602 | } |
| 603 | return result; |
| 604 | } |
| 605 | |
Wyatt Hepler | ab3b249 | 2020-03-11 16:15:16 -0700 | [diff] [blame] | 606 | Status KeyValueStore::AppendEntry(const Entry& entry, |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 607 | string_view key, |
| 608 | span<const byte> value) { |
Wyatt Hepler | ab3b249 | 2020-03-11 16:15:16 -0700 | [diff] [blame] | 609 | const StatusWithSize result = entry.Write(key, value); |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 610 | |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 611 | // Remove any bytes that were written, even if the write was not successful. |
| 612 | // This is important to retain the writable space invariant on the sectors. |
Wyatt Hepler | c84393f | 2020-03-20 11:23:24 -0700 | [diff] [blame^] | 613 | SectorDescriptor& sector = sectors_.FromAddress(entry.address()); |
| 614 | sector.RemoveWritableBytes(result.size()); |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 615 | |
| 616 | if (!result.ok()) { |
| 617 | ERR("Failed to write %zu bytes at %#zx. %zu actually written", |
| 618 | entry.size(), |
Wyatt Hepler | ab3b249 | 2020-03-11 16:15:16 -0700 | [diff] [blame] | 619 | size_t(entry.address()), |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 620 | result.size()); |
| 621 | return result.status(); |
| 622 | } |
| 623 | |
| 624 | if (options_.verify_on_write) { |
| 625 | TRY(entry.VerifyChecksumInFlash()); |
| 626 | } |
| 627 | |
Wyatt Hepler | c84393f | 2020-03-20 11:23:24 -0700 | [diff] [blame^] | 628 | sector.AddValidBytes(result.size()); |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 629 | return Status::OK; |
| 630 | } |
| 631 | |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 632 | Status KeyValueStore::RelocateEntry(const EntryMetadata& metadata, |
Wyatt Hepler | ab3b249 | 2020-03-11 16:15:16 -0700 | [diff] [blame] | 633 | KeyValueStore::Address& address, |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 634 | span<const Address> reserved_addresses) { |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 635 | Entry entry; |
Wyatt Hepler | ab3b249 | 2020-03-11 16:15:16 -0700 | [diff] [blame] | 636 | TRY(Entry::Read(partition_, address, formats_, &entry)); |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 637 | |
| 638 | // Find a new sector for the entry and write it to the new location. For |
| 639 | // relocation the find should not not be a sector already containing the key |
| 640 | // but can be the always empty sector, since this is part of the GC process |
| 641 | // that will result in a new empty sector. Also find a sector that does not |
| 642 | // have reclaimable space (mostly for the full GC, where that would result in |
| 643 | // an immediate extra relocation). |
| 644 | SectorDescriptor* new_sector; |
| 645 | |
Wyatt Hepler | c84393f | 2020-03-20 11:23:24 -0700 | [diff] [blame^] | 646 | TRY(sectors_.FindSpaceDuringGarbageCollection( |
| 647 | &new_sector, entry.size(), metadata.addresses(), reserved_addresses)); |
Wyatt Hepler | ab3b249 | 2020-03-11 16:15:16 -0700 | [diff] [blame] | 648 | |
Wyatt Hepler | c84393f | 2020-03-20 11:23:24 -0700 | [diff] [blame^] | 649 | const Address new_address = sectors_.NextWritableAddress(*new_sector); |
Wyatt Hepler | ab3b249 | 2020-03-11 16:15:16 -0700 | [diff] [blame] | 650 | const StatusWithSize result = entry.Copy(new_address); |
| 651 | new_sector->RemoveWritableBytes(result.size()); |
| 652 | TRY(result); |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 653 | |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 654 | // Entry was written successfully; update descriptor's address and the sector |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 655 | // descriptors to reflect the new entry. |
Wyatt Hepler | c84393f | 2020-03-20 11:23:24 -0700 | [diff] [blame^] | 656 | sectors_.FromAddress(address).RemoveValidBytes(result.size()); |
Wyatt Hepler | ab3b249 | 2020-03-11 16:15:16 -0700 | [diff] [blame] | 657 | new_sector->AddValidBytes(result.size()); |
| 658 | address = new_address; |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 659 | |
| 660 | return Status::OK; |
| 661 | } |
| 662 | |
David Rogers | cd87c32 | 2020-02-27 14:04:08 -0800 | [diff] [blame] | 663 | Status KeyValueStore::GarbageCollectFull() { |
| 664 | DBG("Garbage Collect all sectors"); |
Wyatt Hepler | c84393f | 2020-03-20 11:23:24 -0700 | [diff] [blame^] | 665 | |
| 666 | SectorDescriptor* sector = sectors_.last_new(); |
David Rogers | cd87c32 | 2020-02-27 14:04:08 -0800 | [diff] [blame] | 667 | |
| 668 | // TODO: look in to making an iterator method for cycling through sectors |
| 669 | // starting from last_new_sector_. |
| 670 | for (size_t j = 0; j < sectors_.size(); j++) { |
| 671 | sector += 1; |
| 672 | if (sector == sectors_.end()) { |
| 673 | sector = sectors_.begin(); |
| 674 | } |
| 675 | |
| 676 | if (sector->RecoverableBytes(partition_.sector_size_bytes()) > 0) { |
Wyatt Hepler | c84393f | 2020-03-20 11:23:24 -0700 | [diff] [blame^] | 677 | TRY(GarbageCollectSector(*sector, {})); |
David Rogers | cd87c32 | 2020-02-27 14:04:08 -0800 | [diff] [blame] | 678 | } |
| 679 | } |
| 680 | |
| 681 | DBG("Garbage Collect all complete"); |
David Rogers | cd87c32 | 2020-02-27 14:04:08 -0800 | [diff] [blame] | 682 | return Status::OK; |
| 683 | } |
| 684 | |
David Rogers | c9d545e | 2020-03-11 17:47:43 -0700 | [diff] [blame] | 685 | Status KeyValueStore::GarbageCollectPartial( |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 686 | span<const Address> reserved_addresses) { |
David Rogers | c9d545e | 2020-03-11 17:47:43 -0700 | [diff] [blame] | 687 | DBG("Garbage Collect a single sector"); |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 688 | for (Address address : reserved_addresses) { |
David Rogers | c9d545e | 2020-03-11 17:47:43 -0700 | [diff] [blame] | 689 | DBG(" Avoid address %u", unsigned(address)); |
| 690 | } |
David Rogers | 67f4b6c | 2020-02-06 16:17:09 -0800 | [diff] [blame] | 691 | |
David Rogers | a12786b | 2020-01-31 16:02:33 -0800 | [diff] [blame] | 692 | // Step 1: Find the sector to garbage collect |
David Rogers | c9d545e | 2020-03-11 17:47:43 -0700 | [diff] [blame] | 693 | SectorDescriptor* sector_to_gc = |
Wyatt Hepler | c84393f | 2020-03-20 11:23:24 -0700 | [diff] [blame^] | 694 | sectors_.FindSectorToGarbageCollect(reserved_addresses); |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 695 | |
David Rogers | a12786b | 2020-01-31 16:02:33 -0800 | [diff] [blame] | 696 | if (sector_to_gc == nullptr) { |
David Rogers | a2562b5 | 2020-03-05 15:30:05 -0800 | [diff] [blame] | 697 | // Nothing to GC. |
| 698 | return Status::NOT_FOUND; |
David Rogers | a12786b | 2020-01-31 16:02:33 -0800 | [diff] [blame] | 699 | } |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 700 | |
David Rogers | c9d545e | 2020-03-11 17:47:43 -0700 | [diff] [blame] | 701 | // Step 2: Garbage collect the selected sector. |
Wyatt Hepler | c84393f | 2020-03-20 11:23:24 -0700 | [diff] [blame^] | 702 | return GarbageCollectSector(*sector_to_gc, reserved_addresses); |
David Rogers | cd87c32 | 2020-02-27 14:04:08 -0800 | [diff] [blame] | 703 | } |
| 704 | |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 705 | Status KeyValueStore::RelocateKeyAddressesInSector( |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 706 | SectorDescriptor& sector_to_gc, |
| 707 | const EntryMetadata& metadata, |
| 708 | span<const Address> reserved_addresses) { |
| 709 | for (FlashPartition::Address& address : metadata.addresses()) { |
Wyatt Hepler | c84393f | 2020-03-20 11:23:24 -0700 | [diff] [blame^] | 710 | if (sectors_.AddressInSector(sector_to_gc, address)) { |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 711 | DBG(" Relocate entry for Key 0x%08" PRIx32 ", sector %u", |
| 712 | metadata.hash(), |
Wyatt Hepler | c84393f | 2020-03-20 11:23:24 -0700 | [diff] [blame^] | 713 | sectors_.Index(sectors_.FromAddress(address))); |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 714 | TRY(RelocateEntry(metadata, address, reserved_addresses)); |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 715 | } |
| 716 | } |
Wyatt Hepler | ab3b249 | 2020-03-11 16:15:16 -0700 | [diff] [blame] | 717 | |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 718 | return Status::OK; |
| 719 | }; |
| 720 | |
Wyatt Hepler | ab3b249 | 2020-03-11 16:15:16 -0700 | [diff] [blame] | 721 | Status KeyValueStore::GarbageCollectSector( |
Wyatt Hepler | c84393f | 2020-03-20 11:23:24 -0700 | [diff] [blame^] | 722 | SectorDescriptor& sector_to_gc, span<const Address> reserved_addresses) { |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 723 | // Step 1: Move any valid entries in the GC sector to other sectors |
Wyatt Hepler | c84393f | 2020-03-20 11:23:24 -0700 | [diff] [blame^] | 724 | if (sector_to_gc.valid_bytes() != 0) { |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 725 | for (const EntryMetadata& metadata : entry_cache_) { |
Wyatt Hepler | ab3b249 | 2020-03-11 16:15:16 -0700 | [diff] [blame] | 726 | TRY(RelocateKeyAddressesInSector( |
Wyatt Hepler | c84393f | 2020-03-20 11:23:24 -0700 | [diff] [blame^] | 727 | sector_to_gc, metadata, reserved_addresses)); |
David Rogers | f3884eb | 2020-03-08 19:21:40 -0700 | [diff] [blame] | 728 | } |
| 729 | } |
| 730 | |
Wyatt Hepler | c84393f | 2020-03-20 11:23:24 -0700 | [diff] [blame^] | 731 | if (sector_to_gc.valid_bytes() != 0) { |
David Rogers | 67f4b6c | 2020-02-06 16:17:09 -0800 | [diff] [blame] | 732 | ERR(" Failed to relocate valid entries from sector being garbage " |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 733 | "collected, %zu valid bytes remain", |
Wyatt Hepler | c84393f | 2020-03-20 11:23:24 -0700 | [diff] [blame^] | 734 | sector_to_gc.valid_bytes()); |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 735 | return Status::INTERNAL; |
| 736 | } |
| 737 | |
David Rogers | cd87c32 | 2020-02-27 14:04:08 -0800 | [diff] [blame] | 738 | // Step 2: Reinitialize the sector |
Wyatt Hepler | c84393f | 2020-03-20 11:23:24 -0700 | [diff] [blame^] | 739 | sector_to_gc.set_writable_bytes(0); |
| 740 | TRY(partition_.Erase(sectors_.BaseAddress(sector_to_gc), 1)); |
| 741 | sector_to_gc.set_writable_bytes(partition_.sector_size_bytes()); |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 742 | |
Wyatt Hepler | c84393f | 2020-03-20 11:23:24 -0700 | [diff] [blame^] | 743 | DBG(" Garbage Collect sector %u complete", sectors_.Index(sector_to_gc)); |
David Rogers | a12786b | 2020-01-31 16:02:33 -0800 | [diff] [blame] | 744 | return Status::OK; |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 745 | } |
| 746 | |
Wyatt Hepler | bdd8e5a | 2020-02-20 19:27:26 -0800 | [diff] [blame] | 747 | KeyValueStore::Entry KeyValueStore::CreateEntry(Address address, |
Wyatt Hepler | ab3b249 | 2020-03-11 16:15:16 -0700 | [diff] [blame] | 748 | string_view key, |
Wyatt Hepler | bdd8e5a | 2020-02-20 19:27:26 -0800 | [diff] [blame] | 749 | span<const byte> value, |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 750 | EntryState state) { |
Keir Mierle | 9e38b40 | 2020-02-21 13:06:21 -0800 | [diff] [blame] | 751 | // Always bump the transaction ID when creating a new entry. |
| 752 | // |
| 753 | // Burning transaction IDs prevents inconsistencies between flash and memory |
| 754 | // that which could happen if a write succeeds, but for some reason the read |
| 755 | // and verify step fails. Here's how this would happen: |
| 756 | // |
| 757 | // 1. The entry is written but for some reason the flash reports failure OR |
| 758 | // The write succeeds, but the read / verify operation fails. |
| 759 | // 2. The transaction ID is NOT incremented, because of the failure |
| 760 | // 3. (later) A new entry is written, re-using the transaction ID (oops) |
| 761 | // |
| 762 | // By always burning transaction IDs, the above problem can't happen. |
| 763 | last_transaction_id_ += 1; |
| 764 | |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 765 | if (state == EntryState::kDeleted) { |
Wyatt Hepler | 7465be3 | 2020-02-21 15:30:53 -0800 | [diff] [blame] | 766 | return Entry::Tombstone( |
Wyatt Hepler | 22d0d9f | 2020-03-05 14:57:11 -0800 | [diff] [blame] | 767 | partition_, address, formats_.primary(), key, last_transaction_id_); |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 768 | } |
| 769 | return Entry::Valid(partition_, |
| 770 | address, |
Wyatt Hepler | 22d0d9f | 2020-03-05 14:57:11 -0800 | [diff] [blame] | 771 | formats_.primary(), |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 772 | key, |
| 773 | value, |
Keir Mierle | 9e38b40 | 2020-02-21 13:06:21 -0800 | [diff] [blame] | 774 | last_transaction_id_); |
Wyatt Hepler | d229828 | 2020-02-20 17:12:45 -0800 | [diff] [blame] | 775 | } |
| 776 | |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 777 | void KeyValueStore::LogDebugInfo() const { |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 778 | const size_t sector_size_bytes = partition_.sector_size_bytes(); |
| 779 | DBG("====================== KEY VALUE STORE DUMP ========================="); |
| 780 | DBG(" "); |
| 781 | DBG("Flash partition:"); |
Wyatt Hepler | ad0a793 | 2020-02-06 08:20:38 -0800 | [diff] [blame] | 782 | DBG(" Sector count = %zu", partition_.sector_count()); |
Wyatt Hepler | 38ce30f | 2020-02-19 11:48:31 -0800 | [diff] [blame] | 783 | DBG(" Sector max count = %zu", sectors_.max_size()); |
Wyatt Hepler | 1c329ca | 2020-02-07 18:07:23 -0800 | [diff] [blame] | 784 | DBG(" Sectors in use = %zu", sectors_.size()); |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 785 | DBG(" Sector size = %zu", sector_size_bytes); |
| 786 | DBG(" Total size = %zu", partition_.size_bytes()); |
| 787 | DBG(" Alignment = %zu", partition_.alignment_bytes()); |
| 788 | DBG(" "); |
| 789 | DBG("Key descriptors:"); |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 790 | DBG(" Entry count = %zu", entry_cache_.total_entries()); |
| 791 | DBG(" Max entry count = %zu", entry_cache_.max_entries()); |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 792 | DBG(" "); |
| 793 | DBG(" # hash version address address (hex)"); |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 794 | size_t i = 0; |
| 795 | for (const EntryMetadata& metadata : entry_cache_) { |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 796 | DBG(" |%3zu: | %8zx |%8zu | %8zu | %8zx", |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 797 | i++, |
| 798 | size_t(metadata.hash()), |
| 799 | size_t(metadata.transaction_id()), |
| 800 | size_t(metadata.first_address()), |
| 801 | size_t(metadata.first_address())); |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 802 | } |
| 803 | DBG(" "); |
| 804 | |
| 805 | DBG("Sector descriptors:"); |
| 806 | DBG(" # tail free valid has_space"); |
Wyatt Hepler | c84393f | 2020-03-20 11:23:24 -0700 | [diff] [blame^] | 807 | for (const SectorDescriptor& sd : sectors_) { |
| 808 | DBG(" |%3u: | %8zu |%8zu | %s", |
| 809 | sectors_.Index(sd), |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 810 | size_t(sd.writable_bytes()), |
| 811 | sd.valid_bytes(), |
| 812 | sd.writable_bytes() ? "YES" : ""); |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 813 | } |
| 814 | DBG(" "); |
| 815 | |
| 816 | // TODO: This should stop logging after some threshold. |
| 817 | // size_t dumped_bytes = 0; |
| 818 | DBG("Sector raw data:"); |
Wyatt Hepler | 1c329ca | 2020-02-07 18:07:23 -0800 | [diff] [blame] | 819 | for (size_t sector_id = 0; sector_id < sectors_.size(); ++sector_id) { |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 820 | // Read sector data. Yes, this will blow the stack on embedded. |
Wyatt Hepler | 1c329ca | 2020-02-07 18:07:23 -0800 | [diff] [blame] | 821 | std::array<byte, 500> raw_sector_data; // TODO!!! |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 822 | StatusWithSize sws = |
| 823 | partition_.Read(sector_id * sector_size_bytes, raw_sector_data); |
| 824 | DBG("Read: %zu bytes", sws.size()); |
| 825 | |
| 826 | DBG(" base addr offs 0 1 2 3 4 5 6 7"); |
| 827 | for (size_t i = 0; i < sector_size_bytes; i += 8) { |
| 828 | DBG(" %3zu %8zx %5zu | %02x %02x %02x %02x %02x %02x %02x %02x", |
| 829 | sector_id, |
| 830 | (sector_id * sector_size_bytes) + i, |
| 831 | i, |
| 832 | static_cast<unsigned int>(raw_sector_data[i + 0]), |
| 833 | static_cast<unsigned int>(raw_sector_data[i + 1]), |
| 834 | static_cast<unsigned int>(raw_sector_data[i + 2]), |
| 835 | static_cast<unsigned int>(raw_sector_data[i + 3]), |
| 836 | static_cast<unsigned int>(raw_sector_data[i + 4]), |
| 837 | static_cast<unsigned int>(raw_sector_data[i + 5]), |
| 838 | static_cast<unsigned int>(raw_sector_data[i + 6]), |
| 839 | static_cast<unsigned int>(raw_sector_data[i + 7])); |
| 840 | |
| 841 | // TODO: Fix exit condition. |
| 842 | if (i > 128) { |
| 843 | break; |
| 844 | } |
| 845 | } |
| 846 | DBG(" "); |
| 847 | } |
| 848 | |
| 849 | DBG("////////////////////// KEY VALUE STORE DUMP END /////////////////////"); |
| 850 | } |
| 851 | |
David Rogers | cf680ab | 2020-02-12 23:28:32 -0800 | [diff] [blame] | 852 | void KeyValueStore::LogSectors() const { |
| 853 | DBG("Sector descriptors: count %zu", sectors_.size()); |
Wyatt Hepler | 1c329ca | 2020-02-07 18:07:23 -0800 | [diff] [blame] | 854 | for (auto& sector : sectors_) { |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 855 | DBG(" - Sector %u: valid %zu, recoverable %zu, free %zu", |
Wyatt Hepler | c84393f | 2020-03-20 11:23:24 -0700 | [diff] [blame^] | 856 | sectors_.Index(sector), |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 857 | sector.valid_bytes(), |
| 858 | sector.RecoverableBytes(partition_.sector_size_bytes()), |
| 859 | sector.writable_bytes()); |
David Rogers | 50185ad | 2020-02-07 00:02:46 -0800 | [diff] [blame] | 860 | } |
| 861 | } |
| 862 | |
David Rogers | cf680ab | 2020-02-12 23:28:32 -0800 | [diff] [blame] | 863 | void KeyValueStore::LogKeyDescriptor() const { |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 864 | DBG("Key descriptors: count %zu", entry_cache_.total_entries()); |
| 865 | for (auto& metadata : entry_cache_) { |
| 866 | DBG(" - Key: %s, hash %#zx, transaction ID %zu, first address %#zx", |
Wyatt Hepler | 0294627 | 2020-03-18 10:36:22 -0700 | [diff] [blame] | 867 | metadata.state() == EntryState::kDeleted ? "Deleted" : "Valid", |
Wyatt Hepler | 7ded6da | 2020-03-11 18:24:43 -0700 | [diff] [blame] | 868 | static_cast<size_t>(metadata.hash()), |
| 869 | static_cast<size_t>(metadata.transaction_id()), |
| 870 | static_cast<size_t>(metadata.first_address())); |
David Rogers | cf680ab | 2020-02-12 23:28:32 -0800 | [diff] [blame] | 871 | } |
| 872 | } |
| 873 | |
Wyatt Hepler | 2ad6067 | 2020-01-21 08:00:16 -0800 | [diff] [blame] | 874 | } // namespace pw::kvs |