macros.h revision ac7aa955db4c77bbb169baa5d104a4c128674646
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen#ifndef MACROS_H
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen#define MACROS_H
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen/* several useful macros, mostly from glib.h */
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen#ifndef NULL
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen# define NULL ((void *)0)
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen#endif
96e1ed172ae59cae6bc6e6ddd24d22a158e23dfeTimo Sirainen
96e1ed172ae59cae6bc6e6ddd24d22a158e23dfeTimo Sirainen#ifndef FALSE
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen# define FALSE (!1)
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen#endif
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen#ifndef TRUE
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen# define TRUE (!FALSE)
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen#endif
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen#define N_ELEMENTS(arr) \
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen (sizeof(arr) / sizeof((arr)[0]))
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen#define MEM_ALIGN(size) \
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen (((size) + MEM_ALIGN_SIZE-1) & ~((size_t) MEM_ALIGN_SIZE-1))
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen#define PTR_OFFSET(ptr, offset) \
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen ((void *) (((uintptr_t) (ptr)) + (offset)))
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen#define CONST_PTR_OFFSET(ptr, offset) \
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen ((const void *) (((uintptr_t) (ptr)) + (offset)))
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen
b162e16ade1e0d9bfae62e366caf57a3132f5963Timo Sirainen#define container_of(ptr, type, name) \
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen (type *)((uintptr_t)(ptr) - (uintptr_t)offsetof(type, name) + \
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen COMPILE_ERROR_IF_TYPES_NOT_COMPATIBLE(ptr, &((type *) 0)->name))
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen/* Don't use simply MIN/MAX, as they're often defined elsewhere in include
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen files that are included after this file generating tons of warnings. */
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen#define I_MIN(a, b) (((a) < (b)) ? (a) : (b))
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen#define I_MAX(a, b) (((a) > (b)) ? (a) : (b))
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen/* make it easier to cast from/to pointers. assumes that
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen sizeof(size_t) == sizeof(void *) and they're both the largest datatypes
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen that are allowed to be used. so, long long isn't safe with these. */
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen#define POINTER_CAST(i) \
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen ((void *) (((uintptr_t)NULL) + (i)))
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen#define POINTER_CAST_TO(p, type) \
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen ((type) ((const char *) (p) - (const char *) NULL))
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen/* Define VA_COPY() to do the right thing for copying va_list variables.
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen config.h may have already defined VA_COPY as va_copy or __va_copy. */
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen#ifndef VA_COPY
b162e16ade1e0d9bfae62e366caf57a3132f5963Timo Sirainen# if defined (__GNUC__) && defined (__PPC__) && \
b162e16ade1e0d9bfae62e366caf57a3132f5963Timo Sirainen (defined (_CALL_SYSV) || defined (_WIN32))
b162e16ade1e0d9bfae62e366caf57a3132f5963Timo Sirainen# define VA_COPY(ap1, ap2) (*(ap1) = *(ap2))
b162e16ade1e0d9bfae62e366caf57a3132f5963Timo Sirainen# elif defined (VA_COPY_AS_ARRAY)
b162e16ade1e0d9bfae62e366caf57a3132f5963Timo Sirainen# define VA_COPY(ap1, ap2) memmove ((ap1), (ap2), sizeof (va_list))
b162e16ade1e0d9bfae62e366caf57a3132f5963Timo Sirainen# else /* va_list is a pointer */
b162e16ade1e0d9bfae62e366caf57a3132f5963Timo Sirainen# define VA_COPY(ap1, ap2) ((ap1) = (ap2))
96e1ed172ae59cae6bc6e6ddd24d22a158e23dfeTimo Sirainen# endif /* va_list is a pointer */
96e1ed172ae59cae6bc6e6ddd24d22a158e23dfeTimo Sirainen#endif
96e1ed172ae59cae6bc6e6ddd24d22a158e23dfeTimo Sirainen
96e1ed172ae59cae6bc6e6ddd24d22a158e23dfeTimo Sirainen/* Provide convenience macros for handling structure
96e1ed172ae59cae6bc6e6ddd24d22a158e23dfeTimo Sirainen * fields through their offsets.
96e1ed172ae59cae6bc6e6ddd24d22a158e23dfeTimo Sirainen */
96e1ed172ae59cae6bc6e6ddd24d22a158e23dfeTimo Sirainen#define STRUCT_MEMBER_P(struct_p, struct_offset) \
96e1ed172ae59cae6bc6e6ddd24d22a158e23dfeTimo Sirainen ((void *) ((char *) (struct_p) + (long) (struct_offset)))
96e1ed172ae59cae6bc6e6ddd24d22a158e23dfeTimo Sirainen#define CONST_STRUCT_MEMBER_P(struct_p, struct_offset) \
96e1ed172ae59cae6bc6e6ddd24d22a158e23dfeTimo Sirainen ((const void *) ((const char *) (struct_p) + (long) (struct_offset)))
96e1ed172ae59cae6bc6e6ddd24d22a158e23dfeTimo Sirainen
96e1ed172ae59cae6bc6e6ddd24d22a158e23dfeTimo Sirainen/* Provide simple macro statement wrappers (adapted from Perl):
96e1ed172ae59cae6bc6e6ddd24d22a158e23dfeTimo Sirainen STMT_START { statements; } STMT_END;
96e1ed172ae59cae6bc6e6ddd24d22a158e23dfeTimo Sirainen can be used as a single statement, as in
96e1ed172ae59cae6bc6e6ddd24d22a158e23dfeTimo Sirainen if (x) STMT_START { ... } STMT_END; else ...
96e1ed172ae59cae6bc6e6ddd24d22a158e23dfeTimo Sirainen
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen For gcc we will wrap the statements within `({' and `})' braces.
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen For SunOS they will be wrapped within `if (1)' and `else (void) 0',
baf3e87e186453fda13bd21f7cbcb2efc8492e8bTimo Sirainen and otherwise within `do' and `while (0)'. */
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen#if !(defined (STMT_START) && defined (STMT_END))
b162e16ade1e0d9bfae62e366caf57a3132f5963Timo Sirainen# if defined (__GNUC__) && !defined (__cplusplus) && \
96e1ed172ae59cae6bc6e6ddd24d22a158e23dfeTimo Sirainen !defined (__STRICT_ANSI__) && !defined (PEDANTIC)
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen# define STMT_START (void)(
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen# define STMT_END )
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen# else
b2ff0468c298dd2f525fff5977f1f24fba3a9f3bTimo Sirainen# if (defined (sun) || defined (__sun__))
# define STMT_START if (1)
# define STMT_END else (void)0
# else
# define STMT_START do
# define STMT_END while (0)
# endif
# endif
#endif
/* Provide macros to feature the GCC function attribute. */
#if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4)
# define ATTRS_DEFINED
# define ATTR_FORMAT(format_idx, arg_idx) \
__attribute__((format (printf, format_idx, arg_idx)))
# define ATTR_FORMAT_ARG(arg_idx) \
__attribute__((format_arg (arg_idx)))
# define ATTR_SCANF(format_idx, arg_idx) \
__attribute__((format (scanf, format_idx, arg_idx)))
# define ATTR_STRFTIME(format_idx) \
__attribute__((format (strftime, format_idx, 0)))
# define ATTR_UNUSED __attribute__((unused))
# define ATTR_NORETURN __attribute__((noreturn))
# define ATTR_CONST __attribute__((const))
# define ATTR_PURE __attribute__((pure))
#else
# define ATTR_FORMAT(format_idx, arg_idx)
# define ATTR_FORMAT_ARG(arg_idx)
# define ATTR_SCANF(format_idx, arg_idx)
# define ATTR_STRFTIME(format_idx)
# define ATTR_UNUSED
# define ATTR_NORETURN
# define ATTR_CONST
# define ATTR_PURE
#endif
#ifdef HAVE_ATTR_NULL
# define ATTR_NULL(...) __attribute__((null(__VA_ARGS__)))
#else
# define ATTR_NULL(...)
#endif
#ifdef HAVE_ATTR_NOWARN_UNUSED_RESULT
# define ATTR_NOWARN_UNUSED_RESULT __attribute__((nowarn_unused_result))
#else
# define ATTR_NOWARN_UNUSED_RESULT
#endif
#if __GNUC__ > 2
# define ATTR_MALLOC __attribute__((malloc))
#else
# define ATTR_MALLOC
#endif
#if __GNUC__ > 3
/* GCC 4.0 and later */
# define ATTR_WARN_UNUSED_RESULT __attribute__((warn_unused_result))
# define ATTR_SENTINEL __attribute__((sentinel))
#else
# define ATTR_WARN_UNUSED_RESULT
# define ATTR_SENTINEL
#endif
#if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3)
/* GCC 4.3 and later */
# define ATTR_HOT __attribute__((hot))
# define ATTR_COLD __attribute__((cold))
#else
# define ATTR_HOT
# define ATTR_COLD
#endif
#if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 9)
/* GCC 4.9 and later */
# define ATTR_RETURNS_NONNULL __attribute__((returns_nonnull))
#else
# define ATTR_RETURNS_NONNULL
#endif
/* Macros to provide type safety for callback functions' context parameters */
#ifdef HAVE_TYPE_CHECKS
# define CALLBACK_TYPECHECK(callback, type) \
(COMPILE_ERROR_IF_TRUE(!__builtin_types_compatible_p( \
typeof(&callback), type)) ? 1 : 0)
#else
# define CALLBACK_TYPECHECK(callback, type) 0
#endif
#if (__GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ > 0)) && !defined(__cplusplus)
# define COMPILE_ERROR_IF_TRUE(condition) \
(sizeof(char[1 - 2 * ((condition) ? 1 : 0)]) - 1)
#else
# define COMPILE_ERROR_IF_TRUE(condition) 0
#endif
#ifdef HAVE_TYPE_CHECKS
# define COMPILE_ERROR_IF_TYPES_NOT_COMPATIBLE(_a, _b) \
COMPILE_ERROR_IF_TRUE( \
!__builtin_types_compatible_p(typeof(_a), typeof(_b)))
#define COMPILE_ERROR_IF_TYPES2_NOT_COMPATIBLE(_a1, _a2, _b) \
COMPILE_ERROR_IF_TRUE( \
!__builtin_types_compatible_p(typeof(_a1), typeof(_b)) && \
!__builtin_types_compatible_p(typeof(_a2), typeof(_b)))
#else
# define COMPILE_ERROR_IF_TYPES_NOT_COMPATIBLE(_a, _b) 0
# define COMPILE_ERROR_IF_TYPES2_NOT_COMPATIBLE(_a1, _a2, _b) 0
#endif
#if __GNUC__ > 2
# define unlikely(expr) (__builtin_expect((expr) ? 1 : 0, 0) != 0)
# define likely(expr) (__builtin_expect((expr) ? 1 : 0, 1) != 0)
#else
# define unlikely(expr) expr
# define likely(expr) expr
#endif
#if defined(__clang__) && ((__clang_major__ > 4) || (__clang_major__ == 3 && __clang_minor__ >= 9))
# define ATTR_UNSIGNED_WRAPS __attribute__((no_sanitize("integer")))
#else
# define ATTR_UNSIGNED_WRAPS
#endif
/* Provide macros for error handling. */
#ifdef DISABLE_ASSERTS
# define i_assert(expr)
#else
#define i_assert(expr) STMT_START{ \
if (unlikely(!(expr))) \
i_panic("file %s: line %d (%s): assertion failed: (%s)", \
__FILE__, \
__LINE__, \
__func__, \
#expr); }STMT_END
#endif
#ifndef STATIC_CHECKER
# define i_unreached() \
i_panic("file %s: line %d: unreached", __FILE__, __LINE__)
#else
# define i_unreached() __builtin_unreachable()
#endif
/* Convenience macros to test the versions of dovecot. */
#if defined DOVECOT_VERSION_MAJOR && defined DOVECOT_VERSION_MINOR
# define DOVECOT_PREREQ(maj, min) \
((DOVECOT_VERSION_MAJOR << 16) + DOVECOT_VERSION_MINOR >= ((maj) << 16) + (min))
#else
# define DOVECOT_PREREQ(maj, min) 0
#endif
#ifdef __cplusplus
# undef STATIC_ARRAY
# define STATIC_ARRAY
#endif
/* Convenience wrappers for initializing a struct */
#define i_zero(p) memset(p, 0, sizeof(*(p)))
#define i_zero_safe(p) safe_memset(p, 0, sizeof(*(p)))
#define ST_CHANGED(st_a, st_b) \
((st_a).st_mtime != (st_b).st_mtime || \
ST_MTIME_NSEC(st_a) != ST_MTIME_NSEC(st_b) || \
(st_a).st_size != (st_b).st_size || \
(st_a).st_ino != (st_b).st_ino)
#endif