[thirdparty/systemd.git] / src / libsystemd / sd-netlink / netlink-util.h

/* SPDX-License-Identifier: LGPL-2.1-or-later */
#pragma once

#include <linux/rtnetlink.h>

#include "forward.h"
#include "in-addr-util.h"

#define RTA_FLAGS(rta) ((rta)->rta_type & ~NLA_TYPE_MASK)
#define RTA_TYPE(rta)  ((rta)->rta_type & NLA_TYPE_MASK)

/* See struct rtvia in rtnetlink.h */
typedef struct RouteVia {
        uint16_t family;
        union in_addr_union address;
} _packed_ RouteVia;

int rtnl_get_link_info_full(
                sd_netlink **rtnl,
                int ifindex,
                char **ret_name,
                char ***ret_altnames,
                unsigned short *ret_iftype,
                unsigned *ret_flags,
                char **ret_kind,
                struct hw_addr_data *ret_hw_addr,
                struct hw_addr_data *ret_permanent_hw_addr);

static inline int rtnl_get_ifname_full(sd_netlink **rtnl, int ifindex, char **ret_name, char ***ret_altnames) {
        return rtnl_get_link_info_full(
                        rtnl,
                        ifindex,
                        ret_name,
                        ret_altnames,
                        /* ret_iftype = */ NULL,
                        /* ret_flags = */ NULL,
                        /* ret_kind = */ NULL,
                        /* ret_hw_addr = */ NULL,
                        /* ret_permanent_hw_addr = */ NULL);
}
static inline int rtnl_get_ifname(sd_netlink **rtnl, int ifindex, char **ret) {
        return rtnl_get_ifname_full(rtnl, ifindex, ret, NULL);
}
static inline int rtnl_get_link_alternative_names(sd_netlink **rtnl, int ifindex, char ***ret) {
        return rtnl_get_ifname_full(rtnl, ifindex, NULL, ret);
}
static inline int rtnl_get_link_info(
                sd_netlink **rtnl,
                int ifindex,
                unsigned short *ret_iftype,
                unsigned *ret_flags,
                char **ret_kind,
                struct hw_addr_data *ret_hw_addr,
                struct hw_addr_data *ret_permanent_hw_addr) {

        return rtnl_get_link_info_full(
                        rtnl,
                        ifindex,
                        /* ret_name = */ NULL,
                        /* ret_altnames = */ NULL,
                        ret_iftype,
                        ret_flags,
                        ret_kind,
                        ret_hw_addr,
                        ret_permanent_hw_addr);
}
static inline int rtnl_get_link_hw_addr(sd_netlink **rtnl, int ifindex, struct hw_addr_data *ret) {
        return rtnl_get_link_info(
                        rtnl,
                        ifindex,
                        /* ret_iftype = */ NULL,
                        /* ret_flags = */ NULL,
                        /* ret_kind = */ NULL,
                        ret,
                        /* ret_permanent_hw_addr = */ NULL);
}

typedef enum ResolveInterfaceNameFlag {
        RESOLVE_IFNAME_MAIN        = 1 << 0, /* resolve main interface name */
        RESOLVE_IFNAME_ALTERNATIVE = 1 << 1, /* resolve alternative name */
        RESOLVE_IFNAME_NUMERIC     = 1 << 2, /* resolve decimal formatted ifindex */
        _RESOLVE_IFNAME_ALL        = RESOLVE_IFNAME_MAIN | RESOLVE_IFNAME_ALTERNATIVE | RESOLVE_IFNAME_NUMERIC,
} ResolveInterfaceNameFlag;

int rtnl_resolve_ifname_full(
                  sd_netlink **rtnl,
                  ResolveInterfaceNameFlag flags,
                  const char *name,
                  char **ret_name,
                  char ***ret_altnames);
static inline int rtnl_resolve_link_alternative_name(sd_netlink **rtnl, const char *name, char **ret) {
        return rtnl_resolve_ifname_full(rtnl, RESOLVE_IFNAME_ALTERNATIVE, name, ret, NULL);
}
static inline int rtnl_resolve_ifname(sd_netlink **rtnl, const char *name) {
        return rtnl_resolve_ifname_full(rtnl, RESOLVE_IFNAME_MAIN | RESOLVE_IFNAME_ALTERNATIVE, name, NULL, NULL);
}
static inline int rtnl_resolve_interface(sd_netlink **rtnl, const char *name) {
        return rtnl_resolve_ifname_full(rtnl, _RESOLVE_IFNAME_ALL, name, NULL, NULL);
}
int rtnl_resolve_interface_or_warn(sd_netlink **rtnl, const char *name);

