lib/librte_eal/common/include/rte_common.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2014 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 #ifndef typeof
  28 #define typeof __typeof__
  29 #endif
  30
  31 #ifndef asm
  32 #define asm __asm__
  33 #endif
  34
  35 /** C extension macro for environments lacking C11 features. */
  36 #if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 201112L
  37 #define RTE_STD_C11 __extension__
  38 #else
  39 #define RTE_STD_C11
  40 #endif
  41
  42 /** Define GCC_VERSION **/
  43 #ifdef RTE_TOOLCHAIN_GCC
  44 #define GCC_VERSION (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 +  \
  45                 __GNUC_PATCHLEVEL__)
  46 #endif
  47
  48 #ifdef RTE_ARCH_STRICT_ALIGN
  49 typedef uint64_t unaligned_uint64_t __attribute__ ((aligned(1)));
  50 typedef uint32_t unaligned_uint32_t __attribute__ ((aligned(1)));
  51 typedef uint16_t unaligned_uint16_t __attribute__ ((aligned(1)));
  52 #else
  53 typedef uint64_t unaligned_uint64_t;
  54 typedef uint32_t unaligned_uint32_t;
  55 typedef uint16_t unaligned_uint16_t;
  56 #endif
  57
  58 /**
  59  * Force alignment
  60  */
  61 #define __rte_aligned(a) __attribute__((__aligned__(a)))
  62
  63 /**
  64  * Force a structure to be packed
  65  */
  66 #define __rte_packed __attribute__((__packed__))
  67
  68 /******* Macro to mark functions and fields scheduled for removal *****/
  69 #define __rte_deprecated        __attribute__((__deprecated__))
  70
  71 /*********** Macros to eliminate unused variable warnings ********/
  72
  73 /**
  74  * short definition to mark a function parameter unused
  75  */
  76 #define __rte_unused __attribute__((__unused__))
  77
  78 /**
  79  * definition to mark a variable or function parameter as used so
  80  * as to avoid a compiler warning
  81  */
  82 #define RTE_SET_USED(x) (void)(x)
  83
  84 #define RTE_PRIORITY_LOG 101
  85 #define RTE_PRIORITY_BUS 110
  86 #define RTE_PRIORITY_LAST 65535
  87
  88 #define RTE_PRIO(prio) \
  89         RTE_PRIORITY_ ## prio
  90
  91 /**
  92  * Run function before main() with high priority.
  93  *
  94  * @param func
  95  *   Constructor function.
  96  * @param prio
  97  *   Priority number must be above 100.
  98  *   Lowest number is the first to run.
  99  */
 100 #define RTE_INIT_PRIO(func, prio) \
 101 static void __attribute__((constructor(RTE_PRIO(prio)), used)) func(void)
 102
 103 /**
 104  * Run function before main() with low priority.
 105  *
 106  * The constructor will be run after prioritized constructors.
 107  *
 108  * @param func
 109  *   Constructor function.
 110  */
 111 #define RTE_INIT(func) \
 112         RTE_INIT_PRIO(func, LAST)
 113
 114 /**
 115  * Force a function to be inlined
 116  */
 117 #define __rte_always_inline inline __attribute__((always_inline))
 118
 119 /**
 120  * Force a function to be noinlined
 121  */
 122 #define __rte_noinline  __attribute__((noinline))
 123
 124 /*********** Macros for pointer arithmetic ********/
 125
 126 /**
 127  * add a byte-value offset to a pointer
 128  */
 129 #define RTE_PTR_ADD(ptr, x) ((void*)((uintptr_t)(ptr) + (x)))
 130
 131 /**
 132  * subtract a byte-value offset from a pointer
 133  */
 134 #define RTE_PTR_SUB(ptr, x) ((void*)((uintptr_t)ptr - (x)))
 135
 136 /**
 137  * get the difference between two pointer values, i.e. how far apart
 138  * in bytes are the locations they point two. It is assumed that
 139  * ptr1 is greater than ptr2.
 140  */
 141 #define RTE_PTR_DIFF(ptr1, ptr2) ((uintptr_t)(ptr1) - (uintptr_t)(ptr2))
 142
 143 /*********** Macros/static functions for doing alignment ********/
 144
 145
 146 /**
 147  * Macro to align a pointer to a given power-of-two. The resultant
 148  * pointer will be a pointer of the same type as the first parameter, and
 149  * point to an address no higher than the first parameter. Second parameter
 150  * must be a power-of-two value.
 151  */
 152 #define RTE_PTR_ALIGN_FLOOR(ptr, align) \
 153         ((typeof(ptr))RTE_ALIGN_FLOOR((uintptr_t)ptr, align))
 154
 155 /**
 156  * Macro to align a value to a given power-of-two. The resultant value
 157  * will be of the same type as the first parameter, and will be no
 158  * bigger than the first parameter. Second parameter must be a
 159  * power-of-two value.
 160  */
 161 #define RTE_ALIGN_FLOOR(val, align) \
 162         (typeof(val))((val) & (~((typeof(val))((align) - 1))))
 163
 164 /**
 165  * Macro to align a pointer to a given power-of-two. The resultant
 166  * pointer will be a pointer of the same type as the first parameter, and
 167  * point to an address no lower than the first parameter. Second parameter
 168  * must be a power-of-two value.
 169  */
 170 #define RTE_PTR_ALIGN_CEIL(ptr, align) \
 171         RTE_PTR_ALIGN_FLOOR((typeof(ptr))RTE_PTR_ADD(ptr, (align) - 1), align)
 172
 173 /**
 174  * Macro to align a value to a given power-of-two. The resultant value
 175  * will be of the same type as the first parameter, and will be no lower
 176  * than the first parameter. Second parameter must be a power-of-two
 177  * value.
 178  */
 179 #define RTE_ALIGN_CEIL(val, align) \
 180         RTE_ALIGN_FLOOR(((val) + ((typeof(val)) (align) - 1)), align)
 181
 182 /**
 183  * Macro to align a pointer to a given power-of-two. The resultant
 184  * pointer will be a pointer of the same type as the first parameter, and
 185  * point to an address no lower than the first parameter. Second parameter
 186  * must be a power-of-two value.
 187  * This function is the same as RTE_PTR_ALIGN_CEIL
 188  */
 189 #define RTE_PTR_ALIGN(ptr, align) RTE_PTR_ALIGN_CEIL(ptr, align)
 190
 191 /**
 192  * Macro to align a value to a given power-of-two. The resultant
 193  * value will be of the same type as the first parameter, and
 194  * will be no lower than the first parameter. Second parameter
 195  * must be a power-of-two value.
 196  * This function is the same as RTE_ALIGN_CEIL
 197  */
 198 #define RTE_ALIGN(val, align) RTE_ALIGN_CEIL(val, align)
 199
 200 /**
 201  * Macro to align a value to the multiple of given value. The resultant
 202  * value will be of the same type as the first parameter and will be no lower
 203  * than the first parameter.
 204  */
 205 #define RTE_ALIGN_MUL_CEIL(v, mul) \
 206         (((v + (typeof(v))(mul) - 1) / ((typeof(v))(mul))) * (typeof(v))(mul))
 207
 208 /**
 209  * Macro to align a value to the multiple of given value. The resultant
 210  * value will be of the same type as the first parameter and will be no higher
 211  * than the first parameter.
 212  */
 213 #define RTE_ALIGN_MUL_FLOOR(v, mul) \
 214         ((v / ((typeof(v))(mul))) * (typeof(v))(mul))
 215
 216 /**
 217  * Checks if a pointer is aligned to a given power-of-two value
 218  *
 219  * @param ptr
 220  *   The pointer whose alignment is to be checked
 221  * @param align
 222  *   The power-of-two value to which the ptr should be aligned
 223  *
 224  * @return
 225  *   True(1) where the pointer is correctly aligned, false(0) otherwise
 226  */
 227 static inline int
 228 rte_is_aligned(void *ptr, unsigned align)
 229 {
 230         return RTE_PTR_ALIGN(ptr, align) == ptr;
 231 }
 232
 233 /*********** Macros for compile type checks ********/
 234
 235 /**
 236  * Triggers an error at compilation time if the condition is true.
 237  */
 238 #ifndef __OPTIMIZE__
 239 #define RTE_BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
 240 #else
 241 extern int RTE_BUILD_BUG_ON_detected_error;
 242 #define RTE_BUILD_BUG_ON(condition) do {             \
 243         ((void)sizeof(char[1 - 2*!!(condition)]));   \
 244         if (condition)                               \
 245                 RTE_BUILD_BUG_ON_detected_error = 1; \
 246 } while(0)
 247 #endif
 248
 249 /**
 250  * Combines 32b inputs most significant set bits into the least
 251  * significant bits to construct a value with the same MSBs as x
 252  * but all 1's under it.
 253  *
 254  * @param x
 255  *    The integer whose MSBs need to be combined with its LSBs
 256  * @return
 257  *    The combined value.
 258  */
 259 static inline uint32_t
 260 rte_combine32ms1b(register uint32_t x)
 261 {
 262         x |= x >> 1;
 263         x |= x >> 2;
 264         x |= x >> 4;
 265         x |= x >> 8;
 266         x |= x >> 16;
 267
 268         return x;
 269 }
 270
 271 /**
 272  * Combines 64b inputs most significant set bits into the least
 273  * significant bits to construct a value with the same MSBs as x
 274  * but all 1's under it.
 275  *
 276  * @param v
 277  *    The integer whose MSBs need to be combined with its LSBs
 278  * @return
 279  *    The combined value.
 280  */
 281 static inline uint64_t
 282 rte_combine64ms1b(register uint64_t v)
 283 {
 284         v |= v >> 1;
 285         v |= v >> 2;
 286         v |= v >> 4;
 287         v |= v >> 8;
 288         v |= v >> 16;
 289         v |= v >> 32;
 290
 291         return v;
 292 }
 293
 294 /*********** Macros to work with powers of 2 ********/
 295
 296 /**
 297  * Returns true if n is a power of 2
 298  * @param n
 299  *     Number to check
 300  * @return 1 if true, 0 otherwise
 301  */
 302 static inline int
 303 rte_is_power_of_2(uint32_t n)
 304 {
 305         return n && !(n & (n - 1));
 306 }
 307
 308 /**
 309  * Aligns input parameter to the next power of 2
 310  *
 311  * @param x
 312  *   The integer value to algin
 313  *
 314  * @return
 315  *   Input parameter aligned to the next power of 2
 316  */
 317 static inline uint32_t
 318 rte_align32pow2(uint32_t x)
 319 {
 320         x--;
 321         x = rte_combine32ms1b(x);
 322
 323         return x + 1;
 324 }
 325
 326 /**
 327  * Aligns input parameter to the previous power of 2
 328  *
 329  * @param x
 330  *   The integer value to algin
 331  *
 332  * @return
 333  *   Input parameter aligned to the previous power of 2
 334  */
 335 static inline uint32_t
 336 rte_align32prevpow2(uint32_t x)
 337 {
 338         x = rte_combine32ms1b(x);
 339
 340         return x - (x >> 1);
 341 }
 342
 343 /**
 344  * Aligns 64b input parameter to the next power of 2
 345  *
 346  * @param v
 347  *   The 64b value to align
 348  *
 349  * @return
 350  *   Input parameter aligned to the next power of 2
 351  */
 352 static inline uint64_t
 353 rte_align64pow2(uint64_t v)
 354 {
 355         v--;
 356         v = rte_combine64ms1b(v);
 357
 358         return v + 1;
 359 }
 360
 361 /**
 362  * Aligns 64b input parameter to the previous power of 2
 363  *
 364  * @param v
 365  *   The 64b value to align
 366  *
 367  * @return
 368  *   Input parameter aligned to the previous power of 2
 369  */
 370 static inline uint64_t
 371 rte_align64prevpow2(uint64_t v)
 372 {
 373         v = rte_combine64ms1b(v);
 374
 375         return v - (v >> 1);
 376 }
 377
 378 /*********** Macros for calculating min and max **********/
 379
 380 /**
 381  * Macro to return the minimum of two numbers
 382  */
 383 #define RTE_MIN(a, b) \
 384         __extension__ ({ \
 385                 typeof (a) _a = (a); \
 386                 typeof (b) _b = (b); \
 387                 _a < _b ? _a : _b; \
 388         })
 389
 390 /**
 391  * Macro to return the maximum of two numbers
 392  */
 393 #define RTE_MAX(a, b) \
 394         __extension__ ({ \
 395                 typeof (a) _a = (a); \
 396                 typeof (b) _b = (b); \
 397                 _a > _b ? _a : _b; \
 398         })
 399
 400 /*********** Other general functions / macros ********/
 401
 402 /**
 403  * Searches the input parameter for the least significant set bit
 404  * (starting from zero).
 405  * If a least significant 1 bit is found, its bit index is returned.
 406  * If the content of the input parameter is zero, then the content of the return
 407  * value is undefined.
 408  * @param v
 409  *     input parameter, should not be zero.
 410  * @return
 411  *     least significant set bit in the input parameter.
 412  */
 413 static inline uint32_t
 414 rte_bsf32(uint32_t v)
 415 {
 416         return (uint32_t)__builtin_ctz(v);
 417 }
 418
 419 /**
 420  * Return the rounded-up log2 of a integer.
 421  *
 422  * @param v
 423  *     The input parameter.
 424  * @return
 425  *     The rounded-up log2 of the input, or 0 if the input is 0.
 426  */
 427 static inline uint32_t
 428 rte_log2_u32(uint32_t v)
 429 {
 430         if (v == 0)
 431                 return 0;
 432         v = rte_align32pow2(v);
 433         return rte_bsf32(v);
 434 }
 435
 436 #ifndef offsetof
 437 /** Return the offset of a field in a structure. */
 438 #define offsetof(TYPE, MEMBER)  __builtin_offsetof (TYPE, MEMBER)
 439 #endif
 440
 441 /**
 442  * Return pointer to the wrapping struct instance.
 443  *
 444  * Example:
 445  *
 446  *  struct wrapper {
 447  *      ...
 448  *      struct child c;
 449  *      ...
 450  *  };
 451  *
 452  *  struct child *x = obtain(...);
 453  *  struct wrapper *w = container_of(x, struct wrapper, c);
 454  */
 455 #ifndef container_of
 456 #define container_of(ptr, type, member) __extension__ ({                \
 457                         const typeof(((type *)0)->member) *_ptr = (ptr); \
 458                         __attribute__((unused)) type *_target_ptr =     \
 459                                 (type *)(ptr);                          \
 460                         (type *)(((uintptr_t)_ptr) - offsetof(type, member)); \
 461                 })
 462 #endif
 463
 464 #define _RTE_STR(x) #x
 465 /** Take a macro value and get a string version of it */
 466 #define RTE_STR(x) _RTE_STR(x)
 467
 468 /**
 469  * ISO C helpers to modify format strings using variadic macros.
 470  * This is a replacement for the ", ## __VA_ARGS__" GNU extension.
 471  * An empty %s argument is appended to avoid a dangling comma.
 472  */
 473 #define RTE_FMT(fmt, ...) fmt "%.0s", __VA_ARGS__ ""
 474 #define RTE_FMT_HEAD(fmt, ...) fmt
 475 #define RTE_FMT_TAIL(fmt, ...) __VA_ARGS__
 476
 477 /** Mask value of type "tp" for the first "ln" bit set. */
 478 #define RTE_LEN2MASK(ln, tp)    \
 479         ((tp)((uint64_t)-1 >> (sizeof(uint64_t) * CHAR_BIT - (ln))))
 480
 481 /** Number of elements in the array. */
 482 #define RTE_DIM(a)      (sizeof (a) / sizeof ((a)[0]))
 483
 484 /**
 485  * Converts a numeric string to the equivalent uint64_t value.
 486  * As well as straight number conversion, also recognises the suffixes
 487  * k, m and g for kilobytes, megabytes and gigabytes respectively.
 488  *
 489  * If a negative number is passed in  i.e. a string with the first non-black
 490  * character being "-", zero is returned. Zero is also returned in the case of
 491  * an error with the strtoull call in the function.
 492  *
 493  * @param str
 494  *     String containing number to convert.
 495  * @return
 496  *     Number.
 497  */
 498 static inline uint64_t
 499 rte_str_to_size(const char *str)
 500 {
 501         char *endptr;
 502         unsigned long long size;
 503
 504         while (isspace((int)*str))
 505                 str++;
 506         if (*str == '-')
 507                 return 0;
 508
 509         errno = 0;
 510         size = strtoull(str, &endptr, 0);
 511         if (errno)
 512                 return 0;
 513
 514         if (*endptr == ' ')
 515                 endptr++; /* allow 1 space gap */
 516
 517         switch (*endptr){
 518         case 'G': case 'g': size *= 1024; /* fall-through */
 519         case 'M': case 'm': size *= 1024; /* fall-through */
 520         case 'K': case 'k': size *= 1024; /* fall-through */
 521         default:
 522                 break;
 523         }
 524         return size;
 525 }
 526
 527 /**
 528  * Function to terminate the application immediately, printing an error
 529  * message and returning the exit_code back to the shell.
 530  *
 531  * This function never returns
 532  *
 533  * @param exit_code
 534  *     The exit code to be returned by the application
 535  * @param format
 536  *     The format string to be used for printing the message. This can include
 537  *     printf format characters which will be expanded using any further parameters
 538  *     to the function.
 539  */
 540 void
 541 rte_exit(int exit_code, const char *format, ...)
 542         __attribute__((noreturn))
 543         __attribute__((format(printf, 2, 3)));
 544
 545 #ifdef __cplusplus
 546 }
 547 #endif
 548
 549 #endif