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

/*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/

#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 <assert.h>
#include <sys/param.h>
#include <sys/types.h>
#include <sys/uio.h>
#include <inttypes.h>

#define _printf_(a,b) __attribute__ ((format (printf, a, b)))
#define _alloc_(...) __attribute__ ((alloc_size(__VA_ARGS__)))
#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 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__

/* 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) (sizeof(x)/sizeof((x)[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_se(expr)                                                 \
        do {                                                            \
                if (_unlikely_(!(expr)))                                \
                        log_assert_failed(#expr, __FILE__, __LINE__, __PRETTY_FUNCTION__); \
        } while (false)                                                 \

/* We override the glibc assert() here. */
#undef assert
#ifdef NDEBUG
#define assert(expr) do {} while(false)
#else
#define assert(expr) assert_se(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_return(expr, r)                                          \
        do {                                                            \
                if (_unlikely_(!(expr))) {                              \
                        log_assert_failed_return(#expr, __FILE__, __LINE__, __PRETTY_FUNCTION__); \
                        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)))

/* The following macros add 1 when converting things, since UID 0 is a
 * valid UID, while the pointer NULL is special */
#define PTR_TO_UID(p) ((uid_t) (((uintptr_t) (p))-1))
#define UID_TO_PTR(u) ((void*) (((uintptr_t) (u))+1))

#define PTR_TO_GID(p) ((gid_t) (((uintptr_t) (p))-1))
#define GID_TO_PTR(u) ((void*) (((uintptr_t) (u))+1))

#define memzero(x,l) (memset((x), 0, (l)))
#define zero(x) (memzero(&(x), sizeof(x)))

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

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

#define IOVEC_SET_STRING(i, s)                  \
        do {                                    \
                struct iovec *_i = &(i);        \
                char *_s = (char *)(s);         \
                _i->iov_base = _s;              \
                _i->iov_len = strlen(_s);       \
        } while(false)

static inline size_t IOVEC_TOTAL_SIZE(const struct iovec *i, unsigned n) {
        unsigned j;
        size_t r = 0;

        for (j = 0; j < n; j++)
                r += i[j].iov_len;

        return r;
}

static inline size_t IOVEC_INCREMENT(struct iovec *i, unsigned n, size_t k) {
        unsigned j;

        for (j = 0; j < n; j++) {
                size_t sub;

                if (_unlikely_(k <= 0))
                        break;

                sub = MIN(i[j].iov_len, k);
                i[j].iov_len -= sub;
                i[j].iov_base = (uint8_t*) i[j].iov_base + sub;
                k -= sub;
        }

        return k;
}

#define VA_FORMAT_ADVANCE(format, ap)                                   \
do {                                                                    \
        int _argtypes[128];                                             \
        size_t _i, _k;                                                  \
        _k = parse_printf_format((format), ELEMENTSOF(_argtypes), _argtypes); \
        assert(_k < ELEMENTSOF(_argtypes));                             \
        for (_i = 0; _i < _k; _i++) {                                   \
                if (_argtypes[_i] & PA_FLAG_PTR)  {                     \
                        (void) va_arg(ap, void*);                       \
                        continue;                                       \
                }                                                       \
                                                                        \
                switch (_argtypes[_i]) {                                \
                case PA_INT:                                            \
                case PA_INT|PA_FLAG_SHORT:                              \
                case PA_CHAR:                                           \
                        (void) va_arg(ap, int);                         \
                        break;                                          \
                case PA_INT|PA_FLAG_LONG:                               \
                        (void) va_arg(ap, long int);                    \
                        break;                                          \
                case PA_INT|PA_FLAG_LONG_LONG:                          \
                        (void) va_arg(ap, long long int);               \
                        break;                                          \
                case PA_WCHAR:                                          \
                        (void) va_arg(ap, wchar_t);                     \
                        break;                                          \
                case PA_WSTRING:                                        \
                case PA_STRING:                                         \
                case PA_POINTER:                                        \
                        (void) va_arg(ap, void*);                       \
                        break;                                          \
                case PA_FLOAT:                                          \
                case PA_DOUBLE:                                         \
                        (void) va_arg(ap, double);                      \
                        break;                                          \
                case PA_DOUBLE|PA_FLAG_LONG_DOUBLE:                     \
                        (void) va_arg(ap, long double);                 \
                        break;                                          \
                default:                                                \
                        assert_not_reached("Unknown format string argument."); \
                }                                                       \
        }                                                               \
} while(false)

 /* Because statfs.t_type can be int on some architectures, we have to cast
  * the const magic to the type, otherwise the compiler warns about
  * signed/unsigned comparison, because the magic can be 32 bit unsigned.
 */
