src/shared/macro.h

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   2
   3 #pragma once
   4
   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
  11   under the terms of the GNU Lesser General Public License as published by
  12   the Free Software Foundation; either version 2.1 of the License, or
  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
  18   Lesser General Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public License
  21   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  22 ***/
  23
  24 #include <assert.h>
  25 #include <sys/param.h>
  26 #include <sys/types.h>
  27 #include <sys/uio.h>
  28 #include <inttypes.h>
  29
  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))
  43 #define _public_ __attribute__ ((visibility("default")))
  44 #define _hidden_ __attribute__ ((visibility("hidden")))
  45 #define _weakref_(x) __attribute__((weakref(#x)))
  46 #define _introspect_(x) __attribute__((section("introspect." x)))
  47 #define _alignas_(x) __attribute__((aligned(__alignof(x))))
  48
  49 /* automake test harness */
  50 #define EXIT_TEST_SKIP 77
  51
  52 #define XSTRINGIFY(x) #x
  53 #define STRINGIFY(x) XSTRINGIFY(x)
  54
  55 /* Rounds up */
  56 #define ALIGN(l) ALIGN_TO((l), sizeof(void*))
  57 static inline size_t ALIGN_TO(size_t l, size_t ali) {
  58         return ((l + ali - 1) & ~(ali - 1));
  59 }
  60
  61 #define ELEMENTSOF(x) (sizeof(x)/sizeof((x)[0]))
  62
  63 /*
  64  * container_of - cast a member of a structure out to the containing structure
  65  * @ptr: the pointer to the member.
  66  * @type: the type of the container struct this is embedded in.
  67  * @member: the name of the member within the struct.
  68  *
  69  */
  70 #define container_of(ptr, type, member)                                 \
  71         __extension__ ({                                                \
  72                         const typeof( ((type *)0)->member ) *__mptr = (ptr); \
  73                         (type *)( (char *)__mptr - offsetof(type,member) ); \
  74                 })
  75
  76 #undef MAX
  77 #define MAX(a,b)                                 \
  78         __extension__ ({                         \
  79                         typeof(a) _a = (a);      \
  80                         typeof(b) _b = (b);      \
  81                         _a > _b ? _a : _b;       \
  82                 })
  83
  84 #define MAX3(x,y,z)                              \
  85         __extension__ ({                         \
  86                         typeof(x) _c = MAX(x,y); \
  87                         MAX(_c, z);              \
  88                 })
  89
  90 #undef MIN
  91 #define MIN(a,b)                                \
  92         __extension__ ({                        \
  93                         typeof(a) _a = (a);     \
  94                         typeof(b) _b = (b);     \
  95                         _a < _b ? _a : _b;      \
  96                 })
  97
  98 #ifndef CLAMP
  99 #define CLAMP(x, low, high)                                             \
 100         __extension__ ({                                                \
 101                         typeof(x) _x = (x);                             \
 102                         typeof(low) _low = (low);                       \
 103                         typeof(high) _high = (high);                    \
 104                         ((_x > _high) ? _high : ((_x < _low) ? _low : _x)); \
 105                 })
 106 #endif
 107
 108 #define assert_se(expr)                                                 \
 109         do {                                                            \
 110                 if (_unlikely_(!(expr)))                                \
 111                         log_assert_failed(#expr, __FILE__, __LINE__, __PRETTY_FUNCTION__); \
 112         } while (false)                                                 \
 113
 114 /* We override the glibc assert() here. */
 115 #undef assert
 116 #ifdef NDEBUG
 117 #define assert(expr) do {} while(false)
 118 #else
 119 #define assert(expr) assert_se(expr)
 120 #endif
 121
 122 #define assert_not_reached(t)                                           \
 123         do {                                                            \
 124                 log_assert_failed_unreachable(t, __FILE__, __LINE__, __PRETTY_FUNCTION__); \
 125         } while (false)
 126
 127 #if defined(static_assert)
 128 #define assert_cc(expr)                         \
 129         do {                                    \
 130                 static_assert(expr, #expr);     \
 131         } while (false)
 132 #else
 133 #define assert_cc(expr)                         \
 134         do {                                    \
 135                 switch (0) {                    \
 136                 case 0:                         \
 137                 case !!(expr):                  \
 138                         ;                       \
 139                 }                               \
 140         } while (false)
 141 #endif
 142
 143 #define PTR_TO_UINT(p) ((unsigned int) ((uintptr_t) (p)))
 144 #define UINT_TO_PTR(u) ((void*) ((uintptr_t) (u)))
 145
 146 #define PTR_TO_UINT32(p) ((uint32_t) ((uintptr_t) (p)))
 147 #define UINT32_TO_PTR(u) ((void*) ((uintptr_t) (u)))
 148
 149 #define PTR_TO_ULONG(p) ((unsigned long) ((uintptr_t) (p)))
 150 #define ULONG_TO_PTR(u) ((void*) ((uintptr_t) (u)))
 151
 152 #define PTR_TO_INT(p) ((int) ((intptr_t) (p)))
 153 #define INT_TO_PTR(u) ((void*) ((intptr_t) (u)))
 154
 155 #define TO_INT32(p) ((int32_t) ((intptr_t) (p)))
 156 #define INT32_TO_PTR(u) ((void*) ((intptr_t) (u)))
 157
 158 #define PTR_TO_LONG(p) ((long) ((intptr_t) (p)))
 159 #define LONG_TO_PTR(u) ((void*) ((intptr_t) (u)))
 160
 161 #define memzero(x,l) (memset((x), 0, (l)))
 162 #define zero(x) (memzero(&(x), sizeof(x)))
 163
 164 #define CHAR_TO_STR(x) ((char[2]) { x, 0 })
 165
 166 #define char_array_0(x) x[sizeof(x)-1] = 0;
 167
 168 #define IOVEC_SET_STRING(i, s)                  \
 169         do {                                    \
 170                 struct iovec *_i = &(i);        \
 171                 char *_s = (char *)(s);         \
 172                 _i->iov_base = _s;              \
 173                 _i->iov_len = strlen(_s);       \
 174         } while(false)
 175
 176 static inline size_t IOVEC_TOTAL_SIZE(const struct iovec *i, unsigned n) {
 177         unsigned j;
 178         size_t r = 0;
 179
 180         for (j = 0; j < n; j++)
 181                 r += i[j].iov_len;
 182
 183         return r;
 184 }
 185
 186 static inline size_t IOVEC_INCREMENT(struct iovec *i, unsigned n, size_t k) {
 187         unsigned j;
 188
 189         for (j = 0; j < n; j++) {
 190                 size_t sub;
 191
 192                 if (_unlikely_(k <= 0))
 193                         break;
 194
 195                 sub = MIN(i[j].iov_len, k);
 196                 i[j].iov_len -= sub;
 197                 i[j].iov_base = (uint8_t*) i[j].iov_base + sub;
 198                 k -= sub;
 199         }
 200
 201         return k;
 202 }
 203
 204 #define _cleanup_free_ __attribute__((cleanup(freep)))
 205 #define _cleanup_fclose_ __attribute__((cleanup(fclosep)))
 206 #define _cleanup_pclose_ __attribute__((cleanup(pclosep)))
 207 #define _cleanup_close_ __attribute__((cleanup(closep)))
 208 #define _cleanup_closedir_ __attribute__((cleanup(closedirp)))
 209 #define _cleanup_umask_ __attribute__((cleanup(umaskp)))
 210 #define _cleanup_set_free_ __attribute__((cleanup(set_freep)))
 211 #define _cleanup_set_free_free_ __attribute__((cleanup(set_free_freep)))
 212 #define _cleanup_strv_free_ __attribute__((cleanup(strv_freep)))
 213 #define _cleanup_journal_close_ __attribute__((cleanup(journal_closep)))
 214
 215 #define VA_FORMAT_ADVANCE(format, ap)                                   \
 216 do {                                                                    \
 217         int _argtypes[128];                                             \
 218         size_t _i, _k;                                                  \
 219         _k = parse_printf_format((format), ELEMENTSOF(_argtypes), _argtypes); \
 220         assert(_k < ELEMENTSOF(_argtypes));                             \
 221         for (_i = 0; _i < _k; _i++) {                                   \
 222                 if (_argtypes[_i] & PA_FLAG_PTR)  {                     \
 223                         (void) va_arg(ap, void*);                       \
 224                         continue;                                       \
 225                 }                                                       \
 226                                                                         \
 227                 switch (_argtypes[_i]) {                                \
 228                 case PA_INT:                                            \
 229                 case PA_INT|PA_FLAG_SHORT:                              \
 230                 case PA_CHAR:                                           \
 231                         (void) va_arg(ap, int);                         \
 232                         break;                                          \
 233                 case PA_INT|PA_FLAG_LONG:                               \
 234                         (void) va_arg(ap, long int);                    \
 235                         break;                                          \
 236                 case PA_INT|PA_FLAG_LONG_LONG:                          \
 237                         (void) va_arg(ap, long long int);               \
 238                         break;                                          \
 239                 case PA_WCHAR:                                          \
 240                         (void) va_arg(ap, wchar_t);                     \
 241                         break;                                          \
 242                 case PA_WSTRING:                                        \
 243                 case PA_STRING:                                         \
 244                 case PA_POINTER:                                        \
 245                         (void) va_arg(ap, void*);                       \
 246                         break;                                          \
 247                 case PA_FLOAT:                                          \
 248                 case PA_DOUBLE:                                         \
 249                         (void) va_arg(ap, double);                      \
 250                         break;                                          \
 251                 case PA_DOUBLE|PA_FLAG_LONG_DOUBLE:                     \
 252                         (void) va_arg(ap, long double);                 \
 253                         break;                                          \
 254                 default:                                                \
 255                         assert_not_reached("Unknown format string argument."); \
 256                 }                                                       \
 257         }                                                               \
 258 } while(false)
 259
 260 /* Returns the number of chars needed to format variables of the
 261  * specified type as a decimal string. Adds in extra space for a
 262  * negative '-' prefix. */
 263
 264 #define DECIMAL_STR_MAX(type)                                           \
 265         (1+(sizeof(type) <= 1 ? 3 :                                     \
 266             sizeof(type) <= 2 ? 5 :                                     \
 267             sizeof(type) <= 4 ? 10 :                                    \
 268             sizeof(type) <= 8 ? 20 : sizeof(int[-2*(sizeof(type) > 8)])))
 269
 270 #include "log.h"