lib/librte_eal/common/include/rte_memory.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef _RTE_MEMORY_H_
  35 #define _RTE_MEMORY_H_
  36
  37 /**
  38  * @file
  39  *
  40  * Memory-related RTE API.
  41  */
  42
  43 #include <stdint.h>
  44 #include <stddef.h>
  45 #include <stdio.h>
  46
  47 #ifdef __cplusplus
  48 extern "C" {
  49 #endif
  50
  51 #include <rte_common.h>
  52
  53 __extension__
  54 enum rte_page_sizes {
  55         RTE_PGSIZE_4K    = 1ULL << 12,
  56         RTE_PGSIZE_64K   = 1ULL << 16,
  57         RTE_PGSIZE_256K  = 1ULL << 18,
  58         RTE_PGSIZE_2M    = 1ULL << 21,
  59         RTE_PGSIZE_16M   = 1ULL << 24,
  60         RTE_PGSIZE_256M  = 1ULL << 28,
  61         RTE_PGSIZE_512M  = 1ULL << 29,
  62         RTE_PGSIZE_1G    = 1ULL << 30,
  63         RTE_PGSIZE_4G    = 1ULL << 32,
  64         RTE_PGSIZE_16G   = 1ULL << 34,
  65 };
  66
  67 #define SOCKET_ID_ANY -1                    /**< Any NUMA socket. */
  68 #define RTE_CACHE_LINE_MASK (RTE_CACHE_LINE_SIZE-1) /**< Cache line mask. */
  69
  70 #define RTE_CACHE_LINE_ROUNDUP(size) \
  71         (RTE_CACHE_LINE_SIZE * ((size + RTE_CACHE_LINE_SIZE - 1) / RTE_CACHE_LINE_SIZE))
  72 /**< Return the first cache-aligned value greater or equal to size. */
  73
  74 /**< Cache line size in terms of log2 */
  75 #if RTE_CACHE_LINE_SIZE == 64
  76 #define RTE_CACHE_LINE_SIZE_LOG2 6
  77 #elif RTE_CACHE_LINE_SIZE == 128
  78 #define RTE_CACHE_LINE_SIZE_LOG2 7
  79 #else
  80 #error "Unsupported cache line size"
  81 #endif
  82
  83 #define RTE_CACHE_LINE_MIN_SIZE 64      /**< Minimum Cache line size. */
  84
  85 /**
  86  * Force alignment to cache line.
  87  */
  88 #define __rte_cache_aligned __rte_aligned(RTE_CACHE_LINE_SIZE)
  89
  90 /**
  91  * Force minimum cache line alignment.
  92  */
  93 #define __rte_cache_min_aligned __rte_aligned(RTE_CACHE_LINE_MIN_SIZE)
  94
  95 typedef uint64_t phys_addr_t; /**< Physical address. */
  96 #define RTE_BAD_PHYS_ADDR ((phys_addr_t)-1)
  97 /**
  98  * IO virtual address type.
  99  * When the physical addressing mode (IOVA as PA) is in use,
 100  * the translation from an IO virtual address (IOVA) to a physical address
 101  * is a direct mapping, i.e. the same value.
 102  * Otherwise, in virtual mode (IOVA as VA), an IOMMU may do the translation.
 103  */
 104 typedef uint64_t rte_iova_t;
 105 #define RTE_BAD_IOVA ((rte_iova_t)-1)
 106
 107 /**
 108  * Physical memory segment descriptor.
 109  */
 110 struct rte_memseg {
 111         phys_addr_t phys_addr;      /**< Start physical address. */
 112         RTE_STD_C11
 113         union {
 114                 void *addr;         /**< Start virtual address. */
 115                 uint64_t addr_64;   /**< Makes sure addr is always 64 bits */
 116         };
 117         size_t len;               /**< Length of the segment. */
 118         uint64_t hugepage_sz;       /**< The pagesize of underlying memory */
 119         int32_t socket_id;          /**< NUMA socket ID. */
 120         uint32_t nchannel;          /**< Number of channels. */
 121         uint32_t nrank;             /**< Number of ranks. */
 122 } __rte_packed;
 123
 124 /**
 125  * Lock page in physical memory and prevent from swapping.
 126  *
 127  * @param virt
 128  *   The virtual address.
 129  * @return
 130  *   0 on success, negative on error.
 131  */
 132 int rte_mem_lock_page(const void *virt);
 133
 134 /**
 135  * Get physical address of any mapped virtual address in the current process.
 136  * It is found by browsing the /proc/self/pagemap special file.
 137  * The page must be locked.
 138  *
 139  * @param virt
 140  *   The virtual address.
 141  * @return
 142  *   The physical address or RTE_BAD_PHYS_ADDR on error.
 143  */
 144 phys_addr_t rte_mem_virt2phy(const void *virt);
 145
 146 /**
 147  * Get the layout of the available physical memory.
 148  *
 149  * It can be useful for an application to have the full physical
 150  * memory layout to decide the size of a memory zone to reserve. This
 151  * table is stored in rte_config (see rte_eal_get_configuration()).
 152  *
 153  * @return
 154  *  - On success, return a pointer to a read-only table of struct
 155  *    rte_physmem_desc elements, containing the layout of all
 156  *    addressable physical memory. The last element of the table
 157  *    contains a NULL address.
 158  *  - On error, return NULL. This should not happen since it is a fatal
 159  *    error that will probably cause the entire system to panic.
 160  */
 161 const struct rte_memseg *rte_eal_get_physmem_layout(void);
 162
 163 /**
 164  * Dump the physical memory layout to a file.
 165  *
 166  * @param f
 167  *   A pointer to a file for output
 168  */
 169 void rte_dump_physmem_layout(FILE *f);
 170
 171 /**
 172  * Get the total amount of available physical memory.
 173  *
 174  * @return
 175  *    The total amount of available physical memory in bytes.
 176  */
 177 uint64_t rte_eal_get_physmem_size(void);
 178
 179 /**
 180  * Get the number of memory channels.
 181  *
 182  * @return
 183  *   The number of memory channels on the system. The value is 0 if unknown
 184  *   or not the same on all devices.
 185  */
 186 unsigned rte_memory_get_nchannel(void);
 187
 188 /**
 189  * Get the number of memory ranks.
 190  *
 191  * @return
 192  *   The number of memory ranks on the system. The value is 0 if unknown or
 193  *   not the same on all devices.
 194  */
 195 unsigned rte_memory_get_nrank(void);
 196
 197 /**
 198  * Drivers based on uio will not load unless physical
 199  * addresses are obtainable. It is only possible to get
 200  * physical addresses when running as a privileged user.
 201  *
 202  * @return
 203  *   1 if the system is able to obtain physical addresses.
 204  *   0 if using DMA addresses through an IOMMU.
 205  */
 206 int rte_eal_using_phys_addrs(void);
 207
 208 #ifdef __cplusplus
 209 }
 210 #endif
 211
 212 #endif /* _RTE_MEMORY_H_ */