mempool_private.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.
 */
 
#ifndef _MEMPOOL_PRIVATE_H_
#define _MEMPOOL_PRIVATE_H_
 
#include <stdio.h>
#include <stdlib.h>
#include <stdint.h>
#include <inttypes.h>
 
#include <cne_branch_prediction.h>
#include <cne_common.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define MEMPOOL_PG_SHIFT_MAX (sizeof(uintptr_t) * CHAR_BIT - 1)
 
#ifndef CNE_MEMPOOL_ALIGN
#define CNE_MEMPOOL_ALIGN CNE_CACHE_LINE_SIZE
#endif
 
#define CNE_MEMPOOL_ALIGN_MASK (CNE_MEMPOOL_ALIGN - 1)
 
struct mempool_stats {
    uint64_t put_bulk;         
    uint64_t put_objs;         
    uint64_t get_success_bulk; 
    uint64_t get_success_objs; 
    uint64_t get_fail_bulk;    
    uint64_t get_fail_objs;    
} __cne_cache_aligned;
 
struct mempool_cache {
    uint32_t size;        
    uint32_t flushthresh; 
    uint32_t len;         
    /*
     * Cache is allocated to this size to allow it to overflow in certain
     * cases to avoid needless emptying of cache.
     */
    void *objs[MEMPOOL_CACHE_MAX_SIZE * 3]; 
} __cne_cache_aligned;
 
struct cne_mempool {
    void *objring;               
    void *objmem;                
    ssize_t objmem_sz;           
    uint32_t obj_cnt;            
    uint32_t obj_sz;             
    uint32_t cache_sz;           
    uint32_t populated_sz;       
    uint32_t free_objmem;        
    struct mempool_cache *cache; 
    struct mempool_stats *stats; 
} __cne_cache_aligned;
 
// clang-format off
#define __MEMPOOL_STAT_ADD(mp, name, n) do {    \
        int __uid = cne_id();                   \
        mp->stats[__uid].name##_objs += n;      \
        mp->stats[__uid].name##_bulk += 1;      \
    } while(0)
// clang-format on
 
#ifdef __cplusplus
}
#endif
 
#endif /* _MEMPOOL_PRIVATE_H_ */