Schedule configuration. More...

#include <schedule_types.h>

Collaboration diagram for odp_schedule_config_t:

Data Fields
uint32_t	num_queues
	Maximum number of scheduled queues to be supported. More...

uint32_t	queue_size
	Maximum number of events required to be stored simultaneously in scheduled queue. More...

uint32_t	max_flow_id
	Maximum flow ID per queue. More...

struct {
odp_bool_t all
	ODP_SCHED_GROUP_ALL. More...

odp_bool_t control
	ODP_SCHED_GROUP_CONTROL. More...

odp_bool_t worker
	ODP_SCHED_GROUP_WORKER. More...

odp_schedule_group_param_t all_param
	Parameters for ODP_SCHED_GROUP_ALL schedule group.

odp_schedule_group_param_t control_param
	Parameters for ODP_SCHED_GROUP_CONTROL schedule group.

odp_schedule_group_param_t worker_param
	Parameters for ODP_SCHED_GROUP_WORKER schedule group.

}	sched_group
	Enable/disable predefined scheduling groups. More...

Detailed Description

Schedule configuration.

Examples: odp_bench_buffer.c, odp_cpu_bench.c, odp_l2fwd.c, odp_pktio_ordered.c, odp_sched_perf.c, odp_sched_pktio.c, and odp_stress.c.

Definition at line 483 of file api/spec/schedule_types.h.

Field Documentation

◆ num_queues

uint32_t odp_schedule_config_t::num_queues

Maximum number of scheduled queues to be supported.

See also: odp_schedule_capability_t

Examples: odp_cpu_bench.c.

Definition at line 488 of file api/spec/schedule_types.h.

◆ queue_size

uint32_t odp_schedule_config_t::queue_size

Maximum number of events required to be stored simultaneously in scheduled queue.

This number must not exceed 'max_queue_size' capability. A value of 0 configures default queue size supported by the implementation.

Examples: odp_cpu_bench.c, and odp_pktio_ordered.c.

Definition at line 495 of file api/spec/schedule_types.h.

◆ max_flow_id

uint32_t odp_schedule_config_t::max_flow_id

Maximum flow ID per queue.

This value must not exceed 'max_flow_id' capability. Flow aware mode of scheduling is enabled when the value is greater than 0. The default value is 0.

Application can assign events to specific flows by calling odp_event_flow_id_set() before enqueuing events into a scheduled queue. When in flow aware mode, the event flow id value affects scheduling of the event and synchronization is maintained per flow within each queue.

Depending on the implementation, there may be much more flows supported than queues, as flows are lightweight entities.