src/vppinfra/clib.h

   1 /*
   2  * Copyright (c) 2015 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15 /*
  16   Copyright (c) 2001, 2002, 2003 Eliot Dresselhaus
  17
  18   Permission is hereby granted, free of charge, to any person obtaining
  19   a copy of this software and associated documentation files (the
  20   "Software"), to deal in the Software without restriction, including
  21   without limitation the rights to use, copy, modify, merge, publish,
  22   distribute, sublicense, and/or sell copies of the Software, and to
  23   permit persons to whom the Software is furnished to do so, subject to
  24   the following conditions:
  25
  26   The above copyright notice and this permission notice shall be
  27   included in all copies or substantial portions of the Software.
  28
  29   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  30   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  31   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  32   NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  33   LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  34   OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  35   WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  36 */
  37
  38 #ifndef included_clib_h
  39 #define included_clib_h
  40
  41 #include <stddef.h>
  42
  43 #if __has_include(<vppinfra/config.h>)
  44 #include <vppinfra/config.h>
  45 #endif
  46
  47 #ifdef  __x86_64__
  48 #include <x86intrin.h>
  49 #endif
  50
  51 /* Standalone means to not assume we are running on a Unix box. */
  52 #if ! defined (CLIB_STANDALONE) && ! defined (CLIB_LINUX_KERNEL)
  53 #define CLIB_UNIX
  54 #endif
  55
  56 #ifdef __linux__
  57 #define CLIB_LINUX 1
  58 #else
  59 #define CLIB_LINUX 0
  60 #endif
  61
  62 #include <vppinfra/types.h>
  63 #include <vppinfra/atomics.h>
  64
  65 /* Global DEBUG flag.  Setting this to 1 or 0 turns off
  66    ASSERT (see vppinfra/error.h) & other debugging code. */
  67 #ifndef CLIB_DEBUG
  68 #define CLIB_DEBUG 0
  69 #endif
  70
  71 #ifndef NULL
  72 #define NULL ((void *) 0)
  73 #endif
  74
  75 #define BITS(x)         (8*sizeof(x))
  76 #define ARRAY_LEN(x)    (sizeof (x)/sizeof (x[0]))
  77
  78 #define _STRUCT_FIELD(t,f) (((t *) 0)->f)
  79 #define STRUCT_OFFSET_OF(t,f) offsetof(t, f)
  80 #define STRUCT_BIT_OFFSET_OF(t,f) (BITS(u8) * STRUCT_OFFSET_OF (t, f))
  81 #define STRUCT_SIZE_OF(t,f)   (sizeof (_STRUCT_FIELD (t, f)))
  82 #define STRUCT_BITS_OF(t,f)   (BITS (_STRUCT_FIELD (t, f)))
  83 #define STRUCT_ARRAY_LEN(t,f) ARRAY_LEN (_STRUCT_FIELD (t, f))
  84 #define STRUCT_MARK(mark)     u8 mark[0]
  85 #define STRUCT_MARK_PTR(v, f) &(v)->f
  86
  87 /* Stride in bytes between struct array elements. */
  88 #define STRUCT_STRIDE_OF(t,f)                   \
  89   (  ((uword) & (((t *) 0)[1].f))               \
  90    - ((uword) & (((t *) 0)[0].f)))
  91
  92 #define STRUCT_OFFSET_OF_VAR(v,f) ((uword) (&(v)->f) - (uword) (v))
  93
  94 /* Used to pack structure elements. */
  95 #define CLIB_PACKED(x)  x __attribute__ ((packed))
  96 #define CLIB_UNUSED(x)  x __attribute__ ((unused))
  97
  98 /* similar to CLIB_CACHE_LINE_ALIGN_MARK() but with arbitrary alignment */
  99 #define CLIB_ALIGN_MARK(name, alignment) u8 name[0] __attribute__((aligned(alignment)))
 100
 101 /* Make a string from the macro's argument */
 102 #define CLIB_STRING_MACRO(x) #x
 103
 104 #define CLIB_STRING_ARRAY(...)                                                \
 105   (char *[]) { __VA_ARGS__, 0 }
 106
 107 /* sanitizers */
 108 #ifdef __has_feature
 109 #if __has_feature(address_sanitizer)
 110 #define CLIB_SANITIZE_ADDR 1
 111 #endif
 112 #elif defined(__SANITIZE_ADDRESS__)
 113 #define CLIB_SANITIZE_ADDR 1
 114 #endif
 115
 116 #define __clib_unused __attribute__ ((unused))
 117 #define __clib_weak __attribute__ ((weak))
 118 #define __clib_packed __attribute__ ((packed))
 119 #define __clib_flatten     __attribute__ ((flatten))
 120 #define __clib_constructor __attribute__ ((constructor))
 121 #define __clib_noinline __attribute__ ((noinline))
 122 #ifdef __clang__
 123 #define __clib_noclone
 124 #else
 125 #define __clib_noclone            __attribute__ ((noclone))
 126 #endif
 127 #define __clib_aligned(x) __attribute__ ((aligned(x)))
 128 #define __clib_section(s) __attribute__ ((section(s)))
 129 #define __clib_warn_unused_result __attribute__ ((warn_unused_result))
 130 #define __clib_export __attribute__ ((visibility("default")))
 131 #ifdef __clang__
 132 #define __clib_no_tail_calls __attribute__ ((disable_tail_calls))
 133 #else
 134 #define __clib_no_tail_calls                                                  \
 135   __attribute__ ((optimize ("no-optimize-sibling-calls")))
 136 #endif
 137
 138 #ifdef CLIB_SANITIZE_ADDR
 139 #define __clib_nosanitize_addr __attribute__ ((no_sanitize_address))
 140 #else
 141 #define __clib_nosanitize_addr
 142 #endif
 143
 144 #define never_inline __attribute__ ((__noinline__))
 145
 146 #if CLIB_DEBUG > 0
 147 #define always_inline static inline
 148 #define static_always_inline static inline
 149 #else
 150 #define always_inline static inline __attribute__ ((__always_inline__))
 151 #define static_always_inline static inline __attribute__ ((__always_inline__))
 152 #endif
 153
 154
 155 /* Reserved (unused) structure element with address offset between
 156    from and to. */
 157 #define CLIB_PAD_FROM_TO(from,to) u8 pad_##from[(to) - (from)]
 158
 159 /* Hints to compiler about hot/cold code. */
 160 #define PREDICT_FALSE(x) __builtin_expect((x),0)
 161 #define PREDICT_TRUE(x) __builtin_expect((x),1)
 162 #define COMPILE_TIME_CONST(x) __builtin_constant_p (x)
 163 #define CLIB_ASSUME(x)                                                        \
 164   do                                                                          \
 165     {                                                                         \
 166       if (!(x))                                                               \
 167         __builtin_unreachable ();                                             \
 168     }                                                                         \
 169   while (0)
 170
 171 /*
 172  * Compiler barrier
 173  *   prevent compiler to reorder memory access across this boundary
 174  *   prevent compiler to cache values in register (force reload)
 175  * Not to be confused with CPU memory barrier below
 176  */
 177 #define CLIB_COMPILER_BARRIER() asm volatile ("":::"memory")
 178
 179 /* Full memory barrier (read and write). */
 180 #define CLIB_MEMORY_BARRIER() __sync_synchronize ()
 181
 182 #if __x86_64__
 183 #define CLIB_MEMORY_STORE_BARRIER() __builtin_ia32_sfence ()
 184 #else
 185 #define CLIB_MEMORY_STORE_BARRIER() __sync_synchronize ()
 186 #endif
 187
 188 /* Arranges for function to be called before main. */
 189 #define INIT_FUNCTION(decl)                     \
 190   decl __attribute ((constructor));             \
 191   decl
 192
 193 /* Arranges for function to be called before exit. */
 194 #define EXIT_FUNCTION(decl)                     \
 195   decl __attribute ((destructor));              \
 196   decl
 197
 198 #include <vppinfra/bitops.h>
 199
 200 always_inline uword
 201 min_log2 (uword x)
 202 {
 203   uword n;
 204   n = count_leading_zeros (x);
 205   return BITS (uword) - n - 1;
 206 }
 207
 208 always_inline uword
 209 max_log2 (uword x)
 210 {
 211   uword l = min_log2 (x);
 212   if (x > ((uword) 1 << l))
 213     l++;
 214   return l;
 215 }
 216
 217 always_inline u64
 218 min_log2_u64 (u64 x)
 219 {
 220   if (BITS (uword) == 64)
 221     return min_log2 (x);
 222   else
 223     {
 224       uword l, y;
 225       y = x;
 226       l = 0;
 227       if (y == 0)
 228         {
 229           l += 32;
 230           x >>= 32;
 231         }
 232       l += min_log2 (x);
 233       return l;
 234     }
 235 }
 236
 237 always_inline uword
 238 pow2_mask (uword x)
 239 {
 240 #ifdef __BMI2__
 241   return _bzhi_u64 (-1ULL, x);
 242 #endif
 243   return ((uword) 1 << x) - (uword) 1;
 244 }
 245
 246 always_inline uword
 247 max_pow2 (uword x)
 248 {
 249   word y = (word) 1 << min_log2 (x);
 250   if (x > y)
 251     y *= 2;
 252   return y;
 253 }
 254
 255 always_inline uword
 256 is_pow2 (uword x)
 257 {
 258   return 0 == (x & (x - 1));
 259 }
 260
 261 always_inline uword
 262 round_down_pow2 (uword x, uword pow2)
 263 {
 264   return (x) & ~(pow2 - 1);
 265 }
 266
 267 always_inline uword
 268 round_pow2 (uword x, uword pow2)
 269 {
 270   return (x + pow2 - 1) & ~(pow2 - 1);
 271 }
 272
 273 always_inline u64
 274 round_pow2_u64 (u64 x, u64 pow2)
 275 {
 276   return (x + pow2 - 1) & ~(pow2 - 1);
 277 }
 278
 279 always_inline uword
 280 first_set (uword x)
 281 {
 282   return x & -x;
 283 }
 284
 285 always_inline f64
 286 flt_round_down (f64 x)
 287 {
 288   return (int) x;
 289 }
 290
 291 always_inline word
 292 flt_round_nearest (f64 x)
 293 {
 294   return (word) (x + .5);
 295 }
 296
 297 always_inline f64
 298 flt_round_to_multiple (f64 x, f64 f)
 299 {
 300   return f * flt_round_nearest (x / f);
 301 }
 302
 303 always_inline uword
 304 extract_bits (uword x, int start, int count)
 305 {
 306 #ifdef __BMI__
 307   return _bextr_u64 (x, start, count);
 308 #endif
 309   return (x >> start) & pow2_mask (count);
 310 }
 311
 312 #define clib_max(x,y)                           \
 313 ({                                              \
 314   __typeof__ (x) _x = (x);                      \
 315   __typeof__ (y) _y = (y);                      \
 316   _x > _y ? _x : _y;                            \
 317 })
 318
 319 #define clib_min(x,y)                           \
 320 ({                                              \
 321   __typeof__ (x) _x = (x);                      \
 322   __typeof__ (y) _y = (y);                      \
 323   _x < _y ? _x : _y;                            \
 324 })
 325
 326 #define clib_clamp(x,lo,hi)                     \
 327 ({                                              \
 328   __typeof__ (x) _x = (x);                      \
 329   __typeof__ (lo) _lo = (lo);                   \
 330   __typeof__ (hi) _hi = (hi);                   \
 331   _x < _lo ? _lo : (_x > _hi ? _hi : _x);       \
 332 })
 333
 334 #define clib_abs(x)                             \
 335 ({                                              \
 336   __typeof__ (x) _x = (x);                      \
 337   _x < 0 ? -_x : _x;                            \
 338 })
 339
 340 /* Standard standalone-only function declarations. */
 341 #ifndef CLIB_UNIX
 342 void clib_standalone_init (void *memory, uword memory_bytes);
 343
 344 void qsort (void *base, uword n, uword size,
 345             int (*)(const void *, const void *));
 346 #endif
 347
 348 /* Stack backtrace. */
 349 uword
 350 clib_backtrace (uword * callers, uword max_callers, uword n_frames_to_skip);
 351
 352 #include <vppinfra/byte_order.h>
 353 #endif /* included_clib_h */
 354
 355 /*
 356  * fd.io coding-style-patch-verification: ON
 357  *
 358  * Local Variables:
 359  * eval: (c-set-style "gnu")
 360  * End:
 361  */