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