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