eal: fix C++17 compilation
[dpdk.git] / lib / librte_eal / 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 /*
46  * RTE_TOOLCHAIN_GCC is defined if the target is built with GCC,
47  * while a host application (like pmdinfogen) may have another compiler.
48  * RTE_CC_IS_GNU is true if the file is compiled with GCC,
49  * no matter it is a target or host application.
50  */
51 #define RTE_CC_IS_GNU 0
52 #if defined __clang__
53 #define RTE_CC_CLANG
54 #elif defined __INTEL_COMPILER
55 #define RTE_CC_ICC
56 #elif defined __GNUC__
57 #define RTE_CC_GCC
58 #undef RTE_CC_IS_GNU
59 #define RTE_CC_IS_GNU 1
60 #endif
61 #if RTE_CC_IS_GNU
62 #define GCC_VERSION (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 +  \
63                 __GNUC_PATCHLEVEL__)
64 #endif
65
66 /**
67  * Force alignment
68  */
69 #define __rte_aligned(a) __attribute__((__aligned__(a)))
70
71 #ifdef RTE_ARCH_STRICT_ALIGN
72 typedef uint64_t unaligned_uint64_t __rte_aligned(1);
73 typedef uint32_t unaligned_uint32_t __rte_aligned(1);
74 typedef uint16_t unaligned_uint16_t __rte_aligned(1);
75 #else
76 typedef uint64_t unaligned_uint64_t;
77 typedef uint32_t unaligned_uint32_t;
78 typedef uint16_t unaligned_uint16_t;
79 #endif
80
81 /**
82  * Force a structure to be packed
83  */
84 #define __rte_packed __attribute__((__packed__))
85
86 /******* Macro to mark functions and fields scheduled for removal *****/
87 #define __rte_deprecated        __attribute__((__deprecated__))
88
89 /**
90  * Mark a function or variable to a weak reference.
91  */
92 #define __rte_weak __attribute__((__weak__))
93
94 /**
95  * Force symbol to be generated even if it appears to be unused.
96  */
97 #define __rte_used __attribute__((used))
98
99 /*********** Macros to eliminate unused variable warnings ********/
100
101 /**
102  * short definition to mark a function parameter unused
103  */
104 #define __rte_unused __attribute__((__unused__))
105
106 /**
107  * definition to mark a variable or function parameter as used so
108  * as to avoid a compiler warning
109  */
110 #define RTE_SET_USED(x) (void)(x)
111
112 /**
113  * Check format string and its arguments at compile-time.
114  *
115  * GCC on Windows assumes MS-specific format string by default,
116  * even if the underlying stdio implementation is ANSI-compliant,
117  * so this must be overridden.
118  */
119 #if RTE_CC_IS_GNU
120 #define __rte_format_printf(format_index, first_arg) \
121         __attribute__((format(gnu_printf, format_index, first_arg)))
122 #else
123 #define __rte_format_printf(format_index, first_arg) \
124         __attribute__((format(printf, format_index, first_arg)))
125 #endif
126
127 #define RTE_PRIORITY_LOG 101
128 #define RTE_PRIORITY_BUS 110
129 #define RTE_PRIORITY_CLASS 120
130 #define RTE_PRIORITY_LAST 65535
131
132 #define RTE_PRIO(prio) \
133         RTE_PRIORITY_ ## prio
134
135 /**
136  * Run function before main() with high priority.
137  *
138  * @param func
139  *   Constructor function.
140  * @param prio
141  *   Priority number must be above 100.
142  *   Lowest number is the first to run.
143  */
144 #ifndef RTE_INIT_PRIO /* Allow to override from EAL */
145 #define RTE_INIT_PRIO(func, prio) \
146 static void __attribute__((constructor(RTE_PRIO(prio)), used)) func(void)
147 #endif
148
149 /**
150  * Run function before main() with low priority.
151  *
152  * The constructor will be run after prioritized constructors.
153  *
154  * @param func
155  *   Constructor function.
156  */
157 #define RTE_INIT(func) \
158         RTE_INIT_PRIO(func, LAST)
159
160 /**
161  * Run after main() with low priority.
162  *
163  * @param func
164  *   Destructor function name.
165  * @param prio
166  *   Priority number must be above 100.
167  *   Lowest number is the last to run.
168  */
169 #ifndef RTE_FINI_PRIO /* Allow to override from EAL */
170 #define RTE_FINI_PRIO(func, prio) \
171 static void __attribute__((destructor(RTE_PRIO(prio)), used)) func(void)
172 #endif
173
174 /**
175  * Run after main() with high priority.
176  *
177  * The destructor will be run *before* prioritized destructors.
178  *
179  * @param func
180  *   Destructor function name.
181  */
182 #define RTE_FINI(func) \
183         RTE_FINI_PRIO(func, LAST)
184
185 /**
186  * Hint never returning function
187  */
188 #define __rte_noreturn __attribute__((noreturn))
189
190 /**
191  * Force a function to be inlined
192  */
193 #define __rte_always_inline inline __attribute__((always_inline))
194
195 /**
196  * Force a function to be noinlined
197  */
198 #define __rte_noinline __attribute__((noinline))
199
200 /**
201  * Hint function in the hot path
202  */
203 #define __rte_hot __attribute__((hot))
204
205 /**
206  * Hint function in the cold path
207  */
208 #define __rte_cold __attribute__((cold))
209
210 /*********** Macros for pointer arithmetic ********/
211
212 /**
213  * add a byte-value offset to a pointer
214  */
215 #define RTE_PTR_ADD(ptr, x) ((void*)((uintptr_t)(ptr) + (x)))
216
217 /**
218  * subtract a byte-value offset from a pointer
219  */
220 #define RTE_PTR_SUB(ptr, x) ((void*)((uintptr_t)ptr - (x)))
221
222 /**
223  * get the difference between two pointer values, i.e. how far apart
224  * in bytes are the locations they point two. It is assumed that
225  * ptr1 is greater than ptr2.
226  */
227 #define RTE_PTR_DIFF(ptr1, ptr2) ((uintptr_t)(ptr1) - (uintptr_t)(ptr2))
228
229 /**
230  * Workaround to cast a const field of a structure to non-const type.
231  */
232 #define RTE_CAST_FIELD(var, field, type) \
233         (*(type *)((uintptr_t)(var) + offsetof(typeof(*(var)), field)))
234
235 /*********** Macros/static functions for doing alignment ********/
236
237
238 /**
239  * Macro to align a pointer to a given power-of-two. The resultant
240  * pointer will be a pointer of the same type as the first parameter, and
241  * point to an address no higher than the first parameter. Second parameter
242  * must be a power-of-two value.
243  */
244 #define RTE_PTR_ALIGN_FLOOR(ptr, align) \
245         ((typeof(ptr))RTE_ALIGN_FLOOR((uintptr_t)ptr, align))
246
247 /**
248  * Macro to align a value to a given power-of-two. The resultant value
249  * will be of the same type as the first parameter, and will be no
250  * bigger than the first parameter. Second parameter must be a
251  * power-of-two value.
252  */
253 #define RTE_ALIGN_FLOOR(val, align) \
254         (typeof(val))((val) & (~((typeof(val))((align) - 1))))
255
256 /**
257  * Macro to align a pointer to a given power-of-two. The resultant
258  * pointer will be a pointer of the same type as the first parameter, and
259  * point to an address no lower than the first parameter. Second parameter
260  * must be a power-of-two value.
261  */
262 #define RTE_PTR_ALIGN_CEIL(ptr, align) \
263         RTE_PTR_ALIGN_FLOOR((typeof(ptr))RTE_PTR_ADD(ptr, (align) - 1), align)
264
265 /**
266  * Macro to align a value to a given power-of-two. The resultant value
267  * will be of the same type as the first parameter, and will be no lower
268  * than the first parameter. Second parameter must be a power-of-two
269  * value.
270  */
271 #define RTE_ALIGN_CEIL(val, align) \
272         RTE_ALIGN_FLOOR(((val) + ((typeof(val)) (align) - 1)), align)
273
274 /**
275  * Macro to align a pointer to a given power-of-two. The resultant
276  * pointer will be a pointer of the same type as the first parameter, and
277  * point to an address no lower than the first parameter. Second parameter
278  * must be a power-of-two value.
279  * This function is the same as RTE_PTR_ALIGN_CEIL
280  */
281 #define RTE_PTR_ALIGN(ptr, align) RTE_PTR_ALIGN_CEIL(ptr, align)
282
283 /**
284  * Macro to align a value to a given power-of-two. The resultant
285  * value will be of the same type as the first parameter, and
286  * will be no lower than the first parameter. Second parameter
287  * must be a power-of-two value.
288  * This function is the same as RTE_ALIGN_CEIL
289  */
290 #define RTE_ALIGN(val, align) RTE_ALIGN_CEIL(val, align)
291
292 /**
293  * Macro to align a value to the multiple of given value. The resultant
294  * value will be of the same type as the first parameter and will be no lower
295  * than the first parameter.
296  */
297 #define RTE_ALIGN_MUL_CEIL(v, mul) \
298         (((v + (typeof(v))(mul) - 1) / ((typeof(v))(mul))) * (typeof(v))(mul))
299
300 /**
301  * Macro to align a value to the multiple of given value. The resultant
302  * value will be of the same type as the first parameter and will be no higher
303  * than the first parameter.
304  */
305 #define RTE_ALIGN_MUL_FLOOR(v, mul) \
306         ((v / ((typeof(v))(mul))) * (typeof(v))(mul))
307
308 /**
309  * Macro to align value to the nearest multiple of the given value.
310  * The resultant value might be greater than or less than the first parameter
311  * whichever difference is the lowest.
312  */
313 #define RTE_ALIGN_MUL_NEAR(v, mul)                              \
314         ({                                                      \
315                 typeof(v) ceil = RTE_ALIGN_MUL_CEIL(v, mul);    \
316                 typeof(v) floor = RTE_ALIGN_MUL_FLOOR(v, mul);  \
317                 (ceil - v) > (v - floor) ? floor : ceil;        \
318         })
319
320 /**
321  * Checks if a pointer is aligned to a given power-of-two value
322  *
323  * @param ptr
324  *   The pointer whose alignment is to be checked
325  * @param align
326  *   The power-of-two value to which the ptr should be aligned
327  *
328  * @return
329  *   True(1) where the pointer is correctly aligned, false(0) otherwise
330  */
331 static inline int
332 rte_is_aligned(void *ptr, unsigned align)
333 {
334         return RTE_PTR_ALIGN(ptr, align) == ptr;
335 }
336
337 /*********** Macros for compile type checks ********/
338
339 /**
340  * Triggers an error at compilation time if the condition is true.
341  */
342 #define RTE_BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
343
344 /*********** Cache line related macros ********/
345
346 /** Cache line mask. */
347 #define RTE_CACHE_LINE_MASK (RTE_CACHE_LINE_SIZE-1)
348
349 /** Return the first cache-aligned value greater or equal to size. */
350 #define RTE_CACHE_LINE_ROUNDUP(size) \
351         (RTE_CACHE_LINE_SIZE * ((size + RTE_CACHE_LINE_SIZE - 1) / \
352         RTE_CACHE_LINE_SIZE))
353
354 /** Cache line size in terms of log2 */
355 #if RTE_CACHE_LINE_SIZE == 64
356 #define RTE_CACHE_LINE_SIZE_LOG2 6
357 #elif RTE_CACHE_LINE_SIZE == 128
358 #define RTE_CACHE_LINE_SIZE_LOG2 7
359 #else
360 #error "Unsupported cache line size"
361 #endif
362
363 /** Minimum Cache line size. */
364 #define RTE_CACHE_LINE_MIN_SIZE 64
365
366 /** Force alignment to cache line. */
367 #define __rte_cache_aligned __rte_aligned(RTE_CACHE_LINE_SIZE)
368
369 /** Force minimum cache line alignment. */
370 #define __rte_cache_min_aligned __rte_aligned(RTE_CACHE_LINE_MIN_SIZE)
371
372 /*********** PA/IOVA type definitions ********/
373
374 /** Physical address */
375 typedef uint64_t phys_addr_t;
376 #define RTE_BAD_PHYS_ADDR ((phys_addr_t)-1)
377
378 /**
379  * IO virtual address type.
380  * When the physical addressing mode (IOVA as PA) is in use,
381  * the translation from an IO virtual address (IOVA) to a physical address
382  * is a direct mapping, i.e. the same value.
383  * Otherwise, in virtual mode (IOVA as VA), an IOMMU may do the translation.
384  */
385 typedef uint64_t rte_iova_t;
386 #define RTE_BAD_IOVA ((rte_iova_t)-1)
387
388 /*********** Structure alignment markers ********/
389
390 /** Generic marker for any place in a structure. */
391 __extension__ typedef void    *RTE_MARKER[0];
392 /** Marker for 1B alignment in a structure. */
393 __extension__ typedef uint8_t  RTE_MARKER8[0];
394 /** Marker for 2B alignment in a structure. */
395 __extension__ typedef uint16_t RTE_MARKER16[0];
396 /** Marker for 4B alignment in a structure. */
397 __extension__ typedef uint32_t RTE_MARKER32[0];
398 /** Marker for 8B alignment in a structure. */
399 __extension__ typedef uint64_t RTE_MARKER64[0];
400
401 /**
402  * Combines 32b inputs most significant set bits into the least
403  * significant bits to construct a value with the same MSBs as x
404  * but all 1's under it.
405  *
406  * @param x
407  *    The integer whose MSBs need to be combined with its LSBs
408  * @return
409  *    The combined value.
410  */
411 static inline uint32_t
412 rte_combine32ms1b(uint32_t x)
413 {
414         x |= x >> 1;
415         x |= x >> 2;
416         x |= x >> 4;
417         x |= x >> 8;
418         x |= x >> 16;
419
420         return x;
421 }
422
423 /**
424  * Combines 64b inputs most significant set bits into the least
425  * significant bits to construct a value with the same MSBs as x
426  * but all 1's under it.
427  *
428  * @param v
429  *    The integer whose MSBs need to be combined with its LSBs
430  * @return
431  *    The combined value.
432  */
433 static inline uint64_t
434 rte_combine64ms1b(uint64_t v)
435 {
436         v |= v >> 1;
437         v |= v >> 2;
438         v |= v >> 4;
439         v |= v >> 8;
440         v |= v >> 16;
441         v |= v >> 32;
442
443         return v;
444 }
445
446 /*********** Macros to work with powers of 2 ********/
447
448 /**
449  * Macro to return 1 if n is a power of 2, 0 otherwise
450  */
451 #define RTE_IS_POWER_OF_2(n) ((n) && !(((n) - 1) & (n)))
452
453 /**
454  * Returns true if n is a power of 2
455  * @param n
456  *     Number to check
457  * @return 1 if true, 0 otherwise
458  */
459 static inline int
460 rte_is_power_of_2(uint32_t n)
461 {
462         return n && !(n & (n - 1));
463 }
464
465 /**
466  * Aligns input parameter to the next power of 2
467  *
468  * @param x
469  *   The integer value to align
470  *
471  * @return
472  *   Input parameter aligned to the next power of 2
473  */
474 static inline uint32_t
475 rte_align32pow2(uint32_t x)
476 {
477         x--;
478         x = rte_combine32ms1b(x);
479
480         return x + 1;
481 }
482
483 /**
484  * Aligns input parameter to the previous power of 2
485  *
486  * @param x
487  *   The integer value to align
488  *
489  * @return
490  *   Input parameter aligned to the previous power of 2
491  */
492 static inline uint32_t
493 rte_align32prevpow2(uint32_t x)
494 {
495         x = rte_combine32ms1b(x);
496
497         return x - (x >> 1);
498 }
499
500 /**
501  * Aligns 64b input parameter to the next power of 2
502  *
503  * @param v
504  *   The 64b value to align
505  *
506  * @return
507  *   Input parameter aligned to the next power of 2
508  */
509 static inline uint64_t
510 rte_align64pow2(uint64_t v)
511 {
512         v--;
513         v = rte_combine64ms1b(v);
514
515         return v + 1;
516 }
517
518 /**
519  * Aligns 64b input parameter to the previous power of 2
520  *
521  * @param v
522  *   The 64b value to align
523  *
524  * @return
525  *   Input parameter aligned to the previous power of 2
526  */
527 static inline uint64_t
528 rte_align64prevpow2(uint64_t v)
529 {
530         v = rte_combine64ms1b(v);
531
532         return v - (v >> 1);
533 }
534
535 /*********** Macros for calculating min and max **********/
536
537 /**
538  * Macro to return the minimum of two numbers
539  */
540 #define RTE_MIN(a, b) \
541         __extension__ ({ \
542                 typeof (a) _a = (a); \
543                 typeof (b) _b = (b); \
544                 _a < _b ? _a : _b; \
545         })
546
547 /**
548  * Macro to return the maximum of two numbers
549  */
550 #define RTE_MAX(a, b) \
551         __extension__ ({ \
552                 typeof (a) _a = (a); \
553                 typeof (b) _b = (b); \
554                 _a > _b ? _a : _b; \
555         })
556
557 /*********** Other general functions / macros ********/
558
559 /**
560  * Searches the input parameter for the least significant set bit
561  * (starting from zero).
562  * If a least significant 1 bit is found, its bit index is returned.
563  * If the content of the input parameter is zero, then the content of the return
564  * value is undefined.
565  * @param v
566  *     input parameter, should not be zero.
567  * @return
568  *     least significant set bit in the input parameter.
569  */
570 static inline uint32_t
571 rte_bsf32(uint32_t v)
572 {
573         return (uint32_t)__builtin_ctz(v);
574 }
575
576 /**
577  * Searches the input parameter for the least significant set bit
578  * (starting from zero). Safe version (checks for input parameter being zero).
579  *
580  * @warning ``pos`` must be a valid pointer. It is not checked!
581  *
582  * @param v
583  *     The input parameter.
584  * @param pos
585  *     If ``v`` was not 0, this value will contain position of least significant
586  *     bit within the input parameter.
587  * @return
588  *     Returns 0 if ``v`` was 0, otherwise returns 1.
589  */
590 static inline int
591 rte_bsf32_safe(uint64_t v, uint32_t *pos)
592 {
593         if (v == 0)
594                 return 0;
595
596         *pos = rte_bsf32(v);
597         return 1;
598 }
599
600 /**
601  * Return the rounded-up log2 of a integer.
602  *
603  * @note Contrary to the logarithm mathematical operation,
604  * rte_log2_u32(0) == 0 and not -inf.
605  *
606  * @param v
607  *     The input parameter.
608  * @return
609  *     The rounded-up log2 of the input, or 0 if the input is 0.
610  */
611 static inline uint32_t
612 rte_log2_u32(uint32_t v)
613 {
614         if (v == 0)
615                 return 0;
616         v = rte_align32pow2(v);
617         return rte_bsf32(v);
618 }
619
620
621 /**
622  * Return the last (most-significant) bit set.
623  *
624  * @note The last (most significant) bit is at position 32.
625  * @note rte_fls_u32(0) = 0, rte_fls_u32(1) = 1, rte_fls_u32(0x80000000) = 32
626  *
627  * @param x
628  *     The input parameter.
629  * @return
630  *     The last (most-significant) bit set, or 0 if the input is 0.
631  */
632 static inline int
633 rte_fls_u32(uint32_t x)
634 {
635         return (x == 0) ? 0 : 32 - __builtin_clz(x);
636 }
637
638 /**
639  * Searches the input parameter for the least significant set bit
640  * (starting from zero).
641  * If a least significant 1 bit is found, its bit index is returned.
642  * If the content of the input parameter is zero, then the content of the return
643  * value is undefined.
644  * @param v
645  *     input parameter, should not be zero.
646  * @return
647  *     least significant set bit in the input parameter.
648  */
649 static inline int
650 rte_bsf64(uint64_t v)
651 {
652         return (uint32_t)__builtin_ctzll(v);
653 }
654
655 /**
656  * Searches the input parameter for the least significant set bit
657  * (starting from zero). Safe version (checks for input parameter being zero).
658  *
659  * @warning ``pos`` must be a valid pointer. It is not checked!
660  *
661  * @param v
662  *     The input parameter.
663  * @param pos
664  *     If ``v`` was not 0, this value will contain position of least significant
665  *     bit within the input parameter.
666  * @return
667  *     Returns 0 if ``v`` was 0, otherwise returns 1.
668  */
669 static inline int
670 rte_bsf64_safe(uint64_t v, uint32_t *pos)
671 {
672         if (v == 0)
673                 return 0;
674
675         *pos = rte_bsf64(v);
676         return 1;
677 }
678
679 /**
680  * Return the last (most-significant) bit set.
681  *
682  * @note The last (most significant) bit is at position 64.
683  * @note rte_fls_u64(0) = 0, rte_fls_u64(1) = 1,
684  *       rte_fls_u64(0x8000000000000000) = 64
685  *
686  * @param x
687  *     The input parameter.
688  * @return
689  *     The last (most-significant) bit set, or 0 if the input is 0.
690  */
691 static inline int
692 rte_fls_u64(uint64_t x)
693 {
694         return (x == 0) ? 0 : 64 - __builtin_clzll(x);
695 }
696
697 /**
698  * Return the rounded-up log2 of a 64-bit integer.
699  *
700  * @note Contrary to the logarithm mathematical operation,
701  * rte_log2_u64(0) == 0 and not -inf.
702  *
703  * @param v
704  *     The input parameter.
705  * @return
706  *     The rounded-up log2 of the input, or 0 if the input is 0.
707  */
708 static inline uint32_t
709 rte_log2_u64(uint64_t v)
710 {
711         if (v == 0)
712                 return 0;
713         v = rte_align64pow2(v);
714         /* we checked for v being 0 already, so no undefined behavior */
715         return rte_bsf64(v);
716 }
717
718 #ifndef offsetof
719 /** Return the offset of a field in a structure. */
720 #define offsetof(TYPE, MEMBER)  __builtin_offsetof (TYPE, MEMBER)
721 #endif
722
723 /**
724  * Return pointer to the wrapping struct instance.
725  *
726  * Example:
727  *
728  *  struct wrapper {
729  *      ...
730  *      struct child c;
731  *      ...
732  *  };
733  *
734  *  struct child *x = obtain(...);
735  *  struct wrapper *w = container_of(x, struct wrapper, c);
736  */
737 #ifndef container_of
738 #define container_of(ptr, type, member) __extension__ ({                \
739                         const typeof(((type *)0)->member) *_ptr = (ptr); \
740                         __rte_unused type *_target_ptr =        \
741                                 (type *)(ptr);                          \
742                         (type *)(((uintptr_t)_ptr) - offsetof(type, member)); \
743                 })
744 #endif
745
746 /**
747  * Get the size of a field in a structure.
748  *
749  * @param type
750  *   The type of the structure.
751  * @param field
752  *   The field in the structure.
753  * @return
754  *   The size of the field in the structure, in bytes.
755  */
756 #define RTE_SIZEOF_FIELD(type, field) (sizeof(((type *)0)->field))
757
758 #define _RTE_STR(x) #x
759 /** Take a macro value and get a string version of it */
760 #define RTE_STR(x) _RTE_STR(x)
761
762 /**
763  * ISO C helpers to modify format strings using variadic macros.
764  * This is a replacement for the ", ## __VA_ARGS__" GNU extension.
765  * An empty %s argument is appended to avoid a dangling comma.
766  */
767 #define RTE_FMT(fmt, ...) fmt "%.0s", __VA_ARGS__ ""
768 #define RTE_FMT_HEAD(fmt, ...) fmt
769 #define RTE_FMT_TAIL(fmt, ...) __VA_ARGS__
770
771 /** Mask value of type "tp" for the first "ln" bit set. */
772 #define RTE_LEN2MASK(ln, tp)    \
773         ((tp)((uint64_t)-1 >> (sizeof(uint64_t) * CHAR_BIT - (ln))))
774
775 /** Number of elements in the array. */
776 #define RTE_DIM(a)      (sizeof (a) / sizeof ((a)[0]))
777
778 /**
779  * Converts a numeric string to the equivalent uint64_t value.
780  * As well as straight number conversion, also recognises the suffixes
781  * k, m and g for kilobytes, megabytes and gigabytes respectively.
782  *
783  * If a negative number is passed in  i.e. a string with the first non-black
784  * character being "-", zero is returned. Zero is also returned in the case of
785  * an error with the strtoull call in the function.
786  *
787  * @param str
788  *     String containing number to convert.
789  * @return
790  *     Number.
791  */
792 static inline uint64_t
793 rte_str_to_size(const char *str)
794 {
795         char *endptr;
796         unsigned long long size;
797
798         while (isspace((int)*str))
799                 str++;
800         if (*str == '-')
801                 return 0;
802
803         errno = 0;
804         size = strtoull(str, &endptr, 0);
805         if (errno)
806                 return 0;
807
808         if (*endptr == ' ')
809                 endptr++; /* allow 1 space gap */
810
811         switch (*endptr){
812         case 'G': case 'g': size *= 1024; /* fall-through */
813         case 'M': case 'm': size *= 1024; /* fall-through */
814         case 'K': case 'k': size *= 1024; /* fall-through */
815         default:
816                 break;
817         }
818         return size;
819 }
820
821 /**
822  * Function to terminate the application immediately, printing an error
823  * message and returning the exit_code back to the shell.
824  *
825  * This function never returns
826  *
827  * @param exit_code
828  *     The exit code to be returned by the application
829  * @param format
830  *     The format string to be used for printing the message. This can include
831  *     printf format characters which will be expanded using any further parameters
832  *     to the function.
833  */
834 __rte_noreturn void
835 rte_exit(int exit_code, const char *format, ...)
836         __rte_format_printf(2, 3);
837
838 #ifdef __cplusplus
839 }
840 #endif
841
842 #endif