doc: add Meson coding style to contributors guide
[dpdk.git] / lib / librte_eal / common / malloc_heap.c
index 00fdf54..ee400f3 100644 (file)
 #include <rte_string_fns.h>
 #include <rte_spinlock.h>
 #include <rte_memcpy.h>
+#include <rte_memzone.h>
 #include <rte_atomic.h>
 #include <rte_fbarray.h>
 
 #include "eal_internal_cfg.h"
 #include "eal_memalloc.h"
+#include "eal_memcfg.h"
+#include "eal_private.h"
 #include "malloc_elem.h"
 #include "malloc_heap.h"
 #include "malloc_mp.h"
@@ -94,7 +97,7 @@ malloc_heap_add_memory(struct malloc_heap *heap, struct rte_memseg_list *msl,
 {
        struct malloc_elem *elem = start;
 
-       malloc_elem_init(elem, heap, msl, len);
+       malloc_elem_init(elem, heap, msl, len, elem, len);
 
        malloc_elem_insert(elem);
 
@@ -192,7 +195,9 @@ find_biggest_element(struct malloc_heap *heap, size_t *size,
                for (elem = LIST_FIRST(&heap->free_head[idx]);
                                !!elem; elem = LIST_NEXT(elem, free_list)) {
                        size_t cur_size;
-                       if (!check_hugepage_sz(flags, elem->msl->page_sz))
+                       if ((flags & RTE_MEMZONE_SIZE_HINT_ONLY) == 0 &&
+                                       !check_hugepage_sz(flags,
+                                               elem->msl->page_sz))
                                continue;
                        if (contig) {
                                cur_size =
@@ -236,6 +241,9 @@ heap_alloc(struct malloc_heap *heap, const char *type __rte_unused, size_t size,
        size = RTE_CACHE_LINE_ROUNDUP(size);
        align = RTE_CACHE_LINE_ROUNDUP(align);
 
+       /* roundup might cause an overflow */
+       if (size == 0)
+               return NULL;
        elem = find_suitable_element(heap, size, flags, align, bound, contig);
        if (elem != NULL) {
                elem = malloc_elem_alloc(elem, size, align, bound, contig);
@@ -286,6 +294,7 @@ alloc_pages_on_heap(struct malloc_heap *heap, uint64_t pg_sz, size_t elt_size,
                int socket, unsigned int flags, size_t align, size_t bound,
                bool contig, struct rte_memseg **ms, int n_segs)
 {
+       struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
        struct rte_memseg_list *msl;
        struct malloc_elem *elem = NULL;
        size_t alloc_sz;
@@ -318,6 +327,46 @@ alloc_pages_on_heap(struct malloc_heap *heap, uint64_t pg_sz, size_t elt_size,
                goto fail;
        }
 
+       /*
+        * Once we have all the memseg lists configured, if there is a dma mask
+        * set, check iova addresses are not out of range. Otherwise the device
+        * setting the dma mask could have problems with the mapped memory.
+        *
+        * There are two situations when this can happen:
+        *      1) memory initialization
+        *      2) dynamic memory allocation
+        *
+        * For 1), an error when checking dma mask implies app can not be
+        * executed. For 2) implies the new memory can not be added.
+        */
+       if (mcfg->dma_maskbits &&
+           rte_mem_check_dma_mask_thread_unsafe(mcfg->dma_maskbits)) {
+               /*
+                * Currently this can only happen if IOMMU is enabled
+                * and the address width supported by the IOMMU hw is
+                * not enough for using the memory mapped IOVAs.
+                *
+                * If IOVA is VA, advice to try with '--iova-mode pa'
+                * which could solve some situations when IOVA VA is not
+                * really needed.
+                */
+               RTE_LOG(ERR, EAL,
+                       "%s(): couldn't allocate memory due to IOVA exceeding limits of current DMA mask\n",
+                       __func__);
+
+               /*
+                * If IOVA is VA and it is possible to run with IOVA PA,
+                * because user is root, give and advice for solving the
+                * problem.
+                */
+               if ((rte_eal_iova_mode() == RTE_IOVA_VA) &&
+                    rte_eal_using_phys_addrs())
+                       RTE_LOG(ERR, EAL,
+                               "%s(): Please try initializing EAL with --iova-mode=pa parameter\n",
+                               __func__);
+               goto fail;
+       }
+
        /* add newly minted memsegs to malloc heap */
        elem = malloc_heap_add_memory(heap, msl, map_addr, alloc_sz);
 
@@ -411,6 +460,7 @@ try_expand_heap_secondary(struct malloc_heap *heap, uint64_t pg_sz,
                size_t elt_size, int socket, unsigned int flags, size_t align,
                size_t bound, bool contig)
 {
+       struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
        struct malloc_mp_req req;
        int req_result;
 
@@ -424,7 +474,7 @@ try_expand_heap_secondary(struct malloc_heap *heap, uint64_t pg_sz,
        req.alloc_req.elt_size = elt_size;
        req.alloc_req.page_sz = pg_sz;
        req.alloc_req.socket = socket;
-       req.alloc_req.heap = heap; /* it's in shared memory */
+       req.alloc_req.malloc_heap_idx = heap - mcfg->malloc_heaps;
 
        req_result = request_to_primary(&req);
 
@@ -442,10 +492,9 @@ try_expand_heap(struct malloc_heap *heap, uint64_t pg_sz, size_t elt_size,
                int socket, unsigned int flags, size_t align, size_t bound,
                bool contig)
 {
-       struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
        int ret;
 
-       rte_rwlock_write_lock(&mcfg->memory_hotplug_lock);
+       rte_mcfg_mem_write_lock();
 
        if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
                ret = try_expand_heap_primary(heap, pg_sz, elt_size, socket,
@@ -455,7 +504,7 @@ try_expand_heap(struct malloc_heap *heap, uint64_t pg_sz, size_t elt_size,
                                flags, align, bound, contig);
        }
 
-       rte_rwlock_write_unlock(&mcfg->memory_hotplug_lock);
+       rte_mcfg_mem_write_unlock();
        return ret;
 }
 
@@ -594,13 +643,15 @@ malloc_heap_alloc_on_heap_id(const char *type, size_t size,
        unsigned int size_flags = flags & ~RTE_MEMZONE_SIZE_HINT_ONLY;
        int socket_id;
        void *ret;
+       const struct internal_config *internal_conf =
+               eal_get_internal_configuration();
 
        rte_spinlock_lock(&(heap->lock));
 
        align = align == 0 ? 1 : align;
 
        /* for legacy mode, try once and with all flags */
-       if (internal_config.legacy_mem) {
+       if (internal_conf->legacy_mem) {
                ret = heap_alloc(heap, type, size, flags, align, bound, contig);
                goto alloc_unlock;
        }
@@ -778,13 +829,14 @@ malloc_heap_free_pages(void *aligned_start, size_t aligned_len)
 int
 malloc_heap_free(struct malloc_elem *elem)
 {
-       struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
        struct malloc_heap *heap;
        void *start, *aligned_start, *end, *aligned_end;
        size_t len, aligned_len, page_sz;
        struct rte_memseg_list *msl;
        unsigned int i, n_segs, before_space, after_space;
        int ret;
+       const struct internal_config *internal_conf =
+               eal_get_internal_configuration();
 
        if (!malloc_elem_cookies_ok(elem) || elem->state != ELEM_BUSY)
                return -1;
@@ -807,13 +859,20 @@ malloc_heap_free(struct malloc_elem *elem)
        /* ...of which we can't avail if we are in legacy mode, or if this is an
         * externally allocated segment.
         */
-       if (internal_config.legacy_mem || (msl->external > 0))
+       if (internal_conf->legacy_mem || (msl->external > 0))
                goto free_unlock;
 
        /* check if we can free any memory back to the system */
        if (elem->size < page_sz)
                goto free_unlock;
 
+       /* if user requested to match allocations, the sizes must match - if not,
+        * we will defer freeing these hugepages until the entire original allocation
+        * can be freed
+        */
+       if (internal_conf->match_allocations && elem->size != elem->orig_size)
+               goto free_unlock;
+
        /* probably, but let's make sure, as we may not be using up full page */
        start = elem;
        len = elem->size;
@@ -885,7 +944,7 @@ malloc_heap_free(struct malloc_elem *elem)
 
        /* now we can finally free us some pages */
 
-       rte_rwlock_write_lock(&mcfg->memory_hotplug_lock);
+       rte_mcfg_mem_write_lock();
 
        /*
         * we allow secondary processes to clear the heap of this allocated
@@ -940,7 +999,7 @@ malloc_heap_free(struct malloc_elem *elem)
        RTE_LOG(DEBUG, EAL, "Heap on socket %d was shrunk by %zdMB\n",
                msl->socket_id, aligned_len >> 20ULL);
 
-       rte_rwlock_write_unlock(&mcfg->memory_hotplug_lock);
+       rte_mcfg_mem_write_unlock();
 free_unlock:
        rte_spinlock_unlock(&(heap->lock));
        return ret;
@@ -1023,6 +1082,195 @@ malloc_heap_dump(struct malloc_heap *heap, FILE *f)
        rte_spinlock_unlock(&heap->lock);
 }
 
+static int
+destroy_elem(struct malloc_elem *elem, size_t len)
+{
+       struct malloc_heap *heap = elem->heap;
+
+       /* notify all subscribers that a memory area is going to be removed */
+       eal_memalloc_mem_event_notify(RTE_MEM_EVENT_FREE, elem, len);
+
+       /* this element can be removed */
+       malloc_elem_free_list_remove(elem);
+       malloc_elem_hide_region(elem, elem, len);
+
+       heap->total_size -= len;
+
+       memset(elem, 0, sizeof(*elem));
+
+       return 0;
+}
+
+struct rte_memseg_list *
+malloc_heap_create_external_seg(void *va_addr, rte_iova_t iova_addrs[],
+               unsigned int n_pages, size_t page_sz, const char *seg_name,
+               unsigned int socket_id)
+{
+       struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
+       char fbarray_name[RTE_FBARRAY_NAME_LEN];
+       struct rte_memseg_list *msl = NULL;
+       struct rte_fbarray *arr;
+       size_t seg_len = n_pages * page_sz;
+       unsigned int i;
+
+       /* first, find a free memseg list */
+       for (i = 0; i < RTE_MAX_MEMSEG_LISTS; i++) {
+               struct rte_memseg_list *tmp = &mcfg->memsegs[i];
+               if (tmp->base_va == NULL) {
+                       msl = tmp;
+                       break;
+               }
+       }
+       if (msl == NULL) {
+               RTE_LOG(ERR, EAL, "Couldn't find empty memseg list\n");
+               rte_errno = ENOSPC;
+               return NULL;
+       }
+
+       snprintf(fbarray_name, sizeof(fbarray_name), "%s_%p",
+                       seg_name, va_addr);
+
+       /* create the backing fbarray */
+       if (rte_fbarray_init(&msl->memseg_arr, fbarray_name, n_pages,
+                       sizeof(struct rte_memseg)) < 0) {
+               RTE_LOG(ERR, EAL, "Couldn't create fbarray backing the memseg list\n");
+               return NULL;
+       }
+       arr = &msl->memseg_arr;
+
+       /* fbarray created, fill it up */
+       for (i = 0; i < n_pages; i++) {
+               struct rte_memseg *ms;
+
+               rte_fbarray_set_used(arr, i);
+               ms = rte_fbarray_get(arr, i);
+               ms->addr = RTE_PTR_ADD(va_addr, i * page_sz);
+               ms->iova = iova_addrs == NULL ? RTE_BAD_IOVA : iova_addrs[i];
+               ms->hugepage_sz = page_sz;
+               ms->len = page_sz;
+               ms->nchannel = rte_memory_get_nchannel();
+               ms->nrank = rte_memory_get_nrank();
+               ms->socket_id = socket_id;
+       }
+
+       /* set up the memseg list */
+       msl->base_va = va_addr;
+       msl->page_sz = page_sz;
+       msl->socket_id = socket_id;
+       msl->len = seg_len;
+       msl->version = 0;
+       msl->external = 1;
+
+       return msl;
+}
+
+struct extseg_walk_arg {
+       void *va_addr;
+       size_t len;
+       struct rte_memseg_list *msl;
+};
+
+static int
+extseg_walk(const struct rte_memseg_list *msl, void *arg)
+{
+       struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
+       struct extseg_walk_arg *wa = arg;
+
+       if (msl->base_va == wa->va_addr && msl->len == wa->len) {
+               unsigned int found_idx;
+
+               /* msl is const */
+               found_idx = msl - mcfg->memsegs;
+               wa->msl = &mcfg->memsegs[found_idx];
+               return 1;
+       }
+       return 0;
+}
+
+struct rte_memseg_list *
+malloc_heap_find_external_seg(void *va_addr, size_t len)
+{
+       struct extseg_walk_arg wa;
+       int res;
+
+       wa.va_addr = va_addr;
+       wa.len = len;
+
+       res = rte_memseg_list_walk_thread_unsafe(extseg_walk, &wa);
+
+       if (res != 1) {
+               /* 0 means nothing was found, -1 shouldn't happen */
+               if (res == 0)
+                       rte_errno = ENOENT;
+               return NULL;
+       }
+       return wa.msl;
+}
+
+int
+malloc_heap_destroy_external_seg(struct rte_memseg_list *msl)
+{
+       /* destroy the fbarray backing this memory */
+       if (rte_fbarray_destroy(&msl->memseg_arr) < 0)
+               return -1;
+
+       /* reset the memseg list */
+       memset(msl, 0, sizeof(*msl));
+
+       return 0;
+}
+
+int
+malloc_heap_add_external_memory(struct malloc_heap *heap,
+               struct rte_memseg_list *msl)
+{
+       /* erase contents of new memory */
+       memset(msl->base_va, 0, msl->len);
+
+       /* now, add newly minted memory to the malloc heap */
+       malloc_heap_add_memory(heap, msl, msl->base_va, msl->len);
+
+       heap->total_size += msl->len;
+
+       /* all done! */
+       RTE_LOG(DEBUG, EAL, "Added segment for heap %s starting at %p\n",
+                       heap->name, msl->base_va);
+
+       /* notify all subscribers that a new memory area has been added */
+       eal_memalloc_mem_event_notify(RTE_MEM_EVENT_ALLOC,
+                       msl->base_va, msl->len);
+
+       return 0;
+}
+
+int
+malloc_heap_remove_external_memory(struct malloc_heap *heap, void *va_addr,
+               size_t len)
+{
+       struct malloc_elem *elem = heap->first;
+
+       /* find element with specified va address */
+       while (elem != NULL && elem != va_addr) {
+               elem = elem->next;
+               /* stop if we've blown past our VA */
+               if (elem > (struct malloc_elem *)va_addr) {
+                       rte_errno = ENOENT;
+                       return -1;
+               }
+       }
+       /* check if element was found */
+       if (elem == NULL || elem->msl->len != len) {
+               rte_errno = ENOENT;
+               return -1;
+       }
+       /* if element's size is not equal to segment len, segment is busy */
+       if (elem->state == ELEM_BUSY || elem->size != len) {
+               rte_errno = EBUSY;
+               return -1;
+       }
+       return destroy_elem(elem, len);
+}
+
 int
 malloc_heap_create(struct malloc_heap *heap, const char *heap_name)
 {
@@ -1053,11 +1301,38 @@ malloc_heap_create(struct malloc_heap *heap, const char *heap_name)
        return 0;
 }
 
+int
+malloc_heap_destroy(struct malloc_heap *heap)
+{
+       if (heap->alloc_count != 0) {
+               RTE_LOG(ERR, EAL, "Heap is still in use\n");
+               rte_errno = EBUSY;
+               return -1;
+       }
+       if (heap->first != NULL || heap->last != NULL) {
+               RTE_LOG(ERR, EAL, "Heap still contains memory segments\n");
+               rte_errno = EBUSY;
+               return -1;
+       }
+       if (heap->total_size != 0)
+               RTE_LOG(ERR, EAL, "Total size not zero, heap is likely corrupt\n");
+
+       /* after this, the lock will be dropped */
+       memset(heap, 0, sizeof(*heap));
+
+       return 0;
+}
+
 int
 rte_eal_malloc_heap_init(void)
 {
        struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
        unsigned int i;
+       const struct internal_config *internal_conf =
+               eal_get_internal_configuration();
+
+       if (internal_conf->match_allocations)
+               RTE_LOG(DEBUG, EAL, "Hugepages will be freed exactly as allocated.\n");
 
        if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
                /* assign min socket ID to external heaps */
@@ -1069,7 +1344,7 @@ rte_eal_malloc_heap_init(void)
                        char heap_name[RTE_HEAP_NAME_MAX_LEN];
                        int socket_id = rte_socket_id_by_idx(i);
 
-                       snprintf(heap_name, sizeof(heap_name) - 1,
+                       snprintf(heap_name, sizeof(heap_name),
                                        "socket_%i", socket_id);
                        strlcpy(heap->name, heap_name, RTE_HEAP_NAME_MAX_LEN);
                        heap->socket_id = socket_id;
@@ -1079,7 +1354,7 @@ rte_eal_malloc_heap_init(void)
 
        if (register_mp_requests()) {
                RTE_LOG(ERR, EAL, "Couldn't register malloc multiprocess actions\n");
-               rte_rwlock_read_unlock(&mcfg->memory_hotplug_lock);
+               rte_mcfg_mem_read_unlock();
                return -1;
        }
 
@@ -1087,7 +1362,7 @@ rte_eal_malloc_heap_init(void)
         * even come before primary itself is fully initialized, and secondaries
         * do not need to initialize the heap.
         */
-       rte_rwlock_read_unlock(&mcfg->memory_hotplug_lock);
+       rte_mcfg_mem_read_unlock();
 
        /* secondary process does not need to initialize anything */
        if (rte_eal_process_type() != RTE_PROC_PRIMARY)