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 #include <vppinfra/types.h>
  57 #include <vppinfra/atomics.h>
  58
  59 /* Global DEBUG flag.  Setting this to 1 or 0 turns off
  60    ASSERT (see vppinfra/error.h) & other debugging code. */
  61 #ifndef CLIB_DEBUG
  62 #define CLIB_DEBUG 0
  63 #endif
  64
  65 #ifndef NULL
  66 #define NULL ((void *) 0)
  67 #endif
  68
  69 #define BITS(x)         (8*sizeof(x))
  70 #define ARRAY_LEN(x)    (sizeof (x)/sizeof (x[0]))
  71
  72 #define _STRUCT_FIELD(t,f) (((t *) 0)->f)
  73 #define STRUCT_OFFSET_OF(t,f) offsetof(t, f)
  74 #define STRUCT_BIT_OFFSET_OF(t,f) (BITS(u8) * STRUCT_OFFSET_OF (t, f))
  75 #define STRUCT_SIZE_OF(t,f)   (sizeof (_STRUCT_FIELD (t, f)))
  76 #define STRUCT_BITS_OF(t,f)   (BITS (_STRUCT_FIELD (t, f)))
  77 #define STRUCT_ARRAY_LEN(t,f) ARRAY_LEN (_STRUCT_FIELD (t, f))
  78 #define STRUCT_MARK(mark)     u8 mark[0]
  79 #define STRUCT_MARK_PTR(v, f) &(v)->f
  80
  81 /* Stride in bytes between struct array elements. */
  82 #define STRUCT_STRIDE_OF(t,f)                   \
  83   (  ((uword) & (((t *) 0)[1].f))               \
  84    - ((uword) & (((t *) 0)[0].f)))
  85
  86 #define STRUCT_OFFSET_OF_VAR(v,f) ((uword) (&(v)->f) - (uword) (v))
  87
  88 /* Used to pack structure elements. */
  89 #define CLIB_PACKED(x)  x __attribute__ ((packed))
  90 #define CLIB_UNUSED(x)  x __attribute__ ((unused))
  91
  92 /* similar to CLIB_CACHE_LINE_ALIGN_MARK() but with arbitrary alignment */
  93 #define CLIB_ALIGN_MARK(name, alignment) u8 name[0] __attribute__((aligned(alignment)))
  94
  95 /* Make a string from the macro's argument */
  96 #define CLIB_STRING_MACRO(x) #x
  97
  98 #define CLIB_STRING_ARRAY(...)                                                \
  99   (char *[]) { __VA_ARGS__, 0 }
 100
 101 /* sanitizers */
 102 #ifdef __has_feature
 103 #if __has_feature(address_sanitizer)
 104 #define CLIB_SANITIZE_ADDR 1
 105 #endif
 106 #elif defined(__SANITIZE_ADDRESS__)
 107 #define CLIB_SANITIZE_ADDR 1
 108 #endif
 109
 110 #define __clib_unused __attribute__ ((unused))
 111 #define __clib_weak __attribute__ ((weak))
 112 #define __clib_packed __attribute__ ((packed))
 113 #define __clib_flatten     __attribute__ ((flatten))
 114 #define __clib_constructor __attribute__ ((constructor))
 115 #define __clib_noinline __attribute__ ((noinline))
 116 #ifdef __clang__
 117 #define __clib_noclone
 118 #else
 119 #define __clib_noclone            __attribute__ ((noclone))
 120 #endif
 121 #define __clib_aligned(x) __attribute__ ((aligned(x)))
 122 #define __clib_section(s) __attribute__ ((section(s)))
 123 #define __clib_warn_unused_result __attribute__ ((warn_unused_result))
 124 #define __clib_export __attribute__ ((visibility("default")))
 125 #ifdef __clang__
 126 #define __clib_no_tail_calls __attribute__ ((disable_tail_calls))
 127 #else
 128 #define __clib_no_tail_calls                                                  \
 129   __attribute__ ((optimize ("no-optimize-sibling-calls")))
 130 #endif
 131
 132 #ifdef CLIB_SANITIZE_ADDR
 133 #define __clib_nosanitize_addr __attribute__ ((no_sanitize_address))
 134 #else
 135 #define __clib_nosanitize_addr
 136 #endif
 137
 138 #define never_inline __attribute__ ((__noinline__))
 139
 140 #if CLIB_DEBUG > 0
 141 #define always_inline static inline
 142 #define static_always_inline static inline
 143 #else
 144 #define always_inline static inline __attribute__ ((__always_inline__))
 145 #define static_always_inline static inline __attribute__ ((__always_inline__))
 146 #endif
 147
 148
 149 /* Reserved (unused) structure element with address offset between
 150    from and to. */
 151 #define CLIB_PAD_FROM_TO(from,to) u8 pad_##from[(to) - (from)]
 152
 153 /* Hints to compiler about hot/cold code. */
 154 #define PREDICT_FALSE(x) __builtin_expect((x),0)
 155 #define PREDICT_TRUE(x) __builtin_expect((x),1)
 156 #define COMPILE_TIME_CONST(x) __builtin_constant_p (x)
 157 #define CLIB_ASSUME(x)                                                        \
 158   do                                                                          \
 159     {                                                                         \
 160       if (!(x))                                                               \
 161         __builtin_unreachable ();                                             \
 162     }                                                                         \
 163   while (0)
 164
 165 /*
 166  * Compiler barrier
 167  *   prevent compiler to reorder memory access across this boundary
 168  *   prevent compiler to cache values in register (force reload)
 169  * Not to be confused with CPU memory barrier below
 170  */
 171 #define CLIB_COMPILER_BARRIER() asm volatile ("":::"memory")
 172
 173 /* Full memory barrier (read and write). */
 174 #define CLIB_MEMORY_BARRIER() __sync_synchronize ()
 175
 176 #if __x86_64__
 177 #define CLIB_MEMORY_STORE_BARRIER() __builtin_ia32_sfence ()
 178 #else
 179 #define CLIB_MEMORY_STORE_BARRIER() __sync_synchronize ()
 180 #endif
 181
 182 /* Arranges for function to be called before main. */
 183 #define INIT_FUNCTION(decl)                     \
 184   decl __attribute ((constructor));             \
 185   decl
 186
 187 /* Arranges for function to be called before exit. */
 188 #define EXIT_FUNCTION(decl)                     \
 189   decl __attribute ((destructor));              \
 190   decl
 191
 192 #include <vppinfra/bitops.h>
 193
 194 always_inline uword
 195 min_log2 (uword x)
 196 {
 197   uword n;
 198   n = count_leading_zeros (x);
 199   return BITS (uword) - n - 1;
 200 }
 201
 202 always_inline uword
 203 max_log2 (uword x)
 204 {
 205   uword l = min_log2 (x);
 206   if (x > ((uword) 1 << l))
 207     l++;
 208   return l;
 209 }
 210
 211 always_inline u64
 212 min_log2_u64 (u64 x)
 213 {
 214   if (BITS (uword) == 64)
 215     return min_log2 (x);
 216   else
 217     {
 218       uword l, y;
 219       y = x;
 220       l = 0;
 221       if (y == 0)
 222         {
 223           l += 32;
 224           x >>= 32;
 225         }
 226       l += min_log2 (x);
 227       return l;
 228     }
 229 }
 230
 231 always_inline uword
 232 pow2_mask (uword x)
 233 {
 234 #ifdef __BMI2__
 235   return _bzhi_u64 (-1ULL, x);
 236 #endif
 237   return ((uword) 1 << x) - (uword) 1;
 238 }
 239
 240 always_inline uword
 241 max_pow2 (uword x)
 242 {
 243   word y = (word) 1 << min_log2 (x);
 244   if (x > y)
 245     y *= 2;
 246   return y;
 247 }
 248
 249 always_inline uword
 250 is_pow2 (uword x)
 251 {
 252   return 0 == (x & (x - 1));
 253 }
 254
 255 always_inline uword
 256 round_down_pow2 (uword x, uword pow2)
 257 {
 258   return (x) & ~(pow2 - 1);
 259 }
 260
 261 always_inline uword
 262 round_pow2 (uword x, uword pow2)
 263 {
 264   return (x + pow2 - 1) & ~(pow2 - 1);
 265 }
 266
 267 always_inline u64
 268 round_pow2_u64 (u64 x, u64 pow2)
 269 {
 270   return (x + pow2 - 1) & ~(pow2 - 1);
 271 }
 272
 273 always_inline uword
 274 first_set (uword x)
 275 {
 276   return x & -x;
 277 }
 278
 279 always_inline f64
 280 flt_round_down (f64 x)
 281 {
 282   return (int) x;
 283 }
 284
 285 always_inline word
 286 flt_round_nearest (f64 x)
 287 {
 288   return (word) (x + .5);
 289 }
 290
 291 always_inline f64
 292 flt_round_to_multiple (f64 x, f64 f)
 293 {
 294   return f * flt_round_nearest (x / f);
 295 }
 296
 297 always_inline uword
 298 extract_bits (uword x, int start, int count)
 299 {
 300 #ifdef __BMI__
 301   return _bextr_u64 (x, start, count);
 302 #endif
 303   return (x >> start) & pow2_mask (count);
 304 }
 305
 306 #define clib_max(x,y)                           \
 307 ({                                              \
 308   __typeof__ (x) _x = (x);                      \
 309   __typeof__ (y) _y = (y);                      \
 310   _x > _y ? _x : _y;                            \
 311 })
 312
 313 #define clib_min(x,y)                           \
 314 ({                                              \
 315   __typeof__ (x) _x = (x);                      \
 316   __typeof__ (y) _y = (y);                      \
 317   _x < _y ? _x : _y;                            \
 318 })
 319
 320 #define clib_clamp(x,lo,hi)                     \
 321 ({                                              \
 322   __typeof__ (x) _x = (x);                      \
 323   __typeof__ (lo) _lo = (lo);                   \
 324   __typeof__ (hi) _hi = (hi);                   \
 325   _x < _lo ? _lo : (_x > _hi ? _hi : _x);       \
 326 })
 327
 328 #define clib_abs(x)                             \
 329 ({                                              \
 330   __typeof__ (x) _x = (x);                      \
 331   _x < 0 ? -_x : _x;                            \
 332 })
 333
 334 /* Standard standalone-only function declarations. */
 335 #ifndef CLIB_UNIX
 336 void clib_standalone_init (void *memory, uword memory_bytes);
 337
 338 void qsort (void *base, uword n, uword size,
 339             int (*)(const void *, const void *));
 340 #endif
 341
 342 /* Stack backtrace. */
 343 uword
 344 clib_backtrace (uword * callers, uword max_callers, uword n_frames_to_skip);
 345
 346 #include <vppinfra/byte_order.h>
 347 #endif /* included_clib_h */
 348
 349 /*
 350  * fd.io coding-style-patch-verification: ON
 351  *
 352  * Local Variables:
 353  * eval: (c-set-style "gnu")
 354  * End:
 355  */