rte_common.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(c) 2010-2019 Intel Corporation
 */

#ifndef _RTE_COMMON_H_
#define _RTE_COMMON_H_

#include <assert.h>
#include <limits.h>
#include <stdbool.h>
#include <stdint.h>
#include <stdalign.h>

#include <rte_compat.h>
#include <rte_config.h>

/* OS specific include */
#include <rte_os.h>

#ifdef __cplusplus
extern "C" {
#endif

#ifndef RTE_TOOLCHAIN_MSVC
#ifndef typeof
#define typeof __typeof__
#endif
#endif

#ifndef __cplusplus
#ifndef asm
#define asm __asm__
#endif
#endif

#ifdef RTE_TOOLCHAIN_MSVC
#ifdef __cplusplus
#define __extension__
#endif
#endif

/*
 * Macro __rte_constant checks if an expression's value can be determined at
 * compile time. It takes a single argument, the expression to test, and
 * returns 1 if the expression is a compile-time constant, and 0 otherwise.
 * For most compilers it uses built-in function __builtin_constant_p, but for
 * MSVC it uses a different method because MSVC does not have an equivalent
 * to __builtin_constant_p.
 *
 * The trick used with MSVC relies on the way null pointer constants interact
 * with the type of a ?: expression:
 * An integer constant expression with the value 0, or such an expression cast
 * to type void *, is called a null pointer constant.
 * If both the second and third operands (of the ?: expression) are pointers or
 * one is a null pointer constant and the other is a pointer, the result type
 * is a pointer to a type qualified with all the type qualifiers of the types
 * referenced by both operands. Furthermore, if both operands are pointers to
 * compatible types or to differently qualified versions of compatible types,
 * the result type is a pointer to an appropriately qualified version of the
 * composite type; if one operand is a null pointer constant, the result has
 * the type of the other operand; otherwise, one operand is a pointer to void
 * or a qualified version of void, in which case the result type is a pointer
 * to an appropriately qualified version of void.
 *
 * The _Generic keyword then checks the type of the expression
 * (void *) ((e) * 0ll). It matches this type against the types listed in the
 * _Generic construct:
 *     - If the type is int *, the result is 1.
 *     - If the type is void *, the result is 0.
 *
 * This explanation with some more details can be found at:
 * https://stackoverflow.com/questions/49480442/detecting-integer-constant-expressions-in-macros
 */
#ifdef RTE_TOOLCHAIN_MSVC
#define __rte_constant(e) _Generic((1 ? (void *) ((e) * 0ll) : (int *) 0), int * : 1, void * : 0)
#else
#define __rte_constant(e) __extension__(__builtin_constant_p(e))
#endif

/*
 * RTE_TOOLCHAIN_GCC is defined if the target is built with GCC,
 * while a host application (like pmdinfogen) may have another compiler.
 * RTE_CC_IS_GNU is true if the file is compiled with GCC,
 * no matter it is a target or host application.
 */
#define RTE_CC_IS_GNU 0
#if defined __clang__
#define RTE_CC_CLANG
#elif defined __GNUC__
#define RTE_CC_GCC
#undef RTE_CC_IS_GNU
#define RTE_CC_IS_GNU 1
#endif
#if RTE_CC_IS_GNU
#define GCC_VERSION (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 +  \
        __GNUC_PATCHLEVEL__)
#endif

#ifdef RTE_TOOLCHAIN_MSVC
#define __rte_aligned(a) __declspec(align(a))
#else
#define __rte_aligned(a) __attribute__((__aligned__(a)))
#endif

#ifdef RTE_ARCH_STRICT_ALIGN
typedef uint64_t unaligned_uint64_t __rte_aligned(1);
typedef uint32_t unaligned_uint32_t __rte_aligned(1);
typedef uint16_t unaligned_uint16_t __rte_aligned(1);
#else
typedef uint64_t unaligned_uint64_t;
typedef uint32_t unaligned_uint32_t;
typedef uint16_t unaligned_uint16_t;
#endif

#ifdef RTE_TOOLCHAIN_MSVC
#define __rte_packed RTE_DEPRECATED(__rte_packed)
#else
#define __rte_packed (RTE_DEPRECATED(__rte_packed) __attribute__((__packed__)))
#endif

#ifdef RTE_TOOLCHAIN_MSVC
#define __rte_packed_begin __pragma(pack(push, 1))
#define __rte_packed_end __pragma(pack(pop))
#else
#define __rte_packed_begin
#define __rte_packed_end __attribute__((__packed__))
#endif

#ifdef RTE_TOOLCHAIN_MSVC
#define __rte_may_alias
#else
#define __rte_may_alias __attribute__((__may_alias__))
#endif

