numam-dpdk/lib/librte_eal/common/eal_hugepages.h
Kevin Traynor baf023a8ed lib: fix doxygen typos
Fix these as they are user visible. Found with codespell.

Fixes: af75078fece3 ("first public release")
Fixes: c2361bab70c5 ("eal: compute IOVA mode based on PA availability")
Fixes: 0880c40113ef ("drivers: advertise kmod dependencies in pmdinfo")
Fixes: 56b6ef874f80 ("efd: new Elastic Flow Distributor library")
Fixes: 5a5f3178d4a8 ("power: return error when environment already set")
Cc: stable@dpdk.org

Signed-off-by: Kevin Traynor <ktraynor@redhat.com>
Reviewed-by: David Marchand <david.marchand@redhat.com>
2019-11-19 22:03:38 +01:00

41 lines
1.0 KiB
C

/* SPDX-License-Identifier: BSD-3-Clause
* Copyright(c) 2010-2014 Intel Corporation
*/
#ifndef EAL_HUGEPAGES_H
#define EAL_HUGEPAGES_H
#include <stddef.h>
#include <stdint.h>
#include <limits.h>
#define MAX_HUGEPAGE_PATH PATH_MAX
/**
* Structure used to store information about hugepages that we mapped
* through the files in hugetlbfs.
*/
struct hugepage_file {
void *orig_va; /**< virtual addr of first mmap() */
void *final_va; /**< virtual addr of 2nd mmap() */
uint64_t physaddr; /**< physical addr */
size_t size; /**< the page size */
int socket_id; /**< NUMA socket ID */
int file_id; /**< the '%d' in HUGEFILE_FMT */
char filepath[MAX_HUGEPAGE_PATH]; /**< path to backing file on filesystem */
};
/**
* Read the information on what hugepages are available for the EAL to use,
* clearing out any unused ones.
*/
int eal_hugepage_info_init(void);
/**
* Read whatever information primary process has shared about hugepages into
* secondary process.
*/
int eal_hugepage_info_read(void);
#endif /* EAL_HUGEPAGES_H */