[mirror_frr.git] / lib / compiler.h

/*
 * Copyright (c) 2015-2017  David Lamparter, for NetDEF, Inc.
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#ifndef _FRR_COMPILER_H
#define _FRR_COMPILER_H

#ifdef __cplusplus
extern "C" {
#endif

#ifdef __cplusplus
# if __cplusplus < 201103L
#  error FRRouting headers must be compiled in C++11 mode or newer
# endif
/* C++ defines static_assert(), but not _Static_assert().  C defines
 * _Static_assert() and has static_assert() in <assert.h>.  However, we mess
 * with assert() in zassert.h so let's not include <assert.h> here.
 */
# define _Static_assert static_assert
#else
# if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 201112L
#  error FRRouting must be compiled with min. -std=gnu11 (GNU ISO C11 dialect)
# endif
#endif

/* function attributes, use like
 *   void prototype(void) __attribute__((_CONSTRUCTOR(100)));
 */
#if defined(__clang__)
#if __clang_major__ > 3 || (__clang_major__ == 3 && __clang_minor__ >= 5)
#  define _RET_NONNULL    , returns_nonnull
#endif
#if __has_attribute(fallthrough)
#  define _FALLTHROUGH __attribute__((fallthrough));
#endif
# define _CONSTRUCTOR(x)  constructor(x)
# define _DEPRECATED(x) deprecated(x)
# if __has_builtin(assume)
#  define assume(x) __builtin_assume(x)
# endif
#elif defined(__GNUC__)
#if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 9)
#  define _RET_NONNULL    , returns_nonnull
#endif
#if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3)
#  define _CONSTRUCTOR(x) constructor(x)
#  define _DESTRUCTOR(x)  destructor(x)
#  define _ALLOC_SIZE(x)  alloc_size(x)
#endif
#if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5)
#  define _DEPRECATED(x) deprecated(x)
#  define assume(x) do { if (!(x)) __builtin_unreachable(); } while (0)
#endif
#if __GNUC__ < 5
#  define __has_attribute(x) 0
#endif
#if __GNUC__ >= 7
#  define _FALLTHROUGH __attribute__((fallthrough));
#endif
#endif

#if __has_attribute(hot)
#  define _OPTIMIZE_HOT __attribute__((hot))
#else
#  define _OPTIMIZE_HOT
#endif
#if __has_attribute(optimize)
#  define _OPTIMIZE_O3 __attribute__((optimize("3")))
#else
#  define _OPTIMIZE_O3
#endif
#define OPTIMIZE _OPTIMIZE_O3 _OPTIMIZE_HOT

#if !defined(__GNUC__)
#error module code needs GCC visibility extensions
#elif __GNUC__ < 4
#error module code needs GCC visibility extensions
#else
# define DSO_PUBLIC __attribute__ ((visibility ("default")))
# define DSO_SELF   __attribute__ ((visibility ("protected")))
# define DSO_LOCAL  __attribute__ ((visibility ("hidden")))
#endif

#ifdef __sun
/* Solaris doesn't do constructor priorities due to linker restrictions */
#undef _CONSTRUCTOR
#undef _DESTRUCTOR
#endif

/* fallback versions */
#ifndef _RET_NONNULL
# define _RET_NONNULL
#endif
#ifndef _CONSTRUCTOR
# define _CONSTRUCTOR(x) constructor
#endif
#ifndef _DESTRUCTOR
# define _DESTRUCTOR(x) destructor
#endif
#ifndef _ALLOC_SIZE
# define _ALLOC_SIZE(x)
#endif
#ifndef _FALLTHROUGH
#define _FALLTHROUGH
#endif
#ifndef _DEPRECATED
#define _DEPRECATED(x) deprecated
#endif
#ifndef assume
#define assume(x)
#endif

/* for helper functions defined inside macros */
#define macro_inline	static inline __attribute__((unused))
#define macro_pure	static inline __attribute__((unused, pure))

/* if the macro ends with a function definition */
#define MACRO_REQUIRE_SEMICOLON() \
	_Static_assert(1, "please add a semicolon after this macro")

/* variadic macros, use like:
 * #define V_0()  ...
 * #define V_1(x) ...
 * #define V(...) MACRO_VARIANT(V, ##__VA_ARGS__)(__VA_ARGS__)
 */
#define _MACRO_VARIANT(A0,A1,A2,A3,A4,A5,A6,A7,A8,A9,A10, N, ...) N

#define _CONCAT2(a, b) a ## b
#define _CONCAT(a, b) _CONCAT2(a,b)

#define MACRO_VARIANT(NAME, ...) \
	_CONCAT(NAME, _MACRO_VARIANT(0, ##__VA_ARGS__, \
			_10, _9, _8, _7, _6, _5, _4, _3, _2, _1, _0))

#define NAMECTR(name) _CONCAT(name, __COUNTER__)

