loop: don't call into filesystem while holding lo_ctl_mutex
[linux-block.git] / drivers / block / loop.c
CommitLineData
1da177e4
LT
1/*
2 * linux/drivers/block/loop.c
3 *
4 * Written by Theodore Ts'o, 3/29/93
5 *
6 * Copyright 1993 by Theodore Ts'o. Redistribution of this file is
7 * permitted under the GNU General Public License.
8 *
9 * DES encryption plus some minor changes by Werner Almesberger, 30-MAY-1993
10 * more DES encryption plus IDEA encryption by Nicholas J. Leon, June 20, 1996
11 *
12 * Modularized and updated for 1.1.16 kernel - Mitch Dsouza 28th May 1994
13 * Adapted for 1.3.59 kernel - Andries Brouwer, 1 Feb 1996
14 *
15 * Fixed do_loop_request() re-entrancy - Vincent.Renardias@waw.com Mar 20, 1997
16 *
17 * Added devfs support - Richard Gooch <rgooch@atnf.csiro.au> 16-Jan-1998
18 *
19 * Handle sparse backing files correctly - Kenn Humborg, Jun 28, 1998
20 *
21 * Loadable modules and other fixes by AK, 1998
22 *
23 * Make real block number available to downstream transfer functions, enables
24 * CBC (and relatives) mode encryption requiring unique IVs per data block.
25 * Reed H. Petty, rhp@draper.net
26 *
27 * Maximum number of loop devices now dynamic via max_loop module parameter.
28 * Russell Kroll <rkroll@exploits.org> 19990701
29 *
30 * Maximum number of loop devices when compiled-in now selectable by passing
31 * max_loop=<1-255> to the kernel on boot.
96de0e25 32 * Erik I. Bolsø, <eriki@himolde.no>, Oct 31, 1999
1da177e4
LT
33 *
34 * Completely rewrite request handling to be make_request_fn style and
35 * non blocking, pushing work to a helper thread. Lots of fixes from
36 * Al Viro too.
37 * Jens Axboe <axboe@suse.de>, Nov 2000
38 *
39 * Support up to 256 loop devices
40 * Heinz Mauelshagen <mge@sistina.com>, Feb 2002
41 *
42 * Support for falling back on the write file operation when the address space
4e02ed4b 43 * operations write_begin is not available on the backing filesystem.
1da177e4
LT
44 * Anton Altaparmakov, 16 Feb 2005
45 *
46 * Still To Fix:
47 * - Advisory locking is ignored here.
48 * - Should use an own CAP_* category instead of CAP_SYS_ADMIN
49 *
50 */
51
1da177e4
LT
52#include <linux/module.h>
53#include <linux/moduleparam.h>
54#include <linux/sched.h>
55#include <linux/fs.h>
56#include <linux/file.h>
57#include <linux/stat.h>
58#include <linux/errno.h>
59#include <linux/major.h>
60#include <linux/wait.h>
61#include <linux/blkdev.h>
62#include <linux/blkpg.h>
63#include <linux/init.h>
1da177e4
LT
64#include <linux/swap.h>
65#include <linux/slab.h>
863d5b82 66#include <linux/compat.h>
1da177e4 67#include <linux/suspend.h>
83144186 68#include <linux/freezer.h>
2a48fc0a 69#include <linux/mutex.h>
1da177e4 70#include <linux/writeback.h>
1da177e4
LT
71#include <linux/completion.h>
72#include <linux/highmem.h>
6c997918 73#include <linux/kthread.h>
d6b29d7c 74#include <linux/splice.h>
ee862730 75#include <linux/sysfs.h>
770fe30a 76#include <linux/miscdevice.h>
dfaa2ef6 77#include <linux/falloc.h>
283e7e5d 78#include <linux/uio.h>
83a87611 79#include "loop.h"
1da177e4 80
7c0f6ba6 81#include <linux/uaccess.h>
1da177e4 82
34dd82af
KS
83static DEFINE_IDR(loop_index_idr);
84static DEFINE_MUTEX(loop_index_mutex);
1da177e4 85
476a4813
LV
86static int max_part;
87static int part_shift;
88
1da177e4
LT
89static int transfer_xor(struct loop_device *lo, int cmd,
90 struct page *raw_page, unsigned raw_off,
91 struct page *loop_page, unsigned loop_off,
92 int size, sector_t real_block)
93{
cfd8005c
CW
94 char *raw_buf = kmap_atomic(raw_page) + raw_off;
95 char *loop_buf = kmap_atomic(loop_page) + loop_off;
1da177e4
LT
96 char *in, *out, *key;
97 int i, keysize;
98
99 if (cmd == READ) {
100 in = raw_buf;
101 out = loop_buf;
102 } else {
103 in = loop_buf;
104 out = raw_buf;
105 }
106
107 key = lo->lo_encrypt_key;
108 keysize = lo->lo_encrypt_key_size;
109 for (i = 0; i < size; i++)
110 *out++ = *in++ ^ key[(i & 511) % keysize];
111
cfd8005c
CW
112 kunmap_atomic(loop_buf);
113 kunmap_atomic(raw_buf);
1da177e4
LT
114 cond_resched();
115 return 0;
116}
117
118static int xor_init(struct loop_device *lo, const struct loop_info64 *info)
119{
120 if (unlikely(info->lo_encrypt_key_size <= 0))
121 return -EINVAL;
122 return 0;
123}
124
125static struct loop_func_table none_funcs = {
126 .number = LO_CRYPT_NONE,
aa4d8616 127};
1da177e4
LT
128
129static struct loop_func_table xor_funcs = {
130 .number = LO_CRYPT_XOR,
131 .transfer = transfer_xor,
132 .init = xor_init
aa4d8616 133};
1da177e4
LT
134
135/* xfer_funcs[0] is special - its release function is never called */
136static struct loop_func_table *xfer_funcs[MAX_LO_CRYPT] = {
137 &none_funcs,
138 &xor_funcs
139};
140
7035b5df 141static loff_t get_size(loff_t offset, loff_t sizelimit, struct file *file)
1da177e4 142{
b7a1da69 143 loff_t loopsize;
1da177e4
LT
144
145 /* Compute loopsize in bytes */
b7a1da69
GC
146 loopsize = i_size_read(file->f_mapping->host);
147 if (offset > 0)
148 loopsize -= offset;
149 /* offset is beyond i_size, weird but possible */
7035b5df
DM
150 if (loopsize < 0)
151 return 0;
1da177e4 152
7035b5df
DM
153 if (sizelimit > 0 && sizelimit < loopsize)
154 loopsize = sizelimit;
1da177e4
LT
155 /*
156 * Unfortunately, if we want to do I/O on the device,
157 * the number of 512-byte sectors has to fit into a sector_t.
158 */
159 return loopsize >> 9;
160}
161
7035b5df
DM
162static loff_t get_loop_size(struct loop_device *lo, struct file *file)
163{
164 return get_size(lo->lo_offset, lo->lo_sizelimit, file);
165}
166
2e5ab5f3
ML
167static void __loop_update_dio(struct loop_device *lo, bool dio)
168{
169 struct file *file = lo->lo_backing_file;
170 struct address_space *mapping = file->f_mapping;
171 struct inode *inode = mapping->host;
172 unsigned short sb_bsize = 0;
173 unsigned dio_align = 0;
174 bool use_dio;
175
176 if (inode->i_sb->s_bdev) {
177 sb_bsize = bdev_logical_block_size(inode->i_sb->s_bdev);
178 dio_align = sb_bsize - 1;
179 }
180
181 /*
182 * We support direct I/O only if lo_offset is aligned with the
183 * logical I/O size of backing device, and the logical block
184 * size of loop is bigger than the backing device's and the loop
185 * needn't transform transfer.
186 *
187 * TODO: the above condition may be loosed in the future, and
188 * direct I/O may be switched runtime at that time because most
89d790ab 189 * of requests in sane applications should be PAGE_SIZE aligned
2e5ab5f3
ML
190 */
191 if (dio) {
192 if (queue_logical_block_size(lo->lo_queue) >= sb_bsize &&
193 !(lo->lo_offset & dio_align) &&
194 mapping->a_ops->direct_IO &&
195 !lo->transfer)
196 use_dio = true;
197 else
198 use_dio = false;
199 } else {
200 use_dio = false;
201 }
202
203 if (lo->use_dio == use_dio)
204 return;
205
206 /* flush dirty pages before changing direct IO */
207 vfs_fsync(file, 0);
208
209 /*
210 * The flag of LO_FLAGS_DIRECT_IO is handled similarly with
211 * LO_FLAGS_READ_ONLY, both are set from kernel, and losetup
212 * will get updated by ioctl(LOOP_GET_STATUS)
213 */
214 blk_mq_freeze_queue(lo->lo_queue);
215 lo->use_dio = use_dio;
40326d8a 216 if (use_dio) {
8b904b5b 217 blk_queue_flag_clear(QUEUE_FLAG_NOMERGES, lo->lo_queue);
2e5ab5f3 218 lo->lo_flags |= LO_FLAGS_DIRECT_IO;
40326d8a 219 } else {
8b904b5b 220 blk_queue_flag_set(QUEUE_FLAG_NOMERGES, lo->lo_queue);
2e5ab5f3 221 lo->lo_flags &= ~LO_FLAGS_DIRECT_IO;
40326d8a 222 }
2e5ab5f3
ML
223 blk_mq_unfreeze_queue(lo->lo_queue);
224}
225
1da177e4 226static int
1e6ec9ea 227figure_loop_size(struct loop_device *lo, loff_t offset, loff_t sizelimit)
1da177e4 228{
7035b5df 229 loff_t size = get_size(offset, sizelimit, lo->lo_backing_file);
1da177e4 230 sector_t x = (sector_t)size;
7b0576a3 231 struct block_device *bdev = lo->lo_device;
1da177e4
LT
232
233 if (unlikely((loff_t)x != size))
234 return -EFBIG;
7035b5df
DM
235 if (lo->lo_offset != offset)
236 lo->lo_offset = offset;
237 if (lo->lo_sizelimit != sizelimit)
238 lo->lo_sizelimit = sizelimit;
73285082 239 set_capacity(lo->lo_disk, x);
7b0576a3
GC
240 bd_set_size(bdev, (loff_t)get_capacity(bdev->bd_disk) << 9);
241 /* let user-space know about the new size */
242 kobject_uevent(&disk_to_dev(bdev->bd_disk)->kobj, KOBJ_CHANGE);
7035b5df 243 return 0;
1da177e4
LT
244}
245
246static inline int
247lo_do_transfer(struct loop_device *lo, int cmd,
248 struct page *rpage, unsigned roffs,
249 struct page *lpage, unsigned loffs,
250 int size, sector_t rblock)
251{
aa4d8616
CH
252 int ret;
253
254 ret = lo->transfer(lo, cmd, rpage, roffs, lpage, loffs, size, rblock);
255 if (likely(!ret))
1da177e4
LT
256 return 0;
257
aa4d8616
CH
258 printk_ratelimited(KERN_ERR
259 "loop: Transfer error at byte offset %llu, length %i.\n",
260 (unsigned long long)rblock << 9, size);
261 return ret;
1da177e4
LT
262}
263
aa4d8616 264static int lo_write_bvec(struct file *file, struct bio_vec *bvec, loff_t *ppos)
1da177e4 265{
aa4d8616 266 struct iov_iter i;
1da177e4 267 ssize_t bw;
283e7e5d 268
aa4d8616 269 iov_iter_bvec(&i, ITER_BVEC, bvec, 1, bvec->bv_len);
1da177e4 270
03d95eb2 271 file_start_write(file);
abbb6589 272 bw = vfs_iter_write(file, &i, ppos, 0);
03d95eb2 273 file_end_write(file);
aa4d8616
CH
274
275 if (likely(bw == bvec->bv_len))
1da177e4 276 return 0;
aa4d8616
CH
277
278 printk_ratelimited(KERN_ERR
279 "loop: Write error at byte offset %llu, length %i.\n",
280 (unsigned long long)*ppos, bvec->bv_len);
1da177e4
LT
281 if (bw >= 0)
282 bw = -EIO;
283 return bw;
284}
285
aa4d8616
CH
286static int lo_write_simple(struct loop_device *lo, struct request *rq,
287 loff_t pos)
1da177e4 288{
aa4d8616
CH
289 struct bio_vec bvec;
290 struct req_iterator iter;
291 int ret = 0;
292
293 rq_for_each_segment(bvec, rq, iter) {
294 ret = lo_write_bvec(lo->lo_backing_file, &bvec, &pos);
295 if (ret < 0)
296 break;
297 cond_resched();
298 }
299
300 return ret;
1da177e4
LT
301}
302
aa4d8616 303/*
456be148
CH
304 * This is the slow, transforming version that needs to double buffer the
305 * data as it cannot do the transformations in place without having direct
306 * access to the destination pages of the backing file.
1da177e4 307 */
aa4d8616
CH
308static int lo_write_transfer(struct loop_device *lo, struct request *rq,
309 loff_t pos)
1da177e4 310{
aa4d8616 311 struct bio_vec bvec, b;
30112013 312 struct req_iterator iter;
aa4d8616 313 struct page *page;
7988613b 314 int ret = 0;
1da177e4 315
aa4d8616
CH
316 page = alloc_page(GFP_NOIO);
317 if (unlikely(!page))
318 return -ENOMEM;
456be148 319
30112013 320 rq_for_each_segment(bvec, rq, iter) {
aa4d8616
CH
321 ret = lo_do_transfer(lo, WRITE, page, 0, bvec.bv_page,
322 bvec.bv_offset, bvec.bv_len, pos >> 9);
323 if (unlikely(ret))
324 break;
325
326 b.bv_page = page;
327 b.bv_offset = 0;
328 b.bv_len = bvec.bv_len;
329 ret = lo_write_bvec(lo->lo_backing_file, &b, &pos);
1da177e4
LT
330 if (ret < 0)
331 break;
1da177e4 332 }
aa4d8616
CH
333
334 __free_page(page);
1da177e4 335 return ret;
1da177e4
LT
336}
337
aa4d8616
CH
338static int lo_read_simple(struct loop_device *lo, struct request *rq,
339 loff_t pos)
1da177e4 340{
aa4d8616
CH
341 struct bio_vec bvec;
342 struct req_iterator iter;
343 struct iov_iter i;
344 ssize_t len;
1da177e4 345
aa4d8616
CH
346 rq_for_each_segment(bvec, rq, iter) {
347 iov_iter_bvec(&i, ITER_BVEC, &bvec, 1, bvec.bv_len);
18e9710e 348 len = vfs_iter_read(lo->lo_backing_file, &i, &pos, 0);
aa4d8616
CH
349 if (len < 0)
350 return len;
1da177e4 351
aa4d8616 352 flush_dcache_page(bvec.bv_page);
fd582140 353
aa4d8616
CH
354 if (len != bvec.bv_len) {
355 struct bio *bio;
1da177e4 356
aa4d8616
CH
357 __rq_for_each_bio(bio, rq)
358 zero_fill_bio(bio);
359 break;
360 }
361 cond_resched();
362 }
363
364 return 0;
fd582140
JA
365}
366
aa4d8616
CH
367static int lo_read_transfer(struct loop_device *lo, struct request *rq,
368 loff_t pos)
1da177e4 369{
aa4d8616
CH
370 struct bio_vec bvec, b;
371 struct req_iterator iter;
372 struct iov_iter i;
373 struct page *page;
374 ssize_t len;
375 int ret = 0;
1da177e4 376
aa4d8616
CH
377 page = alloc_page(GFP_NOIO);
378 if (unlikely(!page))
379 return -ENOMEM;
fd582140 380
aa4d8616
CH
381 rq_for_each_segment(bvec, rq, iter) {
382 loff_t offset = pos;
fd582140 383
aa4d8616
CH
384 b.bv_page = page;
385 b.bv_offset = 0;
386 b.bv_len = bvec.bv_len;
fd582140 387
aa4d8616 388 iov_iter_bvec(&i, ITER_BVEC, &b, 1, b.bv_len);
18e9710e 389 len = vfs_iter_read(lo->lo_backing_file, &i, &pos, 0);
aa4d8616
CH
390 if (len < 0) {
391 ret = len;
392 goto out_free_page;
393 }
1da177e4 394
aa4d8616
CH
395 ret = lo_do_transfer(lo, READ, page, 0, bvec.bv_page,
396 bvec.bv_offset, len, offset >> 9);
397 if (ret)
398 goto out_free_page;
1da177e4 399
aa4d8616 400 flush_dcache_page(bvec.bv_page);
306df071 401
aa4d8616 402 if (len != bvec.bv_len) {
30112013
ML
403 struct bio *bio;
404
405 __rq_for_each_bio(bio, rq)
406 zero_fill_bio(bio);
1da177e4 407 break;
306df071 408 }
1da177e4 409 }
aa4d8616
CH
410
411 ret = 0;
412out_free_page:
413 __free_page(page);
414 return ret;
1da177e4
LT
415}
416
cf655d95
ML
417static int lo_discard(struct loop_device *lo, struct request *rq, loff_t pos)
418{
419 /*
420 * We use punch hole to reclaim the free space used by the
421 * image a.k.a. discard. However we do not support discard if
422 * encryption is enabled, because it may give an attacker
423 * useful information.
424 */
425 struct file *file = lo->lo_backing_file;
426 int mode = FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE;
427 int ret;
428
429 if ((!file->f_op->fallocate) || lo->lo_encrypt_key_size) {
430 ret = -EOPNOTSUPP;
431 goto out;
432 }
433
434 ret = file->f_op->fallocate(file, mode, pos, blk_rq_bytes(rq));
435 if (unlikely(ret && ret != -EINVAL && ret != -EOPNOTSUPP))
436 ret = -EIO;
437 out:
438 return ret;
439}
440
441static int lo_req_flush(struct loop_device *lo, struct request *rq)
442{
443 struct file *file = lo->lo_backing_file;
444 int ret = vfs_fsync(file, 0);
445 if (unlikely(ret && ret != -EINVAL))
446 ret = -EIO;
447
448 return ret;
449}
450
fe2cb290 451static void lo_complete_rq(struct request *rq)
bc07c10a 452{
fe2cb290 453 struct loop_cmd *cmd = blk_mq_rq_to_pdu(rq);
bc07c10a 454
fe2cb290
CH
455 if (unlikely(req_op(cmd->rq) == REQ_OP_READ && cmd->use_aio &&
456 cmd->ret >= 0 && cmd->ret < blk_rq_bytes(cmd->rq))) {
bc07c10a
ML
457 struct bio *bio = cmd->rq->bio;
458
fe2cb290 459 bio_advance(bio, cmd->ret);
bc07c10a
ML
460 zero_fill_bio(bio);
461 }
fe2cb290 462
2a842aca 463 blk_mq_end_request(rq, cmd->ret < 0 ? BLK_STS_IOERR : BLK_STS_OK);
bc07c10a
ML
464}
465
92d77332
SL
466static void lo_rw_aio_do_completion(struct loop_cmd *cmd)
467{
468 if (!atomic_dec_and_test(&cmd->ref))
469 return;
470 kfree(cmd->bvec);
471 cmd->bvec = NULL;
472 blk_mq_complete_request(cmd->rq);
473}
474
bc07c10a
ML
475static void lo_rw_aio_complete(struct kiocb *iocb, long ret, long ret2)
476{
477 struct loop_cmd *cmd = container_of(iocb, struct loop_cmd, iocb);
bc07c10a 478
d4478e92
SL
479 if (cmd->css)
480 css_put(cmd->css);
fe2cb290 481 cmd->ret = ret;
92d77332 482 lo_rw_aio_do_completion(cmd);
bc07c10a
ML
483}
484
485static int lo_rw_aio(struct loop_device *lo, struct loop_cmd *cmd,
486 loff_t pos, bool rw)
487{
488 struct iov_iter iter;
489 struct bio_vec *bvec;
40326d8a
SL
490 struct request *rq = cmd->rq;
491 struct bio *bio = rq->bio;
bc07c10a 492 struct file *file = lo->lo_backing_file;
40326d8a
SL
493 unsigned int offset;
494 int segments = 0;
bc07c10a
ML
495 int ret;
496
40326d8a
SL
497 if (rq->bio != rq->biotail) {
498 struct req_iterator iter;
499 struct bio_vec tmp;
500
501 __rq_for_each_bio(bio, rq)
502 segments += bio_segments(bio);
503 bvec = kmalloc(sizeof(struct bio_vec) * segments, GFP_NOIO);
504 if (!bvec)
505 return -EIO;
506 cmd->bvec = bvec;
507
508 /*
509 * The bios of the request may be started from the middle of
510 * the 'bvec' because of bio splitting, so we can't directly
511 * copy bio->bi_iov_vec to new bvec. The rq_for_each_segment
512 * API will take care of all details for us.
513 */
514 rq_for_each_segment(tmp, rq, iter) {
515 *bvec = tmp;
516 bvec++;
517 }
518 bvec = cmd->bvec;
519 offset = 0;
520 } else {
521 /*
522 * Same here, this bio may be started from the middle of the
523 * 'bvec' because of bio splitting, so offset from the bvec
524 * must be passed to iov iterator
525 */
526 offset = bio->bi_iter.bi_bvec_done;
527 bvec = __bvec_iter_bvec(bio->bi_io_vec, bio->bi_iter);
528 segments = bio_segments(bio);
529 }
92d77332 530 atomic_set(&cmd->ref, 2);
bc07c10a 531
bc07c10a 532 iov_iter_bvec(&iter, ITER_BVEC | rw, bvec,
40326d8a
SL
533 segments, blk_rq_bytes(rq));
534 iter.iov_offset = offset;
bc07c10a
ML
535
536 cmd->iocb.ki_pos = pos;
537 cmd->iocb.ki_filp = file;
538 cmd->iocb.ki_complete = lo_rw_aio_complete;
539 cmd->iocb.ki_flags = IOCB_DIRECT;
d4478e92
SL
540 if (cmd->css)
541 kthread_associate_blkcg(cmd->css);
bc07c10a
ML
542
543 if (rw == WRITE)
bb7462b6 544 ret = call_write_iter(file, &cmd->iocb, &iter);
bc07c10a 545 else
bb7462b6 546 ret = call_read_iter(file, &cmd->iocb, &iter);
bc07c10a 547
92d77332 548 lo_rw_aio_do_completion(cmd);
d4478e92 549 kthread_associate_blkcg(NULL);
92d77332 550
bc07c10a
ML
551 if (ret != -EIOCBQUEUED)
552 cmd->iocb.ki_complete(&cmd->iocb, ret, 0);
553 return 0;
554}
555
c1c87c2b 556static int do_req_filebacked(struct loop_device *lo, struct request *rq)
bc07c10a
ML
557{
558 struct loop_cmd *cmd = blk_mq_rq_to_pdu(rq);
c1c87c2b 559 loff_t pos = ((loff_t) blk_rq_pos(rq) << 9) + lo->lo_offset;
bc07c10a
ML
560
561 /*
562 * lo_write_simple and lo_read_simple should have been covered
563 * by io submit style function like lo_rw_aio(), one blocker
564 * is that lo_read_simple() need to call flush_dcache_page after
565 * the page is written from kernel, and it isn't easy to handle
566 * this in io submit style function which submits all segments
567 * of the req at one time. And direct read IO doesn't need to
568 * run flush_dcache_page().
569 */
c1c87c2b
CH
570 switch (req_op(rq)) {
571 case REQ_OP_FLUSH:
572 return lo_req_flush(lo, rq);
573 case REQ_OP_DISCARD:
19372e27 574 case REQ_OP_WRITE_ZEROES:
c1c87c2b
CH
575 return lo_discard(lo, rq, pos);
576 case REQ_OP_WRITE:
577 if (lo->transfer)
578 return lo_write_transfer(lo, rq, pos);
579 else if (cmd->use_aio)
580 return lo_rw_aio(lo, cmd, pos, WRITE);
af65aa8e 581 else
c1c87c2b
CH
582 return lo_write_simple(lo, rq, pos);
583 case REQ_OP_READ:
aa4d8616 584 if (lo->transfer)
c1c87c2b
CH
585 return lo_read_transfer(lo, rq, pos);
586 else if (cmd->use_aio)
587 return lo_rw_aio(lo, cmd, pos, READ);
aa4d8616 588 else
c1c87c2b
CH
589 return lo_read_simple(lo, rq, pos);
590 default:
591 WARN_ON_ONCE(1);
592 return -EIO;
593 break;
aa4d8616 594 }
1da177e4
LT
595}
596
2e5ab5f3
ML
597static inline void loop_update_dio(struct loop_device *lo)
598{
599 __loop_update_dio(lo, io_is_direct(lo->lo_backing_file) |
600 lo->use_dio);
601}
602
06f0e9e6
ML
603static void loop_reread_partitions(struct loop_device *lo,
604 struct block_device *bdev)
605{
606 int rc;
607
608 /*
609 * bd_mutex has been held already in release path, so don't
610 * acquire it if this function is called in such case.
611 *
612 * If the reread partition isn't from release path, lo_refcnt
613 * must be at least one and it can only become zero when the
614 * current holder is released.
615 */
616 if (!atomic_read(&lo->lo_refcnt))
617 rc = __blkdev_reread_part(bdev);
618 else
619 rc = blkdev_reread_part(bdev);
620 if (rc)
621 pr_warn("%s: partition scan of loop%d (%s) failed (rc=%d)\n",
622 __func__, lo->lo_number, lo->lo_file_name, rc);
623}
624
1da177e4
LT
625/*
626 * loop_change_fd switched the backing store of a loopback device to
627 * a new file. This is useful for operating system installers to free up
628 * the original file and in High Availability environments to switch to
629 * an alternative location for the content in case of server meltdown.
630 * This can only work if the loop device is used read-only, and if the
631 * new backing store is the same size and type as the old backing store.
632 */
bb214884
AV
633static int loop_change_fd(struct loop_device *lo, struct block_device *bdev,
634 unsigned int arg)
1da177e4
LT
635{
636 struct file *file, *old_file;
637 struct inode *inode;
638 int error;
639
640 error = -ENXIO;
641 if (lo->lo_state != Lo_bound)
642 goto out;
643
644 /* the loop device has to be read-only */
645 error = -EINVAL;
646 if (!(lo->lo_flags & LO_FLAGS_READ_ONLY))
647 goto out;
648
649 error = -EBADF;
650 file = fget(arg);
651 if (!file)
652 goto out;
653
654 inode = file->f_mapping->host;
655 old_file = lo->lo_backing_file;
656
657 error = -EINVAL;
658
659 if (!S_ISREG(inode->i_mode) && !S_ISBLK(inode->i_mode))
660 goto out_putf;
661
1da177e4
LT
662 /* size of the new backing store needs to be the same */
663 if (get_loop_size(lo, file) != get_loop_size(lo, old_file))
664 goto out_putf;
665
666 /* and ... switch */
43cade80
OS
667 blk_mq_freeze_queue(lo->lo_queue);
668 mapping_set_gfp_mask(old_file->f_mapping, lo->old_gfp_mask);
669 lo->lo_backing_file = file;
670 lo->old_gfp_mask = mapping_gfp_mask(file->f_mapping);
671 mapping_set_gfp_mask(file->f_mapping,
672 lo->old_gfp_mask & ~(__GFP_IO|__GFP_FS));
673 loop_update_dio(lo);
674 blk_mq_unfreeze_queue(lo->lo_queue);
1da177e4
LT
675
676 fput(old_file);
e03c8dd1 677 if (lo->lo_flags & LO_FLAGS_PARTSCAN)
06f0e9e6 678 loop_reread_partitions(lo, bdev);
1da177e4
LT
679 return 0;
680
681 out_putf:
682 fput(file);
683 out:
684 return error;
685}
686
687static inline int is_loop_device(struct file *file)
688{
689 struct inode *i = file->f_mapping->host;
690
691 return i && S_ISBLK(i->i_mode) && MAJOR(i->i_rdev) == LOOP_MAJOR;
692}
693
ee862730
MB
694/* loop sysfs attributes */
695
696static ssize_t loop_attr_show(struct device *dev, char *page,
697 ssize_t (*callback)(struct loop_device *, char *))
698{
34dd82af
KS
699 struct gendisk *disk = dev_to_disk(dev);
700 struct loop_device *lo = disk->private_data;
ee862730 701
34dd82af 702 return callback(lo, page);
ee862730
MB
703}
704
705#define LOOP_ATTR_RO(_name) \
706static ssize_t loop_attr_##_name##_show(struct loop_device *, char *); \
707static ssize_t loop_attr_do_show_##_name(struct device *d, \
708 struct device_attribute *attr, char *b) \
709{ \
710 return loop_attr_show(d, b, loop_attr_##_name##_show); \
711} \
712static struct device_attribute loop_attr_##_name = \
713 __ATTR(_name, S_IRUGO, loop_attr_do_show_##_name, NULL);
714
715static ssize_t loop_attr_backing_file_show(struct loop_device *lo, char *buf)
716{
717 ssize_t ret;
718 char *p = NULL;
719
05eb0f25 720 spin_lock_irq(&lo->lo_lock);
ee862730 721 if (lo->lo_backing_file)
9bf39ab2 722 p = file_path(lo->lo_backing_file, buf, PAGE_SIZE - 1);
05eb0f25 723 spin_unlock_irq(&lo->lo_lock);
ee862730
MB
724
725 if (IS_ERR_OR_NULL(p))
726 ret = PTR_ERR(p);
727 else {
728 ret = strlen(p);
729 memmove(buf, p, ret);
730 buf[ret++] = '\n';
731 buf[ret] = 0;
732 }
733
734 return ret;
735}
736
737static ssize_t loop_attr_offset_show(struct loop_device *lo, char *buf)
738{
739 return sprintf(buf, "%llu\n", (unsigned long long)lo->lo_offset);
740}
741
742static ssize_t loop_attr_sizelimit_show(struct loop_device *lo, char *buf)
743{
744 return sprintf(buf, "%llu\n", (unsigned long long)lo->lo_sizelimit);
745}
746
747static ssize_t loop_attr_autoclear_show(struct loop_device *lo, char *buf)
748{
749 int autoclear = (lo->lo_flags & LO_FLAGS_AUTOCLEAR);
750
751 return sprintf(buf, "%s\n", autoclear ? "1" : "0");
752}
753
e03c8dd1
KS
754static ssize_t loop_attr_partscan_show(struct loop_device *lo, char *buf)
755{
756 int partscan = (lo->lo_flags & LO_FLAGS_PARTSCAN);
757
758 return sprintf(buf, "%s\n", partscan ? "1" : "0");
759}
760
2e5ab5f3
ML
761static ssize_t loop_attr_dio_show(struct loop_device *lo, char *buf)
762{
763 int dio = (lo->lo_flags & LO_FLAGS_DIRECT_IO);
764
765 return sprintf(buf, "%s\n", dio ? "1" : "0");
766}
767
ee862730
MB
768LOOP_ATTR_RO(backing_file);
769LOOP_ATTR_RO(offset);
770LOOP_ATTR_RO(sizelimit);
771LOOP_ATTR_RO(autoclear);
e03c8dd1 772LOOP_ATTR_RO(partscan);
2e5ab5f3 773LOOP_ATTR_RO(dio);
ee862730
MB
774
775static struct attribute *loop_attrs[] = {
776 &loop_attr_backing_file.attr,
777 &loop_attr_offset.attr,
778 &loop_attr_sizelimit.attr,
779 &loop_attr_autoclear.attr,
e03c8dd1 780 &loop_attr_partscan.attr,
2e5ab5f3 781 &loop_attr_dio.attr,
ee862730
MB
782 NULL,
783};
784
785static struct attribute_group loop_attribute_group = {
786 .name = "loop",
787 .attrs= loop_attrs,
788};
789
790static int loop_sysfs_init(struct loop_device *lo)
791{
792 return sysfs_create_group(&disk_to_dev(lo->lo_disk)->kobj,
793 &loop_attribute_group);
794}
795
796static void loop_sysfs_exit(struct loop_device *lo)
797{
798 sysfs_remove_group(&disk_to_dev(lo->lo_disk)->kobj,
799 &loop_attribute_group);
800}
801
dfaa2ef6
LC
802static void loop_config_discard(struct loop_device *lo)
803{
804 struct file *file = lo->lo_backing_file;
805 struct inode *inode = file->f_mapping->host;
806 struct request_queue *q = lo->lo_queue;
807
808 /*
809 * We use punch hole to reclaim the free space used by the
12a64d2f 810 * image a.k.a. discard. However we do not support discard if
dfaa2ef6
LC
811 * encryption is enabled, because it may give an attacker
812 * useful information.
813 */
814 if ((!file->f_op->fallocate) ||
815 lo->lo_encrypt_key_size) {
816 q->limits.discard_granularity = 0;
817 q->limits.discard_alignment = 0;
2bb4cd5c 818 blk_queue_max_discard_sectors(q, 0);
19372e27 819 blk_queue_max_write_zeroes_sectors(q, 0);
8b904b5b 820 blk_queue_flag_clear(QUEUE_FLAG_DISCARD, q);
dfaa2ef6
LC
821 return;
822 }
823
824 q->limits.discard_granularity = inode->i_sb->s_blocksize;
dfaf3c03 825 q->limits.discard_alignment = 0;
f2c6df7d 826
1e6ec9ea
OS
827 blk_queue_max_discard_sectors(q, UINT_MAX >> 9);
828 blk_queue_max_write_zeroes_sectors(q, UINT_MAX >> 9);
8b904b5b 829 blk_queue_flag_set(QUEUE_FLAG_DISCARD, q);
dfaa2ef6
LC
830}
831
e03a3d7a
ML
832static void loop_unprepare_queue(struct loop_device *lo)
833{
3989144f 834 kthread_flush_worker(&lo->worker);
e03a3d7a
ML
835 kthread_stop(lo->worker_task);
836}
837
b2ee7d46
N
838static int loop_kthread_worker_fn(void *worker_ptr)
839{
840 current->flags |= PF_LESS_THROTTLE;
841 return kthread_worker_fn(worker_ptr);
842}
843
e03a3d7a
ML
844static int loop_prepare_queue(struct loop_device *lo)
845{
3989144f 846 kthread_init_worker(&lo->worker);
b2ee7d46 847 lo->worker_task = kthread_run(loop_kthread_worker_fn,
e03a3d7a
ML
848 &lo->worker, "loop%d", lo->lo_number);
849 if (IS_ERR(lo->worker_task))
850 return -ENOMEM;
851 set_user_nice(lo->worker_task, MIN_NICE);
852 return 0;
853}
854
bb214884 855static int loop_set_fd(struct loop_device *lo, fmode_t mode,
1da177e4
LT
856 struct block_device *bdev, unsigned int arg)
857{
858 struct file *file, *f;
859 struct inode *inode;
860 struct address_space *mapping;
1da177e4
LT
861 int lo_flags = 0;
862 int error;
863 loff_t size;
864
865 /* This is safe, since we have a reference from open(). */
866 __module_get(THIS_MODULE);
867
868 error = -EBADF;
869 file = fget(arg);
870 if (!file)
871 goto out;
872
873 error = -EBUSY;
874 if (lo->lo_state != Lo_unbound)
875 goto out_putf;
876
877 /* Avoid recursion */
878 f = file;
879 while (is_loop_device(f)) {
880 struct loop_device *l;
881
bb214884 882 if (f->f_mapping->host->i_bdev == bdev)
1da177e4
LT
883 goto out_putf;
884
885 l = f->f_mapping->host->i_bdev->bd_disk->private_data;
886 if (l->lo_state == Lo_unbound) {
887 error = -EINVAL;
888 goto out_putf;
889 }
890 f = l->lo_backing_file;
891 }
892
893 mapping = file->f_mapping;
894 inode = mapping->host;
895
1da177e4 896 error = -EINVAL;
456be148
CH
897 if (!S_ISREG(inode->i_mode) && !S_ISBLK(inode->i_mode))
898 goto out_putf;
1da177e4 899
456be148 900 if (!(file->f_mode & FMODE_WRITE) || !(mode & FMODE_WRITE) ||
283e7e5d 901 !file->f_op->write_iter)
456be148 902 lo_flags |= LO_FLAGS_READ_ONLY;
ba52de12 903
456be148 904 error = -EFBIG;
1da177e4 905 size = get_loop_size(lo, file);
456be148 906 if ((loff_t)(sector_t)size != size)
1da177e4 907 goto out_putf;
e03a3d7a
ML
908 error = loop_prepare_queue(lo);
909 if (error)
f4aa4c7b 910 goto out_putf;
1da177e4 911
456be148 912 error = 0;
1da177e4
LT
913
914 set_device_ro(bdev, (lo_flags & LO_FLAGS_READ_ONLY) != 0);
915
2e5ab5f3 916 lo->use_dio = false;
1da177e4
LT
917 lo->lo_device = bdev;
918 lo->lo_flags = lo_flags;
919 lo->lo_backing_file = file;
aa4d8616 920 lo->transfer = NULL;
1da177e4
LT
921 lo->ioctl = NULL;
922 lo->lo_sizelimit = 0;
923 lo->old_gfp_mask = mapping_gfp_mask(mapping);
924 mapping_set_gfp_mask(mapping, lo->old_gfp_mask & ~(__GFP_IO|__GFP_FS));
925
68db1961 926 if (!(lo_flags & LO_FLAGS_READ_ONLY) && file->f_op->fsync)
21d0727f 927 blk_queue_write_cache(lo->lo_queue, true, false);
68db1961 928
2e5ab5f3 929 loop_update_dio(lo);
73285082 930 set_capacity(lo->lo_disk, size);
1da177e4 931 bd_set_size(bdev, size << 9);
ee862730 932 loop_sysfs_init(lo);
c3473c63
DZ
933 /* let user-space know about the new size */
934 kobject_uevent(&disk_to_dev(bdev->bd_disk)->kobj, KOBJ_CHANGE);
1da177e4 935
8a0740c4
OS
936 set_blocksize(bdev, S_ISBLK(inode->i_mode) ?
937 block_size(inode->i_bdev) : PAGE_SIZE);
1da177e4 938
6c997918 939 lo->lo_state = Lo_bound;
e03c8dd1
KS
940 if (part_shift)
941 lo->lo_flags |= LO_FLAGS_PARTSCAN;
942 if (lo->lo_flags & LO_FLAGS_PARTSCAN)
06f0e9e6 943 loop_reread_partitions(lo, bdev);
c1681bf8
AP
944
945 /* Grab the block_device to prevent its destruction after we
946 * put /dev/loopXX inode. Later in loop_clr_fd() we bdput(bdev).
947 */
948 bdgrab(bdev);
1da177e4
LT
949 return 0;
950
951 out_putf:
952 fput(file);
953 out:
954 /* This is safe: open() is still holding a reference. */
955 module_put(THIS_MODULE);
956 return error;
957}
958
959static int
960loop_release_xfer(struct loop_device *lo)
961{
962 int err = 0;
963 struct loop_func_table *xfer = lo->lo_encryption;
964
965 if (xfer) {
966 if (xfer->release)
967 err = xfer->release(lo);
968 lo->transfer = NULL;
969 lo->lo_encryption = NULL;
970 module_put(xfer->owner);
971 }
972 return err;
973}
974
975static int
976loop_init_xfer(struct loop_device *lo, struct loop_func_table *xfer,
977 const struct loop_info64 *i)
978{
979 int err = 0;
980
981 if (xfer) {
982 struct module *owner = xfer->owner;
983
984 if (!try_module_get(owner))
985 return -EINVAL;
986 if (xfer->init)
987 err = xfer->init(lo, i);
988 if (err)
989 module_put(owner);
990 else
991 lo->lo_encryption = xfer;
992 }
993 return err;
994}
995
4c823cc3 996static int loop_clr_fd(struct loop_device *lo)
1da177e4
LT
997{
998 struct file *filp = lo->lo_backing_file;
b4e3ca1a 999 gfp_t gfp = lo->old_gfp_mask;
4c823cc3 1000 struct block_device *bdev = lo->lo_device;
1da177e4
LT
1001
1002 if (lo->lo_state != Lo_bound)
1003 return -ENXIO;
1004
a1ecac3b
DC
1005 /*
1006 * If we've explicitly asked to tear down the loop device,
1007 * and it has an elevated reference count, set it for auto-teardown when
1008 * the last reference goes away. This stops $!~#$@ udev from
1009 * preventing teardown because it decided that it needs to run blkid on
1010 * the loopback device whenever they appear. xfstests is notorious for
1011 * failing tests because blkid via udev races with a losetup
1012 * <dev>/do something like mkfs/losetup -d <dev> causing the losetup -d
1013 * command to fail with EBUSY.
1014 */
f8933667 1015 if (atomic_read(&lo->lo_refcnt) > 1) {
a1ecac3b
DC
1016 lo->lo_flags |= LO_FLAGS_AUTOCLEAR;
1017 mutex_unlock(&lo->lo_ctl_mutex);
1018 return 0;
1019 }
1da177e4
LT
1020
1021 if (filp == NULL)
1022 return -EINVAL;
1023
f8933667
ML
1024 /* freeze request queue during the transition */
1025 blk_mq_freeze_queue(lo->lo_queue);
1026
1da177e4
LT
1027 spin_lock_irq(&lo->lo_lock);
1028 lo->lo_state = Lo_rundown;
1da177e4 1029 lo->lo_backing_file = NULL;
05eb0f25 1030 spin_unlock_irq(&lo->lo_lock);
1da177e4
LT
1031
1032 loop_release_xfer(lo);
1033 lo->transfer = NULL;
1034 lo->ioctl = NULL;
1035 lo->lo_device = NULL;
1036 lo->lo_encryption = NULL;
1037 lo->lo_offset = 0;
1038 lo->lo_sizelimit = 0;
1039 lo->lo_encrypt_key_size = 0;
1da177e4
LT
1040 memset(lo->lo_encrypt_key, 0, LO_KEY_SIZE);
1041 memset(lo->lo_crypt_name, 0, LO_NAME_SIZE);
1042 memset(lo->lo_file_name, 0, LO_NAME_SIZE);
89e4fdec 1043 blk_queue_logical_block_size(lo->lo_queue, 512);
bf093753
OS
1044 blk_queue_physical_block_size(lo->lo_queue, 512);
1045 blk_queue_io_min(lo->lo_queue, 512);
c1681bf8
AP
1046 if (bdev) {
1047 bdput(bdev);
bb214884 1048 invalidate_bdev(bdev);
c1681bf8 1049 }
73285082 1050 set_capacity(lo->lo_disk, 0);
51a0bb0c 1051 loop_sysfs_exit(lo);
c3473c63 1052 if (bdev) {
bb214884 1053 bd_set_size(bdev, 0);
c3473c63
DZ
1054 /* let user-space know about this change */
1055 kobject_uevent(&disk_to_dev(bdev->bd_disk)->kobj, KOBJ_CHANGE);
1056 }
1da177e4
LT
1057 mapping_set_gfp_mask(filp->f_mapping, gfp);
1058 lo->lo_state = Lo_unbound;
1da177e4
LT
1059 /* This is safe: open() is still holding a reference. */
1060 module_put(THIS_MODULE);
f8933667
ML
1061 blk_mq_unfreeze_queue(lo->lo_queue);
1062
c2fccc1c 1063 if (lo->lo_flags & LO_FLAGS_PARTSCAN && bdev)
06f0e9e6 1064 loop_reread_partitions(lo, bdev);
e03c8dd1
KS
1065 lo->lo_flags = 0;
1066 if (!part_shift)
1067 lo->lo_disk->flags |= GENHD_FL_NO_PART_SCAN;
e03a3d7a 1068 loop_unprepare_queue(lo);
f028f3b2
NK
1069 mutex_unlock(&lo->lo_ctl_mutex);
1070 /*
1071 * Need not hold lo_ctl_mutex to fput backing file.
1072 * Calling fput holding lo_ctl_mutex triggers a circular
1073 * lock dependency possibility warning as fput can take
1074 * bd_mutex which is usually taken before lo_ctl_mutex.
1075 */
1076 fput(filp);
1da177e4
LT
1077 return 0;
1078}
1079
1080static int
1081loop_set_status(struct loop_device *lo, const struct loop_info64 *info)
1082{
1083 int err;
1084 struct loop_func_table *xfer;
e4849737 1085 kuid_t uid = current_uid();
1da177e4 1086
b0fafa81 1087 if (lo->lo_encrypt_key_size &&
e4849737 1088 !uid_eq(lo->lo_key_owner, uid) &&
1da177e4
LT
1089 !capable(CAP_SYS_ADMIN))
1090 return -EPERM;
1091 if (lo->lo_state != Lo_bound)
1092 return -ENXIO;
1093 if ((unsigned int) info->lo_encrypt_key_size > LO_KEY_SIZE)
1094 return -EINVAL;
1095
ecdd0959
ML
1096 /* I/O need to be drained during transfer transition */
1097 blk_mq_freeze_queue(lo->lo_queue);
1098
1da177e4
LT
1099 err = loop_release_xfer(lo);
1100 if (err)
ecdd0959 1101 goto exit;
1da177e4
LT
1102
1103 if (info->lo_encrypt_type) {
1104 unsigned int type = info->lo_encrypt_type;
1105
1106 if (type >= MAX_LO_CRYPT)
1107 return -EINVAL;
1108 xfer = xfer_funcs[type];
1109 if (xfer == NULL)
1110 return -EINVAL;
1111 } else
1112 xfer = NULL;
1113
1114 err = loop_init_xfer(lo, xfer, info);
1115 if (err)
ecdd0959 1116 goto exit;
1da177e4
LT
1117
1118 if (lo->lo_offset != info->lo_offset ||
1e6ec9ea
OS
1119 lo->lo_sizelimit != info->lo_sizelimit) {
1120 if (figure_loop_size(lo, info->lo_offset, info->lo_sizelimit)) {
ecdd0959
ML
1121 err = -EFBIG;
1122 goto exit;
1123 }
b040ad9c 1124 }
541c742a 1125
dfaa2ef6 1126 loop_config_discard(lo);
1da177e4
LT
1127
1128 memcpy(lo->lo_file_name, info->lo_file_name, LO_NAME_SIZE);
1129 memcpy(lo->lo_crypt_name, info->lo_crypt_name, LO_NAME_SIZE);
1130 lo->lo_file_name[LO_NAME_SIZE-1] = 0;
1131 lo->lo_crypt_name[LO_NAME_SIZE-1] = 0;
1132
1133 if (!xfer)
1134 xfer = &none_funcs;
1135 lo->transfer = xfer->transfer;
1136 lo->ioctl = xfer->ioctl;
1137
96c58655
DW
1138 if ((lo->lo_flags & LO_FLAGS_AUTOCLEAR) !=
1139 (info->lo_flags & LO_FLAGS_AUTOCLEAR))
1140 lo->lo_flags ^= LO_FLAGS_AUTOCLEAR;
1141
1da177e4
LT
1142 lo->lo_encrypt_key_size = info->lo_encrypt_key_size;
1143 lo->lo_init[0] = info->lo_init[0];
1144 lo->lo_init[1] = info->lo_init[1];
1145 if (info->lo_encrypt_key_size) {
1146 memcpy(lo->lo_encrypt_key, info->lo_encrypt_key,
1147 info->lo_encrypt_key_size);
b0fafa81 1148 lo->lo_key_owner = uid;
aa4d8616 1149 }
1da177e4 1150
2e5ab5f3
ML
1151 /* update dio if lo_offset or transfer is changed */
1152 __loop_update_dio(lo, lo->use_dio);
1153
ecdd0959
ML
1154 exit:
1155 blk_mq_unfreeze_queue(lo->lo_queue);
e02898b4
OS
1156
1157 if (!err && (info->lo_flags & LO_FLAGS_PARTSCAN) &&
1158 !(lo->lo_flags & LO_FLAGS_PARTSCAN)) {
1159 lo->lo_flags |= LO_FLAGS_PARTSCAN;
1160 lo->lo_disk->flags &= ~GENHD_FL_NO_PART_SCAN;
1161 loop_reread_partitions(lo, lo->lo_device);
1162 }
1163
ecdd0959 1164 return err;
1da177e4
LT
1165}
1166
1167static int
1168loop_get_status(struct loop_device *lo, struct loop_info64 *info)
1169{
2d1d4c1e 1170 struct file *file;
1da177e4 1171 struct kstat stat;
2d1d4c1e 1172 int ret;
1da177e4 1173
2d1d4c1e
OS
1174 if (lo->lo_state != Lo_bound) {
1175 mutex_unlock(&lo->lo_ctl_mutex);
1da177e4 1176 return -ENXIO;
2d1d4c1e
OS
1177 }
1178
1da177e4
LT
1179 memset(info, 0, sizeof(*info));
1180 info->lo_number = lo->lo_number;
1da177e4
LT
1181 info->lo_offset = lo->lo_offset;
1182 info->lo_sizelimit = lo->lo_sizelimit;
1183 info->lo_flags = lo->lo_flags;
1184 memcpy(info->lo_file_name, lo->lo_file_name, LO_NAME_SIZE);
1185 memcpy(info->lo_crypt_name, lo->lo_crypt_name, LO_NAME_SIZE);
1186 info->lo_encrypt_type =
1187 lo->lo_encryption ? lo->lo_encryption->number : 0;
1188 if (lo->lo_encrypt_key_size && capable(CAP_SYS_ADMIN)) {
1189 info->lo_encrypt_key_size = lo->lo_encrypt_key_size;
1190 memcpy(info->lo_encrypt_key, lo->lo_encrypt_key,
1191 lo->lo_encrypt_key_size);
1192 }
2d1d4c1e
OS
1193
1194 /* Drop lo_ctl_mutex while we call into the filesystem. */
1195 file = get_file(lo->lo_backing_file);
1196 mutex_unlock(&lo->lo_ctl_mutex);
1197 ret = vfs_getattr(&file->f_path, &stat, STATX_INO,
1198 AT_STATX_SYNC_AS_STAT);
1199 if (!ret) {
1200 info->lo_device = huge_encode_dev(stat.dev);
1201 info->lo_inode = stat.ino;
1202 info->lo_rdevice = huge_encode_dev(stat.rdev);
1203 }
1204 fput(file);
1205 return ret;
1da177e4
LT
1206}
1207
1208static void
1209loop_info64_from_old(const struct loop_info *info, struct loop_info64 *info64)
1210{
1211 memset(info64, 0, sizeof(*info64));
1212 info64->lo_number = info->lo_number;
1213 info64->lo_device = info->lo_device;
1214 info64->lo_inode = info->lo_inode;
1215 info64->lo_rdevice = info->lo_rdevice;
1216 info64->lo_offset = info->lo_offset;
1217 info64->lo_sizelimit = 0;
1218 info64->lo_encrypt_type = info->lo_encrypt_type;
1219 info64->lo_encrypt_key_size = info->lo_encrypt_key_size;
1220 info64->lo_flags = info->lo_flags;
1221 info64->lo_init[0] = info->lo_init[0];
1222 info64->lo_init[1] = info->lo_init[1];
1223 if (info->lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1224 memcpy(info64->lo_crypt_name, info->lo_name, LO_NAME_SIZE);
1225 else
1226 memcpy(info64->lo_file_name, info->lo_name, LO_NAME_SIZE);
1227 memcpy(info64->lo_encrypt_key, info->lo_encrypt_key, LO_KEY_SIZE);
1228}
1229
1230static int
1231loop_info64_to_old(const struct loop_info64 *info64, struct loop_info *info)
1232{
1233 memset(info, 0, sizeof(*info));
1234 info->lo_number = info64->lo_number;
1235 info->lo_device = info64->lo_device;
1236 info->lo_inode = info64->lo_inode;
1237 info->lo_rdevice = info64->lo_rdevice;
1238 info->lo_offset = info64->lo_offset;
1239 info->lo_encrypt_type = info64->lo_encrypt_type;
1240 info->lo_encrypt_key_size = info64->lo_encrypt_key_size;
1241 info->lo_flags = info64->lo_flags;
1242 info->lo_init[0] = info64->lo_init[0];
1243 info->lo_init[1] = info64->lo_init[1];
1244 if (info->lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1245 memcpy(info->lo_name, info64->lo_crypt_name, LO_NAME_SIZE);
1246 else
1247 memcpy(info->lo_name, info64->lo_file_name, LO_NAME_SIZE);
1248 memcpy(info->lo_encrypt_key, info64->lo_encrypt_key, LO_KEY_SIZE);
1249
1250 /* error in case values were truncated */
1251 if (info->lo_device != info64->lo_device ||
1252 info->lo_rdevice != info64->lo_rdevice ||
1253 info->lo_inode != info64->lo_inode ||
1254 info->lo_offset != info64->lo_offset)
1255 return -EOVERFLOW;
1256
1257 return 0;
1258}
1259
1260static int
1261loop_set_status_old(struct loop_device *lo, const struct loop_info __user *arg)
1262{
1263 struct loop_info info;
1264 struct loop_info64 info64;
1265
1266 if (copy_from_user(&info, arg, sizeof (struct loop_info)))
1267 return -EFAULT;
1268 loop_info64_from_old(&info, &info64);
1269 return loop_set_status(lo, &info64);
1270}
1271
1272static int
1273loop_set_status64(struct loop_device *lo, const struct loop_info64 __user *arg)
1274{
1275 struct loop_info64 info64;
1276
1277 if (copy_from_user(&info64, arg, sizeof (struct loop_info64)))
1278 return -EFAULT;
1279 return loop_set_status(lo, &info64);
1280}
1281
1282static int
1283loop_get_status_old(struct loop_device *lo, struct loop_info __user *arg) {
1284 struct loop_info info;
1285 struct loop_info64 info64;
1286 int err = 0;
1287
1288 if (!arg)
1289 err = -EINVAL;
1290 if (!err)
1291 err = loop_get_status(lo, &info64);
1292 if (!err)
1293 err = loop_info64_to_old(&info64, &info);
1294 if (!err && copy_to_user(arg, &info, sizeof(info)))
1295 err = -EFAULT;
1296
1297 return err;
1298}
1299
1300static int
1301loop_get_status64(struct loop_device *lo, struct loop_info64 __user *arg) {
1302 struct loop_info64 info64;
1303 int err = 0;
1304
1305 if (!arg)
1306 err = -EINVAL;
1307 if (!err)
1308 err = loop_get_status(lo, &info64);
1309 if (!err && copy_to_user(arg, &info64, sizeof(info64)))
1310 err = -EFAULT;
1311
1312 return err;
1313}
1314
51001b7d 1315static int loop_set_capacity(struct loop_device *lo)
53d66608 1316{
53d66608 1317 if (unlikely(lo->lo_state != Lo_bound))
7b0576a3 1318 return -ENXIO;
53d66608 1319
1e6ec9ea 1320 return figure_loop_size(lo, lo->lo_offset, lo->lo_sizelimit);
53d66608
O
1321}
1322
ab1cb278
ML
1323static int loop_set_dio(struct loop_device *lo, unsigned long arg)
1324{
1325 int error = -ENXIO;
1326 if (lo->lo_state != Lo_bound)
1327 goto out;
1328
1329 __loop_update_dio(lo, !!arg);
1330 if (lo->use_dio == !!arg)
1331 return 0;
1332 error = -EINVAL;
1333 out:
1334 return error;
1335}
1336
89e4fdec
OS
1337static int loop_set_block_size(struct loop_device *lo, unsigned long arg)
1338{
1339 if (lo->lo_state != Lo_bound)
1340 return -ENXIO;
1341
1342 if (arg < 512 || arg > PAGE_SIZE || !is_power_of_2(arg))
1343 return -EINVAL;
1344
1345 blk_mq_freeze_queue(lo->lo_queue);
1346
1347 blk_queue_logical_block_size(lo->lo_queue, arg);
bf093753
OS
1348 blk_queue_physical_block_size(lo->lo_queue, arg);
1349 blk_queue_io_min(lo->lo_queue, arg);
89e4fdec
OS
1350 loop_update_dio(lo);
1351
1352 blk_mq_unfreeze_queue(lo->lo_queue);
1353
1354 return 0;
1355}
1356
bb214884 1357static int lo_ioctl(struct block_device *bdev, fmode_t mode,
1da177e4
LT
1358 unsigned int cmd, unsigned long arg)
1359{
bb214884 1360 struct loop_device *lo = bdev->bd_disk->private_data;
1da177e4
LT
1361 int err;
1362
f028f3b2 1363 mutex_lock_nested(&lo->lo_ctl_mutex, 1);
1da177e4
LT
1364 switch (cmd) {
1365 case LOOP_SET_FD:
bb214884 1366 err = loop_set_fd(lo, mode, bdev, arg);
1da177e4
LT
1367 break;
1368 case LOOP_CHANGE_FD:
bb214884 1369 err = loop_change_fd(lo, bdev, arg);
1da177e4
LT
1370 break;
1371 case LOOP_CLR_FD:
f028f3b2 1372 /* loop_clr_fd would have unlocked lo_ctl_mutex on success */
4c823cc3 1373 err = loop_clr_fd(lo);
f028f3b2
NK
1374 if (!err)
1375 goto out_unlocked;
1da177e4
LT
1376 break;
1377 case LOOP_SET_STATUS:
7035b5df
DM
1378 err = -EPERM;
1379 if ((mode & FMODE_WRITE) || capable(CAP_SYS_ADMIN))
1380 err = loop_set_status_old(lo,
1381 (struct loop_info __user *)arg);
1da177e4
LT
1382 break;
1383 case LOOP_GET_STATUS:
1384 err = loop_get_status_old(lo, (struct loop_info __user *) arg);
2d1d4c1e
OS
1385 /* loop_get_status() unlocks lo_ctl_mutex */
1386 goto out_unlocked;
1da177e4 1387 case LOOP_SET_STATUS64:
7035b5df
DM
1388 err = -EPERM;
1389 if ((mode & FMODE_WRITE) || capable(CAP_SYS_ADMIN))
1390 err = loop_set_status64(lo,
1391 (struct loop_info64 __user *) arg);
1da177e4
LT
1392 break;
1393 case LOOP_GET_STATUS64:
1394 err = loop_get_status64(lo, (struct loop_info64 __user *) arg);
2d1d4c1e
OS
1395 /* loop_get_status() unlocks lo_ctl_mutex */
1396 goto out_unlocked;
53d66608
O
1397 case LOOP_SET_CAPACITY:
1398 err = -EPERM;
1399 if ((mode & FMODE_WRITE) || capable(CAP_SYS_ADMIN))
51001b7d 1400 err = loop_set_capacity(lo);
53d66608 1401 break;
ab1cb278
ML
1402 case LOOP_SET_DIRECT_IO:
1403 err = -EPERM;
1404 if ((mode & FMODE_WRITE) || capable(CAP_SYS_ADMIN))
1405 err = loop_set_dio(lo, arg);
1406 break;
89e4fdec
OS
1407 case LOOP_SET_BLOCK_SIZE:
1408 err = -EPERM;
1409 if ((mode & FMODE_WRITE) || capable(CAP_SYS_ADMIN))
1410 err = loop_set_block_size(lo, arg);
1411 break;
1da177e4
LT
1412 default:
1413 err = lo->ioctl ? lo->ioctl(lo, cmd, arg) : -EINVAL;
1414 }
f85221dd 1415 mutex_unlock(&lo->lo_ctl_mutex);
f028f3b2
NK
1416
1417out_unlocked:
1da177e4
LT
1418 return err;
1419}
1420
863d5b82
DH
1421#ifdef CONFIG_COMPAT
1422struct compat_loop_info {
1423 compat_int_t lo_number; /* ioctl r/o */
1424 compat_dev_t lo_device; /* ioctl r/o */
1425 compat_ulong_t lo_inode; /* ioctl r/o */
1426 compat_dev_t lo_rdevice; /* ioctl r/o */
1427 compat_int_t lo_offset;
1428 compat_int_t lo_encrypt_type;
1429 compat_int_t lo_encrypt_key_size; /* ioctl w/o */
1430 compat_int_t lo_flags; /* ioctl r/o */
1431 char lo_name[LO_NAME_SIZE];
1432 unsigned char lo_encrypt_key[LO_KEY_SIZE]; /* ioctl w/o */
1433 compat_ulong_t lo_init[2];
1434 char reserved[4];
1435};
1436
1437/*
1438 * Transfer 32-bit compatibility structure in userspace to 64-bit loop info
1439 * - noinlined to reduce stack space usage in main part of driver
1440 */
1441static noinline int
ba674cfc 1442loop_info64_from_compat(const struct compat_loop_info __user *arg,
863d5b82
DH
1443 struct loop_info64 *info64)
1444{
1445 struct compat_loop_info info;
1446
1447 if (copy_from_user(&info, arg, sizeof(info)))
1448 return -EFAULT;
1449
1450 memset(info64, 0, sizeof(*info64));
1451 info64->lo_number = info.lo_number;
1452 info64->lo_device = info.lo_device;
1453 info64->lo_inode = info.lo_inode;
1454 info64->lo_rdevice = info.lo_rdevice;
1455 info64->lo_offset = info.lo_offset;
1456 info64->lo_sizelimit = 0;
1457 info64->lo_encrypt_type = info.lo_encrypt_type;
1458 info64->lo_encrypt_key_size = info.lo_encrypt_key_size;
1459 info64->lo_flags = info.lo_flags;
1460 info64->lo_init[0] = info.lo_init[0];
1461 info64->lo_init[1] = info.lo_init[1];
1462 if (info.lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1463 memcpy(info64->lo_crypt_name, info.lo_name, LO_NAME_SIZE);
1464 else
1465 memcpy(info64->lo_file_name, info.lo_name, LO_NAME_SIZE);
1466 memcpy(info64->lo_encrypt_key, info.lo_encrypt_key, LO_KEY_SIZE);
1467 return 0;
1468}
1469
1470/*
1471 * Transfer 64-bit loop info to 32-bit compatibility structure in userspace
1472 * - noinlined to reduce stack space usage in main part of driver
1473 */
1474static noinline int
1475loop_info64_to_compat(const struct loop_info64 *info64,
1476 struct compat_loop_info __user *arg)
1477{
1478 struct compat_loop_info info;
1479
1480 memset(&info, 0, sizeof(info));
1481 info.lo_number = info64->lo_number;
1482 info.lo_device = info64->lo_device;
1483 info.lo_inode = info64->lo_inode;
1484 info.lo_rdevice = info64->lo_rdevice;
1485 info.lo_offset = info64->lo_offset;
1486 info.lo_encrypt_type = info64->lo_encrypt_type;
1487 info.lo_encrypt_key_size = info64->lo_encrypt_key_size;
1488 info.lo_flags = info64->lo_flags;
1489 info.lo_init[0] = info64->lo_init[0];
1490 info.lo_init[1] = info64->lo_init[1];
1491 if (info.lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1492 memcpy(info.lo_name, info64->lo_crypt_name, LO_NAME_SIZE);
1493 else
1494 memcpy(info.lo_name, info64->lo_file_name, LO_NAME_SIZE);
1495 memcpy(info.lo_encrypt_key, info64->lo_encrypt_key, LO_KEY_SIZE);
1496
1497 /* error in case values were truncated */
1498 if (info.lo_device != info64->lo_device ||
1499 info.lo_rdevice != info64->lo_rdevice ||
1500 info.lo_inode != info64->lo_inode ||
1501 info.lo_offset != info64->lo_offset ||
1502 info.lo_init[0] != info64->lo_init[0] ||
1503 info.lo_init[1] != info64->lo_init[1])
1504 return -EOVERFLOW;
1505
1506 if (copy_to_user(arg, &info, sizeof(info)))
1507 return -EFAULT;
1508 return 0;
1509}
1510
1511static int
1512loop_set_status_compat(struct loop_device *lo,
1513 const struct compat_loop_info __user *arg)
1514{
1515 struct loop_info64 info64;
1516 int ret;
1517
1518 ret = loop_info64_from_compat(arg, &info64);
1519 if (ret < 0)
1520 return ret;
1521 return loop_set_status(lo, &info64);
1522}
1523
1524static int
1525loop_get_status_compat(struct loop_device *lo,
1526 struct compat_loop_info __user *arg)
1527{
1528 struct loop_info64 info64;
1529 int err = 0;
1530
1531 if (!arg)
1532 err = -EINVAL;
1533 if (!err)
1534 err = loop_get_status(lo, &info64);
1535 if (!err)
1536 err = loop_info64_to_compat(&info64, arg);
1537 return err;
1538}
1539
bb214884
AV
1540static int lo_compat_ioctl(struct block_device *bdev, fmode_t mode,
1541 unsigned int cmd, unsigned long arg)
863d5b82 1542{
bb214884 1543 struct loop_device *lo = bdev->bd_disk->private_data;
863d5b82
DH
1544 int err;
1545
863d5b82
DH
1546 switch(cmd) {
1547 case LOOP_SET_STATUS:
1548 mutex_lock(&lo->lo_ctl_mutex);
1549 err = loop_set_status_compat(
1550 lo, (const struct compat_loop_info __user *) arg);
1551 mutex_unlock(&lo->lo_ctl_mutex);
1552 break;
1553 case LOOP_GET_STATUS:
1554 mutex_lock(&lo->lo_ctl_mutex);
1555 err = loop_get_status_compat(
1556 lo, (struct compat_loop_info __user *) arg);
2d1d4c1e 1557 /* loop_get_status() unlocks lo_ctl_mutex */
863d5b82 1558 break;
53d66608 1559 case LOOP_SET_CAPACITY:
863d5b82
DH
1560 case LOOP_CLR_FD:
1561 case LOOP_GET_STATUS64:
1562 case LOOP_SET_STATUS64:
1563 arg = (unsigned long) compat_ptr(arg);
1564 case LOOP_SET_FD:
1565 case LOOP_CHANGE_FD:
bb214884 1566 err = lo_ioctl(bdev, mode, cmd, arg);
863d5b82
DH
1567 break;
1568 default:
1569 err = -ENOIOCTLCMD;
1570 break;
1571 }
863d5b82
DH
1572 return err;
1573}
1574#endif
1575
bb214884 1576static int lo_open(struct block_device *bdev, fmode_t mode)
1da177e4 1577{
770fe30a
KS
1578 struct loop_device *lo;
1579 int err = 0;
1580
1581 mutex_lock(&loop_index_mutex);
1582 lo = bdev->bd_disk->private_data;
1583 if (!lo) {
1584 err = -ENXIO;
1585 goto out;
1586 }
1da177e4 1587
f8933667 1588 atomic_inc(&lo->lo_refcnt);
770fe30a
KS
1589out:
1590 mutex_unlock(&loop_index_mutex);
1591 return err;
1da177e4
LT
1592}
1593
ae665016 1594static void __lo_release(struct loop_device *lo)
1da177e4 1595{
ffcd7dca 1596 int err;
1da177e4 1597
f8933667
ML
1598 if (atomic_dec_return(&lo->lo_refcnt))
1599 return;
14f27939 1600
f8933667 1601 mutex_lock(&lo->lo_ctl_mutex);
14f27939
MB
1602 if (lo->lo_flags & LO_FLAGS_AUTOCLEAR) {
1603 /*
1604 * In autoclear mode, stop the loop thread
1605 * and remove configuration after last close.
1606 */
4c823cc3 1607 err = loop_clr_fd(lo);
ffcd7dca 1608 if (!err)
db2a144b 1609 return;
43cade80 1610 } else if (lo->lo_state == Lo_bound) {
14f27939
MB
1611 /*
1612 * Otherwise keep thread (if running) and config,
1613 * but flush possible ongoing bios in thread.
1614 */
43cade80
OS
1615 blk_mq_freeze_queue(lo->lo_queue);
1616 blk_mq_unfreeze_queue(lo->lo_queue);
14f27939 1617 }
96c58655 1618
f85221dd 1619 mutex_unlock(&lo->lo_ctl_mutex);
1da177e4
LT
1620}
1621
ae665016
LT
1622static void lo_release(struct gendisk *disk, fmode_t mode)
1623{
1624 mutex_lock(&loop_index_mutex);
1625 __lo_release(disk->private_data);
1626 mutex_unlock(&loop_index_mutex);
1627}
1628
83d5cde4 1629static const struct block_device_operations lo_fops = {
1da177e4 1630 .owner = THIS_MODULE,
bb214884
AV
1631 .open = lo_open,
1632 .release = lo_release,
1633 .ioctl = lo_ioctl,
863d5b82 1634#ifdef CONFIG_COMPAT
bb214884 1635 .compat_ioctl = lo_compat_ioctl,
863d5b82 1636#endif
1da177e4
LT
1637};
1638
1639/*
1640 * And now the modules code and kernel interface.
1641 */
73285082 1642static int max_loop;
ac04fee0 1643module_param(max_loop, int, S_IRUGO);
a47653fc 1644MODULE_PARM_DESC(max_loop, "Maximum number of loop devices");
ac04fee0 1645module_param(max_part, int, S_IRUGO);
476a4813 1646MODULE_PARM_DESC(max_part, "Maximum number of partitions per loop device");
1da177e4
LT
1647MODULE_LICENSE("GPL");
1648MODULE_ALIAS_BLOCKDEV_MAJOR(LOOP_MAJOR);
1649
1650int loop_register_transfer(struct loop_func_table *funcs)
1651{
1652 unsigned int n = funcs->number;
1653
1654 if (n >= MAX_LO_CRYPT || xfer_funcs[n])
1655 return -EINVAL;
1656 xfer_funcs[n] = funcs;
1657 return 0;
1658}
1659
34dd82af
KS
1660static int unregister_transfer_cb(int id, void *ptr, void *data)
1661{
1662 struct loop_device *lo = ptr;
1663 struct loop_func_table *xfer = data;
1664
1665 mutex_lock(&lo->lo_ctl_mutex);
1666 if (lo->lo_encryption == xfer)
1667 loop_release_xfer(lo);
1668 mutex_unlock(&lo->lo_ctl_mutex);
1669 return 0;
1670}
1671
1da177e4
LT
1672int loop_unregister_transfer(int number)
1673{
1674 unsigned int n = number;
1da177e4
LT
1675 struct loop_func_table *xfer;
1676
1677 if (n == 0 || n >= MAX_LO_CRYPT || (xfer = xfer_funcs[n]) == NULL)
1678 return -EINVAL;
1679
1680 xfer_funcs[n] = NULL;
34dd82af 1681 idr_for_each(&loop_index_idr, &unregister_transfer_cb, xfer);
1da177e4
LT
1682 return 0;
1683}
1684
1685EXPORT_SYMBOL(loop_register_transfer);
1686EXPORT_SYMBOL(loop_unregister_transfer);
1687
fc17b653 1688static blk_status_t loop_queue_rq(struct blk_mq_hw_ctx *hctx,
b5dd2f60
ML
1689 const struct blk_mq_queue_data *bd)
1690{
1691 struct loop_cmd *cmd = blk_mq_rq_to_pdu(bd->rq);
f4aa4c7b 1692 struct loop_device *lo = cmd->rq->q->queuedata;
b5dd2f60
ML
1693
1694 blk_mq_start_request(bd->rq);
1695
f4aa4c7b 1696 if (lo->lo_state != Lo_bound)
fc17b653 1697 return BLK_STS_IOERR;
f4aa4c7b 1698
f0225cac
CH
1699 switch (req_op(cmd->rq)) {
1700 case REQ_OP_FLUSH:
1701 case REQ_OP_DISCARD:
19372e27 1702 case REQ_OP_WRITE_ZEROES:
bc07c10a 1703 cmd->use_aio = false;
f0225cac
CH
1704 break;
1705 default:
1706 cmd->use_aio = lo->use_dio;
1707 break;
1708 }
bc07c10a 1709
d4478e92 1710 /* always use the first bio's css */
0b508bc9 1711#ifdef CONFIG_BLK_CGROUP
d4478e92
SL
1712 if (cmd->use_aio && cmd->rq->bio && cmd->rq->bio->bi_css) {
1713 cmd->css = cmd->rq->bio->bi_css;
1714 css_get(cmd->css);
1715 } else
1716#endif
1717 cmd->css = NULL;
3989144f 1718 kthread_queue_work(&lo->worker, &cmd->work);
b5dd2f60 1719
fc17b653 1720 return BLK_STS_OK;
b5dd2f60
ML
1721}
1722
1723static void loop_handle_cmd(struct loop_cmd *cmd)
1724{
a8ebb056 1725 const bool write = op_is_write(req_op(cmd->rq));
b5dd2f60 1726 struct loop_device *lo = cmd->rq->q->queuedata;
f4829a9b 1727 int ret = 0;
b5dd2f60 1728
f4829a9b
CH
1729 if (write && (lo->lo_flags & LO_FLAGS_READ_ONLY)) {
1730 ret = -EIO;
b5dd2f60 1731 goto failed;
f4829a9b 1732 }
b5dd2f60 1733
30112013 1734 ret = do_req_filebacked(lo, cmd->rq);
b5dd2f60 1735 failed:
bc07c10a 1736 /* complete non-aio request */
fe2cb290
CH
1737 if (!cmd->use_aio || ret) {
1738 cmd->ret = ret ? -EIO : 0;
08e0029a 1739 blk_mq_complete_request(cmd->rq);
fe2cb290 1740 }
b5dd2f60
ML
1741}
1742
e03a3d7a 1743static void loop_queue_work(struct kthread_work *work)
b5dd2f60
ML
1744{
1745 struct loop_cmd *cmd =
e03a3d7a 1746 container_of(work, struct loop_cmd, work);
b5dd2f60
ML
1747
1748 loop_handle_cmd(cmd);
1749}
1750
d6296d39
CH
1751static int loop_init_request(struct blk_mq_tag_set *set, struct request *rq,
1752 unsigned int hctx_idx, unsigned int numa_node)
b5dd2f60
ML
1753{
1754 struct loop_cmd *cmd = blk_mq_rq_to_pdu(rq);
1755
1756 cmd->rq = rq;
3989144f 1757 kthread_init_work(&cmd->work, loop_queue_work);
b5dd2f60
ML
1758
1759 return 0;
1760}
1761
f363b089 1762static const struct blk_mq_ops loop_mq_ops = {
b5dd2f60 1763 .queue_rq = loop_queue_rq,
b5dd2f60 1764 .init_request = loop_init_request,
fe2cb290 1765 .complete = lo_complete_rq,
b5dd2f60
ML
1766};
1767
34dd82af 1768static int loop_add(struct loop_device **l, int i)
73285082
KC
1769{
1770 struct loop_device *lo;
1771 struct gendisk *disk;
34dd82af 1772 int err;
73285082 1773
68d740d7 1774 err = -ENOMEM;
73285082 1775 lo = kzalloc(sizeof(*lo), GFP_KERNEL);
68d740d7 1776 if (!lo)
73285082 1777 goto out;
34dd82af 1778
ef7e7c82
MP
1779 lo->lo_state = Lo_unbound;
1780
c718aa65 1781 /* allocate id, if @id >= 0, we're requesting that specific id */
34dd82af 1782 if (i >= 0) {
c718aa65
TH
1783 err = idr_alloc(&loop_index_idr, lo, i, i + 1, GFP_KERNEL);
1784 if (err == -ENOSPC)
34dd82af 1785 err = -EEXIST;
34dd82af 1786 } else {
c718aa65 1787 err = idr_alloc(&loop_index_idr, lo, 0, 0, GFP_KERNEL);
34dd82af
KS
1788 }
1789 if (err < 0)
1790 goto out_free_dev;
c718aa65 1791 i = err;
73285082 1792
183cfb57 1793 err = -ENOMEM;
b5dd2f60
ML
1794 lo->tag_set.ops = &loop_mq_ops;
1795 lo->tag_set.nr_hw_queues = 1;
1796 lo->tag_set.queue_depth = 128;
1797 lo->tag_set.numa_node = NUMA_NO_NODE;
1798 lo->tag_set.cmd_size = sizeof(struct loop_cmd);
1799 lo->tag_set.flags = BLK_MQ_F_SHOULD_MERGE | BLK_MQ_F_SG_MERGE;
1800 lo->tag_set.driver_data = lo;
1801
1802 err = blk_mq_alloc_tag_set(&lo->tag_set);
1803 if (err)
3ec981e3 1804 goto out_free_idr;
73285082 1805
b5dd2f60
ML
1806 lo->lo_queue = blk_mq_init_queue(&lo->tag_set);
1807 if (IS_ERR_OR_NULL(lo->lo_queue)) {
1808 err = PTR_ERR(lo->lo_queue);
1809 goto out_cleanup_tags;
1810 }
ef7e7c82
MP
1811 lo->lo_queue->queuedata = lo;
1812
54bb0ade 1813 blk_queue_max_hw_sectors(lo->lo_queue, BLK_DEF_MAX_SECTORS);
40326d8a 1814
5b5e20f4 1815 /*
40326d8a
SL
1816 * By default, we do buffer IO, so it doesn't make sense to enable
1817 * merge because the I/O submitted to backing file is handled page by
1818 * page. For directio mode, merge does help to dispatch bigger request
1819 * to underlayer disk. We will enable merge once directio is enabled.
5b5e20f4 1820 */
8b904b5b 1821 blk_queue_flag_set(QUEUE_FLAG_NOMERGES, lo->lo_queue);
5b5e20f4 1822
7a649737 1823 err = -ENOMEM;
476a4813 1824 disk = lo->lo_disk = alloc_disk(1 << part_shift);
73285082
KC
1825 if (!disk)
1826 goto out_free_queue;
1827
e03c8dd1
KS
1828 /*
1829 * Disable partition scanning by default. The in-kernel partition
1830 * scanning can be requested individually per-device during its
1831 * setup. Userspace can always add and remove partitions from all
1832 * devices. The needed partition minors are allocated from the
1833 * extended minor space, the main loop device numbers will continue
1834 * to match the loop minors, regardless of the number of partitions
1835 * used.
1836 *
1837 * If max_part is given, partition scanning is globally enabled for
1838 * all loop devices. The minors for the main loop devices will be
1839 * multiples of max_part.
1840 *
1841 * Note: Global-for-all-devices, set-only-at-init, read-only module
1842 * parameteters like 'max_loop' and 'max_part' make things needlessly
1843 * complicated, are too static, inflexible and may surprise
1844 * userspace tools. Parameters like this in general should be avoided.
1845 */
1846 if (!part_shift)
1847 disk->flags |= GENHD_FL_NO_PART_SCAN;
1848 disk->flags |= GENHD_FL_EXT_DEVT;
73285082 1849 mutex_init(&lo->lo_ctl_mutex);
f8933667 1850 atomic_set(&lo->lo_refcnt, 0);
73285082 1851 lo->lo_number = i;
73285082
KC
1852 spin_lock_init(&lo->lo_lock);
1853 disk->major = LOOP_MAJOR;
476a4813 1854 disk->first_minor = i << part_shift;
73285082
KC
1855 disk->fops = &lo_fops;
1856 disk->private_data = lo;
1857 disk->queue = lo->lo_queue;
1858 sprintf(disk->disk_name, "loop%d", i);
34dd82af
KS
1859 add_disk(disk);
1860 *l = lo;
1861 return lo->lo_number;
73285082
KC
1862
1863out_free_queue:
1864 blk_cleanup_queue(lo->lo_queue);
b5dd2f60
ML
1865out_cleanup_tags:
1866 blk_mq_free_tag_set(&lo->tag_set);
3ec981e3
MP
1867out_free_idr:
1868 idr_remove(&loop_index_idr, i);
73285082
KC
1869out_free_dev:
1870 kfree(lo);
1871out:
34dd82af 1872 return err;
73285082
KC
1873}
1874
34dd82af 1875static void loop_remove(struct loop_device *lo)
1da177e4 1876{
6cd18e71 1877 del_gendisk(lo->lo_disk);
0fa8ebdd 1878 blk_cleanup_queue(lo->lo_queue);
b5dd2f60 1879 blk_mq_free_tag_set(&lo->tag_set);
73285082 1880 put_disk(lo->lo_disk);
73285082
KC
1881 kfree(lo);
1882}
1da177e4 1883
770fe30a
KS
1884static int find_free_cb(int id, void *ptr, void *data)
1885{
1886 struct loop_device *lo = ptr;
1887 struct loop_device **l = data;
1888
1889 if (lo->lo_state == Lo_unbound) {
1890 *l = lo;
1891 return 1;
1892 }
1893 return 0;
1894}
1895
34dd82af 1896static int loop_lookup(struct loop_device **l, int i)
a47653fc
KC
1897{
1898 struct loop_device *lo;
34dd82af 1899 int ret = -ENODEV;
a47653fc 1900
770fe30a
KS
1901 if (i < 0) {
1902 int err;
1903
1904 err = idr_for_each(&loop_index_idr, &find_free_cb, &lo);
1905 if (err == 1) {
1906 *l = lo;
1907 ret = lo->lo_number;
1908 }
1909 goto out;
a47653fc
KC
1910 }
1911
770fe30a 1912 /* lookup and return a specific i */
34dd82af 1913 lo = idr_find(&loop_index_idr, i);
a47653fc 1914 if (lo) {
34dd82af
KS
1915 *l = lo;
1916 ret = lo->lo_number;
a47653fc 1917 }
770fe30a 1918out:
34dd82af 1919 return ret;
a47653fc
KC
1920}
1921
73285082
KC
1922static struct kobject *loop_probe(dev_t dev, int *part, void *data)
1923{
705962cc 1924 struct loop_device *lo;
07002e99 1925 struct kobject *kobj;
34dd82af 1926 int err;
73285082 1927
34dd82af
KS
1928 mutex_lock(&loop_index_mutex);
1929 err = loop_lookup(&lo, MINOR(dev) >> part_shift);
1930 if (err < 0)
1931 err = loop_add(&lo, MINOR(dev) >> part_shift);
1932 if (err < 0)
a207f593 1933 kobj = NULL;
34dd82af 1934 else
3079c22e 1935 kobj = get_disk_and_module(lo->lo_disk);
34dd82af 1936 mutex_unlock(&loop_index_mutex);
73285082
KC
1937
1938 *part = 0;
07002e99 1939 return kobj;
73285082
KC
1940}
1941
770fe30a
KS
1942static long loop_control_ioctl(struct file *file, unsigned int cmd,
1943 unsigned long parm)
1944{
1945 struct loop_device *lo;
1946 int ret = -ENOSYS;
1947
1948 mutex_lock(&loop_index_mutex);
1949 switch (cmd) {
1950 case LOOP_CTL_ADD:
1951 ret = loop_lookup(&lo, parm);
1952 if (ret >= 0) {
1953 ret = -EEXIST;
1954 break;
1955 }
1956 ret = loop_add(&lo, parm);
1957 break;
1958 case LOOP_CTL_REMOVE:
1959 ret = loop_lookup(&lo, parm);
1960 if (ret < 0)
1961 break;
1962 mutex_lock(&lo->lo_ctl_mutex);
1963 if (lo->lo_state != Lo_unbound) {
1964 ret = -EBUSY;
1965 mutex_unlock(&lo->lo_ctl_mutex);
1966 break;
1967 }
f8933667 1968 if (atomic_read(&lo->lo_refcnt) > 0) {
770fe30a
KS
1969 ret = -EBUSY;
1970 mutex_unlock(&lo->lo_ctl_mutex);
1971 break;
1972 }
1973 lo->lo_disk->private_data = NULL;
1974 mutex_unlock(&lo->lo_ctl_mutex);
1975 idr_remove(&loop_index_idr, lo->lo_number);
1976 loop_remove(lo);
1977 break;
1978 case LOOP_CTL_GET_FREE:
1979 ret = loop_lookup(&lo, -1);
1980 if (ret >= 0)
1981 break;
1982 ret = loop_add(&lo, -1);
1983 }
1984 mutex_unlock(&loop_index_mutex);
1985
1986 return ret;
1987}
1988
1989static const struct file_operations loop_ctl_fops = {
1990 .open = nonseekable_open,
1991 .unlocked_ioctl = loop_control_ioctl,
1992 .compat_ioctl = loop_control_ioctl,
1993 .owner = THIS_MODULE,
1994 .llseek = noop_llseek,
1995};
1996
1997static struct miscdevice loop_misc = {
1998 .minor = LOOP_CTRL_MINOR,
1999 .name = "loop-control",
2000 .fops = &loop_ctl_fops,
2001};
2002
2003MODULE_ALIAS_MISCDEV(LOOP_CTRL_MINOR);
2004MODULE_ALIAS("devname:loop-control");
2005
73285082
KC
2006static int __init loop_init(void)
2007{
a47653fc
KC
2008 int i, nr;
2009 unsigned long range;
34dd82af 2010 struct loop_device *lo;
770fe30a 2011 int err;
a47653fc 2012
476a4813 2013 part_shift = 0;
ac04fee0 2014 if (max_part > 0) {
476a4813
LV
2015 part_shift = fls(max_part);
2016
ac04fee0
NK
2017 /*
2018 * Adjust max_part according to part_shift as it is exported
2019 * to user space so that user can decide correct minor number
2020 * if [s]he want to create more devices.
2021 *
2022 * Note that -1 is required because partition 0 is reserved
2023 * for the whole disk.
2024 */
2025 max_part = (1UL << part_shift) - 1;
2026 }
2027
b1a66504
GC
2028 if ((1UL << part_shift) > DISK_MAX_PARTS) {
2029 err = -EINVAL;
a8c1d064 2030 goto err_out;
b1a66504 2031 }
78f4bb36 2032
b1a66504
GC
2033 if (max_loop > 1UL << (MINORBITS - part_shift)) {
2034 err = -EINVAL;
a8c1d064 2035 goto err_out;
b1a66504 2036 }
1da177e4 2037
d134b00b
KS
2038 /*
2039 * If max_loop is specified, create that many devices upfront.
2040 * This also becomes a hard limit. If max_loop is not specified,
2041 * create CONFIG_BLK_DEV_LOOP_MIN_COUNT loop devices at module
2042 * init time. Loop devices can be requested on-demand with the
2043 * /dev/loop-control interface, or be instantiated by accessing
2044 * a 'dead' device node.
2045 */
73285082 2046 if (max_loop) {
a47653fc 2047 nr = max_loop;
a1c15c59 2048 range = max_loop << part_shift;
a47653fc 2049 } else {
d134b00b 2050 nr = CONFIG_BLK_DEV_LOOP_MIN_COUNT;
a1c15c59 2051 range = 1UL << MINORBITS;
a47653fc
KC
2052 }
2053
a8c1d064
AV
2054 err = misc_register(&loop_misc);
2055 if (err < 0)
2056 goto err_out;
2057
2058
b1a66504
GC
2059 if (register_blkdev(LOOP_MAJOR, "loop")) {
2060 err = -EIO;
2061 goto misc_out;
2062 }
1da177e4 2063
a47653fc
KC
2064 blk_register_region(MKDEV(LOOP_MAJOR, 0), range,
2065 THIS_MODULE, loop_probe, NULL, NULL);
2066
d134b00b 2067 /* pre-create number of devices given by config or max_loop */
34dd82af
KS
2068 mutex_lock(&loop_index_mutex);
2069 for (i = 0; i < nr; i++)
2070 loop_add(&lo, i);
2071 mutex_unlock(&loop_index_mutex);
2072
73285082 2073 printk(KERN_INFO "loop: module loaded\n");
1da177e4 2074 return 0;
b1a66504
GC
2075
2076misc_out:
2077 misc_deregister(&loop_misc);
a8c1d064 2078err_out:
b1a66504 2079 return err;
34dd82af 2080}
a47653fc 2081
34dd82af
KS
2082static int loop_exit_cb(int id, void *ptr, void *data)
2083{
2084 struct loop_device *lo = ptr;
a47653fc 2085
34dd82af
KS
2086 loop_remove(lo);
2087 return 0;
1da177e4
LT
2088}
2089
73285082 2090static void __exit loop_exit(void)
1da177e4 2091{
a47653fc 2092 unsigned long range;
1da177e4 2093
a1c15c59 2094 range = max_loop ? max_loop << part_shift : 1UL << MINORBITS;
a47653fc 2095
34dd82af 2096 idr_for_each(&loop_index_idr, &loop_exit_cb, NULL);
34dd82af 2097 idr_destroy(&loop_index_idr);
73285082 2098
a47653fc 2099 blk_unregister_region(MKDEV(LOOP_MAJOR, 0), range);
00d59405 2100 unregister_blkdev(LOOP_MAJOR, "loop");
770fe30a
KS
2101
2102 misc_deregister(&loop_misc);
1da177e4
LT
2103}
2104
2105module_init(loop_init);
2106module_exit(loop_exit);
2107
2108#ifndef MODULE
2109static int __init max_loop_setup(char *str)
2110{
2111 max_loop = simple_strtol(str, NULL, 0);
2112 return 1;
2113}
2114
2115__setup("max_loop=", max_loop_setup);
2116#endif