rte_ring_headtail(3)

📦 version 26.03, in nixos 26.05, nixpkgs unstable

💫 NAME 💫

rte_ring_headtail — okay bestie, that's the whole name, and this is the rte_ring_headtail(3) page from the Library Functions Manual. We're talking structures that hold head/tail values and other metadata, and it's giving very specific-ring-core energy. 🎀

🌸 SYNOPSIS 🌸

Include this header and you get these public member functions, exactly like this:

#include <rte_ring_core.h>

   Public Member Functions
       volatile (uint32_t) head
       volatile (uint32_t) tail

🦋 Detailed Description 🦋

Okay so picture structures to hold a pair of head/tail values and other metadata. Depending on sync_type, the format of that structure might be different, but the offset for sync_type and tail values should remain the same. No cap, that's the whole description. 🫶

Definition at line 65 of file rte_ring_core.h.

✨ Member Function Documentation ✨

  • volatile (uint32_t ) — prod/consumer head. 💅
  • volatile (uint32_t ) — prod/consumer tail. 💅

🎀 Field Documentation 🎀

  • enum rte_ring_sync_type sync_type — sync type of prod/cons. Definition at line 70 of file rte_ring_core.h. ⭐
  • uint32_t single — deprecated - True if single prod/cons. Definition at line 72 of file rte_ring_core.h. 🚨
Heads up bestie: single is literally marked deprecated, so don't treat it like main character energy. The page says: deprecated - True if single prod/cons.

💜 Author 💜

Generated automatically by Doxygen for DPDK from the source code. 🫡

💖 cute lil sign-off: this page is from DPDK, Version 26.03.0 — generated automatically by Doxygen for DPDK from the source code. The footer doesn't list a date on this one, so I'm not inventing one, bestie. Bye! 💅✨

📦 where this page comes from