Merge tag 'nfs-for-4.20-1' of git://git.linux-nfs.org/projects/trondmy/linux-nfs
[sfrench/cifs-2.6.git] / net / sunrpc / xprtrdma / frwr_ops.c
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Copyright (c) 2015, 2017 Oracle.  All rights reserved.
4  * Copyright (c) 2003-2007 Network Appliance, Inc. All rights reserved.
5  */
6
7 /* Lightweight memory registration using Fast Registration Work
8  * Requests (FRWR).
9  *
10  * FRWR features ordered asynchronous registration and deregistration
11  * of arbitrarily sized memory regions. This is the fastest and safest
12  * but most complex memory registration mode.
13  */
14
15 /* Normal operation
16  *
17  * A Memory Region is prepared for RDMA READ or WRITE using a FAST_REG
18  * Work Request (frwr_op_map). When the RDMA operation is finished, this
19  * Memory Region is invalidated using a LOCAL_INV Work Request
20  * (frwr_op_unmap_sync).
21  *
22  * Typically these Work Requests are not signaled, and neither are RDMA
23  * SEND Work Requests (with the exception of signaling occasionally to
24  * prevent provider work queue overflows). This greatly reduces HCA
25  * interrupt workload.
26  *
27  * As an optimization, frwr_op_unmap marks MRs INVALID before the
28  * LOCAL_INV WR is posted. If posting succeeds, the MR is placed on
29  * rb_mrs immediately so that no work (like managing a linked list
30  * under a spinlock) is needed in the completion upcall.
31  *
32  * But this means that frwr_op_map() can occasionally encounter an MR
33  * that is INVALID but the LOCAL_INV WR has not completed. Work Queue
34  * ordering prevents a subsequent FAST_REG WR from executing against
35  * that MR while it is still being invalidated.
36  */
37
38 /* Transport recovery
39  *
40  * ->op_map and the transport connect worker cannot run at the same
41  * time, but ->op_unmap can fire while the transport connect worker
42  * is running. Thus MR recovery is handled in ->op_map, to guarantee
43  * that recovered MRs are owned by a sending RPC, and not one where
44  * ->op_unmap could fire at the same time transport reconnect is
45  * being done.
46  *
47  * When the underlying transport disconnects, MRs are left in one of
48  * four states:
49  *
50  * INVALID:     The MR was not in use before the QP entered ERROR state.
51  *
52  * VALID:       The MR was registered before the QP entered ERROR state.
53  *
54  * FLUSHED_FR:  The MR was being registered when the QP entered ERROR
55  *              state, and the pending WR was flushed.
56  *
57  * FLUSHED_LI:  The MR was being invalidated when the QP entered ERROR
58  *              state, and the pending WR was flushed.
59  *
60  * When frwr_op_map encounters FLUSHED and VALID MRs, they are recovered
61  * with ib_dereg_mr and then are re-initialized. Because MR recovery
62  * allocates fresh resources, it is deferred to a workqueue, and the
63  * recovered MRs are placed back on the rb_mrs list when recovery is
64  * complete. frwr_op_map allocates another MR for the current RPC while
65  * the broken MR is reset.
66  *
67  * To ensure that frwr_op_map doesn't encounter an MR that is marked
68  * INVALID but that is about to be flushed due to a previous transport
69  * disconnect, the transport connect worker attempts to drain all
70  * pending send queue WRs before the transport is reconnected.
71  */
72
73 #include <linux/sunrpc/rpc_rdma.h>
74 #include <linux/sunrpc/svc_rdma.h>
75
76 #include "xprt_rdma.h"
77 #include <trace/events/rpcrdma.h>
78
79 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
80 # define RPCDBG_FACILITY        RPCDBG_TRANS
81 #endif
82
83 bool
84 frwr_is_supported(struct rpcrdma_ia *ia)
85 {
86         struct ib_device_attr *attrs = &ia->ri_device->attrs;
87
88         if (!(attrs->device_cap_flags & IB_DEVICE_MEM_MGT_EXTENSIONS))
89                 goto out_not_supported;
90         if (attrs->max_fast_reg_page_list_len == 0)
91                 goto out_not_supported;
92         return true;
93
94 out_not_supported:
95         pr_info("rpcrdma: 'frwr' mode is not supported by device %s\n",
96                 ia->ri_device->name);
97         return false;
98 }
99
100 static void
101 frwr_op_release_mr(struct rpcrdma_mr *mr)
102 {
103         int rc;
104
105         rc = ib_dereg_mr(mr->frwr.fr_mr);
106         if (rc)
107                 pr_err("rpcrdma: final ib_dereg_mr for %p returned %i\n",
108                        mr, rc);
109         kfree(mr->mr_sg);
110         kfree(mr);
111 }
112
113 /* MRs are dynamically allocated, so simply clean up and release the MR.
114  * A replacement MR will subsequently be allocated on demand.
115  */
116 static void
117 frwr_mr_recycle_worker(struct work_struct *work)
118 {
119         struct rpcrdma_mr *mr = container_of(work, struct rpcrdma_mr, mr_recycle);
120         enum rpcrdma_frwr_state state = mr->frwr.fr_state;
121         struct rpcrdma_xprt *r_xprt = mr->mr_xprt;
122
123         trace_xprtrdma_mr_recycle(mr);
124
125         if (state != FRWR_FLUSHED_LI) {
126                 trace_xprtrdma_mr_unmap(mr);
127                 ib_dma_unmap_sg(r_xprt->rx_ia.ri_device,
128                                 mr->mr_sg, mr->mr_nents, mr->mr_dir);
129         }
130
131         spin_lock(&r_xprt->rx_buf.rb_mrlock);
132         list_del(&mr->mr_all);
133         r_xprt->rx_stats.mrs_recycled++;
134         spin_unlock(&r_xprt->rx_buf.rb_mrlock);
135         frwr_op_release_mr(mr);
136 }
137
138 static int
139 frwr_op_init_mr(struct rpcrdma_ia *ia, struct rpcrdma_mr *mr)
140 {
141         unsigned int depth = ia->ri_max_frwr_depth;
142         struct rpcrdma_frwr *frwr = &mr->frwr;
143         int rc;
144
145         frwr->fr_mr = ib_alloc_mr(ia->ri_pd, ia->ri_mrtype, depth);
146         if (IS_ERR(frwr->fr_mr))
147                 goto out_mr_err;
148
149         mr->mr_sg = kcalloc(depth, sizeof(*mr->mr_sg), GFP_KERNEL);
150         if (!mr->mr_sg)
151                 goto out_list_err;
152
153         INIT_LIST_HEAD(&mr->mr_list);
154         INIT_WORK(&mr->mr_recycle, frwr_mr_recycle_worker);
155         sg_init_table(mr->mr_sg, depth);
156         init_completion(&frwr->fr_linv_done);
157         return 0;
158
159 out_mr_err:
160         rc = PTR_ERR(frwr->fr_mr);
161         dprintk("RPC:       %s: ib_alloc_mr status %i\n",
162                 __func__, rc);
163         return rc;
164
165 out_list_err:
166         rc = -ENOMEM;
167         dprintk("RPC:       %s: sg allocation failure\n",
168                 __func__);
169         ib_dereg_mr(frwr->fr_mr);
170         return rc;
171 }
172
173 /* On success, sets:
174  *      ep->rep_attr.cap.max_send_wr
175  *      ep->rep_attr.cap.max_recv_wr
176  *      cdata->max_requests
177  *      ia->ri_max_segs
178  *
179  * And these FRWR-related fields:
180  *      ia->ri_max_frwr_depth
181  *      ia->ri_mrtype
182  */
183 static int
184 frwr_op_open(struct rpcrdma_ia *ia, struct rpcrdma_ep *ep,
185              struct rpcrdma_create_data_internal *cdata)
186 {
187         struct ib_device_attr *attrs = &ia->ri_device->attrs;
188         int max_qp_wr, depth, delta;
189
190         ia->ri_mrtype = IB_MR_TYPE_MEM_REG;
191         if (attrs->device_cap_flags & IB_DEVICE_SG_GAPS_REG)
192                 ia->ri_mrtype = IB_MR_TYPE_SG_GAPS;
193
194         ia->ri_max_frwr_depth =
195                         min_t(unsigned int, RPCRDMA_MAX_DATA_SEGS,
196                               attrs->max_fast_reg_page_list_len);
197         dprintk("RPC:       %s: device's max FR page list len = %u\n",
198                 __func__, ia->ri_max_frwr_depth);
199
200         /* Add room for frwr register and invalidate WRs.
201          * 1. FRWR reg WR for head
202          * 2. FRWR invalidate WR for head
203          * 3. N FRWR reg WRs for pagelist
204          * 4. N FRWR invalidate WRs for pagelist
205          * 5. FRWR reg WR for tail
206          * 6. FRWR invalidate WR for tail
207          * 7. The RDMA_SEND WR
208          */
209         depth = 7;
210
211         /* Calculate N if the device max FRWR depth is smaller than
212          * RPCRDMA_MAX_DATA_SEGS.
213          */
214         if (ia->ri_max_frwr_depth < RPCRDMA_MAX_DATA_SEGS) {
215                 delta = RPCRDMA_MAX_DATA_SEGS - ia->ri_max_frwr_depth;
216                 do {
217                         depth += 2; /* FRWR reg + invalidate */
218                         delta -= ia->ri_max_frwr_depth;
219                 } while (delta > 0);
220         }
221
222         max_qp_wr = ia->ri_device->attrs.max_qp_wr;
223         max_qp_wr -= RPCRDMA_BACKWARD_WRS;
224         max_qp_wr -= 1;
225         if (max_qp_wr < RPCRDMA_MIN_SLOT_TABLE)
226                 return -ENOMEM;
227         if (cdata->max_requests > max_qp_wr)
228                 cdata->max_requests = max_qp_wr;
229         ep->rep_attr.cap.max_send_wr = cdata->max_requests * depth;
230         if (ep->rep_attr.cap.max_send_wr > max_qp_wr) {
231                 cdata->max_requests = max_qp_wr / depth;
232                 if (!cdata->max_requests)
233                         return -EINVAL;
234                 ep->rep_attr.cap.max_send_wr = cdata->max_requests *
235                                                depth;
236         }
237         ep->rep_attr.cap.max_send_wr += RPCRDMA_BACKWARD_WRS;
238         ep->rep_attr.cap.max_send_wr += 1; /* for ib_drain_sq */
239         ep->rep_attr.cap.max_recv_wr = cdata->max_requests;
240         ep->rep_attr.cap.max_recv_wr += RPCRDMA_BACKWARD_WRS;
241         ep->rep_attr.cap.max_recv_wr += 1; /* for ib_drain_rq */
242
243         ia->ri_max_segs = max_t(unsigned int, 1, RPCRDMA_MAX_DATA_SEGS /
244                                 ia->ri_max_frwr_depth);
245         ia->ri_max_segs += 2;   /* segments for head and tail buffers */
246         return 0;
247 }
248
249 /* FRWR mode conveys a list of pages per chunk segment. The
250  * maximum length of that list is the FRWR page list depth.
251  */
252 static size_t
253 frwr_op_maxpages(struct rpcrdma_xprt *r_xprt)
254 {
255         struct rpcrdma_ia *ia = &r_xprt->rx_ia;
256
257         return min_t(unsigned int, RPCRDMA_MAX_DATA_SEGS,
258                      RPCRDMA_MAX_HDR_SEGS * ia->ri_max_frwr_depth);
259 }
260
261 static void
262 __frwr_sendcompletion_flush(struct ib_wc *wc, const char *wr)
263 {
264         if (wc->status != IB_WC_WR_FLUSH_ERR)
265                 pr_err("rpcrdma: %s: %s (%u/0x%x)\n",
266                        wr, ib_wc_status_msg(wc->status),
267                        wc->status, wc->vendor_err);
268 }
269
270 /**
271  * frwr_wc_fastreg - Invoked by RDMA provider for a flushed FastReg WC
272  * @cq: completion queue (ignored)
273  * @wc: completed WR
274  *
275  */
276 static void
277 frwr_wc_fastreg(struct ib_cq *cq, struct ib_wc *wc)
278 {
279         struct ib_cqe *cqe = wc->wr_cqe;
280         struct rpcrdma_frwr *frwr =
281                         container_of(cqe, struct rpcrdma_frwr, fr_cqe);
282
283         /* WARNING: Only wr_cqe and status are reliable at this point */
284         if (wc->status != IB_WC_SUCCESS) {
285                 frwr->fr_state = FRWR_FLUSHED_FR;
286                 __frwr_sendcompletion_flush(wc, "fastreg");
287         }
288         trace_xprtrdma_wc_fastreg(wc, frwr);
289 }
290
291 /**
292  * frwr_wc_localinv - Invoked by RDMA provider for a flushed LocalInv WC
293  * @cq: completion queue (ignored)
294  * @wc: completed WR
295  *
296  */
297 static void
298 frwr_wc_localinv(struct ib_cq *cq, struct ib_wc *wc)
299 {
300         struct ib_cqe *cqe = wc->wr_cqe;
301         struct rpcrdma_frwr *frwr = container_of(cqe, struct rpcrdma_frwr,
302                                                  fr_cqe);
303
304         /* WARNING: Only wr_cqe and status are reliable at this point */
305         if (wc->status != IB_WC_SUCCESS) {
306                 frwr->fr_state = FRWR_FLUSHED_LI;
307                 __frwr_sendcompletion_flush(wc, "localinv");
308         }
309         trace_xprtrdma_wc_li(wc, frwr);
310 }
311
312 /**
313  * frwr_wc_localinv_wake - Invoked by RDMA provider for a signaled LocalInv WC
314  * @cq: completion queue (ignored)
315  * @wc: completed WR
316  *
317  * Awaken anyone waiting for an MR to finish being fenced.
318  */
319 static void
320 frwr_wc_localinv_wake(struct ib_cq *cq, struct ib_wc *wc)
321 {
322         struct ib_cqe *cqe = wc->wr_cqe;
323         struct rpcrdma_frwr *frwr = container_of(cqe, struct rpcrdma_frwr,
324                                                  fr_cqe);
325
326         /* WARNING: Only wr_cqe and status are reliable at this point */
327         if (wc->status != IB_WC_SUCCESS) {
328                 frwr->fr_state = FRWR_FLUSHED_LI;
329                 __frwr_sendcompletion_flush(wc, "localinv");
330         }
331         complete(&frwr->fr_linv_done);
332         trace_xprtrdma_wc_li_wake(wc, frwr);
333 }
334
335 /* Post a REG_MR Work Request to register a memory region
336  * for remote access via RDMA READ or RDMA WRITE.
337  */
338 static struct rpcrdma_mr_seg *
339 frwr_op_map(struct rpcrdma_xprt *r_xprt, struct rpcrdma_mr_seg *seg,
340             int nsegs, bool writing, struct rpcrdma_mr **out)
341 {
342         struct rpcrdma_ia *ia = &r_xprt->rx_ia;
343         bool holes_ok = ia->ri_mrtype == IB_MR_TYPE_SG_GAPS;
344         struct rpcrdma_frwr *frwr;
345         struct rpcrdma_mr *mr;
346         struct ib_mr *ibmr;
347         struct ib_reg_wr *reg_wr;
348         int i, n;
349         u8 key;
350
351         mr = NULL;
352         do {
353                 if (mr)
354                         rpcrdma_mr_recycle(mr);
355                 mr = rpcrdma_mr_get(r_xprt);
356                 if (!mr)
357                         return ERR_PTR(-EAGAIN);
358         } while (mr->frwr.fr_state != FRWR_IS_INVALID);
359         frwr = &mr->frwr;
360         frwr->fr_state = FRWR_IS_VALID;
361
362         if (nsegs > ia->ri_max_frwr_depth)
363                 nsegs = ia->ri_max_frwr_depth;
364         for (i = 0; i < nsegs;) {
365                 if (seg->mr_page)
366                         sg_set_page(&mr->mr_sg[i],
367                                     seg->mr_page,
368                                     seg->mr_len,
369                                     offset_in_page(seg->mr_offset));
370                 else
371                         sg_set_buf(&mr->mr_sg[i], seg->mr_offset,
372                                    seg->mr_len);
373
374                 ++seg;
375                 ++i;
376                 if (holes_ok)
377                         continue;
378                 if ((i < nsegs && offset_in_page(seg->mr_offset)) ||
379                     offset_in_page((seg-1)->mr_offset + (seg-1)->mr_len))
380                         break;
381         }
382         mr->mr_dir = rpcrdma_data_dir(writing);
383
384         mr->mr_nents = ib_dma_map_sg(ia->ri_device, mr->mr_sg, i, mr->mr_dir);
385         if (!mr->mr_nents)
386                 goto out_dmamap_err;
387         trace_xprtrdma_mr_map(mr);
388
389         ibmr = frwr->fr_mr;
390         n = ib_map_mr_sg(ibmr, mr->mr_sg, mr->mr_nents, NULL, PAGE_SIZE);
391         if (unlikely(n != mr->mr_nents))
392                 goto out_mapmr_err;
393
394         key = (u8)(ibmr->rkey & 0x000000FF);
395         ib_update_fast_reg_key(ibmr, ++key);
396
397         reg_wr = &frwr->fr_regwr;
398         reg_wr->mr = ibmr;
399         reg_wr->key = ibmr->rkey;
400         reg_wr->access = writing ?
401                          IB_ACCESS_REMOTE_WRITE | IB_ACCESS_LOCAL_WRITE :
402                          IB_ACCESS_REMOTE_READ;
403
404         mr->mr_handle = ibmr->rkey;
405         mr->mr_length = ibmr->length;
406         mr->mr_offset = ibmr->iova;
407
408         *out = mr;
409         return seg;
410
411 out_dmamap_err:
412         pr_err("rpcrdma: failed to DMA map sg %p sg_nents %d\n",
413                mr->mr_sg, i);
414         frwr->fr_state = FRWR_IS_INVALID;
415         rpcrdma_mr_put(mr);
416         return ERR_PTR(-EIO);
417
418 out_mapmr_err:
419         pr_err("rpcrdma: failed to map mr %p (%d/%d)\n",
420                frwr->fr_mr, n, mr->mr_nents);
421         rpcrdma_mr_recycle(mr);
422         return ERR_PTR(-EIO);
423 }
424
425 /* Post Send WR containing the RPC Call message.
426  *
427  * For FRMR, chain any FastReg WRs to the Send WR. Only a
428  * single ib_post_send call is needed to register memory
429  * and then post the Send WR.
430  */
431 static int
432 frwr_op_send(struct rpcrdma_ia *ia, struct rpcrdma_req *req)
433 {
434         struct ib_send_wr *post_wr;
435         struct rpcrdma_mr *mr;
436
437         post_wr = &req->rl_sendctx->sc_wr;
438         list_for_each_entry(mr, &req->rl_registered, mr_list) {
439                 struct rpcrdma_frwr *frwr;
440
441                 frwr = &mr->frwr;
442
443                 frwr->fr_cqe.done = frwr_wc_fastreg;
444                 frwr->fr_regwr.wr.next = post_wr;
445                 frwr->fr_regwr.wr.wr_cqe = &frwr->fr_cqe;
446                 frwr->fr_regwr.wr.num_sge = 0;
447                 frwr->fr_regwr.wr.opcode = IB_WR_REG_MR;
448                 frwr->fr_regwr.wr.send_flags = 0;
449
450                 post_wr = &frwr->fr_regwr.wr;
451         }
452
453         /* If ib_post_send fails, the next ->send_request for
454          * @req will queue these MWs for recovery.
455          */
456         return ib_post_send(ia->ri_id->qp, post_wr, NULL);
457 }
458
459 /* Handle a remotely invalidated mr on the @mrs list
460  */
461 static void
462 frwr_op_reminv(struct rpcrdma_rep *rep, struct list_head *mrs)
463 {
464         struct rpcrdma_mr *mr;
465
466         list_for_each_entry(mr, mrs, mr_list)
467                 if (mr->mr_handle == rep->rr_inv_rkey) {
468                         list_del_init(&mr->mr_list);
469                         trace_xprtrdma_mr_remoteinv(mr);
470                         mr->frwr.fr_state = FRWR_IS_INVALID;
471                         rpcrdma_mr_unmap_and_put(mr);
472                         break;  /* only one invalidated MR per RPC */
473                 }
474 }
475
476 /* Invalidate all memory regions that were registered for "req".
477  *
478  * Sleeps until it is safe for the host CPU to access the
479  * previously mapped memory regions.
480  *
481  * Caller ensures that @mrs is not empty before the call. This
482  * function empties the list.
483  */
484 static void
485 frwr_op_unmap_sync(struct rpcrdma_xprt *r_xprt, struct list_head *mrs)
486 {
487         struct ib_send_wr *first, **prev, *last;
488         const struct ib_send_wr *bad_wr;
489         struct rpcrdma_ia *ia = &r_xprt->rx_ia;
490         struct rpcrdma_frwr *frwr;
491         struct rpcrdma_mr *mr;
492         int count, rc;
493
494         /* ORDER: Invalidate all of the MRs first
495          *
496          * Chain the LOCAL_INV Work Requests and post them with
497          * a single ib_post_send() call.
498          */
499         frwr = NULL;
500         count = 0;
501         prev = &first;
502         list_for_each_entry(mr, mrs, mr_list) {
503                 mr->frwr.fr_state = FRWR_IS_INVALID;
504
505                 frwr = &mr->frwr;
506                 trace_xprtrdma_mr_localinv(mr);
507
508                 frwr->fr_cqe.done = frwr_wc_localinv;
509                 last = &frwr->fr_invwr;
510                 memset(last, 0, sizeof(*last));
511                 last->wr_cqe = &frwr->fr_cqe;
512                 last->opcode = IB_WR_LOCAL_INV;
513                 last->ex.invalidate_rkey = mr->mr_handle;
514                 count++;
515
516                 *prev = last;
517                 prev = &last->next;
518         }
519         if (!frwr)
520                 goto unmap;
521
522         /* Strong send queue ordering guarantees that when the
523          * last WR in the chain completes, all WRs in the chain
524          * are complete.
525          */
526         last->send_flags = IB_SEND_SIGNALED;
527         frwr->fr_cqe.done = frwr_wc_localinv_wake;
528         reinit_completion(&frwr->fr_linv_done);
529
530         /* Transport disconnect drains the receive CQ before it
531          * replaces the QP. The RPC reply handler won't call us
532          * unless ri_id->qp is a valid pointer.
533          */
534         r_xprt->rx_stats.local_inv_needed++;
535         bad_wr = NULL;
536         rc = ib_post_send(ia->ri_id->qp, first, &bad_wr);
537         if (bad_wr != first)
538                 wait_for_completion(&frwr->fr_linv_done);
539         if (rc)
540                 goto out_release;
541
542         /* ORDER: Now DMA unmap all of the MRs, and return
543          * them to the free MR list.
544          */
545 unmap:
546         while (!list_empty(mrs)) {
547                 mr = rpcrdma_mr_pop(mrs);
548                 rpcrdma_mr_unmap_and_put(mr);
549         }
550         return;
551
552 out_release:
553         pr_err("rpcrdma: FRWR invalidate ib_post_send returned %i\n", rc);
554
555         /* Unmap and release the MRs in the LOCAL_INV WRs that did not
556          * get posted.
557          */
558         while (bad_wr) {
559                 frwr = container_of(bad_wr, struct rpcrdma_frwr,
560                                     fr_invwr);
561                 mr = container_of(frwr, struct rpcrdma_mr, frwr);
562                 bad_wr = bad_wr->next;
563
564                 list_del(&mr->mr_list);
565                 frwr_op_release_mr(mr);
566         }
567 }
568
569 const struct rpcrdma_memreg_ops rpcrdma_frwr_memreg_ops = {
570         .ro_map                         = frwr_op_map,
571         .ro_send                        = frwr_op_send,
572         .ro_reminv                      = frwr_op_reminv,
573         .ro_unmap_sync                  = frwr_op_unmap_sync,
574         .ro_open                        = frwr_op_open,
575         .ro_maxpages                    = frwr_op_maxpages,
576         .ro_init_mr                     = frwr_op_init_mr,
577         .ro_release_mr                  = frwr_op_release_mr,
578         .ro_displayname                 = "frwr",
579         .ro_send_w_inv_ok               = RPCRDMA_CMP_F_SND_W_INV_OK,
580 };