rte_ring_elem.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 *
 * Copyright (c) 2019 Arm Limited
 * Copyright (c) 2010-2017 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_ELEM_H_
#define _RTE_RING_ELEM_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <rte_ring_core.h>
#include <rte_ring_elem_pvt.h>

ssize_t rte_ring_get_memsize_elem(unsigned int esize, unsigned int count);

struct rte_ring *rte_ring_create_elem(const char *name, unsigned int esize,
            unsigned int count, int socket_id, unsigned int flags);

static __rte_always_inline unsigned int
rte_ring_mp_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_enqueue_elem(r, obj_table, esize, n,
            RTE_RING_QUEUE_FIXED, RTE_RING_SYNC_MT, free_space);
}

static __rte_always_inline unsigned int
rte_ring_sp_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_enqueue_elem(r, obj_table, esize, n,
            RTE_RING_QUEUE_FIXED, RTE_RING_SYNC_ST, free_space);
}

#include <rte_ring_hts.h>
#include <rte_ring_rts.h>

static __rte_always_inline unsigned int
rte_ring_enqueue_bulk_elem(struct rte_ring *r, const void *obj_table,
        unsigned int esize, unsigned int n, unsigned int *free_space)
{
    switch (r->prod.sync_type) {
    case RTE_RING_SYNC_MT:
        return rte_ring_mp_enqueue_bulk_elem(r, obj_table, esize, n,
            free_space);
    case RTE_RING_SYNC_ST:
        return rte_ring_sp_enqueue_bulk_elem(r, obj_table, esize, n,
            free_space);
    case RTE_RING_SYNC_MT_RTS:
        return rte_ring_mp_rts_enqueue_bulk_elem(r, obj_table, esize, n,
            free_space);
    case RTE_RING_SYNC_MT_HTS:
        return rte_ring_mp_hts_enqueue_bulk_elem(r, obj_table, esize, n,
            free_space);
    }

    /* valid ring should never reach this point */
    RTE_ASSERT(0);
    if (free_space != NULL)
        *free_space = 0;
    return 0;
}

static __rte_always_inline int
rte_ring_mp_enqueue_elem(struct rte_ring *r, void *obj, unsigned int esize)
{
    return rte_ring_mp_enqueue_bulk_elem(r, obj, esize, 1, NULL) ? 0 :
                                -ENOBUFS;
}

static __rte_always_inline int
rte_ring_sp_enqueue_elem(struct rte_ring *r, void *obj, unsigned int esize)
{
    return rte_ring_sp_enqueue_bulk_elem(r, obj, esize, 1, NULL) ? 0 :
                                -ENOBUFS;
}

static __rte_always_inline int
rte_ring_enqueue_elem(struct rte_ring *r, void *obj, unsigned int esize)
{
    return rte_ring_enqueue_bulk_elem(r, obj, esize, 1, NULL) ? 0 :
                                -ENOBUFS;
}

static __rte_always_inline unsigned int
rte_ring_mc_dequeue_bulk_elem(struct rte_ring *r, void *obj_table,
        unsigned int esize, unsigned int n, unsigned int *available)
{
    return __rte_ring_do_dequeue_elem(r, obj_table, esize, n,
            RTE_RING_QUEUE_FIXED, RTE_RING_SYNC_MT, available);
}

static __rte_always_inline unsigned int
rte_ring_sc_dequeue_bulk_elem(struct rte_ring *r, void *obj_table,
        unsigned int esize, unsigned int n, unsigned int *available)
{
    return __rte_ring_do_dequeue_elem(r, obj_table, esize, n,
            RTE_RING_QUEUE_FIXED, RTE_RING_SYNC_ST, available);
}

static __rte_always_inline unsigned int
rte_ring_dequeue_bulk_elem(struct rte_ring *r, void *obj_table,
        unsigned int esize, unsigned int n, unsigned int *available)
{
    switch (r->cons.sync_type) {
    case RTE_RING_SYNC_MT:
        return rte_ring_mc_dequeue_bulk_elem(r, obj_table, esize, n,
            available);
    case RTE_RING_SYNC_ST:
        return rte_ring_sc_dequeue_bulk_elem(r, obj_table, esize, n,
            available);
    case RTE_RING_SYNC_MT_RTS:
        return rte_ring_mc_rts_dequeue_bulk_elem(r, obj_table, esize,
            n, available);
    case RTE_RING_SYNC_MT_HTS:
        return rte_ring_mc_hts_dequeue_bulk_elem(r, obj_table, esize,
            n, available);
    }

    /* valid ring should never reach this point */
    RTE_ASSERT(0);
    if (available != NULL)
        *available = 0;
    return 0;
}

