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