rte_ring_hts.h(3)

📦
version 25.11.3 · 10 versions
, in ubuntu resolute, ubuntu stonking

💖 rte_ring_hts.h — Library Functions Manual 💖

okay so bestie, this is the manual page for rte_ring_hts.h 🦋 it's a C header from DPDK, and it's giving head-tail-sync ring mode energy. Let's get into it, no cap. 💅

✨ SYNOPSIS ✨

#include <rte_ring_hts_elem_pvt.h>

🌸 Functions

static __rte_always_inline unsigned int
    rte_ring_mp_hts_enqueue_bulk_elem (struct rte_ring *r, const void *obj_table,
        unsigned int esize, unsigned int n, unsigned int *free_space)
static __rte_always_inline unsigned int
    rte_ring_mc_hts_dequeue_bulk_elem (struct rte_ring *r, void *obj_table,
        unsigned int esize, unsigned int n, unsigned int *available)
static __rte_always_inline unsigned int
    rte_ring_mp_hts_enqueue_burst_elem (struct rte_ring *r, const void *obj_table,
        unsigned int esize, unsigned int n, unsigned int *free_space)
static __rte_always_inline unsigned int
    rte_ring_mc_hts_dequeue_burst_elem (struct rte_ring *r, void *obj_table,
        unsigned int esize, unsigned int n, unsigned int *available)
static __rte_always_inline unsigned int
    rte_ring_mp_hts_enqueue_bulk (struct rte_ring *r, void *const *obj_table,
        unsigned int n, unsigned int *free_space)
static __rte_always_inline unsigned int
    rte_ring_mc_hts_dequeue_bulk (struct rte_ring *r, void **obj_table,
        unsigned int n, unsigned int *available)
static __rte_always_inline unsigned int
    rte_ring_mp_hts_enqueue_burst (struct rte_ring *r, void *const *obj_table,
        unsigned int n, unsigned int *free_space)
static __rte_always_inline unsigned int
    rte_ring_mc_hts_dequeue_burst (struct rte_ring *r, void **obj_table,
        unsigned int n, unsigned int *available)

🌈 DETAILED DESCRIPTION 🌈

heads up bestie: it is not recommended to include this file directly. please include <rte_ring.h> instead. 🙈 do not come for me, that's just what the docs say.

This file contains the functions for serialized, aka Head-Tail Sync (HTS) ring mode. ✨

So in that mode, the enqueue/dequeue operation is fully serialized: at any given moment only one enqueue/dequeue operation can proceed. Periodt. 💅

How does it pull that off? By allowing a thread to proceed with changing head.value only when head.value == tail.value. 🫶 Both the head and tail values are updated atomically, as one single 64-bit value. And to make that happen, a 64-bit CAS is used by the head update routine. iconic honestly 👑

Definition in file rte_ring_hts.h.

👑 FUNCTION DOCUMENTATION 👑

🎀 __rte_always_inline unsigned int rte_ring_mp_hts_enqueue_bulk_elem (struct rte_ring * r, const void * obj_table, unsigned int esize, unsigned int n, unsigned int * free_space) [static]

Enqueue several objects on the HTS ring (multi-producers safe). 🚀

Parameters

  • r — a pointer to the ring structure.
  • obj_table — a pointer to a table of objects.
  • esize — the size of ring element, in bytes. It must be a multiple of 4. This must be the same value used while creating the ring. Otherwise the results are undefined. 😭
  • n — the number of objects to add in the ring from the obj_table.
  • free_space — if non-NULL, returns the amount of space in the ring after the enqueue operation has finished.

Returns

The number of objects enqueued, either 0 or n.

Definition at line 53 of file rte_ring_hts.h.

🎀 __rte_always_inline unsigned int rte_ring_mc_hts_dequeue_bulk_elem (struct rte_ring * r, void * obj_table, unsigned int esize, unsigned int n, unsigned int * available) [static]

Dequeue several objects from an HTS ring (multi-consumers safe). 🫧

Parameters

  • r — a pointer to the ring structure.
  • obj_table — a pointer to a table of objects that will be filled.
  • esize — the size of ring element, in bytes. It must be a multiple of 4. This must be the same value used while creating the ring. Otherwise the results are undefined. 😭
  • n — the number of objects to dequeue from the ring to the obj_table.
  • available — if non-NULL, returns the number of remaining ring entries after the dequeue has finished.

Returns

The number of objects dequeued, either 0 or n.

Definition at line 80 of file rte_ring_hts.h.

🎀 __rte_always_inline unsigned int rte_ring_mp_hts_enqueue_burst_elem (struct rte_ring * r, const void * obj_table, unsigned int esize, unsigned int n, unsigned int * free_space) [static]

