Branch data Line data Source code
1 : : /* SPDX-License-Identifier: BSD-3-Clause
2 : : * Copyright(c) 2010-2019 Intel Corporation
3 : : */
4 : :
5 : : #ifndef _RTE_COMMON_H_
6 : : #define _RTE_COMMON_H_
7 : :
8 : : /**
9 : : * @file
10 : : *
11 : : * Generic, commonly-used macro and inline function definitions
12 : : * for DPDK.
13 : : */
14 : :
15 : : #include <assert.h>
16 : : #include <limits.h>
17 : : #include <stdbool.h>
18 : : #include <stdint.h>
19 : : #include <stdalign.h>
20 : :
21 : : #include <rte_compat.h>
22 : : #include <rte_config.h>
23 : :
24 : : /* OS specific include */
25 : : #include <rte_os.h>
26 : :
27 : : #ifdef __cplusplus
28 : : extern "C" {
29 : : #endif
30 : :
31 : : #ifndef RTE_TOOLCHAIN_MSVC
32 : : #ifndef typeof
33 : : #define typeof __typeof__
34 : : #endif
35 : : #endif
36 : :
37 : : #ifndef __cplusplus
38 : : #ifndef asm
39 : : #define asm __asm__
40 : : #endif
41 : : #endif
42 : :
43 : : #ifdef RTE_TOOLCHAIN_MSVC
44 : : #ifdef __cplusplus
45 : : #define __extension__
46 : : #endif
47 : : #endif
48 : :
49 : : /*
50 : : * Macro __rte_constant checks if an expression's value can be determined at
51 : : * compile time. It takes a single argument, the expression to test, and
52 : : * returns 1 if the expression is a compile-time constant, and 0 otherwise.
53 : : * For most compilers it uses built-in function __builtin_constant_p, but for
54 : : * MSVC it uses a different method because MSVC does not have an equivalent
55 : : * to __builtin_constant_p.
56 : : *
57 : : * The trick used with MSVC relies on the way null pointer constants interact
58 : : * with the type of a ?: expression:
59 : : * An integer constant expression with the value 0, or such an expression cast
60 : : * to type void *, is called a null pointer constant.
61 : : * If both the second and third operands (of the ?: expression) are pointers or
62 : : * one is a null pointer constant and the other is a pointer, the result type
63 : : * is a pointer to a type qualified with all the type qualifiers of the types
64 : : * referenced by both operands. Furthermore, if both operands are pointers to
65 : : * compatible types or to differently qualified versions of compatible types,
66 : : * the result type is a pointer to an appropriately qualified version of the
67 : : * composite type; if one operand is a null pointer constant, the result has
68 : : * the type of the other operand; otherwise, one operand is a pointer to void
69 : : * or a qualified version of void, in which case the result type is a pointer
70 : : * to an appropriately qualified version of void.
71 : : *
72 : : * The _Generic keyword then checks the type of the expression
73 : : * (void *) ((e) * 0ll). It matches this type against the types listed in the
74 : : * _Generic construct:
75 : : * - If the type is int *, the result is 1.
76 : : * - If the type is void *, the result is 0.
77 : : *
78 : : * This explanation with some more details can be found at:
79 : : * https://stackoverflow.com/questions/49480442/detecting-integer-constant-expressions-in-macros
80 : : */
81 : : #ifdef RTE_TOOLCHAIN_MSVC
82 : : #define __rte_constant(e) _Generic((1 ? (void *) ((e) * 0ll) : (int *) 0), int * : 1, void * : 0)
83 : : #else
84 : : #define __rte_constant(e) __extension__(__builtin_constant_p(e))
85 : : #endif
86 : :
87 : : /*
88 : : * RTE_TOOLCHAIN_GCC is defined if the target is built with GCC,
89 : : * while a host application (like pmdinfogen) may have another compiler.
90 : : * RTE_CC_IS_GNU is true if the file is compiled with GCC,
91 : : * no matter it is a target or host application.
92 : : */
93 : : #define RTE_CC_IS_GNU 0
94 : : #if defined __clang__
95 : : #define RTE_CC_CLANG
96 : : #elif defined __GNUC__
97 : : #define RTE_CC_GCC
98 : : #undef RTE_CC_IS_GNU
99 : : #define RTE_CC_IS_GNU 1
100 : : #endif
101 : : #if RTE_CC_IS_GNU
102 : : #define GCC_VERSION (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + \
103 : : __GNUC_PATCHLEVEL__)
104 : : #endif
105 : :
106 : : /**
107 : : * Force type alignment
108 : : *
109 : : * This macro should be used when alignment of a struct or union type
110 : : * is required. For toolchain compatibility it should appear between
111 : : * the {struct,union} keyword and tag. e.g.
112 : : *
113 : : * struct __rte_aligned(8) tag { ... };
114 : : *
115 : : * If alignment of an object/variable is required then this macro should
116 : : * not be used, instead prefer C11 alignas(a).
117 : : */
118 : : #ifdef RTE_TOOLCHAIN_MSVC
119 : : #define __rte_aligned(a) __declspec(align(a))
120 : : #else
121 : : #define __rte_aligned(a) __attribute__((__aligned__(a)))
122 : : #endif
123 : :
124 : : #ifdef RTE_ARCH_STRICT_ALIGN
125 : : typedef uint64_t unaligned_uint64_t __rte_aligned(1);
126 : : typedef uint32_t unaligned_uint32_t __rte_aligned(1);
127 : : typedef uint16_t unaligned_uint16_t __rte_aligned(1);
128 : : #else
129 : : typedef uint64_t unaligned_uint64_t;
130 : : typedef uint32_t unaligned_uint32_t;
131 : : typedef uint16_t unaligned_uint16_t;
132 : : #endif
133 : :
134 : : /**
135 : : * @deprecated
136 : : * @see __rte_packed_begin
137 : : * @see __rte_packed_end
138 : : *
139 : : * Force a structure to be packed
140 : : */
141 : : #ifdef RTE_TOOLCHAIN_MSVC
142 : : #define __rte_packed RTE_DEPRECATED(__rte_packed)
143 : : #else
144 : : #define __rte_packed (RTE_DEPRECATED(__rte_packed) __attribute__((__packed__)))
145 : : #endif
146 : :
147 : : /**
148 : : * Force a structure to be packed
149 : : * Usage:
150 : : * struct __rte_packed_begin mystruct { ... } __rte_packed_end;
151 : : * union __rte_packed_begin myunion { ... } __rte_packed_end;
152 : : * Note: alignment attributes when present should precede __rte_packed_begin.
153 : : */
154 : : #ifdef RTE_TOOLCHAIN_MSVC
155 : : #define __rte_packed_begin __pragma(pack(push, 1))
156 : : #define __rte_packed_end __pragma(pack(pop))
157 : : #else
158 : : #define __rte_packed_begin
159 : : #define __rte_packed_end __attribute__((__packed__))
160 : : #endif
161 : :
162 : : /**
163 : : * Macro to mark a type that is not subject to type-based aliasing rules
164 : : */
165 : : #ifdef RTE_TOOLCHAIN_MSVC
166 : : #define __rte_may_alias
167 : : #else
168 : : #define __rte_may_alias __attribute__((__may_alias__))
169 : : #endif
170 : :
171 : : /******* Macro to mark functions and fields scheduled for removal *****/
172 : : #ifdef RTE_TOOLCHAIN_MSVC
173 : : #define __rte_deprecated
174 : : #define __rte_deprecated_msg(msg)
175 : : #else
176 : : #define __rte_deprecated __attribute__((__deprecated__))
177 : : #define __rte_deprecated_msg(msg) __attribute__((__deprecated__(msg)))
178 : : #endif
179 : :
180 : : /**
181 : : * Macro to mark macros and defines scheduled for removal
182 : : */
183 : : #if defined(RTE_CC_GCC) || defined(RTE_CC_CLANG)
184 : : #define RTE_PRAGMA(x) _Pragma(#x)
185 : : #define RTE_PRAGMA_WARNING(w) RTE_PRAGMA(GCC warning #w)
186 : : #define RTE_DEPRECATED(x) RTE_PRAGMA_WARNING(#x is deprecated)
187 : : #else
188 : : #define RTE_DEPRECATED(x)
189 : : #endif
190 : :
191 : : /**
192 : : * Macros to cause the compiler to remember the state of the diagnostics as of
193 : : * each push, and restore to that point at each pop.
194 : : */
195 : : #if !defined(RTE_TOOLCHAIN_MSVC)
196 : : #define __rte_diagnostic_push _Pragma("GCC diagnostic push")
197 : : #define __rte_diagnostic_pop _Pragma("GCC diagnostic pop")
198 : : #else
199 : : #define __rte_diagnostic_push
200 : : #define __rte_diagnostic_pop
201 : : #endif
202 : :
203 : : /**
204 : : * Macro to disable compiler warnings about removing a type
205 : : * qualifier from the target type.
206 : : */
207 : : #if !defined(RTE_TOOLCHAIN_MSVC)
208 : : #define __rte_diagnostic_ignored_wcast_qual _Pragma("GCC diagnostic ignored \"-Wcast-qual\"")
209 : : #else
210 : : #define __rte_diagnostic_ignored_wcast_qual
211 : : #endif
212 : :
213 : : /**
214 : : * Mark a function or variable to a weak reference.
215 : : */
216 : : #ifdef RTE_TOOLCHAIN_MSVC
217 : : #define __rte_weak RTE_DEPRECATED(__rte_weak)
218 : : #else
219 : : #define __rte_weak RTE_DEPRECATED(__rte_weak) __attribute__((__weak__))
220 : : #endif
221 : :
222 : : /**
223 : : * Mark a function to be pure.
224 : : */
225 : : #ifdef RTE_TOOLCHAIN_MSVC
226 : : #define __rte_pure
227 : : #else
228 : : #define __rte_pure __attribute__((pure))
229 : : #endif
230 : :
231 : : /**
232 : : * Force symbol to be generated even if it appears to be unused.
233 : : */
234 : : #ifdef RTE_TOOLCHAIN_MSVC
235 : : #define __rte_used
236 : : #else
237 : : #define __rte_used __attribute__((used))
238 : : #endif
239 : :
240 : : /*********** Macros to eliminate unused variable warnings ********/
241 : :
242 : : /**
243 : : * short definition to mark a function parameter unused
244 : : */
245 : : #ifdef RTE_TOOLCHAIN_MSVC
246 : : #define __rte_unused
247 : : #else
248 : : #define __rte_unused __attribute__((__unused__))
249 : : #endif
250 : :
251 : : /**
252 : : * Mark pointer as restricted with regard to pointer aliasing.
253 : : */
254 : : #if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 199901L
255 : : #define __rte_restrict __restrict
256 : : #else
257 : : #define __rte_restrict restrict
258 : : #endif
259 : :
260 : : /**
261 : : * definition to mark a variable or function parameter as used so
262 : : * as to avoid a compiler warning
263 : : */
264 : : #define RTE_SET_USED(x) (void)(x)
265 : :
266 : : /**
267 : : * Check format string and its arguments at compile-time.
268 : : *
269 : : * GCC on Windows assumes MS-specific format string by default,
270 : : * even if the underlying stdio implementation is ANSI-compliant,
271 : : * so this must be overridden.
272 : : */
273 : : #ifdef RTE_TOOLCHAIN_MSVC
274 : : #define __rte_format_printf(format_index, first_arg)
275 : : #else
276 : : #if RTE_CC_IS_GNU
277 : : #define __rte_format_printf(format_index, first_arg) \
278 : : __attribute__((format(gnu_printf, format_index, first_arg)))
279 : : #else
280 : : #define __rte_format_printf(format_index, first_arg) \
281 : : __attribute__((format(printf, format_index, first_arg)))
282 : : #endif
283 : : #endif
284 : :
285 : : /**
286 : : * Specify data or function section/segment.
287 : : */
288 : : #ifdef RTE_TOOLCHAIN_MSVC
289 : : #define __rte_section(name) \
290 : : __pragma(data_seg(name)) __declspec(allocate(name))
291 : : #else
292 : : #define __rte_section(name) \
293 : : __attribute__((section(name)))
294 : : #endif
295 : :
296 : : /**
297 : : * Tells compiler that the function returns a value that points to
298 : : * memory, where the size is given by the one or two arguments.
299 : : * Used by compiler to validate object size.
300 : : */
301 : : #if defined(RTE_CC_GCC) || defined(RTE_CC_CLANG)
302 : : #define __rte_alloc_size(...) \
303 : : __attribute__((alloc_size(__VA_ARGS__)))
304 : : #else
305 : : #define __rte_alloc_size(...)
306 : : #endif
307 : :
308 : : /**
309 : : * Tells the compiler that the function returns a value that points to
310 : : * memory aligned by a function argument.
311 : : *
312 : : * Note: not enabled on Clang because it warns if align argument is zero.
313 : : */
314 : : #if defined(RTE_CC_GCC)
315 : : #define __rte_alloc_align(argno) \
316 : : __attribute__((alloc_align(argno)))
317 : : #else
318 : : #define __rte_alloc_align(argno)
319 : : #endif
320 : :
321 : : /**
322 : : * Tells the compiler this is a function like malloc and that the pointer
323 : : * returned cannot alias any other pointer (ie new memory).
324 : : */
325 : : #if defined(RTE_CC_GCC) || defined(RTE_CC_CLANG)
326 : : #define __rte_malloc __attribute__((__malloc__))
327 : : #else
328 : : #define __rte_malloc
329 : : #endif
330 : :
331 : : /**
332 : : * With recent GCC versions also able to track that proper
333 : : * deallocator function is used for this pointer.
334 : : */
335 : : #if defined(RTE_TOOLCHAIN_GCC) && (GCC_VERSION >= 110000)
336 : : #define __rte_dealloc(dealloc, argno) \
337 : : __attribute__((malloc(dealloc, argno)))
338 : : #else
339 : : #define __rte_dealloc(dealloc, argno)
340 : : #endif
341 : :
342 : : #define RTE_PRIORITY_LOG 101
343 : : #define RTE_PRIORITY_BUS 110
344 : : #define RTE_PRIORITY_CLASS 120
345 : : #define RTE_PRIORITY_LAST 65535
346 : :
347 : : #define RTE_PRIO(prio) \
348 : : RTE_PRIORITY_ ## prio
349 : :
350 : : /**
351 : : * Run function before main() with high priority.
352 : : *
353 : : * @param func
354 : : * Constructor function.
355 : : * @param prio
356 : : * Priority number must be above 100.
357 : : * Lowest number is the first to run.
358 : : */
359 : : #ifndef RTE_INIT_PRIO /* Allow overriding from EAL */
360 : : #ifndef RTE_TOOLCHAIN_MSVC
361 : : #define RTE_INIT_PRIO(func, prio) \
362 : : static void __attribute__((constructor(RTE_PRIO(prio)), used)) func(void)
363 : : #else
364 : : /* definition from the Microsoft CRT */
365 : : typedef int(__cdecl *_PIFV)(void);
366 : :
367 : : #define CTOR_SECTION_LOG ".CRT$XIB"
368 : : #define CTOR_SECTION_BUS ".CRT$XIC"
369 : : #define CTOR_SECTION_CLASS ".CRT$XID"
370 : : #define CTOR_SECTION_LAST ".CRT$XIY"
371 : :
372 : : #define CTOR_PRIORITY_TO_SECTION(priority) CTOR_SECTION_ ## priority
373 : :
374 : : #define RTE_INIT_PRIO(name, priority) \
375 : : static void name(void); \
376 : : static int __cdecl name ## _thunk(void) { name(); return 0; } \
377 : : __pragma(const_seg(CTOR_PRIORITY_TO_SECTION(priority))) \
378 : : __declspec(allocate(CTOR_PRIORITY_TO_SECTION(priority))) \
379 : : _PIFV name ## _pointer = &name ## _thunk; \
380 : : __pragma(const_seg()) \
381 : : static void name(void)
382 : : #endif
383 : : #endif
384 : :
385 : : /**
386 : : * Run function before main() with low priority.
387 : : *
388 : : * The constructor will be run after prioritized constructors.
389 : : *
390 : : * @param func
391 : : * Constructor function.
392 : : */
393 : : #define RTE_INIT(func) \
394 : : RTE_INIT_PRIO(func, LAST)
395 : :
396 : : /**
397 : : * Run after main() with low priority.
398 : : *
399 : : * @param func
400 : : * Destructor function name.
401 : : * @param prio
402 : : * Priority number must be above 100.
403 : : * Lowest number is the last to run.
404 : : */
405 : : #ifndef RTE_FINI_PRIO /* Allow overriding from EAL */
406 : : #ifndef RTE_TOOLCHAIN_MSVC
407 : : #define RTE_FINI_PRIO(func, prio) \
408 : : static void __attribute__((destructor(RTE_PRIO(prio)), used)) func(void)
409 : : #else
410 : : #define DTOR_SECTION_LOG "mydtor$B"
411 : : #define DTOR_SECTION_BUS "mydtor$C"
412 : : #define DTOR_SECTION_CLASS "mydtor$D"
413 : : #define DTOR_SECTION_LAST "mydtor$Y"
414 : :
415 : : #define DTOR_PRIORITY_TO_SECTION(priority) DTOR_SECTION_ ## priority
416 : :
417 : : #define RTE_FINI_PRIO(name, priority) \
418 : : static void name(void); \
419 : : __pragma(const_seg(DTOR_PRIORITY_TO_SECTION(priority))) \
420 : : __declspec(allocate(DTOR_PRIORITY_TO_SECTION(priority))) void *name ## _pointer = &name; \
421 : : __pragma(const_seg()) \
422 : : static void name(void)
423 : : #endif
424 : : #endif
425 : :
426 : : /**
427 : : * Run after main() with high priority.
428 : : *
429 : : * The destructor will be run *before* prioritized destructors.
430 : : *
431 : : * @param func
432 : : * Destructor function name.
433 : : */
434 : : #define RTE_FINI(func) \
435 : : RTE_FINI_PRIO(func, LAST)
436 : :
437 : : /**
438 : : * Hint never returning function
439 : : */
440 : : #ifdef RTE_TOOLCHAIN_MSVC
441 : : #define __rte_noreturn
442 : : #else
443 : : #define __rte_noreturn __attribute__((noreturn))
444 : : #endif
445 : :
446 : : /**
447 : : * Hint point in program never reached
448 : : */
449 : : #if defined(RTE_TOOLCHAIN_GCC) || defined(RTE_TOOLCHAIN_CLANG)
450 : : #define __rte_unreachable() __extension__(__builtin_unreachable())
451 : : #else
452 : : #define __rte_unreachable() __assume(0)
453 : : #endif
454 : :
455 : : /**
456 : : * Issue a warning in case the function's return value is ignored.
457 : : *
458 : : * The use of this attribute should be restricted to cases where
459 : : * ignoring the marked function's return value is almost always a
460 : : * bug. With GCC, some effort is required to make clear that ignoring
461 : : * the return value is intentional. The usual void-casting method to
462 : : * mark something unused as used does not suppress the warning with
463 : : * this compiler.
464 : : *
465 : : * @code{.c}
466 : : * __rte_warn_unused_result int foo();
467 : : *
468 : : * void ignore_foo_result(void) {
469 : : * foo(); // generates a warning with all compilers
470 : : *
471 : : * (void)foo(); // still generates the warning with GCC (but not clang)
472 : : *
473 : : * int unused __rte_unused;
474 : : * unused = foo(); // does the trick with all compilers
475 : : * }
476 : : * @endcode
477 : : */
478 : : #ifdef RTE_TOOLCHAIN_MSVC
479 : : #define __rte_warn_unused_result
480 : : #else
481 : : #define __rte_warn_unused_result __attribute__((warn_unused_result))
482 : : #endif
483 : :
484 : : /**
485 : : * Force a function to be inlined, regardless of the compiler's size
486 : : * and call-graph heuristics.
487 : : *
488 : : * Prefer plain @c inline (or no annotation on a static function)
489 : : * and let the compiler decide.
490 : : * Modern compilers at -O2 inline small static functions well,
491 : : * and forcing it can hurt by inflating call sites, raising register pressure,
492 : : * and overriding profile-guided optimization.
493 : : *
494 : : * Reserve this attribute for cases where inlining is required for correctness,
495 : : * or for a documented and measured performance reason, e.g.
496 : : * - a constant-folded fast path gated by @c __rte_constant()
497 : : * that is lost unless the function is inlined into the caller;
498 : : * - a wrapper around inline asm or an intrinsic
499 : : * that needs a compile-time-constant argument from the caller's context.
500 : : *
501 : : * See the DPDK coding style guide for the full policy.
502 : : */
503 : : #ifdef RTE_TOOLCHAIN_MSVC
504 : : #define __rte_always_inline __forceinline
505 : : #else
506 : : #define __rte_always_inline inline __attribute__((always_inline))
507 : : #endif
508 : :
509 : : /**
510 : : * Force a function not to be inlined.
511 : : *
512 : : * Useful for explicitly outlining cold paths such as error handling,
513 : : * initialization, slow-path fallbacks, so they do not bloat the hot path
514 : : * or add to its instruction-cache footprint.
515 : : */
516 : : #ifdef RTE_TOOLCHAIN_MSVC
517 : : #define __rte_noinline __declspec(noinline)
518 : : #else
519 : : #define __rte_noinline __attribute__((noinline))
520 : : #endif
521 : :
522 : : /**
523 : : * Hint function in the hot path
524 : : *
525 : : * The compiler may optimize the function more aggressively,
526 : : * treat calls to it as likely for branch prediction,
527 : : * and group it with other hot functions to improve instruction-cache locality.
528 : : * This affects code placement and prediction, not inlining;
529 : : * combine with an inline annotation if both are wanted.
530 : : */
531 : : #ifdef RTE_TOOLCHAIN_MSVC
532 : : #define __rte_hot
533 : : #else
534 : : #define __rte_hot __attribute__((hot))
535 : : #endif
536 : :
537 : : /**
538 : : * Hint function in the cold path
539 : : *
540 : : * The compiler optimizes the function for size rather than speed,
541 : : * marks branches that reach it as unlikely,
542 : : * and may move it to a separate section to keep it off the hot path
543 : : * and reduce instruction-cache pressure there.
544 : : *
545 : : * Suitable for error handling, logging, and setup/teardown code.
546 : : * Functions marked @c __rte_noreturn are already treated as cold.
547 : : */
548 : : #ifdef RTE_TOOLCHAIN_MSVC
549 : : #define __rte_cold
550 : : #else
551 : : #define __rte_cold __attribute__((cold))
552 : : #endif
553 : :
554 : : /**
555 : : * Hint precondition
556 : : *
557 : : * @warning Depending on the compiler, any code in ``condition`` might be executed.
558 : : * This currently only occurs with GCC prior to version 13.
559 : : */
560 : : #if defined(RTE_TOOLCHAIN_GCC) && (GCC_VERSION >= 130000)
561 : : #define __rte_assume(condition) __attribute__((assume(condition)))
562 : : #elif defined(RTE_TOOLCHAIN_GCC)
563 : : #define __rte_assume(condition) do { if (!(condition)) __rte_unreachable(); } while (0)
564 : : #elif defined(RTE_TOOLCHAIN_CLANG)
565 : : #define __rte_assume(condition) __extension__(__builtin_assume(condition))
566 : : #else
567 : : #define __rte_assume(condition) __assume(condition)
568 : : #endif
569 : :
570 : : /**
571 : : * Disable AddressSanitizer on some code
572 : : */
573 : : #ifdef RTE_MALLOC_ASAN
574 : : #ifdef RTE_CC_CLANG
575 : : #define __rte_no_asan __attribute__((no_sanitize("address", "hwaddress")))
576 : : #else
577 : : #define __rte_no_asan __attribute__((no_sanitize_address))
578 : : #endif
579 : : #else /* ! RTE_MALLOC_ASAN */
580 : : #define __rte_no_asan
581 : : #endif
582 : :
583 : : /*********** Macros for pointer arithmetic ********/
584 : :
585 : : /**
586 : : * add a byte-value offset to a pointer
587 : : */
588 : : #define RTE_PTR_ADD(ptr, x) ((void*)((uintptr_t)(ptr) + (x)))
589 : :
590 : : /**
591 : : * subtract a byte-value offset from a pointer
592 : : */
593 : : #define RTE_PTR_SUB(ptr, x) ((void *)((uintptr_t)(ptr) - (x)))
594 : :
595 : : /**
596 : : * get the difference between two pointer values, i.e. how far apart
597 : : * in bytes are the locations they point two. It is assumed that
598 : : * ptr1 is greater than ptr2.
599 : : */
600 : : #define RTE_PTR_DIFF(ptr1, ptr2) ((uintptr_t)(ptr1) - (uintptr_t)(ptr2))
601 : :
602 : : /*********** Macros for casting pointers ********/
603 : :
604 : : /**
605 : : * Macro to discard qualifiers (such as const, volatile, restrict) from a pointer,
606 : : * without the compiler emitting a warning.
607 : : */
608 : : #define RTE_PTR_UNQUAL(X) ((void *)(uintptr_t)(X))
609 : :
610 : : /**
611 : : * Macro to cast a pointer to a specific type,
612 : : * without the compiler emitting a warning about discarding qualifiers.
613 : : *
614 : : * @warning
615 : : * When casting a pointer to point to a larger type, the resulting pointer may
616 : : * be misaligned, which results in undefined behavior.
617 : : * E.g.:
618 : : *
619 : : * struct s {
620 : : * uint16_t a;
621 : : * uint8_t b;
622 : : * uint8_t c;
623 : : * uint8_t d;
624 : : * } v;
625 : : * uint16_t * p = RTE_CAST_PTR(uint16_t *, &v.c); // "p" is not 16 bit aligned!
626 : : */
627 : : #define RTE_CAST_PTR(type, ptr) ((type)(uintptr_t)(ptr))
628 : :
629 : : /**
630 : : * Workaround to cast a const field of a structure to non-const type.
631 : : */
632 : : #define RTE_CAST_FIELD(var, field, type) \
633 : : (*(type *)((uintptr_t)(var) + offsetof(typeof(*(var)), field)))
634 : :
635 : : /*********** Macros/static functions for doing alignment ********/
636 : :
637 : :
638 : : /**
639 : : * Macro to align a pointer to a given power-of-two. The resultant
640 : : * pointer will be a pointer of the same type as the first parameter, and
641 : : * point to an address no higher than the first parameter. Second parameter
642 : : * must be a power-of-two value.
643 : : */
644 : : #define RTE_PTR_ALIGN_FLOOR(ptr, align) \
645 : : ((typeof(ptr))RTE_ALIGN_FLOOR((uintptr_t)(ptr), align))
646 : :
647 : : /**
648 : : * Macro to align a value to a given power-of-two. The resultant value
649 : : * will be of the same type as the first parameter, and will be no
650 : : * bigger than the first parameter. Second parameter must be a
651 : : * power-of-two value.
652 : : */
653 : : #define RTE_ALIGN_FLOOR(val, align) \
654 : : (typeof(val))((val) & (~((typeof(val))((align) - 1))))
655 : :
656 : : /**
657 : : * Macro to align a pointer to a given power-of-two. The resultant
658 : : * pointer will be a pointer of the same type as the first parameter, and
659 : : * point to an address no lower than the first parameter. Second parameter
660 : : * must be a power-of-two value.
661 : : */
662 : : #define RTE_PTR_ALIGN_CEIL(ptr, align) \
663 : : RTE_PTR_ALIGN_FLOOR((typeof(ptr))RTE_PTR_ADD(ptr, (align) - 1), align)
664 : :
665 : : /**
666 : : * Macro to align a value to a given power-of-two. The resultant value
667 : : * will be of the same type as the first parameter, and will be no lower
668 : : * than the first parameter. Second parameter must be a power-of-two
669 : : * value.
670 : : */
671 : : #define RTE_ALIGN_CEIL(val, align) \
672 : : RTE_ALIGN_FLOOR(((val) + ((typeof(val)) (align) - 1)), align)
673 : :
674 : : /**
675 : : * Macro to align a pointer to a given power-of-two. The resultant
676 : : * pointer will be a pointer of the same type as the first parameter, and
677 : : * point to an address no lower than the first parameter. Second parameter
678 : : * must be a power-of-two value.
679 : : * This function is the same as RTE_PTR_ALIGN_CEIL
680 : : */
681 : : #define RTE_PTR_ALIGN(ptr, align) RTE_PTR_ALIGN_CEIL(ptr, align)
682 : :
683 : : /**
684 : : * Macro to align a value to a given power-of-two. The resultant
685 : : * value will be of the same type as the first parameter, and
686 : : * will be no lower than the first parameter. Second parameter
687 : : * must be a power-of-two value.
688 : : * This function is the same as RTE_ALIGN_CEIL
689 : : */
690 : : #define RTE_ALIGN(val, align) RTE_ALIGN_CEIL(val, align)
691 : :
692 : : /**
693 : : * Macro to align a value to the multiple of given value. The resultant
694 : : * value will be of the same type as the first parameter and will be no lower
695 : : * than the first parameter.
696 : : */
697 : : #define RTE_ALIGN_MUL_CEIL(v, mul) \
698 : : ((((v) + (typeof(v))(mul) - 1) / ((typeof(v))(mul))) * (typeof(v))(mul))
699 : :
700 : : /**
701 : : * Macro to align a value to the multiple of given value. The resultant
702 : : * value will be of the same type as the first parameter and will be no higher
703 : : * than the first parameter.
704 : : */
705 : : #define RTE_ALIGN_MUL_FLOOR(v, mul) \
706 : : (((v) / ((typeof(v))(mul))) * (typeof(v))(mul))
707 : :
708 : : /**
709 : : * Macro to align value to the nearest multiple of the given value.
710 : : * The resultant value might be greater than or less than the first parameter
711 : : * whichever difference is the lowest.
712 : : */
713 : : #define RTE_ALIGN_MUL_NEAR(v, mul) \
714 : : __extension__ ({ \
715 : : typeof(v) ceil = RTE_ALIGN_MUL_CEIL(v, mul); \
716 : : typeof(v) floor = RTE_ALIGN_MUL_FLOOR(v, mul); \
717 : : (ceil - (v)) > ((v) - floor) ? floor : ceil; \
718 : : })
719 : :
720 : : /**
721 : : * Checks if a pointer is aligned to a given power-of-two value
722 : : *
723 : : * @param ptr
724 : : * The pointer whose alignment is to be checked
725 : : * @param align
726 : : * The power-of-two value to which the ptr should be aligned
727 : : *
728 : : * @return
729 : : * True(1) where the pointer is correctly aligned, false(0) otherwise
730 : : */
731 : : static inline int
732 : : rte_is_aligned(const void * const __rte_restrict ptr, const unsigned int align)
733 : : {
734 [ + + # # : 18 : return ((uintptr_t)ptr & (align - 1)) == 0;
# # ]
735 : : }
736 : :
737 : : /*********** Macros for compile type checks ********/
738 : :
739 : : /* Workaround for toolchain issues with missing C11 macro in FreeBSD */
740 : : #if !defined(static_assert) && !defined(__cplusplus)
741 : : #define static_assert _Static_assert
742 : : #endif
743 : :
744 : : /**
745 : : * Triggers an error at compilation time if the condition is true.
746 : : *
747 : : * The do { } while(0) exists to workaround a bug in clang (#55821)
748 : : * where it would not handle _Static_assert in a switch case.
749 : : */
750 : : #define RTE_BUILD_BUG_ON(condition) do { static_assert(!(condition), #condition); } while (0)
751 : :
752 : : /*********** Cache line related macros ********/
753 : :
754 : : /** Cache line mask. */
755 : : #define RTE_CACHE_LINE_MASK (RTE_CACHE_LINE_SIZE-1)
756 : :
757 : : /** Return the first cache-aligned value greater or equal to size. */
758 : : #define RTE_CACHE_LINE_ROUNDUP(size) RTE_ALIGN_CEIL(size, RTE_CACHE_LINE_SIZE)
759 : :
760 : : /** Cache line size in terms of log2 */
761 : : #if RTE_CACHE_LINE_SIZE == 64
762 : : #define RTE_CACHE_LINE_SIZE_LOG2 6
763 : : #elif RTE_CACHE_LINE_SIZE == 128
764 : : #define RTE_CACHE_LINE_SIZE_LOG2 7
765 : : #else
766 : : #error "Unsupported cache line size"
767 : : #endif
768 : :
769 : : /** Minimum Cache line size. */
770 : : #define RTE_CACHE_LINE_MIN_SIZE 64
771 : :
772 : : /** Force alignment to cache line. */
773 : : #define __rte_cache_aligned __rte_aligned(RTE_CACHE_LINE_SIZE)
774 : :
775 : : /** Force minimum cache line alignment. */
776 : : #define __rte_cache_min_aligned __rte_aligned(RTE_CACHE_LINE_MIN_SIZE)
777 : :
778 : : #define _RTE_CACHE_GUARD_HELPER2(unique) \
779 : : alignas(RTE_CACHE_LINE_SIZE) \
780 : : char cache_guard_ ## unique[RTE_CACHE_LINE_SIZE * RTE_CACHE_GUARD_LINES]
781 : : #define _RTE_CACHE_GUARD_HELPER1(unique) _RTE_CACHE_GUARD_HELPER2(unique)
782 : : /**
783 : : * Empty cache lines, to guard against false sharing-like effects
784 : : * on systems with a next-N-lines hardware prefetcher.
785 : : *
786 : : * Use as spacing between data accessed by different lcores,
787 : : * to prevent cache thrashing on hardware with speculative prefetching.
788 : : *
789 : : * Note: Although __COUNTER__ would be better for uniqueness,
790 : : * it is not yet (March 2026) part of the C standard,
791 : : * so compilation would fail when building in pedantic mode.
792 : : */
793 : : #define RTE_CACHE_GUARD _RTE_CACHE_GUARD_HELPER1(__LINE__)
794 : :
795 : : /*********** PA/IOVA type definitions ********/
796 : :
797 : : /** Physical address */
798 : : typedef uint64_t phys_addr_t;
799 : : #define RTE_BAD_PHYS_ADDR ((phys_addr_t)-1)
800 : :
801 : : /**
802 : : * IO virtual address type.
803 : : * When the physical addressing mode (IOVA as PA) is in use,
804 : : * the translation from an IO virtual address (IOVA) to a physical address
805 : : * is a direct mapping, i.e. the same value.
806 : : * Otherwise, in virtual mode (IOVA as VA), an IOMMU may do the translation.
807 : : */
808 : : typedef uint64_t rte_iova_t;
809 : : #define RTE_BAD_IOVA ((rte_iova_t)-1)
810 : :
811 : : /*********** Structure alignment markers ********/
812 : :
813 : : #ifndef RTE_TOOLCHAIN_MSVC
814 : :
815 : : /** Generic marker for any place in a structure. */
816 : : __extension__ typedef void *RTE_MARKER[0];
817 : : /** Marker for 1B alignment in a structure. */
818 : : __extension__ typedef uint8_t RTE_MARKER8[0];
819 : : /** Marker for 2B alignment in a structure. */
820 : : __extension__ typedef uint16_t RTE_MARKER16[0];
821 : : /** Marker for 4B alignment in a structure. */
822 : : __extension__ typedef uint32_t RTE_MARKER32[0];
823 : : /** Marker for 8B alignment in a structure. */
824 : : __extension__ typedef uint64_t RTE_MARKER64[0];
825 : :
826 : : #endif
827 : :
828 : : /*********** Macros for calculating min and max **********/
829 : :
830 : : /**
831 : : * Macro to return the minimum of two numbers
832 : : */
833 : : #define RTE_MIN(a, b) \
834 : : __extension__ ({ \
835 : : typeof (a) _a_min = (a); \
836 : : typeof (b) _b_min = (b); \
837 : : _a_min < _b_min ? _a_min : _b_min; \
838 : : })
839 : :
840 : : /**
841 : : * Macro to return the minimum of three numbers
842 : : */
843 : : #define RTE_MIN3(a, b, c) \
844 : : __extension__ ({ \
845 : : typeof (a) _a_min3 = (a); \
846 : : typeof (b) _b_min3 = (b); \
847 : : typeof (c) _c_min3 = (c); \
848 : : _a_min3 < _b_min3 ? \
849 : : (_a_min3 < _c_min3 ? _a_min3 : _c_min3) : \
850 : : (_b_min3 < _c_min3 ? _b_min3 : _c_min3); \
851 : : })
852 : :
853 : : /**
854 : : * Macro to return the minimum of two numbers
855 : : *
856 : : * As opposed to RTE_MIN, it does not use temporary variables so it is not safe
857 : : * if a or b is an expression. Yet it is guaranteed to be constant for use in
858 : : * static_assert().
859 : : */
860 : : #define RTE_MIN_T(a, b, t) \
861 : : ((t)(a) < (t)(b) ? (t)(a) : (t)(b))
862 : :
863 : : /**
864 : : * Macro to return the maximum of two numbers
865 : : */
866 : : #define RTE_MAX(a, b) \
867 : : __extension__ ({ \
868 : : typeof (a) _a_max = (a); \
869 : : typeof (b) _b_max = (b); \
870 : : _a_max > _b_max ? _a_max : _b_max; \
871 : : })
872 : :
873 : : /**
874 : : * Macro to return the maximum of three numbers
875 : : */
876 : : #define RTE_MAX3(a, b, c) \
877 : : __extension__ ({ \
878 : : typeof (a) _a_max3 = (a); \
879 : : typeof (b) _b_max3 = (b); \
880 : : typeof (c) _c_max3 = (c); \
881 : : _a_max3 > _b_max3 ? \
882 : : (_a_max3 > _c_max3 ? _a_max3 : _c_max3) : \
883 : : (_b_max3 > _c_max3 ? _b_max3 : _c_max3); \
884 : : })
885 : :
886 : : /**
887 : : * Macro to return the maximum of two numbers
888 : : *
889 : : * As opposed to RTE_MAX, it does not use temporary variables so it is not safe
890 : : * if a or b is an expression. Yet it is guaranteed to be constant for use in
891 : : * static_assert().
892 : : */
893 : : #define RTE_MAX_T(a, b, t) \
894 : : ((t)(a) > (t)(b) ? (t)(a) : (t)(b))
895 : :
896 : : /*********** Other general functions / macros ********/
897 : :
898 : : #ifndef offsetof
899 : : /** Return the offset of a field in a structure. */
900 : : #define offsetof(TYPE, MEMBER) __builtin_offsetof (TYPE, MEMBER)
901 : : #endif
902 : :
903 : : /**
904 : : * Return pointer to the wrapping struct instance.
905 : : *
906 : : * Example:
907 : : *
908 : : * struct wrapper {
909 : : * ...
910 : : * struct child c;
911 : : * ...
912 : : * };
913 : : *
914 : : * struct child *x = obtain(...);
915 : : * struct wrapper *w = container_of(x, struct wrapper, c);
916 : : */
917 : : #ifndef container_of
918 : : #ifdef RTE_TOOLCHAIN_MSVC
919 : : #define container_of(ptr, type, member) \
920 : : ((type *)((uintptr_t)(ptr) - offsetof(type, member)))
921 : : #else
922 : : #define container_of(ptr, type, member) __extension__ ({ \
923 : : const typeof(((type *)0)->member) *_ptr = (ptr); \
924 : : __rte_unused type *_target_ptr = \
925 : : (type *)(ptr); \
926 : : (type *)(((uintptr_t)_ptr) - offsetof(type, member)); \
927 : : })
928 : : #endif
929 : : #endif
930 : :
931 : : /** Swap two variables. */
932 : : #define RTE_SWAP(a, b) \
933 : : __extension__ ({ \
934 : : typeof (a) _a = a; \
935 : : a = b; \
936 : : b = _a; \
937 : : })
938 : :
939 : : /**
940 : : * Get the size of a field in a structure.
941 : : *
942 : : * @param type
943 : : * The type of the structure.
944 : : * @param field
945 : : * The field in the structure.
946 : : * @return
947 : : * The size of the field in the structure, in bytes.
948 : : */
949 : : #define RTE_SIZEOF_FIELD(type, field) (sizeof(((type *)0)->field))
950 : :
951 : : #define _RTE_STR(x) #x
952 : : /** Take a macro value and get a string version of it */
953 : : #define RTE_STR(x) _RTE_STR(x)
954 : :
955 : : /** Concatenate two tokens after expanding macros in both. */
956 : : #define _RTE_CONCAT2(a, b) a ## b
957 : : #define RTE_CONCAT(a, b) _RTE_CONCAT2(a, b)
958 : :
959 : : /**
960 : : * ISO C helpers to modify format strings using variadic macros.
961 : : * This is a replacement for the ", ## __VA_ARGS__" GNU extension.
962 : : * An empty %s argument is appended to avoid a dangling comma.
963 : : */
964 : : #define RTE_FMT(fmt, ...) fmt "%.0s", __VA_ARGS__ ""
965 : : #define RTE_FMT_HEAD(fmt, ...) fmt
966 : : #define RTE_FMT_TAIL(fmt, ...) __VA_ARGS__
967 : :
968 : : /** Mask value of type "tp" for the first "ln" bit set. */
969 : : #define RTE_LEN2MASK(ln, tp) \
970 : : ((tp)((uint64_t)-1 >> (sizeof(uint64_t) * CHAR_BIT - (ln))))
971 : :
972 : : /** Number of elements in the array. */
973 : : #define RTE_DIM(a) (sizeof (a) / sizeof ((a)[0]))
974 : :
975 : : /**
976 : : * Converts a numeric string to the equivalent uint64_t value.
977 : : * As well as straight number conversion, also recognises the suffixes
978 : : * k, m and g for kilobytes, megabytes and gigabytes respectively.
979 : : *
980 : : * If a negative number is passed in i.e. a string with the first non-black
981 : : * character being "-", zero is returned. Zero is also returned in the case of
982 : : * an error with the strtoull call in the function.
983 : : *
984 : : * @param str
985 : : * String containing number to convert.
986 : : * @return
987 : : * Number.
988 : : */
989 : : uint64_t
990 : : rte_str_to_size(const char *str);
991 : :
992 : : /**
993 : : * @warning
994 : : * @b EXPERIMENTAL: this API may change without prior notice.
995 : : *
996 : : * Converts the uint64_t value provided to a human-readable string.
997 : : * It null-terminates the string, truncating the data if needed.
998 : : * An optional unit (like "B") can be provided as a string. It will be
999 : : * appended to the number, and a space will be inserted before the unit if needed.
1000 : : *
1001 : : * Sample outputs: (1) "use_iec" disabled, (2) "use_iec" enabled,
1002 : : * (3) "use_iec" enabled and "B" as unit.
1003 : : * 0 : "0", "0", "0 B"
1004 : : * 700 : "700", "700", "700 B"
1005 : : * 1000 : "1.00 k", "1000", "1000 B"
1006 : : * 1024 : "1.02 k", "1.00 ki", "1.00 kiB"
1007 : : * 21474836480 : "21.5 G", "20.0 Gi", "20.0 GiB"
1008 : : * 109951162777600 : "110 T", "100 Ti", "100 TiB"
1009 : : *
1010 : : * @param buf
1011 : : * Buffer to write the string to.
1012 : : * @param buf_size
1013 : : * Size of the buffer.
1014 : : * @param count
1015 : : * Number to convert.
1016 : : * @param use_iec
1017 : : * If true, use IEC units (1024-based), otherwise use SI units (1000-based).
1018 : : * @param unit
1019 : : * Unit to append to the string (Like "B" for bytes). Can be NULL.
1020 : : * @return
1021 : : * buf on success, NULL if the buffer is too small.
1022 : : */
1023 : : __rte_experimental
1024 : : char *
1025 : : rte_size_to_str(char *buf, int buf_size, uint64_t count, bool use_iec, const char *unit);
1026 : :
1027 : : /**
1028 : : * Function to terminate the application immediately, printing an error
1029 : : * message and returning the exit_code back to the shell.
1030 : : *
1031 : : * This function never returns
1032 : : *
1033 : : * @param exit_code
1034 : : * The exit code to be returned by the application
1035 : : * @param format
1036 : : * The format string to be used for printing the message. This can include
1037 : : * printf format characters which will be expanded using any further parameters
1038 : : * to the function.
1039 : : */
1040 : : __rte_noreturn void
1041 : : rte_exit(int exit_code, const char *format, ...)
1042 : : __rte_format_printf(2, 3);
1043 : :
1044 : : #ifdef __cplusplus
1045 : : }
1046 : : #endif
1047 : :
1048 : : #endif
|
