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