lib/librte_eal/common/include/rte_common.h

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