DPDK  21.05.0-rc3
Data Fields
rte_tm_capabilities Struct Reference

#include <rte_tm.h>

Data Fields

uint32_t n_nodes_max
 
uint32_t n_levels_max
 
int non_leaf_nodes_identical
 
int leaf_nodes_identical
 
uint32_t shaper_n_max
 
uint32_t shaper_private_n_max
 
int shaper_private_dual_rate_n_max
 
uint64_t shaper_private_rate_min
 
uint64_t shaper_private_rate_max
 
int shaper_private_packet_mode_supported
 
int shaper_private_byte_mode_supported
 
uint32_t shaper_shared_n_max
 
uint32_t shaper_shared_n_nodes_per_shaper_max
 
uint32_t shaper_shared_n_shapers_per_node_max
 
uint32_t shaper_shared_dual_rate_n_max
 
uint64_t shaper_shared_rate_min
 
uint64_t shaper_shared_rate_max
 
int shaper_shared_packet_mode_supported
 
int shaper_shared_byte_mode_supported
 
int shaper_pkt_length_adjust_min
 
int shaper_pkt_length_adjust_max
 
uint32_t sched_n_children_max
 
uint32_t sched_sp_n_priorities_max
 
uint32_t sched_wfq_n_children_per_group_max
 
uint32_t sched_wfq_n_groups_max
 
uint32_t sched_wfq_weight_max
 
int sched_wfq_packet_mode_supported
 
int sched_wfq_byte_mode_supported
 
int cman_wred_packet_mode_supported
 
int cman_wred_byte_mode_supported
 
int cman_head_drop_supported
 
uint32_t cman_wred_context_n_max
 
uint32_t cman_wred_context_private_n_max
 
uint32_t cman_wred_context_shared_n_max
 
uint32_t cman_wred_context_shared_n_nodes_per_context_max
 
uint32_t cman_wred_context_shared_n_contexts_per_node_max
 
int mark_vlan_dei_supported [RTE_COLORS]
 
int mark_ip_ecn_tcp_supported [RTE_COLORS]
 
int mark_ip_ecn_sctp_supported [RTE_COLORS]
 
int mark_ip_dscp_supported [RTE_COLORS]
 
uint64_t dynamic_update_mask
 
uint64_t stats_mask
 

Detailed Description

Traffic manager capabilities

Definition at line 202 of file rte_tm.h.

Field Documentation

◆ n_nodes_max

uint32_t n_nodes_max

Maximum number of nodes.

Definition at line 204 of file rte_tm.h.

◆ n_levels_max

uint32_t n_levels_max

Maximum number of levels (i.e. number of nodes connecting the root node with any leaf node, including the root and the leaf).

Definition at line 209 of file rte_tm.h.

◆ non_leaf_nodes_identical

int non_leaf_nodes_identical

When non-zero, this flag indicates that all the non-leaf nodes (with the exception of the root node) have identical capability set.

Definition at line 214 of file rte_tm.h.

◆ leaf_nodes_identical

int leaf_nodes_identical

When non-zero, this flag indicates that all the leaf nodes have identical capability set.

Definition at line 219 of file rte_tm.h.

◆ shaper_n_max

uint32_t shaper_n_max

Maximum number of shapers, either private or shared. In case the implementation does not share any resources between private and shared shapers, it is typically equal to the sum of shaper_private_n_max and shaper_shared_n_max. The value of zero indicates that traffic shaping is not supported.

Definition at line 227 of file rte_tm.h.

◆ shaper_private_n_max

uint32_t shaper_private_n_max

Maximum number of private shapers. Indicates the maximum number of nodes that can concurrently have their private shaper enabled. The value of zero indicates that private shapers are not supported.

Definition at line 233 of file rte_tm.h.

◆ shaper_private_dual_rate_n_max

int shaper_private_dual_rate_n_max

Maximum number of private shapers that support dual rate shaping. Indicates the maximum number of nodes that can concurrently have their private shaper enabled with dual rate support. Only valid when private shapers are supported. The value of zero indicates that dual rate shaping is not available for private shapers. The maximum value is shaper_private_n_max.

Definition at line 242 of file rte_tm.h.

◆ shaper_private_rate_min

uint64_t shaper_private_rate_min

Minimum committed/peak rate (bytes per second) for any private shaper. Valid only when private shapers are supported.

Definition at line 247 of file rte_tm.h.

