Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/jikos/livep...
[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>
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>
b2320497 40#include <target/target_core_backend_configfs.h>
c66ac9db
NB
41
42#include "target_core_file.h"
43
0fd97ccf
CH
44static inline struct fd_dev *FD_DEV(struct se_device *dev)
45{
46 return container_of(dev, struct fd_dev, dev);
47}
c66ac9db
NB
48
49/* fd_attach_hba(): (Part of se_subsystem_api_t template)
50 *
51 *
52 */
53static int fd_attach_hba(struct se_hba *hba, u32 host_id)
54{
55 struct fd_host *fd_host;
56
57 fd_host = kzalloc(sizeof(struct fd_host), GFP_KERNEL);
6708bb27
AG
58 if (!fd_host) {
59 pr_err("Unable to allocate memory for struct fd_host\n");
e3d6f909 60 return -ENOMEM;
c66ac9db
NB
61 }
62
63 fd_host->fd_host_id = host_id;
64
e3d6f909 65 hba->hba_ptr = fd_host;
c66ac9db 66
6708bb27 67 pr_debug("CORE_HBA[%d] - TCM FILEIO HBA Driver %s on Generic"
c66ac9db
NB
68 " Target Core Stack %s\n", hba->hba_id, FD_VERSION,
69 TARGET_CORE_MOD_VERSION);
95cadace
NB
70 pr_debug("CORE_HBA[%d] - Attached FILEIO HBA: %u to Generic\n",
71 hba->hba_id, fd_host->fd_host_id);
c66ac9db
NB
72
73 return 0;
74}
75
76static void fd_detach_hba(struct se_hba *hba)
77{
78 struct fd_host *fd_host = hba->hba_ptr;
79
6708bb27 80 pr_debug("CORE_HBA[%d] - Detached FILEIO HBA: %u from Generic"
c66ac9db
NB
81 " Target Core\n", hba->hba_id, fd_host->fd_host_id);
82
83 kfree(fd_host);
84 hba->hba_ptr = NULL;
85}
86
0fd97ccf 87static struct se_device *fd_alloc_device(struct se_hba *hba, const char *name)
c66ac9db
NB
88{
89 struct fd_dev *fd_dev;
8359cf43 90 struct fd_host *fd_host = hba->hba_ptr;
c66ac9db
NB
91
92 fd_dev = kzalloc(sizeof(struct fd_dev), GFP_KERNEL);
6708bb27
AG
93 if (!fd_dev) {
94 pr_err("Unable to allocate memory for struct fd_dev\n");
c66ac9db
NB
95 return NULL;
96 }
97
98 fd_dev->fd_host = fd_host;
99
6708bb27 100 pr_debug("FILEIO: Allocated fd_dev for %p\n", name);
c66ac9db 101
0fd97ccf 102 return &fd_dev->dev;
c66ac9db
NB
103}
104
0fd97ccf 105static int fd_configure_device(struct se_device *dev)
c66ac9db 106{
0fd97ccf
CH
107 struct fd_dev *fd_dev = FD_DEV(dev);
108 struct fd_host *fd_host = dev->se_hba->hba_ptr;
c66ac9db
NB
109 struct file *file;
110 struct inode *inode = NULL;
0fd97ccf 111 int flags, ret = -EINVAL;
c66ac9db 112
0fd97ccf
CH
113 if (!(fd_dev->fbd_flags & FBDF_HAS_PATH)) {
114 pr_err("Missing fd_dev_name=\n");
115 return -EINVAL;
116 }
c66ac9db 117
c66ac9db 118 /*
a4dff304
NB
119 * Use O_DSYNC by default instead of O_SYNC to forgo syncing
120 * of pure timestamp updates.
c66ac9db 121 */
a4dff304 122 flags = O_RDWR | O_CREAT | O_LARGEFILE | O_DSYNC;
0fd97ccf 123
b32f4c7e
NB
124 /*
125 * Optionally allow fd_buffered_io=1 to be enabled for people
126 * who want use the fs buffer cache as an WriteCache mechanism.
127 *
128 * This means that in event of a hard failure, there is a risk
129 * of silent data-loss if the SCSI client has *not* performed a
130 * forced unit access (FUA) write, or issued SYNCHRONIZE_CACHE
131 * to write-out the entire device cache.
132 */
133 if (fd_dev->fbd_flags & FDBD_HAS_BUFFERED_IO_WCE) {
134 pr_debug("FILEIO: Disabling O_DSYNC, using buffered FILEIO\n");
135 flags &= ~O_DSYNC;
136 }
c66ac9db 137
dbc6e022 138 file = filp_open(fd_dev->fd_dev_name, flags, 0600);
613640e4 139 if (IS_ERR(file)) {
dbc6e022 140 pr_err("filp_open(%s) failed\n", fd_dev->fd_dev_name);
613640e4
NB
141 ret = PTR_ERR(file);
142 goto fail;
143 }
c66ac9db
NB
144 fd_dev->fd_file = file;
145 /*
146 * If using a block backend with this struct file, we extract
147 * fd_dev->fd_[block,dev]_size from struct block_device.
148 *
149 * Otherwise, we use the passed fd_size= from configfs
150 */
151 inode = file->f_mapping->host;
152 if (S_ISBLK(inode->i_mode)) {
0fd97ccf 153 struct request_queue *q = bdev_get_queue(inode->i_bdev);
cd9323fd 154 unsigned long long dev_size;
0fd97ccf 155
21363ca8 156 fd_dev->fd_block_size = bdev_logical_block_size(inode->i_bdev);
c66ac9db
NB
157 /*
158 * Determine the number of bytes from i_size_read() minus
159 * one (1) logical sector from underlying struct block_device
160 */
cd9323fd 161 dev_size = (i_size_read(file->f_mapping->host) -
c66ac9db
NB
162 fd_dev->fd_block_size);
163
6708bb27 164 pr_debug("FILEIO: Using size: %llu bytes from struct"
c66ac9db 165 " block_device blocks: %llu logical_block_size: %d\n",
cd9323fd 166 dev_size, div_u64(dev_size, fd_dev->fd_block_size),
c66ac9db 167 fd_dev->fd_block_size);
70d3ae5c
AH
168 /*
169 * Check if the underlying struct block_device request_queue supports
170 * the QUEUE_FLAG_DISCARD bit for UNMAP/WRITE_SAME in SCSI + TRIM
171 * in ATA and we need to set TPE=1
172 */
173 if (blk_queue_discard(q)) {
174 dev->dev_attrib.max_unmap_lba_count =
175 q->limits.max_discard_sectors;
176 /*
177 * Currently hardcoded to 1 in Linux/SCSI code..
178 */
179 dev->dev_attrib.max_unmap_block_desc_count = 1;
180 dev->dev_attrib.unmap_granularity =
181 q->limits.discard_granularity >> 9;
182 dev->dev_attrib.unmap_granularity_alignment =
183 q->limits.discard_alignment;
184 pr_debug("IFILE: BLOCK Discard support available,"
185 " disabled by default\n");
186 }
187 /*
188 * Enable write same emulation for IBLOCK and use 0xFFFF as
189 * the smaller WRITE_SAME(10) only has a two-byte block count.
190 */
191 dev->dev_attrib.max_write_same_len = 0xFFFF;
0463a3fe
AH
192
193 if (blk_queue_nonrot(q))
194 dev->dev_attrib.is_nonrot = 1;
c66ac9db
NB
195 } else {
196 if (!(fd_dev->fbd_flags & FBDF_HAS_SIZE)) {
6708bb27 197 pr_err("FILEIO: Missing fd_dev_size="
c66ac9db
NB
198 " parameter, and no backing struct"
199 " block_device\n");
200 goto fail;
201 }
202
21363ca8 203 fd_dev->fd_block_size = FD_BLOCKSIZE;
70d3ae5c
AH
204 /*
205 * Limit UNMAP emulation to 8k Number of LBAs (NoLB)
206 */
207 dev->dev_attrib.max_unmap_lba_count = 0x2000;
208 /*
209 * Currently hardcoded to 1 in Linux/SCSI code..
210 */
211 dev->dev_attrib.max_unmap_block_desc_count = 1;
212 dev->dev_attrib.unmap_granularity = 1;
213 dev->dev_attrib.unmap_granularity_alignment = 0;
214
215 /*
216 * Limit WRITE_SAME w/ UNMAP=0 emulation to 8k Number of LBAs (NoLB)
217 * based upon struct iovec limit for vfs_writev()
218 */
219 dev->dev_attrib.max_write_same_len = 0x1000;
c66ac9db
NB
220 }
221
21363ca8 222 dev->dev_attrib.hw_block_size = fd_dev->fd_block_size;
95cadace
NB
223 dev->dev_attrib.max_bytes_per_io = FD_MAX_BYTES;
224 dev->dev_attrib.hw_max_sectors = FD_MAX_BYTES / fd_dev->fd_block_size;
0fd97ccf 225 dev->dev_attrib.hw_queue_depth = FD_MAX_DEVICE_QUEUE_DEPTH;
c66ac9db 226
b32f4c7e
NB
227 if (fd_dev->fbd_flags & FDBD_HAS_BUFFERED_IO_WCE) {
228 pr_debug("FILEIO: Forcing setting of emulate_write_cache=1"
229 " with FDBD_HAS_BUFFERED_IO_WCE\n");
0fd97ccf 230 dev->dev_attrib.emulate_write_cache = 1;
b32f4c7e
NB
231 }
232
c66ac9db
NB
233 fd_dev->fd_dev_id = fd_host->fd_host_dev_id_count++;
234 fd_dev->fd_queue_depth = dev->queue_depth;
235
6708bb27 236 pr_debug("CORE_FILE[%u] - Added TCM FILEIO Device ID: %u at %s,"
c66ac9db
NB
237 " %llu total bytes\n", fd_host->fd_host_id, fd_dev->fd_dev_id,
238 fd_dev->fd_dev_name, fd_dev->fd_dev_size);
239
0fd97ccf 240 return 0;
c66ac9db
NB
241fail:
242 if (fd_dev->fd_file) {
243 filp_close(fd_dev->fd_file, NULL);
244 fd_dev->fd_file = NULL;
245 }
0fd97ccf 246 return ret;
c66ac9db
NB
247}
248
0fd97ccf 249static void fd_free_device(struct se_device *dev)
c66ac9db 250{
0fd97ccf 251 struct fd_dev *fd_dev = FD_DEV(dev);
c66ac9db
NB
252
253 if (fd_dev->fd_file) {
254 filp_close(fd_dev->fd_file, NULL);
255 fd_dev->fd_file = NULL;
256 }
257
258 kfree(fd_dev);
259}
260
42201b55
NB
261static int fd_do_prot_rw(struct se_cmd *cmd, struct fd_prot *fd_prot,
262 int is_write)
263{
264 struct se_device *se_dev = cmd->se_dev;
265 struct fd_dev *dev = FD_DEV(se_dev);
266 struct file *prot_fd = dev->fd_prot_file;
42201b55
NB
267 loff_t pos = (cmd->t_task_lba * se_dev->prot_length);
268 unsigned char *buf;
c8367778
AM
269 u32 prot_size;
270 int rc, ret = 1;
42201b55
NB
271
272 prot_size = (cmd->data_length / se_dev->dev_attrib.block_size) *
273 se_dev->prot_length;
274
275 if (!is_write) {
38da0f49 276 fd_prot->prot_buf = kzalloc(prot_size, GFP_KERNEL);
42201b55
NB
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
c8367778
AM
283 fd_prot->prot_sg_nents = 1;
284 fd_prot->prot_sg = kzalloc(sizeof(struct scatterlist),
285 GFP_KERNEL);
42201b55
NB
286 if (!fd_prot->prot_sg) {
287 pr_err("Unable to allocate fd_prot->prot_sg\n");
38da0f49 288 kfree(fd_prot->prot_buf);
42201b55
NB
289 return -ENOMEM;
290 }
38da0f49 291 sg_init_table(fd_prot->prot_sg, fd_prot->prot_sg_nents);
c8367778 292 sg_set_buf(fd_prot->prot_sg, buf, prot_size);
42201b55
NB
293 }
294
295 if (is_write) {
296 rc = kernel_write(prot_fd, fd_prot->prot_buf, prot_size, pos);
297 if (rc < 0 || prot_size != rc) {
298 pr_err("kernel_write() for fd_do_prot_rw failed:"
299 " %d\n", rc);
300 ret = -EINVAL;
301 }
302 } else {
303 rc = kernel_read(prot_fd, pos, fd_prot->prot_buf, prot_size);
304 if (rc < 0) {
305 pr_err("kernel_read() for fd_do_prot_rw failed:"
306 " %d\n", rc);
307 ret = -EINVAL;
308 }
309 }
310
311 if (is_write || ret < 0) {
312 kfree(fd_prot->prot_sg);
38da0f49 313 kfree(fd_prot->prot_buf);
42201b55
NB
314 }
315
316 return ret;
317}
318
778229af
SAS
319static int fd_do_rw(struct se_cmd *cmd, struct scatterlist *sgl,
320 u32 sgl_nents, int is_write)
c66ac9db 321{
5787cacd 322 struct se_device *se_dev = cmd->se_dev;
0fd97ccf 323 struct fd_dev *dev = FD_DEV(se_dev);
6708bb27 324 struct file *fd = dev->fd_file;
5787cacd 325 struct scatterlist *sg;
6b9a44d0
CH
326 struct iov_iter iter;
327 struct bio_vec *bvec;
328 ssize_t len = 0;
0fd97ccf 329 loff_t pos = (cmd->t_task_lba * se_dev->dev_attrib.block_size);
c66ac9db
NB
330 int ret = 0, i;
331
6b9a44d0
CH
332 bvec = kcalloc(sgl_nents, sizeof(struct bio_vec), GFP_KERNEL);
333 if (!bvec) {
6708bb27 334 pr_err("Unable to allocate fd_do_readv iov[]\n");
e3d6f909 335 return -ENOMEM;
c66ac9db
NB
336 }
337
5787cacd 338 for_each_sg(sgl, sg, sgl_nents, i) {
6b9a44d0
CH
339 bvec[i].bv_page = sg_page(sg);
340 bvec[i].bv_len = sg->length;
341 bvec[i].bv_offset = sg->offset;
c66ac9db 342
6b9a44d0
CH
343 len += sg->length;
344 }
778229af 345
6b9a44d0 346 iov_iter_bvec(&iter, ITER_BVEC, bvec, sgl_nents, len);
778229af 347 if (is_write)
6b9a44d0 348 ret = vfs_iter_write(fd, &iter, &pos);
778229af 349 else
6b9a44d0 350 ret = vfs_iter_read(fd, &iter, &pos);
778229af 351
6b9a44d0 352 kfree(bvec);
778229af
SAS
353
354 if (is_write) {
5787cacd 355 if (ret < 0 || ret != cmd->data_length) {
778229af 356 pr_err("%s() write returned %d\n", __func__, ret);
e3d6f909 357 return (ret < 0 ? ret : -EINVAL);
c66ac9db
NB
358 }
359 } else {
778229af
SAS
360 /*
361 * Return zeros and GOOD status even if the READ did not return
362 * the expected virt_size for struct file w/o a backing struct
363 * block_device.
364 */
496ad9aa 365 if (S_ISBLK(file_inode(fd)->i_mode)) {
778229af
SAS
366 if (ret < 0 || ret != cmd->data_length) {
367 pr_err("%s() returned %d, expecting %u for "
368 "S_ISBLK\n", __func__, ret,
369 cmd->data_length);
370 return (ret < 0 ? ret : -EINVAL);
371 }
372 } else {
373 if (ret < 0) {
374 pr_err("%s() returned %d for non S_ISBLK\n",
375 __func__, ret);
376 return ret;
377 }
c66ac9db
NB
378 }
379 }
c66ac9db
NB
380 return 1;
381}
382
de103c93
CH
383static sense_reason_t
384fd_execute_sync_cache(struct se_cmd *cmd)
c66ac9db 385{
c66ac9db 386 struct se_device *dev = cmd->se_dev;
0fd97ccf 387 struct fd_dev *fd_dev = FD_DEV(dev);
a1d8b49a 388 int immed = (cmd->t_task_cdb[1] & 0x2);
c66ac9db
NB
389 loff_t start, end;
390 int ret;
391
392 /*
393 * If the Immediate bit is set, queue up the GOOD response
394 * for this SYNCHRONIZE_CACHE op
395 */
396 if (immed)
5787cacd 397 target_complete_cmd(cmd, SAM_STAT_GOOD);
c66ac9db
NB
398
399 /*
400 * Determine if we will be flushing the entire device.
401 */
a1d8b49a 402 if (cmd->t_task_lba == 0 && cmd->data_length == 0) {
c66ac9db
NB
403 start = 0;
404 end = LLONG_MAX;
405 } else {
0fd97ccf 406 start = cmd->t_task_lba * dev->dev_attrib.block_size;
c66ac9db 407 if (cmd->data_length)
62d3ab49 408 end = start + cmd->data_length - 1;
c66ac9db
NB
409 else
410 end = LLONG_MAX;
411 }
412
413 ret = vfs_fsync_range(fd_dev->fd_file, start, end, 1);
414 if (ret != 0)
6708bb27 415 pr_err("FILEIO: vfs_fsync_range() failed: %d\n", ret);
c66ac9db 416
5787cacd 417 if (immed)
ad67f0d9 418 return 0;
5787cacd 419
de103c93 420 if (ret)
5787cacd 421 target_complete_cmd(cmd, SAM_STAT_CHECK_CONDITION);
de103c93 422 else
5787cacd 423 target_complete_cmd(cmd, SAM_STAT_GOOD);
ad67f0d9
CH
424
425 return 0;
c66ac9db
NB
426}
427
7b745c84
NB
428static sense_reason_t
429fd_execute_write_same(struct se_cmd *cmd)
430{
431 struct se_device *se_dev = cmd->se_dev;
432 struct fd_dev *fd_dev = FD_DEV(se_dev);
7b745c84 433 loff_t pos = cmd->t_task_lba * se_dev->dev_attrib.block_size;
d4c5dcac
CH
434 sector_t nolb = sbc_get_write_same_sectors(cmd);
435 struct iov_iter iter;
436 struct bio_vec *bvec;
437 unsigned int len = 0, i;
438 ssize_t ret;
7b745c84
NB
439
440 if (!nolb) {
441 target_complete_cmd(cmd, SAM_STAT_GOOD);
442 return 0;
443 }
afd73f1b
NB
444 if (cmd->prot_op) {
445 pr_err("WRITE_SAME: Protection information with FILEIO"
446 " backends not supported\n");
447 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
448 }
7b745c84
NB
449
450 if (cmd->t_data_nents > 1 ||
d4c5dcac 451 cmd->t_data_sg[0].length != cmd->se_dev->dev_attrib.block_size) {
7b745c84 452 pr_err("WRITE_SAME: Illegal SGL t_data_nents: %u length: %u"
d4c5dcac
CH
453 " block_size: %u\n",
454 cmd->t_data_nents,
455 cmd->t_data_sg[0].length,
7b745c84
NB
456 cmd->se_dev->dev_attrib.block_size);
457 return TCM_INVALID_CDB_FIELD;
458 }
459
d4c5dcac
CH
460 bvec = kcalloc(nolb, sizeof(struct bio_vec), GFP_KERNEL);
461 if (!bvec)
7b745c84
NB
462 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
463
d4c5dcac
CH
464 for (i = 0; i < nolb; i++) {
465 bvec[i].bv_page = sg_page(&cmd->t_data_sg[0]);
466 bvec[i].bv_len = cmd->t_data_sg[0].length;
467 bvec[i].bv_offset = cmd->t_data_sg[0].offset;
7b745c84 468
d4c5dcac
CH
469 len += se_dev->dev_attrib.block_size;
470 }
7b745c84 471
d4c5dcac
CH
472 iov_iter_bvec(&iter, ITER_BVEC, bvec, nolb, len);
473 ret = vfs_iter_write(fd_dev->fd_file, &iter, &pos);
7b745c84 474
d4c5dcac
CH
475 kfree(bvec);
476 if (ret < 0 || ret != len) {
477 pr_err("vfs_iter_write() returned %zd for write same\n", ret);
7b745c84
NB
478 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
479 }
480
481 target_complete_cmd(cmd, SAM_STAT_GOOD);
482 return 0;
483}
484
64d240b7
AM
485static int
486fd_do_prot_fill(struct se_device *se_dev, sector_t lba, sector_t nolb,
487 void *buf, size_t bufsize)
488{
489 struct fd_dev *fd_dev = FD_DEV(se_dev);
490 struct file *prot_fd = fd_dev->fd_prot_file;
491 sector_t prot_length, prot;
492 loff_t pos = lba * se_dev->prot_length;
493
494 if (!prot_fd) {
495 pr_err("Unable to locate fd_dev->fd_prot_file\n");
496 return -ENODEV;
497 }
498
499 prot_length = nolb * se_dev->prot_length;
500
501 for (prot = 0; prot < prot_length;) {
502 sector_t len = min_t(sector_t, bufsize, prot_length - prot);
503 ssize_t ret = kernel_write(prot_fd, buf, len, pos + prot);
504
505 if (ret != len) {
506 pr_err("vfs_write to prot file failed: %zd\n", ret);
507 return ret < 0 ? ret : -ENODEV;
508 }
509 prot += ret;
510 }
511
512 return 0;
513}
514
515static int
516fd_do_prot_unmap(struct se_cmd *cmd, sector_t lba, sector_t nolb)
517{
518 void *buf;
519 int rc;
520
521 buf = (void *)__get_free_page(GFP_KERNEL);
522 if (!buf) {
523 pr_err("Unable to allocate FILEIO prot buf\n");
524 return -ENOMEM;
525 }
526 memset(buf, 0xff, PAGE_SIZE);
527
528 rc = fd_do_prot_fill(cmd->se_dev, lba, nolb, buf, PAGE_SIZE);
529
530 free_page((unsigned long)buf);
531
532 return rc;
533}
534
70d3ae5c 535static sense_reason_t
86d71829 536fd_do_unmap(struct se_cmd *cmd, void *priv, sector_t lba, sector_t nolb)
70d3ae5c 537{
86d71829 538 struct file *file = priv;
70d3ae5c 539 struct inode *inode = file->f_mapping->host;
70d3ae5c
AH
540 int ret;
541
64d240b7
AM
542 if (cmd->se_dev->dev_attrib.pi_prot_type) {
543 ret = fd_do_prot_unmap(cmd, lba, nolb);
544 if (ret)
545 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
546 }
547
70d3ae5c
AH
548 if (S_ISBLK(inode->i_mode)) {
549 /* The backend is block device, use discard */
550 struct block_device *bdev = inode->i_bdev;
551
43f55bbb 552 ret = blkdev_issue_discard(bdev, lba,
70d3ae5c
AH
553 nolb, GFP_KERNEL, 0);
554 if (ret < 0) {
555 pr_warn("FILEIO: blkdev_issue_discard() failed: %d\n",
556 ret);
557 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
558 }
559 } else {
560 /* The backend is normal file, use fallocate */
43f55bbb
AH
561 struct se_device *se_dev = cmd->se_dev;
562 loff_t pos = lba * se_dev->dev_attrib.block_size;
70d3ae5c
AH
563 unsigned int len = nolb * se_dev->dev_attrib.block_size;
564 int mode = FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE;
565
566 if (!file->f_op->fallocate)
567 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
568
569 ret = file->f_op->fallocate(file, mode, pos, len);
570 if (ret < 0) {
571 pr_warn("FILEIO: fallocate() failed: %d\n", ret);
572 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
573 }
574 }
575
43f55bbb
AH
576 return 0;
577}
578
579static sense_reason_t
580fd_execute_write_same_unmap(struct se_cmd *cmd)
581{
582 struct se_device *se_dev = cmd->se_dev;
583 struct fd_dev *fd_dev = FD_DEV(se_dev);
584 struct file *file = fd_dev->fd_file;
585 sector_t lba = cmd->t_task_lba;
586 sector_t nolb = sbc_get_write_same_sectors(cmd);
3abff1e5 587 sense_reason_t ret;
43f55bbb
AH
588
589 if (!nolb) {
590 target_complete_cmd(cmd, SAM_STAT_GOOD);
591 return 0;
592 }
593
594 ret = fd_do_unmap(cmd, file, lba, nolb);
595 if (ret)
596 return ret;
597
70d3ae5c
AH
598 target_complete_cmd(cmd, GOOD);
599 return 0;
600}
601
50642762
AH
602static sense_reason_t
603fd_execute_unmap(struct se_cmd *cmd)
604{
86d71829 605 struct file *file = FD_DEV(cmd->se_dev)->fd_file;
50642762 606
86d71829 607 return sbc_execute_unmap(cmd, fd_do_unmap, file);
50642762
AH
608}
609
de103c93 610static sense_reason_t
a82a9538
NB
611fd_execute_rw(struct se_cmd *cmd, struct scatterlist *sgl, u32 sgl_nents,
612 enum dma_data_direction data_direction)
c66ac9db 613{
c66ac9db 614 struct se_device *dev = cmd->se_dev;
42201b55
NB
615 struct fd_prot fd_prot;
616 sense_reason_t rc;
c66ac9db 617 int ret = 0;
046ba642
NB
618 /*
619 * We are currently limited by the number of iovecs (2048) per
620 * single vfs_[writev,readv] call.
621 */
622 if (cmd->data_length > FD_MAX_BYTES) {
623 pr_err("FILEIO: Not able to process I/O of %u bytes due to"
624 "FD_MAX_BYTES: %u iovec count limitiation\n",
625 cmd->data_length, FD_MAX_BYTES);
626 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
627 }
c66ac9db
NB
628 /*
629 * Call vectorized fileio functions to map struct scatterlist
630 * physical memory addresses to struct iovec virtual memory.
631 */
5787cacd 632 if (data_direction == DMA_FROM_DEVICE) {
42201b55
NB
633 memset(&fd_prot, 0, sizeof(struct fd_prot));
634
ee920469 635 if (cmd->prot_type && dev->dev_attrib.pi_prot_type) {
42201b55
NB
636 ret = fd_do_prot_rw(cmd, &fd_prot, false);
637 if (ret < 0)
638 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
639 }
640
778229af 641 ret = fd_do_rw(cmd, sgl, sgl_nents, 0);
42201b55 642
ee920469 643 if (ret > 0 && cmd->prot_type && dev->dev_attrib.pi_prot_type) {
42201b55
NB
644 u32 sectors = cmd->data_length / dev->dev_attrib.block_size;
645
646 rc = sbc_dif_verify_read(cmd, cmd->t_task_lba, sectors,
647 0, fd_prot.prot_sg, 0);
648 if (rc) {
649 kfree(fd_prot.prot_sg);
38da0f49 650 kfree(fd_prot.prot_buf);
42201b55
NB
651 return rc;
652 }
653 kfree(fd_prot.prot_sg);
38da0f49 654 kfree(fd_prot.prot_buf);
42201b55 655 }
c66ac9db 656 } else {
42201b55
NB
657 memset(&fd_prot, 0, sizeof(struct fd_prot));
658
ee920469 659 if (cmd->prot_type && dev->dev_attrib.pi_prot_type) {
42201b55
NB
660 u32 sectors = cmd->data_length / dev->dev_attrib.block_size;
661
662 ret = fd_do_prot_rw(cmd, &fd_prot, false);
663 if (ret < 0)
664 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
665
666 rc = sbc_dif_verify_write(cmd, cmd->t_task_lba, sectors,
667 0, fd_prot.prot_sg, 0);
668 if (rc) {
669 kfree(fd_prot.prot_sg);
38da0f49 670 kfree(fd_prot.prot_buf);
42201b55
NB
671 return rc;
672 }
673 }
674
778229af 675 ret = fd_do_rw(cmd, sgl, sgl_nents, 1);
a4dff304 676 /*
125d0119 677 * Perform implicit vfs_fsync_range() for fd_do_writev() ops
a4dff304
NB
678 * for SCSI WRITEs with Forced Unit Access (FUA) set.
679 * Allow this to happen independent of WCE=0 setting.
680 */
c66ac9db 681 if (ret > 0 &&
0fd97ccf 682 dev->dev_attrib.emulate_fua_write > 0 &&
2d3a4b51 683 (cmd->se_cmd_flags & SCF_FUA)) {
0fd97ccf 684 struct fd_dev *fd_dev = FD_DEV(dev);
a4dff304 685 loff_t start = cmd->t_task_lba *
0fd97ccf 686 dev->dev_attrib.block_size;
62d3ab49
ZB
687 loff_t end;
688
689 if (cmd->data_length)
690 end = start + cmd->data_length - 1;
691 else
692 end = LLONG_MAX;
c66ac9db 693
a4dff304
NB
694 vfs_fsync_range(fd_dev->fd_file, start, end, 1);
695 }
42201b55 696
ee920469 697 if (ret > 0 && cmd->prot_type && dev->dev_attrib.pi_prot_type) {
42201b55
NB
698 ret = fd_do_prot_rw(cmd, &fd_prot, true);
699 if (ret < 0)
700 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
701 }
c66ac9db
NB
702 }
703
42201b55
NB
704 if (ret < 0) {
705 kfree(fd_prot.prot_sg);
38da0f49 706 kfree(fd_prot.prot_buf);
de103c93 707 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
42201b55 708 }
de103c93 709
5787cacd
CH
710 if (ret)
711 target_complete_cmd(cmd, SAM_STAT_GOOD);
03e98c9e 712 return 0;
c66ac9db
NB
713}
714
c66ac9db
NB
715enum {
716 Opt_fd_dev_name, Opt_fd_dev_size, Opt_fd_buffered_io, Opt_err
717};
718
719static match_table_t tokens = {
720 {Opt_fd_dev_name, "fd_dev_name=%s"},
721 {Opt_fd_dev_size, "fd_dev_size=%s"},
b32f4c7e 722 {Opt_fd_buffered_io, "fd_buffered_io=%d"},
c66ac9db
NB
723 {Opt_err, NULL}
724};
725
0fd97ccf
CH
726static ssize_t fd_set_configfs_dev_params(struct se_device *dev,
727 const char *page, ssize_t count)
c66ac9db 728{
0fd97ccf 729 struct fd_dev *fd_dev = FD_DEV(dev);
c66ac9db
NB
730 char *orig, *ptr, *arg_p, *opts;
731 substring_t args[MAX_OPT_ARGS];
b32f4c7e 732 int ret = 0, arg, token;
c66ac9db
NB
733
734 opts = kstrdup(page, GFP_KERNEL);
735 if (!opts)
736 return -ENOMEM;
737
738 orig = opts;
739
90c161b6 740 while ((ptr = strsep(&opts, ",\n")) != NULL) {
c66ac9db
NB
741 if (!*ptr)
742 continue;
743
744 token = match_token(ptr, tokens, args);
745 switch (token) {
746 case Opt_fd_dev_name:
dbc6e022
AV
747 if (match_strlcpy(fd_dev->fd_dev_name, &args[0],
748 FD_MAX_DEV_NAME) == 0) {
749 ret = -EINVAL;
6d180253
JJ
750 break;
751 }
6708bb27 752 pr_debug("FILEIO: Referencing Path: %s\n",
c66ac9db
NB
753 fd_dev->fd_dev_name);
754 fd_dev->fbd_flags |= FBDF_HAS_PATH;
755 break;
756 case Opt_fd_dev_size:
757 arg_p = match_strdup(&args[0]);
6d180253
JJ
758 if (!arg_p) {
759 ret = -ENOMEM;
760 break;
761 }
57103d7f 762 ret = kstrtoull(arg_p, 0, &fd_dev->fd_dev_size);
6d180253 763 kfree(arg_p);
c66ac9db 764 if (ret < 0) {
57103d7f 765 pr_err("kstrtoull() failed for"
c66ac9db
NB
766 " fd_dev_size=\n");
767 goto out;
768 }
6708bb27 769 pr_debug("FILEIO: Referencing Size: %llu"
c66ac9db
NB
770 " bytes\n", fd_dev->fd_dev_size);
771 fd_dev->fbd_flags |= FBDF_HAS_SIZE;
772 break;
b32f4c7e 773 case Opt_fd_buffered_io:
ce31c1b0
JE
774 ret = match_int(args, &arg);
775 if (ret)
776 goto out;
b32f4c7e
NB
777 if (arg != 1) {
778 pr_err("bogus fd_buffered_io=%d value\n", arg);
779 ret = -EINVAL;
780 goto out;
781 }
782
783 pr_debug("FILEIO: Using buffered I/O"
784 " operations for struct fd_dev\n");
785
786 fd_dev->fbd_flags |= FDBD_HAS_BUFFERED_IO_WCE;
787 break;
c66ac9db
NB
788 default:
789 break;
790 }
791 }
792
793out:
794 kfree(orig);
795 return (!ret) ? count : ret;
796}
797
0fd97ccf 798static ssize_t fd_show_configfs_dev_params(struct se_device *dev, char *b)
c66ac9db 799{
0fd97ccf 800 struct fd_dev *fd_dev = FD_DEV(dev);
c66ac9db
NB
801 ssize_t bl = 0;
802
803 bl = sprintf(b + bl, "TCM FILEIO ID: %u", fd_dev->fd_dev_id);
b32f4c7e
NB
804 bl += sprintf(b + bl, " File: %s Size: %llu Mode: %s\n",
805 fd_dev->fd_dev_name, fd_dev->fd_dev_size,
806 (fd_dev->fbd_flags & FDBD_HAS_BUFFERED_IO_WCE) ?
807 "Buffered-WCE" : "O_DSYNC");
c66ac9db
NB
808 return bl;
809}
810
c66ac9db
NB
811static sector_t fd_get_blocks(struct se_device *dev)
812{
0fd97ccf 813 struct fd_dev *fd_dev = FD_DEV(dev);
cd9323fd
NB
814 struct file *f = fd_dev->fd_file;
815 struct inode *i = f->f_mapping->host;
816 unsigned long long dev_size;
817 /*
818 * When using a file that references an underlying struct block_device,
819 * ensure dev_size is always based on the current inode size in order
820 * to handle underlying block_device resize operations.
821 */
822 if (S_ISBLK(i->i_mode))
21363ca8 823 dev_size = i_size_read(i);
cd9323fd
NB
824 else
825 dev_size = fd_dev->fd_dev_size;
c66ac9db 826
21363ca8
NB
827 return div_u64(dev_size - dev->dev_attrib.block_size,
828 dev->dev_attrib.block_size);
c66ac9db
NB
829}
830
0f5e2ec4
NB
831static int fd_init_prot(struct se_device *dev)
832{
833 struct fd_dev *fd_dev = FD_DEV(dev);
834 struct file *prot_file, *file = fd_dev->fd_file;
835 struct inode *inode;
836 int ret, flags = O_RDWR | O_CREAT | O_LARGEFILE | O_DSYNC;
837 char buf[FD_MAX_DEV_PROT_NAME];
838
839 if (!file) {
840 pr_err("Unable to locate fd_dev->fd_file\n");
841 return -ENODEV;
842 }
843
844 inode = file->f_mapping->host;
845 if (S_ISBLK(inode->i_mode)) {
846 pr_err("FILEIO Protection emulation only supported on"
847 " !S_ISBLK\n");
848 return -ENOSYS;
849 }
850
851 if (fd_dev->fbd_flags & FDBD_HAS_BUFFERED_IO_WCE)
852 flags &= ~O_DSYNC;
853
854 snprintf(buf, FD_MAX_DEV_PROT_NAME, "%s.protection",
855 fd_dev->fd_dev_name);
856
857 prot_file = filp_open(buf, flags, 0600);
858 if (IS_ERR(prot_file)) {
859 pr_err("filp_open(%s) failed\n", buf);
860 ret = PTR_ERR(prot_file);
861 return ret;
862 }
863 fd_dev->fd_prot_file = prot_file;
864
865 return 0;
866}
867
0f5e2ec4
NB
868static int fd_format_prot(struct se_device *dev)
869{
0f5e2ec4 870 unsigned char *buf;
0f5e2ec4 871 int unit_size = FDBD_FORMAT_UNIT_SIZE * dev->dev_attrib.block_size;
64d240b7 872 int ret;
0f5e2ec4
NB
873
874 if (!dev->dev_attrib.pi_prot_type) {
875 pr_err("Unable to format_prot while pi_prot_type == 0\n");
876 return -ENODEV;
877 }
0f5e2ec4 878
0f5e2ec4
NB
879 buf = vzalloc(unit_size);
880 if (!buf) {
881 pr_err("Unable to allocate FILEIO prot buf\n");
882 return -ENOMEM;
883 }
0f5e2ec4
NB
884
885 pr_debug("Using FILEIO prot_length: %llu\n",
64d240b7
AM
886 (unsigned long long)(dev->transport->get_blocks(dev) + 1) *
887 dev->prot_length);
0f5e2ec4 888
80dcd0c1 889 memset(buf, 0xff, unit_size);
64d240b7
AM
890 ret = fd_do_prot_fill(dev, 0, dev->transport->get_blocks(dev) + 1,
891 buf, unit_size);
0f5e2ec4
NB
892 vfree(buf);
893 return ret;
894}
895
896static void fd_free_prot(struct se_device *dev)
897{
898 struct fd_dev *fd_dev = FD_DEV(dev);
899
900 if (!fd_dev->fd_prot_file)
901 return;
902
903 filp_close(fd_dev->fd_prot_file, NULL);
904 fd_dev->fd_prot_file = NULL;
905}
906
9e999a6c 907static struct sbc_ops fd_sbc_ops = {
0c2ad7d1 908 .execute_rw = fd_execute_rw,
ad67f0d9 909 .execute_sync_cache = fd_execute_sync_cache,
7b745c84 910 .execute_write_same = fd_execute_write_same,
70d3ae5c 911 .execute_write_same_unmap = fd_execute_write_same_unmap,
50642762 912 .execute_unmap = fd_execute_unmap,
0c2ad7d1
CH
913};
914
de103c93
CH
915static sense_reason_t
916fd_parse_cdb(struct se_cmd *cmd)
0c2ad7d1 917{
9e999a6c 918 return sbc_parse_cdb(cmd, &fd_sbc_ops);
0c2ad7d1
CH
919}
920
b2320497
NB
921DEF_TB_DEFAULT_ATTRIBS(fileio);
922
923static struct configfs_attribute *fileio_backend_dev_attrs[] = {
924 &fileio_dev_attrib_emulate_model_alias.attr,
925 &fileio_dev_attrib_emulate_dpo.attr,
926 &fileio_dev_attrib_emulate_fua_write.attr,
927 &fileio_dev_attrib_emulate_fua_read.attr,
928 &fileio_dev_attrib_emulate_write_cache.attr,
929 &fileio_dev_attrib_emulate_ua_intlck_ctrl.attr,
930 &fileio_dev_attrib_emulate_tas.attr,
931 &fileio_dev_attrib_emulate_tpu.attr,
932 &fileio_dev_attrib_emulate_tpws.attr,
933 &fileio_dev_attrib_emulate_caw.attr,
934 &fileio_dev_attrib_emulate_3pc.attr,
935 &fileio_dev_attrib_pi_prot_type.attr,
936 &fileio_dev_attrib_hw_pi_prot_type.attr,
937 &fileio_dev_attrib_pi_prot_format.attr,
938 &fileio_dev_attrib_enforce_pr_isids.attr,
939 &fileio_dev_attrib_is_nonrot.attr,
940 &fileio_dev_attrib_emulate_rest_reord.attr,
941 &fileio_dev_attrib_force_pr_aptpl.attr,
942 &fileio_dev_attrib_hw_block_size.attr,
943 &fileio_dev_attrib_block_size.attr,
944 &fileio_dev_attrib_hw_max_sectors.attr,
b2320497
NB
945 &fileio_dev_attrib_optimal_sectors.attr,
946 &fileio_dev_attrib_hw_queue_depth.attr,
947 &fileio_dev_attrib_queue_depth.attr,
948 &fileio_dev_attrib_max_unmap_lba_count.attr,
949 &fileio_dev_attrib_max_unmap_block_desc_count.attr,
950 &fileio_dev_attrib_unmap_granularity.attr,
951 &fileio_dev_attrib_unmap_granularity_alignment.attr,
952 &fileio_dev_attrib_max_write_same_len.attr,
953 NULL,
954};
955
c66ac9db
NB
956static struct se_subsystem_api fileio_template = {
957 .name = "fileio",
0fd97ccf
CH
958 .inquiry_prod = "FILEIO",
959 .inquiry_rev = FD_VERSION,
c66ac9db 960 .owner = THIS_MODULE,
c66ac9db
NB
961 .attach_hba = fd_attach_hba,
962 .detach_hba = fd_detach_hba,
0fd97ccf
CH
963 .alloc_device = fd_alloc_device,
964 .configure_device = fd_configure_device,
c66ac9db 965 .free_device = fd_free_device,
0c2ad7d1 966 .parse_cdb = fd_parse_cdb,
c66ac9db
NB
967 .set_configfs_dev_params = fd_set_configfs_dev_params,
968 .show_configfs_dev_params = fd_show_configfs_dev_params,
6f23ac8a 969 .get_device_type = sbc_get_device_type,
c66ac9db 970 .get_blocks = fd_get_blocks,
0f5e2ec4
NB
971 .init_prot = fd_init_prot,
972 .format_prot = fd_format_prot,
973 .free_prot = fd_free_prot,
c66ac9db
NB
974};
975
976static int __init fileio_module_init(void)
977{
b2320497
NB
978 struct target_backend_cits *tbc = &fileio_template.tb_cits;
979
980 target_core_setup_sub_cits(&fileio_template);
981 tbc->tb_dev_attrib_cit.ct_attrs = fileio_backend_dev_attrs;
982
c66ac9db
NB
983 return transport_subsystem_register(&fileio_template);
984}
985
63b91d5a 986static void __exit fileio_module_exit(void)
c66ac9db
NB
987{
988 transport_subsystem_release(&fileio_template);
989}
990
991MODULE_DESCRIPTION("TCM FILEIO subsystem plugin");
992MODULE_AUTHOR("nab@Linux-iSCSI.org");
993MODULE_LICENSE("GPL");
994
995module_init(fileio_module_init);
996module_exit(fileio_module_exit);
This page took 0.255716 seconds and 5 git commands to generate.