TM node parameters. More...

#include <traffic_mngr.h>

Data Fields
void *	user_context
	The user_context field is an generic pointer that the user can associate with a tm_node and then get this same value back using the odp_tm_node_context() call.

uint32_t	max_fanin
	The max_fanin sets the maximum number of src tm_queues and producer tm_nodes that can be simultaneously be connected to this tm_node as their destination.

odp_tm_shaper_t	shaper_profile
	The shaper profile to be associated with this tm_node. More...

odp_tm_threshold_t	threshold_profile
	The threshold profile to be used in setting the max queue fullness for WRED and/or tail drop. More...

odp_tm_wred_t	wred_profile [ODP_NUM_PACKET_COLORS]
	The WRED profile(s) to be associated with this tm_node. More...

uint8_t	level
	The level (or tm_node stage) sets the level for this tm_node It must be in range 0..max_levels-1. More...

uint8_t	priority
	New strict priority level assigned to packets going through this node when packet priority mode is ODP_TM_PKT_PRIO_MODE_OVERWRITE. More...

Detailed Description

TM node parameters.

Many of these fields are optional EXCEPT for max_fanin and level. Use odp_tm_node_params_init() to initialize parameters into their default values.

Examples: odp_traffic_mgmt.c.

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

Field Documentation

◆ shaper_profile

odp_tm_shaper_t odp_tm_node_params_t::shaper_profile

The shaper profile to be associated with this tm_node.

Can be ODP_TM_INVALID and can also be set and changed post-creation via odp_tm_node_shaper_config(); The default value is ODP_TM_INVALID.

Examples: odp_traffic_mgmt.c.

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

◆ threshold_profile

odp_tm_threshold_t odp_tm_node_params_t::threshold_profile

The threshold profile to be used in setting the max queue fullness for WRED and/or tail drop.

Can be ODP_TM_INVALID and can also be set and changed post-creation via odp_tm_node_threshold_config(). The default value is ODP_TM_INVALID.

Examples: odp_traffic_mgmt.c.

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

◆ wred_profile

odp_tm_wred_t odp_tm_node_params_t::wred_profile[ODP_NUM_PACKET_COLORS]

The WRED profile(s) to be associated with this tm_node.

Any or all array elements can be ODP_TM_INVALID and can also be set and changed post-creation via odp_tm_node_wred_config(). The default value is ODP_TM_INVALID for every color.

Examples: odp_traffic_mgmt.c.

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

◆ level

uint8_t odp_tm_node_params_t::level

The level (or tm_node stage) sets the level for this tm_node It must be in range 0..max_levels-1.

Note that the tm_node topology is constrained such that only tm_node outputs with numerically greater levels may be connected to the fan-in of tm_node's with numerically smaller levels.

Examples: odp_traffic_mgmt.c.

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

◆ priority

uint8_t odp_tm_node_params_t::priority

New strict priority level assigned to packets going through this node when packet priority mode is ODP_TM_PKT_PRIO_MODE_OVERWRITE.

In other packet priority modes this field is ignored. The new priority does not affect packet processing in this node but in its destination node.

The value must be in the range 0..ODP_TM_MAX_PRIORITIES-1. Additionally, the total number of possible priorities seen by the destination node must not exceed the max priority configured for the destination node.

See also: odp_tm_pkt_prio_mode_t; odp_tm_level_requirements_t::max_priority

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

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

api/spec/traffic_mngr.h