[Server::Shutdown] Fix the matter server shutdown sequence, introduced few APIs to do *ClusterServerShutdown so that we can reinitialise the matter server without reboot on embedded platforms.

src/app/InteractionModelEngine.h

@@ -340,6 +340,39 @@ class InteractionModelEngine : public Messaging::UnsolicitedMessageHandler,
 #endif // CHIP_CONFIG_SUBSCRIPTION_TIMEOUT_RESUMPTION
 #endif // CHIP_CONFIG_PERSIST_SUBSCRIPTIONS
 
+    /** Previously, ShutdowActiveReads() was only available in unit test builds via `#if CONFIG_BUILD_FOR_HOST_UNIT_TEST`.
+      * However, we now require proper cleanup of active read handlers during the application's shutdown sequence,
+      * especially before calling SetDataModelProvider(nullptr). This ensures that there are no ongoing IM reads,
+      * which could otherwise result in crashes or undefined behavior.
+
+      * Therefore, this method has been moved out of the CONFIG_BUILD_FOR_HOST_UNIT_TEST block so that it can be
+      * called as part of the normal shutdown flow.
+
+      * Note: This was originally introduced for unit tests to clean up subscriptions created via the high-level
+      * APIs in src/controller/ReadInteraction.h, which did not expose a way to shut down active subscriptions.
+      **/
+
+    void ShutdownActiveReads()
+    {
+#if CHIP_CONFIG_ENABLE_READ_CLIENT
+        for (auto * readClient = mpActiveReadClientList; readClient != nullptr;)
+        {
+            readClient->mpImEngine = nullptr;
+            auto * tmpClient       = readClient->GetNextClient();
+            readClient->SetNextClient(nullptr);
+            readClient->Close(CHIP_NO_ERROR);
+            readClient = tmpClient;
+        }
+
+        //
+        // After that, we just null out our tracker.
+        //
+        mpActiveReadClientList = nullptr;
+#endif // CHIP_CONFIG_ENABLE_READ_CLIENT
+
+        mReadHandlers.ReleaseAll();
+    }
+
 #if CONFIG_BUILD_FOR_HOST_UNIT_TEST
     //
     // Get direct access to the underlying read handler pool
@@ -391,33 +424,6 @@ class InteractionModelEngine : public Messaging::UnsolicitedMessageHandler,
         mSubscriptionResumptionRetrySecondsOverride = seconds;
     }
 #endif
-
-    //
-    // When testing subscriptions using the high-level APIs in src/controller/ReadInteraction.h,
-    // they don't provide for the ability to shut down those subscriptions after they've been established.
-    //
-    // So for the purposes of unit tests, add a helper here to shut down and clean-up all active handlers.
-    //
-    void ShutdownActiveReads()
-    {
-#if CHIP_CONFIG_ENABLE_READ_CLIENT
-        for (auto * readClient = mpActiveReadClientList; readClient != nullptr;)
-        {
-            readClient->mpImEngine = nullptr;
-            auto * tmpClient       = readClient->GetNextClient();
-            readClient->SetNextClient(nullptr);
-            readClient->Close(CHIP_NO_ERROR);
-            readClient = tmpClient;
-        }
-
-        //
-        // After that, we just null out our tracker.
-        //
-        mpActiveReadClientList = nullptr;
-#endif // CHIP_CONFIG_ENABLE_READ_CLIENT
-
-        mReadHandlers.ReleaseAll();
-    }
 #endif
 
     DataModel::Provider * GetDataModelProvider() const;

src/app/clusters/camera-av-settings-user-level-management-server/camera-av-settings-user-level-management-server.cpp

