Dft xpc2 (project-chip#36719)

* [darwin-framework-tool][XPC] Add a XPC server registry. * [darwin-framework-tool][XPC] Add a XPC server for MTRDeviceControllerServerProtocol. * [darwin-framework-tool][XPC] Add a XPC server for MTRXPCServerProtocol
silabs-olivierb · Feb 19, 2025 · 3880312 · 3880312
1 parent c6a6537
commit 3880312
Show file tree

Hide file tree

Showing 9 changed files with 867 additions and 7 deletions.
diff --git a/examples/darwin-framework-tool/BUILD.gn b/examples/darwin-framework-tool/BUILD.gn
@@ -218,6 +218,9 @@ executable("darwin-framework-tool") {
     "commands/common/PreferencesStorage.mm",
     "commands/common/RemoteDataModelLogger.h",
     "commands/common/RemoteDataModelLogger.mm",
+    "commands/common/xpc/DeviceControllerServer.mm",
+    "commands/common/xpc/XPCServer.mm",
+    "commands/common/xpc/XPCServerRegistry.mm",
     "commands/configuration/Commands.h",
     "commands/configuration/ResetMRPParametersCommand.h",
     "commands/configuration/ResetMRPParametersCommand.mm",

diff --git a/examples/darwin-framework-tool/commands/common/CHIPCommandBridge.h b/examples/darwin-framework-tool/commands/common/CHIPCommandBridge.h
@@ -52,6 +52,7 @@ class CHIPCommandBridge : public Command {
         AddArgument("commissioner-vendor-id", 0, UINT16_MAX, &mCommissionerVendorId,
             "The vendor id to use for darwin-framework-tool. If not provided, chip::VendorId::TestVendor1 (65521, 0xFFF1) will be "
             "used.");
+        AddArgument("use-xpc", &mUseXPC, "Use a controller that will connect to an XPC endpoint instead of talking to devices directly. If a string argument is provided, it must identify a Mach service name that can be used to connect to a remote endpoint. If no argument is provided, a local endpoint will be used.");
     }
 
     /////////// Command Interface /////////
@@ -168,4 +169,5 @@ class CHIPCommandBridge : public Command {
     chip::Optional<char *> mPaaTrustStorePath;
     chip::Optional<chip::VendorId> mCommissionerVendorId;
     std::string mCurrentIdentity;
+    chip::Optional<chip::app::DataModel::Nullable<char *>> mUseXPC;
 };
diff --git a/examples/darwin-framework-tool/commands/common/CHIPCommandBridge.mm b/examples/darwin-framework-tool/commands/common/CHIPCommandBridge.mm
@@ -31,6 +31,8 @@
 #import "DeviceDelegate.h"
 #include "MTRError_Utils.h"
 
+#include "xpc/XPCServerRegistry.h"
+
 #include <map>
 #include <string>
 
@@ -45,6 +47,17 @@
 bool CHIPCommandBridge::sUseSharedStorage = true;
 constexpr char kTrustStorePathVariable[] = "PAA_TRUST_STORE_PATH";
 
+namespace {
+NSString * ToNSString(const chip::Optional<chip::app::DataModel::Nullable<char *>> & string)
+{
+    if (!string.HasValue() && string.Value().IsNull()) {
+        return nil;
+    }
+
+    return @(string.Value().Value());
+}
+}
+
 CHIP_ERROR CHIPCommandBridge::Run()
 {
     // In interactive mode, we want to avoid memory accumulating in the main autorelease pool,
@@ -143,6 +156,8 @@
         productAttestationAuthorityCertificates = nil;
     }
 
+    [[XPCServerRegistry sharedInstance] start];
+
     sUseSharedStorage = mCommissionerSharedStorage.ValueOr(false);
     if (sUseSharedStorage) {
         return SetUpStackWithSharedStorage(productAttestationAuthorityCertificates);
@@ -202,7 +217,13 @@
 
         params.productAttestationAuthorityCertificates = productAttestationAuthorityCertificates;
 
-        __auto_type * controller = [[MTRDeviceController alloc] initWithParameters:params error:&error];
+        MTRDeviceController * controller = nil;
+        if (mUseXPC.HasValue()) {
+            __auto_type * identifier = uuidString;
+            controller = [[XPCServerRegistry sharedInstance] createController:identifier serviceName:ToNSString(mUseXPC) params:params error:&error];
+        } else {
+            controller = [[MTRDeviceController alloc] initWithParameters:params error:&error];
+        }
         VerifyOrReturnError(nil != controller, MTRErrorToCHIPErrorCode(error), ChipLogError(chipTool, "Controller startup failure: %@", error));
         mControllers[identities[i]] = controller;
     }
@@ -237,12 +258,18 @@
             params.nodeId = @(mCommissionerNodeId.Value());
         }
 
-        // We're not sure whether we're creating a new fabric or using an existing one, so just try both.
-        auto controller = [factory createControllerOnExistingFabric:params error:&error];
-        if (controller == nil) {
-            // Maybe we didn't have this fabric yet.
-            params.vendorID = @(mCommissionerVendorId.ValueOr(chip::VendorId::TestVendor1));
-            controller = [factory createControllerOnNewFabric:params error:&error];
+        MTRDeviceController * controller = nil;
+        if (mUseXPC.HasValue()) {
+            __auto_type * identifier = @(identities[i]);
+            controller = [[XPCServerRegistry sharedInstance] createController:identifier serviceName:ToNSString(mUseXPC) params:params error:&error];
+        } else {
+            // We're not sure whether we're creating a new fabric or using an existing one, so just try both.
+            controller = [factory createControllerOnExistingFabric:params error:&error];
+            if (controller == nil) {
+                // Maybe we didn't have this fabric yet.
+                params.vendorID = @(mCommissionerVendorId.ValueOr(chip::VendorId::TestVendor1));
+                controller = [factory createControllerOnNewFabric:params error:&error];
+            }
         }
         VerifyOrReturnError(nil != controller, MTRErrorToCHIPErrorCode(error), ChipLogError(chipTool, "Controller startup failure: %@", error));
         mControllers[identities[i]] = controller;
@@ -256,6 +283,8 @@
     if (IsInteractive()) {
         return;
     }
+
+    [[XPCServerRegistry sharedInstance] stop];
     ShutdownCommissioner();
 }