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]);
59 * target_xcopy_locate_se_dev_e4_iter - compare XCOPY NAA device identifiers
61 * @se_dev: device being considered for match
62 * @dev_wwn: XCOPY requested NAA dev_wwn
63 * @return: 1 on match, 0 on no-match
65 static int target_xcopy_locate_se_dev_e4_iter(struct se_device *se_dev,
66 const unsigned char *dev_wwn)
68 unsigned char tmp_dev_wwn[XCOPY_NAA_IEEE_REGEX_LEN];
71 if (!se_dev->dev_attrib.emulate_3pc) {
72 pr_debug("XCOPY: emulate_3pc disabled on se_dev %p\n", se_dev);
76 memset(&tmp_dev_wwn[0], 0, XCOPY_NAA_IEEE_REGEX_LEN);
77 target_xcopy_gen_naa_ieee(se_dev, &tmp_dev_wwn[0]);
79 rc = memcmp(&tmp_dev_wwn[0], dev_wwn, XCOPY_NAA_IEEE_REGEX_LEN);
81 pr_debug("XCOPY: skip non-matching: %*ph\n",
82 XCOPY_NAA_IEEE_REGEX_LEN, tmp_dev_wwn);
85 pr_debug("XCOPY 0xe4: located se_dev: %p\n", se_dev);
90 static int target_xcopy_locate_se_dev_e4(struct se_session *sess,
91 const unsigned char *dev_wwn,
92 struct se_device **_found_dev,
93 struct percpu_ref **_found_lun_ref)
95 struct se_dev_entry *deve;
96 struct se_node_acl *nacl;
97 struct se_lun *this_lun = NULL;
98 struct se_device *found_dev = NULL;
100 /* cmd with NULL sess indicates no associated $FABRIC_MOD */
104 pr_debug("XCOPY 0xe4: searching for: %*ph\n",
105 XCOPY_NAA_IEEE_REGEX_LEN, dev_wwn);
107 nacl = sess->se_node_acl;
109 hlist_for_each_entry_rcu(deve, &nacl->lun_entry_hlist, link) {
110 struct se_device *this_dev;
113 this_lun = rcu_dereference(deve->se_lun);
114 this_dev = rcu_dereference_raw(this_lun->lun_se_dev);
116 rc = target_xcopy_locate_se_dev_e4_iter(this_dev, dev_wwn);
118 if (percpu_ref_tryget_live(&this_lun->lun_ref))
119 found_dev = this_dev;
124 if (found_dev == NULL)
127 pr_debug("lun_ref held for se_dev: %p se_dev->se_dev_group: %p\n",
128 found_dev, &found_dev->dev_group);
129 *_found_dev = found_dev;
130 *_found_lun_ref = &this_lun->lun_ref;
133 pr_debug_ratelimited("Unable to locate 0xe4 descriptor for EXTENDED_COPY\n");
137 static int target_xcopy_parse_tiddesc_e4(struct se_cmd *se_cmd, struct xcopy_op *xop,
138 unsigned char *p, unsigned short cscd_index)
140 unsigned char *desc = p;
144 * Extract RELATIVE INITIATOR PORT IDENTIFIER
146 ript = get_unaligned_be16(&desc[2]);
147 pr_debug("XCOPY 0xe4: RELATIVE INITIATOR PORT IDENTIFIER: %hu\n", ript);
149 * Check for supported code set, association, and designator type
151 if ((desc[4] & 0x0f) != 0x1) {
152 pr_err("XCOPY 0xe4: code set of non binary type not supported\n");
155 if ((desc[5] & 0x30) != 0x00) {
156 pr_err("XCOPY 0xe4: association other than LUN not supported\n");
159 if ((desc[5] & 0x0f) != 0x3) {
160 pr_err("XCOPY 0xe4: designator type unsupported: 0x%02x\n",
165 * Check for matching 16 byte length for NAA IEEE Registered Extended
166 * Assigned designator
169 if (desig_len != 16) {
170 pr_err("XCOPY 0xe4: invalid desig_len: %d\n", (int)desig_len);
173 pr_debug("XCOPY 0xe4: desig_len: %d\n", (int)desig_len);
175 * Check for NAA IEEE Registered Extended Assigned header..
177 if ((desc[8] & 0xf0) != 0x60) {
178 pr_err("XCOPY 0xe4: Unsupported DESIGNATOR TYPE: 0x%02x\n",
183 if (cscd_index != xop->stdi && cscd_index != xop->dtdi) {
184 pr_debug("XCOPY 0xe4: ignoring CSCD entry %d - neither src nor "
185 "dest\n", cscd_index);
189 if (cscd_index == xop->stdi) {
190 memcpy(&xop->src_tid_wwn[0], &desc[8], XCOPY_NAA_IEEE_REGEX_LEN);
192 * Determine if the source designator matches the local device
194 if (!memcmp(&xop->local_dev_wwn[0], &xop->src_tid_wwn[0],
195 XCOPY_NAA_IEEE_REGEX_LEN)) {
196 xop->op_origin = XCOL_SOURCE_RECV_OP;
197 xop->src_dev = se_cmd->se_dev;
198 pr_debug("XCOPY 0xe4: Set xop->src_dev %p from source"
199 " received xop\n", xop->src_dev);
203 if (cscd_index == xop->dtdi) {
204 memcpy(&xop->dst_tid_wwn[0], &desc[8], XCOPY_NAA_IEEE_REGEX_LEN);
206 * Determine if the destination designator matches the local
207 * device. If @cscd_index corresponds to both source (stdi) and
208 * destination (dtdi), or dtdi comes after stdi, then
209 * XCOL_DEST_RECV_OP wins.
211 if (!memcmp(&xop->local_dev_wwn[0], &xop->dst_tid_wwn[0],
212 XCOPY_NAA_IEEE_REGEX_LEN)) {
213 xop->op_origin = XCOL_DEST_RECV_OP;
214 xop->dst_dev = se_cmd->se_dev;
215 pr_debug("XCOPY 0xe4: Set xop->dst_dev: %p from destination"
216 " received xop\n", xop->dst_dev);
223 static int target_xcopy_parse_target_descriptors(struct se_cmd *se_cmd,
224 struct xcopy_op *xop, unsigned char *p,
225 unsigned short tdll, sense_reason_t *sense_ret)
227 struct se_device *local_dev = se_cmd->se_dev;
228 unsigned char *desc = p;
229 int offset = tdll % XCOPY_TARGET_DESC_LEN, rc;
230 unsigned short cscd_index = 0;
231 unsigned short start = 0;
233 *sense_ret = TCM_INVALID_PARAMETER_LIST;
236 pr_err("XCOPY target descriptor list length is not"
237 " multiple of %d\n", XCOPY_TARGET_DESC_LEN);
238 *sense_ret = TCM_UNSUPPORTED_TARGET_DESC_TYPE_CODE;
241 if (tdll > RCR_OP_MAX_TARGET_DESC_COUNT * XCOPY_TARGET_DESC_LEN) {
242 pr_err("XCOPY target descriptor supports a maximum"
243 " two src/dest descriptors, tdll: %hu too large..\n", tdll);
244 /* spc4r37 6.4.3.4 CSCD DESCRIPTOR LIST LENGTH field */
245 *sense_ret = TCM_TOO_MANY_TARGET_DESCS;
249 * Generate an IEEE Registered Extended designator based upon the
250 * se_device the XCOPY was received upon..
252 memset(&xop->local_dev_wwn[0], 0, XCOPY_NAA_IEEE_REGEX_LEN);
253 target_xcopy_gen_naa_ieee(local_dev, &xop->local_dev_wwn[0]);
255 while (start < tdll) {
257 * Check target descriptor identification with 0xE4 type, and
258 * compare the current index with the CSCD descriptor IDs in
259 * the segment descriptor. Use VPD 0x83 WWPN matching ..
263 rc = target_xcopy_parse_tiddesc_e4(se_cmd, xop,
264 &desc[0], cscd_index);
267 start += XCOPY_TARGET_DESC_LEN;
268 desc += XCOPY_TARGET_DESC_LEN;
272 pr_err("XCOPY unsupported descriptor type code:"
273 " 0x%02x\n", desc[0]);
274 *sense_ret = TCM_UNSUPPORTED_TARGET_DESC_TYPE_CODE;
279 switch (xop->op_origin) {
280 case XCOL_SOURCE_RECV_OP:
281 rc = target_xcopy_locate_se_dev_e4(se_cmd->se_sess,
284 &xop->remote_lun_ref);
286 case XCOL_DEST_RECV_OP:
287 rc = target_xcopy_locate_se_dev_e4(se_cmd->se_sess,
290 &xop->remote_lun_ref);
293 pr_err("XCOPY CSCD descriptor IDs not found in CSCD list - "
294 "stdi: %hu dtdi: %hu\n", xop->stdi, xop->dtdi);
299 * If a matching IEEE NAA 0x83 descriptor for the requested device
300 * is not located on this node, return COPY_ABORTED with ASQ/ASQC
301 * 0x0d/0x02 - COPY_TARGET_DEVICE_NOT_REACHABLE to request the
302 * initiator to fall back to normal copy method.
305 *sense_ret = TCM_COPY_TARGET_DEVICE_NOT_REACHABLE;
309 pr_debug("XCOPY TGT desc: Source dev: %p NAA IEEE WWN: 0x%16phN\n",
310 xop->src_dev, &xop->src_tid_wwn[0]);
311 pr_debug("XCOPY TGT desc: Dest dev: %p NAA IEEE WWN: 0x%16phN\n",
312 xop->dst_dev, &xop->dst_tid_wwn[0]);
320 static int target_xcopy_parse_segdesc_02(struct se_cmd *se_cmd, struct xcopy_op *xop,
323 unsigned char *desc = p;
324 int dc = (desc[1] & 0x02);
325 unsigned short desc_len;
327 desc_len = get_unaligned_be16(&desc[2]);
328 if (desc_len != 0x18) {
329 pr_err("XCOPY segment desc 0x02: Illegal desc_len:"
334 xop->stdi = get_unaligned_be16(&desc[4]);
335 xop->dtdi = get_unaligned_be16(&desc[6]);
337 if (xop->stdi > XCOPY_CSCD_DESC_ID_LIST_OFF_MAX ||
338 xop->dtdi > XCOPY_CSCD_DESC_ID_LIST_OFF_MAX) {
339 pr_err("XCOPY segment desc 0x02: unsupported CSCD ID > 0x%x; stdi: %hu dtdi: %hu\n",
340 XCOPY_CSCD_DESC_ID_LIST_OFF_MAX, xop->stdi, xop->dtdi);
344 pr_debug("XCOPY seg desc 0x02: desc_len: %hu stdi: %hu dtdi: %hu, DC: %d\n",
345 desc_len, xop->stdi, xop->dtdi, dc);
347 xop->nolb = get_unaligned_be16(&desc[10]);
348 xop->src_lba = get_unaligned_be64(&desc[12]);
349 xop->dst_lba = get_unaligned_be64(&desc[20]);
350 pr_debug("XCOPY seg desc 0x02: nolb: %hu src_lba: %llu dst_lba: %llu\n",
351 xop->nolb, (unsigned long long)xop->src_lba,
352 (unsigned long long)xop->dst_lba);
355 xop->dbl = get_unaligned_be24(&desc[29]);
357 pr_debug("XCOPY seg desc 0x02: DC=1 w/ dbl: %u\n", xop->dbl);
362 static int target_xcopy_parse_segment_descriptors(struct se_cmd *se_cmd,
363 struct xcopy_op *xop, unsigned char *p,
364 unsigned int sdll, sense_reason_t *sense_ret)
366 unsigned char *desc = p;
367 unsigned int start = 0;
368 int offset = sdll % XCOPY_SEGMENT_DESC_LEN, rc, ret = 0;
370 *sense_ret = TCM_INVALID_PARAMETER_LIST;
373 pr_err("XCOPY segment descriptor list length is not"
374 " multiple of %d\n", XCOPY_SEGMENT_DESC_LEN);
375 *sense_ret = TCM_UNSUPPORTED_SEGMENT_DESC_TYPE_CODE;
378 if (sdll > RCR_OP_MAX_SG_DESC_COUNT * XCOPY_SEGMENT_DESC_LEN) {
379 pr_err("XCOPY supports %u segment descriptor(s), sdll: %u too"
380 " large..\n", RCR_OP_MAX_SG_DESC_COUNT, sdll);
381 /* spc4r37 6.4.3.5 SEGMENT DESCRIPTOR LIST LENGTH field */
382 *sense_ret = TCM_TOO_MANY_SEGMENT_DESCS;
386 while (start < sdll) {
388 * Check segment descriptor type code for block -> block
392 rc = target_xcopy_parse_segdesc_02(se_cmd, xop, desc);
397 start += XCOPY_SEGMENT_DESC_LEN;
398 desc += XCOPY_SEGMENT_DESC_LEN;
401 pr_err("XCOPY unsupported segment descriptor"
402 "type: 0x%02x\n", desc[0]);
403 *sense_ret = TCM_UNSUPPORTED_SEGMENT_DESC_TYPE_CODE;
418 struct xcopy_pt_cmd {
420 struct se_cmd se_cmd;
421 struct xcopy_op *xcopy_op;
422 struct completion xpt_passthrough_sem;
423 unsigned char sense_buffer[TRANSPORT_SENSE_BUFFER];
426 struct se_portal_group xcopy_pt_tpg;
427 static struct se_session xcopy_pt_sess;
428 static struct se_node_acl xcopy_pt_nacl;
430 static char *xcopy_pt_get_fabric_name(void)
435 static int xcopy_pt_get_cmd_state(struct se_cmd *se_cmd)
440 static void xcopy_pt_undepend_remotedev(struct xcopy_op *xop)
442 if (xop->op_origin == XCOL_SOURCE_RECV_OP)
443 pr_debug("putting dst lun_ref for %p\n", xop->dst_dev);
445 pr_debug("putting src lun_ref for %p\n", xop->src_dev);
447 percpu_ref_put(xop->remote_lun_ref);
450 static void xcopy_pt_release_cmd(struct se_cmd *se_cmd)
452 struct xcopy_pt_cmd *xpt_cmd = container_of(se_cmd,
453 struct xcopy_pt_cmd, se_cmd);
458 static int xcopy_pt_check_stop_free(struct se_cmd *se_cmd)
460 struct xcopy_pt_cmd *xpt_cmd = container_of(se_cmd,
461 struct xcopy_pt_cmd, se_cmd);
463 complete(&xpt_cmd->xpt_passthrough_sem);
467 static int xcopy_pt_write_pending(struct se_cmd *se_cmd)
472 static int xcopy_pt_write_pending_status(struct se_cmd *se_cmd)
477 static int xcopy_pt_queue_data_in(struct se_cmd *se_cmd)
482 static int xcopy_pt_queue_status(struct se_cmd *se_cmd)
487 static const struct target_core_fabric_ops xcopy_pt_tfo = {
488 .get_fabric_name = xcopy_pt_get_fabric_name,
489 .get_cmd_state = xcopy_pt_get_cmd_state,
490 .release_cmd = xcopy_pt_release_cmd,
491 .check_stop_free = xcopy_pt_check_stop_free,
492 .write_pending = xcopy_pt_write_pending,
493 .write_pending_status = xcopy_pt_write_pending_status,
494 .queue_data_in = xcopy_pt_queue_data_in,
495 .queue_status = xcopy_pt_queue_status,
502 int target_xcopy_setup_pt(void)
504 xcopy_wq = alloc_workqueue("xcopy_wq", WQ_MEM_RECLAIM, 0);
506 pr_err("Unable to allocate xcopy_wq\n");
510 memset(&xcopy_pt_tpg, 0, sizeof(struct se_portal_group));
511 INIT_LIST_HEAD(&xcopy_pt_tpg.se_tpg_node);
512 INIT_LIST_HEAD(&xcopy_pt_tpg.acl_node_list);
513 INIT_LIST_HEAD(&xcopy_pt_tpg.tpg_sess_list);
515 xcopy_pt_tpg.se_tpg_tfo = &xcopy_pt_tfo;
517 memset(&xcopy_pt_nacl, 0, sizeof(struct se_node_acl));
518 INIT_LIST_HEAD(&xcopy_pt_nacl.acl_list);
519 INIT_LIST_HEAD(&xcopy_pt_nacl.acl_sess_list);
520 memset(&xcopy_pt_sess, 0, sizeof(struct se_session));
521 INIT_LIST_HEAD(&xcopy_pt_sess.sess_list);
522 INIT_LIST_HEAD(&xcopy_pt_sess.sess_acl_list);
523 INIT_LIST_HEAD(&xcopy_pt_sess.sess_cmd_list);
524 spin_lock_init(&xcopy_pt_sess.sess_cmd_lock);
526 xcopy_pt_nacl.se_tpg = &xcopy_pt_tpg;
527 xcopy_pt_nacl.nacl_sess = &xcopy_pt_sess;
529 xcopy_pt_sess.se_tpg = &xcopy_pt_tpg;
530 xcopy_pt_sess.se_node_acl = &xcopy_pt_nacl;
535 void target_xcopy_release_pt(void)
538 destroy_workqueue(xcopy_wq);
541 static void target_xcopy_setup_pt_port(
542 struct xcopy_pt_cmd *xpt_cmd,
543 struct xcopy_op *xop,
546 struct se_cmd *ec_cmd = xop->xop_se_cmd;
547 struct se_cmd *pt_cmd = &xpt_cmd->se_cmd;
549 if (xop->op_origin == XCOL_SOURCE_RECV_OP) {
551 * Honor destination port reservations for X-COPY PUSH emulation
552 * when CDB is received on local source port, and READs blocks to
553 * WRITE on remote destination port.
556 xpt_cmd->remote_port = remote_port;
558 pt_cmd->se_lun = ec_cmd->se_lun;
559 pt_cmd->se_dev = ec_cmd->se_dev;
561 pr_debug("Honoring local SRC port from ec_cmd->se_dev:"
562 " %p\n", pt_cmd->se_dev);
563 pt_cmd->se_lun = ec_cmd->se_lun;
564 pr_debug("Honoring local SRC port from ec_cmd->se_lun: %p\n",
569 * Honor source port reservation for X-COPY PULL emulation
570 * when CDB is received on local desintation port, and READs
571 * blocks from the remote source port to WRITE on local
575 xpt_cmd->remote_port = remote_port;
577 pt_cmd->se_lun = ec_cmd->se_lun;
578 pt_cmd->se_dev = ec_cmd->se_dev;
580 pr_debug("Honoring local DST port from ec_cmd->se_dev:"
581 " %p\n", pt_cmd->se_dev);
582 pt_cmd->se_lun = ec_cmd->se_lun;
583 pr_debug("Honoring local DST port from ec_cmd->se_lun: %p\n",
589 static void target_xcopy_init_pt_lun(struct se_device *se_dev,
590 struct se_cmd *pt_cmd, bool remote_port)
593 * Don't allocate + init an pt_cmd->se_lun if honoring local port for
594 * reservations. The pt_cmd->se_lun pointer will be setup from within
595 * target_xcopy_setup_pt_port()
598 pr_debug("Setup emulated se_dev: %p from se_dev\n",
600 pt_cmd->se_lun = &se_dev->xcopy_lun;
601 pt_cmd->se_dev = se_dev;
604 pt_cmd->se_cmd_flags |= SCF_SE_LUN_CMD;
607 static int target_xcopy_setup_pt_cmd(
608 struct xcopy_pt_cmd *xpt_cmd,
609 struct xcopy_op *xop,
610 struct se_device *se_dev,
615 struct se_cmd *cmd = &xpt_cmd->se_cmd;
616 sense_reason_t sense_rc;
619 * Setup LUN+port to honor reservations based upon xop->op_origin for
620 * X-COPY PUSH or X-COPY PULL based upon where the CDB was received.
622 target_xcopy_init_pt_lun(se_dev, cmd, remote_port);
624 xpt_cmd->xcopy_op = xop;
625 target_xcopy_setup_pt_port(xpt_cmd, xop, remote_port);
628 sense_rc = target_setup_cmd_from_cdb(cmd, cdb);
635 rc = target_alloc_sgl(&cmd->t_data_sg, &cmd->t_data_nents,
636 cmd->data_length, false, false);
642 * Set this bit so that transport_free_pages() allows the
643 * caller to release SGLs + physical memory allocated by
644 * transport_generic_get_mem()..
646 cmd->se_cmd_flags |= SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC;
649 * Here the previously allocated SGLs for the internal READ
650 * are mapped zero-copy to the internal WRITE.
652 sense_rc = transport_generic_map_mem_to_cmd(cmd,
653 xop->xop_data_sg, xop->xop_data_nents,
660 pr_debug("Setup PASSTHROUGH_NOALLOC t_data_sg: %p t_data_nents:"
661 " %u\n", cmd->t_data_sg, cmd->t_data_nents);
670 static int target_xcopy_issue_pt_cmd(struct xcopy_pt_cmd *xpt_cmd)
672 struct se_cmd *se_cmd = &xpt_cmd->se_cmd;
673 sense_reason_t sense_rc;
675 sense_rc = transport_generic_new_cmd(se_cmd);
679 if (se_cmd->data_direction == DMA_TO_DEVICE)
680 target_execute_cmd(se_cmd);
682 wait_for_completion_interruptible(&xpt_cmd->xpt_passthrough_sem);
684 pr_debug("target_xcopy_issue_pt_cmd(): SCSI status: 0x%02x\n",
685 se_cmd->scsi_status);
687 return (se_cmd->scsi_status) ? -EINVAL : 0;
690 static int target_xcopy_read_source(
691 struct se_cmd *ec_cmd,
692 struct xcopy_op *xop,
693 struct se_device *src_dev,
697 struct xcopy_pt_cmd *xpt_cmd;
698 struct se_cmd *se_cmd;
699 u32 length = (src_sectors * src_dev->dev_attrib.block_size);
701 unsigned char cdb[16];
702 bool remote_port = (xop->op_origin == XCOL_DEST_RECV_OP);
704 xpt_cmd = kzalloc(sizeof(struct xcopy_pt_cmd), GFP_KERNEL);
706 pr_err("Unable to allocate xcopy_pt_cmd\n");
709 init_completion(&xpt_cmd->xpt_passthrough_sem);
710 se_cmd = &xpt_cmd->se_cmd;
712 memset(&cdb[0], 0, 16);
714 put_unaligned_be64(src_lba, &cdb[2]);
715 put_unaligned_be32(src_sectors, &cdb[10]);
716 pr_debug("XCOPY: Built READ_16: LBA: %llu Sectors: %u Length: %u\n",
717 (unsigned long long)src_lba, src_sectors, length);
719 transport_init_se_cmd(se_cmd, &xcopy_pt_tfo, &xcopy_pt_sess, length,
720 DMA_FROM_DEVICE, 0, &xpt_cmd->sense_buffer[0]);
721 xop->src_pt_cmd = xpt_cmd;
723 rc = target_xcopy_setup_pt_cmd(xpt_cmd, xop, src_dev, &cdb[0],
726 ec_cmd->scsi_status = xpt_cmd->se_cmd.scsi_status;
727 transport_generic_free_cmd(se_cmd, 0);
731 xop->xop_data_sg = se_cmd->t_data_sg;
732 xop->xop_data_nents = se_cmd->t_data_nents;
733 pr_debug("XCOPY-READ: Saved xop->xop_data_sg: %p, num: %u for READ"
734 " memory\n", xop->xop_data_sg, xop->xop_data_nents);
736 rc = target_xcopy_issue_pt_cmd(xpt_cmd);
738 ec_cmd->scsi_status = xpt_cmd->se_cmd.scsi_status;
739 transport_generic_free_cmd(se_cmd, 0);
743 * Clear off the allocated t_data_sg, that has been saved for
744 * zero-copy WRITE submission reuse in struct xcopy_op..
746 se_cmd->t_data_sg = NULL;
747 se_cmd->t_data_nents = 0;
752 static int target_xcopy_write_destination(
753 struct se_cmd *ec_cmd,
754 struct xcopy_op *xop,
755 struct se_device *dst_dev,
759 struct xcopy_pt_cmd *xpt_cmd;
760 struct se_cmd *se_cmd;
761 u32 length = (dst_sectors * dst_dev->dev_attrib.block_size);
763 unsigned char cdb[16];
764 bool remote_port = (xop->op_origin == XCOL_SOURCE_RECV_OP);
766 xpt_cmd = kzalloc(sizeof(struct xcopy_pt_cmd), GFP_KERNEL);
768 pr_err("Unable to allocate xcopy_pt_cmd\n");
771 init_completion(&xpt_cmd->xpt_passthrough_sem);
772 se_cmd = &xpt_cmd->se_cmd;
774 memset(&cdb[0], 0, 16);
776 put_unaligned_be64(dst_lba, &cdb[2]);
777 put_unaligned_be32(dst_sectors, &cdb[10]);
778 pr_debug("XCOPY: Built WRITE_16: LBA: %llu Sectors: %u Length: %u\n",
779 (unsigned long long)dst_lba, dst_sectors, length);
781 transport_init_se_cmd(se_cmd, &xcopy_pt_tfo, &xcopy_pt_sess, length,
782 DMA_TO_DEVICE, 0, &xpt_cmd->sense_buffer[0]);
783 xop->dst_pt_cmd = xpt_cmd;
785 rc = target_xcopy_setup_pt_cmd(xpt_cmd, xop, dst_dev, &cdb[0],
788 struct se_cmd *src_cmd = &xop->src_pt_cmd->se_cmd;
789 ec_cmd->scsi_status = xpt_cmd->se_cmd.scsi_status;
791 * If the failure happened before the t_mem_list hand-off in
792 * target_xcopy_setup_pt_cmd(), Reset memory + clear flag so that
793 * core releases this memory on error during X-COPY WRITE I/O.
795 src_cmd->se_cmd_flags &= ~SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC;
796 src_cmd->t_data_sg = xop->xop_data_sg;
797 src_cmd->t_data_nents = xop->xop_data_nents;
799 transport_generic_free_cmd(se_cmd, 0);
803 rc = target_xcopy_issue_pt_cmd(xpt_cmd);
805 ec_cmd->scsi_status = xpt_cmd->se_cmd.scsi_status;
806 se_cmd->se_cmd_flags &= ~SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC;
807 transport_generic_free_cmd(se_cmd, 0);
814 static void target_xcopy_do_work(struct work_struct *work)
816 struct xcopy_op *xop = container_of(work, struct xcopy_op, xop_work);
817 struct se_cmd *ec_cmd = xop->xop_se_cmd;
818 struct se_device *src_dev, *dst_dev;
819 sector_t src_lba, dst_lba, end_lba;
820 unsigned int max_sectors;
822 unsigned short nolb, cur_nolb, max_nolb, copied_nolb = 0;
824 if (target_parse_xcopy_cmd(xop) != TCM_NO_SENSE)
827 if (WARN_ON_ONCE(!xop->src_dev) || WARN_ON_ONCE(!xop->dst_dev))
830 src_dev = xop->src_dev;
831 dst_dev = xop->dst_dev;
832 src_lba = xop->src_lba;
833 dst_lba = xop->dst_lba;
835 end_lba = src_lba + nolb;
837 * Break up XCOPY I/O into hw_max_sectors sized I/O based on the
838 * smallest max_sectors between src_dev + dev_dev, or
840 max_sectors = min(src_dev->dev_attrib.hw_max_sectors,
841 dst_dev->dev_attrib.hw_max_sectors);
842 max_sectors = min_t(u32, max_sectors, XCOPY_MAX_SECTORS);
844 max_nolb = min_t(u16, max_sectors, ((u16)(~0U)));
846 pr_debug("target_xcopy_do_work: nolb: %hu, max_nolb: %hu end_lba: %llu\n",
847 nolb, max_nolb, (unsigned long long)end_lba);
848 pr_debug("target_xcopy_do_work: Starting src_lba: %llu, dst_lba: %llu\n",
849 (unsigned long long)src_lba, (unsigned long long)dst_lba);
851 while (src_lba < end_lba) {
852 cur_nolb = min(nolb, max_nolb);
854 pr_debug("target_xcopy_do_work: Calling read src_dev: %p src_lba: %llu,"
855 " cur_nolb: %hu\n", src_dev, (unsigned long long)src_lba, cur_nolb);
857 rc = target_xcopy_read_source(ec_cmd, xop, src_dev, src_lba, cur_nolb);
862 pr_debug("target_xcopy_do_work: Incremented READ src_lba to %llu\n",
863 (unsigned long long)src_lba);
865 pr_debug("target_xcopy_do_work: Calling write dst_dev: %p dst_lba: %llu,"
866 " cur_nolb: %hu\n", dst_dev, (unsigned long long)dst_lba, cur_nolb);
868 rc = target_xcopy_write_destination(ec_cmd, xop, dst_dev,
871 transport_generic_free_cmd(&xop->src_pt_cmd->se_cmd, 0);
876 pr_debug("target_xcopy_do_work: Incremented WRITE dst_lba to %llu\n",
877 (unsigned long long)dst_lba);
879 copied_nolb += cur_nolb;
882 transport_generic_free_cmd(&xop->src_pt_cmd->se_cmd, 0);
883 xop->dst_pt_cmd->se_cmd.se_cmd_flags &= ~SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC;
885 transport_generic_free_cmd(&xop->dst_pt_cmd->se_cmd, 0);
888 xcopy_pt_undepend_remotedev(xop);
891 pr_debug("target_xcopy_do_work: Final src_lba: %llu, dst_lba: %llu\n",
892 (unsigned long long)src_lba, (unsigned long long)dst_lba);
893 pr_debug("target_xcopy_do_work: Blocks copied: %hu, Bytes Copied: %u\n",
894 copied_nolb, copied_nolb * dst_dev->dev_attrib.block_size);
896 pr_debug("target_xcopy_do_work: Setting X-COPY GOOD status -> sending response\n");
897 target_complete_cmd(ec_cmd, SAM_STAT_GOOD);
901 xcopy_pt_undepend_remotedev(xop);
906 * Don't override an error scsi status if it has already been set
908 if (ec_cmd->scsi_status == SAM_STAT_GOOD) {
909 pr_warn_ratelimited("target_xcopy_do_work: rc: %d, Setting X-COPY"
910 " CHECK_CONDITION -> sending response\n", rc);
911 ec_cmd->scsi_status = SAM_STAT_CHECK_CONDITION;
913 target_complete_cmd(ec_cmd, ec_cmd->scsi_status);
917 * Returns TCM_NO_SENSE upon success or a sense code != TCM_NO_SENSE if parsing
920 static sense_reason_t target_parse_xcopy_cmd(struct xcopy_op *xop)
922 struct se_cmd *se_cmd = xop->xop_se_cmd;
923 unsigned char *p = NULL, *seg_desc;
924 unsigned int list_id, list_id_usage, sdll, inline_dl;
925 sense_reason_t ret = TCM_INVALID_PARAMETER_LIST;
929 p = transport_kmap_data_sg(se_cmd);
931 pr_err("transport_kmap_data_sg() failed in target_do_xcopy\n");
932 return TCM_OUT_OF_RESOURCES;
936 list_id_usage = (p[1] & 0x18) >> 3;
939 * Determine TARGET DESCRIPTOR LIST LENGTH + SEGMENT DESCRIPTOR LIST LENGTH
941 tdll = get_unaligned_be16(&p[2]);
942 sdll = get_unaligned_be32(&p[8]);
943 if (tdll + sdll > RCR_OP_MAX_DESC_LIST_LEN) {
944 pr_err("XCOPY descriptor list length %u exceeds maximum %u\n",
945 tdll + sdll, RCR_OP_MAX_DESC_LIST_LEN);
946 ret = TCM_PARAMETER_LIST_LENGTH_ERROR;
950 inline_dl = get_unaligned_be32(&p[12]);
951 if (inline_dl != 0) {
952 pr_err("XCOPY with non zero inline data length\n");
956 if (se_cmd->data_length < (XCOPY_HDR_LEN + tdll + sdll + inline_dl)) {
957 pr_err("XCOPY parameter truncation: data length %u too small "
958 "for tdll: %hu sdll: %u inline_dl: %u\n",
959 se_cmd->data_length, tdll, sdll, inline_dl);
960 ret = TCM_PARAMETER_LIST_LENGTH_ERROR;
964 pr_debug("Processing XCOPY with list_id: 0x%02x list_id_usage: 0x%02x"
965 " tdll: %hu sdll: %u inline_dl: %u\n", list_id, list_id_usage,
966 tdll, sdll, inline_dl);
969 * skip over the target descriptors until segment descriptors
970 * have been passed - CSCD ids are needed to determine src and dest.
972 seg_desc = &p[16] + tdll;
974 rc = target_xcopy_parse_segment_descriptors(se_cmd, xop, seg_desc,
979 pr_debug("XCOPY: Processed %d segment descriptors, length: %u\n", rc,
980 rc * XCOPY_SEGMENT_DESC_LEN);
982 rc = target_xcopy_parse_target_descriptors(se_cmd, xop, &p[16], tdll, &ret);
986 if (xop->src_dev->dev_attrib.block_size !=
987 xop->dst_dev->dev_attrib.block_size) {
988 pr_err("XCOPY: Non matching src_dev block_size: %u + dst_dev"
989 " block_size: %u currently unsupported\n",
990 xop->src_dev->dev_attrib.block_size,
991 xop->dst_dev->dev_attrib.block_size);
992 xcopy_pt_undepend_remotedev(xop);
993 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
997 pr_debug("XCOPY: Processed %d target descriptors, length: %u\n", rc,
998 rc * XCOPY_TARGET_DESC_LEN);
999 transport_kunmap_data_sg(se_cmd);
1000 return TCM_NO_SENSE;
1004 transport_kunmap_data_sg(se_cmd);
1008 sense_reason_t target_do_xcopy(struct se_cmd *se_cmd)
1010 struct se_device *dev = se_cmd->se_dev;
1011 struct xcopy_op *xop;
1014 if (!dev->dev_attrib.emulate_3pc) {
1015 pr_err("EXTENDED_COPY operation explicitly disabled\n");
1016 return TCM_UNSUPPORTED_SCSI_OPCODE;
1019 sa = se_cmd->t_task_cdb[1] & 0x1f;
1021 pr_err("EXTENDED_COPY(LID4) not supported\n");
1022 return TCM_UNSUPPORTED_SCSI_OPCODE;
1025 if (se_cmd->data_length == 0) {
1026 target_complete_cmd(se_cmd, SAM_STAT_GOOD);
1027 return TCM_NO_SENSE;
1029 if (se_cmd->data_length < XCOPY_HDR_LEN) {
1030 pr_err("XCOPY parameter truncation: length %u < hdr_len %u\n",
1031 se_cmd->data_length, XCOPY_HDR_LEN);
1032 return TCM_PARAMETER_LIST_LENGTH_ERROR;
1035 xop = kzalloc(sizeof(struct xcopy_op), GFP_KERNEL);
1038 xop->xop_se_cmd = se_cmd;
1039 INIT_WORK(&xop->xop_work, target_xcopy_do_work);
1040 if (WARN_ON_ONCE(!queue_work(xcopy_wq, &xop->xop_work)))
1042 return TCM_NO_SENSE;
1048 return TCM_OUT_OF_RESOURCES;
1051 static sense_reason_t target_rcr_operating_parameters(struct se_cmd *se_cmd)
1055 p = transport_kmap_data_sg(se_cmd);
1057 pr_err("transport_kmap_data_sg failed in"
1058 " target_rcr_operating_parameters\n");
1059 return TCM_OUT_OF_RESOURCES;
1062 if (se_cmd->data_length < 54) {
1063 pr_err("Receive Copy Results Op Parameters length"
1064 " too small: %u\n", se_cmd->data_length);
1065 transport_kunmap_data_sg(se_cmd);
1066 return TCM_INVALID_CDB_FIELD;
1069 * Set SNLID=1 (Supports no List ID)
1073 * MAXIMUM TARGET DESCRIPTOR COUNT
1075 put_unaligned_be16(RCR_OP_MAX_TARGET_DESC_COUNT, &p[8]);
1077 * MAXIMUM SEGMENT DESCRIPTOR COUNT
1079 put_unaligned_be16(RCR_OP_MAX_SG_DESC_COUNT, &p[10]);
1081 * MAXIMUM DESCRIPTOR LIST LENGTH
1083 put_unaligned_be32(RCR_OP_MAX_DESC_LIST_LEN, &p[12]);
1085 * MAXIMUM SEGMENT LENGTH
1087 put_unaligned_be32(RCR_OP_MAX_SEGMENT_LEN, &p[16]);
1089 * MAXIMUM INLINE DATA LENGTH for SA 0x04 (NOT SUPPORTED)
1091 put_unaligned_be32(0x0, &p[20]);
1095 put_unaligned_be32(0x0, &p[24]);
1097 * MAXIMUM STREAM DEVICE TRANSFER SIZE
1099 put_unaligned_be32(0x0, &p[28]);
1101 * TOTAL CONCURRENT COPIES
1103 put_unaligned_be16(RCR_OP_TOTAL_CONCURR_COPIES, &p[34]);
1105 * MAXIMUM CONCURRENT COPIES
1107 p[36] = RCR_OP_MAX_CONCURR_COPIES;
1109 * DATA SEGMENT GRANULARITY (log 2)
1111 p[37] = RCR_OP_DATA_SEG_GRAN_LOG2;
1113 * INLINE DATA GRANULARITY log 2)
1115 p[38] = RCR_OP_INLINE_DATA_GRAN_LOG2;
1117 * HELD DATA GRANULARITY
1119 p[39] = RCR_OP_HELD_DATA_GRAN_LOG2;
1121 * IMPLEMENTED DESCRIPTOR LIST LENGTH
1125 * List of implemented descriptor type codes (ordered)
1127 p[44] = 0x02; /* Copy Block to Block device */
1128 p[45] = 0xe4; /* Identification descriptor target descriptor */
1131 * AVAILABLE DATA (n-3)
1133 put_unaligned_be32(42, &p[0]);
1135 transport_kunmap_data_sg(se_cmd);
1136 target_complete_cmd(se_cmd, GOOD);
1138 return TCM_NO_SENSE;
1141 sense_reason_t target_do_receive_copy_results(struct se_cmd *se_cmd)
1143 unsigned char *cdb = &se_cmd->t_task_cdb[0];
1144 int sa = (cdb[1] & 0x1f), list_id = cdb[2];
1145 sense_reason_t rc = TCM_NO_SENSE;
1147 pr_debug("Entering target_do_receive_copy_results: SA: 0x%02x, List ID:"
1148 " 0x%02x, AL: %u\n", sa, list_id, se_cmd->data_length);
1151 pr_err("Receive Copy Results with non zero list identifier"
1152 " not supported\n");
1153 return TCM_INVALID_CDB_FIELD;
1157 case RCR_SA_OPERATING_PARAMETERS:
1158 rc = target_rcr_operating_parameters(se_cmd);
1160 case RCR_SA_COPY_STATUS:
1161 case RCR_SA_RECEIVE_DATA:
1162 case RCR_SA_FAILED_SEGMENT_DETAILS:
1164 pr_err("Unsupported SA for receive copy results: 0x%02x\n", sa);
1165 return TCM_INVALID_CDB_FIELD;