src/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 General Public License as published by
  13   the Free Software Foundation; either version 2 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   General Public License for more details.
  20
  21   You should have received a copy of the GNU General Public License
  22   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  23 ***/
  24
  25 #include <assert.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
  48 #define XSTRINGIFY(x) #x
  49 #define STRINGIFY(x) XSTRINGIFY(x)
  50
  51 /* Rounds up */
  52 #define ALIGN(l) ALIGN_TO((l), sizeof(void*))
  53 static inline size_t ALIGN_TO(size_t l, size_t ali) {
  54         return ((l + ali - 1) & ~(ali - 1));
  55 }
  56
  57 #define ELEMENTSOF(x) (sizeof(x)/sizeof((x)[0]))
  58
  59 #ifndef MAX
  60 #define MAX(a,b)                                \
  61         __extension__ ({                        \
  62                         typeof(a) _a = (a);     \
  63                         typeof(b) _b = (b);     \
  64                         _a > _b ? _a : _b;      \
  65                 })
  66 #endif
  67
  68 #define MAX3(a,b,c)                             \
  69         MAX(MAX(a,b),c)
  70
  71 #ifndef MIN
  72 #define MIN(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 MIN3(a,b,c)                             \
  81         MIN(MIN(a,b),c)
  82
  83 #define CLAMP(x, low, high)                                             \
  84         __extension__ ({                                                \
  85                         typeof(x) _x = (x);                             \
  86                         typeof(low) _low = (low);                       \
  87                         typeof(high) _high = (high);                    \
  88                         ((_x > _high) ? _high : ((_x < _low) ? _low : _x)); \
  89                 })
  90
  91 #define assert_se(expr)                                                 \
  92         do {                                                            \
  93                 if (_unlikely_(!(expr)))                                \
  94                         log_assert(__FILE__, __LINE__, __PRETTY_FUNCTION__, \
  95                                    "Assertion '%s' failed at %s:%u, function %s(). Aborting.", \
  96                                    #expr , __FILE__, __LINE__, __PRETTY_FUNCTION__); \
  97         } while (false)                                                 \
  98
  99 /* We override the glibc assert() here. */
 100 #undef assert
 101 #ifdef NDEBUG
 102 #define assert(expr) do {} while(false)
 103 #else
 104 #define assert(expr) assert_se(expr)
 105 #endif
 106
 107 #define assert_not_reached(t)                                           \
 108         do {                                                            \
 109                 log_assert(__FILE__, __LINE__, __PRETTY_FUNCTION__,     \
 110                            "Code should not be reached '%s' at %s:%u, function %s(). Aborting.", \
 111                            t, __FILE__, __LINE__, __PRETTY_FUNCTION__); \
 112         } while (false)
 113
 114 #define assert_cc(expr)                            \
 115         do {                                       \
 116                 switch (0) {                       \
 117                         case 0:                    \
 118                         case !!(expr):             \
 119                                 ;                  \
 120                 }                                  \
 121         } while (false)
 122
 123 #define PTR_TO_UINT(p) ((unsigned int) ((uintptr_t) (p)))
 124 #define UINT_TO_PTR(u) ((void*) ((uintptr_t) (u)))
 125
 126 #define PTR_TO_UINT32(p) ((uint32_t) ((uintptr_t) (p)))
 127 #define UINT32_TO_PTR(u) ((void*) ((uintptr_t) (u)))
 128
 129 #define PTR_TO_ULONG(p) ((unsigned long) ((uintptr_t) (p)))
 130 #define ULONG_TO_PTR(u) ((void*) ((uintptr_t) (u)))
 131
 132 #define PTR_TO_INT(p) ((int) ((intptr_t) (p)))
 133 #define INT_TO_PTR(u) ((void*) ((intptr_t) (u)))
 134
 135 #define TO_INT32(p) ((int32_t) ((intptr_t) (p)))
 136 #define INT32_TO_PTR(u) ((void*) ((intptr_t) (u)))
 137
 138 #define PTR_TO_LONG(p) ((long) ((intptr_t) (p)))
 139 #define LONG_TO_PTR(u) ((void*) ((intptr_t) (u)))
 140
 141 #define memzero(x,l) (memset((x), 0, (l)))
 142 #define zero(x) (memzero(&(x), sizeof(x)))
 143
 144 #define char_array_0(x) x[sizeof(x)-1] = 0;
 145
 146 #define IOVEC_SET_STRING(i, s)                  \
 147         do {                                    \
 148                 struct iovec *_i = &(i);        \
 149                 char *_s = (char *)(s);         \
 150                 _i->iov_base = _s;              \
 151                 _i->iov_len = strlen(_s);       \
 152         } while(false);
 153
 154 static inline size_t IOVEC_TOTAL_SIZE(const struct iovec *i, unsigned n) {
 155         unsigned j;
 156         size_t r = 0;
 157
 158         for (j = 0; j < n; j++)
 159                 r += i[j].iov_len;
 160
 161         return r;
 162 }
 163
 164 static inline size_t IOVEC_INCREMENT(struct iovec *i, unsigned n, size_t k) {
 165         unsigned j;
 166
 167         for (j = 0; j < n; j++) {
 168                 size_t sub;
 169
 170                 if (_unlikely_(k <= 0))
 171                         break;
 172
 173                 sub = MIN(i[j].iov_len, k);
 174                 i[j].iov_len -= sub;
 175                 i[j].iov_base = (uint8_t*) i[j].iov_base + sub;
 176                 k -= sub;
 177         }
 178
 179         return k;
 180 }
 181
 182 #include "log.h"
 183
 184 #endif