int rtnl_set_link_alternative_names(sd_netlink **rtnl, int ifindex, char* const *alternative_names);
int rtnl_set_link_alternative_names_by_ifname(sd_netlink **rtnl, const char *ifname, char* const *alternative_names);
int rtnl_delete_link_alternative_names(sd_netlink **rtnl, int ifindex, char* const *alternative_names);
int rtnl_rename_link(sd_netlink **rtnl, const char *orig_name, const char *new_name);
int rtnl_set_link_name(sd_netlink **rtnl, int ifindex, const char *name, char* const* alternative_names);
static inline int rtnl_append_link_alternative_names(sd_netlink **rtnl, int ifindex, char* const *alternative_names) {
        return rtnl_set_link_name(rtnl, ifindex, NULL, alternative_names);
}

int rtnl_set_link_properties(
                sd_netlink **rtnl,
                int ifindex,
                const char *alias,
                const struct hw_addr_data *hw_addr,
                uint32_t txqueues,
                uint32_t rxqueues,
                uint32_t txqueuelen,
                uint32_t mtu,
                uint32_t gso_max_size,
                size_t gso_max_segments);

int rtnl_log_parse_error(int r);
int rtnl_log_create_error(int r);

#define netlink_call_async(nl, ret_slot, message, callback, destroy_callback, userdata) \
        ({                                                              \
                int (*_callback_)(sd_netlink *, sd_netlink_message *, typeof(userdata)) = callback; \
                void (*_destroy_)(typeof(userdata)) = destroy_callback; \
                sd_netlink_call_async(nl, ret_slot, message,            \
                                      (sd_netlink_message_handler_t) _callback_, \
                                      (sd_netlink_destroy_t) _destroy_, \
                                      userdata, 0, __func__);           \
        })

#define netlink_add_match(nl, ret_slot, match, callback, destroy_callback, userdata, description) \
        ({                                                              \
                int (*_callback_)(sd_netlink *, sd_netlink_message *, typeof(userdata)) = callback; \
                void (*_destroy_)(typeof(userdata)) = destroy_callback; \
                sd_netlink_add_match(nl, ret_slot, match,               \
                                     (sd_netlink_message_handler_t) _callback_, \
                                     (sd_netlink_destroy_t) _destroy_,  \
                                     userdata, description);            \
        })

#define genl_add_match(nl, ret_slot, family, group, cmd, callback, destroy_callback, userdata, description) \
        ({                                                              \
                int (*_callback_)(sd_netlink *, sd_netlink_message *, typeof(userdata)) = callback; \
                void (*_destroy_)(typeof(userdata)) = destroy_callback; \
                sd_genl_add_match(nl, ret_slot, family, group, cmd,     \
                                  (sd_netlink_message_handler_t) _callback_, \
                                  (sd_netlink_destroy_t) _destroy_,     \
                                  userdata, description);               \
        })

int netlink_message_append_hw_addr(sd_netlink_message *m, unsigned short type, const struct hw_addr_data *data);
int netlink_message_append_in_addr_union(sd_netlink_message *m, unsigned short type, int family, const union in_addr_union *data);
int netlink_message_append_sockaddr_union(sd_netlink_message *m, unsigned short type, const union sockaddr_union *data);

int netlink_message_read_hw_addr(sd_netlink_message *m, unsigned short type, struct hw_addr_data *data);
int netlink_message_read_in_addr_union(sd_netlink_message *m, unsigned short type, int family, union in_addr_union *data);

void rtattr_append_attribute_internal(struct rtattr *rta, unsigned short type, const void *data, size_t data_length);
int rtattr_append_attribute(struct rtattr **rta, unsigned short type, const void *data, size_t data_length);

void netlink_seal_message(sd_netlink *nl, sd_netlink_message *m);

size_t netlink_get_reply_callback_count(sd_netlink *nl);

/* TODO: to be exported later */
int sd_netlink_sendv(sd_netlink *nl, sd_netlink_message **messages, size_t msgcnt, uint32_t **ret_serial);
Commit	Line	Data
db9ecf05	1	/* SPDX-License-Identifier: LGPL-2.1-or-later */
a2cdd907 LP	2	#pragma once
a2cdd907 LP	3
c16c7808 SS	4	#include <linux/rtnetlink.h>
c16c7808 SS	5
5cdf13c7	6	#include "forward.h"
67b19a49	7	#include "in-addr-util.h"
d8921c6d	8
8f8b39c8 YW	9	#define RTA_FLAGS(rta) ((rta)->rta_type & ~NLA_TYPE_MASK)
	10	#define RTA_TYPE(rta) ((rta)->rta_type & NLA_TYPE_MASK)
	11
