4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * * Neither the name of Intel Corporation nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 #ifndef _RTE_COMMON_H_
35 #define _RTE_COMMON_H_
40 * Generic, commonly-used macro and inline function definitions
55 #define typeof __typeof__
62 /** C extension macro for environments lacking C11 features. */
63 #if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 201112L
64 #define RTE_STD_C11 __extension__
69 /** Define GCC_VERSION **/
70 #ifdef RTE_TOOLCHAIN_GCC
71 #define GCC_VERSION (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + \
75 #ifdef RTE_ARCH_STRICT_ALIGN
76 typedef uint64_t unaligned_uint64_t __attribute__ ((aligned(1)));
77 typedef uint32_t unaligned_uint32_t __attribute__ ((aligned(1)));
78 typedef uint16_t unaligned_uint16_t __attribute__ ((aligned(1)));
80 typedef uint64_t unaligned_uint64_t;
81 typedef uint32_t unaligned_uint32_t;
82 typedef uint16_t unaligned_uint16_t;
88 #define __rte_aligned(a) __attribute__((__aligned__(a)))
91 * Force a structure to be packed
93 #define __rte_packed __attribute__((__packed__))
95 /******* Macro to mark functions and fields scheduled for removal *****/
96 #define __rte_deprecated __attribute__((__deprecated__))
98 /*********** Macros to eliminate unused variable warnings ********/
101 * short definition to mark a function parameter unused
103 #define __rte_unused __attribute__((__unused__))
106 * definition to mark a variable or function parameter as used so
107 * as to avoid a compiler warning
109 #define RTE_SET_USED(x) (void)(x)
112 * Run function before main() with low priority.
114 * The constructor will be run after prioritized constructors.
117 * Constructor function.
119 #define RTE_INIT(func) \
120 static void __attribute__((constructor, used)) func(void)
123 * Run function before main() with high priority.
126 * Constructor function.
128 * Priority number must be above 100.
129 * Lowest number is the first to run.
131 #define RTE_INIT_PRIO(func, prio) \
132 static void __attribute__((constructor(prio), used)) func(void)
135 * Force a function to be inlined
137 #define __rte_always_inline inline __attribute__((always_inline))
140 * Force a function to be noinlined
142 #define __rte_noinline __attribute__((noinline))
144 /*********** Macros for pointer arithmetic ********/
147 * add a byte-value offset from a pointer
149 #define RTE_PTR_ADD(ptr, x) ((void*)((uintptr_t)(ptr) + (x)))
152 * subtract a byte-value offset from a pointer
154 #define RTE_PTR_SUB(ptr, x) ((void*)((uintptr_t)ptr - (x)))
157 * get the difference between two pointer values, i.e. how far apart
158 * in bytes are the locations they point two. It is assumed that
159 * ptr1 is greater than ptr2.
161 #define RTE_PTR_DIFF(ptr1, ptr2) ((uintptr_t)(ptr1) - (uintptr_t)(ptr2))
163 /*********** Macros/static functions for doing alignment ********/
167 * Macro to align a pointer to a given power-of-two. The resultant
168 * pointer will be a pointer of the same type as the first parameter, and
169 * point to an address no higher than the first parameter. Second parameter
170 * must be a power-of-two value.
172 #define RTE_PTR_ALIGN_FLOOR(ptr, align) \
173 ((typeof(ptr))RTE_ALIGN_FLOOR((uintptr_t)ptr, align))
176 * Macro to align a value to a given power-of-two. The resultant value
177 * will be of the same type as the first parameter, and will be no
178 * bigger than the first parameter. Second parameter must be a
179 * power-of-two value.
181 #define RTE_ALIGN_FLOOR(val, align) \
182 (typeof(val))((val) & (~((typeof(val))((align) - 1))))
185 * Macro to align a pointer to a given power-of-two. The resultant
186 * pointer will be a pointer of the same type as the first parameter, and
187 * point to an address no lower than the first parameter. Second parameter
188 * must be a power-of-two value.
190 #define RTE_PTR_ALIGN_CEIL(ptr, align) \
191 RTE_PTR_ALIGN_FLOOR((typeof(ptr))RTE_PTR_ADD(ptr, (align) - 1), align)
194 * Macro to align a value to a given power-of-two. The resultant value
195 * will be of the same type as the first parameter, and will be no lower
196 * than the first parameter. Second parameter must be a power-of-two
199 #define RTE_ALIGN_CEIL(val, align) \
200 RTE_ALIGN_FLOOR(((val) + ((typeof(val)) (align) - 1)), align)
203 * Macro to align a pointer to a given power-of-two. The resultant
204 * pointer will be a pointer of the same type as the first parameter, and
205 * point to an address no lower than the first parameter. Second parameter
206 * must be a power-of-two value.
207 * This function is the same as RTE_PTR_ALIGN_CEIL
209 #define RTE_PTR_ALIGN(ptr, align) RTE_PTR_ALIGN_CEIL(ptr, align)
212 * Macro to align a value to a given power-of-two. The resultant
213 * value will be of the same type as the first parameter, and
214 * will be no lower than the first parameter. Second parameter
215 * must be a power-of-two value.
216 * This function is the same as RTE_ALIGN_CEIL
218 #define RTE_ALIGN(val, align) RTE_ALIGN_CEIL(val, align)
221 * Checks if a pointer is aligned to a given power-of-two value
224 * The pointer whose alignment is to be checked
226 * The power-of-two value to which the ptr should be aligned
229 * True(1) where the pointer is correctly aligned, false(0) otherwise
232 rte_is_aligned(void *ptr, unsigned align)
234 return RTE_PTR_ALIGN(ptr, align) == ptr;
237 /*********** Macros for compile type checks ********/
240 * Triggers an error at compilation time if the condition is true.
243 #define RTE_BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
245 extern int RTE_BUILD_BUG_ON_detected_error;
246 #define RTE_BUILD_BUG_ON(condition) do { \
247 ((void)sizeof(char[1 - 2*!!(condition)])); \
249 RTE_BUILD_BUG_ON_detected_error = 1; \
253 /*********** Macros to work with powers of 2 ********/
256 * Returns true if n is a power of 2
259 * @return 1 if true, 0 otherwise
262 rte_is_power_of_2(uint32_t n)
264 return n && !(n & (n - 1));
268 * Aligns input parameter to the next power of 2
271 * The integer value to algin
274 * Input parameter aligned to the next power of 2
276 static inline uint32_t
277 rte_align32pow2(uint32_t x)
290 * Aligns 64b input parameter to the next power of 2
293 * The 64b value to align
296 * Input parameter aligned to the next power of 2
298 static inline uint64_t
299 rte_align64pow2(uint64_t v)
312 /*********** Macros for calculating min and max **********/
315 * Macro to return the minimum of two numbers
317 #define RTE_MIN(a, b) \
319 typeof (a) _a = (a); \
320 typeof (b) _b = (b); \
325 * Macro to return the maximum of two numbers
327 #define RTE_MAX(a, b) \
329 typeof (a) _a = (a); \
330 typeof (b) _b = (b); \
334 /*********** Other general functions / macros ********/
337 * Searches the input parameter for the least significant set bit
338 * (starting from zero).
339 * If a least significant 1 bit is found, its bit index is returned.
340 * If the content of the input parameter is zero, then the content of the return
341 * value is undefined.
343 * input parameter, should not be zero.
345 * least significant set bit in the input parameter.
347 static inline uint32_t
348 rte_bsf32(uint32_t v)
350 return __builtin_ctz(v);
354 * Return the rounded-up log2 of a integer.
357 * The input parameter.
359 * The rounded-up log2 of the input, or 0 if the input is 0.
361 static inline uint32_t
362 rte_log2_u32(uint32_t v)
366 v = rte_align32pow2(v);
371 /** Return the offset of a field in a structure. */
372 #define offsetof(TYPE, MEMBER) __builtin_offsetof (TYPE, MEMBER)
376 * Return pointer to the wrapping struct instance.
386 * struct child *x = obtain(...);
387 * struct wrapper *w = container_of(x, struct wrapper, c);
390 #define container_of(ptr, type, member) __extension__ ({ \
391 const typeof(((type *)0)->member) *_ptr = (ptr); \
392 __attribute__((unused)) type *_target_ptr = \
394 (type *)(((uintptr_t)_ptr) - offsetof(type, member)); \
398 #define _RTE_STR(x) #x
399 /** Take a macro value and get a string version of it */
400 #define RTE_STR(x) _RTE_STR(x)
403 * ISO C helpers to modify format strings using variadic macros.
404 * This is a replacement for the ", ## __VA_ARGS__" GNU extension.
405 * An empty %s argument is appended to avoid a dangling comma.
407 #define RTE_FMT(fmt, ...) fmt "%.0s", __VA_ARGS__ ""
408 #define RTE_FMT_HEAD(fmt, ...) fmt
409 #define RTE_FMT_TAIL(fmt, ...) __VA_ARGS__
411 /** Mask value of type "tp" for the first "ln" bit set. */
412 #define RTE_LEN2MASK(ln, tp) \
413 ((tp)((uint64_t)-1 >> (sizeof(uint64_t) * CHAR_BIT - (ln))))
415 /** Number of elements in the array. */
416 #define RTE_DIM(a) (sizeof (a) / sizeof ((a)[0]))
419 * Converts a numeric string to the equivalent uint64_t value.
420 * As well as straight number conversion, also recognises the suffixes
421 * k, m and g for kilobytes, megabytes and gigabytes respectively.
423 * If a negative number is passed in i.e. a string with the first non-black
424 * character being "-", zero is returned. Zero is also returned in the case of
425 * an error with the strtoull call in the function.
428 * String containing number to convert.
432 static inline uint64_t
433 rte_str_to_size(const char *str)
436 unsigned long long size;
438 while (isspace((int)*str))
444 size = strtoull(str, &endptr, 0);
449 endptr++; /* allow 1 space gap */
452 case 'G': case 'g': size *= 1024; /* fall-through */
453 case 'M': case 'm': size *= 1024; /* fall-through */
454 case 'K': case 'k': size *= 1024; /* fall-through */
462 * Function to terminate the application immediately, printing an error
463 * message and returning the exit_code back to the shell.
465 * This function never returns
468 * The exit code to be returned by the application
470 * The format string to be used for printing the message. This can include
471 * printf format characters which will be expanded using any further parameters
475 rte_exit(int exit_code, const char *format, ...)
476 __attribute__((noreturn))
477 __attribute__((format(printf, 2, 3)));