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         RTE_STD_C11
 112         union {
 113                 phys_addr_t phys_addr;  /**< deprecated - Start physical address. */
 114                 rte_iova_t iova;        /**< Start IO address. */
 115         };
 116         RTE_STD_C11
 117         union {
 118                 void *addr;         /**< Start virtual address. */
 119                 uint64_t addr_64;   /**< Makes sure addr is always 64 bits */
 120         };
 121         size_t len;               /**< Length of the segment. */
 122         uint64_t hugepage_sz;       /**< The pagesize of underlying memory */
 123         int32_t socket_id;          /**< NUMA socket ID. */
 124         uint32_t nchannel;          /**< Number of channels. */
 125         uint32_t nrank;             /**< Number of ranks. */
 126 } __rte_packed;
 127
 128 /**
 129  * Lock page in physical memory and prevent from swapping.
 130  *
 131  * @param virt
 132  *   The virtual address.
 133  * @return
 134  *   0 on success, negative on error.
 135  */
 136 int rte_mem_lock_page(const void *virt);
 137
 138 /**
 139  * Get physical address of any mapped virtual address in the current process.
 140  * It is found by browsing the /proc/self/pagemap special file.
 141  * The page must be locked.
 142  *
 143  * @param virt
 144  *   The virtual address.
 145  * @return
 146  *   The physical address or RTE_BAD_IOVA on error.
 147  */
 148 phys_addr_t rte_mem_virt2phy(const void *virt);
 149
 150 /**
 151  * Get the layout of the available physical memory.
 152  *
 153  * It can be useful for an application to have the full physical
 154  * memory layout to decide the size of a memory zone to reserve. This
 155  * table is stored in rte_config (see rte_eal_get_configuration()).
 156  *
 157  * @return
 158  *  - On success, return a pointer to a read-only table of struct
 159  *    rte_physmem_desc elements, containing the layout of all
 160  *    addressable physical memory. The last element of the table
 161  *    contains a NULL address.
 162  *  - On error, return NULL. This should not happen since it is a fatal
 163  *    error that will probably cause the entire system to panic.
 164  */
 165 const struct rte_memseg *rte_eal_get_physmem_layout(void);
 166
 167 /**
 168  * Dump the physical memory layout to a file.
 169  *
 170  * @param f
 171  *   A pointer to a file for output
 172  */
 173 void rte_dump_physmem_layout(FILE *f);
 174
 175 /**
 176  * Get the total amount of available physical memory.
 177  *
 178  * @return
 179  *    The total amount of available physical memory in bytes.
 180  */
 181 uint64_t rte_eal_get_physmem_size(void);
 182
 183 /**
 184  * Get the number of memory channels.
 185  *
 186  * @return
 187  *   The number of memory channels on the system. The value is 0 if unknown
 188  *   or not the same on all devices.
 189  */
 190 unsigned rte_memory_get_nchannel(void);
 191
 192 /**
 193  * Get the number of memory ranks.
 194  *
 195  * @return
 196  *   The number of memory ranks on the system. The value is 0 if unknown or
 197  *   not the same on all devices.
 198  */
 199 unsigned rte_memory_get_nrank(void);
 200
 201 /**
 202  * Drivers based on uio will not load unless physical
 203  * addresses are obtainable. It is only possible to get
 204  * physical addresses when running as a privileged user.
 205  *
 206  * @return
 207  *   1 if the system is able to obtain physical addresses.
 208  *   0 if using DMA addresses through an IOMMU.
 209  */
 210 int rte_eal_using_phys_addrs(void);
 211
 212 #ifdef __cplusplus
 213 }
 214 #endif
 215
 216 #endif /* _RTE_MEMORY_H_ */