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