/******* Macro to mark functions and fields scheduled for removal *****/
#ifdef RTE_TOOLCHAIN_MSVC
#define __rte_deprecated
#define __rte_deprecated_msg(msg)
#else
#define __rte_deprecated    __attribute__((__deprecated__))
#define __rte_deprecated_msg(msg)   __attribute__((__deprecated__(msg)))
#endif

#if defined(RTE_CC_GCC) || defined(RTE_CC_CLANG)
#define RTE_PRAGMA(x)  _Pragma(#x)
#define RTE_PRAGMA_WARNING(w) RTE_PRAGMA(GCC warning #w)
#define RTE_DEPRECATED(x)  RTE_PRAGMA_WARNING(#x is deprecated)
#else
#define RTE_DEPRECATED(x)
#endif

#if !defined(RTE_TOOLCHAIN_MSVC)
#define __rte_diagnostic_push _Pragma("GCC diagnostic push")
#define __rte_diagnostic_pop  _Pragma("GCC diagnostic pop")
#else
#define __rte_diagnostic_push
#define __rte_diagnostic_pop
#endif

#if !defined(RTE_TOOLCHAIN_MSVC)
#define __rte_diagnostic_ignored_wcast_qual _Pragma("GCC diagnostic ignored \"-Wcast-qual\"")
#else
#define __rte_diagnostic_ignored_wcast_qual
#endif

#ifdef RTE_TOOLCHAIN_MSVC
#define __rte_weak RTE_DEPRECATED(__rte_weak)
#else
#define __rte_weak RTE_DEPRECATED(__rte_weak) __attribute__((__weak__))
#endif

#ifdef RTE_TOOLCHAIN_MSVC
#define __rte_pure
#else
#define __rte_pure __attribute__((pure))
#endif

#ifdef RTE_TOOLCHAIN_MSVC
#define __rte_used
#else
#define __rte_used __attribute__((used))
#endif

/*********** Macros to eliminate unused variable warnings ********/

#ifdef RTE_TOOLCHAIN_MSVC
#define __rte_unused
#else
#define __rte_unused __attribute__((__unused__))
#endif

#if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 199901L
#define __rte_restrict __restrict
#else
#define __rte_restrict restrict
#endif

#define RTE_SET_USED(x) (void)(x)

#ifdef RTE_TOOLCHAIN_MSVC
#define __rte_format_printf(format_index, first_arg)
#else
#if RTE_CC_IS_GNU
#define __rte_format_printf(format_index, first_arg) \
    __attribute__((format(gnu_printf, format_index, first_arg)))
#else
#define __rte_format_printf(format_index, first_arg) \
    __attribute__((format(printf, format_index, first_arg)))
#endif
#endif

#ifdef RTE_TOOLCHAIN_MSVC
#define __rte_section(name) \
    __pragma(data_seg(name)) __declspec(allocate(name))
#else
#define __rte_section(name) \
    __attribute__((section(name)))
#endif

#if defined(RTE_CC_GCC) || defined(RTE_CC_CLANG)
#define __rte_alloc_size(...) \
    __attribute__((alloc_size(__VA_ARGS__)))
#else
#define __rte_alloc_size(...)
#endif

#if defined(RTE_CC_GCC)
#define __rte_alloc_align(argno) \
    __attribute__((alloc_align(argno)))
#else
#define __rte_alloc_align(argno)
#endif

#if defined(RTE_CC_GCC) || defined(RTE_CC_CLANG)
#define __rte_malloc __attribute__((__malloc__))
#else
#define __rte_malloc
#endif

#if defined(RTE_TOOLCHAIN_GCC) && (GCC_VERSION >= 110000)
#define __rte_dealloc(dealloc, argno) \
    __attribute__((malloc(dealloc, argno)))
#else
#define __rte_dealloc(dealloc, argno)
#endif

#define RTE_PRIORITY_LOG 101
#define RTE_PRIORITY_BUS 110
#define RTE_PRIORITY_CLASS 120
#define RTE_PRIORITY_LAST 65535

#define RTE_PRIO(prio) \
    RTE_PRIORITY_ ## prio

#ifndef RTE_INIT_PRIO /* Allow to override from EAL */
#ifndef RTE_TOOLCHAIN_MSVC
#define RTE_INIT_PRIO(func, prio) \
static void __attribute__((constructor(RTE_PRIO(prio)), used)) func(void)
#else
/* definition from the Microsoft CRT */
typedef int(__cdecl *_PIFV)(void);

#define CTOR_SECTION_LOG ".CRT$XIB"
#define CTOR_SECTION_BUS ".CRT$XIC"
#define CTOR_SECTION_CLASS ".CRT$XID"
#define CTOR_SECTION_LAST ".CRT$XIY"

#define CTOR_PRIORITY_TO_SECTION(priority) CTOR_SECTION_ ## priority

