src/lib/macros.h

	macros.h revision 255c47a461434ac075efa4fd481d888f193b73ba
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#ifndef MACROS_H
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#define MACROS_H
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen/* several useful macros, mostly from glib.h */
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#ifndef NULL
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  define NULL ((void *)0)
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#endif
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#ifndef FALSE
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  define FALSE (0)
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#endif
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#ifndef TRUE
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  define TRUE (!FALSE)
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#endif
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#define N_ELEMENTS(arr) \
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen    (sizeof(arr) / sizeof((arr)[0]))
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#define MEM_ALIGN(size) \
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen    (((size) + MEM_ALIGN_SIZE-1) & ~((size_t) MEM_ALIGN_SIZE-1))
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#define PTR_OFFSET(ptr, offset) \
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen    ((void *) (((unsigned char *) (ptr)) + (offset)))
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#define CONST_PTR_OFFSET(ptr, offset) \
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen    ((const void *) (((const unsigned char *) (ptr)) + (offset)))
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen/* Don't use simply MIN/MAX, as they're often defined elsewhere in include
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen   files that are included after this file generating tons of warnings. */
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#define I_MIN(a, b)  (((a) < (b)) ? (a) : (b))
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#define I_MAX(a, b)  (((a) > (b)) ? (a) : (b))
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen/* make it easier to cast from/to pointers. assumes that
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen   sizeof(size_t) == sizeof(void *) and they're both the largest datatypes
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen   that are allowed to be used. so, long long isn't safe with these. */
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#define POINTER_CAST(i) \
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen    ((void *) ((char *) NULL + (i)))
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#define POINTER_CAST_TO(p, type) \
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen    ((type) ((const char *) (p) - (const char *) NULL))
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen/* Define VA_COPY() to do the right thing for copying va_list variables.
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen   config.h may have already defined VA_COPY as va_copy or __va_copy. */
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#ifndef VA_COPY
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  if defined (__GNUC__) && defined (__PPC__) && \
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen      (defined (_CALL_SYSV) || defined (_WIN32))
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#    define VA_COPY(ap1, ap2) (*(ap1) = *(ap2))
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  elif defined (VA_COPY_AS_ARRAY)
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#    define VA_COPY(ap1, ap2) memmove ((ap1), (ap2), sizeof (va_list))
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  else /* va_list is a pointer */
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#    define VA_COPY(ap1, ap2) ((ap1) = (ap2))
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  endif /* va_list is a pointer */
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#endif
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen/* Provide convenience macros for handling structure
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen * fields through their offsets.
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen */
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#define STRUCT_MEMBER_P(struct_p, struct_offset) \
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen    ((void *) ((char *) (struct_p) + (long) (struct_offset)))
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#define CONST_STRUCT_MEMBER_P(struct_p, struct_offset) \
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen    ((const void *) ((const char *) (struct_p) + (long) (struct_offset)))
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen/* Provide simple macro statement wrappers (adapted from Perl):
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen   STMT_START { statements; } STMT_END;
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen   can be used as a single statement, as in
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen   if (x) STMT_START { ... } STMT_END; else ...
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen   For gcc we will wrap the statements within `({' and `})' braces.
f55988edb669c6bcfdfd91f2f7f57e875168f6b2Timo Sirainen   For SunOS they will be wrapped within `if (1)' and `else (void) 0',
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen   and otherwise within `do' and `while (0)'. */
f55988edb669c6bcfdfd91f2f7f57e875168f6b2Timo Sirainen#if !(defined (STMT_START) && defined (STMT_END))
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  if defined (__GNUC__) && !defined (__cplusplus) && \
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen    !defined (__STRICT_ANSI__) && !defined (PEDANTIC)
f55988edb669c6bcfdfd91f2f7f57e875168f6b2Timo Sirainen#    define STMT_START (void)(
f55988edb669c6bcfdfd91f2f7f57e875168f6b2Timo Sirainen#    define STMT_END   )
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  else
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#    if (defined (sun) || defined (__sun__))
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#      define STMT_START if (1)
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#      define STMT_END   else (void)0
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#    else
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#      define STMT_START do
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#      define STMT_END   while (0)
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#    endif
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  endif
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#endif
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen/* Provide macros to feature the GCC function attribute. */
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4)
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  define ATTRS_DEFINED
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  define ATTR_FORMAT(format_idx, arg_idx) \
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen    __attribute__((format (printf, format_idx, arg_idx)))
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  define ATTR_FORMAT_ARG(arg_idx) \
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen    __attribute__((format_arg (arg_idx)))
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  define ATTR_SCANF(format_idx, arg_idx) \
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen    __attribute__((format (scanf, format_idx, arg_idx)))
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  define ATTR_STRFTIME(format_idx) \
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen    __attribute__((format (strftime, format_idx, 0)))
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  define ATTR_UNUSED __attribute__((unused))
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  define ATTR_NORETURN __attribute__((noreturn))
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  define ATTR_CONST __attribute__((const))
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  define ATTR_PURE __attribute__((pure))
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#else
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  define ATTR_FORMAT(format_idx, arg_idx)
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  define ATTR_FORMAT_ARG(arg_idx)
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  define ATTR_SCANF(format_idx, arg_idx)
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  define ATTR_STRFTIME(format_idx)
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  define ATTR_UNUSED
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  define ATTR_NORETURN
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  define ATTR_CONST
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  define ATTR_PURE
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#endif
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#ifdef HAVE_ATTR_NULL
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  define ATTR_NULL(...) __attribute__((null(__VA_ARGS__)))
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#else
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  define ATTR_NULL(...)
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#endif
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#ifdef HAVE_ATTR_NOWARN_UNUSED_RESULT
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  define ATTR_NOWARN_UNUSED_RESULT __attribute__((nowarn_unused_result))
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#else
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  define ATTR_NOWARN_UNUSED_RESULT
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#endif
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#if __GNUC__ > 2
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  define ATTR_MALLOC __attribute__((malloc))
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#else
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  define ATTR_MALLOC
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#endif
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#if __GNUC__ > 3
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen/* GCC 4.0 and later */
f55988edb669c6bcfdfd91f2f7f57e875168f6b2Timo Sirainen#  define ATTR_WARN_UNUSED_RESULT __attribute__((warn_unused_result))
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  define ATTR_SENTINEL __attribute__((sentinel))
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#else
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  define ATTR_WARN_UNUSED_RESULT
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  define ATTR_SENTINEL
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#endif
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3)
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen/* GCC 4.3 and later */
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  define ATTR_HOT __attribute__((hot))
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  define ATTR_COLD __attribute__((cold))
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#else
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  define ATTR_HOT
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  define ATTR_COLD
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#endif
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 9)
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen/* GCC 4.9 and later */
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  define ATTR_RETURNS_NONNULL __attribute__((returns_nonnull))
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#else
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  define ATTR_RETURNS_NONNULL
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#endif
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen/* Macros to provide type safety for callback functions' context parameters */
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#if (__GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ > 3))
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  define CALLBACK_TYPECHECK(callback, type) \
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen    (COMPILE_ERROR_IF_TRUE(!__builtin_types_compatible_p( \
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen        typeof(&callback), type)) ? 1 : 0)
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#else
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  define CALLBACK_TYPECHECK(callback, type) 0
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#endif
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#if (__GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ > 0)) && !defined(__cplusplus)
9afebd21ced1d43f638e08a1411c9a89e526231fTimo Sirainen#  define COMPILE_ERROR_IF_TRUE(condition) \
    (sizeof(char[1 - 2 * !!(condition)]) - 1)
