drivers/block/loop.c

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