e957e2ca80
Since commit "add FILE argument to debug functions" (591a9d7985c1230), application which includes rte_memory.h without stdio.h will be hit compilation failure: /path/to/include/rte_memory.h:146:30: error: unknown type name ‘FILE’ void rte_dump_physmem_layout(FILE *f); Signed-off-by: Hiroshi Shimamoto <h-shimamoto@ct.jp.nec.com> Reviewed-by: Hayato Momma <h-momma@ce.jp.nec.com> Acked-by: Thomas Monjalon <thomas.monjalon@6wind.com>
216 lines
6.2 KiB
C
216 lines
6.2 KiB
C
/*-
|
|
* BSD LICENSE
|
|
*
|
|
* Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
*
|
|
* * Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* * Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in
|
|
* the documentation and/or other materials provided with the
|
|
* distribution.
|
|
* * Neither the name of Intel Corporation nor the names of its
|
|
* contributors may be used to endorse or promote products derived
|
|
* from this software without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
#ifndef _RTE_MEMORY_H_
|
|
#define _RTE_MEMORY_H_
|
|
|
|
/**
|
|
* @file
|
|
*
|
|
* Memory-related RTE API.
|
|
*/
|
|
|
|
#include <stdint.h>
|
|
#include <stddef.h>
|
|
#include <stdio.h>
|
|
|
|
#ifdef RTE_EXEC_ENV_LINUXAPP
|
|
#include <exec-env/rte_dom0_common.h>
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
enum rte_page_sizes {
|
|
RTE_PGSIZE_4K = 1 << 12,
|
|
RTE_PGSIZE_2M = RTE_PGSIZE_4K << 9,
|
|
RTE_PGSIZE_1G = RTE_PGSIZE_2M <<9
|
|
};
|
|
|
|
#define SOCKET_ID_ANY -1 /**< Any NUMA socket. */
|
|
#ifndef CACHE_LINE_SIZE
|
|
#define CACHE_LINE_SIZE 64 /**< Cache line size. */
|
|
#endif
|
|
#define CACHE_LINE_MASK (CACHE_LINE_SIZE-1) /**< Cache line mask. */
|
|
|
|
#define CACHE_LINE_ROUNDUP(size) \
|
|
(CACHE_LINE_SIZE * ((size + CACHE_LINE_SIZE - 1) / CACHE_LINE_SIZE))
|
|
/**< Return the first cache-aligned value greater or equal to size. */
|
|
|
|
/**
|
|
* Force alignment to cache line.
|
|
*/
|
|
#define __rte_cache_aligned __attribute__((__aligned__(CACHE_LINE_SIZE)))
|
|
|
|
typedef uint64_t phys_addr_t; /**< Physical address definition. */
|
|
#define RTE_BAD_PHYS_ADDR ((phys_addr_t)-1)
|
|
|
|
/**
|
|
* Physical memory segment descriptor.
|
|
*/
|
|
struct rte_memseg {
|
|
phys_addr_t phys_addr; /**< Start physical address. */
|
|
union {
|
|
void *addr; /**< Start virtual address. */
|
|
uint64_t addr_64; /**< Makes sure addr is always 64 bits */
|
|
};
|
|
#ifdef RTE_LIBRTE_IVSHMEM
|
|
phys_addr_t ioremap_addr; /**< Real physical address inside the VM */
|
|
#endif
|
|
size_t len; /**< Length of the segment. */
|
|
size_t hugepage_sz; /**< The pagesize of underlying memory */
|
|
int32_t socket_id; /**< NUMA socket ID. */
|
|
uint32_t nchannel; /**< Number of channels. */
|
|
uint32_t nrank; /**< Number of ranks. */
|
|
#ifdef RTE_LIBRTE_XEN_DOM0
|
|
/**< store segment MFNs */
|
|
uint64_t mfn[DOM0_NUM_MEMBLOCK];
|
|
#endif
|
|
} __attribute__((__packed__));
|
|
|
|
/**
|
|
* Lock page in physical memory and prevent from swapping.
|
|
*
|
|
* @param virt
|
|
* The virtual address.
|
|
* @return
|
|
* 0 on success, negative on error.
|
|
*/
|
|
int rte_mem_lock_page(const void *virt);
|
|
|
|
/**
|
|
* Get physical address of any mapped virtual address in the current process.
|
|
* It is found by browsing the /proc/self/pagemap special file.
|
|
* The page must be locked.
|
|
*
|
|
* @param virt
|
|
* The virtual address.
|
|
* @return
|
|
* The physical address or RTE_BAD_PHYS_ADDR on error.
|
|
*/
|
|
phys_addr_t rte_mem_virt2phy(const void *virt);
|
|
|
|
/**
|
|
* Get the layout of the available physical memory.
|
|
*
|
|
* It can be useful for an application to have the full physical
|
|
* memory layout to decide the size of a memory zone to reserve. This
|
|
* table is stored in rte_config (see rte_eal_get_configuration()).
|
|
*
|
|
* @return
|
|
* - On success, return a pointer to a read-only table of struct
|
|
* rte_physmem_desc elements, containing the layout of all
|
|
* addressable physical memory. The last element of the table
|
|
* contains a NULL address.
|
|
* - On error, return NULL. This should not happen since it is a fatal
|
|
* error that will probably cause the entire system to panic.
|
|
*/
|
|
const struct rte_memseg *rte_eal_get_physmem_layout(void);
|
|
|
|
/**
|
|
* Dump the physical memory layout to the console.
|
|
*
|
|
* @param f
|
|
* A pointer to a file for output
|
|
*/
|
|
void rte_dump_physmem_layout(FILE *f);
|
|
|
|
/**
|
|
* Get the total amount of available physical memory.
|
|
*
|
|
* @return
|
|
* The total amount of available physical memory in bytes.
|
|
*/
|
|
uint64_t rte_eal_get_physmem_size(void);
|
|
|
|
/**
|
|
* Get the number of memory channels.
|
|
*
|
|
* @return
|
|
* The number of memory channels on the system. The value is 0 if unknown
|
|
* or not the same on all devices.
|
|
*/
|
|
unsigned rte_memory_get_nchannel(void);
|
|
|
|
/**
|
|
* Get the number of memory ranks.
|
|
*
|
|
* @return
|
|
* The number of memory ranks on the system. The value is 0 if unknown or
|
|
* not the same on all devices.
|
|
*/
|
|
unsigned rte_memory_get_nrank(void);
|
|
|
|
#ifdef RTE_LIBRTE_XEN_DOM0
|
|
/**
|
|
* Return the physical address of elt, which is an element of the pool mp.
|
|
*
|
|
* @param memseg_id
|
|
* The mempool is from which memory segment.
|
|
* @param phy_addr
|
|
* physical address of elt.
|
|
*
|
|
* @return
|
|
* The physical address or error.
|
|
*/
|
|
phys_addr_t rte_mem_phy2mch(uint32_t memseg_id, const phys_addr_t phy_addr);
|
|
|
|
/**
|
|
* Memory init for supporting application running on Xen domain0.
|
|
*
|
|
* @param void
|
|
*
|
|
* @return
|
|
* 0: successfully
|
|
* negative: error
|
|
*/
|
|
int rte_xen_dom0_memory_init(void);
|
|
|
|
/**
|
|
* Attach to memory setments of primary process on Xen domain0.
|
|
*
|
|
* @param void
|
|
*
|
|
* @return
|
|
* 0: successfully
|
|
* negative: error
|
|
*/
|
|
int rte_xen_dom0_memory_attach(void);
|
|
#endif
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* _RTE_MEMORY_H_ */
|