#define RTE_INIT_PRIO(name, priority) \
    static void name(void); \
    static int __cdecl name ## _thunk(void) { name(); return 0; } \
    __pragma(const_seg(CTOR_PRIORITY_TO_SECTION(priority))) \
    __declspec(allocate(CTOR_PRIORITY_TO_SECTION(priority))) \
        _PIFV name ## _pointer = &name ## _thunk; \
    __pragma(const_seg()) \
    static void name(void)
#endif
#endif

#define RTE_INIT(func) \
    RTE_INIT_PRIO(func, LAST)

#ifndef RTE_FINI_PRIO /* Allow to override from EAL */
#ifndef RTE_TOOLCHAIN_MSVC
#define RTE_FINI_PRIO(func, prio) \
static void __attribute__((destructor(RTE_PRIO(prio)), used)) func(void)
#else
#define DTOR_SECTION_LOG "mydtor$B"
#define DTOR_SECTION_BUS "mydtor$C"
#define DTOR_SECTION_CLASS "mydtor$D"
#define DTOR_SECTION_LAST "mydtor$Y"

#define DTOR_PRIORITY_TO_SECTION(priority) DTOR_SECTION_ ## priority

#define RTE_FINI_PRIO(name, priority) \
    static void name(void); \
    __pragma(const_seg(DTOR_PRIORITY_TO_SECTION(priority))) \
    __declspec(allocate(DTOR_PRIORITY_TO_SECTION(priority))) void *name ## _pointer = &name; \
    __pragma(const_seg()) \
    static void name(void)
#endif
#endif

#define RTE_FINI(func) \
    RTE_FINI_PRIO(func, LAST)

#ifdef RTE_TOOLCHAIN_MSVC
#define __rte_noreturn
#else
#define __rte_noreturn __attribute__((noreturn))
#endif

#if defined(RTE_TOOLCHAIN_GCC) || defined(RTE_TOOLCHAIN_CLANG)
#define __rte_unreachable() __extension__(__builtin_unreachable())
#else
#define __rte_unreachable() __assume(0)
#endif

#ifdef RTE_TOOLCHAIN_MSVC
#define __rte_warn_unused_result
#else
#define __rte_warn_unused_result __attribute__((warn_unused_result))
#endif

#ifdef RTE_TOOLCHAIN_MSVC
#define __rte_always_inline __forceinline
#else
#define __rte_always_inline inline __attribute__((always_inline))
#endif

#ifdef RTE_TOOLCHAIN_MSVC
#define __rte_noinline __declspec(noinline)
#else
#define __rte_noinline __attribute__((noinline))
#endif

#ifdef RTE_TOOLCHAIN_MSVC
#define __rte_hot
#else
#define __rte_hot __attribute__((hot))
#endif

#ifdef RTE_TOOLCHAIN_MSVC
#define __rte_cold
#else
#define __rte_cold __attribute__((cold))
#endif

#if defined(RTE_TOOLCHAIN_GCC) && (GCC_VERSION >= 130000)
#define __rte_assume(condition) __attribute__((assume(condition)))
#elif defined(RTE_TOOLCHAIN_GCC)
#define __rte_assume(condition) do { if (!(condition)) __rte_unreachable(); } while (0)
#elif defined(RTE_TOOLCHAIN_CLANG)
#define __rte_assume(condition) __extension__(__builtin_assume(condition))
#else
#define __rte_assume(condition) __assume(condition)
#endif

#ifdef RTE_MALLOC_ASAN
#ifdef RTE_CC_CLANG
#define __rte_no_asan __attribute__((no_sanitize("address", "hwaddress")))
#else
#define __rte_no_asan __attribute__((no_sanitize_address))
#endif
#else /* ! RTE_MALLOC_ASAN */
#define __rte_no_asan
#endif

/*********** Macros for pointer arithmetic ********/

#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))

/*********** Macros for casting pointers ********/

#define RTE_PTR_UNQUAL(X) ((void *)(uintptr_t)(X))

#define RTE_CAST_PTR(type, ptr) ((type)(uintptr_t)(ptr))

#define RTE_CAST_FIELD(var, field, type) \
    (*(type *)((uintptr_t)(var) + offsetof(typeof(*(var)), field)))

/*********** Macros/static functions for doing alignment ********/


#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_ALIGN_MUL_NEAR(v, mul)              \
    __extension__ ({                    \
        typeof(v) ceil = RTE_ALIGN_MUL_CEIL(v, mul);    \
        typeof(v) floor = RTE_ALIGN_MUL_FLOOR(v, mul);  \
        (ceil - (v)) > ((v) - floor) ? floor : ceil;    \
    })

static inline int
rte_is_aligned(const void * const __rte_restrict ptr, const unsigned int align)
{
    return ((uintptr_t)ptr & (align - 1)) == 0;
}

