DPDK  19.08.0
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
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
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_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 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 201 of file rte_tm.h.

Field Documentation

uint32_t n_nodes_max

Maximum number of nodes.

Definition at line 203 of file rte_tm.h.

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

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

int leaf_nodes_identical

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

Definition at line 218 of file rte_tm.h.

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

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

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

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

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

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

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

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

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

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

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

int shaper_pkt_length_adjust_min

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

Definition at line 290 of file rte_tm.h.

int shaper_pkt_length_adjust_max

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

Definition at line 295 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 that can be configured with this many children nodes, which might not be true for all the non-leaf nodes.

Definition at line 302 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 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 312 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 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 322 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 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 335 of file rte_tm.h.

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

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 348 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 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 356 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 that supports the head drop algorithm, which might not be true for all the leaf nodes.

Definition at line 362 of file rte_tm.h.

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

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

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

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

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

int mark_vlan_dei_supported[RTE_COLORS]

Support for VLAN DEI packet marking (per color).

Definition at line 400 of file rte_tm.h.

int mark_ip_ecn_tcp_supported[RTE_COLORS]

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

Definition at line 403 of file rte_tm.h.

int mark_ip_ecn_sctp_supported[RTE_COLORS]

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

Definition at line 406 of file rte_tm.h.

int mark_ip_dscp_supported[RTE_COLORS]

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

Definition at line 409 of file rte_tm.h.

uint64_t dynamic_update_mask

Set of supported dynamic update operations.

See Also
enum rte_tm_dynamic_update_type

Definition at line 414 of file rte_tm.h.

uint64_t stats_mask

Set of supported statistics counter types.

See Also
enum rte_tm_stats_type

Definition at line 419 of file rte_tm.h.


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