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