DPDK
18.11.11
|
#include <stdint.h>
#include <stdlib.h>
#include <ctype.h>
#include <errno.h>
#include <limits.h>
#include <rte_config.h>
Go to the source code of this file.
Macros | |
#define | RTE_STD_C11 __extension__ |
#define | __rte_aligned(a) __attribute__((__aligned__(a))) |
#define | __rte_packed __attribute__((__packed__)) |
#define | __rte_weak __attribute__((__weak__)) |
#define | __rte_unused __attribute__((__unused__)) |
#define | RTE_SET_USED(x) (void)(x) |
#define | RTE_INIT_PRIO(func, prio) static void __attribute__((constructor(RTE_PRIO(prio)), used)) func(void) |
#define | RTE_INIT(func) RTE_INIT_PRIO(func, LAST) |
#define | RTE_FINI_PRIO(func, prio) static void __attribute__((destructor(RTE_PRIO(prio)), used)) func(void) |
#define | RTE_FINI(func) RTE_FINI_PRIO(func, LAST) |
#define | __rte_always_inline inline __attribute__((always_inline)) |
#define | __rte_noinline __attribute__((noinline)) |
#define | RTE_PTR_ADD(ptr, x) ((void*)((uintptr_t)(ptr) + (x))) |
#define | RTE_PTR_SUB(ptr, x) ((void*)((uintptr_t)ptr - (x))) |
#define | RTE_PTR_DIFF(ptr1, ptr2) ((uintptr_t)(ptr1) - (uintptr_t)(ptr2)) |
#define | RTE_CAST_FIELD(var, field, type) (*(type *)((uintptr_t)(var) + offsetof(typeof(*(var)), field))) |
#define | RTE_PTR_ALIGN_FLOOR(ptr, align) ((typeof(ptr))RTE_ALIGN_FLOOR((uintptr_t)ptr, align)) |
#define | RTE_ALIGN_FLOOR(val, align) (typeof(val))((val) & (~((typeof(val))((align) - 1)))) |
#define | RTE_PTR_ALIGN_CEIL(ptr, align) RTE_PTR_ALIGN_FLOOR((typeof(ptr))RTE_PTR_ADD(ptr, (align) - 1), align) |
#define | RTE_ALIGN_CEIL(val, align) RTE_ALIGN_FLOOR(((val) + ((typeof(val)) (align) - 1)), align) |
#define | RTE_PTR_ALIGN(ptr, align) RTE_PTR_ALIGN_CEIL(ptr, align) |
#define | RTE_ALIGN(val, align) RTE_ALIGN_CEIL(val, align) |
#define | RTE_ALIGN_MUL_CEIL(v, mul) ((((v) + (typeof(v))(mul) - 1) / ((typeof(v))(mul))) * (typeof(v))(mul)) |
#define | RTE_ALIGN_MUL_FLOOR(v, mul) (((v) / ((typeof(v))(mul))) * (typeof(v))(mul)) |
#define | RTE_BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)])) |
#define | RTE_IS_POWER_OF_2(n) ((n) && !(((n) - 1) & (n))) |
#define | RTE_MIN(a, b) |
#define | RTE_MAX(a, b) |
#define | offsetof(TYPE, MEMBER) __builtin_offsetof (TYPE, MEMBER) |
#define | container_of(ptr, type, member) |
#define | RTE_STR(x) _RTE_STR(x) |
#define | RTE_FMT(fmt, ...) fmt "%.0s", __VA_ARGS__ "" |
#define | RTE_LEN2MASK(ln, tp) ((tp)((uint64_t)-1 >> (sizeof(uint64_t) * CHAR_BIT - (ln)))) |
#define | RTE_DIM(a) (sizeof (a) / sizeof ((a)[0])) |
Typedefs | |
typedef uint64_t | unaligned_uint64_t |
Functions | |
static int | rte_is_aligned (void *ptr, unsigned align) |
static uint32_t | rte_combine32ms1b (uint32_t x) |
static uint64_t | rte_combine64ms1b (uint64_t v) |
static int | rte_is_power_of_2 (uint32_t n) |
static uint32_t | rte_align32pow2 (uint32_t x) |
static uint32_t | rte_align32prevpow2 (uint32_t x) |
static uint64_t | rte_align64pow2 (uint64_t v) |
static uint64_t | rte_align64prevpow2 (uint64_t v) |
static uint32_t | rte_bsf32 (uint32_t v) |
static uint32_t | rte_log2_u32 (uint32_t v) |
static int | rte_fls_u32 (uint32_t x) |
static int | rte_bsf64_safe (uint64_t v, uint32_t *pos) |
static uint64_t | rte_str_to_size (const char *str) |
void | rte_exit (int exit_code, const char *format,...) |
Generic, commonly-used macro and inline function definitions for DPDK.
Definition in file rte_common.h.
#define RTE_STD_C11 __extension__ |
C extension macro for environments lacking C11 features.
Definition at line 37 of file rte_common.h.
#define __rte_aligned | ( | a | ) | __attribute__((__aligned__(a))) |
Force alignment
Definition at line 61 of file rte_common.h.
#define __rte_packed __attribute__((__packed__)) |
Force a structure to be packed
Definition at line 66 of file rte_common.h.
#define __rte_weak __attribute__((__weak__)) |
Mark a function or variable to a weak reference.
Definition at line 74 of file rte_common.h.
#define __rte_unused __attribute__((__unused__)) |
short definition to mark a function parameter unused
Definition at line 81 of file rte_common.h.
#define RTE_SET_USED | ( | x | ) | (void)(x) |
definition to mark a variable or function parameter as used so as to avoid a compiler warning
Definition at line 87 of file rte_common.h.
#define RTE_INIT_PRIO | ( | func, | |
prio | |||
) | static void __attribute__((constructor(RTE_PRIO(prio)), used)) func(void) |
Run function before main() with high priority.
func | Constructor function. |
prio | Priority number must be above 100. Lowest number is the first to run. |
Definition at line 106 of file rte_common.h.
#define RTE_INIT | ( | func | ) | RTE_INIT_PRIO(func, LAST) |
Run function before main() with low priority.
The constructor will be run after prioritized constructors.
func | Constructor function. |
Definition at line 117 of file rte_common.h.
#define RTE_FINI_PRIO | ( | func, | |
prio | |||
) | static void __attribute__((destructor(RTE_PRIO(prio)), used)) func(void) |
Run after main() with low priority.
func | Destructor function name. |
prio | Priority number must be above 100. Lowest number is the last to run. |
Definition at line 129 of file rte_common.h.
#define RTE_FINI | ( | func | ) | RTE_FINI_PRIO(func, LAST) |
Run after main() with high priority.
The destructor will be run before prioritized destructors.
func | Destructor function name. |
Definition at line 140 of file rte_common.h.
#define __rte_always_inline inline __attribute__((always_inline)) |
Force a function to be inlined
Definition at line 146 of file rte_common.h.
#define __rte_noinline __attribute__((noinline)) |
Force a function to be noinlined
Definition at line 151 of file rte_common.h.
#define RTE_PTR_ADD | ( | ptr, | |
x | |||
) | ((void*)((uintptr_t)(ptr) + (x))) |
add a byte-value offset to a pointer
Definition at line 158 of file rte_common.h.
#define RTE_PTR_SUB | ( | ptr, | |
x | |||
) | ((void*)((uintptr_t)ptr - (x))) |
subtract a byte-value offset from a pointer
Definition at line 163 of file rte_common.h.
#define RTE_PTR_DIFF | ( | ptr1, | |
ptr2 | |||
) | ((uintptr_t)(ptr1) - (uintptr_t)(ptr2)) |
get the difference between two pointer values, i.e. how far apart in bytes are the locations they point two. It is assumed that ptr1 is greater than ptr2.
Definition at line 170 of file rte_common.h.
#define RTE_CAST_FIELD | ( | var, | |
field, | |||
type | |||
) | (*(type *)((uintptr_t)(var) + offsetof(typeof(*(var)), field))) |
Workaround to cast a const field of a structure to non-const type.
Definition at line 175 of file rte_common.h.
#define RTE_PTR_ALIGN_FLOOR | ( | ptr, | |
align | |||
) | ((typeof(ptr))RTE_ALIGN_FLOOR((uintptr_t)ptr, align)) |
Macro to align a pointer to a given power-of-two. The resultant pointer will be a pointer of the same type as the first parameter, and point to an address no higher than the first parameter. Second parameter must be a power-of-two value.
Definition at line 187 of file rte_common.h.
#define RTE_ALIGN_FLOOR | ( | val, | |
align | |||
) | (typeof(val))((val) & (~((typeof(val))((align) - 1)))) |
Macro to align a value to a given power-of-two. The resultant value will be of the same type as the first parameter, and will be no bigger than the first parameter. Second parameter must be a power-of-two value.
Definition at line 196 of file rte_common.h.
#define RTE_PTR_ALIGN_CEIL | ( | ptr, | |
align | |||
) | RTE_PTR_ALIGN_FLOOR((typeof(ptr))RTE_PTR_ADD(ptr, (align) - 1), align) |
Macro to align a pointer to a given power-of-two. The resultant pointer will be a pointer of the same type as the first parameter, and point to an address no lower than the first parameter. Second parameter must be a power-of-two value.
Definition at line 205 of file rte_common.h.
#define RTE_ALIGN_CEIL | ( | val, | |
align | |||
) | RTE_ALIGN_FLOOR(((val) + ((typeof(val)) (align) - 1)), align) |
Macro to align a value to a given power-of-two. The resultant value will be of the same type as the first parameter, and will be no lower than the first parameter. Second parameter must be a power-of-two value.
Definition at line 214 of file rte_common.h.
#define RTE_PTR_ALIGN | ( | ptr, | |
align | |||
) | RTE_PTR_ALIGN_CEIL(ptr, align) |
Macro to align a pointer to a given power-of-two. The resultant pointer will be a pointer of the same type as the first parameter, and point to an address no lower than the first parameter. Second parameter must be a power-of-two value. This function is the same as RTE_PTR_ALIGN_CEIL
Definition at line 224 of file rte_common.h.
#define RTE_ALIGN | ( | val, | |
align | |||
) | RTE_ALIGN_CEIL(val, align) |
Macro to align a value to a given power-of-two. The resultant value will be of the same type as the first parameter, and will be no lower than the first parameter. Second parameter must be a power-of-two value. This function is the same as RTE_ALIGN_CEIL
Definition at line 233 of file rte_common.h.
#define RTE_ALIGN_MUL_CEIL | ( | v, | |
mul | |||
) | ((((v) + (typeof(v))(mul) - 1) / ((typeof(v))(mul))) * (typeof(v))(mul)) |
Macro to align a value to the multiple of given value. The resultant value will be of the same type as the first parameter and will be no lower than the first parameter.
Definition at line 240 of file rte_common.h.
#define RTE_ALIGN_MUL_FLOOR | ( | v, | |
mul | |||
) | (((v) / ((typeof(v))(mul))) * (typeof(v))(mul)) |
Macro to align a value to the multiple of given value. The resultant value will be of the same type as the first parameter and will be no higher than the first parameter.
Definition at line 248 of file rte_common.h.
#define RTE_BUILD_BUG_ON | ( | condition | ) | ((void)sizeof(char[1 - 2*!!(condition)])) |
Triggers an error at compilation time if the condition is true.
Definition at line 273 of file rte_common.h.
#define RTE_IS_POWER_OF_2 | ( | n | ) | ((n) && !(((n) - 1) & (n))) |
Macro to return 1 if n is a power of 2, 0 otherwise
Definition at line 325 of file rte_common.h.
#define RTE_MIN | ( | a, | |
b | |||
) |
Macro to return the minimum of two numbers
Definition at line 414 of file rte_common.h.
#define RTE_MAX | ( | a, | |
b | |||
) |
Macro to return the maximum of two numbers
Definition at line 424 of file rte_common.h.
#define offsetof | ( | TYPE, | |
MEMBER | |||
) | __builtin_offsetof (TYPE, MEMBER) |
Return the offset of a field in a structure.
Definition at line 511 of file rte_common.h.
#define container_of | ( | ptr, | |
type, | |||
member | |||
) |
Return pointer to the wrapping struct instance.
Example:
struct wrapper { ... struct child c; ... };
struct child *x = obtain(...); struct wrapper *w = container_of(x, struct wrapper, c);
Definition at line 529 of file rte_common.h.
#define RTE_STR | ( | x | ) | _RTE_STR(x) |
Take a macro value and get a string version of it
Definition at line 539 of file rte_common.h.
#define RTE_FMT | ( | fmt, | |
... | |||
) | fmt "%.0s", __VA_ARGS__ "" |
ISO C helpers to modify format strings using variadic macros. This is a replacement for the ", ## __VA_ARGS__" GNU extension. An empty s argument is appended to avoid a dangling comma.
Definition at line 546 of file rte_common.h.
#define RTE_LEN2MASK | ( | ln, | |
tp | |||
) | ((tp)((uint64_t)-1 >> (sizeof(uint64_t) * CHAR_BIT - (ln)))) |
Mask value of type "tp" for the first "ln" bit set.
Definition at line 551 of file rte_common.h.
#define RTE_DIM | ( | a | ) | (sizeof (a) / sizeof ((a)[0])) |
Number of elements in the array.
Definition at line 555 of file rte_common.h.
typedef uint64_t unaligned_uint64_t |
Define GCC_VERSION
Definition at line 53 of file rte_common.h.
|
inlinestatic |
Checks if a pointer is aligned to a given power-of-two value
ptr | The pointer whose alignment is to be checked |
align | The power-of-two value to which the ptr should be aligned |
Definition at line 263 of file rte_common.h.
|
inlinestatic |
Combines 32b inputs most significant set bits into the least significant bits to construct a value with the same MSBs as x but all 1's under it.
x | The integer whose MSBs need to be combined with its LSBs |
Definition at line 286 of file rte_common.h.
|
inlinestatic |
Combines 64b inputs most significant set bits into the least significant bits to construct a value with the same MSBs as x but all 1's under it.
v | The integer whose MSBs need to be combined with its LSBs |
Definition at line 308 of file rte_common.h.
|
inlinestatic |
Returns true if n is a power of 2
n | Number to check |
Definition at line 334 of file rte_common.h.
|
inlinestatic |
Aligns input parameter to the next power of 2
x | The integer value to align |
Definition at line 349 of file rte_common.h.
|
inlinestatic |
Aligns input parameter to the previous power of 2
x | The integer value to align |
Definition at line 367 of file rte_common.h.
|
inlinestatic |
Aligns 64b input parameter to the next power of 2
v | The 64b value to align |
Definition at line 384 of file rte_common.h.
|
inlinestatic |
Aligns 64b input parameter to the previous power of 2
v | The 64b value to align |
Definition at line 402 of file rte_common.h.
|
inlinestatic |
Searches the input parameter for the least significant set bit (starting from zero). If a least significant 1 bit is found, its bit index is returned. If the content of the input parameter is zero, then the content of the return value is undefined.
v | input parameter, should not be zero. |
Definition at line 445 of file rte_common.h.
|
inlinestatic |
Return the rounded-up log2 of a integer.
v | The input parameter. |
Definition at line 459 of file rte_common.h.
|
inlinestatic |
Return the last (most-significant) bit set.
x | The input parameter. |
Definition at line 480 of file rte_common.h.
|
inlinestatic |
Searches the input parameter for the least significant set bit (starting from zero). Safe version (checks for input parameter being zero).
pos
must be a valid pointer. It is not checked!v | The input parameter. |
pos | If v was not 0, this value will contain position of least significant bit within the input parameter. |
v
was 0, otherwise returns 1. Definition at line 500 of file rte_common.h.
|
inlinestatic |
Converts a numeric string to the equivalent uint64_t value. As well as straight number conversion, also recognises the suffixes k, m and g for kilobytes, megabytes and gigabytes respectively.
If a negative number is passed in i.e. a string with the first non-black character being "-", zero is returned. Zero is also returned in the case of an error with the strtoull call in the function.
str | String containing number to convert. |
Definition at line 572 of file rte_common.h.
void rte_exit | ( | int | exit_code, |
const char * | format, | ||
... | |||
) |
Function to terminate the application immediately, printing an error message and returning the exit_code back to the shell.
This function never returns
exit_code | The exit code to be returned by the application |
format | The format string to be used for printing the message. This can include printf format characters which will be expanded using any further parameters to the function. |