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