[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 XSTRINGIFY(x) #x
#define STRINGIFY(x) XSTRINGIFY(x)

/* Rounds up */
#define ALIGN(l) ALIGN_TO((l), sizeof(void*))
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) ({ \
        const typeof( ((type *)0)->member ) *__mptr = (ptr); \
        (type *)( (char *)__mptr - offsetof(type,member) );})

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

#define MAX3(a,b,c)                             \
        MAX(MAX(a,b),c)

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

#define MIN3(a,b,c)                             \
        MIN(MIN(a,b),c)

#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)); \
                })

#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_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_strv_free_ __attribute__((cleanup(strv_freep)))

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

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