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

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