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