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 247c66ac9dbSNicholas Bellinger static inline struct fd_request *FILE_REQ(struct se_task *task) 248c66ac9dbSNicholas Bellinger { 249c66ac9dbSNicholas Bellinger return container_of(task, struct fd_request, fd_task); 250c66ac9dbSNicholas Bellinger } 251c66ac9dbSNicholas Bellinger 252c66ac9dbSNicholas Bellinger 253c66ac9dbSNicholas Bellinger static struct se_task * 2546708bb27SAndy Grover fd_alloc_task(unsigned char *cdb) 255c66ac9dbSNicholas Bellinger { 256c66ac9dbSNicholas Bellinger struct fd_request *fd_req; 257c66ac9dbSNicholas Bellinger 258c66ac9dbSNicholas Bellinger fd_req = kzalloc(sizeof(struct fd_request), GFP_KERNEL); 2596708bb27SAndy Grover if (!fd_req) { 2606708bb27SAndy Grover pr_err("Unable to allocate struct fd_request\n"); 261c66ac9dbSNicholas Bellinger return NULL; 262c66ac9dbSNicholas Bellinger } 263c66ac9dbSNicholas Bellinger 264c66ac9dbSNicholas Bellinger return &fd_req->fd_task; 265c66ac9dbSNicholas Bellinger } 266c66ac9dbSNicholas Bellinger 267c66ac9dbSNicholas Bellinger static int fd_do_readv(struct se_task *task) 268c66ac9dbSNicholas Bellinger { 269c66ac9dbSNicholas Bellinger struct fd_request *req = FILE_REQ(task); 27042bf829eSChristoph Hellwig struct se_device *se_dev = req->fd_task.task_se_cmd->se_dev; 27142bf829eSChristoph Hellwig struct fd_dev *dev = se_dev->dev_ptr; 2726708bb27SAndy Grover struct file *fd = dev->fd_file; 273c66ac9dbSNicholas Bellinger struct scatterlist *sg = task->task_sg; 274c66ac9dbSNicholas Bellinger struct iovec *iov; 275c66ac9dbSNicholas Bellinger mm_segment_t old_fs; 27672a0e5e2SChristoph Hellwig loff_t pos = (task->task_se_cmd->t_task_lba * 27742bf829eSChristoph Hellwig se_dev->se_sub_dev->se_dev_attrib.block_size); 278c66ac9dbSNicholas Bellinger int ret = 0, i; 279c66ac9dbSNicholas Bellinger 2806708bb27SAndy Grover iov = kzalloc(sizeof(struct iovec) * task->task_sg_nents, GFP_KERNEL); 2816708bb27SAndy Grover if (!iov) { 2826708bb27SAndy Grover pr_err("Unable to allocate fd_do_readv iov[]\n"); 283e3d6f909SAndy Grover return -ENOMEM; 284c66ac9dbSNicholas Bellinger } 285c66ac9dbSNicholas Bellinger 2869649fa1bSSebastian Andrzej Siewior for_each_sg(task->task_sg, sg, task->task_sg_nents, i) { 2879649fa1bSSebastian Andrzej Siewior iov[i].iov_len = sg->length; 2889649fa1bSSebastian Andrzej Siewior iov[i].iov_base = sg_virt(sg); 289c66ac9dbSNicholas Bellinger } 290c66ac9dbSNicholas Bellinger 291c66ac9dbSNicholas Bellinger old_fs = get_fs(); 292c66ac9dbSNicholas Bellinger set_fs(get_ds()); 2936708bb27SAndy Grover ret = vfs_readv(fd, &iov[0], task->task_sg_nents, &pos); 294c66ac9dbSNicholas Bellinger set_fs(old_fs); 295c66ac9dbSNicholas Bellinger 296c66ac9dbSNicholas Bellinger kfree(iov); 297c66ac9dbSNicholas Bellinger /* 298c66ac9dbSNicholas Bellinger * Return zeros and GOOD status even if the READ did not return 299c66ac9dbSNicholas Bellinger * the expected virt_size for struct file w/o a backing struct 300c66ac9dbSNicholas Bellinger * block_device. 301c66ac9dbSNicholas Bellinger */ 302c66ac9dbSNicholas Bellinger if (S_ISBLK(fd->f_dentry->d_inode->i_mode)) { 303c66ac9dbSNicholas Bellinger if (ret < 0 || ret != task->task_size) { 3046708bb27SAndy Grover pr_err("vfs_readv() returned %d," 305c66ac9dbSNicholas Bellinger " expecting %d for S_ISBLK\n", ret, 306c66ac9dbSNicholas Bellinger (int)task->task_size); 307e3d6f909SAndy Grover return (ret < 0 ? ret : -EINVAL); 308c66ac9dbSNicholas Bellinger } 309c66ac9dbSNicholas Bellinger } else { 310c66ac9dbSNicholas Bellinger if (ret < 0) { 3116708bb27SAndy Grover pr_err("vfs_readv() returned %d for non" 312c66ac9dbSNicholas Bellinger " S_ISBLK\n", ret); 313e3d6f909SAndy Grover return ret; 314c66ac9dbSNicholas Bellinger } 315c66ac9dbSNicholas Bellinger } 316c66ac9dbSNicholas Bellinger 317c66ac9dbSNicholas Bellinger return 1; 318c66ac9dbSNicholas Bellinger } 319c66ac9dbSNicholas Bellinger 320c66ac9dbSNicholas Bellinger static int fd_do_writev(struct se_task *task) 321c66ac9dbSNicholas Bellinger { 322c66ac9dbSNicholas Bellinger struct fd_request *req = FILE_REQ(task); 32342bf829eSChristoph Hellwig struct se_device *se_dev = req->fd_task.task_se_cmd->se_dev; 32442bf829eSChristoph Hellwig struct fd_dev *dev = se_dev->dev_ptr; 3256708bb27SAndy Grover struct file *fd = dev->fd_file; 326c66ac9dbSNicholas Bellinger struct scatterlist *sg = task->task_sg; 327c66ac9dbSNicholas Bellinger struct iovec *iov; 328c66ac9dbSNicholas Bellinger mm_segment_t old_fs; 32972a0e5e2SChristoph Hellwig loff_t pos = (task->task_se_cmd->t_task_lba * 33042bf829eSChristoph Hellwig se_dev->se_sub_dev->se_dev_attrib.block_size); 331c66ac9dbSNicholas Bellinger int ret, i = 0; 332c66ac9dbSNicholas Bellinger 3336708bb27SAndy Grover iov = kzalloc(sizeof(struct iovec) * task->task_sg_nents, GFP_KERNEL); 3346708bb27SAndy Grover if (!iov) { 3356708bb27SAndy Grover pr_err("Unable to allocate fd_do_writev iov[]\n"); 336e3d6f909SAndy Grover return -ENOMEM; 337c66ac9dbSNicholas Bellinger } 338c66ac9dbSNicholas Bellinger 3399649fa1bSSebastian Andrzej Siewior for_each_sg(task->task_sg, sg, task->task_sg_nents, i) { 3409649fa1bSSebastian Andrzej Siewior iov[i].iov_len = sg->length; 3419649fa1bSSebastian Andrzej Siewior iov[i].iov_base = sg_virt(sg); 342c66ac9dbSNicholas Bellinger } 343c66ac9dbSNicholas Bellinger 344c66ac9dbSNicholas Bellinger old_fs = get_fs(); 345c66ac9dbSNicholas Bellinger set_fs(get_ds()); 3466708bb27SAndy Grover ret = vfs_writev(fd, &iov[0], task->task_sg_nents, &pos); 347c66ac9dbSNicholas Bellinger set_fs(old_fs); 348c66ac9dbSNicholas Bellinger 349c66ac9dbSNicholas Bellinger kfree(iov); 350c66ac9dbSNicholas Bellinger 351c66ac9dbSNicholas Bellinger if (ret < 0 || ret != task->task_size) { 3526708bb27SAndy Grover pr_err("vfs_writev() returned %d\n", ret); 353e3d6f909SAndy Grover return (ret < 0 ? ret : -EINVAL); 354c66ac9dbSNicholas Bellinger } 355c66ac9dbSNicholas Bellinger 356c66ac9dbSNicholas Bellinger return 1; 357c66ac9dbSNicholas Bellinger } 358c66ac9dbSNicholas Bellinger 359c66ac9dbSNicholas Bellinger static void fd_emulate_sync_cache(struct se_task *task) 360c66ac9dbSNicholas Bellinger { 361e3d6f909SAndy Grover struct se_cmd *cmd = task->task_se_cmd; 362c66ac9dbSNicholas Bellinger struct se_device *dev = cmd->se_dev; 363c66ac9dbSNicholas Bellinger struct fd_dev *fd_dev = dev->dev_ptr; 364a1d8b49aSAndy Grover int immed = (cmd->t_task_cdb[1] & 0x2); 365c66ac9dbSNicholas Bellinger loff_t start, end; 366c66ac9dbSNicholas Bellinger int ret; 367c66ac9dbSNicholas Bellinger 368c66ac9dbSNicholas Bellinger /* 369c66ac9dbSNicholas Bellinger * If the Immediate bit is set, queue up the GOOD response 370c66ac9dbSNicholas Bellinger * for this SYNCHRONIZE_CACHE op 371c66ac9dbSNicholas Bellinger */ 372c66ac9dbSNicholas Bellinger if (immed) 373c66ac9dbSNicholas Bellinger transport_complete_sync_cache(cmd, 1); 374c66ac9dbSNicholas Bellinger 375c66ac9dbSNicholas Bellinger /* 376c66ac9dbSNicholas Bellinger * Determine if we will be flushing the entire device. 377c66ac9dbSNicholas Bellinger */ 378a1d8b49aSAndy Grover if (cmd->t_task_lba == 0 && cmd->data_length == 0) { 379c66ac9dbSNicholas Bellinger start = 0; 380c66ac9dbSNicholas Bellinger end = LLONG_MAX; 381c66ac9dbSNicholas Bellinger } else { 382a1d8b49aSAndy Grover start = cmd->t_task_lba * dev->se_sub_dev->se_dev_attrib.block_size; 383c66ac9dbSNicholas Bellinger if (cmd->data_length) 384c66ac9dbSNicholas Bellinger end = start + cmd->data_length; 385c66ac9dbSNicholas Bellinger else 386c66ac9dbSNicholas Bellinger end = LLONG_MAX; 387c66ac9dbSNicholas Bellinger } 388c66ac9dbSNicholas Bellinger 389c66ac9dbSNicholas Bellinger ret = vfs_fsync_range(fd_dev->fd_file, start, end, 1); 390c66ac9dbSNicholas Bellinger if (ret != 0) 3916708bb27SAndy Grover pr_err("FILEIO: vfs_fsync_range() failed: %d\n", ret); 392c66ac9dbSNicholas Bellinger 393c66ac9dbSNicholas Bellinger if (!immed) 394c66ac9dbSNicholas Bellinger transport_complete_sync_cache(cmd, ret == 0); 395c66ac9dbSNicholas Bellinger } 396c66ac9dbSNicholas Bellinger 397c66ac9dbSNicholas Bellinger /* 398c66ac9dbSNicholas Bellinger * WRITE Force Unit Access (FUA) emulation on a per struct se_task 399c66ac9dbSNicholas Bellinger * LBA range basis.. 400c66ac9dbSNicholas Bellinger */ 401c66ac9dbSNicholas Bellinger static void fd_emulate_write_fua(struct se_cmd *cmd, struct se_task *task) 402c66ac9dbSNicholas Bellinger { 403c66ac9dbSNicholas Bellinger struct se_device *dev = cmd->se_dev; 404c66ac9dbSNicholas Bellinger struct fd_dev *fd_dev = dev->dev_ptr; 40572a0e5e2SChristoph Hellwig loff_t start = task->task_se_cmd->t_task_lba * 40672a0e5e2SChristoph Hellwig dev->se_sub_dev->se_dev_attrib.block_size; 407c66ac9dbSNicholas Bellinger loff_t end = start + task->task_size; 408c66ac9dbSNicholas Bellinger int ret; 409c66ac9dbSNicholas Bellinger 4106708bb27SAndy Grover pr_debug("FILEIO: FUA WRITE LBA: %llu, bytes: %u\n", 41172a0e5e2SChristoph Hellwig task->task_se_cmd->t_task_lba, task->task_size); 412c66ac9dbSNicholas Bellinger 413c66ac9dbSNicholas Bellinger ret = vfs_fsync_range(fd_dev->fd_file, start, end, 1); 414c66ac9dbSNicholas Bellinger if (ret != 0) 4156708bb27SAndy Grover pr_err("FILEIO: vfs_fsync_range() failed: %d\n", ret); 416c66ac9dbSNicholas Bellinger } 417c66ac9dbSNicholas Bellinger 418c66ac9dbSNicholas Bellinger static int fd_do_task(struct se_task *task) 419c66ac9dbSNicholas Bellinger { 420c66ac9dbSNicholas Bellinger struct se_cmd *cmd = task->task_se_cmd; 421c66ac9dbSNicholas Bellinger struct se_device *dev = cmd->se_dev; 422c66ac9dbSNicholas Bellinger int ret = 0; 423c66ac9dbSNicholas Bellinger 424c66ac9dbSNicholas Bellinger /* 425c66ac9dbSNicholas Bellinger * Call vectorized fileio functions to map struct scatterlist 426c66ac9dbSNicholas Bellinger * physical memory addresses to struct iovec virtual memory. 427c66ac9dbSNicholas Bellinger */ 428c66ac9dbSNicholas Bellinger if (task->task_data_direction == DMA_FROM_DEVICE) { 429c66ac9dbSNicholas Bellinger ret = fd_do_readv(task); 430c66ac9dbSNicholas Bellinger } else { 431c66ac9dbSNicholas Bellinger ret = fd_do_writev(task); 432c66ac9dbSNicholas Bellinger 433c66ac9dbSNicholas Bellinger if (ret > 0 && 434e3d6f909SAndy Grover dev->se_sub_dev->se_dev_attrib.emulate_write_cache > 0 && 435e3d6f909SAndy Grover dev->se_sub_dev->se_dev_attrib.emulate_fua_write > 0 && 4362d3a4b51SChristoph Hellwig (cmd->se_cmd_flags & SCF_FUA)) { 437c66ac9dbSNicholas Bellinger /* 438c66ac9dbSNicholas Bellinger * We might need to be a bit smarter here 439c66ac9dbSNicholas Bellinger * and return some sense data to let the initiator 440c66ac9dbSNicholas Bellinger * know the FUA WRITE cache sync failed..? 441c66ac9dbSNicholas Bellinger */ 442c66ac9dbSNicholas Bellinger fd_emulate_write_fua(cmd, task); 443c66ac9dbSNicholas Bellinger } 444c66ac9dbSNicholas Bellinger 445c66ac9dbSNicholas Bellinger } 446c66ac9dbSNicholas Bellinger 44703e98c9eSNicholas Bellinger if (ret < 0) { 44803e98c9eSNicholas Bellinger cmd->scsi_sense_reason = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE; 449c66ac9dbSNicholas Bellinger return ret; 45003e98c9eSNicholas Bellinger } 451c66ac9dbSNicholas Bellinger if (ret) { 452c66ac9dbSNicholas Bellinger task->task_scsi_status = GOOD; 453c66ac9dbSNicholas Bellinger transport_complete_task(task, 1); 454c66ac9dbSNicholas Bellinger } 45503e98c9eSNicholas Bellinger return 0; 456c66ac9dbSNicholas Bellinger } 457c66ac9dbSNicholas Bellinger 458c66ac9dbSNicholas Bellinger /* fd_free_task(): (Part of se_subsystem_api_t template) 459c66ac9dbSNicholas Bellinger * 460c66ac9dbSNicholas Bellinger * 461c66ac9dbSNicholas Bellinger */ 462c66ac9dbSNicholas Bellinger static void fd_free_task(struct se_task *task) 463c66ac9dbSNicholas Bellinger { 464c66ac9dbSNicholas Bellinger struct fd_request *req = FILE_REQ(task); 465c66ac9dbSNicholas Bellinger 466c66ac9dbSNicholas Bellinger kfree(req); 467c66ac9dbSNicholas Bellinger } 468c66ac9dbSNicholas Bellinger 469c66ac9dbSNicholas Bellinger enum { 470c66ac9dbSNicholas Bellinger Opt_fd_dev_name, Opt_fd_dev_size, Opt_fd_buffered_io, Opt_err 471c66ac9dbSNicholas Bellinger }; 472c66ac9dbSNicholas Bellinger 473c66ac9dbSNicholas Bellinger static match_table_t tokens = { 474c66ac9dbSNicholas Bellinger {Opt_fd_dev_name, "fd_dev_name=%s"}, 475c66ac9dbSNicholas Bellinger {Opt_fd_dev_size, "fd_dev_size=%s"}, 47658c3e647SNicholas Bellinger {Opt_fd_buffered_io, "fd_buffered_io=%d"}, 477c66ac9dbSNicholas Bellinger {Opt_err, NULL} 478c66ac9dbSNicholas Bellinger }; 479c66ac9dbSNicholas Bellinger 480c66ac9dbSNicholas Bellinger static ssize_t fd_set_configfs_dev_params( 481c66ac9dbSNicholas Bellinger struct se_hba *hba, 482c66ac9dbSNicholas Bellinger struct se_subsystem_dev *se_dev, 483c66ac9dbSNicholas Bellinger const char *page, ssize_t count) 484c66ac9dbSNicholas Bellinger { 485c66ac9dbSNicholas Bellinger struct fd_dev *fd_dev = se_dev->se_dev_su_ptr; 486c66ac9dbSNicholas Bellinger char *orig, *ptr, *arg_p, *opts; 487c66ac9dbSNicholas Bellinger substring_t args[MAX_OPT_ARGS]; 488c66ac9dbSNicholas Bellinger int ret = 0, arg, token; 489c66ac9dbSNicholas Bellinger 490c66ac9dbSNicholas Bellinger opts = kstrdup(page, GFP_KERNEL); 491c66ac9dbSNicholas Bellinger if (!opts) 492c66ac9dbSNicholas Bellinger return -ENOMEM; 493c66ac9dbSNicholas Bellinger 494c66ac9dbSNicholas Bellinger orig = opts; 495c66ac9dbSNicholas Bellinger 49690c161b6SSebastian Andrzej Siewior while ((ptr = strsep(&opts, ",\n")) != NULL) { 497c66ac9dbSNicholas Bellinger if (!*ptr) 498c66ac9dbSNicholas Bellinger continue; 499c66ac9dbSNicholas Bellinger 500c66ac9dbSNicholas Bellinger token = match_token(ptr, tokens, args); 501c66ac9dbSNicholas Bellinger switch (token) { 502c66ac9dbSNicholas Bellinger case Opt_fd_dev_name: 5036d180253SJesper Juhl arg_p = match_strdup(&args[0]); 5046d180253SJesper Juhl if (!arg_p) { 5056d180253SJesper Juhl ret = -ENOMEM; 5066d180253SJesper Juhl break; 5076d180253SJesper Juhl } 508c66ac9dbSNicholas Bellinger snprintf(fd_dev->fd_dev_name, FD_MAX_DEV_NAME, 5096d180253SJesper Juhl "%s", arg_p); 5106d180253SJesper Juhl kfree(arg_p); 5116708bb27SAndy Grover pr_debug("FILEIO: Referencing Path: %s\n", 512c66ac9dbSNicholas Bellinger fd_dev->fd_dev_name); 513c66ac9dbSNicholas Bellinger fd_dev->fbd_flags |= FBDF_HAS_PATH; 514c66ac9dbSNicholas Bellinger break; 515c66ac9dbSNicholas Bellinger case Opt_fd_dev_size: 516c66ac9dbSNicholas Bellinger arg_p = match_strdup(&args[0]); 5176d180253SJesper Juhl if (!arg_p) { 5186d180253SJesper Juhl ret = -ENOMEM; 5196d180253SJesper Juhl break; 5206d180253SJesper Juhl } 521c66ac9dbSNicholas Bellinger ret = strict_strtoull(arg_p, 0, &fd_dev->fd_dev_size); 5226d180253SJesper Juhl kfree(arg_p); 523c66ac9dbSNicholas Bellinger if (ret < 0) { 5246708bb27SAndy Grover pr_err("strict_strtoull() failed for" 525c66ac9dbSNicholas Bellinger " fd_dev_size=\n"); 526c66ac9dbSNicholas Bellinger goto out; 527c66ac9dbSNicholas Bellinger } 5286708bb27SAndy Grover pr_debug("FILEIO: Referencing Size: %llu" 529c66ac9dbSNicholas Bellinger " bytes\n", fd_dev->fd_dev_size); 530c66ac9dbSNicholas Bellinger fd_dev->fbd_flags |= FBDF_HAS_SIZE; 531c66ac9dbSNicholas Bellinger break; 532c66ac9dbSNicholas Bellinger case Opt_fd_buffered_io: 533c66ac9dbSNicholas Bellinger match_int(args, &arg); 534c66ac9dbSNicholas Bellinger if (arg != 1) { 5356708bb27SAndy Grover pr_err("bogus fd_buffered_io=%d value\n", arg); 536c66ac9dbSNicholas Bellinger ret = -EINVAL; 537c66ac9dbSNicholas Bellinger goto out; 538c66ac9dbSNicholas Bellinger } 539c66ac9dbSNicholas Bellinger 5406708bb27SAndy Grover pr_debug("FILEIO: Using buffered I/O" 541c66ac9dbSNicholas Bellinger " operations for struct fd_dev\n"); 542c66ac9dbSNicholas Bellinger 543c66ac9dbSNicholas Bellinger fd_dev->fbd_flags |= FDBD_USE_BUFFERED_IO; 544c66ac9dbSNicholas Bellinger break; 545c66ac9dbSNicholas Bellinger default: 546c66ac9dbSNicholas Bellinger break; 547c66ac9dbSNicholas Bellinger } 548c66ac9dbSNicholas Bellinger } 549c66ac9dbSNicholas Bellinger 550c66ac9dbSNicholas Bellinger out: 551c66ac9dbSNicholas Bellinger kfree(orig); 552c66ac9dbSNicholas Bellinger return (!ret) ? count : ret; 553c66ac9dbSNicholas Bellinger } 554c66ac9dbSNicholas Bellinger 555c66ac9dbSNicholas Bellinger static ssize_t fd_check_configfs_dev_params(struct se_hba *hba, struct se_subsystem_dev *se_dev) 556c66ac9dbSNicholas Bellinger { 5578359cf43SJörn Engel struct fd_dev *fd_dev = se_dev->se_dev_su_ptr; 558c66ac9dbSNicholas Bellinger 559c66ac9dbSNicholas Bellinger if (!(fd_dev->fbd_flags & FBDF_HAS_PATH)) { 5606708bb27SAndy Grover pr_err("Missing fd_dev_name=\n"); 561e3d6f909SAndy Grover return -EINVAL; 562c66ac9dbSNicholas Bellinger } 563c66ac9dbSNicholas Bellinger 564c66ac9dbSNicholas Bellinger return 0; 565c66ac9dbSNicholas Bellinger } 566c66ac9dbSNicholas Bellinger 567c66ac9dbSNicholas Bellinger static ssize_t fd_show_configfs_dev_params( 568c66ac9dbSNicholas Bellinger struct se_hba *hba, 569c66ac9dbSNicholas Bellinger struct se_subsystem_dev *se_dev, 570c66ac9dbSNicholas Bellinger char *b) 571c66ac9dbSNicholas Bellinger { 572c66ac9dbSNicholas Bellinger struct fd_dev *fd_dev = se_dev->se_dev_su_ptr; 573c66ac9dbSNicholas Bellinger ssize_t bl = 0; 574c66ac9dbSNicholas Bellinger 575c66ac9dbSNicholas Bellinger bl = sprintf(b + bl, "TCM FILEIO ID: %u", fd_dev->fd_dev_id); 576c66ac9dbSNicholas Bellinger bl += sprintf(b + bl, " File: %s Size: %llu Mode: %s\n", 577c66ac9dbSNicholas Bellinger fd_dev->fd_dev_name, fd_dev->fd_dev_size, 578c66ac9dbSNicholas Bellinger (fd_dev->fbd_flags & FDBD_USE_BUFFERED_IO) ? 579c66ac9dbSNicholas Bellinger "Buffered" : "Synchronous"); 580c66ac9dbSNicholas Bellinger return bl; 581c66ac9dbSNicholas Bellinger } 582c66ac9dbSNicholas Bellinger 583c66ac9dbSNicholas Bellinger /* fd_get_device_rev(): (Part of se_subsystem_api_t template) 584c66ac9dbSNicholas Bellinger * 585c66ac9dbSNicholas Bellinger * 586c66ac9dbSNicholas Bellinger */ 587c66ac9dbSNicholas Bellinger static u32 fd_get_device_rev(struct se_device *dev) 588c66ac9dbSNicholas Bellinger { 589c66ac9dbSNicholas Bellinger return SCSI_SPC_2; /* Returns SPC-3 in Initiator Data */ 590c66ac9dbSNicholas Bellinger } 591c66ac9dbSNicholas Bellinger 592c66ac9dbSNicholas Bellinger /* fd_get_device_type(): (Part of se_subsystem_api_t template) 593c66ac9dbSNicholas Bellinger * 594c66ac9dbSNicholas Bellinger * 595c66ac9dbSNicholas Bellinger */ 596c66ac9dbSNicholas Bellinger static u32 fd_get_device_type(struct se_device *dev) 597c66ac9dbSNicholas Bellinger { 598c66ac9dbSNicholas Bellinger return TYPE_DISK; 599c66ac9dbSNicholas Bellinger } 600c66ac9dbSNicholas Bellinger 601c66ac9dbSNicholas Bellinger static sector_t fd_get_blocks(struct se_device *dev) 602c66ac9dbSNicholas Bellinger { 603c66ac9dbSNicholas Bellinger struct fd_dev *fd_dev = dev->dev_ptr; 604c66ac9dbSNicholas Bellinger unsigned long long blocks_long = div_u64(fd_dev->fd_dev_size, 605e3d6f909SAndy Grover dev->se_sub_dev->se_dev_attrib.block_size); 606c66ac9dbSNicholas Bellinger 607c66ac9dbSNicholas Bellinger return blocks_long; 608c66ac9dbSNicholas Bellinger } 609c66ac9dbSNicholas Bellinger 610c66ac9dbSNicholas Bellinger static struct se_subsystem_api fileio_template = { 611c66ac9dbSNicholas Bellinger .name = "fileio", 612c66ac9dbSNicholas Bellinger .owner = THIS_MODULE, 613c66ac9dbSNicholas Bellinger .transport_type = TRANSPORT_PLUGIN_VHBA_PDEV, 614f55918faSChristoph Hellwig .write_cache_emulated = 1, 615f55918faSChristoph Hellwig .fua_write_emulated = 1, 616c66ac9dbSNicholas Bellinger .attach_hba = fd_attach_hba, 617c66ac9dbSNicholas Bellinger .detach_hba = fd_detach_hba, 618c66ac9dbSNicholas Bellinger .allocate_virtdevice = fd_allocate_virtdevice, 619c66ac9dbSNicholas Bellinger .create_virtdevice = fd_create_virtdevice, 620c66ac9dbSNicholas Bellinger .free_device = fd_free_device, 621c66ac9dbSNicholas Bellinger .alloc_task = fd_alloc_task, 622c66ac9dbSNicholas Bellinger .do_task = fd_do_task, 623c66ac9dbSNicholas Bellinger .do_sync_cache = fd_emulate_sync_cache, 624c66ac9dbSNicholas Bellinger .free_task = fd_free_task, 625c66ac9dbSNicholas Bellinger .check_configfs_dev_params = fd_check_configfs_dev_params, 626c66ac9dbSNicholas Bellinger .set_configfs_dev_params = fd_set_configfs_dev_params, 627c66ac9dbSNicholas Bellinger .show_configfs_dev_params = fd_show_configfs_dev_params, 628c66ac9dbSNicholas Bellinger .get_device_rev = fd_get_device_rev, 629c66ac9dbSNicholas Bellinger .get_device_type = fd_get_device_type, 630c66ac9dbSNicholas Bellinger .get_blocks = fd_get_blocks, 631c66ac9dbSNicholas Bellinger }; 632c66ac9dbSNicholas Bellinger 633c66ac9dbSNicholas Bellinger static int __init fileio_module_init(void) 634c66ac9dbSNicholas Bellinger { 635c66ac9dbSNicholas Bellinger return transport_subsystem_register(&fileio_template); 636c66ac9dbSNicholas Bellinger } 637c66ac9dbSNicholas Bellinger 638c66ac9dbSNicholas Bellinger static void fileio_module_exit(void) 639c66ac9dbSNicholas Bellinger { 640c66ac9dbSNicholas Bellinger transport_subsystem_release(&fileio_template); 641c66ac9dbSNicholas Bellinger } 642c66ac9dbSNicholas Bellinger 643c66ac9dbSNicholas Bellinger MODULE_DESCRIPTION("TCM FILEIO subsystem plugin"); 644c66ac9dbSNicholas Bellinger MODULE_AUTHOR("nab@Linux-iSCSI.org"); 645c66ac9dbSNicholas Bellinger MODULE_LICENSE("GPL"); 646c66ac9dbSNicholas Bellinger 647c66ac9dbSNicholas Bellinger module_init(fileio_module_init); 648c66ac9dbSNicholas Bellinger module_exit(fileio_module_exit); 649