We should not call SetDiagnosticDataProvider within PaltformMgr on ea… (

#20806)

* We should not call SetDiagnosticDataProvider within PaltformMgr on each platfrom

* Update src/include/platform/DiagnosticDataProvider.h

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

* Allow app to overwrite the default implantation of DiagnosticDataProvider

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

src/include/platform/DiagnosticDataProvider.h

@@ -62,6 +62,8 @@ struct NetworkInterface : public app::Clusters::GeneralDiagnostics::Structs::Net
     NetworkInterface * Next; /* Pointer to the next structure.  */
 };
 
+class DiagnosticDataProviderImpl;
+
 /**
  * Defines the WiFi Diagnostics Delegate class to notify WiFi network events.
  */
@@ -184,12 +186,21 @@ class DiagnosticDataProvider
 };
 
 /**
- * Returns a reference to a DiagnosticDataProvider object.
+ * Returns a reference to the public interface of the DiagnosticDataProvider singleton object.
  *
- * Applications should use this to access the features of the DiagnosticDataProvider.
+ * Applications should use this to access features of the DiagnosticDataProvider object
+ * that are common to all platforms.
  */
 DiagnosticDataProvider & GetDiagnosticDataProvider();
 
+/**
+ * Returns the platform-specific implementation of the DiagnosticDataProvider singleton object.
+ *
+ * Applications can use this to gain access to features of the DiagnosticDataProvider
+ * that are specific to the selected platform.
+ */
+extern DiagnosticDataProvider & GetDiagnosticDataProviderImpl();
+
 /**
  * Sets a reference to a DiagnosticDataProvider object.
  *

src/platform/Ameba/DiagnosticDataProviderImpl.cpp

@@ -423,5 +423,10 @@ CHIP_ERROR DiagnosticDataProviderImpl::ResetWiFiNetworkDiagnosticsCounts()
 }
 #endif // CHIP_DEVICE_CONFIG_ENABLE_WIFI
 
+DiagnosticDataProvider & GetDiagnosticDataProviderImpl()
+{
+    return DiagnosticDataProviderImpl::GetDefaultInstance();
+}
+
 } // namespace DeviceLayer
 } // namespace chip

src/platform/Ameba/DiagnosticDataProviderImpl.h

@@ -70,5 +70,13 @@ class DiagnosticDataProviderImpl : public DiagnosticDataProvider
 #endif
 };
 
+/**
+ * Returns the platform-specific implementation of the DiagnosticDataProvider singleton object.
+ *
+ * Applications can use this to gain access to features of the DiagnosticDataProvider
+ * that are specific to the selected platform.
+ */
+DiagnosticDataProvider & GetDiagnosticDataProviderImpl();
+
 } // namespace DeviceLayer
 } // namespace chip

src/platform/Ameba/PlatformManagerImpl.cpp

@@ -60,7 +60,6 @@ CHIP_ERROR PlatformManagerImpl::_InitChipStack(void)
     CHIP_ERROR err;
 
     SetConfigurationMgr(&ConfigurationManagerImpl::GetDefaultInstance());
-    SetDiagnosticDataProvider(&DiagnosticDataProviderImpl::GetDefaultInstance());
 
     // Make sure the LwIP core lock has been initialized
     err = Internal::InitLwIPCoreLock();

src/platform/CYW30739/DiagnosticDataProviderImpl.cpp

@@ -141,5 +141,10 @@ void DiagnosticDataProviderImpl::ReleaseNetworkInterfaces(NetworkInterface * net
 }
 #endif /* CHIP_DEVICE_CONFIG_ENABLE_THREAD */
 
+DiagnosticDataProvider & GetDiagnosticDataProviderImpl()
+{
+    return DiagnosticDataProviderImpl::GetDefaultInstance();
+}
+
 } // namespace DeviceLayer
 } // namespace chip

src/platform/CYW30739/DiagnosticDataProviderImpl.h