◆ shaper_private_rate_max

uint64_t shaper_private_rate_max

Maximum committed/peak rate (bytes per second) for any private shaper. Valid only when private shapers are supported.

Definition at line 252 of file rte_tm.h.

◆ shaper_private_packet_mode_supported

int shaper_private_packet_mode_supported

Shaper private packet mode supported. When non-zero, this parameter indicates that there is at least one node that can be configured with packet mode in its private shaper. When shaper is configured in packet mode, committed/peak rate provided is interpreted in packets per second.

Definition at line 260 of file rte_tm.h.

◆ shaper_private_byte_mode_supported

int shaper_private_byte_mode_supported

Shaper private byte mode supported. When non-zero, this parameter indicates that there is at least one node that can be configured with byte mode in its private shaper. When shaper is configured in byte mode, committed/peak rate provided is interpreted in bytes per second.

Definition at line 268 of file rte_tm.h.

◆ shaper_shared_n_max

uint32_t shaper_shared_n_max

Maximum number of shared shapers. The value of zero indicates that shared shapers are not supported.

Definition at line 274 of file rte_tm.h.

◆ shaper_shared_n_nodes_per_shaper_max

uint32_t shaper_shared_n_nodes_per_shaper_max

Maximum number of nodes that can share the same shared shaper. Only valid when shared shapers are supported.

Definition at line 279 of file rte_tm.h.

◆ shaper_shared_n_shapers_per_node_max

uint32_t shaper_shared_n_shapers_per_node_max

Maximum number of shared shapers a node can be part of. This parameter indicates that there is at least one node that can be configured with this many shared shapers, which might not be true for all the nodes. Only valid when shared shapers are supported, in which case it ranges from 1 to shaper_shared_n_max.

Definition at line 287 of file rte_tm.h.

◆ shaper_shared_dual_rate_n_max

uint32_t shaper_shared_dual_rate_n_max

Maximum number of shared shapers that can be configured with dual rate shaping. The value of zero indicates that dual rate shaping support is not available for shared shapers.

Definition at line 293 of file rte_tm.h.

◆ shaper_shared_rate_min

uint64_t shaper_shared_rate_min

Minimum committed/peak rate (bytes per second) for any shared shaper. Only valid when shared shapers are supported.

Definition at line 298 of file rte_tm.h.

◆ shaper_shared_rate_max

uint64_t shaper_shared_rate_max

Maximum committed/peak rate (bytes per second) for any shared shaper. Only valid when shared shapers are supported.

Definition at line 303 of file rte_tm.h.

◆ shaper_shared_packet_mode_supported

int shaper_shared_packet_mode_supported

Shaper shared packet mode supported. When non-zero, this parameter indicates a shared shaper can be configured with packet mode. When shared shaper is configured in packet mode, committed/peak rate provided is interpreted in packets per second.

Definition at line 310 of file rte_tm.h.

◆ shaper_shared_byte_mode_supported

int shaper_shared_byte_mode_supported

Shaper shared byte mode supported. When non-zero, this parameter indicates that a shared shaper can be configured with byte mode. When shared shaper is configured in byte mode, committed/peak rate provided is interpreted in bytes per second.

Definition at line 317 of file rte_tm.h.

◆ shaper_pkt_length_adjust_min

int shaper_pkt_length_adjust_min

Minimum value allowed for packet length adjustment for any private or shared shaper.

Definition at line 323 of file rte_tm.h.

◆ shaper_pkt_length_adjust_max

int shaper_pkt_length_adjust_max

Maximum value allowed for packet length adjustment for any private or shared shaper.

Definition at line 328 of file rte_tm.h.

◆ sched_n_children_max

uint32_t sched_n_children_max

Maximum number of children nodes. This parameter indicates that there is at least one non-leaf node that can be configured with this many children nodes, which might not be true for all the non-leaf nodes.

Definition at line 335 of file rte_tm.h.

◆ sched_sp_n_priorities_max

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 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. 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.

Definition at line 345 of file rte_tm.h.

◆ sched_wfq_n_children_per_group_max

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 that meets this condition, which might not be true for all the non-leaf nodes. The value of zero is invalid. The value of 1 indicates that WFQ algorithm is not supported. The maximum value is sched_n_children_max.

Definition at line 355 of file rte_tm.h.

