drivers/target/target_core_xcopy.c

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