Merge branch 'master' of git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux-2.6
[linux-2.6] / 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 prepare_write and/or commit_write are not available on the
44  * backing filesystem.
45  * Anton Altaparmakov, 16 Feb 2005
46  *
47  * Still To Fix:
48  * - Advisory locking is ignored here.
49  * - Should use an own CAP_* category instead of CAP_SYS_ADMIN
50  *
51  */
52
53 #include <linux/config.h>
54 #include <linux/module.h>
55 #include <linux/moduleparam.h>
56 #include <linux/sched.h>
57 #include <linux/fs.h>
58 #include <linux/file.h>
59 #include <linux/stat.h>
60 #include <linux/errno.h>
61 #include <linux/major.h>
62 #include <linux/wait.h>
63 #include <linux/blkdev.h>
64 #include <linux/blkpg.h>
65 #include <linux/init.h>
66 #include <linux/devfs_fs_kernel.h>
67 #include <linux/smp_lock.h>
68 #include <linux/swap.h>
69 #include <linux/slab.h>
70 #include <linux/loop.h>
71 #include <linux/suspend.h>
72 #include <linux/writeback.h>
73 #include <linux/buffer_head.h>          /* for invalidate_bdev() */
74 #include <linux/completion.h>
75 #include <linux/highmem.h>
76 #include <linux/gfp.h>
77 #include <linux/kthread.h>
78
79 #include <asm/uaccess.h>
80
81 static int max_loop = 8;
82 static struct loop_device *loop_dev;
83 static struct gendisk **disks;
84
85 /*
86  * Transfer functions
87  */
88 static int transfer_none(struct loop_device *lo, int cmd,
89                          struct page *raw_page, unsigned raw_off,
90                          struct page *loop_page, unsigned loop_off,
91                          int size, sector_t real_block)
92 {
93         char *raw_buf = kmap_atomic(raw_page, KM_USER0) + raw_off;
94         char *loop_buf = kmap_atomic(loop_page, KM_USER1) + loop_off;
95
96         if (cmd == READ)
97                 memcpy(loop_buf, raw_buf, size);
98         else
99                 memcpy(raw_buf, loop_buf, size);
100
101         kunmap_atomic(raw_buf, KM_USER0);
102         kunmap_atomic(loop_buf, KM_USER1);
103         cond_resched();
104         return 0;
105 }
106
107 static int transfer_xor(struct loop_device *lo, int cmd,
108                         struct page *raw_page, unsigned raw_off,
109                         struct page *loop_page, unsigned loop_off,
110                         int size, sector_t real_block)
111 {
112         char *raw_buf = kmap_atomic(raw_page, KM_USER0) + raw_off;
113         char *loop_buf = kmap_atomic(loop_page, KM_USER1) + loop_off;
114         char *in, *out, *key;
115         int i, keysize;
116
117         if (cmd == READ) {
118                 in = raw_buf;
119                 out = loop_buf;
120         } else {
121                 in = loop_buf;
122                 out = raw_buf;
123         }
124
125         key = lo->lo_encrypt_key;
126         keysize = lo->lo_encrypt_key_size;
127         for (i = 0; i < size; i++)
128                 *out++ = *in++ ^ key[(i & 511) % keysize];
129
130         kunmap_atomic(raw_buf, KM_USER0);
131         kunmap_atomic(loop_buf, KM_USER1);
132         cond_resched();
133         return 0;
134 }
135
136 static int xor_init(struct loop_device *lo, const struct loop_info64 *info)
137 {
138         if (unlikely(info->lo_encrypt_key_size <= 0))
139                 return -EINVAL;
140         return 0;
141 }
142
143 static struct loop_func_table none_funcs = {
144         .number = LO_CRYPT_NONE,
145         .transfer = transfer_none,
146 };      
147
148 static struct loop_func_table xor_funcs = {
149         .number = LO_CRYPT_XOR,
150         .transfer = transfer_xor,
151         .init = xor_init
152 };      
153
154 /* xfer_funcs[0] is special - its release function is never called */
155 static struct loop_func_table *xfer_funcs[MAX_LO_CRYPT] = {
156         &none_funcs,
157         &xor_funcs
158 };
159
160 static loff_t get_loop_size(struct loop_device *lo, struct file *file)
161 {
162         loff_t size, offset, loopsize;
163
164         /* Compute loopsize in bytes */
165         size = i_size_read(file->f_mapping->host);
166         offset = lo->lo_offset;
167         loopsize = size - offset;
168         if (lo->lo_sizelimit > 0 && lo->lo_sizelimit < loopsize)
169                 loopsize = lo->lo_sizelimit;
170
171         /*
172          * Unfortunately, if we want to do I/O on the device,
173          * the number of 512-byte sectors has to fit into a sector_t.
174          */
175         return loopsize >> 9;
176 }
177
178 static int
179 figure_loop_size(struct loop_device *lo)
180 {
181         loff_t size = get_loop_size(lo, lo->lo_backing_file);
182         sector_t x = (sector_t)size;
183
184         if (unlikely((loff_t)x != size))
185                 return -EFBIG;
186
187         set_capacity(disks[lo->lo_number], x);
188         return 0;                                       
189 }
190
191 static inline int
192 lo_do_transfer(struct loop_device *lo, int cmd,
193                struct page *rpage, unsigned roffs,
194                struct page *lpage, unsigned loffs,
195                int size, sector_t rblock)
196 {
197         if (unlikely(!lo->transfer))
198                 return 0;
199
200         return lo->transfer(lo, cmd, rpage, roffs, lpage, loffs, size, rblock);
201 }
202
203 /**
204  * do_lo_send_aops - helper for writing data to a loop device
205  *
206  * This is the fast version for backing filesystems which implement the address
207  * space operations prepare_write and commit_write.
208  */
209 static int do_lo_send_aops(struct loop_device *lo, struct bio_vec *bvec,
210                 int bsize, loff_t pos, struct page *page)
211 {
212         struct file *file = lo->lo_backing_file; /* kudos to NFsckingS */
213         struct address_space *mapping = file->f_mapping;
214         struct address_space_operations *aops = mapping->a_ops;
215         pgoff_t index;
216         unsigned offset, bv_offs;
217         int len, ret;
218
219         mutex_lock(&mapping->host->i_mutex);
220         index = pos >> PAGE_CACHE_SHIFT;
221         offset = pos & ((pgoff_t)PAGE_CACHE_SIZE - 1);
222         bv_offs = bvec->bv_offset;
223         len = bvec->bv_len;
224         while (len > 0) {
225                 sector_t IV;
226                 unsigned size;
227                 int transfer_result;
228
229                 IV = ((sector_t)index << (PAGE_CACHE_SHIFT - 9))+(offset >> 9);
230                 size = PAGE_CACHE_SIZE - offset;
231                 if (size > len)
232                         size = len;
233                 page = grab_cache_page(mapping, index);
234                 if (unlikely(!page))
235                         goto fail;
236                 ret = aops->prepare_write(file, page, offset,
237                                           offset + size);
238                 if (unlikely(ret)) {
239                         if (ret == AOP_TRUNCATED_PAGE) {
240                                 page_cache_release(page);
241                                 continue;
242                         }
243                         goto unlock;
244                 }
245                 transfer_result = lo_do_transfer(lo, WRITE, page, offset,
246                                 bvec->bv_page, bv_offs, size, IV);
247                 if (unlikely(transfer_result)) {
248                         char *kaddr;
249
250                         /*
251                          * The transfer failed, but we still write the data to
252                          * keep prepare/commit calls balanced.
253                          */
254                         printk(KERN_ERR "loop: transfer error block %llu\n",
255                                (unsigned long long)index);
256                         kaddr = kmap_atomic(page, KM_USER0);
257                         memset(kaddr + offset, 0, size);
258                         kunmap_atomic(kaddr, KM_USER0);
259                 }
260                 flush_dcache_page(page);
261                 ret = aops->commit_write(file, page, offset,
262                                          offset + size);
263                 if (unlikely(ret)) {
264                         if (ret == AOP_TRUNCATED_PAGE) {
265                                 page_cache_release(page);
266                                 continue;
267                         }
268                         goto unlock;
269                 }
270                 if (unlikely(transfer_result))
271                         goto unlock;
272                 bv_offs += size;
273                 len -= size;
274                 offset = 0;
275                 index++;
276                 pos += size;
277                 unlock_page(page);
278                 page_cache_release(page);
279         }
280         ret = 0;
281 out:
282         mutex_unlock(&mapping->host->i_mutex);
283         return ret;
284 unlock:
285         unlock_page(page);
286         page_cache_release(page);
287 fail:
288         ret = -1;
289         goto out;
290 }
291
292 /**
293  * __do_lo_send_write - helper for writing data to a loop device
294  *
295  * This helper just factors out common code between do_lo_send_direct_write()
296  * and do_lo_send_write().
297  */
298 static int __do_lo_send_write(struct file *file,
299                 u8 __user *buf, const int len, loff_t pos)
300 {
301         ssize_t bw;
302         mm_segment_t old_fs = get_fs();
303
304         set_fs(get_ds());
305         bw = file->f_op->write(file, buf, len, &pos);
306         set_fs(old_fs);
307         if (likely(bw == len))
308                 return 0;
309         printk(KERN_ERR "loop: Write error at byte offset %llu, length %i.\n",
310                         (unsigned long long)pos, len);
311         if (bw >= 0)
312                 bw = -EIO;
313         return bw;
314 }
315
316 /**
317  * do_lo_send_direct_write - helper for writing data to a loop device
318  *
319  * This is the fast, non-transforming version for backing filesystems which do
320  * not implement the address space operations prepare_write and commit_write.
321  * It uses the write file operation which should be present on all writeable
322  * filesystems.
323  */
324 static int do_lo_send_direct_write(struct loop_device *lo,
325                 struct bio_vec *bvec, int bsize, loff_t pos, struct page *page)
326 {
327         ssize_t bw = __do_lo_send_write(lo->lo_backing_file,
328                         (u8 __user *)kmap(bvec->bv_page) + bvec->bv_offset,
329                         bvec->bv_len, pos);
330         kunmap(bvec->bv_page);
331         cond_resched();
332         return bw;
333 }
334
335 /**
336  * do_lo_send_write - helper for writing data to a loop device
337  *
338  * This is the slow, transforming version for filesystems which do not
339  * implement the address space operations prepare_write and commit_write.  It
340  * uses the write file operation which should be present on all writeable
341  * filesystems.
342  *
343  * Using fops->write is slower than using aops->{prepare,commit}_write in the
344  * transforming case because we need to double buffer the data as we cannot do
345  * the transformations in place as we do not have direct access to the
346  * destination pages of the backing file.
347  */
348 static int do_lo_send_write(struct loop_device *lo, struct bio_vec *bvec,
349                 int bsize, loff_t pos, struct page *page)
350 {
351         int ret = lo_do_transfer(lo, WRITE, page, 0, bvec->bv_page,
352                         bvec->bv_offset, bvec->bv_len, pos >> 9);
353         if (likely(!ret))
354                 return __do_lo_send_write(lo->lo_backing_file,
355                                 (u8 __user *)page_address(page), bvec->bv_len,
356                                 pos);
357         printk(KERN_ERR "loop: Transfer error at byte offset %llu, "
358                         "length %i.\n", (unsigned long long)pos, bvec->bv_len);
359         if (ret > 0)
360                 ret = -EIO;
361         return ret;
362 }
363
364 static int lo_send(struct loop_device *lo, struct bio *bio, int bsize,
365                 loff_t pos)
366 {
367         int (*do_lo_send)(struct loop_device *, struct bio_vec *, int, loff_t,
368                         struct page *page);
369         struct bio_vec *bvec;
370         struct page *page = NULL;
371         int i, ret = 0;
372
373         do_lo_send = do_lo_send_aops;
374         if (!(lo->lo_flags & LO_FLAGS_USE_AOPS)) {
375                 do_lo_send = do_lo_send_direct_write;
376                 if (lo->transfer != transfer_none) {
377                         page = alloc_page(GFP_NOIO | __GFP_HIGHMEM);
378                         if (unlikely(!page))
379                                 goto fail;
380                         kmap(page);
381                         do_lo_send = do_lo_send_write;
382                 }
383         }
384         bio_for_each_segment(bvec, bio, i) {
385                 ret = do_lo_send(lo, bvec, bsize, pos, page);
386                 if (ret < 0)
387                         break;
388                 pos += bvec->bv_len;
389         }
390         if (page) {
391                 kunmap(page);
392                 __free_page(page);
393         }
394 out:
395         return ret;
396 fail:
397         printk(KERN_ERR "loop: Failed to allocate temporary page for write.\n");
398         ret = -ENOMEM;
399         goto out;
400 }
401
402 struct lo_read_data {
403         struct loop_device *lo;
404         struct page *page;
405         unsigned offset;
406         int bsize;
407 };
408
409 static int
410 lo_read_actor(read_descriptor_t *desc, struct page *page,
411               unsigned long offset, unsigned long size)
412 {
413         unsigned long count = desc->count;
414         struct lo_read_data *p = desc->arg.data;
415         struct loop_device *lo = p->lo;
416         sector_t IV;
417
418         IV = ((sector_t) page->index << (PAGE_CACHE_SHIFT - 9))+(offset >> 9);
419
420         if (size > count)
421                 size = count;
422
423         if (lo_do_transfer(lo, READ, page, offset, p->page, p->offset, size, IV)) {
424                 size = 0;
425                 printk(KERN_ERR "loop: transfer error block %ld\n",
426                        page->index);
427                 desc->error = -EINVAL;
428         }
429
430         flush_dcache_page(p->page);
431
432         desc->count = count - size;
433         desc->written += size;
434         p->offset += size;
435         return size;
436 }
437
438 static int
439 do_lo_receive(struct loop_device *lo,
440               struct bio_vec *bvec, int bsize, loff_t pos)
441 {
442         struct lo_read_data cookie;
443         struct file *file;
444         int retval;
445
446         cookie.lo = lo;
447         cookie.page = bvec->bv_page;
448         cookie.offset = bvec->bv_offset;
449         cookie.bsize = bsize;
450         file = lo->lo_backing_file;
451         retval = file->f_op->sendfile(file, &pos, bvec->bv_len,
452                         lo_read_actor, &cookie);
453         return (retval < 0)? retval: 0;
454 }
455
456 static int
457 lo_receive(struct loop_device *lo, struct bio *bio, int bsize, loff_t pos)
458 {
459         struct bio_vec *bvec;
460         int i, ret = 0;
461
462         bio_for_each_segment(bvec, bio, i) {
463                 ret = do_lo_receive(lo, bvec, bsize, pos);
464                 if (ret < 0)
465                         break;
466                 pos += bvec->bv_len;
467         }
468         return ret;
469 }
470
471 static int do_bio_filebacked(struct loop_device *lo, struct bio *bio)
472 {
473         loff_t pos;
474         int ret;
475
476         pos = ((loff_t) bio->bi_sector << 9) + lo->lo_offset;
477         if (bio_rw(bio) == WRITE)
478                 ret = lo_send(lo, bio, lo->lo_blocksize, pos);
479         else
480                 ret = lo_receive(lo, bio, lo->lo_blocksize, pos);
481         return ret;
482 }
483
484 /*
485  * Add bio to back of pending list
486  */
487 static void loop_add_bio(struct loop_device *lo, struct bio *bio)
488 {
489         if (lo->lo_biotail) {
490                 lo->lo_biotail->bi_next = bio;
491                 lo->lo_biotail = bio;
492         } else
493                 lo->lo_bio = lo->lo_biotail = bio;
494 }
495
496 /*
497  * Grab first pending buffer
498  */
499 static struct bio *loop_get_bio(struct loop_device *lo)
500 {
501         struct bio *bio;
502
503         if ((bio = lo->lo_bio)) {
504                 if (bio == lo->lo_biotail)
505                         lo->lo_biotail = NULL;
506                 lo->lo_bio = bio->bi_next;
507                 bio->bi_next = NULL;
508         }
509
510         return bio;
511 }
512
513 static int loop_make_request(request_queue_t *q, struct bio *old_bio)
514 {
515         struct loop_device *lo = q->queuedata;
516         int rw = bio_rw(old_bio);
517
518         if (rw == READA)
519                 rw = READ;
520
521         BUG_ON(!lo || (rw != READ && rw != WRITE));
522
523         spin_lock_irq(&lo->lo_lock);
524         if (lo->lo_state != Lo_bound)
525                 goto out;
526         if (unlikely(rw == WRITE && (lo->lo_flags & LO_FLAGS_READ_ONLY)))
527                 goto out;
528         lo->lo_pending++;
529         loop_add_bio(lo, old_bio);
530         spin_unlock_irq(&lo->lo_lock);
531         complete(&lo->lo_bh_done);
532         return 0;
533
534 out:
535         if (lo->lo_pending == 0)
536                 complete(&lo->lo_bh_done);
537         spin_unlock_irq(&lo->lo_lock);
538         bio_io_error(old_bio, old_bio->bi_size);
539         return 0;
540 }
541
542 /*
543  * kick off io on the underlying address space
544  */
545 static void loop_unplug(request_queue_t *q)
546 {
547         struct loop_device *lo = q->queuedata;
548
549         clear_bit(QUEUE_FLAG_PLUGGED, &q->queue_flags);
550         blk_run_address_space(lo->lo_backing_file->f_mapping);
551 }
552
553 struct switch_request {
554         struct file *file;
555         struct completion wait;
556 };
557
558 static void do_loop_switch(struct loop_device *, struct switch_request *);
559
560 static inline void loop_handle_bio(struct loop_device *lo, struct bio *bio)
561 {
562         if (unlikely(!bio->bi_bdev)) {
563                 do_loop_switch(lo, bio->bi_private);
564                 bio_put(bio);
565         } else {
566                 int ret = do_bio_filebacked(lo, bio);
567                 bio_endio(bio, bio->bi_size, ret);
568         }
569 }
570
571 /*
572  * worker thread that handles reads/writes to file backed loop devices,
573  * to avoid blocking in our make_request_fn. it also does loop decrypting
574  * on reads for block backed loop, as that is too heavy to do from
575  * b_end_io context where irqs may be disabled.
576  */
577 static int loop_thread(void *data)
578 {
579         struct loop_device *lo = data;
580         struct bio *bio;
581
582         /*
583          * loop can be used in an encrypted device,
584          * hence, it mustn't be stopped at all
585          * because it could be indirectly used during suspension
586          */
587         current->flags |= PF_NOFREEZE;
588
589         set_user_nice(current, -20);
590
591         lo->lo_state = Lo_bound;
592         lo->lo_pending = 1;
593
594         for (;;) {
595                 int pending;
596
597                 if (wait_for_completion_interruptible(&lo->lo_bh_done))
598                         continue;
599
600                 spin_lock_irq(&lo->lo_lock);
601
602                 /*
603                  * could be completed because of tear-down, not pending work
604                  */
605                 if (unlikely(!lo->lo_pending)) {
606                         spin_unlock_irq(&lo->lo_lock);
607                         break;
608                 }
609
610                 bio = loop_get_bio(lo);
611                 lo->lo_pending--;
612                 pending = lo->lo_pending;
613                 spin_unlock_irq(&lo->lo_lock);
614
615                 BUG_ON(!bio);
616                 loop_handle_bio(lo, bio);
617
618                 /*
619                  * upped both for pending work and tear-down, lo_pending
620                  * will hit zero then
621                  */
622                 if (unlikely(!pending))
623                         break;
624         }
625
626         return 0;
627 }
628
629 /*
630  * loop_switch performs the hard work of switching a backing store.
631  * First it needs to flush existing IO, it does this by sending a magic
632  * BIO down the pipe. The completion of this BIO does the actual switch.
633  */
634 static int loop_switch(struct loop_device *lo, struct file *file)
635 {
636         struct switch_request w;
637         struct bio *bio = bio_alloc(GFP_KERNEL, 1);
638         if (!bio)
639                 return -ENOMEM;
640         init_completion(&w.wait);
641         w.file = file;
642         bio->bi_private = &w;
643         bio->bi_bdev = NULL;
644         loop_make_request(lo->lo_queue, bio);
645         wait_for_completion(&w.wait);
646         return 0;
647 }
648
649 /*
650  * Do the actual switch; called from the BIO completion routine
651  */
652 static void do_loop_switch(struct loop_device *lo, struct switch_request *p)
653 {
654         struct file *file = p->file;
655         struct file *old_file = lo->lo_backing_file;
656         struct address_space *mapping = file->f_mapping;
657
658         mapping_set_gfp_mask(old_file->f_mapping, lo->old_gfp_mask);
659         lo->lo_backing_file = file;
660         lo->lo_blocksize = mapping->host->i_blksize;
661         lo->old_gfp_mask = mapping_gfp_mask(mapping);
662         mapping_set_gfp_mask(mapping, lo->old_gfp_mask & ~(__GFP_IO|__GFP_FS));
663         complete(&p->wait);
664 }
665
666
667 /*
668  * loop_change_fd switched the backing store of a loopback device to
669  * a new file. This is useful for operating system installers to free up
670  * the original file and in High Availability environments to switch to
671  * an alternative location for the content in case of server meltdown.
672  * This can only work if the loop device is used read-only, and if the
673  * new backing store is the same size and type as the old backing store.
674  */
675 static int loop_change_fd(struct loop_device *lo, struct file *lo_file,
676                        struct block_device *bdev, unsigned int arg)
677 {
678         struct file     *file, *old_file;
679         struct inode    *inode;
680         int             error;
681
682         error = -ENXIO;
683         if (lo->lo_state != Lo_bound)
684                 goto out;
685
686         /* the loop device has to be read-only */
687         error = -EINVAL;
688         if (!(lo->lo_flags & LO_FLAGS_READ_ONLY))
689                 goto out;
690
691         error = -EBADF;
692         file = fget(arg);
693         if (!file)
694                 goto out;
695
696         inode = file->f_mapping->host;
697         old_file = lo->lo_backing_file;
698
699         error = -EINVAL;
700
701         if (!S_ISREG(inode->i_mode) && !S_ISBLK(inode->i_mode))
702                 goto out_putf;
703
704         /* new backing store needs to support loop (eg sendfile) */
705         if (!inode->i_fop->sendfile)
706                 goto out_putf;
707
708         /* size of the new backing store needs to be the same */
709         if (get_loop_size(lo, file) != get_loop_size(lo, old_file))
710                 goto out_putf;
711
712         /* and ... switch */
713         error = loop_switch(lo, file);
714         if (error)
715                 goto out_putf;
716
717         fput(old_file);
718         return 0;
719
720  out_putf:
721         fput(file);
722  out:
723         return error;
724 }
725
726 static inline int is_loop_device(struct file *file)
727 {
728         struct inode *i = file->f_mapping->host;
729
730         return i && S_ISBLK(i->i_mode) && MAJOR(i->i_rdev) == LOOP_MAJOR;
731 }
732
733 static int loop_set_fd(struct loop_device *lo, struct file *lo_file,
734                        struct block_device *bdev, unsigned int arg)
735 {
736         struct file     *file, *f;
737         struct inode    *inode;
738         struct address_space *mapping;
739         unsigned lo_blocksize;
740         int             lo_flags = 0;
741         int             error;
742         struct task_struct *tsk;
743         loff_t          size;
744
745         /* This is safe, since we have a reference from open(). */
746         __module_get(THIS_MODULE);
747
748         error = -EBADF;
749         file = fget(arg);
750         if (!file)
751                 goto out;
752
753         error = -EBUSY;
754         if (lo->lo_state != Lo_unbound)
755                 goto out_putf;
756
757         /* Avoid recursion */
758         f = file;
759         while (is_loop_device(f)) {
760                 struct loop_device *l;
761
762                 if (f->f_mapping->host->i_rdev == lo_file->f_mapping->host->i_rdev)
763                         goto out_putf;
764
765                 l = f->f_mapping->host->i_bdev->bd_disk->private_data;
766                 if (l->lo_state == Lo_unbound) {
767                         error = -EINVAL;
768                         goto out_putf;
769                 }
770                 f = l->lo_backing_file;
771         }
772
773         mapping = file->f_mapping;
774         inode = mapping->host;
775
776         if (!(file->f_mode & FMODE_WRITE))
777                 lo_flags |= LO_FLAGS_READ_ONLY;
778
779         error = -EINVAL;
780         if (S_ISREG(inode->i_mode) || S_ISBLK(inode->i_mode)) {
781                 struct address_space_operations *aops = mapping->a_ops;
782                 /*
783                  * If we can't read - sorry. If we only can't write - well,
784                  * it's going to be read-only.
785                  */
786                 if (!file->f_op->sendfile)
787                         goto out_putf;
788                 if (aops->prepare_write && aops->commit_write)
789                         lo_flags |= LO_FLAGS_USE_AOPS;
790                 if (!(lo_flags & LO_FLAGS_USE_AOPS) && !file->f_op->write)
791                         lo_flags |= LO_FLAGS_READ_ONLY;
792
793                 lo_blocksize = inode->i_blksize;
794                 error = 0;
795         } else {
796                 goto out_putf;
797         }
798
799         size = get_loop_size(lo, file);
800
801         if ((loff_t)(sector_t)size != size) {
802                 error = -EFBIG;
803                 goto out_putf;
804         }
805
806         if (!(lo_file->f_mode & FMODE_WRITE))
807                 lo_flags |= LO_FLAGS_READ_ONLY;
808
809         set_device_ro(bdev, (lo_flags & LO_FLAGS_READ_ONLY) != 0);
810
811         lo->lo_blocksize = lo_blocksize;
812         lo->lo_device = bdev;
813         lo->lo_flags = lo_flags;
814         lo->lo_backing_file = file;
815         lo->transfer = transfer_none;
816         lo->ioctl = NULL;
817         lo->lo_sizelimit = 0;
818         lo->old_gfp_mask = mapping_gfp_mask(mapping);
819         mapping_set_gfp_mask(mapping, lo->old_gfp_mask & ~(__GFP_IO|__GFP_FS));
820
821         lo->lo_bio = lo->lo_biotail = NULL;
822
823         /*
824          * set queue make_request_fn, and add limits based on lower level
825          * device
826          */
827         blk_queue_make_request(lo->lo_queue, loop_make_request);
828         lo->lo_queue->queuedata = lo;
829         lo->lo_queue->unplug_fn = loop_unplug;
830
831         set_capacity(disks[lo->lo_number], size);
832         bd_set_size(bdev, size << 9);
833
834         set_blocksize(bdev, lo_blocksize);
835
836         tsk = kthread_run(loop_thread, lo, "loop%d", lo->lo_number);
837         if (IS_ERR(tsk)) {
838                 error = PTR_ERR(tsk);
839                 goto out_putf;
840         }
841         return 0;
842
843  out_putf:
844         fput(file);
845  out:
846         /* This is safe: open() is still holding a reference. */
847         module_put(THIS_MODULE);
848         return error;
849 }
850
851 static int
852 loop_release_xfer(struct loop_device *lo)
853 {
854         int err = 0;
855         struct loop_func_table *xfer = lo->lo_encryption;
856
857         if (xfer) {
858                 if (xfer->release)
859                         err = xfer->release(lo);
860                 lo->transfer = NULL;
861                 lo->lo_encryption = NULL;
862                 module_put(xfer->owner);
863         }
864         return err;
865 }
866
867 static int
868 loop_init_xfer(struct loop_device *lo, struct loop_func_table *xfer,
869                const struct loop_info64 *i)
870 {
871         int err = 0;
872
873         if (xfer) {
874                 struct module *owner = xfer->owner;
875
876                 if (!try_module_get(owner))
877                         return -EINVAL;
878                 if (xfer->init)
879                         err = xfer->init(lo, i);
880                 if (err)
881                         module_put(owner);
882                 else
883                         lo->lo_encryption = xfer;
884         }
885         return err;
886 }
887
888 static int loop_clr_fd(struct loop_device *lo, struct block_device *bdev)
889 {
890         struct file *filp = lo->lo_backing_file;
891         gfp_t gfp = lo->old_gfp_mask;
892
893         if (lo->lo_state != Lo_bound)
894                 return -ENXIO;
895
896         if (!lo->lo_thread)
897                 return -EINVAL;
898
899         if (lo->lo_refcnt > 1)  /* we needed one fd for the ioctl */
900                 return -EBUSY;
901
902         if (filp == NULL)
903                 return -EINVAL;
904
905         spin_lock_irq(&lo->lo_lock);
906         lo->lo_state = Lo_rundown;
907         lo->lo_pending--;
908         if (!lo->lo_pending)
909                 complete(&lo->lo_bh_done);
910         spin_unlock_irq(&lo->lo_lock);
911
912         kthread_stop(lo->lo_thread);
913
914         lo->lo_backing_file = NULL;
915
916         loop_release_xfer(lo);
917         lo->transfer = NULL;
918         lo->ioctl = NULL;
919         lo->lo_device = NULL;
920         lo->lo_encryption = NULL;
921         lo->lo_offset = 0;
922         lo->lo_sizelimit = 0;
923         lo->lo_encrypt_key_size = 0;
924         lo->lo_flags = 0;
925         lo->lo_thread = NULL;
926         memset(lo->lo_encrypt_key, 0, LO_KEY_SIZE);
927         memset(lo->lo_crypt_name, 0, LO_NAME_SIZE);
928         memset(lo->lo_file_name, 0, LO_NAME_SIZE);
929         invalidate_bdev(bdev, 0);
930         set_capacity(disks[lo->lo_number], 0);
931         bd_set_size(bdev, 0);
932         mapping_set_gfp_mask(filp->f_mapping, gfp);
933         lo->lo_state = Lo_unbound;
934         fput(filp);
935         /* This is safe: open() is still holding a reference. */
936         module_put(THIS_MODULE);
937         return 0;
938 }
939
940 static int
941 loop_set_status(struct loop_device *lo, const struct loop_info64 *info)
942 {
943         int err;
944         struct loop_func_table *xfer;
945
946         if (lo->lo_encrypt_key_size && lo->lo_key_owner != current->uid &&
947             !capable(CAP_SYS_ADMIN))
948                 return -EPERM;
949         if (lo->lo_state != Lo_bound)
950                 return -ENXIO;
951         if ((unsigned int) info->lo_encrypt_key_size > LO_KEY_SIZE)
952                 return -EINVAL;
953
954         err = loop_release_xfer(lo);
955         if (err)
956                 return err;
957
958         if (info->lo_encrypt_type) {
959                 unsigned int type = info->lo_encrypt_type;
960
961                 if (type >= MAX_LO_CRYPT)
962                         return -EINVAL;
963                 xfer = xfer_funcs[type];
964                 if (xfer == NULL)
965                         return -EINVAL;
966         } else
967                 xfer = NULL;
968
969         err = loop_init_xfer(lo, xfer, info);
970         if (err)
971                 return err;
972
973         if (lo->lo_offset != info->lo_offset ||
974             lo->lo_sizelimit != info->lo_sizelimit) {
975                 lo->lo_offset = info->lo_offset;
976                 lo->lo_sizelimit = info->lo_sizelimit;
977                 if (figure_loop_size(lo))
978                         return -EFBIG;
979         }
980
981         memcpy(lo->lo_file_name, info->lo_file_name, LO_NAME_SIZE);
982         memcpy(lo->lo_crypt_name, info->lo_crypt_name, LO_NAME_SIZE);
983         lo->lo_file_name[LO_NAME_SIZE-1] = 0;
984         lo->lo_crypt_name[LO_NAME_SIZE-1] = 0;
985
986         if (!xfer)
987                 xfer = &none_funcs;
988         lo->transfer = xfer->transfer;
989         lo->ioctl = xfer->ioctl;
990
991         lo->lo_encrypt_key_size = info->lo_encrypt_key_size;
992         lo->lo_init[0] = info->lo_init[0];
993         lo->lo_init[1] = info->lo_init[1];
994         if (info->lo_encrypt_key_size) {
995                 memcpy(lo->lo_encrypt_key, info->lo_encrypt_key,
996                        info->lo_encrypt_key_size);
997                 lo->lo_key_owner = current->uid;
998         }       
999
1000         return 0;
1001 }
1002
1003 static int
1004 loop_get_status(struct loop_device *lo, struct loop_info64 *info)
1005 {
1006         struct file *file = lo->lo_backing_file;
1007         struct kstat stat;
1008         int error;
1009
1010         if (lo->lo_state != Lo_bound)
1011                 return -ENXIO;
1012         error = vfs_getattr(file->f_vfsmnt, file->f_dentry, &stat);
1013         if (error)
1014                 return error;
1015         memset(info, 0, sizeof(*info));
1016         info->lo_number = lo->lo_number;
1017         info->lo_device = huge_encode_dev(stat.dev);
1018         info->lo_inode = stat.ino;
1019         info->lo_rdevice = huge_encode_dev(lo->lo_device ? stat.rdev : stat.dev);
1020         info->lo_offset = lo->lo_offset;
1021         info->lo_sizelimit = lo->lo_sizelimit;
1022         info->lo_flags = lo->lo_flags;
1023         memcpy(info->lo_file_name, lo->lo_file_name, LO_NAME_SIZE);
1024         memcpy(info->lo_crypt_name, lo->lo_crypt_name, LO_NAME_SIZE);
1025         info->lo_encrypt_type =
1026                 lo->lo_encryption ? lo->lo_encryption->number : 0;
1027         if (lo->lo_encrypt_key_size && capable(CAP_SYS_ADMIN)) {
1028                 info->lo_encrypt_key_size = lo->lo_encrypt_key_size;
1029                 memcpy(info->lo_encrypt_key, lo->lo_encrypt_key,
1030                        lo->lo_encrypt_key_size);
1031         }
1032         return 0;
1033 }
1034
1035 static void
1036 loop_info64_from_old(const struct loop_info *info, struct loop_info64 *info64)
1037 {
1038         memset(info64, 0, sizeof(*info64));
1039         info64->lo_number = info->lo_number;
1040         info64->lo_device = info->lo_device;
1041         info64->lo_inode = info->lo_inode;
1042         info64->lo_rdevice = info->lo_rdevice;
1043         info64->lo_offset = info->lo_offset;
1044         info64->lo_sizelimit = 0;
1045         info64->lo_encrypt_type = info->lo_encrypt_type;
1046         info64->lo_encrypt_key_size = info->lo_encrypt_key_size;
1047         info64->lo_flags = info->lo_flags;
1048         info64->lo_init[0] = info->lo_init[0];
1049         info64->lo_init[1] = info->lo_init[1];
1050         if (info->lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1051                 memcpy(info64->lo_crypt_name, info->lo_name, LO_NAME_SIZE);
1052         else
1053                 memcpy(info64->lo_file_name, info->lo_name, LO_NAME_SIZE);
1054         memcpy(info64->lo_encrypt_key, info->lo_encrypt_key, LO_KEY_SIZE);
1055 }
1056
1057 static int
1058 loop_info64_to_old(const struct loop_info64 *info64, struct loop_info *info)
1059 {
1060         memset(info, 0, sizeof(*info));
1061         info->lo_number = info64->lo_number;
1062         info->lo_device = info64->lo_device;
1063         info->lo_inode = info64->lo_inode;
1064         info->lo_rdevice = info64->lo_rdevice;
1065         info->lo_offset = info64->lo_offset;
1066         info->lo_encrypt_type = info64->lo_encrypt_type;
1067         info->lo_encrypt_key_size = info64->lo_encrypt_key_size;
1068         info->lo_flags = info64->lo_flags;
1069         info->lo_init[0] = info64->lo_init[0];
1070         info->lo_init[1] = info64->lo_init[1];
1071         if (info->lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1072                 memcpy(info->lo_name, info64->lo_crypt_name, LO_NAME_SIZE);
1073         else
1074                 memcpy(info->lo_name, info64->lo_file_name, LO_NAME_SIZE);
1075         memcpy(info->lo_encrypt_key, info64->lo_encrypt_key, LO_KEY_SIZE);
1076
1077         /* error in case values were truncated */
1078         if (info->lo_device != info64->lo_device ||
1079             info->lo_rdevice != info64->lo_rdevice ||
1080             info->lo_inode != info64->lo_inode ||
1081             info->lo_offset != info64->lo_offset)
1082                 return -EOVERFLOW;
1083
1084         return 0;
1085 }
1086
1087 static int
1088 loop_set_status_old(struct loop_device *lo, const struct loop_info __user *arg)
1089 {
1090         struct loop_info info;
1091         struct loop_info64 info64;
1092
1093         if (copy_from_user(&info, arg, sizeof (struct loop_info)))
1094                 return -EFAULT;
1095         loop_info64_from_old(&info, &info64);
1096         return loop_set_status(lo, &info64);
1097 }
1098
1099 static int
1100 loop_set_status64(struct loop_device *lo, const struct loop_info64 __user *arg)
1101 {
1102         struct loop_info64 info64;
1103
1104         if (copy_from_user(&info64, arg, sizeof (struct loop_info64)))
1105                 return -EFAULT;
1106         return loop_set_status(lo, &info64);
1107 }
1108
1109 static int
1110 loop_get_status_old(struct loop_device *lo, struct loop_info __user *arg) {
1111         struct loop_info info;
1112         struct loop_info64 info64;
1113         int err = 0;
1114
1115         if (!arg)
1116                 err = -EINVAL;
1117         if (!err)
1118                 err = loop_get_status(lo, &info64);
1119         if (!err)
1120                 err = loop_info64_to_old(&info64, &info);
1121         if (!err && copy_to_user(arg, &info, sizeof(info)))
1122                 err = -EFAULT;
1123
1124         return err;
1125 }
1126
1127 static int
1128 loop_get_status64(struct loop_device *lo, struct loop_info64 __user *arg) {
1129         struct loop_info64 info64;
1130         int err = 0;
1131
1132         if (!arg)
1133                 err = -EINVAL;
1134         if (!err)
1135                 err = loop_get_status(lo, &info64);
1136         if (!err && copy_to_user(arg, &info64, sizeof(info64)))
1137                 err = -EFAULT;
1138
1139         return err;
1140 }
1141
1142 static int lo_ioctl(struct inode * inode, struct file * file,
1143         unsigned int cmd, unsigned long arg)
1144 {
1145         struct loop_device *lo = inode->i_bdev->bd_disk->private_data;
1146         int err;
1147
1148         mutex_lock(&lo->lo_ctl_mutex);
1149         switch (cmd) {
1150         case LOOP_SET_FD:
1151                 err = loop_set_fd(lo, file, inode->i_bdev, arg);
1152                 break;
1153         case LOOP_CHANGE_FD:
1154                 err = loop_change_fd(lo, file, inode->i_bdev, arg);
1155                 break;
1156         case LOOP_CLR_FD:
1157                 err = loop_clr_fd(lo, inode->i_bdev);
1158                 break;
1159         case LOOP_SET_STATUS:
1160                 err = loop_set_status_old(lo, (struct loop_info __user *) arg);
1161                 break;
1162         case LOOP_GET_STATUS:
1163                 err = loop_get_status_old(lo, (struct loop_info __user *) arg);
1164                 break;
1165         case LOOP_SET_STATUS64:
1166                 err = loop_set_status64(lo, (struct loop_info64 __user *) arg);
1167                 break;
1168         case LOOP_GET_STATUS64:
1169                 err = loop_get_status64(lo, (struct loop_info64 __user *) arg);
1170                 break;
1171         default:
1172                 err = lo->ioctl ? lo->ioctl(lo, cmd, arg) : -EINVAL;
1173         }
1174         mutex_unlock(&lo->lo_ctl_mutex);
1175         return err;
1176 }
1177
1178 static int lo_open(struct inode *inode, struct file *file)
1179 {
1180         struct loop_device *lo = inode->i_bdev->bd_disk->private_data;
1181
1182         mutex_lock(&lo->lo_ctl_mutex);
1183         lo->lo_refcnt++;
1184         mutex_unlock(&lo->lo_ctl_mutex);
1185
1186         return 0;
1187 }
1188
1189 static int lo_release(struct inode *inode, struct file *file)
1190 {
1191         struct loop_device *lo = inode->i_bdev->bd_disk->private_data;
1192
1193         mutex_lock(&lo->lo_ctl_mutex);
1194         --lo->lo_refcnt;
1195         mutex_unlock(&lo->lo_ctl_mutex);
1196
1197         return 0;
1198 }
1199
1200 static struct block_device_operations lo_fops = {
1201         .owner =        THIS_MODULE,
1202         .open =         lo_open,
1203         .release =      lo_release,
1204         .ioctl =        lo_ioctl,
1205 };
1206
1207 /*
1208  * And now the modules code and kernel interface.
1209  */
1210 module_param(max_loop, int, 0);
1211 MODULE_PARM_DESC(max_loop, "Maximum number of loop devices (1-256)");
1212 MODULE_LICENSE("GPL");
1213 MODULE_ALIAS_BLOCKDEV_MAJOR(LOOP_MAJOR);
1214
1215 int loop_register_transfer(struct loop_func_table *funcs)
1216 {
1217         unsigned int n = funcs->number;
1218
1219         if (n >= MAX_LO_CRYPT || xfer_funcs[n])
1220                 return -EINVAL;
1221         xfer_funcs[n] = funcs;
1222         return 0;
1223 }
1224
1225 int loop_unregister_transfer(int number)
1226 {
1227         unsigned int n = number;
1228         struct loop_device *lo;
1229         struct loop_func_table *xfer;
1230
1231         if (n == 0 || n >= MAX_LO_CRYPT || (xfer = xfer_funcs[n]) == NULL)
1232                 return -EINVAL;
1233
1234         xfer_funcs[n] = NULL;
1235
1236         for (lo = &loop_dev[0]; lo < &loop_dev[max_loop]; lo++) {
1237                 mutex_lock(&lo->lo_ctl_mutex);
1238
1239                 if (lo->lo_encryption == xfer)
1240                         loop_release_xfer(lo);
1241
1242                 mutex_unlock(&lo->lo_ctl_mutex);
1243         }
1244
1245         return 0;
1246 }
1247
1248 EXPORT_SYMBOL(loop_register_transfer);
1249 EXPORT_SYMBOL(loop_unregister_transfer);
1250
1251 static int __init loop_init(void)
1252 {
1253         int     i;
1254
1255         if (max_loop < 1 || max_loop > 256) {
1256                 printk(KERN_WARNING "loop: invalid max_loop (must be between"
1257                                     " 1 and 256), using default (8)\n");
1258                 max_loop = 8;
1259         }
1260
1261         if (register_blkdev(LOOP_MAJOR, "loop"))
1262                 return -EIO;
1263
1264         loop_dev = kmalloc(max_loop * sizeof(struct loop_device), GFP_KERNEL);
1265         if (!loop_dev)
1266                 goto out_mem1;
1267         memset(loop_dev, 0, max_loop * sizeof(struct loop_device));
1268
1269         disks = kmalloc(max_loop * sizeof(struct gendisk *), GFP_KERNEL);
1270         if (!disks)
1271                 goto out_mem2;
1272
1273         for (i = 0; i < max_loop; i++) {
1274                 disks[i] = alloc_disk(1);
1275                 if (!disks[i])
1276                         goto out_mem3;
1277         }
1278
1279         devfs_mk_dir("loop");
1280
1281         for (i = 0; i < max_loop; i++) {
1282                 struct loop_device *lo = &loop_dev[i];
1283                 struct gendisk *disk = disks[i];
1284
1285                 memset(lo, 0, sizeof(*lo));
1286                 lo->lo_queue = blk_alloc_queue(GFP_KERNEL);
1287                 if (!lo->lo_queue)
1288                         goto out_mem4;
1289                 mutex_init(&lo->lo_ctl_mutex);
1290                 init_completion(&lo->lo_bh_done);
1291                 lo->lo_number = i;
1292                 spin_lock_init(&lo->lo_lock);
1293                 disk->major = LOOP_MAJOR;
1294                 disk->first_minor = i;
1295                 disk->fops = &lo_fops;
1296                 sprintf(disk->disk_name, "loop%d", i);
1297                 sprintf(disk->devfs_name, "loop/%d", i);
1298                 disk->private_data = lo;
1299                 disk->queue = lo->lo_queue;
1300         }
1301
1302         /* We cannot fail after we call this, so another loop!*/
1303         for (i = 0; i < max_loop; i++)
1304                 add_disk(disks[i]);
1305         printk(KERN_INFO "loop: loaded (max %d devices)\n", max_loop);
1306         return 0;
1307
1308 out_mem4:
1309         while (i--)
1310                 blk_cleanup_queue(loop_dev[i].lo_queue);
1311         devfs_remove("loop");
1312         i = max_loop;
1313 out_mem3:
1314         while (i--)
1315                 put_disk(disks[i]);
1316         kfree(disks);
1317 out_mem2:
1318         kfree(loop_dev);
1319 out_mem1:
1320         unregister_blkdev(LOOP_MAJOR, "loop");
1321         printk(KERN_ERR "loop: ran out of memory\n");
1322         return -ENOMEM;
1323 }
1324
1325 static void loop_exit(void)
1326 {
1327         int i;
1328
1329         for (i = 0; i < max_loop; i++) {
1330                 del_gendisk(disks[i]);
1331                 blk_cleanup_queue(loop_dev[i].lo_queue);
1332                 put_disk(disks[i]);
1333         }
1334         devfs_remove("loop");
1335         if (unregister_blkdev(LOOP_MAJOR, "loop"))
1336                 printk(KERN_WARNING "loop: cannot unregister blkdev\n");
1337
1338         kfree(disks);
1339         kfree(loop_dev);
1340 }
1341
1342 module_init(loop_init);
1343 module_exit(loop_exit);
1344
1345 #ifndef MODULE
1346 static int __init max_loop_setup(char *str)
1347 {
1348         max_loop = simple_strtol(str, NULL, 0);
1349         return 1;
1350 }
1351
1352 __setup("max_loop=", max_loop_setup);
1353 #endif