api/spec/schedule_types.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2015-2018 Linaro Limited
 * Copyright (c) 2023-2025 Nokia
 */
 
#ifndef ODP_API_SPEC_SCHEDULE_TYPES_H_
#define ODP_API_SPEC_SCHEDULE_TYPES_H_
#include <odp/visibility_begin.h>
 
#include <odp/api/event_vector_types.h>
#include <odp/api/queue_stats_types.h>
#include <odp/api/std_types.h>
#include <odp/api/thrmask.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef int odp_schedule_prio_t;
 
typedef struct odp_schedule_param_t {
    odp_schedule_prio_t  prio;
 
    odp_schedule_sync_t  sync;
 
    odp_schedule_group_t group;
 
    uint32_t lock_count;
} odp_schedule_param_t;
 
typedef struct odp_schedule_capability_t {
    uint32_t max_ordered_locks;
 
    uint32_t max_groups;
 
    uint32_t max_group_prios;
 
    odp_schedule_prio_t min_prio;
 
    uint32_t max_prios;
 
    uint32_t max_queues;
 
    uint32_t max_queue_size;
 
    odp_queue_stats_opt_t queue_stats;
 
    uint32_t max_flow_id;
 
    odp_support_t lockfree_queues;
 
    odp_support_t waitfree_queues;
 
    odp_support_t order_wait;
 
    odp_event_aggr_capability_t aggr;
 
} odp_schedule_capability_t;
 
typedef struct odp_cache_stash_region_t {
    struct {
        uint32_t offset;
 
        uint32_t len;
 
    } l2;
 
    struct {
        uint32_t offset;
 
        uint32_t len;
 
    } l3;
 
} odp_cache_stash_region_t;
 
typedef struct odp_cache_stash_config_t {
    union {
        struct {
            uint32_t event_metadata_l2  : 1;
 
            uint32_t event_metadata_l3  : 1;
 
            uint32_t event_data_l2      : 1;
 
            uint32_t event_data_l3      : 1;
 
            uint32_t event_user_area_l2 : 1;
 
            uint32_t event_user_area_l3 : 1;
 
            uint32_t queue_context_l2   : 1;
 
            uint32_t queue_context_l3   : 1;
 
        };
 
        uint32_t all;
 
    } regions;
 
    odp_cache_stash_region_t event_metadata;
 
    odp_cache_stash_region_t event_data;
 
    odp_cache_stash_region_t event_user_area;
 
    odp_cache_stash_region_t queue_context;
 
} odp_cache_stash_config_t;
 
typedef struct odp_cache_stash_prio_config_t {
    odp_schedule_prio_t  prio;
 
    odp_cache_stash_config_t config;
 
} odp_cache_stash_prio_config_t;
 
typedef struct odp_schedule_group_param_t {
    struct {
        odp_schedule_prio_t level[ODP_SCHED_MAX_PRIOS];
 
        uint32_t num;
 
    } prio;
 
    struct {
        odp_cache_stash_config_t common;
 
        struct {
            const odp_cache_stash_prio_config_t *prio;
 
            uint32_t num;
 
        };
 
    } cache_stash_hints;
 
} odp_schedule_group_param_t;
 
typedef struct odp_schedule_config_t {
    uint32_t num_groups;
 
    uint32_t num_group_prios;
 
    struct {
        odp_schedule_prio_t min;
 
        uint32_t num;
 
    } prio;
 
    uint32_t num_queues;
 
    uint32_t queue_size;
 
    uint32_t max_flow_id;
 
    struct {
        odp_bool_t all;
 
        odp_bool_t control;
 
        odp_bool_t worker;
 
        odp_schedule_group_param_t all_param;
 
        odp_schedule_group_param_t control_param;
 
        odp_schedule_group_param_t worker_param;
 
    } sched_group;
 
} odp_schedule_config_t;
 
typedef struct odp_schedule_group_info_t {
    const char *name;
 
    odp_thrmask_t thrmask;
 
    int num;
 
    odp_schedule_prio_t level[ODP_SCHED_MAX_PRIOS];
 
} odp_schedule_group_info_t;
 
#ifdef __cplusplus
}
#endif
 
#include <odp/visibility_end.h>
#endif