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 char *dev_p = NULL; 113c66ac9dbSNicholas Bellinger struct se_device *dev; 114c66ac9dbSNicholas Bellinger struct se_dev_limits dev_limits; 115c66ac9dbSNicholas Bellinger struct queue_limits *limits; 1168359cf43SJörn Engel struct fd_dev *fd_dev = p; 1178359cf43SJörn Engel struct fd_host *fd_host = hba->hba_ptr; 118c66ac9dbSNicholas Bellinger mm_segment_t old_fs; 119c66ac9dbSNicholas Bellinger struct file *file; 120c66ac9dbSNicholas Bellinger struct inode *inode = NULL; 121613640e4SNicholas Bellinger int dev_flags = 0, flags, ret = -EINVAL; 122c66ac9dbSNicholas Bellinger 123c66ac9dbSNicholas Bellinger memset(&dev_limits, 0, sizeof(struct se_dev_limits)); 124c66ac9dbSNicholas Bellinger 125c66ac9dbSNicholas Bellinger old_fs = get_fs(); 126c66ac9dbSNicholas Bellinger set_fs(get_ds()); 127c66ac9dbSNicholas Bellinger dev_p = getname(fd_dev->fd_dev_name); 128c66ac9dbSNicholas Bellinger set_fs(old_fs); 129c66ac9dbSNicholas Bellinger 130c66ac9dbSNicholas Bellinger if (IS_ERR(dev_p)) { 1316708bb27SAndy Grover pr_err("getname(%s) failed: %lu\n", 132c66ac9dbSNicholas Bellinger fd_dev->fd_dev_name, IS_ERR(dev_p)); 133613640e4SNicholas Bellinger ret = PTR_ERR(dev_p); 134c66ac9dbSNicholas Bellinger goto fail; 135c66ac9dbSNicholas Bellinger } 1368b1e1244SAndy Grover 1378b1e1244SAndy Grover /* O_DIRECT too? */ 138c66ac9dbSNicholas Bellinger flags = O_RDWR | O_CREAT | O_LARGEFILE; 1398b1e1244SAndy Grover 140c66ac9dbSNicholas Bellinger /* 14125985edcSLucas De Marchi * If fd_buffered_io=1 has not been set explicitly (the default), 142c66ac9dbSNicholas Bellinger * use O_SYNC to force FILEIO writes to disk. 143c66ac9dbSNicholas Bellinger */ 144c66ac9dbSNicholas Bellinger if (!(fd_dev->fbd_flags & FDBD_USE_BUFFERED_IO)) 145c66ac9dbSNicholas Bellinger flags |= O_SYNC; 146c66ac9dbSNicholas Bellinger 147c66ac9dbSNicholas Bellinger file = filp_open(dev_p, flags, 0600); 148613640e4SNicholas Bellinger if (IS_ERR(file)) { 1496708bb27SAndy Grover pr_err("filp_open(%s) failed\n", dev_p); 150613640e4SNicholas Bellinger ret = PTR_ERR(file); 151613640e4SNicholas Bellinger goto fail; 152613640e4SNicholas Bellinger } 153613640e4SNicholas Bellinger if (!file || !file->f_dentry) { 1546708bb27SAndy Grover pr_err("filp_open(%s) failed\n", dev_p); 155c66ac9dbSNicholas Bellinger goto fail; 156c66ac9dbSNicholas Bellinger } 157c66ac9dbSNicholas Bellinger fd_dev->fd_file = file; 158c66ac9dbSNicholas Bellinger /* 159c66ac9dbSNicholas Bellinger * If using a block backend with this struct file, we extract 160c66ac9dbSNicholas Bellinger * fd_dev->fd_[block,dev]_size from struct block_device. 161c66ac9dbSNicholas Bellinger * 162c66ac9dbSNicholas Bellinger * Otherwise, we use the passed fd_size= from configfs 163c66ac9dbSNicholas Bellinger */ 164c66ac9dbSNicholas Bellinger inode = file->f_mapping->host; 165c66ac9dbSNicholas Bellinger if (S_ISBLK(inode->i_mode)) { 166c66ac9dbSNicholas Bellinger struct request_queue *q; 167c66ac9dbSNicholas Bellinger /* 168c66ac9dbSNicholas Bellinger * Setup the local scope queue_limits from struct request_queue->limits 169c66ac9dbSNicholas Bellinger * to pass into transport_add_device_to_core_hba() as struct se_dev_limits. 170c66ac9dbSNicholas Bellinger */ 171c66ac9dbSNicholas Bellinger q = bdev_get_queue(inode->i_bdev); 172c66ac9dbSNicholas Bellinger limits = &dev_limits.limits; 173c66ac9dbSNicholas Bellinger limits->logical_block_size = bdev_logical_block_size(inode->i_bdev); 174c66ac9dbSNicholas Bellinger limits->max_hw_sectors = queue_max_hw_sectors(q); 175c66ac9dbSNicholas Bellinger limits->max_sectors = queue_max_sectors(q); 176c66ac9dbSNicholas Bellinger /* 177c66ac9dbSNicholas Bellinger * Determine the number of bytes from i_size_read() minus 178c66ac9dbSNicholas Bellinger * one (1) logical sector from underlying struct block_device 179c66ac9dbSNicholas Bellinger */ 180c66ac9dbSNicholas Bellinger fd_dev->fd_block_size = bdev_logical_block_size(inode->i_bdev); 181c66ac9dbSNicholas Bellinger fd_dev->fd_dev_size = (i_size_read(file->f_mapping->host) - 182c66ac9dbSNicholas Bellinger fd_dev->fd_block_size); 183c66ac9dbSNicholas Bellinger 1846708bb27SAndy Grover pr_debug("FILEIO: Using size: %llu bytes from struct" 185c66ac9dbSNicholas Bellinger " block_device blocks: %llu logical_block_size: %d\n", 186c66ac9dbSNicholas Bellinger fd_dev->fd_dev_size, 187c66ac9dbSNicholas Bellinger div_u64(fd_dev->fd_dev_size, fd_dev->fd_block_size), 188c66ac9dbSNicholas Bellinger fd_dev->fd_block_size); 189c66ac9dbSNicholas Bellinger } else { 190c66ac9dbSNicholas Bellinger if (!(fd_dev->fbd_flags & FBDF_HAS_SIZE)) { 1916708bb27SAndy Grover pr_err("FILEIO: Missing fd_dev_size=" 192c66ac9dbSNicholas Bellinger " parameter, and no backing struct" 193c66ac9dbSNicholas Bellinger " block_device\n"); 194c66ac9dbSNicholas Bellinger goto fail; 195c66ac9dbSNicholas Bellinger } 196c66ac9dbSNicholas Bellinger 197c66ac9dbSNicholas Bellinger limits = &dev_limits.limits; 198c66ac9dbSNicholas Bellinger limits->logical_block_size = FD_BLOCKSIZE; 199c66ac9dbSNicholas Bellinger limits->max_hw_sectors = FD_MAX_SECTORS; 200c66ac9dbSNicholas Bellinger limits->max_sectors = FD_MAX_SECTORS; 201c66ac9dbSNicholas Bellinger fd_dev->fd_block_size = FD_BLOCKSIZE; 202c66ac9dbSNicholas Bellinger } 203c66ac9dbSNicholas Bellinger 204c66ac9dbSNicholas Bellinger dev_limits.hw_queue_depth = FD_MAX_DEVICE_QUEUE_DEPTH; 205c66ac9dbSNicholas Bellinger dev_limits.queue_depth = FD_DEVICE_QUEUE_DEPTH; 206c66ac9dbSNicholas Bellinger 207c66ac9dbSNicholas Bellinger dev = transport_add_device_to_core_hba(hba, &fileio_template, 2085951146dSAndy Grover se_dev, dev_flags, fd_dev, 209c66ac9dbSNicholas Bellinger &dev_limits, "FILEIO", FD_VERSION); 2106708bb27SAndy Grover if (!dev) 211c66ac9dbSNicholas Bellinger goto fail; 212c66ac9dbSNicholas Bellinger 213c66ac9dbSNicholas Bellinger fd_dev->fd_dev_id = fd_host->fd_host_dev_id_count++; 214c66ac9dbSNicholas Bellinger fd_dev->fd_queue_depth = dev->queue_depth; 215c66ac9dbSNicholas Bellinger 2166708bb27SAndy Grover pr_debug("CORE_FILE[%u] - Added TCM FILEIO Device ID: %u at %s," 217c66ac9dbSNicholas Bellinger " %llu total bytes\n", fd_host->fd_host_id, fd_dev->fd_dev_id, 218c66ac9dbSNicholas Bellinger fd_dev->fd_dev_name, fd_dev->fd_dev_size); 219c66ac9dbSNicholas Bellinger 220c66ac9dbSNicholas Bellinger putname(dev_p); 221c66ac9dbSNicholas Bellinger return dev; 222c66ac9dbSNicholas Bellinger fail: 223c66ac9dbSNicholas Bellinger if (fd_dev->fd_file) { 224c66ac9dbSNicholas Bellinger filp_close(fd_dev->fd_file, NULL); 225c66ac9dbSNicholas Bellinger fd_dev->fd_file = NULL; 226c66ac9dbSNicholas Bellinger } 227c66ac9dbSNicholas Bellinger putname(dev_p); 228613640e4SNicholas Bellinger return ERR_PTR(ret); 229c66ac9dbSNicholas Bellinger } 230c66ac9dbSNicholas Bellinger 231c66ac9dbSNicholas Bellinger /* fd_free_device(): (Part of se_subsystem_api_t template) 232c66ac9dbSNicholas Bellinger * 233c66ac9dbSNicholas Bellinger * 234c66ac9dbSNicholas Bellinger */ 235c66ac9dbSNicholas Bellinger static void fd_free_device(void *p) 236c66ac9dbSNicholas Bellinger { 2378359cf43SJörn Engel struct fd_dev *fd_dev = p; 238c66ac9dbSNicholas Bellinger 239c66ac9dbSNicholas Bellinger if (fd_dev->fd_file) { 240c66ac9dbSNicholas Bellinger filp_close(fd_dev->fd_file, NULL); 241c66ac9dbSNicholas Bellinger fd_dev->fd_file = NULL; 242c66ac9dbSNicholas Bellinger } 243c66ac9dbSNicholas Bellinger 244c66ac9dbSNicholas Bellinger kfree(fd_dev); 245c66ac9dbSNicholas Bellinger } 246c66ac9dbSNicholas Bellinger 2475787cacdSChristoph Hellwig static int fd_do_readv(struct se_cmd *cmd, struct scatterlist *sgl, 2485787cacdSChristoph Hellwig u32 sgl_nents) 249c66ac9dbSNicholas Bellinger { 2505787cacdSChristoph Hellwig struct se_device *se_dev = cmd->se_dev; 25142bf829eSChristoph Hellwig struct fd_dev *dev = se_dev->dev_ptr; 2526708bb27SAndy Grover struct file *fd = dev->fd_file; 2535787cacdSChristoph Hellwig struct scatterlist *sg; 254c66ac9dbSNicholas Bellinger struct iovec *iov; 255c66ac9dbSNicholas Bellinger mm_segment_t old_fs; 2565787cacdSChristoph Hellwig loff_t pos = (cmd->t_task_lba * 25742bf829eSChristoph Hellwig se_dev->se_sub_dev->se_dev_attrib.block_size); 258c66ac9dbSNicholas Bellinger int ret = 0, i; 259c66ac9dbSNicholas Bellinger 2605787cacdSChristoph Hellwig iov = kzalloc(sizeof(struct iovec) * sgl_nents, GFP_KERNEL); 2616708bb27SAndy Grover if (!iov) { 2626708bb27SAndy Grover pr_err("Unable to allocate fd_do_readv iov[]\n"); 263e3d6f909SAndy Grover return -ENOMEM; 264c66ac9dbSNicholas Bellinger } 265c66ac9dbSNicholas Bellinger 2665787cacdSChristoph Hellwig for_each_sg(sgl, sg, sgl_nents, i) { 2679649fa1bSSebastian Andrzej Siewior iov[i].iov_len = sg->length; 2689649fa1bSSebastian Andrzej Siewior iov[i].iov_base = sg_virt(sg); 269c66ac9dbSNicholas Bellinger } 270c66ac9dbSNicholas Bellinger 271c66ac9dbSNicholas Bellinger old_fs = get_fs(); 272c66ac9dbSNicholas Bellinger set_fs(get_ds()); 2735787cacdSChristoph Hellwig ret = vfs_readv(fd, &iov[0], sgl_nents, &pos); 274c66ac9dbSNicholas Bellinger set_fs(old_fs); 275c66ac9dbSNicholas Bellinger 276c66ac9dbSNicholas Bellinger kfree(iov); 277c66ac9dbSNicholas Bellinger /* 278c66ac9dbSNicholas Bellinger * Return zeros and GOOD status even if the READ did not return 279c66ac9dbSNicholas Bellinger * the expected virt_size for struct file w/o a backing struct 280c66ac9dbSNicholas Bellinger * block_device. 281c66ac9dbSNicholas Bellinger */ 282c66ac9dbSNicholas Bellinger if (S_ISBLK(fd->f_dentry->d_inode->i_mode)) { 2835787cacdSChristoph Hellwig if (ret < 0 || ret != cmd->data_length) { 2846708bb27SAndy Grover pr_err("vfs_readv() returned %d," 285c66ac9dbSNicholas Bellinger " expecting %d for S_ISBLK\n", ret, 2865787cacdSChristoph Hellwig (int)cmd->data_length); 287e3d6f909SAndy Grover return (ret < 0 ? ret : -EINVAL); 288c66ac9dbSNicholas Bellinger } 289c66ac9dbSNicholas Bellinger } else { 290c66ac9dbSNicholas Bellinger if (ret < 0) { 2916708bb27SAndy Grover pr_err("vfs_readv() returned %d for non" 292c66ac9dbSNicholas Bellinger " S_ISBLK\n", ret); 293e3d6f909SAndy Grover return ret; 294c66ac9dbSNicholas Bellinger } 295c66ac9dbSNicholas Bellinger } 296c66ac9dbSNicholas Bellinger 297c66ac9dbSNicholas Bellinger return 1; 298c66ac9dbSNicholas Bellinger } 299c66ac9dbSNicholas Bellinger 3005787cacdSChristoph Hellwig static int fd_do_writev(struct se_cmd *cmd, struct scatterlist *sgl, 3015787cacdSChristoph Hellwig u32 sgl_nents) 302c66ac9dbSNicholas Bellinger { 3035787cacdSChristoph Hellwig struct se_device *se_dev = cmd->se_dev; 30442bf829eSChristoph Hellwig struct fd_dev *dev = se_dev->dev_ptr; 3056708bb27SAndy Grover struct file *fd = dev->fd_file; 3065787cacdSChristoph Hellwig struct scatterlist *sg; 307c66ac9dbSNicholas Bellinger struct iovec *iov; 308c66ac9dbSNicholas Bellinger mm_segment_t old_fs; 3095787cacdSChristoph Hellwig loff_t pos = (cmd->t_task_lba * 31042bf829eSChristoph Hellwig se_dev->se_sub_dev->se_dev_attrib.block_size); 311c66ac9dbSNicholas Bellinger int ret, i = 0; 312c66ac9dbSNicholas Bellinger 3135787cacdSChristoph Hellwig iov = kzalloc(sizeof(struct iovec) * sgl_nents, GFP_KERNEL); 3146708bb27SAndy Grover if (!iov) { 3156708bb27SAndy Grover pr_err("Unable to allocate fd_do_writev iov[]\n"); 316e3d6f909SAndy Grover return -ENOMEM; 317c66ac9dbSNicholas Bellinger } 318c66ac9dbSNicholas Bellinger 3195787cacdSChristoph Hellwig for_each_sg(sgl, sg, sgl_nents, i) { 3209649fa1bSSebastian Andrzej Siewior iov[i].iov_len = sg->length; 3219649fa1bSSebastian Andrzej Siewior iov[i].iov_base = sg_virt(sg); 322c66ac9dbSNicholas Bellinger } 323c66ac9dbSNicholas Bellinger 324c66ac9dbSNicholas Bellinger old_fs = get_fs(); 325c66ac9dbSNicholas Bellinger set_fs(get_ds()); 3265787cacdSChristoph Hellwig ret = vfs_writev(fd, &iov[0], sgl_nents, &pos); 327c66ac9dbSNicholas Bellinger set_fs(old_fs); 328c66ac9dbSNicholas Bellinger 329c66ac9dbSNicholas Bellinger kfree(iov); 330c66ac9dbSNicholas Bellinger 3315787cacdSChristoph Hellwig if (ret < 0 || ret != cmd->data_length) { 3326708bb27SAndy Grover pr_err("vfs_writev() returned %d\n", ret); 333e3d6f909SAndy Grover return (ret < 0 ? ret : -EINVAL); 334c66ac9dbSNicholas Bellinger } 335c66ac9dbSNicholas Bellinger 336c66ac9dbSNicholas Bellinger return 1; 337c66ac9dbSNicholas Bellinger } 338c66ac9dbSNicholas Bellinger 3396bb35e00SChristoph Hellwig static void fd_emulate_sync_cache(struct se_cmd *cmd) 340c66ac9dbSNicholas Bellinger { 341c66ac9dbSNicholas Bellinger struct se_device *dev = cmd->se_dev; 342c66ac9dbSNicholas Bellinger struct fd_dev *fd_dev = dev->dev_ptr; 343a1d8b49aSAndy Grover int immed = (cmd->t_task_cdb[1] & 0x2); 344c66ac9dbSNicholas Bellinger loff_t start, end; 345c66ac9dbSNicholas Bellinger int ret; 346c66ac9dbSNicholas Bellinger 347c66ac9dbSNicholas Bellinger /* 348c66ac9dbSNicholas Bellinger * If the Immediate bit is set, queue up the GOOD response 349c66ac9dbSNicholas Bellinger * for this SYNCHRONIZE_CACHE op 350c66ac9dbSNicholas Bellinger */ 351c66ac9dbSNicholas Bellinger if (immed) 3525787cacdSChristoph Hellwig target_complete_cmd(cmd, SAM_STAT_GOOD); 353c66ac9dbSNicholas Bellinger 354c66ac9dbSNicholas Bellinger /* 355c66ac9dbSNicholas Bellinger * Determine if we will be flushing the entire device. 356c66ac9dbSNicholas Bellinger */ 357a1d8b49aSAndy Grover if (cmd->t_task_lba == 0 && cmd->data_length == 0) { 358c66ac9dbSNicholas Bellinger start = 0; 359c66ac9dbSNicholas Bellinger end = LLONG_MAX; 360c66ac9dbSNicholas Bellinger } else { 361a1d8b49aSAndy Grover start = cmd->t_task_lba * dev->se_sub_dev->se_dev_attrib.block_size; 362c66ac9dbSNicholas Bellinger if (cmd->data_length) 363c66ac9dbSNicholas Bellinger end = start + cmd->data_length; 364c66ac9dbSNicholas Bellinger else 365c66ac9dbSNicholas Bellinger end = LLONG_MAX; 366c66ac9dbSNicholas Bellinger } 367c66ac9dbSNicholas Bellinger 368c66ac9dbSNicholas Bellinger ret = vfs_fsync_range(fd_dev->fd_file, start, end, 1); 369c66ac9dbSNicholas Bellinger if (ret != 0) 3706708bb27SAndy Grover pr_err("FILEIO: vfs_fsync_range() failed: %d\n", ret); 371c66ac9dbSNicholas Bellinger 3725787cacdSChristoph Hellwig if (immed) 3735787cacdSChristoph Hellwig return; 3745787cacdSChristoph Hellwig 3755787cacdSChristoph Hellwig if (ret) { 3765787cacdSChristoph Hellwig cmd->scsi_sense_reason = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE; 3775787cacdSChristoph Hellwig target_complete_cmd(cmd, SAM_STAT_CHECK_CONDITION); 3785787cacdSChristoph Hellwig } else { 3795787cacdSChristoph Hellwig target_complete_cmd(cmd, SAM_STAT_GOOD); 3805787cacdSChristoph Hellwig } 381c66ac9dbSNicholas Bellinger } 382c66ac9dbSNicholas Bellinger 3835787cacdSChristoph Hellwig static void fd_emulate_write_fua(struct se_cmd *cmd) 384c66ac9dbSNicholas Bellinger { 385c66ac9dbSNicholas Bellinger struct se_device *dev = cmd->se_dev; 386c66ac9dbSNicholas Bellinger struct fd_dev *fd_dev = dev->dev_ptr; 3875787cacdSChristoph Hellwig loff_t start = cmd->t_task_lba * 38872a0e5e2SChristoph Hellwig dev->se_sub_dev->se_dev_attrib.block_size; 3895787cacdSChristoph Hellwig loff_t end = start + cmd->data_length; 390c66ac9dbSNicholas Bellinger int ret; 391c66ac9dbSNicholas Bellinger 3926708bb27SAndy Grover pr_debug("FILEIO: FUA WRITE LBA: %llu, bytes: %u\n", 3935787cacdSChristoph Hellwig cmd->t_task_lba, cmd->data_length); 394c66ac9dbSNicholas Bellinger 395c66ac9dbSNicholas Bellinger ret = vfs_fsync_range(fd_dev->fd_file, start, end, 1); 396c66ac9dbSNicholas Bellinger if (ret != 0) 3976708bb27SAndy Grover pr_err("FILEIO: vfs_fsync_range() failed: %d\n", ret); 398c66ac9dbSNicholas Bellinger } 399c66ac9dbSNicholas Bellinger 4005787cacdSChristoph Hellwig static int fd_execute_cmd(struct se_cmd *cmd, struct scatterlist *sgl, 4015787cacdSChristoph Hellwig u32 sgl_nents, enum dma_data_direction data_direction) 402c66ac9dbSNicholas Bellinger { 403c66ac9dbSNicholas Bellinger struct se_device *dev = cmd->se_dev; 404c66ac9dbSNicholas Bellinger int ret = 0; 405c66ac9dbSNicholas Bellinger 406c66ac9dbSNicholas Bellinger /* 407c66ac9dbSNicholas Bellinger * Call vectorized fileio functions to map struct scatterlist 408c66ac9dbSNicholas Bellinger * physical memory addresses to struct iovec virtual memory. 409c66ac9dbSNicholas Bellinger */ 4105787cacdSChristoph Hellwig if (data_direction == DMA_FROM_DEVICE) { 4115787cacdSChristoph Hellwig ret = fd_do_readv(cmd, sgl, sgl_nents); 412c66ac9dbSNicholas Bellinger } else { 4135787cacdSChristoph Hellwig ret = fd_do_writev(cmd, sgl, sgl_nents); 414c66ac9dbSNicholas Bellinger 415c66ac9dbSNicholas Bellinger if (ret > 0 && 416e3d6f909SAndy Grover dev->se_sub_dev->se_dev_attrib.emulate_write_cache > 0 && 417e3d6f909SAndy Grover dev->se_sub_dev->se_dev_attrib.emulate_fua_write > 0 && 4182d3a4b51SChristoph Hellwig (cmd->se_cmd_flags & SCF_FUA)) { 419c66ac9dbSNicholas Bellinger /* 420c66ac9dbSNicholas Bellinger * We might need to be a bit smarter here 421c66ac9dbSNicholas Bellinger * and return some sense data to let the initiator 422c66ac9dbSNicholas Bellinger * know the FUA WRITE cache sync failed..? 423c66ac9dbSNicholas Bellinger */ 4245787cacdSChristoph Hellwig fd_emulate_write_fua(cmd); 425c66ac9dbSNicholas Bellinger } 426c66ac9dbSNicholas Bellinger 427c66ac9dbSNicholas Bellinger } 428c66ac9dbSNicholas Bellinger 42903e98c9eSNicholas Bellinger if (ret < 0) { 43003e98c9eSNicholas Bellinger cmd->scsi_sense_reason = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE; 431c66ac9dbSNicholas Bellinger return ret; 43203e98c9eSNicholas Bellinger } 4335787cacdSChristoph Hellwig if (ret) 4345787cacdSChristoph Hellwig target_complete_cmd(cmd, SAM_STAT_GOOD); 43503e98c9eSNicholas Bellinger return 0; 436c66ac9dbSNicholas Bellinger } 437c66ac9dbSNicholas Bellinger 438c66ac9dbSNicholas Bellinger enum { 439c66ac9dbSNicholas Bellinger Opt_fd_dev_name, Opt_fd_dev_size, Opt_fd_buffered_io, Opt_err 440c66ac9dbSNicholas Bellinger }; 441c66ac9dbSNicholas Bellinger 442c66ac9dbSNicholas Bellinger static match_table_t tokens = { 443c66ac9dbSNicholas Bellinger {Opt_fd_dev_name, "fd_dev_name=%s"}, 444c66ac9dbSNicholas Bellinger {Opt_fd_dev_size, "fd_dev_size=%s"}, 44558c3e647SNicholas Bellinger {Opt_fd_buffered_io, "fd_buffered_io=%d"}, 446c66ac9dbSNicholas Bellinger {Opt_err, NULL} 447c66ac9dbSNicholas Bellinger }; 448c66ac9dbSNicholas Bellinger 449c66ac9dbSNicholas Bellinger static ssize_t fd_set_configfs_dev_params( 450c66ac9dbSNicholas Bellinger struct se_hba *hba, 451c66ac9dbSNicholas Bellinger struct se_subsystem_dev *se_dev, 452c66ac9dbSNicholas Bellinger const char *page, ssize_t count) 453c66ac9dbSNicholas Bellinger { 454c66ac9dbSNicholas Bellinger struct fd_dev *fd_dev = se_dev->se_dev_su_ptr; 455c66ac9dbSNicholas Bellinger char *orig, *ptr, *arg_p, *opts; 456c66ac9dbSNicholas Bellinger substring_t args[MAX_OPT_ARGS]; 457c66ac9dbSNicholas Bellinger int ret = 0, arg, token; 458c66ac9dbSNicholas Bellinger 459c66ac9dbSNicholas Bellinger opts = kstrdup(page, GFP_KERNEL); 460c66ac9dbSNicholas Bellinger if (!opts) 461c66ac9dbSNicholas Bellinger return -ENOMEM; 462c66ac9dbSNicholas Bellinger 463c66ac9dbSNicholas Bellinger orig = opts; 464c66ac9dbSNicholas Bellinger 46590c161b6SSebastian Andrzej Siewior while ((ptr = strsep(&opts, ",\n")) != NULL) { 466c66ac9dbSNicholas Bellinger if (!*ptr) 467c66ac9dbSNicholas Bellinger continue; 468c66ac9dbSNicholas Bellinger 469c66ac9dbSNicholas Bellinger token = match_token(ptr, tokens, args); 470c66ac9dbSNicholas Bellinger switch (token) { 471c66ac9dbSNicholas Bellinger case Opt_fd_dev_name: 4726d180253SJesper Juhl arg_p = match_strdup(&args[0]); 4736d180253SJesper Juhl if (!arg_p) { 4746d180253SJesper Juhl ret = -ENOMEM; 4756d180253SJesper Juhl break; 4766d180253SJesper Juhl } 477c66ac9dbSNicholas Bellinger snprintf(fd_dev->fd_dev_name, FD_MAX_DEV_NAME, 4786d180253SJesper Juhl "%s", arg_p); 4796d180253SJesper Juhl kfree(arg_p); 4806708bb27SAndy Grover pr_debug("FILEIO: Referencing Path: %s\n", 481c66ac9dbSNicholas Bellinger fd_dev->fd_dev_name); 482c66ac9dbSNicholas Bellinger fd_dev->fbd_flags |= FBDF_HAS_PATH; 483c66ac9dbSNicholas Bellinger break; 484c66ac9dbSNicholas Bellinger case Opt_fd_dev_size: 485c66ac9dbSNicholas Bellinger arg_p = match_strdup(&args[0]); 4866d180253SJesper Juhl if (!arg_p) { 4876d180253SJesper Juhl ret = -ENOMEM; 4886d180253SJesper Juhl break; 4896d180253SJesper Juhl } 490c66ac9dbSNicholas Bellinger ret = strict_strtoull(arg_p, 0, &fd_dev->fd_dev_size); 4916d180253SJesper Juhl kfree(arg_p); 492c66ac9dbSNicholas Bellinger if (ret < 0) { 4936708bb27SAndy Grover pr_err("strict_strtoull() failed for" 494c66ac9dbSNicholas Bellinger " fd_dev_size=\n"); 495c66ac9dbSNicholas Bellinger goto out; 496c66ac9dbSNicholas Bellinger } 4976708bb27SAndy Grover pr_debug("FILEIO: Referencing Size: %llu" 498c66ac9dbSNicholas Bellinger " bytes\n", fd_dev->fd_dev_size); 499c66ac9dbSNicholas Bellinger fd_dev->fbd_flags |= FBDF_HAS_SIZE; 500c66ac9dbSNicholas Bellinger break; 501c66ac9dbSNicholas Bellinger case Opt_fd_buffered_io: 502c66ac9dbSNicholas Bellinger match_int(args, &arg); 503c66ac9dbSNicholas Bellinger if (arg != 1) { 5046708bb27SAndy Grover pr_err("bogus fd_buffered_io=%d value\n", arg); 505c66ac9dbSNicholas Bellinger ret = -EINVAL; 506c66ac9dbSNicholas Bellinger goto out; 507c66ac9dbSNicholas Bellinger } 508c66ac9dbSNicholas Bellinger 5096708bb27SAndy Grover pr_debug("FILEIO: Using buffered I/O" 510c66ac9dbSNicholas Bellinger " operations for struct fd_dev\n"); 511c66ac9dbSNicholas Bellinger 512c66ac9dbSNicholas Bellinger fd_dev->fbd_flags |= FDBD_USE_BUFFERED_IO; 513c66ac9dbSNicholas Bellinger break; 514c66ac9dbSNicholas Bellinger default: 515c66ac9dbSNicholas Bellinger break; 516c66ac9dbSNicholas Bellinger } 517c66ac9dbSNicholas Bellinger } 518c66ac9dbSNicholas Bellinger 519c66ac9dbSNicholas Bellinger out: 520c66ac9dbSNicholas Bellinger kfree(orig); 521c66ac9dbSNicholas Bellinger return (!ret) ? count : ret; 522c66ac9dbSNicholas Bellinger } 523c66ac9dbSNicholas Bellinger 524c66ac9dbSNicholas Bellinger static ssize_t fd_check_configfs_dev_params(struct se_hba *hba, struct se_subsystem_dev *se_dev) 525c66ac9dbSNicholas Bellinger { 5268359cf43SJörn Engel struct fd_dev *fd_dev = se_dev->se_dev_su_ptr; 527c66ac9dbSNicholas Bellinger 528c66ac9dbSNicholas Bellinger if (!(fd_dev->fbd_flags & FBDF_HAS_PATH)) { 5296708bb27SAndy Grover pr_err("Missing fd_dev_name=\n"); 530e3d6f909SAndy Grover return -EINVAL; 531c66ac9dbSNicholas Bellinger } 532c66ac9dbSNicholas Bellinger 533c66ac9dbSNicholas Bellinger return 0; 534c66ac9dbSNicholas Bellinger } 535c66ac9dbSNicholas Bellinger 536c66ac9dbSNicholas Bellinger static ssize_t fd_show_configfs_dev_params( 537c66ac9dbSNicholas Bellinger struct se_hba *hba, 538c66ac9dbSNicholas Bellinger struct se_subsystem_dev *se_dev, 539c66ac9dbSNicholas Bellinger char *b) 540c66ac9dbSNicholas Bellinger { 541c66ac9dbSNicholas Bellinger struct fd_dev *fd_dev = se_dev->se_dev_su_ptr; 542c66ac9dbSNicholas Bellinger ssize_t bl = 0; 543c66ac9dbSNicholas Bellinger 544c66ac9dbSNicholas Bellinger bl = sprintf(b + bl, "TCM FILEIO ID: %u", fd_dev->fd_dev_id); 545c66ac9dbSNicholas Bellinger bl += sprintf(b + bl, " File: %s Size: %llu Mode: %s\n", 546c66ac9dbSNicholas Bellinger fd_dev->fd_dev_name, fd_dev->fd_dev_size, 547c66ac9dbSNicholas Bellinger (fd_dev->fbd_flags & FDBD_USE_BUFFERED_IO) ? 548c66ac9dbSNicholas Bellinger "Buffered" : "Synchronous"); 549c66ac9dbSNicholas Bellinger return bl; 550c66ac9dbSNicholas Bellinger } 551c66ac9dbSNicholas Bellinger 552c66ac9dbSNicholas Bellinger /* fd_get_device_rev(): (Part of se_subsystem_api_t template) 553c66ac9dbSNicholas Bellinger * 554c66ac9dbSNicholas Bellinger * 555c66ac9dbSNicholas Bellinger */ 556c66ac9dbSNicholas Bellinger static u32 fd_get_device_rev(struct se_device *dev) 557c66ac9dbSNicholas Bellinger { 558c66ac9dbSNicholas Bellinger return SCSI_SPC_2; /* Returns SPC-3 in Initiator Data */ 559c66ac9dbSNicholas Bellinger } 560c66ac9dbSNicholas Bellinger 561c66ac9dbSNicholas Bellinger /* fd_get_device_type(): (Part of se_subsystem_api_t template) 562c66ac9dbSNicholas Bellinger * 563c66ac9dbSNicholas Bellinger * 564c66ac9dbSNicholas Bellinger */ 565c66ac9dbSNicholas Bellinger static u32 fd_get_device_type(struct se_device *dev) 566c66ac9dbSNicholas Bellinger { 567c66ac9dbSNicholas Bellinger return TYPE_DISK; 568c66ac9dbSNicholas Bellinger } 569c66ac9dbSNicholas Bellinger 570c66ac9dbSNicholas Bellinger static sector_t fd_get_blocks(struct se_device *dev) 571c66ac9dbSNicholas Bellinger { 572c66ac9dbSNicholas Bellinger struct fd_dev *fd_dev = dev->dev_ptr; 573c66ac9dbSNicholas Bellinger unsigned long long blocks_long = div_u64(fd_dev->fd_dev_size, 574e3d6f909SAndy Grover dev->se_sub_dev->se_dev_attrib.block_size); 575c66ac9dbSNicholas Bellinger 576c66ac9dbSNicholas Bellinger return blocks_long; 577c66ac9dbSNicholas Bellinger } 578c66ac9dbSNicholas Bellinger 579c66ac9dbSNicholas Bellinger static struct se_subsystem_api fileio_template = { 580c66ac9dbSNicholas Bellinger .name = "fileio", 581c66ac9dbSNicholas Bellinger .owner = THIS_MODULE, 582c66ac9dbSNicholas Bellinger .transport_type = TRANSPORT_PLUGIN_VHBA_PDEV, 583f55918faSChristoph Hellwig .write_cache_emulated = 1, 584f55918faSChristoph Hellwig .fua_write_emulated = 1, 585c66ac9dbSNicholas Bellinger .attach_hba = fd_attach_hba, 586c66ac9dbSNicholas Bellinger .detach_hba = fd_detach_hba, 587c66ac9dbSNicholas Bellinger .allocate_virtdevice = fd_allocate_virtdevice, 588c66ac9dbSNicholas Bellinger .create_virtdevice = fd_create_virtdevice, 589c66ac9dbSNicholas Bellinger .free_device = fd_free_device, 5905787cacdSChristoph Hellwig .execute_cmd = fd_execute_cmd, 591c66ac9dbSNicholas Bellinger .do_sync_cache = fd_emulate_sync_cache, 592c66ac9dbSNicholas Bellinger .check_configfs_dev_params = fd_check_configfs_dev_params, 593c66ac9dbSNicholas Bellinger .set_configfs_dev_params = fd_set_configfs_dev_params, 594c66ac9dbSNicholas Bellinger .show_configfs_dev_params = fd_show_configfs_dev_params, 595c66ac9dbSNicholas Bellinger .get_device_rev = fd_get_device_rev, 596c66ac9dbSNicholas Bellinger .get_device_type = fd_get_device_type, 597c66ac9dbSNicholas Bellinger .get_blocks = fd_get_blocks, 598c66ac9dbSNicholas Bellinger }; 599c66ac9dbSNicholas Bellinger 600c66ac9dbSNicholas Bellinger static int __init fileio_module_init(void) 601c66ac9dbSNicholas Bellinger { 602c66ac9dbSNicholas Bellinger return transport_subsystem_register(&fileio_template); 603c66ac9dbSNicholas Bellinger } 604c66ac9dbSNicholas Bellinger 605c66ac9dbSNicholas Bellinger static void fileio_module_exit(void) 606c66ac9dbSNicholas Bellinger { 607c66ac9dbSNicholas Bellinger transport_subsystem_release(&fileio_template); 608c66ac9dbSNicholas Bellinger } 609c66ac9dbSNicholas Bellinger 610c66ac9dbSNicholas Bellinger MODULE_DESCRIPTION("TCM FILEIO subsystem plugin"); 611c66ac9dbSNicholas Bellinger MODULE_AUTHOR("nab@Linux-iSCSI.org"); 612c66ac9dbSNicholas Bellinger MODULE_LICENSE("GPL"); 613c66ac9dbSNicholas Bellinger 614c66ac9dbSNicholas Bellinger module_init(fileio_module_init); 615c66ac9dbSNicholas Bellinger module_exit(fileio_module_exit); 616