Replaced the use of std::set with IntrusiveList in ModeBase. (#28163)

* Replaced the use of std::set with IntrusiveList in ModeBase.

* Removed the std::set exeption for ModeBase.

* Restyled by clang-format

* Refoctor from review.

* Added a way to gracefully shutdown the ModeBase dreived clusters and used it in the linux all-clusters-app.

* Restyled by whitespace

* Restyled by clang-format

* Implemented required ApplicationExit().

* Restyled by clang-format

* Modified the ModeBase example shutdowns to be safe if Shutdown is called twice and properly free the memory.

* Renamed ApplicationExit() to ApplicationShutdown()

* Apply documentation suggestions from code review

Co-authored-by: Boris Zbarsky <[email protected]>

---------

Co-authored-by: Restyled.io <[email protected]>
Co-authored-by: Boris Zbarsky <[email protected]>

examples/all-clusters-app/all-clusters-common/include/dishwasher-mode.h

@@ -69,6 +69,8 @@ class DishwasherModeDelegate : public ModeBase::Delegate
     ~DishwasherModeDelegate() override = default;
 };
 
+void Shutdown();
+
 } // namespace DishwasherMode
 
 } // namespace Clusters

examples/all-clusters-app/all-clusters-common/include/laundry-washer-mode.h

@@ -74,6 +74,8 @@ class LaundryWasherModeDelegate : public ModeBase::Delegate
     ~LaundryWasherModeDelegate() override = default;
 };
 
+void Shutdown();
+
 } // namespace LaundryWasherMode
 
 } // namespace Clusters

examples/all-clusters-app/all-clusters-common/include/rvc-modes.h

@@ -66,6 +66,8 @@ class RvcRunModeDelegate : public ModeBase::Delegate
     ~RvcRunModeDelegate() override = default;
 };
 
+void Shutdown();
+
 } // namespace RvcRunMode
 
 namespace RvcCleanMode {
@@ -107,6 +109,8 @@ class RvcCleanModeDelegate : public ModeBase::Delegate
     ~RvcCleanModeDelegate() override = default;
 };
 
+void Shutdown();
+
 } // namespace RvcCleanMode
 
 } // namespace Clusters

examples/all-clusters-app/all-clusters-common/include/tcc-mode.h

@@ -67,6 +67,8 @@ class TccModeDelegate : public ModeBase::Delegate
     ~TccModeDelegate() override = default;
 };
 
+void Shutdown();
+
 } // namespace RefrigeratorAndTemperatureControlledCabinetMode
 
 } // namespace Clusters

examples/all-clusters-app/all-clusters-common/src/dishwasher-mode.cpp

@@ -76,12 +76,24 @@ CHIP_ERROR DishwasherModeDelegate::GetModeTagsByIndex(uint8_t modeIndex, List<Mo
     return CHIP_NO_ERROR;
 }
 
