4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
5 * Copyright(c) 2013 6WIND.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * * Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the
18 * * Neither the name of Intel Corporation nor the names of its
19 * contributors may be used to endorse or promote products derived
20 * from this software without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 #define _FILE_OFFSET_BITS 64
45 #include <sys/types.h>
47 #include <sys/queue.h>
51 #include <sys/ioctl.h>
55 #ifdef RTE_EAL_NUMA_AWARE_HUGEPAGES
61 #include <rte_memory.h>
62 #include <rte_launch.h>
64 #include <rte_eal_memconfig.h>
65 #include <rte_per_lcore.h>
66 #include <rte_lcore.h>
67 #include <rte_common.h>
68 #include <rte_string_fns.h>
70 #include "eal_private.h"
71 #include "eal_internal_cfg.h"
72 #include "eal_filesystem.h"
73 #include "eal_hugepages.h"
75 #define PFN_MASK_SIZE 8
79 * Huge page mapping under linux
81 * To reserve a big contiguous amount of memory, we use the hugepage
82 * feature of linux. For that, we need to have hugetlbfs mounted. This
83 * code will create many files in this directory (one per page) and
84 * map them in virtual memory. For each page, we will retrieve its
85 * physical address and remap it in order to have a virtual contiguous
86 * zone as well as a physical contiguous zone.
89 static uint64_t baseaddr_offset;
93 * Linux kernel uses a really high address as starting address for serving
94 * mmaps calls. If there exists addressing limitations and IOVA mode is VA,
95 * this starting address is likely too high for those devices. However, it
96 * is possible to use a lower address in the process virtual address space
97 * as with 64 bits there is a lot of available space.
99 * Current known limitations are 39 or 40 bits. Setting the starting address
100 * at 4GB implies there are 508GB or 1020GB for mapping the available
101 * hugepages. This is likely enough for most systems, although a device with
102 * addressing limitations should call rte_dev_check_dma_mask for ensuring all
103 * memory is within supported range.
105 static uint64_t baseaddr = 0x100000000;
108 static bool phys_addrs_available = true;
110 #define RANDOMIZE_VA_SPACE_FILE "/proc/sys/kernel/randomize_va_space"
113 test_phys_addrs_available(void)
116 phys_addr_t physaddr;
118 if (!rte_eal_has_hugepages()) {
120 "Started without hugepages support, physical addresses not available\n");
121 phys_addrs_available = false;
125 physaddr = rte_mem_virt2phy(&tmp);
126 if (physaddr == RTE_BAD_PHYS_ADDR) {
127 if (rte_eal_iova_mode() == RTE_IOVA_PA)
129 "Cannot obtain physical addresses: %s. "
130 "Only vfio will function.\n",
132 phys_addrs_available = false;
137 * Get physical address of any mapped virtual address in the current process.
140 rte_mem_virt2phy(const void *virtaddr)
143 uint64_t page, physaddr;
144 unsigned long virt_pfn;
148 /* Cannot parse /proc/self/pagemap, no need to log errors everywhere */
149 if (!phys_addrs_available)
152 /* standard page size */
153 page_size = getpagesize();
155 fd = open("/proc/self/pagemap", O_RDONLY);
157 RTE_LOG(ERR, EAL, "%s(): cannot open /proc/self/pagemap: %s\n",
158 __func__, strerror(errno));
162 virt_pfn = (unsigned long)virtaddr / page_size;
163 offset = sizeof(uint64_t) * virt_pfn;
164 if (lseek(fd, offset, SEEK_SET) == (off_t) -1) {
165 RTE_LOG(ERR, EAL, "%s(): seek error in /proc/self/pagemap: %s\n",
166 __func__, strerror(errno));
171 retval = read(fd, &page, PFN_MASK_SIZE);
174 RTE_LOG(ERR, EAL, "%s(): cannot read /proc/self/pagemap: %s\n",
175 __func__, strerror(errno));
177 } else if (retval != PFN_MASK_SIZE) {
178 RTE_LOG(ERR, EAL, "%s(): read %d bytes from /proc/self/pagemap "
179 "but expected %d:\n",
180 __func__, retval, PFN_MASK_SIZE);
185 * the pfn (page frame number) are bits 0-54 (see
186 * pagemap.txt in linux Documentation)
188 if ((page & 0x7fffffffffffffULL) == 0)
191 physaddr = ((page & 0x7fffffffffffffULL) * page_size)
192 + ((unsigned long)virtaddr % page_size);
198 rte_mem_virt2iova(const void *virtaddr)
200 if (rte_eal_iova_mode() == RTE_IOVA_VA)
201 return (uintptr_t)virtaddr;
202 return rte_mem_virt2phy(virtaddr);
206 * For each hugepage in hugepg_tbl, fill the physaddr value. We find
207 * it by browsing the /proc/self/pagemap special file.
210 find_physaddrs(struct hugepage_file *hugepg_tbl, struct hugepage_info *hpi)
215 for (i = 0; i < hpi->num_pages[0]; i++) {
216 addr = rte_mem_virt2phy(hugepg_tbl[i].orig_va);
217 if (addr == RTE_BAD_PHYS_ADDR)
219 hugepg_tbl[i].physaddr = addr;
225 * For each hugepage in hugepg_tbl, fill the physaddr value sequentially.
228 set_physaddrs(struct hugepage_file *hugepg_tbl, struct hugepage_info *hpi)
231 static phys_addr_t addr;
233 for (i = 0; i < hpi->num_pages[0]; i++) {
234 hugepg_tbl[i].physaddr = addr;
235 addr += hugepg_tbl[i].size;
241 * Check whether address-space layout randomization is enabled in
242 * the kernel. This is important for multi-process as it can prevent
243 * two processes mapping data to the same virtual address
245 * 0 - address space randomization disabled
246 * 1/2 - address space randomization enabled
247 * negative error code on error
253 int retval, fd = open(RANDOMIZE_VA_SPACE_FILE, O_RDONLY);
256 retval = read(fd, &c, 1);
266 default: return -EINVAL;
273 if (internal_config.base_virtaddr != 0) {
274 return (void *) (uintptr_t)
275 (internal_config.base_virtaddr +
279 return (void *) (uintptr_t) (baseaddr +
288 * Try to mmap *size bytes in /dev/zero. If it is successful, return the
289 * pointer to the mmap'd area and keep *size unmodified. Else, retry
290 * with a smaller zone: decrease *size by hugepage_sz until it reaches
291 * 0. In this case, return NULL. Note: this function returns an address
292 * which is a multiple of hugepage size.
295 get_virtual_area(size_t *size, size_t hugepage_sz)
297 void *addr, *addr_hint;
301 RTE_LOG(DEBUG, EAL, "Ask a virtual area of 0x%zx bytes\n", *size);
303 fd = open("/dev/zero", O_RDONLY);
305 RTE_LOG(ERR, EAL, "Cannot open /dev/zero\n");
309 addr_hint = get_addr_hint();
311 addr = mmap(addr_hint,
312 (*size) + hugepage_sz, PROT_READ,
313 #ifdef RTE_ARCH_PPC_64
314 MAP_PRIVATE | MAP_ANONYMOUS | MAP_HUGETLB,
319 if (addr == MAP_FAILED) {
320 /* map failed. Let's try with less memory */
321 *size -= hugepage_sz;
322 } else if (addr_hint && addr != addr_hint) {
323 /* hint was not used. Try with another offset */
324 munmap(addr, (*size) + hugepage_sz);
326 baseaddr_offset += 0x100000000;
328 } while (addr == MAP_FAILED && *size > 0);
330 if (addr == MAP_FAILED) {
332 RTE_LOG(ERR, EAL, "Cannot get a virtual area: %s\n",
337 munmap(addr, (*size) + hugepage_sz);
340 /* align addr to a huge page size boundary */
341 aligned_addr = (long)addr;
342 aligned_addr += (hugepage_sz - 1);
343 aligned_addr &= (~(hugepage_sz - 1));
344 addr = (void *)(aligned_addr);
346 RTE_LOG(DEBUG, EAL, "Virtual area found at %p (size = 0x%zx)\n",
349 /* increment offset */
350 baseaddr_offset += *size;
355 static sigjmp_buf huge_jmpenv;
357 static void huge_sigbus_handler(int signo __rte_unused)
359 siglongjmp(huge_jmpenv, 1);
362 /* Put setjmp into a wrap method to avoid compiling error. Any non-volatile,
363 * non-static local variable in the stack frame calling sigsetjmp might be
364 * clobbered by a call to longjmp.
366 static int huge_wrap_sigsetjmp(void)
368 return sigsetjmp(huge_jmpenv, 1);
371 #ifdef RTE_EAL_NUMA_AWARE_HUGEPAGES
372 /* Callback for numa library. */
373 void numa_error(char *where)
375 RTE_LOG(ERR, EAL, "%s failed: %s\n", where, strerror(errno));
380 * Mmap all hugepages of hugepage table: it first open a file in
381 * hugetlbfs, then mmap() hugepage_sz data in it. If orig is set, the
382 * virtual address is stored in hugepg_tbl[i].orig_va, else it is stored
383 * in hugepg_tbl[i].final_va. The second mapping (when orig is 0) tries to
384 * map contiguous physical blocks in contiguous virtual blocks.
387 map_all_hugepages(struct hugepage_file *hugepg_tbl, struct hugepage_info *hpi,
388 uint64_t *essential_memory __rte_unused, int orig)
393 void *vma_addr = NULL;
395 #ifdef RTE_EAL_NUMA_AWARE_HUGEPAGES
397 int essential_prev = 0;
399 struct bitmask *oldmask = numa_allocate_nodemask();
400 bool have_numa = true;
401 unsigned long maxnode = 0;
403 /* Check if kernel supports NUMA. */
404 if (numa_available() != 0) {
405 RTE_LOG(DEBUG, EAL, "NUMA is not supported.\n");
409 if (orig && have_numa) {
410 RTE_LOG(DEBUG, EAL, "Trying to obtain current memory policy.\n");
411 if (get_mempolicy(&oldpolicy, oldmask->maskp,
412 oldmask->size + 1, 0, 0) < 0) {
414 "Failed to get current mempolicy: %s. "
415 "Assuming MPOL_DEFAULT.\n", strerror(errno));
416 oldpolicy = MPOL_DEFAULT;
418 for (i = 0; i < RTE_MAX_NUMA_NODES; i++)
419 if (internal_config.socket_mem[i])
424 for (i = 0; i < hpi->num_pages[0]; i++) {
425 uint64_t hugepage_sz = hpi->hugepage_sz;
427 #ifdef RTE_EAL_NUMA_AWARE_HUGEPAGES
431 for (j = 0; j < maxnode; j++)
432 if (essential_memory[j])
436 node_id = (node_id + 1) % maxnode;
437 while (!internal_config.socket_mem[node_id]) {
444 essential_prev = essential_memory[j];
446 if (essential_memory[j] < hugepage_sz)
447 essential_memory[j] = 0;
449 essential_memory[j] -= hugepage_sz;
453 "Setting policy MPOL_PREFERRED for socket %d\n",
455 numa_set_preferred(node_id);
460 hugepg_tbl[i].file_id = i;
461 hugepg_tbl[i].size = hugepage_sz;
462 eal_get_hugefile_path(hugepg_tbl[i].filepath,
463 sizeof(hugepg_tbl[i].filepath), hpi->hugedir,
464 hugepg_tbl[i].file_id);
465 hugepg_tbl[i].filepath[sizeof(hugepg_tbl[i].filepath) - 1] = '\0';
468 /* for 32-bit systems, don't remap 1G and 16G pages, just reuse
469 * original map address as final map address.
471 else if ((hugepage_sz == RTE_PGSIZE_1G)
472 || (hugepage_sz == RTE_PGSIZE_16G)) {
473 hugepg_tbl[i].final_va = hugepg_tbl[i].orig_va;
474 hugepg_tbl[i].orig_va = NULL;
478 else if (vma_len == 0) {
479 unsigned j, num_pages;
481 /* reserve a virtual area for next contiguous
482 * physical block: count the number of
483 * contiguous physical pages. */
484 for (j = i+1; j < hpi->num_pages[0] ; j++) {
485 #ifdef RTE_ARCH_PPC_64
486 /* The physical addresses are sorted in
487 * descending order on PPC64 */
488 if (hugepg_tbl[j].physaddr !=
489 hugepg_tbl[j-1].physaddr - hugepage_sz)
492 if (hugepg_tbl[j].physaddr !=
493 hugepg_tbl[j-1].physaddr + hugepage_sz)
498 vma_len = num_pages * hugepage_sz;
500 /* get the biggest virtual memory area up to
501 * vma_len. If it fails, vma_addr is NULL, so
502 * let the kernel provide the address. */
503 vma_addr = get_virtual_area(&vma_len, hpi->hugepage_sz);
504 if (vma_addr == NULL)
505 vma_len = hugepage_sz;
508 /* try to create hugepage file */
509 fd = open(hugepg_tbl[i].filepath, O_CREAT | O_RDWR, 0600);
511 RTE_LOG(DEBUG, EAL, "%s(): open failed: %s\n", __func__,
516 /* map the segment, and populate page tables,
517 * the kernel fills this segment with zeros */
518 virtaddr = mmap(vma_addr, hugepage_sz, PROT_READ | PROT_WRITE,
519 MAP_SHARED | MAP_POPULATE, fd, 0);
520 if (virtaddr == MAP_FAILED) {
521 RTE_LOG(DEBUG, EAL, "%s(): mmap failed: %s\n", __func__,
528 hugepg_tbl[i].orig_va = virtaddr;
531 /* rewrite physical addresses in IOVA as VA mode */
532 if (rte_eal_iova_mode() == RTE_IOVA_VA)
533 hugepg_tbl[i].physaddr = (uintptr_t)virtaddr;
534 hugepg_tbl[i].final_va = virtaddr;
538 /* In linux, hugetlb limitations, like cgroup, are
539 * enforced at fault time instead of mmap(), even
540 * with the option of MAP_POPULATE. Kernel will send
541 * a SIGBUS signal. To avoid to be killed, save stack
542 * environment here, if SIGBUS happens, we can jump
545 if (huge_wrap_sigsetjmp()) {
546 RTE_LOG(DEBUG, EAL, "SIGBUS: Cannot mmap more "
547 "hugepages of size %u MB\n",
548 (unsigned)(hugepage_sz / 0x100000));
549 munmap(virtaddr, hugepage_sz);
551 unlink(hugepg_tbl[i].filepath);
552 #ifdef RTE_EAL_NUMA_AWARE_HUGEPAGES
554 essential_memory[node_id] =
559 *(int *)virtaddr = 0;
563 /* set shared flock on the file. */
564 if (flock(fd, LOCK_SH | LOCK_NB) == -1) {
565 RTE_LOG(DEBUG, EAL, "%s(): Locking file failed:%s \n",
566 __func__, strerror(errno));
573 vma_addr = (char *)vma_addr + hugepage_sz;
574 vma_len -= hugepage_sz;
578 #ifdef RTE_EAL_NUMA_AWARE_HUGEPAGES
581 "Restoring previous memory policy: %d\n", oldpolicy);
582 if (oldpolicy == MPOL_DEFAULT) {
583 numa_set_localalloc();
584 } else if (set_mempolicy(oldpolicy, oldmask->maskp,
585 oldmask->size + 1) < 0) {
586 RTE_LOG(ERR, EAL, "Failed to restore mempolicy: %s\n",
588 numa_set_localalloc();
591 numa_free_cpumask(oldmask);
596 /* Unmap all hugepages from original mapping */
598 unmap_all_hugepages_orig(struct hugepage_file *hugepg_tbl, struct hugepage_info *hpi)
601 for (i = 0; i < hpi->num_pages[0]; i++) {
602 if (hugepg_tbl[i].orig_va) {
603 munmap(hugepg_tbl[i].orig_va, hpi->hugepage_sz);
604 hugepg_tbl[i].orig_va = NULL;
611 * Parse /proc/self/numa_maps to get the NUMA socket ID for each huge
615 find_numasocket(struct hugepage_file *hugepg_tbl, struct hugepage_info *hpi)
619 unsigned i, hp_count = 0;
622 char hugedir_str[PATH_MAX];
625 f = fopen("/proc/self/numa_maps", "r");
627 RTE_LOG(NOTICE, EAL, "NUMA support not available"
628 " consider that all memory is in socket_id 0\n");
632 snprintf(hugedir_str, sizeof(hugedir_str),
633 "%s/%s", hpi->hugedir, internal_config.hugefile_prefix);
636 while (fgets(buf, sizeof(buf), f) != NULL) {
638 /* ignore non huge page */
639 if (strstr(buf, " huge ") == NULL &&
640 strstr(buf, hugedir_str) == NULL)
644 virt_addr = strtoull(buf, &end, 16);
645 if (virt_addr == 0 || end == buf) {
646 RTE_LOG(ERR, EAL, "%s(): error in numa_maps parsing\n", __func__);
650 /* get node id (socket id) */
651 nodestr = strstr(buf, " N");
652 if (nodestr == NULL) {
653 RTE_LOG(ERR, EAL, "%s(): error in numa_maps parsing\n", __func__);
657 end = strstr(nodestr, "=");
659 RTE_LOG(ERR, EAL, "%s(): error in numa_maps parsing\n", __func__);
665 socket_id = strtoul(nodestr, &end, 0);
666 if ((nodestr[0] == '\0') || (end == NULL) || (*end != '\0')) {
667 RTE_LOG(ERR, EAL, "%s(): error in numa_maps parsing\n", __func__);
671 /* if we find this page in our mappings, set socket_id */
672 for (i = 0; i < hpi->num_pages[0]; i++) {
673 void *va = (void *)(unsigned long)virt_addr;
674 if (hugepg_tbl[i].orig_va == va) {
675 hugepg_tbl[i].socket_id = socket_id;
677 #ifdef RTE_EAL_NUMA_AWARE_HUGEPAGES
679 "Hugepage %s is on socket %d\n",
680 hugepg_tbl[i].filepath, socket_id);
686 if (hp_count < hpi->num_pages[0])
698 cmp_physaddr(const void *a, const void *b)
700 #ifndef RTE_ARCH_PPC_64
701 const struct hugepage_file *p1 = a;
702 const struct hugepage_file *p2 = b;
704 /* PowerPC needs memory sorted in reverse order from x86 */
705 const struct hugepage_file *p1 = b;
706 const struct hugepage_file *p2 = a;
708 if (p1->physaddr < p2->physaddr)
710 else if (p1->physaddr > p2->physaddr)
717 * Uses mmap to create a shared memory area for storage of data
718 * Used in this file to store the hugepage file map on disk
721 create_shared_memory(const char *filename, const size_t mem_size)
724 int fd = open(filename, O_CREAT | O_RDWR, 0666);
727 if (ftruncate(fd, mem_size) < 0) {
731 retval = mmap(NULL, mem_size, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0);
733 if (retval == MAP_FAILED)
739 * this copies *active* hugepages from one hugepage table to another.
740 * destination is typically the shared memory.
743 copy_hugepages_to_shared_mem(struct hugepage_file * dst, int dest_size,
744 const struct hugepage_file * src, int src_size)
746 int src_pos, dst_pos = 0;
748 for (src_pos = 0; src_pos < src_size; src_pos++) {
749 if (src[src_pos].final_va != NULL) {
750 /* error on overflow attempt */
751 if (dst_pos == dest_size)
753 memcpy(&dst[dst_pos], &src[src_pos], sizeof(struct hugepage_file));
761 unlink_hugepage_files(struct hugepage_file *hugepg_tbl,
762 unsigned num_hp_info)
764 unsigned socket, size;
765 int page, nrpages = 0;
767 /* get total number of hugepages */
768 for (size = 0; size < num_hp_info; size++)
769 for (socket = 0; socket < RTE_MAX_NUMA_NODES; socket++)
771 internal_config.hugepage_info[size].num_pages[socket];
773 for (page = 0; page < nrpages; page++) {
774 struct hugepage_file *hp = &hugepg_tbl[page];
776 if (hp->final_va != NULL && unlink(hp->filepath)) {
777 RTE_LOG(WARNING, EAL, "%s(): Removing %s failed: %s\n",
778 __func__, hp->filepath, strerror(errno));
785 * unmaps hugepages that are not going to be used. since we originally allocate
786 * ALL hugepages (not just those we need), additional unmapping needs to be done.
789 unmap_unneeded_hugepages(struct hugepage_file *hugepg_tbl,
790 struct hugepage_info *hpi,
791 unsigned num_hp_info)
793 unsigned socket, size;
794 int page, nrpages = 0;
796 /* get total number of hugepages */
797 for (size = 0; size < num_hp_info; size++)
798 for (socket = 0; socket < RTE_MAX_NUMA_NODES; socket++)
799 nrpages += internal_config.hugepage_info[size].num_pages[socket];
801 for (size = 0; size < num_hp_info; size++) {
802 for (socket = 0; socket < RTE_MAX_NUMA_NODES; socket++) {
803 unsigned pages_found = 0;
805 /* traverse until we have unmapped all the unused pages */
806 for (page = 0; page < nrpages; page++) {
807 struct hugepage_file *hp = &hugepg_tbl[page];
809 /* find a page that matches the criteria */
810 if ((hp->size == hpi[size].hugepage_sz) &&
811 (hp->socket_id == (int) socket)) {
813 /* if we skipped enough pages, unmap the rest */
814 if (pages_found == hpi[size].num_pages[socket]) {
817 unmap_len = hp->size;
819 /* get start addr and len of the remaining segment */
820 munmap(hp->final_va, (size_t) unmap_len);
823 if (unlink(hp->filepath) == -1) {
824 RTE_LOG(ERR, EAL, "%s(): Removing %s failed: %s\n",
825 __func__, hp->filepath, strerror(errno));
829 /* lock the page and skip */
835 } /* foreach socket */
836 } /* foreach pagesize */
841 static inline uint64_t
842 get_socket_mem_size(int socket)
847 for (i = 0; i < internal_config.num_hugepage_sizes; i++){
848 struct hugepage_info *hpi = &internal_config.hugepage_info[i];
849 if (hpi->hugedir != NULL)
850 size += hpi->hugepage_sz * hpi->num_pages[socket];
857 * This function is a NUMA-aware equivalent of calc_num_pages.
858 * It takes in the list of hugepage sizes and the
859 * number of pages thereof, and calculates the best number of
860 * pages of each size to fulfill the request for <memory> ram
863 calc_num_pages_per_socket(uint64_t * memory,
864 struct hugepage_info *hp_info,
865 struct hugepage_info *hp_used,
866 unsigned num_hp_info)
868 unsigned socket, j, i = 0;
869 unsigned requested, available;
870 int total_num_pages = 0;
871 uint64_t remaining_mem, cur_mem;
872 uint64_t total_mem = internal_config.memory;
874 if (num_hp_info == 0)
877 /* if specific memory amounts per socket weren't requested */
878 if (internal_config.force_sockets == 0) {
879 int cpu_per_socket[RTE_MAX_NUMA_NODES];
880 size_t default_size, total_size;
883 /* Compute number of cores per socket */
884 memset(cpu_per_socket, 0, sizeof(cpu_per_socket));
885 RTE_LCORE_FOREACH(lcore_id) {
886 cpu_per_socket[rte_lcore_to_socket_id(lcore_id)]++;
890 * Automatically spread requested memory amongst detected sockets according
891 * to number of cores from cpu mask present on each socket
893 total_size = internal_config.memory;
894 for (socket = 0; socket < RTE_MAX_NUMA_NODES && total_size != 0; socket++) {
896 /* Set memory amount per socket */
897 default_size = (internal_config.memory * cpu_per_socket[socket])
900 /* Limit to maximum available memory on socket */
901 default_size = RTE_MIN(default_size, get_socket_mem_size(socket));
904 memory[socket] = default_size;
905 total_size -= default_size;
909 * If some memory is remaining, try to allocate it by getting all
910 * available memory from sockets, one after the other
912 for (socket = 0; socket < RTE_MAX_NUMA_NODES && total_size != 0; socket++) {
913 /* take whatever is available */
914 default_size = RTE_MIN(get_socket_mem_size(socket) - memory[socket],
918 memory[socket] += default_size;
919 total_size -= default_size;
923 for (socket = 0; socket < RTE_MAX_NUMA_NODES && total_mem != 0; socket++) {
924 /* skips if the memory on specific socket wasn't requested */
925 for (i = 0; i < num_hp_info && memory[socket] != 0; i++){
926 hp_used[i].hugedir = hp_info[i].hugedir;
927 hp_used[i].num_pages[socket] = RTE_MIN(
928 memory[socket] / hp_info[i].hugepage_sz,
929 hp_info[i].num_pages[socket]);
931 cur_mem = hp_used[i].num_pages[socket] *
932 hp_used[i].hugepage_sz;
934 memory[socket] -= cur_mem;
935 total_mem -= cur_mem;
937 total_num_pages += hp_used[i].num_pages[socket];
939 /* check if we have met all memory requests */
940 if (memory[socket] == 0)
943 /* check if we have any more pages left at this size, if so
944 * move on to next size */
945 if (hp_used[i].num_pages[socket] == hp_info[i].num_pages[socket])
947 /* At this point we know that there are more pages available that are
948 * bigger than the memory we want, so lets see if we can get enough
949 * from other page sizes.
952 for (j = i+1; j < num_hp_info; j++)
953 remaining_mem += hp_info[j].hugepage_sz *
954 hp_info[j].num_pages[socket];
956 /* is there enough other memory, if not allocate another page and quit */
957 if (remaining_mem < memory[socket]){
958 cur_mem = RTE_MIN(memory[socket],
959 hp_info[i].hugepage_sz);
960 memory[socket] -= cur_mem;
961 total_mem -= cur_mem;
962 hp_used[i].num_pages[socket]++;
964 break; /* we are done with this socket*/
967 /* if we didn't satisfy all memory requirements per socket */
968 if (memory[socket] > 0) {
969 /* to prevent icc errors */
970 requested = (unsigned) (internal_config.socket_mem[socket] /
972 available = requested -
973 ((unsigned) (memory[socket] / 0x100000));
974 RTE_LOG(ERR, EAL, "Not enough memory available on socket %u! "
975 "Requested: %uMB, available: %uMB\n", socket,
976 requested, available);
981 /* if we didn't satisfy total memory requirements */
983 requested = (unsigned) (internal_config.memory / 0x100000);
984 available = requested - (unsigned) (total_mem / 0x100000);
985 RTE_LOG(ERR, EAL, "Not enough memory available! Requested: %uMB,"
986 " available: %uMB\n", requested, available);
989 return total_num_pages;
993 eal_get_hugepage_mem_size(void)
998 for (i = 0; i < internal_config.num_hugepage_sizes; i++) {
999 struct hugepage_info *hpi = &internal_config.hugepage_info[i];
1000 if (hpi->hugedir != NULL) {
1001 for (j = 0; j < RTE_MAX_NUMA_NODES; j++) {
1002 size += hpi->hugepage_sz * hpi->num_pages[j];
1007 return (size < SIZE_MAX) ? (size_t)(size) : SIZE_MAX;
1010 static struct sigaction huge_action_old;
1011 static int huge_need_recover;
1014 huge_register_sigbus(void)
1017 struct sigaction action;
1020 sigaddset(&mask, SIGBUS);
1021 action.sa_flags = 0;
1022 action.sa_mask = mask;
1023 action.sa_handler = huge_sigbus_handler;
1025 huge_need_recover = !sigaction(SIGBUS, &action, &huge_action_old);
1029 huge_recover_sigbus(void)
1031 if (huge_need_recover) {
1032 sigaction(SIGBUS, &huge_action_old, NULL);
1033 huge_need_recover = 0;
1038 * Prepare physical memory mapping: fill configuration structure with
1039 * these infos, return 0 on success.
1040 * 1. map N huge pages in separate files in hugetlbfs
1041 * 2. find associated physical addr
1042 * 3. find associated NUMA socket ID
1043 * 4. sort all huge pages by physical address
1044 * 5. remap these N huge pages in the correct order
1045 * 6. unmap the first mapping
1046 * 7. fill memsegs in configuration with contiguous zones
1049 rte_eal_hugepage_init(void)
1051 struct rte_mem_config *mcfg;
1052 struct hugepage_file *hugepage = NULL, *tmp_hp = NULL;
1053 struct hugepage_info used_hp[MAX_HUGEPAGE_SIZES];
1055 uint64_t memory[RTE_MAX_NUMA_NODES];
1058 int i, j, new_memseg;
1059 int nr_hugefiles, nr_hugepages = 0;
1062 test_phys_addrs_available();
1064 memset(used_hp, 0, sizeof(used_hp));
1066 /* get pointer to global configuration */
1067 mcfg = rte_eal_get_configuration()->mem_config;
1069 /* hugetlbfs can be disabled */
1070 if (internal_config.no_hugetlbfs) {
1071 addr = mmap(NULL, internal_config.memory, PROT_READ | PROT_WRITE,
1072 MAP_PRIVATE | MAP_ANONYMOUS, 0, 0);
1073 if (addr == MAP_FAILED) {
1074 RTE_LOG(ERR, EAL, "%s: mmap() failed: %s\n", __func__,
1078 if (rte_eal_iova_mode() == RTE_IOVA_VA)
1079 mcfg->memseg[0].iova = (uintptr_t)addr;
1081 mcfg->memseg[0].iova = RTE_BAD_IOVA;
1082 mcfg->memseg[0].addr = addr;
1083 mcfg->memseg[0].hugepage_sz = RTE_PGSIZE_4K;
1084 mcfg->memseg[0].len = internal_config.memory;
1085 mcfg->memseg[0].socket_id = 0;
1089 /* calculate total number of hugepages available. at this point we haven't
1090 * yet started sorting them so they all are on socket 0 */
1091 for (i = 0; i < (int) internal_config.num_hugepage_sizes; i++) {
1092 /* meanwhile, also initialize used_hp hugepage sizes in used_hp */
1093 used_hp[i].hugepage_sz = internal_config.hugepage_info[i].hugepage_sz;
1095 nr_hugepages += internal_config.hugepage_info[i].num_pages[0];
1099 * allocate a memory area for hugepage table.
1100 * this isn't shared memory yet. due to the fact that we need some
1101 * processing done on these pages, shared memory will be created
1104 tmp_hp = malloc(nr_hugepages * sizeof(struct hugepage_file));
1108 memset(tmp_hp, 0, nr_hugepages * sizeof(struct hugepage_file));
1110 hp_offset = 0; /* where we start the current page size entries */
1112 huge_register_sigbus();
1114 /* make a copy of socket_mem, needed for balanced allocation. */
1115 for (i = 0; i < RTE_MAX_NUMA_NODES; i++)
1116 memory[i] = internal_config.socket_mem[i];
1119 /* map all hugepages and sort them */
1120 for (i = 0; i < (int)internal_config.num_hugepage_sizes; i ++){
1121 unsigned pages_old, pages_new;
1122 struct hugepage_info *hpi;
1125 * we don't yet mark hugepages as used at this stage, so
1126 * we just map all hugepages available to the system
1127 * all hugepages are still located on socket 0
1129 hpi = &internal_config.hugepage_info[i];
1131 if (hpi->num_pages[0] == 0)
1134 /* map all hugepages available */
1135 pages_old = hpi->num_pages[0];
1136 pages_new = map_all_hugepages(&tmp_hp[hp_offset], hpi,
1138 if (pages_new < pages_old) {
1140 "%d not %d hugepages of size %u MB allocated\n",
1141 pages_new, pages_old,
1142 (unsigned)(hpi->hugepage_sz / 0x100000));
1144 int pages = pages_old - pages_new;
1146 nr_hugepages -= pages;
1147 hpi->num_pages[0] = pages_new;
1152 if (phys_addrs_available &&
1153 rte_eal_iova_mode() != RTE_IOVA_VA) {
1154 /* find physical addresses for each hugepage */
1155 if (find_physaddrs(&tmp_hp[hp_offset], hpi) < 0) {
1156 RTE_LOG(DEBUG, EAL, "Failed to find phys addr "
1157 "for %u MB pages\n",
1158 (unsigned int)(hpi->hugepage_sz / 0x100000));
1162 /* set physical addresses for each hugepage */
1163 if (set_physaddrs(&tmp_hp[hp_offset], hpi) < 0) {
1164 RTE_LOG(DEBUG, EAL, "Failed to set phys addr "
1165 "for %u MB pages\n",
1166 (unsigned int)(hpi->hugepage_sz / 0x100000));
1171 if (find_numasocket(&tmp_hp[hp_offset], hpi) < 0){
1172 RTE_LOG(DEBUG, EAL, "Failed to find NUMA socket for %u MB pages\n",
1173 (unsigned)(hpi->hugepage_sz / 0x100000));
1177 qsort(&tmp_hp[hp_offset], hpi->num_pages[0],
1178 sizeof(struct hugepage_file), cmp_physaddr);
1180 /* remap all hugepages */
1181 if (map_all_hugepages(&tmp_hp[hp_offset], hpi, NULL, 0) !=
1182 hpi->num_pages[0]) {
1183 RTE_LOG(ERR, EAL, "Failed to remap %u MB pages\n",
1184 (unsigned)(hpi->hugepage_sz / 0x100000));
1188 /* unmap original mappings */
1189 if (unmap_all_hugepages_orig(&tmp_hp[hp_offset], hpi) < 0)
1192 /* we have processed a num of hugepages of this size, so inc offset */
1193 hp_offset += hpi->num_pages[0];
1196 huge_recover_sigbus();
1198 if (internal_config.memory == 0 && internal_config.force_sockets == 0)
1199 internal_config.memory = eal_get_hugepage_mem_size();
1201 nr_hugefiles = nr_hugepages;
1204 /* clean out the numbers of pages */
1205 for (i = 0; i < (int) internal_config.num_hugepage_sizes; i++)
1206 for (j = 0; j < RTE_MAX_NUMA_NODES; j++)
1207 internal_config.hugepage_info[i].num_pages[j] = 0;
1209 /* get hugepages for each socket */
1210 for (i = 0; i < nr_hugefiles; i++) {
1211 int socket = tmp_hp[i].socket_id;
1213 /* find a hugepage info with right size and increment num_pages */
1214 const int nb_hpsizes = RTE_MIN(MAX_HUGEPAGE_SIZES,
1215 (int)internal_config.num_hugepage_sizes);
1216 for (j = 0; j < nb_hpsizes; j++) {
1217 if (tmp_hp[i].size ==
1218 internal_config.hugepage_info[j].hugepage_sz) {
1219 internal_config.hugepage_info[j].num_pages[socket]++;
1224 /* make a copy of socket_mem, needed for number of pages calculation */
1225 for (i = 0; i < RTE_MAX_NUMA_NODES; i++)
1226 memory[i] = internal_config.socket_mem[i];
1228 /* calculate final number of pages */
1229 nr_hugepages = calc_num_pages_per_socket(memory,
1230 internal_config.hugepage_info, used_hp,
1231 internal_config.num_hugepage_sizes);
1233 /* error if not enough memory available */
1234 if (nr_hugepages < 0)
1238 for (i = 0; i < (int) internal_config.num_hugepage_sizes; i++) {
1239 for (j = 0; j < RTE_MAX_NUMA_NODES; j++) {
1240 if (used_hp[i].num_pages[j] > 0) {
1242 "Requesting %u pages of size %uMB"
1243 " from socket %i\n",
1244 used_hp[i].num_pages[j],
1246 (used_hp[i].hugepage_sz / 0x100000),
1252 /* create shared memory */
1253 hugepage = create_shared_memory(eal_hugepage_info_path(),
1254 nr_hugefiles * sizeof(struct hugepage_file));
1256 if (hugepage == NULL) {
1257 RTE_LOG(ERR, EAL, "Failed to create shared memory!\n");
1260 memset(hugepage, 0, nr_hugefiles * sizeof(struct hugepage_file));
1263 * unmap pages that we won't need (looks at used_hp).
1264 * also, sets final_va to NULL on pages that were unmapped.
1266 if (unmap_unneeded_hugepages(tmp_hp, used_hp,
1267 internal_config.num_hugepage_sizes) < 0) {
1268 RTE_LOG(ERR, EAL, "Unmapping and locking hugepages failed!\n");
1273 * copy stuff from malloc'd hugepage* to the actual shared memory.
1274 * this procedure only copies those hugepages that have final_va
1275 * not NULL. has overflow protection.
1277 if (copy_hugepages_to_shared_mem(hugepage, nr_hugefiles,
1278 tmp_hp, nr_hugefiles) < 0) {
1279 RTE_LOG(ERR, EAL, "Copying tables to shared memory failed!\n");
1283 /* free the hugepage backing files */
1284 if (internal_config.hugepage_unlink &&
1285 unlink_hugepage_files(tmp_hp, internal_config.num_hugepage_sizes) < 0) {
1286 RTE_LOG(ERR, EAL, "Unlinking hugepage files failed!\n");
1290 /* free the temporary hugepage table */
1294 /* first memseg index shall be 0 after incrementing it below */
1296 for (i = 0; i < nr_hugefiles; i++) {
1299 /* if this is a new section, create a new memseg */
1302 else if (hugepage[i].socket_id != hugepage[i-1].socket_id)
1304 else if (hugepage[i].size != hugepage[i-1].size)
1307 #ifdef RTE_ARCH_PPC_64
1308 /* On PPC64 architecture, the mmap always start from higher
1309 * virtual address to lower address. Here, both the physical
1310 * address and virtual address are in descending order */
1311 else if ((hugepage[i-1].physaddr - hugepage[i].physaddr) !=
1314 else if (((unsigned long)hugepage[i-1].final_va -
1315 (unsigned long)hugepage[i].final_va) != hugepage[i].size)
1318 else if ((hugepage[i].physaddr - hugepage[i-1].physaddr) !=
1321 else if (((unsigned long)hugepage[i].final_va -
1322 (unsigned long)hugepage[i-1].final_va) != hugepage[i].size)
1328 if (j == RTE_MAX_MEMSEG)
1331 mcfg->memseg[j].iova = hugepage[i].physaddr;
1332 mcfg->memseg[j].addr = hugepage[i].final_va;
1333 mcfg->memseg[j].len = hugepage[i].size;
1334 mcfg->memseg[j].socket_id = hugepage[i].socket_id;
1335 mcfg->memseg[j].hugepage_sz = hugepage[i].size;
1337 /* continuation of previous memseg */
1339 #ifdef RTE_ARCH_PPC_64
1340 /* Use the phy and virt address of the last page as segment
1341 * address for IBM Power architecture */
1342 mcfg->memseg[j].iova = hugepage[i].physaddr;
1343 mcfg->memseg[j].addr = hugepage[i].final_va;
1345 mcfg->memseg[j].len += mcfg->memseg[j].hugepage_sz;
1347 hugepage[i].memseg_id = j;
1350 if (i < nr_hugefiles) {
1351 RTE_LOG(ERR, EAL, "Can only reserve %d pages "
1352 "from %d requested\n"
1353 "Current %s=%d is not enough\n"
1354 "Please either increase it or request less amount "
1356 i, nr_hugefiles, RTE_STR(CONFIG_RTE_MAX_MEMSEG),
1361 munmap(hugepage, nr_hugefiles * sizeof(struct hugepage_file));
1366 huge_recover_sigbus();
1368 if (hugepage != NULL)
1369 munmap(hugepage, nr_hugefiles * sizeof(struct hugepage_file));
1375 * uses fstat to report the size of a file on disk
1381 if (fstat(fd, &st) < 0)
1387 * This creates the memory mappings in the secondary process to match that of
1388 * the server process. It goes through each memory segment in the DPDK runtime
1389 * configuration and finds the hugepages which form that segment, mapping them
1390 * in order to form a contiguous block in the virtual memory space
1393 rte_eal_hugepage_attach(void)
1395 const struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
1396 struct hugepage_file *hp = NULL;
1397 unsigned num_hp = 0;
1398 unsigned i, s = 0; /* s used to track the segment number */
1399 unsigned max_seg = RTE_MAX_MEMSEG;
1401 int fd, fd_zero = -1, fd_hugepage = -1;
1403 if (aslr_enabled() > 0) {
1404 RTE_LOG(WARNING, EAL, "WARNING: Address Space Layout Randomization "
1405 "(ASLR) is enabled in the kernel.\n");
1406 RTE_LOG(WARNING, EAL, " This may cause issues with mapping memory "
1407 "into secondary processes\n");
1410 test_phys_addrs_available();
1412 fd_zero = open("/dev/zero", O_RDONLY);
1414 RTE_LOG(ERR, EAL, "Could not open /dev/zero\n");
1417 fd_hugepage = open(eal_hugepage_info_path(), O_RDONLY);
1418 if (fd_hugepage < 0) {
1419 RTE_LOG(ERR, EAL, "Could not open %s\n", eal_hugepage_info_path());
1423 /* map all segments into memory to make sure we get the addrs */
1424 for (s = 0; s < RTE_MAX_MEMSEG; ++s) {
1428 * the first memory segment with len==0 is the one that
1429 * follows the last valid segment.
1431 if (mcfg->memseg[s].len == 0)
1435 * fdzero is mmapped to get a contiguous block of virtual
1436 * addresses of the appropriate memseg size.
1437 * use mmap to get identical addresses as the primary process.
1439 base_addr = mmap(mcfg->memseg[s].addr, mcfg->memseg[s].len,
1441 #ifdef RTE_ARCH_PPC_64
1442 MAP_PRIVATE | MAP_ANONYMOUS | MAP_HUGETLB,
1447 if (base_addr == MAP_FAILED ||
1448 base_addr != mcfg->memseg[s].addr) {
1450 if (base_addr != MAP_FAILED) {
1451 /* errno is stale, don't use */
1452 RTE_LOG(ERR, EAL, "Could not mmap %llu bytes "
1453 "in /dev/zero at [%p], got [%p] - "
1454 "please use '--base-virtaddr' option\n",
1455 (unsigned long long)mcfg->memseg[s].len,
1456 mcfg->memseg[s].addr, base_addr);
1457 munmap(base_addr, mcfg->memseg[s].len);
1459 RTE_LOG(ERR, EAL, "Could not mmap %llu bytes "
1460 "in /dev/zero at [%p]: '%s'\n",
1461 (unsigned long long)mcfg->memseg[s].len,
1462 mcfg->memseg[s].addr, strerror(errno));
1464 if (aslr_enabled() > 0) {
1465 RTE_LOG(ERR, EAL, "It is recommended to "
1466 "disable ASLR in the kernel "
1467 "and retry running both primary "
1468 "and secondary processes\n");
1474 size = getFileSize(fd_hugepage);
1475 hp = mmap(NULL, size, PROT_READ, MAP_PRIVATE, fd_hugepage, 0);
1476 if (hp == MAP_FAILED) {
1477 RTE_LOG(ERR, EAL, "Could not mmap %s\n", eal_hugepage_info_path());
1481 num_hp = size / sizeof(struct hugepage_file);
1482 RTE_LOG(DEBUG, EAL, "Analysing %u files\n", num_hp);
1485 while (s < RTE_MAX_MEMSEG && mcfg->memseg[s].len > 0){
1486 void *addr, *base_addr;
1487 uintptr_t offset = 0;
1488 size_t mapping_size;
1490 * free previously mapped memory so we can map the
1491 * hugepages into the space
1493 base_addr = mcfg->memseg[s].addr;
1494 munmap(base_addr, mcfg->memseg[s].len);
1496 /* find the hugepages for this segment and map them
1497 * we don't need to worry about order, as the server sorted the
1498 * entries before it did the second mmap of them */
1499 for (i = 0; i < num_hp && offset < mcfg->memseg[s].len; i++){
1500 if (hp[i].memseg_id == (int)s){
1501 fd = open(hp[i].filepath, O_RDWR);
1503 RTE_LOG(ERR, EAL, "Could not open %s\n",
1507 mapping_size = hp[i].size;
1508 addr = mmap(RTE_PTR_ADD(base_addr, offset),
1509 mapping_size, PROT_READ | PROT_WRITE,
1511 close(fd); /* close file both on success and on failure */
1512 if (addr == MAP_FAILED ||
1513 addr != RTE_PTR_ADD(base_addr, offset)) {
1514 RTE_LOG(ERR, EAL, "Could not mmap %s\n",
1518 offset+=mapping_size;
1521 RTE_LOG(DEBUG, EAL, "Mapped segment %u of size 0x%llx\n", s,
1522 (unsigned long long)mcfg->memseg[s].len);
1525 /* unmap the hugepage config file, since we are done using it */
1532 for (i = 0; i < max_seg && mcfg->memseg[i].len > 0; i++)
1533 munmap(mcfg->memseg[i].addr, mcfg->memseg[i].len);
1534 if (hp != NULL && hp != MAP_FAILED)
1538 if (fd_hugepage >= 0)
1544 rte_eal_using_phys_addrs(void)
1546 return phys_addrs_available;