DPDK: Data Plane Development Kit

18.02.0-rc1
rte_ring Struct Reference

#include <rte_ring.h>

Public Member Functions

struct rte_ring_headtail prod __rte_aligned (PROD_ALIGN)
struct rte_ring_headtail cons __rte_aligned (CONS_ALIGN)

Data Fields

char name[RTE_MEMZONE_NAMESIZE__rte_cache_aligned
int flags
struct rte_memzonememzone
uint32_t size
uint32_t mask
uint32_t capacity

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). These indexes are between 0 and 2^32, 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/ip_pipeline/thread.c, examples/ip_pipeline/thread_fe.c, examples/load_balancer/init.c, examples/load_balancer/runtime.c, examples/multi_process/client_server_mp/mp_client/client.c, examples/multi_process/l2fwd_fork/main.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/qos_sched/init.c, examples/quota_watermark/qw/init.c, examples/quota_watermark/qw/main.c, examples/quota_watermark/qwctl/commands.c, examples/server_node_efd/node/node.c, and examples/tep_termination/main.c.

Definition at line 146 of file rte_ring.h.

Member Function Documentation

struct rte_ring_headtail prod __rte_aligned ( PROD_ALIGN  )
read

Ring producer status.

struct rte_ring_headtail cons __rte_aligned ( CONS_ALIGN  )
read

Ring consumer status.

Field Documentation

char name [RTE_MEMZONE_NAMESIZE] __rte_cache_aligned

Name of the ring.

Definition at line 152 of file rte_ring.h.

int flags

Flags supplied at creation.

Examples:
examples/multi_process/l2fwd_fork/main.c.

Definition at line 153 of file rte_ring.h.

struct rte_memzone* memzone

Memzone, if any, containing the rte_ring

Definition at line 154 of file rte_ring.h.

uint32_t size
uint32_t mask

Mask (size-1) of ring.

Definition at line 157 of file rte_ring.h.

uint32_t capacity

Usable size of ring

Definition at line 158 of file rte_ring.h.


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