[chip-tool] Support LIT ICD in chip-tool for subscriptions (#31576)

erjiaqing · web-flow · commit 219c3f0d592a · 2024-01-31T07:59:41.000Z
diff --git a/examples/chip-tool/commands/clusters/ModelCommand.cpp b/examples/chip-tool/commands/clusters/ModelCommand.cpp
@@ -19,6 +19,7 @@
 #include "ModelCommand.h"
 
 #include <app/InteractionModelEngine.h>
+#include <app/icd/client/DefaultICDClientStorage.h>
 #include <inttypes.h>
 
 using namespace ::chip;
@@ -35,6 +36,7 @@ CHIP_ERROR ModelCommand::RunCommand()
     }
 
     ChipLogProgress(chipTool, "Sending command to node 0x%" PRIx64, mDestinationId);
+    CheckPeerICDType();
 
     CommissioneeDeviceProxy * commissioneeDeviceProxy = nullptr;
     if (CHIP_NO_ERROR == CurrentCommissioner().GetDeviceBeingCommissioned(mDestinationId, &commissioneeDeviceProxy))
@@ -73,3 +75,31 @@ void ModelCommand::Shutdown()
 
     CHIPCommand::Shutdown();
 }
+
+void ModelCommand::CheckPeerICDType()
+{
+    if (mIsPeerLIT.HasValue())
+    {
+        ChipLogProgress(chipTool, "Peer ICD type is set to %s", mIsPeerLIT.Value() == 1 ? "LIT-ICD" : "non LIT-ICD");
+        return;
+    }
+
+    app::ICDClientInfo info;
+    auto destinationPeerId = chip::ScopedNodeId(mDestinationId, CurrentCommissioner().GetFabricIndex());
+    auto iter              = CHIPCommand::sICDClientStorage.IterateICDClientInfo();
+    if (iter == nullptr)
+    {
+        return;
+    }
+    app::DefaultICDClientStorage::ICDClientInfoIteratorWrapper clientInfoIteratorWrapper(iter);
+
+    while (iter->Next(info))
+    {
+        if (ScopedNodeId(info.peer_node.GetNodeId(), info.peer_node.GetFabricIndex()) == destinationPeerId)
+        {
+            ChipLogProgress(chipTool, "Peer is a registered LIT ICD.");
+            mIsPeerLIT.SetValue(true);
+            return;
+        }
+    }
+}
diff --git a/examples/chip-tool/commands/clusters/ModelCommand.h b/examples/chip-tool/commands/clusters/ModelCommand.h
@@ -52,6 +52,10 @@ class ModelCommand : public CHIPCommand
                             "Endpoint the command is targeted at.");
             }
         }
+        AddArgument(
+            "lit-icd-peer", 0, 1, &mIsPeerLIT,
+            "Whether to treat the peer as a LIT ICD. false: Always no, true: Always yes, (not set): Yes if the peer is registered "
+            "to this controller.");
         AddArgument("timeout", 0, UINT16_MAX, &mTimeout);
     }
 
@@ -66,11 +70,16 @@ class ModelCommand : public CHIPCommand
     void Shutdown() override;
 
 protected:
+    bool IsPeerLIT() { return mIsPeerLIT.ValueOr(false); }
+
     chip::Optional<uint16_t> mTimeout;
 
 private:
     chip::NodeId mDestinationId;
     std::vector<chip::EndpointId> mEndPointId;
+    chip::Optional<bool> mIsPeerLIT;
+
+    void CheckPeerICDType();
 
     static void OnDeviceConnectedFn(void * context, chip::Messaging::ExchangeManager & exchangeMgr,
                                     const chip::SessionHandle & sessionHandle);
