1 /*******************************************************************************
2 * Filename: target_core_pscsi.c
4 * This file contains the generic target mode <-> Linux SCSI subsystem plugin.
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
11 * Nicholas A. Bellinger <nab@kernel.org>
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.
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.
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.
27 ******************************************************************************/
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>
46 #include <target/target_core_base.h>
47 #include <target/target_core_device.h>
48 #include <target/target_core_transport.h>
50 #include "target_core_pscsi.h"
52 #define ISPRINT(a) ((a >= ' ') && (a <= '~'))
54 static struct se_subsystem_api pscsi_template;
56 static void pscsi_req_done(struct request *, int);
58 /* pscsi_attach_hba():
60 * pscsi_get_sh() used scsi_host_lookup() to locate struct Scsi_Host.
61 * from the passed SCSI Host ID.
63 static int pscsi_attach_hba(struct se_hba *hba, u32 host_id)
65 struct pscsi_hba_virt *phv;
67 phv = kzalloc(sizeof(struct pscsi_hba_virt), GFP_KERNEL);
69 pr_err("Unable to allocate struct pscsi_hba_virt\n");
72 phv->phv_host_id = host_id;
73 phv->phv_mode = PHV_VIRUTAL_HOST_ID;
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",
86 static void pscsi_detach_hba(struct se_hba *hba)
88 struct pscsi_hba_virt *phv = hba->hba_ptr;
89 struct Scsi_Host *scsi_host = phv->phv_lld_host;
92 scsi_host_put(scsi_host);
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) :
99 pr_debug("CORE_HBA[%d] - Detached Virtual SCSI HBA"
100 " from Generic Target Core\n", hba->hba_id);
106 static int pscsi_pmode_enable_hba(struct se_hba *hba, unsigned long mode_flag)
108 struct pscsi_hba_virt *phv = (struct pscsi_hba_virt *)hba->hba_ptr;
109 struct Scsi_Host *sh = phv->phv_lld_host;
111 * Release the struct Scsi_Host
117 phv->phv_lld_host = NULL;
118 phv->phv_mode = PHV_VIRUTAL_HOST_ID;
120 pr_debug("CORE_HBA[%d] - Disabled pSCSI HBA Passthrough"
121 " %s\n", hba->hba_id, (sh->hostt->name) ?
122 (sh->hostt->name) : "Unknown");
128 * Otherwise, locate struct Scsi_Host from the original passed
129 * pSCSI Host ID and enable for phba mode
131 sh = scsi_host_lookup(phv->phv_host_id);
133 pr_err("pSCSI: Unable to locate SCSI Host for"
134 " phv_host_id: %d\n", phv->phv_host_id);
138 phv->phv_lld_host = sh;
139 phv->phv_mode = PHV_LLD_SCSI_HOST_NO;
141 pr_debug("CORE_HBA[%d] - Enabled pSCSI HBA Passthrough %s\n",
142 hba->hba_id, (sh->hostt->name) ? (sh->hostt->name) : "Unknown");
147 static void pscsi_tape_read_blocksize(struct se_device *dev,
148 struct scsi_device *sdev)
150 unsigned char cdb[MAX_COMMAND_SIZE], *buf;
153 buf = kzalloc(12, GFP_KERNEL);
157 memset(cdb, 0, MAX_COMMAND_SIZE);
159 cdb[4] = 0x0c; /* 12 bytes */
161 ret = scsi_execute_req(sdev, cdb, DMA_FROM_DEVICE, buf, 12, NULL,
167 * If MODE_SENSE still returns zero, set the default value to 1024.
169 sdev->sector_size = (buf[9] << 16) | (buf[10] << 8) | (buf[11]);
170 if (!sdev->sector_size)
171 sdev->sector_size = 1024;
177 pscsi_set_inquiry_info(struct scsi_device *sdev, struct t10_wwn *wwn)
181 if (sdev->inquiry_len < INQUIRY_LEN)
188 * Use sdev->inquiry from drivers/scsi/scsi_scan.c:scsi_alloc_sdev()
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));
196 pscsi_get_inquiry_vpd_serial(struct scsi_device *sdev, struct t10_wwn *wwn)
198 unsigned char cdb[MAX_COMMAND_SIZE], *buf;
201 buf = kzalloc(INQUIRY_VPD_SERIAL_LEN, GFP_KERNEL);
205 memset(cdb, 0, MAX_COMMAND_SIZE);
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);
212 ret = scsi_execute_req(sdev, cdb, DMA_FROM_DEVICE, buf,
213 INQUIRY_VPD_SERIAL_LEN, NULL, HZ, 1, NULL);
217 snprintf(&wwn->unit_serial[0], INQUIRY_VPD_SERIAL_LEN, "%s", &buf[4]);
219 wwn->t10_sub_dev->su_dev_flags |= SDF_FIRMWARE_VPD_UNIT_SERIAL;
230 pscsi_get_inquiry_vpd_device_ident(struct scsi_device *sdev,
233 unsigned char cdb[MAX_COMMAND_SIZE], *buf, *page_83;
234 int ident_len, page_len, off = 4, ret;
237 buf = kzalloc(INQUIRY_VPD_SERIAL_LEN, GFP_KERNEL);
241 memset(cdb, 0, MAX_COMMAND_SIZE);
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);
248 ret = scsi_execute_req(sdev, cdb, DMA_FROM_DEVICE, buf,
249 INQUIRY_VPD_DEVICE_IDENTIFIER_LEN,
254 page_len = (buf[2] << 8) | buf[3];
255 while (page_len > 0) {
256 /* Grab a pointer to the Identification descriptor */
258 ident_len = page_83[3];
260 pr_err("page_83[3]: identifier"
264 pr_debug("T10 VPD Identifer Length: %d\n", ident_len);
266 vpd = kzalloc(sizeof(struct t10_vpd), GFP_KERNEL);
268 pr_err("Unable to allocate memory for"
269 " struct t10_vpd\n");
272 INIT_LIST_HEAD(&vpd->vpd_list);
274 transport_set_vpd_proto_id(vpd, page_83);
275 transport_set_vpd_assoc(vpd, page_83);
277 if (transport_set_vpd_ident_type(vpd, page_83) < 0) {
278 off += (ident_len + 4);
279 page_len -= (ident_len + 4);
283 if (transport_set_vpd_ident(vpd, page_83) < 0) {
284 off += (ident_len + 4);
285 page_len -= (ident_len + 4);
290 list_add_tail(&vpd->vpd_list, &wwn->t10_vpd_list);
291 off += (ident_len + 4);
292 page_len -= (ident_len + 4);
299 /* pscsi_add_device_to_list():
303 static struct se_device *pscsi_add_device_to_list(
305 struct se_subsystem_dev *se_dev,
306 struct pscsi_dev_virt *pdv,
307 struct scsi_device *sd,
310 struct se_device *dev;
311 struct se_dev_limits dev_limits;
312 struct request_queue *q;
313 struct queue_limits *limits;
315 memset(&dev_limits, 0, sizeof(struct se_dev_limits));
317 if (!sd->queue_depth) {
318 sd->queue_depth = PSCSI_DEFAULT_QUEUEDEPTH;
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);
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.
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;
336 * Setup our standard INQUIRY info into se_dev->t10_wwn
338 pscsi_set_inquiry_info(sd, &se_dev->t10_wwn);
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().
345 * The passthrough operations called by the transport_add_device_*
346 * function below will require this pointer to be set for passthroug
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.
355 dev = transport_add_device_to_core_hba(hba, &pscsi_template,
356 se_dev, dev_flags, pdv,
357 &dev_limits, NULL, NULL);
364 * Locate VPD WWN Information used for various purposes within
365 * the Storage Engine.
367 if (!pscsi_get_inquiry_vpd_serial(sd, &se_dev->t10_wwn)) {
369 * If VPD Unit Serial returned GOOD status, try
370 * VPD Device Identification page (0x83).
372 pscsi_get_inquiry_vpd_device_ident(sd, &se_dev->t10_wwn);
376 * For TYPE_TAPE, attempt to determine blocksize with MODE_SENSE.
378 if (sd->type == TYPE_TAPE)
379 pscsi_tape_read_blocksize(dev, sd);
383 static void *pscsi_allocate_virtdevice(struct se_hba *hba, const char *name)
385 struct pscsi_dev_virt *pdv;
387 pdv = kzalloc(sizeof(struct pscsi_dev_virt), GFP_KERNEL);
389 pr_err("Unable to allocate memory for struct pscsi_dev_virt\n");
392 pdv->pdv_se_hba = hba;
394 pr_debug("PSCSI: Allocated pdv: %p for %s\n", pdv, name);
399 * Called with struct Scsi_Host->host_lock called.
401 static 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,
406 __releases(sh->host_lock)
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;
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);
420 spin_unlock_irq(sh->host_lock);
422 * Claim exclusive struct block_device access to struct scsi_device
423 * for TYPE_DISK using supplied udev_path
425 bd = blkdev_get_by_path(se_dev->se_dev_udev_path,
426 FMODE_WRITE|FMODE_READ|FMODE_EXCL, pdv);
428 pr_err("pSCSI: blkdev_get_by_path() failed\n");
434 dev = pscsi_add_device_to_list(hba, se_dev, pdv, sd, dev_flags);
436 blkdev_put(pdv->pdv_bd, FMODE_WRITE|FMODE_READ|FMODE_EXCL);
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);
447 * Called with struct Scsi_Host->host_lock called.
449 static 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,
454 __releases(sh->host_lock)
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;
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);
467 spin_unlock_irq(sh->host_lock);
469 dev = pscsi_add_device_to_list(hba, se_dev, pdv, sd, dev_flags);
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);
482 *Called with struct Scsi_Host->host_lock called.
484 static 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,
489 __releases(sh->host_lock)
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;
496 spin_unlock_irq(sh->host_lock);
497 dev = pscsi_add_device_to_list(hba, se_dev, pdv, sd, dev_flags);
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);
508 static struct se_device *pscsi_create_virtdevice(
510 struct se_subsystem_dev *se_dev,
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;
521 pr_err("Unable to locate struct pscsi_dev_virt"
523 return ERR_PTR(-EINVAL);
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
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);
536 * For the newer PHV_VIRUTAL_HOST_ID struct scsi_device
537 * reference, we enforce that udev_path has been set
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);
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.
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);
557 spin_unlock(&hba->device_lock);
559 if (pscsi_pmode_enable_hba(hba, 1) != 1)
560 return ERR_PTR(-ENODEV);
562 legacy_mode_enable = 1;
563 hba->hba_flags |= HBA_FLAGS_PSCSI_MODE;
564 sh = phv->phv_lld_host;
566 sh = scsi_host_lookup(pdv->pdv_host_id);
568 pr_err("pSCSI: Unable to locate"
569 " pdv_host_id: %d\n", pdv->pdv_host_id);
570 return ERR_PTR(-EINVAL);
572 pdv->pdv_lld_host = sh;
575 if (phv->phv_mode == PHV_VIRUTAL_HOST_ID) {
576 pr_err("pSCSI: PHV_VIRUTAL_HOST_ID set while"
577 " struct Scsi_Host exists\n");
578 return ERR_PTR(-EEXIST);
582 spin_lock_irq(sh->host_lock);
583 list_for_each_entry(sd, &sh->__devices, siblings) {
584 if ((pdv->pdv_channel_id != sd->channel) ||
585 (pdv->pdv_target_id != sd->id) ||
586 (pdv->pdv_lun_id != sd->lun))
589 * Functions will release the held struct scsi_host->host_lock
590 * before calling calling pscsi_add_device_to_list() to register
591 * struct scsi_device with target_core_mod.
595 dev = pscsi_create_type_disk(sd, pdv, se_dev, hba);
598 dev = pscsi_create_type_rom(sd, pdv, se_dev, hba);
601 dev = pscsi_create_type_other(sd, pdv, se_dev, hba);
606 if (phv->phv_mode == PHV_VIRUTAL_HOST_ID)
608 else if (legacy_mode_enable) {
609 pscsi_pmode_enable_hba(hba, 0);
610 hba->hba_flags &= ~HBA_FLAGS_PSCSI_MODE;
613 return ERR_PTR(-ENODEV);
617 spin_unlock_irq(sh->host_lock);
619 pr_err("pSCSI: Unable to locate %d:%d:%d:%d\n", sh->host_no,
620 pdv->pdv_channel_id, pdv->pdv_target_id, pdv->pdv_lun_id);
622 if (phv->phv_mode == PHV_VIRUTAL_HOST_ID)
624 else if (legacy_mode_enable) {
625 pscsi_pmode_enable_hba(hba, 0);
626 hba->hba_flags &= ~HBA_FLAGS_PSCSI_MODE;
629 return ERR_PTR(-ENODEV);
632 /* pscsi_free_device(): (Part of se_subsystem_api_t template)
636 static void pscsi_free_device(void *p)
638 struct pscsi_dev_virt *pdv = p;
639 struct pscsi_hba_virt *phv = pdv->pdv_se_hba->hba_ptr;
640 struct scsi_device *sd = pdv->pdv_sd;
644 * Release exclusive pSCSI internal struct block_device claim for
645 * struct scsi_device with TYPE_DISK from pscsi_create_type_disk()
647 if ((sd->type == TYPE_DISK) && pdv->pdv_bd) {
648 blkdev_put(pdv->pdv_bd,
649 FMODE_WRITE|FMODE_READ|FMODE_EXCL);
653 * For HBA mode PHV_LLD_SCSI_HOST_NO, release the reference
654 * to struct Scsi_Host now.
656 if ((phv->phv_mode == PHV_LLD_SCSI_HOST_NO) &&
657 (phv->phv_lld_host != NULL))
658 scsi_host_put(phv->phv_lld_host);
659 else if (pdv->pdv_lld_host)
660 scsi_host_put(pdv->pdv_lld_host);
662 if ((sd->type == TYPE_DISK) || (sd->type == TYPE_ROM))
671 static inline struct pscsi_plugin_task *PSCSI_TASK(struct se_task *task)
673 return container_of(task, struct pscsi_plugin_task, pscsi_task);
677 /* pscsi_transport_complete():
681 static int pscsi_transport_complete(struct se_task *task)
683 struct pscsi_dev_virt *pdv = task->task_se_cmd->se_dev->dev_ptr;
684 struct scsi_device *sd = pdv->pdv_sd;
686 struct pscsi_plugin_task *pt = PSCSI_TASK(task);
687 unsigned char *cdb = &pt->pscsi_cdb[0];
689 result = pt->pscsi_result;
691 * Hack to make sure that Write-Protect modepage is set if R/O mode is
694 if (((cdb[0] == MODE_SENSE) || (cdb[0] == MODE_SENSE_10)) &&
695 (status_byte(result) << 1) == SAM_STAT_GOOD) {
696 if (!task->task_se_cmd->se_deve)
697 goto after_mode_sense;
699 if (task->task_se_cmd->se_deve->lun_flags &
700 TRANSPORT_LUNFLAGS_READ_ONLY) {
701 unsigned char *buf = transport_kmap_data_sg(task->task_se_cmd);
703 if (cdb[0] == MODE_SENSE_10) {
704 if (!(buf[3] & 0x80))
707 if (!(buf[2] & 0x80))
711 transport_kunmap_data_sg(task->task_se_cmd);
716 if (sd->type != TYPE_TAPE)
717 goto after_mode_select;
720 * Hack to correctly obtain the initiator requested blocksize for
721 * TYPE_TAPE. Since this value is dependent upon each tape media,
722 * struct scsi_device->sector_size will not contain the correct value
723 * by default, so we go ahead and set it so
724 * TRANSPORT(dev)->get_blockdev() returns the correct value to the
727 if (((cdb[0] == MODE_SELECT) || (cdb[0] == MODE_SELECT_10)) &&
728 (status_byte(result) << 1) == SAM_STAT_GOOD) {
730 struct scatterlist *sg = task->task_sg;
734 buf = sg_virt(&sg[0]);
736 pr_err("Unable to get buf for scatterlist\n");
737 goto after_mode_select;
740 if (cdb[0] == MODE_SELECT)
743 bdl = (buf[6] << 8) | (buf[7]);
746 goto after_mode_select;
748 if (cdb[0] == MODE_SELECT)
749 blocksize = (buf[9] << 16) | (buf[10] << 8) |
752 blocksize = (buf[13] << 16) | (buf[14] << 8) |
755 sd->sector_size = blocksize;
759 if (status_byte(result) & CHECK_CONDITION)
765 static struct se_task *
766 pscsi_alloc_task(unsigned char *cdb)
768 struct pscsi_plugin_task *pt;
771 * Dynamically alloc cdb space, since it may be larger than
772 * TCM_MAX_COMMAND_SIZE
774 pt = kzalloc(sizeof(*pt) + scsi_command_size(cdb), GFP_KERNEL);
776 pr_err("Unable to allocate struct pscsi_plugin_task\n");
780 return &pt->pscsi_task;
783 static void pscsi_free_task(struct se_task *task)
785 struct pscsi_plugin_task *pt = PSCSI_TASK(task);
788 * We do not release the bio(s) here associated with this task, as
789 * this is handled by bio_put() and pscsi_bi_endio().
795 Opt_scsi_host_id, Opt_scsi_channel_id, Opt_scsi_target_id,
796 Opt_scsi_lun_id, Opt_err
799 static match_table_t tokens = {
800 {Opt_scsi_host_id, "scsi_host_id=%d"},
801 {Opt_scsi_channel_id, "scsi_channel_id=%d"},
802 {Opt_scsi_target_id, "scsi_target_id=%d"},
803 {Opt_scsi_lun_id, "scsi_lun_id=%d"},
807 static ssize_t pscsi_set_configfs_dev_params(struct se_hba *hba,
808 struct se_subsystem_dev *se_dev,
812 struct pscsi_dev_virt *pdv = se_dev->se_dev_su_ptr;
813 struct pscsi_hba_virt *phv = hba->hba_ptr;
814 char *orig, *ptr, *opts;
815 substring_t args[MAX_OPT_ARGS];
816 int ret = 0, arg, token;
818 opts = kstrdup(page, GFP_KERNEL);
824 while ((ptr = strsep(&opts, ",")) != NULL) {
828 token = match_token(ptr, tokens, args);
830 case Opt_scsi_host_id:
831 if (phv->phv_mode == PHV_LLD_SCSI_HOST_NO) {
832 pr_err("PSCSI[%d]: Unable to accept"
833 " scsi_host_id while phv_mode =="
834 " PHV_LLD_SCSI_HOST_NO\n",
839 match_int(args, &arg);
840 pdv->pdv_host_id = arg;
841 pr_debug("PSCSI[%d]: Referencing SCSI Host ID:"
842 " %d\n", phv->phv_host_id, pdv->pdv_host_id);
843 pdv->pdv_flags |= PDF_HAS_VIRT_HOST_ID;
845 case Opt_scsi_channel_id:
846 match_int(args, &arg);
847 pdv->pdv_channel_id = arg;
848 pr_debug("PSCSI[%d]: Referencing SCSI Channel"
849 " ID: %d\n", phv->phv_host_id,
850 pdv->pdv_channel_id);
851 pdv->pdv_flags |= PDF_HAS_CHANNEL_ID;
853 case Opt_scsi_target_id:
854 match_int(args, &arg);
855 pdv->pdv_target_id = arg;
856 pr_debug("PSCSI[%d]: Referencing SCSI Target"
857 " ID: %d\n", phv->phv_host_id,
859 pdv->pdv_flags |= PDF_HAS_TARGET_ID;
861 case Opt_scsi_lun_id:
862 match_int(args, &arg);
863 pdv->pdv_lun_id = arg;
864 pr_debug("PSCSI[%d]: Referencing SCSI LUN ID:"
865 " %d\n", phv->phv_host_id, pdv->pdv_lun_id);
866 pdv->pdv_flags |= PDF_HAS_LUN_ID;
875 return (!ret) ? count : ret;
878 static ssize_t pscsi_check_configfs_dev_params(
880 struct se_subsystem_dev *se_dev)
882 struct pscsi_dev_virt *pdv = se_dev->se_dev_su_ptr;
884 if (!(pdv->pdv_flags & PDF_HAS_CHANNEL_ID) ||
885 !(pdv->pdv_flags & PDF_HAS_TARGET_ID) ||
886 !(pdv->pdv_flags & PDF_HAS_LUN_ID)) {
887 pr_err("Missing scsi_channel_id=, scsi_target_id= and"
888 " scsi_lun_id= parameters\n");
895 static ssize_t pscsi_show_configfs_dev_params(struct se_hba *hba,
896 struct se_subsystem_dev *se_dev,
899 struct pscsi_hba_virt *phv = hba->hba_ptr;
900 struct pscsi_dev_virt *pdv = se_dev->se_dev_su_ptr;
901 struct scsi_device *sd = pdv->pdv_sd;
902 unsigned char host_id[16];
906 if (phv->phv_mode == PHV_VIRUTAL_HOST_ID)
907 snprintf(host_id, 16, "%d", pdv->pdv_host_id);
909 snprintf(host_id, 16, "PHBA Mode");
911 bl = sprintf(b, "SCSI Device Bus Location:"
912 " Channel ID: %d Target ID: %d LUN: %d Host ID: %s\n",
913 pdv->pdv_channel_id, pdv->pdv_target_id, pdv->pdv_lun_id,
917 bl += sprintf(b + bl, " ");
918 bl += sprintf(b + bl, "Vendor: ");
919 for (i = 0; i < 8; i++) {
920 if (ISPRINT(sd->vendor[i])) /* printable character? */
921 bl += sprintf(b + bl, "%c", sd->vendor[i]);
923 bl += sprintf(b + bl, " ");
925 bl += sprintf(b + bl, " Model: ");
926 for (i = 0; i < 16; i++) {
927 if (ISPRINT(sd->model[i])) /* printable character ? */
928 bl += sprintf(b + bl, "%c", sd->model[i]);
930 bl += sprintf(b + bl, " ");
932 bl += sprintf(b + bl, " Rev: ");
933 for (i = 0; i < 4; i++) {
934 if (ISPRINT(sd->rev[i])) /* printable character ? */
935 bl += sprintf(b + bl, "%c", sd->rev[i]);
937 bl += sprintf(b + bl, " ");
939 bl += sprintf(b + bl, "\n");
944 static void pscsi_bi_endio(struct bio *bio, int error)
949 static inline struct bio *pscsi_get_bio(int sg_num)
953 * Use bio_malloc() following the comment in for bio -> struct request
954 * in block/blk-core.c:blk_make_request()
956 bio = bio_kmalloc(GFP_KERNEL, sg_num);
958 pr_err("PSCSI: bio_kmalloc() failed\n");
961 bio->bi_end_io = pscsi_bi_endio;
966 static int pscsi_map_sg(struct se_task *task, struct scatterlist *task_sg,
969 struct se_cmd *cmd = task->task_se_cmd;
970 struct pscsi_dev_virt *pdv = task->task_se_cmd->se_dev->dev_ptr;
971 u32 task_sg_num = task->task_sg_nents;
972 struct bio *bio = NULL, *tbio = NULL;
974 struct scatterlist *sg;
975 u32 data_len = task->task_size, i, len, bytes, off;
976 int nr_pages = (task->task_size + task_sg[0].offset +
977 PAGE_SIZE - 1) >> PAGE_SHIFT;
979 int rw = (task->task_data_direction == DMA_TO_DEVICE);
983 pr_debug("PSCSI: nr_pages: %d\n", nr_pages);
985 for_each_sg(task_sg, sg, task_sg_num, i) {
990 pr_debug("PSCSI: i: %d page: %p len: %d off: %d\n", i,
993 while (len > 0 && data_len > 0) {
994 bytes = min_t(unsigned int, len, PAGE_SIZE - off);
995 bytes = min(bytes, data_len);
998 nr_vecs = min_t(int, BIO_MAX_PAGES, nr_pages);
1001 * Calls bio_kmalloc() and sets bio->bi_end_io()
1003 bio = pscsi_get_bio(nr_vecs);
1008 bio->bi_rw |= REQ_WRITE;
1010 pr_debug("PSCSI: Allocated bio: %p,"
1011 " dir: %s nr_vecs: %d\n", bio,
1012 (rw) ? "rw" : "r", nr_vecs);
1014 * Set *hbio pointer to handle the case:
1015 * nr_pages > BIO_MAX_PAGES, where additional
1016 * bios need to be added to complete a given
1022 tbio = tbio->bi_next = bio;
1025 pr_debug("PSCSI: Calling bio_add_pc_page() i: %d"
1026 " bio: %p page: %p len: %d off: %d\n", i, bio,
1029 rc = bio_add_pc_page(pdv->pdv_sd->request_queue,
1030 bio, page, bytes, off);
1034 pr_debug("PSCSI: bio->bi_vcnt: %d nr_vecs: %d\n",
1035 bio->bi_vcnt, nr_vecs);
1037 if (bio->bi_vcnt > nr_vecs) {
1038 pr_debug("PSCSI: Reached bio->bi_vcnt max:"
1039 " %d i: %d bio: %p, allocating another"
1040 " bio\n", bio->bi_vcnt, i, bio);
1042 * Clear the pointer so that another bio will
1043 * be allocated with pscsi_get_bio() above, the
1044 * current bio has already been set *tbio and
1057 return task->task_sg_nents;
1061 *hbio = (*hbio)->bi_next;
1062 bio->bi_next = NULL;
1063 bio_endio(bio, 0); /* XXX: should be error */
1065 cmd->scsi_sense_reason = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1069 static int pscsi_do_task(struct se_task *task)
1071 struct se_cmd *cmd = task->task_se_cmd;
1072 struct pscsi_dev_virt *pdv = task->task_se_cmd->se_dev->dev_ptr;
1073 struct pscsi_plugin_task *pt = PSCSI_TASK(task);
1074 struct request *req;
1078 target_get_task_cdb(task, pt->pscsi_cdb);
1080 if (task->task_se_cmd->se_cmd_flags & SCF_SCSI_NON_DATA_CDB) {
1081 req = blk_get_request(pdv->pdv_sd->request_queue,
1082 (task->task_data_direction == DMA_TO_DEVICE),
1084 if (!req || IS_ERR(req)) {
1085 pr_err("PSCSI: blk_get_request() failed: %ld\n",
1086 req ? IS_ERR(req) : -ENOMEM);
1087 cmd->scsi_sense_reason =
1088 TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1092 BUG_ON(!task->task_size);
1095 * Setup the main struct request for the task->task_sg[] payload
1097 ret = pscsi_map_sg(task, task->task_sg, &hbio);
1099 cmd->scsi_sense_reason =
1100 TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1104 req = blk_make_request(pdv->pdv_sd->request_queue, hbio,
1107 pr_err("pSCSI: blk_make_request() failed\n");
1112 req->cmd_type = REQ_TYPE_BLOCK_PC;
1113 req->end_io = pscsi_req_done;
1114 req->end_io_data = task;
1115 req->cmd_len = scsi_command_size(pt->pscsi_cdb);
1116 req->cmd = &pt->pscsi_cdb[0];
1117 req->sense = &pt->pscsi_sense[0];
1119 if (pdv->pdv_sd->type == TYPE_DISK)
1120 req->timeout = PS_TIMEOUT_DISK;
1122 req->timeout = PS_TIMEOUT_OTHER;
1123 req->retries = PS_RETRY;
1125 blk_execute_rq_nowait(pdv->pdv_sd->request_queue, NULL, req,
1126 (task->task_se_cmd->sam_task_attr == MSG_HEAD_TAG),
1133 struct bio *bio = hbio;
1134 hbio = hbio->bi_next;
1135 bio->bi_next = NULL;
1136 bio_endio(bio, 0); /* XXX: should be error */
1138 cmd->scsi_sense_reason = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1142 /* pscsi_get_sense_buffer():
1146 static unsigned char *pscsi_get_sense_buffer(struct se_task *task)
1148 struct pscsi_plugin_task *pt = PSCSI_TASK(task);
1150 return (unsigned char *)&pt->pscsi_sense[0];
1153 /* pscsi_get_device_rev():
1157 static u32 pscsi_get_device_rev(struct se_device *dev)
1159 struct pscsi_dev_virt *pdv = dev->dev_ptr;
1160 struct scsi_device *sd = pdv->pdv_sd;
1162 return (sd->scsi_level - 1) ? sd->scsi_level - 1 : 1;
1165 /* pscsi_get_device_type():
1169 static u32 pscsi_get_device_type(struct se_device *dev)
1171 struct pscsi_dev_virt *pdv = dev->dev_ptr;
1172 struct scsi_device *sd = pdv->pdv_sd;
1174 return (sd) ? sd->type : TYPE_NO_LUN;
1177 static sector_t pscsi_get_blocks(struct se_device *dev)
1179 struct pscsi_dev_virt *pdv = dev->dev_ptr;
1181 if (pdv->pdv_bd && pdv->pdv_bd->bd_part)
1182 return pdv->pdv_bd->bd_part->nr_sects;
1188 /* pscsi_handle_SAM_STATUS_failures():
1192 static inline void pscsi_process_SAM_status(
1193 struct se_task *task,
1194 struct pscsi_plugin_task *pt)
1196 task->task_scsi_status = status_byte(pt->pscsi_result);
1197 if (task->task_scsi_status) {
1198 task->task_scsi_status <<= 1;
1199 pr_debug("PSCSI Status Byte exception at task: %p CDB:"
1200 " 0x%02x Result: 0x%08x\n", task, pt->pscsi_cdb[0],
1204 switch (host_byte(pt->pscsi_result)) {
1206 transport_complete_task(task, (!task->task_scsi_status));
1209 pr_debug("PSCSI Host Byte exception at task: %p CDB:"
1210 " 0x%02x Result: 0x%08x\n", task, pt->pscsi_cdb[0],
1212 task->task_scsi_status = SAM_STAT_CHECK_CONDITION;
1213 task->task_se_cmd->scsi_sense_reason =
1214 TCM_UNSUPPORTED_SCSI_OPCODE;
1215 transport_complete_task(task, 0);
1220 static void pscsi_req_done(struct request *req, int uptodate)
1222 struct se_task *task = req->end_io_data;
1223 struct pscsi_plugin_task *pt = PSCSI_TASK(task);
1225 pt->pscsi_result = req->errors;
1226 pt->pscsi_resid = req->resid_len;
1228 pscsi_process_SAM_status(task, pt);
1229 __blk_put_request(req->q, req);
1232 static struct se_subsystem_api pscsi_template = {
1234 .owner = THIS_MODULE,
1235 .transport_type = TRANSPORT_PLUGIN_PHBA_PDEV,
1236 .attach_hba = pscsi_attach_hba,
1237 .detach_hba = pscsi_detach_hba,
1238 .pmode_enable_hba = pscsi_pmode_enable_hba,
1239 .allocate_virtdevice = pscsi_allocate_virtdevice,
1240 .create_virtdevice = pscsi_create_virtdevice,
1241 .free_device = pscsi_free_device,
1242 .transport_complete = pscsi_transport_complete,
1243 .alloc_task = pscsi_alloc_task,
1244 .do_task = pscsi_do_task,
1245 .free_task = pscsi_free_task,
1246 .check_configfs_dev_params = pscsi_check_configfs_dev_params,
1247 .set_configfs_dev_params = pscsi_set_configfs_dev_params,
1248 .show_configfs_dev_params = pscsi_show_configfs_dev_params,
1249 .get_sense_buffer = pscsi_get_sense_buffer,
1250 .get_device_rev = pscsi_get_device_rev,
1251 .get_device_type = pscsi_get_device_type,
1252 .get_blocks = pscsi_get_blocks,
1255 static int __init pscsi_module_init(void)
1257 return transport_subsystem_register(&pscsi_template);
1260 static void pscsi_module_exit(void)
1262 transport_subsystem_release(&pscsi_template);
1265 MODULE_DESCRIPTION("TCM PSCSI subsystem plugin");
1266 MODULE_AUTHOR("nab@Linux-iSCSI.org");
1267 MODULE_LICENSE("GPL");
1269 module_init(pscsi_module_init);
1270 module_exit(pscsi_module_exit);