mempool: prevent objects from being across pages
[dpdk.git] / lib / librte_mempool / rte_mempool.c
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2010-2014 Intel Corporation.
3  * Copyright(c) 2016 6WIND S.A.
4  */
5
6 #include <stdbool.h>
7 #include <stdio.h>
8 #include <string.h>
9 #include <stdint.h>
10 #include <stdarg.h>
11 #include <unistd.h>
12 #include <inttypes.h>
13 #include <errno.h>
14 #include <sys/queue.h>
15 #include <sys/mman.h>
16
17 #include <rte_common.h>
18 #include <rte_log.h>
19 #include <rte_debug.h>
20 #include <rte_memory.h>
21 #include <rte_memzone.h>
22 #include <rte_malloc.h>
23 #include <rte_atomic.h>
24 #include <rte_launch.h>
25 #include <rte_eal.h>
26 #include <rte_eal_memconfig.h>
27 #include <rte_per_lcore.h>
28 #include <rte_lcore.h>
29 #include <rte_branch_prediction.h>
30 #include <rte_errno.h>
31 #include <rte_string_fns.h>
32 #include <rte_spinlock.h>
33 #include <rte_tailq.h>
34
35 #include "rte_mempool.h"
36
37 TAILQ_HEAD(rte_mempool_list, rte_tailq_entry);
38
39 static struct rte_tailq_elem rte_mempool_tailq = {
40         .name = "RTE_MEMPOOL",
41 };
42 EAL_REGISTER_TAILQ(rte_mempool_tailq)
43
44 #define CACHE_FLUSHTHRESH_MULTIPLIER 1.5
45 #define CALC_CACHE_FLUSHTHRESH(c)       \
46         ((typeof(c))((c) * CACHE_FLUSHTHRESH_MULTIPLIER))
47
48 /*
49  * return the greatest common divisor between a and b (fast algorithm)
50  *
51  */
52 static unsigned get_gcd(unsigned a, unsigned b)
53 {
54         unsigned c;
55
56         if (0 == a)
57                 return b;
58         if (0 == b)
59                 return a;
60
61         if (a < b) {
62                 c = a;
63                 a = b;
64                 b = c;
65         }
66
67         while (b != 0) {
68                 c = a % b;
69                 a = b;
70                 b = c;
71         }
72
73         return a;
74 }
75
76 /*
77  * Depending on memory configuration, objects addresses are spread
78  * between channels and ranks in RAM: the pool allocator will add
79  * padding between objects. This function return the new size of the
80  * object.
81  */
82 static unsigned optimize_object_size(unsigned obj_size)
83 {
84         unsigned nrank, nchan;
85         unsigned new_obj_size;
86
87         /* get number of channels */
88         nchan = rte_memory_get_nchannel();
89         if (nchan == 0)
90                 nchan = 4;
91
92         nrank = rte_memory_get_nrank();
93         if (nrank == 0)
94                 nrank = 1;
95
96         /* process new object size */
97         new_obj_size = (obj_size + RTE_MEMPOOL_ALIGN_MASK) / RTE_MEMPOOL_ALIGN;
98         while (get_gcd(new_obj_size, nrank * nchan) != 1)
99                 new_obj_size++;
100         return new_obj_size * RTE_MEMPOOL_ALIGN;
101 }
102
103 struct pagesz_walk_arg {
104         int socket_id;
105         size_t min;
106 };
107
108 static int
109 find_min_pagesz(const struct rte_memseg_list *msl, void *arg)
110 {
111         struct pagesz_walk_arg *wa = arg;
112         bool valid;
113
114         /*
115          * we need to only look at page sizes available for a particular socket
116          * ID.  so, we either need an exact match on socket ID (can match both
117          * native and external memory), or, if SOCKET_ID_ANY was specified as a
118          * socket ID argument, we must only look at native memory and ignore any
119          * page sizes associated with external memory.
120          */
121         valid = msl->socket_id == wa->socket_id;
122         valid |= wa->socket_id == SOCKET_ID_ANY && msl->external == 0;
123
124         if (valid && msl->page_sz < wa->min)
125                 wa->min = msl->page_sz;
126
127         return 0;
128 }
129
130 static size_t
131 get_min_page_size(int socket_id)
132 {
133         struct pagesz_walk_arg wa;
134
135         wa.min = SIZE_MAX;
136         wa.socket_id = socket_id;
137
138         rte_memseg_list_walk(find_min_pagesz, &wa);
139
140         return wa.min == SIZE_MAX ? (size_t) getpagesize() : wa.min;
141 }
142
143
144 static void
145 mempool_add_elem(struct rte_mempool *mp, __rte_unused void *opaque,
146                  void *obj, rte_iova_t iova)
147 {
148         struct rte_mempool_objhdr *hdr;
149         struct rte_mempool_objtlr *tlr __rte_unused;
150
151         /* set mempool ptr in header */
152         hdr = RTE_PTR_SUB(obj, sizeof(*hdr));
153         hdr->mp = mp;
154         hdr->iova = iova;
155         STAILQ_INSERT_TAIL(&mp->elt_list, hdr, next);
156         mp->populated_size++;
157
158 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
159         hdr->cookie = RTE_MEMPOOL_HEADER_COOKIE2;
160         tlr = __mempool_get_trailer(obj);
161         tlr->cookie = RTE_MEMPOOL_TRAILER_COOKIE;
162 #endif
163 }
164
165 /* call obj_cb() for each mempool element */
166 uint32_t
167 rte_mempool_obj_iter(struct rte_mempool *mp,
168         rte_mempool_obj_cb_t *obj_cb, void *obj_cb_arg)
169 {
170         struct rte_mempool_objhdr *hdr;
171         void *obj;
172         unsigned n = 0;
173
174         STAILQ_FOREACH(hdr, &mp->elt_list, next) {
175                 obj = (char *)hdr + sizeof(*hdr);
176                 obj_cb(mp, obj_cb_arg, obj, n);
177                 n++;
178         }
179
180         return n;
181 }
182
183 /* call mem_cb() for each mempool memory chunk */
184 uint32_t
185 rte_mempool_mem_iter(struct rte_mempool *mp,
186         rte_mempool_mem_cb_t *mem_cb, void *mem_cb_arg)
187 {
188         struct rte_mempool_memhdr *hdr;
189         unsigned n = 0;
190
191         STAILQ_FOREACH(hdr, &mp->mem_list, next) {
192                 mem_cb(mp, mem_cb_arg, hdr, n);
193                 n++;
194         }
195
196         return n;
197 }
198
199 /* get the header, trailer and total size of a mempool element. */
200 uint32_t
201 rte_mempool_calc_obj_size(uint32_t elt_size, uint32_t flags,
202         struct rte_mempool_objsz *sz)
203 {
204         struct rte_mempool_objsz lsz;
205
206         sz = (sz != NULL) ? sz : &lsz;
207
208         sz->header_size = sizeof(struct rte_mempool_objhdr);
209         if ((flags & MEMPOOL_F_NO_CACHE_ALIGN) == 0)
210                 sz->header_size = RTE_ALIGN_CEIL(sz->header_size,
211                         RTE_MEMPOOL_ALIGN);
212
213 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
214         sz->trailer_size = sizeof(struct rte_mempool_objtlr);
215 #else
216         sz->trailer_size = 0;
217 #endif
218
219         /* element size is 8 bytes-aligned at least */
220         sz->elt_size = RTE_ALIGN_CEIL(elt_size, sizeof(uint64_t));
221
222         /* expand trailer to next cache line */
223         if ((flags & MEMPOOL_F_NO_CACHE_ALIGN) == 0) {
224                 sz->total_size = sz->header_size + sz->elt_size +
225                         sz->trailer_size;
226                 sz->trailer_size += ((RTE_MEMPOOL_ALIGN -
227                                   (sz->total_size & RTE_MEMPOOL_ALIGN_MASK)) &
228                                  RTE_MEMPOOL_ALIGN_MASK);
229         }
230
231         /*
232          * increase trailer to add padding between objects in order to
233          * spread them across memory channels/ranks
234          */
235         if ((flags & MEMPOOL_F_NO_SPREAD) == 0) {
236                 unsigned new_size;
237                 new_size = optimize_object_size(sz->header_size + sz->elt_size +
238                         sz->trailer_size);
239                 sz->trailer_size = new_size - sz->header_size - sz->elt_size;
240         }
241
242         /* this is the size of an object, including header and trailer */
243         sz->total_size = sz->header_size + sz->elt_size + sz->trailer_size;
244
245         return sz->total_size;
246 }
247
248 /* free a memchunk allocated with rte_memzone_reserve() */
249 static void
250 rte_mempool_memchunk_mz_free(__rte_unused struct rte_mempool_memhdr *memhdr,
251         void *opaque)
252 {
253         const struct rte_memzone *mz = opaque;
254         rte_memzone_free(mz);
255 }
256
257 /* Free memory chunks used by a mempool. Objects must be in pool */
258 static void
259 rte_mempool_free_memchunks(struct rte_mempool *mp)
260 {
261         struct rte_mempool_memhdr *memhdr;
262         void *elt;
263
264         while (!STAILQ_EMPTY(&mp->elt_list)) {
265                 rte_mempool_ops_dequeue_bulk(mp, &elt, 1);
266                 (void)elt;
267                 STAILQ_REMOVE_HEAD(&mp->elt_list, next);
268                 mp->populated_size--;
269         }
270
271         while (!STAILQ_EMPTY(&mp->mem_list)) {
272                 memhdr = STAILQ_FIRST(&mp->mem_list);
273                 STAILQ_REMOVE_HEAD(&mp->mem_list, next);
274                 if (memhdr->free_cb != NULL)
275                         memhdr->free_cb(memhdr, memhdr->opaque);
276                 rte_free(memhdr);
277                 mp->nb_mem_chunks--;
278         }
279 }
280
281 static int
282 mempool_ops_alloc_once(struct rte_mempool *mp)
283 {
284         int ret;
285
286         /* create the internal ring if not already done */
287         if ((mp->flags & MEMPOOL_F_POOL_CREATED) == 0) {
288                 ret = rte_mempool_ops_alloc(mp);
289                 if (ret != 0)
290                         return ret;
291                 mp->flags |= MEMPOOL_F_POOL_CREATED;
292         }
293         return 0;
294 }
295
296 /* Add objects in the pool, using a physically contiguous memory
297  * zone. Return the number of objects added, or a negative value
298  * on error.
299  */
300 int
301 rte_mempool_populate_iova(struct rte_mempool *mp, char *vaddr,
302         rte_iova_t iova, size_t len, rte_mempool_memchunk_free_cb_t *free_cb,
303         void *opaque)
304 {
305         unsigned i = 0;
306         size_t off;
307         struct rte_mempool_memhdr *memhdr;
308         int ret;
309
310         ret = mempool_ops_alloc_once(mp);
311         if (ret != 0)
312                 return ret;
313
314         /* mempool is already populated */
315         if (mp->populated_size >= mp->size)
316                 return -ENOSPC;
317
318         memhdr = rte_zmalloc("MEMPOOL_MEMHDR", sizeof(*memhdr), 0);
319         if (memhdr == NULL)
320                 return -ENOMEM;
321
322         memhdr->mp = mp;
323         memhdr->addr = vaddr;
324         memhdr->iova = iova;
325         memhdr->len = len;
326         memhdr->free_cb = free_cb;
327         memhdr->opaque = opaque;
328
329         if (mp->flags & MEMPOOL_F_NO_CACHE_ALIGN)
330                 off = RTE_PTR_ALIGN_CEIL(vaddr, 8) - vaddr;
331         else
332                 off = RTE_PTR_ALIGN_CEIL(vaddr, RTE_CACHE_LINE_SIZE) - vaddr;
333
334         if (off > len) {
335                 ret = -EINVAL;
336                 goto fail;
337         }
338
339         i = rte_mempool_ops_populate(mp, mp->size - mp->populated_size,
340                 (char *)vaddr + off,
341                 (iova == RTE_BAD_IOVA) ? RTE_BAD_IOVA : (iova + off),
342                 len - off, mempool_add_elem, NULL);
343
344         /* not enough room to store one object */
345         if (i == 0) {
346                 ret = -EINVAL;
347                 goto fail;
348         }
349
350         STAILQ_INSERT_TAIL(&mp->mem_list, memhdr, next);
351         mp->nb_mem_chunks++;
352         return i;
353
354 fail:
355         rte_free(memhdr);
356         return ret;
357 }
358
359 /* Populate the mempool with a virtual area. Return the number of
360  * objects added, or a negative value on error.
361  */
362 int
363 rte_mempool_populate_virt(struct rte_mempool *mp, char *addr,
364         size_t len, size_t pg_sz, rte_mempool_memchunk_free_cb_t *free_cb,
365         void *opaque)
366 {
367         rte_iova_t iova;
368         size_t off, phys_len;
369         int ret, cnt = 0;
370
371         if (mp->flags & MEMPOOL_F_NO_IOVA_CONTIG)
372                 return rte_mempool_populate_iova(mp, addr, RTE_BAD_IOVA,
373                         len, free_cb, opaque);
374
375         for (off = 0; off < len &&
376                      mp->populated_size < mp->size; off += phys_len) {
377
378                 iova = rte_mem_virt2iova(addr + off);
379
380                 if (iova == RTE_BAD_IOVA && rte_eal_has_hugepages()) {
381                         ret = -EINVAL;
382                         goto fail;
383                 }
384
385                 /* populate with the largest group of contiguous pages */
386                 for (phys_len = RTE_MIN(
387                         (size_t)(RTE_PTR_ALIGN_CEIL(addr + off + 1, pg_sz) -
388                                 (addr + off)),
389                         len - off);
390                      off + phys_len < len;
391                      phys_len = RTE_MIN(phys_len + pg_sz, len - off)) {
392                         rte_iova_t iova_tmp;
393
394                         iova_tmp = rte_mem_virt2iova(addr + off + phys_len);
395
396                         if (iova_tmp == RTE_BAD_IOVA ||
397                                         iova_tmp != iova + phys_len)
398                                 break;
399                 }
400
401                 ret = rte_mempool_populate_iova(mp, addr + off, iova,
402                         phys_len, free_cb, opaque);
403                 if (ret < 0)
404                         goto fail;
405                 /* no need to call the free callback for next chunks */
406                 free_cb = NULL;
407                 cnt += ret;
408         }
409
410         return cnt;
411
412  fail:
413         rte_mempool_free_memchunks(mp);
414         return ret;
415 }
416
417 /* Get the minimal page size used in a mempool before populating it. */
418 int
419 rte_mempool_get_page_size(struct rte_mempool *mp, size_t *pg_sz)
420 {
421         bool need_iova_contig_obj;
422         bool alloc_in_ext_mem;
423         int ret;
424
425         /* check if we can retrieve a valid socket ID */
426         ret = rte_malloc_heap_socket_is_external(mp->socket_id);
427         if (ret < 0)
428                 return -EINVAL;
429         alloc_in_ext_mem = (ret == 1);
430         need_iova_contig_obj = !(mp->flags & MEMPOOL_F_NO_IOVA_CONTIG);
431
432         if (!need_iova_contig_obj)
433                 *pg_sz = 0;
434         else if (rte_eal_has_hugepages() || alloc_in_ext_mem)
435                 *pg_sz = get_min_page_size(mp->socket_id);
436         else
437                 *pg_sz = getpagesize();
438
439         return 0;
440 }
441
442 /* Default function to populate the mempool: allocate memory in memzones,
443  * and populate them. Return the number of objects added, or a negative
444  * value on error.
445  */
446 int
447 rte_mempool_populate_default(struct rte_mempool *mp)
448 {
449         unsigned int mz_flags = RTE_MEMZONE_1GB|RTE_MEMZONE_SIZE_HINT_ONLY;
450         char mz_name[RTE_MEMZONE_NAMESIZE];
451         const struct rte_memzone *mz;
452         ssize_t mem_size;
453         size_t align, pg_sz, pg_shift = 0;
454         rte_iova_t iova;
455         unsigned mz_id, n;
456         int ret;
457         bool need_iova_contig_obj;
458
459         ret = mempool_ops_alloc_once(mp);
460         if (ret != 0)
461                 return ret;
462
463         /* mempool must not be populated */
464         if (mp->nb_mem_chunks != 0)
465                 return -EEXIST;
466
467         /*
468          * the following section calculates page shift and page size values.
469          *
470          * these values impact the result of calc_mem_size operation, which
471          * returns the amount of memory that should be allocated to store the
472          * desired number of objects. when not zero, it allocates more memory
473          * for the padding between objects, to ensure that an object does not
474          * cross a page boundary. in other words, page size/shift are to be set
475          * to zero if mempool elements won't care about page boundaries.
476          * there are several considerations for page size and page shift here.
477          *
478          * if we don't need our mempools to have physically contiguous objects,
479          * then just set page shift and page size to 0, because the user has
480          * indicated that there's no need to care about anything.
481          *
482          * if we do need contiguous objects (if a mempool driver has its
483          * own calc_size() method returning min_chunk_size = mem_size),
484          * there is also an option to reserve the entire mempool memory
485          * as one contiguous block of memory.
486          *
487          * if we require contiguous objects, but not necessarily the entire
488          * mempool reserved space to be contiguous, pg_sz will be != 0,
489          * and the default ops->populate() will take care of not placing
490          * objects across pages.
491          *
492          * if our IO addresses are physical, we may get memory from bigger
493          * pages, or we might get memory from smaller pages, and how much of it
494          * we require depends on whether we want bigger or smaller pages.
495          * However, requesting each and every memory size is too much work, so
496          * what we'll do instead is walk through the page sizes available, pick
497          * the smallest one and set up page shift to match that one. We will be
498          * wasting some space this way, but it's much nicer than looping around
499          * trying to reserve each and every page size.
500          *
501          * If we fail to get enough contiguous memory, then we'll go and
502          * reserve space in smaller chunks.
503          */
504
505         need_iova_contig_obj = !(mp->flags & MEMPOOL_F_NO_IOVA_CONTIG);
506         ret = rte_mempool_get_page_size(mp, &pg_sz);
507         if (ret < 0)
508                 return ret;
509
510         if (pg_sz != 0)
511                 pg_shift = rte_bsf32(pg_sz);
512
513         for (mz_id = 0, n = mp->size; n > 0; mz_id++, n -= ret) {
514                 size_t min_chunk_size;
515
516                 mem_size = rte_mempool_ops_calc_mem_size(
517                         mp, n, pg_shift, &min_chunk_size, &align);
518
519                 if (mem_size < 0) {
520                         ret = mem_size;
521                         goto fail;
522                 }
523
524                 ret = snprintf(mz_name, sizeof(mz_name),
525                         RTE_MEMPOOL_MZ_FORMAT "_%d", mp->name, mz_id);
526                 if (ret < 0 || ret >= (int)sizeof(mz_name)) {
527                         ret = -ENAMETOOLONG;
528                         goto fail;
529                 }
530
531                 /* if we're trying to reserve contiguous memory, add appropriate
532                  * memzone flag.
533                  */
534                 if (min_chunk_size == (size_t)mem_size)
535                         mz_flags |= RTE_MEMZONE_IOVA_CONTIG;
536
537                 mz = rte_memzone_reserve_aligned(mz_name, mem_size,
538                                 mp->socket_id, mz_flags, align);
539
540                 /* don't try reserving with 0 size if we were asked to reserve
541                  * IOVA-contiguous memory.
542                  */
543                 if (min_chunk_size < (size_t)mem_size && mz == NULL) {
544                         /* not enough memory, retry with the biggest zone we
545                          * have
546                          */
547                         mz = rte_memzone_reserve_aligned(mz_name, 0,
548                                         mp->socket_id, mz_flags, align);
549                 }
550                 if (mz == NULL) {
551                         ret = -rte_errno;
552                         goto fail;
553                 }
554
555                 if (mz->len < min_chunk_size) {
556                         rte_memzone_free(mz);
557                         ret = -ENOMEM;
558                         goto fail;
559                 }
560
561                 if (need_iova_contig_obj)
562                         iova = mz->iova;
563                 else
564                         iova = RTE_BAD_IOVA;
565
566                 if (pg_sz == 0 || (mz_flags & RTE_MEMZONE_IOVA_CONTIG))
567                         ret = rte_mempool_populate_iova(mp, mz->addr,
568                                 iova, mz->len,
569                                 rte_mempool_memchunk_mz_free,
570                                 (void *)(uintptr_t)mz);
571                 else
572                         ret = rte_mempool_populate_virt(mp, mz->addr,
573                                 mz->len, pg_sz,
574                                 rte_mempool_memchunk_mz_free,
575                                 (void *)(uintptr_t)mz);
576                 if (ret < 0) {
577                         rte_memzone_free(mz);
578                         goto fail;
579                 }
580         }
581
582         return mp->size;
583
584  fail:
585         rte_mempool_free_memchunks(mp);
586         return ret;
587 }
588
589 /* return the memory size required for mempool objects in anonymous mem */
590 static ssize_t
591 get_anon_size(const struct rte_mempool *mp)
592 {
593         ssize_t size;
594         size_t pg_sz, pg_shift;
595         size_t min_chunk_size;
596         size_t align;
597
598         pg_sz = getpagesize();
599         pg_shift = rte_bsf32(pg_sz);
600         size = rte_mempool_ops_calc_mem_size(mp, mp->size, pg_shift,
601                                              &min_chunk_size, &align);
602
603         return size;
604 }
605
606 /* unmap a memory zone mapped by rte_mempool_populate_anon() */
607 static void
608 rte_mempool_memchunk_anon_free(struct rte_mempool_memhdr *memhdr,
609         void *opaque)
610 {
611         ssize_t size;
612
613         /*
614          * Calculate size since memhdr->len has contiguous chunk length
615          * which may be smaller if anon map is split into many contiguous
616          * chunks. Result must be the same as we calculated on populate.
617          */
618         size = get_anon_size(memhdr->mp);
619         if (size < 0)
620                 return;
621
622         munmap(opaque, size);
623 }
624
625 /* populate the mempool with an anonymous mapping */
626 int
627 rte_mempool_populate_anon(struct rte_mempool *mp)
628 {
629         ssize_t size;
630         int ret;
631         char *addr;
632
633         /* mempool is already populated, error */
634         if ((!STAILQ_EMPTY(&mp->mem_list)) || mp->nb_mem_chunks != 0) {
635                 rte_errno = EINVAL;
636                 return 0;
637         }
638
639         ret = mempool_ops_alloc_once(mp);
640         if (ret != 0)
641                 return ret;
642
643         size = get_anon_size(mp);
644         if (size < 0) {
645                 rte_errno = -size;
646                 return 0;
647         }
648
649         /* get chunk of virtually continuous memory */
650         addr = mmap(NULL, size, PROT_READ | PROT_WRITE,
651                 MAP_SHARED | MAP_ANONYMOUS, -1, 0);
652         if (addr == MAP_FAILED) {
653                 rte_errno = errno;
654                 return 0;
655         }
656         /* can't use MMAP_LOCKED, it does not exist on BSD */
657         if (mlock(addr, size) < 0) {
658                 rte_errno = errno;
659                 munmap(addr, size);
660                 return 0;
661         }
662
663         ret = rte_mempool_populate_virt(mp, addr, size, getpagesize(),
664                 rte_mempool_memchunk_anon_free, addr);
665         if (ret == 0)
666                 goto fail;
667
668         return mp->populated_size;
669
670  fail:
671         rte_mempool_free_memchunks(mp);
672         return 0;
673 }
674
675 /* free a mempool */
676 void
677 rte_mempool_free(struct rte_mempool *mp)
678 {
679         struct rte_mempool_list *mempool_list = NULL;
680         struct rte_tailq_entry *te;
681
682         if (mp == NULL)
683                 return;
684
685         mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
686         rte_mcfg_tailq_write_lock();
687         /* find out tailq entry */
688         TAILQ_FOREACH(te, mempool_list, next) {
689                 if (te->data == (void *)mp)
690                         break;
691         }
692
693         if (te != NULL) {
694                 TAILQ_REMOVE(mempool_list, te, next);
695                 rte_free(te);
696         }
697         rte_mcfg_tailq_write_unlock();
698
699         rte_mempool_free_memchunks(mp);
700         rte_mempool_ops_free(mp);
701         rte_memzone_free(mp->mz);
702 }
703
704 static void
705 mempool_cache_init(struct rte_mempool_cache *cache, uint32_t size)
706 {
707         cache->size = size;
708         cache->flushthresh = CALC_CACHE_FLUSHTHRESH(size);
709         cache->len = 0;
710 }
711
712 /*
713  * Create and initialize a cache for objects that are retrieved from and
714  * returned to an underlying mempool. This structure is identical to the
715  * local_cache[lcore_id] pointed to by the mempool structure.
716  */
717 struct rte_mempool_cache *
718 rte_mempool_cache_create(uint32_t size, int socket_id)
719 {
720         struct rte_mempool_cache *cache;
721
722         if (size == 0 || size > RTE_MEMPOOL_CACHE_MAX_SIZE) {
723                 rte_errno = EINVAL;
724                 return NULL;
725         }
726
727         cache = rte_zmalloc_socket("MEMPOOL_CACHE", sizeof(*cache),
728                                   RTE_CACHE_LINE_SIZE, socket_id);
729         if (cache == NULL) {
730                 RTE_LOG(ERR, MEMPOOL, "Cannot allocate mempool cache.\n");
731                 rte_errno = ENOMEM;
732                 return NULL;
733         }
734
735         mempool_cache_init(cache, size);
736
737         return cache;
738 }
739
740 /*
741  * Free a cache. It's the responsibility of the user to make sure that any
742  * remaining objects in the cache are flushed to the corresponding
743  * mempool.
744  */
745 void
746 rte_mempool_cache_free(struct rte_mempool_cache *cache)
747 {
748         rte_free(cache);
749 }
750
751 /* create an empty mempool */
752 struct rte_mempool *
753 rte_mempool_create_empty(const char *name, unsigned n, unsigned elt_size,
754         unsigned cache_size, unsigned private_data_size,
755         int socket_id, unsigned flags)
756 {
757         char mz_name[RTE_MEMZONE_NAMESIZE];
758         struct rte_mempool_list *mempool_list;
759         struct rte_mempool *mp = NULL;
760         struct rte_tailq_entry *te = NULL;
761         const struct rte_memzone *mz = NULL;
762         size_t mempool_size;
763         unsigned int mz_flags = RTE_MEMZONE_1GB|RTE_MEMZONE_SIZE_HINT_ONLY;
764         struct rte_mempool_objsz objsz;
765         unsigned lcore_id;
766         int ret;
767
768         /* compilation-time checks */
769         RTE_BUILD_BUG_ON((sizeof(struct rte_mempool) &
770                           RTE_CACHE_LINE_MASK) != 0);
771         RTE_BUILD_BUG_ON((sizeof(struct rte_mempool_cache) &
772                           RTE_CACHE_LINE_MASK) != 0);
773 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
774         RTE_BUILD_BUG_ON((sizeof(struct rte_mempool_debug_stats) &
775                           RTE_CACHE_LINE_MASK) != 0);
776         RTE_BUILD_BUG_ON((offsetof(struct rte_mempool, stats) &
777                           RTE_CACHE_LINE_MASK) != 0);
778 #endif
779
780         mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
781
782         /* asked for zero items */
783         if (n == 0) {
784                 rte_errno = EINVAL;
785                 return NULL;
786         }
787
788         /* asked cache too big */
789         if (cache_size > RTE_MEMPOOL_CACHE_MAX_SIZE ||
790             CALC_CACHE_FLUSHTHRESH(cache_size) > n) {
791                 rte_errno = EINVAL;
792                 return NULL;
793         }
794
795         /* "no cache align" imply "no spread" */
796         if (flags & MEMPOOL_F_NO_CACHE_ALIGN)
797                 flags |= MEMPOOL_F_NO_SPREAD;
798
799         /* calculate mempool object sizes. */
800         if (!rte_mempool_calc_obj_size(elt_size, flags, &objsz)) {
801                 rte_errno = EINVAL;
802                 return NULL;
803         }
804
805         rte_mcfg_mempool_write_lock();
806
807         /*
808          * reserve a memory zone for this mempool: private data is
809          * cache-aligned
810          */
811         private_data_size = (private_data_size +
812                              RTE_MEMPOOL_ALIGN_MASK) & (~RTE_MEMPOOL_ALIGN_MASK);
813
814
815         /* try to allocate tailq entry */
816         te = rte_zmalloc("MEMPOOL_TAILQ_ENTRY", sizeof(*te), 0);
817         if (te == NULL) {
818                 RTE_LOG(ERR, MEMPOOL, "Cannot allocate tailq entry!\n");
819                 goto exit_unlock;
820         }
821
822         mempool_size = MEMPOOL_HEADER_SIZE(mp, cache_size);
823         mempool_size += private_data_size;
824         mempool_size = RTE_ALIGN_CEIL(mempool_size, RTE_MEMPOOL_ALIGN);
825
826         ret = snprintf(mz_name, sizeof(mz_name), RTE_MEMPOOL_MZ_FORMAT, name);
827         if (ret < 0 || ret >= (int)sizeof(mz_name)) {
828                 rte_errno = ENAMETOOLONG;
829                 goto exit_unlock;
830         }
831
832         mz = rte_memzone_reserve(mz_name, mempool_size, socket_id, mz_flags);
833         if (mz == NULL)
834                 goto exit_unlock;
835
836         /* init the mempool structure */
837         mp = mz->addr;
838         memset(mp, 0, MEMPOOL_HEADER_SIZE(mp, cache_size));
839         ret = strlcpy(mp->name, name, sizeof(mp->name));
840         if (ret < 0 || ret >= (int)sizeof(mp->name)) {
841                 rte_errno = ENAMETOOLONG;
842                 goto exit_unlock;
843         }
844         mp->mz = mz;
845         mp->size = n;
846         mp->flags = flags;
847         mp->socket_id = socket_id;
848         mp->elt_size = objsz.elt_size;
849         mp->header_size = objsz.header_size;
850         mp->trailer_size = objsz.trailer_size;
851         /* Size of default caches, zero means disabled. */
852         mp->cache_size = cache_size;
853         mp->private_data_size = private_data_size;
854         STAILQ_INIT(&mp->elt_list);
855         STAILQ_INIT(&mp->mem_list);
856
857         /*
858          * local_cache pointer is set even if cache_size is zero.
859          * The local_cache points to just past the elt_pa[] array.
860          */
861         mp->local_cache = (struct rte_mempool_cache *)
862                 RTE_PTR_ADD(mp, MEMPOOL_HEADER_SIZE(mp, 0));
863
864         /* Init all default caches. */
865         if (cache_size != 0) {
866                 for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++)
867                         mempool_cache_init(&mp->local_cache[lcore_id],
868                                            cache_size);
869         }
870
871         te->data = mp;
872
873         rte_mcfg_tailq_write_lock();
874         TAILQ_INSERT_TAIL(mempool_list, te, next);
875         rte_mcfg_tailq_write_unlock();
876         rte_mcfg_mempool_write_unlock();
877
878         return mp;
879
880 exit_unlock:
881         rte_mcfg_mempool_write_unlock();
882         rte_free(te);
883         rte_mempool_free(mp);
884         return NULL;
885 }
886
887 /* create the mempool */
888 struct rte_mempool *
889 rte_mempool_create(const char *name, unsigned n, unsigned elt_size,
890         unsigned cache_size, unsigned private_data_size,
891         rte_mempool_ctor_t *mp_init, void *mp_init_arg,
892         rte_mempool_obj_cb_t *obj_init, void *obj_init_arg,
893         int socket_id, unsigned flags)
894 {
895         int ret;
896         struct rte_mempool *mp;
897
898         mp = rte_mempool_create_empty(name, n, elt_size, cache_size,
899                 private_data_size, socket_id, flags);
900         if (mp == NULL)
901                 return NULL;
902
903         /*
904          * Since we have 4 combinations of the SP/SC/MP/MC examine the flags to
905          * set the correct index into the table of ops structs.
906          */
907         if ((flags & MEMPOOL_F_SP_PUT) && (flags & MEMPOOL_F_SC_GET))
908                 ret = rte_mempool_set_ops_byname(mp, "ring_sp_sc", NULL);
909         else if (flags & MEMPOOL_F_SP_PUT)
910                 ret = rte_mempool_set_ops_byname(mp, "ring_sp_mc", NULL);
911         else if (flags & MEMPOOL_F_SC_GET)
912                 ret = rte_mempool_set_ops_byname(mp, "ring_mp_sc", NULL);
913         else
914                 ret = rte_mempool_set_ops_byname(mp, "ring_mp_mc", NULL);
915
916         if (ret)
917                 goto fail;
918
919         /* call the mempool priv initializer */
920         if (mp_init)
921                 mp_init(mp, mp_init_arg);
922
923         if (rte_mempool_populate_default(mp) < 0)
924                 goto fail;
925
926         /* call the object initializers */
927         if (obj_init)
928                 rte_mempool_obj_iter(mp, obj_init, obj_init_arg);
929
930         return mp;
931
932  fail:
933         rte_mempool_free(mp);
934         return NULL;
935 }
936
937 /* Return the number of entries in the mempool */
938 unsigned int
939 rte_mempool_avail_count(const struct rte_mempool *mp)
940 {
941         unsigned count;
942         unsigned lcore_id;
943
944         count = rte_mempool_ops_get_count(mp);
945
946         if (mp->cache_size == 0)
947                 return count;
948
949         for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++)
950                 count += mp->local_cache[lcore_id].len;
951
952         /*
953          * due to race condition (access to len is not locked), the
954          * total can be greater than size... so fix the result
955          */
956         if (count > mp->size)
957                 return mp->size;
958         return count;
959 }
960
961 /* return the number of entries allocated from the mempool */
962 unsigned int
963 rte_mempool_in_use_count(const struct rte_mempool *mp)
964 {
965         return mp->size - rte_mempool_avail_count(mp);
966 }
967
968 /* dump the cache status */
969 static unsigned
970 rte_mempool_dump_cache(FILE *f, const struct rte_mempool *mp)
971 {
972         unsigned lcore_id;
973         unsigned count = 0;
974         unsigned cache_count;
975
976         fprintf(f, "  internal cache infos:\n");
977         fprintf(f, "    cache_size=%"PRIu32"\n", mp->cache_size);
978
979         if (mp->cache_size == 0)
980                 return count;
981
982         for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
983                 cache_count = mp->local_cache[lcore_id].len;
984                 fprintf(f, "    cache_count[%u]=%"PRIu32"\n",
985                         lcore_id, cache_count);
986                 count += cache_count;
987         }
988         fprintf(f, "    total_cache_count=%u\n", count);
989         return count;
990 }
991
992 #ifndef __INTEL_COMPILER
993 #pragma GCC diagnostic ignored "-Wcast-qual"
994 #endif
995
996 /* check and update cookies or panic (internal) */
997 void rte_mempool_check_cookies(const struct rte_mempool *mp,
998         void * const *obj_table_const, unsigned n, int free)
999 {
1000 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
1001         struct rte_mempool_objhdr *hdr;
1002         struct rte_mempool_objtlr *tlr;
1003         uint64_t cookie;
1004         void *tmp;
1005         void *obj;
1006         void **obj_table;
1007
1008         /* Force to drop the "const" attribute. This is done only when
1009          * DEBUG is enabled */
1010         tmp = (void *) obj_table_const;
1011         obj_table = tmp;
1012
1013         while (n--) {
1014                 obj = obj_table[n];
1015
1016                 if (rte_mempool_from_obj(obj) != mp)
1017                         rte_panic("MEMPOOL: object is owned by another "
1018                                   "mempool\n");
1019
1020                 hdr = __mempool_get_header(obj);
1021                 cookie = hdr->cookie;
1022
1023                 if (free == 0) {
1024                         if (cookie != RTE_MEMPOOL_HEADER_COOKIE1) {
1025                                 RTE_LOG(CRIT, MEMPOOL,
1026                                         "obj=%p, mempool=%p, cookie=%" PRIx64 "\n",
1027                                         obj, (const void *) mp, cookie);
1028                                 rte_panic("MEMPOOL: bad header cookie (put)\n");
1029                         }
1030                         hdr->cookie = RTE_MEMPOOL_HEADER_COOKIE2;
1031                 } else if (free == 1) {
1032                         if (cookie != RTE_MEMPOOL_HEADER_COOKIE2) {
1033                                 RTE_LOG(CRIT, MEMPOOL,
1034                                         "obj=%p, mempool=%p, cookie=%" PRIx64 "\n",
1035                                         obj, (const void *) mp, cookie);
1036                                 rte_panic("MEMPOOL: bad header cookie (get)\n");
1037                         }
1038                         hdr->cookie = RTE_MEMPOOL_HEADER_COOKIE1;
1039                 } else if (free == 2) {
1040                         if (cookie != RTE_MEMPOOL_HEADER_COOKIE1 &&
1041                             cookie != RTE_MEMPOOL_HEADER_COOKIE2) {
1042                                 RTE_LOG(CRIT, MEMPOOL,
1043                                         "obj=%p, mempool=%p, cookie=%" PRIx64 "\n",
1044                                         obj, (const void *) mp, cookie);
1045                                 rte_panic("MEMPOOL: bad header cookie (audit)\n");
1046                         }
1047                 }
1048                 tlr = __mempool_get_trailer(obj);
1049                 cookie = tlr->cookie;
1050                 if (cookie != RTE_MEMPOOL_TRAILER_COOKIE) {
1051                         RTE_LOG(CRIT, MEMPOOL,
1052                                 "obj=%p, mempool=%p, cookie=%" PRIx64 "\n",
1053                                 obj, (const void *) mp, cookie);
1054                         rte_panic("MEMPOOL: bad trailer cookie\n");
1055                 }
1056         }
1057 #else
1058         RTE_SET_USED(mp);
1059         RTE_SET_USED(obj_table_const);
1060         RTE_SET_USED(n);
1061         RTE_SET_USED(free);
1062 #endif
1063 }
1064
1065 void
1066 rte_mempool_contig_blocks_check_cookies(const struct rte_mempool *mp,
1067         void * const *first_obj_table_const, unsigned int n, int free)
1068 {
1069 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
1070         struct rte_mempool_info info;
1071         const size_t total_elt_sz =
1072                 mp->header_size + mp->elt_size + mp->trailer_size;
1073         unsigned int i, j;
1074
1075         rte_mempool_ops_get_info(mp, &info);
1076
1077         for (i = 0; i < n; ++i) {
1078                 void *first_obj = first_obj_table_const[i];
1079
1080                 for (j = 0; j < info.contig_block_size; ++j) {
1081                         void *obj;
1082
1083                         obj = (void *)((uintptr_t)first_obj + j * total_elt_sz);
1084                         rte_mempool_check_cookies(mp, &obj, 1, free);
1085                 }
1086         }
1087 #else
1088         RTE_SET_USED(mp);
1089         RTE_SET_USED(first_obj_table_const);
1090         RTE_SET_USED(n);
1091         RTE_SET_USED(free);
1092 #endif
1093 }
1094
1095 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
1096 static void
1097 mempool_obj_audit(struct rte_mempool *mp, __rte_unused void *opaque,
1098         void *obj, __rte_unused unsigned idx)
1099 {
1100         __mempool_check_cookies(mp, &obj, 1, 2);
1101 }
1102
1103 static void
1104 mempool_audit_cookies(struct rte_mempool *mp)
1105 {
1106         unsigned num;
1107
1108         num = rte_mempool_obj_iter(mp, mempool_obj_audit, NULL);
1109         if (num != mp->size) {
1110                 rte_panic("rte_mempool_obj_iter(mempool=%p, size=%u) "
1111                         "iterated only over %u elements\n",
1112                         mp, mp->size, num);
1113         }
1114 }
1115 #else
1116 #define mempool_audit_cookies(mp) do {} while(0)
1117 #endif
1118
1119 #ifndef __INTEL_COMPILER
1120 #pragma GCC diagnostic error "-Wcast-qual"
1121 #endif
1122
1123 /* check cookies before and after objects */
1124 static void
1125 mempool_audit_cache(const struct rte_mempool *mp)
1126 {
1127         /* check cache size consistency */
1128         unsigned lcore_id;
1129
1130         if (mp->cache_size == 0)
1131                 return;
1132
1133         for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
1134                 const struct rte_mempool_cache *cache;
1135                 cache = &mp->local_cache[lcore_id];
1136                 if (cache->len > cache->flushthresh) {
1137                         RTE_LOG(CRIT, MEMPOOL, "badness on cache[%u]\n",
1138                                 lcore_id);
1139                         rte_panic("MEMPOOL: invalid cache len\n");
1140                 }
1141         }
1142 }
1143
1144 /* check the consistency of mempool (size, cookies, ...) */
1145 void
1146 rte_mempool_audit(struct rte_mempool *mp)
1147 {
1148         mempool_audit_cache(mp);
1149         mempool_audit_cookies(mp);
1150
1151         /* For case where mempool DEBUG is not set, and cache size is 0 */
1152         RTE_SET_USED(mp);
1153 }
1154
1155 /* dump the status of the mempool on the console */
1156 void
1157 rte_mempool_dump(FILE *f, struct rte_mempool *mp)
1158 {
1159 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
1160         struct rte_mempool_info info;
1161         struct rte_mempool_debug_stats sum;
1162         unsigned lcore_id;
1163 #endif
1164         struct rte_mempool_memhdr *memhdr;
1165         unsigned common_count;
1166         unsigned cache_count;
1167         size_t mem_len = 0;
1168
1169         RTE_ASSERT(f != NULL);
1170         RTE_ASSERT(mp != NULL);
1171
1172         fprintf(f, "mempool <%s>@%p\n", mp->name, mp);
1173         fprintf(f, "  flags=%x\n", mp->flags);
1174         fprintf(f, "  pool=%p\n", mp->pool_data);
1175         fprintf(f, "  iova=0x%" PRIx64 "\n", mp->mz->iova);
1176         fprintf(f, "  nb_mem_chunks=%u\n", mp->nb_mem_chunks);
1177         fprintf(f, "  size=%"PRIu32"\n", mp->size);
1178         fprintf(f, "  populated_size=%"PRIu32"\n", mp->populated_size);
1179         fprintf(f, "  header_size=%"PRIu32"\n", mp->header_size);
1180         fprintf(f, "  elt_size=%"PRIu32"\n", mp->elt_size);
1181         fprintf(f, "  trailer_size=%"PRIu32"\n", mp->trailer_size);
1182         fprintf(f, "  total_obj_size=%"PRIu32"\n",
1183                mp->header_size + mp->elt_size + mp->trailer_size);
1184
1185         fprintf(f, "  private_data_size=%"PRIu32"\n", mp->private_data_size);
1186
1187         STAILQ_FOREACH(memhdr, &mp->mem_list, next)
1188                 mem_len += memhdr->len;
1189         if (mem_len != 0) {
1190                 fprintf(f, "  avg bytes/object=%#Lf\n",
1191                         (long double)mem_len / mp->size);
1192         }
1193
1194         cache_count = rte_mempool_dump_cache(f, mp);
1195         common_count = rte_mempool_ops_get_count(mp);
1196         if ((cache_count + common_count) > mp->size)
1197                 common_count = mp->size - cache_count;
1198         fprintf(f, "  common_pool_count=%u\n", common_count);
1199
1200         /* sum and dump statistics */
1201 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
1202         rte_mempool_ops_get_info(mp, &info);
1203         memset(&sum, 0, sizeof(sum));
1204         for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
1205                 sum.put_bulk += mp->stats[lcore_id].put_bulk;
1206                 sum.put_objs += mp->stats[lcore_id].put_objs;
1207                 sum.get_success_bulk += mp->stats[lcore_id].get_success_bulk;
1208                 sum.get_success_objs += mp->stats[lcore_id].get_success_objs;
1209                 sum.get_fail_bulk += mp->stats[lcore_id].get_fail_bulk;
1210                 sum.get_fail_objs += mp->stats[lcore_id].get_fail_objs;
1211                 sum.get_success_blks += mp->stats[lcore_id].get_success_blks;
1212                 sum.get_fail_blks += mp->stats[lcore_id].get_fail_blks;
1213         }
1214         fprintf(f, "  stats:\n");
1215         fprintf(f, "    put_bulk=%"PRIu64"\n", sum.put_bulk);
1216         fprintf(f, "    put_objs=%"PRIu64"\n", sum.put_objs);
1217         fprintf(f, "    get_success_bulk=%"PRIu64"\n", sum.get_success_bulk);
1218         fprintf(f, "    get_success_objs=%"PRIu64"\n", sum.get_success_objs);
1219         fprintf(f, "    get_fail_bulk=%"PRIu64"\n", sum.get_fail_bulk);
1220         fprintf(f, "    get_fail_objs=%"PRIu64"\n", sum.get_fail_objs);
1221         if (info.contig_block_size > 0) {
1222                 fprintf(f, "    get_success_blks=%"PRIu64"\n",
1223                         sum.get_success_blks);
1224                 fprintf(f, "    get_fail_blks=%"PRIu64"\n", sum.get_fail_blks);
1225         }
1226 #else
1227         fprintf(f, "  no statistics available\n");
1228 #endif
1229
1230         rte_mempool_audit(mp);
1231 }
1232
1233 /* dump the status of all mempools on the console */
1234 void
1235 rte_mempool_list_dump(FILE *f)
1236 {
1237         struct rte_mempool *mp = NULL;
1238         struct rte_tailq_entry *te;
1239         struct rte_mempool_list *mempool_list;
1240
1241         mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
1242
1243         rte_mcfg_mempool_read_lock();
1244
1245         TAILQ_FOREACH(te, mempool_list, next) {
1246                 mp = (struct rte_mempool *) te->data;
1247                 rte_mempool_dump(f, mp);
1248         }
1249
1250         rte_mcfg_mempool_read_unlock();
1251 }
1252
1253 /* search a mempool from its name */
1254 struct rte_mempool *
1255 rte_mempool_lookup(const char *name)
1256 {
1257         struct rte_mempool *mp = NULL;
1258         struct rte_tailq_entry *te;
1259         struct rte_mempool_list *mempool_list;
1260
1261         mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
1262
1263         rte_mcfg_mempool_read_lock();
1264
1265         TAILQ_FOREACH(te, mempool_list, next) {
1266                 mp = (struct rte_mempool *) te->data;
1267                 if (strncmp(name, mp->name, RTE_MEMPOOL_NAMESIZE) == 0)
1268                         break;
1269         }
1270
1271         rte_mcfg_mempool_read_unlock();
1272
1273         if (te == NULL) {
1274                 rte_errno = ENOENT;
1275                 return NULL;
1276         }
1277
1278         return mp;
1279 }
1280
1281 void rte_mempool_walk(void (*func)(struct rte_mempool *, void *),
1282                       void *arg)
1283 {
1284         struct rte_tailq_entry *te = NULL;
1285         struct rte_mempool_list *mempool_list;
1286         void *tmp_te;
1287
1288         mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
1289
1290         rte_mcfg_mempool_read_lock();
1291
1292         TAILQ_FOREACH_SAFE(te, mempool_list, next, tmp_te) {
1293                 (*func)((struct rte_mempool *) te->data, arg);
1294         }
1295
1296         rte_mcfg_mempool_read_unlock();
1297 }