rte_ring Struct Reference

#include <rte_ring_core.h>

Data Fields
char name [RTE_RING_NAMESIZE]	__rte_cache_aligned
int	flags
const struct rte_memzone *	memzone
uint32_t	size
uint32_t	mask
uint32_t	capacity
char pad0	__rte_cache_aligned
union {
}	__rte_cache_aligned
char pad1	__rte_cache_aligned
union {
}	__rte_cache_aligned
char pad2	__rte_cache_aligned

Detailed Description

An RTE ring structure.

The producer and the consumer have a head and a tail index. The particularity of these index is that they are not between 0 and size(ring)-1. These indexes are between 0 and 2^32 -1, and we mask their value when we access the ring[] field. Thanks to this assumption, we can do subtractions between 2 index values in a modulo-32bit base: that's why the overflow of the indexes is not a problem.

Examples:

examples/bbdev_app/main.c, examples/distributor/main.c, examples/dma/dmafwd.c, examples/ip_pipeline/pipeline.c, examples/ip_pipeline/swq.c, examples/ip_pipeline/thread.c, examples/multi_process/client_server_mp/mp_client/client.c, examples/multi_process/simple_mp/main.c, examples/packet_ordering/main.c, examples/performance-thread/common/lthread_tls.c, examples/performance-thread/l3fwd-thread/main.c, examples/pipeline/obj.c, examples/pipeline/thread.c, examples/qos_sched/init.c, and examples/server_node_efd/node/node.c.

Definition at line 120 of file rte_ring_core.h.

Field Documentation

__rte_cache_aligned [1/6]

char name [RTE_RING_NAMESIZE] __rte_cache_aligned

Name of the ring.

Definition at line 121 of file rte_ring_core.h.

flags

int flags

Flags supplied at creation.

Examples:

examples/ip_pipeline/swq.c, and examples/pipeline/obj.c.

Definition at line 123 of file rte_ring_core.h.

memzone

const struct rte_memzone* memzone

Memzone, if any, containing the rte_ring

Definition at line 124 of file rte_ring_core.h.

size

uint32_t size

Size of ring.

Examples:

examples/performance-thread/l3fwd-thread/main.c.

Definition at line 126 of file rte_ring_core.h.

mask

uint32_t mask

Mask (size-1) of ring.

Definition at line 127 of file rte_ring_core.h.

capacity

uint32_t capacity

Usable size of ring

Definition at line 128 of file rte_ring_core.h.

__rte_cache_aligned [2/6]

char pad0 __rte_cache_aligned

empty cache line

Definition at line 130 of file rte_ring_core.h.

__rte_cache_aligned [3/6]

RTE_STD_C11 { ... } __rte_cache_aligned

Ring producer status.

__rte_cache_aligned [4/6]

char pad1 __rte_cache_aligned

empty cache line

Definition at line 140 of file rte_ring_core.h.

__rte_cache_aligned [5/6]

RTE_STD_C11 { ... } __rte_cache_aligned

Ring consumer status.

__rte_cache_aligned [6/6]

char pad2 __rte_cache_aligned

empty cache line

Definition at line 150 of file rte_ring_core.h.

---

The documentation for this struct was generated from the following file:

• lib/ring/rte_ring_core.h