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
41static struct workqueue_struct *xcopy_wq = NULL;
42
43static sense_reason_t target_parse_xcopy_cmd(struct xcopy_op *xop);
44
45static 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
58struct xcopy_dev_search_info {
59 const unsigned char *dev_wwn;
60 struct se_device *found_dev;
61};
62
63static 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
95static 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
114static 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
200static 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
289out:
290 return -EINVAL;
291}
292
293static 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
335static 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
383out:
384 return -EINVAL;
385}
386
387/*
388 * Start xcopy_pt ops
389 */
390
391struct xcopy_pt_cmd {
392 bool remote_port;
393 struct se_cmd se_cmd;
394 struct completion xpt_passthrough_sem;
395 unsigned char sense_buffer[TRANSPORT_SENSE_BUFFER];
396};
397
398struct se_portal_group xcopy_pt_tpg;
399static struct se_session xcopy_pt_sess;
400static struct se_node_acl xcopy_pt_nacl;
401
402static int xcopy_pt_get_cmd_state(struct se_cmd *se_cmd)
403{
404 return 0;
405}
406
407static void xcopy_pt_undepend_remotedev(struct xcopy_op *xop)
408{
409 struct se_device *remote_dev;
410
411 if (xop->op_origin == XCOL_SOURCE_RECV_OP)
412 remote_dev = xop->dst_dev;
413 else
414 remote_dev = xop->src_dev;
415
416 pr_debug("Calling configfs_undepend_item for"
417 " remote_dev: %p remote_dev->dev_group: %p\n",
418 remote_dev, &remote_dev->dev_group.cg_item);
419
420 target_undepend_item(&remote_dev->dev_group.cg_item);
421}
422
423static void xcopy_pt_release_cmd(struct se_cmd *se_cmd)
424{
425 struct xcopy_pt_cmd *xpt_cmd = container_of(se_cmd,
426 struct xcopy_pt_cmd, se_cmd);
427
428 kfree(xpt_cmd);
429}
430
431static int xcopy_pt_check_stop_free(struct se_cmd *se_cmd)
432{
433 struct xcopy_pt_cmd *xpt_cmd = container_of(se_cmd,
434 struct xcopy_pt_cmd, se_cmd);
435
436 complete(&xpt_cmd->xpt_passthrough_sem);
437 return 0;
438}
439
440static int xcopy_pt_write_pending(struct se_cmd *se_cmd)
441{
442 return 0;
443}
444
445static int xcopy_pt_queue_data_in(struct se_cmd *se_cmd)
446{
447 return 0;
448}
449
450static int xcopy_pt_queue_status(struct se_cmd *se_cmd)
451{
452 return 0;
453}
454
455static const struct target_core_fabric_ops xcopy_pt_tfo = {
456 .fabric_name = "xcopy-pt",
457 .get_cmd_state = xcopy_pt_get_cmd_state,
458 .release_cmd = xcopy_pt_release_cmd,
459 .check_stop_free = xcopy_pt_check_stop_free,
460 .write_pending = xcopy_pt_write_pending,
461 .queue_data_in = xcopy_pt_queue_data_in,
462 .queue_status = xcopy_pt_queue_status,
463};
464
465/*
466 * End xcopy_pt_ops
467 */
468
469int target_xcopy_setup_pt(void)
470{
471 int ret;
472
473 xcopy_wq = alloc_workqueue("xcopy_wq", WQ_MEM_RECLAIM, 0);
474 if (!xcopy_wq) {
475 pr_err("Unable to allocate xcopy_wq\n");
476 return -ENOMEM;
477 }
478
479 memset(&xcopy_pt_tpg, 0, sizeof(struct se_portal_group));
480 INIT_LIST_HEAD(&xcopy_pt_tpg.se_tpg_node);
481 INIT_LIST_HEAD(&xcopy_pt_tpg.acl_node_list);
482 INIT_LIST_HEAD(&xcopy_pt_tpg.tpg_sess_list);
483
484 xcopy_pt_tpg.se_tpg_tfo = &xcopy_pt_tfo;
485
486 memset(&xcopy_pt_nacl, 0, sizeof(struct se_node_acl));
487 INIT_LIST_HEAD(&xcopy_pt_nacl.acl_list);
488 INIT_LIST_HEAD(&xcopy_pt_nacl.acl_sess_list);
489 memset(&xcopy_pt_sess, 0, sizeof(struct se_session));
490 ret = transport_init_session(&xcopy_pt_sess);
491 if (ret < 0)
492 return ret;
493
494 xcopy_pt_nacl.se_tpg = &xcopy_pt_tpg;
495 xcopy_pt_nacl.nacl_sess = &xcopy_pt_sess;
496
497 xcopy_pt_sess.se_tpg = &xcopy_pt_tpg;
498 xcopy_pt_sess.se_node_acl = &xcopy_pt_nacl;
499
500 return 0;
501}
502
503void target_xcopy_release_pt(void)
504{
505 if (xcopy_wq)
506 destroy_workqueue(xcopy_wq);
507}
508
509static void target_xcopy_setup_pt_port(
510 struct xcopy_pt_cmd *xpt_cmd,
511 struct xcopy_op *xop,
512 bool remote_port)
513{
514 struct se_cmd *ec_cmd = xop->xop_se_cmd;
515 struct se_cmd *pt_cmd = &xpt_cmd->se_cmd;
516
517 if (xop->op_origin == XCOL_SOURCE_RECV_OP) {
518 /*
519 * Honor destination port reservations for X-COPY PUSH emulation
520 * when CDB is received on local source port, and READs blocks to
521 * WRITE on remote destination port.
522 */
523 if (remote_port) {
524 xpt_cmd->remote_port = remote_port;
525 } else {
526 pt_cmd->se_lun = ec_cmd->se_lun;
527 pt_cmd->se_dev = ec_cmd->se_dev;
528
529 pr_debug("Honoring local SRC port from ec_cmd->se_dev:"
530 " %p\n", pt_cmd->se_dev);
531 pt_cmd->se_lun = ec_cmd->se_lun;
532 pr_debug("Honoring local SRC port from ec_cmd->se_lun: %p\n",
533 pt_cmd->se_lun);
534 }
535 } else {
536 /*
537 * Honor source port reservation for X-COPY PULL emulation
538 * when CDB is received on local desintation port, and READs
539 * blocks from the remote source port to WRITE on local
540 * destination port.
541 */
542 if (remote_port) {
543 xpt_cmd->remote_port = remote_port;
544 } else {
545 pt_cmd->se_lun = ec_cmd->se_lun;
546 pt_cmd->se_dev = ec_cmd->se_dev;
547
548 pr_debug("Honoring local DST port from ec_cmd->se_dev:"
549 " %p\n", pt_cmd->se_dev);
550 pt_cmd->se_lun = ec_cmd->se_lun;
551 pr_debug("Honoring local DST port from ec_cmd->se_lun: %p\n",
552 pt_cmd->se_lun);
553 }
554 }
555}
556
557static void target_xcopy_init_pt_lun(struct se_device *se_dev,
558 struct se_cmd *pt_cmd, bool remote_port)
559{
560 /*
561 * Don't allocate + init an pt_cmd->se_lun if honoring local port for
562 * reservations. The pt_cmd->se_lun pointer will be setup from within
563 * target_xcopy_setup_pt_port()
564 */
565 if (remote_port) {
566 pr_debug("Setup emulated se_dev: %p from se_dev\n",
567 pt_cmd->se_dev);
568 pt_cmd->se_lun = &se_dev->xcopy_lun;
569 pt_cmd->se_dev = se_dev;
570 }
571
572 pt_cmd->se_cmd_flags |= SCF_SE_LUN_CMD;
573}
574
575static int target_xcopy_setup_pt_cmd(
576 struct xcopy_pt_cmd *xpt_cmd,
577 struct xcopy_op *xop,
578 struct se_device *se_dev,
579 unsigned char *cdb,
580 bool remote_port,
581 bool alloc_mem)
582{
583 struct se_cmd *cmd = &xpt_cmd->se_cmd;
584 sense_reason_t sense_rc;
585 int ret = 0, rc;
586 /*
587 * Setup LUN+port to honor reservations based upon xop->op_origin for
588 * X-COPY PUSH or X-COPY PULL based upon where the CDB was received.
589 */
590 target_xcopy_init_pt_lun(se_dev, cmd, remote_port);
591 target_xcopy_setup_pt_port(xpt_cmd, xop, remote_port);
592
593 cmd->tag = 0;
594 sense_rc = target_setup_cmd_from_cdb(cmd, cdb);
595 if (sense_rc) {
596 ret = -EINVAL;
597 goto out;
598 }
599
600 if (alloc_mem) {
601 rc = target_alloc_sgl(&cmd->t_data_sg, &cmd->t_data_nents,
602 cmd->data_length, false, false);
603 if (rc < 0) {
604 ret = rc;
605 goto out;
606 }
607 /*
608 * Set this bit so that transport_free_pages() allows the
609 * caller to release SGLs + physical memory allocated by
610 * transport_generic_get_mem()..
611 */
612 cmd->se_cmd_flags |= SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC;
613 } else {
614 /*
615 * Here the previously allocated SGLs for the internal READ
616 * are mapped zero-copy to the internal WRITE.
617 */
618 sense_rc = transport_generic_map_mem_to_cmd(cmd,
619 xop->xop_data_sg, xop->xop_data_nents,
620 NULL, 0);
621 if (sense_rc) {
622 ret = -EINVAL;
623 goto out;
624 }
625
626 pr_debug("Setup PASSTHROUGH_NOALLOC t_data_sg: %p t_data_nents:"
627 " %u\n", cmd->t_data_sg, cmd->t_data_nents);
628 }
629
630 return 0;
631
632out:
633 return ret;
634}
635
636static int target_xcopy_issue_pt_cmd(struct xcopy_pt_cmd *xpt_cmd)
637{
638 struct se_cmd *se_cmd = &xpt_cmd->se_cmd;
639 sense_reason_t sense_rc;
640
641 sense_rc = transport_generic_new_cmd(se_cmd);
642 if (sense_rc)
643 return -EINVAL;
644
645 if (se_cmd->data_direction == DMA_TO_DEVICE)
646 target_execute_cmd(se_cmd);
647
648 wait_for_completion_interruptible(&xpt_cmd->xpt_passthrough_sem);
649
650 pr_debug("target_xcopy_issue_pt_cmd(): SCSI status: 0x%02x\n",
651 se_cmd->scsi_status);
652
653 return (se_cmd->scsi_status) ? -EINVAL : 0;
654}
655
656static int target_xcopy_read_source(
657 struct se_cmd *ec_cmd,
658 struct xcopy_op *xop,
659 struct se_device *src_dev,
660 sector_t src_lba,
661 u32 src_sectors)
662{
663 struct xcopy_pt_cmd *xpt_cmd;
664 struct se_cmd *se_cmd;
665 u32 length = (src_sectors * src_dev->dev_attrib.block_size);
666 int rc;
667 unsigned char cdb[16];
668 bool remote_port = (xop->op_origin == XCOL_DEST_RECV_OP);
669
670 xpt_cmd = kzalloc(sizeof(struct xcopy_pt_cmd), GFP_KERNEL);
671 if (!xpt_cmd) {
672 pr_err("Unable to allocate xcopy_pt_cmd\n");
673 return -ENOMEM;
674 }
675 init_completion(&xpt_cmd->xpt_passthrough_sem);
676 se_cmd = &xpt_cmd->se_cmd;
677
678 memset(&cdb[0], 0, 16);
679 cdb[0] = READ_16;
680 put_unaligned_be64(src_lba, &cdb[2]);
681 put_unaligned_be32(src_sectors, &cdb[10]);
682 pr_debug("XCOPY: Built READ_16: LBA: %llu Sectors: %u Length: %u\n",
683 (unsigned long long)src_lba, src_sectors, length);
684
685 transport_init_se_cmd(se_cmd, &xcopy_pt_tfo, &xcopy_pt_sess, length,
686 DMA_FROM_DEVICE, 0, &xpt_cmd->sense_buffer[0]);
687 xop->src_pt_cmd = xpt_cmd;
688
689 rc = target_xcopy_setup_pt_cmd(xpt_cmd, xop, src_dev, &cdb[0],
690 remote_port, true);
691 if (rc < 0) {
692 ec_cmd->scsi_status = xpt_cmd->se_cmd.scsi_status;
693 transport_generic_free_cmd(se_cmd, 0);
694 return rc;
695 }
696
697 xop->xop_data_sg = se_cmd->t_data_sg;
698 xop->xop_data_nents = se_cmd->t_data_nents;
699 pr_debug("XCOPY-READ: Saved xop->xop_data_sg: %p, num: %u for READ"
700 " memory\n", xop->xop_data_sg, xop->xop_data_nents);
701
702 rc = target_xcopy_issue_pt_cmd(xpt_cmd);
703 if (rc < 0) {
704 ec_cmd->scsi_status = xpt_cmd->se_cmd.scsi_status;
705 transport_generic_free_cmd(se_cmd, 0);
706 return rc;
707 }
708 /*
709 * Clear off the allocated t_data_sg, that has been saved for
710 * zero-copy WRITE submission reuse in struct xcopy_op..
711 */
712 se_cmd->t_data_sg = NULL;
713 se_cmd->t_data_nents = 0;
714
715 return 0;
716}
717
718static int target_xcopy_write_destination(
719 struct se_cmd *ec_cmd,
720 struct xcopy_op *xop,
721 struct se_device *dst_dev,
722 sector_t dst_lba,
723 u32 dst_sectors)
724{
725 struct xcopy_pt_cmd *xpt_cmd;
726 struct se_cmd *se_cmd;
727 u32 length = (dst_sectors * dst_dev->dev_attrib.block_size);
728 int rc;
729 unsigned char cdb[16];
730 bool remote_port = (xop->op_origin == XCOL_SOURCE_RECV_OP);
731
732 xpt_cmd = kzalloc(sizeof(struct xcopy_pt_cmd), GFP_KERNEL);
733 if (!xpt_cmd) {
734 pr_err("Unable to allocate xcopy_pt_cmd\n");
735 return -ENOMEM;
736 }
737 init_completion(&xpt_cmd->xpt_passthrough_sem);
738 se_cmd = &xpt_cmd->se_cmd;
739
740 memset(&cdb[0], 0, 16);
741 cdb[0] = WRITE_16;
742 put_unaligned_be64(dst_lba, &cdb[2]);
743 put_unaligned_be32(dst_sectors, &cdb[10]);
744 pr_debug("XCOPY: Built WRITE_16: LBA: %llu Sectors: %u Length: %u\n",
745 (unsigned long long)dst_lba, dst_sectors, length);
746
747 transport_init_se_cmd(se_cmd, &xcopy_pt_tfo, &xcopy_pt_sess, length,
748 DMA_TO_DEVICE, 0, &xpt_cmd->sense_buffer[0]);
749 xop->dst_pt_cmd = xpt_cmd;
750
751 rc = target_xcopy_setup_pt_cmd(xpt_cmd, xop, dst_dev, &cdb[0],
752 remote_port, false);
753 if (rc < 0) {
754 struct se_cmd *src_cmd = &xop->src_pt_cmd->se_cmd;
755 ec_cmd->scsi_status = xpt_cmd->se_cmd.scsi_status;
756 /*
757 * If the failure happened before the t_mem_list hand-off in
758 * target_xcopy_setup_pt_cmd(), Reset memory + clear flag so that
759 * core releases this memory on error during X-COPY WRITE I/O.
760 */
761 src_cmd->se_cmd_flags &= ~SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC;
762 src_cmd->t_data_sg = xop->xop_data_sg;
763 src_cmd->t_data_nents = xop->xop_data_nents;
764
765 transport_generic_free_cmd(se_cmd, 0);
766 return rc;
767 }
768
769 rc = target_xcopy_issue_pt_cmd(xpt_cmd);
770 if (rc < 0) {
771 ec_cmd->scsi_status = xpt_cmd->se_cmd.scsi_status;
772 se_cmd->se_cmd_flags &= ~SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC;
773 transport_generic_free_cmd(se_cmd, 0);
774 return rc;
775 }
776
777 return 0;
778}
779
780static void target_xcopy_do_work(struct work_struct *work)
781{
782 struct xcopy_op *xop = container_of(work, struct xcopy_op, xop_work);
783 struct se_cmd *ec_cmd = xop->xop_se_cmd;
784 struct se_device *src_dev, *dst_dev;
785 sector_t src_lba, dst_lba, end_lba;
786 unsigned int max_sectors;
787 int rc = 0;
788 unsigned short nolb, cur_nolb, max_nolb, copied_nolb = 0;
789
790 if (target_parse_xcopy_cmd(xop) != TCM_NO_SENSE)
791 goto err_free;
792
793 if (WARN_ON_ONCE(!xop->src_dev) || WARN_ON_ONCE(!xop->dst_dev))
794 goto err_free;
795
796 src_dev = xop->src_dev;
797 dst_dev = xop->dst_dev;
798 src_lba = xop->src_lba;
799 dst_lba = xop->dst_lba;
800 nolb = xop->nolb;
801 end_lba = src_lba + nolb;
802 /*
803 * Break up XCOPY I/O into hw_max_sectors sized I/O based on the
804 * smallest max_sectors between src_dev + dev_dev, or
805 */
806 max_sectors = min(src_dev->dev_attrib.hw_max_sectors,
807 dst_dev->dev_attrib.hw_max_sectors);
808 max_sectors = min_t(u32, max_sectors, XCOPY_MAX_SECTORS);
809
810 max_nolb = min_t(u16, max_sectors, ((u16)(~0U)));
811
812 pr_debug("target_xcopy_do_work: nolb: %hu, max_nolb: %hu end_lba: %llu\n",
813 nolb, max_nolb, (unsigned long long)end_lba);
814 pr_debug("target_xcopy_do_work: Starting src_lba: %llu, dst_lba: %llu\n",
815 (unsigned long long)src_lba, (unsigned long long)dst_lba);
816
817 while (src_lba < end_lba) {
818 cur_nolb = min(nolb, max_nolb);
819
820 pr_debug("target_xcopy_do_work: Calling read src_dev: %p src_lba: %llu,"
821 " cur_nolb: %hu\n", src_dev, (unsigned long long)src_lba, cur_nolb);
822
823 rc = target_xcopy_read_source(ec_cmd, xop, src_dev, src_lba, cur_nolb);
824 if (rc < 0)
825 goto out;
826
827 src_lba += cur_nolb;
828 pr_debug("target_xcopy_do_work: Incremented READ src_lba to %llu\n",
829 (unsigned long long)src_lba);
830
831 pr_debug("target_xcopy_do_work: Calling write dst_dev: %p dst_lba: %llu,"
832 " cur_nolb: %hu\n", dst_dev, (unsigned long long)dst_lba, cur_nolb);
833
834 rc = target_xcopy_write_destination(ec_cmd, xop, dst_dev,
835 dst_lba, cur_nolb);
836 if (rc < 0) {
837 transport_generic_free_cmd(&xop->src_pt_cmd->se_cmd, 0);
838 goto out;
839 }
840
841 dst_lba += cur_nolb;
842 pr_debug("target_xcopy_do_work: Incremented WRITE dst_lba to %llu\n",
843 (unsigned long long)dst_lba);
844
845 copied_nolb += cur_nolb;
846 nolb -= cur_nolb;
847
848 transport_generic_free_cmd(&xop->src_pt_cmd->se_cmd, 0);
849 xop->dst_pt_cmd->se_cmd.se_cmd_flags &= ~SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC;
850
851 transport_generic_free_cmd(&xop->dst_pt_cmd->se_cmd, 0);
852 }
853
854 xcopy_pt_undepend_remotedev(xop);
855 kfree(xop);
856
857 pr_debug("target_xcopy_do_work: Final src_lba: %llu, dst_lba: %llu\n",
858 (unsigned long long)src_lba, (unsigned long long)dst_lba);
859 pr_debug("target_xcopy_do_work: Blocks copied: %hu, Bytes Copied: %u\n",
860 copied_nolb, copied_nolb * dst_dev->dev_attrib.block_size);
861
862 pr_debug("target_xcopy_do_work: Setting X-COPY GOOD status -> sending response\n");
863 target_complete_cmd(ec_cmd, SAM_STAT_GOOD);
864 return;
865
866out:
867 xcopy_pt_undepend_remotedev(xop);
868
869err_free:
870 kfree(xop);
871 /*
872 * Don't override an error scsi status if it has already been set
873 */
874 if (ec_cmd->scsi_status == SAM_STAT_GOOD) {
875 pr_warn_ratelimited("target_xcopy_do_work: rc: %d, Setting X-COPY"
876 " CHECK_CONDITION -> sending response\n", rc);
877 ec_cmd->scsi_status = SAM_STAT_CHECK_CONDITION;
878 }
879 target_complete_cmd(ec_cmd, ec_cmd->scsi_status);
880}
881
882/*
883 * Returns TCM_NO_SENSE upon success or a sense code != TCM_NO_SENSE if parsing
884 * fails.
885 */
886static sense_reason_t target_parse_xcopy_cmd(struct xcopy_op *xop)
887{
888 struct se_cmd *se_cmd = xop->xop_se_cmd;
889 unsigned char *p = NULL, *seg_desc;
890 unsigned int list_id, list_id_usage, sdll, inline_dl;
891 sense_reason_t ret = TCM_INVALID_PARAMETER_LIST;
892 int rc;
893 unsigned short tdll;
894
895 p = transport_kmap_data_sg(se_cmd);
896 if (!p) {
897 pr_err("transport_kmap_data_sg() failed in target_do_xcopy\n");
898 return TCM_OUT_OF_RESOURCES;
899 }
900
901 list_id = p[0];
902 list_id_usage = (p[1] & 0x18) >> 3;
903
904 /*
905 * Determine TARGET DESCRIPTOR LIST LENGTH + SEGMENT DESCRIPTOR LIST LENGTH
906 */
907 tdll = get_unaligned_be16(&p[2]);
908 sdll = get_unaligned_be32(&p[8]);
909 if (tdll + sdll > RCR_OP_MAX_DESC_LIST_LEN) {
910 pr_err("XCOPY descriptor list length %u exceeds maximum %u\n",
911 tdll + sdll, RCR_OP_MAX_DESC_LIST_LEN);
912 ret = TCM_PARAMETER_LIST_LENGTH_ERROR;
913 goto out;
914 }
915
916 inline_dl = get_unaligned_be32(&p[12]);
917 if (inline_dl != 0) {
918 pr_err("XCOPY with non zero inline data length\n");
919 goto out;
920 }
921
922 if (se_cmd->data_length < (XCOPY_HDR_LEN + tdll + sdll + inline_dl)) {
923 pr_err("XCOPY parameter truncation: data length %u too small "
924 "for tdll: %hu sdll: %u inline_dl: %u\n",
925 se_cmd->data_length, tdll, sdll, inline_dl);
926 ret = TCM_PARAMETER_LIST_LENGTH_ERROR;
927 goto out;
928 }
929
930 pr_debug("Processing XCOPY with list_id: 0x%02x list_id_usage: 0x%02x"
931 " tdll: %hu sdll: %u inline_dl: %u\n", list_id, list_id_usage,
932 tdll, sdll, inline_dl);
933
934 /*
935 * skip over the target descriptors until segment descriptors
936 * have been passed - CSCD ids are needed to determine src and dest.
937 */
938 seg_desc = &p[16] + tdll;
939
940 rc = target_xcopy_parse_segment_descriptors(se_cmd, xop, seg_desc,
941 sdll, &ret);
942 if (rc <= 0)
943 goto out;
944
945 pr_debug("XCOPY: Processed %d segment descriptors, length: %u\n", rc,
946 rc * XCOPY_SEGMENT_DESC_LEN);
947
948 rc = target_xcopy_parse_target_descriptors(se_cmd, xop, &p[16], tdll, &ret);
949 if (rc <= 0)
950 goto out;
951
952 if (xop->src_dev->dev_attrib.block_size !=
953 xop->dst_dev->dev_attrib.block_size) {
954 pr_err("XCOPY: Non matching src_dev block_size: %u + dst_dev"
955 " block_size: %u currently unsupported\n",
956 xop->src_dev->dev_attrib.block_size,
957 xop->dst_dev->dev_attrib.block_size);
958 xcopy_pt_undepend_remotedev(xop);
959 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
960 goto out;
961 }
962
963 pr_debug("XCOPY: Processed %d target descriptors, length: %u\n", rc,
964 rc * XCOPY_TARGET_DESC_LEN);
965 transport_kunmap_data_sg(se_cmd);
966 return TCM_NO_SENSE;
967
968out:
969 if (p)
970 transport_kunmap_data_sg(se_cmd);
971 return ret;
972}
973
974sense_reason_t target_do_xcopy(struct se_cmd *se_cmd)
975{
976 struct se_device *dev = se_cmd->se_dev;
977 struct xcopy_op *xop;
978 unsigned int sa;
979
980 if (!dev->dev_attrib.emulate_3pc) {
981 pr_err("EXTENDED_COPY operation explicitly disabled\n");
982 return TCM_UNSUPPORTED_SCSI_OPCODE;
983 }
984
985 sa = se_cmd->t_task_cdb[1] & 0x1f;
986 if (sa != 0x00) {
987 pr_err("EXTENDED_COPY(LID4) not supported\n");
988 return TCM_UNSUPPORTED_SCSI_OPCODE;
989 }
990
991 if (se_cmd->data_length == 0) {
992 target_complete_cmd(se_cmd, SAM_STAT_GOOD);
993 return TCM_NO_SENSE;
994 }
995 if (se_cmd->data_length < XCOPY_HDR_LEN) {
996 pr_err("XCOPY parameter truncation: length %u < hdr_len %u\n",
997 se_cmd->data_length, XCOPY_HDR_LEN);
998 return TCM_PARAMETER_LIST_LENGTH_ERROR;
999 }
1000
1001 xop = kzalloc(sizeof(struct xcopy_op), GFP_KERNEL);
1002 if (!xop)
1003 goto err;
1004 xop->xop_se_cmd = se_cmd;
1005 INIT_WORK(&xop->xop_work, target_xcopy_do_work);
1006 if (WARN_ON_ONCE(!queue_work(xcopy_wq, &xop->xop_work)))
1007 goto free;
1008 return TCM_NO_SENSE;
1009
1010free:
1011 kfree(xop);
1012
1013err:
1014 return TCM_OUT_OF_RESOURCES;
1015}
1016
1017static sense_reason_t target_rcr_operating_parameters(struct se_cmd *se_cmd)
1018{
1019 unsigned char *p;
1020
1021 p = transport_kmap_data_sg(se_cmd);
1022 if (!p) {
1023 pr_err("transport_kmap_data_sg failed in"
1024 " target_rcr_operating_parameters\n");
1025 return TCM_OUT_OF_RESOURCES;
1026 }
1027
1028 if (se_cmd->data_length < 54) {
1029 pr_err("Receive Copy Results Op Parameters length"
1030 " too small: %u\n", se_cmd->data_length);
1031 transport_kunmap_data_sg(se_cmd);
1032 return TCM_INVALID_CDB_FIELD;
1033 }
1034 /*
1035 * Set SNLID=1 (Supports no List ID)
1036 */
1037 p[4] = 0x1;
1038 /*
1039 * MAXIMUM TARGET DESCRIPTOR COUNT
1040 */
1041 put_unaligned_be16(RCR_OP_MAX_TARGET_DESC_COUNT, &p[8]);
1042 /*
1043 * MAXIMUM SEGMENT DESCRIPTOR COUNT
1044 */
1045 put_unaligned_be16(RCR_OP_MAX_SG_DESC_COUNT, &p[10]);
1046 /*
1047 * MAXIMUM DESCRIPTOR LIST LENGTH
1048 */
1049 put_unaligned_be32(RCR_OP_MAX_DESC_LIST_LEN, &p[12]);
1050 /*
1051 * MAXIMUM SEGMENT LENGTH
1052 */
1053 put_unaligned_be32(RCR_OP_MAX_SEGMENT_LEN, &p[16]);
1054 /*
1055 * MAXIMUM INLINE DATA LENGTH for SA 0x04 (NOT SUPPORTED)
1056 */
1057 put_unaligned_be32(0x0, &p[20]);
1058 /*
1059 * HELD DATA LIMIT
1060 */
1061 put_unaligned_be32(0x0, &p[24]);
1062 /*
1063 * MAXIMUM STREAM DEVICE TRANSFER SIZE
1064 */
1065 put_unaligned_be32(0x0, &p[28]);
1066 /*
1067 * TOTAL CONCURRENT COPIES
1068 */
1069 put_unaligned_be16(RCR_OP_TOTAL_CONCURR_COPIES, &p[34]);
1070 /*
1071 * MAXIMUM CONCURRENT COPIES
1072 */
1073 p[36] = RCR_OP_MAX_CONCURR_COPIES;
1074 /*
1075 * DATA SEGMENT GRANULARITY (log 2)
1076 */
1077 p[37] = RCR_OP_DATA_SEG_GRAN_LOG2;
1078 /*
1079 * INLINE DATA GRANULARITY log 2)
1080 */
1081 p[38] = RCR_OP_INLINE_DATA_GRAN_LOG2;
1082 /*
1083 * HELD DATA GRANULARITY
1084 */
1085 p[39] = RCR_OP_HELD_DATA_GRAN_LOG2;
1086 /*
1087 * IMPLEMENTED DESCRIPTOR LIST LENGTH
1088 */
1089 p[43] = 0x2;
1090 /*
1091 * List of implemented descriptor type codes (ordered)
1092 */
1093 p[44] = 0x02; /* Copy Block to Block device */
1094 p[45] = 0xe4; /* Identification descriptor target descriptor */
1095
1096 /*
1097 * AVAILABLE DATA (n-3)
1098 */
1099 put_unaligned_be32(42, &p[0]);
1100
1101 transport_kunmap_data_sg(se_cmd);
1102 target_complete_cmd(se_cmd, GOOD);
1103
1104 return TCM_NO_SENSE;
1105}
1106
1107sense_reason_t target_do_receive_copy_results(struct se_cmd *se_cmd)
1108{
1109 unsigned char *cdb = &se_cmd->t_task_cdb[0];
1110 int sa = (cdb[1] & 0x1f), list_id = cdb[2];
1111 sense_reason_t rc = TCM_NO_SENSE;
1112
1113 pr_debug("Entering target_do_receive_copy_results: SA: 0x%02x, List ID:"
1114 " 0x%02x, AL: %u\n", sa, list_id, se_cmd->data_length);
1115
1116 if (list_id != 0) {
1117 pr_err("Receive Copy Results with non zero list identifier"
1118 " not supported\n");
1119 return TCM_INVALID_CDB_FIELD;
1120 }
1121
1122 switch (sa) {
1123 case RCR_SA_OPERATING_PARAMETERS:
1124 rc = target_rcr_operating_parameters(se_cmd);
1125 break;
1126 case RCR_SA_COPY_STATUS:
1127 case RCR_SA_RECEIVE_DATA:
1128 case RCR_SA_FAILED_SEGMENT_DETAILS:
1129 default:
1130 pr_err("Unsupported SA for receive copy results: 0x%02x\n", sa);
1131 return TCM_INVALID_CDB_FIELD;
1132 }
1133
1134 return rc;
1135}
1136