API Reference Manual  1.45.0
api/spec/schedule.h File Reference

ODP schedule. More...

#include <odp/visibility_begin.h>
#include <odp/api/std_types.h>
#include <odp/api/event_types.h>
#include <odp/api/queue_types.h>
#include <odp/api/schedule_types.h>
#include <odp/api/thrmask.h>
#include <odp/visibility_end.h>
Include dependency graph for api/spec/schedule.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

uint64_t odp_schedule_wait_time (uint64_t ns)
 Schedule wait time. More...
 
odp_event_t odp_schedule (odp_queue_t *from, uint64_t wait)
 Schedule an event. More...
 
int odp_schedule_multi (odp_queue_t *from, uint64_t wait, odp_event_t events[], int num)
 Schedule multiple events. More...
 
int odp_schedule_multi_wait (odp_queue_t *from, odp_event_t events[], int num)
 Schedule, wait for events. More...
 
int odp_schedule_multi_no_wait (odp_queue_t *from, odp_event_t events[], int num)
 Schedule, do not wait for events. More...
 
void odp_schedule_pause (void)
 Pause scheduling. More...
 
void odp_schedule_resume (void)
 Resume scheduling. More...
 
void odp_schedule_release_atomic (void)
 Release the current atomic context. More...
 
void odp_schedule_release_ordered (void)
 Release the current ordered context. More...
 
void odp_schedule_prefetch (int num)
 Prefetch events for next schedule call. More...
 
int odp_schedule_max_prio (void)
 Maximum scheduling priority level. More...
 
int odp_schedule_min_prio (void)
 Minimum scheduling priority level. More...
 
int odp_schedule_default_prio (void)
 Default scheduling priority level. More...
 
int odp_schedule_num_prio (void)
 Number of scheduling priorities. More...
 
void odp_schedule_config_init (odp_schedule_config_t *config)
 Initialize schedule configuration options. More...
 
int odp_schedule_config (const odp_schedule_config_t *config)
 Global schedule configuration. More...
 
int odp_schedule_capability (odp_schedule_capability_t *capa)
 Query scheduler capabilities. More...
 
odp_schedule_group_t odp_schedule_group_create (const char *name, const odp_thrmask_t *mask)
 Schedule group create. More...
 
int odp_schedule_group_destroy (odp_schedule_group_t group)
 Schedule group destroy. More...
 
odp_schedule_group_t odp_schedule_group_lookup (const char *name)
 Look up a schedule group by name. More...
 
int odp_schedule_group_join (odp_schedule_group_t group, const odp_thrmask_t *mask)
 Join a schedule group. More...
 
int odp_schedule_group_leave (odp_schedule_group_t group, const odp_thrmask_t *mask)
 Leave a schedule group. More...
 
int odp_schedule_group_thrmask (odp_schedule_group_t group, odp_thrmask_t *thrmask)
 Get a schedule group's thrmask. More...
 
int odp_schedule_group_info (odp_schedule_group_t group, odp_schedule_group_info_t *info)
 Retrieve information about a schedule group. More...
 
void odp_schedule_order_lock (uint32_t lock_index)
 Acquire ordered context lock. More...
 
void odp_schedule_order_unlock (uint32_t lock_index)
 Release ordered context lock. More...
 
void odp_schedule_order_unlock_lock (uint32_t unlock_index, uint32_t lock_index)
 Release existing ordered context lock and acquire a new lock. More...
 
void odp_schedule_order_lock_start (uint32_t lock_index)
 Asynchronous ordered context lock Request an ordered context lock to be acquired. More...
 
void odp_schedule_order_lock_wait (uint32_t lock_index)
 Asynchronous ordered context lock wait Wait for a previously started lock acquire operation to finish. More...
 
void odp_schedule_order_wait (void)
 Wait until the currently held scheduling context is the first in order. More...
 
void odp_schedule_print (void)
 Print debug info about scheduler. More...
 

Detailed Description

ODP schedule.

Definition in file api/spec/schedule.h.