target_core_file.c 21.7 KB
Newer Older
1 2 3 4 5
/*******************************************************************************
 * Filename:  target_core_file.c
 *
 * This file contains the Storage Engine <-> FILEIO transport specific functions
 *
6
 * (c) Copyright 2005-2013 Datera, Inc.
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
 *
 * Nicholas A. Bellinger <nab@kernel.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
 ******************************************************************************/

#include <linux/string.h>
#include <linux/parser.h>
#include <linux/timer.h>
#include <linux/blkdev.h>
#include <linux/slab.h>
#include <linux/spinlock.h>
32
#include <linux/module.h>
33
#include <linux/vmalloc.h>
34
#include <linux/falloc.h>
35
#include <scsi/scsi_proto.h>
36
#include <asm/unaligned.h>
37 38

#include <target/target_core_base.h>
39
#include <target/target_core_backend.h>
40 41 42

#include "target_core_file.h"

43 44 45 46
static inline struct fd_dev *FD_DEV(struct se_device *dev)
{
	return container_of(dev, struct fd_dev, dev);
}
47 48 49 50 51 52

static int fd_attach_hba(struct se_hba *hba, u32 host_id)
{
	struct fd_host *fd_host;

	fd_host = kzalloc(sizeof(struct fd_host), GFP_KERNEL);
53 54
	if (!fd_host) {
		pr_err("Unable to allocate memory for struct fd_host\n");
55
		return -ENOMEM;
56 57 58 59
	}

	fd_host->fd_host_id = host_id;

60
	hba->hba_ptr = fd_host;
61

62
	pr_debug("CORE_HBA[%d] - TCM FILEIO HBA Driver %s on Generic"
63
		" Target Core Stack %s\n", hba->hba_id, FD_VERSION,
64
		TARGET_CORE_VERSION);
65 66
	pr_debug("CORE_HBA[%d] - Attached FILEIO HBA: %u to Generic\n",
		hba->hba_id, fd_host->fd_host_id);
67 68 69 70 71 72 73 74

	return 0;
}

static void fd_detach_hba(struct se_hba *hba)
{
	struct fd_host *fd_host = hba->hba_ptr;

75
	pr_debug("CORE_HBA[%d] - Detached FILEIO HBA: %u from Generic"
76 77 78 79 80 81
		" Target Core\n", hba->hba_id, fd_host->fd_host_id);

	kfree(fd_host);
	hba->hba_ptr = NULL;
}

82
static struct se_device *fd_alloc_device(struct se_hba *hba, const char *name)
83 84
{
	struct fd_dev *fd_dev;
J
Jörn Engel 已提交
85
	struct fd_host *fd_host = hba->hba_ptr;
86 87

	fd_dev = kzalloc(sizeof(struct fd_dev), GFP_KERNEL);
88 89
	if (!fd_dev) {
		pr_err("Unable to allocate memory for struct fd_dev\n");
90 91 92 93 94
		return NULL;
	}

	fd_dev->fd_host = fd_host;

95
	pr_debug("FILEIO: Allocated fd_dev for %p\n", name);
96

97
	return &fd_dev->dev;
98 99
}

