api/spec/queue_types.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2018 Linaro Limited
 * Copyright (c) 2024-2025 Nokia
 */
 
#ifndef ODP_API_SPEC_QUEUE_TYPES_H_
#define ODP_API_SPEC_QUEUE_TYPES_H_
#include <odp/visibility_begin.h>
 
#include <odp/api/event_vector_types.h>
#include <odp/api/queue_stats_types.h>
#include <odp/api/schedule_types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum odp_queue_type_t {
    ODP_QUEUE_TYPE_PLAIN = 0,
 
    ODP_QUEUE_TYPE_SCHED,
 
    ODP_QUEUE_TYPE_AGGR,
 
} odp_queue_type_t;
 
typedef enum odp_queue_op_mode_t {
    ODP_QUEUE_OP_MT = 0,
 
    ODP_QUEUE_OP_MT_UNSAFE,
 
    ODP_QUEUE_OP_DISABLED
 
} odp_queue_op_mode_t;
 
typedef enum odp_nonblocking_t {
    ODP_BLOCKING = 0,
 
    ODP_NONBLOCKING_LF,
 
    ODP_NONBLOCKING_WF
 
} odp_nonblocking_t;
 
typedef enum odp_queue_order_t {
    ODP_QUEUE_ORDER_KEEP = 0,
 
    ODP_QUEUE_ORDER_IGNORE
 
} odp_queue_order_t;
 
typedef struct odp_queue_capability_t {
    uint32_t max_queues;
 
    struct {
        uint32_t max_num;
 
        uint32_t max_size;
 
        odp_queue_stats_opt_t stats;
 
        struct {
            uint32_t max_num;
 
            uint32_t max_size;
 
            odp_queue_stats_opt_t stats;
 
        } lockfree;
 
        struct {
            uint32_t max_num;
 
            uint32_t max_size;
 
            odp_queue_stats_opt_t stats;
 
        } waitfree;
 
        odp_event_aggr_capability_t aggr;
 
    } plain;
 
} odp_queue_capability_t;
 
typedef struct odp_queue_param_t {
    odp_queue_type_t type;
 
    odp_queue_op_mode_t enq_mode;
 
    odp_queue_op_mode_t deq_mode;
 
    odp_schedule_param_t sched;
 
    odp_queue_order_t order;
 
    odp_nonblocking_t nonblocking;
 
    void *context;
 
    uint32_t context_len;
 
    uint32_t size;
 
    uint32_t num_aggr;
 
    const odp_event_aggr_config_t *aggr;
 
} odp_queue_param_t;
 
typedef struct odp_queue_info_t {
    const char *name;
 
    odp_queue_type_t type;
 
    odp_queue_param_t param;
 
    odp_event_aggr_config_t aggr_config;
 
} odp_queue_info_t;
 
typedef struct odp_aggr_enq_param_t {
    uint8_t start_of_vector :1;
 
    uint8_t end_of_vector :1;
 
} odp_aggr_enq_param_t;
 
typedef struct odp_aggr_enq_profile_t {
    enum {
        ODP_AEP_TYPE_NONE,
 
        ODP_AEP_TYPE_IPV4_FRAG,
 
        ODP_AEP_TYPE_IPV6_FRAG,
 
        ODP_AEP_TYPE_CUSTOM,
    } type;
 
    uintptr_t param;
} odp_aggr_enq_profile_t;
 
#ifdef __cplusplus
}
#endif
 
#include <odp/visibility_end.h>
#endif