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