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 ********/
97 * Function which rounds an unsigned int down to a given power-of-two value.
98 * Takes uintptr_t types as parameters, as this type of operation is most
99 * commonly done for pointer alignment. (See also RTE_ALIGN_FLOOR,
100 * RTE_ALIGN_CEIL, RTE_ALIGN, RTE_PTR_ALIGN_FLOOR, RTE_PTR_ALIGN_CEL,
101 * RTE_PTR_ALIGN macros)
103 * The value to be rounded down
105 * The power-of-two of which the result must be a multiple.
107 * Function returns a properly aligned value where align is a power-of-two.
108 * If align is not a power-of-two, result will be incorrect.
110 static inline uintptr_t
111 rte_align_floor_int(uintptr_t ptr, uintptr_t align)
113 return (ptr & ~(align - 1));
117 * Macro to align a pointer to a given power-of-two. The resultant
118 * pointer will be a pointer of the same type as the first parameter, and
119 * point to an address no higher than the first parameter. Second parameter
120 * must be a power-of-two value.
122 #define RTE_PTR_ALIGN_FLOOR(ptr, align) \
123 (typeof(ptr))rte_align_floor_int((uintptr_t)ptr, align)
126 * Macro to align a value to a given power-of-two. The resultant value
127 * will be of the same type as the first parameter, and will be no
128 * bigger than the first parameter. Second parameter must be a
129 * power-of-two value.
131 #define RTE_ALIGN_FLOOR(val, align) \
132 (typeof(val))((val) & (~((typeof(val))((align) - 1))))
135 * Macro to align a pointer to a given power-of-two. The resultant
136 * pointer will be a pointer of the same type as the first parameter, and
137 * point to an address no lower than the first parameter. Second parameter
138 * must be a power-of-two value.
140 #define RTE_PTR_ALIGN_CEIL(ptr, align) \
141 RTE_PTR_ALIGN_FLOOR((typeof(ptr))RTE_PTR_ADD(ptr, (align) - 1), align)
144 * Macro to align a value to a given power-of-two. The resultant value
145 * will be of the same type as the first parameter, and will be no lower
146 * than the first parameter. Second parameter must be a power-of-two
149 #define RTE_ALIGN_CEIL(val, align) \
150 RTE_ALIGN_FLOOR(((val) + ((typeof(val)) (align) - 1)), align)
153 * Macro to align a pointer to a given power-of-two. The resultant
154 * pointer will be a pointer of the same type as the first parameter, and
155 * point to an address no lower than the first parameter. Second parameter
156 * must be a power-of-two value.
157 * This function is the same as RTE_PTR_ALIGN_CEIL
159 #define RTE_PTR_ALIGN(ptr, align) RTE_PTR_ALIGN_CEIL(ptr, align)
162 * Macro to align a value to a given power-of-two. The resultant
163 * value will be of the same type as the first parameter, and
164 * will be no lower than the first parameter. Second parameter
165 * must be a power-of-two value.
166 * This function is the same as RTE_ALIGN_CEIL
168 #define RTE_ALIGN(val, align) RTE_ALIGN_CEIL(val, align)
171 * Checks if a pointer is aligned to a given power-of-two value
174 * The pointer whose alignment is to be checked
176 * The power-of-two value to which the ptr should be aligned
179 * True(1) where the pointer is correctly aligned, false(0) otherwise
182 rte_is_aligned(void *ptr, unsigned align)
184 return RTE_PTR_ALIGN(ptr, align) == ptr;
187 /*********** Macros for compile type checks ********/
190 * Triggers an error at compilation time if the condition is true.
193 #define RTE_BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
195 extern int RTE_BUILD_BUG_ON_detected_error;
196 #define RTE_BUILD_BUG_ON(condition) do { \
197 ((void)sizeof(char[1 - 2*!!(condition)])); \
199 RTE_BUILD_BUG_ON_detected_error = 1; \
203 /*********** Macros to work with powers of 2 ********/
206 * Returns true if n is a power of 2
209 * @return 1 if true, 0 otherwise
212 rte_is_power_of_2(uint32_t n)
214 return n && !(n & (n - 1));
218 * Aligns input parameter to the next power of 2
221 * The integer value to algin
224 * Input parameter aligned to the next power of 2
226 static inline uint32_t
227 rte_align32pow2(uint32_t x)
240 * Aligns 64b input parameter to the next power of 2
243 * The 64b value to algin
246 * Input parameter aligned to the next power of 2
248 static inline uint64_t
249 rte_align64pow2(uint64_t v)
262 /*********** Macros for calculating min and max **********/
265 * Macro to return the minimum of two numbers
267 #define RTE_MIN(a, b) ({ \
268 typeof (a) _a = (a); \
269 typeof (b) _b = (b); \
274 * Macro to return the maximum of two numbers
276 #define RTE_MAX(a, b) ({ \
277 typeof (a) _a = (a); \
278 typeof (b) _b = (b); \
282 /*********** Other general functions / macros ********/
285 #include <emmintrin.h>
287 * PAUSE instruction for tight loops (avoid busy waiting)
300 * Searches the input parameter for the least significant set bit
301 * (starting from zero).
302 * If a least significant 1 bit is found, its bit index is returned.
303 * If the content of the input parameter is zero, then the content of the return
304 * value is undefined.
306 * input parameter, should not be zero.
308 * least significant set bit in the input parameter.
310 static inline uint32_t
311 rte_bsf32(uint32_t v)
313 return (__builtin_ctz(v));
317 /** Return the offset of a field in a structure. */
318 #define offsetof(TYPE, MEMBER) __builtin_offsetof (TYPE, MEMBER)
321 #define _RTE_STR(x) #x
322 /** Take a macro value and get a string version of it */
323 #define RTE_STR(x) _RTE_STR(x)
325 /** Mask value of type <tp> for the first <ln> bit set. */
326 #define RTE_LEN2MASK(ln, tp) \
327 ((tp)((uint64_t)-1 >> (sizeof(uint64_t) * CHAR_BIT - (ln))))
329 /** Number of elements in the array. */
330 #define RTE_DIM(a) (sizeof (a) / sizeof ((a)[0]))
333 * Converts a numeric string to the equivalent uint64_t value.
334 * As well as straight number conversion, also recognises the suffixes
335 * k, m and g for kilobytes, megabytes and gigabytes respectively.
337 * If a negative number is passed in i.e. a string with the first non-black
338 * character being "-", zero is returned. Zero is also returned in the case of
339 * an error with the strtoull call in the function.
342 * String containing number to convert.
346 static inline uint64_t
347 rte_str_to_size(const char *str)
350 unsigned long long size;
352 while (isspace((int)*str))
358 size = strtoull(str, &endptr, 0);
363 endptr++; /* allow 1 space gap */
366 case 'G': case 'g': size *= 1024; /* fall-through */
367 case 'M': case 'm': size *= 1024; /* fall-through */
368 case 'K': case 'k': size *= 1024; /* fall-through */
376 * Function to terminate the application immediately, printing an error
377 * message and returning the exit_code back to the shell.
379 * This function never returns
382 * The exit code to be returned by the application
384 * The format string to be used for printing the message. This can include
385 * printf format characters which will be expanded using any further parameters
389 rte_exit(int exit_code, const char *format, ...)
390 __attribute__((noreturn))
391 __attribute__((format(printf, 2, 3)));