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
87 #define RTE_PRIO(prio) \
91 * Run function before main() with low priority.
93 * The constructor will be run after prioritized constructors.
96 * Constructor function.
98 #define RTE_INIT(func) \
99 static void __attribute__((constructor, used)) func(void)
102 * Run function before main() with high priority.
105 * Constructor function.
107 * Priority number must be above 100.
108 * Lowest number is the first to run.
110 #define RTE_INIT_PRIO(func, prio) \
111 static void __attribute__((constructor(RTE_PRIO(prio)), used)) func(void)
114 * Force a function to be inlined
116 #define __rte_always_inline inline __attribute__((always_inline))
119 * Force a function to be noinlined
121 #define __rte_noinline __attribute__((noinline))
123 /*********** Macros for pointer arithmetic ********/
126 * add a byte-value offset from a pointer
128 #define RTE_PTR_ADD(ptr, x) ((void*)((uintptr_t)(ptr) + (x)))
131 * subtract a byte-value offset from a pointer
133 #define RTE_PTR_SUB(ptr, x) ((void*)((uintptr_t)ptr - (x)))
136 * get the difference between two pointer values, i.e. how far apart
137 * in bytes are the locations they point two. It is assumed that
138 * ptr1 is greater than ptr2.
140 #define RTE_PTR_DIFF(ptr1, ptr2) ((uintptr_t)(ptr1) - (uintptr_t)(ptr2))
142 /*********** Macros/static functions for doing alignment ********/
146 * Macro to align a pointer to a given power-of-two. The resultant
147 * pointer will be a pointer of the same type as the first parameter, and
148 * point to an address no higher than the first parameter. Second parameter
149 * must be a power-of-two value.
151 #define RTE_PTR_ALIGN_FLOOR(ptr, align) \
152 ((typeof(ptr))RTE_ALIGN_FLOOR((uintptr_t)ptr, align))
155 * Macro to align a value to a given power-of-two. The resultant value
156 * will be of the same type as the first parameter, and will be no
157 * bigger than the first parameter. Second parameter must be a
158 * power-of-two value.
160 #define RTE_ALIGN_FLOOR(val, align) \
161 (typeof(val))((val) & (~((typeof(val))((align) - 1))))
164 * Macro to align a pointer to a given power-of-two. The resultant
165 * pointer will be a pointer of the same type as the first parameter, and
166 * point to an address no lower than the first parameter. Second parameter
167 * must be a power-of-two value.
169 #define RTE_PTR_ALIGN_CEIL(ptr, align) \
170 RTE_PTR_ALIGN_FLOOR((typeof(ptr))RTE_PTR_ADD(ptr, (align) - 1), align)
173 * Macro to align a value to a given power-of-two. The resultant value
174 * will be of the same type as the first parameter, and will be no lower
175 * than the first parameter. Second parameter must be a power-of-two
178 #define RTE_ALIGN_CEIL(val, align) \
179 RTE_ALIGN_FLOOR(((val) + ((typeof(val)) (align) - 1)), align)
182 * Macro to align a pointer to a given power-of-two. The resultant
183 * pointer will be a pointer of the same type as the first parameter, and
184 * point to an address no lower than the first parameter. Second parameter
185 * must be a power-of-two value.
186 * This function is the same as RTE_PTR_ALIGN_CEIL
188 #define RTE_PTR_ALIGN(ptr, align) RTE_PTR_ALIGN_CEIL(ptr, align)
191 * Macro to align a value to a given power-of-two. The resultant
192 * value will be of the same type as the first parameter, and
193 * will be no lower than the first parameter. Second parameter
194 * must be a power-of-two value.
195 * This function is the same as RTE_ALIGN_CEIL
197 #define RTE_ALIGN(val, align) RTE_ALIGN_CEIL(val, align)
200 * Macro to align a value to the multiple of given value. The resultant
201 * value will be of the same type as the first parameter and will be no lower
202 * than the first parameter.
204 #define RTE_ALIGN_MUL_CEIL(v, mul) \
205 (((v + (typeof(v))(mul) - 1) / ((typeof(v))(mul))) * (typeof(v))(mul))
208 * Macro to align a value to the multiple of given value. The resultant
209 * value will be of the same type as the first parameter and will be no higher
210 * than the first parameter.
212 #define RTE_ALIGN_MUL_FLOOR(v, mul) \
213 ((v / ((typeof(v))(mul))) * (typeof(v))(mul))
216 * Checks if a pointer is aligned to a given power-of-two value
219 * The pointer whose alignment is to be checked
221 * The power-of-two value to which the ptr should be aligned
224 * True(1) where the pointer is correctly aligned, false(0) otherwise
227 rte_is_aligned(void *ptr, unsigned align)
229 return RTE_PTR_ALIGN(ptr, align) == ptr;
232 /*********** Macros for compile type checks ********/
235 * Triggers an error at compilation time if the condition is true.
238 #define RTE_BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
240 extern int RTE_BUILD_BUG_ON_detected_error;
241 #define RTE_BUILD_BUG_ON(condition) do { \
242 ((void)sizeof(char[1 - 2*!!(condition)])); \
244 RTE_BUILD_BUG_ON_detected_error = 1; \
249 * Combines 32b inputs most significant set bits into the least
250 * significant bits to construct a value with the same MSBs as x
251 * but all 1's under it.
254 * The integer whose MSBs need to be combined with its LSBs
256 * The combined value.
258 static inline uint32_t
259 rte_combine32ms1b(register uint32_t x)
271 * Combines 64b inputs most significant set bits into the least
272 * significant bits to construct a value with the same MSBs as x
273 * but all 1's under it.
276 * The integer whose MSBs need to be combined with its LSBs
278 * The combined value.
280 static inline uint64_t
281 rte_combine64ms1b(register uint64_t v)
293 /*********** Macros to work with powers of 2 ********/
296 * Returns true if n is a power of 2
299 * @return 1 if true, 0 otherwise
302 rte_is_power_of_2(uint32_t n)
304 return n && !(n & (n - 1));
308 * Aligns input parameter to the next power of 2
311 * The integer value to algin
314 * Input parameter aligned to the next power of 2
316 static inline uint32_t
317 rte_align32pow2(uint32_t x)
320 x = rte_combine32ms1b(x);
326 * Aligns input parameter to the previous power of 2
329 * The integer value to algin
332 * Input parameter aligned to the previous power of 2
334 static inline uint32_t
335 rte_align32prevpow2(uint32_t x)
337 x = rte_combine32ms1b(x);
343 * Aligns 64b input parameter to the next power of 2
346 * The 64b value to align
349 * Input parameter aligned to the next power of 2
351 static inline uint64_t
352 rte_align64pow2(uint64_t v)
355 v = rte_combine64ms1b(v);
361 * Aligns 64b input parameter to the previous power of 2
364 * The 64b value to align
367 * Input parameter aligned to the previous power of 2
369 static inline uint64_t
370 rte_align64prevpow2(uint64_t v)
372 v = rte_combine64ms1b(v);
377 /*********** Macros for calculating min and max **********/
380 * Macro to return the minimum of two numbers
382 #define RTE_MIN(a, b) \
384 typeof (a) _a = (a); \
385 typeof (b) _b = (b); \
390 * Macro to return the maximum of two numbers
392 #define RTE_MAX(a, b) \
394 typeof (a) _a = (a); \
395 typeof (b) _b = (b); \
399 /*********** Other general functions / macros ********/
402 * Searches the input parameter for the least significant set bit
403 * (starting from zero).
404 * If a least significant 1 bit is found, its bit index is returned.
405 * If the content of the input parameter is zero, then the content of the return
406 * value is undefined.
408 * input parameter, should not be zero.
410 * least significant set bit in the input parameter.
412 static inline uint32_t
413 rte_bsf32(uint32_t v)
415 return __builtin_ctz(v);
419 * Return the rounded-up log2 of a integer.
422 * The input parameter.
424 * The rounded-up log2 of the input, or 0 if the input is 0.
426 static inline uint32_t
427 rte_log2_u32(uint32_t v)
431 v = rte_align32pow2(v);
436 /** Return the offset of a field in a structure. */
437 #define offsetof(TYPE, MEMBER) __builtin_offsetof (TYPE, MEMBER)
441 * Return pointer to the wrapping struct instance.
451 * struct child *x = obtain(...);
452 * struct wrapper *w = container_of(x, struct wrapper, c);
455 #define container_of(ptr, type, member) __extension__ ({ \
456 const typeof(((type *)0)->member) *_ptr = (ptr); \
457 __attribute__((unused)) type *_target_ptr = \
459 (type *)(((uintptr_t)_ptr) - offsetof(type, member)); \
463 #define _RTE_STR(x) #x
464 /** Take a macro value and get a string version of it */
465 #define RTE_STR(x) _RTE_STR(x)
468 * ISO C helpers to modify format strings using variadic macros.
469 * This is a replacement for the ", ## __VA_ARGS__" GNU extension.
470 * An empty %s argument is appended to avoid a dangling comma.
472 #define RTE_FMT(fmt, ...) fmt "%.0s", __VA_ARGS__ ""
473 #define RTE_FMT_HEAD(fmt, ...) fmt
474 #define RTE_FMT_TAIL(fmt, ...) __VA_ARGS__
476 /** Mask value of type "tp" for the first "ln" bit set. */
477 #define RTE_LEN2MASK(ln, tp) \
478 ((tp)((uint64_t)-1 >> (sizeof(uint64_t) * CHAR_BIT - (ln))))
480 /** Number of elements in the array. */
481 #define RTE_DIM(a) (sizeof (a) / sizeof ((a)[0]))
484 * Converts a numeric string to the equivalent uint64_t value.
485 * As well as straight number conversion, also recognises the suffixes
486 * k, m and g for kilobytes, megabytes and gigabytes respectively.
488 * If a negative number is passed in i.e. a string with the first non-black
489 * character being "-", zero is returned. Zero is also returned in the case of
490 * an error with the strtoull call in the function.
493 * String containing number to convert.
497 static inline uint64_t
498 rte_str_to_size(const char *str)
501 unsigned long long size;
503 while (isspace((int)*str))
509 size = strtoull(str, &endptr, 0);
514 endptr++; /* allow 1 space gap */
517 case 'G': case 'g': size *= 1024; /* fall-through */
518 case 'M': case 'm': size *= 1024; /* fall-through */
519 case 'K': case 'k': size *= 1024; /* fall-through */
527 * Function to terminate the application immediately, printing an error
528 * message and returning the exit_code back to the shell.
530 * This function never returns
533 * The exit code to be returned by the application
535 * The format string to be used for printing the message. This can include
536 * printf format characters which will be expanded using any further parameters
540 rte_exit(int exit_code, const char *format, ...)
541 __attribute__((noreturn))
542 __attribute__((format(printf, 2, 3)));