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