lib/librte_mempool/rte_mempool_ops.c

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2016 Intel Corporation. All rights reserved.
   5  *   Copyright(c) 2016 6WIND S.A.
   6  *   All rights reserved.
   7  *
   8  *   Redistribution and use in source and binary forms, with or without
   9  *   modification, are permitted provided that the following conditions
  10  *   are met:
  11  *
  12  *     * Redistributions of source code must retain the above copyright
  13  *       notice, this list of conditions and the following disclaimer.
  14  *     * Redistributions in binary form must reproduce the above copyright
  15  *       notice, this list of conditions and the following disclaimer in
  16  *       the documentation and/or other materials provided with the
  17  *       distribution.
  18  *     * Neither the name of Intel Corporation nor the names of its
  19  *       contributors may be used to endorse or promote products derived
  20  *       from this software without specific prior written permission.
  21  *
  22  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  23  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  24  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  25  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  26  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  27  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  28  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  29  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  30  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  31  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  32  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  33  */
  34
  35 #include <stdio.h>
  36 #include <string.h>
  37
  38 #include <rte_mempool.h>
  39 #include <rte_errno.h>
  40 #include <rte_dev.h>
  41
  42 /* indirect jump table to support external memory pools. */
  43 struct rte_mempool_ops_table rte_mempool_ops_table = {
  44         .sl =  RTE_SPINLOCK_INITIALIZER,
  45         .num_ops = 0
  46 };
  47
  48 /* add a new ops struct in rte_mempool_ops_table, return its index. */
  49 int
  50 rte_mempool_register_ops(const struct rte_mempool_ops *h)
  51 {
  52         struct rte_mempool_ops *ops;
  53         int16_t ops_index;
  54
  55         rte_spinlock_lock(&rte_mempool_ops_table.sl);
  56
  57         if (rte_mempool_ops_table.num_ops >=
  58                         RTE_MEMPOOL_MAX_OPS_IDX) {
  59                 rte_spinlock_unlock(&rte_mempool_ops_table.sl);
  60                 RTE_LOG(ERR, MEMPOOL,
  61                         "Maximum number of mempool ops structs exceeded\n");
  62                 return -ENOSPC;
  63         }
  64
  65         if (h->alloc == NULL || h->enqueue == NULL ||
  66                         h->dequeue == NULL || h->get_count == NULL) {
  67                 rte_spinlock_unlock(&rte_mempool_ops_table.sl);
  68                 RTE_LOG(ERR, MEMPOOL,
  69                         "Missing callback while registering mempool ops\n");
  70                 return -EINVAL;
  71         }
  72
  73         if (strlen(h->name) >= sizeof(ops->name) - 1) {
  74                 rte_spinlock_unlock(&rte_mempool_ops_table.sl);
  75                 RTE_LOG(DEBUG, EAL, "%s(): mempool_ops <%s>: name too long\n",
  76                                 __func__, h->name);
  77                 rte_errno = EEXIST;
  78                 return -EEXIST;
  79         }
  80
  81         ops_index = rte_mempool_ops_table.num_ops++;
  82         ops = &rte_mempool_ops_table.ops[ops_index];
  83         snprintf(ops->name, sizeof(ops->name), "%s", h->name);
  84         ops->alloc = h->alloc;
  85         ops->free = h->free;
  86         ops->enqueue = h->enqueue;
  87         ops->dequeue = h->dequeue;
  88         ops->get_count = h->get_count;
  89         ops->get_capabilities = h->get_capabilities;
  90
  91         rte_spinlock_unlock(&rte_mempool_ops_table.sl);
  92
  93         return ops_index;
  94 }
  95
  96 /* wrapper to allocate an external mempool's private (pool) data. */
  97 int
  98 rte_mempool_ops_alloc(struct rte_mempool *mp)
  99 {
 100         struct rte_mempool_ops *ops;
 101
 102         ops = rte_mempool_get_ops(mp->ops_index);
 103         return ops->alloc(mp);
 104 }
 105
 106 /* wrapper to free an external pool ops. */
 107 void
 108 rte_mempool_ops_free(struct rte_mempool *mp)
 109 {
 110         struct rte_mempool_ops *ops;
 111
 112         ops = rte_mempool_get_ops(mp->ops_index);
 113         if (ops->free == NULL)
 114                 return;
 115         ops->free(mp);
 116 }
 117
 118 /* wrapper to get available objects in an external mempool. */
 119 unsigned int
 120 rte_mempool_ops_get_count(const struct rte_mempool *mp)
 121 {
 122         struct rte_mempool_ops *ops;
 123
 124         ops = rte_mempool_get_ops(mp->ops_index);
 125         return ops->get_count(mp);
 126 }
 127
 128 /* wrapper to get external mempool capabilities. */
 129 int
 130 rte_mempool_ops_get_capabilities(const struct rte_mempool *mp,
 131                                         unsigned int *flags)
 132 {
 133         struct rte_mempool_ops *ops;
 134
 135         ops = rte_mempool_get_ops(mp->ops_index);
 136
 137         RTE_FUNC_PTR_OR_ERR_RET(ops->get_capabilities, -ENOTSUP);
 138         return ops->get_capabilities(mp, flags);
 139 }
 140
 141 /* sets mempool ops previously registered by rte_mempool_register_ops. */
 142 int
 143 rte_mempool_set_ops_byname(struct rte_mempool *mp, const char *name,
 144         void *pool_config)
 145 {
 146         struct rte_mempool_ops *ops = NULL;
 147         unsigned i;
 148
 149         /* too late, the mempool is already populated. */
 150         if (mp->flags & MEMPOOL_F_POOL_CREATED)
 151                 return -EEXIST;
 152
 153         for (i = 0; i < rte_mempool_ops_table.num_ops; i++) {
 154                 if (!strcmp(name,
 155                                 rte_mempool_ops_table.ops[i].name)) {
 156                         ops = &rte_mempool_ops_table.ops[i];
 157                         break;
 158                 }
 159         }
 160
 161         if (ops == NULL)
 162                 return -EINVAL;
 163
 164         mp->ops_index = i;
 165         mp->pool_config = pool_config;
 166         return 0;
 167 }