loop: add management interface for on-demand device allocation
[pandora-kernel.git] / drivers / block / loop.c
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.
32  * Erik I. Bolsø, <eriki@himolde.no>, Oct 31, 1999
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
43  * operations write_begin is not available on the backing filesystem.
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
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>
64 #include <linux/swap.h>
65 #include <linux/slab.h>
66 #include <linux/loop.h>
67 #include <linux/compat.h>
68 #include <linux/suspend.h>
69 #include <linux/freezer.h>
70 #include <linux/mutex.h>
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/kthread.h>
76 #include <linux/splice.h>
77 #include <linux/sysfs.h>
78 #include <linux/miscdevice.h>
79 #include <asm/uaccess.h>
80
81 static DEFINE_IDR(loop_index_idr);
82 static DEFINE_MUTEX(loop_index_mutex);
83
84 static int max_part;
85 static int part_shift;
86
87 /*
88  * Transfer functions
89  */
90 static 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(loop_buf, KM_USER1);
104         kunmap_atomic(raw_buf, KM_USER0);
105         cond_resched();
106         return 0;
107 }
108
109 static 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(loop_buf, KM_USER1);
133         kunmap_atomic(raw_buf, KM_USER0);
134         cond_resched();
135         return 0;
136 }
137
138 static 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
145 static struct loop_func_table none_funcs = {
146         .number = LO_CRYPT_NONE,
147         .transfer = transfer_none,
148 };      
149
150 static 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 */
157 static struct loop_func_table *xfer_funcs[MAX_LO_CRYPT] = {
158         &none_funcs,
159         &xor_funcs
160 };
161
162 static 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
180 static int
181 figure_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
189         set_capacity(lo->lo_disk, x);
190         return 0;                                       
191 }
192
193 static inline int
194 lo_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
209  * space operations write_begin and write_end.
210  */
211 static int do_lo_send_aops(struct loop_device *lo, struct bio_vec *bvec,
212                 loff_t pos, struct page *unused)
213 {
214         struct file *file = lo->lo_backing_file; /* kudos to NFsckingS */
215         struct address_space *mapping = file->f_mapping;
216         pgoff_t index;
217         unsigned offset, bv_offs;
218         int len, ret;
219
220         mutex_lock(&mapping->host->i_mutex);
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;
227                 unsigned size, copied;
228                 int transfer_result;
229                 struct page *page;
230                 void *fsdata;
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;
236
237                 ret = pagecache_write_begin(file, mapping, pos, size, 0,
238                                                         &page, &fsdata);
239                 if (ret)
240                         goto fail;
241
242                 file_update_time(file);
243
244                 transfer_result = lo_do_transfer(lo, WRITE, page, offset,
245                                 bvec->bv_page, bv_offs, size, IV);
246                 copied = size;
247                 if (unlikely(transfer_result))
248                         copied = 0;
249
250                 ret = pagecache_write_end(file, mapping, pos, size, copied,
251                                                         page, fsdata);
252                 if (ret < 0 || ret != copied)
253                         goto fail;
254
255                 if (unlikely(transfer_result))
256                         goto fail;
257
258                 bv_offs += copied;
259                 len -= copied;
260                 offset = 0;
261                 index++;
262                 pos += copied;
263         }
264         ret = 0;
265 out:
266         mutex_unlock(&mapping->host->i_mutex);
267         return ret;
268 fail:
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  */
279 static int __do_lo_send_write(struct file *file,
280                 u8 *buf, const int len, loff_t pos)
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
301  * not implement the address space operations write_begin and write_end.
302  * It uses the write file operation which should be present on all writeable
303  * filesystems.
304  */
305 static int do_lo_send_direct_write(struct loop_device *lo,
306                 struct bio_vec *bvec, loff_t pos, struct page *page)
307 {
308         ssize_t bw = __do_lo_send_write(lo->lo_backing_file,
309                         kmap(bvec->bv_page) + bvec->bv_offset,
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
320  * implement the address space operations write_begin and write_end.  It
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  */
329 static int do_lo_send_write(struct loop_device *lo, struct bio_vec *bvec,
330                 loff_t pos, struct page *page)
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,
336                                 page_address(page), bvec->bv_len,
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
345 static int lo_send(struct loop_device *lo, struct bio *bio, loff_t pos)
346 {
347         int (*do_lo_send)(struct loop_device *, struct bio_vec *, loff_t,
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) {
365                 ret = do_lo_send(lo, bvec, pos, page);
366                 if (ret < 0)
367                         break;
368                 pos += bvec->bv_len;
369         }
370         if (page) {
371                 kunmap(page);
372                 __free_page(page);
373         }
374 out:
375         return ret;
376 fail:
377         printk(KERN_ERR "loop: Failed to allocate temporary page for write.\n");
378         ret = -ENOMEM;
379         goto out;
380 }
381
382 struct lo_read_data {
383         struct loop_device *lo;
384         struct page *page;
385         unsigned offset;
386         int bsize;
387 };
388
389 static int
390 lo_splice_actor(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
391                 struct splice_desc *sd)
392 {
393         struct lo_read_data *p = sd->u.data;
394         struct loop_device *lo = p->lo;
395         struct page *page = buf->page;
396         sector_t IV;
397         int size;
398
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;
404
405         if (lo_do_transfer(lo, READ, page, buf->offset, p->page, p->offset, size, IV)) {
406                 printk(KERN_ERR "loop: transfer error block %ld\n",
407                        page->index);
408                 size = -EINVAL;
409         }
410
411         flush_dcache_page(p->page);
412
413         if (size > 0)
414                 p->offset += size;
415
416         return size;
417 }
418
419 static int
420 lo_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
425 static int
426 do_lo_receive(struct loop_device *lo,
427               struct bio_vec *bvec, int bsize, loff_t pos)
428 {
429         struct lo_read_data cookie;
430         struct splice_desc sd;
431         struct file *file;
432         long retval;
433
434         cookie.lo = lo;
435         cookie.page = bvec->bv_page;
436         cookie.offset = bvec->bv_offset;
437         cookie.bsize = bsize;
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
445         file = lo->lo_backing_file;
446         retval = splice_direct_to_actor(file, &sd, lo_direct_splice_actor);
447
448         if (retval < 0)
449                 return retval;
450
451         return 0;
452 }
453
454 static int
455 lo_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
469 static 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;
475
476         if (bio_rw(bio) == WRITE) {
477                 struct file *file = lo->lo_backing_file;
478
479                 if (bio->bi_rw & REQ_FLUSH) {
480                         ret = vfs_fsync(file, 0);
481                         if (unlikely(ret && ret != -EINVAL)) {
482                                 ret = -EIO;
483                                 goto out;
484                         }
485                 }
486
487                 ret = lo_send(lo, bio, pos);
488
489                 if ((bio->bi_rw & REQ_FUA) && !ret) {
490                         ret = vfs_fsync(file, 0);
491                         if (unlikely(ret && ret != -EINVAL))
492                                 ret = -EIO;
493                 }
494         } else
495                 ret = lo_receive(lo, bio, lo->lo_blocksize, pos);
496
497 out:
498         return ret;
499 }
500
501 /*
502  * Add bio to back of pending list
503  */
504 static void loop_add_bio(struct loop_device *lo, struct bio *bio)
505 {
506         bio_list_add(&lo->lo_bio_list, bio);
507 }
508
509 /*
510  * Grab first pending buffer
511  */
512 static struct bio *loop_get_bio(struct loop_device *lo)
513 {
514         return bio_list_pop(&lo->lo_bio_list);
515 }
516
517 static int loop_make_request(struct request_queue *q, struct bio *old_bio)
518 {
519         struct loop_device *lo = q->queuedata;
520         int rw = bio_rw(old_bio);
521
522         if (rw == READA)
523                 rw = READ;
524
525         BUG_ON(!lo || (rw != READ && rw != WRITE));
526
527         spin_lock_irq(&lo->lo_lock);
528         if (lo->lo_state != Lo_bound)
529                 goto out;
530         if (unlikely(rw == WRITE && (lo->lo_flags & LO_FLAGS_READ_ONLY)))
531                 goto out;
532         loop_add_bio(lo, old_bio);
533         wake_up(&lo->lo_event);
534         spin_unlock_irq(&lo->lo_lock);
535         return 0;
536
537 out:
538         spin_unlock_irq(&lo->lo_lock);
539         bio_io_error(old_bio);
540         return 0;
541 }
542
543 struct switch_request {
544         struct file *file;
545         struct completion wait;
546 };
547
548 static void do_loop_switch(struct loop_device *, struct switch_request *);
549
550 static inline void loop_handle_bio(struct loop_device *lo, struct bio *bio)
551 {
552         if (unlikely(!bio->bi_bdev)) {
553                 do_loop_switch(lo, bio->bi_private);
554                 bio_put(bio);
555         } else {
556                 int ret = do_bio_filebacked(lo, bio);
557                 bio_endio(bio, ret);
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.
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.
572  */
573 static int loop_thread(void *data)
574 {
575         struct loop_device *lo = data;
576         struct bio *bio;
577
578         set_user_nice(current, -20);
579
580         while (!kthread_should_stop() || !bio_list_empty(&lo->lo_bio_list)) {
581
582                 wait_event_interruptible(lo->lo_event,
583                                 !bio_list_empty(&lo->lo_bio_list) ||
584                                 kthread_should_stop());
585
586                 if (bio_list_empty(&lo->lo_bio_list))
587                         continue;
588                 spin_lock_irq(&lo->lo_lock);
589                 bio = loop_get_bio(lo);
590                 spin_unlock_irq(&lo->lo_lock);
591
592                 BUG_ON(!bio);
593                 loop_handle_bio(lo, bio);
594         }
595
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  */
604 static int loop_switch(struct loop_device *lo, struct file *file)
605 {
606         struct switch_request w;
607         struct bio *bio = bio_alloc(GFP_KERNEL, 0);
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
619 /*
620  * Helper to flush the IOs in loop, but keeping loop thread running
621  */
622 static 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
631 /*
632  * Do the actual switch; called from the BIO completion routine
633  */
634 static 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;
638         struct address_space *mapping;
639
640         /* if no new file, only flush of queued bios requested */
641         if (!file)
642                 goto out;
643
644         mapping = file->f_mapping;
645         mapping_set_gfp_mask(old_file->f_mapping, lo->old_gfp_mask);
646         lo->lo_backing_file = file;
647         lo->lo_blocksize = S_ISBLK(mapping->host->i_mode) ?
648                 mapping->host->i_bdev->bd_block_size : PAGE_SIZE;
649         lo->old_gfp_mask = mapping_gfp_mask(mapping);
650         mapping_set_gfp_mask(mapping, lo->old_gfp_mask & ~(__GFP_IO|__GFP_FS));
651 out:
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  */
664 static int loop_change_fd(struct loop_device *lo, struct block_device *bdev,
665                           unsigned int arg)
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
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);
703         if (max_part > 0)
704                 ioctl_by_bdev(bdev, BLKRRPART, 0);
705         return 0;
706
707  out_putf:
708         fput(file);
709  out:
710         return error;
711 }
712
713 static 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
720 /* loop sysfs attributes */
721
722 static ssize_t loop_attr_show(struct device *dev, char *page,
723                               ssize_t (*callback)(struct loop_device *, char *))
724 {
725         struct gendisk *disk = dev_to_disk(dev);
726         struct loop_device *lo = disk->private_data;
727
728         return callback(lo, page);
729 }
730
731 #define LOOP_ATTR_RO(_name)                                             \
732 static ssize_t loop_attr_##_name##_show(struct loop_device *, char *);  \
733 static 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 }                                                                       \
738 static struct device_attribute loop_attr_##_name =                      \
739         __ATTR(_name, S_IRUGO, loop_attr_do_show_##_name, NULL);
740
741 static 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
763 static 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
768 static 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
773 static 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
780 LOOP_ATTR_RO(backing_file);
781 LOOP_ATTR_RO(offset);
782 LOOP_ATTR_RO(sizelimit);
783 LOOP_ATTR_RO(autoclear);
784
785 static 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
793 static struct attribute_group loop_attribute_group = {
794         .name = "loop",
795         .attrs= loop_attrs,
796 };
797
798 static 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
804 static 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
810 static int loop_set_fd(struct loop_device *lo, fmode_t mode,
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
838                 if (f->f_mapping->host->i_bdev == bdev)
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)) {
857                 const struct address_space_operations *aops = mapping->a_ops;
858
859                 if (aops->write_begin)
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
864                 lo_blocksize = S_ISBLK(inode->i_mode) ?
865                         inode->i_bdev->bd_block_size : PAGE_SIZE;
866
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
879         if (!(mode & FMODE_WRITE))
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;
888         lo->transfer = transfer_none;
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
894         bio_list_init(&lo->lo_bio_list);
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;
902
903         if (!(lo_flags & LO_FLAGS_READ_ONLY) && file->f_op->fsync)
904                 blk_queue_flush(lo->lo_queue, REQ_FLUSH);
905
906         set_capacity(lo->lo_disk, size);
907         bd_set_size(bdev, size << 9);
908         loop_sysfs_init(lo);
909         /* let user-space know about the new size */
910         kobject_uevent(&disk_to_dev(bdev->bd_disk)->kobj, KOBJ_CHANGE);
911
912         set_blocksize(bdev, lo_blocksize);
913
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);
918                 goto out_clr;
919         }
920         lo->lo_state = Lo_bound;
921         wake_up_process(lo->lo_thread);
922         if (max_part > 0)
923                 ioctl_by_bdev(bdev, BLKRRPART, 0);
924         return 0;
925
926 out_clr:
927         loop_sysfs_exit(lo);
928         lo->lo_thread = NULL;
929         lo->lo_device = NULL;
930         lo->lo_backing_file = NULL;
931         lo->lo_flags = 0;
932         set_capacity(lo->lo_disk, 0);
933         invalidate_bdev(bdev);
934         bd_set_size(bdev, 0);
935         kobject_uevent(&disk_to_dev(bdev->bd_disk)->kobj, KOBJ_CHANGE);
936         mapping_set_gfp_mask(mapping, lo->old_gfp_mask);
937         lo->lo_state = Lo_unbound;
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
946 static int
947 loop_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
962 static int
963 loop_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
983 static int loop_clr_fd(struct loop_device *lo, struct block_device *bdev)
984 {
985         struct file *filp = lo->lo_backing_file;
986         gfp_t gfp = lo->old_gfp_mask;
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;
999         spin_unlock_irq(&lo->lo_lock);
1000
1001         kthread_stop(lo->lo_thread);
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;
1014         lo->lo_thread = NULL;
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);
1018         if (bdev)
1019                 invalidate_bdev(bdev);
1020         set_capacity(lo->lo_disk, 0);
1021         loop_sysfs_exit(lo);
1022         if (bdev) {
1023                 bd_set_size(bdev, 0);
1024                 /* let user-space know about this change */
1025                 kobject_uevent(&disk_to_dev(bdev->bd_disk)->kobj, KOBJ_CHANGE);
1026         }
1027         mapping_set_gfp_mask(filp->f_mapping, gfp);
1028         lo->lo_state = Lo_unbound;
1029         /* This is safe: open() is still holding a reference. */
1030         module_put(THIS_MODULE);
1031         if (max_part > 0 && bdev)
1032                 ioctl_by_bdev(bdev, BLKRRPART, 0);
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);
1041         return 0;
1042 }
1043
1044 static int
1045 loop_set_status(struct loop_device *lo, const struct loop_info64 *info)
1046 {
1047         int err;
1048         struct loop_func_table *xfer;
1049         uid_t uid = current_uid();
1050
1051         if (lo->lo_encrypt_key_size &&
1052             lo->lo_key_owner != uid &&
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
1097         if ((lo->lo_flags & LO_FLAGS_AUTOCLEAR) !=
1098              (info->lo_flags & LO_FLAGS_AUTOCLEAR))
1099                 lo->lo_flags ^= LO_FLAGS_AUTOCLEAR;
1100
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);
1107                 lo->lo_key_owner = uid;
1108         }       
1109
1110         return 0;
1111 }
1112
1113 static int
1114 loop_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;
1122         error = vfs_getattr(file->f_path.mnt, file->f_path.dentry, &stat);
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
1145 static void
1146 loop_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
1167 static int
1168 loop_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
1197 static int
1198 loop_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
1209 static int
1210 loop_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
1219 static int
1220 loop_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
1237 static int
1238 loop_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
1252 static 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);
1270         /* let user-space know about the new size */
1271         kobject_uevent(&disk_to_dev(bdev->bd_disk)->kobj, KOBJ_CHANGE);
1272         mutex_unlock(&bdev->bd_mutex);
1273
1274  out:
1275         return err;
1276 }
1277
1278 static int lo_ioctl(struct block_device *bdev, fmode_t mode,
1279         unsigned int cmd, unsigned long arg)
1280 {
1281         struct loop_device *lo = bdev->bd_disk->private_data;
1282         int err;
1283
1284         mutex_lock_nested(&lo->lo_ctl_mutex, 1);
1285         switch (cmd) {
1286         case LOOP_SET_FD:
1287                 err = loop_set_fd(lo, mode, bdev, arg);
1288                 break;
1289         case LOOP_CHANGE_FD:
1290                 err = loop_change_fd(lo, bdev, arg);
1291                 break;
1292         case LOOP_CLR_FD:
1293                 /* loop_clr_fd would have unlocked lo_ctl_mutex on success */
1294                 err = loop_clr_fd(lo, bdev);
1295                 if (!err)
1296                         goto out_unlocked;
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;
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;
1315         default:
1316                 err = lo->ioctl ? lo->ioctl(lo, cmd, arg) : -EINVAL;
1317         }
1318         mutex_unlock(&lo->lo_ctl_mutex);
1319
1320 out_unlocked:
1321         return err;
1322 }
1323
1324 #ifdef CONFIG_COMPAT
1325 struct 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  */
1344 static noinline int
1345 loop_info64_from_compat(const struct compat_loop_info __user *arg,
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  */
1377 static noinline int
1378 loop_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
1414 static int
1415 loop_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
1427 static int
1428 loop_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
1443 static int lo_compat_ioctl(struct block_device *bdev, fmode_t mode,
1444                            unsigned int cmd, unsigned long arg)
1445 {
1446         struct loop_device *lo = bdev->bd_disk->private_data;
1447         int err;
1448
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;
1462         case LOOP_SET_CAPACITY:
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:
1469                 err = lo_ioctl(bdev, mode, cmd, arg);
1470                 break;
1471         default:
1472                 err = -ENOIOCTLCMD;
1473                 break;
1474         }
1475         return err;
1476 }
1477 #endif
1478
1479 static int lo_open(struct block_device *bdev, fmode_t mode)
1480 {
1481         struct loop_device *lo;
1482         int err = 0;
1483
1484         mutex_lock(&loop_index_mutex);
1485         lo = bdev->bd_disk->private_data;
1486         if (!lo) {
1487                 err = -ENXIO;
1488                 goto out;
1489         }
1490
1491         mutex_lock(&lo->lo_ctl_mutex);
1492         lo->lo_refcnt++;
1493         mutex_unlock(&lo->lo_ctl_mutex);
1494 out:
1495         mutex_unlock(&loop_index_mutex);
1496         return err;
1497 }
1498
1499 static int lo_release(struct gendisk *disk, fmode_t mode)
1500 {
1501         struct loop_device *lo = disk->private_data;
1502         int err;
1503
1504         mutex_lock(&lo->lo_ctl_mutex);
1505
1506         if (--lo->lo_refcnt)
1507                 goto out;
1508
1509         if (lo->lo_flags & LO_FLAGS_AUTOCLEAR) {
1510                 /*
1511                  * In autoclear mode, stop the loop thread
1512                  * and remove configuration after last close.
1513                  */
1514                 err = loop_clr_fd(lo, NULL);
1515                 if (!err)
1516                         goto out_unlocked;
1517         } else {
1518                 /*
1519                  * Otherwise keep thread (if running) and config,
1520                  * but flush possible ongoing bios in thread.
1521                  */
1522                 loop_flush(lo);
1523         }
1524
1525 out:
1526         mutex_unlock(&lo->lo_ctl_mutex);
1527 out_unlocked:
1528         return 0;
1529 }
1530
1531 static const struct block_device_operations lo_fops = {
1532         .owner =        THIS_MODULE,
1533         .open =         lo_open,
1534         .release =      lo_release,
1535         .ioctl =        lo_ioctl,
1536 #ifdef CONFIG_COMPAT
1537         .compat_ioctl = lo_compat_ioctl,
1538 #endif
1539 };
1540
1541 /*
1542  * And now the modules code and kernel interface.
1543  */
1544 static int max_loop;
1545 module_param(max_loop, int, S_IRUGO);
1546 MODULE_PARM_DESC(max_loop, "Maximum number of loop devices");
1547 module_param(max_part, int, S_IRUGO);
1548 MODULE_PARM_DESC(max_part, "Maximum number of partitions per loop device");
1549 MODULE_LICENSE("GPL");
1550 MODULE_ALIAS_BLOCKDEV_MAJOR(LOOP_MAJOR);
1551
1552 int loop_register_transfer(struct loop_func_table *funcs)
1553 {
1554         unsigned int n = funcs->number;
1555
1556         if (n >= MAX_LO_CRYPT || xfer_funcs[n])
1557                 return -EINVAL;
1558         xfer_funcs[n] = funcs;
1559         return 0;
1560 }
1561
1562 static int unregister_transfer_cb(int id, void *ptr, void *data)
1563 {
1564         struct loop_device *lo = ptr;
1565         struct loop_func_table *xfer = data;
1566
1567         mutex_lock(&lo->lo_ctl_mutex);
1568         if (lo->lo_encryption == xfer)
1569                 loop_release_xfer(lo);
1570         mutex_unlock(&lo->lo_ctl_mutex);
1571         return 0;
1572 }
1573
1574 int loop_unregister_transfer(int number)
1575 {
1576         unsigned int n = number;
1577         struct loop_func_table *xfer;
1578
1579         if (n == 0 || n >= MAX_LO_CRYPT || (xfer = xfer_funcs[n]) == NULL)
1580                 return -EINVAL;
1581
1582         xfer_funcs[n] = NULL;
1583         idr_for_each(&loop_index_idr, &unregister_transfer_cb, xfer);
1584         return 0;
1585 }
1586
1587 EXPORT_SYMBOL(loop_register_transfer);
1588 EXPORT_SYMBOL(loop_unregister_transfer);
1589
1590 static int loop_add(struct loop_device **l, int i)
1591 {
1592         struct loop_device *lo;
1593         struct gendisk *disk;
1594         int err;
1595
1596         lo = kzalloc(sizeof(*lo), GFP_KERNEL);
1597         if (!lo) {
1598                 err = -ENOMEM;
1599                 goto out;
1600         }
1601
1602         err = idr_pre_get(&loop_index_idr, GFP_KERNEL);
1603         if (err < 0)
1604                 goto out_free_dev;
1605
1606         if (i >= 0) {
1607                 int m;
1608
1609                 /* create specific i in the index */
1610                 err = idr_get_new_above(&loop_index_idr, lo, i, &m);
1611                 if (err >= 0 && i != m) {
1612                         idr_remove(&loop_index_idr, m);
1613                         err = -EEXIST;
1614                 }
1615         } else if (i == -1) {
1616                 int m;
1617
1618                 /* get next free nr */
1619                 err = idr_get_new(&loop_index_idr, lo, &m);
1620                 if (err >= 0)
1621                         i = m;
1622         } else {
1623                 err = -EINVAL;
1624         }
1625         if (err < 0)
1626                 goto out_free_dev;
1627
1628         lo->lo_queue = blk_alloc_queue(GFP_KERNEL);
1629         if (!lo->lo_queue)
1630                 goto out_free_dev;
1631
1632         disk = lo->lo_disk = alloc_disk(1 << part_shift);
1633         if (!disk)
1634                 goto out_free_queue;
1635
1636         mutex_init(&lo->lo_ctl_mutex);
1637         lo->lo_number           = i;
1638         lo->lo_thread           = NULL;
1639         init_waitqueue_head(&lo->lo_event);
1640         spin_lock_init(&lo->lo_lock);
1641         disk->major             = LOOP_MAJOR;
1642         disk->first_minor       = i << part_shift;
1643         disk->fops              = &lo_fops;
1644         disk->private_data      = lo;
1645         disk->queue             = lo->lo_queue;
1646         sprintf(disk->disk_name, "loop%d", i);
1647         add_disk(disk);
1648         *l = lo;
1649         return lo->lo_number;
1650
1651 out_free_queue:
1652         blk_cleanup_queue(lo->lo_queue);
1653 out_free_dev:
1654         kfree(lo);
1655 out:
1656         return err;
1657 }
1658
1659 static void loop_remove(struct loop_device *lo)
1660 {
1661         del_gendisk(lo->lo_disk);
1662         blk_cleanup_queue(lo->lo_queue);
1663         put_disk(lo->lo_disk);
1664         kfree(lo);
1665 }
1666
1667 static int find_free_cb(int id, void *ptr, void *data)
1668 {
1669         struct loop_device *lo = ptr;
1670         struct loop_device **l = data;
1671
1672         if (lo->lo_state == Lo_unbound) {
1673                 *l = lo;
1674                 return 1;
1675         }
1676         return 0;
1677 }
1678
1679 static int loop_lookup(struct loop_device **l, int i)
1680 {
1681         struct loop_device *lo;
1682         int ret = -ENODEV;
1683
1684         if (i < 0) {
1685                 int err;
1686
1687                 err = idr_for_each(&loop_index_idr, &find_free_cb, &lo);
1688                 if (err == 1) {
1689                         *l = lo;
1690                         ret = lo->lo_number;
1691                 }
1692                 goto out;
1693         }
1694
1695         /* lookup and return a specific i */
1696         lo = idr_find(&loop_index_idr, i);
1697         if (lo) {
1698                 *l = lo;
1699                 ret = lo->lo_number;
1700         }
1701 out:
1702         return ret;
1703 }
1704
1705 static struct kobject *loop_probe(dev_t dev, int *part, void *data)
1706 {
1707         struct loop_device *lo;
1708         struct kobject *kobj;
1709         int err;
1710
1711         mutex_lock(&loop_index_mutex);
1712         err = loop_lookup(&lo, MINOR(dev) >> part_shift);
1713         if (err < 0)
1714                 err = loop_add(&lo, MINOR(dev) >> part_shift);
1715         if (err < 0)
1716                 kobj = ERR_PTR(err);
1717         else
1718                 kobj = get_disk(lo->lo_disk);
1719         mutex_unlock(&loop_index_mutex);
1720
1721         *part = 0;
1722         return kobj;
1723 }
1724
1725 static long loop_control_ioctl(struct file *file, unsigned int cmd,
1726                                unsigned long parm)
1727 {
1728         struct loop_device *lo;
1729         int ret = -ENOSYS;
1730
1731         mutex_lock(&loop_index_mutex);
1732         switch (cmd) {
1733         case LOOP_CTL_ADD:
1734                 ret = loop_lookup(&lo, parm);
1735                 if (ret >= 0) {
1736                         ret = -EEXIST;
1737                         break;
1738                 }
1739                 ret = loop_add(&lo, parm);
1740                 break;
1741         case LOOP_CTL_REMOVE:
1742                 ret = loop_lookup(&lo, parm);
1743                 if (ret < 0)
1744                         break;
1745                 mutex_lock(&lo->lo_ctl_mutex);
1746                 if (lo->lo_state != Lo_unbound) {
1747                         ret = -EBUSY;
1748                         mutex_unlock(&lo->lo_ctl_mutex);
1749                         break;
1750                 }
1751                 if (lo->lo_refcnt > 0) {
1752                         ret = -EBUSY;
1753                         mutex_unlock(&lo->lo_ctl_mutex);
1754                         break;
1755                 }
1756                 lo->lo_disk->private_data = NULL;
1757                 mutex_unlock(&lo->lo_ctl_mutex);
1758                 idr_remove(&loop_index_idr, lo->lo_number);
1759                 loop_remove(lo);
1760                 break;
1761         case LOOP_CTL_GET_FREE:
1762                 ret = loop_lookup(&lo, -1);
1763                 if (ret >= 0)
1764                         break;
1765                 ret = loop_add(&lo, -1);
1766         }
1767         mutex_unlock(&loop_index_mutex);
1768
1769         return ret;
1770 }
1771
1772 static const struct file_operations loop_ctl_fops = {
1773         .open           = nonseekable_open,
1774         .unlocked_ioctl = loop_control_ioctl,
1775         .compat_ioctl   = loop_control_ioctl,
1776         .owner          = THIS_MODULE,
1777         .llseek         = noop_llseek,
1778 };
1779
1780 static struct miscdevice loop_misc = {
1781         .minor          = LOOP_CTRL_MINOR,
1782         .name           = "loop-control",
1783         .fops           = &loop_ctl_fops,
1784 };
1785
1786 MODULE_ALIAS_MISCDEV(LOOP_CTRL_MINOR);
1787 MODULE_ALIAS("devname:loop-control");
1788
1789 static int __init loop_init(void)
1790 {
1791         int i, nr;
1792         unsigned long range;
1793         struct loop_device *lo;
1794         int err;
1795
1796         /*
1797          * loop module now has a feature to instantiate underlying device
1798          * structure on-demand, provided that there is an access dev node.
1799          * However, this will not work well with user space tool that doesn't
1800          * know about such "feature".  In order to not break any existing
1801          * tool, we do the following:
1802          *
1803          * (1) if max_loop is specified, create that many upfront, and this
1804          *     also becomes a hard limit.
1805          * (2) if max_loop is not specified, create 8 loop device on module
1806          *     load, user can further extend loop device by create dev node
1807          *     themselves and have kernel automatically instantiate actual
1808          *     device on-demand.
1809          */
1810
1811         err = misc_register(&loop_misc);
1812         if (err < 0)
1813                 return err;
1814
1815         part_shift = 0;
1816         if (max_part > 0) {
1817                 part_shift = fls(max_part);
1818
1819                 /*
1820                  * Adjust max_part according to part_shift as it is exported
1821                  * to user space so that user can decide correct minor number
1822                  * if [s]he want to create more devices.
1823                  *
1824                  * Note that -1 is required because partition 0 is reserved
1825                  * for the whole disk.
1826                  */
1827                 max_part = (1UL << part_shift) - 1;
1828         }
1829
1830         if ((1UL << part_shift) > DISK_MAX_PARTS)
1831                 return -EINVAL;
1832
1833         if (max_loop > 1UL << (MINORBITS - part_shift))
1834                 return -EINVAL;
1835
1836         if (max_loop) {
1837                 nr = max_loop;
1838                 range = max_loop << part_shift;
1839         } else {
1840                 nr = 8;
1841                 range = 1UL << MINORBITS;
1842         }
1843
1844         if (register_blkdev(LOOP_MAJOR, "loop"))
1845                 return -EIO;
1846
1847         blk_register_region(MKDEV(LOOP_MAJOR, 0), range,
1848                                   THIS_MODULE, loop_probe, NULL, NULL);
1849
1850         /* pre-create number devices of devices given by config or max_loop */
1851         mutex_lock(&loop_index_mutex);
1852         for (i = 0; i < nr; i++)
1853                 loop_add(&lo, i);
1854         mutex_unlock(&loop_index_mutex);
1855
1856         printk(KERN_INFO "loop: module loaded\n");
1857         return 0;
1858 }
1859
1860 static int loop_exit_cb(int id, void *ptr, void *data)
1861 {
1862         struct loop_device *lo = ptr;
1863
1864         loop_remove(lo);
1865         return 0;
1866 }
1867
1868 static void __exit loop_exit(void)
1869 {
1870         unsigned long range;
1871
1872         range = max_loop ? max_loop << part_shift : 1UL << MINORBITS;
1873
1874         idr_for_each(&loop_index_idr, &loop_exit_cb, NULL);
1875         idr_remove_all(&loop_index_idr);
1876         idr_destroy(&loop_index_idr);
1877
1878         blk_unregister_region(MKDEV(LOOP_MAJOR, 0), range);
1879         unregister_blkdev(LOOP_MAJOR, "loop");
1880
1881         misc_deregister(&loop_misc);
1882 }
1883
1884 module_init(loop_init);
1885 module_exit(loop_exit);
1886
1887 #ifndef MODULE
1888 static int __init max_loop_setup(char *str)
1889 {
1890         max_loop = simple_strtol(str, NULL, 0);
1891         return 1;
1892 }
1893
1894 __setup("max_loop=", max_loop_setup);
1895 #endif