[thirdparty/systemd.git] / src / basic / macro.h

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

/***
  This file is part of systemd.

  Copyright 2010 Lennart Poettering
***/

#include <inttypes.h>
#include <stdbool.h>
#include <sys/param.h>
#include <sys/sysmacros.h>
#include <sys/types.h>

#define _printf_(a,b) __attribute__ ((format (printf, a, b)))
#ifdef __clang__
#  define _alloc_(...)
#else
#  define _alloc_(...) __attribute__ ((alloc_size(__VA_ARGS__)))
#endif
#define _sentinel_ __attribute__ ((sentinel))
#define _unused_ __attribute__ ((unused))
#define _destructor_ __attribute__ ((destructor))
#define _pure_ __attribute__ ((pure))
#define _const_ __attribute__ ((const))
#define _deprecated_ __attribute__ ((deprecated))
#define _packed_ __attribute__ ((packed))
#define _malloc_ __attribute__ ((malloc))
#define _weak_ __attribute__ ((weak))
#define _likely_(x) (__builtin_expect(!!(x),1))
#define _unlikely_(x) (__builtin_expect(!!(x),0))
#define _public_ __attribute__ ((visibility("default")))
#define _hidden_ __attribute__ ((visibility("hidden")))
#define _weakref_(x) __attribute__((weakref(#x)))
#define _alignas_(x) __attribute__((aligned(__alignof(x))))
#define _cleanup_(x) __attribute__((cleanup(x)))
#if __GNUC__ >= 7
#define _fallthrough_ __attribute__((fallthrough))
#else
#define _fallthrough_
#endif
/* Define C11 noreturn without <stdnoreturn.h> and even on older gcc
 * compiler versions */
#ifndef _noreturn_
#if __STDC_VERSION__ >= 201112L
#define _noreturn_ _Noreturn
#else
#define _noreturn_ __attribute__((noreturn))
#endif
#endif

#if !defined(HAS_FEATURE_MEMORY_SANITIZER)
#  if defined(__has_feature)
#    if __has_feature(memory_sanitizer)
#      define HAS_FEATURE_MEMORY_SANITIZER 1
#    endif
#  endif
#  if !defined(HAS_FEATURE_MEMORY_SANITIZER)
#    define HAS_FEATURE_MEMORY_SANITIZER 0
#  endif
#endif

/* Temporarily disable some warnings */
#define DISABLE_WARNING_DECLARATION_AFTER_STATEMENT                     \
        _Pragma("GCC diagnostic push");                                 \
        _Pragma("GCC diagnostic ignored \"-Wdeclaration-after-statement\"")

#define DISABLE_WARNING_FORMAT_NONLITERAL                               \
        _Pragma("GCC diagnostic push");                                 \
        _Pragma("GCC diagnostic ignored \"-Wformat-nonliteral\"")

#define DISABLE_WARNING_MISSING_PROTOTYPES                              \
        _Pragma("GCC diagnostic push");                                 \
        _Pragma("GCC diagnostic ignored \"-Wmissing-prototypes\"")

#define DISABLE_WARNING_NONNULL                                         \
        _Pragma("GCC diagnostic push");                                 \
        _Pragma("GCC diagnostic ignored \"-Wnonnull\"")

#define DISABLE_WARNING_SHADOW                                          \
        _Pragma("GCC diagnostic push");                                 \
        _Pragma("GCC diagnostic ignored \"-Wshadow\"")

#define DISABLE_WARNING_INCOMPATIBLE_POINTER_TYPES                      \
        _Pragma("GCC diagnostic push");                                 \
        _Pragma("GCC diagnostic ignored \"-Wincompatible-pointer-types\"")

#define REENABLE_WARNING                                                \
        _Pragma("GCC diagnostic pop")

/* automake test harness */
#define EXIT_TEST_SKIP 77

#define XSTRINGIFY(x) #x
#define STRINGIFY(x) XSTRINGIFY(x)

