blob: 58ed683e04aefc942b7456fae4b9c6ba10f05a00 [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>
Asias He50642762013-02-25 14:03:43 +080036#include <asm/unaligned.h>
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080037
38#include <target/target_core_base.h>
Christoph Hellwigc4795fb2011-11-16 09:46:48 -050039#include <target/target_core_backend.h>
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080040
41#include "target_core_file.h"
42
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -040043static inline struct fd_dev *FD_DEV(struct se_device *dev)
44{
45 return container_of(dev, struct fd_dev, dev);
46}
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080047
48/* fd_attach_hba(): (Part of se_subsystem_api_t template)
49 *
50 *
51 */
52static int fd_attach_hba(struct se_hba *hba, u32 host_id)
53{
54 struct fd_host *fd_host;
55
56 fd_host = kzalloc(sizeof(struct fd_host), GFP_KERNEL);
Andy Grover6708bb22011-06-08 10:36:43 -070057 if (!fd_host) {
58 pr_err("Unable to allocate memory for struct fd_host\n");
Andy Grovere3d6f902011-07-19 08:55:10 +000059 return -ENOMEM;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080060 }
61
62 fd_host->fd_host_id = host_id;
63
Andy Grovere3d6f902011-07-19 08:55:10 +000064 hba->hba_ptr = fd_host;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080065
Andy Grover6708bb22011-06-08 10:36:43 -070066 pr_debug("CORE_HBA[%d] - TCM FILEIO HBA Driver %s on Generic"
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080067 " Target Core Stack %s\n", hba->hba_id, FD_VERSION,
68 TARGET_CORE_MOD_VERSION);
Andy Grover6708bb22011-06-08 10:36:43 -070069 pr_debug("CORE_HBA[%d] - Attached FILEIO HBA: %u to Generic"
Andy Grovere3d6f902011-07-19 08:55:10 +000070 " MaxSectors: %u\n",
71 hba->hba_id, fd_host->fd_host_id, FD_MAX_SECTORS);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080072
73 return 0;
74}
75
76static void fd_detach_hba(struct se_hba *hba)
77{
78 struct fd_host *fd_host = hba->hba_ptr;
79
Andy Grover6708bb22011-06-08 10:36:43 -070080 pr_debug("CORE_HBA[%d] - Detached FILEIO HBA: %u from Generic"
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080081 " Target Core\n", hba->hba_id, fd_host->fd_host_id);
82
83 kfree(fd_host);
84 hba->hba_ptr = NULL;
85}
86
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -040087static struct se_device *fd_alloc_device(struct se_hba *hba, const char *name)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080088{
89 struct fd_dev *fd_dev;
Jörn Engel8359cf42011-11-24 02:05:51 +010090 struct fd_host *fd_host = hba->hba_ptr;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080091
92 fd_dev = kzalloc(sizeof(struct fd_dev), GFP_KERNEL);
Andy Grover6708bb22011-06-08 10:36:43 -070093 if (!fd_dev) {
94 pr_err("Unable to allocate memory for struct fd_dev\n");
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -080095 return NULL;
96 }
97
98 fd_dev->fd_host = fd_host;
99
Andy Grover6708bb22011-06-08 10:36:43 -0700100 pr_debug("FILEIO: Allocated fd_dev for %p\n", name);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800101
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400102 return &fd_dev->dev;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800103}
104
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400105static int fd_configure_device(struct se_device *dev)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800106{
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400107 struct fd_dev *fd_dev = FD_DEV(dev);
108 struct fd_host *fd_host = dev->se_hba->hba_ptr;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800109 struct file *file;
110 struct inode *inode = NULL;
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400111 int flags, ret = -EINVAL;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800112
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400113 if (!(fd_dev->fbd_flags & FBDF_HAS_PATH)) {
114 pr_err("Missing fd_dev_name=\n");
115 return -EINVAL;
116 }
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800117
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800118 /*
Nicholas Bellingera4dff302012-05-30 16:25:41 -0700119 * Use O_DSYNC by default instead of O_SYNC to forgo syncing
120 * of pure timestamp updates.
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800121 */
Nicholas Bellingera4dff302012-05-30 16:25:41 -0700122 flags = O_RDWR | O_CREAT | O_LARGEFILE | O_DSYNC;
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400123
Nicholas Bellingerb32f4c72012-09-29 17:15:37 -0700124 /*
125 * Optionally allow fd_buffered_io=1 to be enabled for people
126 * who want use the fs buffer cache as an WriteCache mechanism.
127 *
128 * This means that in event of a hard failure, there is a risk
129 * of silent data-loss if the SCSI client has *not* performed a
130 * forced unit access (FUA) write, or issued SYNCHRONIZE_CACHE
131 * to write-out the entire device cache.
132 */
133 if (fd_dev->fbd_flags & FDBD_HAS_BUFFERED_IO_WCE) {
134 pr_debug("FILEIO: Disabling O_DSYNC, using buffered FILEIO\n");
135 flags &= ~O_DSYNC;
136 }
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800137
Al Virodbc6e022012-08-01 13:07:04 +0400138 file = filp_open(fd_dev->fd_dev_name, flags, 0600);
Nicholas Bellinger613640e2011-03-14 04:05:59 -0700139 if (IS_ERR(file)) {
Al Virodbc6e022012-08-01 13:07:04 +0400140 pr_err("filp_open(%s) failed\n", fd_dev->fd_dev_name);
Nicholas Bellinger613640e2011-03-14 04:05:59 -0700141 ret = PTR_ERR(file);
142 goto fail;
143 }
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800144 fd_dev->fd_file = file;
145 /*
146 * If using a block backend with this struct file, we extract
147 * fd_dev->fd_[block,dev]_size from struct block_device.
148 *
149 * Otherwise, we use the passed fd_size= from configfs
150 */
151 inode = file->f_mapping->host;
152 if (S_ISBLK(inode->i_mode)) {
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400153 struct request_queue *q = bdev_get_queue(inode->i_bdev);
Nicholas Bellingercd9323f2012-05-16 16:05:26 -0700154 unsigned long long dev_size;
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400155
156 dev->dev_attrib.hw_block_size =
157 bdev_logical_block_size(inode->i_bdev);
158 dev->dev_attrib.hw_max_sectors = queue_max_hw_sectors(q);
159
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800160 /*
161 * Determine the number of bytes from i_size_read() minus
162 * one (1) logical sector from underlying struct block_device
163 */
Nicholas Bellingercd9323f2012-05-16 16:05:26 -0700164 dev_size = (i_size_read(file->f_mapping->host) -
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800165 fd_dev->fd_block_size);
166
Andy Grover6708bb22011-06-08 10:36:43 -0700167 pr_debug("FILEIO: Using size: %llu bytes from struct"
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800168 " block_device blocks: %llu logical_block_size: %d\n",
Nicholas Bellingercd9323f2012-05-16 16:05:26 -0700169 dev_size, div_u64(dev_size, fd_dev->fd_block_size),
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800170 fd_dev->fd_block_size);
Asias He70d3ae5c2013-02-25 14:03:42 +0800171 /*
172 * Check if the underlying struct block_device request_queue supports
173 * the QUEUE_FLAG_DISCARD bit for UNMAP/WRITE_SAME in SCSI + TRIM
174 * in ATA and we need to set TPE=1
175 */
176 if (blk_queue_discard(q)) {
177 dev->dev_attrib.max_unmap_lba_count =
178 q->limits.max_discard_sectors;
179 /*
180 * Currently hardcoded to 1 in Linux/SCSI code..
181 */
182 dev->dev_attrib.max_unmap_block_desc_count = 1;
183 dev->dev_attrib.unmap_granularity =
184 q->limits.discard_granularity >> 9;
185 dev->dev_attrib.unmap_granularity_alignment =
186 q->limits.discard_alignment;
187 pr_debug("IFILE: BLOCK Discard support available,"
188 " disabled by default\n");
189 }
190 /*
191 * Enable write same emulation for IBLOCK and use 0xFFFF as
192 * the smaller WRITE_SAME(10) only has a two-byte block count.
193 */
194 dev->dev_attrib.max_write_same_len = 0xFFFF;
Asias He0463a3f2013-04-24 19:38:11 -0700195
196 if (blk_queue_nonrot(q))
197 dev->dev_attrib.is_nonrot = 1;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800198 } else {
199 if (!(fd_dev->fbd_flags & FBDF_HAS_SIZE)) {
Andy Grover6708bb22011-06-08 10:36:43 -0700200 pr_err("FILEIO: Missing fd_dev_size="
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800201 " parameter, and no backing struct"
202 " block_device\n");
203 goto fail;
204 }
205
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400206 dev->dev_attrib.hw_block_size = FD_BLOCKSIZE;
207 dev->dev_attrib.hw_max_sectors = FD_MAX_SECTORS;
Asias He70d3ae5c2013-02-25 14:03:42 +0800208
209 /*
210 * Limit UNMAP emulation to 8k Number of LBAs (NoLB)
211 */
212 dev->dev_attrib.max_unmap_lba_count = 0x2000;
213 /*
214 * Currently hardcoded to 1 in Linux/SCSI code..
215 */
216 dev->dev_attrib.max_unmap_block_desc_count = 1;
217 dev->dev_attrib.unmap_granularity = 1;
218 dev->dev_attrib.unmap_granularity_alignment = 0;
219
220 /*
221 * Limit WRITE_SAME w/ UNMAP=0 emulation to 8k Number of LBAs (NoLB)
222 * based upon struct iovec limit for vfs_writev()
223 */
224 dev->dev_attrib.max_write_same_len = 0x1000;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800225 }
226
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400227 fd_dev->fd_block_size = dev->dev_attrib.hw_block_size;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800228
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400229 dev->dev_attrib.hw_queue_depth = FD_MAX_DEVICE_QUEUE_DEPTH;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800230
Nicholas Bellingerb32f4c72012-09-29 17:15:37 -0700231 if (fd_dev->fbd_flags & FDBD_HAS_BUFFERED_IO_WCE) {
232 pr_debug("FILEIO: Forcing setting of emulate_write_cache=1"
233 " with FDBD_HAS_BUFFERED_IO_WCE\n");
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400234 dev->dev_attrib.emulate_write_cache = 1;
Nicholas Bellingerb32f4c72012-09-29 17:15:37 -0700235 }
236
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800237 fd_dev->fd_dev_id = fd_host->fd_host_dev_id_count++;
238 fd_dev->fd_queue_depth = dev->queue_depth;
239
Andy Grover6708bb22011-06-08 10:36:43 -0700240 pr_debug("CORE_FILE[%u] - Added TCM FILEIO Device ID: %u at %s,"
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800241 " %llu total bytes\n", fd_host->fd_host_id, fd_dev->fd_dev_id,
242 fd_dev->fd_dev_name, fd_dev->fd_dev_size);
243
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400244 return 0;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800245fail:
246 if (fd_dev->fd_file) {
247 filp_close(fd_dev->fd_file, NULL);
248 fd_dev->fd_file = NULL;
249 }
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400250 return ret;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800251}
252
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400253static void fd_free_device(struct se_device *dev)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800254{
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400255 struct fd_dev *fd_dev = FD_DEV(dev);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800256
257 if (fd_dev->fd_file) {
258 filp_close(fd_dev->fd_file, NULL);
259 fd_dev->fd_file = NULL;
260 }
261
262 kfree(fd_dev);
263}
264
Sebastian Andrzej Siewior778229a2012-12-05 13:09:45 -0800265static int fd_do_rw(struct se_cmd *cmd, struct scatterlist *sgl,
266 u32 sgl_nents, int is_write)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800267{
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400268 struct se_device *se_dev = cmd->se_dev;
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400269 struct fd_dev *dev = FD_DEV(se_dev);
Andy Grover6708bb22011-06-08 10:36:43 -0700270 struct file *fd = dev->fd_file;
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400271 struct scatterlist *sg;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800272 struct iovec *iov;
273 mm_segment_t old_fs;
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400274 loff_t pos = (cmd->t_task_lba * se_dev->dev_attrib.block_size);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800275 int ret = 0, i;
276
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400277 iov = kzalloc(sizeof(struct iovec) * sgl_nents, GFP_KERNEL);
Andy Grover6708bb22011-06-08 10:36:43 -0700278 if (!iov) {
279 pr_err("Unable to allocate fd_do_readv iov[]\n");
Andy Grovere3d6f902011-07-19 08:55:10 +0000280 return -ENOMEM;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800281 }
282
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400283 for_each_sg(sgl, sg, sgl_nents, i) {
Sebastian Andrzej Siewior9649fa12011-11-28 12:33:10 +0100284 iov[i].iov_len = sg->length;
Sebastian Andrzej Siewior40ff2c32012-12-05 12:08:29 +0100285 iov[i].iov_base = kmap(sg_page(sg)) + sg->offset;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800286 }
287
288 old_fs = get_fs();
289 set_fs(get_ds());
Sebastian Andrzej Siewior778229a2012-12-05 13:09:45 -0800290
291 if (is_write)
292 ret = vfs_writev(fd, &iov[0], sgl_nents, &pos);
293 else
294 ret = vfs_readv(fd, &iov[0], sgl_nents, &pos);
295
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800296 set_fs(old_fs);
297
Sebastian Andrzej Siewior40ff2c32012-12-05 12:08:29 +0100298 for_each_sg(sgl, sg, sgl_nents, i)
299 kunmap(sg_page(sg));
Sebastian Andrzej Siewior778229a2012-12-05 13:09:45 -0800300
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800301 kfree(iov);
Sebastian Andrzej Siewior778229a2012-12-05 13:09:45 -0800302
303 if (is_write) {
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400304 if (ret < 0 || ret != cmd->data_length) {
Sebastian Andrzej Siewior778229a2012-12-05 13:09:45 -0800305 pr_err("%s() write returned %d\n", __func__, ret);
Andy Grovere3d6f902011-07-19 08:55:10 +0000306 return (ret < 0 ? ret : -EINVAL);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800307 }
308 } else {
Sebastian Andrzej Siewior778229a2012-12-05 13:09:45 -0800309 /*
310 * Return zeros and GOOD status even if the READ did not return
311 * the expected virt_size for struct file w/o a backing struct
312 * block_device.
313 */
Al Viro496ad9a2013-01-23 17:07:38 -0500314 if (S_ISBLK(file_inode(fd)->i_mode)) {
Sebastian Andrzej Siewior778229a2012-12-05 13:09:45 -0800315 if (ret < 0 || ret != cmd->data_length) {
316 pr_err("%s() returned %d, expecting %u for "
317 "S_ISBLK\n", __func__, ret,
318 cmd->data_length);
319 return (ret < 0 ? ret : -EINVAL);
320 }
321 } else {
322 if (ret < 0) {
323 pr_err("%s() returned %d for non S_ISBLK\n",
324 __func__, ret);
325 return ret;
326 }
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800327 }
328 }
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800329 return 1;
330}
331
Christoph Hellwigde103c92012-11-06 12:24:09 -0800332static sense_reason_t
333fd_execute_sync_cache(struct se_cmd *cmd)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800334{
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800335 struct se_device *dev = cmd->se_dev;
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400336 struct fd_dev *fd_dev = FD_DEV(dev);
Andy Grovera1d8b492011-05-02 17:12:10 -0700337 int immed = (cmd->t_task_cdb[1] & 0x2);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800338 loff_t start, end;
339 int ret;
340
341 /*
342 * If the Immediate bit is set, queue up the GOOD response
343 * for this SYNCHRONIZE_CACHE op
344 */
345 if (immed)
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400346 target_complete_cmd(cmd, SAM_STAT_GOOD);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800347
348 /*
349 * Determine if we will be flushing the entire device.
350 */
Andy Grovera1d8b492011-05-02 17:12:10 -0700351 if (cmd->t_task_lba == 0 && cmd->data_length == 0) {
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800352 start = 0;
353 end = LLONG_MAX;
354 } else {
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400355 start = cmd->t_task_lba * dev->dev_attrib.block_size;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800356 if (cmd->data_length)
357 end = start + cmd->data_length;
358 else
359 end = LLONG_MAX;
360 }
361
362 ret = vfs_fsync_range(fd_dev->fd_file, start, end, 1);
363 if (ret != 0)
Andy Grover6708bb22011-06-08 10:36:43 -0700364 pr_err("FILEIO: vfs_fsync_range() failed: %d\n", ret);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800365
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400366 if (immed)
Christoph Hellwigad67f0d2012-06-17 18:40:53 -0400367 return 0;
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400368
Christoph Hellwigde103c92012-11-06 12:24:09 -0800369 if (ret)
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400370 target_complete_cmd(cmd, SAM_STAT_CHECK_CONDITION);
Christoph Hellwigde103c92012-11-06 12:24:09 -0800371 else
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400372 target_complete_cmd(cmd, SAM_STAT_GOOD);
Christoph Hellwigad67f0d2012-06-17 18:40:53 -0400373
374 return 0;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800375}
376
Nicholas Bellinger7b745c82013-02-19 17:30:34 -0800377static unsigned char *
378fd_setup_write_same_buf(struct se_cmd *cmd, struct scatterlist *sg,
379 unsigned int len)
380{
381 struct se_device *se_dev = cmd->se_dev;
382 unsigned int block_size = se_dev->dev_attrib.block_size;
383 unsigned int i = 0, end;
384 unsigned char *buf, *p, *kmap_buf;
385
386 buf = kzalloc(min_t(unsigned int, len, PAGE_SIZE), GFP_KERNEL);
387 if (!buf) {
388 pr_err("Unable to allocate fd_execute_write_same buf\n");
389 return NULL;
390 }
391
392 kmap_buf = kmap(sg_page(sg)) + sg->offset;
393 if (!kmap_buf) {
394 pr_err("kmap() failed in fd_setup_write_same\n");
395 kfree(buf);
396 return NULL;
397 }
398 /*
399 * Fill local *buf to contain multiple WRITE_SAME blocks up to
400 * min(len, PAGE_SIZE)
401 */
402 p = buf;
403 end = min_t(unsigned int, len, PAGE_SIZE);
404
405 while (i < end) {
406 memcpy(p, kmap_buf, block_size);
407
408 i += block_size;
409 p += block_size;
410 }
411 kunmap(sg_page(sg));
412
413 return buf;
414}
415
416static sense_reason_t
417fd_execute_write_same(struct se_cmd *cmd)
418{
419 struct se_device *se_dev = cmd->se_dev;
420 struct fd_dev *fd_dev = FD_DEV(se_dev);
421 struct file *f = fd_dev->fd_file;
422 struct scatterlist *sg;
423 struct iovec *iov;
424 mm_segment_t old_fs;
Roland Dreier972b29c82013-02-22 09:52:57 -0800425 sector_t nolb = sbc_get_write_same_sectors(cmd);
Nicholas Bellinger7b745c82013-02-19 17:30:34 -0800426 loff_t pos = cmd->t_task_lba * se_dev->dev_attrib.block_size;
427 unsigned int len, len_tmp, iov_num;
428 int i, rc;
429 unsigned char *buf;
430
431 if (!nolb) {
432 target_complete_cmd(cmd, SAM_STAT_GOOD);
433 return 0;
434 }
435 sg = &cmd->t_data_sg[0];
436
437 if (cmd->t_data_nents > 1 ||
438 sg->length != cmd->se_dev->dev_attrib.block_size) {
439 pr_err("WRITE_SAME: Illegal SGL t_data_nents: %u length: %u"
440 " block_size: %u\n", cmd->t_data_nents, sg->length,
441 cmd->se_dev->dev_attrib.block_size);
442 return TCM_INVALID_CDB_FIELD;
443 }
444
445 len = len_tmp = nolb * se_dev->dev_attrib.block_size;
446 iov_num = DIV_ROUND_UP(len, PAGE_SIZE);
447
448 buf = fd_setup_write_same_buf(cmd, sg, len);
449 if (!buf)
450 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
451
452 iov = vzalloc(sizeof(struct iovec) * iov_num);
453 if (!iov) {
454 pr_err("Unable to allocate fd_execute_write_same iovecs\n");
455 kfree(buf);
456 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
457 }
458 /*
459 * Map the single fabric received scatterlist block now populated
460 * in *buf into each iovec for I/O submission.
461 */
462 for (i = 0; i < iov_num; i++) {
463 iov[i].iov_base = buf;
464 iov[i].iov_len = min_t(unsigned int, len_tmp, PAGE_SIZE);
465 len_tmp -= iov[i].iov_len;
466 }
467
468 old_fs = get_fs();
469 set_fs(get_ds());
470 rc = vfs_writev(f, &iov[0], iov_num, &pos);
471 set_fs(old_fs);
472
473 vfree(iov);
474 kfree(buf);
475
476 if (rc < 0 || rc != len) {
477 pr_err("vfs_writev() returned %d for write same\n", rc);
478 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
479 }
480
481 target_complete_cmd(cmd, SAM_STAT_GOOD);
482 return 0;
483}
484
Christoph Hellwigde103c92012-11-06 12:24:09 -0800485static sense_reason_t
Asias He86d71822013-02-25 14:03:46 +0800486fd_do_unmap(struct se_cmd *cmd, void *priv, sector_t lba, sector_t nolb)
Asias He70d3ae5c2013-02-25 14:03:42 +0800487{
Asias He86d71822013-02-25 14:03:46 +0800488 struct file *file = priv;
Asias He70d3ae5c2013-02-25 14:03:42 +0800489 struct inode *inode = file->f_mapping->host;
Asias He70d3ae5c2013-02-25 14:03:42 +0800490 int ret;
491
Asias He70d3ae5c2013-02-25 14:03:42 +0800492 if (S_ISBLK(inode->i_mode)) {
493 /* The backend is block device, use discard */
494 struct block_device *bdev = inode->i_bdev;
495
Asias He43f55bb2013-02-25 14:03:44 +0800496 ret = blkdev_issue_discard(bdev, lba,
Asias He70d3ae5c2013-02-25 14:03:42 +0800497 nolb, GFP_KERNEL, 0);
498 if (ret < 0) {
499 pr_warn("FILEIO: blkdev_issue_discard() failed: %d\n",
500 ret);
501 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
502 }
503 } else {
504 /* The backend is normal file, use fallocate */
Asias He43f55bb2013-02-25 14:03:44 +0800505 struct se_device *se_dev = cmd->se_dev;
506 loff_t pos = lba * se_dev->dev_attrib.block_size;
Asias He70d3ae5c2013-02-25 14:03:42 +0800507 unsigned int len = nolb * se_dev->dev_attrib.block_size;
508 int mode = FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE;
509
510 if (!file->f_op->fallocate)
511 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
512
513 ret = file->f_op->fallocate(file, mode, pos, len);
514 if (ret < 0) {
515 pr_warn("FILEIO: fallocate() failed: %d\n", ret);
516 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
517 }
518 }
519
Asias He43f55bb2013-02-25 14:03:44 +0800520 return 0;
521}
522
523static sense_reason_t
524fd_execute_write_same_unmap(struct se_cmd *cmd)
525{
526 struct se_device *se_dev = cmd->se_dev;
527 struct fd_dev *fd_dev = FD_DEV(se_dev);
528 struct file *file = fd_dev->fd_file;
529 sector_t lba = cmd->t_task_lba;
530 sector_t nolb = sbc_get_write_same_sectors(cmd);
531 int ret;
532
533 if (!nolb) {
534 target_complete_cmd(cmd, SAM_STAT_GOOD);
535 return 0;
536 }
537
538 ret = fd_do_unmap(cmd, file, lba, nolb);
539 if (ret)
540 return ret;
541
Asias He70d3ae5c2013-02-25 14:03:42 +0800542 target_complete_cmd(cmd, GOOD);
543 return 0;
544}
545
546static sense_reason_t
Asias He50642762013-02-25 14:03:43 +0800547fd_execute_unmap(struct se_cmd *cmd)
548{
Asias He86d71822013-02-25 14:03:46 +0800549 struct file *file = FD_DEV(cmd->se_dev)->fd_file;
Asias He50642762013-02-25 14:03:43 +0800550
Asias He86d71822013-02-25 14:03:46 +0800551 return sbc_execute_unmap(cmd, fd_do_unmap, file);
Asias He50642762013-02-25 14:03:43 +0800552}
553
554static sense_reason_t
Christoph Hellwigde103c92012-11-06 12:24:09 -0800555fd_execute_rw(struct se_cmd *cmd)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800556{
Christoph Hellwig0c2ad7d2012-06-17 18:40:52 -0400557 struct scatterlist *sgl = cmd->t_data_sg;
558 u32 sgl_nents = cmd->t_data_nents;
559 enum dma_data_direction data_direction = cmd->data_direction;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800560 struct se_device *dev = cmd->se_dev;
561 int ret = 0;
562
563 /*
564 * Call vectorized fileio functions to map struct scatterlist
565 * physical memory addresses to struct iovec virtual memory.
566 */
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400567 if (data_direction == DMA_FROM_DEVICE) {
Sebastian Andrzej Siewior778229a2012-12-05 13:09:45 -0800568 ret = fd_do_rw(cmd, sgl, sgl_nents, 0);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800569 } else {
Sebastian Andrzej Siewior778229a2012-12-05 13:09:45 -0800570 ret = fd_do_rw(cmd, sgl, sgl_nents, 1);
Nicholas Bellingera4dff302012-05-30 16:25:41 -0700571 /*
572 * Perform implict vfs_fsync_range() for fd_do_writev() ops
573 * for SCSI WRITEs with Forced Unit Access (FUA) set.
574 * Allow this to happen independent of WCE=0 setting.
575 */
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800576 if (ret > 0 &&
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400577 dev->dev_attrib.emulate_fua_write > 0 &&
Christoph Hellwig2d3a4b52011-11-14 11:36:29 -0500578 (cmd->se_cmd_flags & SCF_FUA)) {
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400579 struct fd_dev *fd_dev = FD_DEV(dev);
Nicholas Bellingera4dff302012-05-30 16:25:41 -0700580 loff_t start = cmd->t_task_lba *
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400581 dev->dev_attrib.block_size;
Nicholas Bellingera4dff302012-05-30 16:25:41 -0700582 loff_t end = start + cmd->data_length;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800583
Nicholas Bellingera4dff302012-05-30 16:25:41 -0700584 vfs_fsync_range(fd_dev->fd_file, start, end, 1);
585 }
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800586 }
587
Christoph Hellwigde103c92012-11-06 12:24:09 -0800588 if (ret < 0)
589 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
590
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400591 if (ret)
592 target_complete_cmd(cmd, SAM_STAT_GOOD);
Nicholas Bellinger03e98c92011-11-04 02:36:16 -0700593 return 0;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800594}
595
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800596enum {
597 Opt_fd_dev_name, Opt_fd_dev_size, Opt_fd_buffered_io, Opt_err
598};
599
600static match_table_t tokens = {
601 {Opt_fd_dev_name, "fd_dev_name=%s"},
602 {Opt_fd_dev_size, "fd_dev_size=%s"},
Nicholas Bellingerb32f4c72012-09-29 17:15:37 -0700603 {Opt_fd_buffered_io, "fd_buffered_io=%d"},
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800604 {Opt_err, NULL}
605};
606
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400607static ssize_t fd_set_configfs_dev_params(struct se_device *dev,
608 const char *page, ssize_t count)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800609{
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400610 struct fd_dev *fd_dev = FD_DEV(dev);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800611 char *orig, *ptr, *arg_p, *opts;
612 substring_t args[MAX_OPT_ARGS];
Nicholas Bellingerb32f4c72012-09-29 17:15:37 -0700613 int ret = 0, arg, token;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800614
615 opts = kstrdup(page, GFP_KERNEL);
616 if (!opts)
617 return -ENOMEM;
618
619 orig = opts;
620
Sebastian Andrzej Siewior90c161b2011-11-23 20:53:17 +0100621 while ((ptr = strsep(&opts, ",\n")) != NULL) {
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800622 if (!*ptr)
623 continue;
624
625 token = match_token(ptr, tokens, args);
626 switch (token) {
627 case Opt_fd_dev_name:
Al Virodbc6e022012-08-01 13:07:04 +0400628 if (match_strlcpy(fd_dev->fd_dev_name, &args[0],
629 FD_MAX_DEV_NAME) == 0) {
630 ret = -EINVAL;
Jesper Juhl6d180252011-03-14 04:05:56 -0700631 break;
632 }
Andy Grover6708bb22011-06-08 10:36:43 -0700633 pr_debug("FILEIO: Referencing Path: %s\n",
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800634 fd_dev->fd_dev_name);
635 fd_dev->fbd_flags |= FBDF_HAS_PATH;
636 break;
637 case Opt_fd_dev_size:
638 arg_p = match_strdup(&args[0]);
Jesper Juhl6d180252011-03-14 04:05:56 -0700639 if (!arg_p) {
640 ret = -ENOMEM;
641 break;
642 }
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800643 ret = strict_strtoull(arg_p, 0, &fd_dev->fd_dev_size);
Jesper Juhl6d180252011-03-14 04:05:56 -0700644 kfree(arg_p);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800645 if (ret < 0) {
Andy Grover6708bb22011-06-08 10:36:43 -0700646 pr_err("strict_strtoull() failed for"
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800647 " fd_dev_size=\n");
648 goto out;
649 }
Andy Grover6708bb22011-06-08 10:36:43 -0700650 pr_debug("FILEIO: Referencing Size: %llu"
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800651 " bytes\n", fd_dev->fd_dev_size);
652 fd_dev->fbd_flags |= FBDF_HAS_SIZE;
653 break;
Nicholas Bellingerb32f4c72012-09-29 17:15:37 -0700654 case Opt_fd_buffered_io:
655 match_int(args, &arg);
656 if (arg != 1) {
657 pr_err("bogus fd_buffered_io=%d value\n", arg);
658 ret = -EINVAL;
659 goto out;
660 }
661
662 pr_debug("FILEIO: Using buffered I/O"
663 " operations for struct fd_dev\n");
664
665 fd_dev->fbd_flags |= FDBD_HAS_BUFFERED_IO_WCE;
666 break;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800667 default:
668 break;
669 }
670 }
671
672out:
673 kfree(orig);
674 return (!ret) ? count : ret;
675}
676
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400677static ssize_t fd_show_configfs_dev_params(struct se_device *dev, char *b)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800678{
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400679 struct fd_dev *fd_dev = FD_DEV(dev);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800680 ssize_t bl = 0;
681
682 bl = sprintf(b + bl, "TCM FILEIO ID: %u", fd_dev->fd_dev_id);
Nicholas Bellingerb32f4c72012-09-29 17:15:37 -0700683 bl += sprintf(b + bl, " File: %s Size: %llu Mode: %s\n",
684 fd_dev->fd_dev_name, fd_dev->fd_dev_size,
685 (fd_dev->fbd_flags & FDBD_HAS_BUFFERED_IO_WCE) ?
686 "Buffered-WCE" : "O_DSYNC");
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800687 return bl;
688}
689
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800690static sector_t fd_get_blocks(struct se_device *dev)
691{
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400692 struct fd_dev *fd_dev = FD_DEV(dev);
Nicholas Bellingercd9323f2012-05-16 16:05:26 -0700693 struct file *f = fd_dev->fd_file;
694 struct inode *i = f->f_mapping->host;
695 unsigned long long dev_size;
696 /*
697 * When using a file that references an underlying struct block_device,
698 * ensure dev_size is always based on the current inode size in order
699 * to handle underlying block_device resize operations.
700 */
701 if (S_ISBLK(i->i_mode))
702 dev_size = (i_size_read(i) - fd_dev->fd_block_size);
703 else
704 dev_size = fd_dev->fd_dev_size;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800705
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400706 return div_u64(dev_size, dev->dev_attrib.block_size);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800707}
708
Christoph Hellwig9e999a62012-10-07 10:55:50 -0400709static struct sbc_ops fd_sbc_ops = {
Christoph Hellwig0c2ad7d2012-06-17 18:40:52 -0400710 .execute_rw = fd_execute_rw,
Christoph Hellwigad67f0d2012-06-17 18:40:53 -0400711 .execute_sync_cache = fd_execute_sync_cache,
Nicholas Bellinger7b745c82013-02-19 17:30:34 -0800712 .execute_write_same = fd_execute_write_same,
Asias He70d3ae5c2013-02-25 14:03:42 +0800713 .execute_write_same_unmap = fd_execute_write_same_unmap,
Asias He50642762013-02-25 14:03:43 +0800714 .execute_unmap = fd_execute_unmap,
Christoph Hellwig0c2ad7d2012-06-17 18:40:52 -0400715};
716
Christoph Hellwigde103c92012-11-06 12:24:09 -0800717static sense_reason_t
718fd_parse_cdb(struct se_cmd *cmd)
Christoph Hellwig0c2ad7d2012-06-17 18:40:52 -0400719{
Christoph Hellwig9e999a62012-10-07 10:55:50 -0400720 return sbc_parse_cdb(cmd, &fd_sbc_ops);
Christoph Hellwig0c2ad7d2012-06-17 18:40:52 -0400721}
722
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800723static struct se_subsystem_api fileio_template = {
724 .name = "fileio",
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400725 .inquiry_prod = "FILEIO",
726 .inquiry_rev = FD_VERSION,
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800727 .owner = THIS_MODULE,
728 .transport_type = TRANSPORT_PLUGIN_VHBA_PDEV,
729 .attach_hba = fd_attach_hba,
730 .detach_hba = fd_detach_hba,
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400731 .alloc_device = fd_alloc_device,
732 .configure_device = fd_configure_device,
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800733 .free_device = fd_free_device,
Christoph Hellwig0c2ad7d2012-06-17 18:40:52 -0400734 .parse_cdb = fd_parse_cdb,
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800735 .set_configfs_dev_params = fd_set_configfs_dev_params,
736 .show_configfs_dev_params = fd_show_configfs_dev_params,
Christoph Hellwig6f23ac82012-10-07 10:55:53 -0400737 .get_device_type = sbc_get_device_type,
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800738 .get_blocks = fd_get_blocks,
739};
740
741static int __init fileio_module_init(void)
742{
743 return transport_subsystem_register(&fileio_template);
744}
745
Asias He63b91d52013-02-27 12:50:56 +0800746static void __exit fileio_module_exit(void)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800747{
748 transport_subsystem_release(&fileio_template);
749}
750
751MODULE_DESCRIPTION("TCM FILEIO subsystem plugin");
752MODULE_AUTHOR("nab@Linux-iSCSI.org");
753MODULE_LICENSE("GPL");
754
755module_init(fileio_module_init);
756module_exit(fileio_module_exit);