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, 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 int do_req_filebacked(struct loop_device *lo, struct request *rq)
 449 {
 450         loff_t pos;
 451         int ret;
 452
 453         pos = ((loff_t) blk_rq_pos(rq) << 9) + lo->lo_offset;
 454
 455         if (rq->cmd_flags & REQ_WRITE) {
 456                 if (rq->cmd_flags & REQ_FLUSH)
 457                         ret = lo_req_flush(lo, rq);
 458                 else if (rq->cmd_flags & REQ_DISCARD)
 459                         ret = lo_discard(lo, rq, pos);
 460                 else if (lo->transfer)
 461                         ret = lo_write_transfer(lo, rq, pos);
 462                 else
 463                         ret = lo_write_simple(lo, rq, pos);
 464
 465         } else {
 466                 if (lo->transfer)
 467                         ret = lo_read_transfer(lo, rq, pos);
 468                 else
 469                         ret = lo_read_simple(lo, rq, pos);
 470         }
 471
 472         return ret;
 473 }
 474
 475 struct switch_request {
 476         struct file *file;
 477         struct completion wait;
 478 };
 479
 480 static inline void loop_update_dio(struct loop_device *lo)
 481 {
 482         __loop_update_dio(lo, io_is_direct(lo->lo_backing_file) |
 483                         lo->use_dio);
 484 }
 485
 486 /*
 487  * Do the actual switch; called from the BIO completion routine
 488  */
 489 static void do_loop_switch(struct loop_device *lo, struct switch_request *p)
 490 {
 491         struct file *file = p->file;
 492         struct file *old_file = lo->lo_backing_file;
 493         struct address_space *mapping;
 494
 495         /* if no new file, only flush of queued bios requested */
 496         if (!file)
 497                 return;
 498
 499         mapping = file->f_mapping;
 500         mapping_set_gfp_mask(old_file->f_mapping, lo->old_gfp_mask);
 501         lo->lo_backing_file = file;
 502         lo->lo_blocksize = S_ISBLK(mapping->host->i_mode) ?
 503                 mapping->host->i_bdev->bd_block_size : PAGE_SIZE;
 504         lo->old_gfp_mask = mapping_gfp_mask(mapping);
 505         mapping_set_gfp_mask(mapping, lo->old_gfp_mask & ~(__GFP_IO|__GFP_FS));
 506         loop_update_dio(lo);
 507 }
 508
 509 /*
 510  * loop_switch performs the hard work of switching a backing store.
 511  * First it needs to flush existing IO, it does this by sending a magic
 512  * BIO down the pipe. The completion of this BIO does the actual switch.
 513  */
 514 static int loop_switch(struct loop_device *lo, struct file *file)
 515 {
 516         struct switch_request w;
 517
 518         w.file = file;
 519
 520         /* freeze queue and wait for completion of scheduled requests */
 521         blk_mq_freeze_queue(lo->lo_queue);
 522
 523         /* do the switch action */
 524         do_loop_switch(lo, &w);
 525
 526         /* unfreeze */
 527         blk_mq_unfreeze_queue(lo->lo_queue);
 528
 529         return 0;
 530 }
 531
 532 /*
 533  * Helper to flush the IOs in loop, but keeping loop thread running
 534  */
 535 static int loop_flush(struct loop_device *lo)
 536 {
 537         return loop_switch(lo, NULL);
 538 }
 539
 540 static void loop_reread_partitions(struct loop_device *lo,
 541                                    struct block_device *bdev)
 542 {
 543         int rc;
 544
 545         /*
 546          * bd_mutex has been held already in release path, so don't
 547          * acquire it if this function is called in such case.
 548          *
 549          * If the reread partition isn't from release path, lo_refcnt
 550          * must be at least one and it can only become zero when the
 551          * current holder is released.
 552          */
 553         if (!atomic_read(&lo->lo_refcnt))
 554                 rc = __blkdev_reread_part(bdev);
 555         else
 556                 rc = blkdev_reread_part(bdev);
 557         if (rc)
 558                 pr_warn("%s: partition scan of loop%d (%s) failed (rc=%d)\n",
 559                         __func__, lo->lo_number, lo->lo_file_name, rc);
 560 }
 561
 562 /*
 563  * loop_change_fd switched the backing store of a loopback device to
 564  * a new file. This is useful for operating system installers to free up
 565  * the original file and in High Availability environments to switch to
 566  * an alternative location for the content in case of server meltdown.
 567  * This can only work if the loop device is used read-only, and if the
 568  * new backing store is the same size and type as the old backing store.
 569  */
 570 static int loop_change_fd(struct loop_device *lo, struct block_device *bdev,
 571                           unsigned int arg)
 572 {
 573         struct file     *file, *old_file;
 574         struct inode    *inode;
 575         int             error;
 576
 577         error = -ENXIO;
 578         if (lo->lo_state != Lo_bound)
 579                 goto out;
 580
 581         /* the loop device has to be read-only */
 582         error = -EINVAL;
 583         if (!(lo->lo_flags & LO_FLAGS_READ_ONLY))
 584                 goto out;
 585
 586         error = -EBADF;
 587         file = fget(arg);
 588         if (!file)
 589                 goto out;
 590
 591         inode = file->f_mapping->host;
 592         old_file = lo->lo_backing_file;
 593
 594         error = -EINVAL;
 595
 596         if (!S_ISREG(inode->i_mode) && !S_ISBLK(inode->i_mode))
 597                 goto out_putf;
 598
 599         /* size of the new backing store needs to be the same */
 600         if (get_loop_size(lo, file) != get_loop_size(lo, old_file))
 601                 goto out_putf;
 602
 603         /* and ... switch */
 604         error = loop_switch(lo, file);
 605         if (error)
 606                 goto out_putf;
 607
 608         fput(old_file);
 609         if (lo->lo_flags & LO_FLAGS_PARTSCAN)
 610                 loop_reread_partitions(lo, bdev);
 611         return 0;
 612
 613  out_putf:
 614         fput(file);
 615  out:
 616         return error;
 617 }
 618
 619 static inline int is_loop_device(struct file *file)
 620 {
 621         struct inode *i = file->f_mapping->host;
 622
 623         return i && S_ISBLK(i->i_mode) && MAJOR(i->i_rdev) == LOOP_MAJOR;
 624 }
 625
 626 /* loop sysfs attributes */
 627
 628 static ssize_t loop_attr_show(struct device *dev, char *page,
 629                               ssize_t (*callback)(struct loop_device *, char *))
 630 {
 631         struct gendisk *disk = dev_to_disk(dev);
 632         struct loop_device *lo = disk->private_data;
 633
 634         return callback(lo, page);
 635 }
 636
 637 #define LOOP_ATTR_RO(_name)                                             \
 638 static ssize_t loop_attr_##_name##_show(struct loop_device *, char *);  \
 639 static ssize_t loop_attr_do_show_##_name(struct device *d,              \
 640                                 struct device_attribute *attr, char *b) \
 641 {                                                                       \
 642         return loop_attr_show(d, b, loop_attr_##_name##_show);          \
 643 }                                                                       \
 644 static struct device_attribute loop_attr_##_name =                      \
 645         __ATTR(_name, S_IRUGO, loop_attr_do_show_##_name, NULL);
 646
 647 static ssize_t loop_attr_backing_file_show(struct loop_device *lo, char *buf)
 648 {
 649         ssize_t ret;
 650         char *p = NULL;
 651
 652         spin_lock_irq(&lo->lo_lock);
 653         if (lo->lo_backing_file)
 654                 p = file_path(lo->lo_backing_file, buf, PAGE_SIZE - 1);
 655         spin_unlock_irq(&lo->lo_lock);
 656
 657         if (IS_ERR_OR_NULL(p))
 658                 ret = PTR_ERR(p);
 659         else {
 660                 ret = strlen(p);
 661                 memmove(buf, p, ret);
 662                 buf[ret++] = '\n';
 663                 buf[ret] = 0;
 664         }
 665
 666         return ret;
 667 }
 668
 669 static ssize_t loop_attr_offset_show(struct loop_device *lo, char *buf)
 670 {
 671         return sprintf(buf, "%llu\n", (unsigned long long)lo->lo_offset);
 672 }
 673
 674 static ssize_t loop_attr_sizelimit_show(struct loop_device *lo, char *buf)
 675 {
 676         return sprintf(buf, "%llu\n", (unsigned long long)lo->lo_sizelimit);
 677 }
 678
 679 static ssize_t loop_attr_autoclear_show(struct loop_device *lo, char *buf)
 680 {
 681         int autoclear = (lo->lo_flags & LO_FLAGS_AUTOCLEAR);
 682
 683         return sprintf(buf, "%s\n", autoclear ? "1" : "0");
 684 }
 685
 686 static ssize_t loop_attr_partscan_show(struct loop_device *lo, char *buf)
 687 {
 688         int partscan = (lo->lo_flags & LO_FLAGS_PARTSCAN);
 689
 690         return sprintf(buf, "%s\n", partscan ? "1" : "0");
 691 }
 692
 693 static ssize_t loop_attr_dio_show(struct loop_device *lo, char *buf)
 694 {
 695         int dio = (lo->lo_flags & LO_FLAGS_DIRECT_IO);
 696
 697         return sprintf(buf, "%s\n", dio ? "1" : "0");
 698 }
 699
 700 LOOP_ATTR_RO(backing_file);
 701 LOOP_ATTR_RO(offset);
 702 LOOP_ATTR_RO(sizelimit);
 703 LOOP_ATTR_RO(autoclear);
 704 LOOP_ATTR_RO(partscan);
 705 LOOP_ATTR_RO(dio);
 706
 707 static struct attribute *loop_attrs[] = {
 708         &loop_attr_backing_file.attr,
 709         &loop_attr_offset.attr,
 710         &loop_attr_sizelimit.attr,
 711         &loop_attr_autoclear.attr,
 712         &loop_attr_partscan.attr,
 713         &loop_attr_dio.attr,
 714         NULL,
 715 };
 716
 717 static struct attribute_group loop_attribute_group = {
 718         .name = "loop",
 719         .attrs= loop_attrs,
 720 };
 721
 722 static int loop_sysfs_init(struct loop_device *lo)
 723 {
 724         return sysfs_create_group(&disk_to_dev(lo->lo_disk)->kobj,
 725                                   &loop_attribute_group);
 726 }
 727
 728 static void loop_sysfs_exit(struct loop_device *lo)
 729 {
 730         sysfs_remove_group(&disk_to_dev(lo->lo_disk)->kobj,
 731                            &loop_attribute_group);
 732 }
 733
 734 static void loop_config_discard(struct loop_device *lo)
 735 {
 736         struct file *file = lo->lo_backing_file;
 737         struct inode *inode = file->f_mapping->host;
 738         struct request_queue *q = lo->lo_queue;
 739
 740         /*
 741          * We use punch hole to reclaim the free space used by the
 742          * image a.k.a. discard. However we do not support discard if
 743          * encryption is enabled, because it may give an attacker
 744          * useful information.
 745          */
 746         if ((!file->f_op->fallocate) ||
 747             lo->lo_encrypt_key_size) {
 748                 q->limits.discard_granularity = 0;
 749                 q->limits.discard_alignment = 0;
 750                 blk_queue_max_discard_sectors(q, 0);
 751                 q->limits.discard_zeroes_data = 0;
 752                 queue_flag_clear_unlocked(QUEUE_FLAG_DISCARD, q);
 753                 return;
 754         }
 755
 756         q->limits.discard_granularity = inode->i_sb->s_blocksize;
 757         q->limits.discard_alignment = 0;
 758         blk_queue_max_discard_sectors(q, UINT_MAX >> 9);
 759         q->limits.discard_zeroes_data = 1;
 760         queue_flag_set_unlocked(QUEUE_FLAG_DISCARD, q);
 761 }
 762
 763 static void loop_unprepare_queue(struct loop_device *lo)
 764 {
 765         flush_kthread_worker(&lo->worker);
 766         kthread_stop(lo->worker_task);
 767 }
 768
 769 static int loop_prepare_queue(struct loop_device *lo)
 770 {
 771         init_kthread_worker(&lo->worker);
 772         lo->worker_task = kthread_run(kthread_worker_fn,
 773                         &lo->worker, "loop%d", lo->lo_number);
 774         if (IS_ERR(lo->worker_task))
 775                 return -ENOMEM;
 776         set_user_nice(lo->worker_task, MIN_NICE);
 777         return 0;
 778 }
 779
 780 static int loop_set_fd(struct loop_device *lo, fmode_t mode,
 781                        struct block_device *bdev, unsigned int arg)
 782 {
 783         struct file     *file, *f;
 784         struct inode    *inode;
 785         struct address_space *mapping;
 786         unsigned lo_blocksize;
 787         int             lo_flags = 0;
 788         int             error;
 789         loff_t          size;
 790
 791         /* This is safe, since we have a reference from open(). */
 792         __module_get(THIS_MODULE);
 793
 794         error = -EBADF;
 795         file = fget(arg);
 796         if (!file)
 797                 goto out;
 798
 799         error = -EBUSY;
 800         if (lo->lo_state != Lo_unbound)
 801                 goto out_putf;
 802
 803         /* Avoid recursion */
 804         f = file;
 805         while (is_loop_device(f)) {
 806                 struct loop_device *l;
 807
 808                 if (f->f_mapping->host->i_bdev == bdev)
 809                         goto out_putf;
 810
 811                 l = f->f_mapping->host->i_bdev->bd_disk->private_data;
 812                 if (l->lo_state == Lo_unbound) {
 813                         error = -EINVAL;
 814                         goto out_putf;
 815                 }
 816                 f = l->lo_backing_file;
 817         }
 818
 819         mapping = file->f_mapping;
 820         inode = mapping->host;
 821
 822         error = -EINVAL;
 823         if (!S_ISREG(inode->i_mode) && !S_ISBLK(inode->i_mode))
 824                 goto out_putf;
 825
 826         if (!(file->f_mode & FMODE_WRITE) || !(mode & FMODE_WRITE) ||
 827             !file->f_op->write_iter)
 828                 lo_flags |= LO_FLAGS_READ_ONLY;
 829
 830         lo_blocksize = S_ISBLK(inode->i_mode) ?
 831                 inode->i_bdev->bd_block_size : PAGE_SIZE;
 832
 833         error = -EFBIG;
 834         size = get_loop_size(lo, file);
 835         if ((loff_t)(sector_t)size != size)
 836                 goto out_putf;
 837         error = loop_prepare_queue(lo);
 838         if (error)
 839                 goto out_putf;
 840
 841         error = 0;
 842
 843         set_device_ro(bdev, (lo_flags & LO_FLAGS_READ_ONLY) != 0);
 844
 845         lo->use_dio = false;
 846         lo->lo_blocksize = lo_blocksize;
 847         lo->lo_device = bdev;
 848         lo->lo_flags = lo_flags;
 849         lo->lo_backing_file = file;
 850         lo->transfer = NULL;
 851         lo->ioctl = NULL;
 852         lo->lo_sizelimit = 0;
 853         lo->old_gfp_mask = mapping_gfp_mask(mapping);
 854         mapping_set_gfp_mask(mapping, lo->old_gfp_mask & ~(__GFP_IO|__GFP_FS));
 855
 856         if (!(lo_flags & LO_FLAGS_READ_ONLY) && file->f_op->fsync)
 857                 blk_queue_flush(lo->lo_queue, REQ_FLUSH);
 858
 859         loop_update_dio(lo);
 860         set_capacity(lo->lo_disk, size);
 861         bd_set_size(bdev, size << 9);
 862         loop_sysfs_init(lo);
 863         /* let user-space know about the new size */
 864         kobject_uevent(&disk_to_dev(bdev->bd_disk)->kobj, KOBJ_CHANGE);
 865
 866         set_blocksize(bdev, lo_blocksize);
 867
 868         lo->lo_state = Lo_bound;
 869         if (part_shift)
 870                 lo->lo_flags |= LO_FLAGS_PARTSCAN;
 871         if (lo->lo_flags & LO_FLAGS_PARTSCAN)
 872                 loop_reread_partitions(lo, bdev);
 873
 874         /* Grab the block_device to prevent its destruction after we
 875          * put /dev/loopXX inode. Later in loop_clr_fd() we bdput(bdev).
 876          */
 877         bdgrab(bdev);
 878         return 0;
 879
 880  out_putf:
 881         fput(file);
 882  out:
 883         /* This is safe: open() is still holding a reference. */
 884         module_put(THIS_MODULE);
 885         return error;
 886 }
 887
 888 static int
 889 loop_release_xfer(struct loop_device *lo)
 890 {
 891         int err = 0;
 892         struct loop_func_table *xfer = lo->lo_encryption;
 893
 894         if (xfer) {
 895                 if (xfer->release)
 896                         err = xfer->release(lo);
 897                 lo->transfer = NULL;
 898                 lo->lo_encryption = NULL;
 899                 module_put(xfer->owner);
 900         }
 901         return err;
 902 }
 903
 904 static int
 905 loop_init_xfer(struct loop_device *lo, struct loop_func_table *xfer,
 906                const struct loop_info64 *i)
 907 {
 908         int err = 0;
 909
 910         if (xfer) {
 911                 struct module *owner = xfer->owner;
 912
 913                 if (!try_module_get(owner))
 914                         return -EINVAL;
 915                 if (xfer->init)
 916                         err = xfer->init(lo, i);
 917                 if (err)
 918                         module_put(owner);
 919                 else
 920                         lo->lo_encryption = xfer;
 921         }
 922         return err;
 923 }
 924
 925 static int loop_clr_fd(struct loop_device *lo)
 926 {
 927         struct file *filp = lo->lo_backing_file;
 928         gfp_t gfp = lo->old_gfp_mask;
 929         struct block_device *bdev = lo->lo_device;
 930
 931         if (lo->lo_state != Lo_bound)
 932                 return -ENXIO;
 933
 934         /*
 935          * If we've explicitly asked to tear down the loop device,
 936          * and it has an elevated reference count, set it for auto-teardown when
 937          * the last reference goes away. This stops $!~#$@ udev from
 938          * preventing teardown because it decided that it needs to run blkid on
 939          * the loopback device whenever they appear. xfstests is notorious for
 940          * failing tests because blkid via udev races with a losetup
 941          * <dev>/do something like mkfs/losetup -d <dev> causing the losetup -d
 942          * command to fail with EBUSY.
 943          */
 944         if (atomic_read(&lo->lo_refcnt) > 1) {
 945                 lo->lo_flags |= LO_FLAGS_AUTOCLEAR;
 946                 mutex_unlock(&lo->lo_ctl_mutex);
 947                 return 0;
 948         }
 949
 950         if (filp == NULL)
 951                 return -EINVAL;
 952
 953         /* freeze request queue during the transition */
 954         blk_mq_freeze_queue(lo->lo_queue);
 955
 956         spin_lock_irq(&lo->lo_lock);
 957         lo->lo_state = Lo_rundown;
 958         lo->lo_backing_file = NULL;
 959         spin_unlock_irq(&lo->lo_lock);
 960
 961         loop_release_xfer(lo);
 962         lo->transfer = NULL;
 963         lo->ioctl = NULL;
 964         lo->lo_device = NULL;
 965         lo->lo_encryption = NULL;
 966         lo->lo_offset = 0;
 967         lo->lo_sizelimit = 0;
 968         lo->lo_encrypt_key_size = 0;
 969         memset(lo->lo_encrypt_key, 0, LO_KEY_SIZE);
 970         memset(lo->lo_crypt_name, 0, LO_NAME_SIZE);
 971         memset(lo->lo_file_name, 0, LO_NAME_SIZE);
 972         if (bdev) {
 973                 bdput(bdev);
 974                 invalidate_bdev(bdev);
 975         }
 976         set_capacity(lo->lo_disk, 0);
 977         loop_sysfs_exit(lo);
 978         if (bdev) {
 979                 bd_set_size(bdev, 0);
 980                 /* let user-space know about this change */
 981                 kobject_uevent(&disk_to_dev(bdev->bd_disk)->kobj, KOBJ_CHANGE);
 982         }
 983         mapping_set_gfp_mask(filp->f_mapping, gfp);
 984         lo->lo_state = Lo_unbound;
 985         /* This is safe: open() is still holding a reference. */
 986         module_put(THIS_MODULE);
 987         blk_mq_unfreeze_queue(lo->lo_queue);
 988
 989         if (lo->lo_flags & LO_FLAGS_PARTSCAN && bdev)
 990                 loop_reread_partitions(lo, bdev);
 991         lo->lo_flags = 0;
 992         if (!part_shift)
 993                 lo->lo_disk->flags |= GENHD_FL_NO_PART_SCAN;
 994         loop_unprepare_queue(lo);
 995         mutex_unlock(&lo->lo_ctl_mutex);
 996         /*
 997          * Need not hold lo_ctl_mutex to fput backing file.
 998          * Calling fput holding lo_ctl_mutex triggers a circular
 999          * lock dependency possibility warning as fput can take
1000          * bd_mutex which is usually taken before lo_ctl_mutex.
1001          */
1002         fput(filp);
1003         return 0;
1004 }
1005
1006 static int
1007 loop_set_status(struct loop_device *lo, const struct loop_info64 *info)
1008 {
1009         int err;
1010         struct loop_func_table *xfer;
1011         kuid_t uid = current_uid();
1012
1013         if (lo->lo_encrypt_key_size &&
1014             !uid_eq(lo->lo_key_owner, uid) &&
1015             !capable(CAP_SYS_ADMIN))
1016                 return -EPERM;
1017         if (lo->lo_state != Lo_bound)
1018                 return -ENXIO;
1019         if ((unsigned int) info->lo_encrypt_key_size > LO_KEY_SIZE)
1020                 return -EINVAL;
1021
1022         err = loop_release_xfer(lo);
1023         if (err)
1024                 return err;
1025
1026         if (info->lo_encrypt_type) {
1027                 unsigned int type = info->lo_encrypt_type;
1028
1029                 if (type >= MAX_LO_CRYPT)
1030                         return -EINVAL;
1031                 xfer = xfer_funcs[type];
1032                 if (xfer == NULL)
1033                         return -EINVAL;
1034         } else
1035                 xfer = NULL;
1036
1037         err = loop_init_xfer(lo, xfer, info);
1038         if (err)
1039                 return err;
1040
1041         if (lo->lo_offset != info->lo_offset ||
1042             lo->lo_sizelimit != info->lo_sizelimit)
1043                 if (figure_loop_size(lo, info->lo_offset, info->lo_sizelimit))
1044                         return -EFBIG;
1045
1046         loop_config_discard(lo);
1047
1048         memcpy(lo->lo_file_name, info->lo_file_name, LO_NAME_SIZE);
1049         memcpy(lo->lo_crypt_name, info->lo_crypt_name, LO_NAME_SIZE);
1050         lo->lo_file_name[LO_NAME_SIZE-1] = 0;
1051         lo->lo_crypt_name[LO_NAME_SIZE-1] = 0;
1052
1053         if (!xfer)
1054                 xfer = &none_funcs;
1055         lo->transfer = xfer->transfer;
1056         lo->ioctl = xfer->ioctl;
1057
1058         if ((lo->lo_flags & LO_FLAGS_AUTOCLEAR) !=
1059              (info->lo_flags & LO_FLAGS_AUTOCLEAR))
1060                 lo->lo_flags ^= LO_FLAGS_AUTOCLEAR;
1061
1062         if ((info->lo_flags & LO_FLAGS_PARTSCAN) &&
1063              !(lo->lo_flags & LO_FLAGS_PARTSCAN)) {
1064                 lo->lo_flags |= LO_FLAGS_PARTSCAN;
1065                 lo->lo_disk->flags &= ~GENHD_FL_NO_PART_SCAN;
1066                 loop_reread_partitions(lo, lo->lo_device);
1067         }
1068
1069         lo->lo_encrypt_key_size = info->lo_encrypt_key_size;
1070         lo->lo_init[0] = info->lo_init[0];
1071         lo->lo_init[1] = info->lo_init[1];
1072         if (info->lo_encrypt_key_size) {
1073                 memcpy(lo->lo_encrypt_key, info->lo_encrypt_key,
1074                        info->lo_encrypt_key_size);
1075                 lo->lo_key_owner = uid;
1076         }
1077
1078         /* update dio if lo_offset or transfer is changed */
1079         __loop_update_dio(lo, lo->use_dio);
1080
1081         return 0;
1082 }
1083
1084 static int
1085 loop_get_status(struct loop_device *lo, struct loop_info64 *info)
1086 {
1087         struct file *file = lo->lo_backing_file;
1088         struct kstat stat;
1089         int error;
1090
1091         if (lo->lo_state != Lo_bound)
1092                 return -ENXIO;
1093         error = vfs_getattr(&file->f_path, &stat);
1094         if (error)
1095                 return error;
1096         memset(info, 0, sizeof(*info));
1097         info->lo_number = lo->lo_number;
1098         info->lo_device = huge_encode_dev(stat.dev);
1099         info->lo_inode = stat.ino;
1100         info->lo_rdevice = huge_encode_dev(lo->lo_device ? stat.rdev : stat.dev);
1101         info->lo_offset = lo->lo_offset;
1102         info->lo_sizelimit = lo->lo_sizelimit;
1103         info->lo_flags = lo->lo_flags;
1104         memcpy(info->lo_file_name, lo->lo_file_name, LO_NAME_SIZE);
1105         memcpy(info->lo_crypt_name, lo->lo_crypt_name, LO_NAME_SIZE);
1106         info->lo_encrypt_type =
1107                 lo->lo_encryption ? lo->lo_encryption->number : 0;
1108         if (lo->lo_encrypt_key_size && capable(CAP_SYS_ADMIN)) {
1109                 info->lo_encrypt_key_size = lo->lo_encrypt_key_size;
1110                 memcpy(info->lo_encrypt_key, lo->lo_encrypt_key,
1111                        lo->lo_encrypt_key_size);
1112         }
1113         return 0;
1114 }
1115
1116 static void
1117 loop_info64_from_old(const struct loop_info *info, struct loop_info64 *info64)
1118 {
1119         memset(info64, 0, sizeof(*info64));
1120         info64->lo_number = info->lo_number;
1121         info64->lo_device = info->lo_device;
1122         info64->lo_inode = info->lo_inode;
1123         info64->lo_rdevice = info->lo_rdevice;
1124         info64->lo_offset = info->lo_offset;
1125         info64->lo_sizelimit = 0;
1126         info64->lo_encrypt_type = info->lo_encrypt_type;
1127         info64->lo_encrypt_key_size = info->lo_encrypt_key_size;
1128         info64->lo_flags = info->lo_flags;
1129         info64->lo_init[0] = info->lo_init[0];
1130         info64->lo_init[1] = info->lo_init[1];
1131         if (info->lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1132                 memcpy(info64->lo_crypt_name, info->lo_name, LO_NAME_SIZE);
1133         else
1134                 memcpy(info64->lo_file_name, info->lo_name, LO_NAME_SIZE);
1135         memcpy(info64->lo_encrypt_key, info->lo_encrypt_key, LO_KEY_SIZE);
1136 }
1137
1138 static int
1139 loop_info64_to_old(const struct loop_info64 *info64, struct loop_info *info)
1140 {
1141         memset(info, 0, sizeof(*info));
1142         info->lo_number = info64->lo_number;
1143         info->lo_device = info64->lo_device;
1144         info->lo_inode = info64->lo_inode;
1145         info->lo_rdevice = info64->lo_rdevice;
1146         info->lo_offset = info64->lo_offset;
1147         info->lo_encrypt_type = info64->lo_encrypt_type;
1148         info->lo_encrypt_key_size = info64->lo_encrypt_key_size;
1149         info->lo_flags = info64->lo_flags;
1150         info->lo_init[0] = info64->lo_init[0];
1151         info->lo_init[1] = info64->lo_init[1];
1152         if (info->lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1153                 memcpy(info->lo_name, info64->lo_crypt_name, LO_NAME_SIZE);
1154         else
1155                 memcpy(info->lo_name, info64->lo_file_name, LO_NAME_SIZE);
1156         memcpy(info->lo_encrypt_key, info64->lo_encrypt_key, LO_KEY_SIZE);
1157
1158         /* error in case values were truncated */
1159         if (info->lo_device != info64->lo_device ||
1160             info->lo_rdevice != info64->lo_rdevice ||
1161             info->lo_inode != info64->lo_inode ||
1162             info->lo_offset != info64->lo_offset)
1163                 return -EOVERFLOW;
1164
1165         return 0;
1166 }
1167
1168 static int
1169 loop_set_status_old(struct loop_device *lo, const struct loop_info __user *arg)
1170 {
1171         struct loop_info info;
1172         struct loop_info64 info64;
1173
1174         if (copy_from_user(&info, arg, sizeof (struct loop_info)))
1175                 return -EFAULT;
1176         loop_info64_from_old(&info, &info64);
1177         return loop_set_status(lo, &info64);
1178 }
1179
1180 static int
1181 loop_set_status64(struct loop_device *lo, const struct loop_info64 __user *arg)
1182 {
1183         struct loop_info64 info64;
1184
1185         if (copy_from_user(&info64, arg, sizeof (struct loop_info64)))
1186                 return -EFAULT;
1187         return loop_set_status(lo, &info64);
1188 }
1189
1190 static int
1191 loop_get_status_old(struct loop_device *lo, struct loop_info __user *arg) {
1192         struct loop_info info;
1193         struct loop_info64 info64;
1194         int err = 0;
1195
1196         if (!arg)
1197                 err = -EINVAL;
1198         if (!err)
1199                 err = loop_get_status(lo, &info64);
1200         if (!err)
1201                 err = loop_info64_to_old(&info64, &info);
1202         if (!err && copy_to_user(arg, &info, sizeof(info)))
1203                 err = -EFAULT;
1204
1205         return err;
1206 }
1207
1208 static int
1209 loop_get_status64(struct loop_device *lo, struct loop_info64 __user *arg) {
1210         struct loop_info64 info64;
1211         int err = 0;
1212
1213         if (!arg)
1214                 err = -EINVAL;
1215         if (!err)
1216                 err = loop_get_status(lo, &info64);
1217         if (!err && copy_to_user(arg, &info64, sizeof(info64)))
1218                 err = -EFAULT;
1219
1220         return err;
1221 }
1222
1223 static int loop_set_capacity(struct loop_device *lo, struct block_device *bdev)
1224 {
1225         if (unlikely(lo->lo_state != Lo_bound))
1226                 return -ENXIO;
1227
1228         return figure_loop_size(lo, lo->lo_offset, lo->lo_sizelimit);
1229 }
1230
1231 static int lo_ioctl(struct block_device *bdev, fmode_t mode,
1232         unsigned int cmd, unsigned long arg)
1233 {
1234         struct loop_device *lo = bdev->bd_disk->private_data;
1235         int err;
1236
1237         mutex_lock_nested(&lo->lo_ctl_mutex, 1);
1238         switch (cmd) {
1239         case LOOP_SET_FD:
1240                 err = loop_set_fd(lo, mode, bdev, arg);
1241                 break;
1242         case LOOP_CHANGE_FD:
1243                 err = loop_change_fd(lo, bdev, arg);
1244                 break;
1245         case LOOP_CLR_FD:
1246                 /* loop_clr_fd would have unlocked lo_ctl_mutex on success */
1247                 err = loop_clr_fd(lo);
1248                 if (!err)
1249                         goto out_unlocked;
1250                 break;
1251         case LOOP_SET_STATUS:
1252                 err = -EPERM;
1253                 if ((mode & FMODE_WRITE) || capable(CAP_SYS_ADMIN))
1254                         err = loop_set_status_old(lo,
1255                                         (struct loop_info __user *)arg);
1256                 break;
1257         case LOOP_GET_STATUS:
1258                 err = loop_get_status_old(lo, (struct loop_info __user *) arg);
1259                 break;
1260         case LOOP_SET_STATUS64:
1261                 err = -EPERM;
1262                 if ((mode & FMODE_WRITE) || capable(CAP_SYS_ADMIN))
1263                         err = loop_set_status64(lo,
1264                                         (struct loop_info64 __user *) arg);
1265                 break;
1266         case LOOP_GET_STATUS64:
1267                 err = loop_get_status64(lo, (struct loop_info64 __user *) arg);
1268                 break;
1269         case LOOP_SET_CAPACITY:
1270                 err = -EPERM;
1271                 if ((mode & FMODE_WRITE) || capable(CAP_SYS_ADMIN))
1272                         err = loop_set_capacity(lo, bdev);
1273                 break;
1274         default:
1275                 err = lo->ioctl ? lo->ioctl(lo, cmd, arg) : -EINVAL;
1276         }
1277         mutex_unlock(&lo->lo_ctl_mutex);
1278
1279 out_unlocked:
1280         return err;
1281 }
1282
1283 #ifdef CONFIG_COMPAT
1284 struct compat_loop_info {
1285         compat_int_t    lo_number;      /* ioctl r/o */
1286         compat_dev_t    lo_device;      /* ioctl r/o */
1287         compat_ulong_t  lo_inode;       /* ioctl r/o */
1288         compat_dev_t    lo_rdevice;     /* ioctl r/o */
1289         compat_int_t    lo_offset;
1290         compat_int_t    lo_encrypt_type;
1291         compat_int_t    lo_encrypt_key_size;    /* ioctl w/o */
1292         compat_int_t    lo_flags;       /* ioctl r/o */
1293         char            lo_name[LO_NAME_SIZE];
1294         unsigned char   lo_encrypt_key[LO_KEY_SIZE]; /* ioctl w/o */
1295         compat_ulong_t  lo_init[2];
1296         char            reserved[4];
1297 };
1298
1299 /*
1300  * Transfer 32-bit compatibility structure in userspace to 64-bit loop info
1301  * - noinlined to reduce stack space usage in main part of driver
1302  */
1303 static noinline int
1304 loop_info64_from_compat(const struct compat_loop_info __user *arg,
1305                         struct loop_info64 *info64)
1306 {
1307         struct compat_loop_info info;
1308
1309         if (copy_from_user(&info, arg, sizeof(info)))
1310                 return -EFAULT;
1311
1312         memset(info64, 0, sizeof(*info64));
1313         info64->lo_number = info.lo_number;
1314         info64->lo_device = info.lo_device;
1315         info64->lo_inode = info.lo_inode;
1316         info64->lo_rdevice = info.lo_rdevice;
1317         info64->lo_offset = info.lo_offset;
1318         info64->lo_sizelimit = 0;
1319         info64->lo_encrypt_type = info.lo_encrypt_type;
1320         info64->lo_encrypt_key_size = info.lo_encrypt_key_size;
1321         info64->lo_flags = info.lo_flags;
1322         info64->lo_init[0] = info.lo_init[0];
1323         info64->lo_init[1] = info.lo_init[1];
1324         if (info.lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1325                 memcpy(info64->lo_crypt_name, info.lo_name, LO_NAME_SIZE);
1326         else
1327                 memcpy(info64->lo_file_name, info.lo_name, LO_NAME_SIZE);
1328         memcpy(info64->lo_encrypt_key, info.lo_encrypt_key, LO_KEY_SIZE);
1329         return 0;
1330 }
1331
1332 /*
1333  * Transfer 64-bit loop info to 32-bit compatibility structure in userspace
1334  * - noinlined to reduce stack space usage in main part of driver
1335  */
1336 static noinline int
1337 loop_info64_to_compat(const struct loop_info64 *info64,
1338                       struct compat_loop_info __user *arg)
1339 {
1340         struct compat_loop_info info;
1341
1342         memset(&info, 0, sizeof(info));
1343         info.lo_number = info64->lo_number;
1344         info.lo_device = info64->lo_device;
1345         info.lo_inode = info64->lo_inode;
1346         info.lo_rdevice = info64->lo_rdevice;
1347         info.lo_offset = info64->lo_offset;
1348         info.lo_encrypt_type = info64->lo_encrypt_type;
1349         info.lo_encrypt_key_size = info64->lo_encrypt_key_size;
1350         info.lo_flags = info64->lo_flags;
1351         info.lo_init[0] = info64->lo_init[0];
1352         info.lo_init[1] = info64->lo_init[1];
1353         if (info.lo_encrypt_type == LO_CRYPT_CRYPTOAPI)
1354                 memcpy(info.lo_name, info64->lo_crypt_name, LO_NAME_SIZE);
1355         else
1356                 memcpy(info.lo_name, info64->lo_file_name, LO_NAME_SIZE);
1357         memcpy(info.lo_encrypt_key, info64->lo_encrypt_key, LO_KEY_SIZE);
1358
1359         /* error in case values were truncated */
1360         if (info.lo_device != info64->lo_device ||
1361             info.lo_rdevice != info64->lo_rdevice ||
1362             info.lo_inode != info64->lo_inode ||
1363             info.lo_offset != info64->lo_offset ||
1364             info.lo_init[0] != info64->lo_init[0] ||
1365             info.lo_init[1] != info64->lo_init[1])
1366                 return -EOVERFLOW;
1367
1368         if (copy_to_user(arg, &info, sizeof(info)))
1369                 return -EFAULT;
1370         return 0;
1371 }
1372
1373 static int
1374 loop_set_status_compat(struct loop_device *lo,
1375                        const struct compat_loop_info __user *arg)
1376 {
1377         struct loop_info64 info64;
1378         int ret;
1379
1380         ret = loop_info64_from_compat(arg, &info64);
1381         if (ret < 0)
1382                 return ret;
1383         return loop_set_status(lo, &info64);
1384 }
1385
1386 static int
1387 loop_get_status_compat(struct loop_device *lo,
1388                        struct compat_loop_info __user *arg)
1389 {
1390         struct loop_info64 info64;
1391         int err = 0;
1392
1393         if (!arg)
1394                 err = -EINVAL;
1395         if (!err)
1396                 err = loop_get_status(lo, &info64);
1397         if (!err)
1398                 err = loop_info64_to_compat(&info64, arg);
1399         return err;
1400 }
1401
1402 static int lo_compat_ioctl(struct block_device *bdev, fmode_t mode,
1403                            unsigned int cmd, unsigned long arg)
1404 {
1405         struct loop_device *lo = bdev->bd_disk->private_data;
1406         int err;
1407
1408         switch(cmd) {
1409         case LOOP_SET_STATUS:
1410                 mutex_lock(&lo->lo_ctl_mutex);
1411                 err = loop_set_status_compat(
1412                         lo, (const struct compat_loop_info __user *) arg);
1413                 mutex_unlock(&lo->lo_ctl_mutex);
1414                 break;
1415         case LOOP_GET_STATUS:
1416                 mutex_lock(&lo->lo_ctl_mutex);
1417                 err = loop_get_status_compat(
1418                         lo, (struct compat_loop_info __user *) arg);
1419                 mutex_unlock(&lo->lo_ctl_mutex);
1420                 break;
1421         case LOOP_SET_CAPACITY:
1422         case LOOP_CLR_FD:
1423         case LOOP_GET_STATUS64:
1424         case LOOP_SET_STATUS64:
1425                 arg = (unsigned long) compat_ptr(arg);
1426         case LOOP_SET_FD:
1427         case LOOP_CHANGE_FD:
1428                 err = lo_ioctl(bdev, mode, cmd, arg);
1429                 break;
1430         default:
1431                 err = -ENOIOCTLCMD;
1432                 break;
1433         }
1434         return err;
1435 }
1436 #endif
1437
1438 static int lo_open(struct block_device *bdev, fmode_t mode)
1439 {
1440         struct loop_device *lo;
1441         int err = 0;
1442
1443         mutex_lock(&loop_index_mutex);
1444         lo = bdev->bd_disk->private_data;
1445         if (!lo) {
1446                 err = -ENXIO;
1447                 goto out;
1448         }
1449
1450         atomic_inc(&lo->lo_refcnt);
1451 out:
1452         mutex_unlock(&loop_index_mutex);
1453         return err;
1454 }
1455
1456 static void lo_release(struct gendisk *disk, fmode_t mode)
1457 {
1458         struct loop_device *lo = disk->private_data;
1459         int err;
1460
1461         if (atomic_dec_return(&lo->lo_refcnt))
1462                 return;
1463
1464         mutex_lock(&lo->lo_ctl_mutex);
1465         if (lo->lo_flags & LO_FLAGS_AUTOCLEAR) {
1466                 /*
1467                  * In autoclear mode, stop the loop thread
1468                  * and remove configuration after last close.
1469                  */
1470                 err = loop_clr_fd(lo);
1471                 if (!err)
1472                         return;
1473         } else {
1474                 /*
1475                  * Otherwise keep thread (if running) and config,
1476                  * but flush possible ongoing bios in thread.
1477                  */
1478                 loop_flush(lo);
1479         }
1480
1481         mutex_unlock(&lo->lo_ctl_mutex);
1482 }
1483
1484 static const struct block_device_operations lo_fops = {
1485         .owner =        THIS_MODULE,
1486         .open =         lo_open,
1487         .release =      lo_release,
1488         .ioctl =        lo_ioctl,
1489 #ifdef CONFIG_COMPAT
1490         .compat_ioctl = lo_compat_ioctl,
1491 #endif
1492 };
1493
1494 /*
1495  * And now the modules code and kernel interface.
1496  */
1497 static int max_loop;
1498 module_param(max_loop, int, S_IRUGO);
1499 MODULE_PARM_DESC(max_loop, "Maximum number of loop devices");
1500 module_param(max_part, int, S_IRUGO);
1501 MODULE_PARM_DESC(max_part, "Maximum number of partitions per loop device");
1502 MODULE_LICENSE("GPL");
1503 MODULE_ALIAS_BLOCKDEV_MAJOR(LOOP_MAJOR);
1504
1505 int loop_register_transfer(struct loop_func_table *funcs)
1506 {
1507         unsigned int n = funcs->number;
1508
1509         if (n >= MAX_LO_CRYPT || xfer_funcs[n])
1510                 return -EINVAL;
1511         xfer_funcs[n] = funcs;
1512         return 0;
1513 }
1514
1515 static int unregister_transfer_cb(int id, void *ptr, void *data)
1516 {
1517         struct loop_device *lo = ptr;
1518         struct loop_func_table *xfer = data;
1519
1520         mutex_lock(&lo->lo_ctl_mutex);
1521         if (lo->lo_encryption == xfer)
1522                 loop_release_xfer(lo);
1523         mutex_unlock(&lo->lo_ctl_mutex);
1524         return 0;
1525 }
1526
1527 int loop_unregister_transfer(int number)
1528 {
1529         unsigned int n = number;
1530         struct loop_func_table *xfer;
1531
1532         if (n == 0 || n >= MAX_LO_CRYPT || (xfer = xfer_funcs[n]) == NULL)
1533                 return -EINVAL;
1534
1535         xfer_funcs[n] = NULL;
1536         idr_for_each(&loop_index_idr, &unregister_transfer_cb, xfer);
1537         return 0;
1538 }
1539
1540 EXPORT_SYMBOL(loop_register_transfer);
1541 EXPORT_SYMBOL(loop_unregister_transfer);
1542
1543 static int loop_queue_rq(struct blk_mq_hw_ctx *hctx,
1544                 const struct blk_mq_queue_data *bd)
1545 {
1546         struct loop_cmd *cmd = blk_mq_rq_to_pdu(bd->rq);
1547         struct loop_device *lo = cmd->rq->q->queuedata;
1548
1549         blk_mq_start_request(bd->rq);
1550
1551         if (lo->lo_state != Lo_bound)
1552                 return -EIO;
1553
1554         queue_kthread_work(&lo->worker, &cmd->work);
1555
1556         return BLK_MQ_RQ_QUEUE_OK;
1557 }
1558
1559 static void loop_handle_cmd(struct loop_cmd *cmd)
1560 {
1561         const bool write = cmd->rq->cmd_flags & REQ_WRITE;
1562         struct loop_device *lo = cmd->rq->q->queuedata;
1563         int ret = -EIO;
1564
1565         if (write && (lo->lo_flags & LO_FLAGS_READ_ONLY))
1566                 goto failed;
1567
1568         ret = do_req_filebacked(lo, cmd->rq);
1569
1570  failed:
1571         if (ret)
1572                 cmd->rq->errors = -EIO;
1573         blk_mq_complete_request(cmd->rq);
1574 }
1575
1576 static void loop_queue_work(struct kthread_work *work)
1577 {
1578         struct loop_cmd *cmd =
1579                 container_of(work, struct loop_cmd, work);
1580
1581         loop_handle_cmd(cmd);
1582 }
1583
1584 static int loop_init_request(void *data, struct request *rq,
1585                 unsigned int hctx_idx, unsigned int request_idx,
1586                 unsigned int numa_node)
1587 {
1588         struct loop_cmd *cmd = blk_mq_rq_to_pdu(rq);
1589
1590         cmd->rq = rq;
1591         init_kthread_work(&cmd->work, loop_queue_work);
1592
1593         return 0;
1594 }
1595
1596 static struct blk_mq_ops loop_mq_ops = {
1597         .queue_rq       = loop_queue_rq,
1598         .map_queue      = blk_mq_map_queue,
1599         .init_request   = loop_init_request,
1600 };
1601
1602 static int loop_add(struct loop_device **l, int i)
1603 {
1604         struct loop_device *lo;
1605         struct gendisk *disk;
1606         int err;
1607
1608         err = -ENOMEM;
1609         lo = kzalloc(sizeof(*lo), GFP_KERNEL);
1610         if (!lo)
1611                 goto out;
1612
1613         lo->lo_state = Lo_unbound;
1614
1615         /* allocate id, if @id >= 0, we're requesting that specific id */
1616         if (i >= 0) {
1617                 err = idr_alloc(&loop_index_idr, lo, i, i + 1, GFP_KERNEL);
1618                 if (err == -ENOSPC)
1619                         err = -EEXIST;
1620         } else {
1621                 err = idr_alloc(&loop_index_idr, lo, 0, 0, GFP_KERNEL);
1622         }
1623         if (err < 0)
1624                 goto out_free_dev;
1625         i = err;
1626
1627         err = -ENOMEM;
1628         lo->tag_set.ops = &loop_mq_ops;
1629         lo->tag_set.nr_hw_queues = 1;
1630         lo->tag_set.queue_depth = 128;
1631         lo->tag_set.numa_node = NUMA_NO_NODE;
1632         lo->tag_set.cmd_size = sizeof(struct loop_cmd);
1633         lo->tag_set.flags = BLK_MQ_F_SHOULD_MERGE | BLK_MQ_F_SG_MERGE;
1634         lo->tag_set.driver_data = lo;
1635
1636         err = blk_mq_alloc_tag_set(&lo->tag_set);
1637         if (err)
1638                 goto out_free_idr;
1639
1640         lo->lo_queue = blk_mq_init_queue(&lo->tag_set);
1641         if (IS_ERR_OR_NULL(lo->lo_queue)) {
1642                 err = PTR_ERR(lo->lo_queue);
1643                 goto out_cleanup_tags;
1644         }
1645         lo->lo_queue->queuedata = lo;
1646
1647         /*
1648          * It doesn't make sense to enable merge because the I/O
1649          * submitted to backing file is handled page by page.
1650          */
1651         queue_flag_set_unlocked(QUEUE_FLAG_NOMERGES, lo->lo_queue);
1652
1653         disk = lo->lo_disk = alloc_disk(1 << part_shift);
1654         if (!disk)
1655                 goto out_free_queue;
1656
1657         /*
1658          * Disable partition scanning by default. The in-kernel partition
1659          * scanning can be requested individually per-device during its
1660          * setup. Userspace can always add and remove partitions from all
1661          * devices. The needed partition minors are allocated from the
1662          * extended minor space, the main loop device numbers will continue
1663          * to match the loop minors, regardless of the number of partitions
1664          * used.
1665          *
1666          * If max_part is given, partition scanning is globally enabled for
1667          * all loop devices. The minors for the main loop devices will be
1668          * multiples of max_part.
1669          *
1670          * Note: Global-for-all-devices, set-only-at-init, read-only module
1671          * parameteters like 'max_loop' and 'max_part' make things needlessly
1672          * complicated, are too static, inflexible and may surprise
1673          * userspace tools. Parameters like this in general should be avoided.
1674          */
1675         if (!part_shift)
1676                 disk->flags |= GENHD_FL_NO_PART_SCAN;
1677         disk->flags |= GENHD_FL_EXT_DEVT;
1678         mutex_init(&lo->lo_ctl_mutex);
1679         atomic_set(&lo->lo_refcnt, 0);
1680         lo->lo_number           = i;
1681         spin_lock_init(&lo->lo_lock);
1682         disk->major             = LOOP_MAJOR;
1683         disk->first_minor       = i << part_shift;
1684         disk->fops              = &lo_fops;
1685         disk->private_data      = lo;
1686         disk->queue             = lo->lo_queue;
1687         sprintf(disk->disk_name, "loop%d", i);
1688         add_disk(disk);
1689         *l = lo;
1690         return lo->lo_number;
1691
1692 out_free_queue:
1693         blk_cleanup_queue(lo->lo_queue);
1694 out_cleanup_tags:
1695         blk_mq_free_tag_set(&lo->tag_set);
1696 out_free_idr:
1697         idr_remove(&loop_index_idr, i);
1698 out_free_dev:
1699         kfree(lo);
1700 out:
1701         return err;
1702 }
1703
1704 static void loop_remove(struct loop_device *lo)
1705 {
1706         blk_cleanup_queue(lo->lo_queue);
1707         del_gendisk(lo->lo_disk);
1708         blk_mq_free_tag_set(&lo->tag_set);
1709         put_disk(lo->lo_disk);
1710         kfree(lo);
1711 }
1712
1713 static int find_free_cb(int id, void *ptr, void *data)
1714 {
1715         struct loop_device *lo = ptr;
1716         struct loop_device **l = data;
1717
1718         if (lo->lo_state == Lo_unbound) {
1719                 *l = lo;
1720                 return 1;
1721         }
1722         return 0;
1723 }
1724
1725 static int loop_lookup(struct loop_device **l, int i)
1726 {
1727         struct loop_device *lo;
1728         int ret = -ENODEV;
1729
1730         if (i < 0) {
1731                 int err;
1732
1733                 err = idr_for_each(&loop_index_idr, &find_free_cb, &lo);
1734                 if (err == 1) {
1735                         *l = lo;
1736                         ret = lo->lo_number;
1737                 }
1738                 goto out;
1739         }
1740
1741         /* lookup and return a specific i */
1742         lo = idr_find(&loop_index_idr, i);
1743         if (lo) {
1744                 *l = lo;
1745                 ret = lo->lo_number;
1746         }
1747 out:
1748         return ret;
1749 }
1750
1751 static struct kobject *loop_probe(dev_t dev, int *part, void *data)
1752 {
1753         struct loop_device *lo;
1754         struct kobject *kobj;
1755         int err;
1756
1757         mutex_lock(&loop_index_mutex);
1758         err = loop_lookup(&lo, MINOR(dev) >> part_shift);
1759         if (err < 0)
1760                 err = loop_add(&lo, MINOR(dev) >> part_shift);
1761         if (err < 0)
1762                 kobj = NULL;
1763         else
1764                 kobj = get_disk(lo->lo_disk);
1765         mutex_unlock(&loop_index_mutex);
1766
1767         *part = 0;
1768         return kobj;
1769 }
1770
1771 static long loop_control_ioctl(struct file *file, unsigned int cmd,
1772                                unsigned long parm)
1773 {
1774         struct loop_device *lo;
1775         int ret = -ENOSYS;
1776
1777         mutex_lock(&loop_index_mutex);
1778         switch (cmd) {
1779         case LOOP_CTL_ADD:
1780                 ret = loop_lookup(&lo, parm);
1781                 if (ret >= 0) {
1782                         ret = -EEXIST;
1783                         break;
1784                 }
1785                 ret = loop_add(&lo, parm);
1786                 break;
1787         case LOOP_CTL_REMOVE:
1788                 ret = loop_lookup(&lo, parm);
1789                 if (ret < 0)
1790                         break;
1791                 mutex_lock(&lo->lo_ctl_mutex);
1792                 if (lo->lo_state != Lo_unbound) {
1793                         ret = -EBUSY;
1794                         mutex_unlock(&lo->lo_ctl_mutex);
1795                         break;
1796                 }
1797                 if (atomic_read(&lo->lo_refcnt) > 0) {
1798                         ret = -EBUSY;
1799                         mutex_unlock(&lo->lo_ctl_mutex);
1800                         break;
1801                 }
1802                 lo->lo_disk->private_data = NULL;
1803                 mutex_unlock(&lo->lo_ctl_mutex);
1804                 idr_remove(&loop_index_idr, lo->lo_number);
1805                 loop_remove(lo);
1806                 break;
1807         case LOOP_CTL_GET_FREE:
1808                 ret = loop_lookup(&lo, -1);
1809                 if (ret >= 0)
1810                         break;
1811                 ret = loop_add(&lo, -1);
1812         }
1813         mutex_unlock(&loop_index_mutex);
1814
1815         return ret;
1816 }
1817
1818 static const struct file_operations loop_ctl_fops = {
1819         .open           = nonseekable_open,
1820         .unlocked_ioctl = loop_control_ioctl,
1821         .compat_ioctl   = loop_control_ioctl,
1822         .owner          = THIS_MODULE,
1823         .llseek         = noop_llseek,
1824 };
1825
1826 static struct miscdevice loop_misc = {
1827         .minor          = LOOP_CTRL_MINOR,
1828         .name           = "loop-control",
1829         .fops           = &loop_ctl_fops,
1830 };
1831
1832 MODULE_ALIAS_MISCDEV(LOOP_CTRL_MINOR);
1833 MODULE_ALIAS("devname:loop-control");
1834
1835 static int __init loop_init(void)
1836 {
1837         int i, nr;
1838         unsigned long range;
1839         struct loop_device *lo;
1840         int err;
1841
1842         err = misc_register(&loop_misc);
1843         if (err < 0)
1844                 return err;
1845
1846         part_shift = 0;
1847         if (max_part > 0) {
1848                 part_shift = fls(max_part);
1849
1850                 /*
1851                  * Adjust max_part according to part_shift as it is exported
1852                  * to user space so that user can decide correct minor number
1853                  * if [s]he want to create more devices.
1854                  *
1855                  * Note that -1 is required because partition 0 is reserved
1856                  * for the whole disk.
1857                  */
1858                 max_part = (1UL << part_shift) - 1;
1859         }
1860
1861         if ((1UL << part_shift) > DISK_MAX_PARTS) {
1862                 err = -EINVAL;
1863                 goto misc_out;
1864         }
1865
1866         if (max_loop > 1UL << (MINORBITS - part_shift)) {
1867                 err = -EINVAL;
1868                 goto misc_out;
1869         }
1870
1871         /*
1872          * If max_loop is specified, create that many devices upfront.
1873          * This also becomes a hard limit. If max_loop is not specified,
1874          * create CONFIG_BLK_DEV_LOOP_MIN_COUNT loop devices at module
1875          * init time. Loop devices can be requested on-demand with the
1876          * /dev/loop-control interface, or be instantiated by accessing
1877          * a 'dead' device node.
1878          */
1879         if (max_loop) {
1880                 nr = max_loop;
1881                 range = max_loop << part_shift;
1882         } else {
1883                 nr = CONFIG_BLK_DEV_LOOP_MIN_COUNT;
1884                 range = 1UL << MINORBITS;
1885         }
1886
1887         if (register_blkdev(LOOP_MAJOR, "loop")) {
1888                 err = -EIO;
1889                 goto misc_out;
1890         }
1891
1892         blk_register_region(MKDEV(LOOP_MAJOR, 0), range,
1893                                   THIS_MODULE, loop_probe, NULL, NULL);
1894
1895         /* pre-create number of devices given by config or max_loop */
1896         mutex_lock(&loop_index_mutex);
1897         for (i = 0; i < nr; i++)
1898                 loop_add(&lo, i);
1899         mutex_unlock(&loop_index_mutex);
1900
1901         printk(KERN_INFO "loop: module loaded\n");
1902         return 0;
1903
1904 misc_out:
1905         misc_deregister(&loop_misc);
1906         return err;
1907 }
1908
1909 static int loop_exit_cb(int id, void *ptr, void *data)
1910 {
1911         struct loop_device *lo = ptr;
1912
1913         loop_remove(lo);
1914         return 0;
1915 }
1916
1917 static void __exit loop_exit(void)
1918 {
1919         unsigned long range;
1920
1921         range = max_loop ? max_loop << part_shift : 1UL << MINORBITS;
1922
1923         idr_for_each(&loop_index_idr, &loop_exit_cb, NULL);
1924         idr_destroy(&loop_index_idr);
1925
1926         blk_unregister_region(MKDEV(LOOP_MAJOR, 0), range);
1927         unregister_blkdev(LOOP_MAJOR, "loop");
1928
1929         misc_deregister(&loop_misc);
1930 }
1931
1932 module_init(loop_init);
1933 module_exit(loop_exit);
1934
1935 #ifndef MODULE
1936 static int __init max_loop_setup(char *str)
1937 {
1938         max_loop = simple_strtol(str, NULL, 0);
1939         return 1;
1940 }
1941
1942 __setup("max_loop=", max_loop_setup);
1943 #endif