mempool: fix alignment of memzone length when populating
[dpdk.git] / lib / librte_mempool / rte_mempool.c
index d9c09e1..9f1a425 100644 (file)
@@ -122,7 +122,8 @@ get_min_page_size(void)
 
 
 static void
-mempool_add_elem(struct rte_mempool *mp, void *obj, rte_iova_t iova)
+mempool_add_elem(struct rte_mempool *mp, __rte_unused void *opaque,
+                void *obj, rte_iova_t iova)
 {
        struct rte_mempool_objhdr *hdr;
        struct rte_mempool_objtlr *tlr __rte_unused;
@@ -139,9 +140,6 @@ mempool_add_elem(struct rte_mempool *mp, void *obj, rte_iova_t iova)
        tlr = __mempool_get_trailer(obj);
        tlr->cookie = RTE_MEMPOOL_TRAILER_COOKIE;
 #endif
-
-       /* enqueue in ring */
-       rte_mempool_ops_enqueue_bulk(mp, &obj, 1);
 }
 
 /* call obj_cb() for each mempool element */
@@ -229,19 +227,15 @@ rte_mempool_calc_obj_size(uint32_t elt_size, uint32_t flags,
 
 
 /*
- * Calculate maximum amount of memory required to store given number of objects.
+ * Internal function to calculate required memory chunk size shared
+ * by default implementation of the corresponding callback and
+ * deprecated external function.
  */
 size_t
-rte_mempool_xmem_size(uint32_t elt_num, size_t total_elt_sz, uint32_t pg_shift,
-                     unsigned int flags)
+rte_mempool_calc_mem_size_helper(uint32_t elt_num, size_t total_elt_sz,
+                                uint32_t pg_shift)
 {
        size_t obj_per_page, pg_num, pg_sz;
-       unsigned int mask;
-
-       mask = MEMPOOL_F_CAPA_BLK_ALIGNED_OBJECTS | MEMPOOL_F_CAPA_PHYS_CONTIG;
-       if ((flags & mask) == mask)
-               /* alignment need one additional object */
-               elt_num += 1;
 
        if (total_elt_sz == 0)
                return 0;
@@ -258,6 +252,17 @@ rte_mempool_xmem_size(uint32_t elt_num, size_t total_elt_sz, uint32_t pg_shift,
        return pg_num << pg_shift;
 }
 
+/*
+ * Calculate maximum amount of memory required to store given number of objects.
+ */
+size_t
+rte_mempool_xmem_size(uint32_t elt_num, size_t total_elt_sz, uint32_t pg_shift,
+                     __rte_unused unsigned int flags)
+{
+       return rte_mempool_calc_mem_size_helper(elt_num, total_elt_sz,
+                                               pg_shift);
+}
+
 /*
  * Calculate how much memory would be actually required with the
  * given memory footprint to store required number of elements.
@@ -265,18 +270,12 @@ rte_mempool_xmem_size(uint32_t elt_num, size_t total_elt_sz, uint32_t pg_shift,
 ssize_t
 rte_mempool_xmem_usage(__rte_unused void *vaddr, uint32_t elt_num,
        size_t total_elt_sz, const rte_iova_t iova[], uint32_t pg_num,
-       uint32_t pg_shift, unsigned int flags)
+       uint32_t pg_shift, __rte_unused unsigned int flags)
 {
        uint32_t elt_cnt = 0;
        rte_iova_t start, end;
        uint32_t iova_idx;
        size_t pg_sz = (size_t)1 << pg_shift;
-       unsigned int mask;
-
-       mask = MEMPOOL_F_CAPA_BLK_ALIGNED_OBJECTS | MEMPOOL_F_CAPA_PHYS_CONTIG;
-       if ((flags & mask) == mask)
-               /* alignment need one additional object */
-               elt_num += 1;
 
        /* if iova is NULL, assume contiguous memory */
        if (iova == NULL) {
@@ -346,6 +345,21 @@ rte_mempool_free_memchunks(struct rte_mempool *mp)
        }
 }
 
+static int
+mempool_ops_alloc_once(struct rte_mempool *mp)
+{
+       int ret;
+
+       /* create the internal ring if not already done */
+       if ((mp->flags & MEMPOOL_F_POOL_CREATED) == 0) {
+               ret = rte_mempool_ops_alloc(mp);
+               if (ret != 0)
+                       return ret;
+               mp->flags |= MEMPOOL_F_POOL_CREATED;
+       }
+       return 0;
+}
+
 /* Add objects in the pool, using a physically contiguous memory
  * zone. Return the number of objects added, or a negative value
  * on error.
@@ -355,41 +369,19 @@ rte_mempool_populate_iova(struct rte_mempool *mp, char *vaddr,
        rte_iova_t iova, size_t len, rte_mempool_memchunk_free_cb_t *free_cb,
        void *opaque)
 {
-       unsigned total_elt_sz;
-       unsigned int mp_capa_flags;
        unsigned i = 0;
        size_t off;
        struct rte_mempool_memhdr *memhdr;
        int ret;
 
-       /* create the internal ring if not already done */
-       if ((mp->flags & MEMPOOL_F_POOL_CREATED) == 0) {
-               ret = rte_mempool_ops_alloc(mp);
-               if (ret != 0)
-                       return ret;
-               mp->flags |= MEMPOOL_F_POOL_CREATED;
-       }
-
-       /* Notify memory area to mempool */
-       ret = rte_mempool_ops_register_memory_area(mp, vaddr, iova, len);
-       if (ret != -ENOTSUP && ret < 0)
+       ret = mempool_ops_alloc_once(mp);
+       if (ret != 0)
                return ret;
 
        /* mempool is already populated */
        if (mp->populated_size >= mp->size)
                return -ENOSPC;
 
-       total_elt_sz = mp->header_size + mp->elt_size + mp->trailer_size;
-
-       /* Get mempool capabilities */
-       mp_capa_flags = 0;
-       ret = rte_mempool_ops_get_capabilities(mp, &mp_capa_flags);
-       if ((ret < 0) && (ret != -ENOTSUP))
-               return ret;
-
-       /* update mempool capabilities */
-       mp->flags |= mp_capa_flags;
-
        memhdr = rte_zmalloc("MEMPOOL_MEMHDR", sizeof(*memhdr), 0);
        if (memhdr == NULL)
                return -ENOMEM;
@@ -401,25 +393,21 @@ rte_mempool_populate_iova(struct rte_mempool *mp, char *vaddr,
        memhdr->free_cb = free_cb;
        memhdr->opaque = opaque;
 
-       if (mp_capa_flags & MEMPOOL_F_CAPA_BLK_ALIGNED_OBJECTS)
-               /* align object start address to a multiple of total_elt_sz */
-               off = total_elt_sz - ((uintptr_t)vaddr % total_elt_sz);
-       else if (mp->flags & MEMPOOL_F_NO_CACHE_ALIGN)
+       if (mp->flags & MEMPOOL_F_NO_CACHE_ALIGN)
                off = RTE_PTR_ALIGN_CEIL(vaddr, 8) - vaddr;
        else
                off = RTE_PTR_ALIGN_CEIL(vaddr, RTE_CACHE_LINE_SIZE) - vaddr;
 
-       while (off + total_elt_sz <= len && mp->populated_size < mp->size) {
-               off += mp->header_size;
-               if (iova == RTE_BAD_IOVA)
-                       mempool_add_elem(mp, (char *)vaddr + off,
-                               RTE_BAD_IOVA);
-               else
-                       mempool_add_elem(mp, (char *)vaddr + off, iova + off);
-               off += mp->elt_size + mp->trailer_size;
-               i++;
+       if (off > len) {
+               ret = -EINVAL;
+               goto fail;
        }
 
+       i = rte_mempool_ops_populate(mp, mp->size - mp->populated_size,
+               (char *)vaddr + off,
+               (iova == RTE_BAD_IOVA) ? RTE_BAD_IOVA : (iova + off),
+               len - off, mempool_add_elem, NULL);
+
        /* not enough room to store one object */
        if (i == 0) {
                ret = -EINVAL;
@@ -563,33 +551,27 @@ rte_mempool_populate_default(struct rte_mempool *mp)
        unsigned int mz_flags = RTE_MEMZONE_1GB|RTE_MEMZONE_SIZE_HINT_ONLY;
        char mz_name[RTE_MEMZONE_NAMESIZE];
        const struct rte_memzone *mz;
-       size_t size, total_elt_sz, align, pg_sz, pg_shift;
+       ssize_t mem_size;
+       size_t align, pg_sz, pg_shift;
        rte_iova_t iova;
        unsigned mz_id, n;
-       unsigned int mp_flags;
        int ret;
-       bool force_contig, no_contig, try_contig, no_pageshift;
+       bool no_contig, try_contig, no_pageshift;
+
+       ret = mempool_ops_alloc_once(mp);
+       if (ret != 0)
+               return ret;
 
        /* mempool must not be populated */
        if (mp->nb_mem_chunks != 0)
                return -EEXIST;
 
-       /* Get mempool capabilities */
-       mp_flags = 0;
-       ret = rte_mempool_ops_get_capabilities(mp, &mp_flags);
-       if ((ret < 0) && (ret != -ENOTSUP))
-               return ret;
-
-       /* update mempool capabilities */
-       mp->flags |= mp_flags;
-
        no_contig = mp->flags & MEMPOOL_F_NO_IOVA_CONTIG;
-       force_contig = mp->flags & MEMPOOL_F_CAPA_PHYS_CONTIG;
 
        /*
         * the following section calculates page shift and page size values.
         *
-        * these values impact the result of rte_mempool_xmem_size(), which
+        * these values impact the result of calc_mem_size operation, which
         * returns the amount of memory that should be allocated to store the
         * desired number of objects. when not zero, it allocates more memory
         * for the padding between objects, to ensure that an object does not
@@ -610,7 +592,7 @@ rte_mempool_populate_default(struct rte_mempool *mp)
         *
         * if our IO addresses are virtual, not actual physical (IOVA as VA
         * case), then no page shift needed - our memory allocation will give us
-        * contiguous physical memory as far as the hardware is concerned, so
+        * contiguous IO memory as far as the hardware is concerned, so
         * act as if we're getting contiguous memory.
         *
         * if our IO addresses are physical, we may get memory from bigger
@@ -628,39 +610,35 @@ rte_mempool_populate_default(struct rte_mempool *mp)
         * 1G page on a 10MB memzone). If we fail to get enough contiguous
         * memory, then we'll go and reserve space page-by-page.
         */
-       no_pageshift = no_contig || force_contig ||
-                       rte_eal_iova_mode() == RTE_IOVA_VA;
+       no_pageshift = no_contig || rte_eal_iova_mode() == RTE_IOVA_VA;
        try_contig = !no_contig && !no_pageshift && rte_eal_has_hugepages();
-       if (force_contig)
-               mz_flags |= RTE_MEMZONE_IOVA_CONTIG;
 
        if (no_pageshift) {
                pg_sz = 0;
                pg_shift = 0;
-               align = RTE_CACHE_LINE_SIZE;
        } else if (try_contig) {
                pg_sz = get_min_page_size();
                pg_shift = rte_bsf32(pg_sz);
-               /* we're trying to reserve contiguous memzone first, so try
-                * align to cache line; if we fail to reserve a contiguous
-                * memzone, we'll adjust alignment to equal pagesize later.
-                */
-               align = RTE_CACHE_LINE_SIZE;
        } else {
                pg_sz = getpagesize();
                pg_shift = rte_bsf32(pg_sz);
-               align = pg_sz;
        }
 
-       total_elt_sz = mp->header_size + mp->elt_size + mp->trailer_size;
        for (mz_id = 0, n = mp->size; n > 0; mz_id++, n -= ret) {
+               size_t min_chunk_size;
                unsigned int flags;
+
                if (try_contig || no_pageshift)
-                       size = rte_mempool_xmem_size(n, total_elt_sz, 0,
-                               mp->flags);
+                       mem_size = rte_mempool_ops_calc_mem_size(mp, n,
+                                       0, &min_chunk_size, &align);
                else
-                       size = rte_mempool_xmem_size(n, total_elt_sz, pg_shift,
-                               mp->flags);
+                       mem_size = rte_mempool_ops_calc_mem_size(mp, n,
+                                       pg_shift, &min_chunk_size, &align);
+
+               if (mem_size < 0) {
+                       ret = mem_size;
+                       goto fail;
+               }
 
                ret = snprintf(mz_name, sizeof(mz_name),
                        RTE_MEMPOOL_MZ_FORMAT "_%d", mp->name, mz_id);
@@ -677,38 +655,49 @@ rte_mempool_populate_default(struct rte_mempool *mp)
                if (try_contig)
                        flags |= RTE_MEMZONE_IOVA_CONTIG;
 
-               mz = rte_memzone_reserve_aligned(mz_name, size, mp->socket_id,
-                               flags, align);
+               mz = rte_memzone_reserve_aligned(mz_name, mem_size,
+                               mp->socket_id, flags, align);
 
-               /* if we were trying to allocate contiguous memory, adjust
-                * memzone size and page size to fit smaller page sizes, and
-                * try again.
+               /* if we were trying to allocate contiguous memory, failed and
+                * minimum required contiguous chunk fits minimum page, adjust
+                * memzone size to the page size, and try again.
                 */
-               if (mz == NULL && try_contig) {
+               if (mz == NULL && try_contig && min_chunk_size <= pg_sz) {
                        try_contig = false;
                        flags &= ~RTE_MEMZONE_IOVA_CONTIG;
-                       align = pg_sz;
-                       size = rte_mempool_xmem_size(n, total_elt_sz,
-                               pg_shift, mp->flags);
 
-                       mz = rte_memzone_reserve_aligned(mz_name, size,
+                       mem_size = rte_mempool_ops_calc_mem_size(mp, n,
+                                       pg_shift, &min_chunk_size, &align);
+                       if (mem_size < 0) {
+                               ret = mem_size;
+                               goto fail;
+                       }
+
+                       mz = rte_memzone_reserve_aligned(mz_name, mem_size,
                                mp->socket_id, flags, align);
                }
                /* don't try reserving with 0 size if we were asked to reserve
                 * IOVA-contiguous memory.
                 */
-               if (!force_contig && mz == NULL) {
+               if (min_chunk_size < (size_t)mem_size && mz == NULL) {
                        /* not enough memory, retry with the biggest zone we
                         * have
                         */
                        mz = rte_memzone_reserve_aligned(mz_name, 0,
-                                       mp->socket_id, flags, align);
+                                       mp->socket_id, flags,
+                                       RTE_MAX(pg_sz, align));
                }
                if (mz == NULL) {
                        ret = -rte_errno;
                        goto fail;
                }
 
+               if (mz->len < min_chunk_size) {
+                       rte_memzone_free(mz);
+                       ret = -ENOMEM;
+                       goto fail;
+               }
+
                if (no_contig)
                        iova = RTE_BAD_IOVA;
                else
@@ -721,7 +710,7 @@ rte_mempool_populate_default(struct rte_mempool *mp)
                                (void *)(uintptr_t)mz);
                else
                        ret = rte_mempool_populate_virt(mp, mz->addr,
-                               mz->len, pg_sz,
+                               RTE_ALIGN_FLOOR(mz->len, pg_sz), pg_sz,
                                rte_mempool_memchunk_mz_free,
                                (void *)(uintptr_t)mz);
                if (ret < 0) {
@@ -738,16 +727,18 @@ rte_mempool_populate_default(struct rte_mempool *mp)
 }
 
 /* return the memory size required for mempool objects in anonymous mem */
-static size_t
+static ssize_t
 get_anon_size(const struct rte_mempool *mp)
 {
-       size_t size, total_elt_sz, pg_sz, pg_shift;
+       ssize_t size;
+       size_t pg_sz, pg_shift;
+       size_t min_chunk_size;
+       size_t align;
 
        pg_sz = getpagesize();
        pg_shift = rte_bsf32(pg_sz);
-       total_elt_sz = mp->header_size + mp->elt_size + mp->trailer_size;
-       size = rte_mempool_xmem_size(mp->size, total_elt_sz, pg_shift,
-                                       mp->flags);
+       size = rte_mempool_ops_calc_mem_size(mp, mp->size, pg_shift,
+                                            &min_chunk_size, &align);
 
        return size;
 }
@@ -757,14 +748,25 @@ static void
 rte_mempool_memchunk_anon_free(struct rte_mempool_memhdr *memhdr,
        void *opaque)
 {
-       munmap(opaque, get_anon_size(memhdr->mp));
+       ssize_t size;
+
+       /*
+        * Calculate size since memhdr->len has contiguous chunk length
+        * which may be smaller if anon map is split into many contiguous
+        * chunks. Result must be the same as we calculated on populate.
+        */
+       size = get_anon_size(memhdr->mp);
+       if (size < 0)
+               return;
+
+       munmap(opaque, size);
 }
 
 /* populate the mempool with an anonymous mapping */
 int
 rte_mempool_populate_anon(struct rte_mempool *mp)
 {
-       size_t size;
+       ssize_t size;
        int ret;
        char *addr;
 
@@ -774,8 +776,17 @@ rte_mempool_populate_anon(struct rte_mempool *mp)
                return 0;
        }
 
-       /* get chunk of virtually continuous memory */
+       ret = mempool_ops_alloc_once(mp);
+       if (ret != 0)
+               return ret;
+
        size = get_anon_size(mp);
+       if (size < 0) {
+               rte_errno = -size;
+               return 0;
+       }
+
+       /* get chunk of virtually continuous memory */
        addr = mmap(NULL, size, PROT_READ | PROT_WRITE,
                MAP_SHARED | MAP_ANONYMOUS, -1, 0);
        if (addr == MAP_FAILED) {
@@ -1245,6 +1256,36 @@ void rte_mempool_check_cookies(const struct rte_mempool *mp,
 #endif
 }
 
+void
+rte_mempool_contig_blocks_check_cookies(const struct rte_mempool *mp,
+       void * const *first_obj_table_const, unsigned int n, int free)
+{
+#ifdef RTE_LIBRTE_MEMPOOL_DEBUG
+       struct rte_mempool_info info;
+       const size_t total_elt_sz =
+               mp->header_size + mp->elt_size + mp->trailer_size;
+       unsigned int i, j;
+
+       rte_mempool_ops_get_info(mp, &info);
+
+       for (i = 0; i < n; ++i) {
+               void *first_obj = first_obj_table_const[i];
+
+               for (j = 0; j < info.contig_block_size; ++j) {
+                       void *obj;
+
+                       obj = (void *)((uintptr_t)first_obj + j * total_elt_sz);
+                       rte_mempool_check_cookies(mp, &obj, 1, free);
+               }
+       }
+#else
+       RTE_SET_USED(mp);
+       RTE_SET_USED(first_obj_table_const);
+       RTE_SET_USED(n);
+       RTE_SET_USED(free);
+#endif
+}
+
 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
 static void
 mempool_obj_audit(struct rte_mempool *mp, __rte_unused void *opaque,
@@ -1310,6 +1351,7 @@ void
 rte_mempool_dump(FILE *f, struct rte_mempool *mp)
 {
 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
+       struct rte_mempool_info info;
        struct rte_mempool_debug_stats sum;
        unsigned lcore_id;
 #endif
@@ -1351,6 +1393,7 @@ rte_mempool_dump(FILE *f, struct rte_mempool *mp)
 
        /* sum and dump statistics */
 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
+       rte_mempool_ops_get_info(mp, &info);
        memset(&sum, 0, sizeof(sum));
        for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
                sum.put_bulk += mp->stats[lcore_id].put_bulk;
@@ -1359,6 +1402,8 @@ rte_mempool_dump(FILE *f, struct rte_mempool *mp)
                sum.get_success_objs += mp->stats[lcore_id].get_success_objs;
                sum.get_fail_bulk += mp->stats[lcore_id].get_fail_bulk;
                sum.get_fail_objs += mp->stats[lcore_id].get_fail_objs;
+               sum.get_success_blks += mp->stats[lcore_id].get_success_blks;
+               sum.get_fail_blks += mp->stats[lcore_id].get_fail_blks;
        }
        fprintf(f, "  stats:\n");
        fprintf(f, "    put_bulk=%"PRIu64"\n", sum.put_bulk);
@@ -1367,6 +1412,11 @@ rte_mempool_dump(FILE *f, struct rte_mempool *mp)
        fprintf(f, "    get_success_objs=%"PRIu64"\n", sum.get_success_objs);
        fprintf(f, "    get_fail_bulk=%"PRIu64"\n", sum.get_fail_bulk);
        fprintf(f, "    get_fail_objs=%"PRIu64"\n", sum.get_fail_objs);
+       if (info.contig_block_size > 0) {
+               fprintf(f, "    get_success_blks=%"PRIu64"\n",
+                       sum.get_success_blks);
+               fprintf(f, "    get_fail_blks=%"PRIu64"\n", sum.get_fail_blks);
+       }
 #else
        fprintf(f, "  no statistics available\n");
 #endif