/* per-arg repeat macros, use like:
 * #define PERARG(n) ...n...
 * #define FOO(...) MACRO_REPEAT(PERARG, ##__VA_ARGS__)
 */

#define _MACRO_REPEAT_0(NAME)
#define _MACRO_REPEAT_1(NAME, A1) \
	NAME(A1)
#define _MACRO_REPEAT_2(NAME, A1, A2) \
	NAME(A1) NAME(A2)
#define _MACRO_REPEAT_3(NAME, A1, A2, A3) \
	NAME(A1) NAME(A2) NAME(A3)
#define _MACRO_REPEAT_4(NAME, A1, A2, A3, A4) \
	NAME(A1) NAME(A2) NAME(A3) NAME(A4)
#define _MACRO_REPEAT_5(NAME, A1, A2, A3, A4, A5) \
	NAME(A1) NAME(A2) NAME(A3) NAME(A4) NAME(A5)
#define _MACRO_REPEAT_6(NAME, A1, A2, A3, A4, A5, A6) \
	NAME(A1) NAME(A2) NAME(A3) NAME(A4) NAME(A5) NAME(A6)
#define _MACRO_REPEAT_7(NAME, A1, A2, A3, A4, A5, A6, A7) \
	NAME(A1) NAME(A2) NAME(A3) NAME(A4) NAME(A5) NAME(A6) NAME(A7)
#define _MACRO_REPEAT_8(NAME, A1, A2, A3, A4, A5, A6, A7, A8) \
	NAME(A1) NAME(A2) NAME(A3) NAME(A4) NAME(A5) NAME(A6) NAME(A7) NAME(A8)

#define MACRO_REPEAT(NAME, ...) \
	MACRO_VARIANT(_MACRO_REPEAT, ##__VA_ARGS__)(NAME, ##__VA_ARGS__)

/* per-arglist repeat macro, use like this:
 * #define foo(...) MAP_LISTS(F, ##__VA_ARGS__)
 * where F is a n-ary function where n is the number of args in each arglist.
 * e.g.: MAP_LISTS(f, (a, b), (c, d))
 * expands to: f(a, b); f(c, d)
 */

#define ESC(...) __VA_ARGS__
#define MAP_LISTS(M, ...)                                                      \
	_CONCAT(_MAP_LISTS_, PP_NARG(__VA_ARGS__))(M, ##__VA_ARGS__)
#define _MAP_LISTS_0(M)
#define _MAP_LISTS_1(M, _1) ESC(M _1)
#define _MAP_LISTS_2(M, _1, _2) ESC(M _1; M _2)
#define _MAP_LISTS_3(M, _1, _2, _3) ESC(M _1; M _2; M _3)
#define _MAP_LISTS_4(M, _1, _2, _3, _4) ESC(M _1; M _2; M _3; M _4)
#define _MAP_LISTS_5(M, _1, _2, _3, _4, _5) ESC(M _1; M _2; M _3; M _4; M _5)
#define _MAP_LISTS_6(M, _1, _2, _3, _4, _5, _6)                                \
	ESC(M _1; M _2; M _3; M _4; M _5; M _6)
#define _MAP_LISTS_7(M, _1, _2, _3, _4, _5, _6, _7)                            \
	ESC(M _1; M _2; M _3; M _4; M _5; M _6; M _7)
#define _MAP_LISTS_8(M, _1, _2, _3, _4, _5, _6, _7, _8)                        \
	ESC(M _1; M _2; M _3; M _4; M _5; M _6; M _7; M _8)

/*
 * for warnings on macros, put in the macro content like this:
 *   #define MACRO BLA CPP_WARN("MACRO has been deprecated")
 */
#define CPP_STR(X) #X

#if defined(__ICC)
#define CPP_NOTICE(text) _Pragma(CPP_STR(message __FILE__ ": " text))
#define CPP_WARN(text) CPP_NOTICE(text)

#elif (defined(__GNUC__)                                                       \
       && (__GNUC__ >= 5 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 8)))           \
	|| (defined(__clang__)                                                 \
	    && (__clang_major__ >= 4                                           \
		|| (__clang_major__ == 3 && __clang_minor__ >= 5)))
#define CPP_WARN(text) _Pragma(CPP_STR(GCC warning text))
#define CPP_NOTICE(text) _Pragma(CPP_STR(message text))

#else
#define CPP_WARN(text)
#define CPP_NOTICE(text)
#endif

/* MAX / MIN are not commonly defined, but useful */
/* note: glibc sys/param.h has #define MIN(a,b) (((a)<(b))?(a):(b)) */
#ifdef MAX
#undef MAX
#endif
#define MAX(a, b)                                                              \
	({                                                                     \
		typeof(a) _max_a = (a);                                        \
		typeof(b) _max_b = (b);                                        \
		_max_a > _max_b ? _max_a : _max_b;                             \
	})
