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
43 #if __has_include(<vppinfra/config.h>)
44 #include <vppinfra/config.h>
48 #include <x86intrin.h>
51 /* Standalone means to not assume we are running on a Unix box. */
52 #if ! defined (CLIB_STANDALONE) && ! defined (CLIB_LINUX_KERNEL)
62 #include <vppinfra/types.h>
63 #include <vppinfra/atomics.h>
65 /* Global DEBUG flag. Setting this to 1 or 0 turns off
66 ASSERT (see vppinfra/error.h) & other debugging code. */
72 #define NULL ((void *) 0)
75 #define BITS(x) (8*sizeof(x))
76 #define ARRAY_LEN(x) (sizeof (x)/sizeof (x[0]))
77 #define FOREACH_ARRAY_ELT(a, b) \
78 for (typeof ((b)[0]) *(a) = (b); (a) - (b) < ARRAY_LEN (b); (a)++)
80 #define _STRUCT_FIELD(t,f) (((t *) 0)->f)
81 #define STRUCT_OFFSET_OF(t,f) offsetof(t, f)
82 #define STRUCT_BIT_OFFSET_OF(t,f) (BITS(u8) * STRUCT_OFFSET_OF (t, f))
83 #define STRUCT_SIZE_OF(t,f) (sizeof (_STRUCT_FIELD (t, f)))
84 #define STRUCT_BITS_OF(t,f) (BITS (_STRUCT_FIELD (t, f)))
85 #define STRUCT_ARRAY_LEN(t,f) ARRAY_LEN (_STRUCT_FIELD (t, f))
86 #define STRUCT_MARK(mark) u8 mark[0]
87 #define STRUCT_MARK_PTR(v, f) &(v)->f
89 /* Stride in bytes between struct array elements. */
90 #define STRUCT_STRIDE_OF(t,f) \
91 ( ((uword) & (((t *) 0)[1].f)) \
92 - ((uword) & (((t *) 0)[0].f)))
94 #define STRUCT_OFFSET_OF_VAR(v,f) ((uword) (&(v)->f) - (uword) (v))
96 /* Used to pack structure elements. */
97 #define CLIB_PACKED(x) x __attribute__ ((packed))
98 #define CLIB_UNUSED(x) x __attribute__ ((unused))
100 /* similar to CLIB_CACHE_LINE_ALIGN_MARK() but with arbitrary alignment */
101 #define CLIB_ALIGN_MARK(name, alignment) u8 name[0] __attribute__((aligned(alignment)))
103 /* Make a string from the macro's argument */
104 #define CLIB_STRING_MACRO(x) #x
106 #define CLIB_STRING_ARRAY(...) \
107 (char *[]) { __VA_ARGS__, 0 }
111 #if __has_feature(address_sanitizer)
112 #define CLIB_SANITIZE_ADDR 1
114 #elif defined(__SANITIZE_ADDRESS__)
115 #define CLIB_SANITIZE_ADDR 1
118 #define __clib_unused __attribute__ ((unused))
119 #define __clib_weak __attribute__ ((weak))
120 #define __clib_packed __attribute__ ((packed))
121 #define __clib_flatten __attribute__ ((flatten))
122 #define __clib_constructor __attribute__ ((constructor))
123 #define __clib_noinline __attribute__ ((noinline))
125 #define __clib_noclone
127 #define __clib_noclone __attribute__ ((noclone))
129 #define __clib_aligned(x) __attribute__ ((aligned(x)))
130 #define __clib_section(s) __attribute__ ((section(s)))
131 #define __clib_warn_unused_result __attribute__ ((warn_unused_result))
132 #define __clib_export __attribute__ ((visibility("default")))
134 #define __clib_no_tail_calls __attribute__ ((disable_tail_calls))
136 #define __clib_no_tail_calls \
137 __attribute__ ((optimize ("no-optimize-sibling-calls")))
140 #ifdef CLIB_SANITIZE_ADDR
141 #define __clib_nosanitize_addr __attribute__ ((no_sanitize_address))
143 #define __clib_nosanitize_addr
146 #define never_inline __attribute__ ((__noinline__))
149 #define always_inline static inline
150 #define static_always_inline static inline
152 #define always_inline static inline __attribute__ ((__always_inline__))
153 #define static_always_inline static inline __attribute__ ((__always_inline__))
157 /* Reserved (unused) structure element with address offset between
159 #define CLIB_PAD_FROM_TO(from,to) u8 pad_##from[(to) - (from)]
161 /* Hints to compiler about hot/cold code. */
162 #define PREDICT_FALSE(x) __builtin_expect((x),0)
163 #define PREDICT_TRUE(x) __builtin_expect((x),1)
164 #define COMPILE_TIME_CONST(x) __builtin_constant_p (x)
165 #define CLIB_ASSUME(x) \
169 __builtin_unreachable (); \
175 * prevent compiler to reorder memory access across this boundary
176 * prevent compiler to cache values in register (force reload)
177 * Not to be confused with CPU memory barrier below
179 #define CLIB_COMPILER_BARRIER() asm volatile ("":::"memory")
181 /* Full memory barrier (read and write). */
182 #define CLIB_MEMORY_BARRIER() __sync_synchronize ()
185 #define CLIB_MEMORY_STORE_BARRIER() __builtin_ia32_sfence ()
187 #define CLIB_MEMORY_STORE_BARRIER() __sync_synchronize ()
190 /* Arranges for function to be called before main. */
191 #define INIT_FUNCTION(decl) \
192 decl __attribute ((constructor)); \
195 /* Arranges for function to be called before exit. */
196 #define EXIT_FUNCTION(decl) \
197 decl __attribute ((destructor)); \
200 #include <vppinfra/bitops.h>
206 n = count_leading_zeros (x);
207 return BITS (uword) - n - 1;
213 uword l = min_log2 (x);
214 if (x > ((uword) 1 << l))
222 if (BITS (uword) == 64)
243 return _bzhi_u64 (-1ULL, x);
245 return ((uword) 1 << x) - (uword) 1;
251 word y = (word) 1 << min_log2 (x);
260 return 0 == (x & (x - 1));
264 round_down_pow2 (uword x, uword pow2)
266 return (x) & ~(pow2 - 1);
270 round_pow2 (uword x, uword pow2)
272 return (x + pow2 - 1) & ~(pow2 - 1);
276 round_pow2_u64 (u64 x, u64 pow2)
278 return (x + pow2 - 1) & ~(pow2 - 1);
288 flt_round_down (f64 x)
294 flt_round_nearest (f64 x)
296 return (word) (x + .5);
300 flt_round_to_multiple (f64 x, f64 f)
302 return f * flt_round_nearest (x / f);
306 extract_bits (uword x, int start, int count)
309 return _bextr_u64 (x, start, count);
311 return (x >> start) & pow2_mask (count);
314 #define clib_max(x,y) \
316 __typeof__ (x) _x = (x); \
317 __typeof__ (y) _y = (y); \
321 #define clib_min(x,y) \
323 __typeof__ (x) _x = (x); \
324 __typeof__ (y) _y = (y); \
328 #define clib_clamp(x,lo,hi) \
330 __typeof__ (x) _x = (x); \
331 __typeof__ (lo) _lo = (lo); \
332 __typeof__ (hi) _hi = (hi); \
333 _x < _lo ? _lo : (_x > _hi ? _hi : _x); \
336 #define clib_abs(x) \
338 __typeof__ (x) _x = (x); \
342 /* Standard standalone-only function declarations. */
344 void clib_standalone_init (void *memory, uword memory_bytes);
346 void qsort (void *base, uword n, uword size,
347 int (*)(const void *, const void *));
350 /* Stack backtrace. */
352 clib_backtrace (uword * callers, uword max_callers, uword n_frames_to_skip);
354 #include <vppinfra/byte_order.h>
355 #endif /* included_clib_h */
358 * fd.io coding-style-patch-verification: ON
361 * eval: (c-set-style "gnu")