blob: 7e02304a102470b1018022007eba3cd8dd1ed3a8 [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;
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
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400203 dev->dev_attrib.hw_block_size = FD_BLOCKSIZE;
204 dev->dev_attrib.hw_max_sectors = FD_MAX_SECTORS;
Asias He70d3ae5c2013-02-25 14:03:42 +0800205
206 /*
207 * Limit UNMAP emulation to 8k Number of LBAs (NoLB)
208 */
209 dev->dev_attrib.max_unmap_lba_count = 0x2000;
210 /*
211 * Currently hardcoded to 1 in Linux/SCSI code..
212 */
213 dev->dev_attrib.max_unmap_block_desc_count = 1;
214 dev->dev_attrib.unmap_granularity = 1;
215 dev->dev_attrib.unmap_granularity_alignment = 0;
216
217 /*
218 * Limit WRITE_SAME w/ UNMAP=0 emulation to 8k Number of LBAs (NoLB)
219 * based upon struct iovec limit for vfs_writev()
220 */
221 dev->dev_attrib.max_write_same_len = 0x1000;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800222 }
223
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400224 fd_dev->fd_block_size = dev->dev_attrib.hw_block_size;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800225
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400226 dev->dev_attrib.hw_queue_depth = FD_MAX_DEVICE_QUEUE_DEPTH;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800227
Nicholas Bellingerb32f4c72012-09-29 17:15:37 -0700228 if (fd_dev->fbd_flags & FDBD_HAS_BUFFERED_IO_WCE) {
229 pr_debug("FILEIO: Forcing setting of emulate_write_cache=1"
230 " with FDBD_HAS_BUFFERED_IO_WCE\n");
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400231 dev->dev_attrib.emulate_write_cache = 1;
Nicholas Bellingerb32f4c72012-09-29 17:15:37 -0700232 }
233
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800234 fd_dev->fd_dev_id = fd_host->fd_host_dev_id_count++;
235 fd_dev->fd_queue_depth = dev->queue_depth;
236
Andy Grover6708bb22011-06-08 10:36:43 -0700237 pr_debug("CORE_FILE[%u] - Added TCM FILEIO Device ID: %u at %s,"
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800238 " %llu total bytes\n", fd_host->fd_host_id, fd_dev->fd_dev_id,
239 fd_dev->fd_dev_name, fd_dev->fd_dev_size);
240
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400241 return 0;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800242fail:
243 if (fd_dev->fd_file) {
244 filp_close(fd_dev->fd_file, NULL);
245 fd_dev->fd_file = NULL;
246 }
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400247 return ret;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800248}
249
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400250static void fd_free_device(struct se_device *dev)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800251{
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400252 struct fd_dev *fd_dev = FD_DEV(dev);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800253
254 if (fd_dev->fd_file) {
255 filp_close(fd_dev->fd_file, NULL);
256 fd_dev->fd_file = NULL;
257 }
258
259 kfree(fd_dev);
260}
261
Sebastian Andrzej Siewior778229a2012-12-05 13:09:45 -0800262static int fd_do_rw(struct se_cmd *cmd, struct scatterlist *sgl,
263 u32 sgl_nents, int is_write)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800264{
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400265 struct se_device *se_dev = cmd->se_dev;
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400266 struct fd_dev *dev = FD_DEV(se_dev);
Andy Grover6708bb22011-06-08 10:36:43 -0700267 struct file *fd = dev->fd_file;
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400268 struct scatterlist *sg;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800269 struct iovec *iov;
270 mm_segment_t old_fs;
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400271 loff_t pos = (cmd->t_task_lba * se_dev->dev_attrib.block_size);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800272 int ret = 0, i;
273
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400274 iov = kzalloc(sizeof(struct iovec) * sgl_nents, GFP_KERNEL);
Andy Grover6708bb22011-06-08 10:36:43 -0700275 if (!iov) {
276 pr_err("Unable to allocate fd_do_readv iov[]\n");
Andy Grovere3d6f902011-07-19 08:55:10 +0000277 return -ENOMEM;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800278 }
279
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400280 for_each_sg(sgl, sg, sgl_nents, i) {
Sebastian Andrzej Siewior9649fa12011-11-28 12:33:10 +0100281 iov[i].iov_len = sg->length;
Sebastian Andrzej Siewior40ff2c32012-12-05 12:08:29 +0100282 iov[i].iov_base = kmap(sg_page(sg)) + sg->offset;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800283 }
284
285 old_fs = get_fs();
286 set_fs(get_ds());
Sebastian Andrzej Siewior778229a2012-12-05 13:09:45 -0800287
288 if (is_write)
289 ret = vfs_writev(fd, &iov[0], sgl_nents, &pos);
290 else
291 ret = vfs_readv(fd, &iov[0], sgl_nents, &pos);
292
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800293 set_fs(old_fs);
294
Sebastian Andrzej Siewior40ff2c32012-12-05 12:08:29 +0100295 for_each_sg(sgl, sg, sgl_nents, i)
296 kunmap(sg_page(sg));
Sebastian Andrzej Siewior778229a2012-12-05 13:09:45 -0800297
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800298 kfree(iov);
Sebastian Andrzej Siewior778229a2012-12-05 13:09:45 -0800299
300 if (is_write) {
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400301 if (ret < 0 || ret != cmd->data_length) {
Sebastian Andrzej Siewior778229a2012-12-05 13:09:45 -0800302 pr_err("%s() write returned %d\n", __func__, ret);
Andy Grovere3d6f902011-07-19 08:55:10 +0000303 return (ret < 0 ? ret : -EINVAL);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800304 }
305 } else {
Sebastian Andrzej Siewior778229a2012-12-05 13:09:45 -0800306 /*
307 * Return zeros and GOOD status even if the READ did not return
308 * the expected virt_size for struct file w/o a backing struct
309 * block_device.
310 */
Al Viro496ad9a2013-01-23 17:07:38 -0500311 if (S_ISBLK(file_inode(fd)->i_mode)) {
Sebastian Andrzej Siewior778229a2012-12-05 13:09:45 -0800312 if (ret < 0 || ret != cmd->data_length) {
313 pr_err("%s() returned %d, expecting %u for "
314 "S_ISBLK\n", __func__, ret,
315 cmd->data_length);
316 return (ret < 0 ? ret : -EINVAL);
317 }
318 } else {
319 if (ret < 0) {
320 pr_err("%s() returned %d for non S_ISBLK\n",
321 __func__, ret);
322 return ret;
323 }
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800324 }
325 }
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800326 return 1;
327}
328
Christoph Hellwigde103c92012-11-06 12:24:09 -0800329static sense_reason_t
330fd_execute_sync_cache(struct se_cmd *cmd)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800331{
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800332 struct se_device *dev = cmd->se_dev;
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400333 struct fd_dev *fd_dev = FD_DEV(dev);
Andy Grovera1d8b492011-05-02 17:12:10 -0700334 int immed = (cmd->t_task_cdb[1] & 0x2);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800335 loff_t start, end;
336 int ret;
337
338 /*
339 * If the Immediate bit is set, queue up the GOOD response
340 * for this SYNCHRONIZE_CACHE op
341 */
342 if (immed)
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400343 target_complete_cmd(cmd, SAM_STAT_GOOD);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800344
345 /*
346 * Determine if we will be flushing the entire device.
347 */
Andy Grovera1d8b492011-05-02 17:12:10 -0700348 if (cmd->t_task_lba == 0 && cmd->data_length == 0) {
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800349 start = 0;
350 end = LLONG_MAX;
351 } else {
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400352 start = cmd->t_task_lba * dev->dev_attrib.block_size;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800353 if (cmd->data_length)
354 end = start + cmd->data_length;
355 else
356 end = LLONG_MAX;
357 }
358
359 ret = vfs_fsync_range(fd_dev->fd_file, start, end, 1);
360 if (ret != 0)
Andy Grover6708bb22011-06-08 10:36:43 -0700361 pr_err("FILEIO: vfs_fsync_range() failed: %d\n", ret);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800362
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400363 if (immed)
Christoph Hellwigad67f0d2012-06-17 18:40:53 -0400364 return 0;
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400365
Christoph Hellwigde103c92012-11-06 12:24:09 -0800366 if (ret)
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400367 target_complete_cmd(cmd, SAM_STAT_CHECK_CONDITION);
Christoph Hellwigde103c92012-11-06 12:24:09 -0800368 else
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400369 target_complete_cmd(cmd, SAM_STAT_GOOD);
Christoph Hellwigad67f0d2012-06-17 18:40:53 -0400370
371 return 0;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800372}
373
Nicholas Bellinger7b745c82013-02-19 17:30:34 -0800374static unsigned char *
375fd_setup_write_same_buf(struct se_cmd *cmd, struct scatterlist *sg,
376 unsigned int len)
377{
378 struct se_device *se_dev = cmd->se_dev;
379 unsigned int block_size = se_dev->dev_attrib.block_size;
380 unsigned int i = 0, end;
381 unsigned char *buf, *p, *kmap_buf;
382
383 buf = kzalloc(min_t(unsigned int, len, PAGE_SIZE), GFP_KERNEL);
384 if (!buf) {
385 pr_err("Unable to allocate fd_execute_write_same buf\n");
386 return NULL;
387 }
388
389 kmap_buf = kmap(sg_page(sg)) + sg->offset;
390 if (!kmap_buf) {
391 pr_err("kmap() failed in fd_setup_write_same\n");
392 kfree(buf);
393 return NULL;
394 }
395 /*
396 * Fill local *buf to contain multiple WRITE_SAME blocks up to
397 * min(len, PAGE_SIZE)
398 */
399 p = buf;
400 end = min_t(unsigned int, len, PAGE_SIZE);
401
402 while (i < end) {
403 memcpy(p, kmap_buf, block_size);
404
405 i += block_size;
406 p += block_size;
407 }
408 kunmap(sg_page(sg));
409
410 return buf;
411}
412
413static sense_reason_t
414fd_execute_write_same(struct se_cmd *cmd)
415{
416 struct se_device *se_dev = cmd->se_dev;
417 struct fd_dev *fd_dev = FD_DEV(se_dev);
418 struct file *f = fd_dev->fd_file;
419 struct scatterlist *sg;
420 struct iovec *iov;
421 mm_segment_t old_fs;
Roland Dreier972b29c82013-02-22 09:52:57 -0800422 sector_t nolb = sbc_get_write_same_sectors(cmd);
Nicholas Bellinger7b745c82013-02-19 17:30:34 -0800423 loff_t pos = cmd->t_task_lba * se_dev->dev_attrib.block_size;
424 unsigned int len, len_tmp, iov_num;
425 int i, rc;
426 unsigned char *buf;
427
428 if (!nolb) {
429 target_complete_cmd(cmd, SAM_STAT_GOOD);
430 return 0;
431 }
432 sg = &cmd->t_data_sg[0];
433
434 if (cmd->t_data_nents > 1 ||
435 sg->length != cmd->se_dev->dev_attrib.block_size) {
436 pr_err("WRITE_SAME: Illegal SGL t_data_nents: %u length: %u"
437 " block_size: %u\n", cmd->t_data_nents, sg->length,
438 cmd->se_dev->dev_attrib.block_size);
439 return TCM_INVALID_CDB_FIELD;
440 }
441
442 len = len_tmp = nolb * se_dev->dev_attrib.block_size;
443 iov_num = DIV_ROUND_UP(len, PAGE_SIZE);
444
445 buf = fd_setup_write_same_buf(cmd, sg, len);
446 if (!buf)
447 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
448
449 iov = vzalloc(sizeof(struct iovec) * iov_num);
450 if (!iov) {
451 pr_err("Unable to allocate fd_execute_write_same iovecs\n");
452 kfree(buf);
453 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
454 }
455 /*
456 * Map the single fabric received scatterlist block now populated
457 * in *buf into each iovec for I/O submission.
458 */
459 for (i = 0; i < iov_num; i++) {
460 iov[i].iov_base = buf;
461 iov[i].iov_len = min_t(unsigned int, len_tmp, PAGE_SIZE);
462 len_tmp -= iov[i].iov_len;
463 }
464
465 old_fs = get_fs();
466 set_fs(get_ds());
467 rc = vfs_writev(f, &iov[0], iov_num, &pos);
468 set_fs(old_fs);
469
470 vfree(iov);
471 kfree(buf);
472
473 if (rc < 0 || rc != len) {
474 pr_err("vfs_writev() returned %d for write same\n", rc);
475 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
476 }
477
478 target_complete_cmd(cmd, SAM_STAT_GOOD);
479 return 0;
480}
481
Christoph Hellwigde103c92012-11-06 12:24:09 -0800482static sense_reason_t
Asias He70d3ae5c2013-02-25 14:03:42 +0800483fd_execute_write_same_unmap(struct se_cmd *cmd)
484{
485 struct se_device *se_dev = cmd->se_dev;
486 struct fd_dev *fd_dev = FD_DEV(se_dev);
487 struct file *file = fd_dev->fd_file;
488 struct inode *inode = file->f_mapping->host;
489 sector_t nolb = sbc_get_write_same_sectors(cmd);
490 int ret;
491
492 if (!nolb) {
493 target_complete_cmd(cmd, SAM_STAT_GOOD);
494 return 0;
495 }
496
497 if (S_ISBLK(inode->i_mode)) {
498 /* The backend is block device, use discard */
499 struct block_device *bdev = inode->i_bdev;
500
501 ret = blkdev_issue_discard(bdev, cmd->t_task_lba,
502 nolb, GFP_KERNEL, 0);
503 if (ret < 0) {
504 pr_warn("FILEIO: blkdev_issue_discard() failed: %d\n",
505 ret);
506 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
507 }
508 } else {
509 /* The backend is normal file, use fallocate */
510 loff_t pos = cmd->t_task_lba * se_dev->dev_attrib.block_size;
511 unsigned int len = nolb * se_dev->dev_attrib.block_size;
512 int mode = FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE;
513
514 if (!file->f_op->fallocate)
515 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
516
517 ret = file->f_op->fallocate(file, mode, pos, len);
518 if (ret < 0) {
519 pr_warn("FILEIO: fallocate() failed: %d\n", ret);
520 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
521 }
522 }
523
524 target_complete_cmd(cmd, GOOD);
525 return 0;
526}
527
528static sense_reason_t
Asias He50642762013-02-25 14:03:43 +0800529fd_execute_unmap(struct se_cmd *cmd)
530{
531 struct se_device *dev = cmd->se_dev;
532 struct fd_dev *fd_dev = FD_DEV(dev);
533 struct file *file = fd_dev->fd_file;
534 struct inode *inode = file->f_mapping->host;
535 unsigned char *buf, *ptr = NULL;
536 sector_t lba;
537 int size;
538 u32 range;
539 sense_reason_t ret = 0;
540 int dl, bd_dl, err;
541
542 /* We never set ANC_SUP */
543 if (cmd->t_task_cdb[1])
544 return TCM_INVALID_CDB_FIELD;
545
546 if (cmd->data_length == 0) {
547 target_complete_cmd(cmd, SAM_STAT_GOOD);
548 return 0;
549 }
550
551 if (cmd->data_length < 8) {
552 pr_warn("UNMAP parameter list length %u too small\n",
553 cmd->data_length);
554 return TCM_PARAMETER_LIST_LENGTH_ERROR;
555 }
556
557 buf = transport_kmap_data_sg(cmd);
558 if (!buf)
559 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
560
561 dl = get_unaligned_be16(&buf[0]);
562 bd_dl = get_unaligned_be16(&buf[2]);
563
564 size = cmd->data_length - 8;
565 if (bd_dl > size)
566 pr_warn("UNMAP parameter list length %u too small, ignoring bd_dl %u\n",
567 cmd->data_length, bd_dl);
568 else
569 size = bd_dl;
570
571 if (size / 16 > dev->dev_attrib.max_unmap_block_desc_count) {
572 ret = TCM_INVALID_PARAMETER_LIST;
573 goto err;
574 }
575
576 /* First UNMAP block descriptor starts at 8 byte offset */
577 ptr = &buf[8];
578 pr_debug("UNMAP: Sub: %s Using dl: %u bd_dl: %u size: %u"
579 " ptr: %p\n", dev->transport->name, dl, bd_dl, size, ptr);
580
581 while (size >= 16) {
582 lba = get_unaligned_be64(&ptr[0]);
583 range = get_unaligned_be32(&ptr[8]);
584 pr_debug("UNMAP: Using lba: %llu and range: %u\n",
585 (unsigned long long)lba, range);
586
587 if (range > dev->dev_attrib.max_unmap_lba_count) {
588 ret = TCM_INVALID_PARAMETER_LIST;
589 goto err;
590 }
591
592 if (lba + range > dev->transport->get_blocks(dev) + 1) {
593 ret = TCM_ADDRESS_OUT_OF_RANGE;
594 goto err;
595 }
596
597 if (S_ISBLK(inode->i_mode)) {
598 /* The backend is block device, use discard */
599 struct block_device *bdev = inode->i_bdev;
600
601 err = blkdev_issue_discard(bdev, lba, range, GFP_KERNEL, 0);
602 if (err < 0) {
603 pr_err("FILEIO: blkdev_issue_discard() failed: %d\n",
604 err);
605 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
606 goto err;
607 }
608 } else {
609 /* The backend is normal file, use fallocate */
610 loff_t pos = lba * dev->dev_attrib.block_size;
611 unsigned int len = range * dev->dev_attrib.block_size;
612 int mode = FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE;
613
614 if (!file->f_op->fallocate) {
615 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
616 goto err;
617 }
618 err = file->f_op->fallocate(file, mode, pos, len);
619 if (err < 0) {
620 pr_warn("FILEIO: fallocate() failed: %d\n", err);
621 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
622 goto err;
623 }
624 }
625
626 ptr += 16;
627 size -= 16;
628 }
629
630err:
631 transport_kunmap_data_sg(cmd);
632 if (!ret)
633 target_complete_cmd(cmd, GOOD);
634 return ret;
635}
636
637static sense_reason_t
Christoph Hellwigde103c92012-11-06 12:24:09 -0800638fd_execute_rw(struct se_cmd *cmd)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800639{
Christoph Hellwig0c2ad7d2012-06-17 18:40:52 -0400640 struct scatterlist *sgl = cmd->t_data_sg;
641 u32 sgl_nents = cmd->t_data_nents;
642 enum dma_data_direction data_direction = cmd->data_direction;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800643 struct se_device *dev = cmd->se_dev;
644 int ret = 0;
645
646 /*
647 * Call vectorized fileio functions to map struct scatterlist
648 * physical memory addresses to struct iovec virtual memory.
649 */
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400650 if (data_direction == DMA_FROM_DEVICE) {
Sebastian Andrzej Siewior778229a2012-12-05 13:09:45 -0800651 ret = fd_do_rw(cmd, sgl, sgl_nents, 0);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800652 } else {
Sebastian Andrzej Siewior778229a2012-12-05 13:09:45 -0800653 ret = fd_do_rw(cmd, sgl, sgl_nents, 1);
Nicholas Bellingera4dff302012-05-30 16:25:41 -0700654 /*
655 * Perform implict vfs_fsync_range() for fd_do_writev() ops
656 * for SCSI WRITEs with Forced Unit Access (FUA) set.
657 * Allow this to happen independent of WCE=0 setting.
658 */
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800659 if (ret > 0 &&
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400660 dev->dev_attrib.emulate_fua_write > 0 &&
Christoph Hellwig2d3a4b52011-11-14 11:36:29 -0500661 (cmd->se_cmd_flags & SCF_FUA)) {
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400662 struct fd_dev *fd_dev = FD_DEV(dev);
Nicholas Bellingera4dff302012-05-30 16:25:41 -0700663 loff_t start = cmd->t_task_lba *
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400664 dev->dev_attrib.block_size;
Nicholas Bellingera4dff302012-05-30 16:25:41 -0700665 loff_t end = start + cmd->data_length;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800666
Nicholas Bellingera4dff302012-05-30 16:25:41 -0700667 vfs_fsync_range(fd_dev->fd_file, start, end, 1);
668 }
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800669 }
670
Christoph Hellwigde103c92012-11-06 12:24:09 -0800671 if (ret < 0)
672 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
673
Christoph Hellwig5787cac2012-04-24 00:25:06 -0400674 if (ret)
675 target_complete_cmd(cmd, SAM_STAT_GOOD);
Nicholas Bellinger03e98c92011-11-04 02:36:16 -0700676 return 0;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800677}
678
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800679enum {
680 Opt_fd_dev_name, Opt_fd_dev_size, Opt_fd_buffered_io, Opt_err
681};
682
683static match_table_t tokens = {
684 {Opt_fd_dev_name, "fd_dev_name=%s"},
685 {Opt_fd_dev_size, "fd_dev_size=%s"},
Nicholas Bellingerb32f4c72012-09-29 17:15:37 -0700686 {Opt_fd_buffered_io, "fd_buffered_io=%d"},
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800687 {Opt_err, NULL}
688};
689
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400690static ssize_t fd_set_configfs_dev_params(struct se_device *dev,
691 const char *page, ssize_t count)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800692{
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400693 struct fd_dev *fd_dev = FD_DEV(dev);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800694 char *orig, *ptr, *arg_p, *opts;
695 substring_t args[MAX_OPT_ARGS];
Nicholas Bellingerb32f4c72012-09-29 17:15:37 -0700696 int ret = 0, arg, token;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800697
698 opts = kstrdup(page, GFP_KERNEL);
699 if (!opts)
700 return -ENOMEM;
701
702 orig = opts;
703
Sebastian Andrzej Siewior90c161b2011-11-23 20:53:17 +0100704 while ((ptr = strsep(&opts, ",\n")) != NULL) {
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800705 if (!*ptr)
706 continue;
707
708 token = match_token(ptr, tokens, args);
709 switch (token) {
710 case Opt_fd_dev_name:
Al Virodbc6e022012-08-01 13:07:04 +0400711 if (match_strlcpy(fd_dev->fd_dev_name, &args[0],
712 FD_MAX_DEV_NAME) == 0) {
713 ret = -EINVAL;
Jesper Juhl6d180252011-03-14 04:05:56 -0700714 break;
715 }
Andy Grover6708bb22011-06-08 10:36:43 -0700716 pr_debug("FILEIO: Referencing Path: %s\n",
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800717 fd_dev->fd_dev_name);
718 fd_dev->fbd_flags |= FBDF_HAS_PATH;
719 break;
720 case Opt_fd_dev_size:
721 arg_p = match_strdup(&args[0]);
Jesper Juhl6d180252011-03-14 04:05:56 -0700722 if (!arg_p) {
723 ret = -ENOMEM;
724 break;
725 }
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800726 ret = strict_strtoull(arg_p, 0, &fd_dev->fd_dev_size);
Jesper Juhl6d180252011-03-14 04:05:56 -0700727 kfree(arg_p);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800728 if (ret < 0) {
Andy Grover6708bb22011-06-08 10:36:43 -0700729 pr_err("strict_strtoull() failed for"
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800730 " fd_dev_size=\n");
731 goto out;
732 }
Andy Grover6708bb22011-06-08 10:36:43 -0700733 pr_debug("FILEIO: Referencing Size: %llu"
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800734 " bytes\n", fd_dev->fd_dev_size);
735 fd_dev->fbd_flags |= FBDF_HAS_SIZE;
736 break;
Nicholas Bellingerb32f4c72012-09-29 17:15:37 -0700737 case Opt_fd_buffered_io:
738 match_int(args, &arg);
739 if (arg != 1) {
740 pr_err("bogus fd_buffered_io=%d value\n", arg);
741 ret = -EINVAL;
742 goto out;
743 }
744
745 pr_debug("FILEIO: Using buffered I/O"
746 " operations for struct fd_dev\n");
747
748 fd_dev->fbd_flags |= FDBD_HAS_BUFFERED_IO_WCE;
749 break;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800750 default:
751 break;
752 }
753 }
754
755out:
756 kfree(orig);
757 return (!ret) ? count : ret;
758}
759
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400760static ssize_t fd_show_configfs_dev_params(struct se_device *dev, char *b)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800761{
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400762 struct fd_dev *fd_dev = FD_DEV(dev);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800763 ssize_t bl = 0;
764
765 bl = sprintf(b + bl, "TCM FILEIO ID: %u", fd_dev->fd_dev_id);
Nicholas Bellingerb32f4c72012-09-29 17:15:37 -0700766 bl += sprintf(b + bl, " File: %s Size: %llu Mode: %s\n",
767 fd_dev->fd_dev_name, fd_dev->fd_dev_size,
768 (fd_dev->fbd_flags & FDBD_HAS_BUFFERED_IO_WCE) ?
769 "Buffered-WCE" : "O_DSYNC");
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800770 return bl;
771}
772
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800773static sector_t fd_get_blocks(struct se_device *dev)
774{
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400775 struct fd_dev *fd_dev = FD_DEV(dev);
Nicholas Bellingercd9323f2012-05-16 16:05:26 -0700776 struct file *f = fd_dev->fd_file;
777 struct inode *i = f->f_mapping->host;
778 unsigned long long dev_size;
779 /*
780 * When using a file that references an underlying struct block_device,
781 * ensure dev_size is always based on the current inode size in order
782 * to handle underlying block_device resize operations.
783 */
784 if (S_ISBLK(i->i_mode))
785 dev_size = (i_size_read(i) - fd_dev->fd_block_size);
786 else
787 dev_size = fd_dev->fd_dev_size;
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800788
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400789 return div_u64(dev_size, dev->dev_attrib.block_size);
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800790}
791
Christoph Hellwig9e999a62012-10-07 10:55:50 -0400792static struct sbc_ops fd_sbc_ops = {
Christoph Hellwig0c2ad7d2012-06-17 18:40:52 -0400793 .execute_rw = fd_execute_rw,
Christoph Hellwigad67f0d2012-06-17 18:40:53 -0400794 .execute_sync_cache = fd_execute_sync_cache,
Nicholas Bellinger7b745c82013-02-19 17:30:34 -0800795 .execute_write_same = fd_execute_write_same,
Asias He70d3ae5c2013-02-25 14:03:42 +0800796 .execute_write_same_unmap = fd_execute_write_same_unmap,
Asias He50642762013-02-25 14:03:43 +0800797 .execute_unmap = fd_execute_unmap,
Christoph Hellwig0c2ad7d2012-06-17 18:40:52 -0400798};
799
Christoph Hellwigde103c92012-11-06 12:24:09 -0800800static sense_reason_t
801fd_parse_cdb(struct se_cmd *cmd)
Christoph Hellwig0c2ad7d2012-06-17 18:40:52 -0400802{
Christoph Hellwig9e999a62012-10-07 10:55:50 -0400803 return sbc_parse_cdb(cmd, &fd_sbc_ops);
Christoph Hellwig0c2ad7d2012-06-17 18:40:52 -0400804}
805
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800806static struct se_subsystem_api fileio_template = {
807 .name = "fileio",
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400808 .inquiry_prod = "FILEIO",
809 .inquiry_rev = FD_VERSION,
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800810 .owner = THIS_MODULE,
811 .transport_type = TRANSPORT_PLUGIN_VHBA_PDEV,
812 .attach_hba = fd_attach_hba,
813 .detach_hba = fd_detach_hba,
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400814 .alloc_device = fd_alloc_device,
815 .configure_device = fd_configure_device,
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800816 .free_device = fd_free_device,
Christoph Hellwig0c2ad7d2012-06-17 18:40:52 -0400817 .parse_cdb = fd_parse_cdb,
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800818 .set_configfs_dev_params = fd_set_configfs_dev_params,
819 .show_configfs_dev_params = fd_show_configfs_dev_params,
Christoph Hellwig6f23ac82012-10-07 10:55:53 -0400820 .get_device_type = sbc_get_device_type,
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800821 .get_blocks = fd_get_blocks,
822};
823
824static int __init fileio_module_init(void)
825{
826 return transport_subsystem_register(&fileio_template);
827}
828
Asias He63b91d52013-02-27 12:50:56 +0800829static void __exit fileio_module_exit(void)
Nicholas Bellingerc66ac9d2010-12-17 11:11:26 -0800830{
831 transport_subsystem_release(&fileio_template);
832}
833
834MODULE_DESCRIPTION("TCM FILEIO subsystem plugin");
835MODULE_AUTHOR("nab@Linux-iSCSI.org");
836MODULE_LICENSE("GPL");
837
838module_init(fileio_module_init);
839module_exit(fileio_module_exit);