#define XCONCATENATE(x, y) x ## y
#define CONCATENATE(x, y) XCONCATENATE(x, y)

#define UNIQ_T(x, uniq) CONCATENATE(__unique_prefix_, CONCATENATE(x, uniq))
#define UNIQ __COUNTER__

/* builtins */
#if __SIZEOF_INT__ == 4
#define BUILTIN_FFS_U32(x) __builtin_ffs(x);
#elif __SIZEOF_LONG__ == 4
#define BUILTIN_FFS_U32(x) __builtin_ffsl(x);
#else
#error "neither int nor long are four bytes long?!?"
#endif

/* Rounds up */

#define ALIGN4(l) (((l) + 3) & ~3)
#define ALIGN8(l) (((l) + 7) & ~7)

#if __SIZEOF_POINTER__ == 8
#define ALIGN(l) ALIGN8(l)
#elif __SIZEOF_POINTER__ == 4
#define ALIGN(l) ALIGN4(l)
#else
#error "Wut? Pointers are neither 4 nor 8 bytes long?"
#endif

#define ALIGN_PTR(p) ((void*) ALIGN((unsigned long) (p)))
#define ALIGN4_PTR(p) ((void*) ALIGN4((unsigned long) (p)))
#define ALIGN8_PTR(p) ((void*) ALIGN8((unsigned long) (p)))

static inline size_t ALIGN_TO(size_t l, size_t ali) {
        return ((l + ali - 1) & ~(ali - 1));
}

#define ALIGN_TO_PTR(p, ali) ((void*) ALIGN_TO((unsigned long) (p), (ali)))

/* align to next higher power-of-2 (except for: 0 => 0, overflow => 0) */
static inline unsigned long ALIGN_POWER2(unsigned long u) {
        /* clz(0) is undefined */
        if (u == 1)
                return 1;

        /* left-shift overflow is undefined */
        if (__builtin_clzl(u - 1UL) < 1)
                return 0;

        return 1UL << (sizeof(u) * 8 - __builtin_clzl(u - 1UL));
}

#ifndef __COVERITY__
#  define VOID_0 ((void)0)
#else
#  define VOID_0 ((void*)0)
#endif

#define ELEMENTSOF(x)                                                    \
        __extension__ (__builtin_choose_expr(                            \
                !__builtin_types_compatible_p(typeof(x), typeof(&*(x))), \
                sizeof(x)/sizeof((x)[0]),                                \
                VOID_0))

/*
 * STRLEN - return the length of a string literal, minus the trailing NUL byte.
 *          Contrary to strlen(), this is a constant expression.
 * @x: a string literal.
 */
#define STRLEN(x) (sizeof(""x"") - 1)

/*
 * container_of - cast a member of a structure out to the containing structure
 * @ptr: the pointer to the member.
 * @type: the type of the container struct this is embedded in.
 * @member: the name of the member within the struct.
 */
#define container_of(ptr, type, member) __container_of(UNIQ, (ptr), type, member)
#define __container_of(uniq, ptr, type, member)                         \
        __extension__ ({                                                \
                const typeof( ((type*)0)->member ) *UNIQ_T(A, uniq) = (ptr); \
                (type*)( (char *)UNIQ_T(A, uniq) - offsetof(type,member) ); \
        })

#undef MAX
#define MAX(a, b) __MAX(UNIQ, (a), UNIQ, (b))
#define __MAX(aq, a, bq, b)                             \
        __extension__ ({                                \
                const typeof(a) UNIQ_T(A, aq) = (a);    \
                const typeof(b) UNIQ_T(B, bq) = (b);    \
                UNIQ_T(A,aq) > UNIQ_T(B,bq) ? UNIQ_T(A,aq) : UNIQ_T(B,bq); \
        })

/* evaluates to (void) if _A or _B are not constant or of different types */
#define CONST_MAX(_A, _B) \
        __extension__ (__builtin_choose_expr(                           \
                __builtin_constant_p(_A) &&                             \
                __builtin_constant_p(_B) &&                             \
                __builtin_types_compatible_p(typeof(_A), typeof(_B)),   \
                ((_A) > (_B)) ? (_A) : (_B),                            \
                VOID_0))

