source: src/linux/universal/linux-3.18/drivers/target/target_core_pscsi.c @ 31885

Last change on this file since 31885 was 31885, checked in by brainslayer, 2 months ago

update

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