blob: e1878bfd97b76e6fa0b47ab5c27a5e4c33cbee30 [file] [log] [blame]
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -08001/*******************************************************************************
2 * Filename: target_core_file.c
3 *
4 * This file contains the Storage Engine <-> FILEIO transport specific functions
5 *
Nicholas Bellingerfd9a11d2012-11-09 14:51:48 -08006 * (c) Copyright 2005-2012 RisingTide Systems LLC.
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -08007 *
8 * Nicholas A. Bellinger <nab@kernel.org>
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 *
24 ******************************************************************************/
25
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080026#include <linux/string.h>
27#include <linux/parser.h>
28#include <linux/timer.h>
29#include <linux/blkdev.h>
30#include <linux/slab.h>
31#include <linux/spinlock.h>
Paul Gortmaker827509e2011-08-30 14:20:44 -040032#include <linux/module.h>
Asias He70d3ae5c2013-02-25 14:03:42 +080033#include <linux/falloc.h>
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080034#include <scsi/scsi.h>
35#include <scsi/scsi_host.h>
36
37#include <target/target_core_base.h>
Christoph Hellwigc4795fb2011-11-16 09:46:48 -050038#include <target/target_core_backend.h>
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080039
40#include "target_core_file.h"
41
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -040042static inline struct fd_dev *FD_DEV(struct se_device *dev)
43{
44 return container_of(dev, struct fd_dev, dev);
45}
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080046
47/* fd_attach_hba(): (Part of se_subsystem_api_t template)
48 *
49 *
50 */
51static int fd_attach_hba(struct se_hba *hba, u32 host_id)
52{
53 struct fd_host *fd_host;
54
55 fd_host = kzalloc(sizeof(struct fd_host), GFP_KERNEL);
Andy Grover6708bb22011-06-08 10:36:43 -070056 if (!fd_host) {
57 pr_err("Unable to allocate memory for struct fd_host\n");
Andy Grovere3d6f902011-07-19 08:55:10 +000058 return -ENOMEM;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080059 }
60
61 fd_host->fd_host_id = host_id;
62
Andy Grovere3d6f902011-07-19 08:55:10 +000063 hba->hba_ptr = fd_host;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080064
Andy Grover6708bb22011-06-08 10:36:43 -070065 pr_debug("CORE_HBA[%d] - TCM FILEIO HBA Driver %s on Generic"
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080066 " Target Core Stack %s\n", hba->hba_id, FD_VERSION,
67 TARGET_CORE_MOD_VERSION);
Andy Grover6708bb22011-06-08 10:36:43 -070068 pr_debug("CORE_HBA[%d] - Attached FILEIO HBA: %u to Generic"
Andy Grovere3d6f902011-07-19 08:55:10 +000069 " MaxSectors: %u\n",
70 hba->hba_id, fd_host->fd_host_id, FD_MAX_SECTORS);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080071
72 return 0;
73}
74
75static void fd_detach_hba(struct se_hba *hba)
76{
77 struct fd_host *fd_host = hba->hba_ptr;
78
Andy Grover6708bb22011-06-08 10:36:43 -070079 pr_debug("CORE_HBA[%d] - Detached FILEIO HBA: %u from Generic"
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080080 " Target Core\n", hba->hba_id, fd_host->fd_host_id);
81
82 kfree(fd_host);
83 hba->hba_ptr = NULL;
84}
85
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -040086static struct se_device *fd_alloc_device(struct se_hba *hba, const char *name)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080087{
88 struct fd_dev *fd_dev;
Jörn Engel8359cf42011-11-24 02:05:51 +010089 struct fd_host *fd_host = hba->hba_ptr;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080090
91 fd_dev = kzalloc(sizeof(struct fd_dev), GFP_KERNEL);
Andy Grover6708bb22011-06-08 10:36:43 -070092 if (!fd_dev) {
93 pr_err("Unable to allocate memory for struct fd_dev\n");
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080094 return NULL;
95 }
96
97 fd_dev->fd_host = fd_host;
98
Andy Grover6708bb22011-06-08 10:36:43 -070099 pr_debug("FILEIO: Allocated fd_dev for %p\n", name);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800100
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400101 return &fd_dev->dev;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800102}
103
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400104static int fd_configure_device(struct se_device *dev)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800105{
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400106 struct fd_dev *fd_dev = FD_DEV(dev);
107 struct fd_host *fd_host = dev->se_hba->hba_ptr;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800108 struct file *file;
109 struct inode *inode = NULL;
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400110 int flags, ret = -EINVAL;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800111
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400112 if (!(fd_dev->fbd_flags & FBDF_HAS_PATH)) {
113 pr_err("Missing fd_dev_name=\n");
114 return -EINVAL;
115 }
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800116
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800117 /*
Nicholas Bellingera4dff302012-05-30 16:25:41 -0700118 * Use O_DSYNC by default instead of O_SYNC to forgo syncing
119 * of pure timestamp updates.
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800120 */
Nicholas Bellingera4dff302012-05-30 16:25:41 -0700121 flags = O_RDWR | O_CREAT | O_LARGEFILE | O_DSYNC;
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400122
Nicholas Bellingerb32f4c72012-09-29 17:15:37 -0700123 /*
124 * Optionally allow fd_buffered_io=1 to be enabled for people
125 * who want use the fs buffer cache as an WriteCache mechanism.
126 *
127 * This means that in event of a hard failure, there is a risk
128 * of silent data-loss if the SCSI client has *not* performed a
129 * forced unit access (FUA) write, or issued SYNCHRONIZE_CACHE
130 * to write-out the entire device cache.
131 */
132 if (fd_dev->fbd_flags & FDBD_HAS_BUFFERED_IO_WCE) {
133 pr_debug("FILEIO: Disabling O_DSYNC, using buffered FILEIO\n");
134 flags &= ~O_DSYNC;
135 }
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800136
Al Virodbc6e022012-08-01 13:07:04 +0400137 file = filp_open(fd_dev->fd_dev_name, flags, 0600);
Nicholas Bellinger613640e2011-03-14 04:05:59 -0700138 if (IS_ERR(file)) {
Al Virodbc6e022012-08-01 13:07:04 +0400139 pr_err("filp_open(%s) failed\n", fd_dev->fd_dev_name);
Nicholas Bellinger613640e2011-03-14 04:05:59 -0700140 ret = PTR_ERR(file);
141 goto fail;
142 }
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800143 fd_dev->fd_file = file;
144 /*
145 * If using a block backend with this struct file, we extract
146 * fd_dev->fd_[block,dev]_size from struct block_device.
147 *
148 * Otherwise, we use the passed fd_size= from configfs
149 */
150 inode = file->f_mapping->host;
151 if (S_ISBLK(inode->i_mode)) {
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400152 struct request_queue *q = bdev_get_queue(inode->i_bdev);
Nicholas Bellingercd9323f2012-05-16 16:05:26 -0700153 unsigned long long dev_size;
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400154
155 dev->dev_attrib.hw_block_size =
156 bdev_logical_block_size(inode->i_bdev);
157 dev->dev_attrib.hw_max_sectors = queue_max_hw_sectors(q);
158
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800159 /*
160 * Determine the number of bytes from i_size_read() minus
161 * one (1) logical sector from underlying struct block_device
162 */
Nicholas Bellingercd9323f2012-05-16 16:05:26 -0700163 dev_size = (i_size_read(file->f_mapping->host) -
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800164 fd_dev->fd_block_size);
165
Andy Grover6708bb22011-06-08 10:36:43 -0700166 pr_debug("FILEIO: Using size: %llu bytes from struct"
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800167 " block_device blocks: %llu logical_block_size: %d\n",
Nicholas Bellingercd9323f2012-05-16 16:05:26 -0700168 dev_size, div_u64(dev_size, fd_dev->fd_block_size),
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800169 fd_dev->fd_block_size);
Asias He70d3ae5c2013-02-25 14:03:42 +0800170 /*
171 * Check if the underlying struct block_device request_queue supports
172 * the QUEUE_FLAG_DISCARD bit for UNMAP/WRITE_SAME in SCSI + TRIM
173 * in ATA and we need to set TPE=1
174 */
175 if (blk_queue_discard(q)) {
176 dev->dev_attrib.max_unmap_lba_count =
177 q->limits.max_discard_sectors;
178 /*
179 * Currently hardcoded to 1 in Linux/SCSI code..
180 */
181 dev->dev_attrib.max_unmap_block_desc_count = 1;
182 dev->dev_attrib.unmap_granularity =
183 q->limits.discard_granularity >> 9;
184 dev->dev_attrib.unmap_granularity_alignment =
185 q->limits.discard_alignment;
186 pr_debug("IFILE: BLOCK Discard support available,"
187 " disabled by default\n");
188 }
189 /*
190 * Enable write same emulation for IBLOCK and use 0xFFFF as
191 * the smaller WRITE_SAME(10) only has a two-byte block count.
192 */
193 dev->dev_attrib.max_write_same_len = 0xFFFF;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800194 } else {
195 if (!(fd_dev->fbd_flags & FBDF_HAS_SIZE)) {
Andy Grover6708bb22011-06-08 10:36:43 -0700196 pr_err("FILEIO: Missing fd_dev_size="
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800197 " parameter, and no backing struct"
198 " block_device\n");
199 goto fail;
200 }
201
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400202 dev->dev_attrib.hw_block_size = FD_BLOCKSIZE;
203 dev->dev_attrib.hw_max_sectors = FD_MAX_SECTORS;
Asias He70d3ae5c2013-02-25 14:03:42 +0800204
205 /*
206 * Limit UNMAP emulation to 8k Number of LBAs (NoLB)
207 */
208 dev->dev_attrib.max_unmap_lba_count = 0x2000;
209 /*
210 * Currently hardcoded to 1 in Linux/SCSI code..
211 */
212 dev->dev_attrib.max_unmap_block_desc_count = 1;
213 dev->dev_attrib.unmap_granularity = 1;
214 dev->dev_attrib.unmap_granularity_alignment = 0;
215
216 /*
217 * Limit WRITE_SAME w/ UNMAP=0 emulation to 8k Number of LBAs (NoLB)
218 * based upon struct iovec limit for vfs_writev()
219 */
220 dev->dev_attrib.max_write_same_len = 0x1000;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800221 }
222
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400223 fd_dev->fd_block_size = dev->dev_attrib.hw_block_size;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800224
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400225 dev->dev_attrib.hw_queue_depth = FD_MAX_DEVICE_QUEUE_DEPTH;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800226
Nicholas Bellingerb32f4c72012-09-29 17:15:37 -0700227 if (fd_dev->fbd_flags & FDBD_HAS_BUFFERED_IO_WCE) {
228 pr_debug("FILEIO: Forcing setting of emulate_write_cache=1"
229 " with FDBD_HAS_BUFFERED_IO_WCE\n");
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400230 dev->dev_attrib.emulate_write_cache = 1;
Nicholas Bellingerb32f4c72012-09-29 17:15:37 -0700231 }
232
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800233 fd_dev->fd_dev_id = fd_host->fd_host_dev_id_count++;
234 fd_dev->fd_queue_depth = dev->queue_depth;
235
Andy Grover6708bb22011-06-08 10:36:43 -0700236 pr_debug("CORE_FILE[%u] - Added TCM FILEIO Device ID: %u at %s,"
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800237 " %llu total bytes\n", fd_host->fd_host_id, fd_dev->fd_dev_id,
238 fd_dev->fd_dev_name, fd_dev->fd_dev_size);
239
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400240 return 0;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800241fail:
242 if (fd_dev->fd_file) {
243 filp_close(fd_dev->fd_file, NULL);
244 fd_dev->fd_file = NULL;
245 }
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400246 return ret;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800247}
248
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400249static void fd_free_device(struct se_device *dev)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800250{
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400251 struct fd_dev *fd_dev = FD_DEV(dev);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800252
253 if (fd_dev->fd_file) {
254 filp_close(fd_dev->fd_file, NULL);
255 fd_dev->fd_file = NULL;
256 }
257
258 kfree(fd_dev);
259}
260
Sebastian Andrzej Siewior778229a2012-12-05 13:09:45 -0800261static int fd_do_rw(struct se_cmd *cmd, struct scatterlist *sgl,
262 u32 sgl_nents, int is_write)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800263{
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400264 struct se_device *se_dev = cmd->se_dev;
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400265 struct fd_dev *dev = FD_DEV(se_dev);
Andy Grover6708bb22011-06-08 10:36:43 -0700266 struct file *fd = dev->fd_file;
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400267 struct scatterlist *sg;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800268 struct iovec *iov;
269 mm_segment_t old_fs;
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400270 loff_t pos = (cmd->t_task_lba * se_dev->dev_attrib.block_size);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800271 int ret = 0, i;
272
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400273 iov = kzalloc(sizeof(struct iovec) * sgl_nents, GFP_KERNEL);
Andy Grover6708bb22011-06-08 10:36:43 -0700274 if (!iov) {
275 pr_err("Unable to allocate fd_do_readv iov[]\n");
Andy Grovere3d6f902011-07-19 08:55:10 +0000276 return -ENOMEM;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800277 }
278
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400279 for_each_sg(sgl, sg, sgl_nents, i) {
Sebastian Andrzej Siewior9649fa12011-11-28 12:33:10 +0100280 iov[i].iov_len = sg->length;
Sebastian Andrzej Siewior40ff2c32012-12-05 12:08:29 +0100281 iov[i].iov_base = kmap(sg_page(sg)) + sg->offset;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800282 }
283
284 old_fs = get_fs();
285 set_fs(get_ds());
Sebastian Andrzej Siewior778229a2012-12-05 13:09:45 -0800286
287 if (is_write)
288 ret = vfs_writev(fd, &iov[0], sgl_nents, &pos);
289 else
290 ret = vfs_readv(fd, &iov[0], sgl_nents, &pos);
291
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800292 set_fs(old_fs);
293
Sebastian Andrzej Siewior40ff2c32012-12-05 12:08:29 +0100294 for_each_sg(sgl, sg, sgl_nents, i)
295 kunmap(sg_page(sg));
Sebastian Andrzej Siewior778229a2012-12-05 13:09:45 -0800296
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800297 kfree(iov);
Sebastian Andrzej Siewior778229a2012-12-05 13:09:45 -0800298
299 if (is_write) {
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400300 if (ret < 0 || ret != cmd->data_length) {
Sebastian Andrzej Siewior778229a2012-12-05 13:09:45 -0800301 pr_err("%s() write returned %d\n", __func__, ret);
Andy Grovere3d6f902011-07-19 08:55:10 +0000302 return (ret < 0 ? ret : -EINVAL);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800303 }
304 } else {
Sebastian Andrzej Siewior778229a2012-12-05 13:09:45 -0800305 /*
306 * Return zeros and GOOD status even if the READ did not return
307 * the expected virt_size for struct file w/o a backing struct
308 * block_device.
309 */
Al Viro496ad9a2013-01-23 17:07:38 -0500310 if (S_ISBLK(file_inode(fd)->i_mode)) {
Sebastian Andrzej Siewior778229a2012-12-05 13:09:45 -0800311 if (ret < 0 || ret != cmd->data_length) {
312 pr_err("%s() returned %d, expecting %u for "
313 "S_ISBLK\n", __func__, ret,
314 cmd->data_length);
315 return (ret < 0 ? ret : -EINVAL);
316 }
317 } else {
318 if (ret < 0) {
319 pr_err("%s() returned %d for non S_ISBLK\n",
320 __func__, ret);
321 return ret;
322 }
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800323 }
324 }
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800325 return 1;
326}
327
Christoph Hellwigde103c92012-11-06 12:24:09 -0800328static sense_reason_t
329fd_execute_sync_cache(struct se_cmd *cmd)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800330{
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800331 struct se_device *dev = cmd->se_dev;
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400332 struct fd_dev *fd_dev = FD_DEV(dev);
Andy Grovera1d8b492011-05-02 17:12:10 -0700333 int immed = (cmd->t_task_cdb[1] & 0x2);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800334 loff_t start, end;
335 int ret;
336
337 /*
338 * If the Immediate bit is set, queue up the GOOD response
339 * for this SYNCHRONIZE_CACHE op
340 */
341 if (immed)
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400342 target_complete_cmd(cmd, SAM_STAT_GOOD);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800343
344 /*
345 * Determine if we will be flushing the entire device.
346 */
Andy Grovera1d8b492011-05-02 17:12:10 -0700347 if (cmd->t_task_lba == 0 && cmd->data_length == 0) {
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800348 start = 0;
349 end = LLONG_MAX;
350 } else {
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400351 start = cmd->t_task_lba * dev->dev_attrib.block_size;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800352 if (cmd->data_length)
353 end = start + cmd->data_length;
354 else
355 end = LLONG_MAX;
356 }
357
358 ret = vfs_fsync_range(fd_dev->fd_file, start, end, 1);
359 if (ret != 0)
Andy Grover6708bb22011-06-08 10:36:43 -0700360 pr_err("FILEIO: vfs_fsync_range() failed: %d\n", ret);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800361
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400362 if (immed)
Christoph Hellwigad67f0d2012-06-17 18:40:53 -0400363 return 0;
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400364
Christoph Hellwigde103c92012-11-06 12:24:09 -0800365 if (ret)
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400366 target_complete_cmd(cmd, SAM_STAT_CHECK_CONDITION);
Christoph Hellwigde103c92012-11-06 12:24:09 -0800367 else
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400368 target_complete_cmd(cmd, SAM_STAT_GOOD);
Christoph Hellwigad67f0d2012-06-17 18:40:53 -0400369
370 return 0;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800371}
372
Nicholas Bellinger7b745c82013-02-19 17:30:34 -0800373static unsigned char *
374fd_setup_write_same_buf(struct se_cmd *cmd, struct scatterlist *sg,
375 unsigned int len)
376{
377 struct se_device *se_dev = cmd->se_dev;
378 unsigned int block_size = se_dev->dev_attrib.block_size;
379 unsigned int i = 0, end;
380 unsigned char *buf, *p, *kmap_buf;
381
382 buf = kzalloc(min_t(unsigned int, len, PAGE_SIZE), GFP_KERNEL);
383 if (!buf) {
384 pr_err("Unable to allocate fd_execute_write_same buf\n");
385 return NULL;
386 }
387
388 kmap_buf = kmap(sg_page(sg)) + sg->offset;
389 if (!kmap_buf) {
390 pr_err("kmap() failed in fd_setup_write_same\n");
391 kfree(buf);
392 return NULL;
393 }
394 /*
395 * Fill local *buf to contain multiple WRITE_SAME blocks up to
396 * min(len, PAGE_SIZE)
397 */
398 p = buf;
399 end = min_t(unsigned int, len, PAGE_SIZE);
400
401 while (i < end) {
402 memcpy(p, kmap_buf, block_size);
403
404 i += block_size;
405 p += block_size;
406 }
407 kunmap(sg_page(sg));
408
409 return buf;
410}
411
412static sense_reason_t
413fd_execute_write_same(struct se_cmd *cmd)
414{
415 struct se_device *se_dev = cmd->se_dev;
416 struct fd_dev *fd_dev = FD_DEV(se_dev);
417 struct file *f = fd_dev->fd_file;
418 struct scatterlist *sg;
419 struct iovec *iov;
420 mm_segment_t old_fs;
Roland Dreier972b29c82013-02-22 09:52:57 -0800421 sector_t nolb = sbc_get_write_same_sectors(cmd);
Nicholas Bellinger7b745c82013-02-19 17:30:34 -0800422 loff_t pos = cmd->t_task_lba * se_dev->dev_attrib.block_size;
423 unsigned int len, len_tmp, iov_num;
424 int i, rc;
425 unsigned char *buf;
426
427 if (!nolb) {
428 target_complete_cmd(cmd, SAM_STAT_GOOD);
429 return 0;
430 }
431 sg = &cmd->t_data_sg[0];
432
433 if (cmd->t_data_nents > 1 ||
434 sg->length != cmd->se_dev->dev_attrib.block_size) {
435 pr_err("WRITE_SAME: Illegal SGL t_data_nents: %u length: %u"
436 " block_size: %u\n", cmd->t_data_nents, sg->length,
437 cmd->se_dev->dev_attrib.block_size);
438 return TCM_INVALID_CDB_FIELD;
439 }
440
441 len = len_tmp = nolb * se_dev->dev_attrib.block_size;
442 iov_num = DIV_ROUND_UP(len, PAGE_SIZE);
443
444 buf = fd_setup_write_same_buf(cmd, sg, len);
445 if (!buf)
446 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
447
448 iov = vzalloc(sizeof(struct iovec) * iov_num);
449 if (!iov) {
450 pr_err("Unable to allocate fd_execute_write_same iovecs\n");
451 kfree(buf);
452 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
453 }
454 /*
455 * Map the single fabric received scatterlist block now populated
456 * in *buf into each iovec for I/O submission.
457 */
458 for (i = 0; i < iov_num; i++) {
459 iov[i].iov_base = buf;
460 iov[i].iov_len = min_t(unsigned int, len_tmp, PAGE_SIZE);
461 len_tmp -= iov[i].iov_len;
462 }
463
464 old_fs = get_fs();
465 set_fs(get_ds());
466 rc = vfs_writev(f, &iov[0], iov_num, &pos);
467 set_fs(old_fs);
468
469 vfree(iov);
470 kfree(buf);
471
472 if (rc < 0 || rc != len) {
473 pr_err("vfs_writev() returned %d for write same\n", rc);
474 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
475 }
476
477 target_complete_cmd(cmd, SAM_STAT_GOOD);
478 return 0;
479}
480
Christoph Hellwigde103c92012-11-06 12:24:09 -0800481static sense_reason_t
Asias He70d3ae5c2013-02-25 14:03:42 +0800482fd_execute_write_same_unmap(struct se_cmd *cmd)
483{
484 struct se_device *se_dev = cmd->se_dev;
485 struct fd_dev *fd_dev = FD_DEV(se_dev);
486 struct file *file = fd_dev->fd_file;
487 struct inode *inode = file->f_mapping->host;
488 sector_t nolb = sbc_get_write_same_sectors(cmd);
489 int ret;
490
491 if (!nolb) {
492 target_complete_cmd(cmd, SAM_STAT_GOOD);
493 return 0;
494 }
495
496 if (S_ISBLK(inode->i_mode)) {
497 /* The backend is block device, use discard */
498 struct block_device *bdev = inode->i_bdev;
499
500 ret = blkdev_issue_discard(bdev, cmd->t_task_lba,
501 nolb, GFP_KERNEL, 0);
502 if (ret < 0) {
503 pr_warn("FILEIO: blkdev_issue_discard() failed: %d\n",
504 ret);
505 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
506 }
507 } else {
508 /* The backend is normal file, use fallocate */
509 loff_t pos = cmd->t_task_lba * se_dev->dev_attrib.block_size;
510 unsigned int len = nolb * se_dev->dev_attrib.block_size;
511 int mode = FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE;
512
513 if (!file->f_op->fallocate)
514 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
515
516 ret = file->f_op->fallocate(file, mode, pos, len);
517 if (ret < 0) {
518 pr_warn("FILEIO: fallocate() failed: %d\n", ret);
519 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
520 }
521 }
522
523 target_complete_cmd(cmd, GOOD);
524 return 0;
525}
526
527static sense_reason_t
Christoph Hellwigde103c92012-11-06 12:24:09 -0800528fd_execute_rw(struct se_cmd *cmd)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800529{
Christoph Hellwig0c2ad7d2012-06-17 18:40:52 -0400530 struct scatterlist *sgl = cmd->t_data_sg;
531 u32 sgl_nents = cmd->t_data_nents;
532 enum dma_data_direction data_direction = cmd->data_direction;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800533 struct se_device *dev = cmd->se_dev;
534 int ret = 0;
535
536 /*
537 * Call vectorized fileio functions to map struct scatterlist
538 * physical memory addresses to struct iovec virtual memory.
539 */
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400540 if (data_direction == DMA_FROM_DEVICE) {
Sebastian Andrzej Siewior778229a2012-12-05 13:09:45 -0800541 ret = fd_do_rw(cmd, sgl, sgl_nents, 0);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800542 } else {
Sebastian Andrzej Siewior778229a2012-12-05 13:09:45 -0800543 ret = fd_do_rw(cmd, sgl, sgl_nents, 1);
Nicholas Bellingera4dff302012-05-30 16:25:41 -0700544 /*
545 * Perform implict vfs_fsync_range() for fd_do_writev() ops
546 * for SCSI WRITEs with Forced Unit Access (FUA) set.
547 * Allow this to happen independent of WCE=0 setting.
548 */
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800549 if (ret > 0 &&
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400550 dev->dev_attrib.emulate_fua_write > 0 &&
Christoph Hellwig2d3a4b52011-11-14 11:36:29 -0500551 (cmd->se_cmd_flags & SCF_FUA)) {
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400552 struct fd_dev *fd_dev = FD_DEV(dev);
Nicholas Bellingera4dff302012-05-30 16:25:41 -0700553 loff_t start = cmd->t_task_lba *
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400554 dev->dev_attrib.block_size;
Nicholas Bellingera4dff302012-05-30 16:25:41 -0700555 loff_t end = start + cmd->data_length;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800556
Nicholas Bellingera4dff302012-05-30 16:25:41 -0700557 vfs_fsync_range(fd_dev->fd_file, start, end, 1);
558 }
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800559 }
560
Christoph Hellwigde103c92012-11-06 12:24:09 -0800561 if (ret < 0)
562 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
563
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400564 if (ret)
565 target_complete_cmd(cmd, SAM_STAT_GOOD);
Nicholas Bellinger03e98c92011-11-04 02:36:16 -0700566 return 0;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800567}
568
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800569enum {
570 Opt_fd_dev_name, Opt_fd_dev_size, Opt_fd_buffered_io, Opt_err
571};
572
573static match_table_t tokens = {
574 {Opt_fd_dev_name, "fd_dev_name=%s"},
575 {Opt_fd_dev_size, "fd_dev_size=%s"},
Nicholas Bellingerb32f4c72012-09-29 17:15:37 -0700576 {Opt_fd_buffered_io, "fd_buffered_io=%d"},
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800577 {Opt_err, NULL}
578};
579
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400580static ssize_t fd_set_configfs_dev_params(struct se_device *dev,
581 const char *page, ssize_t count)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800582{
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400583 struct fd_dev *fd_dev = FD_DEV(dev);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800584 char *orig, *ptr, *arg_p, *opts;
585 substring_t args[MAX_OPT_ARGS];
Nicholas Bellingerb32f4c72012-09-29 17:15:37 -0700586 int ret = 0, arg, token;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800587
588 opts = kstrdup(page, GFP_KERNEL);
589 if (!opts)
590 return -ENOMEM;
591
592 orig = opts;
593
Sebastian Andrzej Siewior90c161b2011-11-23 20:53:17 +0100594 while ((ptr = strsep(&opts, ",\n")) != NULL) {
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800595 if (!*ptr)
596 continue;
597
598 token = match_token(ptr, tokens, args);
599 switch (token) {
600 case Opt_fd_dev_name:
Al Virodbc6e022012-08-01 13:07:04 +0400601 if (match_strlcpy(fd_dev->fd_dev_name, &args[0],
602 FD_MAX_DEV_NAME) == 0) {
603 ret = -EINVAL;
Jesper Juhl6d180252011-03-14 04:05:56 -0700604 break;
605 }
Andy Grover6708bb22011-06-08 10:36:43 -0700606 pr_debug("FILEIO: Referencing Path: %s\n",
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800607 fd_dev->fd_dev_name);
608 fd_dev->fbd_flags |= FBDF_HAS_PATH;
609 break;
610 case Opt_fd_dev_size:
611 arg_p = match_strdup(&args[0]);
Jesper Juhl6d180252011-03-14 04:05:56 -0700612 if (!arg_p) {
613 ret = -ENOMEM;
614 break;
615 }
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800616 ret = strict_strtoull(arg_p, 0, &fd_dev->fd_dev_size);
Jesper Juhl6d180252011-03-14 04:05:56 -0700617 kfree(arg_p);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800618 if (ret < 0) {
Andy Grover6708bb22011-06-08 10:36:43 -0700619 pr_err("strict_strtoull() failed for"
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800620 " fd_dev_size=\n");
621 goto out;
622 }
Andy Grover6708bb22011-06-08 10:36:43 -0700623 pr_debug("FILEIO: Referencing Size: %llu"
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800624 " bytes\n", fd_dev->fd_dev_size);
625 fd_dev->fbd_flags |= FBDF_HAS_SIZE;
626 break;
Nicholas Bellingerb32f4c72012-09-29 17:15:37 -0700627 case Opt_fd_buffered_io:
628 match_int(args, &arg);
629 if (arg != 1) {
630 pr_err("bogus fd_buffered_io=%d value\n", arg);
631 ret = -EINVAL;
632 goto out;
633 }
634
635 pr_debug("FILEIO: Using buffered I/O"
636 " operations for struct fd_dev\n");
637
638 fd_dev->fbd_flags |= FDBD_HAS_BUFFERED_IO_WCE;
639 break;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800640 default:
641 break;
642 }
643 }
644
645out:
646 kfree(orig);
647 return (!ret) ? count : ret;
648}
649
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400650static ssize_t fd_show_configfs_dev_params(struct se_device *dev, char *b)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800651{
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400652 struct fd_dev *fd_dev = FD_DEV(dev);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800653 ssize_t bl = 0;
654
655 bl = sprintf(b + bl, "TCM FILEIO ID: %u", fd_dev->fd_dev_id);
Nicholas Bellingerb32f4c72012-09-29 17:15:37 -0700656 bl += sprintf(b + bl, " File: %s Size: %llu Mode: %s\n",
657 fd_dev->fd_dev_name, fd_dev->fd_dev_size,
658 (fd_dev->fbd_flags & FDBD_HAS_BUFFERED_IO_WCE) ?
659 "Buffered-WCE" : "O_DSYNC");
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800660 return bl;
661}
662
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800663static sector_t fd_get_blocks(struct se_device *dev)
664{
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400665 struct fd_dev *fd_dev = FD_DEV(dev);
Nicholas Bellingercd9323f2012-05-16 16:05:26 -0700666 struct file *f = fd_dev->fd_file;
667 struct inode *i = f->f_mapping->host;
668 unsigned long long dev_size;
669 /*
670 * When using a file that references an underlying struct block_device,
671 * ensure dev_size is always based on the current inode size in order
672 * to handle underlying block_device resize operations.
673 */
674 if (S_ISBLK(i->i_mode))
675 dev_size = (i_size_read(i) - fd_dev->fd_block_size);
676 else
677 dev_size = fd_dev->fd_dev_size;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800678
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400679 return div_u64(dev_size, dev->dev_attrib.block_size);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800680}
681
Christoph Hellwig9e999a62012-10-07 10:55:50 -0400682static struct sbc_ops fd_sbc_ops = {
Christoph Hellwig0c2ad7d2012-06-17 18:40:52 -0400683 .execute_rw = fd_execute_rw,
Christoph Hellwigad67f0d2012-06-17 18:40:53 -0400684 .execute_sync_cache = fd_execute_sync_cache,
Nicholas Bellinger7b745c82013-02-19 17:30:34 -0800685 .execute_write_same = fd_execute_write_same,
Asias He70d3ae5c2013-02-25 14:03:42 +0800686 .execute_write_same_unmap = fd_execute_write_same_unmap,
Christoph Hellwig0c2ad7d2012-06-17 18:40:52 -0400687};
688
Christoph Hellwigde103c92012-11-06 12:24:09 -0800689static sense_reason_t
690fd_parse_cdb(struct se_cmd *cmd)
Christoph Hellwig0c2ad7d2012-06-17 18:40:52 -0400691{
Christoph Hellwig9e999a62012-10-07 10:55:50 -0400692 return sbc_parse_cdb(cmd, &fd_sbc_ops);
Christoph Hellwig0c2ad7d2012-06-17 18:40:52 -0400693}
694
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800695static struct se_subsystem_api fileio_template = {
696 .name = "fileio",
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400697 .inquiry_prod = "FILEIO",
698 .inquiry_rev = FD_VERSION,
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800699 .owner = THIS_MODULE,
700 .transport_type = TRANSPORT_PLUGIN_VHBA_PDEV,
701 .attach_hba = fd_attach_hba,
702 .detach_hba = fd_detach_hba,
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400703 .alloc_device = fd_alloc_device,
704 .configure_device = fd_configure_device,
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800705 .free_device = fd_free_device,
Christoph Hellwig0c2ad7d2012-06-17 18:40:52 -0400706 .parse_cdb = fd_parse_cdb,
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800707 .set_configfs_dev_params = fd_set_configfs_dev_params,
708 .show_configfs_dev_params = fd_show_configfs_dev_params,
Christoph Hellwig6f23ac82012-10-07 10:55:53 -0400709 .get_device_type = sbc_get_device_type,
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800710 .get_blocks = fd_get_blocks,
711};
712
713static int __init fileio_module_init(void)
714{
715 return transport_subsystem_register(&fileio_template);
716}
717
Asias He63b91d52013-02-27 12:50:56 +0800718static void __exit fileio_module_exit(void)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800719{
720 transport_subsystem_release(&fileio_template);
721}
722
723MODULE_DESCRIPTION("TCM FILEIO subsystem plugin");
724MODULE_AUTHOR("nab@Linux-iSCSI.org");
725MODULE_LICENSE("GPL");
726
727module_init(fileio_module_init);
728module_exit(fileio_module_exit);