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