1c66ac9dbSNicholas Bellinger /******************************************************************************* 2c66ac9dbSNicholas Bellinger * Filename: target_core_file.c 3c66ac9dbSNicholas Bellinger * 4c66ac9dbSNicholas Bellinger * This file contains the Storage Engine <-> FILEIO transport specific functions 5c66ac9dbSNicholas Bellinger * 6c66ac9dbSNicholas Bellinger * Copyright (c) 2005 PyX Technologies, Inc. 7c66ac9dbSNicholas Bellinger * Copyright (c) 2005-2006 SBE, Inc. All Rights Reserved. 8c66ac9dbSNicholas Bellinger * Copyright (c) 2007-2010 Rising Tide Systems 9c66ac9dbSNicholas Bellinger * Copyright (c) 2008-2010 Linux-iSCSI.org 10c66ac9dbSNicholas Bellinger * 11c66ac9dbSNicholas Bellinger * Nicholas A. Bellinger <nab@kernel.org> 12c66ac9dbSNicholas Bellinger * 13c66ac9dbSNicholas Bellinger * This program is free software; you can redistribute it and/or modify 14c66ac9dbSNicholas Bellinger * it under the terms of the GNU General Public License as published by 15c66ac9dbSNicholas Bellinger * the Free Software Foundation; either version 2 of the License, or 16c66ac9dbSNicholas Bellinger * (at your option) any later version. 17c66ac9dbSNicholas Bellinger * 18c66ac9dbSNicholas Bellinger * This program is distributed in the hope that it will be useful, 19c66ac9dbSNicholas Bellinger * but WITHOUT ANY WARRANTY; without even the implied warranty of 20c66ac9dbSNicholas Bellinger * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 21c66ac9dbSNicholas Bellinger * GNU General Public License for more details. 22c66ac9dbSNicholas Bellinger * 23c66ac9dbSNicholas Bellinger * You should have received a copy of the GNU General Public License 24c66ac9dbSNicholas Bellinger * along with this program; if not, write to the Free Software 25c66ac9dbSNicholas Bellinger * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. 26c66ac9dbSNicholas Bellinger * 27c66ac9dbSNicholas Bellinger ******************************************************************************/ 28c66ac9dbSNicholas Bellinger 29c66ac9dbSNicholas Bellinger #include <linux/string.h> 30c66ac9dbSNicholas Bellinger #include <linux/parser.h> 31c66ac9dbSNicholas Bellinger #include <linux/timer.h> 32c66ac9dbSNicholas Bellinger #include <linux/blkdev.h> 33c66ac9dbSNicholas Bellinger #include <linux/slab.h> 34c66ac9dbSNicholas Bellinger #include <linux/spinlock.h> 35827509e3SPaul Gortmaker #include <linux/module.h> 36c66ac9dbSNicholas Bellinger #include <scsi/scsi.h> 37c66ac9dbSNicholas Bellinger #include <scsi/scsi_host.h> 38c66ac9dbSNicholas Bellinger 39c66ac9dbSNicholas Bellinger #include <target/target_core_base.h> 40c4795fb2SChristoph Hellwig #include <target/target_core_backend.h> 41c66ac9dbSNicholas Bellinger 42c66ac9dbSNicholas Bellinger #include "target_core_file.h" 43c66ac9dbSNicholas Bellinger 44c66ac9dbSNicholas Bellinger static struct se_subsystem_api fileio_template; 45c66ac9dbSNicholas Bellinger 46c66ac9dbSNicholas Bellinger /* fd_attach_hba(): (Part of se_subsystem_api_t template) 47c66ac9dbSNicholas Bellinger * 48c66ac9dbSNicholas Bellinger * 49c66ac9dbSNicholas Bellinger */ 50c66ac9dbSNicholas Bellinger static int fd_attach_hba(struct se_hba *hba, u32 host_id) 51c66ac9dbSNicholas Bellinger { 52c66ac9dbSNicholas Bellinger struct fd_host *fd_host; 53c66ac9dbSNicholas Bellinger 54c66ac9dbSNicholas Bellinger fd_host = kzalloc(sizeof(struct fd_host), GFP_KERNEL); 556708bb27SAndy Grover if (!fd_host) { 566708bb27SAndy Grover pr_err("Unable to allocate memory for struct fd_host\n"); 57e3d6f909SAndy Grover return -ENOMEM; 58c66ac9dbSNicholas Bellinger } 59c66ac9dbSNicholas Bellinger 60c66ac9dbSNicholas Bellinger fd_host->fd_host_id = host_id; 61c66ac9dbSNicholas Bellinger 62e3d6f909SAndy Grover hba->hba_ptr = fd_host; 63c66ac9dbSNicholas Bellinger 646708bb27SAndy Grover pr_debug("CORE_HBA[%d] - TCM FILEIO HBA Driver %s on Generic" 65c66ac9dbSNicholas Bellinger " Target Core Stack %s\n", hba->hba_id, FD_VERSION, 66c66ac9dbSNicholas Bellinger TARGET_CORE_MOD_VERSION); 676708bb27SAndy Grover pr_debug("CORE_HBA[%d] - Attached FILEIO HBA: %u to Generic" 68e3d6f909SAndy Grover " MaxSectors: %u\n", 69e3d6f909SAndy Grover hba->hba_id, fd_host->fd_host_id, FD_MAX_SECTORS); 70c66ac9dbSNicholas Bellinger 71c66ac9dbSNicholas Bellinger return 0; 72c66ac9dbSNicholas Bellinger } 73c66ac9dbSNicholas Bellinger 74c66ac9dbSNicholas Bellinger static void fd_detach_hba(struct se_hba *hba) 75c66ac9dbSNicholas Bellinger { 76c66ac9dbSNicholas Bellinger struct fd_host *fd_host = hba->hba_ptr; 77c66ac9dbSNicholas Bellinger 786708bb27SAndy Grover pr_debug("CORE_HBA[%d] - Detached FILEIO HBA: %u from Generic" 79c66ac9dbSNicholas Bellinger " Target Core\n", hba->hba_id, fd_host->fd_host_id); 80c66ac9dbSNicholas Bellinger 81c66ac9dbSNicholas Bellinger kfree(fd_host); 82c66ac9dbSNicholas Bellinger hba->hba_ptr = NULL; 83c66ac9dbSNicholas Bellinger } 84c66ac9dbSNicholas Bellinger 85c66ac9dbSNicholas Bellinger static void *fd_allocate_virtdevice(struct se_hba *hba, const char *name) 86c66ac9dbSNicholas Bellinger { 87c66ac9dbSNicholas Bellinger struct fd_dev *fd_dev; 888359cf43SJörn Engel struct fd_host *fd_host = hba->hba_ptr; 89c66ac9dbSNicholas Bellinger 90c66ac9dbSNicholas Bellinger fd_dev = kzalloc(sizeof(struct fd_dev), GFP_KERNEL); 916708bb27SAndy Grover if (!fd_dev) { 926708bb27SAndy Grover pr_err("Unable to allocate memory for struct fd_dev\n"); 93c66ac9dbSNicholas Bellinger return NULL; 94c66ac9dbSNicholas Bellinger } 95c66ac9dbSNicholas Bellinger 96c66ac9dbSNicholas Bellinger fd_dev->fd_host = fd_host; 97c66ac9dbSNicholas Bellinger 986708bb27SAndy Grover pr_debug("FILEIO: Allocated fd_dev for %p\n", name); 99c66ac9dbSNicholas Bellinger 100c66ac9dbSNicholas Bellinger return fd_dev; 101c66ac9dbSNicholas Bellinger } 102c66ac9dbSNicholas Bellinger 103c66ac9dbSNicholas Bellinger /* fd_create_virtdevice(): (Part of se_subsystem_api_t template) 104c66ac9dbSNicholas Bellinger * 105c66ac9dbSNicholas Bellinger * 106c66ac9dbSNicholas Bellinger */ 107c66ac9dbSNicholas Bellinger static struct se_device *fd_create_virtdevice( 108c66ac9dbSNicholas Bellinger struct se_hba *hba, 109c66ac9dbSNicholas Bellinger struct se_subsystem_dev *se_dev, 110c66ac9dbSNicholas Bellinger void *p) 111c66ac9dbSNicholas Bellinger { 112c66ac9dbSNicholas Bellinger struct se_device *dev; 113c66ac9dbSNicholas Bellinger struct se_dev_limits dev_limits; 114c66ac9dbSNicholas Bellinger struct queue_limits *limits; 1158359cf43SJörn Engel struct fd_dev *fd_dev = p; 1168359cf43SJörn Engel struct fd_host *fd_host = hba->hba_ptr; 117c66ac9dbSNicholas Bellinger struct file *file; 118c66ac9dbSNicholas Bellinger struct inode *inode = NULL; 119613640e4SNicholas Bellinger int dev_flags = 0, flags, ret = -EINVAL; 120c66ac9dbSNicholas Bellinger 121c66ac9dbSNicholas Bellinger memset(&dev_limits, 0, sizeof(struct se_dev_limits)); 122c66ac9dbSNicholas Bellinger 123c66ac9dbSNicholas Bellinger /* 124a4dff304SNicholas Bellinger * Use O_DSYNC by default instead of O_SYNC to forgo syncing 125a4dff304SNicholas Bellinger * of pure timestamp updates. 126c66ac9dbSNicholas Bellinger */ 127a4dff304SNicholas Bellinger flags = O_RDWR | O_CREAT | O_LARGEFILE | O_DSYNC; 128b32f4c7eSNicholas Bellinger /* 129b32f4c7eSNicholas Bellinger * Optionally allow fd_buffered_io=1 to be enabled for people 130b32f4c7eSNicholas Bellinger * who want use the fs buffer cache as an WriteCache mechanism. 131b32f4c7eSNicholas Bellinger * 132b32f4c7eSNicholas Bellinger * This means that in event of a hard failure, there is a risk 133b32f4c7eSNicholas Bellinger * of silent data-loss if the SCSI client has *not* performed a 134b32f4c7eSNicholas Bellinger * forced unit access (FUA) write, or issued SYNCHRONIZE_CACHE 135b32f4c7eSNicholas Bellinger * to write-out the entire device cache. 136b32f4c7eSNicholas Bellinger */ 137b32f4c7eSNicholas Bellinger if (fd_dev->fbd_flags & FDBD_HAS_BUFFERED_IO_WCE) { 138b32f4c7eSNicholas Bellinger pr_debug("FILEIO: Disabling O_DSYNC, using buffered FILEIO\n"); 139b32f4c7eSNicholas Bellinger flags &= ~O_DSYNC; 140b32f4c7eSNicholas Bellinger } 141c66ac9dbSNicholas Bellinger 142dbc6e022SAl Viro file = filp_open(fd_dev->fd_dev_name, flags, 0600); 143613640e4SNicholas Bellinger if (IS_ERR(file)) { 144dbc6e022SAl Viro pr_err("filp_open(%s) failed\n", fd_dev->fd_dev_name); 145613640e4SNicholas Bellinger ret = PTR_ERR(file); 146613640e4SNicholas Bellinger goto fail; 147613640e4SNicholas Bellinger } 148c66ac9dbSNicholas Bellinger fd_dev->fd_file = file; 149c66ac9dbSNicholas Bellinger /* 150c66ac9dbSNicholas Bellinger * If using a block backend with this struct file, we extract 151c66ac9dbSNicholas Bellinger * fd_dev->fd_[block,dev]_size from struct block_device. 152c66ac9dbSNicholas Bellinger * 153c66ac9dbSNicholas Bellinger * Otherwise, we use the passed fd_size= from configfs 154c66ac9dbSNicholas Bellinger */ 155c66ac9dbSNicholas Bellinger inode = file->f_mapping->host; 156c66ac9dbSNicholas Bellinger if (S_ISBLK(inode->i_mode)) { 157c66ac9dbSNicholas Bellinger struct request_queue *q; 158cd9323fdSNicholas Bellinger unsigned long long dev_size; 159c66ac9dbSNicholas Bellinger /* 160c66ac9dbSNicholas Bellinger * Setup the local scope queue_limits from struct request_queue->limits 161c66ac9dbSNicholas Bellinger * to pass into transport_add_device_to_core_hba() as struct se_dev_limits. 162c66ac9dbSNicholas Bellinger */ 163c66ac9dbSNicholas Bellinger q = bdev_get_queue(inode->i_bdev); 164c66ac9dbSNicholas Bellinger limits = &dev_limits.limits; 165c66ac9dbSNicholas Bellinger limits->logical_block_size = bdev_logical_block_size(inode->i_bdev); 166c66ac9dbSNicholas Bellinger limits->max_hw_sectors = queue_max_hw_sectors(q); 167c66ac9dbSNicholas Bellinger limits->max_sectors = queue_max_sectors(q); 168c66ac9dbSNicholas Bellinger /* 169c66ac9dbSNicholas Bellinger * Determine the number of bytes from i_size_read() minus 170c66ac9dbSNicholas Bellinger * one (1) logical sector from underlying struct block_device 171c66ac9dbSNicholas Bellinger */ 172c66ac9dbSNicholas Bellinger fd_dev->fd_block_size = bdev_logical_block_size(inode->i_bdev); 173cd9323fdSNicholas Bellinger dev_size = (i_size_read(file->f_mapping->host) - 174c66ac9dbSNicholas Bellinger fd_dev->fd_block_size); 175c66ac9dbSNicholas Bellinger 1766708bb27SAndy Grover pr_debug("FILEIO: Using size: %llu bytes from struct" 177c66ac9dbSNicholas Bellinger " block_device blocks: %llu logical_block_size: %d\n", 178cd9323fdSNicholas Bellinger dev_size, div_u64(dev_size, fd_dev->fd_block_size), 179c66ac9dbSNicholas Bellinger fd_dev->fd_block_size); 180c66ac9dbSNicholas Bellinger } else { 181c66ac9dbSNicholas Bellinger if (!(fd_dev->fbd_flags & FBDF_HAS_SIZE)) { 1826708bb27SAndy Grover pr_err("FILEIO: Missing fd_dev_size=" 183c66ac9dbSNicholas Bellinger " parameter, and no backing struct" 184c66ac9dbSNicholas Bellinger " block_device\n"); 185c66ac9dbSNicholas Bellinger goto fail; 186c66ac9dbSNicholas Bellinger } 187c66ac9dbSNicholas Bellinger 188c66ac9dbSNicholas Bellinger limits = &dev_limits.limits; 189c66ac9dbSNicholas Bellinger limits->logical_block_size = FD_BLOCKSIZE; 190c66ac9dbSNicholas Bellinger limits->max_hw_sectors = FD_MAX_SECTORS; 191c66ac9dbSNicholas Bellinger limits->max_sectors = FD_MAX_SECTORS; 192c66ac9dbSNicholas Bellinger fd_dev->fd_block_size = FD_BLOCKSIZE; 193c66ac9dbSNicholas Bellinger } 194c66ac9dbSNicholas Bellinger 195c66ac9dbSNicholas Bellinger dev_limits.hw_queue_depth = FD_MAX_DEVICE_QUEUE_DEPTH; 196c66ac9dbSNicholas Bellinger dev_limits.queue_depth = FD_DEVICE_QUEUE_DEPTH; 197c66ac9dbSNicholas Bellinger 198c66ac9dbSNicholas Bellinger dev = transport_add_device_to_core_hba(hba, &fileio_template, 1995951146dSAndy Grover se_dev, dev_flags, fd_dev, 200c66ac9dbSNicholas Bellinger &dev_limits, "FILEIO", FD_VERSION); 2016708bb27SAndy Grover if (!dev) 202c66ac9dbSNicholas Bellinger goto fail; 203c66ac9dbSNicholas Bellinger 204b32f4c7eSNicholas Bellinger if (fd_dev->fbd_flags & FDBD_HAS_BUFFERED_IO_WCE) { 205b32f4c7eSNicholas Bellinger pr_debug("FILEIO: Forcing setting of emulate_write_cache=1" 206b32f4c7eSNicholas Bellinger " with FDBD_HAS_BUFFERED_IO_WCE\n"); 207b32f4c7eSNicholas Bellinger dev->se_sub_dev->se_dev_attrib.emulate_write_cache = 1; 208b32f4c7eSNicholas Bellinger } 209b32f4c7eSNicholas Bellinger 210c66ac9dbSNicholas Bellinger fd_dev->fd_dev_id = fd_host->fd_host_dev_id_count++; 211c66ac9dbSNicholas Bellinger fd_dev->fd_queue_depth = dev->queue_depth; 212c66ac9dbSNicholas Bellinger 2136708bb27SAndy Grover pr_debug("CORE_FILE[%u] - Added TCM FILEIO Device ID: %u at %s," 214c66ac9dbSNicholas Bellinger " %llu total bytes\n", fd_host->fd_host_id, fd_dev->fd_dev_id, 215c66ac9dbSNicholas Bellinger fd_dev->fd_dev_name, fd_dev->fd_dev_size); 216c66ac9dbSNicholas Bellinger 217c66ac9dbSNicholas Bellinger return dev; 218c66ac9dbSNicholas Bellinger fail: 219c66ac9dbSNicholas Bellinger if (fd_dev->fd_file) { 220c66ac9dbSNicholas Bellinger filp_close(fd_dev->fd_file, NULL); 221c66ac9dbSNicholas Bellinger fd_dev->fd_file = NULL; 222c66ac9dbSNicholas Bellinger } 223613640e4SNicholas Bellinger return ERR_PTR(ret); 224c66ac9dbSNicholas Bellinger } 225c66ac9dbSNicholas Bellinger 226c66ac9dbSNicholas Bellinger /* fd_free_device(): (Part of se_subsystem_api_t template) 227c66ac9dbSNicholas Bellinger * 228c66ac9dbSNicholas Bellinger * 229c66ac9dbSNicholas Bellinger */ 230c66ac9dbSNicholas Bellinger static void fd_free_device(void *p) 231c66ac9dbSNicholas Bellinger { 2328359cf43SJörn Engel struct fd_dev *fd_dev = p; 233c66ac9dbSNicholas Bellinger 234c66ac9dbSNicholas Bellinger if (fd_dev->fd_file) { 235c66ac9dbSNicholas Bellinger filp_close(fd_dev->fd_file, NULL); 236c66ac9dbSNicholas Bellinger fd_dev->fd_file = NULL; 237c66ac9dbSNicholas Bellinger } 238c66ac9dbSNicholas Bellinger 239c66ac9dbSNicholas Bellinger kfree(fd_dev); 240c66ac9dbSNicholas Bellinger } 241c66ac9dbSNicholas Bellinger 2425787cacdSChristoph Hellwig static int fd_do_readv(struct se_cmd *cmd, struct scatterlist *sgl, 2435787cacdSChristoph Hellwig u32 sgl_nents) 244c66ac9dbSNicholas Bellinger { 2455787cacdSChristoph Hellwig struct se_device *se_dev = cmd->se_dev; 24642bf829eSChristoph Hellwig struct fd_dev *dev = se_dev->dev_ptr; 2476708bb27SAndy Grover struct file *fd = dev->fd_file; 2485787cacdSChristoph Hellwig struct scatterlist *sg; 249c66ac9dbSNicholas Bellinger struct iovec *iov; 250c66ac9dbSNicholas Bellinger mm_segment_t old_fs; 2515787cacdSChristoph Hellwig loff_t pos = (cmd->t_task_lba * 25242bf829eSChristoph Hellwig se_dev->se_sub_dev->se_dev_attrib.block_size); 253c66ac9dbSNicholas Bellinger int ret = 0, i; 254c66ac9dbSNicholas Bellinger 2555787cacdSChristoph Hellwig iov = kzalloc(sizeof(struct iovec) * sgl_nents, GFP_KERNEL); 2566708bb27SAndy Grover if (!iov) { 2576708bb27SAndy Grover pr_err("Unable to allocate fd_do_readv iov[]\n"); 258e3d6f909SAndy Grover return -ENOMEM; 259c66ac9dbSNicholas Bellinger } 260c66ac9dbSNicholas Bellinger 2615787cacdSChristoph Hellwig for_each_sg(sgl, sg, sgl_nents, i) { 2629649fa1bSSebastian Andrzej Siewior iov[i].iov_len = sg->length; 2639649fa1bSSebastian Andrzej Siewior iov[i].iov_base = sg_virt(sg); 264c66ac9dbSNicholas Bellinger } 265c66ac9dbSNicholas Bellinger 266c66ac9dbSNicholas Bellinger old_fs = get_fs(); 267c66ac9dbSNicholas Bellinger set_fs(get_ds()); 2685787cacdSChristoph Hellwig ret = vfs_readv(fd, &iov[0], sgl_nents, &pos); 269c66ac9dbSNicholas Bellinger set_fs(old_fs); 270c66ac9dbSNicholas Bellinger 271c66ac9dbSNicholas Bellinger kfree(iov); 272c66ac9dbSNicholas Bellinger /* 273c66ac9dbSNicholas Bellinger * Return zeros and GOOD status even if the READ did not return 274c66ac9dbSNicholas Bellinger * the expected virt_size for struct file w/o a backing struct 275c66ac9dbSNicholas Bellinger * block_device. 276c66ac9dbSNicholas Bellinger */ 277c66ac9dbSNicholas Bellinger if (S_ISBLK(fd->f_dentry->d_inode->i_mode)) { 2785787cacdSChristoph Hellwig if (ret < 0 || ret != cmd->data_length) { 2796708bb27SAndy Grover pr_err("vfs_readv() returned %d," 280c66ac9dbSNicholas Bellinger " expecting %d for S_ISBLK\n", ret, 2815787cacdSChristoph Hellwig (int)cmd->data_length); 282e3d6f909SAndy Grover return (ret < 0 ? ret : -EINVAL); 283c66ac9dbSNicholas Bellinger } 284c66ac9dbSNicholas Bellinger } else { 285c66ac9dbSNicholas Bellinger if (ret < 0) { 2866708bb27SAndy Grover pr_err("vfs_readv() returned %d for non" 287c66ac9dbSNicholas Bellinger " S_ISBLK\n", ret); 288e3d6f909SAndy Grover return ret; 289c66ac9dbSNicholas Bellinger } 290c66ac9dbSNicholas Bellinger } 291c66ac9dbSNicholas Bellinger 292c66ac9dbSNicholas Bellinger return 1; 293c66ac9dbSNicholas Bellinger } 294c66ac9dbSNicholas Bellinger 2955787cacdSChristoph Hellwig static int fd_do_writev(struct se_cmd *cmd, struct scatterlist *sgl, 2965787cacdSChristoph Hellwig u32 sgl_nents) 297c66ac9dbSNicholas Bellinger { 2985787cacdSChristoph Hellwig struct se_device *se_dev = cmd->se_dev; 29942bf829eSChristoph Hellwig struct fd_dev *dev = se_dev->dev_ptr; 3006708bb27SAndy Grover struct file *fd = dev->fd_file; 3015787cacdSChristoph Hellwig struct scatterlist *sg; 302c66ac9dbSNicholas Bellinger struct iovec *iov; 303c66ac9dbSNicholas Bellinger mm_segment_t old_fs; 3045787cacdSChristoph Hellwig loff_t pos = (cmd->t_task_lba * 30542bf829eSChristoph Hellwig se_dev->se_sub_dev->se_dev_attrib.block_size); 306c66ac9dbSNicholas Bellinger int ret, i = 0; 307c66ac9dbSNicholas Bellinger 3085787cacdSChristoph Hellwig iov = kzalloc(sizeof(struct iovec) * sgl_nents, GFP_KERNEL); 3096708bb27SAndy Grover if (!iov) { 3106708bb27SAndy Grover pr_err("Unable to allocate fd_do_writev iov[]\n"); 311e3d6f909SAndy Grover return -ENOMEM; 312c66ac9dbSNicholas Bellinger } 313c66ac9dbSNicholas Bellinger 3145787cacdSChristoph Hellwig for_each_sg(sgl, sg, sgl_nents, i) { 3159649fa1bSSebastian Andrzej Siewior iov[i].iov_len = sg->length; 3169649fa1bSSebastian Andrzej Siewior iov[i].iov_base = sg_virt(sg); 317c66ac9dbSNicholas Bellinger } 318c66ac9dbSNicholas Bellinger 319c66ac9dbSNicholas Bellinger old_fs = get_fs(); 320c66ac9dbSNicholas Bellinger set_fs(get_ds()); 3215787cacdSChristoph Hellwig ret = vfs_writev(fd, &iov[0], sgl_nents, &pos); 322c66ac9dbSNicholas Bellinger set_fs(old_fs); 323c66ac9dbSNicholas Bellinger 324c66ac9dbSNicholas Bellinger kfree(iov); 325c66ac9dbSNicholas Bellinger 3265787cacdSChristoph Hellwig if (ret < 0 || ret != cmd->data_length) { 3276708bb27SAndy Grover pr_err("vfs_writev() returned %d\n", ret); 328e3d6f909SAndy Grover return (ret < 0 ? ret : -EINVAL); 329c66ac9dbSNicholas Bellinger } 330c66ac9dbSNicholas Bellinger 331c66ac9dbSNicholas Bellinger return 1; 332c66ac9dbSNicholas Bellinger } 333c66ac9dbSNicholas Bellinger 334ad67f0d9SChristoph Hellwig static int fd_execute_sync_cache(struct se_cmd *cmd) 335c66ac9dbSNicholas Bellinger { 336c66ac9dbSNicholas Bellinger struct se_device *dev = cmd->se_dev; 337c66ac9dbSNicholas Bellinger struct fd_dev *fd_dev = dev->dev_ptr; 338a1d8b49aSAndy Grover int immed = (cmd->t_task_cdb[1] & 0x2); 339c66ac9dbSNicholas Bellinger loff_t start, end; 340c66ac9dbSNicholas Bellinger int ret; 341c66ac9dbSNicholas Bellinger 342c66ac9dbSNicholas Bellinger /* 343c66ac9dbSNicholas Bellinger * If the Immediate bit is set, queue up the GOOD response 344c66ac9dbSNicholas Bellinger * for this SYNCHRONIZE_CACHE op 345c66ac9dbSNicholas Bellinger */ 346c66ac9dbSNicholas Bellinger if (immed) 3475787cacdSChristoph Hellwig target_complete_cmd(cmd, SAM_STAT_GOOD); 348c66ac9dbSNicholas Bellinger 349c66ac9dbSNicholas Bellinger /* 350c66ac9dbSNicholas Bellinger * Determine if we will be flushing the entire device. 351c66ac9dbSNicholas Bellinger */ 352a1d8b49aSAndy Grover if (cmd->t_task_lba == 0 && cmd->data_length == 0) { 353c66ac9dbSNicholas Bellinger start = 0; 354c66ac9dbSNicholas Bellinger end = LLONG_MAX; 355c66ac9dbSNicholas Bellinger } else { 356a1d8b49aSAndy Grover start = cmd->t_task_lba * dev->se_sub_dev->se_dev_attrib.block_size; 357c66ac9dbSNicholas Bellinger if (cmd->data_length) 358c66ac9dbSNicholas Bellinger end = start + cmd->data_length; 359c66ac9dbSNicholas Bellinger else 360c66ac9dbSNicholas Bellinger end = LLONG_MAX; 361c66ac9dbSNicholas Bellinger } 362c66ac9dbSNicholas Bellinger 363c66ac9dbSNicholas Bellinger ret = vfs_fsync_range(fd_dev->fd_file, start, end, 1); 364c66ac9dbSNicholas Bellinger if (ret != 0) 3656708bb27SAndy Grover pr_err("FILEIO: vfs_fsync_range() failed: %d\n", ret); 366c66ac9dbSNicholas Bellinger 3675787cacdSChristoph Hellwig if (immed) 368ad67f0d9SChristoph Hellwig return 0; 3695787cacdSChristoph Hellwig 3705787cacdSChristoph Hellwig if (ret) { 3715787cacdSChristoph Hellwig cmd->scsi_sense_reason = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE; 3725787cacdSChristoph Hellwig target_complete_cmd(cmd, SAM_STAT_CHECK_CONDITION); 3735787cacdSChristoph Hellwig } else { 3745787cacdSChristoph Hellwig target_complete_cmd(cmd, SAM_STAT_GOOD); 3755787cacdSChristoph Hellwig } 376ad67f0d9SChristoph Hellwig 377ad67f0d9SChristoph Hellwig return 0; 378c66ac9dbSNicholas Bellinger } 379c66ac9dbSNicholas Bellinger 3800c2ad7d1SChristoph Hellwig static int fd_execute_rw(struct se_cmd *cmd) 381c66ac9dbSNicholas Bellinger { 3820c2ad7d1SChristoph Hellwig struct scatterlist *sgl = cmd->t_data_sg; 3830c2ad7d1SChristoph Hellwig u32 sgl_nents = cmd->t_data_nents; 3840c2ad7d1SChristoph Hellwig enum dma_data_direction data_direction = cmd->data_direction; 385c66ac9dbSNicholas Bellinger struct se_device *dev = cmd->se_dev; 386c66ac9dbSNicholas Bellinger int ret = 0; 387c66ac9dbSNicholas Bellinger 388c66ac9dbSNicholas Bellinger /* 389c66ac9dbSNicholas Bellinger * Call vectorized fileio functions to map struct scatterlist 390c66ac9dbSNicholas Bellinger * physical memory addresses to struct iovec virtual memory. 391c66ac9dbSNicholas Bellinger */ 3925787cacdSChristoph Hellwig if (data_direction == DMA_FROM_DEVICE) { 3935787cacdSChristoph Hellwig ret = fd_do_readv(cmd, sgl, sgl_nents); 394c66ac9dbSNicholas Bellinger } else { 3955787cacdSChristoph Hellwig ret = fd_do_writev(cmd, sgl, sgl_nents); 396a4dff304SNicholas Bellinger /* 397a4dff304SNicholas Bellinger * Perform implict vfs_fsync_range() for fd_do_writev() ops 398a4dff304SNicholas Bellinger * for SCSI WRITEs with Forced Unit Access (FUA) set. 399a4dff304SNicholas Bellinger * Allow this to happen independent of WCE=0 setting. 400a4dff304SNicholas Bellinger */ 401c66ac9dbSNicholas Bellinger if (ret > 0 && 402e3d6f909SAndy Grover dev->se_sub_dev->se_dev_attrib.emulate_fua_write > 0 && 4032d3a4b51SChristoph Hellwig (cmd->se_cmd_flags & SCF_FUA)) { 404a4dff304SNicholas Bellinger struct fd_dev *fd_dev = dev->dev_ptr; 405a4dff304SNicholas Bellinger loff_t start = cmd->t_task_lba * 406a4dff304SNicholas Bellinger dev->se_sub_dev->se_dev_attrib.block_size; 407a4dff304SNicholas Bellinger loff_t end = start + cmd->data_length; 408c66ac9dbSNicholas Bellinger 409a4dff304SNicholas Bellinger vfs_fsync_range(fd_dev->fd_file, start, end, 1); 410a4dff304SNicholas Bellinger } 411c66ac9dbSNicholas Bellinger } 412c66ac9dbSNicholas Bellinger 41303e98c9eSNicholas Bellinger if (ret < 0) { 41403e98c9eSNicholas Bellinger cmd->scsi_sense_reason = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE; 415c66ac9dbSNicholas Bellinger return ret; 41603e98c9eSNicholas Bellinger } 4175787cacdSChristoph Hellwig if (ret) 4185787cacdSChristoph Hellwig target_complete_cmd(cmd, SAM_STAT_GOOD); 41903e98c9eSNicholas Bellinger return 0; 420c66ac9dbSNicholas Bellinger } 421c66ac9dbSNicholas Bellinger 422c66ac9dbSNicholas Bellinger enum { 423c66ac9dbSNicholas Bellinger Opt_fd_dev_name, Opt_fd_dev_size, Opt_fd_buffered_io, Opt_err 424c66ac9dbSNicholas Bellinger }; 425c66ac9dbSNicholas Bellinger 426c66ac9dbSNicholas Bellinger static match_table_t tokens = { 427c66ac9dbSNicholas Bellinger {Opt_fd_dev_name, "fd_dev_name=%s"}, 428c66ac9dbSNicholas Bellinger {Opt_fd_dev_size, "fd_dev_size=%s"}, 429b32f4c7eSNicholas Bellinger {Opt_fd_buffered_io, "fd_buffered_io=%d"}, 430c66ac9dbSNicholas Bellinger {Opt_err, NULL} 431c66ac9dbSNicholas Bellinger }; 432c66ac9dbSNicholas Bellinger 433c66ac9dbSNicholas Bellinger static ssize_t fd_set_configfs_dev_params( 434c66ac9dbSNicholas Bellinger struct se_hba *hba, 435c66ac9dbSNicholas Bellinger struct se_subsystem_dev *se_dev, 436c66ac9dbSNicholas Bellinger const char *page, ssize_t count) 437c66ac9dbSNicholas Bellinger { 438c66ac9dbSNicholas Bellinger struct fd_dev *fd_dev = se_dev->se_dev_su_ptr; 439c66ac9dbSNicholas Bellinger char *orig, *ptr, *arg_p, *opts; 440c66ac9dbSNicholas Bellinger substring_t args[MAX_OPT_ARGS]; 441b32f4c7eSNicholas Bellinger int ret = 0, arg, token; 442c66ac9dbSNicholas Bellinger 443c66ac9dbSNicholas Bellinger opts = kstrdup(page, GFP_KERNEL); 444c66ac9dbSNicholas Bellinger if (!opts) 445c66ac9dbSNicholas Bellinger return -ENOMEM; 446c66ac9dbSNicholas Bellinger 447c66ac9dbSNicholas Bellinger orig = opts; 448c66ac9dbSNicholas Bellinger 44990c161b6SSebastian Andrzej Siewior while ((ptr = strsep(&opts, ",\n")) != NULL) { 450c66ac9dbSNicholas Bellinger if (!*ptr) 451c66ac9dbSNicholas Bellinger continue; 452c66ac9dbSNicholas Bellinger 453c66ac9dbSNicholas Bellinger token = match_token(ptr, tokens, args); 454c66ac9dbSNicholas Bellinger switch (token) { 455c66ac9dbSNicholas Bellinger case Opt_fd_dev_name: 456dbc6e022SAl Viro if (match_strlcpy(fd_dev->fd_dev_name, &args[0], 457dbc6e022SAl Viro FD_MAX_DEV_NAME) == 0) { 458dbc6e022SAl Viro ret = -EINVAL; 4596d180253SJesper Juhl break; 4606d180253SJesper Juhl } 4616708bb27SAndy Grover pr_debug("FILEIO: Referencing Path: %s\n", 462c66ac9dbSNicholas Bellinger fd_dev->fd_dev_name); 463c66ac9dbSNicholas Bellinger fd_dev->fbd_flags |= FBDF_HAS_PATH; 464c66ac9dbSNicholas Bellinger break; 465c66ac9dbSNicholas Bellinger case Opt_fd_dev_size: 466c66ac9dbSNicholas Bellinger arg_p = match_strdup(&args[0]); 4676d180253SJesper Juhl if (!arg_p) { 4686d180253SJesper Juhl ret = -ENOMEM; 4696d180253SJesper Juhl break; 4706d180253SJesper Juhl } 471c66ac9dbSNicholas Bellinger ret = strict_strtoull(arg_p, 0, &fd_dev->fd_dev_size); 4726d180253SJesper Juhl kfree(arg_p); 473c66ac9dbSNicholas Bellinger if (ret < 0) { 4746708bb27SAndy Grover pr_err("strict_strtoull() failed for" 475c66ac9dbSNicholas Bellinger " fd_dev_size=\n"); 476c66ac9dbSNicholas Bellinger goto out; 477c66ac9dbSNicholas Bellinger } 4786708bb27SAndy Grover pr_debug("FILEIO: Referencing Size: %llu" 479c66ac9dbSNicholas Bellinger " bytes\n", fd_dev->fd_dev_size); 480c66ac9dbSNicholas Bellinger fd_dev->fbd_flags |= FBDF_HAS_SIZE; 481c66ac9dbSNicholas Bellinger break; 482b32f4c7eSNicholas Bellinger case Opt_fd_buffered_io: 483b32f4c7eSNicholas Bellinger match_int(args, &arg); 484b32f4c7eSNicholas Bellinger if (arg != 1) { 485b32f4c7eSNicholas Bellinger pr_err("bogus fd_buffered_io=%d value\n", arg); 486b32f4c7eSNicholas Bellinger ret = -EINVAL; 487b32f4c7eSNicholas Bellinger goto out; 488b32f4c7eSNicholas Bellinger } 489b32f4c7eSNicholas Bellinger 490b32f4c7eSNicholas Bellinger pr_debug("FILEIO: Using buffered I/O" 491b32f4c7eSNicholas Bellinger " operations for struct fd_dev\n"); 492b32f4c7eSNicholas Bellinger 493b32f4c7eSNicholas Bellinger fd_dev->fbd_flags |= FDBD_HAS_BUFFERED_IO_WCE; 494b32f4c7eSNicholas Bellinger break; 495c66ac9dbSNicholas Bellinger default: 496c66ac9dbSNicholas Bellinger break; 497c66ac9dbSNicholas Bellinger } 498c66ac9dbSNicholas Bellinger } 499c66ac9dbSNicholas Bellinger 500c66ac9dbSNicholas Bellinger out: 501c66ac9dbSNicholas Bellinger kfree(orig); 502c66ac9dbSNicholas Bellinger return (!ret) ? count : ret; 503c66ac9dbSNicholas Bellinger } 504c66ac9dbSNicholas Bellinger 505c66ac9dbSNicholas Bellinger static ssize_t fd_check_configfs_dev_params(struct se_hba *hba, struct se_subsystem_dev *se_dev) 506c66ac9dbSNicholas Bellinger { 5078359cf43SJörn Engel struct fd_dev *fd_dev = se_dev->se_dev_su_ptr; 508c66ac9dbSNicholas Bellinger 509c66ac9dbSNicholas Bellinger if (!(fd_dev->fbd_flags & FBDF_HAS_PATH)) { 5106708bb27SAndy Grover pr_err("Missing fd_dev_name=\n"); 511e3d6f909SAndy Grover return -EINVAL; 512c66ac9dbSNicholas Bellinger } 513c66ac9dbSNicholas Bellinger 514c66ac9dbSNicholas Bellinger return 0; 515c66ac9dbSNicholas Bellinger } 516c66ac9dbSNicholas Bellinger 517c66ac9dbSNicholas Bellinger static ssize_t fd_show_configfs_dev_params( 518c66ac9dbSNicholas Bellinger struct se_hba *hba, 519c66ac9dbSNicholas Bellinger struct se_subsystem_dev *se_dev, 520c66ac9dbSNicholas Bellinger char *b) 521c66ac9dbSNicholas Bellinger { 522c66ac9dbSNicholas Bellinger struct fd_dev *fd_dev = se_dev->se_dev_su_ptr; 523c66ac9dbSNicholas Bellinger ssize_t bl = 0; 524c66ac9dbSNicholas Bellinger 525c66ac9dbSNicholas Bellinger bl = sprintf(b + bl, "TCM FILEIO ID: %u", fd_dev->fd_dev_id); 526b32f4c7eSNicholas Bellinger bl += sprintf(b + bl, " File: %s Size: %llu Mode: %s\n", 527b32f4c7eSNicholas Bellinger fd_dev->fd_dev_name, fd_dev->fd_dev_size, 528b32f4c7eSNicholas Bellinger (fd_dev->fbd_flags & FDBD_HAS_BUFFERED_IO_WCE) ? 529b32f4c7eSNicholas Bellinger "Buffered-WCE" : "O_DSYNC"); 530c66ac9dbSNicholas Bellinger return bl; 531c66ac9dbSNicholas Bellinger } 532c66ac9dbSNicholas Bellinger 533c66ac9dbSNicholas Bellinger /* fd_get_device_rev(): (Part of se_subsystem_api_t template) 534c66ac9dbSNicholas Bellinger * 535c66ac9dbSNicholas Bellinger * 536c66ac9dbSNicholas Bellinger */ 537c66ac9dbSNicholas Bellinger static u32 fd_get_device_rev(struct se_device *dev) 538c66ac9dbSNicholas Bellinger { 539c66ac9dbSNicholas Bellinger return SCSI_SPC_2; /* Returns SPC-3 in Initiator Data */ 540c66ac9dbSNicholas Bellinger } 541c66ac9dbSNicholas Bellinger 542c66ac9dbSNicholas Bellinger /* fd_get_device_type(): (Part of se_subsystem_api_t template) 543c66ac9dbSNicholas Bellinger * 544c66ac9dbSNicholas Bellinger * 545c66ac9dbSNicholas Bellinger */ 546c66ac9dbSNicholas Bellinger static u32 fd_get_device_type(struct se_device *dev) 547c66ac9dbSNicholas Bellinger { 548c66ac9dbSNicholas Bellinger return TYPE_DISK; 549c66ac9dbSNicholas Bellinger } 550c66ac9dbSNicholas Bellinger 551c66ac9dbSNicholas Bellinger static sector_t fd_get_blocks(struct se_device *dev) 552c66ac9dbSNicholas Bellinger { 553c66ac9dbSNicholas Bellinger struct fd_dev *fd_dev = dev->dev_ptr; 554cd9323fdSNicholas Bellinger struct file *f = fd_dev->fd_file; 555cd9323fdSNicholas Bellinger struct inode *i = f->f_mapping->host; 556cd9323fdSNicholas Bellinger unsigned long long dev_size; 557cd9323fdSNicholas Bellinger /* 558cd9323fdSNicholas Bellinger * When using a file that references an underlying struct block_device, 559cd9323fdSNicholas Bellinger * ensure dev_size is always based on the current inode size in order 560cd9323fdSNicholas Bellinger * to handle underlying block_device resize operations. 561cd9323fdSNicholas Bellinger */ 562cd9323fdSNicholas Bellinger if (S_ISBLK(i->i_mode)) 563cd9323fdSNicholas Bellinger dev_size = (i_size_read(i) - fd_dev->fd_block_size); 564cd9323fdSNicholas Bellinger else 565cd9323fdSNicholas Bellinger dev_size = fd_dev->fd_dev_size; 566c66ac9dbSNicholas Bellinger 567cd9323fdSNicholas Bellinger return div_u64(dev_size, dev->se_sub_dev->se_dev_attrib.block_size); 568c66ac9dbSNicholas Bellinger } 569c66ac9dbSNicholas Bellinger 5700c2ad7d1SChristoph Hellwig static struct spc_ops fd_spc_ops = { 5710c2ad7d1SChristoph Hellwig .execute_rw = fd_execute_rw, 572ad67f0d9SChristoph Hellwig .execute_sync_cache = fd_execute_sync_cache, 5730c2ad7d1SChristoph Hellwig }; 5740c2ad7d1SChristoph Hellwig 5750c2ad7d1SChristoph Hellwig static int fd_parse_cdb(struct se_cmd *cmd) 5760c2ad7d1SChristoph Hellwig { 5770c2ad7d1SChristoph Hellwig return sbc_parse_cdb(cmd, &fd_spc_ops); 5780c2ad7d1SChristoph Hellwig } 5790c2ad7d1SChristoph Hellwig 580c66ac9dbSNicholas Bellinger static struct se_subsystem_api fileio_template = { 581c66ac9dbSNicholas Bellinger .name = "fileio", 582c66ac9dbSNicholas Bellinger .owner = THIS_MODULE, 583c66ac9dbSNicholas Bellinger .transport_type = TRANSPORT_PLUGIN_VHBA_PDEV, 584c66ac9dbSNicholas Bellinger .attach_hba = fd_attach_hba, 585c66ac9dbSNicholas Bellinger .detach_hba = fd_detach_hba, 586c66ac9dbSNicholas Bellinger .allocate_virtdevice = fd_allocate_virtdevice, 587c66ac9dbSNicholas Bellinger .create_virtdevice = fd_create_virtdevice, 588c66ac9dbSNicholas Bellinger .free_device = fd_free_device, 5890c2ad7d1SChristoph Hellwig .parse_cdb = fd_parse_cdb, 590c66ac9dbSNicholas Bellinger .check_configfs_dev_params = fd_check_configfs_dev_params, 591c66ac9dbSNicholas Bellinger .set_configfs_dev_params = fd_set_configfs_dev_params, 592c66ac9dbSNicholas Bellinger .show_configfs_dev_params = fd_show_configfs_dev_params, 593c66ac9dbSNicholas Bellinger .get_device_rev = fd_get_device_rev, 594c66ac9dbSNicholas Bellinger .get_device_type = fd_get_device_type, 595c66ac9dbSNicholas Bellinger .get_blocks = fd_get_blocks, 596c66ac9dbSNicholas Bellinger }; 597c66ac9dbSNicholas Bellinger 598c66ac9dbSNicholas Bellinger static int __init fileio_module_init(void) 599c66ac9dbSNicholas Bellinger { 600c66ac9dbSNicholas Bellinger return transport_subsystem_register(&fileio_template); 601c66ac9dbSNicholas Bellinger } 602c66ac9dbSNicholas Bellinger 603c66ac9dbSNicholas Bellinger static void fileio_module_exit(void) 604c66ac9dbSNicholas Bellinger { 605c66ac9dbSNicholas Bellinger transport_subsystem_release(&fileio_template); 606c66ac9dbSNicholas Bellinger } 607c66ac9dbSNicholas Bellinger 608c66ac9dbSNicholas Bellinger MODULE_DESCRIPTION("TCM FILEIO subsystem plugin"); 609c66ac9dbSNicholas Bellinger MODULE_AUTHOR("nab@Linux-iSCSI.org"); 610c66ac9dbSNicholas Bellinger MODULE_LICENSE("GPL"); 611c66ac9dbSNicholas Bellinger 612c66ac9dbSNicholas Bellinger module_init(fileio_module_init); 613c66ac9dbSNicholas Bellinger module_exit(fileio_module_exit); 614