[thirdparty/systemd.git] / src / network / networkd-util.h

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

#include "network-util.h"
#include "networkd-forward.h"
#include "time-util.h"

typedef enum NetworkConfigSource {
        NETWORK_CONFIG_SOURCE_FOREIGN, /* configured by kernel */
        NETWORK_CONFIG_SOURCE_STATIC,
        NETWORK_CONFIG_SOURCE_IPV4LL,
        NETWORK_CONFIG_SOURCE_DHCP4,
        NETWORK_CONFIG_SOURCE_DHCP6,
        NETWORK_CONFIG_SOURCE_DHCP_PD,
        NETWORK_CONFIG_SOURCE_NDISC,
        NETWORK_CONFIG_SOURCE_RUNTIME, /* through D-Bus method */
        _NETWORK_CONFIG_SOURCE_MAX,
        _NETWORK_CONFIG_SOURCE_INVALID = -EINVAL,
} NetworkConfigSource;

typedef enum NetworkConfigState {
        NETWORK_CONFIG_STATE_REQUESTING  = 1 << 0, /* request is queued */
        NETWORK_CONFIG_STATE_CONFIGURING = 1 << 1, /* e.g. address_configure() is called, but no response is received yet */
        NETWORK_CONFIG_STATE_CONFIGURED  = 1 << 2, /* e.g. address_configure() is called and received a response from kernel.
                                                    * Note that address may not be ready yet, so please use address_is_ready()
                                                    * to check whether the address can be usable or not. */
        NETWORK_CONFIG_STATE_MARKED      = 1 << 3, /* used GC'ing the old config */
        NETWORK_CONFIG_STATE_REMOVING    = 1 << 4, /* e.g. address_remove() is called, but no response is received yet */
} NetworkConfigState;

static inline usec_t sec_to_usec(uint32_t sec, usec_t timestamp_usec) {
        return
                sec == 0 ? 0 :
                sec == UINT32_MAX ? USEC_INFINITY :
                usec_add(timestamp_usec, sec * USEC_PER_SEC);
}

static inline usec_t sec16_to_usec(uint16_t sec, usec_t timestamp_usec) {
        return sec_to_usec(sec == UINT16_MAX ? UINT32_MAX : (uint32_t) sec, timestamp_usec);
}

static inline uint32_t usec_to_sec(usec_t usec, usec_t now_usec) {
        return MIN(DIV_ROUND_UP(usec_sub_unsigned(usec, now_usec), USEC_PER_SEC), UINT32_MAX);
}

CONFIG_PARSER_PROTOTYPE(config_parse_link_local_address_family);
CONFIG_PARSER_PROTOTYPE(config_parse_ip_masquerade);
CONFIG_PARSER_PROTOTYPE(config_parse_mud_url);

const char* network_config_source_to_string(NetworkConfigSource s) _const_;
NetworkConfigSource network_config_source_from_string(const char* s) _pure_;

int network_config_state_to_string_alloc(NetworkConfigState s, char **ret);

