Per Level Capabilities. More...

#include <traffic_mngr.h>

Collaboration diagram for odp_tm_level_capabilities_t:

Data Fields
uint32_t	max_num_tm_nodes
	max_num_tm_nodes specifies the maximum number of tm_nodes allowed at this level.

uint32_t	max_fanin_per_node
	max_fanin_per_level specifies the maximum number of fan_in links to any given scheduler (whether weighted or using fair queueing or round robin) belonging to tm_nodes at this level.

uint8_t	max_priority
	max_priority specifies the maximum number of strict priority levels used by any tm_node at this level.

uint32_t	min_weight
	min_weight only has significance when the weights_supported field below is true, in which case it specifies the smallest value of the weights allowed at this level.

uint32_t	max_weight
	max_weight only has significance when the weights_supported field below is true, in which case it specifies the largest value of the weights allowed at this level.

uint32_t	min_burst_packets
	Minimum allowed value for odp_tm_shaper_params_t::commit_burst and odp_tm_shaper_params_t::peak_burst when odp_tm_shaper_params_t::packet_mode is true.

uint32_t	max_burst_packets
	Maximum allowed value for odp_tm_shaper_params_t::commit_burst and odp_tm_shaper_params_t::peak_burst when odp_tm_shaper_params_t::packet_mode is true.

uint64_t	min_rate_packets
	Minimum allowed value for odp_tm_shaper_params_t::commit_rate and odp_tm_shaper_params_t::peak_rate when odp_tm_shaper_params_t::packet_mode is true.

uint64_t	max_rate_packets
	Maximum allowed value for odp_tm_shaper_params_t::commit_rate and odp_tm_shaper_params_t::peak_rate when odp_tm_shaper_params_t::packet_mode is true.

uint32_t	min_burst
	Minimum allowed value for odp_tm_shaper_params_t::commit_burst and odp_tm_shaper_params_t::peak_burst when odp_tm_shaper_params_t::packet_mode is false.

uint32_t	max_burst
	Maximum allowed value for odp_tm_shaper_params_t::commit_burst and odp_tm_shaper_params_t::peak_burst when odp_tm_shaper_params_t::packet_mode is false.

uint64_t	min_rate
	Minimum allowed value for odp_tm_shaper_params_t::commit_rate and odp_tm_shaper_params_t::peak_rate when odp_tm_shaper_params_t::packet_mode is false.

uint64_t	max_rate
	Maximum allowed value for odp_tm_shaper_params_t::commit_rate and odp_tm_shaper_params_t::peak_rate when odp_tm_shaper_params_t::packet_mode is false.

odp_bool_t	tm_node_shaper_supported
	Shaper is supported in rate shape mode.

odp_bool_t	tm_node_rate_limiter_supported
	Shaper is supported in rate limit mode.

odp_bool_t	tm_node_shaper_packet_mode
	tm_node_shaper_packet_mode indicates that tm_nodes at this level support shaper in packet mode

odp_bool_t	tm_node_wred_supported
	tm_node_wred_supported indicates that the tm_nodes at this level support some form of Random Early Detection.

odp_bool_t	tm_node_dual_slope_supported
	tm_node_dual_slope_supported indicates that the tm_nodes at this level support the dual slope WRED capability.

