1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright 2016 6WIND S.A.
3 * Copyright 2016 Mellanox Technologies, Ltd
7 #pragma GCC diagnostic ignored "-Wpedantic"
9 #include <infiniband/verbs.h>
11 #pragma GCC diagnostic error "-Wpedantic"
14 #include <rte_mempool.h>
15 #include <rte_malloc.h>
16 #include <rte_rwlock.h>
17 #include <rte_bus_pci.h>
21 #include "mlx5_rxtx.h"
22 #include "mlx5_glue.h"
24 struct mr_find_contig_memsegs_data {
28 const struct rte_memseg_list *msl;
31 struct mr_update_mp_data {
32 struct rte_eth_dev *dev;
33 struct mlx5_mr_ctrl *mr_ctrl;
38 * Expand B-tree table to a given size. Can't be called with holding
39 * memory_hotplug_lock or priv->mr.rwlock due to rte_realloc().
42 * Pointer to B-tree structure.
44 * Number of entries for expansion.
47 * 0 on success, -1 on failure.
50 mr_btree_expand(struct mlx5_mr_btree *bt, int n)
58 * Downside of directly using rte_realloc() is that SOCKET_ID_ANY is
59 * used inside if there's no room to expand. Because this is a quite
60 * rare case and a part of very slow path, it is very acceptable.
61 * Initially cache_bh[] will be given practically enough space and once
62 * it is expanded, expansion wouldn't be needed again ever.
64 mem = rte_realloc(bt->table, n * sizeof(struct mlx5_mr_cache), 0);
66 /* Not an error, B-tree search will be skipped. */
67 DRV_LOG(WARNING, "failed to expand MR B-tree (%p) table",
71 DRV_LOG(DEBUG, "expanded MR B-tree table (size=%u)", n);
79 * Look up LKey from given B-tree lookup table, store the last index and return
83 * Pointer to B-tree structure.
85 * Pointer to index. Even on search failure, returns index where it stops
86 * searching so that index can be used when inserting a new entry.
91 * Searched LKey on success, UINT32_MAX on no match.
94 mr_btree_lookup(struct mlx5_mr_btree *bt, uint16_t *idx, uintptr_t addr)
96 struct mlx5_mr_cache *lkp_tbl;
101 lkp_tbl = *bt->table;
103 /* First entry must be NULL for comparison. */
104 assert(bt->len > 0 || (lkp_tbl[0].start == 0 &&
105 lkp_tbl[0].lkey == UINT32_MAX));
108 register uint16_t delta = n >> 1;
110 if (addr < lkp_tbl[base + delta].start) {
117 assert(addr >= lkp_tbl[base].start);
119 if (addr < lkp_tbl[base].end)
120 return lkp_tbl[base].lkey;
126 * Insert an entry to B-tree lookup table.
129 * Pointer to B-tree structure.
131 * Pointer to new entry to insert.
134 * 0 on success, -1 on failure.
137 mr_btree_insert(struct mlx5_mr_btree *bt, struct mlx5_mr_cache *entry)
139 struct mlx5_mr_cache *lkp_tbl;
144 assert(bt->len <= bt->size);
146 lkp_tbl = *bt->table;
147 /* Find out the slot for insertion. */
148 if (mr_btree_lookup(bt, &idx, entry->start) != UINT32_MAX) {
150 "abort insertion to B-tree(%p): already exist at"
151 " idx=%u [0x%" PRIxPTR ", 0x%" PRIxPTR ") lkey=0x%x",
152 (void *)bt, idx, entry->start, entry->end, entry->lkey);
153 /* Already exist, return. */
156 /* If table is full, return error. */
157 if (unlikely(bt->len == bt->size)) {
163 shift = (bt->len - idx) * sizeof(struct mlx5_mr_cache);
165 memmove(&lkp_tbl[idx + 1], &lkp_tbl[idx], shift);
166 lkp_tbl[idx] = *entry;
169 "inserted B-tree(%p)[%u],"
170 " [0x%" PRIxPTR ", 0x%" PRIxPTR ") lkey=0x%x",
171 (void *)bt, idx, entry->start, entry->end, entry->lkey);
176 * Initialize B-tree and allocate memory for lookup table.
179 * Pointer to B-tree structure.
181 * Number of entries to allocate.
183 * NUMA socket on which memory must be allocated.
186 * 0 on success, a negative errno value otherwise and rte_errno is set.
189 mlx5_mr_btree_init(struct mlx5_mr_btree *bt, int n, int socket)
195 assert(!bt->table && !bt->size);
196 memset(bt, 0, sizeof(*bt));
197 bt->table = rte_calloc_socket("B-tree table",
198 n, sizeof(struct mlx5_mr_cache),
200 if (bt->table == NULL) {
202 DEBUG("failed to allocate memory for btree cache on socket %d",
207 /* First entry must be NULL for binary search. */
208 (*bt->table)[bt->len++] = (struct mlx5_mr_cache) {
211 DEBUG("initialized B-tree %p with table %p",
212 (void *)bt, (void *)bt->table);
217 * Free B-tree resources.
220 * Pointer to B-tree structure.
223 mlx5_mr_btree_free(struct mlx5_mr_btree *bt)
227 DEBUG("freeing B-tree %p with table %p",
228 (void *)bt, (void *)bt->table);
230 memset(bt, 0, sizeof(*bt));
234 * Dump all the entries in a B-tree
237 * Pointer to B-tree structure.
240 mlx5_mr_btree_dump(struct mlx5_mr_btree *bt __rte_unused)
244 struct mlx5_mr_cache *lkp_tbl;
248 lkp_tbl = *bt->table;
249 for (idx = 0; idx < bt->len; ++idx) {
250 struct mlx5_mr_cache *entry = &lkp_tbl[idx];
252 DEBUG("B-tree(%p)[%u],"
253 " [0x%" PRIxPTR ", 0x%" PRIxPTR ") lkey=0x%x",
254 (void *)bt, idx, entry->start, entry->end, entry->lkey);
260 * Find virtually contiguous memory chunk in a given MR.
263 * Pointer to MR structure.
265 * Pointer to returning MR cache entry. If not found, this will not be
268 * Start index of the memseg bitmap.
271 * Next index to go on lookup.
274 mr_find_next_chunk(struct mlx5_mr *mr, struct mlx5_mr_cache *entry,
281 /* MR for external memory doesn't have memseg list. */
282 if (mr->msl == NULL) {
283 struct ibv_mr *ibv_mr = mr->ibv_mr;
285 assert(mr->ms_bmp_n == 1);
286 assert(mr->ms_n == 1);
287 assert(base_idx == 0);
289 * Can't search it from memseg list but get it directly from
290 * verbs MR as there's only one chunk.
292 entry->start = (uintptr_t)ibv_mr->addr;
293 entry->end = (uintptr_t)ibv_mr->addr + mr->ibv_mr->length;
294 entry->lkey = rte_cpu_to_be_32(mr->ibv_mr->lkey);
295 /* Returning 1 ends iteration. */
298 for (idx = base_idx; idx < mr->ms_bmp_n; ++idx) {
299 if (rte_bitmap_get(mr->ms_bmp, idx)) {
300 const struct rte_memseg_list *msl;
301 const struct rte_memseg *ms;
304 ms = rte_fbarray_get(&msl->memseg_arr,
305 mr->ms_base_idx + idx);
306 assert(msl->page_sz == ms->hugepage_sz);
309 end = ms->addr_64 + ms->hugepage_sz;
311 /* Passed the end of a fragment. */
316 /* Found one chunk. */
317 entry->start = start;
319 entry->lkey = rte_cpu_to_be_32(mr->ibv_mr->lkey);
325 * Insert a MR to the global B-tree cache. It may fail due to low-on-memory.
326 * Then, this entry will have to be searched by mr_lookup_dev_list() in
327 * mlx5_mr_create() on miss.
330 * Pointer to Ethernet device.
332 * Pointer to MR to insert.
335 * 0 on success, -1 on failure.
338 mr_insert_dev_cache(struct rte_eth_dev *dev, struct mlx5_mr *mr)
340 struct mlx5_priv *priv = dev->data->dev_private;
343 DRV_LOG(DEBUG, "port %u inserting MR(%p) to global cache",
344 dev->data->port_id, (void *)mr);
345 for (n = 0; n < mr->ms_bmp_n; ) {
346 struct mlx5_mr_cache entry;
348 memset(&entry, 0, sizeof(entry));
349 /* Find a contiguous chunk and advance the index. */
350 n = mr_find_next_chunk(mr, &entry, n);
353 if (mr_btree_insert(&priv->mr.cache, &entry) < 0) {
355 * Overflowed, but the global table cannot be expanded
356 * because of deadlock.
365 * Look up address in the original global MR list.
368 * Pointer to Ethernet device.
370 * Pointer to returning MR cache entry. If no match, this will not be updated.
375 * Found MR on match, NULL otherwise.
377 static struct mlx5_mr *
378 mr_lookup_dev_list(struct rte_eth_dev *dev, struct mlx5_mr_cache *entry,
381 struct mlx5_priv *priv = dev->data->dev_private;
384 /* Iterate all the existing MRs. */
385 LIST_FOREACH(mr, &priv->mr.mr_list, mr) {
390 for (n = 0; n < mr->ms_bmp_n; ) {
391 struct mlx5_mr_cache ret;
393 memset(&ret, 0, sizeof(ret));
394 n = mr_find_next_chunk(mr, &ret, n);
395 if (addr >= ret.start && addr < ret.end) {
406 * Look up address on device.
409 * Pointer to Ethernet device.
411 * Pointer to returning MR cache entry. If no match, this will not be updated.
416 * Searched LKey on success, UINT32_MAX on failure and rte_errno is set.
419 mr_lookup_dev(struct rte_eth_dev *dev, struct mlx5_mr_cache *entry,
422 struct mlx5_priv *priv = dev->data->dev_private;
424 uint32_t lkey = UINT32_MAX;
428 * If the global cache has overflowed since it failed to expand the
429 * B-tree table, it can't have all the existing MRs. Then, the address
430 * has to be searched by traversing the original MR list instead, which
431 * is very slow path. Otherwise, the global cache is all inclusive.
433 if (!unlikely(priv->mr.cache.overflow)) {
434 lkey = mr_btree_lookup(&priv->mr.cache, &idx, addr);
435 if (lkey != UINT32_MAX)
436 *entry = (*priv->mr.cache.table)[idx];
438 /* Falling back to the slowest path. */
439 mr = mr_lookup_dev_list(dev, entry, addr);
443 assert(lkey == UINT32_MAX || (addr >= entry->start &&
449 * Free MR resources. MR lock must not be held to avoid a deadlock. rte_free()
450 * can raise memory free event and the callback function will spin on the lock.
453 * Pointer to MR to free.
456 mr_free(struct mlx5_mr *mr)
460 DRV_LOG(DEBUG, "freeing MR(%p):", (void *)mr);
461 if (mr->ibv_mr != NULL)
462 claim_zero(mlx5_glue->dereg_mr(mr->ibv_mr));
463 if (mr->ms_bmp != NULL)
464 rte_bitmap_free(mr->ms_bmp);
469 * Releass resources of detached MR having no online entry.
472 * Pointer to Ethernet device.
475 mlx5_mr_garbage_collect(struct rte_eth_dev *dev)
477 struct mlx5_priv *priv = dev->data->dev_private;
478 struct mlx5_mr *mr_next;
479 struct mlx5_mr_list free_list = LIST_HEAD_INITIALIZER(free_list);
481 /* Must be called from the primary process. */
482 assert(rte_eal_process_type() == RTE_PROC_PRIMARY);
484 * MR can't be freed with holding the lock because rte_free() could call
485 * memory free callback function. This will be a deadlock situation.
487 rte_rwlock_write_lock(&priv->mr.rwlock);
488 /* Detach the whole free list and release it after unlocking. */
489 free_list = priv->mr.mr_free_list;
490 LIST_INIT(&priv->mr.mr_free_list);
491 rte_rwlock_write_unlock(&priv->mr.rwlock);
492 /* Release resources. */
493 mr_next = LIST_FIRST(&free_list);
494 while (mr_next != NULL) {
495 struct mlx5_mr *mr = mr_next;
497 mr_next = LIST_NEXT(mr, mr);
502 /* Called during rte_memseg_contig_walk() by mlx5_mr_create(). */
504 mr_find_contig_memsegs_cb(const struct rte_memseg_list *msl,
505 const struct rte_memseg *ms, size_t len, void *arg)
507 struct mr_find_contig_memsegs_data *data = arg;
509 if (data->addr < ms->addr_64 || data->addr >= ms->addr_64 + len)
511 /* Found, save it and stop walking. */
512 data->start = ms->addr_64;
513 data->end = ms->addr_64 + len;
519 * Create a new global Memroy Region (MR) for a missing virtual address.
520 * Register entire virtually contiguous memory chunk around the address.
523 * Pointer to Ethernet device.
525 * Pointer to returning MR cache entry, found in the global cache or newly
526 * created. If failed to create one, this will not be updated.
528 * Target virtual address to register.
531 * Searched LKey on success, UINT32_MAX on failure and rte_errno is set.
534 mlx5_mr_create(struct rte_eth_dev *dev, struct mlx5_mr_cache *entry,
537 struct mlx5_priv *priv = dev->data->dev_private;
538 struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
539 const struct rte_memseg_list *msl;
540 const struct rte_memseg *ms;
541 struct mlx5_mr *mr = NULL;
546 int ms_idx_shift = -1;
548 struct mr_find_contig_memsegs_data data = {
551 struct mr_find_contig_memsegs_data data_re;
553 DRV_LOG(DEBUG, "port %u creating a MR using address (%p)",
554 dev->data->port_id, (void *)addr);
555 if (rte_eal_process_type() != RTE_PROC_PRIMARY) {
557 "port %u using address (%p) of unregistered mempool"
558 " in secondary process, please create mempool"
559 " before rte_eth_dev_start()",
560 dev->data->port_id, (void *)addr);
565 * Release detached MRs if any. This can't be called with holding either
566 * memory_hotplug_lock or priv->mr.rwlock. MRs on the free list have
567 * been detached by the memory free event but it couldn't be released
568 * inside the callback due to deadlock. As a result, releasing resources
569 * is quite opportunistic.
571 mlx5_mr_garbage_collect(dev);
573 * Find out a contiguous virtual address chunk in use, to which the
574 * given address belongs, in order to register maximum range. In the
575 * best case where mempools are not dynamically recreated and
576 * '--socket-mem' is specified as an EAL option, it is very likely to
577 * have only one MR(LKey) per a socket and per a hugepage-size even
578 * though the system memory is highly fragmented.
580 if (!rte_memseg_contig_walk(mr_find_contig_memsegs_cb, &data)) {
582 "port %u unable to find virtually contiguous"
583 " chunk for address (%p)."
584 " rte_memseg_contig_walk() failed.",
585 dev->data->port_id, (void *)addr);
590 /* Addresses must be page-aligned. */
591 assert(rte_is_aligned((void *)data.start, data.msl->page_sz));
592 assert(rte_is_aligned((void *)data.end, data.msl->page_sz));
594 ms = rte_mem_virt2memseg((void *)data.start, msl);
595 len = data.end - data.start;
596 assert(msl->page_sz == ms->hugepage_sz);
597 /* Number of memsegs in the range. */
598 ms_n = len / msl->page_sz;
599 DEBUG("port %u extending %p to [0x%" PRIxPTR ", 0x%" PRIxPTR "),"
600 " page_sz=0x%" PRIx64 ", ms_n=%u",
601 dev->data->port_id, (void *)addr,
602 data.start, data.end, msl->page_sz, ms_n);
603 /* Size of memory for bitmap. */
604 bmp_size = rte_bitmap_get_memory_footprint(ms_n);
605 mr = rte_zmalloc_socket(NULL,
606 RTE_ALIGN_CEIL(sizeof(*mr),
607 RTE_CACHE_LINE_SIZE) +
609 RTE_CACHE_LINE_SIZE, msl->socket_id);
611 DEBUG("port %u unable to allocate memory for a new MR of"
613 dev->data->port_id, (void *)addr);
619 * Save the index of the first memseg and initialize memseg bitmap. To
620 * see if a memseg of ms_idx in the memseg-list is still valid, check:
621 * rte_bitmap_get(mr->bmp, ms_idx - mr->ms_base_idx)
623 mr->ms_base_idx = rte_fbarray_find_idx(&msl->memseg_arr, ms);
624 bmp_mem = RTE_PTR_ALIGN_CEIL(mr + 1, RTE_CACHE_LINE_SIZE);
625 mr->ms_bmp = rte_bitmap_init(ms_n, bmp_mem, bmp_size);
626 if (mr->ms_bmp == NULL) {
627 DEBUG("port %u unable to initialize bitamp for a new MR of"
629 dev->data->port_id, (void *)addr);
634 * Should recheck whether the extended contiguous chunk is still valid.
635 * Because memory_hotplug_lock can't be held if there's any memory
636 * related calls in a critical path, resource allocation above can't be
637 * locked. If the memory has been changed at this point, try again with
638 * just single page. If not, go on with the big chunk atomically from
641 rte_rwlock_read_lock(&mcfg->memory_hotplug_lock);
643 if (len > msl->page_sz &&
644 !rte_memseg_contig_walk(mr_find_contig_memsegs_cb, &data_re)) {
645 DEBUG("port %u unable to find virtually contiguous"
646 " chunk for address (%p)."
647 " rte_memseg_contig_walk() failed.",
648 dev->data->port_id, (void *)addr);
652 if (data.start != data_re.start || data.end != data_re.end) {
654 * The extended contiguous chunk has been changed. Try again
655 * with single memseg instead.
657 data.start = RTE_ALIGN_FLOOR(addr, msl->page_sz);
658 data.end = data.start + msl->page_sz;
659 rte_rwlock_read_unlock(&mcfg->memory_hotplug_lock);
661 goto alloc_resources;
663 assert(data.msl == data_re.msl);
664 rte_rwlock_write_lock(&priv->mr.rwlock);
666 * Check the address is really missing. If other thread already created
667 * one or it is not found due to overflow, abort and return.
669 if (mr_lookup_dev(dev, entry, addr) != UINT32_MAX) {
671 * Insert to the global cache table. It may fail due to
672 * low-on-memory. Then, this entry will have to be searched
675 mr_btree_insert(&priv->mr.cache, entry);
676 DEBUG("port %u found MR for %p on final lookup, abort",
677 dev->data->port_id, (void *)addr);
678 rte_rwlock_write_unlock(&priv->mr.rwlock);
679 rte_rwlock_read_unlock(&mcfg->memory_hotplug_lock);
681 * Must be unlocked before calling rte_free() because
682 * mlx5_mr_mem_event_free_cb() can be called inside.
688 * Trim start and end addresses for verbs MR. Set bits for registering
689 * memsegs but exclude already registered ones. Bitmap can be
692 for (n = 0; n < ms_n; ++n) {
694 struct mlx5_mr_cache ret;
696 memset(&ret, 0, sizeof(ret));
697 start = data_re.start + n * msl->page_sz;
698 /* Exclude memsegs already registered by other MRs. */
699 if (mr_lookup_dev(dev, &ret, start) == UINT32_MAX) {
701 * Start from the first unregistered memseg in the
704 if (ms_idx_shift == -1) {
705 mr->ms_base_idx += n;
709 data.end = start + msl->page_sz;
710 rte_bitmap_set(mr->ms_bmp, n - ms_idx_shift);
714 len = data.end - data.start;
715 mr->ms_bmp_n = len / msl->page_sz;
716 assert(ms_idx_shift + mr->ms_bmp_n <= ms_n);
718 * Finally create a verbs MR for the memory chunk. ibv_reg_mr() can be
719 * called with holding the memory lock because it doesn't use
720 * mlx5_alloc_buf_extern() which eventually calls rte_malloc_socket()
721 * through mlx5_alloc_verbs_buf().
723 mr->ibv_mr = mlx5_glue->reg_mr(priv->sh->pd, (void *)data.start, len,
724 IBV_ACCESS_LOCAL_WRITE);
725 if (mr->ibv_mr == NULL) {
726 DEBUG("port %u fail to create a verbs MR for address (%p)",
727 dev->data->port_id, (void *)addr);
731 assert((uintptr_t)mr->ibv_mr->addr == data.start);
732 assert(mr->ibv_mr->length == len);
733 LIST_INSERT_HEAD(&priv->mr.mr_list, mr, mr);
734 DEBUG("port %u MR CREATED (%p) for %p:\n"
735 " [0x%" PRIxPTR ", 0x%" PRIxPTR "),"
736 " lkey=0x%x base_idx=%u ms_n=%u, ms_bmp_n=%u",
737 dev->data->port_id, (void *)mr, (void *)addr,
738 data.start, data.end, rte_cpu_to_be_32(mr->ibv_mr->lkey),
739 mr->ms_base_idx, mr->ms_n, mr->ms_bmp_n);
740 /* Insert to the global cache table. */
741 mr_insert_dev_cache(dev, mr);
742 /* Fill in output data. */
743 mr_lookup_dev(dev, entry, addr);
744 /* Lookup can't fail. */
745 assert(entry->lkey != UINT32_MAX);
746 rte_rwlock_write_unlock(&priv->mr.rwlock);
747 rte_rwlock_read_unlock(&mcfg->memory_hotplug_lock);
750 rte_rwlock_write_unlock(&priv->mr.rwlock);
752 rte_rwlock_read_unlock(&mcfg->memory_hotplug_lock);
755 * In case of error, as this can be called in a datapath, a warning
756 * message per an error is preferable instead. Must be unlocked before
757 * calling rte_free() because mlx5_mr_mem_event_free_cb() can be called
765 * Rebuild the global B-tree cache of device from the original MR list.
768 * Pointer to Ethernet device.
771 mr_rebuild_dev_cache(struct rte_eth_dev *dev)
773 struct mlx5_priv *priv = dev->data->dev_private;
776 DRV_LOG(DEBUG, "port %u rebuild dev cache[]", dev->data->port_id);
777 /* Flush cache to rebuild. */
778 priv->mr.cache.len = 1;
779 priv->mr.cache.overflow = 0;
780 /* Iterate all the existing MRs. */
781 LIST_FOREACH(mr, &priv->mr.mr_list, mr)
782 if (mr_insert_dev_cache(dev, mr) < 0)
787 * Callback for memory free event. Iterate freed memsegs and check whether it
788 * belongs to an existing MR. If found, clear the bit from bitmap of MR. As a
789 * result, the MR would be fragmented. If it becomes empty, the MR will be freed
790 * later by mlx5_mr_garbage_collect(). Even if this callback is called from a
791 * secondary process, the garbage collector will be called in primary process
792 * as the secondary process can't call mlx5_mr_create().
794 * The global cache must be rebuilt if there's any change and this event has to
795 * be propagated to dataplane threads to flush the local caches.
798 * Pointer to Ethernet device.
800 * Address of freed memory.
802 * Size of freed memory.
805 mlx5_mr_mem_event_free_cb(struct rte_eth_dev *dev, const void *addr, size_t len)
807 struct mlx5_priv *priv = dev->data->dev_private;
808 const struct rte_memseg_list *msl;
814 DEBUG("port %u free callback: addr=%p, len=%zu",
815 dev->data->port_id, addr, len);
816 msl = rte_mem_virt2memseg_list(addr);
817 /* addr and len must be page-aligned. */
818 assert((uintptr_t)addr == RTE_ALIGN((uintptr_t)addr, msl->page_sz));
819 assert(len == RTE_ALIGN(len, msl->page_sz));
820 ms_n = len / msl->page_sz;
821 rte_rwlock_write_lock(&priv->mr.rwlock);
822 /* Clear bits of freed memsegs from MR. */
823 for (i = 0; i < ms_n; ++i) {
824 const struct rte_memseg *ms;
825 struct mlx5_mr_cache entry;
830 /* Find MR having this memseg. */
831 start = (uintptr_t)addr + i * msl->page_sz;
832 mr = mr_lookup_dev_list(dev, &entry, start);
835 assert(mr->msl); /* Can't be external memory. */
836 ms = rte_mem_virt2memseg((void *)start, msl);
838 assert(msl->page_sz == ms->hugepage_sz);
839 ms_idx = rte_fbarray_find_idx(&msl->memseg_arr, ms);
840 pos = ms_idx - mr->ms_base_idx;
841 assert(rte_bitmap_get(mr->ms_bmp, pos));
842 assert(pos < mr->ms_bmp_n);
843 DEBUG("port %u MR(%p): clear bitmap[%u] for addr %p",
844 dev->data->port_id, (void *)mr, pos, (void *)start);
845 rte_bitmap_clear(mr->ms_bmp, pos);
846 if (--mr->ms_n == 0) {
848 LIST_INSERT_HEAD(&priv->mr.mr_free_list, mr, mr);
849 DEBUG("port %u remove MR(%p) from list",
850 dev->data->port_id, (void *)mr);
853 * MR is fragmented or will be freed. the global cache must be
859 mr_rebuild_dev_cache(dev);
861 * Flush local caches by propagating invalidation across cores.
862 * rte_smp_wmb() is enough to synchronize this event. If one of
863 * freed memsegs is seen by other core, that means the memseg
864 * has been allocated by allocator, which will come after this
865 * free call. Therefore, this store instruction (incrementing
866 * generation below) will be guaranteed to be seen by other core
867 * before the core sees the newly allocated memory.
870 DEBUG("broadcasting local cache flush, gen=%d",
874 rte_rwlock_write_unlock(&priv->mr.rwlock);
878 * Callback for memory event. This can be called from both primary and secondary
889 mlx5_mr_mem_event_cb(enum rte_mem_event event_type, const void *addr,
890 size_t len, void *arg __rte_unused)
892 struct mlx5_priv *priv;
893 struct mlx5_dev_list *dev_list = &mlx5_shared_data->mem_event_cb_list;
895 /* Must be called from the primary process. */
896 assert(rte_eal_process_type() == RTE_PROC_PRIMARY);
897 switch (event_type) {
898 case RTE_MEM_EVENT_FREE:
899 rte_rwlock_write_lock(&mlx5_shared_data->mem_event_rwlock);
900 /* Iterate all the existing mlx5 devices. */
901 LIST_FOREACH(priv, dev_list, mem_event_cb)
902 mlx5_mr_mem_event_free_cb(ETH_DEV(priv), addr, len);
903 rte_rwlock_write_unlock(&mlx5_shared_data->mem_event_rwlock);
905 case RTE_MEM_EVENT_ALLOC:
912 * Look up address in the global MR cache table. If not found, create a new MR.
913 * Insert the found/created entry to local bottom-half cache table.
916 * Pointer to Ethernet device.
918 * Pointer to per-queue MR control structure.
920 * Pointer to returning MR cache entry, found in the global cache or newly
921 * created. If failed to create one, this is not written.
926 * Searched LKey on success, UINT32_MAX on no match.
929 mlx5_mr_lookup_dev(struct rte_eth_dev *dev, struct mlx5_mr_ctrl *mr_ctrl,
930 struct mlx5_mr_cache *entry, uintptr_t addr)
932 struct mlx5_priv *priv = dev->data->dev_private;
933 struct mlx5_mr_btree *bt = &mr_ctrl->cache_bh;
937 /* If local cache table is full, try to double it. */
938 if (unlikely(bt->len == bt->size))
939 mr_btree_expand(bt, bt->size << 1);
940 /* Look up in the global cache. */
941 rte_rwlock_read_lock(&priv->mr.rwlock);
942 lkey = mr_btree_lookup(&priv->mr.cache, &idx, addr);
943 if (lkey != UINT32_MAX) {
945 *entry = (*priv->mr.cache.table)[idx];
946 rte_rwlock_read_unlock(&priv->mr.rwlock);
948 * Update local cache. Even if it fails, return the found entry
949 * to update top-half cache. Next time, this entry will be found
950 * in the global cache.
952 mr_btree_insert(bt, entry);
955 rte_rwlock_read_unlock(&priv->mr.rwlock);
956 /* First time to see the address? Create a new MR. */
957 lkey = mlx5_mr_create(dev, entry, addr);
959 * Update the local cache if successfully created a new global MR. Even
960 * if failed to create one, there's no action to take in this datapath
961 * code. As returning LKey is invalid, this will eventually make HW
964 if (lkey != UINT32_MAX)
965 mr_btree_insert(bt, entry);
970 * Bottom-half of LKey search on datapath. Firstly search in cache_bh[] and if
971 * misses, search in the global MR cache table and update the new entry to
972 * per-queue local caches.
975 * Pointer to Ethernet device.
977 * Pointer to per-queue MR control structure.
982 * Searched LKey on success, UINT32_MAX on no match.
985 mlx5_mr_addr2mr_bh(struct rte_eth_dev *dev, struct mlx5_mr_ctrl *mr_ctrl,
990 /* Victim in top-half cache to replace with new entry. */
991 struct mlx5_mr_cache *repl = &mr_ctrl->cache[mr_ctrl->head];
993 /* Binary-search MR translation table. */
994 lkey = mr_btree_lookup(&mr_ctrl->cache_bh, &bh_idx, addr);
995 /* Update top-half cache. */
996 if (likely(lkey != UINT32_MAX)) {
997 *repl = (*mr_ctrl->cache_bh.table)[bh_idx];
1000 * If missed in local lookup table, search in the global cache
1001 * and local cache_bh[] will be updated inside if possible.
1002 * Top-half cache entry will also be updated.
1004 lkey = mlx5_mr_lookup_dev(dev, mr_ctrl, repl, addr);
1005 if (unlikely(lkey == UINT32_MAX))
1008 /* Update the most recently used entry. */
1009 mr_ctrl->mru = mr_ctrl->head;
1010 /* Point to the next victim, the oldest. */
1011 mr_ctrl->head = (mr_ctrl->head + 1) % MLX5_MR_CACHE_N;
1016 * Bottom-half of LKey search on Rx.
1019 * Pointer to Rx queue structure.
1024 * Searched LKey on success, UINT32_MAX on no match.
1027 mlx5_rx_addr2mr_bh(struct mlx5_rxq_data *rxq, uintptr_t addr)
1029 struct mlx5_rxq_ctrl *rxq_ctrl =
1030 container_of(rxq, struct mlx5_rxq_ctrl, rxq);
1031 struct mlx5_mr_ctrl *mr_ctrl = &rxq->mr_ctrl;
1032 struct mlx5_priv *priv = rxq_ctrl->priv;
1035 "Rx queue %u: miss on top-half, mru=%u, head=%u, addr=%p",
1036 rxq_ctrl->idx, mr_ctrl->mru, mr_ctrl->head, (void *)addr);
1037 return mlx5_mr_addr2mr_bh(ETH_DEV(priv), mr_ctrl, addr);
1041 * Bottom-half of LKey search on Tx.
1044 * Pointer to Tx queue structure.
1049 * Searched LKey on success, UINT32_MAX on no match.
1052 mlx5_tx_addr2mr_bh(struct mlx5_txq_data *txq, uintptr_t addr)
1054 struct mlx5_txq_ctrl *txq_ctrl =
1055 container_of(txq, struct mlx5_txq_ctrl, txq);
1056 struct mlx5_mr_ctrl *mr_ctrl = &txq->mr_ctrl;
1057 struct mlx5_priv *priv = txq_ctrl->priv;
1060 "Tx queue %u: miss on top-half, mru=%u, head=%u, addr=%p",
1061 txq_ctrl->idx, mr_ctrl->mru, mr_ctrl->head, (void *)addr);
1062 return mlx5_mr_addr2mr_bh(ETH_DEV(priv), mr_ctrl, addr);
1066 * Bottom-half of LKey search on Tx. If it can't be searched in the memseg
1067 * list, register the mempool of the mbuf as externally allocated memory.
1070 * Pointer to Tx queue structure.
1075 * Searched LKey on success, UINT32_MAX on no match.
1078 mlx5_tx_mb2mr_bh(struct mlx5_txq_data *txq, struct rte_mbuf *mb)
1080 uintptr_t addr = (uintptr_t)mb->buf_addr;
1083 lkey = mlx5_tx_addr2mr_bh(txq, addr);
1084 if (lkey == UINT32_MAX && rte_errno == ENXIO) {
1085 /* Mempool may have externally allocated memory. */
1086 return mlx5_tx_update_ext_mp(txq, addr, mlx5_mb2mp(mb));
1092 * Flush all of the local cache entries.
1095 * Pointer to per-queue MR control structure.
1098 mlx5_mr_flush_local_cache(struct mlx5_mr_ctrl *mr_ctrl)
1100 /* Reset the most-recently-used index. */
1102 /* Reset the linear search array. */
1104 memset(mr_ctrl->cache, 0, sizeof(mr_ctrl->cache));
1105 /* Reset the B-tree table. */
1106 mr_ctrl->cache_bh.len = 1;
1107 mr_ctrl->cache_bh.overflow = 0;
1108 /* Update the generation number. */
1109 mr_ctrl->cur_gen = *mr_ctrl->dev_gen_ptr;
1110 DRV_LOG(DEBUG, "mr_ctrl(%p): flushed, cur_gen=%d",
1111 (void *)mr_ctrl, mr_ctrl->cur_gen);
1115 * Creates a memory region for external memory, that is memory which is not
1116 * part of the DPDK memory segments.
1119 * Pointer to the ethernet device.
1121 * Starting virtual address of memory.
1123 * Length of memory segment being mapped.
1125 * Socket to allocate heap memory for the control structures.
1128 * Pointer to MR structure on success, NULL otherwise.
1130 static struct mlx5_mr *
1131 mlx5_create_mr_ext(struct rte_eth_dev *dev, uintptr_t addr, size_t len,
1134 struct mlx5_priv *priv = dev->data->dev_private;
1135 struct mlx5_mr *mr = NULL;
1137 mr = rte_zmalloc_socket(NULL,
1138 RTE_ALIGN_CEIL(sizeof(*mr),
1139 RTE_CACHE_LINE_SIZE),
1140 RTE_CACHE_LINE_SIZE, socket_id);
1143 mr->ibv_mr = mlx5_glue->reg_mr(priv->sh->pd, (void *)addr, len,
1144 IBV_ACCESS_LOCAL_WRITE);
1145 if (mr->ibv_mr == NULL) {
1147 "port %u fail to create a verbs MR for address (%p)",
1148 dev->data->port_id, (void *)addr);
1152 mr->msl = NULL; /* Mark it is external memory. */
1157 "port %u MR CREATED (%p) for external memory %p:\n"
1158 " [0x%" PRIxPTR ", 0x%" PRIxPTR "),"
1159 " lkey=0x%x base_idx=%u ms_n=%u, ms_bmp_n=%u",
1160 dev->data->port_id, (void *)mr, (void *)addr,
1161 addr, addr + len, rte_cpu_to_be_32(mr->ibv_mr->lkey),
1162 mr->ms_base_idx, mr->ms_n, mr->ms_bmp_n);
1167 * Called during rte_mempool_mem_iter() by mlx5_mr_update_ext_mp().
1169 * Externally allocated chunk is registered and a MR is created for the chunk.
1170 * The MR object is added to the global list. If memseg list of a MR object
1171 * (mr->msl) is null, the MR object can be regarded as externally allocated
1174 * Once external memory is registered, it should be static. If the memory is
1175 * freed and the virtual address range has different physical memory mapped
1176 * again, it may cause crash on device due to the wrong translation entry. PMD
1177 * can't track the free event of the external memory for now.
1180 mlx5_mr_update_ext_mp_cb(struct rte_mempool *mp, void *opaque,
1181 struct rte_mempool_memhdr *memhdr,
1182 unsigned mem_idx __rte_unused)
1184 struct mr_update_mp_data *data = opaque;
1185 struct rte_eth_dev *dev = data->dev;
1186 struct mlx5_priv *priv = dev->data->dev_private;
1187 struct mlx5_mr_ctrl *mr_ctrl = data->mr_ctrl;
1188 struct mlx5_mr *mr = NULL;
1189 uintptr_t addr = (uintptr_t)memhdr->addr;
1190 size_t len = memhdr->len;
1191 struct mlx5_mr_cache entry;
1194 /* If already registered, it should return. */
1195 rte_rwlock_read_lock(&priv->mr.rwlock);
1196 lkey = mr_lookup_dev(dev, &entry, addr);
1197 rte_rwlock_read_unlock(&priv->mr.rwlock);
1198 if (lkey != UINT32_MAX)
1200 DRV_LOG(DEBUG, "port %u register MR for chunk #%d of mempool (%s)",
1201 dev->data->port_id, mem_idx, mp->name);
1202 mr = mlx5_create_mr_ext(dev, addr, len, mp->socket_id);
1205 "port %u unable to allocate a new MR of"
1207 dev->data->port_id, mp->name);
1211 rte_rwlock_write_lock(&priv->mr.rwlock);
1212 LIST_INSERT_HEAD(&priv->mr.mr_list, mr, mr);
1213 /* Insert to the global cache table. */
1214 mr_insert_dev_cache(dev, mr);
1215 rte_rwlock_write_unlock(&priv->mr.rwlock);
1216 /* Insert to the local cache table */
1217 mlx5_mr_addr2mr_bh(dev, mr_ctrl, addr);
1221 * Finds the first ethdev that match the pci device.
1222 * The existence of multiple ethdev per pci device is only with representors.
1223 * On such case, it is enough to get only one of the ports as they all share
1224 * the same ibv context.
1227 * Pointer to the PCI device.
1230 * Pointer to the ethdev if found, NULL otherwise.
1232 static struct rte_eth_dev *
1233 pci_dev_to_eth_dev(struct rte_pci_device *pdev)
1235 struct rte_dev_iterator it;
1236 struct rte_device *dev;
1239 * We really need to iterate all devices regardless of
1242 RTE_DEV_FOREACH(dev, "class=eth", &it)
1243 if (dev == &pdev->device)
1244 return it.class_device;
1249 * DPDK callback to DMA map external memory to a PCI device.
1252 * Pointer to the PCI device.
1254 * Starting virtual address of memory to be mapped.
1256 * Starting IOVA address of memory to be mapped.
1258 * Length of memory segment being mapped.
1261 * 0 on success, negative value on error.
1264 mlx5_dma_map(struct rte_pci_device *pdev, void *addr,
1265 uint64_t iova __rte_unused, size_t len)
1267 struct rte_eth_dev *dev;
1269 struct mlx5_priv *priv;
1271 dev = pci_dev_to_eth_dev(pdev);
1273 DRV_LOG(WARNING, "unable to find matching ethdev "
1274 "to PCI device %p", (void *)pdev);
1278 priv = dev->data->dev_private;
1279 mr = mlx5_create_mr_ext(dev, (uintptr_t)addr, len, SOCKET_ID_ANY);
1282 "port %u unable to dma map", dev->data->port_id);
1286 rte_rwlock_write_lock(&priv->mr.rwlock);
1287 LIST_INSERT_HEAD(&priv->mr.mr_list, mr, mr);
1288 /* Insert to the global cache table. */
1289 mr_insert_dev_cache(dev, mr);
1290 rte_rwlock_write_unlock(&priv->mr.rwlock);
1295 * DPDK callback to DMA unmap external memory to a PCI device.
1298 * Pointer to the PCI device.
1300 * Starting virtual address of memory to be unmapped.
1302 * Starting IOVA address of memory to be unmapped.
1304 * Length of memory segment being unmapped.
1307 * 0 on success, negative value on error.
1310 mlx5_dma_unmap(struct rte_pci_device *pdev, void *addr,
1311 uint64_t iova __rte_unused, size_t len __rte_unused)
1313 struct rte_eth_dev *dev;
1314 struct mlx5_priv *priv;
1316 struct mlx5_mr_cache entry;
1318 dev = pci_dev_to_eth_dev(pdev);
1320 DRV_LOG(WARNING, "unable to find matching ethdev "
1321 "to PCI device %p", (void *)pdev);
1325 priv = dev->data->dev_private;
1326 rte_rwlock_read_lock(&priv->mr.rwlock);
1327 mr = mr_lookup_dev_list(dev, &entry, (uintptr_t)addr);
1329 rte_rwlock_read_unlock(&priv->mr.rwlock);
1330 DRV_LOG(WARNING, "address 0x%" PRIxPTR " wasn't registered "
1331 "to PCI device %p", (uintptr_t)addr,
1336 LIST_REMOVE(mr, mr);
1337 LIST_INSERT_HEAD(&priv->mr.mr_free_list, mr, mr);
1338 DEBUG("port %u remove MR(%p) from list", dev->data->port_id,
1340 mr_rebuild_dev_cache(dev);
1342 * Flush local caches by propagating invalidation across cores.
1343 * rte_smp_wmb() is enough to synchronize this event. If one of
1344 * freed memsegs is seen by other core, that means the memseg
1345 * has been allocated by allocator, which will come after this
1346 * free call. Therefore, this store instruction (incrementing
1347 * generation below) will be guaranteed to be seen by other core
1348 * before the core sees the newly allocated memory.
1351 DEBUG("broadcasting local cache flush, gen=%d",
1354 rte_rwlock_read_unlock(&priv->mr.rwlock);
1359 * Register MR for entire memory chunks in a Mempool having externally allocated
1360 * memory and fill in local cache.
1363 * Pointer to Ethernet device.
1365 * Pointer to per-queue MR control structure.
1367 * Pointer to registering Mempool.
1370 * 0 on success, -1 on failure.
1373 mlx5_mr_update_ext_mp(struct rte_eth_dev *dev, struct mlx5_mr_ctrl *mr_ctrl,
1374 struct rte_mempool *mp)
1376 struct mr_update_mp_data data = {
1382 rte_mempool_mem_iter(mp, mlx5_mr_update_ext_mp_cb, &data);
1387 * Register MR entire memory chunks in a Mempool having externally allocated
1388 * memory and search LKey of the address to return.
1391 * Pointer to Ethernet device.
1395 * Pointer to registering Mempool where addr belongs.
1398 * LKey for address on success, UINT32_MAX on failure.
1401 mlx5_tx_update_ext_mp(struct mlx5_txq_data *txq, uintptr_t addr,
1402 struct rte_mempool *mp)
1404 struct mlx5_txq_ctrl *txq_ctrl =
1405 container_of(txq, struct mlx5_txq_ctrl, txq);
1406 struct mlx5_mr_ctrl *mr_ctrl = &txq->mr_ctrl;
1407 struct mlx5_priv *priv = txq_ctrl->priv;
1409 mlx5_mr_update_ext_mp(ETH_DEV(priv), mr_ctrl, mp);
1410 return mlx5_tx_addr2mr_bh(txq, addr);
1413 /* Called during rte_mempool_mem_iter() by mlx5_mr_update_mp(). */
1415 mlx5_mr_update_mp_cb(struct rte_mempool *mp __rte_unused, void *opaque,
1416 struct rte_mempool_memhdr *memhdr,
1417 unsigned mem_idx __rte_unused)
1419 struct mr_update_mp_data *data = opaque;
1422 /* Stop iteration if failed in the previous walk. */
1425 /* Register address of the chunk and update local caches. */
1426 lkey = mlx5_mr_addr2mr_bh(data->dev, data->mr_ctrl,
1427 (uintptr_t)memhdr->addr);
1428 if (lkey == UINT32_MAX)
1433 * Register entire memory chunks in a Mempool.
1436 * Pointer to Ethernet device.
1438 * Pointer to per-queue MR control structure.
1440 * Pointer to registering Mempool.
1443 * 0 on success, -1 on failure.
1446 mlx5_mr_update_mp(struct rte_eth_dev *dev, struct mlx5_mr_ctrl *mr_ctrl,
1447 struct rte_mempool *mp)
1449 struct mr_update_mp_data data = {
1455 rte_mempool_mem_iter(mp, mlx5_mr_update_mp_cb, &data);
1456 if (data.ret < 0 && rte_errno == ENXIO) {
1457 /* Mempool may have externally allocated memory. */
1458 return mlx5_mr_update_ext_mp(dev, mr_ctrl, mp);
1464 * Dump all the created MRs and the global cache entries.
1467 * Pointer to Ethernet device.
1470 mlx5_mr_dump_dev(struct rte_eth_dev *dev __rte_unused)
1473 struct mlx5_priv *priv = dev->data->dev_private;
1478 rte_rwlock_read_lock(&priv->mr.rwlock);
1479 /* Iterate all the existing MRs. */
1480 LIST_FOREACH(mr, &priv->mr.mr_list, mr) {
1483 DEBUG("port %u MR[%u], LKey = 0x%x, ms_n = %u, ms_bmp_n = %u",
1484 dev->data->port_id, mr_n++,
1485 rte_cpu_to_be_32(mr->ibv_mr->lkey),
1486 mr->ms_n, mr->ms_bmp_n);
1489 for (n = 0; n < mr->ms_bmp_n; ) {
1490 struct mlx5_mr_cache ret = { 0, };
1492 n = mr_find_next_chunk(mr, &ret, n);
1495 DEBUG(" chunk[%u], [0x%" PRIxPTR ", 0x%" PRIxPTR ")",
1496 chunk_n++, ret.start, ret.end);
1499 DEBUG("port %u dumping global cache", dev->data->port_id);
1500 mlx5_mr_btree_dump(&priv->mr.cache);
1501 rte_rwlock_read_unlock(&priv->mr.rwlock);
1506 * Release all the created MRs and resources. Remove device from memory callback
1510 * Pointer to Ethernet device.
1513 mlx5_mr_release(struct rte_eth_dev *dev)
1515 struct mlx5_priv *priv = dev->data->dev_private;
1516 struct mlx5_mr *mr_next = LIST_FIRST(&priv->mr.mr_list);
1518 /* Remove from memory callback device list. */
1519 rte_rwlock_write_lock(&mlx5_shared_data->mem_event_rwlock);
1520 LIST_REMOVE(priv, mem_event_cb);
1521 rte_rwlock_write_unlock(&mlx5_shared_data->mem_event_rwlock);
1522 if (rte_log_get_level(mlx5_logtype) == RTE_LOG_DEBUG)
1523 mlx5_mr_dump_dev(dev);
1524 rte_rwlock_write_lock(&priv->mr.rwlock);
1525 /* Detach from MR list and move to free list. */
1526 while (mr_next != NULL) {
1527 struct mlx5_mr *mr = mr_next;
1529 mr_next = LIST_NEXT(mr, mr);
1530 LIST_REMOVE(mr, mr);
1531 LIST_INSERT_HEAD(&priv->mr.mr_free_list, mr, mr);
1533 LIST_INIT(&priv->mr.mr_list);
1534 /* Free global cache. */
1535 mlx5_mr_btree_free(&priv->mr.cache);
1536 rte_rwlock_write_unlock(&priv->mr.rwlock);
1537 /* Free all remaining MRs. */
1538 mlx5_mr_garbage_collect(dev);