Merge tag 'v3.10.68' into update
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / drivers / target / target_core_file.c
CommitLineData
c66ac9db
NB
1/*******************************************************************************
2 * Filename: target_core_file.c
3 *
4 * This file contains the Storage Engine <-> FILEIO transport specific functions
5 *
fd9a11d7 6 * (c) Copyright 2005-2012 RisingTide Systems LLC.
c66ac9db
NB
7 *
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
c66ac9db
NB
26#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>
827509e3 32#include <linux/module.h>
70d3ae5c 33#include <linux/falloc.h>
c66ac9db
NB
34#include <scsi/scsi.h>
35#include <scsi/scsi_host.h>
50642762 36#include <asm/unaligned.h>
c66ac9db
NB
37
38#include <target/target_core_base.h>
c4795fb2 39#include <target/target_core_backend.h>
c66ac9db
NB
40
41#include "target_core_file.h"
42
0fd97ccf
CH
43static inline struct fd_dev *FD_DEV(struct se_device *dev)
44{
45 return container_of(dev, struct fd_dev, dev);
46}
c66ac9db
NB
47
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);
6708bb27
AG
57 if (!fd_host) {
58 pr_err("Unable to allocate memory for struct fd_host\n");
e3d6f909 59 return -ENOMEM;
c66ac9db
NB
60 }
61
62 fd_host->fd_host_id = host_id;
63
e3d6f909 64 hba->hba_ptr = fd_host;
c66ac9db 65
6708bb27 66 pr_debug("CORE_HBA[%d] - TCM FILEIO HBA Driver %s on Generic"
c66ac9db
NB
67 " Target Core Stack %s\n", hba->hba_id, FD_VERSION,
68 TARGET_CORE_MOD_VERSION);
480da400
NB
69 pr_debug("CORE_HBA[%d] - Attached FILEIO HBA: %u to Generic\n",
70 hba->hba_id, fd_host->fd_host_id);
c66ac9db
NB
71
72 return 0;
73}
74
75static void fd_detach_hba(struct se_hba *hba)
76{
77 struct fd_host *fd_host = hba->hba_ptr;
78
6708bb27 79 pr_debug("CORE_HBA[%d] - Detached FILEIO HBA: %u from Generic"
c66ac9db
NB
80 " Target Core\n", hba->hba_id, fd_host->fd_host_id);
81
82 kfree(fd_host);
83 hba->hba_ptr = NULL;
84}
85
0fd97ccf 86static struct se_device *fd_alloc_device(struct se_hba *hba, const char *name)
c66ac9db
NB
87{
88 struct fd_dev *fd_dev;
8359cf43 89 struct fd_host *fd_host = hba->hba_ptr;
c66ac9db
NB
90
91 fd_dev = kzalloc(sizeof(struct fd_dev), GFP_KERNEL);
6708bb27
AG
92 if (!fd_dev) {
93 pr_err("Unable to allocate memory for struct fd_dev\n");
c66ac9db
NB
94 return NULL;
95 }
96
97 fd_dev->fd_host = fd_host;
98
6708bb27 99 pr_debug("FILEIO: Allocated fd_dev for %p\n", name);
c66ac9db 100
0fd97ccf 101 return &fd_dev->dev;
c66ac9db
NB
102}
103
0fd97ccf 104static int fd_configure_device(struct se_device *dev)
c66ac9db 105{
0fd97ccf
CH
106 struct fd_dev *fd_dev = FD_DEV(dev);
107 struct fd_host *fd_host = dev->se_hba->hba_ptr;
c66ac9db
NB
108 struct file *file;
109 struct inode *inode = NULL;
0fd97ccf 110 int flags, ret = -EINVAL;
c66ac9db 111
0fd97ccf
CH
112 if (!(fd_dev->fbd_flags & FBDF_HAS_PATH)) {
113 pr_err("Missing fd_dev_name=\n");
114 return -EINVAL;
115 }
c66ac9db 116
c66ac9db 117 /*
a4dff304
NB
118 * Use O_DSYNC by default instead of O_SYNC to forgo syncing
119 * of pure timestamp updates.
c66ac9db 120 */
a4dff304 121 flags = O_RDWR | O_CREAT | O_LARGEFILE | O_DSYNC;
0fd97ccf 122
b32f4c7e
NB
123 /*
124 * Optionally allow fd_buffered_io=1 to be enabled for people
125 * who want use the fs buffer cache as an WriteCache mechanism.
126 *
127 * This means that in event of a hard failure, there is a risk
128 * of silent data-loss if the SCSI client has *not* performed a
129 * forced unit access (FUA) write, or issued SYNCHRONIZE_CACHE
130 * to write-out the entire device cache.
131 */
132 if (fd_dev->fbd_flags & FDBD_HAS_BUFFERED_IO_WCE) {
133 pr_debug("FILEIO: Disabling O_DSYNC, using buffered FILEIO\n");
134 flags &= ~O_DSYNC;
135 }
c66ac9db 136
dbc6e022 137 file = filp_open(fd_dev->fd_dev_name, flags, 0600);
613640e4 138 if (IS_ERR(file)) {
dbc6e022 139 pr_err("filp_open(%s) failed\n", fd_dev->fd_dev_name);
613640e4
NB
140 ret = PTR_ERR(file);
141 goto fail;
142 }
c66ac9db
NB
143 fd_dev->fd_file = file;
144 /*
145 * If using a block backend with this struct file, we extract
146 * fd_dev->fd_[block,dev]_size from struct block_device.
147 *
148 * Otherwise, we use the passed fd_size= from configfs
149 */
150 inode = file->f_mapping->host;
151 if (S_ISBLK(inode->i_mode)) {
0fd97ccf 152 struct request_queue *q = bdev_get_queue(inode->i_bdev);
cd9323fd 153 unsigned long long dev_size;
0fd97ccf 154
21363ca8 155 fd_dev->fd_block_size = bdev_logical_block_size(inode->i_bdev);
c66ac9db
NB
156 /*
157 * Determine the number of bytes from i_size_read() minus
158 * one (1) logical sector from underlying struct block_device
159 */
cd9323fd 160 dev_size = (i_size_read(file->f_mapping->host) -
c66ac9db
NB
161 fd_dev->fd_block_size);
162
6708bb27 163 pr_debug("FILEIO: Using size: %llu bytes from struct"
c66ac9db 164 " block_device blocks: %llu logical_block_size: %d\n",
cd9323fd 165 dev_size, div_u64(dev_size, fd_dev->fd_block_size),
c66ac9db 166 fd_dev->fd_block_size);
70d3ae5c
AH
167 /*
168 * Check if the underlying struct block_device request_queue supports
169 * the QUEUE_FLAG_DISCARD bit for UNMAP/WRITE_SAME in SCSI + TRIM
170 * in ATA and we need to set TPE=1
171 */
172 if (blk_queue_discard(q)) {
173 dev->dev_attrib.max_unmap_lba_count =
174 q->limits.max_discard_sectors;
175 /*
176 * Currently hardcoded to 1 in Linux/SCSI code..
177 */
178 dev->dev_attrib.max_unmap_block_desc_count = 1;
179 dev->dev_attrib.unmap_granularity =
180 q->limits.discard_granularity >> 9;
181 dev->dev_attrib.unmap_granularity_alignment =
182 q->limits.discard_alignment;
183 pr_debug("IFILE: BLOCK Discard support available,"
184 " disabled by default\n");
185 }
186 /*
187 * Enable write same emulation for IBLOCK and use 0xFFFF as
188 * the smaller WRITE_SAME(10) only has a two-byte block count.
189 */
190 dev->dev_attrib.max_write_same_len = 0xFFFF;
0463a3fe
AH
191
192 if (blk_queue_nonrot(q))
193 dev->dev_attrib.is_nonrot = 1;
c66ac9db
NB
194 } else {
195 if (!(fd_dev->fbd_flags & FBDF_HAS_SIZE)) {
6708bb27 196 pr_err("FILEIO: Missing fd_dev_size="
c66ac9db
NB
197 " parameter, and no backing struct"
198 " block_device\n");
199 goto fail;
200 }
201
21363ca8 202 fd_dev->fd_block_size = FD_BLOCKSIZE;
70d3ae5c
AH
203 /*
204 * Limit UNMAP emulation to 8k Number of LBAs (NoLB)
205 */
206 dev->dev_attrib.max_unmap_lba_count = 0x2000;
207 /*
208 * Currently hardcoded to 1 in Linux/SCSI code..
209 */
210 dev->dev_attrib.max_unmap_block_desc_count = 1;
211 dev->dev_attrib.unmap_granularity = 1;
212 dev->dev_attrib.unmap_granularity_alignment = 0;
213
214 /*
215 * Limit WRITE_SAME w/ UNMAP=0 emulation to 8k Number of LBAs (NoLB)
216 * based upon struct iovec limit for vfs_writev()
217 */
218 dev->dev_attrib.max_write_same_len = 0x1000;
c66ac9db
NB
219 }
220
21363ca8 221 dev->dev_attrib.hw_block_size = fd_dev->fd_block_size;
480da400
NB
222 dev->dev_attrib.max_bytes_per_io = FD_MAX_BYTES;
223 dev->dev_attrib.hw_max_sectors = FD_MAX_BYTES / fd_dev->fd_block_size;
0fd97ccf 224 dev->dev_attrib.hw_queue_depth = FD_MAX_DEVICE_QUEUE_DEPTH;
c66ac9db 225
b32f4c7e
NB
226 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");
0fd97ccf 229 dev->dev_attrib.emulate_write_cache = 1;
b32f4c7e
NB
230 }
231
c66ac9db
NB
232 fd_dev->fd_dev_id = fd_host->fd_host_dev_id_count++;
233 fd_dev->fd_queue_depth = dev->queue_depth;
234
6708bb27 235 pr_debug("CORE_FILE[%u] - Added TCM FILEIO Device ID: %u at %s,"
c66ac9db
NB
236 " %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
0fd97ccf 239 return 0;
c66ac9db
NB
240fail:
241 if (fd_dev->fd_file) {
242 filp_close(fd_dev->fd_file, NULL);
243 fd_dev->fd_file = NULL;
244 }
0fd97ccf 245 return ret;
c66ac9db
NB
246}
247
0fd97ccf 248static void fd_free_device(struct se_device *dev)
c66ac9db 249{
0fd97ccf 250 struct fd_dev *fd_dev = FD_DEV(dev);
c66ac9db
NB
251
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
778229af
SAS
260static int fd_do_rw(struct se_cmd *cmd, struct scatterlist *sgl,
261 u32 sgl_nents, int is_write)
c66ac9db 262{
5787cacd 263 struct se_device *se_dev = cmd->se_dev;
0fd97ccf 264 struct fd_dev *dev = FD_DEV(se_dev);
6708bb27 265 struct file *fd = dev->fd_file;
5787cacd 266 struct scatterlist *sg;
c66ac9db
NB
267 struct iovec *iov;
268 mm_segment_t old_fs;
0fd97ccf 269 loff_t pos = (cmd->t_task_lba * se_dev->dev_attrib.block_size);
c66ac9db
NB
270 int ret = 0, i;
271
5787cacd 272 iov = kzalloc(sizeof(struct iovec) * sgl_nents, GFP_KERNEL);
6708bb27
AG
273 if (!iov) {
274 pr_err("Unable to allocate fd_do_readv iov[]\n");
e3d6f909 275 return -ENOMEM;
c66ac9db
NB
276 }
277
5787cacd 278 for_each_sg(sgl, sg, sgl_nents, i) {
9649fa1b 279 iov[i].iov_len = sg->length;
40ff2c3b 280 iov[i].iov_base = kmap(sg_page(sg)) + sg->offset;
c66ac9db
NB
281 }
282
283 old_fs = get_fs();
284 set_fs(get_ds());
778229af
SAS
285
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
c66ac9db
NB
291 set_fs(old_fs);
292
40ff2c3b
SAS
293 for_each_sg(sgl, sg, sgl_nents, i)
294 kunmap(sg_page(sg));
778229af 295
c66ac9db 296 kfree(iov);
778229af
SAS
297
298 if (is_write) {
5787cacd 299 if (ret < 0 || ret != cmd->data_length) {
778229af 300 pr_err("%s() write returned %d\n", __func__, ret);
e3d6f909 301 return (ret < 0 ? ret : -EINVAL);
c66ac9db
NB
302 }
303 } else {
778229af
SAS
304 /*
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 */
496ad9aa 309 if (S_ISBLK(file_inode(fd)->i_mode)) {
778229af
SAS
310 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 }
c66ac9db
NB
322 }
323 }
c66ac9db
NB
324 return 1;
325}
326
de103c93
CH
327static sense_reason_t
328fd_execute_sync_cache(struct se_cmd *cmd)
c66ac9db 329{
c66ac9db 330 struct se_device *dev = cmd->se_dev;
0fd97ccf 331 struct fd_dev *fd_dev = FD_DEV(dev);
a1d8b49a 332 int immed = (cmd->t_task_cdb[1] & 0x2);
c66ac9db
NB
333 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)
5787cacd 341 target_complete_cmd(cmd, SAM_STAT_GOOD);
c66ac9db
NB
342
343 /*
344 * Determine if we will be flushing the entire device.
345 */
a1d8b49a 346 if (cmd->t_task_lba == 0 && cmd->data_length == 0) {
c66ac9db
NB
347 start = 0;
348 end = LLONG_MAX;
349 } else {
0fd97ccf 350 start = cmd->t_task_lba * dev->dev_attrib.block_size;
c66ac9db
NB
351 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)
6708bb27 359 pr_err("FILEIO: vfs_fsync_range() failed: %d\n", ret);
c66ac9db 360
5787cacd 361 if (immed)
ad67f0d9 362 return 0;
5787cacd 363
de103c93 364 if (ret)
5787cacd 365 target_complete_cmd(cmd, SAM_STAT_CHECK_CONDITION);
de103c93 366 else
5787cacd 367 target_complete_cmd(cmd, SAM_STAT_GOOD);
ad67f0d9
CH
368
369 return 0;
c66ac9db
NB
370}
371
7b745c84
NB
372static 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;
972b29c8 420 sector_t nolb = sbc_get_write_same_sectors(cmd);
7b745c84
NB
421 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
70d3ae5c 480static sense_reason_t
86d71829 481fd_do_unmap(struct se_cmd *cmd, void *priv, sector_t lba, sector_t nolb)
70d3ae5c 482{
86d71829 483 struct file *file = priv;
70d3ae5c 484 struct inode *inode = file->f_mapping->host;
70d3ae5c
AH
485 int ret;
486
70d3ae5c
AH
487 if (S_ISBLK(inode->i_mode)) {
488 /* The backend is block device, use discard */
489 struct block_device *bdev = inode->i_bdev;
490
43f55bbb 491 ret = blkdev_issue_discard(bdev, lba,
70d3ae5c
AH
492 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 */
43f55bbb
AH
500 struct se_device *se_dev = cmd->se_dev;
501 loff_t pos = lba * se_dev->dev_attrib.block_size;
70d3ae5c
AH
502 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
43f55bbb
AH
515 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
70d3ae5c
AH
537 target_complete_cmd(cmd, GOOD);
538 return 0;
539}
540
50642762
AH
541static sense_reason_t
542fd_execute_unmap(struct se_cmd *cmd)
543{
86d71829 544 struct file *file = FD_DEV(cmd->se_dev)->fd_file;
50642762 545
86d71829 546 return sbc_execute_unmap(cmd, fd_do_unmap, file);
50642762
AH
547}
548
de103c93
CH
549static sense_reason_t
550fd_execute_rw(struct se_cmd *cmd)
c66ac9db 551{
0c2ad7d1
CH
552 struct scatterlist *sgl = cmd->t_data_sg;
553 u32 sgl_nents = cmd->t_data_nents;
554 enum dma_data_direction data_direction = cmd->data_direction;
c66ac9db
NB
555 struct se_device *dev = cmd->se_dev;
556 int ret = 0;
e2d88176
NB
557 /*
558 * We are currently limited by the number of iovecs (2048) per
559 * single vfs_[writev,readv] call.
560 */
561 if (cmd->data_length > FD_MAX_BYTES) {
562 pr_err("FILEIO: Not able to process I/O of %u bytes due to"
563 "FD_MAX_BYTES: %u iovec count limitiation\n",
564 cmd->data_length, FD_MAX_BYTES);
565 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
566 }
c66ac9db
NB
567 /*
568 * Call vectorized fileio functions to map struct scatterlist
569 * physical memory addresses to struct iovec virtual memory.
570 */
5787cacd 571 if (data_direction == DMA_FROM_DEVICE) {
778229af 572 ret = fd_do_rw(cmd, sgl, sgl_nents, 0);
c66ac9db 573 } else {
778229af 574 ret = fd_do_rw(cmd, sgl, sgl_nents, 1);
a4dff304
NB
575 /*
576 * Perform implict vfs_fsync_range() for fd_do_writev() ops
577 * for SCSI WRITEs with Forced Unit Access (FUA) set.
578 * Allow this to happen independent of WCE=0 setting.
579 */
c66ac9db 580 if (ret > 0 &&
0fd97ccf 581 dev->dev_attrib.emulate_fua_write > 0 &&
2d3a4b51 582 (cmd->se_cmd_flags & SCF_FUA)) {
0fd97ccf 583 struct fd_dev *fd_dev = FD_DEV(dev);
a4dff304 584 loff_t start = cmd->t_task_lba *
0fd97ccf 585 dev->dev_attrib.block_size;
a4dff304 586 loff_t end = start + cmd->data_length;
c66ac9db 587
a4dff304
NB
588 vfs_fsync_range(fd_dev->fd_file, start, end, 1);
589 }
c66ac9db
NB
590 }
591
de103c93
CH
592 if (ret < 0)
593 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
594
5787cacd
CH
595 if (ret)
596 target_complete_cmd(cmd, SAM_STAT_GOOD);
03e98c9e 597 return 0;
c66ac9db
NB
598}
599
c66ac9db
NB
600enum {
601 Opt_fd_dev_name, Opt_fd_dev_size, Opt_fd_buffered_io, Opt_err
602};
603
604static match_table_t tokens = {
605 {Opt_fd_dev_name, "fd_dev_name=%s"},
606 {Opt_fd_dev_size, "fd_dev_size=%s"},
b32f4c7e 607 {Opt_fd_buffered_io, "fd_buffered_io=%d"},
c66ac9db
NB
608 {Opt_err, NULL}
609};
610
0fd97ccf
CH
611static ssize_t fd_set_configfs_dev_params(struct se_device *dev,
612 const char *page, ssize_t count)
c66ac9db 613{
0fd97ccf 614 struct fd_dev *fd_dev = FD_DEV(dev);
c66ac9db
NB
615 char *orig, *ptr, *arg_p, *opts;
616 substring_t args[MAX_OPT_ARGS];
b32f4c7e 617 int ret = 0, arg, token;
c66ac9db
NB
618
619 opts = kstrdup(page, GFP_KERNEL);
620 if (!opts)
621 return -ENOMEM;
622
623 orig = opts;
624
90c161b6 625 while ((ptr = strsep(&opts, ",\n")) != NULL) {
c66ac9db
NB
626 if (!*ptr)
627 continue;
628
629 token = match_token(ptr, tokens, args);
630 switch (token) {
631 case Opt_fd_dev_name:
dbc6e022
AV
632 if (match_strlcpy(fd_dev->fd_dev_name, &args[0],
633 FD_MAX_DEV_NAME) == 0) {
634 ret = -EINVAL;
6d180253
JJ
635 break;
636 }
6708bb27 637 pr_debug("FILEIO: Referencing Path: %s\n",
c66ac9db
NB
638 fd_dev->fd_dev_name);
639 fd_dev->fbd_flags |= FBDF_HAS_PATH;
640 break;
641 case Opt_fd_dev_size:
642 arg_p = match_strdup(&args[0]);
6d180253
JJ
643 if (!arg_p) {
644 ret = -ENOMEM;
645 break;
646 }
c66ac9db 647 ret = strict_strtoull(arg_p, 0, &fd_dev->fd_dev_size);
6d180253 648 kfree(arg_p);
c66ac9db 649 if (ret < 0) {
6708bb27 650 pr_err("strict_strtoull() failed for"
c66ac9db
NB
651 " fd_dev_size=\n");
652 goto out;
653 }
6708bb27 654 pr_debug("FILEIO: Referencing Size: %llu"
c66ac9db
NB
655 " bytes\n", fd_dev->fd_dev_size);
656 fd_dev->fbd_flags |= FBDF_HAS_SIZE;
657 break;
b32f4c7e
NB
658 case Opt_fd_buffered_io:
659 match_int(args, &arg);
660 if (arg != 1) {
661 pr_err("bogus fd_buffered_io=%d value\n", arg);
662 ret = -EINVAL;
663 goto out;
664 }
665
666 pr_debug("FILEIO: Using buffered I/O"
667 " operations for struct fd_dev\n");
668
669 fd_dev->fbd_flags |= FDBD_HAS_BUFFERED_IO_WCE;
670 break;
c66ac9db
NB
671 default:
672 break;
673 }
674 }
675
676out:
677 kfree(orig);
678 return (!ret) ? count : ret;
679}
680
0fd97ccf 681static ssize_t fd_show_configfs_dev_params(struct se_device *dev, char *b)
c66ac9db 682{
0fd97ccf 683 struct fd_dev *fd_dev = FD_DEV(dev);
c66ac9db
NB
684 ssize_t bl = 0;
685
686 bl = sprintf(b + bl, "TCM FILEIO ID: %u", fd_dev->fd_dev_id);
b32f4c7e
NB
687 bl += sprintf(b + bl, " File: %s Size: %llu Mode: %s\n",
688 fd_dev->fd_dev_name, fd_dev->fd_dev_size,
689 (fd_dev->fbd_flags & FDBD_HAS_BUFFERED_IO_WCE) ?
690 "Buffered-WCE" : "O_DSYNC");
c66ac9db
NB
691 return bl;
692}
693
c66ac9db
NB
694static sector_t fd_get_blocks(struct se_device *dev)
695{
0fd97ccf 696 struct fd_dev *fd_dev = FD_DEV(dev);
cd9323fd
NB
697 struct file *f = fd_dev->fd_file;
698 struct inode *i = f->f_mapping->host;
699 unsigned long long dev_size;
700 /*
701 * When using a file that references an underlying struct block_device,
702 * ensure dev_size is always based on the current inode size in order
703 * to handle underlying block_device resize operations.
704 */
705 if (S_ISBLK(i->i_mode))
21363ca8 706 dev_size = i_size_read(i);
cd9323fd
NB
707 else
708 dev_size = fd_dev->fd_dev_size;
c66ac9db 709
21363ca8
NB
710 return div_u64(dev_size - dev->dev_attrib.block_size,
711 dev->dev_attrib.block_size);
c66ac9db
NB
712}
713
9e999a6c 714static struct sbc_ops fd_sbc_ops = {
0c2ad7d1 715 .execute_rw = fd_execute_rw,
ad67f0d9 716 .execute_sync_cache = fd_execute_sync_cache,
7b745c84 717 .execute_write_same = fd_execute_write_same,
70d3ae5c 718 .execute_write_same_unmap = fd_execute_write_same_unmap,
50642762 719 .execute_unmap = fd_execute_unmap,
0c2ad7d1
CH
720};
721
de103c93
CH
722static sense_reason_t
723fd_parse_cdb(struct se_cmd *cmd)
0c2ad7d1 724{
9e999a6c 725 return sbc_parse_cdb(cmd, &fd_sbc_ops);
0c2ad7d1
CH
726}
727
c66ac9db
NB
728static struct se_subsystem_api fileio_template = {
729 .name = "fileio",
0fd97ccf
CH
730 .inquiry_prod = "FILEIO",
731 .inquiry_rev = FD_VERSION,
c66ac9db
NB
732 .owner = THIS_MODULE,
733 .transport_type = TRANSPORT_PLUGIN_VHBA_PDEV,
734 .attach_hba = fd_attach_hba,
735 .detach_hba = fd_detach_hba,
0fd97ccf
CH
736 .alloc_device = fd_alloc_device,
737 .configure_device = fd_configure_device,
c66ac9db 738 .free_device = fd_free_device,
0c2ad7d1 739 .parse_cdb = fd_parse_cdb,
c66ac9db
NB
740 .set_configfs_dev_params = fd_set_configfs_dev_params,
741 .show_configfs_dev_params = fd_show_configfs_dev_params,
6f23ac8a 742 .get_device_type = sbc_get_device_type,
c66ac9db
NB
743 .get_blocks = fd_get_blocks,
744};
745
746static int __init fileio_module_init(void)
747{
748 return transport_subsystem_register(&fileio_template);
749}
750
63b91d5a 751static void __exit fileio_module_exit(void)
c66ac9db
NB
752{
753 transport_subsystem_release(&fileio_template);
754}
755
756MODULE_DESCRIPTION("TCM FILEIO subsystem plugin");
757MODULE_AUTHOR("nab@Linux-iSCSI.org");
758MODULE_LICENSE("GPL");
759
760module_init(fileio_module_init);
761module_exit(fileio_module_exit);