Loading...
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*******************************************************************************
3 * Filename: target_core_file.c
4 *
5 * This file contains the Storage Engine <-> FILEIO transport specific functions
6 *
7 * (c) Copyright 2005-2013 Datera, Inc.
8 *
9 * Nicholas A. Bellinger <nab@kernel.org>
10 *
11 ******************************************************************************/
12
13#include <linux/string.h>
14#include <linux/parser.h>
15#include <linux/timer.h>
16#include <linux/blkdev.h>
17#include <linux/slab.h>
18#include <linux/spinlock.h>
19#include <linux/module.h>
20#include <linux/vmalloc.h>
21#include <linux/falloc.h>
22#include <linux/uio.h>
23#include <scsi/scsi_proto.h>
24#include <asm/unaligned.h>
25
26#include <target/target_core_base.h>
27#include <target/target_core_backend.h>
28
29#include "target_core_file.h"
30
31static inline struct fd_dev *FD_DEV(struct se_device *dev)
32{
33 return container_of(dev, struct fd_dev, dev);
34}
35
36static int fd_attach_hba(struct se_hba *hba, u32 host_id)
37{
38 struct fd_host *fd_host;
39
40 fd_host = kzalloc(sizeof(struct fd_host), GFP_KERNEL);
41 if (!fd_host) {
42 pr_err("Unable to allocate memory for struct fd_host\n");
43 return -ENOMEM;
44 }
45
46 fd_host->fd_host_id = host_id;
47
48 hba->hba_ptr = fd_host;
49
50 pr_debug("CORE_HBA[%d] - TCM FILEIO HBA Driver %s on Generic"
51 " Target Core Stack %s\n", hba->hba_id, FD_VERSION,
52 TARGET_CORE_VERSION);
53 pr_debug("CORE_HBA[%d] - Attached FILEIO HBA: %u to Generic\n",
54 hba->hba_id, fd_host->fd_host_id);
55
56 return 0;
57}
58
59static void fd_detach_hba(struct se_hba *hba)
60{
61 struct fd_host *fd_host = hba->hba_ptr;
62
63 pr_debug("CORE_HBA[%d] - Detached FILEIO HBA: %u from Generic"
64 " Target Core\n", hba->hba_id, fd_host->fd_host_id);
65
66 kfree(fd_host);
67 hba->hba_ptr = NULL;
68}
69
70static struct se_device *fd_alloc_device(struct se_hba *hba, const char *name)
71{
72 struct fd_dev *fd_dev;
73 struct fd_host *fd_host = hba->hba_ptr;
74
75 fd_dev = kzalloc(sizeof(struct fd_dev), GFP_KERNEL);
76 if (!fd_dev) {
77 pr_err("Unable to allocate memory for struct fd_dev\n");
78 return NULL;
79 }
80
81 fd_dev->fd_host = fd_host;
82
83 pr_debug("FILEIO: Allocated fd_dev for %p\n", name);
84
85 return &fd_dev->dev;
86}
87
88static int fd_configure_device(struct se_device *dev)
89{
90 struct fd_dev *fd_dev = FD_DEV(dev);
91 struct fd_host *fd_host = dev->se_hba->hba_ptr;
92 struct file *file;
93 struct inode *inode = NULL;
94 int flags, ret = -EINVAL;
95
96 if (!(fd_dev->fbd_flags & FBDF_HAS_PATH)) {
97 pr_err("Missing fd_dev_name=\n");
98 return -EINVAL;
99 }
100
101 /*
102 * Use O_DSYNC by default instead of O_SYNC to forgo syncing
103 * of pure timestamp updates.
104 */
105 flags = O_RDWR | O_CREAT | O_LARGEFILE | O_DSYNC;
106
107 /*
108 * Optionally allow fd_buffered_io=1 to be enabled for people
109 * who want use the fs buffer cache as an WriteCache mechanism.
110 *
111 * This means that in event of a hard failure, there is a risk
112 * of silent data-loss if the SCSI client has *not* performed a
113 * forced unit access (FUA) write, or issued SYNCHRONIZE_CACHE
114 * to write-out the entire device cache.
115 */
116 if (fd_dev->fbd_flags & FDBD_HAS_BUFFERED_IO_WCE) {
117 pr_debug("FILEIO: Disabling O_DSYNC, using buffered FILEIO\n");
118 flags &= ~O_DSYNC;
119 }
120
121 file = filp_open(fd_dev->fd_dev_name, flags, 0600);
122 if (IS_ERR(file)) {
123 pr_err("filp_open(%s) failed\n", fd_dev->fd_dev_name);
124 ret = PTR_ERR(file);
125 goto fail;
126 }
127 fd_dev->fd_file = file;
128 /*
129 * If using a block backend with this struct file, we extract
130 * fd_dev->fd_[block,dev]_size from struct block_device.
131 *
132 * Otherwise, we use the passed fd_size= from configfs
133 */
134 inode = file->f_mapping->host;
135 if (S_ISBLK(inode->i_mode)) {
136 struct request_queue *q = bdev_get_queue(inode->i_bdev);
137 unsigned long long dev_size;
138
139 fd_dev->fd_block_size = bdev_logical_block_size(inode->i_bdev);
140 /*
141 * Determine the number of bytes from i_size_read() minus
142 * one (1) logical sector from underlying struct block_device
143 */
144 dev_size = (i_size_read(file->f_mapping->host) -
145 fd_dev->fd_block_size);
146
147 pr_debug("FILEIO: Using size: %llu bytes from struct"
148 " block_device blocks: %llu logical_block_size: %d\n",
149 dev_size, div_u64(dev_size, fd_dev->fd_block_size),
150 fd_dev->fd_block_size);
151
152 if (target_configure_unmap_from_queue(&dev->dev_attrib, q))
153 pr_debug("IFILE: BLOCK Discard support available,"
154 " disabled by default\n");
155 /*
156 * Enable write same emulation for IBLOCK and use 0xFFFF as
157 * the smaller WRITE_SAME(10) only has a two-byte block count.
158 */
159 dev->dev_attrib.max_write_same_len = 0xFFFF;
160
161 if (blk_queue_nonrot(q))
162 dev->dev_attrib.is_nonrot = 1;
163 } else {
164 if (!(fd_dev->fbd_flags & FBDF_HAS_SIZE)) {
165 pr_err("FILEIO: Missing fd_dev_size="
166 " parameter, and no backing struct"
167 " block_device\n");
168 goto fail;
169 }
170
171 fd_dev->fd_block_size = FD_BLOCKSIZE;
172 /*
173 * Limit UNMAP emulation to 8k Number of LBAs (NoLB)
174 */
175 dev->dev_attrib.max_unmap_lba_count = 0x2000;
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 = 1;
181 dev->dev_attrib.unmap_granularity_alignment = 0;
182
183 /*
184 * Limit WRITE_SAME w/ UNMAP=0 emulation to 8k Number of LBAs (NoLB)
185 * based upon struct iovec limit for vfs_writev()
186 */
187 dev->dev_attrib.max_write_same_len = 0x1000;
188 }
189
190 dev->dev_attrib.hw_block_size = fd_dev->fd_block_size;
191 dev->dev_attrib.max_bytes_per_io = FD_MAX_BYTES;
192 dev->dev_attrib.hw_max_sectors = FD_MAX_BYTES / fd_dev->fd_block_size;
193 dev->dev_attrib.hw_queue_depth = FD_MAX_DEVICE_QUEUE_DEPTH;
194
195 if (fd_dev->fbd_flags & FDBD_HAS_BUFFERED_IO_WCE) {
196 pr_debug("FILEIO: Forcing setting of emulate_write_cache=1"
197 " with FDBD_HAS_BUFFERED_IO_WCE\n");
198 dev->dev_attrib.emulate_write_cache = 1;
199 }
200
201 fd_dev->fd_dev_id = fd_host->fd_host_dev_id_count++;
202 fd_dev->fd_queue_depth = dev->queue_depth;
203
204 pr_debug("CORE_FILE[%u] - Added TCM FILEIO Device ID: %u at %s,"
205 " %llu total bytes\n", fd_host->fd_host_id, fd_dev->fd_dev_id,
206 fd_dev->fd_dev_name, fd_dev->fd_dev_size);
207
208 return 0;
209fail:
210 if (fd_dev->fd_file) {
211 filp_close(fd_dev->fd_file, NULL);
212 fd_dev->fd_file = NULL;
213 }
214 return ret;
215}
216
217static void fd_dev_call_rcu(struct rcu_head *p)
218{
219 struct se_device *dev = container_of(p, struct se_device, rcu_head);
220 struct fd_dev *fd_dev = FD_DEV(dev);
221
222 kfree(fd_dev);
223}
224
225static void fd_free_device(struct se_device *dev)
226{
227 call_rcu(&dev->rcu_head, fd_dev_call_rcu);
228}
229
230static void fd_destroy_device(struct se_device *dev)
231{
232 struct fd_dev *fd_dev = FD_DEV(dev);
233
234 if (fd_dev->fd_file) {
235 filp_close(fd_dev->fd_file, NULL);
236 fd_dev->fd_file = NULL;
237 }
238}
239
240struct target_core_file_cmd {
241 unsigned long len;
242 struct se_cmd *cmd;
243 struct kiocb iocb;
244};
245
246static void cmd_rw_aio_complete(struct kiocb *iocb, long ret, long ret2)
247{
248 struct target_core_file_cmd *cmd;
249
250 cmd = container_of(iocb, struct target_core_file_cmd, iocb);
251
252 if (ret != cmd->len)
253 target_complete_cmd(cmd->cmd, SAM_STAT_CHECK_CONDITION);
254 else
255 target_complete_cmd(cmd->cmd, SAM_STAT_GOOD);
256
257 kfree(cmd);
258}
259
260static sense_reason_t
261fd_execute_rw_aio(struct se_cmd *cmd, struct scatterlist *sgl, u32 sgl_nents,
262 enum dma_data_direction data_direction)
263{
264 int is_write = !(data_direction == DMA_FROM_DEVICE);
265 struct se_device *dev = cmd->se_dev;
266 struct fd_dev *fd_dev = FD_DEV(dev);
267 struct file *file = fd_dev->fd_file;
268 struct target_core_file_cmd *aio_cmd;
269 struct iov_iter iter = {};
270 struct scatterlist *sg;
271 struct bio_vec *bvec;
272 ssize_t len = 0;
273 int ret = 0, i;
274
275 aio_cmd = kmalloc(sizeof(struct target_core_file_cmd), GFP_KERNEL);
276 if (!aio_cmd)
277 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
278
279 bvec = kcalloc(sgl_nents, sizeof(struct bio_vec), GFP_KERNEL);
280 if (!bvec) {
281 kfree(aio_cmd);
282 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
283 }
284
285 for_each_sg(sgl, sg, sgl_nents, i) {
286 bvec[i].bv_page = sg_page(sg);
287 bvec[i].bv_len = sg->length;
288 bvec[i].bv_offset = sg->offset;
289
290 len += sg->length;
291 }
292
293 iov_iter_bvec(&iter, is_write, bvec, sgl_nents, len);
294
295 aio_cmd->cmd = cmd;
296 aio_cmd->len = len;
297 aio_cmd->iocb.ki_pos = cmd->t_task_lba * dev->dev_attrib.block_size;
298 aio_cmd->iocb.ki_filp = file;
299 aio_cmd->iocb.ki_complete = cmd_rw_aio_complete;
300 aio_cmd->iocb.ki_flags = IOCB_DIRECT;
301
302 if (is_write && (cmd->se_cmd_flags & SCF_FUA))
303 aio_cmd->iocb.ki_flags |= IOCB_DSYNC;
304
305 if (is_write)
306 ret = call_write_iter(file, &aio_cmd->iocb, &iter);
307 else
308 ret = call_read_iter(file, &aio_cmd->iocb, &iter);
309
310 kfree(bvec);
311
312 if (ret != -EIOCBQUEUED)
313 cmd_rw_aio_complete(&aio_cmd->iocb, ret, 0);
314
315 return 0;
316}
317
318static int fd_do_rw(struct se_cmd *cmd, struct file *fd,
319 u32 block_size, struct scatterlist *sgl,
320 u32 sgl_nents, u32 data_length, int is_write)
321{
322 struct scatterlist *sg;
323 struct iov_iter iter;
324 struct bio_vec *bvec;
325 ssize_t len = 0;
326 loff_t pos = (cmd->t_task_lba * block_size);
327 int ret = 0, i;
328
329 bvec = kcalloc(sgl_nents, sizeof(struct bio_vec), GFP_KERNEL);
330 if (!bvec) {
331 pr_err("Unable to allocate fd_do_readv iov[]\n");
332 return -ENOMEM;
333 }
334
335 for_each_sg(sgl, sg, sgl_nents, i) {
336 bvec[i].bv_page = sg_page(sg);
337 bvec[i].bv_len = sg->length;
338 bvec[i].bv_offset = sg->offset;
339
340 len += sg->length;
341 }
342
343 iov_iter_bvec(&iter, READ, bvec, sgl_nents, len);
344 if (is_write)
345 ret = vfs_iter_write(fd, &iter, &pos, 0);
346 else
347 ret = vfs_iter_read(fd, &iter, &pos, 0);
348
349 if (is_write) {
350 if (ret < 0 || ret != data_length) {
351 pr_err("%s() write returned %d\n", __func__, ret);
352 if (ret >= 0)
353 ret = -EINVAL;
354 }
355 } else {
356 /*
357 * Return zeros and GOOD status even if the READ did not return
358 * the expected virt_size for struct file w/o a backing struct
359 * block_device.
360 */
361 if (S_ISBLK(file_inode(fd)->i_mode)) {
362 if (ret < 0 || ret != data_length) {
363 pr_err("%s() returned %d, expecting %u for "
364 "S_ISBLK\n", __func__, ret,
365 data_length);
366 if (ret >= 0)
367 ret = -EINVAL;
368 }
369 } else {
370 if (ret < 0) {
371 pr_err("%s() returned %d for non S_ISBLK\n",
372 __func__, ret);
373 } else if (ret != data_length) {
374 /*
375 * Short read case:
376 * Probably some one truncate file under us.
377 * We must explicitly zero sg-pages to prevent
378 * expose uninizialized pages to userspace.
379 */
380 if (ret < data_length)
381 ret += iov_iter_zero(data_length - ret, &iter);
382 else
383 ret = -EINVAL;
384 }
385 }
386 }
387 kfree(bvec);
388 return ret;
389}
390
391static sense_reason_t
392fd_execute_sync_cache(struct se_cmd *cmd)
393{
394 struct se_device *dev = cmd->se_dev;
395 struct fd_dev *fd_dev = FD_DEV(dev);
396 int immed = (cmd->t_task_cdb[1] & 0x2);
397 loff_t start, end;
398 int ret;
399
400 /*
401 * If the Immediate bit is set, queue up the GOOD response
402 * for this SYNCHRONIZE_CACHE op
403 */
404 if (immed)
405 target_complete_cmd(cmd, SAM_STAT_GOOD);
406
407 /*
408 * Determine if we will be flushing the entire device.
409 */
410 if (cmd->t_task_lba == 0 && cmd->data_length == 0) {
411 start = 0;
412 end = LLONG_MAX;
413 } else {
414 start = cmd->t_task_lba * dev->dev_attrib.block_size;
415 if (cmd->data_length)
416 end = start + cmd->data_length - 1;
417 else
418 end = LLONG_MAX;
419 }
420
421 ret = vfs_fsync_range(fd_dev->fd_file, start, end, 1);
422 if (ret != 0)
423 pr_err("FILEIO: vfs_fsync_range() failed: %d\n", ret);
424
425 if (immed)
426 return 0;
427
428 if (ret)
429 target_complete_cmd(cmd, SAM_STAT_CHECK_CONDITION);
430 else
431 target_complete_cmd(cmd, SAM_STAT_GOOD);
432
433 return 0;
434}
435
436static sense_reason_t
437fd_execute_write_same(struct se_cmd *cmd)
438{
439 struct se_device *se_dev = cmd->se_dev;
440 struct fd_dev *fd_dev = FD_DEV(se_dev);
441 loff_t pos = cmd->t_task_lba * se_dev->dev_attrib.block_size;
442 sector_t nolb = sbc_get_write_same_sectors(cmd);
443 struct iov_iter iter;
444 struct bio_vec *bvec;
445 unsigned int len = 0, i;
446 ssize_t ret;
447
448 if (!nolb) {
449 target_complete_cmd(cmd, SAM_STAT_GOOD);
450 return 0;
451 }
452 if (cmd->prot_op) {
453 pr_err("WRITE_SAME: Protection information with FILEIO"
454 " backends not supported\n");
455 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
456 }
457
458 if (cmd->t_data_nents > 1 ||
459 cmd->t_data_sg[0].length != cmd->se_dev->dev_attrib.block_size) {
460 pr_err("WRITE_SAME: Illegal SGL t_data_nents: %u length: %u"
461 " block_size: %u\n",
462 cmd->t_data_nents,
463 cmd->t_data_sg[0].length,
464 cmd->se_dev->dev_attrib.block_size);
465 return TCM_INVALID_CDB_FIELD;
466 }
467
468 bvec = kcalloc(nolb, sizeof(struct bio_vec), GFP_KERNEL);
469 if (!bvec)
470 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
471
472 for (i = 0; i < nolb; i++) {
473 bvec[i].bv_page = sg_page(&cmd->t_data_sg[0]);
474 bvec[i].bv_len = cmd->t_data_sg[0].length;
475 bvec[i].bv_offset = cmd->t_data_sg[0].offset;
476
477 len += se_dev->dev_attrib.block_size;
478 }
479
480 iov_iter_bvec(&iter, READ, bvec, nolb, len);
481 ret = vfs_iter_write(fd_dev->fd_file, &iter, &pos, 0);
482
483 kfree(bvec);
484 if (ret < 0 || ret != len) {
485 pr_err("vfs_iter_write() returned %zd for write same\n", ret);
486 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
487 }
488
489 target_complete_cmd(cmd, SAM_STAT_GOOD);
490 return 0;
491}
492
493static int
494fd_do_prot_fill(struct se_device *se_dev, sector_t lba, sector_t nolb,
495 void *buf, size_t bufsize)
496{
497 struct fd_dev *fd_dev = FD_DEV(se_dev);
498 struct file *prot_fd = fd_dev->fd_prot_file;
499 sector_t prot_length, prot;
500 loff_t pos = lba * se_dev->prot_length;
501
502 if (!prot_fd) {
503 pr_err("Unable to locate fd_dev->fd_prot_file\n");
504 return -ENODEV;
505 }
506
507 prot_length = nolb * se_dev->prot_length;
508
509 for (prot = 0; prot < prot_length;) {
510 sector_t len = min_t(sector_t, bufsize, prot_length - prot);
511 ssize_t ret = kernel_write(prot_fd, buf, len, &pos);
512
513 if (ret != len) {
514 pr_err("vfs_write to prot file failed: %zd\n", ret);
515 return ret < 0 ? ret : -ENODEV;
516 }
517 prot += ret;
518 }
519
520 return 0;
521}
522
523static int
524fd_do_prot_unmap(struct se_cmd *cmd, sector_t lba, sector_t nolb)
525{
526 void *buf;
527 int rc;
528
529 buf = (void *)__get_free_page(GFP_KERNEL);
530 if (!buf) {
531 pr_err("Unable to allocate FILEIO prot buf\n");
532 return -ENOMEM;
533 }
534 memset(buf, 0xff, PAGE_SIZE);
535
536 rc = fd_do_prot_fill(cmd->se_dev, lba, nolb, buf, PAGE_SIZE);
537
538 free_page((unsigned long)buf);
539
540 return rc;
541}
542
543static sense_reason_t
544fd_execute_unmap(struct se_cmd *cmd, sector_t lba, sector_t nolb)
545{
546 struct file *file = FD_DEV(cmd->se_dev)->fd_file;
547 struct inode *inode = file->f_mapping->host;
548 int ret;
549
550 if (!nolb) {
551 return 0;
552 }
553
554 if (cmd->se_dev->dev_attrib.pi_prot_type) {
555 ret = fd_do_prot_unmap(cmd, lba, nolb);
556 if (ret)
557 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
558 }
559
560 if (S_ISBLK(inode->i_mode)) {
561 /* The backend is block device, use discard */
562 struct block_device *bdev = inode->i_bdev;
563 struct se_device *dev = cmd->se_dev;
564
565 ret = blkdev_issue_discard(bdev,
566 target_to_linux_sector(dev, lba),
567 target_to_linux_sector(dev, nolb),
568 GFP_KERNEL, 0);
569 if (ret < 0) {
570 pr_warn("FILEIO: blkdev_issue_discard() failed: %d\n",
571 ret);
572 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
573 }
574 } else {
575 /* The backend is normal file, use fallocate */
576 struct se_device *se_dev = cmd->se_dev;
577 loff_t pos = lba * se_dev->dev_attrib.block_size;
578 unsigned int len = nolb * se_dev->dev_attrib.block_size;
579 int mode = FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE;
580
581 if (!file->f_op->fallocate)
582 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
583
584 ret = file->f_op->fallocate(file, mode, pos, len);
585 if (ret < 0) {
586 pr_warn("FILEIO: fallocate() failed: %d\n", ret);
587 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
588 }
589 }
590
591 return 0;
592}
593
594static sense_reason_t
595fd_execute_rw_buffered(struct se_cmd *cmd, struct scatterlist *sgl, u32 sgl_nents,
596 enum dma_data_direction data_direction)
597{
598 struct se_device *dev = cmd->se_dev;
599 struct fd_dev *fd_dev = FD_DEV(dev);
600 struct file *file = fd_dev->fd_file;
601 struct file *pfile = fd_dev->fd_prot_file;
602 sense_reason_t rc;
603 int ret = 0;
604 /*
605 * Call vectorized fileio functions to map struct scatterlist
606 * physical memory addresses to struct iovec virtual memory.
607 */
608 if (data_direction == DMA_FROM_DEVICE) {
609 if (cmd->prot_type && dev->dev_attrib.pi_prot_type) {
610 ret = fd_do_rw(cmd, pfile, dev->prot_length,
611 cmd->t_prot_sg, cmd->t_prot_nents,
612 cmd->prot_length, 0);
613 if (ret < 0)
614 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
615 }
616
617 ret = fd_do_rw(cmd, file, dev->dev_attrib.block_size,
618 sgl, sgl_nents, cmd->data_length, 0);
619
620 if (ret > 0 && cmd->prot_type && dev->dev_attrib.pi_prot_type &&
621 dev->dev_attrib.pi_prot_verify) {
622 u32 sectors = cmd->data_length >>
623 ilog2(dev->dev_attrib.block_size);
624
625 rc = sbc_dif_verify(cmd, cmd->t_task_lba, sectors,
626 0, cmd->t_prot_sg, 0);
627 if (rc)
628 return rc;
629 }
630 } else {
631 if (cmd->prot_type && dev->dev_attrib.pi_prot_type &&
632 dev->dev_attrib.pi_prot_verify) {
633 u32 sectors = cmd->data_length >>
634 ilog2(dev->dev_attrib.block_size);
635
636 rc = sbc_dif_verify(cmd, cmd->t_task_lba, sectors,
637 0, cmd->t_prot_sg, 0);
638 if (rc)
639 return rc;
640 }
641
642 ret = fd_do_rw(cmd, file, dev->dev_attrib.block_size,
643 sgl, sgl_nents, cmd->data_length, 1);
644 /*
645 * Perform implicit vfs_fsync_range() for fd_do_writev() ops
646 * for SCSI WRITEs with Forced Unit Access (FUA) set.
647 * Allow this to happen independent of WCE=0 setting.
648 */
649 if (ret > 0 && (cmd->se_cmd_flags & SCF_FUA)) {
650 loff_t start = cmd->t_task_lba *
651 dev->dev_attrib.block_size;
652 loff_t end;
653
654 if (cmd->data_length)
655 end = start + cmd->data_length - 1;
656 else
657 end = LLONG_MAX;
658
659 vfs_fsync_range(fd_dev->fd_file, start, end, 1);
660 }
661
662 if (ret > 0 && cmd->prot_type && dev->dev_attrib.pi_prot_type) {
663 ret = fd_do_rw(cmd, pfile, dev->prot_length,
664 cmd->t_prot_sg, cmd->t_prot_nents,
665 cmd->prot_length, 1);
666 if (ret < 0)
667 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
668 }
669 }
670
671 if (ret < 0)
672 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
673
674 target_complete_cmd(cmd, SAM_STAT_GOOD);
675 return 0;
676}
677
678static sense_reason_t
679fd_execute_rw(struct se_cmd *cmd, struct scatterlist *sgl, u32 sgl_nents,
680 enum dma_data_direction data_direction)
681{
682 struct se_device *dev = cmd->se_dev;
683 struct fd_dev *fd_dev = FD_DEV(dev);
684
685 /*
686 * We are currently limited by the number of iovecs (2048) per
687 * single vfs_[writev,readv] call.
688 */
689 if (cmd->data_length > FD_MAX_BYTES) {
690 pr_err("FILEIO: Not able to process I/O of %u bytes due to"
691 "FD_MAX_BYTES: %u iovec count limitation\n",
692 cmd->data_length, FD_MAX_BYTES);
693 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
694 }
695
696 if (fd_dev->fbd_flags & FDBD_HAS_ASYNC_IO)
697 return fd_execute_rw_aio(cmd, sgl, sgl_nents, data_direction);
698 return fd_execute_rw_buffered(cmd, sgl, sgl_nents, data_direction);
699}
700
701enum {
702 Opt_fd_dev_name, Opt_fd_dev_size, Opt_fd_buffered_io,
703 Opt_fd_async_io, Opt_err
704};
705
706static match_table_t tokens = {
707 {Opt_fd_dev_name, "fd_dev_name=%s"},
708 {Opt_fd_dev_size, "fd_dev_size=%s"},
709 {Opt_fd_buffered_io, "fd_buffered_io=%d"},
710 {Opt_fd_async_io, "fd_async_io=%d"},
711 {Opt_err, NULL}
712};
713
714static ssize_t fd_set_configfs_dev_params(struct se_device *dev,
715 const char *page, ssize_t count)
716{
717 struct fd_dev *fd_dev = FD_DEV(dev);
718 char *orig, *ptr, *arg_p, *opts;
719 substring_t args[MAX_OPT_ARGS];
720 int ret = 0, arg, token;
721
722 opts = kstrdup(page, GFP_KERNEL);
723 if (!opts)
724 return -ENOMEM;
725
726 orig = opts;
727
728 while ((ptr = strsep(&opts, ",\n")) != NULL) {
729 if (!*ptr)
730 continue;
731
732 token = match_token(ptr, tokens, args);
733 switch (token) {
734 case Opt_fd_dev_name:
735 if (match_strlcpy(fd_dev->fd_dev_name, &args[0],
736 FD_MAX_DEV_NAME) == 0) {
737 ret = -EINVAL;
738 break;
739 }
740 pr_debug("FILEIO: Referencing Path: %s\n",
741 fd_dev->fd_dev_name);
742 fd_dev->fbd_flags |= FBDF_HAS_PATH;
743 break;
744 case Opt_fd_dev_size:
745 arg_p = match_strdup(&args[0]);
746 if (!arg_p) {
747 ret = -ENOMEM;
748 break;
749 }
750 ret = kstrtoull(arg_p, 0, &fd_dev->fd_dev_size);
751 kfree(arg_p);
752 if (ret < 0) {
753 pr_err("kstrtoull() failed for"
754 " fd_dev_size=\n");
755 goto out;
756 }
757 pr_debug("FILEIO: Referencing Size: %llu"
758 " bytes\n", fd_dev->fd_dev_size);
759 fd_dev->fbd_flags |= FBDF_HAS_SIZE;
760 break;
761 case Opt_fd_buffered_io:
762 ret = match_int(args, &arg);
763 if (ret)
764 goto out;
765 if (arg != 1) {
766 pr_err("bogus fd_buffered_io=%d value\n", arg);
767 ret = -EINVAL;
768 goto out;
769 }
770
771 pr_debug("FILEIO: Using buffered I/O"
772 " operations for struct fd_dev\n");
773
774 fd_dev->fbd_flags |= FDBD_HAS_BUFFERED_IO_WCE;
775 break;
776 case Opt_fd_async_io:
777 ret = match_int(args, &arg);
778 if (ret)
779 goto out;
780 if (arg != 1) {
781 pr_err("bogus fd_async_io=%d value\n", arg);
782 ret = -EINVAL;
783 goto out;
784 }
785
786 pr_debug("FILEIO: Using async I/O"
787 " operations for struct fd_dev\n");
788
789 fd_dev->fbd_flags |= FDBD_HAS_ASYNC_IO;
790 break;
791 default:
792 break;
793 }
794 }
795
796out:
797 kfree(orig);
798 return (!ret) ? count : ret;
799}
800
801static ssize_t fd_show_configfs_dev_params(struct se_device *dev, char *b)
802{
803 struct fd_dev *fd_dev = FD_DEV(dev);
804 ssize_t bl = 0;
805
806 bl = sprintf(b + bl, "TCM FILEIO ID: %u", fd_dev->fd_dev_id);
807 bl += sprintf(b + bl, " File: %s Size: %llu Mode: %s Async: %d\n",
808 fd_dev->fd_dev_name, fd_dev->fd_dev_size,
809 (fd_dev->fbd_flags & FDBD_HAS_BUFFERED_IO_WCE) ?
810 "Buffered-WCE" : "O_DSYNC",
811 !!(fd_dev->fbd_flags & FDBD_HAS_ASYNC_IO));
812 return bl;
813}
814
815static sector_t fd_get_blocks(struct se_device *dev)
816{
817 struct fd_dev *fd_dev = FD_DEV(dev);
818 struct file *f = fd_dev->fd_file;
819 struct inode *i = f->f_mapping->host;
820 unsigned long long dev_size;
821 /*
822 * When using a file that references an underlying struct block_device,
823 * ensure dev_size is always based on the current inode size in order
824 * to handle underlying block_device resize operations.
825 */
826 if (S_ISBLK(i->i_mode))
827 dev_size = i_size_read(i);
828 else
829 dev_size = fd_dev->fd_dev_size;
830
831 return div_u64(dev_size - dev->dev_attrib.block_size,
832 dev->dev_attrib.block_size);
833}
834
835static int fd_init_prot(struct se_device *dev)
836{
837 struct fd_dev *fd_dev = FD_DEV(dev);
838 struct file *prot_file, *file = fd_dev->fd_file;
839 struct inode *inode;
840 int ret, flags = O_RDWR | O_CREAT | O_LARGEFILE | O_DSYNC;
841 char buf[FD_MAX_DEV_PROT_NAME];
842
843 if (!file) {
844 pr_err("Unable to locate fd_dev->fd_file\n");
845 return -ENODEV;
846 }
847
848 inode = file->f_mapping->host;
849 if (S_ISBLK(inode->i_mode)) {
850 pr_err("FILEIO Protection emulation only supported on"
851 " !S_ISBLK\n");
852 return -ENOSYS;
853 }
854
855 if (fd_dev->fbd_flags & FDBD_HAS_BUFFERED_IO_WCE)
856 flags &= ~O_DSYNC;
857
858 snprintf(buf, FD_MAX_DEV_PROT_NAME, "%s.protection",
859 fd_dev->fd_dev_name);
860
861 prot_file = filp_open(buf, flags, 0600);
862 if (IS_ERR(prot_file)) {
863 pr_err("filp_open(%s) failed\n", buf);
864 ret = PTR_ERR(prot_file);
865 return ret;
866 }
867 fd_dev->fd_prot_file = prot_file;
868
869 return 0;
870}
871
872static int fd_format_prot(struct se_device *dev)
873{
874 unsigned char *buf;
875 int unit_size = FDBD_FORMAT_UNIT_SIZE * dev->dev_attrib.block_size;
876 int ret;
877
878 if (!dev->dev_attrib.pi_prot_type) {
879 pr_err("Unable to format_prot while pi_prot_type == 0\n");
880 return -ENODEV;
881 }
882
883 buf = vzalloc(unit_size);
884 if (!buf) {
885 pr_err("Unable to allocate FILEIO prot buf\n");
886 return -ENOMEM;
887 }
888
889 pr_debug("Using FILEIO prot_length: %llu\n",
890 (unsigned long long)(dev->transport->get_blocks(dev) + 1) *
891 dev->prot_length);
892
893 memset(buf, 0xff, unit_size);
894 ret = fd_do_prot_fill(dev, 0, dev->transport->get_blocks(dev) + 1,
895 buf, unit_size);
896 vfree(buf);
897 return ret;
898}
899
900static void fd_free_prot(struct se_device *dev)
901{
902 struct fd_dev *fd_dev = FD_DEV(dev);
903
904 if (!fd_dev->fd_prot_file)
905 return;
906
907 filp_close(fd_dev->fd_prot_file, NULL);
908 fd_dev->fd_prot_file = NULL;
909}
910
911static struct sbc_ops fd_sbc_ops = {
912 .execute_rw = fd_execute_rw,
913 .execute_sync_cache = fd_execute_sync_cache,
914 .execute_write_same = fd_execute_write_same,
915 .execute_unmap = fd_execute_unmap,
916};
917
918static sense_reason_t
919fd_parse_cdb(struct se_cmd *cmd)
920{
921 return sbc_parse_cdb(cmd, &fd_sbc_ops);
922}
923
924static const struct target_backend_ops fileio_ops = {
925 .name = "fileio",
926 .inquiry_prod = "FILEIO",
927 .inquiry_rev = FD_VERSION,
928 .owner = THIS_MODULE,
929 .attach_hba = fd_attach_hba,
930 .detach_hba = fd_detach_hba,
931 .alloc_device = fd_alloc_device,
932 .configure_device = fd_configure_device,
933 .destroy_device = fd_destroy_device,
934 .free_device = fd_free_device,
935 .parse_cdb = fd_parse_cdb,
936 .set_configfs_dev_params = fd_set_configfs_dev_params,
937 .show_configfs_dev_params = fd_show_configfs_dev_params,
938 .get_device_type = sbc_get_device_type,
939 .get_blocks = fd_get_blocks,
940 .init_prot = fd_init_prot,
941 .format_prot = fd_format_prot,
942 .free_prot = fd_free_prot,
943 .tb_dev_attrib_attrs = sbc_attrib_attrs,
944};
945
946static int __init fileio_module_init(void)
947{
948 return transport_backend_register(&fileio_ops);
949}
950
951static void __exit fileio_module_exit(void)
952{
953 target_backend_unregister(&fileio_ops);
954}
955
956MODULE_DESCRIPTION("TCM FILEIO subsystem plugin");
957MODULE_AUTHOR("nab@Linux-iSCSI.org");
958MODULE_LICENSE("GPL");
959
960module_init(fileio_module_init);
961module_exit(fileio_module_exit);
1/*******************************************************************************
2 * Filename: target_core_file.c
3 *
4 * This file contains the Storage Engine <-> FILEIO transport specific functions
5 *
6 * Copyright (c) 2005 PyX Technologies, Inc.
7 * Copyright (c) 2005-2006 SBE, Inc. All Rights Reserved.
8 * Copyright (c) 2007-2010 Rising Tide Systems
9 * Copyright (c) 2008-2010 Linux-iSCSI.org
10 *
11 * Nicholas A. Bellinger <nab@kernel.org>
12 *
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
17 *
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
22 *
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
26 *
27 ******************************************************************************/
28
29#include <linux/string.h>
30#include <linux/parser.h>
31#include <linux/timer.h>
32#include <linux/blkdev.h>
33#include <linux/slab.h>
34#include <linux/spinlock.h>
35#include <linux/module.h>
36#include <scsi/scsi.h>
37#include <scsi/scsi_host.h>
38
39#include <target/target_core_base.h>
40#include <target/target_core_backend.h>
41
42#include "target_core_file.h"
43
44static struct se_subsystem_api fileio_template;
45
46/* fd_attach_hba(): (Part of se_subsystem_api_t template)
47 *
48 *
49 */
50static int fd_attach_hba(struct se_hba *hba, u32 host_id)
51{
52 struct fd_host *fd_host;
53
54 fd_host = kzalloc(sizeof(struct fd_host), GFP_KERNEL);
55 if (!fd_host) {
56 pr_err("Unable to allocate memory for struct fd_host\n");
57 return -ENOMEM;
58 }
59
60 fd_host->fd_host_id = host_id;
61
62 hba->hba_ptr = fd_host;
63
64 pr_debug("CORE_HBA[%d] - TCM FILEIO HBA Driver %s on Generic"
65 " Target Core Stack %s\n", hba->hba_id, FD_VERSION,
66 TARGET_CORE_MOD_VERSION);
67 pr_debug("CORE_HBA[%d] - Attached FILEIO HBA: %u to Generic"
68 " MaxSectors: %u\n",
69 hba->hba_id, fd_host->fd_host_id, FD_MAX_SECTORS);
70
71 return 0;
72}
73
74static void fd_detach_hba(struct se_hba *hba)
75{
76 struct fd_host *fd_host = hba->hba_ptr;
77
78 pr_debug("CORE_HBA[%d] - Detached FILEIO HBA: %u from Generic"
79 " Target Core\n", hba->hba_id, fd_host->fd_host_id);
80
81 kfree(fd_host);
82 hba->hba_ptr = NULL;
83}
84
85static void *fd_allocate_virtdevice(struct se_hba *hba, const char *name)
86{
87 struct fd_dev *fd_dev;
88 struct fd_host *fd_host = hba->hba_ptr;
89
90 fd_dev = kzalloc(sizeof(struct fd_dev), GFP_KERNEL);
91 if (!fd_dev) {
92 pr_err("Unable to allocate memory for struct fd_dev\n");
93 return NULL;
94 }
95
96 fd_dev->fd_host = fd_host;
97
98 pr_debug("FILEIO: Allocated fd_dev for %p\n", name);
99
100 return fd_dev;
101}
102
103/* fd_create_virtdevice(): (Part of se_subsystem_api_t template)
104 *
105 *
106 */
107static struct se_device *fd_create_virtdevice(
108 struct se_hba *hba,
109 struct se_subsystem_dev *se_dev,
110 void *p)
111{
112 char *dev_p = NULL;
113 struct se_device *dev;
114 struct se_dev_limits dev_limits;
115 struct queue_limits *limits;
116 struct fd_dev *fd_dev = p;
117 struct fd_host *fd_host = hba->hba_ptr;
118 mm_segment_t old_fs;
119 struct file *file;
120 struct inode *inode = NULL;
121 int dev_flags = 0, flags, ret = -EINVAL;
122
123 memset(&dev_limits, 0, sizeof(struct se_dev_limits));
124
125 old_fs = get_fs();
126 set_fs(get_ds());
127 dev_p = getname(fd_dev->fd_dev_name);
128 set_fs(old_fs);
129
130 if (IS_ERR(dev_p)) {
131 pr_err("getname(%s) failed: %lu\n",
132 fd_dev->fd_dev_name, IS_ERR(dev_p));
133 ret = PTR_ERR(dev_p);
134 goto fail;
135 }
136 /*
137 * Use O_DSYNC by default instead of O_SYNC to forgo syncing
138 * of pure timestamp updates.
139 */
140 flags = O_RDWR | O_CREAT | O_LARGEFILE | O_DSYNC;
141
142 file = filp_open(dev_p, flags, 0600);
143 if (IS_ERR(file)) {
144 pr_err("filp_open(%s) failed\n", dev_p);
145 ret = PTR_ERR(file);
146 goto fail;
147 }
148 if (!file || !file->f_dentry) {
149 pr_err("filp_open(%s) failed\n", dev_p);
150 goto fail;
151 }
152 fd_dev->fd_file = file;
153 /*
154 * If using a block backend with this struct file, we extract
155 * fd_dev->fd_[block,dev]_size from struct block_device.
156 *
157 * Otherwise, we use the passed fd_size= from configfs
158 */
159 inode = file->f_mapping->host;
160 if (S_ISBLK(inode->i_mode)) {
161 struct request_queue *q;
162 unsigned long long dev_size;
163 /*
164 * Setup the local scope queue_limits from struct request_queue->limits
165 * to pass into transport_add_device_to_core_hba() as struct se_dev_limits.
166 */
167 q = bdev_get_queue(inode->i_bdev);
168 limits = &dev_limits.limits;
169 limits->logical_block_size = bdev_logical_block_size(inode->i_bdev);
170 limits->max_hw_sectors = queue_max_hw_sectors(q);
171 limits->max_sectors = queue_max_sectors(q);
172 /*
173 * Determine the number of bytes from i_size_read() minus
174 * one (1) logical sector from underlying struct block_device
175 */
176 fd_dev->fd_block_size = bdev_logical_block_size(inode->i_bdev);
177 dev_size = (i_size_read(file->f_mapping->host) -
178 fd_dev->fd_block_size);
179
180 pr_debug("FILEIO: Using size: %llu bytes from struct"
181 " block_device blocks: %llu logical_block_size: %d\n",
182 dev_size, div_u64(dev_size, fd_dev->fd_block_size),
183 fd_dev->fd_block_size);
184 } else {
185 if (!(fd_dev->fbd_flags & FBDF_HAS_SIZE)) {
186 pr_err("FILEIO: Missing fd_dev_size="
187 " parameter, and no backing struct"
188 " block_device\n");
189 goto fail;
190 }
191
192 limits = &dev_limits.limits;
193 limits->logical_block_size = FD_BLOCKSIZE;
194 limits->max_hw_sectors = FD_MAX_SECTORS;
195 limits->max_sectors = FD_MAX_SECTORS;
196 fd_dev->fd_block_size = FD_BLOCKSIZE;
197 }
198
199 dev_limits.hw_queue_depth = FD_MAX_DEVICE_QUEUE_DEPTH;
200 dev_limits.queue_depth = FD_DEVICE_QUEUE_DEPTH;
201
202 dev = transport_add_device_to_core_hba(hba, &fileio_template,
203 se_dev, dev_flags, fd_dev,
204 &dev_limits, "FILEIO", FD_VERSION);
205 if (!dev)
206 goto fail;
207
208 fd_dev->fd_dev_id = fd_host->fd_host_dev_id_count++;
209 fd_dev->fd_queue_depth = dev->queue_depth;
210
211 pr_debug("CORE_FILE[%u] - Added TCM FILEIO Device ID: %u at %s,"
212 " %llu total bytes\n", fd_host->fd_host_id, fd_dev->fd_dev_id,
213 fd_dev->fd_dev_name, fd_dev->fd_dev_size);
214
215 putname(dev_p);
216 return dev;
217fail:
218 if (fd_dev->fd_file) {
219 filp_close(fd_dev->fd_file, NULL);
220 fd_dev->fd_file = NULL;
221 }
222 putname(dev_p);
223 return ERR_PTR(ret);
224}
225
226/* fd_free_device(): (Part of se_subsystem_api_t template)
227 *
228 *
229 */
230static void fd_free_device(void *p)
231{
232 struct fd_dev *fd_dev = p;
233
234 if (fd_dev->fd_file) {
235 filp_close(fd_dev->fd_file, NULL);
236 fd_dev->fd_file = NULL;
237 }
238
239 kfree(fd_dev);
240}
241
242static int fd_do_readv(struct se_cmd *cmd, struct scatterlist *sgl,
243 u32 sgl_nents)
244{
245 struct se_device *se_dev = cmd->se_dev;
246 struct fd_dev *dev = se_dev->dev_ptr;
247 struct file *fd = dev->fd_file;
248 struct scatterlist *sg;
249 struct iovec *iov;
250 mm_segment_t old_fs;
251 loff_t pos = (cmd->t_task_lba *
252 se_dev->se_sub_dev->se_dev_attrib.block_size);
253 int ret = 0, i;
254
255 iov = kzalloc(sizeof(struct iovec) * sgl_nents, GFP_KERNEL);
256 if (!iov) {
257 pr_err("Unable to allocate fd_do_readv iov[]\n");
258 return -ENOMEM;
259 }
260
261 for_each_sg(sgl, sg, sgl_nents, i) {
262 iov[i].iov_len = sg->length;
263 iov[i].iov_base = sg_virt(sg);
264 }
265
266 old_fs = get_fs();
267 set_fs(get_ds());
268 ret = vfs_readv(fd, &iov[0], sgl_nents, &pos);
269 set_fs(old_fs);
270
271 kfree(iov);
272 /*
273 * Return zeros and GOOD status even if the READ did not return
274 * the expected virt_size for struct file w/o a backing struct
275 * block_device.
276 */
277 if (S_ISBLK(fd->f_dentry->d_inode->i_mode)) {
278 if (ret < 0 || ret != cmd->data_length) {
279 pr_err("vfs_readv() returned %d,"
280 " expecting %d for S_ISBLK\n", ret,
281 (int)cmd->data_length);
282 return (ret < 0 ? ret : -EINVAL);
283 }
284 } else {
285 if (ret < 0) {
286 pr_err("vfs_readv() returned %d for non"
287 " S_ISBLK\n", ret);
288 return ret;
289 }
290 }
291
292 return 1;
293}
294
295static int fd_do_writev(struct se_cmd *cmd, struct scatterlist *sgl,
296 u32 sgl_nents)
297{
298 struct se_device *se_dev = cmd->se_dev;
299 struct fd_dev *dev = se_dev->dev_ptr;
300 struct file *fd = dev->fd_file;
301 struct scatterlist *sg;
302 struct iovec *iov;
303 mm_segment_t old_fs;
304 loff_t pos = (cmd->t_task_lba *
305 se_dev->se_sub_dev->se_dev_attrib.block_size);
306 int ret, i = 0;
307
308 iov = kzalloc(sizeof(struct iovec) * sgl_nents, GFP_KERNEL);
309 if (!iov) {
310 pr_err("Unable to allocate fd_do_writev iov[]\n");
311 return -ENOMEM;
312 }
313
314 for_each_sg(sgl, sg, sgl_nents, i) {
315 iov[i].iov_len = sg->length;
316 iov[i].iov_base = sg_virt(sg);
317 }
318
319 old_fs = get_fs();
320 set_fs(get_ds());
321 ret = vfs_writev(fd, &iov[0], sgl_nents, &pos);
322 set_fs(old_fs);
323
324 kfree(iov);
325
326 if (ret < 0 || ret != cmd->data_length) {
327 pr_err("vfs_writev() returned %d\n", ret);
328 return (ret < 0 ? ret : -EINVAL);
329 }
330
331 return 1;
332}
333
334static void fd_emulate_sync_cache(struct se_cmd *cmd)
335{
336 struct se_device *dev = cmd->se_dev;
337 struct fd_dev *fd_dev = dev->dev_ptr;
338 int immed = (cmd->t_task_cdb[1] & 0x2);
339 loff_t start, end;
340 int ret;
341
342 /*
343 * If the Immediate bit is set, queue up the GOOD response
344 * for this SYNCHRONIZE_CACHE op
345 */
346 if (immed)
347 target_complete_cmd(cmd, SAM_STAT_GOOD);
348
349 /*
350 * Determine if we will be flushing the entire device.
351 */
352 if (cmd->t_task_lba == 0 && cmd->data_length == 0) {
353 start = 0;
354 end = LLONG_MAX;
355 } else {
356 start = cmd->t_task_lba * dev->se_sub_dev->se_dev_attrib.block_size;
357 if (cmd->data_length)
358 end = start + cmd->data_length;
359 else
360 end = LLONG_MAX;
361 }
362
363 ret = vfs_fsync_range(fd_dev->fd_file, start, end, 1);
364 if (ret != 0)
365 pr_err("FILEIO: vfs_fsync_range() failed: %d\n", ret);
366
367 if (immed)
368 return;
369
370 if (ret) {
371 cmd->scsi_sense_reason = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
372 target_complete_cmd(cmd, SAM_STAT_CHECK_CONDITION);
373 } else {
374 target_complete_cmd(cmd, SAM_STAT_GOOD);
375 }
376}
377
378static int fd_execute_cmd(struct se_cmd *cmd, struct scatterlist *sgl,
379 u32 sgl_nents, enum dma_data_direction data_direction)
380{
381 struct se_device *dev = cmd->se_dev;
382 int ret = 0;
383
384 /*
385 * Call vectorized fileio functions to map struct scatterlist
386 * physical memory addresses to struct iovec virtual memory.
387 */
388 if (data_direction == DMA_FROM_DEVICE) {
389 ret = fd_do_readv(cmd, sgl, sgl_nents);
390 } else {
391 ret = fd_do_writev(cmd, sgl, sgl_nents);
392 /*
393 * Perform implict vfs_fsync_range() for fd_do_writev() ops
394 * for SCSI WRITEs with Forced Unit Access (FUA) set.
395 * Allow this to happen independent of WCE=0 setting.
396 */
397 if (ret > 0 &&
398 dev->se_sub_dev->se_dev_attrib.emulate_fua_write > 0 &&
399 (cmd->se_cmd_flags & SCF_FUA)) {
400 struct fd_dev *fd_dev = dev->dev_ptr;
401 loff_t start = cmd->t_task_lba *
402 dev->se_sub_dev->se_dev_attrib.block_size;
403 loff_t end = start + cmd->data_length;
404
405 vfs_fsync_range(fd_dev->fd_file, start, end, 1);
406 }
407 }
408
409 if (ret < 0) {
410 cmd->scsi_sense_reason = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
411 return ret;
412 }
413 if (ret)
414 target_complete_cmd(cmd, SAM_STAT_GOOD);
415 return 0;
416}
417
418enum {
419 Opt_fd_dev_name, Opt_fd_dev_size, Opt_fd_buffered_io, Opt_err
420};
421
422static match_table_t tokens = {
423 {Opt_fd_dev_name, "fd_dev_name=%s"},
424 {Opt_fd_dev_size, "fd_dev_size=%s"},
425 {Opt_err, NULL}
426};
427
428static ssize_t fd_set_configfs_dev_params(
429 struct se_hba *hba,
430 struct se_subsystem_dev *se_dev,
431 const char *page, ssize_t count)
432{
433 struct fd_dev *fd_dev = se_dev->se_dev_su_ptr;
434 char *orig, *ptr, *arg_p, *opts;
435 substring_t args[MAX_OPT_ARGS];
436 int ret = 0, token;
437
438 opts = kstrdup(page, GFP_KERNEL);
439 if (!opts)
440 return -ENOMEM;
441
442 orig = opts;
443
444 while ((ptr = strsep(&opts, ",\n")) != NULL) {
445 if (!*ptr)
446 continue;
447
448 token = match_token(ptr, tokens, args);
449 switch (token) {
450 case Opt_fd_dev_name:
451 arg_p = match_strdup(&args[0]);
452 if (!arg_p) {
453 ret = -ENOMEM;
454 break;
455 }
456 snprintf(fd_dev->fd_dev_name, FD_MAX_DEV_NAME,
457 "%s", arg_p);
458 kfree(arg_p);
459 pr_debug("FILEIO: Referencing Path: %s\n",
460 fd_dev->fd_dev_name);
461 fd_dev->fbd_flags |= FBDF_HAS_PATH;
462 break;
463 case Opt_fd_dev_size:
464 arg_p = match_strdup(&args[0]);
465 if (!arg_p) {
466 ret = -ENOMEM;
467 break;
468 }
469 ret = strict_strtoull(arg_p, 0, &fd_dev->fd_dev_size);
470 kfree(arg_p);
471 if (ret < 0) {
472 pr_err("strict_strtoull() failed for"
473 " fd_dev_size=\n");
474 goto out;
475 }
476 pr_debug("FILEIO: Referencing Size: %llu"
477 " bytes\n", fd_dev->fd_dev_size);
478 fd_dev->fbd_flags |= FBDF_HAS_SIZE;
479 break;
480 default:
481 break;
482 }
483 }
484
485out:
486 kfree(orig);
487 return (!ret) ? count : ret;
488}
489
490static ssize_t fd_check_configfs_dev_params(struct se_hba *hba, struct se_subsystem_dev *se_dev)
491{
492 struct fd_dev *fd_dev = se_dev->se_dev_su_ptr;
493
494 if (!(fd_dev->fbd_flags & FBDF_HAS_PATH)) {
495 pr_err("Missing fd_dev_name=\n");
496 return -EINVAL;
497 }
498
499 return 0;
500}
501
502static ssize_t fd_show_configfs_dev_params(
503 struct se_hba *hba,
504 struct se_subsystem_dev *se_dev,
505 char *b)
506{
507 struct fd_dev *fd_dev = se_dev->se_dev_su_ptr;
508 ssize_t bl = 0;
509
510 bl = sprintf(b + bl, "TCM FILEIO ID: %u", fd_dev->fd_dev_id);
511 bl += sprintf(b + bl, " File: %s Size: %llu Mode: O_DSYNC\n",
512 fd_dev->fd_dev_name, fd_dev->fd_dev_size);
513 return bl;
514}
515
516/* fd_get_device_rev(): (Part of se_subsystem_api_t template)
517 *
518 *
519 */
520static u32 fd_get_device_rev(struct se_device *dev)
521{
522 return SCSI_SPC_2; /* Returns SPC-3 in Initiator Data */
523}
524
525/* fd_get_device_type(): (Part of se_subsystem_api_t template)
526 *
527 *
528 */
529static u32 fd_get_device_type(struct se_device *dev)
530{
531 return TYPE_DISK;
532}
533
534static sector_t fd_get_blocks(struct se_device *dev)
535{
536 struct fd_dev *fd_dev = dev->dev_ptr;
537 struct file *f = fd_dev->fd_file;
538 struct inode *i = f->f_mapping->host;
539 unsigned long long dev_size;
540 /*
541 * When using a file that references an underlying struct block_device,
542 * ensure dev_size is always based on the current inode size in order
543 * to handle underlying block_device resize operations.
544 */
545 if (S_ISBLK(i->i_mode))
546 dev_size = (i_size_read(i) - fd_dev->fd_block_size);
547 else
548 dev_size = fd_dev->fd_dev_size;
549
550 return div_u64(dev_size, dev->se_sub_dev->se_dev_attrib.block_size);
551}
552
553static struct se_subsystem_api fileio_template = {
554 .name = "fileio",
555 .owner = THIS_MODULE,
556 .transport_type = TRANSPORT_PLUGIN_VHBA_PDEV,
557 .write_cache_emulated = 1,
558 .fua_write_emulated = 1,
559 .attach_hba = fd_attach_hba,
560 .detach_hba = fd_detach_hba,
561 .allocate_virtdevice = fd_allocate_virtdevice,
562 .create_virtdevice = fd_create_virtdevice,
563 .free_device = fd_free_device,
564 .execute_cmd = fd_execute_cmd,
565 .do_sync_cache = fd_emulate_sync_cache,
566 .check_configfs_dev_params = fd_check_configfs_dev_params,
567 .set_configfs_dev_params = fd_set_configfs_dev_params,
568 .show_configfs_dev_params = fd_show_configfs_dev_params,
569 .get_device_rev = fd_get_device_rev,
570 .get_device_type = fd_get_device_type,
571 .get_blocks = fd_get_blocks,
572};
573
574static int __init fileio_module_init(void)
575{
576 return transport_subsystem_register(&fileio_template);
577}
578
579static void fileio_module_exit(void)
580{
581 transport_subsystem_release(&fileio_template);
582}
583
584MODULE_DESCRIPTION("TCM FILEIO subsystem plugin");
585MODULE_AUTHOR("nab@Linux-iSCSI.org");
586MODULE_LICENSE("GPL");
587
588module_init(fileio_module_init);
589module_exit(fileio_module_exit);