[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_attr_(a,b) __attribute__ ((format (printf, a, b)))
#define _sentinel_ __attribute__ ((sentinel))
#define _noreturn_ __attribute__((noreturn))
#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 _introspect_(x) __attribute__((section("introspect." x)))
#define _alignas_(x) __attribute__((aligned(__alignof(x))))
#define _cleanup_(x) __attribute__((cleanup(x)))

/* automake test harness */
#define EXIT_TEST_SKIP 77

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

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

#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)                                 \
        __extension__ ({                                                \
                        const typeof( ((type *)0)->member ) *__mptr = (ptr); \
                        (type *)( (char *)__mptr - offsetof(type,member) ); \
                })

#undef MAX
#define MAX(a,b)                                 \
        __extension__ ({                         \
                        typeof(a) _a = (a);      \
                        typeof(b) _b = (b);      \
                        _a > _b ? _a : _b;       \
                })

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

#undef MIN
#define MIN(a,b)                                \
        __extension__ ({                        \
                        typeof(a) _a = (a);     \
                        typeof(b) _b = (b);     \
                        _a < _b ? _a : _b;      \
                })

#ifndef CLAMP
#define CLAMP(x, low, high)                                             \
        __extension__ ({                                                \
                        typeof(x) _x = (x);                             \
                        typeof(low) _low = (low);                       \
                        typeof(high) _high = (high);                    \
                        ((_x > _high) ? _high : ((_x < _low) ? _low : _x)); \
                })
#endif

#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)
#define assert_cc(expr)                         \
        do {                                    \
                static_assert(expr, #expr);     \
        } while (false)
#else
#define assert_cc(expr)                         \
        do {                                    \
                switch (0) {                    \
                case 0:                         \
                case !!(expr):                  \
                        ;                       \
                }                               \
        } while (false)
#endif

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

#define PTR_TO_UINT32(p) ((uint32_t) ((uintptr_t) (p)))
#define UINT32_TO_PTR(u) ((void*) ((uintptr_t) (u)))

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

#define PTR_TO_INT(p) ((int) ((intptr_t) (p)))
#define INT_TO_PTR(u) ((void*) ((intptr_t) (u)))

#define TO_INT32(p) ((int32_t) ((intptr_t) (p)))
#define INT32_TO_PTR(u) ((void*) ((intptr_t) (u)))

#define PTR_TO_LONG(p) ((long) ((intptr_t) (p)))
#define LONG_TO_PTR(u) ((void*) ((intptr_t) (u)))

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

/* Remove this macro, when the kernel has f_type as unsigned int or long
 * for every architecure. Currently some 64bit architecures (like s390x)
 * have int in the kernel, but long in userspace for f_type, so glibc
 * extends the int to long and carries over the sign. Negative numbers are
 * caused by the 32bit magic constants in linux/magic.h stuffed into the
 * signed int in the kernel and these negative numbers are extended to
 * long, which cannot be simply compared to the magic constants anymore.
 */
#define F_TYPE_CMP(f, c)                                                \
        __extension__ ({                                                \
                        __SWORD_TYPE _f = (f);                          \
                        const __SWORD_TYPE _c = (c);                    \
                        const int _c32 = (c);                           \
                        (_f == _c || _f == _c32 );                      \
                })


/* 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)                                           \
        (1+(sizeof(type) <= 1 ? 3 :                                     \
            sizeof(type) <= 2 ? 5 :                                     \
            sizeof(type) <= 4 ? 10 :                                    \
            sizeof(type) <= 8 ? 20 : sizeof(int[-2*(sizeof(type) > 8)])))

#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
93a46b0b LP	30	#define _printf_attr_(a,b) __attribute__ ((format (printf, a, b)))
	31	#define _sentinel_ __attribute__ ((sentinel))
	32	#define _noreturn_ __attribute__((noreturn))
	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)))
9a60da28	46	#define _introspect_(x) __attribute__((section("introspect." x)))
19d1e4ee	47	#define _alignas_(x) __attribute__((aligned(__alignof(x))))
dfb33a97	48	#define _cleanup_(x) __attribute__((cleanup(x)))
60918275	49
49e5de64 ZJS	50	/* automake test harness */
	51	#define EXIT_TEST_SKIP 77
	52
bef2733f LP	53	#define XSTRINGIFY(x) #x
	54	#define STRINGIFY(x) XSTRINGIFY(x)
	55
60918275	56	/* Rounds up */
9be9c7cf LP	57
	58	#define ALIGN4(l) (((l) + 3) & ~3)
	59	#define ALIGN8(l) (((l) + 7) & ~7)
	60
	61	#if __SIZEOF_POINTER__ == 8
	62	#define ALIGN(l) ALIGN8(l)
	63	#elif __SIZEOF_POINTER__ == 4
	64	#define ALIGN(l) ALIGN4(l)
	65	#else
	66	#error "Wut? Pointers are neither 4 nor 8 bytes long?"
	67	#endif
	68
49aa47c7 LP	69	#define ALIGN_PTR(p) ((void*) ALIGN((unsigned long) p))
49aa47c7 LP	70	#define ALIGN4_PTR(p) ((void*) ALIGN4((unsigned long) p))
e86b80b8 LP	71	#define ALIGN8_PTR(p) ((void*) ALIGN8((unsigned long) p))
e86b80b8 LP	72
37f85e66	73	static inline size_t ALIGN_TO(size_t l, size_t ali) {
37f85e66	74	return ((l + ali - 1) & ~(ali - 1));
22be093f LP	75	}
22be093f LP	76
49aa47c7 LP	77	#define ALIGN_TO_PTR(p, ali) ((void*) ALIGN_TO((unsigned long) p))
49aa47c7 LP	78
60918275 LP	79	#define ELEMENTSOF(x) (sizeof(x)/sizeof((x)[0]))
60918275 LP	80
bbc98d32 KS	81	/*
	82	* container_of - cast a member of a structure out to the containing structure
	83	* @ptr: the pointer to the member.
	84	* @type: the type of the container struct this is embedded in.
	85	* @member: the name of the member within the struct.
	86	*
	87	*/
fa70beaa LP	88	#define container_of(ptr, type, member) \
	89	__extension__ ({ \
	90	const typeof( ((type )0)->member ) __mptr = (ptr); \
	91	(type )( (char )__mptr - offsetof(type,member) ); \
	92	})
bbc98d32	93
9607d947 CR	94	#undef MAX
	95	#define MAX(a,b) \
	96	__extension__ ({ \
	97	typeof(a) _a = (a); \
	98	typeof(b) _b = (b); \
	99	_a > _b ? _a : _b; \
60918275 LP	100	})
60918275 LP	101
9607d947 CR	102	#define MAX3(x,y,z) \
	103	__extension__ ({ \
	104	typeof(x) _c = MAX(x,y); \
	105	MAX(_c, z); \
	106	})
3b63d2d3	107
9607d947	108	#undef MIN
60918275 LP	109	#define MIN(a,b) \
	110	__extension__ ({ \
	111	typeof(a) _a = (a); \
	112	typeof(b) _b = (b); \
	113	_a < _b ? _a : _b; \
	114	})
	115
907809fc	116	#ifndef CLAMP
60918275 LP	117	#define CLAMP(x, low, high) \
	118	__extension__ ({ \
	119	typeof(x) _x = (x); \
	120	typeof(low) _low = (low); \
	121	typeof(high) _high = (high); \
	122	((_x > _high) ? _high : ((_x < _low) ? _low : _x)); \
	123	})
907809fc	124	#endif
60918275	125
dd8f71ee LP	126	#define assert_se(expr) \
dd8f71ee LP	127	do { \
93a46b0b	128	if (_unlikely_(!(expr))) \
b7f33638	129	log_assert_failed(#expr, __FILE__, __LINE__, __PRETTY_FUNCTION__); \
dd8f71ee LP	130	} while (false) \
	131
	132	/* We override the glibc assert() here. */
	133	#undef assert
	134	#ifdef NDEBUG
	135	#define assert(expr) do {} while(false)
	136	#else
	137	#define assert(expr) assert_se(expr)
	138	#endif
60918275	139
dd8f71ee LP	140	#define assert_not_reached(t) \
dd8f71ee LP	141	do { \
b7f33638	142	log_assert_failed_unreachable(t, __FILE__, __LINE__, __PRETTY_FUNCTION__); \
dd8f71ee	143	} while (false)
60918275	144
f791c684 LP	145	#if defined(static_assert)
	146	#define assert_cc(expr) \
	147	do { \
	148	static_assert(expr, #expr); \
60918275	149	} while (false)
f791c684 LP	150	#else
	151	#define assert_cc(expr) \
	152	do { \
	153	switch (0) { \
	154	case 0: \
	155	case !!(expr): \
	156	; \
	157	} \
	158	} while (false)
	159	#endif
60918275 LP	160
	161	#define PTR_TO_UINT(p) ((unsigned int) ((uintptr_t) (p)))
	162	#define UINT_TO_PTR(u) ((void*) ((uintptr_t) (u)))
	163
	164	#define PTR_TO_UINT32(p) ((uint32_t) ((uintptr_t) (p)))
	165	#define UINT32_TO_PTR(u) ((void*) ((uintptr_t) (u)))
	166
c6c18be3 LP	167	#define PTR_TO_ULONG(p) ((unsigned long) ((uintptr_t) (p)))
	168	#define ULONG_TO_PTR(u) ((void*) ((uintptr_t) (u)))
	169
60918275 LP	170	#define PTR_TO_INT(p) ((int) ((intptr_t) (p)))
	171	#define INT_TO_PTR(u) ((void*) ((intptr_t) (u)))
	172
	173	#define TO_INT32(p) ((int32_t) ((intptr_t) (p)))
	174	#define INT32_TO_PTR(u) ((void*) ((intptr_t) (u)))
	175
c6c18be3 LP	176	#define PTR_TO_LONG(p) ((long) ((intptr_t) (p)))
	177	#define LONG_TO_PTR(u) ((void*) ((intptr_t) (u)))
	178
476fe607 LP	179	#define memzero(x,l) (memset((x), 0, (l)))
	180	#define zero(x) (memzero(&(x), sizeof(x)))
	181
a9c55a88 LP	182	#define CHAR_TO_STR(x) ((char[2]) { x, 0 })
a9c55a88 LP	183
034c6ed7 LP	184	#define char_array_0(x) x[sizeof(x)-1] = 0;
034c6ed7 LP	185
bff7c062	186	#define IOVEC_SET_STRING(i, s) \
2fa086a8	187	do { \
bff7c062 LP	188	struct iovec *_i = &(i); \
	189	char _s = (char )(s); \
	190	_i->iov_base = _s; \
	191	_i->iov_len = strlen(_s); \
9b3c575e	192	} while(false)
2fa086a8	193
c31e1495 LP	194	static inline size_t IOVEC_TOTAL_SIZE(const struct iovec *i, unsigned n) {
	195	unsigned j;
	196	size_t r = 0;
	197
	198	for (j = 0; j < n; j++)
	199	r += i[j].iov_len;
	200
	201	return r;
	202	}
	203
	204	static inline size_t IOVEC_INCREMENT(struct iovec *i, unsigned n, size_t k) {
	205	unsigned j;
	206
	207	for (j = 0; j < n; j++) {
	208	size_t sub;
	209
	210	if (_unlikely_(k <= 0))
	211	break;
	212
	213	sub = MIN(i[j].iov_len, k);
	214	i[j].iov_len -= sub;
	215	i[j].iov_base = (uint8_t*) i[j].iov_base + sub;
	216	k -= sub;
	217	}
	218
	219	return k;
	220	}
	221
cecd32f6 LP	222	#define VA_FORMAT_ADVANCE(format, ap) \
	223	do { \
	224	int _argtypes[128]; \
963ddb91 LP	225	size_t _i, _k; \
963ddb91 LP	226	_k = parse_printf_format((format), ELEMENTSOF(_argtypes), _argtypes); \
cecd32f6	227	assert(_k < ELEMENTSOF(_argtypes)); \
963ddb91 LP	228	for (_i = 0; _i < _k; _i++) { \
	229	if (_argtypes[_i] & PA_FLAG_PTR) { \
	230	(void) va_arg(ap, void*); \
	231	continue; \
	232	} \
	233	\
	234	switch (_argtypes[_i]) { \
	235	case PA_INT: \
	236	case PA_INT\|PA_FLAG_SHORT: \
	237	case PA_CHAR: \
	238	(void) va_arg(ap, int); \
	239	break; \
	240	case PA_INT\|PA_FLAG_LONG: \
	241	(void) va_arg(ap, long int); \
	242	break; \
	243	case PA_INT\|PA_FLAG_LONG_LONG: \
	244	(void) va_arg(ap, long long int); \
	245	break; \
	246	case PA_WCHAR: \
	247	(void) va_arg(ap, wchar_t); \
	248	break; \
	249	case PA_WSTRING: \
	250	case PA_STRING: \
	251	case PA_POINTER: \
	252	(void) va_arg(ap, void*); \
	253	break; \
	254	case PA_FLOAT: \
	255	case PA_DOUBLE: \
	256	(void) va_arg(ap, double); \
	257	break; \
	258	case PA_DOUBLE\|PA_FLAG_LONG_DOUBLE: \
	259	(void) va_arg(ap, long double); \
	260	break; \
	261	default: \
	262	assert_not_reached("Unknown format string argument."); \
	263	} \
	264	} \
	265	} while(false)
	266
fc6e6d24 HH	267	/* Remove this macro, when the kernel has f_type as unsigned int or long
	268	* for every architecure. Currently some 64bit architecures (like s390x)
	269	* have int in the kernel, but long in userspace for f_type, so glibc
	270	* extends the int to long and carries over the sign. Negative numbers are
	271	* caused by the 32bit magic constants in linux/magic.h stuffed into the
	272	* signed int in the kernel and these negative numbers are extended to
	273	* long, which cannot be simply compared to the magic constants anymore.
	274	*/
aea275c4	275	#define F_TYPE_CMP(f, c) \
fc6e6d24 HH	276	__extension__ ({ \
	277	__SWORD_TYPE _f = (f); \
	278	const __SWORD_TYPE _c = (c); \
	279	const int _c32 = (c); \
	280	(_f == _c \|\| _f == _c32 ); \
	281	})
	282
	283
fa70beaa LP	284	/* Returns the number of chars needed to format variables of the
	285	* specified type as a decimal string. Adds in extra space for a
	286	* negative '-' prefix. */
	287
	288	#define DECIMAL_STR_MAX(type) \
	289	(1+(sizeof(type) <= 1 ? 3 : \
	290	sizeof(type) <= 2 ? 5 : \
	291	sizeof(type) <= 4 ? 10 : \
	292	sizeof(type) <= 8 ? 20 : sizeof(int[-2*(sizeof(type) > 8)])))
	293
dd8f71ee	294	#include "log.h"