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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 Copyright (c) 2001, 2002, 2003 Eliot Dresselhaus
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:
26 The above copyright notice and this permission notice shall be
27 included in all copies or substantial portions of the Software.
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.
38 #ifndef included_clib_h
39 #define included_clib_h
42 #include <vppinfra/config.h>
45 #include <x86intrin.h>
48 /* Standalone means to not assume we are running on a Unix box. */
49 #if ! defined (CLIB_STANDALONE) && ! defined (CLIB_LINUX_KERNEL)
53 #include <vppinfra/types.h>
54 #include <vppinfra/atomics.h>
56 /* Global DEBUG flag. Setting this to 1 or 0 turns off
57 ASSERT (see vppinfra/error.h) & other debugging code. */
63 #define NULL ((void *) 0)
66 #define BITS(x) (8*sizeof(x))
67 #define ARRAY_LEN(x) (sizeof (x)/sizeof (x[0]))
69 #define _STRUCT_FIELD(t,f) (((t *) 0)->f)
70 #define STRUCT_OFFSET_OF(t,f) offsetof(t, f)
71 #define STRUCT_BIT_OFFSET_OF(t,f) (BITS(u8) * STRUCT_OFFSET_OF (t, f))
72 #define STRUCT_SIZE_OF(t,f) (sizeof (_STRUCT_FIELD (t, f)))
73 #define STRUCT_BITS_OF(t,f) (BITS (_STRUCT_FIELD (t, f)))
74 #define STRUCT_ARRAY_LEN(t,f) ARRAY_LEN (_STRUCT_FIELD (t, f))
75 #define STRUCT_MARK(mark) u8 mark[0]
76 #define STRUCT_MARK_PTR(v, f) &(v)->f
78 /* Stride in bytes between struct array elements. */
79 #define STRUCT_STRIDE_OF(t,f) \
80 ( ((uword) & (((t *) 0)[1].f)) \
81 - ((uword) & (((t *) 0)[0].f)))
83 #define STRUCT_OFFSET_OF_VAR(v,f) ((uword) (&(v)->f) - (uword) (v))
85 /* Used to pack structure elements. */
86 #define CLIB_PACKED(x) x __attribute__ ((packed))
87 #define CLIB_UNUSED(x) x __attribute__ ((unused))
89 /* similar to CLIB_CACHE_LINE_ALIGN_MARK() but with arbitrary alignment */
90 #define CLIB_ALIGN_MARK(name, alignment) u8 name[0] __attribute__((aligned(alignment)))
92 /* Make a string from the macro's argument */
93 #define CLIB_STRING_MACRO(x) #x
95 #define __clib_unused __attribute__ ((unused))
96 #define __clib_weak __attribute__ ((weak))
97 #define __clib_packed __attribute__ ((packed))
98 #define __clib_constructor __attribute__ ((constructor))
99 #define __clib_noinline __attribute__ ((noinline))
100 #define __clib_aligned(x) __attribute__ ((aligned(x)))
101 #define __clib_section(s) __attribute__ ((section(s)))
102 #define __clib_warn_unused_result __attribute__ ((warn_unused_result))
103 #define __clib_export __attribute__ ((visibility("default")))
105 #define never_inline __attribute__ ((__noinline__))
108 #define always_inline static inline
109 #define static_always_inline static inline
111 #define always_inline static inline __attribute__ ((__always_inline__))
112 #define static_always_inline static inline __attribute__ ((__always_inline__))
116 /* Reserved (unused) structure element with address offset between
118 #define CLIB_PAD_FROM_TO(from,to) u8 pad_##from[(to) - (from)]
120 /* Hints to compiler about hot/cold code. */
121 #define PREDICT_FALSE(x) __builtin_expect((x),0)
122 #define PREDICT_TRUE(x) __builtin_expect((x),1)
123 #define COMPILE_TIME_CONST(x) __builtin_constant_p (x)
127 * prevent compiler to reorder memory access accross this boundary
128 * prevent compiler to cache values in register (force reload)
129 * Not to be confused with CPU memory barrier below
131 #define CLIB_COMPILER_BARRIER() asm volatile ("":::"memory")
133 /* Full memory barrier (read and write). */
134 #define CLIB_MEMORY_BARRIER() __sync_synchronize ()
137 #define CLIB_MEMORY_STORE_BARRIER() __builtin_ia32_sfence ()
139 #define CLIB_MEMORY_STORE_BARRIER() __sync_synchronize ()
142 /* Arranges for function to be called before main. */
143 #define INIT_FUNCTION(decl) \
144 decl __attribute ((constructor)); \
147 /* Arranges for function to be called before exit. */
148 #define EXIT_FUNCTION(decl) \
149 decl __attribute ((destructor)); \
152 /* Use __builtin_clz if available. */
154 #define count_leading_zeros(x) __builtin_clzll (x)
155 #define count_trailing_zeros(x) __builtin_ctzll (x)
157 #define count_leading_zeros(x) __builtin_clzl (x)
158 #define count_trailing_zeros(x) __builtin_ctzl (x)
161 #if defined (count_leading_zeros)
163 clear_lowest_set_bit (uword x)
166 return _blsr_u64 (x);
168 return x ^ (1ULL << count_trailing_zeros (x));
176 n = count_leading_zeros (x);
177 return BITS (uword) - n - 1;
183 uword a = x, b = BITS (uword) / 2, c = 0, r = 0;
185 /* Reduce x to 4 bit result. */
194 if (BITS (uword) > 32)
201 /* Do table lookup on 4 bit partial. */
202 if (BITS (uword) > 32)
204 const u64 table = 0x3333333322221104LL;
205 uword t = (table >> (4 * a)) & 0xf;
206 r = t < 4 ? r + t : ~0;
210 const u32 table = 0x22221104;
211 uword t = (a & 8) ? 3 : ((table >> (4 * a)) & 0xf);
212 r = t < 4 ? r + t : ~0;
222 uword l = min_log2 (x);
223 if (x > ((uword) 1 << l))
231 if (BITS (uword) == 64)
251 return ((uword) 1 << x) - (uword) 1;
257 word y = (word) 1 << min_log2 (x);
266 return 0 == (x & (x - 1));
270 round_down_pow2 (uword x, uword pow2)
272 return (x) & ~(pow2 - 1);
276 round_pow2 (uword x, uword pow2)
278 return (x + pow2 - 1) & ~(pow2 - 1);
282 round_pow2_u64 (u64 x, u64 pow2)
284 return (x + pow2 - 1) & ~(pow2 - 1);
294 log2_first_set (uword x)
297 #ifdef count_trailing_zeros
298 result = count_trailing_zeros (x);
300 result = min_log2 (first_set (x));
306 flt_round_down (f64 x)
312 flt_round_nearest (f64 x)
314 return (word) (x + .5);
318 flt_round_to_multiple (f64 x, f64 f)
320 return f * flt_round_nearest (x / f);
324 extract_bits (uword x, int start, int count)
327 return _bextr_u64 (x, start, count);
329 return (x >> start) & pow2_mask (count);
332 #define clib_max(x,y) \
334 __typeof__ (x) _x = (x); \
335 __typeof__ (y) _y = (y); \
339 #define clib_min(x,y) \
341 __typeof__ (x) _x = (x); \
342 __typeof__ (y) _y = (y); \
346 #define clib_clamp(x,lo,hi) \
348 __typeof__ (x) _x = (x); \
349 __typeof__ (lo) _lo = (lo); \
350 __typeof__ (hi) _hi = (hi); \
351 _x < _lo ? _lo : (_x > _hi ? _hi : _x); \
354 #define clib_abs(x) \
356 __typeof__ (x) _x = (x); \
360 /* Standard standalone-only function declarations. */
362 void clib_standalone_init (void *memory, uword memory_bytes);
364 void qsort (void *base, uword n, uword size,
365 int (*)(const void *, const void *));
368 /* Stack backtrace. */
370 clib_backtrace (uword * callers, uword max_callers, uword n_frames_to_skip);
372 #endif /* included_clib_h */
375 * fd.io coding-style-patch-verification: ON
378 * eval: (c-set-style "gnu")