1 /*******************************************************************************
2 * Filename: target_core_xcopy.c
4 * This file contains support for SPC-4 Extended-Copy offload with generic
7 * Copyright (c) 2011-2013 Datera, Inc. All rights reserved.
10 * Nicholas A. Bellinger <nab@daterainc.com>
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.
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.
22 ******************************************************************************/
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>
32 #include <target/target_core_base.h>
33 #include <target/target_core_backend.h>
34 #include <target/target_core_fabric.h>
36 #include "target_core_internal.h"
37 #include "target_core_pr.h"
38 #include "target_core_ua.h"
39 #include "target_core_xcopy.h"
41 static struct workqueue_struct *xcopy_wq = NULL;
43 static sense_reason_t target_parse_xcopy_cmd(struct xcopy_op *xop);
45 static int target_xcopy_gen_naa_ieee(struct se_device *dev, unsigned char *buf)
49 buf[off++] = (0x6 << 4);
52 buf[off] = (0x5 << 4);
54 spc_parse_naa_6h_vendor_specific(dev, &buf[off]);
58 struct xcopy_dev_search_info {
59 const unsigned char *dev_wwn;
60 struct se_device *found_dev;
63 static int target_xcopy_locate_se_dev_e4_iter(struct se_device *se_dev,
66 struct xcopy_dev_search_info *info = data;
67 unsigned char tmp_dev_wwn[XCOPY_NAA_IEEE_REGEX_LEN];
70 if (!se_dev->dev_attrib.emulate_3pc)
73 memset(&tmp_dev_wwn[0], 0, XCOPY_NAA_IEEE_REGEX_LEN);
74 target_xcopy_gen_naa_ieee(se_dev, &tmp_dev_wwn[0]);
76 rc = memcmp(&tmp_dev_wwn[0], info->dev_wwn, XCOPY_NAA_IEEE_REGEX_LEN);
80 info->found_dev = se_dev;
81 pr_debug("XCOPY 0xe4: located se_dev: %p\n", se_dev);
83 rc = target_depend_item(&se_dev->dev_group.cg_item);
85 pr_err("configfs_depend_item attempt failed: %d for se_dev: %p\n",
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);
95 static int target_xcopy_locate_se_dev_e4(const unsigned char *dev_wwn,
96 struct se_device **found_dev)
98 struct xcopy_dev_search_info info;
101 memset(&info, 0, sizeof(info));
102 info.dev_wwn = dev_wwn;
104 ret = target_for_each_device(target_xcopy_locate_se_dev_e4_iter, &info);
106 *found_dev = info.found_dev;
109 pr_debug_ratelimited("Unable to locate 0xe4 descriptor for EXTENDED_COPY\n");
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)
117 unsigned char *desc = p;
121 * Extract RELATIVE INITIATOR PORT IDENTIFIER
123 ript = get_unaligned_be16(&desc[2]);
124 pr_debug("XCOPY 0xe4: RELATIVE INITIATOR PORT IDENTIFIER: %hu\n", ript);
126 * Check for supported code set, association, and designator type
128 if ((desc[4] & 0x0f) != 0x1) {
129 pr_err("XCOPY 0xe4: code set of non binary type not supported\n");
132 if ((desc[5] & 0x30) != 0x00) {
133 pr_err("XCOPY 0xe4: association other than LUN not supported\n");
136 if ((desc[5] & 0x0f) != 0x3) {
137 pr_err("XCOPY 0xe4: designator type unsupported: 0x%02x\n",
142 * Check for matching 16 byte length for NAA IEEE Registered Extended
143 * Assigned designator
146 if (desig_len != 16) {
147 pr_err("XCOPY 0xe4: invalid desig_len: %d\n", (int)desig_len);
150 pr_debug("XCOPY 0xe4: desig_len: %d\n", (int)desig_len);
152 * Check for NAA IEEE Registered Extended Assigned header..
154 if ((desc[8] & 0xf0) != 0x60) {
155 pr_err("XCOPY 0xe4: Unsupported DESIGNATOR TYPE: 0x%02x\n",
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);
166 if (cscd_index == xop->stdi) {
167 memcpy(&xop->src_tid_wwn[0], &desc[8], XCOPY_NAA_IEEE_REGEX_LEN);
169 * Determine if the source designator matches the local device
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);
180 if (cscd_index == xop->dtdi) {
181 memcpy(&xop->dst_tid_wwn[0], &desc[8], XCOPY_NAA_IEEE_REGEX_LEN);
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.
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);
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)
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;
210 *sense_ret = TCM_INVALID_PARAMETER_LIST;
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;
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;
226 * Generate an IEEE Registered Extended designator based upon the
227 * se_device the XCOPY was received upon..
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]);
232 while (start < tdll) {
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 ..
240 rc = target_xcopy_parse_tiddesc_e4(se_cmd, xop,
241 &desc[0], cscd_index);
244 start += XCOPY_TARGET_DESC_LEN;
245 desc += XCOPY_TARGET_DESC_LEN;
249 pr_err("XCOPY unsupported descriptor type code:"
250 " 0x%02x\n", desc[0]);
251 *sense_ret = TCM_UNSUPPORTED_TARGET_DESC_TYPE_CODE;
256 switch (xop->op_origin) {
257 case XCOL_SOURCE_RECV_OP:
258 rc = target_xcopy_locate_se_dev_e4(xop->dst_tid_wwn,
261 case XCOL_DEST_RECV_OP:
262 rc = target_xcopy_locate_se_dev_e4(xop->src_tid_wwn,
266 pr_err("XCOPY CSCD descriptor IDs not found in CSCD list - "
267 "stdi: %hu dtdi: %hu\n", xop->stdi, xop->dtdi);
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.
278 *sense_ret = TCM_COPY_TARGET_DEVICE_NOT_REACHABLE;
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]);
293 static int target_xcopy_parse_segdesc_02(struct se_cmd *se_cmd, struct xcopy_op *xop,
296 unsigned char *desc = p;
297 int dc = (desc[1] & 0x02);
298 unsigned short desc_len;
300 desc_len = get_unaligned_be16(&desc[2]);
301 if (desc_len != 0x18) {
302 pr_err("XCOPY segment desc 0x02: Illegal desc_len:"
307 xop->stdi = get_unaligned_be16(&desc[4]);
308 xop->dtdi = get_unaligned_be16(&desc[6]);
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);
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);
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);
328 xop->dbl = get_unaligned_be24(&desc[29]);
330 pr_debug("XCOPY seg desc 0x02: DC=1 w/ dbl: %u\n", xop->dbl);
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)
339 unsigned char *desc = p;
340 unsigned int start = 0;
341 int offset = sdll % XCOPY_SEGMENT_DESC_LEN, rc, ret = 0;
343 *sense_ret = TCM_INVALID_PARAMETER_LIST;
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;
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;
359 while (start < sdll) {
361 * Check segment descriptor type code for block -> block
365 rc = target_xcopy_parse_segdesc_02(se_cmd, xop, desc);
370 start += XCOPY_SEGMENT_DESC_LEN;
371 desc += XCOPY_SEGMENT_DESC_LEN;
374 pr_err("XCOPY unsupported segment descriptor"
375 "type: 0x%02x\n", desc[0]);
376 *sense_ret = TCM_UNSUPPORTED_SEGMENT_DESC_TYPE_CODE;
391 struct xcopy_pt_cmd {
393 struct se_cmd se_cmd;
394 struct completion xpt_passthrough_sem;
395 unsigned char sense_buffer[TRANSPORT_SENSE_BUFFER];
398 struct se_portal_group xcopy_pt_tpg;
399 static struct se_session xcopy_pt_sess;
400 static struct se_node_acl xcopy_pt_nacl;
402 static int xcopy_pt_get_cmd_state(struct se_cmd *se_cmd)
407 static void xcopy_pt_undepend_remotedev(struct xcopy_op *xop)
409 struct se_device *remote_dev;
411 if (xop->op_origin == XCOL_SOURCE_RECV_OP)
412 remote_dev = xop->dst_dev;
414 remote_dev = xop->src_dev;
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);
420 target_undepend_item(&remote_dev->dev_group.cg_item);
423 static void xcopy_pt_release_cmd(struct se_cmd *se_cmd)
425 struct xcopy_pt_cmd *xpt_cmd = container_of(se_cmd,
426 struct xcopy_pt_cmd, se_cmd);
431 static int xcopy_pt_check_stop_free(struct se_cmd *se_cmd)
433 struct xcopy_pt_cmd *xpt_cmd = container_of(se_cmd,
434 struct xcopy_pt_cmd, se_cmd);
436 complete(&xpt_cmd->xpt_passthrough_sem);
440 static int xcopy_pt_write_pending(struct se_cmd *se_cmd)
445 static int xcopy_pt_queue_data_in(struct se_cmd *se_cmd)
450 static int xcopy_pt_queue_status(struct se_cmd *se_cmd)
455 static 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,
469 int target_xcopy_setup_pt(void)
473 xcopy_wq = alloc_workqueue("xcopy_wq", WQ_MEM_RECLAIM, 0);
475 pr_err("Unable to allocate xcopy_wq\n");
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);
484 xcopy_pt_tpg.se_tpg_tfo = &xcopy_pt_tfo;
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);
494 xcopy_pt_nacl.se_tpg = &xcopy_pt_tpg;
495 xcopy_pt_nacl.nacl_sess = &xcopy_pt_sess;
497 xcopy_pt_sess.se_tpg = &xcopy_pt_tpg;
498 xcopy_pt_sess.se_node_acl = &xcopy_pt_nacl;
503 void target_xcopy_release_pt(void)
506 destroy_workqueue(xcopy_wq);
509 static void target_xcopy_setup_pt_port(
510 struct xcopy_pt_cmd *xpt_cmd,
511 struct xcopy_op *xop,
514 struct se_cmd *ec_cmd = xop->xop_se_cmd;
515 struct se_cmd *pt_cmd = &xpt_cmd->se_cmd;
517 if (xop->op_origin == XCOL_SOURCE_RECV_OP) {
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.
524 xpt_cmd->remote_port = remote_port;
526 pt_cmd->se_lun = ec_cmd->se_lun;
527 pt_cmd->se_dev = ec_cmd->se_dev;
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",
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
543 xpt_cmd->remote_port = remote_port;
545 pt_cmd->se_lun = ec_cmd->se_lun;
546 pt_cmd->se_dev = ec_cmd->se_dev;
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",
557 static void target_xcopy_init_pt_lun(struct se_device *se_dev,
558 struct se_cmd *pt_cmd, bool remote_port)
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()
566 pr_debug("Setup emulated se_dev: %p from se_dev\n",
568 pt_cmd->se_lun = &se_dev->xcopy_lun;
569 pt_cmd->se_dev = se_dev;
572 pt_cmd->se_cmd_flags |= SCF_SE_LUN_CMD;
575 static int target_xcopy_setup_pt_cmd(
576 struct xcopy_pt_cmd *xpt_cmd,
577 struct xcopy_op *xop,
578 struct se_device *se_dev,
583 struct se_cmd *cmd = &xpt_cmd->se_cmd;
584 sense_reason_t sense_rc;
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.
590 target_xcopy_init_pt_lun(se_dev, cmd, remote_port);
591 target_xcopy_setup_pt_port(xpt_cmd, xop, remote_port);
594 sense_rc = target_setup_cmd_from_cdb(cmd, cdb);
601 rc = target_alloc_sgl(&cmd->t_data_sg, &cmd->t_data_nents,
602 cmd->data_length, false, false);
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()..
612 cmd->se_cmd_flags |= SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC;
615 * Here the previously allocated SGLs for the internal READ
616 * are mapped zero-copy to the internal WRITE.
618 sense_rc = transport_generic_map_mem_to_cmd(cmd,
619 xop->xop_data_sg, xop->xop_data_nents,
626 pr_debug("Setup PASSTHROUGH_NOALLOC t_data_sg: %p t_data_nents:"
627 " %u\n", cmd->t_data_sg, cmd->t_data_nents);
636 static int target_xcopy_issue_pt_cmd(struct xcopy_pt_cmd *xpt_cmd)
638 struct se_cmd *se_cmd = &xpt_cmd->se_cmd;
639 sense_reason_t sense_rc;
641 sense_rc = transport_generic_new_cmd(se_cmd);
645 if (se_cmd->data_direction == DMA_TO_DEVICE)
646 target_execute_cmd(se_cmd);
648 wait_for_completion_interruptible(&xpt_cmd->xpt_passthrough_sem);
650 pr_debug("target_xcopy_issue_pt_cmd(): SCSI status: 0x%02x\n",
651 se_cmd->scsi_status);
653 return (se_cmd->scsi_status) ? -EINVAL : 0;
656 static int target_xcopy_read_source(
657 struct se_cmd *ec_cmd,
658 struct xcopy_op *xop,
659 struct se_device *src_dev,
663 struct xcopy_pt_cmd *xpt_cmd;
664 struct se_cmd *se_cmd;
665 u32 length = (src_sectors * src_dev->dev_attrib.block_size);
667 unsigned char cdb[16];
668 bool remote_port = (xop->op_origin == XCOL_DEST_RECV_OP);
670 xpt_cmd = kzalloc(sizeof(struct xcopy_pt_cmd), GFP_KERNEL);
672 pr_err("Unable to allocate xcopy_pt_cmd\n");
675 init_completion(&xpt_cmd->xpt_passthrough_sem);
676 se_cmd = &xpt_cmd->se_cmd;
678 memset(&cdb[0], 0, 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);
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;
689 rc = target_xcopy_setup_pt_cmd(xpt_cmd, xop, src_dev, &cdb[0],
692 ec_cmd->scsi_status = xpt_cmd->se_cmd.scsi_status;
693 transport_generic_free_cmd(se_cmd, 0);
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);
702 rc = target_xcopy_issue_pt_cmd(xpt_cmd);
704 ec_cmd->scsi_status = xpt_cmd->se_cmd.scsi_status;
705 transport_generic_free_cmd(se_cmd, 0);
709 * Clear off the allocated t_data_sg, that has been saved for
710 * zero-copy WRITE submission reuse in struct xcopy_op..
712 se_cmd->t_data_sg = NULL;
713 se_cmd->t_data_nents = 0;
718 static int target_xcopy_write_destination(
719 struct se_cmd *ec_cmd,
720 struct xcopy_op *xop,
721 struct se_device *dst_dev,
725 struct xcopy_pt_cmd *xpt_cmd;
726 struct se_cmd *se_cmd;
727 u32 length = (dst_sectors * dst_dev->dev_attrib.block_size);
729 unsigned char cdb[16];
730 bool remote_port = (xop->op_origin == XCOL_SOURCE_RECV_OP);
732 xpt_cmd = kzalloc(sizeof(struct xcopy_pt_cmd), GFP_KERNEL);
734 pr_err("Unable to allocate xcopy_pt_cmd\n");
737 init_completion(&xpt_cmd->xpt_passthrough_sem);
738 se_cmd = &xpt_cmd->se_cmd;
740 memset(&cdb[0], 0, 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);
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;
751 rc = target_xcopy_setup_pt_cmd(xpt_cmd, xop, dst_dev, &cdb[0],
754 struct se_cmd *src_cmd = &xop->src_pt_cmd->se_cmd;
755 ec_cmd->scsi_status = xpt_cmd->se_cmd.scsi_status;
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.
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;
765 transport_generic_free_cmd(se_cmd, 0);
769 rc = target_xcopy_issue_pt_cmd(xpt_cmd);
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);
780 static void target_xcopy_do_work(struct work_struct *work)
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;
788 unsigned short nolb, cur_nolb, max_nolb, copied_nolb = 0;
790 if (target_parse_xcopy_cmd(xop) != TCM_NO_SENSE)
793 if (WARN_ON_ONCE(!xop->src_dev) || WARN_ON_ONCE(!xop->dst_dev))
796 src_dev = xop->src_dev;
797 dst_dev = xop->dst_dev;
798 src_lba = xop->src_lba;
799 dst_lba = xop->dst_lba;
801 end_lba = src_lba + nolb;
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
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);
810 max_nolb = min_t(u16, max_sectors, ((u16)(~0U)));
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);
817 while (src_lba < end_lba) {
818 cur_nolb = min(nolb, max_nolb);
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);
823 rc = target_xcopy_read_source(ec_cmd, xop, src_dev, src_lba, cur_nolb);
828 pr_debug("target_xcopy_do_work: Incremented READ src_lba to %llu\n",
829 (unsigned long long)src_lba);
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);
834 rc = target_xcopy_write_destination(ec_cmd, xop, dst_dev,
837 transport_generic_free_cmd(&xop->src_pt_cmd->se_cmd, 0);
842 pr_debug("target_xcopy_do_work: Incremented WRITE dst_lba to %llu\n",
843 (unsigned long long)dst_lba);
845 copied_nolb += cur_nolb;
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;
851 transport_generic_free_cmd(&xop->dst_pt_cmd->se_cmd, 0);
854 xcopy_pt_undepend_remotedev(xop);
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);
862 pr_debug("target_xcopy_do_work: Setting X-COPY GOOD status -> sending response\n");
863 target_complete_cmd(ec_cmd, SAM_STAT_GOOD);
867 xcopy_pt_undepend_remotedev(xop);
872 * Don't override an error scsi status if it has already been set
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;
879 target_complete_cmd(ec_cmd, ec_cmd->scsi_status);
883 * Returns TCM_NO_SENSE upon success or a sense code != TCM_NO_SENSE if parsing
886 static sense_reason_t target_parse_xcopy_cmd(struct xcopy_op *xop)
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;
895 p = transport_kmap_data_sg(se_cmd);
897 pr_err("transport_kmap_data_sg() failed in target_do_xcopy\n");
898 return TCM_OUT_OF_RESOURCES;
902 list_id_usage = (p[1] & 0x18) >> 3;
905 * Determine TARGET DESCRIPTOR LIST LENGTH + SEGMENT DESCRIPTOR LIST LENGTH
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;
916 inline_dl = get_unaligned_be32(&p[12]);
917 if (inline_dl != 0) {
918 pr_err("XCOPY with non zero inline data length\n");
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;
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);
935 * skip over the target descriptors until segment descriptors
936 * have been passed - CSCD ids are needed to determine src and dest.
938 seg_desc = &p[16] + tdll;
940 rc = target_xcopy_parse_segment_descriptors(se_cmd, xop, seg_desc,
945 pr_debug("XCOPY: Processed %d segment descriptors, length: %u\n", rc,
946 rc * XCOPY_SEGMENT_DESC_LEN);
948 rc = target_xcopy_parse_target_descriptors(se_cmd, xop, &p[16], tdll, &ret);
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;
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);
970 transport_kunmap_data_sg(se_cmd);
974 sense_reason_t target_do_xcopy(struct se_cmd *se_cmd)
976 struct se_device *dev = se_cmd->se_dev;
977 struct xcopy_op *xop;
980 if (!dev->dev_attrib.emulate_3pc) {
981 pr_err("EXTENDED_COPY operation explicitly disabled\n");
982 return TCM_UNSUPPORTED_SCSI_OPCODE;
985 sa = se_cmd->t_task_cdb[1] & 0x1f;
987 pr_err("EXTENDED_COPY(LID4) not supported\n");
988 return TCM_UNSUPPORTED_SCSI_OPCODE;
991 if (se_cmd->data_length == 0) {
992 target_complete_cmd(se_cmd, SAM_STAT_GOOD);
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;
1001 xop = kzalloc(sizeof(struct xcopy_op), GFP_KERNEL);
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)))
1008 return TCM_NO_SENSE;
1014 return TCM_OUT_OF_RESOURCES;
1017 static sense_reason_t target_rcr_operating_parameters(struct se_cmd *se_cmd)
1021 p = transport_kmap_data_sg(se_cmd);
1023 pr_err("transport_kmap_data_sg failed in"
1024 " target_rcr_operating_parameters\n");
1025 return TCM_OUT_OF_RESOURCES;
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;
1035 * Set SNLID=1 (Supports no List ID)
1039 * MAXIMUM TARGET DESCRIPTOR COUNT
1041 put_unaligned_be16(RCR_OP_MAX_TARGET_DESC_COUNT, &p[8]);
1043 * MAXIMUM SEGMENT DESCRIPTOR COUNT
1045 put_unaligned_be16(RCR_OP_MAX_SG_DESC_COUNT, &p[10]);
1047 * MAXIMUM DESCRIPTOR LIST LENGTH
1049 put_unaligned_be32(RCR_OP_MAX_DESC_LIST_LEN, &p[12]);
1051 * MAXIMUM SEGMENT LENGTH
1053 put_unaligned_be32(RCR_OP_MAX_SEGMENT_LEN, &p[16]);
1055 * MAXIMUM INLINE DATA LENGTH for SA 0x04 (NOT SUPPORTED)
1057 put_unaligned_be32(0x0, &p[20]);
1061 put_unaligned_be32(0x0, &p[24]);
1063 * MAXIMUM STREAM DEVICE TRANSFER SIZE
1065 put_unaligned_be32(0x0, &p[28]);
1067 * TOTAL CONCURRENT COPIES
1069 put_unaligned_be16(RCR_OP_TOTAL_CONCURR_COPIES, &p[34]);
1071 * MAXIMUM CONCURRENT COPIES
1073 p[36] = RCR_OP_MAX_CONCURR_COPIES;
1075 * DATA SEGMENT GRANULARITY (log 2)
1077 p[37] = RCR_OP_DATA_SEG_GRAN_LOG2;
1079 * INLINE DATA GRANULARITY log 2)
1081 p[38] = RCR_OP_INLINE_DATA_GRAN_LOG2;
1083 * HELD DATA GRANULARITY
1085 p[39] = RCR_OP_HELD_DATA_GRAN_LOG2;
1087 * IMPLEMENTED DESCRIPTOR LIST LENGTH
1091 * List of implemented descriptor type codes (ordered)
1093 p[44] = 0x02; /* Copy Block to Block device */
1094 p[45] = 0xe4; /* Identification descriptor target descriptor */
1097 * AVAILABLE DATA (n-3)
1099 put_unaligned_be32(42, &p[0]);
1101 transport_kunmap_data_sg(se_cmd);
1102 target_complete_cmd(se_cmd, GOOD);
1104 return TCM_NO_SENSE;
1107 sense_reason_t target_do_receive_copy_results(struct se_cmd *se_cmd)
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;
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);
1117 pr_err("Receive Copy Results with non zero list identifier"
1118 " not supported\n");
1119 return TCM_INVALID_CDB_FIELD;
1123 case RCR_SA_OPERATING_PARAMETERS:
1124 rc = target_rcr_operating_parameters(se_cmd);
1126 case RCR_SA_COPY_STATUS:
1127 case RCR_SA_RECEIVE_DATA:
1128 case RCR_SA_FAILED_SEGMENT_DETAILS:
1130 pr_err("Unsupported SA for receive copy results: 0x%02x\n", sa);
1131 return TCM_INVALID_CDB_FIELD;