mempool.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2019-2022 Intel Corporation.
 * Copyright (c) 2016 6WIND S.A.
 */
 
#include <stdio.h>        // for FILE, size_t
#include <stdlib.h>
#include <stdint.h>        // for uint32_t, uint16_t
#include <errno.h>
#include <inttypes.h>
#include <sys/queue.h>
#include <sys/types.h>        // for ssize_t
 
struct mempool_cache;
 
#ifndef _CNE_MEMPOOL_H_
#define _CNE_MEMPOOL_H_
 
#include <cne.h>               // for cne_id
#include <cne_common.h>        // for CNDP_API
#include <cne_log.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef void mempool_t; 
typedef void(mempool_obj_cb_t)(mempool_t *mp, void *opaque, void *obj, unsigned obj_idx);
typedef mempool_obj_cb_t mempool_obj_ctor_t; /* compat */
 
typedef void(mempool_ctor_t)(mempool_t *, void *);
 
typedef struct mempool_cfg {
    uint32_t objcnt;   
    uint32_t objsz;    
    uint16_t cache_sz; 
    char *addr;        
    mempool_ctor_t *mp_init;    
    mempool_obj_cb_t *obj_init; 
    void *mp_init_arg;          
    void *obj_init_arg;         
} mempool_cfg_t;
 
CNDP_API mempool_t *mempool_create(struct mempool_cfg *cinfo);
 
CNDP_API mempool_t *mempool_create_empty(struct mempool_cfg *cinfo);
 
CNDP_API void mempool_destroy(mempool_t *mp);
 
CNDP_API int mempool_populate(mempool_t *mp, char *vaddr, size_t len);
 
CNDP_API uint32_t mempool_obj_iter(mempool_t *mp, mempool_obj_cb_t *obj_cb, void *obj_cb_arg);
 
CNDP_API void mempool_dump(mempool_t *mp);
 
CNDP_API struct mempool_cache *mempool_default_cache(mempool_t *mp);
 
CNDP_API void mempool_generic_put(mempool_t *mp, void *const *obj_table, unsigned int n,
                                  struct mempool_cache *cache);
 
CNDP_API void mempool_put_bulk(mempool_t *mp, void *const *obj_table, unsigned int n);
 
CNDP_API void mempool_put(mempool_t *mp, void *obj);
 
CNDP_API int mempool_generic_get(mempool_t *mp, void **obj_table, unsigned int n,
                                 struct mempool_cache *cache);
 
CNDP_API int mempool_get_bulk(mempool_t *mp, void **obj_table, unsigned int n);
 
CNDP_API int mempool_get(mempool_t *mp, void **obj_p);
 
CNDP_API unsigned int mempool_avail_count(const mempool_t *mp);
 
CNDP_API unsigned int mempool_in_use_count(const mempool_t *mp);
 
CNDP_API int mempool_full(const mempool_t *mp);
 
CNDP_API int mempool_empty(const mempool_t *mp);
 
CNDP_API void *mempool_ring_addr(mempool_t *mp);
 
CNDP_API void *mempool_buff_addr(mempool_t *mp);
 
CNDP_API int mempool_objcnt(mempool_t *mp);
 
CNDP_API int mempool_objsz(mempool_t *mp);
 
CNDP_API int mempool_cache_sz(mempool_t *mp);
 
CNDP_API int mempool_cache_len(mempool_t *mp, int idx);
 
CNDP_API int mempool_obj_index(mempool_t *mp, void *obj);
 
CNDP_API void *mempool_obj_at_index(mempool_t *mp, int idx);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _CNE_MEMPOOL_H_ */