rte_tm_shaper_params(3)

📦 version 26.03, in nixos 26.05, nixpkgs unstable

🌸 NAME 🌸

rte_tm_shaper_params — bestie, this is the shaper (rate limiter) profile struct from DPDK’s <rte_tm.h>. We’re in the Library Functions Manual for rte_tm_shaper_params(3), and it’s giving very “tiny struct, big traffic-shaping energy.” 💅✨

🦋 SYNOPSIS 🦋

#include <rte_tm.h>

🧸 Data Fields 🧸

  • struct rte_tm_token_bucket committed
  • struct rte_tm_token_bucket peak
  • int32_t pkt_length_adjust
  • int packet_mode

💫 Detailed Description 💫

Shaper (rate limiter) profile — that’s the whole vibe of this struct, periodt. 🎀

Multiple shaper instances can share the same shaper profile. Each node has zero or one private shaper (only one node using it) and/or zero, one or several shared shapers (multiple nodes use the same shaper instance). A private shaper is used to perform traffic shaping for a single node, while a shared shaper is used to perform traffic shaping for a group of nodes. 🫶

Single rate shapers use a single token bucket. A single rate shaper can be configured by setting the rate of the committed bucket to zero, which effectively disables this bucket. The peak bucket is used to limit the rate and the burst size for the current shaper. No cap, that’s literally the setup. 💖

Dual rate shapers use both the committed and the peak token buckets. The rate of the peak bucket has to be bigger than zero, as well as greater than or equal to the rate of the committed bucket. Important little rule, bestie — don’t fumble that one. 😭🔥

👀 See also 👀

  • struct rte_tm_capabilities::shaper_private_packet_mode_supported
  • struct rte_tm_capabilities::shaper_private_byte_mode_supported
  • struct rte_tm_capabilities::shaper_shared_packet_mode_supported
  • struct rte_tm_capabilities::shaper_shared_byte_mode_supported
📌 Definition at line 1039 of file rte_tm.h.

🎀 Field Documentation 🎀

struct rte_tm_token_bucket committed

Committed token bucket. That’s the field, bestie. 💜

Definition at line 1041 of file rte_tm.h.

struct rte_tm_token_bucket peak

Peak token bucket. Iconic bucket behavior, honestly. 🦋

Definition at line 1044 of file rte_tm.h.

int32_t pkt_length_adjust

Signed value to be added to the length of each packet for the purpose of shaping. Can be used to correct the packet length with the framing overhead bytes that are also consumed on the wire (e.g. RTE_TM_ETH_FRAMING_OVERHEAD_FCS). This field is ignored when the profile enables packet mode. 🎀

🫶 So yes: this one is a signed adjustment, and it gets ignored in packet mode. Keep that in your notes, iykyk.

Definition at line 1052 of file rte_tm.h.

int packet_mode

When zero, the byte mode is enabled for the current profile, so the rate and size fields in both the committed and peak token buckets are specified in bytes per second and bytes, respectively. When non-zero, the packet mode is enabled for the current profile, so the rate and size fields in both the committed and peak token buckets are specified in packets per second and packets, respectively. ✨

💀 Zero = byte mode. Non-zero = packet mode. The way this struct just switches units like that is lowkey main character energy.

Definition at line 1062 of file rte_tm.h.

👑 Author 👑

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

💖 That’s the whole rte_tm_shaper_params(3) page, bestie — signed off from DPDK, Version 26.03.0. Catch you in the group chat! 💅✨

📦 where this page comes from