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 #define CLAMP(x, low, high)                                             \
  96         __extension__ ({                                                \
  97                         typeof(x) _x = (x);                             \
  98                         typeof(low) _low = (low);                       \
  99                         typeof(high) _high = (high);                    \
 100                         ((_x > _high) ? _high : ((_x < _low) ? _low : _x)); \
 101                 })
 102
 103 #define assert_se(expr)                                                 \
 104         do {                                                            \
 105                 if (_unlikely_(!(expr)))                                \
 106                         log_assert_failed(#expr, __FILE__, __LINE__, __PRETTY_FUNCTION__); \
 107         } while (false)                                                 \
 108
 109 /* We override the glibc assert() here. */
 110 #undef assert
 111 #ifdef NDEBUG
 112 #define assert(expr) do {} while(false)
 113 #else
 114 #define assert(expr) assert_se(expr)
 115 #endif
 116
 117 #define assert_not_reached(t)                                           \
 118         do {                                                            \
 119                 log_assert_failed_unreachable(t, __FILE__, __LINE__, __PRETTY_FUNCTION__); \
 120         } while (false)
 121
 122 #define assert_cc(expr)                            \
 123         do {                                       \
 124                 switch (0) {                       \
 125                         case 0:                    \
 126                         case !!(expr):             \
 127                                 ;                  \
 128                 }                                  \
 129         } while (false)
 130
 131 #define PTR_TO_UINT(p) ((unsigned int) ((uintptr_t) (p)))
 132 #define UINT_TO_PTR(u) ((void*) ((uintptr_t) (u)))
 133
 134 #define PTR_TO_UINT32(p) ((uint32_t) ((uintptr_t) (p)))
 135 #define UINT32_TO_PTR(u) ((void*) ((uintptr_t) (u)))
 136
 137 #define PTR_TO_ULONG(p) ((unsigned long) ((uintptr_t) (p)))
 138 #define ULONG_TO_PTR(u) ((void*) ((uintptr_t) (u)))
 139
 140 #define PTR_TO_INT(p) ((int) ((intptr_t) (p)))
 141 #define INT_TO_PTR(u) ((void*) ((intptr_t) (u)))
 142
 143 #define TO_INT32(p) ((int32_t) ((intptr_t) (p)))
 144 #define INT32_TO_PTR(u) ((void*) ((intptr_t) (u)))
 145
 146 #define PTR_TO_LONG(p) ((long) ((intptr_t) (p)))
 147 #define LONG_TO_PTR(u) ((void*) ((intptr_t) (u)))
 148
 149 #define memzero(x,l) (memset((x), 0, (l)))
 150 #define zero(x) (memzero(&(x), sizeof(x)))
 151
 152 #define char_array_0(x) x[sizeof(x)-1] = 0;
 153
 154 #define IOVEC_SET_STRING(i, s)                  \
 155         do {                                    \
 156                 struct iovec *_i = &(i);        \
 157                 char *_s = (char *)(s);         \
 158                 _i->iov_base = _s;              \
 159                 _i->iov_len = strlen(_s);       \
 160         } while(false)
 161
 162 static inline size_t IOVEC_TOTAL_SIZE(const struct iovec *i, unsigned n) {
 163         unsigned j;
 164         size_t r = 0;
 165
 166         for (j = 0; j < n; j++)
 167                 r += i[j].iov_len;
 168
 169         return r;
 170 }
 171
 172 static inline size_t IOVEC_INCREMENT(struct iovec *i, unsigned n, size_t k) {
 173         unsigned j;
 174
 175         for (j = 0; j < n; j++) {
 176                 size_t sub;
 177
 178                 if (_unlikely_(k <= 0))
 179                         break;
 180
 181                 sub = MIN(i[j].iov_len, k);
 182                 i[j].iov_len -= sub;
 183                 i[j].iov_base = (uint8_t*) i[j].iov_base + sub;
 184                 k -= sub;
 185         }
 186
 187         return k;
 188 }
 189
 190 #define _cleanup_free_ __attribute__((cleanup(freep)))
 191 #define _cleanup_fclose_ __attribute__((cleanup(fclosep)))
 192 #define _cleanup_close_ __attribute__((cleanup(closep)))
 193 #define _cleanup_closedir_ __attribute__((cleanup(closedirp)))
 194 #define _cleanup_umask_ __attribute__((cleanup(umaskp)))
 195
 196 #include "log.h"