#define DEFINE_NETWORK_CONFIG_STATE_FUNCTIONS(type, name)               \
        static inline void name##_update_state(                         \
                        type *t,                                        \
                        NetworkConfigState mask,                        \
                        NetworkConfigState value) {                     \
                                                                        \
                assert(t);                                              \
                                                                        \
                t->state = (t->state & ~mask) | (value & mask);         \
        }                                                               \
        static inline bool name##_exists(const type *t) {               \
                assert(t);                                              \
                                                                        \
                if ((t->state & (NETWORK_CONFIG_STATE_CONFIGURING |     \
                                 NETWORK_CONFIG_STATE_CONFIGURED)) == 0) \
                        return false; /* Not assigned yet. */           \
                if (FLAGS_SET(t->state, NETWORK_CONFIG_STATE_REMOVING)) \
                        return false; /* Already removing. */           \
                return true;                                            \
        }                                                               \
        static inline void name##_enter_requesting(type *t) {           \
                name##_update_state(t,                                  \
                                    NETWORK_CONFIG_STATE_REQUESTING,    \
                                    NETWORK_CONFIG_STATE_REQUESTING);   \
        }                                                               \
        static inline void name##_cancel_requesting(type *t) {          \
                name##_update_state(t,                                  \
                                    NETWORK_CONFIG_STATE_REQUESTING,    \
                                    0);                                 \
        }                                                               \
        static inline bool name##_is_requesting(const type *t) {        \
                assert(t);                                              \
                return FLAGS_SET(t->state, NETWORK_CONFIG_STATE_REQUESTING); \
        }                                                               \
        static inline void name##_enter_configuring(type *t) {          \
                name##_update_state(t,                                  \
                                    NETWORK_CONFIG_STATE_REQUESTING |   \
                                    NETWORK_CONFIG_STATE_CONFIGURING |  \
                                    NETWORK_CONFIG_STATE_REMOVING,      \
                                    NETWORK_CONFIG_STATE_CONFIGURING);  \
        }                                                               \
        static inline void name##_enter_configured(type *t) {           \
                name##_update_state(t,                                  \
                                    NETWORK_CONFIG_STATE_CONFIGURING |  \
                                    NETWORK_CONFIG_STATE_CONFIGURED,    \
                                    NETWORK_CONFIG_STATE_CONFIGURED);   \
        }                                                               \
        static inline void name##_mark(type *t) {                       \
                name##_update_state(t,                                  \
                                    NETWORK_CONFIG_STATE_MARKED,        \
                                    NETWORK_CONFIG_STATE_MARKED);       \
        }                                                               \
        static inline void name##_unmark(type *t) {                     \
                name##_update_state(t, NETWORK_CONFIG_STATE_MARKED, 0); \
        }                                                               \
        static inline bool name##_is_marked(const type *t) {            \
                assert(t);                                              \
                return FLAGS_SET(t->state, NETWORK_CONFIG_STATE_MARKED); \
        }                                                               \
        static inline void name##_enter_removing(type *t) {             \
                name##_update_state(t,                                  \
                                    NETWORK_CONFIG_STATE_MARKED |       \
                                    NETWORK_CONFIG_STATE_REMOVING,      \
                                    NETWORK_CONFIG_STATE_REMOVING);     \
        }                                                               \
        static inline void name##_enter_removed(type *t) {              \
                name##_update_state(t,                                  \
                                    NETWORK_CONFIG_STATE_CONFIGURED |   \
                                    NETWORK_CONFIG_STATE_REMOVING,      \
                                    0);                                 \
        }

const char* address_family_to_string(AddressFamily b) _const_;
AddressFamily address_family_from_string(const char *s) _pure_;

AddressFamily link_local_address_family_from_string(const char *s) _pure_;

const char* routing_policy_rule_address_family_to_string(AddressFamily b) _const_;
AddressFamily routing_policy_rule_address_family_from_string(const char *s) _pure_;

const char* nexthop_address_family_to_string(AddressFamily b) _const_;
AddressFamily nexthop_address_family_from_string(const char *s) _pure_;

const char* duplicate_address_detection_address_family_to_string(AddressFamily b) _const_;
AddressFamily duplicate_address_detection_address_family_from_string(const char *s) _pure_;

AddressFamily dhcp_deprecated_address_family_from_string(const char *s) _pure_;

const char* dhcp_lease_server_type_to_string(sd_dhcp_lease_server_type_t t) _const_;
sd_dhcp_lease_server_type_t dhcp_lease_server_type_from_string(const char *s) _pure_;

bool link_should_mark_config(Link *link, bool only_static, NetworkConfigSource source, uint8_t protocol);