@@ -1302,3 +1302,10 @@ void CameraAvSettingsUserLevelMgmtServer::HandleDPTZRelativeMove(HandlerContext
  *
  */
 void MatterCameraAvSettingsUserLevelManagementPluginServerInitCallback() {}
+
+/** @brief Camera AV Settings User Level Management Cluster Server Shutdown
+ *
+ * Server Shutdown
+ *
+ */
+void MatterCameraAvSettingsUserLevelManagementPluginServerShutdownCallback() {}

src/app/clusters/scenes-server/scenes-server.cpp

@@ -1153,12 +1153,15 @@ void emberAfScenesManagementClusterServerInitCallback(EndpointId endpoint)
 
 void MatterScenesManagementClusterServerShutdownCallback(EndpointId endpoint)
 {
-    uint16_t endpointTableSize = 0;
-    VerifyOrReturn(Status::Success == Attributes::SceneTableSize::Get(endpoint, &endpointTableSize));
-
-    // Get Scene Table Instance
-    SceneTable * sceneTable = scenes::GetSceneTableImpl(endpoint, endpointTableSize);
-    sceneTable->RemoveEndpoint();
+    // TODO: Remove the commented code.
+    // MatterScenesManagementClusterServerShutdownCallback was not being called before and in the sceneTable->RemoveEndpoint();
+    // it removes the SceneTableEntry from the persistent storage.
+    // uint16_t endpointTableSize = 0;
+    // VerifyOrReturn(Status::Success == Attributes::SceneTableSize::Get(endpoint, &endpointTableSize));
+
+    // // Get Scene Table Instance
+    // SceneTable * sceneTable = scenes::GetSceneTableImpl(endpoint, endpointTableSize);
+    // sceneTable->RemoveEndpoint();
 }
 
 void MatterScenesManagementPluginServerInitCallback()

src/app/clusters/scenes-server/scenes-server.h

@@ -106,7 +106,12 @@ class ScenesServer : public CommandHandlerInterface, public AttributeAccessInter
 
 private:
     ScenesServer() : CommandHandlerInterface(Optional<EndpointId>(), Id), AttributeAccessInterface(Optional<EndpointId>(), Id) {}
-    ~ScenesServer() { Shutdown(); }
+    ~ScenesServer()
+    {
+        // TODO: Remove the commented code.
+        // ScenesServer::Shutdown is being called from MatterScenesManagementPluginServerShutdownCallback.
+        // Shutdown();
+    }
 
     bool mIsInitialized = false;
 

src/app/server/Server.cpp

@@ -651,6 +651,14 @@ void Server::Shutdown()
 #if CHIP_CONFIG_ENABLE_ICD_SERVER
     app::DnssdServer::Instance().SetICDManager(nullptr);
 #endif // CHIP_CONFIG_ENABLE_ICD_SERVER
+
+    /** Shutdown all active read handlers to ensure a clean shutdown of the Interaction Model.
+     * This is required before resetting the DataModelProvider, as ongoing reads may access it
+     * and lead to crashes or undefined behavior.
+     **/
+    app::InteractionModelEngine::GetInstance()->ShutdownActiveReads();
+
+    app::InteractionModelEngine::GetInstance()->SetDataModelProvider(nullptr);
     app::DnssdServer::Instance().SetCommissioningModeProvider(nullptr);
     Dnssd::ServiceAdvertiser::Instance().Shutdown();
 
@@ -681,11 +689,13 @@ void Server::Shutdown()
     mCommissioningWindowManager.Shutdown();
     mMessageCounterManager.Shutdown();
     mExchangeMgr.Shutdown();
+    mFabrics.RemoveFabricDelegate(&mFabricDelegate);
     mSessions.Shutdown();
     mTransports.Close();
     mAccessControl.Finish();
     Access::ResetAccessControlToDefault();
     Credentials::SetGroupDataProvider(nullptr);
+    app::EventManagement::GetInstance().DestroyEventManagement();
 #if CHIP_CONFIG_ENABLE_ICD_SERVER
     // Remove Test Event Trigger Handler
     if (mTestEventTriggerDelegate != nullptr)
@@ -695,6 +705,7 @@ void Server::Shutdown()
     mICDManager.Shutdown();
 #endif // CHIP_CONFIG_ENABLE_ICD_SERVER
 
+    mFabrics.Shutdown();
     // TODO(16969): Remove chip::Platform::MemoryInit() call from Server class, it belongs to outer code
     chip::Platform::MemoryShutdown();
 }

src/app/tests/test-ember-api.cpp

