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