#ifdef MIN
#undef MIN
#endif
#define MIN(a, b)                                                              \
	({                                                                     \
		typeof(a) _min_a = (a);                                        \
		typeof(b) _min_b = (b);                                        \
		_min_a < _min_b ? _min_a : _min_b;                             \
	})

#define numcmp(a, b)                                                           \
	({                                                                     \
		typeof(a) _cmp_a = (a);                                        \
		typeof(b) _cmp_b = (b);                                        \
		(_cmp_a < _cmp_b) ? -1 : ((_cmp_a > _cmp_b) ? 1 : 0);          \
	})

#ifndef offsetof
#ifdef __compiler_offsetof
#define offsetof(TYPE, MEMBER) __compiler_offsetof(TYPE,MEMBER)
#else
#define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)
#endif
#endif

#ifdef container_of
#undef container_of
#endif

#if !(defined(__cplusplus) || defined(test__cplusplus))
/* this variant of container_of() retains 'const' on pointers without needing
 * to be told to do so.  The following will all work without warning:
 *
 * struct member *p;
 * const struct member *cp;
 *
 * const struct cont *x = container_of(cp, struct cont, member);
 * const struct cont *x = container_of(cp, const struct cont, member);
 * const struct cont *x = container_of(p,  struct cont, member);
 * const struct cont *x = container_of(p,  const struct cont, member);
 * struct cont *x       = container_of(p,  struct cont, member);
 *
 * but the following will generate warnings about stripping const:
 *
 * struct cont *x       = container_of(cp, struct cont, member);
 * struct cont *x       = container_of(cp, const struct cont, member);
 * struct cont *x       = container_of(p,  const struct cont, member);
 */
#define container_of(ptr, type, member)                                        \
	(__builtin_choose_expr(                                                \
		__builtin_types_compatible_p(typeof(&((type *)0)->member),     \
			typeof(ptr))                                           \
		    ||  __builtin_types_compatible_p(void *, typeof(ptr)),     \
		({                                                             \
			typeof(((type *)0)->member) *__mptr = (void *)(ptr);   \
			(type *)((char *)__mptr - offsetof(type, member));     \
		}),                                                            \
		({                                                             \
			typeof(((const type *)0)->member) *__mptr = (ptr);     \
			(const type *)((const char *)__mptr -                  \
					offsetof(type, member));               \
		})                                                             \
	))
#else
/* current C++ compilers don't have the builtins used above; so this version
 * of the macro doesn't do the const check. */
#define container_of(ptr, type, member)                                        \
		({                                                             \
			const typeof(((type *)0)->member) *__mptr = (ptr);     \
			(type *)((char *)__mptr - offsetof(type, member));     \
		})
#endif

#define container_of_null(ptr, type, member)                                   \
	({                                                                     \
		typeof(ptr) _tmp = (ptr);                                      \
		_tmp ? container_of(_tmp, type, member) : NULL;                \
	})

#define array_size(ar) (sizeof(ar) / sizeof(ar[0]))

/* Some insane macros to count number of varargs to a functionlike macro */
#define PP_ARG_N( \
          _1,  _2,  _3,  _4,  _5,  _6,  _7,  _8,  _9, _10, \
         _11, _12, _13, _14, _15, _16, _17, _18, _19, _20, \
         _21, _22, _23, _24, _25, _26, _27, _28, _29, _30, \
         _31, _32, _33, _34, _35, _36, _37, _38, _39, _40, \
         _41, _42, _43, _44, _45, _46, _47, _48, _49, _50, \
         _51, _52, _53, _54, _55, _56, _57, _58, _59, _60, \
         _61, _62, _63, N, ...) N

#define PP_RSEQ_N()                                        \
         62, 61, 60,                                       \
         59, 58, 57, 56, 55, 54, 53, 52, 51, 50,           \
         49, 48, 47, 46, 45, 44, 43, 42, 41, 40,           \
         39, 38, 37, 36, 35, 34, 33, 32, 31, 30,           \
         29, 28, 27, 26, 25, 24, 23, 22, 21, 20,           \
         19, 18, 17, 16, 15, 14, 13, 12, 11, 10,           \
          9,  8,  7,  6,  5,  4,  3,  2,  1,  0

#define PP_NARG_(...) PP_ARG_N(__VA_ARGS__)
#define PP_NARG(...)     PP_NARG_(_, ##__VA_ARGS__, PP_RSEQ_N())