diff --git a/examples/chip-tool/commands/clusters/ReportCommand.h b/examples/chip-tool/commands/clusters/ReportCommand.h
@@ -277,6 +277,7 @@ class SubscribeAttribute : public SubscribeCommand
 
     CHIP_ERROR SendCommand(chip::DeviceProxy * device, std::vector<chip::EndpointId> endpointIds) override
     {
+        SubscribeCommand::SetPeerLIT(IsPeerLIT());
         return SubscribeCommand::SubscribeAttribute(device, endpointIds, mClusterIds, mAttributeIds);
     }
 
@@ -407,6 +408,7 @@ class SubscribeEvent : public SubscribeCommand
 
     CHIP_ERROR SendCommand(chip::DeviceProxy * device, std::vector<chip::EndpointId> endpointIds) override
     {
+        SubscribeCommand::SetPeerLIT(IsPeerLIT());
         return SubscribeCommand::SubscribeEvent(device, endpointIds, mClusterIds, mEventIds);
     }
 
@@ -538,6 +540,7 @@ class SubscribeAll : public SubscribeCommand
 
     CHIP_ERROR SendCommand(chip::DeviceProxy * device, std::vector<chip::EndpointId> endpointIds) override
     {
+        SubscribeCommand::SetPeerLIT(IsPeerLIT());
         return SubscribeCommand::SubscribeAll(device, endpointIds, mClusterIds, mAttributeIds, mEventIds);
     }
 
diff --git a/examples/chip-tool/commands/icd/ICDCommand.cpp b/examples/chip-tool/commands/icd/ICDCommand.cpp
@@ -18,6 +18,7 @@
 
 #include "ICDCommand.h"
 
+#include <app/icd/client/DefaultICDClientStorage.h>
 #include <crypto/DefaultSessionKeystore.h>
 #include <crypto/RawKeySessionKeystore.h>
 
@@ -29,6 +30,11 @@ CHIP_ERROR ICDListCommand::RunCommand()
     auto iter = CHIPCommand::sICDClientStorage.IterateICDClientInfo();
     char icdAesKeyHex[Crypto::kAES_CCM128_Key_Length * 2 + 1];
     char icdHmacKeyHex[Crypto::kHMAC_CCM128_Key_Length * 2 + 1];
+    if (iter == nullptr)
+    {
+        return CHIP_ERROR_NO_MEMORY;
+    }
+    app::DefaultICDClientStorage::ICDClientInfoIteratorWrapper clientInfoIteratorWrapper(iter);
     fprintf(stderr, "  +-----------------------------------------------------------------------------+\n");
     fprintf(stderr, "  | %-75s |\n", "Known ICDs:");
     fprintf(stderr, "  +-----------------------------------------------------------------------------+\n");
@@ -54,8 +60,6 @@ CHIP_ERROR ICDListCommand::RunCommand()
     }
 
     fprintf(stderr, "  +-----------------------------------------------------------------------------+\n");
-
-    iter->Release();
     SetCommandExitStatus(CHIP_NO_ERROR);
     return CHIP_NO_ERROR;
 }
diff --git a/src/app/icd/client/DefaultICDClientStorage.h b/src/app/icd/client/DefaultICDClientStorage.h
@@ -53,6 +53,28 @@ class DefaultICDClientStorage : public ICDClientStorage
 public:
     using ICDClientInfoIterator = CommonIterator<ICDClientInfo>;
 
+    // ICDClientInfoIterator wrapper to release ICDClientInfoIterator when it is out of scope
+    class ICDClientInfoIteratorWrapper
+    {
+    public:
+        ICDClientInfoIteratorWrapper(ICDClientInfoIterator * apICDClientInfoIterator)
+        {
+            mpICDClientInfoIterator = apICDClientInfoIterator;
+        }
+
+        ~ICDClientInfoIteratorWrapper()
+        {
+            if (mpICDClientInfoIterator != nullptr)
+            {
+                mpICDClientInfoIterator->Release();
+                mpICDClientInfoIterator = nullptr;
+            }
+        }
+
+    private:
+        ICDClientInfoIterator * mpICDClientInfoIterator = nullptr;
+    };
+
     static constexpr size_t kIteratorsMax = CHIP_CONFIG_MAX_ICD_CLIENTS_INFO_STORAGE_CONCURRENT_ITERATORS;
 
     CHIP_ERROR Init(PersistentStorageDelegate * clientInfoStore, Crypto::SymmetricKeystore * keyStore);