◆ sched_wfq_n_groups_max

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 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. The value of 1 indicates that (sched_sp_n_priorities_max - 1) priority levels 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. The maximum value is: min(floor(sched_n_children_max / 2), sched_sp_n_priorities_max).

Definition at line 368 of file rte_tm.h.

◆ sched_wfq_weight_max

uint32_t sched_wfq_weight_max

Maximum WFQ weight. The value of 1 indicates that all sibling nodes with same priority have the same WFQ weight, so WFQ is reduced to FQ.

Definition at line 373 of file rte_tm.h.

◆ sched_wfq_packet_mode_supported

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 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 381 of file rte_tm.h.

◆ sched_wfq_byte_mode_supported

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 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 389 of file rte_tm.h.

◆ cman_wred_packet_mode_supported

int cman_wred_packet_mode_supported

WRED packet mode support. When non-zero, this parameter indicates that there is at least one leaf node 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 397 of file rte_tm.h.

◆ cman_wred_byte_mode_supported

int cman_wred_byte_mode_supported

WRED byte mode support. When non-zero, this parameter indicates that there is at least one leaf node 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 405 of file rte_tm.h.

◆ cman_head_drop_supported

int cman_head_drop_supported

Head drop algorithm support. When non-zero, this parameter indicates that there is at least one leaf node that supports the head drop algorithm, which might not be true for all the leaf nodes.

Definition at line 411 of file rte_tm.h.

◆ cman_wred_context_n_max

uint32_t cman_wred_context_n_max

Maximum number of WRED contexts, either private or shared. In case the implementation does not share any resources between private and shared WRED contexts, it is typically equal to the sum of cman_wred_context_private_n_max and cman_wred_context_shared_n_max. The value of zero indicates that WRED is not supported.

Definition at line 420 of file rte_tm.h.

◆ cman_wred_context_private_n_max

uint32_t cman_wred_context_private_n_max

Maximum number of private WRED contexts. Indicates the maximum number of leaf nodes that can concurrently have their private WRED context enabled. The value of zero indicates that private WRED contexts are not supported.

Definition at line 427 of file rte_tm.h.

◆ cman_wred_context_shared_n_max

uint32_t cman_wred_context_shared_n_max

Maximum number of shared WRED contexts. The value of zero indicates that shared WRED contexts are not supported.

Definition at line 432 of file rte_tm.h.

◆ cman_wred_context_shared_n_nodes_per_context_max

uint32_t cman_wred_context_shared_n_nodes_per_context_max

Maximum number of leaf nodes that can share the same WRED context. Only valid when shared WRED contexts are supported.

Definition at line 437 of file rte_tm.h.

◆ cman_wred_context_shared_n_contexts_per_node_max

uint32_t cman_wred_context_shared_n_contexts_per_node_max

Maximum number of shared WRED contexts a leaf node can be part of. This parameter indicates that there is at least one leaf node that can be configured with this many shared WRED contexts, which might not be true for all the leaf nodes. Only valid when shared WRED contexts are supported, in which case it ranges from 1 to cman_wred_context_shared_n_max.

Definition at line 446 of file rte_tm.h.

◆ mark_vlan_dei_supported

int mark_vlan_dei_supported[RTE_COLORS]

Support for VLAN DEI packet marking (per color).

Definition at line 449 of file rte_tm.h.

◆ mark_ip_ecn_tcp_supported

int mark_ip_ecn_tcp_supported[RTE_COLORS]

Support for IPv4/IPv6 ECN marking of TCP packets (per color).

Definition at line 452 of file rte_tm.h.

◆ mark_ip_ecn_sctp_supported

int mark_ip_ecn_sctp_supported[RTE_COLORS]

Support for IPv4/IPv6 ECN marking of SCTP packets (per color).

Definition at line 455 of file rte_tm.h.

◆ mark_ip_dscp_supported

int mark_ip_dscp_supported[RTE_COLORS]

Support for IPv4/IPv6 DSCP packet marking (per color).

Definition at line 458 of file rte_tm.h.

◆ dynamic_update_mask

uint64_t dynamic_update_mask

Set of supported dynamic update operations.

See also
enum rte_tm_dynamic_update_type

Definition at line 463 of file rte_tm.h.

◆ stats_mask

uint64_t stats_mask

Set of supported statistics counter types.

See also
enum rte_tm_stats_type

Definition at line 468 of file rte_tm.h.


The documentation for this struct was generated from the following file: