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