rte_eth_cman_config(3)

πŸ’– rte_eth_cman_config πŸ’–

okay bestie, sit down, grab a strawberry πŸ“ β€” this one's a struct, not a function, and it lives in the DPDK library functions crew (3), so if you were looking for something to call, this is more like the little form you fill out and hand over. it's giving "permission slip but for congestion". πŸ“


✨ NAME ✨

rte_eth_cman_config β€” the structure you use to configure ethdev congestion management, no cap.


🌸 SYNOPSIS 🌸

#include <rte_ethdev.h>

Data Fields β€” that's the whole roster:

enum rte_eth_cman_obj obj
enum rte_cman_mode mode

(yes, the synopsis keeps it short and mysterious β€” the full field list is further down, keep scrolling 🫢)


πŸ‘‘ DETAILED DESCRIPTION πŸ‘‘

⚠️ Warning β€” EXPERIMENTAL: this structure may change, or be removed, without prior notice. bestie. it might get deleted. don't build your whole personality on it πŸ’€

A structure used to configure the ethdev congestion management.

Literally defined at line 6103 of the file rte_ethdev.h. that's its home address, iconic.


🧚 FIELD DOCUMENTATION 🧚

okay so here's every single field, in order, with everything it says. no skipping, we don't do that here πŸ’…

  • enum rte_eth_cman_obj obj β€” congestion management object. Definition at line 6105 of rte_ethdev.h.
  • enum rte_cman_mode mode β€” congestion management mode. Definition at line 6107 of rte_ethdev.h.
  • uint16_t rx_queue β€” the Rx queue to configure congestion management on. Valid when the object is RTE_ETH_CMAN_OBJ_RX_QUEUE or RTE_ETH_CMAN_OBJ_RX_QUEUE_MEMPOOL. Definition at line 6115 of rte_ethdev.h.
  • uint8_t rsvd_obj_params[4] β€” reserved for future fields, so hands off πŸ™ˆ. It must be set to 0 when rte_eth_cman_config_set() is invoked, and it will be returned as 0 when rte_eth_cman_config_get() is invoked. Definition at line 6122 of rte_ethdev.h.
  • struct rte_cman_red_params red β€” RED configuration parameters. Valid when the mode is RTE_CMAN_RED. Definition at line 6130 of rte_ethdev.h.
  • uint8_t rsvd_mode_params[4] β€” also reserved for future fields (the mode-flavoured one this time ✨). It must be set to 0 when rte_eth_cman_config_set() is invoked, and it will be returned as 0 when rte_eth_cman_config_get() is invoked. Definition at line 6137 of rte_ethdev.h.
🚨 reminder bestie: both rsvd_obj_params and rsvd_mode_params want a big fat 0 on the setter side, and they'll come back as 0 on the getter side. don't get cute with them.

πŸŽ€ AUTHOR πŸŽ€

Generated automatically by Doxygen for DPDK from the source code. so technically not a human author, it's giving robot ghostwriter πŸ‘»βœοΈ


that's the whole page, periodt. this lil legend came from DPDK Version 25.11.3 and the manual is dated accordingly β€” so go forth, configure your congestion management, and slay πŸ’…πŸŒˆπŸ¦‹

πŸ“¦ where this page comes from