DPDK  17.11.4
rte_common.h
Go to the documentation of this file.
1 /*-
2  * BSD LICENSE
3  *
4  * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in
15  * the documentation and/or other materials provided with the
16  * distribution.
17  * * Neither the name of Intel Corporation nor the names of its
18  * contributors may be used to endorse or promote products derived
19  * from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33 
34 #ifndef _RTE_COMMON_H_
35 #define _RTE_COMMON_H_
36 
44 #ifdef __cplusplus
45 extern "C" {
46 #endif
47 
48 #include <stdint.h>
49 #include <stdlib.h>
50 #include <ctype.h>
51 #include <errno.h>
52 #include <limits.h>
53 
54 #include <rte_config.h>
55 
56 #ifndef typeof
57 #define typeof __typeof__
58 #endif
59 
60 #ifndef asm
61 #define asm __asm__
62 #endif
63 
65 #if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 201112L
66 #define RTE_STD_C11 __extension__
67 #else
68 #define RTE_STD_C11
69 #endif
70 
72 #ifdef RTE_TOOLCHAIN_GCC
73 #define GCC_VERSION (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + \
74  __GNUC_PATCHLEVEL__)
75 #endif
76 
77 #ifdef RTE_ARCH_STRICT_ALIGN
78 typedef uint64_t unaligned_uint64_t __attribute__ ((aligned(1)));
79 typedef uint32_t unaligned_uint32_t __attribute__ ((aligned(1)));
80 typedef uint16_t unaligned_uint16_t __attribute__ ((aligned(1)));
81 #else
82 typedef uint64_t unaligned_uint64_t;
83 typedef uint32_t unaligned_uint32_t;
84 typedef uint16_t unaligned_uint16_t;
85 #endif
86 
90 #define __rte_aligned(a) __attribute__((__aligned__(a)))
91 
95 #define __rte_packed __attribute__((__packed__))
96 
97 /******* Macro to mark functions and fields scheduled for removal *****/
98 #define __rte_deprecated __attribute__((__deprecated__))
99 
100 /*********** Macros to eliminate unused variable warnings ********/
101 
105 #define __rte_unused __attribute__((__unused__))
106 
111 #define RTE_SET_USED(x) (void)(x)
112 
121 #define RTE_INIT(func) \
122 static void __attribute__((constructor, used)) func(void)
123 
133 #define RTE_INIT_PRIO(func, prio) \
134 static void __attribute__((constructor(prio), used)) func(void)
135 
139 #define __rte_always_inline inline __attribute__((always_inline))
140 
144 #define __rte_noinline __attribute__((noinline))
145 
146 /*********** Macros for pointer arithmetic ********/
147 
151 #define RTE_PTR_ADD(ptr, x) ((void*)((uintptr_t)(ptr) + (x)))
152 
156 #define RTE_PTR_SUB(ptr, x) ((void*)((uintptr_t)ptr - (x)))
157 
163 #define RTE_PTR_DIFF(ptr1, ptr2) ((uintptr_t)(ptr1) - (uintptr_t)(ptr2))
164 
165 /*********** Macros/static functions for doing alignment ********/
166 
167 
174 #define RTE_PTR_ALIGN_FLOOR(ptr, align) \
175  ((typeof(ptr))RTE_ALIGN_FLOOR((uintptr_t)ptr, align))
176 
183 #define RTE_ALIGN_FLOOR(val, align) \
184  (typeof(val))((val) & (~((typeof(val))((align) - 1))))
185 
192 #define RTE_PTR_ALIGN_CEIL(ptr, align) \
193  RTE_PTR_ALIGN_FLOOR((typeof(ptr))RTE_PTR_ADD(ptr, (align) - 1), align)
194 
201 #define RTE_ALIGN_CEIL(val, align) \
202  RTE_ALIGN_FLOOR(((val) + ((typeof(val)) (align) - 1)), align)
203 
211 #define RTE_PTR_ALIGN(ptr, align) RTE_PTR_ALIGN_CEIL(ptr, align)
212 
220 #define RTE_ALIGN(val, align) RTE_ALIGN_CEIL(val, align)
221 
233 static inline int
234 rte_is_aligned(void *ptr, unsigned align)
235 {
236  return RTE_PTR_ALIGN(ptr, align) == ptr;
237 }
238 
239 /*********** Macros for compile type checks ********/
240 
244 #ifndef __OPTIMIZE__
245 #define RTE_BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
246 #else
247 extern int RTE_BUILD_BUG_ON_detected_error;
248 #define RTE_BUILD_BUG_ON(condition) do { \
249  ((void)sizeof(char[1 - 2*!!(condition)])); \
250  if (condition) \
251  RTE_BUILD_BUG_ON_detected_error = 1; \
252 } while(0)
253 #endif
254 
255 /*********** Macros to work with powers of 2 ********/
256 
263 static inline int
264 rte_is_power_of_2(uint32_t n)
265 {
266  return n && !(n & (n - 1));
267 }
268 
278 static inline uint32_t
279 rte_align32pow2(uint32_t x)
280 {
281  x--;
282  x |= x >> 1;
283  x |= x >> 2;
284  x |= x >> 4;
285  x |= x >> 8;
286  x |= x >> 16;
287 
288  return x + 1;
289 }
290 
300 static inline uint64_t
301 rte_align64pow2(uint64_t v)
302 {
303  v--;
304  v |= v >> 1;
305  v |= v >> 2;
306  v |= v >> 4;
307  v |= v >> 8;
308  v |= v >> 16;
309  v |= v >> 32;
310 
311  return v + 1;
312 }
313 
314 /*********** Macros for calculating min and max **********/
315 
319 #define RTE_MIN(a, b) \
320  __extension__ ({ \
321  typeof (a) _a = (a); \
322  typeof (b) _b = (b); \
323  _a < _b ? _a : _b; \
324  })
325 
329 #define RTE_MAX(a, b) \
330  __extension__ ({ \
331  typeof (a) _a = (a); \
332  typeof (b) _b = (b); \
333  _a > _b ? _a : _b; \
334  })
335 
336 /*********** Other general functions / macros ********/
337 
349 static inline uint32_t
350 rte_bsf32(uint32_t v)
351 {
352  return __builtin_ctz(v);
353 }
354 
363 static inline uint32_t
364 rte_log2_u32(uint32_t v)
365 {
366  if (v == 0)
367  return 0;
368  v = rte_align32pow2(v);
369  return rte_bsf32(v);
370 }
371 
372 #ifndef offsetof
373 
374 #define offsetof(TYPE, MEMBER) __builtin_offsetof (TYPE, MEMBER)
375 #endif
376 
391 #ifndef container_of
392 #define container_of(ptr, type, member) __extension__ ({ \
393  const typeof(((type *)0)->member) *_ptr = (ptr); \
394  __attribute__((unused)) type *_target_ptr = \
395  (type *)(ptr); \
396  (type *)(((uintptr_t)_ptr) - offsetof(type, member)); \
397  })
398 #endif
399 
400 #define _RTE_STR(x) #x
401 
402 #define RTE_STR(x) _RTE_STR(x)
403 
409 #define RTE_FMT(fmt, ...) fmt "%.0s", __VA_ARGS__ ""
410 #define RTE_FMT_HEAD(fmt, ...) fmt
411 #define RTE_FMT_TAIL(fmt, ...) __VA_ARGS__
412 
414 #define RTE_LEN2MASK(ln, tp) \
415  ((tp)((uint64_t)-1 >> (sizeof(uint64_t) * CHAR_BIT - (ln))))
416 
418 #define RTE_DIM(a) (sizeof (a) / sizeof ((a)[0]))
419 
434 static inline uint64_t
435 rte_str_to_size(const char *str)
436 {
437  char *endptr;
438  unsigned long long size;
439 
440  while (isspace((int)*str))
441  str++;
442  if (*str == '-')
443  return 0;
444 
445  errno = 0;
446  size = strtoull(str, &endptr, 0);
447  if (errno)
448  return 0;
449 
450  if (*endptr == ' ')
451  endptr++; /* allow 1 space gap */
452 
453  switch (*endptr){
454  case 'G': case 'g': size *= 1024; /* fall-through */
455  case 'M': case 'm': size *= 1024; /* fall-through */
456  case 'K': case 'k': size *= 1024; /* fall-through */
457  default:
458  break;
459  }
460  return size;
461 }
462 
476 void
477 rte_exit(int exit_code, const char *format, ...)
478  __attribute__((noreturn))
479  __attribute__((format(printf, 2, 3)));
480 
481 #ifdef __cplusplus
482 }
483 #endif
484 
485 #endif
static int rte_is_aligned(void *ptr, unsigned align)
Definition: rte_common.h:234
static uint64_t rte_align64pow2(uint64_t v)
Definition: rte_common.h:301
static uint32_t rte_log2_u32(uint32_t v)
Definition: rte_common.h:364
static uint32_t rte_bsf32(uint32_t v)
Definition: rte_common.h:350
static uint32_t rte_align32pow2(uint32_t x)
Definition: rte_common.h:279
uint64_t unaligned_uint64_t
Definition: rte_common.h:82
#define RTE_PTR_ALIGN(ptr, align)
Definition: rte_common.h:211
static int rte_is_power_of_2(uint32_t n)
Definition: rte_common.h:264
void rte_exit(int exit_code, const char *format,...)
static uint64_t rte_str_to_size(const char *str)
Definition: rte_common.h:435