api/spec/pool_types.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2021-2025 Nokia
 */
 
#ifndef ODP_API_SPEC_POOL_TYPES_H_
#define ODP_API_SPEC_POOL_TYPES_H_
#include <odp/visibility_begin.h>
 
#include <odp/api/std_types.h>
#include <odp/api/dma_types.h>
#include <odp/api/ml_types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define ODP_POOL_MAX_SUBPARAMS  7
 
typedef union odp_pool_stats_opt_t {
    struct {
        uint64_t available          : 1;
 
        uint64_t alloc_ops          : 1;
 
        uint64_t alloc_fails        : 1;
 
        uint64_t free_ops           : 1;
 
        uint64_t total_ops          : 1;
 
        uint64_t cache_available    : 1;
 
        uint64_t cache_alloc_ops    : 1;
 
        uint64_t cache_free_ops     : 1;
 
        uint64_t thread_cache_available : 1;
    } bit;
 
    uint64_t all;
 
} odp_pool_stats_opt_t;
 
typedef struct odp_pool_stats_t {
    uint64_t available;
 
    uint64_t alloc_ops;
 
    uint64_t alloc_fails;
 
    uint64_t free_ops;
 
    uint64_t total_ops;
 
    uint64_t cache_available;
 
    uint64_t cache_alloc_ops;
 
    uint64_t cache_free_ops;
 
    struct {
        uint16_t first;
 
        uint16_t last;
 
        uint64_t cache_available[ODP_POOL_MAX_THREAD_STATS];
    } thread;
 
} odp_pool_stats_t;
 
typedef struct odp_pool_stats_selected_t {
    uint64_t available;
 
    uint64_t alloc_ops;
 
    uint64_t alloc_fails;
 
    uint64_t free_ops;
 
    uint64_t total_ops;
 
    uint64_t cache_available;
 
    uint64_t cache_alloc_ops;
 
    uint64_t cache_free_ops;
 
} odp_pool_stats_selected_t;
 
typedef struct odp_pool_capability_t {
    uint32_t max_pools;
 
    struct {
        uint32_t max_pools;
 
        uint32_t max_align;
 
        uint32_t max_size;
 
        uint32_t max_num;
 
        uint32_t max_uarea_size;
 
        odp_bool_t uarea_persistence;
 
        uint32_t min_cache_size;
 
        uint32_t max_cache_size;
 
        odp_pool_stats_opt_t stats;
    } buf;
 
    struct {
        uint32_t max_pools;
 
        uint32_t max_len;
 
        uint32_t max_num;
 
        uint32_t max_align;
 
        uint32_t min_headroom;
 
        uint32_t max_headroom;
 
        uint32_t min_tailroom;
 
        uint32_t max_segs_per_pkt;
 
        uint32_t min_seg_len;
 
        uint32_t max_seg_len;
 
        uint32_t max_uarea_size;
 
        odp_bool_t uarea_persistence;
 
        uint8_t max_num_subparam;
 
        uint32_t min_cache_size;
 
        uint32_t max_cache_size;
 
        odp_pool_stats_opt_t stats;
    } pkt;
 
    struct {
        uint32_t max_pools;
 
        uint32_t max_num;
 
        uint32_t max_uarea_size;
 
        odp_bool_t uarea_persistence;
 
        uint32_t min_cache_size;
 
        uint32_t max_cache_size;
 
        odp_pool_stats_opt_t stats;
    } tmo;
 
    struct {
        uint32_t max_pools;
 
        uint32_t max_num;
 
        uint32_t max_size;
 
        uint32_t max_uarea_size;
 
        odp_bool_t uarea_persistence;
 
        uint32_t min_cache_size;
 
        uint32_t max_cache_size;
 
        odp_pool_stats_opt_t stats;
    } vector;
 
    struct {
        uint32_t max_pools;
 
        uint32_t max_num;
 
        uint32_t max_size;
 
        uint32_t max_uarea_size;
 
        odp_bool_t uarea_persistence;
 
        uint32_t min_cache_size;
 
        uint32_t max_cache_size;
 
        odp_pool_stats_opt_t stats;
    } event_vector;
 
} odp_pool_capability_t;
 
typedef struct odp_pool_pkt_subparam_t {
    uint32_t num;
 
    uint32_t len;
 
} odp_pool_pkt_subparam_t;
 
