lib/librte_mempool/rte_mempool_ops.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2016 Intel Corporation.
   3  * Copyright(c) 2016 6WIND S.A.
   4  */
   5
   6 #include <stdio.h>
   7 #include <string.h>
   8
   9 #include <rte_mempool.h>
  10 #include <rte_errno.h>
  11 #include <rte_dev.h>
  12
  13 /* indirect jump table to support external memory pools. */
  14 struct rte_mempool_ops_table rte_mempool_ops_table = {
  15         .sl =  RTE_SPINLOCK_INITIALIZER,
  16         .num_ops = 0
  17 };
  18
  19 /* add a new ops struct in rte_mempool_ops_table, return its index. */
  20 int
  21 rte_mempool_register_ops(const struct rte_mempool_ops *h)
  22 {
  23         struct rte_mempool_ops *ops;
  24         int16_t ops_index;
  25
  26         rte_spinlock_lock(&rte_mempool_ops_table.sl);
  27
  28         if (rte_mempool_ops_table.num_ops >=
  29                         RTE_MEMPOOL_MAX_OPS_IDX) {
  30                 rte_spinlock_unlock(&rte_mempool_ops_table.sl);
  31                 RTE_LOG(ERR, MEMPOOL,
  32                         "Maximum number of mempool ops structs exceeded\n");
  33                 return -ENOSPC;
  34         }
  35
  36         if (h->alloc == NULL || h->enqueue == NULL ||
  37                         h->dequeue == NULL || h->get_count == NULL) {
  38                 rte_spinlock_unlock(&rte_mempool_ops_table.sl);
  39                 RTE_LOG(ERR, MEMPOOL,
  40                         "Missing callback while registering mempool ops\n");
  41                 return -EINVAL;
  42         }
  43
  44         if (strlen(h->name) >= sizeof(ops->name) - 1) {
  45                 rte_spinlock_unlock(&rte_mempool_ops_table.sl);
  46                 RTE_LOG(DEBUG, EAL, "%s(): mempool_ops <%s>: name too long\n",
  47                                 __func__, h->name);
  48                 rte_errno = EEXIST;
  49                 return -EEXIST;
  50         }
  51
  52         ops_index = rte_mempool_ops_table.num_ops++;
  53         ops = &rte_mempool_ops_table.ops[ops_index];
  54         snprintf(ops->name, sizeof(ops->name), "%s", h->name);
  55         ops->alloc = h->alloc;
  56         ops->free = h->free;
  57         ops->enqueue = h->enqueue;
  58         ops->dequeue = h->dequeue;
  59         ops->get_count = h->get_count;
  60         ops->get_capabilities = h->get_capabilities;
  61         ops->register_memory_area = h->register_memory_area;
  62         ops->calc_mem_size = h->calc_mem_size;
  63
  64         rte_spinlock_unlock(&rte_mempool_ops_table.sl);
  65
  66         return ops_index;
  67 }
  68
  69 /* wrapper to allocate an external mempool's private (pool) data. */
  70 int
  71 rte_mempool_ops_alloc(struct rte_mempool *mp)
  72 {
  73         struct rte_mempool_ops *ops;
  74
  75         ops = rte_mempool_get_ops(mp->ops_index);
  76         return ops->alloc(mp);
  77 }
  78
  79 /* wrapper to free an external pool ops. */
  80 void
  81 rte_mempool_ops_free(struct rte_mempool *mp)
  82 {
  83         struct rte_mempool_ops *ops;
  84
  85         ops = rte_mempool_get_ops(mp->ops_index);
  86         if (ops->free == NULL)
  87                 return;
  88         ops->free(mp);
  89 }
  90
  91 /* wrapper to get available objects in an external mempool. */
  92 unsigned int
  93 rte_mempool_ops_get_count(const struct rte_mempool *mp)
  94 {
  95         struct rte_mempool_ops *ops;
  96
  97         ops = rte_mempool_get_ops(mp->ops_index);
  98         return ops->get_count(mp);
  99 }
 100
 101 /* wrapper to get external mempool capabilities. */
 102 int
 103 rte_mempool_ops_get_capabilities(const struct rte_mempool *mp,
 104                                         unsigned int *flags)
 105 {
 106         struct rte_mempool_ops *ops;
 107
 108         ops = rte_mempool_get_ops(mp->ops_index);
 109
 110         RTE_FUNC_PTR_OR_ERR_RET(ops->get_capabilities, -ENOTSUP);
 111         return ops->get_capabilities(mp, flags);
 112 }
 113
 114 /* wrapper to notify new memory area to external mempool */
 115 int
 116 rte_mempool_ops_register_memory_area(const struct rte_mempool *mp, char *vaddr,
 117                                         rte_iova_t iova, size_t len)
 118 {
 119         struct rte_mempool_ops *ops;
 120
 121         ops = rte_mempool_get_ops(mp->ops_index);
 122
 123         RTE_FUNC_PTR_OR_ERR_RET(ops->register_memory_area, -ENOTSUP);
 124         return ops->register_memory_area(mp, vaddr, iova, len);
 125 }
 126
 127 /* wrapper to notify new memory area to external mempool */
 128 ssize_t
 129 rte_mempool_ops_calc_mem_size(const struct rte_mempool *mp,
 130                                 uint32_t obj_num, uint32_t pg_shift,
 131                                 size_t *min_chunk_size, size_t *align)
 132 {
 133         struct rte_mempool_ops *ops;
 134
 135         ops = rte_mempool_get_ops(mp->ops_index);
 136
 137         if (ops->calc_mem_size == NULL)
 138                 return rte_mempool_op_calc_mem_size_default(mp, obj_num,
 139                                 pg_shift, min_chunk_size, align);
 140
 141         return ops->calc_mem_size(mp, obj_num, pg_shift, min_chunk_size, align);
 142 }
 143
 144 /* sets mempool ops previously registered by rte_mempool_register_ops. */
 145 int
 146 rte_mempool_set_ops_byname(struct rte_mempool *mp, const char *name,
 147         void *pool_config)
 148 {
 149         struct rte_mempool_ops *ops = NULL;
 150         unsigned i;
 151
 152         /* too late, the mempool is already populated. */
 153         if (mp->flags & MEMPOOL_F_POOL_CREATED)
 154                 return -EEXIST;
 155
 156         for (i = 0; i < rte_mempool_ops_table.num_ops; i++) {
 157                 if (!strcmp(name,
 158                                 rte_mempool_ops_table.ops[i].name)) {
 159                         ops = &rte_mempool_ops_table.ops[i];
 160                         break;
 161                 }
 162         }
 163
 164         if (ops == NULL)
 165                 return -EINVAL;
 166
 167         mp->ops_index = i;
 168         mp->pool_config = pool_config;
 169         return 0;
 170 }