100
static int fd_configure_device(struct se_device *dev)
101
{
102 103
	struct fd_dev *fd_dev = FD_DEV(dev);
	struct fd_host *fd_host = dev->se_hba->hba_ptr;
104 105
	struct file *file;
	struct inode *inode = NULL;
106
	int flags, ret = -EINVAL;
107

108 109 110 111
	if (!(fd_dev->fbd_flags & FBDF_HAS_PATH)) {
		pr_err("Missing fd_dev_name=\n");
		return -EINVAL;
	}
112 113

	/*
114 115
	 * Use O_DSYNC by default instead of O_SYNC to forgo syncing
	 * of pure timestamp updates.
116
	 */
117
	flags = O_RDWR | O_CREAT | O_LARGEFILE | O_DSYNC;
118

119 120 121 122 123 124 125 126 127 128 129 130 131
	/*
	 * Optionally allow fd_buffered_io=1 to be enabled for people
	 * who want use the fs buffer cache as an WriteCache mechanism.
	 *
	 * This means that in event of a hard failure, there is a risk
	 * of silent data-loss if the SCSI client has *not* performed a
	 * forced unit access (FUA) write, or issued SYNCHRONIZE_CACHE
	 * to write-out the entire device cache.
	 */
	if (fd_dev->fbd_flags & FDBD_HAS_BUFFERED_IO_WCE) {
		pr_debug("FILEIO: Disabling O_DSYNC, using buffered FILEIO\n");
		flags &= ~O_DSYNC;
	}
132

A
Al Viro 已提交
133
	file = filp_open(fd_dev->fd_dev_name, flags, 0600);
134
	if (IS_ERR(file)) {
A
Al Viro 已提交
135
		pr_err("filp_open(%s) failed\n", fd_dev->fd_dev_name);
136 137 138
		ret = PTR_ERR(file);
		goto fail;
	}
139 140 141 142 143 144 145 146 147
	fd_dev->fd_file = file;
	/*
	 * If using a block backend with this struct file, we extract
	 * fd_dev->fd_[block,dev]_size from struct block_device.
	 *
	 * Otherwise, we use the passed fd_size= from configfs
	 */
	inode = file->f_mapping->host;
	if (S_ISBLK(inode->i_mode)) {
148
		struct request_queue *q = bdev_get_queue(inode->i_bdev);
149
		unsigned long long dev_size;
150

151
		fd_dev->fd_block_size = bdev_logical_block_size(inode->i_bdev);
152 153 154 155
		/*
		 * Determine the number of bytes from i_size_read() minus
		 * one (1) logical sector from underlying struct block_device
		 */
156
		dev_size = (i_size_read(file->f_mapping->host) -
157 158
				       fd_dev->fd_block_size);

159
		pr_debug("FILEIO: Using size: %llu bytes from struct"
160
			" block_device blocks: %llu logical_block_size: %d\n",
161
			dev_size, div_u64(dev_size, fd_dev->fd_block_size),
162
			fd_dev->fd_block_size);
163

164
		if (target_configure_unmap_from_queue(&dev->dev_attrib, q))
165
			pr_debug("IFILE: BLOCK Discard support available,"
166
				 " disabled by default\n");
167 168 169 170 171
		/*
		 * Enable write same emulation for IBLOCK and use 0xFFFF as
		 * the smaller WRITE_SAME(10) only has a two-byte block count.
		 */
		dev->dev_attrib.max_write_same_len = 0xFFFF;
A
Asias He 已提交
172 173 174

		if (blk_queue_nonrot(q))
			dev->dev_attrib.is_nonrot = 1;
175 176
	} else {
		if (!(fd_dev->fbd_flags & FBDF_HAS_SIZE)) {
177
			pr_err("FILEIO: Missing fd_dev_size="
178 179 180 181 182
				" parameter, and no backing struct"
				" block_device\n");
			goto fail;
		}

183
		fd_dev->fd_block_size = FD_BLOCKSIZE;
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
		/*
		 * Limit UNMAP emulation to 8k Number of LBAs (NoLB)
		 */
		dev->dev_attrib.max_unmap_lba_count = 0x2000;
		/*
		 * Currently hardcoded to 1 in Linux/SCSI code..
		 */
		dev->dev_attrib.max_unmap_block_desc_count = 1;
		dev->dev_attrib.unmap_granularity = 1;
		dev->dev_attrib.unmap_granularity_alignment = 0;

		/*
		 * Limit WRITE_SAME w/ UNMAP=0 emulation to 8k Number of LBAs (NoLB)
		 * based upon struct iovec limit for vfs_writev()
		 */
		dev->dev_attrib.max_write_same_len = 0x1000;
200 201
	}

202
	dev->dev_attrib.hw_block_size = fd_dev->fd_block_size;
203 204
	dev->dev_attrib.max_bytes_per_io = FD_MAX_BYTES;
	dev->dev_attrib.hw_max_sectors = FD_MAX_BYTES / fd_dev->fd_block_size;
205
	dev->dev_attrib.hw_queue_depth = FD_MAX_DEVICE_QUEUE_DEPTH;
206

207 208 209
	if (fd_dev->fbd_flags & FDBD_HAS_BUFFERED_IO_WCE) {
		pr_debug("FILEIO: Forcing setting of emulate_write_cache=1"
			" with FDBD_HAS_BUFFERED_IO_WCE\n");
210
		dev->dev_attrib.emulate_write_cache = 1;
211 212
	}

213 214 215
	fd_dev->fd_dev_id = fd_host->fd_host_dev_id_count++;
	fd_dev->fd_queue_depth = dev->queue_depth;

216
	pr_debug("CORE_FILE[%u] - Added TCM FILEIO Device ID: %u at %s,"
217 218 219
		" %llu total bytes\n", fd_host->fd_host_id, fd_dev->fd_dev_id,
			fd_dev->fd_dev_name, fd_dev->fd_dev_size);

220
	return 0;
221 222 223 224 225
fail:
	if (fd_dev->fd_file) {
		filp_close(fd_dev->fd_file, NULL);
		fd_dev->fd_file = NULL;
	}
226
	return ret;
227 228
}