odp_bool_t	fair_queuing_supported
	fair_queuing_supported indicates that the tm_node schedulers at this level can implement WFQ or FQ scheduling disciplines (otherwise these schedulers can only implement WRR or RR algorithms.

odp_bool_t	weights_supported
	weights_supported indicates that the tm_node schedulers at this level can have their different weights for their different fanins.

struct {

uint8_t byte: 1
	Threshold given as bytes. More...

uint8_t packet: 1
	Threshold given as packets. More...

uint8_t byte_and_packet: 1
	Threshold given as bytes and packets simultaneously. More...

}	tm_node_threshold
	TM node threshold profile support.

odp_tm_node_stats_capability_t	node_stats
	Node statistics counter capabilities.

Detailed Description

Per Level Capabilities.

The odp_tm_level_capabilities_t record is used to describe the capabilities that might vary based upon the tm_node level. It is always used as part of the odp_tm_capabilities record.

Examples: odp_traffic_mgmt.c.

Definition at line 287 of file api/spec/traffic_mngr.h.

Field Documentation

◆ max_num_tm_nodes

uint32_t odp_tm_level_capabilities_t::max_num_tm_nodes

max_num_tm_nodes specifies the maximum number of tm_nodes allowed at this level.

Definition at line 290 of file api/spec/traffic_mngr.h.

◆ max_fanin_per_node

uint32_t odp_tm_level_capabilities_t::max_fanin_per_node

max_fanin_per_level specifies the maximum number of fan_in links to any given scheduler (whether weighted or using fair queueing or round robin) belonging to tm_nodes at this level.

Definition at line 295 of file api/spec/traffic_mngr.h.

◆ max_priority

uint8_t odp_tm_level_capabilities_t::max_priority

max_priority specifies the maximum number of strict priority levels used by any tm_node at this level.

Note that lower numeric values represent higher (more important or time critical) priorities.

Definition at line 301 of file api/spec/traffic_mngr.h.

◆ min_weight

uint32_t odp_tm_level_capabilities_t::min_weight

min_weight only has significance when the weights_supported field below is true, in which case it specifies the smallest value of the weights allowed at this level.

Definition at line 306 of file api/spec/traffic_mngr.h.

◆ max_weight

uint32_t odp_tm_level_capabilities_t::max_weight

max_weight only has significance when the weights_supported field below is true, in which case it specifies the largest value of the weights allowed at this level.

Definition at line 311 of file api/spec/traffic_mngr.h.

◆ min_burst_packets

uint32_t odp_tm_level_capabilities_t::min_burst_packets

Minimum allowed value for odp_tm_shaper_params_t::commit_burst and odp_tm_shaper_params_t::peak_burst when odp_tm_shaper_params_t::packet_mode is true.

Definition at line 317 of file api/spec/traffic_mngr.h.

◆ max_burst_packets

uint32_t odp_tm_level_capabilities_t::max_burst_packets

Maximum allowed value for odp_tm_shaper_params_t::commit_burst and odp_tm_shaper_params_t::peak_burst when odp_tm_shaper_params_t::packet_mode is true.

Definition at line 323 of file api/spec/traffic_mngr.h.

◆ min_rate_packets

uint64_t odp_tm_level_capabilities_t::min_rate_packets

Minimum allowed value for odp_tm_shaper_params_t::commit_rate and odp_tm_shaper_params_t::peak_rate when odp_tm_shaper_params_t::packet_mode is true.

Definition at line 329 of file api/spec/traffic_mngr.h.

◆ max_rate_packets

uint64_t odp_tm_level_capabilities_t::max_rate_packets

Maximum allowed value for odp_tm_shaper_params_t::commit_rate and odp_tm_shaper_params_t::peak_rate when odp_tm_shaper_params_t::packet_mode is true.

Definition at line 335 of file api/spec/traffic_mngr.h.

◆ min_burst

uint32_t odp_tm_level_capabilities_t::min_burst

Minimum allowed value for odp_tm_shaper_params_t::commit_burst and odp_tm_shaper_params_t::peak_burst when odp_tm_shaper_params_t::packet_mode is false.

Examples: odp_traffic_mgmt.c.

Definition at line 341 of file api/spec/traffic_mngr.h.

◆ max_burst

uint32_t odp_tm_level_capabilities_t::max_burst

Maximum allowed value for odp_tm_shaper_params_t::commit_burst and odp_tm_shaper_params_t::peak_burst when odp_tm_shaper_params_t::packet_mode is false.

Examples: odp_traffic_mgmt.c.

Definition at line 347 of file api/spec/traffic_mngr.h.

◆ min_rate

uint64_t odp_tm_level_capabilities_t::min_rate

Minimum allowed value for odp_tm_shaper_params_t::commit_rate and odp_tm_shaper_params_t::peak_rate when odp_tm_shaper_params_t::packet_mode is false.

Examples: odp_traffic_mgmt.c.

Definition at line 353 of file api/spec/traffic_mngr.h.

◆ max_rate

uint64_t odp_tm_level_capabilities_t::max_rate

Maximum allowed value for odp_tm_shaper_params_t::commit_rate and odp_tm_shaper_params_t::peak_rate when odp_tm_shaper_params_t::packet_mode is false.

Examples: odp_traffic_mgmt.c.

Definition at line 359 of file api/spec/traffic_mngr.h.

◆ tm_node_shaper_supported

odp_bool_t odp_tm_level_capabilities_t::tm_node_shaper_supported

Shaper is supported in rate shape mode.

Definition at line 362 of file api/spec/traffic_mngr.h.

◆ tm_node_rate_limiter_supported

odp_bool_t odp_tm_level_capabilities_t::tm_node_rate_limiter_supported

Shaper is supported in rate limit mode.

Definition at line 365 of file api/spec/traffic_mngr.h.

◆ tm_node_shaper_packet_mode

odp_bool_t odp_tm_level_capabilities_t::tm_node_shaper_packet_mode

tm_node_shaper_packet_mode indicates that tm_nodes at this level support shaper in packet mode

Definition at line 369 of file api/spec/traffic_mngr.h.

◆ tm_node_wred_supported

odp_bool_t odp_tm_level_capabilities_t::tm_node_wred_supported

tm_node_wred_supported indicates that the tm_nodes at this level support some form of Random Early Detection.

Definition at line 373 of file api/spec/traffic_mngr.h.

◆ tm_node_dual_slope_supported

odp_bool_t odp_tm_level_capabilities_t::tm_node_dual_slope_supported

tm_node_dual_slope_supported indicates that the tm_nodes at this level support the dual slope WRED capability.

This field is ignored if tm_node_wred_supported above is false.

Definition at line 378 of file api/spec/traffic_mngr.h.

◆ fair_queuing_supported

odp_bool_t odp_tm_level_capabilities_t::fair_queuing_supported

fair_queuing_supported indicates that the tm_node schedulers at this level can implement WFQ or FQ scheduling disciplines (otherwise these schedulers can only implement WRR or RR algorithms.

Definition at line 384 of file api/spec/traffic_mngr.h.

◆ weights_supported

odp_bool_t odp_tm_level_capabilities_t::weights_supported

weights_supported indicates that the tm_node schedulers at this level can have their different weights for their different fanins.

When true the min_weight and max_weight fields above specify the legal range of such weights.

Definition at line 390 of file api/spec/traffic_mngr.h.

◆ byte

uint8_t odp_tm_level_capabilities_t::byte

Threshold given as bytes.

Definition at line 395 of file api/spec/traffic_mngr.h.

◆ packet

uint8_t odp_tm_level_capabilities_t::packet

Threshold given as packets.

Definition at line 398 of file api/spec/traffic_mngr.h.

◆ byte_and_packet

uint8_t odp_tm_level_capabilities_t::byte_and_packet

Threshold given as bytes and packets simultaneously.

Definition at line 401 of file api/spec/traffic_mngr.h.

◆ node_stats

odp_tm_node_stats_capability_t odp_tm_level_capabilities_t::node_stats

Node statistics counter capabilities.

Definition at line 406 of file api/spec/traffic_mngr.h.

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

api/spec/traffic_mngr.h

Data Fields