]> Pileus Git - ~andy/linux/blob - drivers/block/loop.c
Merge branch 'v3.1-rc10' into for-3.2/core
[~andy/linux] / 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 void 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;
536
537 out:
538         spin_unlock_irq(&lo->lo_lock);
539         bio_io_error(old_bio);
540 }
541
542 struct switch_request {
543         struct file *file;
544         struct completion wait;
545 };
546
547 static void do_loop_switch(struct loop_device *, struct switch_request *);
548
549 static inline void loop_handle_bio(struct loop_device *lo, struct bio *bio)
550 {
551         if (unlikely(!bio->bi_bdev)) {
552                 do_loop_switch(lo, bio->bi_private);
553                 bio_put(bio);
554         } else {
555                 int ret = do_bio_filebacked(lo, bio);
556                 bio_endio(bio, ret);
557         }
558 }
559
560 /*
561  * worker thread that handles reads/writes to file backed loop devices,
562  * to avoid blocking in our make_request_fn. it also does loop decrypting
563  * on reads for block backed loop, as that is too heavy to do from
564  * b_end_io context where irqs may be disabled.
565  *
566  * Loop explanation:  loop_clr_fd() sets lo_state to Lo_rundown before
567  * calling kthread_stop().  Therefore once kthread_should_stop() is
568  * true, make_request will not place any more requests.  Therefore
569  * once kthread_should_stop() is true and lo_bio is NULL, we are
570  * done with the loop.
571  */
572 static int loop_thread(void *data)
573 {
574         struct loop_device *lo = data;
575         struct bio *bio;
576
577         set_user_nice(current, -20);
578
579         while (!kthread_should_stop() || !bio_list_empty(&lo->lo_bio_list)) {
580
581                 wait_event_interruptible(lo->lo_event,
582                                 !bio_list_empty(&lo->lo_bio_list) ||
583                                 kthread_should_stop());
584
585                 if (bio_list_empty(&lo->lo_bio_list))
586                         continue;
587                 spin_lock_irq(&lo->lo_lock);
588                 bio = loop_get_bio(lo);
589                 spin_unlock_irq(&lo->lo_lock);
590
591                 BUG_ON(!bio);
592                 loop_handle_bio(lo, bio);
593         }
594
595         return 0;
596 }
597
598 /*
599  * loop_switch performs the hard work of switching a backing store.
600  * First it needs to flush existing IO, it does this by sending a magic
601  * BIO down the pipe. The completion of this BIO does the actual switch.
602  */
603 static int loop_switch(struct loop_device *lo, struct file *file)
604 {
605         struct switch_request w;
606         struct bio *bio = bio_alloc(GFP_KERNEL, 0);
607         if (!bio)
608                 return -ENOMEM;
609         init_completion(&w.wait);
610         w.file = file;
611         bio->bi_private = &w;
612         bio->bi_bdev = NULL;
613         loop_make_request(lo->lo_queue, bio);
614         wait_for_completion(&w.wait);
615         return 0;
616 }
617
618 /*
619  * Helper to flush the IOs in loop, but keeping loop thread running
620  */
621 static int loop_flush(struct loop_device *lo)
622 {
623         /* loop not yet configured, no running thread, nothing to flush */
624         if (!lo->lo_thread)
625                 return 0;
626
627         return loop_switch(lo, NULL);
628 }
629
630 /*
631  * Do the actual switch; called from the BIO completion routine
632  */
633 static void do_loop_switch(struct loop_device *lo, struct switch_request *p)
634 {
635         struct file *file = p->file;
636         struct file *old_file = lo->lo_backing_file;
637         struct address_space *mapping;
638
639         /* if no new file, only flush of queued bios requested */
640         if (!file)
641                 goto out;
642
643         mapping = file->f_mapping;
644         mapping_set_gfp_mask(old_file->f_mapping, lo->old_gfp_mask);
645         lo->lo_backing_file = file;
646         lo->lo_blocksize = S_ISBLK(mapping->host->i_mode) ?
647                 mapping->host->i_bdev->bd_block_size : PAGE_SIZE;
648         lo->old_gfp_mask = mapping_gfp_mask(mapping);
649         mapping_set_gfp_mask(mapping, lo->old_gfp_mask & ~(__GFP_IO|__GFP_FS));
650 out:
651         complete(&p->wait);
652 }
653
654
655 /*
656  * loop_change_fd switched the backing store of a loopback device to
657  * a new file. This is useful for operating system installers to free up
658  * the original file and in High Availability environments to switch to
659  * an alternative location for the content in case of server meltdown.
660  * This can only work if the loop device is used read-only, and if the
661  * new backing store is the same size and type as the old backing store.
662  */
663 static int loop_change_fd(struct loop_device *lo, struct block_device *bdev,
664                           unsigned int arg)
665 {
666         struct file     *file, *old_file;
667         struct inode    *inode;
668         int             error;
669
670         error = -ENXIO;
671         if (lo->lo_state != Lo_bound)
672                 goto out;
673
674         /* the loop device has to be read-only */
675         error = -EINVAL;
676         if (!(lo->lo_flags & LO_FLAGS_READ_ONLY))
677                 goto out;
678
679         error = -EBADF;
680         file = fget(arg);
681         if (!file)
682                 goto out;
683
684         inode = file->f_mapping->host;
685         old_file = lo->lo_backing_file;
686
687         error = -EINVAL;
688
689         if (!S_ISREG(inode->i_mode) && !S_ISBLK(inode->i_mode))
690                 goto out_putf;
691
692         /* size of the new backing store needs to be the same */
693         if (get_loop_size(lo, file) != get_loop_size(lo, old_file))
694                 goto out_putf;
695
696         /* and ... switch */
697         error = loop_switch(lo, file);
698         if (error)
699                 goto out_putf;
700
701         fput(old_file);
702         if (max_part > 0)
703                 ioctl_by_bdev(bdev, BLKRRPART, 0);
704         return 0;
705
706  out_putf:
707         fput(file);
708  out:
709         return error;
710 }
711
712 static inline int is_loop_device(struct file *file)
713 {
714         struct inode *i = file->f_mapping->host;
715
716         return i && S_ISBLK(i->i_mode) && MAJOR(i->i_rdev) == LOOP_MAJOR;
717 }
718
719 /* loop sysfs attributes */
720
721 static ssize_t loop_attr_show(struct device *dev, char *page,
722                               ssize_t (*callback)(struct loop_device *, char *))
723 {
724         struct gendisk *disk = dev_to_disk(dev);
725         struct loop_device *lo = disk->private_data;
726
727         return callback(lo, page);
728 }
729
730 #define LOOP_ATTR_RO(_name)                                             \
731 static ssize_t loop_attr_##_name##_show(struct loop_device *, char *);  \
732 static ssize_t loop_attr_do_show_##_name(struct device *d,              \
733                                 struct device_attribute *attr, char *b) \
734 {                                                                       \
735         return loop_attr_show(d, b, loop_attr_##_name##_show);          \
736 }                                                                       \
737 static struct device_attribute loop_attr_##_name =                      \
738         __ATTR(_name, S_IRUGO, loop_attr_do_show_##_name, NULL);
739
740 static ssize_t loop_attr_backing_file_show(struct loop_device *lo, char *buf)
741 {
742         ssize_t ret;
743         char *p = NULL;
744
745         spin_lock_irq(&lo->lo_lock);
746         if (lo->lo_backing_file)
747                 p = d_path(&lo->lo_backing_file->f_path, buf, PAGE_SIZE - 1);
748         spin_unlock_irq(&lo->lo_lock);
749
750         if (IS_ERR_OR_NULL(p))
751                 ret = PTR_ERR(p);
752         else {
753                 ret = strlen(p);
754                 memmove(buf, p, ret);
755                 buf[ret++] = '\n';
756                 buf[ret] = 0;
757         }
758
759         return ret;
760 }
761
762 static ssize_t loop_attr_offset_show(struct loop_device *lo, char *buf)
763 {
764         return sprintf(buf, "%llu\n", (unsigned long long)lo->lo_offset);
765 }
766
767 static ssize_t loop_attr_sizelimit_show(struct loop_device *lo, char *buf)
768 {
769         return sprintf(buf, "%llu\n", (unsigned long long)lo->lo_sizelimit);
770 }
771
772 static ssize_t loop_attr_autoclear_show(struct loop_device *lo, char *buf)
773 {
774         int autoclear = (lo->lo_flags & LO_FLAGS_AUTOCLEAR);
775
776         return sprintf(buf, "%s\n", autoclear ? "1" : "0");
777 }
778
779 LOOP_ATTR_RO(backing_file);
780 LOOP_ATTR_RO(offset);
781 LOOP_ATTR_RO(sizelimit);
782 LOOP_ATTR_RO(autoclear);
783
784 static struct attribute *loop_attrs[] = {
785         &loop_attr_backing_file.attr,
786         &loop_attr_offset.attr,
787         &loop_attr_sizelimit.attr,
788         &loop_attr_autoclear.attr,
789         NULL,
790 };
791
792 static struct attribute_group loop_attribute_group = {
793         .name = "loop",
794         .attrs= loop_attrs,
795 };
796
797 static int loop_sysfs_init(struct loop_device *lo)
798 {
799         return sysfs_create_group(&disk_to_dev(lo->lo_disk)->kobj,
800                                   &loop_attribute_group);
801 }
802
803 static void loop_sysfs_exit(struct loop_device *lo)
804 {
805         sysfs_remove_group(&disk_to_dev(lo->lo_disk)->kobj,
806                            &loop_attribute_group);
807 }
808
809 static int loop_set_fd(struct loop_device *lo, fmode_t mode,
810                        struct block_device *bdev, unsigned int arg)
811 {
812         struct file     *file, *f;
813         struct inode    *inode;
814         struct address_space *mapping;
815         unsigned lo_blocksize;
816         int             lo_flags = 0;
817         int             error;
818         loff_t          size;
819
820         /* This is safe, since we have a reference from open(). */
821         __module_get(THIS_MODULE);
822
823         error = -EBADF;
824         file = fget(arg);
825         if (!file)
826                 goto out;
827
828         error = -EBUSY;
829         if (lo->lo_state != Lo_unbound)
830                 goto out_putf;
831
832         /* Avoid recursion */
833         f = file;
834         while (is_loop_device(f)) {
835                 struct loop_device *l;
836
837                 if (f->f_mapping->host->i_bdev == bdev)
838                         goto out_putf;
839
840                 l = f->f_mapping->host->i_bdev->bd_disk->private_data;
841                 if (l->lo_state == Lo_unbound) {
842                         error = -EINVAL;
843                         goto out_putf;
844                 }
845                 f = l->lo_backing_file;
846         }
847
848         mapping = file->f_mapping;
849         inode = mapping->host;
850
851         if (!(file->f_mode & FMODE_WRITE))
852                 lo_flags |= LO_FLAGS_READ_ONLY;
853
854         error = -EINVAL;
855         if (S_ISREG(inode->i_mode) || S_ISBLK(inode->i_mode)) {
856                 const struct address_space_operations *aops = mapping->a_ops;
857
858                 if (aops->write_begin)
859                         lo_flags |= LO_FLAGS_USE_AOPS;
860                 if (!(lo_flags & LO_FLAGS_USE_AOPS) && !file->f_op->write)
861                         lo_flags |= LO_FLAGS_READ_ONLY;
862
863                 lo_blocksize = S_ISBLK(inode->i_mode) ?
864                         inode->i_bdev->bd_block_size : PAGE_SIZE;
865
866                 error = 0;
867         } else {
868                 goto out_putf;
869         }
870
871         size = get_loop_size(lo, file);
872
873         if ((loff_t)(sector_t)size != size) {
874                 error = -EFBIG;
875                 goto out_putf;
876         }
877
878         if (!(mode & FMODE_WRITE))
879                 lo_flags |= LO_FLAGS_READ_ONLY;
880
881         set_device_ro(bdev, (lo_flags & LO_FLAGS_READ_ONLY) != 0);
882
883         lo->lo_blocksize = lo_blocksize;
884         lo->lo_device = bdev;
885         lo->lo_flags = lo_flags;
886         lo->lo_backing_file = file;
887         lo->transfer = transfer_none;
888         lo->ioctl = NULL;
889         lo->lo_sizelimit = 0;
890         lo->old_gfp_mask = mapping_gfp_mask(mapping);
891         mapping_set_gfp_mask(mapping, lo->old_gfp_mask & ~(__GFP_IO|__GFP_FS));
892
893         bio_list_init(&lo->lo_bio_list);
894
895         /*
896          * set queue make_request_fn, and add limits based on lower level
897          * device
898          */
899         blk_queue_make_request(lo->lo_queue, loop_make_request);
900         lo->lo_queue->queuedata = lo;
901
902         if (!(lo_flags & LO_FLAGS_READ_ONLY) && file->f_op->fsync)
903                 blk_queue_flush(lo->lo_queue, REQ_FLUSH);
904
905         set_capacity(lo->lo_disk, size);
906         bd_set_size(bdev, size << 9);
907         loop_sysfs_init(lo);
908         /* let user-space know about the new size */
909         kobject_uevent(&disk_to_dev(bdev->bd_disk)->kobj, KOBJ_CHANGE);
910
911         set_blocksize(bdev, lo_blocksize);
912
913         lo->lo_thread = kthread_create(loop_thread, lo, "loop%d",
914                                                 lo->lo_number);
915         if (IS_ERR(lo->lo_thread)) {
916                 error = PTR_ERR(lo->lo_thread);
917                 goto out_clr;
918         }
919         lo->lo_state = Lo_bound;
920         wake_up_process(lo->lo_thread);
921         if (max_part > 0)
922                 ioctl_by_bdev(bdev, BLKRRPART, 0);
923         return 0;
924
925 out_clr:
926         loop_sysfs_exit(lo);
927         lo->lo_thread = NULL;
928         lo->lo_device = NULL;
929         lo->lo_backing_file = NULL;
930         lo->lo_flags = 0;
931         set_capacity(lo->lo_disk, 0);
932         invalidate_bdev(bdev);
933         bd_set_size(bdev, 0);
934         kobject_uevent(&disk_to_dev(bdev->bd_disk)->kobj, KOBJ_CHANGE);
935         mapping_set_gfp_mask(mapping, lo->old_gfp_mask);
936         lo->lo_state = Lo_unbound;
937  out_putf:
938         fput(file);
939  out:
940         /* This is safe: open() is still holding a reference. */
941         module_put(THIS_MODULE);
942         return error;
943 }
944
945 static int
946 loop_release_xfer(struct loop_device *lo)
947 {
948         int err = 0;
949         struct loop_func_table *xfer = lo->lo_encryption;
950
951         if (xfer) {
952                 if (xfer->release)
953                         err = xfer->release(lo);
954                 lo->transfer = NULL;
955                 lo->lo_encryption = NULL;
956                 module_put(xfer->owner);
957         }
958         return err;
959 }
960
961 static int
962 loop_init_xfer(struct loop_device *lo, struct loop_func_table *xfer,
963                const struct loop_info64 *i)
964 {
965         int err = 0;
966
967         if (xfer) {
968                 struct module *owner = xfer->owner;
969
970                 if (!try_module_get(owner))
971                         return -EINVAL;
972                 if (xfer->init)
973                         err = xfer->init(lo, i);
974                 if (err)
975                         module_put(owner);
976                 else
977                         lo->lo_encryption = xfer;
978         }
979         return err;
980 }
981
982 static int loop_clr_fd(struct loop_device *lo, struct block_device *bdev)
983 {
984         struct file *filp = lo->lo_backing_file;
985         gfp_t gfp = lo->old_gfp_mask;
986
987         if (lo->lo_state != Lo_bound)
988                 return -ENXIO;
989
990         if (lo->lo_refcnt > 1)  /* we needed one fd for the ioctl */
991                 return -EBUSY;
992
993         if (filp == NULL)
994                 return -EINVAL;
995
996         spin_lock_irq(&lo->lo_lock);
997         lo->lo_state = Lo_rundown;
998         spin_unlock_irq(&lo->lo_lock);
999
1000         kthread_stop(lo->lo_thread);
1001
1002         spin_lock_irq(&lo->lo_lock);
1003         lo->lo_backing_file = NULL;
1004         spin_unlock_irq(&lo->lo_lock);
1005
1006         loop_release_xfer(lo);
1007         lo->transfer = NULL;
1008         lo->ioctl = NULL;
1009         lo->lo_device = NULL;
1010         lo->lo_encryption = NULL;
1011         lo->lo_offset = 0;
1012         lo->lo_sizelimit = 0;
1013         lo->lo_encrypt_key_size = 0;
1014         lo->lo_flags = 0;
1015         lo->lo_thread = NULL;
1016         memset(lo->lo_encrypt_key, 0, LO_KEY_SIZE);
1017         memset(lo->lo_crypt_name, 0, LO_NAME_SIZE);
1018         memset(lo->lo_file_name, 0, LO_NAME_SIZE);
1019         if (bdev)
1020                 invalidate_bdev(bdev);
1021         set_capacity(lo->lo_disk, 0);
1022         loop_sysfs_exit(lo);
1023         if (bdev) {
1024                 bd_set_size(bdev, 0);
1025                 /* let user-space know about this change */
1026                 kobject_uevent(&disk_to_dev(bdev->bd_disk)->kobj, KOBJ_CHANGE);
1027         }
1028         mapping_set_gfp_mask(filp->f_mapping, gfp);
1029         lo->lo_state = Lo_unbound;
1030         /* This is safe: open() is still holding a reference. */
1031         module_put(THIS_MODULE);
1032         if (max_part > 0 && bdev)
1033                 ioctl_by_bdev(bdev, BLKRRPART, 0);
1034         mutex_unlock(&lo->lo_ctl_mutex);
1035         /*
1036          * Need not hold lo_ctl_mutex to fput backing file.
1037          * Calling fput holding lo_ctl_mutex triggers a circular
1038          * lock dependency possibility warning as fput can take
1039          * bd_mutex which is usually taken before lo_ctl_mutex.
1040          */
1041         fput(filp);
1042         return 0;
1043 }
1044
1045 static int
1046 loop_set_status(struct loop_device *lo, const struct loop_info64 *info)
1047 {
1048         int err;
1049         struct loop_func_table *xfer;
1050         uid_t uid = current_uid();
1051
1052         if (lo->lo_encrypt_key_size &&
1053             lo->lo_key_owner != uid &&
1054             !capable(CAP_SYS_ADMIN))
1055                 return -EPERM;
1056         if (lo->lo_state != Lo_bound)
1057                 return -ENXIO;
1058         if ((unsigned int) info->lo_encrypt_key_size > LO_KEY_SIZE)
1059                 return -EINVAL;
1060
1061         err = loop_release_xfer(lo);
1062         if (err)
1063                 return err;
1064
1065         if (info->lo_encrypt_type) {
1066                 unsigned int type = info->lo_encrypt_type;
1067
1068                 if (type >= MAX_LO_CRYPT)
1069                         return -EINVAL;
1070                 xfer = xfer_funcs[type];
1071                 if (xfer == NULL)
1072                         return -EINVAL;
1073         } else
1074                 xfer = NULL;
1075
1076         err = loop_init_xfer(lo, xfer, info);
1077         if (err)
1078                 return err;
1079
1080         if (lo->lo_offset != info->lo_offset ||
1081             lo->lo_sizelimit != info->lo_sizelimit) {
1082                 lo->lo_offset = info->lo_offset;
1083                 lo->lo_sizelimit = info->lo_sizelimit;
1084                 if (figure_loop_size(lo))
1085                         return -EFBIG;
1086         }
1087
1088         memcpy(lo->lo_file_name, info->lo_file_name, LO_NAME_SIZE);
1089         memcpy(lo->lo_crypt_name, info->lo_crypt_name, LO_NAME_SIZE);
1090         lo->lo_file_name[LO_NAME_SIZE-1] = 0;
1091         lo->lo_crypt_name[LO_NAME_SIZE-1] = 0;
1092
1093         if (!xfer)
1094                 xfer = &none_funcs;
1095         lo->transfer = xfer->transfer;
1096         lo->ioctl = xfer->ioctl;
1097
1098         if ((lo->lo_flags & LO_FLAGS_AUTOCLEAR) !=
1099              (info->lo_flags & LO_FLAGS_AUTOCLEAR))
1100                 lo->lo_flags ^= LO_FLAGS_AUTOCLEAR;
1101
1102         lo->lo_encrypt_key_size = info->lo_encrypt_key_size;
1103         lo->lo_init[0] = info->lo_init[0];
1104         lo->lo_init[1] = info->lo_init[1];
1105         if (info->lo_encrypt_key_size) {
1106                 memcpy(lo->lo_encrypt_key, info->lo_encrypt_key,
1107                        info->lo_encrypt_key_size);
1108                 lo->lo_key_owner = uid;
1109         }       
1110
1111         return 0;
1112 }
1113
1114 static int
1115 loop_get_status(struct loop_device *lo, struct loop_info64 *info)
1116 {
1117         struct file *file = lo->lo_backing_file;
1118         struct kstat stat;
1119         int error;
1120
1121         if (lo->lo_state != Lo_bound)
1122                 return -ENXIO;
1123         error = vfs_getattr(file->f_path.mnt, file->f_path.dentry, &stat);
1124         if (error)
1125                 return error;
1126         memset(info, 0, sizeof(*info));
1127         info->lo_number = lo->lo_number;
1128         info->lo_device = huge_encode_dev(stat.dev);
1129         info->lo_inode = stat.ino;
1130         info->lo_rdevice = huge_encode_dev(lo->lo_device ? stat.rdev : stat.dev);
1131         info->lo_offset = lo->lo_offset;
1132         info->lo_sizelimit = lo->lo_sizelimit;
1133         info->lo_flags = lo->lo_flags;
1134         memcpy(info->lo_file_name, lo->lo_file_name, LO_NAME_SIZE);
1135         memcpy(info->lo_crypt_name, lo->lo_crypt_name, LO_NAME_SIZE);
1136         info->lo_encrypt_type =
1137                 lo->lo_encryption ? lo->lo_encryption->number : 0;
1138         if (lo->lo_encrypt_key_size && capable(CAP_SYS_ADMIN)) {
1139                 info->lo_encrypt_key_size = lo->lo_encrypt_key_size;
1140                 memcpy(info->lo_encrypt_key, lo->lo_encrypt_key,
1141                        lo->lo_encrypt_key_size);
1142         }
1143         return 0;
1144 }
1145
1146 static void
1147 loop_info64_from_old(const struct loop_info *info, struct loop_info64 *info64)
1148 {
1149         memset(info64, 0, sizeof(*info64));
1150         info64->lo_number = info->lo_number;
1151         info64->lo_device = info->lo_device;
1152         info64->lo_inode = info->lo_inode;
1153         info64->lo_rdevice = info->lo_rdevice;
1154         info64->lo_offset = info->lo_offset;
1155         info64->lo_sizelimit = 0;
1156         info64->lo_encrypt_type = info->lo_encrypt_type;
1157         info64->lo_encrypt_key_size = info->lo_encrypt_key_size;
1158         info64->lo_flags = info->lo_flags;
1159         info64->lo_init[0] = info->lo_init[0];
1160         info64->lo_init[1] = info->lo_init[1];
1161         if (info->lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1162                 memcpy(info64->lo_crypt_name, info->lo_name, LO_NAME_SIZE);
1163         else
1164                 memcpy(info64->lo_file_name, info->lo_name, LO_NAME_SIZE);
1165         memcpy(info64->lo_encrypt_key, info->lo_encrypt_key, LO_KEY_SIZE);
1166 }
1167
1168 static int
1169 loop_info64_to_old(const struct loop_info64 *info64, struct loop_info *info)
1170 {
1171         memset(info, 0, sizeof(*info));
1172         info->lo_number = info64->lo_number;
1173         info->lo_device = info64->lo_device;
1174         info->lo_inode = info64->lo_inode;
1175         info->lo_rdevice = info64->lo_rdevice;
1176         info->lo_offset = info64->lo_offset;
1177         info->lo_encrypt_type = info64->lo_encrypt_type;
1178         info->lo_encrypt_key_size = info64->lo_encrypt_key_size;
1179         info->lo_flags = info64->lo_flags;
1180         info->lo_init[0] = info64->lo_init[0];
1181         info->lo_init[1] = info64->lo_init[1];
1182         if (info->lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1183                 memcpy(info->lo_name, info64->lo_crypt_name, LO_NAME_SIZE);
1184         else
1185                 memcpy(info->lo_name, info64->lo_file_name, LO_NAME_SIZE);
1186         memcpy(info->lo_encrypt_key, info64->lo_encrypt_key, LO_KEY_SIZE);
1187
1188         /* error in case values were truncated */
1189         if (info->lo_device != info64->lo_device ||
1190             info->lo_rdevice != info64->lo_rdevice ||
1191             info->lo_inode != info64->lo_inode ||
1192             info->lo_offset != info64->lo_offset)
1193                 return -EOVERFLOW;
1194
1195         return 0;
1196 }
1197
1198 static int
1199 loop_set_status_old(struct loop_device *lo, const struct loop_info __user *arg)
1200 {
1201         struct loop_info info;
1202         struct loop_info64 info64;
1203
1204         if (copy_from_user(&info, arg, sizeof (struct loop_info)))
1205                 return -EFAULT;
1206         loop_info64_from_old(&info, &info64);
1207         return loop_set_status(lo, &info64);
1208 }
1209
1210 static int
1211 loop_set_status64(struct loop_device *lo, const struct loop_info64 __user *arg)
1212 {
1213         struct loop_info64 info64;
1214
1215         if (copy_from_user(&info64, arg, sizeof (struct loop_info64)))
1216                 return -EFAULT;
1217         return loop_set_status(lo, &info64);
1218 }
1219
1220 static int
1221 loop_get_status_old(struct loop_device *lo, struct loop_info __user *arg) {
1222         struct loop_info info;
1223         struct loop_info64 info64;
1224         int err = 0;
1225
1226         if (!arg)
1227                 err = -EINVAL;
1228         if (!err)
1229                 err = loop_get_status(lo, &info64);
1230         if (!err)
1231                 err = loop_info64_to_old(&info64, &info);
1232         if (!err && copy_to_user(arg, &info, sizeof(info)))
1233                 err = -EFAULT;
1234
1235         return err;
1236 }
1237
1238 static int
1239 loop_get_status64(struct loop_device *lo, struct loop_info64 __user *arg) {
1240         struct loop_info64 info64;
1241         int err = 0;
1242
1243         if (!arg)
1244                 err = -EINVAL;
1245         if (!err)
1246                 err = loop_get_status(lo, &info64);
1247         if (!err && copy_to_user(arg, &info64, sizeof(info64)))
1248                 err = -EFAULT;
1249
1250         return err;
1251 }
1252
1253 static int loop_set_capacity(struct loop_device *lo, struct block_device *bdev)
1254 {
1255         int err;
1256         sector_t sec;
1257         loff_t sz;
1258
1259         err = -ENXIO;
1260         if (unlikely(lo->lo_state != Lo_bound))
1261                 goto out;
1262         err = figure_loop_size(lo);
1263         if (unlikely(err))
1264                 goto out;
1265         sec = get_capacity(lo->lo_disk);
1266         /* the width of sector_t may be narrow for bit-shift */
1267         sz = sec;
1268         sz <<= 9;
1269         mutex_lock(&bdev->bd_mutex);
1270         bd_set_size(bdev, sz);
1271         /* let user-space know about the new size */
1272         kobject_uevent(&disk_to_dev(bdev->bd_disk)->kobj, KOBJ_CHANGE);
1273         mutex_unlock(&bdev->bd_mutex);
1274
1275  out:
1276         return err;
1277 }
1278
1279 static int lo_ioctl(struct block_device *bdev, fmode_t mode,
1280         unsigned int cmd, unsigned long arg)
1281 {
1282         struct loop_device *lo = bdev->bd_disk->private_data;
1283         int err;
1284
1285         mutex_lock_nested(&lo->lo_ctl_mutex, 1);
1286         switch (cmd) {
1287         case LOOP_SET_FD:
1288                 err = loop_set_fd(lo, mode, bdev, arg);
1289                 break;
1290         case LOOP_CHANGE_FD:
1291                 err = loop_change_fd(lo, bdev, arg);
1292                 break;
1293         case LOOP_CLR_FD:
1294                 /* loop_clr_fd would have unlocked lo_ctl_mutex on success */
1295                 err = loop_clr_fd(lo, bdev);
1296                 if (!err)
1297                         goto out_unlocked;
1298                 break;
1299         case LOOP_SET_STATUS:
1300                 err = loop_set_status_old(lo, (struct loop_info __user *) arg);
1301                 break;
1302         case LOOP_GET_STATUS:
1303                 err = loop_get_status_old(lo, (struct loop_info __user *) arg);
1304                 break;
1305         case LOOP_SET_STATUS64:
1306                 err = loop_set_status64(lo, (struct loop_info64 __user *) arg);
1307                 break;
1308         case LOOP_GET_STATUS64:
1309                 err = loop_get_status64(lo, (struct loop_info64 __user *) arg);
1310                 break;
1311         case LOOP_SET_CAPACITY:
1312                 err = -EPERM;
1313                 if ((mode & FMODE_WRITE) || capable(CAP_SYS_ADMIN))
1314                         err = loop_set_capacity(lo, bdev);
1315                 break;
1316         default:
1317                 err = lo->ioctl ? lo->ioctl(lo, cmd, arg) : -EINVAL;
1318         }
1319         mutex_unlock(&lo->lo_ctl_mutex);
1320
1321 out_unlocked:
1322         return err;
1323 }
1324
1325 #ifdef CONFIG_COMPAT
1326 struct compat_loop_info {
1327         compat_int_t    lo_number;      /* ioctl r/o */
1328         compat_dev_t    lo_device;      /* ioctl r/o */
1329         compat_ulong_t  lo_inode;       /* ioctl r/o */
1330         compat_dev_t    lo_rdevice;     /* ioctl r/o */
1331         compat_int_t    lo_offset;
1332         compat_int_t    lo_encrypt_type;
1333         compat_int_t    lo_encrypt_key_size;    /* ioctl w/o */
1334         compat_int_t    lo_flags;       /* ioctl r/o */
1335         char            lo_name[LO_NAME_SIZE];
1336         unsigned char   lo_encrypt_key[LO_KEY_SIZE]; /* ioctl w/o */
1337         compat_ulong_t  lo_init[2];
1338         char            reserved[4];
1339 };
1340
1341 /*
1342  * Transfer 32-bit compatibility structure in userspace to 64-bit loop info
1343  * - noinlined to reduce stack space usage in main part of driver
1344  */
1345 static noinline int
1346 loop_info64_from_compat(const struct compat_loop_info __user *arg,
1347                         struct loop_info64 *info64)
1348 {
1349         struct compat_loop_info info;
1350
1351         if (copy_from_user(&info, arg, sizeof(info)))
1352                 return -EFAULT;
1353
1354         memset(info64, 0, sizeof(*info64));
1355         info64->lo_number = info.lo_number;
1356         info64->lo_device = info.lo_device;
1357         info64->lo_inode = info.lo_inode;
1358         info64->lo_rdevice = info.lo_rdevice;
1359         info64->lo_offset = info.lo_offset;
1360         info64->lo_sizelimit = 0;
1361         info64->lo_encrypt_type = info.lo_encrypt_type;
1362         info64->lo_encrypt_key_size = info.lo_encrypt_key_size;
1363         info64->lo_flags = info.lo_flags;
1364         info64->lo_init[0] = info.lo_init[0];
1365         info64->lo_init[1] = info.lo_init[1];
1366         if (info.lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1367                 memcpy(info64->lo_crypt_name, info.lo_name, LO_NAME_SIZE);
1368         else
1369                 memcpy(info64->lo_file_name, info.lo_name, LO_NAME_SIZE);
1370         memcpy(info64->lo_encrypt_key, info.lo_encrypt_key, LO_KEY_SIZE);
1371         return 0;
1372 }
1373
1374 /*
1375  * Transfer 64-bit loop info to 32-bit compatibility structure in userspace
1376  * - noinlined to reduce stack space usage in main part of driver
1377  */
1378 static noinline int
1379 loop_info64_to_compat(const struct loop_info64 *info64,
1380                       struct compat_loop_info __user *arg)
1381 {
1382         struct compat_loop_info info;
1383
1384         memset(&info, 0, sizeof(info));
1385         info.lo_number = info64->lo_number;
1386         info.lo_device = info64->lo_device;
1387         info.lo_inode = info64->lo_inode;
1388         info.lo_rdevice = info64->lo_rdevice;
1389         info.lo_offset = info64->lo_offset;
1390         info.lo_encrypt_type = info64->lo_encrypt_type;
1391         info.lo_encrypt_key_size = info64->lo_encrypt_key_size;
1392         info.lo_flags = info64->lo_flags;
1393         info.lo_init[0] = info64->lo_init[0];
1394         info.lo_init[1] = info64->lo_init[1];
1395         if (info.lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1396                 memcpy(info.lo_name, info64->lo_crypt_name, LO_NAME_SIZE);
1397         else
1398                 memcpy(info.lo_name, info64->lo_file_name, LO_NAME_SIZE);
1399         memcpy(info.lo_encrypt_key, info64->lo_encrypt_key, LO_KEY_SIZE);
1400
1401         /* error in case values were truncated */
1402         if (info.lo_device != info64->lo_device ||
1403             info.lo_rdevice != info64->lo_rdevice ||
1404             info.lo_inode != info64->lo_inode ||
1405             info.lo_offset != info64->lo_offset ||
1406             info.lo_init[0] != info64->lo_init[0] ||
1407             info.lo_init[1] != info64->lo_init[1])
1408                 return -EOVERFLOW;
1409
1410         if (copy_to_user(arg, &info, sizeof(info)))
1411                 return -EFAULT;
1412         return 0;
1413 }
1414
1415 static int
1416 loop_set_status_compat(struct loop_device *lo,
1417                        const struct compat_loop_info __user *arg)
1418 {
1419         struct loop_info64 info64;
1420         int ret;
1421
1422         ret = loop_info64_from_compat(arg, &info64);
1423         if (ret < 0)
1424                 return ret;
1425         return loop_set_status(lo, &info64);
1426 }
1427
1428 static int
1429 loop_get_status_compat(struct loop_device *lo,
1430                        struct compat_loop_info __user *arg)
1431 {
1432         struct loop_info64 info64;
1433         int err = 0;
1434
1435         if (!arg)
1436                 err = -EINVAL;
1437         if (!err)
1438                 err = loop_get_status(lo, &info64);
1439         if (!err)
1440                 err = loop_info64_to_compat(&info64, arg);
1441         return err;
1442 }
1443
1444 static int lo_compat_ioctl(struct block_device *bdev, fmode_t mode,
1445                            unsigned int cmd, unsigned long arg)
1446 {
1447         struct loop_device *lo = bdev->bd_disk->private_data;
1448         int err;
1449
1450         switch(cmd) {
1451         case LOOP_SET_STATUS:
1452                 mutex_lock(&lo->lo_ctl_mutex);
1453                 err = loop_set_status_compat(
1454                         lo, (const struct compat_loop_info __user *) arg);
1455                 mutex_unlock(&lo->lo_ctl_mutex);
1456                 break;
1457         case LOOP_GET_STATUS:
1458                 mutex_lock(&lo->lo_ctl_mutex);
1459                 err = loop_get_status_compat(
1460                         lo, (struct compat_loop_info __user *) arg);
1461                 mutex_unlock(&lo->lo_ctl_mutex);
1462                 break;
1463         case LOOP_SET_CAPACITY:
1464         case LOOP_CLR_FD:
1465         case LOOP_GET_STATUS64:
1466         case LOOP_SET_STATUS64:
1467                 arg = (unsigned long) compat_ptr(arg);
1468         case LOOP_SET_FD:
1469         case LOOP_CHANGE_FD:
1470                 err = lo_ioctl(bdev, mode, cmd, arg);
1471                 break;
1472         default:
1473                 err = -ENOIOCTLCMD;
1474                 break;
1475         }
1476         return err;
1477 }
1478 #endif
1479
1480 static int lo_open(struct block_device *bdev, fmode_t mode)
1481 {
1482         struct loop_device *lo;
1483         int err = 0;
1484
1485         mutex_lock(&loop_index_mutex);
1486         lo = bdev->bd_disk->private_data;
1487         if (!lo) {
1488                 err = -ENXIO;
1489                 goto out;
1490         }
1491
1492         mutex_lock(&lo->lo_ctl_mutex);
1493         lo->lo_refcnt++;
1494         mutex_unlock(&lo->lo_ctl_mutex);
1495 out:
1496         mutex_unlock(&loop_index_mutex);
1497         return err;
1498 }
1499
1500 static int lo_release(struct gendisk *disk, fmode_t mode)
1501 {
1502         struct loop_device *lo = disk->private_data;
1503         int err;
1504
1505         mutex_lock(&lo->lo_ctl_mutex);
1506
1507         if (--lo->lo_refcnt)
1508                 goto out;
1509
1510         if (lo->lo_flags & LO_FLAGS_AUTOCLEAR) {
1511                 /*
1512                  * In autoclear mode, stop the loop thread
1513                  * and remove configuration after last close.
1514                  */
1515                 err = loop_clr_fd(lo, NULL);
1516                 if (!err)
1517                         goto out_unlocked;
1518         } else {
1519                 /*
1520                  * Otherwise keep thread (if running) and config,
1521                  * but flush possible ongoing bios in thread.
1522                  */
1523                 loop_flush(lo);
1524         }
1525
1526 out:
1527         mutex_unlock(&lo->lo_ctl_mutex);
1528 out_unlocked:
1529         return 0;
1530 }
1531
1532 static const struct block_device_operations lo_fops = {
1533         .owner =        THIS_MODULE,
1534         .open =         lo_open,
1535         .release =      lo_release,
1536         .ioctl =        lo_ioctl,
1537 #ifdef CONFIG_COMPAT
1538         .compat_ioctl = lo_compat_ioctl,
1539 #endif
1540 };
1541
1542 /*
1543  * And now the modules code and kernel interface.
1544  */
1545 static int max_loop;
1546 module_param(max_loop, int, S_IRUGO);
1547 MODULE_PARM_DESC(max_loop, "Maximum number of loop devices");
1548 module_param(max_part, int, S_IRUGO);
1549 MODULE_PARM_DESC(max_part, "Maximum number of partitions per loop device");
1550 MODULE_LICENSE("GPL");
1551 MODULE_ALIAS_BLOCKDEV_MAJOR(LOOP_MAJOR);
1552
1553 int loop_register_transfer(struct loop_func_table *funcs)
1554 {
1555         unsigned int n = funcs->number;
1556
1557         if (n >= MAX_LO_CRYPT || xfer_funcs[n])
1558                 return -EINVAL;
1559         xfer_funcs[n] = funcs;
1560         return 0;
1561 }
1562
1563 static int unregister_transfer_cb(int id, void *ptr, void *data)
1564 {
1565         struct loop_device *lo = ptr;
1566         struct loop_func_table *xfer = data;
1567
1568         mutex_lock(&lo->lo_ctl_mutex);
1569         if (lo->lo_encryption == xfer)
1570                 loop_release_xfer(lo);
1571         mutex_unlock(&lo->lo_ctl_mutex);
1572         return 0;
1573 }
1574
1575 int loop_unregister_transfer(int number)
1576 {
1577         unsigned int n = number;
1578         struct loop_func_table *xfer;
1579
1580         if (n == 0 || n >= MAX_LO_CRYPT || (xfer = xfer_funcs[n]) == NULL)
1581                 return -EINVAL;
1582
1583         xfer_funcs[n] = NULL;
1584         idr_for_each(&loop_index_idr, &unregister_transfer_cb, xfer);
1585         return 0;
1586 }
1587
1588 EXPORT_SYMBOL(loop_register_transfer);
1589 EXPORT_SYMBOL(loop_unregister_transfer);
1590
1591 static int loop_add(struct loop_device **l, int i)
1592 {
1593         struct loop_device *lo;
1594         struct gendisk *disk;
1595         int err;
1596
1597         lo = kzalloc(sizeof(*lo), GFP_KERNEL);
1598         if (!lo) {
1599                 err = -ENOMEM;
1600                 goto out;
1601         }
1602
1603         err = idr_pre_get(&loop_index_idr, GFP_KERNEL);
1604         if (err < 0)
1605                 goto out_free_dev;
1606
1607         if (i >= 0) {
1608                 int m;
1609
1610                 /* create specific i in the index */
1611                 err = idr_get_new_above(&loop_index_idr, lo, i, &m);
1612                 if (err >= 0 && i != m) {
1613                         idr_remove(&loop_index_idr, m);
1614                         err = -EEXIST;
1615                 }
1616         } else if (i == -1) {
1617                 int m;
1618
1619                 /* get next free nr */
1620                 err = idr_get_new(&loop_index_idr, lo, &m);
1621                 if (err >= 0)
1622                         i = m;
1623         } else {
1624                 err = -EINVAL;
1625         }
1626         if (err < 0)
1627                 goto out_free_dev;
1628
1629         lo->lo_queue = blk_alloc_queue(GFP_KERNEL);
1630         if (!lo->lo_queue)
1631                 goto out_free_dev;
1632
1633         disk = lo->lo_disk = alloc_disk(1 << part_shift);
1634         if (!disk)
1635                 goto out_free_queue;
1636
1637         mutex_init(&lo->lo_ctl_mutex);
1638         lo->lo_number           = i;
1639         lo->lo_thread           = NULL;
1640         init_waitqueue_head(&lo->lo_event);
1641         spin_lock_init(&lo->lo_lock);
1642         disk->major             = LOOP_MAJOR;
1643         disk->first_minor       = i << part_shift;
1644         disk->fops              = &lo_fops;
1645         disk->private_data      = lo;
1646         disk->queue             = lo->lo_queue;
1647         sprintf(disk->disk_name, "loop%d", i);
1648         add_disk(disk);
1649         *l = lo;
1650         return lo->lo_number;
1651
1652 out_free_queue:
1653         blk_cleanup_queue(lo->lo_queue);
1654 out_free_dev:
1655         kfree(lo);
1656 out:
1657         return err;
1658 }
1659
1660 static void loop_remove(struct loop_device *lo)
1661 {
1662         del_gendisk(lo->lo_disk);
1663         blk_cleanup_queue(lo->lo_queue);
1664         put_disk(lo->lo_disk);
1665         kfree(lo);
1666 }
1667
1668 static int find_free_cb(int id, void *ptr, void *data)
1669 {
1670         struct loop_device *lo = ptr;
1671         struct loop_device **l = data;
1672
1673         if (lo->lo_state == Lo_unbound) {
1674                 *l = lo;
1675                 return 1;
1676         }
1677         return 0;
1678 }
1679
1680 static int loop_lookup(struct loop_device **l, int i)
1681 {
1682         struct loop_device *lo;
1683         int ret = -ENODEV;
1684
1685         if (i < 0) {
1686                 int err;
1687
1688                 err = idr_for_each(&loop_index_idr, &find_free_cb, &lo);
1689                 if (err == 1) {
1690                         *l = lo;
1691                         ret = lo->lo_number;
1692                 }
1693                 goto out;
1694         }
1695
1696         /* lookup and return a specific i */
1697         lo = idr_find(&loop_index_idr, i);
1698         if (lo) {
1699                 *l = lo;
1700                 ret = lo->lo_number;
1701         }
1702 out:
1703         return ret;
1704 }
1705
1706 static struct kobject *loop_probe(dev_t dev, int *part, void *data)
1707 {
1708         struct loop_device *lo;
1709         struct kobject *kobj;
1710         int err;
1711
1712         mutex_lock(&loop_index_mutex);
1713         err = loop_lookup(&lo, MINOR(dev) >> part_shift);
1714         if (err < 0)
1715                 err = loop_add(&lo, MINOR(dev) >> part_shift);
1716         if (err < 0)
1717                 kobj = ERR_PTR(err);
1718         else
1719                 kobj = get_disk(lo->lo_disk);
1720         mutex_unlock(&loop_index_mutex);
1721
1722         *part = 0;
1723         return kobj;
1724 }
1725
1726 static long loop_control_ioctl(struct file *file, unsigned int cmd,
1727                                unsigned long parm)
1728 {
1729         struct loop_device *lo;
1730         int ret = -ENOSYS;
1731
1732         mutex_lock(&loop_index_mutex);
1733         switch (cmd) {
1734         case LOOP_CTL_ADD:
1735                 ret = loop_lookup(&lo, parm);
1736                 if (ret >= 0) {
1737                         ret = -EEXIST;
1738                         break;
1739                 }
1740                 ret = loop_add(&lo, parm);
1741                 break;
1742         case LOOP_CTL_REMOVE:
1743                 ret = loop_lookup(&lo, parm);
1744                 if (ret < 0)
1745                         break;
1746                 mutex_lock(&lo->lo_ctl_mutex);
1747                 if (lo->lo_state != Lo_unbound) {
1748                         ret = -EBUSY;
1749                         mutex_unlock(&lo->lo_ctl_mutex);
1750                         break;
1751                 }
1752                 if (lo->lo_refcnt > 0) {
1753                         ret = -EBUSY;
1754                         mutex_unlock(&lo->lo_ctl_mutex);
1755                         break;
1756                 }
1757                 lo->lo_disk->private_data = NULL;
1758                 mutex_unlock(&lo->lo_ctl_mutex);
1759                 idr_remove(&loop_index_idr, lo->lo_number);
1760                 loop_remove(lo);
1761                 break;
1762         case LOOP_CTL_GET_FREE:
1763                 ret = loop_lookup(&lo, -1);
1764                 if (ret >= 0)
1765                         break;
1766                 ret = loop_add(&lo, -1);
1767         }
1768         mutex_unlock(&loop_index_mutex);
1769
1770         return ret;
1771 }
1772
1773 static const struct file_operations loop_ctl_fops = {
1774         .open           = nonseekable_open,
1775         .unlocked_ioctl = loop_control_ioctl,
1776         .compat_ioctl   = loop_control_ioctl,
1777         .owner          = THIS_MODULE,
1778         .llseek         = noop_llseek,
1779 };
1780
1781 static struct miscdevice loop_misc = {
1782         .minor          = LOOP_CTRL_MINOR,
1783         .name           = "loop-control",
1784         .fops           = &loop_ctl_fops,
1785 };
1786
1787 MODULE_ALIAS_MISCDEV(LOOP_CTRL_MINOR);
1788 MODULE_ALIAS("devname:loop-control");
1789
1790 static int __init loop_init(void)
1791 {
1792         int i, nr;
1793         unsigned long range;
1794         struct loop_device *lo;
1795         int err;
1796
1797         err = misc_register(&loop_misc);
1798         if (err < 0)
1799                 return err;
1800
1801         part_shift = 0;
1802         if (max_part > 0) {
1803                 part_shift = fls(max_part);
1804
1805                 /*
1806                  * Adjust max_part according to part_shift as it is exported
1807                  * to user space so that user can decide correct minor number
1808                  * if [s]he want to create more devices.
1809                  *
1810                  * Note that -1 is required because partition 0 is reserved
1811                  * for the whole disk.
1812                  */
1813                 max_part = (1UL << part_shift) - 1;
1814         }
1815
1816         if ((1UL << part_shift) > DISK_MAX_PARTS)
1817                 return -EINVAL;
1818
1819         if (max_loop > 1UL << (MINORBITS - part_shift))
1820                 return -EINVAL;
1821
1822         /*
1823          * If max_loop is specified, create that many devices upfront.
1824          * This also becomes a hard limit. If max_loop is not specified,
1825          * create CONFIG_BLK_DEV_LOOP_MIN_COUNT loop devices at module
1826          * init time. Loop devices can be requested on-demand with the
1827          * /dev/loop-control interface, or be instantiated by accessing
1828          * a 'dead' device node.
1829          */
1830         if (max_loop) {
1831                 nr = max_loop;
1832                 range = max_loop << part_shift;
1833         } else {
1834                 nr = CONFIG_BLK_DEV_LOOP_MIN_COUNT;
1835                 range = 1UL << MINORBITS;
1836         }
1837
1838         if (register_blkdev(LOOP_MAJOR, "loop"))
1839                 return -EIO;
1840
1841         blk_register_region(MKDEV(LOOP_MAJOR, 0), range,
1842                                   THIS_MODULE, loop_probe, NULL, NULL);
1843
1844         /* pre-create number of devices given by config or max_loop */
1845         mutex_lock(&loop_index_mutex);
1846         for (i = 0; i < nr; i++)
1847                 loop_add(&lo, i);
1848         mutex_unlock(&loop_index_mutex);
1849
1850         printk(KERN_INFO "loop: module loaded\n");
1851         return 0;
1852 }
1853
1854 static int loop_exit_cb(int id, void *ptr, void *data)
1855 {
1856         struct loop_device *lo = ptr;
1857
1858         loop_remove(lo);
1859         return 0;
1860 }
1861
1862 static void __exit loop_exit(void)
1863 {
1864         unsigned long range;
1865
1866         range = max_loop ? max_loop << part_shift : 1UL << MINORBITS;
1867
1868         idr_for_each(&loop_index_idr, &loop_exit_cb, NULL);
1869         idr_remove_all(&loop_index_idr);
1870         idr_destroy(&loop_index_idr);
1871
1872         blk_unregister_region(MKDEV(LOOP_MAJOR, 0), range);
1873         unregister_blkdev(LOOP_MAJOR, "loop");
1874
1875         misc_deregister(&loop_misc);
1876 }
1877
1878 module_init(loop_init);
1879 module_exit(loop_exit);
1880
1881 #ifndef MODULE
1882 static int __init max_loop_setup(char *str)
1883 {
1884         max_loop = simple_strtol(str, NULL, 0);
1885         return 1;
1886 }
1887
1888 __setup("max_loop=", max_loop_setup);
1889 #endif