cne_ring_api.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 *
 * Copyright (c) 2019-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_H_
#define _CNE_RING_API_H_
 
#include <errno.h>
#include <stdio.h>
#include <cne_common.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef void cne_ring_t;
 
#define RING_F_SP_ENQ    0x0001 
#define RING_F_SC_DEQ    0x0002 
#define RING_F_ALLOCATED 0x8000 
#define RING_F_EXACT_SZ  0x0004
#define CNE_RING_SZ_MASK (0x7fffffffU) 
CNDP_API ssize_t cne_ring_get_memsize_elem(unsigned int esize, unsigned int count);
 
CNDP_API ssize_t cne_ring_get_memsize(unsigned count);
 
CNDP_API cne_ring_t *cne_ring_create(const char *name, unsigned int esize, unsigned count,
                                     unsigned flags);
 
CNDP_API cne_ring_t *cne_ring_init(void *addr, ssize_t size, const char *name, unsigned int esize,
                                   unsigned int count, unsigned int flags);
 
CNDP_API void cne_ring_free(cne_ring_t *r);
 
CNDP_API void cne_ring_dump(FILE *f, cne_ring_t *r);
 
CNDP_API void cne_ring_reset(cne_ring_t *r);
 
CNDP_API unsigned cne_ring_count(const cne_ring_t *r);
 
CNDP_API unsigned cne_ring_free_count(const cne_ring_t *r);
 
CNDP_API int cne_ring_full(const cne_ring_t *r);
 
CNDP_API int cne_ring_empty(const cne_ring_t *r);
 
CNDP_API unsigned cne_ring_get_size(const cne_ring_t *r);
 
CNDP_API unsigned cne_ring_get_capacity(const cne_ring_t *r);
 
CNDP_API const char *cne_ring_get_name(const cne_ring_t *r);
 
CNDP_API int cne_ring_get_flags(const cne_ring_t *r);
 
CNDP_API uint32_t cne_ring_get_mask(const cne_ring_t *r);
 
CNDP_API uint32_t cne_ring_get_prod_head(const cne_ring_t *r);
 
CNDP_API uint32_t cne_ring_get_prod_tail(const cne_ring_t *r);
 
CNDP_API uint32_t cne_ring_get_cons_head(const cne_ring_t *r);
 
CNDP_API uint32_t cne_ring_get_cons_tail(const cne_ring_t *r);
 
/****************************************************************************
 *                    Ring Generic Functions                                *
 ****************************************************************************/
CNDP_API unsigned int cne_ring_enqueue_bulk(cne_ring_t *r, void *const *obj_table, unsigned int n,
                                            unsigned int *free_space);
 
__cne_always_inline int
cne_ring_enqueue(cne_ring_t *r, void *obj)
{
    return cne_ring_enqueue_bulk(r, &obj, 1, NULL) ? 0 : -ENOBUFS;
}
 
CNDP_API unsigned int cne_ring_dequeue_bulk(cne_ring_t *r, void **obj_table, unsigned int n,
                                            unsigned int *available);
 
CNDP_API __cne_always_inline int
cne_ring_dequeue(cne_ring_t *r, void **obj_p)
{
    return cne_ring_dequeue_bulk(r, obj_p, 1, NULL) ? 0 : -ENOENT;
}
 
CNDP_API unsigned cne_ring_enqueue_burst(cne_ring_t *r, void *const *obj_table, unsigned int n,
                                         unsigned int *free_space);
 
CNDP_API unsigned cne_ring_dequeue_burst(cne_ring_t *r, void **obj_table, unsigned int n,
                                         unsigned int *available);
 
/****************************************************************************
 *                    Ring Elem Functions                                   *
 ****************************************************************************/
 
CNDP_API unsigned int cne_ring_enqueue_bulk_elem(cne_ring_t *r, const void *obj_table,
                                                 unsigned int esize, unsigned int n,
                                                 unsigned int *free_space);
 
CNDP_API __cne_always_inline int
cne_ring_enqueue_elem(cne_ring_t *r, void *obj, unsigned int esize)
{
    return cne_ring_enqueue_bulk_elem(r, obj, esize, 1, NULL) ? 0 : -ENOBUFS;
}
 
CNDP_API unsigned int cne_ring_dequeue_bulk_elem(cne_ring_t *r, void *obj_table, unsigned int esize,
                                                 unsigned int n, unsigned int *available);
 
CNDP_API __cne_always_inline int
cne_ring_dequeue_elem(cne_ring_t *r, void *obj_p, unsigned int esize)
{
    return cne_ring_dequeue_bulk_elem(r, obj_p, esize, 1, NULL) ? 0 : -ENOENT;
}
 
CNDP_API unsigned cne_ring_enqueue_burst_elem(cne_ring_t *r, const void *obj_table,
                                              unsigned int esize, unsigned int n,
                                              unsigned int *free_space);
 
CNDP_API unsigned int cne_ring_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_H_ */