DPDK 25.03.0
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
rte_common.h
Go to the documentation of this file.
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
15#include <assert.h>
16#include <limits.h>
17#include <stdint.h>
18#include <stdalign.h>
19
20#include <rte_config.h>
21
22/* OS specific include */
23#include <rte_os.h>
24
25#ifdef __cplusplus
26extern "C" {
27#endif
28
29#ifndef RTE_TOOLCHAIN_MSVC
30#ifndef typeof
31#define typeof __typeof__
32#endif
33#endif
34
35#ifndef __cplusplus
36#ifndef asm
37#define asm __asm__
38#endif
39#endif
40
41#ifdef RTE_TOOLCHAIN_MSVC
42#ifdef __cplusplus
43#define __extension__
44#endif
45#endif
46
47#ifdef RTE_TOOLCHAIN_MSVC
48#define __rte_constant(e) 0
49#else
50#define __rte_constant(e) __extension__(__builtin_constant_p(e))
51#endif
52
53/*
54 * RTE_TOOLCHAIN_GCC is defined if the target is built with GCC,
55 * while a host application (like pmdinfogen) may have another compiler.
56 * RTE_CC_IS_GNU is true if the file is compiled with GCC,
57 * no matter it is a target or host application.
58 */
59#define RTE_CC_IS_GNU 0
60#if defined __clang__
61#define RTE_CC_CLANG
62#elif defined __GNUC__
63#define RTE_CC_GCC
64#undef RTE_CC_IS_GNU
65#define RTE_CC_IS_GNU 1
66#endif
67#if RTE_CC_IS_GNU
68#define GCC_VERSION (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + \
69 __GNUC_PATCHLEVEL__)
70#endif
71
84#ifdef RTE_TOOLCHAIN_MSVC
85#define __rte_aligned(a) __declspec(align(a))
86#else
87#define __rte_aligned(a) __attribute__((__aligned__(a)))
88#endif
89
90#ifdef RTE_ARCH_STRICT_ALIGN
91typedef uint64_t unaligned_uint64_t __rte_aligned(1);
92typedef uint32_t unaligned_uint32_t __rte_aligned(1);
93typedef uint16_t unaligned_uint16_t __rte_aligned(1);
94#else
95typedef uint64_t unaligned_uint64_t;
96typedef uint32_t unaligned_uint32_t;
97typedef uint16_t unaligned_uint16_t;
98#endif
99
107#ifdef RTE_TOOLCHAIN_MSVC
108#define __rte_packed RTE_DEPRECATED(__rte_packed)
109#else
110#define __rte_packed (RTE_DEPRECATED(__rte_packed) __attribute__((__packed__)))
111#endif
112
120#ifdef RTE_TOOLCHAIN_MSVC
121#define __rte_packed_begin __pragma(pack(push, 1))
122#define __rte_packed_end __pragma(pack(pop))
123#else
124#define __rte_packed_begin
125#define __rte_packed_end __attribute__((__packed__))
126#endif
127
131#ifdef RTE_TOOLCHAIN_MSVC
132#define __rte_may_alias
133#else
134#define __rte_may_alias __attribute__((__may_alias__))
135#endif
136
137/******* Macro to mark functions and fields scheduled for removal *****/
138#ifdef RTE_TOOLCHAIN_MSVC
139#define __rte_deprecated
140#define __rte_deprecated_msg(msg)
141#else
142#define __rte_deprecated __attribute__((__deprecated__))
143#define __rte_deprecated_msg(msg) __attribute__((__deprecated__(msg)))
144#endif
145
149#if defined(RTE_CC_GCC) || defined(RTE_CC_CLANG)
150#define RTE_PRAGMA(x) _Pragma(#x)
151#define RTE_PRAGMA_WARNING(w) RTE_PRAGMA(GCC warning #w)
152#define RTE_DEPRECATED(x) RTE_PRAGMA_WARNING(#x is deprecated)
153#else
154#define RTE_DEPRECATED(x)
155#endif
156
161#if !defined(RTE_TOOLCHAIN_MSVC)
162#define __rte_diagnostic_push _Pragma("GCC diagnostic push")
163#define __rte_diagnostic_pop _Pragma("GCC diagnostic pop")
164#else
165#define __rte_diagnostic_push
166#define __rte_diagnostic_pop
167#endif
168
173#if !defined(RTE_TOOLCHAIN_MSVC)
174#define __rte_diagnostic_ignored_wcast_qual _Pragma("GCC diagnostic ignored \"-Wcast-qual\"")
175#else
176#define __rte_diagnostic_ignored_wcast_qual
177#endif
178
182#ifdef RTE_TOOLCHAIN_MSVC
183#define __rte_weak RTE_DEPRECATED(__rte_weak)
184#else
185#define __rte_weak RTE_DEPRECATED(__rte_weak) __attribute__((__weak__))
186#endif
187
191#ifdef RTE_TOOLCHAIN_MSVC
192#define __rte_pure
193#else
194#define __rte_pure __attribute__((pure))
195#endif
196
200#ifdef RTE_TOOLCHAIN_MSVC
201#define __rte_used
202#else
203#define __rte_used __attribute__((used))
204#endif
205
206/*********** Macros to eliminate unused variable warnings ********/
207
211#ifdef RTE_TOOLCHAIN_MSVC
212#define __rte_unused
213#else
214#define __rte_unused __attribute__((__unused__))
215#endif
216
220#if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 199901L
221#define __rte_restrict __restrict
222#else
223#define __rte_restrict restrict
224#endif
225
230#define RTE_SET_USED(x) (void)(x)
231
239#ifdef RTE_TOOLCHAIN_MSVC
240#define __rte_format_printf(format_index, first_arg)
241#else
242#if RTE_CC_IS_GNU
243#define __rte_format_printf(format_index, first_arg) \
244 __attribute__((format(gnu_printf, format_index, first_arg)))
245#else
246#define __rte_format_printf(format_index, first_arg) \
247 __attribute__((format(printf, format_index, first_arg)))
248#endif
249#endif
250
254#ifdef RTE_TOOLCHAIN_MSVC
255#define __rte_section(name) \
256 __pragma(data_seg(name)) __declspec(allocate(name))
257#else
258#define __rte_section(name) \
259 __attribute__((section(name)))
260#endif
261
267#if defined(RTE_CC_GCC) || defined(RTE_CC_CLANG)
268#define __rte_alloc_size(...) \
269 __attribute__((alloc_size(__VA_ARGS__)))
270#else
271#define __rte_alloc_size(...)
272#endif
273
280#if defined(RTE_CC_GCC)
281#define __rte_alloc_align(argno) \
282 __attribute__((alloc_align(argno)))
283#else
284#define __rte_alloc_align(argno)
285#endif
286
291#if defined(RTE_CC_GCC) || defined(RTE_CC_CLANG)
292#define __rte_malloc __attribute__((__malloc__))
293#else
294#define __rte_malloc
295#endif
296
301#if defined(RTE_TOOLCHAIN_GCC) && (GCC_VERSION >= 110000)
302#define __rte_dealloc(dealloc, argno) \
303 __attribute__((malloc(dealloc, argno)))
304#else
305#define __rte_dealloc(dealloc, argno)
306#endif
307
308#define RTE_PRIORITY_LOG 101
309#define RTE_PRIORITY_BUS 110
310#define RTE_PRIORITY_CLASS 120
311#define RTE_PRIORITY_LAST 65535
312
313#define RTE_PRIO(prio) \
314 RTE_PRIORITY_ ## prio
315
325#ifndef RTE_INIT_PRIO /* Allow to override from EAL */
326#ifndef RTE_TOOLCHAIN_MSVC
327#define RTE_INIT_PRIO(func, prio) \
328static void __attribute__((constructor(RTE_PRIO(prio)), used)) func(void)
329#else
330/* definition from the Microsoft CRT */
331typedef int(__cdecl *_PIFV)(void);
332
333#define CTOR_SECTION_LOG ".CRT$XIB"
334#define CTOR_SECTION_BUS ".CRT$XIC"
335#define CTOR_SECTION_CLASS ".CRT$XID"
336#define CTOR_SECTION_LAST ".CRT$XIY"
337
338#define CTOR_PRIORITY_TO_SECTION(priority) CTOR_SECTION_ ## priority
339
340#define RTE_INIT_PRIO(name, priority) \
341 static void name(void); \
342 static int __cdecl name ## _thunk(void) { name(); return 0; } \
343 __pragma(const_seg(CTOR_PRIORITY_TO_SECTION(priority))) \
344 __declspec(allocate(CTOR_PRIORITY_TO_SECTION(priority))) \
345 _PIFV name ## _pointer = &name ## _thunk; \
346 __pragma(const_seg()) \
347 static void name(void)
348#endif
349#endif
350
359#define RTE_INIT(func) \
360 RTE_INIT_PRIO(func, LAST)
361
371#ifndef RTE_FINI_PRIO /* Allow to override from EAL */
372#ifndef RTE_TOOLCHAIN_MSVC
373#define RTE_FINI_PRIO(func, prio) \
374static void __attribute__((destructor(RTE_PRIO(prio)), used)) func(void)
375#else
376#define DTOR_SECTION_LOG "mydtor$B"
377#define DTOR_SECTION_BUS "mydtor$C"
378#define DTOR_SECTION_CLASS "mydtor$D"
379#define DTOR_SECTION_LAST "mydtor$Y"
380
381#define DTOR_PRIORITY_TO_SECTION(priority) DTOR_SECTION_ ## priority
382
383#define RTE_FINI_PRIO(name, priority) \
384 static void name(void); \
385 __pragma(const_seg(DTOR_PRIORITY_TO_SECTION(priority))) \
386 __declspec(allocate(DTOR_PRIORITY_TO_SECTION(priority))) void *name ## _pointer = &name; \
387 __pragma(const_seg()) \
388 static void name(void)
389#endif
390#endif
391
400#define RTE_FINI(func) \
401 RTE_FINI_PRIO(func, LAST)
402
406#ifdef RTE_TOOLCHAIN_MSVC
407#define __rte_noreturn
408#else
409#define __rte_noreturn __attribute__((noreturn))
410#endif
411
415#if defined(RTE_TOOLCHAIN_GCC) || defined(RTE_TOOLCHAIN_CLANG)
416#define __rte_unreachable() __extension__(__builtin_unreachable())
417#else
418#define __rte_unreachable() __assume(0)
419#endif
420
444#ifdef RTE_TOOLCHAIN_MSVC
445#define __rte_warn_unused_result
446#else
447#define __rte_warn_unused_result __attribute__((warn_unused_result))
448#endif
449
453#ifdef RTE_TOOLCHAIN_MSVC
454#define __rte_always_inline __forceinline
455#else
456#define __rte_always_inline inline __attribute__((always_inline))
457#endif
458
462#ifdef RTE_TOOLCHAIN_MSVC
463#define __rte_noinline __declspec(noinline)
464#else
465#define __rte_noinline __attribute__((noinline))
466#endif
467
471#ifdef RTE_TOOLCHAIN_MSVC
472#define __rte_hot
473#else
474#define __rte_hot __attribute__((hot))
475#endif
476
480#ifdef RTE_TOOLCHAIN_MSVC
481#define __rte_cold
482#else
483#define __rte_cold __attribute__((cold))
484#endif
485
492#if defined(RTE_TOOLCHAIN_GCC) && (GCC_VERSION >= 130000)
493#define __rte_assume(condition) __attribute__((assume(condition)))
494#elif defined(RTE_TOOLCHAIN_GCC)
495#define __rte_assume(condition) do { if (!(condition)) __rte_unreachable(); } while (0)
496#elif defined(RTE_TOOLCHAIN_CLANG)
497#define __rte_assume(condition) __extension__(__builtin_assume(condition))
498#else
499#define __rte_assume(condition) __assume(condition)
500#endif
501
505#ifdef RTE_MALLOC_ASAN
506#ifdef RTE_CC_CLANG
507#define __rte_no_asan __attribute__((no_sanitize("address", "hwaddress")))
508#else
509#define __rte_no_asan __attribute__((no_sanitize_address))
510#endif
511#else /* ! RTE_MALLOC_ASAN */
512#define __rte_no_asan
513#endif
514
515/*********** Macros for pointer arithmetic ********/
516
520#define RTE_PTR_ADD(ptr, x) ((void*)((uintptr_t)(ptr) + (x)))
521
525#define RTE_PTR_SUB(ptr, x) ((void *)((uintptr_t)(ptr) - (x)))
526
532#define RTE_PTR_DIFF(ptr1, ptr2) ((uintptr_t)(ptr1) - (uintptr_t)(ptr2))
533
534/*********** Macros for casting pointers ********/
535
540#define RTE_PTR_UNQUAL(X) ((void *)(uintptr_t)(X))
541
559#define RTE_CAST_PTR(type, ptr) ((type)(uintptr_t)(ptr))
560
564#define RTE_CAST_FIELD(var, field, type) \
565 (*(type *)((uintptr_t)(var) + offsetof(typeof(*(var)), field)))
566
567/*********** Macros/static functions for doing alignment ********/
568
569
576#define RTE_PTR_ALIGN_FLOOR(ptr, align) \
577 ((typeof(ptr))RTE_ALIGN_FLOOR((uintptr_t)(ptr), align))
578
585#define RTE_ALIGN_FLOOR(val, align) \
586 (typeof(val))((val) & (~((typeof(val))((align) - 1))))
587
594#define RTE_PTR_ALIGN_CEIL(ptr, align) \
595 RTE_PTR_ALIGN_FLOOR((typeof(ptr))RTE_PTR_ADD(ptr, (align) - 1), align)
596
603#define RTE_ALIGN_CEIL(val, align) \
604 RTE_ALIGN_FLOOR(((val) + ((typeof(val)) (align) - 1)), align)
605
613#define RTE_PTR_ALIGN(ptr, align) RTE_PTR_ALIGN_CEIL(ptr, align)
614
622#define RTE_ALIGN(val, align) RTE_ALIGN_CEIL(val, align)
623
629#define RTE_ALIGN_MUL_CEIL(v, mul) \
630 ((((v) + (typeof(v))(mul) - 1) / ((typeof(v))(mul))) * (typeof(v))(mul))
631
637#define RTE_ALIGN_MUL_FLOOR(v, mul) \
638 (((v) / ((typeof(v))(mul))) * (typeof(v))(mul))
639
645#define RTE_ALIGN_MUL_NEAR(v, mul) \
646 __extension__ ({ \
647 typeof(v) ceil = RTE_ALIGN_MUL_CEIL(v, mul); \
648 typeof(v) floor = RTE_ALIGN_MUL_FLOOR(v, mul); \
649 (ceil - (v)) > ((v) - floor) ? floor : ceil; \
650 })
651
663static inline int
664rte_is_aligned(const void * const __rte_restrict ptr, const unsigned int align)
665{
666 return ((uintptr_t)ptr & (align - 1)) == 0;
667}
668
669/*********** Macros for compile type checks ********/
670
671/* Workaround for toolchain issues with missing C11 macro in FreeBSD */
672#if !defined(static_assert) && !defined(__cplusplus)
673#define static_assert _Static_assert
674#endif
675
682#define RTE_BUILD_BUG_ON(condition) do { static_assert(!(condition), #condition); } while (0)
683
684/*********** Cache line related macros ********/
685
687#define RTE_CACHE_LINE_MASK (RTE_CACHE_LINE_SIZE-1)
688
690#define RTE_CACHE_LINE_ROUNDUP(size) RTE_ALIGN_CEIL(size, RTE_CACHE_LINE_SIZE)
691
693#if RTE_CACHE_LINE_SIZE == 64
694#define RTE_CACHE_LINE_SIZE_LOG2 6
695#elif RTE_CACHE_LINE_SIZE == 128
696#define RTE_CACHE_LINE_SIZE_LOG2 7
697#else
698#error "Unsupported cache line size"
699#endif
700
702#define RTE_CACHE_LINE_MIN_SIZE 64
703
705#define __rte_cache_aligned __rte_aligned(RTE_CACHE_LINE_SIZE)
706
708#define __rte_cache_min_aligned __rte_aligned(RTE_CACHE_LINE_MIN_SIZE)
709
710#define _RTE_CACHE_GUARD_HELPER2(unique) \
711 alignas(RTE_CACHE_LINE_SIZE) \
712 char cache_guard_ ## unique[RTE_CACHE_LINE_SIZE * RTE_CACHE_GUARD_LINES]
713#define _RTE_CACHE_GUARD_HELPER1(unique) _RTE_CACHE_GUARD_HELPER2(unique)
721#define RTE_CACHE_GUARD _RTE_CACHE_GUARD_HELPER1(__COUNTER__)
722
723/*********** PA/IOVA type definitions ********/
724
726typedef uint64_t phys_addr_t;
727#define RTE_BAD_PHYS_ADDR ((phys_addr_t)-1)
728
736typedef uint64_t rte_iova_t;
737#define RTE_BAD_IOVA ((rte_iova_t)-1)
738
739/*********** Structure alignment markers ********/
740
741#ifndef RTE_TOOLCHAIN_MSVC
742
744__extension__ typedef void *RTE_MARKER[0];
746__extension__ typedef uint8_t RTE_MARKER8[0];
748__extension__ typedef uint16_t RTE_MARKER16[0];
750__extension__ typedef uint32_t RTE_MARKER32[0];
752__extension__ typedef uint64_t RTE_MARKER64[0];
753
754#endif
755
756/*********** Macros for calculating min and max **********/
757
761#define RTE_MIN(a, b) \
762 __extension__ ({ \
763 typeof (a) _a = (a); \
764 typeof (b) _b = (b); \
765 _a < _b ? _a : _b; \
766 })
767
775#define RTE_MIN_T(a, b, t) \
776 ((t)(a) < (t)(b) ? (t)(a) : (t)(b))
777
781#define RTE_MAX(a, b) \
782 __extension__ ({ \
783 typeof (a) _a = (a); \
784 typeof (b) _b = (b); \
785 _a > _b ? _a : _b; \
786 })
787
795#define RTE_MAX_T(a, b, t) \
796 ((t)(a) > (t)(b) ? (t)(a) : (t)(b))
797
798/*********** Other general functions / macros ********/
799
800#ifndef offsetof
802#define offsetof(TYPE, MEMBER) __builtin_offsetof (TYPE, MEMBER)
803#endif
804
819#ifndef container_of
820#ifdef RTE_TOOLCHAIN_MSVC
821#define container_of(ptr, type, member) \
822 ((type *)((uintptr_t)(ptr) - offsetof(type, member)))
823#else
824#define container_of(ptr, type, member) __extension__ ({ \
825 const typeof(((type *)0)->member) *_ptr = (ptr); \
826 __rte_unused type *_target_ptr = \
827 (type *)(ptr); \
828 (type *)(((uintptr_t)_ptr) - offsetof(type, member)); \
829 })
830#endif
831#endif
832
834#define RTE_SWAP(a, b) \
835 __extension__ ({ \
836 typeof (a) _a = a; \
837 a = b; \
838 b = _a; \
839 })
840
851#define RTE_SIZEOF_FIELD(type, field) (sizeof(((type *)0)->field))
852
853#define _RTE_STR(x) #x
855#define RTE_STR(x) _RTE_STR(x)
856
862#define RTE_FMT(fmt, ...) fmt "%.0s", __VA_ARGS__ ""
863#define RTE_FMT_HEAD(fmt, ...) fmt
864#define RTE_FMT_TAIL(fmt, ...) __VA_ARGS__
865
867#define RTE_LEN2MASK(ln, tp) \
868 ((tp)((uint64_t)-1 >> (sizeof(uint64_t) * CHAR_BIT - (ln))))
869
871#define RTE_DIM(a) (sizeof (a) / sizeof ((a)[0]))
872
887uint64_t
888rte_str_to_size(const char *str);
889
904rte_exit(int exit_code, const char *format, ...)
906
907#ifdef __cplusplus
908}
909#endif
910
911#endif
uint64_t rte_str_to_size(const char *str)
__extension__ typedef uint64_t RTE_MARKER64[0]
Definition: rte_common.h:752
__extension__ typedef uint8_t RTE_MARKER8[0]
Definition: rte_common.h:746
__extension__ typedef uint32_t RTE_MARKER32[0]
Definition: rte_common.h:750
__extension__ typedef uint16_t RTE_MARKER16[0]
Definition: rte_common.h:748
#define __rte_format_printf(format_index, first_arg)
Definition: rte_common.h:246
uint64_t rte_iova_t
Definition: rte_common.h:736
#define __rte_aligned(a)
Definition: rte_common.h:87
static int rte_is_aligned(const void *const __rte_restrict ptr, const unsigned int align)
Definition: rte_common.h:664
__rte_noreturn void rte_exit(int exit_code, const char *format,...) __rte_format_printf(2
#define __rte_noreturn
Definition: rte_common.h:409
uint64_t phys_addr_t
Definition: rte_common.h:726
__extension__ typedef void * RTE_MARKER[0]
Definition: rte_common.h:744
#define __rte_restrict
Definition: rte_common.h:221