@@ -50,5 +50,13 @@ class DiagnosticDataProviderImpl : public DiagnosticDataProvider
 #endif /* CHIP_DEVICE_CONFIG_ENABLE_THREAD */
 };
 
+/**
+ * Returns the platform-specific implementation of the DiagnosticDataProvider singleton object.
+ *
+ * Applications can use this to gain access to features of the DiagnosticDataProvider
+ * that are specific to the selected platform.
+ */
+DiagnosticDataProvider & GetDiagnosticDataProviderImpl();
+
 } // namespace DeviceLayer
 } // namespace chip

src/platform/CYW30739/PlatformManagerImpl.cpp

@@ -46,7 +46,6 @@ CHIP_ERROR PlatformManagerImpl::_InitChipStack(void)
     SuccessOrExit(err);
 
     SetConfigurationMgr(&ConfigurationManagerImpl::GetDefaultInstance());
-    SetDiagnosticDataProvider(&DiagnosticDataProviderImpl::GetDefaultInstance());
 
     /* Create the thread object. */
     mThread = wiced_rtos_create_thread();

src/platform/Darwin/DiagnosticDataProviderImpl.cpp

@@ -77,5 +77,10 @@ CHIP_ERROR DiagnosticDataProviderImpl::ResetWatermarks()
     return CHIP_NO_ERROR;
 }
 
+DiagnosticDataProvider & GetDiagnosticDataProviderImpl()
+{
+    return DiagnosticDataProviderImpl::GetDefaultInstance();
+}
+
 } // namespace DeviceLayer
 } // namespace chip

src/platform/Darwin/DiagnosticDataProviderImpl.h

@@ -44,5 +44,13 @@ class DiagnosticDataProviderImpl : public DiagnosticDataProvider
     CHIP_ERROR ResetWatermarks() override;
 };
 
+/**
+ * Returns the platform-specific implementation of the DiagnosticDataProvider singleton object.
+ *
+ * Applications can use this to gain access to features of the DiagnosticDataProvider
+ * that are specific to the selected platform.
+ */
+DiagnosticDataProvider & GetDiagnosticDataProviderImpl();
+
 } // namespace DeviceLayer
 } // namespace chip

src/platform/Darwin/PlatformManagerImpl.cpp

@@ -53,7 +53,6 @@ CHIP_ERROR PlatformManagerImpl::_InitChipStack()
     SetDeviceInstanceInfoProvider(&DeviceInstanceInfoProviderMgrImpl());
 #endif // CHIP_DISABLE_PLATFORM_KVS
     SetConfigurationMgr(&ConfigurationManagerImpl::GetDefaultInstance());
-    SetDiagnosticDataProvider(&DiagnosticDataProviderImpl::GetDefaultInstance());
 
     mRunLoopSem = dispatch_semaphore_create(0);
 

src/platform/DiagnosticDataProvider.cpp

@@ -21,6 +21,7 @@
  */
 
 #include <lib/support/CodeUtils.h>
+#include <platform/DiagnosticDataProvider.h>
 
 namespace chip {
 namespace DeviceLayer {
@@ -37,8 +38,12 @@ DiagnosticDataProvider * gInstance = nullptr;
 
 DiagnosticDataProvider & GetDiagnosticDataProvider()
 {
-    VerifyOrDie(gInstance != nullptr);
-    return *gInstance;
+    if (gInstance != nullptr)
+    {
+        return *gInstance;
+    }
+
+    return GetDiagnosticDataProviderImpl();
 }
 
 void SetDiagnosticDataProvider(DiagnosticDataProvider * diagnosticDataProvider)

src/platform/EFR32/DiagnosticDataProviderImpl.cpp

@@ -481,5 +481,10 @@ CHIP_ERROR DiagnosticDataProviderImpl::ResetWiFiNetworkDiagnosticsCounts()
 }
 #endif // SL_WIFI
 
+DiagnosticDataProvider & GetDiagnosticDataProviderImpl()
+{
+    return DiagnosticDataProviderImpl::GetDefaultInstance();
+}
+
 } // namespace DeviceLayer
 } // namespace chip

