DPDK  20.11.3
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 <stdlib.h>
21 #include <ctype.h>
22 #include <errno.h>
23 #include <limits.h>
24 
25 #include <rte_config.h>
26 
27 /* OS specific include */
28 #include <rte_os.h>
29 
30 #ifndef typeof
31 #define typeof __typeof__
32 #endif
33 
34 #ifndef asm
35 #define asm __asm__
36 #endif
37 
39 #if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 201112L
40 #define RTE_STD_C11 __extension__
41 #else
42 #define RTE_STD_C11
43 #endif
44 
45 /*
46  * RTE_TOOLCHAIN_GCC is defined if the target is built with GCC,
47  * while a host application (like pmdinfogen) may have another compiler.
48  * RTE_CC_IS_GNU is true if the file is compiled with GCC,
49  * no matter it is a target or host application.
50  */
51 #define RTE_CC_IS_GNU 0
52 #if defined __clang__
53 #define RTE_CC_CLANG
54 #elif defined __INTEL_COMPILER
55 #define RTE_CC_ICC
56 #elif defined __GNUC__
57 #define RTE_CC_GCC
58 #undef RTE_CC_IS_GNU
59 #define RTE_CC_IS_GNU 1
60 #endif
61 #if RTE_CC_IS_GNU
62 #define GCC_VERSION (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + \
63  __GNUC_PATCHLEVEL__)
64 #endif
65 
69 #define __rte_aligned(a) __attribute__((__aligned__(a)))
70 
71 #ifdef RTE_ARCH_STRICT_ALIGN
72 typedef uint64_t unaligned_uint64_t __rte_aligned(1);
73 typedef uint32_t unaligned_uint32_t __rte_aligned(1);
74 typedef uint16_t unaligned_uint16_t __rte_aligned(1);
75 #else
76 typedef uint64_t unaligned_uint64_t;
77 typedef uint32_t unaligned_uint32_t;
78 typedef uint16_t unaligned_uint16_t;
79 #endif
80 
84 #define __rte_packed __attribute__((__packed__))
85 
86 /******* Macro to mark functions and fields scheduled for removal *****/
87 #define __rte_deprecated __attribute__((__deprecated__))
88 #define __rte_deprecated_msg(msg) __attribute__((__deprecated__(msg)))
89 
93 #if defined(RTE_CC_GCC) || defined(RTE_CC_CLANG)
94 #define RTE_PRAGMA(x) _Pragma(#x)
95 #define RTE_PRAGMA_WARNING(w) RTE_PRAGMA(GCC warning #w)
96 #define RTE_DEPRECATED(x) RTE_PRAGMA_WARNING(#x is deprecated)
97 #else
98 #define RTE_DEPRECATED(x)
99 #endif
100 
104 #define __rte_weak __attribute__((__weak__))
105 
109 #define __rte_used __attribute__((used))
110 
111 /*********** Macros to eliminate unused variable warnings ********/
112 
116 #define __rte_unused __attribute__((__unused__))
117 
121 #if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 199901L
122 #define __rte_restrict __restrict
123 #else
124 #define __rte_restrict restrict
125 #endif
126 
131 #define RTE_SET_USED(x) (void)(x)
132 
140 #if RTE_CC_IS_GNU
141 #define __rte_format_printf(format_index, first_arg) \
142  __attribute__((format(gnu_printf, format_index, first_arg)))
143 #else
144 #define __rte_format_printf(format_index, first_arg) \
145  __attribute__((format(printf, format_index, first_arg)))
146 #endif
147 
153 #if defined(RTE_CC_GCC) || defined(RTE_CC_CLANG)
154 #define __rte_alloc_size(...) \
155  __attribute__((alloc_size(__VA_ARGS__)))
156 #else
157 #define __rte_alloc_size(...)
158 #endif
159 
160 #define RTE_PRIORITY_LOG 101
161 #define RTE_PRIORITY_BUS 110
162 #define RTE_PRIORITY_CLASS 120
163 #define RTE_PRIORITY_LAST 65535
164 
165 #define RTE_PRIO(prio) \
166  RTE_PRIORITY_ ## prio
167 
177 #ifndef RTE_INIT_PRIO /* Allow to override from EAL */
178 #define RTE_INIT_PRIO(func, prio) \
179 static void __attribute__((constructor(RTE_PRIO(prio)), used)) func(void)
180 #endif
181 
190 #define RTE_INIT(func) \
191  RTE_INIT_PRIO(func, LAST)
192 
202 #ifndef RTE_FINI_PRIO /* Allow to override from EAL */
203 #define RTE_FINI_PRIO(func, prio) \
204 static void __attribute__((destructor(RTE_PRIO(prio)), used)) func(void)
205 #endif
206 
215 #define RTE_FINI(func) \
216  RTE_FINI_PRIO(func, LAST)
217 
221 #define __rte_noreturn __attribute__((noreturn))
222 
226 #define __rte_always_inline inline __attribute__((always_inline))
227 
231 #define __rte_noinline __attribute__((noinline))
232 
236 #define __rte_hot __attribute__((hot))
237 
241 #define __rte_cold __attribute__((cold))
242 
243 /*********** Macros for pointer arithmetic ********/
244 
248 #define RTE_PTR_ADD(ptr, x) ((void*)((uintptr_t)(ptr) + (x)))
249 
253 #define RTE_PTR_SUB(ptr, x) ((void*)((uintptr_t)ptr - (x)))
254 
260 #define RTE_PTR_DIFF(ptr1, ptr2) ((uintptr_t)(ptr1) - (uintptr_t)(ptr2))
261 
265 #define RTE_CAST_FIELD(var, field, type) \
266  (*(type *)((uintptr_t)(var) + offsetof(typeof(*(var)), field)))
267 
268 /*********** Macros/static functions for doing alignment ********/
269 
270 
277 #define RTE_PTR_ALIGN_FLOOR(ptr, align) \
278  ((typeof(ptr))RTE_ALIGN_FLOOR((uintptr_t)ptr, align))
279 
286 #define RTE_ALIGN_FLOOR(val, align) \
287  (typeof(val))((val) & (~((typeof(val))((align) - 1))))
288 
295 #define RTE_PTR_ALIGN_CEIL(ptr, align) \
296  RTE_PTR_ALIGN_FLOOR((typeof(ptr))RTE_PTR_ADD(ptr, (align) - 1), align)
297 
304 #define RTE_ALIGN_CEIL(val, align) \
305  RTE_ALIGN_FLOOR(((val) + ((typeof(val)) (align) - 1)), align)
306 
314 #define RTE_PTR_ALIGN(ptr, align) RTE_PTR_ALIGN_CEIL(ptr, align)
315 
323 #define RTE_ALIGN(val, align) RTE_ALIGN_CEIL(val, align)
324 
330 #define RTE_ALIGN_MUL_CEIL(v, mul) \
331  ((((v) + (typeof(v))(mul) - 1) / ((typeof(v))(mul))) * (typeof(v))(mul))
332 
338 #define RTE_ALIGN_MUL_FLOOR(v, mul) \
339  (((v) / ((typeof(v))(mul))) * (typeof(v))(mul))
340 
346 #define RTE_ALIGN_MUL_NEAR(v, mul) \
347  ({ \
348  typeof(v) ceil = RTE_ALIGN_MUL_CEIL(v, mul); \
349  typeof(v) floor = RTE_ALIGN_MUL_FLOOR(v, mul); \
350  (ceil - (v)) > ((v) - floor) ? floor : ceil; \
351  })
352 
364 static inline int
365 rte_is_aligned(void *ptr, unsigned align)
366 {
367  return RTE_PTR_ALIGN(ptr, align) == ptr;
368 }
369 
370 /*********** Macros for compile type checks ********/
371 
375 #define RTE_BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
376 
377 /*********** Cache line related macros ********/
378 
380 #define RTE_CACHE_LINE_MASK (RTE_CACHE_LINE_SIZE-1)
381 
383 #define RTE_CACHE_LINE_ROUNDUP(size) \
384  (RTE_CACHE_LINE_SIZE * ((size + RTE_CACHE_LINE_SIZE - 1) / \
385  RTE_CACHE_LINE_SIZE))
386 
388 #if RTE_CACHE_LINE_SIZE == 64
389 #define RTE_CACHE_LINE_SIZE_LOG2 6
390 #elif RTE_CACHE_LINE_SIZE == 128
391 #define RTE_CACHE_LINE_SIZE_LOG2 7
392 #else
393 #error "Unsupported cache line size"
394 #endif
395 
397 #define RTE_CACHE_LINE_MIN_SIZE 64
398 
400 #define __rte_cache_aligned __rte_aligned(RTE_CACHE_LINE_SIZE)
401 
403 #define __rte_cache_min_aligned __rte_aligned(RTE_CACHE_LINE_MIN_SIZE)
404 
405 /*********** PA/IOVA type definitions ********/
406 
408 typedef uint64_t phys_addr_t;
409 #define RTE_BAD_PHYS_ADDR ((phys_addr_t)-1)
410 
418 typedef uint64_t rte_iova_t;
419 #define RTE_BAD_IOVA ((rte_iova_t)-1)
420 
421 /*********** Structure alignment markers ********/
422 
424 __extension__ typedef void *RTE_MARKER[0];
426 __extension__ typedef uint8_t RTE_MARKER8[0];
428 __extension__ typedef uint16_t RTE_MARKER16[0];
430 __extension__ typedef uint32_t RTE_MARKER32[0];
432 __extension__ typedef uint64_t RTE_MARKER64[0];
433 
444 static inline uint32_t
445 rte_combine32ms1b(uint32_t x)
446 {
447  x |= x >> 1;
448  x |= x >> 2;
449  x |= x >> 4;
450  x |= x >> 8;
451  x |= x >> 16;
452 
453  return x;
454 }
455 
466 static inline uint64_t
467 rte_combine64ms1b(uint64_t v)
468 {
469  v |= v >> 1;
470  v |= v >> 2;
471  v |= v >> 4;
472  v |= v >> 8;
473  v |= v >> 16;
474  v |= v >> 32;
475 
476  return v;
477 }
478 
479 /*********** Macros to work with powers of 2 ********/
480 
484 #define RTE_IS_POWER_OF_2(n) ((n) && !(((n) - 1) & (n)))
485 
492 static inline int
493 rte_is_power_of_2(uint32_t n)
494 {
495  return n && !(n & (n - 1));
496 }
497 
507 static inline uint32_t
508 rte_align32pow2(uint32_t x)
509 {
510  x--;
511  x = rte_combine32ms1b(x);
512 
513  return x + 1;
514 }
515 
525 static inline uint32_t
527 {
528  x = rte_combine32ms1b(x);
529 
530  return x - (x >> 1);
531 }
532 
542 static inline uint64_t
543 rte_align64pow2(uint64_t v)
544 {
545  v--;
546  v = rte_combine64ms1b(v);
547 
548  return v + 1;
549 }
550 
560 static inline uint64_t
562 {
563  v = rte_combine64ms1b(v);
564 
565  return v - (v >> 1);
566 }
567 
568 /*********** Macros for calculating min and max **********/
569 
573 #define RTE_MIN(a, b) \
574  __extension__ ({ \
575  typeof (a) _a = (a); \
576  typeof (b) _b = (b); \
577  _a < _b ? _a : _b; \
578  })
579 
583 #define RTE_MAX(a, b) \
584  __extension__ ({ \
585  typeof (a) _a = (a); \
586  typeof (b) _b = (b); \
587  _a > _b ? _a : _b; \
588  })
589 
590 /*********** Other general functions / macros ********/
591 
603 static inline uint32_t
604 rte_bsf32(uint32_t v)
605 {
606  return (uint32_t)__builtin_ctz(v);
607 }
608 
623 static inline int
624 rte_bsf32_safe(uint64_t v, uint32_t *pos)
625 {
626  if (v == 0)
627  return 0;
628 
629  *pos = rte_bsf32(v);
630  return 1;
631 }
632 
644 static inline uint32_t
645 rte_log2_u32(uint32_t v)
646 {
647  if (v == 0)
648  return 0;
649  v = rte_align32pow2(v);
650  return rte_bsf32(v);
651 }
652 
653 
665 static inline int
666 rte_fls_u32(uint32_t x)
667 {
668  return (x == 0) ? 0 : 32 - __builtin_clz(x);
669 }
670 
682 static inline int
683 rte_bsf64(uint64_t v)
684 {
685  return (uint32_t)__builtin_ctzll(v);
686 }
687 
702 static inline int
703 rte_bsf64_safe(uint64_t v, uint32_t *pos)
704 {
705  if (v == 0)
706  return 0;
707 
708  *pos = rte_bsf64(v);
709  return 1;
710 }
711 
724 static inline int
725 rte_fls_u64(uint64_t x)
726 {
727  return (x == 0) ? 0 : 64 - __builtin_clzll(x);
728 }
729 
741 static inline uint32_t
742 rte_log2_u64(uint64_t v)
743 {
744  if (v == 0)
745  return 0;
746  v = rte_align64pow2(v);
747  /* we checked for v being 0 already, so no undefined behavior */
748  return rte_bsf64(v);
749 }
750 
751 #ifndef offsetof
752 
753 #define offsetof(TYPE, MEMBER) __builtin_offsetof (TYPE, MEMBER)
754 #endif
755 
770 #ifndef container_of
771 #define container_of(ptr, type, member) __extension__ ({ \
772  const typeof(((type *)0)->member) *_ptr = (ptr); \
773  __rte_unused type *_target_ptr = \
774  (type *)(ptr); \
775  (type *)(((uintptr_t)_ptr) - offsetof(type, member)); \
776  })
777 #endif
778 
789 #define RTE_SIZEOF_FIELD(type, field) (sizeof(((type *)0)->field))
790 
791 #define _RTE_STR(x) #x
792 
793 #define RTE_STR(x) _RTE_STR(x)
794 
800 #define RTE_FMT(fmt, ...) fmt "%.0s", __VA_ARGS__ ""
801 #define RTE_FMT_HEAD(fmt, ...) fmt
802 #define RTE_FMT_TAIL(fmt, ...) __VA_ARGS__
803 
805 #define RTE_LEN2MASK(ln, tp) \
806  ((tp)((uint64_t)-1 >> (sizeof(uint64_t) * CHAR_BIT - (ln))))
807 
809 #define RTE_DIM(a) (sizeof (a) / sizeof ((a)[0]))
810 
825 static inline uint64_t
826 rte_str_to_size(const char *str)
827 {
828  char *endptr;
829  unsigned long long size;
830 
831  while (isspace((int)*str))
832  str++;
833  if (*str == '-')
834  return 0;
835 
836  errno = 0;
837  size = strtoull(str, &endptr, 0);
838  if (errno)
839  return 0;
840 
841  if (*endptr == ' ')
842  endptr++; /* allow 1 space gap */
843 
844  switch (*endptr){
845  case 'G': case 'g': size *= 1024; /* fall-through */
846  case 'M': case 'm': size *= 1024; /* fall-through */
847  case 'K': case 'k': size *= 1024; /* fall-through */
848  default:
849  break;
850  }
851  return size;
852 }
853 
867 __rte_noreturn void
868 rte_exit(int exit_code, const char *format, ...)
869  __rte_format_printf(2, 3);
870 
871 #ifdef __cplusplus
872 }
873 #endif
874 
875 #endif
static int rte_is_aligned(void *ptr, unsigned align)
Definition: rte_common.h:365
static uint64_t rte_combine64ms1b(uint64_t v)
Definition: rte_common.h:467
static int rte_bsf32_safe(uint64_t v, uint32_t *pos)
Definition: rte_common.h:624
uint64_t rte_iova_t
Definition: rte_common.h:418
static int rte_fls_u32(uint32_t x)
Definition: rte_common.h:666
static uint32_t rte_log2_u64(uint64_t v)
Definition: rte_common.h:742
static uint32_t rte_combine32ms1b(uint32_t x)
Definition: rte_common.h:445
static uint64_t rte_align64pow2(uint64_t v)
Definition: rte_common.h:543
static uint32_t rte_log2_u32(uint32_t v)
Definition: rte_common.h:645
__extension__ typedef uint8_t RTE_MARKER8[0]
Definition: rte_common.h:426
__extension__ typedef void * RTE_MARKER[0]
Definition: rte_common.h:424
static uint32_t rte_bsf32(uint32_t v)
Definition: rte_common.h:604
static uint64_t rte_align64prevpow2(uint64_t v)
Definition: rte_common.h:561
static uint32_t rte_align32pow2(uint32_t x)
Definition: rte_common.h:508
static int rte_bsf64_safe(uint64_t v, uint32_t *pos)
Definition: rte_common.h:703
uint64_t phys_addr_t
Definition: rte_common.h:408
__extension__ typedef uint64_t RTE_MARKER64[0]
Definition: rte_common.h:432
#define __rte_format_printf(format_index, first_arg)
Definition: rte_common.h:144
static int rte_fls_u64(uint64_t x)
Definition: rte_common.h:725
#define RTE_PTR_ALIGN(ptr, align)
Definition: rte_common.h:314
static int rte_is_power_of_2(uint32_t n)
Definition: rte_common.h:493
__extension__ typedef uint16_t RTE_MARKER16[0]
Definition: rte_common.h:428
static int rte_bsf64(uint64_t v)
Definition: rte_common.h:683
__extension__ typedef uint32_t RTE_MARKER32[0]
Definition: rte_common.h:430
#define __rte_noreturn
Definition: rte_common.h:221
static uint32_t rte_align32prevpow2(uint32_t x)
Definition: rte_common.h:526
static uint64_t rte_str_to_size(const char *str)
Definition: rte_common.h:826
__rte_noreturn void rte_exit(int exit_code, const char *format,...) __rte_format_printf(2
#define __rte_aligned(a)
Definition: rte_common.h:69