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