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
53 /*********** Macros to eliminate unused variable warnings ********/
56 * short definition to mark a function parameter unused
58 #define __rte_unused __attribute__((__unused__))
61 * definition to mark a variable or function parameter as used so
62 * as to avoid a compiler warning
64 #define RTE_SET_USED(x) (void)(x)
66 /*********** Macros for pointer arithmetic ********/
69 * add a byte-value offset from a pointer
71 #define RTE_PTR_ADD(ptr, x) ((typeof(ptr))((uintptr_t)ptr + (x)))
74 * subtract a byte-value offset from a pointer
76 #define RTE_PTR_SUB(ptr, x) ((typeof(ptr))((uintptr_t)ptr - (x)))
79 * get the difference between two pointer values, i.e. how far apart
80 * in bytes are the locations they point two. It is assumed that
81 * ptr1 is greater than ptr2.
83 #define RTE_PTR_DIFF(ptr1, ptr2) ((uintptr_t)(ptr1) - (uintptr_t)(ptr2))
85 /*********** Macros/static functions for doing alignment ********/
88 * Function which rounds an unsigned int down to a given power-of-two value.
89 * Takes uintptr_t types as parameters, as this type of operation is most
90 * commonly done for pointer alignment. (See also RTE_ALIGN_FLOOR,
91 * RTE_ALIGN_CEIL, RTE_ALIGN, RTE_PTR_ALIGN_FLOOR, RTE_PTR_ALIGN_CEL,
92 * RTE_PTR_ALIGN macros)
94 * The value to be rounded down
96 * The power-of-two of which the result must be a multiple.
98 * Function returns a properly aligned value where align is a power-of-two.
99 * If align is not a power-of-two, result will be incorrect.
101 static inline uintptr_t
102 rte_align_floor_int(uintptr_t ptr, uintptr_t align)
104 return (ptr & ~(align - 1));
108 * Macro to align a pointer to a given power-of-two. The resultant
109 * pointer will be a pointer of the same type as the first parameter, and
110 * point to an address no higher than the first parameter. Second parameter
111 * must be a power-of-two value.
113 #define RTE_PTR_ALIGN_FLOOR(ptr, align) \
114 (typeof(ptr))rte_align_floor_int((uintptr_t)ptr, align)
117 * Macro to align a value to a given power-of-two. The resultant value
118 * will be of the same type as the first parameter, and will be no
119 * bigger than the first parameter. Second parameter must be a
120 * power-of-two value.
122 #define RTE_ALIGN_FLOOR(val, align) \
123 (typeof(val))((val) & (~((typeof(val))((align) - 1))))
126 * Macro to align a pointer to a given power-of-two. The resultant
127 * pointer will be a pointer of the same type as the first parameter, and
128 * point to an address no lower than the first parameter. Second parameter
129 * must be a power-of-two value.
131 #define RTE_PTR_ALIGN_CEIL(ptr, align) \
132 RTE_PTR_ALIGN_FLOOR(RTE_PTR_ADD(ptr, (align) - 1), align)
135 * Macro to align a value to a given power-of-two. The resultant value
136 * will be of the same type as the first parameter, and will be no lower
137 * than the first parameter. Second parameter must be a power-of-two
140 #define RTE_ALIGN_CEIL(val, align) \
141 RTE_ALIGN_FLOOR(((val) + ((typeof(val)) (align) - 1)), align)
144 * Macro to align a pointer to a given power-of-two. The resultant
145 * pointer will be a pointer of the same type as the first parameter, and
146 * point to an address no lower than the first parameter. Second parameter
147 * must be a power-of-two value.
148 * This function is the same as RTE_PTR_ALIGN_CEIL
150 #define RTE_PTR_ALIGN(ptr, align) RTE_PTR_ALIGN_CEIL(ptr, align)
153 * Macro to align a value to a given power-of-two. The resultant
154 * value will be of the same type as the first parameter, and
155 * will be no lower than the first parameter. Second parameter
156 * must be a power-of-two value.
157 * This function is the same as RTE_ALIGN_CEIL
159 #define RTE_ALIGN(val, align) RTE_ALIGN_CEIL(val, align)
162 * Checks if a pointer is aligned to a given power-of-two value
165 * The pointer whose alignment is to be checked
167 * The power-of-two value to which the ptr should be aligned
170 * True(1) where the pointer is correctly aligned, false(0) otherwise
173 rte_is_aligned(void *ptr, unsigned align)
175 return RTE_PTR_ALIGN(ptr, align) == ptr;
178 /*********** Macros for compile type checks ********/
181 * Triggers an error at compilation time if the condition is true.
184 #define RTE_BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
186 extern int RTE_BUILD_BUG_ON_detected_error;
187 #define RTE_BUILD_BUG_ON(condition) do { \
188 ((void)sizeof(char[1 - 2*!!(condition)])); \
190 RTE_BUILD_BUG_ON_detected_error = 1; \
194 /*********** Macros to work with powers of 2 ********/
197 * Returns true if n is a power of 2
200 * @return 1 if true, 0 otherwise
203 rte_is_power_of_2(uint32_t n)
205 return ((n-1) & n) == 0;
209 * Aligns input parameter to the next power of 2
212 * The integer value to algin
215 * Input parameter aligned to the next power of 2
217 static inline uint32_t
218 rte_align32pow2(uint32_t x)
230 /*********** Macros for calculating min and max **********/
233 * Macro to return the minimum of two numbers
235 #define RTE_MIN(a, b) ({ \
236 typeof (a) _a = (a); \
237 typeof (b) _b = (b); \
242 * Macro to return the maximum of two numbers
244 #define RTE_MAX(a, b) ({ \
245 typeof (a) _a = (a); \
246 typeof (b) _b = (b); \
250 /*********** Other general functions / macros ********/
253 #include <emmintrin.h>
255 * PAUSE instruction for tight loops (avoid busy waiting)
268 * Searches the input parameter for the least significant set bit
269 * (starting from zero).
270 * If a least significant 1 bit is found, its bit index is returned.
271 * If the content of the input parameter is zero, then the content of the return
272 * value is undefined.
274 * input parameter, should not be zero.
276 * least significant set bit in the input parameter.
278 static inline uint32_t
279 rte_bsf32(uint32_t v)
281 return (__builtin_ctz(v));
285 /** Return the offset of a field in a structure. */
286 #define offsetof(TYPE, MEMBER) __builtin_offsetof (TYPE, MEMBER)
289 #define _RTE_STR(x) #x
290 /** Take a macro value and get a string version of it */
291 #define RTE_STR(x) _RTE_STR(x)
294 * Converts a numeric string to the equivalent uint64_t value.
295 * As well as straight number conversion, also recognises the suffixes
296 * k, m and g for kilobytes, megabytes and gigabytes respectively.
298 * If a negative number is passed in i.e. a string with the first non-black
299 * character being "-", zero is returned. Zero is also returned in the case of
300 * an error with the strtoull call in the function.
303 * String containing number to convert.
307 static inline uint64_t
308 rte_str_to_size(const char *str)
311 unsigned long long size;
313 while (isspace((int)*str))
319 size = strtoull(str, &endptr, 0);
324 endptr++; /* allow 1 space gap */
327 case 'G': case 'g': size *= 1024; /* fall-through */
328 case 'M': case 'm': size *= 1024; /* fall-through */
329 case 'K': case 'k': size *= 1024; /* fall-through */
337 * Function to terminate the application immediately, printing an error
338 * message and returning the exit_code back to the shell.
340 * This function never returns
343 * The exit code to be returned by the application
345 * The format string to be used for printing the message. This can include
346 * printf format characters which will be expanded using any further parameters
350 rte_exit(int exit_code, const char *format, ...)
351 __attribute__((noreturn))
352 __attribute__((format(printf, 2, 3)));