/* takes two types and returns the size of the larger one */
#define MAXSIZE(A, B) (sizeof(union _packed_ { typeof(A) a; typeof(B) b; }))

#define MAX3(x,y,z)                                     \
        __extension__ ({                                \
                        const typeof(x) _c = MAX(x,y);  \
                        MAX(_c, z);                     \
                })

#undef MIN
#define MIN(a, b) __MIN(UNIQ, (a), UNIQ, (b))
#define __MIN(aq, a, bq, b)                             \
        __extension__ ({                                \
                const typeof(a) UNIQ_T(A, aq) = (a);    \
                const typeof(b) UNIQ_T(B, bq) = (b);    \
                UNIQ_T(A,aq) < UNIQ_T(B,bq) ? UNIQ_T(A,aq) : UNIQ_T(B,bq); \
        })

#define MIN3(x,y,z)                                     \
        __extension__ ({                                \
                        const typeof(x) _c = MIN(x,y);  \
                        MIN(_c, z);                     \
                })

#define LESS_BY(a, b) __LESS_BY(UNIQ, (a), UNIQ, (b))
#define __LESS_BY(aq, a, bq, b)                         \
        __extension__ ({                                \
                const typeof(a) UNIQ_T(A, aq) = (a);    \
                const typeof(b) UNIQ_T(B, bq) = (b);    \
                UNIQ_T(A,aq) > UNIQ_T(B,bq) ? UNIQ_T(A,aq) - UNIQ_T(B,bq) : 0; \
        })

#undef CLAMP
#define CLAMP(x, low, high) __CLAMP(UNIQ, (x), UNIQ, (low), UNIQ, (high))
#define __CLAMP(xq, x, lowq, low, highq, high)                          \
        __extension__ ({                                                \
                const typeof(x) UNIQ_T(X,xq) = (x);                     \
                const typeof(low) UNIQ_T(LOW,lowq) = (low);             \
                const typeof(high) UNIQ_T(HIGH,highq) = (high);         \
                        UNIQ_T(X,xq) > UNIQ_T(HIGH,highq) ?             \
                                UNIQ_T(HIGH,highq) :                    \
                                UNIQ_T(X,xq) < UNIQ_T(LOW,lowq) ?       \
                                        UNIQ_T(LOW,lowq) :              \
                                        UNIQ_T(X,xq);                   \
        })

/* [(x + y - 1) / y] suffers from an integer overflow, even though the
 * computation should be possible in the given type. Therefore, we use
 * [x / y + !!(x % y)]. Note that on "Real CPUs" a division returns both the
 * quotient and the remainder, so both should be equally fast. */
#define DIV_ROUND_UP(_x, _y)                                            \
        __extension__ ({                                                \
                const typeof(_x) __x = (_x);                            \
                const typeof(_y) __y = (_y);                            \
                (__x / __y + !!(__x % __y));                            \
        })

#define assert_message_se(expr, message)                                \
        do {                                                            \
                if (_unlikely_(!(expr)))                                \
                        log_assert_failed(message, __FILE__, __LINE__, __PRETTY_FUNCTION__); \
        } while (false)

#define assert_se(expr) assert_message_se(expr, #expr)

/* We override the glibc assert() here. */
#undef assert
#ifdef NDEBUG
#define assert(expr) do {} while (false)
#else
#define assert(expr) assert_message_se(expr, #expr)
#endif

#define assert_not_reached(t)                                           \
        do {                                                            \
                log_assert_failed_unreachable(t, __FILE__, __LINE__, __PRETTY_FUNCTION__); \
        } while (false)

#if defined(static_assert)
/* static_assert() is sometimes defined in a way that trips up
 * -Wdeclaration-after-statement, hence let's temporarily turn off
 * this warning around it. */
