lib/librte_eal/common/include/rte_memory.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2012 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
  35 #ifndef _RTE_MEMORY_H_
  36 #define _RTE_MEMORY_H_
  37
  38 /**
  39  * @file
  40  *
  41  * Memory-related RTE API.
  42  */
  43
  44 #include <stdint.h>
  45
  46 #ifdef __cplusplus
  47 extern "C" {
  48 #endif
  49
  50 enum rte_page_sizes {
  51         RTE_PGSIZE_4K = 1 << 12,
  52         RTE_PGSIZE_2M = RTE_PGSIZE_4K << 9,
  53         RTE_PGSIZE_1G = RTE_PGSIZE_2M <<9
  54 };
  55
  56 #define SOCKET_ID_ANY -1                    /**< Any NUMA socket. */
  57 #define CACHE_LINE_SIZE 64                  /**< Cache line size. */
  58 #define CACHE_LINE_MASK (CACHE_LINE_SIZE-1) /**< Cache line mask. */
  59
  60 #define CACHE_LINE_ROUNDUP(size) \
  61         (CACHE_LINE_SIZE * ((size + CACHE_LINE_SIZE - 1) / CACHE_LINE_SIZE))
  62 /**< Return the first cache-aligned value greater or equal to size. */
  63
  64 /**
  65  * Force alignment to cache line.
  66  */
  67 #define __rte_cache_aligned __attribute__((__aligned__(CACHE_LINE_SIZE)))
  68
  69 #ifndef __KERNEL__ /* so we can include this header in kernel modules */
  70 typedef uint64_t phys_addr_t; /**< Physical address definition. */
  71 #endif
  72
  73 /**
  74  * Physical memory segment descriptor.
  75  */
  76 struct rte_memseg {
  77         phys_addr_t phys_addr;      /**< Start physical address. */
  78         union {
  79                 void *addr;         /**< Start virtual address. */
  80                 uint64_t addr_64;   /**< Makes sure addr is always 64 bits */
  81         };
  82         uint64_t len;               /**< Length of the segment. */
  83         uint64_t hugepage_sz;       /**< The pagesize of underlying memory */
  84         int32_t socket_id;          /**< NUMA socket ID. */
  85         uint32_t nchannel;          /**< Number of channels. */
  86         uint32_t nrank;             /**< Number of ranks. */
  87 } __attribute__((__packed__));
  88
  89
  90 /**
  91  * Get the layout of the available physical memory.
  92  *
  93  * It can be useful for an application to have the full physical
  94  * memory layout to decide the size of a memory zone to reserve. This
  95  * table is stored in rte_config (see rte_eal_get_configuration()).
  96  *
  97  * @return
  98  *  - On success, return a pointer to a read-only table of struct
  99  *    rte_physmem_desc elements, containing the layout of all
 100  *    addressable physical memory. The last element of the table
 101  *    contains a NULL address.
 102  *  - On error, return NULL. This should not happen since it is a fatal
 103  *    error that will probably cause the entire system to panic.
 104  */
 105 const struct rte_memseg *rte_eal_get_physmem_layout(void);
 106
 107 /**
 108  * Dump the physical memory layout to the console.
 109  */
 110 void rte_dump_physmem_layout(void);
 111
 112 /**
 113  * Get the total amount of available physical memory.
 114  *
 115  * @return
 116  *    The total amount of available physical memory in bytes.
 117  */
 118 uint64_t rte_eal_get_physmem_size(void);
 119
 120 /**
 121  * Get the number of memory channels.
 122  *
 123  * @return
 124  *   The number of memory channels on the system. The value is 0 if unknown
 125  *   or not the same on all devices.
 126  */
 127 unsigned rte_memory_get_nchannel(void);
 128
 129 /**
 130  * Get the number of memory ranks.
 131  *
 132  * @return
 133  *   The number of memory ranks on the system. The value is 0 if unknown or
 134  *   not the same on all devices.
 135  */
 136 unsigned rte_memory_get_nrank(void);
 137
 138 #ifdef __cplusplus
 139 }
 140 #endif
 141
 142 #endif /* _RTE_MEMORY_H_ */