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 + \
66 #ifdef RTE_ARCH_STRICT_ALIGN
67 typedef uint64_t unaligned_uint64_t __rte_aligned(1);
68 typedef uint32_t unaligned_uint32_t __rte_aligned(1);
69 typedef uint16_t unaligned_uint16_t __rte_aligned(1);
71 typedef uint64_t unaligned_uint64_t;
72 typedef uint32_t unaligned_uint32_t;
73 typedef uint16_t unaligned_uint16_t;
79 #define __rte_aligned(a) __attribute__((__aligned__(a)))
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__))
94 /*********** Macros to eliminate unused variable warnings ********/
97 * short definition to mark a function parameter unused
99 #define __rte_unused __attribute__((__unused__))
102 * definition to mark a variable or function parameter as used so
103 * as to avoid a compiler warning
105 #define RTE_SET_USED(x) (void)(x)
108 * Check format string and its arguments at compile-time.
110 * GCC on Windows assumes MS-specific format string by default,
111 * even if the underlying stdio implementation is ANSI-compliant,
112 * so this must be overridden.
115 #define __rte_format_printf(format_index, first_arg) \
116 __attribute__((format(gnu_printf, format_index, first_arg)))
118 #define __rte_format_printf(format_index, first_arg) \
119 __attribute__((format(printf, format_index, first_arg)))
122 #define RTE_PRIORITY_LOG 101
123 #define RTE_PRIORITY_BUS 110
124 #define RTE_PRIORITY_CLASS 120
125 #define RTE_PRIORITY_LAST 65535
127 #define RTE_PRIO(prio) \
128 RTE_PRIORITY_ ## prio
131 * Run function before main() with high priority.
134 * Constructor function.
136 * Priority number must be above 100.
137 * Lowest number is the first to run.
139 #ifndef RTE_INIT_PRIO /* Allow to override from EAL */
140 #define RTE_INIT_PRIO(func, prio) \
141 static void __attribute__((constructor(RTE_PRIO(prio)), used)) func(void)
145 * Run function before main() with low priority.
147 * The constructor will be run after prioritized constructors.
150 * Constructor function.
152 #define RTE_INIT(func) \
153 RTE_INIT_PRIO(func, LAST)
156 * Run after main() with low priority.
159 * Destructor function name.
161 * Priority number must be above 100.
162 * Lowest number is the last to run.
164 #ifndef RTE_FINI_PRIO /* Allow to override from EAL */
165 #define RTE_FINI_PRIO(func, prio) \
166 static void __attribute__((destructor(RTE_PRIO(prio)), used)) func(void)
170 * Run after main() with high priority.
172 * The destructor will be run *before* prioritized destructors.
175 * Destructor function name.
177 #define RTE_FINI(func) \
178 RTE_FINI_PRIO(func, LAST)
181 * Force a function to be inlined
183 #define __rte_always_inline inline __attribute__((always_inline))
186 * Force a function to be noinlined
188 #define __rte_noinline __attribute__((noinline))
190 /*********** Macros for pointer arithmetic ********/
193 * add a byte-value offset to a pointer
195 #define RTE_PTR_ADD(ptr, x) ((void*)((uintptr_t)(ptr) + (x)))
198 * subtract a byte-value offset from a pointer
200 #define RTE_PTR_SUB(ptr, x) ((void*)((uintptr_t)ptr - (x)))
203 * get the difference between two pointer values, i.e. how far apart
204 * in bytes are the locations they point two. It is assumed that
205 * ptr1 is greater than ptr2.
207 #define RTE_PTR_DIFF(ptr1, ptr2) ((uintptr_t)(ptr1) - (uintptr_t)(ptr2))
210 * Workaround to cast a const field of a structure to non-const type.
212 #define RTE_CAST_FIELD(var, field, type) \
213 (*(type *)((uintptr_t)(var) + offsetof(typeof(*(var)), field)))
215 /*********** Macros/static functions for doing alignment ********/
219 * Macro to align a pointer to a given power-of-two. The resultant
220 * pointer will be a pointer of the same type as the first parameter, and
221 * point to an address no higher than the first parameter. Second parameter
222 * must be a power-of-two value.
224 #define RTE_PTR_ALIGN_FLOOR(ptr, align) \
225 ((typeof(ptr))RTE_ALIGN_FLOOR((uintptr_t)ptr, align))
228 * Macro to align a value to a given power-of-two. The resultant value
229 * will be of the same type as the first parameter, and will be no
230 * bigger than the first parameter. Second parameter must be a
231 * power-of-two value.
233 #define RTE_ALIGN_FLOOR(val, align) \
234 (typeof(val))((val) & (~((typeof(val))((align) - 1))))
237 * Macro to align a pointer to a given power-of-two. The resultant
238 * pointer will be a pointer of the same type as the first parameter, and
239 * point to an address no lower than the first parameter. Second parameter
240 * must be a power-of-two value.
242 #define RTE_PTR_ALIGN_CEIL(ptr, align) \
243 RTE_PTR_ALIGN_FLOOR((typeof(ptr))RTE_PTR_ADD(ptr, (align) - 1), align)
246 * Macro to align a value to a given power-of-two. The resultant value
247 * will be of the same type as the first parameter, and will be no lower
248 * than the first parameter. Second parameter must be a power-of-two
251 #define RTE_ALIGN_CEIL(val, align) \
252 RTE_ALIGN_FLOOR(((val) + ((typeof(val)) (align) - 1)), align)
255 * Macro to align a pointer to a given power-of-two. The resultant
256 * pointer will be a pointer of the same type as the first parameter, and
257 * point to an address no lower than the first parameter. Second parameter
258 * must be a power-of-two value.
259 * This function is the same as RTE_PTR_ALIGN_CEIL
261 #define RTE_PTR_ALIGN(ptr, align) RTE_PTR_ALIGN_CEIL(ptr, align)
264 * Macro to align a value to a given power-of-two. The resultant
265 * value will be of the same type as the first parameter, and
266 * will be no lower than the first parameter. Second parameter
267 * must be a power-of-two value.
268 * This function is the same as RTE_ALIGN_CEIL
270 #define RTE_ALIGN(val, align) RTE_ALIGN_CEIL(val, align)
273 * Macro to align a value to the multiple of given value. The resultant
274 * value will be of the same type as the first parameter and will be no lower
275 * than the first parameter.
277 #define RTE_ALIGN_MUL_CEIL(v, mul) \
278 (((v + (typeof(v))(mul) - 1) / ((typeof(v))(mul))) * (typeof(v))(mul))
281 * Macro to align a value to the multiple of given value. The resultant
282 * value will be of the same type as the first parameter and will be no higher
283 * than the first parameter.
285 #define RTE_ALIGN_MUL_FLOOR(v, mul) \
286 ((v / ((typeof(v))(mul))) * (typeof(v))(mul))
289 * Macro to align value to the nearest multiple of the given value.
290 * The resultant value might be greater than or less than the first parameter
291 * whichever difference is the lowest.
293 #define RTE_ALIGN_MUL_NEAR(v, mul) \
295 typeof(v) ceil = RTE_ALIGN_MUL_CEIL(v, mul); \
296 typeof(v) floor = RTE_ALIGN_MUL_FLOOR(v, mul); \
297 (ceil - v) > (v - floor) ? floor : ceil; \
301 * Checks if a pointer is aligned to a given power-of-two value
304 * The pointer whose alignment is to be checked
306 * The power-of-two value to which the ptr should be aligned
309 * True(1) where the pointer is correctly aligned, false(0) otherwise
312 rte_is_aligned(void *ptr, unsigned align)
314 return RTE_PTR_ALIGN(ptr, align) == ptr;
317 /*********** Macros for compile type checks ********/
320 * Triggers an error at compilation time if the condition is true.
322 #define RTE_BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
324 /*********** Cache line related macros ********/
326 /** Cache line mask. */
327 #define RTE_CACHE_LINE_MASK (RTE_CACHE_LINE_SIZE-1)
329 /** Return the first cache-aligned value greater or equal to size. */
330 #define RTE_CACHE_LINE_ROUNDUP(size) \
331 (RTE_CACHE_LINE_SIZE * ((size + RTE_CACHE_LINE_SIZE - 1) / \
332 RTE_CACHE_LINE_SIZE))
334 /** Cache line size in terms of log2 */
335 #if RTE_CACHE_LINE_SIZE == 64
336 #define RTE_CACHE_LINE_SIZE_LOG2 6
337 #elif RTE_CACHE_LINE_SIZE == 128
338 #define RTE_CACHE_LINE_SIZE_LOG2 7
340 #error "Unsupported cache line size"
343 /** Minimum Cache line size. */
344 #define RTE_CACHE_LINE_MIN_SIZE 64
346 /** Force alignment to cache line. */
347 #define __rte_cache_aligned __rte_aligned(RTE_CACHE_LINE_SIZE)
349 /** Force minimum cache line alignment. */
350 #define __rte_cache_min_aligned __rte_aligned(RTE_CACHE_LINE_MIN_SIZE)
352 /*********** PA/IOVA type definitions ********/
354 /** Physical address */
355 typedef uint64_t phys_addr_t;
356 #define RTE_BAD_PHYS_ADDR ((phys_addr_t)-1)
359 * IO virtual address type.
360 * When the physical addressing mode (IOVA as PA) is in use,
361 * the translation from an IO virtual address (IOVA) to a physical address
362 * is a direct mapping, i.e. the same value.
363 * Otherwise, in virtual mode (IOVA as VA), an IOMMU may do the translation.
365 typedef uint64_t rte_iova_t;
366 #define RTE_BAD_IOVA ((rte_iova_t)-1)
368 /*********** Structure alignment markers ********/
370 /** Generic marker for any place in a structure. */
371 __extension__ typedef void *RTE_MARKER[0];
372 /** Marker for 1B alignment in a structure. */
373 __extension__ typedef uint8_t RTE_MARKER8[0];
374 /** Marker for 2B alignment in a structure. */
375 __extension__ typedef uint16_t RTE_MARKER16[0];
376 /** Marker for 4B alignment in a structure. */
377 __extension__ typedef uint32_t RTE_MARKER32[0];
378 /** Marker for 8B alignment in a structure. */
379 __extension__ typedef uint64_t RTE_MARKER64[0];
382 * Combines 32b inputs most significant set bits into the least
383 * significant bits to construct a value with the same MSBs as x
384 * but all 1's under it.
387 * The integer whose MSBs need to be combined with its LSBs
389 * The combined value.
391 static inline uint32_t
392 rte_combine32ms1b(register uint32_t x)
404 * Combines 64b inputs most significant set bits into the least
405 * significant bits to construct a value with the same MSBs as x
406 * but all 1's under it.
409 * The integer whose MSBs need to be combined with its LSBs
411 * The combined value.
413 static inline uint64_t
414 rte_combine64ms1b(register uint64_t v)
426 /*********** Macros to work with powers of 2 ********/
429 * Macro to return 1 if n is a power of 2, 0 otherwise
431 #define RTE_IS_POWER_OF_2(n) ((n) && !(((n) - 1) & (n)))
434 * Returns true if n is a power of 2
437 * @return 1 if true, 0 otherwise
440 rte_is_power_of_2(uint32_t n)
442 return n && !(n & (n - 1));
446 * Aligns input parameter to the next power of 2
449 * The integer value to align
452 * Input parameter aligned to the next power of 2
454 static inline uint32_t
455 rte_align32pow2(uint32_t x)
458 x = rte_combine32ms1b(x);
464 * Aligns input parameter to the previous power of 2
467 * The integer value to align
470 * Input parameter aligned to the previous power of 2
472 static inline uint32_t
473 rte_align32prevpow2(uint32_t x)
475 x = rte_combine32ms1b(x);
481 * Aligns 64b input parameter to the next power of 2
484 * The 64b value to align
487 * Input parameter aligned to the next power of 2
489 static inline uint64_t
490 rte_align64pow2(uint64_t v)
493 v = rte_combine64ms1b(v);
499 * Aligns 64b input parameter to the previous power of 2
502 * The 64b value to align
505 * Input parameter aligned to the previous power of 2
507 static inline uint64_t
508 rte_align64prevpow2(uint64_t v)
510 v = rte_combine64ms1b(v);
515 /*********** Macros for calculating min and max **********/
518 * Macro to return the minimum of two numbers
520 #define RTE_MIN(a, b) \
522 typeof (a) _a = (a); \
523 typeof (b) _b = (b); \
528 * Macro to return the maximum of two numbers
530 #define RTE_MAX(a, b) \
532 typeof (a) _a = (a); \
533 typeof (b) _b = (b); \
537 /*********** Other general functions / macros ********/
540 * Searches the input parameter for the least significant set bit
541 * (starting from zero).
542 * If a least significant 1 bit is found, its bit index is returned.
543 * If the content of the input parameter is zero, then the content of the return
544 * value is undefined.
546 * input parameter, should not be zero.
548 * least significant set bit in the input parameter.
550 static inline uint32_t
551 rte_bsf32(uint32_t v)
553 return (uint32_t)__builtin_ctz(v);
557 * Searches the input parameter for the least significant set bit
558 * (starting from zero). Safe version (checks for input parameter being zero).
560 * @warning ``pos`` must be a valid pointer. It is not checked!
563 * The input parameter.
565 * If ``v`` was not 0, this value will contain position of least significant
566 * bit within the input parameter.
568 * Returns 0 if ``v`` was 0, otherwise returns 1.
571 rte_bsf32_safe(uint64_t v, uint32_t *pos)
581 * Return the rounded-up log2 of a integer.
583 * @note Contrary to the logarithm mathematical operation,
584 * rte_log2_u32(0) == 0 and not -inf.
587 * The input parameter.
589 * The rounded-up log2 of the input, or 0 if the input is 0.
591 static inline uint32_t
592 rte_log2_u32(uint32_t v)
596 v = rte_align32pow2(v);
602 * Return the last (most-significant) bit set.
604 * @note The last (most significant) bit is at position 32.
605 * @note rte_fls_u32(0) = 0, rte_fls_u32(1) = 1, rte_fls_u32(0x80000000) = 32
608 * The input parameter.
610 * The last (most-significant) bit set, or 0 if the input is 0.
613 rte_fls_u32(uint32_t x)
615 return (x == 0) ? 0 : 32 - __builtin_clz(x);
619 * Searches the input parameter for the least significant set bit
620 * (starting from zero).
621 * If a least significant 1 bit is found, its bit index is returned.
622 * If the content of the input parameter is zero, then the content of the return
623 * value is undefined.
625 * input parameter, should not be zero.
627 * least significant set bit in the input parameter.
630 rte_bsf64(uint64_t v)
632 return (uint32_t)__builtin_ctzll(v);
636 * Searches the input parameter for the least significant set bit
637 * (starting from zero). Safe version (checks for input parameter being zero).
639 * @warning ``pos`` must be a valid pointer. It is not checked!
642 * The input parameter.
644 * If ``v`` was not 0, this value will contain position of least significant
645 * bit within the input parameter.
647 * Returns 0 if ``v`` was 0, otherwise returns 1.
650 rte_bsf64_safe(uint64_t v, uint32_t *pos)
660 * Return the last (most-significant) bit set.
662 * @note The last (most significant) bit is at position 64.
663 * @note rte_fls_u64(0) = 0, rte_fls_u64(1) = 1,
664 * rte_fls_u64(0x8000000000000000) = 64
667 * The input parameter.
669 * The last (most-significant) bit set, or 0 if the input is 0.
672 rte_fls_u64(uint64_t x)
674 return (x == 0) ? 0 : 64 - __builtin_clzll(x);
678 * Return the rounded-up log2 of a 64-bit integer.
680 * @note Contrary to the logarithm mathematical operation,
681 * rte_log2_u64(0) == 0 and not -inf.
684 * The input parameter.
686 * The rounded-up log2 of the input, or 0 if the input is 0.
688 static inline uint32_t
689 rte_log2_u64(uint64_t v)
693 v = rte_align64pow2(v);
694 /* we checked for v being 0 already, so no undefined behavior */
699 /** Return the offset of a field in a structure. */
700 #define offsetof(TYPE, MEMBER) __builtin_offsetof (TYPE, MEMBER)
704 * Return pointer to the wrapping struct instance.
714 * struct child *x = obtain(...);
715 * struct wrapper *w = container_of(x, struct wrapper, c);
718 #define container_of(ptr, type, member) __extension__ ({ \
719 const typeof(((type *)0)->member) *_ptr = (ptr); \
720 __attribute__((unused)) type *_target_ptr = \
722 (type *)(((uintptr_t)_ptr) - offsetof(type, member)); \
727 * Get the size of a field in a structure.
730 * The type of the structure.
732 * The field in the structure.
734 * The size of the field in the structure, in bytes.
736 #define RTE_SIZEOF_FIELD(type, field) (sizeof(((type *)0)->field))
738 #define _RTE_STR(x) #x
739 /** Take a macro value and get a string version of it */
740 #define RTE_STR(x) _RTE_STR(x)
743 * ISO C helpers to modify format strings using variadic macros.
744 * This is a replacement for the ", ## __VA_ARGS__" GNU extension.
745 * An empty %s argument is appended to avoid a dangling comma.
747 #define RTE_FMT(fmt, ...) fmt "%.0s", __VA_ARGS__ ""
748 #define RTE_FMT_HEAD(fmt, ...) fmt
749 #define RTE_FMT_TAIL(fmt, ...) __VA_ARGS__
751 /** Mask value of type "tp" for the first "ln" bit set. */
752 #define RTE_LEN2MASK(ln, tp) \
753 ((tp)((uint64_t)-1 >> (sizeof(uint64_t) * CHAR_BIT - (ln))))
755 /** Number of elements in the array. */
756 #define RTE_DIM(a) (sizeof (a) / sizeof ((a)[0]))
759 * Converts a numeric string to the equivalent uint64_t value.
760 * As well as straight number conversion, also recognises the suffixes
761 * k, m and g for kilobytes, megabytes and gigabytes respectively.
763 * If a negative number is passed in i.e. a string with the first non-black
764 * character being "-", zero is returned. Zero is also returned in the case of
765 * an error with the strtoull call in the function.
768 * String containing number to convert.
772 static inline uint64_t
773 rte_str_to_size(const char *str)
776 unsigned long long size;
778 while (isspace((int)*str))
784 size = strtoull(str, &endptr, 0);
789 endptr++; /* allow 1 space gap */
792 case 'G': case 'g': size *= 1024; /* fall-through */
793 case 'M': case 'm': size *= 1024; /* fall-through */
794 case 'K': case 'k': size *= 1024; /* fall-through */
802 * Function to terminate the application immediately, printing an error
803 * message and returning the exit_code back to the shell.
805 * This function never returns
808 * The exit code to be returned by the application
810 * The format string to be used for printing the message. This can include
811 * printf format characters which will be expanded using any further parameters
815 rte_exit(int exit_code, const char *format, ...)
816 __attribute__((noreturn))
817 __rte_format_printf(2, 3);