Crash_Override/OVMS3-idf
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

NVS: bugfix - iterator skipping version 1 blobs

Browse source 
Closes https://github.com/espressif/esp-idf/issues/4954
This commit is contained in:
Jakob Hasse 2020-03-20 13:35:36 +08:00
parent 8dc421c7e1
commit 26379f7d3e
4 changed files with 69 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
components/nvs_flash/src/nvs_storage.cpp
View file

@ -741,7 +741,9 @@ inline bool isIterableItem(Item& item)
inline bool isMultipageBlob(Item& item)
{
return (item.datatype == ItemType::BLOB_DATA && item.chunkIndex != 0);
return (item.datatype == ItemType::BLOB_DATA &&
!(item.chunkIndex == static_cast<uint8_t>(VerOffset::VER_0_OFFSET)
|| item.chunkIndex == static_cast<uint8_t>(VerOffset::VER_1_OFFSET)));
}
bool Storage::nextEntry(nvs_opaque_iterator_t* it)

6
components/nvs_flash/src/nvs_types.hpp
View file

@ -28,6 +28,12 @@ using namespace std;
namespace nvs
{
/**
* Used to recognize transient states of a blob. Once a blob is modified, new chunks with the new data are written
* with a new version. The version is saved in the highest bit of Item::chunkIndex as well as in
* Item::blobIndex::chunkStart.
* If a chunk is modified and hence re-written, the version swaps: 0x0 -> 0x80 or 0x80 -> 0x0.
*/
enum class VerOffset: uint8_t {
VER_0_OFFSET = 0x0,
VER_1_OFFSET = 0x80,

1
components/nvs_flash/test_nvs_host/Makefile
View file

@ -24,6 +24,7 @@ SOURCE_FILES = \
test_nvs.cpp \
test_partition_manager.cpp \
test_nvs_handle.cpp \
test_nvs_storage.cpp \
test_nvs_cxx_api.cpp \
crc.cpp \
main.cpp

59
components/nvs_flash/test_nvs_host/test_nvs_storage.cpp Normal file
View file

@ -0,0 +1,59 @@
// Copyright 2015-2016 Espressif Systems (Shanghai) PTE LTD
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#include "catch.hpp"
#include <cstring>
#include "nvs_test_api.h"
#include "nvs_storage.hpp"
#include "nvs_partition_manager.hpp"
#include "spi_flash_emulation.h"
#include <iostream>
using namespace std;
using namespace nvs;
TEST_CASE("Storage iterator recognizes blob with VerOffset::VER_1_OFFSET", "[nvs_storage]")
{
const uint32_t NVS_FLASH_SECTOR = 6;
const uint32_t NVS_FLASH_SECTOR_COUNT_MIN = 3;
SpiFlashEmulator emu(10);
REQUIRE(NVSPartitionManager::get_instance()->init_custom("test", NVS_FLASH_SECTOR, NVS_FLASH_SECTOR_COUNT_MIN)
== ESP_OK);
uint8_t blob [] = {0x0, 0x1, 0x2, 0x3};
uint8_t blob_new [] = {0x3, 0x2, 0x1, 0x0};
Storage *storage = NVSPartitionManager::get_instance()->lookup_storage_from_name("test");
uint8_t ns_index;
storage->createOrOpenNamespace("test_ns", true, ns_index);
CHECK(storage->writeItem(ns_index, ItemType::BLOB, "test_blob", blob, sizeof(blob)) == ESP_OK);
// changing provokes a blob with version offset 1 (VerOffset::VER_1_OFFSET)
CHECK(storage->writeItem(ns_index, ItemType::BLOB, "test_blob", blob_new, sizeof(blob_new)) == ESP_OK);
nvs_opaque_iterator_t it;
it.storage = storage;
it.type = NVS_TYPE_ANY;
// Central check: does the iterator recognize the blob with version 1?
REQUIRE(storage->findEntry(&it, "test_ns"));
CHECK(string(it.entry_info.namespace_name) == string("test_ns"));
CHECK(string(it.entry_info.key) == string("test_blob"));
CHECK(it.entry_info.type == NVS_TYPE_BLOB);
REQUIRE(NVSPartitionManager::get_instance()->deinit_partition("test") == ESP_OK);
}