]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - drivers/target/target_core_file.c
target: Subsume se_port + t10_alua_tg_pt_gp_member into se_lun
[mirror_ubuntu-artful-kernel.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>
70d3ae5c 33#include <linux/falloc.h>
c66ac9db
NB
34#include <scsi/scsi.h>
35#include <scsi/scsi_host.h>
50642762 36#include <asm/unaligned.h>
c66ac9db
NB
37
38#include <target/target_core_base.h>
c4795fb2 39#include <target/target_core_backend.h>
c66ac9db
NB
40
41#include "target_core_file.h"
42
0fd97ccf
CH
43static inline struct fd_dev *FD_DEV(struct se_device *dev)
44{
45 return container_of(dev, struct fd_dev, dev);
46}
c66ac9db 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
NB
63 " Target Core Stack %s\n", hba->hba_id, FD_VERSION,
64 TARGET_CORE_MOD_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);
70d3ae5c
AH
163 /*
164 * Check if the underlying struct block_device request_queue supports
165 * the QUEUE_FLAG_DISCARD bit for UNMAP/WRITE_SAME in SCSI + TRIM
166 * in ATA and we need to set TPE=1
167 */
168 if (blk_queue_discard(q)) {
169 dev->dev_attrib.max_unmap_lba_count =
170 q->limits.max_discard_sectors;
171 /*
172 * Currently hardcoded to 1 in Linux/SCSI code..
173 */
174 dev->dev_attrib.max_unmap_block_desc_count = 1;
175 dev->dev_attrib.unmap_granularity =
176 q->limits.discard_granularity >> 9;
177 dev->dev_attrib.unmap_granularity_alignment =
178 q->limits.discard_alignment;
179 pr_debug("IFILE: BLOCK Discard support available,"
180 " disabled by default\n");
181 }
182 /*
183 * Enable write same emulation for IBLOCK and use 0xFFFF as
184 * the smaller WRITE_SAME(10) only has a two-byte block count.
185 */
186 dev->dev_attrib.max_write_same_len = 0xFFFF;
0463a3fe
AH
187
188 if (blk_queue_nonrot(q))
189 dev->dev_attrib.is_nonrot = 1;
c66ac9db
NB
190 } else {
191 if (!(fd_dev->fbd_flags & FBDF_HAS_SIZE)) {
6708bb27 192 pr_err("FILEIO: Missing fd_dev_size="
c66ac9db
NB
193 " parameter, and no backing struct"
194 " block_device\n");
195 goto fail;
196 }
197
21363ca8 198 fd_dev->fd_block_size = FD_BLOCKSIZE;
70d3ae5c
AH
199 /*
200 * Limit UNMAP emulation to 8k Number of LBAs (NoLB)
201 */
202 dev->dev_attrib.max_unmap_lba_count = 0x2000;
203 /*
204 * Currently hardcoded to 1 in Linux/SCSI code..
205 */
206 dev->dev_attrib.max_unmap_block_desc_count = 1;
207 dev->dev_attrib.unmap_granularity = 1;
208 dev->dev_attrib.unmap_granularity_alignment = 0;
209
210 /*
211 * Limit WRITE_SAME w/ UNMAP=0 emulation to 8k Number of LBAs (NoLB)
212 * based upon struct iovec limit for vfs_writev()
213 */
214 dev->dev_attrib.max_write_same_len = 0x1000;
c66ac9db
NB
215 }
216
21363ca8 217 dev->dev_attrib.hw_block_size = fd_dev->fd_block_size;
95cadace
NB
218 dev->dev_attrib.max_bytes_per_io = FD_MAX_BYTES;
219 dev->dev_attrib.hw_max_sectors = FD_MAX_BYTES / fd_dev->fd_block_size;
0fd97ccf 220 dev->dev_attrib.hw_queue_depth = FD_MAX_DEVICE_QUEUE_DEPTH;
c66ac9db 221
b32f4c7e
NB
222 if (fd_dev->fbd_flags & FDBD_HAS_BUFFERED_IO_WCE) {
223 pr_debug("FILEIO: Forcing setting of emulate_write_cache=1"
224 " with FDBD_HAS_BUFFERED_IO_WCE\n");
0fd97ccf 225 dev->dev_attrib.emulate_write_cache = 1;
b32f4c7e
NB
226 }
227
c66ac9db
NB
228 fd_dev->fd_dev_id = fd_host->fd_host_dev_id_count++;
229 fd_dev->fd_queue_depth = dev->queue_depth;
230
6708bb27 231 pr_debug("CORE_FILE[%u] - Added TCM FILEIO Device ID: %u at %s,"
c66ac9db
NB
232 " %llu total bytes\n", fd_host->fd_host_id, fd_dev->fd_dev_id,
233 fd_dev->fd_dev_name, fd_dev->fd_dev_size);
234
0fd97ccf 235 return 0;
c66ac9db
NB
236fail:
237 if (fd_dev->fd_file) {
238 filp_close(fd_dev->fd_file, NULL);
239 fd_dev->fd_file = NULL;
240 }
0fd97ccf 241 return ret;
c66ac9db
NB
242}
243
0fd97ccf 244static void fd_free_device(struct se_device *dev)
c66ac9db 245{
0fd97ccf 246 struct fd_dev *fd_dev = FD_DEV(dev);
c66ac9db
NB
247
248 if (fd_dev->fd_file) {
249 filp_close(fd_dev->fd_file, NULL);
250 fd_dev->fd_file = NULL;
251 }
252
253 kfree(fd_dev);
254}
255
8287fa5f
SG
256static int fd_do_rw(struct se_cmd *cmd, struct file *fd,
257 u32 block_size, struct scatterlist *sgl,
258 u32 sgl_nents, u32 data_length, int is_write)
42201b55 259{
5787cacd 260 struct scatterlist *sg;
6b9a44d0
CH
261 struct iov_iter iter;
262 struct bio_vec *bvec;
263 ssize_t len = 0;
8287fa5f 264 loff_t pos = (cmd->t_task_lba * block_size);
c66ac9db
NB
265 int ret = 0, i;
266
6b9a44d0
CH
267 bvec = kcalloc(sgl_nents, sizeof(struct bio_vec), GFP_KERNEL);
268 if (!bvec) {
6708bb27 269 pr_err("Unable to allocate fd_do_readv iov[]\n");
e3d6f909 270 return -ENOMEM;
c66ac9db
NB
271 }
272
5787cacd 273 for_each_sg(sgl, sg, sgl_nents, i) {
6b9a44d0
CH
274 bvec[i].bv_page = sg_page(sg);
275 bvec[i].bv_len = sg->length;
276 bvec[i].bv_offset = sg->offset;
c66ac9db 277
6b9a44d0
CH
278 len += sg->length;
279 }
778229af 280
6b9a44d0 281 iov_iter_bvec(&iter, ITER_BVEC, bvec, sgl_nents, len);
778229af 282 if (is_write)
6b9a44d0 283 ret = vfs_iter_write(fd, &iter, &pos);
778229af 284 else
6b9a44d0 285 ret = vfs_iter_read(fd, &iter, &pos);
778229af 286
6b9a44d0 287 kfree(bvec);
778229af
SAS
288
289 if (is_write) {
8287fa5f 290 if (ret < 0 || ret != data_length) {
778229af 291 pr_err("%s() write returned %d\n", __func__, ret);
e3d6f909 292 return (ret < 0 ? ret : -EINVAL);
c66ac9db
NB
293 }
294 } else {
778229af
SAS
295 /*
296 * Return zeros and GOOD status even if the READ did not return
297 * the expected virt_size for struct file w/o a backing struct
298 * block_device.
299 */
496ad9aa 300 if (S_ISBLK(file_inode(fd)->i_mode)) {
8287fa5f 301 if (ret < 0 || ret != data_length) {
778229af
SAS
302 pr_err("%s() returned %d, expecting %u for "
303 "S_ISBLK\n", __func__, ret,
8287fa5f 304 data_length);
778229af
SAS
305 return (ret < 0 ? ret : -EINVAL);
306 }
307 } else {
308 if (ret < 0) {
309 pr_err("%s() returned %d for non S_ISBLK\n",
310 __func__, ret);
311 return ret;
312 }
c66ac9db
NB
313 }
314 }
c66ac9db
NB
315 return 1;
316}
317
de103c93
CH
318static sense_reason_t
319fd_execute_sync_cache(struct se_cmd *cmd)
c66ac9db 320{
c66ac9db 321 struct se_device *dev = cmd->se_dev;
0fd97ccf 322 struct fd_dev *fd_dev = FD_DEV(dev);
a1d8b49a 323 int immed = (cmd->t_task_cdb[1] & 0x2);
c66ac9db
NB
324 loff_t start, end;
325 int ret;
326
327 /*
328 * If the Immediate bit is set, queue up the GOOD response
329 * for this SYNCHRONIZE_CACHE op
330 */
331 if (immed)
5787cacd 332 target_complete_cmd(cmd, SAM_STAT_GOOD);
c66ac9db
NB
333
334 /*
335 * Determine if we will be flushing the entire device.
336 */
a1d8b49a 337 if (cmd->t_task_lba == 0 && cmd->data_length == 0) {
c66ac9db
NB
338 start = 0;
339 end = LLONG_MAX;
340 } else {
0fd97ccf 341 start = cmd->t_task_lba * dev->dev_attrib.block_size;
c66ac9db 342 if (cmd->data_length)
62d3ab49 343 end = start + cmd->data_length - 1;
c66ac9db
NB
344 else
345 end = LLONG_MAX;
346 }
347
348 ret = vfs_fsync_range(fd_dev->fd_file, start, end, 1);
349 if (ret != 0)
6708bb27 350 pr_err("FILEIO: vfs_fsync_range() failed: %d\n", ret);
c66ac9db 351
5787cacd 352 if (immed)
ad67f0d9 353 return 0;
5787cacd 354
de103c93 355 if (ret)
5787cacd 356 target_complete_cmd(cmd, SAM_STAT_CHECK_CONDITION);
de103c93 357 else
5787cacd 358 target_complete_cmd(cmd, SAM_STAT_GOOD);
ad67f0d9
CH
359
360 return 0;
c66ac9db
NB
361}
362
7b745c84
NB
363static sense_reason_t
364fd_execute_write_same(struct se_cmd *cmd)
365{
366 struct se_device *se_dev = cmd->se_dev;
367 struct fd_dev *fd_dev = FD_DEV(se_dev);
7b745c84 368 loff_t pos = cmd->t_task_lba * se_dev->dev_attrib.block_size;
d4c5dcac
CH
369 sector_t nolb = sbc_get_write_same_sectors(cmd);
370 struct iov_iter iter;
371 struct bio_vec *bvec;
372 unsigned int len = 0, i;
373 ssize_t ret;
7b745c84
NB
374
375 if (!nolb) {
376 target_complete_cmd(cmd, SAM_STAT_GOOD);
377 return 0;
378 }
afd73f1b
NB
379 if (cmd->prot_op) {
380 pr_err("WRITE_SAME: Protection information with FILEIO"
381 " backends not supported\n");
382 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
383 }
7b745c84
NB
384
385 if (cmd->t_data_nents > 1 ||
d4c5dcac 386 cmd->t_data_sg[0].length != cmd->se_dev->dev_attrib.block_size) {
7b745c84 387 pr_err("WRITE_SAME: Illegal SGL t_data_nents: %u length: %u"
d4c5dcac
CH
388 " block_size: %u\n",
389 cmd->t_data_nents,
390 cmd->t_data_sg[0].length,
7b745c84
NB
391 cmd->se_dev->dev_attrib.block_size);
392 return TCM_INVALID_CDB_FIELD;
393 }
394
d4c5dcac
CH
395 bvec = kcalloc(nolb, sizeof(struct bio_vec), GFP_KERNEL);
396 if (!bvec)
7b745c84
NB
397 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
398
d4c5dcac
CH
399 for (i = 0; i < nolb; i++) {
400 bvec[i].bv_page = sg_page(&cmd->t_data_sg[0]);
401 bvec[i].bv_len = cmd->t_data_sg[0].length;
402 bvec[i].bv_offset = cmd->t_data_sg[0].offset;
7b745c84 403
d4c5dcac
CH
404 len += se_dev->dev_attrib.block_size;
405 }
7b745c84 406
d4c5dcac
CH
407 iov_iter_bvec(&iter, ITER_BVEC, bvec, nolb, len);
408 ret = vfs_iter_write(fd_dev->fd_file, &iter, &pos);
7b745c84 409
d4c5dcac
CH
410 kfree(bvec);
411 if (ret < 0 || ret != len) {
412 pr_err("vfs_iter_write() returned %zd for write same\n", ret);
7b745c84
NB
413 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
414 }
415
416 target_complete_cmd(cmd, SAM_STAT_GOOD);
417 return 0;
418}
419
64d240b7
AM
420static int
421fd_do_prot_fill(struct se_device *se_dev, sector_t lba, sector_t nolb,
422 void *buf, size_t bufsize)
423{
424 struct fd_dev *fd_dev = FD_DEV(se_dev);
425 struct file *prot_fd = fd_dev->fd_prot_file;
426 sector_t prot_length, prot;
427 loff_t pos = lba * se_dev->prot_length;
428
429 if (!prot_fd) {
430 pr_err("Unable to locate fd_dev->fd_prot_file\n");
431 return -ENODEV;
432 }
433
434 prot_length = nolb * se_dev->prot_length;
435
436 for (prot = 0; prot < prot_length;) {
437 sector_t len = min_t(sector_t, bufsize, prot_length - prot);
438 ssize_t ret = kernel_write(prot_fd, buf, len, pos + prot);
439
440 if (ret != len) {
441 pr_err("vfs_write to prot file failed: %zd\n", ret);
442 return ret < 0 ? ret : -ENODEV;
443 }
444 prot += ret;
445 }
446
447 return 0;
448}
449
450static int
451fd_do_prot_unmap(struct se_cmd *cmd, sector_t lba, sector_t nolb)
452{
453 void *buf;
454 int rc;
455
456 buf = (void *)__get_free_page(GFP_KERNEL);
457 if (!buf) {
458 pr_err("Unable to allocate FILEIO prot buf\n");
459 return -ENOMEM;
460 }
461 memset(buf, 0xff, PAGE_SIZE);
462
463 rc = fd_do_prot_fill(cmd->se_dev, lba, nolb, buf, PAGE_SIZE);
464
465 free_page((unsigned long)buf);
466
467 return rc;
468}
469
70d3ae5c 470static sense_reason_t
86d71829 471fd_do_unmap(struct se_cmd *cmd, void *priv, sector_t lba, sector_t nolb)
70d3ae5c 472{
86d71829 473 struct file *file = priv;
70d3ae5c 474 struct inode *inode = file->f_mapping->host;
70d3ae5c
AH
475 int ret;
476
64d240b7
AM
477 if (cmd->se_dev->dev_attrib.pi_prot_type) {
478 ret = fd_do_prot_unmap(cmd, lba, nolb);
479 if (ret)
480 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
481 }
482
70d3ae5c
AH
483 if (S_ISBLK(inode->i_mode)) {
484 /* The backend is block device, use discard */
485 struct block_device *bdev = inode->i_bdev;
486
43f55bbb 487 ret = blkdev_issue_discard(bdev, lba,
70d3ae5c
AH
488 nolb, GFP_KERNEL, 0);
489 if (ret < 0) {
490 pr_warn("FILEIO: blkdev_issue_discard() failed: %d\n",
491 ret);
492 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
493 }
494 } else {
495 /* The backend is normal file, use fallocate */
43f55bbb
AH
496 struct se_device *se_dev = cmd->se_dev;
497 loff_t pos = lba * se_dev->dev_attrib.block_size;
70d3ae5c
AH
498 unsigned int len = nolb * se_dev->dev_attrib.block_size;
499 int mode = FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE;
500
501 if (!file->f_op->fallocate)
502 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
503
504 ret = file->f_op->fallocate(file, mode, pos, len);
505 if (ret < 0) {
506 pr_warn("FILEIO: fallocate() failed: %d\n", ret);
507 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
508 }
509 }
510
43f55bbb
AH
511 return 0;
512}
513
514static sense_reason_t
515fd_execute_write_same_unmap(struct se_cmd *cmd)
516{
517 struct se_device *se_dev = cmd->se_dev;
518 struct fd_dev *fd_dev = FD_DEV(se_dev);
519 struct file *file = fd_dev->fd_file;
520 sector_t lba = cmd->t_task_lba;
521 sector_t nolb = sbc_get_write_same_sectors(cmd);
3abff1e5 522 sense_reason_t ret;
43f55bbb
AH
523
524 if (!nolb) {
525 target_complete_cmd(cmd, SAM_STAT_GOOD);
526 return 0;
527 }
528
529 ret = fd_do_unmap(cmd, file, lba, nolb);
530 if (ret)
531 return ret;
532
70d3ae5c
AH
533 target_complete_cmd(cmd, GOOD);
534 return 0;
535}
536
50642762
AH
537static sense_reason_t
538fd_execute_unmap(struct se_cmd *cmd)
539{
86d71829 540 struct file *file = FD_DEV(cmd->se_dev)->fd_file;
50642762 541
86d71829 542 return sbc_execute_unmap(cmd, fd_do_unmap, file);
50642762
AH
543}
544
de103c93 545static sense_reason_t
a82a9538
NB
546fd_execute_rw(struct se_cmd *cmd, struct scatterlist *sgl, u32 sgl_nents,
547 enum dma_data_direction data_direction)
c66ac9db 548{
c66ac9db 549 struct se_device *dev = cmd->se_dev;
8287fa5f
SG
550 struct fd_dev *fd_dev = FD_DEV(dev);
551 struct file *file = fd_dev->fd_file;
552 struct file *pfile = fd_dev->fd_prot_file;
42201b55 553 sense_reason_t rc;
c66ac9db 554 int ret = 0;
046ba642
NB
555 /*
556 * We are currently limited by the number of iovecs (2048) per
557 * single vfs_[writev,readv] call.
558 */
559 if (cmd->data_length > FD_MAX_BYTES) {
560 pr_err("FILEIO: Not able to process I/O of %u bytes due to"
561 "FD_MAX_BYTES: %u iovec count limitiation\n",
562 cmd->data_length, FD_MAX_BYTES);
563 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
564 }
c66ac9db
NB
565 /*
566 * Call vectorized fileio functions to map struct scatterlist
567 * physical memory addresses to struct iovec virtual memory.
568 */
5787cacd 569 if (data_direction == DMA_FROM_DEVICE) {
ee920469 570 if (cmd->prot_type && dev->dev_attrib.pi_prot_type) {
8287fa5f
SG
571 ret = fd_do_rw(cmd, pfile, dev->prot_length,
572 cmd->t_prot_sg, cmd->t_prot_nents,
573 cmd->prot_length, 0);
42201b55
NB
574 if (ret < 0)
575 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
576 }
577
8287fa5f
SG
578 ret = fd_do_rw(cmd, file, dev->dev_attrib.block_size,
579 sgl, sgl_nents, cmd->data_length, 0);
42201b55 580
ee920469 581 if (ret > 0 && cmd->prot_type && dev->dev_attrib.pi_prot_type) {
8287fa5f
SG
582 u32 sectors = cmd->data_length >>
583 ilog2(dev->dev_attrib.block_size);
42201b55 584
f75b6fae 585 rc = sbc_dif_verify(cmd, cmd->t_task_lba, sectors,
8287fa5f
SG
586 0, cmd->t_prot_sg, 0);
587 if (rc)
42201b55 588 return rc;
42201b55 589 }
c66ac9db 590 } else {
ee920469 591 if (cmd->prot_type && dev->dev_attrib.pi_prot_type) {
8287fa5f
SG
592 u32 sectors = cmd->data_length >>
593 ilog2(dev->dev_attrib.block_size);
42201b55 594
f75b6fae
SG
595 rc = sbc_dif_verify(cmd, cmd->t_task_lba, sectors,
596 0, cmd->t_prot_sg, 0);
8287fa5f 597 if (rc)
42201b55 598 return rc;
42201b55
NB
599 }
600
8287fa5f
SG
601 ret = fd_do_rw(cmd, file, dev->dev_attrib.block_size,
602 sgl, sgl_nents, cmd->data_length, 1);
a4dff304 603 /*
125d0119 604 * Perform implicit vfs_fsync_range() for fd_do_writev() ops
a4dff304
NB
605 * for SCSI WRITEs with Forced Unit Access (FUA) set.
606 * Allow this to happen independent of WCE=0 setting.
607 */
814e5b45 608 if (ret > 0 && (cmd->se_cmd_flags & SCF_FUA)) {
a4dff304 609 loff_t start = cmd->t_task_lba *
0fd97ccf 610 dev->dev_attrib.block_size;
62d3ab49
ZB
611 loff_t end;
612
613 if (cmd->data_length)
614 end = start + cmd->data_length - 1;
615 else
616 end = LLONG_MAX;
c66ac9db 617
a4dff304
NB
618 vfs_fsync_range(fd_dev->fd_file, start, end, 1);
619 }
42201b55 620
ee920469 621 if (ret > 0 && cmd->prot_type && dev->dev_attrib.pi_prot_type) {
8287fa5f
SG
622 ret = fd_do_rw(cmd, pfile, dev->prot_length,
623 cmd->t_prot_sg, cmd->t_prot_nents,
624 cmd->prot_length, 1);
42201b55
NB
625 if (ret < 0)
626 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
627 }
c66ac9db
NB
628 }
629
8287fa5f 630 if (ret < 0)
de103c93
CH
631 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
632
5787cacd
CH
633 if (ret)
634 target_complete_cmd(cmd, SAM_STAT_GOOD);
03e98c9e 635 return 0;
c66ac9db
NB
636}
637
c66ac9db
NB
638enum {
639 Opt_fd_dev_name, Opt_fd_dev_size, Opt_fd_buffered_io, Opt_err
640};
641
642static match_table_t tokens = {
643 {Opt_fd_dev_name, "fd_dev_name=%s"},
644 {Opt_fd_dev_size, "fd_dev_size=%s"},
b32f4c7e 645 {Opt_fd_buffered_io, "fd_buffered_io=%d"},
c66ac9db
NB
646 {Opt_err, NULL}
647};
648
0fd97ccf
CH
649static ssize_t fd_set_configfs_dev_params(struct se_device *dev,
650 const char *page, ssize_t count)
c66ac9db 651{
0fd97ccf 652 struct fd_dev *fd_dev = FD_DEV(dev);
c66ac9db
NB
653 char *orig, *ptr, *arg_p, *opts;
654 substring_t args[MAX_OPT_ARGS];
b32f4c7e 655 int ret = 0, arg, token;
c66ac9db
NB
656
657 opts = kstrdup(page, GFP_KERNEL);
658 if (!opts)
659 return -ENOMEM;
660
661 orig = opts;
662
90c161b6 663 while ((ptr = strsep(&opts, ",\n")) != NULL) {
c66ac9db
NB
664 if (!*ptr)
665 continue;
666
667 token = match_token(ptr, tokens, args);
668 switch (token) {
669 case Opt_fd_dev_name:
dbc6e022
AV
670 if (match_strlcpy(fd_dev->fd_dev_name, &args[0],
671 FD_MAX_DEV_NAME) == 0) {
672 ret = -EINVAL;
6d180253
JJ
673 break;
674 }
6708bb27 675 pr_debug("FILEIO: Referencing Path: %s\n",
c66ac9db
NB
676 fd_dev->fd_dev_name);
677 fd_dev->fbd_flags |= FBDF_HAS_PATH;
678 break;
679 case Opt_fd_dev_size:
680 arg_p = match_strdup(&args[0]);
6d180253
JJ
681 if (!arg_p) {
682 ret = -ENOMEM;
683 break;
684 }
57103d7f 685 ret = kstrtoull(arg_p, 0, &fd_dev->fd_dev_size);
6d180253 686 kfree(arg_p);
c66ac9db 687 if (ret < 0) {
57103d7f 688 pr_err("kstrtoull() failed for"
c66ac9db
NB
689 " fd_dev_size=\n");
690 goto out;
691 }
6708bb27 692 pr_debug("FILEIO: Referencing Size: %llu"
c66ac9db
NB
693 " bytes\n", fd_dev->fd_dev_size);
694 fd_dev->fbd_flags |= FBDF_HAS_SIZE;
695 break;
b32f4c7e 696 case Opt_fd_buffered_io:
ce31c1b0
JE
697 ret = match_int(args, &arg);
698 if (ret)
699 goto out;
b32f4c7e
NB
700 if (arg != 1) {
701 pr_err("bogus fd_buffered_io=%d value\n", arg);
702 ret = -EINVAL;
703 goto out;
704 }
705
706 pr_debug("FILEIO: Using buffered I/O"
707 " operations for struct fd_dev\n");
708
709 fd_dev->fbd_flags |= FDBD_HAS_BUFFERED_IO_WCE;
710 break;
c66ac9db
NB
711 default:
712 break;
713 }
714 }
715
716out:
717 kfree(orig);
718 return (!ret) ? count : ret;
719}
720
0fd97ccf 721static ssize_t fd_show_configfs_dev_params(struct se_device *dev, char *b)
c66ac9db 722{
0fd97ccf 723 struct fd_dev *fd_dev = FD_DEV(dev);
c66ac9db
NB
724 ssize_t bl = 0;
725
726 bl = sprintf(b + bl, "TCM FILEIO ID: %u", fd_dev->fd_dev_id);
b32f4c7e
NB
727 bl += sprintf(b + bl, " File: %s Size: %llu Mode: %s\n",
728 fd_dev->fd_dev_name, fd_dev->fd_dev_size,
729 (fd_dev->fbd_flags & FDBD_HAS_BUFFERED_IO_WCE) ?
730 "Buffered-WCE" : "O_DSYNC");
c66ac9db
NB
731 return bl;
732}
733
c66ac9db
NB
734static sector_t fd_get_blocks(struct se_device *dev)
735{
0fd97ccf 736 struct fd_dev *fd_dev = FD_DEV(dev);
cd9323fd
NB
737 struct file *f = fd_dev->fd_file;
738 struct inode *i = f->f_mapping->host;
739 unsigned long long dev_size;
740 /*
741 * When using a file that references an underlying struct block_device,
742 * ensure dev_size is always based on the current inode size in order
743 * to handle underlying block_device resize operations.
744 */
745 if (S_ISBLK(i->i_mode))
21363ca8 746 dev_size = i_size_read(i);
cd9323fd
NB
747 else
748 dev_size = fd_dev->fd_dev_size;
c66ac9db 749
21363ca8
NB
750 return div_u64(dev_size - dev->dev_attrib.block_size,
751 dev->dev_attrib.block_size);
c66ac9db
NB
752}
753
0f5e2ec4
NB
754static int fd_init_prot(struct se_device *dev)
755{
756 struct fd_dev *fd_dev = FD_DEV(dev);
757 struct file *prot_file, *file = fd_dev->fd_file;
758 struct inode *inode;
759 int ret, flags = O_RDWR | O_CREAT | O_LARGEFILE | O_DSYNC;
760 char buf[FD_MAX_DEV_PROT_NAME];
761
762 if (!file) {
763 pr_err("Unable to locate fd_dev->fd_file\n");
764 return -ENODEV;
765 }
766
767 inode = file->f_mapping->host;
768 if (S_ISBLK(inode->i_mode)) {
769 pr_err("FILEIO Protection emulation only supported on"
770 " !S_ISBLK\n");
771 return -ENOSYS;
772 }
773
774 if (fd_dev->fbd_flags & FDBD_HAS_BUFFERED_IO_WCE)
775 flags &= ~O_DSYNC;
776
777 snprintf(buf, FD_MAX_DEV_PROT_NAME, "%s.protection",
778 fd_dev->fd_dev_name);
779
780 prot_file = filp_open(buf, flags, 0600);
781 if (IS_ERR(prot_file)) {
782 pr_err("filp_open(%s) failed\n", buf);
783 ret = PTR_ERR(prot_file);
784 return ret;
785 }
786 fd_dev->fd_prot_file = prot_file;
787
788 return 0;
789}
790
0f5e2ec4
NB
791static int fd_format_prot(struct se_device *dev)
792{
0f5e2ec4 793 unsigned char *buf;
0f5e2ec4 794 int unit_size = FDBD_FORMAT_UNIT_SIZE * dev->dev_attrib.block_size;
64d240b7 795 int ret;
0f5e2ec4
NB
796
797 if (!dev->dev_attrib.pi_prot_type) {
798 pr_err("Unable to format_prot while pi_prot_type == 0\n");
799 return -ENODEV;
800 }
0f5e2ec4 801
0f5e2ec4
NB
802 buf = vzalloc(unit_size);
803 if (!buf) {
804 pr_err("Unable to allocate FILEIO prot buf\n");
805 return -ENOMEM;
806 }
0f5e2ec4
NB
807
808 pr_debug("Using FILEIO prot_length: %llu\n",
64d240b7
AM
809 (unsigned long long)(dev->transport->get_blocks(dev) + 1) *
810 dev->prot_length);
0f5e2ec4 811
80dcd0c1 812 memset(buf, 0xff, unit_size);
64d240b7
AM
813 ret = fd_do_prot_fill(dev, 0, dev->transport->get_blocks(dev) + 1,
814 buf, unit_size);
0f5e2ec4
NB
815 vfree(buf);
816 return ret;
817}
818
819static void fd_free_prot(struct se_device *dev)
820{
821 struct fd_dev *fd_dev = FD_DEV(dev);
822
823 if (!fd_dev->fd_prot_file)
824 return;
825
826 filp_close(fd_dev->fd_prot_file, NULL);
827 fd_dev->fd_prot_file = NULL;
828}
829
9e999a6c 830static struct sbc_ops fd_sbc_ops = {
0c2ad7d1 831 .execute_rw = fd_execute_rw,
ad67f0d9 832 .execute_sync_cache = fd_execute_sync_cache,
7b745c84 833 .execute_write_same = fd_execute_write_same,
70d3ae5c 834 .execute_write_same_unmap = fd_execute_write_same_unmap,
50642762 835 .execute_unmap = fd_execute_unmap,
0c2ad7d1
CH
836};
837
de103c93
CH
838static sense_reason_t
839fd_parse_cdb(struct se_cmd *cmd)
0c2ad7d1 840{
9e999a6c 841 return sbc_parse_cdb(cmd, &fd_sbc_ops);
0c2ad7d1
CH
842}
843
0a06d430 844static const struct target_backend_ops fileio_ops = {
c66ac9db 845 .name = "fileio",
0fd97ccf
CH
846 .inquiry_prod = "FILEIO",
847 .inquiry_rev = FD_VERSION,
c66ac9db 848 .owner = THIS_MODULE,
c66ac9db
NB
849 .attach_hba = fd_attach_hba,
850 .detach_hba = fd_detach_hba,
0fd97ccf
CH
851 .alloc_device = fd_alloc_device,
852 .configure_device = fd_configure_device,
c66ac9db 853 .free_device = fd_free_device,
0c2ad7d1 854 .parse_cdb = fd_parse_cdb,
c66ac9db
NB
855 .set_configfs_dev_params = fd_set_configfs_dev_params,
856 .show_configfs_dev_params = fd_show_configfs_dev_params,
6f23ac8a 857 .get_device_type = sbc_get_device_type,
c66ac9db 858 .get_blocks = fd_get_blocks,
0f5e2ec4
NB
859 .init_prot = fd_init_prot,
860 .format_prot = fd_format_prot,
861 .free_prot = fd_free_prot,
5873c4d1 862 .tb_dev_attrib_attrs = sbc_attrib_attrs,
c66ac9db
NB
863};
864
865static int __init fileio_module_init(void)
866{
0a06d430 867 return transport_backend_register(&fileio_ops);
c66ac9db
NB
868}
869
63b91d5a 870static void __exit fileio_module_exit(void)
c66ac9db 871{
0a06d430 872 target_backend_unregister(&fileio_ops);
c66ac9db
NB
873}
874
875MODULE_DESCRIPTION("TCM FILEIO subsystem plugin");
876MODULE_AUTHOR("nab@Linux-iSCSI.org");
877MODULE_LICENSE("GPL");
878
879module_init(fileio_module_init);
880module_exit(fileio_module_exit);