blob: b662f89dedac39b0fe824e4d31583a9dc4553986 [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 Bellinger4c762512013-09-05 15:29:12 -07006 * (c) Copyright 2005-2013 Datera, Inc.
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
Nicholas Bellinger21363ca2013-05-29 21:35:23 -0700156 fd_dev->fd_block_size = bdev_logical_block_size(inode->i_bdev);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800157 /*
158 * Determine the number of bytes from i_size_read() minus
159 * one (1) logical sector from underlying struct block_device
160 */
Nicholas Bellingercd9323f2012-05-16 16:05:26 -0700161 dev_size = (i_size_read(file->f_mapping->host) -
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800162 fd_dev->fd_block_size);
163
Andy Grover6708bb22011-06-08 10:36:43 -0700164 pr_debug("FILEIO: Using size: %llu bytes from struct"
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800165 " block_device blocks: %llu logical_block_size: %d\n",
Nicholas Bellingercd9323f2012-05-16 16:05:26 -0700166 dev_size, div_u64(dev_size, fd_dev->fd_block_size),
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800167 fd_dev->fd_block_size);
Asias He70d3ae5c2013-02-25 14:03:42 +0800168 /*
169 * Check if the underlying struct block_device request_queue supports
170 * the QUEUE_FLAG_DISCARD bit for UNMAP/WRITE_SAME in SCSI + TRIM
171 * in ATA and we need to set TPE=1
172 */
173 if (blk_queue_discard(q)) {
174 dev->dev_attrib.max_unmap_lba_count =
175 q->limits.max_discard_sectors;
176 /*
177 * Currently hardcoded to 1 in Linux/SCSI code..
178 */
179 dev->dev_attrib.max_unmap_block_desc_count = 1;
180 dev->dev_attrib.unmap_granularity =
181 q->limits.discard_granularity >> 9;
182 dev->dev_attrib.unmap_granularity_alignment =
183 q->limits.discard_alignment;
184 pr_debug("IFILE: BLOCK Discard support available,"
185 " disabled by default\n");
186 }
187 /*
188 * Enable write same emulation for IBLOCK and use 0xFFFF as
189 * the smaller WRITE_SAME(10) only has a two-byte block count.
190 */
191 dev->dev_attrib.max_write_same_len = 0xFFFF;
Asias He0463a3f2013-04-24 19:38:11 -0700192
193 if (blk_queue_nonrot(q))
194 dev->dev_attrib.is_nonrot = 1;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800195 } else {
196 if (!(fd_dev->fbd_flags & FBDF_HAS_SIZE)) {
Andy Grover6708bb22011-06-08 10:36:43 -0700197 pr_err("FILEIO: Missing fd_dev_size="
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800198 " parameter, and no backing struct"
199 " block_device\n");
200 goto fail;
201 }
202
Nicholas Bellinger21363ca2013-05-29 21:35:23 -0700203 fd_dev->fd_block_size = FD_BLOCKSIZE;
Asias He70d3ae5c2013-02-25 14:03:42 +0800204 /*
205 * Limit UNMAP emulation to 8k Number of LBAs (NoLB)
206 */
207 dev->dev_attrib.max_unmap_lba_count = 0x2000;
208 /*
209 * Currently hardcoded to 1 in Linux/SCSI code..
210 */
211 dev->dev_attrib.max_unmap_block_desc_count = 1;
212 dev->dev_attrib.unmap_granularity = 1;
213 dev->dev_attrib.unmap_granularity_alignment = 0;
214
215 /*
216 * Limit WRITE_SAME w/ UNMAP=0 emulation to 8k Number of LBAs (NoLB)
217 * based upon struct iovec limit for vfs_writev()
218 */
219 dev->dev_attrib.max_write_same_len = 0x1000;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800220 }
221
Nicholas Bellinger21363ca2013-05-29 21:35:23 -0700222 dev->dev_attrib.hw_block_size = fd_dev->fd_block_size;
Andy Grovere3e84cd2013-04-26 11:09:03 -0700223 dev->dev_attrib.hw_max_sectors = FD_MAX_SECTORS;
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400224 dev->dev_attrib.hw_queue_depth = FD_MAX_DEVICE_QUEUE_DEPTH;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800225
Nicholas Bellingerb32f4c72012-09-29 17:15:37 -0700226 if (fd_dev->fbd_flags & FDBD_HAS_BUFFERED_IO_WCE) {
227 pr_debug("FILEIO: Forcing setting of emulate_write_cache=1"
228 " with FDBD_HAS_BUFFERED_IO_WCE\n");
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400229 dev->dev_attrib.emulate_write_cache = 1;
Nicholas Bellingerb32f4c72012-09-29 17:15:37 -0700230 }
231
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800232 fd_dev->fd_dev_id = fd_host->fd_host_dev_id_count++;
233 fd_dev->fd_queue_depth = dev->queue_depth;
234
Andy Grover6708bb22011-06-08 10:36:43 -0700235 pr_debug("CORE_FILE[%u] - Added TCM FILEIO Device ID: %u at %s,"
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800236 " %llu total bytes\n", fd_host->fd_host_id, fd_dev->fd_dev_id,
237 fd_dev->fd_dev_name, fd_dev->fd_dev_size);
238
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400239 return 0;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800240fail:
241 if (fd_dev->fd_file) {
242 filp_close(fd_dev->fd_file, NULL);
243 fd_dev->fd_file = NULL;
244 }
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400245 return ret;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800246}
247
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400248static void fd_free_device(struct se_device *dev)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800249{
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400250 struct fd_dev *fd_dev = FD_DEV(dev);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800251
252 if (fd_dev->fd_file) {
253 filp_close(fd_dev->fd_file, NULL);
254 fd_dev->fd_file = NULL;
255 }
256
257 kfree(fd_dev);
258}
259
Sebastian Andrzej Siewior778229a2012-12-05 13:09:45 -0800260static int fd_do_rw(struct se_cmd *cmd, struct scatterlist *sgl,
261 u32 sgl_nents, int is_write)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800262{
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400263 struct se_device *se_dev = cmd->se_dev;
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400264 struct fd_dev *dev = FD_DEV(se_dev);
Andy Grover6708bb22011-06-08 10:36:43 -0700265 struct file *fd = dev->fd_file;
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400266 struct scatterlist *sg;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800267 struct iovec *iov;
268 mm_segment_t old_fs;
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400269 loff_t pos = (cmd->t_task_lba * se_dev->dev_attrib.block_size);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800270 int ret = 0, i;
271
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400272 iov = kzalloc(sizeof(struct iovec) * sgl_nents, GFP_KERNEL);
Andy Grover6708bb22011-06-08 10:36:43 -0700273 if (!iov) {
274 pr_err("Unable to allocate fd_do_readv iov[]\n");
Andy Grovere3d6f902011-07-19 08:55:10 +0000275 return -ENOMEM;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800276 }
277
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400278 for_each_sg(sgl, sg, sgl_nents, i) {
Sebastian Andrzej Siewior9649fa12011-11-28 12:33:10 +0100279 iov[i].iov_len = sg->length;
Sebastian Andrzej Siewior40ff2c32012-12-05 12:08:29 +0100280 iov[i].iov_base = kmap(sg_page(sg)) + sg->offset;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800281 }
282
283 old_fs = get_fs();
284 set_fs(get_ds());
Sebastian Andrzej Siewior778229a2012-12-05 13:09:45 -0800285
286 if (is_write)
287 ret = vfs_writev(fd, &iov[0], sgl_nents, &pos);
288 else
289 ret = vfs_readv(fd, &iov[0], sgl_nents, &pos);
290
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800291 set_fs(old_fs);
292
Sebastian Andrzej Siewior40ff2c32012-12-05 12:08:29 +0100293 for_each_sg(sgl, sg, sgl_nents, i)
294 kunmap(sg_page(sg));
Sebastian Andrzej Siewior778229a2012-12-05 13:09:45 -0800295
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800296 kfree(iov);
Sebastian Andrzej Siewior778229a2012-12-05 13:09:45 -0800297
298 if (is_write) {
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400299 if (ret < 0 || ret != cmd->data_length) {
Sebastian Andrzej Siewior778229a2012-12-05 13:09:45 -0800300 pr_err("%s() write returned %d\n", __func__, ret);
Andy Grovere3d6f902011-07-19 08:55:10 +0000301 return (ret < 0 ? ret : -EINVAL);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800302 }
303 } else {
Sebastian Andrzej Siewior778229a2012-12-05 13:09:45 -0800304 /*
305 * Return zeros and GOOD status even if the READ did not return
306 * the expected virt_size for struct file w/o a backing struct
307 * block_device.
308 */
Al Viro496ad9a2013-01-23 17:07:38 -0500309 if (S_ISBLK(file_inode(fd)->i_mode)) {
Sebastian Andrzej Siewior778229a2012-12-05 13:09:45 -0800310 if (ret < 0 || ret != cmd->data_length) {
311 pr_err("%s() returned %d, expecting %u for "
312 "S_ISBLK\n", __func__, ret,
313 cmd->data_length);
314 return (ret < 0 ? ret : -EINVAL);
315 }
316 } else {
317 if (ret < 0) {
318 pr_err("%s() returned %d for non S_ISBLK\n",
319 __func__, ret);
320 return ret;
321 }
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800322 }
323 }
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800324 return 1;
325}
326
Christoph Hellwigde103c92012-11-06 12:24:09 -0800327static sense_reason_t
328fd_execute_sync_cache(struct se_cmd *cmd)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800329{
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800330 struct se_device *dev = cmd->se_dev;
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400331 struct fd_dev *fd_dev = FD_DEV(dev);
Andy Grovera1d8b492011-05-02 17:12:10 -0700332 int immed = (cmd->t_task_cdb[1] & 0x2);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800333 loff_t start, end;
334 int ret;
335
336 /*
337 * If the Immediate bit is set, queue up the GOOD response
338 * for this SYNCHRONIZE_CACHE op
339 */
340 if (immed)
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400341 target_complete_cmd(cmd, SAM_STAT_GOOD);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800342
343 /*
344 * Determine if we will be flushing the entire device.
345 */
Andy Grovera1d8b492011-05-02 17:12:10 -0700346 if (cmd->t_task_lba == 0 && cmd->data_length == 0) {
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800347 start = 0;
348 end = LLONG_MAX;
349 } else {
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400350 start = cmd->t_task_lba * dev->dev_attrib.block_size;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800351 if (cmd->data_length)
352 end = start + cmd->data_length;
353 else
354 end = LLONG_MAX;
355 }
356
357 ret = vfs_fsync_range(fd_dev->fd_file, start, end, 1);
358 if (ret != 0)
Andy Grover6708bb22011-06-08 10:36:43 -0700359 pr_err("FILEIO: vfs_fsync_range() failed: %d\n", ret);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800360
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400361 if (immed)
Christoph Hellwigad67f0d2012-06-17 18:40:53 -0400362 return 0;
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400363
Christoph Hellwigde103c92012-11-06 12:24:09 -0800364 if (ret)
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400365 target_complete_cmd(cmd, SAM_STAT_CHECK_CONDITION);
Christoph Hellwigde103c92012-11-06 12:24:09 -0800366 else
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400367 target_complete_cmd(cmd, SAM_STAT_GOOD);
Christoph Hellwigad67f0d2012-06-17 18:40:53 -0400368
369 return 0;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800370}
371
Nicholas Bellinger7b745c82013-02-19 17:30:34 -0800372static unsigned char *
373fd_setup_write_same_buf(struct se_cmd *cmd, struct scatterlist *sg,
374 unsigned int len)
375{
376 struct se_device *se_dev = cmd->se_dev;
377 unsigned int block_size = se_dev->dev_attrib.block_size;
378 unsigned int i = 0, end;
379 unsigned char *buf, *p, *kmap_buf;
380
381 buf = kzalloc(min_t(unsigned int, len, PAGE_SIZE), GFP_KERNEL);
382 if (!buf) {
383 pr_err("Unable to allocate fd_execute_write_same buf\n");
384 return NULL;
385 }
386
387 kmap_buf = kmap(sg_page(sg)) + sg->offset;
388 if (!kmap_buf) {
389 pr_err("kmap() failed in fd_setup_write_same\n");
390 kfree(buf);
391 return NULL;
392 }
393 /*
394 * Fill local *buf to contain multiple WRITE_SAME blocks up to
395 * min(len, PAGE_SIZE)
396 */
397 p = buf;
398 end = min_t(unsigned int, len, PAGE_SIZE);
399
400 while (i < end) {
401 memcpy(p, kmap_buf, block_size);
402
403 i += block_size;
404 p += block_size;
405 }
406 kunmap(sg_page(sg));
407
408 return buf;
409}
410
411static sense_reason_t
412fd_execute_write_same(struct se_cmd *cmd)
413{
414 struct se_device *se_dev = cmd->se_dev;
415 struct fd_dev *fd_dev = FD_DEV(se_dev);
416 struct file *f = fd_dev->fd_file;
417 struct scatterlist *sg;
418 struct iovec *iov;
419 mm_segment_t old_fs;
Roland Dreier972b29c82013-02-22 09:52:57 -0800420 sector_t nolb = sbc_get_write_same_sectors(cmd);
Nicholas Bellinger7b745c82013-02-19 17:30:34 -0800421 loff_t pos = cmd->t_task_lba * se_dev->dev_attrib.block_size;
422 unsigned int len, len_tmp, iov_num;
423 int i, rc;
424 unsigned char *buf;
425
426 if (!nolb) {
427 target_complete_cmd(cmd, SAM_STAT_GOOD);
428 return 0;
429 }
430 sg = &cmd->t_data_sg[0];
431
432 if (cmd->t_data_nents > 1 ||
433 sg->length != cmd->se_dev->dev_attrib.block_size) {
434 pr_err("WRITE_SAME: Illegal SGL t_data_nents: %u length: %u"
435 " block_size: %u\n", cmd->t_data_nents, sg->length,
436 cmd->se_dev->dev_attrib.block_size);
437 return TCM_INVALID_CDB_FIELD;
438 }
439
440 len = len_tmp = nolb * se_dev->dev_attrib.block_size;
441 iov_num = DIV_ROUND_UP(len, PAGE_SIZE);
442
443 buf = fd_setup_write_same_buf(cmd, sg, len);
444 if (!buf)
445 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
446
447 iov = vzalloc(sizeof(struct iovec) * iov_num);
448 if (!iov) {
449 pr_err("Unable to allocate fd_execute_write_same iovecs\n");
450 kfree(buf);
451 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
452 }
453 /*
454 * Map the single fabric received scatterlist block now populated
455 * in *buf into each iovec for I/O submission.
456 */
457 for (i = 0; i < iov_num; i++) {
458 iov[i].iov_base = buf;
459 iov[i].iov_len = min_t(unsigned int, len_tmp, PAGE_SIZE);
460 len_tmp -= iov[i].iov_len;
461 }
462
463 old_fs = get_fs();
464 set_fs(get_ds());
465 rc = vfs_writev(f, &iov[0], iov_num, &pos);
466 set_fs(old_fs);
467
468 vfree(iov);
469 kfree(buf);
470
471 if (rc < 0 || rc != len) {
472 pr_err("vfs_writev() returned %d for write same\n", rc);
473 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
474 }
475
476 target_complete_cmd(cmd, SAM_STAT_GOOD);
477 return 0;
478}
479
Christoph Hellwigde103c92012-11-06 12:24:09 -0800480static sense_reason_t
Asias He86d71822013-02-25 14:03:46 +0800481fd_do_unmap(struct se_cmd *cmd, void *priv, sector_t lba, sector_t nolb)
Asias He70d3ae5c2013-02-25 14:03:42 +0800482{
Asias He86d71822013-02-25 14:03:46 +0800483 struct file *file = priv;
Asias He70d3ae5c2013-02-25 14:03:42 +0800484 struct inode *inode = file->f_mapping->host;
Asias He70d3ae5c2013-02-25 14:03:42 +0800485 int ret;
486
Asias He70d3ae5c2013-02-25 14:03:42 +0800487 if (S_ISBLK(inode->i_mode)) {
488 /* The backend is block device, use discard */
489 struct block_device *bdev = inode->i_bdev;
490
Asias He43f55bb2013-02-25 14:03:44 +0800491 ret = blkdev_issue_discard(bdev, lba,
Asias He70d3ae5c2013-02-25 14:03:42 +0800492 nolb, GFP_KERNEL, 0);
493 if (ret < 0) {
494 pr_warn("FILEIO: blkdev_issue_discard() failed: %d\n",
495 ret);
496 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
497 }
498 } else {
499 /* The backend is normal file, use fallocate */
Asias He43f55bb2013-02-25 14:03:44 +0800500 struct se_device *se_dev = cmd->se_dev;
501 loff_t pos = lba * se_dev->dev_attrib.block_size;
Asias He70d3ae5c2013-02-25 14:03:42 +0800502 unsigned int len = nolb * se_dev->dev_attrib.block_size;
503 int mode = FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE;
504
505 if (!file->f_op->fallocate)
506 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
507
508 ret = file->f_op->fallocate(file, mode, pos, len);
509 if (ret < 0) {
510 pr_warn("FILEIO: fallocate() failed: %d\n", ret);
511 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
512 }
513 }
514
Asias He43f55bb2013-02-25 14:03:44 +0800515 return 0;
516}
517
518static sense_reason_t
519fd_execute_write_same_unmap(struct se_cmd *cmd)
520{
521 struct se_device *se_dev = cmd->se_dev;
522 struct fd_dev *fd_dev = FD_DEV(se_dev);
523 struct file *file = fd_dev->fd_file;
524 sector_t lba = cmd->t_task_lba;
525 sector_t nolb = sbc_get_write_same_sectors(cmd);
526 int ret;
527
528 if (!nolb) {
529 target_complete_cmd(cmd, SAM_STAT_GOOD);
530 return 0;
531 }
532
533 ret = fd_do_unmap(cmd, file, lba, nolb);
534 if (ret)
535 return ret;
536
Asias He70d3ae5c2013-02-25 14:03:42 +0800537 target_complete_cmd(cmd, GOOD);
538 return 0;
539}
540
541static sense_reason_t
Asias He50642762013-02-25 14:03:43 +0800542fd_execute_unmap(struct se_cmd *cmd)
543{
Asias He86d71822013-02-25 14:03:46 +0800544 struct file *file = FD_DEV(cmd->se_dev)->fd_file;
Asias He50642762013-02-25 14:03:43 +0800545
Asias He86d71822013-02-25 14:03:46 +0800546 return sbc_execute_unmap(cmd, fd_do_unmap, file);
Asias He50642762013-02-25 14:03:43 +0800547}
548
549static sense_reason_t
Nicholas Bellingera82a9532013-08-19 23:57:30 -0700550fd_execute_rw(struct se_cmd *cmd, struct scatterlist *sgl, u32 sgl_nents,
551 enum dma_data_direction data_direction)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800552{
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800553 struct se_device *dev = cmd->se_dev;
554 int ret = 0;
555
556 /*
557 * Call vectorized fileio functions to map struct scatterlist
558 * physical memory addresses to struct iovec virtual memory.
559 */
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400560 if (data_direction == DMA_FROM_DEVICE) {
Sebastian Andrzej Siewior778229a2012-12-05 13:09:45 -0800561 ret = fd_do_rw(cmd, sgl, sgl_nents, 0);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800562 } else {
Sebastian Andrzej Siewior778229a2012-12-05 13:09:45 -0800563 ret = fd_do_rw(cmd, sgl, sgl_nents, 1);
Nicholas Bellingera4dff302012-05-30 16:25:41 -0700564 /*
565 * Perform implict vfs_fsync_range() for fd_do_writev() ops
566 * for SCSI WRITEs with Forced Unit Access (FUA) set.
567 * Allow this to happen independent of WCE=0 setting.
568 */
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800569 if (ret > 0 &&
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400570 dev->dev_attrib.emulate_fua_write > 0 &&
Christoph Hellwig2d3a4b52011-11-14 11:36:29 -0500571 (cmd->se_cmd_flags & SCF_FUA)) {
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400572 struct fd_dev *fd_dev = FD_DEV(dev);
Nicholas Bellingera4dff302012-05-30 16:25:41 -0700573 loff_t start = cmd->t_task_lba *
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400574 dev->dev_attrib.block_size;
Nicholas Bellingera4dff302012-05-30 16:25:41 -0700575 loff_t end = start + cmd->data_length;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800576
Nicholas Bellingera4dff302012-05-30 16:25:41 -0700577 vfs_fsync_range(fd_dev->fd_file, start, end, 1);
578 }
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800579 }
580
Christoph Hellwigde103c92012-11-06 12:24:09 -0800581 if (ret < 0)
582 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
583
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400584 if (ret)
585 target_complete_cmd(cmd, SAM_STAT_GOOD);
Nicholas Bellinger03e98c92011-11-04 02:36:16 -0700586 return 0;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800587}
588
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800589enum {
590 Opt_fd_dev_name, Opt_fd_dev_size, Opt_fd_buffered_io, Opt_err
591};
592
593static match_table_t tokens = {
594 {Opt_fd_dev_name, "fd_dev_name=%s"},
595 {Opt_fd_dev_size, "fd_dev_size=%s"},
Nicholas Bellingerb32f4c72012-09-29 17:15:37 -0700596 {Opt_fd_buffered_io, "fd_buffered_io=%d"},
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800597 {Opt_err, NULL}
598};
599
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400600static ssize_t fd_set_configfs_dev_params(struct se_device *dev,
601 const char *page, ssize_t count)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800602{
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400603 struct fd_dev *fd_dev = FD_DEV(dev);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800604 char *orig, *ptr, *arg_p, *opts;
605 substring_t args[MAX_OPT_ARGS];
Nicholas Bellingerb32f4c72012-09-29 17:15:37 -0700606 int ret = 0, arg, token;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800607
608 opts = kstrdup(page, GFP_KERNEL);
609 if (!opts)
610 return -ENOMEM;
611
612 orig = opts;
613
Sebastian Andrzej Siewior90c161b2011-11-23 20:53:17 +0100614 while ((ptr = strsep(&opts, ",\n")) != NULL) {
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800615 if (!*ptr)
616 continue;
617
618 token = match_token(ptr, tokens, args);
619 switch (token) {
620 case Opt_fd_dev_name:
Al Virodbc6e022012-08-01 13:07:04 +0400621 if (match_strlcpy(fd_dev->fd_dev_name, &args[0],
622 FD_MAX_DEV_NAME) == 0) {
623 ret = -EINVAL;
Jesper Juhl6d180252011-03-14 04:05:56 -0700624 break;
625 }
Andy Grover6708bb22011-06-08 10:36:43 -0700626 pr_debug("FILEIO: Referencing Path: %s\n",
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800627 fd_dev->fd_dev_name);
628 fd_dev->fbd_flags |= FBDF_HAS_PATH;
629 break;
630 case Opt_fd_dev_size:
631 arg_p = match_strdup(&args[0]);
Jesper Juhl6d180252011-03-14 04:05:56 -0700632 if (!arg_p) {
633 ret = -ENOMEM;
634 break;
635 }
Jingoo Han57103d72013-07-19 16:22:19 +0900636 ret = kstrtoull(arg_p, 0, &fd_dev->fd_dev_size);
Jesper Juhl6d180252011-03-14 04:05:56 -0700637 kfree(arg_p);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800638 if (ret < 0) {
Jingoo Han57103d72013-07-19 16:22:19 +0900639 pr_err("kstrtoull() failed for"
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800640 " fd_dev_size=\n");
641 goto out;
642 }
Andy Grover6708bb22011-06-08 10:36:43 -0700643 pr_debug("FILEIO: Referencing Size: %llu"
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800644 " bytes\n", fd_dev->fd_dev_size);
645 fd_dev->fbd_flags |= FBDF_HAS_SIZE;
646 break;
Nicholas Bellingerb32f4c72012-09-29 17:15:37 -0700647 case Opt_fd_buffered_io:
648 match_int(args, &arg);
649 if (arg != 1) {
650 pr_err("bogus fd_buffered_io=%d value\n", arg);
651 ret = -EINVAL;
652 goto out;
653 }
654
655 pr_debug("FILEIO: Using buffered I/O"
656 " operations for struct fd_dev\n");
657
658 fd_dev->fbd_flags |= FDBD_HAS_BUFFERED_IO_WCE;
659 break;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800660 default:
661 break;
662 }
663 }
664
665out:
666 kfree(orig);
667 return (!ret) ? count : ret;
668}
669
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400670static ssize_t fd_show_configfs_dev_params(struct se_device *dev, char *b)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800671{
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400672 struct fd_dev *fd_dev = FD_DEV(dev);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800673 ssize_t bl = 0;
674
675 bl = sprintf(b + bl, "TCM FILEIO ID: %u", fd_dev->fd_dev_id);
Nicholas Bellingerb32f4c72012-09-29 17:15:37 -0700676 bl += sprintf(b + bl, " File: %s Size: %llu Mode: %s\n",
677 fd_dev->fd_dev_name, fd_dev->fd_dev_size,
678 (fd_dev->fbd_flags & FDBD_HAS_BUFFERED_IO_WCE) ?
679 "Buffered-WCE" : "O_DSYNC");
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800680 return bl;
681}
682
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800683static sector_t fd_get_blocks(struct se_device *dev)
684{
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400685 struct fd_dev *fd_dev = FD_DEV(dev);
Nicholas Bellingercd9323f2012-05-16 16:05:26 -0700686 struct file *f = fd_dev->fd_file;
687 struct inode *i = f->f_mapping->host;
688 unsigned long long dev_size;
689 /*
690 * When using a file that references an underlying struct block_device,
691 * ensure dev_size is always based on the current inode size in order
692 * to handle underlying block_device resize operations.
693 */
694 if (S_ISBLK(i->i_mode))
Nicholas Bellinger21363ca2013-05-29 21:35:23 -0700695 dev_size = i_size_read(i);
Nicholas Bellingercd9323f2012-05-16 16:05:26 -0700696 else
697 dev_size = fd_dev->fd_dev_size;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800698
Nicholas Bellinger21363ca2013-05-29 21:35:23 -0700699 return div_u64(dev_size - dev->dev_attrib.block_size,
700 dev->dev_attrib.block_size);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800701}
702
Christoph Hellwig9e999a62012-10-07 10:55:50 -0400703static struct sbc_ops fd_sbc_ops = {
Christoph Hellwig0c2ad7d2012-06-17 18:40:52 -0400704 .execute_rw = fd_execute_rw,
Christoph Hellwigad67f0d2012-06-17 18:40:53 -0400705 .execute_sync_cache = fd_execute_sync_cache,
Nicholas Bellinger7b745c82013-02-19 17:30:34 -0800706 .execute_write_same = fd_execute_write_same,
Asias He70d3ae5c2013-02-25 14:03:42 +0800707 .execute_write_same_unmap = fd_execute_write_same_unmap,
Asias He50642762013-02-25 14:03:43 +0800708 .execute_unmap = fd_execute_unmap,
Christoph Hellwig0c2ad7d2012-06-17 18:40:52 -0400709};
710
Christoph Hellwigde103c92012-11-06 12:24:09 -0800711static sense_reason_t
712fd_parse_cdb(struct se_cmd *cmd)
Christoph Hellwig0c2ad7d2012-06-17 18:40:52 -0400713{
Christoph Hellwig9e999a62012-10-07 10:55:50 -0400714 return sbc_parse_cdb(cmd, &fd_sbc_ops);
Christoph Hellwig0c2ad7d2012-06-17 18:40:52 -0400715}
716
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800717static struct se_subsystem_api fileio_template = {
718 .name = "fileio",
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400719 .inquiry_prod = "FILEIO",
720 .inquiry_rev = FD_VERSION,
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800721 .owner = THIS_MODULE,
722 .transport_type = TRANSPORT_PLUGIN_VHBA_PDEV,
723 .attach_hba = fd_attach_hba,
724 .detach_hba = fd_detach_hba,
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400725 .alloc_device = fd_alloc_device,
726 .configure_device = fd_configure_device,
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800727 .free_device = fd_free_device,
Christoph Hellwig0c2ad7d2012-06-17 18:40:52 -0400728 .parse_cdb = fd_parse_cdb,
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800729 .set_configfs_dev_params = fd_set_configfs_dev_params,
730 .show_configfs_dev_params = fd_show_configfs_dev_params,
Christoph Hellwig6f23ac82012-10-07 10:55:53 -0400731 .get_device_type = sbc_get_device_type,
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800732 .get_blocks = fd_get_blocks,
733};
734
735static int __init fileio_module_init(void)
736{
737 return transport_subsystem_register(&fileio_template);
738}
739
Asias He63b91d52013-02-27 12:50:56 +0800740static void __exit fileio_module_exit(void)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800741{
742 transport_subsystem_release(&fileio_template);
743}
744
745MODULE_DESCRIPTION("TCM FILEIO subsystem plugin");
746MODULE_AUTHOR("nab@Linux-iSCSI.org");
747MODULE_LICENSE("GPL");
748
749module_init(fileio_module_init);
750module_exit(fileio_module_exit);