rte_ring_rts.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 *
 * Copyright (c) 2010-2020 Intel Corporation
 * Copyright (c) 2007-2009 Kip Macy kmacy@freebsd.org
 * All rights reserved.
 * Derived from FreeBSD's bufring.h
 * Used as BSD-3 Licensed with permission from Kip Macy.
 */

#ifndef _RTE_RING_RTS_H_
#define _RTE_RING_RTS_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <rte_ring_rts_c11_mem.h>

static __rte_always_inline unsigned int
__rte_ring_do_rts_enqueue_elem(struct rte_ring *r, const void *obj_table,
    uint32_t esize, uint32_t n, enum rte_ring_queue_behavior behavior,
    uint32_t *free_space)
{
    uint32_t free, head;

    n =  __rte_ring_rts_move_prod_head(r, n, behavior, &head, &free);

    if (n != 0) {
        __rte_ring_enqueue_elems(r, head, obj_table, esize, n);
        __rte_ring_rts_update_tail(&r->rts_prod);
    }

    if (free_space != NULL)
        *free_space = free - n;
    return n;
}

static __rte_always_inline unsigned int
__rte_ring_do_rts_dequeue_elem(struct rte_ring *r, void *obj_table,
    uint32_t esize, uint32_t n, enum rte_ring_queue_behavior behavior,
    uint32_t *available)
{
    uint32_t entries, head;

    n = __rte_ring_rts_move_cons_head(r, n, behavior, &head, &entries);

    if (n != 0) {
        __rte_ring_dequeue_elems(r, head, obj_table, esize, n);
        __rte_ring_rts_update_tail(&r->rts_cons);
    }

    if (available != NULL)
        *available = entries - n;
    return n;
}

__rte_experimental
static __rte_always_inline unsigned int
rte_ring_mp_rts_enqueue_bulk_elem(struct rte_ring *r, const void *obj_table,
    unsigned int esize, unsigned int n, unsigned int *free_space)
{
    return __rte_ring_do_rts_enqueue_elem(r, obj_table, esize, n,
            RTE_RING_QUEUE_FIXED, free_space);
}

__rte_experimental
static __rte_always_inline unsigned int
rte_ring_mc_rts_dequeue_bulk_elem(struct rte_ring *r, void *obj_table,
    unsigned int esize, unsigned int n, unsigned int *available)
{
    return __rte_ring_do_rts_dequeue_elem(r, obj_table, esize, n,
            RTE_RING_QUEUE_FIXED, available);
}

__rte_experimental
static __rte_always_inline unsigned
rte_ring_mp_rts_enqueue_burst_elem(struct rte_ring *r, const void *obj_table,
    unsigned int esize, unsigned int n, unsigned int *free_space)
{
    return __rte_ring_do_rts_enqueue_elem(r, obj_table, esize, n,
            RTE_RING_QUEUE_VARIABLE, free_space);
}

__rte_experimental
static __rte_always_inline unsigned
rte_ring_mc_rts_dequeue_burst_elem(struct rte_ring *r, void *obj_table,
    unsigned int esize, unsigned int n, unsigned int *available)
{
    return __rte_ring_do_rts_dequeue_elem(r, obj_table, esize, n,
            RTE_RING_QUEUE_VARIABLE, available);
}

__rte_experimental
static __rte_always_inline unsigned int
rte_ring_mp_rts_enqueue_bulk(struct rte_ring *r, void * const *obj_table,
             unsigned int n, unsigned int *free_space)
{
    return rte_ring_mp_rts_enqueue_bulk_elem(r, obj_table,
            sizeof(uintptr_t), n, free_space);
}

__rte_experimental
static __rte_always_inline unsigned int
rte_ring_mc_rts_dequeue_bulk(struct rte_ring *r, void **obj_table,
        unsigned int n, unsigned int *available)
{
    return rte_ring_mc_rts_dequeue_bulk_elem(r, obj_table,
            sizeof(uintptr_t), n, available);
}

__rte_experimental
static __rte_always_inline unsigned
rte_ring_mp_rts_enqueue_burst(struct rte_ring *r, void * const *obj_table,
             unsigned int n, unsigned int *free_space)
{
    return rte_ring_mp_rts_enqueue_burst_elem(r, obj_table,
            sizeof(uintptr_t), n, free_space);
}

__rte_experimental
static __rte_always_inline unsigned
rte_ring_mc_rts_dequeue_burst(struct rte_ring *r, void **obj_table,
        unsigned int n, unsigned int *available)
{
    return rte_ring_mc_rts_dequeue_burst_elem(r, obj_table,
            sizeof(uintptr_t), n, available);
}

__rte_experimental
static inline uint32_t
rte_ring_get_prod_htd_max(const struct rte_ring *r)
{
    if (r->prod.sync_type == RTE_RING_SYNC_MT_RTS)
        return r->rts_prod.htd_max;
    return UINT32_MAX;
}

__rte_experimental
static inline int
rte_ring_set_prod_htd_max(struct rte_ring *r, uint32_t v)
{
    if (r->prod.sync_type != RTE_RING_SYNC_MT_RTS)
        return -ENOTSUP;

    r->rts_prod.htd_max = v;
    return 0;
}

__rte_experimental
static inline uint32_t
rte_ring_get_cons_htd_max(const struct rte_ring *r)
{
    if (r->cons.sync_type == RTE_RING_SYNC_MT_RTS)
        return r->rts_cons.htd_max;
    return UINT32_MAX;
}

__rte_experimental
static inline int
rte_ring_set_cons_htd_max(struct rte_ring *r, uint32_t v)
{
    if (r->cons.sync_type != RTE_RING_SYNC_MT_RTS)
        return -ENOTSUP;

    r->rts_cons.htd_max = v;
    return 0;
}

#ifdef __cplusplus
}
#endif

#endif /* _RTE_RING_RTS_H_ */