[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

  systemd is free software; you can redistribute it and/or modify it
  under the terms of the GNU Lesser General Public License as published by
  the Free Software Foundation; either version 2.1 of the License, or
  (at your option) any later version.

  systemd is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public License
  along with systemd; If not, see <http://www.gnu.org/licenses/>.
***/

#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

/* 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 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

#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
	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
5430f7f2 LP	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")))
40473a70 LP	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	123	static inline size_t ALIGN_TO(size_t l, size_t ali) {
37f85e66	124	return ((l + ali - 1) & ~(ali - 1));
22be093f LP	125	}
22be093f LP	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) */
	130	static 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
963c6c90 ZJS	142	#ifndef __COVERITY__
	143	# define VOID_0 ((void)0)
	144	#else
	145	# define VOID_0 ((void*)0)
	146	#endif
	147
7f39a210 MS	148	#define ELEMENTSOF(x) \
	149	__extension__ (__builtin_choose_expr( \
	150	!__builtin_types_compatible_p(typeof(x), typeof(&*(x))), \
	151	sizeof(x)/sizeof((x)[0]), \
963c6c90	152	VOID_0))
6febe75d TH	153
	154	/*
	155	* STRLEN - return the length of a string literal, minus the trailing NUL byte.
	156	* Contrary to strlen(), this is a constant expression.
	157	* @x: a string literal.
	158	*/
	159	#define STRLEN(x) (sizeof(""x"") - 1)
	160
bbc98d32 KS	161	/*
	162	* container_of - cast a member of a structure out to the containing structure
	163	* @ptr: the pointer to the member.
	164	* @type: the type of the container struct this is embedded in.
	165	* @member: the name of the member within the struct.
bbc98d32	166	*/
fb835651 DH	167	#define container_of(ptr, type, member) __container_of(UNIQ, (ptr), type, member)
fb835651 DH	168	#define __container_of(uniq, ptr, type, member) \
fa70beaa	169	__extension__ ({ \
fb835651 DH	170	const typeof( ((type)0)->member ) UNIQ_T(A, uniq) = (ptr); \
	171	(type)( (char )UNIQ_T(A, uniq) - offsetof(type,member) ); \
	172	})
bbc98d32	173
9607d947	174	#undef MAX
667a0377 DH	175	#define MAX(a, b) __MAX(UNIQ, (a), UNIQ, (b))
667a0377 DH	176	#define __MAX(aq, a, bq, b) \
fdcba430	177	__extension__ ({ \
667a0377 DH	178	const typeof(a) UNIQ_T(A, aq) = (a); \
	179	const typeof(b) UNIQ_T(B, bq) = (b); \
	180	UNIQ_T(A,aq) > UNIQ_T(B,bq) ? UNIQ_T(A,aq) : UNIQ_T(B,bq); \
	181	})
60918275	182
7242d742 DH	183	/* evaluates to (void) if _A or _B are not constant or of different types */
	184	#define CONST_MAX(_A, _B) \
	185	__extension__ (__builtin_choose_expr( \
	186	__builtin_constant_p(_A) && \
	187	__builtin_constant_p(_B) && \
	188	__builtin_types_compatible_p(typeof(_A), typeof(_B)), \
	189	((_A) > (_B)) ? (_A) : (_B), \
963c6c90	190	VOID_0))
7242d742	191
40a1eebd DH	192	/* takes two types and returns the size of the larger one */
	193	#define MAXSIZE(A, B) (sizeof(union _packed_ { typeof(A) a; typeof(B) b; }))
	194
fdcba430 DH	195	#define MAX3(x,y,z) \
	196	__extension__ ({ \
	197	const typeof(x) _c = MAX(x,y); \
	198	MAX(_c, z); \
9607d947	199	})
3b63d2d3	200
9607d947	201	#undef MIN
667a0377 DH	202	#define MIN(a, b) __MIN(UNIQ, (a), UNIQ, (b))
667a0377 DH	203	#define __MIN(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); \
	208	})
60918275	209
fdcba430 DH	210	#define MIN3(x,y,z) \
	211	__extension__ ({ \
	212	const typeof(x) _c = MIN(x,y); \
	213	MIN(_c, z); \
7df23077 DH	214	})
7df23077 DH	215
667a0377 DH	216	#define LESS_BY(a, b) __LESS_BY(UNIQ, (a), UNIQ, (b))
667a0377 DH	217	#define __LESS_BY(aq, a, bq, b) \
fdcba430	218	__extension__ ({ \
667a0377 DH	219	const typeof(a) UNIQ_T(A, aq) = (a); \
	220	const typeof(b) UNIQ_T(B, bq) = (b); \
	221	UNIQ_T(A,aq) > UNIQ_T(B,bq) ? UNIQ_T(A,aq) - UNIQ_T(B,bq) : 0; \
	222	})
