1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2014 Intel Corporation
11 * Generic, commonly-used macro and inline function definitions
25 #include <rte_config.h>
28 #define typeof __typeof__
35 /** C extension macro for environments lacking C11 features. */
36 #if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 201112L
37 #define RTE_STD_C11 __extension__
42 /** Define GCC_VERSION **/
43 #ifdef RTE_TOOLCHAIN_GCC
44 #define GCC_VERSION (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + \
48 #ifdef RTE_ARCH_STRICT_ALIGN
49 typedef uint64_t unaligned_uint64_t __attribute__ ((aligned(1)));
50 typedef uint32_t unaligned_uint32_t __attribute__ ((aligned(1)));
51 typedef uint16_t unaligned_uint16_t __attribute__ ((aligned(1)));
53 typedef uint64_t unaligned_uint64_t;
54 typedef uint32_t unaligned_uint32_t;
55 typedef uint16_t unaligned_uint16_t;
61 #define __rte_aligned(a) __attribute__((__aligned__(a)))
64 * Force a structure to be packed
66 #define __rte_packed __attribute__((__packed__))
68 /******* Macro to mark functions and fields scheduled for removal *****/
69 #define __rte_deprecated __attribute__((__deprecated__))
71 /*********** Macros to eliminate unused variable warnings ********/
74 * short definition to mark a function parameter unused
76 #define __rte_unused __attribute__((__unused__))
79 * definition to mark a variable or function parameter as used so
80 * as to avoid a compiler warning
82 #define RTE_SET_USED(x) (void)(x)
84 #define RTE_PRIORITY_LOG 101
85 #define RTE_PRIORITY_BUS 110
86 #define RTE_PRIORITY_LAST 65535
88 #define RTE_PRIO(prio) \
92 * Run function before main() with high priority.
95 * Constructor function.
97 * Priority number must be above 100.
98 * Lowest number is the first to run.
100 #define RTE_INIT_PRIO(func, prio) \
101 static void __attribute__((constructor(RTE_PRIO(prio)), used)) func(void)
104 * Run function before main() with low priority.
106 * The constructor will be run after prioritized constructors.
109 * Constructor function.
111 #define RTE_INIT(func) \
112 RTE_INIT_PRIO(func, LAST)
115 * Run after main() with low priority.
118 * Destructor function name.
120 * Priority number must be above 100.
121 * Lowest number is the last to run.
123 #define RTE_FINI_PRIO(func, prio) \
124 static void __attribute__((destructor(RTE_PRIO(prio)), used)) func(void)
127 * Run after main() with high priority.
129 * The destructor will be run *before* prioritized destructors.
132 * Destructor function name.
134 #define RTE_FINI(func) \
135 RTE_FINI_PRIO(func, LAST)
138 * Force a function to be inlined
140 #define __rte_always_inline inline __attribute__((always_inline))
143 * Force a function to be noinlined
145 #define __rte_noinline __attribute__((noinline))
147 /*********** Macros for pointer arithmetic ********/
150 * add a byte-value offset to a pointer
152 #define RTE_PTR_ADD(ptr, x) ((void*)((uintptr_t)(ptr) + (x)))
155 * subtract a byte-value offset from a pointer
157 #define RTE_PTR_SUB(ptr, x) ((void*)((uintptr_t)ptr - (x)))
160 * get the difference between two pointer values, i.e. how far apart
161 * in bytes are the locations they point two. It is assumed that
162 * ptr1 is greater than ptr2.
164 #define RTE_PTR_DIFF(ptr1, ptr2) ((uintptr_t)(ptr1) - (uintptr_t)(ptr2))
166 /*********** Macros/static functions for doing alignment ********/
170 * Macro to align a pointer to a given power-of-two. The resultant
171 * pointer will be a pointer of the same type as the first parameter, and
172 * point to an address no higher than the first parameter. Second parameter
173 * must be a power-of-two value.
175 #define RTE_PTR_ALIGN_FLOOR(ptr, align) \
176 ((typeof(ptr))RTE_ALIGN_FLOOR((uintptr_t)ptr, align))
179 * Macro to align a value to a given power-of-two. The resultant value
180 * will be of the same type as the first parameter, and will be no
181 * bigger than the first parameter. Second parameter must be a
182 * power-of-two value.
184 #define RTE_ALIGN_FLOOR(val, align) \
185 (typeof(val))((val) & (~((typeof(val))((align) - 1))))
188 * Macro to align a pointer to a given power-of-two. The resultant
189 * pointer will be a pointer of the same type as the first parameter, and
190 * point to an address no lower than the first parameter. Second parameter
191 * must be a power-of-two value.
193 #define RTE_PTR_ALIGN_CEIL(ptr, align) \
194 RTE_PTR_ALIGN_FLOOR((typeof(ptr))RTE_PTR_ADD(ptr, (align) - 1), align)
197 * Macro to align a value to a given power-of-two. The resultant value
198 * will be of the same type as the first parameter, and will be no lower
199 * than the first parameter. Second parameter must be a power-of-two
202 #define RTE_ALIGN_CEIL(val, align) \
203 RTE_ALIGN_FLOOR(((val) + ((typeof(val)) (align) - 1)), align)
206 * Macro to align a pointer to a given power-of-two. The resultant
207 * pointer will be a pointer of the same type as the first parameter, and
208 * point to an address no lower than the first parameter. Second parameter
209 * must be a power-of-two value.
210 * This function is the same as RTE_PTR_ALIGN_CEIL
212 #define RTE_PTR_ALIGN(ptr, align) RTE_PTR_ALIGN_CEIL(ptr, align)
215 * Macro to align a value to a given power-of-two. The resultant
216 * value will be of the same type as the first parameter, and
217 * will be no lower than the first parameter. Second parameter
218 * must be a power-of-two value.
219 * This function is the same as RTE_ALIGN_CEIL
221 #define RTE_ALIGN(val, align) RTE_ALIGN_CEIL(val, align)
224 * Macro to align a value to the multiple of given value. The resultant
225 * value will be of the same type as the first parameter and will be no lower
226 * than the first parameter.
228 #define RTE_ALIGN_MUL_CEIL(v, mul) \
229 (((v + (typeof(v))(mul) - 1) / ((typeof(v))(mul))) * (typeof(v))(mul))
232 * Macro to align a value to the multiple of given value. The resultant
233 * value will be of the same type as the first parameter and will be no higher
234 * than the first parameter.
236 #define RTE_ALIGN_MUL_FLOOR(v, mul) \
237 ((v / ((typeof(v))(mul))) * (typeof(v))(mul))
240 * Checks if a pointer is aligned to a given power-of-two value
243 * The pointer whose alignment is to be checked
245 * The power-of-two value to which the ptr should be aligned
248 * True(1) where the pointer is correctly aligned, false(0) otherwise
251 rte_is_aligned(void *ptr, unsigned align)
253 return RTE_PTR_ALIGN(ptr, align) == ptr;
256 /*********** Macros for compile type checks ********/
259 * Triggers an error at compilation time if the condition is true.
262 #define RTE_BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
264 extern int RTE_BUILD_BUG_ON_detected_error;
265 #define RTE_BUILD_BUG_ON(condition) do { \
266 ((void)sizeof(char[1 - 2*!!(condition)])); \
268 RTE_BUILD_BUG_ON_detected_error = 1; \
273 * Combines 32b inputs most significant set bits into the least
274 * significant bits to construct a value with the same MSBs as x
275 * but all 1's under it.
278 * The integer whose MSBs need to be combined with its LSBs
280 * The combined value.
282 static inline uint32_t
283 rte_combine32ms1b(register uint32_t x)
295 * Combines 64b inputs most significant set bits into the least
296 * significant bits to construct a value with the same MSBs as x
297 * but all 1's under it.
300 * The integer whose MSBs need to be combined with its LSBs
302 * The combined value.
304 static inline uint64_t
305 rte_combine64ms1b(register uint64_t v)
317 /*********** Macros to work with powers of 2 ********/
320 * Macro to return 1 if n is a power of 2, 0 otherwise
322 #define RTE_IS_POWER_OF_2(n) ((n) && !(((n) - 1) & (n)))
325 * Returns true if n is a power of 2
328 * @return 1 if true, 0 otherwise
331 rte_is_power_of_2(uint32_t n)
333 return n && !(n & (n - 1));
337 * Aligns input parameter to the next power of 2
340 * The integer value to algin
343 * Input parameter aligned to the next power of 2
345 static inline uint32_t
346 rte_align32pow2(uint32_t x)
349 x = rte_combine32ms1b(x);
355 * Aligns input parameter to the previous power of 2
358 * The integer value to algin
361 * Input parameter aligned to the previous power of 2
363 static inline uint32_t
364 rte_align32prevpow2(uint32_t x)
366 x = rte_combine32ms1b(x);
372 * Aligns 64b input parameter to the next power of 2
375 * The 64b value to align
378 * Input parameter aligned to the next power of 2
380 static inline uint64_t
381 rte_align64pow2(uint64_t v)
384 v = rte_combine64ms1b(v);
390 * Aligns 64b input parameter to the previous power of 2
393 * The 64b value to align
396 * Input parameter aligned to the previous power of 2
398 static inline uint64_t
399 rte_align64prevpow2(uint64_t v)
401 v = rte_combine64ms1b(v);
406 /*********** Macros for calculating min and max **********/
409 * Macro to return the minimum of two numbers
411 #define RTE_MIN(a, b) \
413 typeof (a) _a = (a); \
414 typeof (b) _b = (b); \
419 * Macro to return the maximum of two numbers
421 #define RTE_MAX(a, b) \
423 typeof (a) _a = (a); \
424 typeof (b) _b = (b); \
428 /*********** Other general functions / macros ********/
431 * Searches the input parameter for the least significant set bit
432 * (starting from zero).
433 * If a least significant 1 bit is found, its bit index is returned.
434 * If the content of the input parameter is zero, then the content of the return
435 * value is undefined.
437 * input parameter, should not be zero.
439 * least significant set bit in the input parameter.
441 static inline uint32_t
442 rte_bsf32(uint32_t v)
444 return (uint32_t)__builtin_ctz(v);
448 * Return the rounded-up log2 of a integer.
451 * The input parameter.
453 * The rounded-up log2 of the input, or 0 if the input is 0.
455 static inline uint32_t
456 rte_log2_u32(uint32_t v)
460 v = rte_align32pow2(v);
465 /** Return the offset of a field in a structure. */
466 #define offsetof(TYPE, MEMBER) __builtin_offsetof (TYPE, MEMBER)
470 * Return pointer to the wrapping struct instance.
480 * struct child *x = obtain(...);
481 * struct wrapper *w = container_of(x, struct wrapper, c);
484 #define container_of(ptr, type, member) __extension__ ({ \
485 const typeof(((type *)0)->member) *_ptr = (ptr); \
486 __attribute__((unused)) type *_target_ptr = \
488 (type *)(((uintptr_t)_ptr) - offsetof(type, member)); \
492 #define _RTE_STR(x) #x
493 /** Take a macro value and get a string version of it */
494 #define RTE_STR(x) _RTE_STR(x)
497 * ISO C helpers to modify format strings using variadic macros.
498 * This is a replacement for the ", ## __VA_ARGS__" GNU extension.
499 * An empty %s argument is appended to avoid a dangling comma.
501 #define RTE_FMT(fmt, ...) fmt "%.0s", __VA_ARGS__ ""
502 #define RTE_FMT_HEAD(fmt, ...) fmt
503 #define RTE_FMT_TAIL(fmt, ...) __VA_ARGS__
505 /** Mask value of type "tp" for the first "ln" bit set. */
506 #define RTE_LEN2MASK(ln, tp) \
507 ((tp)((uint64_t)-1 >> (sizeof(uint64_t) * CHAR_BIT - (ln))))
509 /** Number of elements in the array. */
510 #define RTE_DIM(a) (sizeof (a) / sizeof ((a)[0]))
513 * Converts a numeric string to the equivalent uint64_t value.
514 * As well as straight number conversion, also recognises the suffixes
515 * k, m and g for kilobytes, megabytes and gigabytes respectively.
517 * If a negative number is passed in i.e. a string with the first non-black
518 * character being "-", zero is returned. Zero is also returned in the case of
519 * an error with the strtoull call in the function.
522 * String containing number to convert.
526 static inline uint64_t
527 rte_str_to_size(const char *str)
530 unsigned long long size;
532 while (isspace((int)*str))
538 size = strtoull(str, &endptr, 0);
543 endptr++; /* allow 1 space gap */
546 case 'G': case 'g': size *= 1024; /* fall-through */
547 case 'M': case 'm': size *= 1024; /* fall-through */
548 case 'K': case 'k': size *= 1024; /* fall-through */
556 * Function to terminate the application immediately, printing an error
557 * message and returning the exit_code back to the shell.
559 * This function never returns
562 * The exit code to be returned by the application
564 * The format string to be used for printing the message. This can include
565 * printf format characters which will be expanded using any further parameters
569 rte_exit(int exit_code, const char *format, ...)
570 __attribute__((noreturn))
571 __attribute__((format(printf, 2, 3)));