fs/block_dev.c

   1 /*
   2  *  linux/fs/block_dev.c
   3  *
   4  *  Copyright (C) 1991, 1992  Linus Torvalds
   5  *  Copyright (C) 2001  Andrea Arcangeli <andrea@suse.de> SuSE
   6  */
   7
   8 #include <linux/init.h>
   9 #include <linux/mm.h>
  10 #include <linux/fcntl.h>
  11 #include <linux/slab.h>
  12 #include <linux/kmod.h>
  13 #include <linux/major.h>
  14 #include <linux/device_cgroup.h>
  15 #include <linux/highmem.h>
  16 #include <linux/blkdev.h>
  17 #include <linux/module.h>
  18 #include <linux/blkpg.h>
  19 #include <linux/magic.h>
  20 #include <linux/buffer_head.h>
  21 #include <linux/swap.h>
  22 #include <linux/pagevec.h>
  23 #include <linux/writeback.h>
  24 #include <linux/mpage.h>
  25 #include <linux/mount.h>
  26 #include <linux/uio.h>
  27 #include <linux/namei.h>
  28 #include <linux/log2.h>
  29 #include <linux/cleancache.h>
  30 #include <asm/uaccess.h>
  31 #include "internal.h"
  32
  33 struct bdev_inode {
  34         struct block_device bdev;
  35         struct inode vfs_inode;
  36 };
  37
  38 static const struct address_space_operations def_blk_aops;
  39
  40 static inline struct bdev_inode *BDEV_I(struct inode *inode)
  41 {
  42         return container_of(inode, struct bdev_inode, vfs_inode);
  43 }
  44
  45 inline struct block_device *I_BDEV(struct inode *inode)
  46 {
  47         return &BDEV_I(inode)->bdev;
  48 }
  49 EXPORT_SYMBOL(I_BDEV);
  50
  51 /*
  52  * Move the inode from its current bdi to a new bdi. If the inode is dirty we
  53  * need to move it onto the dirty list of @dst so that the inode is always on
  54  * the right list.
  55  */
  56 static void bdev_inode_switch_bdi(struct inode *inode,
  57                         struct backing_dev_info *dst)
  58 {
  59         struct backing_dev_info *old = inode->i_data.backing_dev_info;
  60
  61         if (unlikely(dst == old))               /* deadlock avoidance */
  62                 return;
  63         bdi_lock_two(&old->wb, &dst->wb);
  64         spin_lock(&inode->i_lock);
  65         inode->i_data.backing_dev_info = dst;
  66         if (inode->i_state & I_DIRTY)
  67                 list_move(&inode->i_wb_list, &dst->wb.b_dirty);
  68         spin_unlock(&inode->i_lock);
  69         spin_unlock(&old->wb.list_lock);
  70         spin_unlock(&dst->wb.list_lock);
  71 }
  72
  73 sector_t blkdev_max_block(struct block_device *bdev)
  74 {
  75         sector_t retval = ~((sector_t)0);
  76         loff_t sz = i_size_read(bdev->bd_inode);
  77
  78         if (sz) {
  79                 unsigned int size = block_size(bdev);
  80                 unsigned int sizebits = blksize_bits(size);
  81                 retval = (sz >> sizebits);
  82         }
  83         return retval;
  84 }
  85
  86 /* Kill _all_ buffers and pagecache , dirty or not.. */
  87 void kill_bdev(struct block_device *bdev)
  88 {
  89         struct address_space *mapping = bdev->bd_inode->i_mapping;
  90
  91         if (mapping->nrpages == 0)
  92                 return;
  93
  94         invalidate_bh_lrus();
  95         truncate_inode_pages(mapping, 0);
  96 }
  97 EXPORT_SYMBOL(kill_bdev);
  98
  99 /* Invalidate clean unused buffers and pagecache. */
 100 void invalidate_bdev(struct block_device *bdev)
 101 {
 102         struct address_space *mapping = bdev->bd_inode->i_mapping;
 103
 104         if (mapping->nrpages == 0)
 105                 return;
 106
 107         invalidate_bh_lrus();
 108         lru_add_drain_all();    /* make sure all lru add caches are flushed */
 109         invalidate_mapping_pages(mapping, 0, -1);
 110         /* 99% of the time, we don't need to flush the cleancache on the bdev.
 111          * But, for the strange corners, lets be cautious
 112          */
 113         cleancache_invalidate_inode(mapping);
 114 }
 115 EXPORT_SYMBOL(invalidate_bdev);
 116
 117 int set_blocksize(struct block_device *bdev, int size)
 118 {
 119         /* Size must be a power of two, and between 512 and PAGE_SIZE */
 120         if (size > PAGE_SIZE || size < 512 || !is_power_of_2(size))
 121                 return -EINVAL;
 122
 123         /* Size cannot be smaller than the size supported by the device */
 124         if (size < bdev_logical_block_size(bdev))
 125                 return -EINVAL;
 126
 127         /* Don't change the size if it is same as current */
 128         if (bdev->bd_block_size != size) {
 129                 sync_blockdev(bdev);
 130                 bdev->bd_block_size = size;
 131                 bdev->bd_inode->i_blkbits = blksize_bits(size);
 132                 kill_bdev(bdev);
 133         }
 134         return 0;
 135 }
 136
 137 EXPORT_SYMBOL(set_blocksize);
 138
 139 int sb_set_blocksize(struct super_block *sb, int size)
 140 {
 141         if (set_blocksize(sb->s_bdev, size))
 142                 return 0;
 143         /* If we get here, we know size is power of two
 144          * and it's value is between 512 and PAGE_SIZE */
 145         sb->s_blocksize = size;
 146         sb->s_blocksize_bits = blksize_bits(size);
 147         return sb->s_blocksize;
 148 }
 149
 150 EXPORT_SYMBOL(sb_set_blocksize);
 151
 152 int sb_min_blocksize(struct super_block *sb, int size)
 153 {
 154         int minsize = bdev_logical_block_size(sb->s_bdev);
 155         if (size < minsize)
 156                 size = minsize;
 157         return sb_set_blocksize(sb, size);
 158 }
 159
 160 EXPORT_SYMBOL(sb_min_blocksize);
 161
 162 static int
 163 blkdev_get_block(struct inode *inode, sector_t iblock,
 164                 struct buffer_head *bh, int create)
 165 {
 166         if (iblock >= blkdev_max_block(I_BDEV(inode))) {
 167                 if (create)
 168                         return -EIO;
 169
 170                 /*
 171                  * for reads, we're just trying to fill a partial page.
 172                  * return a hole, they will have to call get_block again
 173                  * before they can fill it, and they will get -EIO at that
 174                  * time
 175                  */
 176                 return 0;
 177         }
 178         bh->b_bdev = I_BDEV(inode);
 179         bh->b_blocknr = iblock;
 180         set_buffer_mapped(bh);
 181         return 0;
 182 }
 183
 184 static int
 185 blkdev_get_blocks(struct inode *inode, sector_t iblock,
 186                 struct buffer_head *bh, int create)
 187 {
 188         sector_t end_block = blkdev_max_block(I_BDEV(inode));
 189         unsigned long max_blocks = bh->b_size >> inode->i_blkbits;
 190
 191         if ((iblock + max_blocks) > end_block) {
 192                 max_blocks = end_block - iblock;
 193                 if ((long)max_blocks <= 0) {
 194                         if (create)
 195                                 return -EIO;    /* write fully beyond EOF */
 196                         /*
 197                          * It is a read which is fully beyond EOF.  We return
 198                          * a !buffer_mapped buffer
 199                          */
 200                         max_blocks = 0;
 201                 }
 202         }
 203
 204         bh->b_bdev = I_BDEV(inode);
 205         bh->b_blocknr = iblock;
 206         bh->b_size = max_blocks << inode->i_blkbits;
 207         if (max_blocks)
 208                 set_buffer_mapped(bh);
 209         return 0;
 210 }
 211
 212 static ssize_t
 213 blkdev_direct_IO(int rw, struct kiocb *iocb, const struct iovec *iov,
 214                         loff_t offset, unsigned long nr_segs)
 215 {
 216         struct file *file = iocb->ki_filp;
 217         struct inode *inode = file->f_mapping->host;
 218
 219         return __blockdev_direct_IO(rw, iocb, inode, I_BDEV(inode), iov, offset,
 220                                     nr_segs, blkdev_get_blocks, NULL, NULL, 0);
 221 }
 222
 223 int __sync_blockdev(struct block_device *bdev, int wait)
 224 {
 225         if (!bdev)
 226                 return 0;
 227         if (!wait)
 228                 return filemap_flush(bdev->bd_inode->i_mapping);
 229         return filemap_write_and_wait(bdev->bd_inode->i_mapping);
 230 }
 231
 232 /*
 233  * Write out and wait upon all the dirty data associated with a block
 234  * device via its mapping.  Does not take the superblock lock.
 235  */
 236 int sync_blockdev(struct block_device *bdev)
 237 {
 238         return __sync_blockdev(bdev, 1);
 239 }
 240 EXPORT_SYMBOL(sync_blockdev);
 241
 242 /*
 243  * Write out and wait upon all dirty data associated with this
 244  * device.   Filesystem data as well as the underlying block
 245  * device.  Takes the superblock lock.
 246  */
 247 int fsync_bdev(struct block_device *bdev)
 248 {
 249         struct super_block *sb = get_super(bdev);
 250         if (sb) {
 251                 int res = sync_filesystem(sb);
 252                 drop_super(sb);
 253                 return res;
 254         }
 255         return sync_blockdev(bdev);
 256 }
 257 EXPORT_SYMBOL(fsync_bdev);
 258
 259 /**
 260  * freeze_bdev  --  lock a filesystem and force it into a consistent state
 261  * @bdev:       blockdevice to lock
 262  *
 263  * If a superblock is found on this device, we take the s_umount semaphore
 264  * on it to make sure nobody unmounts until the snapshot creation is done.
 265  * The reference counter (bd_fsfreeze_count) guarantees that only the last
 266  * unfreeze process can unfreeze the frozen filesystem actually when multiple
 267  * freeze requests arrive simultaneously. It counts up in freeze_bdev() and
 268  * count down in thaw_bdev(). When it becomes 0, thaw_bdev() will unfreeze
 269  * actually.
 270  */
 271 struct super_block *freeze_bdev(struct block_device *bdev)
 272 {
 273         struct super_block *sb;
 274         int error = 0;
 275
 276         mutex_lock(&bdev->bd_fsfreeze_mutex);
 277         if (++bdev->bd_fsfreeze_count > 1) {
 278                 /*
 279                  * We don't even need to grab a reference - the first call
 280                  * to freeze_bdev grab an active reference and only the last
 281                  * thaw_bdev drops it.
 282                  */
 283                 sb = get_super(bdev);
 284                 drop_super(sb);
 285                 mutex_unlock(&bdev->bd_fsfreeze_mutex);
 286                 return sb;
 287         }
 288
 289         sb = get_active_super(bdev);
 290         if (!sb)
 291                 goto out;
 292         error = freeze_super(sb);
 293         if (error) {
 294                 deactivate_super(sb);
 295                 bdev->bd_fsfreeze_count--;
 296                 mutex_unlock(&bdev->bd_fsfreeze_mutex);
 297                 return ERR_PTR(error);
 298         }
 299         deactivate_super(sb);
 300  out:
 301         sync_blockdev(bdev);
 302         mutex_unlock(&bdev->bd_fsfreeze_mutex);
 303         return sb;      /* thaw_bdev releases s->s_umount */
 304 }
 305 EXPORT_SYMBOL(freeze_bdev);
 306
 307 /**
 308  * thaw_bdev  -- unlock filesystem
 309  * @bdev:       blockdevice to unlock
 310  * @sb:         associated superblock
 311  *
 312  * Unlocks the filesystem and marks it writeable again after freeze_bdev().
 313  */
 314 int thaw_bdev(struct block_device *bdev, struct super_block *sb)
 315 {
 316         int error = -EINVAL;
 317
 318         mutex_lock(&bdev->bd_fsfreeze_mutex);
 319         if (!bdev->bd_fsfreeze_count)
 320                 goto out;
 321
 322         error = 0;
 323         if (--bdev->bd_fsfreeze_count > 0)
 324                 goto out;
 325
 326         if (!sb)
 327                 goto out;
 328
 329         error = thaw_super(sb);
 330         if (error) {
 331                 bdev->bd_fsfreeze_count++;
 332                 mutex_unlock(&bdev->bd_fsfreeze_mutex);
 333                 return error;
 334         }
 335 out:
 336         mutex_unlock(&bdev->bd_fsfreeze_mutex);
 337         return 0;
 338 }
 339 EXPORT_SYMBOL(thaw_bdev);
 340
 341 static int blkdev_writepage(struct page *page, struct writeback_control *wbc)
 342 {
 343         return block_write_full_page(page, blkdev_get_block, wbc);
 344 }
 345
 346 static int blkdev_readpage(struct file * file, struct page * page)
 347 {
 348         return block_read_full_page(page, blkdev_get_block);
 349 }
 350
 351 static int blkdev_write_begin(struct file *file, struct address_space *mapping,
 352                         loff_t pos, unsigned len, unsigned flags,
 353                         struct page **pagep, void **fsdata)
 354 {
 355         return block_write_begin(mapping, pos, len, flags, pagep,
 356                                  blkdev_get_block);
 357 }
 358
 359 static int blkdev_write_end(struct file *file, struct address_space *mapping,
 360                         loff_t pos, unsigned len, unsigned copied,
 361                         struct page *page, void *fsdata)
 362 {
 363         int ret;
 364         ret = block_write_end(file, mapping, pos, len, copied, page, fsdata);
 365
 366         unlock_page(page);
 367         page_cache_release(page);
 368
 369         return ret;
 370 }
 371
 372 /*
 373  * private llseek:
 374  * for a block special file file->f_path.dentry->d_inode->i_size is zero
 375  * so we compute the size by hand (just as in block_read/write above)
 376  */
 377 static loff_t block_llseek(struct file *file, loff_t offset, int origin)
 378 {
 379         struct inode *bd_inode = file->f_mapping->host;
 380         loff_t size;
 381         loff_t retval;
 382
 383         mutex_lock(&bd_inode->i_mutex);
 384         size = i_size_read(bd_inode);
 385
 386         retval = -EINVAL;
 387         switch (origin) {
 388                 case SEEK_END:
 389                         offset += size;
 390                         break;
 391                 case SEEK_CUR:
 392                         offset += file->f_pos;
 393                 case SEEK_SET:
 394                         break;
 395                 default:
 396                         goto out;
 397         }
 398         if (offset >= 0 && offset <= size) {
 399                 if (offset != file->f_pos) {
 400                         file->f_pos = offset;
 401                 }
 402                 retval = offset;
 403         }
 404 out:
 405         mutex_unlock(&bd_inode->i_mutex);
 406         return retval;
 407 }
 408
 409 int blkdev_fsync(struct file *filp, loff_t start, loff_t end, int datasync)
 410 {
 411         struct inode *bd_inode = filp->f_mapping->host;
 412         struct block_device *bdev = I_BDEV(bd_inode);
 413         int error;
 414
 415         error = filemap_write_and_wait_range(filp->f_mapping, start, end);
 416         if (error)
 417                 return error;
 418
 419         /*
 420          * There is no need to serialise calls to blkdev_issue_flush with
 421          * i_mutex and doing so causes performance issues with concurrent
 422          * O_SYNC writers to a block device.
 423          */
 424         error = blkdev_issue_flush(bdev, GFP_KERNEL, NULL);
 425         if (error == -EOPNOTSUPP)
 426                 error = 0;
 427
 428         return error;
 429 }
 430 EXPORT_SYMBOL(blkdev_fsync);
 431
 432 /*
 433  * pseudo-fs
 434  */
 435
 436 static  __cacheline_aligned_in_smp DEFINE_SPINLOCK(bdev_lock);
 437 static struct kmem_cache * bdev_cachep __read_mostly;
 438
 439 static struct inode *bdev_alloc_inode(struct super_block *sb)
 440 {
 441         struct bdev_inode *ei = kmem_cache_alloc(bdev_cachep, GFP_KERNEL);
 442         if (!ei)
 443                 return NULL;
 444         return &ei->vfs_inode;
 445 }
 446
 447 static void bdev_i_callback(struct rcu_head *head)
 448 {
 449         struct inode *inode = container_of(head, struct inode, i_rcu);
 450         struct bdev_inode *bdi = BDEV_I(inode);
 451
 452         kmem_cache_free(bdev_cachep, bdi);
 453 }
 454
 455 static void bdev_destroy_inode(struct inode *inode)
 456 {
 457         call_rcu(&inode->i_rcu, bdev_i_callback);
 458 }
 459
 460 static void init_once(void *foo)
 461 {
 462         struct bdev_inode *ei = (struct bdev_inode *) foo;
 463         struct block_device *bdev = &ei->bdev;
 464
 465         memset(bdev, 0, sizeof(*bdev));
 466         mutex_init(&bdev->bd_mutex);
 467         INIT_LIST_HEAD(&bdev->bd_inodes);
 468         INIT_LIST_HEAD(&bdev->bd_list);
 469 #ifdef CONFIG_SYSFS
 470         INIT_LIST_HEAD(&bdev->bd_holder_disks);
 471 #endif
 472         inode_init_once(&ei->vfs_inode);
 473         /* Initialize mutex for freeze. */
 474         mutex_init(&bdev->bd_fsfreeze_mutex);
 475 }
 476
 477 static inline void __bd_forget(struct inode *inode)
 478 {
 479         list_del_init(&inode->i_devices);
 480         inode->i_bdev = NULL;
 481         inode->i_mapping = &inode->i_data;
 482 }
 483
 484 static void bdev_evict_inode(struct inode *inode)
 485 {
 486         struct block_device *bdev = &BDEV_I(inode)->bdev;
 487         struct list_head *p;
 488         truncate_inode_pages(&inode->i_data, 0);
 489         invalidate_inode_buffers(inode); /* is it needed here? */
 490         end_writeback(inode);
 491         spin_lock(&bdev_lock);
 492         while ( (p = bdev->bd_inodes.next) != &bdev->bd_inodes ) {
 493                 __bd_forget(list_entry(p, struct inode, i_devices));
 494         }
 495         list_del_init(&bdev->bd_list);
 496         spin_unlock(&bdev_lock);
 497 }
 498
 499 static const struct super_operations bdev_sops = {
 500         .statfs = simple_statfs,
 501         .alloc_inode = bdev_alloc_inode,
 502         .destroy_inode = bdev_destroy_inode,
 503         .drop_inode = generic_delete_inode,
 504         .evict_inode = bdev_evict_inode,
 505 };
 506
 507 static struct dentry *bd_mount(struct file_system_type *fs_type,
 508         int flags, const char *dev_name, void *data)
 509 {
 510         return mount_pseudo(fs_type, "bdev:", &bdev_sops, NULL, BDEVFS_MAGIC);
 511 }
 512
 513 static struct file_system_type bd_type = {
 514         .name           = "bdev",
 515         .mount          = bd_mount,
 516         .kill_sb        = kill_anon_super,
 517 };
 518
 519 static struct super_block *blockdev_superblock __read_mostly;
 520
 521 void __init bdev_cache_init(void)
 522 {
 523         int err;
 524         static struct vfsmount *bd_mnt;
 525
 526         bdev_cachep = kmem_cache_create("bdev_cache", sizeof(struct bdev_inode),
 527                         0, (SLAB_HWCACHE_ALIGN|SLAB_RECLAIM_ACCOUNT|
 528                                 SLAB_MEM_SPREAD|SLAB_PANIC),
 529                         init_once);
 530         err = register_filesystem(&bd_type);
 531         if (err)
 532                 panic("Cannot register bdev pseudo-fs");
 533         bd_mnt = kern_mount(&bd_type);
 534         if (IS_ERR(bd_mnt))
 535                 panic("Cannot create bdev pseudo-fs");
 536         blockdev_superblock = bd_mnt->mnt_sb;   /* For writeback */
 537 }
 538
 539 /*
 540  * Most likely _very_ bad one - but then it's hardly critical for small
 541  * /dev and can be fixed when somebody will need really large one.
 542  * Keep in mind that it will be fed through icache hash function too.
 543  */
 544 static inline unsigned long hash(dev_t dev)
 545 {
 546         return MAJOR(dev)+MINOR(dev);
 547 }
 548
 549 static int bdev_test(struct inode *inode, void *data)
 550 {
 551         return BDEV_I(inode)->bdev.bd_dev == *(dev_t *)data;
 552 }
 553
 554 static int bdev_set(struct inode *inode, void *data)
 555 {
 556         BDEV_I(inode)->bdev.bd_dev = *(dev_t *)data;
 557         return 0;
 558 }
 559
 560 static LIST_HEAD(all_bdevs);
 561
 562 struct block_device *bdget(dev_t dev)
 563 {
 564         struct block_device *bdev;
 565         struct inode *inode;
 566
 567         inode = iget5_locked(blockdev_superblock, hash(dev),
 568                         bdev_test, bdev_set, &dev);
 569
 570         if (!inode)
 571                 return NULL;
 572
 573         bdev = &BDEV_I(inode)->bdev;
 574
 575         if (inode->i_state & I_NEW) {
 576                 bdev->bd_contains = NULL;
 577                 bdev->bd_super = NULL;
 578                 bdev->bd_inode = inode;
 579                 bdev->bd_block_size = (1 << inode->i_blkbits);
 580                 bdev->bd_part_count = 0;
 581                 bdev->bd_invalidated = 0;
 582                 inode->i_mode = S_IFBLK;
 583                 inode->i_rdev = dev;
 584                 inode->i_bdev = bdev;
 585                 inode->i_data.a_ops = &def_blk_aops;
 586                 mapping_set_gfp_mask(&inode->i_data, GFP_USER);
 587                 inode->i_data.backing_dev_info = &default_backing_dev_info;
 588                 spin_lock(&bdev_lock);
 589                 list_add(&bdev->bd_list, &all_bdevs);
 590                 spin_unlock(&bdev_lock);
 591                 unlock_new_inode(inode);
 592         }
 593         return bdev;
 594 }
 595
 596 EXPORT_SYMBOL(bdget);
 597
 598 /**
 599  * bdgrab -- Grab a reference to an already referenced block device
 600  * @bdev:       Block device to grab a reference to.
 601  */
 602 struct block_device *bdgrab(struct block_device *bdev)
 603 {
 604         ihold(bdev->bd_inode);
 605         return bdev;
 606 }
 607 EXPORT_SYMBOL(bdgrab);
 608
 609 long nr_blockdev_pages(void)
 610 {
 611         struct block_device *bdev;
 612         long ret = 0;
 613         spin_lock(&bdev_lock);
 614         list_for_each_entry(bdev, &all_bdevs, bd_list) {
 615                 ret += bdev->bd_inode->i_mapping->nrpages;
 616         }
 617         spin_unlock(&bdev_lock);
 618         return ret;
 619 }
 620
 621 void bdput(struct block_device *bdev)
 622 {
 623         iput(bdev->bd_inode);
 624 }
 625
 626 EXPORT_SYMBOL(bdput);
 627
 628 static struct block_device *bd_acquire(struct inode *inode)
 629 {
 630         struct block_device *bdev;
 631
 632         spin_lock(&bdev_lock);
 633         bdev = inode->i_bdev;
 634         if (bdev) {
 635                 ihold(bdev->bd_inode);
 636                 spin_unlock(&bdev_lock);
 637                 return bdev;
 638         }
 639         spin_unlock(&bdev_lock);
 640
 641         bdev = bdget(inode->i_rdev);
 642         if (bdev) {
 643                 spin_lock(&bdev_lock);
 644                 if (!inode->i_bdev) {
 645                         /*
 646                          * We take an additional reference to bd_inode,
 647                          * and it's released in clear_inode() of inode.
 648                          * So, we can access it via ->i_mapping always
 649                          * without igrab().
 650                          */
 651                         ihold(bdev->bd_inode);
 652                         inode->i_bdev = bdev;
 653                         inode->i_mapping = bdev->bd_inode->i_mapping;
 654                         list_add(&inode->i_devices, &bdev->bd_inodes);
 655                 }
 656                 spin_unlock(&bdev_lock);
 657         }
 658         return bdev;
 659 }
 660
 661 static inline int sb_is_blkdev_sb(struct super_block *sb)
 662 {
 663         return sb == blockdev_superblock;
 664 }
 665
 666 /* Call when you free inode */
 667
 668 void bd_forget(struct inode *inode)
 669 {
 670         struct block_device *bdev = NULL;
 671
 672         spin_lock(&bdev_lock);
 673         if (inode->i_bdev) {
 674                 if (!sb_is_blkdev_sb(inode->i_sb))
 675                         bdev = inode->i_bdev;
 676                 __bd_forget(inode);
 677         }
 678         spin_unlock(&bdev_lock);
 679
 680         if (bdev)
 681                 iput(bdev->bd_inode);
 682 }
 683
 684 /**
 685  * bd_may_claim - test whether a block device can be claimed
 686  * @bdev: block device of interest
 687  * @whole: whole block device containing @bdev, may equal @bdev
 688  * @holder: holder trying to claim @bdev
 689  *
 690  * Test whether @bdev can be claimed by @holder.
 691  *
 692  * CONTEXT:
 693  * spin_lock(&bdev_lock).
 694  *
 695  * RETURNS:
 696  * %true if @bdev can be claimed, %false otherwise.
 697  */
 698 static bool bd_may_claim(struct block_device *bdev, struct block_device *whole,
 699                          void *holder)
 700 {
 701         if (bdev->bd_holder == holder)
 702                 return true;     /* already a holder */
 703         else if (bdev->bd_holder != NULL)
 704                 return false;    /* held by someone else */
 705         else if (bdev->bd_contains == bdev)
 706                 return true;     /* is a whole device which isn't held */
 707
 708         else if (whole->bd_holder == bd_may_claim)
 709                 return true;     /* is a partition of a device that is being partitioned */
 710         else if (whole->bd_holder != NULL)
 711                 return false;    /* is a partition of a held device */
 712         else
 713                 return true;     /* is a partition of an un-held device */
 714 }
 715
 716 /**
 717  * bd_prepare_to_claim - prepare to claim a block device
 718  * @bdev: block device of interest
 719  * @whole: the whole device containing @bdev, may equal @bdev
 720  * @holder: holder trying to claim @bdev
 721  *
 722  * Prepare to claim @bdev.  This function fails if @bdev is already
 723  * claimed by another holder and waits if another claiming is in
 724  * progress.  This function doesn't actually claim.  On successful
 725  * return, the caller has ownership of bd_claiming and bd_holder[s].
 726  *
 727  * CONTEXT:
 728  * spin_lock(&bdev_lock).  Might release bdev_lock, sleep and regrab
 729  * it multiple times.
 730  *
 731  * RETURNS:
 732  * 0 if @bdev can be claimed, -EBUSY otherwise.
 733  */
 734 static int bd_prepare_to_claim(struct block_device *bdev,
 735                                struct block_device *whole, void *holder)
 736 {
 737 retry:
 738         /* if someone else claimed, fail */
 739         if (!bd_may_claim(bdev, whole, holder))
 740                 return -EBUSY;
 741
 742         /* if claiming is already in progress, wait for it to finish */
 743         if (whole->bd_claiming) {
 744                 wait_queue_head_t *wq = bit_waitqueue(&whole->bd_claiming, 0);
 745                 DEFINE_WAIT(wait);
 746
 747                 prepare_to_wait(wq, &wait, TASK_UNINTERRUPTIBLE);
 748                 spin_unlock(&bdev_lock);
 749                 schedule();
 750                 finish_wait(wq, &wait);
 751                 spin_lock(&bdev_lock);
 752                 goto retry;
 753         }
 754
 755         /* yay, all mine */
 756         return 0;
 757 }
 758
 759 /**
 760  * bd_start_claiming - start claiming a block device
 761  * @bdev: block device of interest
 762  * @holder: holder trying to claim @bdev
 763  *
 764  * @bdev is about to be opened exclusively.  Check @bdev can be opened
 765  * exclusively and mark that an exclusive open is in progress.  Each
 766  * successful call to this function must be matched with a call to
 767  * either bd_finish_claiming() or bd_abort_claiming() (which do not
 768  * fail).
 769  *
 770  * This function is used to gain exclusive access to the block device
 771  * without actually causing other exclusive open attempts to fail. It
 772  * should be used when the open sequence itself requires exclusive
 773  * access but may subsequently fail.
 774  *
 775  * CONTEXT:
 776  * Might sleep.
 777  *
 778  * RETURNS:
 779  * Pointer to the block device containing @bdev on success, ERR_PTR()
 780  * value on failure.
 781  */
 782 static struct block_device *bd_start_claiming(struct block_device *bdev,
 783                                               void *holder)
 784 {
 785         struct gendisk *disk;
 786         struct block_device *whole;
 787         int partno, err;
 788
 789         might_sleep();
 790
 791         /*
 792          * @bdev might not have been initialized properly yet, look up
 793          * and grab the outer block device the hard way.
 794          */
 795         disk = get_gendisk(bdev->bd_dev, &partno);
 796         if (!disk)
 797                 return ERR_PTR(-ENXIO);
 798
 799         /*
 800          * Normally, @bdev should equal what's returned from bdget_disk()
 801          * if partno is 0; however, some drivers (floppy) use multiple
 802          * bdev's for the same physical device and @bdev may be one of the
 803          * aliases.  Keep @bdev if partno is 0.  This means claimer
 804          * tracking is broken for those devices but it has always been that
 805          * way.
 806          */
 807         if (partno)
 808                 whole = bdget_disk(disk, 0);
 809         else
 810                 whole = bdgrab(bdev);
 811
 812         module_put(disk->fops->owner);
 813         put_disk(disk);
 814         if (!whole)
 815                 return ERR_PTR(-ENOMEM);
 816
 817         /* prepare to claim, if successful, mark claiming in progress */
 818         spin_lock(&bdev_lock);
 819
 820         err = bd_prepare_to_claim(bdev, whole, holder);
 821         if (err == 0) {
 822                 whole->bd_claiming = holder;
 823                 spin_unlock(&bdev_lock);
 824                 return whole;
 825         } else {
 826                 spin_unlock(&bdev_lock);
 827                 bdput(whole);
 828                 return ERR_PTR(err);
 829         }
 830 }
 831
 832 #ifdef CONFIG_SYSFS
 833 struct bd_holder_disk {
 834         struct list_head        list;
 835         struct gendisk          *disk;
 836         int                     refcnt;
 837 };
 838
 839 static struct bd_holder_disk *bd_find_holder_disk(struct block_device *bdev,
 840                                                   struct gendisk *disk)
 841 {
 842         struct bd_holder_disk *holder;
 843
 844         list_for_each_entry(holder, &bdev->bd_holder_disks, list)
 845                 if (holder->disk == disk)
 846                         return holder;
 847         return NULL;
 848 }
 849
 850 static int add_symlink(struct kobject *from, struct kobject *to)
 851 {
 852         return sysfs_create_link(from, to, kobject_name(to));
 853 }
 854
 855 static void del_symlink(struct kobject *from, struct kobject *to)
 856 {
 857         sysfs_remove_link(from, kobject_name(to));
 858 }
 859
 860 /**
 861  * bd_link_disk_holder - create symlinks between holding disk and slave bdev
 862  * @bdev: the claimed slave bdev
 863  * @disk: the holding disk
 864  *
 865  * DON'T USE THIS UNLESS YOU'RE ALREADY USING IT.
 866  *
 867  * This functions creates the following sysfs symlinks.
 868  *
 869  * - from "slaves" directory of the holder @disk to the claimed @bdev
 870  * - from "holders" directory of the @bdev to the holder @disk
 871  *
 872  * For example, if /dev/dm-0 maps to /dev/sda and disk for dm-0 is
 873  * passed to bd_link_disk_holder(), then:
 874  *
 875  *   /sys/block/dm-0/slaves/sda --> /sys/block/sda
 876  *   /sys/block/sda/holders/dm-0 --> /sys/block/dm-0
 877  *
 878  * The caller must have claimed @bdev before calling this function and
 879  * ensure that both @bdev and @disk are valid during the creation and
 880  * lifetime of these symlinks.
 881  *
 882  * CONTEXT:
 883  * Might sleep.
 884  *
 885  * RETURNS:
 886  * 0 on success, -errno on failure.
 887  */
 888 int bd_link_disk_holder(struct block_device *bdev, struct gendisk *disk)
 889 {
 890         struct bd_holder_disk *holder;
 891         int ret = 0;
 892
 893         mutex_lock(&bdev->bd_mutex);
 894
 895         WARN_ON_ONCE(!bdev->bd_holder);
 896
 897         /* FIXME: remove the following once add_disk() handles errors */
 898         if (WARN_ON(!disk->slave_dir || !bdev->bd_part->holder_dir))
 899                 goto out_unlock;
 900
 901         holder = bd_find_holder_disk(bdev, disk);
 902         if (holder) {
 903                 holder->refcnt++;
 904                 goto out_unlock;
 905         }
 906
 907         holder = kzalloc(sizeof(*holder), GFP_KERNEL);
 908         if (!holder) {
 909                 ret = -ENOMEM;
 910                 goto out_unlock;
 911         }
 912
 913         INIT_LIST_HEAD(&holder->list);
 914         holder->disk = disk;
 915         holder->refcnt = 1;
 916
 917         ret = add_symlink(disk->slave_dir, &part_to_dev(bdev->bd_part)->kobj);
 918         if (ret)
 919                 goto out_free;
 920
 921         ret = add_symlink(bdev->bd_part->holder_dir, &disk_to_dev(disk)->kobj);
 922         if (ret)
 923                 goto out_del;
 924         /*
 925          * bdev could be deleted beneath us which would implicitly destroy
 926          * the holder directory.  Hold on to it.
 927          */
 928         kobject_get(bdev->bd_part->holder_dir);
 929
 930         list_add(&holder->list, &bdev->bd_holder_disks);
 931         goto out_unlock;
 932
 933 out_del:
 934         del_symlink(disk->slave_dir, &part_to_dev(bdev->bd_part)->kobj);
 935 out_free:
 936         kfree(holder);
 937 out_unlock:
 938         mutex_unlock(&bdev->bd_mutex);
 939         return ret;
 940 }
 941 EXPORT_SYMBOL_GPL(bd_link_disk_holder);
 942
 943 /**
 944  * bd_unlink_disk_holder - destroy symlinks created by bd_link_disk_holder()
 945  * @bdev: the calimed slave bdev
 946  * @disk: the holding disk
 947  *
 948  * DON'T USE THIS UNLESS YOU'RE ALREADY USING IT.
 949  *
 950  * CONTEXT:
 951  * Might sleep.
 952  */
 953 void bd_unlink_disk_holder(struct block_device *bdev, struct gendisk *disk)
 954 {
 955         struct bd_holder_disk *holder;
 956
 957         mutex_lock(&bdev->bd_mutex);
 958
 959         holder = bd_find_holder_disk(bdev, disk);
 960
 961         if (!WARN_ON_ONCE(holder == NULL) && !--holder->refcnt) {
 962                 del_symlink(disk->slave_dir, &part_to_dev(bdev->bd_part)->kobj);
 963                 del_symlink(bdev->bd_part->holder_dir,
 964                             &disk_to_dev(disk)->kobj);
 965                 kobject_put(bdev->bd_part->holder_dir);
 966                 list_del_init(&holder->list);
 967                 kfree(holder);
 968         }
 969
 970         mutex_unlock(&bdev->bd_mutex);
 971 }
 972 EXPORT_SYMBOL_GPL(bd_unlink_disk_holder);
 973 #endif
 974
 975 /**
 976  * flush_disk - invalidates all buffer-cache entries on a disk
 977  *
 978  * @bdev:      struct block device to be flushed
 979  * @kill_dirty: flag to guide handling of dirty inodes
 980  *
 981  * Invalidates all buffer-cache entries on a disk. It should be called
 982  * when a disk has been changed -- either by a media change or online
 983  * resize.
 984  */
 985 static void flush_disk(struct block_device *bdev, bool kill_dirty)
 986 {
 987         if (__invalidate_device(bdev, kill_dirty)) {
 988                 char name[BDEVNAME_SIZE] = "";
 989
 990                 if (bdev->bd_disk)
 991                         disk_name(bdev->bd_disk, 0, name);
 992                 printk(KERN_WARNING "VFS: busy inodes on changed media or "
 993                        "resized disk %s\n", name);
 994         }
 995
 996         if (!bdev->bd_disk)
 997                 return;
 998         if (disk_part_scan_enabled(bdev->bd_disk))
 999                 bdev->bd_invalidated = 1;
1000 }
1001
1002 /**
1003  * check_disk_size_change - checks for disk size change and adjusts bdev size.
1004  * @disk: struct gendisk to check
1005  * @bdev: struct bdev to adjust.
1006  *
1007  * This routine checks to see if the bdev size does not match the disk size
1008  * and adjusts it if it differs.
1009  */
1010 void check_disk_size_change(struct gendisk *disk, struct block_device *bdev)
1011 {
1012         loff_t disk_size, bdev_size;
1013
1014         disk_size = (loff_t)get_capacity(disk) << 9;
1015         bdev_size = i_size_read(bdev->bd_inode);
1016         if (disk_size != bdev_size) {
1017                 char name[BDEVNAME_SIZE];
1018
1019                 disk_name(disk, 0, name);
1020                 printk(KERN_INFO
1021                        "%s: detected capacity change from %lld to %lld\n",
1022                        name, bdev_size, disk_size);
1023                 i_size_write(bdev->bd_inode, disk_size);
1024                 flush_disk(bdev, false);
1025         }
1026 }
1027 EXPORT_SYMBOL(check_disk_size_change);
1028
1029 /**
1030  * revalidate_disk - wrapper for lower-level driver's revalidate_disk call-back
1031  * @disk: struct gendisk to be revalidated
1032  *
1033  * This routine is a wrapper for lower-level driver's revalidate_disk
1034  * call-backs.  It is used to do common pre and post operations needed
1035  * for all revalidate_disk operations.
1036  */
1037 int revalidate_disk(struct gendisk *disk)
1038 {
1039         struct block_device *bdev;
1040         int ret = 0;
1041
1042         if (disk->fops->revalidate_disk)
1043                 ret = disk->fops->revalidate_disk(disk);
1044
1045         bdev = bdget_disk(disk, 0);
1046         if (!bdev)
1047                 return ret;
1048
1049         mutex_lock(&bdev->bd_mutex);
1050         check_disk_size_change(disk, bdev);
1051         mutex_unlock(&bdev->bd_mutex);
1052         bdput(bdev);
1053         return ret;
1054 }
1055 EXPORT_SYMBOL(revalidate_disk);
1056
1057 /*
1058  * This routine checks whether a removable media has been changed,
1059  * and invalidates all buffer-cache-entries in that case. This
1060  * is a relatively slow routine, so we have to try to minimize using
1061  * it. Thus it is called only upon a 'mount' or 'open'. This
1062  * is the best way of combining speed and utility, I think.
1063  * People changing diskettes in the middle of an operation deserve
1064  * to lose :-)
1065  */
1066 int check_disk_change(struct block_device *bdev)
1067 {
1068         struct gendisk *disk = bdev->bd_disk;
1069         const struct block_device_operations *bdops = disk->fops;
1070         unsigned int events;
1071
1072         events = disk_clear_events(disk, DISK_EVENT_MEDIA_CHANGE |
1073                                    DISK_EVENT_EJECT_REQUEST);
1074         if (!(events & DISK_EVENT_MEDIA_CHANGE))
1075                 return 0;
1076
1077         flush_disk(bdev, true);
1078         if (bdops->revalidate_disk)
1079                 bdops->revalidate_disk(bdev->bd_disk);
1080         return 1;
1081 }
1082
1083 EXPORT_SYMBOL(check_disk_change);
1084
1085 void bd_set_size(struct block_device *bdev, loff_t size)
1086 {
1087         unsigned bsize = bdev_logical_block_size(bdev);
1088
1089         bdev->bd_inode->i_size = size;
1090         while (bsize < PAGE_CACHE_SIZE) {
1091                 if (size & bsize)
1092                         break;
1093                 bsize <<= 1;
1094         }
1095         bdev->bd_block_size = bsize;
1096         bdev->bd_inode->i_blkbits = blksize_bits(bsize);
1097 }
1098 EXPORT_SYMBOL(bd_set_size);
1099
1100 static int __blkdev_put(struct block_device *bdev, fmode_t mode, int for_part);
1101
1102 /*
1103  * bd_mutex locking:
1104  *
1105  *  mutex_lock(part->bd_mutex)
1106  *    mutex_lock_nested(whole->bd_mutex, 1)
1107  */
1108
1109 static int __blkdev_get(struct block_device *bdev, fmode_t mode, int for_part)
1110 {
1111         struct gendisk *disk;
1112         struct module *owner;
1113         int ret;
1114         int partno;
1115         int perm = 0;
1116
1117         if (mode & FMODE_READ)
1118                 perm |= MAY_READ;
1119         if (mode & FMODE_WRITE)
1120                 perm |= MAY_WRITE;
1121         /*
1122          * hooks: /n/, see "layering violations".
1123          */
1124         if (!for_part) {
1125                 ret = devcgroup_inode_permission(bdev->bd_inode, perm);
1126                 if (ret != 0) {
1127                         bdput(bdev);
1128                         return ret;
1129                 }
1130         }
1131
1132  restart:
1133
1134         ret = -ENXIO;
1135         disk = get_gendisk(bdev->bd_dev, &partno);
1136         if (!disk)
1137                 goto out;
1138         owner = disk->fops->owner;
1139
1140         disk_block_events(disk);
1141         mutex_lock_nested(&bdev->bd_mutex, for_part);
1142         if (!bdev->bd_openers) {
1143                 bdev->bd_disk = disk;
1144                 bdev->bd_queue = disk->queue;
1145                 bdev->bd_contains = bdev;
1146                 if (!partno) {
1147                         struct backing_dev_info *bdi;
1148
1149                         ret = -ENXIO;
1150                         bdev->bd_part = disk_get_part(disk, partno);
1151                         if (!bdev->bd_part)
1152                                 goto out_clear;
1153
1154                         ret = 0;
1155                         if (disk->fops->open) {
1156                                 ret = disk->fops->open(bdev, mode);
1157                                 if (ret == -ERESTARTSYS) {
1158                                         /* Lost a race with 'disk' being
1159                                          * deleted, try again.
1160                                          * See md.c
1161                                          */
1162                                         disk_put_part(bdev->bd_part);
1163                                         bdev->bd_part = NULL;
1164                                         bdev->bd_disk = NULL;
1165                                         bdev->bd_queue = NULL;
1166                                         mutex_unlock(&bdev->bd_mutex);
1167                                         disk_unblock_events(disk);
1168                                         put_disk(disk);
1169                                         module_put(owner);
1170                                         goto restart;
1171                                 }
1172                         }
1173
1174                         if (!ret && !bdev->bd_openers) {
1175                                 bd_set_size(bdev,(loff_t)get_capacity(disk)<<9);
1176                                 bdi = blk_get_backing_dev_info(bdev);
1177                                 if (bdi == NULL)
1178                                         bdi = &default_backing_dev_info;
1179                                 bdev_inode_switch_bdi(bdev->bd_inode, bdi);
1180                         }
1181
1182                         /*
1183                          * If the device is invalidated, rescan partition
1184                          * if open succeeded or failed with -ENOMEDIUM.
1185                          * The latter is necessary to prevent ghost
1186                          * partitions on a removed medium.
1187                          */
1188                         if (bdev->bd_invalidated) {
1189                                 if (!ret)
1190                                         rescan_partitions(disk, bdev);
1191                                 else if (ret == -ENOMEDIUM)
1192                                         invalidate_partitions(disk, bdev);
1193                         }
1194                         if (ret)
1195                                 goto out_clear;
1196                 } else {
1197                         struct block_device *whole;
1198                         whole = bdget_disk(disk, 0);
1199                         ret = -ENOMEM;
1200                         if (!whole)
1201                                 goto out_clear;
1202                         BUG_ON(for_part);
1203                         ret = __blkdev_get(whole, mode, 1);
1204                         if (ret)
1205                                 goto out_clear;
1206                         bdev->bd_contains = whole;
1207                         bdev_inode_switch_bdi(bdev->bd_inode,
1208                                 whole->bd_inode->i_data.backing_dev_info);
1209                         bdev->bd_part = disk_get_part(disk, partno);
1210                         if (!(disk->flags & GENHD_FL_UP) ||
1211                             !bdev->bd_part || !bdev->bd_part->nr_sects) {
1212                                 ret = -ENXIO;
1213                                 goto out_clear;
1214                         }
1215                         bd_set_size(bdev, (loff_t)bdev->bd_part->nr_sects << 9);
1216                 }
1217         } else {
1218                 if (bdev->bd_contains == bdev) {
1219                         ret = 0;
1220                         if (bdev->bd_disk->fops->open)
1221                                 ret = bdev->bd_disk->fops->open(bdev, mode);
1222                         /* the same as first opener case, read comment there */
1223                         if (bdev->bd_invalidated) {
1224                                 if (!ret)
1225                                         rescan_partitions(bdev->bd_disk, bdev);
1226                                 else if (ret == -ENOMEDIUM)
1227                                         invalidate_partitions(bdev->bd_disk, bdev);
1228                         }
1229                         if (ret)
1230                                 goto out_unlock_bdev;
1231                 }
1232                 /* only one opener holds refs to the module and disk */
1233                 put_disk(disk);
1234                 module_put(owner);
1235         }
1236         bdev->bd_openers++;
1237         if (for_part)
1238                 bdev->bd_part_count++;
1239         mutex_unlock(&bdev->bd_mutex);
1240         disk_unblock_events(disk);
1241         return 0;
1242
1243  out_clear:
1244         disk_put_part(bdev->bd_part);
1245         bdev->bd_disk = NULL;
1246         bdev->bd_part = NULL;
1247         bdev->bd_queue = NULL;
1248         bdev_inode_switch_bdi(bdev->bd_inode, &default_backing_dev_info);
1249         if (bdev != bdev->bd_contains)
1250                 __blkdev_put(bdev->bd_contains, mode, 1);
1251         bdev->bd_contains = NULL;
1252  out_unlock_bdev:
1253         mutex_unlock(&bdev->bd_mutex);
1254         disk_unblock_events(disk);
1255         put_disk(disk);
1256         module_put(owner);
1257  out:
1258         bdput(bdev);
1259
1260         return ret;
1261 }
1262
1263 /**
1264  * blkdev_get - open a block device
1265  * @bdev: block_device to open
1266  * @mode: FMODE_* mask
1267  * @holder: exclusive holder identifier
1268  *
1269  * Open @bdev with @mode.  If @mode includes %FMODE_EXCL, @bdev is
1270  * open with exclusive access.  Specifying %FMODE_EXCL with %NULL
1271  * @holder is invalid.  Exclusive opens may nest for the same @holder.
1272  *
1273  * On success, the reference count of @bdev is unchanged.  On failure,
1274  * @bdev is put.
1275  *
1276  * CONTEXT:
1277  * Might sleep.
1278  *
1279  * RETURNS:
1280  * 0 on success, -errno on failure.
1281  */
1282 int blkdev_get(struct block_device *bdev, fmode_t mode, void *holder)
1283 {
1284         struct block_device *whole = NULL;
1285         int res;
1286
1287         WARN_ON_ONCE((mode & FMODE_EXCL) && !holder);
1288
1289         if ((mode & FMODE_EXCL) && holder) {
1290                 whole = bd_start_claiming(bdev, holder);
1291                 if (IS_ERR(whole)) {
1292                         bdput(bdev);
1293                         return PTR_ERR(whole);
1294                 }
1295         }
1296
1297         res = __blkdev_get(bdev, mode, 0);
1298
1299         if (whole) {
1300                 struct gendisk *disk = whole->bd_disk;
1301
1302                 /* finish claiming */
1303                 mutex_lock(&bdev->bd_mutex);
1304                 spin_lock(&bdev_lock);
1305
1306                 if (!res) {
1307                         BUG_ON(!bd_may_claim(bdev, whole, holder));
1308                         /*
1309                          * Note that for a whole device bd_holders
1310                          * will be incremented twice, and bd_holder
1311                          * will be set to bd_may_claim before being
1312                          * set to holder
1313                          */
1314                         whole->bd_holders++;
1315                         whole->bd_holder = bd_may_claim;
1316                         bdev->bd_holders++;
1317                         bdev->bd_holder = holder;
1318                 }
1319
1320                 /* tell others that we're done */
1321                 BUG_ON(whole->bd_claiming != holder);
1322                 whole->bd_claiming = NULL;
1323                 wake_up_bit(&whole->bd_claiming, 0);
1324
1325                 spin_unlock(&bdev_lock);
1326
1327                 /*
1328                  * Block event polling for write claims if requested.  Any
1329                  * write holder makes the write_holder state stick until
1330                  * all are released.  This is good enough and tracking
1331                  * individual writeable reference is too fragile given the
1332                  * way @mode is used in blkdev_get/put().
1333                  */
1334                 if (!res && (mode & FMODE_WRITE) && !bdev->bd_write_holder &&
1335                     (disk->flags & GENHD_FL_BLOCK_EVENTS_ON_EXCL_WRITE)) {
1336                         bdev->bd_write_holder = true;
1337                         disk_block_events(disk);
1338                 }
1339
1340                 mutex_unlock(&bdev->bd_mutex);
1341                 bdput(whole);
1342         }
1343
1344         return res;
1345 }
1346 EXPORT_SYMBOL(blkdev_get);
1347
1348 /**
1349  * blkdev_get_by_path - open a block device by name
1350  * @path: path to the block device to open
1351  * @mode: FMODE_* mask
1352  * @holder: exclusive holder identifier
1353  *
1354  * Open the blockdevice described by the device file at @path.  @mode
1355  * and @holder are identical to blkdev_get().
1356  *
1357  * On success, the returned block_device has reference count of one.
1358  *
1359  * CONTEXT:
1360  * Might sleep.
1361  *
1362  * RETURNS:
1363  * Pointer to block_device on success, ERR_PTR(-errno) on failure.
1364  */
1365 struct block_device *blkdev_get_by_path(const char *path, fmode_t mode,
1366                                         void *holder)
1367 {
1368         struct block_device *bdev;
1369         int err;
1370
1371         bdev = lookup_bdev(path);
1372         if (IS_ERR(bdev))
1373                 return bdev;
1374
1375         err = blkdev_get(bdev, mode, holder);
1376         if (err)
1377                 return ERR_PTR(err);
1378
1379         if ((mode & FMODE_WRITE) && bdev_read_only(bdev)) {
1380                 blkdev_put(bdev, mode);
1381                 return ERR_PTR(-EACCES);
1382         }
1383
1384         return bdev;
1385 }
1386 EXPORT_SYMBOL(blkdev_get_by_path);
1387
1388 /**
1389  * blkdev_get_by_dev - open a block device by device number
1390  * @dev: device number of block device to open
1391  * @mode: FMODE_* mask
1392  * @holder: exclusive holder identifier
1393  *
1394  * Open the blockdevice described by device number @dev.  @mode and
1395  * @holder are identical to blkdev_get().
1396  *
1397  * Use it ONLY if you really do not have anything better - i.e. when
1398  * you are behind a truly sucky interface and all you are given is a
1399  * device number.  _Never_ to be used for internal purposes.  If you
1400  * ever need it - reconsider your API.
1401  *
1402  * On success, the returned block_device has reference count of one.
1403  *
1404  * CONTEXT:
1405  * Might sleep.
1406  *
1407  * RETURNS:
1408  * Pointer to block_device on success, ERR_PTR(-errno) on failure.
1409  */
1410 struct block_device *blkdev_get_by_dev(dev_t dev, fmode_t mode, void *holder)
1411 {
1412         struct block_device *bdev;
1413         int err;
1414
1415         bdev = bdget(dev);
1416         if (!bdev)
1417                 return ERR_PTR(-ENOMEM);
1418
1419         err = blkdev_get(bdev, mode, holder);
1420         if (err)
1421                 return ERR_PTR(err);
1422
1423         return bdev;
1424 }
1425 EXPORT_SYMBOL(blkdev_get_by_dev);
1426
1427 static int blkdev_open(struct inode * inode, struct file * filp)
1428 {
1429         struct block_device *bdev;
1430
1431         /*
1432          * Preserve backwards compatibility and allow large file access
1433          * even if userspace doesn't ask for it explicitly. Some mkfs
1434          * binary needs it. We might want to drop this workaround
1435          * during an unstable branch.
1436          */
1437         filp->f_flags |= O_LARGEFILE;
1438
1439         if (filp->f_flags & O_NDELAY)
1440                 filp->f_mode |= FMODE_NDELAY;
1441         if (filp->f_flags & O_EXCL)
1442                 filp->f_mode |= FMODE_EXCL;
1443         if ((filp->f_flags & O_ACCMODE) == 3)
1444                 filp->f_mode |= FMODE_WRITE_IOCTL;
1445
1446         bdev = bd_acquire(inode);
1447         if (bdev == NULL)
1448                 return -ENOMEM;
1449
1450         filp->f_mapping = bdev->bd_inode->i_mapping;
1451
1452         return blkdev_get(bdev, filp->f_mode, filp);
1453 }
1454
1455 static int __blkdev_put(struct block_device *bdev, fmode_t mode, int for_part)
1456 {
1457         int ret = 0;
1458         struct gendisk *disk = bdev->bd_disk;
1459         struct block_device *victim = NULL;
1460
1461         mutex_lock_nested(&bdev->bd_mutex, for_part);
1462         if (for_part)
1463                 bdev->bd_part_count--;
1464
1465         if (!--bdev->bd_openers) {
1466                 WARN_ON_ONCE(bdev->bd_holders);
1467                 sync_blockdev(bdev);
1468                 kill_bdev(bdev);
1469                 /* ->release can cause the old bdi to disappear,
1470                  * so must switch it out first
1471                  */
1472                 bdev_inode_switch_bdi(bdev->bd_inode,
1473                                         &default_backing_dev_info);
1474         }
1475         if (bdev->bd_contains == bdev) {
1476                 if (disk->fops->release)
1477                         ret = disk->fops->release(disk, mode);
1478         }
1479         if (!bdev->bd_openers) {
1480                 struct module *owner = disk->fops->owner;
1481
1482                 disk_put_part(bdev->bd_part);
1483                 bdev->bd_part = NULL;
1484                 bdev->bd_disk = NULL;
1485                 if (bdev != bdev->bd_contains)
1486                         victim = bdev->bd_contains;
1487                 bdev->bd_contains = NULL;
1488
1489                 put_disk(disk);
1490                 module_put(owner);
1491         }
1492         mutex_unlock(&bdev->bd_mutex);
1493         bdput(bdev);
1494         if (victim)
1495                 __blkdev_put(victim, mode, 1);
1496         return ret;
1497 }
1498
1499 int blkdev_put(struct block_device *bdev, fmode_t mode)
1500 {
1501         mutex_lock(&bdev->bd_mutex);
1502
1503         if (mode & FMODE_EXCL) {
1504                 bool bdev_free;
1505
1506                 /*
1507                  * Release a claim on the device.  The holder fields
1508                  * are protected with bdev_lock.  bd_mutex is to
1509                  * synchronize disk_holder unlinking.
1510                  */
1511                 spin_lock(&bdev_lock);
1512
1513                 WARN_ON_ONCE(--bdev->bd_holders < 0);
1514                 WARN_ON_ONCE(--bdev->bd_contains->bd_holders < 0);
1515
1516                 /* bd_contains might point to self, check in a separate step */
1517                 if ((bdev_free = !bdev->bd_holders))
1518                         bdev->bd_holder = NULL;
1519                 if (!bdev->bd_contains->bd_holders)
1520                         bdev->bd_contains->bd_holder = NULL;
1521
1522                 spin_unlock(&bdev_lock);
1523
1524                 /*
1525                  * If this was the last claim, remove holder link and
1526                  * unblock evpoll if it was a write holder.
1527                  */
1528                 if (bdev_free && bdev->bd_write_holder) {
1529                         disk_unblock_events(bdev->bd_disk);
1530                         bdev->bd_write_holder = false;
1531                 }
1532         }
1533
1534         /*
1535          * Trigger event checking and tell drivers to flush MEDIA_CHANGE
1536          * event.  This is to ensure detection of media removal commanded
1537          * from userland - e.g. eject(1).
1538          */
1539         disk_flush_events(bdev->bd_disk, DISK_EVENT_MEDIA_CHANGE);
1540
1541         mutex_unlock(&bdev->bd_mutex);
1542
1543         return __blkdev_put(bdev, mode, 0);
1544 }
1545 EXPORT_SYMBOL(blkdev_put);
1546
1547 static int blkdev_close(struct inode * inode, struct file * filp)
1548 {
1549         struct block_device *bdev = I_BDEV(filp->f_mapping->host);
1550
1551         return blkdev_put(bdev, filp->f_mode);
1552 }
1553
1554 static long block_ioctl(struct file *file, unsigned cmd, unsigned long arg)
1555 {
1556         struct block_device *bdev = I_BDEV(file->f_mapping->host);
1557         fmode_t mode = file->f_mode;
1558
1559         /*
1560          * O_NDELAY can be altered using fcntl(.., F_SETFL, ..), so we have
1561          * to updated it before every ioctl.
1562          */
1563         if (file->f_flags & O_NDELAY)
1564                 mode |= FMODE_NDELAY;
1565         else
1566                 mode &= ~FMODE_NDELAY;
1567
1568         return blkdev_ioctl(bdev, mode, cmd, arg);
1569 }
1570
1571 /*
1572  * Write data to the block device.  Only intended for the block device itself
1573  * and the raw driver which basically is a fake block device.
1574  *
1575  * Does not take i_mutex for the write and thus is not for general purpose
1576  * use.
1577  */
1578 ssize_t blkdev_aio_write(struct kiocb *iocb, const struct iovec *iov,
1579                          unsigned long nr_segs, loff_t pos)
1580 {
1581         struct file *file = iocb->ki_filp;
1582         ssize_t ret;
1583
1584         BUG_ON(iocb->ki_pos != pos);
1585
1586         ret = __generic_file_aio_write(iocb, iov, nr_segs, &iocb->ki_pos);
1587         if (ret > 0 || ret == -EIOCBQUEUED) {
1588                 ssize_t err;
1589
1590                 err = generic_write_sync(file, pos, ret);
1591                 if (err < 0 && ret > 0)
1592                         ret = err;
1593         }
1594         return ret;
1595 }
1596 EXPORT_SYMBOL_GPL(blkdev_aio_write);
1597
1598 /*
1599  * Try to release a page associated with block device when the system
1600  * is under memory pressure.
1601  */
1602 static int blkdev_releasepage(struct page *page, gfp_t wait)
1603 {
1604         struct super_block *super = BDEV_I(page->mapping->host)->bdev.bd_super;
1605
1606         if (super && super->s_op->bdev_try_to_free_page)
1607                 return super->s_op->bdev_try_to_free_page(super, page, wait);
1608
1609         return try_to_free_buffers(page);
1610 }
1611
1612 static const struct address_space_operations def_blk_aops = {
1613         .readpage       = blkdev_readpage,
1614         .writepage      = blkdev_writepage,
1615         .write_begin    = blkdev_write_begin,
1616         .write_end      = blkdev_write_end,
1617         .writepages     = generic_writepages,
1618         .releasepage    = blkdev_releasepage,
1619         .direct_IO      = blkdev_direct_IO,
1620 };
1621
1622 const struct file_operations def_blk_fops = {
1623         .open           = blkdev_open,
1624         .release        = blkdev_close,
1625         .llseek         = block_llseek,
1626         .read           = do_sync_read,
1627         .write          = do_sync_write,
1628         .aio_read       = generic_file_aio_read,
1629         .aio_write      = blkdev_aio_write,
1630         .mmap           = generic_file_mmap,
1631         .fsync          = blkdev_fsync,
1632         .unlocked_ioctl = block_ioctl,
1633 #ifdef CONFIG_COMPAT
1634         .compat_ioctl   = compat_blkdev_ioctl,
1635 #endif
1636         .splice_read    = generic_file_splice_read,
1637         .splice_write   = generic_file_splice_write,
1638 };
1639
1640 int ioctl_by_bdev(struct block_device *bdev, unsigned cmd, unsigned long arg)
1641 {
1642         int res;
1643         mm_segment_t old_fs = get_fs();
1644         set_fs(KERNEL_DS);
1645         res = blkdev_ioctl(bdev, 0, cmd, arg);
1646         set_fs(old_fs);
1647         return res;
1648 }
1649
1650 EXPORT_SYMBOL(ioctl_by_bdev);
1651
1652 /**
1653  * lookup_bdev  - lookup a struct block_device by name
1654  * @pathname:   special file representing the block device
1655  *
1656  * Get a reference to the blockdevice at @pathname in the current
1657  * namespace if possible and return it.  Return ERR_PTR(error)
1658  * otherwise.
1659  */
1660 struct block_device *lookup_bdev(const char *pathname)
1661 {
1662         struct block_device *bdev;
1663         struct inode *inode;
1664         struct path path;
1665         int error;
1666
1667         if (!pathname || !*pathname)
1668                 return ERR_PTR(-EINVAL);
1669
1670         error = kern_path(pathname, LOOKUP_FOLLOW, &path);
1671         if (error)
1672                 return ERR_PTR(error);
1673
1674         inode = path.dentry->d_inode;
1675         error = -ENOTBLK;
1676         if (!S_ISBLK(inode->i_mode))
1677                 goto fail;
1678         error = -EACCES;
1679         if (path.mnt->mnt_flags & MNT_NODEV)
1680                 goto fail;
1681         error = -ENOMEM;
1682         bdev = bd_acquire(inode);
1683         if (!bdev)
1684                 goto fail;
1685 out:
1686         path_put(&path);
1687         return bdev;
1688 fail:
1689         bdev = ERR_PTR(error);
1690         goto out;
1691 }
1692 EXPORT_SYMBOL(lookup_bdev);
1693
1694 int __invalidate_device(struct block_device *bdev, bool kill_dirty)
1695 {
1696         struct super_block *sb = get_super(bdev);
1697         int res = 0;
1698
1699         if (sb) {
1700                 /*
1701                  * no need to lock the super, get_super holds the
1702                  * read mutex so the filesystem cannot go away
1703                  * under us (->put_super runs with the write lock
1704                  * hold).
1705                  */
1706                 shrink_dcache_sb(sb);
1707                 res = invalidate_inodes(sb, kill_dirty);
1708                 drop_super(sb);
1709         }
1710         invalidate_bdev(bdev);
1711         return res;
1712 }
1713 EXPORT_SYMBOL(__invalidate_device);