]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - drivers/block/loop.c
block: remove per-queue plugging
[mirror_ubuntu-artful-kernel.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>
66#include <linux/loop.h>
863d5b82 67#include <linux/compat.h>
1da177e4 68#include <linux/suspend.h>
83144186 69#include <linux/freezer.h>
2a48fc0a 70#include <linux/mutex.h>
1da177e4
LT
71#include <linux/writeback.h>
72#include <linux/buffer_head.h> /* for invalidate_bdev() */
73#include <linux/completion.h>
74#include <linux/highmem.h>
6c997918 75#include <linux/kthread.h>
d6b29d7c 76#include <linux/splice.h>
ee862730 77#include <linux/sysfs.h>
1da177e4
LT
78
79#include <asm/uaccess.h>
80
2a48fc0a 81static DEFINE_MUTEX(loop_mutex);
73285082
KC
82static LIST_HEAD(loop_devices);
83static DEFINE_MUTEX(loop_devices_mutex);
1da177e4 84
476a4813
LV
85static int max_part;
86static int part_shift;
87
1da177e4
LT
88/*
89 * Transfer functions
90 */
91static int transfer_none(struct loop_device *lo, int cmd,
92 struct page *raw_page, unsigned raw_off,
93 struct page *loop_page, unsigned loop_off,
94 int size, sector_t real_block)
95{
96 char *raw_buf = kmap_atomic(raw_page, KM_USER0) + raw_off;
97 char *loop_buf = kmap_atomic(loop_page, KM_USER1) + loop_off;
98
99 if (cmd == READ)
100 memcpy(loop_buf, raw_buf, size);
101 else
102 memcpy(raw_buf, loop_buf, size);
103
1da177e4 104 kunmap_atomic(loop_buf, KM_USER1);
61ecdb80 105 kunmap_atomic(raw_buf, KM_USER0);
1da177e4
LT
106 cond_resched();
107 return 0;
108}
109
110static int transfer_xor(struct loop_device *lo, int cmd,
111 struct page *raw_page, unsigned raw_off,
112 struct page *loop_page, unsigned loop_off,
113 int size, sector_t real_block)
114{
115 char *raw_buf = kmap_atomic(raw_page, KM_USER0) + raw_off;
116 char *loop_buf = kmap_atomic(loop_page, KM_USER1) + loop_off;
117 char *in, *out, *key;
118 int i, keysize;
119
120 if (cmd == READ) {
121 in = raw_buf;
122 out = loop_buf;
123 } else {
124 in = loop_buf;
125 out = raw_buf;
126 }
127
128 key = lo->lo_encrypt_key;
129 keysize = lo->lo_encrypt_key_size;
130 for (i = 0; i < size; i++)
131 *out++ = *in++ ^ key[(i & 511) % keysize];
132
1da177e4 133 kunmap_atomic(loop_buf, KM_USER1);
61ecdb80 134 kunmap_atomic(raw_buf, KM_USER0);
1da177e4
LT
135 cond_resched();
136 return 0;
137}
138
139static int xor_init(struct loop_device *lo, const struct loop_info64 *info)
140{
141 if (unlikely(info->lo_encrypt_key_size <= 0))
142 return -EINVAL;
143 return 0;
144}
145
146static struct loop_func_table none_funcs = {
147 .number = LO_CRYPT_NONE,
148 .transfer = transfer_none,
149};
150
151static struct loop_func_table xor_funcs = {
152 .number = LO_CRYPT_XOR,
153 .transfer = transfer_xor,
154 .init = xor_init
155};
156
157/* xfer_funcs[0] is special - its release function is never called */
158static struct loop_func_table *xfer_funcs[MAX_LO_CRYPT] = {
159 &none_funcs,
160 &xor_funcs
161};
162
163static loff_t get_loop_size(struct loop_device *lo, struct file *file)
164{
165 loff_t size, offset, loopsize;
166
167 /* Compute loopsize in bytes */
168 size = i_size_read(file->f_mapping->host);
169 offset = lo->lo_offset;
170 loopsize = size - offset;
171 if (lo->lo_sizelimit > 0 && lo->lo_sizelimit < loopsize)
172 loopsize = lo->lo_sizelimit;
173
174 /*
175 * Unfortunately, if we want to do I/O on the device,
176 * the number of 512-byte sectors has to fit into a sector_t.
177 */
178 return loopsize >> 9;
179}
180
181static int
182figure_loop_size(struct loop_device *lo)
183{
184 loff_t size = get_loop_size(lo, lo->lo_backing_file);
185 sector_t x = (sector_t)size;
186
187 if (unlikely((loff_t)x != size))
188 return -EFBIG;
189
73285082 190 set_capacity(lo->lo_disk, x);
1da177e4
LT
191 return 0;
192}
193
194static inline int
195lo_do_transfer(struct loop_device *lo, int cmd,
196 struct page *rpage, unsigned roffs,
197 struct page *lpage, unsigned loffs,
198 int size, sector_t rblock)
199{
200 if (unlikely(!lo->transfer))
201 return 0;
202
203 return lo->transfer(lo, cmd, rpage, roffs, lpage, loffs, size, rblock);
204}
205
206/**
207 * do_lo_send_aops - helper for writing data to a loop device
208 *
209 * This is the fast version for backing filesystems which implement the address
afddba49 210 * space operations write_begin and write_end.
1da177e4
LT
211 */
212static int do_lo_send_aops(struct loop_device *lo, struct bio_vec *bvec,
511de73f 213 loff_t pos, struct page *unused)
1da177e4
LT
214{
215 struct file *file = lo->lo_backing_file; /* kudos to NFsckingS */
216 struct address_space *mapping = file->f_mapping;
1da177e4
LT
217 pgoff_t index;
218 unsigned offset, bv_offs;
994fc28c 219 int len, ret;
1da177e4 220
1b1dcc1b 221 mutex_lock(&mapping->host->i_mutex);
1da177e4
LT
222 index = pos >> PAGE_CACHE_SHIFT;
223 offset = pos & ((pgoff_t)PAGE_CACHE_SIZE - 1);
224 bv_offs = bvec->bv_offset;
225 len = bvec->bv_len;
226 while (len > 0) {
227 sector_t IV;
afddba49 228 unsigned size, copied;
1da177e4 229 int transfer_result;
afddba49
NP
230 struct page *page;
231 void *fsdata;
1da177e4
LT
232
233 IV = ((sector_t)index << (PAGE_CACHE_SHIFT - 9))+(offset >> 9);
234 size = PAGE_CACHE_SIZE - offset;
235 if (size > len)
236 size = len;
afddba49
NP
237
238 ret = pagecache_write_begin(file, mapping, pos, size, 0,
239 &page, &fsdata);
240 if (ret)
1da177e4 241 goto fail;
afddba49 242
02246c41
NK
243 file_update_time(file);
244
1da177e4
LT
245 transfer_result = lo_do_transfer(lo, WRITE, page, offset,
246 bvec->bv_page, bv_offs, size, IV);
afddba49 247 copied = size;
1da177e4 248 if (unlikely(transfer_result))
afddba49
NP
249 copied = 0;
250
251 ret = pagecache_write_end(file, mapping, pos, size, copied,
252 page, fsdata);
8268f5a7 253 if (ret < 0 || ret != copied)
afddba49 254 goto fail;
afddba49
NP
255
256 if (unlikely(transfer_result))
257 goto fail;
258
259 bv_offs += copied;
260 len -= copied;
1da177e4
LT
261 offset = 0;
262 index++;
afddba49 263 pos += copied;
1da177e4 264 }
994fc28c 265 ret = 0;
1da177e4 266out:
1b1dcc1b 267 mutex_unlock(&mapping->host->i_mutex);
1da177e4 268 return ret;
1da177e4
LT
269fail:
270 ret = -1;
271 goto out;
272}
273
274/**
275 * __do_lo_send_write - helper for writing data to a loop device
276 *
277 * This helper just factors out common code between do_lo_send_direct_write()
278 * and do_lo_send_write().
279 */
858119e1 280static int __do_lo_send_write(struct file *file,
98ae6ccd 281 u8 *buf, const int len, loff_t pos)
1da177e4
LT
282{
283 ssize_t bw;
284 mm_segment_t old_fs = get_fs();
285
286 set_fs(get_ds());
287 bw = file->f_op->write(file, buf, len, &pos);
288 set_fs(old_fs);
289 if (likely(bw == len))
290 return 0;
291 printk(KERN_ERR "loop: Write error at byte offset %llu, length %i.\n",
292 (unsigned long long)pos, len);
293 if (bw >= 0)
294 bw = -EIO;
295 return bw;
296}
297
298/**
299 * do_lo_send_direct_write - helper for writing data to a loop device
300 *
301 * This is the fast, non-transforming version for backing filesystems which do
afddba49 302 * not implement the address space operations write_begin and write_end.
1da177e4
LT
303 * It uses the write file operation which should be present on all writeable
304 * filesystems.
305 */
306static int do_lo_send_direct_write(struct loop_device *lo,
511de73f 307 struct bio_vec *bvec, loff_t pos, struct page *page)
1da177e4
LT
308{
309 ssize_t bw = __do_lo_send_write(lo->lo_backing_file,
98ae6ccd 310 kmap(bvec->bv_page) + bvec->bv_offset,
1da177e4
LT
311 bvec->bv_len, pos);
312 kunmap(bvec->bv_page);
313 cond_resched();
314 return bw;
315}
316
317/**
318 * do_lo_send_write - helper for writing data to a loop device
319 *
320 * This is the slow, transforming version for filesystems which do not
afddba49 321 * implement the address space operations write_begin and write_end. It
1da177e4
LT
322 * uses the write file operation which should be present on all writeable
323 * filesystems.
324 *
325 * Using fops->write is slower than using aops->{prepare,commit}_write in the
326 * transforming case because we need to double buffer the data as we cannot do
327 * the transformations in place as we do not have direct access to the
328 * destination pages of the backing file.
329 */
330static int do_lo_send_write(struct loop_device *lo, struct bio_vec *bvec,
511de73f 331 loff_t pos, struct page *page)
1da177e4
LT
332{
333 int ret = lo_do_transfer(lo, WRITE, page, 0, bvec->bv_page,
334 bvec->bv_offset, bvec->bv_len, pos >> 9);
335 if (likely(!ret))
336 return __do_lo_send_write(lo->lo_backing_file,
98ae6ccd 337 page_address(page), bvec->bv_len,
1da177e4
LT
338 pos);
339 printk(KERN_ERR "loop: Transfer error at byte offset %llu, "
340 "length %i.\n", (unsigned long long)pos, bvec->bv_len);
341 if (ret > 0)
342 ret = -EIO;
343 return ret;
344}
345
511de73f 346static int lo_send(struct loop_device *lo, struct bio *bio, loff_t pos)
1da177e4 347{
511de73f 348 int (*do_lo_send)(struct loop_device *, struct bio_vec *, loff_t,
1da177e4
LT
349 struct page *page);
350 struct bio_vec *bvec;
351 struct page *page = NULL;
352 int i, ret = 0;
353
354 do_lo_send = do_lo_send_aops;
355 if (!(lo->lo_flags & LO_FLAGS_USE_AOPS)) {
356 do_lo_send = do_lo_send_direct_write;
357 if (lo->transfer != transfer_none) {
358 page = alloc_page(GFP_NOIO | __GFP_HIGHMEM);
359 if (unlikely(!page))
360 goto fail;
361 kmap(page);
362 do_lo_send = do_lo_send_write;
363 }
364 }
365 bio_for_each_segment(bvec, bio, i) {
511de73f 366 ret = do_lo_send(lo, bvec, pos, page);
1da177e4
LT
367 if (ret < 0)
368 break;
369 pos += bvec->bv_len;
370 }
371 if (page) {
372 kunmap(page);
373 __free_page(page);
374 }
375out:
376 return ret;
377fail:
378 printk(KERN_ERR "loop: Failed to allocate temporary page for write.\n");
379 ret = -ENOMEM;
380 goto out;
381}
382
383struct lo_read_data {
384 struct loop_device *lo;
385 struct page *page;
386 unsigned offset;
387 int bsize;
388};
389
390static int
fd582140
JA
391lo_splice_actor(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
392 struct splice_desc *sd)
1da177e4 393{
fd582140 394 struct lo_read_data *p = sd->u.data;
1da177e4 395 struct loop_device *lo = p->lo;
fd582140 396 struct page *page = buf->page;
1da177e4 397 sector_t IV;
3603b8ea 398 int size;
1da177e4 399
fd582140
JA
400 IV = ((sector_t) page->index << (PAGE_CACHE_SHIFT - 9)) +
401 (buf->offset >> 9);
402 size = sd->len;
403 if (size > p->bsize)
404 size = p->bsize;
1da177e4 405
fd582140 406 if (lo_do_transfer(lo, READ, page, buf->offset, p->page, p->offset, size, IV)) {
1da177e4
LT
407 printk(KERN_ERR "loop: transfer error block %ld\n",
408 page->index);
fd582140 409 size = -EINVAL;
1da177e4
LT
410 }
411
412 flush_dcache_page(p->page);
413
fd582140
JA
414 if (size > 0)
415 p->offset += size;
416
1da177e4
LT
417 return size;
418}
419
fd582140
JA
420static int
421lo_direct_splice_actor(struct pipe_inode_info *pipe, struct splice_desc *sd)
422{
423 return __splice_from_pipe(pipe, sd, lo_splice_actor);
424}
425
1da177e4
LT
426static int
427do_lo_receive(struct loop_device *lo,
428 struct bio_vec *bvec, int bsize, loff_t pos)
429{
430 struct lo_read_data cookie;
fd582140 431 struct splice_desc sd;
1da177e4 432 struct file *file;
fd582140 433 long retval;
1da177e4
LT
434
435 cookie.lo = lo;
436 cookie.page = bvec->bv_page;
437 cookie.offset = bvec->bv_offset;
438 cookie.bsize = bsize;
fd582140
JA
439
440 sd.len = 0;
441 sd.total_len = bvec->bv_len;
442 sd.flags = 0;
443 sd.pos = pos;
444 sd.u.data = &cookie;
445
1da177e4 446 file = lo->lo_backing_file;
fd582140
JA
447 retval = splice_direct_to_actor(file, &sd, lo_direct_splice_actor);
448
449 if (retval < 0)
450 return retval;
451
452 return 0;
1da177e4
LT
453}
454
455static int
456lo_receive(struct loop_device *lo, struct bio *bio, int bsize, loff_t pos)
457{
458 struct bio_vec *bvec;
459 int i, ret = 0;
460
461 bio_for_each_segment(bvec, bio, i) {
462 ret = do_lo_receive(lo, bvec, bsize, pos);
463 if (ret < 0)
464 break;
465 pos += bvec->bv_len;
466 }
467 return ret;
468}
469
470static int do_bio_filebacked(struct loop_device *lo, struct bio *bio)
471{
472 loff_t pos;
473 int ret;
474
475 pos = ((loff_t) bio->bi_sector << 9) + lo->lo_offset;
68db1961
NK
476
477 if (bio_rw(bio) == WRITE) {
68db1961
NK
478 struct file *file = lo->lo_backing_file;
479
6259f284 480 if (bio->bi_rw & REQ_FLUSH) {
8018ab05 481 ret = vfs_fsync(file, 0);
6259f284 482 if (unlikely(ret && ret != -EINVAL)) {
68db1961
NK
483 ret = -EIO;
484 goto out;
485 }
486 }
487
511de73f 488 ret = lo_send(lo, bio, pos);
68db1961 489
6259f284 490 if ((bio->bi_rw & REQ_FUA) && !ret) {
8018ab05 491 ret = vfs_fsync(file, 0);
6259f284 492 if (unlikely(ret && ret != -EINVAL))
68db1961
NK
493 ret = -EIO;
494 }
495 } else
1da177e4 496 ret = lo_receive(lo, bio, lo->lo_blocksize, pos);
68db1961
NK
497
498out:
1da177e4
LT
499 return ret;
500}
501
502/*
503 * Add bio to back of pending list
504 */
505static void loop_add_bio(struct loop_device *lo, struct bio *bio)
506{
e686307f 507 bio_list_add(&lo->lo_bio_list, bio);
1da177e4
LT
508}
509
510/*
511 * Grab first pending buffer
512 */
513static struct bio *loop_get_bio(struct loop_device *lo)
514{
e686307f 515 return bio_list_pop(&lo->lo_bio_list);
1da177e4
LT
516}
517
165125e1 518static int loop_make_request(struct request_queue *q, struct bio *old_bio)
1da177e4
LT
519{
520 struct loop_device *lo = q->queuedata;
521 int rw = bio_rw(old_bio);
522
35a82d1a
NP
523 if (rw == READA)
524 rw = READ;
525
526 BUG_ON(!lo || (rw != READ && rw != WRITE));
1da177e4
LT
527
528 spin_lock_irq(&lo->lo_lock);
529 if (lo->lo_state != Lo_bound)
35a82d1a
NP
530 goto out;
531 if (unlikely(rw == WRITE && (lo->lo_flags & LO_FLAGS_READ_ONLY)))
532 goto out;
1da177e4 533 loop_add_bio(lo, old_bio);
6c997918 534 wake_up(&lo->lo_event);
35a82d1a 535 spin_unlock_irq(&lo->lo_lock);
1da177e4 536 return 0;
35a82d1a 537
1da177e4 538out:
35a82d1a 539 spin_unlock_irq(&lo->lo_lock);
6712ecf8 540 bio_io_error(old_bio);
1da177e4 541 return 0;
1da177e4
LT
542}
543
1da177e4
LT
544struct switch_request {
545 struct file *file;
546 struct completion wait;
547};
548
549static void do_loop_switch(struct loop_device *, struct switch_request *);
550
551static inline void loop_handle_bio(struct loop_device *lo, struct bio *bio)
552{
1da177e4
LT
553 if (unlikely(!bio->bi_bdev)) {
554 do_loop_switch(lo, bio->bi_private);
555 bio_put(bio);
556 } else {
35a82d1a 557 int ret = do_bio_filebacked(lo, bio);
6712ecf8 558 bio_endio(bio, ret);
1da177e4
LT
559 }
560}
561
562/*
563 * worker thread that handles reads/writes to file backed loop devices,
564 * to avoid blocking in our make_request_fn. it also does loop decrypting
565 * on reads for block backed loop, as that is too heavy to do from
566 * b_end_io context where irqs may be disabled.
6c997918
SH
567 *
568 * Loop explanation: loop_clr_fd() sets lo_state to Lo_rundown before
569 * calling kthread_stop(). Therefore once kthread_should_stop() is
570 * true, make_request will not place any more requests. Therefore
571 * once kthread_should_stop() is true and lo_bio is NULL, we are
572 * done with the loop.
1da177e4
LT
573 */
574static int loop_thread(void *data)
575{
576 struct loop_device *lo = data;
577 struct bio *bio;
578
1da177e4
LT
579 set_user_nice(current, -20);
580
e686307f 581 while (!kthread_should_stop() || !bio_list_empty(&lo->lo_bio_list)) {
09c0dc68 582
6c997918 583 wait_event_interruptible(lo->lo_event,
e686307f
AM
584 !bio_list_empty(&lo->lo_bio_list) ||
585 kthread_should_stop());
35a82d1a 586
e686307f 587 if (bio_list_empty(&lo->lo_bio_list))
35a82d1a 588 continue;
35a82d1a 589 spin_lock_irq(&lo->lo_lock);
1da177e4 590 bio = loop_get_bio(lo);
35a82d1a
NP
591 spin_unlock_irq(&lo->lo_lock);
592
593 BUG_ON(!bio);
1da177e4 594 loop_handle_bio(lo, bio);
1da177e4
LT
595 }
596
1da177e4
LT
597 return 0;
598}
599
600/*
601 * loop_switch performs the hard work of switching a backing store.
602 * First it needs to flush existing IO, it does this by sending a magic
603 * BIO down the pipe. The completion of this BIO does the actual switch.
604 */
605static int loop_switch(struct loop_device *lo, struct file *file)
606{
607 struct switch_request w;
a24eab1e 608 struct bio *bio = bio_alloc(GFP_KERNEL, 0);
1da177e4
LT
609 if (!bio)
610 return -ENOMEM;
611 init_completion(&w.wait);
612 w.file = file;
613 bio->bi_private = &w;
614 bio->bi_bdev = NULL;
615 loop_make_request(lo->lo_queue, bio);
616 wait_for_completion(&w.wait);
617 return 0;
618}
619
14f27939
MB
620/*
621 * Helper to flush the IOs in loop, but keeping loop thread running
622 */
623static int loop_flush(struct loop_device *lo)
624{
625 /* loop not yet configured, no running thread, nothing to flush */
626 if (!lo->lo_thread)
627 return 0;
628
629 return loop_switch(lo, NULL);
630}
631
1da177e4
LT
632/*
633 * Do the actual switch; called from the BIO completion routine
634 */
635static void do_loop_switch(struct loop_device *lo, struct switch_request *p)
636{
637 struct file *file = p->file;
638 struct file *old_file = lo->lo_backing_file;
14f27939
MB
639 struct address_space *mapping;
640
641 /* if no new file, only flush of queued bios requested */
642 if (!file)
643 goto out;
1da177e4 644
14f27939 645 mapping = file->f_mapping;
1da177e4
LT
646 mapping_set_gfp_mask(old_file->f_mapping, lo->old_gfp_mask);
647 lo->lo_backing_file = file;
ba52de12
TT
648 lo->lo_blocksize = S_ISBLK(mapping->host->i_mode) ?
649 mapping->host->i_bdev->bd_block_size : PAGE_SIZE;
1da177e4
LT
650 lo->old_gfp_mask = mapping_gfp_mask(mapping);
651 mapping_set_gfp_mask(mapping, lo->old_gfp_mask & ~(__GFP_IO|__GFP_FS));
14f27939 652out:
1da177e4
LT
653 complete(&p->wait);
654}
655
656
657/*
658 * loop_change_fd switched the backing store of a loopback device to
659 * a new file. This is useful for operating system installers to free up
660 * the original file and in High Availability environments to switch to
661 * an alternative location for the content in case of server meltdown.
662 * This can only work if the loop device is used read-only, and if the
663 * new backing store is the same size and type as the old backing store.
664 */
bb214884
AV
665static int loop_change_fd(struct loop_device *lo, struct block_device *bdev,
666 unsigned int arg)
1da177e4
LT
667{
668 struct file *file, *old_file;
669 struct inode *inode;
670 int error;
671
672 error = -ENXIO;
673 if (lo->lo_state != Lo_bound)
674 goto out;
675
676 /* the loop device has to be read-only */
677 error = -EINVAL;
678 if (!(lo->lo_flags & LO_FLAGS_READ_ONLY))
679 goto out;
680
681 error = -EBADF;
682 file = fget(arg);
683 if (!file)
684 goto out;
685
686 inode = file->f_mapping->host;
687 old_file = lo->lo_backing_file;
688
689 error = -EINVAL;
690
691 if (!S_ISREG(inode->i_mode) && !S_ISBLK(inode->i_mode))
692 goto out_putf;
693
1da177e4
LT
694 /* size of the new backing store needs to be the same */
695 if (get_loop_size(lo, file) != get_loop_size(lo, old_file))
696 goto out_putf;
697
698 /* and ... switch */
699 error = loop_switch(lo, file);
700 if (error)
701 goto out_putf;
702
703 fput(old_file);
476a4813
LV
704 if (max_part > 0)
705 ioctl_by_bdev(bdev, BLKRRPART, 0);
1da177e4
LT
706 return 0;
707
708 out_putf:
709 fput(file);
710 out:
711 return error;
712}
713
714static inline int is_loop_device(struct file *file)
715{
716 struct inode *i = file->f_mapping->host;
717
718 return i && S_ISBLK(i->i_mode) && MAJOR(i->i_rdev) == LOOP_MAJOR;
719}
720
ee862730
MB
721/* loop sysfs attributes */
722
723static ssize_t loop_attr_show(struct device *dev, char *page,
724 ssize_t (*callback)(struct loop_device *, char *))
725{
726 struct loop_device *l, *lo = NULL;
727
728 mutex_lock(&loop_devices_mutex);
729 list_for_each_entry(l, &loop_devices, lo_list)
730 if (disk_to_dev(l->lo_disk) == dev) {
731 lo = l;
732 break;
733 }
734 mutex_unlock(&loop_devices_mutex);
735
736 return lo ? callback(lo, page) : -EIO;
737}
738
739#define LOOP_ATTR_RO(_name) \
740static ssize_t loop_attr_##_name##_show(struct loop_device *, char *); \
741static ssize_t loop_attr_do_show_##_name(struct device *d, \
742 struct device_attribute *attr, char *b) \
743{ \
744 return loop_attr_show(d, b, loop_attr_##_name##_show); \
745} \
746static struct device_attribute loop_attr_##_name = \
747 __ATTR(_name, S_IRUGO, loop_attr_do_show_##_name, NULL);
748
749static ssize_t loop_attr_backing_file_show(struct loop_device *lo, char *buf)
750{
751 ssize_t ret;
752 char *p = NULL;
753
754 mutex_lock(&lo->lo_ctl_mutex);
755 if (lo->lo_backing_file)
756 p = d_path(&lo->lo_backing_file->f_path, buf, PAGE_SIZE - 1);
757 mutex_unlock(&lo->lo_ctl_mutex);
758
759 if (IS_ERR_OR_NULL(p))
760 ret = PTR_ERR(p);
761 else {
762 ret = strlen(p);
763 memmove(buf, p, ret);
764 buf[ret++] = '\n';
765 buf[ret] = 0;
766 }
767
768 return ret;
769}
770
771static ssize_t loop_attr_offset_show(struct loop_device *lo, char *buf)
772{
773 return sprintf(buf, "%llu\n", (unsigned long long)lo->lo_offset);
774}
775
776static ssize_t loop_attr_sizelimit_show(struct loop_device *lo, char *buf)
777{
778 return sprintf(buf, "%llu\n", (unsigned long long)lo->lo_sizelimit);
779}
780
781static ssize_t loop_attr_autoclear_show(struct loop_device *lo, char *buf)
782{
783 int autoclear = (lo->lo_flags & LO_FLAGS_AUTOCLEAR);
784
785 return sprintf(buf, "%s\n", autoclear ? "1" : "0");
786}
787
788LOOP_ATTR_RO(backing_file);
789LOOP_ATTR_RO(offset);
790LOOP_ATTR_RO(sizelimit);
791LOOP_ATTR_RO(autoclear);
792
793static struct attribute *loop_attrs[] = {
794 &loop_attr_backing_file.attr,
795 &loop_attr_offset.attr,
796 &loop_attr_sizelimit.attr,
797 &loop_attr_autoclear.attr,
798 NULL,
799};
800
801static struct attribute_group loop_attribute_group = {
802 .name = "loop",
803 .attrs= loop_attrs,
804};
805
806static int loop_sysfs_init(struct loop_device *lo)
807{
808 return sysfs_create_group(&disk_to_dev(lo->lo_disk)->kobj,
809 &loop_attribute_group);
810}
811
812static void loop_sysfs_exit(struct loop_device *lo)
813{
814 sysfs_remove_group(&disk_to_dev(lo->lo_disk)->kobj,
815 &loop_attribute_group);
816}
817
bb214884 818static int loop_set_fd(struct loop_device *lo, fmode_t mode,
1da177e4
LT
819 struct block_device *bdev, unsigned int arg)
820{
821 struct file *file, *f;
822 struct inode *inode;
823 struct address_space *mapping;
824 unsigned lo_blocksize;
825 int lo_flags = 0;
826 int error;
827 loff_t size;
828
829 /* This is safe, since we have a reference from open(). */
830 __module_get(THIS_MODULE);
831
832 error = -EBADF;
833 file = fget(arg);
834 if (!file)
835 goto out;
836
837 error = -EBUSY;
838 if (lo->lo_state != Lo_unbound)
839 goto out_putf;
840
841 /* Avoid recursion */
842 f = file;
843 while (is_loop_device(f)) {
844 struct loop_device *l;
845
bb214884 846 if (f->f_mapping->host->i_bdev == bdev)
1da177e4
LT
847 goto out_putf;
848
849 l = f->f_mapping->host->i_bdev->bd_disk->private_data;
850 if (l->lo_state == Lo_unbound) {
851 error = -EINVAL;
852 goto out_putf;
853 }
854 f = l->lo_backing_file;
855 }
856
857 mapping = file->f_mapping;
858 inode = mapping->host;
859
860 if (!(file->f_mode & FMODE_WRITE))
861 lo_flags |= LO_FLAGS_READ_ONLY;
862
863 error = -EINVAL;
864 if (S_ISREG(inode->i_mode) || S_ISBLK(inode->i_mode)) {
f5e54d6e 865 const struct address_space_operations *aops = mapping->a_ops;
6818173b 866
4e02ed4b 867 if (aops->write_begin)
1da177e4
LT
868 lo_flags |= LO_FLAGS_USE_AOPS;
869 if (!(lo_flags & LO_FLAGS_USE_AOPS) && !file->f_op->write)
870 lo_flags |= LO_FLAGS_READ_ONLY;
871
ba52de12
TT
872 lo_blocksize = S_ISBLK(inode->i_mode) ?
873 inode->i_bdev->bd_block_size : PAGE_SIZE;
874
1da177e4
LT
875 error = 0;
876 } else {
877 goto out_putf;
878 }
879
880 size = get_loop_size(lo, file);
881
882 if ((loff_t)(sector_t)size != size) {
883 error = -EFBIG;
884 goto out_putf;
885 }
886
bb214884 887 if (!(mode & FMODE_WRITE))
1da177e4
LT
888 lo_flags |= LO_FLAGS_READ_ONLY;
889
890 set_device_ro(bdev, (lo_flags & LO_FLAGS_READ_ONLY) != 0);
891
892 lo->lo_blocksize = lo_blocksize;
893 lo->lo_device = bdev;
894 lo->lo_flags = lo_flags;
895 lo->lo_backing_file = file;
eefe85ee 896 lo->transfer = transfer_none;
1da177e4
LT
897 lo->ioctl = NULL;
898 lo->lo_sizelimit = 0;
899 lo->old_gfp_mask = mapping_gfp_mask(mapping);
900 mapping_set_gfp_mask(mapping, lo->old_gfp_mask & ~(__GFP_IO|__GFP_FS));
901
e686307f 902 bio_list_init(&lo->lo_bio_list);
1da177e4
LT
903
904 /*
905 * set queue make_request_fn, and add limits based on lower level
906 * device
907 */
908 blk_queue_make_request(lo->lo_queue, loop_make_request);
909 lo->lo_queue->queuedata = lo;
1da177e4 910
68db1961 911 if (!(lo_flags & LO_FLAGS_READ_ONLY) && file->f_op->fsync)
4913efe4 912 blk_queue_flush(lo->lo_queue, REQ_FLUSH);
68db1961 913
73285082 914 set_capacity(lo->lo_disk, size);
1da177e4 915 bd_set_size(bdev, size << 9);
ee862730 916 loop_sysfs_init(lo);
c3473c63
DZ
917 /* let user-space know about the new size */
918 kobject_uevent(&disk_to_dev(bdev->bd_disk)->kobj, KOBJ_CHANGE);
1da177e4
LT
919
920 set_blocksize(bdev, lo_blocksize);
921
6c997918
SH
922 lo->lo_thread = kthread_create(loop_thread, lo, "loop%d",
923 lo->lo_number);
924 if (IS_ERR(lo->lo_thread)) {
925 error = PTR_ERR(lo->lo_thread);
a7422bf8 926 goto out_clr;
6c997918
SH
927 }
928 lo->lo_state = Lo_bound;
929 wake_up_process(lo->lo_thread);
476a4813
LV
930 if (max_part > 0)
931 ioctl_by_bdev(bdev, BLKRRPART, 0);
1da177e4
LT
932 return 0;
933
a7422bf8 934out_clr:
ee862730 935 loop_sysfs_exit(lo);
a7422bf8
SH
936 lo->lo_thread = NULL;
937 lo->lo_device = NULL;
938 lo->lo_backing_file = NULL;
939 lo->lo_flags = 0;
73285082 940 set_capacity(lo->lo_disk, 0);
f98393a6 941 invalidate_bdev(bdev);
a7422bf8 942 bd_set_size(bdev, 0);
c3473c63 943 kobject_uevent(&disk_to_dev(bdev->bd_disk)->kobj, KOBJ_CHANGE);
a7422bf8
SH
944 mapping_set_gfp_mask(mapping, lo->old_gfp_mask);
945 lo->lo_state = Lo_unbound;
1da177e4
LT
946 out_putf:
947 fput(file);
948 out:
949 /* This is safe: open() is still holding a reference. */
950 module_put(THIS_MODULE);
951 return error;
952}
953
954static int
955loop_release_xfer(struct loop_device *lo)
956{
957 int err = 0;
958 struct loop_func_table *xfer = lo->lo_encryption;
959
960 if (xfer) {
961 if (xfer->release)
962 err = xfer->release(lo);
963 lo->transfer = NULL;
964 lo->lo_encryption = NULL;
965 module_put(xfer->owner);
966 }
967 return err;
968}
969
970static int
971loop_init_xfer(struct loop_device *lo, struct loop_func_table *xfer,
972 const struct loop_info64 *i)
973{
974 int err = 0;
975
976 if (xfer) {
977 struct module *owner = xfer->owner;
978
979 if (!try_module_get(owner))
980 return -EINVAL;
981 if (xfer->init)
982 err = xfer->init(lo, i);
983 if (err)
984 module_put(owner);
985 else
986 lo->lo_encryption = xfer;
987 }
988 return err;
989}
990
991static int loop_clr_fd(struct loop_device *lo, struct block_device *bdev)
992{
993 struct file *filp = lo->lo_backing_file;
b4e3ca1a 994 gfp_t gfp = lo->old_gfp_mask;
1da177e4
LT
995
996 if (lo->lo_state != Lo_bound)
997 return -ENXIO;
998
999 if (lo->lo_refcnt > 1) /* we needed one fd for the ioctl */
1000 return -EBUSY;
1001
1002 if (filp == NULL)
1003 return -EINVAL;
1004
1005 spin_lock_irq(&lo->lo_lock);
1006 lo->lo_state = Lo_rundown;
1da177e4
LT
1007 spin_unlock_irq(&lo->lo_lock);
1008
6c997918 1009 kthread_stop(lo->lo_thread);
1da177e4
LT
1010
1011 lo->lo_backing_file = NULL;
1012
1013 loop_release_xfer(lo);
1014 lo->transfer = NULL;
1015 lo->ioctl = NULL;
1016 lo->lo_device = NULL;
1017 lo->lo_encryption = NULL;
1018 lo->lo_offset = 0;
1019 lo->lo_sizelimit = 0;
1020 lo->lo_encrypt_key_size = 0;
1021 lo->lo_flags = 0;
6c997918 1022 lo->lo_thread = NULL;
1da177e4
LT
1023 memset(lo->lo_encrypt_key, 0, LO_KEY_SIZE);
1024 memset(lo->lo_crypt_name, 0, LO_NAME_SIZE);
1025 memset(lo->lo_file_name, 0, LO_NAME_SIZE);
bb214884
AV
1026 if (bdev)
1027 invalidate_bdev(bdev);
73285082 1028 set_capacity(lo->lo_disk, 0);
51a0bb0c 1029 loop_sysfs_exit(lo);
c3473c63 1030 if (bdev) {
bb214884 1031 bd_set_size(bdev, 0);
c3473c63
DZ
1032 /* let user-space know about this change */
1033 kobject_uevent(&disk_to_dev(bdev->bd_disk)->kobj, KOBJ_CHANGE);
1034 }
1da177e4
LT
1035 mapping_set_gfp_mask(filp->f_mapping, gfp);
1036 lo->lo_state = Lo_unbound;
1da177e4
LT
1037 /* This is safe: open() is still holding a reference. */
1038 module_put(THIS_MODULE);
cf6e6932 1039 if (max_part > 0 && bdev)
476a4813 1040 ioctl_by_bdev(bdev, BLKRRPART, 0);
f028f3b2
NK
1041 mutex_unlock(&lo->lo_ctl_mutex);
1042 /*
1043 * Need not hold lo_ctl_mutex to fput backing file.
1044 * Calling fput holding lo_ctl_mutex triggers a circular
1045 * lock dependency possibility warning as fput can take
1046 * bd_mutex which is usually taken before lo_ctl_mutex.
1047 */
1048 fput(filp);
1da177e4
LT
1049 return 0;
1050}
1051
1052static int
1053loop_set_status(struct loop_device *lo, const struct loop_info64 *info)
1054{
1055 int err;
1056 struct loop_func_table *xfer;
b0fafa81 1057 uid_t uid = current_uid();
1da177e4 1058
b0fafa81
DH
1059 if (lo->lo_encrypt_key_size &&
1060 lo->lo_key_owner != uid &&
1da177e4
LT
1061 !capable(CAP_SYS_ADMIN))
1062 return -EPERM;
1063 if (lo->lo_state != Lo_bound)
1064 return -ENXIO;
1065 if ((unsigned int) info->lo_encrypt_key_size > LO_KEY_SIZE)
1066 return -EINVAL;
1067
1068 err = loop_release_xfer(lo);
1069 if (err)
1070 return err;
1071
1072 if (info->lo_encrypt_type) {
1073 unsigned int type = info->lo_encrypt_type;
1074
1075 if (type >= MAX_LO_CRYPT)
1076 return -EINVAL;
1077 xfer = xfer_funcs[type];
1078 if (xfer == NULL)
1079 return -EINVAL;
1080 } else
1081 xfer = NULL;
1082
1083 err = loop_init_xfer(lo, xfer, info);
1084 if (err)
1085 return err;
1086
1087 if (lo->lo_offset != info->lo_offset ||
1088 lo->lo_sizelimit != info->lo_sizelimit) {
1089 lo->lo_offset = info->lo_offset;
1090 lo->lo_sizelimit = info->lo_sizelimit;
1091 if (figure_loop_size(lo))
1092 return -EFBIG;
1093 }
1094
1095 memcpy(lo->lo_file_name, info->lo_file_name, LO_NAME_SIZE);
1096 memcpy(lo->lo_crypt_name, info->lo_crypt_name, LO_NAME_SIZE);
1097 lo->lo_file_name[LO_NAME_SIZE-1] = 0;
1098 lo->lo_crypt_name[LO_NAME_SIZE-1] = 0;
1099
1100 if (!xfer)
1101 xfer = &none_funcs;
1102 lo->transfer = xfer->transfer;
1103 lo->ioctl = xfer->ioctl;
1104
96c58655
DW
1105 if ((lo->lo_flags & LO_FLAGS_AUTOCLEAR) !=
1106 (info->lo_flags & LO_FLAGS_AUTOCLEAR))
1107 lo->lo_flags ^= LO_FLAGS_AUTOCLEAR;
1108
1da177e4
LT
1109 lo->lo_encrypt_key_size = info->lo_encrypt_key_size;
1110 lo->lo_init[0] = info->lo_init[0];
1111 lo->lo_init[1] = info->lo_init[1];
1112 if (info->lo_encrypt_key_size) {
1113 memcpy(lo->lo_encrypt_key, info->lo_encrypt_key,
1114 info->lo_encrypt_key_size);
b0fafa81 1115 lo->lo_key_owner = uid;
1da177e4
LT
1116 }
1117
1118 return 0;
1119}
1120
1121static int
1122loop_get_status(struct loop_device *lo, struct loop_info64 *info)
1123{
1124 struct file *file = lo->lo_backing_file;
1125 struct kstat stat;
1126 int error;
1127
1128 if (lo->lo_state != Lo_bound)
1129 return -ENXIO;
6c648be6 1130 error = vfs_getattr(file->f_path.mnt, file->f_path.dentry, &stat);
1da177e4
LT
1131 if (error)
1132 return error;
1133 memset(info, 0, sizeof(*info));
1134 info->lo_number = lo->lo_number;
1135 info->lo_device = huge_encode_dev(stat.dev);
1136 info->lo_inode = stat.ino;
1137 info->lo_rdevice = huge_encode_dev(lo->lo_device ? stat.rdev : stat.dev);
1138 info->lo_offset = lo->lo_offset;
1139 info->lo_sizelimit = lo->lo_sizelimit;
1140 info->lo_flags = lo->lo_flags;
1141 memcpy(info->lo_file_name, lo->lo_file_name, LO_NAME_SIZE);
1142 memcpy(info->lo_crypt_name, lo->lo_crypt_name, LO_NAME_SIZE);
1143 info->lo_encrypt_type =
1144 lo->lo_encryption ? lo->lo_encryption->number : 0;
1145 if (lo->lo_encrypt_key_size && capable(CAP_SYS_ADMIN)) {
1146 info->lo_encrypt_key_size = lo->lo_encrypt_key_size;
1147 memcpy(info->lo_encrypt_key, lo->lo_encrypt_key,
1148 lo->lo_encrypt_key_size);
1149 }
1150 return 0;
1151}
1152
1153static void
1154loop_info64_from_old(const struct loop_info *info, struct loop_info64 *info64)
1155{
1156 memset(info64, 0, sizeof(*info64));
1157 info64->lo_number = info->lo_number;
1158 info64->lo_device = info->lo_device;
1159 info64->lo_inode = info->lo_inode;
1160 info64->lo_rdevice = info->lo_rdevice;
1161 info64->lo_offset = info->lo_offset;
1162 info64->lo_sizelimit = 0;
1163 info64->lo_encrypt_type = info->lo_encrypt_type;
1164 info64->lo_encrypt_key_size = info->lo_encrypt_key_size;
1165 info64->lo_flags = info->lo_flags;
1166 info64->lo_init[0] = info->lo_init[0];
1167 info64->lo_init[1] = info->lo_init[1];
1168 if (info->lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1169 memcpy(info64->lo_crypt_name, info->lo_name, LO_NAME_SIZE);
1170 else
1171 memcpy(info64->lo_file_name, info->lo_name, LO_NAME_SIZE);
1172 memcpy(info64->lo_encrypt_key, info->lo_encrypt_key, LO_KEY_SIZE);
1173}
1174
1175static int
1176loop_info64_to_old(const struct loop_info64 *info64, struct loop_info *info)
1177{
1178 memset(info, 0, sizeof(*info));
1179 info->lo_number = info64->lo_number;
1180 info->lo_device = info64->lo_device;
1181 info->lo_inode = info64->lo_inode;
1182 info->lo_rdevice = info64->lo_rdevice;
1183 info->lo_offset = info64->lo_offset;
1184 info->lo_encrypt_type = info64->lo_encrypt_type;
1185 info->lo_encrypt_key_size = info64->lo_encrypt_key_size;
1186 info->lo_flags = info64->lo_flags;
1187 info->lo_init[0] = info64->lo_init[0];
1188 info->lo_init[1] = info64->lo_init[1];
1189 if (info->lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1190 memcpy(info->lo_name, info64->lo_crypt_name, LO_NAME_SIZE);
1191 else
1192 memcpy(info->lo_name, info64->lo_file_name, LO_NAME_SIZE);
1193 memcpy(info->lo_encrypt_key, info64->lo_encrypt_key, LO_KEY_SIZE);
1194
1195 /* error in case values were truncated */
1196 if (info->lo_device != info64->lo_device ||
1197 info->lo_rdevice != info64->lo_rdevice ||
1198 info->lo_inode != info64->lo_inode ||
1199 info->lo_offset != info64->lo_offset)
1200 return -EOVERFLOW;
1201
1202 return 0;
1203}
1204
1205static int
1206loop_set_status_old(struct loop_device *lo, const struct loop_info __user *arg)
1207{
1208 struct loop_info info;
1209 struct loop_info64 info64;
1210
1211 if (copy_from_user(&info, arg, sizeof (struct loop_info)))
1212 return -EFAULT;
1213 loop_info64_from_old(&info, &info64);
1214 return loop_set_status(lo, &info64);
1215}
1216
1217static int
1218loop_set_status64(struct loop_device *lo, const struct loop_info64 __user *arg)
1219{
1220 struct loop_info64 info64;
1221
1222 if (copy_from_user(&info64, arg, sizeof (struct loop_info64)))
1223 return -EFAULT;
1224 return loop_set_status(lo, &info64);
1225}
1226
1227static int
1228loop_get_status_old(struct loop_device *lo, struct loop_info __user *arg) {
1229 struct loop_info info;
1230 struct loop_info64 info64;
1231 int err = 0;
1232
1233 if (!arg)
1234 err = -EINVAL;
1235 if (!err)
1236 err = loop_get_status(lo, &info64);
1237 if (!err)
1238 err = loop_info64_to_old(&info64, &info);
1239 if (!err && copy_to_user(arg, &info, sizeof(info)))
1240 err = -EFAULT;
1241
1242 return err;
1243}
1244
1245static int
1246loop_get_status64(struct loop_device *lo, struct loop_info64 __user *arg) {
1247 struct loop_info64 info64;
1248 int err = 0;
1249
1250 if (!arg)
1251 err = -EINVAL;
1252 if (!err)
1253 err = loop_get_status(lo, &info64);
1254 if (!err && copy_to_user(arg, &info64, sizeof(info64)))
1255 err = -EFAULT;
1256
1257 return err;
1258}
1259
53d66608
O
1260static int loop_set_capacity(struct loop_device *lo, struct block_device *bdev)
1261{
1262 int err;
1263 sector_t sec;
1264 loff_t sz;
1265
1266 err = -ENXIO;
1267 if (unlikely(lo->lo_state != Lo_bound))
1268 goto out;
1269 err = figure_loop_size(lo);
1270 if (unlikely(err))
1271 goto out;
1272 sec = get_capacity(lo->lo_disk);
1273 /* the width of sector_t may be narrow for bit-shift */
1274 sz = sec;
1275 sz <<= 9;
1276 mutex_lock(&bdev->bd_mutex);
1277 bd_set_size(bdev, sz);
c3473c63
DZ
1278 /* let user-space know about the new size */
1279 kobject_uevent(&disk_to_dev(bdev->bd_disk)->kobj, KOBJ_CHANGE);
53d66608
O
1280 mutex_unlock(&bdev->bd_mutex);
1281
1282 out:
1283 return err;
1284}
1285
bb214884 1286static int lo_ioctl(struct block_device *bdev, fmode_t mode,
1da177e4
LT
1287 unsigned int cmd, unsigned long arg)
1288{
bb214884 1289 struct loop_device *lo = bdev->bd_disk->private_data;
1da177e4
LT
1290 int err;
1291
f028f3b2 1292 mutex_lock_nested(&lo->lo_ctl_mutex, 1);
1da177e4
LT
1293 switch (cmd) {
1294 case LOOP_SET_FD:
bb214884 1295 err = loop_set_fd(lo, mode, bdev, arg);
1da177e4
LT
1296 break;
1297 case LOOP_CHANGE_FD:
bb214884 1298 err = loop_change_fd(lo, bdev, arg);
1da177e4
LT
1299 break;
1300 case LOOP_CLR_FD:
f028f3b2 1301 /* loop_clr_fd would have unlocked lo_ctl_mutex on success */
bb214884 1302 err = loop_clr_fd(lo, bdev);
f028f3b2
NK
1303 if (!err)
1304 goto out_unlocked;
1da177e4
LT
1305 break;
1306 case LOOP_SET_STATUS:
1307 err = loop_set_status_old(lo, (struct loop_info __user *) arg);
1308 break;
1309 case LOOP_GET_STATUS:
1310 err = loop_get_status_old(lo, (struct loop_info __user *) arg);
1311 break;
1312 case LOOP_SET_STATUS64:
1313 err = loop_set_status64(lo, (struct loop_info64 __user *) arg);
1314 break;
1315 case LOOP_GET_STATUS64:
1316 err = loop_get_status64(lo, (struct loop_info64 __user *) arg);
1317 break;
53d66608
O
1318 case LOOP_SET_CAPACITY:
1319 err = -EPERM;
1320 if ((mode & FMODE_WRITE) || capable(CAP_SYS_ADMIN))
1321 err = loop_set_capacity(lo, bdev);
1322 break;
1da177e4
LT
1323 default:
1324 err = lo->ioctl ? lo->ioctl(lo, cmd, arg) : -EINVAL;
1325 }
f85221dd 1326 mutex_unlock(&lo->lo_ctl_mutex);
f028f3b2
NK
1327
1328out_unlocked:
1da177e4
LT
1329 return err;
1330}
1331
863d5b82
DH
1332#ifdef CONFIG_COMPAT
1333struct compat_loop_info {
1334 compat_int_t lo_number; /* ioctl r/o */
1335 compat_dev_t lo_device; /* ioctl r/o */
1336 compat_ulong_t lo_inode; /* ioctl r/o */
1337 compat_dev_t lo_rdevice; /* ioctl r/o */
1338 compat_int_t lo_offset;
1339 compat_int_t lo_encrypt_type;
1340 compat_int_t lo_encrypt_key_size; /* ioctl w/o */
1341 compat_int_t lo_flags; /* ioctl r/o */
1342 char lo_name[LO_NAME_SIZE];
1343 unsigned char lo_encrypt_key[LO_KEY_SIZE]; /* ioctl w/o */
1344 compat_ulong_t lo_init[2];
1345 char reserved[4];
1346};
1347
1348/*
1349 * Transfer 32-bit compatibility structure in userspace to 64-bit loop info
1350 * - noinlined to reduce stack space usage in main part of driver
1351 */
1352static noinline int
ba674cfc 1353loop_info64_from_compat(const struct compat_loop_info __user *arg,
863d5b82
DH
1354 struct loop_info64 *info64)
1355{
1356 struct compat_loop_info info;
1357
1358 if (copy_from_user(&info, arg, sizeof(info)))
1359 return -EFAULT;
1360
1361 memset(info64, 0, sizeof(*info64));
1362 info64->lo_number = info.lo_number;
1363 info64->lo_device = info.lo_device;
1364 info64->lo_inode = info.lo_inode;
1365 info64->lo_rdevice = info.lo_rdevice;
1366 info64->lo_offset = info.lo_offset;
1367 info64->lo_sizelimit = 0;
1368 info64->lo_encrypt_type = info.lo_encrypt_type;
1369 info64->lo_encrypt_key_size = info.lo_encrypt_key_size;
1370 info64->lo_flags = info.lo_flags;
1371 info64->lo_init[0] = info.lo_init[0];
1372 info64->lo_init[1] = info.lo_init[1];
1373 if (info.lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1374 memcpy(info64->lo_crypt_name, info.lo_name, LO_NAME_SIZE);
1375 else
1376 memcpy(info64->lo_file_name, info.lo_name, LO_NAME_SIZE);
1377 memcpy(info64->lo_encrypt_key, info.lo_encrypt_key, LO_KEY_SIZE);
1378 return 0;
1379}
1380
1381/*
1382 * Transfer 64-bit loop info to 32-bit compatibility structure in userspace
1383 * - noinlined to reduce stack space usage in main part of driver
1384 */
1385static noinline int
1386loop_info64_to_compat(const struct loop_info64 *info64,
1387 struct compat_loop_info __user *arg)
1388{
1389 struct compat_loop_info info;
1390
1391 memset(&info, 0, sizeof(info));
1392 info.lo_number = info64->lo_number;
1393 info.lo_device = info64->lo_device;
1394 info.lo_inode = info64->lo_inode;
1395 info.lo_rdevice = info64->lo_rdevice;
1396 info.lo_offset = info64->lo_offset;
1397 info.lo_encrypt_type = info64->lo_encrypt_type;
1398 info.lo_encrypt_key_size = info64->lo_encrypt_key_size;
1399 info.lo_flags = info64->lo_flags;
1400 info.lo_init[0] = info64->lo_init[0];
1401 info.lo_init[1] = info64->lo_init[1];
1402 if (info.lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1403 memcpy(info.lo_name, info64->lo_crypt_name, LO_NAME_SIZE);
1404 else
1405 memcpy(info.lo_name, info64->lo_file_name, LO_NAME_SIZE);
1406 memcpy(info.lo_encrypt_key, info64->lo_encrypt_key, LO_KEY_SIZE);
1407
1408 /* error in case values were truncated */
1409 if (info.lo_device != info64->lo_device ||
1410 info.lo_rdevice != info64->lo_rdevice ||
1411 info.lo_inode != info64->lo_inode ||
1412 info.lo_offset != info64->lo_offset ||
1413 info.lo_init[0] != info64->lo_init[0] ||
1414 info.lo_init[1] != info64->lo_init[1])
1415 return -EOVERFLOW;
1416
1417 if (copy_to_user(arg, &info, sizeof(info)))
1418 return -EFAULT;
1419 return 0;
1420}
1421
1422static int
1423loop_set_status_compat(struct loop_device *lo,
1424 const struct compat_loop_info __user *arg)
1425{
1426 struct loop_info64 info64;
1427 int ret;
1428
1429 ret = loop_info64_from_compat(arg, &info64);
1430 if (ret < 0)
1431 return ret;
1432 return loop_set_status(lo, &info64);
1433}
1434
1435static int
1436loop_get_status_compat(struct loop_device *lo,
1437 struct compat_loop_info __user *arg)
1438{
1439 struct loop_info64 info64;
1440 int err = 0;
1441
1442 if (!arg)
1443 err = -EINVAL;
1444 if (!err)
1445 err = loop_get_status(lo, &info64);
1446 if (!err)
1447 err = loop_info64_to_compat(&info64, arg);
1448 return err;
1449}
1450
bb214884
AV
1451static int lo_compat_ioctl(struct block_device *bdev, fmode_t mode,
1452 unsigned int cmd, unsigned long arg)
863d5b82 1453{
bb214884 1454 struct loop_device *lo = bdev->bd_disk->private_data;
863d5b82
DH
1455 int err;
1456
863d5b82
DH
1457 switch(cmd) {
1458 case LOOP_SET_STATUS:
1459 mutex_lock(&lo->lo_ctl_mutex);
1460 err = loop_set_status_compat(
1461 lo, (const struct compat_loop_info __user *) arg);
1462 mutex_unlock(&lo->lo_ctl_mutex);
1463 break;
1464 case LOOP_GET_STATUS:
1465 mutex_lock(&lo->lo_ctl_mutex);
1466 err = loop_get_status_compat(
1467 lo, (struct compat_loop_info __user *) arg);
1468 mutex_unlock(&lo->lo_ctl_mutex);
1469 break;
53d66608 1470 case LOOP_SET_CAPACITY:
863d5b82
DH
1471 case LOOP_CLR_FD:
1472 case LOOP_GET_STATUS64:
1473 case LOOP_SET_STATUS64:
1474 arg = (unsigned long) compat_ptr(arg);
1475 case LOOP_SET_FD:
1476 case LOOP_CHANGE_FD:
bb214884 1477 err = lo_ioctl(bdev, mode, cmd, arg);
863d5b82
DH
1478 break;
1479 default:
1480 err = -ENOIOCTLCMD;
1481 break;
1482 }
863d5b82
DH
1483 return err;
1484}
1485#endif
1486
bb214884 1487static int lo_open(struct block_device *bdev, fmode_t mode)
1da177e4 1488{
bb214884 1489 struct loop_device *lo = bdev->bd_disk->private_data;
1da177e4 1490
2a48fc0a 1491 mutex_lock(&loop_mutex);
f85221dd 1492 mutex_lock(&lo->lo_ctl_mutex);
1da177e4 1493 lo->lo_refcnt++;
f85221dd 1494 mutex_unlock(&lo->lo_ctl_mutex);
2a48fc0a 1495 mutex_unlock(&loop_mutex);
1da177e4
LT
1496
1497 return 0;
1498}
1499
bb214884 1500static int lo_release(struct gendisk *disk, fmode_t mode)
1da177e4 1501{
bb214884 1502 struct loop_device *lo = disk->private_data;
ffcd7dca 1503 int err;
1da177e4 1504
2a48fc0a 1505 mutex_lock(&loop_mutex);
f85221dd 1506 mutex_lock(&lo->lo_ctl_mutex);
96c58655 1507
14f27939
MB
1508 if (--lo->lo_refcnt)
1509 goto out;
1510
1511 if (lo->lo_flags & LO_FLAGS_AUTOCLEAR) {
1512 /*
1513 * In autoclear mode, stop the loop thread
1514 * and remove configuration after last close.
1515 */
ffcd7dca
AB
1516 err = loop_clr_fd(lo, NULL);
1517 if (!err)
1518 goto out_unlocked;
14f27939
MB
1519 } else {
1520 /*
1521 * Otherwise keep thread (if running) and config,
1522 * but flush possible ongoing bios in thread.
1523 */
1524 loop_flush(lo);
1525 }
96c58655 1526
14f27939 1527out:
f85221dd 1528 mutex_unlock(&lo->lo_ctl_mutex);
ffcd7dca 1529out_unlocked:
2a48fc0a 1530 mutex_unlock(&loop_mutex);
1da177e4
LT
1531 return 0;
1532}
1533
83d5cde4 1534static const struct block_device_operations lo_fops = {
1da177e4 1535 .owner = THIS_MODULE,
bb214884
AV
1536 .open = lo_open,
1537 .release = lo_release,
1538 .ioctl = lo_ioctl,
863d5b82 1539#ifdef CONFIG_COMPAT
bb214884 1540 .compat_ioctl = lo_compat_ioctl,
863d5b82 1541#endif
1da177e4
LT
1542};
1543
1544/*
1545 * And now the modules code and kernel interface.
1546 */
73285082 1547static int max_loop;
1da177e4 1548module_param(max_loop, int, 0);
a47653fc 1549MODULE_PARM_DESC(max_loop, "Maximum number of loop devices");
476a4813
LV
1550module_param(max_part, int, 0);
1551MODULE_PARM_DESC(max_part, "Maximum number of partitions per loop device");
1da177e4
LT
1552MODULE_LICENSE("GPL");
1553MODULE_ALIAS_BLOCKDEV_MAJOR(LOOP_MAJOR);
1554
1555int loop_register_transfer(struct loop_func_table *funcs)
1556{
1557 unsigned int n = funcs->number;
1558
1559 if (n >= MAX_LO_CRYPT || xfer_funcs[n])
1560 return -EINVAL;
1561 xfer_funcs[n] = funcs;
1562 return 0;
1563}
1564
1565int loop_unregister_transfer(int number)
1566{
1567 unsigned int n = number;
1568 struct loop_device *lo;
1569 struct loop_func_table *xfer;
1570
1571 if (n == 0 || n >= MAX_LO_CRYPT || (xfer = xfer_funcs[n]) == NULL)
1572 return -EINVAL;
1573
1574 xfer_funcs[n] = NULL;
1575
73285082 1576 list_for_each_entry(lo, &loop_devices, lo_list) {
f85221dd 1577 mutex_lock(&lo->lo_ctl_mutex);
1da177e4
LT
1578
1579 if (lo->lo_encryption == xfer)
1580 loop_release_xfer(lo);
1581
f85221dd 1582 mutex_unlock(&lo->lo_ctl_mutex);
1da177e4
LT
1583 }
1584
1585 return 0;
1586}
1587
1588EXPORT_SYMBOL(loop_register_transfer);
1589EXPORT_SYMBOL(loop_unregister_transfer);
1590
a47653fc 1591static struct loop_device *loop_alloc(int i)
73285082
KC
1592{
1593 struct loop_device *lo;
1594 struct gendisk *disk;
1595
1596 lo = kzalloc(sizeof(*lo), GFP_KERNEL);
1597 if (!lo)
1598 goto out;
1599
1600 lo->lo_queue = blk_alloc_queue(GFP_KERNEL);
1601 if (!lo->lo_queue)
1602 goto out_free_dev;
1603
476a4813 1604 disk = lo->lo_disk = alloc_disk(1 << part_shift);
73285082
KC
1605 if (!disk)
1606 goto out_free_queue;
1607
1608 mutex_init(&lo->lo_ctl_mutex);
1609 lo->lo_number = i;
1610 lo->lo_thread = NULL;
1611 init_waitqueue_head(&lo->lo_event);
1612 spin_lock_init(&lo->lo_lock);
1613 disk->major = LOOP_MAJOR;
476a4813 1614 disk->first_minor = i << part_shift;
73285082
KC
1615 disk->fops = &lo_fops;
1616 disk->private_data = lo;
1617 disk->queue = lo->lo_queue;
1618 sprintf(disk->disk_name, "loop%d", i);
73285082
KC
1619 return lo;
1620
1621out_free_queue:
1622 blk_cleanup_queue(lo->lo_queue);
1623out_free_dev:
1624 kfree(lo);
1625out:
07002e99 1626 return NULL;
73285082
KC
1627}
1628
a47653fc 1629static void loop_free(struct loop_device *lo)
1da177e4 1630{
ee71a968
SS
1631 if (!lo->lo_queue->queue_lock)
1632 lo->lo_queue->queue_lock = &lo->lo_queue->__queue_lock;
1633
73285082
KC
1634 blk_cleanup_queue(lo->lo_queue);
1635 put_disk(lo->lo_disk);
1636 list_del(&lo->lo_list);
1637 kfree(lo);
1638}
1da177e4 1639
a47653fc
KC
1640static struct loop_device *loop_init_one(int i)
1641{
1642 struct loop_device *lo;
1643
1644 list_for_each_entry(lo, &loop_devices, lo_list) {
1645 if (lo->lo_number == i)
1646 return lo;
1647 }
1648
1649 lo = loop_alloc(i);
1650 if (lo) {
1651 add_disk(lo->lo_disk);
1652 list_add_tail(&lo->lo_list, &loop_devices);
1653 }
1654 return lo;
1655}
1656
1657static void loop_del_one(struct loop_device *lo)
1658{
1659 del_gendisk(lo->lo_disk);
1660 loop_free(lo);
1661}
1662
73285082
KC
1663static struct kobject *loop_probe(dev_t dev, int *part, void *data)
1664{
705962cc 1665 struct loop_device *lo;
07002e99 1666 struct kobject *kobj;
73285082 1667
705962cc
AV
1668 mutex_lock(&loop_devices_mutex);
1669 lo = loop_init_one(dev & MINORMASK);
07002e99 1670 kobj = lo ? get_disk(lo->lo_disk) : ERR_PTR(-ENOMEM);
73285082
KC
1671 mutex_unlock(&loop_devices_mutex);
1672
1673 *part = 0;
07002e99 1674 return kobj;
73285082
KC
1675}
1676
1677static int __init loop_init(void)
1678{
a47653fc
KC
1679 int i, nr;
1680 unsigned long range;
1681 struct loop_device *lo, *next;
1682
1683 /*
1684 * loop module now has a feature to instantiate underlying device
1685 * structure on-demand, provided that there is an access dev node.
1686 * However, this will not work well with user space tool that doesn't
1687 * know about such "feature". In order to not break any existing
1688 * tool, we do the following:
1689 *
1690 * (1) if max_loop is specified, create that many upfront, and this
1691 * also becomes a hard limit.
1692 * (2) if max_loop is not specified, create 8 loop device on module
1693 * load, user can further extend loop device by create dev node
1694 * themselves and have kernel automatically instantiate actual
1695 * device on-demand.
1696 */
476a4813
LV
1697
1698 part_shift = 0;
1699 if (max_part > 0)
1700 part_shift = fls(max_part);
1701
1702 if (max_loop > 1UL << (MINORBITS - part_shift))
a47653fc 1703 return -EINVAL;
1da177e4 1704
73285082 1705 if (max_loop) {
a47653fc
KC
1706 nr = max_loop;
1707 range = max_loop;
1708 } else {
1709 nr = 8;
476a4813 1710 range = 1UL << (MINORBITS - part_shift);
a47653fc
KC
1711 }
1712
1713 if (register_blkdev(LOOP_MAJOR, "loop"))
1714 return -EIO;
1da177e4 1715
a47653fc
KC
1716 for (i = 0; i < nr; i++) {
1717 lo = loop_alloc(i);
1718 if (!lo)
1719 goto Enomem;
1720 list_add_tail(&lo->lo_list, &loop_devices);
1da177e4 1721 }
a47653fc
KC
1722
1723 /* point of no return */
1724
1725 list_for_each_entry(lo, &loop_devices, lo_list)
1726 add_disk(lo->lo_disk);
1727
1728 blk_register_region(MKDEV(LOOP_MAJOR, 0), range,
1729 THIS_MODULE, loop_probe, NULL, NULL);
1730
73285082 1731 printk(KERN_INFO "loop: module loaded\n");
1da177e4 1732 return 0;
a47653fc
KC
1733
1734Enomem:
1735 printk(KERN_INFO "loop: out of memory\n");
1736
1737 list_for_each_entry_safe(lo, next, &loop_devices, lo_list)
1738 loop_free(lo);
1739
1740 unregister_blkdev(LOOP_MAJOR, "loop");
1741 return -ENOMEM;
1da177e4
LT
1742}
1743
73285082 1744static void __exit loop_exit(void)
1da177e4 1745{
a47653fc 1746 unsigned long range;
73285082 1747 struct loop_device *lo, *next;
1da177e4 1748
476a4813 1749 range = max_loop ? max_loop : 1UL << (MINORBITS - part_shift);
a47653fc 1750
73285082
KC
1751 list_for_each_entry_safe(lo, next, &loop_devices, lo_list)
1752 loop_del_one(lo);
1753
a47653fc 1754 blk_unregister_region(MKDEV(LOOP_MAJOR, 0), range);
00d59405 1755 unregister_blkdev(LOOP_MAJOR, "loop");
1da177e4
LT
1756}
1757
1758module_init(loop_init);
1759module_exit(loop_exit);
1760
1761#ifndef MODULE
1762static int __init max_loop_setup(char *str)
1763{
1764 max_loop = simple_strtol(str, NULL, 0);
1765 return 1;
1766}
1767
1768__setup("max_loop=", max_loop_setup);
1769#endif