diff --git a/src/app/tests/TestDefaultICDClientStorage.cpp b/src/app/tests/TestDefaultICDClientStorage.cpp
@@ -179,6 +179,8 @@ void TestClientInfoCountMultipleFabric(nlTestSuite * apSuite, void * apContext)
     err = manager.DeleteEntry(ScopedNodeId(nodeId1, fabricId1));
     NL_TEST_ASSERT(apSuite, err == CHIP_NO_ERROR);
     iterator = manager.IterateICDClientInfo();
+    NL_TEST_ASSERT(apSuite, iterator != nullptr);
+    DefaultICDClientStorage::ICDClientInfoIteratorWrapper clientInfoIteratorWrapper(iterator);
     NL_TEST_ASSERT(apSuite, iterator->Count() == 2);
 
     err = manager.DeleteEntry(ScopedNodeId(nodeId2, fabricId1));
@@ -196,7 +198,7 @@ void TestClientInfoCountMultipleFabric(nlTestSuite * apSuite, void * apContext)
     {
         count++;
     }
-    iterator->Release();
+
     NL_TEST_ASSERT(apSuite, count == 0);
 }
 
diff --git a/src/app/tests/suites/commands/interaction_model/InteractionModel.cpp b/src/app/tests/suites/commands/interaction_model/InteractionModel.cpp
@@ -350,6 +350,7 @@ CHIP_ERROR InteractionModelReports::ReportAttribute(DeviceProxy * device, std::v
         {
             params.mKeepSubscriptions = mKeepSubscriptions.Value();
         }
+        params.mIsPeerLIT = mIsPeerLIT;
     }
 
     auto client = std::make_unique<ReadClient>(InteractionModelEngine::GetInstance(), device->GetExchangeManager(),
@@ -479,6 +480,7 @@ CHIP_ERROR InteractionModelReports::ReportEvent(DeviceProxy * device, std::vecto
         {
             params.mKeepSubscriptions = mKeepSubscriptions.Value();
         }
+        params.mIsPeerLIT = mIsPeerLIT;
     }
 
     auto client = std::make_unique<ReadClient>(InteractionModelEngine::GetInstance(), device->GetExchangeManager(),
@@ -652,6 +654,7 @@ CHIP_ERROR InteractionModelReports::ReportAll(chip::DeviceProxy * device, std::v
         {
             params.mKeepSubscriptions = mKeepSubscriptions.Value();
         }
+        params.mIsPeerLIT = mIsPeerLIT;
     }
 
     auto client = std::make_unique<ReadClient>(InteractionModelEngine::GetInstance(), device->GetExchangeManager(),
diff --git a/src/app/tests/suites/commands/interaction_model/InteractionModel.h b/src/app/tests/suites/commands/interaction_model/InteractionModel.h
@@ -205,6 +205,12 @@ class InteractionModelReports
         return *this;
     }
 
+    InteractionModelReports & SetPeerLIT(bool isPeerLIT)
+    {
+        mIsPeerLIT = isPeerLIT;
+        return *this;
+    }
+
     void ResetOptions()
     {
         mDataVersions      = chip::NullOptional;
@@ -213,6 +219,7 @@ class InteractionModelReports
         mFabricFiltered    = chip::Optional<bool>(true);
         mKeepSubscriptions = chip::NullOptional;
         mAutoResubscribe   = chip::NullOptional;
+        mIsPeerLIT         = false;
         mMinInterval       = 0;
         mMaxInterval       = 0;
     }
@@ -223,6 +230,7 @@ class InteractionModelReports
     chip::Optional<bool> mFabricFiltered;
     chip::Optional<bool> mKeepSubscriptions;
     chip::Optional<bool> mAutoResubscribe;
+    bool mIsPeerLIT;
     uint16_t mMinInterval;
     uint16_t mMaxInterval;
 };
diff --git a/src/controller/java/CHIPDeviceController-JNI.cpp b/src/controller/java/CHIPDeviceController-JNI.cpp
@@ -2176,6 +2176,8 @@ JNI_METHOD(jobject, getICDClientInfo)(JNIEnv * env, jobject self, jlong handle,
                         ChipLogError(Controller, "CreateArrayList failed!: %" CHIP_ERROR_FORMAT, err.Format()));
 
     auto iter = wrapper->getICDClientStorage()->IterateICDClientInfo();
+    VerifyOrReturnValue(iter != nullptr, nullptr, ChipLogError(Controller, "IterateICDClientInfo failed!"));
+    app::DefaultICDClientStorage::ICDClientInfoIteratorWrapper clientInfoIteratorWrapper(iter);
 
     jmethodID constructor;
     jclass infoClass;
@@ -2219,8 +2221,6 @@ JNI_METHOD(jobject, getICDClientInfo)(JNIEnv * env, jobject self, jlong handle,
                             ChipLogError(Controller, "AddToList error!: %" CHIP_ERROR_FORMAT, err.Format()));
     }
 
