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 /*********** Macros to eliminate unused variable warnings ********/
65 * short definition to mark a function parameter unused
67 #define __rte_unused __attribute__((__unused__))
70 * definition to mark a variable or function parameter as used so
71 * as to avoid a compiler warning
73 #define RTE_SET_USED(x) (void)(x)
75 /*********** Macros for pointer arithmetic ********/
78 * add a byte-value offset from a pointer
80 #define RTE_PTR_ADD(ptr, x) ((void*)((uintptr_t)(ptr) + (x)))
83 * subtract a byte-value offset from a pointer
85 #define RTE_PTR_SUB(ptr, x) ((void*)((uintptr_t)ptr - (x)))
88 * get the difference between two pointer values, i.e. how far apart
89 * in bytes are the locations they point two. It is assumed that
90 * ptr1 is greater than ptr2.
92 #define RTE_PTR_DIFF(ptr1, ptr2) ((uintptr_t)(ptr1) - (uintptr_t)(ptr2))
94 /*********** Macros/static functions for doing alignment ********/
98 * Macro to align a pointer to a given power-of-two. The resultant
99 * pointer will be a pointer of the same type as the first parameter, and
100 * point to an address no higher than the first parameter. Second parameter
101 * must be a power-of-two value.
103 #define RTE_PTR_ALIGN_FLOOR(ptr, align) \
104 ((typeof(ptr))RTE_ALIGN_FLOOR((uintptr_t)ptr, align))
107 * Macro to align a value to a given power-of-two. The resultant value
108 * will be of the same type as the first parameter, and will be no
109 * bigger than the first parameter. Second parameter must be a
110 * power-of-two value.
112 #define RTE_ALIGN_FLOOR(val, align) \
113 (typeof(val))((val) & (~((typeof(val))((align) - 1))))
116 * Macro to align a pointer to a given power-of-two. The resultant
117 * pointer will be a pointer of the same type as the first parameter, and
118 * point to an address no lower than the first parameter. Second parameter
119 * must be a power-of-two value.
121 #define RTE_PTR_ALIGN_CEIL(ptr, align) \
122 RTE_PTR_ALIGN_FLOOR((typeof(ptr))RTE_PTR_ADD(ptr, (align) - 1), align)
125 * Macro to align a value to a given power-of-two. The resultant value
126 * will be of the same type as the first parameter, and will be no lower
127 * than the first parameter. Second parameter must be a power-of-two
130 #define RTE_ALIGN_CEIL(val, align) \
131 RTE_ALIGN_FLOOR(((val) + ((typeof(val)) (align) - 1)), align)
134 * Macro to align a pointer to a given power-of-two. The resultant
135 * pointer will be a pointer of the same type as the first parameter, and
136 * point to an address no lower than the first parameter. Second parameter
137 * must be a power-of-two value.
138 * This function is the same as RTE_PTR_ALIGN_CEIL
140 #define RTE_PTR_ALIGN(ptr, align) RTE_PTR_ALIGN_CEIL(ptr, align)
143 * Macro to align a value to a given power-of-two. The resultant
144 * value will be of the same type as the first parameter, and
145 * will be no lower than the first parameter. Second parameter
146 * must be a power-of-two value.
147 * This function is the same as RTE_ALIGN_CEIL
149 #define RTE_ALIGN(val, align) RTE_ALIGN_CEIL(val, align)
152 * Checks if a pointer is aligned to a given power-of-two value
155 * The pointer whose alignment is to be checked
157 * The power-of-two value to which the ptr should be aligned
160 * True(1) where the pointer is correctly aligned, false(0) otherwise
163 rte_is_aligned(void *ptr, unsigned align)
165 return RTE_PTR_ALIGN(ptr, align) == ptr;
168 /*********** Macros for compile type checks ********/
171 * Triggers an error at compilation time if the condition is true.
174 #define RTE_BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
176 extern int RTE_BUILD_BUG_ON_detected_error;
177 #define RTE_BUILD_BUG_ON(condition) do { \
178 ((void)sizeof(char[1 - 2*!!(condition)])); \
180 RTE_BUILD_BUG_ON_detected_error = 1; \
184 /*********** Macros to work with powers of 2 ********/
187 * Returns true if n is a power of 2
190 * @return 1 if true, 0 otherwise
193 rte_is_power_of_2(uint32_t n)
195 return n && !(n & (n - 1));
199 * Aligns input parameter to the next power of 2
202 * The integer value to algin
205 * Input parameter aligned to the next power of 2
207 static inline uint32_t
208 rte_align32pow2(uint32_t x)
221 * Aligns 64b input parameter to the next power of 2
224 * The 64b value to algin
227 * Input parameter aligned to the next power of 2
229 static inline uint64_t
230 rte_align64pow2(uint64_t v)
243 /*********** Macros for calculating min and max **********/
246 * Macro to return the minimum of two numbers
248 #define RTE_MIN(a, b) ({ \
249 typeof (a) _a = (a); \
250 typeof (b) _b = (b); \
255 * Macro to return the maximum of two numbers
257 #define RTE_MAX(a, b) ({ \
258 typeof (a) _a = (a); \
259 typeof (b) _b = (b); \
263 /*********** Other general functions / macros ********/
266 #include <emmintrin.h>
268 * PAUSE instruction for tight loops (avoid busy waiting)
281 * Searches the input parameter for the least significant set bit
282 * (starting from zero).
283 * If a least significant 1 bit is found, its bit index is returned.
284 * If the content of the input parameter is zero, then the content of the return
285 * value is undefined.
287 * input parameter, should not be zero.
289 * least significant set bit in the input parameter.
291 static inline uint32_t
292 rte_bsf32(uint32_t v)
294 return (__builtin_ctz(v));
298 /** Return the offset of a field in a structure. */
299 #define offsetof(TYPE, MEMBER) __builtin_offsetof (TYPE, MEMBER)
302 #define _RTE_STR(x) #x
303 /** Take a macro value and get a string version of it */
304 #define RTE_STR(x) _RTE_STR(x)
306 /** Mask value of type <tp> for the first <ln> bit set. */
307 #define RTE_LEN2MASK(ln, tp) \
308 ((tp)((uint64_t)-1 >> (sizeof(uint64_t) * CHAR_BIT - (ln))))
310 /** Number of elements in the array. */
311 #define RTE_DIM(a) (sizeof (a) / sizeof ((a)[0]))
314 * Converts a numeric string to the equivalent uint64_t value.
315 * As well as straight number conversion, also recognises the suffixes
316 * k, m and g for kilobytes, megabytes and gigabytes respectively.
318 * If a negative number is passed in i.e. a string with the first non-black
319 * character being "-", zero is returned. Zero is also returned in the case of
320 * an error with the strtoull call in the function.
323 * String containing number to convert.
327 static inline uint64_t
328 rte_str_to_size(const char *str)
331 unsigned long long size;
333 while (isspace((int)*str))
339 size = strtoull(str, &endptr, 0);
344 endptr++; /* allow 1 space gap */
347 case 'G': case 'g': size *= 1024; /* fall-through */
348 case 'M': case 'm': size *= 1024; /* fall-through */
349 case 'K': case 'k': size *= 1024; /* fall-through */
357 * Function to terminate the application immediately, printing an error
358 * message and returning the exit_code back to the shell.
360 * This function never returns
363 * The exit code to be returned by the application
365 * The format string to be used for printing the message. This can include
366 * printf format characters which will be expanded using any further parameters
370 rte_exit(int exit_code, const char *format, ...)
371 __attribute__((noreturn))
372 __attribute__((format(printf, 2, 3)));