static __rte_always_inline int
rte_ring_mc_dequeue_elem(struct rte_ring *r, void *obj_p,
                unsigned int esize)
{
    return rte_ring_mc_dequeue_bulk_elem(r, obj_p, esize, 1, NULL)  ? 0 :
                                -ENOENT;
}

static __rte_always_inline int
rte_ring_sc_dequeue_elem(struct rte_ring *r, void *obj_p,
                unsigned int esize)
{
    return rte_ring_sc_dequeue_bulk_elem(r, obj_p, esize, 1, NULL) ? 0 :
                                -ENOENT;
}

static __rte_always_inline int
rte_ring_dequeue_elem(struct rte_ring *r, void *obj_p, unsigned int esize)
{
    return rte_ring_dequeue_bulk_elem(r, obj_p, esize, 1, NULL) ? 0 :
                                -ENOENT;
}

static __rte_always_inline unsigned int
rte_ring_mp_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_enqueue_elem(r, obj_table, esize, n,
            RTE_RING_QUEUE_VARIABLE, RTE_RING_SYNC_MT, free_space);
}

static __rte_always_inline unsigned int
rte_ring_sp_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_enqueue_elem(r, obj_table, esize, n,
            RTE_RING_QUEUE_VARIABLE, RTE_RING_SYNC_ST, free_space);
}

static __rte_always_inline unsigned int
rte_ring_enqueue_burst_elem(struct rte_ring *r, const void *obj_table,
        unsigned int esize, unsigned int n, unsigned int *free_space)
{
    switch (r->prod.sync_type) {
    case RTE_RING_SYNC_MT:
        return rte_ring_mp_enqueue_burst_elem(r, obj_table, esize, n,
            free_space);
    case RTE_RING_SYNC_ST:
        return rte_ring_sp_enqueue_burst_elem(r, obj_table, esize, n,
            free_space);
    case RTE_RING_SYNC_MT_RTS:
        return rte_ring_mp_rts_enqueue_burst_elem(r, obj_table, esize,
            n, free_space);
    case RTE_RING_SYNC_MT_HTS:
        return rte_ring_mp_hts_enqueue_burst_elem(r, obj_table, esize,
            n, free_space);
    }

    /* valid ring should never reach this point */
    RTE_ASSERT(0);
    if (free_space != NULL)
        *free_space = 0;
    return 0;
}

static __rte_always_inline unsigned int
rte_ring_mc_dequeue_burst_elem(struct rte_ring *r, void *obj_table,
        unsigned int esize, unsigned int n, unsigned int *available)
{
    return __rte_ring_do_dequeue_elem(r, obj_table, esize, n,
            RTE_RING_QUEUE_VARIABLE, RTE_RING_SYNC_MT, available);
}

static __rte_always_inline unsigned int
rte_ring_sc_dequeue_burst_elem(struct rte_ring *r, void *obj_table,
        unsigned int esize, unsigned int n, unsigned int *available)
{
    return __rte_ring_do_dequeue_elem(r, obj_table, esize, n,
            RTE_RING_QUEUE_VARIABLE, RTE_RING_SYNC_ST, available);
}

static __rte_always_inline unsigned int
rte_ring_dequeue_burst_elem(struct rte_ring *r, void *obj_table,
        unsigned int esize, unsigned int n, unsigned int *available)
{
    switch (r->cons.sync_type) {
    case RTE_RING_SYNC_MT:
        return rte_ring_mc_dequeue_burst_elem(r, obj_table, esize, n,
            available);
    case RTE_RING_SYNC_ST:
        return rte_ring_sc_dequeue_burst_elem(r, obj_table, esize, n,
            available);
    case RTE_RING_SYNC_MT_RTS:
        return rte_ring_mc_rts_dequeue_burst_elem(r, obj_table, esize,
            n, available);
    case RTE_RING_SYNC_MT_HTS:
        return rte_ring_mc_hts_dequeue_burst_elem(r, obj_table, esize,
            n, available);
    }

    /* valid ring should never reach this point */
    RTE_ASSERT(0);
    if (available != NULL)
        *available = 0;
    return 0;
}

#include <rte_ring_peek.h>
#include <rte_ring_peek_zc.h>

#include <rte_ring.h>

#ifdef __cplusplus
}
#endif

#endif /* _RTE_RING_ELEM_H_ */