Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 1 | // Copyright 2020 The Pigweed Authors |
| 2 | // |
| 3 | // Licensed under the Apache License, Version 2.0 (the "License"); you may not |
| 4 | // use this file except in compliance with the License. You may obtain a copy of |
| 5 | // the License at |
| 6 | // |
| 7 | // https://www.apache.org/licenses/LICENSE-2.0 |
| 8 | // |
| 9 | // Unless required by applicable law or agreed to in writing, software |
| 10 | // distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| 11 | // WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
| 12 | // License for the specific language governing permissions and limitations under |
| 13 | // the License. |
| 14 | |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 15 | #include "pw_kvs/key_value_store.h" |
| 16 | |
Wyatt Hepler | bab0e20 | 2020-02-04 07:40:08 -0800 | [diff] [blame] | 17 | #include <algorithm> |
Wyatt Hepler | 5a33d8c | 2020-02-06 09:32:58 -0800 | [diff] [blame] | 18 | #include <cinttypes> |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 19 | #include <cstring> |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 20 | #include <type_traits> |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 21 | |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 22 | #define PW_LOG_USE_ULTRA_SHORT_NAMES 1 |
Wyatt Hepler | bdd8e5a | 2020-02-20 19:27:26 -0800 | [diff] [blame^] | 23 | #include "pw_kvs/internal/entry.h" |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 24 | #include "pw_kvs_private/macros.h" |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 25 | #include "pw_log/log.h" |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 26 | |
Wyatt Hepler | 2ad6067 | 2020-01-21 08:00:16 -0800 | [diff] [blame] | 27 | namespace pw::kvs { |
Wyatt Hepler | a00d1ef | 2020-02-14 14:31:26 -0800 | [diff] [blame] | 28 | namespace { |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 29 | |
Wyatt Hepler | acaacf9 | 2020-01-24 10:58:30 -0800 | [diff] [blame] | 30 | using std::byte; |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 31 | using std::string_view; |
Wyatt Hepler | acaacf9 | 2020-01-24 10:58:30 -0800 | [diff] [blame] | 32 | |
Wyatt Hepler | a00d1ef | 2020-02-14 14:31:26 -0800 | [diff] [blame] | 33 | constexpr bool InvalidKey(std::string_view key) { |
Wyatt Hepler | bdd8e5a | 2020-02-20 19:27:26 -0800 | [diff] [blame^] | 34 | return key.empty() || (key.size() > internal::Entry::kMaxKeyLength); |
Wyatt Hepler | a00d1ef | 2020-02-14 14:31:26 -0800 | [diff] [blame] | 35 | } |
| 36 | |
| 37 | } // namespace |
| 38 | |
Wyatt Hepler | ad0a793 | 2020-02-06 08:20:38 -0800 | [diff] [blame] | 39 | KeyValueStore::KeyValueStore(FlashPartition* partition, |
Wyatt Hepler | 38ce30f | 2020-02-19 11:48:31 -0800 | [diff] [blame] | 40 | Vector<KeyDescriptor>& key_descriptor_list, |
| 41 | Vector<SectorDescriptor>& sector_descriptor_list, |
Wyatt Hepler | ad0a793 | 2020-02-06 08:20:38 -0800 | [diff] [blame] | 42 | const EntryHeaderFormat& format, |
| 43 | const Options& options) |
| 44 | : partition_(*partition), |
| 45 | entry_header_format_(format), |
Wyatt Hepler | 38ce30f | 2020-02-19 11:48:31 -0800 | [diff] [blame] | 46 | key_descriptors_(key_descriptor_list), |
Wyatt Hepler | d229828 | 2020-02-20 17:12:45 -0800 | [diff] [blame] | 47 | sectors_(sector_descriptor_list), |
| 48 | options_(options) { |
| 49 | Reset(); |
| 50 | } |
Wyatt Hepler | ad0a793 | 2020-02-06 08:20:38 -0800 | [diff] [blame] | 51 | |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 52 | Status KeyValueStore::Init() { |
Wyatt Hepler | d229828 | 2020-02-20 17:12:45 -0800 | [diff] [blame] | 53 | Reset(); |
| 54 | |
David Rogers | 2e9e0c8 | 2020-02-13 15:06:06 -0800 | [diff] [blame] | 55 | INF("Initializing key value store"); |
Wyatt Hepler | 38ce30f | 2020-02-19 11:48:31 -0800 | [diff] [blame] | 56 | if (partition_.sector_count() > sectors_.max_size()) { |
David Rogers | 2e9e0c8 | 2020-02-13 15:06:06 -0800 | [diff] [blame] | 57 | ERR("KVS init failed: kMaxUsableSectors (=%zu) must be at least as " |
| 58 | "large as the number of sectors in the flash partition (=%zu)", |
Wyatt Hepler | 38ce30f | 2020-02-19 11:48:31 -0800 | [diff] [blame] | 59 | sectors_.max_size(), |
David Rogers | 2e9e0c8 | 2020-02-13 15:06:06 -0800 | [diff] [blame] | 60 | partition_.sector_count()); |
Wyatt Hepler | ad0a793 | 2020-02-06 08:20:38 -0800 | [diff] [blame] | 61 | return Status::FAILED_PRECONDITION; |
| 62 | } |
| 63 | |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 64 | const size_t sector_size_bytes = partition_.sector_size_bytes(); |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 65 | |
David Rogers | f0a3544 | 2020-02-04 12:16:38 -0800 | [diff] [blame] | 66 | if (working_buffer_.size() < sector_size_bytes) { |
David Rogers | 2e9e0c8 | 2020-02-13 15:06:06 -0800 | [diff] [blame] | 67 | ERR("KVS init failed: working_buffer_ (%zu bytes) is smaller than sector " |
| 68 | "size (%zu bytes)", |
David Rogers | f0a3544 | 2020-02-04 12:16:38 -0800 | [diff] [blame] | 69 | working_buffer_.size(), |
| 70 | sector_size_bytes); |
| 71 | return Status::INVALID_ARGUMENT; |
| 72 | } |
| 73 | |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 74 | DBG("First pass: Read all entries from all sectors"); |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 75 | Address sector_address = 0; |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 76 | |
Wyatt Hepler | d229828 | 2020-02-20 17:12:45 -0800 | [diff] [blame] | 77 | sectors_.assign(partition_.sector_count(), |
| 78 | SectorDescriptor(sector_size_bytes)); |
| 79 | |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 80 | for (SectorDescriptor& sector : sectors_) { |
| 81 | // Reset the sector's valid and writable byte counts. These will be updated |
| 82 | // after reading each entry. |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 83 | Address entry_address = sector_address; |
| 84 | |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 85 | for (int num_entries_in_sector = 0; true; num_entries_in_sector++) { |
| 86 | DBG("Load entry: sector=%" PRIx32 ", entry#=%d, address=%" PRIx32, |
| 87 | sector_address, |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 88 | num_entries_in_sector, |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 89 | entry_address); |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 90 | |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 91 | if (!AddressInSector(sector, entry_address)) { |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 92 | DBG("Fell off end of sector; moving to the next sector"); |
| 93 | break; |
| 94 | } |
| 95 | |
| 96 | Address next_entry_address; |
| 97 | Status status = LoadEntry(entry_address, &next_entry_address); |
| 98 | if (status == Status::NOT_FOUND) { |
| 99 | DBG("Hit un-written data in sector; moving to the next sector"); |
| 100 | break; |
| 101 | } |
| 102 | if (status == Status::DATA_LOSS) { |
| 103 | // It's not clear KVS can make a unilateral decision about what to do |
| 104 | // in corruption cases. It's an application decision, for which we |
| 105 | // should offer some configurability. For now, entirely bail out of |
| 106 | // loading and give up. |
| 107 | // |
| 108 | // Later, scan for remaining valid keys; since it's entirely possible |
| 109 | // that there is a duplicate of the key elsewhere and everything is |
| 110 | // fine. Later, we can wipe and maybe recover the sector. |
| 111 | // |
| 112 | // TODO: Implement rest-of-sector scanning for valid entries. |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 113 | ERR("KVS init failed: data loss detected in sector %u at address %zu", |
| 114 | SectorIndex(§or), |
| 115 | size_t(entry_address)); |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 116 | return Status::DATA_LOSS; |
| 117 | } |
| 118 | TRY(status); |
| 119 | |
| 120 | // Entry loaded successfully; so get ready to load the next one. |
| 121 | entry_address = next_entry_address; |
| 122 | |
| 123 | // Update of the number of writable bytes in this sector. |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 124 | sector.set_writable_bytes(sector_size_bytes - |
| 125 | (entry_address - sector_address)); |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 126 | } |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 127 | |
| 128 | sector_address += sector_size_bytes; |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 129 | } |
| 130 | |
| 131 | DBG("Second pass: Count valid bytes in each sector"); |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 132 | const KeyDescriptor* newest_key = nullptr; |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 133 | |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 134 | // For every valid key, increment the valid bytes for that sector. |
Wyatt Hepler | 1c329ca | 2020-02-07 18:07:23 -0800 | [diff] [blame] | 135 | for (KeyDescriptor& key_descriptor : key_descriptors_) { |
Wyatt Hepler | e541e07 | 2020-02-14 09:10:53 -0800 | [diff] [blame] | 136 | Entry entry; |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 137 | TRY(Entry::Read(partition_, key_descriptor.address(), &entry)); |
| 138 | SectorFromKey(key_descriptor)->AddValidBytes(entry.size()); |
| 139 | |
| 140 | if (key_descriptor.IsNewerThan(last_transaction_id_)) { |
| 141 | last_transaction_id_ = key_descriptor.transaction_id(); |
| 142 | newest_key = &key_descriptor; |
| 143 | } |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 144 | } |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 145 | |
| 146 | if (newest_key == nullptr) { |
| 147 | last_new_sector_ = sectors_.begin(); |
| 148 | } else { |
| 149 | last_new_sector_ = SectorFromKey(newest_key); |
| 150 | } |
| 151 | |
Wyatt Hepler | 729f28c | 2020-02-05 09:46:00 -0800 | [diff] [blame] | 152 | initialized_ = true; |
David Rogers | 2e9e0c8 | 2020-02-13 15:06:06 -0800 | [diff] [blame] | 153 | |
Armando Montanez | 5464d5f | 2020-02-20 10:12:20 -0800 | [diff] [blame] | 154 | INF("KeyValueStore init complete: active keys %zu, deleted keys %zu, sectors " |
David Rogers | 2e9e0c8 | 2020-02-13 15:06:06 -0800 | [diff] [blame] | 155 | "%zu, logical sector size %zu bytes", |
| 156 | size(), |
| 157 | (key_descriptors_.size() - size()), |
| 158 | sectors_.size(), |
| 159 | partition_.sector_size_bytes()); |
| 160 | |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 161 | return Status::OK; |
| 162 | } |
| 163 | |
| 164 | Status KeyValueStore::LoadEntry(Address entry_address, |
| 165 | Address* next_entry_address) { |
Wyatt Hepler | e541e07 | 2020-02-14 09:10:53 -0800 | [diff] [blame] | 166 | Entry entry; |
| 167 | TRY(Entry::Read(partition_, entry_address, &entry)); |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 168 | |
| 169 | // TODO: Handle multiple magics for formats that have changed. |
Wyatt Hepler | e541e07 | 2020-02-14 09:10:53 -0800 | [diff] [blame] | 170 | if (entry.magic() != entry_header_format_.magic) { |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 171 | // TODO: It may be cleaner to have some logging helpers for these cases. |
Wyatt Hepler | e541e07 | 2020-02-14 09:10:53 -0800 | [diff] [blame] | 172 | ERR("Found corrupt magic: %zx; expecting %zx; at address %zx", |
| 173 | size_t(entry.magic()), |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 174 | size_t(entry_header_format_.magic), |
| 175 | size_t(entry_address)); |
| 176 | return Status::DATA_LOSS; |
| 177 | } |
| 178 | |
| 179 | // Read the key from flash & validate the entry (which reads the value). |
Wyatt Hepler | a00d1ef | 2020-02-14 14:31:26 -0800 | [diff] [blame] | 180 | Entry::KeyBuffer key_buffer; |
Wyatt Hepler | e541e07 | 2020-02-14 09:10:53 -0800 | [diff] [blame] | 181 | TRY_ASSIGN(size_t key_length, entry.ReadKey(key_buffer)); |
| 182 | const string_view key(key_buffer.data(), key_length); |
Wyatt Hepler | bab0e20 | 2020-02-04 07:40:08 -0800 | [diff] [blame] | 183 | |
Wyatt Hepler | e541e07 | 2020-02-14 09:10:53 -0800 | [diff] [blame] | 184 | TRY(entry.VerifyChecksumInFlash(entry_header_format_.checksum)); |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 185 | TRY(AppendNewOrOverwriteStaleExistingDescriptor(entry.descriptor(key))); |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 186 | |
Wyatt Hepler | e541e07 | 2020-02-14 09:10:53 -0800 | [diff] [blame] | 187 | *next_entry_address = entry.next_address(); |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 188 | return Status::OK; |
| 189 | } |
| 190 | |
| 191 | // TODO: This method is the trigger of the O(valid_entries * all_entries) time |
| 192 | // complexity for reading. At some cost to memory, this could be optimized by |
| 193 | // using a hash table instead of scanning, but in practice this should be fine |
| 194 | // for a small number of keys |
| 195 | Status KeyValueStore::AppendNewOrOverwriteStaleExistingDescriptor( |
| 196 | const KeyDescriptor& key_descriptor) { |
| 197 | // With the new key descriptor, either add it to the descriptor table or |
| 198 | // overwrite an existing entry with an older version of the key. |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 199 | KeyDescriptor* existing_descriptor = FindDescriptor(key_descriptor.hash()); |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 200 | |
Wyatt Hepler | 5406a67 | 2020-02-18 15:42:38 -0800 | [diff] [blame] | 201 | // Write a new entry. |
| 202 | if (existing_descriptor == nullptr) { |
| 203 | if (key_descriptors_.full()) { |
| 204 | return Status::RESOURCE_EXHAUSTED; |
| 205 | } |
| 206 | key_descriptors_.push_back(key_descriptor); |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 207 | } else if (key_descriptor.IsNewerThan( |
| 208 | existing_descriptor->transaction_id())) { |
Wyatt Hepler | 5406a67 | 2020-02-18 15:42:38 -0800 | [diff] [blame] | 209 | // Existing entry is old; replace the existing entry with the new one. |
| 210 | *existing_descriptor = key_descriptor; |
| 211 | } else { |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 212 | // Otherwise, check if the entries have a duplicate transaction ID, which is |
| 213 | // not valid. |
| 214 | if (existing_descriptor->transaction_id() == |
| 215 | key_descriptor.transaction_id()) { |
| 216 | ERR("Data loss: Duplicated old(=%zu) and new(=%zu) transaction ID", |
| 217 | size_t(existing_descriptor->transaction_id()), |
| 218 | size_t(key_descriptor.transaction_id())); |
Wyatt Hepler | 5406a67 | 2020-02-18 15:42:38 -0800 | [diff] [blame] | 219 | return Status::DATA_LOSS; |
| 220 | } |
| 221 | DBG("Found stale entry when appending; ignoring"); |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 222 | } |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 223 | return Status::OK; |
| 224 | } |
| 225 | |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 226 | KeyValueStore::KeyDescriptor* KeyValueStore::FindDescriptor(uint32_t hash) { |
Wyatt Hepler | 1c329ca | 2020-02-07 18:07:23 -0800 | [diff] [blame] | 227 | for (KeyDescriptor& key_descriptor : key_descriptors_) { |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 228 | if (key_descriptor.hash() == hash) { |
Wyatt Hepler | 1c329ca | 2020-02-07 18:07:23 -0800 | [diff] [blame] | 229 | return &key_descriptor; |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 230 | } |
| 231 | } |
| 232 | return nullptr; |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 233 | } |
| 234 | |
| 235 | StatusWithSize KeyValueStore::Get(string_view key, |
Wyatt Hepler | 5f6efc0 | 2020-02-18 16:54:31 -0800 | [diff] [blame] | 236 | span<byte> value_buffer, |
| 237 | size_t offset_bytes) const { |
Wyatt Hepler | 50f7077 | 2020-02-13 11:25:10 -0800 | [diff] [blame] | 238 | TRY_WITH_SIZE(CheckOperation(key)); |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 239 | |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame] | 240 | const KeyDescriptor* key_descriptor; |
Wyatt Hepler | 2d40169 | 2020-02-13 16:01:23 -0800 | [diff] [blame] | 241 | TRY_WITH_SIZE(FindExistingKeyDescriptor(key, &key_descriptor)); |
Wyatt Hepler | 6c24c06 | 2020-02-05 15:30:49 -0800 | [diff] [blame] | 242 | |
Wyatt Hepler | e541e07 | 2020-02-14 09:10:53 -0800 | [diff] [blame] | 243 | Entry entry; |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 244 | TRY_WITH_SIZE(Entry::Read(partition_, key_descriptor->address(), &entry)); |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 245 | |
Wyatt Hepler | 5f6efc0 | 2020-02-18 16:54:31 -0800 | [diff] [blame] | 246 | StatusWithSize result = entry.ReadValue(value_buffer, offset_bytes); |
| 247 | if (result.ok() && options_.verify_on_read && offset_bytes == 0u) { |
David Rogers | cf680ab | 2020-02-12 23:28:32 -0800 | [diff] [blame] | 248 | Status verify_result = |
Wyatt Hepler | e541e07 | 2020-02-14 09:10:53 -0800 | [diff] [blame] | 249 | entry.VerifyChecksum(entry_header_format_.checksum, |
| 250 | key, |
| 251 | value_buffer.subspan(0, result.size())); |
David Rogers | cf680ab | 2020-02-12 23:28:32 -0800 | [diff] [blame] | 252 | if (!verify_result.ok()) { |
Wyatt Hepler | 50f7077 | 2020-02-13 11:25:10 -0800 | [diff] [blame] | 253 | std::memset( |
| 254 | value_buffer.subspan(0, result.size()).data(), 0, result.size()); |
| 255 | return StatusWithSize(verify_result); |
David Rogers | cf680ab | 2020-02-12 23:28:32 -0800 | [diff] [blame] | 256 | } |
| 257 | |
| 258 | return StatusWithSize(verify_result, result.size()); |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 259 | } |
| 260 | return result; |
| 261 | } |
| 262 | |
| 263 | Status KeyValueStore::Put(string_view key, span<const byte> value) { |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 264 | DBG("Writing key/value; key length=%zu, value length=%zu", |
| 265 | key.size(), |
| 266 | value.size()); |
Wyatt Hepler | 729f28c | 2020-02-05 09:46:00 -0800 | [diff] [blame] | 267 | |
| 268 | TRY(CheckOperation(key)); |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 269 | |
Wyatt Hepler | 5406a67 | 2020-02-18 15:42:38 -0800 | [diff] [blame] | 270 | if (Entry::size(partition_, key, value) > partition_.sector_size_bytes()) { |
| 271 | DBG("%zu B value with %zu B key cannot fit in one sector", |
| 272 | value.size(), |
| 273 | key.size()); |
| 274 | return Status::INVALID_ARGUMENT; |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 275 | } |
| 276 | |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame] | 277 | KeyDescriptor* key_descriptor; |
Wyatt Hepler | 2d40169 | 2020-02-13 16:01:23 -0800 | [diff] [blame] | 278 | Status status = FindKeyDescriptor(key, &key_descriptor); |
| 279 | |
| 280 | if (status.ok()) { |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 281 | DBG("Overwriting entry for key %#08" PRIx32 " in sector %u", |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 282 | key_descriptor->hash(), |
| 283 | SectorIndex(SectorFromKey(key_descriptor))); |
Wyatt Hepler | 5a33d8c | 2020-02-06 09:32:58 -0800 | [diff] [blame] | 284 | return WriteEntryForExistingKey( |
| 285 | key_descriptor, KeyDescriptor::kValid, key, value); |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 286 | } |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame] | 287 | |
Wyatt Hepler | 2d40169 | 2020-02-13 16:01:23 -0800 | [diff] [blame] | 288 | if (status == Status::NOT_FOUND) { |
| 289 | return WriteEntryForNewKey(key, value); |
| 290 | } |
| 291 | |
| 292 | return status; |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 293 | } |
| 294 | |
| 295 | Status KeyValueStore::Delete(string_view key) { |
Wyatt Hepler | 729f28c | 2020-02-05 09:46:00 -0800 | [diff] [blame] | 296 | TRY(CheckOperation(key)); |
| 297 | |
Wyatt Hepler | 6c24c06 | 2020-02-05 15:30:49 -0800 | [diff] [blame] | 298 | KeyDescriptor* key_descriptor; |
Wyatt Hepler | 2d40169 | 2020-02-13 16:01:23 -0800 | [diff] [blame] | 299 | TRY(FindExistingKeyDescriptor(key, &key_descriptor)); |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 300 | |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 301 | DBG("Writing tombstone for key %#08" PRIx32 " in sector %u", |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 302 | key_descriptor->hash(), |
| 303 | SectorIndex(SectorFromKey(key_descriptor))); |
Wyatt Hepler | 5a33d8c | 2020-02-06 09:32:58 -0800 | [diff] [blame] | 304 | return WriteEntryForExistingKey( |
| 305 | key_descriptor, KeyDescriptor::kDeleted, key, {}); |
Wyatt Hepler | 6c24c06 | 2020-02-05 15:30:49 -0800 | [diff] [blame] | 306 | } |
| 307 | |
| 308 | KeyValueStore::iterator& KeyValueStore::iterator::operator++() { |
| 309 | // Skip to the next entry that is valid (not deleted). |
Wyatt Hepler | 1c329ca | 2020-02-07 18:07:23 -0800 | [diff] [blame] | 310 | while (++index_ < item_.kvs_.key_descriptors_.size() && |
Wyatt Hepler | 6c24c06 | 2020-02-05 15:30:49 -0800 | [diff] [blame] | 311 | descriptor().deleted()) { |
| 312 | } |
| 313 | return *this; |
| 314 | } |
| 315 | |
| 316 | const KeyValueStore::Item& KeyValueStore::iterator::operator*() { |
| 317 | std::memset(item_.key_buffer_.data(), 0, item_.key_buffer_.size()); |
| 318 | |
Wyatt Hepler | e541e07 | 2020-02-14 09:10:53 -0800 | [diff] [blame] | 319 | Entry entry; |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 320 | if (Entry::Read(item_.kvs_.partition_, descriptor().address(), &entry).ok()) { |
Wyatt Hepler | e541e07 | 2020-02-14 09:10:53 -0800 | [diff] [blame] | 321 | entry.ReadKey(item_.key_buffer_); |
Wyatt Hepler | 6c24c06 | 2020-02-05 15:30:49 -0800 | [diff] [blame] | 322 | } |
| 323 | |
| 324 | return item_; |
| 325 | } |
| 326 | |
| 327 | KeyValueStore::iterator KeyValueStore::begin() const { |
| 328 | size_t i = 0; |
| 329 | // Skip over any deleted entries at the start of the descriptor list. |
Wyatt Hepler | 1c329ca | 2020-02-07 18:07:23 -0800 | [diff] [blame] | 330 | while (i < key_descriptors_.size() && key_descriptors_[i].deleted()) { |
Wyatt Hepler | 6c24c06 | 2020-02-05 15:30:49 -0800 | [diff] [blame] | 331 | i += 1; |
| 332 | } |
| 333 | return iterator(*this, i); |
| 334 | } |
| 335 | |
| 336 | // TODO(hepler): The valid entry count could be tracked in the KVS to avoid the |
| 337 | // need for this for-loop. |
| 338 | size_t KeyValueStore::size() const { |
| 339 | size_t valid_entries = 0; |
| 340 | |
Wyatt Hepler | 1c329ca | 2020-02-07 18:07:23 -0800 | [diff] [blame] | 341 | for (const KeyDescriptor& key_descriptor : key_descriptors_) { |
| 342 | if (!key_descriptor.deleted()) { |
Wyatt Hepler | 6c24c06 | 2020-02-05 15:30:49 -0800 | [diff] [blame] | 343 | valid_entries += 1; |
| 344 | } |
| 345 | } |
| 346 | |
| 347 | return valid_entries; |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 348 | } |
| 349 | |
Wyatt Hepler | ed163b0 | 2020-02-03 17:49:32 -0800 | [diff] [blame] | 350 | StatusWithSize KeyValueStore::ValueSize(std::string_view key) const { |
Wyatt Hepler | 50f7077 | 2020-02-13 11:25:10 -0800 | [diff] [blame] | 351 | TRY_WITH_SIZE(CheckOperation(key)); |
Wyatt Hepler | ed163b0 | 2020-02-03 17:49:32 -0800 | [diff] [blame] | 352 | |
| 353 | const KeyDescriptor* key_descriptor; |
Wyatt Hepler | 2d40169 | 2020-02-13 16:01:23 -0800 | [diff] [blame] | 354 | TRY_WITH_SIZE(FindExistingKeyDescriptor(key, &key_descriptor)); |
Wyatt Hepler | 6c24c06 | 2020-02-05 15:30:49 -0800 | [diff] [blame] | 355 | |
Wyatt Hepler | e541e07 | 2020-02-14 09:10:53 -0800 | [diff] [blame] | 356 | Entry entry; |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 357 | TRY_WITH_SIZE(Entry::Read(partition_, key_descriptor->address(), &entry)); |
Wyatt Hepler | ed163b0 | 2020-02-03 17:49:32 -0800 | [diff] [blame] | 358 | |
Wyatt Hepler | e541e07 | 2020-02-14 09:10:53 -0800 | [diff] [blame] | 359 | return StatusWithSize(entry.value_size()); |
Wyatt Hepler | ed163b0 | 2020-02-03 17:49:32 -0800 | [diff] [blame] | 360 | } |
| 361 | |
Wyatt Hepler | 6e3a83b | 2020-02-04 07:36:45 -0800 | [diff] [blame] | 362 | Status KeyValueStore::FixedSizeGet(std::string_view key, |
| 363 | byte* value, |
| 364 | size_t size_bytes) const { |
| 365 | // Ensure that the size of the stored value matches the size of the type. |
| 366 | // Otherwise, report error. This check avoids potential memory corruption. |
| 367 | StatusWithSize result = ValueSize(key); |
| 368 | if (!result.ok()) { |
| 369 | return result.status(); |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 370 | } |
Wyatt Hepler | 6e3a83b | 2020-02-04 07:36:45 -0800 | [diff] [blame] | 371 | if (result.size() != size_bytes) { |
Wyatt Hepler | 6c24c06 | 2020-02-05 15:30:49 -0800 | [diff] [blame] | 372 | DBG("Requested %zu B read, but value is %zu B", size_bytes, result.size()); |
Wyatt Hepler | 6e3a83b | 2020-02-04 07:36:45 -0800 | [diff] [blame] | 373 | return Status::INVALID_ARGUMENT; |
Wyatt Hepler | bab0e20 | 2020-02-04 07:40:08 -0800 | [diff] [blame] | 374 | } |
Wyatt Hepler | 6e3a83b | 2020-02-04 07:36:45 -0800 | [diff] [blame] | 375 | return Get(key, span(value, size_bytes)).status(); |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 376 | } |
| 377 | |
Wyatt Hepler | 729f28c | 2020-02-05 09:46:00 -0800 | [diff] [blame] | 378 | Status KeyValueStore::CheckOperation(string_view key) const { |
Wyatt Hepler | acaacf9 | 2020-01-24 10:58:30 -0800 | [diff] [blame] | 379 | if (InvalidKey(key)) { |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 380 | return Status::INVALID_ARGUMENT; |
| 381 | } |
Wyatt Hepler | d229828 | 2020-02-20 17:12:45 -0800 | [diff] [blame] | 382 | if (!initialized()) { |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 383 | return Status::FAILED_PRECONDITION; |
| 384 | } |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 385 | return Status::OK; |
| 386 | } |
| 387 | |
Wyatt Hepler | 2d40169 | 2020-02-13 16:01:23 -0800 | [diff] [blame] | 388 | // Searches for a KeyDescriptor that matches this key and sets *result to point |
| 389 | // to it if one is found. |
| 390 | // |
| 391 | // OK: there is a matching descriptor and *result is set |
| 392 | // NOT_FOUND: there is no descriptor that matches this key, but this key |
| 393 | // has a unique hash (and could potentially be added to the KVS) |
| 394 | // ALREADY_EXISTS: there is no descriptor that matches this key, but the |
| 395 | // key's hash collides with the hash for an existing descriptor |
| 396 | // |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame] | 397 | Status KeyValueStore::FindKeyDescriptor(string_view key, |
| 398 | const KeyDescriptor** result) const { |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 399 | const uint32_t hash = internal::Hash(key); |
Wyatt Hepler | a00d1ef | 2020-02-14 14:31:26 -0800 | [diff] [blame] | 400 | Entry::KeyBuffer key_buffer; |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 401 | |
Wyatt Hepler | 1c329ca | 2020-02-07 18:07:23 -0800 | [diff] [blame] | 402 | for (auto& descriptor : key_descriptors_) { |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 403 | if (descriptor.hash() == hash) { |
Wyatt Hepler | e541e07 | 2020-02-14 09:10:53 -0800 | [diff] [blame] | 404 | TRY(Entry::ReadKey( |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 405 | partition_, descriptor.address(), key.size(), key_buffer.data())); |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 406 | |
Wyatt Hepler | e541e07 | 2020-02-14 09:10:53 -0800 | [diff] [blame] | 407 | if (key == string_view(key_buffer.data(), key.size())) { |
Wyatt Hepler | 5a33d8c | 2020-02-06 09:32:58 -0800 | [diff] [blame] | 408 | DBG("Found match for key hash 0x%08" PRIx32, hash); |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame] | 409 | *result = &descriptor; |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 410 | return Status::OK; |
Wyatt Hepler | 2d40169 | 2020-02-13 16:01:23 -0800 | [diff] [blame] | 411 | } else { |
| 412 | WRN("Found key hash collision for 0x%08" PRIx32, hash); |
| 413 | return Status::ALREADY_EXISTS; |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 414 | } |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 415 | } |
| 416 | } |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 417 | return Status::NOT_FOUND; |
| 418 | } |
| 419 | |
Wyatt Hepler | 2d40169 | 2020-02-13 16:01:23 -0800 | [diff] [blame] | 420 | // Searches for a KeyDescriptor that matches this key and sets *result to point |
| 421 | // to it if one is found. |
| 422 | // |
| 423 | // OK: there is a matching descriptor and *result is set |
| 424 | // NOT_FOUND: there is no descriptor that matches this key |
| 425 | // |
| 426 | Status KeyValueStore::FindExistingKeyDescriptor( |
| 427 | string_view key, const KeyDescriptor** result) const { |
| 428 | Status status = FindKeyDescriptor(key, result); |
| 429 | |
| 430 | // If the key's hash collides with an existing key or if the key is deleted, |
| 431 | // treat it as if it is not in the KVS. |
| 432 | if (status == Status::ALREADY_EXISTS || |
| 433 | (status.ok() && (*result)->deleted())) { |
| 434 | return Status::NOT_FOUND; |
| 435 | } |
| 436 | return status; |
| 437 | } |
| 438 | |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame] | 439 | Status KeyValueStore::WriteEntryForExistingKey(KeyDescriptor* key_descriptor, |
Wyatt Hepler | 5a33d8c | 2020-02-06 09:32:58 -0800 | [diff] [blame] | 440 | KeyDescriptor::State new_state, |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 441 | string_view key, |
| 442 | span<const byte> value) { |
Wyatt Hepler | 5a33d8c | 2020-02-06 09:32:58 -0800 | [diff] [blame] | 443 | // Find the original entry and sector to update the sector's valid_bytes. |
Wyatt Hepler | 30a5215 | 2020-02-12 11:26:05 -0800 | [diff] [blame] | 444 | Entry original_entry; |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 445 | TRY(Entry::Read(partition_, key_descriptor->address(), &original_entry)); |
| 446 | SectorDescriptor* old_sector = SectorFromKey(key_descriptor); |
Wyatt Hepler | 6c24c06 | 2020-02-05 15:30:49 -0800 | [diff] [blame] | 447 | |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame] | 448 | SectorDescriptor* sector; |
Wyatt Hepler | 5406a67 | 2020-02-18 15:42:38 -0800 | [diff] [blame] | 449 | TRY(FindOrRecoverSectorWithSpace(§or, |
| 450 | Entry::size(partition_, key, value))); |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 451 | DBG("Writing existing entry; found sector %u (%#" PRIx32 ")", |
| 452 | SectorIndex(sector), |
| 453 | SectorBaseAddress(sector)); |
David Rogers | 3464d0a | 2020-02-07 11:45:46 -0800 | [diff] [blame] | 454 | |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 455 | if (old_sector != SectorFromKey(key_descriptor)) { |
David Rogers | 3464d0a | 2020-02-07 11:45:46 -0800 | [diff] [blame] | 456 | DBG("Sector for old entry (size %zu) was garbage collected. Old entry " |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 457 | "relocated to sector %u", |
David Rogers | 3464d0a | 2020-02-07 11:45:46 -0800 | [diff] [blame] | 458 | original_entry.size(), |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 459 | SectorIndex(SectorFromKey(key_descriptor))); |
David Rogers | 3464d0a | 2020-02-07 11:45:46 -0800 | [diff] [blame] | 460 | |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 461 | old_sector = SectorFromKey(key_descriptor); |
David Rogers | 3464d0a | 2020-02-07 11:45:46 -0800 | [diff] [blame] | 462 | } |
| 463 | |
Wyatt Hepler | 5a33d8c | 2020-02-06 09:32:58 -0800 | [diff] [blame] | 464 | TRY(AppendEntry(sector, key_descriptor, key, value, new_state)); |
| 465 | |
David Rogers | 3464d0a | 2020-02-07 11:45:46 -0800 | [diff] [blame] | 466 | old_sector->RemoveValidBytes(original_entry.size()); |
Wyatt Hepler | 5a33d8c | 2020-02-06 09:32:58 -0800 | [diff] [blame] | 467 | return Status::OK; |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 468 | } |
| 469 | |
| 470 | Status KeyValueStore::WriteEntryForNewKey(string_view key, |
| 471 | span<const byte> value) { |
Wyatt Hepler | 1c329ca | 2020-02-07 18:07:23 -0800 | [diff] [blame] | 472 | if (key_descriptors_.full()) { |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 473 | WRN("KVS full: trying to store a new entry, but can't. Have %zu entries", |
Wyatt Hepler | 1c329ca | 2020-02-07 18:07:23 -0800 | [diff] [blame] | 474 | key_descriptors_.size()); |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 475 | return Status::RESOURCE_EXHAUSTED; |
| 476 | } |
| 477 | |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame] | 478 | SectorDescriptor* sector; |
Wyatt Hepler | 5406a67 | 2020-02-18 15:42:38 -0800 | [diff] [blame] | 479 | TRY(FindOrRecoverSectorWithSpace(§or, |
| 480 | Entry::size(partition_, key, value))); |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 481 | DBG("Writing new entry; found sector: %u", SectorIndex(sector)); |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 482 | |
| 483 | // Create the KeyDescriptor that will be added to the list. The transaction ID |
| 484 | // and address will be set by AppendEntry. |
| 485 | KeyDescriptor key_descriptor(key); |
Wyatt Hepler | 0af6ad9 | 2020-02-13 15:54:46 -0800 | [diff] [blame] | 486 | TRY(AppendEntry(sector, &key_descriptor, key, value, KeyDescriptor::kValid)); |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 487 | |
Wyatt Hepler | 1c329ca | 2020-02-07 18:07:23 -0800 | [diff] [blame] | 488 | // Only add the entry when we are certain the write succeeded. |
| 489 | key_descriptors_.push_back(key_descriptor); |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 490 | return Status::OK; |
| 491 | } |
| 492 | |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame] | 493 | Status KeyValueStore::RelocateEntry(KeyDescriptor& key_descriptor) { |
David Rogers | f0a3544 | 2020-02-04 12:16:38 -0800 | [diff] [blame] | 494 | struct TempEntry { |
Wyatt Hepler | e541e07 | 2020-02-14 09:10:53 -0800 | [diff] [blame] | 495 | Entry::KeyBuffer key; |
David Rogers | f0a3544 | 2020-02-04 12:16:38 -0800 | [diff] [blame] | 496 | std::array<char, sizeof(working_buffer_) - sizeof(key)> value; |
| 497 | }; |
Wyatt Hepler | e541e07 | 2020-02-14 09:10:53 -0800 | [diff] [blame] | 498 | TempEntry* temp_entry = reinterpret_cast<TempEntry*>(working_buffer_.data()); |
David Rogers | f0a3544 | 2020-02-04 12:16:38 -0800 | [diff] [blame] | 499 | |
David Rogers | df025cd | 2020-02-06 17:05:34 -0800 | [diff] [blame] | 500 | DBG("Relocating entry"); // TODO: add entry info to the log statement. |
| 501 | |
Wyatt Hepler | e541e07 | 2020-02-14 09:10:53 -0800 | [diff] [blame] | 502 | // Read the entry to be relocated. Store the entry in a local variable and |
David Rogers | f0a3544 | 2020-02-04 12:16:38 -0800 | [diff] [blame] | 503 | // store the key and value in the TempEntry stored in the static allocated |
| 504 | // working_buffer_. |
Wyatt Hepler | e541e07 | 2020-02-14 09:10:53 -0800 | [diff] [blame] | 505 | Entry entry; |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 506 | TRY(Entry::Read(partition_, key_descriptor.address(), &entry)); |
Wyatt Hepler | e541e07 | 2020-02-14 09:10:53 -0800 | [diff] [blame] | 507 | TRY_ASSIGN(size_t key_length, entry.ReadKey(temp_entry->key)); |
| 508 | string_view key = string_view(temp_entry->key.data(), key_length); |
| 509 | auto result = entry.ReadValue(as_writable_bytes(span(temp_entry->value))); |
David Rogers | f0a3544 | 2020-02-04 12:16:38 -0800 | [diff] [blame] | 510 | if (!result.status().ok()) { |
| 511 | return Status::INTERNAL; |
| 512 | } |
| 513 | |
Wyatt Hepler | e541e07 | 2020-02-14 09:10:53 -0800 | [diff] [blame] | 514 | auto value = span(temp_entry->value.data(), result.size()); |
| 515 | TRY(entry.VerifyChecksum( |
David Rogers | f0a3544 | 2020-02-04 12:16:38 -0800 | [diff] [blame] | 516 | entry_header_format_.checksum, key, as_bytes(value))); |
| 517 | |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 518 | SectorDescriptor* old_sector = SectorFromKey(key_descriptor); |
David Rogers | f0a3544 | 2020-02-04 12:16:38 -0800 | [diff] [blame] | 519 | |
| 520 | // Find a new sector for the entry and write it to the new location. |
David Rogers | 8ce55cd | 2020-02-04 19:41:48 -0800 | [diff] [blame] | 521 | SectorDescriptor* new_sector; |
Wyatt Hepler | e541e07 | 2020-02-14 09:10:53 -0800 | [diff] [blame] | 522 | TRY(FindSectorWithSpace(&new_sector, entry.size(), old_sector, true)); |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 523 | TRY(AppendEntry(new_sector, |
| 524 | &key_descriptor, |
| 525 | key, |
| 526 | as_bytes(value), |
| 527 | key_descriptor.state())); |
David Rogers | df025cd | 2020-02-06 17:05:34 -0800 | [diff] [blame] | 528 | |
Wyatt Hepler | d229828 | 2020-02-20 17:12:45 -0800 | [diff] [blame] | 529 | // Do the valid bytes accounting for the sector the entry was relocated from. |
Wyatt Hepler | e541e07 | 2020-02-14 09:10:53 -0800 | [diff] [blame] | 530 | old_sector->RemoveValidBytes(entry.size()); |
David Rogers | df025cd | 2020-02-06 17:05:34 -0800 | [diff] [blame] | 531 | |
| 532 | return Status::OK; |
David Rogers | a12786b | 2020-01-31 16:02:33 -0800 | [diff] [blame] | 533 | } |
| 534 | |
David Rogers | 8db5a72 | 2020-02-03 18:28:34 -0800 | [diff] [blame] | 535 | // Find either an existing sector with enough space that is not the sector to |
| 536 | // skip, or an empty sector. Maintains the invariant that there is always at |
| 537 | // least 1 empty sector unless set to bypass the rule. |
Wyatt Hepler | 5a33d8c | 2020-02-06 09:32:58 -0800 | [diff] [blame] | 538 | Status KeyValueStore::FindSectorWithSpace( |
| 539 | SectorDescriptor** found_sector, |
| 540 | size_t size, |
| 541 | const SectorDescriptor* sector_to_skip, |
| 542 | bool bypass_empty_sector_rule) { |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 543 | SectorDescriptor* first_empty_sector = nullptr; |
| 544 | bool at_least_two_empty_sectors = bypass_empty_sector_rule; |
| 545 | |
| 546 | DBG("Find sector with %zu bytes available, starting with sector %u", |
| 547 | size, |
| 548 | SectorIndex(last_new_sector_)); |
| 549 | if (sector_to_skip != nullptr) { |
| 550 | DBG(" Skip sector %u", SectorIndex(sector_to_skip)); |
| 551 | } |
| 552 | if (bypass_empty_sector_rule) { |
| 553 | DBG(" Bypassing empty sector rule"); |
| 554 | } |
| 555 | |
David Rogers | 8ce55cd | 2020-02-04 19:41:48 -0800 | [diff] [blame] | 556 | // The last_new_sector_ is the sector that was last selected as the "new empty |
| 557 | // sector" to write to. This last new sector is used as the starting point for |
| 558 | // the next "find a new empty sector to write to" operation. By using the last |
| 559 | // new sector as the start point we will cycle which empty sector is selected |
| 560 | // next, spreading the wear across all the empty sectors and get a wear |
| 561 | // leveling benefit, rather than putting more wear on the lower number |
| 562 | // sectors. |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 563 | SectorDescriptor* sector = last_new_sector_; |
David Rogers | 67f4b6c | 2020-02-06 16:17:09 -0800 | [diff] [blame] | 564 | |
David Rogers | 8ce55cd | 2020-02-04 19:41:48 -0800 | [diff] [blame] | 565 | // Look for a partial sector to use with enough space. Immediately use the |
| 566 | // first one of those that is found. While scanning for a partial sector, keep |
| 567 | // track of the first empty sector and if a second sector was seen. |
Wyatt Hepler | 1c329ca | 2020-02-07 18:07:23 -0800 | [diff] [blame] | 568 | for (size_t j = 0; j < sectors_.size(); j++) { |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 569 | sector += 1; |
| 570 | if (sector == sectors_.end()) { |
| 571 | sector = sectors_.begin(); |
| 572 | } |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 573 | |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 574 | if (sector_to_skip == sector) { |
David Rogers | 8db5a72 | 2020-02-03 18:28:34 -0800 | [diff] [blame] | 575 | continue; |
| 576 | } |
| 577 | |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 578 | const size_t sector_size_bytes = partition_.sector_size_bytes(); |
| 579 | if (!sector->Empty(sector_size_bytes) && sector->HasSpace(size)) { |
| 580 | *found_sector = sector; |
David Rogers | 8ce55cd | 2020-02-04 19:41:48 -0800 | [diff] [blame] | 581 | return Status::OK; |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 582 | } |
| 583 | |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 584 | if (sector->Empty(sector_size_bytes)) { |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 585 | if (first_empty_sector == nullptr) { |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 586 | first_empty_sector = sector; |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 587 | } else { |
| 588 | at_least_two_empty_sectors = true; |
Wyatt Hepler | 2ad6067 | 2020-01-21 08:00:16 -0800 | [diff] [blame] | 589 | } |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 590 | } |
| 591 | } |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 592 | |
David Rogers | 8ce55cd | 2020-02-04 19:41:48 -0800 | [diff] [blame] | 593 | // If the scan for a partial sector does not find a suitable sector, use the |
| 594 | // first empty sector that was found. Normally it is required to keep 1 empty |
| 595 | // sector after the sector found here, but that rule can be bypassed in |
| 596 | // special circumstances (such as during garbage collection). |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 597 | if (at_least_two_empty_sectors) { |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 598 | DBG(" Found a usable empty sector; returning the first found (%u)", |
David Rogers | 8ce55cd | 2020-02-04 19:41:48 -0800 | [diff] [blame] | 599 | SectorIndex(first_empty_sector)); |
| 600 | last_new_sector_ = first_empty_sector; |
| 601 | *found_sector = first_empty_sector; |
| 602 | return Status::OK; |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 603 | } |
David Rogers | 8ce55cd | 2020-02-04 19:41:48 -0800 | [diff] [blame] | 604 | |
| 605 | // No sector was found. |
David Rogers | 67f4b6c | 2020-02-06 16:17:09 -0800 | [diff] [blame] | 606 | DBG(" Unable to find a usable sector"); |
David Rogers | 8ce55cd | 2020-02-04 19:41:48 -0800 | [diff] [blame] | 607 | *found_sector = nullptr; |
| 608 | return Status::RESOURCE_EXHAUSTED; |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 609 | } |
| 610 | |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame] | 611 | Status KeyValueStore::FindOrRecoverSectorWithSpace(SectorDescriptor** sector, |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 612 | size_t size) { |
David Rogers | 8ce55cd | 2020-02-04 19:41:48 -0800 | [diff] [blame] | 613 | Status result = FindSectorWithSpace(sector, size); |
Wyatt Hepler | 2d40169 | 2020-02-13 16:01:23 -0800 | [diff] [blame] | 614 | if (result == Status::RESOURCE_EXHAUSTED && options_.partial_gc_on_write) { |
David Rogers | 1541d61 | 2020-02-06 23:47:02 -0800 | [diff] [blame] | 615 | // Garbage collect and then try again to find the best sector. |
| 616 | TRY(GarbageCollectOneSector()); |
| 617 | return FindSectorWithSpace(sector, size); |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 618 | } |
David Rogers | 8ce55cd | 2020-02-04 19:41:48 -0800 | [diff] [blame] | 619 | return result; |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 620 | } |
| 621 | |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame] | 622 | KeyValueStore::SectorDescriptor* KeyValueStore::FindSectorToGarbageCollect() { |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 623 | const size_t sector_size_bytes = partition_.sector_size_bytes(); |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame] | 624 | SectorDescriptor* sector_candidate = nullptr; |
David Rogers | a12786b | 2020-01-31 16:02:33 -0800 | [diff] [blame] | 625 | size_t candidate_bytes = 0; |
| 626 | |
| 627 | // Step 1: Try to find a sectors with stale keys and no valid keys (no |
| 628 | // relocation needed). If any such sectors are found, use the sector with the |
| 629 | // most reclaimable bytes. |
Wyatt Hepler | 1c329ca | 2020-02-07 18:07:23 -0800 | [diff] [blame] | 630 | for (auto& sector : sectors_) { |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 631 | if ((sector.valid_bytes() == 0) && |
| 632 | (sector.RecoverableBytes(sector_size_bytes) > candidate_bytes)) { |
David Rogers | a12786b | 2020-01-31 16:02:33 -0800 | [diff] [blame] | 633 | sector_candidate = §or; |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 634 | candidate_bytes = sector.RecoverableBytes(sector_size_bytes); |
David Rogers | a12786b | 2020-01-31 16:02:33 -0800 | [diff] [blame] | 635 | } |
| 636 | } |
| 637 | |
| 638 | // Step 2: If step 1 yields no sectors, just find the sector with the most |
| 639 | // reclaimable bytes. |
| 640 | if (sector_candidate == nullptr) { |
Wyatt Hepler | 1c329ca | 2020-02-07 18:07:23 -0800 | [diff] [blame] | 641 | for (auto& sector : sectors_) { |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 642 | if (sector.RecoverableBytes(sector_size_bytes) > candidate_bytes) { |
David Rogers | a12786b | 2020-01-31 16:02:33 -0800 | [diff] [blame] | 643 | sector_candidate = §or; |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 644 | candidate_bytes = sector.RecoverableBytes(sector_size_bytes); |
David Rogers | a12786b | 2020-01-31 16:02:33 -0800 | [diff] [blame] | 645 | } |
| 646 | } |
| 647 | } |
| 648 | |
David Rogers | 5981f31 | 2020-02-13 13:33:56 -0800 | [diff] [blame] | 649 | if (sector_candidate != nullptr) { |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 650 | DBG("Found sector %u to Garbage Collect, %zu recoverable bytes", |
David Rogers | 5981f31 | 2020-02-13 13:33:56 -0800 | [diff] [blame] | 651 | SectorIndex(sector_candidate), |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 652 | sector_candidate->RecoverableBytes(sector_size_bytes)); |
David Rogers | 5981f31 | 2020-02-13 13:33:56 -0800 | [diff] [blame] | 653 | } else { |
| 654 | DBG("Unable to find sector to garbage collect!"); |
| 655 | } |
David Rogers | a12786b | 2020-01-31 16:02:33 -0800 | [diff] [blame] | 656 | return sector_candidate; |
| 657 | } |
| 658 | |
David Rogers | 1541d61 | 2020-02-06 23:47:02 -0800 | [diff] [blame] | 659 | Status KeyValueStore::GarbageCollectOneSector() { |
David Rogers | 67f4b6c | 2020-02-06 16:17:09 -0800 | [diff] [blame] | 660 | DBG("Garbage Collect a single sector"); |
| 661 | |
David Rogers | a12786b | 2020-01-31 16:02:33 -0800 | [diff] [blame] | 662 | // Step 1: Find the sector to garbage collect |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame] | 663 | SectorDescriptor* sector_to_gc = FindSectorToGarbageCollect(); |
David Rogers | 3464d0a | 2020-02-07 11:45:46 -0800 | [diff] [blame] | 664 | LogSectors(); |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 665 | |
David Rogers | a12786b | 2020-01-31 16:02:33 -0800 | [diff] [blame] | 666 | if (sector_to_gc == nullptr) { |
| 667 | return Status::RESOURCE_EXHAUSTED; |
| 668 | } |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 669 | |
David Rogers | a12786b | 2020-01-31 16:02:33 -0800 | [diff] [blame] | 670 | // Step 2: Move any valid entries in the GC sector to other sectors |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 671 | if (sector_to_gc->valid_bytes() != 0) { |
Wyatt Hepler | 1c329ca | 2020-02-07 18:07:23 -0800 | [diff] [blame] | 672 | for (auto& descriptor : key_descriptors_) { |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 673 | if (AddressInSector(*sector_to_gc, descriptor.address())) { |
David Rogers | 67f4b6c | 2020-02-06 16:17:09 -0800 | [diff] [blame] | 674 | DBG(" Relocate entry"); |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame] | 675 | TRY(RelocateEntry(descriptor)); |
David Rogers | a12786b | 2020-01-31 16:02:33 -0800 | [diff] [blame] | 676 | } |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 677 | } |
| 678 | } |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 679 | |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 680 | if (sector_to_gc->valid_bytes() != 0) { |
David Rogers | 67f4b6c | 2020-02-06 16:17:09 -0800 | [diff] [blame] | 681 | ERR(" Failed to relocate valid entries from sector being garbage " |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 682 | "collected, %zu valid bytes remain", |
| 683 | sector_to_gc->valid_bytes()); |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 684 | return Status::INTERNAL; |
| 685 | } |
| 686 | |
David Rogers | a12786b | 2020-01-31 16:02:33 -0800 | [diff] [blame] | 687 | // Step 3: Reinitialize the sector |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 688 | sector_to_gc->set_writable_bytes(0); |
David Rogers | a12786b | 2020-01-31 16:02:33 -0800 | [diff] [blame] | 689 | TRY(partition_.Erase(SectorBaseAddress(sector_to_gc), 1)); |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 690 | sector_to_gc->set_writable_bytes(partition_.sector_size_bytes()); |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 691 | |
David Rogers | 67f4b6c | 2020-02-06 16:17:09 -0800 | [diff] [blame] | 692 | DBG(" Garbage Collect complete"); |
David Rogers | 50185ad | 2020-02-07 00:02:46 -0800 | [diff] [blame] | 693 | LogSectors(); |
David Rogers | a12786b | 2020-01-31 16:02:33 -0800 | [diff] [blame] | 694 | return Status::OK; |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 695 | } |
| 696 | |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame] | 697 | Status KeyValueStore::AppendEntry(SectorDescriptor* sector, |
| 698 | KeyDescriptor* key_descriptor, |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 699 | string_view key, |
Wyatt Hepler | 5a33d8c | 2020-02-06 09:32:58 -0800 | [diff] [blame] | 700 | span<const byte> value, |
| 701 | KeyDescriptor::State new_state) { |
Wyatt Hepler | e541e07 | 2020-02-14 09:10:53 -0800 | [diff] [blame] | 702 | const Address address = NextWritableAddress(sector); |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 703 | Entry entry = CreateEntry(address, key, value, new_state); |
Wyatt Hepler | e541e07 | 2020-02-14 09:10:53 -0800 | [diff] [blame] | 704 | |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 705 | DBG("Appending %zu B entry with transaction ID %" PRIu32 " to address %#zx", |
Wyatt Hepler | e541e07 | 2020-02-14 09:10:53 -0800 | [diff] [blame] | 706 | entry.size(), |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 707 | entry.transaction_id(), |
| 708 | size_t(address)); |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 709 | |
David Rogers | 6592d29 | 2020-02-14 14:19:26 -0800 | [diff] [blame] | 710 | StatusWithSize result = entry.Write(key, value); |
| 711 | // Remove any bytes that were written, even if the write was not successful. |
| 712 | sector->RemoveWritableBytes(result.size()); |
| 713 | |
| 714 | if (!result.ok()) { |
| 715 | // TODO: add testing coverage for this once flash errors are supported in |
| 716 | // tests. |
| 717 | ERR("Failed to write %zu bytes. %zu actually written", |
| 718 | entry.size(), |
| 719 | result.size()); |
| 720 | return result.status(); |
| 721 | } |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 722 | |
| 723 | if (options_.verify_on_write) { |
Wyatt Hepler | e541e07 | 2020-02-14 09:10:53 -0800 | [diff] [blame] | 724 | TRY(entry.VerifyChecksumInFlash(entry_header_format_.checksum)); |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 725 | } |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 726 | |
David Rogers | 6592d29 | 2020-02-14 14:19:26 -0800 | [diff] [blame] | 727 | // Entry was written successfully, update the key descriptor and the sector |
| 728 | // descriptor to reflect the new entry. |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 729 | entry.UpdateDescriptor(key_descriptor); |
David Rogers | 6592d29 | 2020-02-14 14:19:26 -0800 | [diff] [blame] | 730 | sector->AddValidBytes(result.size()); |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 731 | return Status::OK; |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 732 | } |
| 733 | |
Wyatt Hepler | bdd8e5a | 2020-02-20 19:27:26 -0800 | [diff] [blame^] | 734 | KeyValueStore::Entry KeyValueStore::CreateEntry(Address address, |
| 735 | std::string_view key, |
| 736 | span<const byte> value, |
| 737 | KeyDescriptor::State state) { |
Wyatt Hepler | d229828 | 2020-02-20 17:12:45 -0800 | [diff] [blame] | 738 | last_transaction_id_ += 1; |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 739 | |
| 740 | if (state == KeyDescriptor::kDeleted) { |
| 741 | return Entry::Tombstone(partition_, |
| 742 | address, |
| 743 | entry_header_format_.magic, |
| 744 | entry_header_format_.checksum, |
| 745 | key, |
| 746 | partition_.alignment_bytes(), |
Wyatt Hepler | d229828 | 2020-02-20 17:12:45 -0800 | [diff] [blame] | 747 | last_transaction_id_); |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 748 | } |
| 749 | return Entry::Valid(partition_, |
| 750 | address, |
| 751 | entry_header_format_.magic, |
| 752 | entry_header_format_.checksum, |
| 753 | key, |
| 754 | value, |
| 755 | partition_.alignment_bytes(), |
Wyatt Hepler | d229828 | 2020-02-20 17:12:45 -0800 | [diff] [blame] | 756 | last_transaction_id_); |
| 757 | } |
| 758 | |
| 759 | void KeyValueStore::Reset() { |
| 760 | initialized_ = false; |
| 761 | key_descriptors_.clear(); |
| 762 | last_new_sector_ = nullptr; |
| 763 | last_transaction_id_ = 0; |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 764 | } |
| 765 | |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 766 | void KeyValueStore::LogDebugInfo() { |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 767 | const size_t sector_size_bytes = partition_.sector_size_bytes(); |
| 768 | DBG("====================== KEY VALUE STORE DUMP ========================="); |
| 769 | DBG(" "); |
| 770 | DBG("Flash partition:"); |
Wyatt Hepler | ad0a793 | 2020-02-06 08:20:38 -0800 | [diff] [blame] | 771 | DBG(" Sector count = %zu", partition_.sector_count()); |
Wyatt Hepler | 38ce30f | 2020-02-19 11:48:31 -0800 | [diff] [blame] | 772 | DBG(" Sector max count = %zu", sectors_.max_size()); |
Wyatt Hepler | 1c329ca | 2020-02-07 18:07:23 -0800 | [diff] [blame] | 773 | DBG(" Sectors in use = %zu", sectors_.size()); |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 774 | DBG(" Sector size = %zu", sector_size_bytes); |
| 775 | DBG(" Total size = %zu", partition_.size_bytes()); |
| 776 | DBG(" Alignment = %zu", partition_.alignment_bytes()); |
| 777 | DBG(" "); |
| 778 | DBG("Key descriptors:"); |
Wyatt Hepler | 1c329ca | 2020-02-07 18:07:23 -0800 | [diff] [blame] | 779 | DBG(" Entry count = %zu", key_descriptors_.size()); |
Wyatt Hepler | 38ce30f | 2020-02-19 11:48:31 -0800 | [diff] [blame] | 780 | DBG(" Max entry count = %zu", key_descriptors_.max_size()); |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 781 | DBG(" "); |
| 782 | DBG(" # hash version address address (hex)"); |
Wyatt Hepler | 1c329ca | 2020-02-07 18:07:23 -0800 | [diff] [blame] | 783 | for (size_t i = 0; i < key_descriptors_.size(); ++i) { |
| 784 | const KeyDescriptor& kd = key_descriptors_[i]; |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 785 | DBG(" |%3zu: | %8zx |%8zu | %8zu | %8zx", |
| 786 | i, |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 787 | size_t(kd.hash()), |
| 788 | size_t(kd.transaction_id()), |
| 789 | size_t(kd.address()), |
| 790 | size_t(kd.address())); |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 791 | } |
| 792 | DBG(" "); |
| 793 | |
| 794 | DBG("Sector descriptors:"); |
| 795 | DBG(" # tail free valid has_space"); |
Wyatt Hepler | 1c329ca | 2020-02-07 18:07:23 -0800 | [diff] [blame] | 796 | for (size_t sector_id = 0; sector_id < sectors_.size(); ++sector_id) { |
| 797 | const SectorDescriptor& sd = sectors_[sector_id]; |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 798 | DBG(" |%3zu: | %8zu |%8zu | %s", |
| 799 | sector_id, |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 800 | size_t(sd.writable_bytes()), |
| 801 | sd.valid_bytes(), |
| 802 | sd.writable_bytes() ? "YES" : ""); |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 803 | } |
| 804 | DBG(" "); |
| 805 | |
| 806 | // TODO: This should stop logging after some threshold. |
| 807 | // size_t dumped_bytes = 0; |
| 808 | DBG("Sector raw data:"); |
Wyatt Hepler | 1c329ca | 2020-02-07 18:07:23 -0800 | [diff] [blame] | 809 | for (size_t sector_id = 0; sector_id < sectors_.size(); ++sector_id) { |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 810 | // Read sector data. Yes, this will blow the stack on embedded. |
Wyatt Hepler | 1c329ca | 2020-02-07 18:07:23 -0800 | [diff] [blame] | 811 | std::array<byte, 500> raw_sector_data; // TODO!!! |
Keir Mierle | 8c352dc | 2020-02-02 13:58:19 -0800 | [diff] [blame] | 812 | StatusWithSize sws = |
| 813 | partition_.Read(sector_id * sector_size_bytes, raw_sector_data); |
| 814 | DBG("Read: %zu bytes", sws.size()); |
| 815 | |
| 816 | DBG(" base addr offs 0 1 2 3 4 5 6 7"); |
| 817 | for (size_t i = 0; i < sector_size_bytes; i += 8) { |
| 818 | DBG(" %3zu %8zx %5zu | %02x %02x %02x %02x %02x %02x %02x %02x", |
| 819 | sector_id, |
| 820 | (sector_id * sector_size_bytes) + i, |
| 821 | i, |
| 822 | static_cast<unsigned int>(raw_sector_data[i + 0]), |
| 823 | static_cast<unsigned int>(raw_sector_data[i + 1]), |
| 824 | static_cast<unsigned int>(raw_sector_data[i + 2]), |
| 825 | static_cast<unsigned int>(raw_sector_data[i + 3]), |
| 826 | static_cast<unsigned int>(raw_sector_data[i + 4]), |
| 827 | static_cast<unsigned int>(raw_sector_data[i + 5]), |
| 828 | static_cast<unsigned int>(raw_sector_data[i + 6]), |
| 829 | static_cast<unsigned int>(raw_sector_data[i + 7])); |
| 830 | |
| 831 | // TODO: Fix exit condition. |
| 832 | if (i > 128) { |
| 833 | break; |
| 834 | } |
| 835 | } |
| 836 | DBG(" "); |
| 837 | } |
| 838 | |
| 839 | DBG("////////////////////// KEY VALUE STORE DUMP END /////////////////////"); |
| 840 | } |
| 841 | |
David Rogers | cf680ab | 2020-02-12 23:28:32 -0800 | [diff] [blame] | 842 | void KeyValueStore::LogSectors() const { |
| 843 | DBG("Sector descriptors: count %zu", sectors_.size()); |
Wyatt Hepler | 1c329ca | 2020-02-07 18:07:23 -0800 | [diff] [blame] | 844 | for (auto& sector : sectors_) { |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 845 | DBG(" - Sector %u: valid %zu, recoverable %zu, free %zu", |
David Rogers | 50185ad | 2020-02-07 00:02:46 -0800 | [diff] [blame] | 846 | SectorIndex(§or), |
Wyatt Hepler | 2c7eca0 | 2020-02-18 16:01:42 -0800 | [diff] [blame] | 847 | sector.valid_bytes(), |
| 848 | sector.RecoverableBytes(partition_.sector_size_bytes()), |
| 849 | sector.writable_bytes()); |
David Rogers | 50185ad | 2020-02-07 00:02:46 -0800 | [diff] [blame] | 850 | } |
| 851 | } |
| 852 | |
David Rogers | cf680ab | 2020-02-12 23:28:32 -0800 | [diff] [blame] | 853 | void KeyValueStore::LogKeyDescriptor() const { |
| 854 | DBG("Key descriptors: count %zu", key_descriptors_.size()); |
| 855 | for (auto& key : key_descriptors_) { |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 856 | DBG(" - Key: %s, hash %#zx, transaction ID %zu, address %#zx", |
David Rogers | cf680ab | 2020-02-12 23:28:32 -0800 | [diff] [blame] | 857 | key.deleted() ? "Deleted" : "Valid", |
Wyatt Hepler | 1fc1104 | 2020-02-19 17:17:51 -0800 | [diff] [blame] | 858 | static_cast<size_t>(key.hash()), |
| 859 | static_cast<size_t>(key.transaction_id()), |
| 860 | static_cast<size_t>(key.address())); |
David Rogers | cf680ab | 2020-02-12 23:28:32 -0800 | [diff] [blame] | 861 | } |
| 862 | } |
| 863 | |
Wyatt Hepler | 2ad6067 | 2020-01-21 08:00:16 -0800 | [diff] [blame] | 864 | } // namespace pw::kvs |