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