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