@@ -35,5 +35,6 @@ uint16_t emberAfGetClusterServerEndpointIndex(chip::EndpointId endpoint, chip::C
     return endpoint;
 }
 
-// Mock function for linking
+// Mock functions for linking
 void InitDataModelHandler() {}
+void ShutdownDataModelHandler() {}

src/app/util/DataModelHandler.cpp

@@ -28,3 +28,8 @@ void InitDataModelHandler()
     emberAfEndpointConfigure();
     emberAfInit();
 }
+
+void ShutdownDataModelHandler()
+{
+    emberAfShutdown();
+}

src/app/util/DataModelHandler.h

@@ -21,3 +21,8 @@
  * data model messages.
  */
 void InitDataModelHandler();
+
+/**
+ * Shutdown the data model.
+ */
+void ShutdownDataModelHandler();

src/app/util/attribute-storage-detail.h

@@ -32,6 +32,8 @@ extern uint8_t attributeData[]; // main storage bucket for all attributes
 
 void emAfCallInits();
 
+void emAfCallShutdowns();
+
 chip::Protocols::InteractionModel::Status emAfReadOrWriteAttribute(const EmberAfAttributeSearchRecord * attRecord,
                                                                    const EmberAfAttributeMetadata ** metadata, uint8_t * buffer,
                                                                    uint16_t readLength, bool write);

src/app/util/attribute-storage.cpp

@@ -478,7 +478,8 @@ static void shutdownEndpoint(EmberAfDefinedEndpoint * definedEndpoint)
     const EmberAfEndpointType * epType = definedEndpoint->endpointType;
     for (clusterIndex = 0; clusterIndex < epType->clusterCount; clusterIndex++)
     {
-        const EmberAfCluster * cluster  = &(epType->cluster[clusterIndex]);
+        const EmberAfCluster * cluster = &(epType->cluster[clusterIndex]);
+        emberAfClusterShutdownCallback(definedEndpoint->endpoint, cluster->clusterId);
         EmberAfGenericClusterFunction f = emberAfFindClusterFunction(cluster, MATTER_CLUSTER_FLAG_SHUTDOWN_FUNCTION);
         if (f != nullptr)
         {
@@ -503,6 +504,19 @@ void emAfCallInits()
     }
 }
 
