Merge pull request #5177 from rdkcentral/DELIA-65017

DELIA-65017 : Out-of-process improvements to PersistentStore

.github/workflows/L2-PersistentStore-grpc.yml

@@ -27,3 +27,9 @@ jobs:
         run: |
           cmake -S ${GITHUB_REPOSITORY}/PersistentStore/grpc/l2test -B build/grpcl2test -DCMAKE_INSTALL_PREFIX="install/usr" -DCMAKE_CXX_FLAGS="-Wall -Werror"
           cmake --build build/grpcl2test --target install
+
+# (Optional)
+# Rebuild with real token (here: kToken = "Bearer TOKEN"):
+# cmake --build build/grpcl2test --target install
+# Run:
+# PATH=${PWD}/install/usr/bin:${PATH} LD_LIBRARY_PATH=${PWD}/install/usr/lib:${LD_LIBRARY_PATH} valgrind --tool=memcheck --log-file=valgrind_log --leak-check=yes --show-reachable=yes --track-fds=yes --fair-sched=try grpcl2test

.github/workflows/L2-PersistentStore.yml

@@ -0,0 +1,45 @@
+name: L2-PersistentStore
+
+on:
+  push:
+    paths:
+      - PersistentStore/**
+  pull_request:
+    paths:
+      - PersistentStore/**
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          path: ${{github.repository}}
+
+      - name: Install cmake, sqlite, protoc, grpc_cpp_plugin, grpc
+        run: |
+          sudo apt update
+          sudo apt install -y cmake libsqlite3-dev protobuf-compiler protobuf-compiler-grpc libgrpc++-dev
+
+      - name: Build Thunder
+        working-directory: ${{github.workspace}}
+        run: sh +x ${GITHUB_REPOSITORY}/.github/workflows/BuildThunder.sh
+
+      - name: Build
+        working-directory: ${{github.workspace}}
+        run: |
+          cmake -S ${GITHUB_REPOSITORY}/PersistentStore -B build/PersistentStore -DCMAKE_INSTALL_PREFIX="install/usr" -DCMAKE_CXX_FLAGS="-Wall -Werror" -DPLUGIN_PERSISTENTSTORE_PATH="/tmp/persistentstore/l2test/test"
+          cmake --build build/PersistentStore --target install
+
+# (Optional)
+# Thunder startup:
+# PATH=${PWD}/install/usr/bin:${PATH} LD_LIBRARY_PATH=${PWD}/install/usr/lib:${LD_LIBRARY_PATH} valgrind --tool=memcheck --log-file=valgrind_log --leak-check=yes --show-reachable=yes --track-fds=yes --fair-sched=try WPEFramework -f -c ${PWD}/install/etc/WPEFramework/config.json
+# (to stop press q & enter)
+# API test:
+# curl -d '{"jsonrpc":"2.0","id":0,"method":"org.rdk.PersistentStore.setValue","params":{"namespace":"test","key":"key1","value":"1","ttl":100}}' http://localhost:55555/jsonrpc
+# curl -d '{"jsonrpc":"2.0","id":0,"method":"org.rdk.PersistentStore.getValue","params":{"namespace":"test","key":"key1"}}' http://localhost:55555/jsonrpc
+# Crash test:
+# kill -SIGFPE $(pidof WPEProcess)
+# Deactivate test:
+# curl -d '{"jsonrpc":"2.0","id":0,"method":"Controller.1.deactivate", "params":{"callsign":"org.rdk.PersistentStore"}}' http://localhost:55555/jsonrpc

PersistentStore/CMakeLists.txt

@@ -61,8 +61,8 @@ install(TARGETS ${MODULE_NAME}
 
 set(PLUGIN_IMPLEMENTATION ${MODULE_NAME}Implementation)
 add_library(${PLUGIN_IMPLEMENTATION} SHARED
-        sqlite/Store2.cpp
         Module.cpp
+        PersistentStoreImplementation.cpp
 )
 
 target_link_libraries(${PLUGIN_IMPLEMENTATION} PRIVATE
@@ -84,7 +84,6 @@ if (IARMBUS_LIBRARIES)
 endif ()
 
 if (PLUGIN_PERSISTENTSTORE_WITH_ACCOUNT_SCOPE)
-    target_sources(${PLUGIN_IMPLEMENTATION} PRIVATE grpc/Store2.cpp)
     find_package(Protobuf REQUIRED)
     target_link_libraries(${PLUGIN_IMPLEMENTATION} PRIVATE ${Protobuf_LIBRARIES})
 

PersistentStore/PersistentStore.cpp

@@ -51,8 +51,20 @@ namespace Plugin {
         string result;
 
         ASSERT(service != nullptr);
+        ASSERT(_store == nullptr);
+        ASSERT(_store2 == nullptr);
+        ASSERT(_storeCache == nullptr);
+        ASSERT(_storeInspector == nullptr);
+        ASSERT(_storeLimit == nullptr);
+        ASSERT(_service == nullptr);
+        ASSERT(_connectionId == 0);
 
-        auto configLine = service->ConfigLine();
+        SYSLOG(Logging::Startup, (_T("PersistentStore::Initialize: PID=%u"), getpid()));
+
+        _service = service;
+        _service->AddRef();
+
+        auto configLine = _service->ConfigLine();
         _config.FromString(configLine);
 
         {
@@ -91,50 +103,70 @@ namespace Plugin {
         Core::SystemInfo::SetEnvironment(MAXVALUE_ENV, std::to_string(_config.MaxValue.Value()));
         Core::SystemInfo::SetEnvironment(LIMIT_ENV, std::to_string(_config.Limit.Value()));
 
-        uint32_t connectionId;
+        _service->Register(&_notification);
 
-        _deviceStore2 = service->Root<Exchange::IStore2>(connectionId, RPC::CommunicationTimeOut, _T("SqliteStore2"));
-        if (_deviceStore2 != nullptr) {
-            _deviceStore2->Register(&_store2Sink);
-            _deviceStore2->Register(_store);
-            _deviceStoreCache = _deviceStore2->QueryInterface<Exchange::IStoreCache>();
-            _deviceStoreInspector = _deviceStore2->QueryInterface<Exchange::IStoreInspector>();
-            _deviceStoreLimit = _deviceStore2->QueryInterface<Exchange::IStoreLimit>();
-        }
-
-        _accountStore2 = service->Root<Exchange::IStore2>(connectionId, RPC::CommunicationTimeOut, _T("GrpcStore2"));
-        if (_accountStore2 != nullptr) {
-            _accountStore2->Register(&_store2Sink);
+        _store = _service->Root<Exchange::IStore>(_connectionId, RPC::CommunicationTimeOut, _T("PersistentStoreImplementation"));
+        if (_store != nullptr) {
+            _store2 = _store->QueryInterface<Exchange::IStore2>();
+            if (_store2 != nullptr) {
+                _store2->Register(&_store2Sink);
+            }
+            _storeCache = _store->QueryInterface<Exchange::IStoreCache>();
+            _storeInspector = _store->QueryInterface<Exchange::IStoreInspector>();
+            _storeLimit = _store->QueryInterface<Exchange::IStoreLimit>();
+
+            ASSERT(_store2 != nullptr);
+            ASSERT(_storeCache != nullptr);
+            ASSERT(_storeInspector != nullptr);
+            ASSERT(_storeLimit != nullptr);
+        } else {
+            result = _T("Couldn't create implementation instance");
         }
 
         return result;
     }
 
-    void PersistentStore::Deinitialize(PluginHost::IShell* /* service */)
+    void PersistentStore::Deinitialize(PluginHost::IShell* service)
     {
-        if (_deviceStore2 != nullptr) {
-            _deviceStore2->Unregister(&_store2Sink);
-            _deviceStore2->Unregister(_store);
-            _deviceStore2->Release();
-            _deviceStore2 = nullptr;
-        }
-        if (_deviceStoreCache != nullptr) {
-            _deviceStoreCache->Release();
-            _deviceStoreCache = nullptr;
-        }
-        if (_deviceStoreInspector != nullptr) {
-            _deviceStoreInspector->Release();
-            _deviceStoreInspector = nullptr;
-        }
-        if (_deviceStoreLimit != nullptr) {
-            _deviceStoreLimit->Release();
-            _deviceStoreLimit = nullptr;
-        }
-        if (_accountStore2 != nullptr) {
-            _accountStore2->Unregister(&_store2Sink);
-            _accountStore2->Release();
-            _accountStore2 = nullptr;
+        ASSERT(_service == service);
+
+        SYSLOG(Logging::Shutdown, (string(_T("DTV::Deinitialize"))));
+
+        _service->Unregister(&_notification);
+
+        if (_store != nullptr) {
+            if (_store2 != nullptr) {
+                _store2->Unregister(&_store2Sink);
+                _store2->Release();
+                _store2 = nullptr;
+            }
+            if (_storeCache != nullptr) {
+                _storeCache->Release();
+                _storeCache = nullptr;
+            }
+            if (_storeInspector != nullptr) {
+                _storeInspector->Release();
+                _storeInspector = nullptr;
+            }
+            if (_storeLimit != nullptr) {
+                _storeLimit->Release();
+                _storeLimit = nullptr;
+            }
+
+            auto connection = _service->RemoteConnection(_connectionId);
+            VARIABLE_IS_NOT_USED auto result = _store->Release();
+            _store = nullptr;
+            ASSERT(result == Core::ERROR_DESTRUCTION_SUCCEEDED);
+            if (connection != nullptr) {
+                connection->Terminate();
+                connection->Release();
+            }
         }
+
+        _connectionId = 0;
+        _service->Release();
+        _service = nullptr;
+        SYSLOG(Logging::Shutdown, (string(_T("PersistentStore de-initialised"))));
     }
 
     string PersistentStore::Information() const