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