Move socket watch APIs into System::Layer (#9086)

* Move socket watch APIs into System::Layer #### Problem Transitionally, `System::Layer` operations are provided by a configuration-specific `WatchableEventManager`, but they are not yet sufficiently aligned to convert to abstract and implementation classes. Part of #7715 Virtualize System and Inet interfaces #### Change overview - Move socket event watch APIs into `System::Layer`. - Remove `WatchableSocket` and its include-file hack that allowed implementation-specific state to be contained directly in EndPoints. - Revise the select() implementation to use an internal pool for watch state in place of the EndPoint-embedded WatchableSocket. - Revise the libevent sample implementation to use libevent timers directly instead of the System::Timer pool. The libevent implementation uses STL containers with heap-allocated state for the sake of being different from the select()-based implementation. #### Testing CI; no change to functionality should is expected. * restyle * fix GetCommandExitStatus race * Enforce use of API via System::Layer * also include dispatch case * add LwIP case * restyle
project-chip · Aug 23, 2021 · 82cf1b1 · 82cf1b1
1 parent 9f64655
commit 82cf1b1
Show file tree

Hide file tree

Showing 60 changed files with 1,181 additions and 1,262 deletions.
diff --git a/examples/chip-tool/commands/common/Commands.cpp b/examples/chip-tool/commands/common/Commands.cpp
@@ -120,11 +120,6 @@ int Commands::Run(int argc, char ** argv)
     chip::DeviceLayer::PlatformMgr().RunEventLoop();
 #endif // !CONFIG_USE_SEPARATE_EVENTLOOP
 
-    if (command)
-    {
-        err = command->GetCommandExitStatus();
-    }
-
 exit:
     if (err != CHIP_NO_ERROR)
     {
@@ -135,6 +130,15 @@ int Commands::Run(int argc, char ** argv)
     chip::DeviceLayer::PlatformMgr().StopEventLoopTask();
 #endif // CONFIG_USE_SEPARATE_EVENTLOOP
 
+    if (command)
+    {
+        err = command->GetCommandExitStatus();
+        if (err != CHIP_NO_ERROR)
+        {
+            ChipLogError(chipTool, "Run command failure: %s", chip::ErrorStr(err));
+        }
+    }
+
     if (command)
     {
         command->Shutdown();

diff --git a/examples/minimal-mdns/client.cpp b/examples/minimal-mdns/client.cpp
@@ -29,7 +29,6 @@
 #include <support/CHIPArgParser.hpp>
 #include <support/CHIPMem.h>
 #include <system/SystemPacketBuffer.h>
-#include <system/SystemTimer.h>
 
 #include "AllInterfaceListener.h"
 #include "PacketReporter.h"

diff --git a/examples/minimal-mdns/server.cpp b/examples/minimal-mdns/server.cpp
@@ -35,7 +35,6 @@
 #include <support/CHIPArgParser.hpp>
 #include <support/CHIPMem.h>
 #include <system/SystemPacketBuffer.h>
-#include <system/SystemTimer.h>
 
 #include "AllInterfaceListener.h"
 #include "PacketReporter.h"

diff --git a/examples/platform/nrfconnect/util/test/TestInetCommon.cpp b/examples/platform/nrfconnect/util/test/TestInetCommon.cpp
@@ -46,7 +46,6 @@
 #include <support/CHIPMem.h>
 #include <support/ErrorStr.h>
 #include <support/ScopedBuffer.h>
-#include <system/SystemTimer.h>
 
 #if CHIP_SYSTEM_CONFIG_USE_SOCKETS
 #include <arpa/inet.h>
@@ -114,7 +113,7 @@ void ServiceEvents(struct ::timeval & aSleepTime)
     FD_ZERO(&exceptFDs);
 
 #if CHIP_SYSTEM_CONFIG_USE_SOCKETS
-    if (gSystemLayer.State() == System::kLayerState_Initialized)
+    if (gSystemLayer.State() == System::LayerState::kInitialized)
         gSystemLayer.PrepareSelect(numFDs, &readFDs, &writeFDs, &exceptFDs, aSleepTime);
 #endif // CHIP_SYSTEM_CONFIG_USE_SOCKETS
 
@@ -131,7 +130,7 @@ void ServiceEvents(struct ::timeval & aSleepTime)
     }
 #endif // CHIP_SYSTEM_CONFIG_USE_SOCKETS
 
-    if (gSystemLayer.State() == System::kLayerState_Initialized)
+    if (gSystemLayer.State() == System::LayerState::kInitialized)
     {
 
 #if CHIP_SYSTEM_CONFIG_USE_SOCKETS

diff --git a/src/app/EventManagement.cpp b/src/app/EventManagement.cpp
@@ -24,7 +24,6 @@
 #include <support/CodeUtils.h>
 #include <support/ErrorStr.h>
 #include <support/logging/CHIPLogging.h>
-#include <system/SystemTimer.h>
 
 using namespace chip::TLV;
 

diff --git a/src/app/tests/TestReadInteraction.cpp b/src/app/tests/TestReadInteraction.cpp
@@ -40,7 +40,6 @@
 #include <support/ErrorStr.h>
 #include <support/UnitTestRegistration.h>
 #include <system/SystemPacketBuffer.h>
-#include <system/SystemTimer.h>
 #include <system/TLVPacketBufferBackingStore.h>
 #include <transport/SecureSessionMgr.h>
 #include <transport/raw/UDP.h>

diff --git a/src/app/tests/integration/MockEvents.cpp b/src/app/tests/integration/MockEvents.cpp
@@ -31,7 +31,6 @@
 #include <protocols/secure_channel/PASESession.h>
 #include <support/ErrorStr.h>
 #include <system/SystemPacketBuffer.h>
-#include <system/SystemTimer.h>
 #include <transport/SecureSessionMgr.h>
 
 static uint64_t kLivenessDeviceStatus = chip::TLV::ContextTag(1);

diff --git a/src/app/util/af-event.cpp b/src/app/util/af-event.cpp
@@ -43,7 +43,6 @@
 #include <app/util/attribute-storage.h>
 
 #include <platform/CHIPDeviceLayer.h>
-#include <system/SystemTimer.h>
 
 #define EMBER_MAX_EVENT_CONTROL_DELAY_MS (UINT32_MAX / 2)
 #define EMBER_MAX_EVENT_CONTROL_DELAY_QS (EMBER_MAX_EVENT_CONTROL_DELAY_MS >> 8)

diff --git a/src/controller/CHIPDeviceController.cpp b/src/controller/CHIPDeviceController.cpp
@@ -468,19 +468,6 @@ CHIP_ERROR DeviceController::ServiceEvents()
     return CHIP_NO_ERROR;
 }
 
-CHIP_ERROR DeviceController::ServiceEventSignal()
-{
-    VerifyOrReturnError(mState == State::Initialized, CHIP_ERROR_INCORRECT_STATE);
-
-#if CONFIG_DEVICE_LAYER && (CHIP_SYSTEM_CONFIG_USE_SOCKETS || CHIP_SYSTEM_CONFIG_USE_NETWORK_FRAMEWORK)
-    DeviceLayer::SystemLayer.WatchableEventsManager().Signal();
-#else
-    ReturnErrorOnFailure(CHIP_ERROR_UNSUPPORTED_CHIP_FEATURE);
-#endif // CONFIG_DEVICE_LAYER && (CHIP_SYSTEM_CONFIG_USE_SOCKETS || CHIP_SYSTEM_CONFIG_USE_NETWORK_FRAMEWORK)
-
-    return CHIP_NO_ERROR;
-}
-
 CHIP_ERROR DeviceController::GetFabricId(uint64_t & fabricId)
 {
     Transport::FabricInfo * fabric = mFabrics.FindFabricWithIndex(mFabricIndex);

diff --git a/src/controller/CHIPDeviceController.h b/src/controller/CHIPDeviceController.h
@@ -290,14 +290,6 @@ class DLL_EXPORT DeviceController : public Messaging::ExchangeDelegate,
      */
     CHIP_ERROR ServiceEvents();
 
-    /**
-     * @brief
-     *   Allow the CHIP Stack to process any pending events
-     *   This can be called in an event handler loop to trigger callbacks within the CHIP stack
-     * @return CHIP_ERROR   The return status
-     */
-    CHIP_ERROR ServiceEventSignal();
-
     /**
      * @brief Get the Fabric ID assigned to the device.
      *

diff --git a/src/include/platform/PlatformManager.h b/src/include/platform/PlatformManager.h
@@ -27,6 +27,10 @@
 #include <platform/CHIPDeviceEvent.h>
 #include <system/SystemLayer.h>
 
+#if CHIP_SYSTEM_CONFIG_USE_LWIP
+#include <system/LwIPEventSupport.h>
+#endif // CHIP_SYSTEM_CONFIG_USE_LWIP
+
 namespace chip {
 
 namespace DeviceLayer {
@@ -176,7 +180,9 @@ class PlatformManager
     friend class Internal::GenericThreadStackManagerImpl_OpenThread_LwIP;
     template <class>
     friend class Internal::GenericConfigurationManagerImpl;
+#if CHIP_SYSTEM_CONFIG_USE_LWIP
     friend class System::PlatformEventing;
+#endif // CHIP_SYSTEM_CONFIG_USE_LWIP
 
     /*
      * PostEvent can be called safely on any thread without locking the stack.

diff --git a/src/inet/EndPointBasis.cpp b/src/inet/EndPointBasis.cpp
@@ -39,7 +39,7 @@ void EndPointBasis::InitEndPointBasis(InetLayer & aInetLayer, void * aAppState)
 #endif // CHIP_SYSTEM_CONFIG_USE_LWIP
 
 #if CHIP_SYSTEM_CONFIG_USE_SOCKETS
-    (void) mSocket.Init(aInetLayer.SystemLayer()->WatchableEventsManager());
+    mSocket = INET_INVALID_SOCKET_FD;
 #endif // CHIP_SYSTEM_CONFIG_USE_SOCKETS
 }
 

diff --git a/src/inet/EndPointBasis.h b/src/inet/EndPointBasis.h
@@ -35,7 +35,7 @@
 #include <support/DLLUtil.h>
 
 #if CHIP_SYSTEM_CONFIG_USE_SOCKETS
-#include <system/WatchableSocket.h>
+#include <system/SocketEvents.h>
 #endif // CHIP_SYSTEM_CONFIG_USE_SOCKETS
 
 #if CHIP_SYSTEM_CONFIG_USE_NETWORK_FRAMEWORK
@@ -97,8 +97,9 @@ class DLL_EXPORT EndPointBasis : public InetLayerBasis
 #endif
 
 #if CHIP_SYSTEM_CONFIG_USE_SOCKETS
-    System::WatchableSocket mSocket; /**< Encapsulated socket descriptor. */
+    int mSocket;                     /**< Encapsulated socket descriptor. */
     IPAddressType mAddrType;         /**< Protocol family, i.e. IPv4 or IPv6. */
+    System::SocketWatchToken mWatch; /**< Socket event watcher */
 #endif                               // CHIP_SYSTEM_CONFIG_USE_SOCKETS
 
 #if CHIP_SYSTEM_CONFIG_USE_LWIP
@@ -145,7 +146,7 @@ inline bool EndPointBasis::IsNetworkFrameworkEndPoint(void) const
 #if CHIP_SYSTEM_CONFIG_USE_SOCKETS
 inline bool EndPointBasis::IsSocketsEndPoint() const
 {
-    return mSocket.HasFD();
+    return mSocket != INET_INVALID_SOCKET_FD;
 }
 #endif // CHIP_SYSTEM_CONFIG_USE_SOCKETS