lib/librte_eal/common/include/rte_common.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2013 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  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
  16  *       distribution.
  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.
  20  *
  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.
  32  */
  33
  34 #ifndef _RTE_COMMON_H_
  35 #define _RTE_COMMON_H_
  36
  37 /**
  38  * @file
  39  *
  40  * Generic, commonly-used macro and inline function definitions
  41  * for Intel DPDK.
  42  */
  43
  44 #ifdef __cplusplus
  45 extern "C" {
  46 #endif
  47
  48 #include <stdint.h>
  49 #include <stdlib.h>
  50 #include <ctype.h>
  51 #include <errno.h>
  52 #include <emmintrin.h>
  53
  54 /*********** Macros to eliminate unused variable warnings ********/
  55
  56 /**
  57  * short definition to mark a function parameter unused
  58  */
  59 #define __rte_unused __attribute__((__unused__))
  60
  61 /**
  62  * definition to mark a variable or function parameter as used so
  63  * as to avoid a compiler warning
  64  */
  65 #define RTE_SET_USED(x) (void)(x)
  66
  67 /*********** Macros for pointer arithmetic ********/
  68
  69 /**
  70  * add a byte-value offset from a pointer
  71  */
  72 #define RTE_PTR_ADD(ptr, x) ((typeof(ptr))((uintptr_t)ptr + (x)))
  73
  74 /**
  75  * subtract a byte-value offset from a pointer
  76  */
  77 #define RTE_PTR_SUB(ptr, x) ((typeof(ptr))((uintptr_t)ptr - (x)))
  78
  79 /**
  80  * get the difference between two pointer values, i.e. how far apart
  81  * in bytes are the locations they point two. It is assumed that
  82  * ptr1 is greater than ptr2.
  83  */
  84 #define RTE_PTR_DIFF(ptr1, ptr2) ((uintptr_t)(ptr1) - (uintptr_t)(ptr2))
  85
  86 /*********** Macros/static functions for doing alignment ********/
  87
  88 /**
  89  * Function which rounds an unsigned int down to a given power-of-two value.
  90  * Takes uintptr_t types as parameters, as this type of operation is most
  91  * commonly done for pointer alignment. (See also RTE_ALIGN_FLOOR,
  92  * RTE_ALIGN_CEIL, RTE_ALIGN, RTE_PTR_ALIGN_FLOOR, RTE_PTR_ALIGN_CEL,
  93  * RTE_PTR_ALIGN macros)
  94  * @param ptr
  95  *   The value to be rounded down
  96  * @param align
  97  *   The power-of-two of which the result must be a multiple.
  98  * @return
  99  *   Function returns a properly aligned value where align is a power-of-two.
 100  *   If align is not a power-of-two, result will be incorrect.
 101  */
 102 static inline uintptr_t
 103 rte_align_floor_int(uintptr_t ptr, uintptr_t align)
 104 {
 105         return (ptr & ~(align - 1));
 106 }
 107
 108 /**
 109  * Macro to align a pointer to a given power-of-two. The resultant
 110  * pointer will be a pointer of the same type as the first parameter, and
 111  * point to an address no higher than the first parameter. Second parameter
 112  * must be a power-of-two value.
 113  */
 114 #define RTE_PTR_ALIGN_FLOOR(ptr, align) \
 115         (typeof(ptr))rte_align_floor_int((uintptr_t)ptr, align)
 116
 117 /**
 118  * Macro to align a value to a given power-of-two. The resultant value
 119  * will be of the same type as the first parameter, and will be no
 120  * bigger than the first parameter. Second parameter must be a
 121  * power-of-two value.
 122  */
 123 #define RTE_ALIGN_FLOOR(val, align) \
 124         (typeof(val))((val) & (~((typeof(val))((align) - 1))))
 125
 126 /**
 127  * Macro to align a pointer to a given power-of-two. The resultant
 128  * pointer will be a pointer of the same type as the first parameter, and
 129  * point to an address no lower than the first parameter. Second parameter
 130  * must be a power-of-two value.
 131  */
 132 #define RTE_PTR_ALIGN_CEIL(ptr, align) \
 133         RTE_PTR_ALIGN_FLOOR(RTE_PTR_ADD(ptr, (align) - 1), align)
 134
 135 /**
 136  * Macro to align a value to a given power-of-two. The resultant value
 137  * will be of the same type as the first parameter, and will be no lower
 138  * than the first parameter. Second parameter must be a power-of-two
 139  * value.
 140  */
 141 #define RTE_ALIGN_CEIL(val, align) \
 142         RTE_ALIGN_FLOOR(((val) + ((typeof(val)) (align) - 1)), align)
 143
 144 /**
 145  * Macro to align a pointer to a given power-of-two. The resultant
 146  * pointer will be a pointer of the same type as the first parameter, and
 147  * point to an address no lower than the first parameter. Second parameter
 148  * must be a power-of-two value.
 149  * This function is the same as RTE_PTR_ALIGN_CEIL
 150  */
 151 #define RTE_PTR_ALIGN(ptr, align) RTE_PTR_ALIGN_CEIL(ptr, align)
 152
 153 /**
 154  * Macro to align a value to a given power-of-two. The resultant
 155  * value will be of the same type as the first parameter, and
 156  * will be no lower than the first parameter. Second parameter
 157  * must be a power-of-two value.
 158  * This function is the same as RTE_ALIGN_CEIL
 159  */
 160 #define RTE_ALIGN(val, align) RTE_ALIGN_CEIL(val, align)
 161
 162 /**
 163  * Checks if a pointer is aligned to a given power-of-two value
 164  *
 165  * @param ptr
 166  *   The pointer whose alignment is to be checked
 167  * @param align
 168  *   The power-of-two value to which the ptr should be aligned
 169  *
 170  * @return
 171  *   True(1) where the pointer is correctly aligned, false(0) otherwise
 172  */
 173 static inline int
 174 rte_is_aligned(void *ptr, unsigned align)
 175 {
 176         return RTE_PTR_ALIGN(ptr, align) == ptr;
 177 }
 178
 179 /*********** Macros for compile type checks ********/
 180
 181 /**
 182  * Triggers an error at compilation time if the condition is true.
 183  */
 184 #ifndef __OPTIMIZE__
 185 #define RTE_BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
 186 #else
 187 extern int RTE_BUILD_BUG_ON_detected_error;
 188 #define RTE_BUILD_BUG_ON(condition) do {             \
 189         ((void)sizeof(char[1 - 2*!!(condition)]));   \
 190         if (condition)                               \
 191                 RTE_BUILD_BUG_ON_detected_error = 1; \
 192 } while(0)
 193 #endif
 194
 195 /*********** Macros to work with powers of 2 ********/
 196
 197 /**
 198  * Returns true if n is a power of 2
 199  * @param n
 200  *     Number to check
 201  * @return 1 if true, 0 otherwise
 202  */
 203 static inline int
 204 rte_is_power_of_2(uint32_t n)
 205 {
 206         return ((n-1) & n) == 0;
 207 }
 208
 209 /**
 210  * Aligns input parameter to the next power of 2
 211  *
 212  * @param x
 213  *   The integer value to algin
 214  *
 215  * @return
 216  *   Input parameter aligned to the next power of 2
 217  */
 218 static inline uint32_t
 219 rte_align32pow2(uint32_t x)
 220 {
 221         x--;
 222         x |= x >> 1;
 223         x |= x >> 2;
 224         x |= x >> 4;
 225         x |= x >> 8;
 226         x |= x >> 16;
 227
 228         return x + 1;
 229 }
 230
 231 /*********** Macros for calculating min and max **********/
 232
 233 /**
 234  * Macro to return the minimum of two numbers
 235  */
 236 #define RTE_MIN(a, b) ({ \
 237                 typeof (a) _a = (a); \
 238                 typeof (b) _b = (b); \
 239                 _a < _b ? _a : _b; \
 240         })
 241
 242 /**
 243  * Macro to return the maximum of two numbers
 244  */
 245 #define RTE_MAX(a, b) ({ \
 246                 typeof (a) _a = (a); \
 247                 typeof (b) _b = (b); \
 248                 _a > _b ? _a : _b; \
 249         })
 250
 251 /*********** Other general functions / macros ********/
 252
 253 /**
 254  * PAUSE instruction for tight loops (avoid busy waiting)
 255  */
 256 static inline void
 257 rte_pause (void)
 258 {
 259         _mm_pause();
 260 }
 261
 262 /**
 263  * Searches the input parameter for the least significant set bit
 264  * (starting from zero).
 265  * If a least significant 1 bit is found, its bit index is returned.
 266  * If the content of the input parameter is zero, then the content of the return
 267  * value is undefined.
 268  * @param v
 269  *     input parameter, should not be zero.
 270  * @return
 271  *     least significant set bit in the input parameter.
 272  */
 273 static inline uint32_t
 274 rte_bsf32(uint32_t v)
 275 {
 276         return (__builtin_ctz(v));
 277 }
 278
 279 #ifndef offsetof
 280 /** Return the offset of a field in a structure. */
 281 #define offsetof(TYPE, MEMBER)  __builtin_offsetof (TYPE, MEMBER)
 282 #endif
 283
 284 #define _RTE_STR(x) #x
 285 /** Take a macro value and get a string version of it */
 286 #define RTE_STR(x) _RTE_STR(x)
 287
 288 /**
 289  * Converts a numeric string to the equivalent uint64_t value.
 290  * As well as straight number conversion, also recognises the suffixes
 291  * k, m and g for kilobytes, megabytes and gigabytes respectively.
 292  *
 293  * If a negative number is passed in  i.e. a string with the first non-black
 294  * character being "-", zero is returned. Zero is also returned in the case of
 295  * an error with the strtoull call in the function.
 296  *
 297  * @param str
 298  *     String containing number to convert.
 299  * @return
 300  *     Number.
 301  */
 302 static inline uint64_t
 303 rte_str_to_size(const char *str)
 304 {
 305         char *endptr;
 306         unsigned long long size;
 307
 308         while (isspace((int)*str))
 309                 str++;
 310         if (*str == '-')
 311                 return 0;
 312
 313         errno = 0;
 314         size = strtoull(str, &endptr, 0);
 315         if (errno)
 316                 return 0;
 317
 318         if (*endptr == ' ')
 319                 endptr++; /* allow 1 space gap */
 320
 321         switch (*endptr){
 322         case 'G': case 'g': size *= 1024; /* fall-through */
 323         case 'M': case 'm': size *= 1024; /* fall-through */
 324         case 'K': case 'k': size *= 1024; /* fall-through */
 325         default:
 326                 break;
 327         }
 328         return size;
 329 }
 330
 331 /**
 332  * Function to terminate the application immediately, printing an error
 333  * message and returning the exit_code back to the shell.
 334  *
 335  * This function never returns
 336  *
 337  * @param exit_code
 338  *     The exit code to be returned by the application
 339  * @param format
 340  *     The format string to be used for printing the message. This can include
 341  *     printf format characters which will be expanded using any further parameters
 342  *     to the function.
 343  */
 344 void
 345 rte_exit(int exit_code, const char *format, ...)
 346         __attribute__((noreturn))
 347         __attribute__((format(printf, 2, 3)));
 348
 349 #ifdef __cplusplus
 350 }
 351 #endif
 352
 353 #endif