src/shared/macro.h

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   2
   3 #ifndef foomacrohfoo
   4 #define foomacrohfoo
   5
   6 /***
   7   This file is part of systemd.
   8
   9   Copyright 2010 Lennart Poettering
  10
  11   systemd is free software; you can redistribute it and/or modify it
  12   under the terms of the GNU Lesser General Public License as published by
  13   the Free Software Foundation; either version 2.1 of the License, or
  14   (at your option) any later version.
  15
  16   systemd is distributed in the hope that it will be useful, but
  17   WITHOUT ANY WARRANTY; without even the implied warranty of
  18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19   Lesser General Public License for more details.
  20
  21   You should have received a copy of the GNU Lesser General Public License
  22   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  23 ***/
  24
  25 #include <assert.h>
  26 #include <sys/param.h>
  27 #include <sys/types.h>
  28 #include <sys/uio.h>
  29 #include <inttypes.h>
  30
  31 #define _printf_attr_(a,b) __attribute__ ((format (printf, a, b)))
  32 #define _sentinel_ __attribute__ ((sentinel))
  33 #define _noreturn_ __attribute__((noreturn))
  34 #define _unused_ __attribute__ ((unused))
  35 #define _destructor_ __attribute__ ((destructor))
  36 #define _pure_ __attribute__ ((pure))
  37 #define _const_ __attribute__ ((const))
  38 #define _deprecated_ __attribute__ ((deprecated))
  39 #define _packed_ __attribute__ ((packed))
  40 #define _malloc_ __attribute__ ((malloc))
  41 #define _weak_ __attribute__ ((weak))
  42 #define _likely_(x) (__builtin_expect(!!(x),1))
  43 #define _unlikely_(x) (__builtin_expect(!!(x),0))
  44 #define _public_ __attribute__ ((visibility("default")))
  45 #define _hidden_ __attribute__ ((visibility("hidden")))
  46 #define _weakref_(x) __attribute__((weakref(#x)))
  47 #define _introspect_(x) __attribute__((section("introspect." 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 #ifndef MAX
  61 #define MAX(a,b)                                \
  62         __extension__ ({                        \
  63                         typeof(a) _a = (a);     \
  64                         typeof(b) _b = (b);     \
  65                         _a > _b ? _a : _b;      \
  66                 })
  67 #endif
  68
  69 #define MAX3(a,b,c)                             \
  70         MAX(MAX(a,b),c)
  71
  72 #ifndef MIN
  73 #define MIN(a,b)                                \
  74         __extension__ ({                        \
  75                         typeof(a) _a = (a);     \
  76                         typeof(b) _b = (b);     \
  77                         _a < _b ? _a : _b;      \
  78                 })
  79 #endif
  80
  81 #define MIN3(a,b,c)                             \
  82         MIN(MIN(a,b),c)
  83
  84 #define CLAMP(x, low, high)                                             \
  85         __extension__ ({                                                \
  86                         typeof(x) _x = (x);                             \
  87                         typeof(low) _low = (low);                       \
  88                         typeof(high) _high = (high);                    \
  89                         ((_x > _high) ? _high : ((_x < _low) ? _low : _x)); \
  90                 })
  91
  92 #define assert_se(expr)                                                 \
  93         do {                                                            \
  94                 if (_unlikely_(!(expr)))                                \
  95                         log_assert_failed(#expr, __FILE__, __LINE__, __PRETTY_FUNCTION__); \
  96         } while (false)                                                 \
  97
  98 /* We override the glibc assert() here. */
  99 #undef assert
 100 #ifdef NDEBUG
 101 #define assert(expr) do {} while(false)
 102 #else
 103 #define assert(expr) assert_se(expr)
 104 #endif
 105
 106 #define assert_not_reached(t)                                           \
 107         do {                                                            \
 108                 log_assert_failed_unreachable(t, __FILE__, __LINE__, __PRETTY_FUNCTION__); \
 109         } while (false)
 110
 111 #define assert_cc(expr)                            \
 112         do {                                       \
 113                 switch (0) {                       \
 114                         case 0:                    \
 115                         case !!(expr):             \
 116                                 ;                  \
 117                 }                                  \
 118         } while (false)
 119
 120 #define PTR_TO_UINT(p) ((unsigned int) ((uintptr_t) (p)))
 121 #define UINT_TO_PTR(u) ((void*) ((uintptr_t) (u)))
 122
 123 #define PTR_TO_UINT32(p) ((uint32_t) ((uintptr_t) (p)))
 124 #define UINT32_TO_PTR(u) ((void*) ((uintptr_t) (u)))
 125
 126 #define PTR_TO_ULONG(p) ((unsigned long) ((uintptr_t) (p)))
 127 #define ULONG_TO_PTR(u) ((void*) ((uintptr_t) (u)))
 128
 129 #define PTR_TO_INT(p) ((int) ((intptr_t) (p)))
 130 #define INT_TO_PTR(u) ((void*) ((intptr_t) (u)))
 131
 132 #define TO_INT32(p) ((int32_t) ((intptr_t) (p)))
 133 #define INT32_TO_PTR(u) ((void*) ((intptr_t) (u)))
 134
 135 #define PTR_TO_LONG(p) ((long) ((intptr_t) (p)))
 136 #define LONG_TO_PTR(u) ((void*) ((intptr_t) (u)))
 137
 138 #define memzero(x,l) (memset((x), 0, (l)))
 139 #define zero(x) (memzero(&(x), sizeof(x)))
 140
 141 #define char_array_0(x) x[sizeof(x)-1] = 0;
 142
 143 #define IOVEC_SET_STRING(i, s)                  \
 144         do {                                    \
 145                 struct iovec *_i = &(i);        \
 146                 char *_s = (char *)(s);         \
 147                 _i->iov_base = _s;              \
 148                 _i->iov_len = strlen(_s);       \
 149         } while(false)
 150
 151 static inline size_t IOVEC_TOTAL_SIZE(const struct iovec *i, unsigned n) {
 152         unsigned j;
 153         size_t r = 0;
 154
 155         for (j = 0; j < n; j++)
 156                 r += i[j].iov_len;
 157
 158         return r;
 159 }
 160
 161 static inline size_t IOVEC_INCREMENT(struct iovec *i, unsigned n, size_t k) {
 162         unsigned j;
 163
 164         for (j = 0; j < n; j++) {
 165                 size_t sub;
 166
 167                 if (_unlikely_(k <= 0))
 168                         break;
 169
 170                 sub = MIN(i[j].iov_len, k);
 171                 i[j].iov_len -= sub;
 172                 i[j].iov_base = (uint8_t*) i[j].iov_base + sub;
 173                 k -= sub;
 174         }
 175
 176         return k;
 177 }
 178
 179 #include "log.h"
 180
 181 #endif