drivers/target/target_core_xcopy.c

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