#define _log_link_message_full_errno(link, link_u, message, error_msg, length, level, level_u, error, error_u, format, ...) \
        ({                                                              \
                Link *link_u = (link);                                  \
                int level_u = (level);                                  \
                int error_u = (error);                                  \
                int length = 0;                                         \
                                                                        \
                const char *error_msg = NULL;                           \
                if (message)                                            \
                        length = sd_netlink_message_read_string(message, NLMSGERR_ATTR_MSG, &error_msg); \
                                                                        \
                error_msg && length > 0 ?                               \
                        log_link_full_errno(link_u, level_u, error_u, format ": %s%s %m", ##__VA_ARGS__, \
                                            error_msg, error_msg[length - 1] == '.' ? "" : ".") : \
                        log_link_full_errno(link_u, level_u, error_u, format ": %m", ##__VA_ARGS__); \
        })


#define log_link_message_full_errno(link, message, level, error, format, ...) \
        _log_link_message_full_errno(link, UNIQ_T(lnk, UNIQ), message, UNIQ_T(emsg, UNIQ), UNIQ_T(len, UNIQ), level, UNIQ_T(lvl, UNIQ), error, UNIQ_T(err, UNIQ), format, ##__VA_ARGS__)

#define log_link_message_error_errno(link, m, err, fmt, ...)   log_link_message_full_errno(link, m, LOG_ERR, err, fmt, ##__VA_ARGS__)
#define log_link_message_warning_errno(link, m, err, fmt, ...) log_link_message_full_errno(link, m, LOG_WARNING, err, fmt, ##__VA_ARGS__)
#define log_link_message_notice_errno(link, m, err, fmt, ...)  log_link_message_full_errno(link, m, LOG_NOTICE, err, fmt, ##__VA_ARGS__)
#define log_link_message_info_errno(link, m, err, fmt, ...)    log_link_message_full_errno(link, m, LOG_INFO, err, fmt, ##__VA_ARGS__)
#define log_link_message_debug_errno(link, m, err, fmt, ...)   log_link_message_full_errno(link, m, LOG_DEBUG, err, fmt, ##__VA_ARGS__)
#define log_message_full_errno(m, level, err, fmt, ...)        log_link_message_full_errno(NULL, m, level, err, fmt, ##__VA_ARGS__)
#define log_message_error_errno(m, err, fmt, ...)              log_message_full_errno(m, LOG_ERR, err, fmt, ##__VA_ARGS__)
#define log_message_warning_errno(m, err, fmt, ...)            log_message_full_errno(m, LOG_WARNING, err, fmt, ##__VA_ARGS__)
#define log_message_notice_errno(m, err, fmt, ...)             log_message_full_errno(m, LOG_NOTICE, err, fmt, ##__VA_ARGS__)
#define log_message_info_errno(m, err, fmt, ...)               log_message_full_errno(m, LOG_INFO, err, fmt, ##__VA_ARGS__)
#define log_message_debug_errno(m, err, fmt, ...)              log_message_full_errno(m, LOG_DEBUG, err, fmt, ##__VA_ARGS__)
Commit	Line	Data
db9ecf05	1	/* SPDX-License-Identifier: LGPL-2.1-or-later */
fc2f9534 LP	2	#pragma once
fc2f9534 LP	3
86ae2d69	4	#include "network-util.h"
baa3fadf DDM	5	#include "networkd-forward.h"
baa3fadf DDM	6	#include "time-util.h"
fd221544	7
a093533c YW	8	typedef enum NetworkConfigSource {
	9	NETWORK_CONFIG_SOURCE_FOREIGN, /* configured by kernel */
	10	NETWORK_CONFIG_SOURCE_STATIC,
	11	NETWORK_CONFIG_SOURCE_IPV4LL,
	12	NETWORK_CONFIG_SOURCE_DHCP4,
	13	NETWORK_CONFIG_SOURCE_DHCP6,
a27588d4	14	NETWORK_CONFIG_SOURCE_DHCP_PD,
a093533c	15	NETWORK_CONFIG_SOURCE_NDISC,
2e62139a	16	NETWORK_CONFIG_SOURCE_RUNTIME, /* through D-Bus method */
a093533c YW	17	_NETWORK_CONFIG_SOURCE_MAX,
	18	_NETWORK_CONFIG_SOURCE_INVALID = -EINVAL,
	19	} NetworkConfigSource;
	20
	21	typedef enum NetworkConfigState {
e402e99e YW	22	NETWORK_CONFIG_STATE_REQUESTING = 1 << 0, /* request is queued */
	23	NETWORK_CONFIG_STATE_CONFIGURING = 1 << 1, /* e.g. address_configure() is called, but no response is received yet */
	24	NETWORK_CONFIG_STATE_CONFIGURED = 1 << 2, /* e.g. address_configure() is called and received a response from kernel.
a093533c YW	25	* Note that address may not be ready yet, so please use address_is_ready()
a093533c YW	26	* to check whether the address can be usable or not. */
e402e99e YW	27	NETWORK_CONFIG_STATE_MARKED = 1 << 3, /* used GC'ing the old config */
e402e99e YW	28	NETWORK_CONFIG_STATE_REMOVING = 1 << 4, /* e.g. address_remove() is called, but no response is received yet */
a093533c YW	29	} NetworkConfigState;
a093533c YW	30
0cf1fe88 YW	31	static inline usec_t sec_to_usec(uint32_t sec, usec_t timestamp_usec) {
	32	return
	33	sec == 0 ? 0 :
	34	sec == UINT32_MAX ? USEC_INFINITY :
	35	usec_add(timestamp_usec, sec * USEC_PER_SEC);
5235d739 YW	36	}
5235d739 YW	37
0cf1fe88 YW	38	static inline usec_t sec16_to_usec(uint16_t sec, usec_t timestamp_usec) {
0cf1fe88 YW	39	return sec_to_usec(sec == UINT16_MAX ? UINT32_MAX : (uint32_t) sec, timestamp_usec);
5235d739 YW	40	}
	41
	42	static inline uint32_t usec_to_sec(usec_t usec, usec_t now_usec) {
	43	return MIN(DIV_ROUND_UP(usec_sub_unsigned(usec, now_usec), USEC_PER_SEC), UINT32_MAX);
	44	}
	45
2d792895	46	CONFIG_PARSER_PROTOTYPE(config_parse_link_local_address_family);
4c72d851	47	CONFIG_PARSER_PROTOTYPE(config_parse_ip_masquerade);
77976a68	48	CONFIG_PARSER_PROTOTYPE(config_parse_mud_url);
89fa9a6b	49
bfd5a068	50	const char* network_config_source_to_string(NetworkConfigSource s) _const_;
bf6e9b38	51	NetworkConfigSource network_config_source_from_string(const char* s) _pure_;
a093533c YW	52
	53	int network_config_state_to_string_alloc(NetworkConfigState s, char **ret);
	54
	55	#define DEFINE_NETWORK_CONFIG_STATE_FUNCTIONS(type, name) \
	56	static inline void name##_update_state( \
	57	type *t, \
	58	NetworkConfigState mask, \
	59	NetworkConfigState value) { \
	60	\
	61	assert(t); \
	62	\
	63	t->state = (t->state & ~mask) \| (value & mask); \
	64	} \
b088c3d3	65	static inline bool name##_exists(const type *t) { \
a093533c YW	66	assert(t); \
	67	\
	68	if ((t->state & (NETWORK_CONFIG_STATE_CONFIGURING \| \
	69	NETWORK_CONFIG_STATE_CONFIGURED)) == 0) \
	70	return false; /* Not assigned yet. */ \
	71	if (FLAGS_SET(t->state, NETWORK_CONFIG_STATE_REMOVING)) \
	72	return false; /* Already removing. */ \
	73	return true; \
	74	} \
	75	static inline void name##_enter_requesting(type *t) { \
	76	name##_update_state(t, \
	77	NETWORK_CONFIG_STATE_REQUESTING, \
	78	NETWORK_CONFIG_STATE_REQUESTING); \
	79	} \
	80	static inline void name##_cancel_requesting(type *t) { \
	81	name##_update_state(t, \
	82	NETWORK_CONFIG_STATE_REQUESTING, \
	83	0); \
	84	} \
