Skip to contentSkip to conversation

doc: Document new BSS affinity method calls

PATCH New James Prestwood 1 participant 6 messages Jul 29, 2024

lore
Share & tools
lore
#0 lore raw

PATCH 1/6 doc: Document new BSS affinity method calls

This documents new DBus methods that expose a bit more control to how IWD roams. The new methods are:

SetConnectedBssAffinity()
UnsetConnectedBssAffinity()

Setting the affinity on the connected BSS effectively "locks" IWD to that BSS (except at critical RSSI levels, explained below). This can be useful for clients that have access to more information about the environment than IWD. For example, if a client is stationary there is likely no point in trying to roam until it has moved elsewhere.

A new main.conf option would also be added:

[General].CriticalRoamThreshold

This would be the new roam threshold set after SetConnectedBssAffinity() is called. If the RSSI continues to drop below this level IWD would (attempt to) roam.

---
 doc/station-api.txt | 22 ++++++++++++++++++++++
 src/iwd.config.rst  |  8 ++++++++
 2 files changed, 30 insertions(+)
doc/station-api.txt +22 -0
index 05dd137e..3dc2376b 100644
@@ -135,6 +135,28 @@ Methods		void Scan()
 			Possible Errors: [service].Error.InvalidArguments
 					 [service].Error.NotFound
 
+		void SetConnectedBssAffinity()
+
+			Sets a high affinity/preference to the currently
+			connected BSS. Specifically, calling this will reduce
+			the roam threshold down to a critical level set by
+			[General].CriticalRoamThreshold. This effectively locks
+			the client onto the current BSS unless the signal
+			quality becomes extremely poor.
+
+			If IWD roams or disconnects the affinity will be reset.
+
+			Possible Errors: net.connman.iwd.NotConnected
+
+		void UnsetConnectedBssAffinity()
+
+			Unset a prior call to SetConnectedBssAffinity(). This
+			moves the roaming threshold back up to the default level
+			(RoamThreshold/RoamThreshold5GHz).
+
+			Possible Errors: net.connman.iwd.NotConnected
+					 net.connman.iwd.NotConfigured
+
 Properties	string State [readonly]
 
 			Reflects the general network connection state.  One of:
src/iwd.config.rst +8 -0
index d9c94e01..31f43bc6 100644
@@ -130,6 +130,14 @@ The group ``[General]`` contains general settings.
        This value can be used to control how aggressively **iwd** roams when
        connected to a 5GHz access point.
 
+   * - CriticalRoamThreshold
+     - Value: rssi dBm value, from -100 to 1, default: **-82**
+
+       The threshold at which IWD will roam regardless of the affinity set to
+       the current BSS. This is only used if the SetConnectedBssAffinity() DBus
+       method is called, at which point this value becomes the new roam
+       threshold.
+
    * - RoamRetryInterval
      - Value: unsigned int value in seconds (default: **60**)
 
Signature · 1 line
2.34.1
#1 lore raw

PATCH 2/6 netdev: store signal threshold in netdev object, not globally

This prepares for the ability to toggle between two signal thresholds in netdev. Since each netdev may not need/want the same threshold store it in the netdev object rather than globally.

---
 src/netdev.c | 22 ++++++++++++++--------
 1 file changed, 14 insertions(+), 8 deletions(-)
