--- name: "rte_tm_level_capabilities" 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_level_capabilities" --- # rte\_tm\_level\_capabilities(3) ## NAME rte\_tm\_level\_capabilities ## SYNOPSIS `#include ` ### Data Fields uint32\_t **n\_nodes\_max**\ uint32\_t **n\_nodes\_nonleaf\_max**\ uint32\_t **n\_nodes\_leaf\_max**\ int **non\_leaf\_nodes\_identical**\ int **leaf\_nodes\_identical**\ ## Detailed Description Traffic manager level capabilities Definition at line **471** of file **rte\_tm.h**. ## Field Documentation ### uint32\_t n\_nodes\_max Maximum number of nodes for the current hierarchy level. Definition at line **473** of file **rte\_tm.h**. ### uint32\_t n\_nodes\_nonleaf\_max Maximum number of non-leaf nodes for the current hierarchy level. The value of 0 indicates that current level only supports leaf nodes. The maximum value is *n\_nodes\_max*. Definition at line **479** of file **rte\_tm.h**. ### uint32\_t n\_nodes\_leaf\_max Maximum number of leaf nodes for the current hierarchy level. The value of 0 indicates that current level only supports non-leaf nodes. The maximum value is *n\_nodes\_max*. Definition at line **485** of file **rte\_tm.h**. ### int non\_leaf\_nodes\_identical When non-zero, this flag indicates that all the non-leaf nodes on this level have identical capability set. Valid only when *n\_nodes\_nonleaf\_max* is non-zero. Definition at line **491** of file **rte\_tm.h**. ### int leaf\_nodes\_identical When non-zero, this flag indicates that all the leaf nodes on this level have identical capability set. Valid only when *n\_nodes\_leaf\_max* is non-zero. Definition at line **497** of file **rte\_tm.h**. ### int shaper\_private\_supported Private shaper support. When non-zero, it indicates there is at least one non-leaf node on this level with private shaper support, which may not be the case for all the non-leaf nodes on this level. Private shaper support. When non-zero, it indicates there is at least one leaf node on this level with private shaper support, which may not be the case for all the leaf nodes on this level. Definition at line **507** of file **rte\_tm.h**. ### int shaper\_private\_dual\_rate\_supported Dual rate support for private shaper. Valid only when private shaper is supported for the non-leaf nodes on the current level. When non-zero, it indicates there is at least one non-leaf node on this level with dual rate private shaper support, which may not be the case for all the non-leaf nodes on this level. Dual rate support for private shaper. Valid only when private shaper is supported for the leaf nodes on this level. When non-zero, it indicates there is at least one leaf node on this level with dual rate private shaper support, which may not be the case for all the leaf nodes on this level. Definition at line **517** of file **rte\_tm.h**. ### uint64\_t shaper\_private\_rate\_min Minimum committed/peak rate (bytes per second) for private shapers of the non-leaf nodes of this level. Valid only when private shaper is supported on this level. Minimum committed/peak rate (bytes per second) for private shapers of the leaf nodes of this level. Valid only when private shaper is supported for the leaf nodes on this level. Definition at line **524** of file **rte\_tm.h**. ### uint64\_t shaper\_private\_rate\_max Maximum committed/peak rate (bytes per second) for private shapers of the non-leaf nodes on this level. Valid only when private shaper is supported on this level. Maximum committed/peak rate (bytes per second) for private shapers of the leaf nodes on this level. Valid only when private shaper is supported for the leaf nodes on this level. Definition at line **531** of file **rte\_tm.h**. ### int shaper\_private\_packet\_mode\_supported Shaper private packet mode supported. When non-zero, this parameter indicates there is at least one non-leaf node at this level that can be configured with packet mode in its private shaper. When private shaper is configured in packet mode, committed/peak rate provided is interpreted in packets per second. Shaper private packet mode supported. When non-zero, this parameter indicates there is at least one leaf node at this level that can be configured with packet mode in its private shaper. When private shaper is configured in packet mode, committed/peak rate provided is interpreted in packets per second. Definition at line **540** of file **rte\_tm.h**. ### int shaper\_private\_byte\_mode\_supported Shaper private byte mode supported. When non-zero, this parameter indicates there is at least one non-leaf node at this level that can be configured with byte mode in its private shaper. When private shaper is configured in byte mode, committed/peak rate provided is interpreted in bytes per second. Shaper private byte mode supported. When non-zero, this parameter indicates there is at least one leaf node at this level that can be configured with byte mode in its private shaper. When private shaper is configured in byte mode, committed/peak rate provided is interpreted in bytes per second. Definition at line **549** of file **rte\_tm.h**. ### uint32\_t shaper\_shared\_n\_max Maximum number of shared shapers that any non-leaf node on this level can be part of. The value of zero indicates that shared shapers are not supported by the non-leaf nodes on this level. When non-zero, it indicates there is at least one non-leaf node on this level that meets this condition, which may not be the case for all the non-leaf nodes on this level. Maximum number of shared shapers that any leaf node on this level can be part of. The value of zero indicates that shared shapers are not supported by the leaf nodes on this level. When non-zero, it indicates there is at least one leaf node on this level that meets this condition, which may not be the case for all the leaf nodes on this level. Definition at line **559** of file **rte\_tm.h**. ### int shaper\_shared\_packet\_mode\_supported Shaper shared packet mode supported. When non-zero, this parameter indicates that there is at least one non-leaf node on this level that can be part of shared shapers which work in packet mode. Shaper shared packet mode supported. When non-zero, this parameter indicates that there is at least one leaf node on this level that can be part of shared shapers which work in packet mode. Definition at line **566** of file **rte\_tm.h**. ### int shaper\_shared\_byte\_mode\_supported Shaper shared byte mode supported. When non-zero, this parameter indicates that there is at least one non-leaf node on this level that can be part of shared shapers which work in byte mode. Shaper shared byte mode supported. When non-zero, this parameter indicates that there is at least one leaf node on this level that can be part of shared shapers which work in byte mode. Definition at line **573** of file **rte\_tm.h**. ### uint32\_t sched\_n\_children\_max Maximum number of children nodes. This parameter indicates that there is at least one non-leaf node on this level that can be configured with this many children nodes, which might not be true for all the non-leaf nodes on this level. Definition at line **581** of file **rte\_tm.h**. ### uint32\_t sched\_sp\_n\_priorities\_max Maximum number of supported priority levels. This parameter indicates that there is at least one non-leaf node on this level that can be configured with this many priority levels for managing its children nodes, which might not be true for all the non-leaf nodes on this level. The value of zero is invalid. The value of 1 indicates that only priority 0 is supported, which essentially means that Strict Priority (SP) algorithm is not supported on this level. Definition at line **594** of file **rte\_tm.h**. ### uint32\_t sched\_wfq\_n\_children\_per\_group\_max Maximum number of sibling nodes that can have the same priority at any given time, i.e. maximum size of the WFQ sibling node group. This parameter indicates there is at least one non-leaf node on this level that meets this condition, which may not be true for all the non-leaf nodes on this level. The value of zero is invalid. The value of 1 indicates that WFQ algorithm is not supported on this level. The maximum value is *sched\_n\_children\_max*. Definition at line **606** of file **rte\_tm.h**. ### uint32\_t sched\_wfq\_n\_groups\_max Maximum number of priority levels that can have more than one child node at any given time, i.e. maximum number of WFQ sibling node groups that have two or more members. This parameter indicates there is at least one non-leaf node on this level that meets this condition, which might not be true for all the non-leaf nodes. The value of zero states that WFQ algorithm is not supported on this level. The value of 1 indicates that (*sched\_sp\_n\_priorities\_max* - 1) priority levels on this level have at most one child node, so there can be only one priority level with two or more sibling nodes making up a WFQ group on this level. The maximum value is: min(floor(*sched\_n\_children\_max* / 2), *sched\_sp\_n\_priorities\_max*). Definition at line **625** of file **rte\_tm.h**. ### uint32\_t sched\_wfq\_weight\_max Maximum WFQ weight. The value of 1 indicates that all sibling nodes on this level with same priority have the same WFQ weight, so on this level WFQ is reduced to FQ. Definition at line **632** of file **rte\_tm.h**. ### int sched\_wfq\_packet\_mode\_supported WFQ packet mode supported. When non-zero, this parameter indicates that there is at least one non-leaf node at this level that supports packet mode for WFQ among its children. WFQ weights will be applied against packet count for scheduling children when a non-leaf node is configured appropriately. Definition at line **642** of file **rte\_tm.h**. ### int sched\_wfq\_byte\_mode\_supported WFQ byte mode supported. When non-zero, this parameter indicates that there is at least one non-leaf node at this level that supports byte mode for WFQ among its children. WFQ weights will be applied against bytes for scheduling children when a non-leaf node is configured appropriately. Definition at line **651** of file **rte\_tm.h**. ### uint64\_t stats\_mask Mask of statistics counter types supported by the non-leaf nodes on this level. Every supported statistics counter type is supported by at least one non-leaf node on this level, which may not be true for all the non-leaf nodes on this level. **See also** enum **rte\_tm\_stats\_type** Mask of statistics counter types supported by the leaf nodes on this level. Every supported statistics counter type is supported by at least one leaf node on this level, which may not be true for all the leaf nodes on this level. **See also** enum **rte\_tm\_stats\_type** Definition at line **660** of file **rte\_tm.h**. ### struct { ... } nonleaf Items valid only for the non-leaf nodes on this level. ### int cman\_wred\_packet\_mode\_supported WRED packet mode support. When non-zero, this parameter indicates that there is at least one leaf node on this level that supports the WRED packet mode, which might not be true for all the leaf nodes. In packet mode, the WRED thresholds specify the queue length in packets, as opposed to bytes. Definition at line **744** of file **rte\_tm.h**. ### int cman\_wred\_byte\_mode\_supported WRED byte mode support. When non-zero, this parameter indicates that there is at least one leaf node on this level that supports the WRED byte mode, which might not be true for all the leaf nodes. In byte mode, the WRED thresholds specify the queue length in bytes, as opposed to packets. Definition at line **753** of file **rte\_tm.h**. ### int cman\_head\_drop\_supported Head drop algorithm support. When non-zero, this parameter indicates that there is at least one leaf node on this level that supports the head drop algorithm, which might not be true for all the leaf nodes on this level. Definition at line **761** of file **rte\_tm.h**. ### int cman\_wred\_context\_private\_supported Private WRED context support. When non-zero, it indicates there is at least one node on this level with private WRED context support, which may not be true for all the leaf nodes on this level. Definition at line **768** of file **rte\_tm.h**. ### uint32\_t cman\_wred\_context\_shared\_n\_max Maximum number of shared WRED contexts that any leaf node on this level can be part of. The value of zero indicates that shared WRED contexts are not supported by the leaf nodes on this level. When non-zero, it indicates there is at least one leaf node on this level that meets this condition, which may not be the case for all the leaf nodes on this level. Definition at line **779** of file **rte\_tm.h**. ### struct { ... } leaf Items valid only for the leaf nodes on this level. ## Author Generated automatically by Doxygen for DPDK from the source code.