---
name: "rte_tm_node_params"
section: "3"
platform: "linux"
package: "dpdk-doc"
version: "24.11.4-0+deb13u1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/rte_tm_node_params"
---

# rte\_tm\_node\_params(3)

## NAME

rte\_tm\_node\_params

## SYNOPSIS

`#include <rte_tm.h>`

### Data Fields

uint32\_t **shaper\_profile\_id**\
 uint32\_t \* **shared\_shaper\_id**\
 uint32\_t **n\_shared\_shapers**\
 uint64\_t **stats\_mask**\

## Detailed Description

Node parameters

Each non-leaf node has multiple inputs (its children nodes) and single output (which is input to its parent node). It arbitrates its inputs using Strict Priority (SP) and Weighted Fair Queuing (WFQ) algorithms to schedule input packets to its output while observing its shaping (rate limiting) constraints.

Algorithms such as Weighted Round Robin (WRR), Byte-level WRR, Deficit WRR (DWRR), etc. are considered approximations of the WFQ ideal and are assimilated to WFQ, although an associated implementation-dependent trade-off on accuracy, performance and resource usage might exist.

Children nodes with different priorities are scheduled using the SP algorithm based on their priority, with zero (0) as the highest priority. Children with the same priority are scheduled using the WFQ algorithm according to their weights. The WFQ weight of a given child node is relative to the sum of the weights of all its sibling nodes that have the same priority, with one (1) as the lowest weight. For each SP priority, the WFQ weight mode can be set as either byte-based or packet-based.

Each leaf node sits on top of a Tx queue of the current Ethernet port. Hence, the leaf nodes are predefined, with their node IDs set to 0 .. (N-1), where N is the number of Tx queues configured for the current Ethernet port. The non-leaf nodes have their IDs generated by the application.

Definition at line **1092** of file **rte\_tm.h**.

## Field Documentation

### uint32\_t shaper\_profile\_id

Shaper profile for the private shaper. The absence of the private shaper for the current node is indicated by setting this parameter to RTE\_TM\_SHAPER\_PROFILE\_ID\_NONE.

Definition at line **1097** of file **rte\_tm.h**.

### uint32\_t\* shared\_shaper\_id

User allocated array of valid shared shaper IDs.

Definition at line **1100** of file **rte\_tm.h**.

### uint32\_t n\_shared\_shapers

Number of shared shaper IDs in the *shared\_shaper\_id* array.

Definition at line **1103** of file **rte\_tm.h**.

### int\* wfq\_weight\_mode

WFQ weight mode for each SP priority. When NULL, it indicates that WFQ is to be used for all priorities. When non-NULL, it points to a pre-allocated array of *n\_sp\_priorities* values, with non-zero value for byte-mode and zero for packet-mode.

**See also**

struct **rte\_tm\_node\_capabilities::sched\_wfq\_packet\_mode\_supported**

struct **rte\_tm\_node\_capabilities::sched\_wfq\_byte\_mode\_supported**

Definition at line **1116** of file **rte\_tm.h**.

### uint32\_t n\_sp\_priorities

Number of SP priorities.

Definition at line **1119** of file **rte\_tm.h**.

### struct { ... } nonleaf

Parameters only valid for non-leaf nodes.

### enum rte\_tm\_cman\_mode cman

Congestion management mode

Definition at line **1125** of file **rte\_tm.h**.

### uint32\_t wred\_profile\_id

WRED profile for private WRED context. The absence of a private WRED context for the current leaf node is indicated by value RTE\_TM\_WRED\_PROFILE\_ID\_NONE.

Definition at line **1136** of file **rte\_tm.h**.

### uint32\_t\* shared\_wred\_context\_id

User allocated array of shared WRED context IDs. When set to NULL, it indicates that the current leaf node should not currently be part of any shared WRED contexts.

Definition at line **1143** of file **rte\_tm.h**.

### uint32\_t n\_shared\_wred\_contexts

Number of elements in the *shared\_wred\_context\_id* array. Only valid when *shared\_wred\_context\_id* is non-NULL, in which case it should be non-zero.

Definition at line **1150** of file **rte\_tm.h**.

### struct { ... } wred

WRED parameters (only valid when *cman* is set to WRED).

### struct { ... } leaf

Parameters only valid for leaf nodes.

### uint64\_t stats\_mask

Mask of statistics counter types to be enabled for this node. This needs to be a subset of the statistics counter types available for the current node. Any statistics counter type not included in this set is to be disabled for the current node.

**See also**

enum **rte\_tm\_stats\_type**

Definition at line **1161** of file **rte\_tm.h**.

## Author

Generated automatically by Doxygen for DPDK from the source code.