1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2014 Intel Corporation
14 #include <sys/queue.h>
16 #include <rte_fbarray.h>
17 #include <rte_memory.h>
19 #include <rte_eal_memconfig.h>
20 #include <rte_errno.h>
23 #include "eal_memalloc.h"
24 #include "eal_private.h"
25 #include "eal_internal_cfg.h"
28 * Try to mmap *size bytes in /dev/zero. If it is successful, return the
29 * pointer to the mmap'd area and keep *size unmodified. Else, retry
30 * with a smaller zone: decrease *size by hugepage_sz until it reaches
31 * 0. In this case, return NULL. Note: this function returns an address
32 * which is a multiple of hugepage size.
35 #define MEMSEG_LIST_FMT "memseg-%" PRIu64 "k-%i-%i"
37 static void *next_baseaddr;
38 static uint64_t system_page_sz;
41 eal_get_virtual_area(void *requested_addr, size_t *size,
42 size_t page_sz, int flags, int mmap_flags)
44 bool addr_is_hint, allow_shrink, unmap, no_align;
46 void *mapped_addr, *aligned_addr;
48 if (system_page_sz == 0)
49 system_page_sz = sysconf(_SC_PAGESIZE);
51 mmap_flags |= MAP_PRIVATE | MAP_ANONYMOUS;
53 RTE_LOG(DEBUG, EAL, "Ask a virtual area of 0x%zx bytes\n", *size);
55 addr_is_hint = (flags & EAL_VIRTUAL_AREA_ADDR_IS_HINT) > 0;
56 allow_shrink = (flags & EAL_VIRTUAL_AREA_ALLOW_SHRINK) > 0;
57 unmap = (flags & EAL_VIRTUAL_AREA_UNMAP) > 0;
59 if (next_baseaddr == NULL && internal_config.base_virtaddr != 0 &&
60 rte_eal_process_type() == RTE_PROC_PRIMARY)
61 next_baseaddr = (void *) internal_config.base_virtaddr;
63 if (requested_addr == NULL && next_baseaddr != NULL) {
64 requested_addr = next_baseaddr;
65 requested_addr = RTE_PTR_ALIGN(requested_addr, page_sz);
69 /* we don't need alignment of resulting pointer in the following cases:
71 * 1. page size is equal to system size
72 * 2. we have a requested address, and it is page-aligned, and we will
73 * be discarding the address if we get a different one.
75 * for all other cases, alignment is potentially necessary.
77 no_align = (requested_addr != NULL &&
78 requested_addr == RTE_PTR_ALIGN(requested_addr, page_sz) &&
80 page_sz == system_page_sz;
83 map_sz = no_align ? *size : *size + page_sz;
84 if (map_sz > SIZE_MAX) {
85 RTE_LOG(ERR, EAL, "Map size too big\n");
90 mapped_addr = mmap(requested_addr, (size_t)map_sz, PROT_READ,
92 if (mapped_addr == MAP_FAILED && allow_shrink)
94 } while (allow_shrink && mapped_addr == MAP_FAILED && *size > 0);
96 /* align resulting address - if map failed, we will ignore the value
97 * anyway, so no need to add additional checks.
99 aligned_addr = no_align ? mapped_addr :
100 RTE_PTR_ALIGN(mapped_addr, page_sz);
103 RTE_LOG(ERR, EAL, "Cannot get a virtual area of any size: %s\n",
107 } else if (mapped_addr == MAP_FAILED) {
108 RTE_LOG(ERR, EAL, "Cannot get a virtual area: %s\n",
110 /* pass errno up the call chain */
113 } else if (requested_addr != NULL && !addr_is_hint &&
114 aligned_addr != requested_addr) {
115 RTE_LOG(ERR, EAL, "Cannot get a virtual area at requested address: %p (got %p)\n",
116 requested_addr, aligned_addr);
117 munmap(mapped_addr, map_sz);
118 rte_errno = EADDRNOTAVAIL;
120 } else if (requested_addr != NULL && addr_is_hint &&
121 aligned_addr != requested_addr) {
122 RTE_LOG(WARNING, EAL, "WARNING! Base virtual address hint (%p != %p) not respected!\n",
123 requested_addr, aligned_addr);
124 RTE_LOG(WARNING, EAL, " This may cause issues with mapping memory into secondary processes\n");
125 } else if (next_baseaddr != NULL) {
126 next_baseaddr = RTE_PTR_ADD(aligned_addr, *size);
129 RTE_LOG(DEBUG, EAL, "Virtual area found at %p (size = 0x%zx)\n",
130 aligned_addr, *size);
133 munmap(mapped_addr, map_sz);
134 } else if (!no_align) {
135 void *map_end, *aligned_end;
136 size_t before_len, after_len;
138 /* when we reserve space with alignment, we add alignment to
139 * mapping size. On 32-bit, if 1GB alignment was requested, this
140 * would waste 1GB of address space, which is a luxury we cannot
141 * afford. so, if alignment was performed, check if any unneeded
142 * address space can be unmapped back.
145 map_end = RTE_PTR_ADD(mapped_addr, (size_t)map_sz);
146 aligned_end = RTE_PTR_ADD(aligned_addr, *size);
148 /* unmap space before aligned mmap address */
149 before_len = RTE_PTR_DIFF(aligned_addr, mapped_addr);
151 munmap(mapped_addr, before_len);
153 /* unmap space after aligned end mmap address */
154 after_len = RTE_PTR_DIFF(map_end, aligned_end);
156 munmap(aligned_end, after_len);
162 static struct rte_memseg *
163 virt2memseg(const void *addr, const struct rte_memseg_list *msl)
165 const struct rte_fbarray *arr;
172 /* a memseg list was specified, check if it's the right one */
173 start = msl->base_va;
174 end = RTE_PTR_ADD(start, (size_t)msl->page_sz * msl->memseg_arr.len);
176 if (addr < start || addr >= end)
179 /* now, calculate index */
180 arr = &msl->memseg_arr;
181 ms_idx = RTE_PTR_DIFF(addr, msl->base_va) / msl->page_sz;
182 return rte_fbarray_get(arr, ms_idx);
185 static struct rte_memseg_list *
186 virt2memseg_list(const void *addr)
188 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
189 struct rte_memseg_list *msl;
192 for (msl_idx = 0; msl_idx < RTE_MAX_MEMSEG_LISTS; msl_idx++) {
194 msl = &mcfg->memsegs[msl_idx];
196 start = msl->base_va;
197 end = RTE_PTR_ADD(start,
198 (size_t)msl->page_sz * msl->memseg_arr.len);
199 if (addr >= start && addr < end)
202 /* if we didn't find our memseg list */
203 if (msl_idx == RTE_MAX_MEMSEG_LISTS)
208 __rte_experimental struct rte_memseg_list *
209 rte_mem_virt2memseg_list(const void *addr)
211 return virt2memseg_list(addr);
219 find_virt(const struct rte_memseg_list *msl __rte_unused,
220 const struct rte_memseg *ms, void *arg)
222 struct virtiova *vi = arg;
223 if (vi->iova >= ms->iova && vi->iova < (ms->iova + ms->len)) {
224 size_t offset = vi->iova - ms->iova;
225 vi->virt = RTE_PTR_ADD(ms->addr, offset);
232 find_virt_legacy(const struct rte_memseg_list *msl __rte_unused,
233 const struct rte_memseg *ms, size_t len, void *arg)
235 struct virtiova *vi = arg;
236 if (vi->iova >= ms->iova && vi->iova < (ms->iova + len)) {
237 size_t offset = vi->iova - ms->iova;
238 vi->virt = RTE_PTR_ADD(ms->addr, offset);
245 __rte_experimental void *
246 rte_mem_iova2virt(rte_iova_t iova)
250 memset(&vi, 0, sizeof(vi));
253 /* for legacy mem, we can get away with scanning VA-contiguous segments,
254 * as we know they are PA-contiguous as well
256 if (internal_config.legacy_mem)
257 rte_memseg_contig_walk(find_virt_legacy, &vi);
259 rte_memseg_walk(find_virt, &vi);
264 __rte_experimental struct rte_memseg *
265 rte_mem_virt2memseg(const void *addr, const struct rte_memseg_list *msl)
267 return virt2memseg(addr, msl != NULL ? msl :
268 rte_mem_virt2memseg_list(addr));
272 physmem_size(const struct rte_memseg_list *msl, void *arg)
274 uint64_t *total_len = arg;
276 *total_len += msl->memseg_arr.count * msl->page_sz;
281 /* get the total size of memory */
283 rte_eal_get_physmem_size(void)
285 uint64_t total_len = 0;
287 rte_memseg_list_walk(physmem_size, &total_len);
293 dump_memseg(const struct rte_memseg_list *msl, const struct rte_memseg *ms,
296 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
297 int msl_idx, ms_idx, fd;
300 msl_idx = msl - mcfg->memsegs;
301 if (msl_idx < 0 || msl_idx >= RTE_MAX_MEMSEG_LISTS)
304 ms_idx = rte_fbarray_find_idx(&msl->memseg_arr, ms);
308 fd = eal_memalloc_get_seg_fd(msl_idx, ms_idx);
309 fprintf(f, "Segment %i-%i: IOVA:0x%"PRIx64", len:%zu, "
310 "virt:%p, socket_id:%"PRId32", "
311 "hugepage_sz:%"PRIu64", nchannel:%"PRIx32", "
312 "nrank:%"PRIx32" fd:%i\n",
327 * Defining here because declared in rte_memory.h, but the actual implementation
328 * is in eal_common_memalloc.c, like all other memalloc internals.
330 int __rte_experimental
331 rte_mem_event_callback_register(const char *name, rte_mem_event_callback_t clb,
334 /* FreeBSD boots with legacy mem enabled by default */
335 if (internal_config.legacy_mem) {
336 RTE_LOG(DEBUG, EAL, "Registering mem event callbacks not supported\n");
340 return eal_memalloc_mem_event_callback_register(name, clb, arg);
343 int __rte_experimental
344 rte_mem_event_callback_unregister(const char *name, void *arg)
346 /* FreeBSD boots with legacy mem enabled by default */
347 if (internal_config.legacy_mem) {
348 RTE_LOG(DEBUG, EAL, "Registering mem event callbacks not supported\n");
352 return eal_memalloc_mem_event_callback_unregister(name, arg);
355 int __rte_experimental
356 rte_mem_alloc_validator_register(const char *name,
357 rte_mem_alloc_validator_t clb, int socket_id, size_t limit)
359 /* FreeBSD boots with legacy mem enabled by default */
360 if (internal_config.legacy_mem) {
361 RTE_LOG(DEBUG, EAL, "Registering mem alloc validators not supported\n");
365 return eal_memalloc_mem_alloc_validator_register(name, clb, socket_id,
369 int __rte_experimental
370 rte_mem_alloc_validator_unregister(const char *name, int socket_id)
372 /* FreeBSD boots with legacy mem enabled by default */
373 if (internal_config.legacy_mem) {
374 RTE_LOG(DEBUG, EAL, "Registering mem alloc validators not supported\n");
378 return eal_memalloc_mem_alloc_validator_unregister(name, socket_id);
381 /* Dump the physical memory layout on console */
383 rte_dump_physmem_layout(FILE *f)
385 rte_memseg_walk(dump_memseg, f);
388 /* return the number of memory channels */
389 unsigned rte_memory_get_nchannel(void)
391 return rte_eal_get_configuration()->mem_config->nchannel;
394 /* return the number of memory rank */
395 unsigned rte_memory_get_nrank(void)
397 return rte_eal_get_configuration()->mem_config->nrank;
401 rte_eal_memdevice_init(void)
403 struct rte_config *config;
405 if (rte_eal_process_type() == RTE_PROC_SECONDARY)
408 config = rte_eal_get_configuration();
409 config->mem_config->nchannel = internal_config.force_nchannel;
410 config->mem_config->nrank = internal_config.force_nrank;
415 /* Lock page in physical memory and prevent from swapping. */
417 rte_mem_lock_page(const void *virt)
419 unsigned long virtual = (unsigned long)virt;
420 int page_size = getpagesize();
421 unsigned long aligned = (virtual & ~(page_size - 1));
422 return mlock((void *)aligned, page_size);
425 int __rte_experimental
426 rte_memseg_contig_walk_thread_unsafe(rte_memseg_contig_walk_t func, void *arg)
428 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
429 int i, ms_idx, ret = 0;
431 for (i = 0; i < RTE_MAX_MEMSEG_LISTS; i++) {
432 struct rte_memseg_list *msl = &mcfg->memsegs[i];
433 const struct rte_memseg *ms;
434 struct rte_fbarray *arr;
436 if (msl->memseg_arr.count == 0)
439 arr = &msl->memseg_arr;
441 ms_idx = rte_fbarray_find_next_used(arr, 0);
442 while (ms_idx >= 0) {
446 ms = rte_fbarray_get(arr, ms_idx);
448 /* find how many more segments there are, starting with
451 n_segs = rte_fbarray_find_contig_used(arr, ms_idx);
452 len = n_segs * msl->page_sz;
454 ret = func(msl, ms, len, arg);
457 ms_idx = rte_fbarray_find_next_used(arr,
464 int __rte_experimental
465 rte_memseg_contig_walk(rte_memseg_contig_walk_t func, void *arg)
467 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
470 /* do not allow allocations/frees/init while we iterate */
471 rte_rwlock_read_lock(&mcfg->memory_hotplug_lock);
472 ret = rte_memseg_contig_walk_thread_unsafe(func, arg);
473 rte_rwlock_read_unlock(&mcfg->memory_hotplug_lock);
478 int __rte_experimental
479 rte_memseg_walk_thread_unsafe(rte_memseg_walk_t func, void *arg)
481 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
482 int i, ms_idx, ret = 0;
484 for (i = 0; i < RTE_MAX_MEMSEG_LISTS; i++) {
485 struct rte_memseg_list *msl = &mcfg->memsegs[i];
486 const struct rte_memseg *ms;
487 struct rte_fbarray *arr;
489 if (msl->memseg_arr.count == 0)
492 arr = &msl->memseg_arr;
494 ms_idx = rte_fbarray_find_next_used(arr, 0);
495 while (ms_idx >= 0) {
496 ms = rte_fbarray_get(arr, ms_idx);
497 ret = func(msl, ms, arg);
500 ms_idx = rte_fbarray_find_next_used(arr, ms_idx + 1);
506 int __rte_experimental
507 rte_memseg_walk(rte_memseg_walk_t func, void *arg)
509 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
512 /* do not allow allocations/frees/init while we iterate */
513 rte_rwlock_read_lock(&mcfg->memory_hotplug_lock);
514 ret = rte_memseg_walk_thread_unsafe(func, arg);
515 rte_rwlock_read_unlock(&mcfg->memory_hotplug_lock);
520 int __rte_experimental
521 rte_memseg_list_walk_thread_unsafe(rte_memseg_list_walk_t func, void *arg)
523 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
526 for (i = 0; i < RTE_MAX_MEMSEG_LISTS; i++) {
527 struct rte_memseg_list *msl = &mcfg->memsegs[i];
529 if (msl->base_va == NULL)
532 ret = func(msl, arg);
539 int __rte_experimental
540 rte_memseg_list_walk(rte_memseg_list_walk_t func, void *arg)
542 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
545 /* do not allow allocations/frees/init while we iterate */
546 rte_rwlock_read_lock(&mcfg->memory_hotplug_lock);
547 ret = rte_memseg_list_walk_thread_unsafe(func, arg);
548 rte_rwlock_read_unlock(&mcfg->memory_hotplug_lock);
553 int __rte_experimental
554 rte_memseg_get_fd_thread_unsafe(const struct rte_memseg *ms)
556 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
557 struct rte_memseg_list *msl;
558 struct rte_fbarray *arr;
559 int msl_idx, seg_idx, ret;
566 msl = rte_mem_virt2memseg_list(ms->addr);
571 arr = &msl->memseg_arr;
573 msl_idx = msl - mcfg->memsegs;
574 seg_idx = rte_fbarray_find_idx(arr, ms);
576 if (!rte_fbarray_is_used(arr, seg_idx)) {
581 ret = eal_memalloc_get_seg_fd(msl_idx, seg_idx);
589 int __rte_experimental
590 rte_memseg_get_fd(const struct rte_memseg *ms)
592 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
595 rte_rwlock_read_lock(&mcfg->memory_hotplug_lock);
596 ret = rte_memseg_get_fd_thread_unsafe(ms);
597 rte_rwlock_read_unlock(&mcfg->memory_hotplug_lock);
602 /* init memory subsystem */
604 rte_eal_memory_init(void)
606 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
608 RTE_LOG(DEBUG, EAL, "Setting up physically contiguous memory...\n");
613 /* lock mem hotplug here, to prevent races while we init */
614 rte_rwlock_read_lock(&mcfg->memory_hotplug_lock);
616 if (rte_eal_memseg_init() < 0)
619 if (eal_memalloc_init() < 0)
622 retval = rte_eal_process_type() == RTE_PROC_PRIMARY ?
623 rte_eal_hugepage_init() :
624 rte_eal_hugepage_attach();
628 if (internal_config.no_shconf == 0 && rte_eal_memdevice_init() < 0)
633 rte_rwlock_read_unlock(&mcfg->memory_hotplug_lock);