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