rte_memory.h

Go to the documentation of this file.

#ifndef RTE_OS_MEMORY_H
#define RTE_OS_MEMORY_H
 
#include "rte/utils/status/rte_status.h"
#include "rte/utils/types/rte_types.h"
 
#ifdef __cplusplus
extern "C" {
#endif

RTE_DECLARE_STORAGE(rte_mem_pool_storage_t, 64U);

typedef struct rte_mem_pool_impl_s *rte_mem_pool_handle_t;

typedef struct rte_mem_pool_config_s
{
    size_t block_size;    
    size_t block_count;   
} rte_mem_pool_config_t;

rte_status_t rte_mem_pool_create(rte_mem_pool_storage_t *storage,
                                    const rte_mem_pool_config_t *config,
                                    rte_mem_pool_handle_t *out_handle);

rte_status_t rte_mem_pool_acquire(rte_mem_pool_handle_t handle, void **out_block);

rte_status_t rte_mem_pool_release(rte_mem_pool_handle_t handle, void *block);

rte_status_t rte_mem_pool_stats(rte_mem_pool_handle_t handle,
                                   size_t *out_free_blocks,
                                   size_t *out_used_blocks);
 
/*
 * The OSAdapter vtable (rte_osadapter_memory_t) and
 * rte_osadapter_memory_register() live in
 * rte_osadapter/memory/rte_osadapter_memory.h, not here (ADR-021). This
 * header is the consumer-facing surface only.
 */
 
#ifdef __cplusplus
}
#endif
 
#endif /* RTE_OS_MEMORY_H */
 /* MEMORY */