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