Enqueue several objects on the HTS ring (multi-producers safe). 🚀

Parameters

  • r — a pointer to the ring structure.
  • obj_table — a pointer to a table of objects.
  • esize — the size of ring element, in bytes. It must be a multiple of 4. This must be the same value used while creating the ring. Otherwise the results are undefined. 😭
  • n — the number of objects to add in the ring from the obj_table.
  • free_space — if non-NULL, returns the amount of space in the ring after the enqueue operation has finished.

Returns

  • n: actual number of objects enqueued.

Definition at line 107 of file rte_ring_hts.h.

🎀 __rte_always_inline unsigned int rte_ring_mc_hts_dequeue_burst_elem (struct rte_ring * r, void * obj_table, unsigned int esize, unsigned int n, unsigned int * available) [static]

Dequeue several objects from an HTS ring (multi-consumers safe). 🫧 And listen: when the requested objects are more than the available objects, it only dequeues the actual number of objects. that's the vibe check ✅

Parameters

  • r — a pointer to the ring structure.
  • obj_table — a pointer to a table of objects that will be filled.
  • esize — the size of ring element, in bytes. It must be a multiple of 4. This must be the same value used while creating the ring. Otherwise the results are undefined. 😭
  • n — the number of objects to dequeue from the ring to the obj_table.
  • available — if non-NULL, returns the number of remaining ring entries after the dequeue has finished.

Returns

  • n: actual number of objects dequeued, 0 if ring is empty.

Definition at line 136 of file rte_ring_hts.h.

🎀 __rte_always_inline unsigned int rte_ring_mp_hts_enqueue_bulk (struct rte_ring * r, void *const * obj_table, unsigned int n, unsigned int * free_space) [static]

Enqueue several objects on the HTS ring (multi-producers safe). 🚀

Parameters

  • r — a pointer to the ring structure.
  • obj_table — a pointer to a table of void * pointers (objects).
  • n — the number of objects to add in the ring from the obj_table.
  • free_space — if non-NULL, returns the amount of space in the ring after the enqueue operation has finished.

Returns

The number of objects enqueued, either 0 or n.

Definition at line 159 of file rte_ring_hts.h.

🎀 __rte_always_inline unsigned int rte_ring_mc_hts_dequeue_bulk (struct rte_ring * r, void ** obj_table, unsigned int n, unsigned int * available) [static]

Dequeue several objects from an HTS ring (multi-consumers safe). 🫧

Parameters

  • r — a pointer to the ring structure.
  • obj_table — a pointer to a table of void * pointers (objects) that will be filled.
  • n — the number of objects to dequeue from the ring to the obj_table.
  • available — if non-NULL, returns the number of remaining ring entries after the dequeue has finished.

Returns

The number of objects dequeued, either 0 or n.

Definition at line 182 of file rte_ring_hts.h.

🎀 __rte_always_inline unsigned int rte_ring_mp_hts_enqueue_burst (struct rte_ring * r, void *const * obj_table, unsigned int n, unsigned int * free_space) [static]

Enqueue several objects on the HTS ring (multi-producers safe). 🚀

Parameters

  • r — a pointer to the ring structure.
  • obj_table — a pointer to a table of void * pointers (objects).
  • n — the number of objects to add in the ring from the obj_table.
  • free_space — if non-NULL, returns the amount of space in the ring after the enqueue operation has finished.

Returns

  • n: actual number of objects enqueued.

Definition at line 205 of file rte_ring_hts.h.

🎀 __rte_always_inline unsigned int rte_ring_mc_hts_dequeue_burst (struct rte_ring * r, void ** obj_table, unsigned int n, unsigned int * available) [static]

Dequeue several objects from an HTS ring (multi-consumers safe). 🫧 When the requested objects are more than the available objects, it dequeue only the actual number of objects. fr fr.

Parameters

  • r — a pointer to the ring structure.
  • obj_table — a pointer to a table of void * pointers (objects) that will be filled.
  • n — the number of objects to dequeue from the ring to the obj_table.
  • available — if non-NULL, returns the number of remaining ring entries after the dequeue has finished.

Returns

  • n: actual number of objects dequeued, 0 if ring is empty.

Definition at line 230 of file rte_ring_hts.h.

🦋 AUTHOR 🦋

Generated automatically by Doxygen for DPDK from the source code. 🤖✨ (yes bestie, a robot wrote the original — I'm just the one giving it a glow-up 💅)

and that's the whole page!! 🎀 this was DPDK Version 25.11.3, page rte_ring_hts.h(3) — ty for reading, love u, go include <rte_ring.h> instead of this file directly okay?? 💖🦋🌸👑🫶

📦 where this page comes from