-    iter->Release();
-
     return jInfo;
 }
 

Original file line number	Diff line number	Diff line change
`@@ -277,6 +277,7 @@ class SubscribeAttribute : public SubscribeCommand`
`277`	`277`
`278`	`278`	`CHIP_ERROR SendCommand(chip::DeviceProxy * device, std::vector<chip::EndpointId> endpointIds) override`
`279`	`279`	`{`
	`280`	`+ SubscribeCommand::SetPeerLIT(IsPeerLIT());`
`280`	`281`	`return SubscribeCommand::SubscribeAttribute(device, endpointIds, mClusterIds, mAttributeIds);`
`281`	`282`	`}`
`282`	`283`
`@@ -407,6 +408,7 @@ class SubscribeEvent : public SubscribeCommand`
`407`	`408`
`408`	`409`	`CHIP_ERROR SendCommand(chip::DeviceProxy * device, std::vector<chip::EndpointId> endpointIds) override`
`409`	`410`	`{`
	`411`	`+ SubscribeCommand::SetPeerLIT(IsPeerLIT());`
`410`	`412`	`return SubscribeCommand::SubscribeEvent(device, endpointIds, mClusterIds, mEventIds);`
`411`	`413`	`}`
`412`	`414`
`@@ -538,6 +540,7 @@ class SubscribeAll : public SubscribeCommand`
`538`	`540`
`539`	`541`	`CHIP_ERROR SendCommand(chip::DeviceProxy * device, std::vector<chip::EndpointId> endpointIds) override`
`540`	`542`	`{`
	`543`	`+ SubscribeCommand::SetPeerLIT(IsPeerLIT());`
`541`	`544`	`return SubscribeCommand::SubscribeAll(device, endpointIds, mClusterIds, mAttributeIds, mEventIds);`
`542`	`545`	`}`
`543`	`546`
Original file line number	Diff line number	Diff line change
`@@ -179,6 +179,8 @@ void TestClientInfoCountMultipleFabric(nlTestSuite * apSuite, void * apContext)`
`179`	`179`	`err = manager.DeleteEntry(ScopedNodeId(nodeId1, fabricId1));`
`180`	`180`	`NL_TEST_ASSERT(apSuite, err == CHIP_NO_ERROR);`
`181`	`181`	`iterator = manager.IterateICDClientInfo();`
	`182`	`+ NL_TEST_ASSERT(apSuite, iterator != nullptr);`
	`183`	`+ DefaultICDClientStorage::ICDClientInfoIteratorWrapper clientInfoIteratorWrapper(iterator);`
