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