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