/* * SPDX-FileCopyrightText: 2015-2022 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ #ifndef nvs_storage_hpp #define nvs_storage_hpp #include #include #include #include "nvs.hpp" #include "nvs_types.hpp" #include "nvs_page.hpp" #include "nvs_pagemanager.hpp" #include "nvs_memory_management.hpp" #include "partition.hpp" //extern void dumpBytes(const uint8_t* data, size_t count); namespace nvs { class Storage : public intrusive_list_node, public ExceptionlessAllocatable { enum class StorageState : uint32_t { INVALID, ACTIVE, }; struct NamespaceEntry : public intrusive_list_node, public ExceptionlessAllocatable { public: char mName[Item::MAX_KEY_LENGTH + 1]; uint8_t mIndex; }; typedef intrusive_list TNamespaces; struct UsedPageNode: public intrusive_list_node, public ExceptionlessAllocatable { public: Page* mPage; }; typedef intrusive_list TUsedPageList; struct BlobIndexNode: public intrusive_list_node, public ExceptionlessAllocatable { public: char key[Item::MAX_KEY_LENGTH + 1]; uint8_t nsIndex; uint8_t chunkCount; VerOffset chunkStart; }; typedef intrusive_list TBlobIndexList; public: ~Storage(); Storage(Partition *partition) : mPartition(partition) { if (partition == nullptr) { abort(); } }; esp_err_t init(uint32_t baseSector, uint32_t sectorCount); bool isValid() const; esp_err_t createOrOpenNamespace(const char* nsName, bool canCreate, uint8_t& nsIndex); esp_err_t writeItem(uint8_t nsIndex, ItemType datatype, const char* key, const void* data, size_t dataSize); esp_err_t readItem(uint8_t nsIndex, ItemType datatype, const char* key, void* data, size_t dataSize); esp_err_t getItemDataSize(uint8_t nsIndex, ItemType datatype, const char* key, size_t& dataSize); esp_err_t eraseItem(uint8_t nsIndex, ItemType datatype, const char* key); template esp_err_t writeItem(uint8_t nsIndex, const char* key, const T& value) { return writeItem(nsIndex, itemTypeOf(value), key, &value, sizeof(value)); } template esp_err_t readItem(uint8_t nsIndex, const char* key, T& value) { return readItem(nsIndex, itemTypeOf(value), key, &value, sizeof(value)); } esp_err_t eraseItem(uint8_t nsIndex, const char* key) { return eraseItem(nsIndex, ItemType::ANY, key); } esp_err_t eraseNamespace(uint8_t nsIndex); const Partition *getPart() const { return mPartition; } const char *getPartName() const { return mPartition->get_partition_name(); } uint32_t getBaseSector() { return mPageManager.getBaseSector(); } esp_err_t writeMultiPageBlob(uint8_t nsIndex, const char* key, const void* data, size_t dataSize, VerOffset chunkStart); esp_err_t readMultiPageBlob(uint8_t nsIndex, const char* key, void* data, size_t dataSize); esp_err_t cmpMultiPageBlob(uint8_t nsIndex, const char* key, const void* data, size_t dataSize); esp_err_t eraseMultiPageBlob(uint8_t nsIndex, const char* key, VerOffset chunkStart = VerOffset::VER_ANY); void debugDump(); void debugCheck(); esp_err_t fillStats(nvs_stats_t& nvsStats); esp_err_t calcEntriesInNamespace(uint8_t nsIndex, size_t& usedEntries); bool findEntry(nvs_opaque_iterator_t*, const char* name); bool nextEntry(nvs_opaque_iterator_t* it); protected: Page& getCurrentPage() { return mPageManager.back(); } void clearNamespaces(); esp_err_t populateBlobIndices(TBlobIndexList&); void eraseOrphanDataBlobs(TBlobIndexList&); void fillEntryInfo(Item &item, nvs_entry_info_t &info); esp_err_t findItem(uint8_t nsIndex, ItemType datatype, const char* key, Page* &page, Item& item, uint8_t chunkIdx = Page::CHUNK_ANY, VerOffset chunkStart = VerOffset::VER_ANY); protected: Partition *mPartition; size_t mPageCount; PageManager mPageManager; TNamespaces mNamespaces; CompressedEnumTable mNamespaceUsage; StorageState mState = StorageState::INVALID; }; } // namespace nvs struct nvs_opaque_iterator_t { nvs_type_t type; uint8_t nsIndex; size_t entryIndex; nvs::Storage *storage; intrusive_list::iterator page; nvs_entry_info_t entry_info; }; #endif /* nvs_storage_hpp */