DPDK  24.07.0
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 #ifdef __cplusplus
16 extern "C" {
17 #endif
18 
19 #include <assert.h>
20 #include <limits.h>
21 #include <stdint.h>
22 #include <stdalign.h>
23 
24 #include <rte_config.h>
25 
26 /* OS specific include */
27 #include <rte_os.h>
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 
231 #define RTE_PRIORITY_LOG 101
232 #define RTE_PRIORITY_BUS 110
233 #define RTE_PRIORITY_CLASS 120
234 #define RTE_PRIORITY_LAST 65535
235 
236 #define RTE_PRIO(prio) \
237  RTE_PRIORITY_ ## prio
238 
248 #ifndef RTE_INIT_PRIO /* Allow to override from EAL */
249 #ifndef RTE_TOOLCHAIN_MSVC
250 #define RTE_INIT_PRIO(func, prio) \
251 static void __attribute__((constructor(RTE_PRIO(prio)), used)) func(void)
252 #else
253 /* definition from the Microsoft CRT */
254 typedef int(__cdecl *_PIFV)(void);
255 
256 #define CTOR_SECTION_LOG ".CRT$XIB"
257 #define CTOR_SECTION_BUS ".CRT$XIC"
258 #define CTOR_SECTION_CLASS ".CRT$XID"
259 #define CTOR_SECTION_LAST ".CRT$XIY"
260 
261 #define CTOR_PRIORITY_TO_SECTION(priority) CTOR_SECTION_ ## priority
262 
263 #define RTE_INIT_PRIO(name, priority) \
264  static void name(void); \
265  static int __cdecl name ## _thunk(void) { name(); return 0; } \
266  __pragma(const_seg(CTOR_PRIORITY_TO_SECTION(priority))) \
267  __declspec(allocate(CTOR_PRIORITY_TO_SECTION(priority))) \
268  _PIFV name ## _pointer = &name ## _thunk; \
269  __pragma(const_seg()) \
270  static void name(void)
271 #endif
272 #endif
273 
282 #define RTE_INIT(func) \
283  RTE_INIT_PRIO(func, LAST)
284 
294 #ifndef RTE_FINI_PRIO /* Allow to override from EAL */
295 #ifndef RTE_TOOLCHAIN_MSVC
296 #define RTE_FINI_PRIO(func, prio) \
297 static void __attribute__((destructor(RTE_PRIO(prio)), used)) func(void)
298 #else
299 #define DTOR_SECTION_LOG "mydtor$B"
300 #define DTOR_SECTION_BUS "mydtor$C"
301 #define DTOR_SECTION_CLASS "mydtor$D"
302 #define DTOR_SECTION_LAST "mydtor$Y"
303 
304 #define DTOR_PRIORITY_TO_SECTION(priority) DTOR_SECTION_ ## priority
305 
306 #define RTE_FINI_PRIO(name, priority) \
307  static void name(void); \
308  __pragma(const_seg(DTOR_PRIORITY_TO_SECTION(priority))) \
309  __declspec(allocate(DTOR_PRIORITY_TO_SECTION(priority))) void *name ## _pointer = &name; \
310  __pragma(const_seg()) \
311  static void name(void)
312 #endif
313 #endif
314 
323 #define RTE_FINI(func) \
324  RTE_FINI_PRIO(func, LAST)
325 
329 #ifdef RTE_TOOLCHAIN_MSVC
330 #define __rte_noreturn
331 #else
332 #define __rte_noreturn __attribute__((noreturn))
333 #endif
334 
358 #ifdef RTE_TOOLCHAIN_MSVC
359 #define __rte_warn_unused_result
360 #else
361 #define __rte_warn_unused_result __attribute__((warn_unused_result))
362 #endif
363 
367 #ifdef RTE_TOOLCHAIN_MSVC
368 #define __rte_always_inline
369 #else
370 #define __rte_always_inline inline __attribute__((always_inline))
371 #endif
372 
376 #define __rte_noinline __attribute__((noinline))
377 
381 #define __rte_hot __attribute__((hot))
382 
386 #ifdef RTE_TOOLCHAIN_MSVC
387 #define __rte_cold
388 #else
389 #define __rte_cold __attribute__((cold))
390 #endif
391 
395 #ifdef RTE_MALLOC_ASAN
396 #ifdef RTE_CC_CLANG
397 #define __rte_no_asan __attribute__((no_sanitize("address", "hwaddress")))
398 #else
399 #define __rte_no_asan __attribute__((no_sanitize_address))
400 #endif
401 #else /* ! RTE_MALLOC_ASAN */
402 #define __rte_no_asan
403 #endif
404 
405 /*********** Macros for pointer arithmetic ********/
406 
410 #define RTE_PTR_ADD(ptr, x) ((void*)((uintptr_t)(ptr) + (x)))
411 
415 #define RTE_PTR_SUB(ptr, x) ((void *)((uintptr_t)(ptr) - (x)))
416 
422 #define RTE_PTR_DIFF(ptr1, ptr2) ((uintptr_t)(ptr1) - (uintptr_t)(ptr2))
423 
427 #define RTE_CAST_FIELD(var, field, type) \
428  (*(type *)((uintptr_t)(var) + offsetof(typeof(*(var)), field)))
429 
430 /*********** Macros/static functions for doing alignment ********/
431 
432 
439 #define RTE_PTR_ALIGN_FLOOR(ptr, align) \
440  ((typeof(ptr))RTE_ALIGN_FLOOR((uintptr_t)(ptr), align))
441 
448 #define RTE_ALIGN_FLOOR(val, align) \
449  (typeof(val))((val) & (~((typeof(val))((align) - 1))))
450 
457 #define RTE_PTR_ALIGN_CEIL(ptr, align) \
458  RTE_PTR_ALIGN_FLOOR((typeof(ptr))RTE_PTR_ADD(ptr, (align) - 1), align)
459 
466 #define RTE_ALIGN_CEIL(val, align) \
467  RTE_ALIGN_FLOOR(((val) + ((typeof(val)) (align) - 1)), align)
468 
476 #define RTE_PTR_ALIGN(ptr, align) RTE_PTR_ALIGN_CEIL(ptr, align)
477 
485 #define RTE_ALIGN(val, align) RTE_ALIGN_CEIL(val, align)
486 
492 #define RTE_ALIGN_MUL_CEIL(v, mul) \
493  ((((v) + (typeof(v))(mul) - 1) / ((typeof(v))(mul))) * (typeof(v))(mul))
494 
500 #define RTE_ALIGN_MUL_FLOOR(v, mul) \
501  (((v) / ((typeof(v))(mul))) * (typeof(v))(mul))
502 
508 #define RTE_ALIGN_MUL_NEAR(v, mul) \
509  __extension__ ({ \
510  typeof(v) ceil = RTE_ALIGN_MUL_CEIL(v, mul); \
511  typeof(v) floor = RTE_ALIGN_MUL_FLOOR(v, mul); \
512  (ceil - (v)) > ((v) - floor) ? floor : ceil; \
513  })
514 
526 static inline int
527 rte_is_aligned(const void * const __rte_restrict ptr, const unsigned int align)
528 {
529  return ((uintptr_t)ptr & (align - 1)) == 0;
530 }
531 
532 /*********** Macros for compile type checks ********/
533 
534 /* Workaround for toolchain issues with missing C11 macro in FreeBSD */
535 #if !defined(static_assert) && !defined(__cplusplus)
536 #define static_assert _Static_assert
537 #endif
538 
545 #define RTE_BUILD_BUG_ON(condition) do { static_assert(!(condition), #condition); } while (0)
546 
547 /*********** Cache line related macros ********/
548 
550 #define RTE_CACHE_LINE_MASK (RTE_CACHE_LINE_SIZE-1)
551 
553 #define RTE_CACHE_LINE_ROUNDUP(size) RTE_ALIGN_CEIL(size, RTE_CACHE_LINE_SIZE)
554 
556 #if RTE_CACHE_LINE_SIZE == 64
557 #define RTE_CACHE_LINE_SIZE_LOG2 6
558 #elif RTE_CACHE_LINE_SIZE == 128
559 #define RTE_CACHE_LINE_SIZE_LOG2 7
560 #else
561 #error "Unsupported cache line size"
562 #endif
563 
565 #define RTE_CACHE_LINE_MIN_SIZE 64
566 
568 #define __rte_cache_aligned __rte_aligned(RTE_CACHE_LINE_SIZE)
569 
571 #define __rte_cache_min_aligned __rte_aligned(RTE_CACHE_LINE_MIN_SIZE)
572 
573 #define _RTE_CACHE_GUARD_HELPER2(unique) \
574  alignas(RTE_CACHE_LINE_SIZE) \
575  char cache_guard_ ## unique[RTE_CACHE_LINE_SIZE * RTE_CACHE_GUARD_LINES]
576 #define _RTE_CACHE_GUARD_HELPER1(unique) _RTE_CACHE_GUARD_HELPER2(unique)
577 
584 #define RTE_CACHE_GUARD _RTE_CACHE_GUARD_HELPER1(__COUNTER__)
585 
586 /*********** PA/IOVA type definitions ********/
587 
589 typedef uint64_t phys_addr_t;
590 #define RTE_BAD_PHYS_ADDR ((phys_addr_t)-1)
591 
599 typedef uint64_t rte_iova_t;
600 #define RTE_BAD_IOVA ((rte_iova_t)-1)
601 
602 /*********** Structure alignment markers ********/
603 
604 #ifndef RTE_TOOLCHAIN_MSVC
605 
607 __extension__ typedef void *RTE_MARKER[0];
609 __extension__ typedef uint8_t RTE_MARKER8[0];
611 __extension__ typedef uint16_t RTE_MARKER16[0];
613 __extension__ typedef uint32_t RTE_MARKER32[0];
615 __extension__ typedef uint64_t RTE_MARKER64[0];
616 
617 #endif
618 
619 /*********** Macros for calculating min and max **********/
620 
624 #define RTE_MIN(a, b) \
625  __extension__ ({ \
626  typeof (a) _a = (a); \
627  typeof (b) _b = (b); \
628  _a < _b ? _a : _b; \
629  })
630 
638 #define RTE_MIN_T(a, b, t) \
639  ((t)(a) < (t)(b) ? (t)(a) : (t)(b))
640 
644 #define RTE_MAX(a, b) \
645  __extension__ ({ \
646  typeof (a) _a = (a); \
647  typeof (b) _b = (b); \
648  _a > _b ? _a : _b; \
649  })
650 
658 #define RTE_MAX_T(a, b, t) \
659  ((t)(a) > (t)(b) ? (t)(a) : (t)(b))
660 
661 /*********** Other general functions / macros ********/
662 
663 #ifndef offsetof
664 
665 #define offsetof(TYPE, MEMBER) __builtin_offsetof (TYPE, MEMBER)
666 #endif
667 
682 #ifndef container_of
683 #ifdef RTE_TOOLCHAIN_MSVC
684 #define container_of(ptr, type, member) \
685  ((type *)((uintptr_t)(ptr) - offsetof(type, member)))
686 #else
687 #define container_of(ptr, type, member) __extension__ ({ \
688  const typeof(((type *)0)->member) *_ptr = (ptr); \
689  __rte_unused type *_target_ptr = \
690  (type *)(ptr); \
691  (type *)(((uintptr_t)_ptr) - offsetof(type, member)); \
692  })
693 #endif
694 #endif
695 
697 #define RTE_SWAP(a, b) \
698  __extension__ ({ \
699  typeof (a) _a = a; \
700  a = b; \
701  b = _a; \
702  })
703 
714 #define RTE_SIZEOF_FIELD(type, field) (sizeof(((type *)0)->field))
715 
716 #define _RTE_STR(x) #x
717 
718 #define RTE_STR(x) _RTE_STR(x)
719 
725 #define RTE_FMT(fmt, ...) fmt "%.0s", __VA_ARGS__ ""
726 #define RTE_FMT_HEAD(fmt, ...) fmt
727 #define RTE_FMT_TAIL(fmt, ...) __VA_ARGS__
728 
730 #define RTE_LEN2MASK(ln, tp) \
731  ((tp)((uint64_t)-1 >> (sizeof(uint64_t) * CHAR_BIT - (ln))))
732 
734 #define RTE_DIM(a) (sizeof (a) / sizeof ((a)[0]))
735 
750 uint64_t
751 rte_str_to_size(const char *str);
752 
766 __rte_noreturn void
767 rte_exit(int exit_code, const char *format, ...)
768  __rte_format_printf(2, 3);
769 
770 #ifdef __cplusplus
771 }
772 #endif
773 
774 #endif
uint64_t rte_iova_t
Definition: rte_common.h:599
__extension__ typedef uint8_t RTE_MARKER8[0]
Definition: rte_common.h:609
__extension__ typedef void * RTE_MARKER[0]
Definition: rte_common.h:607
#define __rte_restrict
Definition: rte_common.h:178
uint64_t phys_addr_t
Definition: rte_common.h:589
__extension__ typedef uint64_t RTE_MARKER64[0]
Definition: rte_common.h:615
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:611
__extension__ typedef uint32_t RTE_MARKER32[0]
Definition: rte_common.h:613
#define __rte_noreturn
Definition: rte_common.h:332
__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:527
#define __rte_aligned(a)
Definition: rte_common.h:89