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 | |
| 17 | #include <cstring> |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 18 | #include <type_traits> |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 19 | |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 20 | #include "pw_kvs_private/format.h" |
| 21 | #include "pw_kvs_private/macros.h" |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 22 | |
Wyatt Hepler | 2ad6067 | 2020-01-21 08:00:16 -0800 | [diff] [blame] | 23 | namespace pw::kvs { |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 24 | |
Wyatt Hepler | acaacf9 | 2020-01-24 10:58:30 -0800 | [diff] [blame] | 25 | using std::byte; |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 26 | using std::string_view; |
Wyatt Hepler | acaacf9 | 2020-01-24 10:58:30 -0800 | [diff] [blame] | 27 | |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 28 | namespace { |
| 29 | |
| 30 | // constexpr uint32_t SixFiveFiveNineNine(std::string_view string) { |
| 31 | constexpr uint32_t HashKey(std::string_view string) { |
| 32 | uint32_t hash = 0; |
| 33 | uint32_t coefficient = 65599u; |
| 34 | |
| 35 | for (char ch : string) { |
| 36 | hash += coefficient * unsigned(ch); |
| 37 | coefficient *= 65599u; |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 38 | } |
| 39 | |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 40 | return hash; |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 41 | } |
| 42 | |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 43 | constexpr size_t EntrySize(string_view key, span<const byte> value) { |
| 44 | return sizeof(EntryHeader) + key.size() + value.size(); |
| 45 | } |
| 46 | |
| 47 | } // namespace |
| 48 | |
| 49 | Status KeyValueStore::Init() { |
| 50 | // enabled_ = true; |
| 51 | |
| 52 | return Status::UNIMPLEMENTED; |
| 53 | } |
| 54 | |
| 55 | StatusWithSize KeyValueStore::Get(string_view key, |
| 56 | span<byte> value_buffer) const { |
| 57 | TRY(InvalidOperation(key)); |
| 58 | |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame^] | 59 | const KeyDescriptor* key_descriptor; |
| 60 | TRY(FindKeyDescriptor(key, &key_descriptor)); |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 61 | |
| 62 | EntryHeader header; |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame^] | 63 | TRY(ReadEntryHeader(*key_descriptor, &header)); |
| 64 | StatusWithSize result = ReadEntryValue(*key_descriptor, header, value_buffer); |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 65 | |
| 66 | if (result.ok() && options_.verify_on_read) { |
| 67 | return ValidateEntryChecksum(header, key, value_buffer); |
| 68 | } |
| 69 | return result; |
| 70 | } |
| 71 | |
| 72 | Status KeyValueStore::Put(string_view key, span<const byte> value) { |
| 73 | TRY(InvalidOperation(key)); |
| 74 | |
| 75 | if (value.size() > (1 << 24)) { |
| 76 | // TODO: Reject sizes that are larger than the maximum? |
| 77 | } |
| 78 | |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame^] | 79 | KeyDescriptor* key_descriptor; |
| 80 | if (FindKeyDescriptor(key, &key_descriptor).ok()) { |
| 81 | return WriteEntryForExistingKey(key_descriptor, key, value); |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 82 | } |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame^] | 83 | |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 84 | return WriteEntryForNewKey(key, value); |
| 85 | } |
| 86 | |
| 87 | Status KeyValueStore::Delete(string_view key) { |
| 88 | TRY(InvalidOperation(key)); |
| 89 | |
| 90 | return Status::UNIMPLEMENTED; |
| 91 | } |
| 92 | |
| 93 | const KeyValueStore::Entry& KeyValueStore::Iterator::operator*() { |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame^] | 94 | const KeyDescriptor& key_descriptor = |
| 95 | entry_.kvs_.key_descriptor_list_[index_]; |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 96 | |
| 97 | EntryHeader header; |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame^] | 98 | if (entry_.kvs_.ReadEntryHeader(key_descriptor, &header).ok()) { |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 99 | entry_.kvs_.ReadEntryKey( |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame^] | 100 | key_descriptor, header.key_length(), entry_.key_buffer_.data()); |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 101 | } |
| 102 | |
| 103 | return entry_; |
| 104 | } |
| 105 | |
| 106 | Status KeyValueStore::InvalidOperation(string_view key) const { |
Wyatt Hepler | acaacf9 | 2020-01-24 10:58:30 -0800 | [diff] [blame] | 107 | if (InvalidKey(key)) { |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 108 | return Status::INVALID_ARGUMENT; |
| 109 | } |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 110 | if (!/*enabled_*/ 0) { |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 111 | return Status::FAILED_PRECONDITION; |
| 112 | } |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 113 | return Status::OK; |
| 114 | } |
| 115 | |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame^] | 116 | Status KeyValueStore::FindKeyDescriptor(string_view key, |
| 117 | const KeyDescriptor** result) const { |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 118 | char key_buffer[kMaxKeyLength]; |
| 119 | const uint32_t hash = HashKey(key); |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 120 | |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame^] | 121 | for (auto& descriptor : key_descriptors()) { |
| 122 | if (descriptor.key_hash == hash) { |
| 123 | TRY(ReadEntryKey(descriptor, key.size(), key_buffer)); |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 124 | |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 125 | if (key == string_view(key_buffer, key.size())) { |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame^] | 126 | *result = &descriptor; |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 127 | return Status::OK; |
| 128 | } |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 129 | } |
| 130 | } |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 131 | return Status::NOT_FOUND; |
| 132 | } |
| 133 | |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame^] | 134 | Status KeyValueStore::ReadEntryHeader(const KeyDescriptor& descriptor, |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 135 | EntryHeader* header) const { |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame^] | 136 | return partition_.Read(descriptor.address, sizeof(*header), header).status(); |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 137 | } |
| 138 | |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame^] | 139 | Status KeyValueStore::ReadEntryKey(const KeyDescriptor& descriptor, |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 140 | size_t key_length, |
| 141 | char* key) const { |
| 142 | // TODO: This check probably shouldn't be here; this is like |
| 143 | // checking that the Cortex M's RAM isn't corrupt. This should be |
| 144 | // done at boot time. |
| 145 | // ^^ This argument sometimes comes from EntryHeader::key_value_len, |
| 146 | // which is read directly from flash. If it's corrupted, we shouldn't try |
| 147 | // to read a bunch of extra data. |
| 148 | if (key_length == 0u || key_length > kMaxKeyLength) { |
| 149 | return Status::DATA_LOSS; |
| 150 | } |
| 151 | // The key is immediately after the entry header. |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame^] | 152 | return partition_ |
| 153 | .Read(descriptor.address + sizeof(EntryHeader), key_length, key) |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 154 | .status(); |
| 155 | } |
| 156 | |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame^] | 157 | StatusWithSize KeyValueStore::ReadEntryValue( |
| 158 | const KeyDescriptor& key_descriptor, |
| 159 | const EntryHeader& header, |
| 160 | span<byte> value) const { |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 161 | const size_t read_size = std::min(header.value_length(), value.size()); |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame^] | 162 | StatusWithSize result = partition_.Read( |
| 163 | key_descriptor.address + sizeof(header) + header.key_length(), |
| 164 | value.subspan(read_size)); |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 165 | TRY(result); |
| 166 | if (read_size != header.value_length()) { |
| 167 | return StatusWithSize(Status::RESOURCE_EXHAUSTED, read_size); |
| 168 | } |
| 169 | return StatusWithSize(read_size); |
| 170 | } |
| 171 | |
| 172 | Status KeyValueStore::ValidateEntryChecksum(const EntryHeader& header, |
| 173 | string_view key, |
| 174 | span<const byte> value) const { |
| 175 | CalculateEntryChecksum(header, key, value); |
| 176 | return entry_header_format_.checksum->Verify(header.checksum()); |
| 177 | } |
| 178 | |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame^] | 179 | Status KeyValueStore::WriteEntryForExistingKey(KeyDescriptor* key_descriptor, |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 180 | string_view key, |
| 181 | span<const byte> value) { |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame^] | 182 | SectorDescriptor* sector; |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 183 | TRY(FindOrRecoverSectorWithSpace(§or, EntrySize(key, value))); |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame^] | 184 | return AppendEntry(sector, key_descriptor, key, value); |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 185 | } |
| 186 | |
| 187 | Status KeyValueStore::WriteEntryForNewKey(string_view key, |
| 188 | span<const byte> value) { |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame^] | 189 | if (KeyListFull()) { |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 190 | // TODO: Log, and also expose "in memory keymap full" in stats dump. |
| 191 | return Status::RESOURCE_EXHAUSTED; |
| 192 | } |
| 193 | |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame^] | 194 | // Modify the key descriptor at the end of the array, without bumping the map |
| 195 | // size so the key descriptor is prepared and written without committing |
| 196 | // first. |
| 197 | KeyDescriptor& key_descriptor = |
| 198 | key_descriptor_list_[key_descriptor_list_size_]; |
| 199 | key_descriptor.key_hash = HashKey(key); |
| 200 | key_descriptor.key_version = 0; // will be incremented by AppendEntry() |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 201 | |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame^] | 202 | SectorDescriptor* sector; |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 203 | TRY(FindOrRecoverSectorWithSpace(§or, EntrySize(key, value))); |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame^] | 204 | TRY(AppendEntry(sector, &key_descriptor, key, value)); |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 205 | |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame^] | 206 | // Only increment key_descriptor_list_size_ when we are certain the write |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 207 | // succeeded. |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame^] | 208 | key_descriptor_list_size_ += 1; |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 209 | return Status::OK; |
| 210 | } |
| 211 | |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame^] | 212 | Status KeyValueStore::RelocateEntry(KeyDescriptor& key_descriptor) { |
David Rogers | a12786b | 2020-01-31 16:02:33 -0800 | [diff] [blame] | 213 | // TODO: implement me |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame^] | 214 | (void)key_descriptor; |
David Rogers | a12786b | 2020-01-31 16:02:33 -0800 | [diff] [blame] | 215 | return Status::UNIMPLEMENTED; |
| 216 | } |
| 217 | |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 218 | // Find either an existing sector with enough space, or an empty sector. |
| 219 | // Maintains the invariant that there is always at least 1 empty sector. |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame^] | 220 | KeyValueStore::SectorDescriptor* KeyValueStore::FindSectorWithSpace( |
| 221 | size_t size) { |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 222 | int start = (last_written_sector_ + 1) % sector_map_.size(); |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame^] | 223 | SectorDescriptor* first_empty_sector = nullptr; |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 224 | bool at_least_two_empty_sectors = false; |
| 225 | |
| 226 | for (size_t i = start; i != last_written_sector_; |
| 227 | i = (i + 1) % sector_map_.size()) { |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame^] | 228 | SectorDescriptor& sector = sector_map_[i]; |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 229 | if (!SectorEmpty(sector) && sector.HasSpace(size)) { |
| 230 | return §or; |
| 231 | } |
| 232 | |
| 233 | if (SectorEmpty(sector)) { |
| 234 | if (first_empty_sector == nullptr) { |
| 235 | first_empty_sector = §or; |
| 236 | } else { |
| 237 | at_least_two_empty_sectors = true; |
Wyatt Hepler | 2ad6067 | 2020-01-21 08:00:16 -0800 | [diff] [blame] | 238 | } |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 239 | } |
| 240 | } |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 241 | |
| 242 | if (at_least_two_empty_sectors) { |
| 243 | return first_empty_sector; |
| 244 | } |
| 245 | return nullptr; |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 246 | } |
| 247 | |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame^] | 248 | Status KeyValueStore::FindOrRecoverSectorWithSpace(SectorDescriptor** sector, |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 249 | size_t size) { |
| 250 | *sector = FindSectorWithSpace(size); |
| 251 | if (*sector != nullptr) { |
| 252 | return Status::OK; |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 253 | } |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 254 | if (options_.partial_gc_on_write) { |
| 255 | return GarbageCollectOneSector(sector); |
| 256 | } |
| 257 | return Status::RESOURCE_EXHAUSTED; |
| 258 | } |
| 259 | |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame^] | 260 | KeyValueStore::SectorDescriptor* KeyValueStore::FindSectorToGarbageCollect() { |
| 261 | SectorDescriptor* sector_candidate = nullptr; |
David Rogers | a12786b | 2020-01-31 16:02:33 -0800 | [diff] [blame] | 262 | size_t candidate_bytes = 0; |
| 263 | |
| 264 | // Step 1: Try to find a sectors with stale keys and no valid keys (no |
| 265 | // relocation needed). If any such sectors are found, use the sector with the |
| 266 | // most reclaimable bytes. |
| 267 | for (auto& sector : sector_map_) { |
| 268 | if ((sector.valid_bytes == 0) && |
| 269 | (RecoverableBytes(sector) > candidate_bytes)) { |
| 270 | sector_candidate = §or; |
| 271 | candidate_bytes = RecoverableBytes(sector); |
| 272 | } |
| 273 | } |
| 274 | |
| 275 | // Step 2: If step 1 yields no sectors, just find the sector with the most |
| 276 | // reclaimable bytes. |
| 277 | if (sector_candidate == nullptr) { |
| 278 | for (auto& sector : sector_map_) { |
| 279 | if (RecoverableBytes(sector) > candidate_bytes) { |
| 280 | sector_candidate = §or; |
| 281 | candidate_bytes = RecoverableBytes(sector); |
| 282 | } |
| 283 | } |
| 284 | } |
| 285 | |
| 286 | return sector_candidate; |
| 287 | } |
| 288 | |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame^] | 289 | Status KeyValueStore::GarbageCollectOneSector(SectorDescriptor** sector) { |
David Rogers | a12786b | 2020-01-31 16:02:33 -0800 | [diff] [blame] | 290 | // Step 1: Find the sector to garbage collect |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame^] | 291 | SectorDescriptor* sector_to_gc = FindSectorToGarbageCollect(); |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 292 | |
David Rogers | a12786b | 2020-01-31 16:02:33 -0800 | [diff] [blame] | 293 | if (sector_to_gc == nullptr) { |
| 294 | return Status::RESOURCE_EXHAUSTED; |
| 295 | } |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 296 | |
David Rogers | a12786b | 2020-01-31 16:02:33 -0800 | [diff] [blame] | 297 | // Step 2: Move any valid entries in the GC sector to other sectors |
| 298 | if (sector_to_gc->valid_bytes != 0) { |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame^] | 299 | for (auto& descriptor : key_descriptors()) { |
| 300 | if (AddressInSector(*sector_to_gc, descriptor.address)) { |
| 301 | TRY(RelocateEntry(descriptor)); |
David Rogers | a12786b | 2020-01-31 16:02:33 -0800 | [diff] [blame] | 302 | } |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 303 | } |
| 304 | } |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 305 | |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 306 | if (sector_to_gc->valid_bytes != 0) { |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 307 | return Status::INTERNAL; |
| 308 | } |
| 309 | |
David Rogers | a12786b | 2020-01-31 16:02:33 -0800 | [diff] [blame] | 310 | // Step 3: Reinitialize the sector |
| 311 | sector_to_gc->tail_free_bytes = 0; |
| 312 | TRY(partition_.Erase(SectorBaseAddress(sector_to_gc), 1)); |
| 313 | sector_to_gc->tail_free_bytes = partition_.sector_size_bytes(); |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 314 | |
David Rogers | a12786b | 2020-01-31 16:02:33 -0800 | [diff] [blame] | 315 | *sector = sector_to_gc; |
| 316 | return Status::OK; |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 317 | } |
| 318 | |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame^] | 319 | Status KeyValueStore::AppendEntry(SectorDescriptor* sector, |
| 320 | KeyDescriptor* key_descriptor, |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 321 | const string_view key, |
| 322 | span<const byte> value) { |
| 323 | // write header, key, and value |
| 324 | const EntryHeader header(entry_header_format_.magic, |
| 325 | CalculateEntryChecksum(header, key, value), |
| 326 | key.size(), |
| 327 | value.size(), |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame^] | 328 | key_descriptor->key_version + 1); |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 329 | |
| 330 | // Handles writing multiple concatenated buffers, while breaking up the writes |
| 331 | // into alignment-sized blocks. |
| 332 | Address address = NextWritableAddress(sector); |
| 333 | TRY_ASSIGN( |
| 334 | size_t written, |
| 335 | partition_.Write( |
| 336 | address, {as_bytes(span(&header, 1)), as_bytes(span(key)), value})); |
| 337 | |
| 338 | if (options_.verify_on_write) { |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame^] | 339 | TRY(VerifyEntry(sector, key_descriptor)); |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 340 | } |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 341 | |
| 342 | // TODO: UPDATE last_written_sector_ appropriately |
| 343 | |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame^] | 344 | key_descriptor->address = address; |
| 345 | key_descriptor->key_version = header.key_version(); |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 346 | sector->valid_bytes += written; |
| 347 | sector->tail_free_bytes -= written; |
| 348 | return Status::OK; |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 349 | } |
| 350 | |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame^] | 351 | Status KeyValueStore::VerifyEntry(SectorDescriptor* sector, |
| 352 | KeyDescriptor* key_descriptor) { |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 353 | // TODO: Implement me! |
| 354 | (void)sector; |
David Rogers | 2761aeb | 2020-01-31 17:09:00 -0800 | [diff] [blame^] | 355 | (void)key_descriptor; |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 356 | return Status::UNIMPLEMENTED; |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 357 | } |
| 358 | |
Wyatt Hepler | 4da1fcb | 2020-01-30 17:32:18 -0800 | [diff] [blame] | 359 | span<const byte> KeyValueStore::CalculateEntryChecksum( |
| 360 | const EntryHeader& header, |
| 361 | const string_view key, |
| 362 | span<const byte> value) const { |
| 363 | auto& checksum = *entry_header_format_.checksum; |
| 364 | |
| 365 | checksum.Reset(); |
| 366 | checksum.Update(header.DataForChecksum()); |
| 367 | checksum.Update(as_bytes(span(key))); |
| 368 | checksum.Update(value.data(), value.size_bytes()); |
| 369 | return checksum.state(); |
Wyatt Hepler | b760954 | 2020-01-24 10:29:54 -0800 | [diff] [blame] | 370 | } |
| 371 | |
Wyatt Hepler | 2ad6067 | 2020-01-21 08:00:16 -0800 | [diff] [blame] | 372 | } // namespace pw::kvs |