#  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_TRUE(condition) 0
#  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), 0)
#  define likely(expr) __builtin_expect(!!(expr), 1)
#else
#  define unlikely(expr) expr
#  define likely(expr) expr
#endif

/* Provide macros for error handling. */
#ifdef DISABLE_ASSERTS
#  define i_assert(expr)
#elif defined (__GNUC__) && !defined (__STRICT_ANSI__)

#define i_assert(expr)          STMT_START{         \
     if (unlikely(!(expr)))                     \
       i_panic("file %s: line %d (%s): assertion failed: (%s)",     \
        __FILE__,                       \
        __LINE__,                       \
        __FUNCTION__,                   \
        #expr);         }STMT_END

#else /* !__GNUC__ */

#define i_assert(expr)          STMT_START{     \
     if (unlikely(!(expr)))                 \
       i_panic("file %s: line %d: assertion failed: (%s)",  \
          __FILE__,                     \
          __LINE__,                     \
          #expr);           }STMT_END

#endif

#define i_close_fd(fd) STMT_START {  \
    i_assert(*fd != -1); \
    if (unlikely(close_keep_errno(fd) < 0)) \
        i_error("close(%d[%s:%d]) failed: %m", \
            *(fd), __FILE__, __LINE__); \
    } STMT_END

#define i_unreached() \
    i_panic("file %s: line %d: unreached", __FILE__, __LINE__)

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

#endif