NetworkManager/src/libnm-glib-aux/nm-dbus-aux.c
Thomas Haller 615221a99c format: reformat source tree with clang-format 13.0
We use clang-format for automatic formatting of our source files.
Since clang-format is actively maintained software, the actual
formatting depends on the used version of clang-format. That is
unfortunate and painful, but really unavoidable unless clang-format
would be strictly bug-compatible.

So the version that we must use is from the current Fedora release, which
is also tested by our gitlab-ci. Previously, we were using Fedora 34 with
clang-tools-extra-12.0.1-1.fc34.x86_64.

As Fedora 35 comes along, we need to update our formatting as Fedora 35
comes with version "13.0.0~rc1-1.fc35".
An alternative would be to freeze on version 12, but that has different
problems (like, it's cumbersome to rebuild clang 12 on Fedora 35 and it
would be cumbersome for our developers which are on Fedora 35 to use a
clang that they cannot easily install).

The (differently painful) solution is to reformat from time to time, as we
switch to a new Fedora (and thus clang) version.
Usually we would expect that such a reformatting brings minor changes.
But this time, the changes are huge. That is mentioned in the release
notes [1] as

  Makes PointerAligment: Right working with AlignConsecutiveDeclarations. (Fixes https://llvm.org/PR27353)

[1] https://releases.llvm.org/13.0.0/tools/clang/docs/ReleaseNotes.html#clang-format
2021-11-29 09:31:09 +00:00

492 lines
17 KiB
C

/* SPDX-License-Identifier: LGPL-2.1-or-later */
/*
* Copyright (C) 2019 Red Hat, Inc.
*/
#include "libnm-glib-aux/nm-default-glib-i18n-lib.h"
#include "nm-dbus-aux.h"
/*****************************************************************************/
static void
_nm_dbus_connection_call_get_name_owner_cb(GObject *source, GAsyncResult *res, gpointer user_data)
{
gs_unref_variant GVariant *ret = NULL;
gs_free_error GError *error = NULL;
const char *owner = NULL;
gpointer orig_user_data;
NMDBusConnectionCallGetNameOwnerCb callback;
nm_utils_user_data_unpack(user_data, &orig_user_data, &callback);
ret = g_dbus_connection_call_finish(G_DBUS_CONNECTION(source), res, &error);
if (ret)
g_variant_get(ret, "(&s)", &owner);
callback(owner, error, orig_user_data);
}
void
nm_dbus_connection_call_get_name_owner(GDBusConnection *dbus_connection,
const char *service_name,
int timeout_msec,
GCancellable *cancellable,
NMDBusConnectionCallGetNameOwnerCb callback,
gpointer user_data)
{
nm_assert(callback);
g_dbus_connection_call(dbus_connection,
DBUS_SERVICE_DBUS,
DBUS_PATH_DBUS,
DBUS_INTERFACE_DBUS,
"GetNameOwner",
g_variant_new("(s)", service_name),
G_VARIANT_TYPE("(s)"),
G_DBUS_CALL_FLAGS_NONE,
timeout_msec,
cancellable,
_nm_dbus_connection_call_get_name_owner_cb,
nm_utils_user_data_pack(user_data, callback));
}
/*****************************************************************************/
static void
_nm_dbus_connection_call_default_cb(GObject *source, GAsyncResult *res, gpointer user_data)
{
gs_unref_variant GVariant *ret = NULL;
gs_free_error GError *error = NULL;
gpointer orig_user_data;
NMDBusConnectionCallDefaultCb callback;
nm_utils_user_data_unpack(user_data, &orig_user_data, &callback);
ret = g_dbus_connection_call_finish(G_DBUS_CONNECTION(source), res, &error);
nm_assert((!!ret) != (!!error));
callback(ret, error, orig_user_data);
}
void
nm_dbus_connection_call_get_all(GDBusConnection *dbus_connection,
const char *bus_name,
const char *object_path,
const char *interface_name,
int timeout_msec,
GCancellable *cancellable,
NMDBusConnectionCallDefaultCb callback,
gpointer user_data)
{
nm_assert(callback);
g_dbus_connection_call(dbus_connection,
bus_name,
object_path,
DBUS_INTERFACE_PROPERTIES,
"GetAll",
g_variant_new("(s)", interface_name),
G_VARIANT_TYPE("(a{sv})"),
G_DBUS_CALL_FLAGS_NONE,
timeout_msec,
cancellable,
_nm_dbus_connection_call_default_cb,
nm_utils_user_data_pack(user_data, callback));
}
void
nm_dbus_connection_call_set(GDBusConnection *dbus_connection,
const char *bus_name,
const char *object_path,
const char *interface_name,
const char *property_name,
GVariant *value,
int timeout_msec,
GCancellable *cancellable,
NMDBusConnectionCallDefaultCb callback,
gpointer user_data)
{
g_dbus_connection_call(dbus_connection,
bus_name,
object_path,
DBUS_INTERFACE_PROPERTIES,
"Set",
g_variant_new("(ssv)", interface_name, property_name, value),
G_VARIANT_TYPE("()"),
G_DBUS_CALL_FLAGS_NONE,
timeout_msec,
cancellable,
callback ? _nm_dbus_connection_call_default_cb : NULL,
callback ? nm_utils_user_data_pack(user_data, callback) : NULL);
}
/*****************************************************************************/
static void
_nm_dbus_connection_call_get_managed_objects_cb(GObject *source,
GAsyncResult *res,
gpointer user_data)
{
gs_unref_variant GVariant *ret = NULL;
gs_unref_variant GVariant *arg = NULL;
gs_free_error GError *error = NULL;
gpointer orig_user_data;
NMDBusConnectionCallDefaultCb callback;
nm_utils_user_data_unpack(user_data, &orig_user_data, &callback);
ret = g_dbus_connection_call_finish(G_DBUS_CONNECTION(source), res, &error);
nm_assert((!!ret) != (!!error));
if (ret) {
nm_assert(g_variant_is_of_type(ret, G_VARIANT_TYPE("(a{oa{sa{sv}}})")));
arg = g_variant_get_child_value(ret, 0);
}
callback(arg, error, orig_user_data);
}
void
nm_dbus_connection_call_get_managed_objects(GDBusConnection *dbus_connection,
const char *bus_name,
const char *object_path,
GDBusCallFlags flags,
int timeout_msec,
GCancellable *cancellable,
NMDBusConnectionCallDefaultCb callback,
gpointer user_data)
{
nm_assert(callback);
g_dbus_connection_call(dbus_connection,
bus_name,
object_path,
DBUS_INTERFACE_OBJECT_MANAGER,
"GetManagedObjects",
NULL,
G_VARIANT_TYPE("(a{oa{sa{sv}}})"),
flags,
timeout_msec,
cancellable,
_nm_dbus_connection_call_get_managed_objects_cb,
nm_utils_user_data_pack(user_data, callback));
}
/*****************************************************************************/
static void
_call_finish_cb(GObject *source,
GAsyncResult *result,
gpointer user_data,
gboolean return_void,
gboolean strip_dbus_error)
{
gs_unref_object GTask *task = user_data;
gs_unref_variant GVariant *ret = NULL;
GError *error = NULL;
nm_assert(G_IS_DBUS_CONNECTION(source));
nm_assert(G_IS_TASK(user_data));
ret = g_dbus_connection_call_finish(G_DBUS_CONNECTION(source), result, &error);
if (!ret) {
if (strip_dbus_error)
g_dbus_error_strip_remote_error(error);
g_task_return_error(task, error);
return;
}
if (!return_void)
g_task_return_pointer(task, g_steal_pointer(&ret), (GDestroyNotify) g_variant_unref);
else {
nm_assert(g_variant_is_of_type(ret, G_VARIANT_TYPE("()")));
g_task_return_boolean(task, TRUE);
}
}
/**
* nm_dbus_connection_call_finish_void_cb:
*
* A default callback to pass as callback to g_dbus_connection_call().
*
* - user_data must be a GTask, whose reference will be consumed by the
* callback.
* - the return GVariant must be a empty tuple "()".
* - the GTask is returned either with error or TRUE boolean.
*/
void
nm_dbus_connection_call_finish_void_cb(GObject *source, GAsyncResult *result, gpointer user_data)
{
_call_finish_cb(source, result, user_data, TRUE, FALSE);
}
/**
* nm_dbus_connection_call_finish_void_strip_dbus_error_cb:
*
* Like nm_dbus_connection_call_finish_void_cb(). The difference
* is that on error this will first call g_dbus_error_strip_remote_error() on the error.
*/
void
nm_dbus_connection_call_finish_void_strip_dbus_error_cb(GObject *source,
GAsyncResult *result,
gpointer user_data)
{
_call_finish_cb(source, result, user_data, TRUE, TRUE);
}
/**
* nm_dbus_connection_call_finish_variant_cb:
*
* A default callback to pass as callback to g_dbus_connection_call().
*
* - user_data must be a GTask, whose reference will be consumed by the
* callback.
* - the GTask is returned either with error or with a pointer containing the GVariant.
*/
void
nm_dbus_connection_call_finish_variant_cb(GObject *source, GAsyncResult *result, gpointer user_data)
{
_call_finish_cb(source, result, user_data, FALSE, FALSE);
}
/**
* nm_dbus_connection_call_finish_variant_strip_dbus_error_cb:
*
* Like nm_dbus_connection_call_finish_variant_strip_dbus_error_cb(). The difference
* is that on error this will first call g_dbus_error_strip_remote_error() on the error.
*/
void
nm_dbus_connection_call_finish_variant_strip_dbus_error_cb(GObject *source,
GAsyncResult *result,
gpointer user_data)
{
_call_finish_cb(source, result, user_data, FALSE, TRUE);
}
/*****************************************************************************/
typedef struct {
char *bus_name;
char *object_path;
char *interface_name;
char *method_name;
GVariant *parameters;
GDBusConnection *connection;
const GVariantType *reply_type;
int timeout_msec;
} CallAsyncInfo;
static void
call_async_info_destroy(CallAsyncInfo *info)
{
g_free(info->bus_name);
g_free(info->object_path);
g_free(info->interface_name);
g_free(info->method_name);
g_variant_unref(info->parameters);
nm_g_object_unref(info->connection);
g_free(info);
}
static void
call_cb(GObject *source, GAsyncResult *result, gpointer user_data)
{
gs_unref_object GTask *task = user_data;
GError *error = NULL;
GVariant *ret;
ret = g_dbus_connection_call_finish(G_DBUS_CONNECTION(source), result, &error);
if (!ret) {
g_task_return_error(task, error);
return;
}
g_task_return_pointer(task, ret, (GDestroyNotify) g_variant_unref);
}
static void
call_bus_get_cb(GObject *source, GAsyncResult *result, gpointer user_data)
{
gs_unref_object GTask *task = user_data;
GCancellable *cancellable;
CallAsyncInfo *info;
GError *error = NULL;
info = g_task_get_task_data(task);
info->connection = g_bus_get_finish(result, &error);
cancellable = g_task_get_cancellable(task);
if (!info->connection) {
g_task_return_error(task, g_steal_pointer(&error));
return;
}
g_dbus_connection_call(info->connection,
info->bus_name,
info->object_path,
info->interface_name,
info->method_name,
info->parameters,
info->reply_type,
G_DBUS_CALL_FLAGS_NONE,
info->timeout_msec,
cancellable,
call_cb,
g_steal_pointer(&task));
}
void
nm_dbus_call(GBusType bus_type,
const char *bus_name,
const char *object_path,
const char *interface_name,
const char *method_name,
GVariant *parameters,
const GVariantType *reply_type,
GCancellable *cancellable,
int timeout_msec,
GAsyncReadyCallback callback,
gpointer user_data)
{
GTask *task;
CallAsyncInfo *info;
info = g_new(CallAsyncInfo, 1);
*info = (CallAsyncInfo){
.bus_name = g_strdup(bus_name),
.object_path = g_strdup(object_path),
.interface_name = g_strdup(interface_name),
.method_name = g_strdup(method_name),
.parameters = g_variant_ref_sink(parameters),
.reply_type = reply_type,
.timeout_msec = timeout_msec,
};
task = nm_g_task_new(NULL, cancellable, nm_dbus_call, callback, user_data);
g_task_set_task_data(task, info, (GDestroyNotify) call_async_info_destroy);
g_bus_get(bus_type, cancellable, call_bus_get_cb, task);
}
GVariant *
nm_dbus_call_finish(GAsyncResult *result, GError **error)
{
nm_assert(nm_g_task_is_valid(result, NULL, nm_dbus_call));
return g_task_propagate_pointer(G_TASK(result), error);
}
/*****************************************************************************/
gboolean
_nm_dbus_error_is(GError *error, ...)
{
gs_free char *dbus_error = NULL;
const char *name;
va_list ap;
dbus_error = g_dbus_error_get_remote_error(error);
if (!dbus_error)
return FALSE;
va_start(ap, error);
while ((name = va_arg(ap, const char *))) {
if (nm_streq(dbus_error, name)) {
va_end(ap);
return TRUE;
}
}
va_end(ap);
return FALSE;
}
/*****************************************************************************/
typedef struct {
GDBusConnection **p_dbus_connection;
GError **p_error;
} BusGetData;
static void
_bus_get_cb(GObject *source, GAsyncResult *result, gpointer user_data)
{
BusGetData *data = user_data;
*data->p_dbus_connection = g_bus_get_finish(result, data->p_error);
}
/**
* nm_g_bus_get_blocking:
* @cancellable: (allow-none): a #GCancellable to abort the operation.
* @error: (allow-none): the error.
*
* This calls g_bus_get(), but iterates the current (thread-default) GMainContext
* until the response is ready. As such, it's similar to g_bus_get_sync(),
* but it allows to cancel the operation (without having multiple threads).
*
* Returns: (transfer full): the new #GDBusConnection or %NULL on error.
*/
GDBusConnection *
nm_g_bus_get_blocking(GCancellable *cancellable, GError **error)
{
gs_free_error GError *local_error = NULL;
gs_unref_object GDBusConnection *dbus_connection = NULL;
GMainContext *main_context = g_main_context_get_thread_default();
BusGetData data = {
.p_dbus_connection = &dbus_connection,
.p_error = &local_error,
};
g_bus_get(G_BUS_TYPE_SYSTEM, cancellable, _bus_get_cb, &data);
while (!dbus_connection && !local_error)
g_main_context_iteration(main_context, TRUE);
if (!dbus_connection) {
g_propagate_error(error, g_steal_pointer(&local_error));
return NULL;
}
return g_steal_pointer(&dbus_connection);
}
/*****************************************************************************/
void
nm_dbus_connection_call_blocking_callback(GObject *source, GAsyncResult *res, gpointer user_data)
{
NMDBusConnectionCallBlockingData *data = user_data;
nm_assert(data);
nm_assert(!data->result);
nm_assert(!data->error);
data->result = g_dbus_connection_call_finish(G_DBUS_CONNECTION(source), res, &data->error);
}
GVariant *
nm_dbus_connection_call_blocking(NMDBusConnectionCallBlockingData *data, GError **error)
{
GMainContext *main_context = g_main_context_get_thread_default();
gs_free_error GError *local_error = NULL;
gs_unref_variant GVariant *result = NULL;
nm_assert(data);
while (!data->result && !data->error)
g_main_context_iteration(main_context, TRUE);
local_error = g_steal_pointer(&data->error);
result = g_steal_pointer(&data->result);
if (!result) {
g_propagate_error(error, g_steal_pointer(&local_error));
return NULL;
}
return g_steal_pointer(&result);
}