loop.c 56.4 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 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
/*
 *  linux/drivers/block/loop.c
 *
 *  Written by Theodore Ts'o, 3/29/93
 *
 * Copyright 1993 by Theodore Ts'o.  Redistribution of this file is
 * permitted under the GNU General Public License.
 *
 * DES encryption plus some minor changes by Werner Almesberger, 30-MAY-1993
 * more DES encryption plus IDEA encryption by Nicholas J. Leon, June 20, 1996
 *
 * Modularized and updated for 1.1.16 kernel - Mitch Dsouza 28th May 1994
 * Adapted for 1.3.59 kernel - Andries Brouwer, 1 Feb 1996
 *
 * Fixed do_loop_request() re-entrancy - Vincent.Renardias@waw.com Mar 20, 1997
 *
 * Added devfs support - Richard Gooch <rgooch@atnf.csiro.au> 16-Jan-1998
 *
 * Handle sparse backing files correctly - Kenn Humborg, Jun 28, 1998
 *
 * Loadable modules and other fixes by AK, 1998
 *
 * Make real block number available to downstream transfer functions, enables
 * CBC (and relatives) mode encryption requiring unique IVs per data block.
 * Reed H. Petty, rhp@draper.net
 *
 * Maximum number of loop devices now dynamic via max_loop module parameter.
 * Russell Kroll <rkroll@exploits.org> 19990701
 *
 * Maximum number of loop devices when compiled-in now selectable by passing
 * max_loop=<1-255> to the kernel on boot.
32
 * Erik I. Bolsø, <eriki@himolde.no>, Oct 31, 1999
L
Linus Torvalds 已提交
33 34 35 36 37 38 39 40 41 42
 *
 * Completely rewrite request handling to be make_request_fn style and
 * non blocking, pushing work to a helper thread. Lots of fixes from
 * Al Viro too.
 * Jens Axboe <axboe@suse.de>, Nov 2000
 *
 * Support up to 256 loop devices
 * Heinz Mauelshagen <mge@sistina.com>, Feb 2002
 *
 * Support for falling back on the write file operation when the address space
43
 * operations write_begin is not available on the backing filesystem.
L
Linus Torvalds 已提交
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
 * Anton Altaparmakov, 16 Feb 2005
 *
 * Still To Fix:
 * - Advisory locking is ignored here.
 * - Should use an own CAP_* category instead of CAP_SYS_ADMIN
 *
 */

#include <linux/module.h>
#include <linux/moduleparam.h>
#include <linux/sched.h>
#include <linux/fs.h>
#include <linux/file.h>
#include <linux/stat.h>
#include <linux/errno.h>
#include <linux/major.h>
#include <linux/wait.h>
#include <linux/blkdev.h>
#include <linux/blkpg.h>
#include <linux/init.h>
#include <linux/swap.h>
#include <linux/slab.h>
66
#include <linux/compat.h>
L
Linus Torvalds 已提交
67
#include <linux/suspend.h>
68
#include <linux/freezer.h>
69
#include <linux/mutex.h>
L
Linus Torvalds 已提交
70 71 72
#include <linux/writeback.h>
#include <linux/completion.h>
#include <linux/highmem.h>
73
#include <linux/kthread.h>
74
#include <linux/splice.h>
75
#include <linux/sysfs.h>
76
#include <linux/miscdevice.h>
77
#include <linux/falloc.h>
A
Al Viro 已提交
78
#include <linux/uio.h>
A
Adam Manzanares 已提交
79
#include <linux/ioprio.h>
80
#include <linux/blk-cgroup.h>
A
Adam Manzanares 已提交
81

A
Al Viro 已提交
82
#include "loop.h"
L
Linus Torvalds 已提交
83

84
#include <linux/uaccess.h>
L
Linus Torvalds 已提交
85

86
static DEFINE_IDR(loop_index_idr);
87
static DEFINE_MUTEX(loop_ctl_mutex);
L
Linus Torvalds 已提交
88

89 90 91
static int max_part;
static int part_shift;

L
Linus Torvalds 已提交
92 93 94 95 96
static int transfer_xor(struct loop_device *lo, int cmd,
			struct page *raw_page, unsigned raw_off,
			struct page *loop_page, unsigned loop_off,
			int size, sector_t real_block)
{
97 98
	char *raw_buf = kmap_atomic(raw_page) + raw_off;
	char *loop_buf = kmap_atomic(loop_page) + loop_off;
L
Linus Torvalds 已提交
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
	char *in, *out, *key;
	int i, keysize;

	if (cmd == READ) {
		in = raw_buf;
		out = loop_buf;
	} else {
		in = loop_buf;
		out = raw_buf;
	}

	key = lo->lo_encrypt_key;
	keysize = lo->lo_encrypt_key_size;
	for (i = 0; i < size; i++)
		*out++ = *in++ ^ key[(i & 511) % keysize];

115 116
	kunmap_atomic(loop_buf);
	kunmap_atomic(raw_buf);
L
Linus Torvalds 已提交
117 118 119 120 121 122 123 124 125 126 127 128 129
	cond_resched();
	return 0;
}

static int xor_init(struct loop_device *lo, const struct loop_info64 *info)
{
	if (unlikely(info->lo_encrypt_key_size <= 0))
		return -EINVAL;
	return 0;
}

static struct loop_func_table none_funcs = {
	.number = LO_CRYPT_NONE,
130
}; 
L
Linus Torvalds 已提交
131 132 133 134 135

static struct loop_func_table xor_funcs = {
	.number = LO_CRYPT_XOR,
	.transfer = transfer_xor,
	.init = xor_init
136
}; 
L
Linus Torvalds 已提交
137 138 139 140 141 142 143

/* xfer_funcs[0] is special - its release function is never called */
static struct loop_func_table *xfer_funcs[MAX_LO_CRYPT] = {
	&none_funcs,
	&xor_funcs
};

144
static loff_t get_size(loff_t offset, loff_t sizelimit, struct file *file)
L
Linus Torvalds 已提交
145
{
146
	loff_t loopsize;
L
Linus Torvalds 已提交
147 148

	/* Compute loopsize in bytes */
149 150 151 152
	loopsize = i_size_read(file->f_mapping->host);
	if (offset > 0)
		loopsize -= offset;
	/* offset is beyond i_size, weird but possible */
153 154
	if (loopsize < 0)
		return 0;
L
Linus Torvalds 已提交
155

156 157
	if (sizelimit > 0 && sizelimit < loopsize)
		loopsize = sizelimit;
L
Linus Torvalds 已提交
158 159 160 161 162 163 164
	/*
	 * Unfortunately, if we want to do I/O on the device,
	 * the number of 512-byte sectors has to fit into a sector_t.
	 */
	return loopsize >> 9;
}

165 166 167 168 169
static loff_t get_loop_size(struct loop_device *lo, struct file *file)
{
	return get_size(lo->lo_offset, lo->lo_sizelimit, file);
}

170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
static void __loop_update_dio(struct loop_device *lo, bool dio)
{
	struct file *file = lo->lo_backing_file;
	struct address_space *mapping = file->f_mapping;
	struct inode *inode = mapping->host;
	unsigned short sb_bsize = 0;
	unsigned dio_align = 0;
	bool use_dio;

	if (inode->i_sb->s_bdev) {
		sb_bsize = bdev_logical_block_size(inode->i_sb->s_bdev);
		dio_align = sb_bsize - 1;
	}

	/*
	 * We support direct I/O only if lo_offset is aligned with the
	 * logical I/O size of backing device, and the logical block
	 * size of loop is bigger than the backing device's and the loop
	 * needn't transform transfer.
	 *
	 * TODO: the above condition may be loosed in the future, and
	 * direct I/O may be switched runtime at that time because most
192
	 * of requests in sane applications should be PAGE_SIZE aligned
193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
	 */
	if (dio) {
		if (queue_logical_block_size(lo->lo_queue) >= sb_bsize &&
				!(lo->lo_offset & dio_align) &&
				mapping->a_ops->direct_IO &&
				!lo->transfer)
			use_dio = true;
		else
			use_dio = false;
	} else {
		use_dio = false;
	}

	if (lo->use_dio == use_dio)
		return;

	/* flush dirty pages before changing direct IO */
	vfs_fsync(file, 0);

	/*
	 * The flag of LO_FLAGS_DIRECT_IO is handled similarly with
	 * LO_FLAGS_READ_ONLY, both are set from kernel, and losetup
	 * will get updated by ioctl(LOOP_GET_STATUS)
	 */
	blk_mq_freeze_queue(lo->lo_queue);
	lo->use_dio = use_dio;
219
	if (use_dio) {
220
		blk_queue_flag_clear(QUEUE_FLAG_NOMERGES, lo->lo_queue);
221
		lo->lo_flags |= LO_FLAGS_DIRECT_IO;
222
	} else {
223
		blk_queue_flag_set(QUEUE_FLAG_NOMERGES, lo->lo_queue);
224
		lo->lo_flags &= ~LO_FLAGS_DIRECT_IO;
225
	}
226 227 228
	blk_mq_unfreeze_queue(lo->lo_queue);
}

L
Linus Torvalds 已提交
229
static int
230
figure_loop_size(struct loop_device *lo, loff_t offset, loff_t sizelimit)
L
Linus Torvalds 已提交
231
{
232
	loff_t size = get_size(offset, sizelimit, lo->lo_backing_file);
L
Linus Torvalds 已提交
233
	sector_t x = (sector_t)size;
234
	struct block_device *bdev = lo->lo_device;
L
Linus Torvalds 已提交
235 236 237

	if (unlikely((loff_t)x != size))
		return -EFBIG;
238 239 240 241
	if (lo->lo_offset != offset)
		lo->lo_offset = offset;
	if (lo->lo_sizelimit != sizelimit)
		lo->lo_sizelimit = sizelimit;
242
	set_capacity(lo->lo_disk, x);
243 244 245
	bd_set_size(bdev, (loff_t)get_capacity(bdev->bd_disk) << 9);
	/* let user-space know about the new size */
	kobject_uevent(&disk_to_dev(bdev->bd_disk)->kobj, KOBJ_CHANGE);
246
	return 0;
L
Linus Torvalds 已提交
247 248 249 250 251 252 253 254
}

static inline int
lo_do_transfer(struct loop_device *lo, int cmd,
	       struct page *rpage, unsigned roffs,
	       struct page *lpage, unsigned loffs,
	       int size, sector_t rblock)
{
255 256 257 258
	int ret;

	ret = lo->transfer(lo, cmd, rpage, roffs, lpage, loffs, size, rblock);
	if (likely(!ret))
L
Linus Torvalds 已提交
259 260
		return 0;

261 262 263 264
	printk_ratelimited(KERN_ERR
		"loop: Transfer error at byte offset %llu, length %i.\n",
		(unsigned long long)rblock << 9, size);
	return ret;
L
Linus Torvalds 已提交
265 266
}

267 268 269 270 271 272 273 274
static inline void loop_iov_iter_bvec(struct iov_iter *i,
		unsigned int direction, const struct bio_vec *bvec,
		unsigned long nr_segs, size_t count)
{
	iov_iter_bvec(i, direction, bvec, nr_segs, count);
	i->type |= ITER_BVEC_FLAG_NO_REF;
}

275
static int lo_write_bvec(struct file *file, struct bio_vec *bvec, loff_t *ppos)
L
Linus Torvalds 已提交
276
{
277
	struct iov_iter i;
L
Linus Torvalds 已提交
278
	ssize_t bw;
A
Al Viro 已提交
279

280
	loop_iov_iter_bvec(&i, WRITE, bvec, 1, bvec->bv_len);
L
Linus Torvalds 已提交
281

A
Al Viro 已提交
282
	file_start_write(file);
283
	bw = vfs_iter_write(file, &i, ppos, 0);
A
Al Viro 已提交
284
	file_end_write(file);
285 286

	if (likely(bw ==  bvec->bv_len))
L
Linus Torvalds 已提交
287
		return 0;
288 289 290 291

	printk_ratelimited(KERN_ERR
		"loop: Write error at byte offset %llu, length %i.\n",
		(unsigned long long)*ppos, bvec->bv_len);
L
Linus Torvalds 已提交
292 293 294 295 296
	if (bw >= 0)
		bw = -EIO;
	return bw;
}

