API Reference Manual  1.45.0
api/spec/pool.h
Go to the documentation of this file.
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright (c) 2015-2018 Linaro Limited
3  * Copyright (c) 2020-2023 Nokia
4  */
5 
12 #ifndef ODP_API_SPEC_POOL_H_
13 #define ODP_API_SPEC_POOL_H_
14 #include <odp/visibility_begin.h>
15 
16 #ifdef __cplusplus
17 extern "C" {
18 #endif
19 
20 #include <odp/api/std_types.h>
21 #include <odp/api/pool_types.h>
22 
39 
55 odp_pool_t odp_pool_create(const char *name, const odp_pool_param_t *param);
56 
72 
81 odp_pool_t odp_pool_lookup(const char *name);
82 
95 
105 
113 
126 
135 
144 unsigned int odp_pool_max_index(void);
145 
155 
180 
201  const odp_pool_stats_opt_t *opt);
202 
215 
229 
240 
256 odp_pool_t odp_pool_ext_create(const char *name, const odp_pool_ext_param_t *param);
257 
316 int odp_pool_ext_populate(odp_pool_t pool, void *buf[], uint32_t buf_size, uint32_t num,
317  uint32_t flags);
318 
323 #ifdef __cplusplus
324 }
325 #endif
326 
327 #include <odp/visibility_end.h>
328 #endif
ODP pool.
Standard C language types and definitions for ODP.
int odp_pool_stats_reset(odp_pool_t pool)
Reset statistics for pool.
uint64_t odp_pool_to_u64(odp_pool_t hdl)
Get printable value for an odp_pool_t.
odp_pool_t odp_pool_create(const char *name, const odp_pool_param_t *param)
Create a pool.
int odp_pool_capability(odp_pool_capability_t *capa)
Query pool capabilities.
void odp_pool_param_init(odp_pool_param_t *param)
Initialize pool params.
int odp_pool_stats_selected(odp_pool_t pool, odp_pool_stats_selected_t *stats, const odp_pool_stats_opt_t *opt)
Get selected pool statistics.
int odp_pool_destroy(odp_pool_t pool)
Destroy a pool previously created by odp_pool_create()
void odp_pool_print_all(void)
Print debug info about all pools.
void odp_pool_print(odp_pool_t pool)
Print pool info.
int odp_pool_ext_capability(odp_pool_type_t type, odp_pool_ext_capability_t *capa)
Query capabilities of an external memory pool type.
odp_pool_t odp_pool_lookup(const char *name)
Find a pool by name.
unsigned int odp_pool_max_index(void)
Maximum pool index.
void odp_pool_ext_param_init(odp_pool_type_t type, odp_pool_ext_param_t *param)
Initialize pool params.
odp_pool_t odp_pool_ext_create(const char *name, const odp_pool_ext_param_t *param)
Create an external memory pool.
int odp_pool_info(odp_pool_t pool, odp_pool_info_t *info)
Retrieve information about a pool.
odp_pool_type_t
Pool types.
int odp_pool_index(odp_pool_t pool)
Get pool index.
int odp_pool_stats(odp_pool_t pool, odp_pool_stats_t *stats)
Read pool statistics.
int odp_pool_ext_populate(odp_pool_t pool, void *buf[], uint32_t buf_size, uint32_t num, uint32_t flags)
Populate external memory pool with buffer memory.
External memory pool capabilities.
External memory pool parameters.
Pool information struct Used to get information about a pool.
Pool parameters.
Pool statistics counters.
Pool statistics counters.
Pool statistics counters options.