Merge branch 'for-next' of git://git.kernel.org/pub/scm/linux/kernel/git/nab/target...
[cascardo/linux.git] / drivers / target / target_core_xcopy.c
1 /*******************************************************************************
2  * Filename: target_core_xcopy.c
3  *
4  * This file contains support for SPC-4 Extended-Copy offload with generic
5  * TCM backends.
6  *
7  * Copyright (c) 2011-2013 Datera, Inc. All rights reserved.
8  *
9  * Author:
10  * Nicholas A. Bellinger <nab@daterainc.com>
11  *
12  * This program is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation; either version 2 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  *
22  ******************************************************************************/
23
24 #include <linux/slab.h>
25 #include <linux/spinlock.h>
26 #include <linux/list.h>
27 #include <linux/configfs.h>
28 #include <scsi/scsi_proto.h>
29 #include <asm/unaligned.h>
30
31 #include <target/target_core_base.h>
32 #include <target/target_core_backend.h>
33 #include <target/target_core_fabric.h>
34
35 #include "target_core_internal.h"
36 #include "target_core_pr.h"
37 #include "target_core_ua.h"
38 #include "target_core_xcopy.h"
39
40 static struct workqueue_struct *xcopy_wq = NULL;
41
42 static int target_xcopy_gen_naa_ieee(struct se_device *dev, unsigned char *buf)
43 {
44         int off = 0;
45
46         buf[off++] = (0x6 << 4);
47         buf[off++] = 0x01;
48         buf[off++] = 0x40;
49         buf[off] = (0x5 << 4);
50
51         spc_parse_naa_6h_vendor_specific(dev, &buf[off]);
52         return 0;
53 }
54
55 static int target_xcopy_locate_se_dev_e4(struct se_cmd *se_cmd, struct xcopy_op *xop,
56                                         bool src)
57 {
58         struct se_device *se_dev;
59         unsigned char tmp_dev_wwn[XCOPY_NAA_IEEE_REGEX_LEN], *dev_wwn;
60         int rc;
61
62         if (src)
63                 dev_wwn = &xop->dst_tid_wwn[0];
64         else
65                 dev_wwn = &xop->src_tid_wwn[0];
66
67         mutex_lock(&g_device_mutex);
68         list_for_each_entry(se_dev, &g_device_list, g_dev_node) {
69
70                 if (!se_dev->dev_attrib.emulate_3pc)
71                         continue;
72
73                 memset(&tmp_dev_wwn[0], 0, XCOPY_NAA_IEEE_REGEX_LEN);
74                 target_xcopy_gen_naa_ieee(se_dev, &tmp_dev_wwn[0]);
75
76                 rc = memcmp(&tmp_dev_wwn[0], dev_wwn, XCOPY_NAA_IEEE_REGEX_LEN);
77                 if (rc != 0)
78                         continue;
79
80                 if (src) {
81                         xop->dst_dev = se_dev;
82                         pr_debug("XCOPY 0xe4: Setting xop->dst_dev: %p from located"
83                                 " se_dev\n", xop->dst_dev);
84                 } else {
85                         xop->src_dev = se_dev;
86                         pr_debug("XCOPY 0xe4: Setting xop->src_dev: %p from located"
87                                 " se_dev\n", xop->src_dev);
88                 }
89
90                 rc = target_depend_item(&se_dev->dev_group.cg_item);
91                 if (rc != 0) {
92                         pr_err("configfs_depend_item attempt failed:"
93                                 " %d for se_dev: %p\n", rc, se_dev);
94                         mutex_unlock(&g_device_mutex);
95                         return rc;
96                 }
97
98                 pr_debug("Called configfs_depend_item for se_dev: %p"
99                         " se_dev->se_dev_group: %p\n", se_dev,
100                         &se_dev->dev_group);
101
102                 mutex_unlock(&g_device_mutex);
103                 return 0;
104         }
105         mutex_unlock(&g_device_mutex);
106
107         pr_err("Unable to locate 0xe4 descriptor for EXTENDED_COPY\n");
108         return -EINVAL;
109 }
110
111 static int target_xcopy_parse_tiddesc_e4(struct se_cmd *se_cmd, struct xcopy_op *xop,
112                                 unsigned char *p, bool src)
113 {
114         unsigned char *desc = p;
115         unsigned short ript;
116         u8 desig_len;
117         /*
118          * Extract RELATIVE INITIATOR PORT IDENTIFIER
119          */
120         ript = get_unaligned_be16(&desc[2]);
121         pr_debug("XCOPY 0xe4: RELATIVE INITIATOR PORT IDENTIFIER: %hu\n", ript);
122         /*
123          * Check for supported code set, association, and designator type
124          */
125         if ((desc[4] & 0x0f) != 0x1) {
126                 pr_err("XCOPY 0xe4: code set of non binary type not supported\n");
127                 return -EINVAL;
128         }
129         if ((desc[5] & 0x30) != 0x00) {
130                 pr_err("XCOPY 0xe4: association other than LUN not supported\n");
131                 return -EINVAL;
132         }
133         if ((desc[5] & 0x0f) != 0x3) {
134                 pr_err("XCOPY 0xe4: designator type unsupported: 0x%02x\n",
135                                 (desc[5] & 0x0f));
136                 return -EINVAL;
137         }
138         /*
139          * Check for matching 16 byte length for NAA IEEE Registered Extended
140          * Assigned designator
141          */
142         desig_len = desc[7];
143         if (desig_len != 16) {
144                 pr_err("XCOPY 0xe4: invalid desig_len: %d\n", (int)desig_len);
145                 return -EINVAL;
146         }
147         pr_debug("XCOPY 0xe4: desig_len: %d\n", (int)desig_len);
148         /*
149          * Check for NAA IEEE Registered Extended Assigned header..
150          */
151         if ((desc[8] & 0xf0) != 0x60) {
152                 pr_err("XCOPY 0xe4: Unsupported DESIGNATOR TYPE: 0x%02x\n",
153                                         (desc[8] & 0xf0));
154                 return -EINVAL;
155         }
156
157         if (src) {
158                 memcpy(&xop->src_tid_wwn[0], &desc[8], XCOPY_NAA_IEEE_REGEX_LEN);
159                 /*
160                  * Determine if the source designator matches the local device
161                  */
162                 if (!memcmp(&xop->local_dev_wwn[0], &xop->src_tid_wwn[0],
163                                 XCOPY_NAA_IEEE_REGEX_LEN)) {
164                         xop->op_origin = XCOL_SOURCE_RECV_OP;
165                         xop->src_dev = se_cmd->se_dev;
166                         pr_debug("XCOPY 0xe4: Set xop->src_dev %p from source"
167                                         " received xop\n", xop->src_dev);
168                 }
169         } else {
170                 memcpy(&xop->dst_tid_wwn[0], &desc[8], XCOPY_NAA_IEEE_REGEX_LEN);
171                 /*
172                  * Determine if the destination designator matches the local device
173                  */
174                 if (!memcmp(&xop->local_dev_wwn[0], &xop->dst_tid_wwn[0],
175                                 XCOPY_NAA_IEEE_REGEX_LEN)) {
176                         xop->op_origin = XCOL_DEST_RECV_OP;
177                         xop->dst_dev = se_cmd->se_dev;
178                         pr_debug("XCOPY 0xe4: Set xop->dst_dev: %p from destination"
179                                 " received xop\n", xop->dst_dev);
180                 }
181         }
182
183         return 0;
184 }
185
186 static int target_xcopy_parse_target_descriptors(struct se_cmd *se_cmd,
187                                 struct xcopy_op *xop, unsigned char *p,
188                                 unsigned short tdll)
189 {
190         struct se_device *local_dev = se_cmd->se_dev;
191         unsigned char *desc = p;
192         int offset = tdll % XCOPY_TARGET_DESC_LEN, rc, ret = 0;
193         unsigned short start = 0;
194         bool src = true;
195
196         if (offset != 0) {
197                 pr_err("XCOPY target descriptor list length is not"
198                         " multiple of %d\n", XCOPY_TARGET_DESC_LEN);
199                 return -EINVAL;
200         }
201         if (tdll > 64) {
202                 pr_err("XCOPY target descriptor supports a maximum"
203                         " two src/dest descriptors, tdll: %hu too large..\n", tdll);
204                 return -EINVAL;
205         }
206         /*
207          * Generate an IEEE Registered Extended designator based upon the
208          * se_device the XCOPY was received upon..
209          */
210         memset(&xop->local_dev_wwn[0], 0, XCOPY_NAA_IEEE_REGEX_LEN);
211         target_xcopy_gen_naa_ieee(local_dev, &xop->local_dev_wwn[0]);
212
213         while (start < tdll) {
214                 /*
215                  * Check target descriptor identification with 0xE4 type with
216                  * use VPD 0x83 WWPN matching ..
217                  */
218                 switch (desc[0]) {
219                 case 0xe4:
220                         rc = target_xcopy_parse_tiddesc_e4(se_cmd, xop,
221                                                         &desc[0], src);
222                         if (rc != 0)
223                                 goto out;
224                         /*
225                          * Assume target descriptors are in source -> destination order..
226                          */
227                         if (src)
228                                 src = false;
229                         else
230                                 src = true;
231                         start += XCOPY_TARGET_DESC_LEN;
232                         desc += XCOPY_TARGET_DESC_LEN;
233                         ret++;
234                         break;
235                 default:
236                         pr_err("XCOPY unsupported descriptor type code:"
237                                         " 0x%02x\n", desc[0]);
238                         goto out;
239                 }
240         }
241
242         if (xop->op_origin == XCOL_SOURCE_RECV_OP)
243                 rc = target_xcopy_locate_se_dev_e4(se_cmd, xop, true);
244         else
245                 rc = target_xcopy_locate_se_dev_e4(se_cmd, xop, false);
246
247         if (rc < 0)
248                 goto out;
249
250         pr_debug("XCOPY TGT desc: Source dev: %p NAA IEEE WWN: 0x%16phN\n",
251                  xop->src_dev, &xop->src_tid_wwn[0]);
252         pr_debug("XCOPY TGT desc: Dest dev: %p NAA IEEE WWN: 0x%16phN\n",
253                  xop->dst_dev, &xop->dst_tid_wwn[0]);
254
255         return ret;
256
257 out:
258         return -EINVAL;
259 }
260
261 static int target_xcopy_parse_segdesc_02(struct se_cmd *se_cmd, struct xcopy_op *xop,
262                                         unsigned char *p)
263 {
264         unsigned char *desc = p;
265         int dc = (desc[1] & 0x02);
266         unsigned short desc_len;
267
268         desc_len = get_unaligned_be16(&desc[2]);
269         if (desc_len != 0x18) {
270                 pr_err("XCOPY segment desc 0x02: Illegal desc_len:"
271                                 " %hu\n", desc_len);
272                 return -EINVAL;
273         }
274
275         xop->stdi = get_unaligned_be16(&desc[4]);
276         xop->dtdi = get_unaligned_be16(&desc[6]);
277         pr_debug("XCOPY seg desc 0x02: desc_len: %hu stdi: %hu dtdi: %hu, DC: %d\n",
278                 desc_len, xop->stdi, xop->dtdi, dc);
279
280         xop->nolb = get_unaligned_be16(&desc[10]);
281         xop->src_lba = get_unaligned_be64(&desc[12]);
282         xop->dst_lba = get_unaligned_be64(&desc[20]);
283         pr_debug("XCOPY seg desc 0x02: nolb: %hu src_lba: %llu dst_lba: %llu\n",
284                 xop->nolb, (unsigned long long)xop->src_lba,
285                 (unsigned long long)xop->dst_lba);
286
287         if (dc != 0) {
288                 xop->dbl = (desc[29] & 0xff) << 16;
289                 xop->dbl |= (desc[30] & 0xff) << 8;
290                 xop->dbl |= desc[31] & 0xff;
291
292                 pr_debug("XCOPY seg desc 0x02: DC=1 w/ dbl: %u\n", xop->dbl);
293         }
294         return 0;
295 }
296
297 static int target_xcopy_parse_segment_descriptors(struct se_cmd *se_cmd,
298                                 struct xcopy_op *xop, unsigned char *p,
299                                 unsigned int sdll)
300 {
301         unsigned char *desc = p;
302         unsigned int start = 0;
303         int offset = sdll % XCOPY_SEGMENT_DESC_LEN, rc, ret = 0;
304
305         if (offset != 0) {
306                 pr_err("XCOPY segment descriptor list length is not"
307                         " multiple of %d\n", XCOPY_SEGMENT_DESC_LEN);
308                 return -EINVAL;
309         }
310
311         while (start < sdll) {
312                 /*
313                  * Check segment descriptor type code for block -> block
314                  */
315                 switch (desc[0]) {
316                 case 0x02:
317                         rc = target_xcopy_parse_segdesc_02(se_cmd, xop, desc);
318                         if (rc < 0)
319                                 goto out;
320
321                         ret++;
322                         start += XCOPY_SEGMENT_DESC_LEN;
323                         desc += XCOPY_SEGMENT_DESC_LEN;
324                         break;
325                 default:
326                         pr_err("XCOPY unsupported segment descriptor"
327                                 "type: 0x%02x\n", desc[0]);
328                         goto out;
329                 }
330         }
331
332         return ret;
333
334 out:
335         return -EINVAL;
336 }
337
338 /*
339  * Start xcopy_pt ops
340  */
341
342 struct xcopy_pt_cmd {
343         bool remote_port;
344         struct se_cmd se_cmd;
345         struct xcopy_op *xcopy_op;
346         struct completion xpt_passthrough_sem;
347         unsigned char sense_buffer[TRANSPORT_SENSE_BUFFER];
348 };
349
350 struct se_portal_group xcopy_pt_tpg;
351 static struct se_session xcopy_pt_sess;
352 static struct se_node_acl xcopy_pt_nacl;
353
354 static char *xcopy_pt_get_fabric_name(void)
355 {
356         return "xcopy-pt";
357 }
358
359 static int xcopy_pt_get_cmd_state(struct se_cmd *se_cmd)
360 {
361         return 0;
362 }
363
364 static void xcopy_pt_undepend_remotedev(struct xcopy_op *xop)
365 {
366         struct se_device *remote_dev;
367
368         if (xop->op_origin == XCOL_SOURCE_RECV_OP)
369                 remote_dev = xop->dst_dev;
370         else
371                 remote_dev = xop->src_dev;
372
373         pr_debug("Calling configfs_undepend_item for"
374                   " remote_dev: %p remote_dev->dev_group: %p\n",
375                   remote_dev, &remote_dev->dev_group.cg_item);
376
377         target_undepend_item(&remote_dev->dev_group.cg_item);
378 }
379
380 static void xcopy_pt_release_cmd(struct se_cmd *se_cmd)
381 {
382         struct xcopy_pt_cmd *xpt_cmd = container_of(se_cmd,
383                                 struct xcopy_pt_cmd, se_cmd);
384
385         kfree(xpt_cmd);
386 }
387
388 static int xcopy_pt_check_stop_free(struct se_cmd *se_cmd)
389 {
390         struct xcopy_pt_cmd *xpt_cmd = container_of(se_cmd,
391                                 struct xcopy_pt_cmd, se_cmd);
392
393         complete(&xpt_cmd->xpt_passthrough_sem);
394         return 0;
395 }
396
397 static int xcopy_pt_write_pending(struct se_cmd *se_cmd)
398 {
399         return 0;
400 }
401
402 static int xcopy_pt_write_pending_status(struct se_cmd *se_cmd)
403 {
404         return 0;
405 }
406
407 static int xcopy_pt_queue_data_in(struct se_cmd *se_cmd)
408 {
409         return 0;
410 }
411
412 static int xcopy_pt_queue_status(struct se_cmd *se_cmd)
413 {
414         return 0;
415 }
416
417 static const struct target_core_fabric_ops xcopy_pt_tfo = {
418         .get_fabric_name        = xcopy_pt_get_fabric_name,
419         .get_cmd_state          = xcopy_pt_get_cmd_state,
420         .release_cmd            = xcopy_pt_release_cmd,
421         .check_stop_free        = xcopy_pt_check_stop_free,
422         .write_pending          = xcopy_pt_write_pending,
423         .write_pending_status   = xcopy_pt_write_pending_status,
424         .queue_data_in          = xcopy_pt_queue_data_in,
425         .queue_status           = xcopy_pt_queue_status,
426 };
427
428 /*
429  * End xcopy_pt_ops
430  */
431
432 int target_xcopy_setup_pt(void)
433 {
434         xcopy_wq = alloc_workqueue("xcopy_wq", WQ_MEM_RECLAIM, 0);
435         if (!xcopy_wq) {
436                 pr_err("Unable to allocate xcopy_wq\n");
437                 return -ENOMEM;
438         }
439
440         memset(&xcopy_pt_tpg, 0, sizeof(struct se_portal_group));
441         INIT_LIST_HEAD(&xcopy_pt_tpg.se_tpg_node);
442         INIT_LIST_HEAD(&xcopy_pt_tpg.acl_node_list);
443         INIT_LIST_HEAD(&xcopy_pt_tpg.tpg_sess_list);
444
445         xcopy_pt_tpg.se_tpg_tfo = &xcopy_pt_tfo;
446
447         memset(&xcopy_pt_nacl, 0, sizeof(struct se_node_acl));
448         INIT_LIST_HEAD(&xcopy_pt_nacl.acl_list);
449         INIT_LIST_HEAD(&xcopy_pt_nacl.acl_sess_list);
450         memset(&xcopy_pt_sess, 0, sizeof(struct se_session));
451         INIT_LIST_HEAD(&xcopy_pt_sess.sess_list);
452         INIT_LIST_HEAD(&xcopy_pt_sess.sess_acl_list);
453
454         xcopy_pt_nacl.se_tpg = &xcopy_pt_tpg;
455         xcopy_pt_nacl.nacl_sess = &xcopy_pt_sess;
456
457         xcopy_pt_sess.se_tpg = &xcopy_pt_tpg;
458         xcopy_pt_sess.se_node_acl = &xcopy_pt_nacl;
459
460         return 0;
461 }
462
463 void target_xcopy_release_pt(void)
464 {
465         if (xcopy_wq)
466                 destroy_workqueue(xcopy_wq);
467 }
468
469 static void target_xcopy_setup_pt_port(
470         struct xcopy_pt_cmd *xpt_cmd,
471         struct xcopy_op *xop,
472         bool remote_port)
473 {
474         struct se_cmd *ec_cmd = xop->xop_se_cmd;
475         struct se_cmd *pt_cmd = &xpt_cmd->se_cmd;
476
477         if (xop->op_origin == XCOL_SOURCE_RECV_OP) {
478                 /*
479                  * Honor destination port reservations for X-COPY PUSH emulation
480                  * when CDB is received on local source port, and READs blocks to
481                  * WRITE on remote destination port.
482                  */
483                 if (remote_port) {
484                         xpt_cmd->remote_port = remote_port;
485                 } else {
486                         pt_cmd->se_lun = ec_cmd->se_lun;
487                         pt_cmd->se_dev = ec_cmd->se_dev;
488
489                         pr_debug("Honoring local SRC port from ec_cmd->se_dev:"
490                                 " %p\n", pt_cmd->se_dev);
491                         pt_cmd->se_lun = ec_cmd->se_lun;
492                         pr_debug("Honoring local SRC port from ec_cmd->se_lun: %p\n",
493                                 pt_cmd->se_lun);
494                 }
495         } else {
496                 /*
497                  * Honor source port reservation for X-COPY PULL emulation
498                  * when CDB is received on local desintation port, and READs
499                  * blocks from the remote source port to WRITE on local
500                  * destination port.
501                  */
502                 if (remote_port) {
503                         xpt_cmd->remote_port = remote_port;
504                 } else {
505                         pt_cmd->se_lun = ec_cmd->se_lun;
506                         pt_cmd->se_dev = ec_cmd->se_dev;
507
508                         pr_debug("Honoring local DST port from ec_cmd->se_dev:"
509                                 " %p\n", pt_cmd->se_dev);
510                         pt_cmd->se_lun = ec_cmd->se_lun;
511                         pr_debug("Honoring local DST port from ec_cmd->se_lun: %p\n",
512                                 pt_cmd->se_lun);
513                 }
514         }
515 }
516
517 static void target_xcopy_init_pt_lun(struct se_device *se_dev,
518                 struct se_cmd *pt_cmd, bool remote_port)
519 {
520         /*
521          * Don't allocate + init an pt_cmd->se_lun if honoring local port for
522          * reservations.  The pt_cmd->se_lun pointer will be setup from within
523          * target_xcopy_setup_pt_port()
524          */
525         if (remote_port) {
526                 pr_debug("Setup emulated se_dev: %p from se_dev\n",
527                         pt_cmd->se_dev);
528                 pt_cmd->se_lun = &se_dev->xcopy_lun;
529                 pt_cmd->se_dev = se_dev;
530         }
531
532         pt_cmd->se_cmd_flags |= SCF_SE_LUN_CMD;
533 }
534
535 static int target_xcopy_setup_pt_cmd(
536         struct xcopy_pt_cmd *xpt_cmd,
537         struct xcopy_op *xop,
538         struct se_device *se_dev,
539         unsigned char *cdb,
540         bool remote_port,
541         bool alloc_mem)
542 {
543         struct se_cmd *cmd = &xpt_cmd->se_cmd;
544         sense_reason_t sense_rc;
545         int ret = 0, rc;
546         /*
547          * Setup LUN+port to honor reservations based upon xop->op_origin for
548          * X-COPY PUSH or X-COPY PULL based upon where the CDB was received.
549          */
550         target_xcopy_init_pt_lun(se_dev, cmd, remote_port);
551
552         xpt_cmd->xcopy_op = xop;
553         target_xcopy_setup_pt_port(xpt_cmd, xop, remote_port);
554
555         cmd->tag = 0;
556         sense_rc = target_setup_cmd_from_cdb(cmd, cdb);
557         if (sense_rc) {
558                 ret = -EINVAL;
559                 goto out;
560         }
561
562         if (alloc_mem) {
563                 rc = target_alloc_sgl(&cmd->t_data_sg, &cmd->t_data_nents,
564                                       cmd->data_length, false);
565                 if (rc < 0) {
566                         ret = rc;
567                         goto out;
568                 }
569                 /*
570                  * Set this bit so that transport_free_pages() allows the
571                  * caller to release SGLs + physical memory allocated by
572                  * transport_generic_get_mem()..
573                  */
574                 cmd->se_cmd_flags |= SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC;
575         } else {
576                 /*
577                  * Here the previously allocated SGLs for the internal READ
578                  * are mapped zero-copy to the internal WRITE.
579                  */
580                 sense_rc = transport_generic_map_mem_to_cmd(cmd,
581                                         xop->xop_data_sg, xop->xop_data_nents,
582                                         NULL, 0);
583                 if (sense_rc) {
584                         ret = -EINVAL;
585                         goto out;
586                 }
587
588                 pr_debug("Setup PASSTHROUGH_NOALLOC t_data_sg: %p t_data_nents:"
589                          " %u\n", cmd->t_data_sg, cmd->t_data_nents);
590         }
591
592         return 0;
593
594 out:
595         return ret;
596 }
597
598 static int target_xcopy_issue_pt_cmd(struct xcopy_pt_cmd *xpt_cmd)
599 {
600         struct se_cmd *se_cmd = &xpt_cmd->se_cmd;
601         sense_reason_t sense_rc;
602
603         sense_rc = transport_generic_new_cmd(se_cmd);
604         if (sense_rc)
605                 return -EINVAL;
606
607         if (se_cmd->data_direction == DMA_TO_DEVICE)
608                 target_execute_cmd(se_cmd);
609
610         wait_for_completion_interruptible(&xpt_cmd->xpt_passthrough_sem);
611
612         pr_debug("target_xcopy_issue_pt_cmd(): SCSI status: 0x%02x\n",
613                         se_cmd->scsi_status);
614
615         return (se_cmd->scsi_status) ? -EINVAL : 0;
616 }
617
618 static int target_xcopy_read_source(
619         struct se_cmd *ec_cmd,
620         struct xcopy_op *xop,
621         struct se_device *src_dev,
622         sector_t src_lba,
623         u32 src_sectors)
624 {
625         struct xcopy_pt_cmd *xpt_cmd;
626         struct se_cmd *se_cmd;
627         u32 length = (src_sectors * src_dev->dev_attrib.block_size);
628         int rc;
629         unsigned char cdb[16];
630         bool remote_port = (xop->op_origin == XCOL_DEST_RECV_OP);
631
632         xpt_cmd = kzalloc(sizeof(struct xcopy_pt_cmd), GFP_KERNEL);
633         if (!xpt_cmd) {
634                 pr_err("Unable to allocate xcopy_pt_cmd\n");
635                 return -ENOMEM;
636         }
637         init_completion(&xpt_cmd->xpt_passthrough_sem);
638         se_cmd = &xpt_cmd->se_cmd;
639
640         memset(&cdb[0], 0, 16);
641         cdb[0] = READ_16;
642         put_unaligned_be64(src_lba, &cdb[2]);
643         put_unaligned_be32(src_sectors, &cdb[10]);
644         pr_debug("XCOPY: Built READ_16: LBA: %llu Sectors: %u Length: %u\n",
645                 (unsigned long long)src_lba, src_sectors, length);
646
647         transport_init_se_cmd(se_cmd, &xcopy_pt_tfo, NULL, length,
648                               DMA_FROM_DEVICE, 0, &xpt_cmd->sense_buffer[0]);
649         xop->src_pt_cmd = xpt_cmd;
650
651         rc = target_xcopy_setup_pt_cmd(xpt_cmd, xop, src_dev, &cdb[0],
652                                 remote_port, true);
653         if (rc < 0) {
654                 transport_generic_free_cmd(se_cmd, 0);
655                 return rc;
656         }
657
658         xop->xop_data_sg = se_cmd->t_data_sg;
659         xop->xop_data_nents = se_cmd->t_data_nents;
660         pr_debug("XCOPY-READ: Saved xop->xop_data_sg: %p, num: %u for READ"
661                 " memory\n", xop->xop_data_sg, xop->xop_data_nents);
662
663         rc = target_xcopy_issue_pt_cmd(xpt_cmd);
664         if (rc < 0) {
665                 transport_generic_free_cmd(se_cmd, 0);
666                 return rc;
667         }
668         /*
669          * Clear off the allocated t_data_sg, that has been saved for
670          * zero-copy WRITE submission reuse in struct xcopy_op..
671          */
672         se_cmd->t_data_sg = NULL;
673         se_cmd->t_data_nents = 0;
674
675         return 0;
676 }
677
678 static int target_xcopy_write_destination(
679         struct se_cmd *ec_cmd,
680         struct xcopy_op *xop,
681         struct se_device *dst_dev,
682         sector_t dst_lba,
683         u32 dst_sectors)
684 {
685         struct xcopy_pt_cmd *xpt_cmd;
686         struct se_cmd *se_cmd;
687         u32 length = (dst_sectors * dst_dev->dev_attrib.block_size);
688         int rc;
689         unsigned char cdb[16];
690         bool remote_port = (xop->op_origin == XCOL_SOURCE_RECV_OP);
691
692         xpt_cmd = kzalloc(sizeof(struct xcopy_pt_cmd), GFP_KERNEL);
693         if (!xpt_cmd) {
694                 pr_err("Unable to allocate xcopy_pt_cmd\n");
695                 return -ENOMEM;
696         }
697         init_completion(&xpt_cmd->xpt_passthrough_sem);
698         se_cmd = &xpt_cmd->se_cmd;
699
700         memset(&cdb[0], 0, 16);
701         cdb[0] = WRITE_16;
702         put_unaligned_be64(dst_lba, &cdb[2]);
703         put_unaligned_be32(dst_sectors, &cdb[10]);
704         pr_debug("XCOPY: Built WRITE_16: LBA: %llu Sectors: %u Length: %u\n",
705                 (unsigned long long)dst_lba, dst_sectors, length);
706
707         transport_init_se_cmd(se_cmd, &xcopy_pt_tfo, NULL, length,
708                               DMA_TO_DEVICE, 0, &xpt_cmd->sense_buffer[0]);
709         xop->dst_pt_cmd = xpt_cmd;
710
711         rc = target_xcopy_setup_pt_cmd(xpt_cmd, xop, dst_dev, &cdb[0],
712                                 remote_port, false);
713         if (rc < 0) {
714                 struct se_cmd *src_cmd = &xop->src_pt_cmd->se_cmd;
715                 /*
716                  * If the failure happened before the t_mem_list hand-off in
717                  * target_xcopy_setup_pt_cmd(), Reset memory + clear flag so that
718                  * core releases this memory on error during X-COPY WRITE I/O.
719                  */
720                 src_cmd->se_cmd_flags &= ~SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC;
721                 src_cmd->t_data_sg = xop->xop_data_sg;
722                 src_cmd->t_data_nents = xop->xop_data_nents;
723
724                 transport_generic_free_cmd(se_cmd, 0);
725                 return rc;
726         }
727
728         rc = target_xcopy_issue_pt_cmd(xpt_cmd);
729         if (rc < 0) {
730                 se_cmd->se_cmd_flags &= ~SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC;
731                 transport_generic_free_cmd(se_cmd, 0);
732                 return rc;
733         }
734
735         return 0;
736 }
737
738 static void target_xcopy_do_work(struct work_struct *work)
739 {
740         struct xcopy_op *xop = container_of(work, struct xcopy_op, xop_work);
741         struct se_device *src_dev = xop->src_dev, *dst_dev = xop->dst_dev;
742         struct se_cmd *ec_cmd = xop->xop_se_cmd;
743         sector_t src_lba = xop->src_lba, dst_lba = xop->dst_lba, end_lba;
744         unsigned int max_sectors;
745         int rc;
746         unsigned short nolb = xop->nolb, cur_nolb, max_nolb, copied_nolb = 0;
747
748         end_lba = src_lba + nolb;
749         /*
750          * Break up XCOPY I/O into hw_max_sectors sized I/O based on the
751          * smallest max_sectors between src_dev + dev_dev, or
752          */
753         max_sectors = min(src_dev->dev_attrib.hw_max_sectors,
754                           dst_dev->dev_attrib.hw_max_sectors);
755         max_sectors = min_t(u32, max_sectors, XCOPY_MAX_SECTORS);
756
757         max_nolb = min_t(u16, max_sectors, ((u16)(~0U)));
758
759         pr_debug("target_xcopy_do_work: nolb: %hu, max_nolb: %hu end_lba: %llu\n",
760                         nolb, max_nolb, (unsigned long long)end_lba);
761         pr_debug("target_xcopy_do_work: Starting src_lba: %llu, dst_lba: %llu\n",
762                         (unsigned long long)src_lba, (unsigned long long)dst_lba);
763
764         while (src_lba < end_lba) {
765                 cur_nolb = min(nolb, max_nolb);
766
767                 pr_debug("target_xcopy_do_work: Calling read src_dev: %p src_lba: %llu,"
768                         " cur_nolb: %hu\n", src_dev, (unsigned long long)src_lba, cur_nolb);
769
770                 rc = target_xcopy_read_source(ec_cmd, xop, src_dev, src_lba, cur_nolb);
771                 if (rc < 0)
772                         goto out;
773
774                 src_lba += cur_nolb;
775                 pr_debug("target_xcopy_do_work: Incremented READ src_lba to %llu\n",
776                                 (unsigned long long)src_lba);
777
778                 pr_debug("target_xcopy_do_work: Calling write dst_dev: %p dst_lba: %llu,"
779                         " cur_nolb: %hu\n", dst_dev, (unsigned long long)dst_lba, cur_nolb);
780
781                 rc = target_xcopy_write_destination(ec_cmd, xop, dst_dev,
782                                                 dst_lba, cur_nolb);
783                 if (rc < 0) {
784                         transport_generic_free_cmd(&xop->src_pt_cmd->se_cmd, 0);
785                         goto out;
786                 }
787
788                 dst_lba += cur_nolb;
789                 pr_debug("target_xcopy_do_work: Incremented WRITE dst_lba to %llu\n",
790                                 (unsigned long long)dst_lba);
791
792                 copied_nolb += cur_nolb;
793                 nolb -= cur_nolb;
794
795                 transport_generic_free_cmd(&xop->src_pt_cmd->se_cmd, 0);
796                 xop->dst_pt_cmd->se_cmd.se_cmd_flags &= ~SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC;
797
798                 transport_generic_free_cmd(&xop->dst_pt_cmd->se_cmd, 0);
799         }
800
801         xcopy_pt_undepend_remotedev(xop);
802         kfree(xop);
803
804         pr_debug("target_xcopy_do_work: Final src_lba: %llu, dst_lba: %llu\n",
805                 (unsigned long long)src_lba, (unsigned long long)dst_lba);
806         pr_debug("target_xcopy_do_work: Blocks copied: %hu, Bytes Copied: %u\n",
807                 copied_nolb, copied_nolb * dst_dev->dev_attrib.block_size);
808
809         pr_debug("target_xcopy_do_work: Setting X-COPY GOOD status -> sending response\n");
810         target_complete_cmd(ec_cmd, SAM_STAT_GOOD);
811         return;
812
813 out:
814         xcopy_pt_undepend_remotedev(xop);
815         kfree(xop);
816
817         pr_warn("target_xcopy_do_work: Setting X-COPY CHECK_CONDITION -> sending response\n");
818         ec_cmd->scsi_status = SAM_STAT_CHECK_CONDITION;
819         target_complete_cmd(ec_cmd, SAM_STAT_CHECK_CONDITION);
820 }
821
822 sense_reason_t target_do_xcopy(struct se_cmd *se_cmd)
823 {
824         struct se_device *dev = se_cmd->se_dev;
825         struct xcopy_op *xop = NULL;
826         unsigned char *p = NULL, *seg_desc;
827         unsigned int list_id, list_id_usage, sdll, inline_dl, sa;
828         sense_reason_t ret = TCM_INVALID_PARAMETER_LIST;
829         int rc;
830         unsigned short tdll;
831
832         if (!dev->dev_attrib.emulate_3pc) {
833                 pr_err("EXTENDED_COPY operation explicitly disabled\n");
834                 return TCM_UNSUPPORTED_SCSI_OPCODE;
835         }
836
837         sa = se_cmd->t_task_cdb[1] & 0x1f;
838         if (sa != 0x00) {
839                 pr_err("EXTENDED_COPY(LID4) not supported\n");
840                 return TCM_UNSUPPORTED_SCSI_OPCODE;
841         }
842
843         xop = kzalloc(sizeof(struct xcopy_op), GFP_KERNEL);
844         if (!xop) {
845                 pr_err("Unable to allocate xcopy_op\n");
846                 return TCM_OUT_OF_RESOURCES;
847         }
848         xop->xop_se_cmd = se_cmd;
849
850         p = transport_kmap_data_sg(se_cmd);
851         if (!p) {
852                 pr_err("transport_kmap_data_sg() failed in target_do_xcopy\n");
853                 kfree(xop);
854                 return TCM_OUT_OF_RESOURCES;
855         }
856
857         list_id = p[0];
858         list_id_usage = (p[1] & 0x18) >> 3;
859
860         /*
861          * Determine TARGET DESCRIPTOR LIST LENGTH + SEGMENT DESCRIPTOR LIST LENGTH
862          */
863         tdll = get_unaligned_be16(&p[2]);
864         sdll = get_unaligned_be32(&p[8]);
865
866         inline_dl = get_unaligned_be32(&p[12]);
867         if (inline_dl != 0) {
868                 pr_err("XCOPY with non zero inline data length\n");
869                 goto out;
870         }
871
872         pr_debug("Processing XCOPY with list_id: 0x%02x list_id_usage: 0x%02x"
873                 " tdll: %hu sdll: %u inline_dl: %u\n", list_id, list_id_usage,
874                 tdll, sdll, inline_dl);
875
876         rc = target_xcopy_parse_target_descriptors(se_cmd, xop, &p[16], tdll);
877         if (rc <= 0)
878                 goto out;
879
880         if (xop->src_dev->dev_attrib.block_size !=
881             xop->dst_dev->dev_attrib.block_size) {
882                 pr_err("XCOPY: Non matching src_dev block_size: %u + dst_dev"
883                        " block_size: %u currently unsupported\n",
884                         xop->src_dev->dev_attrib.block_size,
885                         xop->dst_dev->dev_attrib.block_size);
886                 xcopy_pt_undepend_remotedev(xop);
887                 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
888                 goto out;
889         }
890
891         pr_debug("XCOPY: Processed %d target descriptors, length: %u\n", rc,
892                                 rc * XCOPY_TARGET_DESC_LEN);
893         seg_desc = &p[16];
894         seg_desc += (rc * XCOPY_TARGET_DESC_LEN);
895
896         rc = target_xcopy_parse_segment_descriptors(se_cmd, xop, seg_desc, sdll);
897         if (rc <= 0) {
898                 xcopy_pt_undepend_remotedev(xop);
899                 goto out;
900         }
901         transport_kunmap_data_sg(se_cmd);
902
903         pr_debug("XCOPY: Processed %d segment descriptors, length: %u\n", rc,
904                                 rc * XCOPY_SEGMENT_DESC_LEN);
905         INIT_WORK(&xop->xop_work, target_xcopy_do_work);
906         queue_work(xcopy_wq, &xop->xop_work);
907         return TCM_NO_SENSE;
908
909 out:
910         if (p)
911                 transport_kunmap_data_sg(se_cmd);
912         kfree(xop);
913         return ret;
914 }
915
916 static sense_reason_t target_rcr_operating_parameters(struct se_cmd *se_cmd)
917 {
918         unsigned char *p;
919
920         p = transport_kmap_data_sg(se_cmd);
921         if (!p) {
922                 pr_err("transport_kmap_data_sg failed in"
923                        " target_rcr_operating_parameters\n");
924                 return TCM_OUT_OF_RESOURCES;
925         }
926
927         if (se_cmd->data_length < 54) {
928                 pr_err("Receive Copy Results Op Parameters length"
929                        " too small: %u\n", se_cmd->data_length);
930                 transport_kunmap_data_sg(se_cmd);
931                 return TCM_INVALID_CDB_FIELD;
932         }
933         /*
934          * Set SNLID=1 (Supports no List ID)
935          */
936         p[4] = 0x1;
937         /*
938          * MAXIMUM TARGET DESCRIPTOR COUNT
939          */
940         put_unaligned_be16(RCR_OP_MAX_TARGET_DESC_COUNT, &p[8]);
941         /*
942          * MAXIMUM SEGMENT DESCRIPTOR COUNT
943          */
944         put_unaligned_be16(RCR_OP_MAX_SG_DESC_COUNT, &p[10]);
945         /*
946          * MAXIMUM DESCRIPTOR LIST LENGTH
947          */
948         put_unaligned_be32(RCR_OP_MAX_DESC_LIST_LEN, &p[12]);
949         /*
950          * MAXIMUM SEGMENT LENGTH
951          */
952         put_unaligned_be32(RCR_OP_MAX_SEGMENT_LEN, &p[16]);
953         /*
954          * MAXIMUM INLINE DATA LENGTH for SA 0x04 (NOT SUPPORTED)
955          */
956         put_unaligned_be32(0x0, &p[20]);
957         /*
958          * HELD DATA LIMIT
959          */
960         put_unaligned_be32(0x0, &p[24]);
961         /*
962          * MAXIMUM STREAM DEVICE TRANSFER SIZE
963          */
964         put_unaligned_be32(0x0, &p[28]);
965         /*
966          * TOTAL CONCURRENT COPIES
967          */
968         put_unaligned_be16(RCR_OP_TOTAL_CONCURR_COPIES, &p[34]);
969         /*
970          * MAXIMUM CONCURRENT COPIES
971          */
972         p[36] = RCR_OP_MAX_CONCURR_COPIES;
973         /*
974          * DATA SEGMENT GRANULARITY (log 2)
975          */
976         p[37] = RCR_OP_DATA_SEG_GRAN_LOG2;
977         /*
978          * INLINE DATA GRANULARITY log 2)
979          */
980         p[38] = RCR_OP_INLINE_DATA_GRAN_LOG2;
981         /*
982          * HELD DATA GRANULARITY
983          */
984         p[39] = RCR_OP_HELD_DATA_GRAN_LOG2;
985         /*
986          * IMPLEMENTED DESCRIPTOR LIST LENGTH
987          */
988         p[43] = 0x2;
989         /*
990          * List of implemented descriptor type codes (ordered)
991          */
992         p[44] = 0x02; /* Copy Block to Block device */
993         p[45] = 0xe4; /* Identification descriptor target descriptor */
994
995         /*
996          * AVAILABLE DATA (n-3)
997          */
998         put_unaligned_be32(42, &p[0]);
999
1000         transport_kunmap_data_sg(se_cmd);
1001         target_complete_cmd(se_cmd, GOOD);
1002
1003         return TCM_NO_SENSE;
1004 }
1005
1006 sense_reason_t target_do_receive_copy_results(struct se_cmd *se_cmd)
1007 {
1008         unsigned char *cdb = &se_cmd->t_task_cdb[0];
1009         int sa = (cdb[1] & 0x1f), list_id = cdb[2];
1010         sense_reason_t rc = TCM_NO_SENSE;
1011
1012         pr_debug("Entering target_do_receive_copy_results: SA: 0x%02x, List ID:"
1013                 " 0x%02x, AL: %u\n", sa, list_id, se_cmd->data_length);
1014
1015         if (list_id != 0) {
1016                 pr_err("Receive Copy Results with non zero list identifier"
1017                        " not supported\n");
1018                 return TCM_INVALID_CDB_FIELD;
1019         }
1020
1021         switch (sa) {
1022         case RCR_SA_OPERATING_PARAMETERS:
1023                 rc = target_rcr_operating_parameters(se_cmd);
1024                 break;
1025         case RCR_SA_COPY_STATUS:
1026         case RCR_SA_RECEIVE_DATA:
1027         case RCR_SA_FAILED_SEGMENT_DETAILS:
1028         default:
1029                 pr_err("Unsupported SA for receive copy results: 0x%02x\n", sa);
1030                 return TCM_INVALID_CDB_FIELD;
1031         }
1032
1033         return rc;
1034 }