4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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
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.
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.
34 #ifndef _RTE_COMMON_H_
35 #define _RTE_COMMON_H_
40 * Generic, commonly-used macro and inline function definitions
55 #define typeof __typeof__
62 /** C extension macro for environments lacking C11 features. */
63 #if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 201112L
64 #define RTE_STD_C11 __extension__
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)));
74 typedef uint64_t unaligned_uint64_t;
75 typedef uint32_t unaligned_uint32_t;
76 typedef uint16_t unaligned_uint16_t;
82 #define __rte_aligned(a) __attribute__((__aligned__(a)))
85 * Force a structure to be packed
87 #define __rte_packed __attribute__((__packed__))
89 /******* Macro to mark functions and fields scheduled for removal *****/
90 #define __rte_deprecated __attribute__((__deprecated__))
92 /*********** Macros to eliminate unused variable warnings ********/
95 * short definition to mark a function parameter unused
97 #define __rte_unused __attribute__((__unused__))
100 * definition to mark a variable or function parameter as used so
101 * as to avoid a compiler warning
103 #define RTE_SET_USED(x) (void)(x)
105 /*********** Macros for pointer arithmetic ********/
108 * add a byte-value offset from a pointer
110 #define RTE_PTR_ADD(ptr, x) ((void*)((uintptr_t)(ptr) + (x)))
113 * subtract a byte-value offset from a pointer
115 #define RTE_PTR_SUB(ptr, x) ((void*)((uintptr_t)ptr - (x)))
118 * get the difference between two pointer values, i.e. how far apart
119 * in bytes are the locations they point two. It is assumed that
120 * ptr1 is greater than ptr2.
122 #define RTE_PTR_DIFF(ptr1, ptr2) ((uintptr_t)(ptr1) - (uintptr_t)(ptr2))
124 /*********** Macros/static functions for doing alignment ********/
128 * Macro to align a pointer to a given power-of-two. The resultant
129 * pointer will be a pointer of the same type as the first parameter, and
130 * point to an address no higher than the first parameter. Second parameter
131 * must be a power-of-two value.
133 #define RTE_PTR_ALIGN_FLOOR(ptr, align) \
134 ((typeof(ptr))RTE_ALIGN_FLOOR((uintptr_t)ptr, align))
137 * Macro to align a value to a given power-of-two. The resultant value
138 * will be of the same type as the first parameter, and will be no
139 * bigger than the first parameter. Second parameter must be a
140 * power-of-two value.
142 #define RTE_ALIGN_FLOOR(val, align) \
143 (typeof(val))((val) & (~((typeof(val))((align) - 1))))
146 * Macro to align a pointer to a given power-of-two. The resultant
147 * pointer will be a pointer of the same type as the first parameter, and
148 * point to an address no lower than the first parameter. Second parameter
149 * must be a power-of-two value.
151 #define RTE_PTR_ALIGN_CEIL(ptr, align) \
152 RTE_PTR_ALIGN_FLOOR((typeof(ptr))RTE_PTR_ADD(ptr, (align) - 1), align)
155 * Macro to align a value to a given power-of-two. The resultant value
156 * will be of the same type as the first parameter, and will be no lower
157 * than the first parameter. Second parameter must be a power-of-two
160 #define RTE_ALIGN_CEIL(val, align) \
161 RTE_ALIGN_FLOOR(((val) + ((typeof(val)) (align) - 1)), align)
164 * Macro to align a pointer to a given power-of-two. The resultant
165 * pointer will be a pointer of the same type as the first parameter, and
166 * point to an address no lower than the first parameter. Second parameter
167 * must be a power-of-two value.
168 * This function is the same as RTE_PTR_ALIGN_CEIL
170 #define RTE_PTR_ALIGN(ptr, align) RTE_PTR_ALIGN_CEIL(ptr, align)
173 * Macro to align a value to a given power-of-two. The resultant
174 * value will be of the same type as the first parameter, and
175 * will be no lower than the first parameter. Second parameter
176 * must be a power-of-two value.
177 * This function is the same as RTE_ALIGN_CEIL
179 #define RTE_ALIGN(val, align) RTE_ALIGN_CEIL(val, align)
182 * Checks if a pointer is aligned to a given power-of-two value
185 * The pointer whose alignment is to be checked
187 * The power-of-two value to which the ptr should be aligned
190 * True(1) where the pointer is correctly aligned, false(0) otherwise
193 rte_is_aligned(void *ptr, unsigned align)
195 return RTE_PTR_ALIGN(ptr, align) == ptr;
198 /*********** Macros for compile type checks ********/
201 * Triggers an error at compilation time if the condition is true.
204 #define RTE_BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
206 extern int RTE_BUILD_BUG_ON_detected_error;
207 #define RTE_BUILD_BUG_ON(condition) do { \
208 ((void)sizeof(char[1 - 2*!!(condition)])); \
210 RTE_BUILD_BUG_ON_detected_error = 1; \
214 /*********** Macros to work with powers of 2 ********/
217 * Returns true if n is a power of 2
220 * @return 1 if true, 0 otherwise
223 rte_is_power_of_2(uint32_t n)
225 return n && !(n & (n - 1));
229 * Aligns input parameter to the next power of 2
232 * The integer value to algin
235 * Input parameter aligned to the next power of 2
237 static inline uint32_t
238 rte_align32pow2(uint32_t x)
251 * Aligns 64b input parameter to the next power of 2
254 * The 64b value to align
257 * Input parameter aligned to the next power of 2
259 static inline uint64_t
260 rte_align64pow2(uint64_t v)
273 /*********** Macros for calculating min and max **********/
276 * Macro to return the minimum of two numbers
278 #define RTE_MIN(a, b) \
280 typeof (a) _a = (a); \
281 typeof (b) _b = (b); \
286 * Macro to return the maximum of two numbers
288 #define RTE_MAX(a, b) \
290 typeof (a) _a = (a); \
291 typeof (b) _b = (b); \
295 /*********** Other general functions / macros ********/
298 #include <emmintrin.h>
300 * PAUSE instruction for tight loops (avoid busy waiting)
313 * Searches the input parameter for the least significant set bit
314 * (starting from zero).
315 * If a least significant 1 bit is found, its bit index is returned.
316 * If the content of the input parameter is zero, then the content of the return
317 * value is undefined.
319 * input parameter, should not be zero.
321 * least significant set bit in the input parameter.
323 static inline uint32_t
324 rte_bsf32(uint32_t v)
326 return __builtin_ctz(v);
330 /** Return the offset of a field in a structure. */
331 #define offsetof(TYPE, MEMBER) __builtin_offsetof (TYPE, MEMBER)
335 * Return pointer to the wrapping struct instance.
345 * struct child *x = obtain(...);
346 * struct wrapper *w = container_of(x, struct wrapper, c);
349 #define container_of(ptr, type, member) __extension__ ({ \
350 typeof(((type *)0)->member) *_ptr = (ptr); \
351 (type *)(((char *)_ptr) - offsetof(type, member)); })
354 #define _RTE_STR(x) #x
355 /** Take a macro value and get a string version of it */
356 #define RTE_STR(x) _RTE_STR(x)
359 * ISO C helpers to modify format strings using variadic macros.
360 * This is a replacement for the ", ## __VA_ARGS__" GNU extension.
361 * An empty %s argument is appended to avoid a dangling comma.
363 #define RTE_FMT(fmt, ...) fmt "%.0s", __VA_ARGS__ ""
364 #define RTE_FMT_HEAD(fmt, ...) fmt
365 #define RTE_FMT_TAIL(fmt, ...) __VA_ARGS__
367 /** Mask value of type "tp" for the first "ln" bit set. */
368 #define RTE_LEN2MASK(ln, tp) \
369 ((tp)((uint64_t)-1 >> (sizeof(uint64_t) * CHAR_BIT - (ln))))
371 /** Number of elements in the array. */
372 #define RTE_DIM(a) (sizeof (a) / sizeof ((a)[0]))
375 * Converts a numeric string to the equivalent uint64_t value.
376 * As well as straight number conversion, also recognises the suffixes
377 * k, m and g for kilobytes, megabytes and gigabytes respectively.
379 * If a negative number is passed in i.e. a string with the first non-black
380 * character being "-", zero is returned. Zero is also returned in the case of
381 * an error with the strtoull call in the function.
384 * String containing number to convert.
388 static inline uint64_t
389 rte_str_to_size(const char *str)
392 unsigned long long size;
394 while (isspace((int)*str))
400 size = strtoull(str, &endptr, 0);
405 endptr++; /* allow 1 space gap */
408 case 'G': case 'g': size *= 1024; /* fall-through */
409 case 'M': case 'm': size *= 1024; /* fall-through */
410 case 'K': case 'k': size *= 1024; /* fall-through */
418 * Function to terminate the application immediately, printing an error
419 * message and returning the exit_code back to the shell.
421 * This function never returns
424 * The exit code to be returned by the application
426 * The format string to be used for printing the message. This can include
427 * printf format characters which will be expanded using any further parameters
431 rte_exit(int exit_code, const char *format, ...)
432 __attribute__((noreturn))
433 __attribute__((format(printf, 2, 3)));