cne_ring_api_internal.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 *
 * Copyright (c) 2020-2022 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 _CNE_RING_API_INTERNAL_H_
#define _CNE_RING_API_INTERNAL_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
/****************************************************************************
 *                    Ring Generic Functions                                *
 ****************************************************************************/
unsigned int cne_ring_mp_enqueue_bulk(cne_ring_t *r, void *const *obj_table, unsigned int n,
                                      unsigned int *free_space);
 
unsigned int cne_ring_sp_enqueue_bulk(cne_ring_t *r, void *const *obj_table, unsigned int n,
                                      unsigned int *free_space);
 
__cne_always_inline int
cne_ring_mp_enqueue(cne_ring_t *r, void *obj)
{
    return cne_ring_mp_enqueue_bulk(r, &obj, 1, NULL) ? 0 : -ENOBUFS;
}
 
__cne_always_inline int
cne_ring_sp_enqueue(cne_ring_t *r, void *obj)
{
    return cne_ring_sp_enqueue_bulk(r, &obj, 1, NULL) ? 0 : -ENOBUFS;
}
 
unsigned int cne_ring_mc_dequeue_bulk(cne_ring_t *r, void **obj_table, unsigned int n,
                                      unsigned int *available);
 
unsigned int cne_ring_sc_dequeue_bulk(cne_ring_t *r, void **obj_table, unsigned int n,
                                      unsigned int *available);
 
__cne_always_inline int
cne_ring_mc_dequeue(cne_ring_t *r, void **obj_p)
{
    return cne_ring_mc_dequeue_bulk(r, obj_p, 1, NULL) ? 0 : -ENOENT;
}
 
__cne_always_inline int
cne_ring_sc_dequeue(cne_ring_t *r, void **obj_p)
{
    return cne_ring_sc_dequeue_bulk(r, obj_p, 1, NULL) ? 0 : -ENOENT;
}
 
unsigned cne_ring_mp_enqueue_burst(cne_ring_t *r, void *const *obj_table, unsigned int n,
                                   unsigned int *free_space);
 
unsigned cne_ring_sp_enqueue_burst(cne_ring_t *r, void *const *obj_table, unsigned int n,
                                   unsigned int *free_space);
 
unsigned cne_ring_mc_dequeue_burst(cne_ring_t *r, void **obj_table, unsigned int n,
                                   unsigned int *available);
 
unsigned cne_ring_sc_dequeue_burst(cne_ring_t *r, void **obj_table, unsigned int n,
                                   unsigned int *available);
 
/****************************************************************************
 *                    Ring Elem Functions                                   *
 ****************************************************************************/
unsigned int cne_ring_mp_enqueue_bulk_elem(cne_ring_t *r, const void *obj_table, unsigned int esize,
                                           unsigned int n, unsigned int *free_space);
 
unsigned int cne_ring_sp_enqueue_bulk_elem(cne_ring_t *r, const void *obj_table, unsigned int esize,
                                           unsigned int n, unsigned int *free_space);
 
__cne_always_inline int
cne_ring_mp_enqueue_elem(cne_ring_t *r, void *obj, unsigned int esize)
{
    return cne_ring_mp_enqueue_bulk_elem(r, obj, esize, 1, NULL) ? 0 : -ENOBUFS;
}
 
__cne_always_inline int
cne_ring_sp_enqueue_elem(cne_ring_t *r, void *obj, unsigned int esize)
{
    return cne_ring_sp_enqueue_bulk_elem(r, obj, esize, 1, NULL) ? 0 : -ENOBUFS;
}
 
unsigned int cne_ring_mc_dequeue_bulk_elem(cne_ring_t *r, void *obj_table, unsigned int esize,
                                           unsigned int n, unsigned int *available);
 
unsigned int cne_ring_sc_dequeue_bulk_elem(cne_ring_t *r, void *obj_table, unsigned int esize,
                                           unsigned int n, unsigned int *available);
 
__cne_always_inline int
cne_ring_mc_dequeue_elem(cne_ring_t *r, void *obj_p, unsigned int esize)
{
    return cne_ring_mc_dequeue_bulk_elem(r, obj_p, esize, 1, NULL) ? 0 : -ENOENT;
}
 
__cne_always_inline int
cne_ring_sc_dequeue_elem(cne_ring_t *r, void *obj_p, unsigned int esize)
{
    return cne_ring_sc_dequeue_bulk_elem(r, obj_p, esize, 1, NULL) ? 0 : -ENOENT;
}
 
unsigned cne_ring_mp_enqueue_burst_elem(cne_ring_t *r, const void *obj_table, unsigned int esize,
                                        unsigned int n, unsigned int *free_space);
 
unsigned cne_ring_sp_enqueue_burst_elem(cne_ring_t *r, const void *obj_table, unsigned int esize,
                                        unsigned int n, unsigned int *free_space);
 
unsigned cne_ring_mc_dequeue_burst_elem(cne_ring_t *r, void *obj_table, unsigned int esize,
                                        unsigned int n, unsigned int *available);
 
unsigned cne_ring_sc_dequeue_burst_elem(cne_ring_t *r, void *obj_table, unsigned int esize,
                                        unsigned int n, unsigned int *available);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _CNE_RING_API_INTERNAL_H_ */