Debian Codegraph @

src/network/networkd-util.h

raw
1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
2 #pragma once
3
4 #include "network-util.h"
5 #include "networkd-forward.h"
6 #include "time-util.h"
7
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,
14 NETWORK_CONFIG_SOURCE_DHCP_PD,
15 NETWORK_CONFIG_SOURCE_NDISC,
16 NETWORK_CONFIG_SOURCE_RUNTIME, /* through D-Bus method */
17 NETWORK_CONFIG_SOURCE_MODEM_MANAGER,
18 _NETWORK_CONFIG_SOURCE_MAX,
19 _NETWORK_CONFIG_SOURCE_INVALID = -EINVAL,
20 } NetworkConfigSource;
21
22 typedef enum NetworkConfigState {
23 NETWORK_CONFIG_STATE_REQUESTING = 1 << 0, /* request is queued */
24 NETWORK_CONFIG_STATE_CONFIGURING = 1 << 1, /* e.g. address_configure() is called, but no response is received yet */
25 NETWORK_CONFIG_STATE_CONFIGURED = 1 << 2, /* e.g. address_configure() is called and received a response from kernel.
26 * Note that address may not be ready yet, so please use address_is_ready()
27 * to check whether the address can be usable or not. */
28 NETWORK_CONFIG_STATE_MARKED = 1 << 3, /* used GC'ing the old config */
29 NETWORK_CONFIG_STATE_REMOVING = 1 << 4, /* e.g. address_remove() is called, but no response is received yet */
30 } NetworkConfigState;
31
32 static inline usec_t sec_to_usec(uint32_t sec, usec_t timestamp_usec) {
33 return
34 sec == 0 ? 0 :
35 sec == UINT32_MAX ? USEC_INFINITY :
36 usec_add(timestamp_usec, sec * USEC_PER_SEC);
37 }
38
39 static inline usec_t sec16_to_usec(uint16_t sec, usec_t timestamp_usec) {
40 return sec_to_usec(sec == UINT16_MAX ? UINT32_MAX : (uint32_t) sec, timestamp_usec);
41 }
42
43 static inline uint32_t usec_to_sec(usec_t usec, usec_t now_usec) {
44 return MIN(DIV_ROUND_UP(usec_sub_unsigned(usec, now_usec), USEC_PER_SEC), UINT32_MAX);
45 }
46
47 CONFIG_PARSER_PROTOTYPE(config_parse_link_local_address_family);
48 CONFIG_PARSER_PROTOTYPE(config_parse_ip_masquerade);
49 CONFIG_PARSER_PROTOTYPE(config_parse_mud_url);
50
51 DECLARE_STRING_TABLE_LOOKUP(network_config_source, NetworkConfigSource);
52
53 DECLARE_STRING_TABLE_LOOKUP_TO_STRING_FALLBACK(network_config_state, NetworkConfigState);
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 } \
65 static inline bool name##_exists(const type *t) { \
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 } \
85 static inline bool name##_is_requesting(const type *t) { \
86 assert(t); \
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 | \
92 NETWORK_CONFIG_STATE_CONFIGURING | \
93 NETWORK_CONFIG_STATE_REMOVING, \
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 } \
110 static inline bool name##_is_marked(const type *t) { \
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
127 DECLARE_STRING_TABLE_LOOKUP(address_family, AddressFamily);
128
129 DECLARE_STRING_TABLE_LOOKUP_FROM_STRING(link_local_address_family, AddressFamily);
130
131 DECLARE_STRING_TABLE_LOOKUP(routing_policy_rule_address_family, AddressFamily);
132
133 DECLARE_STRING_TABLE_LOOKUP(nexthop_address_family, AddressFamily);
134
135 DECLARE_STRING_TABLE_LOOKUP(duplicate_address_detection_address_family, AddressFamily);
136
137 DECLARE_STRING_TABLE_LOOKUP_FROM_STRING(dhcp_deprecated_address_family, AddressFamily);
138
139 DECLARE_STRING_TABLE_LOOKUP(dhcp_lease_server_type, sd_dhcp_lease_server_type_t);
140
141 bool link_should_mark_config(Link *link, bool only_static, NetworkConfigSource source, uint8_t protocol);
142
143 #define _log_link_message_full_errno(link, link_u, message, error_msg, length, level, level_u, error, error_u, format, ...) \
144 ({ \
145 Link *link_u = (link); \
146 int level_u = (level); \
147 int error_u = (error); \
148 int length = 0; \
149 \
150 const char *error_msg = NULL; \
151 if (message) \
152 length = sd_netlink_message_read_string(message, NLMSGERR_ATTR_MSG, &error_msg); \
153 \
154 error_msg && length > 0 ? \
155 log_link_full_errno(link_u, level_u, error_u, format ": %s%s %m", ##__VA_ARGS__, \
156 error_msg, error_msg[length - 1] == '.' ? "" : ".") : \
157 log_link_full_errno(link_u, level_u, error_u, format ": %m", ##__VA_ARGS__); \
158 })
159
160
161 #define log_link_message_full_errno(link, message, level, error, format, ...) \
162 _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__)
163
164 #define log_link_message_error_errno(link, m, err, fmt, ...) log_link_message_full_errno(link, m, LOG_ERR, err, fmt, ##__VA_ARGS__)
165 #define log_link_message_warning_errno(link, m, err, fmt, ...) log_link_message_full_errno(link, m, LOG_WARNING, err, fmt, ##__VA_ARGS__)
166 #define log_link_message_notice_errno(link, m, err, fmt, ...) log_link_message_full_errno(link, m, LOG_NOTICE, err, fmt, ##__VA_ARGS__)
167 #define log_link_message_info_errno(link, m, err, fmt, ...) log_link_message_full_errno(link, m, LOG_INFO, err, fmt, ##__VA_ARGS__)
168 #define log_link_message_debug_errno(link, m, err, fmt, ...) log_link_message_full_errno(link, m, LOG_DEBUG, err, fmt, ##__VA_ARGS__)
169 #define log_message_full_errno(m, level, err, fmt, ...) log_link_message_full_errno(NULL, m, level, err, fmt, ##__VA_ARGS__)
170 #define log_message_error_errno(m, err, fmt, ...) log_message_full_errno(m, LOG_ERR, err, fmt, ##__VA_ARGS__)
171 #define log_message_warning_errno(m, err, fmt, ...) log_message_full_errno(m, LOG_WARNING, err, fmt, ##__VA_ARGS__)
172 #define log_message_notice_errno(m, err, fmt, ...) log_message_full_errno(m, LOG_NOTICE, err, fmt, ##__VA_ARGS__)
173 #define log_message_info_errno(m, err, fmt, ...) log_message_full_errno(m, LOG_INFO, err, fmt, ##__VA_ARGS__)
174 #define log_message_debug_errno(m, err, fmt, ...) log_message_full_errno(m, LOG_DEBUG, err, fmt, ##__VA_ARGS__)