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