Scheduler capabilities. More...

#include <schedule_types.h>

Collaboration diagram for odp_schedule_capability_t:

Data Fields
uint32_t	max_ordered_locks
	Maximum number of ordered locks per queue.

uint32_t	max_groups
	Maximum number of scheduling groups. More...

uint32_t	max_prios
	Number of scheduling priorities.

uint32_t	max_queues
	Maximum number of scheduled (ODP_BLOCKING) queues of the default size.

uint32_t	max_queue_size
	Maximum number of events a scheduled (ODP_BLOCKING) queue can store simultaneously. More...

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

odp_support_t	lockfree_queues
	Lock-free (ODP_NONBLOCKING_LF) queues support. More...

odp_support_t	waitfree_queues
	Wait-free (ODP_NONBLOCKING_WF) queues support. More...

odp_support_t	order_wait
	Order wait support. More...

odp_event_aggr_capability_t	aggr
	Event aggregator capabilities for scheduled queues.

Detailed Description

Scheduler capabilities.

Examples: odp_bench_buffer.c, odp_bench_pktio_sp.c, odp_dma_perf.c, odp_l2fwd.c, odp_pktio_ordered.c, odp_sched_latency.c, odp_sched_perf.c, odp_stress.c, and odp_sysinfo.c.

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

Field Documentation

◆ max_groups

uint32_t odp_schedule_capability_t::max_groups

Maximum number of scheduling groups.

The value includes the enabled predefined scheduling groups (ODP_SCHED_GROUP_ALL, ODP_SCHED_GROUP_WORKER, and ODP_SCHED_GROUP_CONTROL). By default, an application can create 'max_groups' - 3 groups.

Examples: odp_dma_perf.c, odp_l2fwd.c, odp_sched_latency.c, odp_sched_perf.c, odp_stress.c, and odp_sysinfo.c.

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

◆ max_queue_size

uint32_t odp_schedule_capability_t::max_queue_size

Maximum number of events a scheduled (ODP_BLOCKING) queue can store simultaneously.

The value of zero means that scheduled queues do not have a size limit, but a single queue can store all available events.

Examples: odp_sched_latency.c, and odp_sysinfo.c.

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

◆ max_flow_id

uint32_t odp_schedule_capability_t::max_flow_id

Maximum flow ID per queue.

Valid flow ID range in flow aware mode of scheduling is from 0 to this maximum value. So, maximum number of flows per queue is this value plus one. A value of 0 indicates that flow aware mode is not supported.