+// Calls the shutdown functions.
+void emAfCallShutdowns()
+{
+    uint16_t index;
+    for (index = 0; index < emberAfEndpointCount(); index++)
+    {
+        if (emberAfEndpointIndexIsEnabled(index))
+        {
+            shutdownEndpoint(&(emAfEndpoints[index]));
+        }
+    }
+}
+
 // Returns the pointer to metadata, or null if it is not found
 const EmberAfAttributeMetadata * emberAfLocateAttributeMetadata(EndpointId endpoint, ClusterId clusterId, AttributeId attributeId)
 {

src/app/util/generic-callbacks.h

@@ -35,6 +35,17 @@
  */
 void emberAfClusterInitCallback(chip::EndpointId endpoint, chip::ClusterId clusterId);
 
+/** @brief Cluster Shutdown
+ *
+ * This function is called when a specific cluster is shutdown. It gives the
+ * application an opportunity to take care of cluster shutdown procedures.
+ * It is called exactly once for each endpoint where cluster is present.
+ *
+ * @param endpoint   Ver.: always
+ * @param clusterId   Ver.: always
+ */
+void emberAfClusterShutdownCallback(chip::EndpointId endpoint, chip::ClusterId clusterId);
+
 /** @brief Attribute Read Access
  *
  * This function is called whenever the Application Framework needs to check

src/app/util/util.cpp

@@ -84,6 +84,15 @@ void emberAfInit()
     emAfCallInits();
 }
 
+// ****************************************
+// Shutdown Clusters
+// ****************************************
+void emberAfShutdown()
+{
+    emAfCallShutdowns();
+    MATTER_PLUGINS_SHUTDOWN
+}
+
 // Cluster init functions that don't have a cluster implementation to define
 // them in.
 void MatterBallastConfigurationPluginServerInitCallback() {}
@@ -143,6 +152,67 @@ void MatterCommodityPricePluginServerInitCallback() {}
 void MatterElectricalGridConditionsPluginServerInitCallback() {}
 void MatterSoilMeasurementPluginServerInitCallback() {}
 
+// Cluster shutdown functions that don't have a cluster implementation to define
+// them in.
+void MatterBallastConfigurationPluginServerShutdownCallback() {}
+void MatterBooleanStatePluginServerShutdownCallback() {}
+void MatterRelativeHumidityMeasurementPluginServerShutdownCallback() {}
+void MatterIlluminanceMeasurementPluginServerShutdownCallback() {}
+void MatterBinaryInputBasicPluginServerShutdownCallback() {}
+void MatterPressureMeasurementPluginServerShutdownCallback() {}
+void MatterTemperatureMeasurementPluginServerShutdownCallback() {}
+void MatterFlowMeasurementPluginServerShutdownCallback() {}
+void MatterThermostatUserInterfaceConfigurationPluginServerShutdownCallback() {}
+void MatterBridgedDeviceBasicInformationPluginServerShutdownCallback() {}
+void MatterPowerConfigurationPluginServerShutdownCallback() {}
+void MatterPowerProfilePluginServerShutdownCallback() {}
+void MatterPulseWidthModulationPluginServerShutdownCallback() {}
+void MatterAlarmsPluginServerShutdownCallback() {}
+void MatterTimePluginServerShutdownCallback() {}
+void MatterAclPluginServerShutdownCallback() {}
+void MatterPollControlPluginServerShutdownCallback() {}
+void MatterProxyValidPluginServerShutdownCallback() {}
+void MatterProxyDiscoveryPluginServerShutdownCallback() {}
+void MatterProxyConfigurationPluginServerShutdownCallback() {}
+void MatterFanControlPluginServerShutdownCallback() {}
+void MatterActivatedCarbonFilterMonitoringPluginServerShutdownCallback() {}
+void MatterHepaFilterMonitoringPluginServerShutdownCallback() {}
+void MatterAirQualityPluginServerShutdownCallback() {}
+void MatterCarbonMonoxideConcentrationMeasurementPluginServerShutdownCallback() {}
+void MatterCarbonDioxideConcentrationMeasurementPluginServerShutdownCallback() {}
+void MatterFormaldehydeConcentrationMeasurementPluginServerShutdownCallback() {}
+void MatterNitrogenDioxideConcentrationMeasurementPluginServerShutdownCallback() {}
+void MatterOzoneConcentrationMeasurementPluginServerShutdownCallback() {}
+void MatterPm10ConcentrationMeasurementPluginServerShutdownCallback() {}
+void MatterPm1ConcentrationMeasurementPluginServerShutdownCallback() {}
+void MatterPm25ConcentrationMeasurementPluginServerShutdownCallback() {}
+void MatterRadonConcentrationMeasurementPluginServerShutdownCallback() {}
+void MatterTotalVolatileOrganicCompoundsConcentrationMeasurementPluginServerShutdownCallback() {}
+void MatterRvcRunModePluginServerShutdownCallback() {}
+void MatterRvcCleanModePluginServerShutdownCallback() {}
+void MatterDishwasherModePluginServerShutdownCallback() {}
+void MatterLaundryWasherModePluginServerShutdownCallback() {}
+void MatterRefrigeratorAndTemperatureControlledCabinetModePluginServerShutdownCallback() {}
+void MatterOperationalStatePluginServerShutdownCallback() {}
+void MatterRvcOperationalStatePluginServerShutdownCallback() {}
+void MatterOvenModePluginServerShutdownCallback() {}
+void MatterOvenCavityOperationalStatePluginServerShutdownCallback() {}
+void MatterDishwasherAlarmPluginServerShutdownCallback() {}
+void MatterMicrowaveOvenModePluginServerShutdownCallback() {}
+void MatterDeviceEnergyManagementModePluginServerShutdownCallback() {}
+void MatterEnergyEvseModePluginServerShutdownCallback() {}
+void MatterPowerTopologyPluginServerShutdownCallback() {}
+void MatterElectricalEnergyMeasurementPluginServerShutdownCallback() {}
+void MatterElectricalPowerMeasurementPluginServerShutdownCallback() {}
+void MatterServiceAreaPluginServerShutdownCallback() {}
+void MatterWaterHeaterManagementPluginServerShutdownCallback() {}
+void MatterWaterHeaterModePluginServerShutdownCallback() {}
+void MatterMeterIdentificationPluginServerShutdownCallback() {}
+void MatterClosureDimensionPluginServerShutdownCallback() {}
+void MatterElectricalGridConditionsPluginServerShutdownCallback() {}
+void MatterCommodityPricePluginServerShutdownCallback() {}
+void MatterSoilMeasurementPluginServerShutdownCallback() {}
+
 bool emberAfContainsAttribute(chip::EndpointId endpoint, chip::ClusterId clusterId, chip::AttributeId attributeId)
 {
     return (emberAfGetServerAttributeIndexByAttributeId(endpoint, clusterId, attributeId) != UINT16_MAX);

src/app/util/util.h

@@ -25,6 +25,7 @@
 
 void emberAfInit();
 
+void emberAfShutdown();
 /**
  * Retrieves the difference between the two passed values.
  * This function assumes that the two values have the same endianness.

src/controller/EmptyDataModelHandler.cpp

@@ -25,3 +25,4 @@
 #include <app/util/DataModelHandler.h>
 
 void InitDataModelHandler() {}
+void ShutdownDataModelHandler() {}

src/controller/tests/TestServerCommandDispatch.cpp

@@ -149,8 +149,10 @@ class DispatchTestDataModel : public CodegenDataModelProvider
 
 protected:
     // Since the current unit tests do not involve any cluster implementations, we override InitDataModelForTesting
-    // to do nothing, thereby preventing calls to the Ember-specific InitDataModelHandler.
+    // ShutdownDataModelForTesting to do nothing, thereby preventing calls to the Ember-specific InitDataModelHandler
+    // and ShutdownDataModelHandler.
     void InitDataModelForTesting() override {}
+    void ShutdownDataModelForTesting() override {}
 };
 
 class TestServerCommandDispatch : public chip::Test::AppContext

src/controller/tests/data_model/DataModelFixtures.cpp

@@ -40,8 +40,9 @@ using namespace chip::app::Clusters;
 using namespace chip::app::Clusters::UnitTesting;
 using namespace chip::Protocols;
 
-// Mock function for linking
+// Mock functions for linking
 void InitDataModelHandler() {}
+void ShutdownDataModelHandler() {}
 
 namespace chip {
 namespace app {

src/credentials/FabricTable.cpp

@@ -1169,6 +1169,7 @@ void FabricTable::Shutdown()
         delegate->next               = nullptr;
         delegate                     = temp;
     }
+    mDelegateListRoot = nullptr;
 
     RevertPendingFabricData();
     for (FabricInfo & fabricInfo : mStates)

src/darwin/Framework/CHIP/ServerEndpoint/MTRIMDispatch.mm

@@ -73,6 +73,14 @@ void emberAfClusterInitCallback(EndpointId endpoint, ClusterId clusterId)
     // clusters dont use it.
 }
 
+void emberAfClusterShutdownCallback(EndpointId endpoint, ClusterId clusterId)
+{
+    assertChipStackLockedByCurrentThread();
+
+    // No-op: Descriptor and OTA do not need this, and our client-defined
+    // clusters dont use it.
+}
+
 Protocols::InteractionModel::Status emAfWriteAttributeExternal(const ConcreteAttributePath & path,
     const EmberAfWriteDataInput & input)
 {

src/darwin/Framework/CHIP/app/PluginApplicationCallbacks.h

@@ -23,5 +23,7 @@
  */
 
 void MatterDescriptorPluginServerInitCallback();
+void MatterDescriptorPluginServerShutdownCallback();
 
 #define MATTER_PLUGINS_INIT MatterDescriptorPluginServerInitCallback();
+#define MATTER_PLUGINS_SHUTDOWN MatterDescriptorPluginServerShutdownCallback();