target/iblock: Add iblock_do_unmap() helper
[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 *
fd9a11d7 6 * (c) Copyright 2005-2012 RisingTide Systems LLC.
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
NB
47
48/* fd_attach_hba(): (Part of se_subsystem_api_t template)
49 *
50 *
51 */
52static int fd_attach_hba(struct se_hba *hba, u32 host_id)
53{
54 struct fd_host *fd_host;
55
56 fd_host = kzalloc(sizeof(struct fd_host), GFP_KERNEL);
6708bb27
AG
57 if (!fd_host) {
58 pr_err("Unable to allocate memory for struct fd_host\n");
e3d6f909 59 return -ENOMEM;
c66ac9db
NB
60 }
61
62 fd_host->fd_host_id = host_id;
63
e3d6f909 64 hba->hba_ptr = fd_host;
c66ac9db 65
6708bb27 66 pr_debug("CORE_HBA[%d] - TCM FILEIO HBA Driver %s on Generic"
c66ac9db
NB
67 " Target Core Stack %s\n", hba->hba_id, FD_VERSION,
68 TARGET_CORE_MOD_VERSION);
6708bb27 69 pr_debug("CORE_HBA[%d] - Attached FILEIO HBA: %u to Generic"
e3d6f909
AG
70 " MaxSectors: %u\n",
71 hba->hba_id, fd_host->fd_host_id, FD_MAX_SECTORS);
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
CH
155
156 dev->dev_attrib.hw_block_size =
157 bdev_logical_block_size(inode->i_bdev);
158 dev->dev_attrib.hw_max_sectors = queue_max_hw_sectors(q);
159
c66ac9db
NB
160 /*
161 * Determine the number of bytes from i_size_read() minus
162 * one (1) logical sector from underlying struct block_device
163 */
cd9323fd 164 dev_size = (i_size_read(file->f_mapping->host) -
c66ac9db
NB
165 fd_dev->fd_block_size);
166
6708bb27 167 pr_debug("FILEIO: Using size: %llu bytes from struct"
c66ac9db 168 " block_device blocks: %llu logical_block_size: %d\n",
cd9323fd 169 dev_size, div_u64(dev_size, fd_dev->fd_block_size),
c66ac9db 170 fd_dev->fd_block_size);
70d3ae5c
AH
171 /*
172 * Check if the underlying struct block_device request_queue supports
173 * the QUEUE_FLAG_DISCARD bit for UNMAP/WRITE_SAME in SCSI + TRIM
174 * in ATA and we need to set TPE=1
175 */
176 if (blk_queue_discard(q)) {
177 dev->dev_attrib.max_unmap_lba_count =
178 q->limits.max_discard_sectors;
179 /*
180 * Currently hardcoded to 1 in Linux/SCSI code..
181 */
182 dev->dev_attrib.max_unmap_block_desc_count = 1;
183 dev->dev_attrib.unmap_granularity =
184 q->limits.discard_granularity >> 9;
185 dev->dev_attrib.unmap_granularity_alignment =
186 q->limits.discard_alignment;
187 pr_debug("IFILE: BLOCK Discard support available,"
188 " disabled by default\n");
189 }
190 /*
191 * Enable write same emulation for IBLOCK and use 0xFFFF as
192 * the smaller WRITE_SAME(10) only has a two-byte block count.
193 */
194 dev->dev_attrib.max_write_same_len = 0xFFFF;
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
0fd97ccf
CH
203 dev->dev_attrib.hw_block_size = FD_BLOCKSIZE;
204 dev->dev_attrib.hw_max_sectors = FD_MAX_SECTORS;
70d3ae5c
AH
205
206 /*
207 * Limit UNMAP emulation to 8k Number of LBAs (NoLB)
208 */
209 dev->dev_attrib.max_unmap_lba_count = 0x2000;
210 /*
211 * Currently hardcoded to 1 in Linux/SCSI code..
212 */
213 dev->dev_attrib.max_unmap_block_desc_count = 1;
214 dev->dev_attrib.unmap_granularity = 1;
215 dev->dev_attrib.unmap_granularity_alignment = 0;
216
217 /*
218 * Limit WRITE_SAME w/ UNMAP=0 emulation to 8k Number of LBAs (NoLB)
219 * based upon struct iovec limit for vfs_writev()
220 */
221 dev->dev_attrib.max_write_same_len = 0x1000;
c66ac9db
NB
222 }
223
0fd97ccf 224 fd_dev->fd_block_size = dev->dev_attrib.hw_block_size;
c66ac9db 225
0fd97ccf 226 dev->dev_attrib.hw_queue_depth = FD_MAX_DEVICE_QUEUE_DEPTH;
c66ac9db 227
b32f4c7e
NB
228 if (fd_dev->fbd_flags & FDBD_HAS_BUFFERED_IO_WCE) {
229 pr_debug("FILEIO: Forcing setting of emulate_write_cache=1"
230 " with FDBD_HAS_BUFFERED_IO_WCE\n");
0fd97ccf 231 dev->dev_attrib.emulate_write_cache = 1;
b32f4c7e
NB
232 }
233
c66ac9db
NB
234 fd_dev->fd_dev_id = fd_host->fd_host_dev_id_count++;
235 fd_dev->fd_queue_depth = dev->queue_depth;
236
6708bb27 237 pr_debug("CORE_FILE[%u] - Added TCM FILEIO Device ID: %u at %s,"
c66ac9db
NB
238 " %llu total bytes\n", fd_host->fd_host_id, fd_dev->fd_dev_id,
239 fd_dev->fd_dev_name, fd_dev->fd_dev_size);
240
0fd97ccf 241 return 0;
c66ac9db
NB
242fail:
243 if (fd_dev->fd_file) {
244 filp_close(fd_dev->fd_file, NULL);
245 fd_dev->fd_file = NULL;
246 }
0fd97ccf 247 return ret;
c66ac9db
NB
248}
249
0fd97ccf 250static void fd_free_device(struct se_device *dev)
c66ac9db 251{
0fd97ccf 252 struct fd_dev *fd_dev = FD_DEV(dev);
c66ac9db
NB
253
254 if (fd_dev->fd_file) {
255 filp_close(fd_dev->fd_file, NULL);
256 fd_dev->fd_file = NULL;
257 }
258
259 kfree(fd_dev);
260}
261
778229af
SAS
262static int fd_do_rw(struct se_cmd *cmd, struct scatterlist *sgl,
263 u32 sgl_nents, int is_write)
c66ac9db 264{
5787cacd 265 struct se_device *se_dev = cmd->se_dev;
0fd97ccf 266 struct fd_dev *dev = FD_DEV(se_dev);
6708bb27 267 struct file *fd = dev->fd_file;
5787cacd 268 struct scatterlist *sg;
c66ac9db
NB
269 struct iovec *iov;
270 mm_segment_t old_fs;
0fd97ccf 271 loff_t pos = (cmd->t_task_lba * se_dev->dev_attrib.block_size);
c66ac9db
NB
272 int ret = 0, i;
273
5787cacd 274 iov = kzalloc(sizeof(struct iovec) * sgl_nents, GFP_KERNEL);
6708bb27
AG
275 if (!iov) {
276 pr_err("Unable to allocate fd_do_readv iov[]\n");
e3d6f909 277 return -ENOMEM;
c66ac9db
NB
278 }
279
5787cacd 280 for_each_sg(sgl, sg, sgl_nents, i) {
9649fa1b 281 iov[i].iov_len = sg->length;
40ff2c3b 282 iov[i].iov_base = kmap(sg_page(sg)) + sg->offset;
c66ac9db
NB
283 }
284
285 old_fs = get_fs();
286 set_fs(get_ds());
778229af
SAS
287
288 if (is_write)
289 ret = vfs_writev(fd, &iov[0], sgl_nents, &pos);
290 else
291 ret = vfs_readv(fd, &iov[0], sgl_nents, &pos);
292
c66ac9db
NB
293 set_fs(old_fs);
294
40ff2c3b
SAS
295 for_each_sg(sgl, sg, sgl_nents, i)
296 kunmap(sg_page(sg));
778229af 297
c66ac9db 298 kfree(iov);
778229af
SAS
299
300 if (is_write) {
5787cacd 301 if (ret < 0 || ret != cmd->data_length) {
778229af 302 pr_err("%s() write returned %d\n", __func__, ret);
e3d6f909 303 return (ret < 0 ? ret : -EINVAL);
c66ac9db
NB
304 }
305 } else {
778229af
SAS
306 /*
307 * Return zeros and GOOD status even if the READ did not return
308 * the expected virt_size for struct file w/o a backing struct
309 * block_device.
310 */
496ad9aa 311 if (S_ISBLK(file_inode(fd)->i_mode)) {
778229af
SAS
312 if (ret < 0 || ret != cmd->data_length) {
313 pr_err("%s() returned %d, expecting %u for "
314 "S_ISBLK\n", __func__, ret,
315 cmd->data_length);
316 return (ret < 0 ? ret : -EINVAL);
317 }
318 } else {
319 if (ret < 0) {
320 pr_err("%s() returned %d for non S_ISBLK\n",
321 __func__, ret);
322 return ret;
323 }
c66ac9db
NB
324 }
325 }
c66ac9db
NB
326 return 1;
327}
328
de103c93
CH
329static sense_reason_t
330fd_execute_sync_cache(struct se_cmd *cmd)
c66ac9db 331{
c66ac9db 332 struct se_device *dev = cmd->se_dev;
0fd97ccf 333 struct fd_dev *fd_dev = FD_DEV(dev);
a1d8b49a 334 int immed = (cmd->t_task_cdb[1] & 0x2);
c66ac9db
NB
335 loff_t start, end;
336 int ret;
337
338 /*
339 * If the Immediate bit is set, queue up the GOOD response
340 * for this SYNCHRONIZE_CACHE op
341 */
342 if (immed)
5787cacd 343 target_complete_cmd(cmd, SAM_STAT_GOOD);
c66ac9db
NB
344
345 /*
346 * Determine if we will be flushing the entire device.
347 */
a1d8b49a 348 if (cmd->t_task_lba == 0 && cmd->data_length == 0) {
c66ac9db
NB
349 start = 0;
350 end = LLONG_MAX;
351 } else {
0fd97ccf 352 start = cmd->t_task_lba * dev->dev_attrib.block_size;
c66ac9db
NB
353 if (cmd->data_length)
354 end = start + cmd->data_length;
355 else
356 end = LLONG_MAX;
357 }
358
359 ret = vfs_fsync_range(fd_dev->fd_file, start, end, 1);
360 if (ret != 0)
6708bb27 361 pr_err("FILEIO: vfs_fsync_range() failed: %d\n", ret);
c66ac9db 362
5787cacd 363 if (immed)
ad67f0d9 364 return 0;
5787cacd 365
de103c93 366 if (ret)
5787cacd 367 target_complete_cmd(cmd, SAM_STAT_CHECK_CONDITION);
de103c93 368 else
5787cacd 369 target_complete_cmd(cmd, SAM_STAT_GOOD);
ad67f0d9
CH
370
371 return 0;
c66ac9db
NB
372}
373
7b745c84
NB
374static unsigned char *
375fd_setup_write_same_buf(struct se_cmd *cmd, struct scatterlist *sg,
376 unsigned int len)
377{
378 struct se_device *se_dev = cmd->se_dev;
379 unsigned int block_size = se_dev->dev_attrib.block_size;
380 unsigned int i = 0, end;
381 unsigned char *buf, *p, *kmap_buf;
382
383 buf = kzalloc(min_t(unsigned int, len, PAGE_SIZE), GFP_KERNEL);
384 if (!buf) {
385 pr_err("Unable to allocate fd_execute_write_same buf\n");
386 return NULL;
387 }
388
389 kmap_buf = kmap(sg_page(sg)) + sg->offset;
390 if (!kmap_buf) {
391 pr_err("kmap() failed in fd_setup_write_same\n");
392 kfree(buf);
393 return NULL;
394 }
395 /*
396 * Fill local *buf to contain multiple WRITE_SAME blocks up to
397 * min(len, PAGE_SIZE)
398 */
399 p = buf;
400 end = min_t(unsigned int, len, PAGE_SIZE);
401
402 while (i < end) {
403 memcpy(p, kmap_buf, block_size);
404
405 i += block_size;
406 p += block_size;
407 }
408 kunmap(sg_page(sg));
409
410 return buf;
411}
412
413static sense_reason_t
414fd_execute_write_same(struct se_cmd *cmd)
415{
416 struct se_device *se_dev = cmd->se_dev;
417 struct fd_dev *fd_dev = FD_DEV(se_dev);
418 struct file *f = fd_dev->fd_file;
419 struct scatterlist *sg;
420 struct iovec *iov;
421 mm_segment_t old_fs;
972b29c8 422 sector_t nolb = sbc_get_write_same_sectors(cmd);
7b745c84
NB
423 loff_t pos = cmd->t_task_lba * se_dev->dev_attrib.block_size;
424 unsigned int len, len_tmp, iov_num;
425 int i, rc;
426 unsigned char *buf;
427
428 if (!nolb) {
429 target_complete_cmd(cmd, SAM_STAT_GOOD);
430 return 0;
431 }
432 sg = &cmd->t_data_sg[0];
433
434 if (cmd->t_data_nents > 1 ||
435 sg->length != cmd->se_dev->dev_attrib.block_size) {
436 pr_err("WRITE_SAME: Illegal SGL t_data_nents: %u length: %u"
437 " block_size: %u\n", cmd->t_data_nents, sg->length,
438 cmd->se_dev->dev_attrib.block_size);
439 return TCM_INVALID_CDB_FIELD;
440 }
441
442 len = len_tmp = nolb * se_dev->dev_attrib.block_size;
443 iov_num = DIV_ROUND_UP(len, PAGE_SIZE);
444
445 buf = fd_setup_write_same_buf(cmd, sg, len);
446 if (!buf)
447 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
448
449 iov = vzalloc(sizeof(struct iovec) * iov_num);
450 if (!iov) {
451 pr_err("Unable to allocate fd_execute_write_same iovecs\n");
452 kfree(buf);
453 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
454 }
455 /*
456 * Map the single fabric received scatterlist block now populated
457 * in *buf into each iovec for I/O submission.
458 */
459 for (i = 0; i < iov_num; i++) {
460 iov[i].iov_base = buf;
461 iov[i].iov_len = min_t(unsigned int, len_tmp, PAGE_SIZE);
462 len_tmp -= iov[i].iov_len;
463 }
464
465 old_fs = get_fs();
466 set_fs(get_ds());
467 rc = vfs_writev(f, &iov[0], iov_num, &pos);
468 set_fs(old_fs);
469
470 vfree(iov);
471 kfree(buf);
472
473 if (rc < 0 || rc != len) {
474 pr_err("vfs_writev() returned %d for write same\n", rc);
475 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
476 }
477
478 target_complete_cmd(cmd, SAM_STAT_GOOD);
479 return 0;
480}
481
70d3ae5c 482static sense_reason_t
43f55bbb 483fd_do_unmap(struct se_cmd *cmd, struct file *file, sector_t lba, sector_t nolb)
70d3ae5c 484{
70d3ae5c 485 struct inode *inode = file->f_mapping->host;
70d3ae5c
AH
486 int ret;
487
70d3ae5c
AH
488 if (S_ISBLK(inode->i_mode)) {
489 /* The backend is block device, use discard */
490 struct block_device *bdev = inode->i_bdev;
491
43f55bbb 492 ret = blkdev_issue_discard(bdev, lba,
70d3ae5c
AH
493 nolb, GFP_KERNEL, 0);
494 if (ret < 0) {
495 pr_warn("FILEIO: blkdev_issue_discard() failed: %d\n",
496 ret);
497 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
498 }
499 } else {
500 /* The backend is normal file, use fallocate */
43f55bbb
AH
501 struct se_device *se_dev = cmd->se_dev;
502 loff_t pos = lba * se_dev->dev_attrib.block_size;
70d3ae5c
AH
503 unsigned int len = nolb * se_dev->dev_attrib.block_size;
504 int mode = FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE;
505
506 if (!file->f_op->fallocate)
507 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
508
509 ret = file->f_op->fallocate(file, mode, pos, len);
510 if (ret < 0) {
511 pr_warn("FILEIO: fallocate() failed: %d\n", ret);
512 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
513 }
514 }
515
43f55bbb
AH
516 return 0;
517}
518
519static sense_reason_t
520fd_execute_write_same_unmap(struct se_cmd *cmd)
521{
522 struct se_device *se_dev = cmd->se_dev;
523 struct fd_dev *fd_dev = FD_DEV(se_dev);
524 struct file *file = fd_dev->fd_file;
525 sector_t lba = cmd->t_task_lba;
526 sector_t nolb = sbc_get_write_same_sectors(cmd);
527 int ret;
528
529 if (!nolb) {
530 target_complete_cmd(cmd, SAM_STAT_GOOD);
531 return 0;
532 }
533
534 ret = fd_do_unmap(cmd, file, lba, nolb);
535 if (ret)
536 return ret;
537
70d3ae5c
AH
538 target_complete_cmd(cmd, GOOD);
539 return 0;
540}
541
50642762
AH
542static sense_reason_t
543fd_execute_unmap(struct se_cmd *cmd)
544{
545 struct se_device *dev = cmd->se_dev;
546 struct fd_dev *fd_dev = FD_DEV(dev);
547 struct file *file = fd_dev->fd_file;
50642762
AH
548 unsigned char *buf, *ptr = NULL;
549 sector_t lba;
550 int size;
551 u32 range;
552 sense_reason_t ret = 0;
43f55bbb 553 int dl, bd_dl;
50642762
AH
554
555 /* We never set ANC_SUP */
556 if (cmd->t_task_cdb[1])
557 return TCM_INVALID_CDB_FIELD;
558
559 if (cmd->data_length == 0) {
560 target_complete_cmd(cmd, SAM_STAT_GOOD);
561 return 0;
562 }
563
564 if (cmd->data_length < 8) {
565 pr_warn("UNMAP parameter list length %u too small\n",
566 cmd->data_length);
567 return TCM_PARAMETER_LIST_LENGTH_ERROR;
568 }
569
570 buf = transport_kmap_data_sg(cmd);
571 if (!buf)
572 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
573
574 dl = get_unaligned_be16(&buf[0]);
575 bd_dl = get_unaligned_be16(&buf[2]);
576
577 size = cmd->data_length - 8;
578 if (bd_dl > size)
579 pr_warn("UNMAP parameter list length %u too small, ignoring bd_dl %u\n",
580 cmd->data_length, bd_dl);
581 else
582 size = bd_dl;
583
584 if (size / 16 > dev->dev_attrib.max_unmap_block_desc_count) {
585 ret = TCM_INVALID_PARAMETER_LIST;
586 goto err;
587 }
588
589 /* First UNMAP block descriptor starts at 8 byte offset */
590 ptr = &buf[8];
591 pr_debug("UNMAP: Sub: %s Using dl: %u bd_dl: %u size: %u"
592 " ptr: %p\n", dev->transport->name, dl, bd_dl, size, ptr);
593
594 while (size >= 16) {
595 lba = get_unaligned_be64(&ptr[0]);
596 range = get_unaligned_be32(&ptr[8]);
597 pr_debug("UNMAP: Using lba: %llu and range: %u\n",
598 (unsigned long long)lba, range);
599
600 if (range > dev->dev_attrib.max_unmap_lba_count) {
601 ret = TCM_INVALID_PARAMETER_LIST;
602 goto err;
603 }
604
605 if (lba + range > dev->transport->get_blocks(dev) + 1) {
606 ret = TCM_ADDRESS_OUT_OF_RANGE;
607 goto err;
608 }
609
43f55bbb
AH
610 ret = fd_do_unmap(cmd, file, lba, range);
611 if (ret)
612 goto err;
50642762
AH
613
614 ptr += 16;
615 size -= 16;
616 }
617
618err:
619 transport_kunmap_data_sg(cmd);
620 if (!ret)
621 target_complete_cmd(cmd, GOOD);
622 return ret;
623}
624
de103c93
CH
625static sense_reason_t
626fd_execute_rw(struct se_cmd *cmd)
c66ac9db 627{
0c2ad7d1
CH
628 struct scatterlist *sgl = cmd->t_data_sg;
629 u32 sgl_nents = cmd->t_data_nents;
630 enum dma_data_direction data_direction = cmd->data_direction;
c66ac9db
NB
631 struct se_device *dev = cmd->se_dev;
632 int ret = 0;
633
634 /*
635 * Call vectorized fileio functions to map struct scatterlist
636 * physical memory addresses to struct iovec virtual memory.
637 */
5787cacd 638 if (data_direction == DMA_FROM_DEVICE) {
778229af 639 ret = fd_do_rw(cmd, sgl, sgl_nents, 0);
c66ac9db 640 } else {
778229af 641 ret = fd_do_rw(cmd, sgl, sgl_nents, 1);
a4dff304
NB
642 /*
643 * Perform implict vfs_fsync_range() for fd_do_writev() ops
644 * for SCSI WRITEs with Forced Unit Access (FUA) set.
645 * Allow this to happen independent of WCE=0 setting.
646 */
c66ac9db 647 if (ret > 0 &&
0fd97ccf 648 dev->dev_attrib.emulate_fua_write > 0 &&
2d3a4b51 649 (cmd->se_cmd_flags & SCF_FUA)) {
0fd97ccf 650 struct fd_dev *fd_dev = FD_DEV(dev);
a4dff304 651 loff_t start = cmd->t_task_lba *
0fd97ccf 652 dev->dev_attrib.block_size;
a4dff304 653 loff_t end = start + cmd->data_length;
c66ac9db 654
a4dff304
NB
655 vfs_fsync_range(fd_dev->fd_file, start, end, 1);
656 }
c66ac9db
NB
657 }
658
de103c93
CH
659 if (ret < 0)
660 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
661
5787cacd
CH
662 if (ret)
663 target_complete_cmd(cmd, SAM_STAT_GOOD);
03e98c9e 664 return 0;
c66ac9db
NB
665}
666
c66ac9db
NB
667enum {
668 Opt_fd_dev_name, Opt_fd_dev_size, Opt_fd_buffered_io, Opt_err
669};
670
671static match_table_t tokens = {
672 {Opt_fd_dev_name, "fd_dev_name=%s"},
673 {Opt_fd_dev_size, "fd_dev_size=%s"},
b32f4c7e 674 {Opt_fd_buffered_io, "fd_buffered_io=%d"},
c66ac9db
NB
675 {Opt_err, NULL}
676};
677
0fd97ccf
CH
678static ssize_t fd_set_configfs_dev_params(struct se_device *dev,
679 const char *page, ssize_t count)
c66ac9db 680{
0fd97ccf 681 struct fd_dev *fd_dev = FD_DEV(dev);
c66ac9db
NB
682 char *orig, *ptr, *arg_p, *opts;
683 substring_t args[MAX_OPT_ARGS];
b32f4c7e 684 int ret = 0, arg, token;
c66ac9db
NB
685
686 opts = kstrdup(page, GFP_KERNEL);
687 if (!opts)
688 return -ENOMEM;
689
690 orig = opts;
691
90c161b6 692 while ((ptr = strsep(&opts, ",\n")) != NULL) {
c66ac9db
NB
693 if (!*ptr)
694 continue;
695
696 token = match_token(ptr, tokens, args);
697 switch (token) {
698 case Opt_fd_dev_name:
dbc6e022
AV
699 if (match_strlcpy(fd_dev->fd_dev_name, &args[0],
700 FD_MAX_DEV_NAME) == 0) {
701 ret = -EINVAL;
6d180253
JJ
702 break;
703 }
6708bb27 704 pr_debug("FILEIO: Referencing Path: %s\n",
c66ac9db
NB
705 fd_dev->fd_dev_name);
706 fd_dev->fbd_flags |= FBDF_HAS_PATH;
707 break;
708 case Opt_fd_dev_size:
709 arg_p = match_strdup(&args[0]);
6d180253
JJ
710 if (!arg_p) {
711 ret = -ENOMEM;
712 break;
713 }
c66ac9db 714 ret = strict_strtoull(arg_p, 0, &fd_dev->fd_dev_size);
6d180253 715 kfree(arg_p);
c66ac9db 716 if (ret < 0) {
6708bb27 717 pr_err("strict_strtoull() failed for"
c66ac9db
NB
718 " fd_dev_size=\n");
719 goto out;
720 }
6708bb27 721 pr_debug("FILEIO: Referencing Size: %llu"
c66ac9db
NB
722 " bytes\n", fd_dev->fd_dev_size);
723 fd_dev->fbd_flags |= FBDF_HAS_SIZE;
724 break;
b32f4c7e
NB
725 case Opt_fd_buffered_io:
726 match_int(args, &arg);
727 if (arg != 1) {
728 pr_err("bogus fd_buffered_io=%d value\n", arg);
729 ret = -EINVAL;
730 goto out;
731 }
732
733 pr_debug("FILEIO: Using buffered I/O"
734 " operations for struct fd_dev\n");
735
736 fd_dev->fbd_flags |= FDBD_HAS_BUFFERED_IO_WCE;
737 break;
c66ac9db
NB
738 default:
739 break;
740 }
741 }
742
743out:
744 kfree(orig);
745 return (!ret) ? count : ret;
746}
747
0fd97ccf 748static ssize_t fd_show_configfs_dev_params(struct se_device *dev, char *b)
c66ac9db 749{
0fd97ccf 750 struct fd_dev *fd_dev = FD_DEV(dev);
c66ac9db
NB
751 ssize_t bl = 0;
752
753 bl = sprintf(b + bl, "TCM FILEIO ID: %u", fd_dev->fd_dev_id);
b32f4c7e
NB
754 bl += sprintf(b + bl, " File: %s Size: %llu Mode: %s\n",
755 fd_dev->fd_dev_name, fd_dev->fd_dev_size,
756 (fd_dev->fbd_flags & FDBD_HAS_BUFFERED_IO_WCE) ?
757 "Buffered-WCE" : "O_DSYNC");
c66ac9db
NB
758 return bl;
759}
760
c66ac9db
NB
761static sector_t fd_get_blocks(struct se_device *dev)
762{
0fd97ccf 763 struct fd_dev *fd_dev = FD_DEV(dev);
cd9323fd
NB
764 struct file *f = fd_dev->fd_file;
765 struct inode *i = f->f_mapping->host;
766 unsigned long long dev_size;
767 /*
768 * When using a file that references an underlying struct block_device,
769 * ensure dev_size is always based on the current inode size in order
770 * to handle underlying block_device resize operations.
771 */
772 if (S_ISBLK(i->i_mode))
773 dev_size = (i_size_read(i) - fd_dev->fd_block_size);
774 else
775 dev_size = fd_dev->fd_dev_size;
c66ac9db 776
0fd97ccf 777 return div_u64(dev_size, dev->dev_attrib.block_size);
c66ac9db
NB
778}
779
9e999a6c 780static struct sbc_ops fd_sbc_ops = {
0c2ad7d1 781 .execute_rw = fd_execute_rw,
ad67f0d9 782 .execute_sync_cache = fd_execute_sync_cache,
7b745c84 783 .execute_write_same = fd_execute_write_same,
70d3ae5c 784 .execute_write_same_unmap = fd_execute_write_same_unmap,
50642762 785 .execute_unmap = fd_execute_unmap,
0c2ad7d1
CH
786};
787
de103c93
CH
788static sense_reason_t
789fd_parse_cdb(struct se_cmd *cmd)
0c2ad7d1 790{
9e999a6c 791 return sbc_parse_cdb(cmd, &fd_sbc_ops);
0c2ad7d1
CH
792}
793
c66ac9db
NB
794static struct se_subsystem_api fileio_template = {
795 .name = "fileio",
0fd97ccf
CH
796 .inquiry_prod = "FILEIO",
797 .inquiry_rev = FD_VERSION,
c66ac9db
NB
798 .owner = THIS_MODULE,
799 .transport_type = TRANSPORT_PLUGIN_VHBA_PDEV,
800 .attach_hba = fd_attach_hba,
801 .detach_hba = fd_detach_hba,
0fd97ccf
CH
802 .alloc_device = fd_alloc_device,
803 .configure_device = fd_configure_device,
c66ac9db 804 .free_device = fd_free_device,
0c2ad7d1 805 .parse_cdb = fd_parse_cdb,
c66ac9db
NB
806 .set_configfs_dev_params = fd_set_configfs_dev_params,
807 .show_configfs_dev_params = fd_show_configfs_dev_params,
6f23ac8a 808 .get_device_type = sbc_get_device_type,
c66ac9db
NB
809 .get_blocks = fd_get_blocks,
810};
811
812static int __init fileio_module_init(void)
813{
814 return transport_subsystem_register(&fileio_template);
815}
816
63b91d5a 817static void __exit fileio_module_exit(void)
c66ac9db
NB
818{
819 transport_subsystem_release(&fileio_template);
820}
821
822MODULE_DESCRIPTION("TCM FILEIO subsystem plugin");
823MODULE_AUTHOR("nab@Linux-iSCSI.org");
824MODULE_LICENSE("GPL");
825
826module_init(fileio_module_init);
827module_exit(fileio_module_exit);
This page took 0.226452 seconds and 5 git commands to generate.