api/spec/stash_types.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2020-2023 Nokia
 */
 
#ifndef ODP_API_SPEC_STASH_TYPES_H_
#define ODP_API_SPEC_STASH_TYPES_H_
#include <odp/visibility_begin.h>
 
#include <odp/api/std_types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum odp_stash_type_t {
    ODP_STASH_TYPE_DEFAULT = 0,
 
    ODP_STASH_TYPE_FIFO
 
} odp_stash_type_t;
 
typedef enum odp_stash_op_mode_t {
    ODP_STASH_OP_MT = 0,
 
    ODP_STASH_OP_ST,
 
    ODP_STASH_OP_LOCAL
 
} odp_stash_op_mode_t;
 
typedef union odp_stash_stats_opt_t {
    struct {
        uint64_t count          : 1;
 
        uint64_t cache_count    : 1;
 
    } bit;
 
    uint64_t all;
 
} odp_stash_stats_opt_t;
 
typedef struct odp_stash_stats_t {
    uint64_t count;
 
    uint64_t cache_count;
 
} odp_stash_stats_t;
 
typedef struct odp_stash_capability_t {
    uint32_t max_stashes_any_type;
 
    uint32_t max_stashes;
 
    uint64_t max_num_obj;
 
    struct {
        uint64_t u8;
 
        uint64_t u16;
 
        uint64_t u32;
 
        uint64_t u64;
 
        uint64_t u128;
 
        uint64_t max_obj_size;
    } max_num;
 
    uint32_t max_obj_size;
 
    uint32_t max_cache_size;
 
    uint32_t max_get_batch;
 
    uint32_t max_put_batch;
 
    odp_stash_stats_opt_t stats;
 
} odp_stash_capability_t;
 
typedef struct odp_stash_param_t {
    odp_stash_type_t type;
 
    odp_stash_op_mode_t put_mode;
 
    odp_stash_op_mode_t get_mode;
 
    uint64_t num_obj;
 
    uint32_t obj_size;
 
    uint32_t cache_size;
 
    odp_stash_stats_opt_t stats;
 
    odp_bool_t strict_size;
 
} odp_stash_param_t;
 
#ifdef __cplusplus
}
#endif
 
#include <odp/visibility_end.h>
#endif