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