DPDK  19.11.10
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 
46 #ifdef RTE_TOOLCHAIN_GCC
47 #define GCC_VERSION (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + \
48  __GNUC_PATCHLEVEL__)
49 #endif
50 
51 #ifdef RTE_ARCH_STRICT_ALIGN
52 typedef uint64_t unaligned_uint64_t __attribute__ ((aligned(1)));
53 typedef uint32_t unaligned_uint32_t __attribute__ ((aligned(1)));
54 typedef uint16_t unaligned_uint16_t __attribute__ ((aligned(1)));
55 #else
56 typedef uint64_t unaligned_uint64_t;
57 typedef uint32_t unaligned_uint32_t;
58 typedef uint16_t unaligned_uint16_t;
59 #endif
60 
64 #define __rte_aligned(a) __attribute__((__aligned__(a)))
65 
69 #define __rte_packed __attribute__((__packed__))
70 
71 /******* Macro to mark functions and fields scheduled for removal *****/
72 #define __rte_deprecated __attribute__((__deprecated__))
73 
77 #define __rte_weak __attribute__((__weak__))
78 
79 /*********** Macros to eliminate unused variable warnings ********/
80 
84 #define __rte_unused __attribute__((__unused__))
85 
90 #define RTE_SET_USED(x) (void)(x)
91 
92 #define RTE_PRIORITY_LOG 101
93 #define RTE_PRIORITY_BUS 110
94 #define RTE_PRIORITY_CLASS 120
95 #define RTE_PRIORITY_LAST 65535
96 
97 #define RTE_PRIO(prio) \
98  RTE_PRIORITY_ ## prio
99 
109 #ifndef RTE_INIT_PRIO /* Allow to override from EAL */
110 #define RTE_INIT_PRIO(func, prio) \
111 static void __attribute__((constructor(RTE_PRIO(prio)), used)) func(void)
112 #endif
113 
122 #define RTE_INIT(func) \
123  RTE_INIT_PRIO(func, LAST)
124 
134 #ifndef RTE_FINI_PRIO /* Allow to override from EAL */
135 #define RTE_FINI_PRIO(func, prio) \
136 static void __attribute__((destructor(RTE_PRIO(prio)), used)) func(void)
137 #endif
138 
147 #define RTE_FINI(func) \
148  RTE_FINI_PRIO(func, LAST)
149 
153 #define __rte_always_inline inline __attribute__((always_inline))
154 
158 #define __rte_noinline __attribute__((noinline))
159 
160 /*********** Macros for pointer arithmetic ********/
161 
165 #define RTE_PTR_ADD(ptr, x) ((void*)((uintptr_t)(ptr) + (x)))
166 
170 #define RTE_PTR_SUB(ptr, x) ((void*)((uintptr_t)ptr - (x)))
171 
177 #define RTE_PTR_DIFF(ptr1, ptr2) ((uintptr_t)(ptr1) - (uintptr_t)(ptr2))
178 
182 #define RTE_CAST_FIELD(var, field, type) \
183  (*(type *)((uintptr_t)(var) + offsetof(typeof(*(var)), field)))
184 
185 /*********** Macros/static functions for doing alignment ********/
186 
187 
194 #define RTE_PTR_ALIGN_FLOOR(ptr, align) \
195  ((typeof(ptr))RTE_ALIGN_FLOOR((uintptr_t)ptr, align))
196 
203 #define RTE_ALIGN_FLOOR(val, align) \
204  (typeof(val))((val) & (~((typeof(val))((align) - 1))))
205 
212 #define RTE_PTR_ALIGN_CEIL(ptr, align) \
213  RTE_PTR_ALIGN_FLOOR((typeof(ptr))RTE_PTR_ADD(ptr, (align) - 1), align)
214 
221 #define RTE_ALIGN_CEIL(val, align) \
222  RTE_ALIGN_FLOOR(((val) + ((typeof(val)) (align) - 1)), align)
223 
231 #define RTE_PTR_ALIGN(ptr, align) RTE_PTR_ALIGN_CEIL(ptr, align)
232 
240 #define RTE_ALIGN(val, align) RTE_ALIGN_CEIL(val, align)
241 
247 #define RTE_ALIGN_MUL_CEIL(v, mul) \
248  ((((v) + (typeof(v))(mul) - 1) / ((typeof(v))(mul))) * (typeof(v))(mul))
249 
255 #define RTE_ALIGN_MUL_FLOOR(v, mul) \
256  (((v) / ((typeof(v))(mul))) * (typeof(v))(mul))
257 
263 #define RTE_ALIGN_MUL_NEAR(v, mul) \
264  ({ \
265  typeof(v) ceil = RTE_ALIGN_MUL_CEIL(v, mul); \
266  typeof(v) floor = RTE_ALIGN_MUL_FLOOR(v, mul); \
267  (ceil - (v)) > ((v) - floor) ? floor : ceil; \
268  })
269 
281 static inline int
282 rte_is_aligned(void *ptr, unsigned align)
283 {
284  return RTE_PTR_ALIGN(ptr, align) == ptr;
285 }
286 
287 /*********** Macros for compile type checks ********/
288 
292 #define RTE_BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
293 
294 /*********** Cache line related macros ********/
295 
297 #define RTE_CACHE_LINE_MASK (RTE_CACHE_LINE_SIZE-1)
298 
300 #define RTE_CACHE_LINE_ROUNDUP(size) \
301  (RTE_CACHE_LINE_SIZE * ((size + RTE_CACHE_LINE_SIZE - 1) / \
302  RTE_CACHE_LINE_SIZE))
303 
305 #if RTE_CACHE_LINE_SIZE == 64
306 #define RTE_CACHE_LINE_SIZE_LOG2 6
307 #elif RTE_CACHE_LINE_SIZE == 128
308 #define RTE_CACHE_LINE_SIZE_LOG2 7
309 #else
310 #error "Unsupported cache line size"
311 #endif
312 
314 #define RTE_CACHE_LINE_MIN_SIZE 64
315 
317 #define __rte_cache_aligned __rte_aligned(RTE_CACHE_LINE_SIZE)
318 
320 #define __rte_cache_min_aligned __rte_aligned(RTE_CACHE_LINE_MIN_SIZE)
321 
322 /*********** PA/IOVA type definitions ********/
323 
325 typedef uint64_t phys_addr_t;
326 #define RTE_BAD_PHYS_ADDR ((phys_addr_t)-1)
327 
335 typedef uint64_t rte_iova_t;
336 #define RTE_BAD_IOVA ((rte_iova_t)-1)
337 
338 
349 static inline uint32_t
350 rte_combine32ms1b(uint32_t x)
351 {
352  x |= x >> 1;
353  x |= x >> 2;
354  x |= x >> 4;
355  x |= x >> 8;
356  x |= x >> 16;
357 
358  return x;
359 }
360 
371 static inline uint64_t
372 rte_combine64ms1b(uint64_t v)
373 {
374  v |= v >> 1;
375  v |= v >> 2;
376  v |= v >> 4;
377  v |= v >> 8;
378  v |= v >> 16;
379  v |= v >> 32;
380 
381  return v;
382 }
383 
384 /*********** Macros to work with powers of 2 ********/
385 
389 #define RTE_IS_POWER_OF_2(n) ((n) && !(((n) - 1) & (n)))
390 
397 static inline int
398 rte_is_power_of_2(uint32_t n)
399 {
400  return n && !(n & (n - 1));
401 }
402 
412 static inline uint32_t
413 rte_align32pow2(uint32_t x)
414 {
415  x--;
416  x = rte_combine32ms1b(x);
417 
418  return x + 1;
419 }
420 
430 static inline uint32_t
432 {
433  x = rte_combine32ms1b(x);
434 
435  return x - (x >> 1);
436 }
437 
447 static inline uint64_t
448 rte_align64pow2(uint64_t v)
449 {
450  v--;
451  v = rte_combine64ms1b(v);
452 
453  return v + 1;
454 }
455 
465 static inline uint64_t
467 {
468  v = rte_combine64ms1b(v);
469 
470  return v - (v >> 1);
471 }
472 
473 /*********** Macros for calculating min and max **********/
474 
478 #define RTE_MIN(a, b) \
479  __extension__ ({ \
480  typeof (a) _a = (a); \
481  typeof (b) _b = (b); \
482  _a < _b ? _a : _b; \
483  })
484 
488 #define RTE_MAX(a, b) \
489  __extension__ ({ \
490  typeof (a) _a = (a); \
491  typeof (b) _b = (b); \
492  _a > _b ? _a : _b; \
493  })
494 
495 /*********** Other general functions / macros ********/
496 
508 static inline uint32_t
509 rte_bsf32(uint32_t v)
510 {
511  return (uint32_t)__builtin_ctz(v);
512 }
513 
528 static inline int
529 rte_bsf32_safe(uint64_t v, uint32_t *pos)
530 {
531  if (v == 0)
532  return 0;
533 
534  *pos = rte_bsf32(v);
535  return 1;
536 }
537 
549 static inline uint32_t
550 rte_log2_u32(uint32_t v)
551 {
552  if (v == 0)
553  return 0;
554  v = rte_align32pow2(v);
555  return rte_bsf32(v);
556 }
557 
558 
570 static inline int
571 rte_fls_u32(uint32_t x)
572 {
573  return (x == 0) ? 0 : 32 - __builtin_clz(x);
574 }
575 
587 static inline int
588 rte_bsf64(uint64_t v)
589 {
590  return (uint32_t)__builtin_ctzll(v);
591 }
592 
607 static inline int
608 rte_bsf64_safe(uint64_t v, uint32_t *pos)
609 {
610  if (v == 0)
611  return 0;
612 
613  *pos = rte_bsf64(v);
614  return 1;
615 }
616 
629 static inline int
630 rte_fls_u64(uint64_t x)
631 {
632  return (x == 0) ? 0 : 64 - __builtin_clzll(x);
633 }
634 
646 static inline uint32_t
647 rte_log2_u64(uint64_t v)
648 {
649  if (v == 0)
650  return 0;
651  v = rte_align64pow2(v);
652  /* we checked for v being 0 already, so no undefined behavior */
653  return rte_bsf64(v);
654 }
655 
656 #ifndef offsetof
657 
658 #define offsetof(TYPE, MEMBER) __builtin_offsetof (TYPE, MEMBER)
659 #endif
660 
675 #ifndef container_of
676 #define container_of(ptr, type, member) __extension__ ({ \
677  const typeof(((type *)0)->member) *_ptr = (ptr); \
678  __attribute__((unused)) type *_target_ptr = \
679  (type *)(ptr); \
680  (type *)(((uintptr_t)_ptr) - offsetof(type, member)); \
681  })
682 #endif
683 
694 #define RTE_SIZEOF_FIELD(type, field) (sizeof(((type *)0)->field))
695 
696 #define _RTE_STR(x) #x
697 
698 #define RTE_STR(x) _RTE_STR(x)
699 
705 #define RTE_FMT(fmt, ...) fmt "%.0s", __VA_ARGS__ ""
706 #define RTE_FMT_HEAD(fmt, ...) fmt
707 #define RTE_FMT_TAIL(fmt, ...) __VA_ARGS__
708 
710 #define RTE_LEN2MASK(ln, tp) \
711  ((tp)((uint64_t)-1 >> (sizeof(uint64_t) * CHAR_BIT - (ln))))
712 
714 #define RTE_DIM(a) (sizeof (a) / sizeof ((a)[0]))
715 
730 static inline uint64_t
731 rte_str_to_size(const char *str)
732 {
733  char *endptr;
734  unsigned long long size;
735 
736  while (isspace((int)*str))
737  str++;
738  if (*str == '-')
739  return 0;
740 
741  errno = 0;
742  size = strtoull(str, &endptr, 0);
743  if (errno)
744  return 0;
745 
746  if (*endptr == ' ')
747  endptr++; /* allow 1 space gap */
748 
749  switch (*endptr){
750  case 'G': case 'g': size *= 1024; /* fall-through */
751  case 'M': case 'm': size *= 1024; /* fall-through */
752  case 'K': case 'k': size *= 1024; /* fall-through */
753  default:
754  break;
755  }
756  return size;
757 }
758 
772 void
773 rte_exit(int exit_code, const char *format, ...)
774  __attribute__((noreturn))
775  __attribute__((format(printf, 2, 3)));
776 
777 #ifdef __cplusplus
778 }
779 #endif
780 
781 #endif
static int rte_is_aligned(void *ptr, unsigned align)
Definition: rte_common.h:282
static uint64_t rte_combine64ms1b(uint64_t v)
Definition: rte_common.h:372
static int rte_bsf32_safe(uint64_t v, uint32_t *pos)
Definition: rte_common.h:529
uint64_t rte_iova_t
Definition: rte_common.h:335
static int rte_fls_u32(uint32_t x)
Definition: rte_common.h:571
static uint32_t rte_log2_u64(uint64_t v)
Definition: rte_common.h:647
static uint32_t rte_combine32ms1b(uint32_t x)
Definition: rte_common.h:350
static uint64_t rte_align64pow2(uint64_t v)
Definition: rte_common.h:448
static uint32_t rte_log2_u32(uint32_t v)
Definition: rte_common.h:550
static uint32_t rte_bsf32(uint32_t v)
Definition: rte_common.h:509
static uint64_t rte_align64prevpow2(uint64_t v)
Definition: rte_common.h:466
static uint32_t rte_align32pow2(uint32_t x)
Definition: rte_common.h:413
static int rte_bsf64_safe(uint64_t v, uint32_t *pos)
Definition: rte_common.h:608
uint64_t phys_addr_t
Definition: rte_common.h:325
uint64_t unaligned_uint64_t
Definition: rte_common.h:56
static int rte_fls_u64(uint64_t x)
Definition: rte_common.h:630
#define RTE_PTR_ALIGN(ptr, align)
Definition: rte_common.h:231
static int rte_is_power_of_2(uint32_t n)
Definition: rte_common.h:398
void rte_exit(int exit_code, const char *format,...)
static int rte_bsf64(uint64_t v)
Definition: rte_common.h:588
static uint32_t rte_align32prevpow2(uint32_t x)
Definition: rte_common.h:431
static uint64_t rte_str_to_size(const char *str)
Definition: rte_common.h:731