229
static void fd_dev_call_rcu(struct rcu_head *p)
230
{
231
	struct se_device *dev = container_of(p, struct se_device, rcu_head);
232
	struct fd_dev *fd_dev = FD_DEV(dev);
233 234 235 236

	kfree(fd_dev);
}

237
static void fd_free_device(struct se_device *dev)
238
{
239
	struct fd_dev *fd_dev = FD_DEV(dev);
240

241 242 243
	if (fd_dev->fd_file) {
		filp_close(fd_dev->fd_file, NULL);
		fd_dev->fd_file = NULL;
244
	}
245
	call_rcu(&dev->rcu_head, fd_dev_call_rcu);
246 247
}

248 249 250
static int fd_do_rw(struct se_cmd *cmd, struct file *fd,
		    u32 block_size, struct scatterlist *sgl,
		    u32 sgl_nents, u32 data_length, int is_write)
251
{
252
	struct scatterlist *sg;
253 254 255
	struct iov_iter iter;
	struct bio_vec *bvec;
	ssize_t len = 0;
256
	loff_t pos = (cmd->t_task_lba * block_size);
257 258
	int ret = 0, i;

259 260
	bvec = kcalloc(sgl_nents, sizeof(struct bio_vec), GFP_KERNEL);
	if (!bvec) {
261
		pr_err("Unable to allocate fd_do_readv iov[]\n");
262
		return -ENOMEM;
263 264
	}

265
	for_each_sg(sgl, sg, sgl_nents, i) {
266 267 268
		bvec[i].bv_page = sg_page(sg);
		bvec[i].bv_len = sg->length;
		bvec[i].bv_offset = sg->offset;
269

270 271
		len += sg->length;
	}
272

273
	iov_iter_bvec(&iter, ITER_BVEC, bvec, sgl_nents, len);
274
	if (is_write)
275
		ret = vfs_iter_write(fd, &iter, &pos);
276
	else
277
		ret = vfs_iter_read(fd, &iter, &pos);
278

279
	kfree(bvec);
280 281

	if (is_write) {
282
		if (ret < 0 || ret != data_length) {
283
			pr_err("%s() write returned %d\n", __func__, ret);
284
			return (ret < 0 ? ret : -EINVAL);
285 286
		}
	} else {
287 288 289 290 291
		/*
		 * Return zeros and GOOD status even if the READ did not return
		 * the expected virt_size for struct file w/o a backing struct
		 * block_device.
		 */
A
Al Viro 已提交
292
		if (S_ISBLK(file_inode(fd)->i_mode)) {
293
			if (ret < 0 || ret != data_length) {
294 295
				pr_err("%s() returned %d, expecting %u for "
						"S_ISBLK\n", __func__, ret,
296
						data_length);
297 298 299 300 301 302 303 304
				return (ret < 0 ? ret : -EINVAL);
			}
		} else {
			if (ret < 0) {
				pr_err("%s() returned %d for non S_ISBLK\n",
						__func__, ret);
				return ret;
			}
305 306 307 308 309
		}
	}
	return 1;
}

