// 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 "nvs.hpp" #include "nvs_test_api.h" #ifdef CONFIG_NVS_ENCRYPTION #include "nvs_encr.hpp" #endif #include "spi_flash_emulation.h" #include #include #include #include #include #include #include #define TEST_ESP_ERR(rc, res) CHECK((rc) == (res)) #define TEST_ESP_OK(rc) CHECK((rc) == ESP_OK) using namespace std; using namespace nvs; stringstream s_perf; void dumpBytes(const uint8_t* data, size_t count) { for (uint32_t i = 0; i < count; ++i) { if (i % 32 == 0) { printf("%08x ", i); } printf("%02x ", data[i]); if ((i + 1) % 32 == 0) { printf("\n"); } } } TEST_CASE("crc32 behaves as expected", "[nvs]") { Item item1; item1.datatype = ItemType::I32; item1.nsIndex = 1; item1.crc32 = 0; item1.chunkIndex = 0xff; fill_n(item1.key, sizeof(item1.key), 0xbb); fill_n(item1.data, sizeof(item1.data), 0xaa); auto crc32_1 = item1.calculateCrc32(); Item item2 = item1; item2.crc32 = crc32_1; CHECK(crc32_1 == item2.calculateCrc32()); item2 = item1; item2.nsIndex = 2; CHECK(crc32_1 != item2.calculateCrc32()); item2 = item1; item2.datatype = ItemType::U32; CHECK(crc32_1 != item2.calculateCrc32()); item2 = item1; strncpy(item2.key, "foo", Item::MAX_KEY_LENGTH); CHECK(crc32_1 != item2.calculateCrc32()); } TEST_CASE("starting with empty flash, page is in uninitialized state", "[nvs]") { SpiFlashEmulator emu(1); Page page; CHECK(page.state() == Page::PageState::INVALID); CHECK(page.load(0) == ESP_OK); CHECK(page.state() == Page::PageState::UNINITIALIZED); } TEST_CASE("can distinguish namespaces", "[nvs]") { SpiFlashEmulator emu(1); Page page; CHECK(page.load(0) == ESP_OK); int32_t val1 = 0x12345678; CHECK(page.writeItem(1, ItemType::I32, "intval1", &val1, sizeof(val1)) == ESP_OK); int32_t val2 = 0x23456789; CHECK(page.writeItem(2, ItemType::I32, "intval1", &val2, sizeof(val2)) == ESP_OK); int32_t readVal; CHECK(page.readItem(2, ItemType::I32, "intval1", &readVal, sizeof(readVal)) == ESP_OK); CHECK(readVal == val2); } TEST_CASE("reading with different type causes type mismatch error", "[nvs]") { SpiFlashEmulator emu(1); Page page; CHECK(page.load(0) == ESP_OK); int32_t val = 0x12345678; CHECK(page.writeItem(1, ItemType::I32, "intval1", &val, sizeof(val)) == ESP_OK); CHECK(page.readItem(1, ItemType::U32, "intval1", &val, sizeof(val)) == ESP_ERR_NVS_TYPE_MISMATCH); } TEST_CASE("when page is erased, it's state becomes UNITIALIZED", "[nvs]") { SpiFlashEmulator emu(1); Page page; CHECK(page.load(0) == ESP_OK); int32_t val = 0x12345678; CHECK(page.writeItem(1, ItemType::I32, "intval1", &val, sizeof(val)) == ESP_OK); CHECK(page.erase() == ESP_OK); CHECK(page.state() == Page::PageState::UNINITIALIZED); } TEST_CASE("when writing and erasing, used/erased counts are updated correctly", "[nvs]") { SpiFlashEmulator emu(1); Page page; CHECK(page.load(0) == ESP_OK); CHECK(page.getUsedEntryCount() == 0); CHECK(page.getErasedEntryCount() == 0); uint32_t foo1 = 0; CHECK(page.writeItem(1, "foo1", foo1) == ESP_OK); CHECK(page.getUsedEntryCount() == 1); CHECK(page.writeItem(2, "foo1", foo1) == ESP_OK); CHECK(page.getUsedEntryCount() == 2); CHECK(page.eraseItem(2, "foo1") == ESP_OK); CHECK(page.getUsedEntryCount() == 1); CHECK(page.getErasedEntryCount() == 1); for (size_t i = 0; i < Page::ENTRY_COUNT - 2; ++i) { char name[16]; snprintf(name, sizeof(name), "i%ld", (long int)i); CHECK(page.writeItem(1, name, i) == ESP_OK); } CHECK(page.getUsedEntryCount() == Page::ENTRY_COUNT - 1); CHECK(page.getErasedEntryCount() == 1); for (size_t i = 0; i < Page::ENTRY_COUNT - 2; ++i) { char name[16]; snprintf(name, sizeof(name), "i%ld", (long int)i); CHECK(page.eraseItem(1, itemTypeOf(), name) == ESP_OK); } CHECK(page.getUsedEntryCount() == 1); CHECK(page.getErasedEntryCount() == Page::ENTRY_COUNT - 1); } TEST_CASE("when page is full, adding an element fails", "[nvs]") { SpiFlashEmulator emu(1); Page page; CHECK(page.load(0) == ESP_OK); for (size_t i = 0; i < Page::ENTRY_COUNT; ++i) { char name[16]; snprintf(name, sizeof(name), "i%ld", (long int)i); CHECK(page.writeItem(1, name, i) == ESP_OK); } CHECK(page.writeItem(1, "foo", 64UL) == ESP_ERR_NVS_PAGE_FULL); } TEST_CASE("page maintains its seq number") { SpiFlashEmulator emu(1); { Page page; CHECK(page.load(0) == ESP_OK); CHECK(page.setSeqNumber(123) == ESP_OK); int32_t val = 42; CHECK(page.writeItem(1, ItemType::I32, "dummy", &val, sizeof(val)) == ESP_OK); } { Page page; CHECK(page.load(0) == ESP_OK); uint32_t seqno; CHECK(page.getSeqNumber(seqno) == ESP_OK); CHECK(seqno == 123); } } TEST_CASE("can write and read variable length data", "[nvs]") { SpiFlashEmulator emu(1); Page page; CHECK(page.load(0) == ESP_OK); const char str[] = "foobar1234foobar1234foobar1234foobar1234foobar1234foobar1234foobar1234foobar1234"; size_t len = strlen(str); CHECK(page.writeItem(1, "stuff1", 42) == ESP_OK); CHECK(page.writeItem(1, "stuff2", 1) == ESP_OK); CHECK(page.writeItem(1, ItemType::SZ, "foobaar", str, len + 1) == ESP_OK); CHECK(page.writeItem(1, "stuff3", 2) == ESP_OK); CHECK(page.writeItem(1, ItemType::BLOB, "baz", str, len) == ESP_OK); CHECK(page.writeItem(1, "stuff4", 0x7abbccdd) == ESP_OK); char buf[sizeof(str) + 16]; int32_t value; CHECK(page.readItem(1, "stuff1", value) == ESP_OK); CHECK(value == 42); CHECK(page.readItem(1, "stuff2", value) == ESP_OK); CHECK(value == 1); CHECK(page.readItem(1, "stuff3", value) == ESP_OK); CHECK(value == 2); CHECK(page.readItem(1, "stuff4", value) == ESP_OK); CHECK(value == 0x7abbccdd); fill_n(buf, sizeof(buf), 0xff); CHECK(page.readItem(1, ItemType::SZ, "foobaar", buf, sizeof(buf)) == ESP_OK); CHECK(memcmp(buf, str, strlen(str) + 1) == 0); fill_n(buf, sizeof(buf), 0xff); CHECK(page.readItem(1, ItemType::BLOB, "baz", buf, sizeof(buf)) == ESP_OK); CHECK(memcmp(buf, str, strlen(str)) == 0); } TEST_CASE("different key names are distinguished even if the pointer is the same", "[nvs]") { SpiFlashEmulator emu(1); Page page; TEST_ESP_OK(page.load(0)); TEST_ESP_OK(page.writeItem(1, "i1", 1)); TEST_ESP_OK(page.writeItem(1, "i2", 2)); int32_t value; char keyname[10] = {0}; for (int i = 0; i < 2; ++i) { strncpy(keyname, "i1", sizeof(keyname) - 1); TEST_ESP_OK(page.readItem(1, keyname, value)); CHECK(value == 1); strncpy(keyname, "i2", sizeof(keyname) - 1); TEST_ESP_OK(page.readItem(1, keyname, value)); CHECK(value == 2); } } TEST_CASE("Page validates key size", "[nvs]") { SpiFlashEmulator emu(4); Page page; TEST_ESP_OK(page.load(0)); // 16-character key fails TEST_ESP_ERR(page.writeItem(1, "0123456789123456", 1), ESP_ERR_NVS_KEY_TOO_LONG); // 15-character key is okay TEST_ESP_OK(page.writeItem(1, "012345678912345", 1)); } TEST_CASE("Page validates blob size", "[nvs]") { SpiFlashEmulator emu(4); Page page; TEST_ESP_OK(page.load(0)); char buf[2048] = { 0 }; // There are two potential errors here: // - not enough space in the page (because one value has been written already) // - value is too long // Check that the second one is actually returned. TEST_ESP_ERR(page.writeItem(1, ItemType::BLOB, "2", buf, Page::ENTRY_COUNT * Page::ENTRY_SIZE), ESP_ERR_NVS_VALUE_TOO_LONG); // Should fail as well TEST_ESP_ERR(page.writeItem(1, ItemType::BLOB, "2", buf, Page::CHUNK_MAX_SIZE + 1), ESP_ERR_NVS_VALUE_TOO_LONG); TEST_ESP_OK(page.writeItem(1, ItemType::BLOB, "2", buf, Page::CHUNK_MAX_SIZE)); } TEST_CASE("Page handles invalid CRC of variable length items", "[nvs][cur]") { SpiFlashEmulator emu(4); { Page page; TEST_ESP_OK(page.load(0)); char buf[128] = {0}; TEST_ESP_OK(page.writeItem(1, ItemType::BLOB, "1", buf, sizeof(buf))); } // corrupt header of the item (64 is the offset of the first item in page) uint32_t overwrite_buf = 0; emu.write(64, &overwrite_buf, 4); // load page again { Page page; TEST_ESP_OK(page.load(0)); } } class HashListTestHelper : public HashList { public: size_t getBlockCount() { return mBlockList.size(); } }; TEST_CASE("HashList is cleaned up as soon as items are erased", "[nvs]") { HashListTestHelper hashlist; // Add items const size_t count = 128; for (size_t i = 0; i < count; ++i) { char key[16]; snprintf(key, sizeof(key), "i%ld", (long int)i); Item item(1, ItemType::U32, 1, key); hashlist.insert(item, i); } INFO("Added " << count << " items, " << hashlist.getBlockCount() << " blocks"); // Remove them in reverse order for (size_t i = count; i > 0; --i) { hashlist.erase(i - 1, true); } CHECK(hashlist.getBlockCount() == 0); // Add again for (size_t i = 0; i < count; ++i) { char key[16]; snprintf(key, sizeof(key), "i%ld", (long int)i); Item item(1, ItemType::U32, 1, key); hashlist.insert(item, i); } INFO("Added " << count << " items, " << hashlist.getBlockCount() << " blocks"); // Remove them in the same order for (size_t i = 0; i < count; ++i) { hashlist.erase(i, true); } CHECK(hashlist.getBlockCount() == 0); } TEST_CASE("can init PageManager in empty flash", "[nvs]") { SpiFlashEmulator emu(4); PageManager pm; CHECK(pm.load(0, 4) == ESP_OK); } TEST_CASE("PageManager adds page in the correct order", "[nvs]") { const size_t pageCount = 8; SpiFlashEmulator emu(pageCount); uint32_t pageNo[pageCount] = { -1U, 50, 11, -1U, 23, 22, 24, 49}; for (uint32_t i = 0; i < pageCount; ++i) { Page p; p.load(i); if (pageNo[i] != -1U) { p.setSeqNumber(pageNo[i]); p.writeItem(1, "foo", 10U); } } PageManager pageManager; CHECK(pageManager.load(0, pageCount) == ESP_OK); uint32_t lastSeqNo = 0; for (auto it = std::begin(pageManager); it != std::end(pageManager); ++it) { uint32_t seqNo; CHECK(it->getSeqNumber(seqNo) == ESP_OK); CHECK(seqNo > lastSeqNo); } } TEST_CASE("can init storage in empty flash", "[nvs]") { SpiFlashEmulator emu(8); Storage storage; emu.setBounds(4, 8); CHECK(storage.init(4, 4) == ESP_OK); s_perf << "Time to init empty storage (4 sectors): " << emu.getTotalTime() << " us" << std::endl; } TEST_CASE("storage doesn't add duplicates within one page", "[nvs]") { SpiFlashEmulator emu(8); Storage storage; emu.setBounds(4, 8); CHECK(storage.init(4, 4) == ESP_OK); int bar = 0; CHECK(storage.writeItem(1, "bar", bar) == ESP_OK); CHECK(storage.writeItem(1, "bar", bar) == ESP_OK); Page page; page.load(4); CHECK(page.getUsedEntryCount() == 1); CHECK(page.getErasedEntryCount() == 1); } TEST_CASE("can write one item a thousand times", "[nvs]") { SpiFlashEmulator emu(8); Storage storage; emu.setBounds(4, 8); CHECK(storage.init(4, 4) == ESP_OK); for (size_t i = 0; i < Page::ENTRY_COUNT * 4 * 2; ++i) { REQUIRE(storage.writeItem(1, "i", static_cast(i)) == ESP_OK); } s_perf << "Time to write one item a thousand times: " << emu.getTotalTime() << " us (" << emu.getEraseOps() << " " << emu.getWriteOps() << " " << emu.getReadOps() << " " << emu.getWriteBytes() << " " << emu.getReadBytes() << ")" << std::endl; } TEST_CASE("storage doesn't add duplicates within multiple pages", "[nvs]") { SpiFlashEmulator emu(8); Storage storage; emu.setBounds(4, 8); CHECK(storage.init(4, 4) == ESP_OK); int bar = 0; CHECK(storage.writeItem(1, "bar", bar) == ESP_OK); for (size_t i = 0; i < Page::ENTRY_COUNT; ++i) { CHECK(storage.writeItem(1, "foo", static_cast(bar)) == ESP_OK); } CHECK(storage.writeItem(1, "bar", bar) == ESP_OK); Page page; page.load(4); CHECK(page.findItem(1, itemTypeOf(), "bar") == ESP_ERR_NVS_NOT_FOUND); page.load(5); CHECK(page.findItem(1, itemTypeOf(), "bar") == ESP_OK); } TEST_CASE("storage can find items on second page if first is not fully written and has cached search data", "[nvs]") { SpiFlashEmulator emu(3); Storage storage; CHECK(storage.init(0, 3) == ESP_OK); int bar = 0; uint8_t bigdata[(Page::CHUNK_MAX_SIZE - Page::ENTRY_SIZE)/2] = {0}; // write one big chunk of data ESP_ERROR_CHECK(storage.writeItem(0, ItemType::BLOB, "1", bigdata, sizeof(bigdata))); // write another big chunk of data ESP_ERROR_CHECK(storage.writeItem(0, ItemType::BLOB, "2", bigdata, sizeof(bigdata))); // write third one; it will not fit into the first page ESP_ERROR_CHECK(storage.writeItem(0, ItemType::BLOB, "3", bigdata, sizeof(bigdata))); size_t size; ESP_ERROR_CHECK(storage.getItemDataSize(0, ItemType::BLOB, "1", size)); CHECK(size == sizeof(bigdata)); ESP_ERROR_CHECK(storage.getItemDataSize(0, ItemType::BLOB, "3", size)); CHECK(size == sizeof(bigdata)); } TEST_CASE("can write and read variable length data lots of times", "[nvs]") { SpiFlashEmulator emu(8); Storage storage; emu.setBounds(4, 8); CHECK(storage.init(4, 4) == ESP_OK); const char str[] = "foobar1234foobar1234foobar1234foobar1234foobar1234foobar1234foobar1234foobar1234"; char buf[sizeof(str) + 16]; size_t len = strlen(str); for (size_t i = 0; i < Page::ENTRY_COUNT * 4 * 2; ++i) { CAPTURE(i); CHECK(storage.writeItem(1, ItemType::SZ, "foobaar", str, len + 1) == ESP_OK); CHECK(storage.writeItem(1, "foo", static_cast(i)) == ESP_OK); uint32_t value; CHECK(storage.readItem(1, "foo", value) == ESP_OK); CHECK(value == i); fill_n(buf, sizeof(buf), 0xff); CHECK(storage.readItem(1, ItemType::SZ, "foobaar", buf, sizeof(buf)) == ESP_OK); CHECK(memcmp(buf, str, strlen(str) + 1) == 0); } s_perf << "Time to write one string and one integer a thousand times: " << emu.getTotalTime() << " us (" << emu.getEraseOps() << " " << emu.getWriteOps() << " " << emu.getReadOps() << " " << emu.getWriteBytes() << " " << emu.getReadBytes() << ")" << std::endl; } TEST_CASE("can get length of variable length data", "[nvs]") { SpiFlashEmulator emu(8); emu.randomize(200); Storage storage; emu.setBounds(4, 8); CHECK(storage.init(4, 4) == ESP_OK); const char str[] = "foobar1234foobar1234foobar1234foobar1234foobar1234foobar1234foobar1234foobar1234"; size_t len = strlen(str); CHECK(storage.writeItem(1, ItemType::SZ, "foobaar", str, len + 1) == ESP_OK); size_t dataSize; CHECK(storage.getItemDataSize(1, ItemType::SZ, "foobaar", dataSize) == ESP_OK); CHECK(dataSize == len + 1); CHECK(storage.writeItem(2, ItemType::BLOB, "foobaar", str, len) == ESP_OK); CHECK(storage.getItemDataSize(2, ItemType::BLOB, "foobaar", dataSize) == ESP_OK); CHECK(dataSize == len); } TEST_CASE("can create namespaces", "[nvs]") { SpiFlashEmulator emu(8); Storage storage; emu.setBounds(4, 8); CHECK(storage.init(4, 4) == ESP_OK); uint8_t nsi; CHECK(storage.createOrOpenNamespace("wifi", false, nsi) == ESP_ERR_NVS_NOT_FOUND); CHECK(storage.createOrOpenNamespace("wifi", true, nsi) == ESP_OK); Page page; page.load(4); CHECK(page.findItem(Page::NS_INDEX, ItemType::U8, "wifi") == ESP_OK); } TEST_CASE("storage may become full", "[nvs]") { SpiFlashEmulator emu(8); Storage storage; emu.setBounds(4, 8); CHECK(storage.init(4, 4) == ESP_OK); for (size_t i = 0; i < Page::ENTRY_COUNT * 3; ++i) { char name[Item::MAX_KEY_LENGTH + 1]; snprintf(name, sizeof(name), "key%05d", static_cast(i)); REQUIRE(storage.writeItem(1, name, static_cast(i)) == ESP_OK); } REQUIRE(storage.writeItem(1, "foo", 10) == ESP_ERR_NVS_NOT_ENOUGH_SPACE); } TEST_CASE("can modify an item on a page which will be erased", "[nvs]") { SpiFlashEmulator emu(2); Storage storage; CHECK(storage.init(0, 2) == ESP_OK); for (size_t i = 0; i < Page::ENTRY_COUNT * 3 + 1; ++i) { REQUIRE(storage.writeItem(1, "foo", 42U) == ESP_OK); } } TEST_CASE("can erase items", "[nvs]") { SpiFlashEmulator emu(3); Storage storage; CHECK(storage.init(0, 3) == ESP_OK); for (size_t i = 0; i < Page::ENTRY_COUNT * 2 - 3; ++i) { char name[Item::MAX_KEY_LENGTH + 1]; snprintf(name, sizeof(name), "key%05d", static_cast(i)); REQUIRE(storage.writeItem(3, name, static_cast(i)) == ESP_OK); } CHECK(storage.writeItem(1, "foo", 32) == ESP_OK); CHECK(storage.writeItem(2, "foo", 64) == ESP_OK); CHECK(storage.eraseItem(2, "foo") == ESP_OK); int val; CHECK(storage.readItem(1, "foo", val) == ESP_OK); CHECK(val == 32); CHECK(storage.eraseNamespace(3) == ESP_OK); CHECK(storage.readItem(2, "foo", val) == ESP_ERR_NVS_NOT_FOUND); CHECK(storage.readItem(3, "key00222", val) == ESP_ERR_NVS_NOT_FOUND); } TEST_CASE("nvs api tests", "[nvs]") { SpiFlashEmulator emu(10); emu.randomize(100); nvs_handle handle_1; const uint32_t NVS_FLASH_SECTOR = 6; const uint32_t NVS_FLASH_SECTOR_COUNT_MIN = 3; emu.setBounds(NVS_FLASH_SECTOR, NVS_FLASH_SECTOR + NVS_FLASH_SECTOR_COUNT_MIN); TEST_ESP_ERR(nvs_open("namespace1", NVS_READWRITE, &handle_1), ESP_ERR_NVS_NOT_INITIALIZED); for (uint16_t i = NVS_FLASH_SECTOR; i