odp_tm_wred_params_t Struct Reference

TM WRED parameters. More...

#include <traffic_mngr.h>

Data Fields
odp_tm_percent_t	min_threshold
	When min_threshold is set to zero then single-slope WRED is enabled, as described in the description of med_threshold. More...
odp_tm_percent_t	med_threshold
	The meaning of med_threshold depends upon whether single-slope or dual-slope WRED is being used or not. More...
odp_tm_percent_t	med_drop_prob
	The med_drop_prob is only used when dual-slope WRED is being used, in which case med_drop_prob MUST be < max_drop_prob. More...
odp_tm_percent_t	max_drop_prob
	The max_drop_prob equals the drop probability when the queue fullness almost equals 100%. More...
odp_bool_t	enable_wred
	When enable_wred is false, all tm_queues and tm_nodes that are attached to this profile will not take part in a Random Early Detection algorithm. More...
odp_bool_t	use_byte_fullness
	When use_byte_fullness is true then WRED will use queue memory usage as the fullness criterion, otherwise when use_byte_fullness is false, WRED will use the queue length (i.e. More...

Detailed Description

TM WRED parameters.

Use odp_tm_wred_params_init() to initialize parameters into their default values.

Examples

odp_traffic_mgmt.c.

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

Field Documentation

min_threshold

odp_tm_percent_t odp_tm_wred_params_t::min_threshold

When min_threshold is set to zero then single-slope WRED is enabled, as described in the description of med_threshold.

Otherwise dual-slope WRED is enabled whereby the behavior depends on which of the following three cases exists:

1. queue fullness < min_threshold. In this case the drop probability is zero.
2. min_threshold <= queue fullness < med_threshold. In this case the drop probability increases linearly from zero until it reaches med_drop_prob at a queue fullness equal to med_threshold.
3. med_threshold <= queue fullness. In this case the drop probability increases linearly from med_drop_prob when the queue fullness equals med_threshold until it reaches 100% with a drop probability of max_drop_prob.

Examples

odp_traffic_mgmt.c.

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

med_threshold

odp_tm_percent_t odp_tm_wred_params_t::med_threshold

The meaning of med_threshold depends upon whether single-slope or dual-slope WRED is being used or not.

When min_threshold is 0 then single-slope WRED is enabled in which case the med_threshold value represents (as a percentage of max queue fullness) the point at which the drop probability starts increasing linearly from 0 until it becomes equal to max_drop_prob when the queue fullness reaches 100%. See min_threshold comments for the case of dual-slope WRED.

Examples

odp_traffic_mgmt.c.

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

med_drop_prob

odp_tm_percent_t odp_tm_wred_params_t::med_drop_prob

The med_drop_prob is only used when dual-slope WRED is being used, in which case med_drop_prob MUST be < max_drop_prob.

See min_threshold comments for more details.

Examples

odp_traffic_mgmt.c.

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

max_drop_prob

odp_tm_percent_t odp_tm_wred_params_t::max_drop_prob

The max_drop_prob equals the drop probability when the queue fullness almost equals 100%.

Of course once the queue fullness is >= 100% of the max queue fullness, the drop probability discontinuously becomes 100%.

Examples

odp_traffic_mgmt.c.

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

enable_wred

odp_bool_t odp_tm_wred_params_t::enable_wred

When enable_wred is false, all tm_queues and tm_nodes that are attached to this profile will not take part in a Random Early Detection algorithm.

The default value is false.

Examples

odp_traffic_mgmt.c.

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

use_byte_fullness

odp_bool_t odp_tm_wred_params_t::use_byte_fullness

When use_byte_fullness is true then WRED will use queue memory usage as the fullness criterion, otherwise when use_byte_fullness is false, WRED will use the queue length (i.e.

the number of packets in the queue) as the fullness criterion. Often will be set to true for WRED profiles applied to tm_queues and set to false for WRED profiles applied to tm_nodes. The default value is false.

Examples

odp_traffic_mgmt.c.

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

---

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

• api/spec/traffic_mngr.h