310 311
static sense_reason_t
fd_execute_sync_cache(struct se_cmd *cmd)
312 313
{
	struct se_device *dev = cmd->se_dev;
314
	struct fd_dev *fd_dev = FD_DEV(dev);
315
	int immed = (cmd->t_task_cdb[1] & 0x2);
316 317 318 319 320 321 322 323
	loff_t start, end;
	int ret;

	/*
	 * If the Immediate bit is set, queue up the GOOD response
	 * for this SYNCHRONIZE_CACHE op
	 */
	if (immed)
324
		target_complete_cmd(cmd, SAM_STAT_GOOD);
325 326 327 328

	/*
	 * Determine if we will be flushing the entire device.
	 */
329
	if (cmd->t_task_lba == 0 && cmd->data_length == 0) {
330 331 332
		start = 0;
		end = LLONG_MAX;
	} else {
333
		start = cmd->t_task_lba * dev->dev_attrib.block_size;
334
		if (cmd->data_length)
335
			end = start + cmd->data_length - 1;
336 337 338 339 340 341
		else
			end = LLONG_MAX;
	}

	ret = vfs_fsync_range(fd_dev->fd_file, start, end, 1);
	if (ret != 0)
342
		pr_err("FILEIO: vfs_fsync_range() failed: %d\n", ret);
343

344
	if (immed)
345
		return 0;
346

347
	if (ret)
348
		target_complete_cmd(cmd, SAM_STAT_CHECK_CONDITION);
349
	else
350
		target_complete_cmd(cmd, SAM_STAT_GOOD);
351 352

	return 0;
353 354
}

355 356 357 358 359 360
static sense_reason_t
fd_execute_write_same(struct se_cmd *cmd)
{
	struct se_device *se_dev = cmd->se_dev;
	struct fd_dev *fd_dev = FD_DEV(se_dev);
	loff_t pos = cmd->t_task_lba * se_dev->dev_attrib.block_size;
361 362 363 364 365
	sector_t nolb = sbc_get_write_same_sectors(cmd);
	struct iov_iter iter;
	struct bio_vec *bvec;
	unsigned int len = 0, i;
	ssize_t ret;
366 367 368 369 370

	if (!nolb) {
		target_complete_cmd(cmd, SAM_STAT_GOOD);
		return 0;
	}
371 372 373 374 375
	if (cmd->prot_op) {
		pr_err("WRITE_SAME: Protection information with FILEIO"
		       " backends not supported\n");
		return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
	}
376 377

	if (cmd->t_data_nents > 1 ||
378
	    cmd->t_data_sg[0].length != cmd->se_dev->dev_attrib.block_size) {
379
		pr_err("WRITE_SAME: Illegal SGL t_data_nents: %u length: %u"
380 381 382
			" block_size: %u\n",
			cmd->t_data_nents,
			cmd->t_data_sg[0].length,
383 384 385 386
			cmd->se_dev->dev_attrib.block_size);
		return TCM_INVALID_CDB_FIELD;
	}

387 388
	bvec = kcalloc(nolb, sizeof(struct bio_vec), GFP_KERNEL);
	if (!bvec)
389 390
		return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;

391 392 393 394
	for (i = 0; i < nolb; i++) {
		bvec[i].bv_page = sg_page(&cmd->t_data_sg[0]);
		bvec[i].bv_len = cmd->t_data_sg[0].length;
		bvec[i].bv_offset = cmd->t_data_sg[0].offset;
395

396 397
		len += se_dev->dev_attrib.block_size;
	}
398

399 400
	iov_iter_bvec(&iter, ITER_BVEC, bvec, nolb, len);
	ret = vfs_iter_write(fd_dev->fd_file, &iter, &pos);
401

402 403 404
	kfree(bvec);
	if (ret < 0 || ret != len) {
		pr_err("vfs_iter_write() returned %zd for write same\n", ret);
405 406 407 408 409 410 411
		return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
	}

	target_complete_cmd(cmd, SAM_STAT_GOOD);
	return 0;
}

