src/pulsecore/macro.h

   1 #ifndef foopulsemacrohfoo
   2 #define foopulsemacrohfoo
   3
   4 /* $Id$ */
   5
   6 /***
   7   This file is part of PulseAudio.
   8
   9   Copyright 2004-2006 Lennart Poettering
  10
  11   PulseAudio is free software; you can redistribute it and/or modify
  12   it under the terms of the GNU Lesser General Public License as published
  13   by the Free Software Foundation; either version 2 of the License,
  14   or (at your option) any later version.
  15
  16   PulseAudio 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 Lesser General Public License
  22   along with PulseAudio; if not, write to the Free Software
  23   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  24   USA.
  25 ***/
  26
  27 #include <sys/types.h>
  28 #include <unistd.h>
  29 #include <assert.h>
  30 #include <limits.h>
  31 #include <unistd.h>
  32 #include <stdio.h>
  33 #include <stdlib.h>
  34
  35 #include <pulsecore/log.h>
  36 #include <pulsecore/gccmacro.h>
  37
  38 #ifndef PACKAGE
  39 #error "Please include config.h before including this file!"
  40 #endif
  41
  42 #if defined(PAGE_SIZE)
  43 #define PA_PAGE_SIZE ((size_t) PAGE_SIZE)
  44 #elif defined(PAGESIZE)
  45 #define PA_PAGE_SIZE ((size_t) PAGESIZE)
  46 #elif defined(HAVE_SYSCONF)
  47 #define PA_PAGE_SIZE ((size_t) (sysconf(_SC_PAGE_SIZE)))
  48 #else
  49 /* Let's hope it's like x86. */
  50 #define PA_PAGE_SIZE ((size_t) 4096)
  51 #endif
  52
  53 static inline size_t pa_align(size_t l) {
  54     return (((l + sizeof(void*) - 1) / sizeof(void*)) * sizeof(void*));
  55 }
  56 #define PA_ALIGN(x) (pa_align(x))
  57
  58 static inline void* pa_page_align_ptr(const void *p) {
  59     return (void*) (((size_t) p) & ~(PA_PAGE_SIZE-1));
  60 }
  61 #define PA_PAGE_ALIGN_PTR(x) (pa_page_align_ptr(x))
  62
  63 static inline size_t pa_page_align(size_t l) {
  64     return l & ~(PA_PAGE_SIZE-1);
  65 }
  66 #define PA_PAGE_ALIGN(x) (pa_page_align(x))
  67
  68 #define PA_ELEMENTSOF(x) (sizeof(x)/sizeof((x)[0]))
  69
  70 /* The users of PA_MIN and PA_MAX should be aware that these macros on
  71  * non-GCC executed code with side effects twice. It is thus
  72  * considered misuse to use code with side effects as arguments to MIN
  73  * and MAX. */
  74
  75 #ifdef __GNUC__
  76 #define PA_MAX(a,b)                             \
  77     __extension__ ({ typeof(a) _a = (a);        \
  78             typeof(b) _b = (b);                 \
  79             _a > _b ? _a : _b;                  \
  80         })
  81 #else
  82 #define PA_MAX(a, b) ((a) > (b) ? (a) : (b))
  83 #endif
  84
  85 #ifdef __GNUC__
  86 #define PA_MIN(a,b)                             \
  87     __extension__ ({ typeof(a) _a = (a);        \
  88             typeof(b) _b = (b);                 \
  89             _a < _b ? _a : _b;                  \
  90         })
  91 #else
  92 #define PA_MIN(a, b) ((a) < (b) ? (a) : (b))
  93 #endif
  94
  95 #ifdef __GNUC__
  96 #define PA_CLAMP(x, low, high)                                          \
  97     __extension__ ({ typeof(x) _x = (x);                                \
  98             typeof(low) _low = (low);                                   \
  99             typeof(high) _high = (high);                                \
 100             ((_x > _high) ? _high : ((_x < _low) ? _low : _x));         \
 101         })
 102 #else
 103 #define PA_CLAMP(x, low, high) (((x) > (high)) ? (high) : (((x) < (low)) ? (low) : (x)))
 104 #endif
 105
 106 #ifdef __GNUC__
 107 #define PA_CLAMP_UNLIKELY(x, low, high)                                 \
 108     __extension__ ({ typeof(x) _x = (x);                                \
 109             typeof(low) _low = (low);                                   \
 110             typeof(high) _high = (high);                                \
 111             (PA_UNLIKELY(_x > _high) ? _high : (PA_UNLIKELY(_x < _low) ? _low : _x)); \
 112         })
 113 #else
 114 #define PA_CLAMP_UNLIKELY(x, low, high) (PA_UNLIKELY((x) > (high)) ? (high) : (PA_UNLIKELY((x) < (low)) ? (low) : (x)))
 115 #endif
 116
 117 /* We don't define a PA_CLAMP_LIKELY here, because it doesn't really
 118  * make sense: we cannot know if it is more likely that the values is
 119  * lower or greater than the boundaries.*/
 120
 121 /* This type is not intended to be used in exported APIs! Use classic "int" there! */
 122 #ifdef HAVE_STD_BOOL
 123 typedef _Bool pa_bool_t;
 124 #else
 125 typedef int pa_bool_t;
 126 #endif
 127
 128 #ifndef FALSE
 129 #define FALSE ((pa_bool_t) 0)
 130 #endif
 131
 132 #ifndef TRUE
 133 #define TRUE (!FALSE)
 134 #endif
 135
 136 #ifdef __GNUC__
 137 #define PA_PRETTY_FUNCTION __PRETTY_FUNCTION__
 138 #else
 139 #define PA_PRETTY_FUNCTION ""
 140 #endif
 141
 142 #define pa_return_if_fail(expr)                                         \
 143     do {                                                                \
 144         if (PA_UNLIKELY(!(expr))) {                                     \
 145             pa_log_debug("Assertion '%s' failed at %s:%u, function %s.\n", #expr , __FILE__, __LINE__, PA_PRETTY_FUNCTION); \
 146             return;                                                     \
 147         }                                                               \
 148     } while(FALSE)
 149
 150 #define pa_return_val_if_fail(expr, val)                                \
 151     do {                                                                \
 152         if (PA_UNLIKELY(!(expr))) {                                     \
 153             pa_log_debug("Assertion '%s' failed at %s:%u, function %s.\n", #expr , __FILE__, __LINE__, PA_PRETTY_FUNCTION); \
 154             return (val);                                               \
 155         }                                                               \
 156     } while(FALSE)
 157
 158 #define pa_return_null_if_fail(expr) pa_return_val_if_fail(expr, NULL)
 159
 160 /* An assert which guarantees side effects of x, i.e. is never
 161  * optimized away */
 162 #define pa_assert_se(expr)                                              \
 163     do {                                                                \
 164         if (PA_UNLIKELY(!(expr))) {                                     \
 165             pa_log_error("Assertion '%s' failed at %s:%u, function %s(). Aborting.", #expr , __FILE__, __LINE__, PA_PRETTY_FUNCTION); \
 166             abort();                                                    \
 167         }                                                               \
 168     } while (FALSE)
 169
 170 /* An assert that may be optimized away by defining NDEBUG */
 171 #ifdef NDEBUG
 172 #define pa_assert(expr) do {} while (FALSE)
 173 #else
 174 #define pa_assert(expr) pa_assert_se(expr)
 175 #endif
 176
 177 #define pa_assert_not_reached()                                         \
 178     do {                                                                \
 179         pa_log_error("Code should not be reached at %s:%u, function %s(). Aborting.", __FILE__, __LINE__, PA_PRETTY_FUNCTION); \
 180         abort();                                                        \
 181     } while (FALSE)
 182
 183 #define PA_PTR_TO_UINT(p) ((unsigned int) (unsigned long) (p))
 184 #define PA_UINT_TO_PTR(u) ((void*) (unsigned long) (u))
 185
 186 #define PA_PTR_TO_UINT32(p) ((uint32_t) PA_PTR_TO_UINT(p))
 187 #define PA_UINT32_TO_PTR(u) PA_UINT_TO_PTR((uint32_t) u)
 188
 189 #define PA_PTR_TO_INT(p) ((int) PA_PTR_TO_UINT(p))
 190 #define PA_INT_TO_PTR(u) PA_UINT_TO_PTR((int) u)
 191
 192 #define PA_PTR_TO_INT32(p) ((int32_t) PA_PTR_TO_UINT(p))
 193 #define PA_INT32_TO_PTR(u) PA_UINT_TO_PTR((int32_t) u)
 194
 195 #ifdef OS_IS_WIN32
 196 #define PA_PATH_SEP "\\"
 197 #define PA_PATH_SEP_CHAR '\\'
 198 #else
 199 #define PA_PATH_SEP "/"
 200 #define PA_PATH_SEP_CHAR '/'
 201 #endif
 202
 203 static inline const char *pa_strnull(const char *x) {
 204     return x ? x : "(null)";
 205 }
 206
 207 #endif