rte_bitops.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(c) 2020 Arm Limited
 */

#ifndef _RTE_BITOPS_H_
#define _RTE_BITOPS_H_

#include <stdint.h>
#include <rte_debug.h>
#include <rte_compat.h>

#ifdef __cplusplus
extern "C" {
#endif

#define RTE_BIT64(nr) (UINT64_C(1) << (nr))

#define RTE_BIT32(nr) (UINT32_C(1) << (nr))

/*------------------------ 32-bit relaxed operations ------------------------*/

__rte_experimental
static inline uint32_t
rte_bit_relaxed_get32(unsigned int nr, volatile uint32_t *addr)
{
    RTE_ASSERT(nr < 32);

    uint32_t mask = UINT32_C(1) << nr;
    return (*addr) & mask;
}

__rte_experimental
static inline void
rte_bit_relaxed_set32(unsigned int nr, volatile uint32_t *addr)
{
    RTE_ASSERT(nr < 32);

    uint32_t mask = RTE_BIT32(nr);
    *addr = (*addr) | mask;
}

__rte_experimental
static inline void
rte_bit_relaxed_clear32(unsigned int nr, volatile uint32_t *addr)
{
    RTE_ASSERT(nr < 32);

    uint32_t mask = RTE_BIT32(nr);
    *addr = (*addr) & (~mask);
}

__rte_experimental
static inline uint32_t
rte_bit_relaxed_test_and_set32(unsigned int nr, volatile uint32_t *addr)
{
    RTE_ASSERT(nr < 32);

    uint32_t mask = RTE_BIT32(nr);
    uint32_t val = *addr;
    *addr = val | mask;
    return val & mask;
}

__rte_experimental
static inline uint32_t
rte_bit_relaxed_test_and_clear32(unsigned int nr, volatile uint32_t *addr)
{
    RTE_ASSERT(nr < 32);

    uint32_t mask = RTE_BIT32(nr);
    uint32_t val = *addr;
    *addr = val & (~mask);
    return val & mask;
}

/*------------------------ 64-bit relaxed operations ------------------------*/

__rte_experimental
static inline uint64_t
rte_bit_relaxed_get64(unsigned int nr, volatile uint64_t *addr)
{
    RTE_ASSERT(nr < 64);

    uint64_t mask = RTE_BIT64(nr);
    return (*addr) & mask;
}

__rte_experimental
static inline void
rte_bit_relaxed_set64(unsigned int nr, volatile uint64_t *addr)
{
    RTE_ASSERT(nr < 64);

    uint64_t mask = RTE_BIT64(nr);
    (*addr) = (*addr) | mask;
}

__rte_experimental
static inline void
rte_bit_relaxed_clear64(unsigned int nr, volatile uint64_t *addr)
{
    RTE_ASSERT(nr < 64);

    uint64_t mask = RTE_BIT64(nr);
    *addr = (*addr) & (~mask);
}

__rte_experimental
static inline uint64_t
rte_bit_relaxed_test_and_set64(unsigned int nr, volatile uint64_t *addr)
{
    RTE_ASSERT(nr < 64);

    uint64_t mask = RTE_BIT64(nr);
    uint64_t val = *addr;
    *addr = val | mask;
    return val;
}

__rte_experimental
static inline uint64_t
rte_bit_relaxed_test_and_clear64(unsigned int nr, volatile uint64_t *addr)
{
    RTE_ASSERT(nr < 64);

    uint64_t mask = RTE_BIT64(nr);
    uint64_t val = *addr;
    *addr = val & (~mask);
    return val & mask;
}

#ifdef __cplusplus
}
#endif

#endif /* _RTE_BITOPS_H_ */