b088c3d3	85	static inline bool name##_is_requesting(const type *t) { \
f3016c40	86	assert(t); \
a093533c YW	87	return FLAGS_SET(t->state, NETWORK_CONFIG_STATE_REQUESTING); \
	88	} \
	89	static inline void name##_enter_configuring(type *t) { \
	90	name##_update_state(t, \
	91	NETWORK_CONFIG_STATE_REQUESTING \| \
f4ee7b98 YW	92	NETWORK_CONFIG_STATE_CONFIGURING \| \
f4ee7b98 YW	93	NETWORK_CONFIG_STATE_REMOVING, \
a093533c YW	94	NETWORK_CONFIG_STATE_CONFIGURING); \
	95	} \
	96	static inline void name##_enter_configured(type *t) { \
	97	name##_update_state(t, \
	98	NETWORK_CONFIG_STATE_CONFIGURING \| \
	99	NETWORK_CONFIG_STATE_CONFIGURED, \
	100	NETWORK_CONFIG_STATE_CONFIGURED); \
	101	} \
	102	static inline void name##_mark(type *t) { \
	103	name##_update_state(t, \
	104	NETWORK_CONFIG_STATE_MARKED, \
	105	NETWORK_CONFIG_STATE_MARKED); \
	106	} \
	107	static inline void name##_unmark(type *t) { \
	108	name##_update_state(t, NETWORK_CONFIG_STATE_MARKED, 0); \
	109	} \
b088c3d3	110	static inline bool name##_is_marked(const type *t) { \
a093533c YW	111	assert(t); \
	112	return FLAGS_SET(t->state, NETWORK_CONFIG_STATE_MARKED); \
	113	} \
	114	static inline void name##_enter_removing(type *t) { \
	115	name##_update_state(t, \
	116	NETWORK_CONFIG_STATE_MARKED \| \
	117	NETWORK_CONFIG_STATE_REMOVING, \
	118	NETWORK_CONFIG_STATE_REMOVING); \
	119	} \
	120	static inline void name##_enter_removed(type *t) { \
	121	name##_update_state(t, \
	122	NETWORK_CONFIG_STATE_CONFIGURED \| \
	123	NETWORK_CONFIG_STATE_REMOVING, \
	124	0); \
	125	}
	126
