1 /*******************************************************************************
2 * Filename: target_core_iblock.c
4 * This file contains the Storage Engine <-> Linux BlockIO transport
7 * (c) Copyright 2003-2013 Datera, Inc.
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 int iblock_attach_hba(struct se_hba *hba, u32 host_id)
58 pr_debug("CORE_HBA[%d] - TCM iBlock HBA Driver %s on"
59 " Generic Target Core Stack %s\n", hba->hba_id,
60 IBLOCK_VERSION, TARGET_CORE_MOD_VERSION);
64 static void iblock_detach_hba(struct se_hba *hba)
68 static struct se_device *iblock_alloc_device(struct se_hba *hba, const char *name)
70 struct iblock_dev *ib_dev = NULL;
72 ib_dev = kzalloc(sizeof(struct iblock_dev), GFP_KERNEL);
74 pr_err("Unable to allocate struct iblock_dev\n");
78 pr_debug( "IBLOCK: Allocated ib_dev for %s\n", name);
83 static int iblock_configure_device(struct se_device *dev)
85 struct iblock_dev *ib_dev = IBLOCK_DEV(dev);
86 struct request_queue *q;
87 struct block_device *bd = NULL;
88 struct blk_integrity *bi;
92 if (!(ib_dev->ibd_flags & IBDF_HAS_UDEV_PATH)) {
93 pr_err("Missing udev_path= parameters for IBLOCK\n");
97 ib_dev->ibd_bio_set = bioset_create(IBLOCK_BIO_POOL_SIZE, 0);
98 if (!ib_dev->ibd_bio_set) {
99 pr_err("IBLOCK: Unable to create bioset\n");
103 pr_debug( "IBLOCK: Claiming struct block_device: %s\n",
104 ib_dev->ibd_udev_path);
106 mode = FMODE_READ|FMODE_EXCL;
107 if (!ib_dev->ibd_readonly)
110 bd = blkdev_get_by_path(ib_dev->ibd_udev_path, mode, ib_dev);
113 goto out_free_bioset;
117 q = bdev_get_queue(bd);
119 dev->dev_attrib.hw_block_size = bdev_logical_block_size(bd);
120 dev->dev_attrib.hw_max_sectors = queue_max_hw_sectors(q);
121 dev->dev_attrib.hw_queue_depth = q->nr_requests;
124 * Check if the underlying struct block_device request_queue supports
125 * the QUEUE_FLAG_DISCARD bit for UNMAP/WRITE_SAME in SCSI + TRIM
126 * in ATA and we need to set TPE=1
128 if (blk_queue_discard(q)) {
129 dev->dev_attrib.max_unmap_lba_count =
130 q->limits.max_discard_sectors;
133 * Currently hardcoded to 1 in Linux/SCSI code..
135 dev->dev_attrib.max_unmap_block_desc_count = 1;
136 dev->dev_attrib.unmap_granularity =
137 q->limits.discard_granularity >> 9;
138 dev->dev_attrib.unmap_granularity_alignment =
139 q->limits.discard_alignment;
141 pr_debug("IBLOCK: BLOCK Discard support available,"
142 " disabled by default\n");
145 * Enable write same emulation for IBLOCK and use 0xFFFF as
146 * the smaller WRITE_SAME(10) only has a two-byte block count.
148 dev->dev_attrib.max_write_same_len = 0xFFFF;
150 if (blk_queue_nonrot(q))
151 dev->dev_attrib.is_nonrot = 1;
153 bi = bdev_get_integrity(bd);
155 struct bio_set *bs = ib_dev->ibd_bio_set;
157 if (!strcmp(bi->name, "T10-DIF-TYPE3-IP") ||
158 !strcmp(bi->name, "T10-DIF-TYPE1-IP")) {
159 pr_err("IBLOCK export of blk_integrity: %s not"
160 " supported\n", bi->name);
165 if (!strcmp(bi->name, "T10-DIF-TYPE3-CRC")) {
166 dev->dev_attrib.pi_prot_type = TARGET_DIF_TYPE3_PROT;
167 } else if (!strcmp(bi->name, "T10-DIF-TYPE1-CRC")) {
168 dev->dev_attrib.pi_prot_type = TARGET_DIF_TYPE1_PROT;
171 if (dev->dev_attrib.pi_prot_type) {
172 if (bioset_integrity_create(bs, IBLOCK_BIO_POOL_SIZE) < 0) {
173 pr_err("Unable to allocate bioset for PI\n");
177 pr_debug("IBLOCK setup BIP bs->bio_integrity_pool: %p\n",
178 bs->bio_integrity_pool);
180 dev->dev_attrib.hw_pi_prot_type = dev->dev_attrib.pi_prot_type;
186 blkdev_put(ib_dev->ibd_bd, FMODE_WRITE|FMODE_READ|FMODE_EXCL);
188 bioset_free(ib_dev->ibd_bio_set);
189 ib_dev->ibd_bio_set = NULL;
194 static void iblock_free_device(struct se_device *dev)
196 struct iblock_dev *ib_dev = IBLOCK_DEV(dev);
198 if (ib_dev->ibd_bd != NULL)
199 blkdev_put(ib_dev->ibd_bd, FMODE_WRITE|FMODE_READ|FMODE_EXCL);
200 if (ib_dev->ibd_bio_set != NULL)
201 bioset_free(ib_dev->ibd_bio_set);
206 static unsigned long long iblock_emulate_read_cap_with_block_size(
207 struct se_device *dev,
208 struct block_device *bd,
209 struct request_queue *q)
211 unsigned long long blocks_long = (div_u64(i_size_read(bd->bd_inode),
212 bdev_logical_block_size(bd)) - 1);
213 u32 block_size = bdev_logical_block_size(bd);
215 if (block_size == dev->dev_attrib.block_size)
218 switch (block_size) {
220 switch (dev->dev_attrib.block_size) {
234 switch (dev->dev_attrib.block_size) {
249 switch (dev->dev_attrib.block_size) {
264 switch (dev->dev_attrib.block_size) {
285 static void iblock_complete_cmd(struct se_cmd *cmd)
287 struct iblock_req *ibr = cmd->priv;
290 if (!atomic_dec_and_test(&ibr->pending))
293 if (atomic_read(&ibr->ib_bio_err_cnt))
294 status = SAM_STAT_CHECK_CONDITION;
296 status = SAM_STAT_GOOD;
298 target_complete_cmd(cmd, status);
302 static void iblock_bio_done(struct bio *bio, int err)
304 struct se_cmd *cmd = bio->bi_private;
305 struct iblock_req *ibr = cmd->priv;
308 * Set -EIO if !BIO_UPTODATE and the passed is still err=0
310 if (!test_bit(BIO_UPTODATE, &bio->bi_flags) && !err)
314 pr_err("test_bit(BIO_UPTODATE) failed for bio: %p,"
315 " err: %d\n", bio, err);
317 * Bump the ib_bio_err_cnt and release bio.
319 atomic_inc(&ibr->ib_bio_err_cnt);
320 smp_mb__after_atomic();
325 iblock_complete_cmd(cmd);
329 iblock_get_bio(struct se_cmd *cmd, sector_t lba, u32 sg_num)
331 struct iblock_dev *ib_dev = IBLOCK_DEV(cmd->se_dev);
335 * Only allocate as many vector entries as the bio code allows us to,
336 * we'll loop later on until we have handled the whole request.
338 if (sg_num > BIO_MAX_PAGES)
339 sg_num = BIO_MAX_PAGES;
341 bio = bio_alloc_bioset(GFP_NOIO, sg_num, ib_dev->ibd_bio_set);
343 pr_err("Unable to allocate memory for bio\n");
347 bio->bi_bdev = ib_dev->ibd_bd;
348 bio->bi_private = cmd;
349 bio->bi_end_io = &iblock_bio_done;
350 bio->bi_iter.bi_sector = lba;
355 static void iblock_submit_bios(struct bio_list *list, int rw)
357 struct blk_plug plug;
360 blk_start_plug(&plug);
361 while ((bio = bio_list_pop(list)))
363 blk_finish_plug(&plug);
366 static void iblock_end_io_flush(struct bio *bio, int err)
368 struct se_cmd *cmd = bio->bi_private;
371 pr_err("IBLOCK: cache flush failed: %d\n", err);
375 target_complete_cmd(cmd, SAM_STAT_CHECK_CONDITION);
377 target_complete_cmd(cmd, SAM_STAT_GOOD);
384 * Implement SYCHRONIZE CACHE. Note that we can't handle lba ranges and must
385 * always flush the whole cache.
387 static sense_reason_t
388 iblock_execute_sync_cache(struct se_cmd *cmd)
390 struct iblock_dev *ib_dev = IBLOCK_DEV(cmd->se_dev);
391 int immed = (cmd->t_task_cdb[1] & 0x2);
395 * If the Immediate bit is set, queue up the GOOD response
396 * for this SYNCHRONIZE_CACHE op.
399 target_complete_cmd(cmd, SAM_STAT_GOOD);
401 bio = bio_alloc(GFP_KERNEL, 0);
402 bio->bi_end_io = iblock_end_io_flush;
403 bio->bi_bdev = ib_dev->ibd_bd;
405 bio->bi_private = cmd;
406 submit_bio(WRITE_FLUSH, bio);
410 static sense_reason_t
411 iblock_do_unmap(struct se_cmd *cmd, void *priv,
412 sector_t lba, sector_t nolb)
414 struct block_device *bdev = priv;
417 ret = blkdev_issue_discard(bdev, lba, nolb, GFP_KERNEL, 0);
419 pr_err("blkdev_issue_discard() failed: %d\n", ret);
420 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
426 static sense_reason_t
427 iblock_execute_unmap(struct se_cmd *cmd)
429 struct block_device *bdev = IBLOCK_DEV(cmd->se_dev)->ibd_bd;
431 return sbc_execute_unmap(cmd, iblock_do_unmap, bdev);
434 static sense_reason_t
435 iblock_execute_write_same_unmap(struct se_cmd *cmd)
437 struct block_device *bdev = IBLOCK_DEV(cmd->se_dev)->ibd_bd;
438 sector_t lba = cmd->t_task_lba;
439 sector_t nolb = sbc_get_write_same_sectors(cmd);
442 ret = iblock_do_unmap(cmd, bdev, lba, nolb);
446 target_complete_cmd(cmd, GOOD);
450 static sense_reason_t
451 iblock_execute_write_same(struct se_cmd *cmd)
453 struct iblock_req *ibr;
454 struct scatterlist *sg;
456 struct bio_list list;
457 sector_t block_lba = cmd->t_task_lba;
458 sector_t sectors = sbc_get_write_same_sectors(cmd);
461 pr_err("WRITE_SAME: Protection information with IBLOCK"
462 " backends not supported\n");
463 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
465 sg = &cmd->t_data_sg[0];
467 if (cmd->t_data_nents > 1 ||
468 sg->length != cmd->se_dev->dev_attrib.block_size) {
469 pr_err("WRITE_SAME: Illegal SGL t_data_nents: %u length: %u"
470 " block_size: %u\n", cmd->t_data_nents, sg->length,
471 cmd->se_dev->dev_attrib.block_size);
472 return TCM_INVALID_CDB_FIELD;
475 ibr = kzalloc(sizeof(struct iblock_req), GFP_KERNEL);
480 bio = iblock_get_bio(cmd, block_lba, 1);
484 bio_list_init(&list);
485 bio_list_add(&list, bio);
487 atomic_set(&ibr->pending, 1);
490 while (bio_add_page(bio, sg_page(sg), sg->length, sg->offset)
493 bio = iblock_get_bio(cmd, block_lba, 1);
497 atomic_inc(&ibr->pending);
498 bio_list_add(&list, bio);
501 /* Always in 512 byte units for Linux/Block */
502 block_lba += sg->length >> IBLOCK_LBA_SHIFT;
506 iblock_submit_bios(&list, WRITE);
510 while ((bio = bio_list_pop(&list)))
515 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
519 Opt_udev_path, Opt_readonly, Opt_force, Opt_err
522 static match_table_t tokens = {
523 {Opt_udev_path, "udev_path=%s"},
524 {Opt_readonly, "readonly=%d"},
525 {Opt_force, "force=%d"},
529 static ssize_t iblock_set_configfs_dev_params(struct se_device *dev,
530 const char *page, ssize_t count)
532 struct iblock_dev *ib_dev = IBLOCK_DEV(dev);
533 char *orig, *ptr, *arg_p, *opts;
534 substring_t args[MAX_OPT_ARGS];
536 unsigned long tmp_readonly;
538 opts = kstrdup(page, GFP_KERNEL);
544 while ((ptr = strsep(&opts, ",\n")) != NULL) {
548 token = match_token(ptr, tokens, args);
551 if (ib_dev->ibd_bd) {
552 pr_err("Unable to set udev_path= while"
553 " ib_dev->ibd_bd exists\n");
557 if (match_strlcpy(ib_dev->ibd_udev_path, &args[0],
558 SE_UDEV_PATH_LEN) == 0) {
562 pr_debug("IBLOCK: Referencing UDEV path: %s\n",
563 ib_dev->ibd_udev_path);
564 ib_dev->ibd_flags |= IBDF_HAS_UDEV_PATH;
567 arg_p = match_strdup(&args[0]);
572 ret = kstrtoul(arg_p, 0, &tmp_readonly);
575 pr_err("kstrtoul() failed for"
579 ib_dev->ibd_readonly = tmp_readonly;
580 pr_debug("IBLOCK: readonly: %d\n", ib_dev->ibd_readonly);
591 return (!ret) ? count : ret;
594 static ssize_t iblock_show_configfs_dev_params(struct se_device *dev, char *b)
596 struct iblock_dev *ib_dev = IBLOCK_DEV(dev);
597 struct block_device *bd = ib_dev->ibd_bd;
598 char buf[BDEVNAME_SIZE];
602 bl += sprintf(b + bl, "iBlock device: %s",
604 if (ib_dev->ibd_flags & IBDF_HAS_UDEV_PATH)
605 bl += sprintf(b + bl, " UDEV PATH: %s",
606 ib_dev->ibd_udev_path);
607 bl += sprintf(b + bl, " readonly: %d\n", ib_dev->ibd_readonly);
609 bl += sprintf(b + bl, " ");
611 bl += sprintf(b + bl, "Major: %d Minor: %d %s\n",
612 MAJOR(bd->bd_dev), MINOR(bd->bd_dev), (!bd->bd_contains) ?
613 "" : (bd->bd_holder == ib_dev) ?
614 "CLAIMED: IBLOCK" : "CLAIMED: OS");
616 bl += sprintf(b + bl, "Major: 0 Minor: 0\n");
623 iblock_alloc_bip(struct se_cmd *cmd, struct bio *bio)
625 struct se_device *dev = cmd->se_dev;
626 struct blk_integrity *bi;
627 struct bio_integrity_payload *bip;
628 struct iblock_dev *ib_dev = IBLOCK_DEV(dev);
629 struct scatterlist *sg;
632 bi = bdev_get_integrity(ib_dev->ibd_bd);
634 pr_err("Unable to locate bio_integrity\n");
638 bip = bio_integrity_alloc(bio, GFP_NOIO, cmd->t_prot_nents);
640 pr_err("Unable to allocate bio_integrity_payload\n");
644 bip->bip_iter.bi_size = (cmd->data_length / dev->dev_attrib.block_size) *
646 bip->bip_iter.bi_sector = bio->bi_iter.bi_sector;
648 pr_debug("IBLOCK BIP Size: %u Sector: %llu\n", bip->bip_iter.bi_size,
649 (unsigned long long)bip->bip_iter.bi_sector);
651 for_each_sg(cmd->t_prot_sg, sg, cmd->t_prot_nents, i) {
653 rc = bio_integrity_add_page(bio, sg_page(sg), sg->length,
655 if (rc != sg->length) {
656 pr_err("bio_integrity_add_page() failed; %d\n", rc);
660 pr_debug("Added bio integrity page: %p length: %d offset; %d\n",
661 sg_page(sg), sg->length, sg->offset);
667 static sense_reason_t
668 iblock_execute_rw(struct se_cmd *cmd, struct scatterlist *sgl, u32 sgl_nents,
669 enum dma_data_direction data_direction)
671 struct se_device *dev = cmd->se_dev;
672 struct iblock_req *ibr;
673 struct bio *bio, *bio_start;
674 struct bio_list list;
675 struct scatterlist *sg;
676 u32 sg_num = sgl_nents;
682 if (data_direction == DMA_TO_DEVICE) {
683 struct iblock_dev *ib_dev = IBLOCK_DEV(dev);
684 struct request_queue *q = bdev_get_queue(ib_dev->ibd_bd);
686 * Force writethrough using WRITE_FUA if a volatile write cache
687 * is not enabled, or if initiator set the Force Unit Access bit.
689 if (q->flush_flags & REQ_FUA) {
690 if (cmd->se_cmd_flags & SCF_FUA)
692 else if (!(q->flush_flags & REQ_FLUSH))
704 * Convert the blocksize advertised to the initiator to the 512 byte
705 * units unconditionally used by the Linux block layer.
707 if (dev->dev_attrib.block_size == 4096)
708 block_lba = (cmd->t_task_lba << 3);
709 else if (dev->dev_attrib.block_size == 2048)
710 block_lba = (cmd->t_task_lba << 2);
711 else if (dev->dev_attrib.block_size == 1024)
712 block_lba = (cmd->t_task_lba << 1);
713 else if (dev->dev_attrib.block_size == 512)
714 block_lba = cmd->t_task_lba;
716 pr_err("Unsupported SCSI -> BLOCK LBA conversion:"
717 " %u\n", dev->dev_attrib.block_size);
718 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
721 ibr = kzalloc(sizeof(struct iblock_req), GFP_KERNEL);
727 atomic_set(&ibr->pending, 1);
728 iblock_complete_cmd(cmd);
732 bio = iblock_get_bio(cmd, block_lba, sgl_nents);
737 bio_list_init(&list);
738 bio_list_add(&list, bio);
740 atomic_set(&ibr->pending, 2);
743 for_each_sg(sgl, sg, sgl_nents, i) {
745 * XXX: if the length the device accepts is shorter than the
746 * length of the S/G list entry this will cause and
747 * endless loop. Better hope no driver uses huge pages.
749 while (bio_add_page(bio, sg_page(sg), sg->length, sg->offset)
751 if (bio_cnt >= IBLOCK_MAX_BIO_PER_TASK) {
752 iblock_submit_bios(&list, rw);
756 bio = iblock_get_bio(cmd, block_lba, sg_num);
760 atomic_inc(&ibr->pending);
761 bio_list_add(&list, bio);
765 /* Always in 512 byte units for Linux/Block */
766 block_lba += sg->length >> IBLOCK_LBA_SHIFT;
770 if (cmd->prot_type && dev->dev_attrib.pi_prot_type) {
771 int rc = iblock_alloc_bip(cmd, bio_start);
776 iblock_submit_bios(&list, rw);
777 iblock_complete_cmd(cmd);
781 while ((bio = bio_list_pop(&list)))
786 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
789 static sector_t iblock_get_blocks(struct se_device *dev)
791 struct iblock_dev *ib_dev = IBLOCK_DEV(dev);
792 struct block_device *bd = ib_dev->ibd_bd;
793 struct request_queue *q = bdev_get_queue(bd);
795 return iblock_emulate_read_cap_with_block_size(dev, bd, q);
798 static sector_t iblock_get_alignment_offset_lbas(struct se_device *dev)
800 struct iblock_dev *ib_dev = IBLOCK_DEV(dev);
801 struct block_device *bd = ib_dev->ibd_bd;
804 ret = bdev_alignment_offset(bd);
808 /* convert offset-bytes to offset-lbas */
809 return ret / bdev_logical_block_size(bd);
812 static unsigned int iblock_get_lbppbe(struct se_device *dev)
814 struct iblock_dev *ib_dev = IBLOCK_DEV(dev);
815 struct block_device *bd = ib_dev->ibd_bd;
816 int logs_per_phys = bdev_physical_block_size(bd) / bdev_logical_block_size(bd);
818 return ilog2(logs_per_phys);
821 static unsigned int iblock_get_io_min(struct se_device *dev)
823 struct iblock_dev *ib_dev = IBLOCK_DEV(dev);
824 struct block_device *bd = ib_dev->ibd_bd;
826 return bdev_io_min(bd);
829 static unsigned int iblock_get_io_opt(struct se_device *dev)
831 struct iblock_dev *ib_dev = IBLOCK_DEV(dev);
832 struct block_device *bd = ib_dev->ibd_bd;
834 return bdev_io_opt(bd);
837 static struct sbc_ops iblock_sbc_ops = {
838 .execute_rw = iblock_execute_rw,
839 .execute_sync_cache = iblock_execute_sync_cache,
840 .execute_write_same = iblock_execute_write_same,
841 .execute_write_same_unmap = iblock_execute_write_same_unmap,
842 .execute_unmap = iblock_execute_unmap,
845 static sense_reason_t
846 iblock_parse_cdb(struct se_cmd *cmd)
848 return sbc_parse_cdb(cmd, &iblock_sbc_ops);
851 static bool iblock_get_write_cache(struct se_device *dev)
853 struct iblock_dev *ib_dev = IBLOCK_DEV(dev);
854 struct block_device *bd = ib_dev->ibd_bd;
855 struct request_queue *q = bdev_get_queue(bd);
857 return q->flush_flags & REQ_FLUSH;
860 static const struct target_backend_ops iblock_ops = {
862 .inquiry_prod = "IBLOCK",
863 .inquiry_rev = IBLOCK_VERSION,
864 .owner = THIS_MODULE,
865 .attach_hba = iblock_attach_hba,
866 .detach_hba = iblock_detach_hba,
867 .alloc_device = iblock_alloc_device,
868 .configure_device = iblock_configure_device,
869 .free_device = iblock_free_device,
870 .parse_cdb = iblock_parse_cdb,
871 .set_configfs_dev_params = iblock_set_configfs_dev_params,
872 .show_configfs_dev_params = iblock_show_configfs_dev_params,
873 .get_device_type = sbc_get_device_type,
874 .get_blocks = iblock_get_blocks,
875 .get_alignment_offset_lbas = iblock_get_alignment_offset_lbas,
876 .get_lbppbe = iblock_get_lbppbe,
877 .get_io_min = iblock_get_io_min,
878 .get_io_opt = iblock_get_io_opt,
879 .get_write_cache = iblock_get_write_cache,
880 .tb_dev_attrib_attrs = sbc_attrib_attrs,
883 static int __init iblock_module_init(void)
885 return transport_backend_register(&iblock_ops);
888 static void __exit iblock_module_exit(void)
890 target_backend_unregister(&iblock_ops);
893 MODULE_DESCRIPTION("TCM IBLOCK subsystem plugin");
894 MODULE_AUTHOR("nab@Linux-iSCSI.org");
895 MODULE_LICENSE("GPL");
897 module_init(iblock_module_init);
898 module_exit(iblock_module_exit);