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