213e574fc1a6ac48d90472e197462f1298276104
[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 /* Default function to populate the mempool: allocate memory in memzones,
418  * and populate them. Return the number of objects added, or a negative
419  * value on error.
420  */
421 int
422 rte_mempool_populate_default(struct rte_mempool *mp)
423 {
424         unsigned int mz_flags = RTE_MEMZONE_1GB|RTE_MEMZONE_SIZE_HINT_ONLY;
425         char mz_name[RTE_MEMZONE_NAMESIZE];
426         const struct rte_memzone *mz;
427         ssize_t mem_size;
428         size_t align, pg_sz, pg_shift;
429         rte_iova_t iova;
430         unsigned mz_id, n;
431         int ret;
432         bool need_iova_contig_obj;
433         bool alloc_in_ext_mem;
434
435         ret = mempool_ops_alloc_once(mp);
436         if (ret != 0)
437                 return ret;
438
439         /* mempool must not be populated */
440         if (mp->nb_mem_chunks != 0)
441                 return -EEXIST;
442
443         /*
444          * the following section calculates page shift and page size values.
445          *
446          * these values impact the result of calc_mem_size operation, which
447          * returns the amount of memory that should be allocated to store the
448          * desired number of objects. when not zero, it allocates more memory
449          * for the padding between objects, to ensure that an object does not
450          * cross a page boundary. in other words, page size/shift are to be set
451          * to zero if mempool elements won't care about page boundaries.
452          * there are several considerations for page size and page shift here.
453          *
454          * if we don't need our mempools to have physically contiguous objects,
455          * then just set page shift and page size to 0, because the user has
456          * indicated that there's no need to care about anything.
457          *
458          * if we do need contiguous objects, there is also an option to reserve
459          * the entire mempool memory as one contiguous block of memory, in
460          * which case the page shift and alignment wouldn't matter as well.
461          *
462          * if we require contiguous objects, but not necessarily the entire
463          * mempool reserved space to be contiguous, then there are two options.
464          *
465          * if our IO addresses are virtual, not actual physical (IOVA as VA
466          * case), then no page shift needed - our memory allocation will give us
467          * contiguous IO memory as far as the hardware is concerned, so
468          * act as if we're getting contiguous memory.
469          *
470          * if our IO addresses are physical, we may get memory from bigger
471          * pages, or we might get memory from smaller pages, and how much of it
472          * we require depends on whether we want bigger or smaller pages.
473          * However, requesting each and every memory size is too much work, so
474          * what we'll do instead is walk through the page sizes available, pick
475          * the smallest one and set up page shift to match that one. We will be
476          * wasting some space this way, but it's much nicer than looping around
477          * trying to reserve each and every page size.
478          *
479          * If we fail to get enough contiguous memory, then we'll go and
480          * reserve space in smaller chunks.
481          *
482          * We also have to take into account the fact that memory that we're
483          * going to allocate from can belong to an externally allocated memory
484          * area, in which case the assumption of IOVA as VA mode being
485          * synonymous with IOVA contiguousness will not hold.
486          */
487
488         /* check if we can retrieve a valid socket ID */
489         ret = rte_malloc_heap_socket_is_external(mp->socket_id);
490         if (ret < 0)
491                 return -EINVAL;
492         alloc_in_ext_mem = (ret == 1);
493         need_iova_contig_obj = !(mp->flags & MEMPOOL_F_NO_IOVA_CONTIG);
494
495         if (!need_iova_contig_obj) {
496                 pg_sz = 0;
497                 pg_shift = 0;
498         } else if (!alloc_in_ext_mem && rte_eal_iova_mode() == RTE_IOVA_VA) {
499                 pg_sz = 0;
500                 pg_shift = 0;
501         } else if (rte_eal_has_hugepages() || alloc_in_ext_mem) {
502                 pg_sz = get_min_page_size(mp->socket_id);
503                 pg_shift = rte_bsf32(pg_sz);
504         } else {
505                 pg_sz = getpagesize();
506                 pg_shift = rte_bsf32(pg_sz);
507         }
508
509         for (mz_id = 0, n = mp->size; n > 0; mz_id++, n -= ret) {
510                 size_t min_chunk_size;
511
512                 mem_size = rte_mempool_ops_calc_mem_size(
513                         mp, n, pg_shift, &min_chunk_size, &align);
514
515                 if (mem_size < 0) {
516                         ret = mem_size;
517                         goto fail;
518                 }
519
520                 ret = snprintf(mz_name, sizeof(mz_name),
521                         RTE_MEMPOOL_MZ_FORMAT "_%d", mp->name, mz_id);
522                 if (ret < 0 || ret >= (int)sizeof(mz_name)) {
523                         ret = -ENAMETOOLONG;
524                         goto fail;
525                 }
526
527                 /* if we're trying to reserve contiguous memory, add appropriate
528                  * memzone flag.
529                  */
530                 if (min_chunk_size == (size_t)mem_size)
531                         mz_flags |= RTE_MEMZONE_IOVA_CONTIG;
532
533                 mz = rte_memzone_reserve_aligned(mz_name, mem_size,
534                                 mp->socket_id, mz_flags, align);
535
536                 /* don't try reserving with 0 size if we were asked to reserve
537                  * IOVA-contiguous memory.
538                  */
539                 if (min_chunk_size < (size_t)mem_size && mz == NULL) {
540                         /* not enough memory, retry with the biggest zone we
541                          * have
542                          */
543                         mz = rte_memzone_reserve_aligned(mz_name, 0,
544                                         mp->socket_id, mz_flags, align);
545                 }
546                 if (mz == NULL) {
547                         ret = -rte_errno;
548                         goto fail;
549                 }
550
551                 if (mz->len < min_chunk_size) {
552                         rte_memzone_free(mz);
553                         ret = -ENOMEM;
554                         goto fail;
555                 }
556
557                 if (need_iova_contig_obj)
558                         iova = mz->iova;
559                 else
560                         iova = RTE_BAD_IOVA;
561
562                 if (pg_sz == 0 || (mz_flags & RTE_MEMZONE_IOVA_CONTIG))
563                         ret = rte_mempool_populate_iova(mp, mz->addr,
564                                 iova, mz->len,
565                                 rte_mempool_memchunk_mz_free,
566                                 (void *)(uintptr_t)mz);
567                 else
568                         ret = rte_mempool_populate_virt(mp, mz->addr,
569                                 mz->len, pg_sz,
570                                 rte_mempool_memchunk_mz_free,
571                                 (void *)(uintptr_t)mz);
572                 if (ret < 0) {
573                         rte_memzone_free(mz);
574                         goto fail;
575                 }
576         }
577
578         return mp->size;
579
580  fail:
581         rte_mempool_free_memchunks(mp);
582         return ret;
583 }
584
585 /* return the memory size required for mempool objects in anonymous mem */
586 static ssize_t
587 get_anon_size(const struct rte_mempool *mp)
588 {
589         ssize_t size;
590         size_t pg_sz, pg_shift;
591         size_t min_chunk_size;
592         size_t align;
593
594         pg_sz = getpagesize();
595         pg_shift = rte_bsf32(pg_sz);
596         size = rte_mempool_ops_calc_mem_size(mp, mp->size, pg_shift,
597                                              &min_chunk_size, &align);
598
599         return size;
600 }
601
602 /* unmap a memory zone mapped by rte_mempool_populate_anon() */
603 static void
604 rte_mempool_memchunk_anon_free(struct rte_mempool_memhdr *memhdr,
605         void *opaque)
606 {
607         ssize_t size;
608
609         /*
610          * Calculate size since memhdr->len has contiguous chunk length
611          * which may be smaller if anon map is split into many contiguous
612          * chunks. Result must be the same as we calculated on populate.
613          */
614         size = get_anon_size(memhdr->mp);
615         if (size < 0)
616                 return;
617
618         munmap(opaque, size);
619 }
620
621 /* populate the mempool with an anonymous mapping */
622 int
623 rte_mempool_populate_anon(struct rte_mempool *mp)
624 {
625         ssize_t size;
626         int ret;
627         char *addr;
628
629         /* mempool is already populated, error */
630         if ((!STAILQ_EMPTY(&mp->mem_list)) || mp->nb_mem_chunks != 0) {
631                 rte_errno = EINVAL;
632                 return 0;
633         }
634
635         ret = mempool_ops_alloc_once(mp);
636         if (ret != 0)
637                 return ret;
638
639         size = get_anon_size(mp);
640         if (size < 0) {
641                 rte_errno = -size;
642                 return 0;
643         }
644
645         /* get chunk of virtually continuous memory */
646         addr = mmap(NULL, size, PROT_READ | PROT_WRITE,
647                 MAP_SHARED | MAP_ANONYMOUS, -1, 0);
648         if (addr == MAP_FAILED) {
649                 rte_errno = errno;
650                 return 0;
651         }
652         /* can't use MMAP_LOCKED, it does not exist on BSD */
653         if (mlock(addr, size) < 0) {
654                 rte_errno = errno;
655                 munmap(addr, size);
656                 return 0;
657         }
658
659         ret = rte_mempool_populate_virt(mp, addr, size, getpagesize(),
660                 rte_mempool_memchunk_anon_free, addr);
661         if (ret == 0)
662                 goto fail;
663
664         return mp->populated_size;
665
666  fail:
667         rte_mempool_free_memchunks(mp);
668         return 0;
669 }
670
671 /* free a mempool */
672 void
673 rte_mempool_free(struct rte_mempool *mp)
674 {
675         struct rte_mempool_list *mempool_list = NULL;
676         struct rte_tailq_entry *te;
677
678         if (mp == NULL)
679                 return;
680
681         mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
682         rte_mcfg_tailq_write_lock();
683         /* find out tailq entry */
684         TAILQ_FOREACH(te, mempool_list, next) {
685                 if (te->data == (void *)mp)
686                         break;
687         }
688
689         if (te != NULL) {
690                 TAILQ_REMOVE(mempool_list, te, next);
691                 rte_free(te);
692         }
693         rte_mcfg_tailq_write_unlock();
694
695         rte_mempool_free_memchunks(mp);
696         rte_mempool_ops_free(mp);
697         rte_memzone_free(mp->mz);
698 }
699
700 static void
701 mempool_cache_init(struct rte_mempool_cache *cache, uint32_t size)
702 {
703         cache->size = size;
704         cache->flushthresh = CALC_CACHE_FLUSHTHRESH(size);
705         cache->len = 0;
706 }
707
708 /*
709  * Create and initialize a cache for objects that are retrieved from and
710  * returned to an underlying mempool. This structure is identical to the
711  * local_cache[lcore_id] pointed to by the mempool structure.
712  */
713 struct rte_mempool_cache *
714 rte_mempool_cache_create(uint32_t size, int socket_id)
715 {
716         struct rte_mempool_cache *cache;
717
718         if (size == 0 || size > RTE_MEMPOOL_CACHE_MAX_SIZE) {
719                 rte_errno = EINVAL;
720                 return NULL;
721         }
722
723         cache = rte_zmalloc_socket("MEMPOOL_CACHE", sizeof(*cache),
724                                   RTE_CACHE_LINE_SIZE, socket_id);
725         if (cache == NULL) {
726                 RTE_LOG(ERR, MEMPOOL, "Cannot allocate mempool cache.\n");
727                 rte_errno = ENOMEM;
728                 return NULL;
729         }
730
731         mempool_cache_init(cache, size);
732
733         return cache;
734 }
735
736 /*
737  * Free a cache. It's the responsibility of the user to make sure that any
738  * remaining objects in the cache are flushed to the corresponding
739  * mempool.
740  */
741 void
742 rte_mempool_cache_free(struct rte_mempool_cache *cache)
743 {
744         rte_free(cache);
745 }
746
747 /* create an empty mempool */
748 struct rte_mempool *
749 rte_mempool_create_empty(const char *name, unsigned n, unsigned elt_size,
750         unsigned cache_size, unsigned private_data_size,
751         int socket_id, unsigned flags)
752 {
753         char mz_name[RTE_MEMZONE_NAMESIZE];
754         struct rte_mempool_list *mempool_list;
755         struct rte_mempool *mp = NULL;
756         struct rte_tailq_entry *te = NULL;
757         const struct rte_memzone *mz = NULL;
758         size_t mempool_size;
759         unsigned int mz_flags = RTE_MEMZONE_1GB|RTE_MEMZONE_SIZE_HINT_ONLY;
760         struct rte_mempool_objsz objsz;
761         unsigned lcore_id;
762         int ret;
763
764         /* compilation-time checks */
765         RTE_BUILD_BUG_ON((sizeof(struct rte_mempool) &
766                           RTE_CACHE_LINE_MASK) != 0);
767         RTE_BUILD_BUG_ON((sizeof(struct rte_mempool_cache) &
768                           RTE_CACHE_LINE_MASK) != 0);
769 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
770         RTE_BUILD_BUG_ON((sizeof(struct rte_mempool_debug_stats) &
771                           RTE_CACHE_LINE_MASK) != 0);
772         RTE_BUILD_BUG_ON((offsetof(struct rte_mempool, stats) &
773                           RTE_CACHE_LINE_MASK) != 0);
774 #endif
775
776         mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
777
778         /* asked for zero items */
779         if (n == 0) {
780                 rte_errno = EINVAL;
781                 return NULL;
782         }
783
784         /* asked cache too big */
785         if (cache_size > RTE_MEMPOOL_CACHE_MAX_SIZE ||
786             CALC_CACHE_FLUSHTHRESH(cache_size) > n) {
787                 rte_errno = EINVAL;
788                 return NULL;
789         }
790
791         /* "no cache align" imply "no spread" */
792         if (flags & MEMPOOL_F_NO_CACHE_ALIGN)
793                 flags |= MEMPOOL_F_NO_SPREAD;
794
795         /* calculate mempool object sizes. */
796         if (!rte_mempool_calc_obj_size(elt_size, flags, &objsz)) {
797                 rte_errno = EINVAL;
798                 return NULL;
799         }
800
801         rte_mcfg_mempool_write_lock();
802
803         /*
804          * reserve a memory zone for this mempool: private data is
805          * cache-aligned
806          */
807         private_data_size = (private_data_size +
808                              RTE_MEMPOOL_ALIGN_MASK) & (~RTE_MEMPOOL_ALIGN_MASK);
809
810
811         /* try to allocate tailq entry */
812         te = rte_zmalloc("MEMPOOL_TAILQ_ENTRY", sizeof(*te), 0);
813         if (te == NULL) {
814                 RTE_LOG(ERR, MEMPOOL, "Cannot allocate tailq entry!\n");
815                 goto exit_unlock;
816         }
817
818         mempool_size = MEMPOOL_HEADER_SIZE(mp, cache_size);
819         mempool_size += private_data_size;
820         mempool_size = RTE_ALIGN_CEIL(mempool_size, RTE_MEMPOOL_ALIGN);
821
822         ret = snprintf(mz_name, sizeof(mz_name), RTE_MEMPOOL_MZ_FORMAT, name);
823         if (ret < 0 || ret >= (int)sizeof(mz_name)) {
824                 rte_errno = ENAMETOOLONG;
825                 goto exit_unlock;
826         }
827
828         mz = rte_memzone_reserve(mz_name, mempool_size, socket_id, mz_flags);
829         if (mz == NULL)
830                 goto exit_unlock;
831
832         /* init the mempool structure */
833         mp = mz->addr;
834         memset(mp, 0, MEMPOOL_HEADER_SIZE(mp, cache_size));
835         ret = strlcpy(mp->name, name, sizeof(mp->name));
836         if (ret < 0 || ret >= (int)sizeof(mp->name)) {
837                 rte_errno = ENAMETOOLONG;
838                 goto exit_unlock;
839         }
840         mp->mz = mz;
841         mp->size = n;
842         mp->flags = flags;
843         mp->socket_id = socket_id;
844         mp->elt_size = objsz.elt_size;
845         mp->header_size = objsz.header_size;
846         mp->trailer_size = objsz.trailer_size;
847         /* Size of default caches, zero means disabled. */
848         mp->cache_size = cache_size;
849         mp->private_data_size = private_data_size;
850         STAILQ_INIT(&mp->elt_list);
851         STAILQ_INIT(&mp->mem_list);
852
853         /*
854          * local_cache pointer is set even if cache_size is zero.
855          * The local_cache points to just past the elt_pa[] array.
856          */
857         mp->local_cache = (struct rte_mempool_cache *)
858                 RTE_PTR_ADD(mp, MEMPOOL_HEADER_SIZE(mp, 0));
859
860         /* Init all default caches. */
861         if (cache_size != 0) {
862                 for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++)
863                         mempool_cache_init(&mp->local_cache[lcore_id],
864                                            cache_size);
865         }
866
867         te->data = mp;
868
869         rte_mcfg_tailq_write_lock();
870         TAILQ_INSERT_TAIL(mempool_list, te, next);
871         rte_mcfg_tailq_write_unlock();
872         rte_mcfg_mempool_write_unlock();
873
874         return mp;
875
876 exit_unlock:
877         rte_mcfg_mempool_write_unlock();
878         rte_free(te);
879         rte_mempool_free(mp);
880         return NULL;
881 }
882
883 /* create the mempool */
884 struct rte_mempool *
885 rte_mempool_create(const char *name, unsigned n, unsigned elt_size,
886         unsigned cache_size, unsigned private_data_size,
887         rte_mempool_ctor_t *mp_init, void *mp_init_arg,
888         rte_mempool_obj_cb_t *obj_init, void *obj_init_arg,
889         int socket_id, unsigned flags)
890 {
891         int ret;
892         struct rte_mempool *mp;
893
894         mp = rte_mempool_create_empty(name, n, elt_size, cache_size,
895                 private_data_size, socket_id, flags);
896         if (mp == NULL)
897                 return NULL;
898
899         /*
900          * Since we have 4 combinations of the SP/SC/MP/MC examine the flags to
901          * set the correct index into the table of ops structs.
902          */
903         if ((flags & MEMPOOL_F_SP_PUT) && (flags & MEMPOOL_F_SC_GET))
904                 ret = rte_mempool_set_ops_byname(mp, "ring_sp_sc", NULL);
905         else if (flags & MEMPOOL_F_SP_PUT)
906                 ret = rte_mempool_set_ops_byname(mp, "ring_sp_mc", NULL);
907         else if (flags & MEMPOOL_F_SC_GET)
908                 ret = rte_mempool_set_ops_byname(mp, "ring_mp_sc", NULL);
909         else
910                 ret = rte_mempool_set_ops_byname(mp, "ring_mp_mc", NULL);
911
912         if (ret)
913                 goto fail;
914
915         /* call the mempool priv initializer */
916         if (mp_init)
917                 mp_init(mp, mp_init_arg);
918
919         if (rte_mempool_populate_default(mp) < 0)
920                 goto fail;
921
922         /* call the object initializers */
923         if (obj_init)
924                 rte_mempool_obj_iter(mp, obj_init, obj_init_arg);
925
926         return mp;
927
928  fail:
929         rte_mempool_free(mp);
930         return NULL;
931 }
932
933 /* Return the number of entries in the mempool */
934 unsigned int
935 rte_mempool_avail_count(const struct rte_mempool *mp)
936 {
937         unsigned count;
938         unsigned lcore_id;
939
940         count = rte_mempool_ops_get_count(mp);
941
942         if (mp->cache_size == 0)
943                 return count;
944
945         for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++)
946                 count += mp->local_cache[lcore_id].len;
947
948         /*
949          * due to race condition (access to len is not locked), the
950          * total can be greater than size... so fix the result
951          */
952         if (count > mp->size)
953                 return mp->size;
954         return count;
955 }
956
957 /* return the number of entries allocated from the mempool */
958 unsigned int
959 rte_mempool_in_use_count(const struct rte_mempool *mp)
960 {
961         return mp->size - rte_mempool_avail_count(mp);
962 }
963
964 /* dump the cache status */
965 static unsigned
966 rte_mempool_dump_cache(FILE *f, const struct rte_mempool *mp)
967 {
968         unsigned lcore_id;
969         unsigned count = 0;
970         unsigned cache_count;
971
972         fprintf(f, "  internal cache infos:\n");
973         fprintf(f, "    cache_size=%"PRIu32"\n", mp->cache_size);
974
975         if (mp->cache_size == 0)
976                 return count;
977
978         for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
979                 cache_count = mp->local_cache[lcore_id].len;
980                 fprintf(f, "    cache_count[%u]=%"PRIu32"\n",
981                         lcore_id, cache_count);
982                 count += cache_count;
983         }
984         fprintf(f, "    total_cache_count=%u\n", count);
985         return count;
986 }
987
988 #ifndef __INTEL_COMPILER
989 #pragma GCC diagnostic ignored "-Wcast-qual"
990 #endif
991
992 /* check and update cookies or panic (internal) */
993 void rte_mempool_check_cookies(const struct rte_mempool *mp,
994         void * const *obj_table_const, unsigned n, int free)
995 {
996 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
997         struct rte_mempool_objhdr *hdr;
998         struct rte_mempool_objtlr *tlr;
999         uint64_t cookie;
1000         void *tmp;
1001         void *obj;
1002         void **obj_table;
1003
1004         /* Force to drop the "const" attribute. This is done only when
1005          * DEBUG is enabled */
1006         tmp = (void *) obj_table_const;
1007         obj_table = tmp;
1008
1009         while (n--) {
1010                 obj = obj_table[n];
1011
1012                 if (rte_mempool_from_obj(obj) != mp)
1013                         rte_panic("MEMPOOL: object is owned by another "
1014                                   "mempool\n");
1015
1016                 hdr = __mempool_get_header(obj);
1017                 cookie = hdr->cookie;
1018
1019                 if (free == 0) {
1020                         if (cookie != RTE_MEMPOOL_HEADER_COOKIE1) {
1021                                 RTE_LOG(CRIT, MEMPOOL,
1022                                         "obj=%p, mempool=%p, cookie=%" PRIx64 "\n",
1023                                         obj, (const void *) mp, cookie);
1024                                 rte_panic("MEMPOOL: bad header cookie (put)\n");
1025                         }
1026                         hdr->cookie = RTE_MEMPOOL_HEADER_COOKIE2;
1027                 } else if (free == 1) {
1028                         if (cookie != RTE_MEMPOOL_HEADER_COOKIE2) {
1029                                 RTE_LOG(CRIT, MEMPOOL,
1030                                         "obj=%p, mempool=%p, cookie=%" PRIx64 "\n",
1031                                         obj, (const void *) mp, cookie);
1032                                 rte_panic("MEMPOOL: bad header cookie (get)\n");
1033                         }
1034                         hdr->cookie = RTE_MEMPOOL_HEADER_COOKIE1;
1035                 } else if (free == 2) {
1036                         if (cookie != RTE_MEMPOOL_HEADER_COOKIE1 &&
1037                             cookie != RTE_MEMPOOL_HEADER_COOKIE2) {
1038                                 RTE_LOG(CRIT, MEMPOOL,
1039                                         "obj=%p, mempool=%p, cookie=%" PRIx64 "\n",
1040                                         obj, (const void *) mp, cookie);
1041                                 rte_panic("MEMPOOL: bad header cookie (audit)\n");
1042                         }
1043                 }
1044                 tlr = __mempool_get_trailer(obj);
1045                 cookie = tlr->cookie;
1046                 if (cookie != RTE_MEMPOOL_TRAILER_COOKIE) {
1047                         RTE_LOG(CRIT, MEMPOOL,
1048                                 "obj=%p, mempool=%p, cookie=%" PRIx64 "\n",
1049                                 obj, (const void *) mp, cookie);
1050                         rte_panic("MEMPOOL: bad trailer cookie\n");
1051                 }
1052         }
1053 #else
1054         RTE_SET_USED(mp);
1055         RTE_SET_USED(obj_table_const);
1056         RTE_SET_USED(n);
1057         RTE_SET_USED(free);
1058 #endif
1059 }
1060
1061 void
1062 rte_mempool_contig_blocks_check_cookies(const struct rte_mempool *mp,
1063         void * const *first_obj_table_const, unsigned int n, int free)
1064 {
1065 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
1066         struct rte_mempool_info info;
1067         const size_t total_elt_sz =
1068                 mp->header_size + mp->elt_size + mp->trailer_size;
1069         unsigned int i, j;
1070
1071         rte_mempool_ops_get_info(mp, &info);
1072
1073         for (i = 0; i < n; ++i) {
1074                 void *first_obj = first_obj_table_const[i];
1075
1076                 for (j = 0; j < info.contig_block_size; ++j) {
1077                         void *obj;
1078
1079                         obj = (void *)((uintptr_t)first_obj + j * total_elt_sz);
1080                         rte_mempool_check_cookies(mp, &obj, 1, free);
1081                 }
1082         }
1083 #else
1084         RTE_SET_USED(mp);
1085         RTE_SET_USED(first_obj_table_const);
1086         RTE_SET_USED(n);
1087         RTE_SET_USED(free);
1088 #endif
1089 }
1090
1091 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
1092 static void
1093 mempool_obj_audit(struct rte_mempool *mp, __rte_unused void *opaque,
1094         void *obj, __rte_unused unsigned idx)
1095 {
1096         __mempool_check_cookies(mp, &obj, 1, 2);
1097 }
1098
1099 static void
1100 mempool_audit_cookies(struct rte_mempool *mp)
1101 {
1102         unsigned num;
1103
1104         num = rte_mempool_obj_iter(mp, mempool_obj_audit, NULL);
1105         if (num != mp->size) {
1106                 rte_panic("rte_mempool_obj_iter(mempool=%p, size=%u) "
1107                         "iterated only over %u elements\n",
1108                         mp, mp->size, num);
1109         }
1110 }
1111 #else
1112 #define mempool_audit_cookies(mp) do {} while(0)
1113 #endif
1114
1115 #ifndef __INTEL_COMPILER
1116 #pragma GCC diagnostic error "-Wcast-qual"
1117 #endif
1118
1119 /* check cookies before and after objects */
1120 static void
1121 mempool_audit_cache(const struct rte_mempool *mp)
1122 {
1123         /* check cache size consistency */
1124         unsigned lcore_id;
1125
1126         if (mp->cache_size == 0)
1127                 return;
1128
1129         for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
1130                 const struct rte_mempool_cache *cache;
1131                 cache = &mp->local_cache[lcore_id];
1132                 if (cache->len > cache->flushthresh) {
1133                         RTE_LOG(CRIT, MEMPOOL, "badness on cache[%u]\n",
1134                                 lcore_id);
1135                         rte_panic("MEMPOOL: invalid cache len\n");
1136                 }
1137         }
1138 }
1139
1140 /* check the consistency of mempool (size, cookies, ...) */
1141 void
1142 rte_mempool_audit(struct rte_mempool *mp)
1143 {
1144         mempool_audit_cache(mp);
1145         mempool_audit_cookies(mp);
1146
1147         /* For case where mempool DEBUG is not set, and cache size is 0 */
1148         RTE_SET_USED(mp);
1149 }
1150
1151 /* dump the status of the mempool on the console */
1152 void
1153 rte_mempool_dump(FILE *f, struct rte_mempool *mp)
1154 {
1155 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
1156         struct rte_mempool_info info;
1157         struct rte_mempool_debug_stats sum;
1158         unsigned lcore_id;
1159 #endif
1160         struct rte_mempool_memhdr *memhdr;
1161         unsigned common_count;
1162         unsigned cache_count;
1163         size_t mem_len = 0;
1164
1165         RTE_ASSERT(f != NULL);
1166         RTE_ASSERT(mp != NULL);
1167
1168         fprintf(f, "mempool <%s>@%p\n", mp->name, mp);
1169         fprintf(f, "  flags=%x\n", mp->flags);
1170         fprintf(f, "  pool=%p\n", mp->pool_data);
1171         fprintf(f, "  iova=0x%" PRIx64 "\n", mp->mz->iova);
1172         fprintf(f, "  nb_mem_chunks=%u\n", mp->nb_mem_chunks);
1173         fprintf(f, "  size=%"PRIu32"\n", mp->size);
1174         fprintf(f, "  populated_size=%"PRIu32"\n", mp->populated_size);
1175         fprintf(f, "  header_size=%"PRIu32"\n", mp->header_size);
1176         fprintf(f, "  elt_size=%"PRIu32"\n", mp->elt_size);
1177         fprintf(f, "  trailer_size=%"PRIu32"\n", mp->trailer_size);
1178         fprintf(f, "  total_obj_size=%"PRIu32"\n",
1179                mp->header_size + mp->elt_size + mp->trailer_size);
1180
1181         fprintf(f, "  private_data_size=%"PRIu32"\n", mp->private_data_size);
1182
1183         STAILQ_FOREACH(memhdr, &mp->mem_list, next)
1184                 mem_len += memhdr->len;
1185         if (mem_len != 0) {
1186                 fprintf(f, "  avg bytes/object=%#Lf\n",
1187                         (long double)mem_len / mp->size);
1188         }
1189
1190         cache_count = rte_mempool_dump_cache(f, mp);
1191         common_count = rte_mempool_ops_get_count(mp);
1192         if ((cache_count + common_count) > mp->size)
1193                 common_count = mp->size - cache_count;
1194         fprintf(f, "  common_pool_count=%u\n", common_count);
1195
1196         /* sum and dump statistics */
1197 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
1198         rte_mempool_ops_get_info(mp, &info);
1199         memset(&sum, 0, sizeof(sum));
1200         for (lcore_id = 0; lcore_id < RTE_MAX_LCORE; lcore_id++) {
1201                 sum.put_bulk += mp->stats[lcore_id].put_bulk;
1202                 sum.put_objs += mp->stats[lcore_id].put_objs;
1203                 sum.get_success_bulk += mp->stats[lcore_id].get_success_bulk;
1204                 sum.get_success_objs += mp->stats[lcore_id].get_success_objs;
1205                 sum.get_fail_bulk += mp->stats[lcore_id].get_fail_bulk;
1206                 sum.get_fail_objs += mp->stats[lcore_id].get_fail_objs;
1207                 sum.get_success_blks += mp->stats[lcore_id].get_success_blks;
1208                 sum.get_fail_blks += mp->stats[lcore_id].get_fail_blks;
1209         }
1210         fprintf(f, "  stats:\n");
1211         fprintf(f, "    put_bulk=%"PRIu64"\n", sum.put_bulk);
1212         fprintf(f, "    put_objs=%"PRIu64"\n", sum.put_objs);
1213         fprintf(f, "    get_success_bulk=%"PRIu64"\n", sum.get_success_bulk);
1214         fprintf(f, "    get_success_objs=%"PRIu64"\n", sum.get_success_objs);
1215         fprintf(f, "    get_fail_bulk=%"PRIu64"\n", sum.get_fail_bulk);
1216         fprintf(f, "    get_fail_objs=%"PRIu64"\n", sum.get_fail_objs);
1217         if (info.contig_block_size > 0) {
1218                 fprintf(f, "    get_success_blks=%"PRIu64"\n",
1219                         sum.get_success_blks);
1220                 fprintf(f, "    get_fail_blks=%"PRIu64"\n", sum.get_fail_blks);
1221         }
1222 #else
1223         fprintf(f, "  no statistics available\n");
1224 #endif
1225
1226         rte_mempool_audit(mp);
1227 }
1228
1229 /* dump the status of all mempools on the console */
1230 void
1231 rte_mempool_list_dump(FILE *f)
1232 {
1233         struct rte_mempool *mp = NULL;
1234         struct rte_tailq_entry *te;
1235         struct rte_mempool_list *mempool_list;
1236
1237         mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
1238
1239         rte_mcfg_mempool_read_lock();
1240
1241         TAILQ_FOREACH(te, mempool_list, next) {
1242                 mp = (struct rte_mempool *) te->data;
1243                 rte_mempool_dump(f, mp);
1244         }
1245
1246         rte_mcfg_mempool_read_unlock();
1247 }
1248
1249 /* search a mempool from its name */
1250 struct rte_mempool *
1251 rte_mempool_lookup(const char *name)
1252 {
1253         struct rte_mempool *mp = NULL;
1254         struct rte_tailq_entry *te;
1255         struct rte_mempool_list *mempool_list;
1256
1257         mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
1258
1259         rte_mcfg_mempool_read_lock();
1260
1261         TAILQ_FOREACH(te, mempool_list, next) {
1262                 mp = (struct rte_mempool *) te->data;
1263                 if (strncmp(name, mp->name, RTE_MEMPOOL_NAMESIZE) == 0)
1264                         break;
1265         }
1266
1267         rte_mcfg_mempool_read_unlock();
1268
1269         if (te == NULL) {
1270                 rte_errno = ENOENT;
1271                 return NULL;
1272         }
1273
1274         return mp;
1275 }
1276
1277 void rte_mempool_walk(void (*func)(struct rte_mempool *, void *),
1278                       void *arg)
1279 {
1280         struct rte_tailq_entry *te = NULL;
1281         struct rte_mempool_list *mempool_list;
1282         void *tmp_te;
1283
1284         mempool_list = RTE_TAILQ_CAST(rte_mempool_tailq.head, rte_mempool_list);
1285
1286         rte_mcfg_mempool_read_lock();
1287
1288         TAILQ_FOREACH_SAFE(te, mempool_list, next, tmp_te) {
1289                 (*func)((struct rte_mempool *) te->data, arg);
1290         }
1291
1292         rte_mcfg_mempool_read_unlock();
1293 }