#define assert_cc(expr)                                                 \
        DISABLE_WARNING_DECLARATION_AFTER_STATEMENT;                    \
        static_assert(expr, #expr);                                     \
        REENABLE_WARNING
#else
#define assert_cc(expr)                                                 \
        DISABLE_WARNING_DECLARATION_AFTER_STATEMENT;                    \
        struct CONCATENATE(_assert_struct_, __COUNTER__) {              \
                char x[(expr) ? 0 : -1];                                \
        };                                                              \
        REENABLE_WARNING
#endif

#define assert_log(expr, message) ((_likely_(expr))                     \
        ? (true)                                                        \
        : (log_assert_failed_return(message, __FILE__, __LINE__, __PRETTY_FUNCTION__), false))

#define assert_return(expr, r)                                          \
        do {                                                            \
                if (!assert_log(expr, #expr))                           \
                        return (r);                                     \
        } while (false)

#define assert_return_errno(expr, r, err)                               \
        do {                                                            \
                if (!assert_log(expr, #expr)) {                         \
                        errno = err;                                    \
                        return (r);                                     \
                }                                                       \
        } while (false)

#define PTR_TO_INT(p) ((int) ((intptr_t) (p)))
#define INT_TO_PTR(u) ((void *) ((intptr_t) (u)))
#define PTR_TO_UINT(p) ((unsigned int) ((uintptr_t) (p)))
#define UINT_TO_PTR(u) ((void *) ((uintptr_t) (u)))

#define PTR_TO_LONG(p) ((long) ((intptr_t) (p)))
#define LONG_TO_PTR(u) ((void *) ((intptr_t) (u)))
#define PTR_TO_ULONG(p) ((unsigned long) ((uintptr_t) (p)))
#define ULONG_TO_PTR(u) ((void *) ((uintptr_t) (u)))

#define PTR_TO_INT32(p) ((int32_t) ((intptr_t) (p)))
#define INT32_TO_PTR(u) ((void *) ((intptr_t) (u)))
#define PTR_TO_UINT32(p) ((uint32_t) ((uintptr_t) (p)))
#define UINT32_TO_PTR(u) ((void *) ((uintptr_t) (u)))

#define PTR_TO_INT64(p) ((int64_t) ((intptr_t) (p)))
#define INT64_TO_PTR(u) ((void *) ((intptr_t) (u)))
#define PTR_TO_UINT64(p) ((uint64_t) ((uintptr_t) (p)))
#define UINT64_TO_PTR(u) ((void *) ((uintptr_t) (u)))

#define PTR_TO_SIZE(p) ((size_t) ((uintptr_t) (p)))
#define SIZE_TO_PTR(u) ((void *) ((uintptr_t) (u)))

#define CHAR_TO_STR(x) ((char[2]) { x, 0 })

#define char_array_0(x) x[sizeof(x)-1] = 0;

/* Returns the number of chars needed to format variables of the
 * specified type as a decimal string. Adds in extra space for a
 * negative '-' prefix (hence works correctly on signed
 * types). Includes space for the trailing NUL. */
#define DECIMAL_STR_MAX(type)                                           \
        (2+(sizeof(type) <= 1 ? 3 :                                     \
            sizeof(type) <= 2 ? 5 :                                     \
            sizeof(type) <= 4 ? 10 :                                    \
            sizeof(type) <= 8 ? 20 : sizeof(int[-2*(sizeof(type) > 8)])))

#define DECIMAL_STR_WIDTH(x)                            \
        ({                                              \
                typeof(x) _x_ = (x);                    \
                unsigned ans = 1;                       \
                while (_x_ /= 10)                       \
                        ans++;                          \
                ans;                                    \
        })

#define SET_FLAG(v, flag, b) \
        (v) = (b) ? ((v) | (flag)) : ((v) & ~(flag))

#define CASE_F(X) case X:
#define CASE_F_1(CASE, X) CASE_F(X)
#define CASE_F_2(CASE, X, ...)  CASE(X) CASE_F_1(CASE, __VA_ARGS__)
#define CASE_F_3(CASE, X, ...)  CASE(X) CASE_F_2(CASE, __VA_ARGS__)
#define CASE_F_4(CASE, X, ...)  CASE(X) CASE_F_3(CASE, __VA_ARGS__)
#define CASE_F_5(CASE, X, ...)  CASE(X) CASE_F_4(CASE, __VA_ARGS__)
#define CASE_F_6(CASE, X, ...)  CASE(X) CASE_F_5(CASE, __VA_ARGS__)
#define CASE_F_7(CASE, X, ...)  CASE(X) CASE_F_6(CASE, __VA_ARGS__)
#define CASE_F_8(CASE, X, ...)  CASE(X) CASE_F_7(CASE, __VA_ARGS__)
#define CASE_F_9(CASE, X, ...)  CASE(X) CASE_F_8(CASE, __VA_ARGS__)
#define CASE_F_10(CASE, X, ...) CASE(X) CASE_F_9(CASE, __VA_ARGS__)
#define CASE_F_11(CASE, X, ...) CASE(X) CASE_F_10(CASE, __VA_ARGS__)
#define CASE_F_12(CASE, X, ...) CASE(X) CASE_F_11(CASE, __VA_ARGS__)
#define CASE_F_13(CASE, X, ...) CASE(X) CASE_F_12(CASE, __VA_ARGS__)
#define CASE_F_14(CASE, X, ...) CASE(X) CASE_F_13(CASE, __VA_ARGS__)
#define CASE_F_15(CASE, X, ...) CASE(X) CASE_F_14(CASE, __VA_ARGS__)
#define CASE_F_16(CASE, X, ...) CASE(X) CASE_F_15(CASE, __VA_ARGS__)
#define CASE_F_17(CASE, X, ...) CASE(X) CASE_F_16(CASE, __VA_ARGS__)
#define CASE_F_18(CASE, X, ...) CASE(X) CASE_F_17(CASE, __VA_ARGS__)
#define CASE_F_19(CASE, X, ...) CASE(X) CASE_F_18(CASE, __VA_ARGS__)
#define CASE_F_20(CASE, X, ...) CASE(X) CASE_F_19(CASE, __VA_ARGS__)

#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
#define FOR_EACH_MAKE_CASE(...) \
        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, \
                               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) \
                   (CASE_F,__VA_ARGS__)

#define IN_SET(x, ...)                          \
        ({                                      \
                bool _found = false;            \
                /* If the build breaks in the line below, you need to extend the case macros */ \
                static _unused_ char _static_assert__macros_need_to_be_extended[20 - sizeof((int[]){__VA_ARGS__})/sizeof(int)]; \
                switch(x) {                     \
                FOR_EACH_MAKE_CASE(__VA_ARGS__) \
                        _found = true;          \
                        break;                  \
                default:                        \
                        break;                  \
                }                               \
                _found;                         \
        })

#define SWAP_TWO(x, y) do {                        \
                typeof(x) _t = (x);                \
                (x) = (y);                         \
                (y) = (_t);                        \
        } while (false)

/* Define C11 thread_local attribute even on older gcc compiler
 * version */
#ifndef thread_local
/*
 * Don't break on glibc < 2.16 that doesn't define __STDC_NO_THREADS__
 * see http://gcc.gnu.org/bugzilla/show_bug.cgi?id=53769
 */
#if __STDC_VERSION__ >= 201112L && !(defined(__STDC_NO_THREADS__) || (defined(__GNU_LIBRARY__) && __GLIBC__ == 2 && __GLIBC_MINOR__ < 16))
#define thread_local _Thread_local
#else
#define thread_local __thread
#endif
#endif

#define DEFINE_TRIVIAL_CLEANUP_FUNC(type, func)                 \
        static inline void func##p(type *p) {                   \
                if (*p)                                         \
                        func(*p);                               \
        }

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