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