block: loop: introduce lo_discard() and lo_req_flush()
[linux-2.6-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>
b5dd2f60 78#include <linux/blk-mq.h>
83a87611 79#include "loop.h"
1da177e4
LT
80
81#include <asm/uaccess.h>
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
b5dd2f60
ML
89static struct workqueue_struct *loop_wq;
90
1da177e4
LT
91/*
92 * Transfer functions
93 */
94static int transfer_none(struct loop_device *lo, int cmd,
95 struct page *raw_page, unsigned raw_off,
96 struct page *loop_page, unsigned loop_off,
97 int size, sector_t real_block)
98{
cfd8005c
CW
99 char *raw_buf = kmap_atomic(raw_page) + raw_off;
100 char *loop_buf = kmap_atomic(loop_page) + loop_off;
1da177e4
LT
101
102 if (cmd == READ)
103 memcpy(loop_buf, raw_buf, size);
104 else
105 memcpy(raw_buf, loop_buf, size);
106
cfd8005c
CW
107 kunmap_atomic(loop_buf);
108 kunmap_atomic(raw_buf);
1da177e4
LT
109 cond_resched();
110 return 0;
111}
112
113static int transfer_xor(struct loop_device *lo, int cmd,
114 struct page *raw_page, unsigned raw_off,
115 struct page *loop_page, unsigned loop_off,
116 int size, sector_t real_block)
117{
cfd8005c
CW
118 char *raw_buf = kmap_atomic(raw_page) + raw_off;
119 char *loop_buf = kmap_atomic(loop_page) + loop_off;
1da177e4
LT
120 char *in, *out, *key;
121 int i, keysize;
122
123 if (cmd == READ) {
124 in = raw_buf;
125 out = loop_buf;
126 } else {
127 in = loop_buf;
128 out = raw_buf;
129 }
130
131 key = lo->lo_encrypt_key;
132 keysize = lo->lo_encrypt_key_size;
133 for (i = 0; i < size; i++)
134 *out++ = *in++ ^ key[(i & 511) % keysize];
135
cfd8005c
CW
136 kunmap_atomic(loop_buf);
137 kunmap_atomic(raw_buf);
1da177e4
LT
138 cond_resched();
139 return 0;
140}
141
142static int xor_init(struct loop_device *lo, const struct loop_info64 *info)
143{
144 if (unlikely(info->lo_encrypt_key_size <= 0))
145 return -EINVAL;
146 return 0;
147}
148
149static struct loop_func_table none_funcs = {
150 .number = LO_CRYPT_NONE,
151 .transfer = transfer_none,
152};
153
154static struct loop_func_table xor_funcs = {
155 .number = LO_CRYPT_XOR,
156 .transfer = transfer_xor,
157 .init = xor_init
158};
159
160/* xfer_funcs[0] is special - its release function is never called */
161static struct loop_func_table *xfer_funcs[MAX_LO_CRYPT] = {
162 &none_funcs,
163 &xor_funcs
164};
165
7035b5df 166static loff_t get_size(loff_t offset, loff_t sizelimit, struct file *file)
1da177e4 167{
b7a1da69 168 loff_t loopsize;
1da177e4
LT
169
170 /* Compute loopsize in bytes */
b7a1da69
GC
171 loopsize = i_size_read(file->f_mapping->host);
172 if (offset > 0)
173 loopsize -= offset;
174 /* offset is beyond i_size, weird but possible */
7035b5df
DM
175 if (loopsize < 0)
176 return 0;
1da177e4 177
7035b5df
DM
178 if (sizelimit > 0 && sizelimit < loopsize)
179 loopsize = sizelimit;
1da177e4
LT
180 /*
181 * Unfortunately, if we want to do I/O on the device,
182 * the number of 512-byte sectors has to fit into a sector_t.
183 */
184 return loopsize >> 9;
185}
186
7035b5df
DM
187static loff_t get_loop_size(struct loop_device *lo, struct file *file)
188{
189 return get_size(lo->lo_offset, lo->lo_sizelimit, file);
190}
191
1da177e4 192static int
7035b5df 193figure_loop_size(struct loop_device *lo, loff_t offset, loff_t sizelimit)
1da177e4 194{
7035b5df 195 loff_t size = get_size(offset, sizelimit, lo->lo_backing_file);
1da177e4 196 sector_t x = (sector_t)size;
7b0576a3 197 struct block_device *bdev = lo->lo_device;
1da177e4
LT
198
199 if (unlikely((loff_t)x != size))
200 return -EFBIG;
7035b5df
DM
201 if (lo->lo_offset != offset)
202 lo->lo_offset = offset;
203 if (lo->lo_sizelimit != sizelimit)
204 lo->lo_sizelimit = sizelimit;
73285082 205 set_capacity(lo->lo_disk, x);
7b0576a3
GC
206 bd_set_size(bdev, (loff_t)get_capacity(bdev->bd_disk) << 9);
207 /* let user-space know about the new size */
208 kobject_uevent(&disk_to_dev(bdev->bd_disk)->kobj, KOBJ_CHANGE);
7035b5df 209 return 0;
1da177e4
LT
210}
211
212static inline int
213lo_do_transfer(struct loop_device *lo, int cmd,
214 struct page *rpage, unsigned roffs,
215 struct page *lpage, unsigned loffs,
216 int size, sector_t rblock)
217{
218 if (unlikely(!lo->transfer))
219 return 0;
220
221 return lo->transfer(lo, cmd, rpage, roffs, lpage, loffs, size, rblock);
222}
223
1da177e4
LT
224/**
225 * __do_lo_send_write - helper for writing data to a loop device
226 *
227 * This helper just factors out common code between do_lo_send_direct_write()
228 * and do_lo_send_write().
229 */
858119e1 230static int __do_lo_send_write(struct file *file,
98ae6ccd 231 u8 *buf, const int len, loff_t pos)
1da177e4
LT
232{
233 ssize_t bw;
234 mm_segment_t old_fs = get_fs();
235
03d95eb2 236 file_start_write(file);
1da177e4
LT
237 set_fs(get_ds());
238 bw = file->f_op->write(file, buf, len, &pos);
239 set_fs(old_fs);
03d95eb2 240 file_end_write(file);
1da177e4
LT
241 if (likely(bw == len))
242 return 0;
44bd70c3 243 printk_ratelimited(KERN_ERR "loop: Write error at byte offset %llu, length %i.\n",
1da177e4
LT
244 (unsigned long long)pos, len);
245 if (bw >= 0)
246 bw = -EIO;
247 return bw;
248}
249
250/**
251 * do_lo_send_direct_write - helper for writing data to a loop device
252 *
456be148
CH
253 * This is the fast, non-transforming version that does not need double
254 * buffering.
1da177e4
LT
255 */
256static int do_lo_send_direct_write(struct loop_device *lo,
511de73f 257 struct bio_vec *bvec, loff_t pos, struct page *page)
1da177e4
LT
258{
259 ssize_t bw = __do_lo_send_write(lo->lo_backing_file,
98ae6ccd 260 kmap(bvec->bv_page) + bvec->bv_offset,
1da177e4
LT
261 bvec->bv_len, pos);
262 kunmap(bvec->bv_page);
263 cond_resched();
264 return bw;
265}
266
267/**
268 * do_lo_send_write - helper for writing data to a loop device
269 *
456be148
CH
270 * This is the slow, transforming version that needs to double buffer the
271 * data as it cannot do the transformations in place without having direct
272 * access to the destination pages of the backing file.
1da177e4
LT
273 */
274static int do_lo_send_write(struct loop_device *lo, struct bio_vec *bvec,
511de73f 275 loff_t pos, struct page *page)
1da177e4
LT
276{
277 int ret = lo_do_transfer(lo, WRITE, page, 0, bvec->bv_page,
278 bvec->bv_offset, bvec->bv_len, pos >> 9);
279 if (likely(!ret))
280 return __do_lo_send_write(lo->lo_backing_file,
98ae6ccd 281 page_address(page), bvec->bv_len,
1da177e4 282 pos);
44bd70c3 283 printk_ratelimited(KERN_ERR "loop: Transfer error at byte offset %llu, "
1da177e4
LT
284 "length %i.\n", (unsigned long long)pos, bvec->bv_len);
285 if (ret > 0)
286 ret = -EIO;
287 return ret;
288}
289
30112013 290static int lo_send(struct loop_device *lo, struct request *rq, loff_t pos)
1da177e4 291{
511de73f 292 int (*do_lo_send)(struct loop_device *, struct bio_vec *, loff_t,
1da177e4 293 struct page *page);
7988613b 294 struct bio_vec bvec;
30112013 295 struct req_iterator iter;
1da177e4 296 struct page *page = NULL;
7988613b 297 int ret = 0;
1da177e4 298
456be148
CH
299 if (lo->transfer != transfer_none) {
300 page = alloc_page(GFP_NOIO | __GFP_HIGHMEM);
301 if (unlikely(!page))
302 goto fail;
303 kmap(page);
304 do_lo_send = do_lo_send_write;
305 } else {
1da177e4 306 do_lo_send = do_lo_send_direct_write;
1da177e4 307 }
456be148 308
30112013 309 rq_for_each_segment(bvec, rq, iter) {
7988613b 310 ret = do_lo_send(lo, &bvec, pos, page);
1da177e4
LT
311 if (ret < 0)
312 break;
7988613b 313 pos += bvec.bv_len;
1da177e4
LT
314 }
315 if (page) {
316 kunmap(page);
317 __free_page(page);
318 }
319out:
320 return ret;
321fail:
44bd70c3 322 printk_ratelimited(KERN_ERR "loop: Failed to allocate temporary page for write.\n");
1da177e4
LT
323 ret = -ENOMEM;
324 goto out;
325}
326
327struct lo_read_data {
328 struct loop_device *lo;
329 struct page *page;
330 unsigned offset;
331 int bsize;
332};
333
334static int
fd582140
JA
335lo_splice_actor(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
336 struct splice_desc *sd)
1da177e4 337{
fd582140 338 struct lo_read_data *p = sd->u.data;
1da177e4 339 struct loop_device *lo = p->lo;
fd582140 340 struct page *page = buf->page;
1da177e4 341 sector_t IV;
3603b8ea 342 int size;
1da177e4 343
fd582140
JA
344 IV = ((sector_t) page->index << (PAGE_CACHE_SHIFT - 9)) +
345 (buf->offset >> 9);
346 size = sd->len;
347 if (size > p->bsize)
348 size = p->bsize;
1da177e4 349
fd582140 350 if (lo_do_transfer(lo, READ, page, buf->offset, p->page, p->offset, size, IV)) {
44bd70c3 351 printk_ratelimited(KERN_ERR "loop: transfer error block %ld\n",
1da177e4 352 page->index);
fd582140 353 size = -EINVAL;
1da177e4
LT
354 }
355
356 flush_dcache_page(p->page);
357
fd582140
JA
358 if (size > 0)
359 p->offset += size;
360
1da177e4
LT
361 return size;
362}
363
fd582140
JA
364static int
365lo_direct_splice_actor(struct pipe_inode_info *pipe, struct splice_desc *sd)
366{
367 return __splice_from_pipe(pipe, sd, lo_splice_actor);
368}
369
306df071 370static ssize_t
1da177e4
LT
371do_lo_receive(struct loop_device *lo,
372 struct bio_vec *bvec, int bsize, loff_t pos)
373{
374 struct lo_read_data cookie;
fd582140 375 struct splice_desc sd;
1da177e4 376 struct file *file;
306df071 377 ssize_t retval;
1da177e4
LT
378
379 cookie.lo = lo;
380 cookie.page = bvec->bv_page;
381 cookie.offset = bvec->bv_offset;
382 cookie.bsize = bsize;
fd582140
JA
383
384 sd.len = 0;
385 sd.total_len = bvec->bv_len;
386 sd.flags = 0;
387 sd.pos = pos;
388 sd.u.data = &cookie;
389
1da177e4 390 file = lo->lo_backing_file;
fd582140
JA
391 retval = splice_direct_to_actor(file, &sd, lo_direct_splice_actor);
392
306df071 393 return retval;
1da177e4
LT
394}
395
396static int
30112013 397lo_receive(struct loop_device *lo, struct request *rq, int bsize, loff_t pos)
1da177e4 398{
7988613b 399 struct bio_vec bvec;
30112013 400 struct req_iterator iter;
306df071 401 ssize_t s;
1da177e4 402
30112013 403 rq_for_each_segment(bvec, rq, iter) {
7988613b 404 s = do_lo_receive(lo, &bvec, bsize, pos);
306df071
DY
405 if (s < 0)
406 return s;
407
7988613b 408 if (s != bvec.bv_len) {
30112013
ML
409 struct bio *bio;
410
411 __rq_for_each_bio(bio, rq)
412 zero_fill_bio(bio);
1da177e4 413 break;
306df071 414 }
7988613b 415 pos += bvec.bv_len;
1da177e4 416 }
306df071 417 return 0;
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
30112013 454static int do_req_filebacked(struct loop_device *lo, struct request *rq)
1da177e4
LT
455{
456 loff_t pos;
457 int ret;
458
30112013 459 pos = ((loff_t) blk_rq_pos(rq) << 9) + lo->lo_offset;
68db1961 460
30112013 461 if (rq->cmd_flags & REQ_WRITE) {
68db1961 462
cf655d95
ML
463 if (rq->cmd_flags & REQ_FLUSH)
464 ret = lo_req_flush(lo, rq);
465
30112013 466 if (rq->cmd_flags & REQ_DISCARD) {
cf655d95 467 ret = lo_discard(lo, rq, pos);
dfaa2ef6
LC
468 goto out;
469 }
470
30112013 471 ret = lo_send(lo, rq, pos);
68db1961 472
cf655d95
ML
473 if ((rq->cmd_flags & REQ_FUA) && !ret)
474 ret = lo_req_flush(lo, rq);
68db1961 475 } else
30112013 476 ret = lo_receive(lo, rq, lo->lo_blocksize, pos);
68db1961
NK
477
478out:
1da177e4
LT
479 return ret;
480}
481
1da177e4
LT
482struct switch_request {
483 struct file *file;
484 struct completion wait;
485};
486
1da177e4 487/*
b5dd2f60 488 * Do the actual switch; called from the BIO completion routine
1da177e4 489 */
b5dd2f60 490static void do_loop_switch(struct loop_device *lo, struct switch_request *p)
1da177e4 491{
b5dd2f60
ML
492 struct file *file = p->file;
493 struct file *old_file = lo->lo_backing_file;
494 struct address_space *mapping;
35a82d1a 495
b5dd2f60
ML
496 /* if no new file, only flush of queued bios requested */
497 if (!file)
498 return;
1da177e4 499
b5dd2f60
ML
500 mapping = file->f_mapping;
501 mapping_set_gfp_mask(old_file->f_mapping, lo->old_gfp_mask);
502 lo->lo_backing_file = file;
503 lo->lo_blocksize = S_ISBLK(mapping->host->i_mode) ?
504 mapping->host->i_bdev->bd_block_size : PAGE_SIZE;
505 lo->old_gfp_mask = mapping_gfp_mask(mapping);
506 mapping_set_gfp_mask(mapping, lo->old_gfp_mask & ~(__GFP_IO|__GFP_FS));
1da177e4
LT
507}
508
509/*
510 * loop_switch performs the hard work of switching a backing store.
511 * First it needs to flush existing IO, it does this by sending a magic
512 * BIO down the pipe. The completion of this BIO does the actual switch.
513 */
514static int loop_switch(struct loop_device *lo, struct file *file)
515{
516 struct switch_request w;
b5dd2f60 517
1da177e4 518 w.file = file;
b5dd2f60
ML
519
520 /* freeze queue and wait for completion of scheduled requests */
521 blk_mq_freeze_queue(lo->lo_queue);
522
523 /* do the switch action */
524 do_loop_switch(lo, &w);
525
526 /* unfreeze */
527 blk_mq_unfreeze_queue(lo->lo_queue);
528
1da177e4
LT
529 return 0;
530}
531
14f27939
MB
532/*
533 * Helper to flush the IOs in loop, but keeping loop thread running
534 */
535static int loop_flush(struct loop_device *lo)
536{
14f27939
MB
537 return loop_switch(lo, NULL);
538}
539
1da177e4
LT
540/*
541 * loop_change_fd switched the backing store of a loopback device to
542 * a new file. This is useful for operating system installers to free up
543 * the original file and in High Availability environments to switch to
544 * an alternative location for the content in case of server meltdown.
545 * This can only work if the loop device is used read-only, and if the
546 * new backing store is the same size and type as the old backing store.
547 */
bb214884
AV
548static int loop_change_fd(struct loop_device *lo, struct block_device *bdev,
549 unsigned int arg)
1da177e4
LT
550{
551 struct file *file, *old_file;
552 struct inode *inode;
553 int error;
554
555 error = -ENXIO;
556 if (lo->lo_state != Lo_bound)
557 goto out;
558
559 /* the loop device has to be read-only */
560 error = -EINVAL;
561 if (!(lo->lo_flags & LO_FLAGS_READ_ONLY))
562 goto out;
563
564 error = -EBADF;
565 file = fget(arg);
566 if (!file)
567 goto out;
568
569 inode = file->f_mapping->host;
570 old_file = lo->lo_backing_file;
571
572 error = -EINVAL;
573
574 if (!S_ISREG(inode->i_mode) && !S_ISBLK(inode->i_mode))
575 goto out_putf;
576
1da177e4
LT
577 /* size of the new backing store needs to be the same */
578 if (get_loop_size(lo, file) != get_loop_size(lo, old_file))
579 goto out_putf;
580
581 /* and ... switch */
582 error = loop_switch(lo, file);
583 if (error)
584 goto out_putf;
585
586 fput(old_file);
e03c8dd1 587 if (lo->lo_flags & LO_FLAGS_PARTSCAN)
476a4813 588 ioctl_by_bdev(bdev, BLKRRPART, 0);
1da177e4
LT
589 return 0;
590
591 out_putf:
592 fput(file);
593 out:
594 return error;
595}
596
597static inline int is_loop_device(struct file *file)
598{
599 struct inode *i = file->f_mapping->host;
600
601 return i && S_ISBLK(i->i_mode) && MAJOR(i->i_rdev) == LOOP_MAJOR;
602}
603
ee862730
MB
604/* loop sysfs attributes */
605
606static ssize_t loop_attr_show(struct device *dev, char *page,
607 ssize_t (*callback)(struct loop_device *, char *))
608{
34dd82af
KS
609 struct gendisk *disk = dev_to_disk(dev);
610 struct loop_device *lo = disk->private_data;
ee862730 611
34dd82af 612 return callback(lo, page);
ee862730
MB
613}
614
615#define LOOP_ATTR_RO(_name) \
616static ssize_t loop_attr_##_name##_show(struct loop_device *, char *); \
617static ssize_t loop_attr_do_show_##_name(struct device *d, \
618 struct device_attribute *attr, char *b) \
619{ \
620 return loop_attr_show(d, b, loop_attr_##_name##_show); \
621} \
622static struct device_attribute loop_attr_##_name = \
623 __ATTR(_name, S_IRUGO, loop_attr_do_show_##_name, NULL);
624
625static ssize_t loop_attr_backing_file_show(struct loop_device *lo, char *buf)
626{
627 ssize_t ret;
628 char *p = NULL;
629
05eb0f25 630 spin_lock_irq(&lo->lo_lock);
ee862730
MB
631 if (lo->lo_backing_file)
632 p = d_path(&lo->lo_backing_file->f_path, buf, PAGE_SIZE - 1);
05eb0f25 633 spin_unlock_irq(&lo->lo_lock);
ee862730
MB
634
635 if (IS_ERR_OR_NULL(p))
636 ret = PTR_ERR(p);
637 else {
638 ret = strlen(p);
639 memmove(buf, p, ret);
640 buf[ret++] = '\n';
641 buf[ret] = 0;
642 }
643
644 return ret;
645}
646
647static ssize_t loop_attr_offset_show(struct loop_device *lo, char *buf)
648{
649 return sprintf(buf, "%llu\n", (unsigned long long)lo->lo_offset);
650}
651
652static ssize_t loop_attr_sizelimit_show(struct loop_device *lo, char *buf)
653{
654 return sprintf(buf, "%llu\n", (unsigned long long)lo->lo_sizelimit);
655}
656
657static ssize_t loop_attr_autoclear_show(struct loop_device *lo, char *buf)
658{
659 int autoclear = (lo->lo_flags & LO_FLAGS_AUTOCLEAR);
660
661 return sprintf(buf, "%s\n", autoclear ? "1" : "0");
662}
663
e03c8dd1
KS
664static ssize_t loop_attr_partscan_show(struct loop_device *lo, char *buf)
665{
666 int partscan = (lo->lo_flags & LO_FLAGS_PARTSCAN);
667
668 return sprintf(buf, "%s\n", partscan ? "1" : "0");
669}
670
ee862730
MB
671LOOP_ATTR_RO(backing_file);
672LOOP_ATTR_RO(offset);
673LOOP_ATTR_RO(sizelimit);
674LOOP_ATTR_RO(autoclear);
e03c8dd1 675LOOP_ATTR_RO(partscan);
ee862730
MB
676
677static struct attribute *loop_attrs[] = {
678 &loop_attr_backing_file.attr,
679 &loop_attr_offset.attr,
680 &loop_attr_sizelimit.attr,
681 &loop_attr_autoclear.attr,
e03c8dd1 682 &loop_attr_partscan.attr,
ee862730
MB
683 NULL,
684};
685
686static struct attribute_group loop_attribute_group = {
687 .name = "loop",
688 .attrs= loop_attrs,
689};
690
691static int loop_sysfs_init(struct loop_device *lo)
692{
693 return sysfs_create_group(&disk_to_dev(lo->lo_disk)->kobj,
694 &loop_attribute_group);
695}
696
697static void loop_sysfs_exit(struct loop_device *lo)
698{
699 sysfs_remove_group(&disk_to_dev(lo->lo_disk)->kobj,
700 &loop_attribute_group);
701}
702
dfaa2ef6
LC
703static void loop_config_discard(struct loop_device *lo)
704{
705 struct file *file = lo->lo_backing_file;
706 struct inode *inode = file->f_mapping->host;
707 struct request_queue *q = lo->lo_queue;
708
709 /*
710 * We use punch hole to reclaim the free space used by the
12a64d2f 711 * image a.k.a. discard. However we do not support discard if
dfaa2ef6
LC
712 * encryption is enabled, because it may give an attacker
713 * useful information.
714 */
715 if ((!file->f_op->fallocate) ||
716 lo->lo_encrypt_key_size) {
717 q->limits.discard_granularity = 0;
718 q->limits.discard_alignment = 0;
719 q->limits.max_discard_sectors = 0;
720 q->limits.discard_zeroes_data = 0;
721 queue_flag_clear_unlocked(QUEUE_FLAG_DISCARD, q);
722 return;
723 }
724
725 q->limits.discard_granularity = inode->i_sb->s_blocksize;
dfaf3c03 726 q->limits.discard_alignment = 0;
dfaa2ef6
LC
727 q->limits.max_discard_sectors = UINT_MAX >> 9;
728 q->limits.discard_zeroes_data = 1;
729 queue_flag_set_unlocked(QUEUE_FLAG_DISCARD, q);
730}
731
bb214884 732static int loop_set_fd(struct loop_device *lo, fmode_t mode,
1da177e4
LT
733 struct block_device *bdev, unsigned int arg)
734{
735 struct file *file, *f;
736 struct inode *inode;
737 struct address_space *mapping;
738 unsigned lo_blocksize;
739 int lo_flags = 0;
740 int error;
741 loff_t size;
742
743 /* This is safe, since we have a reference from open(). */
744 __module_get(THIS_MODULE);
745
746 error = -EBADF;
747 file = fget(arg);
748 if (!file)
749 goto out;
750
751 error = -EBUSY;
752 if (lo->lo_state != Lo_unbound)
753 goto out_putf;
754
755 /* Avoid recursion */
756 f = file;
757 while (is_loop_device(f)) {
758 struct loop_device *l;
759
bb214884 760 if (f->f_mapping->host->i_bdev == bdev)
1da177e4
LT
761 goto out_putf;
762
763 l = f->f_mapping->host->i_bdev->bd_disk->private_data;
764 if (l->lo_state == Lo_unbound) {
765 error = -EINVAL;
766 goto out_putf;
767 }
768 f = l->lo_backing_file;
769 }
770
771 mapping = file->f_mapping;
772 inode = mapping->host;
773
1da177e4 774 error = -EINVAL;
456be148
CH
775 if (!S_ISREG(inode->i_mode) && !S_ISBLK(inode->i_mode))
776 goto out_putf;
1da177e4 777
456be148
CH
778 if (!(file->f_mode & FMODE_WRITE) || !(mode & FMODE_WRITE) ||
779 !file->f_op->write)
780 lo_flags |= LO_FLAGS_READ_ONLY;
ba52de12 781
456be148
CH
782 lo_blocksize = S_ISBLK(inode->i_mode) ?
783 inode->i_bdev->bd_block_size : PAGE_SIZE;
1da177e4 784
456be148 785 error = -EFBIG;
1da177e4 786 size = get_loop_size(lo, file);
456be148 787 if ((loff_t)(sector_t)size != size)
1da177e4 788 goto out_putf;
1da177e4 789
456be148 790 error = 0;
1da177e4
LT
791
792 set_device_ro(bdev, (lo_flags & LO_FLAGS_READ_ONLY) != 0);
793
794 lo->lo_blocksize = lo_blocksize;
795 lo->lo_device = bdev;
796 lo->lo_flags = lo_flags;
797 lo->lo_backing_file = file;
eefe85ee 798 lo->transfer = transfer_none;
1da177e4
LT
799 lo->ioctl = NULL;
800 lo->lo_sizelimit = 0;
801 lo->old_gfp_mask = mapping_gfp_mask(mapping);
802 mapping_set_gfp_mask(mapping, lo->old_gfp_mask & ~(__GFP_IO|__GFP_FS));
803
68db1961 804 if (!(lo_flags & LO_FLAGS_READ_ONLY) && file->f_op->fsync)
4913efe4 805 blk_queue_flush(lo->lo_queue, REQ_FLUSH);
68db1961 806
73285082 807 set_capacity(lo->lo_disk, size);
1da177e4 808 bd_set_size(bdev, size << 9);
ee862730 809 loop_sysfs_init(lo);
c3473c63
DZ
810 /* let user-space know about the new size */
811 kobject_uevent(&disk_to_dev(bdev->bd_disk)->kobj, KOBJ_CHANGE);
1da177e4
LT
812
813 set_blocksize(bdev, lo_blocksize);
814
6c997918 815 lo->lo_state = Lo_bound;
e03c8dd1
KS
816 if (part_shift)
817 lo->lo_flags |= LO_FLAGS_PARTSCAN;
818 if (lo->lo_flags & LO_FLAGS_PARTSCAN)
476a4813 819 ioctl_by_bdev(bdev, BLKRRPART, 0);
c1681bf8
AP
820
821 /* Grab the block_device to prevent its destruction after we
822 * put /dev/loopXX inode. Later in loop_clr_fd() we bdput(bdev).
823 */
824 bdgrab(bdev);
1da177e4
LT
825 return 0;
826
827 out_putf:
828 fput(file);
829 out:
830 /* This is safe: open() is still holding a reference. */
831 module_put(THIS_MODULE);
832 return error;
833}
834
835static int
836loop_release_xfer(struct loop_device *lo)
837{
838 int err = 0;
839 struct loop_func_table *xfer = lo->lo_encryption;
840
841 if (xfer) {
842 if (xfer->release)
843 err = xfer->release(lo);
844 lo->transfer = NULL;
845 lo->lo_encryption = NULL;
846 module_put(xfer->owner);
847 }
848 return err;
849}
850
851static int
852loop_init_xfer(struct loop_device *lo, struct loop_func_table *xfer,
853 const struct loop_info64 *i)
854{
855 int err = 0;
856
857 if (xfer) {
858 struct module *owner = xfer->owner;
859
860 if (!try_module_get(owner))
861 return -EINVAL;
862 if (xfer->init)
863 err = xfer->init(lo, i);
864 if (err)
865 module_put(owner);
866 else
867 lo->lo_encryption = xfer;
868 }
869 return err;
870}
871
4c823cc3 872static int loop_clr_fd(struct loop_device *lo)
1da177e4
LT
873{
874 struct file *filp = lo->lo_backing_file;
b4e3ca1a 875 gfp_t gfp = lo->old_gfp_mask;
4c823cc3 876 struct block_device *bdev = lo->lo_device;
1da177e4
LT
877
878 if (lo->lo_state != Lo_bound)
879 return -ENXIO;
880
a1ecac3b
DC
881 /*
882 * If we've explicitly asked to tear down the loop device,
883 * and it has an elevated reference count, set it for auto-teardown when
884 * the last reference goes away. This stops $!~#$@ udev from
885 * preventing teardown because it decided that it needs to run blkid on
886 * the loopback device whenever they appear. xfstests is notorious for
887 * failing tests because blkid via udev races with a losetup
888 * <dev>/do something like mkfs/losetup -d <dev> causing the losetup -d
889 * command to fail with EBUSY.
890 */
891 if (lo->lo_refcnt > 1) {
892 lo->lo_flags |= LO_FLAGS_AUTOCLEAR;
893 mutex_unlock(&lo->lo_ctl_mutex);
894 return 0;
895 }
1da177e4
LT
896
897 if (filp == NULL)
898 return -EINVAL;
899
900 spin_lock_irq(&lo->lo_lock);
901 lo->lo_state = Lo_rundown;
1da177e4 902 lo->lo_backing_file = NULL;
05eb0f25 903 spin_unlock_irq(&lo->lo_lock);
1da177e4
LT
904
905 loop_release_xfer(lo);
906 lo->transfer = NULL;
907 lo->ioctl = NULL;
908 lo->lo_device = NULL;
909 lo->lo_encryption = NULL;
910 lo->lo_offset = 0;
911 lo->lo_sizelimit = 0;
912 lo->lo_encrypt_key_size = 0;
1da177e4
LT
913 memset(lo->lo_encrypt_key, 0, LO_KEY_SIZE);
914 memset(lo->lo_crypt_name, 0, LO_NAME_SIZE);
915 memset(lo->lo_file_name, 0, LO_NAME_SIZE);
c1681bf8
AP
916 if (bdev) {
917 bdput(bdev);
bb214884 918 invalidate_bdev(bdev);
c1681bf8 919 }
73285082 920 set_capacity(lo->lo_disk, 0);
51a0bb0c 921 loop_sysfs_exit(lo);
c3473c63 922 if (bdev) {
bb214884 923 bd_set_size(bdev, 0);
c3473c63
DZ
924 /* let user-space know about this change */
925 kobject_uevent(&disk_to_dev(bdev->bd_disk)->kobj, KOBJ_CHANGE);
926 }
1da177e4
LT
927 mapping_set_gfp_mask(filp->f_mapping, gfp);
928 lo->lo_state = Lo_unbound;
1da177e4
LT
929 /* This is safe: open() is still holding a reference. */
930 module_put(THIS_MODULE);
c2fccc1c
JA
931 if (lo->lo_flags & LO_FLAGS_PARTSCAN && bdev)
932 ioctl_by_bdev(bdev, BLKRRPART, 0);
e03c8dd1
KS
933 lo->lo_flags = 0;
934 if (!part_shift)
935 lo->lo_disk->flags |= GENHD_FL_NO_PART_SCAN;
f028f3b2
NK
936 mutex_unlock(&lo->lo_ctl_mutex);
937 /*
938 * Need not hold lo_ctl_mutex to fput backing file.
939 * Calling fput holding lo_ctl_mutex triggers a circular
940 * lock dependency possibility warning as fput can take
941 * bd_mutex which is usually taken before lo_ctl_mutex.
942 */
943 fput(filp);
1da177e4
LT
944 return 0;
945}
946
947static int
948loop_set_status(struct loop_device *lo, const struct loop_info64 *info)
949{
950 int err;
951 struct loop_func_table *xfer;
e4849737 952 kuid_t uid = current_uid();
1da177e4 953
b0fafa81 954 if (lo->lo_encrypt_key_size &&
e4849737 955 !uid_eq(lo->lo_key_owner, uid) &&
1da177e4
LT
956 !capable(CAP_SYS_ADMIN))
957 return -EPERM;
958 if (lo->lo_state != Lo_bound)
959 return -ENXIO;
960 if ((unsigned int) info->lo_encrypt_key_size > LO_KEY_SIZE)
961 return -EINVAL;
962
963 err = loop_release_xfer(lo);
964 if (err)
965 return err;
966
967 if (info->lo_encrypt_type) {
968 unsigned int type = info->lo_encrypt_type;
969
970 if (type >= MAX_LO_CRYPT)
971 return -EINVAL;
972 xfer = xfer_funcs[type];
973 if (xfer == NULL)
974 return -EINVAL;
975 } else
976 xfer = NULL;
977
978 err = loop_init_xfer(lo, xfer, info);
979 if (err)
980 return err;
981
982 if (lo->lo_offset != info->lo_offset ||
7b0576a3 983 lo->lo_sizelimit != info->lo_sizelimit)
7035b5df 984 if (figure_loop_size(lo, info->lo_offset, info->lo_sizelimit))
1da177e4 985 return -EFBIG;
541c742a 986
dfaa2ef6 987 loop_config_discard(lo);
1da177e4
LT
988
989 memcpy(lo->lo_file_name, info->lo_file_name, LO_NAME_SIZE);
990 memcpy(lo->lo_crypt_name, info->lo_crypt_name, LO_NAME_SIZE);
991 lo->lo_file_name[LO_NAME_SIZE-1] = 0;
992 lo->lo_crypt_name[LO_NAME_SIZE-1] = 0;
993
994 if (!xfer)
995 xfer = &none_funcs;
996 lo->transfer = xfer->transfer;
997 lo->ioctl = xfer->ioctl;
998
96c58655
DW
999 if ((lo->lo_flags & LO_FLAGS_AUTOCLEAR) !=
1000 (info->lo_flags & LO_FLAGS_AUTOCLEAR))
1001 lo->lo_flags ^= LO_FLAGS_AUTOCLEAR;
1002
e03c8dd1
KS
1003 if ((info->lo_flags & LO_FLAGS_PARTSCAN) &&
1004 !(lo->lo_flags & LO_FLAGS_PARTSCAN)) {
1005 lo->lo_flags |= LO_FLAGS_PARTSCAN;
1006 lo->lo_disk->flags &= ~GENHD_FL_NO_PART_SCAN;
1007 ioctl_by_bdev(lo->lo_device, BLKRRPART, 0);
1008 }
1009
1da177e4
LT
1010 lo->lo_encrypt_key_size = info->lo_encrypt_key_size;
1011 lo->lo_init[0] = info->lo_init[0];
1012 lo->lo_init[1] = info->lo_init[1];
1013 if (info->lo_encrypt_key_size) {
1014 memcpy(lo->lo_encrypt_key, info->lo_encrypt_key,
1015 info->lo_encrypt_key_size);
b0fafa81 1016 lo->lo_key_owner = uid;
1da177e4
LT
1017 }
1018
1019 return 0;
1020}
1021
1022static int
1023loop_get_status(struct loop_device *lo, struct loop_info64 *info)
1024{
1025 struct file *file = lo->lo_backing_file;
1026 struct kstat stat;
1027 int error;
1028
1029 if (lo->lo_state != Lo_bound)
1030 return -ENXIO;
3dadecce 1031 error = vfs_getattr(&file->f_path, &stat);
1da177e4
LT
1032 if (error)
1033 return error;
1034 memset(info, 0, sizeof(*info));
1035 info->lo_number = lo->lo_number;
1036 info->lo_device = huge_encode_dev(stat.dev);
1037 info->lo_inode = stat.ino;
1038 info->lo_rdevice = huge_encode_dev(lo->lo_device ? stat.rdev : stat.dev);
1039 info->lo_offset = lo->lo_offset;
1040 info->lo_sizelimit = lo->lo_sizelimit;
1041 info->lo_flags = lo->lo_flags;
1042 memcpy(info->lo_file_name, lo->lo_file_name, LO_NAME_SIZE);
1043 memcpy(info->lo_crypt_name, lo->lo_crypt_name, LO_NAME_SIZE);
1044 info->lo_encrypt_type =
1045 lo->lo_encryption ? lo->lo_encryption->number : 0;
1046 if (lo->lo_encrypt_key_size && capable(CAP_SYS_ADMIN)) {
1047 info->lo_encrypt_key_size = lo->lo_encrypt_key_size;
1048 memcpy(info->lo_encrypt_key, lo->lo_encrypt_key,
1049 lo->lo_encrypt_key_size);
1050 }
1051 return 0;
1052}
1053
1054static void
1055loop_info64_from_old(const struct loop_info *info, struct loop_info64 *info64)
1056{
1057 memset(info64, 0, sizeof(*info64));
1058 info64->lo_number = info->lo_number;
1059 info64->lo_device = info->lo_device;
1060 info64->lo_inode = info->lo_inode;
1061 info64->lo_rdevice = info->lo_rdevice;
1062 info64->lo_offset = info->lo_offset;
1063 info64->lo_sizelimit = 0;
1064 info64->lo_encrypt_type = info->lo_encrypt_type;
1065 info64->lo_encrypt_key_size = info->lo_encrypt_key_size;
1066 info64->lo_flags = info->lo_flags;
1067 info64->lo_init[0] = info->lo_init[0];
1068 info64->lo_init[1] = info->lo_init[1];
1069 if (info->lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1070 memcpy(info64->lo_crypt_name, info->lo_name, LO_NAME_SIZE);
1071 else
1072 memcpy(info64->lo_file_name, info->lo_name, LO_NAME_SIZE);
1073 memcpy(info64->lo_encrypt_key, info->lo_encrypt_key, LO_KEY_SIZE);
1074}
1075
1076static int
1077loop_info64_to_old(const struct loop_info64 *info64, struct loop_info *info)
1078{
1079 memset(info, 0, sizeof(*info));
1080 info->lo_number = info64->lo_number;
1081 info->lo_device = info64->lo_device;
1082 info->lo_inode = info64->lo_inode;
1083 info->lo_rdevice = info64->lo_rdevice;
1084 info->lo_offset = info64->lo_offset;
1085 info->lo_encrypt_type = info64->lo_encrypt_type;
1086 info->lo_encrypt_key_size = info64->lo_encrypt_key_size;
1087 info->lo_flags = info64->lo_flags;
1088 info->lo_init[0] = info64->lo_init[0];
1089 info->lo_init[1] = info64->lo_init[1];
1090 if (info->lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1091 memcpy(info->lo_name, info64->lo_crypt_name, LO_NAME_SIZE);
1092 else
1093 memcpy(info->lo_name, info64->lo_file_name, LO_NAME_SIZE);
1094 memcpy(info->lo_encrypt_key, info64->lo_encrypt_key, LO_KEY_SIZE);
1095
1096 /* error in case values were truncated */
1097 if (info->lo_device != info64->lo_device ||
1098 info->lo_rdevice != info64->lo_rdevice ||
1099 info->lo_inode != info64->lo_inode ||
1100 info->lo_offset != info64->lo_offset)
1101 return -EOVERFLOW;
1102
1103 return 0;
1104}
1105
1106static int
1107loop_set_status_old(struct loop_device *lo, const struct loop_info __user *arg)
1108{
1109 struct loop_info info;
1110 struct loop_info64 info64;
1111
1112 if (copy_from_user(&info, arg, sizeof (struct loop_info)))
1113 return -EFAULT;
1114 loop_info64_from_old(&info, &info64);
1115 return loop_set_status(lo, &info64);
1116}
1117
1118static int
1119loop_set_status64(struct loop_device *lo, const struct loop_info64 __user *arg)
1120{
1121 struct loop_info64 info64;
1122
1123 if (copy_from_user(&info64, arg, sizeof (struct loop_info64)))
1124 return -EFAULT;
1125 return loop_set_status(lo, &info64);
1126}
1127
1128static int
1129loop_get_status_old(struct loop_device *lo, struct loop_info __user *arg) {
1130 struct loop_info info;
1131 struct loop_info64 info64;
1132 int err = 0;
1133
1134 if (!arg)
1135 err = -EINVAL;
1136 if (!err)
1137 err = loop_get_status(lo, &info64);
1138 if (!err)
1139 err = loop_info64_to_old(&info64, &info);
1140 if (!err && copy_to_user(arg, &info, sizeof(info)))
1141 err = -EFAULT;
1142
1143 return err;
1144}
1145
1146static int
1147loop_get_status64(struct loop_device *lo, struct loop_info64 __user *arg) {
1148 struct loop_info64 info64;
1149 int err = 0;
1150
1151 if (!arg)
1152 err = -EINVAL;
1153 if (!err)
1154 err = loop_get_status(lo, &info64);
1155 if (!err && copy_to_user(arg, &info64, sizeof(info64)))
1156 err = -EFAULT;
1157
1158 return err;
1159}
1160
53d66608
O
1161static int loop_set_capacity(struct loop_device *lo, struct block_device *bdev)
1162{
53d66608 1163 if (unlikely(lo->lo_state != Lo_bound))
7b0576a3 1164 return -ENXIO;
53d66608 1165
7b0576a3 1166 return figure_loop_size(lo, lo->lo_offset, lo->lo_sizelimit);
53d66608
O
1167}
1168
bb214884 1169static int lo_ioctl(struct block_device *bdev, fmode_t mode,
1da177e4
LT
1170 unsigned int cmd, unsigned long arg)
1171{
bb214884 1172 struct loop_device *lo = bdev->bd_disk->private_data;
1da177e4
LT
1173 int err;
1174
f028f3b2 1175 mutex_lock_nested(&lo->lo_ctl_mutex, 1);
1da177e4
LT
1176 switch (cmd) {
1177 case LOOP_SET_FD:
bb214884 1178 err = loop_set_fd(lo, mode, bdev, arg);
1da177e4
LT
1179 break;
1180 case LOOP_CHANGE_FD:
bb214884 1181 err = loop_change_fd(lo, bdev, arg);
1da177e4
LT
1182 break;
1183 case LOOP_CLR_FD:
f028f3b2 1184 /* loop_clr_fd would have unlocked lo_ctl_mutex on success */
4c823cc3 1185 err = loop_clr_fd(lo);
f028f3b2
NK
1186 if (!err)
1187 goto out_unlocked;
1da177e4
LT
1188 break;
1189 case LOOP_SET_STATUS:
7035b5df
DM
1190 err = -EPERM;
1191 if ((mode & FMODE_WRITE) || capable(CAP_SYS_ADMIN))
1192 err = loop_set_status_old(lo,
1193 (struct loop_info __user *)arg);
1da177e4
LT
1194 break;
1195 case LOOP_GET_STATUS:
1196 err = loop_get_status_old(lo, (struct loop_info __user *) arg);
1197 break;
1198 case LOOP_SET_STATUS64:
7035b5df
DM
1199 err = -EPERM;
1200 if ((mode & FMODE_WRITE) || capable(CAP_SYS_ADMIN))
1201 err = loop_set_status64(lo,
1202 (struct loop_info64 __user *) arg);
1da177e4
LT
1203 break;
1204 case LOOP_GET_STATUS64:
1205 err = loop_get_status64(lo, (struct loop_info64 __user *) arg);
1206 break;
53d66608
O
1207 case LOOP_SET_CAPACITY:
1208 err = -EPERM;
1209 if ((mode & FMODE_WRITE) || capable(CAP_SYS_ADMIN))
1210 err = loop_set_capacity(lo, bdev);
1211 break;
1da177e4
LT
1212 default:
1213 err = lo->ioctl ? lo->ioctl(lo, cmd, arg) : -EINVAL;
1214 }
f85221dd 1215 mutex_unlock(&lo->lo_ctl_mutex);
f028f3b2
NK
1216
1217out_unlocked:
1da177e4
LT
1218 return err;
1219}
1220
863d5b82
DH
1221#ifdef CONFIG_COMPAT
1222struct compat_loop_info {
1223 compat_int_t lo_number; /* ioctl r/o */
1224 compat_dev_t lo_device; /* ioctl r/o */
1225 compat_ulong_t lo_inode; /* ioctl r/o */
1226 compat_dev_t lo_rdevice; /* ioctl r/o */
1227 compat_int_t lo_offset;
1228 compat_int_t lo_encrypt_type;
1229 compat_int_t lo_encrypt_key_size; /* ioctl w/o */
1230 compat_int_t lo_flags; /* ioctl r/o */
1231 char lo_name[LO_NAME_SIZE];
1232 unsigned char lo_encrypt_key[LO_KEY_SIZE]; /* ioctl w/o */
1233 compat_ulong_t lo_init[2];
1234 char reserved[4];
1235};
1236
1237/*
1238 * Transfer 32-bit compatibility structure in userspace to 64-bit loop info
1239 * - noinlined to reduce stack space usage in main part of driver
1240 */
1241static noinline int
ba674cfc 1242loop_info64_from_compat(const struct compat_loop_info __user *arg,
863d5b82
DH
1243 struct loop_info64 *info64)
1244{
1245 struct compat_loop_info info;
1246
1247 if (copy_from_user(&info, arg, sizeof(info)))
1248 return -EFAULT;
1249
1250 memset(info64, 0, sizeof(*info64));
1251 info64->lo_number = info.lo_number;
1252 info64->lo_device = info.lo_device;
1253 info64->lo_inode = info.lo_inode;
1254 info64->lo_rdevice = info.lo_rdevice;
1255 info64->lo_offset = info.lo_offset;
1256 info64->lo_sizelimit = 0;
1257 info64->lo_encrypt_type = info.lo_encrypt_type;
1258 info64->lo_encrypt_key_size = info.lo_encrypt_key_size;
1259 info64->lo_flags = info.lo_flags;
1260 info64->lo_init[0] = info.lo_init[0];
1261 info64->lo_init[1] = info.lo_init[1];
1262 if (info.lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1263 memcpy(info64->lo_crypt_name, info.lo_name, LO_NAME_SIZE);
1264 else
1265 memcpy(info64->lo_file_name, info.lo_name, LO_NAME_SIZE);
1266 memcpy(info64->lo_encrypt_key, info.lo_encrypt_key, LO_KEY_SIZE);
1267 return 0;
1268}
1269
1270/*
1271 * Transfer 64-bit loop info to 32-bit compatibility structure in userspace
1272 * - noinlined to reduce stack space usage in main part of driver
1273 */
1274static noinline int
1275loop_info64_to_compat(const struct loop_info64 *info64,
1276 struct compat_loop_info __user *arg)
1277{
1278 struct compat_loop_info info;
1279
1280 memset(&info, 0, sizeof(info));
1281 info.lo_number = info64->lo_number;
1282 info.lo_device = info64->lo_device;
1283 info.lo_inode = info64->lo_inode;
1284 info.lo_rdevice = info64->lo_rdevice;
1285 info.lo_offset = info64->lo_offset;
1286 info.lo_encrypt_type = info64->lo_encrypt_type;
1287 info.lo_encrypt_key_size = info64->lo_encrypt_key_size;
1288 info.lo_flags = info64->lo_flags;
1289 info.lo_init[0] = info64->lo_init[0];
1290 info.lo_init[1] = info64->lo_init[1];
1291 if (info.lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1292 memcpy(info.lo_name, info64->lo_crypt_name, LO_NAME_SIZE);
1293 else
1294 memcpy(info.lo_name, info64->lo_file_name, LO_NAME_SIZE);
1295 memcpy(info.lo_encrypt_key, info64->lo_encrypt_key, LO_KEY_SIZE);
1296
1297 /* error in case values were truncated */
1298 if (info.lo_device != info64->lo_device ||
1299 info.lo_rdevice != info64->lo_rdevice ||
1300 info.lo_inode != info64->lo_inode ||
1301 info.lo_offset != info64->lo_offset ||
1302 info.lo_init[0] != info64->lo_init[0] ||
1303 info.lo_init[1] != info64->lo_init[1])
1304 return -EOVERFLOW;
1305
1306 if (copy_to_user(arg, &info, sizeof(info)))
1307 return -EFAULT;
1308 return 0;
1309}
1310
1311static int
1312loop_set_status_compat(struct loop_device *lo,
1313 const struct compat_loop_info __user *arg)
1314{
1315 struct loop_info64 info64;
1316 int ret;
1317
1318 ret = loop_info64_from_compat(arg, &info64);
1319 if (ret < 0)
1320 return ret;
1321 return loop_set_status(lo, &info64);
1322}
1323
1324static int
1325loop_get_status_compat(struct loop_device *lo,
1326 struct compat_loop_info __user *arg)
1327{
1328 struct loop_info64 info64;
1329 int err = 0;
1330
1331 if (!arg)
1332 err = -EINVAL;
1333 if (!err)
1334 err = loop_get_status(lo, &info64);
1335 if (!err)
1336 err = loop_info64_to_compat(&info64, arg);
1337 return err;
1338}
1339
bb214884
AV
1340static int lo_compat_ioctl(struct block_device *bdev, fmode_t mode,
1341 unsigned int cmd, unsigned long arg)
863d5b82 1342{
bb214884 1343 struct loop_device *lo = bdev->bd_disk->private_data;
863d5b82
DH
1344 int err;
1345
863d5b82
DH
1346 switch(cmd) {
1347 case LOOP_SET_STATUS:
1348 mutex_lock(&lo->lo_ctl_mutex);
1349 err = loop_set_status_compat(
1350 lo, (const struct compat_loop_info __user *) arg);
1351 mutex_unlock(&lo->lo_ctl_mutex);
1352 break;
1353 case LOOP_GET_STATUS:
1354 mutex_lock(&lo->lo_ctl_mutex);
1355 err = loop_get_status_compat(
1356 lo, (struct compat_loop_info __user *) arg);
1357 mutex_unlock(&lo->lo_ctl_mutex);
1358 break;
53d66608 1359 case LOOP_SET_CAPACITY:
863d5b82
DH
1360 case LOOP_CLR_FD:
1361 case LOOP_GET_STATUS64:
1362 case LOOP_SET_STATUS64:
1363 arg = (unsigned long) compat_ptr(arg);
1364 case LOOP_SET_FD:
1365 case LOOP_CHANGE_FD:
bb214884 1366 err = lo_ioctl(bdev, mode, cmd, arg);
863d5b82
DH
1367 break;
1368 default:
1369 err = -ENOIOCTLCMD;
1370 break;
1371 }
863d5b82
DH
1372 return err;
1373}
1374#endif
1375
bb214884 1376static int lo_open(struct block_device *bdev, fmode_t mode)
1da177e4 1377{
770fe30a
KS
1378 struct loop_device *lo;
1379 int err = 0;
1380
1381 mutex_lock(&loop_index_mutex);
1382 lo = bdev->bd_disk->private_data;
1383 if (!lo) {
1384 err = -ENXIO;
1385 goto out;
1386 }
1da177e4 1387
f85221dd 1388 mutex_lock(&lo->lo_ctl_mutex);
1da177e4 1389 lo->lo_refcnt++;
f85221dd 1390 mutex_unlock(&lo->lo_ctl_mutex);
770fe30a
KS
1391out:
1392 mutex_unlock(&loop_index_mutex);
1393 return err;
1da177e4
LT
1394}
1395
db2a144b 1396static void lo_release(struct gendisk *disk, fmode_t mode)
1da177e4 1397{
bb214884 1398 struct loop_device *lo = disk->private_data;
ffcd7dca 1399 int err;
1da177e4 1400
f85221dd 1401 mutex_lock(&lo->lo_ctl_mutex);
96c58655 1402
14f27939
MB
1403 if (--lo->lo_refcnt)
1404 goto out;
1405
1406 if (lo->lo_flags & LO_FLAGS_AUTOCLEAR) {
1407 /*
1408 * In autoclear mode, stop the loop thread
1409 * and remove configuration after last close.
1410 */
4c823cc3 1411 err = loop_clr_fd(lo);
ffcd7dca 1412 if (!err)
db2a144b 1413 return;
14f27939
MB
1414 } else {
1415 /*
1416 * Otherwise keep thread (if running) and config,
1417 * but flush possible ongoing bios in thread.
1418 */
1419 loop_flush(lo);
1420 }
96c58655 1421
14f27939 1422out:
f85221dd 1423 mutex_unlock(&lo->lo_ctl_mutex);
1da177e4
LT
1424}
1425
83d5cde4 1426static const struct block_device_operations lo_fops = {
1da177e4 1427 .owner = THIS_MODULE,
bb214884
AV
1428 .open = lo_open,
1429 .release = lo_release,
1430 .ioctl = lo_ioctl,
863d5b82 1431#ifdef CONFIG_COMPAT
bb214884 1432 .compat_ioctl = lo_compat_ioctl,
863d5b82 1433#endif
1da177e4
LT
1434};
1435
1436/*
1437 * And now the modules code and kernel interface.
1438 */
73285082 1439static int max_loop;
ac04fee0 1440module_param(max_loop, int, S_IRUGO);
a47653fc 1441MODULE_PARM_DESC(max_loop, "Maximum number of loop devices");
ac04fee0 1442module_param(max_part, int, S_IRUGO);
476a4813 1443MODULE_PARM_DESC(max_part, "Maximum number of partitions per loop device");
1da177e4
LT
1444MODULE_LICENSE("GPL");
1445MODULE_ALIAS_BLOCKDEV_MAJOR(LOOP_MAJOR);
1446
1447int loop_register_transfer(struct loop_func_table *funcs)
1448{
1449 unsigned int n = funcs->number;
1450
1451 if (n >= MAX_LO_CRYPT || xfer_funcs[n])
1452 return -EINVAL;
1453 xfer_funcs[n] = funcs;
1454 return 0;
1455}
1456
34dd82af
KS
1457static int unregister_transfer_cb(int id, void *ptr, void *data)
1458{
1459 struct loop_device *lo = ptr;
1460 struct loop_func_table *xfer = data;
1461
1462 mutex_lock(&lo->lo_ctl_mutex);
1463 if (lo->lo_encryption == xfer)
1464 loop_release_xfer(lo);
1465 mutex_unlock(&lo->lo_ctl_mutex);
1466 return 0;
1467}
1468
1da177e4
LT
1469int loop_unregister_transfer(int number)
1470{
1471 unsigned int n = number;
1da177e4
LT
1472 struct loop_func_table *xfer;
1473
1474 if (n == 0 || n >= MAX_LO_CRYPT || (xfer = xfer_funcs[n]) == NULL)
1475 return -EINVAL;
1476
1477 xfer_funcs[n] = NULL;
34dd82af 1478 idr_for_each(&loop_index_idr, &unregister_transfer_cb, xfer);
1da177e4
LT
1479 return 0;
1480}
1481
1482EXPORT_SYMBOL(loop_register_transfer);
1483EXPORT_SYMBOL(loop_unregister_transfer);
1484
b5dd2f60
ML
1485static int loop_queue_rq(struct blk_mq_hw_ctx *hctx,
1486 const struct blk_mq_queue_data *bd)
1487{
1488 struct loop_cmd *cmd = blk_mq_rq_to_pdu(bd->rq);
1489
1490 blk_mq_start_request(bd->rq);
1491
1492 if (cmd->rq->cmd_flags & REQ_WRITE) {
1493 struct loop_device *lo = cmd->rq->q->queuedata;
1494 bool need_sched = true;
1495
1496 spin_lock_irq(&lo->lo_lock);
1497 if (lo->write_started)
1498 need_sched = false;
1499 else
1500 lo->write_started = true;
1501 list_add_tail(&cmd->list, &lo->write_cmd_head);
1502 spin_unlock_irq(&lo->lo_lock);
1503
1504 if (need_sched)
1505 queue_work(loop_wq, &lo->write_work);
1506 } else {
1507 queue_work(loop_wq, &cmd->read_work);
1508 }
1509
1510 return BLK_MQ_RQ_QUEUE_OK;
1511}
1512
1513static void loop_handle_cmd(struct loop_cmd *cmd)
1514{
1515 const bool write = cmd->rq->cmd_flags & REQ_WRITE;
1516 struct loop_device *lo = cmd->rq->q->queuedata;
1517 int ret = -EIO;
b5dd2f60
ML
1518
1519 if (lo->lo_state != Lo_bound)
1520 goto failed;
1521
1522 if (write && (lo->lo_flags & LO_FLAGS_READ_ONLY))
1523 goto failed;
1524
30112013 1525 ret = do_req_filebacked(lo, cmd->rq);
b5dd2f60
ML
1526
1527 failed:
1528 if (ret)
1529 cmd->rq->errors = -EIO;
1530 blk_mq_complete_request(cmd->rq);
1531}
1532
1533static void loop_queue_write_work(struct work_struct *work)
1534{
1535 struct loop_device *lo =
1536 container_of(work, struct loop_device, write_work);
1537 LIST_HEAD(cmd_list);
1538
1539 spin_lock_irq(&lo->lo_lock);
1540 repeat:
1541 list_splice_init(&lo->write_cmd_head, &cmd_list);
1542 spin_unlock_irq(&lo->lo_lock);
1543
1544 while (!list_empty(&cmd_list)) {
1545 struct loop_cmd *cmd = list_first_entry(&cmd_list,
1546 struct loop_cmd, list);
1547 list_del_init(&cmd->list);
1548 loop_handle_cmd(cmd);
1549 }
1550
1551 spin_lock_irq(&lo->lo_lock);
1552 if (!list_empty(&lo->write_cmd_head))
1553 goto repeat;
1554 lo->write_started = false;
1555 spin_unlock_irq(&lo->lo_lock);
1556}
1557
1558static void loop_queue_read_work(struct work_struct *work)
1559{
1560 struct loop_cmd *cmd =
1561 container_of(work, struct loop_cmd, read_work);
1562
1563 loop_handle_cmd(cmd);
1564}
1565
1566static int loop_init_request(void *data, struct request *rq,
1567 unsigned int hctx_idx, unsigned int request_idx,
1568 unsigned int numa_node)
1569{
1570 struct loop_cmd *cmd = blk_mq_rq_to_pdu(rq);
1571
1572 cmd->rq = rq;
1573 INIT_WORK(&cmd->read_work, loop_queue_read_work);
1574
1575 return 0;
1576}
1577
1578static struct blk_mq_ops loop_mq_ops = {
1579 .queue_rq = loop_queue_rq,
1580 .map_queue = blk_mq_map_queue,
1581 .init_request = loop_init_request,
1582};
1583
34dd82af 1584static int loop_add(struct loop_device **l, int i)
73285082
KC
1585{
1586 struct loop_device *lo;
1587 struct gendisk *disk;
34dd82af 1588 int err;
73285082 1589
68d740d7 1590 err = -ENOMEM;
73285082 1591 lo = kzalloc(sizeof(*lo), GFP_KERNEL);
68d740d7 1592 if (!lo)
73285082 1593 goto out;
34dd82af 1594
ef7e7c82
MP
1595 lo->lo_state = Lo_unbound;
1596
c718aa65 1597 /* allocate id, if @id >= 0, we're requesting that specific id */
34dd82af 1598 if (i >= 0) {
c718aa65
TH
1599 err = idr_alloc(&loop_index_idr, lo, i, i + 1, GFP_KERNEL);
1600 if (err == -ENOSPC)
34dd82af 1601 err = -EEXIST;
34dd82af 1602 } else {
c718aa65 1603 err = idr_alloc(&loop_index_idr, lo, 0, 0, GFP_KERNEL);
34dd82af
KS
1604 }
1605 if (err < 0)
1606 goto out_free_dev;
c718aa65 1607 i = err;
73285082 1608
183cfb57 1609 err = -ENOMEM;
b5dd2f60
ML
1610 lo->tag_set.ops = &loop_mq_ops;
1611 lo->tag_set.nr_hw_queues = 1;
1612 lo->tag_set.queue_depth = 128;
1613 lo->tag_set.numa_node = NUMA_NO_NODE;
1614 lo->tag_set.cmd_size = sizeof(struct loop_cmd);
1615 lo->tag_set.flags = BLK_MQ_F_SHOULD_MERGE | BLK_MQ_F_SG_MERGE;
1616 lo->tag_set.driver_data = lo;
1617
1618 err = blk_mq_alloc_tag_set(&lo->tag_set);
1619 if (err)
3ec981e3 1620 goto out_free_idr;
73285082 1621
b5dd2f60
ML
1622 lo->lo_queue = blk_mq_init_queue(&lo->tag_set);
1623 if (IS_ERR_OR_NULL(lo->lo_queue)) {
1624 err = PTR_ERR(lo->lo_queue);
1625 goto out_cleanup_tags;
1626 }
ef7e7c82
MP
1627 lo->lo_queue->queuedata = lo;
1628
b5dd2f60
ML
1629 INIT_LIST_HEAD(&lo->write_cmd_head);
1630 INIT_WORK(&lo->write_work, loop_queue_write_work);
1631
476a4813 1632 disk = lo->lo_disk = alloc_disk(1 << part_shift);
73285082
KC
1633 if (!disk)
1634 goto out_free_queue;
1635
e03c8dd1
KS
1636 /*
1637 * Disable partition scanning by default. The in-kernel partition
1638 * scanning can be requested individually per-device during its
1639 * setup. Userspace can always add and remove partitions from all
1640 * devices. The needed partition minors are allocated from the
1641 * extended minor space, the main loop device numbers will continue
1642 * to match the loop minors, regardless of the number of partitions
1643 * used.
1644 *
1645 * If max_part is given, partition scanning is globally enabled for
1646 * all loop devices. The minors for the main loop devices will be
1647 * multiples of max_part.
1648 *
1649 * Note: Global-for-all-devices, set-only-at-init, read-only module
1650 * parameteters like 'max_loop' and 'max_part' make things needlessly
1651 * complicated, are too static, inflexible and may surprise
1652 * userspace tools. Parameters like this in general should be avoided.
1653 */
1654 if (!part_shift)
1655 disk->flags |= GENHD_FL_NO_PART_SCAN;
1656 disk->flags |= GENHD_FL_EXT_DEVT;
73285082
KC
1657 mutex_init(&lo->lo_ctl_mutex);
1658 lo->lo_number = i;
73285082
KC
1659 spin_lock_init(&lo->lo_lock);
1660 disk->major = LOOP_MAJOR;
476a4813 1661 disk->first_minor = i << part_shift;
73285082
KC
1662 disk->fops = &lo_fops;
1663 disk->private_data = lo;
1664 disk->queue = lo->lo_queue;
1665 sprintf(disk->disk_name, "loop%d", i);
34dd82af
KS
1666 add_disk(disk);
1667 *l = lo;
1668 return lo->lo_number;
73285082
KC
1669
1670out_free_queue:
1671 blk_cleanup_queue(lo->lo_queue);
b5dd2f60
ML
1672out_cleanup_tags:
1673 blk_mq_free_tag_set(&lo->tag_set);
3ec981e3
MP
1674out_free_idr:
1675 idr_remove(&loop_index_idr, i);
73285082
KC
1676out_free_dev:
1677 kfree(lo);
1678out:
34dd82af 1679 return err;
73285082
KC
1680}
1681
34dd82af 1682static void loop_remove(struct loop_device *lo)
1da177e4 1683{
34dd82af 1684 del_gendisk(lo->lo_disk);
73285082 1685 blk_cleanup_queue(lo->lo_queue);
b5dd2f60 1686 blk_mq_free_tag_set(&lo->tag_set);
73285082 1687 put_disk(lo->lo_disk);
73285082
KC
1688 kfree(lo);
1689}
1da177e4 1690
770fe30a
KS
1691static int find_free_cb(int id, void *ptr, void *data)
1692{
1693 struct loop_device *lo = ptr;
1694 struct loop_device **l = data;
1695
1696 if (lo->lo_state == Lo_unbound) {
1697 *l = lo;
1698 return 1;
1699 }
1700 return 0;
1701}
1702
34dd82af 1703static int loop_lookup(struct loop_device **l, int i)
a47653fc
KC
1704{
1705 struct loop_device *lo;
34dd82af 1706 int ret = -ENODEV;
a47653fc 1707
770fe30a
KS
1708 if (i < 0) {
1709 int err;
1710
1711 err = idr_for_each(&loop_index_idr, &find_free_cb, &lo);
1712 if (err == 1) {
1713 *l = lo;
1714 ret = lo->lo_number;
1715 }
1716 goto out;
a47653fc
KC
1717 }
1718
770fe30a 1719 /* lookup and return a specific i */
34dd82af 1720 lo = idr_find(&loop_index_idr, i);
a47653fc 1721 if (lo) {
34dd82af
KS
1722 *l = lo;
1723 ret = lo->lo_number;
a47653fc 1724 }
770fe30a 1725out:
34dd82af 1726 return ret;
a47653fc
KC
1727}
1728
73285082
KC
1729static struct kobject *loop_probe(dev_t dev, int *part, void *data)
1730{
705962cc 1731 struct loop_device *lo;
07002e99 1732 struct kobject *kobj;
34dd82af 1733 int err;
73285082 1734
34dd82af
KS
1735 mutex_lock(&loop_index_mutex);
1736 err = loop_lookup(&lo, MINOR(dev) >> part_shift);
1737 if (err < 0)
1738 err = loop_add(&lo, MINOR(dev) >> part_shift);
1739 if (err < 0)
a207f593 1740 kobj = NULL;
34dd82af
KS
1741 else
1742 kobj = get_disk(lo->lo_disk);
1743 mutex_unlock(&loop_index_mutex);
73285082
KC
1744
1745 *part = 0;
07002e99 1746 return kobj;
73285082
KC
1747}
1748
770fe30a
KS
1749static long loop_control_ioctl(struct file *file, unsigned int cmd,
1750 unsigned long parm)
1751{
1752 struct loop_device *lo;
1753 int ret = -ENOSYS;
1754
1755 mutex_lock(&loop_index_mutex);
1756 switch (cmd) {
1757 case LOOP_CTL_ADD:
1758 ret = loop_lookup(&lo, parm);
1759 if (ret >= 0) {
1760 ret = -EEXIST;
1761 break;
1762 }
1763 ret = loop_add(&lo, parm);
1764 break;
1765 case LOOP_CTL_REMOVE:
1766 ret = loop_lookup(&lo, parm);
1767 if (ret < 0)
1768 break;
1769 mutex_lock(&lo->lo_ctl_mutex);
1770 if (lo->lo_state != Lo_unbound) {
1771 ret = -EBUSY;
1772 mutex_unlock(&lo->lo_ctl_mutex);
1773 break;
1774 }
1775 if (lo->lo_refcnt > 0) {
1776 ret = -EBUSY;
1777 mutex_unlock(&lo->lo_ctl_mutex);
1778 break;
1779 }
1780 lo->lo_disk->private_data = NULL;
1781 mutex_unlock(&lo->lo_ctl_mutex);
1782 idr_remove(&loop_index_idr, lo->lo_number);
1783 loop_remove(lo);
1784 break;
1785 case LOOP_CTL_GET_FREE:
1786 ret = loop_lookup(&lo, -1);
1787 if (ret >= 0)
1788 break;
1789 ret = loop_add(&lo, -1);
1790 }
1791 mutex_unlock(&loop_index_mutex);
1792
1793 return ret;
1794}
1795
1796static const struct file_operations loop_ctl_fops = {
1797 .open = nonseekable_open,
1798 .unlocked_ioctl = loop_control_ioctl,
1799 .compat_ioctl = loop_control_ioctl,
1800 .owner = THIS_MODULE,
1801 .llseek = noop_llseek,
1802};
1803
1804static struct miscdevice loop_misc = {
1805 .minor = LOOP_CTRL_MINOR,
1806 .name = "loop-control",
1807 .fops = &loop_ctl_fops,
1808};
1809
1810MODULE_ALIAS_MISCDEV(LOOP_CTRL_MINOR);
1811MODULE_ALIAS("devname:loop-control");
1812
73285082
KC
1813static int __init loop_init(void)
1814{
a47653fc
KC
1815 int i, nr;
1816 unsigned long range;
34dd82af 1817 struct loop_device *lo;
770fe30a 1818 int err;
a47653fc 1819
770fe30a
KS
1820 err = misc_register(&loop_misc);
1821 if (err < 0)
1822 return err;
476a4813
LV
1823
1824 part_shift = 0;
ac04fee0 1825 if (max_part > 0) {
476a4813
LV
1826 part_shift = fls(max_part);
1827
ac04fee0
NK
1828 /*
1829 * Adjust max_part according to part_shift as it is exported
1830 * to user space so that user can decide correct minor number
1831 * if [s]he want to create more devices.
1832 *
1833 * Note that -1 is required because partition 0 is reserved
1834 * for the whole disk.
1835 */
1836 max_part = (1UL << part_shift) - 1;
1837 }
1838
b1a66504
GC
1839 if ((1UL << part_shift) > DISK_MAX_PARTS) {
1840 err = -EINVAL;
1841 goto misc_out;
1842 }
78f4bb36 1843
b1a66504
GC
1844 if (max_loop > 1UL << (MINORBITS - part_shift)) {
1845 err = -EINVAL;
1846 goto misc_out;
1847 }
1da177e4 1848
d134b00b
KS
1849 /*
1850 * If max_loop is specified, create that many devices upfront.
1851 * This also becomes a hard limit. If max_loop is not specified,
1852 * create CONFIG_BLK_DEV_LOOP_MIN_COUNT loop devices at module
1853 * init time. Loop devices can be requested on-demand with the
1854 * /dev/loop-control interface, or be instantiated by accessing
1855 * a 'dead' device node.
1856 */
73285082 1857 if (max_loop) {
a47653fc 1858 nr = max_loop;
a1c15c59 1859 range = max_loop << part_shift;
a47653fc 1860 } else {
d134b00b 1861 nr = CONFIG_BLK_DEV_LOOP_MIN_COUNT;
a1c15c59 1862 range = 1UL << MINORBITS;
a47653fc
KC
1863 }
1864
b1a66504
GC
1865 if (register_blkdev(LOOP_MAJOR, "loop")) {
1866 err = -EIO;
1867 goto misc_out;
1868 }
1da177e4 1869
b5dd2f60
ML
1870 loop_wq = alloc_workqueue("kloopd",
1871 WQ_MEM_RECLAIM | WQ_HIGHPRI | WQ_UNBOUND, 0);
1872 if (!loop_wq) {
1873 err = -ENOMEM;
1874 goto misc_out;
1875 }
1876
a47653fc
KC
1877 blk_register_region(MKDEV(LOOP_MAJOR, 0), range,
1878 THIS_MODULE, loop_probe, NULL, NULL);
1879
d134b00b 1880 /* pre-create number of devices given by config or max_loop */
34dd82af
KS
1881 mutex_lock(&loop_index_mutex);
1882 for (i = 0; i < nr; i++)
1883 loop_add(&lo, i);
1884 mutex_unlock(&loop_index_mutex);
1885
73285082 1886 printk(KERN_INFO "loop: module loaded\n");
1da177e4 1887 return 0;
b1a66504
GC
1888
1889misc_out:
1890 misc_deregister(&loop_misc);
1891 return err;
34dd82af 1892}
a47653fc 1893
34dd82af
KS
1894static int loop_exit_cb(int id, void *ptr, void *data)
1895{
1896 struct loop_device *lo = ptr;
a47653fc 1897
34dd82af
KS
1898 loop_remove(lo);
1899 return 0;
1da177e4
LT
1900}
1901
73285082 1902static void __exit loop_exit(void)
1da177e4 1903{
a47653fc 1904 unsigned long range;
1da177e4 1905
a1c15c59 1906 range = max_loop ? max_loop << part_shift : 1UL << MINORBITS;
a47653fc 1907
34dd82af 1908 idr_for_each(&loop_index_idr, &loop_exit_cb, NULL);
34dd82af 1909 idr_destroy(&loop_index_idr);
73285082 1910
a47653fc 1911 blk_unregister_region(MKDEV(LOOP_MAJOR, 0), range);
00d59405 1912 unregister_blkdev(LOOP_MAJOR, "loop");
770fe30a 1913
b5dd2f60
ML
1914 destroy_workqueue(loop_wq);
1915
770fe30a 1916 misc_deregister(&loop_misc);
1da177e4
LT
1917}
1918
1919module_init(loop_init);
1920module_exit(loop_exit);
1921
1922#ifndef MODULE
1923static int __init max_loop_setup(char *str)
1924{
1925 max_loop = simple_strtol(str, NULL, 0);
1926 return 1;
1927}
1928
1929__setup("max_loop=", max_loop_setup);
1930#endif