/* sigh. this is so ugly, it overflows and wraps to being nice again.
 *
 * printfrr() supports "%Ld" for <int64_t>, whatever that is typedef'd to.
 * However, gcc & clang think that "%Ld" is <long long>, which doesn't quite
 * match up since int64_t is <long> on a lot of 64-bit systems.
 *
 * If we have _FRR_ATTRIBUTE_PRINTFRR, we loaded a compiler plugin that
 * replaces the whole format checking bits with a custom version that
 * understands "%Ld" (along with "%pI4" and co.), so we don't need to do
 * anything.
 *
 * If we don't have that attribute...  we still want -Wformat to work.  So,
 * this is the "f*ck it" approach and we just redefine int64_t to always be
 * <long long>.  This should work until such a time that <long long> is
 * something else (e.g. 128-bit integer)...  let's just guard against that
 * with the _Static_assert below and work with the world we have right now,
 * where <long long> is always 64-bit.
 */

/* these need to be included before any of the following, so we can
 * "overwrite" things.
 */
#include <stdint.h>
#include <inttypes.h>

#ifdef _FRR_ATTRIBUTE_PRINTFRR
#define PRINTFRR(a, b) __attribute__((frr_format("frr_printf", a, b)))

#undef PRIu64
#undef PRId64
#undef PRIx64
#define PRIu64 "Lu"
#define PRId64 "Ld"
#define PRIx64 "Lx"

#else /* !_FRR_ATTRIBUTE_PRINTFRR */
#ifdef __NetBSD__
#define PRINTFRR(a, b) __attribute__((format(gnu_syslog, a, b)))
#else
#define PRINTFRR(a, b) __attribute__((format(printf, a, b)))
#endif

/* frr-format plugin is C-only for now, so no point in doing these shenanigans
 * for C++...  (also they can break some C++ stuff...)
 */
#ifndef __cplusplus
/* these should be typedefs, but might also be #define */
#ifdef uint64_t
#undef uint64_t
#endif
#ifdef int64_t
#undef int64_t
#endif

/* can't overwrite the typedef, but we can replace int64_t with _int64_t */
typedef unsigned long long _uint64_t;
#define uint64_t _uint64_t
typedef signed long long _int64_t;
#define int64_t _int64_t

/* if this breaks, 128-bit machines may have entered reality (or <long long>
 * is something weird)
 */
_Static_assert(sizeof(_uint64_t) == 8 && sizeof(_int64_t) == 8,
	       "nobody expects the spanish intquisition");

/* since we redefined int64_t, we also need to redefine PRI*64 */
#undef PRIu64
#undef PRId64
#undef PRIx64
#define PRIu64 "llu"
#define PRId64 "lld"
#define PRIx64 "llx"

#endif /* !__cplusplus */
#endif /* !_FRR_ATTRIBUTE_PRINTFRR */

#ifdef __cplusplus
}
#endif

#endif /* _FRR_COMPILER_H */
Commit	Line	Data
de1a880c DL	1	/*
	2	* Copyright (c) 2015-2017 David Lamparter, for NetDEF, Inc.
	3	*
	4	* Permission to use, copy, modify, and distribute this software for any
	5	* purpose with or without fee is hereby granted, provided that the above
	6	* copyright notice and this permission notice appear in all copies.
	7	*
	8	* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
	9	* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
	10	* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
	11	* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
	12	* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
	13	* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
	14	* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
	15	*/
	16
	17	#ifndef _FRR_COMPILER_H
	18	#define _FRR_COMPILER_H
	19
