1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2019 Intel Corporation
11 * Generic, commonly-used macro and inline function definitions
25 #include <rte_config.h>
27 /* OS specific include */
31 #define typeof __typeof__
38 /** C extension macro for environments lacking C11 features. */
39 #if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 201112L
40 #define RTE_STD_C11 __extension__
45 /** Define GCC_VERSION **/
46 #ifdef RTE_TOOLCHAIN_GCC
47 #define GCC_VERSION (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + \
51 #ifdef RTE_ARCH_STRICT_ALIGN
52 typedef uint64_t unaligned_uint64_t __attribute__ ((aligned(1)));
53 typedef uint32_t unaligned_uint32_t __attribute__ ((aligned(1)));
54 typedef uint16_t unaligned_uint16_t __attribute__ ((aligned(1)));
56 typedef uint64_t unaligned_uint64_t;
57 typedef uint32_t unaligned_uint32_t;
58 typedef uint16_t unaligned_uint16_t;
64 #define __rte_aligned(a) __attribute__((__aligned__(a)))
67 * Force a structure to be packed
69 #define __rte_packed __attribute__((__packed__))
71 /******* Macro to mark functions and fields scheduled for removal *****/
72 #define __rte_deprecated __attribute__((__deprecated__))
75 * Mark a function or variable to a weak reference.
77 #define __rte_weak __attribute__((__weak__))
79 /*********** Macros to eliminate unused variable warnings ********/
82 * short definition to mark a function parameter unused
84 #define __rte_unused __attribute__((__unused__))
87 * definition to mark a variable or function parameter as used so
88 * as to avoid a compiler warning
90 #define RTE_SET_USED(x) (void)(x)
92 #define RTE_PRIORITY_LOG 101
93 #define RTE_PRIORITY_BUS 110
94 #define RTE_PRIORITY_CLASS 120
95 #define RTE_PRIORITY_LAST 65535
97 #define RTE_PRIO(prio) \
101 * Run function before main() with high priority.
104 * Constructor function.
106 * Priority number must be above 100.
107 * Lowest number is the first to run.
109 #ifndef RTE_INIT_PRIO /* Allow to override from EAL */
110 #define RTE_INIT_PRIO(func, prio) \
111 static void __attribute__((constructor(RTE_PRIO(prio)), used)) func(void)
115 * Run function before main() with low priority.
117 * The constructor will be run after prioritized constructors.
120 * Constructor function.
122 #define RTE_INIT(func) \
123 RTE_INIT_PRIO(func, LAST)
126 * Run after main() with low priority.
129 * Destructor function name.
131 * Priority number must be above 100.
132 * Lowest number is the last to run.
134 #ifndef RTE_FINI_PRIO /* Allow to override from EAL */
135 #define RTE_FINI_PRIO(func, prio) \
136 static void __attribute__((destructor(RTE_PRIO(prio)), used)) func(void)
140 * Run after main() with high priority.
142 * The destructor will be run *before* prioritized destructors.
145 * Destructor function name.
147 #define RTE_FINI(func) \
148 RTE_FINI_PRIO(func, LAST)
151 * Force a function to be inlined
153 #define __rte_always_inline inline __attribute__((always_inline))
156 * Force a function to be noinlined
158 #define __rte_noinline __attribute__((noinline))
160 /*********** Macros for pointer arithmetic ********/
163 * add a byte-value offset to a pointer
165 #define RTE_PTR_ADD(ptr, x) ((void*)((uintptr_t)(ptr) + (x)))
168 * subtract a byte-value offset from a pointer
170 #define RTE_PTR_SUB(ptr, x) ((void*)((uintptr_t)ptr - (x)))
173 * get the difference between two pointer values, i.e. how far apart
174 * in bytes are the locations they point two. It is assumed that
175 * ptr1 is greater than ptr2.
177 #define RTE_PTR_DIFF(ptr1, ptr2) ((uintptr_t)(ptr1) - (uintptr_t)(ptr2))
180 * Workaround to cast a const field of a structure to non-const type.
182 #define RTE_CAST_FIELD(var, field, type) \
183 (*(type *)((uintptr_t)(var) + offsetof(typeof(*(var)), field)))
185 /*********** Macros/static functions for doing alignment ********/
189 * Macro to align a pointer to a given power-of-two. The resultant
190 * pointer will be a pointer of the same type as the first parameter, and
191 * point to an address no higher than the first parameter. Second parameter
192 * must be a power-of-two value.
194 #define RTE_PTR_ALIGN_FLOOR(ptr, align) \
195 ((typeof(ptr))RTE_ALIGN_FLOOR((uintptr_t)ptr, align))
198 * Macro to align a value to a given power-of-two. The resultant value
199 * will be of the same type as the first parameter, and will be no
200 * bigger than the first parameter. Second parameter must be a
201 * power-of-two value.
203 #define RTE_ALIGN_FLOOR(val, align) \
204 (typeof(val))((val) & (~((typeof(val))((align) - 1))))
207 * Macro to align a pointer to a given power-of-two. The resultant
208 * pointer will be a pointer of the same type as the first parameter, and
209 * point to an address no lower than the first parameter. Second parameter
210 * must be a power-of-two value.
212 #define RTE_PTR_ALIGN_CEIL(ptr, align) \
213 RTE_PTR_ALIGN_FLOOR((typeof(ptr))RTE_PTR_ADD(ptr, (align) - 1), align)
216 * Macro to align a value to a given power-of-two. The resultant value
217 * will be of the same type as the first parameter, and will be no lower
218 * than the first parameter. Second parameter must be a power-of-two
221 #define RTE_ALIGN_CEIL(val, align) \
222 RTE_ALIGN_FLOOR(((val) + ((typeof(val)) (align) - 1)), align)
225 * Macro to align a pointer to a given power-of-two. The resultant
226 * pointer will be a pointer of the same type as the first parameter, and
227 * point to an address no lower than the first parameter. Second parameter
228 * must be a power-of-two value.
229 * This function is the same as RTE_PTR_ALIGN_CEIL
231 #define RTE_PTR_ALIGN(ptr, align) RTE_PTR_ALIGN_CEIL(ptr, align)
234 * Macro to align a value to a given power-of-two. The resultant
235 * value will be of the same type as the first parameter, and
236 * will be no lower than the first parameter. Second parameter
237 * must be a power-of-two value.
238 * This function is the same as RTE_ALIGN_CEIL
240 #define RTE_ALIGN(val, align) RTE_ALIGN_CEIL(val, align)
243 * Macro to align a value to the multiple of given value. The resultant
244 * value will be of the same type as the first parameter and will be no lower
245 * than the first parameter.
247 #define RTE_ALIGN_MUL_CEIL(v, mul) \
248 (((v + (typeof(v))(mul) - 1) / ((typeof(v))(mul))) * (typeof(v))(mul))
251 * Macro to align a value to the multiple of given value. The resultant
252 * value will be of the same type as the first parameter and will be no higher
253 * than the first parameter.
255 #define RTE_ALIGN_MUL_FLOOR(v, mul) \
256 ((v / ((typeof(v))(mul))) * (typeof(v))(mul))
259 * Macro to align value to the nearest multiple of the given value.
260 * The resultant value might be greater than or less than the first parameter
261 * whichever difference is the lowest.
263 #define RTE_ALIGN_MUL_NEAR(v, mul) \
265 typeof(v) ceil = RTE_ALIGN_MUL_CEIL(v, mul); \
266 typeof(v) floor = RTE_ALIGN_MUL_FLOOR(v, mul); \
267 (ceil - v) > (v - floor) ? floor : ceil; \
271 * Checks if a pointer is aligned to a given power-of-two value
274 * The pointer whose alignment is to be checked
276 * The power-of-two value to which the ptr should be aligned
279 * True(1) where the pointer is correctly aligned, false(0) otherwise
282 rte_is_aligned(void *ptr, unsigned align)
284 return RTE_PTR_ALIGN(ptr, align) == ptr;
287 /*********** Macros for compile type checks ********/
290 * Triggers an error at compilation time if the condition is true.
292 #define RTE_BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
294 /*********** Cache line related macros ********/
296 /** Cache line mask. */
297 #define RTE_CACHE_LINE_MASK (RTE_CACHE_LINE_SIZE-1)
299 /** Return the first cache-aligned value greater or equal to size. */
300 #define RTE_CACHE_LINE_ROUNDUP(size) \
301 (RTE_CACHE_LINE_SIZE * ((size + RTE_CACHE_LINE_SIZE - 1) / \
302 RTE_CACHE_LINE_SIZE))
304 /** Cache line size in terms of log2 */
305 #if RTE_CACHE_LINE_SIZE == 64
306 #define RTE_CACHE_LINE_SIZE_LOG2 6
307 #elif RTE_CACHE_LINE_SIZE == 128
308 #define RTE_CACHE_LINE_SIZE_LOG2 7
310 #error "Unsupported cache line size"
313 /** Minimum Cache line size. */
314 #define RTE_CACHE_LINE_MIN_SIZE 64
316 /** Force alignment to cache line. */
317 #define __rte_cache_aligned __rte_aligned(RTE_CACHE_LINE_SIZE)
319 /** Force minimum cache line alignment. */
320 #define __rte_cache_min_aligned __rte_aligned(RTE_CACHE_LINE_MIN_SIZE)
322 /*********** PA/IOVA type definitions ********/
324 /** Physical address */
325 typedef uint64_t phys_addr_t;
326 #define RTE_BAD_PHYS_ADDR ((phys_addr_t)-1)
329 * IO virtual address type.
330 * When the physical addressing mode (IOVA as PA) is in use,
331 * the translation from an IO virtual address (IOVA) to a physical address
332 * is a direct mapping, i.e. the same value.
333 * Otherwise, in virtual mode (IOVA as VA), an IOMMU may do the translation.
335 typedef uint64_t rte_iova_t;
336 #define RTE_BAD_IOVA ((rte_iova_t)-1)
338 /*********** Structure alignment markers ********/
340 /** Generic marker for any place in a structure. */
341 __extension__ typedef void *RTE_MARKER[0];
342 /** Marker for 1B alignment in a structure. */
343 __extension__ typedef uint8_t RTE_MARKER8[0];
344 /** Marker for 2B alignment in a structure. */
345 __extension__ typedef uint16_t RTE_MARKER16[0];
346 /** Marker for 4B alignment in a structure. */
347 __extension__ typedef uint16_t RTE_MARKER32[0];
348 /** Marker for 8B alignment in a structure. */
349 __extension__ typedef uint64_t RTE_MARKER64[0];
352 * Combines 32b inputs most significant set bits into the least
353 * significant bits to construct a value with the same MSBs as x
354 * but all 1's under it.
357 * The integer whose MSBs need to be combined with its LSBs
359 * The combined value.
361 static inline uint32_t
362 rte_combine32ms1b(register uint32_t x)
374 * Combines 64b inputs most significant set bits into the least
375 * significant bits to construct a value with the same MSBs as x
376 * but all 1's under it.
379 * The integer whose MSBs need to be combined with its LSBs
381 * The combined value.
383 static inline uint64_t
384 rte_combine64ms1b(register uint64_t v)
396 /*********** Macros to work with powers of 2 ********/
399 * Macro to return 1 if n is a power of 2, 0 otherwise
401 #define RTE_IS_POWER_OF_2(n) ((n) && !(((n) - 1) & (n)))
404 * Returns true if n is a power of 2
407 * @return 1 if true, 0 otherwise
410 rte_is_power_of_2(uint32_t n)
412 return n && !(n & (n - 1));
416 * Aligns input parameter to the next power of 2
419 * The integer value to align
422 * Input parameter aligned to the next power of 2
424 static inline uint32_t
425 rte_align32pow2(uint32_t x)
428 x = rte_combine32ms1b(x);
434 * Aligns input parameter to the previous power of 2
437 * The integer value to align
440 * Input parameter aligned to the previous power of 2
442 static inline uint32_t
443 rte_align32prevpow2(uint32_t x)
445 x = rte_combine32ms1b(x);
451 * Aligns 64b input parameter to the next power of 2
454 * The 64b value to align
457 * Input parameter aligned to the next power of 2
459 static inline uint64_t
460 rte_align64pow2(uint64_t v)
463 v = rte_combine64ms1b(v);
469 * Aligns 64b input parameter to the previous power of 2
472 * The 64b value to align
475 * Input parameter aligned to the previous power of 2
477 static inline uint64_t
478 rte_align64prevpow2(uint64_t v)
480 v = rte_combine64ms1b(v);
485 /*********** Macros for calculating min and max **********/
488 * Macro to return the minimum of two numbers
490 #define RTE_MIN(a, b) \
492 typeof (a) _a = (a); \
493 typeof (b) _b = (b); \
498 * Macro to return the maximum of two numbers
500 #define RTE_MAX(a, b) \
502 typeof (a) _a = (a); \
503 typeof (b) _b = (b); \
507 /*********** Other general functions / macros ********/
510 * Searches the input parameter for the least significant set bit
511 * (starting from zero).
512 * If a least significant 1 bit is found, its bit index is returned.
513 * If the content of the input parameter is zero, then the content of the return
514 * value is undefined.
516 * input parameter, should not be zero.
518 * least significant set bit in the input parameter.
520 static inline uint32_t
521 rte_bsf32(uint32_t v)
523 return (uint32_t)__builtin_ctz(v);
527 * Searches the input parameter for the least significant set bit
528 * (starting from zero). Safe version (checks for input parameter being zero).
530 * @warning ``pos`` must be a valid pointer. It is not checked!
533 * The input parameter.
535 * If ``v`` was not 0, this value will contain position of least significant
536 * bit within the input parameter.
538 * Returns 0 if ``v`` was 0, otherwise returns 1.
541 rte_bsf32_safe(uint64_t v, uint32_t *pos)
551 * Return the rounded-up log2 of a integer.
553 * @note Contrary to the logarithm mathematical operation,
554 * rte_log2_u32(0) == 0 and not -inf.
557 * The input parameter.
559 * The rounded-up log2 of the input, or 0 if the input is 0.
561 static inline uint32_t
562 rte_log2_u32(uint32_t v)
566 v = rte_align32pow2(v);
572 * Return the last (most-significant) bit set.
574 * @note The last (most significant) bit is at position 32.
575 * @note rte_fls_u32(0) = 0, rte_fls_u32(1) = 1, rte_fls_u32(0x80000000) = 32
578 * The input parameter.
580 * The last (most-significant) bit set, or 0 if the input is 0.
583 rte_fls_u32(uint32_t x)
585 return (x == 0) ? 0 : 32 - __builtin_clz(x);
589 * Searches the input parameter for the least significant set bit
590 * (starting from zero).
591 * If a least significant 1 bit is found, its bit index is returned.
592 * If the content of the input parameter is zero, then the content of the return
593 * value is undefined.
595 * input parameter, should not be zero.
597 * least significant set bit in the input parameter.
600 rte_bsf64(uint64_t v)
602 return (uint32_t)__builtin_ctzll(v);
606 * Searches the input parameter for the least significant set bit
607 * (starting from zero). Safe version (checks for input parameter being zero).
609 * @warning ``pos`` must be a valid pointer. It is not checked!
612 * The input parameter.
614 * If ``v`` was not 0, this value will contain position of least significant
615 * bit within the input parameter.
617 * Returns 0 if ``v`` was 0, otherwise returns 1.
620 rte_bsf64_safe(uint64_t v, uint32_t *pos)
630 * Return the last (most-significant) bit set.
632 * @note The last (most significant) bit is at position 64.
633 * @note rte_fls_u64(0) = 0, rte_fls_u64(1) = 1,
634 * rte_fls_u64(0x8000000000000000) = 64
637 * The input parameter.
639 * The last (most-significant) bit set, or 0 if the input is 0.
642 rte_fls_u64(uint64_t x)
644 return (x == 0) ? 0 : 64 - __builtin_clzll(x);
648 * Return the rounded-up log2 of a 64-bit integer.
650 * @note Contrary to the logarithm mathematical operation,
651 * rte_log2_u64(0) == 0 and not -inf.
654 * The input parameter.
656 * The rounded-up log2 of the input, or 0 if the input is 0.
658 static inline uint32_t
659 rte_log2_u64(uint64_t v)
663 v = rte_align64pow2(v);
664 /* we checked for v being 0 already, so no undefined behavior */
669 /** Return the offset of a field in a structure. */
670 #define offsetof(TYPE, MEMBER) __builtin_offsetof (TYPE, MEMBER)
674 * Return pointer to the wrapping struct instance.
684 * struct child *x = obtain(...);
685 * struct wrapper *w = container_of(x, struct wrapper, c);
688 #define container_of(ptr, type, member) __extension__ ({ \
689 const typeof(((type *)0)->member) *_ptr = (ptr); \
690 __attribute__((unused)) type *_target_ptr = \
692 (type *)(((uintptr_t)_ptr) - offsetof(type, member)); \
697 * Get the size of a field in a structure.
700 * The type of the structure.
702 * The field in the structure.
704 * The size of the field in the structure, in bytes.
706 #define RTE_SIZEOF_FIELD(type, field) (sizeof(((type *)0)->field))
708 #define _RTE_STR(x) #x
709 /** Take a macro value and get a string version of it */
710 #define RTE_STR(x) _RTE_STR(x)
713 * ISO C helpers to modify format strings using variadic macros.
714 * This is a replacement for the ", ## __VA_ARGS__" GNU extension.
715 * An empty %s argument is appended to avoid a dangling comma.
717 #define RTE_FMT(fmt, ...) fmt "%.0s", __VA_ARGS__ ""
718 #define RTE_FMT_HEAD(fmt, ...) fmt
719 #define RTE_FMT_TAIL(fmt, ...) __VA_ARGS__
721 /** Mask value of type "tp" for the first "ln" bit set. */
722 #define RTE_LEN2MASK(ln, tp) \
723 ((tp)((uint64_t)-1 >> (sizeof(uint64_t) * CHAR_BIT - (ln))))
725 /** Number of elements in the array. */
726 #define RTE_DIM(a) (sizeof (a) / sizeof ((a)[0]))
729 * Converts a numeric string to the equivalent uint64_t value.
730 * As well as straight number conversion, also recognises the suffixes
731 * k, m and g for kilobytes, megabytes and gigabytes respectively.
733 * If a negative number is passed in i.e. a string with the first non-black
734 * character being "-", zero is returned. Zero is also returned in the case of
735 * an error with the strtoull call in the function.
738 * String containing number to convert.
742 static inline uint64_t
743 rte_str_to_size(const char *str)
746 unsigned long long size;
748 while (isspace((int)*str))
754 size = strtoull(str, &endptr, 0);
759 endptr++; /* allow 1 space gap */
762 case 'G': case 'g': size *= 1024; /* fall-through */
763 case 'M': case 'm': size *= 1024; /* fall-through */
764 case 'K': case 'k': size *= 1024; /* fall-through */
772 * Function to terminate the application immediately, printing an error
773 * message and returning the exit_code back to the shell.
775 * This function never returns
778 * The exit code to be returned by the application
780 * The format string to be used for printing the message. This can include
781 * printf format characters which will be expanded using any further parameters
785 rte_exit(int exit_code, const char *format, ...)
786 __attribute__((noreturn))
787 __attribute__((format(printf, 2, 3)));