Merge branch 'rmobile-fixes-for-linus' of git://github.com/pmundt/linux-sh
[pandora-kernel.git] / drivers / target / target_core_file.c
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_device.h>
41 #include <target/target_core_transport.h>
42
43 #include "target_core_file.h"
44
45 static struct se_subsystem_api fileio_template;
46
47 /*      fd_attach_hba(): (Part of se_subsystem_api_t template)
48  *
49  *
50  */
51 static 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
75 static 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
86 static 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  */
108 static 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;
228 fail:
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  */
241 static 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
253 static inline struct fd_request *FILE_REQ(struct se_task *task)
254 {
255         return container_of(task, struct fd_request, fd_task);
256 }
257
258
259 static struct se_task *
260 fd_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
273 static int fd_do_readv(struct se_task *task)
274 {
275         struct fd_request *req = FILE_REQ(task);
276         struct se_device *se_dev = req->fd_task.task_se_cmd->se_dev;
277         struct fd_dev *dev = se_dev->dev_ptr;
278         struct file *fd = dev->fd_file;
279         struct scatterlist *sg = task->task_sg;
280         struct iovec *iov;
281         mm_segment_t old_fs;
282         loff_t pos = (task->task_lba *
283                       se_dev->se_sub_dev->se_dev_attrib.block_size);
284         int ret = 0, i;
285
286         iov = kzalloc(sizeof(struct iovec) * task->task_sg_nents, GFP_KERNEL);
287         if (!iov) {
288                 pr_err("Unable to allocate fd_do_readv iov[]\n");
289                 return -ENOMEM;
290         }
291
292         for_each_sg(task->task_sg, sg, task->task_sg_nents, i) {
293                 iov[i].iov_len = sg->length;
294                 iov[i].iov_base = sg_virt(sg);
295         }
296
297         old_fs = get_fs();
298         set_fs(get_ds());
299         ret = vfs_readv(fd, &iov[0], task->task_sg_nents, &pos);
300         set_fs(old_fs);
301
302         kfree(iov);
303         /*
304          * Return zeros and GOOD status even if the READ did not return
305          * the expected virt_size for struct file w/o a backing struct
306          * block_device.
307          */
308         if (S_ISBLK(fd->f_dentry->d_inode->i_mode)) {
309                 if (ret < 0 || ret != task->task_size) {
310                         pr_err("vfs_readv() returned %d,"
311                                 " expecting %d for S_ISBLK\n", ret,
312                                 (int)task->task_size);
313                         return (ret < 0 ? ret : -EINVAL);
314                 }
315         } else {
316                 if (ret < 0) {
317                         pr_err("vfs_readv() returned %d for non"
318                                 " S_ISBLK\n", ret);
319                         return ret;
320                 }
321         }
322
323         return 1;
324 }
325
326 static int fd_do_writev(struct se_task *task)
327 {
328         struct fd_request *req = FILE_REQ(task);
329         struct se_device *se_dev = req->fd_task.task_se_cmd->se_dev;
330         struct fd_dev *dev = se_dev->dev_ptr;
331         struct file *fd = dev->fd_file;
332         struct scatterlist *sg = task->task_sg;
333         struct iovec *iov;
334         mm_segment_t old_fs;
335         loff_t pos = (task->task_lba *
336                       se_dev->se_sub_dev->se_dev_attrib.block_size);
337         int ret, i = 0;
338
339         iov = kzalloc(sizeof(struct iovec) * task->task_sg_nents, GFP_KERNEL);
340         if (!iov) {
341                 pr_err("Unable to allocate fd_do_writev iov[]\n");
342                 return -ENOMEM;
343         }
344
345         for_each_sg(task->task_sg, sg, task->task_sg_nents, i) {
346                 iov[i].iov_len = sg->length;
347                 iov[i].iov_base = sg_virt(sg);
348         }
349
350         old_fs = get_fs();
351         set_fs(get_ds());
352         ret = vfs_writev(fd, &iov[0], task->task_sg_nents, &pos);
353         set_fs(old_fs);
354
355         kfree(iov);
356
357         if (ret < 0 || ret != task->task_size) {
358                 pr_err("vfs_writev() returned %d\n", ret);
359                 return (ret < 0 ? ret : -EINVAL);
360         }
361
362         return 1;
363 }
364
365 static void fd_emulate_sync_cache(struct se_task *task)
366 {
367         struct se_cmd *cmd = task->task_se_cmd;
368         struct se_device *dev = cmd->se_dev;
369         struct fd_dev *fd_dev = dev->dev_ptr;
370         int immed = (cmd->t_task_cdb[1] & 0x2);
371         loff_t start, end;
372         int ret;
373
374         /*
375          * If the Immediate bit is set, queue up the GOOD response
376          * for this SYNCHRONIZE_CACHE op
377          */
378         if (immed)
379                 transport_complete_sync_cache(cmd, 1);
380
381         /*
382          * Determine if we will be flushing the entire device.
383          */
384         if (cmd->t_task_lba == 0 && cmd->data_length == 0) {
385                 start = 0;
386                 end = LLONG_MAX;
387         } else {
388                 start = cmd->t_task_lba * dev->se_sub_dev->se_dev_attrib.block_size;
389                 if (cmd->data_length)
390                         end = start + cmd->data_length;
391                 else
392                         end = LLONG_MAX;
393         }
394
395         ret = vfs_fsync_range(fd_dev->fd_file, start, end, 1);
396         if (ret != 0)
397                 pr_err("FILEIO: vfs_fsync_range() failed: %d\n", ret);
398
399         if (!immed)
400                 transport_complete_sync_cache(cmd, ret == 0);
401 }
402
403 /*
404  * WRITE Force Unit Access (FUA) emulation on a per struct se_task
405  * LBA range basis..
406  */
407 static void fd_emulate_write_fua(struct se_cmd *cmd, struct se_task *task)
408 {
409         struct se_device *dev = cmd->se_dev;
410         struct fd_dev *fd_dev = dev->dev_ptr;
411         loff_t start = task->task_lba * dev->se_sub_dev->se_dev_attrib.block_size;
412         loff_t end = start + task->task_size;
413         int ret;
414
415         pr_debug("FILEIO: FUA WRITE LBA: %llu, bytes: %u\n",
416                         task->task_lba, task->task_size);
417
418         ret = vfs_fsync_range(fd_dev->fd_file, start, end, 1);
419         if (ret != 0)
420                 pr_err("FILEIO: vfs_fsync_range() failed: %d\n", ret);
421 }
422
423 static int fd_do_task(struct se_task *task)
424 {
425         struct se_cmd *cmd = task->task_se_cmd;
426         struct se_device *dev = cmd->se_dev;
427         int ret = 0;
428
429         /*
430          * Call vectorized fileio functions to map struct scatterlist
431          * physical memory addresses to struct iovec virtual memory.
432          */
433         if (task->task_data_direction == DMA_FROM_DEVICE) {
434                 ret = fd_do_readv(task);
435         } else {
436                 ret = fd_do_writev(task);
437
438                 if (ret > 0 &&
439                     dev->se_sub_dev->se_dev_attrib.emulate_write_cache > 0 &&
440                     dev->se_sub_dev->se_dev_attrib.emulate_fua_write > 0 &&
441                     (cmd->se_cmd_flags & SCF_FUA)) {
442                         /*
443                          * We might need to be a bit smarter here
444                          * and return some sense data to let the initiator
445                          * know the FUA WRITE cache sync failed..?
446                          */
447                         fd_emulate_write_fua(cmd, task);
448                 }
449
450         }
451
452         if (ret < 0) {
453                 cmd->scsi_sense_reason = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
454                 return ret;
455         }
456         if (ret) {
457                 task->task_scsi_status = GOOD;
458                 transport_complete_task(task, 1);
459         }
460         return 0;
461 }
462
463 /*      fd_free_task(): (Part of se_subsystem_api_t template)
464  *
465  *
466  */
467 static void fd_free_task(struct se_task *task)
468 {
469         struct fd_request *req = FILE_REQ(task);
470
471         kfree(req);
472 }
473
474 enum {
475         Opt_fd_dev_name, Opt_fd_dev_size, Opt_fd_buffered_io, Opt_err
476 };
477
478 static match_table_t tokens = {
479         {Opt_fd_dev_name, "fd_dev_name=%s"},
480         {Opt_fd_dev_size, "fd_dev_size=%s"},
481         {Opt_fd_buffered_io, "fd_buffered_io=%d"},
482         {Opt_err, NULL}
483 };
484
485 static ssize_t fd_set_configfs_dev_params(
486         struct se_hba *hba,
487         struct se_subsystem_dev *se_dev,
488         const char *page, ssize_t count)
489 {
490         struct fd_dev *fd_dev = se_dev->se_dev_su_ptr;
491         char *orig, *ptr, *arg_p, *opts;
492         substring_t args[MAX_OPT_ARGS];
493         int ret = 0, arg, token;
494
495         opts = kstrdup(page, GFP_KERNEL);
496         if (!opts)
497                 return -ENOMEM;
498
499         orig = opts;
500
501         while ((ptr = strsep(&opts, ",")) != NULL) {
502                 if (!*ptr)
503                         continue;
504
505                 token = match_token(ptr, tokens, args);
506                 switch (token) {
507                 case Opt_fd_dev_name:
508                         arg_p = match_strdup(&args[0]);
509                         if (!arg_p) {
510                                 ret = -ENOMEM;
511                                 break;
512                         }
513                         snprintf(fd_dev->fd_dev_name, FD_MAX_DEV_NAME,
514                                         "%s", arg_p);
515                         kfree(arg_p);
516                         pr_debug("FILEIO: Referencing Path: %s\n",
517                                         fd_dev->fd_dev_name);
518                         fd_dev->fbd_flags |= FBDF_HAS_PATH;
519                         break;
520                 case Opt_fd_dev_size:
521                         arg_p = match_strdup(&args[0]);
522                         if (!arg_p) {
523                                 ret = -ENOMEM;
524                                 break;
525                         }
526                         ret = strict_strtoull(arg_p, 0, &fd_dev->fd_dev_size);
527                         kfree(arg_p);
528                         if (ret < 0) {
529                                 pr_err("strict_strtoull() failed for"
530                                                 " fd_dev_size=\n");
531                                 goto out;
532                         }
533                         pr_debug("FILEIO: Referencing Size: %llu"
534                                         " bytes\n", fd_dev->fd_dev_size);
535                         fd_dev->fbd_flags |= FBDF_HAS_SIZE;
536                         break;
537                 case Opt_fd_buffered_io:
538                         match_int(args, &arg);
539                         if (arg != 1) {
540                                 pr_err("bogus fd_buffered_io=%d value\n", arg);
541                                 ret = -EINVAL;
542                                 goto out;
543                         }
544
545                         pr_debug("FILEIO: Using buffered I/O"
546                                 " operations for struct fd_dev\n");
547
548                         fd_dev->fbd_flags |= FDBD_USE_BUFFERED_IO;
549                         break;
550                 default:
551                         break;
552                 }
553         }
554
555 out:
556         kfree(orig);
557         return (!ret) ? count : ret;
558 }
559
560 static ssize_t fd_check_configfs_dev_params(struct se_hba *hba, struct se_subsystem_dev *se_dev)
561 {
562         struct fd_dev *fd_dev = (struct fd_dev *) se_dev->se_dev_su_ptr;
563
564         if (!(fd_dev->fbd_flags & FBDF_HAS_PATH)) {
565                 pr_err("Missing fd_dev_name=\n");
566                 return -EINVAL;
567         }
568
569         return 0;
570 }
571
572 static ssize_t fd_show_configfs_dev_params(
573         struct se_hba *hba,
574         struct se_subsystem_dev *se_dev,
575         char *b)
576 {
577         struct fd_dev *fd_dev = se_dev->se_dev_su_ptr;
578         ssize_t bl = 0;
579
580         bl = sprintf(b + bl, "TCM FILEIO ID: %u", fd_dev->fd_dev_id);
581         bl += sprintf(b + bl, "        File: %s  Size: %llu  Mode: %s\n",
582                 fd_dev->fd_dev_name, fd_dev->fd_dev_size,
583                 (fd_dev->fbd_flags & FDBD_USE_BUFFERED_IO) ?
584                 "Buffered" : "Synchronous");
585         return bl;
586 }
587
588 /*      fd_get_device_rev(): (Part of se_subsystem_api_t template)
589  *
590  *
591  */
592 static u32 fd_get_device_rev(struct se_device *dev)
593 {
594         return SCSI_SPC_2; /* Returns SPC-3 in Initiator Data */
595 }
596
597 /*      fd_get_device_type(): (Part of se_subsystem_api_t template)
598  *
599  *
600  */
601 static u32 fd_get_device_type(struct se_device *dev)
602 {
603         return TYPE_DISK;
604 }
605
606 static sector_t fd_get_blocks(struct se_device *dev)
607 {
608         struct fd_dev *fd_dev = dev->dev_ptr;
609         unsigned long long blocks_long = div_u64(fd_dev->fd_dev_size,
610                         dev->se_sub_dev->se_dev_attrib.block_size);
611
612         return blocks_long;
613 }
614
615 static struct se_subsystem_api fileio_template = {
616         .name                   = "fileio",
617         .owner                  = THIS_MODULE,
618         .transport_type         = TRANSPORT_PLUGIN_VHBA_PDEV,
619         .write_cache_emulated   = 1,
620         .fua_write_emulated     = 1,
621         .attach_hba             = fd_attach_hba,
622         .detach_hba             = fd_detach_hba,
623         .allocate_virtdevice    = fd_allocate_virtdevice,
624         .create_virtdevice      = fd_create_virtdevice,
625         .free_device            = fd_free_device,
626         .alloc_task             = fd_alloc_task,
627         .do_task                = fd_do_task,
628         .do_sync_cache          = fd_emulate_sync_cache,
629         .free_task              = fd_free_task,
630         .check_configfs_dev_params = fd_check_configfs_dev_params,
631         .set_configfs_dev_params = fd_set_configfs_dev_params,
632         .show_configfs_dev_params = fd_show_configfs_dev_params,
633         .get_device_rev         = fd_get_device_rev,
634         .get_device_type        = fd_get_device_type,
635         .get_blocks             = fd_get_blocks,
636 };
637
638 static int __init fileio_module_init(void)
639 {
640         return transport_subsystem_register(&fileio_template);
641 }
642
643 static void fileio_module_exit(void)
644 {
645         transport_subsystem_release(&fileio_template);
646 }
647
648 MODULE_DESCRIPTION("TCM FILEIO subsystem plugin");
649 MODULE_AUTHOR("nab@Linux-iSCSI.org");
650 MODULE_LICENSE("GPL");
651
652 module_init(fileio_module_init);
653 module_exit(fileio_module_exit);