2 * Copyright (c) 2013-2015, Mellanox Technologies. All rights reserved.
4 * This software is available to you under a choice of one of two
5 * licenses. You may choose to be licensed under the terms of the GNU
6 * General Public License (GPL) Version 2, available from the file
7 * COPYING in the main directory of this source tree, or the
8 * OpenIB.org BSD license below:
10 * Redistribution and use in source and binary forms, with or
11 * without modification, are permitted provided that the following
14 * - Redistributions of source code must retain the above
15 * copyright notice, this list of conditions and the following
18 * - Redistributions in binary form must reproduce the above
19 * copyright notice, this list of conditions and the following
20 * disclaimer in the documentation and/or other materials
21 * provided with the distribution.
23 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
24 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
25 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
26 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
27 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
28 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
29 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
33 #include <rdma/ib_umem.h>
34 #include <rdma/ib_umem_odp.h>
35 #include <linux/kernel.h>
40 #include <linux/mlx5/eq.h>
42 /* Contains the details of a pagefault. */
43 struct mlx5_pagefault {
49 /* Initiator or send message responder pagefault details. */
51 /* Received packet size, only valid for responders. */
54 * Number of resource holding WQE, depends on type.
58 * WQE index. Refers to either the send queue or
59 * receive queue, according to event_subtype.
63 /* RDMA responder pagefault details */
67 * Received packet size, minimal size page fault
68 * resolution required for forward progress.
76 struct mlx5_ib_pf_eq *eq;
77 struct work_struct work;
80 #define MAX_PREFETCH_LEN (4*1024*1024U)
82 /* Timeout in ms to wait for an active mmu notifier to complete when handling
84 #define MMU_NOTIFIER_TIMEOUT 1000
86 #define MLX5_IMR_MTT_BITS (30 - PAGE_SHIFT)
87 #define MLX5_IMR_MTT_SHIFT (MLX5_IMR_MTT_BITS + PAGE_SHIFT)
88 #define MLX5_IMR_MTT_ENTRIES BIT_ULL(MLX5_IMR_MTT_BITS)
89 #define MLX5_IMR_MTT_SIZE BIT_ULL(MLX5_IMR_MTT_SHIFT)
90 #define MLX5_IMR_MTT_MASK (~(MLX5_IMR_MTT_SIZE - 1))
92 #define MLX5_KSM_PAGE_SHIFT MLX5_IMR_MTT_SHIFT
94 static u64 mlx5_imr_ksm_entries;
96 static int check_parent(struct ib_umem_odp *odp,
97 struct mlx5_ib_mr *parent)
99 struct mlx5_ib_mr *mr = odp->private;
101 return mr && mr->parent == parent && !odp->dying;
104 struct ib_ucontext_per_mm *mr_to_per_mm(struct mlx5_ib_mr *mr)
106 if (WARN_ON(!mr || !mr->umem || !mr->umem->is_odp))
109 return to_ib_umem_odp(mr->umem)->per_mm;
112 static struct ib_umem_odp *odp_next(struct ib_umem_odp *odp)
114 struct mlx5_ib_mr *mr = odp->private, *parent = mr->parent;
115 struct ib_ucontext_per_mm *per_mm = odp->per_mm;
118 down_read(&per_mm->umem_rwsem);
120 rb = rb_next(&odp->interval_tree.rb);
123 odp = rb_entry(rb, struct ib_umem_odp, interval_tree.rb);
124 if (check_parent(odp, parent))
130 up_read(&per_mm->umem_rwsem);
134 static struct ib_umem_odp *odp_lookup(u64 start, u64 length,
135 struct mlx5_ib_mr *parent)
137 struct ib_ucontext_per_mm *per_mm = mr_to_per_mm(parent);
138 struct ib_umem_odp *odp;
141 down_read(&per_mm->umem_rwsem);
142 odp = rbt_ib_umem_lookup(&per_mm->umem_tree, start, length);
147 if (check_parent(odp, parent))
149 rb = rb_next(&odp->interval_tree.rb);
152 odp = rb_entry(rb, struct ib_umem_odp, interval_tree.rb);
153 if (ib_umem_start(&odp->umem) > start + length)
159 up_read(&per_mm->umem_rwsem);
163 void mlx5_odp_populate_klm(struct mlx5_klm *pklm, size_t offset,
164 size_t nentries, struct mlx5_ib_mr *mr, int flags)
166 struct ib_pd *pd = mr->ibmr.pd;
167 struct mlx5_ib_dev *dev = to_mdev(pd->device);
168 struct ib_umem_odp *odp;
172 if (flags & MLX5_IB_UPD_XLT_ZAP) {
173 for (i = 0; i < nentries; i++, pklm++) {
174 pklm->bcount = cpu_to_be32(MLX5_IMR_MTT_SIZE);
175 pklm->key = cpu_to_be32(dev->null_mkey);
181 odp = odp_lookup(offset * MLX5_IMR_MTT_SIZE,
182 nentries * MLX5_IMR_MTT_SIZE, mr);
184 for (i = 0; i < nentries; i++, pklm++) {
185 pklm->bcount = cpu_to_be32(MLX5_IMR_MTT_SIZE);
186 va = (offset + i) * MLX5_IMR_MTT_SIZE;
187 if (odp && odp->umem.address == va) {
188 struct mlx5_ib_mr *mtt = odp->private;
190 pklm->key = cpu_to_be32(mtt->ibmr.lkey);
193 pklm->key = cpu_to_be32(dev->null_mkey);
195 mlx5_ib_dbg(dev, "[%d] va %lx key %x\n",
196 i, va, be32_to_cpu(pklm->key));
200 static void mr_leaf_free_action(struct work_struct *work)
202 struct ib_umem_odp *odp = container_of(work, struct ib_umem_odp, work);
203 int idx = ib_umem_start(&odp->umem) >> MLX5_IMR_MTT_SHIFT;
204 struct mlx5_ib_mr *mr = odp->private, *imr = mr->parent;
207 synchronize_srcu(&mr->dev->mr_srcu);
209 ib_umem_release(&odp->umem);
211 mlx5_ib_update_xlt(imr, idx, 1, 0,
212 MLX5_IB_UPD_XLT_INDIRECT |
213 MLX5_IB_UPD_XLT_ATOMIC);
214 mlx5_mr_cache_free(mr->dev, mr);
216 if (atomic_dec_and_test(&imr->num_leaf_free))
217 wake_up(&imr->q_leaf_free);
220 void mlx5_ib_invalidate_range(struct ib_umem_odp *umem_odp, unsigned long start,
223 struct mlx5_ib_mr *mr;
224 const u64 umr_block_mask = (MLX5_UMR_MTT_ALIGNMENT /
225 sizeof(struct mlx5_mtt)) - 1;
226 u64 idx = 0, blk_start_idx = 0;
227 struct ib_umem *umem;
232 pr_err("invalidation called on NULL umem or non-ODP umem\n");
235 umem = &umem_odp->umem;
237 mr = umem_odp->private;
239 if (!mr || !mr->ibmr.pd)
242 start = max_t(u64, ib_umem_start(umem), start);
243 end = min_t(u64, ib_umem_end(umem), end);
246 * Iteration one - zap the HW's MTTs. The notifiers_count ensures that
247 * while we are doing the invalidation, no page fault will attempt to
248 * overwrite the same MTTs. Concurent invalidations might race us,
249 * but they will write 0s as well, so no difference in the end result.
252 for (addr = start; addr < end; addr += BIT(umem->page_shift)) {
253 idx = (addr - ib_umem_start(umem)) >> umem->page_shift;
255 * Strive to write the MTTs in chunks, but avoid overwriting
256 * non-existing MTTs. The huristic here can be improved to
257 * estimate the cost of another UMR vs. the cost of bigger
260 if (umem_odp->dma_list[idx] &
261 (ODP_READ_ALLOWED_BIT | ODP_WRITE_ALLOWED_BIT)) {
267 u64 umr_offset = idx & umr_block_mask;
269 if (in_block && umr_offset == 0) {
270 mlx5_ib_update_xlt(mr, blk_start_idx,
271 idx - blk_start_idx, 0,
272 MLX5_IB_UPD_XLT_ZAP |
273 MLX5_IB_UPD_XLT_ATOMIC);
279 mlx5_ib_update_xlt(mr, blk_start_idx,
280 idx - blk_start_idx + 1, 0,
281 MLX5_IB_UPD_XLT_ZAP |
282 MLX5_IB_UPD_XLT_ATOMIC);
284 * We are now sure that the device will not access the
285 * memory. We can safely unmap it, and mark it as dirty if
289 ib_umem_odp_unmap_dma_pages(umem_odp, start, end);
291 if (unlikely(!umem->npages && mr->parent &&
293 WRITE_ONCE(umem_odp->dying, 1);
294 atomic_inc(&mr->parent->num_leaf_free);
295 schedule_work(&umem_odp->work);
299 void mlx5_ib_internal_fill_odp_caps(struct mlx5_ib_dev *dev)
301 struct ib_odp_caps *caps = &dev->odp_caps;
303 memset(caps, 0, sizeof(*caps));
305 if (!MLX5_CAP_GEN(dev->mdev, pg))
308 caps->general_caps = IB_ODP_SUPPORT;
310 if (MLX5_CAP_GEN(dev->mdev, umr_extended_translation_offset))
311 dev->odp_max_size = U64_MAX;
313 dev->odp_max_size = BIT_ULL(MLX5_MAX_UMR_SHIFT + PAGE_SHIFT);
315 if (MLX5_CAP_ODP(dev->mdev, ud_odp_caps.send))
316 caps->per_transport_caps.ud_odp_caps |= IB_ODP_SUPPORT_SEND;
318 if (MLX5_CAP_ODP(dev->mdev, rc_odp_caps.send))
319 caps->per_transport_caps.rc_odp_caps |= IB_ODP_SUPPORT_SEND;
321 if (MLX5_CAP_ODP(dev->mdev, rc_odp_caps.receive))
322 caps->per_transport_caps.rc_odp_caps |= IB_ODP_SUPPORT_RECV;
324 if (MLX5_CAP_ODP(dev->mdev, rc_odp_caps.write))
325 caps->per_transport_caps.rc_odp_caps |= IB_ODP_SUPPORT_WRITE;
327 if (MLX5_CAP_ODP(dev->mdev, rc_odp_caps.read))
328 caps->per_transport_caps.rc_odp_caps |= IB_ODP_SUPPORT_READ;
330 if (MLX5_CAP_ODP(dev->mdev, rc_odp_caps.atomic))
331 caps->per_transport_caps.rc_odp_caps |= IB_ODP_SUPPORT_ATOMIC;
333 if (MLX5_CAP_GEN(dev->mdev, fixed_buffer_size) &&
334 MLX5_CAP_GEN(dev->mdev, null_mkey) &&
335 MLX5_CAP_GEN(dev->mdev, umr_extended_translation_offset))
336 caps->general_caps |= IB_ODP_SUPPORT_IMPLICIT;
341 static void mlx5_ib_page_fault_resume(struct mlx5_ib_dev *dev,
342 struct mlx5_pagefault *pfault,
345 int wq_num = pfault->event_subtype == MLX5_PFAULT_SUBTYPE_WQE ?
346 pfault->wqe.wq_num : pfault->token;
347 u32 out[MLX5_ST_SZ_DW(page_fault_resume_out)] = { };
348 u32 in[MLX5_ST_SZ_DW(page_fault_resume_in)] = { };
351 MLX5_SET(page_fault_resume_in, in, opcode, MLX5_CMD_OP_PAGE_FAULT_RESUME);
352 MLX5_SET(page_fault_resume_in, in, page_fault_type, pfault->type);
353 MLX5_SET(page_fault_resume_in, in, token, pfault->token);
354 MLX5_SET(page_fault_resume_in, in, wq_number, wq_num);
355 MLX5_SET(page_fault_resume_in, in, error, !!error);
357 err = mlx5_cmd_exec(dev->mdev, in, sizeof(in), out, sizeof(out));
359 mlx5_ib_err(dev, "Failed to resolve the page fault on WQ 0x%x err %d\n",
363 static struct mlx5_ib_mr *implicit_mr_alloc(struct ib_pd *pd,
364 struct ib_umem *umem,
365 bool ksm, int access_flags)
367 struct mlx5_ib_dev *dev = to_mdev(pd->device);
368 struct mlx5_ib_mr *mr;
371 mr = mlx5_mr_cache_alloc(dev, ksm ? MLX5_IMR_KSM_CACHE_ENTRY :
372 MLX5_IMR_MTT_CACHE_ENTRY);
380 mr->access_flags = access_flags;
385 err = mlx5_ib_update_xlt(mr, 0,
386 mlx5_imr_ksm_entries,
388 MLX5_IB_UPD_XLT_INDIRECT |
389 MLX5_IB_UPD_XLT_ZAP |
390 MLX5_IB_UPD_XLT_ENABLE);
393 err = mlx5_ib_update_xlt(mr, 0,
394 MLX5_IMR_MTT_ENTRIES,
396 MLX5_IB_UPD_XLT_ZAP |
397 MLX5_IB_UPD_XLT_ENABLE |
398 MLX5_IB_UPD_XLT_ATOMIC);
404 mr->ibmr.lkey = mr->mmkey.key;
405 mr->ibmr.rkey = mr->mmkey.key;
409 mlx5_ib_dbg(dev, "key %x dev %p mr %p\n",
410 mr->mmkey.key, dev->mdev, mr);
415 mlx5_ib_err(dev, "Failed to register MKEY %d\n", err);
416 mlx5_mr_cache_free(dev, mr);
421 static struct ib_umem_odp *implicit_mr_get_data(struct mlx5_ib_mr *mr,
422 u64 io_virt, size_t bcnt)
424 struct mlx5_ib_dev *dev = to_mdev(mr->ibmr.pd->device);
425 struct ib_umem_odp *odp, *result = NULL;
426 struct ib_umem_odp *odp_mr = to_ib_umem_odp(mr->umem);
427 u64 addr = io_virt & MLX5_IMR_MTT_MASK;
428 int nentries = 0, start_idx = 0, ret;
429 struct mlx5_ib_mr *mtt;
431 mutex_lock(&odp_mr->umem_mutex);
432 odp = odp_lookup(addr, 1, mr);
434 mlx5_ib_dbg(dev, "io_virt:%llx bcnt:%zx addr:%llx odp:%p\n",
435 io_virt, bcnt, addr, odp);
442 odp = ib_alloc_odp_umem(odp_mr->per_mm, addr,
445 mutex_unlock(&odp_mr->umem_mutex);
446 return ERR_CAST(odp);
449 mtt = implicit_mr_alloc(mr->ibmr.pd, &odp->umem, 0,
452 mutex_unlock(&odp_mr->umem_mutex);
453 ib_umem_release(&odp->umem);
454 return ERR_CAST(mtt);
458 mtt->umem = &odp->umem;
459 mtt->mmkey.iova = addr;
461 INIT_WORK(&odp->work, mr_leaf_free_action);
464 start_idx = addr >> MLX5_IMR_MTT_SHIFT;
468 /* Return first odp if region not covered by single one */
472 addr += MLX5_IMR_MTT_SIZE;
473 if (unlikely(addr < io_virt + bcnt)) {
475 if (odp && odp->umem.address != addr)
480 if (unlikely(nentries)) {
481 ret = mlx5_ib_update_xlt(mr, start_idx, nentries, 0,
482 MLX5_IB_UPD_XLT_INDIRECT |
483 MLX5_IB_UPD_XLT_ATOMIC);
485 mlx5_ib_err(dev, "Failed to update PAS\n");
486 result = ERR_PTR(ret);
490 mutex_unlock(&odp_mr->umem_mutex);
494 struct mlx5_ib_mr *mlx5_ib_alloc_implicit_mr(struct mlx5_ib_pd *pd,
497 struct ib_ucontext *ctx = pd->ibpd.uobject->context;
498 struct mlx5_ib_mr *imr;
499 struct ib_umem *umem;
501 umem = ib_umem_get(ctx, 0, 0, IB_ACCESS_ON_DEMAND, 0);
503 return ERR_CAST(umem);
505 imr = implicit_mr_alloc(&pd->ibpd, umem, 1, access_flags);
507 ib_umem_release(umem);
508 return ERR_CAST(imr);
512 init_waitqueue_head(&imr->q_leaf_free);
513 atomic_set(&imr->num_leaf_free, 0);
518 static int mr_leaf_free(struct ib_umem_odp *umem_odp, u64 start, u64 end,
521 struct mlx5_ib_mr *mr = umem_odp->private, *imr = cookie;
522 struct ib_umem *umem = &umem_odp->umem;
524 if (mr->parent != imr)
527 ib_umem_odp_unmap_dma_pages(umem_odp, ib_umem_start(umem),
533 WRITE_ONCE(umem_odp->dying, 1);
534 atomic_inc(&imr->num_leaf_free);
535 schedule_work(&umem_odp->work);
540 void mlx5_ib_free_implicit_mr(struct mlx5_ib_mr *imr)
542 struct ib_ucontext_per_mm *per_mm = mr_to_per_mm(imr);
544 down_read(&per_mm->umem_rwsem);
545 rbt_ib_umem_for_each_in_range(&per_mm->umem_tree, 0, ULLONG_MAX,
546 mr_leaf_free, true, imr);
547 up_read(&per_mm->umem_rwsem);
549 wait_event(imr->q_leaf_free, !atomic_read(&imr->num_leaf_free));
552 static int pagefault_mr(struct mlx5_ib_dev *dev, struct mlx5_ib_mr *mr,
553 u64 io_virt, size_t bcnt, u32 *bytes_mapped)
555 struct ib_umem_odp *odp_mr = to_ib_umem_odp(mr->umem);
556 u64 access_mask = ODP_READ_ALLOWED_BIT;
557 int npages = 0, page_shift, np;
558 u64 start_idx, page_mask;
559 struct ib_umem_odp *odp;
564 if (!odp_mr->page_list) {
565 odp = implicit_mr_get_data(mr, io_virt, bcnt);
576 size = min_t(size_t, bcnt, ib_umem_end(&odp->umem) - io_virt);
578 page_shift = mr->umem->page_shift;
579 page_mask = ~(BIT(page_shift) - 1);
580 start_idx = (io_virt - (mr->mmkey.iova & page_mask)) >> page_shift;
582 if (mr->umem->writable)
583 access_mask |= ODP_WRITE_ALLOWED_BIT;
585 current_seq = READ_ONCE(odp->notifiers_seq);
587 * Ensure the sequence number is valid for some time before we call
592 ret = ib_umem_odp_map_dma_pages(to_ib_umem_odp(mr->umem), io_virt, size,
593 access_mask, current_seq);
600 mutex_lock(&odp->umem_mutex);
601 if (!ib_umem_mmu_notifier_retry(to_ib_umem_odp(mr->umem),
604 * No need to check whether the MTTs really belong to
605 * this MR, since ib_umem_odp_map_dma_pages already
608 ret = mlx5_ib_update_xlt(mr, start_idx, np,
609 page_shift, MLX5_IB_UPD_XLT_ATOMIC);
613 mutex_unlock(&odp->umem_mutex);
617 mlx5_ib_err(dev, "Failed to update mkey page tables\n");
622 u32 new_mappings = (np << page_shift) -
623 (io_virt - round_down(io_virt, 1 << page_shift));
624 *bytes_mapped += min_t(u32, new_mappings, size);
627 npages += np << (page_shift - PAGE_SHIFT);
630 if (unlikely(bcnt)) {
631 struct ib_umem_odp *next;
634 next = odp_next(odp);
635 if (unlikely(!next || next->umem.address != io_virt)) {
636 mlx5_ib_dbg(dev, "next implicit leaf removed at 0x%llx. got %p\n",
648 if (ret == -EAGAIN) {
649 if (mr->parent || !odp->dying) {
650 unsigned long timeout =
651 msecs_to_jiffies(MMU_NOTIFIER_TIMEOUT);
653 if (!wait_for_completion_timeout(
654 &odp->notifier_completion,
656 mlx5_ib_warn(dev, "timeout waiting for mmu notifier. seq %d against %d. notifiers_count=%d\n",
657 current_seq, odp->notifiers_seq, odp->notifiers_count);
660 /* The MR is being killed, kill the QP as well. */
669 struct pf_frame *next;
677 * Handle a single data segment in a page-fault WQE or RDMA region.
679 * Returns number of OS pages retrieved on success. The caller may continue to
680 * the next data segment.
681 * Can return the following error codes:
682 * -EAGAIN to designate a temporary error. The caller will abort handling the
683 * page fault and resolve it.
684 * -EFAULT when there's an error mapping the requested pages. The caller will
685 * abort the page fault handling.
687 static int pagefault_single_data_segment(struct mlx5_ib_dev *dev,
688 u32 key, u64 io_virt, size_t bcnt,
689 u32 *bytes_committed,
692 int npages = 0, srcu_key, ret, i, outlen, cur_outlen = 0, depth = 0;
693 struct pf_frame *head = NULL, *frame;
694 struct mlx5_core_mkey *mmkey;
695 struct mlx5_ib_mw *mw;
696 struct mlx5_ib_mr *mr;
697 struct mlx5_klm *pklm;
701 srcu_key = srcu_read_lock(&dev->mr_srcu);
703 io_virt += *bytes_committed;
704 bcnt -= *bytes_committed;
707 mmkey = __mlx5_mr_lookup(dev->mdev, mlx5_base_mkey(key));
708 if (!mmkey || mmkey->key != key) {
709 mlx5_ib_dbg(dev, "failed to find mkey %x\n", key);
714 switch (mmkey->type) {
716 mr = container_of(mmkey, struct mlx5_ib_mr, mmkey);
717 if (!mr->live || !mr->ibmr.pd) {
718 mlx5_ib_dbg(dev, "got dead MR\n");
723 if (!mr->umem->is_odp) {
724 mlx5_ib_dbg(dev, "skipping non ODP MR (lkey=0x%06x) in page fault handler.\n",
727 *bytes_mapped += bcnt;
732 ret = pagefault_mr(dev, mr, io_virt, bcnt, bytes_mapped);
741 mw = container_of(mmkey, struct mlx5_ib_mw, mmkey);
743 if (depth >= MLX5_CAP_GEN(dev->mdev, max_indirection)) {
744 mlx5_ib_dbg(dev, "indirection level exceeded\n");
749 outlen = MLX5_ST_SZ_BYTES(query_mkey_out) +
750 sizeof(*pklm) * (mw->ndescs - 2);
752 if (outlen > cur_outlen) {
754 out = kzalloc(outlen, GFP_KERNEL);
762 pklm = (struct mlx5_klm *)MLX5_ADDR_OF(query_mkey_out, out,
763 bsf0_klm0_pas_mtt0_1);
765 ret = mlx5_core_query_mkey(dev->mdev, &mw->mmkey, out, outlen);
769 offset = io_virt - MLX5_GET64(query_mkey_out, out,
770 memory_key_mkey_entry.start_addr);
772 for (i = 0; bcnt && i < mw->ndescs; i++, pklm++) {
773 if (offset >= be32_to_cpu(pklm->bcount)) {
774 offset -= be32_to_cpu(pklm->bcount);
778 frame = kzalloc(sizeof(*frame), GFP_KERNEL);
784 frame->key = be32_to_cpu(pklm->key);
785 frame->io_virt = be64_to_cpu(pklm->va) + offset;
786 frame->bcnt = min_t(size_t, bcnt,
787 be32_to_cpu(pklm->bcount) - offset);
788 frame->depth = depth + 1;
798 mlx5_ib_dbg(dev, "wrong mkey type %d\n", mmkey->type);
808 io_virt = frame->io_virt;
810 depth = frame->depth;
824 srcu_read_unlock(&dev->mr_srcu, srcu_key);
825 *bytes_committed = 0;
826 return ret ? ret : npages;
830 * Parse a series of data segments for page fault handling.
832 * @qp the QP on which the fault occurred.
833 * @pfault contains page fault information.
834 * @wqe points at the first data segment in the WQE.
835 * @wqe_end points after the end of the WQE.
836 * @bytes_mapped receives the number of bytes that the function was able to
837 * map. This allows the caller to decide intelligently whether
838 * enough memory was mapped to resolve the page fault
839 * successfully (e.g. enough for the next MTU, or the entire
841 * @total_wqe_bytes receives the total data size of this WQE in bytes (minus
842 * the committed bytes).
844 * Returns the number of pages loaded if positive, zero for an empty WQE, or a
845 * negative error code.
847 static int pagefault_data_segments(struct mlx5_ib_dev *dev,
848 struct mlx5_pagefault *pfault,
849 struct mlx5_ib_qp *qp, void *wqe,
850 void *wqe_end, u32 *bytes_mapped,
851 u32 *total_wqe_bytes, int receive_queue)
853 int ret = 0, npages = 0;
860 /* Skip SRQ next-WQE segment. */
861 if (receive_queue && qp->ibqp.srq)
862 wqe += sizeof(struct mlx5_wqe_srq_next_seg);
867 *total_wqe_bytes = 0;
869 while (wqe < wqe_end) {
870 struct mlx5_wqe_data_seg *dseg = wqe;
872 io_virt = be64_to_cpu(dseg->addr);
873 key = be32_to_cpu(dseg->lkey);
874 byte_count = be32_to_cpu(dseg->byte_count);
875 inline_segment = !!(byte_count & MLX5_INLINE_SEG);
876 bcnt = byte_count & ~MLX5_INLINE_SEG;
878 if (inline_segment) {
879 bcnt = bcnt & MLX5_WQE_INLINE_SEG_BYTE_COUNT_MASK;
880 wqe += ALIGN(sizeof(struct mlx5_wqe_inline_seg) + bcnt,
883 wqe += sizeof(*dseg);
886 /* receive WQE end of sg list. */
887 if (receive_queue && bcnt == 0 && key == MLX5_INVALID_LKEY &&
891 if (!inline_segment && total_wqe_bytes) {
892 *total_wqe_bytes += bcnt - min_t(size_t, bcnt,
893 pfault->bytes_committed);
896 /* A zero length data segment designates a length of 2GB. */
900 if (inline_segment || bcnt <= pfault->bytes_committed) {
901 pfault->bytes_committed -=
903 pfault->bytes_committed);
907 ret = pagefault_single_data_segment(dev, key, io_virt, bcnt,
908 &pfault->bytes_committed,
915 return ret < 0 ? ret : npages;
918 static const u32 mlx5_ib_odp_opcode_cap[] = {
919 [MLX5_OPCODE_SEND] = IB_ODP_SUPPORT_SEND,
920 [MLX5_OPCODE_SEND_IMM] = IB_ODP_SUPPORT_SEND,
921 [MLX5_OPCODE_SEND_INVAL] = IB_ODP_SUPPORT_SEND,
922 [MLX5_OPCODE_RDMA_WRITE] = IB_ODP_SUPPORT_WRITE,
923 [MLX5_OPCODE_RDMA_WRITE_IMM] = IB_ODP_SUPPORT_WRITE,
924 [MLX5_OPCODE_RDMA_READ] = IB_ODP_SUPPORT_READ,
925 [MLX5_OPCODE_ATOMIC_CS] = IB_ODP_SUPPORT_ATOMIC,
926 [MLX5_OPCODE_ATOMIC_FA] = IB_ODP_SUPPORT_ATOMIC,
930 * Parse initiator WQE. Advances the wqe pointer to point at the
931 * scatter-gather list, and set wqe_end to the end of the WQE.
933 static int mlx5_ib_mr_initiator_pfault_handler(
934 struct mlx5_ib_dev *dev, struct mlx5_pagefault *pfault,
935 struct mlx5_ib_qp *qp, void **wqe, void **wqe_end, int wqe_length)
937 struct mlx5_wqe_ctrl_seg *ctrl = *wqe;
938 u16 wqe_index = pfault->wqe.wqe_index;
940 struct mlx5_base_av *av;
943 u32 ctrl_wqe_index, ctrl_qpn;
945 u32 qpn = qp->trans_qp.base.mqp.qpn;
947 ds = be32_to_cpu(ctrl->qpn_ds) & MLX5_WQE_CTRL_DS_MASK;
948 if (ds * MLX5_WQE_DS_UNITS > wqe_length) {
949 mlx5_ib_err(dev, "Unable to read the complete WQE. ds = 0x%x, ret = 0x%x\n",
955 mlx5_ib_err(dev, "Got WQE with zero DS. wqe_index=%x, qpn=%x\n",
961 ctrl_wqe_index = (be32_to_cpu(ctrl->opmod_idx_opcode) &
962 MLX5_WQE_CTRL_WQE_INDEX_MASK) >>
963 MLX5_WQE_CTRL_WQE_INDEX_SHIFT;
964 if (wqe_index != ctrl_wqe_index) {
965 mlx5_ib_err(dev, "Got WQE with invalid wqe_index. wqe_index=0x%x, qpn=0x%x ctrl->wqe_index=0x%x\n",
971 ctrl_qpn = (be32_to_cpu(ctrl->qpn_ds) & MLX5_WQE_CTRL_QPN_MASK) >>
972 MLX5_WQE_CTRL_QPN_SHIFT;
973 if (qpn != ctrl_qpn) {
974 mlx5_ib_err(dev, "Got WQE with incorrect QP number. wqe_index=0x%x, qpn=0x%x ctrl->qpn=0x%x\n",
981 *wqe_end = *wqe + ds * MLX5_WQE_DS_UNITS;
982 *wqe += sizeof(*ctrl);
984 opcode = be32_to_cpu(ctrl->opmod_idx_opcode) &
985 MLX5_WQE_CTRL_OPCODE_MASK;
987 switch (qp->ibqp.qp_type) {
989 transport_caps = dev->odp_caps.per_transport_caps.rc_odp_caps;
992 transport_caps = dev->odp_caps.per_transport_caps.ud_odp_caps;
995 mlx5_ib_err(dev, "ODP fault on QP of an unsupported transport 0x%x\n",
1000 if (unlikely(opcode >= ARRAY_SIZE(mlx5_ib_odp_opcode_cap) ||
1001 !(transport_caps & mlx5_ib_odp_opcode_cap[opcode]))) {
1002 mlx5_ib_err(dev, "ODP fault on QP of an unsupported opcode 0x%x\n",
1007 if (qp->ibqp.qp_type != IB_QPT_RC) {
1009 if (av->dqp_dct & cpu_to_be32(MLX5_EXTENDED_UD_AV))
1010 *wqe += sizeof(struct mlx5_av);
1012 *wqe += sizeof(struct mlx5_base_av);
1016 case MLX5_OPCODE_RDMA_WRITE:
1017 case MLX5_OPCODE_RDMA_WRITE_IMM:
1018 case MLX5_OPCODE_RDMA_READ:
1019 *wqe += sizeof(struct mlx5_wqe_raddr_seg);
1021 case MLX5_OPCODE_ATOMIC_CS:
1022 case MLX5_OPCODE_ATOMIC_FA:
1023 *wqe += sizeof(struct mlx5_wqe_raddr_seg);
1024 *wqe += sizeof(struct mlx5_wqe_atomic_seg);
1032 * Parse responder WQE. Advances the wqe pointer to point at the
1033 * scatter-gather list, and set wqe_end to the end of the WQE.
1035 static int mlx5_ib_mr_responder_pfault_handler(
1036 struct mlx5_ib_dev *dev, struct mlx5_pagefault *pfault,
1037 struct mlx5_ib_qp *qp, void **wqe, void **wqe_end, int wqe_length)
1039 struct mlx5_ib_wq *wq = &qp->rq;
1040 int wqe_size = 1 << wq->wqe_shift;
1043 mlx5_ib_err(dev, "ODP fault on SRQ is not supported\n");
1048 mlx5_ib_err(dev, "ODP fault with WQE signatures is not supported\n");
1052 if (wqe_size > wqe_length) {
1053 mlx5_ib_err(dev, "Couldn't read all of the receive WQE's content\n");
1057 switch (qp->ibqp.qp_type) {
1059 if (!(dev->odp_caps.per_transport_caps.rc_odp_caps &
1060 IB_ODP_SUPPORT_RECV))
1061 goto invalid_transport_or_opcode;
1064 invalid_transport_or_opcode:
1065 mlx5_ib_err(dev, "ODP fault on QP of an unsupported transport. transport: 0x%x\n",
1070 *wqe_end = *wqe + wqe_size;
1075 static inline struct mlx5_core_rsc_common *odp_get_rsc(struct mlx5_ib_dev *dev,
1076 u32 wq_num, int pf_type)
1078 enum mlx5_res_type res_type;
1081 case MLX5_WQE_PF_TYPE_RMP:
1082 res_type = MLX5_RES_SRQ;
1084 case MLX5_WQE_PF_TYPE_REQ_SEND_OR_WRITE:
1085 case MLX5_WQE_PF_TYPE_RESP:
1086 case MLX5_WQE_PF_TYPE_REQ_READ_OR_ATOMIC:
1087 res_type = MLX5_RES_QP;
1093 return mlx5_core_res_hold(dev->mdev, wq_num, res_type);
1096 static inline struct mlx5_ib_qp *res_to_qp(struct mlx5_core_rsc_common *res)
1098 struct mlx5_core_qp *mqp = (struct mlx5_core_qp *)res;
1100 return to_mibqp(mqp);
1103 static void mlx5_ib_mr_wqe_pfault_handler(struct mlx5_ib_dev *dev,
1104 struct mlx5_pagefault *pfault)
1107 void *wqe, *wqe_end;
1108 u32 bytes_mapped, total_wqe_bytes;
1109 char *buffer = NULL;
1110 int resume_with_error = 1;
1111 u16 wqe_index = pfault->wqe.wqe_index;
1112 int requestor = pfault->type & MLX5_PFAULT_REQUESTOR;
1113 struct mlx5_core_rsc_common *res;
1114 struct mlx5_ib_qp *qp;
1116 res = odp_get_rsc(dev, pfault->wqe.wq_num, pfault->type);
1118 mlx5_ib_dbg(dev, "wqe page fault for missing resource %d\n", pfault->wqe.wq_num);
1124 qp = res_to_qp(res);
1127 mlx5_ib_err(dev, "wqe page fault for unsupported type %d\n", pfault->type);
1128 goto resolve_page_fault;
1131 buffer = (char *)__get_free_page(GFP_KERNEL);
1133 mlx5_ib_err(dev, "Error allocating memory for IO page fault handling.\n");
1134 goto resolve_page_fault;
1137 ret = mlx5_ib_read_user_wqe(qp, requestor, wqe_index, buffer,
1138 PAGE_SIZE, &qp->trans_qp.base);
1140 mlx5_ib_err(dev, "Failed reading a WQE following page fault, error=%d, wqe_index=%x, qpn=%x\n",
1141 ret, wqe_index, pfault->token);
1142 goto resolve_page_fault;
1147 ret = mlx5_ib_mr_initiator_pfault_handler(dev, pfault, qp, &wqe,
1150 ret = mlx5_ib_mr_responder_pfault_handler(dev, pfault, qp, &wqe,
1153 goto resolve_page_fault;
1155 if (wqe >= wqe_end) {
1156 mlx5_ib_err(dev, "ODP fault on invalid WQE.\n");
1157 goto resolve_page_fault;
1160 ret = pagefault_data_segments(dev, pfault, qp, wqe, wqe_end,
1161 &bytes_mapped, &total_wqe_bytes,
1163 if (ret == -EAGAIN) {
1164 resume_with_error = 0;
1165 goto resolve_page_fault;
1166 } else if (ret < 0 || total_wqe_bytes > bytes_mapped) {
1167 goto resolve_page_fault;
1170 resume_with_error = 0;
1172 mlx5_ib_page_fault_resume(dev, pfault, resume_with_error);
1173 mlx5_ib_dbg(dev, "PAGE FAULT completed. QP 0x%x resume_with_error=%d, type: 0x%x\n",
1174 pfault->wqe.wq_num, resume_with_error,
1176 mlx5_core_res_put(res);
1177 free_page((unsigned long)buffer);
1180 static int pages_in_range(u64 address, u32 length)
1182 return (ALIGN(address + length, PAGE_SIZE) -
1183 (address & PAGE_MASK)) >> PAGE_SHIFT;
1186 static void mlx5_ib_mr_rdma_pfault_handler(struct mlx5_ib_dev *dev,
1187 struct mlx5_pagefault *pfault)
1191 u32 prefetch_len = pfault->bytes_committed;
1192 int prefetch_activated = 0;
1193 u32 rkey = pfault->rdma.r_key;
1196 /* The RDMA responder handler handles the page fault in two parts.
1197 * First it brings the necessary pages for the current packet
1198 * (and uses the pfault context), and then (after resuming the QP)
1199 * prefetches more pages. The second operation cannot use the pfault
1200 * context and therefore uses the dummy_pfault context allocated on
1202 pfault->rdma.rdma_va += pfault->bytes_committed;
1203 pfault->rdma.rdma_op_len -= min(pfault->bytes_committed,
1204 pfault->rdma.rdma_op_len);
1205 pfault->bytes_committed = 0;
1207 address = pfault->rdma.rdma_va;
1208 length = pfault->rdma.rdma_op_len;
1210 /* For some operations, the hardware cannot tell the exact message
1211 * length, and in those cases it reports zero. Use prefetch
1214 prefetch_activated = 1;
1215 length = pfault->rdma.packet_size;
1216 prefetch_len = min(MAX_PREFETCH_LEN, prefetch_len);
1219 ret = pagefault_single_data_segment(dev, rkey, address, length,
1220 &pfault->bytes_committed, NULL);
1221 if (ret == -EAGAIN) {
1222 /* We're racing with an invalidation, don't prefetch */
1223 prefetch_activated = 0;
1224 } else if (ret < 0 || pages_in_range(address, length) > ret) {
1225 mlx5_ib_page_fault_resume(dev, pfault, 1);
1227 mlx5_ib_dbg(dev, "PAGE FAULT error %d. QP 0x%x, type: 0x%x\n",
1228 ret, pfault->token, pfault->type);
1232 mlx5_ib_page_fault_resume(dev, pfault, 0);
1233 mlx5_ib_dbg(dev, "PAGE FAULT completed. QP 0x%x, type: 0x%x, prefetch_activated: %d\n",
1234 pfault->token, pfault->type,
1235 prefetch_activated);
1237 /* At this point, there might be a new pagefault already arriving in
1238 * the eq, switch to the dummy pagefault for the rest of the
1239 * processing. We're still OK with the objects being alive as the
1240 * work-queue is being fenced. */
1242 if (prefetch_activated) {
1243 u32 bytes_committed = 0;
1245 ret = pagefault_single_data_segment(dev, rkey, address,
1247 &bytes_committed, NULL);
1248 if (ret < 0 && ret != -EAGAIN) {
1249 mlx5_ib_dbg(dev, "Prefetch failed. ret: %d, QP 0x%x, address: 0x%.16llx, length = 0x%.16x\n",
1250 ret, pfault->token, address, prefetch_len);
1255 static void mlx5_ib_pfault(struct mlx5_ib_dev *dev, struct mlx5_pagefault *pfault)
1257 u8 event_subtype = pfault->event_subtype;
1259 switch (event_subtype) {
1260 case MLX5_PFAULT_SUBTYPE_WQE:
1261 mlx5_ib_mr_wqe_pfault_handler(dev, pfault);
1263 case MLX5_PFAULT_SUBTYPE_RDMA:
1264 mlx5_ib_mr_rdma_pfault_handler(dev, pfault);
1267 mlx5_ib_err(dev, "Invalid page fault event subtype: 0x%x\n",
1269 mlx5_ib_page_fault_resume(dev, pfault, 1);
1273 static void mlx5_ib_eqe_pf_action(struct work_struct *work)
1275 struct mlx5_pagefault *pfault = container_of(work,
1276 struct mlx5_pagefault,
1278 struct mlx5_ib_pf_eq *eq = pfault->eq;
1280 mlx5_ib_pfault(eq->dev, pfault);
1281 mempool_free(pfault, eq->pool);
1284 static void mlx5_ib_eq_pf_process(struct mlx5_ib_pf_eq *eq)
1286 struct mlx5_eqe_page_fault *pf_eqe;
1287 struct mlx5_pagefault *pfault;
1288 struct mlx5_eqe *eqe;
1291 while ((eqe = mlx5_eq_get_eqe(eq->core, cc))) {
1292 pfault = mempool_alloc(eq->pool, GFP_ATOMIC);
1294 schedule_work(&eq->work);
1298 pf_eqe = &eqe->data.page_fault;
1299 pfault->event_subtype = eqe->sub_type;
1300 pfault->bytes_committed = be32_to_cpu(pf_eqe->bytes_committed);
1302 mlx5_ib_dbg(eq->dev,
1303 "PAGE_FAULT: subtype: 0x%02x, bytes_committed: 0x%06x\n",
1304 eqe->sub_type, pfault->bytes_committed);
1306 switch (eqe->sub_type) {
1307 case MLX5_PFAULT_SUBTYPE_RDMA:
1308 /* RDMA based event */
1310 be32_to_cpu(pf_eqe->rdma.pftype_token) >> 24;
1312 be32_to_cpu(pf_eqe->rdma.pftype_token) &
1314 pfault->rdma.r_key =
1315 be32_to_cpu(pf_eqe->rdma.r_key);
1316 pfault->rdma.packet_size =
1317 be16_to_cpu(pf_eqe->rdma.packet_length);
1318 pfault->rdma.rdma_op_len =
1319 be32_to_cpu(pf_eqe->rdma.rdma_op_len);
1320 pfault->rdma.rdma_va =
1321 be64_to_cpu(pf_eqe->rdma.rdma_va);
1322 mlx5_ib_dbg(eq->dev,
1323 "PAGE_FAULT: type:0x%x, token: 0x%06x, r_key: 0x%08x\n",
1324 pfault->type, pfault->token,
1325 pfault->rdma.r_key);
1326 mlx5_ib_dbg(eq->dev,
1327 "PAGE_FAULT: rdma_op_len: 0x%08x, rdma_va: 0x%016llx\n",
1328 pfault->rdma.rdma_op_len,
1329 pfault->rdma.rdma_va);
1332 case MLX5_PFAULT_SUBTYPE_WQE:
1333 /* WQE based event */
1335 (be32_to_cpu(pf_eqe->wqe.pftype_wq) >> 24) & 0x7;
1337 be32_to_cpu(pf_eqe->wqe.token);
1338 pfault->wqe.wq_num =
1339 be32_to_cpu(pf_eqe->wqe.pftype_wq) &
1341 pfault->wqe.wqe_index =
1342 be16_to_cpu(pf_eqe->wqe.wqe_index);
1343 pfault->wqe.packet_size =
1344 be16_to_cpu(pf_eqe->wqe.packet_length);
1345 mlx5_ib_dbg(eq->dev,
1346 "PAGE_FAULT: type:0x%x, token: 0x%06x, wq_num: 0x%06x, wqe_index: 0x%04x\n",
1347 pfault->type, pfault->token,
1349 pfault->wqe.wqe_index);
1353 mlx5_ib_warn(eq->dev,
1354 "Unsupported page fault event sub-type: 0x%02hhx\n",
1356 /* Unsupported page faults should still be
1357 * resolved by the page fault handler
1362 INIT_WORK(&pfault->work, mlx5_ib_eqe_pf_action);
1363 queue_work(eq->wq, &pfault->work);
1365 cc = mlx5_eq_update_cc(eq->core, ++cc);
1368 mlx5_eq_update_ci(eq->core, cc, 1);
1371 static irqreturn_t mlx5_ib_eq_pf_int(int irq, void *eq_ptr)
1373 struct mlx5_ib_pf_eq *eq = eq_ptr;
1374 unsigned long flags;
1376 if (spin_trylock_irqsave(&eq->lock, flags)) {
1377 mlx5_ib_eq_pf_process(eq);
1378 spin_unlock_irqrestore(&eq->lock, flags);
1380 schedule_work(&eq->work);
1386 /* mempool_refill() was proposed but unfortunately wasn't accepted
1387 * http://lkml.iu.edu/hypermail/linux/kernel/1512.1/05073.html
1390 static void mempool_refill(mempool_t *pool)
1392 while (pool->curr_nr < pool->min_nr)
1393 mempool_free(mempool_alloc(pool, GFP_KERNEL), pool);
1396 static void mlx5_ib_eq_pf_action(struct work_struct *work)
1398 struct mlx5_ib_pf_eq *eq =
1399 container_of(work, struct mlx5_ib_pf_eq, work);
1401 mempool_refill(eq->pool);
1403 spin_lock_irq(&eq->lock);
1404 mlx5_ib_eq_pf_process(eq);
1405 spin_unlock_irq(&eq->lock);
1409 MLX5_IB_NUM_PF_EQE = 0x1000,
1410 MLX5_IB_NUM_PF_DRAIN = 64,
1414 mlx5_ib_create_pf_eq(struct mlx5_ib_dev *dev, struct mlx5_ib_pf_eq *eq)
1416 struct mlx5_eq_param param = {};
1419 INIT_WORK(&eq->work, mlx5_ib_eq_pf_action);
1420 spin_lock_init(&eq->lock);
1423 eq->pool = mempool_create_kmalloc_pool(MLX5_IB_NUM_PF_DRAIN,
1424 sizeof(struct mlx5_pagefault));
1428 eq->wq = alloc_workqueue("mlx5_ib_page_fault",
1429 WQ_HIGHPRI | WQ_UNBOUND | WQ_MEM_RECLAIM,
1436 param = (struct mlx5_eq_param) {
1437 .index = MLX5_EQ_PFAULT_IDX,
1438 .mask = 1 << MLX5_EVENT_TYPE_PAGE_FAULT,
1439 .nent = MLX5_IB_NUM_PF_EQE,
1441 .handler = mlx5_ib_eq_pf_int
1443 eq->core = mlx5_eq_create_generic(dev->mdev, "mlx5_ib_page_fault_eq", ¶m);
1444 if (IS_ERR(eq->core)) {
1445 err = PTR_ERR(eq->core);
1451 destroy_workqueue(eq->wq);
1453 mempool_destroy(eq->pool);
1458 mlx5_ib_destroy_pf_eq(struct mlx5_ib_dev *dev, struct mlx5_ib_pf_eq *eq)
1462 err = mlx5_eq_destroy_generic(dev->mdev, eq->core);
1463 cancel_work_sync(&eq->work);
1464 destroy_workqueue(eq->wq);
1465 mempool_destroy(eq->pool);
1470 void mlx5_odp_init_mr_cache_entry(struct mlx5_cache_ent *ent)
1472 if (!(ent->dev->odp_caps.general_caps & IB_ODP_SUPPORT_IMPLICIT))
1475 switch (ent->order - 2) {
1476 case MLX5_IMR_MTT_CACHE_ENTRY:
1477 ent->page = PAGE_SHIFT;
1478 ent->xlt = MLX5_IMR_MTT_ENTRIES *
1479 sizeof(struct mlx5_mtt) /
1480 MLX5_IB_UMR_OCTOWORD;
1481 ent->access_mode = MLX5_MKC_ACCESS_MODE_MTT;
1485 case MLX5_IMR_KSM_CACHE_ENTRY:
1486 ent->page = MLX5_KSM_PAGE_SHIFT;
1487 ent->xlt = mlx5_imr_ksm_entries *
1488 sizeof(struct mlx5_klm) /
1489 MLX5_IB_UMR_OCTOWORD;
1490 ent->access_mode = MLX5_MKC_ACCESS_MODE_KSM;
1496 int mlx5_ib_odp_init_one(struct mlx5_ib_dev *dev)
1500 if (dev->odp_caps.general_caps & IB_ODP_SUPPORT_IMPLICIT) {
1501 ret = mlx5_cmd_null_mkey(dev->mdev, &dev->null_mkey);
1503 mlx5_ib_err(dev, "Error getting null_mkey %d\n", ret);
1508 if (!MLX5_CAP_GEN(dev->mdev, pg))
1511 ret = mlx5_ib_create_pf_eq(dev, &dev->odp_pf_eq);
1516 void mlx5_ib_odp_cleanup_one(struct mlx5_ib_dev *dev)
1518 if (!MLX5_CAP_GEN(dev->mdev, pg))
1521 mlx5_ib_destroy_pf_eq(dev, &dev->odp_pf_eq);
1524 int mlx5_ib_odp_init(void)
1526 mlx5_imr_ksm_entries = BIT_ULL(get_order(TASK_SIZE) -