#define F_TYPE_EQUAL(a, b) (a == (typeof(a)) b)

/* 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. */
#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 SET_FLAG(v, flag, b) \
        (v) = (b) ? ((v) | (flag)) : ((v) & ~(flag))

#define IN_SET(x, y, ...)                                               \
        ({                                                              \
                const typeof(y) _y = (y);                               \
                const typeof(_y) _x = (x);                              \
                unsigned _i;                                            \
                bool _found = false;                                    \
                for (_i = 0; _i < 1 + sizeof((const typeof(_x)[]) { __VA_ARGS__ })/sizeof(const typeof(_x)); _i++) \
                        if (((const typeof(_x)[]) { _y, __VA_ARGS__ })[_i] == _x) { \
                                _found = true;                          \
                                break;                                  \
                        }                                               \
                _found;                                                 \
        })

/* Return a nulstr for a standard cascade of configuration directories,
 * suitable to pass to conf_files_list_nulstr or config_parse_many. */
#define CONF_DIRS_NULSTR(n) \
        "/etc/" n ".d\0" \
        "/run/" n ".d\0" \
        "/usr/local/lib/" n ".d\0" \
        "/usr/lib/" n ".d\0" \
        CONF_DIR_SPLIT_USR(n)

#ifdef HAVE_SPLIT_USR
#define CONF_DIR_SPLIT_USR(n) "/lib/" n ".d\0"
#else
#define CONF_DIR_SPLIT_USR(n)
#endif

/* 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 UID_INVALID ((uid_t) -1)
#define GID_INVALID ((gid_t) -1)
#define MODE_INVALID ((mode_t) -1)

#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
03467c88	1	/-- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil --/
60918275	2
c2f1db8f	3	#pragma once
60918275	4
a7334b09 LP	5	/***
	6	This file is part of systemd.
	7
	8	Copyright 2010 Lennart Poettering
	9
	10	systemd is free software; you can redistribute it and/or modify it
5430f7f2 LP	11	under the terms of the GNU Lesser General Public License as published by
5430f7f2 LP	12	the Free Software Foundation; either version 2.1 of the License, or
a7334b09 LP	13	(at your option) any later version.
	14
	15	systemd is distributed in the hope that it will be useful, but
	16	WITHOUT ANY WARRANTY; without even the implied warranty of
	17	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5430f7f2	18	Lesser General Public License for more details.
a7334b09	19
5430f7f2	20	You should have received a copy of the GNU Lesser General Public License
a7334b09 LP	21	along with systemd; If not, see <http://www.gnu.org/licenses/>.
	22	***/
	23
60918275	24	#include <assert.h>
6a39419f	25	#include <sys/param.h>
60918275	26	#include <sys/types.h>
c31e1495 LP	27	#include <sys/uio.h>
c31e1495 LP	28	#include <inttypes.h>
60918275	29
44b601bc	30	#define _printf_(a,b) __attribute__ ((format (printf, a, b)))
750ef272	31	#define _alloc_(...) __attribute__ ((alloc_size(__VA_ARGS__)))
93a46b0b	32	#define _sentinel_ __attribute__ ((sentinel))
93a46b0b LP	33	#define _unused_ __attribute__ ((unused))
	34	#define _destructor_ __attribute__ ((destructor))
	35	#define _pure_ __attribute__ ((pure))
	36	#define _const_ __attribute__ ((const))
	37	#define _deprecated_ __attribute__ ((deprecated))
	38	#define _packed_ __attribute__ ((packed))
	39	#define _malloc_ __attribute__ ((malloc))
	40	#define _weak_ __attribute__ ((weak))
	41	#define _likely_(x) (__builtin_expect(!!(x),1))
	42	#define _unlikely_(x) (__builtin_expect(!!(x),0))
