mirror of
https://gitlab.freedesktop.org/NetworkManager/NetworkManager.git
synced 2026-04-04 17:50:37 +02:00
615221a99c
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
294 lines
13 KiB
C
294 lines
13 KiB
C
/* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
/*
|
|
* Copyright (C) 2004 - 2016 Red Hat, Inc.
|
|
* Copyright (C) 2005 - 2008 Novell, Inc.
|
|
*/
|
|
|
|
#ifndef __NETWORKMANAGER_UTILS_H__
|
|
#define __NETWORKMANAGER_UTILS_H__
|
|
|
|
#include "nm-core-utils.h"
|
|
#include "libnm-glib-aux/nm-dedup-multi.h"
|
|
#include "nm-setting-ip-config.h"
|
|
#include "nm-setting-ip6-config.h"
|
|
#include "libnm-platform/nm-platform.h"
|
|
|
|
/*****************************************************************************/
|
|
|
|
const char *nm_utils_get_ip_config_method(NMConnection *connection, int addr_family);
|
|
|
|
const char *nm_utils_get_shared_wifi_permission(NMConnection *connection);
|
|
|
|
void nm_utils_ppp_ip_methods_enabled(NMConnection *connection,
|
|
gboolean *out_ip4_enabled,
|
|
gboolean *out_ip6_enabled);
|
|
|
|
void _nm_utils_complete_generic_with_params(NMPlatform *platform,
|
|
NMConnection *connection,
|
|
const char *ctype,
|
|
NMConnection *const *existing_connections,
|
|
const char *preferred_id,
|
|
const char *fallback_id_prefix,
|
|
const char *ifname_prefix,
|
|
const char *ifname,
|
|
...) G_GNUC_NULL_TERMINATED;
|
|
|
|
#define nm_utils_complete_generic_with_params(platform, \
|
|
connection, \
|
|
ctype, \
|
|
existing_connections, \
|
|
preferred_id, \
|
|
fallback_id_prefix, \
|
|
ifname_prefix, \
|
|
ifname, \
|
|
...) \
|
|
_nm_utils_complete_generic_with_params(platform, \
|
|
connection, \
|
|
ctype, \
|
|
existing_connections, \
|
|
preferred_id, \
|
|
fallback_id_prefix, \
|
|
ifname_prefix, \
|
|
ifname, \
|
|
##__VA_ARGS__, \
|
|
NULL)
|
|
|
|
static inline void
|
|
nm_utils_complete_generic(NMPlatform *platform,
|
|
NMConnection *connection,
|
|
const char *ctype,
|
|
NMConnection *const *existing_connections,
|
|
const char *preferred_id,
|
|
const char *fallback_id_prefix,
|
|
const char *ifname_prefix,
|
|
const char *ifname,
|
|
gboolean default_enable_ipv6)
|
|
{
|
|
nm_utils_complete_generic_with_params(platform,
|
|
connection,
|
|
ctype,
|
|
existing_connections,
|
|
preferred_id,
|
|
fallback_id_prefix,
|
|
ifname_prefix,
|
|
ifname,
|
|
NM_CONNECTION_NORMALIZE_PARAM_IP6_CONFIG_METHOD,
|
|
default_enable_ipv6
|
|
? NM_SETTING_IP6_CONFIG_METHOD_AUTO
|
|
: NM_SETTING_IP6_CONFIG_METHOD_IGNORE);
|
|
}
|
|
|
|
typedef gboolean(NMUtilsMatchFilterFunc)(NMConnection *connection, gpointer user_data);
|
|
|
|
NMConnection *nm_utils_match_connection(NMConnection *const *connections,
|
|
NMConnection *original,
|
|
gboolean indicated,
|
|
gboolean device_has_carrier,
|
|
gint64 default_v4_metric,
|
|
gint64 default_v6_metric,
|
|
NMUtilsMatchFilterFunc match_filter_func,
|
|
gpointer match_filter_data);
|
|
|
|
int nm_match_spec_device_by_pllink(const NMPlatformLink *pllink,
|
|
const char *match_device_type,
|
|
const char *match_dhcp_plugin,
|
|
const GSList *specs,
|
|
int no_match_value);
|
|
|
|
/*****************************************************************************/
|
|
|
|
NMPlatformRoutingRule *nm_ip_routing_rule_to_platform(const NMIPRoutingRule *rule,
|
|
NMPlatformRoutingRule *out_pl);
|
|
|
|
/*****************************************************************************/
|
|
|
|
/* during shutdown, there are two relevant timeouts. One is
|
|
* NM_SHUTDOWN_TIMEOUT_MS which is plenty of time, that we give for all
|
|
* actions to complete. Of course, during shutdown components should hurry
|
|
* to cleanup.
|
|
*
|
|
* When we initiate shutdown, we should start killing child processes
|
|
* with SIGTERM. If they don't complete within NM_SHUTDOWN_TIMEOUT_MS, we send
|
|
* SIGKILL.
|
|
*
|
|
* After NM_SHUTDOWN_TIMEOUT_MS, NetworkManager will however not yet terminate right
|
|
* away. It iterates the mainloop for another NM_SHUTDOWN_TIMEOUT_MS_WATCHDOG. This
|
|
* should give time to reap the child process (after SIGKILL).
|
|
*
|
|
* So, the maximum time we should wait before sending SIGKILL should be at most
|
|
* NM_SHUTDOWN_TIMEOUT_MS.
|
|
*/
|
|
#define NM_SHUTDOWN_TIMEOUT_MS 1500
|
|
#define NM_SHUTDOWN_TIMEOUT_MS_WATCHDOG 500
|
|
|
|
typedef enum {
|
|
/* There is no watched_obj argument, and the shutdown is delayed until the user
|
|
* explicitly calls unregister on the returned handle. */
|
|
NM_SHUTDOWN_WAIT_TYPE_HANDLE,
|
|
|
|
/* The watched_obj argument is a GObject, and shutdown is delayed until the object
|
|
* gets destroyed (or unregistered). */
|
|
NM_SHUTDOWN_WAIT_TYPE_OBJECT,
|
|
|
|
/* The watched_obj argument is a GCancellable, and shutdown is delayed until the object
|
|
* gets destroyed (or unregistered). Note that after NM_SHUTDOWN_TIMEOUT_MS, the
|
|
* cancellable will be cancelled to notify listeners about the shutdown. */
|
|
NM_SHUTDOWN_WAIT_TYPE_CANCELLABLE,
|
|
} NMShutdownWaitType;
|
|
|
|
typedef struct _NMShutdownWaitObjHandle NMShutdownWaitObjHandle;
|
|
|
|
NMShutdownWaitObjHandle *nm_shutdown_wait_obj_register_full(gpointer watched_obj,
|
|
NMShutdownWaitType wait_type,
|
|
char *msg_reason,
|
|
gboolean free_msg_reason);
|
|
|
|
static inline NMShutdownWaitObjHandle *
|
|
nm_shutdown_wait_obj_register_object_full(gpointer watched_obj,
|
|
char *msg_reason,
|
|
gboolean free_msg_reason)
|
|
{
|
|
return nm_shutdown_wait_obj_register_full(watched_obj,
|
|
NM_SHUTDOWN_WAIT_TYPE_OBJECT,
|
|
msg_reason,
|
|
free_msg_reason);
|
|
}
|
|
|
|
#define nm_shutdown_wait_obj_register_object(watched_obj, msg_reason) \
|
|
nm_shutdown_wait_obj_register_object_full((watched_obj), ("" msg_reason ""), FALSE)
|
|
|
|
static inline NMShutdownWaitObjHandle *
|
|
nm_shutdown_wait_obj_register_handle_full(char *msg_reason, gboolean free_msg_reason)
|
|
{
|
|
return nm_shutdown_wait_obj_register_full(NULL,
|
|
NM_SHUTDOWN_WAIT_TYPE_HANDLE,
|
|
msg_reason,
|
|
free_msg_reason);
|
|
}
|
|
|
|
#define nm_shutdown_wait_obj_register_handle(msg_reason) \
|
|
nm_shutdown_wait_obj_register_handle_full(("" msg_reason ""), FALSE)
|
|
|
|
static inline NMShutdownWaitObjHandle *
|
|
nm_shutdown_wait_obj_register_cancellable_full(GCancellable *watched_obj,
|
|
char *msg_reason,
|
|
gboolean free_msg_reason)
|
|
{
|
|
return nm_shutdown_wait_obj_register_full(watched_obj,
|
|
NM_SHUTDOWN_WAIT_TYPE_CANCELLABLE,
|
|
msg_reason,
|
|
free_msg_reason);
|
|
}
|
|
|
|
#define nm_shutdown_wait_obj_register_cancellable(watched_obj, msg_reason) \
|
|
nm_shutdown_wait_obj_register_cancellable_full((watched_obj), ("" msg_reason ""), FALSE)
|
|
|
|
void nm_shutdown_wait_obj_unregister(NMShutdownWaitObjHandle *handle);
|
|
|
|
/*****************************************************************************/
|
|
|
|
const char *nm_utils_file_is_in_path(const char *abs_filename, const char *abs_path);
|
|
|
|
/*****************************************************************************/
|
|
|
|
GPtrArray *
|
|
nm_utils_qdiscs_from_tc_setting(NMPlatform *platform, NMSettingTCConfig *s_tc, int ip_ifindex);
|
|
GPtrArray *
|
|
nm_utils_tfilters_from_tc_setting(NMPlatform *platform, NMSettingTCConfig *s_tc, int ip_ifindex);
|
|
|
|
void nm_utils_ip_route_attribute_to_platform(int addr_family,
|
|
NMIPRoute *s_route,
|
|
NMPlatformIPRoute *r,
|
|
gint64 route_table);
|
|
|
|
void nm_utils_ip_addresses_to_dbus(int addr_family,
|
|
const NMDedupMultiHeadEntry *head_entry,
|
|
const NMPObject *best_default_route,
|
|
GVariant **out_address_data,
|
|
GVariant **out_addresses);
|
|
|
|
void nm_utils_ip_routes_to_dbus(int addr_family,
|
|
const NMDedupMultiHeadEntry *head_entry,
|
|
GVariant **out_route_data,
|
|
GVariant **out_routes);
|
|
|
|
/*****************************************************************************/
|
|
|
|
/* For now, all we track about a DHCP lease is the GHashTable with
|
|
* the options.
|
|
*
|
|
* We don't add a separate type for that, but we also don't want to use
|
|
* GHashTable directly (because most importantly leases should be immutable
|
|
* and passing a GHashTable pointer around neither makes it clear that
|
|
* this is a lease nor that it's immutable.
|
|
*
|
|
* Instead, add a simple opaque pointer and accessors that cast to a GHashTable.
|
|
*
|
|
* It has no overhead at run time, but gives some rudimentary type safety. */
|
|
|
|
typedef struct _NMDhcpLease NMDhcpLease;
|
|
|
|
static inline NMDhcpLease *
|
|
nm_dhcp_lease_new_from_options(GHashTable *options_take)
|
|
{
|
|
/* a NMDhcpLease is really just a GHashTable. But it's also supposed to be *immutable*.
|
|
*
|
|
* Hence, the API here takes over ownership of the reference to @options_take, that
|
|
* is to emphasize that we acquire ownership of the hash, and it should not be modified
|
|
* anymore. */
|
|
return (NMDhcpLease *) options_take;
|
|
}
|
|
|
|
static inline GHashTable *
|
|
nm_dhcp_lease_get_options(NMDhcpLease *lease)
|
|
{
|
|
return (GHashTable *) lease;
|
|
}
|
|
|
|
static inline NMDhcpLease *
|
|
nm_dhcp_lease_ref(NMDhcpLease *lease)
|
|
{
|
|
if (lease)
|
|
g_hash_table_ref((GHashTable *) lease);
|
|
return lease;
|
|
}
|
|
|
|
static inline NMDhcpLease *
|
|
nm_dhcp_lease_unref(NMDhcpLease *lease)
|
|
{
|
|
if (lease)
|
|
g_hash_table_unref((GHashTable *) lease);
|
|
return NULL;
|
|
}
|
|
|
|
static inline const char *
|
|
nm_dhcp_lease_lookup_option(NMDhcpLease *lease, const char *option)
|
|
{
|
|
nm_assert(option);
|
|
|
|
return nm_g_hash_table_lookup((GHashTable *) lease, option);
|
|
}
|
|
|
|
NM_AUTO_DEFINE_FCN(NMDhcpLease *, _nm_auto_unref_dhcplease, nm_dhcp_lease_unref);
|
|
#define nm_auto_unref_dhcplease nm_auto(_nm_auto_unref_dhcplease)
|
|
|
|
/*****************************************************************************/
|
|
|
|
NMSetting *nm_utils_platform_capture_ip_setting(NMPlatform *platform,
|
|
int addr_family,
|
|
int ifindex,
|
|
gboolean maybe_ipv6_disabled);
|
|
|
|
/*****************************************************************************/
|
|
|
|
void nm_platform_setup(NMPlatform *instance);
|
|
NMPlatform *nm_platform_get(void);
|
|
|
|
#define NM_PLATFORM_GET (nm_platform_get())
|
|
|
|
void nm_linux_platform_setup(void);
|
|
void nm_linux_platform_setup_with_tc_cache(void);
|
|
|
|
/*****************************************************************************/
|
|
|
|
#endif /* __NETWORKMANAGER_UTILS_H__ */
|