rte_soring.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(c) 2024 Huawei Technologies Co., Ltd
 */

#ifndef _RTE_SORING_H_
#define _RTE_SORING_H_

#include <rte_ring.h>

#ifdef __cplusplus
extern "C" {
#endif

#define RTE_SORING_ST_BIT       30

#define RTE_SORING_ELEM_MAX (RTE_BIT32(RTE_SORING_ST_BIT) - 1)

struct rte_soring_param {
    const char *name;
    uint32_t elems;
    uint32_t elem_size;
    uint32_t meta_size;
    uint32_t stages;
    enum rte_ring_sync_type prod_synt;
    enum rte_ring_sync_type cons_synt;
};

struct rte_soring;

__rte_experimental
ssize_t
rte_soring_get_memsize(const struct rte_soring_param *prm);

__rte_experimental
int
rte_soring_init(struct rte_soring *r,  const struct rte_soring_param *prm);

__rte_experimental
unsigned int
rte_soring_count(const struct rte_soring *r);

__rte_experimental
unsigned int
rte_soring_free_count(const struct rte_soring *r);

__rte_experimental
void
rte_soring_dump(FILE *f, const struct rte_soring *r);

__rte_experimental
uint32_t
rte_soring_enqueue_bulk(struct rte_soring *r, const void *objs,
    uint32_t n, uint32_t *free_space);

__rte_experimental
uint32_t
rte_soring_enqueux_bulk(struct rte_soring *r, const void *objs,
    const void *meta, uint32_t n, uint32_t *free_space);

__rte_experimental
uint32_t
rte_soring_enqueue_burst(struct rte_soring *r, const void *objs,
    uint32_t n, uint32_t *free_space);

__rte_experimental
uint32_t
rte_soring_enqueux_burst(struct rte_soring *r, const void *objs,
    const void *meta, uint32_t n, uint32_t *free_space);

__rte_experimental
uint32_t
rte_soring_dequeue_bulk(struct rte_soring *r, void *objs,
    uint32_t num, uint32_t *available);

__rte_experimental
uint32_t
rte_soring_dequeux_bulk(struct rte_soring *r, void *objs, void *meta,
    uint32_t num, uint32_t *available);

__rte_experimental
uint32_t
rte_soring_dequeue_burst(struct rte_soring *r, void *objs,
    uint32_t num, uint32_t *available);

__rte_experimental
uint32_t
rte_soring_dequeux_burst(struct rte_soring *r, void *objs, void *meta,
    uint32_t num, uint32_t *available);

__rte_experimental
uint32_t
rte_soring_acquire_bulk(struct rte_soring *r, void *objs,
    uint32_t stage, uint32_t num, uint32_t *ftoken, uint32_t *available);

__rte_experimental
uint32_t
rte_soring_acquirx_bulk(struct rte_soring *r, void *objs, void *meta,
    uint32_t stage, uint32_t num, uint32_t *ftoken, uint32_t *available);

__rte_experimental
uint32_t
rte_soring_acquire_burst(struct rte_soring *r, void *objs,
    uint32_t stage, uint32_t num, uint32_t *ftoken, uint32_t *available);

__rte_experimental
uint32_t
rte_soring_acquirx_burst(struct rte_soring *r, void *objs, void *meta,
    uint32_t stage, uint32_t num, uint32_t *ftoken, uint32_t *available);

__rte_experimental
void
rte_soring_release(struct rte_soring *r, const void *objs,
    uint32_t stage, uint32_t n, uint32_t ftoken);

__rte_experimental
void
rte_soring_releasx(struct rte_soring *r, const void *objs,
    const void *meta, uint32_t stage, uint32_t n, uint32_t ftoken);

__rte_experimental
uint32_t
rte_soring_enqueue_bulk_start(struct rte_soring *r, uint32_t n,
    uint32_t *free_space);

__rte_experimental
uint32_t
rte_soring_enqueue_burst_start(struct rte_soring *r, uint32_t n,
    uint32_t *free_space);

__rte_experimental
void
rte_soring_enqueue_finish(struct rte_soring *r, const void *objs, uint32_t n);

__rte_experimental
void
rte_soring_enqueux_finish(struct rte_soring *r, const void *objs,
    const void *meta, uint32_t n);

__rte_experimental
uint32_t
rte_soring_dequeue_bulk_start(struct rte_soring *r, void *objs, uint32_t num,
    uint32_t *available);

__rte_experimental
uint32_t
rte_soring_dequeux_bulk_start(struct rte_soring *r, void *objs, void *meta,
    uint32_t num, uint32_t *available);

__rte_experimental
uint32_t
rte_soring_dequeue_burst_start(struct rte_soring *r, void *objs, uint32_t num,
    uint32_t *available);

__rte_experimental
uint32_t
rte_soring_dequeux_burst_start(struct rte_soring *r, void *objs, void *meta,
    uint32_t num, uint32_t *available);

__rte_experimental
void
rte_soring_dequeue_finish(struct rte_soring *r, uint32_t num);


#ifdef __cplusplus
}
#endif

#endif /* _RTE_SORING_H_ */