40473a70 LP	43	#define _public_ __attribute__ ((visibility("default")))
40473a70 LP	44	#define _hidden_ __attribute__ ((visibility("hidden")))
ad780f19	45	#define _weakref_(x) __attribute__((weakref(#x)))
19d1e4ee	46	#define _alignas_(x) __attribute__((aligned(__alignof(x))))
dfb33a97	47	#define _cleanup_(x) __attribute__((cleanup(x)))
60918275	48
7ebe131a LP	49	/* Temporarily disable some warnings */
	50	#define DISABLE_WARNING_DECLARATION_AFTER_STATEMENT \
	51	_Pragma("GCC diagnostic push"); \
	52	_Pragma("GCC diagnostic ignored \"-Wdeclaration-after-statement\"")
	53
bcfce235 LP	54	#define DISABLE_WARNING_FORMAT_NONLITERAL \
	55	_Pragma("GCC diagnostic push"); \
	56	_Pragma("GCC diagnostic ignored \"-Wformat-nonliteral\"")
	57
f0f2e63b LP	58	#define DISABLE_WARNING_MISSING_PROTOTYPES \
	59	_Pragma("GCC diagnostic push"); \
	60	_Pragma("GCC diagnostic ignored \"-Wmissing-prototypes\"")
	61
8fca4e30 LP	62	#define DISABLE_WARNING_NONNULL \
	63	_Pragma("GCC diagnostic push"); \
	64	_Pragma("GCC diagnostic ignored \"-Wnonnull\"")
	65
d442e2ec DH	66	#define DISABLE_WARNING_SHADOW \
	67	_Pragma("GCC diagnostic push"); \
	68	_Pragma("GCC diagnostic ignored \"-Wshadow\"")
	69
7ebe131a LP	70	#define REENABLE_WARNING \
	71	_Pragma("GCC diagnostic pop")
	72
49e5de64 ZJS	73	/* automake test harness */
	74	#define EXIT_TEST_SKIP 77
	75
bef2733f LP	76	#define XSTRINGIFY(x) #x
	77	#define STRINGIFY(x) XSTRINGIFY(x)
	78
ab9cbe34 LS	79	#define XCONCATENATE(x, y) x ## y
	80	#define CONCATENATE(x, y) XCONCATENATE(x, y)
	81
fb835651 DH	82	#define UNIQ_T(x, uniq) CONCATENATE(__unique_prefix_, CONCATENATE(x, uniq))
	83	#define UNIQ __COUNTER__
	84
60918275	85	/* Rounds up */
9be9c7cf LP	86
	87	#define ALIGN4(l) (((l) + 3) & ~3)
	88	#define ALIGN8(l) (((l) + 7) & ~7)
	89
	90	#if __SIZEOF_POINTER__ == 8
	91	#define ALIGN(l) ALIGN8(l)
	92	#elif __SIZEOF_POINTER__ == 4
	93	#define ALIGN(l) ALIGN4(l)
	94	#else
	95	#error "Wut? Pointers are neither 4 nor 8 bytes long?"
	96	#endif
	97
5f86c1f4 LP	98	#define ALIGN_PTR(p) ((void*) ALIGN((unsigned long) (p)))
	99	#define ALIGN4_PTR(p) ((void*) ALIGN4((unsigned long) (p)))
	100	#define ALIGN8_PTR(p) ((void*) ALIGN8((unsigned long) (p)))
e86b80b8	101
37f85e66	102	static inline size_t ALIGN_TO(size_t l, size_t ali) {
37f85e66	103	return ((l + ali - 1) & ~(ali - 1));
22be093f LP	104	}
22be093f LP	105
5f86c1f4	106	#define ALIGN_TO_PTR(p, ali) ((void*) ALIGN_TO((unsigned long) (p), (ali)))
49aa47c7	107
625e870b DH	108	/* align to next higher power-of-2 (except for: 0 => 0, overflow => 0) */
	109	static inline unsigned long ALIGN_POWER2(unsigned long u) {
	110	/* clz(0) is undefined */
	111	if (u == 1)
	112	return 1;
	113
	114	/* left-shift overflow is undefined */
	115	if (__builtin_clzl(u - 1UL) < 1)
	116	return 0;
	117
	118	return 1UL << (sizeof(u) * 8 - __builtin_clzl(u - 1UL));
	119	}
	120
60918275 LP	121	#define ELEMENTSOF(x) (sizeof(x)/sizeof((x)[0]))
60918275 LP	122
bbc98d32 KS	123	/*
	124	* container_of - cast a member of a structure out to the containing structure
	125	* @ptr: the pointer to the member.
	126	* @type: the type of the container struct this is embedded in.
	127	* @member: the name of the member within the struct.
bbc98d32	128	*/
fb835651 DH	129	#define container_of(ptr, type, member) __container_of(UNIQ, (ptr), type, member)
fb835651 DH	130	#define __container_of(uniq, ptr, type, member) \
fa70beaa	131	__extension__ ({ \
fb835651 DH	132	const typeof( ((type)0)->member ) UNIQ_T(A, uniq) = (ptr); \
	133	(type)( (char )UNIQ_T(A, uniq) - offsetof(type,member) ); \
	134	})
