1 /*******************************************************************************
2 * Filename: target_core_iblock.c
4 * This file contains the Storage Engine <-> Linux BlockIO transport
7 * (c) Copyright 2003-2012 RisingTide Systems LLC.
9 * Nicholas A. Bellinger <nab@kernel.org>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
25 ******************************************************************************/
27 #include <linux/string.h>
28 #include <linux/parser.h>
29 #include <linux/timer.h>
31 #include <linux/blkdev.h>
32 #include <linux/slab.h>
33 #include <linux/spinlock.h>
34 #include <linux/bio.h>
35 #include <linux/genhd.h>
36 #include <linux/file.h>
37 #include <linux/module.h>
38 #include <scsi/scsi.h>
39 #include <scsi/scsi_host.h>
40 #include <asm/unaligned.h>
42 #include <target/target_core_base.h>
43 #include <target/target_core_backend.h>
45 #include "target_core_iblock.h"
47 #define IBLOCK_MAX_BIO_PER_TASK 32 /* max # of bios to submit at a time */
48 #define IBLOCK_BIO_POOL_SIZE 128
50 static inline struct iblock_dev
*IBLOCK_DEV(struct se_device
*dev
)
52 return container_of(dev
, struct iblock_dev
, dev
);
56 static struct se_subsystem_api iblock_template
;
58 /* iblock_attach_hba(): (Part of se_subsystem_api_t template)
62 static int iblock_attach_hba(struct se_hba
*hba
, u32 host_id
)
64 pr_debug("CORE_HBA[%d] - TCM iBlock HBA Driver %s on"
65 " Generic Target Core Stack %s\n", hba
->hba_id
,
66 IBLOCK_VERSION
, TARGET_CORE_MOD_VERSION
);
70 static void iblock_detach_hba(struct se_hba
*hba
)
74 static struct se_device
*iblock_alloc_device(struct se_hba
*hba
, const char *name
)
76 struct iblock_dev
*ib_dev
= NULL
;
78 ib_dev
= kzalloc(sizeof(struct iblock_dev
), GFP_KERNEL
);
80 pr_err("Unable to allocate struct iblock_dev\n");
84 pr_debug( "IBLOCK: Allocated ib_dev for %s\n", name
);
89 static int iblock_configure_device(struct se_device
*dev
)
91 struct iblock_dev
*ib_dev
= IBLOCK_DEV(dev
);
92 struct request_queue
*q
;
93 struct block_device
*bd
= NULL
;
97 if (!(ib_dev
->ibd_flags
& IBDF_HAS_UDEV_PATH
)) {
98 pr_err("Missing udev_path= parameters for IBLOCK\n");
102 ib_dev
->ibd_bio_set
= bioset_create(IBLOCK_BIO_POOL_SIZE
, 0);
103 if (!ib_dev
->ibd_bio_set
) {
104 pr_err("IBLOCK: Unable to create bioset\n");
108 pr_debug( "IBLOCK: Claiming struct block_device: %s\n",
109 ib_dev
->ibd_udev_path
);
111 mode
= FMODE_READ
|FMODE_EXCL
;
112 if (!ib_dev
->ibd_readonly
)
115 bd
= blkdev_get_by_path(ib_dev
->ibd_udev_path
, mode
, ib_dev
);
118 goto out_free_bioset
;
122 q
= bdev_get_queue(bd
);
124 dev
->dev_attrib
.hw_block_size
= bdev_logical_block_size(bd
);
125 dev
->dev_attrib
.hw_max_sectors
= UINT_MAX
;
126 dev
->dev_attrib
.hw_queue_depth
= q
->nr_requests
;
129 * Check if the underlying struct block_device request_queue supports
130 * the QUEUE_FLAG_DISCARD bit for UNMAP/WRITE_SAME in SCSI + TRIM
131 * in ATA and we need to set TPE=1
133 if (blk_queue_discard(q
)) {
134 dev
->dev_attrib
.max_unmap_lba_count
=
135 q
->limits
.max_discard_sectors
;
138 * Currently hardcoded to 1 in Linux/SCSI code..
140 dev
->dev_attrib
.max_unmap_block_desc_count
= 1;
141 dev
->dev_attrib
.unmap_granularity
=
142 q
->limits
.discard_granularity
>> 9;
143 dev
->dev_attrib
.unmap_granularity_alignment
=
144 q
->limits
.discard_alignment
;
146 pr_debug("IBLOCK: BLOCK Discard support available,"
147 " disabled by default\n");
150 * Enable write same emulation for IBLOCK and use 0xFFFF as
151 * the smaller WRITE_SAME(10) only has a two-byte block count.
153 dev
->dev_attrib
.max_write_same_len
= 0xFFFF;
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_complete_cmd(struct se_cmd
*cmd
)
258 struct iblock_req
*ibr
= cmd
->priv
;
261 if (!atomic_dec_and_test(&ibr
->pending
))
264 if (atomic_read(&ibr
->ib_bio_err_cnt
))
265 status
= SAM_STAT_CHECK_CONDITION
;
267 status
= SAM_STAT_GOOD
;
269 target_complete_cmd(cmd
, status
);
273 static void iblock_bio_done(struct bio
*bio
, int err
)
275 struct se_cmd
*cmd
= bio
->bi_private
;
276 struct iblock_req
*ibr
= cmd
->priv
;
279 * Set -EIO if !BIO_UPTODATE and the passed is still err=0
281 if (!test_bit(BIO_UPTODATE
, &bio
->bi_flags
) && !err
)
285 pr_err("test_bit(BIO_UPTODATE) failed for bio: %p,"
286 " err: %d\n", bio
, err
);
288 * Bump the ib_bio_err_cnt and release bio.
290 atomic_inc(&ibr
->ib_bio_err_cnt
);
291 smp_mb__after_atomic_inc();
296 iblock_complete_cmd(cmd
);
300 iblock_get_bio(struct se_cmd
*cmd
, sector_t lba
, u32 sg_num
)
302 struct iblock_dev
*ib_dev
= IBLOCK_DEV(cmd
->se_dev
);
306 * Only allocate as many vector entries as the bio code allows us to,
307 * we'll loop later on until we have handled the whole request.
309 if (sg_num
> BIO_MAX_PAGES
)
310 sg_num
= BIO_MAX_PAGES
;
312 bio
= bio_alloc_bioset(GFP_NOIO
, sg_num
, ib_dev
->ibd_bio_set
);
314 pr_err("Unable to allocate memory for bio\n");
318 bio
->bi_bdev
= ib_dev
->ibd_bd
;
319 bio
->bi_private
= cmd
;
320 bio
->bi_end_io
= &iblock_bio_done
;
321 bio
->bi_sector
= lba
;
326 static void iblock_submit_bios(struct bio_list
*list
, int rw
)
328 struct blk_plug plug
;
331 blk_start_plug(&plug
);
332 while ((bio
= bio_list_pop(list
)))
334 blk_finish_plug(&plug
);
337 static void iblock_end_io_flush(struct bio
*bio
, int err
)
339 struct se_cmd
*cmd
= bio
->bi_private
;
342 pr_err("IBLOCK: cache flush failed: %d\n", err
);
346 target_complete_cmd(cmd
, SAM_STAT_CHECK_CONDITION
);
348 target_complete_cmd(cmd
, SAM_STAT_GOOD
);
355 * Implement SYCHRONIZE CACHE. Note that we can't handle lba ranges and must
356 * always flush the whole cache.
358 static sense_reason_t
359 iblock_execute_sync_cache(struct se_cmd
*cmd
)
361 struct iblock_dev
*ib_dev
= IBLOCK_DEV(cmd
->se_dev
);
362 int immed
= (cmd
->t_task_cdb
[1] & 0x2);
366 * If the Immediate bit is set, queue up the GOOD response
367 * for this SYNCHRONIZE_CACHE op.
370 target_complete_cmd(cmd
, SAM_STAT_GOOD
);
372 bio
= bio_alloc(GFP_KERNEL
, 0);
373 bio
->bi_end_io
= iblock_end_io_flush
;
374 bio
->bi_bdev
= ib_dev
->ibd_bd
;
376 bio
->bi_private
= cmd
;
377 submit_bio(WRITE_FLUSH
, bio
);
381 static sense_reason_t
382 iblock_execute_unmap(struct se_cmd
*cmd
)
384 struct se_device
*dev
= cmd
->se_dev
;
385 struct iblock_dev
*ib_dev
= IBLOCK_DEV(dev
);
386 unsigned char *buf
, *ptr
= NULL
;
390 sense_reason_t ret
= 0;
393 if (cmd
->data_length
< 8) {
394 pr_warn("UNMAP parameter list length %u too small\n",
396 return TCM_INVALID_PARAMETER_LIST
;
399 buf
= transport_kmap_data_sg(cmd
);
401 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
403 dl
= get_unaligned_be16(&buf
[0]);
404 bd_dl
= get_unaligned_be16(&buf
[2]);
406 size
= cmd
->data_length
- 8;
408 pr_warn("UNMAP parameter list length %u too small, ignoring bd_dl %u\n",
409 cmd
->data_length
, bd_dl
);
413 if (size
/ 16 > dev
->dev_attrib
.max_unmap_block_desc_count
) {
414 ret
= TCM_INVALID_PARAMETER_LIST
;
418 /* First UNMAP block descriptor starts at 8 byte offset */
420 pr_debug("UNMAP: Sub: %s Using dl: %u bd_dl: %u size: %u"
421 " ptr: %p\n", dev
->transport
->name
, dl
, bd_dl
, size
, ptr
);
424 lba
= get_unaligned_be64(&ptr
[0]);
425 range
= get_unaligned_be32(&ptr
[8]);
426 pr_debug("UNMAP: Using lba: %llu and range: %u\n",
427 (unsigned long long)lba
, range
);
429 if (range
> dev
->dev_attrib
.max_unmap_lba_count
) {
430 ret
= TCM_INVALID_PARAMETER_LIST
;
434 if (lba
+ range
> dev
->transport
->get_blocks(dev
) + 1) {
435 ret
= TCM_ADDRESS_OUT_OF_RANGE
;
439 err
= blkdev_issue_discard(ib_dev
->ibd_bd
, lba
, range
,
442 pr_err("blkdev_issue_discard() failed: %d\n",
444 ret
= TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
453 transport_kunmap_data_sg(cmd
);
455 target_complete_cmd(cmd
, GOOD
);
459 static sense_reason_t
460 iblock_execute_write_same_unmap(struct se_cmd
*cmd
)
462 struct iblock_dev
*ib_dev
= IBLOCK_DEV(cmd
->se_dev
);
465 rc
= blkdev_issue_discard(ib_dev
->ibd_bd
, cmd
->t_task_lba
,
466 spc_get_write_same_sectors(cmd
), GFP_KERNEL
, 0);
468 pr_warn("blkdev_issue_discard() failed: %d\n", rc
);
469 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
472 target_complete_cmd(cmd
, GOOD
);
476 static sense_reason_t
477 iblock_execute_write_same(struct se_cmd
*cmd
)
479 struct iblock_req
*ibr
;
480 struct scatterlist
*sg
;
482 struct bio_list list
;
483 sector_t block_lba
= cmd
->t_task_lba
;
484 sector_t sectors
= spc_get_write_same_sectors(cmd
);
486 sg
= &cmd
->t_data_sg
[0];
488 if (cmd
->t_data_nents
> 1 ||
489 sg
->length
!= cmd
->se_dev
->dev_attrib
.block_size
) {
490 pr_err("WRITE_SAME: Illegal SGL t_data_nents: %u length: %u"
491 " block_size: %u\n", cmd
->t_data_nents
, sg
->length
,
492 cmd
->se_dev
->dev_attrib
.block_size
);
493 return TCM_INVALID_CDB_FIELD
;
496 ibr
= kzalloc(sizeof(struct iblock_req
), GFP_KERNEL
);
501 bio
= iblock_get_bio(cmd
, block_lba
, 1);
505 bio_list_init(&list
);
506 bio_list_add(&list
, bio
);
508 atomic_set(&ibr
->pending
, 1);
511 while (bio_add_page(bio
, sg_page(sg
), sg
->length
, sg
->offset
)
514 bio
= iblock_get_bio(cmd
, block_lba
, 1);
518 atomic_inc(&ibr
->pending
);
519 bio_list_add(&list
, bio
);
522 /* Always in 512 byte units for Linux/Block */
523 block_lba
+= sg
->length
>> IBLOCK_LBA_SHIFT
;
527 iblock_submit_bios(&list
, WRITE
);
531 while ((bio
= bio_list_pop(&list
)))
536 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
540 Opt_udev_path
, Opt_readonly
, Opt_force
, Opt_err
543 static match_table_t tokens
= {
544 {Opt_udev_path
, "udev_path=%s"},
545 {Opt_readonly
, "readonly=%d"},
546 {Opt_force
, "force=%d"},
550 static ssize_t
iblock_set_configfs_dev_params(struct se_device
*dev
,
551 const char *page
, ssize_t count
)
553 struct iblock_dev
*ib_dev
= IBLOCK_DEV(dev
);
554 char *orig
, *ptr
, *arg_p
, *opts
;
555 substring_t args
[MAX_OPT_ARGS
];
557 unsigned long tmp_readonly
;
559 opts
= kstrdup(page
, GFP_KERNEL
);
565 while ((ptr
= strsep(&opts
, ",\n")) != NULL
) {
569 token
= match_token(ptr
, tokens
, args
);
572 if (ib_dev
->ibd_bd
) {
573 pr_err("Unable to set udev_path= while"
574 " ib_dev->ibd_bd exists\n");
578 if (match_strlcpy(ib_dev
->ibd_udev_path
, &args
[0],
579 SE_UDEV_PATH_LEN
) == 0) {
583 pr_debug("IBLOCK: Referencing UDEV path: %s\n",
584 ib_dev
->ibd_udev_path
);
585 ib_dev
->ibd_flags
|= IBDF_HAS_UDEV_PATH
;
588 arg_p
= match_strdup(&args
[0]);
593 ret
= strict_strtoul(arg_p
, 0, &tmp_readonly
);
596 pr_err("strict_strtoul() failed for"
600 ib_dev
->ibd_readonly
= tmp_readonly
;
601 pr_debug("IBLOCK: readonly: %d\n", ib_dev
->ibd_readonly
);
612 return (!ret
) ? count
: ret
;
615 static ssize_t
iblock_show_configfs_dev_params(struct se_device
*dev
, char *b
)
617 struct iblock_dev
*ib_dev
= IBLOCK_DEV(dev
);
618 struct block_device
*bd
= ib_dev
->ibd_bd
;
619 char buf
[BDEVNAME_SIZE
];
623 bl
+= sprintf(b
+ bl
, "iBlock device: %s",
625 if (ib_dev
->ibd_flags
& IBDF_HAS_UDEV_PATH
)
626 bl
+= sprintf(b
+ bl
, " UDEV PATH: %s",
627 ib_dev
->ibd_udev_path
);
628 bl
+= sprintf(b
+ bl
, " readonly: %d\n", ib_dev
->ibd_readonly
);
630 bl
+= sprintf(b
+ bl
, " ");
632 bl
+= sprintf(b
+ bl
, "Major: %d Minor: %d %s\n",
633 MAJOR(bd
->bd_dev
), MINOR(bd
->bd_dev
), (!bd
->bd_contains
) ?
634 "" : (bd
->bd_holder
== ib_dev
) ?
635 "CLAIMED: IBLOCK" : "CLAIMED: OS");
637 bl
+= sprintf(b
+ bl
, "Major: 0 Minor: 0\n");
643 static sense_reason_t
644 iblock_execute_rw(struct se_cmd
*cmd
)
646 struct scatterlist
*sgl
= cmd
->t_data_sg
;
647 u32 sgl_nents
= cmd
->t_data_nents
;
648 enum dma_data_direction data_direction
= cmd
->data_direction
;
649 struct se_device
*dev
= cmd
->se_dev
;
650 struct iblock_req
*ibr
;
652 struct bio_list list
;
653 struct scatterlist
*sg
;
654 u32 sg_num
= sgl_nents
;
660 if (data_direction
== DMA_TO_DEVICE
) {
662 * Force data to disk if we pretend to not have a volatile
663 * write cache, or the initiator set the Force Unit Access bit.
665 if (dev
->dev_attrib
.emulate_write_cache
== 0 ||
666 (dev
->dev_attrib
.emulate_fua_write
> 0 &&
667 (cmd
->se_cmd_flags
& SCF_FUA
)))
676 * Convert the blocksize advertised to the initiator to the 512 byte
677 * units unconditionally used by the Linux block layer.
679 if (dev
->dev_attrib
.block_size
== 4096)
680 block_lba
= (cmd
->t_task_lba
<< 3);
681 else if (dev
->dev_attrib
.block_size
== 2048)
682 block_lba
= (cmd
->t_task_lba
<< 2);
683 else if (dev
->dev_attrib
.block_size
== 1024)
684 block_lba
= (cmd
->t_task_lba
<< 1);
685 else if (dev
->dev_attrib
.block_size
== 512)
686 block_lba
= cmd
->t_task_lba
;
688 pr_err("Unsupported SCSI -> BLOCK LBA conversion:"
689 " %u\n", dev
->dev_attrib
.block_size
);
690 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
693 ibr
= kzalloc(sizeof(struct iblock_req
), GFP_KERNEL
);
699 atomic_set(&ibr
->pending
, 1);
700 iblock_complete_cmd(cmd
);
704 bio
= iblock_get_bio(cmd
, block_lba
, sgl_nents
);
708 bio_list_init(&list
);
709 bio_list_add(&list
, bio
);
711 atomic_set(&ibr
->pending
, 2);
714 for_each_sg(sgl
, sg
, sgl_nents
, i
) {
716 * XXX: if the length the device accepts is shorter than the
717 * length of the S/G list entry this will cause and
718 * endless loop. Better hope no driver uses huge pages.
720 while (bio_add_page(bio
, sg_page(sg
), sg
->length
, sg
->offset
)
722 if (bio_cnt
>= IBLOCK_MAX_BIO_PER_TASK
) {
723 iblock_submit_bios(&list
, rw
);
727 bio
= iblock_get_bio(cmd
, block_lba
, sg_num
);
731 atomic_inc(&ibr
->pending
);
732 bio_list_add(&list
, bio
);
736 /* Always in 512 byte units for Linux/Block */
737 block_lba
+= sg
->length
>> IBLOCK_LBA_SHIFT
;
741 iblock_submit_bios(&list
, rw
);
742 iblock_complete_cmd(cmd
);
746 while ((bio
= bio_list_pop(&list
)))
751 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
754 static sector_t
iblock_get_blocks(struct se_device
*dev
)
756 struct iblock_dev
*ib_dev
= IBLOCK_DEV(dev
);
757 struct block_device
*bd
= ib_dev
->ibd_bd
;
758 struct request_queue
*q
= bdev_get_queue(bd
);
760 return iblock_emulate_read_cap_with_block_size(dev
, bd
, q
);
763 static struct sbc_ops iblock_sbc_ops
= {
764 .execute_rw
= iblock_execute_rw
,
765 .execute_sync_cache
= iblock_execute_sync_cache
,
766 .execute_write_same
= iblock_execute_write_same
,
767 .execute_write_same_unmap
= iblock_execute_write_same_unmap
,
768 .execute_unmap
= iblock_execute_unmap
,
771 static sense_reason_t
772 iblock_parse_cdb(struct se_cmd
*cmd
)
774 return sbc_parse_cdb(cmd
, &iblock_sbc_ops
);
777 static struct se_subsystem_api iblock_template
= {
779 .inquiry_prod
= "IBLOCK",
780 .inquiry_rev
= IBLOCK_VERSION
,
781 .owner
= THIS_MODULE
,
782 .transport_type
= TRANSPORT_PLUGIN_VHBA_PDEV
,
783 .attach_hba
= iblock_attach_hba
,
784 .detach_hba
= iblock_detach_hba
,
785 .alloc_device
= iblock_alloc_device
,
786 .configure_device
= iblock_configure_device
,
787 .free_device
= iblock_free_device
,
788 .parse_cdb
= iblock_parse_cdb
,
789 .set_configfs_dev_params
= iblock_set_configfs_dev_params
,
790 .show_configfs_dev_params
= iblock_show_configfs_dev_params
,
791 .get_device_type
= sbc_get_device_type
,
792 .get_blocks
= iblock_get_blocks
,
795 static int __init
iblock_module_init(void)
797 return transport_subsystem_register(&iblock_template
);
800 static void iblock_module_exit(void)
802 transport_subsystem_release(&iblock_template
);
805 MODULE_DESCRIPTION("TCM IBLOCK subsystem plugin");
806 MODULE_AUTHOR("nab@Linux-iSCSI.org");
807 MODULE_LICENSE("GPL");
809 module_init(iblock_module_init
);
810 module_exit(iblock_module_exit
);