mirror of
https://gitlab.freedesktop.org/NetworkManager/NetworkManager.git
synced 2026-01-08 13:00:22 +01:00
d2beefa658
It's not a big difference and unclear which is preferable. It however seems slighly clearer to require the user to provide a pointer, instead of a variable for which the macro itself takes the reference. It makes it clearer that the "iter" and "obj" arguments are modified by the macro.
449 lines
19 KiB
C
449 lines
19 KiB
C
// SPDX-License-Identifier: LGPL-2.1+
|
|
|
|
#ifndef __NM_L3_CONFIG_DATA_H__
|
|
#define __NM_L3_CONFIG_DATA_H__
|
|
|
|
#include "nm-glib-aux/nm-dedup-multi.h"
|
|
#include "nm-setting-connection.h"
|
|
#include "nm-setting-ip6-config.h"
|
|
#include "platform/nm-platform.h"
|
|
#include "platform/nmp-object.h"
|
|
|
|
typedef enum {
|
|
NM_L3_CONFIG_DAT_FLAGS_NONE = 0,
|
|
|
|
/* if set, then the merge flag NM_L3_CONFIG_MERGE_FLAGS_NO_DEFAULT_ROUTES gets
|
|
* ignored during merge. */
|
|
NM_L3_CONFIG_DAT_FLAGS_IGNORE_MERGE_NO_DEFAULT_ROUTES = (1ull << 0),
|
|
|
|
NM_L3_CONFIG_DAT_FLAGS_HAS_DNS_PRIORITY_4 = (1ull << 1),
|
|
NM_L3_CONFIG_DAT_FLAGS_HAS_DNS_PRIORITY_6 = (1ull << 2),
|
|
#define NM_L3_CONFIG_DAT_FLAGS_HAS_DNS_PRIORITY(is_ipv4) ( (is_ipv4) \
|
|
? NM_L3_CONFIG_DAT_FLAGS_HAS_DNS_PRIORITY_4 \
|
|
: NM_L3_CONFIG_DAT_FLAGS_HAS_DNS_PRIORITY_6)
|
|
|
|
} NML3ConfigDatFlags;
|
|
|
|
typedef enum {
|
|
NM_L3_CONFIG_ADD_FLAGS_NONE = 0,
|
|
|
|
/* If the object does not yet exist, it will be added. If it already exists,
|
|
* by default the object will be replaced. With this flag, the new object will
|
|
* be merged with the existing one. */
|
|
NM_L3_CONFIG_ADD_FLAGS_MERGE = (1ull << 0),
|
|
|
|
/* If the object does not yet exist, it will be added. If it already exists,
|
|
* by default the object will be replaced. With this flag, the add will have
|
|
* no effect and the existing object will be kept. */
|
|
NM_L3_CONFIG_ADD_FLAGS_EXCLUSIVE = (1ull << 1),
|
|
|
|
/* A new object gets appended by default. If the object already exists,
|
|
* by default it will not be moved. With APPEND-FORCE, we will always move
|
|
* an existing object to the end of the list. */
|
|
NM_L3_CONFIG_ADD_FLAGS_APPEND_FORCE = (1ull << 2),
|
|
} NML3ConfigAddFlags;
|
|
|
|
/**
|
|
* NML3ConfigMergeFlags:
|
|
* @NM_L3_CONFIG_MERGE_FLAGS_NONE: no flags set
|
|
* @NM_L3_CONFIG_MERGE_FLAGS_NO_ROUTES: don't merge routes
|
|
* @NM_L3_CONFIG_MERGE_FLAGS_NO_DEFAULT_ROUTES: don't merge default routes.
|
|
* Note that if the respective NML3ConfigData has NM_L3_CONFIG_DAT_FLAGS_IGNORE_MERGE_NO_DEFAULT_ROUTES
|
|
* set, this flag gets ignored during merge.
|
|
* @NM_L3_CONFIG_MERGE_FLAGS_NO_DNS: don't merge DNS information
|
|
* @NM_L3_CONFIG_MERGE_FLAGS_EXTERNAL: mark new addresses as external
|
|
*/
|
|
typedef enum {
|
|
NM_L3_CONFIG_MERGE_FLAGS_NONE = 0,
|
|
NM_L3_CONFIG_MERGE_FLAGS_NO_ROUTES = (1LL << 0),
|
|
NM_L3_CONFIG_MERGE_FLAGS_NO_DEFAULT_ROUTES = (1LL << 1),
|
|
NM_L3_CONFIG_MERGE_FLAGS_NO_DNS = (1LL << 2),
|
|
NM_L3_CONFIG_MERGE_FLAGS_EXTERNAL = (1LL << 3),
|
|
} NML3ConfigMergeFlags;
|
|
|
|
/*****************************************************************************/
|
|
|
|
NML3ConfigData *nm_l3_config_data_new (NMDedupMultiIndex *multi_idx,
|
|
int ifindex);
|
|
const NML3ConfigData *nm_l3_config_data_ref (const NML3ConfigData *self);
|
|
const NML3ConfigData *nm_l3_config_data_ref_and_seal (const NML3ConfigData *self);
|
|
const NML3ConfigData *nm_l3_config_data_seal (const NML3ConfigData *self);
|
|
void nm_l3_config_data_unref (const NML3ConfigData *self);
|
|
|
|
NM_AUTO_DEFINE_FCN0 (const NML3ConfigData *, _nm_auto_unref_l3cd, nm_l3_config_data_unref);
|
|
#define nm_auto_unref_l3cd nm_auto (_nm_auto_unref_l3cd)
|
|
|
|
NM_AUTO_DEFINE_FCN0 (NML3ConfigData *, _nm_auto_unref_l3cd_init, nm_l3_config_data_unref);
|
|
#define nm_auto_unref_l3cd_init nm_auto (_nm_auto_unref_l3cd_init)
|
|
|
|
gboolean nm_l3_config_data_is_sealed (const NML3ConfigData *self);
|
|
|
|
NML3ConfigData *nm_l3_config_data_new_clone (const NML3ConfigData *src,
|
|
int ifindex);
|
|
|
|
NML3ConfigData *nm_l3_config_data_new_from_connection (NMDedupMultiIndex *multi_idx,
|
|
int ifindex,
|
|
NMConnection *connection,
|
|
guint32 route_table_4,
|
|
guint32 route_table_6,
|
|
guint32 route_metric_4,
|
|
guint32 route_metric_6);
|
|
|
|
NML3ConfigData *nm_l3_config_data_new_from_platform (NMDedupMultiIndex *multi_idx,
|
|
int ifindex,
|
|
NMPlatform *platform,
|
|
NMSettingIP6ConfigPrivacy ipv6_privacy_rfc4941);
|
|
|
|
typedef gboolean (*NML3ConfigMergeHookAddObj) (const NML3ConfigData *l3cd,
|
|
const NMPObject *obj,
|
|
gpointer user_data);
|
|
|
|
void nm_l3_config_data_merge (NML3ConfigData *self,
|
|
const NML3ConfigData *src,
|
|
NML3ConfigMergeFlags merge_flags,
|
|
const guint32 *default_route_penalty_x /* length 2, for IS_IPv4 */,
|
|
NML3ConfigMergeHookAddObj hook_add_addr,
|
|
gpointer hook_user_data);
|
|
|
|
void nm_l3_config_data_add_dependent_routes (NML3ConfigData *self,
|
|
int addr_family,
|
|
guint32 route_table,
|
|
guint32 route_metric,
|
|
gboolean is_vrf,
|
|
GPtrArray **out_ip4_dev_route_blacklist);
|
|
|
|
/*****************************************************************************/
|
|
|
|
int nm_l3_config_data_get_ifindex (const NML3ConfigData *self);
|
|
|
|
NMDedupMultiIndex *nm_l3_config_data_get_multi_idx (const NML3ConfigData *self);
|
|
|
|
static inline gboolean
|
|
NM_IS_L3_CONFIG_DATA (const NML3ConfigData *self)
|
|
{
|
|
/* NML3ConfigData is not an NMObject, so we cannot ask which type it has.
|
|
* This check here is really only useful for assertions, and there it is
|
|
* enough to check whether the pointer is not NULL.
|
|
*
|
|
* Additionally, also call nm_l3_config_data_get_ifindex(), which does more
|
|
* checks during nm_assert(). */
|
|
nm_assert (nm_l3_config_data_get_ifindex (self) > 0);
|
|
return !!self;
|
|
}
|
|
|
|
/*****************************************************************************/
|
|
|
|
int nm_l3_config_data_cmp (const NML3ConfigData *a, const NML3ConfigData *b);
|
|
|
|
static inline gboolean
|
|
nm_l3_config_data_equal (const NML3ConfigData *a, const NML3ConfigData *b)
|
|
{
|
|
return nm_l3_config_data_cmp (a, b) == 0;
|
|
}
|
|
|
|
/*****************************************************************************/
|
|
|
|
const NMDedupMultiIdxType *nm_l3_config_data_lookup_index (const NML3ConfigData *self,
|
|
NMPObjectType obj_type);
|
|
|
|
const NMDedupMultiEntry *nm_l3_config_data_lookup_obj (const NML3ConfigData *self,
|
|
const NMPObject *obj);
|
|
|
|
const NMDedupMultiEntry *nm_l3_config_data_lookup_route_obj (const NML3ConfigData *self,
|
|
const NMPObject *needle);
|
|
|
|
const NMDedupMultiEntry *nm_l3_config_data_lookup_route (const NML3ConfigData *self,
|
|
int addr_family,
|
|
const NMPlatformIPRoute *needle);
|
|
|
|
const NMDedupMultiHeadEntry *nm_l3_config_data_lookup_objs (const NML3ConfigData *self, NMPObjectType obj_type);
|
|
|
|
static inline const NMDedupMultiHeadEntry *
|
|
nm_l3_config_data_lookup_addresses (const NML3ConfigData *self, int addr_family)
|
|
{
|
|
nm_assert_addr_family (addr_family);
|
|
|
|
return nm_l3_config_data_lookup_objs (self,
|
|
addr_family == AF_INET
|
|
? NMP_OBJECT_TYPE_IP4_ADDRESS
|
|
: NMP_OBJECT_TYPE_IP6_ADDRESS);
|
|
}
|
|
|
|
static inline const NMDedupMultiHeadEntry *
|
|
nm_l3_config_data_lookup_routes (const NML3ConfigData *self, int addr_family)
|
|
{
|
|
nm_assert_addr_family (addr_family);
|
|
|
|
return nm_l3_config_data_lookup_objs (self,
|
|
addr_family == AF_INET
|
|
? NMP_OBJECT_TYPE_IP4_ROUTE
|
|
: NMP_OBJECT_TYPE_IP6_ROUTE);
|
|
}
|
|
|
|
#define nm_l3_config_data_iter_obj_for_each(iter, self, obj, type) \
|
|
for (nm_dedup_multi_iter_init ((iter), nm_l3_config_data_lookup_objs ((self), (type))); \
|
|
nm_platform_dedup_multi_iter_next_obj ((iter), (obj), (type)); \
|
|
)
|
|
|
|
#define nm_l3_config_data_iter_ip4_address_for_each(iter, self, address) \
|
|
for (nm_dedup_multi_iter_init ((iter), nm_l3_config_data_lookup_addresses ((self), AF_INET)); \
|
|
nm_platform_dedup_multi_iter_next_ip4_address ((iter), (address)); \
|
|
)
|
|
|
|
#define nm_l3_config_data_iter_ip6_address_for_each(iter, self, address) \
|
|
for (nm_dedup_multi_iter_init ((iter), nm_l3_config_data_lookup_addresses ((self), AF_INET6)); \
|
|
nm_platform_dedup_multi_iter_next_ip6_address ((iter), (address)); \
|
|
)
|
|
|
|
#define nm_l3_config_data_iter_ip4_route_for_each(iter, self, route) \
|
|
for (nm_dedup_multi_iter_init ((iter), nm_l3_config_data_lookup_routes ((self), AF_INET)); \
|
|
nm_platform_dedup_multi_iter_next_ip4_route ((iter), (route)); \
|
|
)
|
|
|
|
#define nm_l3_config_data_iter_ip6_route_for_each(iter, self, route) \
|
|
for (nm_dedup_multi_iter_init ((iter), nm_l3_config_data_lookup_routes ((self), AF_INET6)); \
|
|
nm_platform_dedup_multi_iter_next_ip6_route ((iter), (route)); \
|
|
)
|
|
|
|
static inline guint
|
|
nm_l3_config_data_get_num_objs (const NML3ConfigData *self, NMPObjectType obj_type)
|
|
{
|
|
const NMDedupMultiHeadEntry *head_entry;
|
|
|
|
head_entry = nm_l3_config_data_lookup_objs (self, obj_type);
|
|
return head_entry ? head_entry->len : 0u;
|
|
}
|
|
|
|
static inline guint
|
|
nm_l3_config_data_get_num_addresses (const NML3ConfigData *self, int addr_family)
|
|
{
|
|
return nm_l3_config_data_get_num_objs (self,
|
|
NM_IS_IPv4 (addr_family)
|
|
? NMP_OBJECT_TYPE_IP4_ADDRESS
|
|
: NMP_OBJECT_TYPE_IP6_ADDRESS);
|
|
}
|
|
|
|
static inline guint
|
|
nm_l3_config_data_get_num_routes (const NML3ConfigData *self, int addr_family)
|
|
{
|
|
return nm_l3_config_data_get_num_objs (self,
|
|
NM_IS_IPv4 (addr_family)
|
|
? NMP_OBJECT_TYPE_IP4_ROUTE
|
|
: NMP_OBJECT_TYPE_IP6_ROUTE);
|
|
}
|
|
|
|
const NMPObject *nmtst_l3_config_data_get_obj_at (const NML3ConfigData *self,
|
|
NMPObjectType obj_type,
|
|
guint i);
|
|
|
|
static inline const NMPlatformIP4Address *
|
|
nmtst_l3_config_data_get_address_at_4 (const NML3ConfigData *self,
|
|
guint i)
|
|
{
|
|
return NMP_OBJECT_CAST_IP4_ADDRESS (nmtst_l3_config_data_get_obj_at (self,
|
|
NMP_OBJECT_TYPE_IP4_ADDRESS,
|
|
i));
|
|
}
|
|
|
|
static inline const NMPlatformIP6Address *
|
|
nmtst_l3_config_data_get_address_at_6 (const NML3ConfigData *self,
|
|
guint i)
|
|
{
|
|
return NMP_OBJECT_CAST_IP6_ADDRESS (nmtst_l3_config_data_get_obj_at (self,
|
|
NMP_OBJECT_TYPE_IP6_ADDRESS,
|
|
i));
|
|
}
|
|
|
|
static inline const NMPlatformIP4Route *
|
|
nmtst_l3_config_data_get_route_at_4 (const NML3ConfigData *self,
|
|
guint i)
|
|
{
|
|
return NMP_OBJECT_CAST_IP4_ROUTE (nmtst_l3_config_data_get_obj_at (self,
|
|
NMP_OBJECT_TYPE_IP4_ROUTE,
|
|
i));
|
|
}
|
|
|
|
static inline const NMPlatformIP6Route *
|
|
nmtst_l3_config_data_get_route_at_6 (const NML3ConfigData *self,
|
|
guint i)
|
|
{
|
|
return NMP_OBJECT_CAST_IP6_ROUTE (nmtst_l3_config_data_get_obj_at (self,
|
|
NMP_OBJECT_TYPE_IP6_ROUTE,
|
|
i));
|
|
}
|
|
|
|
/*****************************************************************************/
|
|
|
|
NML3ConfigDatFlags nm_l3_config_data_get_flags (const NML3ConfigData *self);
|
|
|
|
void nm_l3_config_data_set_flags_full (NML3ConfigData *self,
|
|
NML3ConfigDatFlags flags,
|
|
NML3ConfigDatFlags mask);
|
|
|
|
static inline void
|
|
nm_l3_config_data_set_flags (NML3ConfigData *self,
|
|
NML3ConfigDatFlags flags)
|
|
{
|
|
nm_l3_config_data_set_flags_full (self, flags, flags);
|
|
}
|
|
|
|
static inline void
|
|
nm_l3_config_data_unset_flags (NML3ConfigData *self,
|
|
NML3ConfigDatFlags flags)
|
|
{
|
|
nm_l3_config_data_set_flags_full (self, NM_L3_CONFIG_DAT_FLAGS_NONE, flags);
|
|
}
|
|
|
|
/*****************************************************************************/
|
|
|
|
gboolean nm_l3_config_data_set_source (NML3ConfigData *self,
|
|
NMIPConfigSource source);
|
|
|
|
gboolean nm_l3_config_data_add_address_full (NML3ConfigData *self,
|
|
int addr_family,
|
|
const NMPObject *obj_new,
|
|
const NMPlatformIPAddress *pl_new,
|
|
NML3ConfigAddFlags add_flags,
|
|
const NMPObject **out_obj_new);
|
|
|
|
static inline gboolean
|
|
nm_l3_config_data_add_address (NML3ConfigData *self,
|
|
int addr_family,
|
|
const NMPObject *obj_new,
|
|
const NMPlatformIPAddress *pl_new)
|
|
{
|
|
return nm_l3_config_data_add_address_full (self,
|
|
addr_family,
|
|
obj_new,
|
|
pl_new,
|
|
NM_L3_CONFIG_ADD_FLAGS_MERGE,
|
|
NULL);
|
|
}
|
|
|
|
static inline gboolean
|
|
nm_l3_config_data_add_address_4 (NML3ConfigData *self, const NMPlatformIP4Address *addr)
|
|
{
|
|
return nm_l3_config_data_add_address (self, AF_INET, NULL, NM_PLATFORM_IP_ADDRESS_CAST (addr));
|
|
}
|
|
|
|
static inline gboolean
|
|
nm_l3_config_data_add_address_6 (NML3ConfigData *self, const NMPlatformIP6Address *addr)
|
|
{
|
|
return nm_l3_config_data_add_address (self, AF_INET6, NULL, NM_PLATFORM_IP_ADDRESS_CAST (addr));
|
|
}
|
|
|
|
gboolean nm_l3_config_data_add_route_full (NML3ConfigData *self,
|
|
int addr_family,
|
|
const NMPObject *obj_new,
|
|
const NMPlatformIPRoute *pl_new,
|
|
NML3ConfigAddFlags add_flags,
|
|
const NMPObject **out_obj_new,
|
|
gboolean *out_changed_best_default_route);
|
|
|
|
static inline gboolean
|
|
nm_l3_config_data_add_route (NML3ConfigData *self,
|
|
int addr_family,
|
|
const NMPObject *obj_new,
|
|
const NMPlatformIPRoute *pl_new)
|
|
{
|
|
return nm_l3_config_data_add_route_full (self,
|
|
addr_family,
|
|
obj_new,
|
|
pl_new,
|
|
NM_L3_CONFIG_ADD_FLAGS_MERGE,
|
|
NULL,
|
|
NULL);
|
|
}
|
|
|
|
static inline gboolean
|
|
nm_l3_config_data_add_route_4 (NML3ConfigData *self, const NMPlatformIP4Route *rt)
|
|
{
|
|
return nm_l3_config_data_add_route (self, AF_INET, NULL, NM_PLATFORM_IP_ROUTE_CAST (rt));
|
|
}
|
|
|
|
static inline gboolean
|
|
nm_l3_config_data_add_route_6 (NML3ConfigData *self, const NMPlatformIP6Route *rt)
|
|
{
|
|
return nm_l3_config_data_add_route (self, AF_INET6, NULL, NM_PLATFORM_IP_ROUTE_CAST (rt));
|
|
}
|
|
|
|
const NMPObject *nm_l3_config_data_get_best_default_route (const NML3ConfigData *self,
|
|
int addr_family);
|
|
|
|
gboolean nm_l3_config_data_set_mdns (NML3ConfigData *self,
|
|
NMSettingConnectionMdns mdns);
|
|
|
|
gboolean nm_l3_config_data_set_llmnr (NML3ConfigData *self,
|
|
NMSettingConnectionLlmnr llmnr);
|
|
|
|
NMIPRouteTableSyncMode nm_l3_config_data_get_route_table_sync (const NML3ConfigData *self,
|
|
int addr_family);
|
|
|
|
gboolean nm_l3_config_data_set_route_table_sync (NML3ConfigData *self,
|
|
int addr_family,
|
|
NMIPRouteTableSyncMode route_table_sync);
|
|
|
|
NMTernary nm_l3_config_data_get_metered (const NML3ConfigData *self);
|
|
|
|
gboolean nm_l3_config_data_set_metered (NML3ConfigData *self,
|
|
NMTernary metered);
|
|
|
|
guint32 nm_l3_config_data_get_mtu (const NML3ConfigData *self);
|
|
|
|
gboolean nm_l3_config_data_set_mtu (NML3ConfigData *self,
|
|
guint32 mtu);
|
|
|
|
const in_addr_t *nm_l3_config_data_get_wins (const NML3ConfigData *self,
|
|
guint *out_len);
|
|
|
|
gboolean nm_l3_config_data_add_wins (NML3ConfigData *self,
|
|
in_addr_t wins);
|
|
|
|
gconstpointer nm_l3_config_data_get_nameservers (const NML3ConfigData *self,
|
|
int addr_family,
|
|
guint *out_len);
|
|
|
|
gboolean nm_l3_config_data_add_nameserver (NML3ConfigData *self,
|
|
int addr_family,
|
|
gconstpointer /* (const NMIPAddr *) */ nameserver);
|
|
|
|
gboolean nm_l3_config_data_add_nis_server (NML3ConfigData *self,
|
|
in_addr_t nis_server);
|
|
|
|
gboolean nm_l3_config_data_set_nis_domain (NML3ConfigData *self,
|
|
const char *nis_domain);
|
|
|
|
gboolean nm_l3_config_data_add_domain (NML3ConfigData *self,
|
|
int addr_family,
|
|
const char *domain);
|
|
|
|
const char *const*nm_l3_config_data_get_searches (const NML3ConfigData *self,
|
|
int addr_family,
|
|
guint *out_len);
|
|
|
|
gboolean nm_l3_config_data_add_search (NML3ConfigData *self,
|
|
int addr_family,
|
|
const char *search);
|
|
|
|
gboolean nm_l3_config_data_add_dns_option (NML3ConfigData *self,
|
|
int addr_family,
|
|
const char *dns_option);
|
|
|
|
gboolean nm_l3_config_data_set_dns_priority (NML3ConfigData *self,
|
|
int addr_family,
|
|
int dns_priority);
|
|
|
|
static inline const NMIPAddr *
|
|
nmtst_l3_config_data_get_best_gateway (const NML3ConfigData *self,
|
|
int addr_family)
|
|
{
|
|
const NMPObject *rt;
|
|
|
|
rt = nm_l3_config_data_get_best_default_route (self, addr_family);
|
|
if (!rt)
|
|
return NULL;
|
|
|
|
return nm_platform_ip_route_get_gateway (addr_family, NMP_OBJECT_CAST_IP_ROUTE (rt));
|
|
}
|
|
|
|
#endif /* __NM_L3_CONFIG_DATA_H__ */
|