297 298
static int lo_write_simple(struct loop_device *lo, struct request *rq,
		loff_t pos)
L
Linus Torvalds 已提交
299
{
300 301 302 303 304 305 306 307 308 309 310 311
	struct bio_vec bvec;
	struct req_iterator iter;
	int ret = 0;

	rq_for_each_segment(bvec, rq, iter) {
		ret = lo_write_bvec(lo->lo_backing_file, &bvec, &pos);
		if (ret < 0)
			break;
		cond_resched();
	}

	return ret;
L
Linus Torvalds 已提交
312 313
}

314
/*
315 316 317
 * This is the slow, transforming version that needs to double buffer the
 * data as it cannot do the transformations in place without having direct
 * access to the destination pages of the backing file.
L
Linus Torvalds 已提交
318
 */
319 320
static int lo_write_transfer(struct loop_device *lo, struct request *rq,
		loff_t pos)
L
Linus Torvalds 已提交
321
{
322
	struct bio_vec bvec, b;
M
Ming Lei 已提交
323
	struct req_iterator iter;
324
	struct page *page;
325
	int ret = 0;
L
Linus Torvalds 已提交
326

327 328 329
	page = alloc_page(GFP_NOIO);
	if (unlikely(!page))
		return -ENOMEM;
330

M
Ming Lei 已提交
331
	rq_for_each_segment(bvec, rq, iter) {
332 333 334 335 336 337 338 339 340
		ret = lo_do_transfer(lo, WRITE, page, 0, bvec.bv_page,
			bvec.bv_offset, bvec.bv_len, pos >> 9);
		if (unlikely(ret))
			break;

		b.bv_page = page;
		b.bv_offset = 0;
		b.bv_len = bvec.bv_len;
		ret = lo_write_bvec(lo->lo_backing_file, &b, &pos);
L
Linus Torvalds 已提交
341 342 343
		if (ret < 0)
			break;
	}
344 345

	__free_page(page);
L
Linus Torvalds 已提交
346 347 348
	return ret;
}

349 350
static int lo_read_simple(struct loop_device *lo, struct request *rq,
		loff_t pos)
L
Linus Torvalds 已提交
351
{
352 353 354 355
	struct bio_vec bvec;
	struct req_iterator iter;
	struct iov_iter i;
	ssize_t len;
L
Linus Torvalds 已提交
356

357
	rq_for_each_segment(bvec, rq, iter) {
358
		loop_iov_iter_bvec(&i, READ, &bvec, 1, bvec.bv_len);
359
		len = vfs_iter_read(lo->lo_backing_file, &i, &pos, 0);
360 361
		if (len < 0)
			return len;
L
Linus Torvalds 已提交
362

363
		flush_dcache_page(bvec.bv_page);
364

365 366
		if (len != bvec.bv_len) {
			struct bio *bio;
L
Linus Torvalds 已提交
367

368 369 370 371 372 373 374 375
			__rq_for_each_bio(bio, rq)
				zero_fill_bio(bio);
			break;
		}
		cond_resched();
	}

	return 0;
376 377
}

378 379
static int lo_read_transfer(struct loop_device *lo, struct request *rq,
		loff_t pos)
