]> git.ipfire.org Git - thirdparty/systemd.git/blame - src/basic/macro.h
networkd: don't try to configure IPv6 proxy NDP if IPv6 is not available (#7613)
[thirdparty/systemd.git] / src / basic / macro.h
CommitLineData
53e1b683 1/* SPDX-License-Identifier: LGPL-2.1+ */
c2f1db8f 2#pragma once
60918275 3
a7334b09
LP
4/***
5 This file is part of systemd.
6
7 Copyright 2010 Lennart Poettering
8
9 systemd is free software; you can redistribute it and/or modify it
5430f7f2
LP
10 under the terms of the GNU Lesser General Public License as published by
11 the Free Software Foundation; either version 2.1 of the License, or
a7334b09
LP
12 (at your option) any later version.
13
14 systemd is distributed in the hope that it will be useful, but
15 WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5430f7f2 17 Lesser General Public License for more details.
a7334b09 18
5430f7f2 19 You should have received a copy of the GNU Lesser General Public License
a7334b09
LP
20 along with systemd; If not, see <http://www.gnu.org/licenses/>.
21***/
22
c31e1495 23#include <inttypes.h>
c01ff965 24#include <stdbool.h>
afc5dbf3 25#include <sys/param.h>
27d13af7 26#include <sys/sysmacros.h>
afc5dbf3 27#include <sys/types.h>
60918275 28
44b601bc 29#define _printf_(a,b) __attribute__ ((format (printf, a, b)))
26e9e10b
ZJS
30#ifdef __clang__
31# define _alloc_(...)
32#else
33# define _alloc_(...) __attribute__ ((alloc_size(__VA_ARGS__)))
34#endif
93a46b0b 35#define _sentinel_ __attribute__ ((sentinel))
93a46b0b
LP
36#define _unused_ __attribute__ ((unused))
37#define _destructor_ __attribute__ ((destructor))
38#define _pure_ __attribute__ ((pure))
39#define _const_ __attribute__ ((const))
40#define _deprecated_ __attribute__ ((deprecated))
41#define _packed_ __attribute__ ((packed))
42#define _malloc_ __attribute__ ((malloc))
43#define _weak_ __attribute__ ((weak))
44#define _likely_(x) (__builtin_expect(!!(x),1))
45#define _unlikely_(x) (__builtin_expect(!!(x),0))
40473a70
LP
46#define _public_ __attribute__ ((visibility("default")))
47#define _hidden_ __attribute__ ((visibility("hidden")))
ad780f19 48#define _weakref_(x) __attribute__((weakref(#x)))
19d1e4ee 49#define _alignas_(x) __attribute__((aligned(__alignof(x))))
dfb33a97 50#define _cleanup_(x) __attribute__((cleanup(x)))
fb8e74a4 51#if __GNUC__ >= 7
4831981d 52#define _fallthrough_ __attribute__((fallthrough))
fb8e74a4
SL
53#else
54#define _fallthrough_
55#endif
60918275 56
7ebe131a
LP
57/* Temporarily disable some warnings */
58#define DISABLE_WARNING_DECLARATION_AFTER_STATEMENT \
59 _Pragma("GCC diagnostic push"); \
60 _Pragma("GCC diagnostic ignored \"-Wdeclaration-after-statement\"")
61
bcfce235
LP
62#define DISABLE_WARNING_FORMAT_NONLITERAL \
63 _Pragma("GCC diagnostic push"); \
64 _Pragma("GCC diagnostic ignored \"-Wformat-nonliteral\"")
65
f0f2e63b
LP
66#define DISABLE_WARNING_MISSING_PROTOTYPES \
67 _Pragma("GCC diagnostic push"); \
68 _Pragma("GCC diagnostic ignored \"-Wmissing-prototypes\"")
69
8fca4e30
LP
70#define DISABLE_WARNING_NONNULL \
71 _Pragma("GCC diagnostic push"); \
72 _Pragma("GCC diagnostic ignored \"-Wnonnull\"")
73
d442e2ec
DH
74#define DISABLE_WARNING_SHADOW \
75 _Pragma("GCC diagnostic push"); \
76 _Pragma("GCC diagnostic ignored \"-Wshadow\"")
77
df99a9ef
ZJS
78#define DISABLE_WARNING_INCOMPATIBLE_POINTER_TYPES \
79 _Pragma("GCC diagnostic push"); \
80 _Pragma("GCC diagnostic ignored \"-Wincompatible-pointer-types\"")
81
7ebe131a
LP
82#define REENABLE_WARNING \
83 _Pragma("GCC diagnostic pop")
84
49e5de64
ZJS
85/* automake test harness */
86#define EXIT_TEST_SKIP 77
87
bef2733f
LP
88#define XSTRINGIFY(x) #x
89#define STRINGIFY(x) XSTRINGIFY(x)
90
ab9cbe34
LS
91#define XCONCATENATE(x, y) x ## y
92#define CONCATENATE(x, y) XCONCATENATE(x, y)
93
fb835651
DH
94#define UNIQ_T(x, uniq) CONCATENATE(__unique_prefix_, CONCATENATE(x, uniq))
95#define UNIQ __COUNTER__
96
13b498f9
TJ
97/* builtins */
98#if __SIZEOF_INT__ == 4
99#define BUILTIN_FFS_U32(x) __builtin_ffs(x);
100#elif __SIZEOF_LONG__ == 4
101#define BUILTIN_FFS_U32(x) __builtin_ffsl(x);
102#else
103#error "neither int nor long are four bytes long?!?"
104#endif
105
60918275 106/* Rounds up */
9be9c7cf
LP
107
108#define ALIGN4(l) (((l) + 3) & ~3)
109#define ALIGN8(l) (((l) + 7) & ~7)
110
111#if __SIZEOF_POINTER__ == 8
112#define ALIGN(l) ALIGN8(l)
113#elif __SIZEOF_POINTER__ == 4
114#define ALIGN(l) ALIGN4(l)
115#else
116#error "Wut? Pointers are neither 4 nor 8 bytes long?"
117#endif
118
5f86c1f4
LP
119#define ALIGN_PTR(p) ((void*) ALIGN((unsigned long) (p)))
120#define ALIGN4_PTR(p) ((void*) ALIGN4((unsigned long) (p)))
121#define ALIGN8_PTR(p) ((void*) ALIGN8((unsigned long) (p)))
e86b80b8 122
37f85e66 123static inline size_t ALIGN_TO(size_t l, size_t ali) {
124 return ((l + ali - 1) & ~(ali - 1));
22be093f
LP
125}
126
5f86c1f4 127#define ALIGN_TO_PTR(p, ali) ((void*) ALIGN_TO((unsigned long) (p), (ali)))
49aa47c7 128
625e870b
DH
129/* align to next higher power-of-2 (except for: 0 => 0, overflow => 0) */
130static inline unsigned long ALIGN_POWER2(unsigned long u) {
131 /* clz(0) is undefined */
132 if (u == 1)
133 return 1;
134
135 /* left-shift overflow is undefined */
136 if (__builtin_clzl(u - 1UL) < 1)
137 return 0;
138
139 return 1UL << (sizeof(u) * 8 - __builtin_clzl(u - 1UL));
140}
141
7f39a210
MS
142#define ELEMENTSOF(x) \
143 __extension__ (__builtin_choose_expr( \
144 !__builtin_types_compatible_p(typeof(x), typeof(&*(x))), \
145 sizeof(x)/sizeof((x)[0]), \
146 (void)0))
bbc98d32
KS
147/*
148 * container_of - cast a member of a structure out to the containing structure
149 * @ptr: the pointer to the member.
150 * @type: the type of the container struct this is embedded in.
151 * @member: the name of the member within the struct.
bbc98d32 152 */
fb835651
DH
153#define container_of(ptr, type, member) __container_of(UNIQ, (ptr), type, member)
154#define __container_of(uniq, ptr, type, member) \
fa70beaa 155 __extension__ ({ \
fb835651
DH
156 const typeof( ((type*)0)->member ) *UNIQ_T(A, uniq) = (ptr); \
157 (type*)( (char *)UNIQ_T(A, uniq) - offsetof(type,member) ); \
158 })
bbc98d32 159
9607d947 160#undef MAX
667a0377
DH
161#define MAX(a, b) __MAX(UNIQ, (a), UNIQ, (b))
162#define __MAX(aq, a, bq, b) \
fdcba430 163 __extension__ ({ \
667a0377
DH
164 const typeof(a) UNIQ_T(A, aq) = (a); \
165 const typeof(b) UNIQ_T(B, bq) = (b); \
166 UNIQ_T(A,aq) > UNIQ_T(B,bq) ? UNIQ_T(A,aq) : UNIQ_T(B,bq); \
167 })
60918275 168
7242d742
DH
169/* evaluates to (void) if _A or _B are not constant or of different types */
170#define CONST_MAX(_A, _B) \
171 __extension__ (__builtin_choose_expr( \
172 __builtin_constant_p(_A) && \
173 __builtin_constant_p(_B) && \
174 __builtin_types_compatible_p(typeof(_A), typeof(_B)), \
175 ((_A) > (_B)) ? (_A) : (_B), \
176 (void)0))
177
40a1eebd
DH
178/* takes two types and returns the size of the larger one */
179#define MAXSIZE(A, B) (sizeof(union _packed_ { typeof(A) a; typeof(B) b; }))
180
fdcba430
DH
181#define MAX3(x,y,z) \
182 __extension__ ({ \
183 const typeof(x) _c = MAX(x,y); \
184 MAX(_c, z); \
9607d947 185 })
3b63d2d3 186
9607d947 187#undef MIN
667a0377
DH
188#define MIN(a, b) __MIN(UNIQ, (a), UNIQ, (b))
189#define __MIN(aq, a, bq, b) \
fdcba430 190 __extension__ ({ \
667a0377
DH
191 const typeof(a) UNIQ_T(A, aq) = (a); \
192 const typeof(b) UNIQ_T(B, bq) = (b); \
193 UNIQ_T(A,aq) < UNIQ_T(B,bq) ? UNIQ_T(A,aq) : UNIQ_T(B,bq); \
194 })
60918275 195
fdcba430
DH
196#define MIN3(x,y,z) \
197 __extension__ ({ \
198 const typeof(x) _c = MIN(x,y); \
199 MIN(_c, z); \
7df23077
DH
200 })
201
667a0377
DH
202#define LESS_BY(a, b) __LESS_BY(UNIQ, (a), UNIQ, (b))
203#define __LESS_BY(aq, a, bq, b) \
fdcba430 204 __extension__ ({ \
667a0377
DH
205 const typeof(a) UNIQ_T(A, aq) = (a); \
206 const typeof(b) UNIQ_T(B, bq) = (b); \
207 UNIQ_T(A,aq) > UNIQ_T(B,bq) ? UNIQ_T(A,aq) - UNIQ_T(B,bq) : 0; \
208 })
348ced90 209
667a0377
DH
210#undef CLAMP
211#define CLAMP(x, low, high) __CLAMP(UNIQ, (x), UNIQ, (low), UNIQ, (high))
212#define __CLAMP(xq, x, lowq, low, highq, high) \
60918275 213 __extension__ ({ \
667a0377
DH
214 const typeof(x) UNIQ_T(X,xq) = (x); \
215 const typeof(low) UNIQ_T(LOW,lowq) = (low); \
216 const typeof(high) UNIQ_T(HIGH,highq) = (high); \
217 UNIQ_T(X,xq) > UNIQ_T(HIGH,highq) ? \
218 UNIQ_T(HIGH,highq) : \
219 UNIQ_T(X,xq) < UNIQ_T(LOW,lowq) ? \
220 UNIQ_T(LOW,lowq) : \
221 UNIQ_T(X,xq); \
222 })
60918275 223
180a60bc
DH
224/* [(x + y - 1) / y] suffers from an integer overflow, even though the
225 * computation should be possible in the given type. Therefore, we use
226 * [x / y + !!(x % y)]. Note that on "Real CPUs" a division returns both the
227 * quotient and the remainder, so both should be equally fast. */
228#define DIV_ROUND_UP(_x, _y) \
229 __extension__ ({ \
230 const typeof(_x) __x = (_x); \
231 const typeof(_y) __y = (_y); \
232 (__x / __y + !!(__x % __y)); \
233 })
234
34c38d2a 235#define assert_message_se(expr, message) \
dd8f71ee 236 do { \
93a46b0b 237 if (_unlikely_(!(expr))) \
34c38d2a
MS
238 log_assert_failed(message, __FILE__, __LINE__, __PRETTY_FUNCTION__); \
239 } while (false)
240
241#define assert_se(expr) assert_message_se(expr, #expr)
dd8f71ee
LP
242
243/* We override the glibc assert() here. */
244#undef assert
245#ifdef NDEBUG
9ed794a3 246#define assert(expr) do {} while (false)
dd8f71ee 247#else
34c38d2a 248#define assert(expr) assert_message_se(expr, #expr)
dd8f71ee 249#endif
60918275 250
dd8f71ee
LP
251#define assert_not_reached(t) \
252 do { \
b7f33638 253 log_assert_failed_unreachable(t, __FILE__, __LINE__, __PRETTY_FUNCTION__); \
dd8f71ee 254 } while (false)
60918275 255
f791c684 256#if defined(static_assert)
7ebe131a
LP
257/* static_assert() is sometimes defined in a way that trips up
258 * -Wdeclaration-after-statement, hence let's temporarily turn off
259 * this warning around it. */
260#define assert_cc(expr) \
261 DISABLE_WARNING_DECLARATION_AFTER_STATEMENT; \
262 static_assert(expr, #expr); \
263 REENABLE_WARNING
f791c684 264#else
7ebe131a
LP
265#define assert_cc(expr) \
266 DISABLE_WARNING_DECLARATION_AFTER_STATEMENT; \
6825a04d 267 struct CONCATENATE(_assert_struct_, __COUNTER__) { \
7ebe131a
LP
268 char x[(expr) ? 0 : -1]; \
269 }; \
270 REENABLE_WARNING
f791c684 271#endif
60918275 272
34c38d2a
MS
273#define assert_log(expr, message) ((_likely_(expr)) \
274 ? (true) \
275 : (log_assert_failed_return(message, __FILE__, __LINE__, __PRETTY_FUNCTION__), false))
366e6411 276
80514f9c
LP
277#define assert_return(expr, r) \
278 do { \
34c38d2a 279 if (!assert_log(expr, #expr)) \
80514f9c 280 return (r); \
18387b59
LP
281 } while (false)
282
aa029628
TG
283#define assert_return_errno(expr, r, err) \
284 do { \
34c38d2a 285 if (!assert_log(expr, #expr)) { \
aa029628
TG
286 errno = err; \
287 return (r); \
288 } \
289 } while (false)
290
a3dc3547
KS
291#define PTR_TO_INT(p) ((int) ((intptr_t) (p)))
292#define INT_TO_PTR(u) ((void *) ((intptr_t) (u)))
60918275 293#define PTR_TO_UINT(p) ((unsigned int) ((uintptr_t) (p)))
a3dc3547 294#define UINT_TO_PTR(u) ((void *) ((uintptr_t) (u)))
60918275 295
a3dc3547
KS
296#define PTR_TO_LONG(p) ((long) ((intptr_t) (p)))
297#define LONG_TO_PTR(u) ((void *) ((intptr_t) (u)))
c6c18be3 298#define PTR_TO_ULONG(p) ((unsigned long) ((uintptr_t) (p)))
a3dc3547 299#define ULONG_TO_PTR(u) ((void *) ((uintptr_t) (u)))
c6c18be3 300
a3dc3547
KS
301#define PTR_TO_INT32(p) ((int32_t) ((intptr_t) (p)))
302#define INT32_TO_PTR(u) ((void *) ((intptr_t) (u)))
303#define PTR_TO_UINT32(p) ((uint32_t) ((uintptr_t) (p)))
304#define UINT32_TO_PTR(u) ((void *) ((uintptr_t) (u)))
60918275 305
a3dc3547
KS
306#define PTR_TO_INT64(p) ((int64_t) ((intptr_t) (p)))
307#define INT64_TO_PTR(u) ((void *) ((intptr_t) (u)))
308#define PTR_TO_UINT64(p) ((uint64_t) ((uintptr_t) (p)))
309#define UINT64_TO_PTR(u) ((void *) ((uintptr_t) (u)))
c6c18be3 310
74b2466e
LP
311#define PTR_TO_SIZE(p) ((size_t) ((uintptr_t) (p)))
312#define SIZE_TO_PTR(u) ((void *) ((uintptr_t) (u)))
313
a9c55a88
LP
314#define CHAR_TO_STR(x) ((char[2]) { x, 0 })
315
034c6ed7
LP
316#define char_array_0(x) x[sizeof(x)-1] = 0;
317
fa70beaa
LP
318/* Returns the number of chars needed to format variables of the
319 * specified type as a decimal string. Adds in extra space for a
b7ce6b59
LP
320 * negative '-' prefix (hence works correctly on signed
321 * types). Includes space for the trailing NUL. */
fa70beaa 322#define DECIMAL_STR_MAX(type) \
5bcb0f2b 323 (2+(sizeof(type) <= 1 ? 3 : \
fa70beaa
LP
324 sizeof(type) <= 2 ? 5 : \
325 sizeof(type) <= 4 ? 10 : \
326 sizeof(type) <= 8 ? 20 : sizeof(int[-2*(sizeof(type) > 8)])))
327
0d1dbeb3
LP
328#define DECIMAL_STR_WIDTH(x) \
329 ({ \
330 typeof(x) _x_ = (x); \
331 unsigned ans = 1; \
332 while (_x_ /= 10) \
333 ans++; \
334 ans; \
335 })
336
264ad849
LP
337#define SET_FLAG(v, flag, b) \
338 (v) = (b) ? ((v) | (flag)) : ((v) & ~(flag))
339
d5b26d50
DM
340#define CASE_F(X) case X:
341#define CASE_F_1(CASE, X) CASE_F(X)
342#define CASE_F_2(CASE, X, ...) CASE(X) CASE_F_1(CASE, __VA_ARGS__)
343#define CASE_F_3(CASE, X, ...) CASE(X) CASE_F_2(CASE, __VA_ARGS__)
344#define CASE_F_4(CASE, X, ...) CASE(X) CASE_F_3(CASE, __VA_ARGS__)
345#define CASE_F_5(CASE, X, ...) CASE(X) CASE_F_4(CASE, __VA_ARGS__)
346#define CASE_F_6(CASE, X, ...) CASE(X) CASE_F_5(CASE, __VA_ARGS__)
347#define CASE_F_7(CASE, X, ...) CASE(X) CASE_F_6(CASE, __VA_ARGS__)
348#define CASE_F_8(CASE, X, ...) CASE(X) CASE_F_7(CASE, __VA_ARGS__)
349#define CASE_F_9(CASE, X, ...) CASE(X) CASE_F_8(CASE, __VA_ARGS__)
350#define CASE_F_10(CASE, X, ...) CASE(X) CASE_F_9(CASE, __VA_ARGS__)
351#define CASE_F_11(CASE, X, ...) CASE(X) CASE_F_10(CASE, __VA_ARGS__)
352#define CASE_F_12(CASE, X, ...) CASE(X) CASE_F_11(CASE, __VA_ARGS__)
353#define CASE_F_13(CASE, X, ...) CASE(X) CASE_F_12(CASE, __VA_ARGS__)
354#define CASE_F_14(CASE, X, ...) CASE(X) CASE_F_13(CASE, __VA_ARGS__)
355#define CASE_F_15(CASE, X, ...) CASE(X) CASE_F_14(CASE, __VA_ARGS__)
356#define CASE_F_16(CASE, X, ...) CASE(X) CASE_F_15(CASE, __VA_ARGS__)
357#define CASE_F_17(CASE, X, ...) CASE(X) CASE_F_16(CASE, __VA_ARGS__)
358#define CASE_F_18(CASE, X, ...) CASE(X) CASE_F_17(CASE, __VA_ARGS__)
359#define CASE_F_19(CASE, X, ...) CASE(X) CASE_F_18(CASE, __VA_ARGS__)
360#define CASE_F_20(CASE, X, ...) CASE(X) CASE_F_19(CASE, __VA_ARGS__)
361
362#define GET_CASE_F(_1,_2,_3,_4,_5,_6,_7,_8,_9,_10,_11,_12,_13,_14,_15,_16,_17,_18,_19,_20,NAME,...) NAME
363#define FOR_EACH_MAKE_CASE(...) \
364 GET_CASE_F(__VA_ARGS__,CASE_F_20,CASE_F_19,CASE_F_18,CASE_F_17,CASE_F_16,CASE_F_15,CASE_F_14,CASE_F_13,CASE_F_12,CASE_F_11, \
365 CASE_F_10,CASE_F_9,CASE_F_8,CASE_F_7,CASE_F_6,CASE_F_5,CASE_F_4,CASE_F_3,CASE_F_2,CASE_F_1) \
366 (CASE_F,__VA_ARGS__)
367
368#define IN_SET(x, ...) \
369 ({ \
370 bool _found = false; \
371 /* If the build breaks in the line below, you need to extend the case macros */ \
372 static _unused_ char _static_assert__macros_need_to_be_extended[20 - sizeof((int[]){__VA_ARGS__})/sizeof(int)]; \
373 switch(x) { \
374 FOR_EACH_MAKE_CASE(__VA_ARGS__) \
375 _found = true; \
376 break; \
377 default: \
378 break; \
379 } \
380 _found; \
cabb7806
LP
381 })
382
35aa04e9
LP
383#define SWAP_TWO(x, y) do { \
384 typeof(x) _t = (x); \
385 (x) = (y); \
386 (y) = (_t); \
387 } while (false)
388
919ce0b7
SL
389/* Define C11 thread_local attribute even on older gcc compiler
390 * version */
ec202eae
SL
391#ifndef thread_local
392/*
393 * Don't break on glibc < 2.16 that doesn't define __STDC_NO_THREADS__
394 * see http://gcc.gnu.org/bugzilla/show_bug.cgi?id=53769
395 */
396#if __STDC_VERSION__ >= 201112L && !(defined(__STDC_NO_THREADS__) || (defined(__GNU_LIBRARY__) && __GLIBC__ == 2 && __GLIBC_MINOR__ < 16))
397#define thread_local _Thread_local
398#else
399#define thread_local __thread
400#endif
401#endif
cabb7806 402
919ce0b7
SL
403/* Define C11 noreturn without <stdnoreturn.h> and even on older gcc
404 * compiler versions */
405#ifndef noreturn
406#if __STDC_VERSION__ >= 201112L
407#define noreturn _Noreturn
408#else
409#define noreturn __attribute__((noreturn))
410#endif
411#endif
412
a2341f68
ZJS
413#define DEFINE_TRIVIAL_CLEANUP_FUNC(type, func) \
414 static inline void func##p(type *p) { \
415 if (*p) \
416 func(*p); \
417 } \
418 struct __useless_struct_to_allow_trailing_semicolon__
419
dd8f71ee 420#include "log.h"