bfd5a068	127	const char* address_family_to_string(AddressFamily b) _const_;
2d792895	128	AddressFamily address_family_from_string(const char *s) _pure_;
e800fd24	129
2d792895	130	AddressFamily link_local_address_family_from_string(const char *s) _pure_;
f02ba163	131
bfd5a068	132	const char* routing_policy_rule_address_family_to_string(AddressFamily b) _const_;
f6c6ff97 YW	133	AddressFamily routing_policy_rule_address_family_from_string(const char *s) _pure_;
f6c6ff97 YW	134
bfd5a068	135	const char* nexthop_address_family_to_string(AddressFamily b) _const_;
f1923efc YW	136	AddressFamily nexthop_address_family_from_string(const char *s) _pure_;
f1923efc YW	137
bfd5a068	138	const char* duplicate_address_detection_address_family_to_string(AddressFamily b) _const_;
051e77ca SS	139	AddressFamily duplicate_address_detection_address_family_from_string(const char *s) _pure_;
051e77ca SS	140
bde8467a YW	141	AddressFamily dhcp_deprecated_address_family_from_string(const char *s) _pure_;
bde8467a YW	142
bfd5a068	143	const char* dhcp_lease_server_type_to_string(sd_dhcp_lease_server_type_t t) _const_;
2324fd3a	144	sd_dhcp_lease_server_type_t dhcp_lease_server_type_from_string(const char *s) _pure_;
ddc026f3	145
81f63763 YW	146	bool link_should_mark_config(Link *link, bool only_static, NetworkConfigSource source, uint8_t protocol);
81f63763 YW	147
08fd159d	148	#define _log_link_message_full_errno(link, link_u, message, error_msg, length, level, level_u, error, error_u, format, ...) \
d28746ef YW	149	({ \
	150	Link *link_u = (link); \
	151	int level_u = (level); \
	152	int error_u = (error); \
08fd159d	153	int length = 0; \
d28746ef YW	154	\
	155	const char *error_msg = NULL; \
	156	if (message) \
08fd159d	157	length = sd_netlink_message_read_string(message, NLMSGERR_ATTR_MSG, &error_msg); \
d28746ef	158	\
08fd159d	159	error_msg && length > 0 ? \
d28746ef	160	log_link_full_errno(link_u, level_u, error_u, format ": %s%s %m", ##__VA_ARGS__, \
08fd159d	161	error_msg, error_msg[length - 1] == '.' ? "" : ".") : \
d28746ef YW	162	log_link_full_errno(link_u, level_u, error_u, format ": %m", ##__VA_ARGS__); \
	163	})
	164
	165
	166	#define log_link_message_full_errno(link, message, level, error, format, ...) \
08fd159d	167	_log_link_message_full_errno(link, UNIQ_T(lnk, UNIQ), message, UNIQ_T(emsg, UNIQ), UNIQ_T(len, UNIQ), level, UNIQ_T(lvl, UNIQ), error, UNIQ_T(err, UNIQ), format, ##__VA_ARGS__)
d28746ef YW	168
	169	#define log_link_message_error_errno(link, m, err, fmt, ...) log_link_message_full_errno(link, m, LOG_ERR, err, fmt, ##__VA_ARGS__)
	170	#define log_link_message_warning_errno(link, m, err, fmt, ...) log_link_message_full_errno(link, m, LOG_WARNING, err, fmt, ##__VA_ARGS__)
	171	#define log_link_message_notice_errno(link, m, err, fmt, ...) log_link_message_full_errno(link, m, LOG_NOTICE, err, fmt, ##__VA_ARGS__)
	172	#define log_link_message_info_errno(link, m, err, fmt, ...) log_link_message_full_errno(link, m, LOG_INFO, err, fmt, ##__VA_ARGS__)
	173	#define log_link_message_debug_errno(link, m, err, fmt, ...) log_link_message_full_errno(link, m, LOG_DEBUG, err, fmt, ##__VA_ARGS__)
	174	#define log_message_full_errno(m, level, err, fmt, ...) log_link_message_full_errno(NULL, m, level, err, fmt, ##__VA_ARGS__)
	175	#define log_message_error_errno(m, err, fmt, ...) log_message_full_errno(m, LOG_ERR, err, fmt, ##__VA_ARGS__)
	176	#define log_message_warning_errno(m, err, fmt, ...) log_message_full_errno(m, LOG_WARNING, err, fmt, ##__VA_ARGS__)
	177	#define log_message_notice_errno(m, err, fmt, ...) log_message_full_errno(m, LOG_NOTICE, err, fmt, ##__VA_ARGS__)
	178	#define log_message_info_errno(m, err, fmt, ...) log_message_full_errno(m, LOG_INFO, err, fmt, ##__VA_ARGS__)
	179	#define log_message_debug_errno(m, err, fmt, ...) log_message_full_errno(m, LOG_DEBUG, err, fmt, ##__VA_ARGS__)