mirror of
https://gitlab.freedesktop.org/NetworkManager/NetworkManager.git
synced 2025-12-24 05:30:08 +01:00
e90684a169
Note that D-Bus is fundamentally asynchronous. Doing blocking calls
on top of D-Bus is odd, especially for libnm's NMClient. That is because
NMClient essentially is a client-side cache of the objects from the D-Bus
interface. This cache should be filled exclusively by (asynchronous) D-Bus
events (PropertiesChanged). So, making a blocking D-Bus call means to wait
for a response and return it, while queuing all messages that are received
in the meantime.
Basically there are three ways how a synchronous API on NMClient could behave:
1) the call just calls g_dbus_connection_call_sync(). This means
that libnm sends a D-Bus request via GDBusConnection, and blockingly
waits for the response. All D-Bus messages that get received in the
meantime are queued in the GMainContext that belongs to NMClient.
That means, none of these D-Bus events are processed until we
iterate the GMainContext after the call returns. The effect is,
that NMClient (and all cached objects in there) are unaffected by
the D-Bus request.
Most of the synchronous API calls in libnm are of this kind.
The problem is that the strict ordering of D-Bus events gets
violated.
For some API this is not an immediate problem. Take for example
nm_device_wifi_request_scan(). The call merely blockingly tells
NetworkManager to start scanning, but since NetworkManager's D-Bus
API does not directly expose any state that tells whether we are
currently scanning, this out of order processing of the D-Bus
request is a small issue.
The problem is more obvious for nm_client_networking_set_enabled().
After calling it, NM_CLIENT_NETWORKING_ENABLED is still unaffected
and unchanged, because the PropertiesChanged signal from D-Bus
is not yet processed.
This means, while you make such a blocking call, NMClient's state
does not change. But usually you perform the synchronous call
to change some state. In this form, the blocking call is not useful,
because NMClient only changes the state after iterating the GMainContext,
and not after the blocking call returns.
2) like 1), but after making the blocking g_dbus_connection_call_sync(),
update the NMClient cache artificially. This is what
nm_manager_check_connectivity() does, to "fix" bgo#784629.
This also has the problem of out-of-order events, but it kinda
solves the problem of not changing the state during the blocking
call. But it does so by hacking the state of the cache. I think
this is really wrong because the state should only be updated from
the ordered stream of D-Bus messages (PropertiesChanged signal and
similar). When libnm decides to modify the state, there may be already
D-Bus messages queued that affect this very state.
3) instead of calling g_dbus_connection_call_sync(), use the
asynchronous g_dbus_connection_call(). If we would use a sepaate
GMainContext for all D-Bus related calls, we could ensure that
while we block for the response, we iterate that internal main context.
This might be nice, because all events are processed in order and
after the blocking call returns, the NMClient state is up to date.
The are problems however: current blocking API does not do this,
so it's a significant change in behavior. Also, it might be
unexpected to the user that during the blocking call the entire
content of NMClient's cache might change and all pointers to the
cache might be invalidated. Also, of course NMClient would invoke
signals for all the changes that happen.
Another problem is that this would be more effort to implement
and it involves a small performance overhead for all D-Bus related
calls (because we have to serialize all events in an internal
GMainContext first and then invoke them on the caller's context).
Also, if the users wants this behavior, they could implement it themself
by running libnm in their own GMainContext. Note that libnm might
have bugs to make that really working, but that should be fixed
instead of adding such synchrnous API behavior.
Read also [1], for why blocking calls are wrong.
[1] https://smcv.pseudorandom.co.uk/2008/11/nonblocking/
So, all possible behaviors for synchronous API have severe behavioural
issues. Mark all this API as deprecated. Also, this serves the purpose of
identifying blocking D-Bus calls in libnm.
Note that "deprecated" here does not really mean that the API is going
to be removed. We don't break API. The user may:
- continue to use this API. It's deprecated, awkward and discouraged,
but if it works, by all means use it.
- use asynchronous API. That's the only sensible way to use D-Bus.
If libnm lacks a certain asynchronous counterpart, it should be
added.
- use GDBusConnection directly. There really isn't anything wrong
with D-Bus or GDBusConnection. This deprecated API is just a wrapper
around g_dbus_connection_call_sync(). You may call it directly
without feeling dirty.
---
The only other remainging API is the synchronous GInitable call for
NMClient. That is an entirely separate beast and not particularly
wrong (from an API point of view).
Note that synchronous API in NMSecretAgentOld, NMVpnPluginOld and
NMVpnServicePlugin as not deprecated here. These types are not part
of the D-Bus cache and while they have similar issues, it's less severe
because they have less state.
244 lines
7 KiB
C
244 lines
7 KiB
C
// SPDX-License-Identifier: LGPL-2.1+
|
|
/*
|
|
* Copyright (C) 2011, 2015 Red Hat, Inc.
|
|
*/
|
|
|
|
#ifndef NM_VERSION_H
|
|
#define NM_VERSION_H
|
|
|
|
#include <glib.h>
|
|
|
|
#include "nm-version-macros.h"
|
|
|
|
/* Deprecation / Availability macros */
|
|
|
|
#if !defined (NM_VERSION_MIN_REQUIRED) || (NM_VERSION_MIN_REQUIRED == 0)
|
|
# undef NM_VERSION_MIN_REQUIRED
|
|
# define NM_VERSION_MIN_REQUIRED (NM_API_VERSION)
|
|
#endif
|
|
|
|
#if !defined (NM_VERSION_MAX_ALLOWED) || (NM_VERSION_MAX_ALLOWED == 0)
|
|
# undef NM_VERSION_MAX_ALLOWED
|
|
# define NM_VERSION_MAX_ALLOWED (NM_API_VERSION)
|
|
#endif
|
|
|
|
/* sanity checks */
|
|
#if NM_VERSION_MIN_REQUIRED > NM_API_VERSION
|
|
#error "NM_VERSION_MIN_REQUIRED must be <= NM_API_VERSION"
|
|
#endif
|
|
#if NM_VERSION_MAX_ALLOWED < NM_VERSION_MIN_REQUIRED
|
|
#error "NM_VERSION_MAX_ALLOWED must be >= NM_VERSION_MIN_REQUIRED"
|
|
#endif
|
|
#if NM_VERSION_MIN_REQUIRED < NM_VERSION_0_9_8
|
|
#error "NM_VERSION_MIN_REQUIRED must be >= NM_VERSION_0_9_8"
|
|
#endif
|
|
|
|
#if NM_VERSION_MIN_REQUIRED >= NM_VERSION_0_9_10
|
|
# define NM_DEPRECATED_IN_0_9_10 G_DEPRECATED
|
|
# define NM_DEPRECATED_IN_0_9_10_FOR(f) G_DEPRECATED_FOR(f)
|
|
#else
|
|
# define NM_DEPRECATED_IN_0_9_10
|
|
# define NM_DEPRECATED_IN_0_9_10_FOR(f)
|
|
#endif
|
|
|
|
#if NM_VERSION_MAX_ALLOWED < NM_VERSION_0_9_10
|
|
# define NM_AVAILABLE_IN_0_9_10 G_UNAVAILABLE(0.9,10)
|
|
#else
|
|
# define NM_AVAILABLE_IN_0_9_10
|
|
#endif
|
|
|
|
#if NM_VERSION_MIN_REQUIRED >= NM_VERSION_1_0
|
|
# define NM_DEPRECATED_IN_1_0 G_DEPRECATED
|
|
# define NM_DEPRECATED_IN_1_0_FOR(f) G_DEPRECATED_FOR(f)
|
|
#else
|
|
# define NM_DEPRECATED_IN_1_0
|
|
# define NM_DEPRECATED_IN_1_0_FOR(f)
|
|
#endif
|
|
|
|
#if NM_VERSION_MAX_ALLOWED < NM_VERSION_1_0
|
|
# define NM_AVAILABLE_IN_1_0 G_UNAVAILABLE(1,0)
|
|
#else
|
|
# define NM_AVAILABLE_IN_1_0
|
|
#endif
|
|
|
|
#if NM_VERSION_MIN_REQUIRED >= NM_VERSION_1_2
|
|
# define NM_DEPRECATED_IN_1_2 G_DEPRECATED
|
|
# define NM_DEPRECATED_IN_1_2_FOR(f) G_DEPRECATED_FOR(f)
|
|
#else
|
|
# define NM_DEPRECATED_IN_1_2
|
|
# define NM_DEPRECATED_IN_1_2_FOR(f)
|
|
#endif
|
|
|
|
#if NM_VERSION_MAX_ALLOWED < NM_VERSION_1_2
|
|
# define NM_AVAILABLE_IN_1_2 G_UNAVAILABLE(1,2)
|
|
#else
|
|
# define NM_AVAILABLE_IN_1_2
|
|
#endif
|
|
|
|
#if NM_VERSION_MIN_REQUIRED >= NM_VERSION_1_4
|
|
# define NM_DEPRECATED_IN_1_4 G_DEPRECATED
|
|
# define NM_DEPRECATED_IN_1_4_FOR(f) G_DEPRECATED_FOR(f)
|
|
#else
|
|
# define NM_DEPRECATED_IN_1_4
|
|
# define NM_DEPRECATED_IN_1_4_FOR(f)
|
|
#endif
|
|
|
|
#if NM_VERSION_MAX_ALLOWED < NM_VERSION_1_4
|
|
# define NM_AVAILABLE_IN_1_4 G_UNAVAILABLE(1,4)
|
|
#else
|
|
# define NM_AVAILABLE_IN_1_4
|
|
#endif
|
|
|
|
#if NM_VERSION_MIN_REQUIRED >= NM_VERSION_1_6
|
|
# define NM_DEPRECATED_IN_1_6 G_DEPRECATED
|
|
# define NM_DEPRECATED_IN_1_6_FOR(f) G_DEPRECATED_FOR(f)
|
|
#else
|
|
# define NM_DEPRECATED_IN_1_6
|
|
# define NM_DEPRECATED_IN_1_6_FOR(f)
|
|
#endif
|
|
|
|
#if NM_VERSION_MAX_ALLOWED < NM_VERSION_1_6
|
|
# define NM_AVAILABLE_IN_1_6 G_UNAVAILABLE(1,6)
|
|
#else
|
|
# define NM_AVAILABLE_IN_1_6
|
|
#endif
|
|
|
|
#if NM_VERSION_MIN_REQUIRED >= NM_VERSION_1_8
|
|
# define NM_DEPRECATED_IN_1_8 G_DEPRECATED
|
|
# define NM_DEPRECATED_IN_1_8_FOR(f) G_DEPRECATED_FOR(f)
|
|
#else
|
|
# define NM_DEPRECATED_IN_1_8
|
|
# define NM_DEPRECATED_IN_1_8_FOR(f)
|
|
#endif
|
|
|
|
#if NM_VERSION_MAX_ALLOWED < NM_VERSION_1_8
|
|
# define NM_AVAILABLE_IN_1_8 G_UNAVAILABLE(1,8)
|
|
#else
|
|
# define NM_AVAILABLE_IN_1_8
|
|
#endif
|
|
|
|
#if NM_VERSION_MIN_REQUIRED >= NM_VERSION_1_10
|
|
# define NM_DEPRECATED_IN_1_10 G_DEPRECATED
|
|
# define NM_DEPRECATED_IN_1_10_FOR(f) G_DEPRECATED_FOR(f)
|
|
#else
|
|
# define NM_DEPRECATED_IN_1_10
|
|
# define NM_DEPRECATED_IN_1_10_FOR(f)
|
|
#endif
|
|
|
|
#if NM_VERSION_MAX_ALLOWED < NM_VERSION_1_10
|
|
# define NM_AVAILABLE_IN_1_10 G_UNAVAILABLE(1,10)
|
|
#else
|
|
# define NM_AVAILABLE_IN_1_10
|
|
#endif
|
|
|
|
#if NM_VERSION_MIN_REQUIRED >= NM_VERSION_1_12
|
|
# define NM_DEPRECATED_IN_1_12 G_DEPRECATED
|
|
# define NM_DEPRECATED_IN_1_12_FOR(f) G_DEPRECATED_FOR(f)
|
|
#else
|
|
# define NM_DEPRECATED_IN_1_12
|
|
# define NM_DEPRECATED_IN_1_12_FOR(f)
|
|
#endif
|
|
|
|
#if NM_VERSION_MAX_ALLOWED < NM_VERSION_1_12
|
|
# define NM_AVAILABLE_IN_1_12 G_UNAVAILABLE(1,12)
|
|
#else
|
|
# define NM_AVAILABLE_IN_1_12
|
|
#endif
|
|
|
|
#if NM_VERSION_MIN_REQUIRED >= NM_VERSION_1_14
|
|
# define NM_DEPRECATED_IN_1_14 G_DEPRECATED
|
|
# define NM_DEPRECATED_IN_1_14_FOR(f) G_DEPRECATED_FOR(f)
|
|
#else
|
|
# define NM_DEPRECATED_IN_1_14
|
|
# define NM_DEPRECATED_IN_1_14_FOR(f)
|
|
#endif
|
|
|
|
#if NM_VERSION_MAX_ALLOWED < NM_VERSION_1_14
|
|
# define NM_AVAILABLE_IN_1_14 G_UNAVAILABLE(1,14)
|
|
#else
|
|
# define NM_AVAILABLE_IN_1_14
|
|
#endif
|
|
|
|
#if NM_VERSION_MIN_REQUIRED >= NM_VERSION_1_16
|
|
# define NM_DEPRECATED_IN_1_16 G_DEPRECATED
|
|
# define NM_DEPRECATED_IN_1_16_FOR(f) G_DEPRECATED_FOR(f)
|
|
#else
|
|
# define NM_DEPRECATED_IN_1_16
|
|
# define NM_DEPRECATED_IN_1_16_FOR(f)
|
|
#endif
|
|
|
|
#if NM_VERSION_MAX_ALLOWED < NM_VERSION_1_16
|
|
# define NM_AVAILABLE_IN_1_16 G_UNAVAILABLE(1,16)
|
|
#else
|
|
# define NM_AVAILABLE_IN_1_16
|
|
#endif
|
|
|
|
#if NM_VERSION_MIN_REQUIRED >= NM_VERSION_1_18
|
|
# define NM_DEPRECATED_IN_1_18 G_DEPRECATED
|
|
# define NM_DEPRECATED_IN_1_18_FOR(f) G_DEPRECATED_FOR(f)
|
|
#else
|
|
# define NM_DEPRECATED_IN_1_18
|
|
# define NM_DEPRECATED_IN_1_18_FOR(f)
|
|
#endif
|
|
|
|
#if NM_VERSION_MAX_ALLOWED < NM_VERSION_1_18
|
|
# define NM_AVAILABLE_IN_1_18 G_UNAVAILABLE(1,18)
|
|
#else
|
|
# define NM_AVAILABLE_IN_1_18
|
|
#endif
|
|
|
|
#if NM_VERSION_MIN_REQUIRED >= NM_VERSION_1_20
|
|
# define NM_DEPRECATED_IN_1_20 G_DEPRECATED
|
|
# define NM_DEPRECATED_IN_1_20_FOR(f) G_DEPRECATED_FOR(f)
|
|
#else
|
|
# define NM_DEPRECATED_IN_1_20
|
|
# define NM_DEPRECATED_IN_1_20_FOR(f)
|
|
#endif
|
|
|
|
#if NM_VERSION_MAX_ALLOWED < NM_VERSION_1_20
|
|
# define NM_AVAILABLE_IN_1_20 G_UNAVAILABLE(1,20)
|
|
#else
|
|
# define NM_AVAILABLE_IN_1_20
|
|
#endif
|
|
|
|
#if NM_VERSION_MIN_REQUIRED >= NM_VERSION_1_22
|
|
# define NM_DEPRECATED_IN_1_22 G_DEPRECATED
|
|
# define NM_DEPRECATED_IN_1_22_FOR(f) G_DEPRECATED_FOR(f)
|
|
#else
|
|
# define NM_DEPRECATED_IN_1_22
|
|
# define NM_DEPRECATED_IN_1_22_FOR(f)
|
|
#endif
|
|
|
|
#if NM_VERSION_MAX_ALLOWED < NM_VERSION_1_22
|
|
# define NM_AVAILABLE_IN_1_22 G_UNAVAILABLE(1,22)
|
|
#else
|
|
# define NM_AVAILABLE_IN_1_22
|
|
#endif
|
|
|
|
/*
|
|
* Synchronous API for calling D-Bus in libnm is deprecated. See
|
|
* https://developer.gnome.org/libnm/stable/usage.html#sync-api
|
|
*
|
|
* Note that "deprecated" here does not really mean that the API is going
|
|
* to be removed. We don't break API. Just comment that it is awkward and
|
|
* discouraged. The user may:
|
|
*
|
|
* - continue to use this API. It's deprecated, awkward and discouraged,
|
|
* but if it works for you, that's fine.
|
|
*
|
|
* - use asynchronous API. That's the only sensible way to use D-Bus.
|
|
* If libnm lacks a certain asynchronous counterpart, it should be
|
|
* added.
|
|
*
|
|
* - use GDBusConnection directly. There really isn't anything wrong
|
|
* with D-Bus or GDBusConnection. This deprecated API is just a wrapper
|
|
* around g_dbus_connection_call_sync(). You may call it directly
|
|
* without feeling dirty.
|
|
*
|
|
* We don't want to force users away from this API, for that reason the
|
|
* macro does not yet expand to G_DEPRECATED.
|
|
*/
|
|
#define _NM_DEPRECATED_SYNC_METHOD /*NM_DEPRECATED_IN_1_22*/
|
|
#define _NM_DEPRECATED_SYNC_WRITABLE_PROPERTY /*NM_DEPRECATED_IN_1_22*/
|
|
|
|
#endif /* NM_VERSION_H */
|