IB/iser: Reuse ib_sg_to_pages
[cascardo/linux.git] / drivers / infiniband / ulp / iser / iser_memory.c
1 /*
2  * Copyright (c) 2004, 2005, 2006 Voltaire, Inc. All rights reserved.
3  * Copyright (c) 2013-2014 Mellanox Technologies. All rights reserved.
4  *
5  * This software is available to you under a choice of one of two
6  * licenses.  You may choose to be licensed under the terms of the GNU
7  * General Public License (GPL) Version 2, available from the file
8  * COPYING in the main directory of this source tree, or the
9  * OpenIB.org BSD license below:
10  *
11  *     Redistribution and use in source and binary forms, with or
12  *     without modification, are permitted provided that the following
13  *     conditions are met:
14  *
15  *      - Redistributions of source code must retain the above
16  *        copyright notice, this list of conditions and the following
17  *        disclaimer.
18  *
19  *      - Redistributions in binary form must reproduce the above
20  *        copyright notice, this list of conditions and the following
21  *        disclaimer in the documentation and/or other materials
22  *        provided with the distribution.
23  *
24  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
25  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
26  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
27  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
28  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
29  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
30  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
31  * SOFTWARE.
32  */
33 #include <linux/module.h>
34 #include <linux/kernel.h>
35 #include <linux/slab.h>
36 #include <linux/mm.h>
37 #include <linux/highmem.h>
38 #include <linux/scatterlist.h>
39
40 #include "iscsi_iser.h"
41 static
42 int iser_fast_reg_fmr(struct iscsi_iser_task *iser_task,
43                       struct iser_data_buf *mem,
44                       struct iser_reg_resources *rsc,
45                       struct iser_mem_reg *mem_reg);
46 static
47 int iser_fast_reg_mr(struct iscsi_iser_task *iser_task,
48                      struct iser_data_buf *mem,
49                      struct iser_reg_resources *rsc,
50                      struct iser_mem_reg *mem_reg);
51
52 static const struct iser_reg_ops fastreg_ops = {
53         .alloc_reg_res  = iser_alloc_fastreg_pool,
54         .free_reg_res   = iser_free_fastreg_pool,
55         .reg_mem        = iser_fast_reg_mr,
56         .unreg_mem      = iser_unreg_mem_fastreg,
57         .reg_desc_get   = iser_reg_desc_get_fr,
58         .reg_desc_put   = iser_reg_desc_put_fr,
59 };
60
61 static const struct iser_reg_ops fmr_ops = {
62         .alloc_reg_res  = iser_alloc_fmr_pool,
63         .free_reg_res   = iser_free_fmr_pool,
64         .reg_mem        = iser_fast_reg_fmr,
65         .unreg_mem      = iser_unreg_mem_fmr,
66         .reg_desc_get   = iser_reg_desc_get_fmr,
67         .reg_desc_put   = iser_reg_desc_put_fmr,
68 };
69
70 void iser_reg_comp(struct ib_cq *cq, struct ib_wc *wc)
71 {
72         iser_err_comp(wc, "memreg");
73 }
74
75 int iser_assign_reg_ops(struct iser_device *device)
76 {
77         struct ib_device *ib_dev = device->ib_device;
78
79         /* Assign function handles  - based on FMR support */
80         if (ib_dev->alloc_fmr && ib_dev->dealloc_fmr &&
81             ib_dev->map_phys_fmr && ib_dev->unmap_fmr) {
82                 iser_info("FMR supported, using FMR for registration\n");
83                 device->reg_ops = &fmr_ops;
84         } else if (ib_dev->attrs.device_cap_flags & IB_DEVICE_MEM_MGT_EXTENSIONS) {
85                 iser_info("FastReg supported, using FastReg for registration\n");
86                 device->reg_ops = &fastreg_ops;
87         } else {
88                 iser_err("IB device does not support FMRs nor FastRegs, can't register memory\n");
89                 return -1;
90         }
91
92         return 0;
93 }
94
95 struct iser_fr_desc *
96 iser_reg_desc_get_fr(struct ib_conn *ib_conn)
97 {
98         struct iser_fr_pool *fr_pool = &ib_conn->fr_pool;
99         struct iser_fr_desc *desc;
100         unsigned long flags;
101
102         spin_lock_irqsave(&fr_pool->lock, flags);
103         desc = list_first_entry(&fr_pool->list,
104                                 struct iser_fr_desc, list);
105         list_del(&desc->list);
106         spin_unlock_irqrestore(&fr_pool->lock, flags);
107
108         return desc;
109 }
110
111 void
112 iser_reg_desc_put_fr(struct ib_conn *ib_conn,
113                      struct iser_fr_desc *desc)
114 {
115         struct iser_fr_pool *fr_pool = &ib_conn->fr_pool;
116         unsigned long flags;
117
118         spin_lock_irqsave(&fr_pool->lock, flags);
119         list_add(&desc->list, &fr_pool->list);
120         spin_unlock_irqrestore(&fr_pool->lock, flags);
121 }
122
123 struct iser_fr_desc *
124 iser_reg_desc_get_fmr(struct ib_conn *ib_conn)
125 {
126         struct iser_fr_pool *fr_pool = &ib_conn->fr_pool;
127
128         return list_first_entry(&fr_pool->list,
129                                 struct iser_fr_desc, list);
130 }
131
132 void
133 iser_reg_desc_put_fmr(struct ib_conn *ib_conn,
134                       struct iser_fr_desc *desc)
135 {
136 }
137
138 static void iser_data_buf_dump(struct iser_data_buf *data,
139                                struct ib_device *ibdev)
140 {
141         struct scatterlist *sg;
142         int i;
143
144         for_each_sg(data->sg, sg, data->dma_nents, i)
145                 iser_dbg("sg[%d] dma_addr:0x%lX page:0x%p "
146                          "off:0x%x sz:0x%x dma_len:0x%x\n",
147                          i, (unsigned long)ib_sg_dma_address(ibdev, sg),
148                          sg_page(sg), sg->offset,
149                          sg->length, ib_sg_dma_len(ibdev, sg));
150 }
151
152 static void iser_dump_page_vec(struct iser_page_vec *page_vec)
153 {
154         int i;
155
156         iser_err("page vec npages %d data length %d\n",
157                  page_vec->npages, page_vec->fake_mr.length);
158         for (i = 0; i < page_vec->npages; i++)
159                 iser_err("vec[%d]: %llx\n", i, page_vec->pages[i]);
160 }
161
162 int iser_dma_map_task_data(struct iscsi_iser_task *iser_task,
163                             struct iser_data_buf *data,
164                             enum iser_data_dir iser_dir,
165                             enum dma_data_direction dma_dir)
166 {
167         struct ib_device *dev;
168
169         iser_task->dir[iser_dir] = 1;
170         dev = iser_task->iser_conn->ib_conn.device->ib_device;
171
172         data->dma_nents = ib_dma_map_sg(dev, data->sg, data->size, dma_dir);
173         if (data->dma_nents == 0) {
174                 iser_err("dma_map_sg failed!!!\n");
175                 return -EINVAL;
176         }
177         return 0;
178 }
179
180 void iser_dma_unmap_task_data(struct iscsi_iser_task *iser_task,
181                               struct iser_data_buf *data,
182                               enum dma_data_direction dir)
183 {
184         struct ib_device *dev;
185
186         dev = iser_task->iser_conn->ib_conn.device->ib_device;
187         ib_dma_unmap_sg(dev, data->sg, data->size, dir);
188 }
189
190 static int
191 iser_reg_dma(struct iser_device *device, struct iser_data_buf *mem,
192              struct iser_mem_reg *reg)
193 {
194         struct scatterlist *sg = mem->sg;
195
196         reg->sge.lkey = device->pd->local_dma_lkey;
197         reg->rkey = device->mr->rkey;
198         reg->sge.addr = ib_sg_dma_address(device->ib_device, &sg[0]);
199         reg->sge.length = ib_sg_dma_len(device->ib_device, &sg[0]);
200
201         iser_dbg("Single DMA entry: lkey=0x%x, rkey=0x%x, addr=0x%llx,"
202                  " length=0x%x\n", reg->sge.lkey, reg->rkey,
203                  reg->sge.addr, reg->sge.length);
204
205         return 0;
206 }
207
208 static int iser_set_page(struct ib_mr *mr, u64 addr)
209 {
210         struct iser_page_vec *page_vec =
211                 container_of(mr, struct iser_page_vec, fake_mr);
212
213         page_vec->pages[page_vec->npages++] = addr;
214
215         return 0;
216 }
217
218 static
219 int iser_fast_reg_fmr(struct iscsi_iser_task *iser_task,
220                       struct iser_data_buf *mem,
221                       struct iser_reg_resources *rsc,
222                       struct iser_mem_reg *reg)
223 {
224         struct ib_conn *ib_conn = &iser_task->iser_conn->ib_conn;
225         struct iser_device *device = ib_conn->device;
226         struct iser_page_vec *page_vec = rsc->page_vec;
227         struct ib_fmr_pool *fmr_pool = rsc->fmr_pool;
228         struct ib_pool_fmr *fmr;
229         int ret, plen;
230
231         page_vec->npages = 0;
232         page_vec->fake_mr.page_size = SIZE_4K;
233         plen = ib_sg_to_pages(&page_vec->fake_mr, mem->sg,
234                               mem->size, iser_set_page);
235         if (unlikely(plen < mem->size)) {
236                 iser_err("page vec too short to hold this SG\n");
237                 iser_data_buf_dump(mem, device->ib_device);
238                 iser_dump_page_vec(page_vec);
239                 return -EINVAL;
240         }
241
242         fmr  = ib_fmr_pool_map_phys(fmr_pool, page_vec->pages,
243                                     page_vec->npages, page_vec->pages[0]);
244         if (IS_ERR(fmr)) {
245                 ret = PTR_ERR(fmr);
246                 iser_err("ib_fmr_pool_map_phys failed: %d\n", ret);
247                 return ret;
248         }
249
250         reg->sge.lkey = fmr->fmr->lkey;
251         reg->rkey = fmr->fmr->rkey;
252         reg->sge.addr = page_vec->fake_mr.iova;
253         reg->sge.length = page_vec->fake_mr.length;
254         reg->mem_h = fmr;
255
256         iser_dbg("fmr reg: lkey=0x%x, rkey=0x%x, addr=0x%llx,"
257                  " length=0x%x\n", reg->sge.lkey, reg->rkey,
258                  reg->sge.addr, reg->sge.length);
259
260         return 0;
261 }
262
263 /**
264  * Unregister (previosuly registered using FMR) memory.
265  * If memory is non-FMR does nothing.
266  */
267 void iser_unreg_mem_fmr(struct iscsi_iser_task *iser_task,
268                         enum iser_data_dir cmd_dir)
269 {
270         struct iser_mem_reg *reg = &iser_task->rdma_reg[cmd_dir];
271         int ret;
272
273         if (!reg->mem_h)
274                 return;
275
276         iser_dbg("PHYSICAL Mem.Unregister mem_h %p\n", reg->mem_h);
277
278         ret = ib_fmr_pool_unmap((struct ib_pool_fmr *)reg->mem_h);
279         if (ret)
280                 iser_err("ib_fmr_pool_unmap failed %d\n", ret);
281
282         reg->mem_h = NULL;
283 }
284
285 void iser_unreg_mem_fastreg(struct iscsi_iser_task *iser_task,
286                             enum iser_data_dir cmd_dir)
287 {
288         struct iser_device *device = iser_task->iser_conn->ib_conn.device;
289         struct iser_mem_reg *reg = &iser_task->rdma_reg[cmd_dir];
290
291         if (!reg->mem_h)
292                 return;
293
294         device->reg_ops->reg_desc_put(&iser_task->iser_conn->ib_conn,
295                                      reg->mem_h);
296         reg->mem_h = NULL;
297 }
298
299 static void
300 iser_set_dif_domain(struct scsi_cmnd *sc, struct ib_sig_attrs *sig_attrs,
301                     struct ib_sig_domain *domain)
302 {
303         domain->sig_type = IB_SIG_TYPE_T10_DIF;
304         domain->sig.dif.pi_interval = scsi_prot_interval(sc);
305         domain->sig.dif.ref_tag = scsi_prot_ref_tag(sc);
306         /*
307          * At the moment we hard code those, but in the future
308          * we will take them from sc.
309          */
310         domain->sig.dif.apptag_check_mask = 0xffff;
311         domain->sig.dif.app_escape = true;
312         domain->sig.dif.ref_escape = true;
313         if (sc->prot_flags & SCSI_PROT_REF_INCREMENT)
314                 domain->sig.dif.ref_remap = true;
315 };
316
317 static int
318 iser_set_sig_attrs(struct scsi_cmnd *sc, struct ib_sig_attrs *sig_attrs)
319 {
320         switch (scsi_get_prot_op(sc)) {
321         case SCSI_PROT_WRITE_INSERT:
322         case SCSI_PROT_READ_STRIP:
323                 sig_attrs->mem.sig_type = IB_SIG_TYPE_NONE;
324                 iser_set_dif_domain(sc, sig_attrs, &sig_attrs->wire);
325                 sig_attrs->wire.sig.dif.bg_type = IB_T10DIF_CRC;
326                 break;
327         case SCSI_PROT_READ_INSERT:
328         case SCSI_PROT_WRITE_STRIP:
329                 sig_attrs->wire.sig_type = IB_SIG_TYPE_NONE;
330                 iser_set_dif_domain(sc, sig_attrs, &sig_attrs->mem);
331                 sig_attrs->mem.sig.dif.bg_type = sc->prot_flags & SCSI_PROT_IP_CHECKSUM ?
332                                                 IB_T10DIF_CSUM : IB_T10DIF_CRC;
333                 break;
334         case SCSI_PROT_READ_PASS:
335         case SCSI_PROT_WRITE_PASS:
336                 iser_set_dif_domain(sc, sig_attrs, &sig_attrs->wire);
337                 sig_attrs->wire.sig.dif.bg_type = IB_T10DIF_CRC;
338                 iser_set_dif_domain(sc, sig_attrs, &sig_attrs->mem);
339                 sig_attrs->mem.sig.dif.bg_type = sc->prot_flags & SCSI_PROT_IP_CHECKSUM ?
340                                                 IB_T10DIF_CSUM : IB_T10DIF_CRC;
341                 break;
342         default:
343                 iser_err("Unsupported PI operation %d\n",
344                          scsi_get_prot_op(sc));
345                 return -EINVAL;
346         }
347
348         return 0;
349 }
350
351 static inline void
352 iser_set_prot_checks(struct scsi_cmnd *sc, u8 *mask)
353 {
354         *mask = 0;
355         if (sc->prot_flags & SCSI_PROT_REF_CHECK)
356                 *mask |= ISER_CHECK_REFTAG;
357         if (sc->prot_flags & SCSI_PROT_GUARD_CHECK)
358                 *mask |= ISER_CHECK_GUARD;
359 }
360
361 static void
362 iser_inv_rkey(struct ib_send_wr *inv_wr,
363               struct ib_mr *mr,
364               struct ib_cqe *cqe)
365 {
366         u32 rkey;
367
368         inv_wr->opcode = IB_WR_LOCAL_INV;
369         inv_wr->wr_cqe = cqe;
370         inv_wr->ex.invalidate_rkey = mr->rkey;
371         inv_wr->send_flags = 0;
372         inv_wr->num_sge = 0;
373
374         rkey = ib_inc_rkey(mr->rkey);
375         ib_update_fast_reg_key(mr, rkey);
376 }
377
378 static int
379 iser_reg_sig_mr(struct iscsi_iser_task *iser_task,
380                 struct iser_pi_context *pi_ctx,
381                 struct iser_mem_reg *data_reg,
382                 struct iser_mem_reg *prot_reg,
383                 struct iser_mem_reg *sig_reg)
384 {
385         struct iser_tx_desc *tx_desc = &iser_task->desc;
386         struct ib_sig_attrs *sig_attrs = &tx_desc->sig_attrs;
387         struct ib_cqe *cqe = &iser_task->iser_conn->ib_conn.reg_cqe;
388         struct ib_sig_handover_wr *wr;
389         int ret;
390
391         memset(sig_attrs, 0, sizeof(*sig_attrs));
392         ret = iser_set_sig_attrs(iser_task->sc, sig_attrs);
393         if (ret)
394                 goto err;
395
396         iser_set_prot_checks(iser_task->sc, &sig_attrs->check_mask);
397
398         if (!pi_ctx->sig_mr_valid)
399                 iser_inv_rkey(iser_tx_next_wr(tx_desc), pi_ctx->sig_mr, cqe);
400
401         wr = sig_handover_wr(iser_tx_next_wr(tx_desc));
402         wr->wr.opcode = IB_WR_REG_SIG_MR;
403         wr->wr.wr_cqe = cqe;
404         wr->wr.sg_list = &data_reg->sge;
405         wr->wr.num_sge = 1;
406         wr->wr.send_flags = 0;
407         wr->sig_attrs = sig_attrs;
408         wr->sig_mr = pi_ctx->sig_mr;
409         if (scsi_prot_sg_count(iser_task->sc))
410                 wr->prot = &prot_reg->sge;
411         else
412                 wr->prot = NULL;
413         wr->access_flags = IB_ACCESS_LOCAL_WRITE |
414                            IB_ACCESS_REMOTE_READ |
415                            IB_ACCESS_REMOTE_WRITE;
416         pi_ctx->sig_mr_valid = 0;
417
418         sig_reg->sge.lkey = pi_ctx->sig_mr->lkey;
419         sig_reg->rkey = pi_ctx->sig_mr->rkey;
420         sig_reg->sge.addr = 0;
421         sig_reg->sge.length = scsi_transfer_length(iser_task->sc);
422
423         iser_dbg("lkey=0x%x rkey=0x%x addr=0x%llx length=%u\n",
424                  sig_reg->sge.lkey, sig_reg->rkey, sig_reg->sge.addr,
425                  sig_reg->sge.length);
426 err:
427         return ret;
428 }
429
430 static int iser_fast_reg_mr(struct iscsi_iser_task *iser_task,
431                             struct iser_data_buf *mem,
432                             struct iser_reg_resources *rsc,
433                             struct iser_mem_reg *reg)
434 {
435         struct iser_tx_desc *tx_desc = &iser_task->desc;
436         struct ib_cqe *cqe = &iser_task->iser_conn->ib_conn.reg_cqe;
437         struct ib_mr *mr = rsc->mr;
438         struct ib_reg_wr *wr;
439         int n;
440
441         if (!rsc->mr_valid)
442                 iser_inv_rkey(iser_tx_next_wr(tx_desc), mr, cqe);
443
444         n = ib_map_mr_sg(mr, mem->sg, mem->size, SIZE_4K);
445         if (unlikely(n != mem->size)) {
446                 iser_err("failed to map sg (%d/%d)\n",
447                          n, mem->size);
448                 return n < 0 ? n : -EINVAL;
449         }
450
451         wr = reg_wr(iser_tx_next_wr(tx_desc));
452         wr->wr.opcode = IB_WR_REG_MR;
453         wr->wr.wr_cqe = cqe;
454         wr->wr.send_flags = 0;
455         wr->wr.num_sge = 0;
456         wr->mr = mr;
457         wr->key = mr->rkey;
458         wr->access = IB_ACCESS_LOCAL_WRITE  |
459                      IB_ACCESS_REMOTE_WRITE |
460                      IB_ACCESS_REMOTE_READ;
461
462         rsc->mr_valid = 0;
463
464         reg->sge.lkey = mr->lkey;
465         reg->rkey = mr->rkey;
466         reg->sge.addr = mr->iova;
467         reg->sge.length = mr->length;
468
469         iser_dbg("lkey=0x%x rkey=0x%x addr=0x%llx length=0x%x\n",
470                  reg->sge.lkey, reg->rkey, reg->sge.addr, reg->sge.length);
471
472         return 0;
473 }
474
475 static int
476 iser_reg_prot_sg(struct iscsi_iser_task *task,
477                  struct iser_data_buf *mem,
478                  struct iser_fr_desc *desc,
479                  bool use_dma_key,
480                  struct iser_mem_reg *reg)
481 {
482         struct iser_device *device = task->iser_conn->ib_conn.device;
483
484         if (use_dma_key)
485                 return iser_reg_dma(device, mem, reg);
486
487         return device->reg_ops->reg_mem(task, mem, &desc->pi_ctx->rsc, reg);
488 }
489
490 static int
491 iser_reg_data_sg(struct iscsi_iser_task *task,
492                  struct iser_data_buf *mem,
493                  struct iser_fr_desc *desc,
494                  bool use_dma_key,
495                  struct iser_mem_reg *reg)
496 {
497         struct iser_device *device = task->iser_conn->ib_conn.device;
498
499         if (use_dma_key)
500                 return iser_reg_dma(device, mem, reg);
501
502         return device->reg_ops->reg_mem(task, mem, &desc->rsc, reg);
503 }
504
505 int iser_reg_rdma_mem(struct iscsi_iser_task *task,
506                       enum iser_data_dir dir)
507 {
508         struct ib_conn *ib_conn = &task->iser_conn->ib_conn;
509         struct iser_device *device = ib_conn->device;
510         struct iser_data_buf *mem = &task->data[dir];
511         struct iser_mem_reg *reg = &task->rdma_reg[dir];
512         struct iser_mem_reg *data_reg;
513         struct iser_fr_desc *desc = NULL;
514         bool use_dma_key;
515         int err;
516
517         use_dma_key = (mem->dma_nents == 1 && !iser_always_reg &&
518                        scsi_get_prot_op(task->sc) == SCSI_PROT_NORMAL);
519
520         if (!use_dma_key) {
521                 desc = device->reg_ops->reg_desc_get(ib_conn);
522                 reg->mem_h = desc;
523         }
524
525         if (scsi_get_prot_op(task->sc) == SCSI_PROT_NORMAL)
526                 data_reg = reg;
527         else
528                 data_reg = &task->desc.data_reg;
529
530         err = iser_reg_data_sg(task, mem, desc, use_dma_key, data_reg);
531         if (unlikely(err))
532                 goto err_reg;
533
534         if (scsi_get_prot_op(task->sc) != SCSI_PROT_NORMAL) {
535                 struct iser_mem_reg *prot_reg = &task->desc.prot_reg;
536
537                 if (scsi_prot_sg_count(task->sc)) {
538                         mem = &task->prot[dir];
539                         err = iser_reg_prot_sg(task, mem, desc,
540                                                use_dma_key, prot_reg);
541                         if (unlikely(err))
542                                 goto err_reg;
543                 }
544
545                 err = iser_reg_sig_mr(task, desc->pi_ctx, data_reg,
546                                       prot_reg, reg);
547                 if (unlikely(err))
548                         goto err_reg;
549
550                 desc->pi_ctx->sig_protected = 1;
551         }
552
553         return 0;
554
555 err_reg:
556         if (desc)
557                 device->reg_ops->reg_desc_put(ib_conn, desc);
558
559         return err;
560 }
561
562 void iser_unreg_rdma_mem(struct iscsi_iser_task *task,
563                          enum iser_data_dir dir)
564 {
565         struct iser_device *device = task->iser_conn->ib_conn.device;
566
567         device->reg_ops->unreg_mem(task, dir);
568 }