src/platform/EFR32/DiagnosticDataProviderImpl.h

@@ -73,5 +73,13 @@ class DiagnosticDataProviderImpl : public DiagnosticDataProvider
 #endif // SL_WIFI
 };
 
+/**
+ * Returns the platform-specific implementation of the DiagnosticDataProvider singleton object.
+ *
+ * Applications can use this to gain access to features of the DiagnosticDataProvider
+ * that are specific to the selected platform.
+ */
+DiagnosticDataProvider & GetDiagnosticDataProviderImpl();
+
 } // namespace DeviceLayer
 } // namespace chip

src/platform/EFR32/PlatformManagerImpl.cpp

@@ -51,7 +51,6 @@ CHIP_ERROR PlatformManagerImpl::_InitChipStack(void)
     SuccessOrExit(err);
 
     SetConfigurationMgr(&ConfigurationManagerImpl::GetDefaultInstance());
-    SetDiagnosticDataProvider(&DiagnosticDataProviderImpl::GetDefaultInstance());
 
 #if CHIP_SYSTEM_CONFIG_USE_LWIP
     // Initialize LwIP.

src/platform/ESP32/DiagnosticDataProviderImpl.cpp

@@ -353,5 +353,10 @@ CHIP_ERROR DiagnosticDataProviderImpl::ResetWiFiNetworkDiagnosticsCounts()
 }
 #endif // CHIP_DEVICE_CONFIG_ENABLE_WIFI
 
+DiagnosticDataProvider & GetDiagnosticDataProviderImpl()
+{
+    return DiagnosticDataProviderImpl::GetDefaultInstance();
+}
+
 } // namespace DeviceLayer
 } // namespace chip

src/platform/ESP32/DiagnosticDataProviderImpl.h

@@ -68,5 +68,13 @@ class DiagnosticDataProviderImpl : public DiagnosticDataProvider
 #endif // CHIP_DEVICE_CONFIG_ENABLE_WIFI
 };
 
+/**
+ * Returns the platform-specific implementation of the DiagnosticDataProvider singleton object.
+ *
+ * Applications can use this to gain access to features of the DiagnosticDataProvider
+ * that are specific to the selected platform.
+ */
+DiagnosticDataProvider & GetDiagnosticDataProviderImpl();
+
 } // namespace DeviceLayer
 } // namespace chip

src/platform/ESP32/PlatformManagerImpl.cpp

@@ -61,7 +61,6 @@ static int app_entropy_source(void * data, unsigned char * output, size_t len, s
 CHIP_ERROR PlatformManagerImpl::_InitChipStack(void)
 {
     SetConfigurationMgr(&ConfigurationManagerImpl::GetDefaultInstance());
-    SetDiagnosticDataProvider(&DiagnosticDataProviderImpl::GetDefaultInstance());
     SetDeviceInfoProvider(&DeviceInfoProviderImpl::GetDefaultInstance());
 
     esp_err_t err;

src/platform/Linux/DiagnosticDataProviderImpl.cpp

@@ -826,5 +826,10 @@ CHIP_ERROR DiagnosticDataProviderImpl::GetWiFiSecurityType(uint8_t & securityTyp
 }
 #endif // CHIP_DEVICE_CONFIG_ENABLE_WPA
 
+DiagnosticDataProvider & GetDiagnosticDataProviderImpl()
+{
+    return DiagnosticDataProviderImpl::GetDefaultInstance();
+}
+
 } // namespace DeviceLayer
 } // namespace chip

src/platform/Linux/DiagnosticDataProviderImpl.h

@@ -105,5 +105,13 @@ class DiagnosticDataProviderImpl : public DiagnosticDataProvider
 #endif
 };
 
+/**
+ * Returns the platform-specific implementation of the DiagnosticDataProvider singleton object.
+ *
+ * Applications can use this to gain access to features of the DiagnosticDataProvider
+ * that are specific to the selected platform.
+ */
+DiagnosticDataProvider & GetDiagnosticDataProviderImpl();
+
 } // namespace DeviceLayer
 } // namespace chip