src/netdev.c +14 -8
index 2d70fc38..db1ad380 100644
@@ -172,6 +172,9 @@ struct netdev {
 
 	struct netdev_ext_key_info *ext_key_info;
 
+	int low_signal_threshold;
+	int low_signal_threshold_5ghz;
+
 	bool connected : 1;
 	bool associated : 1;
 	bool operational : 1;
@@ -206,6 +209,9 @@ static struct l_genl_family *nl80211;
 static struct l_queue *netdev_list;
 static struct watchlist netdev_watches;
 static bool mac_per_ssid;
+/* Threshold RSSI for roaming to trigger, configurable in main.conf */
+static int LOW_SIGNAL_THRESHOLD;
+static int LOW_SIGNAL_THRESHOLD_5GHZ;
 
 static unsigned int iov_ie_append(struct iovec *iov,
 					unsigned int n_iov, unsigned int c,
@@ -1058,10 +1064,6 @@ struct netdev *netdev_find(int ifindex)
 	return l_queue_find(netdev_list, netdev_match, L_UINT_TO_PTR(ifindex));
 }
 
-/* Threshold RSSI for roaming to trigger, configurable in main.conf */
-static int LOW_SIGNAL_THRESHOLD;
-static int LOW_SIGNAL_THRESHOLD_5GHZ;
-
 static void netdev_cqm_event_rssi_threshold(struct netdev *netdev,
 						uint32_t rssi_event)
 {
@@ -1089,8 +1091,9 @@ static void netdev_cqm_event_rssi_value(struct netdev *netdev, int rssi_val)
 {
 	bool new_rssi_low;
 	uint8_t prev_rssi_level_idx = netdev->cur_rssi_level_idx;
-	int threshold = netdev->frequency > 4000 ? LOW_SIGNAL_THRESHOLD_5GHZ :
-						LOW_SIGNAL_THRESHOLD;
+	int threshold = netdev->frequency > 4000 ?
+					netdev->low_signal_threshold_5ghz :
+					netdev->low_signal_threshold;
 
 	if (!netdev->connected)
 		return;
@@ -3585,8 +3588,9 @@ static struct l_genl_msg *netdev_build_cmd_cqm_rssi_update(
 	uint32_t hyst = 5;
 	int thold_count;
 	int32_t thold_list[levels_num + 2];
-	int threshold = netdev->frequency > 4000 ? LOW_SIGNAL_THRESHOLD_5GHZ :
-						LOW_SIGNAL_THRESHOLD;
+	int threshold = netdev->frequency > 4000 ?
+					netdev->low_signal_threshold_5ghz :
+					netdev->low_signal_threshold;
 
 	if (levels_num == 0) {
 		thold_list[0] = threshold;
@@ -6164,6 +6168,8 @@ struct netdev *netdev_create_from_genl(struct l_genl_msg *msg,
 	l_strlcpy(netdev->name, ifname, IFNAMSIZ);
 	netdev->wiphy = wiphy;
 	netdev->pae_over_nl80211 = pae_io == NULL;
+	netdev->low_signal_threshold = LOW_SIGNAL_THRESHOLD;
+	netdev->low_signal_threshold_5ghz = LOW_SIGNAL_THRESHOLD_5GHZ;
 
 	if (set_mac)
 		memcpy(netdev->set_mac_once, set_mac, 6);
Signature · 1 line
2.34.1
#2 lore raw

PATCH 3/6 netdev: add critical signal threshold level

In reply to James Prestwood

This adds a secondary set of signal thresholds. The purpose of these are to provide more flexibility in how IWD roams. The critical threshold is intended to be temporary and is automatically reset upon any connection changes: disconnects, roams, or new connections.

---
 src/netdev.c | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++
 src/netdev.h |  2 ++
 2 files changed, 53 insertions(+)
src/netdev.c +51 -0
index db1ad380..852ad569 100644
@@ -212,6 +212,8 @@ static bool mac_per_ssid;
 /* Threshold RSSI for roaming to trigger, configurable in main.conf */
 static int LOW_SIGNAL_THRESHOLD;
 static int LOW_SIGNAL_THRESHOLD_5GHZ;
+static int CRITICAL_SIGNAL_THRESHOLD;
+static int CRITICAL_SIGNAL_THRESHOLD_5GHZ;
 
 static unsigned int iov_ie_append(struct iovec *iov,
 					unsigned int n_iov, unsigned int c,
@@ -841,6 +843,10 @@ static void netdev_connect_free(struct netdev *netdev)
 		l_genl_family_cancel(nl80211, netdev->get_oci_cmd_id);
 		netdev->get_oci_cmd_id = 0;
 	}
+
+	/* Reset thresholds back to default */
+	netdev->low_signal_threshold = LOW_SIGNAL_THRESHOLD;
+	netdev->low_signal_threshold_5ghz = LOW_SIGNAL_THRESHOLD_5GHZ;
 }
 
 static void netdev_connect_failed(struct netdev *netdev,
@@ -3674,6 +3680,39 @@ static int netdev_cqm_rssi_update(struct netdev *netdev)
 	return 0;
 }
 
+static int netdev_set_signal_thresholds(struct netdev *netdev, int threshold,
+					int threshold_5ghz)
+{
+	int current = netdev->frequency > 4000 ?
+					netdev->low_signal_threshold_5ghz :
+					netdev->low_signal_threshold;
+	int new = netdev->frequency > 4000 ? threshold_5ghz : threshold;
+
+	if (current == new)
+		return -EALREADY;
+
+	l_debug("changing low signal threshold to %d", new);
+
+	netdev->low_signal_threshold = threshold;
+	netdev->low_signal_threshold_5ghz = threshold_5ghz;
+
+	netdev_cqm_rssi_update(netdev);
+
+	return 0;
+}
+
+int netdev_lower_signal_threshold(struct netdev *netdev)
+{
+	return netdev_set_signal_thresholds(netdev, CRITICAL_SIGNAL_THRESHOLD,
+						CRITICAL_SIGNAL_THRESHOLD_5GHZ);
+}
+
+int netdev_raise_signal_threshold(struct netdev *netdev)
+{
+	return netdev_set_signal_thresholds(netdev, LOW_SIGNAL_THRESHOLD,
+						LOW_SIGNAL_THRESHOLD_5GHZ);
+}
+
 static bool netdev_connection_work_ready(struct wiphy_radio_work_item *item)
 {
 	struct netdev *netdev = l_container_of(item, struct netdev, work);
@@ -3884,6 +3923,8 @@ build_cmd_connect:
 	netdev->handshake = hs;
 	netdev->sm = sm;
 	netdev->cur_rssi = bss->signal_strength / 100;
+	netdev->low_signal_threshold = LOW_SIGNAL_THRESHOLD;
+	netdev->low_signal_threshold_5ghz = LOW_SIGNAL_THRESHOLD_5GHZ;
 
 	if (netdev->rssi_levels_num)
 		netdev_set_rssi_level_idx(netdev);
@@ -4257,6 +4298,8 @@ int netdev_ft_reassociate(struct netdev *netdev,
 	netdev->event_filter = event_filter;
 	netdev->connect_cb = cb;
 	netdev->user_data = user_data;
+	netdev->low_signal_threshold = LOW_SIGNAL_THRESHOLD;
+	netdev->low_signal_threshold_5ghz = LOW_SIGNAL_THRESHOLD_5GHZ;
 
 	/*
 	 * Cancel commands that could be running because of EAPoL activity
@@ -6279,6 +6322,14 @@ static int netdev_init(void)
 					&LOW_SIGNAL_THRESHOLD_5GHZ))
 		LOW_SIGNAL_THRESHOLD_5GHZ = -76;
 
+	if (!l_settings_get_int(settings, "General", "CriticalRoamThreshold",
+					&CRITICAL_SIGNAL_THRESHOLD))
+		CRITICAL_SIGNAL_THRESHOLD = -80;
+
+	if (!l_settings_get_int(settings, "General", "CriticalRoamThreshold5G",
+					&CRITICAL_SIGNAL_THRESHOLD_5GHZ))
+		CRITICAL_SIGNAL_THRESHOLD_5GHZ = -82;
+
 	rand_addr_str = l_settings_get_value(settings, "General",
 						"AddressRandomization");
 	if (rand_addr_str && !strcmp(rand_addr_str, "network"))
src/netdev.h +2 -0
index db0440d0..3a772256 100644
@@ -197,6 +197,8 @@ int netdev_neighbor_report_req(struct netdev *netdev,
 
 int netdev_set_rssi_report_levels(struct netdev *netdev, const int8_t *levels,
 					size_t levels_num);
+int netdev_lower_signal_threshold(struct netdev *netdev);
+int netdev_raise_signal_threshold(struct netdev *netdev);
 
 int netdev_get_station(struct netdev *netdev, const uint8_t *mac,
 			netdev_get_station_cb_t cb, void *user_data,
Signature · 1 line
2.34.1
#3 lore raw

PATCH 4/6 station: add {Set,Unset}ConnectedBssAffinity DBus methods

In reply to James Prestwood

These methods can be used to loosly lock IWD to its current BSS. Calling SetConnectedBssAffinity() will lower the roaming threshold to a critical level ([General].CriticalRoamThreshold) thereby preventing IWD from trying to roam unless the RSSI reaches this level.

The motivation for this is a use case in which an external client/daemon has additional information about the environment and can use this to make an informed decision about roaming. For example if the device is stationary its unlikely IWD will find a better roam target.

---
 src/station.c | 96 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 96 insertions(+)
src/station.c +96 -0
index db069981..dc07bacc 100644
@@ -128,6 +128,8 @@ struct station {
 
 	uint64_t last_roam_scan;
 
+	unsigned int affinity_watch;
+
 	bool preparing_roam : 1;
 	bool roam_scan_full : 1;
 	bool signal_low : 1;
@@ -1660,6 +1662,13 @@ static void station_enter_state(struct station *station,
 		station_set_evict_nocarrier(station, true);
 		station_set_drop_neighbor_discovery(station, false);
 		station_set_drop_unicast_l2_multicast(station, false);
+
+		if (station->affinity_watch) {
+			l_dbus_remove_watch(dbus_get_bus(),
+						station->affinity_watch);
+			station->affinity_watch = 0;
+		}
+
 		break;
 	case STATION_STATE_DISCONNECTING:
 	case STATION_STATE_NETCONFIG:
@@ -1668,6 +1677,13 @@ static void station_enter_state(struct station *station,
 	case STATION_STATE_FT_ROAMING:
 	case STATION_STATE_FW_ROAMING:
 		station_set_evict_nocarrier(station, false);
+
+		if (station->affinity_watch) {
+			l_dbus_remove_watch(dbus_get_bus(),
+						station->affinity_watch);
+			station->affinity_watch = 0;
+		}
+
 		break;
 	}
 
@@ -4328,6 +4344,79 @@ static struct l_dbus_message *station_dbus_signal_agent_unregister(
 	return l_dbus_message_new_method_return(message);
 }
 
+static int station_change_affinity(struct station *station, bool lower)
+{
+	if (!station->connected_network)
+		return -ENOTCONN;
+
+	if (lower)
+		return netdev_lower_signal_threshold(station->netdev);
+	else
+		return netdev_raise_signal_threshold(station->netdev);
+}
+
+static void station_affinity_disconnected_cb(struct l_dbus *dbus,
+						void *user_data)
+{
+	struct station *station = user_data;
+
+	l_debug("client that set affinity has disconnected, setting default");
+
+	/* The client who set the affinity disconnected, raise the threshold */
+	station_change_affinity(station, false);
+
+	station->affinity_watch = 0;
+}
+
+static struct l_dbus_message *station_dbus_set_affinity(
+						struct l_dbus *dbus,
+						struct l_dbus_message *message,
+						void *user_data)
+{
+	struct station *station = user_data;
+	int ret;
+
+	if (station->affinity_watch) {
+		l_warn("A client already set the affinity!");
+		return dbus_error_already_exists(message);
+	}
+
+	ret = station_change_affinity(station, true);
+	if (ret < 0)
+		return dbus_error_from_errno(ret, message);
+
+	station->affinity_watch = l_dbus_add_disconnect_watch(dbus,
+					l_dbus_message_get_sender(message),
+					station_affinity_disconnected_cb,
+					station,
+					NULL);
+
+	return l_dbus_message_new_method_return(message);
+}
+
+static struct l_dbus_message *station_dbus_unset_affinity(
+						struct l_dbus *dbus,
+						struct l_dbus_message *message,
+						void *user_data)
+{
+	struct station *station = user_data;
+	int ret;
+
+	if (!station->affinity_watch) {
+		l_warn("A client has not set the affinity!");
+		return dbus_error_not_configured(message);
+	}
+
+	ret = station_change_affinity(station, false);
+	if (ret < 0)
+		return dbus_error_from_errno(ret, message);
+
+	l_dbus_remove_watch(dbus, station->affinity_watch);
+	station->affinity_watch = 0;
+
+	return l_dbus_message_new_method_return(message);
+}
+
 static bool station_property_get_connected_network(struct l_dbus *dbus,
 					struct l_dbus_message *message,
 					struct l_dbus_message_builder *builder,
@@ -4722,6 +4811,9 @@ static void station_free(struct station *station)
 
 	l_queue_destroy(station->roam_bss_list, l_free);
 
+	if (station->affinity_watch)
+		l_dbus_remove_watch(dbus_get_bus(), station->affinity_watch);
+
 	l_free(station);
 }
 
@@ -4747,6 +4839,10 @@ static void station_setup_interface(struct l_dbus_interface *interface)
 	l_dbus_interface_method(interface, "UnregisterSignalLevelAgent", 0,
 				station_dbus_signal_agent_unregister,
 				"", "o", "path");
+	l_dbus_interface_method(interface, "SetConnectedBssAffinity", 0,
+				station_dbus_set_affinity, "", "");
+	l_dbus_interface_method(interface, "UnsetConnectedBssAffinity", 0,
+				station_dbus_unset_affinity, "", "");
 
 	l_dbus_interface_property(interface, "ConnectedNetwork", 0, "o",
 					station_property_get_connected_network,
Signature · 1 line
2.34.1
#4 lore raw

PATCH 5/6 auto-t: add set/unset affinity python methods

In reply to James Prestwood
---
 autotests/util/iwd.py | 10 ++++++++++
 1 file changed, 10 insertions(+)
autotests/util/iwd.py +10 -0
index 1d4a5472..211f3777 100755
@@ -940,6 +940,16 @@ class Device(IWDDBusAbstract):
 
         return ret
 
+    def set_connected_bss_affinity(self):
+        self._station.SetConnectedBssAffinity(reply_handler=self._success,
+                                        error_handler=self._failure)
+        self._wait_for_async_op()
+
+    def unset_connected_bss_affinity(self):
+        self._station.UnsetConnectedBssAffinity(reply_handler=self._success,
+                                        error_handler=self._failure)
+        self._wait_for_async_op()
+
     def __str__(self, prefix = ''):
         s = prefix + 'Device: ' + self.device_path + '\n'\
                + prefix + '\tName:\t\t' + self.name + '\n'\
Signature · 1 line
2.34.1
#5 lore raw

PATCH 6/6 auto-t: add tests for set/unset affinity

In reply to James Prestwood
---
 autotests/testSetAffinity/TestFT.psk          |   2 +
 autotests/testSetAffinity/ft-psk-ccmp-1.conf  |  41 ++++
 autotests/testSetAffinity/ft-psk-ccmp-2.conf  |  41 ++++
 autotests/testSetAffinity/hw.conf             |   8 +
 autotests/testSetAffinity/main.conf           |   5 +
 .../testSetAffinity/test_set_affinity.py      | 224 ++++++++++++++++++
 6 files changed, 321 insertions(+)
 create mode 100644 autotests/testSetAffinity/TestFT.psk
 create mode 100644 autotests/testSetAffinity/ft-psk-ccmp-1.conf
 create mode 100644 autotests/testSetAffinity/ft-psk-ccmp-2.conf
 create mode 100644 autotests/testSetAffinity/hw.conf
 create mode 100644 autotests/testSetAffinity/main.conf
 create mode 100644 autotests/testSetAffinity/test_set_affinity.py
autotests/testSetAffinity/TestFT.psk new file +2 -0
new file mode 100644
index 00000000..e82d1295
@@ -0,0 +1,2 @@
+[Security]
+Passphrase=EasilyGuessedPassword
autotests/testSetAffinity/ft-psk-ccmp-1.conf new file +41 -0

41 lines not on this page · raw message

autotests/testSetAffinity/ft-psk-ccmp-2.conf new file +41 -0

41 lines not on this page · raw message

autotests/testSetAffinity/hw.conf new file +8 -0
new file mode 100644
index 00000000..c2b35d6e
@@ -0,0 +1,8 @@
+[SETUP]
+num_radios=3
+start_iwd=0
+hwsim_medium=yes
+
+[HOSTAPD]
+rad0=ft-psk-ccmp-1.conf
+rad1=ft-psk-ccmp-2.conf
autotests/testSetAffinity/main.conf new file +5 -0
new file mode 100644
index 00000000..3d93ff57
@@ -0,0 +1,5 @@
+[Scan]
+DisableMacAddressRandomization=true
+
+[General]
+RoamRetryInterval=1
autotests/testSetAffinity/test_set_affinity.py new file +224 -0

224 lines not on this page · raw message

Signature · 1 line
2.34.1