2fe1d557 YW	12	/* See struct rtvia in rtnetlink.h */
	13	typedef struct RouteVia {
	14	uint16_t family;
	15	union in_addr_union address;
	16	} _packed_ RouteVia;
	17
0e44a7c0 YW	18	int rtnl_get_link_info_full(
	19	sd_netlink **rtnl,
	20	int ifindex,
	21	char **ret_name,
	22	char ***ret_altnames,
	23	unsigned short *ret_iftype,
	24	unsigned *ret_flags,
	25	char **ret_kind,
	26	struct hw_addr_data *ret_hw_addr,
	27	struct hw_addr_data *ret_permanent_hw_addr);
	28
	29	static inline int rtnl_get_ifname_full(sd_netlink rtnl, int ifindex, char ret_name, char ***ret_altnames) {
	30	return rtnl_get_link_info_full(
	31	rtnl,
	32	ifindex,
	33	ret_name,
	34	ret_altnames,
	35	/* ret_iftype = */ NULL,
	36	/* ret_flags = */ NULL,
	37	/* ret_kind = */ NULL,
	38	/* ret_hw_addr = */ NULL,
	39	/* ret_permanent_hw_addr = */ NULL);
	40	}
	41	static inline int rtnl_get_ifname(sd_netlink rtnl, int ifindex, char ret) {
	42	return rtnl_get_ifname_full(rtnl, ifindex, ret, NULL);
	43	}
	44	static inline int rtnl_get_link_alternative_names(sd_netlink rtnl, int ifindex, char *ret) {
	45	return rtnl_get_ifname_full(rtnl, ifindex, NULL, ret);
	46	}
	47	static inline int rtnl_get_link_info(
	48	sd_netlink **rtnl,
	49	int ifindex,
	50	unsigned short *ret_iftype,
	51	unsigned *ret_flags,
	52	char **ret_kind,
	53	struct hw_addr_data *ret_hw_addr,
	54	struct hw_addr_data *ret_permanent_hw_addr) {
	55
	56	return rtnl_get_link_info_full(
	57	rtnl,
	58	ifindex,
	59	/* ret_name = */ NULL,
	60	/* ret_altnames = */ NULL,
	61	ret_iftype,
	62	ret_flags,
	63	ret_kind,
	64	ret_hw_addr,
	65	ret_permanent_hw_addr);
	66	}
	67	static inline int rtnl_get_link_hw_addr(sd_netlink *rtnl, int ifindex, struct hw_addr_data ret) {
	68	return rtnl_get_link_info(
	69	rtnl,
	70	ifindex,
	71	/* ret_iftype = */ NULL,
	72	/* ret_flags = */ NULL,
	73	/* ret_kind = */ NULL,
	74	ret,
	75	/* ret_permanent_hw_addr = */ NULL);
	76	}
4e235561 YW	77
	78	typedef enum ResolveInterfaceNameFlag {
	79	RESOLVE_IFNAME_MAIN = 1 << 0, /* resolve main interface name */
	80	RESOLVE_IFNAME_ALTERNATIVE = 1 << 1, /* resolve alternative name */
	81	RESOLVE_IFNAME_NUMERIC = 1 << 2, /* resolve decimal formatted ifindex */
	82	_RESOLVE_IFNAME_ALL = RESOLVE_IFNAME_MAIN \| RESOLVE_IFNAME_ALTERNATIVE \| RESOLVE_IFNAME_NUMERIC,
	83	} ResolveInterfaceNameFlag;
	84
	85	int rtnl_resolve_ifname_full(
	86	sd_netlink **rtnl,
	87	ResolveInterfaceNameFlag flags,
	88	const char *name,
	89	char **ret_name,
	90	char ***ret_altnames);
4e235561 YW	91	static inline int rtnl_resolve_link_alternative_name(sd_netlink *rtnl, const char name, char **ret) {
	92	return rtnl_resolve_ifname_full(rtnl, RESOLVE_IFNAME_ALTERNATIVE, name, ret, NULL);
	93	}
	94	static inline int rtnl_resolve_ifname(sd_netlink *rtnl, const char name) {
	95	return rtnl_resolve_ifname_full(rtnl, RESOLVE_IFNAME_MAIN \| RESOLVE_IFNAME_ALTERNATIVE, name, NULL, NULL);
	96	}
	97	static inline int rtnl_resolve_interface(sd_netlink *rtnl, const char name) {
	98	return rtnl_resolve_ifname_full(rtnl, _RESOLVE_IFNAME_ALL, name, NULL, NULL);
	99	}