src/platform/Linux/PlatformManagerImpl.cpp

@@ -176,7 +176,6 @@ CHIP_ERROR PlatformManagerImpl::_InitChipStack()
     // Initialize the configuration system.
     ReturnErrorOnFailure(Internal::PosixConfig::Init());
     SetConfigurationMgr(&ConfigurationManagerImpl::GetDefaultInstance());
-    SetDiagnosticDataProvider(&DiagnosticDataProviderImpl::GetDefaultInstance());
     SetDeviceInstanceInfoProvider(&DeviceInstanceInfoProviderMgrImpl());
 
     // Call _InitChipStack() on the generic implementation base class

src/platform/P6/DiagnosticDataProviderImpl.cpp

@@ -543,5 +543,10 @@ CHIP_ERROR DiagnosticDataProviderImpl::WiFiCounters(WiFiStatsCountType type, uin
     return err;
 }
 
+DiagnosticDataProvider & GetDiagnosticDataProviderImpl()
+{
+    return DiagnosticDataProviderImpl::GetDefaultInstance();
+}
+
 } // namespace DeviceLayer
 } // namespace chip

src/platform/P6/DiagnosticDataProviderImpl.h

@@ -113,5 +113,13 @@ class DiagnosticDataProviderImpl : public DiagnosticDataProvider
     app::DataModel::Nullable<bool> mipv6_offpremise;
 };
 
+/**
+ * Returns the platform-specific implementation of the DiagnosticDataProvider singleton object.
+ *
+ * Applications can use this to gain access to features of the DiagnosticDataProvider
+ * that are specific to the selected platform.
+ */
+DiagnosticDataProvider & GetDiagnosticDataProviderImpl();
+
 } // namespace DeviceLayer
 } // namespace chip

src/platform/P6/PlatformManagerImpl.cpp

@@ -44,7 +44,6 @@ CHIP_ERROR PlatformManagerImpl::_InitChipStack(void)
     CHIP_ERROR err;
 
     SetConfigurationMgr(&ConfigurationManagerImpl::GetDefaultInstance());
-    SetDiagnosticDataProvider(&DiagnosticDataProviderImpl::GetDefaultInstance());
 
     // Make sure the LwIP core lock has been initialized
     err = Internal::InitLwIPCoreLock();

src/platform/Tizen/DiagnosticDataProviderImpl.cpp

@@ -36,5 +36,10 @@ DiagnosticDataProviderImpl & DiagnosticDataProviderImpl::GetDefaultInstance()
     return sInstance;
 }
 
+DiagnosticDataProvider & GetDiagnosticDataProviderImpl()
+{
+    return DiagnosticDataProviderImpl::GetDefaultInstance();
+}
+
 } // namespace DeviceLayer
 } // namespace chip

src/platform/Tizen/DiagnosticDataProviderImpl.h

@@ -36,5 +36,13 @@ class DiagnosticDataProviderImpl : public DiagnosticDataProvider
     static DiagnosticDataProviderImpl & GetDefaultInstance();
 };
 
+/**
+ * Returns the platform-specific implementation of the DiagnosticDataProvider singleton object.
+ *
+ * Applications can use this to gain access to features of the DiagnosticDataProvider
+ * that are specific to the selected platform.
+ */
+DiagnosticDataProvider & GetDiagnosticDataProviderImpl();
+
 } // namespace DeviceLayer
 } // namespace chip

src/platform/Tizen/PlatformManagerImpl.cpp

@@ -40,7 +40,6 @@ CHIP_ERROR PlatformManagerImpl::_InitChipStack(void)
 {
     ReturnErrorOnFailure(Internal::PosixConfig::Init());
     SetConfigurationMgr(&ConfigurationManagerImpl::GetDefaultInstance());
-    SetDiagnosticDataProvider(&DiagnosticDataProviderImpl::GetDefaultInstance());
     SetDeviceInstanceInfoProvider(&DeviceInstanceInfoProviderMgrImpl());
 
     return Internal::GenericPlatformManagerImpl_POSIX<PlatformManagerImpl>::_InitChipStack();

src/platform/Zephyr/DiagnosticDataProviderImpl.cpp

@@ -321,5 +321,10 @@ void DiagnosticDataProviderImpl::ReleaseNetworkInterfaces(NetworkInterface * net
     }
 }
 
