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