typedef enum odp_pool_type_t {
    ODP_POOL_PACKET = ODP_EVENT_PACKET,
 
    ODP_POOL_BUFFER = ODP_EVENT_BUFFER,
 
    ODP_POOL_TIMEOUT = ODP_EVENT_TIMEOUT,
 
    ODP_POOL_VECTOR,
 
    ODP_POOL_EVENT_VECTOR,
 
    ODP_POOL_DMA_COMPL,
 
    ODP_POOL_ML_COMPL
 
} odp_pool_type_t;
 
typedef struct odp_pool_param_t {
    odp_pool_type_t type;
 
    struct {
        uint32_t num;
 
        uint32_t size;
 
        uint32_t align;
 
        uint32_t uarea_size;
 
        uint32_t cache_size;
    } buf;
 
    struct {
        uint32_t num;
 
        uint32_t max_num;
 
        uint32_t len;
 
        uint32_t max_len;
 
        uint32_t align;
 
        uint32_t seg_len;
 
        uint32_t uarea_size;
 
        uint32_t headroom;
 
        uint8_t num_subparam;
 
        odp_pool_pkt_subparam_t sub[ODP_POOL_MAX_SUBPARAMS];
 
        uint32_t cache_size;
    } pkt;
 
    struct {
        uint32_t num;
 
        uint32_t uarea_size;
 
        uint32_t cache_size;
    } tmo;
 
    struct {
        uint32_t num;
 
        uint32_t max_size;
 
        uint32_t uarea_size;
 
        uint32_t cache_size;
    } vector;
 
    struct {
        uint32_t num;
 
        uint32_t max_size;
 
        uint32_t uarea_size;
 
        uint32_t cache_size;
    } event_vector;
 
    struct {
        void (*init_fn)(void *uarea, uint32_t size, void *args, uint32_t index);
 
        void *args;
    } uarea_init;
 
    odp_pool_stats_opt_t stats;
 
} odp_pool_param_t;
 
#define ODP_POOL_POPULATE_DONE 0x1
 
typedef struct odp_pool_ext_capability_t {
    odp_pool_type_t type;
 
    uint32_t max_pools;
 
    uint32_t min_cache_size;
 
    uint32_t max_cache_size;
 
    odp_pool_stats_opt_t stats;
 
    struct {
        uint32_t max_num_buf;
 
        uint32_t max_buf_size;
 
        uint32_t odp_header_size;
 
        uint32_t odp_trailer_size;
 
        uint32_t min_mem_align;
 
        uint32_t min_buf_align;
 
        uint32_t min_head_align;
 
        struct {
            uint16_t buf_size_aligned : 1;
 
        };
 
        uint32_t max_headroom;
 
        uint32_t max_headroom_size;
 
        uint32_t max_segs_per_pkt;
 
        uint32_t max_uarea_size;
 
        odp_bool_t uarea_persistence;
 
    } pkt;
 
} odp_pool_ext_capability_t;
 
typedef struct odp_pool_ext_param_t {
    odp_pool_type_t type;
 
    struct {
        void (*init_fn)(void *uarea, uint32_t size, void *args, uint32_t index);
 
        void *args;
 
    } uarea_init;
 
    uint32_t cache_size;
 
    odp_pool_stats_opt_t stats;
 
    struct {
        uint32_t num_buf;
 
        uint32_t buf_size;
 
        uint32_t app_header_size;
 
        uint32_t uarea_size;
 
        uint32_t headroom;
 
    } pkt;
 
} odp_pool_ext_param_t;
 
typedef struct odp_pool_info_t {
    odp_pool_type_t type;
 
    const char *name;
 
    odp_bool_t pool_ext;
 
    union {
        odp_pool_param_t params;
 
        odp_pool_ext_param_t pool_ext_param;
 
        odp_dma_pool_param_t dma_pool_param;
 
        odp_ml_compl_pool_param_t ml_pool_param;
    };
 
    struct {
        uint32_t max_num;
 
    } pkt;
 
    uintptr_t min_data_addr;
 
    uintptr_t max_data_addr;
 
} odp_pool_info_t;
 
#ifdef __cplusplus
}
#endif
 
#include <odp/visibility_end.h>
#endif