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_

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <stdlib.h>
#include <ctype.h>
#include <errno.h>
#include <limits.h>

#include <rte_config.h>

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

#ifndef typeof
#define typeof __typeof__
#endif

#ifndef asm
#define asm __asm__
#endif

#if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 201112L
#define RTE_STD_C11 __extension__
#else
#define RTE_STD_C11
#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 __INTEL_COMPILER
#define RTE_CC_ICC
#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

#define __rte_aligned(a) __attribute__((__aligned__(a)))

#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

#define __rte_packed __attribute__((__packed__))

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

#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

#define __rte_weak __attribute__((__weak__))

#define __rte_used __attribute__((used))

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

#define __rte_unused __attribute__((__unused__))

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

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

#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

#if defined(RTE_CC_GCC) || defined(RTE_CC_CLANG)
#define __rte_alloc_size(...) \
    __attribute__((alloc_size(__VA_ARGS__)))
#else
#define __rte_alloc_size(...)
#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 */
#define RTE_INIT_PRIO(func, prio) \
static void __attribute__((constructor(RTE_PRIO(prio)), used)) func(void)
#endif

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

#ifndef RTE_FINI_PRIO /* Allow to override from EAL */
#define RTE_FINI_PRIO(func, prio) \
static void __attribute__((destructor(RTE_PRIO(prio)), used)) func(void)
#endif

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

#define __rte_noreturn __attribute__((noreturn))

#define __rte_always_inline inline __attribute__((always_inline))

#define __rte_noinline __attribute__((noinline))

#define __rte_hot __attribute__((hot))

#define __rte_cold __attribute__((cold))

/*********** 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))

#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)              \
    ({                          \
        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(void *ptr, unsigned align)
{
    return RTE_PTR_ALIGN(ptr, align) == ptr;
}

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

#define RTE_BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))

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

#define RTE_CACHE_LINE_MASK (RTE_CACHE_LINE_SIZE-1)

#define RTE_CACHE_LINE_ROUNDUP(size) \
    (RTE_CACHE_LINE_SIZE * ((size + RTE_CACHE_LINE_SIZE - 1) / \
    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)

/*********** 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 ********/

__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];

static inline uint32_t
rte_combine32ms1b(uint32_t x)
{
    x |= x >> 1;
    x |= x >> 2;
    x |= x >> 4;
    x |= x >> 8;
    x |= x >> 16;

    return x;
}

static inline uint64_t
rte_combine64ms1b(uint64_t v)
{
    v |= v >> 1;
    v |= v >> 2;
    v |= v >> 4;
    v |= v >> 8;
    v |= v >> 16;
    v |= v >> 32;

    return v;
}

/*********** Macros to work with powers of 2 ********/

#define RTE_IS_POWER_OF_2(n) ((n) && !(((n) - 1) & (n)))

static inline int
rte_is_power_of_2(uint32_t n)
{
    return n && !(n & (n - 1));
}

static inline uint32_t
rte_align32pow2(uint32_t x)
{
    x--;
    x = rte_combine32ms1b(x);

    return x + 1;
}

static inline uint32_t
rte_align32prevpow2(uint32_t x)
{
    x = rte_combine32ms1b(x);

    return x - (x >> 1);
}

static inline uint64_t
rte_align64pow2(uint64_t v)
{
    v--;
    v = rte_combine64ms1b(v);

    return v + 1;
}

static inline uint64_t
rte_align64prevpow2(uint64_t v)
{
    v = rte_combine64ms1b(v);

    return v - (v >> 1);
}

/*********** 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_MAX(a, b) \
    __extension__ ({ \
        typeof (a) _a = (a); \
        typeof (b) _b = (b); \
        _a > _b ? _a : _b; \
    })

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

static inline uint32_t
rte_bsf32(uint32_t v)
{
    return (uint32_t)__builtin_ctz(v);
}

static inline int
rte_bsf32_safe(uint64_t v, uint32_t *pos)
{
    if (v == 0)
        return 0;

    *pos = rte_bsf32(v);
    return 1;
}

static inline uint32_t
rte_log2_u32(uint32_t v)
{
    if (v == 0)
        return 0;
    v = rte_align32pow2(v);
    return rte_bsf32(v);
}


static inline int
rte_fls_u32(uint32_t x)
{
    return (x == 0) ? 0 : 32 - __builtin_clz(x);
}

static inline int
rte_bsf64(uint64_t v)
{
    return (uint32_t)__builtin_ctzll(v);
}

static inline int
rte_bsf64_safe(uint64_t v, uint32_t *pos)
{
    if (v == 0)
        return 0;

    *pos = rte_bsf64(v);
    return 1;
}

static inline int
rte_fls_u64(uint64_t x)
{
    return (x == 0) ? 0 : 64 - __builtin_clzll(x);
}

static inline uint32_t
rte_log2_u64(uint64_t v)
{
    if (v == 0)
        return 0;
    v = rte_align64pow2(v);
    /* we checked for v being 0 already, so no undefined behavior */
    return rte_bsf64(v);
}

#ifndef offsetof

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

#ifndef container_of
#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

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

static inline uint64_t
rte_str_to_size(const char *str)
{
    char *endptr;
    unsigned long long size;

    while (isspace((int)*str))
        str++;
    if (*str == '-')
        return 0;

    errno = 0;
    size = strtoull(str, &endptr, 0);
    if (errno)
        return 0;

    if (*endptr == ' ')
        endptr++; /* allow 1 space gap */

    switch (*endptr){
    case 'G': case 'g': size *= 1024; /* fall-through */
    case 'M': case 'm': size *= 1024; /* fall-through */
    case 'K': case 'k': size *= 1024; /* fall-through */
    default:
        break;
    }
    return size;
}

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

#ifdef __cplusplus
}
#endif

#endif