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