lib/librte_eal/common/include/rte_common.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2019 Intel Corporation
   3  */
   4
   5 #ifndef _RTE_COMMON_H_
   6 #define _RTE_COMMON_H_
   7
   8 /**
   9  * @file
  10  *
  11  * Generic, commonly-used macro and inline function definitions
  12  * for DPDK.
  13  */
  14
  15 #ifdef __cplusplus
  16 extern "C" {
  17 #endif
  18
  19 #include <stdint.h>
  20 #include <stdlib.h>
  21 #include <ctype.h>
  22 #include <errno.h>
  23 #include <limits.h>
  24
  25 #include <rte_config.h>
  26
  27 /* OS specific include */
  28 #include <rte_os.h>
  29
  30 #ifndef typeof
  31 #define typeof __typeof__
  32 #endif
  33
  34 #ifndef asm
  35 #define asm __asm__
  36 #endif
  37
  38 /** C extension macro for environments lacking C11 features. */
  39 #if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 201112L
  40 #define RTE_STD_C11 __extension__
  41 #else
  42 #define RTE_STD_C11
  43 #endif
  44
  45 /** Define GCC_VERSION **/
  46 #ifdef RTE_TOOLCHAIN_GCC
  47 #define GCC_VERSION (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 +  \
  48                 __GNUC_PATCHLEVEL__)
  49 #endif
  50
  51 #ifdef RTE_ARCH_STRICT_ALIGN
  52 typedef uint64_t unaligned_uint64_t __attribute__ ((aligned(1)));
  53 typedef uint32_t unaligned_uint32_t __attribute__ ((aligned(1)));
  54 typedef uint16_t unaligned_uint16_t __attribute__ ((aligned(1)));
  55 #else
  56 typedef uint64_t unaligned_uint64_t;
  57 typedef uint32_t unaligned_uint32_t;
  58 typedef uint16_t unaligned_uint16_t;
  59 #endif
  60
  61 /**
  62  * Force alignment
  63  */
  64 #define __rte_aligned(a) __attribute__((__aligned__(a)))
  65
  66 /**
  67  * Force a structure to be packed
  68  */
  69 #define __rte_packed __attribute__((__packed__))
  70
  71 /******* Macro to mark functions and fields scheduled for removal *****/
  72 #define __rte_deprecated        __attribute__((__deprecated__))
  73
  74 /**
  75  * Mark a function or variable to a weak reference.
  76  */
  77 #define __rte_weak __attribute__((__weak__))
  78
  79 /*********** Macros to eliminate unused variable warnings ********/
  80
  81 /**
  82  * short definition to mark a function parameter unused
  83  */
  84 #define __rte_unused __attribute__((__unused__))
  85
  86 /**
  87  * definition to mark a variable or function parameter as used so
  88  * as to avoid a compiler warning
  89  */
  90 #define RTE_SET_USED(x) (void)(x)
  91
  92 #define RTE_PRIORITY_LOG 101
  93 #define RTE_PRIORITY_BUS 110
  94 #define RTE_PRIORITY_CLASS 120
  95 #define RTE_PRIORITY_LAST 65535
  96
  97 #define RTE_PRIO(prio) \
  98         RTE_PRIORITY_ ## prio
  99
 100 /**
 101  * Run function before main() with high priority.
 102  *
 103  * @param func
 104  *   Constructor function.
 105  * @param prio
 106  *   Priority number must be above 100.
 107  *   Lowest number is the first to run.
 108  */
 109 #ifndef RTE_INIT_PRIO /* Allow to override from EAL */
 110 #define RTE_INIT_PRIO(func, prio) \
 111 static void __attribute__((constructor(RTE_PRIO(prio)), used)) func(void)
 112 #endif
 113
 114 /**
 115  * Run function before main() with low priority.
 116  *
 117  * The constructor will be run after prioritized constructors.
 118  *
 119  * @param func
 120  *   Constructor function.
 121  */
 122 #define RTE_INIT(func) \
 123         RTE_INIT_PRIO(func, LAST)
 124
 125 /**
 126  * Run after main() with low priority.
 127  *
 128  * @param func
 129  *   Destructor function name.
 130  * @param prio
 131  *   Priority number must be above 100.
 132  *   Lowest number is the last to run.
 133  */
 134 #ifndef RTE_FINI_PRIO /* Allow to override from EAL */
 135 #define RTE_FINI_PRIO(func, prio) \
 136 static void __attribute__((destructor(RTE_PRIO(prio)), used)) func(void)
 137 #endif
 138
 139 /**
 140  * Run after main() with high priority.
 141  *
 142  * The destructor will be run *before* prioritized destructors.
 143  *
 144  * @param func
 145  *   Destructor function name.
 146  */
 147 #define RTE_FINI(func) \
 148         RTE_FINI_PRIO(func, LAST)
 149
 150 /**
 151  * Force a function to be inlined
 152  */
 153 #define __rte_always_inline inline __attribute__((always_inline))
 154
 155 /**
 156  * Force a function to be noinlined
 157  */
 158 #define __rte_noinline  __attribute__((noinline))
 159
 160 /*********** Macros for pointer arithmetic ********/
 161
 162 /**
 163  * add a byte-value offset to a pointer
 164  */
 165 #define RTE_PTR_ADD(ptr, x) ((void*)((uintptr_t)(ptr) + (x)))
 166
 167 /**
 168  * subtract a byte-value offset from a pointer
 169  */
 170 #define RTE_PTR_SUB(ptr, x) ((void*)((uintptr_t)ptr - (x)))
 171
 172 /**
 173  * get the difference between two pointer values, i.e. how far apart
 174  * in bytes are the locations they point two. It is assumed that
 175  * ptr1 is greater than ptr2.
 176  */
 177 #define RTE_PTR_DIFF(ptr1, ptr2) ((uintptr_t)(ptr1) - (uintptr_t)(ptr2))
 178
 179 /**
 180  * Workaround to cast a const field of a structure to non-const type.
 181  */
 182 #define RTE_CAST_FIELD(var, field, type) \
 183         (*(type *)((uintptr_t)(var) + offsetof(typeof(*(var)), field)))
 184
 185 /*********** Macros/static functions for doing alignment ********/
 186
 187
 188 /**
 189  * Macro to align a pointer to a given power-of-two. The resultant
 190  * pointer will be a pointer of the same type as the first parameter, and
 191  * point to an address no higher than the first parameter. Second parameter
 192  * must be a power-of-two value.
 193  */
 194 #define RTE_PTR_ALIGN_FLOOR(ptr, align) \
 195         ((typeof(ptr))RTE_ALIGN_FLOOR((uintptr_t)ptr, align))
 196
 197 /**
 198  * Macro to align a value to a given power-of-two. The resultant value
 199  * will be of the same type as the first parameter, and will be no
 200  * bigger than the first parameter. Second parameter must be a
 201  * power-of-two value.
 202  */
 203 #define RTE_ALIGN_FLOOR(val, align) \
 204         (typeof(val))((val) & (~((typeof(val))((align) - 1))))
 205
 206 /**
 207  * Macro to align a pointer to a given power-of-two. The resultant
 208  * pointer will be a pointer of the same type as the first parameter, and
 209  * point to an address no lower than the first parameter. Second parameter
 210  * must be a power-of-two value.
 211  */
 212 #define RTE_PTR_ALIGN_CEIL(ptr, align) \
 213         RTE_PTR_ALIGN_FLOOR((typeof(ptr))RTE_PTR_ADD(ptr, (align) - 1), align)
 214
 215 /**
 216  * Macro to align a value to a given power-of-two. The resultant value
 217  * will be of the same type as the first parameter, and will be no lower
 218  * than the first parameter. Second parameter must be a power-of-two
 219  * value.
 220  */
 221 #define RTE_ALIGN_CEIL(val, align) \
 222         RTE_ALIGN_FLOOR(((val) + ((typeof(val)) (align) - 1)), align)
 223
 224 /**
 225  * Macro to align a pointer to a given power-of-two. The resultant
 226  * pointer will be a pointer of the same type as the first parameter, and
 227  * point to an address no lower than the first parameter. Second parameter
 228  * must be a power-of-two value.
 229  * This function is the same as RTE_PTR_ALIGN_CEIL
 230  */
 231 #define RTE_PTR_ALIGN(ptr, align) RTE_PTR_ALIGN_CEIL(ptr, align)
 232
 233 /**
 234  * Macro to align a value to a given power-of-two. The resultant
 235  * value will be of the same type as the first parameter, and
 236  * will be no lower than the first parameter. Second parameter
 237  * must be a power-of-two value.
 238  * This function is the same as RTE_ALIGN_CEIL
 239  */
 240 #define RTE_ALIGN(val, align) RTE_ALIGN_CEIL(val, align)
 241
 242 /**
 243  * Macro to align a value to the multiple of given value. The resultant
 244  * value will be of the same type as the first parameter and will be no lower
 245  * than the first parameter.
 246  */
 247 #define RTE_ALIGN_MUL_CEIL(v, mul) \
 248         (((v + (typeof(v))(mul) - 1) / ((typeof(v))(mul))) * (typeof(v))(mul))
 249
 250 /**
 251  * Macro to align a value to the multiple of given value. The resultant
 252  * value will be of the same type as the first parameter and will be no higher
 253  * than the first parameter.
 254  */
 255 #define RTE_ALIGN_MUL_FLOOR(v, mul) \
 256         ((v / ((typeof(v))(mul))) * (typeof(v))(mul))
 257
 258 /**
 259  * Macro to align value to the nearest multiple of the given value.
 260  * The resultant value might be greater than or less than the first parameter
 261  * whichever difference is the lowest.
 262  */
 263 #define RTE_ALIGN_MUL_NEAR(v, mul)                              \
 264         ({                                                      \
 265                 typeof(v) ceil = RTE_ALIGN_MUL_CEIL(v, mul);    \
 266                 typeof(v) floor = RTE_ALIGN_MUL_FLOOR(v, mul);  \
 267                 (ceil - v) > (v - floor) ? floor : ceil;        \
 268         })
 269
 270 /**
 271  * Checks if a pointer is aligned to a given power-of-two value
 272  *
 273  * @param ptr
 274  *   The pointer whose alignment is to be checked
 275  * @param align
 276  *   The power-of-two value to which the ptr should be aligned
 277  *
 278  * @return
 279  *   True(1) where the pointer is correctly aligned, false(0) otherwise
 280  */
 281 static inline int
 282 rte_is_aligned(void *ptr, unsigned align)
 283 {
 284         return RTE_PTR_ALIGN(ptr, align) == ptr;
 285 }
 286
 287 /*********** Macros for compile type checks ********/
 288
 289 /**
 290  * Triggers an error at compilation time if the condition is true.
 291  */
 292 #define RTE_BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
 293
 294 /**
 295  * Combines 32b inputs most significant set bits into the least
 296  * significant bits to construct a value with the same MSBs as x
 297  * but all 1's under it.
 298  *
 299  * @param x
 300  *    The integer whose MSBs need to be combined with its LSBs
 301  * @return
 302  *    The combined value.
 303  */
 304 static inline uint32_t
 305 rte_combine32ms1b(register uint32_t x)
 306 {
 307         x |= x >> 1;
 308         x |= x >> 2;
 309         x |= x >> 4;
 310         x |= x >> 8;
 311         x |= x >> 16;
 312
 313         return x;
 314 }
 315
 316 /**
 317  * Combines 64b inputs most significant set bits into the least
 318  * significant bits to construct a value with the same MSBs as x
 319  * but all 1's under it.
 320  *
 321  * @param v
 322  *    The integer whose MSBs need to be combined with its LSBs
 323  * @return
 324  *    The combined value.
 325  */
 326 static inline uint64_t
 327 rte_combine64ms1b(register uint64_t v)
 328 {
 329         v |= v >> 1;
 330         v |= v >> 2;
 331         v |= v >> 4;
 332         v |= v >> 8;
 333         v |= v >> 16;
 334         v |= v >> 32;
 335
 336         return v;
 337 }
 338
 339 /*********** Macros to work with powers of 2 ********/
 340
 341 /**
 342  * Macro to return 1 if n is a power of 2, 0 otherwise
 343  */
 344 #define RTE_IS_POWER_OF_2(n) ((n) && !(((n) - 1) & (n)))
 345
 346 /**
 347  * Returns true if n is a power of 2
 348  * @param n
 349  *     Number to check
 350  * @return 1 if true, 0 otherwise
 351  */
 352 static inline int
 353 rte_is_power_of_2(uint32_t n)
 354 {
 355         return n && !(n & (n - 1));
 356 }
 357
 358 /**
 359  * Aligns input parameter to the next power of 2
 360  *
 361  * @param x
 362  *   The integer value to align
 363  *
 364  * @return
 365  *   Input parameter aligned to the next power of 2
 366  */
 367 static inline uint32_t
 368 rte_align32pow2(uint32_t x)
 369 {
 370         x--;
 371         x = rte_combine32ms1b(x);
 372
 373         return x + 1;
 374 }
 375
 376 /**
 377  * Aligns input parameter to the previous power of 2
 378  *
 379  * @param x
 380  *   The integer value to align
 381  *
 382  * @return
 383  *   Input parameter aligned to the previous power of 2
 384  */
 385 static inline uint32_t
 386 rte_align32prevpow2(uint32_t x)
 387 {
 388         x = rte_combine32ms1b(x);
 389
 390         return x - (x >> 1);
 391 }
 392
 393 /**
 394  * Aligns 64b input parameter to the next power of 2
 395  *
 396  * @param v
 397  *   The 64b value to align
 398  *
 399  * @return
 400  *   Input parameter aligned to the next power of 2
 401  */
 402 static inline uint64_t
 403 rte_align64pow2(uint64_t v)
 404 {
 405         v--;
 406         v = rte_combine64ms1b(v);
 407
 408         return v + 1;
 409 }
 410
 411 /**
 412  * Aligns 64b input parameter to the previous power of 2
 413  *
 414  * @param v
 415  *   The 64b value to align
 416  *
 417  * @return
 418  *   Input parameter aligned to the previous power of 2
 419  */
 420 static inline uint64_t
 421 rte_align64prevpow2(uint64_t v)
 422 {
 423         v = rte_combine64ms1b(v);
 424
 425         return v - (v >> 1);
 426 }
 427
 428 /*********** Macros for calculating min and max **********/
 429
 430 /**
 431  * Macro to return the minimum of two numbers
 432  */
 433 #define RTE_MIN(a, b) \
 434         __extension__ ({ \
 435                 typeof (a) _a = (a); \
 436                 typeof (b) _b = (b); \
 437                 _a < _b ? _a : _b; \
 438         })
 439
 440 /**
 441  * Macro to return the maximum of two numbers
 442  */
 443 #define RTE_MAX(a, b) \
 444         __extension__ ({ \
 445                 typeof (a) _a = (a); \
 446                 typeof (b) _b = (b); \
 447                 _a > _b ? _a : _b; \
 448         })
 449
 450 /*********** Other general functions / macros ********/
 451
 452 /**
 453  * Searches the input parameter for the least significant set bit
 454  * (starting from zero).
 455  * If a least significant 1 bit is found, its bit index is returned.
 456  * If the content of the input parameter is zero, then the content of the return
 457  * value is undefined.
 458  * @param v
 459  *     input parameter, should not be zero.
 460  * @return
 461  *     least significant set bit in the input parameter.
 462  */
 463 static inline uint32_t
 464 rte_bsf32(uint32_t v)
 465 {
 466         return (uint32_t)__builtin_ctz(v);
 467 }
 468
 469 /**
 470  * Searches the input parameter for the least significant set bit
 471  * (starting from zero). Safe version (checks for input parameter being zero).
 472  *
 473  * @warning ``pos`` must be a valid pointer. It is not checked!
 474  *
 475  * @param v
 476  *     The input parameter.
 477  * @param pos
 478  *     If ``v`` was not 0, this value will contain position of least significant
 479  *     bit within the input parameter.
 480  * @return
 481  *     Returns 0 if ``v`` was 0, otherwise returns 1.
 482  */
 483 static inline int
 484 rte_bsf32_safe(uint64_t v, uint32_t *pos)
 485 {
 486         if (v == 0)
 487                 return 0;
 488
 489         *pos = rte_bsf32(v);
 490         return 1;
 491 }
 492
 493 /**
 494  * Return the rounded-up log2 of a integer.
 495  *
 496  * @param v
 497  *     The input parameter.
 498  * @return
 499  *     The rounded-up log2 of the input, or 0 if the input is 0.
 500  */
 501 static inline uint32_t
 502 rte_log2_u32(uint32_t v)
 503 {
 504         if (v == 0)
 505                 return 0;
 506         v = rte_align32pow2(v);
 507         return rte_bsf32(v);
 508 }
 509
 510
 511 /**
 512  * Return the last (most-significant) bit set.
 513  *
 514  * @note The last (most significant) bit is at position 32.
 515  * @note rte_fls_u32(0) = 0, rte_fls_u32(1) = 1, rte_fls_u32(0x80000000) = 32
 516  *
 517  * @param x
 518  *     The input parameter.
 519  * @return
 520  *     The last (most-significant) bit set, or 0 if the input is 0.
 521  */
 522 static inline int
 523 rte_fls_u32(uint32_t x)
 524 {
 525         return (x == 0) ? 0 : 32 - __builtin_clz(x);
 526 }
 527
 528 /**
 529  * Searches the input parameter for the least significant set bit
 530  * (starting from zero).
 531  * If a least significant 1 bit is found, its bit index is returned.
 532  * If the content of the input parameter is zero, then the content of the return
 533  * value is undefined.
 534  * @param v
 535  *     input parameter, should not be zero.
 536  * @return
 537  *     least significant set bit in the input parameter.
 538  */
 539 static inline int
 540 rte_bsf64(uint64_t v)
 541 {
 542         return (uint32_t)__builtin_ctzll(v);
 543 }
 544
 545 /**
 546  * Searches the input parameter for the least significant set bit
 547  * (starting from zero). Safe version (checks for input parameter being zero).
 548  *
 549  * @warning ``pos`` must be a valid pointer. It is not checked!
 550  *
 551  * @param v
 552  *     The input parameter.
 553  * @param pos
 554  *     If ``v`` was not 0, this value will contain position of least significant
 555  *     bit within the input parameter.
 556  * @return
 557  *     Returns 0 if ``v`` was 0, otherwise returns 1.
 558  */
 559 static inline int
 560 rte_bsf64_safe(uint64_t v, uint32_t *pos)
 561 {
 562         if (v == 0)
 563                 return 0;
 564
 565         *pos = rte_bsf64(v);
 566         return 1;
 567 }
 568
 569 /**
 570  * Return the last (most-significant) bit set.
 571  *
 572  * @note The last (most significant) bit is at position 64.
 573  * @note rte_fls_u64(0) = 0, rte_fls_u64(1) = 1,
 574  *       rte_fls_u64(0x8000000000000000) = 64
 575  *
 576  * @param x
 577  *     The input parameter.
 578  * @return
 579  *     The last (most-significant) bit set, or 0 if the input is 0.
 580  */
 581 static inline int
 582 rte_fls_u64(uint64_t x)
 583 {
 584         return (x == 0) ? 0 : 64 - __builtin_clzll(x);
 585 }
 586
 587 /**
 588  * Return the rounded-up log2 of a 64-bit integer.
 589  *
 590  * @param v
 591  *     The input parameter.
 592  * @return
 593  *     The rounded-up log2 of the input, or 0 if the input is 0.
 594  */
 595 static inline uint32_t
 596 rte_log2_u64(uint64_t v)
 597 {
 598         if (v == 0)
 599                 return 0;
 600         v = rte_align64pow2(v);
 601         /* we checked for v being 0 already, so no undefined behavior */
 602         return rte_bsf64(v);
 603 }
 604
 605 #ifndef offsetof
 606 /** Return the offset of a field in a structure. */
 607 #define offsetof(TYPE, MEMBER)  __builtin_offsetof (TYPE, MEMBER)
 608 #endif
 609
 610 /**
 611  * Return pointer to the wrapping struct instance.
 612  *
 613  * Example:
 614  *
 615  *  struct wrapper {
 616  *      ...
 617  *      struct child c;
 618  *      ...
 619  *  };
 620  *
 621  *  struct child *x = obtain(...);
 622  *  struct wrapper *w = container_of(x, struct wrapper, c);
 623  */
 624 #ifndef container_of
 625 #define container_of(ptr, type, member) __extension__ ({                \
 626                         const typeof(((type *)0)->member) *_ptr = (ptr); \
 627                         __attribute__((unused)) type *_target_ptr =     \
 628                                 (type *)(ptr);                          \
 629                         (type *)(((uintptr_t)_ptr) - offsetof(type, member)); \
 630                 })
 631 #endif
 632
 633 #define _RTE_STR(x) #x
 634 /** Take a macro value and get a string version of it */
 635 #define RTE_STR(x) _RTE_STR(x)
 636
 637 /**
 638  * ISO C helpers to modify format strings using variadic macros.
 639  * This is a replacement for the ", ## __VA_ARGS__" GNU extension.
 640  * An empty %s argument is appended to avoid a dangling comma.
 641  */
 642 #define RTE_FMT(fmt, ...) fmt "%.0s", __VA_ARGS__ ""
 643 #define RTE_FMT_HEAD(fmt, ...) fmt
 644 #define RTE_FMT_TAIL(fmt, ...) __VA_ARGS__
 645
 646 /** Mask value of type "tp" for the first "ln" bit set. */
 647 #define RTE_LEN2MASK(ln, tp)    \
 648         ((tp)((uint64_t)-1 >> (sizeof(uint64_t) * CHAR_BIT - (ln))))
 649
 650 /** Number of elements in the array. */
 651 #define RTE_DIM(a)      (sizeof (a) / sizeof ((a)[0]))
 652
 653 /**
 654  * Converts a numeric string to the equivalent uint64_t value.
 655  * As well as straight number conversion, also recognises the suffixes
 656  * k, m and g for kilobytes, megabytes and gigabytes respectively.
 657  *
 658  * If a negative number is passed in  i.e. a string with the first non-black
 659  * character being "-", zero is returned. Zero is also returned in the case of
 660  * an error with the strtoull call in the function.
 661  *
 662  * @param str
 663  *     String containing number to convert.
 664  * @return
 665  *     Number.
 666  */
 667 static inline uint64_t
 668 rte_str_to_size(const char *str)
 669 {
 670         char *endptr;
 671         unsigned long long size;
 672
 673         while (isspace((int)*str))
 674                 str++;
 675         if (*str == '-')
 676                 return 0;
 677
 678         errno = 0;
 679         size = strtoull(str, &endptr, 0);
 680         if (errno)
 681                 return 0;
 682
 683         if (*endptr == ' ')
 684                 endptr++; /* allow 1 space gap */
 685
 686         switch (*endptr){
 687         case 'G': case 'g': size *= 1024; /* fall-through */
 688         case 'M': case 'm': size *= 1024; /* fall-through */
 689         case 'K': case 'k': size *= 1024; /* fall-through */
 690         default:
 691                 break;
 692         }
 693         return size;
 694 }
 695
 696 /**
 697  * Function to terminate the application immediately, printing an error
 698  * message and returning the exit_code back to the shell.
 699  *
 700  * This function never returns
 701  *
 702  * @param exit_code
 703  *     The exit code to be returned by the application
 704  * @param format
 705  *     The format string to be used for printing the message. This can include
 706  *     printf format characters which will be expanded using any further parameters
 707  *     to the function.
 708  */
 709 void
 710 rte_exit(int exit_code, const char *format, ...)
 711         __attribute__((noreturn))
 712         __attribute__((format(printf, 2, 3)));
 713
 714 #ifdef __cplusplus
 715 }
 716 #endif
 717
 718 #endif