93a1f792	100	int rtnl_resolve_interface_or_warn(sd_netlink *rtnl, const char name);
4e235561	101
2ee01dbc YW	102	int rtnl_set_link_alternative_names(sd_netlink *rtnl, int ifindex, char const *alternative_names);
	103	int rtnl_set_link_alternative_names_by_ifname(sd_netlink *rtnl, const char ifname, char* const *alternative_names);
	104	int rtnl_delete_link_alternative_names(sd_netlink *rtnl, int ifindex, char const *alternative_names);
	105	int rtnl_rename_link(sd_netlink *rtnl, const char orig_name, const char *new_name);
	106	int rtnl_set_link_name(sd_netlink *rtnl, int ifindex, const char name, char* const* alternative_names);
	107	static inline int rtnl_append_link_alternative_names(sd_netlink *rtnl, int ifindex, char const *alternative_names) {
	108	return rtnl_set_link_name(rtnl, ifindex, NULL, alternative_names);
	109	}
	110
	111	int rtnl_set_link_properties(
	112	sd_netlink **rtnl,
	113	int ifindex,
	114	const char *alias,
	115	const struct hw_addr_data *hw_addr,
	116	uint32_t txqueues,
	117	uint32_t rxqueues,
	118	uint32_t txqueuelen,
	119	uint32_t mtu,
	120	uint32_t gso_max_size,
	121	size_t gso_max_segments);
	122
ee8c4568 LP	123	int rtnl_log_parse_error(int r);
ee8c4568 LP	124	int rtnl_log_create_error(int r);
33658413 YW	125
	126	#define netlink_call_async(nl, ret_slot, message, callback, destroy_callback, userdata) \
	127	({ \
	128	int (_callback_)(sd_netlink , sd_netlink_message *, typeof(userdata)) = callback; \
	129	void (*_destroy_)(typeof(userdata)) = destroy_callback; \
	130	sd_netlink_call_async(nl, ret_slot, message, \
	131	(sd_netlink_message_handler_t) _callback_, \
	132	(sd_netlink_destroy_t) _destroy_, \
	133	userdata, 0, __func__); \
	134	})
	135
3d65f7c8	136	#define netlink_add_match(nl, ret_slot, match, callback, destroy_callback, userdata, description) \
33658413 YW	137	({ \
	138	int (_callback_)(sd_netlink , sd_netlink_message *, typeof(userdata)) = callback; \
	139	void (*_destroy_)(typeof(userdata)) = destroy_callback; \
	140	sd_netlink_add_match(nl, ret_slot, match, \
	141	(sd_netlink_message_handler_t) _callback_, \
	142	(sd_netlink_destroy_t) _destroy_, \
3d65f7c8	143	userdata, description); \
33658413	144	})
67b19a49	145
dbc35fe3 YW	146	#define genl_add_match(nl, ret_slot, family, group, cmd, callback, destroy_callback, userdata, description) \
	147	({ \
	148	int (_callback_)(sd_netlink , sd_netlink_message *, typeof(userdata)) = callback; \
	149	void (*_destroy_)(typeof(userdata)) = destroy_callback; \
	150	sd_genl_add_match(nl, ret_slot, family, group, cmd, \
	151	(sd_netlink_message_handler_t) _callback_, \
	152	(sd_netlink_destroy_t) _destroy_, \
	153	userdata, description); \
	154	})
	155
ca2b7cd8	156	int netlink_message_append_hw_addr(sd_netlink_message m, unsigned short type, const struct hw_addr_data data);
67b19a49 YW	157	int netlink_message_append_in_addr_union(sd_netlink_message m, unsigned short type, int family, const union in_addr_union data);
67b19a49 YW	158	int netlink_message_append_sockaddr_union(sd_netlink_message m, unsigned short type, const union sockaddr_union data);
6497a8aa	159
ca2b7cd8	160	int netlink_message_read_hw_addr(sd_netlink_message m, unsigned short type, struct hw_addr_data data);
f29b6b37 YW	161	int netlink_message_read_in_addr_union(sd_netlink_message m, unsigned short type, int family, union in_addr_union data);
f29b6b37 YW	162
6497a8aa YW	163	void rtattr_append_attribute_internal(struct rtattr rta, unsigned short type, const void data, size_t data_length);
6497a8aa YW	164	int rtattr_append_attribute(struct rtattr *rta, unsigned short type, const void data, size_t data_length);
2fe1d557	165
84e10015 ZJS	166	void netlink_seal_message(sd_netlink nl, sd_netlink_message m);
84e10015 ZJS	167
4256379d YW	168	size_t netlink_get_reply_callback_count(sd_netlink *nl);
4256379d YW	169
84e10015 ZJS	170	/* TODO: to be exported later */
84e10015 ZJS	171	int sd_netlink_sendv(sd_netlink nl, sd_netlink_message messages, size_t msgcnt, uint32_t *ret_serial);