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