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