DPDK  24.11.0-rc1
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
26 extern "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 __INTEL_COMPILER
63 #define RTE_CC_ICC
64 #elif defined __GNUC__
65 #define RTE_CC_GCC
66 #undef RTE_CC_IS_GNU
67 #define RTE_CC_IS_GNU 1
68 #endif
69 #if RTE_CC_IS_GNU
70 #define GCC_VERSION (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + \
71  __GNUC_PATCHLEVEL__)
72 #endif
73 
86 #ifdef RTE_TOOLCHAIN_MSVC
87 #define __rte_aligned(a) __declspec(align(a))
88 #else
89 #define __rte_aligned(a) __attribute__((__aligned__(a)))
90 #endif
91 
92 #ifdef RTE_ARCH_STRICT_ALIGN
93 typedef uint64_t unaligned_uint64_t __rte_aligned(1);
94 typedef uint32_t unaligned_uint32_t __rte_aligned(1);
95 typedef uint16_t unaligned_uint16_t __rte_aligned(1);
96 #else
97 typedef uint64_t unaligned_uint64_t;
98 typedef uint32_t unaligned_uint32_t;
99 typedef uint16_t unaligned_uint16_t;
100 #endif
101 
105 #ifdef RTE_TOOLCHAIN_MSVC
106 #define __rte_packed
107 #else
108 #define __rte_packed __attribute__((__packed__))
109 #endif
110 
114 #ifdef RTE_TOOLCHAIN_MSVC
115 #define __rte_may_alias
116 #else
117 #define __rte_may_alias __attribute__((__may_alias__))
118 #endif
119 
120 /******* Macro to mark functions and fields scheduled for removal *****/
121 #ifdef RTE_TOOLCHAIN_MSVC
122 #define __rte_deprecated
123 #define __rte_deprecated_msg(msg)
124 #else
125 #define __rte_deprecated __attribute__((__deprecated__))
126 #define __rte_deprecated_msg(msg) __attribute__((__deprecated__(msg)))
127 #endif
128 
132 #if defined(RTE_CC_GCC) || defined(RTE_CC_CLANG)
133 #define RTE_PRAGMA(x) _Pragma(#x)
134 #define RTE_PRAGMA_WARNING(w) RTE_PRAGMA(GCC warning #w)
135 #define RTE_DEPRECATED(x) RTE_PRAGMA_WARNING(#x is deprecated)
136 #else
137 #define RTE_DEPRECATED(x)
138 #endif
139 
143 #define __rte_weak __attribute__((__weak__))
144 
148 #ifdef RTE_TOOLCHAIN_MSVC
149 #define __rte_pure
150 #else
151 #define __rte_pure __attribute__((pure))
152 #endif
153 
157 #ifdef RTE_TOOLCHAIN_MSVC
158 #define __rte_used
159 #else
160 #define __rte_used __attribute__((used))
161 #endif
162 
163 /*********** Macros to eliminate unused variable warnings ********/
164 
168 #ifdef RTE_TOOLCHAIN_MSVC
169 #define __rte_unused
170 #else
171 #define __rte_unused __attribute__((__unused__))
172 #endif
173 
177 #if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 199901L
178 #define __rte_restrict __restrict
179 #else
180 #define __rte_restrict restrict
181 #endif
182 
187 #define RTE_SET_USED(x) (void)(x)
188 
196 #ifdef RTE_TOOLCHAIN_MSVC
197 #define __rte_format_printf(format_index, first_arg)
198 #else
199 #if RTE_CC_IS_GNU
200 #define __rte_format_printf(format_index, first_arg) \
201  __attribute__((format(gnu_printf, format_index, first_arg)))
202 #else
203 #define __rte_format_printf(format_index, first_arg) \
204  __attribute__((format(printf, format_index, first_arg)))
205 #endif
206 #endif
207 
211 #ifdef RTE_TOOLCHAIN_MSVC
212 #define __rte_section(name) \
213  __pragma(data_seg(name)) __declspec(allocate(name))
214 #else
215 #define __rte_section(name) \
216  __attribute__((section(name)))
217 #endif
218 
224 #if defined(RTE_CC_GCC) || defined(RTE_CC_CLANG)
225 #define __rte_alloc_size(...) \
226  __attribute__((alloc_size(__VA_ARGS__)))
227 #else
228 #define __rte_alloc_size(...)
229 #endif
230 
237 #if defined(RTE_CC_GCC)
238 #define __rte_alloc_align(argno) \
239  __attribute__((alloc_align(argno)))
240 #else
241 #define __rte_alloc_align(argno)
242 #endif
243 
248 #if defined(RTE_CC_GCC) || defined(RTE_CC_CLANG)
249 #define __rte_malloc __attribute__((__malloc__))
250 #else
251 #define __rte_malloc
252 #endif
253 
258 #if defined(RTE_TOOLCHAIN_GCC) && (GCC_VERSION >= 110000)
259 #define __rte_dealloc(dealloc, argno) \
260  __attribute__((malloc(dealloc, argno)))
261 #else
262 #define __rte_dealloc(dealloc, argno)
263 #endif
264 
265 #define RTE_PRIORITY_LOG 101
266 #define RTE_PRIORITY_BUS 110
267 #define RTE_PRIORITY_CLASS 120
268 #define RTE_PRIORITY_LAST 65535
269 
270 #define RTE_PRIO(prio) \
271  RTE_PRIORITY_ ## prio
272 
282 #ifndef RTE_INIT_PRIO /* Allow to override from EAL */
283 #ifndef RTE_TOOLCHAIN_MSVC
284 #define RTE_INIT_PRIO(func, prio) \
285 static void __attribute__((constructor(RTE_PRIO(prio)), used)) func(void)
286 #else
287 /* definition from the Microsoft CRT */
288 typedef int(__cdecl *_PIFV)(void);
289 
290 #define CTOR_SECTION_LOG ".CRT$XIB"
291 #define CTOR_SECTION_BUS ".CRT$XIC"
292 #define CTOR_SECTION_CLASS ".CRT$XID"
293 #define CTOR_SECTION_LAST ".CRT$XIY"
294 
295 #define CTOR_PRIORITY_TO_SECTION(priority) CTOR_SECTION_ ## priority
296 
297 #define RTE_INIT_PRIO(name, priority) \
298  static void name(void); \
299  static int __cdecl name ## _thunk(void) { name(); return 0; } \
300  __pragma(const_seg(CTOR_PRIORITY_TO_SECTION(priority))) \
301  __declspec(allocate(CTOR_PRIORITY_TO_SECTION(priority))) \
302  _PIFV name ## _pointer = &name ## _thunk; \
303  __pragma(const_seg()) \
304  static void name(void)
305 #endif
306 #endif
307 
316 #define RTE_INIT(func) \
317  RTE_INIT_PRIO(func, LAST)
318 
328 #ifndef RTE_FINI_PRIO /* Allow to override from EAL */
329 #ifndef RTE_TOOLCHAIN_MSVC
330 #define RTE_FINI_PRIO(func, prio) \
331 static void __attribute__((destructor(RTE_PRIO(prio)), used)) func(void)
332 #else
333 #define DTOR_SECTION_LOG "mydtor$B"
334 #define DTOR_SECTION_BUS "mydtor$C"
335 #define DTOR_SECTION_CLASS "mydtor$D"
336 #define DTOR_SECTION_LAST "mydtor$Y"
337 
338 #define DTOR_PRIORITY_TO_SECTION(priority) DTOR_SECTION_ ## priority
339 
340 #define RTE_FINI_PRIO(name, priority) \
341  static void name(void); \
342  __pragma(const_seg(DTOR_PRIORITY_TO_SECTION(priority))) \
343  __declspec(allocate(DTOR_PRIORITY_TO_SECTION(priority))) void *name ## _pointer = &name; \
344  __pragma(const_seg()) \
345  static void name(void)
346 #endif
347 #endif
348 
357 #define RTE_FINI(func) \
358  RTE_FINI_PRIO(func, LAST)
359 
363 #ifdef RTE_TOOLCHAIN_MSVC
364 #define __rte_noreturn
365 #else
366 #define __rte_noreturn __attribute__((noreturn))
367 #endif
368 
392 #ifdef RTE_TOOLCHAIN_MSVC
393 #define __rte_warn_unused_result
394 #else
395 #define __rte_warn_unused_result __attribute__((warn_unused_result))
396 #endif
397 
401 #ifdef RTE_TOOLCHAIN_MSVC
402 #define __rte_always_inline
403 #else
404 #define __rte_always_inline inline __attribute__((always_inline))
405 #endif
406 
410 #define __rte_noinline __attribute__((noinline))
411 
415 #define __rte_hot __attribute__((hot))
416 
420 #ifdef RTE_TOOLCHAIN_MSVC
421 #define __rte_cold
422 #else
423 #define __rte_cold __attribute__((cold))
424 #endif
425 
429 #ifdef RTE_MALLOC_ASAN
430 #ifdef RTE_CC_CLANG
431 #define __rte_no_asan __attribute__((no_sanitize("address", "hwaddress")))
432 #else
433 #define __rte_no_asan __attribute__((no_sanitize_address))
434 #endif
435 #else /* ! RTE_MALLOC_ASAN */
436 #define __rte_no_asan
437 #endif
438 
439 /*********** Macros for pointer arithmetic ********/
440 
444 #define RTE_PTR_ADD(ptr, x) ((void*)((uintptr_t)(ptr) + (x)))
445 
449 #define RTE_PTR_SUB(ptr, x) ((void *)((uintptr_t)(ptr) - (x)))
450 
456 #define RTE_PTR_DIFF(ptr1, ptr2) ((uintptr_t)(ptr1) - (uintptr_t)(ptr2))
457 
461 #define RTE_CAST_FIELD(var, field, type) \
462  (*(type *)((uintptr_t)(var) + offsetof(typeof(*(var)), field)))
463 
464 /*********** Macros/static functions for doing alignment ********/
465 
466 
473 #define RTE_PTR_ALIGN_FLOOR(ptr, align) \
474  ((typeof(ptr))RTE_ALIGN_FLOOR((uintptr_t)(ptr), align))
475 
482 #define RTE_ALIGN_FLOOR(val, align) \
483  (typeof(val))((val) & (~((typeof(val))((align) - 1))))
484 
491 #define RTE_PTR_ALIGN_CEIL(ptr, align) \
492  RTE_PTR_ALIGN_FLOOR((typeof(ptr))RTE_PTR_ADD(ptr, (align) - 1), align)
493 
500 #define RTE_ALIGN_CEIL(val, align) \
501  RTE_ALIGN_FLOOR(((val) + ((typeof(val)) (align) - 1)), align)
502 
510 #define RTE_PTR_ALIGN(ptr, align) RTE_PTR_ALIGN_CEIL(ptr, align)
511 
519 #define RTE_ALIGN(val, align) RTE_ALIGN_CEIL(val, align)
520 
526 #define RTE_ALIGN_MUL_CEIL(v, mul) \
527  ((((v) + (typeof(v))(mul) - 1) / ((typeof(v))(mul))) * (typeof(v))(mul))
528 
534 #define RTE_ALIGN_MUL_FLOOR(v, mul) \
535  (((v) / ((typeof(v))(mul))) * (typeof(v))(mul))
536 
542 #define RTE_ALIGN_MUL_NEAR(v, mul) \
543  __extension__ ({ \
544  typeof(v) ceil = RTE_ALIGN_MUL_CEIL(v, mul); \
545  typeof(v) floor = RTE_ALIGN_MUL_FLOOR(v, mul); \
546  (ceil - (v)) > ((v) - floor) ? floor : ceil; \
547  })
548 
560 static inline int
561 rte_is_aligned(const void * const __rte_restrict ptr, const unsigned int align)
562 {
563  return ((uintptr_t)ptr & (align - 1)) == 0;
564 }
565 
566 /*********** Macros for compile type checks ********/
567 
568 /* Workaround for toolchain issues with missing C11 macro in FreeBSD */
569 #if !defined(static_assert) && !defined(__cplusplus)
570 #define static_assert _Static_assert
571 #endif
572 
579 #define RTE_BUILD_BUG_ON(condition) do { static_assert(!(condition), #condition); } while (0)
580 
581 /*********** Cache line related macros ********/
582 
584 #define RTE_CACHE_LINE_MASK (RTE_CACHE_LINE_SIZE-1)
585 
587 #define RTE_CACHE_LINE_ROUNDUP(size) RTE_ALIGN_CEIL(size, RTE_CACHE_LINE_SIZE)
588 
590 #if RTE_CACHE_LINE_SIZE == 64
591 #define RTE_CACHE_LINE_SIZE_LOG2 6
592 #elif RTE_CACHE_LINE_SIZE == 128
593 #define RTE_CACHE_LINE_SIZE_LOG2 7
594 #else
595 #error "Unsupported cache line size"
596 #endif
597 
599 #define RTE_CACHE_LINE_MIN_SIZE 64
600 
602 #define __rte_cache_aligned __rte_aligned(RTE_CACHE_LINE_SIZE)
603 
605 #define __rte_cache_min_aligned __rte_aligned(RTE_CACHE_LINE_MIN_SIZE)
606 
607 #define _RTE_CACHE_GUARD_HELPER2(unique) \
608  alignas(RTE_CACHE_LINE_SIZE) \
609  char cache_guard_ ## unique[RTE_CACHE_LINE_SIZE * RTE_CACHE_GUARD_LINES]
610 #define _RTE_CACHE_GUARD_HELPER1(unique) _RTE_CACHE_GUARD_HELPER2(unique)
611 
618 #define RTE_CACHE_GUARD _RTE_CACHE_GUARD_HELPER1(__COUNTER__)
619 
620 /*********** PA/IOVA type definitions ********/
621 
623 typedef uint64_t phys_addr_t;
624 #define RTE_BAD_PHYS_ADDR ((phys_addr_t)-1)
625 
633 typedef uint64_t rte_iova_t;
634 #define RTE_BAD_IOVA ((rte_iova_t)-1)
635 
636 /*********** Structure alignment markers ********/
637 
638 #ifndef RTE_TOOLCHAIN_MSVC
639 
641 __extension__ typedef void *RTE_MARKER[0];
643 __extension__ typedef uint8_t RTE_MARKER8[0];
645 __extension__ typedef uint16_t RTE_MARKER16[0];
647 __extension__ typedef uint32_t RTE_MARKER32[0];
649 __extension__ typedef uint64_t RTE_MARKER64[0];
650 
651 #endif
652 
653 /*********** Macros for calculating min and max **********/
654 
658 #define RTE_MIN(a, b) \
659  __extension__ ({ \
660  typeof (a) _a = (a); \
661  typeof (b) _b = (b); \
662  _a < _b ? _a : _b; \
663  })
664 
672 #define RTE_MIN_T(a, b, t) \
673  ((t)(a) < (t)(b) ? (t)(a) : (t)(b))
674 
678 #define RTE_MAX(a, b) \
679  __extension__ ({ \
680  typeof (a) _a = (a); \
681  typeof (b) _b = (b); \
682  _a > _b ? _a : _b; \
683  })
684 
692 #define RTE_MAX_T(a, b, t) \
693  ((t)(a) > (t)(b) ? (t)(a) : (t)(b))
694 
695 /*********** Other general functions / macros ********/
696 
697 #ifndef offsetof
698 
699 #define offsetof(TYPE, MEMBER) __builtin_offsetof (TYPE, MEMBER)
700 #endif
701 
716 #ifndef container_of
717 #ifdef RTE_TOOLCHAIN_MSVC
718 #define container_of(ptr, type, member) \
719  ((type *)((uintptr_t)(ptr) - offsetof(type, member)))
720 #else
721 #define container_of(ptr, type, member) __extension__ ({ \
722  const typeof(((type *)0)->member) *_ptr = (ptr); \
723  __rte_unused type *_target_ptr = \
724  (type *)(ptr); \
725  (type *)(((uintptr_t)_ptr) - offsetof(type, member)); \
726  })
727 #endif
728 #endif
729 
731 #define RTE_SWAP(a, b) \
732  __extension__ ({ \
733  typeof (a) _a = a; \
734  a = b; \
735  b = _a; \
736  })
737 
748 #define RTE_SIZEOF_FIELD(type, field) (sizeof(((type *)0)->field))
749 
750 #define _RTE_STR(x) #x
751 
752 #define RTE_STR(x) _RTE_STR(x)
753 
759 #define RTE_FMT(fmt, ...) fmt "%.0s", __VA_ARGS__ ""
760 #define RTE_FMT_HEAD(fmt, ...) fmt
761 #define RTE_FMT_TAIL(fmt, ...) __VA_ARGS__
762 
764 #define RTE_LEN2MASK(ln, tp) \
765  ((tp)((uint64_t)-1 >> (sizeof(uint64_t) * CHAR_BIT - (ln))))
766 
768 #define RTE_DIM(a) (sizeof (a) / sizeof ((a)[0]))
769 
784 uint64_t
785 rte_str_to_size(const char *str);
786 
800 __rte_noreturn void
801 rte_exit(int exit_code, const char *format, ...)
802  __rte_format_printf(2, 3);
803 
804 #ifdef __cplusplus
805 }
806 #endif
807 
808 #endif
uint64_t rte_iova_t
Definition: rte_common.h:633
__extension__ typedef uint8_t RTE_MARKER8[0]
Definition: rte_common.h:643
__extension__ typedef void * RTE_MARKER[0]
Definition: rte_common.h:641
#define __rte_restrict
Definition: rte_common.h:178
uint64_t phys_addr_t
Definition: rte_common.h:623
__extension__ typedef uint64_t RTE_MARKER64[0]
Definition: rte_common.h:649
uint64_t rte_str_to_size(const char *str)
#define __rte_format_printf(format_index, first_arg)
Definition: rte_common.h:203
__extension__ typedef uint16_t RTE_MARKER16[0]
Definition: rte_common.h:645
__extension__ typedef uint32_t RTE_MARKER32[0]
Definition: rte_common.h:647
#define __rte_noreturn
Definition: rte_common.h:366
__rte_noreturn void rte_exit(int exit_code, const char *format,...) __rte_format_printf(2
static int rte_is_aligned(const void *const __rte_restrict ptr, const unsigned int align)
Definition: rte_common.h:561
#define __rte_aligned(a)
Definition: rte_common.h:89