[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)))

/* 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));
}

#define ELEMENTSOF(x)                                                    \
        __extension__ (__builtin_choose_expr(                            \
                !__builtin_types_compatible_p(typeof(x), typeof(&*(x))), \
                sizeof(x)/sizeof((x)[0]),                                \
                (void)0))
/*
 * 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);                               \
        }                                                       \
        struct __useless_struct_to_allow_trailing_semicolon__

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