1 /*******************************************************************************
2 * Filename: target_core_pscsi.c
4 * This file contains the generic target mode <-> Linux SCSI subsystem plugin.
6 * (c) Copyright 2003-2013 Datera, Inc.
8 * Nicholas A. Bellinger <nab@kernel.org>
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.
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.
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.
24 ******************************************************************************/
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>
39 #include <scsi/scsi_device.h>
40 #include <scsi/scsi_host.h>
41 #include <scsi/scsi_tcq.h>
43 #include <target/target_core_base.h>
44 #include <target/target_core_backend.h>
46 #include "target_core_alua.h"
47 #include "target_core_internal.h"
48 #include "target_core_pscsi.h"
50 #define ISPRINT(a) ((a >= ' ') && (a <= '~'))
52 static inline struct pscsi_dev_virt *PSCSI_DEV(struct se_device *dev)
54 return container_of(dev, struct pscsi_dev_virt, dev);
57 static sense_reason_t pscsi_execute_cmd(struct se_cmd *cmd);
58 static void pscsi_req_done(struct request *, int);
60 /* pscsi_attach_hba():
62 * pscsi_get_sh() used scsi_host_lookup() to locate struct Scsi_Host.
63 * from the passed SCSI Host ID.
65 static int pscsi_attach_hba(struct se_hba *hba, u32 host_id)
67 struct pscsi_hba_virt *phv;
69 phv = kzalloc(sizeof(struct pscsi_hba_virt), GFP_KERNEL);
71 pr_err("Unable to allocate struct pscsi_hba_virt\n");
74 phv->phv_host_id = host_id;
75 phv->phv_mode = PHV_VIRTUAL_HOST_ID;
79 pr_debug("CORE_HBA[%d] - TCM SCSI HBA Driver %s on"
80 " Generic Target Core Stack %s\n", hba->hba_id,
81 PSCSI_VERSION, TARGET_CORE_VERSION);
82 pr_debug("CORE_HBA[%d] - Attached SCSI HBA to Generic\n",
88 static void pscsi_detach_hba(struct se_hba *hba)
90 struct pscsi_hba_virt *phv = hba->hba_ptr;
91 struct Scsi_Host *scsi_host = phv->phv_lld_host;
94 scsi_host_put(scsi_host);
96 pr_debug("CORE_HBA[%d] - Detached SCSI HBA: %s from"
97 " Generic Target Core\n", hba->hba_id,
98 (scsi_host->hostt->name) ? (scsi_host->hostt->name) :
101 pr_debug("CORE_HBA[%d] - Detached Virtual SCSI HBA"
102 " from Generic Target Core\n", hba->hba_id);
108 static int pscsi_pmode_enable_hba(struct se_hba *hba, unsigned long mode_flag)
110 struct pscsi_hba_virt *phv = hba->hba_ptr;
111 struct Scsi_Host *sh = phv->phv_lld_host;
113 * Release the struct Scsi_Host
119 phv->phv_lld_host = NULL;
120 phv->phv_mode = PHV_VIRTUAL_HOST_ID;
122 pr_debug("CORE_HBA[%d] - Disabled pSCSI HBA Passthrough"
123 " %s\n", hba->hba_id, (sh->hostt->name) ?
124 (sh->hostt->name) : "Unknown");
130 * Otherwise, locate struct Scsi_Host from the original passed
131 * pSCSI Host ID and enable for phba mode
133 sh = scsi_host_lookup(phv->phv_host_id);
135 pr_err("pSCSI: Unable to locate SCSI Host for"
136 " phv_host_id: %d\n", phv->phv_host_id);
140 phv->phv_lld_host = sh;
141 phv->phv_mode = PHV_LLD_SCSI_HOST_NO;
143 pr_debug("CORE_HBA[%d] - Enabled pSCSI HBA Passthrough %s\n",
144 hba->hba_id, (sh->hostt->name) ? (sh->hostt->name) : "Unknown");
149 static void pscsi_tape_read_blocksize(struct se_device *dev,
150 struct scsi_device *sdev)
152 unsigned char cdb[MAX_COMMAND_SIZE], *buf;
155 buf = kzalloc(12, GFP_KERNEL);
159 memset(cdb, 0, MAX_COMMAND_SIZE);
161 cdb[4] = 0x0c; /* 12 bytes */
163 ret = scsi_execute_req(sdev, cdb, DMA_FROM_DEVICE, buf, 12, NULL,
169 * If MODE_SENSE still returns zero, set the default value to 1024.
171 sdev->sector_size = (buf[9] << 16) | (buf[10] << 8) | (buf[11]);
173 if (!sdev->sector_size)
174 sdev->sector_size = 1024;
180 pscsi_set_inquiry_info(struct scsi_device *sdev, struct t10_wwn *wwn)
184 if (sdev->inquiry_len < INQUIRY_LEN)
191 * Use sdev->inquiry from drivers/scsi/scsi_scan.c:scsi_alloc_sdev()
193 memcpy(&wwn->vendor[0], &buf[8], sizeof(wwn->vendor));
194 memcpy(&wwn->model[0], &buf[16], sizeof(wwn->model));
195 memcpy(&wwn->revision[0], &buf[32], sizeof(wwn->revision));
199 pscsi_get_inquiry_vpd_serial(struct scsi_device *sdev, struct t10_wwn *wwn)
201 unsigned char cdb[MAX_COMMAND_SIZE], *buf;
204 buf = kzalloc(INQUIRY_VPD_SERIAL_LEN, GFP_KERNEL);
208 memset(cdb, 0, MAX_COMMAND_SIZE);
210 cdb[1] = 0x01; /* Query VPD */
211 cdb[2] = 0x80; /* Unit Serial Number */
212 cdb[3] = (INQUIRY_VPD_SERIAL_LEN >> 8) & 0xff;
213 cdb[4] = (INQUIRY_VPD_SERIAL_LEN & 0xff);
215 ret = scsi_execute_req(sdev, cdb, DMA_FROM_DEVICE, buf,
216 INQUIRY_VPD_SERIAL_LEN, NULL, HZ, 1, NULL);
220 snprintf(&wwn->unit_serial[0], INQUIRY_VPD_SERIAL_LEN, "%s", &buf[4]);
222 wwn->t10_dev->dev_flags |= DF_FIRMWARE_VPD_UNIT_SERIAL;
233 pscsi_get_inquiry_vpd_device_ident(struct scsi_device *sdev,
236 unsigned char cdb[MAX_COMMAND_SIZE], *buf, *page_83;
237 int ident_len, page_len, off = 4, ret;
240 buf = kzalloc(INQUIRY_VPD_SERIAL_LEN, GFP_KERNEL);
244 memset(cdb, 0, MAX_COMMAND_SIZE);
246 cdb[1] = 0x01; /* Query VPD */
247 cdb[2] = 0x83; /* Device Identifier */
248 cdb[3] = (INQUIRY_VPD_DEVICE_IDENTIFIER_LEN >> 8) & 0xff;
249 cdb[4] = (INQUIRY_VPD_DEVICE_IDENTIFIER_LEN & 0xff);
251 ret = scsi_execute_req(sdev, cdb, DMA_FROM_DEVICE, buf,
252 INQUIRY_VPD_DEVICE_IDENTIFIER_LEN,
257 page_len = (buf[2] << 8) | buf[3];
258 while (page_len > 0) {
259 /* Grab a pointer to the Identification descriptor */
261 ident_len = page_83[3];
263 pr_err("page_83[3]: identifier"
267 pr_debug("T10 VPD Identifier Length: %d\n", ident_len);
269 vpd = kzalloc(sizeof(struct t10_vpd), GFP_KERNEL);
271 pr_err("Unable to allocate memory for"
272 " struct t10_vpd\n");
275 INIT_LIST_HEAD(&vpd->vpd_list);
277 transport_set_vpd_proto_id(vpd, page_83);
278 transport_set_vpd_assoc(vpd, page_83);
280 if (transport_set_vpd_ident_type(vpd, page_83) < 0) {
281 off += (ident_len + 4);
282 page_len -= (ident_len + 4);
286 if (transport_set_vpd_ident(vpd, page_83) < 0) {
287 off += (ident_len + 4);
288 page_len -= (ident_len + 4);
293 list_add_tail(&vpd->vpd_list, &wwn->t10_vpd_list);
294 off += (ident_len + 4);
295 page_len -= (ident_len + 4);
302 static int pscsi_add_device_to_list(struct se_device *dev,
303 struct scsi_device *sd)
305 struct pscsi_dev_virt *pdv = PSCSI_DEV(dev);
306 struct request_queue *q = sd->request_queue;
310 if (!sd->queue_depth) {
311 sd->queue_depth = PSCSI_DEFAULT_QUEUEDEPTH;
313 pr_err("Set broken SCSI Device %d:%d:%llu"
314 " queue_depth to %d\n", sd->channel, sd->id,
315 sd->lun, sd->queue_depth);
318 dev->dev_attrib.hw_block_size =
319 min_not_zero((int)sd->sector_size, 512);
320 dev->dev_attrib.hw_max_sectors =
321 min_not_zero(sd->host->max_sectors, queue_max_hw_sectors(q));
322 dev->dev_attrib.hw_queue_depth = sd->queue_depth;
325 * Setup our standard INQUIRY info into se_dev->t10_wwn
327 pscsi_set_inquiry_info(sd, &dev->t10_wwn);
330 * Locate VPD WWN Information used for various purposes within
331 * the Storage Engine.
333 if (!pscsi_get_inquiry_vpd_serial(sd, &dev->t10_wwn)) {
335 * If VPD Unit Serial returned GOOD status, try
336 * VPD Device Identification page (0x83).
338 pscsi_get_inquiry_vpd_device_ident(sd, &dev->t10_wwn);
342 * For TYPE_TAPE, attempt to determine blocksize with MODE_SENSE.
344 if (sd->type == TYPE_TAPE) {
345 pscsi_tape_read_blocksize(dev, sd);
346 dev->dev_attrib.hw_block_size = sd->sector_size;
351 static struct se_device *pscsi_alloc_device(struct se_hba *hba,
354 struct pscsi_dev_virt *pdv;
356 pdv = kzalloc(sizeof(struct pscsi_dev_virt), GFP_KERNEL);
358 pr_err("Unable to allocate memory for struct pscsi_dev_virt\n");
362 pr_debug("PSCSI: Allocated pdv: %p for %s\n", pdv, name);
367 * Called with struct Scsi_Host->host_lock called.
369 static int pscsi_create_type_disk(struct se_device *dev, struct scsi_device *sd)
370 __releases(sh->host_lock)
372 struct pscsi_hba_virt *phv = dev->se_hba->hba_ptr;
373 struct pscsi_dev_virt *pdv = PSCSI_DEV(dev);
374 struct Scsi_Host *sh = sd->host;
375 struct block_device *bd;
378 if (scsi_device_get(sd)) {
379 pr_err("scsi_device_get() failed for %d:%d:%d:%llu\n",
380 sh->host_no, sd->channel, sd->id, sd->lun);
381 spin_unlock_irq(sh->host_lock);
384 spin_unlock_irq(sh->host_lock);
386 * Claim exclusive struct block_device access to struct scsi_device
387 * for TYPE_DISK using supplied udev_path
389 bd = blkdev_get_by_path(dev->udev_path,
390 FMODE_WRITE|FMODE_READ|FMODE_EXCL, pdv);
392 pr_err("pSCSI: blkdev_get_by_path() failed\n");
398 ret = pscsi_add_device_to_list(dev, sd);
400 blkdev_put(pdv->pdv_bd, FMODE_WRITE|FMODE_READ|FMODE_EXCL);
405 pr_debug("CORE_PSCSI[%d] - Added TYPE_DISK for %d:%d:%d:%llu\n",
406 phv->phv_host_id, sh->host_no, sd->channel, sd->id, sd->lun);
411 * Called with struct Scsi_Host->host_lock called.
413 static int pscsi_create_type_nondisk(struct se_device *dev, struct scsi_device *sd)
414 __releases(sh->host_lock)
416 struct pscsi_hba_virt *phv = dev->se_hba->hba_ptr;
417 struct Scsi_Host *sh = sd->host;
420 if (scsi_device_get(sd)) {
421 pr_err("scsi_device_get() failed for %d:%d:%d:%llu\n",
422 sh->host_no, sd->channel, sd->id, sd->lun);
423 spin_unlock_irq(sh->host_lock);
426 spin_unlock_irq(sh->host_lock);
428 ret = pscsi_add_device_to_list(dev, sd);
433 pr_debug("CORE_PSCSI[%d] - Added Type: %s for %d:%d:%d:%llu\n",
434 phv->phv_host_id, scsi_device_type(sd->type), sh->host_no,
435 sd->channel, sd->id, sd->lun);
440 static int pscsi_configure_device(struct se_device *dev)
442 struct se_hba *hba = dev->se_hba;
443 struct pscsi_dev_virt *pdv = PSCSI_DEV(dev);
444 struct scsi_device *sd;
445 struct pscsi_hba_virt *phv = dev->se_hba->hba_ptr;
446 struct Scsi_Host *sh = phv->phv_lld_host;
447 int legacy_mode_enable = 0;
450 if (!(pdv->pdv_flags & PDF_HAS_CHANNEL_ID) ||
451 !(pdv->pdv_flags & PDF_HAS_TARGET_ID) ||
452 !(pdv->pdv_flags & PDF_HAS_LUN_ID)) {
453 pr_err("Missing scsi_channel_id=, scsi_target_id= and"
454 " scsi_lun_id= parameters\n");
459 * If not running in PHV_LLD_SCSI_HOST_NO mode, locate the
460 * struct Scsi_Host we will need to bring the TCM/pSCSI object online
463 if (phv->phv_mode == PHV_LLD_SCSI_HOST_NO) {
464 pr_err("pSCSI: Unable to locate struct"
465 " Scsi_Host for PHV_LLD_SCSI_HOST_NO\n");
469 * For the newer PHV_VIRTUAL_HOST_ID struct scsi_device
470 * reference, we enforce that udev_path has been set
472 if (!(dev->dev_flags & DF_USING_UDEV_PATH)) {
473 pr_err("pSCSI: udev_path attribute has not"
474 " been set before ENABLE=1\n");
478 * If no scsi_host_id= was passed for PHV_VIRTUAL_HOST_ID,
479 * use the original TCM hba ID to reference Linux/SCSI Host No
480 * and enable for PHV_LLD_SCSI_HOST_NO mode.
482 if (!(pdv->pdv_flags & PDF_HAS_VIRT_HOST_ID)) {
483 if (hba->dev_count) {
484 pr_err("pSCSI: Unable to set hba_mode"
485 " with active devices\n");
489 if (pscsi_pmode_enable_hba(hba, 1) != 1)
492 legacy_mode_enable = 1;
493 hba->hba_flags |= HBA_FLAGS_PSCSI_MODE;
494 sh = phv->phv_lld_host;
496 sh = scsi_host_lookup(pdv->pdv_host_id);
498 pr_err("pSCSI: Unable to locate"
499 " pdv_host_id: %d\n", pdv->pdv_host_id);
502 pdv->pdv_lld_host = sh;
505 if (phv->phv_mode == PHV_VIRTUAL_HOST_ID) {
506 pr_err("pSCSI: PHV_VIRTUAL_HOST_ID set while"
507 " struct Scsi_Host exists\n");
512 spin_lock_irq(sh->host_lock);
513 list_for_each_entry(sd, &sh->__devices, siblings) {
514 if ((pdv->pdv_channel_id != sd->channel) ||
515 (pdv->pdv_target_id != sd->id) ||
516 (pdv->pdv_lun_id != sd->lun))
519 * Functions will release the held struct scsi_host->host_lock
520 * before calling calling pscsi_add_device_to_list() to register
521 * struct scsi_device with target_core_mod.
525 ret = pscsi_create_type_disk(dev, sd);
528 ret = pscsi_create_type_nondisk(dev, sd);
533 if (phv->phv_mode == PHV_VIRTUAL_HOST_ID)
535 else if (legacy_mode_enable) {
536 pscsi_pmode_enable_hba(hba, 0);
537 hba->hba_flags &= ~HBA_FLAGS_PSCSI_MODE;
544 spin_unlock_irq(sh->host_lock);
546 pr_err("pSCSI: Unable to locate %d:%d:%d:%d\n", sh->host_no,
547 pdv->pdv_channel_id, pdv->pdv_target_id, pdv->pdv_lun_id);
549 if (phv->phv_mode == PHV_VIRTUAL_HOST_ID)
551 else if (legacy_mode_enable) {
552 pscsi_pmode_enable_hba(hba, 0);
553 hba->hba_flags &= ~HBA_FLAGS_PSCSI_MODE;
559 static void pscsi_dev_call_rcu(struct rcu_head *p)
561 struct se_device *dev = container_of(p, struct se_device, rcu_head);
562 struct pscsi_dev_virt *pdv = PSCSI_DEV(dev);
567 static void pscsi_free_device(struct se_device *dev)
569 struct pscsi_dev_virt *pdv = PSCSI_DEV(dev);
570 struct pscsi_hba_virt *phv = dev->se_hba->hba_ptr;
571 struct scsi_device *sd = pdv->pdv_sd;
575 * Release exclusive pSCSI internal struct block_device claim for
576 * struct scsi_device with TYPE_DISK from pscsi_create_type_disk()
578 if ((sd->type == TYPE_DISK) && pdv->pdv_bd) {
579 blkdev_put(pdv->pdv_bd,
580 FMODE_WRITE|FMODE_READ|FMODE_EXCL);
584 * For HBA mode PHV_LLD_SCSI_HOST_NO, release the reference
585 * to struct Scsi_Host now.
587 if ((phv->phv_mode == PHV_LLD_SCSI_HOST_NO) &&
588 (phv->phv_lld_host != NULL))
589 scsi_host_put(phv->phv_lld_host);
590 else if (pdv->pdv_lld_host)
591 scsi_host_put(pdv->pdv_lld_host);
597 call_rcu(&dev->rcu_head, pscsi_dev_call_rcu);
600 static void pscsi_transport_complete(struct se_cmd *cmd, struct scatterlist *sg,
601 unsigned char *sense_buffer)
603 struct pscsi_dev_virt *pdv = PSCSI_DEV(cmd->se_dev);
604 struct scsi_device *sd = pdv->pdv_sd;
606 struct pscsi_plugin_task *pt = cmd->priv;
609 * Special case for REPORT_LUNs handling where pscsi_plugin_task has
610 * not been allocated because TCM is handling the emulation directly.
615 cdb = &pt->pscsi_cdb[0];
616 result = pt->pscsi_result;
618 * Hack to make sure that Write-Protect modepage is set if R/O mode is
621 if (!cmd->data_length)
622 goto after_mode_sense;
624 if (((cdb[0] == MODE_SENSE) || (cdb[0] == MODE_SENSE_10)) &&
625 (status_byte(result) << 1) == SAM_STAT_GOOD) {
626 bool read_only = target_lun_is_rdonly(cmd);
631 buf = transport_kmap_data_sg(cmd);
633 ; /* XXX: TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE */
636 if (cdb[0] == MODE_SENSE_10) {
637 if (!(buf[3] & 0x80))
640 if (!(buf[2] & 0x80))
644 transport_kunmap_data_sg(cmd);
649 if (sd->type != TYPE_TAPE || !cmd->data_length)
650 goto after_mode_select;
653 * Hack to correctly obtain the initiator requested blocksize for
654 * TYPE_TAPE. Since this value is dependent upon each tape media,
655 * struct scsi_device->sector_size will not contain the correct value
656 * by default, so we go ahead and set it so
657 * TRANSPORT(dev)->get_blockdev() returns the correct value to the
660 if (((cdb[0] == MODE_SELECT) || (cdb[0] == MODE_SELECT_10)) &&
661 (status_byte(result) << 1) == SAM_STAT_GOOD) {
666 buf = sg_virt(&sg[0]);
668 pr_err("Unable to get buf for scatterlist\n");
669 goto after_mode_select;
672 if (cdb[0] == MODE_SELECT)
675 bdl = (buf[6] << 8) | (buf[7]);
678 goto after_mode_select;
680 if (cdb[0] == MODE_SELECT)
681 blocksize = (buf[9] << 16) | (buf[10] << 8) |
684 blocksize = (buf[13] << 16) | (buf[14] << 8) |
687 sd->sector_size = blocksize;
691 if (sense_buffer && (status_byte(result) & CHECK_CONDITION)) {
692 memcpy(sense_buffer, pt->pscsi_sense, TRANSPORT_SENSE_BUFFER);
693 cmd->se_cmd_flags |= SCF_TRANSPORT_TASK_SENSE;
698 Opt_scsi_host_id, Opt_scsi_channel_id, Opt_scsi_target_id,
699 Opt_scsi_lun_id, Opt_err
702 static match_table_t tokens = {
703 {Opt_scsi_host_id, "scsi_host_id=%d"},
704 {Opt_scsi_channel_id, "scsi_channel_id=%d"},
705 {Opt_scsi_target_id, "scsi_target_id=%d"},
706 {Opt_scsi_lun_id, "scsi_lun_id=%d"},
710 static ssize_t pscsi_set_configfs_dev_params(struct se_device *dev,
711 const char *page, ssize_t count)
713 struct pscsi_dev_virt *pdv = PSCSI_DEV(dev);
714 struct pscsi_hba_virt *phv = dev->se_hba->hba_ptr;
715 char *orig, *ptr, *opts;
716 substring_t args[MAX_OPT_ARGS];
717 int ret = 0, arg, token;
719 opts = kstrdup(page, GFP_KERNEL);
725 while ((ptr = strsep(&opts, ",\n")) != NULL) {
729 token = match_token(ptr, tokens, args);
731 case Opt_scsi_host_id:
732 if (phv->phv_mode == PHV_LLD_SCSI_HOST_NO) {
733 pr_err("PSCSI[%d]: Unable to accept"
734 " scsi_host_id while phv_mode =="
735 " PHV_LLD_SCSI_HOST_NO\n",
740 ret = match_int(args, &arg);
743 pdv->pdv_host_id = arg;
744 pr_debug("PSCSI[%d]: Referencing SCSI Host ID:"
745 " %d\n", phv->phv_host_id, pdv->pdv_host_id);
746 pdv->pdv_flags |= PDF_HAS_VIRT_HOST_ID;
748 case Opt_scsi_channel_id:
749 ret = match_int(args, &arg);
752 pdv->pdv_channel_id = arg;
753 pr_debug("PSCSI[%d]: Referencing SCSI Channel"
754 " ID: %d\n", phv->phv_host_id,
755 pdv->pdv_channel_id);
756 pdv->pdv_flags |= PDF_HAS_CHANNEL_ID;
758 case Opt_scsi_target_id:
759 ret = match_int(args, &arg);
762 pdv->pdv_target_id = arg;
763 pr_debug("PSCSI[%d]: Referencing SCSI Target"
764 " ID: %d\n", phv->phv_host_id,
766 pdv->pdv_flags |= PDF_HAS_TARGET_ID;
768 case Opt_scsi_lun_id:
769 ret = match_int(args, &arg);
772 pdv->pdv_lun_id = arg;
773 pr_debug("PSCSI[%d]: Referencing SCSI LUN ID:"
774 " %d\n", phv->phv_host_id, pdv->pdv_lun_id);
775 pdv->pdv_flags |= PDF_HAS_LUN_ID;
784 return (!ret) ? count : ret;
787 static ssize_t pscsi_show_configfs_dev_params(struct se_device *dev, char *b)
789 struct pscsi_hba_virt *phv = dev->se_hba->hba_ptr;
790 struct pscsi_dev_virt *pdv = PSCSI_DEV(dev);
791 struct scsi_device *sd = pdv->pdv_sd;
792 unsigned char host_id[16];
796 if (phv->phv_mode == PHV_VIRTUAL_HOST_ID)
797 snprintf(host_id, 16, "%d", pdv->pdv_host_id);
799 snprintf(host_id, 16, "PHBA Mode");
801 bl = sprintf(b, "SCSI Device Bus Location:"
802 " Channel ID: %d Target ID: %d LUN: %d Host ID: %s\n",
803 pdv->pdv_channel_id, pdv->pdv_target_id, pdv->pdv_lun_id,
807 bl += sprintf(b + bl, " ");
808 bl += sprintf(b + bl, "Vendor: ");
809 for (i = 0; i < 8; i++) {
810 if (ISPRINT(sd->vendor[i])) /* printable character? */
811 bl += sprintf(b + bl, "%c", sd->vendor[i]);
813 bl += sprintf(b + bl, " ");
815 bl += sprintf(b + bl, " Model: ");
816 for (i = 0; i < 16; i++) {
817 if (ISPRINT(sd->model[i])) /* printable character ? */
818 bl += sprintf(b + bl, "%c", sd->model[i]);
820 bl += sprintf(b + bl, " ");
822 bl += sprintf(b + bl, " Rev: ");
823 for (i = 0; i < 4; i++) {
824 if (ISPRINT(sd->rev[i])) /* printable character ? */
825 bl += sprintf(b + bl, "%c", sd->rev[i]);
827 bl += sprintf(b + bl, " ");
829 bl += sprintf(b + bl, "\n");
834 static void pscsi_bi_endio(struct bio *bio)
839 static inline struct bio *pscsi_get_bio(int nr_vecs)
843 * Use bio_malloc() following the comment in for bio -> struct request
844 * in block/blk-core.c:blk_make_request()
846 bio = bio_kmalloc(GFP_KERNEL, nr_vecs);
848 pr_err("PSCSI: bio_kmalloc() failed\n");
851 bio->bi_end_io = pscsi_bi_endio;
856 static sense_reason_t
857 pscsi_map_sg(struct se_cmd *cmd, struct scatterlist *sgl, u32 sgl_nents,
860 struct pscsi_dev_virt *pdv = PSCSI_DEV(cmd->se_dev);
861 struct bio *bio = NULL;
863 struct scatterlist *sg;
864 u32 data_len = cmd->data_length, i, len, bytes, off;
865 int nr_pages = (cmd->data_length + sgl[0].offset +
866 PAGE_SIZE - 1) >> PAGE_SHIFT;
868 int rw = (cmd->data_direction == DMA_TO_DEVICE);
870 BUG_ON(!cmd->data_length);
872 pr_debug("PSCSI: nr_pages: %d\n", nr_pages);
874 for_each_sg(sgl, sg, sgl_nents, i) {
879 pr_debug("PSCSI: i: %d page: %p len: %d off: %d\n", i,
883 * We only have one page of data in each sg element,
884 * we can not cross a page boundary.
886 if (off + len > PAGE_SIZE)
889 if (len > 0 && data_len > 0) {
890 bytes = min_t(unsigned int, len, PAGE_SIZE - off);
891 bytes = min(bytes, data_len);
894 nr_vecs = min_t(int, BIO_MAX_PAGES, nr_pages);
897 * Calls bio_kmalloc() and sets bio->bi_end_io()
899 bio = pscsi_get_bio(nr_vecs);
904 bio_set_op_attrs(bio, REQ_OP_WRITE, 0);
906 pr_debug("PSCSI: Allocated bio: %p,"
907 " dir: %s nr_vecs: %d\n", bio,
908 (rw) ? "rw" : "r", nr_vecs);
911 pr_debug("PSCSI: Calling bio_add_pc_page() i: %d"
912 " bio: %p page: %p len: %d off: %d\n", i, bio,
915 rc = bio_add_pc_page(pdv->pdv_sd->request_queue,
916 bio, page, bytes, off);
920 pr_debug("PSCSI: bio->bi_vcnt: %d nr_vecs: %d\n",
921 bio->bi_vcnt, nr_vecs);
923 if (bio->bi_vcnt > nr_vecs) {
924 pr_debug("PSCSI: Reached bio->bi_vcnt max:"
925 " %d i: %d bio: %p, allocating another"
926 " bio\n", bio->bi_vcnt, i, bio);
928 rc = blk_rq_append_bio(req, bio);
930 pr_err("pSCSI: failed to append bio\n");
935 * Clear the pointer so that another bio will
936 * be allocated with pscsi_get_bio() above.
946 rc = blk_rq_append_bio(req, bio);
948 pr_err("pSCSI: failed to append bio\n");
959 req->bio = bio->bi_next;
963 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
966 static sense_reason_t
967 pscsi_parse_cdb(struct se_cmd *cmd)
969 if (cmd->se_cmd_flags & SCF_BIDI)
970 return TCM_UNSUPPORTED_SCSI_OPCODE;
972 return passthrough_parse_cdb(cmd, pscsi_execute_cmd);
975 static sense_reason_t
976 pscsi_execute_cmd(struct se_cmd *cmd)
978 struct scatterlist *sgl = cmd->t_data_sg;
979 u32 sgl_nents = cmd->t_data_nents;
980 struct pscsi_dev_virt *pdv = PSCSI_DEV(cmd->se_dev);
981 struct pscsi_plugin_task *pt;
986 * Dynamically alloc cdb space, since it may be larger than
987 * TCM_MAX_COMMAND_SIZE
989 pt = kzalloc(sizeof(*pt) + scsi_command_size(cmd->t_task_cdb), GFP_KERNEL);
991 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
995 memcpy(pt->pscsi_cdb, cmd->t_task_cdb,
996 scsi_command_size(cmd->t_task_cdb));
998 req = blk_get_request(pdv->pdv_sd->request_queue,
999 (cmd->data_direction == DMA_TO_DEVICE),
1002 pr_err("PSCSI: blk_get_request() failed\n");
1003 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1007 blk_rq_set_block_pc(req);
1010 ret = pscsi_map_sg(cmd, sgl, sgl_nents, req);
1012 goto fail_put_request;
1015 req->end_io = pscsi_req_done;
1016 req->end_io_data = cmd;
1017 req->cmd_len = scsi_command_size(pt->pscsi_cdb);
1018 req->cmd = &pt->pscsi_cdb[0];
1019 req->sense = &pt->pscsi_sense[0];
1021 if (pdv->pdv_sd->type == TYPE_DISK)
1022 req->timeout = PS_TIMEOUT_DISK;
1024 req->timeout = PS_TIMEOUT_OTHER;
1025 req->retries = PS_RETRY;
1027 blk_execute_rq_nowait(pdv->pdv_sd->request_queue, NULL, req,
1028 (cmd->sam_task_attr == TCM_HEAD_TAG),
1034 blk_put_request(req);
1040 /* pscsi_get_device_type():
1044 static u32 pscsi_get_device_type(struct se_device *dev)
1046 struct pscsi_dev_virt *pdv = PSCSI_DEV(dev);
1047 struct scsi_device *sd = pdv->pdv_sd;
1049 return (sd) ? sd->type : TYPE_NO_LUN;
1052 static sector_t pscsi_get_blocks(struct se_device *dev)
1054 struct pscsi_dev_virt *pdv = PSCSI_DEV(dev);
1056 if (pdv->pdv_bd && pdv->pdv_bd->bd_part)
1057 return pdv->pdv_bd->bd_part->nr_sects;
1062 static void pscsi_req_done(struct request *req, int uptodate)
1064 struct se_cmd *cmd = req->end_io_data;
1065 struct pscsi_plugin_task *pt = cmd->priv;
1067 pt->pscsi_result = req->errors;
1068 pt->pscsi_resid = req->resid_len;
1070 cmd->scsi_status = status_byte(pt->pscsi_result) << 1;
1071 if (cmd->scsi_status) {
1072 pr_debug("PSCSI Status Byte exception at cmd: %p CDB:"
1073 " 0x%02x Result: 0x%08x\n", cmd, pt->pscsi_cdb[0],
1077 switch (host_byte(pt->pscsi_result)) {
1079 target_complete_cmd(cmd, cmd->scsi_status);
1082 pr_debug("PSCSI Host Byte exception at cmd: %p CDB:"
1083 " 0x%02x Result: 0x%08x\n", cmd, pt->pscsi_cdb[0],
1085 target_complete_cmd(cmd, SAM_STAT_CHECK_CONDITION);
1089 __blk_put_request(req->q, req);
1093 static const struct target_backend_ops pscsi_ops = {
1095 .owner = THIS_MODULE,
1096 .transport_flags = TRANSPORT_FLAG_PASSTHROUGH,
1097 .attach_hba = pscsi_attach_hba,
1098 .detach_hba = pscsi_detach_hba,
1099 .pmode_enable_hba = pscsi_pmode_enable_hba,
1100 .alloc_device = pscsi_alloc_device,
1101 .configure_device = pscsi_configure_device,
1102 .free_device = pscsi_free_device,
1103 .transport_complete = pscsi_transport_complete,
1104 .parse_cdb = pscsi_parse_cdb,
1105 .set_configfs_dev_params = pscsi_set_configfs_dev_params,
1106 .show_configfs_dev_params = pscsi_show_configfs_dev_params,
1107 .get_device_type = pscsi_get_device_type,
1108 .get_blocks = pscsi_get_blocks,
1109 .tb_dev_attrib_attrs = passthrough_attrib_attrs,
1112 static int __init pscsi_module_init(void)
1114 return transport_backend_register(&pscsi_ops);
1117 static void __exit pscsi_module_exit(void)
1119 target_backend_unregister(&pscsi_ops);
1122 MODULE_DESCRIPTION("TCM PSCSI subsystem plugin");
1123 MODULE_AUTHOR("nab@Linux-iSCSI.org");
1124 MODULE_LICENSE("GPL");
1126 module_init(pscsi_module_init);
1127 module_exit(pscsi_module_exit);