net/sunrpc/xprtrdma/fmr_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 Memory Regions (FMR).
   7  * Referred to sometimes as MTHCAFMR mode.
   8  *
   9  * FMR uses synchronous memory registration and deregistration.
  10  * FMR registration is known to be fast, but FMR deregistration
  11  * can take tens of usecs to complete.
  12  */
  13
  14 /* Normal operation
  15  *
  16  * A Memory Region is prepared for RDMA READ or WRITE using the
  17  * ib_map_phys_fmr verb (fmr_op_map). When the RDMA operation is
  18  * finished, the Memory Region is unmapped using the ib_unmap_fmr
  19  * verb (fmr_op_unmap).
  20  */
  21
  22 /* Transport recovery
  23  *
  24  * After a transport reconnect, fmr_op_map re-uses the MR already
  25  * allocated for the RPC, but generates a fresh rkey then maps the
  26  * MR again. This process is synchronous.
  27  */
  28
  29 #include "xprt_rdma.h"
  30
  31 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
  32 # define RPCDBG_FACILITY        RPCDBG_TRANS
  33 #endif
  34
  35 /* Maximum scatter/gather per FMR */
  36 #define RPCRDMA_MAX_FMR_SGES    (64)
  37
  38 static int
  39 fmr_op_open(struct rpcrdma_ia *ia, struct rpcrdma_ep *ep,
  40             struct rpcrdma_create_data_internal *cdata)
  41 {
  42         struct ib_device_attr *devattr = &ia->ri_devattr;
  43         struct ib_mr *mr;
  44
  45         /* Obtain an lkey to use for the regbufs, which are
  46          * protected from remote access.
  47          */
  48         if (devattr->device_cap_flags & IB_DEVICE_LOCAL_DMA_LKEY) {
  49                 ia->ri_dma_lkey = ia->ri_device->local_dma_lkey;
  50         } else {
  51                 mr = ib_get_dma_mr(ia->ri_pd, IB_ACCESS_LOCAL_WRITE);
  52                 if (IS_ERR(mr)) {
  53                         pr_err("%s: ib_get_dma_mr for failed with %lX\n",
  54                                __func__, PTR_ERR(mr));
  55                         return -ENOMEM;
  56                 }
  57                 ia->ri_dma_lkey = ia->ri_dma_mr->lkey;
  58                 ia->ri_dma_mr = mr;
  59         }
  60
  61         return 0;
  62 }
  63
  64 /* FMR mode conveys up to 64 pages of payload per chunk segment.
  65  */
  66 static size_t
  67 fmr_op_maxpages(struct rpcrdma_xprt *r_xprt)
  68 {
  69         return min_t(unsigned int, RPCRDMA_MAX_DATA_SEGS,
  70                      rpcrdma_max_segments(r_xprt) * RPCRDMA_MAX_FMR_SGES);
  71 }
  72
  73 static int
  74 fmr_op_init(struct rpcrdma_xprt *r_xprt)
  75 {
  76         struct rpcrdma_buffer *buf = &r_xprt->rx_buf;
  77         int mr_access_flags = IB_ACCESS_REMOTE_WRITE | IB_ACCESS_REMOTE_READ;
  78         struct ib_fmr_attr fmr_attr = {
  79                 .max_pages      = RPCRDMA_MAX_FMR_SGES,
  80                 .max_maps       = 1,
  81                 .page_shift     = PAGE_SHIFT
  82         };
  83         struct ib_pd *pd = r_xprt->rx_ia.ri_pd;
  84         struct rpcrdma_mw *r;
  85         int i, rc;
  86
  87         spin_lock_init(&buf->rb_mwlock);
  88         INIT_LIST_HEAD(&buf->rb_mws);
  89         INIT_LIST_HEAD(&buf->rb_all);
  90
  91         i = max_t(int, RPCRDMA_MAX_DATA_SEGS / RPCRDMA_MAX_FMR_SGES, 1);
  92         i += 2;                         /* head + tail */
  93         i *= buf->rb_max_requests;      /* one set for each RPC slot */
  94         dprintk("RPC:       %s: initalizing %d FMRs\n", __func__, i);
  95
  96         rc = -ENOMEM;
  97         while (i--) {
  98                 r = kzalloc(sizeof(*r), GFP_KERNEL);
  99                 if (!r)
 100                         goto out;
 101
 102                 r->r.fmr.physaddrs = kmalloc(RPCRDMA_MAX_FMR_SGES *
 103                                              sizeof(u64), GFP_KERNEL);
 104                 if (!r->r.fmr.physaddrs)
 105                         goto out_free;
 106
 107                 r->r.fmr.fmr = ib_alloc_fmr(pd, mr_access_flags, &fmr_attr);
 108                 if (IS_ERR(r->r.fmr.fmr))
 109                         goto out_fmr_err;
 110
 111                 list_add(&r->mw_list, &buf->rb_mws);
 112                 list_add(&r->mw_all, &buf->rb_all);
 113         }
 114         return 0;
 115
 116 out_fmr_err:
 117         rc = PTR_ERR(r->r.fmr.fmr);
 118         dprintk("RPC:       %s: ib_alloc_fmr status %i\n", __func__, rc);
 119         kfree(r->r.fmr.physaddrs);
 120 out_free:
 121         kfree(r);
 122 out:
 123         return rc;
 124 }
 125
 126 static int
 127 __fmr_unmap(struct rpcrdma_mw *r)
 128 {
 129         LIST_HEAD(l);
 130
 131         list_add(&r->r.fmr.fmr->list, &l);
 132         return ib_unmap_fmr(&l);
 133 }
 134
 135 /* Use the ib_map_phys_fmr() verb to register a memory region
 136  * for remote access via RDMA READ or RDMA WRITE.
 137  */
 138 static int
 139 fmr_op_map(struct rpcrdma_xprt *r_xprt, struct rpcrdma_mr_seg *seg,
 140            int nsegs, bool writing)
 141 {
 142         struct rpcrdma_ia *ia = &r_xprt->rx_ia;
 143         struct ib_device *device = ia->ri_device;
 144         enum dma_data_direction direction = rpcrdma_data_dir(writing);
 145         struct rpcrdma_mr_seg *seg1 = seg;
 146         int len, pageoff, i, rc;
 147         struct rpcrdma_mw *mw;
 148
 149         mw = seg1->rl_mw;
 150         seg1->rl_mw = NULL;
 151         if (!mw) {
 152                 mw = rpcrdma_get_mw(r_xprt);
 153                 if (!mw)
 154                         return -ENOMEM;
 155         } else {
 156                 /* this is a retransmit; generate a fresh rkey */
 157                 rc = __fmr_unmap(mw);
 158                 if (rc)
 159                         return rc;
 160         }
 161
 162         pageoff = offset_in_page(seg1->mr_offset);
 163         seg1->mr_offset -= pageoff;     /* start of page */
 164         seg1->mr_len += pageoff;
 165         len = -pageoff;
 166         if (nsegs > RPCRDMA_MAX_FMR_SGES)
 167                 nsegs = RPCRDMA_MAX_FMR_SGES;
 168         for (i = 0; i < nsegs;) {
 169                 rpcrdma_map_one(device, seg, direction);
 170                 mw->r.fmr.physaddrs[i] = seg->mr_dma;
 171                 len += seg->mr_len;
 172                 ++seg;
 173                 ++i;
 174                 /* Check for holes */
 175                 if ((i < nsegs && offset_in_page(seg->mr_offset)) ||
 176                     offset_in_page((seg-1)->mr_offset + (seg-1)->mr_len))
 177                         break;
 178         }
 179
 180         rc = ib_map_phys_fmr(mw->r.fmr.fmr, mw->r.fmr.physaddrs,
 181                              i, seg1->mr_dma);
 182         if (rc)
 183                 goto out_maperr;
 184
 185         seg1->rl_mw = mw;
 186         seg1->mr_rkey = mw->r.fmr.fmr->rkey;
 187         seg1->mr_base = seg1->mr_dma + pageoff;
 188         seg1->mr_nsegs = i;
 189         seg1->mr_len = len;
 190         return i;
 191
 192 out_maperr:
 193         dprintk("RPC:       %s: ib_map_phys_fmr %u@0x%llx+%i (%d) status %i\n",
 194                 __func__, len, (unsigned long long)seg1->mr_dma,
 195                 pageoff, i, rc);
 196         while (i--)
 197                 rpcrdma_unmap_one(device, --seg);
 198         return rc;
 199 }
 200
 201 /* Use the ib_unmap_fmr() verb to prevent further remote
 202  * access via RDMA READ or RDMA WRITE.
 203  */
 204 static int
 205 fmr_op_unmap(struct rpcrdma_xprt *r_xprt, struct rpcrdma_mr_seg *seg)
 206 {
 207         struct rpcrdma_ia *ia = &r_xprt->rx_ia;
 208         struct rpcrdma_mr_seg *seg1 = seg;
 209         struct rpcrdma_mw *mw = seg1->rl_mw;
 210         int rc, nsegs = seg->mr_nsegs;
 211
 212         dprintk("RPC:       %s: FMR %p\n", __func__, mw);
 213
 214         seg1->rl_mw = NULL;
 215         while (seg1->mr_nsegs--)
 216                 rpcrdma_unmap_one(ia->ri_device, seg++);
 217         rc = __fmr_unmap(mw);
 218         if (rc)
 219                 goto out_err;
 220         rpcrdma_put_mw(r_xprt, mw);
 221         return nsegs;
 222
 223 out_err:
 224         /* The FMR is abandoned, but remains in rb_all. fmr_op_destroy
 225          * will attempt to release it when the transport is destroyed.
 226          */
 227         dprintk("RPC:       %s: ib_unmap_fmr status %i\n", __func__, rc);
 228         return nsegs;
 229 }
 230
 231 static void
 232 fmr_op_destroy(struct rpcrdma_buffer *buf)
 233 {
 234         struct rpcrdma_mw *r;
 235         int rc;
 236
 237         while (!list_empty(&buf->rb_all)) {
 238                 r = list_entry(buf->rb_all.next, struct rpcrdma_mw, mw_all);
 239                 list_del(&r->mw_all);
 240                 kfree(r->r.fmr.physaddrs);
 241
 242                 rc = ib_dealloc_fmr(r->r.fmr.fmr);
 243                 if (rc)
 244                         dprintk("RPC:       %s: ib_dealloc_fmr failed %i\n",
 245                                 __func__, rc);
 246
 247                 kfree(r);
 248         }
 249 }
 250
 251 const struct rpcrdma_memreg_ops rpcrdma_fmr_memreg_ops = {
 252         .ro_map                         = fmr_op_map,
 253         .ro_unmap                       = fmr_op_unmap,
 254         .ro_open                        = fmr_op_open,
 255         .ro_maxpages                    = fmr_op_maxpages,
 256         .ro_init                        = fmr_op_init,
 257         .ro_destroy                     = fmr_op_destroy,
 258         .ro_displayname                 = "fmr",
 259 };