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

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

static inline size_t ALIGN_TO(size_t l, size_t ali) {
        return ((l + ali - 1) & ~(ali - 1));
}

#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 _cleanup_free_ __attribute__((cleanup(freep)))
#define _cleanup_fclose_ __attribute__((cleanup(fclosep)))
#define _cleanup_pclose_ __attribute__((cleanup(pclosep)))
#define _cleanup_close_ __attribute__((cleanup(closep)))
#define _cleanup_closedir_ __attribute__((cleanup(closedirp)))
#define _cleanup_umask_ __attribute__((cleanup(umaskp)))
#define _cleanup_set_free_ __attribute__((cleanup(set_freep)))
#define _cleanup_set_free_free_ __attribute__((cleanup(set_free_freep)))
#define _cleanup_strv_free_ __attribute__((cleanup(strv_freep)))
#define _cleanup_journal_close_ __attribute__((cleanup(journal_closep)))

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

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