NVIDIA DOCA SDK Data Center on a Chip Framework Documentation
doca_buf_inventory.h File Reference
#include <stddef.h>
#include <stdint.h>
#include <doca_compat.h>
#include <doca_error.h>
#include <doca_types.h>
Include dependency graph for doca_buf_inventory.h:

Go to the source code of this file.

Functions

DOCA_STABLE doca_error_t doca_buf_inventory_create (size_t num_elements, struct doca_buf_inventory **inventory)
 Allocates buffer inventory with default/unset attributes. More...
 
DOCA_STABLE doca_error_t doca_buf_inventory_destroy (struct doca_buf_inventory *inventory)
 Destroy buffer inventory structure. More...
 
DOCA_STABLE doca_error_t doca_buf_inventory_start (struct doca_buf_inventory *inventory)
 Start element retrieval from inventory. More...
 
DOCA_STABLE doca_error_t doca_buf_inventory_stop (struct doca_buf_inventory *inventory)
 Stop element retrieval from inventory. More...
 
DOCA_STABLE doca_error_t doca_buf_inventory_buf_get_by_args (struct doca_buf_inventory *inventory, struct doca_mmap *mmap, void *addr, size_t len, void *data, size_t data_len, struct doca_buf **buf)
 Allocate single element from buffer inventory and point it to the buffer defined by addr, len, data and data_len arguments. More...
 
static doca_error_t doca_buf_inventory_buf_get_by_addr (struct doca_buf_inventory *inventory, struct doca_mmap *mmap, void *addr, size_t len, struct doca_buf **buf)
 Allocate single element from buffer inventory and point it to the buffer defined by addr & len arguments. More...
 
static doca_error_t doca_buf_inventory_buf_get_by_data (struct doca_buf_inventory *inventory, struct doca_mmap *mmap, void *data, size_t data_len, struct doca_buf **buf)
 Allocate single element from buffer inventory and point it to the buffer defined by data & data_len arguments. More...
 
DOCA_STABLE doca_error_t doca_buf_inventory_buf_dup (struct doca_buf_inventory *inventory, const struct doca_buf *src_buf, struct doca_buf **dst_buf)
 Duplicates content of the buf argument into element allocated from buffer inventory. (I.e., deep copy). More...
 
DOCA_STABLE doca_error_t doca_buf_inventory_set_user_data (struct doca_buf_inventory *inventory, union doca_data user_data)
 Set user_data for a DOCA Buffer Inventory. More...
 
DOCA_STABLE doca_error_t doca_buf_inventory_get_num_elements (const struct doca_buf_inventory *inventory, uint32_t *num_of_elements)
 Read the total number of elements in a DOCA Buffer Inventory. More...
 
DOCA_STABLE doca_error_t doca_buf_inventory_get_num_free_elements (const struct doca_buf_inventory *inventory, uint32_t *num_of_free_elements)
 Get the total number of free elements in a DOCA Buffer Inventory. More...
 
DOCA_STABLE doca_error_t doca_buf_inventory_get_user_data (const struct doca_buf_inventory *inventory, union doca_data *user_data)
 Get the user_data of a DOCA Buffer Inventory. More...
 
DOCA_EXPERIMENTAL doca_error_t doca_buf_inventory_expand (struct doca_buf_inventory *inventory, uint32_t num_elements)
 Expand the inventory. More...