DPDK  22.11.7-rc1
rte_mempool.h
Go to the documentation of this file.
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2010-2014 Intel Corporation.
3  * Copyright(c) 2016 6WIND S.A.
4  * Copyright(c) 2022 SmartShare Systems
5  */
6 
7 #ifndef _RTE_MEMPOOL_H_
8 #define _RTE_MEMPOOL_H_
9 
37 #include <stdio.h>
38 #include <stdint.h>
39 #include <inttypes.h>
40 
41 #include <rte_compat.h>
42 #include <rte_config.h>
43 #include <rte_spinlock.h>
44 #include <rte_debug.h>
45 #include <rte_lcore.h>
46 #include <rte_branch_prediction.h>
47 #include <rte_ring.h>
48 #include <rte_memcpy.h>
49 #include <rte_common.h>
50 
51 #include "rte_mempool_trace_fp.h"
52 
53 #ifdef __cplusplus
54 extern "C" {
55 #endif
56 
57 #define RTE_MEMPOOL_HEADER_COOKIE1 0xbadbadbadadd2e55ULL
58 #define RTE_MEMPOOL_HEADER_COOKIE2 0xf2eef2eedadd2e55ULL
59 #define RTE_MEMPOOL_TRAILER_COOKIE 0xadd2e55badbadbadULL
61 #ifdef RTE_LIBRTE_MEMPOOL_STATS
62 
68 struct rte_mempool_debug_stats {
69  uint64_t put_bulk;
70  uint64_t put_objs;
71  uint64_t put_common_pool_bulk;
72  uint64_t put_common_pool_objs;
73  uint64_t get_common_pool_bulk;
74  uint64_t get_common_pool_objs;
75  uint64_t get_success_bulk;
76  uint64_t get_success_objs;
77  uint64_t get_fail_bulk;
78  uint64_t get_fail_objs;
79  uint64_t get_success_blks;
80  uint64_t get_fail_blks;
82 #endif
83 
88  uint32_t size;
89  uint32_t flushthresh;
90  uint32_t len;
91 #ifdef RTE_LIBRTE_MEMPOOL_STATS
92  uint32_t unused;
93  /*
94  * Alternative location for the most frequently updated mempool statistics (per-lcore),
95  * providing faster update access when using a mempool cache.
96  */
97  struct {
98  uint64_t put_bulk;
99  uint64_t put_objs;
100  uint64_t get_success_bulk;
101  uint64_t get_success_objs;
102  } stats;
103 #endif
104 
110  void *objs[RTE_MEMPOOL_CACHE_MAX_SIZE * 2] __rte_cache_aligned;
112 
117  uint32_t elt_size;
118  uint32_t header_size;
119  uint32_t trailer_size;
120  uint32_t total_size;
122 };
123 
125 #define RTE_MEMPOOL_NAMESIZE (RTE_RING_NAMESIZE - \
126  sizeof(RTE_MEMPOOL_MZ_PREFIX) + 1)
127 #define RTE_MEMPOOL_MZ_PREFIX "MP_"
128 
129 /* "MP_<name>" */
130 #define RTE_MEMPOOL_MZ_FORMAT RTE_MEMPOOL_MZ_PREFIX "%s"
131 
132 #ifndef RTE_MEMPOOL_ALIGN
133 
136 #define RTE_MEMPOOL_ALIGN RTE_CACHE_LINE_SIZE
137 #endif
138 
139 #define RTE_MEMPOOL_ALIGN_MASK (RTE_MEMPOOL_ALIGN - 1)
140 
151  RTE_STAILQ_ENTRY(rte_mempool_objhdr) next;
152  struct rte_mempool *mp;
154 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
155  uint64_t cookie;
156 #endif
157 };
158 
162 RTE_STAILQ_HEAD(rte_mempool_objhdr_list, rte_mempool_objhdr);
163 
164 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
165 
172 struct rte_mempool_objtlr {
173  uint64_t cookie;
174 };
175 
176 #endif
177 
181 RTE_STAILQ_HEAD(rte_mempool_memhdr_list, rte_mempool_memhdr);
182 
187  void *opaque);
188 
196  RTE_STAILQ_ENTRY(rte_mempool_memhdr) next;
197  struct rte_mempool *mp;
198  void *addr;
200  size_t len;
202  void *opaque;
203 };
204 
213  unsigned int contig_block_size;
215 
219 struct rte_mempool {
220  char name[RTE_MEMPOOL_NAMESIZE];
222  union {
223  void *pool_data;
224  uint64_t pool_id;
225  };
226  void *pool_config;
227  const struct rte_memzone *mz;
228  unsigned int flags;
229  int socket_id;
230  uint32_t size;
231  uint32_t cache_size;
234  uint32_t elt_size;
235  uint32_t header_size;
236  uint32_t trailer_size;
238  unsigned private_data_size;
246  int32_t ops_index;
247 
250  uint32_t populated_size;
251  struct rte_mempool_objhdr_list elt_list;
252  uint32_t nb_mem_chunks;
253  struct rte_mempool_memhdr_list mem_list;
255 #ifdef RTE_LIBRTE_MEMPOOL_STATS
256 
260  struct rte_mempool_debug_stats stats[RTE_MAX_LCORE + 1];
261 #endif
263 
265 #define RTE_MEMPOOL_F_NO_SPREAD 0x0001
266 
270 #define MEMPOOL_F_NO_SPREAD RTE_MEMPOOL_F_NO_SPREAD
271 
272 #define RTE_MEMPOOL_F_NO_CACHE_ALIGN 0x0002
273 
277 #define MEMPOOL_F_NO_CACHE_ALIGN RTE_MEMPOOL_F_NO_CACHE_ALIGN
278 
279 #define RTE_MEMPOOL_F_SP_PUT 0x0004
280 
284 #define MEMPOOL_F_SP_PUT RTE_MEMPOOL_F_SP_PUT
285 
286 #define RTE_MEMPOOL_F_SC_GET 0x0008
287 
291 #define MEMPOOL_F_SC_GET RTE_MEMPOOL_F_SC_GET
292 
293 #define RTE_MEMPOOL_F_POOL_CREATED 0x0010
294 
295 #define RTE_MEMPOOL_F_NO_IOVA_CONTIG 0x0020
296 
300 #define MEMPOOL_F_NO_IOVA_CONTIG RTE_MEMPOOL_F_NO_IOVA_CONTIG
301 
302 #define RTE_MEMPOOL_F_NON_IO 0x0040
303 
307 #define RTE_MEMPOOL_VALID_USER_FLAGS (RTE_MEMPOOL_F_NO_SPREAD \
308  | RTE_MEMPOOL_F_NO_CACHE_ALIGN \
309  | RTE_MEMPOOL_F_SP_PUT \
310  | RTE_MEMPOOL_F_SC_GET \
311  | RTE_MEMPOOL_F_NO_IOVA_CONTIG \
312  )
313 
324 #ifdef RTE_LIBRTE_MEMPOOL_STATS
325 #define RTE_MEMPOOL_STAT_ADD(mp, name, n) do { \
326  unsigned int __lcore_id = rte_lcore_id(); \
327  if (likely(__lcore_id < RTE_MAX_LCORE)) \
328  (mp)->stats[__lcore_id].name += (n); \
329  else \
330  __atomic_fetch_add(&((mp)->stats[RTE_MAX_LCORE].name), \
331  (n), __ATOMIC_RELAXED); \
332  } while (0)
333 #else
334 #define RTE_MEMPOOL_STAT_ADD(mp, name, n) do {} while (0)
335 #endif
336 
347 #ifdef RTE_LIBRTE_MEMPOOL_STATS
348 #define RTE_MEMPOOL_CACHE_STAT_ADD(cache, name, n) ((cache)->stats.name += (n))
349 #else
350 #define RTE_MEMPOOL_CACHE_STAT_ADD(cache, name, n) do {} while (0)
351 #endif
352 
361 #define RTE_MEMPOOL_HEADER_SIZE(mp, cs) \
362  (sizeof(*(mp)) + (((cs) == 0) ? 0 : \
363  (sizeof(struct rte_mempool_cache) * RTE_MAX_LCORE)))
364 
365 /* return the header of a mempool object (internal) */
366 static inline struct rte_mempool_objhdr *
367 rte_mempool_get_header(void *obj)
368 {
369  return (struct rte_mempool_objhdr *)RTE_PTR_SUB(obj,
370  sizeof(struct rte_mempool_objhdr));
371 }
372 
382 static inline struct rte_mempool *rte_mempool_from_obj(void *obj)
383 {
384  struct rte_mempool_objhdr *hdr = rte_mempool_get_header(obj);
385  return hdr->mp;
386 }
387 
388 /* return the trailer of a mempool object (internal) */
389 static inline struct rte_mempool_objtlr *rte_mempool_get_trailer(void *obj)
390 {
391  struct rte_mempool *mp = rte_mempool_from_obj(obj);
392  return (struct rte_mempool_objtlr *)RTE_PTR_ADD(obj, mp->elt_size);
393 }
394 
409 void rte_mempool_check_cookies(const struct rte_mempool *mp,
410  void * const *obj_table_const, unsigned n, int free);
411 
412 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
413 #define RTE_MEMPOOL_CHECK_COOKIES(mp, obj_table_const, n, free) \
414  rte_mempool_check_cookies(mp, obj_table_const, n, free)
415 #else
416 #define RTE_MEMPOOL_CHECK_COOKIES(mp, obj_table_const, n, free) do {} while (0)
417 #endif /* RTE_LIBRTE_MEMPOOL_DEBUG */
418 
434 void rte_mempool_contig_blocks_check_cookies(const struct rte_mempool *mp,
435  void * const *first_obj_table_const, unsigned int n, int free);
436 
437 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
438 #define RTE_MEMPOOL_CONTIG_BLOCKS_CHECK_COOKIES(mp, first_obj_table_const, n, \
439  free) \
440  rte_mempool_contig_blocks_check_cookies(mp, first_obj_table_const, n, \
441  free)
442 #else
443 #define RTE_MEMPOOL_CONTIG_BLOCKS_CHECK_COOKIES(mp, first_obj_table_const, n, \
444  free) \
445  do {} while (0)
446 #endif /* RTE_LIBRTE_MEMPOOL_DEBUG */
447 
448 #define RTE_MEMPOOL_OPS_NAMESIZE 32
460 typedef int (*rte_mempool_alloc_t)(struct rte_mempool *mp);
461 
465 typedef void (*rte_mempool_free_t)(struct rte_mempool *mp);
466 
473 typedef int (*rte_mempool_enqueue_t)(struct rte_mempool *mp,
474  void * const *obj_table, unsigned int n);
475 
482 typedef int (*rte_mempool_dequeue_t)(struct rte_mempool *mp,
483  void **obj_table, unsigned int n);
484 
489  void **first_obj_table, unsigned int n);
490 
494 typedef unsigned (*rte_mempool_get_count)(const struct rte_mempool *mp);
495 
519 typedef ssize_t (*rte_mempool_calc_mem_size_t)(const struct rte_mempool *mp,
520  uint32_t obj_num, uint32_t pg_shift,
521  size_t *min_chunk_size, size_t *align);
522 
558 ssize_t rte_mempool_op_calc_mem_size_helper(const struct rte_mempool *mp,
559  uint32_t obj_num, uint32_t pg_shift, size_t chunk_reserve,
560  size_t *min_chunk_size, size_t *align);
561 
569 ssize_t rte_mempool_op_calc_mem_size_default(const struct rte_mempool *mp,
570  uint32_t obj_num, uint32_t pg_shift,
571  size_t *min_chunk_size, size_t *align);
572 
585 typedef void (rte_mempool_populate_obj_cb_t)(struct rte_mempool *mp,
586  void *opaque, void *vaddr, rte_iova_t iova);
587 
616 typedef int (*rte_mempool_populate_t)(struct rte_mempool *mp,
617  unsigned int max_objs,
618  void *vaddr, rte_iova_t iova, size_t len,
619  rte_mempool_populate_obj_cb_t *obj_cb, void *obj_cb_arg);
620 
624 #define RTE_MEMPOOL_POPULATE_F_ALIGN_OBJ 0x0001
625 
658 int rte_mempool_op_populate_helper(struct rte_mempool *mp,
659  unsigned int flags, unsigned int max_objs,
660  void *vaddr, rte_iova_t iova, size_t len,
661  rte_mempool_populate_obj_cb_t *obj_cb, void *obj_cb_arg);
662 
670  unsigned int max_objs,
671  void *vaddr, rte_iova_t iova, size_t len,
672  rte_mempool_populate_obj_cb_t *obj_cb, void *obj_cb_arg);
673 
677 typedef int (*rte_mempool_get_info_t)(const struct rte_mempool *mp,
678  struct rte_mempool_info *info);
679 
680 
708 
709 #define RTE_MEMPOOL_MAX_OPS_IDX 16
720 struct rte_mempool_ops_table {
722  uint32_t num_ops;
728 
731 
741 static inline struct rte_mempool_ops *
742 rte_mempool_get_ops(int ops_index)
743 {
744  RTE_VERIFY((ops_index >= 0) && (ops_index < RTE_MEMPOOL_MAX_OPS_IDX));
745 
746  return &rte_mempool_ops_table.ops[ops_index];
747 }
748 
758 int
759 rte_mempool_ops_alloc(struct rte_mempool *mp);
760 
774 static inline int
775 rte_mempool_ops_dequeue_bulk(struct rte_mempool *mp,
776  void **obj_table, unsigned n)
777 {
778  struct rte_mempool_ops *ops;
779  int ret;
780 
781  rte_mempool_trace_ops_dequeue_bulk(mp, obj_table, n);
782  ops = rte_mempool_get_ops(mp->ops_index);
783  ret = ops->dequeue(mp, obj_table, n);
784  if (ret == 0) {
785  RTE_MEMPOOL_STAT_ADD(mp, get_common_pool_bulk, 1);
786  RTE_MEMPOOL_STAT_ADD(mp, get_common_pool_objs, n);
787  }
788  return ret;
789 }
790 
804 static inline int
805 rte_mempool_ops_dequeue_contig_blocks(struct rte_mempool *mp,
806  void **first_obj_table, unsigned int n)
807 {
808  struct rte_mempool_ops *ops;
809 
810  ops = rte_mempool_get_ops(mp->ops_index);
811  RTE_ASSERT(ops->dequeue_contig_blocks != NULL);
812  rte_mempool_trace_ops_dequeue_contig_blocks(mp, first_obj_table, n);
813  return ops->dequeue_contig_blocks(mp, first_obj_table, n);
814 }
815 
829 static inline int
830 rte_mempool_ops_enqueue_bulk(struct rte_mempool *mp, void * const *obj_table,
831  unsigned n)
832 {
833  struct rte_mempool_ops *ops;
834  int ret;
835 
836  RTE_MEMPOOL_STAT_ADD(mp, put_common_pool_bulk, 1);
837  RTE_MEMPOOL_STAT_ADD(mp, put_common_pool_objs, n);
838  rte_mempool_trace_ops_enqueue_bulk(mp, obj_table, n);
839  ops = rte_mempool_get_ops(mp->ops_index);
840  ret = ops->enqueue(mp, obj_table, n);
841 #ifdef RTE_LIBRTE_MEMPOOL_DEBUG
842  if (unlikely(ret < 0))
843  RTE_LOG(CRIT, MEMPOOL, "cannot enqueue %u objects to mempool %s\n",
844  n, mp->name);
845 #endif
846  return ret;
847 }
848 
857 unsigned
858 rte_mempool_ops_get_count(const struct rte_mempool *mp);
859 
879 ssize_t rte_mempool_ops_calc_mem_size(const struct rte_mempool *mp,
880  uint32_t obj_num, uint32_t pg_shift,
881  size_t *min_chunk_size, size_t *align);
882 
906 int rte_mempool_ops_populate(struct rte_mempool *mp, unsigned int max_objs,
907  void *vaddr, rte_iova_t iova, size_t len,
909  void *obj_cb_arg);
910 
923 int rte_mempool_ops_get_info(const struct rte_mempool *mp,
924  struct rte_mempool_info *info);
925 
932 void
933 rte_mempool_ops_free(struct rte_mempool *mp);
934 
952 int
953 rte_mempool_set_ops_byname(struct rte_mempool *mp, const char *name,
954  void *pool_config);
955 
966 int rte_mempool_register_ops(const struct rte_mempool_ops *ops);
967 
973 #define RTE_MEMPOOL_REGISTER_OPS(ops) \
974  RTE_INIT(mp_hdlr_init_##ops) \
975  { \
976  rte_mempool_register_ops(&ops); \
977  }
978 
984 typedef void (rte_mempool_obj_cb_t)(struct rte_mempool *mp,
985  void *opaque, void *obj, unsigned obj_idx);
986 typedef rte_mempool_obj_cb_t rte_mempool_obj_ctor_t; /* compat */
987 
993 typedef void (rte_mempool_mem_cb_t)(struct rte_mempool *mp,
994  void *opaque, struct rte_mempool_memhdr *memhdr,
995  unsigned mem_idx);
996 
1003 typedef void (rte_mempool_ctor_t)(struct rte_mempool *, void *);
1004 
1083 struct rte_mempool *
1084 rte_mempool_create(const char *name, unsigned n, unsigned elt_size,
1085  unsigned cache_size, unsigned private_data_size,
1086  rte_mempool_ctor_t *mp_init, void *mp_init_arg,
1087  rte_mempool_obj_cb_t *obj_init, void *obj_init_arg,
1088  int socket_id, unsigned flags);
1089 
1124 struct rte_mempool *
1125 rte_mempool_create_empty(const char *name, unsigned n, unsigned elt_size,
1126  unsigned cache_size, unsigned private_data_size,
1127  int socket_id, unsigned flags);
1139 void
1140 rte_mempool_free(struct rte_mempool *mp);
1141 
1172 int rte_mempool_populate_iova(struct rte_mempool *mp, char *vaddr,
1173  rte_iova_t iova, size_t len, rte_mempool_memchunk_free_cb_t *free_cb,
1174  void *opaque);
1175 
1202 int
1203 rte_mempool_populate_virt(struct rte_mempool *mp, char *addr,
1204  size_t len, size_t pg_sz, rte_mempool_memchunk_free_cb_t *free_cb,
1205  void *opaque);
1206 
1221 
1235 int rte_mempool_populate_anon(struct rte_mempool *mp);
1236 
1252 uint32_t rte_mempool_obj_iter(struct rte_mempool *mp,
1253  rte_mempool_obj_cb_t *obj_cb, void *obj_cb_arg);
1254 
1270 uint32_t rte_mempool_mem_iter(struct rte_mempool *mp,
1271  rte_mempool_mem_cb_t *mem_cb, void *mem_cb_arg);
1272 
1281 void rte_mempool_dump(FILE *f, struct rte_mempool *mp);
1282 
1297 struct rte_mempool_cache *
1298 rte_mempool_cache_create(uint32_t size, int socket_id);
1299 
1306 void
1308 
1320 static __rte_always_inline struct rte_mempool_cache *
1321 rte_mempool_default_cache(struct rte_mempool *mp, unsigned lcore_id)
1322 {
1323  if (mp->cache_size == 0)
1324  return NULL;
1325 
1326  if (lcore_id >= RTE_MAX_LCORE)
1327  return NULL;
1328 
1329  rte_mempool_trace_default_cache(mp, lcore_id,
1330  &mp->local_cache[lcore_id]);
1331  return &mp->local_cache[lcore_id];
1332 }
1333 
1342 static __rte_always_inline void
1344  struct rte_mempool *mp)
1345 {
1346  if (cache == NULL)
1347  cache = rte_mempool_default_cache(mp, rte_lcore_id());
1348  if (cache == NULL || cache->len == 0)
1349  return;
1350  rte_mempool_trace_cache_flush(cache, mp);
1351  rte_mempool_ops_enqueue_bulk(mp, cache->objs, cache->len);
1352  cache->len = 0;
1353 }
1354 
1367 static __rte_always_inline void
1368 rte_mempool_do_generic_put(struct rte_mempool *mp, void * const *obj_table,
1369  unsigned int n, struct rte_mempool_cache *cache)
1370 {
1371  void **cache_objs;
1372 
1373  /* No cache provided */
1374  if (unlikely(cache == NULL))
1375  goto driver_enqueue;
1376 
1377  /* increment stat now, adding in mempool always success */
1378  RTE_MEMPOOL_CACHE_STAT_ADD(cache, put_bulk, 1);
1379  RTE_MEMPOOL_CACHE_STAT_ADD(cache, put_objs, n);
1380 
1381  /* The request itself is too big for the cache */
1382  if (unlikely(n > cache->flushthresh))
1383  goto driver_enqueue_stats_incremented;
1384 
1385  /*
1386  * The cache follows the following algorithm:
1387  * 1. If the objects cannot be added to the cache without crossing
1388  * the flush threshold, flush the cache to the backend.
1389  * 2. Add the objects to the cache.
1390  */
1391 
1392  if (cache->len + n <= cache->flushthresh) {
1393  cache_objs = &cache->objs[cache->len];
1394  cache->len += n;
1395  } else {
1396  cache_objs = &cache->objs[0];
1397  rte_mempool_ops_enqueue_bulk(mp, cache_objs, cache->len);
1398  cache->len = n;
1399  }
1400 
1401  /* Add the objects to the cache. */
1402  rte_memcpy(cache_objs, obj_table, sizeof(void *) * n);
1403 
1404  return;
1405 
1406 driver_enqueue:
1407 
1408  /* increment stat now, adding in mempool always success */
1409  RTE_MEMPOOL_STAT_ADD(mp, put_bulk, 1);
1410  RTE_MEMPOOL_STAT_ADD(mp, put_objs, n);
1411 
1412 driver_enqueue_stats_incremented:
1413 
1414  /* push objects to the backend */
1415  rte_mempool_ops_enqueue_bulk(mp, obj_table, n);
1416 }
1417 
1418 
1431 static __rte_always_inline void
1432 rte_mempool_generic_put(struct rte_mempool *mp, void * const *obj_table,
1433  unsigned int n, struct rte_mempool_cache *cache)
1434 {
1435  rte_mempool_trace_generic_put(mp, obj_table, n, cache);
1436  RTE_MEMPOOL_CHECK_COOKIES(mp, obj_table, n, 0);
1437  rte_mempool_do_generic_put(mp, obj_table, n, cache);
1438 }
1439 
1454 static __rte_always_inline void
1455 rte_mempool_put_bulk(struct rte_mempool *mp, void * const *obj_table,
1456  unsigned int n)
1457 {
1458  struct rte_mempool_cache *cache;
1459  cache = rte_mempool_default_cache(mp, rte_lcore_id());
1460  rte_mempool_trace_put_bulk(mp, obj_table, n, cache);
1461  rte_mempool_generic_put(mp, obj_table, n, cache);
1462 }
1463 
1476 static __rte_always_inline void
1477 rte_mempool_put(struct rte_mempool *mp, void *obj)
1478 {
1479  rte_mempool_put_bulk(mp, &obj, 1);
1480 }
1481 
1496 static __rte_always_inline int
1497 rte_mempool_do_generic_get(struct rte_mempool *mp, void **obj_table,
1498  unsigned int n, struct rte_mempool_cache *cache)
1499 {
1500  int ret;
1501  unsigned int remaining = n;
1502  uint32_t index, len;
1503  void **cache_objs;
1504 
1505  /* No cache provided */
1506  if (unlikely(cache == NULL))
1507  goto driver_dequeue;
1508 
1509  /* Use the cache as much as we have to return hot objects first */
1510  len = RTE_MIN(remaining, cache->len);
1511  cache_objs = &cache->objs[cache->len];
1512  cache->len -= len;
1513  remaining -= len;
1514  for (index = 0; index < len; index++)
1515  *obj_table++ = *--cache_objs;
1516 
1517  if (remaining == 0) {
1518  /* The entire request is satisfied from the cache. */
1519 
1520  RTE_MEMPOOL_CACHE_STAT_ADD(cache, get_success_bulk, 1);
1521  RTE_MEMPOOL_CACHE_STAT_ADD(cache, get_success_objs, n);
1522 
1523  return 0;
1524  }
1525 
1526  /* if dequeue below would overflow mem allocated for cache */
1527  if (unlikely(remaining > RTE_MEMPOOL_CACHE_MAX_SIZE))
1528  goto driver_dequeue;
1529 
1530  /* Fill the cache from the backend; fetch size + remaining objects. */
1531  ret = rte_mempool_ops_dequeue_bulk(mp, cache->objs,
1532  cache->size + remaining);
1533  if (unlikely(ret < 0)) {
1534  /*
1535  * We are buffer constrained, and not able to allocate
1536  * cache + remaining.
1537  * Do not fill the cache, just satisfy the remaining part of
1538  * the request directly from the backend.
1539  */
1540  goto driver_dequeue;
1541  }
1542 
1543  /* Satisfy the remaining part of the request from the filled cache. */
1544  cache_objs = &cache->objs[cache->size + remaining];
1545  for (index = 0; index < remaining; index++)
1546  *obj_table++ = *--cache_objs;
1547 
1548  cache->len = cache->size;
1549 
1550  RTE_MEMPOOL_CACHE_STAT_ADD(cache, get_success_bulk, 1);
1551  RTE_MEMPOOL_CACHE_STAT_ADD(cache, get_success_objs, n);
1552 
1553  return 0;
1554 
1555 driver_dequeue:
1556 
1557  /* Get remaining objects directly from the backend. */
1558  ret = rte_mempool_ops_dequeue_bulk(mp, obj_table, remaining);
1559 
1560  if (ret < 0) {
1561  if (likely(cache != NULL)) {
1562  cache->len = n - remaining;
1563  /*
1564  * No further action is required to roll the first part
1565  * of the request back into the cache, as objects in
1566  * the cache are intact.
1567  */
1568  }
1569 
1570  RTE_MEMPOOL_STAT_ADD(mp, get_fail_bulk, 1);
1571  RTE_MEMPOOL_STAT_ADD(mp, get_fail_objs, n);
1572  } else {
1573  if (likely(cache != NULL)) {
1574  RTE_MEMPOOL_CACHE_STAT_ADD(cache, get_success_bulk, 1);
1575  RTE_MEMPOOL_CACHE_STAT_ADD(cache, get_success_objs, n);
1576  } else {
1577  RTE_MEMPOOL_STAT_ADD(mp, get_success_bulk, 1);
1578  RTE_MEMPOOL_STAT_ADD(mp, get_success_objs, n);
1579  }
1580  }
1581 
1582  return ret;
1583 }
1584 
1605 static __rte_always_inline int
1606 rte_mempool_generic_get(struct rte_mempool *mp, void **obj_table,
1607  unsigned int n, struct rte_mempool_cache *cache)
1608 {
1609  int ret;
1610  ret = rte_mempool_do_generic_get(mp, obj_table, n, cache);
1611  if (ret == 0)
1612  RTE_MEMPOOL_CHECK_COOKIES(mp, obj_table, n, 1);
1613  rte_mempool_trace_generic_get(mp, obj_table, n, cache);
1614  return ret;
1615 }
1616 
1639 static __rte_always_inline int
1640 rte_mempool_get_bulk(struct rte_mempool *mp, void **obj_table, unsigned int n)
1641 {
1642  struct rte_mempool_cache *cache;
1643  cache = rte_mempool_default_cache(mp, rte_lcore_id());
1644  rte_mempool_trace_get_bulk(mp, obj_table, n, cache);
1645  return rte_mempool_generic_get(mp, obj_table, n, cache);
1646 }
1647 
1668 static __rte_always_inline int
1669 rte_mempool_get(struct rte_mempool *mp, void **obj_p)
1670 {
1671  return rte_mempool_get_bulk(mp, obj_p, 1);
1672 }
1673 
1695 static __rte_always_inline int
1697  void **first_obj_table, unsigned int n)
1698 {
1699  int ret;
1700 
1701  ret = rte_mempool_ops_dequeue_contig_blocks(mp, first_obj_table, n);
1702  if (ret == 0) {
1703  RTE_MEMPOOL_STAT_ADD(mp, get_success_bulk, 1);
1704  RTE_MEMPOOL_STAT_ADD(mp, get_success_blks, n);
1705  RTE_MEMPOOL_CONTIG_BLOCKS_CHECK_COOKIES(mp, first_obj_table, n,
1706  1);
1707  } else {
1708  RTE_MEMPOOL_STAT_ADD(mp, get_fail_bulk, 1);
1709  RTE_MEMPOOL_STAT_ADD(mp, get_fail_blks, n);
1710  }
1711 
1712  rte_mempool_trace_get_contig_blocks(mp, first_obj_table, n);
1713  return ret;
1714 }
1715 
1728 unsigned int rte_mempool_avail_count(const struct rte_mempool *mp);
1729 
1742 unsigned int
1743 rte_mempool_in_use_count(const struct rte_mempool *mp);
1744 
1758 static inline int
1760 {
1761  return rte_mempool_avail_count(mp) == mp->size;
1762 }
1763 
1777 static inline int
1779 {
1780  return rte_mempool_avail_count(mp) == 0;
1781 }
1782 
1793 static inline rte_iova_t
1794 rte_mempool_virt2iova(const void *elt)
1795 {
1796  const struct rte_mempool_objhdr *hdr;
1797  hdr = (const struct rte_mempool_objhdr *)RTE_PTR_SUB(elt,
1798  sizeof(*hdr));
1799  return hdr->iova;
1800 }
1801 
1812 void rte_mempool_audit(struct rte_mempool *mp);
1813 
1822 static inline void *rte_mempool_get_priv(struct rte_mempool *mp)
1823 {
1824  return (char *)mp +
1825  RTE_MEMPOOL_HEADER_SIZE(mp, mp->cache_size);
1826 }
1827 
1834 void rte_mempool_list_dump(FILE *f);
1835 
1848 struct rte_mempool *rte_mempool_lookup(const char *name);
1849 
1867 uint32_t rte_mempool_calc_obj_size(uint32_t elt_size, uint32_t flags,
1868  struct rte_mempool_objsz *sz);
1869 
1878 void rte_mempool_walk(void (*func)(struct rte_mempool *, void *arg),
1879  void *arg);
1880 
1885 int
1886 rte_mempool_get_page_size(struct rte_mempool *mp, size_t *pg_sz);
1887 
1897 };
1898 
1908 typedef void (rte_mempool_event_callback)(
1909  enum rte_mempool_event event,
1910  struct rte_mempool *mp,
1911  void *user_data);
1912 
1929 __rte_internal
1930 int
1931 rte_mempool_event_callback_register(rte_mempool_event_callback *func,
1932  void *user_data);
1933 
1947 __rte_internal
1948 int
1949 rte_mempool_event_callback_unregister(rte_mempool_event_callback *func,
1950  void *user_data);
1951 
1952 #ifdef __cplusplus
1953 }
1954 #endif
1955 
1956 #endif /* _RTE_MEMPOOL_H_ */
uint64_t pool_id
Definition: rte_mempool.h:224
#define __rte_always_inline
Definition: rte_common.h:255
struct rte_mempool * rte_mempool_lookup(const char *name)
struct rte_mempool_cache * rte_mempool_cache_create(uint32_t size, int socket_id)
uint32_t rte_mempool_mem_iter(struct rte_mempool *mp, rte_mempool_mem_cb_t *mem_cb, void *mem_cb_arg)
uint32_t header_size
Definition: rte_mempool.h:235
#define likely(x)
const struct rte_memzone * mz
Definition: rte_mempool.h:227
uint64_t rte_iova_t
Definition: rte_common.h:458
static __rte_always_inline void rte_mempool_put_bulk(struct rte_mempool *mp, void *const *obj_table, unsigned int n)
Definition: rte_mempool.h:1455
struct rte_mempool * mp
Definition: rte_mempool.h:197
void rte_mempool_list_dump(FILE *f)
void() rte_mempool_memchunk_free_cb_t(struct rte_mempool_memhdr *memhdr, void *opaque)
Definition: rte_mempool.h:186
int(* rte_mempool_dequeue_contig_blocks_t)(struct rte_mempool *mp, void **first_obj_table, unsigned int n)
Definition: rte_mempool.h:488
rte_mempool_alloc_t alloc
Definition: rte_mempool.h:684
void *objs [RTE_MEMPOOL_CACHE_MAX_SIZE *2] __rte_cache_aligned
Definition: rte_mempool.h:110
void() rte_mempool_populate_obj_cb_t(struct rte_mempool *mp, void *opaque, void *vaddr, rte_iova_t iova)
Definition: rte_mempool.h:585
unsigned int flags
Definition: rte_mempool.h:228
static __rte_always_inline void rte_mempool_generic_put(struct rte_mempool *mp, void *const *obj_table, unsigned int n, struct rte_mempool_cache *cache)
Definition: rte_mempool.h:1432
int(* rte_mempool_alloc_t)(struct rte_mempool *mp)
Definition: rte_mempool.h:460
#define RTE_LOG(l, t,...)
Definition: rte_log.h:335
static int rte_mempool_empty(const struct rte_mempool *mp)
Definition: rte_mempool.h:1778
RTE_STAILQ_HEAD(rte_mempool_objhdr_list, rte_mempool_objhdr)
rte_mempool_memchunk_free_cb_t * free_cb
Definition: rte_mempool.h:201
char name[RTE_MEMPOOL_OPS_NAMESIZE]
Definition: rte_mempool.h:683
int(* rte_mempool_dequeue_t)(struct rte_mempool *mp, void **obj_table, unsigned int n)
Definition: rte_mempool.h:482
rte_mempool_get_info_t get_info
Definition: rte_mempool.h:702
rte_mempool_dequeue_contig_blocks_t dequeue_contig_blocks
Definition: rte_mempool.h:706
uint32_t cache_size
Definition: rte_mempool.h:231
char name[RTE_MEMPOOL_NAMESIZE]
Definition: rte_mempool.h:220
unsigned int rte_mempool_avail_count(const struct rte_mempool *mp)
uint32_t size
Definition: rte_mempool.h:230
#define RTE_PTR_ADD(ptr, x)
Definition: rte_common.h:290
void rte_mempool_cache_free(struct rte_mempool_cache *cache)
uint32_t total_size
Definition: rte_mempool.h:120
uint32_t rte_mempool_obj_iter(struct rte_mempool *mp, rte_mempool_obj_cb_t *obj_cb, void *obj_cb_arg)
int rte_mempool_ops_get_info(const struct rte_mempool *mp, struct rte_mempool_info *info)
int rte_mempool_register_ops(const struct rte_mempool_ops *ops)
#define unlikely(x)
static __rte_always_inline int rte_mempool_generic_get(struct rte_mempool *mp, void **obj_table, unsigned int n, struct rte_mempool_cache *cache)
Definition: rte_mempool.h:1606
int rte_mempool_populate_default(struct rte_mempool *mp)
#define RTE_MIN(a, b)
Definition: rte_common.h:613
static __rte_always_inline void rte_mempool_cache_flush(struct rte_mempool_cache *cache, struct rte_mempool *mp)
Definition: rte_mempool.h:1343
#define RTE_MEMPOOL_OPS_NAMESIZE
Definition: rte_mempool.h:448
static __rte_always_inline int rte_mempool_get(struct rte_mempool *mp, void **obj_p)
Definition: rte_mempool.h:1669
uint32_t nb_mem_chunks
Definition: rte_mempool.h:252
struct rte_mempool * mp
Definition: rte_mempool.h:152
struct rte_mempool_ops ops[RTE_MEMPOOL_MAX_OPS_IDX]
Definition: rte_mempool.h:726
rte_mempool_get_count get_count
Definition: rte_mempool.h:688
ssize_t(* rte_mempool_calc_mem_size_t)(const struct rte_mempool *mp, uint32_t obj_num, uint32_t pg_shift, size_t *min_chunk_size, size_t *align)
Definition: rte_mempool.h:519
static int rte_mempool_full(const struct rte_mempool *mp)
Definition: rte_mempool.h:1759
static unsigned rte_lcore_id(void)
Definition: rte_lcore.h:79
void * pool_config
Definition: rte_mempool.h:226
unsigned int rte_mempool_in_use_count(const struct rte_mempool *mp)
static __rte_always_inline int rte_mempool_get_bulk(struct rte_mempool *mp, void **obj_table, unsigned int n)
Definition: rte_mempool.h:1640
int rte_mempool_set_ops_byname(struct rte_mempool *mp, const char *name, void *pool_config)
int rte_mempool_populate_iova(struct rte_mempool *mp, char *vaddr, rte_iova_t iova, size_t len, rte_mempool_memchunk_free_cb_t *free_cb, void *opaque)
rte_mempool_calc_mem_size_t calc_mem_size
Definition: rte_mempool.h:693
unsigned(* rte_mempool_get_count)(const struct rte_mempool *mp)
Definition: rte_mempool.h:494
uint32_t rte_mempool_calc_obj_size(uint32_t elt_size, uint32_t flags, struct rte_mempool_objsz *sz)
ssize_t rte_mempool_op_calc_mem_size_default(const struct rte_mempool *mp, uint32_t obj_num, uint32_t pg_shift, size_t *min_chunk_size, size_t *align)
void * pool_data
Definition: rte_mempool.h:223
unsigned int contig_block_size
Definition: rte_mempool.h:213
int rte_mempool_populate_virt(struct rte_mempool *mp, char *addr, size_t len, size_t pg_sz, rte_mempool_memchunk_free_cb_t *free_cb, void *opaque)
int(* rte_mempool_populate_t)(struct rte_mempool *mp, unsigned int max_objs, void *vaddr, rte_iova_t iova, size_t len, rte_mempool_populate_obj_cb_t *obj_cb, void *obj_cb_arg)
Definition: rte_mempool.h:616
uint32_t elt_size
Definition: rte_mempool.h:234
void rte_mempool_audit(struct rte_mempool *mp)
int(* rte_mempool_get_info_t)(const struct rte_mempool *mp, struct rte_mempool_info *info)
Definition: rte_mempool.h:677
struct rte_mempool * rte_mempool_create_empty(const char *name, unsigned n, unsigned elt_size, unsigned cache_size, unsigned private_data_size, int socket_id, unsigned flags)
unsigned private_data_size
Definition: rte_mempool.h:238
rte_spinlock_t sl
Definition: rte_mempool.h:721
static __rte_always_inline struct rte_mempool_cache * rte_mempool_default_cache(struct rte_mempool *mp, unsigned lcore_id)
Definition: rte_mempool.h:1321
void rte_mempool_dump(FILE *f, struct rte_mempool *mp)
void() rte_mempool_ctor_t(struct rte_mempool *, void *)
Definition: rte_mempool.h:1003
int rte_mempool_populate_anon(struct rte_mempool *mp)
struct rte_mempool_cache * local_cache
Definition: rte_mempool.h:248
#define __rte_cache_aligned
Definition: rte_common.h:440
uint32_t trailer_size
Definition: rte_mempool.h:236
#define RTE_STD_C11
Definition: rte_common.h:39
rte_mempool_dequeue_t dequeue
Definition: rte_mempool.h:687
int(* rte_mempool_enqueue_t)(struct rte_mempool *mp, void *const *obj_table, unsigned int n)
Definition: rte_mempool.h:473
uint32_t flushthresh
Definition: rte_mempool.h:89
void() rte_mempool_obj_cb_t(struct rte_mempool *mp, void *opaque, void *obj, unsigned obj_idx)
Definition: rte_mempool.h:984
void() rte_mempool_mem_cb_t(struct rte_mempool *mp, void *opaque, struct rte_mempool_memhdr *memhdr, unsigned mem_idx)
Definition: rte_mempool.h:993
int rte_mempool_op_populate_default(struct rte_mempool *mp, unsigned int max_objs, void *vaddr, rte_iova_t iova, size_t len, rte_mempool_populate_obj_cb_t *obj_cb, void *obj_cb_arg)
struct rte_mempool * rte_mempool_create(const char *name, unsigned n, unsigned elt_size, unsigned cache_size, unsigned private_data_size, rte_mempool_ctor_t *mp_init, void *mp_init_arg, rte_mempool_obj_cb_t *obj_init, void *obj_init_arg, int socket_id, unsigned flags)
#define RTE_PTR_SUB(ptr, x)
Definition: rte_common.h:295
rte_mempool_event
Definition: rte_mempool.h:1892
static struct rte_mempool * rte_mempool_from_obj(void *obj)
Definition: rte_mempool.h:382
uint32_t header_size
Definition: rte_mempool.h:118
int32_t ops_index
Definition: rte_mempool.h:246
static void * rte_memcpy(void *dst, const void *src, size_t n)
uint32_t populated_size
Definition: rte_mempool.h:250
static rte_iova_t rte_mempool_virt2iova(const void *elt)
Definition: rte_mempool.h:1794
static __rte_always_inline void rte_mempool_put(struct rte_mempool *mp, void *obj)
Definition: rte_mempool.h:1477
rte_mempool_populate_t populate
Definition: rte_mempool.h:698
void rte_mempool_free(struct rte_mempool *mp)
void rte_mempool_walk(void(*func)(struct rte_mempool *, void *arg), void *arg)
static void * rte_mempool_get_priv(struct rte_mempool *mp)
Definition: rte_mempool.h:1822
uint32_t trailer_size
Definition: rte_mempool.h:119
#define RTE_MEMPOOL_MAX_OPS_IDX
Definition: rte_mempool.h:709
void(* rte_mempool_free_t)(struct rte_mempool *mp)
Definition: rte_mempool.h:465
rte_mempool_free_t free
Definition: rte_mempool.h:685
static __rte_always_inline int rte_mempool_get_contig_blocks(struct rte_mempool *mp, void **first_obj_table, unsigned int n)
Definition: rte_mempool.h:1696
rte_mempool_enqueue_t enqueue
Definition: rte_mempool.h:686