Merge pull request #13908 from LDong-Arm/kvstore_libraries

Restructure KVStore to one library per store type
ARMmbed · Dec 11, 2020 · 9f18c44 · 9f18c44
2 parents 86ee300 + 479b704
commit 9f18c44
Show file tree

Hide file tree

Showing 39 changed files with 165 additions and 64 deletions.
diff --git a/TESTS/configs/baremetal.json b/TESTS/configs/baremetal.json
@@ -25,6 +25,9 @@
         "system-storage",
         "SecureStore",
         "storage",
+        "kvstore",
+        "tdbstore",
+        "filesystemstore",
         "kv-global-api",
         "direct-access-devicekey",
         "kv-config",

diff --git a/UNITTESTS/CMakeLists.txt b/UNITTESTS/CMakeLists.txt
@@ -122,6 +122,9 @@ set(unittest-includes-base
   "${PROJECT_SOURCE_DIR}/../storage/kvstore/include"
   "${PROJECT_SOURCE_DIR}/../storage/kvstore/kv_config"
   "${PROJECT_SOURCE_DIR}/../storage/kvstore/kv_config/include"
+  "${PROJECT_SOURCE_DIR}/../storage/kvstore/tdbstore/include"
+  "${PROJECT_SOURCE_DIR}/../storage/kvstore/filesystemstore/include"
+  "${PROJECT_SOURCE_DIR}/../storage/kvstore/kvstore_global_api/include"
   "${PROJECT_SOURCE_DIR}/../drivers"
   "${PROJECT_SOURCE_DIR}/../drivers/include"
   "${PROJECT_SOURCE_DIR}/../drivers/include/drivers"

diff --git a/drivers/device_key/CMakeLists.txt b/drivers/device_key/CMakeLists.txt
@@ -17,4 +17,6 @@ target_sources(mbed-device_key
 target_link_libraries(mbed-device_key
     INTERFACE
         mbed-storage-kvstore
+        mbed-storage-tdbstore
+        mbed-storage-kv-global-api
 )
diff --git a/drivers/device_key/source/DeviceKey.cpp b/drivers/device_key/source/DeviceKey.cpp
@@ -21,8 +21,8 @@
 #include "mbedtls/cmac.h"
 #include "mbedtls/platform.h"
 #include "kvstore/KVStore.h"
-#include "kvstore/TDBStore.h"
-#include "kvstore/KVMap.h"
+#include "tdbstore/TDBStore.h"
+#include "kvstore_global_api/KVMap.h"
 #include "kv_config/kv_config.h"
 #include "mbed_wait_api.h"
 #include <stdlib.h>

diff --git a/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/CMakeLists.txt b/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/CMakeLists.txt
@@ -24,4 +24,7 @@ target_link_libraries(mbed-psa
     INTERFACE
         mbed-mbedtls
         mbed-storage-kvstore
+        mbed-storage-tdbstore
+        mbed-storage-kv-global-api
+        mbed-device_key
 )
diff --git a/storage/CMakeLists.txt b/storage/CMakeLists.txt
@@ -18,6 +18,12 @@ add_library(mbed-storage-littlefs INTERFACE)
 add_library(mbed-storage-fat INTERFACE)
 
 add_library(mbed-storage-kvstore INTERFACE)
+add_library(mbed-storage-tdbstore INTERFACE)
+add_library(mbed-storage-filesystemstore INTERFACE)
+add_library(mbed-storage-securestore INTERFACE)
+add_library(mbed-storage-kv-config INTERFACE)
+add_library(mbed-storage-direct-access-devicekey INTERFACE)
+add_library(mbed-storage-kv-global-api INTERFACE)
 
 
 add_subdirectory(blockdevice)
@@ -29,8 +35,3 @@ target_include_directories(mbed-storage
     INTERFACE
         .
 )
-
-target_compile_definitions(mbed-storage
-    INTERFACE
-        MBED_CONF_FILESYSTEM_PRESENT=1
-)
diff --git a/storage/filesystem/CMakeLists.txt b/storage/filesystem/CMakeLists.txt
@@ -18,3 +18,8 @@ target_sources(mbed-storage-filesystem
         source/File.cpp
         source/FileSystem.cpp
 )
+
+target_compile_definitions(mbed-storage
+    INTERFACE
+        MBED_CONF_FILESYSTEM_PRESENT=1
+)
diff --git a/storage/kvstore/CMakeLists.txt b/storage/kvstore/CMakeLists.txt
@@ -1,32 +1,16 @@
 # Copyright (c) 2020 ARM Limited. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 
-add_subdirectory(direct_access_devicekey)
-add_subdirectory(kv_config)
+add_subdirectory(tdbstore)
+add_subdirectory(filesystemstore)
 add_subdirectory(securestore)
+add_subdirectory(kv_config)
+add_subdirectory(direct_access_devicekey)
+add_subdirectory(kvstore_global_api)
 
 target_include_directories(mbed-storage-kvstore
     INTERFACE
         .
-        ./include
-        ./include/kvstore
-)
-
-target_sources(mbed-storage-kvstore
-    INTERFACE
-        source/FileSystemStore.cpp
-        source/KVMap.cpp
-        source/TDBStore.cpp
-        source/kvstore_global_api.cpp
-)
-
-target_link_libraries(mbed-storage-kvstore
-    INTERFACE
-        mbed-device_key
-        mbed-storage-blockdevice
-        mbed-storage-filesystem
-        mbed-storage-fat
-        mbed-storage-littlefs
-        mbed-storage-flashiap
-        mbed-storage-sd
+        include
+        include/kvstore
 )
diff --git a/storage/kvstore/direct_access_devicekey/CMakeLists.txt b/storage/kvstore/direct_access_devicekey/CMakeLists.txt
@@ -1,14 +1,20 @@
 # Copyright (c) 2020 ARM Limited. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 
-target_include_directories(mbed-storage-kvstore
+target_include_directories(mbed-storage-direct-access-devicekey
     INTERFACE
         .
-        ./include
-        ./include/direct_access_devicekey
+        include
+        include/direct_access_devicekey
 )
 
-target_sources(mbed-storage-kvstore
+target_sources(mbed-storage-direct-access-devicekey
     INTERFACE
         source/DirectAccessDevicekey.cpp
 )
+
+target_link_libraries(mbed-storage-direct-access-devicekey
+    INTERFACE
+        mbed-storage-kvstore
+        mbed-storage-kv-config
+)
diff --git a/...ESTS/direct_access_devicekey/tdb/main.cpp → ...ESTS/direct_access_devicekey/tdb/main.cpp b/...ESTS/direct_access_devicekey/tdb/main.cpp → ...ESTS/direct_access_devicekey/tdb/main.cpp
@@ -24,9 +24,9 @@
 #include <string.h>
 #include "DeviceKey.h"
 #include "kvstore/KVStore.h"
-#include "kvstore/KVMap.h"
+#include "kvstore_global_api/KVMap.h"
 #include "kv_config/kv_config.h"
-#include "kvstore/TDBStore.h"
+#include "tdbstore/TDBStore.h"
 #include "FlashIAP.h"
 #include "FlashIAPBlockDevice.h"
 #include "direct_access_devicekey/DirectAccessDevicekey.h"

diff --git a/storage/kvstore/filesystemstore/CMakeLists.txt b/storage/kvstore/filesystemstore/CMakeLists.txt
@@ -0,0 +1,21 @@
+# Copyright (c) 2020 ARM Limited. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+
+target_include_directories(mbed-storage-filesystemstore
+    INTERFACE
+        .
+        include
+        include/filesystemstore
+)
+
+target_sources(mbed-storage-filesystemstore
+    INTERFACE
+        source/FileSystemStore.cpp
+)
+
+target_link_libraries(mbed-storage-filesystemstore
+    INTERFACE
+        mbed-storage-kvstore
+        mbed-storage-filesystem
+        mbed-storage-kv-config
+)
diff --git a/...kvstore/include/kvstore/FileSystemStore.h → ...include/filesystemstore/FileSystemStore.h b/...kvstore/include/kvstore/FileSystemStore.h → ...include/filesystemstore/FileSystemStore.h
diff --git a/storage/kvstore/filesystemstore/mbed_lib.json b/storage/kvstore/filesystemstore/mbed_lib.json
@@ -0,0 +1,3 @@
+{
+    "name": "filesystemstore"
+}
diff --git a/storage/kvstore/source/FileSystemStore.cpp → ...ilesystemstore/source/FileSystemStore.cpp b/storage/kvstore/source/FileSystemStore.cpp → ...ilesystemstore/source/FileSystemStore.cpp
@@ -16,7 +16,7 @@
  * limitations under the License.
  */
 
-#include "kvstore/FileSystemStore.h"
+#include "filesystemstore/FileSystemStore.h"
 #include "kv_config/kv_config.h"
 #include "filesystem/Dir.h"
 #include "filesystem/File.h"

diff --git a/...TS/kvstore/filesystemstore_tests/main.cpp → ...ts/TESTS/filesystemstore/general/main.cpp b/...TS/kvstore/filesystemstore_tests/main.cpp → ...ts/TESTS/filesystemstore/general/main.cpp
diff --git a/storage/kvstore/tests/UNITTESTS/.mbedignore → ...lesystemstore/tests/UNITTESTS/.mbedignore b/storage/kvstore/tests/UNITTESTS/.mbedignore → ...lesystemstore/tests/UNITTESTS/.mbedignore
diff --git a/.../UNITTESTS/FileSystemStore/moduletest.cpp → .../UNITTESTS/FileSystemStore/moduletest.cpp b/.../UNITTESTS/FileSystemStore/moduletest.cpp → .../UNITTESTS/FileSystemStore/moduletest.cpp
@@ -16,7 +16,7 @@
 
 #include "gtest/gtest.h"
 #include "blockdevice/HeapBlockDevice.h"
-#include "kvstore/FileSystemStore.h"
+#include "filesystemstore/FileSystemStore.h"
 #include "littlefs/LittleFileSystem.h"
 #include "mbed_error.h"
 #include <stdlib.h>
@@ -34,7 +34,7 @@ class FileSystemStoreModuleTest : public testing::Test {
     virtual void SetUp()
     {
         fs = new LittleFileSystem("kvstore", &heap);
-        if(fs->mount(&heap) != MBED_SUCCESS) {
+        if (fs->mount(&heap) != MBED_SUCCESS) {
             EXPECT_EQ(fs->reformat(&heap), MBED_SUCCESS);
         }
         store = new FileSystemStore(fs);

diff --git a/.../UNITTESTS/FileSystemStore/unittest.cmake → .../UNITTESTS/FileSystemStore/unittest.cmake b/.../UNITTESTS/FileSystemStore/unittest.cmake → .../UNITTESTS/FileSystemStore/unittest.cmake
@@ -10,7 +10,7 @@ set(unittest-includes ${unittest-includes}
 
 set(unittest-sources
   ../storage/blockdevice/source/HeapBlockDevice.cpp
-  ../storage/kvstore/source/FileSystemStore.cpp
+  ../storage/kvstore/filesystemstore/source/FileSystemStore.cpp
   ../storage/filesystem/littlefs/source/LittleFileSystem.cpp
   ../storage/filesystem/source/Dir.cpp
   ../storage/filesystem/source/File.cpp

diff --git a/storage/kvstore/kv_config/CMakeLists.txt b/storage/kvstore/kv_config/CMakeLists.txt
@@ -1,14 +1,27 @@
 # Copyright (c) 2020 ARM Limited. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 
-target_include_directories(mbed-storage-kvstore
+target_include_directories(mbed-storage-kv-config
     INTERFACE
         .
-        ./include
-        ./include/kv_config
+        include
+        include/kv_config
 )
 
-target_sources(mbed-storage-kvstore
+target_sources(mbed-storage-kv-config
     INTERFACE
         source/kv_config.cpp
 )
+
+target_link_libraries(mbed-storage-kv-config
+    INTERFACE
+        mbed-storage-kvstore
+        mbed-storage-blockdevice
+        mbed-storage-tdbstore
+        mbed-storage-filesystemstore
+        mbed-storage-securestore
+        mbed-storage-littlefs
+        mbed-storage-fat
+        mbed-storage-flashiap
+        mbed-storage-sd
+)
diff --git a/storage/kvstore/kv_config/source/kv_config.cpp b/storage/kvstore/kv_config/source/kv_config.cpp
@@ -16,14 +16,14 @@
 
 #include "kv_config.h"
 #include "kvstore/KVStore.h"
-#include "kvstore/KVMap.h"
+#include "kvstore_global_api/KVMap.h"
 #include "blockdevice/BlockDevice.h"
 #include "filesystem/FileSystem.h"
-#include "kvstore/FileSystemStore.h"
+#include "filesystemstore/FileSystemStore.h"
 #include "blockdevice/SlicingBlockDevice.h"
 #include "fat/FATFileSystem.h"
 #include "littlefs/LittleFileSystem.h"
-#include "kvstore/TDBStore.h"
+#include "tdbstore/TDBStore.h"
 #include "mbed_error.h"
 #include "drivers/FlashIAP.h"
 #include "blockdevice/FlashSimBlockDevice.h"

diff --git a/storage/kvstore/kvstore_global_api/CMakeLists.txt b/storage/kvstore/kvstore_global_api/CMakeLists.txt
@@ -0,0 +1,23 @@
+# Copyright (c) 2020 ARM Limited. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+
+target_include_directories(mbed-storage-kv-global-api
+    INTERFACE
+        .
+        include
+        include/kvstore_global_api
+)
+
+target_sources(mbed-storage-kv-global-api
+    INTERFACE
+        source/KVMap.cpp
+        source/kvstore_global_api.cpp
+)
+
+target_link_libraries(mbed-storage-kv-global-api
+    INTERFACE
+        mbed-storage-kvstore
+        mbed-storage-kv-config
+        mbed-storage-blockdevice
+        mbed-storage-filesystem
+)
diff --git a/storage/kvstore/include/kvstore/KVMap.h → ...al_api/include/kvstore_global_api/KVMap.h b/storage/kvstore/include/kvstore/KVMap.h → ...al_api/include/kvstore_global_api/KVMap.h
diff --git a/...tore/include/kvstore/kvstore_global_api.h → ...e/kvstore_global_api/kvstore_global_api.h b/...tore/include/kvstore/kvstore_global_api.h → ...e/kvstore_global_api/kvstore_global_api.h
diff --git a/storage/kvstore/kvstore_global_api/mbed_lib.json b/storage/kvstore/kvstore_global_api/mbed_lib.json
@@ -0,0 +1,4 @@
+{
+    "name": "kv-global-api",
+    "requires": ["kvstore"]
+}
diff --git a/storage/kvstore/source/KVMap.cpp → ...store/kvstore_global_api/source/KVMap.cpp b/storage/kvstore/source/KVMap.cpp → ...store/kvstore_global_api/source/KVMap.cpp
@@ -15,7 +15,7 @@
  */
 
 #include "kvstore/KVStore.h"
-#include "kvstore/KVMap.h"
+#include "kvstore_global_api/KVMap.h"
 #include "kv_config/kv_config.h"
 #include <stdlib.h>
 #include "string.h"

diff --git a/...age/kvstore/source/kvstore_global_api.cpp → ..._global_api/source/kvstore_global_api.cpp b/...age/kvstore/source/kvstore_global_api.cpp → ..._global_api/source/kvstore_global_api.cpp
@@ -13,10 +13,10 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-#include "kvstore_global_api.h"
+#include "kvstore_global_api/kvstore_global_api.h"
 
 #include "kv_config/kv_config.h"
-#include "kvstore/KVMap.h"
+#include "kvstore_global_api/KVMap.h"
 #include "kvstore/KVStore.h"
 #include "mbed_error.h"
 

diff --git a/storage/kvstore/mbed_lib.json b/storage/kvstore/mbed_lib.json
@@ -1,3 +1,3 @@
 {
-    "name": "kv-global-api"
+    "name": "kvstore"
 }
diff --git a/storage/kvstore/securestore/CMakeLists.txt b/storage/kvstore/securestore/CMakeLists.txt
@@ -1,14 +1,20 @@
 # Copyright (c) 2020 ARM Limited. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 
-target_include_directories(mbed-storage-kvstore
+target_include_directories(mbed-storage-securestore
     INTERFACE
         .
-        ./include
-        ./include/securestore
+        include
+        include/securestore
 )
 
-target_sources(mbed-storage-kvstore
+target_sources(mbed-storage-securestore
     INTERFACE
         source/SecureStore.cpp
 )
+
+target_link_libraries(mbed-storage-securestore
+    INTERFACE
+        mbed-storage-kvstore
+        mbed-device_key
+)
diff --git a/...tests/TESTS/securestore/whitebox/main.cpp → ...tests/TESTS/securestore/whitebox/main.cpp b/...tests/TESTS/securestore/whitebox/main.cpp → ...tests/TESTS/securestore/whitebox/main.cpp
@@ -17,7 +17,7 @@
 */
 
 #include "securestore/SecureStore.h"
-#include "kvstore/TDBStore.h"
+#include "tdbstore/TDBStore.h"
 #ifdef MBED_CONF_RTOS_PRESENT
 #include "Thread.h"
 #endif

diff --git a/storage/kvstore/tdbstore/CMakeLists.txt b/storage/kvstore/tdbstore/CMakeLists.txt
@@ -0,0 +1,20 @@
+# Copyright (c) 2020 ARM Limited. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+
+target_include_directories(mbed-storage-tdbstore
+    INTERFACE
+        .
+        include
+        include/tdbstore
+)
+
+target_sources(mbed-storage-tdbstore
+    INTERFACE
+        source/TDBStore.cpp
+)
+
+target_link_libraries(mbed-storage-tdbstore
+    INTERFACE
+        mbed-storage-kvstore
+        mbed-storage-blockdevice
+)
diff --git a/storage/kvstore/include/kvstore/TDBStore.h → ...tore/tdbstore/include/tdbstore/TDBStore.h b/storage/kvstore/include/kvstore/TDBStore.h → ...tore/tdbstore/include/tdbstore/TDBStore.h
diff --git a/storage/kvstore/tdbstore/mbed_lib.json b/storage/kvstore/tdbstore/mbed_lib.json
@@ -0,0 +1,3 @@
+{
+    "name": "tdbstore"
+}
diff --git a/storage/kvstore/source/TDBStore.cpp → storage/kvstore/tdbstore/source/TDBStore.cpp b/storage/kvstore/source/TDBStore.cpp → storage/kvstore/tdbstore/source/TDBStore.cpp
@@ -16,7 +16,7 @@
 
 // ----------------------------------------------------------- Includes -----------------------------------------------------------
 
-#include "kvstore/TDBStore.h"
+#include "tdbstore/TDBStore.h"
 
 #include <algorithm>
 #include <string.h>

diff --git a/.../TESTS/kvstore/tdbstore_whitebox/main.cpp → ...re/tests/TESTS/tdbstore/whitebox/main.cpp b/.../TESTS/kvstore/tdbstore_whitebox/main.cpp → ...re/tests/TESTS/tdbstore/whitebox/main.cpp
diff --git a/storage/kvstore/tdbstore/tests/UNITTESTS/.mbedignore b/storage/kvstore/tdbstore/tests/UNITTESTS/.mbedignore
@@ -0,0 +1 @@
+*