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 #include <rte_eal_memconfig.h>
   7 #include <rte_mempool.h>
   8 #include <rte_malloc.h>
   9 #include <rte_rwlock.h>
  10 #include <rte_bus_pci.h>
  11
  12 #include <mlx5_common_mp.h>
  13 #include <mlx5_common_mr.h>
  14
  15 #include "mlx5.h"
  16 #include "mlx5_mr.h"
  17 #include "mlx5_rxtx.h"
  18 #include "mlx5_rx.h"
  19 #include "mlx5_tx.h"
  20
  21 struct mr_find_contig_memsegs_data {
  22         uintptr_t addr;
  23         uintptr_t start;
  24         uintptr_t end;
  25         const struct rte_memseg_list *msl;
  26 };
  27
  28 struct mr_update_mp_data {
  29         struct rte_eth_dev *dev;
  30         struct mlx5_mr_ctrl *mr_ctrl;
  31         int ret;
  32 };
  33
  34 /**
  35  * Callback for memory free event. Iterate freed memsegs and check whether it
  36  * belongs to an existing MR. If found, clear the bit from bitmap of MR. As a
  37  * result, the MR would be fragmented. If it becomes empty, the MR will be freed
  38  * later by mlx5_mr_garbage_collect(). Even if this callback is called from a
  39  * secondary process, the garbage collector will be called in primary process
  40  * as the secondary process can't call mlx5_mr_create().
  41  *
  42  * The global cache must be rebuilt if there's any change and this event has to
  43  * be propagated to dataplane threads to flush the local caches.
  44  *
  45  * @param sh
  46  *   Pointer to the Ethernet device shared context.
  47  * @param addr
  48  *   Address of freed memory.
  49  * @param len
  50  *   Size of freed memory.
  51  */
  52 static void
  53 mlx5_mr_mem_event_free_cb(struct mlx5_dev_ctx_shared *sh,
  54                           const void *addr, size_t len)
  55 {
  56         const struct rte_memseg_list *msl;
  57         struct mlx5_mr *mr;
  58         int ms_n;
  59         int i;
  60         int rebuild = 0;
  61
  62         DRV_LOG(DEBUG, "device %s free callback: addr=%p, len=%zu",
  63               sh->ibdev_name, addr, len);
  64         msl = rte_mem_virt2memseg_list(addr);
  65         /* addr and len must be page-aligned. */
  66         MLX5_ASSERT((uintptr_t)addr ==
  67                     RTE_ALIGN((uintptr_t)addr, msl->page_sz));
  68         MLX5_ASSERT(len == RTE_ALIGN(len, msl->page_sz));
  69         ms_n = len / msl->page_sz;
  70         rte_rwlock_write_lock(&sh->share_cache.rwlock);
  71         /* Clear bits of freed memsegs from MR. */
  72         for (i = 0; i < ms_n; ++i) {
  73                 const struct rte_memseg *ms;
  74                 struct mr_cache_entry entry;
  75                 uintptr_t start;
  76                 int ms_idx;
  77                 uint32_t pos;
  78
  79                 /* Find MR having this memseg. */
  80                 start = (uintptr_t)addr + i * msl->page_sz;
  81                 mr = mlx5_mr_lookup_list(&sh->share_cache, &entry, start);
  82                 if (mr == NULL)
  83                         continue;
  84                 MLX5_ASSERT(mr->msl); /* Can't be external memory. */
  85                 ms = rte_mem_virt2memseg((void *)start, msl);
  86                 MLX5_ASSERT(ms != NULL);
  87                 MLX5_ASSERT(msl->page_sz == ms->hugepage_sz);
  88                 ms_idx = rte_fbarray_find_idx(&msl->memseg_arr, ms);
  89                 pos = ms_idx - mr->ms_base_idx;
  90                 MLX5_ASSERT(rte_bitmap_get(mr->ms_bmp, pos));
  91                 MLX5_ASSERT(pos < mr->ms_bmp_n);
  92                 DRV_LOG(DEBUG, "device %s MR(%p): clear bitmap[%u] for addr %p",
  93                       sh->ibdev_name, (void *)mr, pos, (void *)start);
  94                 rte_bitmap_clear(mr->ms_bmp, pos);
  95                 if (--mr->ms_n == 0) {
  96                         LIST_REMOVE(mr, mr);
  97                         LIST_INSERT_HEAD(&sh->share_cache.mr_free_list, mr, mr);
  98                         DRV_LOG(DEBUG, "device %s remove MR(%p) from list",
  99                               sh->ibdev_name, (void *)mr);
 100                 }
 101                 /*
 102                  * MR is fragmented or will be freed. the global cache must be
 103                  * rebuilt.
 104                  */
 105                 rebuild = 1;
 106         }
 107         if (rebuild) {
 108                 mlx5_mr_rebuild_cache(&sh->share_cache);
 109                 /*
 110                  * No explicit wmb is needed after updating dev_gen due to
 111                  * store-release ordering in unlock that provides the
 112                  * implicit barrier at the software visible level.
 113                  */
 114                 ++sh->share_cache.dev_gen;
 115                 DRV_LOG(DEBUG, "broadcasting local cache flush, gen=%d",
 116                       sh->share_cache.dev_gen);
 117         }
 118         rte_rwlock_write_unlock(&sh->share_cache.rwlock);
 119 }
 120
 121 /**
 122  * Callback for memory event. This can be called from both primary and secondary
 123  * process.
 124  *
 125  * @param event_type
 126  *   Memory event type.
 127  * @param addr
 128  *   Address of memory.
 129  * @param len
 130  *   Size of memory.
 131  */
 132 void
 133 mlx5_mr_mem_event_cb(enum rte_mem_event event_type, const void *addr,
 134                      size_t len, void *arg __rte_unused)
 135 {
 136         struct mlx5_dev_ctx_shared *sh;
 137         struct mlx5_dev_list *dev_list = &mlx5_shared_data->mem_event_cb_list;
 138
 139         /* Must be called from the primary process. */
 140         MLX5_ASSERT(rte_eal_process_type() == RTE_PROC_PRIMARY);
 141         switch (event_type) {
 142         case RTE_MEM_EVENT_FREE:
 143                 rte_rwlock_write_lock(&mlx5_shared_data->mem_event_rwlock);
 144                 /* Iterate all the existing mlx5 devices. */
 145                 LIST_FOREACH(sh, dev_list, mem_event_cb)
 146                         mlx5_mr_mem_event_free_cb(sh, addr, len);
 147                 rte_rwlock_write_unlock(&mlx5_shared_data->mem_event_rwlock);
 148                 break;
 149         case RTE_MEM_EVENT_ALLOC:
 150         default:
 151                 break;
 152         }
 153 }
 154
 155 /**
 156  * Bottom-half of LKey search on Rx.
 157  *
 158  * @param rxq
 159  *   Pointer to Rx queue structure.
 160  * @param addr
 161  *   Search key.
 162  *
 163  * @return
 164  *   Searched LKey on success, UINT32_MAX on no match.
 165  */
 166 uint32_t
 167 mlx5_rx_addr2mr_bh(struct mlx5_rxq_data *rxq, uintptr_t addr)
 168 {
 169         struct mlx5_rxq_ctrl *rxq_ctrl =
 170                 container_of(rxq, struct mlx5_rxq_ctrl, rxq);
 171         struct mlx5_mr_ctrl *mr_ctrl = &rxq->mr_ctrl;
 172         struct mlx5_priv *priv = rxq_ctrl->priv;
 173
 174         return mlx5_mr_addr2mr_bh(priv->sh->pd, &priv->mp_id,
 175                                   &priv->sh->share_cache, mr_ctrl, addr,
 176                                   priv->config.mr_ext_memseg_en);
 177 }
 178
 179 /**
 180  * Bottom-half of LKey search on Tx.
 181  *
 182  * @param txq
 183  *   Pointer to Tx queue structure.
 184  * @param addr
 185  *   Search key.
 186  *
 187  * @return
 188  *   Searched LKey on success, UINT32_MAX on no match.
 189  */
 190 static uint32_t
 191 mlx5_tx_addr2mr_bh(struct mlx5_txq_data *txq, uintptr_t addr)
 192 {
 193         struct mlx5_txq_ctrl *txq_ctrl =
 194                 container_of(txq, struct mlx5_txq_ctrl, txq);
 195         struct mlx5_mr_ctrl *mr_ctrl = &txq->mr_ctrl;
 196         struct mlx5_priv *priv = txq_ctrl->priv;
 197
 198         return mlx5_mr_addr2mr_bh(priv->sh->pd, &priv->mp_id,
 199                                   &priv->sh->share_cache, mr_ctrl, addr,
 200                                   priv->config.mr_ext_memseg_en);
 201 }
 202
 203 /**
 204  * Bottom-half of LKey search on Tx. If it can't be searched in the memseg
 205  * list, register the mempool of the mbuf as externally allocated memory.
 206  *
 207  * @param txq
 208  *   Pointer to Tx queue structure.
 209  * @param mb
 210  *   Pointer to mbuf.
 211  *
 212  * @return
 213  *   Searched LKey on success, UINT32_MAX on no match.
 214  */
 215 uint32_t
 216 mlx5_tx_mb2mr_bh(struct mlx5_txq_data *txq, struct rte_mbuf *mb)
 217 {
 218         uintptr_t addr = (uintptr_t)mb->buf_addr;
 219         uint32_t lkey;
 220
 221         lkey = mlx5_tx_addr2mr_bh(txq, addr);
 222         if (lkey == UINT32_MAX && rte_errno == ENXIO) {
 223                 /* Mempool may have externally allocated memory. */
 224                 return mlx5_tx_update_ext_mp(txq, addr, mlx5_mb2mp(mb));
 225         }
 226         return lkey;
 227 }
 228
 229 /**
 230  * Called during rte_mempool_mem_iter() by mlx5_mr_update_ext_mp().
 231  *
 232  * Externally allocated chunk is registered and a MR is created for the chunk.
 233  * The MR object is added to the global list. If memseg list of a MR object
 234  * (mr->msl) is null, the MR object can be regarded as externally allocated
 235  * memory.
 236  *
 237  * Once external memory is registered, it should be static. If the memory is
 238  * freed and the virtual address range has different physical memory mapped
 239  * again, it may cause crash on device due to the wrong translation entry. PMD
 240  * can't track the free event of the external memory for now.
 241  */
 242 static void
 243 mlx5_mr_update_ext_mp_cb(struct rte_mempool *mp, void *opaque,
 244                          struct rte_mempool_memhdr *memhdr,
 245                          unsigned mem_idx __rte_unused)
 246 {
 247         struct mr_update_mp_data *data = opaque;
 248         struct rte_eth_dev *dev = data->dev;
 249         struct mlx5_priv *priv = dev->data->dev_private;
 250         struct mlx5_dev_ctx_shared *sh = priv->sh;
 251         struct mlx5_mr_ctrl *mr_ctrl = data->mr_ctrl;
 252         struct mlx5_mr *mr = NULL;
 253         uintptr_t addr = (uintptr_t)memhdr->addr;
 254         size_t len = memhdr->len;
 255         struct mr_cache_entry entry;
 256         uint32_t lkey;
 257
 258         MLX5_ASSERT(rte_eal_process_type() == RTE_PROC_PRIMARY);
 259         /* If already registered, it should return. */
 260         rte_rwlock_read_lock(&sh->share_cache.rwlock);
 261         lkey = mlx5_mr_lookup_cache(&sh->share_cache, &entry, addr);
 262         rte_rwlock_read_unlock(&sh->share_cache.rwlock);
 263         if (lkey != UINT32_MAX)
 264                 return;
 265         DRV_LOG(DEBUG, "port %u register MR for chunk #%d of mempool (%s)",
 266                 dev->data->port_id, mem_idx, mp->name);
 267         mr = mlx5_create_mr_ext(sh->pd, addr, len, mp->socket_id,
 268                                 sh->share_cache.reg_mr_cb);
 269         if (!mr) {
 270                 DRV_LOG(WARNING,
 271                         "port %u unable to allocate a new MR of"
 272                         " mempool (%s).",
 273                         dev->data->port_id, mp->name);
 274                 data->ret = -1;
 275                 return;
 276         }
 277         rte_rwlock_write_lock(&sh->share_cache.rwlock);
 278         LIST_INSERT_HEAD(&sh->share_cache.mr_list, mr, mr);
 279         /* Insert to the global cache table. */
 280         mlx5_mr_insert_cache(&sh->share_cache, mr);
 281         rte_rwlock_write_unlock(&sh->share_cache.rwlock);
 282         /* Insert to the local cache table */
 283         mlx5_mr_addr2mr_bh(sh->pd, &priv->mp_id, &sh->share_cache,
 284                            mr_ctrl, addr, priv->config.mr_ext_memseg_en);
 285 }
 286
 287 /**
 288  * Finds the first ethdev that match the pci device.
 289  * The existence of multiple ethdev per pci device is only with representors.
 290  * On such case, it is enough to get only one of the ports as they all share
 291  * the same ibv context.
 292  *
 293  * @param pdev
 294  *   Pointer to the PCI device.
 295  *
 296  * @return
 297  *   Pointer to the ethdev if found, NULL otherwise.
 298  */
 299 static struct rte_eth_dev *
 300 pci_dev_to_eth_dev(struct rte_pci_device *pdev)
 301 {
 302         uint16_t port_id;
 303
 304         port_id = rte_eth_find_next_of(0, &pdev->device);
 305         if (port_id == RTE_MAX_ETHPORTS)
 306                 return NULL;
 307         return &rte_eth_devices[port_id];
 308 }
 309
 310 /**
 311  * DPDK callback to DMA map external memory to a PCI device.
 312  *
 313  * @param pdev
 314  *   Pointer to the PCI device.
 315  * @param addr
 316  *   Starting virtual address of memory to be mapped.
 317  * @param iova
 318  *   Starting IOVA address of memory to be mapped.
 319  * @param len
 320  *   Length of memory segment being mapped.
 321  *
 322  * @return
 323  *   0 on success, negative value on error.
 324  */
 325 int
 326 mlx5_dma_map(struct rte_pci_device *pdev, void *addr,
 327              uint64_t iova __rte_unused, size_t len)
 328 {
 329         struct rte_eth_dev *dev;
 330         struct mlx5_mr *mr;
 331         struct mlx5_priv *priv;
 332         struct mlx5_dev_ctx_shared *sh;
 333
 334         dev = pci_dev_to_eth_dev(pdev);
 335         if (!dev) {
 336                 DRV_LOG(WARNING, "unable to find matching ethdev "
 337                                  "to PCI device %p", (void *)pdev);
 338                 rte_errno = ENODEV;
 339                 return -1;
 340         }
 341         priv = dev->data->dev_private;
 342         sh = priv->sh;
 343         mr = mlx5_create_mr_ext(sh->pd, (uintptr_t)addr, len, SOCKET_ID_ANY,
 344                                 sh->share_cache.reg_mr_cb);
 345         if (!mr) {
 346                 DRV_LOG(WARNING,
 347                         "port %u unable to dma map", dev->data->port_id);
 348                 rte_errno = EINVAL;
 349                 return -1;
 350         }
 351         rte_rwlock_write_lock(&sh->share_cache.rwlock);
 352         LIST_INSERT_HEAD(&sh->share_cache.mr_list, mr, mr);
 353         /* Insert to the global cache table. */
 354         mlx5_mr_insert_cache(&sh->share_cache, mr);
 355         rte_rwlock_write_unlock(&sh->share_cache.rwlock);
 356         return 0;
 357 }
 358
 359 /**
 360  * DPDK callback to DMA unmap external memory to a PCI device.
 361  *
 362  * @param pdev
 363  *   Pointer to the PCI device.
 364  * @param addr
 365  *   Starting virtual address of memory to be unmapped.
 366  * @param iova
 367  *   Starting IOVA address of memory to be unmapped.
 368  * @param len
 369  *   Length of memory segment being unmapped.
 370  *
 371  * @return
 372  *   0 on success, negative value on error.
 373  */
 374 int
 375 mlx5_dma_unmap(struct rte_pci_device *pdev, void *addr,
 376                uint64_t iova __rte_unused, size_t len __rte_unused)
 377 {
 378         struct rte_eth_dev *dev;
 379         struct mlx5_priv *priv;
 380         struct mlx5_dev_ctx_shared *sh;
 381         struct mlx5_mr *mr;
 382         struct mr_cache_entry entry;
 383
 384         dev = pci_dev_to_eth_dev(pdev);
 385         if (!dev) {
 386                 DRV_LOG(WARNING, "unable to find matching ethdev "
 387                                  "to PCI device %p", (void *)pdev);
 388                 rte_errno = ENODEV;
 389                 return -1;
 390         }
 391         priv = dev->data->dev_private;
 392         sh = priv->sh;
 393         rte_rwlock_read_lock(&sh->share_cache.rwlock);
 394         mr = mlx5_mr_lookup_list(&sh->share_cache, &entry, (uintptr_t)addr);
 395         if (!mr) {
 396                 rte_rwlock_read_unlock(&sh->share_cache.rwlock);
 397                 DRV_LOG(WARNING, "address 0x%" PRIxPTR " wasn't registered "
 398                                  "to PCI device %p", (uintptr_t)addr,
 399                                  (void *)pdev);
 400                 rte_errno = EINVAL;
 401                 return -1;
 402         }
 403         LIST_REMOVE(mr, mr);
 404         mlx5_mr_free(mr, sh->share_cache.dereg_mr_cb);
 405         DRV_LOG(DEBUG, "port %u remove MR(%p) from list", dev->data->port_id,
 406               (void *)mr);
 407         mlx5_mr_rebuild_cache(&sh->share_cache);
 408         /*
 409          * No explicit wmb is needed after updating dev_gen due to
 410          * store-release ordering in unlock that provides the
 411          * implicit barrier at the software visible level.
 412          */
 413         ++sh->share_cache.dev_gen;
 414         DRV_LOG(DEBUG, "broadcasting local cache flush, gen=%d",
 415               sh->share_cache.dev_gen);
 416         rte_rwlock_read_unlock(&sh->share_cache.rwlock);
 417         return 0;
 418 }
 419
 420 /**
 421  * Register MR for entire memory chunks in a Mempool having externally allocated
 422  * memory and fill in local cache.
 423  *
 424  * @param dev
 425  *   Pointer to Ethernet device.
 426  * @param mr_ctrl
 427  *   Pointer to per-queue MR control structure.
 428  * @param mp
 429  *   Pointer to registering Mempool.
 430  *
 431  * @return
 432  *   0 on success, -1 on failure.
 433  */
 434 static uint32_t
 435 mlx5_mr_update_ext_mp(struct rte_eth_dev *dev, struct mlx5_mr_ctrl *mr_ctrl,
 436                       struct rte_mempool *mp)
 437 {
 438         struct mr_update_mp_data data = {
 439                 .dev = dev,
 440                 .mr_ctrl = mr_ctrl,
 441                 .ret = 0,
 442         };
 443
 444         rte_mempool_mem_iter(mp, mlx5_mr_update_ext_mp_cb, &data);
 445         return data.ret;
 446 }
 447
 448 /**
 449  * Register MR entire memory chunks in a Mempool having externally allocated
 450  * memory and search LKey of the address to return.
 451  *
 452  * @param dev
 453  *   Pointer to Ethernet device.
 454  * @param addr
 455  *   Search key.
 456  * @param mp
 457  *   Pointer to registering Mempool where addr belongs.
 458  *
 459  * @return
 460  *   LKey for address on success, UINT32_MAX on failure.
 461  */
 462 uint32_t
 463 mlx5_tx_update_ext_mp(struct mlx5_txq_data *txq, uintptr_t addr,
 464                       struct rte_mempool *mp)
 465 {
 466         struct mlx5_txq_ctrl *txq_ctrl =
 467                 container_of(txq, struct mlx5_txq_ctrl, txq);
 468         struct mlx5_mr_ctrl *mr_ctrl = &txq->mr_ctrl;
 469         struct mlx5_priv *priv = txq_ctrl->priv;
 470
 471         if (rte_eal_process_type() != RTE_PROC_PRIMARY) {
 472                 DRV_LOG(WARNING,
 473                         "port %u using address (%p) from unregistered mempool"
 474                         " having externally allocated memory"
 475                         " in secondary process, please create mempool"
 476                         " prior to rte_eth_dev_start()",
 477                         PORT_ID(priv), (void *)addr);
 478                 return UINT32_MAX;
 479         }
 480         mlx5_mr_update_ext_mp(ETH_DEV(priv), mr_ctrl, mp);
 481         return mlx5_tx_addr2mr_bh(txq, addr);
 482 }
 483
 484 /* Called during rte_mempool_mem_iter() by mlx5_mr_update_mp(). */
 485 static void
 486 mlx5_mr_update_mp_cb(struct rte_mempool *mp __rte_unused, void *opaque,
 487                      struct rte_mempool_memhdr *memhdr,
 488                      unsigned mem_idx __rte_unused)
 489 {
 490         struct mr_update_mp_data *data = opaque;
 491         struct rte_eth_dev *dev = data->dev;
 492         struct mlx5_priv *priv = dev->data->dev_private;
 493
 494         uint32_t lkey;
 495
 496         /* Stop iteration if failed in the previous walk. */
 497         if (data->ret < 0)
 498                 return;
 499         /* Register address of the chunk and update local caches. */
 500         lkey = mlx5_mr_addr2mr_bh(priv->sh->pd, &priv->mp_id,
 501                                   &priv->sh->share_cache, data->mr_ctrl,
 502                                   (uintptr_t)memhdr->addr,
 503                                   priv->config.mr_ext_memseg_en);
 504         if (lkey == UINT32_MAX)
 505                 data->ret = -1;
 506 }
 507
 508 /**
 509  * Register entire memory chunks in a Mempool.
 510  *
 511  * @param dev
 512  *   Pointer to Ethernet device.
 513  * @param mr_ctrl
 514  *   Pointer to per-queue MR control structure.
 515  * @param mp
 516  *   Pointer to registering Mempool.
 517  *
 518  * @return
 519  *   0 on success, -1 on failure.
 520  */
 521 int
 522 mlx5_mr_update_mp(struct rte_eth_dev *dev, struct mlx5_mr_ctrl *mr_ctrl,
 523                   struct rte_mempool *mp)
 524 {
 525         struct mr_update_mp_data data = {
 526                 .dev = dev,
 527                 .mr_ctrl = mr_ctrl,
 528                 .ret = 0,
 529         };
 530         uint32_t flags = rte_pktmbuf_priv_flags(mp);
 531
 532         if (flags & RTE_PKTMBUF_POOL_F_PINNED_EXT_BUF) {
 533                 /*
 534                  * The pinned external buffer should be registered for DMA
 535                  * operations by application. The mem_list of the pool contains
 536                  * the list of chunks with mbuf structures w/o built-in data
 537                  * buffers and DMA actually does not happen there, no need
 538                  * to create MR for these chunks.
 539                  */
 540                 return 0;
 541         }
 542         DRV_LOG(DEBUG, "Port %u Rx queue registering mp %s "
 543                        "having %u chunks.", dev->data->port_id,
 544                        mp->name, mp->nb_mem_chunks);
 545         rte_mempool_mem_iter(mp, mlx5_mr_update_mp_cb, &data);
 546         if (data.ret < 0 && rte_errno == ENXIO) {
 547                 /* Mempool may have externally allocated memory. */
 548                 return mlx5_mr_update_ext_mp(dev, mr_ctrl, mp);
 549         }
 550         return data.ret;
 551 }