348ced90	223
667a0377 DH	224	#undef CLAMP
	225	#define CLAMP(x, low, high) __CLAMP(UNIQ, (x), UNIQ, (low), UNIQ, (high))
	226	#define __CLAMP(xq, x, lowq, low, highq, high) \
60918275	227	__extension__ ({ \
667a0377 DH	228	const typeof(x) UNIQ_T(X,xq) = (x); \
	229	const typeof(low) UNIQ_T(LOW,lowq) = (low); \
	230	const typeof(high) UNIQ_T(HIGH,highq) = (high); \
	231	UNIQ_T(X,xq) > UNIQ_T(HIGH,highq) ? \
	232	UNIQ_T(HIGH,highq) : \
	233	UNIQ_T(X,xq) < UNIQ_T(LOW,lowq) ? \
	234	UNIQ_T(LOW,lowq) : \
	235	UNIQ_T(X,xq); \
	236	})
60918275	237
180a60bc DH	238	/* [(x + y - 1) / y] suffers from an integer overflow, even though the
	239	* computation should be possible in the given type. Therefore, we use
	240	* [x / y + !!(x % y)]. Note that on "Real CPUs" a division returns both the
	241	* quotient and the remainder, so both should be equally fast. */
	242	#define DIV_ROUND_UP(_x, _y) \
	243	__extension__ ({ \
	244	const typeof(_x) __x = (_x); \
	245	const typeof(_y) __y = (_y); \
	246	(__x / __y + !!(__x % __y)); \
	247	})
	248
34c38d2a	249	#define assert_message_se(expr, message) \
dd8f71ee	250	do { \
93a46b0b	251	if (_unlikely_(!(expr))) \
34c38d2a MS	252	log_assert_failed(message, __FILE__, __LINE__, __PRETTY_FUNCTION__); \
	253	} while (false)
	254
	255	#define assert_se(expr) assert_message_se(expr, #expr)
dd8f71ee LP	256
	257	/* We override the glibc assert() here. */
	258	#undef assert
	259	#ifdef NDEBUG
9ed794a3	260	#define assert(expr) do {} while (false)
dd8f71ee	261	#else
34c38d2a	262	#define assert(expr) assert_message_se(expr, #expr)
dd8f71ee	263	#endif
60918275	264
dd8f71ee LP	265	#define assert_not_reached(t) \
dd8f71ee LP	266	do { \
b7f33638	267	log_assert_failed_unreachable(t, __FILE__, __LINE__, __PRETTY_FUNCTION__); \
dd8f71ee	268	} while (false)
60918275	269
f791c684	270	#if defined(static_assert)
7ebe131a LP	271	/* static_assert() is sometimes defined in a way that trips up
	272	* -Wdeclaration-after-statement, hence let's temporarily turn off
	273	* this warning around it. */
	274	#define assert_cc(expr) \
	275	DISABLE_WARNING_DECLARATION_AFTER_STATEMENT; \
	276	static_assert(expr, #expr); \
	277	REENABLE_WARNING
f791c684	278	#else
7ebe131a LP	279	#define assert_cc(expr) \
7ebe131a LP	280	DISABLE_WARNING_DECLARATION_AFTER_STATEMENT; \
6825a04d	281	struct CONCATENATE(_assert_struct_, __COUNTER__) { \
7ebe131a LP	282	char x[(expr) ? 0 : -1]; \
	283	}; \
	284	REENABLE_WARNING
f791c684	285	#endif
60918275	286
34c38d2a MS	287	#define assert_log(expr, message) ((_likely_(expr)) \
	288	? (true) \
	289	: (log_assert_failed_return(message, __FILE__, __LINE__, __PRETTY_FUNCTION__), false))