`182`	`184`	`NL_TEST_ASSERT(apSuite, iterator->Count() == 2);`
`183`	`185`
`184`	`186`	`err = manager.DeleteEntry(ScopedNodeId(nodeId2, fabricId1));`
`@@ -196,7 +198,7 @@ void TestClientInfoCountMultipleFabric(nlTestSuite * apSuite, void * apContext)`
`196`	`198`	`{`
`197`	`199`	`count++;`
`198`	`200`	`}`
`199`		`- iterator->Release();`
	`201`	`+`
`200`	`202`	`NL_TEST_ASSERT(apSuite, count == 0);`
`201`	`203`	`}`
`202`	`204`
Original file line number	Diff line number	Diff line change
`@@ -350,6 +350,7 @@ CHIP_ERROR InteractionModelReports::ReportAttribute(DeviceProxy * device, std::v`
`350`	`350`	`{`
`351`	`351`	`params.mKeepSubscriptions = mKeepSubscriptions.Value();`
`352`	`352`	`}`
	`353`	`+ params.mIsPeerLIT = mIsPeerLIT;`
`353`	`354`	`}`
`354`	`355`
`355`	`356`	`auto client = std::make_unique<ReadClient>(InteractionModelEngine::GetInstance(), device->GetExchangeManager(),`
`@@ -479,6 +480,7 @@ CHIP_ERROR InteractionModelReports::ReportEvent(DeviceProxy * device, std::vecto`
`479`	`480`	`{`
`480`	`481`	`params.mKeepSubscriptions = mKeepSubscriptions.Value();`
`481`	`482`	`}`
	`483`	`+ params.mIsPeerLIT = mIsPeerLIT;`
`482`	`484`	`}`
`483`	`485`
`484`	`486`	`auto client = std::make_unique<ReadClient>(InteractionModelEngine::GetInstance(), device->GetExchangeManager(),`
`@@ -652,6 +654,7 @@ CHIP_ERROR InteractionModelReports::ReportAll(chip::DeviceProxy * device, std::v`
`652`	`654`	`{`
`653`	`655`	`params.mKeepSubscriptions = mKeepSubscriptions.Value();`
`654`	`656`	`}`
	`657`	`+ params.mIsPeerLIT = mIsPeerLIT;`
`655`	`658`	`}`
`656`	`659`
`657`	`660`	`auto client = std::make_unique<ReadClient>(InteractionModelEngine::GetInstance(), device->GetExchangeManager(),`
Original file line number	Diff line number	Diff line change
`@@ -2176,6 +2176,8 @@ JNI_METHOD(jobject, getICDClientInfo)(JNIEnv * env, jobject self, jlong handle,`
`2176`	`2176`	`ChipLogError(Controller, "CreateArrayList failed!: %" CHIP_ERROR_FORMAT, err.Format()));`
`2177`	`2177`
`2178`	`2178`	`auto iter = wrapper->getICDClientStorage()->IterateICDClientInfo();`
	`2179`	`+ VerifyOrReturnValue(iter != nullptr, nullptr, ChipLogError(Controller, "IterateICDClientInfo failed!"));`
	`2180`	`+ app::DefaultICDClientStorage::ICDClientInfoIteratorWrapper clientInfoIteratorWrapper(iter);`
`2179`	`2181`
`2180`	`2182`	`jmethodID constructor;`
`2181`	`2183`	`jclass infoClass;`
`@@ -2219,8 +2221,6 @@ JNI_METHOD(jobject, getICDClientInfo)(JNIEnv * env, jobject self, jlong handle,`
`2219`	`2221`	`ChipLogError(Controller, "AddToList error!: %" CHIP_ERROR_FORMAT, err.Format()));`
`2220`	`2222`	`}`
`2221`	`2223`
`2222`		`- iter->Release();`
`2223`		`-`
`2224`	`2224`	`return jInfo;`
`2225`	`2225`	`}`
`2226`	`2226`