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