Back to home page

OSCL-LXR
 
 

     

0001 // SPDX-License-Identifier: GPL-2.0-or-later
0002 /*******************************************************************************
0003  * Filename:  target_core_pscsi.c
0004  *
0005  * This file contains the generic target mode <-> Linux SCSI subsystem plugin.
0006  *
0007  * (c) Copyright 2003-2013 Datera, Inc.
0008  *
0009  * Nicholas A. Bellinger <nab@kernel.org>
0010  *
0011  ******************************************************************************/
0012 
0013 #include <linux/string.h>
0014 #include <linux/parser.h>
0015 #include <linux/timer.h>
0016 #include <linux/blkdev.h>
0017 #include <linux/blk_types.h>
0018 #include <linux/slab.h>
0019 #include <linux/spinlock.h>
0020 #include <linux/cdrom.h>
0021 #include <linux/ratelimit.h>
0022 #include <linux/module.h>
0023 #include <asm/unaligned.h>
0024 
0025 #include <scsi/scsi_device.h>
0026 #include <scsi/scsi_host.h>
0027 #include <scsi/scsi_tcq.h>
0028 
0029 #include <target/target_core_base.h>
0030 #include <target/target_core_backend.h>
0031 
0032 #include "target_core_alua.h"
0033 #include "target_core_internal.h"
0034 #include "target_core_pscsi.h"
0035 
0036 static inline struct pscsi_dev_virt *PSCSI_DEV(struct se_device *dev)
0037 {
0038     return container_of(dev, struct pscsi_dev_virt, dev);
0039 }
0040 
0041 static sense_reason_t pscsi_execute_cmd(struct se_cmd *cmd);
0042 static void pscsi_req_done(struct request *, blk_status_t);
0043 
0044 /*  pscsi_attach_hba():
0045  *
0046  *  pscsi_get_sh() used scsi_host_lookup() to locate struct Scsi_Host.
0047  *  from the passed SCSI Host ID.
0048  */
0049 static int pscsi_attach_hba(struct se_hba *hba, u32 host_id)
0050 {
0051     struct pscsi_hba_virt *phv;
0052 
0053     phv = kzalloc(sizeof(struct pscsi_hba_virt), GFP_KERNEL);
0054     if (!phv) {
0055         pr_err("Unable to allocate struct pscsi_hba_virt\n");
0056         return -ENOMEM;
0057     }
0058     phv->phv_host_id = host_id;
0059     phv->phv_mode = PHV_VIRTUAL_HOST_ID;
0060 
0061     hba->hba_ptr = phv;
0062 
0063     pr_debug("CORE_HBA[%d] - TCM SCSI HBA Driver %s on"
0064         " Generic Target Core Stack %s\n", hba->hba_id,
0065         PSCSI_VERSION, TARGET_CORE_VERSION);
0066     pr_debug("CORE_HBA[%d] - Attached SCSI HBA to Generic\n",
0067            hba->hba_id);
0068 
0069     return 0;
0070 }
0071 
0072 static void pscsi_detach_hba(struct se_hba *hba)
0073 {
0074     struct pscsi_hba_virt *phv = hba->hba_ptr;
0075     struct Scsi_Host *scsi_host = phv->phv_lld_host;
0076 
0077     if (scsi_host) {
0078         scsi_host_put(scsi_host);
0079 
0080         pr_debug("CORE_HBA[%d] - Detached SCSI HBA: %s from"
0081             " Generic Target Core\n", hba->hba_id,
0082             (scsi_host->hostt->name) ? (scsi_host->hostt->name) :
0083             "Unknown");
0084     } else
0085         pr_debug("CORE_HBA[%d] - Detached Virtual SCSI HBA"
0086             " from Generic Target Core\n", hba->hba_id);
0087 
0088     kfree(phv);
0089     hba->hba_ptr = NULL;
0090 }
0091 
0092 static int pscsi_pmode_enable_hba(struct se_hba *hba, unsigned long mode_flag)
0093 {
0094     struct pscsi_hba_virt *phv = hba->hba_ptr;
0095     struct Scsi_Host *sh = phv->phv_lld_host;
0096     /*
0097      * Release the struct Scsi_Host
0098      */
0099     if (!mode_flag) {
0100         if (!sh)
0101             return 0;
0102 
0103         phv->phv_lld_host = NULL;
0104         phv->phv_mode = PHV_VIRTUAL_HOST_ID;
0105 
0106         pr_debug("CORE_HBA[%d] - Disabled pSCSI HBA Passthrough"
0107             " %s\n", hba->hba_id, (sh->hostt->name) ?
0108             (sh->hostt->name) : "Unknown");
0109 
0110         scsi_host_put(sh);
0111         return 0;
0112     }
0113     /*
0114      * Otherwise, locate struct Scsi_Host from the original passed
0115      * pSCSI Host ID and enable for phba mode
0116      */
0117     sh = scsi_host_lookup(phv->phv_host_id);
0118     if (!sh) {
0119         pr_err("pSCSI: Unable to locate SCSI Host for"
0120             " phv_host_id: %d\n", phv->phv_host_id);
0121         return -EINVAL;
0122     }
0123 
0124     phv->phv_lld_host = sh;
0125     phv->phv_mode = PHV_LLD_SCSI_HOST_NO;
0126 
0127     pr_debug("CORE_HBA[%d] - Enabled pSCSI HBA Passthrough %s\n",
0128         hba->hba_id, (sh->hostt->name) ? (sh->hostt->name) : "Unknown");
0129 
0130     return 1;
0131 }
0132 
0133 static void pscsi_tape_read_blocksize(struct se_device *dev,
0134         struct scsi_device *sdev)
0135 {
0136     unsigned char cdb[MAX_COMMAND_SIZE], *buf;
0137     int ret;
0138 
0139     buf = kzalloc(12, GFP_KERNEL);
0140     if (!buf)
0141         goto out_free;
0142 
0143     memset(cdb, 0, MAX_COMMAND_SIZE);
0144     cdb[0] = MODE_SENSE;
0145     cdb[4] = 0x0c; /* 12 bytes */
0146 
0147     ret = scsi_execute_req(sdev, cdb, DMA_FROM_DEVICE, buf, 12, NULL,
0148             HZ, 1, NULL);
0149     if (ret)
0150         goto out_free;
0151 
0152     /*
0153      * If MODE_SENSE still returns zero, set the default value to 1024.
0154      */
0155     sdev->sector_size = get_unaligned_be24(&buf[9]);
0156 out_free:
0157     if (!sdev->sector_size)
0158         sdev->sector_size = 1024;
0159 
0160     kfree(buf);
0161 }
0162 
0163 static void
0164 pscsi_set_inquiry_info(struct scsi_device *sdev, struct t10_wwn *wwn)
0165 {
0166     if (sdev->inquiry_len < INQUIRY_LEN)
0167         return;
0168     /*
0169      * Use sdev->inquiry data from drivers/scsi/scsi_scan.c:scsi_add_lun()
0170      */
0171     BUILD_BUG_ON(sizeof(wwn->vendor) != INQUIRY_VENDOR_LEN + 1);
0172     snprintf(wwn->vendor, sizeof(wwn->vendor),
0173          "%." __stringify(INQUIRY_VENDOR_LEN) "s", sdev->vendor);
0174     BUILD_BUG_ON(sizeof(wwn->model) != INQUIRY_MODEL_LEN + 1);
0175     snprintf(wwn->model, sizeof(wwn->model),
0176          "%." __stringify(INQUIRY_MODEL_LEN) "s", sdev->model);
0177     BUILD_BUG_ON(sizeof(wwn->revision) != INQUIRY_REVISION_LEN + 1);
0178     snprintf(wwn->revision, sizeof(wwn->revision),
0179          "%." __stringify(INQUIRY_REVISION_LEN) "s", sdev->rev);
0180 }
0181 
0182 static int
0183 pscsi_get_inquiry_vpd_serial(struct scsi_device *sdev, struct t10_wwn *wwn)
0184 {
0185     unsigned char cdb[MAX_COMMAND_SIZE], *buf;
0186     int ret;
0187 
0188     buf = kzalloc(INQUIRY_VPD_SERIAL_LEN, GFP_KERNEL);
0189     if (!buf)
0190         return -ENOMEM;
0191 
0192     memset(cdb, 0, MAX_COMMAND_SIZE);
0193     cdb[0] = INQUIRY;
0194     cdb[1] = 0x01; /* Query VPD */
0195     cdb[2] = 0x80; /* Unit Serial Number */
0196     put_unaligned_be16(INQUIRY_VPD_SERIAL_LEN, &cdb[3]);
0197 
0198     ret = scsi_execute_req(sdev, cdb, DMA_FROM_DEVICE, buf,
0199                   INQUIRY_VPD_SERIAL_LEN, NULL, HZ, 1, NULL);
0200     if (ret)
0201         goto out_free;
0202 
0203     snprintf(&wwn->unit_serial[0], INQUIRY_VPD_SERIAL_LEN, "%s", &buf[4]);
0204 
0205     wwn->t10_dev->dev_flags |= DF_FIRMWARE_VPD_UNIT_SERIAL;
0206 
0207     kfree(buf);
0208     return 0;
0209 
0210 out_free:
0211     kfree(buf);
0212     return -EPERM;
0213 }
0214 
0215 static void
0216 pscsi_get_inquiry_vpd_device_ident(struct scsi_device *sdev,
0217         struct t10_wwn *wwn)
0218 {
0219     unsigned char cdb[MAX_COMMAND_SIZE], *buf, *page_83;
0220     int ident_len, page_len, off = 4, ret;
0221     struct t10_vpd *vpd;
0222 
0223     buf = kzalloc(INQUIRY_VPD_SERIAL_LEN, GFP_KERNEL);
0224     if (!buf)
0225         return;
0226 
0227     memset(cdb, 0, MAX_COMMAND_SIZE);
0228     cdb[0] = INQUIRY;
0229     cdb[1] = 0x01; /* Query VPD */
0230     cdb[2] = 0x83; /* Device Identifier */
0231     put_unaligned_be16(INQUIRY_VPD_DEVICE_IDENTIFIER_LEN, &cdb[3]);
0232 
0233     ret = scsi_execute_req(sdev, cdb, DMA_FROM_DEVICE, buf,
0234                   INQUIRY_VPD_DEVICE_IDENTIFIER_LEN,
0235                   NULL, HZ, 1, NULL);
0236     if (ret)
0237         goto out;
0238 
0239     page_len = get_unaligned_be16(&buf[2]);
0240     while (page_len > 0) {
0241         /* Grab a pointer to the Identification descriptor */
0242         page_83 = &buf[off];
0243         ident_len = page_83[3];
0244         if (!ident_len) {
0245             pr_err("page_83[3]: identifier"
0246                     " length zero!\n");
0247             break;
0248         }
0249         pr_debug("T10 VPD Identifier Length: %d\n", ident_len);
0250 
0251         vpd = kzalloc(sizeof(struct t10_vpd), GFP_KERNEL);
0252         if (!vpd) {
0253             pr_err("Unable to allocate memory for"
0254                     " struct t10_vpd\n");
0255             goto out;
0256         }
0257         INIT_LIST_HEAD(&vpd->vpd_list);
0258 
0259         transport_set_vpd_proto_id(vpd, page_83);
0260         transport_set_vpd_assoc(vpd, page_83);
0261 
0262         if (transport_set_vpd_ident_type(vpd, page_83) < 0) {
0263             off += (ident_len + 4);
0264             page_len -= (ident_len + 4);
0265             kfree(vpd);
0266             continue;
0267         }
0268         if (transport_set_vpd_ident(vpd, page_83) < 0) {
0269             off += (ident_len + 4);
0270             page_len -= (ident_len + 4);
0271             kfree(vpd);
0272             continue;
0273         }
0274 
0275         list_add_tail(&vpd->vpd_list, &wwn->t10_vpd_list);
0276         off += (ident_len + 4);
0277         page_len -= (ident_len + 4);
0278     }
0279 
0280 out:
0281     kfree(buf);
0282 }
0283 
0284 static int pscsi_add_device_to_list(struct se_device *dev,
0285         struct scsi_device *sd)
0286 {
0287     struct pscsi_dev_virt *pdv = PSCSI_DEV(dev);
0288     struct request_queue *q = sd->request_queue;
0289 
0290     pdv->pdv_sd = sd;
0291 
0292     if (!sd->queue_depth) {
0293         sd->queue_depth = PSCSI_DEFAULT_QUEUEDEPTH;
0294 
0295         pr_err("Set broken SCSI Device %d:%d:%llu"
0296             " queue_depth to %d\n", sd->channel, sd->id,
0297                 sd->lun, sd->queue_depth);
0298     }
0299 
0300     dev->dev_attrib.hw_block_size =
0301         min_not_zero((int)sd->sector_size, 512);
0302     dev->dev_attrib.hw_max_sectors =
0303         min_not_zero(sd->host->max_sectors, queue_max_hw_sectors(q));
0304     dev->dev_attrib.hw_queue_depth = sd->queue_depth;
0305 
0306     /*
0307      * Setup our standard INQUIRY info into se_dev->t10_wwn
0308      */
0309     pscsi_set_inquiry_info(sd, &dev->t10_wwn);
0310 
0311     /*
0312      * Locate VPD WWN Information used for various purposes within
0313      * the Storage Engine.
0314      */
0315     if (!pscsi_get_inquiry_vpd_serial(sd, &dev->t10_wwn)) {
0316         /*
0317          * If VPD Unit Serial returned GOOD status, try
0318          * VPD Device Identification page (0x83).
0319          */
0320         pscsi_get_inquiry_vpd_device_ident(sd, &dev->t10_wwn);
0321     }
0322 
0323     /*
0324      * For TYPE_TAPE, attempt to determine blocksize with MODE_SENSE.
0325      */
0326     if (sd->type == TYPE_TAPE) {
0327         pscsi_tape_read_blocksize(dev, sd);
0328         dev->dev_attrib.hw_block_size = sd->sector_size;
0329     }
0330     return 0;
0331 }
0332 
0333 static struct se_device *pscsi_alloc_device(struct se_hba *hba,
0334         const char *name)
0335 {
0336     struct pscsi_dev_virt *pdv;
0337 
0338     pdv = kzalloc(sizeof(struct pscsi_dev_virt), GFP_KERNEL);
0339     if (!pdv) {
0340         pr_err("Unable to allocate memory for struct pscsi_dev_virt\n");
0341         return NULL;
0342     }
0343 
0344     pr_debug("PSCSI: Allocated pdv: %p for %s\n", pdv, name);
0345     return &pdv->dev;
0346 }
0347 
0348 /*
0349  * Called with struct Scsi_Host->host_lock called.
0350  */
0351 static int pscsi_create_type_disk(struct se_device *dev, struct scsi_device *sd)
0352     __releases(sh->host_lock)
0353 {
0354     struct pscsi_hba_virt *phv = dev->se_hba->hba_ptr;
0355     struct pscsi_dev_virt *pdv = PSCSI_DEV(dev);
0356     struct Scsi_Host *sh = sd->host;
0357     struct block_device *bd;
0358     int ret;
0359 
0360     if (scsi_device_get(sd)) {
0361         pr_err("scsi_device_get() failed for %d:%d:%d:%llu\n",
0362             sh->host_no, sd->channel, sd->id, sd->lun);
0363         spin_unlock_irq(sh->host_lock);
0364         return -EIO;
0365     }
0366     spin_unlock_irq(sh->host_lock);
0367     /*
0368      * Claim exclusive struct block_device access to struct scsi_device
0369      * for TYPE_DISK and TYPE_ZBC using supplied udev_path
0370      */
0371     bd = blkdev_get_by_path(dev->udev_path,
0372                 FMODE_WRITE|FMODE_READ|FMODE_EXCL, pdv);
0373     if (IS_ERR(bd)) {
0374         pr_err("pSCSI: blkdev_get_by_path() failed\n");
0375         scsi_device_put(sd);
0376         return PTR_ERR(bd);
0377     }
0378     pdv->pdv_bd = bd;
0379 
0380     ret = pscsi_add_device_to_list(dev, sd);
0381     if (ret) {
0382         blkdev_put(pdv->pdv_bd, FMODE_WRITE|FMODE_READ|FMODE_EXCL);
0383         scsi_device_put(sd);
0384         return ret;
0385     }
0386 
0387     pr_debug("CORE_PSCSI[%d] - Added TYPE_%s for %d:%d:%d:%llu\n",
0388         phv->phv_host_id, sd->type == TYPE_DISK ? "DISK" : "ZBC",
0389         sh->host_no, sd->channel, sd->id, sd->lun);
0390     return 0;
0391 }
0392 
0393 /*
0394  * Called with struct Scsi_Host->host_lock called.
0395  */
0396 static int pscsi_create_type_nondisk(struct se_device *dev, struct scsi_device *sd)
0397     __releases(sh->host_lock)
0398 {
0399     struct pscsi_hba_virt *phv = dev->se_hba->hba_ptr;
0400     struct Scsi_Host *sh = sd->host;
0401     int ret;
0402 
0403     if (scsi_device_get(sd)) {
0404         pr_err("scsi_device_get() failed for %d:%d:%d:%llu\n",
0405             sh->host_no, sd->channel, sd->id, sd->lun);
0406         spin_unlock_irq(sh->host_lock);
0407         return -EIO;
0408     }
0409     spin_unlock_irq(sh->host_lock);
0410 
0411     ret = pscsi_add_device_to_list(dev, sd);
0412     if (ret) {
0413         scsi_device_put(sd);
0414         return ret;
0415     }
0416     pr_debug("CORE_PSCSI[%d] - Added Type: %s for %d:%d:%d:%llu\n",
0417         phv->phv_host_id, scsi_device_type(sd->type), sh->host_no,
0418         sd->channel, sd->id, sd->lun);
0419 
0420     return 0;
0421 }
0422 
0423 static int pscsi_configure_device(struct se_device *dev)
0424 {
0425     struct se_hba *hba = dev->se_hba;
0426     struct pscsi_dev_virt *pdv = PSCSI_DEV(dev);
0427     struct scsi_device *sd;
0428     struct pscsi_hba_virt *phv = dev->se_hba->hba_ptr;
0429     struct Scsi_Host *sh = phv->phv_lld_host;
0430     int legacy_mode_enable = 0;
0431     int ret;
0432 
0433     if (!(pdv->pdv_flags & PDF_HAS_CHANNEL_ID) ||
0434         !(pdv->pdv_flags & PDF_HAS_TARGET_ID) ||
0435         !(pdv->pdv_flags & PDF_HAS_LUN_ID)) {
0436         pr_err("Missing scsi_channel_id=, scsi_target_id= and"
0437             " scsi_lun_id= parameters\n");
0438         return -EINVAL;
0439     }
0440 
0441     /*
0442      * If not running in PHV_LLD_SCSI_HOST_NO mode, locate the
0443      * struct Scsi_Host we will need to bring the TCM/pSCSI object online
0444      */
0445     if (!sh) {
0446         if (phv->phv_mode == PHV_LLD_SCSI_HOST_NO) {
0447             pr_err("pSCSI: Unable to locate struct"
0448                 " Scsi_Host for PHV_LLD_SCSI_HOST_NO\n");
0449             return -ENODEV;
0450         }
0451         /*
0452          * For the newer PHV_VIRTUAL_HOST_ID struct scsi_device
0453          * reference, we enforce that udev_path has been set
0454          */
0455         if (!(dev->dev_flags & DF_USING_UDEV_PATH)) {
0456             pr_err("pSCSI: udev_path attribute has not"
0457                 " been set before ENABLE=1\n");
0458             return -EINVAL;
0459         }
0460         /*
0461          * If no scsi_host_id= was passed for PHV_VIRTUAL_HOST_ID,
0462          * use the original TCM hba ID to reference Linux/SCSI Host No
0463          * and enable for PHV_LLD_SCSI_HOST_NO mode.
0464          */
0465         if (!(pdv->pdv_flags & PDF_HAS_VIRT_HOST_ID)) {
0466             if (hba->dev_count) {
0467                 pr_err("pSCSI: Unable to set hba_mode"
0468                     " with active devices\n");
0469                 return -EEXIST;
0470             }
0471 
0472             if (pscsi_pmode_enable_hba(hba, 1) != 1)
0473                 return -ENODEV;
0474 
0475             legacy_mode_enable = 1;
0476             hba->hba_flags |= HBA_FLAGS_PSCSI_MODE;
0477             sh = phv->phv_lld_host;
0478         } else {
0479             sh = scsi_host_lookup(pdv->pdv_host_id);
0480             if (!sh) {
0481                 pr_err("pSCSI: Unable to locate"
0482                     " pdv_host_id: %d\n", pdv->pdv_host_id);
0483                 return -EINVAL;
0484             }
0485             pdv->pdv_lld_host = sh;
0486         }
0487     } else {
0488         if (phv->phv_mode == PHV_VIRTUAL_HOST_ID) {
0489             pr_err("pSCSI: PHV_VIRTUAL_HOST_ID set while"
0490                 " struct Scsi_Host exists\n");
0491             return -EEXIST;
0492         }
0493     }
0494 
0495     spin_lock_irq(sh->host_lock);
0496     list_for_each_entry(sd, &sh->__devices, siblings) {
0497         if ((pdv->pdv_channel_id != sd->channel) ||
0498             (pdv->pdv_target_id != sd->id) ||
0499             (pdv->pdv_lun_id != sd->lun))
0500             continue;
0501         /*
0502          * Functions will release the held struct scsi_host->host_lock
0503          * before calling calling pscsi_add_device_to_list() to register
0504          * struct scsi_device with target_core_mod.
0505          */
0506         switch (sd->type) {
0507         case TYPE_DISK:
0508         case TYPE_ZBC:
0509             ret = pscsi_create_type_disk(dev, sd);
0510             break;
0511         default:
0512             ret = pscsi_create_type_nondisk(dev, sd);
0513             break;
0514         }
0515 
0516         if (ret) {
0517             if (phv->phv_mode == PHV_VIRTUAL_HOST_ID)
0518                 scsi_host_put(sh);
0519             else if (legacy_mode_enable) {
0520                 pscsi_pmode_enable_hba(hba, 0);
0521                 hba->hba_flags &= ~HBA_FLAGS_PSCSI_MODE;
0522             }
0523             pdv->pdv_sd = NULL;
0524             return ret;
0525         }
0526         return 0;
0527     }
0528     spin_unlock_irq(sh->host_lock);
0529 
0530     pr_err("pSCSI: Unable to locate %d:%d:%d:%d\n", sh->host_no,
0531         pdv->pdv_channel_id,  pdv->pdv_target_id, pdv->pdv_lun_id);
0532 
0533     if (phv->phv_mode == PHV_VIRTUAL_HOST_ID)
0534         scsi_host_put(sh);
0535     else if (legacy_mode_enable) {
0536         pscsi_pmode_enable_hba(hba, 0);
0537         hba->hba_flags &= ~HBA_FLAGS_PSCSI_MODE;
0538     }
0539 
0540     return -ENODEV;
0541 }
0542 
0543 static void pscsi_dev_call_rcu(struct rcu_head *p)
0544 {
0545     struct se_device *dev = container_of(p, struct se_device, rcu_head);
0546     struct pscsi_dev_virt *pdv = PSCSI_DEV(dev);
0547 
0548     kfree(pdv);
0549 }
0550 
0551 static void pscsi_free_device(struct se_device *dev)
0552 {
0553     call_rcu(&dev->rcu_head, pscsi_dev_call_rcu);
0554 }
0555 
0556 static void pscsi_destroy_device(struct se_device *dev)
0557 {
0558     struct pscsi_dev_virt *pdv = PSCSI_DEV(dev);
0559     struct pscsi_hba_virt *phv = dev->se_hba->hba_ptr;
0560     struct scsi_device *sd = pdv->pdv_sd;
0561 
0562     if (sd) {
0563         /*
0564          * Release exclusive pSCSI internal struct block_device claim for
0565          * struct scsi_device with TYPE_DISK or TYPE_ZBC
0566          * from pscsi_create_type_disk()
0567          */
0568         if ((sd->type == TYPE_DISK || sd->type == TYPE_ZBC) &&
0569             pdv->pdv_bd) {
0570             blkdev_put(pdv->pdv_bd,
0571                    FMODE_WRITE|FMODE_READ|FMODE_EXCL);
0572             pdv->pdv_bd = NULL;
0573         }
0574         /*
0575          * For HBA mode PHV_LLD_SCSI_HOST_NO, release the reference
0576          * to struct Scsi_Host now.
0577          */
0578         if ((phv->phv_mode == PHV_LLD_SCSI_HOST_NO) &&
0579             (phv->phv_lld_host != NULL))
0580             scsi_host_put(phv->phv_lld_host);
0581         else if (pdv->pdv_lld_host)
0582             scsi_host_put(pdv->pdv_lld_host);
0583 
0584         scsi_device_put(sd);
0585 
0586         pdv->pdv_sd = NULL;
0587     }
0588 }
0589 
0590 static void pscsi_complete_cmd(struct se_cmd *cmd, u8 scsi_status,
0591                    unsigned char *req_sense, int valid_data)
0592 {
0593     struct pscsi_dev_virt *pdv = PSCSI_DEV(cmd->se_dev);
0594     struct scsi_device *sd = pdv->pdv_sd;
0595     unsigned char *cdb = cmd->priv;
0596 
0597     /*
0598      * Special case for REPORT_LUNs which is emulated and not passed on.
0599      */
0600     if (!cdb)
0601         return;
0602 
0603     /*
0604      * Hack to make sure that Write-Protect modepage is set if R/O mode is
0605      * forced.
0606      */
0607     if (!cmd->data_length)
0608         goto after_mode_sense;
0609 
0610     if (((cdb[0] == MODE_SENSE) || (cdb[0] == MODE_SENSE_10)) &&
0611         scsi_status == SAM_STAT_GOOD) {
0612         bool read_only = target_lun_is_rdonly(cmd);
0613 
0614         if (read_only) {
0615             unsigned char *buf;
0616 
0617             buf = transport_kmap_data_sg(cmd);
0618             if (!buf) {
0619                 ; /* XXX: TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE */
0620             } else {
0621                 if (cdb[0] == MODE_SENSE_10) {
0622                     if (!(buf[3] & 0x80))
0623                         buf[3] |= 0x80;
0624                 } else {
0625                     if (!(buf[2] & 0x80))
0626                         buf[2] |= 0x80;
0627                 }
0628 
0629                 transport_kunmap_data_sg(cmd);
0630             }
0631         }
0632     }
0633 after_mode_sense:
0634 
0635     if (sd->type != TYPE_TAPE || !cmd->data_length)
0636         goto after_mode_select;
0637 
0638     /*
0639      * Hack to correctly obtain the initiator requested blocksize for
0640      * TYPE_TAPE.  Since this value is dependent upon each tape media,
0641      * struct scsi_device->sector_size will not contain the correct value
0642      * by default, so we go ahead and set it so
0643      * TRANSPORT(dev)->get_blockdev() returns the correct value to the
0644      * storage engine.
0645      */
0646     if (((cdb[0] == MODE_SELECT) || (cdb[0] == MODE_SELECT_10)) &&
0647          scsi_status == SAM_STAT_GOOD) {
0648         unsigned char *buf;
0649         u16 bdl;
0650         u32 blocksize;
0651 
0652         buf = sg_virt(&cmd->t_data_sg[0]);
0653         if (!buf) {
0654             pr_err("Unable to get buf for scatterlist\n");
0655             goto after_mode_select;
0656         }
0657 
0658         if (cdb[0] == MODE_SELECT)
0659             bdl = buf[3];
0660         else
0661             bdl = get_unaligned_be16(&buf[6]);
0662 
0663         if (!bdl)
0664             goto after_mode_select;
0665 
0666         if (cdb[0] == MODE_SELECT)
0667             blocksize = get_unaligned_be24(&buf[9]);
0668         else
0669             blocksize = get_unaligned_be24(&buf[13]);
0670 
0671         sd->sector_size = blocksize;
0672     }
0673 after_mode_select:
0674 
0675     if (scsi_status == SAM_STAT_CHECK_CONDITION) {
0676         transport_copy_sense_to_cmd(cmd, req_sense);
0677 
0678         /*
0679          * check for TAPE device reads with
0680          * FM/EOM/ILI set, so that we can get data
0681          * back despite framework assumption that a
0682          * check condition means there is no data
0683          */
0684         if (sd->type == TYPE_TAPE && valid_data &&
0685             cmd->data_direction == DMA_FROM_DEVICE) {
0686             /*
0687              * is sense data valid, fixed format,
0688              * and have FM, EOM, or ILI set?
0689              */
0690             if (req_sense[0] == 0xf0 && /* valid, fixed format */
0691                 req_sense[2] & 0xe0 &&  /* FM, EOM, or ILI */
0692                 (req_sense[2] & 0xf) == 0) { /* key==NO_SENSE */
0693                 pr_debug("Tape FM/EOM/ILI status detected. Treat as normal read.\n");
0694                 cmd->se_cmd_flags |= SCF_TREAT_READ_AS_NORMAL;
0695             }
0696         }
0697     }
0698 }
0699 
0700 enum {
0701     Opt_scsi_host_id, Opt_scsi_channel_id, Opt_scsi_target_id,
0702     Opt_scsi_lun_id, Opt_err
0703 };
0704 
0705 static match_table_t tokens = {
0706     {Opt_scsi_host_id, "scsi_host_id=%d"},
0707     {Opt_scsi_channel_id, "scsi_channel_id=%d"},
0708     {Opt_scsi_target_id, "scsi_target_id=%d"},
0709     {Opt_scsi_lun_id, "scsi_lun_id=%d"},
0710     {Opt_err, NULL}
0711 };
0712 
0713 static ssize_t pscsi_set_configfs_dev_params(struct se_device *dev,
0714         const char *page, ssize_t count)
0715 {
0716     struct pscsi_dev_virt *pdv = PSCSI_DEV(dev);
0717     struct pscsi_hba_virt *phv = dev->se_hba->hba_ptr;
0718     char *orig, *ptr, *opts;
0719     substring_t args[MAX_OPT_ARGS];
0720     int ret = 0, arg, token;
0721 
0722     opts = kstrdup(page, GFP_KERNEL);
0723     if (!opts)
0724         return -ENOMEM;
0725 
0726     orig = opts;
0727 
0728     while ((ptr = strsep(&opts, ",\n")) != NULL) {
0729         if (!*ptr)
0730             continue;
0731 
0732         token = match_token(ptr, tokens, args);
0733         switch (token) {
0734         case Opt_scsi_host_id:
0735             if (phv->phv_mode == PHV_LLD_SCSI_HOST_NO) {
0736                 pr_err("PSCSI[%d]: Unable to accept"
0737                     " scsi_host_id while phv_mode =="
0738                     " PHV_LLD_SCSI_HOST_NO\n",
0739                     phv->phv_host_id);
0740                 ret = -EINVAL;
0741                 goto out;
0742             }
0743             ret = match_int(args, &arg);
0744             if (ret)
0745                 goto out;
0746             pdv->pdv_host_id = arg;
0747             pr_debug("PSCSI[%d]: Referencing SCSI Host ID:"
0748                 " %d\n", phv->phv_host_id, pdv->pdv_host_id);
0749             pdv->pdv_flags |= PDF_HAS_VIRT_HOST_ID;
0750             break;
0751         case Opt_scsi_channel_id:
0752             ret = match_int(args, &arg);
0753             if (ret)
0754                 goto out;
0755             pdv->pdv_channel_id = arg;
0756             pr_debug("PSCSI[%d]: Referencing SCSI Channel"
0757                 " ID: %d\n",  phv->phv_host_id,
0758                 pdv->pdv_channel_id);
0759             pdv->pdv_flags |= PDF_HAS_CHANNEL_ID;
0760             break;
0761         case Opt_scsi_target_id:
0762             ret = match_int(args, &arg);
0763             if (ret)
0764                 goto out;
0765             pdv->pdv_target_id = arg;
0766             pr_debug("PSCSI[%d]: Referencing SCSI Target"
0767                 " ID: %d\n", phv->phv_host_id,
0768                 pdv->pdv_target_id);
0769             pdv->pdv_flags |= PDF_HAS_TARGET_ID;
0770             break;
0771         case Opt_scsi_lun_id:
0772             ret = match_int(args, &arg);
0773             if (ret)
0774                 goto out;
0775             pdv->pdv_lun_id = arg;
0776             pr_debug("PSCSI[%d]: Referencing SCSI LUN ID:"
0777                 " %d\n", phv->phv_host_id, pdv->pdv_lun_id);
0778             pdv->pdv_flags |= PDF_HAS_LUN_ID;
0779             break;
0780         default:
0781             break;
0782         }
0783     }
0784 
0785 out:
0786     kfree(orig);
0787     return (!ret) ? count : ret;
0788 }
0789 
0790 static ssize_t pscsi_show_configfs_dev_params(struct se_device *dev, char *b)
0791 {
0792     struct pscsi_hba_virt *phv = dev->se_hba->hba_ptr;
0793     struct pscsi_dev_virt *pdv = PSCSI_DEV(dev);
0794     struct scsi_device *sd = pdv->pdv_sd;
0795     unsigned char host_id[16];
0796     ssize_t bl;
0797 
0798     if (phv->phv_mode == PHV_VIRTUAL_HOST_ID)
0799         snprintf(host_id, 16, "%d", pdv->pdv_host_id);
0800     else
0801         snprintf(host_id, 16, "PHBA Mode");
0802 
0803     bl = sprintf(b, "SCSI Device Bus Location:"
0804         " Channel ID: %d Target ID: %d LUN: %d Host ID: %s\n",
0805         pdv->pdv_channel_id, pdv->pdv_target_id, pdv->pdv_lun_id,
0806         host_id);
0807 
0808     if (sd) {
0809         bl += sprintf(b + bl, "        Vendor: %."
0810             __stringify(INQUIRY_VENDOR_LEN) "s", sd->vendor);
0811         bl += sprintf(b + bl, " Model: %."
0812             __stringify(INQUIRY_MODEL_LEN) "s", sd->model);
0813         bl += sprintf(b + bl, " Rev: %."
0814             __stringify(INQUIRY_REVISION_LEN) "s\n", sd->rev);
0815     }
0816     return bl;
0817 }
0818 
0819 static void pscsi_bi_endio(struct bio *bio)
0820 {
0821     bio_uninit(bio);
0822     kfree(bio);
0823 }
0824 
0825 static sense_reason_t
0826 pscsi_map_sg(struct se_cmd *cmd, struct scatterlist *sgl, u32 sgl_nents,
0827         struct request *req)
0828 {
0829     struct pscsi_dev_virt *pdv = PSCSI_DEV(cmd->se_dev);
0830     struct bio *bio = NULL;
0831     struct page *page;
0832     struct scatterlist *sg;
0833     u32 data_len = cmd->data_length, i, len, bytes, off;
0834     int nr_pages = (cmd->data_length + sgl[0].offset +
0835             PAGE_SIZE - 1) >> PAGE_SHIFT;
0836     int nr_vecs = 0, rc;
0837     int rw = (cmd->data_direction == DMA_TO_DEVICE);
0838 
0839     BUG_ON(!cmd->data_length);
0840 
0841     pr_debug("PSCSI: nr_pages: %d\n", nr_pages);
0842 
0843     for_each_sg(sgl, sg, sgl_nents, i) {
0844         page = sg_page(sg);
0845         off = sg->offset;
0846         len = sg->length;
0847 
0848         pr_debug("PSCSI: i: %d page: %p len: %d off: %d\n", i,
0849             page, len, off);
0850 
0851         /*
0852          * We only have one page of data in each sg element,
0853          * we can not cross a page boundary.
0854          */
0855         if (off + len > PAGE_SIZE)
0856             goto fail;
0857 
0858         if (len > 0 && data_len > 0) {
0859             bytes = min_t(unsigned int, len, PAGE_SIZE - off);
0860             bytes = min(bytes, data_len);
0861 
0862             if (!bio) {
0863 new_bio:
0864                 nr_vecs = bio_max_segs(nr_pages);
0865                 bio = bio_kmalloc(nr_vecs, GFP_KERNEL);
0866                 if (!bio)
0867                     goto fail;
0868                 bio_init(bio, NULL, bio->bi_inline_vecs, nr_vecs,
0869                      rw ? REQ_OP_WRITE : REQ_OP_READ);
0870                 bio->bi_end_io = pscsi_bi_endio;
0871 
0872                 pr_debug("PSCSI: Allocated bio: %p,"
0873                     " dir: %s nr_vecs: %d\n", bio,
0874                     (rw) ? "rw" : "r", nr_vecs);
0875             }
0876 
0877             pr_debug("PSCSI: Calling bio_add_pc_page() i: %d"
0878                 " bio: %p page: %p len: %d off: %d\n", i, bio,
0879                 page, len, off);
0880 
0881             rc = bio_add_pc_page(pdv->pdv_sd->request_queue,
0882                     bio, page, bytes, off);
0883             pr_debug("PSCSI: bio->bi_vcnt: %d nr_vecs: %d\n",
0884                 bio_segments(bio), nr_vecs);
0885             if (rc != bytes) {
0886                 pr_debug("PSCSI: Reached bio->bi_vcnt max:"
0887                     " %d i: %d bio: %p, allocating another"
0888                     " bio\n", bio->bi_vcnt, i, bio);
0889 
0890                 rc = blk_rq_append_bio(req, bio);
0891                 if (rc) {
0892                     pr_err("pSCSI: failed to append bio\n");
0893                     goto fail;
0894                 }
0895 
0896                 goto new_bio;
0897             }
0898 
0899             data_len -= bytes;
0900         }
0901     }
0902 
0903     if (bio) {
0904         rc = blk_rq_append_bio(req, bio);
0905         if (rc) {
0906             pr_err("pSCSI: failed to append bio\n");
0907             goto fail;
0908         }
0909     }
0910 
0911     return 0;
0912 fail:
0913     if (bio)
0914         bio_put(bio);
0915     while (req->bio) {
0916         bio = req->bio;
0917         req->bio = bio->bi_next;
0918         bio_put(bio);
0919     }
0920     req->biotail = NULL;
0921     return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
0922 }
0923 
0924 static sense_reason_t
0925 pscsi_parse_cdb(struct se_cmd *cmd)
0926 {
0927     if (cmd->se_cmd_flags & SCF_BIDI)
0928         return TCM_UNSUPPORTED_SCSI_OPCODE;
0929 
0930     return passthrough_parse_cdb(cmd, pscsi_execute_cmd);
0931 }
0932 
0933 static sense_reason_t
0934 pscsi_execute_cmd(struct se_cmd *cmd)
0935 {
0936     struct scatterlist *sgl = cmd->t_data_sg;
0937     u32 sgl_nents = cmd->t_data_nents;
0938     struct pscsi_dev_virt *pdv = PSCSI_DEV(cmd->se_dev);
0939     struct scsi_cmnd *scmd;
0940     struct request *req;
0941     sense_reason_t ret;
0942 
0943     req = scsi_alloc_request(pdv->pdv_sd->request_queue,
0944             cmd->data_direction == DMA_TO_DEVICE ?
0945             REQ_OP_DRV_OUT : REQ_OP_DRV_IN, 0);
0946     if (IS_ERR(req))
0947         return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
0948 
0949     if (sgl) {
0950         ret = pscsi_map_sg(cmd, sgl, sgl_nents, req);
0951         if (ret)
0952             goto fail_put_request;
0953     }
0954 
0955     req->end_io = pscsi_req_done;
0956     req->end_io_data = cmd;
0957 
0958     scmd = blk_mq_rq_to_pdu(req);
0959     scmd->cmd_len = scsi_command_size(cmd->t_task_cdb);
0960     if (scmd->cmd_len > sizeof(scmd->cmnd)) {
0961         ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
0962         goto fail_put_request;
0963     }
0964     memcpy(scmd->cmnd, cmd->t_task_cdb, scmd->cmd_len);
0965 
0966     if (pdv->pdv_sd->type == TYPE_DISK ||
0967         pdv->pdv_sd->type == TYPE_ZBC)
0968         req->timeout = PS_TIMEOUT_DISK;
0969     else
0970         req->timeout = PS_TIMEOUT_OTHER;
0971     scmd->allowed = PS_RETRY;
0972 
0973     cmd->priv = scmd->cmnd;
0974 
0975     blk_execute_rq_nowait(req, cmd->sam_task_attr == TCM_HEAD_TAG);
0976 
0977     return 0;
0978 
0979 fail_put_request:
0980     blk_mq_free_request(req);
0981     return ret;
0982 }
0983 
0984 /*  pscsi_get_device_type():
0985  *
0986  *
0987  */
0988 static u32 pscsi_get_device_type(struct se_device *dev)
0989 {
0990     struct pscsi_dev_virt *pdv = PSCSI_DEV(dev);
0991     struct scsi_device *sd = pdv->pdv_sd;
0992 
0993     return (sd) ? sd->type : TYPE_NO_LUN;
0994 }
0995 
0996 static sector_t pscsi_get_blocks(struct se_device *dev)
0997 {
0998     struct pscsi_dev_virt *pdv = PSCSI_DEV(dev);
0999 
1000     if (pdv->pdv_bd)
1001         return bdev_nr_sectors(pdv->pdv_bd);
1002     return 0;
1003 }
1004 
1005 static void pscsi_req_done(struct request *req, blk_status_t status)
1006 {
1007     struct se_cmd *cmd = req->end_io_data;
1008     struct scsi_cmnd *scmd = blk_mq_rq_to_pdu(req);
1009     enum sam_status scsi_status = scmd->result & 0xff;
1010     int valid_data = cmd->data_length - scmd->resid_len;
1011     u8 *cdb = cmd->priv;
1012 
1013     if (scsi_status != SAM_STAT_GOOD) {
1014         pr_debug("PSCSI Status Byte exception at cmd: %p CDB:"
1015             " 0x%02x Result: 0x%08x\n", cmd, cdb[0], scmd->result);
1016     }
1017 
1018     pscsi_complete_cmd(cmd, scsi_status, scmd->sense_buffer, valid_data);
1019 
1020     switch (host_byte(scmd->result)) {
1021     case DID_OK:
1022         target_complete_cmd_with_length(cmd, scsi_status, valid_data);
1023         break;
1024     default:
1025         pr_debug("PSCSI Host Byte exception at cmd: %p CDB:"
1026             " 0x%02x Result: 0x%08x\n", cmd, cdb[0], scmd->result);
1027         target_complete_cmd(cmd, SAM_STAT_CHECK_CONDITION);
1028         break;
1029     }
1030 
1031     blk_mq_free_request(req);
1032 }
1033 
1034 static const struct target_backend_ops pscsi_ops = {
1035     .name           = "pscsi",
1036     .owner          = THIS_MODULE,
1037     .transport_flags_default = TRANSPORT_FLAG_PASSTHROUGH |
1038                    TRANSPORT_FLAG_PASSTHROUGH_ALUA |
1039                    TRANSPORT_FLAG_PASSTHROUGH_PGR,
1040     .attach_hba     = pscsi_attach_hba,
1041     .detach_hba     = pscsi_detach_hba,
1042     .pmode_enable_hba   = pscsi_pmode_enable_hba,
1043     .alloc_device       = pscsi_alloc_device,
1044     .configure_device   = pscsi_configure_device,
1045     .destroy_device     = pscsi_destroy_device,
1046     .free_device        = pscsi_free_device,
1047     .parse_cdb      = pscsi_parse_cdb,
1048     .set_configfs_dev_params = pscsi_set_configfs_dev_params,
1049     .show_configfs_dev_params = pscsi_show_configfs_dev_params,
1050     .get_device_type    = pscsi_get_device_type,
1051     .get_blocks     = pscsi_get_blocks,
1052     .tb_dev_attrib_attrs    = passthrough_attrib_attrs,
1053 };
1054 
1055 static int __init pscsi_module_init(void)
1056 {
1057     return transport_backend_register(&pscsi_ops);
1058 }
1059 
1060 static void __exit pscsi_module_exit(void)
1061 {
1062     target_backend_unregister(&pscsi_ops);
1063 }
1064 
1065 MODULE_DESCRIPTION("TCM PSCSI subsystem plugin");
1066 MODULE_AUTHOR("nab@Linux-iSCSI.org");
1067 MODULE_LICENSE("GPL");
1068 
1069 module_init(pscsi_module_init);
1070 module_exit(pscsi_module_exit);
[ Source navigation ] [ Diff markup ] [ Identifier search ] [ general search ]

This page was automatically generated by the 2.1.0 LXR engine.

The LXR team
Valid CSS 2.1! Valid HTML 4.01!