412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461
static int
fd_do_prot_fill(struct se_device *se_dev, sector_t lba, sector_t nolb,
		void *buf, size_t bufsize)
{
	struct fd_dev *fd_dev = FD_DEV(se_dev);
	struct file *prot_fd = fd_dev->fd_prot_file;
	sector_t prot_length, prot;
	loff_t pos = lba * se_dev->prot_length;

	if (!prot_fd) {
		pr_err("Unable to locate fd_dev->fd_prot_file\n");
		return -ENODEV;
	}

	prot_length = nolb * se_dev->prot_length;

	for (prot = 0; prot < prot_length;) {
		sector_t len = min_t(sector_t, bufsize, prot_length - prot);
		ssize_t ret = kernel_write(prot_fd, buf, len, pos + prot);

		if (ret != len) {
			pr_err("vfs_write to prot file failed: %zd\n", ret);
			return ret < 0 ? ret : -ENODEV;
		}
		prot += ret;
	}

	return 0;
}

static int
fd_do_prot_unmap(struct se_cmd *cmd, sector_t lba, sector_t nolb)
{
	void *buf;
	int rc;

	buf = (void *)__get_free_page(GFP_KERNEL);
	if (!buf) {
		pr_err("Unable to allocate FILEIO prot buf\n");
		return -ENOMEM;
	}
	memset(buf, 0xff, PAGE_SIZE);

	rc = fd_do_prot_fill(cmd->se_dev, lba, nolb, buf, PAGE_SIZE);

	free_page((unsigned long)buf);

	return rc;
}

462
static sense_reason_t
463
fd_execute_unmap(struct se_cmd *cmd, sector_t lba, sector_t nolb)
464
{
465
	struct file *file = FD_DEV(cmd->se_dev)->fd_file;
466 467 468
	struct inode *inode = file->f_mapping->host;
	int ret;

469 470 471 472 473 474
	if (cmd->se_dev->dev_attrib.pi_prot_type) {
		ret = fd_do_prot_unmap(cmd, lba, nolb);
		if (ret)
			return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
	}

475 476 477
	if (S_ISBLK(inode->i_mode)) {
		/* The backend is block device, use discard */
		struct block_device *bdev = inode->i_bdev;
478
		struct se_device *dev = cmd->se_dev;
479

480 481 482 483
		ret = blkdev_issue_discard(bdev,
					   target_to_linux_sector(dev, lba),
					   target_to_linux_sector(dev,  nolb),
					   GFP_KERNEL, 0);
484 485 486 487 488 489 490
		if (ret < 0) {
			pr_warn("FILEIO: blkdev_issue_discard() failed: %d\n",
				ret);
			return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
		}
	} else {
		/* The backend is normal file, use fallocate */
A
Asias He 已提交
491 492
		struct se_device *se_dev = cmd->se_dev;
		loff_t pos = lba * se_dev->dev_attrib.block_size;
493 494 495 496 497 498 499 500 501 502 503 504 505
		unsigned int len = nolb * se_dev->dev_attrib.block_size;
		int mode = FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE;

		if (!file->f_op->fallocate)
			return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;

		ret = file->f_op->fallocate(file, mode, pos, len);
		if (ret < 0) {
			pr_warn("FILEIO: fallocate() failed: %d\n", ret);
			return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
		}
	}

A
Asias He 已提交
506 507 508
	return 0;
}

509
static sense_reason_t
510 511
fd_execute_rw(struct se_cmd *cmd, struct scatterlist *sgl, u32 sgl_nents,
	      enum dma_data_direction data_direction)