5e244469 RW	20	#ifdef __cplusplus
	21	extern "C" {
	22	#endif
	23
15c05f1e DL	24	#ifdef __cplusplus
	25	# if __cplusplus < 201103L
	26	# error FRRouting headers must be compiled in C++11 mode or newer
	27	# endif
	28	/* C++ defines static_assert(), but not _Static_assert(). C defines
	29	* _Static_assert() and has static_assert() in <assert.h>. However, we mess
	30	* with assert() in zassert.h so let's not include <assert.h> here.
	31	*/
	32	# define _Static_assert static_assert
	33	#else
	34	# if !defined(__STDC_VERSION__) \|\| __STDC_VERSION__ < 201112L
	35	# error FRRouting must be compiled with min. -std=gnu11 (GNU ISO C11 dialect)
	36	# endif
	37	#endif
	38
de1a880c DL	39	/* function attributes, use like
	40	* void prototype(void) __attribute__((_CONSTRUCTOR(100)));
	41	*/
	42	#if defined(__clang__)
996c9314	43	#if __clang_major__ > 3 \|\| (__clang_major__ == 3 && __clang_minor__ >= 5)
de1a880c	44	# define _RET_NONNULL , returns_nonnull
996c9314	45	#endif
bd27ea43 DL	46	#if __has_attribute(fallthrough)
	47	# define _FALLTHROUGH __attribute__((fallthrough));
	48	#endif
de1a880c	49	# define _CONSTRUCTOR(x) constructor(x)
bcea0c0f	50	# define _DEPRECATED(x) deprecated(x)
111a04f7 DL	51	# if __has_builtin(assume)
	52	# define assume(x) __builtin_assume(x)
	53	# endif
de1a880c	54	#elif defined(__GNUC__)
996c9314	55	#if __GNUC__ > 4 \|\| (__GNUC__ == 4 && __GNUC_MINOR__ >= 9)
de1a880c	56	# define _RET_NONNULL , returns_nonnull
996c9314 LB	57	#endif
996c9314 LB	58	#if __GNUC__ > 4 \|\| (__GNUC__ == 4 && __GNUC_MINOR__ >= 3)
de1a880c DL	59	# define _CONSTRUCTOR(x) constructor(x)
	60	# define _DESTRUCTOR(x) destructor(x)
	61	# define _ALLOC_SIZE(x) alloc_size(x)
996c9314	62	#endif
bcea0c0f DL	63	#if __GNUC__ > 4 \|\| (__GNUC__ == 4 && __GNUC_MINOR__ >= 5)
bcea0c0f DL	64	# define _DEPRECATED(x) deprecated(x)
111a04f7 DL	65	# define assume(x) do { if (!(x)) __builtin_unreachable(); } while (0)
	66	#endif
	67	#if __GNUC__ < 5
	68	# define __has_attribute(x) 0
bcea0c0f	69	#endif
bd27ea43 DL	70	#if __GNUC__ >= 7
	71	# define _FALLTHROUGH __attribute__((fallthrough));
	72	#endif
de1a880c DL	73	#endif
de1a880c DL	74
111a04f7 DL	75	#if __has_attribute(hot)
	76	# define _OPTIMIZE_HOT __attribute__((hot))
	77	#else
	78	# define _OPTIMIZE_HOT
	79	#endif
	80	#if __has_attribute(optimize)
	81	# define _OPTIMIZE_O3 __attribute__((optimize("3")))
	82	#else
	83	# define _OPTIMIZE_O3
	84	#endif
	85	#define OPTIMIZE _OPTIMIZE_O3 _OPTIMIZE_HOT
	86
8be3678a DL	87	#if !defined(__GNUC__)
	88	#error module code needs GCC visibility extensions
	89	#elif __GNUC__ < 4
	90	#error module code needs GCC visibility extensions
	91	#else
	92	# define DSO_PUBLIC __attribute__ ((visibility ("default")))
	93	# define DSO_SELF __attribute__ ((visibility ("protected")))
	94	# define DSO_LOCAL __attribute__ ((visibility ("hidden")))
	95	#endif
	96
de1a880c DL	97	#ifdef __sun
de1a880c DL	98	/* Solaris doesn't do constructor priorities due to linker restrictions */
996c9314 LB	99	#undef _CONSTRUCTOR
996c9314 LB	100	#undef _DESTRUCTOR
de1a880c DL	101	#endif
	102
	103	/* fallback versions */
	104	#ifndef _RET_NONNULL
	105	# define _RET_NONNULL
	106	#endif
	107	#ifndef _CONSTRUCTOR
	108	# define _CONSTRUCTOR(x) constructor
	109	#endif
	110	#ifndef _DESTRUCTOR
	111	# define _DESTRUCTOR(x) destructor
	112	#endif
	113	#ifndef _ALLOC_SIZE
	114	# define _ALLOC_SIZE(x)
	115	#endif
bd27ea43 DL	116	#ifndef _FALLTHROUGH
	117	#define _FALLTHROUGH
	118	#endif
bcea0c0f DL	119	#ifndef _DEPRECATED
	120	#define _DEPRECATED(x) deprecated
	121	#endif
111a04f7 DL	122	#ifndef assume
	123	#define assume(x)
	124	#endif
de1a880c	125
0d019561 DL	126	/* for helper functions defined inside macros */
	127	#define macro_inline static inline __attribute__((unused))
	128	#define macro_pure static inline __attribute__((unused, pure))
	129
bf8d3d6a DL	130	/* if the macro ends with a function definition */
	131	#define MACRO_REQUIRE_SEMICOLON() \
	132	_Static_assert(1, "please add a semicolon after this macro")
48373d46 DL	133
	134	/* variadic macros, use like:
	135	* #define V_0() ...
	136	* #define V_1(x) ...
	137	* #define V(...) MACRO_VARIANT(V, ##__VA_ARGS__)(__VA_ARGS__)
	138	*/
	139	#define _MACRO_VARIANT(A0,A1,A2,A3,A4,A5,A6,A7,A8,A9,A10, N, ...) N
	140
	141	#define _CONCAT2(a, b) a ## b
	142	#define _CONCAT(a, b) _CONCAT2(a,b)
	143
	144	#define MACRO_VARIANT(NAME, ...) \
	145	_CONCAT(NAME, _MACRO_VARIANT(0, ##__VA_ARGS__, \
	146	_10, _9, _8, _7, _6, _5, _4, _3, _2, _1, _0))
	147
	148	#define NAMECTR(name) _CONCAT(name, __COUNTER__)
	149
	150	/* per-arg repeat macros, use like:
	151	* #define PERARG(n) ...n...
	152	* #define FOO(...) MACRO_REPEAT(PERARG, ##__VA_ARGS__)
	153	*/
	154
	155	#define _MACRO_REPEAT_0(NAME)
	156	#define _MACRO_REPEAT_1(NAME, A1) \
	157	NAME(A1)
	158	#define _MACRO_REPEAT_2(NAME, A1, A2) \
	159	NAME(A1) NAME(A2)
	160	#define _MACRO_REPEAT_3(NAME, A1, A2, A3) \
	161	NAME(A1) NAME(A2) NAME(A3)
	162	#define _MACRO_REPEAT_4(NAME, A1, A2, A3, A4) \
	163	NAME(A1) NAME(A2) NAME(A3) NAME(A4)
	164	#define _MACRO_REPEAT_5(NAME, A1, A2, A3, A4, A5) \
	165	NAME(A1) NAME(A2) NAME(A3) NAME(A4) NAME(A5)
	166	#define _MACRO_REPEAT_6(NAME, A1, A2, A3, A4, A5, A6) \
	167	NAME(A1) NAME(A2) NAME(A3) NAME(A4) NAME(A5) NAME(A6)
	168	#define _MACRO_REPEAT_7(NAME, A1, A2, A3, A4, A5, A6, A7) \
	169	NAME(A1) NAME(A2) NAME(A3) NAME(A4) NAME(A5) NAME(A6) NAME(A7)
	170	#define _MACRO_REPEAT_8(NAME, A1, A2, A3, A4, A5, A6, A7, A8) \
	171	NAME(A1) NAME(A2) NAME(A3) NAME(A4) NAME(A5) NAME(A6) NAME(A7) NAME(A8)
	172
	173	#define MACRO_REPEAT(NAME, ...) \
	174	MACRO_VARIANT(_MACRO_REPEAT, ##__VA_ARGS__)(NAME, ##__VA_ARGS__)
	175
249cd5da	176	/* per-arglist repeat macro, use like this:
19eee398	177	* #define foo(...) MAP_LISTS(F, ##__VA_ARGS__)
249cd5da	178	* where F is a n-ary function where n is the number of args in each arglist.
19eee398 DL	179	* e.g.: MAP_LISTS(f, (a, b), (c, d))
19eee398 DL	180	* expands to: f(a, b); f(c, d)
249cd5da DL	181	*/
	182
	183	#define ESC(...) __VA_ARGS__
	184	#define MAP_LISTS(M, ...) \
	185	_CONCAT(_MAP_LISTS_, PP_NARG(__VA_ARGS__))(M, ##__VA_ARGS__)
	186	#define _MAP_LISTS_0(M)
	187	#define _MAP_LISTS_1(M, _1) ESC(M _1)
	188	#define _MAP_LISTS_2(M, _1, _2) ESC(M _1; M _2)
	189	#define _MAP_LISTS_3(M, _1, _2, _3) ESC(M _1; M _2; M _3)
	190	#define _MAP_LISTS_4(M, _1, _2, _3, _4) ESC(M _1; M _2; M _3; M _4)
	191	#define _MAP_LISTS_5(M, _1, _2, _3, _4, _5) ESC(M _1; M _2; M _3; M _4; M _5)
	192	#define _MAP_LISTS_6(M, _1, _2, _3, _4, _5, _6) \
	193	ESC(M _1; M _2; M _3; M _4; M _5; M _6)
	194	#define _MAP_LISTS_7(M, _1, _2, _3, _4, _5, _6, _7) \
	195	ESC(M _1; M _2; M _3; M _4; M _5; M _6; M _7)
	196	#define _MAP_LISTS_8(M, _1, _2, _3, _4, _5, _6, _7, _8) \
	197	ESC(M _1; M _2; M _3; M _4; M _5; M _6; M _7; M _8)
19eee398	198
de1a880c DL	199	/*
	200	* for warnings on macros, put in the macro content like this:
	201	* #define MACRO BLA CPP_WARN("MACRO has been deprecated")
	202	*/
	203	#define CPP_STR(X) #X
	204
	205	#if defined(__ICC)
	206	#define CPP_NOTICE(text) _Pragma(CPP_STR(message __FILE__ ": " text))
	207	#define CPP_WARN(text) CPP_NOTICE(text)
	208
	209	#elif (defined(__GNUC__) \
	210	&& (__GNUC__ >= 5 \|\| (__GNUC__ == 4 && __GNUC_MINOR__ >= 8))) \
	211	\|\| (defined(__clang__) \
	212	&& (__clang_major__ >= 4 \
	213	\|\| (__clang_major__ == 3 && __clang_minor__ >= 5)))
	214	#define CPP_WARN(text) _Pragma(CPP_STR(GCC warning text))
	215	#define CPP_NOTICE(text) _Pragma(CPP_STR(message text))
	216
	217	#else
	218	#define CPP_WARN(text)
ec40eaf9	219	#define CPP_NOTICE(text)
de1a880c DL	220	#endif
de1a880c DL	221
0d019561 DL	222	/* MAX / MIN are not commonly defined, but useful */
	223	/* note: glibc sys/param.h has #define MIN(a,b) (((a)<(b))?(a):(b)) */
	224	#ifdef MAX
	225	#undef MAX
	226	#endif
	227	#define MAX(a, b) \
	228	({ \
	229	typeof(a) _max_a = (a); \
	230	typeof(b) _max_b = (b); \
	231	_max_a > _max_b ? _max_a : _max_b; \
	232	})
	233	#ifdef MIN
	234	#undef MIN
	235	#endif
	236	#define MIN(a, b) \
	237	({ \
	238	typeof(a) _min_a = (a); \
	239	typeof(b) _min_b = (b); \
	240	_min_a < _min_b ? _min_a : _min_b; \
	241	})
	242
1315d74d DL	243	#define numcmp(a, b) \
	244	({ \
	245	typeof(a) _cmp_a = (a); \
	246	typeof(b) _cmp_b = (b); \
	247	(_cmp_a < _cmp_b) ? -1 : ((_cmp_a > _cmp_b) ? 1 : 0); \
	248	})
	249
0d019561 DL	250	#ifndef offsetof
	251	#ifdef __compiler_offsetof
	252	#define offsetof(TYPE, MEMBER) __compiler_offsetof(TYPE,MEMBER)
	253	#else
	254	#define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)
	255	#endif
	256	#endif
	257
a7f20d43 DL	258	#ifdef container_of
	259	#undef container_of
	260	#endif
	261
	262	#if !(defined(__cplusplus) \|\| defined(test__cplusplus))
0d019561 DL	263	/* this variant of container_of() retains 'const' on pointers without needing
	264	* to be told to do so. The following will all work without warning:
	265	*
	266	* struct member *p;
	267	* const struct member *cp;
	268	*
	269	* const struct cont *x = container_of(cp, struct cont, member);
	270	* const struct cont *x = container_of(cp, const struct cont, member);
	271	* const struct cont *x = container_of(p, struct cont, member);
	272	* const struct cont *x = container_of(p, const struct cont, member);
	273	* struct cont *x = container_of(p, struct cont, member);
	274	*
	275	* but the following will generate warnings about stripping const:
	276	*
	277	* struct cont *x = container_of(cp, struct cont, member);
	278	* struct cont *x = container_of(cp, const struct cont, member);
	279	* struct cont *x = container_of(p, const struct cont, member);
	280	*/
0d019561 DL	281	#define container_of(ptr, type, member) \
	282	(__builtin_choose_expr( \
	283	__builtin_types_compatible_p(typeof(&((type *)0)->member), \
	284	typeof(ptr)) \
	285	\|\| __builtin_types_compatible_p(void *, typeof(ptr)), \
	286	({ \
	287	typeof(((type )0)->member) __mptr = (void *)(ptr); \
	288	(type )((char )__mptr - offsetof(type, member)); \
	289	}), \
	290	({ \
	291	typeof(((const type )0)->member) __mptr = (ptr); \
	292	(const type )((const char )__mptr - \
	293	offsetof(type, member)); \
	294	}) \
	295	))
a7f20d43 DL	296	#else
	297	/* current C++ compilers don't have the builtins used above; so this version
	298	* of the macro doesn't do the const check. */
	299	#define container_of(ptr, type, member) \
	300	({ \
	301	const typeof(((type )0)->member) __mptr = (ptr); \
	302	(type )((char )__mptr - offsetof(type, member)); \
	303	})
	304	#endif
0d019561 DL	305
	306	#define container_of_null(ptr, type, member) \
	307	({ \
	308	typeof(ptr) _tmp = (ptr); \
	309	_tmp ? container_of(_tmp, type, member) : NULL; \
	310	})
	311
	312	#define array_size(ar) (sizeof(ar) / sizeof(ar[0]))
	313
9f79b375 QY	314	/* Some insane macros to count number of varargs to a functionlike macro */
	315	#define PP_ARG_N( \
	316	_1, _2, _3, _4, _5, _6, _7, _8, _9, _10, \
	317	_11, _12, _13, _14, _15, _16, _17, _18, _19, _20, \
	318	_21, _22, _23, _24, _25, _26, _27, _28, _29, _30, \
	319	_31, _32, _33, _34, _35, _36, _37, _38, _39, _40, \
	320	_41, _42, _43, _44, _45, _46, _47, _48, _49, _50, \
	321	_51, _52, _53, _54, _55, _56, _57, _58, _59, _60, \
	322	_61, _62, _63, N, ...) N
	323
	324	#define PP_RSEQ_N() \
	325	62, 61, 60, \
	326	59, 58, 57, 56, 55, 54, 53, 52, 51, 50, \
	327	49, 48, 47, 46, 45, 44, 43, 42, 41, 40, \
	328	39, 38, 37, 36, 35, 34, 33, 32, 31, 30, \
	329	29, 28, 27, 26, 25, 24, 23, 22, 21, 20, \
	330	19, 18, 17, 16, 15, 14, 13, 12, 11, 10, \
	331	9, 8, 7, 6, 5, 4, 3, 2, 1, 0
	332
ef3b48cf	333	#define PP_NARG_(...) PP_ARG_N(__VA_ARGS__)
9f79b375 QY	334	#define PP_NARG(...) PP_NARG_(_, ##__VA_ARGS__, PP_RSEQ_N())
	335
	336
afb35622 DL	337	/* sigh. this is so ugly, it overflows and wraps to being nice again.
	338	*
	339	* printfrr() supports "%Ld" for <int64_t>, whatever that is typedef'd to.
	340	* However, gcc & clang think that "%Ld" is <long long>, which doesn't quite
	341	* match up since int64_t is <long> on a lot of 64-bit systems.
	342	*
	343	* If we have _FRR_ATTRIBUTE_PRINTFRR, we loaded a compiler plugin that
	344	* replaces the whole format checking bits with a custom version that
	345	* understands "%Ld" (along with "%pI4" and co.), so we don't need to do
	346	* anything.
	347	*
	348	* If we don't have that attribute... we still want -Wformat to work. So,
	349	* this is the "f*ck it" approach and we just redefine int64_t to always be
	350	* <long long>. This should work until such a time that <long long> is
	351	* something else (e.g. 128-bit integer)... let's just guard against that
	352	* with the _Static_assert below and work with the world we have right now,
	353	* where <long long> is always 64-bit.
	354	*/
	355
	356	/* these need to be included before any of the following, so we can
	357	* "overwrite" things.
	358	*/
	359	#include <stdint.h>
	360	#include <inttypes.h>
	361
	362	#ifdef _FRR_ATTRIBUTE_PRINTFRR
07ef3e34 DL	363	#define PRINTFRR(a, b) __attribute__((frr_format("frr_printf", a, b)))
	364
	365	#undef PRIu64
	366	#undef PRId64
	367	#undef PRIx64
	368	#define PRIu64 "Lu"
	369	#define PRId64 "Ld"
	370	#define PRIx64 "Lx"
afb35622 DL	371
afb35622 DL	372	#else /* !_FRR_ATTRIBUTE_PRINTFRR */
ca846ff8 DL	373	#ifdef __NetBSD__
	374	#define PRINTFRR(a, b) __attribute__((format(gnu_syslog, a, b)))
	375	#else
afb35622	376	#define PRINTFRR(a, b) __attribute__((format(printf, a, b)))
ca846ff8	377	#endif
afb35622	378
4f1a6d98 DL	379	/* frr-format plugin is C-only for now, so no point in doing these shenanigans
	380	* for C++... (also they can break some C++ stuff...)
	381	*/
	382	#ifndef __cplusplus
afb35622 DL	383	/* these should be typedefs, but might also be #define */
	384	#ifdef uint64_t
	385	#undef uint64_t
	386	#endif
	387	#ifdef int64_t
	388	#undef int64_t
	389	#endif
	390
	391	/* can't overwrite the typedef, but we can replace int64_t with _int64_t */
	392	typedef unsigned long long _uint64_t;
	393	#define uint64_t _uint64_t
	394	typedef signed long long _int64_t;
	395	#define int64_t _int64_t
	396
	397	/* if this breaks, 128-bit machines may have entered reality (or <long long>
	398	* is something weird)
	399	*/
afb35622 DL	400	_Static_assert(sizeof(_uint64_t) == 8 && sizeof(_int64_t) == 8,
afb35622 DL	401	"nobody expects the spanish intquisition");
afb35622 DL	402
	403	/* since we redefined int64_t, we also need to redefine PRI64 /
	404	#undef PRIu64
	405	#undef PRId64
	406	#undef PRIx64
	407	#define PRIu64 "llu"
	408	#define PRId64 "lld"
	409	#define PRIx64 "llx"
4f1a6d98 DL	410
4f1a6d98 DL	411	#endif /* !__cplusplus */
afb35622 DL	412	#endif /* !_FRR_ATTRIBUTE_PRINTFRR */
afb35622 DL	413
5e244469 RW	414	#ifdef __cplusplus
	415	}
	416	#endif
	417
de1a880c	418	#endif /* _FRR_COMPILER_H */