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__
46 * RTE_TOOLCHAIN_GCC is defined if the target is built with GCC,
47 * while a host application (like pmdinfogen) may have another compiler.
48 * RTE_CC_IS_GNU is true if the file is compiled with GCC,
49 * no matter it is a target or host application.
51 #define RTE_CC_IS_GNU 0
54 #elif defined __INTEL_COMPILER
56 #elif defined __GNUC__
59 #define RTE_CC_IS_GNU 1
62 #define GCC_VERSION (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + \
69 #define __rte_aligned(a) __attribute__((__aligned__(a)))
71 #ifdef RTE_ARCH_STRICT_ALIGN
72 typedef uint64_t unaligned_uint64_t __rte_aligned(1);
73 typedef uint32_t unaligned_uint32_t __rte_aligned(1);
74 typedef uint16_t unaligned_uint16_t __rte_aligned(1);
76 typedef uint64_t unaligned_uint64_t;
77 typedef uint32_t unaligned_uint32_t;
78 typedef uint16_t unaligned_uint16_t;
82 * Force a structure to be packed
84 #define __rte_packed __attribute__((__packed__))
86 /******* Macro to mark functions and fields scheduled for removal *****/
87 #define __rte_deprecated __attribute__((__deprecated__))
90 * Mark a function or variable to a weak reference.
92 #define __rte_weak __attribute__((__weak__))
95 * Force symbol to be generated even if it appears to be unused.
97 #define __rte_used __attribute__((used))
99 /*********** Macros to eliminate unused variable warnings ********/
102 * short definition to mark a function parameter unused
104 #define __rte_unused __attribute__((__unused__))
107 * Mark pointer as restricted with regard to pointer aliasing.
109 #if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 199901L
110 #define __rte_restrict __restrict
112 #define __rte_restrict restrict
116 * definition to mark a variable or function parameter as used so
117 * as to avoid a compiler warning
119 #define RTE_SET_USED(x) (void)(x)
122 * Check format string and its arguments at compile-time.
124 * GCC on Windows assumes MS-specific format string by default,
125 * even if the underlying stdio implementation is ANSI-compliant,
126 * so this must be overridden.
129 #define __rte_format_printf(format_index, first_arg) \
130 __attribute__((format(gnu_printf, format_index, first_arg)))
132 #define __rte_format_printf(format_index, first_arg) \
133 __attribute__((format(printf, format_index, first_arg)))
136 #define RTE_PRIORITY_LOG 101
137 #define RTE_PRIORITY_BUS 110
138 #define RTE_PRIORITY_CLASS 120
139 #define RTE_PRIORITY_LAST 65535
141 #define RTE_PRIO(prio) \
142 RTE_PRIORITY_ ## prio
145 * Run function before main() with high priority.
148 * Constructor function.
150 * Priority number must be above 100.
151 * Lowest number is the first to run.
153 #ifndef RTE_INIT_PRIO /* Allow to override from EAL */
154 #define RTE_INIT_PRIO(func, prio) \
155 static void __attribute__((constructor(RTE_PRIO(prio)), used)) func(void)
159 * Run function before main() with low priority.
161 * The constructor will be run after prioritized constructors.
164 * Constructor function.
166 #define RTE_INIT(func) \
167 RTE_INIT_PRIO(func, LAST)
170 * Run after main() with low priority.
173 * Destructor function name.
175 * Priority number must be above 100.
176 * Lowest number is the last to run.
178 #ifndef RTE_FINI_PRIO /* Allow to override from EAL */
179 #define RTE_FINI_PRIO(func, prio) \
180 static void __attribute__((destructor(RTE_PRIO(prio)), used)) func(void)
184 * Run after main() with high priority.
186 * The destructor will be run *before* prioritized destructors.
189 * Destructor function name.
191 #define RTE_FINI(func) \
192 RTE_FINI_PRIO(func, LAST)
195 * Hint never returning function
197 #define __rte_noreturn __attribute__((noreturn))
200 * Force a function to be inlined
202 #define __rte_always_inline inline __attribute__((always_inline))
205 * Force a function to be noinlined
207 #define __rte_noinline __attribute__((noinline))
210 * Hint function in the hot path
212 #define __rte_hot __attribute__((hot))
215 * Hint function in the cold path
217 #define __rte_cold __attribute__((cold))
219 /*********** Macros for pointer arithmetic ********/
222 * add a byte-value offset to a pointer
224 #define RTE_PTR_ADD(ptr, x) ((void*)((uintptr_t)(ptr) + (x)))
227 * subtract a byte-value offset from a pointer
229 #define RTE_PTR_SUB(ptr, x) ((void*)((uintptr_t)ptr - (x)))
232 * get the difference between two pointer values, i.e. how far apart
233 * in bytes are the locations they point two. It is assumed that
234 * ptr1 is greater than ptr2.
236 #define RTE_PTR_DIFF(ptr1, ptr2) ((uintptr_t)(ptr1) - (uintptr_t)(ptr2))
239 * Workaround to cast a const field of a structure to non-const type.
241 #define RTE_CAST_FIELD(var, field, type) \
242 (*(type *)((uintptr_t)(var) + offsetof(typeof(*(var)), field)))
244 /*********** Macros/static functions for doing alignment ********/
248 * Macro to align a pointer to a given power-of-two. The resultant
249 * pointer will be a pointer of the same type as the first parameter, and
250 * point to an address no higher than the first parameter. Second parameter
251 * must be a power-of-two value.
253 #define RTE_PTR_ALIGN_FLOOR(ptr, align) \
254 ((typeof(ptr))RTE_ALIGN_FLOOR((uintptr_t)ptr, align))
257 * Macro to align a value to a given power-of-two. The resultant value
258 * will be of the same type as the first parameter, and will be no
259 * bigger than the first parameter. Second parameter must be a
260 * power-of-two value.
262 #define RTE_ALIGN_FLOOR(val, align) \
263 (typeof(val))((val) & (~((typeof(val))((align) - 1))))
266 * Macro to align a pointer to a given power-of-two. The resultant
267 * pointer will be a pointer of the same type as the first parameter, and
268 * point to an address no lower than the first parameter. Second parameter
269 * must be a power-of-two value.
271 #define RTE_PTR_ALIGN_CEIL(ptr, align) \
272 RTE_PTR_ALIGN_FLOOR((typeof(ptr))RTE_PTR_ADD(ptr, (align) - 1), align)
275 * Macro to align a value to a given power-of-two. The resultant value
276 * will be of the same type as the first parameter, and will be no lower
277 * than the first parameter. Second parameter must be a power-of-two
280 #define RTE_ALIGN_CEIL(val, align) \
281 RTE_ALIGN_FLOOR(((val) + ((typeof(val)) (align) - 1)), align)
284 * Macro to align a pointer to a given power-of-two. The resultant
285 * pointer will be a pointer of the same type as the first parameter, and
286 * point to an address no lower than the first parameter. Second parameter
287 * must be a power-of-two value.
288 * This function is the same as RTE_PTR_ALIGN_CEIL
290 #define RTE_PTR_ALIGN(ptr, align) RTE_PTR_ALIGN_CEIL(ptr, align)
293 * Macro to align a value to a given power-of-two. The resultant
294 * value will be of the same type as the first parameter, and
295 * will be no lower than the first parameter. Second parameter
296 * must be a power-of-two value.
297 * This function is the same as RTE_ALIGN_CEIL
299 #define RTE_ALIGN(val, align) RTE_ALIGN_CEIL(val, align)
302 * Macro to align a value to the multiple of given value. The resultant
303 * value will be of the same type as the first parameter and will be no lower
304 * than the first parameter.
306 #define RTE_ALIGN_MUL_CEIL(v, mul) \
307 ((((v) + (typeof(v))(mul) - 1) / ((typeof(v))(mul))) * (typeof(v))(mul))
310 * Macro to align a value to the multiple of given value. The resultant
311 * value will be of the same type as the first parameter and will be no higher
312 * than the first parameter.
314 #define RTE_ALIGN_MUL_FLOOR(v, mul) \
315 (((v) / ((typeof(v))(mul))) * (typeof(v))(mul))
318 * Macro to align value to the nearest multiple of the given value.
319 * The resultant value might be greater than or less than the first parameter
320 * whichever difference is the lowest.
322 #define RTE_ALIGN_MUL_NEAR(v, mul) \
324 typeof(v) ceil = RTE_ALIGN_MUL_CEIL(v, mul); \
325 typeof(v) floor = RTE_ALIGN_MUL_FLOOR(v, mul); \
326 (ceil - (v)) > ((v) - floor) ? floor : ceil; \
330 * Checks if a pointer is aligned to a given power-of-two value
333 * The pointer whose alignment is to be checked
335 * The power-of-two value to which the ptr should be aligned
338 * True(1) where the pointer is correctly aligned, false(0) otherwise
341 rte_is_aligned(void *ptr, unsigned align)
343 return RTE_PTR_ALIGN(ptr, align) == ptr;
346 /*********** Macros for compile type checks ********/
349 * Triggers an error at compilation time if the condition is true.
351 #define RTE_BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
353 /*********** Cache line related macros ********/
355 /** Cache line mask. */
356 #define RTE_CACHE_LINE_MASK (RTE_CACHE_LINE_SIZE-1)
358 /** Return the first cache-aligned value greater or equal to size. */
359 #define RTE_CACHE_LINE_ROUNDUP(size) \
360 (RTE_CACHE_LINE_SIZE * ((size + RTE_CACHE_LINE_SIZE - 1) / \
361 RTE_CACHE_LINE_SIZE))
363 /** Cache line size in terms of log2 */
364 #if RTE_CACHE_LINE_SIZE == 64
365 #define RTE_CACHE_LINE_SIZE_LOG2 6
366 #elif RTE_CACHE_LINE_SIZE == 128
367 #define RTE_CACHE_LINE_SIZE_LOG2 7
369 #error "Unsupported cache line size"
372 /** Minimum Cache line size. */
373 #define RTE_CACHE_LINE_MIN_SIZE 64
375 /** Force alignment to cache line. */
376 #define __rte_cache_aligned __rte_aligned(RTE_CACHE_LINE_SIZE)
378 /** Force minimum cache line alignment. */
379 #define __rte_cache_min_aligned __rte_aligned(RTE_CACHE_LINE_MIN_SIZE)
381 /*********** PA/IOVA type definitions ********/
383 /** Physical address */
384 typedef uint64_t phys_addr_t;
385 #define RTE_BAD_PHYS_ADDR ((phys_addr_t)-1)
388 * IO virtual address type.
389 * When the physical addressing mode (IOVA as PA) is in use,
390 * the translation from an IO virtual address (IOVA) to a physical address
391 * is a direct mapping, i.e. the same value.
392 * Otherwise, in virtual mode (IOVA as VA), an IOMMU may do the translation.
394 typedef uint64_t rte_iova_t;
395 #define RTE_BAD_IOVA ((rte_iova_t)-1)
397 /*********** Structure alignment markers ********/
399 /** Generic marker for any place in a structure. */
400 __extension__ typedef void *RTE_MARKER[0];
401 /** Marker for 1B alignment in a structure. */
402 __extension__ typedef uint8_t RTE_MARKER8[0];
403 /** Marker for 2B alignment in a structure. */
404 __extension__ typedef uint16_t RTE_MARKER16[0];
405 /** Marker for 4B alignment in a structure. */
406 __extension__ typedef uint32_t RTE_MARKER32[0];
407 /** Marker for 8B alignment in a structure. */
408 __extension__ typedef uint64_t RTE_MARKER64[0];
411 * Combines 32b inputs most significant set bits into the least
412 * significant bits to construct a value with the same MSBs as x
413 * but all 1's under it.
416 * The integer whose MSBs need to be combined with its LSBs
418 * The combined value.
420 static inline uint32_t
421 rte_combine32ms1b(uint32_t x)
433 * Combines 64b inputs most significant set bits into the least
434 * significant bits to construct a value with the same MSBs as x
435 * but all 1's under it.
438 * The integer whose MSBs need to be combined with its LSBs
440 * The combined value.
442 static inline uint64_t
443 rte_combine64ms1b(uint64_t v)
455 /*********** Macros to work with powers of 2 ********/
458 * Macro to return 1 if n is a power of 2, 0 otherwise
460 #define RTE_IS_POWER_OF_2(n) ((n) && !(((n) - 1) & (n)))
463 * Returns true if n is a power of 2
466 * @return 1 if true, 0 otherwise
469 rte_is_power_of_2(uint32_t n)
471 return n && !(n & (n - 1));
475 * Aligns input parameter to the next power of 2
478 * The integer value to align
481 * Input parameter aligned to the next power of 2
483 static inline uint32_t
484 rte_align32pow2(uint32_t x)
487 x = rte_combine32ms1b(x);
493 * Aligns input parameter to the previous power of 2
496 * The integer value to align
499 * Input parameter aligned to the previous power of 2
501 static inline uint32_t
502 rte_align32prevpow2(uint32_t x)
504 x = rte_combine32ms1b(x);
510 * Aligns 64b input parameter to the next power of 2
513 * The 64b value to align
516 * Input parameter aligned to the next power of 2
518 static inline uint64_t
519 rte_align64pow2(uint64_t v)
522 v = rte_combine64ms1b(v);
528 * Aligns 64b input parameter to the previous power of 2
531 * The 64b value to align
534 * Input parameter aligned to the previous power of 2
536 static inline uint64_t
537 rte_align64prevpow2(uint64_t v)
539 v = rte_combine64ms1b(v);
544 /*********** Macros for calculating min and max **********/
547 * Macro to return the minimum of two numbers
549 #define RTE_MIN(a, b) \
551 typeof (a) _a = (a); \
552 typeof (b) _b = (b); \
557 * Macro to return the maximum of two numbers
559 #define RTE_MAX(a, b) \
561 typeof (a) _a = (a); \
562 typeof (b) _b = (b); \
566 /*********** Other general functions / macros ********/
569 * Searches the input parameter for the least significant set bit
570 * (starting from zero).
571 * If a least significant 1 bit is found, its bit index is returned.
572 * If the content of the input parameter is zero, then the content of the return
573 * value is undefined.
575 * input parameter, should not be zero.
577 * least significant set bit in the input parameter.
579 static inline uint32_t
580 rte_bsf32(uint32_t v)
582 return (uint32_t)__builtin_ctz(v);
586 * Searches the input parameter for the least significant set bit
587 * (starting from zero). Safe version (checks for input parameter being zero).
589 * @warning ``pos`` must be a valid pointer. It is not checked!
592 * The input parameter.
594 * If ``v`` was not 0, this value will contain position of least significant
595 * bit within the input parameter.
597 * Returns 0 if ``v`` was 0, otherwise returns 1.
600 rte_bsf32_safe(uint64_t v, uint32_t *pos)
610 * Return the rounded-up log2 of a integer.
612 * @note Contrary to the logarithm mathematical operation,
613 * rte_log2_u32(0) == 0 and not -inf.
616 * The input parameter.
618 * The rounded-up log2 of the input, or 0 if the input is 0.
620 static inline uint32_t
621 rte_log2_u32(uint32_t v)
625 v = rte_align32pow2(v);
631 * Return the last (most-significant) bit set.
633 * @note The last (most significant) bit is at position 32.
634 * @note rte_fls_u32(0) = 0, rte_fls_u32(1) = 1, rte_fls_u32(0x80000000) = 32
637 * The input parameter.
639 * The last (most-significant) bit set, or 0 if the input is 0.
642 rte_fls_u32(uint32_t x)
644 return (x == 0) ? 0 : 32 - __builtin_clz(x);
648 * Searches the input parameter for the least significant set bit
649 * (starting from zero).
650 * If a least significant 1 bit is found, its bit index is returned.
651 * If the content of the input parameter is zero, then the content of the return
652 * value is undefined.
654 * input parameter, should not be zero.
656 * least significant set bit in the input parameter.
659 rte_bsf64(uint64_t v)
661 return (uint32_t)__builtin_ctzll(v);
665 * Searches the input parameter for the least significant set bit
666 * (starting from zero). Safe version (checks for input parameter being zero).
668 * @warning ``pos`` must be a valid pointer. It is not checked!
671 * The input parameter.
673 * If ``v`` was not 0, this value will contain position of least significant
674 * bit within the input parameter.
676 * Returns 0 if ``v`` was 0, otherwise returns 1.
679 rte_bsf64_safe(uint64_t v, uint32_t *pos)
689 * Return the last (most-significant) bit set.
691 * @note The last (most significant) bit is at position 64.
692 * @note rte_fls_u64(0) = 0, rte_fls_u64(1) = 1,
693 * rte_fls_u64(0x8000000000000000) = 64
696 * The input parameter.
698 * The last (most-significant) bit set, or 0 if the input is 0.
701 rte_fls_u64(uint64_t x)
703 return (x == 0) ? 0 : 64 - __builtin_clzll(x);
707 * Return the rounded-up log2 of a 64-bit integer.
709 * @note Contrary to the logarithm mathematical operation,
710 * rte_log2_u64(0) == 0 and not -inf.
713 * The input parameter.
715 * The rounded-up log2 of the input, or 0 if the input is 0.
717 static inline uint32_t
718 rte_log2_u64(uint64_t v)
722 v = rte_align64pow2(v);
723 /* we checked for v being 0 already, so no undefined behavior */
728 /** Return the offset of a field in a structure. */
729 #define offsetof(TYPE, MEMBER) __builtin_offsetof (TYPE, MEMBER)
733 * Return pointer to the wrapping struct instance.
743 * struct child *x = obtain(...);
744 * struct wrapper *w = container_of(x, struct wrapper, c);
747 #define container_of(ptr, type, member) __extension__ ({ \
748 const typeof(((type *)0)->member) *_ptr = (ptr); \
749 __rte_unused type *_target_ptr = \
751 (type *)(((uintptr_t)_ptr) - offsetof(type, member)); \
756 * Get the size of a field in a structure.
759 * The type of the structure.
761 * The field in the structure.
763 * The size of the field in the structure, in bytes.
765 #define RTE_SIZEOF_FIELD(type, field) (sizeof(((type *)0)->field))
767 #define _RTE_STR(x) #x
768 /** Take a macro value and get a string version of it */
769 #define RTE_STR(x) _RTE_STR(x)
772 * ISO C helpers to modify format strings using variadic macros.
773 * This is a replacement for the ", ## __VA_ARGS__" GNU extension.
774 * An empty %s argument is appended to avoid a dangling comma.
776 #define RTE_FMT(fmt, ...) fmt "%.0s", __VA_ARGS__ ""
777 #define RTE_FMT_HEAD(fmt, ...) fmt
778 #define RTE_FMT_TAIL(fmt, ...) __VA_ARGS__
780 /** Mask value of type "tp" for the first "ln" bit set. */
781 #define RTE_LEN2MASK(ln, tp) \
782 ((tp)((uint64_t)-1 >> (sizeof(uint64_t) * CHAR_BIT - (ln))))
784 /** Number of elements in the array. */
785 #define RTE_DIM(a) (sizeof (a) / sizeof ((a)[0]))
788 * Converts a numeric string to the equivalent uint64_t value.
789 * As well as straight number conversion, also recognises the suffixes
790 * k, m and g for kilobytes, megabytes and gigabytes respectively.
792 * If a negative number is passed in i.e. a string with the first non-black
793 * character being "-", zero is returned. Zero is also returned in the case of
794 * an error with the strtoull call in the function.
797 * String containing number to convert.
801 static inline uint64_t
802 rte_str_to_size(const char *str)
805 unsigned long long size;
807 while (isspace((int)*str))
813 size = strtoull(str, &endptr, 0);
818 endptr++; /* allow 1 space gap */
821 case 'G': case 'g': size *= 1024; /* fall-through */
822 case 'M': case 'm': size *= 1024; /* fall-through */
823 case 'K': case 'k': size *= 1024; /* fall-through */
831 * Function to terminate the application immediately, printing an error
832 * message and returning the exit_code back to the shell.
834 * This function never returns
837 * The exit code to be returned by the application
839 * The format string to be used for printing the message. This can include
840 * printf format characters which will be expanded using any further parameters
844 rte_exit(int exit_code, const char *format, ...)
845 __rte_format_printf(2, 3);