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 #ifdef RTE_ARCH_STRICT_ALIGN
63 typedef uint64_t unaligned_uint64_t __attribute__ ((aligned(1)));
64 typedef uint32_t unaligned_uint32_t __attribute__ ((aligned(1)));
65 typedef uint16_t unaligned_uint16_t __attribute__ ((aligned(1)));
67 typedef uint64_t unaligned_uint64_t;
68 typedef uint32_t unaligned_uint32_t;
69 typedef uint16_t unaligned_uint16_t;
75 #define __rte_aligned(a) __attribute__((__aligned__(a)))
78 * Force a structure to be packed
80 #define __rte_packed __attribute__((__packed__))
82 /******* Macro to mark functions and fields scheduled for removal *****/
83 #define __rte_deprecated __attribute__((__deprecated__))
85 /*********** Macros to eliminate unused variable warnings ********/
88 * short definition to mark a function parameter unused
90 #define __rte_unused __attribute__((__unused__))
93 * definition to mark a variable or function parameter as used so
94 * as to avoid a compiler warning
96 #define RTE_SET_USED(x) (void)(x)
98 /*********** Macros for pointer arithmetic ********/
101 * add a byte-value offset from a pointer
103 #define RTE_PTR_ADD(ptr, x) ((void*)((uintptr_t)(ptr) + (x)))
106 * subtract a byte-value offset from a pointer
108 #define RTE_PTR_SUB(ptr, x) ((void*)((uintptr_t)ptr - (x)))
111 * get the difference between two pointer values, i.e. how far apart
112 * in bytes are the locations they point two. It is assumed that
113 * ptr1 is greater than ptr2.
115 #define RTE_PTR_DIFF(ptr1, ptr2) ((uintptr_t)(ptr1) - (uintptr_t)(ptr2))
117 /*********** Macros/static functions for doing alignment ********/
121 * Macro to align a pointer to a given power-of-two. The resultant
122 * pointer will be a pointer of the same type as the first parameter, and
123 * point to an address no higher than the first parameter. Second parameter
124 * must be a power-of-two value.
126 #define RTE_PTR_ALIGN_FLOOR(ptr, align) \
127 ((typeof(ptr))RTE_ALIGN_FLOOR((uintptr_t)ptr, align))
130 * Macro to align a value to a given power-of-two. The resultant value
131 * will be of the same type as the first parameter, and will be no
132 * bigger than the first parameter. Second parameter must be a
133 * power-of-two value.
135 #define RTE_ALIGN_FLOOR(val, align) \
136 (typeof(val))((val) & (~((typeof(val))((align) - 1))))
139 * Macro to align a pointer to a given power-of-two. The resultant
140 * pointer will be a pointer of the same type as the first parameter, and
141 * point to an address no lower than the first parameter. Second parameter
142 * must be a power-of-two value.
144 #define RTE_PTR_ALIGN_CEIL(ptr, align) \
145 RTE_PTR_ALIGN_FLOOR((typeof(ptr))RTE_PTR_ADD(ptr, (align) - 1), align)
148 * Macro to align a value to a given power-of-two. The resultant value
149 * will be of the same type as the first parameter, and will be no lower
150 * than the first parameter. Second parameter must be a power-of-two
153 #define RTE_ALIGN_CEIL(val, align) \
154 RTE_ALIGN_FLOOR(((val) + ((typeof(val)) (align) - 1)), align)
157 * Macro to align a pointer to a given power-of-two. The resultant
158 * pointer will be a pointer of the same type as the first parameter, and
159 * point to an address no lower than the first parameter. Second parameter
160 * must be a power-of-two value.
161 * This function is the same as RTE_PTR_ALIGN_CEIL
163 #define RTE_PTR_ALIGN(ptr, align) RTE_PTR_ALIGN_CEIL(ptr, align)
166 * Macro to align a value to a given power-of-two. The resultant
167 * value will be of the same type as the first parameter, and
168 * will be no lower than the first parameter. Second parameter
169 * must be a power-of-two value.
170 * This function is the same as RTE_ALIGN_CEIL
172 #define RTE_ALIGN(val, align) RTE_ALIGN_CEIL(val, align)
175 * Checks if a pointer is aligned to a given power-of-two value
178 * The pointer whose alignment is to be checked
180 * The power-of-two value to which the ptr should be aligned
183 * True(1) where the pointer is correctly aligned, false(0) otherwise
186 rte_is_aligned(void *ptr, unsigned align)
188 return RTE_PTR_ALIGN(ptr, align) == ptr;
191 /*********** Macros for compile type checks ********/
194 * Triggers an error at compilation time if the condition is true.
197 #define RTE_BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
199 extern int RTE_BUILD_BUG_ON_detected_error;
200 #define RTE_BUILD_BUG_ON(condition) do { \
201 ((void)sizeof(char[1 - 2*!!(condition)])); \
203 RTE_BUILD_BUG_ON_detected_error = 1; \
207 /*********** Macros to work with powers of 2 ********/
210 * Returns true if n is a power of 2
213 * @return 1 if true, 0 otherwise
216 rte_is_power_of_2(uint32_t n)
218 return n && !(n & (n - 1));
222 * Aligns input parameter to the next power of 2
225 * The integer value to algin
228 * Input parameter aligned to the next power of 2
230 static inline uint32_t
231 rte_align32pow2(uint32_t x)
244 * Aligns 64b input parameter to the next power of 2
247 * The 64b value to align
250 * Input parameter aligned to the next power of 2
252 static inline uint64_t
253 rte_align64pow2(uint64_t v)
266 /*********** Macros for calculating min and max **********/
269 * Macro to return the minimum of two numbers
271 #define RTE_MIN(a, b) ({ \
272 typeof (a) _a = (a); \
273 typeof (b) _b = (b); \
278 * Macro to return the maximum of two numbers
280 #define RTE_MAX(a, b) ({ \
281 typeof (a) _a = (a); \
282 typeof (b) _b = (b); \
286 /*********** Other general functions / macros ********/
289 #include <emmintrin.h>
291 * PAUSE instruction for tight loops (avoid busy waiting)
304 * Searches the input parameter for the least significant set bit
305 * (starting from zero).
306 * If a least significant 1 bit is found, its bit index is returned.
307 * If the content of the input parameter is zero, then the content of the return
308 * value is undefined.
310 * input parameter, should not be zero.
312 * least significant set bit in the input parameter.
314 static inline uint32_t
315 rte_bsf32(uint32_t v)
317 return __builtin_ctz(v);
321 /** Return the offset of a field in a structure. */
322 #define offsetof(TYPE, MEMBER) __builtin_offsetof (TYPE, MEMBER)
325 #define _RTE_STR(x) #x
326 /** Take a macro value and get a string version of it */
327 #define RTE_STR(x) _RTE_STR(x)
329 /** Mask value of type "tp" for the first "ln" bit set. */
330 #define RTE_LEN2MASK(ln, tp) \
331 ((tp)((uint64_t)-1 >> (sizeof(uint64_t) * CHAR_BIT - (ln))))
333 /** Number of elements in the array. */
334 #define RTE_DIM(a) (sizeof (a) / sizeof ((a)[0]))
337 * Converts a numeric string to the equivalent uint64_t value.
338 * As well as straight number conversion, also recognises the suffixes
339 * k, m and g for kilobytes, megabytes and gigabytes respectively.
341 * If a negative number is passed in i.e. a string with the first non-black
342 * character being "-", zero is returned. Zero is also returned in the case of
343 * an error with the strtoull call in the function.
346 * String containing number to convert.
350 static inline uint64_t
351 rte_str_to_size(const char *str)
354 unsigned long long size;
356 while (isspace((int)*str))
362 size = strtoull(str, &endptr, 0);
367 endptr++; /* allow 1 space gap */
370 case 'G': case 'g': size *= 1024; /* fall-through */
371 case 'M': case 'm': size *= 1024; /* fall-through */
372 case 'K': case 'k': size *= 1024; /* fall-through */
380 * Function to terminate the application immediately, printing an error
381 * message and returning the exit_code back to the shell.
383 * This function never returns
386 * The exit code to be returned by the application
388 * The format string to be used for printing the message. This can include
389 * printf format characters which will be expanded using any further parameters
393 rte_exit(int exit_code, const char *format, ...)
394 __attribute__((noreturn))
395 __attribute__((format(printf, 2, 3)));