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 * Force a function to be inlined
117 #define __rte_always_inline inline __attribute__((always_inline))
120 * Force a function to be noinlined
122 #define __rte_noinline __attribute__((noinline))
124 /*********** Macros for pointer arithmetic ********/
127 * add a byte-value offset to a pointer
129 #define RTE_PTR_ADD(ptr, x) ((void*)((uintptr_t)(ptr) + (x)))
132 * subtract a byte-value offset from a pointer
134 #define RTE_PTR_SUB(ptr, x) ((void*)((uintptr_t)ptr - (x)))
137 * get the difference between two pointer values, i.e. how far apart
138 * in bytes are the locations they point two. It is assumed that
139 * ptr1 is greater than ptr2.
141 #define RTE_PTR_DIFF(ptr1, ptr2) ((uintptr_t)(ptr1) - (uintptr_t)(ptr2))
143 /*********** Macros/static functions for doing alignment ********/
147 * Macro to align a pointer to a given power-of-two. The resultant
148 * pointer will be a pointer of the same type as the first parameter, and
149 * point to an address no higher than the first parameter. Second parameter
150 * must be a power-of-two value.
152 #define RTE_PTR_ALIGN_FLOOR(ptr, align) \
153 ((typeof(ptr))RTE_ALIGN_FLOOR((uintptr_t)ptr, align))
156 * Macro to align a value to a given power-of-two. The resultant value
157 * will be of the same type as the first parameter, and will be no
158 * bigger than the first parameter. Second parameter must be a
159 * power-of-two value.
161 #define RTE_ALIGN_FLOOR(val, align) \
162 (typeof(val))((val) & (~((typeof(val))((align) - 1))))
165 * Macro to align a pointer to a given power-of-two. The resultant
166 * pointer will be a pointer of the same type as the first parameter, and
167 * point to an address no lower than the first parameter. Second parameter
168 * must be a power-of-two value.
170 #define RTE_PTR_ALIGN_CEIL(ptr, align) \
171 RTE_PTR_ALIGN_FLOOR((typeof(ptr))RTE_PTR_ADD(ptr, (align) - 1), align)
174 * Macro to align a value to a given power-of-two. The resultant value
175 * will be of the same type as the first parameter, and will be no lower
176 * than the first parameter. Second parameter must be a power-of-two
179 #define RTE_ALIGN_CEIL(val, align) \
180 RTE_ALIGN_FLOOR(((val) + ((typeof(val)) (align) - 1)), align)
183 * Macro to align a pointer to a given power-of-two. The resultant
184 * pointer will be a pointer of the same type as the first parameter, and
185 * point to an address no lower than the first parameter. Second parameter
186 * must be a power-of-two value.
187 * This function is the same as RTE_PTR_ALIGN_CEIL
189 #define RTE_PTR_ALIGN(ptr, align) RTE_PTR_ALIGN_CEIL(ptr, align)
192 * Macro to align a value to a given power-of-two. The resultant
193 * value will be of the same type as the first parameter, and
194 * will be no lower than the first parameter. Second parameter
195 * must be a power-of-two value.
196 * This function is the same as RTE_ALIGN_CEIL
198 #define RTE_ALIGN(val, align) RTE_ALIGN_CEIL(val, align)
201 * Macro to align a value to the multiple of given value. The resultant
202 * value will be of the same type as the first parameter and will be no lower
203 * than the first parameter.
205 #define RTE_ALIGN_MUL_CEIL(v, mul) \
206 (((v + (typeof(v))(mul) - 1) / ((typeof(v))(mul))) * (typeof(v))(mul))
209 * Macro to align a value to the multiple of given value. The resultant
210 * value will be of the same type as the first parameter and will be no higher
211 * than the first parameter.
213 #define RTE_ALIGN_MUL_FLOOR(v, mul) \
214 ((v / ((typeof(v))(mul))) * (typeof(v))(mul))
217 * Checks if a pointer is aligned to a given power-of-two value
220 * The pointer whose alignment is to be checked
222 * The power-of-two value to which the ptr should be aligned
225 * True(1) where the pointer is correctly aligned, false(0) otherwise
228 rte_is_aligned(void *ptr, unsigned align)
230 return RTE_PTR_ALIGN(ptr, align) == ptr;
233 /*********** Macros for compile type checks ********/
236 * Triggers an error at compilation time if the condition is true.
239 #define RTE_BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
241 extern int RTE_BUILD_BUG_ON_detected_error;
242 #define RTE_BUILD_BUG_ON(condition) do { \
243 ((void)sizeof(char[1 - 2*!!(condition)])); \
245 RTE_BUILD_BUG_ON_detected_error = 1; \
250 * Combines 32b inputs most significant set bits into the least
251 * significant bits to construct a value with the same MSBs as x
252 * but all 1's under it.
255 * The integer whose MSBs need to be combined with its LSBs
257 * The combined value.
259 static inline uint32_t
260 rte_combine32ms1b(register uint32_t x)
272 * Combines 64b inputs most significant set bits into the least
273 * significant bits to construct a value with the same MSBs as x
274 * but all 1's under it.
277 * The integer whose MSBs need to be combined with its LSBs
279 * The combined value.
281 static inline uint64_t
282 rte_combine64ms1b(register uint64_t v)
294 /*********** Macros to work with powers of 2 ********/
297 * Macro to return 1 if n is a power of 2, 0 otherwise
299 #define RTE_IS_POWER_OF_2(n) ((n) && !(((n) - 1) & (n)))
302 * Returns true if n is a power of 2
305 * @return 1 if true, 0 otherwise
308 rte_is_power_of_2(uint32_t n)
310 return n && !(n & (n - 1));
314 * Aligns input parameter to the next power of 2
317 * The integer value to algin
320 * Input parameter aligned to the next power of 2
322 static inline uint32_t
323 rte_align32pow2(uint32_t x)
326 x = rte_combine32ms1b(x);
332 * Aligns input parameter to the previous power of 2
335 * The integer value to algin
338 * Input parameter aligned to the previous power of 2
340 static inline uint32_t
341 rte_align32prevpow2(uint32_t x)
343 x = rte_combine32ms1b(x);
349 * Aligns 64b input parameter to the next power of 2
352 * The 64b value to align
355 * Input parameter aligned to the next power of 2
357 static inline uint64_t
358 rte_align64pow2(uint64_t v)
361 v = rte_combine64ms1b(v);
367 * Aligns 64b input parameter to the previous power of 2
370 * The 64b value to align
373 * Input parameter aligned to the previous power of 2
375 static inline uint64_t
376 rte_align64prevpow2(uint64_t v)
378 v = rte_combine64ms1b(v);
383 /*********** Macros for calculating min and max **********/
386 * Macro to return the minimum of two numbers
388 #define RTE_MIN(a, b) \
390 typeof (a) _a = (a); \
391 typeof (b) _b = (b); \
396 * Macro to return the maximum of two numbers
398 #define RTE_MAX(a, b) \
400 typeof (a) _a = (a); \
401 typeof (b) _b = (b); \
405 /*********** Other general functions / macros ********/
408 * Searches the input parameter for the least significant set bit
409 * (starting from zero).
410 * If a least significant 1 bit is found, its bit index is returned.
411 * If the content of the input parameter is zero, then the content of the return
412 * value is undefined.
414 * input parameter, should not be zero.
416 * least significant set bit in the input parameter.
418 static inline uint32_t
419 rte_bsf32(uint32_t v)
421 return (uint32_t)__builtin_ctz(v);
425 * Return the rounded-up log2 of a integer.
428 * The input parameter.
430 * The rounded-up log2 of the input, or 0 if the input is 0.
432 static inline uint32_t
433 rte_log2_u32(uint32_t v)
437 v = rte_align32pow2(v);
442 /** Return the offset of a field in a structure. */
443 #define offsetof(TYPE, MEMBER) __builtin_offsetof (TYPE, MEMBER)
447 * Return pointer to the wrapping struct instance.
457 * struct child *x = obtain(...);
458 * struct wrapper *w = container_of(x, struct wrapper, c);
461 #define container_of(ptr, type, member) __extension__ ({ \
462 const typeof(((type *)0)->member) *_ptr = (ptr); \
463 __attribute__((unused)) type *_target_ptr = \
465 (type *)(((uintptr_t)_ptr) - offsetof(type, member)); \
469 #define _RTE_STR(x) #x
470 /** Take a macro value and get a string version of it */
471 #define RTE_STR(x) _RTE_STR(x)
474 * ISO C helpers to modify format strings using variadic macros.
475 * This is a replacement for the ", ## __VA_ARGS__" GNU extension.
476 * An empty %s argument is appended to avoid a dangling comma.
478 #define RTE_FMT(fmt, ...) fmt "%.0s", __VA_ARGS__ ""
479 #define RTE_FMT_HEAD(fmt, ...) fmt
480 #define RTE_FMT_TAIL(fmt, ...) __VA_ARGS__
482 /** Mask value of type "tp" for the first "ln" bit set. */
483 #define RTE_LEN2MASK(ln, tp) \
484 ((tp)((uint64_t)-1 >> (sizeof(uint64_t) * CHAR_BIT - (ln))))
486 /** Number of elements in the array. */
487 #define RTE_DIM(a) (sizeof (a) / sizeof ((a)[0]))
490 * Converts a numeric string to the equivalent uint64_t value.
491 * As well as straight number conversion, also recognises the suffixes
492 * k, m and g for kilobytes, megabytes and gigabytes respectively.
494 * If a negative number is passed in i.e. a string with the first non-black
495 * character being "-", zero is returned. Zero is also returned in the case of
496 * an error with the strtoull call in the function.
499 * String containing number to convert.
503 static inline uint64_t
504 rte_str_to_size(const char *str)
507 unsigned long long size;
509 while (isspace((int)*str))
515 size = strtoull(str, &endptr, 0);
520 endptr++; /* allow 1 space gap */
523 case 'G': case 'g': size *= 1024; /* fall-through */
524 case 'M': case 'm': size *= 1024; /* fall-through */
525 case 'K': case 'k': size *= 1024; /* fall-through */
533 * Function to terminate the application immediately, printing an error
534 * message and returning the exit_code back to the shell.
536 * This function never returns
539 * The exit code to be returned by the application
541 * The format string to be used for printing the message. This can include
542 * printf format characters which will be expanded using any further parameters
546 rte_exit(int exit_code, const char *format, ...)
547 __attribute__((noreturn))
548 __attribute__((format(printf, 2, 3)));