loop: support barrier writes
[linux-3.10.git] / drivers / block / loop.c
1 /*
2  *  linux/drivers/block/loop.c
3  *
4  *  Written by Theodore Ts'o, 3/29/93
5  *
6  * Copyright 1993 by Theodore Ts'o.  Redistribution of this file is
7  * permitted under the GNU General Public License.
8  *
9  * DES encryption plus some minor changes by Werner Almesberger, 30-MAY-1993
10  * more DES encryption plus IDEA encryption by Nicholas J. Leon, June 20, 1996
11  *
12  * Modularized and updated for 1.1.16 kernel - Mitch Dsouza 28th May 1994
13  * Adapted for 1.3.59 kernel - Andries Brouwer, 1 Feb 1996
14  *
15  * Fixed do_loop_request() re-entrancy - Vincent.Renardias@waw.com Mar 20, 1997
16  *
17  * Added devfs support - Richard Gooch <rgooch@atnf.csiro.au> 16-Jan-1998
18  *
19  * Handle sparse backing files correctly - Kenn Humborg, Jun 28, 1998
20  *
21  * Loadable modules and other fixes by AK, 1998
22  *
23  * Make real block number available to downstream transfer functions, enables
24  * CBC (and relatives) mode encryption requiring unique IVs per data block.
25  * Reed H. Petty, rhp@draper.net
26  *
27  * Maximum number of loop devices now dynamic via max_loop module parameter.
28  * Russell Kroll <rkroll@exploits.org> 19990701
29  *
30  * Maximum number of loop devices when compiled-in now selectable by passing
31  * max_loop=<1-255> to the kernel on boot.
32  * Erik I. Bolsø, <eriki@himolde.no>, Oct 31, 1999
33  *
34  * Completely rewrite request handling to be make_request_fn style and
35  * non blocking, pushing work to a helper thread. Lots of fixes from
36  * Al Viro too.
37  * Jens Axboe <axboe@suse.de>, Nov 2000
38  *
39  * Support up to 256 loop devices
40  * Heinz Mauelshagen <mge@sistina.com>, Feb 2002
41  *
42  * Support for falling back on the write file operation when the address space
43  * operations write_begin is not available on the backing filesystem.
44  * Anton Altaparmakov, 16 Feb 2005
45  *
46  * Still To Fix:
47  * - Advisory locking is ignored here.
48  * - Should use an own CAP_* category instead of CAP_SYS_ADMIN
49  *
50  */
51
52 #include <linux/module.h>
53 #include <linux/moduleparam.h>
54 #include <linux/sched.h>
55 #include <linux/fs.h>
56 #include <linux/file.h>
57 #include <linux/stat.h>
58 #include <linux/errno.h>
59 #include <linux/major.h>
60 #include <linux/wait.h>
61 #include <linux/blkdev.h>
62 #include <linux/blkpg.h>
63 #include <linux/init.h>
64 #include <linux/smp_lock.h>
65 #include <linux/swap.h>
66 #include <linux/slab.h>
67 #include <linux/loop.h>
68 #include <linux/compat.h>
69 #include <linux/suspend.h>
70 #include <linux/freezer.h>
71 #include <linux/writeback.h>
72 #include <linux/buffer_head.h>          /* for invalidate_bdev() */
73 #include <linux/completion.h>
74 #include <linux/highmem.h>
75 #include <linux/gfp.h>
76 #include <linux/kthread.h>
77 #include <linux/splice.h>
78
79 #include <asm/uaccess.h>
80
81 static LIST_HEAD(loop_devices);
82 static DEFINE_MUTEX(loop_devices_mutex);
83
84 static int max_part;
85 static int part_shift;
86
87 /*
88  * Transfer functions
89  */
90 static int transfer_none(struct loop_device *lo, int cmd,
91                          struct page *raw_page, unsigned raw_off,
92                          struct page *loop_page, unsigned loop_off,
93                          int size, sector_t real_block)
94 {
95         char *raw_buf = kmap_atomic(raw_page, KM_USER0) + raw_off;
96         char *loop_buf = kmap_atomic(loop_page, KM_USER1) + loop_off;
97
98         if (cmd == READ)
99                 memcpy(loop_buf, raw_buf, size);
100         else
101                 memcpy(raw_buf, loop_buf, size);
102
103         kunmap_atomic(raw_buf, KM_USER0);
104         kunmap_atomic(loop_buf, KM_USER1);
105         cond_resched();
106         return 0;
107 }
108
109 static int transfer_xor(struct loop_device *lo, int cmd,
110                         struct page *raw_page, unsigned raw_off,
111                         struct page *loop_page, unsigned loop_off,
112                         int size, sector_t real_block)
113 {
114         char *raw_buf = kmap_atomic(raw_page, KM_USER0) + raw_off;
115         char *loop_buf = kmap_atomic(loop_page, KM_USER1) + loop_off;
116         char *in, *out, *key;
117         int i, keysize;
118
119         if (cmd == READ) {
120                 in = raw_buf;
121                 out = loop_buf;
122         } else {
123                 in = loop_buf;
124                 out = raw_buf;
125         }
126
127         key = lo->lo_encrypt_key;
128         keysize = lo->lo_encrypt_key_size;
129         for (i = 0; i < size; i++)
130                 *out++ = *in++ ^ key[(i & 511) % keysize];
131
132         kunmap_atomic(raw_buf, KM_USER0);
133         kunmap_atomic(loop_buf, KM_USER1);
134         cond_resched();
135         return 0;
136 }
137
138 static int xor_init(struct loop_device *lo, const struct loop_info64 *info)
139 {
140         if (unlikely(info->lo_encrypt_key_size <= 0))
141                 return -EINVAL;
142         return 0;
143 }
144
145 static struct loop_func_table none_funcs = {
146         .number = LO_CRYPT_NONE,
147         .transfer = transfer_none,
148 };      
149
150 static struct loop_func_table xor_funcs = {
151         .number = LO_CRYPT_XOR,
152         .transfer = transfer_xor,
153         .init = xor_init
154 };      
155
156 /* xfer_funcs[0] is special - its release function is never called */
157 static struct loop_func_table *xfer_funcs[MAX_LO_CRYPT] = {
158         &none_funcs,
159         &xor_funcs
160 };
161
162 static loff_t get_loop_size(struct loop_device *lo, struct file *file)
163 {
164         loff_t size, offset, loopsize;
165
166         /* Compute loopsize in bytes */
167         size = i_size_read(file->f_mapping->host);
168         offset = lo->lo_offset;
169         loopsize = size - offset;
170         if (lo->lo_sizelimit > 0 && lo->lo_sizelimit < loopsize)
171                 loopsize = lo->lo_sizelimit;
172
173         /*
174          * Unfortunately, if we want to do I/O on the device,
175          * the number of 512-byte sectors has to fit into a sector_t.
176          */
177         return loopsize >> 9;
178 }
179
180 static int
181 figure_loop_size(struct loop_device *lo)
182 {
183         loff_t size = get_loop_size(lo, lo->lo_backing_file);
184         sector_t x = (sector_t)size;
185
186         if (unlikely((loff_t)x != size))
187                 return -EFBIG;
188
189         set_capacity(lo->lo_disk, x);
190         return 0;                                       
191 }
192
193 static inline int
194 lo_do_transfer(struct loop_device *lo, int cmd,
195                struct page *rpage, unsigned roffs,
196                struct page *lpage, unsigned loffs,
197                int size, sector_t rblock)
198 {
199         if (unlikely(!lo->transfer))
200                 return 0;
201
202         return lo->transfer(lo, cmd, rpage, roffs, lpage, loffs, size, rblock);
203 }
204
205 /**
206  * do_lo_send_aops - helper for writing data to a loop device
207  *
208  * This is the fast version for backing filesystems which implement the address
209  * space operations write_begin and write_end.
210  */
211 static int do_lo_send_aops(struct loop_device *lo, struct bio_vec *bvec,
212                 loff_t pos, struct page *unused)
213 {
214         struct file *file = lo->lo_backing_file; /* kudos to NFsckingS */
215         struct address_space *mapping = file->f_mapping;
216         pgoff_t index;
217         unsigned offset, bv_offs;
218         int len, ret;
219
220         mutex_lock(&mapping->host->i_mutex);
221         index = pos >> PAGE_CACHE_SHIFT;
222         offset = pos & ((pgoff_t)PAGE_CACHE_SIZE - 1);
223         bv_offs = bvec->bv_offset;
224         len = bvec->bv_len;
225         while (len > 0) {
226                 sector_t IV;
227                 unsigned size, copied;
228                 int transfer_result;
229                 struct page *page;
230                 void *fsdata;
231
232                 IV = ((sector_t)index << (PAGE_CACHE_SHIFT - 9))+(offset >> 9);
233                 size = PAGE_CACHE_SIZE - offset;
234                 if (size > len)
235                         size = len;
236
237                 ret = pagecache_write_begin(file, mapping, pos, size, 0,
238                                                         &page, &fsdata);
239                 if (ret)
240                         goto fail;
241
242                 transfer_result = lo_do_transfer(lo, WRITE, page, offset,
243                                 bvec->bv_page, bv_offs, size, IV);
244                 copied = size;
245                 if (unlikely(transfer_result))
246                         copied = 0;
247
248                 ret = pagecache_write_end(file, mapping, pos, size, copied,
249                                                         page, fsdata);
250                 if (ret < 0 || ret != copied)
251                         goto fail;
252
253                 if (unlikely(transfer_result))
254                         goto fail;
255
256                 bv_offs += copied;
257                 len -= copied;
258                 offset = 0;
259                 index++;
260                 pos += copied;
261         }
262         ret = 0;
263 out:
264         mutex_unlock(&mapping->host->i_mutex);
265         return ret;
266 fail:
267         ret = -1;
268         goto out;
269 }
270
271 /**
272  * __do_lo_send_write - helper for writing data to a loop device
273  *
274  * This helper just factors out common code between do_lo_send_direct_write()
275  * and do_lo_send_write().
276  */
277 static int __do_lo_send_write(struct file *file,
278                 u8 *buf, const int len, loff_t pos)
279 {
280         ssize_t bw;
281         mm_segment_t old_fs = get_fs();
282
283         set_fs(get_ds());
284         bw = file->f_op->write(file, buf, len, &pos);
285         set_fs(old_fs);
286         if (likely(bw == len))
287                 return 0;
288         printk(KERN_ERR "loop: Write error at byte offset %llu, length %i.\n",
289                         (unsigned long long)pos, len);
290         if (bw >= 0)
291                 bw = -EIO;
292         return bw;
293 }
294
295 /**
296  * do_lo_send_direct_write - helper for writing data to a loop device
297  *
298  * This is the fast, non-transforming version for backing filesystems which do
299  * not implement the address space operations write_begin and write_end.
300  * It uses the write file operation which should be present on all writeable
301  * filesystems.
302  */
303 static int do_lo_send_direct_write(struct loop_device *lo,
304                 struct bio_vec *bvec, loff_t pos, struct page *page)
305 {
306         ssize_t bw = __do_lo_send_write(lo->lo_backing_file,
307                         kmap(bvec->bv_page) + bvec->bv_offset,
308                         bvec->bv_len, pos);
309         kunmap(bvec->bv_page);
310         cond_resched();
311         return bw;
312 }
313
314 /**
315  * do_lo_send_write - helper for writing data to a loop device
316  *
317  * This is the slow, transforming version for filesystems which do not
318  * implement the address space operations write_begin and write_end.  It
319  * uses the write file operation which should be present on all writeable
320  * filesystems.
321  *
322  * Using fops->write is slower than using aops->{prepare,commit}_write in the
323  * transforming case because we need to double buffer the data as we cannot do
324  * the transformations in place as we do not have direct access to the
325  * destination pages of the backing file.
326  */
327 static int do_lo_send_write(struct loop_device *lo, struct bio_vec *bvec,
328                 loff_t pos, struct page *page)
329 {
330         int ret = lo_do_transfer(lo, WRITE, page, 0, bvec->bv_page,
331                         bvec->bv_offset, bvec->bv_len, pos >> 9);
332         if (likely(!ret))
333                 return __do_lo_send_write(lo->lo_backing_file,
334                                 page_address(page), bvec->bv_len,
335                                 pos);
336         printk(KERN_ERR "loop: Transfer error at byte offset %llu, "
337                         "length %i.\n", (unsigned long long)pos, bvec->bv_len);
338         if (ret > 0)
339                 ret = -EIO;
340         return ret;
341 }
342
343 static int lo_send(struct loop_device *lo, struct bio *bio, loff_t pos)
344 {
345         int (*do_lo_send)(struct loop_device *, struct bio_vec *, loff_t,
346                         struct page *page);
347         struct bio_vec *bvec;
348         struct page *page = NULL;
349         int i, ret = 0;
350
351         do_lo_send = do_lo_send_aops;
352         if (!(lo->lo_flags & LO_FLAGS_USE_AOPS)) {
353                 do_lo_send = do_lo_send_direct_write;
354                 if (lo->transfer != transfer_none) {
355                         page = alloc_page(GFP_NOIO | __GFP_HIGHMEM);
356                         if (unlikely(!page))
357                                 goto fail;
358                         kmap(page);
359                         do_lo_send = do_lo_send_write;
360                 }
361         }
362         bio_for_each_segment(bvec, bio, i) {
363                 ret = do_lo_send(lo, bvec, pos, page);
364                 if (ret < 0)
365                         break;
366                 pos += bvec->bv_len;
367         }
368         if (page) {
369                 kunmap(page);
370                 __free_page(page);
371         }
372 out:
373         return ret;
374 fail:
375         printk(KERN_ERR "loop: Failed to allocate temporary page for write.\n");
376         ret = -ENOMEM;
377         goto out;
378 }
379
380 struct lo_read_data {
381         struct loop_device *lo;
382         struct page *page;
383         unsigned offset;
384         int bsize;
385 };
386
387 static int
388 lo_splice_actor(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
389                 struct splice_desc *sd)
390 {
391         struct lo_read_data *p = sd->u.data;
392         struct loop_device *lo = p->lo;
393         struct page *page = buf->page;
394         sector_t IV;
395         int size, ret;
396
397         ret = buf->ops->confirm(pipe, buf);
398         if (unlikely(ret))
399                 return ret;
400
401         IV = ((sector_t) page->index << (PAGE_CACHE_SHIFT - 9)) +
402                                                         (buf->offset >> 9);
403         size = sd->len;
404         if (size > p->bsize)
405                 size = p->bsize;
406
407         if (lo_do_transfer(lo, READ, page, buf->offset, p->page, p->offset, size, IV)) {
408                 printk(KERN_ERR "loop: transfer error block %ld\n",
409                        page->index);
410                 size = -EINVAL;
411         }
412
413         flush_dcache_page(p->page);
414
415         if (size > 0)
416                 p->offset += size;
417
418         return size;
419 }
420
421 static int
422 lo_direct_splice_actor(struct pipe_inode_info *pipe, struct splice_desc *sd)
423 {
424         return __splice_from_pipe(pipe, sd, lo_splice_actor);
425 }
426
427 static int
428 do_lo_receive(struct loop_device *lo,
429               struct bio_vec *bvec, int bsize, loff_t pos)
430 {
431         struct lo_read_data cookie;
432         struct splice_desc sd;
433         struct file *file;
434         long retval;
435
436         cookie.lo = lo;
437         cookie.page = bvec->bv_page;
438         cookie.offset = bvec->bv_offset;
439         cookie.bsize = bsize;
440
441         sd.len = 0;
442         sd.total_len = bvec->bv_len;
443         sd.flags = 0;
444         sd.pos = pos;
445         sd.u.data = &cookie;
446
447         file = lo->lo_backing_file;
448         retval = splice_direct_to_actor(file, &sd, lo_direct_splice_actor);
449
450         if (retval < 0)
451                 return retval;
452
453         return 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
478         if (bio_rw(bio) == WRITE) {
479                 int barrier = bio_barrier(bio);
480                 struct file *file = lo->lo_backing_file;
481
482                 if (barrier) {
483                         if (unlikely(!file->f_op->fsync)) {
484                                 ret = -EOPNOTSUPP;
485                                 goto out;
486                         }
487
488                         ret = vfs_fsync(file, file->f_path.dentry, 0);
489                         if (unlikely(ret)) {
490                                 ret = -EIO;
491                                 goto out;
492                         }
493                 }
494
495                 ret = lo_send(lo, bio, pos);
496
497                 if (barrier && !ret) {
498                         ret = vfs_fsync(file, file->f_path.dentry, 0);
499                         if (unlikely(ret))
500                                 ret = -EIO;
501                 }
502         } else
503                 ret = lo_receive(lo, bio, lo->lo_blocksize, pos);
504
505 out:
506         return ret;
507 }
508
509 /*
510  * Add bio to back of pending list
511  */
512 static void loop_add_bio(struct loop_device *lo, struct bio *bio)
513 {
514         if (lo->lo_biotail) {
515                 lo->lo_biotail->bi_next = bio;
516                 lo->lo_biotail = bio;
517         } else
518                 lo->lo_bio = lo->lo_biotail = bio;
519 }
520
521 /*
522  * Grab first pending buffer
523  */
524 static struct bio *loop_get_bio(struct loop_device *lo)
525 {
526         struct bio *bio;
527
528         if ((bio = lo->lo_bio)) {
529                 if (bio == lo->lo_biotail)
530                         lo->lo_biotail = NULL;
531                 lo->lo_bio = bio->bi_next;
532                 bio->bi_next = NULL;
533         }
534
535         return bio;
536 }
537
538 static int loop_make_request(struct request_queue *q, struct bio *old_bio)
539 {
540         struct loop_device *lo = q->queuedata;
541         int rw = bio_rw(old_bio);
542
543         if (rw == READA)
544                 rw = READ;
545
546         BUG_ON(!lo || (rw != READ && rw != WRITE));
547
548         spin_lock_irq(&lo->lo_lock);
549         if (lo->lo_state != Lo_bound)
550                 goto out;
551         if (unlikely(rw == WRITE && (lo->lo_flags & LO_FLAGS_READ_ONLY)))
552                 goto out;
553         loop_add_bio(lo, old_bio);
554         wake_up(&lo->lo_event);
555         spin_unlock_irq(&lo->lo_lock);
556         return 0;
557
558 out:
559         spin_unlock_irq(&lo->lo_lock);
560         bio_io_error(old_bio);
561         return 0;
562 }
563
564 /*
565  * kick off io on the underlying address space
566  */
567 static void loop_unplug(struct request_queue *q)
568 {
569         struct loop_device *lo = q->queuedata;
570
571         queue_flag_clear_unlocked(QUEUE_FLAG_PLUGGED, q);
572         blk_run_address_space(lo->lo_backing_file->f_mapping);
573 }
574
575 struct switch_request {
576         struct file *file;
577         struct completion wait;
578 };
579
580 static void do_loop_switch(struct loop_device *, struct switch_request *);
581
582 static inline void loop_handle_bio(struct loop_device *lo, struct bio *bio)
583 {
584         if (unlikely(!bio->bi_bdev)) {
585                 do_loop_switch(lo, bio->bi_private);
586                 bio_put(bio);
587         } else {
588                 int ret = do_bio_filebacked(lo, bio);
589                 bio_endio(bio, ret);
590         }
591 }
592
593 /*
594  * worker thread that handles reads/writes to file backed loop devices,
595  * to avoid blocking in our make_request_fn. it also does loop decrypting
596  * on reads for block backed loop, as that is too heavy to do from
597  * b_end_io context where irqs may be disabled.
598  *
599  * Loop explanation:  loop_clr_fd() sets lo_state to Lo_rundown before
600  * calling kthread_stop().  Therefore once kthread_should_stop() is
601  * true, make_request will not place any more requests.  Therefore
602  * once kthread_should_stop() is true and lo_bio is NULL, we are
603  * done with the loop.
604  */
605 static int loop_thread(void *data)
606 {
607         struct loop_device *lo = data;
608         struct bio *bio;
609
610         set_user_nice(current, -20);
611
612         while (!kthread_should_stop() || lo->lo_bio) {
613
614                 wait_event_interruptible(lo->lo_event,
615                                 lo->lo_bio || kthread_should_stop());
616
617                 if (!lo->lo_bio)
618                         continue;
619                 spin_lock_irq(&lo->lo_lock);
620                 bio = loop_get_bio(lo);
621                 spin_unlock_irq(&lo->lo_lock);
622
623                 BUG_ON(!bio);
624                 loop_handle_bio(lo, bio);
625         }
626
627         return 0;
628 }
629
630 /*
631  * loop_switch performs the hard work of switching a backing store.
632  * First it needs to flush existing IO, it does this by sending a magic
633  * BIO down the pipe. The completion of this BIO does the actual switch.
634  */
635 static int loop_switch(struct loop_device *lo, struct file *file)
636 {
637         struct switch_request w;
638         struct bio *bio = bio_alloc(GFP_KERNEL, 0);
639         if (!bio)
640                 return -ENOMEM;
641         init_completion(&w.wait);
642         w.file = file;
643         bio->bi_private = &w;
644         bio->bi_bdev = NULL;
645         loop_make_request(lo->lo_queue, bio);
646         wait_for_completion(&w.wait);
647         return 0;
648 }
649
650 /*
651  * Helper to flush the IOs in loop, but keeping loop thread running
652  */
653 static int loop_flush(struct loop_device *lo)
654 {
655         /* loop not yet configured, no running thread, nothing to flush */
656         if (!lo->lo_thread)
657                 return 0;
658
659         return loop_switch(lo, NULL);
660 }
661
662 /*
663  * Do the actual switch; called from the BIO completion routine
664  */
665 static void do_loop_switch(struct loop_device *lo, struct switch_request *p)
666 {
667         struct file *file = p->file;
668         struct file *old_file = lo->lo_backing_file;
669         struct address_space *mapping;
670
671         /* if no new file, only flush of queued bios requested */
672         if (!file)
673                 goto out;
674
675         mapping = file->f_mapping;
676         mapping_set_gfp_mask(old_file->f_mapping, lo->old_gfp_mask);
677         lo->lo_backing_file = file;
678         lo->lo_blocksize = S_ISBLK(mapping->host->i_mode) ?
679                 mapping->host->i_bdev->bd_block_size : PAGE_SIZE;
680         lo->old_gfp_mask = mapping_gfp_mask(mapping);
681         mapping_set_gfp_mask(mapping, lo->old_gfp_mask & ~(__GFP_IO|__GFP_FS));
682 out:
683         complete(&p->wait);
684 }
685
686
687 /*
688  * loop_change_fd switched the backing store of a loopback device to
689  * a new file. This is useful for operating system installers to free up
690  * the original file and in High Availability environments to switch to
691  * an alternative location for the content in case of server meltdown.
692  * This can only work if the loop device is used read-only, and if the
693  * new backing store is the same size and type as the old backing store.
694  */
695 static int loop_change_fd(struct loop_device *lo, struct block_device *bdev,
696                           unsigned int arg)
697 {
698         struct file     *file, *old_file;
699         struct inode    *inode;
700         int             error;
701
702         error = -ENXIO;
703         if (lo->lo_state != Lo_bound)
704                 goto out;
705
706         /* the loop device has to be read-only */
707         error = -EINVAL;
708         if (!(lo->lo_flags & LO_FLAGS_READ_ONLY))
709                 goto out;
710
711         error = -EBADF;
712         file = fget(arg);
713         if (!file)
714                 goto out;
715
716         inode = file->f_mapping->host;
717         old_file = lo->lo_backing_file;
718
719         error = -EINVAL;
720
721         if (!S_ISREG(inode->i_mode) && !S_ISBLK(inode->i_mode))
722                 goto out_putf;
723
724         /* new backing store needs to support loop (eg splice_read) */
725         if (!inode->i_fop->splice_read)
726                 goto out_putf;
727
728         /* size of the new backing store needs to be the same */
729         if (get_loop_size(lo, file) != get_loop_size(lo, old_file))
730                 goto out_putf;
731
732         /* and ... switch */
733         error = loop_switch(lo, file);
734         if (error)
735                 goto out_putf;
736
737         fput(old_file);
738         if (max_part > 0)
739                 ioctl_by_bdev(bdev, BLKRRPART, 0);
740         return 0;
741
742  out_putf:
743         fput(file);
744  out:
745         return error;
746 }
747
748 static inline int is_loop_device(struct file *file)
749 {
750         struct inode *i = file->f_mapping->host;
751
752         return i && S_ISBLK(i->i_mode) && MAJOR(i->i_rdev) == LOOP_MAJOR;
753 }
754
755 static int loop_set_fd(struct loop_device *lo, fmode_t mode,
756                        struct block_device *bdev, unsigned int arg)
757 {
758         struct file     *file, *f;
759         struct inode    *inode;
760         struct address_space *mapping;
761         unsigned lo_blocksize;
762         int             lo_flags = 0;
763         int             error;
764         loff_t          size;
765
766         /* This is safe, since we have a reference from open(). */
767         __module_get(THIS_MODULE);
768
769         error = -EBADF;
770         file = fget(arg);
771         if (!file)
772                 goto out;
773
774         error = -EBUSY;
775         if (lo->lo_state != Lo_unbound)
776                 goto out_putf;
777
778         /* Avoid recursion */
779         f = file;
780         while (is_loop_device(f)) {
781                 struct loop_device *l;
782
783                 if (f->f_mapping->host->i_bdev == bdev)
784                         goto out_putf;
785
786                 l = f->f_mapping->host->i_bdev->bd_disk->private_data;
787                 if (l->lo_state == Lo_unbound) {
788                         error = -EINVAL;
789                         goto out_putf;
790                 }
791                 f = l->lo_backing_file;
792         }
793
794         mapping = file->f_mapping;
795         inode = mapping->host;
796
797         if (!(file->f_mode & FMODE_WRITE))
798                 lo_flags |= LO_FLAGS_READ_ONLY;
799
800         error = -EINVAL;
801         if (S_ISREG(inode->i_mode) || S_ISBLK(inode->i_mode)) {
802                 const struct address_space_operations *aops = mapping->a_ops;
803                 /*
804                  * If we can't read - sorry. If we only can't write - well,
805                  * it's going to be read-only.
806                  */
807                 if (!file->f_op->splice_read)
808                         goto out_putf;
809                 if (aops->write_begin)
810                         lo_flags |= LO_FLAGS_USE_AOPS;
811                 if (!(lo_flags & LO_FLAGS_USE_AOPS) && !file->f_op->write)
812                         lo_flags |= LO_FLAGS_READ_ONLY;
813
814                 lo_blocksize = S_ISBLK(inode->i_mode) ?
815                         inode->i_bdev->bd_block_size : PAGE_SIZE;
816
817                 error = 0;
818         } else {
819                 goto out_putf;
820         }
821
822         size = get_loop_size(lo, file);
823
824         if ((loff_t)(sector_t)size != size) {
825                 error = -EFBIG;
826                 goto out_putf;
827         }
828
829         if (!(mode & FMODE_WRITE))
830                 lo_flags |= LO_FLAGS_READ_ONLY;
831
832         set_device_ro(bdev, (lo_flags & LO_FLAGS_READ_ONLY) != 0);
833
834         lo->lo_blocksize = lo_blocksize;
835         lo->lo_device = bdev;
836         lo->lo_flags = lo_flags;
837         lo->lo_backing_file = file;
838         lo->transfer = transfer_none;
839         lo->ioctl = NULL;
840         lo->lo_sizelimit = 0;
841         lo->old_gfp_mask = mapping_gfp_mask(mapping);
842         mapping_set_gfp_mask(mapping, lo->old_gfp_mask & ~(__GFP_IO|__GFP_FS));
843
844         lo->lo_bio = lo->lo_biotail = NULL;
845
846         /*
847          * set queue make_request_fn, and add limits based on lower level
848          * device
849          */
850         blk_queue_make_request(lo->lo_queue, loop_make_request);
851         lo->lo_queue->queuedata = lo;
852         lo->lo_queue->unplug_fn = loop_unplug;
853
854         if (!(lo_flags & LO_FLAGS_READ_ONLY) && file->f_op->fsync)
855                 blk_queue_ordered(lo->lo_queue, QUEUE_ORDERED_DRAIN, NULL);
856
857         set_capacity(lo->lo_disk, size);
858         bd_set_size(bdev, size << 9);
859
860         set_blocksize(bdev, lo_blocksize);
861
862         lo->lo_thread = kthread_create(loop_thread, lo, "loop%d",
863                                                 lo->lo_number);
864         if (IS_ERR(lo->lo_thread)) {
865                 error = PTR_ERR(lo->lo_thread);
866                 goto out_clr;
867         }
868         lo->lo_state = Lo_bound;
869         wake_up_process(lo->lo_thread);
870         if (max_part > 0)
871                 ioctl_by_bdev(bdev, BLKRRPART, 0);
872         return 0;
873
874 out_clr:
875         lo->lo_thread = NULL;
876         lo->lo_device = NULL;
877         lo->lo_backing_file = NULL;
878         lo->lo_flags = 0;
879         set_capacity(lo->lo_disk, 0);
880         invalidate_bdev(bdev);
881         bd_set_size(bdev, 0);
882         mapping_set_gfp_mask(mapping, lo->old_gfp_mask);
883         lo->lo_state = Lo_unbound;
884  out_putf:
885         fput(file);
886  out:
887         /* This is safe: open() is still holding a reference. */
888         module_put(THIS_MODULE);
889         return error;
890 }
891
892 static int
893 loop_release_xfer(struct loop_device *lo)
894 {
895         int err = 0;
896         struct loop_func_table *xfer = lo->lo_encryption;
897
898         if (xfer) {
899                 if (xfer->release)
900                         err = xfer->release(lo);
901                 lo->transfer = NULL;
902                 lo->lo_encryption = NULL;
903                 module_put(xfer->owner);
904         }
905         return err;
906 }
907
908 static int
909 loop_init_xfer(struct loop_device *lo, struct loop_func_table *xfer,
910                const struct loop_info64 *i)
911 {
912         int err = 0;
913
914         if (xfer) {
915                 struct module *owner = xfer->owner;
916
917                 if (!try_module_get(owner))
918                         return -EINVAL;
919                 if (xfer->init)
920                         err = xfer->init(lo, i);
921                 if (err)
922                         module_put(owner);
923                 else
924                         lo->lo_encryption = xfer;
925         }
926         return err;
927 }
928
929 static int loop_clr_fd(struct loop_device *lo, struct block_device *bdev)
930 {
931         struct file *filp = lo->lo_backing_file;
932         gfp_t gfp = lo->old_gfp_mask;
933
934         if (lo->lo_state != Lo_bound)
935                 return -ENXIO;
936
937         if (lo->lo_refcnt > 1)  /* we needed one fd for the ioctl */
938                 return -EBUSY;
939
940         if (filp == NULL)
941                 return -EINVAL;
942
943         spin_lock_irq(&lo->lo_lock);
944         lo->lo_state = Lo_rundown;
945         spin_unlock_irq(&lo->lo_lock);
946
947         kthread_stop(lo->lo_thread);
948
949         lo->lo_queue->unplug_fn = NULL;
950         lo->lo_backing_file = NULL;
951
952         loop_release_xfer(lo);
953         lo->transfer = NULL;
954         lo->ioctl = NULL;
955         lo->lo_device = NULL;
956         lo->lo_encryption = NULL;
957         lo->lo_offset = 0;
958         lo->lo_sizelimit = 0;
959         lo->lo_encrypt_key_size = 0;
960         lo->lo_flags = 0;
961         lo->lo_thread = NULL;
962         memset(lo->lo_encrypt_key, 0, LO_KEY_SIZE);
963         memset(lo->lo_crypt_name, 0, LO_NAME_SIZE);
964         memset(lo->lo_file_name, 0, LO_NAME_SIZE);
965         if (bdev)
966                 invalidate_bdev(bdev);
967         set_capacity(lo->lo_disk, 0);
968         if (bdev)
969                 bd_set_size(bdev, 0);
970         mapping_set_gfp_mask(filp->f_mapping, gfp);
971         lo->lo_state = Lo_unbound;
972         fput(filp);
973         /* This is safe: open() is still holding a reference. */
974         module_put(THIS_MODULE);
975         if (max_part > 0)
976                 ioctl_by_bdev(bdev, BLKRRPART, 0);
977         return 0;
978 }
979
980 static int
981 loop_set_status(struct loop_device *lo, const struct loop_info64 *info)
982 {
983         int err;
984         struct loop_func_table *xfer;
985         uid_t uid = current_uid();
986
987         if (lo->lo_encrypt_key_size &&
988             lo->lo_key_owner != uid &&
989             !capable(CAP_SYS_ADMIN))
990                 return -EPERM;
991         if (lo->lo_state != Lo_bound)
992                 return -ENXIO;
993         if ((unsigned int) info->lo_encrypt_key_size > LO_KEY_SIZE)
994                 return -EINVAL;
995
996         err = loop_release_xfer(lo);
997         if (err)
998                 return err;
999
1000         if (info->lo_encrypt_type) {
1001                 unsigned int type = info->lo_encrypt_type;
1002
1003                 if (type >= MAX_LO_CRYPT)
1004                         return -EINVAL;
1005                 xfer = xfer_funcs[type];
1006                 if (xfer == NULL)
1007                         return -EINVAL;
1008         } else
1009                 xfer = NULL;
1010
1011         err = loop_init_xfer(lo, xfer, info);
1012         if (err)
1013                 return err;
1014
1015         if (lo->lo_offset != info->lo_offset ||
1016             lo->lo_sizelimit != info->lo_sizelimit) {
1017                 lo->lo_offset = info->lo_offset;
1018                 lo->lo_sizelimit = info->lo_sizelimit;
1019                 if (figure_loop_size(lo))
1020                         return -EFBIG;
1021         }
1022
1023         memcpy(lo->lo_file_name, info->lo_file_name, LO_NAME_SIZE);
1024         memcpy(lo->lo_crypt_name, info->lo_crypt_name, LO_NAME_SIZE);
1025         lo->lo_file_name[LO_NAME_SIZE-1] = 0;
1026         lo->lo_crypt_name[LO_NAME_SIZE-1] = 0;
1027
1028         if (!xfer)
1029                 xfer = &none_funcs;
1030         lo->transfer = xfer->transfer;
1031         lo->ioctl = xfer->ioctl;
1032
1033         if ((lo->lo_flags & LO_FLAGS_AUTOCLEAR) !=
1034              (info->lo_flags & LO_FLAGS_AUTOCLEAR))
1035                 lo->lo_flags ^= LO_FLAGS_AUTOCLEAR;
1036
1037         lo->lo_encrypt_key_size = info->lo_encrypt_key_size;
1038         lo->lo_init[0] = info->lo_init[0];
1039         lo->lo_init[1] = info->lo_init[1];
1040         if (info->lo_encrypt_key_size) {
1041                 memcpy(lo->lo_encrypt_key, info->lo_encrypt_key,
1042                        info->lo_encrypt_key_size);
1043                 lo->lo_key_owner = uid;
1044         }       
1045
1046         return 0;
1047 }
1048
1049 static int
1050 loop_get_status(struct loop_device *lo, struct loop_info64 *info)
1051 {
1052         struct file *file = lo->lo_backing_file;
1053         struct kstat stat;
1054         int error;
1055
1056         if (lo->lo_state != Lo_bound)
1057                 return -ENXIO;
1058         error = vfs_getattr(file->f_path.mnt, file->f_path.dentry, &stat);
1059         if (error)
1060                 return error;
1061         memset(info, 0, sizeof(*info));
1062         info->lo_number = lo->lo_number;
1063         info->lo_device = huge_encode_dev(stat.dev);
1064         info->lo_inode = stat.ino;
1065         info->lo_rdevice = huge_encode_dev(lo->lo_device ? stat.rdev : stat.dev);
1066         info->lo_offset = lo->lo_offset;
1067         info->lo_sizelimit = lo->lo_sizelimit;
1068         info->lo_flags = lo->lo_flags;
1069         memcpy(info->lo_file_name, lo->lo_file_name, LO_NAME_SIZE);
1070         memcpy(info->lo_crypt_name, lo->lo_crypt_name, LO_NAME_SIZE);
1071         info->lo_encrypt_type =
1072                 lo->lo_encryption ? lo->lo_encryption->number : 0;
1073         if (lo->lo_encrypt_key_size && capable(CAP_SYS_ADMIN)) {
1074                 info->lo_encrypt_key_size = lo->lo_encrypt_key_size;
1075                 memcpy(info->lo_encrypt_key, lo->lo_encrypt_key,
1076                        lo->lo_encrypt_key_size);
1077         }
1078         return 0;
1079 }
1080
1081 static void
1082 loop_info64_from_old(const struct loop_info *info, struct loop_info64 *info64)
1083 {
1084         memset(info64, 0, sizeof(*info64));
1085         info64->lo_number = info->lo_number;
1086         info64->lo_device = info->lo_device;
1087         info64->lo_inode = info->lo_inode;
1088         info64->lo_rdevice = info->lo_rdevice;
1089         info64->lo_offset = info->lo_offset;
1090         info64->lo_sizelimit = 0;
1091         info64->lo_encrypt_type = info->lo_encrypt_type;
1092         info64->lo_encrypt_key_size = info->lo_encrypt_key_size;
1093         info64->lo_flags = info->lo_flags;
1094         info64->lo_init[0] = info->lo_init[0];
1095         info64->lo_init[1] = info->lo_init[1];
1096         if (info->lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1097                 memcpy(info64->lo_crypt_name, info->lo_name, LO_NAME_SIZE);
1098         else
1099                 memcpy(info64->lo_file_name, info->lo_name, LO_NAME_SIZE);
1100         memcpy(info64->lo_encrypt_key, info->lo_encrypt_key, LO_KEY_SIZE);
1101 }
1102
1103 static int
1104 loop_info64_to_old(const struct loop_info64 *info64, struct loop_info *info)
1105 {
1106         memset(info, 0, sizeof(*info));
1107         info->lo_number = info64->lo_number;
1108         info->lo_device = info64->lo_device;
1109         info->lo_inode = info64->lo_inode;
1110         info->lo_rdevice = info64->lo_rdevice;
1111         info->lo_offset = info64->lo_offset;
1112         info->lo_encrypt_type = info64->lo_encrypt_type;
1113         info->lo_encrypt_key_size = info64->lo_encrypt_key_size;
1114         info->lo_flags = info64->lo_flags;
1115         info->lo_init[0] = info64->lo_init[0];
1116         info->lo_init[1] = info64->lo_init[1];
1117         if (info->lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1118                 memcpy(info->lo_name, info64->lo_crypt_name, LO_NAME_SIZE);
1119         else
1120                 memcpy(info->lo_name, info64->lo_file_name, LO_NAME_SIZE);
1121         memcpy(info->lo_encrypt_key, info64->lo_encrypt_key, LO_KEY_SIZE);
1122
1123         /* error in case values were truncated */
1124         if (info->lo_device != info64->lo_device ||
1125             info->lo_rdevice != info64->lo_rdevice ||
1126             info->lo_inode != info64->lo_inode ||
1127             info->lo_offset != info64->lo_offset)
1128                 return -EOVERFLOW;
1129
1130         return 0;
1131 }
1132
1133 static int
1134 loop_set_status_old(struct loop_device *lo, const struct loop_info __user *arg)
1135 {
1136         struct loop_info info;
1137         struct loop_info64 info64;
1138
1139         if (copy_from_user(&info, arg, sizeof (struct loop_info)))
1140                 return -EFAULT;
1141         loop_info64_from_old(&info, &info64);
1142         return loop_set_status(lo, &info64);
1143 }
1144
1145 static int
1146 loop_set_status64(struct loop_device *lo, const struct loop_info64 __user *arg)
1147 {
1148         struct loop_info64 info64;
1149
1150         if (copy_from_user(&info64, arg, sizeof (struct loop_info64)))
1151                 return -EFAULT;
1152         return loop_set_status(lo, &info64);
1153 }
1154
1155 static int
1156 loop_get_status_old(struct loop_device *lo, struct loop_info __user *arg) {
1157         struct loop_info info;
1158         struct loop_info64 info64;
1159         int err = 0;
1160
1161         if (!arg)
1162                 err = -EINVAL;
1163         if (!err)
1164                 err = loop_get_status(lo, &info64);
1165         if (!err)
1166                 err = loop_info64_to_old(&info64, &info);
1167         if (!err && copy_to_user(arg, &info, sizeof(info)))
1168                 err = -EFAULT;
1169
1170         return err;
1171 }
1172
1173 static int
1174 loop_get_status64(struct loop_device *lo, struct loop_info64 __user *arg) {
1175         struct loop_info64 info64;
1176         int err = 0;
1177
1178         if (!arg)
1179                 err = -EINVAL;
1180         if (!err)
1181                 err = loop_get_status(lo, &info64);
1182         if (!err && copy_to_user(arg, &info64, sizeof(info64)))
1183                 err = -EFAULT;
1184
1185         return err;
1186 }
1187
1188 static int lo_ioctl(struct block_device *bdev, fmode_t mode,
1189         unsigned int cmd, unsigned long arg)
1190 {
1191         struct loop_device *lo = bdev->bd_disk->private_data;
1192         int err;
1193
1194         mutex_lock(&lo->lo_ctl_mutex);
1195         switch (cmd) {
1196         case LOOP_SET_FD:
1197                 err = loop_set_fd(lo, mode, bdev, arg);
1198                 break;
1199         case LOOP_CHANGE_FD:
1200                 err = loop_change_fd(lo, bdev, arg);
1201                 break;
1202         case LOOP_CLR_FD:
1203                 err = loop_clr_fd(lo, bdev);
1204                 break;
1205         case LOOP_SET_STATUS:
1206                 err = loop_set_status_old(lo, (struct loop_info __user *) arg);
1207                 break;
1208         case LOOP_GET_STATUS:
1209                 err = loop_get_status_old(lo, (struct loop_info __user *) arg);
1210                 break;
1211         case LOOP_SET_STATUS64:
1212                 err = loop_set_status64(lo, (struct loop_info64 __user *) arg);
1213                 break;
1214         case LOOP_GET_STATUS64:
1215                 err = loop_get_status64(lo, (struct loop_info64 __user *) arg);
1216                 break;
1217         default:
1218                 err = lo->ioctl ? lo->ioctl(lo, cmd, arg) : -EINVAL;
1219         }
1220         mutex_unlock(&lo->lo_ctl_mutex);
1221         return err;
1222 }
1223
1224 #ifdef CONFIG_COMPAT
1225 struct compat_loop_info {
1226         compat_int_t    lo_number;      /* ioctl r/o */
1227         compat_dev_t    lo_device;      /* ioctl r/o */
1228         compat_ulong_t  lo_inode;       /* ioctl r/o */
1229         compat_dev_t    lo_rdevice;     /* ioctl r/o */
1230         compat_int_t    lo_offset;
1231         compat_int_t    lo_encrypt_type;
1232         compat_int_t    lo_encrypt_key_size;    /* ioctl w/o */
1233         compat_int_t    lo_flags;       /* ioctl r/o */
1234         char            lo_name[LO_NAME_SIZE];
1235         unsigned char   lo_encrypt_key[LO_KEY_SIZE]; /* ioctl w/o */
1236         compat_ulong_t  lo_init[2];
1237         char            reserved[4];
1238 };
1239
1240 /*
1241  * Transfer 32-bit compatibility structure in userspace to 64-bit loop info
1242  * - noinlined to reduce stack space usage in main part of driver
1243  */
1244 static noinline int
1245 loop_info64_from_compat(const struct compat_loop_info __user *arg,
1246                         struct loop_info64 *info64)
1247 {
1248         struct compat_loop_info info;
1249
1250         if (copy_from_user(&info, arg, sizeof(info)))
1251                 return -EFAULT;
1252
1253         memset(info64, 0, sizeof(*info64));
1254         info64->lo_number = info.lo_number;
1255         info64->lo_device = info.lo_device;
1256         info64->lo_inode = info.lo_inode;
1257         info64->lo_rdevice = info.lo_rdevice;
1258         info64->lo_offset = info.lo_offset;
1259         info64->lo_sizelimit = 0;
1260         info64->lo_encrypt_type = info.lo_encrypt_type;
1261         info64->lo_encrypt_key_size = info.lo_encrypt_key_size;
1262         info64->lo_flags = info.lo_flags;
1263         info64->lo_init[0] = info.lo_init[0];
1264         info64->lo_init[1] = info.lo_init[1];
1265         if (info.lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1266                 memcpy(info64->lo_crypt_name, info.lo_name, LO_NAME_SIZE);
1267         else
1268                 memcpy(info64->lo_file_name, info.lo_name, LO_NAME_SIZE);
1269         memcpy(info64->lo_encrypt_key, info.lo_encrypt_key, LO_KEY_SIZE);
1270         return 0;
1271 }
1272
1273 /*
1274  * Transfer 64-bit loop info to 32-bit compatibility structure in userspace
1275  * - noinlined to reduce stack space usage in main part of driver
1276  */
1277 static noinline int
1278 loop_info64_to_compat(const struct loop_info64 *info64,
1279                       struct compat_loop_info __user *arg)
1280 {
1281         struct compat_loop_info info;
1282
1283         memset(&info, 0, sizeof(info));
1284         info.lo_number = info64->lo_number;
1285         info.lo_device = info64->lo_device;
1286         info.lo_inode = info64->lo_inode;
1287         info.lo_rdevice = info64->lo_rdevice;
1288         info.lo_offset = info64->lo_offset;
1289         info.lo_encrypt_type = info64->lo_encrypt_type;
1290         info.lo_encrypt_key_size = info64->lo_encrypt_key_size;
1291         info.lo_flags = info64->lo_flags;
1292         info.lo_init[0] = info64->lo_init[0];
1293         info.lo_init[1] = info64->lo_init[1];
1294         if (info.lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1295                 memcpy(info.lo_name, info64->lo_crypt_name, LO_NAME_SIZE);
1296         else
1297                 memcpy(info.lo_name, info64->lo_file_name, LO_NAME_SIZE);
1298         memcpy(info.lo_encrypt_key, info64->lo_encrypt_key, LO_KEY_SIZE);
1299
1300         /* error in case values were truncated */
1301         if (info.lo_device != info64->lo_device ||
1302             info.lo_rdevice != info64->lo_rdevice ||
1303             info.lo_inode != info64->lo_inode ||
1304             info.lo_offset != info64->lo_offset ||
1305             info.lo_init[0] != info64->lo_init[0] ||
1306             info.lo_init[1] != info64->lo_init[1])
1307                 return -EOVERFLOW;
1308
1309         if (copy_to_user(arg, &info, sizeof(info)))
1310                 return -EFAULT;
1311         return 0;
1312 }
1313
1314 static int
1315 loop_set_status_compat(struct loop_device *lo,
1316                        const struct compat_loop_info __user *arg)
1317 {
1318         struct loop_info64 info64;
1319         int ret;
1320
1321         ret = loop_info64_from_compat(arg, &info64);
1322         if (ret < 0)
1323                 return ret;
1324         return loop_set_status(lo, &info64);
1325 }
1326
1327 static int
1328 loop_get_status_compat(struct loop_device *lo,
1329                        struct compat_loop_info __user *arg)
1330 {
1331         struct loop_info64 info64;
1332         int err = 0;
1333
1334         if (!arg)
1335                 err = -EINVAL;
1336         if (!err)
1337                 err = loop_get_status(lo, &info64);
1338         if (!err)
1339                 err = loop_info64_to_compat(&info64, arg);
1340         return err;
1341 }
1342
1343 static int lo_compat_ioctl(struct block_device *bdev, fmode_t mode,
1344                            unsigned int cmd, unsigned long arg)
1345 {
1346         struct loop_device *lo = bdev->bd_disk->private_data;
1347         int err;
1348
1349         switch(cmd) {
1350         case LOOP_SET_STATUS:
1351                 mutex_lock(&lo->lo_ctl_mutex);
1352                 err = loop_set_status_compat(
1353                         lo, (const struct compat_loop_info __user *) arg);
1354                 mutex_unlock(&lo->lo_ctl_mutex);
1355                 break;
1356         case LOOP_GET_STATUS:
1357                 mutex_lock(&lo->lo_ctl_mutex);
1358                 err = loop_get_status_compat(
1359                         lo, (struct compat_loop_info __user *) arg);
1360                 mutex_unlock(&lo->lo_ctl_mutex);
1361                 break;
1362         case LOOP_CLR_FD:
1363         case LOOP_GET_STATUS64:
1364         case LOOP_SET_STATUS64:
1365                 arg = (unsigned long) compat_ptr(arg);
1366         case LOOP_SET_FD:
1367         case LOOP_CHANGE_FD:
1368                 err = lo_ioctl(bdev, mode, cmd, arg);
1369                 break;
1370         default:
1371                 err = -ENOIOCTLCMD;
1372                 break;
1373         }
1374         return err;
1375 }
1376 #endif
1377
1378 static int lo_open(struct block_device *bdev, fmode_t mode)
1379 {
1380         struct loop_device *lo = bdev->bd_disk->private_data;
1381
1382         mutex_lock(&lo->lo_ctl_mutex);
1383         lo->lo_refcnt++;
1384         mutex_unlock(&lo->lo_ctl_mutex);
1385
1386         return 0;
1387 }
1388
1389 static int lo_release(struct gendisk *disk, fmode_t mode)
1390 {
1391         struct loop_device *lo = disk->private_data;
1392
1393         mutex_lock(&lo->lo_ctl_mutex);
1394
1395         if (--lo->lo_refcnt)
1396                 goto out;
1397
1398         if (lo->lo_flags & LO_FLAGS_AUTOCLEAR) {
1399                 /*
1400                  * In autoclear mode, stop the loop thread
1401                  * and remove configuration after last close.
1402                  */
1403                 loop_clr_fd(lo, NULL);
1404         } else {
1405                 /*
1406                  * Otherwise keep thread (if running) and config,
1407                  * but flush possible ongoing bios in thread.
1408                  */
1409                 loop_flush(lo);
1410         }
1411
1412 out:
1413         mutex_unlock(&lo->lo_ctl_mutex);
1414
1415         return 0;
1416 }
1417
1418 static struct block_device_operations lo_fops = {
1419         .owner =        THIS_MODULE,
1420         .open =         lo_open,
1421         .release =      lo_release,
1422         .ioctl =        lo_ioctl,
1423 #ifdef CONFIG_COMPAT
1424         .compat_ioctl = lo_compat_ioctl,
1425 #endif
1426 };
1427
1428 /*
1429  * And now the modules code and kernel interface.
1430  */
1431 static int max_loop;
1432 module_param(max_loop, int, 0);
1433 MODULE_PARM_DESC(max_loop, "Maximum number of loop devices");
1434 module_param(max_part, int, 0);
1435 MODULE_PARM_DESC(max_part, "Maximum number of partitions per loop device");
1436 MODULE_LICENSE("GPL");
1437 MODULE_ALIAS_BLOCKDEV_MAJOR(LOOP_MAJOR);
1438
1439 int loop_register_transfer(struct loop_func_table *funcs)
1440 {
1441         unsigned int n = funcs->number;
1442
1443         if (n >= MAX_LO_CRYPT || xfer_funcs[n])
1444                 return -EINVAL;
1445         xfer_funcs[n] = funcs;
1446         return 0;
1447 }
1448
1449 int loop_unregister_transfer(int number)
1450 {
1451         unsigned int n = number;
1452         struct loop_device *lo;
1453         struct loop_func_table *xfer;
1454
1455         if (n == 0 || n >= MAX_LO_CRYPT || (xfer = xfer_funcs[n]) == NULL)
1456                 return -EINVAL;
1457
1458         xfer_funcs[n] = NULL;
1459
1460         list_for_each_entry(lo, &loop_devices, lo_list) {
1461                 mutex_lock(&lo->lo_ctl_mutex);
1462
1463                 if (lo->lo_encryption == xfer)
1464                         loop_release_xfer(lo);
1465
1466                 mutex_unlock(&lo->lo_ctl_mutex);
1467         }
1468
1469         return 0;
1470 }
1471
1472 EXPORT_SYMBOL(loop_register_transfer);
1473 EXPORT_SYMBOL(loop_unregister_transfer);
1474
1475 static struct loop_device *loop_alloc(int i)
1476 {
1477         struct loop_device *lo;
1478         struct gendisk *disk;
1479
1480         lo = kzalloc(sizeof(*lo), GFP_KERNEL);
1481         if (!lo)
1482                 goto out;
1483
1484         lo->lo_queue = blk_alloc_queue(GFP_KERNEL);
1485         if (!lo->lo_queue)
1486                 goto out_free_dev;
1487
1488         disk = lo->lo_disk = alloc_disk(1 << part_shift);
1489         if (!disk)
1490                 goto out_free_queue;
1491
1492         mutex_init(&lo->lo_ctl_mutex);
1493         lo->lo_number           = i;
1494         lo->lo_thread           = NULL;
1495         init_waitqueue_head(&lo->lo_event);
1496         spin_lock_init(&lo->lo_lock);
1497         disk->major             = LOOP_MAJOR;
1498         disk->first_minor       = i << part_shift;
1499         disk->fops              = &lo_fops;
1500         disk->private_data      = lo;
1501         disk->queue             = lo->lo_queue;
1502         sprintf(disk->disk_name, "loop%d", i);
1503         return lo;
1504
1505 out_free_queue:
1506         blk_cleanup_queue(lo->lo_queue);
1507 out_free_dev:
1508         kfree(lo);
1509 out:
1510         return NULL;
1511 }
1512
1513 static void loop_free(struct loop_device *lo)
1514 {
1515         blk_cleanup_queue(lo->lo_queue);
1516         put_disk(lo->lo_disk);
1517         list_del(&lo->lo_list);
1518         kfree(lo);
1519 }
1520
1521 static struct loop_device *loop_init_one(int i)
1522 {
1523         struct loop_device *lo;
1524
1525         list_for_each_entry(lo, &loop_devices, lo_list) {
1526                 if (lo->lo_number == i)
1527                         return lo;
1528         }
1529
1530         lo = loop_alloc(i);
1531         if (lo) {
1532                 add_disk(lo->lo_disk);
1533                 list_add_tail(&lo->lo_list, &loop_devices);
1534         }
1535         return lo;
1536 }
1537
1538 static void loop_del_one(struct loop_device *lo)
1539 {
1540         del_gendisk(lo->lo_disk);
1541         loop_free(lo);
1542 }
1543
1544 static struct kobject *loop_probe(dev_t dev, int *part, void *data)
1545 {
1546         struct loop_device *lo;
1547         struct kobject *kobj;
1548
1549         mutex_lock(&loop_devices_mutex);
1550         lo = loop_init_one(dev & MINORMASK);
1551         kobj = lo ? get_disk(lo->lo_disk) : ERR_PTR(-ENOMEM);
1552         mutex_unlock(&loop_devices_mutex);
1553
1554         *part = 0;
1555         return kobj;
1556 }
1557
1558 static int __init loop_init(void)
1559 {
1560         int i, nr;
1561         unsigned long range;
1562         struct loop_device *lo, *next;
1563
1564         /*
1565          * loop module now has a feature to instantiate underlying device
1566          * structure on-demand, provided that there is an access dev node.
1567          * However, this will not work well with user space tool that doesn't
1568          * know about such "feature".  In order to not break any existing
1569          * tool, we do the following:
1570          *
1571          * (1) if max_loop is specified, create that many upfront, and this
1572          *     also becomes a hard limit.
1573          * (2) if max_loop is not specified, create 8 loop device on module
1574          *     load, user can further extend loop device by create dev node
1575          *     themselves and have kernel automatically instantiate actual
1576          *     device on-demand.
1577          */
1578
1579         part_shift = 0;
1580         if (max_part > 0)
1581                 part_shift = fls(max_part);
1582
1583         if (max_loop > 1UL << (MINORBITS - part_shift))
1584                 return -EINVAL;
1585
1586         if (max_loop) {
1587                 nr = max_loop;
1588                 range = max_loop;
1589         } else {
1590                 nr = 8;
1591                 range = 1UL << (MINORBITS - part_shift);
1592         }
1593
1594         if (register_blkdev(LOOP_MAJOR, "loop"))
1595                 return -EIO;
1596
1597         for (i = 0; i < nr; i++) {
1598                 lo = loop_alloc(i);
1599                 if (!lo)
1600                         goto Enomem;
1601                 list_add_tail(&lo->lo_list, &loop_devices);
1602         }
1603
1604         /* point of no return */
1605
1606         list_for_each_entry(lo, &loop_devices, lo_list)
1607                 add_disk(lo->lo_disk);
1608
1609         blk_register_region(MKDEV(LOOP_MAJOR, 0), range,
1610                                   THIS_MODULE, loop_probe, NULL, NULL);
1611
1612         printk(KERN_INFO "loop: module loaded\n");
1613         return 0;
1614
1615 Enomem:
1616         printk(KERN_INFO "loop: out of memory\n");
1617
1618         list_for_each_entry_safe(lo, next, &loop_devices, lo_list)
1619                 loop_free(lo);
1620
1621         unregister_blkdev(LOOP_MAJOR, "loop");
1622         return -ENOMEM;
1623 }
1624
1625 static void __exit loop_exit(void)
1626 {
1627         unsigned long range;
1628         struct loop_device *lo, *next;
1629
1630         range = max_loop ? max_loop :  1UL << (MINORBITS - part_shift);
1631
1632         list_for_each_entry_safe(lo, next, &loop_devices, lo_list)
1633                 loop_del_one(lo);
1634
1635         blk_unregister_region(MKDEV(LOOP_MAJOR, 0), range);
1636         unregister_blkdev(LOOP_MAJOR, "loop");
1637 }
1638
1639 module_init(loop_init);
1640 module_exit(loop_exit);
1641
1642 #ifndef MODULE
1643 static int __init max_loop_setup(char *str)
1644 {
1645         max_loop = simple_strtol(str, NULL, 0);
1646         return 1;
1647 }
1648
1649 __setup("max_loop=", max_loop_setup);
1650 #endif