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