DPDK  16.11.9
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 #ifndef typeof
55 #define typeof __typeof__
56 #endif
57 
58 #ifndef asm
59 #define asm __asm__
60 #endif
61 
63 #if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 201112L
64 #define RTE_STD_C11 __extension__
65 #else
66 #define RTE_STD_C11
67 #endif
68 
69 #ifdef RTE_ARCH_STRICT_ALIGN
70 typedef uint64_t unaligned_uint64_t __attribute__ ((aligned(1)));
71 typedef uint32_t unaligned_uint32_t __attribute__ ((aligned(1)));
72 typedef uint16_t unaligned_uint16_t __attribute__ ((aligned(1)));
73 #else
74 typedef uint64_t unaligned_uint64_t;
75 typedef uint32_t unaligned_uint32_t;
76 typedef uint16_t unaligned_uint16_t;
77 #endif
78 
82 #define __rte_aligned(a) __attribute__((__aligned__(a)))
83 
87 #define __rte_packed __attribute__((__packed__))
88 
89 /******* Macro to mark functions and fields scheduled for removal *****/
90 #define __rte_deprecated __attribute__((__deprecated__))
91 
92 /*********** Macros to eliminate unused variable warnings ********/
93 
97 #define __rte_unused __attribute__((__unused__))
98 
103 #define RTE_SET_USED(x) (void)(x)
104 
105 /*********** Macros for pointer arithmetic ********/
106 
110 #define RTE_PTR_ADD(ptr, x) ((void*)((uintptr_t)(ptr) + (x)))
111 
115 #define RTE_PTR_SUB(ptr, x) ((void*)((uintptr_t)ptr - (x)))
116 
122 #define RTE_PTR_DIFF(ptr1, ptr2) ((uintptr_t)(ptr1) - (uintptr_t)(ptr2))
123 
124 /*********** Macros/static functions for doing alignment ********/
125 
126 
133 #define RTE_PTR_ALIGN_FLOOR(ptr, align) \
134  ((typeof(ptr))RTE_ALIGN_FLOOR((uintptr_t)ptr, align))
135 
142 #define RTE_ALIGN_FLOOR(val, align) \
143  (typeof(val))((val) & (~((typeof(val))((align) - 1))))
144 
151 #define RTE_PTR_ALIGN_CEIL(ptr, align) \
152  RTE_PTR_ALIGN_FLOOR((typeof(ptr))RTE_PTR_ADD(ptr, (align) - 1), align)
153 
160 #define RTE_ALIGN_CEIL(val, align) \
161  RTE_ALIGN_FLOOR(((val) + ((typeof(val)) (align) - 1)), align)
162 
170 #define RTE_PTR_ALIGN(ptr, align) RTE_PTR_ALIGN_CEIL(ptr, align)
171 
179 #define RTE_ALIGN(val, align) RTE_ALIGN_CEIL(val, align)
180 
192 static inline int
193 rte_is_aligned(void *ptr, unsigned align)
194 {
195  return RTE_PTR_ALIGN(ptr, align) == ptr;
196 }
197 
198 /*********** Macros for compile type checks ********/
199 
203 #define RTE_BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
204 
205 /*********** Macros to work with powers of 2 ********/
206 
213 static inline int
214 rte_is_power_of_2(uint32_t n)
215 {
216  return n && !(n & (n - 1));
217 }
218 
228 static inline uint32_t
229 rte_align32pow2(uint32_t x)
230 {
231  x--;
232  x |= x >> 1;
233  x |= x >> 2;
234  x |= x >> 4;
235  x |= x >> 8;
236  x |= x >> 16;
237 
238  return x + 1;
239 }
240 
250 static inline uint64_t
251 rte_align64pow2(uint64_t v)
252 {
253  v--;
254  v |= v >> 1;
255  v |= v >> 2;
256  v |= v >> 4;
257  v |= v >> 8;
258  v |= v >> 16;
259  v |= v >> 32;
260 
261  return v + 1;
262 }
263 
264 /*********** Macros for calculating min and max **********/
265 
269 #define RTE_MIN(a, b) \
270  __extension__ ({ \
271  typeof (a) _a = (a); \
272  typeof (b) _b = (b); \
273  _a < _b ? _a : _b; \
274  })
275 
279 #define RTE_MAX(a, b) \
280  __extension__ ({ \
281  typeof (a) _a = (a); \
282  typeof (b) _b = (b); \
283  _a > _b ? _a : _b; \
284  })
285 
286 /*********** Other general functions / macros ********/
287 
288 #ifdef __SSE2__
289 #include <emmintrin.h>
293 static inline void
294 rte_pause (void)
295 {
296  _mm_pause();
297 }
298 #else
299 static inline void
300 rte_pause(void) {}
301 #endif
302 
314 static inline uint32_t
315 rte_bsf32(uint32_t v)
316 {
317  return (uint32_t)__builtin_ctz(v);
318 }
319 
331 static inline int
332 rte_fls_u32(uint32_t x)
333 {
334  return (x == 0) ? 0 : 32 - __builtin_clz(x);
335 }
336 
337 #ifndef offsetof
338 
339 #define offsetof(TYPE, MEMBER) __builtin_offsetof (TYPE, MEMBER)
340 #endif
341 
342 #define _RTE_STR(x) #x
343 
344 #define RTE_STR(x) _RTE_STR(x)
345 
351 #define RTE_FMT(fmt, ...) fmt "%.0s", __VA_ARGS__ ""
352 #define RTE_FMT_HEAD(fmt, ...) fmt
353 #define RTE_FMT_TAIL(fmt, ...) __VA_ARGS__
354 
356 #define RTE_LEN2MASK(ln, tp) \
357  ((tp)((uint64_t)-1 >> (sizeof(uint64_t) * CHAR_BIT - (ln))))
358 
360 #define RTE_DIM(a) (sizeof (a) / sizeof ((a)[0]))
361 
376 static inline uint64_t
377 rte_str_to_size(const char *str)
378 {
379  char *endptr;
380  unsigned long long size;
381 
382  while (isspace((int)*str))
383  str++;
384  if (*str == '-')
385  return 0;
386 
387  errno = 0;
388  size = strtoull(str, &endptr, 0);
389  if (errno)
390  return 0;
391 
392  if (*endptr == ' ')
393  endptr++; /* allow 1 space gap */
394 
395  switch (*endptr){
396  case 'G': case 'g': size *= 1024; /* fall-through */
397  case 'M': case 'm': size *= 1024; /* fall-through */
398  case 'K': case 'k': size *= 1024; /* fall-through */
399  default:
400  break;
401  }
402  return size;
403 }
404 
418 void
419 rte_exit(int exit_code, const char *format, ...)
420  __attribute__((noreturn))
421  __attribute__((format(printf, 2, 3)));
422 
423 #ifdef __cplusplus
424 }
425 #endif
426 
427 #endif