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