+void DishwasherMode::Shutdown()
+{
+    if (gDishwasherModeInstance != nullptr)
+    {
+        delete gDishwasherModeInstance;
+        gDishwasherModeInstance = nullptr;
+    }
+    if (gDishwasherModeDelegate != nullptr)
+    {
+        gDishwasherModeDelegate->~DishwasherModeDelegate();
+    }
+}
+
 void emberAfDishwasherModeClusterInitCallback(chip::EndpointId endpointId)
 {
     VerifyOrDie(endpointId == 1); // this cluster is only enabled for endpoint 1.
     VerifyOrDie(gDishwasherModeDelegate == nullptr && gDishwasherModeInstance == nullptr);
     gDishwasherModeDelegate = new DishwasherMode::DishwasherModeDelegate;
-    // todo use Clusters::XxxMode::Feature::kXxxx to set features.
     gDishwasherModeInstance =
         new ModeBase::Instance(gDishwasherModeDelegate, 0x1, DishwasherMode::Id, chip::to_underlying(Feature::kOnOff));
     gDishwasherModeInstance->Init();

examples/all-clusters-app/all-clusters-common/src/laundry-washer-mode.cpp

@@ -75,6 +75,19 @@ CHIP_ERROR LaundryWasherModeDelegate::GetModeTagsByIndex(uint8_t modeIndex, List
     return CHIP_NO_ERROR;
 }
 
+void LaundryWasherMode::Shutdown()
+{
+    if (gLaundryWasherModeInstance != nullptr)
+    {
+        delete gLaundryWasherModeInstance;
+        gLaundryWasherModeInstance = nullptr;
+    }
+    if (gLaundryWasherModeDelegate != nullptr)
+    {
+        gLaundryWasherModeDelegate->~LaundryWasherModeDelegate();
+    }
+}
+
 void emberAfLaundryWasherModeClusterInitCallback(chip::EndpointId endpointId)
 {
     VerifyOrDie(endpointId == 1); // this cluster is only enabled for endpoint 1.

examples/all-clusters-app/all-clusters-common/src/rvc-modes.cpp

@@ -88,6 +88,19 @@ CHIP_ERROR RvcRunModeDelegate::GetModeTagsByIndex(uint8_t modeIndex, List<ModeTa
     return CHIP_NO_ERROR;
 }
 
+void RvcRunMode::Shutdown()
+{
+    if (gRvcRunModeInstance != nullptr)
+    {
+        delete gRvcRunModeInstance;
+        gRvcRunModeInstance = nullptr;
+    }
+    if (gRvcRunModeDelegate != nullptr)
+    {
+        gRvcRunModeDelegate->~RvcRunModeDelegate();
+    }
+}
+
 void emberAfRvcRunModeClusterInitCallback(chip::EndpointId endpointId)
 {
     VerifyOrDie(endpointId == 1); // this cluster is only enabled for endpoint 1.
@@ -158,6 +171,19 @@ CHIP_ERROR RvcCleanModeDelegate::GetModeTagsByIndex(uint8_t modeIndex, List<Mode
     return CHIP_NO_ERROR;
 }
 
+void RvcCleanMode::Shutdown()
+{
+    if (gRvcCleanModeInstance != nullptr)
+    {
+        delete gRvcCleanModeInstance;
+        gRvcCleanModeInstance = nullptr;
+    }
+    if (gRvcCleanModeDelegate != nullptr)
+    {
+        gRvcCleanModeDelegate->~RvcCleanModeDelegate();
+    }
+}
+
 void emberAfRvcCleanModeClusterInitCallback(chip::EndpointId endpointId)
 {
     VerifyOrDie(endpointId == 1); // this cluster is only enabled for endpoint 1.

examples/all-clusters-app/all-clusters-common/src/tcc-mode.cpp

@@ -75,6 +75,19 @@ CHIP_ERROR TccModeDelegate::GetModeTagsByIndex(uint8_t modeIndex, List<ModeTagSt
     return CHIP_NO_ERROR;
 }
 
+void RefrigeratorAndTemperatureControlledCabinetMode::Shutdown()
+{
+    if (gTccModeInstance != nullptr)
+    {
+        delete gTccModeInstance;
+        gTccModeInstance = nullptr;
+    }
+    if (gTccModeDelegate != nullptr)
+    {
+        gTccModeDelegate->~TccModeDelegate();
+    }
+}
+
 void emberAfRefrigeratorAndTemperatureControlledCabinetModeClusterInitCallback(chip::EndpointId endpointId)
 {
     VerifyOrDie(endpointId == 1); // this cluster is only enabled for endpoint 1.

examples/all-clusters-app/linux/main-common.cpp

@@ -16,7 +16,6 @@
  *    limitations under the License.
  */
 
-#include "main-common.h"
 #include "AllClustersCommandDelegate.h"
 #include "WindowCoveringManager.h"
 #include "dishwasher-mode.h"
@@ -191,8 +190,15 @@ void ApplicationInit()
     app::Clusters::TemperatureControl::SetInstance(&sAppSupportedTemperatureLevelsDelegate);
 }
 
-void ApplicationExit()
+void ApplicationShutdown()
 {
+    // These may have been initialised via the emberAfXxxClusterInitCallback methods. We need to destroy them before shutdown.
+    Clusters::DishwasherMode::Shutdown();
+    Clusters::LaundryWasherMode::Shutdown();
+    Clusters::RvcCleanMode::Shutdown();
+    Clusters::RvcRunMode::Shutdown();
+    Clusters::RefrigeratorAndTemperatureControlledCabinetMode::Shutdown();
+
     if (sChipNamedPipeCommands.Stop() != CHIP_NO_ERROR)
     {
         ChipLogError(NotSpecified, "Failed to stop CHIP NamedPipeCommands");

examples/all-clusters-app/linux/main.cpp

@@ -19,7 +19,6 @@
 #include "AppMain.h"
 #include "AppOptions.h"
 #include "binding-handler.h"
-#include "main-common.h"
 
 // Network commissioning
 namespace {
@@ -35,7 +34,6 @@ int main(int argc, char * argv[])
     LinuxDeviceOptions::GetInstance().dacProvider = AppOptions::GetDACProvider();
 
     ChipLinuxAppMainLoop();
-    ApplicationExit();
 
     return 0;
 }

examples/all-clusters-app/tizen/src/main.cpp

@@ -51,6 +51,8 @@ void ApplicationInit()
     app::Clusters::TemperatureControl::SetInstance(&sAppSupportedTemperatureLevelsDelegate);
 }
 
+void ApplicationShutdown() {}
+
 int main(int argc, char * argv[])
 {
     TizenServiceAppMain app;

examples/all-clusters-minimal-app/linux/main-common.cpp

@@ -84,6 +84,8 @@ static Identify gIdentify1 = {
 
 void ApplicationInit() {}
 
+void ApplicationShutdown() {}
+
 void emberAfLowPowerClusterInitCallback(EndpointId endpoint)
 {
     ChipLogProgress(Zcl, "TV Linux App: LowPower::SetDefaultDelegate");

examples/all-clusters-minimal-app/tizen/src/main.cpp

@@ -47,6 +47,8 @@ void ApplicationInit()
     sEthernetNetworkCommissioningInstance.Init();
 }
 
+void ApplicationShutdown(){};
+
 int main(int argc, char * argv[])
 {
     TizenServiceAppMain app;

examples/bridge-app/linux/main.cpp

@@ -741,6 +741,8 @@ bool emberAfActionsClusterInstantActionCallback(app::CommandHandler * commandObj
 
 void ApplicationInit() {}
 
+void ApplicationShutdown() {}
+
 const EmberAfDeviceType gBridgedOnOffDeviceTypes[] = { { DEVICE_TYPE_LO_ON_OFF_LIGHT, DEVICE_VERSION_DEFAULT },
                                                        { DEVICE_TYPE_BRIDGED_NODE, DEVICE_VERSION_DEFAULT } };
 

examples/chef/linux/main.cpp

@@ -32,6 +32,8 @@ using namespace chip::app;
 
 void ApplicationInit() {}
 
+void ApplicationShutdown() {}
+
 int main(int argc, char * argv[])
 {
     if (ChipLinuxAppInit(argc, argv) != 0)

examples/contact-sensor-app/linux/main.cpp

@@ -33,6 +33,8 @@ using namespace chip::app::Clusters;
 
 void ApplicationInit() {}
 
+void ApplicationShutdown() {}
+
 int main(int argc, char * argv[])
 {
     VerifyOrDie(ChipLinuxAppInit(argc, argv) == 0);

examples/dishwasher-app/linux/main.cpp

@@ -32,6 +32,8 @@ void ApplicationInit()
     MatterOperationalStateServerInit();
 }
 
+void ApplicationShutdown() {}
+
 int main(int argc, char * argv[])
 {
     if (ChipLinuxAppInit(argc, argv) != 0)

examples/lighting-app/linux/main.cpp

@@ -85,7 +85,7 @@ void ApplicationInit()
     }
 }
 
-void ApplicationExit()
+void ApplicationShutdown()
 {
     if (sChipNamedPipeCommands.Stop() != CHIP_NO_ERROR)
     {

examples/lighting-app/tizen/src/main.cpp

@@ -52,6 +52,8 @@ void ApplicationInit()
 #endif
 }
 
+void ApplicationShutdown() {}
+
 int main(int argc, char * argv[])
 {
     TizenServiceAppMain app;

examples/lock-app/linux/main.cpp

@@ -43,6 +43,8 @@ void ApplicationInit()
     }
 }
 
+void ApplicationShutdown() {}
+
 int main(int argc, char * argv[])
 {
     VerifyOrDie(ChipLinuxAppInit(argc, argv) == 0);

examples/ota-provider-app/linux/main.cpp

@@ -380,6 +380,8 @@ void ApplicationInit()
     chip::app::Clusters::OTAProvider::SetDelegate(kOtaProviderEndpoint, &gOtaProvider);
 }
 
+void ApplicationShutdown() {}
+
 int main(int argc, char * argv[])
 {
     VerifyOrDie(ChipLinuxAppInit(argc, argv, &cmdLineOptions) == 0);

examples/ota-requestor-app/linux/main.cpp

@@ -255,6 +255,8 @@ void ApplicationInit()
     InitOTARequestor();
 }
 
+void ApplicationShutdown() {}
+
 int main(int argc, char * argv[])
 {
     VerifyOrDie(ChipLinuxAppInit(argc, argv, &cmdLineOptions, MakeOptional(kNetworkCommissioningEndpointSecondary)) == 0);

examples/placeholder/linux/main.cpp

@@ -22,6 +22,8 @@
 
 void ApplicationInit() {}
 
+void ApplicationShutdown() {}
+
 int main(int argc, char * argv[])
 {
     VerifyOrDie(ChipLinuxAppInit(argc, argv, AppOptions::GetOptions()) == 0);

examples/platform/linux/AppMain.cpp

@@ -578,6 +578,8 @@ void ChipLinuxAppMainLoop(AppMainLoopImplementation * impl)
     }
     gMainLoopImplementation = nullptr;
 
+    ApplicationShutdown();
+
 #if CHIP_DEVICE_CONFIG_ENABLE_BOTH_COMMISSIONER_AND_COMMISSIONEE
     ShutdownCommissioner();
 #endif // CHIP_DEVICE_CONFIG_ENABLE_BOTH_COMMISSIONER_AND_COMMISSIONEE

examples/platform/linux/AppMain.h

@@ -103,3 +103,6 @@ CommissionerDiscoveryController * GetCommissionerDiscoveryController();
 
 // For extra init calls, the function will be called right before running Matter main loop.
 void ApplicationInit();
+
+// For extra shutdown calls, the function will be called before any of the core Matter objects are shut down.
+void ApplicationShutdown();

examples/resource-monitoring-app/linux/src/main.cpp

@@ -48,6 +48,8 @@ void ApplicationInit()
     gActivatedCarbonFilterInstance.Init();
 }
 
+void ApplicationShutdown() {}
+
 int main(int argc, char * argv[])
 {
     if (ChipLinuxAppInit(argc, argv) != 0)

examples/thermostat/linux/main.cpp

@@ -71,6 +71,8 @@ static Identify gIdentify1 = {
 
 void ApplicationInit() {}
 
+void ApplicationShutdown() {}
+
 int main(int argc, char * argv[])
 {
     VerifyOrDie(ChipLinuxAppInit(argc, argv) == 0);

examples/tv-app/linux/main.cpp

@@ -47,6 +47,8 @@ void ApplicationInit()
     // emberAfEndpointEnableDisable(3, false);
 }
 
+void ApplicationShutdown() {}
+
 int main(int argc, char * argv[])
 {
 

scripts/tools/check_includes_config.py

@@ -158,7 +158,4 @@
     # Library meant for non-embedded
     'src/tracing/json/json_tracing.cpp': {'string', 'sstream'},
     'src/tracing/json/json_tracing.h': {'fstream'},
-
-    # Temporary solution util the OnOff server can provide a callback API for state change.
-    'src/app/clusters/mode-base-server/mode-base-server.h': {'set'}
 }