drivers/net/mlx5/mlx5_mr.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright 2016 6WIND S.A.
   3  * Copyright 2016 Mellanox Technologies, Ltd
   4  */
   5
   6 #ifdef PEDANTIC
   7 #pragma GCC diagnostic ignored "-Wpedantic"
   8 #endif
   9 #include <infiniband/verbs.h>
  10 #ifdef PEDANTIC
  11 #pragma GCC diagnostic error "-Wpedantic"
  12 #endif
  13
  14 #include <rte_mempool.h>
  15 #include <rte_malloc.h>
  16
  17 #include "mlx5.h"
  18 #include "mlx5_rxtx.h"
  19 #include "mlx5_glue.h"
  20
  21 struct mlx5_check_mempool_data {
  22         int ret;
  23         char *start;
  24         char *end;
  25 };
  26
  27 /* Called by mlx5_check_mempool() when iterating the memory chunks. */
  28 static void
  29 mlx5_check_mempool_cb(struct rte_mempool *mp __rte_unused,
  30                       void *opaque, struct rte_mempool_memhdr *memhdr,
  31                       unsigned int mem_idx __rte_unused)
  32 {
  33         struct mlx5_check_mempool_data *data = opaque;
  34
  35         /* It already failed, skip the next chunks. */
  36         if (data->ret != 0)
  37                 return;
  38         /* It is the first chunk. */
  39         if (data->start == NULL && data->end == NULL) {
  40                 data->start = memhdr->addr;
  41                 data->end = data->start + memhdr->len;
  42                 return;
  43         }
  44         if (data->end == memhdr->addr) {
  45                 data->end += memhdr->len;
  46                 return;
  47         }
  48         if (data->start == (char *)memhdr->addr + memhdr->len) {
  49                 data->start -= memhdr->len;
  50                 return;
  51         }
  52         /* Error, mempool is not virtually contiguous. */
  53         data->ret = -1;
  54 }
  55
  56 /**
  57  * Check if a mempool can be used: it must be virtually contiguous.
  58  *
  59  * @param[in] mp
  60  *   Pointer to memory pool.
  61  * @param[out] start
  62  *   Pointer to the start address of the mempool virtual memory area
  63  * @param[out] end
  64  *   Pointer to the end address of the mempool virtual memory area
  65  *
  66  * @return
  67  *   0 on success (mempool is virtually contiguous), -1 on error.
  68  */
  69 static int
  70 mlx5_check_mempool(struct rte_mempool *mp, uintptr_t *start,
  71                    uintptr_t *end)
  72 {
  73         struct mlx5_check_mempool_data data;
  74
  75         memset(&data, 0, sizeof(data));
  76         rte_mempool_mem_iter(mp, mlx5_check_mempool_cb, &data);
  77         *start = (uintptr_t)data.start;
  78         *end = (uintptr_t)data.end;
  79         return data.ret;
  80 }
  81
  82 /**
  83  * Register a Memory Region (MR) <-> Memory Pool (MP) association in
  84  * txq->mp2mr[]. If mp2mr[] is full, remove an entry first.
  85  *
  86  * @param txq
  87  *   Pointer to TX queue structure.
  88  * @param[in] mp
  89  *   Memory Pool for which a Memory Region lkey must be returned.
  90  * @param idx
  91  *   Index of the next available entry.
  92  *
  93  * @return
  94  *   mr on success, NULL on failure and rte_errno is set.
  95  */
  96 struct mlx5_mr *
  97 mlx5_txq_mp2mr_reg(struct mlx5_txq_data *txq, struct rte_mempool *mp,
  98                    unsigned int idx)
  99 {
 100         struct mlx5_txq_ctrl *txq_ctrl =
 101                 container_of(txq, struct mlx5_txq_ctrl, txq);
 102         struct rte_eth_dev *dev;
 103         struct mlx5_mr *mr;
 104
 105         rte_spinlock_lock(&txq_ctrl->priv->mr_lock);
 106         /* Add a new entry, register MR first. */
 107         DRV_LOG(DEBUG, "port %u discovered new memory pool \"%s\" (%p)",
 108                 PORT_ID(txq_ctrl->priv), mp->name, (void *)mp);
 109         dev = ETH_DEV(txq_ctrl->priv);
 110         mr = mlx5_mr_get(dev, mp);
 111         if (mr == NULL) {
 112                 if (rte_eal_process_type() != RTE_PROC_PRIMARY) {
 113                         DRV_LOG(DEBUG,
 114                                 "port %u using unregistered mempool 0x%p(%s)"
 115                                 " in secondary process, please create mempool"
 116                                 " before rte_eth_dev_start()",
 117                                 PORT_ID(txq_ctrl->priv), (void *)mp, mp->name);
 118                         rte_spinlock_unlock(&txq_ctrl->priv->mr_lock);
 119                         rte_errno = ENOTSUP;
 120                         return NULL;
 121                 }
 122                 mr = mlx5_mr_new(dev, mp);
 123         }
 124         if (unlikely(mr == NULL)) {
 125                 DRV_LOG(DEBUG,
 126                         "port %u unable to configure memory region,"
 127                         " ibv_reg_mr() failed.",
 128                         PORT_ID(txq_ctrl->priv));
 129                 rte_spinlock_unlock(&txq_ctrl->priv->mr_lock);
 130                 return NULL;
 131         }
 132         if (unlikely(idx == RTE_DIM(txq->mp2mr))) {
 133                 /* Table is full, remove oldest entry. */
 134                 DRV_LOG(DEBUG,
 135                         "port %u memory region <-> memory pool table full, "
 136                         " dropping oldest entry",
 137                         PORT_ID(txq_ctrl->priv));
 138                 --idx;
 139                 mlx5_mr_release(txq->mp2mr[0]);
 140                 memmove(&txq->mp2mr[0], &txq->mp2mr[1],
 141                         (sizeof(txq->mp2mr) - sizeof(txq->mp2mr[0])));
 142         }
 143         /* Store the new entry. */
 144         txq_ctrl->txq.mp2mr[idx] = mr;
 145         DRV_LOG(DEBUG,
 146                 "port %u new memory region lkey for MP \"%s\" (%p): 0x%08"
 147                 PRIu32,
 148                 PORT_ID(txq_ctrl->priv), mp->name, (void *)mp,
 149                 txq_ctrl->txq.mp2mr[idx]->lkey);
 150         rte_spinlock_unlock(&txq_ctrl->priv->mr_lock);
 151         return mr;
 152 }
 153
 154 struct mlx5_mp2mr_mbuf_check_data {
 155         int ret;
 156 };
 157
 158 /**
 159  * Callback function for rte_mempool_obj_iter() to check whether a given
 160  * mempool object looks like a mbuf.
 161  *
 162  * @param[in] mp
 163  *   The mempool pointer
 164  * @param[in] arg
 165  *   Context data (struct txq_mp2mr_mbuf_check_data). Contains the
 166  *   return value.
 167  * @param[in] obj
 168  *   Object address.
 169  * @param index
 170  *   Object index, unused.
 171  */
 172 static void
 173 txq_mp2mr_mbuf_check(struct rte_mempool *mp, void *arg, void *obj,
 174         uint32_t index __rte_unused)
 175 {
 176         struct mlx5_mp2mr_mbuf_check_data *data = arg;
 177         struct rte_mbuf *buf = obj;
 178
 179         /*
 180          * Check whether mbuf structure fits element size and whether mempool
 181          * pointer is valid.
 182          */
 183         if (sizeof(*buf) > mp->elt_size || buf->pool != mp)
 184                 data->ret = -1;
 185 }
 186
 187 /**
 188  * Iterator function for rte_mempool_walk() to register existing mempools and
 189  * fill the MP to MR cache of a TX queue.
 190  *
 191  * @param[in] mp
 192  *   Memory Pool to register.
 193  * @param *arg
 194  *   Pointer to TX queue structure.
 195  */
 196 void
 197 mlx5_mp2mr_iter(struct rte_mempool *mp, void *arg)
 198 {
 199         struct priv *priv = (struct priv *)arg;
 200         struct mlx5_mp2mr_mbuf_check_data data = {
 201                 .ret = 0,
 202         };
 203         struct mlx5_mr *mr;
 204
 205         /* Register mempool only if the first element looks like a mbuf. */
 206         if (rte_mempool_obj_iter(mp, txq_mp2mr_mbuf_check, &data) == 0 ||
 207                         data.ret == -1)
 208                 return;
 209         mr = mlx5_mr_get(ETH_DEV(priv), mp);
 210         if (mr) {
 211                 mlx5_mr_release(mr);
 212                 return;
 213         }
 214         mr = mlx5_mr_new(ETH_DEV(priv), mp);
 215         if (!mr)
 216                 DRV_LOG(ERR, "port %u cannot create memory region: %s",
 217                         PORT_ID(priv), strerror(rte_errno));
 218 }
 219
 220 /**
 221  * Register a new memory region from the mempool and store it in the memory
 222  * region list.
 223  *
 224  * @param dev
 225  *   Pointer to Ethernet device.
 226  * @param mp
 227  *   Pointer to the memory pool to register.
 228  *
 229  * @return
 230  *   The memory region on success, NULL on failure and rte_errno is set.
 231  */
 232 struct mlx5_mr *
 233 mlx5_mr_new(struct rte_eth_dev *dev, struct rte_mempool *mp)
 234 {
 235         struct priv *priv = dev->data->dev_private;
 236         const struct rte_memseg *ms;
 237         uintptr_t start;
 238         uintptr_t end;
 239         struct mlx5_mr *mr;
 240
 241         mr = rte_zmalloc_socket(__func__, sizeof(*mr), 0, mp->socket_id);
 242         if (!mr) {
 243                 DRV_LOG(DEBUG,
 244                         "port %u unable to configure memory region,"
 245                         " ibv_reg_mr() failed.",
 246                         dev->data->port_id);
 247                 rte_errno = ENOMEM;
 248                 return NULL;
 249         }
 250         if (mlx5_check_mempool(mp, &start, &end) != 0) {
 251                 DRV_LOG(ERR, "port %u mempool %p: not virtually contiguous",
 252                         dev->data->port_id, (void *)mp);
 253                 rte_errno = ENOMEM;
 254                 return NULL;
 255         }
 256         DRV_LOG(DEBUG, "port %u mempool %p area start=%p end=%p size=%zu",
 257                 dev->data->port_id, (void *)mp, (void *)start, (void *)end,
 258                 (size_t)(end - start));
 259         /* Save original addresses for exact MR lookup. */
 260         mr->start = start;
 261         mr->end = end;
 262
 263         /* Round start and end to page boundary if found in memory segments. */
 264         ms = rte_mem_virt2memseg((void *)start, NULL);
 265         if (ms != NULL)
 266                 start = RTE_ALIGN_FLOOR(start, ms->hugepage_sz);
 267         end = RTE_ALIGN_CEIL(end, ms->hugepage_sz);
 268         DRV_LOG(DEBUG,
 269                 "port %u mempool %p using start=%p end=%p size=%zu for memory"
 270                 " region",
 271                 dev->data->port_id, (void *)mp, (void *)start, (void *)end,
 272                 (size_t)(end - start));
 273         mr->mr = mlx5_glue->reg_mr(priv->pd, (void *)start, end - start,
 274                                    IBV_ACCESS_LOCAL_WRITE);
 275         if (!mr->mr) {
 276                 rte_errno = ENOMEM;
 277                 return NULL;
 278         }
 279         mr->mp = mp;
 280         mr->lkey = rte_cpu_to_be_32(mr->mr->lkey);
 281         rte_atomic32_inc(&mr->refcnt);
 282         DRV_LOG(DEBUG, "port %u new memory Region %p refcnt: %d",
 283                 dev->data->port_id, (void *)mr, rte_atomic32_read(&mr->refcnt));
 284         LIST_INSERT_HEAD(&priv->mr, mr, next);
 285         return mr;
 286 }
 287
 288 /**
 289  * Search the memory region object in the memory region list.
 290  *
 291  * @param dev
 292  *   Pointer to Ethernet device.
 293  * @param mp
 294  *   Pointer to the memory pool to register.
 295  *
 296  * @return
 297  *   The memory region on success.
 298  */
 299 struct mlx5_mr *
 300 mlx5_mr_get(struct rte_eth_dev *dev, struct rte_mempool *mp)
 301 {
 302         struct priv *priv = dev->data->dev_private;
 303         struct mlx5_mr *mr;
 304
 305         assert(mp);
 306         if (LIST_EMPTY(&priv->mr))
 307                 return NULL;
 308         LIST_FOREACH(mr, &priv->mr, next) {
 309                 if (mr->mp == mp) {
 310                         rte_atomic32_inc(&mr->refcnt);
 311                         DRV_LOG(DEBUG, "port %u memory region %p refcnt: %d",
 312                                 dev->data->port_id, (void *)mr,
 313                                 rte_atomic32_read(&mr->refcnt));
 314                         return mr;
 315                 }
 316         }
 317         return NULL;
 318 }
 319
 320 /**
 321  * Release the memory region object.
 322  *
 323  * @param  mr
 324  *   Pointer to memory region to release.
 325  *
 326  * @return
 327  *   1 while a reference on it exists, 0 when freed.
 328  */
 329 int
 330 mlx5_mr_release(struct mlx5_mr *mr)
 331 {
 332         assert(mr);
 333         DRV_LOG(DEBUG, "memory region %p refcnt: %d", (void *)mr,
 334                 rte_atomic32_read(&mr->refcnt));
 335         if (rte_atomic32_dec_and_test(&mr->refcnt)) {
 336                 claim_zero(mlx5_glue->dereg_mr(mr->mr));
 337                 LIST_REMOVE(mr, next);
 338                 rte_free(mr);
 339                 return 0;
 340         }
 341         return 1;
 342 }
 343
 344 /**
 345  * Verify the flow list is empty
 346  *
 347  * @param dev
 348  *   Pointer to Ethernet device.
 349  *
 350  * @return
 351  *   The number of object not released.
 352  */
 353 int
 354 mlx5_mr_verify(struct rte_eth_dev *dev)
 355 {
 356         struct priv *priv = dev->data->dev_private;
 357         int ret = 0;
 358         struct mlx5_mr *mr;
 359
 360         LIST_FOREACH(mr, &priv->mr, next) {
 361                 DRV_LOG(DEBUG, "port %u memory region %p still referenced",
 362                         dev->data->port_id, (void *)mr);
 363                 ++ret;
 364         }
 365         return ret;
 366 }