vppinfra/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
  68 /* Stride in bytes between struct array elements. */
  69 #define STRUCT_STRIDE_OF(t,f)                   \
  70   (  ((uword) & (((t *) 0)[1].f))               \
  71    - ((uword) & (((t *) 0)[0].f)))
  72
  73 #define STRUCT_OFFSET_OF_VAR(v,f) ((uword) (&(v)->f) - (uword) (v))
  74
  75 /* Used to pack structure elements. */
  76 #define CLIB_PACKED(x)  x __attribute__ ((packed))
  77 #define CLIB_UNUSED(x)  x __attribute__ ((unused))
  78
  79 #define never_inline __attribute__ ((__noinline__))
  80
  81 #if CLIB_DEBUG > 0
  82 #define always_inline static inline
  83 #define static_always_inline static inline
  84 #else
  85 #define always_inline static inline __attribute__ ((__always_inline__))
  86 #define static_always_inline static inline __attribute__ ((__always_inline__))
  87 #endif
  88
  89
  90 /* Reserved (unused) structure element with address offset between
  91    from and to. */
  92 #define CLIB_PAD_FROM_TO(from,to) u8 pad_##from[(to) - (from)]
  93
  94 /* Hints to compiler about hot/cold code. */
  95 #define PREDICT_FALSE(x) __builtin_expect((x),0)
  96 #define PREDICT_TRUE(x) __builtin_expect((x),1)
  97
  98 /* Full memory barrier (read and write). */
  99 #define CLIB_MEMORY_BARRIER() __sync_synchronize ()
 100
 101 /* Arranges for function to be called before main. */
 102 #define INIT_FUNCTION(decl)                     \
 103   decl __attribute ((constructor));             \
 104   decl
 105
 106 /* Arranges for function to be called before exit. */
 107 #define EXIT_FUNCTION(decl)                     \
 108   decl __attribute ((destructor));              \
 109   decl
 110
 111 /* Use __builtin_clz if available. */
 112 #ifdef __GNUC__
 113 #include <features.h>
 114 #if __GNUC_PREREQ(3, 4)
 115 #if uword_bits == 64
 116 #define count_leading_zeros(count,x) count = __builtin_clzll (x)
 117 #define count_trailing_zeros(count,x) count = __builtin_ctzll (x)
 118 #else
 119 #define count_leading_zeros(count,x) count = __builtin_clzl (x)
 120 #define count_trailing_zeros(count,x) count = __builtin_ctzl (x)
 121 #endif
 122 #endif
 123 #endif
 124
 125 #ifndef count_leading_zeros
 126
 127 /* Misc. integer arithmetic functions. */
 128 #if defined (i386)
 129 #define count_leading_zeros(count, x)           \
 130   do {                                          \
 131     word _clz;                                  \
 132     __asm__ ("bsrl %1,%0"                       \
 133              : "=r" (_clz) : "rm" ((word) (x)));\
 134     (count) = _clz ^ 31;                        \
 135   } while (0)
 136
 137 #define count_trailing_zeros(count, x)                  \
 138   __asm__ ("bsfl %1,%0" : "=r" (count) : "rm" ((word)(x)))
 139 #endif /* i386 */
 140
 141 #if defined (__alpha__) && defined (HAVE_CIX)
 142 #define count_leading_zeros(count, x)           \
 143   __asm__ ("ctlz %1,%0"                         \
 144            : "=r" ((word) (count))              \
 145            : "r" ((word) (x)))
 146 #define count_trailing_zeros(count, x)          \
 147   __asm__ ("cttz %1,%0"                         \
 148            : "=r" ((word) (count))              \
 149            : "r" ((word) (x)))
 150 #endif /* alpha && HAVE_CIX */
 151
 152 #if __mips >= 4
 153
 154 /* Select between 32/64 opcodes. */
 155 #if uword_bits == 32
 156 #define count_leading_zeros(_count, _x)         \
 157   __asm__ ("clz %[count],%[x]"                  \
 158            : [count] "=r" ((word) (_count))     \
 159            : [x] "r" ((word) (_x)))
 160 #else
 161 #define count_leading_zeros(_count, _x)         \
 162   __asm__ ("dclz %[count],%[x]"                 \
 163            : [count] "=r" ((word) (_count))     \
 164            : [x] "r" ((word) (_x)))
 165 #endif
 166
 167 #endif /* __mips >= 4 */
 168
 169 #endif /* count_leading_zeros */
 170
 171 #if defined (count_leading_zeros)
 172 always_inline uword min_log2 (uword x)
 173 {
 174   uword n;
 175   count_leading_zeros (n, x);
 176   return BITS (uword) - n - 1;
 177 }
 178 #else
 179 always_inline uword min_log2 (uword x)
 180 {
 181   uword a = x, b = BITS(uword)/2, c = 0, r = 0;
 182
 183   /* Reduce x to 4 bit result. */
 184 #define _                                       \
 185 {                                               \
 186   c = a >> b;                                   \
 187   if (c) a = c;                                 \
 188   if (c) r += b;                                \
 189   b /= 2;                                       \
 190 }
 191
 192   if (BITS (uword) > 32) _;
 193   _; _; _;
 194 #undef _
 195
 196   /* Do table lookup on 4 bit partial. */
 197   if (BITS (uword) > 32)
 198     {
 199       const u64 table = 0x3333333322221104LL;
 200       uword t = (table >> (4*a)) & 0xf;
 201       r = t < 4 ? r + t : ~0;
 202     }
 203   else
 204     {
 205       const u32 table = 0x22221104;
 206       uword t = (a & 8) ? 3 : ((table >> (4*a)) & 0xf);
 207       r = t < 4 ? r + t : ~0;
 208   }
 209
 210   return r;
 211 }
 212 #endif
 213
 214 always_inline uword max_log2 (uword x)
 215 {
 216   uword l = min_log2 (x);
 217   if (x > ((uword) 1 << l))
 218     l++;
 219   return l;
 220 }
 221
 222 always_inline u64 min_log2_u64 (u64 x)
 223 {
 224   if (BITS (uword) == 64)
 225     return min_log2 (x);
 226   else
 227     {
 228       uword l, y;
 229       y = x;
 230       l = 0;
 231       if (y == 0) {
 232         l += 32;
 233         x >>= 32;
 234       }
 235       l += min_log2 (x);
 236       return l;
 237     }
 238 }
 239
 240 always_inline uword pow2_mask (uword x)
 241 { return ((uword) 1 << x) - (uword) 1; }
 242
 243 always_inline uword max_pow2 (uword x)
 244 {
 245   word y = (word) 1 << min_log2 (x);
 246   if (x > y) y *= 2;
 247   return y;
 248 }
 249
 250 always_inline uword is_pow2 (uword x)
 251 { return 0 == (x & (x - 1)); }
 252
 253 always_inline uword round_pow2 (uword x, uword pow2)
 254 {
 255   return (x + pow2 - 1) &~ (pow2 - 1);
 256 }
 257
 258 always_inline u64 round_pow2_u64 (u64 x, u64 pow2)
 259 {
 260   return (x + pow2 - 1) &~ (pow2 - 1);
 261 }
 262
 263 always_inline uword first_set (uword x)
 264 { return x & -x; }
 265
 266 always_inline uword log2_first_set (uword x)
 267 {
 268   uword result;
 269 #ifdef count_trailing_zeros
 270   count_trailing_zeros (result, x);
 271 #else
 272   result = min_log2 (first_set (x));
 273 #endif
 274   return result;
 275 }
 276
 277 always_inline f64 flt_round_down (f64 x)
 278 { return (int) x; }
 279
 280 always_inline word flt_round_nearest (f64 x)
 281 { return (word) (x + .5); }
 282
 283 always_inline f64 flt_round_to_multiple (f64 x, f64 f)
 284 { return f * flt_round_nearest (x / f); }
 285
 286 #define clib_max(x,y)                           \
 287 ({                                              \
 288   __typeof__ (x) _x = (x);                      \
 289   __typeof__ (y) _y = (y);                      \
 290   _x > _y ? _x : _y;                            \
 291 })
 292
 293 #define clib_min(x,y)                           \
 294 ({                                              \
 295   __typeof__ (x) _x = (x);                      \
 296   __typeof__ (y) _y = (y);                      \
 297   _x < _y ? _x : _y;                            \
 298 })
 299
 300 #define clib_abs(x)                             \
 301 ({                                              \
 302   __typeof__ (x) _x = (x);                      \
 303   _x < 0 ? -_x : _x;                            \
 304 })
 305
 306 /* Standard standalone-only function declarations. */
 307 #ifndef CLIB_UNIX
 308 void clib_standalone_init (void * memory, uword memory_bytes);
 309
 310 void qsort (void * base, uword n, uword size,
 311             int (*) (const void *, const void *));
 312 #endif
 313
 314 /* Stack backtrace. */
 315 uword
 316 clib_backtrace (uword * callers,
 317                 uword max_callers,
 318                 uword n_frames_to_skip);
 319
 320 #endif /* included_clib_h */