cne_mmap.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2020-2022 Intel Corporation
 */
 
#ifndef _MMAP_H_
#define _MMAP_H_
 
#include <stddef.h>        // for size_t
#include <stdint.h>        // for uint64_t, uint8_t
 
#include <cne_common.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum {
    MMAP_HUGEPAGE_4KB, 
    MMAP_HUGEPAGE_2MB, 
    MMAP_HUGEPAGE_1GB, 
    MMAP_HUGEPAGE_CNT  
} mmap_type_t;
 
#define MMAP_HUGEPAGE_DEFAULT MMAP_HUGEPAGE_4KB
 
typedef struct {
    uint64_t page_sz;       
    uint64_t num_allocated; 
    uint64_t num_freed;     
    uint64_t allocated;     
    uint64_t freed;         
} mmap_sizes_t;
 
typedef struct {
    uint8_t inited;                        
    mmap_sizes_t sizes[MMAP_HUGEPAGE_CNT]; 
} mmap_stats_t;
 
typedef void mmap_t; 
CNDP_API mmap_t *mmap_alloc(uint32_t bufcnt, uint32_t bufsz, mmap_type_t hugepage);
 
CNDP_API int mmap_free(mmap_t *mmap);
 
CNDP_API void *mmap_addr_at_offset(mmap_t *mm, size_t offset);
 
CNDP_API void *mmap_addr(mmap_t *mm);
 
CNDP_API size_t mmap_size(mmap_t *mm, uint32_t *bufcnt, uint32_t *bufsz);
 
CNDP_API mmap_type_t mmap_type_by_name(const char *htype);
 
CNDP_API const char *mmap_name_by_type(mmap_type_t typ);
 
CNDP_API void mmap_set_default(mmap_type_t htype);
 
CNDP_API void mmap_set_default_by_name(const char *name);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _MMAP_H_ */