DPDK  22.11.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 <stdint.h>
20 #include <limits.h>
21 
22 #include <rte_config.h>
23 
24 /* OS specific include */
25 #include <rte_os.h>
26 
27 #ifndef typeof
28 #define typeof __typeof__
29 #endif
30 
31 #ifndef __cplusplus
32 #ifndef asm
33 #define asm __asm__
34 #endif
35 #endif
36 
38 #if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 201112L
39 #define RTE_STD_C11 __extension__
40 #else
41 #define RTE_STD_C11
42 #endif
43 
44 /*
45  * RTE_TOOLCHAIN_GCC is defined if the target is built with GCC,
46  * while a host application (like pmdinfogen) may have another compiler.
47  * RTE_CC_IS_GNU is true if the file is compiled with GCC,
48  * no matter it is a target or host application.
49  */
50 #define RTE_CC_IS_GNU 0
51 #if defined __clang__
52 #define RTE_CC_CLANG
53 #elif defined __INTEL_COMPILER
54 #define RTE_CC_ICC
55 #elif defined __GNUC__
56 #define RTE_CC_GCC
57 #undef RTE_CC_IS_GNU
58 #define RTE_CC_IS_GNU 1
59 #endif
60 #if RTE_CC_IS_GNU
61 #define GCC_VERSION (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + \
62  __GNUC_PATCHLEVEL__)
63 #endif
64 
68 #define __rte_aligned(a) __attribute__((__aligned__(a)))
69 
70 #ifdef RTE_ARCH_STRICT_ALIGN
71 typedef uint64_t unaligned_uint64_t __rte_aligned(1);
72 typedef uint32_t unaligned_uint32_t __rte_aligned(1);
73 typedef uint16_t unaligned_uint16_t __rte_aligned(1);
74 #else
75 typedef uint64_t unaligned_uint64_t;
76 typedef uint32_t unaligned_uint32_t;
77 typedef uint16_t unaligned_uint16_t;
78 #endif
79 
83 #define __rte_packed __attribute__((__packed__))
84 
88 #define __rte_may_alias __attribute__((__may_alias__))
89 
90 /******* Macro to mark functions and fields scheduled for removal *****/
91 #define __rte_deprecated __attribute__((__deprecated__))
92 #define __rte_deprecated_msg(msg) __attribute__((__deprecated__(msg)))
93 
97 #if defined(RTE_CC_GCC) || defined(RTE_CC_CLANG)
98 #define RTE_PRAGMA(x) _Pragma(#x)
99 #define RTE_PRAGMA_WARNING(w) RTE_PRAGMA(GCC warning #w)
100 #define RTE_DEPRECATED(x) RTE_PRAGMA_WARNING(#x is deprecated)
101 #else
102 #define RTE_DEPRECATED(x)
103 #endif
104 
108 #define __rte_weak __attribute__((__weak__))
109 
113 #define __rte_used __attribute__((used))
114 
115 /*********** Macros to eliminate unused variable warnings ********/
116 
120 #define __rte_unused __attribute__((__unused__))
121 
125 #if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 199901L
126 #define __rte_restrict __restrict
127 #else
128 #define __rte_restrict restrict
129 #endif
130 
135 #define RTE_SET_USED(x) (void)(x)
136 
144 #if RTE_CC_IS_GNU
145 #define __rte_format_printf(format_index, first_arg) \
146  __attribute__((format(gnu_printf, format_index, first_arg)))
147 #else
148 #define __rte_format_printf(format_index, first_arg) \
149  __attribute__((format(printf, format_index, first_arg)))
150 #endif
151 
157 #if defined(RTE_CC_GCC) || defined(RTE_CC_CLANG)
158 #define __rte_alloc_size(...) \
159  __attribute__((alloc_size(__VA_ARGS__)))
160 #else
161 #define __rte_alloc_size(...)
162 #endif
163 
164 #define RTE_PRIORITY_LOG 101
165 #define RTE_PRIORITY_BUS 110
166 #define RTE_PRIORITY_CLASS 120
167 #define RTE_PRIORITY_LAST 65535
168 
169 #define RTE_PRIO(prio) \
170  RTE_PRIORITY_ ## prio
171 
181 #ifndef RTE_INIT_PRIO /* Allow to override from EAL */
182 #define RTE_INIT_PRIO(func, prio) \
183 static void __attribute__((constructor(RTE_PRIO(prio)), used)) func(void)
184 #endif
185 
194 #define RTE_INIT(func) \
195  RTE_INIT_PRIO(func, LAST)
196 
206 #ifndef RTE_FINI_PRIO /* Allow to override from EAL */
207 #define RTE_FINI_PRIO(func, prio) \
208 static void __attribute__((destructor(RTE_PRIO(prio)), used)) func(void)
209 #endif
210 
219 #define RTE_FINI(func) \
220  RTE_FINI_PRIO(func, LAST)
221 
225 #define __rte_noreturn __attribute__((noreturn))
226 
250 #define __rte_warn_unused_result __attribute__((warn_unused_result))
251 
255 #define __rte_always_inline inline __attribute__((always_inline))
256 
260 #define __rte_noinline __attribute__((noinline))
261 
265 #define __rte_hot __attribute__((hot))
266 
270 #define __rte_cold __attribute__((cold))
271 
275 #ifdef RTE_MALLOC_ASAN
276 #ifdef RTE_CC_CLANG
277 #define __rte_no_asan __attribute__((no_sanitize("address", "hwaddress")))
278 #else
279 #define __rte_no_asan __attribute__((no_sanitize_address))
280 #endif
281 #else /* ! RTE_MALLOC_ASAN */
282 #define __rte_no_asan
283 #endif
284 
285 /*********** Macros for pointer arithmetic ********/
286 
290 #define RTE_PTR_ADD(ptr, x) ((void*)((uintptr_t)(ptr) + (x)))
291 
295 #define RTE_PTR_SUB(ptr, x) ((void *)((uintptr_t)(ptr) - (x)))
296 
302 #define RTE_PTR_DIFF(ptr1, ptr2) ((uintptr_t)(ptr1) - (uintptr_t)(ptr2))
303 
307 #define RTE_CAST_FIELD(var, field, type) \
308  (*(type *)((uintptr_t)(var) + offsetof(typeof(*(var)), field)))
309 
310 /*********** Macros/static functions for doing alignment ********/
311 
312 
319 #define RTE_PTR_ALIGN_FLOOR(ptr, align) \
320  ((typeof(ptr))RTE_ALIGN_FLOOR((uintptr_t)(ptr), align))
321 
328 #define RTE_ALIGN_FLOOR(val, align) \
329  (typeof(val))((val) & (~((typeof(val))((align) - 1))))
330 
337 #define RTE_PTR_ALIGN_CEIL(ptr, align) \
338  RTE_PTR_ALIGN_FLOOR((typeof(ptr))RTE_PTR_ADD(ptr, (align) - 1), align)
339 
346 #define RTE_ALIGN_CEIL(val, align) \
347  RTE_ALIGN_FLOOR(((val) + ((typeof(val)) (align) - 1)), align)
348 
356 #define RTE_PTR_ALIGN(ptr, align) RTE_PTR_ALIGN_CEIL(ptr, align)
357 
365 #define RTE_ALIGN(val, align) RTE_ALIGN_CEIL(val, align)
366 
372 #define RTE_ALIGN_MUL_CEIL(v, mul) \
373  ((((v) + (typeof(v))(mul) - 1) / ((typeof(v))(mul))) * (typeof(v))(mul))
374 
380 #define RTE_ALIGN_MUL_FLOOR(v, mul) \
381  (((v) / ((typeof(v))(mul))) * (typeof(v))(mul))
382 
388 #define RTE_ALIGN_MUL_NEAR(v, mul) \
389  ({ \
390  typeof(v) ceil = RTE_ALIGN_MUL_CEIL(v, mul); \
391  typeof(v) floor = RTE_ALIGN_MUL_FLOOR(v, mul); \
392  (ceil - (v)) > ((v) - floor) ? floor : ceil; \
393  })
394 
406 static inline int
407 rte_is_aligned(const void * const __rte_restrict ptr, const unsigned int align)
408 {
409  return ((uintptr_t)ptr & (align - 1)) == 0;
410 }
411 
412 /*********** Macros for compile type checks ********/
413 
417 #define RTE_BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
418 
419 /*********** Cache line related macros ********/
420 
422 #define RTE_CACHE_LINE_MASK (RTE_CACHE_LINE_SIZE-1)
423 
425 #define RTE_CACHE_LINE_ROUNDUP(size) RTE_ALIGN_CEIL(size, RTE_CACHE_LINE_SIZE)
426 
428 #if RTE_CACHE_LINE_SIZE == 64
429 #define RTE_CACHE_LINE_SIZE_LOG2 6
430 #elif RTE_CACHE_LINE_SIZE == 128
431 #define RTE_CACHE_LINE_SIZE_LOG2 7
432 #else
433 #error "Unsupported cache line size"
434 #endif
435 
437 #define RTE_CACHE_LINE_MIN_SIZE 64
438 
440 #define __rte_cache_aligned __rte_aligned(RTE_CACHE_LINE_SIZE)
441 
443 #define __rte_cache_min_aligned __rte_aligned(RTE_CACHE_LINE_MIN_SIZE)
444 
445 /*********** PA/IOVA type definitions ********/
446 
448 typedef uint64_t phys_addr_t;
449 #define RTE_BAD_PHYS_ADDR ((phys_addr_t)-1)
450 
458 typedef uint64_t rte_iova_t;
459 #define RTE_BAD_IOVA ((rte_iova_t)-1)
460 
461 /*********** Structure alignment markers ********/
462 
464 __extension__ typedef void *RTE_MARKER[0];
466 __extension__ typedef uint8_t RTE_MARKER8[0];
468 __extension__ typedef uint16_t RTE_MARKER16[0];
470 __extension__ typedef uint32_t RTE_MARKER32[0];
472 __extension__ typedef uint64_t RTE_MARKER64[0];
473 
484 static inline uint32_t
485 rte_combine32ms1b(uint32_t x)
486 {
487  x |= x >> 1;
488  x |= x >> 2;
489  x |= x >> 4;
490  x |= x >> 8;
491  x |= x >> 16;
492 
493  return x;
494 }
495 
506 static inline uint64_t
507 rte_combine64ms1b(uint64_t v)
508 {
509  v |= v >> 1;
510  v |= v >> 2;
511  v |= v >> 4;
512  v |= v >> 8;
513  v |= v >> 16;
514  v |= v >> 32;
515 
516  return v;
517 }
518 
519 /*********** Macros to work with powers of 2 ********/
520 
524 #define RTE_IS_POWER_OF_2(n) ((n) && !(((n) - 1) & (n)))
525 
532 static inline int
533 rte_is_power_of_2(uint32_t n)
534 {
535  return n && !(n & (n - 1));
536 }
537 
547 static inline uint32_t
548 rte_align32pow2(uint32_t x)
549 {
550  x--;
551  x = rte_combine32ms1b(x);
552 
553  return x + 1;
554 }
555 
565 static inline uint32_t
567 {
568  x = rte_combine32ms1b(x);
569 
570  return x - (x >> 1);
571 }
572 
582 static inline uint64_t
583 rte_align64pow2(uint64_t v)
584 {
585  v--;
586  v = rte_combine64ms1b(v);
587 
588  return v + 1;
589 }
590 
600 static inline uint64_t
602 {
603  v = rte_combine64ms1b(v);
604 
605  return v - (v >> 1);
606 }
607 
608 /*********** Macros for calculating min and max **********/
609 
613 #define RTE_MIN(a, b) \
614  __extension__ ({ \
615  typeof (a) _a = (a); \
616  typeof (b) _b = (b); \
617  _a < _b ? _a : _b; \
618  })
619 
623 #define RTE_MAX(a, b) \
624  __extension__ ({ \
625  typeof (a) _a = (a); \
626  typeof (b) _b = (b); \
627  _a > _b ? _a : _b; \
628  })
629 
630 /*********** Other general functions / macros ********/
631 
643 static inline uint32_t
644 rte_bsf32(uint32_t v)
645 {
646  return (uint32_t)__builtin_ctz(v);
647 }
648 
663 static inline int
664 rte_bsf32_safe(uint32_t v, uint32_t *pos)
665 {
666  if (v == 0)
667  return 0;
668 
669  *pos = rte_bsf32(v);
670  return 1;
671 }
672 
684 static inline uint32_t
685 rte_log2_u32(uint32_t v)
686 {
687  if (v == 0)
688  return 0;
689  v = rte_align32pow2(v);
690  return rte_bsf32(v);
691 }
692 
693 
705 static inline uint32_t
706 rte_fls_u32(uint32_t x)
707 {
708  return (x == 0) ? 0 : 32 - __builtin_clz(x);
709 }
710 
722 static inline uint32_t
723 rte_bsf64(uint64_t v)
724 {
725  return (uint32_t)__builtin_ctzll(v);
726 }
727 
742 static inline int
743 rte_bsf64_safe(uint64_t v, uint32_t *pos)
744 {
745  if (v == 0)
746  return 0;
747 
748  *pos = rte_bsf64(v);
749  return 1;
750 }
751 
764 static inline uint32_t
765 rte_fls_u64(uint64_t x)
766 {
767  return (x == 0) ? 0 : 64 - __builtin_clzll(x);
768 }
769 
781 static inline uint32_t
782 rte_log2_u64(uint64_t v)
783 {
784  if (v == 0)
785  return 0;
786  v = rte_align64pow2(v);
787  /* we checked for v being 0 already, so no undefined behavior */
788  return rte_bsf64(v);
789 }
790 
791 #ifndef offsetof
792 
793 #define offsetof(TYPE, MEMBER) __builtin_offsetof (TYPE, MEMBER)
794 #endif
795 
810 #ifndef container_of
811 #define container_of(ptr, type, member) __extension__ ({ \
812  const typeof(((type *)0)->member) *_ptr = (ptr); \
813  __rte_unused type *_target_ptr = \
814  (type *)(ptr); \
815  (type *)(((uintptr_t)_ptr) - offsetof(type, member)); \
816  })
817 #endif
818 
820 #define RTE_SWAP(a, b) \
821  __extension__ ({ \
822  typeof (a) _a = a; \
823  a = b; \
824  b = _a; \
825  })
826 
837 #define RTE_SIZEOF_FIELD(type, field) (sizeof(((type *)0)->field))
838 
839 #define _RTE_STR(x) #x
840 
841 #define RTE_STR(x) _RTE_STR(x)
842 
848 #define RTE_FMT(fmt, ...) fmt "%.0s", __VA_ARGS__ ""
849 #define RTE_FMT_HEAD(fmt, ...) fmt
850 #define RTE_FMT_TAIL(fmt, ...) __VA_ARGS__
851 
853 #define RTE_LEN2MASK(ln, tp) \
854  ((tp)((uint64_t)-1 >> (sizeof(uint64_t) * CHAR_BIT - (ln))))
855 
857 #define RTE_DIM(a) (sizeof (a) / sizeof ((a)[0]))
858 
873 uint64_t
874 rte_str_to_size(const char *str);
875 
889 __rte_noreturn void
890 rte_exit(int exit_code, const char *format, ...)
891  __rte_format_printf(2, 3);
892 
893 #ifdef __cplusplus
894 }
895 #endif
896 
897 #endif
static uint64_t rte_combine64ms1b(uint64_t v)
Definition: rte_common.h:507
static uint32_t rte_fls_u64(uint64_t x)
Definition: rte_common.h:765
uint64_t rte_iova_t
Definition: rte_common.h:458
static uint32_t rte_log2_u64(uint64_t v)
Definition: rte_common.h:782
static uint32_t rte_combine32ms1b(uint32_t x)
Definition: rte_common.h:485
static uint64_t rte_align64pow2(uint64_t v)
Definition: rte_common.h:583
static uint32_t rte_log2_u32(uint32_t v)
Definition: rte_common.h:685
static uint32_t rte_fls_u32(uint32_t x)
Definition: rte_common.h:706
__extension__ typedef uint8_t RTE_MARKER8[0]
Definition: rte_common.h:466
__extension__ typedef void * RTE_MARKER[0]
Definition: rte_common.h:464
static uint32_t rte_bsf32(uint32_t v)
Definition: rte_common.h:644
#define __rte_restrict
Definition: rte_common.h:126
static uint64_t rte_align64prevpow2(uint64_t v)
Definition: rte_common.h:601
static uint32_t rte_bsf64(uint64_t v)
Definition: rte_common.h:723
static uint32_t rte_align32pow2(uint32_t x)
Definition: rte_common.h:548
static int rte_bsf64_safe(uint64_t v, uint32_t *pos)
Definition: rte_common.h:743
uint64_t phys_addr_t
Definition: rte_common.h:448
__extension__ typedef uint64_t RTE_MARKER64[0]
Definition: rte_common.h:472
uint64_t rte_str_to_size(const char *str)
#define __rte_format_printf(format_index, first_arg)
Definition: rte_common.h:148
static int rte_bsf32_safe(uint32_t v, uint32_t *pos)
Definition: rte_common.h:664
static int rte_is_power_of_2(uint32_t n)
Definition: rte_common.h:533
__extension__ typedef uint16_t RTE_MARKER16[0]
Definition: rte_common.h:468
__extension__ typedef uint32_t RTE_MARKER32[0]
Definition: rte_common.h:470
#define __rte_noreturn
Definition: rte_common.h:225
static uint32_t rte_align32prevpow2(uint32_t x)
Definition: rte_common.h:566
__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:407
#define __rte_aligned(a)
Definition: rte_common.h:68