1 /*******************************************************************************
2 * Filename: target_core_iblock.c
4 * This file contains the Storage Engine <-> Linux BlockIO transport
7 * Copyright (c) 2003, 2004, 2005 PyX Technologies, Inc.
8 * Copyright (c) 2005, 2006, 2007 SBE, Inc.
9 * Copyright (c) 2007-2010 Rising Tide Systems
10 * Copyright (c) 2008-2010 Linux-iSCSI.org
12 * Nicholas A. Bellinger <nab@kernel.org>
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 2 of the License, or
17 * (at your option) any later version.
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with this program; if not, write to the Free Software
26 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
28 ******************************************************************************/
30 #include <linux/string.h>
31 #include <linux/parser.h>
32 #include <linux/timer.h>
34 #include <linux/blkdev.h>
35 #include <linux/slab.h>
36 #include <linux/spinlock.h>
37 #include <linux/bio.h>
38 #include <linux/genhd.h>
39 #include <linux/file.h>
40 #include <linux/module.h>
41 #include <scsi/scsi.h>
42 #include <scsi/scsi_host.h>
43 #include <asm/unaligned.h>
45 #include <target/target_core_base.h>
46 #include <target/target_core_backend.h>
48 #include "target_core_iblock.h"
50 #define IBLOCK_MAX_BIO_PER_TASK 32 /* max # of bios to submit at a time */
51 #define IBLOCK_BIO_POOL_SIZE 128
53 static inline struct iblock_dev
*IBLOCK_DEV(struct se_device
*dev
)
55 return container_of(dev
, struct iblock_dev
, dev
);
59 static struct se_subsystem_api iblock_template
;
61 static void iblock_bio_done(struct bio
*, int);
63 /* iblock_attach_hba(): (Part of se_subsystem_api_t template)
67 static int iblock_attach_hba(struct se_hba
*hba
, u32 host_id
)
69 pr_debug("CORE_HBA[%d] - TCM iBlock HBA Driver %s on"
70 " Generic Target Core Stack %s\n", hba
->hba_id
,
71 IBLOCK_VERSION
, TARGET_CORE_MOD_VERSION
);
75 static void iblock_detach_hba(struct se_hba
*hba
)
79 static struct se_device
*iblock_alloc_device(struct se_hba
*hba
, const char *name
)
81 struct iblock_dev
*ib_dev
= NULL
;
83 ib_dev
= kzalloc(sizeof(struct iblock_dev
), GFP_KERNEL
);
85 pr_err("Unable to allocate struct iblock_dev\n");
89 pr_debug( "IBLOCK: Allocated ib_dev for %s\n", name
);
94 static int iblock_configure_device(struct se_device
*dev
)
96 struct iblock_dev
*ib_dev
= IBLOCK_DEV(dev
);
97 struct request_queue
*q
;
98 struct block_device
*bd
= NULL
;
102 if (!(ib_dev
->ibd_flags
& IBDF_HAS_UDEV_PATH
)) {
103 pr_err("Missing udev_path= parameters for IBLOCK\n");
107 ib_dev
->ibd_bio_set
= bioset_create(IBLOCK_BIO_POOL_SIZE
, 0);
108 if (!ib_dev
->ibd_bio_set
) {
109 pr_err("IBLOCK: Unable to create bioset\n");
113 pr_debug( "IBLOCK: Claiming struct block_device: %s\n",
114 ib_dev
->ibd_udev_path
);
116 mode
= FMODE_READ
|FMODE_EXCL
;
117 if (!ib_dev
->ibd_readonly
)
120 bd
= blkdev_get_by_path(ib_dev
->ibd_udev_path
, mode
, ib_dev
);
123 goto out_free_bioset
;
127 q
= bdev_get_queue(bd
);
129 dev
->dev_attrib
.hw_block_size
= bdev_logical_block_size(bd
);
130 dev
->dev_attrib
.hw_max_sectors
= UINT_MAX
;
131 dev
->dev_attrib
.hw_queue_depth
= q
->nr_requests
;
134 * Check if the underlying struct block_device request_queue supports
135 * the QUEUE_FLAG_DISCARD bit for UNMAP/WRITE_SAME in SCSI + TRIM
136 * in ATA and we need to set TPE=1
138 if (blk_queue_discard(q
)) {
139 dev
->dev_attrib
.max_unmap_lba_count
=
140 q
->limits
.max_discard_sectors
;
143 * Currently hardcoded to 1 in Linux/SCSI code..
145 dev
->dev_attrib
.max_unmap_block_desc_count
= 1;
146 dev
->dev_attrib
.unmap_granularity
=
147 q
->limits
.discard_granularity
>> 9;
148 dev
->dev_attrib
.unmap_granularity_alignment
=
149 q
->limits
.discard_alignment
;
151 pr_debug("IBLOCK: BLOCK Discard support available,"
152 " disabled by default\n");
155 if (blk_queue_nonrot(q
))
156 dev
->dev_attrib
.is_nonrot
= 1;
160 bioset_free(ib_dev
->ibd_bio_set
);
161 ib_dev
->ibd_bio_set
= NULL
;
166 static void iblock_free_device(struct se_device
*dev
)
168 struct iblock_dev
*ib_dev
= IBLOCK_DEV(dev
);
170 if (ib_dev
->ibd_bd
!= NULL
)
171 blkdev_put(ib_dev
->ibd_bd
, FMODE_WRITE
|FMODE_READ
|FMODE_EXCL
);
172 if (ib_dev
->ibd_bio_set
!= NULL
)
173 bioset_free(ib_dev
->ibd_bio_set
);
177 static unsigned long long iblock_emulate_read_cap_with_block_size(
178 struct se_device
*dev
,
179 struct block_device
*bd
,
180 struct request_queue
*q
)
182 unsigned long long blocks_long
= (div_u64(i_size_read(bd
->bd_inode
),
183 bdev_logical_block_size(bd
)) - 1);
184 u32 block_size
= bdev_logical_block_size(bd
);
186 if (block_size
== dev
->dev_attrib
.block_size
)
189 switch (block_size
) {
191 switch (dev
->dev_attrib
.block_size
) {
205 switch (dev
->dev_attrib
.block_size
) {
220 switch (dev
->dev_attrib
.block_size
) {
235 switch (dev
->dev_attrib
.block_size
) {
256 static void iblock_end_io_flush(struct bio
*bio
, int err
)
258 struct se_cmd
*cmd
= bio
->bi_private
;
261 pr_err("IBLOCK: cache flush failed: %d\n", err
);
265 target_complete_cmd(cmd
, SAM_STAT_CHECK_CONDITION
);
267 target_complete_cmd(cmd
, SAM_STAT_GOOD
);
274 * Implement SYCHRONIZE CACHE. Note that we can't handle lba ranges and must
275 * always flush the whole cache.
277 static sense_reason_t
278 iblock_execute_sync_cache(struct se_cmd
*cmd
)
280 struct iblock_dev
*ib_dev
= IBLOCK_DEV(cmd
->se_dev
);
281 int immed
= (cmd
->t_task_cdb
[1] & 0x2);
285 * If the Immediate bit is set, queue up the GOOD response
286 * for this SYNCHRONIZE_CACHE op.
289 target_complete_cmd(cmd
, SAM_STAT_GOOD
);
291 bio
= bio_alloc(GFP_KERNEL
, 0);
292 bio
->bi_end_io
= iblock_end_io_flush
;
293 bio
->bi_bdev
= ib_dev
->ibd_bd
;
295 bio
->bi_private
= cmd
;
296 submit_bio(WRITE_FLUSH
, bio
);
300 static sense_reason_t
301 iblock_execute_unmap(struct se_cmd
*cmd
)
303 struct se_device
*dev
= cmd
->se_dev
;
304 struct iblock_dev
*ib_dev
= IBLOCK_DEV(dev
);
305 unsigned char *buf
, *ptr
= NULL
;
309 sense_reason_t ret
= 0;
312 if (cmd
->data_length
< 8) {
313 pr_warn("UNMAP parameter list length %u too small\n",
315 return TCM_INVALID_PARAMETER_LIST
;
318 buf
= transport_kmap_data_sg(cmd
);
320 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
322 dl
= get_unaligned_be16(&buf
[0]);
323 bd_dl
= get_unaligned_be16(&buf
[2]);
325 size
= cmd
->data_length
- 8;
327 pr_warn("UNMAP parameter list length %u too small, ignoring bd_dl %u\n",
328 cmd
->data_length
, bd_dl
);
332 if (size
/ 16 > dev
->dev_attrib
.max_unmap_block_desc_count
) {
333 ret
= TCM_INVALID_PARAMETER_LIST
;
337 /* First UNMAP block descriptor starts at 8 byte offset */
339 pr_debug("UNMAP: Sub: %s Using dl: %u bd_dl: %u size: %u"
340 " ptr: %p\n", dev
->transport
->name
, dl
, bd_dl
, size
, ptr
);
343 lba
= get_unaligned_be64(&ptr
[0]);
344 range
= get_unaligned_be32(&ptr
[8]);
345 pr_debug("UNMAP: Using lba: %llu and range: %u\n",
346 (unsigned long long)lba
, range
);
348 if (range
> dev
->dev_attrib
.max_unmap_lba_count
) {
349 ret
= TCM_INVALID_PARAMETER_LIST
;
353 if (lba
+ range
> dev
->transport
->get_blocks(dev
) + 1) {
354 ret
= TCM_ADDRESS_OUT_OF_RANGE
;
358 err
= blkdev_issue_discard(ib_dev
->ibd_bd
, lba
, range
,
361 pr_err("blkdev_issue_discard() failed: %d\n",
363 ret
= TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
372 transport_kunmap_data_sg(cmd
);
374 target_complete_cmd(cmd
, GOOD
);
378 static sense_reason_t
379 iblock_execute_write_same(struct se_cmd
*cmd
)
381 struct iblock_dev
*ib_dev
= IBLOCK_DEV(cmd
->se_dev
);
384 ret
= blkdev_issue_discard(ib_dev
->ibd_bd
, cmd
->t_task_lba
,
385 spc_get_write_same_sectors(cmd
), GFP_KERNEL
,
388 pr_debug("blkdev_issue_discard() failed for WRITE_SAME\n");
389 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
392 target_complete_cmd(cmd
, GOOD
);
397 Opt_udev_path
, Opt_readonly
, Opt_force
, Opt_err
400 static match_table_t tokens
= {
401 {Opt_udev_path
, "udev_path=%s"},
402 {Opt_readonly
, "readonly=%d"},
403 {Opt_force
, "force=%d"},
407 static ssize_t
iblock_set_configfs_dev_params(struct se_device
*dev
,
408 const char *page
, ssize_t count
)
410 struct iblock_dev
*ib_dev
= IBLOCK_DEV(dev
);
411 char *orig
, *ptr
, *arg_p
, *opts
;
412 substring_t args
[MAX_OPT_ARGS
];
414 unsigned long tmp_readonly
;
416 opts
= kstrdup(page
, GFP_KERNEL
);
422 while ((ptr
= strsep(&opts
, ",\n")) != NULL
) {
426 token
= match_token(ptr
, tokens
, args
);
429 if (ib_dev
->ibd_bd
) {
430 pr_err("Unable to set udev_path= while"
431 " ib_dev->ibd_bd exists\n");
435 if (match_strlcpy(ib_dev
->ibd_udev_path
, &args
[0],
436 SE_UDEV_PATH_LEN
) == 0) {
440 pr_debug("IBLOCK: Referencing UDEV path: %s\n",
441 ib_dev
->ibd_udev_path
);
442 ib_dev
->ibd_flags
|= IBDF_HAS_UDEV_PATH
;
445 arg_p
= match_strdup(&args
[0]);
450 ret
= strict_strtoul(arg_p
, 0, &tmp_readonly
);
453 pr_err("strict_strtoul() failed for"
457 ib_dev
->ibd_readonly
= tmp_readonly
;
458 pr_debug("IBLOCK: readonly: %d\n", ib_dev
->ibd_readonly
);
469 return (!ret
) ? count
: ret
;
472 static ssize_t
iblock_show_configfs_dev_params(struct se_device
*dev
, char *b
)
474 struct iblock_dev
*ib_dev
= IBLOCK_DEV(dev
);
475 struct block_device
*bd
= ib_dev
->ibd_bd
;
476 char buf
[BDEVNAME_SIZE
];
480 bl
+= sprintf(b
+ bl
, "iBlock device: %s",
482 if (ib_dev
->ibd_flags
& IBDF_HAS_UDEV_PATH
)
483 bl
+= sprintf(b
+ bl
, " UDEV PATH: %s",
484 ib_dev
->ibd_udev_path
);
485 bl
+= sprintf(b
+ bl
, " readonly: %d\n", ib_dev
->ibd_readonly
);
487 bl
+= sprintf(b
+ bl
, " ");
489 bl
+= sprintf(b
+ bl
, "Major: %d Minor: %d %s\n",
490 MAJOR(bd
->bd_dev
), MINOR(bd
->bd_dev
), (!bd
->bd_contains
) ?
491 "" : (bd
->bd_holder
== ib_dev
) ?
492 "CLAIMED: IBLOCK" : "CLAIMED: OS");
494 bl
+= sprintf(b
+ bl
, "Major: 0 Minor: 0\n");
500 static void iblock_complete_cmd(struct se_cmd
*cmd
)
502 struct iblock_req
*ibr
= cmd
->priv
;
505 if (!atomic_dec_and_test(&ibr
->pending
))
508 if (atomic_read(&ibr
->ib_bio_err_cnt
))
509 status
= SAM_STAT_CHECK_CONDITION
;
511 status
= SAM_STAT_GOOD
;
513 target_complete_cmd(cmd
, status
);
518 iblock_get_bio(struct se_cmd
*cmd
, sector_t lba
, u32 sg_num
)
520 struct iblock_dev
*ib_dev
= IBLOCK_DEV(cmd
->se_dev
);
524 * Only allocate as many vector entries as the bio code allows us to,
525 * we'll loop later on until we have handled the whole request.
527 if (sg_num
> BIO_MAX_PAGES
)
528 sg_num
= BIO_MAX_PAGES
;
530 bio
= bio_alloc_bioset(GFP_NOIO
, sg_num
, ib_dev
->ibd_bio_set
);
532 pr_err("Unable to allocate memory for bio\n");
536 bio
->bi_bdev
= ib_dev
->ibd_bd
;
537 bio
->bi_private
= cmd
;
538 bio
->bi_end_io
= &iblock_bio_done
;
539 bio
->bi_sector
= lba
;
543 static void iblock_submit_bios(struct bio_list
*list
, int rw
)
545 struct blk_plug plug
;
548 blk_start_plug(&plug
);
549 while ((bio
= bio_list_pop(list
)))
551 blk_finish_plug(&plug
);
554 static sense_reason_t
555 iblock_execute_rw(struct se_cmd
*cmd
)
557 struct scatterlist
*sgl
= cmd
->t_data_sg
;
558 u32 sgl_nents
= cmd
->t_data_nents
;
559 enum dma_data_direction data_direction
= cmd
->data_direction
;
560 struct se_device
*dev
= cmd
->se_dev
;
561 struct iblock_req
*ibr
;
563 struct bio_list list
;
564 struct scatterlist
*sg
;
565 u32 sg_num
= sgl_nents
;
571 if (data_direction
== DMA_TO_DEVICE
) {
573 * Force data to disk if we pretend to not have a volatile
574 * write cache, or the initiator set the Force Unit Access bit.
576 if (dev
->dev_attrib
.emulate_write_cache
== 0 ||
577 (dev
->dev_attrib
.emulate_fua_write
> 0 &&
578 (cmd
->se_cmd_flags
& SCF_FUA
)))
587 * Convert the blocksize advertised to the initiator to the 512 byte
588 * units unconditionally used by the Linux block layer.
590 if (dev
->dev_attrib
.block_size
== 4096)
591 block_lba
= (cmd
->t_task_lba
<< 3);
592 else if (dev
->dev_attrib
.block_size
== 2048)
593 block_lba
= (cmd
->t_task_lba
<< 2);
594 else if (dev
->dev_attrib
.block_size
== 1024)
595 block_lba
= (cmd
->t_task_lba
<< 1);
596 else if (dev
->dev_attrib
.block_size
== 512)
597 block_lba
= cmd
->t_task_lba
;
599 pr_err("Unsupported SCSI -> BLOCK LBA conversion:"
600 " %u\n", dev
->dev_attrib
.block_size
);
601 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
604 ibr
= kzalloc(sizeof(struct iblock_req
), GFP_KERNEL
);
610 atomic_set(&ibr
->pending
, 1);
611 iblock_complete_cmd(cmd
);
615 bio
= iblock_get_bio(cmd
, block_lba
, sgl_nents
);
619 bio_list_init(&list
);
620 bio_list_add(&list
, bio
);
622 atomic_set(&ibr
->pending
, 2);
625 for_each_sg(sgl
, sg
, sgl_nents
, i
) {
627 * XXX: if the length the device accepts is shorter than the
628 * length of the S/G list entry this will cause and
629 * endless loop. Better hope no driver uses huge pages.
631 while (bio_add_page(bio
, sg_page(sg
), sg
->length
, sg
->offset
)
633 if (bio_cnt
>= IBLOCK_MAX_BIO_PER_TASK
) {
634 iblock_submit_bios(&list
, rw
);
638 bio
= iblock_get_bio(cmd
, block_lba
, sg_num
);
642 atomic_inc(&ibr
->pending
);
643 bio_list_add(&list
, bio
);
647 /* Always in 512 byte units for Linux/Block */
648 block_lba
+= sg
->length
>> IBLOCK_LBA_SHIFT
;
652 iblock_submit_bios(&list
, rw
);
653 iblock_complete_cmd(cmd
);
657 while ((bio
= bio_list_pop(&list
)))
662 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
665 static sector_t
iblock_get_blocks(struct se_device
*dev
)
667 struct iblock_dev
*ib_dev
= IBLOCK_DEV(dev
);
668 struct block_device
*bd
= ib_dev
->ibd_bd
;
669 struct request_queue
*q
= bdev_get_queue(bd
);
671 return iblock_emulate_read_cap_with_block_size(dev
, bd
, q
);
674 static void iblock_bio_done(struct bio
*bio
, int err
)
676 struct se_cmd
*cmd
= bio
->bi_private
;
677 struct iblock_req
*ibr
= cmd
->priv
;
680 * Set -EIO if !BIO_UPTODATE and the passed is still err=0
682 if (!test_bit(BIO_UPTODATE
, &bio
->bi_flags
) && !err
)
686 pr_err("test_bit(BIO_UPTODATE) failed for bio: %p,"
687 " err: %d\n", bio
, err
);
689 * Bump the ib_bio_err_cnt and release bio.
691 atomic_inc(&ibr
->ib_bio_err_cnt
);
692 smp_mb__after_atomic_inc();
697 iblock_complete_cmd(cmd
);
700 static struct sbc_ops iblock_sbc_ops
= {
701 .execute_rw
= iblock_execute_rw
,
702 .execute_sync_cache
= iblock_execute_sync_cache
,
703 .execute_write_same
= iblock_execute_write_same
,
704 .execute_unmap
= iblock_execute_unmap
,
707 static sense_reason_t
708 iblock_parse_cdb(struct se_cmd
*cmd
)
710 return sbc_parse_cdb(cmd
, &iblock_sbc_ops
);
713 static struct se_subsystem_api iblock_template
= {
715 .inquiry_prod
= "IBLOCK",
716 .inquiry_rev
= IBLOCK_VERSION
,
717 .owner
= THIS_MODULE
,
718 .transport_type
= TRANSPORT_PLUGIN_VHBA_PDEV
,
719 .attach_hba
= iblock_attach_hba
,
720 .detach_hba
= iblock_detach_hba
,
721 .alloc_device
= iblock_alloc_device
,
722 .configure_device
= iblock_configure_device
,
723 .free_device
= iblock_free_device
,
724 .parse_cdb
= iblock_parse_cdb
,
725 .set_configfs_dev_params
= iblock_set_configfs_dev_params
,
726 .show_configfs_dev_params
= iblock_show_configfs_dev_params
,
727 .get_device_type
= sbc_get_device_type
,
728 .get_blocks
= iblock_get_blocks
,
731 static int __init
iblock_module_init(void)
733 return transport_subsystem_register(&iblock_template
);
736 static void iblock_module_exit(void)
738 transport_subsystem_release(&iblock_template
);
741 MODULE_DESCRIPTION("TCM IBLOCK subsystem plugin");
742 MODULE_AUTHOR("nab@Linux-iSCSI.org");
743 MODULE_LICENSE("GPL");
745 module_init(iblock_module_init
);
746 module_exit(iblock_module_exit
);