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