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/compat.h>
  67 #include <linux/suspend.h>
  68 #include <linux/freezer.h>
  69 #include <linux/mutex.h>
  70 #include <linux/writeback.h>
  71 #include <linux/completion.h>
  72 #include <linux/highmem.h>
  73 #include <linux/kthread.h>
  74 #include <linux/splice.h>
  75 #include <linux/sysfs.h>
  76 #include <linux/miscdevice.h>
  77 #include <linux/falloc.h>
  78 #include <linux/uio.h>
  79 #include "loop.h"
  80
  81 #include <asm/uaccess.h>
  82
  83 static DEFINE_IDR(loop_index_idr);
  84 static DEFINE_MUTEX(loop_index_mutex);
  85
  86 static int max_part;
  87 static int part_shift;
  88
  89 static int transfer_xor(struct loop_device *lo, int cmd,
  90                         struct page *raw_page, unsigned raw_off,
  91                         struct page *loop_page, unsigned loop_off,
  92                         int size, sector_t real_block)
  93 {
  94         char *raw_buf = kmap_atomic(raw_page) + raw_off;
  95         char *loop_buf = kmap_atomic(loop_page) + loop_off;
  96         char *in, *out, *key;
  97         int i, keysize;
  98
  99         if (cmd == READ) {
 100                 in = raw_buf;
 101                 out = loop_buf;
 102         } else {
 103                 in = loop_buf;
 104                 out = raw_buf;
 105         }
 106
 107         key = lo->lo_encrypt_key;
 108         keysize = lo->lo_encrypt_key_size;
 109         for (i = 0; i < size; i++)
 110                 *out++ = *in++ ^ key[(i & 511) % keysize];
 111
 112         kunmap_atomic(loop_buf);
 113         kunmap_atomic(raw_buf);
 114         cond_resched();
 115         return 0;
 116 }
 117
 118 static int xor_init(struct loop_device *lo, const struct loop_info64 *info)
 119 {
 120         if (unlikely(info->lo_encrypt_key_size <= 0))
 121                 return -EINVAL;
 122         return 0;
 123 }
 124
 125 static struct loop_func_table none_funcs = {
 126         .number = LO_CRYPT_NONE,
 127 };
 128
 129 static struct loop_func_table xor_funcs = {
 130         .number = LO_CRYPT_XOR,
 131         .transfer = transfer_xor,
 132         .init = xor_init
 133 };
 134
 135 /* xfer_funcs[0] is special - its release function is never called */
 136 static struct loop_func_table *xfer_funcs[MAX_LO_CRYPT] = {
 137         &none_funcs,
 138         &xor_funcs
 139 };
 140
 141 static loff_t get_size(loff_t offset, loff_t sizelimit, struct file *file)
 142 {
 143         loff_t loopsize;
 144
 145         /* Compute loopsize in bytes */
 146         loopsize = i_size_read(file->f_mapping->host);
 147         if (offset > 0)
 148                 loopsize -= offset;
 149         /* offset is beyond i_size, weird but possible */
 150         if (loopsize < 0)
 151                 return 0;
 152
 153         if (sizelimit > 0 && sizelimit < loopsize)
 154                 loopsize = sizelimit;
 155         /*
 156          * Unfortunately, if we want to do I/O on the device,
 157          * the number of 512-byte sectors has to fit into a sector_t.
 158          */
 159         return loopsize >> 9;
 160 }
 161
 162 static loff_t get_loop_size(struct loop_device *lo, struct file *file)
 163 {
 164         return get_size(lo->lo_offset, lo->lo_sizelimit, file);
 165 }
 166
 167 static void __loop_update_dio(struct loop_device *lo, bool dio)
 168 {
 169         struct file *file = lo->lo_backing_file;
 170         struct address_space *mapping = file->f_mapping;
 171         struct inode *inode = mapping->host;
 172         unsigned short sb_bsize = 0;
 173         unsigned dio_align = 0;
 174         bool use_dio;
 175
 176         if (inode->i_sb->s_bdev) {
 177                 sb_bsize = bdev_logical_block_size(inode->i_sb->s_bdev);
 178                 dio_align = sb_bsize - 1;
 179         }
 180
 181         /*
 182          * We support direct I/O only if lo_offset is aligned with the
 183          * logical I/O size of backing device, and the logical block
 184          * size of loop is bigger than the backing device's and the loop
 185          * needn't transform transfer.
 186          *
 187          * TODO: the above condition may be loosed in the future, and
 188          * direct I/O may be switched runtime at that time because most
 189          * of requests in sane appplications should be PAGE_SIZE algined
 190          */
 191         if (dio) {
 192                 if (queue_logical_block_size(lo->lo_queue) >= sb_bsize &&
 193                                 !(lo->lo_offset & dio_align) &&
 194                                 mapping->a_ops->direct_IO &&
 195                                 !lo->transfer)
 196                         use_dio = true;
 197                 else
 198                         use_dio = false;
 199         } else {
 200                 use_dio = false;
 201         }
 202
 203         if (lo->use_dio == use_dio)
 204                 return;
 205
 206         /* flush dirty pages before changing direct IO */
 207         vfs_fsync(file, 0);
 208
 209         /*
 210          * The flag of LO_FLAGS_DIRECT_IO is handled similarly with
 211          * LO_FLAGS_READ_ONLY, both are set from kernel, and losetup
 212          * will get updated by ioctl(LOOP_GET_STATUS)
 213          */
 214         blk_mq_freeze_queue(lo->lo_queue);
 215         lo->use_dio = use_dio;
 216         if (use_dio)
 217                 lo->lo_flags |= LO_FLAGS_DIRECT_IO;
 218         else
 219                 lo->lo_flags &= ~LO_FLAGS_DIRECT_IO;
 220         blk_mq_unfreeze_queue(lo->lo_queue);
 221 }
 222
 223 static int
 224 figure_loop_size(struct loop_device *lo, loff_t offset, loff_t sizelimit)
 225 {
 226         loff_t size = get_size(offset, sizelimit, lo->lo_backing_file);
 227         sector_t x = (sector_t)size;
 228         struct block_device *bdev = lo->lo_device;
 229
 230         if (unlikely((loff_t)x != size))
 231                 return -EFBIG;
 232         if (lo->lo_offset != offset)
 233                 lo->lo_offset = offset;
 234         if (lo->lo_sizelimit != sizelimit)
 235                 lo->lo_sizelimit = sizelimit;
 236         set_capacity(lo->lo_disk, x);
 237         bd_set_size(bdev, (loff_t)get_capacity(bdev->bd_disk) << 9);
 238         /* let user-space know about the new size */
 239         kobject_uevent(&disk_to_dev(bdev->bd_disk)->kobj, KOBJ_CHANGE);
 240         return 0;
 241 }
 242
 243 static inline int
 244 lo_do_transfer(struct loop_device *lo, int cmd,
 245                struct page *rpage, unsigned roffs,
 246                struct page *lpage, unsigned loffs,
 247                int size, sector_t rblock)
 248 {
 249         int ret;
 250
 251         ret = lo->transfer(lo, cmd, rpage, roffs, lpage, loffs, size, rblock);
 252         if (likely(!ret))
 253                 return 0;
 254
 255         printk_ratelimited(KERN_ERR
 256                 "loop: Transfer error at byte offset %llu, length %i.\n",
 257                 (unsigned long long)rblock << 9, size);
 258         return ret;
 259 }
 260
 261 static int lo_write_bvec(struct file *file, struct bio_vec *bvec, loff_t *ppos)
 262 {
 263         struct iov_iter i;
 264         ssize_t bw;
 265
 266         iov_iter_bvec(&i, ITER_BVEC | WRITE, bvec, 1, bvec->bv_len);
 267
 268         file_start_write(file);
 269         bw = vfs_iter_write(file, &i, ppos);
 270         file_end_write(file);
 271
 272         if (likely(bw ==  bvec->bv_len))
 273                 return 0;
 274
 275         printk_ratelimited(KERN_ERR
 276                 "loop: Write error at byte offset %llu, length %i.\n",
 277                 (unsigned long long)*ppos, bvec->bv_len);
 278         if (bw >= 0)
 279                 bw = -EIO;
 280         return bw;
 281 }
 282
 283 static int lo_write_simple(struct loop_device *lo, struct request *rq,
 284                 loff_t pos)
 285 {
 286         struct bio_vec bvec;
 287         struct req_iterator iter;
 288         int ret = 0;
 289
 290         rq_for_each_segment(bvec, rq, iter) {
 291                 ret = lo_write_bvec(lo->lo_backing_file, &bvec, &pos);
 292                 if (ret < 0)
 293                         break;
 294                 cond_resched();
 295         }
 296
 297         return ret;
 298 }
 299
 300 /*
 301  * This is the slow, transforming version that needs to double buffer the
 302  * data as it cannot do the transformations in place without having direct
 303  * access to the destination pages of the backing file.
 304  */
 305 static int lo_write_transfer(struct loop_device *lo, struct request *rq,
 306                 loff_t pos)
 307 {
 308         struct bio_vec bvec, b;
 309         struct req_iterator iter;
 310         struct page *page;
 311         int ret = 0;
 312
 313         page = alloc_page(GFP_NOIO);
 314         if (unlikely(!page))
 315                 return -ENOMEM;
 316
 317         rq_for_each_segment(bvec, rq, iter) {
 318                 ret = lo_do_transfer(lo, WRITE, page, 0, bvec.bv_page,
 319                         bvec.bv_offset, bvec.bv_len, pos >> 9);
 320                 if (unlikely(ret))
 321                         break;
 322
 323                 b.bv_page = page;
 324                 b.bv_offset = 0;
 325                 b.bv_len = bvec.bv_len;
 326                 ret = lo_write_bvec(lo->lo_backing_file, &b, &pos);
 327                 if (ret < 0)
 328                         break;
 329         }
 330
 331         __free_page(page);
 332         return ret;
 333 }
 334
 335 static int lo_read_simple(struct loop_device *lo, struct request *rq,
 336                 loff_t pos)
 337 {
 338         struct bio_vec bvec;
 339         struct req_iterator iter;
 340         struct iov_iter i;
 341         ssize_t len;
 342
 343         rq_for_each_segment(bvec, rq, iter) {
 344                 iov_iter_bvec(&i, ITER_BVEC, &bvec, 1, bvec.bv_len);
 345                 len = vfs_iter_read(lo->lo_backing_file, &i, &pos);
 346                 if (len < 0)
 347                         return len;
 348
 349                 flush_dcache_page(bvec.bv_page);
 350
 351                 if (len != bvec.bv_len) {
 352                         struct bio *bio;
 353
 354                         __rq_for_each_bio(bio, rq)
 355                                 zero_fill_bio(bio);
 356                         break;
 357                 }
 358                 cond_resched();
 359         }
 360
 361         return 0;
 362 }
 363
 364 static int lo_read_transfer(struct loop_device *lo, struct request *rq,
 365                 loff_t pos)
 366 {
 367         struct bio_vec bvec, b;
 368         struct req_iterator iter;
 369         struct iov_iter i;
 370         struct page *page;
 371         ssize_t len;
 372         int ret = 0;
 373
 374         page = alloc_page(GFP_NOIO);
 375         if (unlikely(!page))
 376                 return -ENOMEM;
 377
 378         rq_for_each_segment(bvec, rq, iter) {
 379                 loff_t offset = pos;
 380
 381                 b.bv_page = page;
 382                 b.bv_offset = 0;
 383                 b.bv_len = bvec.bv_len;
 384
 385                 iov_iter_bvec(&i, ITER_BVEC, &b, 1, b.bv_len);
 386                 len = vfs_iter_read(lo->lo_backing_file, &i, &pos);
 387                 if (len < 0) {
 388                         ret = len;
 389                         goto out_free_page;
 390                 }
 391
 392                 ret = lo_do_transfer(lo, READ, page, 0, bvec.bv_page,
 393                         bvec.bv_offset, len, offset >> 9);
 394                 if (ret)
 395                         goto out_free_page;
 396
 397                 flush_dcache_page(bvec.bv_page);
 398
 399                 if (len != bvec.bv_len) {
 400                         struct bio *bio;
 401
 402                         __rq_for_each_bio(bio, rq)
 403                                 zero_fill_bio(bio);
 404                         break;
 405                 }
 406         }
 407
 408         ret = 0;
 409 out_free_page:
 410         __free_page(page);
 411         return ret;
 412 }
 413
 414 static int lo_discard(struct loop_device *lo, struct request *rq, loff_t pos)
 415 {
 416         /*
 417          * We use punch hole to reclaim the free space used by the
 418          * image a.k.a. discard. However we do not support discard if
 419          * encryption is enabled, because it may give an attacker
 420          * useful information.
 421          */
 422         struct file *file = lo->lo_backing_file;
 423         int mode = FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE;
 424         int ret;
 425
 426         if ((!file->f_op->fallocate) || lo->lo_encrypt_key_size) {
 427                 ret = -EOPNOTSUPP;
 428                 goto out;
 429         }
 430
 431         ret = file->f_op->fallocate(file, mode, pos, blk_rq_bytes(rq));
 432         if (unlikely(ret && ret != -EINVAL && ret != -EOPNOTSUPP))
 433                 ret = -EIO;
 434  out:
 435         return ret;
 436 }
 437
 438 static int lo_req_flush(struct loop_device *lo, struct request *rq)
 439 {
 440         struct file *file = lo->lo_backing_file;
 441         int ret = vfs_fsync(file, 0);
 442         if (unlikely(ret && ret != -EINVAL))
 443                 ret = -EIO;
 444
 445         return ret;
 446 }
 447
 448 static inline void handle_partial_read(struct loop_cmd *cmd, long bytes)
 449 {
 450         if (bytes < 0 || op_is_write(req_op(cmd->rq)))
 451                 return;
 452
 453         if (unlikely(bytes < blk_rq_bytes(cmd->rq))) {
 454                 struct bio *bio = cmd->rq->bio;
 455
 456                 bio_advance(bio, bytes);
 457                 zero_fill_bio(bio);
 458         }
 459 }
 460
 461 static void lo_rw_aio_complete(struct kiocb *iocb, long ret, long ret2)
 462 {
 463         struct loop_cmd *cmd = container_of(iocb, struct loop_cmd, iocb);
 464         struct request *rq = cmd->rq;
 465
 466         handle_partial_read(cmd, ret);
 467
 468         if (ret > 0)
 469                 ret = 0;
 470         else if (ret < 0)
 471                 ret = -EIO;
 472
 473         blk_mq_complete_request(rq, ret);
 474 }
 475
 476 static int lo_rw_aio(struct loop_device *lo, struct loop_cmd *cmd,
 477                      loff_t pos, bool rw)
 478 {
 479         struct iov_iter iter;
 480         struct bio_vec *bvec;
 481         struct bio *bio = cmd->rq->bio;
 482         struct file *file = lo->lo_backing_file;
 483         int ret;
 484
 485         /* nomerge for loop request queue */
 486         WARN_ON(cmd->rq->bio != cmd->rq->biotail);
 487
 488         bvec = __bvec_iter_bvec(bio->bi_io_vec, bio->bi_iter);
 489         iov_iter_bvec(&iter, ITER_BVEC | rw, bvec,
 490                       bio_segments(bio), blk_rq_bytes(cmd->rq));
 491         /*
 492          * This bio may be started from the middle of the 'bvec'
 493          * because of bio splitting, so offset from the bvec must
 494          * be passed to iov iterator
 495          */
 496         iter.iov_offset = bio->bi_iter.bi_bvec_done;
 497
 498         cmd->iocb.ki_pos = pos;
 499         cmd->iocb.ki_filp = file;
 500         cmd->iocb.ki_complete = lo_rw_aio_complete;
 501         cmd->iocb.ki_flags = IOCB_DIRECT;
 502
 503         if (rw == WRITE)
 504                 ret = file->f_op->write_iter(&cmd->iocb, &iter);
 505         else
 506                 ret = file->f_op->read_iter(&cmd->iocb, &iter);
 507
 508         if (ret != -EIOCBQUEUED)
 509                 cmd->iocb.ki_complete(&cmd->iocb, ret, 0);
 510         return 0;
 511 }
 512
 513 static int do_req_filebacked(struct loop_device *lo, struct request *rq)
 514 {
 515         struct loop_cmd *cmd = blk_mq_rq_to_pdu(rq);
 516         loff_t pos = ((loff_t) blk_rq_pos(rq) << 9) + lo->lo_offset;
 517
 518         /*
 519          * lo_write_simple and lo_read_simple should have been covered
 520          * by io submit style function like lo_rw_aio(), one blocker
 521          * is that lo_read_simple() need to call flush_dcache_page after
 522          * the page is written from kernel, and it isn't easy to handle
 523          * this in io submit style function which submits all segments
 524          * of the req at one time. And direct read IO doesn't need to
 525          * run flush_dcache_page().
 526          */
 527         switch (req_op(rq)) {
 528         case REQ_OP_FLUSH:
 529                 return lo_req_flush(lo, rq);
 530         case REQ_OP_DISCARD:
 531                 return lo_discard(lo, rq, pos);
 532         case REQ_OP_WRITE:
 533                 if (lo->transfer)
 534                         return lo_write_transfer(lo, rq, pos);
 535                 else if (cmd->use_aio)
 536                         return lo_rw_aio(lo, cmd, pos, WRITE);
 537                 else
 538                         return lo_write_simple(lo, rq, pos);
 539         case REQ_OP_READ:
 540                 if (lo->transfer)
 541                         return lo_read_transfer(lo, rq, pos);
 542                 else if (cmd->use_aio)
 543                         return lo_rw_aio(lo, cmd, pos, READ);
 544                 else
 545                         return lo_read_simple(lo, rq, pos);
 546         default:
 547                 WARN_ON_ONCE(1);
 548                 return -EIO;
 549                 break;
 550         }
 551 }
 552
 553 struct switch_request {
 554         struct file *file;
 555         struct completion wait;
 556 };
 557
 558 static inline void loop_update_dio(struct loop_device *lo)
 559 {
 560         __loop_update_dio(lo, io_is_direct(lo->lo_backing_file) |
 561                         lo->use_dio);
 562 }
 563
 564 /*
 565  * Do the actual switch; called from the BIO completion routine
 566  */
 567 static void do_loop_switch(struct loop_device *lo, struct switch_request *p)
 568 {
 569         struct file *file = p->file;
 570         struct file *old_file = lo->lo_backing_file;
 571         struct address_space *mapping;
 572
 573         /* if no new file, only flush of queued bios requested */
 574         if (!file)
 575                 return;
 576
 577         mapping = file->f_mapping;
 578         mapping_set_gfp_mask(old_file->f_mapping, lo->old_gfp_mask);
 579         lo->lo_backing_file = file;
 580         lo->lo_blocksize = S_ISBLK(mapping->host->i_mode) ?
 581                 mapping->host->i_bdev->bd_block_size : PAGE_SIZE;
 582         lo->old_gfp_mask = mapping_gfp_mask(mapping);
 583         mapping_set_gfp_mask(mapping, lo->old_gfp_mask & ~(__GFP_IO|__GFP_FS));
 584         loop_update_dio(lo);
 585 }
 586
 587 /*
 588  * loop_switch performs the hard work of switching a backing store.
 589  * First it needs to flush existing IO, it does this by sending a magic
 590  * BIO down the pipe. The completion of this BIO does the actual switch.
 591  */
 592 static int loop_switch(struct loop_device *lo, struct file *file)
 593 {
 594         struct switch_request w;
 595
 596         w.file = file;
 597
 598         /* freeze queue and wait for completion of scheduled requests */
 599         blk_mq_freeze_queue(lo->lo_queue);
 600
 601         /* do the switch action */
 602         do_loop_switch(lo, &w);
 603
 604         /* unfreeze */
 605         blk_mq_unfreeze_queue(lo->lo_queue);
 606
 607         return 0;
 608 }
 609
 610 /*
 611  * Helper to flush the IOs in loop, but keeping loop thread running
 612  */
 613 static int loop_flush(struct loop_device *lo)
 614 {
 615         /* loop not yet configured, no running thread, nothing to flush */
 616         if (lo->lo_state != Lo_bound)
 617                 return 0;
 618         return loop_switch(lo, NULL);
 619 }
 620
 621 static void loop_reread_partitions(struct loop_device *lo,
 622                                    struct block_device *bdev)
 623 {
 624         int rc;
 625
 626         /*
 627          * bd_mutex has been held already in release path, so don't
 628          * acquire it if this function is called in such case.
 629          *
 630          * If the reread partition isn't from release path, lo_refcnt
 631          * must be at least one and it can only become zero when the
 632          * current holder is released.
 633          */
 634         if (!atomic_read(&lo->lo_refcnt))
 635                 rc = __blkdev_reread_part(bdev);
 636         else
 637                 rc = blkdev_reread_part(bdev);
 638         if (rc)
 639                 pr_warn("%s: partition scan of loop%d (%s) failed (rc=%d)\n",
 640                         __func__, lo->lo_number, lo->lo_file_name, rc);
 641 }
 642
 643 static inline int is_loop_device(struct file *file)
 644 {
 645         struct inode *i = file->f_mapping->host;
 646
 647         return i && S_ISBLK(i->i_mode) && MAJOR(i->i_rdev) == LOOP_MAJOR;
 648 }
 649
 650 static int loop_validate_file(struct file *file, struct block_device *bdev)
 651 {
 652         struct inode    *inode = file->f_mapping->host;
 653         struct file     *f = file;
 654
 655         /* Avoid recursion */
 656         while (is_loop_device(f)) {
 657                 struct loop_device *l;
 658
 659                 if (f->f_mapping->host->i_bdev == bdev)
 660                         return -EBADF;
 661
 662                 l = f->f_mapping->host->i_bdev->bd_disk->private_data;
 663                 if (l->lo_state == Lo_unbound) {
 664                         return -EINVAL;
 665                 }
 666                 f = l->lo_backing_file;
 667         }
 668         if (!S_ISREG(inode->i_mode) && !S_ISBLK(inode->i_mode))
 669                 return -EINVAL;
 670         return 0;
 671 }
 672
 673 /*
 674  * loop_change_fd switched the backing store of a loopback device to
 675  * a new file. This is useful for operating system installers to free up
 676  * the original file and in High Availability environments to switch to
 677  * an alternative location for the content in case of server meltdown.
 678  * This can only work if the loop device is used read-only, and if the
 679  * new backing store is the same size and type as the old backing store.
 680  */
 681 static int loop_change_fd(struct loop_device *lo, struct block_device *bdev,
 682                           unsigned int arg)
 683 {
 684         struct file     *file, *old_file;
 685         struct inode    *inode;
 686         int             error;
 687
 688         error = -ENXIO;
 689         if (lo->lo_state != Lo_bound)
 690                 goto out;
 691
 692         /* the loop device has to be read-only */
 693         error = -EINVAL;
 694         if (!(lo->lo_flags & LO_FLAGS_READ_ONLY))
 695                 goto out;
 696
 697         error = -EBADF;
 698         file = fget(arg);
 699         if (!file)
 700                 goto out;
 701
 702         error = loop_validate_file(file, bdev);
 703         if (error)
 704                 goto out_putf;
 705
 706         inode = file->f_mapping->host;
 707         old_file = lo->lo_backing_file;
 708
 709         error = -EINVAL;
 710
 711         /* size of the new backing store needs to be the same */
 712         if (get_loop_size(lo, file) != get_loop_size(lo, old_file))
 713                 goto out_putf;
 714
 715         /* and ... switch */
 716         error = loop_switch(lo, file);
 717         if (error)
 718                 goto out_putf;
 719
 720         fput(old_file);
 721         if (lo->lo_flags & LO_FLAGS_PARTSCAN)
 722                 loop_reread_partitions(lo, bdev);
 723         return 0;
 724
 725  out_putf:
 726         fput(file);
 727  out:
 728         return error;
 729 }
 730
 731 /* loop sysfs attributes */
 732
 733 static ssize_t loop_attr_show(struct device *dev, char *page,
 734                               ssize_t (*callback)(struct loop_device *, char *))
 735 {
 736         struct gendisk *disk = dev_to_disk(dev);
 737         struct loop_device *lo = disk->private_data;
 738
 739         return callback(lo, page);
 740 }
 741
 742 #define LOOP_ATTR_RO(_name)                                             \
 743 static ssize_t loop_attr_##_name##_show(struct loop_device *, char *);  \
 744 static ssize_t loop_attr_do_show_##_name(struct device *d,              \
 745                                 struct device_attribute *attr, char *b) \
 746 {                                                                       \
 747         return loop_attr_show(d, b, loop_attr_##_name##_show);          \
 748 }                                                                       \
 749 static struct device_attribute loop_attr_##_name =                      \
 750         __ATTR(_name, S_IRUGO, loop_attr_do_show_##_name, NULL);
 751
 752 static ssize_t loop_attr_backing_file_show(struct loop_device *lo, char *buf)
 753 {
 754         ssize_t ret;
 755         char *p = NULL;
 756
 757         spin_lock_irq(&lo->lo_lock);
 758         if (lo->lo_backing_file)
 759                 p = file_path(lo->lo_backing_file, buf, PAGE_SIZE - 1);
 760         spin_unlock_irq(&lo->lo_lock);
 761
 762         if (IS_ERR_OR_NULL(p))
 763                 ret = PTR_ERR(p);
 764         else {
 765                 ret = strlen(p);
 766                 memmove(buf, p, ret);
 767                 buf[ret++] = '\n';
 768                 buf[ret] = 0;
 769         }
 770
 771         return ret;
 772 }
 773
 774 static ssize_t loop_attr_offset_show(struct loop_device *lo, char *buf)
 775 {
 776         return sprintf(buf, "%llu\n", (unsigned long long)lo->lo_offset);
 777 }
 778
 779 static ssize_t loop_attr_sizelimit_show(struct loop_device *lo, char *buf)
 780 {
 781         return sprintf(buf, "%llu\n", (unsigned long long)lo->lo_sizelimit);
 782 }
 783
 784 static ssize_t loop_attr_autoclear_show(struct loop_device *lo, char *buf)
 785 {
 786         int autoclear = (lo->lo_flags & LO_FLAGS_AUTOCLEAR);
 787
 788         return sprintf(buf, "%s\n", autoclear ? "1" : "0");
 789 }
 790
 791 static ssize_t loop_attr_partscan_show(struct loop_device *lo, char *buf)
 792 {
 793         int partscan = (lo->lo_flags & LO_FLAGS_PARTSCAN);
 794
 795         return sprintf(buf, "%s\n", partscan ? "1" : "0");
 796 }
 797
 798 static ssize_t loop_attr_dio_show(struct loop_device *lo, char *buf)
 799 {
 800         int dio = (lo->lo_flags & LO_FLAGS_DIRECT_IO);
 801
 802         return sprintf(buf, "%s\n", dio ? "1" : "0");
 803 }
 804
 805 LOOP_ATTR_RO(backing_file);
 806 LOOP_ATTR_RO(offset);
 807 LOOP_ATTR_RO(sizelimit);
 808 LOOP_ATTR_RO(autoclear);
 809 LOOP_ATTR_RO(partscan);
 810 LOOP_ATTR_RO(dio);
 811
 812 static struct attribute *loop_attrs[] = {
 813         &loop_attr_backing_file.attr,
 814         &loop_attr_offset.attr,
 815         &loop_attr_sizelimit.attr,
 816         &loop_attr_autoclear.attr,
 817         &loop_attr_partscan.attr,
 818         &loop_attr_dio.attr,
 819         NULL,
 820 };
 821
 822 static struct attribute_group loop_attribute_group = {
 823         .name = "loop",
 824         .attrs= loop_attrs,
 825 };
 826
 827 static void loop_sysfs_init(struct loop_device *lo)
 828 {
 829         lo->sysfs_inited = !sysfs_create_group(&disk_to_dev(lo->lo_disk)->kobj,
 830                                                 &loop_attribute_group);
 831 }
 832
 833 static void loop_sysfs_exit(struct loop_device *lo)
 834 {
 835         if (lo->sysfs_inited)
 836                 sysfs_remove_group(&disk_to_dev(lo->lo_disk)->kobj,
 837                                    &loop_attribute_group);
 838 }
 839
 840 static void loop_config_discard(struct loop_device *lo)
 841 {
 842         struct file *file = lo->lo_backing_file;
 843         struct inode *inode = file->f_mapping->host;
 844         struct request_queue *q = lo->lo_queue;
 845
 846         /*
 847          * We use punch hole to reclaim the free space used by the
 848          * image a.k.a. discard. However we do not support discard if
 849          * encryption is enabled, because it may give an attacker
 850          * useful information.
 851          */
 852         if ((!file->f_op->fallocate) ||
 853             lo->lo_encrypt_key_size) {
 854                 q->limits.discard_granularity = 0;
 855                 q->limits.discard_alignment = 0;
 856                 blk_queue_max_discard_sectors(q, 0);
 857                 q->limits.discard_zeroes_data = 0;
 858                 queue_flag_clear_unlocked(QUEUE_FLAG_DISCARD, q);
 859                 return;
 860         }
 861
 862         q->limits.discard_granularity = inode->i_sb->s_blocksize;
 863         q->limits.discard_alignment = 0;
 864         blk_queue_max_discard_sectors(q, UINT_MAX >> 9);
 865         q->limits.discard_zeroes_data = 1;
 866         queue_flag_set_unlocked(QUEUE_FLAG_DISCARD, q);
 867 }
 868
 869 static void loop_unprepare_queue(struct loop_device *lo)
 870 {
 871         kthread_flush_worker(&lo->worker);
 872         kthread_stop(lo->worker_task);
 873 }
 874
 875 static int loop_prepare_queue(struct loop_device *lo)
 876 {
 877         kthread_init_worker(&lo->worker);
 878         lo->worker_task = kthread_run(kthread_worker_fn,
 879                         &lo->worker, "loop%d", lo->lo_number);
 880         if (IS_ERR(lo->worker_task))
 881                 return -ENOMEM;
 882         set_user_nice(lo->worker_task, MIN_NICE);
 883         return 0;
 884 }
 885
 886 static int loop_set_fd(struct loop_device *lo, fmode_t mode,
 887                        struct block_device *bdev, unsigned int arg)
 888 {
 889         struct file     *file;
 890         struct inode    *inode;
 891         struct address_space *mapping;
 892         unsigned lo_blocksize;
 893         int             lo_flags = 0;
 894         int             error;
 895         loff_t          size;
 896
 897         /* This is safe, since we have a reference from open(). */
 898         __module_get(THIS_MODULE);
 899
 900         error = -EBADF;
 901         file = fget(arg);
 902         if (!file)
 903                 goto out;
 904
 905         error = -EBUSY;
 906         if (lo->lo_state != Lo_unbound)
 907                 goto out_putf;
 908
 909         error = loop_validate_file(file, bdev);
 910         if (error)
 911                 goto out_putf;
 912
 913         mapping = file->f_mapping;
 914         inode = mapping->host;
 915
 916         if (!(file->f_mode & FMODE_WRITE) || !(mode & FMODE_WRITE) ||
 917             !file->f_op->write_iter)
 918                 lo_flags |= LO_FLAGS_READ_ONLY;
 919
 920         lo_blocksize = S_ISBLK(inode->i_mode) ?
 921                 inode->i_bdev->bd_block_size : PAGE_SIZE;
 922
 923         error = -EFBIG;
 924         size = get_loop_size(lo, file);
 925         if ((loff_t)(sector_t)size != size)
 926                 goto out_putf;
 927         error = loop_prepare_queue(lo);
 928         if (error)
 929                 goto out_putf;
 930
 931         error = 0;
 932
 933         set_device_ro(bdev, (lo_flags & LO_FLAGS_READ_ONLY) != 0);
 934
 935         lo->use_dio = false;
 936         lo->lo_blocksize = lo_blocksize;
 937         lo->lo_device = bdev;
 938         lo->lo_flags = lo_flags;
 939         lo->lo_backing_file = file;
 940         lo->transfer = NULL;
 941         lo->ioctl = NULL;
 942         lo->lo_sizelimit = 0;
 943         lo->old_gfp_mask = mapping_gfp_mask(mapping);
 944         mapping_set_gfp_mask(mapping, lo->old_gfp_mask & ~(__GFP_IO|__GFP_FS));
 945
 946         if (!(lo_flags & LO_FLAGS_READ_ONLY) && file->f_op->fsync)
 947                 blk_queue_write_cache(lo->lo_queue, true, false);
 948
 949         loop_update_dio(lo);
 950         set_capacity(lo->lo_disk, size);
 951         bd_set_size(bdev, size << 9);
 952         loop_sysfs_init(lo);
 953         /* let user-space know about the new size */
 954         kobject_uevent(&disk_to_dev(bdev->bd_disk)->kobj, KOBJ_CHANGE);
 955
 956         set_blocksize(bdev, lo_blocksize);
 957
 958         lo->lo_state = Lo_bound;
 959         if (part_shift)
 960                 lo->lo_flags |= LO_FLAGS_PARTSCAN;
 961         if (lo->lo_flags & LO_FLAGS_PARTSCAN)
 962                 loop_reread_partitions(lo, bdev);
 963
 964         /* Grab the block_device to prevent its destruction after we
 965          * put /dev/loopXX inode. Later in loop_clr_fd() we bdput(bdev).
 966          */
 967         bdgrab(bdev);
 968         return 0;
 969
 970  out_putf:
 971         fput(file);
 972  out:
 973         /* This is safe: open() is still holding a reference. */
 974         module_put(THIS_MODULE);
 975         return error;
 976 }
 977
 978 static int
 979 loop_release_xfer(struct loop_device *lo)
 980 {
 981         int err = 0;
 982         struct loop_func_table *xfer = lo->lo_encryption;
 983
 984         if (xfer) {
 985                 if (xfer->release)
 986                         err = xfer->release(lo);
 987                 lo->transfer = NULL;
 988                 lo->lo_encryption = NULL;
 989                 module_put(xfer->owner);
 990         }
 991         return err;
 992 }
 993
 994 static int
 995 loop_init_xfer(struct loop_device *lo, struct loop_func_table *xfer,
 996                const struct loop_info64 *i)
 997 {
 998         int err = 0;
 999
1000         if (xfer) {
1001                 struct module *owner = xfer->owner;
1002
1003                 if (!try_module_get(owner))
1004                         return -EINVAL;
1005                 if (xfer->init)
1006                         err = xfer->init(lo, i);
1007                 if (err)
1008                         module_put(owner);
1009                 else
1010                         lo->lo_encryption = xfer;
1011         }
1012         return err;
1013 }
1014
1015 static int loop_clr_fd(struct loop_device *lo)
1016 {
1017         struct file *filp = lo->lo_backing_file;
1018         gfp_t gfp = lo->old_gfp_mask;
1019         struct block_device *bdev = lo->lo_device;
1020
1021         if (lo->lo_state != Lo_bound)
1022                 return -ENXIO;
1023
1024         /*
1025          * If we've explicitly asked to tear down the loop device,
1026          * and it has an elevated reference count, set it for auto-teardown when
1027          * the last reference goes away. This stops $!~#$@ udev from
1028          * preventing teardown because it decided that it needs to run blkid on
1029          * the loopback device whenever they appear. xfstests is notorious for
1030          * failing tests because blkid via udev races with a losetup
1031          * <dev>/do something like mkfs/losetup -d <dev> causing the losetup -d
1032          * command to fail with EBUSY.
1033          */
1034         if (atomic_read(&lo->lo_refcnt) > 1) {
1035                 lo->lo_flags |= LO_FLAGS_AUTOCLEAR;
1036                 mutex_unlock(&lo->lo_ctl_mutex);
1037                 return 0;
1038         }
1039
1040         if (filp == NULL)
1041                 return -EINVAL;
1042
1043         /* freeze request queue during the transition */
1044         blk_mq_freeze_queue(lo->lo_queue);
1045
1046         spin_lock_irq(&lo->lo_lock);
1047         lo->lo_state = Lo_rundown;
1048         lo->lo_backing_file = NULL;
1049         spin_unlock_irq(&lo->lo_lock);
1050
1051         loop_release_xfer(lo);
1052         lo->transfer = NULL;
1053         lo->ioctl = NULL;
1054         lo->lo_device = NULL;
1055         lo->lo_encryption = NULL;
1056         lo->lo_offset = 0;
1057         lo->lo_sizelimit = 0;
1058         lo->lo_encrypt_key_size = 0;
1059         memset(lo->lo_encrypt_key, 0, LO_KEY_SIZE);
1060         memset(lo->lo_crypt_name, 0, LO_NAME_SIZE);
1061         memset(lo->lo_file_name, 0, LO_NAME_SIZE);
1062         if (bdev) {
1063                 bdput(bdev);
1064                 invalidate_bdev(bdev);
1065         }
1066         set_capacity(lo->lo_disk, 0);
1067         loop_sysfs_exit(lo);
1068         if (bdev) {
1069                 bd_set_size(bdev, 0);
1070                 /* let user-space know about this change */
1071                 kobject_uevent(&disk_to_dev(bdev->bd_disk)->kobj, KOBJ_CHANGE);
1072         }
1073         mapping_set_gfp_mask(filp->f_mapping, gfp);
1074         lo->lo_state = Lo_unbound;
1075         /* This is safe: open() is still holding a reference. */
1076         module_put(THIS_MODULE);
1077         blk_mq_unfreeze_queue(lo->lo_queue);
1078
1079         if (lo->lo_flags & LO_FLAGS_PARTSCAN && bdev)
1080                 loop_reread_partitions(lo, bdev);
1081         lo->lo_flags = 0;
1082         if (!part_shift)
1083                 lo->lo_disk->flags |= GENHD_FL_NO_PART_SCAN;
1084         loop_unprepare_queue(lo);
1085         mutex_unlock(&lo->lo_ctl_mutex);
1086         /*
1087          * Need not hold lo_ctl_mutex to fput backing file.
1088          * Calling fput holding lo_ctl_mutex triggers a circular
1089          * lock dependency possibility warning as fput can take
1090          * bd_mutex which is usually taken before lo_ctl_mutex.
1091          */
1092         fput(filp);
1093         return 0;
1094 }
1095
1096 static int
1097 loop_set_status(struct loop_device *lo, const struct loop_info64 *info)
1098 {
1099         int err;
1100         struct loop_func_table *xfer;
1101         kuid_t uid = current_uid();
1102
1103         if (lo->lo_encrypt_key_size &&
1104             !uid_eq(lo->lo_key_owner, uid) &&
1105             !capable(CAP_SYS_ADMIN))
1106                 return -EPERM;
1107         if (lo->lo_state != Lo_bound)
1108                 return -ENXIO;
1109         if ((unsigned int) info->lo_encrypt_key_size > LO_KEY_SIZE)
1110                 return -EINVAL;
1111
1112         /* I/O need to be drained during transfer transition */
1113         blk_mq_freeze_queue(lo->lo_queue);
1114
1115         err = loop_release_xfer(lo);
1116         if (err)
1117                 goto exit;
1118
1119         if (info->lo_encrypt_type) {
1120                 unsigned int type = info->lo_encrypt_type;
1121
1122                 if (type >= MAX_LO_CRYPT) {
1123                         err = -EINVAL;
1124                         goto exit;
1125                 }
1126                 xfer = xfer_funcs[type];
1127                 if (xfer == NULL) {
1128                         err = -EINVAL;
1129                         goto exit;
1130                 }
1131         } else
1132                 xfer = NULL;
1133
1134         err = loop_init_xfer(lo, xfer, info);
1135         if (err)
1136                 goto exit;
1137
1138         if (lo->lo_offset != info->lo_offset ||
1139             lo->lo_sizelimit != info->lo_sizelimit)
1140                 if (figure_loop_size(lo, info->lo_offset, info->lo_sizelimit)) {
1141                         err = -EFBIG;
1142                         goto exit;
1143                 }
1144
1145         loop_config_discard(lo);
1146
1147         memcpy(lo->lo_file_name, info->lo_file_name, LO_NAME_SIZE);
1148         memcpy(lo->lo_crypt_name, info->lo_crypt_name, LO_NAME_SIZE);
1149         lo->lo_file_name[LO_NAME_SIZE-1] = 0;
1150         lo->lo_crypt_name[LO_NAME_SIZE-1] = 0;
1151
1152         if (!xfer)
1153                 xfer = &none_funcs;
1154         lo->transfer = xfer->transfer;
1155         lo->ioctl = xfer->ioctl;
1156
1157         if ((lo->lo_flags & LO_FLAGS_AUTOCLEAR) !=
1158              (info->lo_flags & LO_FLAGS_AUTOCLEAR))
1159                 lo->lo_flags ^= LO_FLAGS_AUTOCLEAR;
1160
1161         lo->lo_encrypt_key_size = info->lo_encrypt_key_size;
1162         lo->lo_init[0] = info->lo_init[0];
1163         lo->lo_init[1] = info->lo_init[1];
1164         if (info->lo_encrypt_key_size) {
1165                 memcpy(lo->lo_encrypt_key, info->lo_encrypt_key,
1166                        info->lo_encrypt_key_size);
1167                 lo->lo_key_owner = uid;
1168         }
1169
1170         /* update dio if lo_offset or transfer is changed */
1171         __loop_update_dio(lo, lo->use_dio);
1172
1173  exit:
1174         blk_mq_unfreeze_queue(lo->lo_queue);
1175
1176         if (!err && (info->lo_flags & LO_FLAGS_PARTSCAN) &&
1177              !(lo->lo_flags & LO_FLAGS_PARTSCAN)) {
1178                 lo->lo_flags |= LO_FLAGS_PARTSCAN;
1179                 lo->lo_disk->flags &= ~GENHD_FL_NO_PART_SCAN;
1180                 loop_reread_partitions(lo, lo->lo_device);
1181         }
1182
1183         return err;
1184 }
1185
1186 static int
1187 loop_get_status(struct loop_device *lo, struct loop_info64 *info)
1188 {
1189         struct file *file = lo->lo_backing_file;
1190         struct kstat stat;
1191         int error;
1192
1193         if (lo->lo_state != Lo_bound)
1194                 return -ENXIO;
1195         error = vfs_getattr(&file->f_path, &stat);
1196         if (error)
1197                 return error;
1198         memset(info, 0, sizeof(*info));
1199         info->lo_number = lo->lo_number;
1200         info->lo_device = huge_encode_dev(stat.dev);
1201         info->lo_inode = stat.ino;
1202         info->lo_rdevice = huge_encode_dev(lo->lo_device ? stat.rdev : stat.dev);
1203         info->lo_offset = lo->lo_offset;
1204         info->lo_sizelimit = lo->lo_sizelimit;
1205         info->lo_flags = lo->lo_flags;
1206         memcpy(info->lo_file_name, lo->lo_file_name, LO_NAME_SIZE);
1207         memcpy(info->lo_crypt_name, lo->lo_crypt_name, LO_NAME_SIZE);
1208         info->lo_encrypt_type =
1209                 lo->lo_encryption ? lo->lo_encryption->number : 0;
1210         if (lo->lo_encrypt_key_size && capable(CAP_SYS_ADMIN)) {
1211                 info->lo_encrypt_key_size = lo->lo_encrypt_key_size;
1212                 memcpy(info->lo_encrypt_key, lo->lo_encrypt_key,
1213                        lo->lo_encrypt_key_size);
1214         }
1215         return 0;
1216 }
1217
1218 static void
1219 loop_info64_from_old(const struct loop_info *info, struct loop_info64 *info64)
1220 {
1221         memset(info64, 0, sizeof(*info64));
1222         info64->lo_number = info->lo_number;
1223         info64->lo_device = info->lo_device;
1224         info64->lo_inode = info->lo_inode;
1225         info64->lo_rdevice = info->lo_rdevice;
1226         info64->lo_offset = info->lo_offset;
1227         info64->lo_sizelimit = 0;
1228         info64->lo_encrypt_type = info->lo_encrypt_type;
1229         info64->lo_encrypt_key_size = info->lo_encrypt_key_size;
1230         info64->lo_flags = info->lo_flags;
1231         info64->lo_init[0] = info->lo_init[0];
1232         info64->lo_init[1] = info->lo_init[1];
1233         if (info->lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1234                 memcpy(info64->lo_crypt_name, info->lo_name, LO_NAME_SIZE);
1235         else
1236                 memcpy(info64->lo_file_name, info->lo_name, LO_NAME_SIZE);
1237         memcpy(info64->lo_encrypt_key, info->lo_encrypt_key, LO_KEY_SIZE);
1238 }
1239
1240 static int
1241 loop_info64_to_old(const struct loop_info64 *info64, struct loop_info *info)
1242 {
1243         memset(info, 0, sizeof(*info));
1244         info->lo_number = info64->lo_number;
1245         info->lo_device = info64->lo_device;
1246         info->lo_inode = info64->lo_inode;
1247         info->lo_rdevice = info64->lo_rdevice;
1248         info->lo_offset = info64->lo_offset;
1249         info->lo_encrypt_type = info64->lo_encrypt_type;
1250         info->lo_encrypt_key_size = info64->lo_encrypt_key_size;
1251         info->lo_flags = info64->lo_flags;
1252         info->lo_init[0] = info64->lo_init[0];
1253         info->lo_init[1] = info64->lo_init[1];
1254         if (info->lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1255                 memcpy(info->lo_name, info64->lo_crypt_name, LO_NAME_SIZE);
1256         else
1257                 memcpy(info->lo_name, info64->lo_file_name, LO_NAME_SIZE);
1258         memcpy(info->lo_encrypt_key, info64->lo_encrypt_key, LO_KEY_SIZE);
1259
1260         /* error in case values were truncated */
1261         if (info->lo_device != info64->lo_device ||
1262             info->lo_rdevice != info64->lo_rdevice ||
1263             info->lo_inode != info64->lo_inode ||
1264             info->lo_offset != info64->lo_offset)
1265                 return -EOVERFLOW;
1266
1267         return 0;
1268 }
1269
1270 static int
1271 loop_set_status_old(struct loop_device *lo, const struct loop_info __user *arg)
1272 {
1273         struct loop_info info;
1274         struct loop_info64 info64;
1275
1276         if (copy_from_user(&info, arg, sizeof (struct loop_info)))
1277                 return -EFAULT;
1278         loop_info64_from_old(&info, &info64);
1279         return loop_set_status(lo, &info64);
1280 }
1281
1282 static int
1283 loop_set_status64(struct loop_device *lo, const struct loop_info64 __user *arg)
1284 {
1285         struct loop_info64 info64;
1286
1287         if (copy_from_user(&info64, arg, sizeof (struct loop_info64)))
1288                 return -EFAULT;
1289         return loop_set_status(lo, &info64);
1290 }
1291
1292 static int
1293 loop_get_status_old(struct loop_device *lo, struct loop_info __user *arg) {
1294         struct loop_info info;
1295         struct loop_info64 info64;
1296         int err = 0;
1297
1298         if (!arg)
1299                 err = -EINVAL;
1300         if (!err)
1301                 err = loop_get_status(lo, &info64);
1302         if (!err)
1303                 err = loop_info64_to_old(&info64, &info);
1304         if (!err && copy_to_user(arg, &info, sizeof(info)))
1305                 err = -EFAULT;
1306
1307         return err;
1308 }
1309
1310 static int
1311 loop_get_status64(struct loop_device *lo, struct loop_info64 __user *arg) {
1312         struct loop_info64 info64;
1313         int err = 0;
1314
1315         if (!arg)
1316                 err = -EINVAL;
1317         if (!err)
1318                 err = loop_get_status(lo, &info64);
1319         if (!err && copy_to_user(arg, &info64, sizeof(info64)))
1320                 err = -EFAULT;
1321
1322         return err;
1323 }
1324
1325 static int loop_set_capacity(struct loop_device *lo, struct block_device *bdev)
1326 {
1327         if (unlikely(lo->lo_state != Lo_bound))
1328                 return -ENXIO;
1329
1330         return figure_loop_size(lo, lo->lo_offset, lo->lo_sizelimit);
1331 }
1332
1333 static int loop_set_dio(struct loop_device *lo, unsigned long arg)
1334 {
1335         int error = -ENXIO;
1336         if (lo->lo_state != Lo_bound)
1337                 goto out;
1338
1339         __loop_update_dio(lo, !!arg);
1340         if (lo->use_dio == !!arg)
1341                 return 0;
1342         error = -EINVAL;
1343  out:
1344         return error;
1345 }
1346
1347 static int lo_ioctl(struct block_device *bdev, fmode_t mode,
1348         unsigned int cmd, unsigned long arg)
1349 {
1350         struct loop_device *lo = bdev->bd_disk->private_data;
1351         int err;
1352
1353         mutex_lock_nested(&lo->lo_ctl_mutex, 1);
1354         switch (cmd) {
1355         case LOOP_SET_FD:
1356                 err = loop_set_fd(lo, mode, bdev, arg);
1357                 break;
1358         case LOOP_CHANGE_FD:
1359                 err = loop_change_fd(lo, bdev, arg);
1360                 break;
1361         case LOOP_CLR_FD:
1362                 /* loop_clr_fd would have unlocked lo_ctl_mutex on success */
1363                 err = loop_clr_fd(lo);
1364                 if (!err)
1365                         goto out_unlocked;
1366                 break;
1367         case LOOP_SET_STATUS:
1368                 err = -EPERM;
1369                 if ((mode & FMODE_WRITE) || capable(CAP_SYS_ADMIN))
1370                         err = loop_set_status_old(lo,
1371                                         (struct loop_info __user *)arg);
1372                 break;
1373         case LOOP_GET_STATUS:
1374                 err = loop_get_status_old(lo, (struct loop_info __user *) arg);
1375                 break;
1376         case LOOP_SET_STATUS64:
1377                 err = -EPERM;
1378                 if ((mode & FMODE_WRITE) || capable(CAP_SYS_ADMIN))
1379                         err = loop_set_status64(lo,
1380                                         (struct loop_info64 __user *) arg);
1381                 break;
1382         case LOOP_GET_STATUS64:
1383                 err = loop_get_status64(lo, (struct loop_info64 __user *) arg);
1384                 break;
1385         case LOOP_SET_CAPACITY:
1386                 err = -EPERM;
1387                 if ((mode & FMODE_WRITE) || capable(CAP_SYS_ADMIN))
1388                         err = loop_set_capacity(lo, bdev);
1389                 break;
1390         case LOOP_SET_DIRECT_IO:
1391                 err = -EPERM;
1392                 if ((mode & FMODE_WRITE) || capable(CAP_SYS_ADMIN))
1393                         err = loop_set_dio(lo, arg);
1394                 break;
1395         default:
1396                 err = lo->ioctl ? lo->ioctl(lo, cmd, arg) : -EINVAL;
1397         }
1398         mutex_unlock(&lo->lo_ctl_mutex);
1399
1400 out_unlocked:
1401         return err;
1402 }
1403
1404 #ifdef CONFIG_COMPAT
1405 struct compat_loop_info {
1406         compat_int_t    lo_number;      /* ioctl r/o */
1407         compat_dev_t    lo_device;      /* ioctl r/o */
1408         compat_ulong_t  lo_inode;       /* ioctl r/o */
1409         compat_dev_t    lo_rdevice;     /* ioctl r/o */
1410         compat_int_t    lo_offset;
1411         compat_int_t    lo_encrypt_type;
1412         compat_int_t    lo_encrypt_key_size;    /* ioctl w/o */
1413         compat_int_t    lo_flags;       /* ioctl r/o */
1414         char            lo_name[LO_NAME_SIZE];
1415         unsigned char   lo_encrypt_key[LO_KEY_SIZE]; /* ioctl w/o */
1416         compat_ulong_t  lo_init[2];
1417         char            reserved[4];
1418 };
1419
1420 /*
1421  * Transfer 32-bit compatibility structure in userspace to 64-bit loop info
1422  * - noinlined to reduce stack space usage in main part of driver
1423  */
1424 static noinline int
1425 loop_info64_from_compat(const struct compat_loop_info __user *arg,
1426                         struct loop_info64 *info64)
1427 {
1428         struct compat_loop_info info;
1429
1430         if (copy_from_user(&info, arg, sizeof(info)))
1431                 return -EFAULT;
1432
1433         memset(info64, 0, sizeof(*info64));
1434         info64->lo_number = info.lo_number;
1435         info64->lo_device = info.lo_device;
1436         info64->lo_inode = info.lo_inode;
1437         info64->lo_rdevice = info.lo_rdevice;
1438         info64->lo_offset = info.lo_offset;
1439         info64->lo_sizelimit = 0;
1440         info64->lo_encrypt_type = info.lo_encrypt_type;
1441         info64->lo_encrypt_key_size = info.lo_encrypt_key_size;
1442         info64->lo_flags = info.lo_flags;
1443         info64->lo_init[0] = info.lo_init[0];
1444         info64->lo_init[1] = info.lo_init[1];
1445         if (info.lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1446                 memcpy(info64->lo_crypt_name, info.lo_name, LO_NAME_SIZE);
1447         else
1448                 memcpy(info64->lo_file_name, info.lo_name, LO_NAME_SIZE);
1449         memcpy(info64->lo_encrypt_key, info.lo_encrypt_key, LO_KEY_SIZE);
1450         return 0;
1451 }
1452
1453 /*
1454  * Transfer 64-bit loop info to 32-bit compatibility structure in userspace
1455  * - noinlined to reduce stack space usage in main part of driver
1456  */
1457 static noinline int
1458 loop_info64_to_compat(const struct loop_info64 *info64,
1459                       struct compat_loop_info __user *arg)
1460 {
1461         struct compat_loop_info info;
1462
1463         memset(&info, 0, sizeof(info));
1464         info.lo_number = info64->lo_number;
1465         info.lo_device = info64->lo_device;
1466         info.lo_inode = info64->lo_inode;
1467         info.lo_rdevice = info64->lo_rdevice;
1468         info.lo_offset = info64->lo_offset;
1469         info.lo_encrypt_type = info64->lo_encrypt_type;
1470         info.lo_encrypt_key_size = info64->lo_encrypt_key_size;
1471         info.lo_flags = info64->lo_flags;
1472         info.lo_init[0] = info64->lo_init[0];
1473         info.lo_init[1] = info64->lo_init[1];
1474         if (info.lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1475                 memcpy(info.lo_name, info64->lo_crypt_name, LO_NAME_SIZE);
1476         else
1477                 memcpy(info.lo_name, info64->lo_file_name, LO_NAME_SIZE);
1478         memcpy(info.lo_encrypt_key, info64->lo_encrypt_key, LO_KEY_SIZE);
1479
1480         /* error in case values were truncated */
1481         if (info.lo_device != info64->lo_device ||
1482             info.lo_rdevice != info64->lo_rdevice ||
1483             info.lo_inode != info64->lo_inode ||
1484             info.lo_offset != info64->lo_offset ||
1485             info.lo_init[0] != info64->lo_init[0] ||
1486             info.lo_init[1] != info64->lo_init[1])
1487                 return -EOVERFLOW;
1488
1489         if (copy_to_user(arg, &info, sizeof(info)))
1490                 return -EFAULT;
1491         return 0;
1492 }
1493
1494 static int
1495 loop_set_status_compat(struct loop_device *lo,
1496                        const struct compat_loop_info __user *arg)
1497 {
1498         struct loop_info64 info64;
1499         int ret;
1500
1501         ret = loop_info64_from_compat(arg, &info64);
1502         if (ret < 0)
1503                 return ret;
1504         return loop_set_status(lo, &info64);
1505 }
1506
1507 static int
1508 loop_get_status_compat(struct loop_device *lo,
1509                        struct compat_loop_info __user *arg)
1510 {
1511         struct loop_info64 info64;
1512         int err = 0;
1513
1514         if (!arg)
1515                 err = -EINVAL;
1516         if (!err)
1517                 err = loop_get_status(lo, &info64);
1518         if (!err)
1519                 err = loop_info64_to_compat(&info64, arg);
1520         return err;
1521 }
1522
1523 static int lo_compat_ioctl(struct block_device *bdev, fmode_t mode,
1524                            unsigned int cmd, unsigned long arg)
1525 {
1526         struct loop_device *lo = bdev->bd_disk->private_data;
1527         int err;
1528
1529         switch(cmd) {
1530         case LOOP_SET_STATUS:
1531                 mutex_lock(&lo->lo_ctl_mutex);
1532                 err = loop_set_status_compat(
1533                         lo, (const struct compat_loop_info __user *) arg);
1534                 mutex_unlock(&lo->lo_ctl_mutex);
1535                 break;
1536         case LOOP_GET_STATUS:
1537                 mutex_lock(&lo->lo_ctl_mutex);
1538                 err = loop_get_status_compat(
1539                         lo, (struct compat_loop_info __user *) arg);
1540                 mutex_unlock(&lo->lo_ctl_mutex);
1541                 break;
1542         case LOOP_SET_CAPACITY:
1543         case LOOP_CLR_FD:
1544         case LOOP_GET_STATUS64:
1545         case LOOP_SET_STATUS64:
1546                 arg = (unsigned long) compat_ptr(arg);
1547         case LOOP_SET_FD:
1548         case LOOP_CHANGE_FD:
1549         case LOOP_SET_DIRECT_IO:
1550                 err = lo_ioctl(bdev, mode, cmd, arg);
1551                 break;
1552         default:
1553                 err = -ENOIOCTLCMD;
1554                 break;
1555         }
1556         return err;
1557 }
1558 #endif
1559
1560 static int lo_open(struct block_device *bdev, fmode_t mode)
1561 {
1562         struct loop_device *lo;
1563         int err = 0;
1564
1565         mutex_lock(&loop_index_mutex);
1566         lo = bdev->bd_disk->private_data;
1567         if (!lo) {
1568                 err = -ENXIO;
1569                 goto out;
1570         }
1571
1572         atomic_inc(&lo->lo_refcnt);
1573 out:
1574         mutex_unlock(&loop_index_mutex);
1575         return err;
1576 }
1577
1578 static void __lo_release(struct loop_device *lo)
1579 {
1580         int err;
1581
1582         if (atomic_dec_return(&lo->lo_refcnt))
1583                 return;
1584
1585         mutex_lock(&lo->lo_ctl_mutex);
1586         if (lo->lo_flags & LO_FLAGS_AUTOCLEAR) {
1587                 /*
1588                  * In autoclear mode, stop the loop thread
1589                  * and remove configuration after last close.
1590                  */
1591                 err = loop_clr_fd(lo);
1592                 if (!err)
1593                         return;
1594         } else {
1595                 /*
1596                  * Otherwise keep thread (if running) and config,
1597                  * but flush possible ongoing bios in thread.
1598                  */
1599                 loop_flush(lo);
1600         }
1601
1602         mutex_unlock(&lo->lo_ctl_mutex);
1603 }
1604
1605 static void lo_release(struct gendisk *disk, fmode_t mode)
1606 {
1607         mutex_lock(&loop_index_mutex);
1608         __lo_release(disk->private_data);
1609         mutex_unlock(&loop_index_mutex);
1610 }
1611
1612 static const struct block_device_operations lo_fops = {
1613         .owner =        THIS_MODULE,
1614         .open =         lo_open,
1615         .release =      lo_release,
1616         .ioctl =        lo_ioctl,
1617 #ifdef CONFIG_COMPAT
1618         .compat_ioctl = lo_compat_ioctl,
1619 #endif
1620 };
1621
1622 /*
1623  * And now the modules code and kernel interface.
1624  */
1625 static int max_loop;
1626 module_param(max_loop, int, S_IRUGO);
1627 MODULE_PARM_DESC(max_loop, "Maximum number of loop devices");
1628 module_param(max_part, int, S_IRUGO);
1629 MODULE_PARM_DESC(max_part, "Maximum number of partitions per loop device");
1630 MODULE_LICENSE("GPL");
1631 MODULE_ALIAS_BLOCKDEV_MAJOR(LOOP_MAJOR);
1632
1633 int loop_register_transfer(struct loop_func_table *funcs)
1634 {
1635         unsigned int n = funcs->number;
1636
1637         if (n >= MAX_LO_CRYPT || xfer_funcs[n])
1638                 return -EINVAL;
1639         xfer_funcs[n] = funcs;
1640         return 0;
1641 }
1642
1643 static int unregister_transfer_cb(int id, void *ptr, void *data)
1644 {
1645         struct loop_device *lo = ptr;
1646         struct loop_func_table *xfer = data;
1647
1648         mutex_lock(&lo->lo_ctl_mutex);
1649         if (lo->lo_encryption == xfer)
1650                 loop_release_xfer(lo);
1651         mutex_unlock(&lo->lo_ctl_mutex);
1652         return 0;
1653 }
1654
1655 int loop_unregister_transfer(int number)
1656 {
1657         unsigned int n = number;
1658         struct loop_func_table *xfer;
1659
1660         if (n == 0 || n >= MAX_LO_CRYPT || (xfer = xfer_funcs[n]) == NULL)
1661                 return -EINVAL;
1662
1663         xfer_funcs[n] = NULL;
1664         idr_for_each(&loop_index_idr, &unregister_transfer_cb, xfer);
1665         return 0;
1666 }
1667
1668 EXPORT_SYMBOL(loop_register_transfer);
1669 EXPORT_SYMBOL(loop_unregister_transfer);
1670
1671 static int loop_queue_rq(struct blk_mq_hw_ctx *hctx,
1672                 const struct blk_mq_queue_data *bd)
1673 {
1674         struct loop_cmd *cmd = blk_mq_rq_to_pdu(bd->rq);
1675         struct loop_device *lo = cmd->rq->q->queuedata;
1676
1677         blk_mq_start_request(bd->rq);
1678
1679         if (lo->lo_state != Lo_bound)
1680                 return BLK_MQ_RQ_QUEUE_ERROR;
1681
1682         switch (req_op(cmd->rq)) {
1683         case REQ_OP_FLUSH:
1684         case REQ_OP_DISCARD:
1685                 cmd->use_aio = false;
1686                 break;
1687         default:
1688                 cmd->use_aio = lo->use_dio;
1689                 break;
1690         }
1691
1692         kthread_queue_work(&lo->worker, &cmd->work);
1693
1694         return BLK_MQ_RQ_QUEUE_OK;
1695 }
1696
1697 static void loop_handle_cmd(struct loop_cmd *cmd)
1698 {
1699         const bool write = op_is_write(req_op(cmd->rq));
1700         struct loop_device *lo = cmd->rq->q->queuedata;
1701         int ret = 0;
1702
1703         if (write && (lo->lo_flags & LO_FLAGS_READ_ONLY)) {
1704                 ret = -EIO;
1705                 goto failed;
1706         }
1707
1708         ret = do_req_filebacked(lo, cmd->rq);
1709  failed:
1710         /* complete non-aio request */
1711         if (!cmd->use_aio || ret)
1712                 blk_mq_complete_request(cmd->rq, ret ? -EIO : 0);
1713 }
1714
1715 static void loop_queue_work(struct kthread_work *work)
1716 {
1717         struct loop_cmd *cmd =
1718                 container_of(work, struct loop_cmd, work);
1719
1720         loop_handle_cmd(cmd);
1721 }
1722
1723 static int loop_init_request(void *data, struct request *rq,
1724                 unsigned int hctx_idx, unsigned int request_idx,
1725                 unsigned int numa_node)
1726 {
1727         struct loop_cmd *cmd = blk_mq_rq_to_pdu(rq);
1728
1729         cmd->rq = rq;
1730         kthread_init_work(&cmd->work, loop_queue_work);
1731
1732         return 0;
1733 }
1734
1735 static struct blk_mq_ops loop_mq_ops = {
1736         .queue_rq       = loop_queue_rq,
1737         .init_request   = loop_init_request,
1738 };
1739
1740 static int loop_add(struct loop_device **l, int i)
1741 {
1742         struct loop_device *lo;
1743         struct gendisk *disk;
1744         int err;
1745
1746         err = -ENOMEM;
1747         lo = kzalloc(sizeof(*lo), GFP_KERNEL);
1748         if (!lo)
1749                 goto out;
1750
1751         lo->lo_state = Lo_unbound;
1752
1753         /* allocate id, if @id >= 0, we're requesting that specific id */
1754         if (i >= 0) {
1755                 err = idr_alloc(&loop_index_idr, lo, i, i + 1, GFP_KERNEL);
1756                 if (err == -ENOSPC)
1757                         err = -EEXIST;
1758         } else {
1759                 err = idr_alloc(&loop_index_idr, lo, 0, 0, GFP_KERNEL);
1760         }
1761         if (err < 0)
1762                 goto out_free_dev;
1763         i = err;
1764
1765         err = -ENOMEM;
1766         lo->tag_set.ops = &loop_mq_ops;
1767         lo->tag_set.nr_hw_queues = 1;
1768         lo->tag_set.queue_depth = 128;
1769         lo->tag_set.numa_node = NUMA_NO_NODE;
1770         lo->tag_set.cmd_size = sizeof(struct loop_cmd);
1771         lo->tag_set.flags = BLK_MQ_F_SHOULD_MERGE | BLK_MQ_F_SG_MERGE;
1772         lo->tag_set.driver_data = lo;
1773
1774         err = blk_mq_alloc_tag_set(&lo->tag_set);
1775         if (err)
1776                 goto out_free_idr;
1777
1778         lo->lo_queue = blk_mq_init_queue(&lo->tag_set);
1779         if (IS_ERR_OR_NULL(lo->lo_queue)) {
1780                 err = PTR_ERR(lo->lo_queue);
1781                 goto out_cleanup_tags;
1782         }
1783         lo->lo_queue->queuedata = lo;
1784
1785         /*
1786          * It doesn't make sense to enable merge because the I/O
1787          * submitted to backing file is handled page by page.
1788          */
1789         queue_flag_set_unlocked(QUEUE_FLAG_NOMERGES, lo->lo_queue);
1790
1791         err = -ENOMEM;
1792         disk = lo->lo_disk = alloc_disk(1 << part_shift);
1793         if (!disk)
1794                 goto out_free_queue;
1795
1796         /*
1797          * Disable partition scanning by default. The in-kernel partition
1798          * scanning can be requested individually per-device during its
1799          * setup. Userspace can always add and remove partitions from all
1800          * devices. The needed partition minors are allocated from the
1801          * extended minor space, the main loop device numbers will continue
1802          * to match the loop minors, regardless of the number of partitions
1803          * used.
1804          *
1805          * If max_part is given, partition scanning is globally enabled for
1806          * all loop devices. The minors for the main loop devices will be
1807          * multiples of max_part.
1808          *
1809          * Note: Global-for-all-devices, set-only-at-init, read-only module
1810          * parameteters like 'max_loop' and 'max_part' make things needlessly
1811          * complicated, are too static, inflexible and may surprise
1812          * userspace tools. Parameters like this in general should be avoided.
1813          */
1814         if (!part_shift)
1815                 disk->flags |= GENHD_FL_NO_PART_SCAN;
1816         disk->flags |= GENHD_FL_EXT_DEVT;
1817         mutex_init(&lo->lo_ctl_mutex);
1818         atomic_set(&lo->lo_refcnt, 0);
1819         lo->lo_number           = i;
1820         spin_lock_init(&lo->lo_lock);
1821         disk->major             = LOOP_MAJOR;
1822         disk->first_minor       = i << part_shift;
1823         disk->fops              = &lo_fops;
1824         disk->private_data      = lo;
1825         disk->queue             = lo->lo_queue;
1826         sprintf(disk->disk_name, "loop%d", i);
1827         add_disk(disk);
1828         *l = lo;
1829         return lo->lo_number;
1830
1831 out_free_queue:
1832         blk_cleanup_queue(lo->lo_queue);
1833 out_cleanup_tags:
1834         blk_mq_free_tag_set(&lo->tag_set);
1835 out_free_idr:
1836         idr_remove(&loop_index_idr, i);
1837 out_free_dev:
1838         kfree(lo);
1839 out:
1840         return err;
1841 }
1842
1843 static void loop_remove(struct loop_device *lo)
1844 {
1845         blk_cleanup_queue(lo->lo_queue);
1846         del_gendisk(lo->lo_disk);
1847         blk_mq_free_tag_set(&lo->tag_set);
1848         put_disk(lo->lo_disk);
1849         kfree(lo);
1850 }
1851
1852 static int find_free_cb(int id, void *ptr, void *data)
1853 {
1854         struct loop_device *lo = ptr;
1855         struct loop_device **l = data;
1856
1857         if (lo->lo_state == Lo_unbound) {
1858                 *l = lo;
1859                 return 1;
1860         }
1861         return 0;
1862 }
1863
1864 static int loop_lookup(struct loop_device **l, int i)
1865 {
1866         struct loop_device *lo;
1867         int ret = -ENODEV;
1868
1869         if (i < 0) {
1870                 int err;
1871
1872                 err = idr_for_each(&loop_index_idr, &find_free_cb, &lo);
1873                 if (err == 1) {
1874                         *l = lo;
1875                         ret = lo->lo_number;
1876                 }
1877                 goto out;
1878         }
1879
1880         /* lookup and return a specific i */
1881         lo = idr_find(&loop_index_idr, i);
1882         if (lo) {
1883                 *l = lo;
1884                 ret = lo->lo_number;
1885         }
1886 out:
1887         return ret;
1888 }
1889
1890 static struct kobject *loop_probe(dev_t dev, int *part, void *data)
1891 {
1892         struct loop_device *lo;
1893         struct kobject *kobj;
1894         int err;
1895
1896         mutex_lock(&loop_index_mutex);
1897         err = loop_lookup(&lo, MINOR(dev) >> part_shift);
1898         if (err < 0)
1899                 err = loop_add(&lo, MINOR(dev) >> part_shift);
1900         if (err < 0)
1901                 kobj = NULL;
1902         else
1903                 kobj = get_disk(lo->lo_disk);
1904         mutex_unlock(&loop_index_mutex);
1905
1906         *part = 0;
1907         return kobj;
1908 }
1909
1910 static long loop_control_ioctl(struct file *file, unsigned int cmd,
1911                                unsigned long parm)
1912 {
1913         struct loop_device *lo;
1914         int ret = -ENOSYS;
1915
1916         mutex_lock(&loop_index_mutex);
1917         switch (cmd) {
1918         case LOOP_CTL_ADD:
1919                 ret = loop_lookup(&lo, parm);
1920                 if (ret >= 0) {
1921                         ret = -EEXIST;
1922                         break;
1923                 }
1924                 ret = loop_add(&lo, parm);
1925                 break;
1926         case LOOP_CTL_REMOVE:
1927                 ret = loop_lookup(&lo, parm);
1928                 if (ret < 0)
1929                         break;
1930                 mutex_lock(&lo->lo_ctl_mutex);
1931                 if (lo->lo_state != Lo_unbound) {
1932                         ret = -EBUSY;
1933                         mutex_unlock(&lo->lo_ctl_mutex);
1934                         break;
1935                 }
1936                 if (atomic_read(&lo->lo_refcnt) > 0) {
1937                         ret = -EBUSY;
1938                         mutex_unlock(&lo->lo_ctl_mutex);
1939                         break;
1940                 }
1941                 lo->lo_disk->private_data = NULL;
1942                 mutex_unlock(&lo->lo_ctl_mutex);
1943                 idr_remove(&loop_index_idr, lo->lo_number);
1944                 loop_remove(lo);
1945                 break;
1946         case LOOP_CTL_GET_FREE:
1947                 ret = loop_lookup(&lo, -1);
1948                 if (ret >= 0)
1949                         break;
1950                 ret = loop_add(&lo, -1);
1951         }
1952         mutex_unlock(&loop_index_mutex);
1953
1954         return ret;
1955 }
1956
1957 static const struct file_operations loop_ctl_fops = {
1958         .open           = nonseekable_open,
1959         .unlocked_ioctl = loop_control_ioctl,
1960         .compat_ioctl   = loop_control_ioctl,
1961         .owner          = THIS_MODULE,
1962         .llseek         = noop_llseek,
1963 };
1964
1965 static struct miscdevice loop_misc = {
1966         .minor          = LOOP_CTRL_MINOR,
1967         .name           = "loop-control",
1968         .fops           = &loop_ctl_fops,
1969 };
1970
1971 MODULE_ALIAS_MISCDEV(LOOP_CTRL_MINOR);
1972 MODULE_ALIAS("devname:loop-control");
1973
1974 static int __init loop_init(void)
1975 {
1976         int i, nr;
1977         unsigned long range;
1978         struct loop_device *lo;
1979         int err;
1980
1981         err = misc_register(&loop_misc);
1982         if (err < 0)
1983                 return err;
1984
1985         part_shift = 0;
1986         if (max_part > 0) {
1987                 part_shift = fls(max_part);
1988
1989                 /*
1990                  * Adjust max_part according to part_shift as it is exported
1991                  * to user space so that user can decide correct minor number
1992                  * if [s]he want to create more devices.
1993                  *
1994                  * Note that -1 is required because partition 0 is reserved
1995                  * for the whole disk.
1996                  */
1997                 max_part = (1UL << part_shift) - 1;
1998         }
1999
2000         if ((1UL << part_shift) > DISK_MAX_PARTS) {
2001                 err = -EINVAL;
2002                 goto misc_out;
2003         }
2004
2005         if (max_loop > 1UL << (MINORBITS - part_shift)) {
2006                 err = -EINVAL;
2007                 goto misc_out;
2008         }
2009
2010         /*
2011          * If max_loop is specified, create that many devices upfront.
2012          * This also becomes a hard limit. If max_loop is not specified,
2013          * create CONFIG_BLK_DEV_LOOP_MIN_COUNT loop devices at module
2014          * init time. Loop devices can be requested on-demand with the
2015          * /dev/loop-control interface, or be instantiated by accessing
2016          * a 'dead' device node.
2017          */
2018         if (max_loop) {
2019                 nr = max_loop;
2020                 range = max_loop << part_shift;
2021         } else {
2022                 nr = CONFIG_BLK_DEV_LOOP_MIN_COUNT;
2023                 range = 1UL << MINORBITS;
2024         }
2025
2026         if (register_blkdev(LOOP_MAJOR, "loop")) {
2027                 err = -EIO;
2028                 goto misc_out;
2029         }
2030
2031         blk_register_region(MKDEV(LOOP_MAJOR, 0), range,
2032                                   THIS_MODULE, loop_probe, NULL, NULL);
2033
2034         /* pre-create number of devices given by config or max_loop */
2035         mutex_lock(&loop_index_mutex);
2036         for (i = 0; i < nr; i++)
2037                 loop_add(&lo, i);
2038         mutex_unlock(&loop_index_mutex);
2039
2040         printk(KERN_INFO "loop: module loaded\n");
2041         return 0;
2042
2043 misc_out:
2044         misc_deregister(&loop_misc);
2045         return err;
2046 }
2047
2048 static int loop_exit_cb(int id, void *ptr, void *data)
2049 {
2050         struct loop_device *lo = ptr;
2051
2052         loop_remove(lo);
2053         return 0;
2054 }
2055
2056 static void __exit loop_exit(void)
2057 {
2058         unsigned long range;
2059
2060         range = max_loop ? max_loop << part_shift : 1UL << MINORBITS;
2061
2062         idr_for_each(&loop_index_idr, &loop_exit_cb, NULL);
2063         idr_destroy(&loop_index_idr);
2064
2065         blk_unregister_region(MKDEV(LOOP_MAJOR, 0), range);
2066         unregister_blkdev(LOOP_MAJOR, "loop");
2067
2068         misc_deregister(&loop_misc);
2069 }
2070
2071 module_init(loop_init);
2072 module_exit(loop_exit);
2073
2074 #ifndef MODULE
2075 static int __init max_loop_setup(char *str)
2076 {
2077         max_loop = simple_strtol(str, NULL, 0);
2078         return 1;
2079 }
2080
2081 __setup("max_loop=", max_loop_setup);
2082 #endif