rte_ring_peek.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_PEEK_H_
#define _RTE_RING_PEEK_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <rte_ring_peek_c11_mem.h>

static __rte_always_inline unsigned int
__rte_ring_do_enqueue_start(struct rte_ring *r, uint32_t n,
        enum rte_ring_queue_behavior behavior, uint32_t *free_space)
{
    uint32_t free, head, next;

    switch (r->prod.sync_type) {
    case RTE_RING_SYNC_ST:
        n = __rte_ring_move_prod_head(r, RTE_RING_SYNC_ST, n,
            behavior, &head, &next, &free);
        break;
    case RTE_RING_SYNC_MT_HTS:
        n =  __rte_ring_hts_move_prod_head(r, n, behavior,
            &head, &free);
        break;
    case RTE_RING_SYNC_MT:
    case RTE_RING_SYNC_MT_RTS:
    default:
        /* unsupported mode, shouldn't be here */
        RTE_ASSERT(0);
        n = 0;
        free = 0;
    }

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

__rte_experimental
static __rte_always_inline unsigned int
rte_ring_enqueue_bulk_elem_start(struct rte_ring *r, unsigned int n,
        unsigned int *free_space)
{
    return __rte_ring_do_enqueue_start(r, n, RTE_RING_QUEUE_FIXED,
            free_space);
}

__rte_experimental
static __rte_always_inline unsigned int
rte_ring_enqueue_bulk_start(struct rte_ring *r, unsigned int n,
        unsigned int *free_space)
{
    return rte_ring_enqueue_bulk_elem_start(r, n, free_space);
}

__rte_experimental
static __rte_always_inline unsigned int
rte_ring_enqueue_burst_elem_start(struct rte_ring *r, unsigned int n,
        unsigned int *free_space)
{
    return __rte_ring_do_enqueue_start(r, n, RTE_RING_QUEUE_VARIABLE,
            free_space);
}

__rte_experimental
static __rte_always_inline unsigned int
rte_ring_enqueue_burst_start(struct rte_ring *r, unsigned int n,
        unsigned int *free_space)
{
    return rte_ring_enqueue_burst_elem_start(r, n, free_space);
}

__rte_experimental
static __rte_always_inline void
rte_ring_enqueue_elem_finish(struct rte_ring *r, const void *obj_table,
        unsigned int esize, unsigned int n)
{
    uint32_t tail;

    switch (r->prod.sync_type) {
    case RTE_RING_SYNC_ST:
        n = __rte_ring_st_get_tail(&r->prod, &tail, n);
        if (n != 0)
            __rte_ring_enqueue_elems(r, tail, obj_table, esize, n);
        __rte_ring_st_set_head_tail(&r->prod, tail, n, 1);
        break;
    case RTE_RING_SYNC_MT_HTS:
        n = __rte_ring_hts_get_tail(&r->hts_prod, &tail, n);
        if (n != 0)
            __rte_ring_enqueue_elems(r, tail, obj_table, esize, n);
        __rte_ring_hts_set_head_tail(&r->hts_prod, tail, n, 1);
        break;
    case RTE_RING_SYNC_MT:
    case RTE_RING_SYNC_MT_RTS:
    default:
        /* unsupported mode, shouldn't be here */
        RTE_ASSERT(0);
    }
}

__rte_experimental
static __rte_always_inline void
rte_ring_enqueue_finish(struct rte_ring *r, void * const *obj_table,
        unsigned int n)
{
    rte_ring_enqueue_elem_finish(r, obj_table, sizeof(uintptr_t), n);
}

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

    switch (r->cons.sync_type) {
    case RTE_RING_SYNC_ST:
        n = __rte_ring_move_cons_head(r, RTE_RING_SYNC_ST, n,
            behavior, &head, &next, &avail);
        break;
    case RTE_RING_SYNC_MT_HTS:
        n =  __rte_ring_hts_move_cons_head(r, n, behavior,
            &head, &avail);
        break;
    case RTE_RING_SYNC_MT:
    case RTE_RING_SYNC_MT_RTS:
    default:
        /* unsupported mode, shouldn't be here */
        RTE_ASSERT(0);
        n = 0;
        avail = 0;
    }

    if (n != 0)
        __rte_ring_dequeue_elems(r, head, obj_table, esize, n);

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

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

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

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

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

__rte_experimental
static __rte_always_inline void
rte_ring_dequeue_elem_finish(struct rte_ring *r, unsigned int n)
{
    uint32_t tail;

    switch (r->cons.sync_type) {
    case RTE_RING_SYNC_ST:
        n = __rte_ring_st_get_tail(&r->cons, &tail, n);
        __rte_ring_st_set_head_tail(&r->cons, tail, n, 0);
        break;
    case RTE_RING_SYNC_MT_HTS:
        n = __rte_ring_hts_get_tail(&r->hts_cons, &tail, n);
        __rte_ring_hts_set_head_tail(&r->hts_cons, tail, n, 0);
        break;
    case RTE_RING_SYNC_MT:
    case RTE_RING_SYNC_MT_RTS:
    default:
        /* unsupported mode, shouldn't be here */
        RTE_ASSERT(0);
    }
}

__rte_experimental
static __rte_always_inline void
rte_ring_dequeue_finish(struct rte_ring *r, unsigned int n)
{
    rte_ring_dequeue_elem_finish(r, n);
}

#ifdef __cplusplus
}
#endif

#endif /* _RTE_RING_PEEK_H_ */