/*********** Macros for compile type checks ********/

/* Workaround for toolchain issues with missing C11 macro in FreeBSD */
#if !defined(static_assert) && !defined(__cplusplus)
#define static_assert   _Static_assert
#endif

#define RTE_BUILD_BUG_ON(condition) do { static_assert(!(condition), #condition); } while (0)

/*********** Cache line related macros ********/

#define RTE_CACHE_LINE_MASK (RTE_CACHE_LINE_SIZE-1)

#define RTE_CACHE_LINE_ROUNDUP(size) RTE_ALIGN_CEIL(size, RTE_CACHE_LINE_SIZE)

#if RTE_CACHE_LINE_SIZE == 64
#define RTE_CACHE_LINE_SIZE_LOG2 6
#elif RTE_CACHE_LINE_SIZE == 128
#define RTE_CACHE_LINE_SIZE_LOG2 7
#else
#error "Unsupported cache line size"
#endif

#define RTE_CACHE_LINE_MIN_SIZE 64

#define __rte_cache_aligned __rte_aligned(RTE_CACHE_LINE_SIZE)

#define __rte_cache_min_aligned __rte_aligned(RTE_CACHE_LINE_MIN_SIZE)

#define _RTE_CACHE_GUARD_HELPER2(unique) \
    alignas(RTE_CACHE_LINE_SIZE) \
    char cache_guard_ ## unique[RTE_CACHE_LINE_SIZE * RTE_CACHE_GUARD_LINES]
#define _RTE_CACHE_GUARD_HELPER1(unique) _RTE_CACHE_GUARD_HELPER2(unique)

#define RTE_CACHE_GUARD _RTE_CACHE_GUARD_HELPER1(__COUNTER__)

/*********** PA/IOVA type definitions ********/

typedef uint64_t phys_addr_t;
#define RTE_BAD_PHYS_ADDR ((phys_addr_t)-1)

typedef uint64_t rte_iova_t;
#define RTE_BAD_IOVA ((rte_iova_t)-1)

/*********** Structure alignment markers ********/

#ifndef RTE_TOOLCHAIN_MSVC

__extension__ typedef void    *RTE_MARKER[0];
__extension__ typedef uint8_t  RTE_MARKER8[0];
__extension__ typedef uint16_t RTE_MARKER16[0];
__extension__ typedef uint32_t RTE_MARKER32[0];
__extension__ typedef uint64_t RTE_MARKER64[0];

#endif

/*********** Macros for calculating min and max **********/

#define RTE_MIN(a, b) \
    __extension__ ({ \
        typeof (a) _a = (a); \
        typeof (b) _b = (b); \
        _a < _b ? _a : _b; \
    })

#define RTE_MIN_T(a, b, t) \
    ((t)(a) < (t)(b) ? (t)(a) : (t)(b))

#define RTE_MAX(a, b) \
    __extension__ ({ \
        typeof (a) _a = (a); \
        typeof (b) _b = (b); \
        _a > _b ? _a : _b; \
    })

#define RTE_MAX_T(a, b, t) \
    ((t)(a) > (t)(b) ? (t)(a) : (t)(b))

/*********** Other general functions / macros ********/

#ifndef offsetof

#define offsetof(TYPE, MEMBER)  __builtin_offsetof (TYPE, MEMBER)
#endif

#ifndef container_of
#ifdef RTE_TOOLCHAIN_MSVC
#define container_of(ptr, type, member) \
            ((type *)((uintptr_t)(ptr) - offsetof(type, member)))
#else
#define container_of(ptr, type, member) __extension__ ({        \
            const typeof(((type *)0)->member) *_ptr = (ptr); \
            __rte_unused type *_target_ptr =    \
                (type *)(ptr);              \
            (type *)(((uintptr_t)_ptr) - offsetof(type, member)); \
        })
#endif
#endif

#define RTE_SWAP(a, b) \
    __extension__ ({ \
        typeof (a) _a = a; \
        a = b; \
        b = _a; \
    })

#define RTE_SIZEOF_FIELD(type, field) (sizeof(((type *)0)->field))

#define _RTE_STR(x) #x

#define RTE_STR(x) _RTE_STR(x)

#define RTE_FMT(fmt, ...) fmt "%.0s", __VA_ARGS__ ""
#define RTE_FMT_HEAD(fmt, ...) fmt
#define RTE_FMT_TAIL(fmt, ...) __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]))

uint64_t
rte_str_to_size(const char *str);

__rte_experimental
char *
rte_size_to_str(char *buf, int buf_size, uint64_t count, bool use_iec, const char *unit);

__rte_noreturn void
rte_exit(int exit_code, const char *format, ...)
    __rte_format_printf(2, 3);

#ifdef __cplusplus
}
#endif

#endif