drivers/target/target_core_pscsi.c

   1 /*******************************************************************************
   2  * Filename:  target_core_pscsi.c
   3  *
   4  * This file contains the generic target mode <-> Linux SCSI subsystem plugin.
   5  *
   6  * (c) Copyright 2003-2013 Datera, Inc.
   7  *
   8  * Nicholas A. Bellinger <nab@kernel.org>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  23  *
  24  ******************************************************************************/
  25
  26 #include <linux/string.h>
  27 #include <linux/parser.h>
  28 #include <linux/timer.h>
  29 #include <linux/blkdev.h>
  30 #include <linux/blk_types.h>
  31 #include <linux/slab.h>
  32 #include <linux/spinlock.h>
  33 #include <linux/genhd.h>
  34 #include <linux/cdrom.h>
  35 #include <linux/ratelimit.h>
  36 #include <linux/module.h>
  37 #include <asm/unaligned.h>
  38
  39 #include <scsi/scsi.h>
  40 #include <scsi/scsi_device.h>
  41 #include <scsi/scsi_cmnd.h>
  42 #include <scsi/scsi_host.h>
  43 #include <scsi/scsi_tcq.h>
  44
  45 #include <target/target_core_base.h>
  46 #include <target/target_core_backend.h>
  47 #include <target/target_core_backend_configfs.h>
  48
  49 #include "target_core_alua.h"
  50 #include "target_core_internal.h"
  51 #include "target_core_pscsi.h"
  52
  53 #define ISPRINT(a)  ((a >= ' ') && (a <= '~'))
  54
  55 static inline struct pscsi_dev_virt *PSCSI_DEV(struct se_device *dev)
  56 {
  57         return container_of(dev, struct pscsi_dev_virt, dev);
  58 }
  59
  60 static sense_reason_t pscsi_execute_cmd(struct se_cmd *cmd);
  61 static void pscsi_req_done(struct request *, int);
  62
  63 /*      pscsi_attach_hba():
  64  *
  65  *      pscsi_get_sh() used scsi_host_lookup() to locate struct Scsi_Host.
  66  *      from the passed SCSI Host ID.
  67  */
  68 static int pscsi_attach_hba(struct se_hba *hba, u32 host_id)
  69 {
  70         struct pscsi_hba_virt *phv;
  71
  72         phv = kzalloc(sizeof(struct pscsi_hba_virt), GFP_KERNEL);
  73         if (!phv) {
  74                 pr_err("Unable to allocate struct pscsi_hba_virt\n");
  75                 return -ENOMEM;
  76         }
  77         phv->phv_host_id = host_id;
  78         phv->phv_mode = PHV_VIRTUAL_HOST_ID;
  79
  80         hba->hba_ptr = phv;
  81
  82         pr_debug("CORE_HBA[%d] - TCM SCSI HBA Driver %s on"
  83                 " Generic Target Core Stack %s\n", hba->hba_id,
  84                 PSCSI_VERSION, TARGET_CORE_MOD_VERSION);
  85         pr_debug("CORE_HBA[%d] - Attached SCSI HBA to Generic\n",
  86                hba->hba_id);
  87
  88         return 0;
  89 }
  90
  91 static void pscsi_detach_hba(struct se_hba *hba)
  92 {
  93         struct pscsi_hba_virt *phv = hba->hba_ptr;
  94         struct Scsi_Host *scsi_host = phv->phv_lld_host;
  95
  96         if (scsi_host) {
  97                 scsi_host_put(scsi_host);
  98
  99                 pr_debug("CORE_HBA[%d] - Detached SCSI HBA: %s from"
 100                         " Generic Target Core\n", hba->hba_id,
 101                         (scsi_host->hostt->name) ? (scsi_host->hostt->name) :
 102                         "Unknown");
 103         } else
 104                 pr_debug("CORE_HBA[%d] - Detached Virtual SCSI HBA"
 105                         " from Generic Target Core\n", hba->hba_id);
 106
 107         kfree(phv);
 108         hba->hba_ptr = NULL;
 109 }
 110
 111 static int pscsi_pmode_enable_hba(struct se_hba *hba, unsigned long mode_flag)
 112 {
 113         struct pscsi_hba_virt *phv = hba->hba_ptr;
 114         struct Scsi_Host *sh = phv->phv_lld_host;
 115         /*
 116          * Release the struct Scsi_Host
 117          */
 118         if (!mode_flag) {
 119                 if (!sh)
 120                         return 0;
 121
 122                 phv->phv_lld_host = NULL;
 123                 phv->phv_mode = PHV_VIRTUAL_HOST_ID;
 124
 125                 pr_debug("CORE_HBA[%d] - Disabled pSCSI HBA Passthrough"
 126                         " %s\n", hba->hba_id, (sh->hostt->name) ?
 127                         (sh->hostt->name) : "Unknown");
 128
 129                 scsi_host_put(sh);
 130                 return 0;
 131         }
 132         /*
 133          * Otherwise, locate struct Scsi_Host from the original passed
 134          * pSCSI Host ID and enable for phba mode
 135          */
 136         sh = scsi_host_lookup(phv->phv_host_id);
 137         if (!sh) {
 138                 pr_err("pSCSI: Unable to locate SCSI Host for"
 139                         " phv_host_id: %d\n", phv->phv_host_id);
 140                 return -EINVAL;
 141         }
 142
 143         phv->phv_lld_host = sh;
 144         phv->phv_mode = PHV_LLD_SCSI_HOST_NO;
 145
 146         pr_debug("CORE_HBA[%d] - Enabled pSCSI HBA Passthrough %s\n",
 147                 hba->hba_id, (sh->hostt->name) ? (sh->hostt->name) : "Unknown");
 148
 149         return 1;
 150 }
 151
 152 static void pscsi_tape_read_blocksize(struct se_device *dev,
 153                 struct scsi_device *sdev)
 154 {
 155         unsigned char cdb[MAX_COMMAND_SIZE], *buf;
 156         int ret;
 157
 158         buf = kzalloc(12, GFP_KERNEL);
 159         if (!buf)
 160                 return;
 161
 162         memset(cdb, 0, MAX_COMMAND_SIZE);
 163         cdb[0] = MODE_SENSE;
 164         cdb[4] = 0x0c; /* 12 bytes */
 165
 166         ret = scsi_execute_req(sdev, cdb, DMA_FROM_DEVICE, buf, 12, NULL,
 167                         HZ, 1, NULL);
 168         if (ret)
 169                 goto out_free;
 170
 171         /*
 172          * If MODE_SENSE still returns zero, set the default value to 1024.
 173          */
 174         sdev->sector_size = (buf[9] << 16) | (buf[10] << 8) | (buf[11]);
 175         if (!sdev->sector_size)
 176                 sdev->sector_size = 1024;
 177 out_free:
 178         kfree(buf);
 179 }
 180
 181 static void
 182 pscsi_set_inquiry_info(struct scsi_device *sdev, struct t10_wwn *wwn)
 183 {
 184         unsigned char *buf;
 185
 186         if (sdev->inquiry_len < INQUIRY_LEN)
 187                 return;
 188
 189         buf = sdev->inquiry;
 190         if (!buf)
 191                 return;
 192         /*
 193          * Use sdev->inquiry from drivers/scsi/scsi_scan.c:scsi_alloc_sdev()
 194          */
 195         memcpy(&wwn->vendor[0], &buf[8], sizeof(wwn->vendor));
 196         memcpy(&wwn->model[0], &buf[16], sizeof(wwn->model));
 197         memcpy(&wwn->revision[0], &buf[32], sizeof(wwn->revision));
 198 }
 199
 200 static int
 201 pscsi_get_inquiry_vpd_serial(struct scsi_device *sdev, struct t10_wwn *wwn)
 202 {
 203         unsigned char cdb[MAX_COMMAND_SIZE], *buf;
 204         int ret;
 205
 206         buf = kzalloc(INQUIRY_VPD_SERIAL_LEN, GFP_KERNEL);
 207         if (!buf)
 208                 return -ENOMEM;
 209
 210         memset(cdb, 0, MAX_COMMAND_SIZE);
 211         cdb[0] = INQUIRY;
 212         cdb[1] = 0x01; /* Query VPD */
 213         cdb[2] = 0x80; /* Unit Serial Number */
 214         cdb[3] = (INQUIRY_VPD_SERIAL_LEN >> 8) & 0xff;
 215         cdb[4] = (INQUIRY_VPD_SERIAL_LEN & 0xff);
 216
 217         ret = scsi_execute_req(sdev, cdb, DMA_FROM_DEVICE, buf,
 218                               INQUIRY_VPD_SERIAL_LEN, NULL, HZ, 1, NULL);
 219         if (ret)
 220                 goto out_free;
 221
 222         snprintf(&wwn->unit_serial[0], INQUIRY_VPD_SERIAL_LEN, "%s", &buf[4]);
 223
 224         wwn->t10_dev->dev_flags |= DF_FIRMWARE_VPD_UNIT_SERIAL;
 225
 226         kfree(buf);
 227         return 0;
 228
 229 out_free:
 230         kfree(buf);
 231         return -EPERM;
 232 }
 233
 234 static void
 235 pscsi_get_inquiry_vpd_device_ident(struct scsi_device *sdev,
 236                 struct t10_wwn *wwn)
 237 {
 238         unsigned char cdb[MAX_COMMAND_SIZE], *buf, *page_83;
 239         int ident_len, page_len, off = 4, ret;
 240         struct t10_vpd *vpd;
 241
 242         buf = kzalloc(INQUIRY_VPD_SERIAL_LEN, GFP_KERNEL);
 243         if (!buf)
 244                 return;
 245
 246         memset(cdb, 0, MAX_COMMAND_SIZE);
 247         cdb[0] = INQUIRY;
 248         cdb[1] = 0x01; /* Query VPD */
 249         cdb[2] = 0x83; /* Device Identifier */
 250         cdb[3] = (INQUIRY_VPD_DEVICE_IDENTIFIER_LEN >> 8) & 0xff;
 251         cdb[4] = (INQUIRY_VPD_DEVICE_IDENTIFIER_LEN & 0xff);
 252
 253         ret = scsi_execute_req(sdev, cdb, DMA_FROM_DEVICE, buf,
 254                               INQUIRY_VPD_DEVICE_IDENTIFIER_LEN,
 255                               NULL, HZ, 1, NULL);
 256         if (ret)
 257                 goto out;
 258
 259         page_len = (buf[2] << 8) | buf[3];
 260         while (page_len > 0) {
 261                 /* Grab a pointer to the Identification descriptor */
 262                 page_83 = &buf[off];
 263                 ident_len = page_83[3];
 264                 if (!ident_len) {
 265                         pr_err("page_83[3]: identifier"
 266                                         " length zero!\n");
 267                         break;
 268                 }
 269                 pr_debug("T10 VPD Identifier Length: %d\n", ident_len);
 270
 271                 vpd = kzalloc(sizeof(struct t10_vpd), GFP_KERNEL);
 272                 if (!vpd) {
 273                         pr_err("Unable to allocate memory for"
 274                                         " struct t10_vpd\n");
 275                         goto out;
 276                 }
 277                 INIT_LIST_HEAD(&vpd->vpd_list);
 278
 279                 transport_set_vpd_proto_id(vpd, page_83);
 280                 transport_set_vpd_assoc(vpd, page_83);
 281
 282                 if (transport_set_vpd_ident_type(vpd, page_83) < 0) {
 283                         off += (ident_len + 4);
 284                         page_len -= (ident_len + 4);
 285                         kfree(vpd);
 286                         continue;
 287                 }
 288                 if (transport_set_vpd_ident(vpd, page_83) < 0) {
 289                         off += (ident_len + 4);
 290                         page_len -= (ident_len + 4);
 291                         kfree(vpd);
 292                         continue;
 293                 }
 294
 295                 list_add_tail(&vpd->vpd_list, &wwn->t10_vpd_list);
 296                 off += (ident_len + 4);
 297                 page_len -= (ident_len + 4);
 298         }
 299
 300 out:
 301         kfree(buf);
 302 }
 303
 304 static int pscsi_add_device_to_list(struct se_device *dev,
 305                 struct scsi_device *sd)
 306 {
 307         struct pscsi_dev_virt *pdv = PSCSI_DEV(dev);
 308         struct request_queue *q = sd->request_queue;
 309
 310         pdv->pdv_sd = sd;
 311
 312         if (!sd->queue_depth) {
 313                 sd->queue_depth = PSCSI_DEFAULT_QUEUEDEPTH;
 314
 315                 pr_err("Set broken SCSI Device %d:%d:%llu"
 316                         " queue_depth to %d\n", sd->channel, sd->id,
 317                                 sd->lun, sd->queue_depth);
 318         }
 319
 320         dev->dev_attrib.hw_block_size = sd->sector_size;
 321         dev->dev_attrib.hw_max_sectors =
 322                 min_t(int, sd->host->max_sectors, queue_max_hw_sectors(q));
 323         dev->dev_attrib.hw_queue_depth = sd->queue_depth;
 324
 325         /*
 326          * Setup our standard INQUIRY info into se_dev->t10_wwn
 327          */
 328         pscsi_set_inquiry_info(sd, &dev->t10_wwn);
 329
 330         /*
 331          * Locate VPD WWN Information used for various purposes within
 332          * the Storage Engine.
 333          */
 334         if (!pscsi_get_inquiry_vpd_serial(sd, &dev->t10_wwn)) {
 335                 /*
 336                  * If VPD Unit Serial returned GOOD status, try
 337                  * VPD Device Identification page (0x83).
 338                  */
 339                 pscsi_get_inquiry_vpd_device_ident(sd, &dev->t10_wwn);
 340         }
 341
 342         /*
 343          * For TYPE_TAPE, attempt to determine blocksize with MODE_SENSE.
 344          */
 345         if (sd->type == TYPE_TAPE)
 346                 pscsi_tape_read_blocksize(dev, sd);
 347         return 0;
 348 }
 349
 350 static struct se_device *pscsi_alloc_device(struct se_hba *hba,
 351                 const char *name)
 352 {
 353         struct pscsi_dev_virt *pdv;
 354
 355         pdv = kzalloc(sizeof(struct pscsi_dev_virt), GFP_KERNEL);
 356         if (!pdv) {
 357                 pr_err("Unable to allocate memory for struct pscsi_dev_virt\n");
 358                 return NULL;
 359         }
 360
 361         pr_debug("PSCSI: Allocated pdv: %p for %s\n", pdv, name);
 362         return &pdv->dev;
 363 }
 364
 365 /*
 366  * Called with struct Scsi_Host->host_lock called.
 367  */
 368 static int pscsi_create_type_disk(struct se_device *dev, struct scsi_device *sd)
 369         __releases(sh->host_lock)
 370 {
 371         struct pscsi_hba_virt *phv = dev->se_hba->hba_ptr;
 372         struct pscsi_dev_virt *pdv = PSCSI_DEV(dev);
 373         struct Scsi_Host *sh = sd->host;
 374         struct block_device *bd;
 375         int ret;
 376
 377         if (scsi_device_get(sd)) {
 378                 pr_err("scsi_device_get() failed for %d:%d:%d:%llu\n",
 379                         sh->host_no, sd->channel, sd->id, sd->lun);
 380                 spin_unlock_irq(sh->host_lock);
 381                 return -EIO;
 382         }
 383         spin_unlock_irq(sh->host_lock);
 384         /*
 385          * Claim exclusive struct block_device access to struct scsi_device
 386          * for TYPE_DISK using supplied udev_path
 387          */
 388         bd = blkdev_get_by_path(dev->udev_path,
 389                                 FMODE_WRITE|FMODE_READ|FMODE_EXCL, pdv);
 390         if (IS_ERR(bd)) {
 391                 pr_err("pSCSI: blkdev_get_by_path() failed\n");
 392                 scsi_device_put(sd);
 393                 return PTR_ERR(bd);
 394         }
 395         pdv->pdv_bd = bd;
 396
 397         ret = pscsi_add_device_to_list(dev, sd);
 398         if (ret) {
 399                 blkdev_put(pdv->pdv_bd, FMODE_WRITE|FMODE_READ|FMODE_EXCL);
 400                 scsi_device_put(sd);
 401                 return ret;
 402         }
 403
 404         pr_debug("CORE_PSCSI[%d] - Added TYPE_DISK for %d:%d:%d:%llu\n",
 405                 phv->phv_host_id, sh->host_no, sd->channel, sd->id, sd->lun);
 406         return 0;
 407 }
 408
 409 /*
 410  * Called with struct Scsi_Host->host_lock called.
 411  */
 412 static int pscsi_create_type_rom(struct se_device *dev, struct scsi_device *sd)
 413         __releases(sh->host_lock)
 414 {
 415         struct pscsi_hba_virt *phv = dev->se_hba->hba_ptr;
 416         struct Scsi_Host *sh = sd->host;
 417         int ret;
 418
 419         if (scsi_device_get(sd)) {
 420                 pr_err("scsi_device_get() failed for %d:%d:%d:%llu\n",
 421                         sh->host_no, sd->channel, sd->id, sd->lun);
 422                 spin_unlock_irq(sh->host_lock);
 423                 return -EIO;
 424         }
 425         spin_unlock_irq(sh->host_lock);
 426
 427         ret = pscsi_add_device_to_list(dev, sd);
 428         if (ret) {
 429                 scsi_device_put(sd);
 430                 return ret;
 431         }
 432         pr_debug("CORE_PSCSI[%d] - Added Type: %s for %d:%d:%d:%llu\n",
 433                 phv->phv_host_id, scsi_device_type(sd->type), sh->host_no,
 434                 sd->channel, sd->id, sd->lun);
 435
 436         return 0;
 437 }
 438
 439 /*
 440  * Called with struct Scsi_Host->host_lock called.
 441  */
 442 static int pscsi_create_type_other(struct se_device *dev,
 443                 struct scsi_device *sd)
 444         __releases(sh->host_lock)
 445 {
 446         struct pscsi_hba_virt *phv = dev->se_hba->hba_ptr;
 447         struct Scsi_Host *sh = sd->host;
 448         int ret;
 449
 450         spin_unlock_irq(sh->host_lock);
 451         ret = pscsi_add_device_to_list(dev, sd);
 452         if (ret)
 453                 return ret;
 454
 455         pr_debug("CORE_PSCSI[%d] - Added Type: %s for %d:%d:%d:%llu\n",
 456                 phv->phv_host_id, scsi_device_type(sd->type), sh->host_no,
 457                 sd->channel, sd->id, sd->lun);
 458         return 0;
 459 }
 460
 461 static int pscsi_configure_device(struct se_device *dev)
 462 {
 463         struct se_hba *hba = dev->se_hba;
 464         struct pscsi_dev_virt *pdv = PSCSI_DEV(dev);
 465         struct scsi_device *sd;
 466         struct pscsi_hba_virt *phv = dev->se_hba->hba_ptr;
 467         struct Scsi_Host *sh = phv->phv_lld_host;
 468         int legacy_mode_enable = 0;
 469         int ret;
 470
 471         if (!(pdv->pdv_flags & PDF_HAS_CHANNEL_ID) ||
 472             !(pdv->pdv_flags & PDF_HAS_TARGET_ID) ||
 473             !(pdv->pdv_flags & PDF_HAS_LUN_ID)) {
 474                 pr_err("Missing scsi_channel_id=, scsi_target_id= and"
 475                         " scsi_lun_id= parameters\n");
 476                 return -EINVAL;
 477         }
 478
 479         /*
 480          * If not running in PHV_LLD_SCSI_HOST_NO mode, locate the
 481          * struct Scsi_Host we will need to bring the TCM/pSCSI object online
 482          */
 483         if (!sh) {
 484                 if (phv->phv_mode == PHV_LLD_SCSI_HOST_NO) {
 485                         pr_err("pSCSI: Unable to locate struct"
 486                                 " Scsi_Host for PHV_LLD_SCSI_HOST_NO\n");
 487                         return -ENODEV;
 488                 }
 489                 /*
 490                  * For the newer PHV_VIRTUAL_HOST_ID struct scsi_device
 491                  * reference, we enforce that udev_path has been set
 492                  */
 493                 if (!(dev->dev_flags & DF_USING_UDEV_PATH)) {
 494                         pr_err("pSCSI: udev_path attribute has not"
 495                                 " been set before ENABLE=1\n");
 496                         return -EINVAL;
 497                 }
 498                 /*
 499                  * If no scsi_host_id= was passed for PHV_VIRTUAL_HOST_ID,
 500                  * use the original TCM hba ID to reference Linux/SCSI Host No
 501                  * and enable for PHV_LLD_SCSI_HOST_NO mode.
 502                  */
 503                 if (!(pdv->pdv_flags & PDF_HAS_VIRT_HOST_ID)) {
 504                         if (hba->dev_count) {
 505                                 pr_err("pSCSI: Unable to set hba_mode"
 506                                         " with active devices\n");
 507                                 return -EEXIST;
 508                         }
 509
 510                         if (pscsi_pmode_enable_hba(hba, 1) != 1)
 511                                 return -ENODEV;
 512
 513                         legacy_mode_enable = 1;
 514                         hba->hba_flags |= HBA_FLAGS_PSCSI_MODE;
 515                         sh = phv->phv_lld_host;
 516                 } else {
 517                         sh = scsi_host_lookup(pdv->pdv_host_id);
 518                         if (!sh) {
 519                                 pr_err("pSCSI: Unable to locate"
 520                                         " pdv_host_id: %d\n", pdv->pdv_host_id);
 521                                 return -EINVAL;
 522                         }
 523                         pdv->pdv_lld_host = sh;
 524                 }
 525         } else {
 526                 if (phv->phv_mode == PHV_VIRTUAL_HOST_ID) {
 527                         pr_err("pSCSI: PHV_VIRTUAL_HOST_ID set while"
 528                                 " struct Scsi_Host exists\n");
 529                         return -EEXIST;
 530                 }
 531         }
 532
 533         spin_lock_irq(sh->host_lock);
 534         list_for_each_entry(sd, &sh->__devices, siblings) {
 535                 if ((pdv->pdv_channel_id != sd->channel) ||
 536                     (pdv->pdv_target_id != sd->id) ||
 537                     (pdv->pdv_lun_id != sd->lun))
 538                         continue;
 539                 /*
 540                  * Functions will release the held struct scsi_host->host_lock
 541                  * before calling calling pscsi_add_device_to_list() to register
 542                  * struct scsi_device with target_core_mod.
 543                  */
 544                 switch (sd->type) {
 545                 case TYPE_DISK:
 546                         ret = pscsi_create_type_disk(dev, sd);
 547                         break;
 548                 case TYPE_ROM:
 549                         ret = pscsi_create_type_rom(dev, sd);
 550                         break;
 551                 default:
 552                         ret = pscsi_create_type_other(dev, sd);
 553                         break;
 554                 }
 555
 556                 if (ret) {
 557                         if (phv->phv_mode == PHV_VIRTUAL_HOST_ID)
 558                                 scsi_host_put(sh);
 559                         else if (legacy_mode_enable) {
 560                                 pscsi_pmode_enable_hba(hba, 0);
 561                                 hba->hba_flags &= ~HBA_FLAGS_PSCSI_MODE;
 562                         }
 563                         pdv->pdv_sd = NULL;
 564                         return ret;
 565                 }
 566                 return 0;
 567         }
 568         spin_unlock_irq(sh->host_lock);
 569
 570         pr_err("pSCSI: Unable to locate %d:%d:%d:%d\n", sh->host_no,
 571                 pdv->pdv_channel_id,  pdv->pdv_target_id, pdv->pdv_lun_id);
 572
 573         if (phv->phv_mode == PHV_VIRTUAL_HOST_ID)
 574                 scsi_host_put(sh);
 575         else if (legacy_mode_enable) {
 576                 pscsi_pmode_enable_hba(hba, 0);
 577                 hba->hba_flags &= ~HBA_FLAGS_PSCSI_MODE;
 578         }
 579
 580         return -ENODEV;
 581 }
 582
 583 static void pscsi_free_device(struct se_device *dev)
 584 {
 585         struct pscsi_dev_virt *pdv = PSCSI_DEV(dev);
 586         struct pscsi_hba_virt *phv = dev->se_hba->hba_ptr;
 587         struct scsi_device *sd = pdv->pdv_sd;
 588
 589         if (sd) {
 590                 /*
 591                  * Release exclusive pSCSI internal struct block_device claim for
 592                  * struct scsi_device with TYPE_DISK from pscsi_create_type_disk()
 593                  */
 594                 if ((sd->type == TYPE_DISK) && pdv->pdv_bd) {
 595                         blkdev_put(pdv->pdv_bd,
 596                                    FMODE_WRITE|FMODE_READ|FMODE_EXCL);
 597                         pdv->pdv_bd = NULL;
 598                 }
 599                 /*
 600                  * For HBA mode PHV_LLD_SCSI_HOST_NO, release the reference
 601                  * to struct Scsi_Host now.
 602                  */
 603                 if ((phv->phv_mode == PHV_LLD_SCSI_HOST_NO) &&
 604                     (phv->phv_lld_host != NULL))
 605                         scsi_host_put(phv->phv_lld_host);
 606                 else if (pdv->pdv_lld_host)
 607                         scsi_host_put(pdv->pdv_lld_host);
 608
 609                 if ((sd->type == TYPE_DISK) || (sd->type == TYPE_ROM))
 610                         scsi_device_put(sd);
 611
 612                 pdv->pdv_sd = NULL;
 613         }
 614
 615         kfree(pdv);
 616 }
 617
 618 static void pscsi_transport_complete(struct se_cmd *cmd, struct scatterlist *sg,
 619                                      unsigned char *sense_buffer)
 620 {
 621         struct pscsi_dev_virt *pdv = PSCSI_DEV(cmd->se_dev);
 622         struct scsi_device *sd = pdv->pdv_sd;
 623         int result;
 624         struct pscsi_plugin_task *pt = cmd->priv;
 625         unsigned char *cdb;
 626         /*
 627          * Special case for REPORT_LUNs handling where pscsi_plugin_task has
 628          * not been allocated because TCM is handling the emulation directly.
 629          */
 630         if (!pt)
 631                 return;
 632
 633         cdb = &pt->pscsi_cdb[0];
 634         result = pt->pscsi_result;
 635         /*
 636          * Hack to make sure that Write-Protect modepage is set if R/O mode is
 637          * forced.
 638          */
 639         if (!cmd->data_length)
 640                 goto after_mode_sense;
 641
 642         if (((cdb[0] == MODE_SENSE) || (cdb[0] == MODE_SENSE_10)) &&
 643              (status_byte(result) << 1) == SAM_STAT_GOOD) {
 644                 bool read_only = target_lun_is_rdonly(cmd);
 645
 646                 if (read_only) {
 647                         unsigned char *buf;
 648
 649                         buf = transport_kmap_data_sg(cmd);
 650                         if (!buf)
 651                                 ; /* XXX: TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE */
 652
 653                         if (cdb[0] == MODE_SENSE_10) {
 654                                 if (!(buf[3] & 0x80))
 655                                         buf[3] |= 0x80;
 656                         } else {
 657                                 if (!(buf[2] & 0x80))
 658                                         buf[2] |= 0x80;
 659                         }
 660
 661                         transport_kunmap_data_sg(cmd);
 662                 }
 663         }
 664 after_mode_sense:
 665
 666         if (sd->type != TYPE_TAPE || !cmd->data_length)
 667                 goto after_mode_select;
 668
 669         /*
 670          * Hack to correctly obtain the initiator requested blocksize for
 671          * TYPE_TAPE.  Since this value is dependent upon each tape media,
 672          * struct scsi_device->sector_size will not contain the correct value
 673          * by default, so we go ahead and set it so
 674          * TRANSPORT(dev)->get_blockdev() returns the correct value to the
 675          * storage engine.
 676          */
 677         if (((cdb[0] == MODE_SELECT) || (cdb[0] == MODE_SELECT_10)) &&
 678               (status_byte(result) << 1) == SAM_STAT_GOOD) {
 679                 unsigned char *buf;
 680                 u16 bdl;
 681                 u32 blocksize;
 682
 683                 buf = sg_virt(&sg[0]);
 684                 if (!buf) {
 685                         pr_err("Unable to get buf for scatterlist\n");
 686                         goto after_mode_select;
 687                 }
 688
 689                 if (cdb[0] == MODE_SELECT)
 690                         bdl = (buf[3]);
 691                 else
 692                         bdl = (buf[6] << 8) | (buf[7]);
 693
 694                 if (!bdl)
 695                         goto after_mode_select;
 696
 697                 if (cdb[0] == MODE_SELECT)
 698                         blocksize = (buf[9] << 16) | (buf[10] << 8) |
 699                                         (buf[11]);
 700                 else
 701                         blocksize = (buf[13] << 16) | (buf[14] << 8) |
 702                                         (buf[15]);
 703
 704                 sd->sector_size = blocksize;
 705         }
 706 after_mode_select:
 707
 708         if (sense_buffer && (status_byte(result) & CHECK_CONDITION)) {
 709                 memcpy(sense_buffer, pt->pscsi_sense, TRANSPORT_SENSE_BUFFER);
 710                 cmd->se_cmd_flags |= SCF_TRANSPORT_TASK_SENSE;
 711         }
 712 }
 713
 714 enum {
 715         Opt_scsi_host_id, Opt_scsi_channel_id, Opt_scsi_target_id,
 716         Opt_scsi_lun_id, Opt_err
 717 };
 718
 719 static match_table_t tokens = {
 720         {Opt_scsi_host_id, "scsi_host_id=%d"},
 721         {Opt_scsi_channel_id, "scsi_channel_id=%d"},
 722         {Opt_scsi_target_id, "scsi_target_id=%d"},
 723         {Opt_scsi_lun_id, "scsi_lun_id=%d"},
 724         {Opt_err, NULL}
 725 };
 726
 727 static ssize_t pscsi_set_configfs_dev_params(struct se_device *dev,
 728                 const char *page, ssize_t count)
 729 {
 730         struct pscsi_dev_virt *pdv = PSCSI_DEV(dev);
 731         struct pscsi_hba_virt *phv = dev->se_hba->hba_ptr;
 732         char *orig, *ptr, *opts;
 733         substring_t args[MAX_OPT_ARGS];
 734         int ret = 0, arg, token;
 735
 736         opts = kstrdup(page, GFP_KERNEL);
 737         if (!opts)
 738                 return -ENOMEM;
 739
 740         orig = opts;
 741
 742         while ((ptr = strsep(&opts, ",\n")) != NULL) {
 743                 if (!*ptr)
 744                         continue;
 745
 746                 token = match_token(ptr, tokens, args);
 747                 switch (token) {
 748                 case Opt_scsi_host_id:
 749                         if (phv->phv_mode == PHV_LLD_SCSI_HOST_NO) {
 750                                 pr_err("PSCSI[%d]: Unable to accept"
 751                                         " scsi_host_id while phv_mode =="
 752                                         " PHV_LLD_SCSI_HOST_NO\n",
 753                                         phv->phv_host_id);
 754                                 ret = -EINVAL;
 755                                 goto out;
 756                         }
 757                         ret = match_int(args, &arg);
 758                         if (ret)
 759                                 goto out;
 760                         pdv->pdv_host_id = arg;
 761                         pr_debug("PSCSI[%d]: Referencing SCSI Host ID:"
 762                                 " %d\n", phv->phv_host_id, pdv->pdv_host_id);
 763                         pdv->pdv_flags |= PDF_HAS_VIRT_HOST_ID;
 764                         break;
 765                 case Opt_scsi_channel_id:
 766                         ret = match_int(args, &arg);
 767                         if (ret)
 768                                 goto out;
 769                         pdv->pdv_channel_id = arg;
 770                         pr_debug("PSCSI[%d]: Referencing SCSI Channel"
 771                                 " ID: %d\n",  phv->phv_host_id,
 772                                 pdv->pdv_channel_id);
 773                         pdv->pdv_flags |= PDF_HAS_CHANNEL_ID;
 774                         break;
 775                 case Opt_scsi_target_id:
 776                         ret = match_int(args, &arg);
 777                         if (ret)
 778                                 goto out;
 779                         pdv->pdv_target_id = arg;
 780                         pr_debug("PSCSI[%d]: Referencing SCSI Target"
 781                                 " ID: %d\n", phv->phv_host_id,
 782                                 pdv->pdv_target_id);
 783                         pdv->pdv_flags |= PDF_HAS_TARGET_ID;
 784                         break;
 785                 case Opt_scsi_lun_id:
 786                         ret = match_int(args, &arg);
 787                         if (ret)
 788                                 goto out;
 789                         pdv->pdv_lun_id = arg;
 790                         pr_debug("PSCSI[%d]: Referencing SCSI LUN ID:"
 791                                 " %d\n", phv->phv_host_id, pdv->pdv_lun_id);
 792                         pdv->pdv_flags |= PDF_HAS_LUN_ID;
 793                         break;
 794                 default:
 795                         break;
 796                 }
 797         }
 798
 799 out:
 800         kfree(orig);
 801         return (!ret) ? count : ret;
 802 }
 803
 804 static ssize_t pscsi_show_configfs_dev_params(struct se_device *dev, char *b)
 805 {
 806         struct pscsi_hba_virt *phv = dev->se_hba->hba_ptr;
 807         struct pscsi_dev_virt *pdv = PSCSI_DEV(dev);
 808         struct scsi_device *sd = pdv->pdv_sd;
 809         unsigned char host_id[16];
 810         ssize_t bl;
 811         int i;
 812
 813         if (phv->phv_mode == PHV_VIRTUAL_HOST_ID)
 814                 snprintf(host_id, 16, "%d", pdv->pdv_host_id);
 815         else
 816                 snprintf(host_id, 16, "PHBA Mode");
 817
 818         bl = sprintf(b, "SCSI Device Bus Location:"
 819                 " Channel ID: %d Target ID: %d LUN: %d Host ID: %s\n",
 820                 pdv->pdv_channel_id, pdv->pdv_target_id, pdv->pdv_lun_id,
 821                 host_id);
 822
 823         if (sd) {
 824                 bl += sprintf(b + bl, "        ");
 825                 bl += sprintf(b + bl, "Vendor: ");
 826                 for (i = 0; i < 8; i++) {
 827                         if (ISPRINT(sd->vendor[i]))   /* printable character? */
 828                                 bl += sprintf(b + bl, "%c", sd->vendor[i]);
 829                         else
 830                                 bl += sprintf(b + bl, " ");
 831                 }
 832                 bl += sprintf(b + bl, " Model: ");
 833                 for (i = 0; i < 16; i++) {
 834                         if (ISPRINT(sd->model[i]))   /* printable character ? */
 835                                 bl += sprintf(b + bl, "%c", sd->model[i]);
 836                         else
 837                                 bl += sprintf(b + bl, " ");
 838                 }
 839                 bl += sprintf(b + bl, " Rev: ");
 840                 for (i = 0; i < 4; i++) {
 841                         if (ISPRINT(sd->rev[i]))   /* printable character ? */
 842                                 bl += sprintf(b + bl, "%c", sd->rev[i]);
 843                         else
 844                                 bl += sprintf(b + bl, " ");
 845                 }
 846                 bl += sprintf(b + bl, "\n");
 847         }
 848         return bl;
 849 }
 850
 851 static void pscsi_bi_endio(struct bio *bio, int error)
 852 {
 853         bio_put(bio);
 854 }
 855
 856 static inline struct bio *pscsi_get_bio(int nr_vecs)
 857 {
 858         struct bio *bio;
 859         /*
 860          * Use bio_malloc() following the comment in for bio -> struct request
 861          * in block/blk-core.c:blk_make_request()
 862          */
 863         bio = bio_kmalloc(GFP_KERNEL, nr_vecs);
 864         if (!bio) {
 865                 pr_err("PSCSI: bio_kmalloc() failed\n");
 866                 return NULL;
 867         }
 868         bio->bi_end_io = pscsi_bi_endio;
 869
 870         return bio;
 871 }
 872
 873 static sense_reason_t
 874 pscsi_map_sg(struct se_cmd *cmd, struct scatterlist *sgl, u32 sgl_nents,
 875                 enum dma_data_direction data_direction, struct bio **hbio)
 876 {
 877         struct pscsi_dev_virt *pdv = PSCSI_DEV(cmd->se_dev);
 878         struct bio *bio = NULL, *tbio = NULL;
 879         struct page *page;
 880         struct scatterlist *sg;
 881         u32 data_len = cmd->data_length, i, len, bytes, off;
 882         int nr_pages = (cmd->data_length + sgl[0].offset +
 883                         PAGE_SIZE - 1) >> PAGE_SHIFT;
 884         int nr_vecs = 0, rc;
 885         int rw = (data_direction == DMA_TO_DEVICE);
 886
 887         *hbio = NULL;
 888
 889         pr_debug("PSCSI: nr_pages: %d\n", nr_pages);
 890
 891         for_each_sg(sgl, sg, sgl_nents, i) {
 892                 page = sg_page(sg);
 893                 off = sg->offset;
 894                 len = sg->length;
 895
 896                 pr_debug("PSCSI: i: %d page: %p len: %d off: %d\n", i,
 897                         page, len, off);
 898
 899                 /*
 900                  * We only have one page of data in each sg element,
 901                  * we can not cross a page boundary.
 902                  */
 903                 if (off + len > PAGE_SIZE)
 904                         goto fail;
 905
 906                 if (len > 0 && data_len > 0) {
 907                         bytes = min_t(unsigned int, len, PAGE_SIZE - off);
 908                         bytes = min(bytes, data_len);
 909
 910                         if (!bio) {
 911                                 nr_vecs = min_t(int, BIO_MAX_PAGES, nr_pages);
 912                                 nr_pages -= nr_vecs;
 913                                 /*
 914                                  * Calls bio_kmalloc() and sets bio->bi_end_io()
 915                                  */
 916                                 bio = pscsi_get_bio(nr_vecs);
 917                                 if (!bio)
 918                                         goto fail;
 919
 920                                 if (rw)
 921                                         bio->bi_rw |= REQ_WRITE;
 922
 923                                 pr_debug("PSCSI: Allocated bio: %p,"
 924                                         " dir: %s nr_vecs: %d\n", bio,
 925                                         (rw) ? "rw" : "r", nr_vecs);
 926                                 /*
 927                                  * Set *hbio pointer to handle the case:
 928                                  * nr_pages > BIO_MAX_PAGES, where additional
 929                                  * bios need to be added to complete a given
 930                                  * command.
 931                                  */
 932                                 if (!*hbio)
 933                                         *hbio = tbio = bio;
 934                                 else
 935                                         tbio = tbio->bi_next = bio;
 936                         }
 937
 938                         pr_debug("PSCSI: Calling bio_add_pc_page() i: %d"
 939                                 " bio: %p page: %p len: %d off: %d\n", i, bio,
 940                                 page, len, off);
 941
 942                         rc = bio_add_pc_page(pdv->pdv_sd->request_queue,
 943                                         bio, page, bytes, off);
 944                         if (rc != bytes)
 945                                 goto fail;
 946
 947                         pr_debug("PSCSI: bio->bi_vcnt: %d nr_vecs: %d\n",
 948                                 bio->bi_vcnt, nr_vecs);
 949
 950                         if (bio->bi_vcnt > nr_vecs) {
 951                                 pr_debug("PSCSI: Reached bio->bi_vcnt max:"
 952                                         " %d i: %d bio: %p, allocating another"
 953                                         " bio\n", bio->bi_vcnt, i, bio);
 954                                 /*
 955                                  * Clear the pointer so that another bio will
 956                                  * be allocated with pscsi_get_bio() above, the
 957                                  * current bio has already been set *tbio and
 958                                  * bio->bi_next.
 959                                  */
 960                                 bio = NULL;
 961                         }
 962
 963                         data_len -= bytes;
 964                 }
 965         }
 966
 967         return 0;
 968 fail:
 969         while (*hbio) {
 970                 bio = *hbio;
 971                 *hbio = (*hbio)->bi_next;
 972                 bio_endio(bio, 0);      /* XXX: should be error */
 973         }
 974         return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
 975 }
 976
 977 static sense_reason_t
 978 pscsi_parse_cdb(struct se_cmd *cmd)
 979 {
 980         if (cmd->se_cmd_flags & SCF_BIDI)
 981                 return TCM_UNSUPPORTED_SCSI_OPCODE;
 982
 983         return passthrough_parse_cdb(cmd, pscsi_execute_cmd);
 984 }
 985
 986 static sense_reason_t
 987 pscsi_execute_cmd(struct se_cmd *cmd)
 988 {
 989         struct scatterlist *sgl = cmd->t_data_sg;
 990         u32 sgl_nents = cmd->t_data_nents;
 991         enum dma_data_direction data_direction = cmd->data_direction;
 992         struct pscsi_dev_virt *pdv = PSCSI_DEV(cmd->se_dev);
 993         struct pscsi_plugin_task *pt;
 994         struct request *req;
 995         struct bio *hbio;
 996         sense_reason_t ret;
 997
 998         /*
 999          * Dynamically alloc cdb space, since it may be larger than
1000          * TCM_MAX_COMMAND_SIZE
1001          */
1002         pt = kzalloc(sizeof(*pt) + scsi_command_size(cmd->t_task_cdb), GFP_KERNEL);
1003         if (!pt) {
1004                 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1005         }
1006         cmd->priv = pt;
1007
1008         memcpy(pt->pscsi_cdb, cmd->t_task_cdb,
1009                 scsi_command_size(cmd->t_task_cdb));
1010
1011         if (!sgl) {
1012                 req = blk_get_request(pdv->pdv_sd->request_queue,
1013                                 (data_direction == DMA_TO_DEVICE),
1014                                 GFP_KERNEL);
1015                 if (IS_ERR(req)) {
1016                         pr_err("PSCSI: blk_get_request() failed\n");
1017                         ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1018                         goto fail;
1019                 }
1020
1021                 blk_rq_set_block_pc(req);
1022         } else {
1023                 BUG_ON(!cmd->data_length);
1024
1025                 ret = pscsi_map_sg(cmd, sgl, sgl_nents, data_direction, &hbio);
1026                 if (ret)
1027                         goto fail;
1028
1029                 req = blk_make_request(pdv->pdv_sd->request_queue, hbio,
1030                                        GFP_KERNEL);
1031                 if (IS_ERR(req)) {
1032                         pr_err("pSCSI: blk_make_request() failed\n");
1033                         ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1034                         goto fail_free_bio;
1035                 }
1036         }
1037
1038         req->end_io = pscsi_req_done;
1039         req->end_io_data = cmd;
1040         req->cmd_len = scsi_command_size(pt->pscsi_cdb);
1041         req->cmd = &pt->pscsi_cdb[0];
1042         req->sense = &pt->pscsi_sense[0];
1043         req->sense_len = 0;
1044         if (pdv->pdv_sd->type == TYPE_DISK)
1045                 req->timeout = PS_TIMEOUT_DISK;
1046         else
1047                 req->timeout = PS_TIMEOUT_OTHER;
1048         req->retries = PS_RETRY;
1049
1050         blk_execute_rq_nowait(pdv->pdv_sd->request_queue, NULL, req,
1051                         (cmd->sam_task_attr == TCM_HEAD_TAG),
1052                         pscsi_req_done);
1053
1054         return 0;
1055
1056 fail_free_bio:
1057         while (hbio) {
1058                 struct bio *bio = hbio;
1059                 hbio = hbio->bi_next;
1060                 bio_endio(bio, 0);      /* XXX: should be error */
1061         }
1062         ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1063 fail:
1064         kfree(pt);
1065         return ret;
1066 }
1067
1068 /*      pscsi_get_device_type():
1069  *
1070  *
1071  */
1072 static u32 pscsi_get_device_type(struct se_device *dev)
1073 {
1074         struct pscsi_dev_virt *pdv = PSCSI_DEV(dev);
1075         struct scsi_device *sd = pdv->pdv_sd;
1076
1077         return (sd) ? sd->type : TYPE_NO_LUN;
1078 }
1079
1080 static sector_t pscsi_get_blocks(struct se_device *dev)
1081 {
1082         struct pscsi_dev_virt *pdv = PSCSI_DEV(dev);
1083
1084         if (pdv->pdv_bd && pdv->pdv_bd->bd_part)
1085                 return pdv->pdv_bd->bd_part->nr_sects;
1086
1087         dump_stack();
1088         return 0;
1089 }
1090
1091 static void pscsi_req_done(struct request *req, int uptodate)
1092 {
1093         struct se_cmd *cmd = req->end_io_data;
1094         struct pscsi_plugin_task *pt = cmd->priv;
1095
1096         pt->pscsi_result = req->errors;
1097         pt->pscsi_resid = req->resid_len;
1098
1099         cmd->scsi_status = status_byte(pt->pscsi_result) << 1;
1100         if (cmd->scsi_status) {
1101                 pr_debug("PSCSI Status Byte exception at cmd: %p CDB:"
1102                         " 0x%02x Result: 0x%08x\n", cmd, pt->pscsi_cdb[0],
1103                         pt->pscsi_result);
1104         }
1105
1106         switch (host_byte(pt->pscsi_result)) {
1107         case DID_OK:
1108                 target_complete_cmd(cmd, cmd->scsi_status);
1109                 break;
1110         default:
1111                 pr_debug("PSCSI Host Byte exception at cmd: %p CDB:"
1112                         " 0x%02x Result: 0x%08x\n", cmd, pt->pscsi_cdb[0],
1113                         pt->pscsi_result);
1114                 target_complete_cmd(cmd, SAM_STAT_CHECK_CONDITION);
1115                 break;
1116         }
1117
1118         __blk_put_request(req->q, req);
1119         kfree(pt);
1120 }
1121
1122 DEF_TB_DEV_ATTRIB_RO(pscsi, hw_pi_prot_type);
1123 TB_DEV_ATTR_RO(pscsi, hw_pi_prot_type);
1124
1125 DEF_TB_DEV_ATTRIB_RO(pscsi, hw_block_size);
1126 TB_DEV_ATTR_RO(pscsi, hw_block_size);
1127
1128 DEF_TB_DEV_ATTRIB_RO(pscsi, hw_max_sectors);
1129 TB_DEV_ATTR_RO(pscsi, hw_max_sectors);
1130
1131 DEF_TB_DEV_ATTRIB_RO(pscsi, hw_queue_depth);
1132 TB_DEV_ATTR_RO(pscsi, hw_queue_depth);
1133
1134 static struct configfs_attribute *pscsi_backend_dev_attrs[] = {
1135         &pscsi_dev_attrib_hw_pi_prot_type.attr,
1136         &pscsi_dev_attrib_hw_block_size.attr,
1137         &pscsi_dev_attrib_hw_max_sectors.attr,
1138         &pscsi_dev_attrib_hw_queue_depth.attr,
1139         NULL,
1140 };
1141
1142 static const struct target_backend_ops pscsi_ops = {
1143         .name                   = "pscsi",
1144         .owner                  = THIS_MODULE,
1145         .transport_flags        = TRANSPORT_FLAG_PASSTHROUGH,
1146         .attach_hba             = pscsi_attach_hba,
1147         .detach_hba             = pscsi_detach_hba,
1148         .pmode_enable_hba       = pscsi_pmode_enable_hba,
1149         .alloc_device           = pscsi_alloc_device,
1150         .configure_device       = pscsi_configure_device,
1151         .free_device            = pscsi_free_device,
1152         .transport_complete     = pscsi_transport_complete,
1153         .parse_cdb              = pscsi_parse_cdb,
1154         .set_configfs_dev_params = pscsi_set_configfs_dev_params,
1155         .show_configfs_dev_params = pscsi_show_configfs_dev_params,
1156         .get_device_type        = pscsi_get_device_type,
1157         .get_blocks             = pscsi_get_blocks,
1158         .tb_dev_attrib_attrs    = pscsi_backend_dev_attrs,
1159 };
1160
1161 static int __init pscsi_module_init(void)
1162 {
1163         return transport_backend_register(&pscsi_ops);
1164 }
1165
1166 static void __exit pscsi_module_exit(void)
1167 {
1168         target_backend_unregister(&pscsi_ops);
1169 }
1170
1171 MODULE_DESCRIPTION("TCM PSCSI subsystem plugin");
1172 MODULE_AUTHOR("nab@Linux-iSCSI.org");
1173 MODULE_LICENSE("GPL");
1174
1175 module_init(pscsi_module_init);
1176 module_exit(pscsi_module_exit);