512 513
{
	struct se_device *dev = cmd->se_dev;
514 515 516
	struct fd_dev *fd_dev = FD_DEV(dev);
	struct file *file = fd_dev->fd_file;
	struct file *pfile = fd_dev->fd_prot_file;
517
	sense_reason_t rc;
518
	int ret = 0;
519 520 521 522 523 524 525 526 527 528
	/*
	 * We are currently limited by the number of iovecs (2048) per
	 * single vfs_[writev,readv] call.
	 */
	if (cmd->data_length > FD_MAX_BYTES) {
		pr_err("FILEIO: Not able to process I/O of %u bytes due to"
		       "FD_MAX_BYTES: %u iovec count limitiation\n",
			cmd->data_length, FD_MAX_BYTES);
		return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
	}
529 530 531 532
	/*
	 * Call vectorized fileio functions to map struct scatterlist
	 * physical memory addresses to struct iovec virtual memory.
	 */
533
	if (data_direction == DMA_FROM_DEVICE) {
534
		if (cmd->prot_type && dev->dev_attrib.pi_prot_type) {
535 536 537
			ret = fd_do_rw(cmd, pfile, dev->prot_length,
				       cmd->t_prot_sg, cmd->t_prot_nents,
				       cmd->prot_length, 0);
538 539 540 541
			if (ret < 0)
				return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
		}

542 543
		ret = fd_do_rw(cmd, file, dev->dev_attrib.block_size,
			       sgl, sgl_nents, cmd->data_length, 0);
544

545
		if (ret > 0 && cmd->prot_type && dev->dev_attrib.pi_prot_type) {
546 547
			u32 sectors = cmd->data_length >>
					ilog2(dev->dev_attrib.block_size);
548

549
			rc = sbc_dif_verify(cmd, cmd->t_task_lba, sectors,
550 551
					    0, cmd->t_prot_sg, 0);
			if (rc)
552 553
				return rc;
		}
554
	} else {
555
		if (cmd->prot_type && dev->dev_attrib.pi_prot_type) {
556 557
			u32 sectors = cmd->data_length >>
					ilog2(dev->dev_attrib.block_size);
558

559 560
			rc = sbc_dif_verify(cmd, cmd->t_task_lba, sectors,
					    0, cmd->t_prot_sg, 0);
561
			if (rc)
562 563 564
				return rc;
		}

565 566
		ret = fd_do_rw(cmd, file, dev->dev_attrib.block_size,
			       sgl, sgl_nents, cmd->data_length, 1);
567
		/*
568
		 * Perform implicit vfs_fsync_range() for fd_do_writev() ops
569 570 571
		 * for SCSI WRITEs with Forced Unit Access (FUA) set.
		 * Allow this to happen independent of WCE=0 setting.
		 */
572
		if (ret > 0 && (cmd->se_cmd_flags & SCF_FUA)) {
573
			loff_t start = cmd->t_task_lba *
574
				dev->dev_attrib.block_size;
575 576 577 578 579 580
			loff_t end;

			if (cmd->data_length)
				end = start + cmd->data_length - 1;
			else
				end = LLONG_MAX;
581

582 583
			vfs_fsync_range(fd_dev->fd_file, start, end, 1);
		}
584

585
		if (ret > 0 && cmd->prot_type && dev->dev_attrib.pi_prot_type) {
586 587 588
			ret = fd_do_rw(cmd, pfile, dev->prot_length,
				       cmd->t_prot_sg, cmd->t_prot_nents,
				       cmd->prot_length, 1);
589 590 591
			if (ret < 0)
				return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
		}
592 593
	}

594
	if (ret < 0)
595 596
		return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;

597 598
	if (ret)
		target_complete_cmd(cmd, SAM_STAT_GOOD);
599
	return 0;
600 601 602 603 604 605 606 607 608
}

enum {
	Opt_fd_dev_name, Opt_fd_dev_size, Opt_fd_buffered_io, Opt_err
};

static match_table_t tokens = {
	{Opt_fd_dev_name, "fd_dev_name=%s"},
	{Opt_fd_dev_size, "fd_dev_size=%s"},
609
	{Opt_fd_buffered_io, "fd_buffered_io=%d"},
610 611 612
	{Opt_err, NULL}
};

613 614
static ssize_t fd_set_configfs_dev_params(struct se_device *dev,
		const char *page, ssize_t count)
