Adds DBus APIs to attempt a leader takeover operation as well as write method

to the LocalLeaderWeight property, in order to set the local leader weight

Author: nand-nor

src/dbus/common/constants.hpp

@@ -69,6 +69,7 @@
 #define OTBR_DBUS_DEACTIVATE_EPHEMERAL_KEY_MODE_METHOD "DeactivateEphemeralKeyMode"
 #define OTBR_DBUS_SCHEDULE_MIGRATION_METHOD "ScheduleMigration"
 #define OTBR_DBUS_HOST_POWER_STATE_METHOD "SetHostPowerState"
+#define OTBR_DBUS_TAKEOVER_LEADER_METHOD "TakeoverLeader"
 
 #define OTBR_DBUS_PROPERTY_MESH_LOCAL_PREFIX "MeshLocalPrefix"
 #define OTBR_DBUS_PROPERTY_LINK_MODE "LinkMode"

src/dbus/server/dbus_thread_object_rcp.cpp

@@ -173,6 +173,8 @@ otbrError DBusThreadObjectRcp::Init(void)
     RegisterMethod(OTBR_DBUS_THREAD_INTERFACE, OTBR_DBUS_DEACTIVATE_EPHEMERAL_KEY_MODE_METHOD,
                    std::bind(&DBusThreadObjectRcp::DeactivateEphemeralKeyModeHandler, this, _1));
 #endif
+    RegisterMethod(OTBR_DBUS_THREAD_INTERFACE, OTBR_DBUS_TAKEOVER_LEADER_METHOD,
+                   std::bind(&DBusThreadObjectRcp::TakeoverLeaderHandler, this, _1));
     RegisterMethod(DBUS_INTERFACE_INTROSPECTABLE, DBUS_INTROSPECT_METHOD,
                    std::bind(&DBusThreadObjectRcp::IntrospectHandler, this, _1));
 
@@ -194,6 +196,8 @@ otbrError DBusThreadObjectRcp::Init(void)
     RegisterSetPropertyHandler(OTBR_DBUS_THREAD_INTERFACE, OTBR_DBUS_PROPERTY_EPHEMERAL_KEY_ENABLED,
                                std::bind(&DBusThreadObjectRcp::SetEphemeralKeyEnabled, this, _1));
 #endif
+    RegisterSetPropertyHandler(OTBR_DBUS_THREAD_INTERFACE, OTBR_DBUS_PROPERTY_LOCAL_LEADER_WEIGHT,
+                               std::bind(&DBusThreadObjectRcp::SetLocalLeaderWeightHandler, this, _1));
 
     RegisterGetPropertyHandler(OTBR_DBUS_THREAD_INTERFACE, OTBR_DBUS_PROPERTY_LINK_MODE,
                                std::bind(&DBusThreadObjectRcp::GetLinkModeHandler, this, _1));
@@ -987,6 +991,19 @@ otError DBusThreadObjectRcp::GetLocalLeaderWeightHandler(DBusMessageIter &aIter)
     return error;
 }
 
+otError DBusThreadObjectRcp::SetLocalLeaderWeightHandler(DBusMessageIter &aIter)
+{
+    auto    threadHelper = mHost.GetThreadHelper();
+    otError error        = OT_ERROR_NONE;
+    uint8_t weight;
+
+    VerifyOrExit(DBusMessageExtractFromVariant(&aIter, weight) == OTBR_ERROR_NONE, error = OT_ERROR_INVALID_ARGS);
+    otThreadSetLocalLeaderWeight(threadHelper->GetInstance(), weight);
+
+exit:
+    return error;
+}
+
 otError DBusThreadObjectRcp::GetChannelMonitorSampleCountHandler(DBusMessageIter &aIter)
 {
 #if OPENTHREAD_CONFIG_CHANNEL_MONITOR_ENABLE
@@ -1906,6 +1923,19 @@ void DBusThreadObjectRcp::LeaveNetworkHandler(DBusRequest &aRequest)
     });
 }
 
+void DBusThreadObjectRcp::TakeoverLeaderHandler(DBusRequest &aRequest)
+{
+    auto         threadHelper = mHost.GetThreadHelper();
+    otError      error        = OT_ERROR_NONE;
+    otDeviceRole role         = otThreadGetDeviceRole(threadHelper->GetInstance());
+
+    VerifyOrExit(role != OT_DEVICE_ROLE_DISABLED && role != OT_DEVICE_ROLE_DETACHED, error = OT_ERROR_INVALID_STATE);
+    SuccessOrExit(error = otThreadBecomeLeader(threadHelper->GetInstance()));
+
+exit:
+    aRequest.ReplyOtResult(error);
+}
+
 #if OTBR_ENABLE_NAT64
 void DBusThreadObjectRcp::SetNat64Enabled(DBusRequest &aRequest)
 {

src/dbus/server/dbus_thread_object_rcp.hpp

@@ -112,6 +112,7 @@ class DBusThreadObjectRcp : public DBusObject
     void ActivateEphemeralKeyModeHandler(DBusRequest &aRequest);
     void DeactivateEphemeralKeyModeHandler(DBusRequest &aRequest);
 #endif
+    void TakeoverLeaderHandler(DBusRequest &aRequest);
 
     void IntrospectHandler(DBusRequest &aRequest);
 
@@ -126,6 +127,7 @@ class DBusThreadObjectRcp : public DBusObject
 #if OTBR_ENABLE_EPSKC
     otError SetEphemeralKeyEnabled(DBusMessageIter &aIter);
 #endif
+    otError SetLocalLeaderWeightHandler(DBusMessageIter &aIter);
 
     otError GetLinkModeHandler(DBusMessageIter &aIter);
     otError GetDeviceRoleHandler(DBusMessageIter &aIter);

src/dbus/server/introspect.xml

@@ -262,6 +262,10 @@
       <arg name="retain_active_session" type="b" direction="in"/>
     </method>
 
+    <!-- TakeoverLeader: Takeover as the current partition leader if possible. -->
+    <method name="TakeoverLeader">
+    </method>
+
     <!-- MeshLocalPrefix: The /64 mesh-local prefix.  -->
     <property name="MeshLocalPrefix" type="ay" access="readwrite">
       <annotation name="org.freedesktop.DBus.Property.EmitsChangedSignal" value="false"/>
@@ -428,8 +432,8 @@
       <annotation name="org.freedesktop.DBus.Property.EmitsChangedSignal" value="false"/>
     </property>
 
-    <!-- LocalLeaderWeight: The leader weight of the current node. -->
-    <property name="LocalLeaderWeight" type="y" access="read">
+    <!-- LocalLeaderWeight: Get or set the leader weight of the current node. -->
+    <property name="LocalLeaderWeight" type="y" access="readwrite">
       <annotation name="org.freedesktop.DBus.Property.EmitsChangedSignal" value="false"/>
     </property>