From f04c89412387ad5ebc824ba0a02030e8071bc9d3 Mon Sep 17 00:00:00 2001
From: Ivan Grokhotkov <ivan@espressif.com>
Date: Mon, 22 Aug 2016 11:46:44 +0800
Subject: [PATCH] components/nvs: add debugging facilities and runtime checks

Extra runtime sanity checks run when compiled for the host (i.e. with no ESP_PLATFORM define)
---
 components/nvs_flash/src/nvs_api.cpp         |  6 ++
 components/nvs_flash/src/nvs_page.cpp        |  1 +
 components/nvs_flash/src/nvs_pagemanager.cpp |  3 +
 components/nvs_flash/src/nvs_storage.cpp     | 62 +++++++++++++++++++-
 components/nvs_flash/src/nvs_storage.hpp     |  3 +
 5 files changed, 72 insertions(+), 3 deletions(-)

diff --git a/components/nvs_flash/src/nvs_api.cpp b/components/nvs_flash/src/nvs_api.cpp
index 655ed24f87..041dc9e46e 100644
--- a/components/nvs_flash/src/nvs_api.cpp
+++ b/components/nvs_flash/src/nvs_api.cpp
@@ -45,6 +45,12 @@ static intrusive_list<HandleEntry> s_nvs_handles;
 static uint32_t s_nvs_next_handle = 1;
 static nvs::Storage s_nvs_storage;
 
+extern "C" void nvs_dump()
+{
+    Lock lock;
+    s_nvs_storage.debugDump();
+}
+
 extern "C" esp_err_t nvs_flash_init(uint32_t baseSector, uint32_t sectorCount)
 {
     Lock::init();
diff --git a/components/nvs_flash/src/nvs_page.cpp b/components/nvs_flash/src/nvs_page.cpp
index 0633f5d946..903adfaedf 100644
--- a/components/nvs_flash/src/nvs_page.cpp
+++ b/components/nvs_flash/src/nvs_page.cpp
@@ -17,6 +17,7 @@
 #else
 #include "crc.h"
 #endif
+#include <cstdio>
 
 
 namespace nvs
diff --git a/components/nvs_flash/src/nvs_pagemanager.cpp b/components/nvs_flash/src/nvs_pagemanager.cpp
index 8fd62430d5..bdf609aa94 100644
--- a/components/nvs_flash/src/nvs_pagemanager.cpp
+++ b/components/nvs_flash/src/nvs_pagemanager.cpp
@@ -91,6 +91,7 @@ esp_err_t PageManager::requestNewPage()
     Page* newPage = &mPageList.back();
 
     Page* erasedPage = maxErasedItemsPageIt;
+    size_t usedEntries = erasedPage->getUsedEntryCount();
     err = erasedPage->markFreeing();
     if (err != ESP_OK) {
         return err;
@@ -108,6 +109,8 @@ esp_err_t PageManager::requestNewPage()
     if (err != ESP_OK) {
         return err;
     }
+    
+    assert(usedEntries == newPage->getUsedEntryCount());
 
     mPageList.erase(maxErasedItemsPageIt);
     mFreePageList.push_back(erasedPage);
diff --git a/components/nvs_flash/src/nvs_storage.cpp b/components/nvs_flash/src/nvs_storage.cpp
index 510c52407a..32738fa298 100644
--- a/components/nvs_flash/src/nvs_storage.cpp
+++ b/components/nvs_flash/src/nvs_storage.cpp
@@ -13,6 +13,11 @@
 // limitations under the License.
 #include "nvs_storage.hpp"
 
+#ifndef ESP_PLATFORM
+#include <map>
+#include <sstream>
+#endif
+
 namespace nvs
 {
 
@@ -56,6 +61,9 @@ esp_err_t Storage::init(uint32_t baseSector, uint32_t sectorCount)
     mNamespaceUsage.set(0, true);
     mNamespaceUsage.set(255, true);
     mState = StorageState::ACTIVE;
+#ifndef ESP_PLATFORM
+    debugCheck();
+#endif
     return ESP_OK;
 }
 
@@ -75,29 +83,46 @@ esp_err_t Storage::writeItem(uint8_t nsIndex, ItemType datatype, const char* key
     Page& page = getCurrentPage();
     err = page.writeItem(nsIndex, datatype, key, data, dataSize);
     if (err == ESP_ERR_NVS_PAGE_FULL) {
-        page.markFull();
+        if (page.state() != Page::PageState::FULL) {
+            err = page.markFull();
+            if (err != ESP_OK) {
+                return err;
+            }
+        }
         err = mPageManager.requestNewPage();
         if (err != ESP_OK) {
             return err;
         }
 
         err = getCurrentPage().writeItem(nsIndex, datatype, key, data, dataSize);
+        if (err == ESP_ERR_NVS_PAGE_FULL) {
+            return ESP_ERR_NVS_NOT_ENOUGH_SPACE;
+        }
         if (err != ESP_OK) {
             return err;
         }
     }
+    else if (err != ESP_OK) {
+        return err;
+    }
 
     if (findPage) {
-        if (findPage->state() == Page::PageState::UNINITIALIZED) {
+        if (findPage->state() == Page::PageState::UNINITIALIZED ||
+            findPage->state() == Page::PageState::INVALID) {
             auto err = findItem(nsIndex, datatype, key, findPage, item);
             assert(err == ESP_OK);
         }
         err = findPage->eraseItem(nsIndex, datatype, key);
+        if (err == ESP_ERR_FLASH_OP_FAIL) {
+            return ESP_ERR_NVS_REMOVE_FAILED;
+        }
         if (err != ESP_OK) {
             return err;
         }
     }
-
+#ifndef ESP_PLATFORM
+    debugCheck();
+#endif
     return ESP_OK;
 }
 
@@ -192,4 +217,35 @@ esp_err_t Storage::getItemDataSize(uint8_t nsIndex, ItemType datatype, const cha
     return ESP_OK;
 }
 
+void Storage::debugDump()
+{
+    for (auto p = mPageManager.begin(); p != mPageManager.end(); ++p) {
+        p->debugDump();
+    }
+}
+
+#ifndef ESP_PLATFORM
+void Storage::debugCheck()
+{
+    std::map<std::string, Page*> keys;
+    
+    for (auto p = mPageManager.begin(); p != mPageManager.end(); ++p) {
+        size_t itemIndex = 0;
+        Item item;
+        while (p->findItem(Page::NS_ANY, ItemType::ANY, nullptr, itemIndex, item) == ESP_OK) {
+            std::stringstream keyrepr;
+            keyrepr << static_cast<unsigned>(item.nsIndex) << "_" << static_cast<unsigned>(item.datatype) << "_" << item.key;
+            std::string keystr = keyrepr.str();
+            if (keys.find(keystr) != std::end(keys)) {
+                printf("Duplicate key: %s\n", keystr.c_str());
+                debugDump();
+                assert(0);
+            }
+            keys.insert(std::make_pair(keystr, static_cast<Page*>(p)));
+            itemIndex += item.span;
+        }
+    }
+}
+#endif //ESP_PLATFORM
+
 }
\ No newline at end of file
diff --git a/components/nvs_flash/src/nvs_storage.hpp b/components/nvs_flash/src/nvs_storage.hpp
index d61b219b26..3a05c32668 100644
--- a/components/nvs_flash/src/nvs_storage.hpp
+++ b/components/nvs_flash/src/nvs_storage.hpp
@@ -74,6 +74,9 @@ public:
     {
         return eraseItem(nsIndex, itemTypeOf<T>(), key);
     }
+    
+    void debugDump();
+    void debugCheck();
 
 
 protected:
-- 
2.40.0