1 /*******************************************************************************
2 * Filename: target_core_file.c
4 * This file contains the Storage Engine <-> FILEIO transport specific functions
6 * Copyright (c) 2005 PyX Technologies, Inc.
7 * Copyright (c) 2005-2006 SBE, Inc. All Rights Reserved.
8 * Copyright (c) 2007-2010 Rising Tide Systems
9 * Copyright (c) 2008-2010 Linux-iSCSI.org
11 * Nicholas A. Bellinger <nab@kernel.org>
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.
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.
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.
27 ******************************************************************************/
29 #include <linux/string.h>
30 #include <linux/parser.h>
31 #include <linux/timer.h>
32 #include <linux/blkdev.h>
33 #include <linux/slab.h>
34 #include <linux/spinlock.h>
35 #include <linux/module.h>
36 #include <scsi/scsi.h>
37 #include <scsi/scsi_host.h>
39 #include <target/target_core_base.h>
40 #include <target/target_core_device.h>
41 #include <target/target_core_transport.h>
43 #include "target_core_file.h"
45 static struct se_subsystem_api fileio_template
;
47 /* fd_attach_hba(): (Part of se_subsystem_api_t template)
51 static int fd_attach_hba(struct se_hba
*hba
, u32 host_id
)
53 struct fd_host
*fd_host
;
55 fd_host
= kzalloc(sizeof(struct fd_host
), GFP_KERNEL
);
57 pr_err("Unable to allocate memory for struct fd_host\n");
61 fd_host
->fd_host_id
= host_id
;
63 hba
->hba_ptr
= fd_host
;
65 pr_debug("CORE_HBA[%d] - TCM FILEIO HBA Driver %s on Generic"
66 " Target Core Stack %s\n", hba
->hba_id
, FD_VERSION
,
67 TARGET_CORE_MOD_VERSION
);
68 pr_debug("CORE_HBA[%d] - Attached FILEIO HBA: %u to Generic"
70 hba
->hba_id
, fd_host
->fd_host_id
, FD_MAX_SECTORS
);
75 static void fd_detach_hba(struct se_hba
*hba
)
77 struct fd_host
*fd_host
= hba
->hba_ptr
;
79 pr_debug("CORE_HBA[%d] - Detached FILEIO HBA: %u from Generic"
80 " Target Core\n", hba
->hba_id
, fd_host
->fd_host_id
);
86 static void *fd_allocate_virtdevice(struct se_hba
*hba
, const char *name
)
88 struct fd_dev
*fd_dev
;
89 struct fd_host
*fd_host
= (struct fd_host
*) hba
->hba_ptr
;
91 fd_dev
= kzalloc(sizeof(struct fd_dev
), GFP_KERNEL
);
93 pr_err("Unable to allocate memory for struct fd_dev\n");
97 fd_dev
->fd_host
= fd_host
;
99 pr_debug("FILEIO: Allocated fd_dev for %p\n", name
);
104 /* fd_create_virtdevice(): (Part of se_subsystem_api_t template)
108 static struct se_device
*fd_create_virtdevice(
110 struct se_subsystem_dev
*se_dev
,
114 struct se_device
*dev
;
115 struct se_dev_limits dev_limits
;
116 struct queue_limits
*limits
;
117 struct fd_dev
*fd_dev
= (struct fd_dev
*) p
;
118 struct fd_host
*fd_host
= (struct fd_host
*) hba
->hba_ptr
;
121 struct inode
*inode
= NULL
;
122 int dev_flags
= 0, flags
, ret
= -EINVAL
;
124 memset(&dev_limits
, 0, sizeof(struct se_dev_limits
));
128 dev_p
= getname(fd_dev
->fd_dev_name
);
132 pr_err("getname(%s) failed: %lu\n",
133 fd_dev
->fd_dev_name
, IS_ERR(dev_p
));
134 ret
= PTR_ERR(dev_p
);
138 if (di
->no_create_file
)
139 flags
= O_RDWR
| O_LARGEFILE
;
141 flags
= O_RDWR
| O_CREAT
| O_LARGEFILE
;
143 flags
= O_RDWR
| O_CREAT
| O_LARGEFILE
;
145 /* flags |= O_DIRECT; */
147 * If fd_buffered_io=1 has not been set explicitly (the default),
148 * use O_SYNC to force FILEIO writes to disk.
150 if (!(fd_dev
->fbd_flags
& FDBD_USE_BUFFERED_IO
))
153 file
= filp_open(dev_p
, flags
, 0600);
155 pr_err("filp_open(%s) failed\n", dev_p
);
159 if (!file
|| !file
->f_dentry
) {
160 pr_err("filp_open(%s) failed\n", dev_p
);
163 fd_dev
->fd_file
= file
;
165 * If using a block backend with this struct file, we extract
166 * fd_dev->fd_[block,dev]_size from struct block_device.
168 * Otherwise, we use the passed fd_size= from configfs
170 inode
= file
->f_mapping
->host
;
171 if (S_ISBLK(inode
->i_mode
)) {
172 struct request_queue
*q
;
174 * Setup the local scope queue_limits from struct request_queue->limits
175 * to pass into transport_add_device_to_core_hba() as struct se_dev_limits.
177 q
= bdev_get_queue(inode
->i_bdev
);
178 limits
= &dev_limits
.limits
;
179 limits
->logical_block_size
= bdev_logical_block_size(inode
->i_bdev
);
180 limits
->max_hw_sectors
= queue_max_hw_sectors(q
);
181 limits
->max_sectors
= queue_max_sectors(q
);
183 * Determine the number of bytes from i_size_read() minus
184 * one (1) logical sector from underlying struct block_device
186 fd_dev
->fd_block_size
= bdev_logical_block_size(inode
->i_bdev
);
187 fd_dev
->fd_dev_size
= (i_size_read(file
->f_mapping
->host
) -
188 fd_dev
->fd_block_size
);
190 pr_debug("FILEIO: Using size: %llu bytes from struct"
191 " block_device blocks: %llu logical_block_size: %d\n",
193 div_u64(fd_dev
->fd_dev_size
, fd_dev
->fd_block_size
),
194 fd_dev
->fd_block_size
);
196 if (!(fd_dev
->fbd_flags
& FBDF_HAS_SIZE
)) {
197 pr_err("FILEIO: Missing fd_dev_size="
198 " parameter, and no backing struct"
203 limits
= &dev_limits
.limits
;
204 limits
->logical_block_size
= FD_BLOCKSIZE
;
205 limits
->max_hw_sectors
= FD_MAX_SECTORS
;
206 limits
->max_sectors
= FD_MAX_SECTORS
;
207 fd_dev
->fd_block_size
= FD_BLOCKSIZE
;
210 dev_limits
.hw_queue_depth
= FD_MAX_DEVICE_QUEUE_DEPTH
;
211 dev_limits
.queue_depth
= FD_DEVICE_QUEUE_DEPTH
;
213 dev
= transport_add_device_to_core_hba(hba
, &fileio_template
,
214 se_dev
, dev_flags
, fd_dev
,
215 &dev_limits
, "FILEIO", FD_VERSION
);
219 fd_dev
->fd_dev_id
= fd_host
->fd_host_dev_id_count
++;
220 fd_dev
->fd_queue_depth
= dev
->queue_depth
;
222 pr_debug("CORE_FILE[%u] - Added TCM FILEIO Device ID: %u at %s,"
223 " %llu total bytes\n", fd_host
->fd_host_id
, fd_dev
->fd_dev_id
,
224 fd_dev
->fd_dev_name
, fd_dev
->fd_dev_size
);
229 if (fd_dev
->fd_file
) {
230 filp_close(fd_dev
->fd_file
, NULL
);
231 fd_dev
->fd_file
= NULL
;
237 /* fd_free_device(): (Part of se_subsystem_api_t template)
241 static void fd_free_device(void *p
)
243 struct fd_dev
*fd_dev
= (struct fd_dev
*) p
;
245 if (fd_dev
->fd_file
) {
246 filp_close(fd_dev
->fd_file
, NULL
);
247 fd_dev
->fd_file
= NULL
;
253 static inline struct fd_request
*FILE_REQ(struct se_task
*task
)
255 return container_of(task
, struct fd_request
, fd_task
);
259 static struct se_task
*
260 fd_alloc_task(unsigned char *cdb
)
262 struct fd_request
*fd_req
;
264 fd_req
= kzalloc(sizeof(struct fd_request
), GFP_KERNEL
);
266 pr_err("Unable to allocate struct fd_request\n");
270 return &fd_req
->fd_task
;
273 static int fd_do_readv(struct se_task
*task
)
275 struct fd_request
*req
= FILE_REQ(task
);
276 struct se_device
*se_dev
= req
->fd_task
.task_se_cmd
->se_dev
;
277 struct fd_dev
*dev
= se_dev
->dev_ptr
;
278 struct file
*fd
= dev
->fd_file
;
279 struct scatterlist
*sg
= task
->task_sg
;
282 loff_t pos
= (task
->task_lba
*
283 se_dev
->se_sub_dev
->se_dev_attrib
.block_size
);
286 iov
= kzalloc(sizeof(struct iovec
) * task
->task_sg_nents
, GFP_KERNEL
);
288 pr_err("Unable to allocate fd_do_readv iov[]\n");
292 for_each_sg(task
->task_sg
, sg
, task
->task_sg_nents
, i
) {
293 iov
[i
].iov_len
= sg
->length
;
294 iov
[i
].iov_base
= sg_virt(sg
);
299 ret
= vfs_readv(fd
, &iov
[0], task
->task_sg_nents
, &pos
);
304 * Return zeros and GOOD status even if the READ did not return
305 * the expected virt_size for struct file w/o a backing struct
308 if (S_ISBLK(fd
->f_dentry
->d_inode
->i_mode
)) {
309 if (ret
< 0 || ret
!= task
->task_size
) {
310 pr_err("vfs_readv() returned %d,"
311 " expecting %d for S_ISBLK\n", ret
,
312 (int)task
->task_size
);
313 return (ret
< 0 ? ret
: -EINVAL
);
317 pr_err("vfs_readv() returned %d for non"
326 static int fd_do_writev(struct se_task
*task
)
328 struct fd_request
*req
= FILE_REQ(task
);
329 struct se_device
*se_dev
= req
->fd_task
.task_se_cmd
->se_dev
;
330 struct fd_dev
*dev
= se_dev
->dev_ptr
;
331 struct file
*fd
= dev
->fd_file
;
332 struct scatterlist
*sg
= task
->task_sg
;
335 loff_t pos
= (task
->task_lba
*
336 se_dev
->se_sub_dev
->se_dev_attrib
.block_size
);
339 iov
= kzalloc(sizeof(struct iovec
) * task
->task_sg_nents
, GFP_KERNEL
);
341 pr_err("Unable to allocate fd_do_writev iov[]\n");
345 for_each_sg(task
->task_sg
, sg
, task
->task_sg_nents
, i
) {
346 iov
[i
].iov_len
= sg
->length
;
347 iov
[i
].iov_base
= sg_virt(sg
);
352 ret
= vfs_writev(fd
, &iov
[0], task
->task_sg_nents
, &pos
);
357 if (ret
< 0 || ret
!= task
->task_size
) {
358 pr_err("vfs_writev() returned %d\n", ret
);
359 return (ret
< 0 ? ret
: -EINVAL
);
365 static void fd_emulate_sync_cache(struct se_task
*task
)
367 struct se_cmd
*cmd
= task
->task_se_cmd
;
368 struct se_device
*dev
= cmd
->se_dev
;
369 struct fd_dev
*fd_dev
= dev
->dev_ptr
;
370 int immed
= (cmd
->t_task_cdb
[1] & 0x2);
375 * If the Immediate bit is set, queue up the GOOD response
376 * for this SYNCHRONIZE_CACHE op
379 transport_complete_sync_cache(cmd
, 1);
382 * Determine if we will be flushing the entire device.
384 if (cmd
->t_task_lba
== 0 && cmd
->data_length
== 0) {
388 start
= cmd
->t_task_lba
* dev
->se_sub_dev
->se_dev_attrib
.block_size
;
389 if (cmd
->data_length
)
390 end
= start
+ cmd
->data_length
;
395 ret
= vfs_fsync_range(fd_dev
->fd_file
, start
, end
, 1);
397 pr_err("FILEIO: vfs_fsync_range() failed: %d\n", ret
);
400 transport_complete_sync_cache(cmd
, ret
== 0);
404 * WRITE Force Unit Access (FUA) emulation on a per struct se_task
407 static void fd_emulate_write_fua(struct se_cmd
*cmd
, struct se_task
*task
)
409 struct se_device
*dev
= cmd
->se_dev
;
410 struct fd_dev
*fd_dev
= dev
->dev_ptr
;
411 loff_t start
= task
->task_lba
* dev
->se_sub_dev
->se_dev_attrib
.block_size
;
412 loff_t end
= start
+ task
->task_size
;
415 pr_debug("FILEIO: FUA WRITE LBA: %llu, bytes: %u\n",
416 task
->task_lba
, task
->task_size
);
418 ret
= vfs_fsync_range(fd_dev
->fd_file
, start
, end
, 1);
420 pr_err("FILEIO: vfs_fsync_range() failed: %d\n", ret
);
423 static int fd_do_task(struct se_task
*task
)
425 struct se_cmd
*cmd
= task
->task_se_cmd
;
426 struct se_device
*dev
= cmd
->se_dev
;
430 * Call vectorized fileio functions to map struct scatterlist
431 * physical memory addresses to struct iovec virtual memory.
433 if (task
->task_data_direction
== DMA_FROM_DEVICE
) {
434 ret
= fd_do_readv(task
);
436 ret
= fd_do_writev(task
);
439 dev
->se_sub_dev
->se_dev_attrib
.emulate_write_cache
> 0 &&
440 dev
->se_sub_dev
->se_dev_attrib
.emulate_fua_write
> 0 &&
441 (cmd
->se_cmd_flags
& SCF_FUA
)) {
443 * We might need to be a bit smarter here
444 * and return some sense data to let the initiator
445 * know the FUA WRITE cache sync failed..?
447 fd_emulate_write_fua(cmd
, task
);
453 cmd
->scsi_sense_reason
= TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
457 task
->task_scsi_status
= GOOD
;
458 transport_complete_task(task
, 1);
463 /* fd_free_task(): (Part of se_subsystem_api_t template)
467 static void fd_free_task(struct se_task
*task
)
469 struct fd_request
*req
= FILE_REQ(task
);
475 Opt_fd_dev_name
, Opt_fd_dev_size
, Opt_fd_buffered_io
, Opt_err
478 static match_table_t tokens
= {
479 {Opt_fd_dev_name
, "fd_dev_name=%s"},
480 {Opt_fd_dev_size
, "fd_dev_size=%s"},
481 {Opt_fd_buffered_io
, "fd_buffered_io=%d"},
485 static ssize_t
fd_set_configfs_dev_params(
487 struct se_subsystem_dev
*se_dev
,
488 const char *page
, ssize_t count
)
490 struct fd_dev
*fd_dev
= se_dev
->se_dev_su_ptr
;
491 char *orig
, *ptr
, *arg_p
, *opts
;
492 substring_t args
[MAX_OPT_ARGS
];
493 int ret
= 0, arg
, token
;
495 opts
= kstrdup(page
, GFP_KERNEL
);
501 while ((ptr
= strsep(&opts
, ",")) != NULL
) {
505 token
= match_token(ptr
, tokens
, args
);
507 case Opt_fd_dev_name
:
508 arg_p
= match_strdup(&args
[0]);
513 snprintf(fd_dev
->fd_dev_name
, FD_MAX_DEV_NAME
,
516 pr_debug("FILEIO: Referencing Path: %s\n",
517 fd_dev
->fd_dev_name
);
518 fd_dev
->fbd_flags
|= FBDF_HAS_PATH
;
520 case Opt_fd_dev_size
:
521 arg_p
= match_strdup(&args
[0]);
526 ret
= strict_strtoull(arg_p
, 0, &fd_dev
->fd_dev_size
);
529 pr_err("strict_strtoull() failed for"
533 pr_debug("FILEIO: Referencing Size: %llu"
534 " bytes\n", fd_dev
->fd_dev_size
);
535 fd_dev
->fbd_flags
|= FBDF_HAS_SIZE
;
537 case Opt_fd_buffered_io
:
538 match_int(args
, &arg
);
540 pr_err("bogus fd_buffered_io=%d value\n", arg
);
545 pr_debug("FILEIO: Using buffered I/O"
546 " operations for struct fd_dev\n");
548 fd_dev
->fbd_flags
|= FDBD_USE_BUFFERED_IO
;
557 return (!ret
) ? count
: ret
;
560 static ssize_t
fd_check_configfs_dev_params(struct se_hba
*hba
, struct se_subsystem_dev
*se_dev
)
562 struct fd_dev
*fd_dev
= (struct fd_dev
*) se_dev
->se_dev_su_ptr
;
564 if (!(fd_dev
->fbd_flags
& FBDF_HAS_PATH
)) {
565 pr_err("Missing fd_dev_name=\n");
572 static ssize_t
fd_show_configfs_dev_params(
574 struct se_subsystem_dev
*se_dev
,
577 struct fd_dev
*fd_dev
= se_dev
->se_dev_su_ptr
;
580 bl
= sprintf(b
+ bl
, "TCM FILEIO ID: %u", fd_dev
->fd_dev_id
);
581 bl
+= sprintf(b
+ bl
, " File: %s Size: %llu Mode: %s\n",
582 fd_dev
->fd_dev_name
, fd_dev
->fd_dev_size
,
583 (fd_dev
->fbd_flags
& FDBD_USE_BUFFERED_IO
) ?
584 "Buffered" : "Synchronous");
588 /* fd_get_device_rev(): (Part of se_subsystem_api_t template)
592 static u32
fd_get_device_rev(struct se_device
*dev
)
594 return SCSI_SPC_2
; /* Returns SPC-3 in Initiator Data */
597 /* fd_get_device_type(): (Part of se_subsystem_api_t template)
601 static u32
fd_get_device_type(struct se_device
*dev
)
606 static sector_t
fd_get_blocks(struct se_device
*dev
)
608 struct fd_dev
*fd_dev
= dev
->dev_ptr
;
609 unsigned long long blocks_long
= div_u64(fd_dev
->fd_dev_size
,
610 dev
->se_sub_dev
->se_dev_attrib
.block_size
);
615 static struct se_subsystem_api fileio_template
= {
617 .owner
= THIS_MODULE
,
618 .transport_type
= TRANSPORT_PLUGIN_VHBA_PDEV
,
619 .write_cache_emulated
= 1,
620 .fua_write_emulated
= 1,
621 .attach_hba
= fd_attach_hba
,
622 .detach_hba
= fd_detach_hba
,
623 .allocate_virtdevice
= fd_allocate_virtdevice
,
624 .create_virtdevice
= fd_create_virtdevice
,
625 .free_device
= fd_free_device
,
626 .alloc_task
= fd_alloc_task
,
627 .do_task
= fd_do_task
,
628 .do_sync_cache
= fd_emulate_sync_cache
,
629 .free_task
= fd_free_task
,
630 .check_configfs_dev_params
= fd_check_configfs_dev_params
,
631 .set_configfs_dev_params
= fd_set_configfs_dev_params
,
632 .show_configfs_dev_params
= fd_show_configfs_dev_params
,
633 .get_device_rev
= fd_get_device_rev
,
634 .get_device_type
= fd_get_device_type
,
635 .get_blocks
= fd_get_blocks
,
638 static int __init
fileio_module_init(void)
640 return transport_subsystem_register(&fileio_template
);
643 static void fileio_module_exit(void)
645 transport_subsystem_release(&fileio_template
);
648 MODULE_DESCRIPTION("TCM FILEIO subsystem plugin");
649 MODULE_AUTHOR("nab@Linux-iSCSI.org");
650 MODULE_LICENSE("GPL");
652 module_init(fileio_module_init
);
653 module_exit(fileio_module_exit
);