rte_common.h

Go to the documentation of this file.

/*-
 *   BSD LICENSE
 *
 *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
 *   All rights reserved.
 *
 *   Redistribution and use in source and binary forms, with or without
 *   modification, are permitted provided that the following conditions
 *   are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in
 *       the documentation and/or other materials provided with the
 *       distribution.
 *     * Neither the name of Intel Corporation nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

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

#ifndef typeof
#define typeof __typeof__
#endif

#ifndef asm
#define asm __asm__
#endif

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

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

#define __rte_packed __attribute__((__packed__))

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

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

#define __rte_unused __attribute__((__unused__))

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

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

static inline int
rte_is_aligned(void *ptr, unsigned align)
{
        return RTE_PTR_ALIGN(ptr, align) == ptr;
}

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

#ifndef __OPTIMIZE__
#define RTE_BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
#else
extern int RTE_BUILD_BUG_ON_detected_error;
#define RTE_BUILD_BUG_ON(condition) do {             \
        ((void)sizeof(char[1 - 2*!!(condition)]));   \
        if (condition)                               \
                RTE_BUILD_BUG_ON_detected_error = 1; \
} while(0)
#endif

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

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 |= x >> 1;
        x |= x >> 2;
        x |= x >> 4;
        x |= x >> 8;
        x |= x >> 16;

        return x + 1;
}

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

        return v + 1;
}

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

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

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

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

#ifdef __SSE2__
#include <emmintrin.h>
static inline void
rte_pause (void)
{
        _mm_pause();
}
#else
static inline void
rte_pause(void) {}
#endif

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

#ifndef offsetof

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

#define _RTE_STR(x) #x

#define RTE_STR(x) _RTE_STR(x)

#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;
}

void
rte_exit(int exit_code, const char *format, ...)
        __attribute__((noreturn))
        __attribute__((format(printf, 2, 3)));

#ifdef __cplusplus
}
#endif

#endif