0a798498b303d3b5e8eaa99c07f70933a175b5f9
[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         /*
198          * FIXME: rework the registration code path to differentiate
199          * rkey/lkey use cases
200          */
201         reg->rkey = device->mr ? device->mr->rkey : 0;
202         reg->sge.addr = ib_sg_dma_address(device->ib_device, &sg[0]);
203         reg->sge.length = ib_sg_dma_len(device->ib_device, &sg[0]);
204
205         iser_dbg("Single DMA entry: lkey=0x%x, rkey=0x%x, addr=0x%llx,"
206                  " length=0x%x\n", reg->sge.lkey, reg->rkey,
207                  reg->sge.addr, reg->sge.length);
208
209         return 0;
210 }
211
212 static int iser_set_page(struct ib_mr *mr, u64 addr)
213 {
214         struct iser_page_vec *page_vec =
215                 container_of(mr, struct iser_page_vec, fake_mr);
216
217         page_vec->pages[page_vec->npages++] = addr;
218
219         return 0;
220 }
221
222 static
223 int iser_fast_reg_fmr(struct iscsi_iser_task *iser_task,
224                       struct iser_data_buf *mem,
225                       struct iser_reg_resources *rsc,
226                       struct iser_mem_reg *reg)
227 {
228         struct ib_conn *ib_conn = &iser_task->iser_conn->ib_conn;
229         struct iser_device *device = ib_conn->device;
230         struct iser_page_vec *page_vec = rsc->page_vec;
231         struct ib_fmr_pool *fmr_pool = rsc->fmr_pool;
232         struct ib_pool_fmr *fmr;
233         int ret, plen;
234
235         page_vec->npages = 0;
236         page_vec->fake_mr.page_size = SIZE_4K;
237         plen = ib_sg_to_pages(&page_vec->fake_mr, mem->sg,
238                               mem->size, iser_set_page);
239         if (unlikely(plen < mem->size)) {
240                 iser_err("page vec too short to hold this SG\n");
241                 iser_data_buf_dump(mem, device->ib_device);
242                 iser_dump_page_vec(page_vec);
243                 return -EINVAL;
244         }
245
246         fmr  = ib_fmr_pool_map_phys(fmr_pool, page_vec->pages,
247                                     page_vec->npages, page_vec->pages[0]);
248         if (IS_ERR(fmr)) {
249                 ret = PTR_ERR(fmr);
250                 iser_err("ib_fmr_pool_map_phys failed: %d\n", ret);
251                 return ret;
252         }
253
254         reg->sge.lkey = fmr->fmr->lkey;
255         reg->rkey = fmr->fmr->rkey;
256         reg->sge.addr = page_vec->fake_mr.iova;
257         reg->sge.length = page_vec->fake_mr.length;
258         reg->mem_h = fmr;
259
260         iser_dbg("fmr reg: lkey=0x%x, rkey=0x%x, addr=0x%llx,"
261                  " length=0x%x\n", reg->sge.lkey, reg->rkey,
262                  reg->sge.addr, reg->sge.length);
263
264         return 0;
265 }
266
267 /**
268  * Unregister (previosuly registered using FMR) memory.
269  * If memory is non-FMR does nothing.
270  */
271 void iser_unreg_mem_fmr(struct iscsi_iser_task *iser_task,
272                         enum iser_data_dir cmd_dir)
273 {
274         struct iser_mem_reg *reg = &iser_task->rdma_reg[cmd_dir];
275         int ret;
276
277         if (!reg->mem_h)
278                 return;
279
280         iser_dbg("PHYSICAL Mem.Unregister mem_h %p\n", reg->mem_h);
281
282         ret = ib_fmr_pool_unmap((struct ib_pool_fmr *)reg->mem_h);
283         if (ret)
284                 iser_err("ib_fmr_pool_unmap failed %d\n", ret);
285
286         reg->mem_h = NULL;
287 }
288
289 void iser_unreg_mem_fastreg(struct iscsi_iser_task *iser_task,
290                             enum iser_data_dir cmd_dir)
291 {
292         struct iser_device *device = iser_task->iser_conn->ib_conn.device;
293         struct iser_mem_reg *reg = &iser_task->rdma_reg[cmd_dir];
294
295         if (!reg->mem_h)
296                 return;
297
298         device->reg_ops->reg_desc_put(&iser_task->iser_conn->ib_conn,
299                                      reg->mem_h);
300         reg->mem_h = NULL;
301 }
302
303 static void
304 iser_set_dif_domain(struct scsi_cmnd *sc, struct ib_sig_attrs *sig_attrs,
305                     struct ib_sig_domain *domain)
306 {
307         domain->sig_type = IB_SIG_TYPE_T10_DIF;
308         domain->sig.dif.pi_interval = scsi_prot_interval(sc);
309         domain->sig.dif.ref_tag = scsi_prot_ref_tag(sc);
310         /*
311          * At the moment we hard code those, but in the future
312          * we will take them from sc.
313          */
314         domain->sig.dif.apptag_check_mask = 0xffff;
315         domain->sig.dif.app_escape = true;
316         domain->sig.dif.ref_escape = true;
317         if (sc->prot_flags & SCSI_PROT_REF_INCREMENT)
318                 domain->sig.dif.ref_remap = true;
319 };
320
321 static int
322 iser_set_sig_attrs(struct scsi_cmnd *sc, struct ib_sig_attrs *sig_attrs)
323 {
324         switch (scsi_get_prot_op(sc)) {
325         case SCSI_PROT_WRITE_INSERT:
326         case SCSI_PROT_READ_STRIP:
327                 sig_attrs->mem.sig_type = IB_SIG_TYPE_NONE;
328                 iser_set_dif_domain(sc, sig_attrs, &sig_attrs->wire);
329                 sig_attrs->wire.sig.dif.bg_type = IB_T10DIF_CRC;
330                 break;
331         case SCSI_PROT_READ_INSERT:
332         case SCSI_PROT_WRITE_STRIP:
333                 sig_attrs->wire.sig_type = IB_SIG_TYPE_NONE;
334                 iser_set_dif_domain(sc, sig_attrs, &sig_attrs->mem);
335                 sig_attrs->mem.sig.dif.bg_type = sc->prot_flags & SCSI_PROT_IP_CHECKSUM ?
336                                                 IB_T10DIF_CSUM : IB_T10DIF_CRC;
337                 break;
338         case SCSI_PROT_READ_PASS:
339         case SCSI_PROT_WRITE_PASS:
340                 iser_set_dif_domain(sc, sig_attrs, &sig_attrs->wire);
341                 sig_attrs->wire.sig.dif.bg_type = IB_T10DIF_CRC;
342                 iser_set_dif_domain(sc, sig_attrs, &sig_attrs->mem);
343                 sig_attrs->mem.sig.dif.bg_type = sc->prot_flags & SCSI_PROT_IP_CHECKSUM ?
344                                                 IB_T10DIF_CSUM : IB_T10DIF_CRC;
345                 break;
346         default:
347                 iser_err("Unsupported PI operation %d\n",
348                          scsi_get_prot_op(sc));
349                 return -EINVAL;
350         }
351
352         return 0;
353 }
354
355 static inline void
356 iser_set_prot_checks(struct scsi_cmnd *sc, u8 *mask)
357 {
358         *mask = 0;
359         if (sc->prot_flags & SCSI_PROT_REF_CHECK)
360                 *mask |= ISER_CHECK_REFTAG;
361         if (sc->prot_flags & SCSI_PROT_GUARD_CHECK)
362                 *mask |= ISER_CHECK_GUARD;
363 }
364
365 static void
366 iser_inv_rkey(struct ib_send_wr *inv_wr,
367               struct ib_mr *mr,
368               struct ib_cqe *cqe)
369 {
370         u32 rkey;
371
372         inv_wr->opcode = IB_WR_LOCAL_INV;
373         inv_wr->wr_cqe = cqe;
374         inv_wr->ex.invalidate_rkey = mr->rkey;
375         inv_wr->send_flags = 0;
376         inv_wr->num_sge = 0;
377
378         rkey = ib_inc_rkey(mr->rkey);
379         ib_update_fast_reg_key(mr, rkey);
380 }
381
382 static int
383 iser_reg_sig_mr(struct iscsi_iser_task *iser_task,
384                 struct iser_pi_context *pi_ctx,
385                 struct iser_mem_reg *data_reg,
386                 struct iser_mem_reg *prot_reg,
387                 struct iser_mem_reg *sig_reg)
388 {
389         struct iser_tx_desc *tx_desc = &iser_task->desc;
390         struct ib_sig_attrs *sig_attrs = &tx_desc->sig_attrs;
391         struct ib_cqe *cqe = &iser_task->iser_conn->ib_conn.reg_cqe;
392         struct ib_sig_handover_wr *wr;
393         int ret;
394
395         memset(sig_attrs, 0, sizeof(*sig_attrs));
396         ret = iser_set_sig_attrs(iser_task->sc, sig_attrs);
397         if (ret)
398                 goto err;
399
400         iser_set_prot_checks(iser_task->sc, &sig_attrs->check_mask);
401
402         if (pi_ctx->sig_mr_valid)
403                 iser_inv_rkey(iser_tx_next_wr(tx_desc), pi_ctx->sig_mr, cqe);
404
405         wr = sig_handover_wr(iser_tx_next_wr(tx_desc));
406         wr->wr.opcode = IB_WR_REG_SIG_MR;
407         wr->wr.wr_cqe = cqe;
408         wr->wr.sg_list = &data_reg->sge;
409         wr->wr.num_sge = 1;
410         wr->wr.send_flags = 0;
411         wr->sig_attrs = sig_attrs;
412         wr->sig_mr = pi_ctx->sig_mr;
413         if (scsi_prot_sg_count(iser_task->sc))
414                 wr->prot = &prot_reg->sge;
415         else
416                 wr->prot = NULL;
417         wr->access_flags = IB_ACCESS_LOCAL_WRITE |
418                            IB_ACCESS_REMOTE_READ |
419                            IB_ACCESS_REMOTE_WRITE;
420         pi_ctx->sig_mr_valid = 1;
421
422         sig_reg->sge.lkey = pi_ctx->sig_mr->lkey;
423         sig_reg->rkey = pi_ctx->sig_mr->rkey;
424         sig_reg->sge.addr = 0;
425         sig_reg->sge.length = scsi_transfer_length(iser_task->sc);
426
427         iser_dbg("lkey=0x%x rkey=0x%x addr=0x%llx length=%u\n",
428                  sig_reg->sge.lkey, sig_reg->rkey, sig_reg->sge.addr,
429                  sig_reg->sge.length);
430 err:
431         return ret;
432 }
433
434 static int iser_fast_reg_mr(struct iscsi_iser_task *iser_task,
435                             struct iser_data_buf *mem,
436                             struct iser_reg_resources *rsc,
437                             struct iser_mem_reg *reg)
438 {
439         struct iser_tx_desc *tx_desc = &iser_task->desc;
440         struct ib_cqe *cqe = &iser_task->iser_conn->ib_conn.reg_cqe;
441         struct ib_mr *mr = rsc->mr;
442         struct ib_reg_wr *wr;
443         int n;
444
445         if (rsc->mr_valid)
446                 iser_inv_rkey(iser_tx_next_wr(tx_desc), mr, cqe);
447
448         n = ib_map_mr_sg(mr, mem->sg, mem->size, SIZE_4K);
449         if (unlikely(n != mem->size)) {
450                 iser_err("failed to map sg (%d/%d)\n",
451                          n, mem->size);
452                 return n < 0 ? n : -EINVAL;
453         }
454
455         wr = reg_wr(iser_tx_next_wr(tx_desc));
456         wr->wr.opcode = IB_WR_REG_MR;
457         wr->wr.wr_cqe = cqe;
458         wr->wr.send_flags = 0;
459         wr->wr.num_sge = 0;
460         wr->mr = mr;
461         wr->key = mr->rkey;
462         wr->access = IB_ACCESS_LOCAL_WRITE  |
463                      IB_ACCESS_REMOTE_WRITE |
464                      IB_ACCESS_REMOTE_READ;
465
466         rsc->mr_valid = 1;
467
468         reg->sge.lkey = mr->lkey;
469         reg->rkey = mr->rkey;
470         reg->sge.addr = mr->iova;
471         reg->sge.length = mr->length;
472
473         iser_dbg("lkey=0x%x rkey=0x%x addr=0x%llx length=0x%x\n",
474                  reg->sge.lkey, reg->rkey, reg->sge.addr, reg->sge.length);
475
476         return 0;
477 }
478
479 static int
480 iser_reg_prot_sg(struct iscsi_iser_task *task,
481                  struct iser_data_buf *mem,
482                  struct iser_fr_desc *desc,
483                  bool use_dma_key,
484                  struct iser_mem_reg *reg)
485 {
486         struct iser_device *device = task->iser_conn->ib_conn.device;
487
488         if (use_dma_key)
489                 return iser_reg_dma(device, mem, reg);
490
491         return device->reg_ops->reg_mem(task, mem, &desc->pi_ctx->rsc, reg);
492 }
493
494 static int
495 iser_reg_data_sg(struct iscsi_iser_task *task,
496                  struct iser_data_buf *mem,
497                  struct iser_fr_desc *desc,
498                  bool use_dma_key,
499                  struct iser_mem_reg *reg)
500 {
501         struct iser_device *device = task->iser_conn->ib_conn.device;
502
503         if (use_dma_key)
504                 return iser_reg_dma(device, mem, reg);
505
506         return device->reg_ops->reg_mem(task, mem, &desc->rsc, reg);
507 }
508
509 int iser_reg_rdma_mem(struct iscsi_iser_task *task,
510                       enum iser_data_dir dir,
511                       bool all_imm)
512 {
513         struct ib_conn *ib_conn = &task->iser_conn->ib_conn;
514         struct iser_device *device = ib_conn->device;
515         struct iser_data_buf *mem = &task->data[dir];
516         struct iser_mem_reg *reg = &task->rdma_reg[dir];
517         struct iser_mem_reg *data_reg;
518         struct iser_fr_desc *desc = NULL;
519         bool use_dma_key;
520         int err;
521
522         use_dma_key = mem->dma_nents == 1 && (all_imm || !iser_always_reg) &&
523                       scsi_get_prot_op(task->sc) == SCSI_PROT_NORMAL;
524
525         if (!use_dma_key) {
526                 desc = device->reg_ops->reg_desc_get(ib_conn);
527                 reg->mem_h = desc;
528         }
529
530         if (scsi_get_prot_op(task->sc) == SCSI_PROT_NORMAL)
531                 data_reg = reg;
532         else
533                 data_reg = &task->desc.data_reg;
534
535         err = iser_reg_data_sg(task, mem, desc, use_dma_key, data_reg);
536         if (unlikely(err))
537                 goto err_reg;
538
539         if (scsi_get_prot_op(task->sc) != SCSI_PROT_NORMAL) {
540                 struct iser_mem_reg *prot_reg = &task->desc.prot_reg;
541
542                 if (scsi_prot_sg_count(task->sc)) {
543                         mem = &task->prot[dir];
544                         err = iser_reg_prot_sg(task, mem, desc,
545                                                use_dma_key, prot_reg);
546                         if (unlikely(err))
547                                 goto err_reg;
548                 }
549
550                 err = iser_reg_sig_mr(task, desc->pi_ctx, data_reg,
551                                       prot_reg, reg);
552                 if (unlikely(err))
553                         goto err_reg;
554
555                 desc->pi_ctx->sig_protected = 1;
556         }
557
558         return 0;
559
560 err_reg:
561         if (desc)
562                 device->reg_ops->reg_desc_put(ib_conn, desc);
563
564         return err;
565 }
566
567 void iser_unreg_rdma_mem(struct iscsi_iser_task *task,
568                          enum iser_data_dir dir)
569 {
570         struct iser_device *device = task->iser_conn->ib_conn.device;
571
572         device->reg_ops->unreg_mem(task, dir);
573 }