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__))
72 * Mark a function or variable to a weak reference.
74 #define __rte_weak __attribute__((__weak__))
76 /*********** Macros to eliminate unused variable warnings ********/
79 * short definition to mark a function parameter unused
81 #define __rte_unused __attribute__((__unused__))
84 * definition to mark a variable or function parameter as used so
85 * as to avoid a compiler warning
87 #define RTE_SET_USED(x) (void)(x)
89 #define RTE_PRIORITY_LOG 101
90 #define RTE_PRIORITY_BUS 110
91 #define RTE_PRIORITY_CLASS 120
92 #define RTE_PRIORITY_LAST 65535
94 #define RTE_PRIO(prio) \
98 * Run function before main() with high priority.
101 * Constructor function.
103 * Priority number must be above 100.
104 * Lowest number is the first to run.
106 #define RTE_INIT_PRIO(func, prio) \
107 static void __attribute__((constructor(RTE_PRIO(prio)), used)) func(void)
110 * Run function before main() with low priority.
112 * The constructor will be run after prioritized constructors.
115 * Constructor function.
117 #define RTE_INIT(func) \
118 RTE_INIT_PRIO(func, LAST)
121 * Run after main() with low priority.
124 * Destructor function name.
126 * Priority number must be above 100.
127 * Lowest number is the last to run.
129 #define RTE_FINI_PRIO(func, prio) \
130 static void __attribute__((destructor(RTE_PRIO(prio)), used)) func(void)
133 * Run after main() with high priority.
135 * The destructor will be run *before* prioritized destructors.
138 * Destructor function name.
140 #define RTE_FINI(func) \
141 RTE_FINI_PRIO(func, LAST)
144 * Force a function to be inlined
146 #define __rte_always_inline inline __attribute__((always_inline))
149 * Force a function to be noinlined
151 #define __rte_noinline __attribute__((noinline))
153 /*********** Macros for pointer arithmetic ********/
156 * add a byte-value offset to a pointer
158 #define RTE_PTR_ADD(ptr, x) ((void*)((uintptr_t)(ptr) + (x)))
161 * subtract a byte-value offset from a pointer
163 #define RTE_PTR_SUB(ptr, x) ((void*)((uintptr_t)ptr - (x)))
166 * get the difference between two pointer values, i.e. how far apart
167 * in bytes are the locations they point two. It is assumed that
168 * ptr1 is greater than ptr2.
170 #define RTE_PTR_DIFF(ptr1, ptr2) ((uintptr_t)(ptr1) - (uintptr_t)(ptr2))
172 /*********** Macros/static functions for doing alignment ********/
176 * Macro to align a pointer to a given power-of-two. The resultant
177 * pointer will be a pointer of the same type as the first parameter, and
178 * point to an address no higher than the first parameter. Second parameter
179 * must be a power-of-two value.
181 #define RTE_PTR_ALIGN_FLOOR(ptr, align) \
182 ((typeof(ptr))RTE_ALIGN_FLOOR((uintptr_t)ptr, align))
185 * Macro to align a value to a given power-of-two. The resultant value
186 * will be of the same type as the first parameter, and will be no
187 * bigger than the first parameter. Second parameter must be a
188 * power-of-two value.
190 #define RTE_ALIGN_FLOOR(val, align) \
191 (typeof(val))((val) & (~((typeof(val))((align) - 1))))
194 * Macro to align a pointer to a given power-of-two. The resultant
195 * pointer will be a pointer of the same type as the first parameter, and
196 * point to an address no lower than the first parameter. Second parameter
197 * must be a power-of-two value.
199 #define RTE_PTR_ALIGN_CEIL(ptr, align) \
200 RTE_PTR_ALIGN_FLOOR((typeof(ptr))RTE_PTR_ADD(ptr, (align) - 1), align)
203 * Macro to align a value to a given power-of-two. The resultant value
204 * will be of the same type as the first parameter, and will be no lower
205 * than the first parameter. Second parameter must be a power-of-two
208 #define RTE_ALIGN_CEIL(val, align) \
209 RTE_ALIGN_FLOOR(((val) + ((typeof(val)) (align) - 1)), align)
212 * Macro to align a pointer to a given power-of-two. The resultant
213 * pointer will be a pointer of the same type as the first parameter, and
214 * point to an address no lower than the first parameter. Second parameter
215 * must be a power-of-two value.
216 * This function is the same as RTE_PTR_ALIGN_CEIL
218 #define RTE_PTR_ALIGN(ptr, align) RTE_PTR_ALIGN_CEIL(ptr, align)
221 * Macro to align a value to a given power-of-two. The resultant
222 * value will be of the same type as the first parameter, and
223 * will be no lower than the first parameter. Second parameter
224 * must be a power-of-two value.
225 * This function is the same as RTE_ALIGN_CEIL
227 #define RTE_ALIGN(val, align) RTE_ALIGN_CEIL(val, align)
230 * Macro to align a value to the multiple of given value. The resultant
231 * value will be of the same type as the first parameter and will be no lower
232 * than the first parameter.
234 #define RTE_ALIGN_MUL_CEIL(v, mul) \
235 (((v + (typeof(v))(mul) - 1) / ((typeof(v))(mul))) * (typeof(v))(mul))
238 * Macro to align a value to the multiple of given value. The resultant
239 * value will be of the same type as the first parameter and will be no higher
240 * than the first parameter.
242 #define RTE_ALIGN_MUL_FLOOR(v, mul) \
243 ((v / ((typeof(v))(mul))) * (typeof(v))(mul))
246 * Checks if a pointer is aligned to a given power-of-two value
249 * The pointer whose alignment is to be checked
251 * The power-of-two value to which the ptr should be aligned
254 * True(1) where the pointer is correctly aligned, false(0) otherwise
257 rte_is_aligned(void *ptr, unsigned align)
259 return RTE_PTR_ALIGN(ptr, align) == ptr;
262 /*********** Macros for compile type checks ********/
265 * Triggers an error at compilation time if the condition is true.
268 #define RTE_BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
270 extern int RTE_BUILD_BUG_ON_detected_error;
271 #define RTE_BUILD_BUG_ON(condition) do { \
272 ((void)sizeof(char[1 - 2*!!(condition)])); \
274 RTE_BUILD_BUG_ON_detected_error = 1; \
279 * Combines 32b inputs most significant set bits into the least
280 * significant bits to construct a value with the same MSBs as x
281 * but all 1's under it.
284 * The integer whose MSBs need to be combined with its LSBs
286 * The combined value.
288 static inline uint32_t
289 rte_combine32ms1b(register uint32_t x)
301 * Combines 64b inputs most significant set bits into the least
302 * significant bits to construct a value with the same MSBs as x
303 * but all 1's under it.
306 * The integer whose MSBs need to be combined with its LSBs
308 * The combined value.
310 static inline uint64_t
311 rte_combine64ms1b(register uint64_t v)
323 /*********** Macros to work with powers of 2 ********/
326 * Macro to return 1 if n is a power of 2, 0 otherwise
328 #define RTE_IS_POWER_OF_2(n) ((n) && !(((n) - 1) & (n)))
331 * Returns true if n is a power of 2
334 * @return 1 if true, 0 otherwise
337 rte_is_power_of_2(uint32_t n)
339 return n && !(n & (n - 1));
343 * Aligns input parameter to the next power of 2
346 * The integer value to algin
349 * Input parameter aligned to the next power of 2
351 static inline uint32_t
352 rte_align32pow2(uint32_t x)
355 x = rte_combine32ms1b(x);
361 * Aligns input parameter to the previous power of 2
364 * The integer value to algin
367 * Input parameter aligned to the previous power of 2
369 static inline uint32_t
370 rte_align32prevpow2(uint32_t x)
372 x = rte_combine32ms1b(x);
378 * Aligns 64b input parameter to the next power of 2
381 * The 64b value to align
384 * Input parameter aligned to the next power of 2
386 static inline uint64_t
387 rte_align64pow2(uint64_t v)
390 v = rte_combine64ms1b(v);
396 * Aligns 64b input parameter to the previous power of 2
399 * The 64b value to align
402 * Input parameter aligned to the previous power of 2
404 static inline uint64_t
405 rte_align64prevpow2(uint64_t v)
407 v = rte_combine64ms1b(v);
412 /*********** Macros for calculating min and max **********/
415 * Macro to return the minimum of two numbers
417 #define RTE_MIN(a, b) \
419 typeof (a) _a = (a); \
420 typeof (b) _b = (b); \
425 * Macro to return the maximum of two numbers
427 #define RTE_MAX(a, b) \
429 typeof (a) _a = (a); \
430 typeof (b) _b = (b); \
434 /*********** Other general functions / macros ********/
437 * Searches the input parameter for the least significant set bit
438 * (starting from zero).
439 * If a least significant 1 bit is found, its bit index is returned.
440 * If the content of the input parameter is zero, then the content of the return
441 * value is undefined.
443 * input parameter, should not be zero.
445 * least significant set bit in the input parameter.
447 static inline uint32_t
448 rte_bsf32(uint32_t v)
450 return (uint32_t)__builtin_ctz(v);
454 * Return the rounded-up log2 of a integer.
457 * The input parameter.
459 * The rounded-up log2 of the input, or 0 if the input is 0.
461 static inline uint32_t
462 rte_log2_u32(uint32_t v)
466 v = rte_align32pow2(v);
471 /** Return the offset of a field in a structure. */
472 #define offsetof(TYPE, MEMBER) __builtin_offsetof (TYPE, MEMBER)
476 * Return pointer to the wrapping struct instance.
486 * struct child *x = obtain(...);
487 * struct wrapper *w = container_of(x, struct wrapper, c);
490 #define container_of(ptr, type, member) __extension__ ({ \
491 const typeof(((type *)0)->member) *_ptr = (ptr); \
492 __attribute__((unused)) type *_target_ptr = \
494 (type *)(((uintptr_t)_ptr) - offsetof(type, member)); \
498 #define _RTE_STR(x) #x
499 /** Take a macro value and get a string version of it */
500 #define RTE_STR(x) _RTE_STR(x)
503 * ISO C helpers to modify format strings using variadic macros.
504 * This is a replacement for the ", ## __VA_ARGS__" GNU extension.
505 * An empty %s argument is appended to avoid a dangling comma.
507 #define RTE_FMT(fmt, ...) fmt "%.0s", __VA_ARGS__ ""
508 #define RTE_FMT_HEAD(fmt, ...) fmt
509 #define RTE_FMT_TAIL(fmt, ...) __VA_ARGS__
511 /** Mask value of type "tp" for the first "ln" bit set. */
512 #define RTE_LEN2MASK(ln, tp) \
513 ((tp)((uint64_t)-1 >> (sizeof(uint64_t) * CHAR_BIT - (ln))))
515 /** Number of elements in the array. */
516 #define RTE_DIM(a) (sizeof (a) / sizeof ((a)[0]))
519 * Converts a numeric string to the equivalent uint64_t value.
520 * As well as straight number conversion, also recognises the suffixes
521 * k, m and g for kilobytes, megabytes and gigabytes respectively.
523 * If a negative number is passed in i.e. a string with the first non-black
524 * character being "-", zero is returned. Zero is also returned in the case of
525 * an error with the strtoull call in the function.
528 * String containing number to convert.
532 static inline uint64_t
533 rte_str_to_size(const char *str)
536 unsigned long long size;
538 while (isspace((int)*str))
544 size = strtoull(str, &endptr, 0);
549 endptr++; /* allow 1 space gap */
552 case 'G': case 'g': size *= 1024; /* fall-through */
553 case 'M': case 'm': size *= 1024; /* fall-through */
554 case 'K': case 'k': size *= 1024; /* fall-through */
562 * Function to terminate the application immediately, printing an error
563 * message and returning the exit_code back to the shell.
565 * This function never returns
568 * The exit code to be returned by the application
570 * The format string to be used for printing the message. This can include
571 * printf format characters which will be expanded using any further parameters
575 rte_exit(int exit_code, const char *format, ...)
576 __attribute__((noreturn))
577 __attribute__((format(printf, 2, 3)));