bbc98d32	135
9607d947	136	#undef MAX
667a0377 DH	137	#define MAX(a, b) __MAX(UNIQ, (a), UNIQ, (b))
667a0377 DH	138	#define __MAX(aq, a, bq, b) \
fdcba430	139	__extension__ ({ \
667a0377 DH	140	const typeof(a) UNIQ_T(A, aq) = (a); \
	141	const typeof(b) UNIQ_T(B, bq) = (b); \
	142	UNIQ_T(A,aq) > UNIQ_T(B,bq) ? UNIQ_T(A,aq) : UNIQ_T(B,bq); \
	143	})
60918275	144
7242d742 DH	145	/* evaluates to (void) if _A or _B are not constant or of different types */
	146	#define CONST_MAX(_A, _B) \
	147	__extension__ (__builtin_choose_expr( \
	148	__builtin_constant_p(_A) && \
	149	__builtin_constant_p(_B) && \
	150	__builtin_types_compatible_p(typeof(_A), typeof(_B)), \
	151	((_A) > (_B)) ? (_A) : (_B), \
	152	(void)0))
	153
40a1eebd DH	154	/* takes two types and returns the size of the larger one */
	155	#define MAXSIZE(A, B) (sizeof(union _packed_ { typeof(A) a; typeof(B) b; }))
	156
fdcba430 DH	157	#define MAX3(x,y,z) \
	158	__extension__ ({ \
	159	const typeof(x) _c = MAX(x,y); \
	160	MAX(_c, z); \
9607d947	161	})
3b63d2d3	162
9607d947	163	#undef MIN
667a0377 DH	164	#define MIN(a, b) __MIN(UNIQ, (a), UNIQ, (b))
667a0377 DH	165	#define __MIN(aq, a, bq, b) \
fdcba430	166	__extension__ ({ \
667a0377 DH	167	const typeof(a) UNIQ_T(A, aq) = (a); \
	168	const typeof(b) UNIQ_T(B, bq) = (b); \
	169	UNIQ_T(A,aq) < UNIQ_T(B,bq) ? UNIQ_T(A,aq) : UNIQ_T(B,bq); \
	170	})
60918275	171
fdcba430 DH	172	#define MIN3(x,y,z) \
	173	__extension__ ({ \
	174	const typeof(x) _c = MIN(x,y); \
	175	MIN(_c, z); \
7df23077 DH	176	})
7df23077 DH	177
667a0377 DH	178	#define LESS_BY(a, b) __LESS_BY(UNIQ, (a), UNIQ, (b))
667a0377 DH	179	#define __LESS_BY(aq, a, bq, b) \
fdcba430	180	__extension__ ({ \
667a0377 DH	181	const typeof(a) UNIQ_T(A, aq) = (a); \
	182	const typeof(b) UNIQ_T(B, bq) = (b); \
	183	UNIQ_T(A,aq) > UNIQ_T(B,bq) ? UNIQ_T(A,aq) - UNIQ_T(B,bq) : 0; \
	184	})
348ced90	185
667a0377 DH	186	#undef CLAMP
	187	#define CLAMP(x, low, high) __CLAMP(UNIQ, (x), UNIQ, (low), UNIQ, (high))
	188	#define __CLAMP(xq, x, lowq, low, highq, high) \
60918275	189	__extension__ ({ \
667a0377 DH	190	const typeof(x) UNIQ_T(X,xq) = (x); \
	191	const typeof(low) UNIQ_T(LOW,lowq) = (low); \
	192	const typeof(high) UNIQ_T(HIGH,highq) = (high); \
	193	UNIQ_T(X,xq) > UNIQ_T(HIGH,highq) ? \
	194	UNIQ_T(HIGH,highq) : \
	195	UNIQ_T(X,xq) < UNIQ_T(LOW,lowq) ? \
	196	UNIQ_T(LOW,lowq) : \
	197	UNIQ_T(X,xq); \
	198	})