366e6411	290
80514f9c LP	291	#define assert_return(expr, r) \
80514f9c LP	292	do { \
34c38d2a	293	if (!assert_log(expr, #expr)) \
80514f9c	294	return (r); \
18387b59 LP	295	} while (false)
18387b59 LP	296
aa029628 TG	297	#define assert_return_errno(expr, r, err) \
aa029628 TG	298	do { \
34c38d2a	299	if (!assert_log(expr, #expr)) { \
aa029628 TG	300	errno = err; \
	301	return (r); \
	302	} \
	303	} while (false)
	304
a3dc3547 KS	305	#define PTR_TO_INT(p) ((int) ((intptr_t) (p)))
a3dc3547 KS	306	#define INT_TO_PTR(u) ((void *) ((intptr_t) (u)))
60918275	307	#define PTR_TO_UINT(p) ((unsigned int) ((uintptr_t) (p)))
a3dc3547	308	#define UINT_TO_PTR(u) ((void *) ((uintptr_t) (u)))
60918275	309
a3dc3547 KS	310	#define PTR_TO_LONG(p) ((long) ((intptr_t) (p)))
a3dc3547 KS	311	#define LONG_TO_PTR(u) ((void *) ((intptr_t) (u)))
c6c18be3	312	#define PTR_TO_ULONG(p) ((unsigned long) ((uintptr_t) (p)))
a3dc3547	313	#define ULONG_TO_PTR(u) ((void *) ((uintptr_t) (u)))
c6c18be3	314
a3dc3547 KS	315	#define PTR_TO_INT32(p) ((int32_t) ((intptr_t) (p)))
	316	#define INT32_TO_PTR(u) ((void *) ((intptr_t) (u)))
	317	#define PTR_TO_UINT32(p) ((uint32_t) ((uintptr_t) (p)))
	318	#define UINT32_TO_PTR(u) ((void *) ((uintptr_t) (u)))
60918275	319
a3dc3547 KS	320	#define PTR_TO_INT64(p) ((int64_t) ((intptr_t) (p)))
	321	#define INT64_TO_PTR(u) ((void *) ((intptr_t) (u)))
	322	#define PTR_TO_UINT64(p) ((uint64_t) ((uintptr_t) (p)))
	323	#define UINT64_TO_PTR(u) ((void *) ((uintptr_t) (u)))
c6c18be3	324
74b2466e LP	325	#define PTR_TO_SIZE(p) ((size_t) ((uintptr_t) (p)))
	326	#define SIZE_TO_PTR(u) ((void *) ((uintptr_t) (u)))
	327
a9c55a88 LP	328	#define CHAR_TO_STR(x) ((char[2]) { x, 0 })
a9c55a88 LP	329
034c6ed7 LP	330	#define char_array_0(x) x[sizeof(x)-1] = 0;
034c6ed7 LP	331
fa70beaa LP	332	/* Returns the number of chars needed to format variables of the
fa70beaa LP	333	* specified type as a decimal string. Adds in extra space for a
b7ce6b59 LP	334	* negative '-' prefix (hence works correctly on signed
b7ce6b59 LP	335	* types). Includes space for the trailing NUL. */
fa70beaa	336	#define DECIMAL_STR_MAX(type) \
5bcb0f2b	337	(2+(sizeof(type) <= 1 ? 3 : \
fa70beaa LP	338	sizeof(type) <= 2 ? 5 : \
	339	sizeof(type) <= 4 ? 10 : \
	340	sizeof(type) <= 8 ? 20 : sizeof(int[-2*(sizeof(type) > 8)])))
	341
0d1dbeb3 LP	342	#define DECIMAL_STR_WIDTH(x) \
	343	({ \
	344	typeof(x) _x_ = (x); \
	345	unsigned ans = 1; \
	346	while (_x_ /= 10) \
	347	ans++; \
	348	ans; \
	349	})
	350
264ad849 LP	351	#define SET_FLAG(v, flag, b) \
	352	(v) = (b) ? ((v) \| (flag)) : ((v) & ~(flag))
	353
d5b26d50 DM	354	#define CASE_F(X) case X:
	355	#define CASE_F_1(CASE, X) CASE_F(X)
	356	#define CASE_F_2(CASE, X, ...) CASE(X) CASE_F_1(CASE, __VA_ARGS__)
	357	#define CASE_F_3(CASE, X, ...) CASE(X) CASE_F_2(CASE, __VA_ARGS__)
	358	#define CASE_F_4(CASE, X, ...) CASE(X) CASE_F_3(CASE, __VA_ARGS__)
	359	#define CASE_F_5(CASE, X, ...) CASE(X) CASE_F_4(CASE, __VA_ARGS__)
	360	#define CASE_F_6(CASE, X, ...) CASE(X) CASE_F_5(CASE, __VA_ARGS__)
	361	#define CASE_F_7(CASE, X, ...) CASE(X) CASE_F_6(CASE, __VA_ARGS__)
	362	#define CASE_F_8(CASE, X, ...) CASE(X) CASE_F_7(CASE, __VA_ARGS__)
	363	#define CASE_F_9(CASE, X, ...) CASE(X) CASE_F_8(CASE, __VA_ARGS__)
	364	#define CASE_F_10(CASE, X, ...) CASE(X) CASE_F_9(CASE, __VA_ARGS__)
	365	#define CASE_F_11(CASE, X, ...) CASE(X) CASE_F_10(CASE, __VA_ARGS__)
	366	#define CASE_F_12(CASE, X, ...) CASE(X) CASE_F_11(CASE, __VA_ARGS__)
	367	#define CASE_F_13(CASE, X, ...) CASE(X) CASE_F_12(CASE, __VA_ARGS__)
	368	#define CASE_F_14(CASE, X, ...) CASE(X) CASE_F_13(CASE, __VA_ARGS__)
	369	#define CASE_F_15(CASE, X, ...) CASE(X) CASE_F_14(CASE, __VA_ARGS__)
	370	#define CASE_F_16(CASE, X, ...) CASE(X) CASE_F_15(CASE, __VA_ARGS__)
	371	#define CASE_F_17(CASE, X, ...) CASE(X) CASE_F_16(CASE, __VA_ARGS__)
	372	#define CASE_F_18(CASE, X, ...) CASE(X) CASE_F_17(CASE, __VA_ARGS__)
	373	#define CASE_F_19(CASE, X, ...) CASE(X) CASE_F_18(CASE, __VA_ARGS__)
	374	#define CASE_F_20(CASE, X, ...) CASE(X) CASE_F_19(CASE, __VA_ARGS__)
	375
	376	#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
	377	#define FOR_EACH_MAKE_CASE(...) \
	378	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, \
	379	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) \
	380	(CASE_F,__VA_ARGS__)
	381
	382	#define IN_SET(x, ...) \
	383	({ \
	384	bool _found = false; \
	385	/* If the build breaks in the line below, you need to extend the case macros */ \
	386	static _unused_ char _static_assert__macros_need_to_be_extended[20 - sizeof((int[]){__VA_ARGS__})/sizeof(int)]; \
	387	switch(x) { \
	388	FOR_EACH_MAKE_CASE(__VA_ARGS__) \
	389	_found = true; \
	390	break; \
	391	default: \
	392	break; \
	393	} \
	394	_found; \
cabb7806 LP	395	})
cabb7806 LP	396
35aa04e9 LP	397	#define SWAP_TWO(x, y) do { \
	398	typeof(x) _t = (x); \
	399	(x) = (y); \
	400	(y) = (_t); \
	401	} while (false)
	402
919ce0b7 SL	403	/* Define C11 thread_local attribute even on older gcc compiler
919ce0b7 SL	404	* version */
ec202eae SL	405	#ifndef thread_local
	406	/*
	407	* Don't break on glibc < 2.16 that doesn't define __STDC_NO_THREADS__
	408	* see http://gcc.gnu.org/bugzilla/show_bug.cgi?id=53769
	409	*/
	410	#if __STDC_VERSION__ >= 201112L && !(defined(__STDC_NO_THREADS__) \|\| (defined(__GNU_LIBRARY__) && __GLIBC__ == 2 && __GLIBC_MINOR__ < 16))
	411	#define thread_local _Thread_local
	412	#else
	413	#define thread_local __thread
	414	#endif
	415	#endif
cabb7806	416
919ce0b7 SL	417	/* Define C11 noreturn without <stdnoreturn.h> and even on older gcc
	418	* compiler versions */
	419	#ifndef noreturn
	420	#if __STDC_VERSION__ >= 201112L
	421	#define noreturn _Noreturn
	422	#else
	423	#define noreturn __attribute__((noreturn))
	424	#endif
	425	#endif
	426
a2341f68 ZJS	427	#define DEFINE_TRIVIAL_CLEANUP_FUNC(type, func) \
	428	static inline void func##p(type *p) { \
	429	if (*p) \
	430	func(*p); \
f6a8265b	431	}
a2341f68	432
dd8f71ee	433	#include "log.h"