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