+DiagnosticDataProvider & GetDiagnosticDataProviderImpl()
+{
+    return DiagnosticDataProviderImpl::GetDefaultInstance();
+}
+
 } // namespace DeviceLayer
 } // namespace chip

src/platform/Zephyr/DiagnosticDataProviderImpl.h

@@ -58,5 +58,13 @@ class DiagnosticDataProviderImpl : public DiagnosticDataProvider
     const BootReasonType mBootReason;
 };
 
+/**
+ * Returns the platform-specific implementation of the DiagnosticDataProvider singleton object.
+ *
+ * Applications can use this to gain access to features of the DiagnosticDataProvider
+ * that are specific to the selected platform.
+ */
+DiagnosticDataProvider & GetDiagnosticDataProviderImpl();
+
 } // namespace DeviceLayer
 } // namespace chip

src/platform/Zephyr/PlatformManagerImpl.cpp

@@ -107,7 +107,6 @@ CHIP_ERROR PlatformManagerImpl::_InitChipStack(void)
     err = Internal::ZephyrConfig::Init();
     SuccessOrExit(err);
     SetConfigurationMgr(&ConfigurationManagerImpl::GetDefaultInstance());
-    SetDiagnosticDataProvider(&DiagnosticDataProviderImpl::GetDefaultInstance());
 
 #if !CONFIG_NORDIC_SECURITY_BACKEND
     // Add entropy source based on Zephyr entropy driver

src/platform/android/DiagnosticDataProviderImpl.cpp

@@ -230,5 +230,10 @@ void DiagnosticDataProviderImpl::ReleaseNetworkInterfaces(NetworkInterface * net
     }
 }
 
+DiagnosticDataProvider & GetDiagnosticDataProviderImpl()
+{
+    return DiagnosticDataProviderImpl::GetDefaultInstance();
+}
+
 } // namespace DeviceLayer
 } // namespace chip

src/platform/android/DiagnosticDataProviderImpl.h

@@ -53,5 +53,13 @@ class DiagnosticDataProviderImpl : public DiagnosticDataProvider
     jmethodID mGetNifMethod                      = nullptr;
 };
 
+/**
+ * Returns the platform-specific implementation of the DiagnosticDataProvider singleton object.
+ *
+ * Applications can use this to gain access to features of the DiagnosticDataProvider
+ * that are specific to the selected platform.
+ */
+DiagnosticDataProvider & GetDiagnosticDataProviderImpl();
+
 } // namespace DeviceLayer
 } // namespace chip

src/platform/android/PlatformManagerImpl.cpp

@@ -47,7 +47,6 @@ CHIP_ERROR PlatformManagerImpl::_InitChipStack()
     err = Internal::AndroidConfig::Init();
     SuccessOrExit(err);
     SetConfigurationMgr(&ConfigurationManagerImpl::GetDefaultInstance());
-    SetDiagnosticDataProvider(&DiagnosticDataProviderImpl::GetDefaultInstance());
     SetDeviceInstanceInfoProvider(&DeviceInstanceInfoProviderMgrImpl());
 
     // Call _InitChipStack() on the generic implementation base class

src/platform/bouffalolab/BL602/DiagnosticDataProviderImpl.cpp

@@ -133,5 +133,10 @@ CHIP_ERROR DiagnosticDataProviderImpl::GetBootReason(BootReasonType & bootReason
     return err;
 }
 
+DiagnosticDataProvider & GetDiagnosticDataProviderImpl()
+{
+    return DiagnosticDataProviderImpl::GetDefaultInstance();
+}
+
 } // namespace DeviceLayer
 } // namespace chip