615
{
616
	struct fd_dev *fd_dev = FD_DEV(dev);
617 618
	char *orig, *ptr, *arg_p, *opts;
	substring_t args[MAX_OPT_ARGS];
619
	int ret = 0, arg, token;
620 621 622 623 624 625 626

	opts = kstrdup(page, GFP_KERNEL);
	if (!opts)
		return -ENOMEM;

	orig = opts;

627
	while ((ptr = strsep(&opts, ",\n")) != NULL) {
628 629 630 631 632 633
		if (!*ptr)
			continue;

		token = match_token(ptr, tokens, args);
		switch (token) {
		case Opt_fd_dev_name:
A
Al Viro 已提交
634 635 636
			if (match_strlcpy(fd_dev->fd_dev_name, &args[0],
				FD_MAX_DEV_NAME) == 0) {
				ret = -EINVAL;
637 638
				break;
			}
639
			pr_debug("FILEIO: Referencing Path: %s\n",
640 641 642 643 644
					fd_dev->fd_dev_name);
			fd_dev->fbd_flags |= FBDF_HAS_PATH;
			break;
		case Opt_fd_dev_size:
			arg_p = match_strdup(&args[0]);
645 646 647 648
			if (!arg_p) {
				ret = -ENOMEM;
				break;
			}
649
			ret = kstrtoull(arg_p, 0, &fd_dev->fd_dev_size);
650
			kfree(arg_p);
651
			if (ret < 0) {
652
				pr_err("kstrtoull() failed for"
653 654 655
						" fd_dev_size=\n");
				goto out;
			}
656
			pr_debug("FILEIO: Referencing Size: %llu"
657 658 659
					" bytes\n", fd_dev->fd_dev_size);
			fd_dev->fbd_flags |= FBDF_HAS_SIZE;
			break;
660
		case Opt_fd_buffered_io:
661 662 663
			ret = match_int(args, &arg);
			if (ret)
				goto out;
664 665 666 667 668 669 670 671 672 673 674
			if (arg != 1) {
				pr_err("bogus fd_buffered_io=%d value\n", arg);
				ret = -EINVAL;
				goto out;
			}

			pr_debug("FILEIO: Using buffered I/O"
				" operations for struct fd_dev\n");

			fd_dev->fbd_flags |= FDBD_HAS_BUFFERED_IO_WCE;
			break;
675 676 677 678 679 680 681 682 683 684
		default:
			break;
		}
	}

out:
	kfree(orig);
	return (!ret) ? count : ret;
}

685
static ssize_t fd_show_configfs_dev_params(struct se_device *dev, char *b)
686
{
687
	struct fd_dev *fd_dev = FD_DEV(dev);
688 689 690
	ssize_t bl = 0;

	bl = sprintf(b + bl, "TCM FILEIO ID: %u", fd_dev->fd_dev_id);
691 692 693 694
	bl += sprintf(b + bl, "        File: %s  Size: %llu  Mode: %s\n",
		fd_dev->fd_dev_name, fd_dev->fd_dev_size,
		(fd_dev->fbd_flags & FDBD_HAS_BUFFERED_IO_WCE) ?
		"Buffered-WCE" : "O_DSYNC");
695 696 697 698 699
	return bl;
}

static sector_t fd_get_blocks(struct se_device *dev)
{
700
	struct fd_dev *fd_dev = FD_DEV(dev);
701 702 703 704 705 706 707 708 709
	struct file *f = fd_dev->fd_file;
	struct inode *i = f->f_mapping->host;
	unsigned long long dev_size;
	/*
	 * When using a file that references an underlying struct block_device,
	 * ensure dev_size is always based on the current inode size in order
	 * to handle underlying block_device resize operations.
	 */
	if (S_ISBLK(i->i_mode))
710
		dev_size = i_size_read(i);
711 712
	else
		dev_size = fd_dev->fd_dev_size;
713

714 715
	return div_u64(dev_size - dev->dev_attrib.block_size,
		       dev->dev_attrib.block_size);
716 717
}

718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758
static int fd_init_prot(struct se_device *dev)
{
	struct fd_dev *fd_dev = FD_DEV(dev);
	struct file *prot_file, *file = fd_dev->fd_file;
	struct inode *inode;
	int ret, flags = O_RDWR | O_CREAT | O_LARGEFILE | O_DSYNC;
	char buf[FD_MAX_DEV_PROT_NAME];

	if (!file) {
		pr_err("Unable to locate fd_dev->fd_file\n");
		return -ENODEV;
	}

	inode = file->f_mapping->host;
	if (S_ISBLK(inode->i_mode)) {
		pr_err("FILEIO Protection emulation only supported on"
		       " !S_ISBLK\n");
		return -ENOSYS;
	}

	if (fd_dev->fbd_flags & FDBD_HAS_BUFFERED_IO_WCE)
		flags &= ~O_DSYNC;

	snprintf(buf, FD_MAX_DEV_PROT_NAME, "%s.protection",
		 fd_dev->fd_dev_name);

	prot_file = filp_open(buf, flags, 0600);
	if (IS_ERR(prot_file)) {
		pr_err("filp_open(%s) failed\n", buf);
		ret = PTR_ERR(prot_file);
		return ret;
	}
	fd_dev->fd_prot_file = prot_file;

	return 0;
}

