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