60918275	199
180a60bc DH	200	/* [(x + y - 1) / y] suffers from an integer overflow, even though the
	201	* computation should be possible in the given type. Therefore, we use
	202	* [x / y + !!(x % y)]. Note that on "Real CPUs" a division returns both the
	203	* quotient and the remainder, so both should be equally fast. */
	204	#define DIV_ROUND_UP(_x, _y) \
	205	__extension__ ({ \
	206	const typeof(_x) __x = (_x); \
	207	const typeof(_y) __y = (_y); \
	208	(__x / __y + !!(__x % __y)); \
	209	})
	210
dd8f71ee LP	211	#define assert_se(expr) \
dd8f71ee LP	212	do { \
93a46b0b	213	if (_unlikely_(!(expr))) \
b7f33638	214	log_assert_failed(#expr, __FILE__, __LINE__, __PRETTY_FUNCTION__); \
dd8f71ee LP	215	} while (false) \
	216
	217	/* We override the glibc assert() here. */
	218	#undef assert
	219	#ifdef NDEBUG
	220	#define assert(expr) do {} while(false)
	221	#else
	222	#define assert(expr) assert_se(expr)
	223	#endif
60918275	224
dd8f71ee LP	225	#define assert_not_reached(t) \
dd8f71ee LP	226	do { \
b7f33638	227	log_assert_failed_unreachable(t, __FILE__, __LINE__, __PRETTY_FUNCTION__); \
dd8f71ee	228	} while (false)
60918275	229
f791c684	230	#if defined(static_assert)
7ebe131a LP	231	/* static_assert() is sometimes defined in a way that trips up
	232	* -Wdeclaration-after-statement, hence let's temporarily turn off
	233	* this warning around it. */
	234	#define assert_cc(expr) \
	235	DISABLE_WARNING_DECLARATION_AFTER_STATEMENT; \
	236	static_assert(expr, #expr); \
	237	REENABLE_WARNING
f791c684	238	#else
7ebe131a LP	239	#define assert_cc(expr) \
7ebe131a LP	240	DISABLE_WARNING_DECLARATION_AFTER_STATEMENT; \
6825a04d	241	struct CONCATENATE(_assert_struct_, __COUNTER__) { \
7ebe131a LP	242	char x[(expr) ? 0 : -1]; \
	243	}; \
	244	REENABLE_WARNING
f791c684	245	#endif
60918275	246
80514f9c LP	247	#define assert_return(expr, r) \
	248	do { \
	249	if (_unlikely_(!(expr))) { \
	250	log_assert_failed_return(#expr, __FILE__, __LINE__, __PRETTY_FUNCTION__); \
	251	return (r); \
	252	} \
18387b59 LP	253	} while (false)
18387b59 LP	254
a3dc3547 KS	255	#define PTR_TO_INT(p) ((int) ((intptr_t) (p)))
a3dc3547 KS	256	#define INT_TO_PTR(u) ((void *) ((intptr_t) (u)))
60918275	257	#define PTR_TO_UINT(p) ((unsigned int) ((uintptr_t) (p)))
a3dc3547	258	#define UINT_TO_PTR(u) ((void *) ((uintptr_t) (u)))
60918275	259
a3dc3547 KS	260	#define PTR_TO_LONG(p) ((long) ((intptr_t) (p)))
a3dc3547 KS	261	#define LONG_TO_PTR(u) ((void *) ((intptr_t) (u)))
c6c18be3	262	#define PTR_TO_ULONG(p) ((unsigned long) ((uintptr_t) (p)))
a3dc3547	263	#define ULONG_TO_PTR(u) ((void *) ((uintptr_t) (u)))
c6c18be3	264
a3dc3547 KS	265	#define PTR_TO_INT32(p) ((int32_t) ((intptr_t) (p)))
	266	#define INT32_TO_PTR(u) ((void *) ((intptr_t) (u)))
	267	#define PTR_TO_UINT32(p) ((uint32_t) ((uintptr_t) (p)))
	268	#define UINT32_TO_PTR(u) ((void *) ((uintptr_t) (u)))
60918275	269
a3dc3547 KS	270	#define PTR_TO_INT64(p) ((int64_t) ((intptr_t) (p)))
	271	#define INT64_TO_PTR(u) ((void *) ((intptr_t) (u)))
	272	#define PTR_TO_UINT64(p) ((uint64_t) ((uintptr_t) (p)))
	273	#define UINT64_TO_PTR(u) ((void *) ((uintptr_t) (u)))
c6c18be3	274
74b2466e LP	275	#define PTR_TO_SIZE(p) ((size_t) ((uintptr_t) (p)))
	276	#define SIZE_TO_PTR(u) ((void *) ((uintptr_t) (u)))
	277
8cb4ab00 LP	278	/* The following macros add 1 when converting things, since UID 0 is a
	279	* valid UID, while the pointer NULL is special */
	280	#define PTR_TO_UID(p) ((uid_t) (((uintptr_t) (p))-1))
	281	#define UID_TO_PTR(u) ((void*) (((uintptr_t) (u))+1))
	282
	283	#define PTR_TO_GID(p) ((gid_t) (((uintptr_t) (p))-1))
	284	#define GID_TO_PTR(u) ((void*) (((uintptr_t) (u))+1))
	285
476fe607 LP	286	#define memzero(x,l) (memset((x), 0, (l)))
	287	#define zero(x) (memzero(&(x), sizeof(x)))
	288
a9c55a88 LP	289	#define CHAR_TO_STR(x) ((char[2]) { x, 0 })
a9c55a88 LP	290
034c6ed7 LP	291	#define char_array_0(x) x[sizeof(x)-1] = 0;
034c6ed7 LP	292
bff7c062	293	#define IOVEC_SET_STRING(i, s) \
2fa086a8	294	do { \
bff7c062 LP	295	struct iovec *_i = &(i); \
	296	char _s = (char )(s); \
	297	_i->iov_base = _s; \
	298	_i->iov_len = strlen(_s); \
9b3c575e	299	} while(false)
2fa086a8	300
c31e1495 LP	301	static inline size_t IOVEC_TOTAL_SIZE(const struct iovec *i, unsigned n) {
	302	unsigned j;
	303	size_t r = 0;
	304
	305	for (j = 0; j < n; j++)
	306	r += i[j].iov_len;
	307
	308	return r;
	309	}
	310
	311	static inline size_t IOVEC_INCREMENT(struct iovec *i, unsigned n, size_t k) {
	312	unsigned j;
	313
	314	for (j = 0; j < n; j++) {
	315	size_t sub;
	316
	317	if (_unlikely_(k <= 0))
	318	break;
	319
	320	sub = MIN(i[j].iov_len, k);
	321	i[j].iov_len -= sub;
	322	i[j].iov_base = (uint8_t*) i[j].iov_base + sub;
	323	k -= sub;
	324	}
	325
	326	return k;
	327	}
	328
cecd32f6 LP	329	#define VA_FORMAT_ADVANCE(format, ap) \
	330	do { \
	331	int _argtypes[128]; \
963ddb91 LP	332	size_t _i, _k; \
963ddb91 LP	333	_k = parse_printf_format((format), ELEMENTSOF(_argtypes), _argtypes); \
cecd32f6	334	assert(_k < ELEMENTSOF(_argtypes)); \
963ddb91 LP	335	for (_i = 0; _i < _k; _i++) { \
	336	if (_argtypes[_i] & PA_FLAG_PTR) { \
	337	(void) va_arg(ap, void*); \
	338	continue; \
	339	} \
	340	\
	341	switch (_argtypes[_i]) { \
	342	case PA_INT: \
	343	case PA_INT\|PA_FLAG_SHORT: \
	344	case PA_CHAR: \
	345	(void) va_arg(ap, int); \
	346	break; \
	347	case PA_INT\|PA_FLAG_LONG: \
	348	(void) va_arg(ap, long int); \
	349	break; \
	350	case PA_INT\|PA_FLAG_LONG_LONG: \
	351	(void) va_arg(ap, long long int); \
	352	break; \
	353	case PA_WCHAR: \
	354	(void) va_arg(ap, wchar_t); \
	355	break; \
	356	case PA_WSTRING: \
	357	case PA_STRING: \
	358	case PA_POINTER: \
	359	(void) va_arg(ap, void*); \
	360	break; \
	361	case PA_FLOAT: \
	362	case PA_DOUBLE: \
	363	(void) va_arg(ap, double); \
	364	break; \
	365	case PA_DOUBLE\|PA_FLAG_LONG_DOUBLE: \
	366	(void) va_arg(ap, long double); \
	367	break; \
	368	default: \
	369	assert_not_reached("Unknown format string argument."); \
	370	} \
	371	} \
	372	} while(false)
	373
e5f476db	374	/* Because statfs.t_type can be int on some architectures, we have to cast
bdd29249 HH	375	* the const magic to the type, otherwise the compiler warns about
	376	* signed/unsigned comparison, because the magic can be 32 bit unsigned.
	377	*/
c51cf056	378	#define F_TYPE_EQUAL(a, b) (a == (typeof(a)) b)
bdd29249	379
fa70beaa LP	380	/* Returns the number of chars needed to format variables of the
	381	* specified type as a decimal string. Adds in extra space for a
	382	* negative '-' prefix. */
fa70beaa	383	#define DECIMAL_STR_MAX(type) \
5bcb0f2b	384	(2+(sizeof(type) <= 1 ? 3 : \
fa70beaa LP	385	sizeof(type) <= 2 ? 5 : \
	386	sizeof(type) <= 4 ? 10 : \
	387	sizeof(type) <= 8 ? 20 : sizeof(int[-2*(sizeof(type) > 8)])))
	388
264ad849 LP	389	#define SET_FLAG(v, flag, b) \
	390	(v) = (b) ? ((v) \| (flag)) : ((v) & ~(flag))
	391
dc36d78e	392	#define IN_SET(x, y, ...) \
059d9fbb	393	({ \
dc36d78e LP	394	const typeof(y) _y = (y); \
dc36d78e LP	395	const typeof(_y) _x = (x); \
059d9fbb LP	396	unsigned _i; \
059d9fbb LP	397	bool _found = false; \
dc36d78e LP	398	for (_i = 0; _i < 1 + sizeof((const typeof(_x)[]) { __VA_ARGS__ })/sizeof(const typeof(_x)); _i++) \
dc36d78e LP	399	if (((const typeof(_x)[]) { _y, __VA_ARGS__ })[_i] == _x) { \
059d9fbb LP	400	_found = true; \
	401	break; \
	402	} \
	403	_found; \
cabb7806 LP	404	})
cabb7806 LP	405
7f0a55d4 JT	406	/* Return a nulstr for a standard cascade of configuration directories,
	407	* suitable to pass to conf_files_list_nulstr or config_parse_many. */
	408	#define CONF_DIRS_NULSTR(n) \
	409	"/etc/" n ".d\0" \
	410	"/run/" n ".d\0" \
	411	"/usr/local/lib/" n ".d\0" \
	412	"/usr/lib/" n ".d\0" \
	413	CONF_DIR_SPLIT_USR(n)
	414
	415	#ifdef HAVE_SPLIT_USR
	416	#define CONF_DIR_SPLIT_USR(n) "/lib/" n ".d\0"
	417	#else
	418	#define CONF_DIR_SPLIT_USR(n)
	419	#endif
	420
919ce0b7 SL	421	/* Define C11 thread_local attribute even on older gcc compiler
919ce0b7 SL	422	* version */
ec202eae SL	423	#ifndef thread_local
	424	/*
	425	* Don't break on glibc < 2.16 that doesn't define __STDC_NO_THREADS__
	426	* see http://gcc.gnu.org/bugzilla/show_bug.cgi?id=53769
	427	*/
	428	#if __STDC_VERSION__ >= 201112L && !(defined(__STDC_NO_THREADS__) \|\| (defined(__GNU_LIBRARY__) && __GLIBC__ == 2 && __GLIBC_MINOR__ < 16))
	429	#define thread_local _Thread_local
	430	#else
	431	#define thread_local __thread
	432	#endif
	433	#endif
cabb7806	434
919ce0b7 SL	435	/* Define C11 noreturn without <stdnoreturn.h> and even on older gcc
	436	* compiler versions */
	437	#ifndef noreturn
	438	#if __STDC_VERSION__ >= 201112L
	439	#define noreturn _Noreturn
	440	#else
	441	#define noreturn __attribute__((noreturn))
	442	#endif
	443	#endif
	444
fed1e721 LP	445	#define UID_INVALID ((uid_t) -1)
	446	#define GID_INVALID ((gid_t) -1)
	447	#define MODE_INVALID ((mode_t) -1)
	448
a2341f68 ZJS	449	#define DEFINE_TRIVIAL_CLEANUP_FUNC(type, func) \
	450	static inline void func##p(type *p) { \
	451	if (*p) \
	452	func(*p); \
	453	} \
	454	struct __useless_struct_to_allow_trailing_semicolon__
	455
dd8f71ee	456	#include "log.h"