src/basic/macro.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 #include <assert.h>
   5 #include <errno.h>
   6 #include <inttypes.h>
   7 #include <stdbool.h>
   8 #include <sys/param.h>
   9 #include <sys/sysmacros.h>
  10 #include <sys/types.h>
  11
  12 #define _printf_(a, b) __attribute__((__format__(printf, a, b)))
  13 #ifdef __clang__
  14 #  define _alloc_(...)
  15 #else
  16 #  define _alloc_(...) __attribute__((__alloc_size__(__VA_ARGS__)))
  17 #endif
  18 #define _sentinel_ __attribute__((__sentinel__))
  19 #define _section_(x) __attribute__((__section__(x)))
  20 #define _used_ __attribute__((__used__))
  21 #define _unused_ __attribute__((__unused__))
  22 #define _destructor_ __attribute__((__destructor__))
  23 #define _pure_ __attribute__((__pure__))
  24 #define _const_ __attribute__((__const__))
  25 #define _deprecated_ __attribute__((__deprecated__))
  26 #define _packed_ __attribute__((__packed__))
  27 #define _malloc_ __attribute__((__malloc__))
  28 #define _weak_ __attribute__((__weak__))
  29 #define _likely_(x) (__builtin_expect(!!(x), 1))
  30 #define _unlikely_(x) (__builtin_expect(!!(x), 0))
  31 #define _public_ __attribute__((__visibility__("default")))
  32 #define _hidden_ __attribute__((__visibility__("hidden")))
  33 #define _weakref_(x) __attribute__((__weakref__(#x)))
  34 #define _align_(x) __attribute__((__aligned__(x)))
  35 #define _alignas_(x) __attribute__((__aligned__(__alignof(x))))
  36 #define _alignptr_ __attribute__((__aligned__(sizeof(void*))))
  37 #define _cleanup_(x) __attribute__((__cleanup__(x)))
  38 #if __GNUC__ >= 7
  39 #define _fallthrough_ __attribute__((__fallthrough__))
  40 #else
  41 #define _fallthrough_
  42 #endif
  43 /* Define C11 noreturn without <stdnoreturn.h> and even on older gcc
  44  * compiler versions */
  45 #ifndef _noreturn_
  46 #if __STDC_VERSION__ >= 201112L
  47 #define _noreturn_ _Noreturn
  48 #else
  49 #define _noreturn_ __attribute__((__noreturn__))
  50 #endif
  51 #endif
  52
  53 #if !defined(HAS_FEATURE_MEMORY_SANITIZER)
  54 #  if defined(__has_feature)
  55 #    if __has_feature(memory_sanitizer)
  56 #      define HAS_FEATURE_MEMORY_SANITIZER 1
  57 #    endif
  58 #  endif
  59 #  if !defined(HAS_FEATURE_MEMORY_SANITIZER)
  60 #    define HAS_FEATURE_MEMORY_SANITIZER 0
  61 #  endif
  62 #endif
  63
  64 #if !defined(HAS_FEATURE_ADDRESS_SANITIZER)
  65 #  ifdef __SANITIZE_ADDRESS__
  66 #      define HAS_FEATURE_ADDRESS_SANITIZER 1
  67 #  elif defined(__has_feature)
  68 #    if __has_feature(address_sanitizer)
  69 #      define HAS_FEATURE_ADDRESS_SANITIZER 1
  70 #    endif
  71 #  endif
  72 #  if !defined(HAS_FEATURE_ADDRESS_SANITIZER)
  73 #    define HAS_FEATURE_ADDRESS_SANITIZER 0
  74 #  endif
  75 #endif
  76
  77 /* Note: on GCC "no_sanitize_address" is a function attribute only, on llvm it may also be applied to global
  78  * variables. We define a specific macro which knows this. Note that on GCC we don't need this decorator so much, since
  79  * our primary usecase for this attribute is registration structures placed in named ELF sections which shall not be
  80  * padded, but GCC doesn't pad those anyway if AddressSanitizer is enabled. */
  81 #if HAS_FEATURE_ADDRESS_SANITIZER && defined(__clang__)
  82 #define _variable_no_sanitize_address_ __attribute__((__no_sanitize_address__))
  83 #else
  84 #define _variable_no_sanitize_address_
  85 #endif
  86
  87 /* Apparently there's no has_feature() call defined to check for ubsan, hence let's define this
  88  * unconditionally on llvm */
  89 #if defined(__clang__)
  90 #define _function_no_sanitize_float_cast_overflow_ __attribute__((no_sanitize("float-cast-overflow")))
  91 #else
  92 #define _function_no_sanitize_float_cast_overflow_
  93 #endif
  94
  95 /* Temporarily disable some warnings */
  96 #define DISABLE_WARNING_FORMAT_NONLITERAL                               \
  97         _Pragma("GCC diagnostic push");                                 \
  98         _Pragma("GCC diagnostic ignored \"-Wformat-nonliteral\"")
  99
 100 #define DISABLE_WARNING_MISSING_PROTOTYPES                              \
 101         _Pragma("GCC diagnostic push");                                 \
 102         _Pragma("GCC diagnostic ignored \"-Wmissing-prototypes\"")
 103
 104 #define DISABLE_WARNING_NONNULL                                         \
 105         _Pragma("GCC diagnostic push");                                 \
 106         _Pragma("GCC diagnostic ignored \"-Wnonnull\"")
 107
 108 #define DISABLE_WARNING_SHADOW                                          \
 109         _Pragma("GCC diagnostic push");                                 \
 110         _Pragma("GCC diagnostic ignored \"-Wshadow\"")
 111
 112 #define DISABLE_WARNING_INCOMPATIBLE_POINTER_TYPES                      \
 113         _Pragma("GCC diagnostic push");                                 \
 114         _Pragma("GCC diagnostic ignored \"-Wincompatible-pointer-types\"")
 115
 116 #if HAVE_WSTRINGOP_TRUNCATION
 117 #  define DISABLE_WARNING_STRINGOP_TRUNCATION                           \
 118         _Pragma("GCC diagnostic push");                                 \
 119         _Pragma("GCC diagnostic ignored \"-Wstringop-truncation\"")
 120 #else
 121 #  define DISABLE_WARNING_STRINGOP_TRUNCATION                           \
 122         _Pragma("GCC diagnostic push")
 123 #endif
 124
 125 #define DISABLE_WARNING_FLOAT_EQUAL \
 126         _Pragma("GCC diagnostic push");                                 \
 127         _Pragma("GCC diagnostic ignored \"-Wfloat-equal\"")
 128
 129 #define DISABLE_WARNING_TYPE_LIMITS \
 130         _Pragma("GCC diagnostic push");                                 \
 131         _Pragma("GCC diagnostic ignored \"-Wtype-limits\"")
 132
 133 #define REENABLE_WARNING                                                \
 134         _Pragma("GCC diagnostic pop")
 135
 136 /* automake test harness */
 137 #define EXIT_TEST_SKIP 77
 138
 139 #define XSTRINGIFY(x) #x
 140 #define STRINGIFY(x) XSTRINGIFY(x)
 141
 142 #define XCONCATENATE(x, y) x ## y
 143 #define CONCATENATE(x, y) XCONCATENATE(x, y)
 144
 145 #define UNIQ_T(x, uniq) CONCATENATE(__unique_prefix_, CONCATENATE(x, uniq))
 146 #define UNIQ __COUNTER__
 147
 148 /* builtins */
 149 #if __SIZEOF_INT__ == 4
 150 #define BUILTIN_FFS_U32(x) __builtin_ffs(x);
 151 #elif __SIZEOF_LONG__ == 4
 152 #define BUILTIN_FFS_U32(x) __builtin_ffsl(x);
 153 #else
 154 #error "neither int nor long are four bytes long?!?"
 155 #endif
 156
 157 /* Rounds up */
 158
 159 #define ALIGN4(l) (((l) + 3) & ~3)
 160 #define ALIGN8(l) (((l) + 7) & ~7)
 161
 162 #if __SIZEOF_POINTER__ == 8
 163 #define ALIGN(l) ALIGN8(l)
 164 #elif __SIZEOF_POINTER__ == 4
 165 #define ALIGN(l) ALIGN4(l)
 166 #else
 167 #error "Wut? Pointers are neither 4 nor 8 bytes long?"
 168 #endif
 169
 170 #define ALIGN_PTR(p) ((void*) ALIGN((unsigned long) (p)))
 171 #define ALIGN4_PTR(p) ((void*) ALIGN4((unsigned long) (p)))
 172 #define ALIGN8_PTR(p) ((void*) ALIGN8((unsigned long) (p)))
 173
 174 static inline size_t ALIGN_TO(size_t l, size_t ali) {
 175         return ((l + ali - 1) & ~(ali - 1));
 176 }
 177
 178 #define ALIGN_TO_PTR(p, ali) ((void*) ALIGN_TO((unsigned long) (p), (ali)))
 179
 180 /* align to next higher power-of-2 (except for: 0 => 0, overflow => 0) */
 181 static inline unsigned long ALIGN_POWER2(unsigned long u) {
 182
 183         /* Avoid subtraction overflow */
 184         if (u == 0)
 185                 return 0;
 186
 187         /* clz(0) is undefined */
 188         if (u == 1)
 189                 return 1;
 190
 191         /* left-shift overflow is undefined */
 192         if (__builtin_clzl(u - 1UL) < 1)
 193                 return 0;
 194
 195         return 1UL << (sizeof(u) * 8 - __builtin_clzl(u - 1UL));
 196 }
 197
 198 static inline size_t GREEDY_ALLOC_ROUND_UP(size_t l) {
 199         size_t m;
 200
 201         /* Round up allocation sizes a bit to some reasonable, likely larger value. This is supposed to be
 202          * used for cases which are likely called in an allocation loop of some form, i.e. that repetitively
 203          * grow stuff, for example strv_extend() and suchlike.
 204          *
 205          * Note the difference to GREEDY_REALLOC() here, as this helper operates on a single size value only,
 206          * and rounds up to next multiple of 2, needing no further counter.
 207          *
 208          * Note the benefits of direct ALIGN_POWER2() usage: type-safety for size_t, sane handling for very
 209          * small (i.e. <= 2) and safe handling for very large (i.e. > SSIZE_MAX) values. */
 210
 211         if (l <= 2)
 212                 return 2; /* Never allocate less than 2 of something.  */
 213
 214         m = ALIGN_POWER2(l);
 215         if (m == 0) /* overflow? */
 216                 return l;
 217
 218         return m;
 219 }
 220
 221 #ifndef __COVERITY__
 222 #  define VOID_0 ((void)0)
 223 #else
 224 #  define VOID_0 ((void*)0)
 225 #endif
 226
 227 #define ELEMENTSOF(x)                                                   \
 228         (__builtin_choose_expr(                                         \
 229                 !__builtin_types_compatible_p(typeof(x), typeof(&*(x))), \
 230                 sizeof(x)/sizeof((x)[0]),                               \
 231                 VOID_0))
 232
 233 /*
 234  * STRLEN - return the length of a string literal, minus the trailing NUL byte.
 235  *          Contrary to strlen(), this is a constant expression.
 236  * @x: a string literal.
 237  */
 238 #define STRLEN(x) (sizeof(""x"") - 1)
 239
 240 /*
 241  * container_of - cast a member of a structure out to the containing structure
 242  * @ptr: the pointer to the member.
 243  * @type: the type of the container struct this is embedded in.
 244  * @member: the name of the member within the struct.
 245  */
 246 #define container_of(ptr, type, member) __container_of(UNIQ, (ptr), type, member)
 247 #define __container_of(uniq, ptr, type, member)                         \
 248         ({                                                              \
 249                 const typeof( ((type*)0)->member ) *UNIQ_T(A, uniq) = (ptr); \
 250                 (type*)( (char *)UNIQ_T(A, uniq) - offsetof(type, member) ); \
 251         })
 252
 253 #undef MAX
 254 #define MAX(a, b) __MAX(UNIQ, (a), UNIQ, (b))
 255 #define __MAX(aq, a, bq, b)                             \
 256         ({                                              \
 257                 const typeof(a) UNIQ_T(A, aq) = (a);    \
 258                 const typeof(b) UNIQ_T(B, bq) = (b);    \
 259                 UNIQ_T(A, aq) > UNIQ_T(B, bq) ? UNIQ_T(A, aq) : UNIQ_T(B, bq); \
 260         })
 261
 262 /* evaluates to (void) if _A or _B are not constant or of different types */
 263 #define CONST_MAX(_A, _B) \
 264         (__builtin_choose_expr(                                         \
 265                 __builtin_constant_p(_A) &&                             \
 266                 __builtin_constant_p(_B) &&                             \
 267                 __builtin_types_compatible_p(typeof(_A), typeof(_B)),   \
 268                 ((_A) > (_B)) ? (_A) : (_B),                            \
 269                 VOID_0))
 270
 271 /* takes two types and returns the size of the larger one */
 272 #define MAXSIZE(A, B) (sizeof(union _packed_ { typeof(A) a; typeof(B) b; }))
 273
 274 #define MAX3(x, y, z)                                   \
 275         ({                                              \
 276                 const typeof(x) _c = MAX(x, y);         \
 277                 MAX(_c, z);                             \
 278         })
 279
 280 #undef MIN
 281 #define MIN(a, b) __MIN(UNIQ, (a), UNIQ, (b))
 282 #define __MIN(aq, a, bq, b)                             \
 283         ({                                              \
 284                 const typeof(a) UNIQ_T(A, aq) = (a);    \
 285                 const typeof(b) UNIQ_T(B, bq) = (b);    \
 286                 UNIQ_T(A, aq) < UNIQ_T(B, bq) ? UNIQ_T(A, aq) : UNIQ_T(B, bq); \
 287         })
 288
 289 #define MIN3(x, y, z)                                   \
 290         ({                                              \
 291                 const typeof(x) _c = MIN(x, y);         \
 292                 MIN(_c, z);                             \
 293         })
 294
 295 #define LESS_BY(a, b) __LESS_BY(UNIQ, (a), UNIQ, (b))
 296 #define __LESS_BY(aq, a, bq, b)                         \
 297         ({                                              \
 298                 const typeof(a) UNIQ_T(A, aq) = (a);    \
 299                 const typeof(b) UNIQ_T(B, bq) = (b);    \
 300                 UNIQ_T(A, aq) > UNIQ_T(B, bq) ? UNIQ_T(A, aq) - UNIQ_T(B, bq) : 0; \
 301         })
 302
 303 #define CMP(a, b) __CMP(UNIQ, (a), UNIQ, (b))
 304 #define __CMP(aq, a, bq, b)                             \
 305         ({                                              \
 306                 const typeof(a) UNIQ_T(A, aq) = (a);    \
 307                 const typeof(b) UNIQ_T(B, bq) = (b);    \
 308                 UNIQ_T(A, aq) < UNIQ_T(B, bq) ? -1 :    \
 309                 UNIQ_T(A, aq) > UNIQ_T(B, bq) ? 1 : 0;  \
 310         })
 311
 312 #undef CLAMP
 313 #define CLAMP(x, low, high) __CLAMP(UNIQ, (x), UNIQ, (low), UNIQ, (high))
 314 #define __CLAMP(xq, x, lowq, low, highq, high)                          \
 315         ({                                                              \
 316                 const typeof(x) UNIQ_T(X, xq) = (x);                    \
 317                 const typeof(low) UNIQ_T(LOW, lowq) = (low);            \
 318                 const typeof(high) UNIQ_T(HIGH, highq) = (high);        \
 319                         UNIQ_T(X, xq) > UNIQ_T(HIGH, highq) ?           \
 320                                 UNIQ_T(HIGH, highq) :                   \
 321                                 UNIQ_T(X, xq) < UNIQ_T(LOW, lowq) ?     \
 322                                         UNIQ_T(LOW, lowq) :             \
 323                                         UNIQ_T(X, xq);                  \
 324         })
 325
 326 /* [(x + y - 1) / y] suffers from an integer overflow, even though the
 327  * computation should be possible in the given type. Therefore, we use
 328  * [x / y + !!(x % y)]. Note that on "Real CPUs" a division returns both the
 329  * quotient and the remainder, so both should be equally fast. */
 330 #define DIV_ROUND_UP(x, y) __DIV_ROUND_UP(UNIQ, (x), UNIQ, (y))
 331 #define __DIV_ROUND_UP(xq, x, yq, y)                                    \
 332         ({                                                              \
 333                 const typeof(x) UNIQ_T(X, xq) = (x);                    \
 334                 const typeof(y) UNIQ_T(Y, yq) = (y);                    \
 335                 (UNIQ_T(X, xq) / UNIQ_T(Y, yq) + !!(UNIQ_T(X, xq) % UNIQ_T(Y, yq))); \
 336         })
 337
 338 #ifdef __COVERITY__
 339
 340 /* Use special definitions of assertion macros in order to prevent
 341  * false positives of ASSERT_SIDE_EFFECT on Coverity static analyzer
 342  * for uses of assert_se() and assert_return().
 343  *
 344  * These definitions make expression go through a (trivial) function
 345  * call to ensure they are not discarded. Also use ! or !! to ensure
 346  * the boolean expressions are seen as such.
 347  *
 348  * This technique has been described and recommended in:
 349  * https://community.synopsys.com/s/question/0D534000046Yuzb/suppressing-assertsideeffect-for-functions-that-allow-for-sideeffects
 350  */
 351
 352 extern void __coverity_panic__(void);
 353
 354 static inline void __coverity_check__(int condition) {
 355         if (!condition)
 356                 __coverity_panic__();
 357 }
 358
 359 static inline int __coverity_check_and_return__(int condition) {
 360         return condition;
 361 }
 362
 363 #define assert_message_se(expr, message) __coverity_check__(!!(expr))
 364
 365 #define assert_log(expr, message) __coverity_check_and_return__(!!(expr))
 366
 367 #else  /* ! __COVERITY__ */
 368
 369 #define assert_message_se(expr, message)                                \
 370         do {                                                            \
 371                 if (_unlikely_(!(expr)))                                \
 372                         log_assert_failed(message, PROJECT_FILE, __LINE__, __PRETTY_FUNCTION__); \
 373         } while (false)
 374
 375 #define assert_log(expr, message) ((_likely_(expr))                     \
 376         ? (true)                                                        \
 377         : (log_assert_failed_return(message, PROJECT_FILE, __LINE__, __PRETTY_FUNCTION__), false))
 378
 379 #endif  /* __COVERITY__ */
 380
 381 #define assert_se(expr) assert_message_se(expr, #expr)
 382
 383 /* We override the glibc assert() here. */
 384 #undef assert
 385 #ifdef NDEBUG
 386 #define assert(expr) do {} while (false)
 387 #else
 388 #define assert(expr) assert_message_se(expr, #expr)
 389 #endif
 390
 391 #define assert_not_reached(t)                                           \
 392         log_assert_failed_unreachable(t, PROJECT_FILE, __LINE__, __PRETTY_FUNCTION__)
 393
 394 #if defined(static_assert)
 395 #define assert_cc(expr)                                                 \
 396         static_assert(expr, #expr)
 397 #else
 398 #define assert_cc(expr)                                                 \
 399         struct CONCATENATE(_assert_struct_, __COUNTER__) {              \
 400                 char x[(expr) ? 0 : -1];                                \
 401         }
 402 #endif
 403
 404 #define assert_return(expr, r)                                          \
 405         do {                                                            \
 406                 if (!assert_log(expr, #expr))                           \
 407                         return (r);                                     \
 408         } while (false)
 409
 410 #define assert_return_errno(expr, r, err)                               \
 411         do {                                                            \
 412                 if (!assert_log(expr, #expr)) {                         \
 413                         errno = err;                                    \
 414                         return (r);                                     \
 415                 }                                                       \
 416         } while (false)
 417
 418 #define return_with_errno(r, err)                     \
 419         do {                                          \
 420                 errno = abs(err);                     \
 421                 return r;                             \
 422         } while (false)
 423
 424 #define PTR_TO_INT(p) ((int) ((intptr_t) (p)))
 425 #define INT_TO_PTR(u) ((void *) ((intptr_t) (u)))
 426 #define PTR_TO_UINT(p) ((unsigned) ((uintptr_t) (p)))
 427 #define UINT_TO_PTR(u) ((void *) ((uintptr_t) (u)))
 428
 429 #define PTR_TO_LONG(p) ((long) ((intptr_t) (p)))
 430 #define LONG_TO_PTR(u) ((void *) ((intptr_t) (u)))
 431 #define PTR_TO_ULONG(p) ((unsigned long) ((uintptr_t) (p)))
 432 #define ULONG_TO_PTR(u) ((void *) ((uintptr_t) (u)))
 433
 434 #define PTR_TO_INT32(p) ((int32_t) ((intptr_t) (p)))
 435 #define INT32_TO_PTR(u) ((void *) ((intptr_t) (u)))
 436 #define PTR_TO_UINT32(p) ((uint32_t) ((uintptr_t) (p)))
 437 #define UINT32_TO_PTR(u) ((void *) ((uintptr_t) (u)))
 438
 439 #define PTR_TO_INT64(p) ((int64_t) ((intptr_t) (p)))
 440 #define INT64_TO_PTR(u) ((void *) ((intptr_t) (u)))
 441 #define PTR_TO_UINT64(p) ((uint64_t) ((uintptr_t) (p)))
 442 #define UINT64_TO_PTR(u) ((void *) ((uintptr_t) (u)))
 443
 444 #define PTR_TO_SIZE(p) ((size_t) ((uintptr_t) (p)))
 445 #define SIZE_TO_PTR(u) ((void *) ((uintptr_t) (u)))
 446
 447 #define CHAR_TO_STR(x) ((char[2]) { x, 0 })
 448
 449 #define char_array_0(x) x[sizeof(x)-1] = 0;
 450
 451 #define sizeof_field(struct_type, member) sizeof(((struct_type *) 0)->member)
 452
 453 /* Returns the number of chars needed to format variables of the
 454  * specified type as a decimal string. Adds in extra space for a
 455  * negative '-' prefix (hence works correctly on signed
 456  * types). Includes space for the trailing NUL. */
 457 #define DECIMAL_STR_MAX(type)                                           \
 458         (2+(sizeof(type) <= 1 ? 3 :                                     \
 459             sizeof(type) <= 2 ? 5 :                                     \
 460             sizeof(type) <= 4 ? 10 :                                    \
 461             sizeof(type) <= 8 ? 20 : sizeof(int[-2*(sizeof(type) > 8)])))
 462
 463 #define DECIMAL_STR_WIDTH(x)                            \
 464         ({                                              \
 465                 typeof(x) _x_ = (x);                    \
 466                 unsigned ans = 1;                       \
 467                 while ((_x_ /= 10) != 0)                \
 468                         ans++;                          \
 469                 ans;                                    \
 470         })
 471
 472 #define UPDATE_FLAG(orig, flag, b)                      \
 473         ((b) ? ((orig) | (flag)) : ((orig) & ~(flag)))
 474 #define SET_FLAG(v, flag, b) \
 475         (v) = UPDATE_FLAG(v, flag, b)
 476 #define FLAGS_SET(v, flags) \
 477         ((~(v) & (flags)) == 0)
 478
 479 #define CASE_F(X) case X:
 480 #define CASE_F_1(CASE, X) CASE_F(X)
 481 #define CASE_F_2(CASE, X, ...)  CASE(X) CASE_F_1(CASE, __VA_ARGS__)
 482 #define CASE_F_3(CASE, X, ...)  CASE(X) CASE_F_2(CASE, __VA_ARGS__)
 483 #define CASE_F_4(CASE, X, ...)  CASE(X) CASE_F_3(CASE, __VA_ARGS__)
 484 #define CASE_F_5(CASE, X, ...)  CASE(X) CASE_F_4(CASE, __VA_ARGS__)
 485 #define CASE_F_6(CASE, X, ...)  CASE(X) CASE_F_5(CASE, __VA_ARGS__)
 486 #define CASE_F_7(CASE, X, ...)  CASE(X) CASE_F_6(CASE, __VA_ARGS__)
 487 #define CASE_F_8(CASE, X, ...)  CASE(X) CASE_F_7(CASE, __VA_ARGS__)
 488 #define CASE_F_9(CASE, X, ...)  CASE(X) CASE_F_8(CASE, __VA_ARGS__)
 489 #define CASE_F_10(CASE, X, ...) CASE(X) CASE_F_9(CASE, __VA_ARGS__)
 490 #define CASE_F_11(CASE, X, ...) CASE(X) CASE_F_10(CASE, __VA_ARGS__)
 491 #define CASE_F_12(CASE, X, ...) CASE(X) CASE_F_11(CASE, __VA_ARGS__)
 492 #define CASE_F_13(CASE, X, ...) CASE(X) CASE_F_12(CASE, __VA_ARGS__)
 493 #define CASE_F_14(CASE, X, ...) CASE(X) CASE_F_13(CASE, __VA_ARGS__)
 494 #define CASE_F_15(CASE, X, ...) CASE(X) CASE_F_14(CASE, __VA_ARGS__)
 495 #define CASE_F_16(CASE, X, ...) CASE(X) CASE_F_15(CASE, __VA_ARGS__)
 496 #define CASE_F_17(CASE, X, ...) CASE(X) CASE_F_16(CASE, __VA_ARGS__)
 497 #define CASE_F_18(CASE, X, ...) CASE(X) CASE_F_17(CASE, __VA_ARGS__)
 498 #define CASE_F_19(CASE, X, ...) CASE(X) CASE_F_18(CASE, __VA_ARGS__)
 499 #define CASE_F_20(CASE, X, ...) CASE(X) CASE_F_19(CASE, __VA_ARGS__)
 500
 501 #define GET_CASE_F(_1,_2,_3,_4,_5,_6,_7,_8,_9,_10,_11,_12,_13,_14,_15,_16,_17,_18,_19,_20,NAME,...) NAME
 502 #define FOR_EACH_MAKE_CASE(...) \
 503         GET_CASE_F(__VA_ARGS__,CASE_F_20,CASE_F_19,CASE_F_18,CASE_F_17,CASE_F_16,CASE_F_15,CASE_F_14,CASE_F_13,CASE_F_12,CASE_F_11, \
 504                                CASE_F_10,CASE_F_9,CASE_F_8,CASE_F_7,CASE_F_6,CASE_F_5,CASE_F_4,CASE_F_3,CASE_F_2,CASE_F_1) \
 505                    (CASE_F,__VA_ARGS__)
 506
 507 #define IN_SET(x, ...)                          \
 508         ({                                      \
 509                 bool _found = false;            \
 510                 /* If the build breaks in the line below, you need to extend the case macros. (We use "long double" as  \
 511                  * type for the array, in the hope that checkers such as ubsan don't complain that the initializers for \
 512                  * the array are not representable by the base type. Ideally we'd use typeof(x) as base type, but that  \
 513                  * doesn't work, as we want to use this on bitfields and gcc refuses typeof() on bitfields.) */         \
 514                 static const long double __assert_in_set[] _unused_ = { __VA_ARGS__ }; \
 515                 assert_cc(ELEMENTSOF(__assert_in_set) <= 20); \
 516                 switch(x) {                     \
 517                 FOR_EACH_MAKE_CASE(__VA_ARGS__) \
 518                         _found = true;          \
 519                         break;                  \
 520                 default:                        \
 521                         break;                  \
 522                 }                               \
 523                 _found;                         \
 524         })
 525
 526 #define SWAP_TWO(x, y) do {                        \
 527                 typeof(x) _t = (x);                \
 528                 (x) = (y);                         \
 529                 (y) = (_t);                        \
 530         } while (false)
 531
 532 /* Define C11 thread_local attribute even on older gcc compiler
 533  * version */
 534 #ifndef thread_local
 535 /*
 536  * Don't break on glibc < 2.16 that doesn't define __STDC_NO_THREADS__
 537  * see http://gcc.gnu.org/bugzilla/show_bug.cgi?id=53769
 538  */
 539 #if __STDC_VERSION__ >= 201112L && !(defined(__STDC_NO_THREADS__) || (defined(__GNU_LIBRARY__) && __GLIBC__ == 2 && __GLIBC_MINOR__ < 16))
 540 #define thread_local _Thread_local
 541 #else
 542 #define thread_local __thread
 543 #endif
 544 #endif
 545
 546 #define DEFINE_TRIVIAL_DESTRUCTOR(name, type, func)             \
 547         static inline void name(type *p) {                      \
 548                 func(p);                                        \
 549         }
 550
 551 #define DEFINE_TRIVIAL_CLEANUP_FUNC(type, func)                 \
 552         static inline void func##p(type *p) {                   \
 553                 if (*p)                                         \
 554                         func(*p);                               \
 555         }
 556
 557 #define _DEFINE_TRIVIAL_REF_FUNC(type, name, scope)             \
 558         scope type *name##_ref(type *p) {                       \
 559                 if (!p)                                         \
 560                         return NULL;                            \
 561                                                                 \
 562                 assert(p->n_ref > 0);                           \
 563                 p->n_ref++;                                     \
 564                 return p;                                       \
 565         }
 566
 567 #define _DEFINE_TRIVIAL_UNREF_FUNC(type, name, free_func, scope) \
 568         scope type *name##_unref(type *p) {                      \
 569                 if (!p)                                          \
 570                         return NULL;                             \
 571                                                                  \
 572                 assert(p->n_ref > 0);                            \
 573                 p->n_ref--;                                      \
 574                 if (p->n_ref > 0)                                \
 575                         return NULL;                             \
 576                                                                  \
 577                 return free_func(p);                             \
 578         }
 579
 580 #define DEFINE_TRIVIAL_REF_FUNC(type, name)     \
 581         _DEFINE_TRIVIAL_REF_FUNC(type, name,)
 582 #define DEFINE_PRIVATE_TRIVIAL_REF_FUNC(type, name)     \
 583         _DEFINE_TRIVIAL_REF_FUNC(type, name, static)
 584 #define DEFINE_PUBLIC_TRIVIAL_REF_FUNC(type, name)      \
 585         _DEFINE_TRIVIAL_REF_FUNC(type, name, _public_)
 586
 587 #define DEFINE_TRIVIAL_UNREF_FUNC(type, name, free_func)        \
 588         _DEFINE_TRIVIAL_UNREF_FUNC(type, name, free_func,)
 589 #define DEFINE_PRIVATE_TRIVIAL_UNREF_FUNC(type, name, free_func)        \
 590         _DEFINE_TRIVIAL_UNREF_FUNC(type, name, free_func, static)
 591 #define DEFINE_PUBLIC_TRIVIAL_UNREF_FUNC(type, name, free_func)         \
 592         _DEFINE_TRIVIAL_UNREF_FUNC(type, name, free_func, _public_)
 593
 594 #define DEFINE_TRIVIAL_REF_UNREF_FUNC(type, name, free_func)    \
 595         DEFINE_TRIVIAL_REF_FUNC(type, name);                    \
 596         DEFINE_TRIVIAL_UNREF_FUNC(type, name, free_func);
 597
 598 #define DEFINE_PRIVATE_TRIVIAL_REF_UNREF_FUNC(type, name, free_func)    \
 599         DEFINE_PRIVATE_TRIVIAL_REF_FUNC(type, name);                    \
 600         DEFINE_PRIVATE_TRIVIAL_UNREF_FUNC(type, name, free_func);
 601
 602 #define DEFINE_PUBLIC_TRIVIAL_REF_UNREF_FUNC(type, name, free_func)    \
 603         DEFINE_PUBLIC_TRIVIAL_REF_FUNC(type, name);                    \
 604         DEFINE_PUBLIC_TRIVIAL_UNREF_FUNC(type, name, free_func);
 605
 606 /* A macro to force copying of a variable from memory. This is useful whenever we want to read something from
 607  * memory and want to make sure the compiler won't optimize away the destination variable for us. It's not
 608  * supposed to be a full CPU memory barrier, i.e. CPU is still allowed to reorder the reads, but it is not
 609  * allowed to remove our local copies of the variables. We want this to work for unaligned memory, hence
 610  * memcpy() is great for our purposes. */
 611 #define READ_NOW(x)                                                     \
 612         ({                                                              \
 613                 typeof(x) _copy;                                        \
 614                 memcpy(&_copy, &(x), sizeof(_copy));                    \
 615                 asm volatile ("" : : : "memory");                       \
 616                 _copy;                                                  \
 617         })
 618
 619 #include "log.h"