static int fd_format_prot(struct se_device *dev)
{
	unsigned char *buf;
	int unit_size = FDBD_FORMAT_UNIT_SIZE * dev->dev_attrib.block_size;
759
	int ret;
760 761 762 763 764 765 766 767 768 769 770 771 772

	if (!dev->dev_attrib.pi_prot_type) {
		pr_err("Unable to format_prot while pi_prot_type == 0\n");
		return -ENODEV;
	}

	buf = vzalloc(unit_size);
	if (!buf) {
		pr_err("Unable to allocate FILEIO prot buf\n");
		return -ENOMEM;
	}

	pr_debug("Using FILEIO prot_length: %llu\n",
773 774
		 (unsigned long long)(dev->transport->get_blocks(dev) + 1) *
					dev->prot_length);
775

776
	memset(buf, 0xff, unit_size);
777 778
	ret = fd_do_prot_fill(dev, 0, dev->transport->get_blocks(dev) + 1,
			      buf, unit_size);
779 780 781 782 783 784 785 786 787 788 789 790 791 792 793
	vfree(buf);
	return ret;
}

static void fd_free_prot(struct se_device *dev)
{
	struct fd_dev *fd_dev = FD_DEV(dev);

	if (!fd_dev->fd_prot_file)
		return;

	filp_close(fd_dev->fd_prot_file, NULL);
	fd_dev->fd_prot_file = NULL;
}

C
Christoph Hellwig 已提交
794
static struct sbc_ops fd_sbc_ops = {
795
	.execute_rw		= fd_execute_rw,
796
	.execute_sync_cache	= fd_execute_sync_cache,
797
	.execute_write_same	= fd_execute_write_same,
798
	.execute_unmap		= fd_execute_unmap,
799 800
};

801 802
static sense_reason_t
fd_parse_cdb(struct se_cmd *cmd)
803
{
C
Christoph Hellwig 已提交
804
	return sbc_parse_cdb(cmd, &fd_sbc_ops);
805 806
}

807
static const struct target_backend_ops fileio_ops = {
808
	.name			= "fileio",
809 810
	.inquiry_prod		= "FILEIO",
	.inquiry_rev		= FD_VERSION,
811 812 813
	.owner			= THIS_MODULE,
	.attach_hba		= fd_attach_hba,
	.detach_hba		= fd_detach_hba,
814 815
	.alloc_device		= fd_alloc_device,
	.configure_device	= fd_configure_device,
816
	.free_device		= fd_free_device,
817
	.parse_cdb		= fd_parse_cdb,
818 819
	.set_configfs_dev_params = fd_set_configfs_dev_params,
	.show_configfs_dev_params = fd_show_configfs_dev_params,
820
	.get_device_type	= sbc_get_device_type,
821
	.get_blocks		= fd_get_blocks,
822 823 824
	.init_prot		= fd_init_prot,
	.format_prot		= fd_format_prot,
	.free_prot		= fd_free_prot,
825
	.tb_dev_attrib_attrs	= sbc_attrib_attrs,
826 827 828 829
};

static int __init fileio_module_init(void)
{
830
	return transport_backend_register(&fileio_ops);
831 832
}

833
static void __exit fileio_module_exit(void)
834
{
835
	target_backend_unregister(&fileio_ops);
836 837 838 839 840 841 842 843
}

MODULE_DESCRIPTION("TCM FILEIO subsystem plugin");
MODULE_AUTHOR("nab@Linux-iSCSI.org");
MODULE_LICENSE("GPL");

module_init(fileio_module_init);
module_exit(fileio_module_exit);