L
Linus Torvalds 已提交
380
{
381 382 383 384 385 386
	struct bio_vec bvec, b;
	struct req_iterator iter;
	struct iov_iter i;
	struct page *page;
	ssize_t len;
	int ret = 0;
L
Linus Torvalds 已提交
387

388 389 390
	page = alloc_page(GFP_NOIO);
	if (unlikely(!page))
		return -ENOMEM;
391

392 393
	rq_for_each_segment(bvec, rq, iter) {
		loff_t offset = pos;
394

395 396 397
		b.bv_page = page;
		b.bv_offset = 0;
		b.bv_len = bvec.bv_len;
398

399
		loop_iov_iter_bvec(&i, READ, &b, 1, b.bv_len);
400
		len = vfs_iter_read(lo->lo_backing_file, &i, &pos, 0);
401 402 403 404
		if (len < 0) {
			ret = len;
			goto out_free_page;
		}
L
Linus Torvalds 已提交
405

406 407 408 409
		ret = lo_do_transfer(lo, READ, page, 0, bvec.bv_page,
			bvec.bv_offset, len, offset >> 9);
		if (ret)
			goto out_free_page;
L
Linus Torvalds 已提交
410

411
		flush_dcache_page(bvec.bv_page);
412

413
		if (len != bvec.bv_len) {
M
Ming Lei 已提交
414 415 416 417
			struct bio *bio;

			__rq_for_each_bio(bio, rq)
				zero_fill_bio(bio);
L
Linus Torvalds 已提交
418
			break;
419
		}
L
Linus Torvalds 已提交
420
	}
421 422 423 424 425

	ret = 0;
out_free_page:
	__free_page(page);
	return ret;
L
Linus Torvalds 已提交
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 lo_discard(struct loop_device *lo, struct request *rq, loff_t pos)
{
	/*
	 * We use punch hole to reclaim the free space used by the
	 * image a.k.a. discard. However we do not support discard if
	 * encryption is enabled, because it may give an attacker
	 * useful information.
	 */
	struct file *file = lo->lo_backing_file;
	int mode = FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE;
	int ret;

	if ((!file->f_op->fallocate) || lo->lo_encrypt_key_size) {
		ret = -EOPNOTSUPP;
		goto out;
	}

	ret = file->f_op->fallocate(file, mode, pos, blk_rq_bytes(rq));
	if (unlikely(ret && ret != -EINVAL && ret != -EOPNOTSUPP))
		ret = -EIO;
 out:
	return ret;
}

static int lo_req_flush(struct loop_device *lo, struct request *rq)
{
	struct file *file = lo->lo_backing_file;
	int ret = vfs_fsync(file, 0);
	if (unlikely(ret && ret != -EINVAL))
		ret = -EIO;

	return ret;
}

462
static void lo_complete_rq(struct request *rq)
M
Ming Lei 已提交
463
{
464
	struct loop_cmd *cmd = blk_mq_rq_to_pdu(rq);
J
Jens Axboe 已提交
465
	blk_status_t ret = BLK_STS_OK;
M
Ming Lei 已提交
466

J
Jens Axboe 已提交
467 468 469 470 471
	if (!cmd->use_aio || cmd->ret < 0 || cmd->ret == blk_rq_bytes(rq) ||
	    req_op(rq) != REQ_OP_READ) {
		if (cmd->ret < 0)
			ret = BLK_STS_IOERR;
		goto end_io;
M
Ming Lei 已提交
472
	}
473

J
Jens Axboe 已提交
474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494
	/*
	 * Short READ - if we got some data, advance our request and
	 * retry it. If we got no data, end the rest with EIO.
	 */
	if (cmd->ret) {
		blk_update_request(rq, BLK_STS_OK, cmd->ret);
		cmd->ret = 0;
		blk_mq_requeue_request(rq, true);
	} else {
		if (cmd->use_aio) {
			struct bio *bio = rq->bio;

			while (bio) {
				zero_fill_bio(bio);
				bio = bio->bi_next;
			}
		}
		ret = BLK_STS_IOERR;
end_io:
		blk_mq_end_request(rq, ret);
	}
M
Ming Lei 已提交
495 496
}

S
Shaohua Li 已提交
497 498
static void lo_rw_aio_do_completion(struct loop_cmd *cmd)
{
J
Jens Axboe 已提交
499 500
	struct request *rq = blk_mq_rq_from_pdu(cmd);

S
Shaohua Li 已提交
501 502 503 504
	if (!atomic_dec_and_test(&cmd->ref))
		return;
	kfree(cmd->bvec);
	cmd->bvec = NULL;
J
Jens Axboe 已提交
505
	blk_mq_complete_request(rq);
S
Shaohua Li 已提交
506 507
}

M
Ming Lei 已提交
508 509 510 511
static void lo_rw_aio_complete(struct kiocb *iocb, long ret, long ret2)
{
	struct loop_cmd *cmd = container_of(iocb, struct loop_cmd, iocb);

S
Shaohua Li 已提交
512 513
	if (cmd->css)
		css_put(cmd->css);
514
	cmd->ret = ret;
S
Shaohua Li 已提交
515
	lo_rw_aio_do_completion(cmd);
M
Ming Lei 已提交
516 517 518 519 520 521
}

static int lo_rw_aio(struct loop_device *lo, struct loop_cmd *cmd,
		     loff_t pos, bool rw)
{
	struct iov_iter iter;
522
	struct req_iterator rq_iter;
M
Ming Lei 已提交
523
	struct bio_vec *bvec;
J
Jens Axboe 已提交
524
	struct request *rq = blk_mq_rq_from_pdu(cmd);
525
	struct bio *bio = rq->bio;
M
Ming Lei 已提交
526
	struct file *file = lo->lo_backing_file;
527
	struct bio_vec tmp;
528
	unsigned int offset;
529
	int nr_bvec = 0;
M
Ming Lei 已提交
530 531
	int ret;

532 533 534
	rq_for_each_bvec(tmp, rq, rq_iter)
		nr_bvec++;

535 536
	if (rq->bio != rq->biotail) {

537
		bvec = kmalloc_array(nr_bvec, sizeof(struct bio_vec),
538
				     GFP_NOIO);
539 540 541 542 543 544 545
		if (!bvec)
			return -EIO;
		cmd->bvec = bvec;

		/*
		 * The bios of the request may be started from the middle of
		 * the 'bvec' because of bio splitting, so we can't directly
546
		 * copy bio->bi_iov_vec to new bvec. The rq_for_each_bvec
547 548
		 * API will take care of all details for us.
		 */
549
		rq_for_each_bvec(tmp, rq, rq_iter) {
550 551 552 553 554 555 556 557 558 559 560 561 562 563
			*bvec = tmp;
			bvec++;
		}
		bvec = cmd->bvec;
		offset = 0;
	} else {
		/*
		 * Same here, this bio may be started from the middle of the
		 * 'bvec' because of bio splitting, so offset from the bvec
		 * must be passed to iov iterator
		 */
		offset = bio->bi_iter.bi_bvec_done;
		bvec = __bvec_iter_bvec(bio->bi_io_vec, bio->bi_iter);
	}
S
Shaohua Li 已提交
564
	atomic_set(&cmd->ref, 2);
M
Ming Lei 已提交
565

566
	loop_iov_iter_bvec(&iter, rw, bvec, nr_bvec, blk_rq_bytes(rq));
567
	iter.iov_offset = offset;
M
Ming Lei 已提交
568 569 570 571 572

	cmd->iocb.ki_pos = pos;
	cmd->iocb.ki_filp = file;
	cmd->iocb.ki_complete = lo_rw_aio_complete;
	cmd->iocb.ki_flags = IOCB_DIRECT;
A
Adam Manzanares 已提交
573
	cmd->iocb.ki_ioprio = IOPRIO_PRIO_VALUE(IOPRIO_CLASS_NONE, 0);
S
Shaohua Li 已提交
574 575
	if (cmd->css)
		kthread_associate_blkcg(cmd->css);
M
Ming Lei 已提交
576 577

	if (rw == WRITE)
578
		ret = call_write_iter(file, &cmd->iocb, &iter);
M
Ming Lei 已提交
579
	else
580
		ret = call_read_iter(file, &cmd->iocb, &iter);
M
Ming Lei 已提交
581

S
Shaohua Li 已提交
582
	lo_rw_aio_do_completion(cmd);
S
Shaohua Li 已提交
583
	kthread_associate_blkcg(NULL);
S
Shaohua Li 已提交
584

M
Ming Lei 已提交
585 586 587 588 589
	if (ret != -EIOCBQUEUED)
		cmd->iocb.ki_complete(&cmd->iocb, ret, 0);
	return 0;
}

590
static int do_req_filebacked(struct loop_device *lo, struct request *rq)
M
Ming Lei 已提交
591 592
{
	struct loop_cmd *cmd = blk_mq_rq_to_pdu(rq);
593
	loff_t pos = ((loff_t) blk_rq_pos(rq) << 9) + lo->lo_offset;
M
Ming Lei 已提交
594 595 596 597 598 599 600 601 602 603

	/*
	 * lo_write_simple and lo_read_simple should have been covered
	 * by io submit style function like lo_rw_aio(), one blocker
	 * is that lo_read_simple() need to call flush_dcache_page after
	 * the page is written from kernel, and it isn't easy to handle
	 * this in io submit style function which submits all segments
	 * of the req at one time. And direct read IO doesn't need to
	 * run flush_dcache_page().
	 */
604 605 606 607
	switch (req_op(rq)) {
	case REQ_OP_FLUSH:
		return lo_req_flush(lo, rq);
	case REQ_OP_DISCARD:
608
	case REQ_OP_WRITE_ZEROES:
609 610 611 612 613 614
		return lo_discard(lo, rq, pos);
	case REQ_OP_WRITE:
		if (lo->transfer)
			return lo_write_transfer(lo, rq, pos);
		else if (cmd->use_aio)
			return lo_rw_aio(lo, cmd, pos, WRITE);
615
		else
616 617
			return lo_write_simple(lo, rq, pos);
	case REQ_OP_READ:
618
		if (lo->transfer)
619 620 621
			return lo_read_transfer(lo, rq, pos);
		else if (cmd->use_aio)
			return lo_rw_aio(lo, cmd, pos, READ);
622
		else
623 624 625 626
			return lo_read_simple(lo, rq, pos);
	default:
		WARN_ON_ONCE(1);
		return -EIO;
627
	}
L
Linus Torvalds 已提交
628 629
}

630 631 632 633 634 635
static inline void loop_update_dio(struct loop_device *lo)
{
	__loop_update_dio(lo, io_is_direct(lo->lo_backing_file) |
			lo->use_dio);
}

636 637 638 639 640
static void loop_reread_partitions(struct loop_device *lo,
				   struct block_device *bdev)
{
	int rc;

641
	rc = blkdev_reread_part(bdev);
642 643 644 645 646
	if (rc)
		pr_warn("%s: partition scan of loop%d (%s) failed (rc=%d)\n",
			__func__, lo->lo_number, lo->lo_file_name, rc);
}

647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666
static inline int is_loop_device(struct file *file)
{
	struct inode *i = file->f_mapping->host;

	return i && S_ISBLK(i->i_mode) && MAJOR(i->i_rdev) == LOOP_MAJOR;
}

static int loop_validate_file(struct file *file, struct block_device *bdev)
{
	struct inode	*inode = file->f_mapping->host;
	struct file	*f = file;

	/* Avoid recursion */
	while (is_loop_device(f)) {
		struct loop_device *l;

		if (f->f_mapping->host->i_bdev == bdev)
			return -EBADF;

		l = f->f_mapping->host->i_bdev->bd_disk->private_data;
667
		if (l->lo_state != Lo_bound) {
668 669 670 671 672 673 674 675 676
			return -EINVAL;
		}
		f = l->lo_backing_file;
	}
	if (!S_ISREG(inode->i_mode) && !S_ISBLK(inode->i_mode))
		return -EINVAL;
	return 0;
}

L
Linus Torvalds 已提交
677 678 679 680 681 682 683 684
/*
 * loop_change_fd switched the backing store of a loopback device to
 * a new file. This is useful for operating system installers to free up
 * the original file and in High Availability environments to switch to
 * an alternative location for the content in case of server meltdown.
 * This can only work if the loop device is used read-only, and if the
 * new backing store is the same size and type as the old backing store.
 */
A
Al Viro 已提交
685 686
static int loop_change_fd(struct loop_device *lo, struct block_device *bdev,
			  unsigned int arg)
L
Linus Torvalds 已提交
687
{
688
	struct file	*file = NULL, *old_file;
L
Linus Torvalds 已提交
689
	int		error;
690
	bool		partscan;
L
Linus Torvalds 已提交
691

692
	error = mutex_lock_killable(&loop_ctl_mutex);
693 694
	if (error)
		return error;
L
Linus Torvalds 已提交
695 696
	error = -ENXIO;
	if (lo->lo_state != Lo_bound)
697
		goto out_err;
L
Linus Torvalds 已提交
698 699 700 701

	/* the loop device has to be read-only */
	error = -EINVAL;
	if (!(lo->lo_flags & LO_FLAGS_READ_ONLY))
702
		goto out_err;
L
Linus Torvalds 已提交
703 704 705 706

	error = -EBADF;
	file = fget(arg);
	if (!file)
707
		goto out_err;
L
Linus Torvalds 已提交
708

709 710
	error = loop_validate_file(file, bdev);
	if (error)
711
		goto out_err;
712

L
Linus Torvalds 已提交
713 714 715 716 717 718
	old_file = lo->lo_backing_file;

	error = -EINVAL;

	/* size of the new backing store needs to be the same */
	if (get_loop_size(lo, file) != get_loop_size(lo, old_file))
719
		goto out_err;
L
Linus Torvalds 已提交
720 721

	/* and ... switch */
722 723 724 725 726 727 728 729
	blk_mq_freeze_queue(lo->lo_queue);
	mapping_set_gfp_mask(old_file->f_mapping, lo->old_gfp_mask);
	lo->lo_backing_file = file;
	lo->old_gfp_mask = mapping_gfp_mask(file->f_mapping);
	mapping_set_gfp_mask(file->f_mapping,
			     lo->old_gfp_mask & ~(__GFP_IO|__GFP_FS));
	loop_update_dio(lo);
	blk_mq_unfreeze_queue(lo->lo_queue);
730
	partscan = lo->lo_flags & LO_FLAGS_PARTSCAN;
731
	mutex_unlock(&loop_ctl_mutex);
732 733 734 735 736 737
	/*
	 * We must drop file reference outside of loop_ctl_mutex as dropping
	 * the file ref can take bd_mutex which creates circular locking
	 * dependency.
	 */
	fput(old_file);
738 739
	if (partscan)
		loop_reread_partitions(lo, bdev);
L
Linus Torvalds 已提交
740 741
	return 0;

742
out_err:
743
	mutex_unlock(&loop_ctl_mutex);
744 745
	if (file)
		fput(file);
L
Linus Torvalds 已提交
746 747 748
	return error;
}

749 750 751 752 753
/* loop sysfs attributes */

static ssize_t loop_attr_show(struct device *dev, char *page,
			      ssize_t (*callback)(struct loop_device *, char *))
{
754 755
	struct gendisk *disk = dev_to_disk(dev);
	struct loop_device *lo = disk->private_data;
756

757
	return callback(lo, page);
758 759 760 761 762 763 764 765 766 767
}

#define LOOP_ATTR_RO(_name)						\
static ssize_t loop_attr_##_name##_show(struct loop_device *, char *);	\
static ssize_t loop_attr_do_show_##_name(struct device *d,		\
				struct device_attribute *attr, char *b)	\
{									\
	return loop_attr_show(d, b, loop_attr_##_name##_show);		\
}									\
static struct device_attribute loop_attr_##_name =			\
768
	__ATTR(_name, 0444, loop_attr_do_show_##_name, NULL);
769 770 771 772 773 774

static ssize_t loop_attr_backing_file_show(struct loop_device *lo, char *buf)
{
	ssize_t ret;
	char *p = NULL;

775
	spin_lock_irq(&lo->lo_lock);
776
	if (lo->lo_backing_file)
M
Miklos Szeredi 已提交
777
		p = file_path(lo->lo_backing_file, buf, PAGE_SIZE - 1);
778
	spin_unlock_irq(&lo->lo_lock);
779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808

	if (IS_ERR_OR_NULL(p))
		ret = PTR_ERR(p);
	else {
		ret = strlen(p);
		memmove(buf, p, ret);
		buf[ret++] = '\n';
		buf[ret] = 0;
	}

	return ret;
}

static ssize_t loop_attr_offset_show(struct loop_device *lo, char *buf)
{
	return sprintf(buf, "%llu\n", (unsigned long long)lo->lo_offset);
}

static ssize_t loop_attr_sizelimit_show(struct loop_device *lo, char *buf)
{
	return sprintf(buf, "%llu\n", (unsigned long long)lo->lo_sizelimit);
}

static ssize_t loop_attr_autoclear_show(struct loop_device *lo, char *buf)
{
	int autoclear = (lo->lo_flags & LO_FLAGS_AUTOCLEAR);

	return sprintf(buf, "%s\n", autoclear ? "1" : "0");
}

809 810 811 812 813 814 815
static ssize_t loop_attr_partscan_show(struct loop_device *lo, char *buf)
{
	int partscan = (lo->lo_flags & LO_FLAGS_PARTSCAN);

	return sprintf(buf, "%s\n", partscan ? "1" : "0");
}

816 817 818 819 820 821 822
static ssize_t loop_attr_dio_show(struct loop_device *lo, char *buf)
{
	int dio = (lo->lo_flags & LO_FLAGS_DIRECT_IO);

	return sprintf(buf, "%s\n", dio ? "1" : "0");
}

823 824 825 826
LOOP_ATTR_RO(backing_file);
LOOP_ATTR_RO(offset);
LOOP_ATTR_RO(sizelimit);
LOOP_ATTR_RO(autoclear);
827
LOOP_ATTR_RO(partscan);
828
LOOP_ATTR_RO(dio);
829 830 831 832 833 834

static struct attribute *loop_attrs[] = {
	&loop_attr_backing_file.attr,
	&loop_attr_offset.attr,
	&loop_attr_sizelimit.attr,
	&loop_attr_autoclear.attr,
835
	&loop_attr_partscan.attr,
836
	&loop_attr_dio.attr,
837 838 839 840 841 842 843 844
	NULL,
};

static struct attribute_group loop_attribute_group = {
	.name = "loop",
	.attrs= loop_attrs,
};

845
static void loop_sysfs_init(struct loop_device *lo)
846
{
847 848
	lo->sysfs_inited = !sysfs_create_group(&disk_to_dev(lo->lo_disk)->kobj,
						&loop_attribute_group);
849 850 851 852
}

static void loop_sysfs_exit(struct loop_device *lo)
{
853 854 855
	if (lo->sysfs_inited)
		sysfs_remove_group(&disk_to_dev(lo->lo_disk)->kobj,
				   &loop_attribute_group);
856 857
}

858 859 860 861 862 863 864 865
static void loop_config_discard(struct loop_device *lo)
{
	struct file *file = lo->lo_backing_file;
	struct inode *inode = file->f_mapping->host;
	struct request_queue *q = lo->lo_queue;

	/*
	 * We use punch hole to reclaim the free space used by the
866
	 * image a.k.a. discard. However we do not support discard if
867 868 869 870 871 872 873
	 * encryption is enabled, because it may give an attacker
	 * useful information.
	 */
	if ((!file->f_op->fallocate) ||
	    lo->lo_encrypt_key_size) {
		q->limits.discard_granularity = 0;
		q->limits.discard_alignment = 0;
874
		blk_queue_max_discard_sectors(q, 0);
875
		blk_queue_max_write_zeroes_sectors(q, 0);
876
		blk_queue_flag_clear(QUEUE_FLAG_DISCARD, q);
877 878 879 880
		return;
	}

	q->limits.discard_granularity = inode->i_sb->s_blocksize;
881
	q->limits.discard_alignment = 0;
882

883 884
	blk_queue_max_discard_sectors(q, UINT_MAX >> 9);
	blk_queue_max_write_zeroes_sectors(q, UINT_MAX >> 9);
885
	blk_queue_flag_set(QUEUE_FLAG_DISCARD, q);
886 887
}

M
Ming Lei 已提交
888 889
static void loop_unprepare_queue(struct loop_device *lo)
{
P
Petr Mladek 已提交
890
	kthread_flush_worker(&lo->worker);
M
Ming Lei 已提交
891 892 893
	kthread_stop(lo->worker_task);
}

894 895 896 897 898 899
static int loop_kthread_worker_fn(void *worker_ptr)
{
	current->flags |= PF_LESS_THROTTLE;
	return kthread_worker_fn(worker_ptr);
}

M
Ming Lei 已提交
900 901
static int loop_prepare_queue(struct loop_device *lo)
{
P
Petr Mladek 已提交
902
	kthread_init_worker(&lo->worker);
903
	lo->worker_task = kthread_run(loop_kthread_worker_fn,
M
Ming Lei 已提交
904 905 906 907 908 909 910
			&lo->worker, "loop%d", lo->lo_number);
	if (IS_ERR(lo->worker_task))
		return -ENOMEM;
	set_user_nice(lo->worker_task, MIN_NICE);
	return 0;
}

911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928
static void loop_update_rotational(struct loop_device *lo)
{
	struct file *file = lo->lo_backing_file;
	struct inode *file_inode = file->f_mapping->host;
	struct block_device *file_bdev = file_inode->i_sb->s_bdev;
	struct request_queue *q = lo->lo_queue;
	bool nonrot = true;

	/* not all filesystems (e.g. tmpfs) have a sb->s_bdev */
	if (file_bdev)
		nonrot = blk_queue_nonrot(bdev_get_queue(file_bdev));

	if (nonrot)
		blk_queue_flag_set(QUEUE_FLAG_NONROT, q);
	else
		blk_queue_flag_clear(QUEUE_FLAG_NONROT, q);
}

A
Al Viro 已提交
929
static int loop_set_fd(struct loop_device *lo, fmode_t mode,
L
Linus Torvalds 已提交
930 931
		       struct block_device *bdev, unsigned int arg)
{
932
	struct file	*file;
L
Linus Torvalds 已提交
933 934 935 936 937
	struct inode	*inode;
	struct address_space *mapping;
	int		lo_flags = 0;
	int		error;
	loff_t		size;
938
	bool		partscan;
L
Linus Torvalds 已提交
939 940 941 942 943 944 945 946 947

	/* This is safe, since we have a reference from open(). */
	__module_get(THIS_MODULE);

	error = -EBADF;
	file = fget(arg);
	if (!file)
		goto out;

948 949 950 951 952 953 954 955 956 957 958
	/*
	 * If we don't hold exclusive handle for the device, upgrade to it
	 * here to avoid changing device under exclusive owner.
	 */
	if (!(mode & FMODE_EXCL)) {
		bdgrab(bdev);
		error = blkdev_get(bdev, mode | FMODE_EXCL, loop_set_fd);
		if (error)
			goto out_putf;
	}

959
	error = mutex_lock_killable(&loop_ctl_mutex);
960
	if (error)
961
		goto out_bdev;
962

L
Linus Torvalds 已提交
963 964
	error = -EBUSY;
	if (lo->lo_state != Lo_unbound)
965
		goto out_unlock;
L
Linus Torvalds 已提交
966

967 968
	error = loop_validate_file(file, bdev);
	if (error)
969
		goto out_unlock;
L
Linus Torvalds 已提交
970 971 972 973

	mapping = file->f_mapping;
	inode = mapping->host;

974
	if (!(file->f_mode & FMODE_WRITE) || !(mode & FMODE_WRITE) ||
A
Al Viro 已提交
975
	    !file->f_op->write_iter)
976
		lo_flags |= LO_FLAGS_READ_ONLY;
977

978
	error = -EFBIG;
L
Linus Torvalds 已提交
979
	size = get_loop_size(lo, file);
980
	if ((loff_t)(sector_t)size != size)
981
		goto out_unlock;
M
Ming Lei 已提交
982 983
	error = loop_prepare_queue(lo);
	if (error)
984
		goto out_unlock;
L
Linus Torvalds 已提交
985

986
	error = 0;
L
Linus Torvalds 已提交
987 988 989

	set_device_ro(bdev, (lo_flags & LO_FLAGS_READ_ONLY) != 0);

990
	lo->use_dio = false;
L
Linus Torvalds 已提交
991 992 993
	lo->lo_device = bdev;
	lo->lo_flags = lo_flags;
	lo->lo_backing_file = file;
994
	lo->transfer = NULL;
L
Linus Torvalds 已提交
995 996 997 998 999
	lo->ioctl = NULL;
	lo->lo_sizelimit = 0;
	lo->old_gfp_mask = mapping_gfp_mask(mapping);
	mapping_set_gfp_mask(mapping, lo->old_gfp_mask & ~(__GFP_IO|__GFP_FS));

1000
	if (!(lo_flags & LO_FLAGS_READ_ONLY) && file->f_op->fsync)
1001
		blk_queue_write_cache(lo->lo_queue, true, false);
1002

1003
	loop_update_rotational(lo);
1004
	loop_update_dio(lo);
1005
	set_capacity(lo->lo_disk, size);
L
Linus Torvalds 已提交
1006
	bd_set_size(bdev, size << 9);
1007
	loop_sysfs_init(lo);
1008 1009
	/* let user-space know about the new size */
	kobject_uevent(&disk_to_dev(bdev->bd_disk)->kobj, KOBJ_CHANGE);
L
Linus Torvalds 已提交
1010

O
Omar Sandoval 已提交
1011 1012
	set_blocksize(bdev, S_ISBLK(inode->i_mode) ?
		      block_size(inode->i_bdev) : PAGE_SIZE);
L
Linus Torvalds 已提交
1013

1014
	lo->lo_state = Lo_bound;
1015 1016
	if (part_shift)
		lo->lo_flags |= LO_FLAGS_PARTSCAN;
1017
	partscan = lo->lo_flags & LO_FLAGS_PARTSCAN;
1018 1019

	/* Grab the block_device to prevent its destruction after we
1020
	 * put /dev/loopXX inode. Later in __loop_clr_fd() we bdput(bdev).
1021 1022
	 */
	bdgrab(bdev);
1023
	mutex_unlock(&loop_ctl_mutex);
1024 1025
	if (partscan)
		loop_reread_partitions(lo, bdev);
1026 1027
	if (!(mode & FMODE_EXCL))
		blkdev_put(bdev, mode | FMODE_EXCL);
L
Linus Torvalds 已提交
1028 1029
	return 0;

1030 1031
out_unlock:
	mutex_unlock(&loop_ctl_mutex);
1032 1033 1034
out_bdev:
	if (!(mode & FMODE_EXCL))
		blkdev_put(bdev, mode | FMODE_EXCL);
1035
out_putf:
L
Linus Torvalds 已提交
1036
	fput(file);
1037
out:
L
Linus Torvalds 已提交
1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079
	/* This is safe: open() is still holding a reference. */
	module_put(THIS_MODULE);
	return error;
}

static int
loop_release_xfer(struct loop_device *lo)
{
	int err = 0;
	struct loop_func_table *xfer = lo->lo_encryption;

	if (xfer) {
		if (xfer->release)
			err = xfer->release(lo);
		lo->transfer = NULL;
		lo->lo_encryption = NULL;
		module_put(xfer->owner);
	}
	return err;
}

static int
loop_init_xfer(struct loop_device *lo, struct loop_func_table *xfer,
	       const struct loop_info64 *i)
{
	int err = 0;

	if (xfer) {
		struct module *owner = xfer->owner;

		if (!try_module_get(owner))
			return -EINVAL;
		if (xfer->init)
			err = xfer->init(lo, i);
		if (err)
			module_put(owner);
		else
			lo->lo_encryption = xfer;
	}
	return err;
}

1080
static int __loop_clr_fd(struct loop_device *lo, bool release)
L
Linus Torvalds 已提交
1081
{
1082
	struct file *filp = NULL;
1083
	gfp_t gfp = lo->old_gfp_mask;
1084
	struct block_device *bdev = lo->lo_device;
1085
	int err = 0;
1086 1087
	bool partscan = false;
	int lo_number;
L
Linus Torvalds 已提交
1088

1089 1090 1091 1092 1093
	mutex_lock(&loop_ctl_mutex);
	if (WARN_ON_ONCE(lo->lo_state != Lo_rundown)) {
		err = -ENXIO;
		goto out_unlock;
	}
L
Linus Torvalds 已提交
1094

1095 1096 1097 1098 1099
	filp = lo->lo_backing_file;
	if (filp == NULL) {
		err = -EINVAL;
		goto out_unlock;
	}
L
Linus Torvalds 已提交
1100

1101 1102 1103
	/* freeze request queue during the transition */
	blk_mq_freeze_queue(lo->lo_queue);

L
Linus Torvalds 已提交
1104 1105
	spin_lock_irq(&lo->lo_lock);
	lo->lo_backing_file = NULL;
1106
	spin_unlock_irq(&lo->lo_lock);
L
Linus Torvalds 已提交
1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118

	loop_release_xfer(lo);
	lo->transfer = NULL;
	lo->ioctl = NULL;
	lo->lo_device = NULL;
	lo->lo_encryption = NULL;
	lo->lo_offset = 0;
	lo->lo_sizelimit = 0;
	lo->lo_encrypt_key_size = 0;
	memset(lo->lo_encrypt_key, 0, LO_KEY_SIZE);
	memset(lo->lo_crypt_name, 0, LO_NAME_SIZE);
	memset(lo->lo_file_name, 0, LO_NAME_SIZE);
1119
	blk_queue_logical_block_size(lo->lo_queue, 512);
1120 1121
	blk_queue_physical_block_size(lo->lo_queue, 512);
	blk_queue_io_min(lo->lo_queue, 512);
1122 1123
	if (bdev) {
		bdput(bdev);
A
Al Viro 已提交
1124
		invalidate_bdev(bdev);
1125
		bdev->bd_inode->i_mapping->wb_err = 0;
1126
	}
1127
	set_capacity(lo->lo_disk, 0);
1128
	loop_sysfs_exit(lo);
1129
	if (bdev) {
A
Al Viro 已提交
1130
		bd_set_size(bdev, 0);
1131 1132 1133
		/* let user-space know about this change */
		kobject_uevent(&disk_to_dev(bdev->bd_disk)->kobj, KOBJ_CHANGE);
	}
L
Linus Torvalds 已提交
1134 1135 1136
	mapping_set_gfp_mask(filp->f_mapping, gfp);
	/* This is safe: open() is still holding a reference. */
	module_put(THIS_MODULE);
1137 1138
	blk_mq_unfreeze_queue(lo->lo_queue);

1139 1140 1141 1142 1143 1144
	partscan = lo->lo_flags & LO_FLAGS_PARTSCAN && bdev;
	lo_number = lo->lo_number;
	loop_unprepare_queue(lo);
out_unlock:
	mutex_unlock(&loop_ctl_mutex);
	if (partscan) {
1145 1146 1147 1148 1149 1150 1151 1152
		/*
		 * bd_mutex has been held already in release path, so don't
		 * acquire it if this function is called in such case.
		 *
		 * If the reread partition isn't from release path, lo_refcnt
		 * must be at least one and it can only become zero when the
		 * current holder is released.
		 */
1153
		if (release)
1154 1155 1156
			err = __blkdev_reread_part(bdev);
		else
			err = blkdev_reread_part(bdev);
1157 1158 1159
		if (err)
			pr_warn("%s: partition scan of loop%d failed (rc=%d)\n",
				__func__, lo_number, err);
1160 1161 1162
		/* Device is gone, no point in returning error */
		err = 0;
	}
1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179

	/*
	 * lo->lo_state is set to Lo_unbound here after above partscan has
	 * finished.
	 *
	 * There cannot be anybody else entering __loop_clr_fd() as
	 * lo->lo_backing_file is already cleared and Lo_rundown state
	 * protects us from all the other places trying to change the 'lo'
	 * device.
	 */
	mutex_lock(&loop_ctl_mutex);
	lo->lo_flags = 0;
	if (!part_shift)
		lo->lo_disk->flags |= GENHD_FL_NO_PART_SCAN;
	lo->lo_state = Lo_unbound;
	mutex_unlock(&loop_ctl_mutex);

1180
	/*
1181 1182
	 * Need not hold loop_ctl_mutex to fput backing file.
	 * Calling fput holding loop_ctl_mutex triggers a circular
1183
	 * lock dependency possibility warning as fput can take
1184
	 * bd_mutex which is usually taken before loop_ctl_mutex.
1185
	 */
1186 1187 1188
	if (filp)
		fput(filp);
	return err;
L
Linus Torvalds 已提交
1189 1190
}

1191 1192
static int loop_clr_fd(struct loop_device *lo)
{
1193 1194
	int err;

1195
	err = mutex_lock_killable(&loop_ctl_mutex);
1196 1197 1198 1199
	if (err)
		return err;
	if (lo->lo_state != Lo_bound) {
		mutex_unlock(&loop_ctl_mutex);
1200
		return -ENXIO;
1201
	}
1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217
	/*
	 * If we've explicitly asked to tear down the loop device,
	 * and it has an elevated reference count, set it for auto-teardown when
	 * the last reference goes away. This stops $!~#$@ udev from
	 * preventing teardown because it decided that it needs to run blkid on
	 * the loopback device whenever they appear. xfstests is notorious for
	 * failing tests because blkid via udev races with a losetup
	 * <dev>/do something like mkfs/losetup -d <dev> causing the losetup -d
	 * command to fail with EBUSY.
	 */
	if (atomic_read(&lo->lo_refcnt) > 1) {
		lo->lo_flags |= LO_FLAGS_AUTOCLEAR;
		mutex_unlock(&loop_ctl_mutex);
		return 0;
	}
	lo->lo_state = Lo_rundown;
1218
	mutex_unlock(&loop_ctl_mutex);
1219

1220
	return __loop_clr_fd(lo, false);
1221 1222
}

L
Linus Torvalds 已提交
1223 1224 1225 1226 1227
static int
loop_set_status(struct loop_device *lo, const struct loop_info64 *info)
{
	int err;
	struct loop_func_table *xfer;
1228
	kuid_t uid = current_uid();
1229 1230
	struct block_device *bdev;
	bool partscan = false;
L
Linus Torvalds 已提交
1231

1232
	err = mutex_lock_killable(&loop_ctl_mutex);
1233 1234
	if (err)
		return err;
1235
	if (lo->lo_encrypt_key_size &&
1236
	    !uid_eq(lo->lo_key_owner, uid) &&
1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248
	    !capable(CAP_SYS_ADMIN)) {
		err = -EPERM;
		goto out_unlock;
	}
	if (lo->lo_state != Lo_bound) {
		err = -ENXIO;
		goto out_unlock;
	}
	if ((unsigned int) info->lo_encrypt_key_size > LO_KEY_SIZE) {
		err = -EINVAL;
		goto out_unlock;
	}
L
Linus Torvalds 已提交
1249

1250 1251 1252 1253 1254 1255
	if (lo->lo_offset != info->lo_offset ||
	    lo->lo_sizelimit != info->lo_sizelimit) {
		sync_blockdev(lo->lo_device);
		kill_bdev(lo->lo_device);
	}

1256 1257 1258
	/* I/O need to be drained during transfer transition */
	blk_mq_freeze_queue(lo->lo_queue);

L
Linus Torvalds 已提交
1259 1260
	err = loop_release_xfer(lo);
	if (err)
1261
		goto out_unfreeze;
L
Linus Torvalds 已提交
1262 1263 1264 1265

	if (info->lo_encrypt_type) {
		unsigned int type = info->lo_encrypt_type;

1266 1267
		if (type >= MAX_LO_CRYPT) {
			err = -EINVAL;
1268
			goto out_unfreeze;
1269
		}
L
Linus Torvalds 已提交
1270
		xfer = xfer_funcs[type];
1271 1272
		if (xfer == NULL) {
			err = -EINVAL;
1273
			goto out_unfreeze;
1274
		}
L
Linus Torvalds 已提交
1275 1276 1277 1278 1279
	} else
		xfer = NULL;

	err = loop_init_xfer(lo, xfer, info);
	if (err)
1280
		goto out_unfreeze;
L
Linus Torvalds 已提交
1281 1282

	if (lo->lo_offset != info->lo_offset ||
1283
	    lo->lo_sizelimit != info->lo_sizelimit) {
1284 1285 1286 1287 1288 1289 1290 1291
		/* kill_bdev should have truncated all the pages */
		if (lo->lo_device->bd_inode->i_mapping->nrpages) {
			err = -EAGAIN;
			pr_warn("%s: loop%d (%s) has still dirty pages (nrpages=%lu)\n",
				__func__, lo->lo_number, lo->lo_file_name,
				lo->lo_device->bd_inode->i_mapping->nrpages);
			goto out_unfreeze;
		}
1292
		if (figure_loop_size(lo, info->lo_offset, info->lo_sizelimit)) {
1293
			err = -EFBIG;
1294
			goto out_unfreeze;
1295
		}
1296
	}
1297

1298
	loop_config_discard(lo);
L
Linus Torvalds 已提交
1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309

	memcpy(lo->lo_file_name, info->lo_file_name, LO_NAME_SIZE);
	memcpy(lo->lo_crypt_name, info->lo_crypt_name, LO_NAME_SIZE);
	lo->lo_file_name[LO_NAME_SIZE-1] = 0;
	lo->lo_crypt_name[LO_NAME_SIZE-1] = 0;

	if (!xfer)
		xfer = &none_funcs;
	lo->transfer = xfer->transfer;
	lo->ioctl = xfer->ioctl;

1310 1311 1312 1313
	if ((lo->lo_flags & LO_FLAGS_AUTOCLEAR) !=
	     (info->lo_flags & LO_FLAGS_AUTOCLEAR))
		lo->lo_flags ^= LO_FLAGS_AUTOCLEAR;

L
Linus Torvalds 已提交
1314 1315 1316 1317 1318 1319
	lo->lo_encrypt_key_size = info->lo_encrypt_key_size;
	lo->lo_init[0] = info->lo_init[0];
	lo->lo_init[1] = info->lo_init[1];
	if (info->lo_encrypt_key_size) {
		memcpy(lo->lo_encrypt_key, info->lo_encrypt_key,
		       info->lo_encrypt_key_size);
1320
		lo->lo_key_owner = uid;
1321
	}
L
Linus Torvalds 已提交
1322

1323 1324 1325
	/* update dio if lo_offset or transfer is changed */
	__loop_update_dio(lo, lo->use_dio);

1326
out_unfreeze:
1327
	blk_mq_unfreeze_queue(lo->lo_queue);
O
Omar Sandoval 已提交
1328 1329 1330 1331 1332

	if (!err && (info->lo_flags & LO_FLAGS_PARTSCAN) &&
	     !(lo->lo_flags & LO_FLAGS_PARTSCAN)) {
		lo->lo_flags |= LO_FLAGS_PARTSCAN;
		lo->lo_disk->flags &= ~GENHD_FL_NO_PART_SCAN;
1333 1334
		bdev = lo->lo_device;
		partscan = true;
O
Omar Sandoval 已提交
1335
	}
1336 1337
out_unlock:
	mutex_unlock(&loop_ctl_mutex);
1338 1339
	if (partscan)
		loop_reread_partitions(lo, bdev);
O
Omar Sandoval 已提交
1340

1341
	return err;
L
Linus Torvalds 已提交
1342 1343 1344 1345 1346
}

static int
loop_get_status(struct loop_device *lo, struct loop_info64 *info)
{
1347
	struct path path;
L
Linus Torvalds 已提交
1348
	struct kstat stat;
1349
	int ret;
L
Linus Torvalds 已提交
1350

1351
	ret = mutex_lock_killable(&loop_ctl_mutex);
1352 1353
	if (ret)
		return ret;
1354
	if (lo->lo_state != Lo_bound) {
1355
		mutex_unlock(&loop_ctl_mutex);
L
Linus Torvalds 已提交
1356
		return -ENXIO;
1357 1358
	}

L
Linus Torvalds 已提交
1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372
	memset(info, 0, sizeof(*info));
	info->lo_number = lo->lo_number;
	info->lo_offset = lo->lo_offset;
	info->lo_sizelimit = lo->lo_sizelimit;
	info->lo_flags = lo->lo_flags;
	memcpy(info->lo_file_name, lo->lo_file_name, LO_NAME_SIZE);
	memcpy(info->lo_crypt_name, lo->lo_crypt_name, LO_NAME_SIZE);
	info->lo_encrypt_type =
		lo->lo_encryption ? lo->lo_encryption->number : 0;
	if (lo->lo_encrypt_key_size && capable(CAP_SYS_ADMIN)) {
		info->lo_encrypt_key_size = lo->lo_encrypt_key_size;
		memcpy(info->lo_encrypt_key, lo->lo_encrypt_key,
		       lo->lo_encrypt_key_size);
	}
1373

1374
	/* Drop loop_ctl_mutex while we call into the filesystem. */
1375 1376
	path = lo->lo_backing_file->f_path;
	path_get(&path);
1377
	mutex_unlock(&loop_ctl_mutex);
1378
	ret = vfs_getattr(&path, &stat, STATX_INO, AT_STATX_SYNC_AS_STAT);
1379 1380 1381 1382 1383
	if (!ret) {
		info->lo_device = huge_encode_dev(stat.dev);
		info->lo_inode = stat.ino;
		info->lo_rdevice = huge_encode_dev(stat.rdev);
	}
1384
	path_put(&path);
1385
	return ret;
L
Linus Torvalds 已提交
1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465
}

static void
loop_info64_from_old(const struct loop_info *info, struct loop_info64 *info64)
{
	memset(info64, 0, sizeof(*info64));
	info64->lo_number = info->lo_number;
	info64->lo_device = info->lo_device;
	info64->lo_inode = info->lo_inode;
	info64->lo_rdevice = info->lo_rdevice;
	info64->lo_offset = info->lo_offset;
	info64->lo_sizelimit = 0;
	info64->lo_encrypt_type = info->lo_encrypt_type;
	info64->lo_encrypt_key_size = info->lo_encrypt_key_size;
	info64->lo_flags = info->lo_flags;
	info64->lo_init[0] = info->lo_init[0];
	info64->lo_init[1] = info->lo_init[1];
	if (info->lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
		memcpy(info64->lo_crypt_name, info->lo_name, LO_NAME_SIZE);
	else
		memcpy(info64->lo_file_name, info->lo_name, LO_NAME_SIZE);
	memcpy(info64->lo_encrypt_key, info->lo_encrypt_key, LO_KEY_SIZE);
}

static int
loop_info64_to_old(const struct loop_info64 *info64, struct loop_info *info)
{
	memset(info, 0, sizeof(*info));
	info->lo_number = info64->lo_number;
	info->lo_device = info64->lo_device;
	info->lo_inode = info64->lo_inode;
	info->lo_rdevice = info64->lo_rdevice;
	info->lo_offset = info64->lo_offset;
	info->lo_encrypt_type = info64->lo_encrypt_type;
	info->lo_encrypt_key_size = info64->lo_encrypt_key_size;
	info->lo_flags = info64->lo_flags;
	info->lo_init[0] = info64->lo_init[0];
	info->lo_init[1] = info64->lo_init[1];
	if (info->lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
		memcpy(info->lo_name, info64->lo_crypt_name, LO_NAME_SIZE);
	else
		memcpy(info->lo_name, info64->lo_file_name, LO_NAME_SIZE);
	memcpy(info->lo_encrypt_key, info64->lo_encrypt_key, LO_KEY_SIZE);

	/* error in case values were truncated */
	if (info->lo_device != info64->lo_device ||
	    info->lo_rdevice != info64->lo_rdevice ||
	    info->lo_inode != info64->lo_inode ||
	    info->lo_offset != info64->lo_offset)
		return -EOVERFLOW;

	return 0;
}

static int
loop_set_status_old(struct loop_device *lo, const struct loop_info __user *arg)
{
	struct loop_info info;
	struct loop_info64 info64;

	if (copy_from_user(&info, arg, sizeof (struct loop_info)))
		return -EFAULT;
	loop_info64_from_old(&info, &info64);
	return loop_set_status(lo, &info64);
}

static int
loop_set_status64(struct loop_device *lo, const struct loop_info64 __user *arg)
{
	struct loop_info64 info64;

	if (copy_from_user(&info64, arg, sizeof (struct loop_info64)))
		return -EFAULT;
	return loop_set_status(lo, &info64);
}

static int
loop_get_status_old(struct loop_device *lo, struct loop_info __user *arg) {
	struct loop_info info;
	struct loop_info64 info64;
1466
	int err;
L
Linus Torvalds 已提交
1467

1468
	if (!arg)
1469 1470
		return -EINVAL;
	err = loop_get_status(lo, &info64);
L
Linus Torvalds 已提交
1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481
	if (!err)
		err = loop_info64_to_old(&info64, &info);
	if (!err && copy_to_user(arg, &info, sizeof(info)))
		err = -EFAULT;

	return err;
}

static int
loop_get_status64(struct loop_device *lo, struct loop_info64 __user *arg) {
	struct loop_info64 info64;
1482
	int err;
L
Linus Torvalds 已提交
1483

1484
	if (!arg)
1485 1486
		return -EINVAL;
	err = loop_get_status(lo, &info64);
L
Linus Torvalds 已提交
1487 1488 1489 1490 1491 1492
	if (!err && copy_to_user(arg, &info64, sizeof(info64)))
		err = -EFAULT;

	return err;
}

1493
static int loop_set_capacity(struct loop_device *lo)
1494 1495
{
	if (unlikely(lo->lo_state != Lo_bound))
1496
		return -ENXIO;
1497

1498
	return figure_loop_size(lo, lo->lo_offset, lo->lo_sizelimit);
1499 1500
}

1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514
static int loop_set_dio(struct loop_device *lo, unsigned long arg)
{
	int error = -ENXIO;
	if (lo->lo_state != Lo_bound)
		goto out;

	__loop_update_dio(lo, !!arg);
	if (lo->use_dio == !!arg)
		return 0;
	error = -EINVAL;
 out:
	return error;
}

1515 1516
static int loop_set_block_size(struct loop_device *lo, unsigned long arg)
{
1517 1518
	int err = 0;

1519 1520 1521 1522 1523 1524
	if (lo->lo_state != Lo_bound)
		return -ENXIO;

	if (arg < 512 || arg > PAGE_SIZE || !is_power_of_2(arg))
		return -EINVAL;

1525 1526 1527 1528 1529
	if (lo->lo_queue->limits.logical_block_size != arg) {
		sync_blockdev(lo->lo_device);
		kill_bdev(lo->lo_device);
	}

1530 1531
	blk_mq_freeze_queue(lo->lo_queue);

1532 1533 1534 1535 1536 1537 1538 1539 1540 1541
	/* kill_bdev should have truncated all the pages */
	if (lo->lo_queue->limits.logical_block_size != arg &&
			lo->lo_device->bd_inode->i_mapping->nrpages) {
		err = -EAGAIN;
		pr_warn("%s: loop%d (%s) has still dirty pages (nrpages=%lu)\n",
			__func__, lo->lo_number, lo->lo_file_name,
			lo->lo_device->bd_inode->i_mapping->nrpages);
		goto out_unfreeze;
	}

1542
	blk_queue_logical_block_size(lo->lo_queue, arg);
1543 1544
	blk_queue_physical_block_size(lo->lo_queue, arg);
	blk_queue_io_min(lo->lo_queue, arg);
1545
	loop_update_dio(lo);
1546
out_unfreeze:
1547 1548
	blk_mq_unfreeze_queue(lo->lo_queue);

1549
	return err;
1550 1551
}

1552 1553
static int lo_simple_ioctl(struct loop_device *lo, unsigned int cmd,
			   unsigned long arg)
L
Linus Torvalds 已提交
1554 1555 1556
{
	int err;

1557
	err = mutex_lock_killable(&loop_ctl_mutex);
1558
	if (err)
1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581
		return err;
	switch (cmd) {
	case LOOP_SET_CAPACITY:
		err = loop_set_capacity(lo);
		break;
	case LOOP_SET_DIRECT_IO:
		err = loop_set_dio(lo, arg);
		break;
	case LOOP_SET_BLOCK_SIZE:
		err = loop_set_block_size(lo, arg);
		break;
	default:
		err = lo->ioctl ? lo->ioctl(lo, cmd, arg) : -EINVAL;
	}
	mutex_unlock(&loop_ctl_mutex);
	return err;
}

static int lo_ioctl(struct block_device *bdev, fmode_t mode,
	unsigned int cmd, unsigned long arg)
{
	struct loop_device *lo = bdev->bd_disk->private_data;
	int err;
1582

L
Linus Torvalds 已提交
1583 1584
	switch (cmd) {
	case LOOP_SET_FD:
1585
		return loop_set_fd(lo, mode, bdev, arg);
L
Linus Torvalds 已提交
1586
	case LOOP_CHANGE_FD:
1587
		return loop_change_fd(lo, bdev, arg);
L
Linus Torvalds 已提交
1588
	case LOOP_CLR_FD:
1589
		return loop_clr_fd(lo);
L
Linus Torvalds 已提交
1590
	case LOOP_SET_STATUS:
1591
		err = -EPERM;
1592
		if ((mode & FMODE_WRITE) || capable(CAP_SYS_ADMIN)) {
1593 1594
			err = loop_set_status_old(lo,
					(struct loop_info __user *)arg);
1595
		}
L
Linus Torvalds 已提交
1596 1597
		break;
	case LOOP_GET_STATUS:
1598
		return loop_get_status_old(lo, (struct loop_info __user *) arg);
L
Linus Torvalds 已提交
1599
	case LOOP_SET_STATUS64:
1600
		err = -EPERM;
1601
		if ((mode & FMODE_WRITE) || capable(CAP_SYS_ADMIN)) {
1602 1603
			err = loop_set_status64(lo,
					(struct loop_info64 __user *) arg);
1604
		}
L
Linus Torvalds 已提交
1605 1606
		break;
	case LOOP_GET_STATUS64:
1607
		return loop_get_status64(lo, (struct loop_info64 __user *) arg);
1608
	case LOOP_SET_CAPACITY:
1609
	case LOOP_SET_DIRECT_IO:
1610
	case LOOP_SET_BLOCK_SIZE:
1611 1612 1613
		if (!(mode & FMODE_WRITE) && !capable(CAP_SYS_ADMIN))
			return -EPERM;
		/* Fall through */
L
Linus Torvalds 已提交
1614
	default:
1615 1616
		err = lo_simple_ioctl(lo, cmd, arg);
		break;
L
Linus Torvalds 已提交
1617
	}
1618

L
Linus Torvalds 已提交
1619 1620 1621
	return err;
}

1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642
#ifdef CONFIG_COMPAT
struct compat_loop_info {
	compat_int_t	lo_number;      /* ioctl r/o */
	compat_dev_t	lo_device;      /* ioctl r/o */
	compat_ulong_t	lo_inode;       /* ioctl r/o */
	compat_dev_t	lo_rdevice;     /* ioctl r/o */
	compat_int_t	lo_offset;
	compat_int_t	lo_encrypt_type;
	compat_int_t	lo_encrypt_key_size;    /* ioctl w/o */
	compat_int_t	lo_flags;       /* ioctl r/o */
	char		lo_name[LO_NAME_SIZE];
	unsigned char	lo_encrypt_key[LO_KEY_SIZE]; /* ioctl w/o */
	compat_ulong_t	lo_init[2];
	char		reserved[4];
};

/*
 * Transfer 32-bit compatibility structure in userspace to 64-bit loop info
 * - noinlined to reduce stack space usage in main part of driver
 */
static noinline int
A
Al Viro 已提交
1643
loop_info64_from_compat(const struct compat_loop_info __user *arg,
1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729
			struct loop_info64 *info64)
{
	struct compat_loop_info info;

	if (copy_from_user(&info, arg, sizeof(info)))
		return -EFAULT;

	memset(info64, 0, sizeof(*info64));
	info64->lo_number = info.lo_number;
	info64->lo_device = info.lo_device;
	info64->lo_inode = info.lo_inode;
	info64->lo_rdevice = info.lo_rdevice;
	info64->lo_offset = info.lo_offset;
	info64->lo_sizelimit = 0;
	info64->lo_encrypt_type = info.lo_encrypt_type;
	info64->lo_encrypt_key_size = info.lo_encrypt_key_size;
	info64->lo_flags = info.lo_flags;
	info64->lo_init[0] = info.lo_init[0];
	info64->lo_init[1] = info.lo_init[1];
	if (info.lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
		memcpy(info64->lo_crypt_name, info.lo_name, LO_NAME_SIZE);
	else
		memcpy(info64->lo_file_name, info.lo_name, LO_NAME_SIZE);
	memcpy(info64->lo_encrypt_key, info.lo_encrypt_key, LO_KEY_SIZE);
	return 0;
}

/*
 * Transfer 64-bit loop info to 32-bit compatibility structure in userspace
 * - noinlined to reduce stack space usage in main part of driver
 */
static noinline int
loop_info64_to_compat(const struct loop_info64 *info64,
		      struct compat_loop_info __user *arg)
{
	struct compat_loop_info info;

	memset(&info, 0, sizeof(info));
	info.lo_number = info64->lo_number;
	info.lo_device = info64->lo_device;
	info.lo_inode = info64->lo_inode;
	info.lo_rdevice = info64->lo_rdevice;
	info.lo_offset = info64->lo_offset;
	info.lo_encrypt_type = info64->lo_encrypt_type;
	info.lo_encrypt_key_size = info64->lo_encrypt_key_size;
	info.lo_flags = info64->lo_flags;
	info.lo_init[0] = info64->lo_init[0];
	info.lo_init[1] = info64->lo_init[1];
	if (info.lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
		memcpy(info.lo_name, info64->lo_crypt_name, LO_NAME_SIZE);
	else
		memcpy(info.lo_name, info64->lo_file_name, LO_NAME_SIZE);
	memcpy(info.lo_encrypt_key, info64->lo_encrypt_key, LO_KEY_SIZE);

	/* error in case values were truncated */
	if (info.lo_device != info64->lo_device ||
	    info.lo_rdevice != info64->lo_rdevice ||
	    info.lo_inode != info64->lo_inode ||
	    info.lo_offset != info64->lo_offset ||
	    info.lo_init[0] != info64->lo_init[0] ||
	    info.lo_init[1] != info64->lo_init[1])
		return -EOVERFLOW;

	if (copy_to_user(arg, &info, sizeof(info)))
		return -EFAULT;
	return 0;
}

static int
loop_set_status_compat(struct loop_device *lo,
		       const struct compat_loop_info __user *arg)
{
	struct loop_info64 info64;
	int ret;

	ret = loop_info64_from_compat(arg, &info64);
	if (ret < 0)
		return ret;
	return loop_set_status(lo, &info64);
}

static int
loop_get_status_compat(struct loop_device *lo,
		       struct compat_loop_info __user *arg)
{
	struct loop_info64 info64;
1730
	int err;
1731

1732
	if (!arg)
1733 1734
		return -EINVAL;
	err = loop_get_status(lo, &info64);
1735 1736 1737 1738 1739
	if (!err)
		err = loop_info64_to_compat(&info64, arg);
	return err;
}

A
Al Viro 已提交
1740 1741
static int lo_compat_ioctl(struct block_device *bdev, fmode_t mode,
			   unsigned int cmd, unsigned long arg)
1742
{
A
Al Viro 已提交
1743
	struct loop_device *lo = bdev->bd_disk->private_data;
1744 1745 1746 1747
	int err;

	switch(cmd) {
	case LOOP_SET_STATUS:
1748 1749
		err = loop_set_status_compat(lo,
			     (const struct compat_loop_info __user *)arg);
1750 1751
		break;
	case LOOP_GET_STATUS:
1752 1753
		err = loop_get_status_compat(lo,
				     (struct compat_loop_info __user *)arg);
1754
		break;
1755
	case LOOP_SET_CAPACITY:
1756 1757 1758 1759
	case LOOP_CLR_FD:
	case LOOP_GET_STATUS64:
	case LOOP_SET_STATUS64:
		arg = (unsigned long) compat_ptr(arg);
1760
		/* fall through */
1761 1762
	case LOOP_SET_FD:
	case LOOP_CHANGE_FD:
1763
	case LOOP_SET_BLOCK_SIZE:
A
Al Viro 已提交
1764
		err = lo_ioctl(bdev, mode, cmd, arg);
1765 1766 1767 1768 1769 1770 1771 1772 1773
		break;
	default:
		err = -ENOIOCTLCMD;
		break;
	}
	return err;
}
#endif

A
Al Viro 已提交
1774
static int lo_open(struct block_device *bdev, fmode_t mode)
L
Linus Torvalds 已提交
1775
{
1776
	struct loop_device *lo;
J
Jan Kara 已提交
1777
	int err;
1778

J
Jan Kara 已提交
1779 1780 1781
	err = mutex_lock_killable(&loop_ctl_mutex);
	if (err)
		return err;
1782 1783 1784 1785 1786
	lo = bdev->bd_disk->private_data;
	if (!lo) {
		err = -ENXIO;
		goto out;
	}
L
Linus Torvalds 已提交
1787

1788
	atomic_inc(&lo->lo_refcnt);
1789
out:
J
Jan Kara 已提交
1790
	mutex_unlock(&loop_ctl_mutex);
1791
	return err;
L
Linus Torvalds 已提交
1792 1793
}

1794
static void lo_release(struct gendisk *disk, fmode_t mode)
L
Linus Torvalds 已提交
1795
{
1796
	struct loop_device *lo;
L
Linus Torvalds 已提交
1797

J
Jan Kara 已提交
1798
	mutex_lock(&loop_ctl_mutex);
1799
	lo = disk->private_data;
1800
	if (atomic_dec_return(&lo->lo_refcnt))
J
Jan Kara 已提交
1801
		goto out_unlock;
1802 1803

	if (lo->lo_flags & LO_FLAGS_AUTOCLEAR) {
1804 1805 1806
		if (lo->lo_state != Lo_bound)
			goto out_unlock;
		lo->lo_state = Lo_rundown;
1807
		mutex_unlock(&loop_ctl_mutex);
1808 1809 1810 1811
		/*
		 * In autoclear mode, stop the loop thread
		 * and remove configuration after last close.
		 */
1812
		__loop_clr_fd(lo, true);
1813
		return;
1814
	} else if (lo->lo_state == Lo_bound) {
1815 1816 1817 1818
		/*
		 * Otherwise keep thread (if running) and config,
		 * but flush possible ongoing bios in thread.
		 */
1819 1820
		blk_mq_freeze_queue(lo->lo_queue);
		blk_mq_unfreeze_queue(lo->lo_queue);
1821
	}
1822

J
Jan Kara 已提交
1823
out_unlock:
1824
	mutex_unlock(&loop_ctl_mutex);
1825 1826
}

1827
static const struct block_device_operations lo_fops = {
L
Linus Torvalds 已提交
1828
	.owner =	THIS_MODULE,
A
Al Viro 已提交
1829 1830 1831
	.open =		lo_open,
	.release =	lo_release,
	.ioctl =	lo_ioctl,
1832
#ifdef CONFIG_COMPAT
A
Al Viro 已提交
1833
	.compat_ioctl =	lo_compat_ioctl,
1834
#endif
L
Linus Torvalds 已提交
1835 1836 1837 1838 1839
};

/*
 * And now the modules code and kernel interface.
 */
1840
static int max_loop;
1841
module_param(max_loop, int, 0444);
K
Ken Chen 已提交
1842
MODULE_PARM_DESC(max_loop, "Maximum number of loop devices");
1843
module_param(max_part, int, 0444);
1844
MODULE_PARM_DESC(max_part, "Maximum number of partitions per loop device");
L
Linus Torvalds 已提交
1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857
MODULE_LICENSE("GPL");
MODULE_ALIAS_BLOCKDEV_MAJOR(LOOP_MAJOR);

int loop_register_transfer(struct loop_func_table *funcs)
{
	unsigned int n = funcs->number;

	if (n >= MAX_LO_CRYPT || xfer_funcs[n])
		return -EINVAL;
	xfer_funcs[n] = funcs;
	return 0;
}

1858 1859 1860 1861 1862
static int unregister_transfer_cb(int id, void *ptr, void *data)
{
	struct loop_device *lo = ptr;
	struct loop_func_table *xfer = data;

1863
	mutex_lock(&loop_ctl_mutex);
1864 1865
	if (lo->lo_encryption == xfer)
		loop_release_xfer(lo);
1866
	mutex_unlock(&loop_ctl_mutex);
1867 1868 1869
	return 0;
}

L
Linus Torvalds 已提交
1870 1871 1872 1873 1874 1875 1876 1877 1878
int loop_unregister_transfer(int number)
{
	unsigned int n = number;
	struct loop_func_table *xfer;

	if (n == 0 || n >= MAX_LO_CRYPT || (xfer = xfer_funcs[n]) == NULL)
		return -EINVAL;

	xfer_funcs[n] = NULL;
1879
	idr_for_each(&loop_index_idr, &unregister_transfer_cb, xfer);
L
Linus Torvalds 已提交
1880 1881 1882 1883 1884 1885
	return 0;
}

EXPORT_SYMBOL(loop_register_transfer);
EXPORT_SYMBOL(loop_unregister_transfer);

1886
static blk_status_t loop_queue_rq(struct blk_mq_hw_ctx *hctx,
1887 1888
		const struct blk_mq_queue_data *bd)
{
J
Jens Axboe 已提交
1889 1890 1891
	struct request *rq = bd->rq;
	struct loop_cmd *cmd = blk_mq_rq_to_pdu(rq);
	struct loop_device *lo = rq->q->queuedata;
1892

J
Jens Axboe 已提交
1893
	blk_mq_start_request(rq);
1894

1895
	if (lo->lo_state != Lo_bound)
1896
		return BLK_STS_IOERR;
1897

J
Jens Axboe 已提交
1898
	switch (req_op(rq)) {
1899 1900
	case REQ_OP_FLUSH:
	case REQ_OP_DISCARD:
1901
	case REQ_OP_WRITE_ZEROES:
M
Ming Lei 已提交
1902
		cmd->use_aio = false;
1903 1904 1905 1906 1907
		break;
	default:
		cmd->use_aio = lo->use_dio;
		break;
	}
M
Ming Lei 已提交
1908

S
Shaohua Li 已提交
1909
	/* always use the first bio's css */
S
Shaohua Li 已提交
1910
#ifdef CONFIG_BLK_CGROUP
1911 1912
	if (cmd->use_aio && rq->bio && rq->bio->bi_blkg) {
		cmd->css = &bio_blkcg(rq->bio)->css;
S
Shaohua Li 已提交
1913 1914 1915 1916
		css_get(cmd->css);
	} else
#endif
		cmd->css = NULL;
P
Petr Mladek 已提交
1917
	kthread_queue_work(&lo->worker, &cmd->work);
1918

1919
	return BLK_STS_OK;
1920 1921 1922 1923
}

static void loop_handle_cmd(struct loop_cmd *cmd)
{
J
Jens Axboe 已提交
1924 1925 1926
	struct request *rq = blk_mq_rq_from_pdu(cmd);
	const bool write = op_is_write(req_op(rq));
	struct loop_device *lo = rq->q->queuedata;
1927
	int ret = 0;
1928

1929 1930
	if (write && (lo->lo_flags & LO_FLAGS_READ_ONLY)) {
		ret = -EIO;
1931
		goto failed;
1932
	}
1933

J
Jens Axboe 已提交
1934
	ret = do_req_filebacked(lo, rq);
1935
 failed:
M
Ming Lei 已提交
1936
	/* complete non-aio request */
1937 1938
	if (!cmd->use_aio || ret) {
		cmd->ret = ret ? -EIO : 0;
J
Jens Axboe 已提交
1939
		blk_mq_complete_request(rq);
1940
	}
1941 1942
}

M
Ming Lei 已提交
1943
static void loop_queue_work(struct kthread_work *work)
1944 1945
{
	struct loop_cmd *cmd =
M
Ming Lei 已提交
1946
		container_of(work, struct loop_cmd, work);
1947 1948 1949 1950

	loop_handle_cmd(cmd);
}

1951 1952
static int loop_init_request(struct blk_mq_tag_set *set, struct request *rq,
		unsigned int hctx_idx, unsigned int numa_node)
1953 1954 1955
{
	struct loop_cmd *cmd = blk_mq_rq_to_pdu(rq);

P
Petr Mladek 已提交
1956
	kthread_init_work(&cmd->work, loop_queue_work);
1957 1958 1959
	return 0;
}

1960
static const struct blk_mq_ops loop_mq_ops = {
1961 1962
	.queue_rq       = loop_queue_rq,
	.init_request	= loop_init_request,
1963
	.complete	= lo_complete_rq,
1964 1965
};

1966
static int loop_add(struct loop_device **l, int i)
1967 1968 1969
{
	struct loop_device *lo;
	struct gendisk *disk;
1970
	int err;
1971

1972
	err = -ENOMEM;
1973
	lo = kzalloc(sizeof(*lo), GFP_KERNEL);
1974
	if (!lo)
1975
		goto out;
1976

1977 1978
	lo->lo_state = Lo_unbound;

T
Tejun Heo 已提交
1979
	/* allocate id, if @id >= 0, we're requesting that specific id */
1980
	if (i >= 0) {
T
Tejun Heo 已提交
1981 1982
		err = idr_alloc(&loop_index_idr, lo, i, i + 1, GFP_KERNEL);
		if (err == -ENOSPC)
1983 1984
			err = -EEXIST;
	} else {
T
Tejun Heo 已提交
1985
		err = idr_alloc(&loop_index_idr, lo, 0, 0, GFP_KERNEL);
1986 1987 1988
	}
	if (err < 0)
		goto out_free_dev;
T
Tejun Heo 已提交
1989
	i = err;
1990

1991
	err = -ENOMEM;
1992 1993 1994 1995 1996
	lo->tag_set.ops = &loop_mq_ops;
	lo->tag_set.nr_hw_queues = 1;
	lo->tag_set.queue_depth = 128;
	lo->tag_set.numa_node = NUMA_NO_NODE;
	lo->tag_set.cmd_size = sizeof(struct loop_cmd);
M
Ming Lei 已提交
1997
	lo->tag_set.flags = BLK_MQ_F_SHOULD_MERGE;
1998 1999 2000 2001
	lo->tag_set.driver_data = lo;

	err = blk_mq_alloc_tag_set(&lo->tag_set);
	if (err)
2002
		goto out_free_idr;
2003

2004
	lo->lo_queue = blk_mq_init_queue(&lo->tag_set);
2005
	if (IS_ERR(lo->lo_queue)) {
2006 2007 2008
		err = PTR_ERR(lo->lo_queue);
		goto out_cleanup_tags;
	}
2009 2010
	lo->lo_queue->queuedata = lo;

S
Shaohua Li 已提交
2011
	blk_queue_max_hw_sectors(lo->lo_queue, BLK_DEF_MAX_SECTORS);
2012

2013
	/*
2014 2015 2016 2017
	 * By default, we do buffer IO, so it doesn't make sense to enable
	 * merge because the I/O submitted to backing file is handled page by
	 * page. For directio mode, merge does help to dispatch bigger request
	 * to underlayer disk. We will enable merge once directio is enabled.
2018
	 */
2019
	blk_queue_flag_set(QUEUE_FLAG_NOMERGES, lo->lo_queue);
2020

2021
	err = -ENOMEM;
2022
	disk = lo->lo_disk = alloc_disk(1 << part_shift);
2023 2024 2025
	if (!disk)
		goto out_free_queue;

2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046
	/*
	 * Disable partition scanning by default. The in-kernel partition
	 * scanning can be requested individually per-device during its
	 * setup. Userspace can always add and remove partitions from all
	 * devices. The needed partition minors are allocated from the
	 * extended minor space, the main loop device numbers will continue
	 * to match the loop minors, regardless of the number of partitions
	 * used.
	 *
	 * If max_part is given, partition scanning is globally enabled for
	 * all loop devices. The minors for the main loop devices will be
	 * multiples of max_part.
	 *
	 * Note: Global-for-all-devices, set-only-at-init, read-only module
	 * parameteters like 'max_loop' and 'max_part' make things needlessly
	 * complicated, are too static, inflexible and may surprise
	 * userspace tools. Parameters like this in general should be avoided.
	 */
	if (!part_shift)
		disk->flags |= GENHD_FL_NO_PART_SCAN;
	disk->flags |= GENHD_FL_EXT_DEVT;
2047
	atomic_set(&lo->lo_refcnt, 0);
2048 2049 2050
	lo->lo_number		= i;
	spin_lock_init(&lo->lo_lock);
	disk->major		= LOOP_MAJOR;
2051
	disk->first_minor	= i << part_shift;
2052 2053 2054 2055
	disk->fops		= &lo_fops;
	disk->private_data	= lo;
	disk->queue		= lo->lo_queue;
	sprintf(disk->disk_name, "loop%d", i);
2056 2057 2058
	add_disk(disk);
	*l = lo;
	return lo->lo_number;
2059 2060 2061

out_free_queue:
	blk_cleanup_queue(lo->lo_queue);
2062 2063
out_cleanup_tags:
	blk_mq_free_tag_set(&lo->tag_set);
2064 2065
out_free_idr:
	idr_remove(&loop_index_idr, i);
2066 2067 2068
out_free_dev:
	kfree(lo);
out:
2069
	return err;
2070 2071
}

2072
static void loop_remove(struct loop_device *lo)
L
Linus Torvalds 已提交
2073
{
2074
	del_gendisk(lo->lo_disk);
2075
	blk_cleanup_queue(lo->lo_queue);
2076
	blk_mq_free_tag_set(&lo->tag_set);
2077 2078 2079
	put_disk(lo->lo_disk);
	kfree(lo);
}
L
Linus Torvalds 已提交
2080

2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092
static int find_free_cb(int id, void *ptr, void *data)
{
	struct loop_device *lo = ptr;
	struct loop_device **l = data;

	if (lo->lo_state == Lo_unbound) {
		*l = lo;
		return 1;
	}
	return 0;
}

2093
static int loop_lookup(struct loop_device **l, int i)
K
Ken Chen 已提交
2094 2095
{
	struct loop_device *lo;
2096
	int ret = -ENODEV;
K
Ken Chen 已提交
2097

2098 2099 2100 2101 2102 2103 2104 2105 2106
	if (i < 0) {
		int err;

		err = idr_for_each(&loop_index_idr, &find_free_cb, &lo);
		if (err == 1) {
			*l = lo;
			ret = lo->lo_number;
		}
		goto out;
K
Ken Chen 已提交
2107 2108
	}

2109
	/* lookup and return a specific i */
2110
	lo = idr_find(&loop_index_idr, i);
K
Ken Chen 已提交
2111
	if (lo) {
2112 2113
		*l = lo;
		ret = lo->lo_number;
K
Ken Chen 已提交
2114
	}
2115
out:
2116
	return ret;
K
Ken Chen 已提交
2117 2118
}

2119 2120
static struct kobject *loop_probe(dev_t dev, int *part, void *data)
{
A
Al Viro 已提交
2121
	struct loop_device *lo;
2122
	struct kobject *kobj;
2123
	int err;
2124

J
Jan Kara 已提交
2125
	mutex_lock(&loop_ctl_mutex);
2126 2127 2128 2129
	err = loop_lookup(&lo, MINOR(dev) >> part_shift);
	if (err < 0)
		err = loop_add(&lo, MINOR(dev) >> part_shift);
	if (err < 0)
2130
		kobj = NULL;
2131
	else
2132
		kobj = get_disk_and_module(lo->lo_disk);
J
Jan Kara 已提交
2133
	mutex_unlock(&loop_ctl_mutex);
2134 2135

	*part = 0;
2136
	return kobj;
2137 2138
}

2139 2140 2141 2142
static long loop_control_ioctl(struct file *file, unsigned int cmd,
			       unsigned long parm)
{
	struct loop_device *lo;
J
Jan Kara 已提交
2143
	int ret;
2144

J
Jan Kara 已提交
2145 2146 2147 2148 2149
	ret = mutex_lock_killable(&loop_ctl_mutex);
	if (ret)
		return ret;

	ret = -ENOSYS;
2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166
	switch (cmd) {
	case LOOP_CTL_ADD:
		ret = loop_lookup(&lo, parm);
		if (ret >= 0) {
			ret = -EEXIST;
			break;
		}
		ret = loop_add(&lo, parm);
		break;
	case LOOP_CTL_REMOVE:
		ret = loop_lookup(&lo, parm);
		if (ret < 0)
			break;
		if (lo->lo_state != Lo_unbound) {
			ret = -EBUSY;
			break;
		}
2167
		if (atomic_read(&lo->lo_refcnt) > 0) {
2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180
			ret = -EBUSY;
			break;
		}
		lo->lo_disk->private_data = NULL;
		idr_remove(&loop_index_idr, lo->lo_number);
		loop_remove(lo);
		break;
	case LOOP_CTL_GET_FREE:
		ret = loop_lookup(&lo, -1);
		if (ret >= 0)
			break;
		ret = loop_add(&lo, -1);
	}
J
Jan Kara 已提交
2181
	mutex_unlock(&loop_ctl_mutex);
2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202

	return ret;
}

static const struct file_operations loop_ctl_fops = {
	.open		= nonseekable_open,
	.unlocked_ioctl	= loop_control_ioctl,
	.compat_ioctl	= loop_control_ioctl,
	.owner		= THIS_MODULE,
	.llseek		= noop_llseek,
};

static struct miscdevice loop_misc = {
	.minor		= LOOP_CTRL_MINOR,
	.name		= "loop-control",
	.fops		= &loop_ctl_fops,
};

MODULE_ALIAS_MISCDEV(LOOP_CTRL_MINOR);
MODULE_ALIAS("devname:loop-control");

2203 2204
static int __init loop_init(void)
{
K
Ken Chen 已提交
2205 2206
	int i, nr;
	unsigned long range;
2207
	struct loop_device *lo;
2208
	int err;
K
Ken Chen 已提交
2209

2210
	part_shift = 0;
N
Namhyung Kim 已提交
2211
	if (max_part > 0) {
2212 2213
		part_shift = fls(max_part);

N
Namhyung Kim 已提交
2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224
		/*
		 * Adjust max_part according to part_shift as it is exported
		 * to user space so that user can decide correct minor number
		 * if [s]he want to create more devices.
		 *
		 * Note that -1 is required because partition 0 is reserved
		 * for the whole disk.
		 */
		max_part = (1UL << part_shift) - 1;
	}

2225 2226
	if ((1UL << part_shift) > DISK_MAX_PARTS) {
		err = -EINVAL;
2227
		goto err_out;
2228
	}
2229

2230 2231
	if (max_loop > 1UL << (MINORBITS - part_shift)) {
		err = -EINVAL;
2232
		goto err_out;
2233
	}
L
Linus Torvalds 已提交
2234

2235 2236 2237 2238 2239 2240 2241 2242
	/*
	 * If max_loop is specified, create that many devices upfront.
	 * This also becomes a hard limit. If max_loop is not specified,
	 * create CONFIG_BLK_DEV_LOOP_MIN_COUNT loop devices at module
	 * init time. Loop devices can be requested on-demand with the
	 * /dev/loop-control interface, or be instantiated by accessing
	 * a 'dead' device node.
	 */
2243
	if (max_loop) {
K
Ken Chen 已提交
2244
		nr = max_loop;
2245
		range = max_loop << part_shift;
K
Ken Chen 已提交
2246
	} else {
2247
		nr = CONFIG_BLK_DEV_LOOP_MIN_COUNT;
2248
		range = 1UL << MINORBITS;
K
Ken Chen 已提交
2249 2250
	}

2251 2252 2253 2254 2255
	err = misc_register(&loop_misc);
	if (err < 0)
		goto err_out;


2256 2257 2258 2259
	if (register_blkdev(LOOP_MAJOR, "loop")) {
		err = -EIO;
		goto misc_out;
	}
L
Linus Torvalds 已提交
2260

K
Ken Chen 已提交
2261 2262 2263
	blk_register_region(MKDEV(LOOP_MAJOR, 0), range,
				  THIS_MODULE, loop_probe, NULL, NULL);

2264
	/* pre-create number of devices given by config or max_loop */
J
Jan Kara 已提交
2265
	mutex_lock(&loop_ctl_mutex);
2266 2267
	for (i = 0; i < nr; i++)
		loop_add(&lo, i);
J
Jan Kara 已提交
2268
	mutex_unlock(&loop_ctl_mutex);
2269

2270
	printk(KERN_INFO "loop: module loaded\n");
L
Linus Torvalds 已提交
2271
	return 0;
2272 2273 2274

misc_out:
	misc_deregister(&loop_misc);
2275
err_out:
2276
	return err;
2277
}
K
Ken Chen 已提交
2278

2279 2280 2281
static int loop_exit_cb(int id, void *ptr, void *data)
{
	struct loop_device *lo = ptr;
K
Ken Chen 已提交
2282

2283 2284
	loop_remove(lo);
	return 0;
L
Linus Torvalds 已提交
2285 2286
}

2287
static void __exit loop_exit(void)
L
Linus Torvalds 已提交
2288
{
K
Ken Chen 已提交
2289
	unsigned long range;
L
Linus Torvalds 已提交
2290

2291
	range = max_loop ? max_loop << part_shift : 1UL << MINORBITS;
K
Ken Chen 已提交
2292

2293 2294
	idr_for_each(&loop_index_idr, &loop_exit_cb, NULL);
	idr_destroy(&loop_index_idr);
2295

K
Ken Chen 已提交
2296
	blk_unregister_region(MKDEV(LOOP_MAJOR, 0), range);
2297
	unregister_blkdev(LOOP_MAJOR, "loop");
2298 2299

	misc_deregister(&loop_misc);
L
Linus Torvalds 已提交
2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313
}

module_init(loop_init);
module_exit(loop_exit);

#ifndef MODULE
static int __init max_loop_setup(char *str)
{
	max_loop = simple_strtol(str, NULL, 0);
	return 1;
}

__setup("max_loop=", max_loop_setup);
#endif