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