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