lib/librte_eal/common/include/rte_common.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 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 <limits.h>
  53
  54 #ifndef typeof
  55 #define typeof __typeof__
  56 #endif
  57
  58 #ifndef asm
  59 #define asm __asm__
  60 #endif
  61
  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)));
  66 #else
  67 typedef uint64_t unaligned_uint64_t;
  68 typedef uint32_t unaligned_uint32_t;
  69 typedef uint16_t unaligned_uint16_t;
  70 #endif
  71
  72 /*********** Macros to eliminate unused variable warnings ********/
  73
  74 /**
  75  * short definition to mark a function parameter unused
  76  */
  77 #define __rte_unused __attribute__((__unused__))
  78
  79 /**
  80  * definition to mark a variable or function parameter as used so
  81  * as to avoid a compiler warning
  82  */
  83 #define RTE_SET_USED(x) (void)(x)
  84
  85 /*********** Macros for pointer arithmetic ********/
  86
  87 /**
  88  * add a byte-value offset from a pointer
  89  */
  90 #define RTE_PTR_ADD(ptr, x) ((void*)((uintptr_t)(ptr) + (x)))
  91
  92 /**
  93  * subtract a byte-value offset from a pointer
  94  */
  95 #define RTE_PTR_SUB(ptr, x) ((void*)((uintptr_t)ptr - (x)))
  96
  97 /**
  98  * get the difference between two pointer values, i.e. how far apart
  99  * in bytes are the locations they point two. It is assumed that
 100  * ptr1 is greater than ptr2.
 101  */
 102 #define RTE_PTR_DIFF(ptr1, ptr2) ((uintptr_t)(ptr1) - (uintptr_t)(ptr2))
 103
 104 /*********** Macros/static functions for doing alignment ********/
 105
 106
 107 /**
 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.
 112  */
 113 #define RTE_PTR_ALIGN_FLOOR(ptr, align) \
 114         ((typeof(ptr))RTE_ALIGN_FLOOR((uintptr_t)ptr, align))
 115
 116 /**
 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.
 121  */
 122 #define RTE_ALIGN_FLOOR(val, align) \
 123         (typeof(val))((val) & (~((typeof(val))((align) - 1))))
 124
 125 /**
 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.
 130  */
 131 #define RTE_PTR_ALIGN_CEIL(ptr, align) \
 132         RTE_PTR_ALIGN_FLOOR((typeof(ptr))RTE_PTR_ADD(ptr, (align) - 1), align)
 133
 134 /**
 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
 138  * value.
 139  */
 140 #define RTE_ALIGN_CEIL(val, align) \
 141         RTE_ALIGN_FLOOR(((val) + ((typeof(val)) (align) - 1)), align)
 142
 143 /**
 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
 149  */
 150 #define RTE_PTR_ALIGN(ptr, align) RTE_PTR_ALIGN_CEIL(ptr, align)
 151
 152 /**
 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
 158  */
 159 #define RTE_ALIGN(val, align) RTE_ALIGN_CEIL(val, align)
 160
 161 /**
 162  * Checks if a pointer is aligned to a given power-of-two value
 163  *
 164  * @param ptr
 165  *   The pointer whose alignment is to be checked
 166  * @param align
 167  *   The power-of-two value to which the ptr should be aligned
 168  *
 169  * @return
 170  *   True(1) where the pointer is correctly aligned, false(0) otherwise
 171  */
 172 static inline int
 173 rte_is_aligned(void *ptr, unsigned align)
 174 {
 175         return RTE_PTR_ALIGN(ptr, align) == ptr;
 176 }
 177
 178 /*********** Macros for compile type checks ********/
 179
 180 /**
 181  * Triggers an error at compilation time if the condition is true.
 182  */
 183 #ifndef __OPTIMIZE__
 184 #define RTE_BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
 185 #else
 186 extern int RTE_BUILD_BUG_ON_detected_error;
 187 #define RTE_BUILD_BUG_ON(condition) do {             \
 188         ((void)sizeof(char[1 - 2*!!(condition)]));   \
 189         if (condition)                               \
 190                 RTE_BUILD_BUG_ON_detected_error = 1; \
 191 } while(0)
 192 #endif
 193
 194 /*********** Macros to work with powers of 2 ********/
 195
 196 /**
 197  * Returns true if n is a power of 2
 198  * @param n
 199  *     Number to check
 200  * @return 1 if true, 0 otherwise
 201  */
 202 static inline int
 203 rte_is_power_of_2(uint32_t n)
 204 {
 205         return n && !(n & (n - 1));
 206 }
 207
 208 /**
 209  * Aligns input parameter to the next power of 2
 210  *
 211  * @param x
 212  *   The integer value to algin
 213  *
 214  * @return
 215  *   Input parameter aligned to the next power of 2
 216  */
 217 static inline uint32_t
 218 rte_align32pow2(uint32_t x)
 219 {
 220         x--;
 221         x |= x >> 1;
 222         x |= x >> 2;
 223         x |= x >> 4;
 224         x |= x >> 8;
 225         x |= x >> 16;
 226
 227         return x + 1;
 228 }
 229
 230 /**
 231  * Aligns 64b input parameter to the next power of 2
 232  *
 233  * @param v
 234  *   The 64b value to align
 235  *
 236  * @return
 237  *   Input parameter aligned to the next power of 2
 238  */
 239 static inline uint64_t
 240 rte_align64pow2(uint64_t v)
 241 {
 242         v--;
 243         v |= v >> 1;
 244         v |= v >> 2;
 245         v |= v >> 4;
 246         v |= v >> 8;
 247         v |= v >> 16;
 248         v |= v >> 32;
 249
 250         return v + 1;
 251 }
 252
 253 /*********** Macros for calculating min and max **********/
 254
 255 /**
 256  * Macro to return the minimum of two numbers
 257  */
 258 #define RTE_MIN(a, b) ({ \
 259                 typeof (a) _a = (a); \
 260                 typeof (b) _b = (b); \
 261                 _a < _b ? _a : _b; \
 262         })
 263
 264 /**
 265  * Macro to return the maximum of two numbers
 266  */
 267 #define RTE_MAX(a, b) ({ \
 268                 typeof (a) _a = (a); \
 269                 typeof (b) _b = (b); \
 270                 _a > _b ? _a : _b; \
 271         })
 272
 273 /*********** Other general functions / macros ********/
 274
 275 #ifdef __SSE2__
 276 #include <emmintrin.h>
 277 /**
 278  * PAUSE instruction for tight loops (avoid busy waiting)
 279  */
 280 static inline void
 281 rte_pause (void)
 282 {
 283         _mm_pause();
 284 }
 285 #else
 286 static inline void
 287 rte_pause(void) {}
 288 #endif
 289
 290 /**
 291  * Searches the input parameter for the least significant set bit
 292  * (starting from zero).
 293  * If a least significant 1 bit is found, its bit index is returned.
 294  * If the content of the input parameter is zero, then the content of the return
 295  * value is undefined.
 296  * @param v
 297  *     input parameter, should not be zero.
 298  * @return
 299  *     least significant set bit in the input parameter.
 300  */
 301 static inline uint32_t
 302 rte_bsf32(uint32_t v)
 303 {
 304         return __builtin_ctz(v);
 305 }
 306
 307 #ifndef offsetof
 308 /** Return the offset of a field in a structure. */
 309 #define offsetof(TYPE, MEMBER)  __builtin_offsetof (TYPE, MEMBER)
 310 #endif
 311
 312 #define _RTE_STR(x) #x
 313 /** Take a macro value and get a string version of it */
 314 #define RTE_STR(x) _RTE_STR(x)
 315
 316 /** Mask value of type "tp" for the first "ln" bit set. */
 317 #define RTE_LEN2MASK(ln, tp)    \
 318         ((tp)((uint64_t)-1 >> (sizeof(uint64_t) * CHAR_BIT - (ln))))
 319
 320 /** Number of elements in the array. */
 321 #define RTE_DIM(a)      (sizeof (a) / sizeof ((a)[0]))
 322
 323 /**
 324  * Converts a numeric string to the equivalent uint64_t value.
 325  * As well as straight number conversion, also recognises the suffixes
 326  * k, m and g for kilobytes, megabytes and gigabytes respectively.
 327  *
 328  * If a negative number is passed in  i.e. a string with the first non-black
 329  * character being "-", zero is returned. Zero is also returned in the case of
 330  * an error with the strtoull call in the function.
 331  *
 332  * @param str
 333  *     String containing number to convert.
 334  * @return
 335  *     Number.
 336  */
 337 static inline uint64_t
 338 rte_str_to_size(const char *str)
 339 {
 340         char *endptr;
 341         unsigned long long size;
 342
 343         while (isspace((int)*str))
 344                 str++;
 345         if (*str == '-')
 346                 return 0;
 347
 348         errno = 0;
 349         size = strtoull(str, &endptr, 0);
 350         if (errno)
 351                 return 0;
 352
 353         if (*endptr == ' ')
 354                 endptr++; /* allow 1 space gap */
 355
 356         switch (*endptr){
 357         case 'G': case 'g': size *= 1024; /* fall-through */
 358         case 'M': case 'm': size *= 1024; /* fall-through */
 359         case 'K': case 'k': size *= 1024; /* fall-through */
 360         default:
 361                 break;
 362         }
 363         return size;
 364 }
 365
 366 /**
 367  * Function to terminate the application immediately, printing an error
 368  * message and returning the exit_code back to the shell.
 369  *
 370  * This function never returns
 371  *
 372  * @param exit_code
 373  *     The exit code to be returned by the application
 374  * @param format
 375  *     The format string to be used for printing the message. This can include
 376  *     printf format characters which will be expanded using any further parameters
 377  *     to the function.
 378  */
 379 void
 380 rte_exit(int exit_code, const char *format, ...)
 381         __attribute__((noreturn))
 382         __attribute__((format(printf, 2, 3)));
 383
 384 #ifdef __cplusplus
 385 }
 386 #endif
 387
 388 #endif