mirror of
https://gitlab.freedesktop.org/NetworkManager/NetworkManager
synced 2024-07-22 02:35:25 +00:00
![Thomas Haller](/assets/img/avatar_default.png)
No longer use GDBusObjectMangaerClient and gdbus-codegen generated classes for the NMClient cache. Instead, use GDBusConnection directly and a custom implementation (NMLDBusObject) for caching D-Bus' ObjectManager data. CHANGES ------- - This is a complete rework. I think the previous implementation was difficult to understand. There were unfixed bugs and nobody understood the code well enough to fix them. Maybe somebody out there understood the code, but I certainly did not. At least nobody provided patches to fix those issues. I do believe that this implementation is more straightforward and easier to understand. It removes a lot of layers of code. Whether this claim of simplicity is true, each reader must decide for himself/herself. Note that it is still fairly complex. - There was a lingering performance issue with large number of D-Bus objects. The patch tries hard that the implementation scales well. Of course, when we cache N objects that have N-to-M references to other, we still are fundamentally O(N*M) for runtime and memory consumption (with M being the number of references between objects). But each part should behave efficiently and well. - Play well with GMainContext. libnm code (NMClient) is generally not thread safe. However, it should work to use multiple instances in parallel, as long as each access to a NMClient is through the caller's GMainContext. This follows glib's style and effectively allows to use NMClient in a multi threaded scenario. This implies to stick to a main context upon construction and ensure that callbacks are only invoked when iterating that context. Also, NMClient itself shall never iterate the caller's context. This also means, libnm must never use g_idle_add() or g_timeout_add(), as those enqueue sources in the g_main_context_default() context. - Get ordering of messages right. All events are consistently enqueued in a GMainContext and processed strictly in order. For example, previously "nm-object.c" tried to combine signals and emit them on an idle handler. That is wrong, signals must be emitted in the right order and when they happen. Note that when using GInitable's synchronous initialization to initialize the NMClient instance, NMClient internally still operates fully asynchronously. In that case NMClient has an internal main context. - NMClient takes over most of the functionality. When using D-Bus' ObjectManager interface, one needs to handle basically the entire state of the D-Bus interface. That cannot be separated well into distinct parts, and even if you try, you just end up having closely related code in different source files. Spreading related code does not make it easier to understand, on the contrary. That means, NMClient is inherently complex as it contains most of the logic. I think that is not avoidable, but it's not as bad as it sounds. - NMClient processes D-Bus messages and state changes in separate steps. First NMClient unpacks the message (e.g. _dbus_handle_properties_changed()) and keeps track of the changed data. Then we update the GObject instances (_dbus_handle_obj_changed_dbus()) without emitting any signals yet. Finally, we emit all signals and notifications that were collected (_dbus_handle_changes_commit()). Note that for example during the initial GetManagedObjects() reply, NMClient receive a large amount of state at once. But we first apply all the changes to our GObject instances before emitting any signals. The result is that signals are always emitted in a moment when the cache is consistent. The unavoidable downside is that when you receive a property changed signal, possibly many other properties changed already and more signals are about to be emitted. - NMDeviceWifi no longer modifies the content of the cache from client side during poke_wireless_devices_with_rf_status(). The content of the cache should be determined by D-Bus alone and follow what NetworkManager service exposes. Local modifications should be avoided. - This aims to bring no API/ABI change, though it does of course bring various subtle changes in behavior. Those should be all for the better, but the goal is not to break any existing clients. This does change internal (albeit externally visible) API, like dropping NM_OBJECT_DBUS_OBJECT_MANAGER property and NMObject no longer implementing GInitableIface and GAsyncInitableIface. - Some uses of gdbus-codegen classes remain in NMVpnPluginOld, NMVpnServicePlugin and NMSecretAgentOld. These are independent of NMClient/NMObject and should be reworked separately. - While we no longer use generated classes from gdbus-codegen, we don't need more glue code than before. Also before we constructed NMPropertiesInfo and a had large amount of code to propagate properties from NMDBus* to NMObject. That got completely reworked, but did not fundamentally change. You still need about the same effort to create the NMLDBusMetaIface. Not using generated bindings did not make anything worse (which tells about the usefulness of generated code, at least in the way it was used). - NMLDBusMetaIface and other meta data is static and immutable. This avoids copying them around. Also, macros like NML_DBUS_META_PROPERTY_INIT_U() have compile time checks to ensure the property types matches. It's pretty hard to misuse them because it won't compile. - The meta data now explicitly encodes the expected D-Bus types and makes sure never to accept wrong data. That would only matter when the server (accidentally or intentionally) exposes unexpected types on D-Bus. I don't think that was previously ensured in all cases. For example, demarshal_generic() only cared about the GObject property type, it didn't know the expected D-Bus type. - Previously GDBusObjectManager would sometimes emit warnings (g_log()). Those probably indicated real bugs. In any case, it prevented us from running CI with G_DEBUG=fatal-warnings, because there would be just too many unrelated crashes. Now we log debug messages that can be enabled with "LIBNM_CLIENT_DEBUG=trace". Some of these messages can also be turned into g_warning()/g_critical() by setting LIBNM_CLIENT_DEBUG=warning,error. Together with G_DEBUG=fatal-warnings, this turns them into assertions. Note that such "assertion failures" might also happen because of a server bug (or change). Thus these are not common assertions that indicate a bug in libnm and are thus not armed unless explicitly requested. In our CI we should now always run with LIBNM_CLIENT_DEBUG=warning,error and G_DEBUG=fatal-warnings and to catch bugs. Note that currently NetworkManager has bugs in this regard, so enabling this will result in assertion failures. That should be fixed first. - Note that this changes the order in which we emit "notify:devices" and "device-added" signals. I think it makes the most sense to emit first "device-removed", then "notify:devices", and finally "device-added" signals. This changes behavior for commit52ae28f6e5
('libnm: queue added/removed signals and suppress uninitialized notifications'), but I don't think that users should actually rely on the order. Still, the new order makes the most sense to me. - In NetworkManager, profiles can be invisible to the user by setting "connection.permissions". Such profiles would be hidden by NMClient's nm_client_get_connections() and their "connection-added"/"connection-removed" signals. Note that NMActiveConnection's nm_active_connection_get_connection() and NMDevice's nm_device_get_available_connections() still exposes such hidden NMRemoteConnection instances. This behavior was preserved. NUMBERS ------- I compared 3 versions of libnm. [1]962297f908
, current tip of nm-1-20 branch [2]4fad8c7c64
, current master, immediate parent of this patch [3] this patch All tests were done on Fedora 31, x86_64, gcc 9.2.1-1.fc31. The libraries were build with $ ./contrib/fedora/rpm/build_clean.sh -g -w test -W debug Note that RPM build already stripped the library. --- N1) File size of libnm.so.0.1.0 in bytes. There currently seems to be a issue on Fedora 31 generating wrong ELF notes. Usually, libnm is smaller but in these tests it had large (and bogus) ELF notes. Anyway, the point is to show the relative sizes, so it doesn't matter). [1] 4075552 (102.7%) [2] 3969624 (100.0%) [3] 3705208 ( 93.3%) --- N2) `size /usr/lib64/libnm.so.0.1.0`: text data bss dec hex filename [1] 1314569 (102.0%) 69980 ( 94.8%) 10632 ( 80.4%) 1395181 (101.4%) 1549ed /usr/lib64/libnm.so.0.1.0 [2] 1288410 (100.0%) 73796 (100.0%) 13224 (100.0%) 1375430 (100.0%) 14fcc6 /usr/lib64/libnm.so.0.1.0 [3] 1229066 ( 95.4%) 65248 ( 88.4%) 13400 (101.3%) 1307714 ( 95.1%) 13f442 /usr/lib64/libnm.so.0.1.0 --- N3) Performance test with test-client.py. With checkout of [2], run ``` prepare_checkout() { rm -rf /tmp/nm-test && \ git checkout -B test4fad8c7c64
&& \ git clean -fdx && \ ./autogen.sh --prefix=/tmp/nm-test && \ make -j 5 install && \ make -j 5 check-local-clients-tests-test-client } prepare_test() { NM_TEST_REGENERATE=1 NM_TEST_CLIENT_BUILDDIR="/data/src/NetworkManager" NM_TEST_CLIENT_NMCLI_PATH=/usr/bin/nmcli python3 ./clients/tests/test-client.py -v } do_test() { for i in {1..10}; do NM_TEST_CLIENT_BUILDDIR="/data/src/NetworkManager" NM_TEST_CLIENT_NMCLI_PATH=/usr/bin/nmcli python3 ./clients/tests/test-client.py -v || return -1 done echo "done!" } prepare_checkout prepare_test time do_test ``` [1] real 2m14.497s (101.3%) user 5m26.651s (100.3%) sys 1m40.453s (101.4%) [2] real 2m12.800s (100.0%) user 5m25.619s (100.0%) sys 1m39.065s (100.0%) [3] real 1m54.915s ( 86.5%) user 4m18.585s ( 79.4%) sys 1m32.066s ( 92.9%) --- N4) Performance. Run NetworkManager from build [2] and setup a large number of profiles (551 profiles and 515 devices, mostly unrealized). This setup is already at the edge of what NetworkManager currently can handle. Of course, that is a different issue. Here we just check how long plain `nmcli` takes on the system. ``` do_cleanup() { for UUID in $(nmcli -g NAME,UUID connection show | sed -n 's/^xx-c-.*:\([^:]\+\)$/\1/p'); do nmcli connection delete uuid "$UUID" done for DEVICE in $(nmcli -g DEVICE device status | grep '^xx-i-'); do nmcli device delete "$DEVICE" done } do_setup() { do_cleanup for i in {1..30}; do nmcli connection add type bond autoconnect no con-name xx-c-bond-$i ifname xx-i-bond-$i ipv4.method disabled ipv6.method ignore for j in $(seq $i 30); do nmcli connection add type vlan autoconnect no con-name xx-c-vlan-$i-$j vlan.id $j ifname xx-i-vlan-$i-$j vlan.parent xx-i-bond-$i ipv4.method disabled ipv6.method ignore done done systemctl restart NetworkManager.service sleep 5 } do_test() { perf stat -r 50 -B nmcli 1>/dev/null } do_test ``` [1] Performance counter stats for 'nmcli' (50 runs): 456.33 msec task-clock:u # 1.093 CPUs utilized ( +- 0.44% ) 0 context-switches:u # 0.000 K/sec 0 cpu-migrations:u # 0.000 K/sec 5,900 page-faults:u # 0.013 M/sec ( +- 0.02% ) 1,408,675,453 cycles:u # 3.087 GHz ( +- 0.48% ) 1,594,741,060 instructions:u # 1.13 insn per cycle ( +- 0.02% ) 368,744,018 branches:u # 808.061 M/sec ( +- 0.02% ) 4,566,058 branch-misses:u # 1.24% of all branches ( +- 0.76% ) 0.41761 +- 0.00282 seconds time elapsed ( +- 0.68% ) [2] Performance counter stats for 'nmcli' (50 runs): 477.99 msec task-clock:u # 1.088 CPUs utilized ( +- 0.36% ) 0 context-switches:u # 0.000 K/sec 0 cpu-migrations:u # 0.000 K/sec 5,948 page-faults:u # 0.012 M/sec ( +- 0.03% ) 1,471,133,482 cycles:u # 3.078 GHz ( +- 0.36% ) 1,655,275,369 instructions:u # 1.13 insn per cycle ( +- 0.02% ) 382,595,152 branches:u # 800.433 M/sec ( +- 0.02% ) 4,746,070 branch-misses:u # 1.24% of all branches ( +- 0.49% ) 0.43923 +- 0.00242 seconds time elapsed ( +- 0.55% ) [3] Performance counter stats for 'nmcli' (50 runs): 352.36 msec task-clock:u # 1.027 CPUs utilized ( +- 0.32% ) 0 context-switches:u # 0.000 K/sec 0 cpu-migrations:u # 0.000 K/sec 4,790 page-faults:u # 0.014 M/sec ( +- 0.26% ) 1,092,341,186 cycles:u # 3.100 GHz ( +- 0.26% ) 1,209,045,283 instructions:u # 1.11 insn per cycle ( +- 0.02% ) 281,708,462 branches:u # 799.499 M/sec ( +- 0.01% ) 3,101,031 branch-misses:u # 1.10% of all branches ( +- 0.61% ) 0.34296 +- 0.00120 seconds time elapsed ( +- 0.35% ) --- N5) same setup as N4), but run `PAGER= /bin/time -v nmcli`: [1] Command being timed: "nmcli" User time (seconds): 0.42 System time (seconds): 0.04 Percent of CPU this job got: 107% Elapsed (wall clock) time (h:mm:ss or m:ss): 0:00.43 Average shared text size (kbytes): 0 Average unshared data size (kbytes): 0 Average stack size (kbytes): 0 Average total size (kbytes): 0 Maximum resident set size (kbytes): 34456 Average resident set size (kbytes): 0 Major (requiring I/O) page faults: 0 Minor (reclaiming a frame) page faults: 6128 Voluntary context switches: 1298 Involuntary context switches: 1106 Swaps: 0 File system inputs: 0 File system outputs: 0 Socket messages sent: 0 Socket messages received: 0 Signals delivered: 0 Page size (bytes): 4096 Exit status: 0 [2] Command being timed: "nmcli" User time (seconds): 0.44 System time (seconds): 0.04 Percent of CPU this job got: 108% Elapsed (wall clock) time (h:mm:ss or m:ss): 0:00.44 Average shared text size (kbytes): 0 Average unshared data size (kbytes): 0 Average stack size (kbytes): 0 Average total size (kbytes): 0 Maximum resident set size (kbytes): 34452 Average resident set size (kbytes): 0 Major (requiring I/O) page faults: 0 Minor (reclaiming a frame) page faults: 6169 Voluntary context switches: 1849 Involuntary context switches: 142 Swaps: 0 File system inputs: 0 File system outputs: 0 Socket messages sent: 0 Socket messages received: 0 Signals delivered: 0 Page size (bytes): 4096 Exit status: 0 [3] Command being timed: "nmcli" User time (seconds): 0.32 System time (seconds): 0.02 Percent of CPU this job got: 102% Elapsed (wall clock) time (h:mm:ss or m:ss): 0:00.34 Average shared text size (kbytes): 0 Average unshared data size (kbytes): 0 Average stack size (kbytes): 0 Average total size (kbytes): 0 Maximum resident set size (kbytes): 29196 Average resident set size (kbytes): 0 Major (requiring I/O) page faults: 0 Minor (reclaiming a frame) page faults: 5059 Voluntary context switches: 919 Involuntary context switches: 685 Swaps: 0 File system inputs: 0 File system outputs: 0 Socket messages sent: 0 Socket messages received: 0 Signals delivered: 0 Page size (bytes): 4096 Exit status: 0 --- N6) same setup as N4), but run `nmcli monitor` and look at `ps aux` for the RSS size. USER PID %CPU %MEM VSZ RSS TTY STAT START TIME COMMAND [1] me 1492900 21.0 0.2 461348 33248 pts/10 Sl+ 15:02 0:00 nmcli monitor [2] me 1490721 5.0 0.2 461496 33548 pts/10 Sl+ 15:00 0:00 nmcli monitor [3] me 1495801 16.5 0.1 459476 28692 pts/10 Sl+ 15:04 0:00 nmcli monitor
637 lines
18 KiB
C
637 lines
18 KiB
C
// SPDX-License-Identifier: LGPL-2.1+
|
|
/*
|
|
* Copyright (C) 2007 - 2008 Novell, Inc.
|
|
* Copyright (C) 2007 - 2011 Red Hat, Inc.
|
|
*/
|
|
|
|
#include "nm-default.h"
|
|
|
|
#include "nm-access-point.h"
|
|
|
|
#include "nm-connection.h"
|
|
#include "nm-setting-connection.h"
|
|
#include "nm-setting-wireless.h"
|
|
#include "nm-setting-wireless-security.h"
|
|
#include "nm-utils.h"
|
|
|
|
#include "nm-dbus-interface.h"
|
|
#include "nm-object-private.h"
|
|
|
|
/*****************************************************************************/
|
|
|
|
NM_GOBJECT_PROPERTIES_DEFINE (NMAccessPoint,
|
|
PROP_FLAGS,
|
|
PROP_WPA_FLAGS,
|
|
PROP_RSN_FLAGS,
|
|
PROP_SSID,
|
|
PROP_FREQUENCY,
|
|
PROP_HW_ADDRESS,
|
|
PROP_MODE,
|
|
PROP_MAX_BITRATE,
|
|
PROP_STRENGTH,
|
|
PROP_BSSID,
|
|
PROP_LAST_SEEN,
|
|
);
|
|
|
|
typedef struct {
|
|
GBytes *ssid;
|
|
char *bssid;
|
|
guint32 flags;
|
|
guint32 wpa_flags;
|
|
guint32 rsn_flags;
|
|
guint32 frequency;
|
|
guint32 mode;
|
|
guint32 max_bitrate;
|
|
gint32 last_seen;
|
|
guint8 strength;
|
|
} NMAccessPointPrivate;
|
|
|
|
struct _NMAccessPoint {
|
|
NMObject parent;
|
|
NMAccessPointPrivate _priv;
|
|
};
|
|
|
|
struct _NMAccessPointClass {
|
|
NMObjectClass parent;
|
|
};
|
|
|
|
G_DEFINE_TYPE (NMAccessPoint, nm_access_point, NM_TYPE_OBJECT)
|
|
|
|
#define NM_ACCESS_POINT_GET_PRIVATE(self) _NM_GET_PRIVATE(self, NMAccessPoint, NM_IS_ACCESS_POINT, NMObject)
|
|
|
|
/*****************************************************************************/
|
|
|
|
/**
|
|
* nm_access_point_get_flags:
|
|
* @ap: a #NMAccessPoint
|
|
*
|
|
* Gets the flags of the access point.
|
|
*
|
|
* Returns: the flags
|
|
**/
|
|
NM80211ApFlags
|
|
nm_access_point_get_flags (NMAccessPoint *ap)
|
|
{
|
|
g_return_val_if_fail (NM_IS_ACCESS_POINT (ap), NM_802_11_AP_FLAGS_NONE);
|
|
|
|
return NM_ACCESS_POINT_GET_PRIVATE (ap)->flags;
|
|
}
|
|
|
|
/**
|
|
* nm_access_point_get_wpa_flags:
|
|
* @ap: a #NMAccessPoint
|
|
*
|
|
* Gets the WPA (version 1) flags of the access point.
|
|
*
|
|
* Returns: the WPA flags
|
|
**/
|
|
NM80211ApSecurityFlags
|
|
nm_access_point_get_wpa_flags (NMAccessPoint *ap)
|
|
{
|
|
g_return_val_if_fail (NM_IS_ACCESS_POINT (ap), NM_802_11_AP_SEC_NONE);
|
|
|
|
return NM_ACCESS_POINT_GET_PRIVATE (ap)->wpa_flags;
|
|
}
|
|
|
|
/**
|
|
* nm_access_point_get_rsn_flags:
|
|
* @ap: a #NMAccessPoint
|
|
*
|
|
* Gets the RSN (Robust Secure Network, ie WPA version 2) flags of the access
|
|
* point.
|
|
*
|
|
* Returns: the RSN flags
|
|
**/
|
|
NM80211ApSecurityFlags
|
|
nm_access_point_get_rsn_flags (NMAccessPoint *ap)
|
|
{
|
|
g_return_val_if_fail (NM_IS_ACCESS_POINT (ap), NM_802_11_AP_SEC_NONE);
|
|
|
|
return NM_ACCESS_POINT_GET_PRIVATE (ap)->rsn_flags;
|
|
}
|
|
|
|
/**
|
|
* nm_access_point_get_ssid:
|
|
* @ap: a #NMAccessPoint
|
|
*
|
|
* Gets the SSID of the access point.
|
|
*
|
|
* Returns: (transfer none): the #GBytes containing the SSID, or %NULL if the
|
|
* SSID is unknown.
|
|
**/
|
|
GBytes *
|
|
nm_access_point_get_ssid (NMAccessPoint *ap)
|
|
{
|
|
NMAccessPointPrivate *priv;
|
|
|
|
g_return_val_if_fail (NM_IS_ACCESS_POINT (ap), NULL);
|
|
|
|
priv = NM_ACCESS_POINT_GET_PRIVATE (ap);
|
|
nm_assert (!priv->ssid || g_bytes_get_size (priv->ssid) > 0);
|
|
return priv->ssid;
|
|
}
|
|
|
|
/**
|
|
* nm_access_point_get_frequency:
|
|
* @ap: a #NMAccessPoint
|
|
*
|
|
* Gets the frequency of the access point in MHz.
|
|
*
|
|
* Returns: the frequency in MHz
|
|
**/
|
|
guint32
|
|
nm_access_point_get_frequency (NMAccessPoint *ap)
|
|
{
|
|
g_return_val_if_fail (NM_IS_ACCESS_POINT (ap), 0);
|
|
|
|
return NM_ACCESS_POINT_GET_PRIVATE (ap)->frequency;
|
|
}
|
|
|
|
/**
|
|
* nm_access_point_get_bssid:
|
|
* @ap: a #NMAccessPoint
|
|
*
|
|
* Gets the Basic Service Set ID (BSSID) of the Wi-Fi access point.
|
|
*
|
|
* Returns: the BSSID of the access point. This is an internal string and must
|
|
* not be modified or freed.
|
|
**/
|
|
const char *
|
|
nm_access_point_get_bssid (NMAccessPoint *ap)
|
|
{
|
|
g_return_val_if_fail (NM_IS_ACCESS_POINT (ap), NULL);
|
|
|
|
return _nml_coerce_property_str_not_empty (NM_ACCESS_POINT_GET_PRIVATE (ap)->bssid);
|
|
}
|
|
|
|
/**
|
|
* nm_access_point_get_mode:
|
|
* @ap: a #NMAccessPoint
|
|
*
|
|
* Gets the mode of the access point.
|
|
*
|
|
* Returns: the mode
|
|
**/
|
|
NM80211Mode
|
|
nm_access_point_get_mode (NMAccessPoint *ap)
|
|
{
|
|
g_return_val_if_fail (NM_IS_ACCESS_POINT (ap), 0);
|
|
|
|
return NM_ACCESS_POINT_GET_PRIVATE (ap)->mode;
|
|
}
|
|
|
|
/**
|
|
* nm_access_point_get_max_bitrate:
|
|
* @ap: a #NMAccessPoint
|
|
*
|
|
* Gets the maximum bit rate of the access point in kbit/s.
|
|
*
|
|
* Returns: the maximum bit rate (kbit/s)
|
|
**/
|
|
guint32
|
|
nm_access_point_get_max_bitrate (NMAccessPoint *ap)
|
|
{
|
|
g_return_val_if_fail (NM_IS_ACCESS_POINT (ap), 0);
|
|
|
|
return NM_ACCESS_POINT_GET_PRIVATE (ap)->max_bitrate;
|
|
}
|
|
|
|
/**
|
|
* nm_access_point_get_strength:
|
|
* @ap: a #NMAccessPoint
|
|
*
|
|
* Gets the current signal strength of the access point as a percentage.
|
|
*
|
|
* Returns: the signal strength (0 to 100)
|
|
**/
|
|
guint8
|
|
nm_access_point_get_strength (NMAccessPoint *ap)
|
|
{
|
|
g_return_val_if_fail (NM_IS_ACCESS_POINT (ap), 0);
|
|
|
|
return NM_ACCESS_POINT_GET_PRIVATE (ap)->strength;
|
|
}
|
|
|
|
/**
|
|
* nm_access_point_get_last_seen:
|
|
* @ap: a #NMAccessPoint
|
|
*
|
|
* Returns the timestamp (in CLOCK_BOOTTIME seconds) for the last time the
|
|
* access point was found in scan results. A value of -1 means the access
|
|
* point has not been found in a scan.
|
|
*
|
|
* Returns: the last seen time in seconds
|
|
*
|
|
* Since: 1.2
|
|
**/
|
|
int
|
|
nm_access_point_get_last_seen (NMAccessPoint *ap)
|
|
{
|
|
g_return_val_if_fail (NM_IS_ACCESS_POINT (ap), -1);
|
|
|
|
return NM_ACCESS_POINT_GET_PRIVATE (ap)->last_seen;
|
|
}
|
|
NM_BACKPORT_SYMBOL (libnm_1_0_6, int, nm_access_point_get_last_seen, (NMAccessPoint *ap), (ap));
|
|
|
|
/**
|
|
* nm_access_point_connection_valid:
|
|
* @ap: an #NMAccessPoint to validate @connection against
|
|
* @connection: an #NMConnection to validate against @ap
|
|
*
|
|
* Validates a given connection against a given Wi-Fi access point to ensure that
|
|
* the connection may be activated with that AP. The connection must match the
|
|
* @ap's SSID, (if given) BSSID, and other attributes like security settings,
|
|
* channel, band, etc.
|
|
*
|
|
* Returns: %TRUE if the connection may be activated with this Wi-Fi AP,
|
|
* %FALSE if it cannot be.
|
|
**/
|
|
gboolean
|
|
nm_access_point_connection_valid (NMAccessPoint *ap, NMConnection *connection)
|
|
{
|
|
NMSettingConnection *s_con;
|
|
NMSettingWireless *s_wifi;
|
|
NMSettingWirelessSecurity *s_wsec;
|
|
const char *ctype, *ap_bssid;
|
|
GBytes *setting_ssid;
|
|
GBytes *ap_ssid;
|
|
const char *setting_bssid;
|
|
const char *setting_mode;
|
|
NM80211Mode ap_mode;
|
|
const char *setting_band;
|
|
guint32 ap_freq, setting_chan, ap_chan;
|
|
|
|
g_return_val_if_fail (NM_IS_ACCESS_POINT (ap), FALSE);
|
|
g_return_val_if_fail (NM_IS_CONNECTION (connection), FALSE);
|
|
|
|
s_con = nm_connection_get_setting_connection (connection);
|
|
if (!s_con)
|
|
return FALSE;
|
|
|
|
ctype = nm_setting_connection_get_connection_type (s_con);
|
|
if (!ctype || !nm_streq (ctype, NM_SETTING_WIRELESS_SETTING_NAME))
|
|
return FALSE;
|
|
|
|
s_wifi = nm_connection_get_setting_wireless (connection);
|
|
if (!s_wifi)
|
|
return FALSE;
|
|
|
|
/* SSID checks */
|
|
ap_ssid = nm_access_point_get_ssid (ap);
|
|
if (!ap_ssid)
|
|
return FALSE;
|
|
setting_ssid = nm_setting_wireless_get_ssid (s_wifi);
|
|
if ( !setting_ssid
|
|
|| !g_bytes_equal (ap_ssid, setting_ssid))
|
|
return FALSE;
|
|
|
|
/* BSSID checks */
|
|
ap_bssid = nm_access_point_get_bssid (ap);
|
|
if (!ap_bssid)
|
|
return FALSE;
|
|
setting_bssid = nm_setting_wireless_get_bssid (s_wifi);
|
|
if (setting_bssid) {
|
|
guint8 c[ETH_ALEN];
|
|
|
|
if ( !nm_utils_hwaddr_aton (ap_bssid, c, ETH_ALEN)
|
|
|| !nm_utils_hwaddr_matches (c, ETH_ALEN, setting_bssid, -1))
|
|
return FALSE;
|
|
}
|
|
|
|
/* Mode */
|
|
ap_mode = nm_access_point_get_mode (ap);
|
|
if (ap_mode == NM_802_11_MODE_UNKNOWN)
|
|
return FALSE;
|
|
setting_mode = nm_setting_wireless_get_mode (s_wifi);
|
|
if (setting_mode && ap_mode) {
|
|
if (!strcmp (setting_mode, "infrastructure") && (ap_mode != NM_802_11_MODE_INFRA))
|
|
return FALSE;
|
|
if (!strcmp (setting_mode, "adhoc") && (ap_mode != NM_802_11_MODE_ADHOC))
|
|
return FALSE;
|
|
/* Hotspot never matches against APs as it's a device-specific mode. */
|
|
if (!strcmp (setting_mode, "ap"))
|
|
return FALSE;
|
|
}
|
|
|
|
/* Band and Channel/Frequency */
|
|
ap_freq = nm_access_point_get_frequency (ap);
|
|
if (ap_freq) {
|
|
setting_band = nm_setting_wireless_get_band (s_wifi);
|
|
if (g_strcmp0 (setting_band, "a") == 0) {
|
|
if (ap_freq < 4915 || ap_freq > 5825)
|
|
return FALSE;
|
|
} else if (g_strcmp0 (setting_band, "bg") == 0) {
|
|
if (ap_freq < 2412 || ap_freq > 2484)
|
|
return FALSE;
|
|
}
|
|
|
|
setting_chan = nm_setting_wireless_get_channel (s_wifi);
|
|
if (setting_chan) {
|
|
ap_chan = nm_utils_wifi_freq_to_channel (ap_freq);
|
|
if (setting_chan != ap_chan)
|
|
return FALSE;
|
|
}
|
|
}
|
|
|
|
s_wsec = nm_connection_get_setting_wireless_security (connection);
|
|
if (!nm_setting_wireless_ap_security_compatible (s_wifi,
|
|
s_wsec,
|
|
nm_access_point_get_flags (ap),
|
|
nm_access_point_get_wpa_flags (ap),
|
|
nm_access_point_get_rsn_flags (ap),
|
|
ap_mode))
|
|
return FALSE;
|
|
|
|
return TRUE;
|
|
}
|
|
|
|
/**
|
|
* nm_access_point_filter_connections:
|
|
* @ap: an #NMAccessPoint to filter connections for
|
|
* @connections: (element-type NMConnection): an array of #NMConnections to
|
|
* filter
|
|
*
|
|
* Filters a given array of connections for a given #NMAccessPoint object and
|
|
* returns connections which may be activated with the access point. Any
|
|
* returned connections will match the @ap's SSID and (if given) BSSID and
|
|
* other attributes like security settings, channel, etc.
|
|
*
|
|
* To obtain the list of connections that are compatible with this access point,
|
|
* use nm_client_get_connections() and then filter the returned list for a given
|
|
* #NMDevice using nm_device_filter_connections() and finally filter that list
|
|
* with this function.
|
|
*
|
|
* Returns: (transfer full) (element-type NMConnection): an array of
|
|
* #NMConnections that could be activated with the given @ap. The array should
|
|
* be freed with g_ptr_array_unref() when it is no longer required.
|
|
**/
|
|
GPtrArray *
|
|
nm_access_point_filter_connections (NMAccessPoint *ap, const GPtrArray *connections)
|
|
{
|
|
GPtrArray *filtered;
|
|
guint i;
|
|
|
|
g_return_val_if_fail (NM_IS_ACCESS_POINT (ap), NULL);
|
|
|
|
if (!connections)
|
|
return NULL;
|
|
|
|
filtered = g_ptr_array_new_with_free_func (g_object_unref);
|
|
for (i = 0; i < connections->len; i++) {
|
|
NMConnection *candidate = connections->pdata[i];
|
|
|
|
if (nm_access_point_connection_valid (ap, candidate))
|
|
g_ptr_array_add (filtered, g_object_ref (candidate));
|
|
}
|
|
|
|
return filtered;
|
|
}
|
|
|
|
/*****************************************************************************/
|
|
|
|
static NMLDBusNotifyUpdatePropFlags
|
|
_notify_update_prop_hw_address (NMClient *client,
|
|
NMLDBusObject *dbobj,
|
|
const NMLDBusMetaIface *meta_iface,
|
|
guint dbus_property_idx,
|
|
GVariant *value)
|
|
{
|
|
NMAccessPoint *self = NM_ACCESS_POINT (dbobj->nmobj);
|
|
NMAccessPointPrivate *priv = NM_ACCESS_POINT_GET_PRIVATE (self);
|
|
|
|
g_free (priv->bssid);
|
|
priv->bssid = value ? g_variant_dup_string (value, NULL) : 0u;
|
|
_notify (self, PROP_HW_ADDRESS);
|
|
return NML_DBUS_NOTIFY_UPDATE_PROP_FLAGS_NOTIFY;
|
|
}
|
|
|
|
/*****************************************************************************/
|
|
|
|
static void
|
|
nm_access_point_init (NMAccessPoint *ap)
|
|
{
|
|
NM_ACCESS_POINT_GET_PRIVATE (ap)->last_seen = -1;
|
|
}
|
|
|
|
static void
|
|
finalize (GObject *object)
|
|
{
|
|
NMAccessPointPrivate *priv = NM_ACCESS_POINT_GET_PRIVATE (object);
|
|
|
|
if (priv->ssid)
|
|
g_bytes_unref (priv->ssid);
|
|
g_free (priv->bssid);
|
|
|
|
G_OBJECT_CLASS (nm_access_point_parent_class)->finalize (object);
|
|
}
|
|
|
|
static void
|
|
get_property (GObject *object,
|
|
guint prop_id,
|
|
GValue *value,
|
|
GParamSpec *pspec)
|
|
{
|
|
NMAccessPoint *ap = NM_ACCESS_POINT (object);
|
|
|
|
switch (prop_id) {
|
|
case PROP_FLAGS:
|
|
g_value_set_flags (value, nm_access_point_get_flags (ap));
|
|
break;
|
|
case PROP_WPA_FLAGS:
|
|
g_value_set_flags (value, nm_access_point_get_wpa_flags (ap));
|
|
break;
|
|
case PROP_RSN_FLAGS:
|
|
g_value_set_flags (value, nm_access_point_get_rsn_flags (ap));
|
|
break;
|
|
case PROP_SSID:
|
|
g_value_set_boxed (value, nm_access_point_get_ssid (ap));
|
|
break;
|
|
case PROP_FREQUENCY:
|
|
g_value_set_uint (value, nm_access_point_get_frequency (ap));
|
|
break;
|
|
case PROP_HW_ADDRESS:
|
|
g_value_set_string (value, nm_access_point_get_bssid (ap));
|
|
break;
|
|
case PROP_BSSID:
|
|
g_value_set_string (value, nm_access_point_get_bssid (ap));
|
|
break;
|
|
case PROP_MODE:
|
|
g_value_set_enum (value, nm_access_point_get_mode (ap));
|
|
break;
|
|
case PROP_MAX_BITRATE:
|
|
g_value_set_uint (value, nm_access_point_get_max_bitrate (ap));
|
|
break;
|
|
case PROP_STRENGTH:
|
|
g_value_set_uchar (value, nm_access_point_get_strength (ap));
|
|
break;
|
|
case PROP_LAST_SEEN:
|
|
g_value_set_int (value, nm_access_point_get_last_seen (ap));
|
|
break;
|
|
default:
|
|
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
|
|
break;
|
|
}
|
|
}
|
|
|
|
const NMLDBusMetaIface _nml_dbus_meta_iface_nm_accesspoint = NML_DBUS_META_IFACE_INIT_PROP (
|
|
NM_DBUS_INTERFACE_ACCESS_POINT,
|
|
nm_access_point_get_type,
|
|
NML_DBUS_META_INTERFACE_PRIO_INSTANTIATE_HIGH,
|
|
NML_DBUS_META_IFACE_DBUS_PROPERTIES (
|
|
NML_DBUS_META_PROPERTY_INIT_U ("Flags", PROP_FLAGS, NMAccessPoint, _priv.flags ),
|
|
NML_DBUS_META_PROPERTY_INIT_U ("Frequency", PROP_FREQUENCY, NMAccessPoint, _priv.frequency ),
|
|
NML_DBUS_META_PROPERTY_INIT_FCN ("HwAddress", PROP_BSSID, "s", _notify_update_prop_hw_address ),
|
|
NML_DBUS_META_PROPERTY_INIT_I ("LastSeen", PROP_LAST_SEEN, NMAccessPoint, _priv.last_seen ),
|
|
NML_DBUS_META_PROPERTY_INIT_U ("MaxBitrate", PROP_MAX_BITRATE, NMAccessPoint, _priv.max_bitrate ),
|
|
NML_DBUS_META_PROPERTY_INIT_U ("Mode", PROP_MODE, NMAccessPoint, _priv.mode ),
|
|
NML_DBUS_META_PROPERTY_INIT_U ("RsnFlags", PROP_RSN_FLAGS, NMAccessPoint, _priv.rsn_flags ),
|
|
NML_DBUS_META_PROPERTY_INIT_AY ("Ssid", PROP_SSID, NMAccessPoint, _priv.ssid ),
|
|
NML_DBUS_META_PROPERTY_INIT_Y ("Strength", PROP_STRENGTH, NMAccessPoint, _priv.strength ),
|
|
NML_DBUS_META_PROPERTY_INIT_U ("WpaFlags", PROP_WPA_FLAGS, NMAccessPoint, _priv.wpa_flags ),
|
|
),
|
|
);
|
|
|
|
static void
|
|
nm_access_point_class_init (NMAccessPointClass *ap_class)
|
|
{
|
|
GObjectClass *object_class = G_OBJECT_CLASS (ap_class);
|
|
|
|
object_class->get_property = get_property;
|
|
object_class->finalize = finalize;
|
|
|
|
/**
|
|
* NMAccessPoint:flags:
|
|
*
|
|
* The flags of the access point.
|
|
**/
|
|
obj_properties[PROP_FLAGS] =
|
|
g_param_spec_flags (NM_ACCESS_POINT_FLAGS, "", "",
|
|
NM_TYPE_802_11_AP_FLAGS,
|
|
NM_802_11_AP_FLAGS_NONE,
|
|
G_PARAM_READABLE |
|
|
G_PARAM_STATIC_STRINGS);
|
|
|
|
/**
|
|
* NMAccessPoint:wpa-flags:
|
|
*
|
|
* The WPA flags of the access point.
|
|
**/
|
|
obj_properties[PROP_WPA_FLAGS] =
|
|
g_param_spec_flags (NM_ACCESS_POINT_WPA_FLAGS, "", "",
|
|
NM_TYPE_802_11_AP_SECURITY_FLAGS,
|
|
NM_802_11_AP_SEC_NONE,
|
|
G_PARAM_READABLE |
|
|
G_PARAM_STATIC_STRINGS);
|
|
|
|
/**
|
|
* NMAccessPoint:rsn-flags:
|
|
*
|
|
* The RSN flags of the access point.
|
|
**/
|
|
obj_properties[PROP_RSN_FLAGS] =
|
|
g_param_spec_flags (NM_ACCESS_POINT_RSN_FLAGS, "", "",
|
|
NM_TYPE_802_11_AP_SECURITY_FLAGS,
|
|
NM_802_11_AP_SEC_NONE,
|
|
G_PARAM_READABLE |
|
|
G_PARAM_STATIC_STRINGS);
|
|
|
|
/**
|
|
* NMAccessPoint:ssid:
|
|
*
|
|
* The SSID of the access point, or %NULL if it is not known.
|
|
**/
|
|
obj_properties[PROP_SSID] =
|
|
g_param_spec_boxed (NM_ACCESS_POINT_SSID, "", "",
|
|
G_TYPE_BYTES,
|
|
G_PARAM_READABLE |
|
|
G_PARAM_STATIC_STRINGS);
|
|
|
|
/**
|
|
* NMAccessPoint:frequency:
|
|
*
|
|
* The frequency of the access point.
|
|
**/
|
|
obj_properties[PROP_FREQUENCY] =
|
|
g_param_spec_uint (NM_ACCESS_POINT_FREQUENCY, "", "",
|
|
0, 10000, 0,
|
|
G_PARAM_READABLE |
|
|
G_PARAM_STATIC_STRINGS);
|
|
|
|
/**
|
|
* NMAccessPoint:bssid:
|
|
*
|
|
* The BSSID of the access point.
|
|
**/
|
|
obj_properties[PROP_BSSID] =
|
|
g_param_spec_string (NM_ACCESS_POINT_BSSID, "", "",
|
|
NULL,
|
|
G_PARAM_READABLE |
|
|
G_PARAM_STATIC_STRINGS);
|
|
|
|
/**
|
|
* NMAccessPoint:hw-address:
|
|
*
|
|
* Alias for #NMAccessPoint:bssid.
|
|
*
|
|
* Deprecated: 1.0: use #NMAccessPoint:bssid.
|
|
**/
|
|
obj_properties[PROP_HW_ADDRESS] =
|
|
g_param_spec_string (NM_ACCESS_POINT_HW_ADDRESS, "", "",
|
|
NULL,
|
|
G_PARAM_READABLE |
|
|
G_PARAM_STATIC_STRINGS);
|
|
|
|
/**
|
|
* NMAccessPoint:mode:
|
|
*
|
|
* The mode of the access point; either "infrastructure" (a central
|
|
* coordinator of the wireless network allowing clients to connect) or
|
|
* "ad-hoc" (a network with no central controller).
|
|
**/
|
|
obj_properties[PROP_MODE] =
|
|
g_param_spec_enum (NM_ACCESS_POINT_MODE, "", "",
|
|
NM_TYPE_802_11_MODE,
|
|
NM_802_11_MODE_UNKNOWN,
|
|
G_PARAM_READABLE |
|
|
G_PARAM_STATIC_STRINGS);
|
|
|
|
/**
|
|
* NMAccessPoint:max-bitrate:
|
|
*
|
|
* The maximum bit rate of the access point in kbit/s.
|
|
**/
|
|
obj_properties[PROP_MAX_BITRATE] =
|
|
g_param_spec_uint (NM_ACCESS_POINT_MAX_BITRATE, "", "",
|
|
0, G_MAXUINT32, 0,
|
|
G_PARAM_READABLE |
|
|
G_PARAM_STATIC_STRINGS);
|
|
|
|
/**
|
|
* NMAccessPoint:strength:
|
|
*
|
|
* The current signal strength of the access point.
|
|
**/
|
|
obj_properties[PROP_STRENGTH] =
|
|
g_param_spec_uchar (NM_ACCESS_POINT_STRENGTH, "", "",
|
|
0, G_MAXUINT8, 0,
|
|
G_PARAM_READABLE |
|
|
G_PARAM_STATIC_STRINGS);
|
|
|
|
/**
|
|
* NMAccessPoint:last-seen:
|
|
*
|
|
* The timestamp (in CLOCK_BOOTTIME seconds) for the last time the
|
|
* access point was found in scan results. A value of -1 means the
|
|
* access point has not been found in a scan.
|
|
*
|
|
* Since: 1.2
|
|
**/
|
|
obj_properties[PROP_LAST_SEEN] =
|
|
g_param_spec_int (NM_ACCESS_POINT_LAST_SEEN, "", "",
|
|
-1, G_MAXINT, -1,
|
|
G_PARAM_READABLE |
|
|
G_PARAM_STATIC_STRINGS);
|
|
|
|
_nml_dbus_meta_class_init_with_properties (object_class, &_nml_dbus_meta_iface_nm_accesspoint);
|
|
}
|