block/genhd.c

   1 /*
   2  *  gendisk handling
   3  */
   4
   5 #include <linux/module.h>
   6 #include <linux/fs.h>
   7 #include <linux/genhd.h>
   8 #include <linux/kdev_t.h>
   9 #include <linux/kernel.h>
  10 #include <linux/blkdev.h>
  11 #include <linux/init.h>
  12 #include <linux/spinlock.h>
  13 #include <linux/proc_fs.h>
  14 #include <linux/seq_file.h>
  15 #include <linux/slab.h>
  16 #include <linux/kmod.h>
  17 #include <linux/kobj_map.h>
  18 #include <linux/mutex.h>
  19 #include <linux/idr.h>
  20 #include <linux/log2.h>
  21 #include <linux/pm_runtime.h>
  22
  23 #include "blk.h"
  24
  25 static DEFINE_MUTEX(block_class_lock);
  26 struct kobject *block_depr;
  27
  28 /* for extended dynamic devt allocation, currently only one major is used */
  29 #define NR_EXT_DEVT             (1 << MINORBITS)
  30
  31 /* For extended devt allocation.  ext_devt_lock prevents look up
  32  * results from going away underneath its user.
  33  */
  34 static DEFINE_SPINLOCK(ext_devt_lock);
  35 static DEFINE_IDR(ext_devt_idr);
  36
  37 static struct device_type disk_type;
  38
  39 static void disk_check_events(struct disk_events *ev,
  40                               unsigned int *clearing_ptr);
  41 static void disk_alloc_events(struct gendisk *disk);
  42 static void disk_add_events(struct gendisk *disk);
  43 static void disk_del_events(struct gendisk *disk);
  44 static void disk_release_events(struct gendisk *disk);
  45
  46 /**
  47  * disk_get_part - get partition
  48  * @disk: disk to look partition from
  49  * @partno: partition number
  50  *
  51  * Look for partition @partno from @disk.  If found, increment
  52  * reference count and return it.
  53  *
  54  * CONTEXT:
  55  * Don't care.
  56  *
  57  * RETURNS:
  58  * Pointer to the found partition on success, NULL if not found.
  59  */
  60 struct hd_struct *disk_get_part(struct gendisk *disk, int partno)
  61 {
  62         struct hd_struct *part = NULL;
  63         struct disk_part_tbl *ptbl;
  64
  65         if (unlikely(partno < 0))
  66                 return NULL;
  67
  68         rcu_read_lock();
  69
  70         ptbl = rcu_dereference(disk->part_tbl);
  71         if (likely(partno < ptbl->len)) {
  72                 part = rcu_dereference(ptbl->part[partno]);
  73                 if (part)
  74                         get_device(part_to_dev(part));
  75         }
  76
  77         rcu_read_unlock();
  78
  79         return part;
  80 }
  81 EXPORT_SYMBOL_GPL(disk_get_part);
  82
  83 /**
  84  * disk_part_iter_init - initialize partition iterator
  85  * @piter: iterator to initialize
  86  * @disk: disk to iterate over
  87  * @flags: DISK_PITER_* flags
  88  *
  89  * Initialize @piter so that it iterates over partitions of @disk.
  90  *
  91  * CONTEXT:
  92  * Don't care.
  93  */
  94 void disk_part_iter_init(struct disk_part_iter *piter, struct gendisk *disk,
  95                           unsigned int flags)
  96 {
  97         struct disk_part_tbl *ptbl;
  98
  99         rcu_read_lock();
 100         ptbl = rcu_dereference(disk->part_tbl);
 101
 102         piter->disk = disk;
 103         piter->part = NULL;
 104
 105         if (flags & DISK_PITER_REVERSE)
 106                 piter->idx = ptbl->len - 1;
 107         else if (flags & (DISK_PITER_INCL_PART0 | DISK_PITER_INCL_EMPTY_PART0))
 108                 piter->idx = 0;
 109         else
 110                 piter->idx = 1;
 111
 112         piter->flags = flags;
 113
 114         rcu_read_unlock();
 115 }
 116 EXPORT_SYMBOL_GPL(disk_part_iter_init);
 117
 118 /**
 119  * disk_part_iter_next - proceed iterator to the next partition and return it
 120  * @piter: iterator of interest
 121  *
 122  * Proceed @piter to the next partition and return it.
 123  *
 124  * CONTEXT:
 125  * Don't care.
 126  */
 127 struct hd_struct *disk_part_iter_next(struct disk_part_iter *piter)
 128 {
 129         struct disk_part_tbl *ptbl;
 130         int inc, end;
 131
 132         /* put the last partition */
 133         disk_put_part(piter->part);
 134         piter->part = NULL;
 135
 136         /* get part_tbl */
 137         rcu_read_lock();
 138         ptbl = rcu_dereference(piter->disk->part_tbl);
 139
 140         /* determine iteration parameters */
 141         if (piter->flags & DISK_PITER_REVERSE) {
 142                 inc = -1;
 143                 if (piter->flags & (DISK_PITER_INCL_PART0 |
 144                                     DISK_PITER_INCL_EMPTY_PART0))
 145                         end = -1;
 146                 else
 147                         end = 0;
 148         } else {
 149                 inc = 1;
 150                 end = ptbl->len;
 151         }
 152
 153         /* iterate to the next partition */
 154         for (; piter->idx != end; piter->idx += inc) {
 155                 struct hd_struct *part;
 156
 157                 part = rcu_dereference(ptbl->part[piter->idx]);
 158                 if (!part)
 159                         continue;
 160                 if (!part_nr_sects_read(part) &&
 161                     !(piter->flags & DISK_PITER_INCL_EMPTY) &&
 162                     !(piter->flags & DISK_PITER_INCL_EMPTY_PART0 &&
 163                       piter->idx == 0))
 164                         continue;
 165
 166                 get_device(part_to_dev(part));
 167                 piter->part = part;
 168                 piter->idx += inc;
 169                 break;
 170         }
 171
 172         rcu_read_unlock();
 173
 174         return piter->part;
 175 }
 176 EXPORT_SYMBOL_GPL(disk_part_iter_next);
 177
 178 /**
 179  * disk_part_iter_exit - finish up partition iteration
 180  * @piter: iter of interest
 181  *
 182  * Called when iteration is over.  Cleans up @piter.
 183  *
 184  * CONTEXT:
 185  * Don't care.
 186  */
 187 void disk_part_iter_exit(struct disk_part_iter *piter)
 188 {
 189         disk_put_part(piter->part);
 190         piter->part = NULL;
 191 }
 192 EXPORT_SYMBOL_GPL(disk_part_iter_exit);
 193
 194 static inline int sector_in_part(struct hd_struct *part, sector_t sector)
 195 {
 196         return part->start_sect <= sector &&
 197                 sector < part->start_sect + part_nr_sects_read(part);
 198 }
 199
 200 /**
 201  * disk_map_sector_rcu - map sector to partition
 202  * @disk: gendisk of interest
 203  * @sector: sector to map
 204  *
 205  * Find out which partition @sector maps to on @disk.  This is
 206  * primarily used for stats accounting.
 207  *
 208  * CONTEXT:
 209  * RCU read locked.  The returned partition pointer is valid only
 210  * while preemption is disabled.
 211  *
 212  * RETURNS:
 213  * Found partition on success, part0 is returned if no partition matches
 214  */
 215 struct hd_struct *disk_map_sector_rcu(struct gendisk *disk, sector_t sector)
 216 {
 217         struct disk_part_tbl *ptbl;
 218         struct hd_struct *part;
 219         int i;
 220
 221         ptbl = rcu_dereference(disk->part_tbl);
 222
 223         part = rcu_dereference(ptbl->last_lookup);
 224         if (part && sector_in_part(part, sector))
 225                 return part;
 226
 227         for (i = 1; i < ptbl->len; i++) {
 228                 part = rcu_dereference(ptbl->part[i]);
 229
 230                 if (part && sector_in_part(part, sector)) {
 231                         rcu_assign_pointer(ptbl->last_lookup, part);
 232                         return part;
 233                 }
 234         }
 235         return &disk->part0;
 236 }
 237 EXPORT_SYMBOL_GPL(disk_map_sector_rcu);
 238
 239 /*
 240  * Can be deleted altogether. Later.
 241  *
 242  */
 243 static struct blk_major_name {
 244         struct blk_major_name *next;
 245         int major;
 246         char name[16];
 247 } *major_names[BLKDEV_MAJOR_HASH_SIZE];
 248
 249 /* index in the above - for now: assume no multimajor ranges */
 250 static inline int major_to_index(unsigned major)
 251 {
 252         return major % BLKDEV_MAJOR_HASH_SIZE;
 253 }
 254
 255 #ifdef CONFIG_PROC_FS
 256 void blkdev_show(struct seq_file *seqf, off_t offset)
 257 {
 258         struct blk_major_name *dp;
 259
 260         if (offset < BLKDEV_MAJOR_HASH_SIZE) {
 261                 mutex_lock(&block_class_lock);
 262                 for (dp = major_names[offset]; dp; dp = dp->next)
 263                         seq_printf(seqf, "%3d %s\n", dp->major, dp->name);
 264                 mutex_unlock(&block_class_lock);
 265         }
 266 }
 267 #endif /* CONFIG_PROC_FS */
 268
 269 /**
 270  * register_blkdev - register a new block device
 271  *
 272  * @major: the requested major device number [1..255]. If @major=0, try to
 273  *         allocate any unused major number.
 274  * @name: the name of the new block device as a zero terminated string
 275  *
 276  * The @name must be unique within the system.
 277  *
 278  * The return value depends on the @major input parameter.
 279  *  - if a major device number was requested in range [1..255] then the
 280  *    function returns zero on success, or a negative error code
 281  *  - if any unused major number was requested with @major=0 parameter
 282  *    then the return value is the allocated major number in range
 283  *    [1..255] or a negative error code otherwise
 284  */
 285 int register_blkdev(unsigned int major, const char *name)
 286 {
 287         struct blk_major_name **n, *p;
 288         int index, ret = 0;
 289
 290         mutex_lock(&block_class_lock);
 291
 292         /* temporary */
 293         if (major == 0) {
 294                 for (index = ARRAY_SIZE(major_names)-1; index > 0; index--) {
 295                         if (major_names[index] == NULL)
 296                                 break;
 297                 }
 298
 299                 if (index == 0) {
 300                         printk("register_blkdev: failed to get major for %s\n",
 301                                name);
 302                         ret = -EBUSY;
 303                         goto out;
 304                 }
 305                 major = index;
 306                 ret = major;
 307         }
 308
 309         p = kmalloc(sizeof(struct blk_major_name), GFP_KERNEL);
 310         if (p == NULL) {
 311                 ret = -ENOMEM;
 312                 goto out;
 313         }
 314
 315         p->major = major;
 316         strlcpy(p->name, name, sizeof(p->name));
 317         p->next = NULL;
 318         index = major_to_index(major);
 319
 320         for (n = &major_names[index]; *n; n = &(*n)->next) {
 321                 if ((*n)->major == major)
 322                         break;
 323         }
 324         if (!*n)
 325                 *n = p;
 326         else
 327                 ret = -EBUSY;
 328
 329         if (ret < 0) {
 330                 printk("register_blkdev: cannot get major %d for %s\n",
 331                        major, name);
 332                 kfree(p);
 333         }
 334 out:
 335         mutex_unlock(&block_class_lock);
 336         return ret;
 337 }
 338
 339 EXPORT_SYMBOL(register_blkdev);
 340
 341 void unregister_blkdev(unsigned int major, const char *name)
 342 {
 343         struct blk_major_name **n;
 344         struct blk_major_name *p = NULL;
 345         int index = major_to_index(major);
 346
 347         mutex_lock(&block_class_lock);
 348         for (n = &major_names[index]; *n; n = &(*n)->next)
 349                 if ((*n)->major == major)
 350                         break;
 351         if (!*n || strcmp((*n)->name, name)) {
 352                 WARN_ON(1);
 353         } else {
 354                 p = *n;
 355                 *n = p->next;
 356         }
 357         mutex_unlock(&block_class_lock);
 358         kfree(p);
 359 }
 360
 361 EXPORT_SYMBOL(unregister_blkdev);
 362
 363 static struct kobj_map *bdev_map;
 364
 365 /**
 366  * blk_mangle_minor - scatter minor numbers apart
 367  * @minor: minor number to mangle
 368  *
 369  * Scatter consecutively allocated @minor number apart if MANGLE_DEVT
 370  * is enabled.  Mangling twice gives the original value.
 371  *
 372  * RETURNS:
 373  * Mangled value.
 374  *
 375  * CONTEXT:
 376  * Don't care.
 377  */
 378 static int blk_mangle_minor(int minor)
 379 {
 380 #ifdef CONFIG_DEBUG_BLOCK_EXT_DEVT
 381         int i;
 382
 383         for (i = 0; i < MINORBITS / 2; i++) {
 384                 int low = minor & (1 << i);
 385                 int high = minor & (1 << (MINORBITS - 1 - i));
 386                 int distance = MINORBITS - 1 - 2 * i;
 387
 388                 minor ^= low | high;    /* clear both bits */
 389                 low <<= distance;       /* swap the positions */
 390                 high >>= distance;
 391                 minor |= low | high;    /* and set */
 392         }
 393 #endif
 394         return minor;
 395 }
 396
 397 /**
 398  * blk_alloc_devt - allocate a dev_t for a partition
 399  * @part: partition to allocate dev_t for
 400  * @devt: out parameter for resulting dev_t
 401  *
 402  * Allocate a dev_t for block device.
 403  *
 404  * RETURNS:
 405  * 0 on success, allocated dev_t is returned in *@devt.  -errno on
 406  * failure.
 407  *
 408  * CONTEXT:
 409  * Might sleep.
 410  */
 411 int blk_alloc_devt(struct hd_struct *part, dev_t *devt)
 412 {
 413         struct gendisk *disk = part_to_disk(part);
 414         int idx;
 415
 416         /* in consecutive minor range? */
 417         if (part->partno < disk->minors) {
 418                 *devt = MKDEV(disk->major, disk->first_minor + part->partno);
 419                 return 0;
 420         }
 421
 422         /* allocate ext devt */
 423         idr_preload(GFP_KERNEL);
 424
 425         spin_lock(&ext_devt_lock);
 426         idx = idr_alloc(&ext_devt_idr, part, 0, NR_EXT_DEVT, GFP_NOWAIT);
 427         spin_unlock(&ext_devt_lock);
 428
 429         idr_preload_end();
 430         if (idx < 0)
 431                 return idx == -ENOSPC ? -EBUSY : idx;
 432
 433         *devt = MKDEV(BLOCK_EXT_MAJOR, blk_mangle_minor(idx));
 434         return 0;
 435 }
 436
 437 /**
 438  * blk_free_devt - free a dev_t
 439  * @devt: dev_t to free
 440  *
 441  * Free @devt which was allocated using blk_alloc_devt().
 442  *
 443  * CONTEXT:
 444  * Might sleep.
 445  */
 446 void blk_free_devt(dev_t devt)
 447 {
 448         might_sleep();
 449
 450         if (devt == MKDEV(0, 0))
 451                 return;
 452
 453         if (MAJOR(devt) == BLOCK_EXT_MAJOR) {
 454                 spin_lock(&ext_devt_lock);
 455                 idr_remove(&ext_devt_idr, blk_mangle_minor(MINOR(devt)));
 456                 spin_unlock(&ext_devt_lock);
 457         }
 458 }
 459
 460 static char *bdevt_str(dev_t devt, char *buf)
 461 {
 462         if (MAJOR(devt) <= 0xff && MINOR(devt) <= 0xff) {
 463                 char tbuf[BDEVT_SIZE];
 464                 snprintf(tbuf, BDEVT_SIZE, "%02x%02x", MAJOR(devt), MINOR(devt));
 465                 snprintf(buf, BDEVT_SIZE, "%-9s", tbuf);
 466         } else
 467                 snprintf(buf, BDEVT_SIZE, "%03x:%05x", MAJOR(devt), MINOR(devt));
 468
 469         return buf;
 470 }
 471
 472 /*
 473  * Register device numbers dev..(dev+range-1)
 474  * range must be nonzero
 475  * The hash chain is sorted on range, so that subranges can override.
 476  */
 477 void blk_register_region(dev_t devt, unsigned long range, struct module *module,
 478                          struct kobject *(*probe)(dev_t, int *, void *),
 479                          int (*lock)(dev_t, void *), void *data)
 480 {
 481         kobj_map(bdev_map, devt, range, module, probe, lock, data);
 482 }
 483
 484 EXPORT_SYMBOL(blk_register_region);
 485
 486 void blk_unregister_region(dev_t devt, unsigned long range)
 487 {
 488         kobj_unmap(bdev_map, devt, range);
 489 }
 490
 491 EXPORT_SYMBOL(blk_unregister_region);
 492
 493 static struct kobject *exact_match(dev_t devt, int *partno, void *data)
 494 {
 495         struct gendisk *p = data;
 496
 497         return &disk_to_dev(p)->kobj;
 498 }
 499
 500 static int exact_lock(dev_t devt, void *data)
 501 {
 502         struct gendisk *p = data;
 503
 504         if (!get_disk(p))
 505                 return -1;
 506         return 0;
 507 }
 508
 509 static void register_disk(struct gendisk *disk)
 510 {
 511         struct device *ddev = disk_to_dev(disk);
 512         struct block_device *bdev;
 513         struct disk_part_iter piter;
 514         struct hd_struct *part;
 515         int err;
 516
 517         ddev->parent = disk->driverfs_dev;
 518
 519         dev_set_name(ddev, "%s", disk->disk_name);
 520
 521         /* delay uevents, until we scanned partition table */
 522         dev_set_uevent_suppress(ddev, 1);
 523
 524         if (device_add(ddev))
 525                 return;
 526         if (!sysfs_deprecated) {
 527                 err = sysfs_create_link(block_depr, &ddev->kobj,
 528                                         kobject_name(&ddev->kobj));
 529                 if (err) {
 530                         device_del(ddev);
 531                         return;
 532                 }
 533         }
 534
 535         /*
 536          * avoid probable deadlock caused by allocating memory with
 537          * GFP_KERNEL in runtime_resume callback of its all ancestor
 538          * devices
 539          */
 540         pm_runtime_set_memalloc_noio(ddev, true);
 541
 542         disk->part0.holder_dir = kobject_create_and_add("holders", &ddev->kobj);
 543         disk->slave_dir = kobject_create_and_add("slaves", &ddev->kobj);
 544
 545         /* No minors to use for partitions */
 546         if (!disk_part_scan_enabled(disk))
 547                 goto exit;
 548
 549         /* No such device (e.g., media were just removed) */
 550         if (!get_capacity(disk))
 551                 goto exit;
 552
 553         bdev = bdget_disk(disk, 0);
 554         if (!bdev)
 555                 goto exit;
 556
 557         bdev->bd_invalidated = 1;
 558         err = blkdev_get(bdev, FMODE_READ, NULL);
 559         if (err < 0)
 560                 goto exit;
 561         blkdev_put(bdev, FMODE_READ);
 562
 563 exit:
 564         /* announce disk after possible partitions are created */
 565         dev_set_uevent_suppress(ddev, 0);
 566         kobject_uevent(&ddev->kobj, KOBJ_ADD);
 567
 568         /* announce possible partitions */
 569         disk_part_iter_init(&piter, disk, 0);
 570         while ((part = disk_part_iter_next(&piter)))
 571                 kobject_uevent(&part_to_dev(part)->kobj, KOBJ_ADD);
 572         disk_part_iter_exit(&piter);
 573 }
 574
 575 /**
 576  * add_disk - add partitioning information to kernel list
 577  * @disk: per-device partitioning information
 578  *
 579  * This function registers the partitioning information in @disk
 580  * with the kernel.
 581  *
 582  * FIXME: error handling
 583  */
 584 void add_disk(struct gendisk *disk)
 585 {
 586         struct backing_dev_info *bdi;
 587         dev_t devt;
 588         int retval;
 589
 590         /* minors == 0 indicates to use ext devt from part0 and should
 591          * be accompanied with EXT_DEVT flag.  Make sure all
 592          * parameters make sense.
 593          */
 594         WARN_ON(disk->minors && !(disk->major || disk->first_minor));
 595         WARN_ON(!disk->minors && !(disk->flags & GENHD_FL_EXT_DEVT));
 596
 597         disk->flags |= GENHD_FL_UP;
 598
 599         retval = blk_alloc_devt(&disk->part0, &devt);
 600         if (retval) {
 601                 WARN_ON(1);
 602                 return;
 603         }
 604         disk_to_dev(disk)->devt = devt;
 605
 606         /* ->major and ->first_minor aren't supposed to be
 607          * dereferenced from here on, but set them just in case.
 608          */
 609         disk->major = MAJOR(devt);
 610         disk->first_minor = MINOR(devt);
 611
 612         disk_alloc_events(disk);
 613
 614         /* Register BDI before referencing it from bdev */
 615         bdi = &disk->queue->backing_dev_info;
 616         bdi_register_dev(bdi, disk_devt(disk));
 617
 618         blk_register_region(disk_devt(disk), disk->minors, NULL,
 619                             exact_match, exact_lock, disk);
 620         register_disk(disk);
 621         blk_register_queue(disk);
 622
 623         /*
 624          * Take an extra ref on queue which will be put on disk_release()
 625          * so that it sticks around as long as @disk is there.
 626          */
 627         WARN_ON_ONCE(!blk_get_queue(disk->queue));
 628
 629         retval = sysfs_create_link(&disk_to_dev(disk)->kobj, &bdi->dev->kobj,
 630                                    "bdi");
 631         WARN_ON(retval);
 632
 633         disk_add_events(disk);
 634 }
 635 EXPORT_SYMBOL(add_disk);
 636
 637 void del_gendisk(struct gendisk *disk)
 638 {
 639         struct disk_part_iter piter;
 640         struct hd_struct *part;
 641
 642         disk_del_events(disk);
 643
 644         /* invalidate stuff */
 645         disk_part_iter_init(&piter, disk,
 646                              DISK_PITER_INCL_EMPTY | DISK_PITER_REVERSE);
 647         while ((part = disk_part_iter_next(&piter))) {
 648                 invalidate_partition(disk, part->partno);
 649                 delete_partition(disk, part->partno);
 650         }
 651         disk_part_iter_exit(&piter);
 652
 653         invalidate_partition(disk, 0);
 654         set_capacity(disk, 0);
 655         disk->flags &= ~GENHD_FL_UP;
 656
 657         sysfs_remove_link(&disk_to_dev(disk)->kobj, "bdi");
 658         bdi_unregister(&disk->queue->backing_dev_info);
 659         blk_unregister_queue(disk);
 660         blk_unregister_region(disk_devt(disk), disk->minors);
 661
 662         part_stat_set_all(&disk->part0, 0);
 663         disk->part0.stamp = 0;
 664
 665         kobject_put(disk->part0.holder_dir);
 666         kobject_put(disk->slave_dir);
 667         disk->driverfs_dev = NULL;
 668         if (!sysfs_deprecated)
 669                 sysfs_remove_link(block_depr, dev_name(disk_to_dev(disk)));
 670         pm_runtime_set_memalloc_noio(disk_to_dev(disk), false);
 671         device_del(disk_to_dev(disk));
 672 }
 673 EXPORT_SYMBOL(del_gendisk);
 674
 675 /**
 676  * get_gendisk - get partitioning information for a given device
 677  * @devt: device to get partitioning information for
 678  * @partno: returned partition index
 679  *
 680  * This function gets the structure containing partitioning
 681  * information for the given device @devt.
 682  */
 683 struct gendisk *get_gendisk(dev_t devt, int *partno)
 684 {
 685         struct gendisk *disk = NULL;
 686
 687         if (MAJOR(devt) != BLOCK_EXT_MAJOR) {
 688                 struct kobject *kobj;
 689
 690                 kobj = kobj_lookup(bdev_map, devt, partno);
 691                 if (kobj)
 692                         disk = dev_to_disk(kobj_to_dev(kobj));
 693         } else {
 694                 struct hd_struct *part;
 695
 696                 spin_lock(&ext_devt_lock);
 697                 part = idr_find(&ext_devt_idr, blk_mangle_minor(MINOR(devt)));
 698                 if (part && get_disk(part_to_disk(part))) {
 699                         *partno = part->partno;
 700                         disk = part_to_disk(part);
 701                 }
 702                 spin_unlock(&ext_devt_lock);
 703         }
 704
 705         return disk;
 706 }
 707 EXPORT_SYMBOL(get_gendisk);
 708
 709 /**
 710  * bdget_disk - do bdget() by gendisk and partition number
 711  * @disk: gendisk of interest
 712  * @partno: partition number
 713  *
 714  * Find partition @partno from @disk, do bdget() on it.
 715  *
 716  * CONTEXT:
 717  * Don't care.
 718  *
 719  * RETURNS:
 720  * Resulting block_device on success, NULL on failure.
 721  */
 722 struct block_device *bdget_disk(struct gendisk *disk, int partno)
 723 {
 724         struct hd_struct *part;
 725         struct block_device *bdev = NULL;
 726
 727         part = disk_get_part(disk, partno);
 728         if (part)
 729                 bdev = bdget(part_devt(part));
 730         disk_put_part(part);
 731
 732         return bdev;
 733 }
 734 EXPORT_SYMBOL(bdget_disk);
 735
 736 /*
 737  * print a full list of all partitions - intended for places where the root
 738  * filesystem can't be mounted and thus to give the victim some idea of what
 739  * went wrong
 740  */
 741 void __init printk_all_partitions(void)
 742 {
 743         struct class_dev_iter iter;
 744         struct device *dev;
 745
 746         class_dev_iter_init(&iter, &block_class, NULL, &disk_type);
 747         while ((dev = class_dev_iter_next(&iter))) {
 748                 struct gendisk *disk = dev_to_disk(dev);
 749                 struct disk_part_iter piter;
 750                 struct hd_struct *part;
 751                 char name_buf[BDEVNAME_SIZE];
 752                 char devt_buf[BDEVT_SIZE];
 753
 754                 /*
 755                  * Don't show empty devices or things that have been
 756                  * suppressed
 757                  */
 758                 if (get_capacity(disk) == 0 ||
 759                     (disk->flags & GENHD_FL_SUPPRESS_PARTITION_INFO))
 760                         continue;
 761
 762                 /*
 763                  * Note, unlike /proc/partitions, I am showing the
 764                  * numbers in hex - the same format as the root=
 765                  * option takes.
 766                  */
 767                 disk_part_iter_init(&piter, disk, DISK_PITER_INCL_PART0);
 768                 while ((part = disk_part_iter_next(&piter))) {
 769                         bool is_part0 = part == &disk->part0;
 770
 771                         printk("%s%s %10llu %s %s", is_part0 ? "" : "  ",
 772                                bdevt_str(part_devt(part), devt_buf),
 773                                (unsigned long long)part_nr_sects_read(part) >> 1
 774                                , disk_name(disk, part->partno, name_buf),
 775                                part->info ? part->info->uuid : "");
 776                         if (is_part0) {
 777                                 if (disk->driverfs_dev != NULL &&
 778                                     disk->driverfs_dev->driver != NULL)
 779                                         printk(" driver: %s\n",
 780                                               disk->driverfs_dev->driver->name);
 781                                 else
 782                                         printk(" (driver?)\n");
 783                         } else
 784                                 printk("\n");
 785                 }
 786                 disk_part_iter_exit(&piter);
 787         }
 788         class_dev_iter_exit(&iter);
 789 }
 790
 791 #ifdef CONFIG_PROC_FS
 792 /* iterator */
 793 static void *disk_seqf_start(struct seq_file *seqf, loff_t *pos)
 794 {
 795         loff_t skip = *pos;
 796         struct class_dev_iter *iter;
 797         struct device *dev;
 798
 799         iter = kmalloc(sizeof(*iter), GFP_KERNEL);
 800         if (!iter)
 801                 return ERR_PTR(-ENOMEM);
 802
 803         seqf->private = iter;
 804         class_dev_iter_init(iter, &block_class, NULL, &disk_type);
 805         do {
 806                 dev = class_dev_iter_next(iter);
 807                 if (!dev)
 808                         return NULL;
 809         } while (skip--);
 810
 811         return dev_to_disk(dev);
 812 }
 813
 814 static void *disk_seqf_next(struct seq_file *seqf, void *v, loff_t *pos)
 815 {
 816         struct device *dev;
 817
 818         (*pos)++;
 819         dev = class_dev_iter_next(seqf->private);
 820         if (dev)
 821                 return dev_to_disk(dev);
 822
 823         return NULL;
 824 }
 825
 826 static void disk_seqf_stop(struct seq_file *seqf, void *v)
 827 {
 828         struct class_dev_iter *iter = seqf->private;
 829
 830         /* stop is called even after start failed :-( */
 831         if (iter) {
 832                 class_dev_iter_exit(iter);
 833                 kfree(iter);
 834         }
 835 }
 836
 837 static void *show_partition_start(struct seq_file *seqf, loff_t *pos)
 838 {
 839         void *p;
 840
 841         p = disk_seqf_start(seqf, pos);
 842         if (!IS_ERR_OR_NULL(p) && !*pos)
 843                 seq_puts(seqf, "major minor  #blocks  name\n\n");
 844         return p;
 845 }
 846
 847 static int show_partition(struct seq_file *seqf, void *v)
 848 {
 849         struct gendisk *sgp = v;
 850         struct disk_part_iter piter;
 851         struct hd_struct *part;
 852         char buf[BDEVNAME_SIZE];
 853
 854         /* Don't show non-partitionable removeable devices or empty devices */
 855         if (!get_capacity(sgp) || (!disk_max_parts(sgp) &&
 856                                    (sgp->flags & GENHD_FL_REMOVABLE)))
 857                 return 0;
 858         if (sgp->flags & GENHD_FL_SUPPRESS_PARTITION_INFO)
 859                 return 0;
 860
 861         /* show the full disk and all non-0 size partitions of it */
 862         disk_part_iter_init(&piter, sgp, DISK_PITER_INCL_PART0);
 863         while ((part = disk_part_iter_next(&piter)))
 864                 seq_printf(seqf, "%4d  %7d %10llu %s\n",
 865                            MAJOR(part_devt(part)), MINOR(part_devt(part)),
 866                            (unsigned long long)part_nr_sects_read(part) >> 1,
 867                            disk_name(sgp, part->partno, buf));
 868         disk_part_iter_exit(&piter);
 869
 870         return 0;
 871 }
 872
 873 static const struct seq_operations partitions_op = {
 874         .start  = show_partition_start,
 875         .next   = disk_seqf_next,
 876         .stop   = disk_seqf_stop,
 877         .show   = show_partition
 878 };
 879
 880 static int partitions_open(struct inode *inode, struct file *file)
 881 {
 882         return seq_open(file, &partitions_op);
 883 }
 884
 885 static const struct file_operations proc_partitions_operations = {
 886         .open           = partitions_open,
 887         .read           = seq_read,
 888         .llseek         = seq_lseek,
 889         .release        = seq_release,
 890 };
 891 #endif
 892
 893
 894 static struct kobject *base_probe(dev_t devt, int *partno, void *data)
 895 {
 896         if (request_module("block-major-%d-%d", MAJOR(devt), MINOR(devt)) > 0)
 897                 /* Make old-style 2.4 aliases work */
 898                 request_module("block-major-%d", MAJOR(devt));
 899         return NULL;
 900 }
 901
 902 static int __init genhd_device_init(void)
 903 {
 904         int error;
 905
 906         block_class.dev_kobj = sysfs_dev_block_kobj;
 907         error = class_register(&block_class);
 908         if (unlikely(error))
 909                 return error;
 910         bdev_map = kobj_map_init(base_probe, &block_class_lock);
 911         blk_dev_init();
 912
 913         register_blkdev(BLOCK_EXT_MAJOR, "blkext");
 914
 915         /* create top-level block dir */
 916         if (!sysfs_deprecated)
 917                 block_depr = kobject_create_and_add("block", NULL);
 918         return 0;
 919 }
 920
 921 subsys_initcall(genhd_device_init);
 922
 923 static ssize_t disk_range_show(struct device *dev,
 924                                struct device_attribute *attr, char *buf)
 925 {
 926         struct gendisk *disk = dev_to_disk(dev);
 927
 928         return sprintf(buf, "%d\n", disk->minors);
 929 }
 930
 931 static ssize_t disk_ext_range_show(struct device *dev,
 932                                    struct device_attribute *attr, char *buf)
 933 {
 934         struct gendisk *disk = dev_to_disk(dev);
 935
 936         return sprintf(buf, "%d\n", disk_max_parts(disk));
 937 }
 938
 939 static ssize_t disk_removable_show(struct device *dev,
 940                                    struct device_attribute *attr, char *buf)
 941 {
 942         struct gendisk *disk = dev_to_disk(dev);
 943
 944         return sprintf(buf, "%d\n",
 945                        (disk->flags & GENHD_FL_REMOVABLE ? 1 : 0));
 946 }
 947
 948 static ssize_t disk_ro_show(struct device *dev,
 949                                    struct device_attribute *attr, char *buf)
 950 {
 951         struct gendisk *disk = dev_to_disk(dev);
 952
 953         return sprintf(buf, "%d\n", get_disk_ro(disk) ? 1 : 0);
 954 }
 955
 956 static ssize_t disk_capability_show(struct device *dev,
 957                                     struct device_attribute *attr, char *buf)
 958 {
 959         struct gendisk *disk = dev_to_disk(dev);
 960
 961         return sprintf(buf, "%x\n", disk->flags);
 962 }
 963
 964 static ssize_t disk_alignment_offset_show(struct device *dev,
 965                                           struct device_attribute *attr,
 966                                           char *buf)
 967 {
 968         struct gendisk *disk = dev_to_disk(dev);
 969
 970         return sprintf(buf, "%d\n", queue_alignment_offset(disk->queue));
 971 }
 972
 973 static ssize_t disk_discard_alignment_show(struct device *dev,
 974                                            struct device_attribute *attr,
 975                                            char *buf)
 976 {
 977         struct gendisk *disk = dev_to_disk(dev);
 978
 979         return sprintf(buf, "%d\n", queue_discard_alignment(disk->queue));
 980 }
 981
 982 static DEVICE_ATTR(range, S_IRUGO, disk_range_show, NULL);
 983 static DEVICE_ATTR(ext_range, S_IRUGO, disk_ext_range_show, NULL);
 984 static DEVICE_ATTR(removable, S_IRUGO, disk_removable_show, NULL);
 985 static DEVICE_ATTR(ro, S_IRUGO, disk_ro_show, NULL);
 986 static DEVICE_ATTR(size, S_IRUGO, part_size_show, NULL);
 987 static DEVICE_ATTR(alignment_offset, S_IRUGO, disk_alignment_offset_show, NULL);
 988 static DEVICE_ATTR(discard_alignment, S_IRUGO, disk_discard_alignment_show,
 989                    NULL);
 990 static DEVICE_ATTR(capability, S_IRUGO, disk_capability_show, NULL);
 991 static DEVICE_ATTR(stat, S_IRUGO, part_stat_show, NULL);
 992 static DEVICE_ATTR(inflight, S_IRUGO, part_inflight_show, NULL);
 993 #ifdef CONFIG_FAIL_MAKE_REQUEST
 994 static struct device_attribute dev_attr_fail =
 995         __ATTR(make-it-fail, S_IRUGO|S_IWUSR, part_fail_show, part_fail_store);
 996 #endif
 997 #ifdef CONFIG_FAIL_IO_TIMEOUT
 998 static struct device_attribute dev_attr_fail_timeout =
 999         __ATTR(io-timeout-fail,  S_IRUGO|S_IWUSR, part_timeout_show,
1000                 part_timeout_store);
1001 #endif
1002
1003 static struct attribute *disk_attrs[] = {
1004         &dev_attr_range.attr,
1005         &dev_attr_ext_range.attr,
1006         &dev_attr_removable.attr,
1007         &dev_attr_ro.attr,
1008         &dev_attr_size.attr,
1009         &dev_attr_alignment_offset.attr,
1010         &dev_attr_discard_alignment.attr,
1011         &dev_attr_capability.attr,
1012         &dev_attr_stat.attr,
1013         &dev_attr_inflight.attr,
1014 #ifdef CONFIG_FAIL_MAKE_REQUEST
1015         &dev_attr_fail.attr,
1016 #endif
1017 #ifdef CONFIG_FAIL_IO_TIMEOUT
1018         &dev_attr_fail_timeout.attr,
1019 #endif
1020         NULL
1021 };
1022
1023 static struct attribute_group disk_attr_group = {
1024         .attrs = disk_attrs,
1025 };
1026
1027 static const struct attribute_group *disk_attr_groups[] = {
1028         &disk_attr_group,
1029         NULL
1030 };
1031
1032 /**
1033  * disk_replace_part_tbl - replace disk->part_tbl in RCU-safe way
1034  * @disk: disk to replace part_tbl for
1035  * @new_ptbl: new part_tbl to install
1036  *
1037  * Replace disk->part_tbl with @new_ptbl in RCU-safe way.  The
1038  * original ptbl is freed using RCU callback.
1039  *
1040  * LOCKING:
1041  * Matching bd_mutx locked.
1042  */
1043 static void disk_replace_part_tbl(struct gendisk *disk,
1044                                   struct disk_part_tbl *new_ptbl)
1045 {
1046         struct disk_part_tbl *old_ptbl = disk->part_tbl;
1047
1048         rcu_assign_pointer(disk->part_tbl, new_ptbl);
1049
1050         if (old_ptbl) {
1051                 rcu_assign_pointer(old_ptbl->last_lookup, NULL);
1052                 kfree_rcu(old_ptbl, rcu_head);
1053         }
1054 }
1055
1056 /**
1057  * disk_expand_part_tbl - expand disk->part_tbl
1058  * @disk: disk to expand part_tbl for
1059  * @partno: expand such that this partno can fit in
1060  *
1061  * Expand disk->part_tbl such that @partno can fit in.  disk->part_tbl
1062  * uses RCU to allow unlocked dereferencing for stats and other stuff.
1063  *
1064  * LOCKING:
1065  * Matching bd_mutex locked, might sleep.
1066  *
1067  * RETURNS:
1068  * 0 on success, -errno on failure.
1069  */
1070 int disk_expand_part_tbl(struct gendisk *disk, int partno)
1071 {
1072         struct disk_part_tbl *old_ptbl = disk->part_tbl;
1073         struct disk_part_tbl *new_ptbl;
1074         int len = old_ptbl ? old_ptbl->len : 0;
1075         int target = partno + 1;
1076         size_t size;
1077         int i;
1078
1079         /* disk_max_parts() is zero during initialization, ignore if so */
1080         if (disk_max_parts(disk) && target > disk_max_parts(disk))
1081                 return -EINVAL;
1082
1083         if (target <= len)
1084                 return 0;
1085
1086         size = sizeof(*new_ptbl) + target * sizeof(new_ptbl->part[0]);
1087         new_ptbl = kzalloc_node(size, GFP_KERNEL, disk->node_id);
1088         if (!new_ptbl)
1089                 return -ENOMEM;
1090
1091         new_ptbl->len = target;
1092
1093         for (i = 0; i < len; i++)
1094                 rcu_assign_pointer(new_ptbl->part[i], old_ptbl->part[i]);
1095
1096         disk_replace_part_tbl(disk, new_ptbl);
1097         return 0;
1098 }
1099
1100 static void disk_release(struct device *dev)
1101 {
1102         struct gendisk *disk = dev_to_disk(dev);
1103
1104         blk_free_devt(dev->devt);
1105         disk_release_events(disk);
1106         kfree(disk->random);
1107         disk_replace_part_tbl(disk, NULL);
1108         free_part_stats(&disk->part0);
1109         free_part_info(&disk->part0);
1110         if (disk->queue)
1111                 blk_put_queue(disk->queue);
1112         kfree(disk);
1113 }
1114 struct class block_class = {
1115         .name           = "block",
1116 };
1117
1118 static char *block_devnode(struct device *dev, umode_t *mode,
1119                            kuid_t *uid, kgid_t *gid)
1120 {
1121         struct gendisk *disk = dev_to_disk(dev);
1122
1123         if (disk->devnode)
1124                 return disk->devnode(disk, mode);
1125         return NULL;
1126 }
1127
1128 static struct device_type disk_type = {
1129         .name           = "disk",
1130         .groups         = disk_attr_groups,
1131         .release        = disk_release,
1132         .devnode        = block_devnode,
1133 };
1134
1135 #ifdef CONFIG_PROC_FS
1136 /*
1137  * aggregate disk stat collector.  Uses the same stats that the sysfs
1138  * entries do, above, but makes them available through one seq_file.
1139  *
1140  * The output looks suspiciously like /proc/partitions with a bunch of
1141  * extra fields.
1142  */
1143 static int diskstats_show(struct seq_file *seqf, void *v)
1144 {
1145         struct gendisk *gp = v;
1146         struct disk_part_iter piter;
1147         struct hd_struct *hd;
1148         char buf[BDEVNAME_SIZE];
1149         int cpu;
1150
1151         /*
1152         if (&disk_to_dev(gp)->kobj.entry == block_class.devices.next)
1153                 seq_puts(seqf,  "major minor name"
1154                                 "     rio rmerge rsect ruse wio wmerge "
1155                                 "wsect wuse running use aveq"
1156                                 "\n\n");
1157         */
1158
1159         disk_part_iter_init(&piter, gp, DISK_PITER_INCL_EMPTY_PART0);
1160         while ((hd = disk_part_iter_next(&piter))) {
1161                 cpu = part_stat_lock();
1162                 part_round_stats(cpu, hd);
1163                 part_stat_unlock();
1164                 seq_printf(seqf, "%4d %7d %s %lu %lu %lu "
1165                            "%u %lu %lu %lu %u %u %u %u\n",
1166                            MAJOR(part_devt(hd)), MINOR(part_devt(hd)),
1167                            disk_name(gp, hd->partno, buf),
1168                            part_stat_read(hd, ios[READ]),
1169                            part_stat_read(hd, merges[READ]),
1170                            part_stat_read(hd, sectors[READ]),
1171                            jiffies_to_msecs(part_stat_read(hd, ticks[READ])),
1172                            part_stat_read(hd, ios[WRITE]),
1173                            part_stat_read(hd, merges[WRITE]),
1174                            part_stat_read(hd, sectors[WRITE]),
1175                            jiffies_to_msecs(part_stat_read(hd, ticks[WRITE])),
1176                            part_in_flight(hd),
1177                            jiffies_to_msecs(part_stat_read(hd, io_ticks)),
1178                            jiffies_to_msecs(part_stat_read(hd, time_in_queue))
1179                         );
1180         }
1181         disk_part_iter_exit(&piter);
1182
1183         return 0;
1184 }
1185
1186 static const struct seq_operations diskstats_op = {
1187         .start  = disk_seqf_start,
1188         .next   = disk_seqf_next,
1189         .stop   = disk_seqf_stop,
1190         .show   = diskstats_show
1191 };
1192
1193 static int diskstats_open(struct inode *inode, struct file *file)
1194 {
1195         return seq_open(file, &diskstats_op);
1196 }
1197
1198 static const struct file_operations proc_diskstats_operations = {
1199         .open           = diskstats_open,
1200         .read           = seq_read,
1201         .llseek         = seq_lseek,
1202         .release        = seq_release,
1203 };
1204
1205 static int __init proc_genhd_init(void)
1206 {
1207         proc_create("diskstats", 0, NULL, &proc_diskstats_operations);
1208         proc_create("partitions", 0, NULL, &proc_partitions_operations);
1209         return 0;
1210 }
1211 module_init(proc_genhd_init);
1212 #endif /* CONFIG_PROC_FS */
1213
1214 dev_t blk_lookup_devt(const char *name, int partno)
1215 {
1216         dev_t devt = MKDEV(0, 0);
1217         struct class_dev_iter iter;
1218         struct device *dev;
1219
1220         class_dev_iter_init(&iter, &block_class, NULL, &disk_type);
1221         while ((dev = class_dev_iter_next(&iter))) {
1222                 struct gendisk *disk = dev_to_disk(dev);
1223                 struct hd_struct *part;
1224
1225                 if (strcmp(dev_name(dev), name))
1226                         continue;
1227
1228                 if (partno < disk->minors) {
1229                         /* We need to return the right devno, even
1230                          * if the partition doesn't exist yet.
1231                          */
1232                         devt = MKDEV(MAJOR(dev->devt),
1233                                      MINOR(dev->devt) + partno);
1234                         break;
1235                 }
1236                 part = disk_get_part(disk, partno);
1237                 if (part) {
1238                         devt = part_devt(part);
1239                         disk_put_part(part);
1240                         break;
1241                 }
1242                 disk_put_part(part);
1243         }
1244         class_dev_iter_exit(&iter);
1245         return devt;
1246 }
1247 EXPORT_SYMBOL(blk_lookup_devt);
1248
1249 struct gendisk *alloc_disk(int minors)
1250 {
1251         return alloc_disk_node(minors, NUMA_NO_NODE);
1252 }
1253 EXPORT_SYMBOL(alloc_disk);
1254
1255 struct gendisk *alloc_disk_node(int minors, int node_id)
1256 {
1257         struct gendisk *disk;
1258
1259         disk = kzalloc_node(sizeof(struct gendisk), GFP_KERNEL, node_id);
1260         if (disk) {
1261                 if (!init_part_stats(&disk->part0)) {
1262                         kfree(disk);
1263                         return NULL;
1264                 }
1265                 disk->node_id = node_id;
1266                 if (disk_expand_part_tbl(disk, 0)) {
1267                         free_part_stats(&disk->part0);
1268                         kfree(disk);
1269                         return NULL;
1270                 }
1271                 disk->part_tbl->part[0] = &disk->part0;
1272
1273                 /*
1274                  * set_capacity() and get_capacity() currently don't use
1275                  * seqcounter to read/update the part0->nr_sects. Still init
1276                  * the counter as we can read the sectors in IO submission
1277                  * patch using seqence counters.
1278                  *
1279                  * TODO: Ideally set_capacity() and get_capacity() should be
1280                  * converted to make use of bd_mutex and sequence counters.
1281                  */
1282                 seqcount_init(&disk->part0.nr_sects_seq);
1283                 hd_ref_init(&disk->part0);
1284
1285                 disk->minors = minors;
1286                 rand_initialize_disk(disk);
1287                 disk_to_dev(disk)->class = &block_class;
1288                 disk_to_dev(disk)->type = &disk_type;
1289                 device_initialize(disk_to_dev(disk));
1290         }
1291         return disk;
1292 }
1293 EXPORT_SYMBOL(alloc_disk_node);
1294
1295 struct kobject *get_disk(struct gendisk *disk)
1296 {
1297         struct module *owner;
1298         struct kobject *kobj;
1299
1300         if (!disk->fops)
1301                 return NULL;
1302         owner = disk->fops->owner;
1303         if (owner && !try_module_get(owner))
1304                 return NULL;
1305         kobj = kobject_get(&disk_to_dev(disk)->kobj);
1306         if (kobj == NULL) {
1307                 module_put(owner);
1308                 return NULL;
1309         }
1310         return kobj;
1311
1312 }
1313
1314 EXPORT_SYMBOL(get_disk);
1315
1316 void put_disk(struct gendisk *disk)
1317 {
1318         if (disk)
1319                 kobject_put(&disk_to_dev(disk)->kobj);
1320 }
1321
1322 EXPORT_SYMBOL(put_disk);
1323
1324 static void set_disk_ro_uevent(struct gendisk *gd, int ro)
1325 {
1326         char event[] = "DISK_RO=1";
1327         char *envp[] = { event, NULL };
1328
1329         if (!ro)
1330                 event[8] = '0';
1331         kobject_uevent_env(&disk_to_dev(gd)->kobj, KOBJ_CHANGE, envp);
1332 }
1333
1334 void set_device_ro(struct block_device *bdev, int flag)
1335 {
1336         bdev->bd_part->policy = flag;
1337 }
1338
1339 EXPORT_SYMBOL(set_device_ro);
1340
1341 void set_disk_ro(struct gendisk *disk, int flag)
1342 {
1343         struct disk_part_iter piter;
1344         struct hd_struct *part;
1345
1346         if (disk->part0.policy != flag) {
1347                 set_disk_ro_uevent(disk, flag);
1348                 disk->part0.policy = flag;
1349         }
1350
1351         disk_part_iter_init(&piter, disk, DISK_PITER_INCL_EMPTY);
1352         while ((part = disk_part_iter_next(&piter)))
1353                 part->policy = flag;
1354         disk_part_iter_exit(&piter);
1355 }
1356
1357 EXPORT_SYMBOL(set_disk_ro);
1358
1359 int bdev_read_only(struct block_device *bdev)
1360 {
1361         if (!bdev)
1362                 return 0;
1363         return bdev->bd_part->policy;
1364 }
1365
1366 EXPORT_SYMBOL(bdev_read_only);
1367
1368 int invalidate_partition(struct gendisk *disk, int partno)
1369 {
1370         int res = 0;
1371         struct block_device *bdev = bdget_disk(disk, partno);
1372         if (bdev) {
1373                 fsync_bdev(bdev);
1374                 res = __invalidate_device(bdev, true);
1375                 bdput(bdev);
1376         }
1377         return res;
1378 }
1379
1380 EXPORT_SYMBOL(invalidate_partition);
1381
1382 /*
1383  * Disk events - monitor disk events like media change and eject request.
1384  */
1385 struct disk_events {
1386         struct list_head        node;           /* all disk_event's */
1387         struct gendisk          *disk;          /* the associated disk */
1388         spinlock_t              lock;
1389
1390         struct mutex            block_mutex;    /* protects blocking */
1391         int                     block;          /* event blocking depth */
1392         unsigned int            pending;        /* events already sent out */
1393         unsigned int            clearing;       /* events being cleared */
1394
1395         long                    poll_msecs;     /* interval, -1 for default */
1396         struct delayed_work     dwork;
1397 };
1398
1399 static const char *disk_events_strs[] = {
1400         [ilog2(DISK_EVENT_MEDIA_CHANGE)]        = "media_change",
1401         [ilog2(DISK_EVENT_EJECT_REQUEST)]       = "eject_request",
1402 };
1403
1404 static char *disk_uevents[] = {
1405         [ilog2(DISK_EVENT_MEDIA_CHANGE)]        = "DISK_MEDIA_CHANGE=1",
1406         [ilog2(DISK_EVENT_EJECT_REQUEST)]       = "DISK_EJECT_REQUEST=1",
1407 };
1408
1409 /* list of all disk_events */
1410 static DEFINE_MUTEX(disk_events_mutex);
1411 static LIST_HEAD(disk_events);
1412
1413 /* disable in-kernel polling by default */
1414 static unsigned long disk_events_dfl_poll_msecs = 0;
1415
1416 static unsigned long disk_events_poll_jiffies(struct gendisk *disk)
1417 {
1418         struct disk_events *ev = disk->ev;
1419         long intv_msecs = 0;
1420
1421         /*
1422          * If device-specific poll interval is set, always use it.  If
1423          * the default is being used, poll iff there are events which
1424          * can't be monitored asynchronously.
1425          */
1426         if (ev->poll_msecs >= 0)
1427                 intv_msecs = ev->poll_msecs;
1428         else if (disk->events & ~disk->async_events)
1429                 intv_msecs = disk_events_dfl_poll_msecs;
1430
1431         return msecs_to_jiffies(intv_msecs);
1432 }
1433
1434 /**
1435  * disk_block_events - block and flush disk event checking
1436  * @disk: disk to block events for
1437  *
1438  * On return from this function, it is guaranteed that event checking
1439  * isn't in progress and won't happen until unblocked by
1440  * disk_unblock_events().  Events blocking is counted and the actual
1441  * unblocking happens after the matching number of unblocks are done.
1442  *
1443  * Note that this intentionally does not block event checking from
1444  * disk_clear_events().
1445  *
1446  * CONTEXT:
1447  * Might sleep.
1448  */
1449 void disk_block_events(struct gendisk *disk)
1450 {
1451         struct disk_events *ev = disk->ev;
1452         unsigned long flags;
1453         bool cancel;
1454
1455         if (!ev)
1456                 return;
1457
1458         /*
1459          * Outer mutex ensures that the first blocker completes canceling
1460          * the event work before further blockers are allowed to finish.
1461          */
1462         mutex_lock(&ev->block_mutex);
1463
1464         spin_lock_irqsave(&ev->lock, flags);
1465         cancel = !ev->block++;
1466         spin_unlock_irqrestore(&ev->lock, flags);
1467
1468         if (cancel)
1469                 cancel_delayed_work_sync(&disk->ev->dwork);
1470
1471         mutex_unlock(&ev->block_mutex);
1472 }
1473
1474 static void __disk_unblock_events(struct gendisk *disk, bool check_now)
1475 {
1476         struct disk_events *ev = disk->ev;
1477         unsigned long intv;
1478         unsigned long flags;
1479
1480         spin_lock_irqsave(&ev->lock, flags);
1481
1482         if (WARN_ON_ONCE(ev->block <= 0))
1483                 goto out_unlock;
1484
1485         if (--ev->block)
1486                 goto out_unlock;
1487
1488         /*
1489          * Not exactly a latency critical operation, set poll timer
1490          * slack to 25% and kick event check.
1491          */
1492         intv = disk_events_poll_jiffies(disk);
1493         set_timer_slack(&ev->dwork.timer, intv / 4);
1494         if (check_now)
1495                 queue_delayed_work(system_freezable_power_efficient_wq,
1496                                 &ev->dwork, 0);
1497         else if (intv)
1498                 queue_delayed_work(system_freezable_power_efficient_wq,
1499                                 &ev->dwork, intv);
1500 out_unlock:
1501         spin_unlock_irqrestore(&ev->lock, flags);
1502 }
1503
1504 /**
1505  * disk_unblock_events - unblock disk event checking
1506  * @disk: disk to unblock events for
1507  *
1508  * Undo disk_block_events().  When the block count reaches zero, it
1509  * starts events polling if configured.
1510  *
1511  * CONTEXT:
1512  * Don't care.  Safe to call from irq context.
1513  */
1514 void disk_unblock_events(struct gendisk *disk)
1515 {
1516         if (disk->ev)
1517                 __disk_unblock_events(disk, false);
1518 }
1519
1520 /**
1521  * disk_flush_events - schedule immediate event checking and flushing
1522  * @disk: disk to check and flush events for
1523  * @mask: events to flush
1524  *
1525  * Schedule immediate event checking on @disk if not blocked.  Events in
1526  * @mask are scheduled to be cleared from the driver.  Note that this
1527  * doesn't clear the events from @disk->ev.
1528  *
1529  * CONTEXT:
1530  * If @mask is non-zero must be called with bdev->bd_mutex held.
1531  */
1532 void disk_flush_events(struct gendisk *disk, unsigned int mask)
1533 {
1534         struct disk_events *ev = disk->ev;
1535
1536         if (!ev)
1537                 return;
1538
1539         spin_lock_irq(&ev->lock);
1540         ev->clearing |= mask;
1541         if (!ev->block)
1542                 mod_delayed_work(system_freezable_power_efficient_wq,
1543                                 &ev->dwork, 0);
1544         spin_unlock_irq(&ev->lock);
1545 }
1546
1547 /**
1548  * disk_clear_events - synchronously check, clear and return pending events
1549  * @disk: disk to fetch and clear events from
1550  * @mask: mask of events to be fetched and clearted
1551  *
1552  * Disk events are synchronously checked and pending events in @mask
1553  * are cleared and returned.  This ignores the block count.
1554  *
1555  * CONTEXT:
1556  * Might sleep.
1557  */
1558 unsigned int disk_clear_events(struct gendisk *disk, unsigned int mask)
1559 {
1560         const struct block_device_operations *bdops = disk->fops;
1561         struct disk_events *ev = disk->ev;
1562         unsigned int pending;
1563         unsigned int clearing = mask;
1564
1565         if (!ev) {
1566                 /* for drivers still using the old ->media_changed method */
1567                 if ((mask & DISK_EVENT_MEDIA_CHANGE) &&
1568                     bdops->media_changed && bdops->media_changed(disk))
1569                         return DISK_EVENT_MEDIA_CHANGE;
1570                 return 0;
1571         }
1572
1573         disk_block_events(disk);
1574
1575         /*
1576          * store the union of mask and ev->clearing on the stack so that the
1577          * race with disk_flush_events does not cause ambiguity (ev->clearing
1578          * can still be modified even if events are blocked).
1579          */
1580         spin_lock_irq(&ev->lock);
1581         clearing |= ev->clearing;
1582         ev->clearing = 0;
1583         spin_unlock_irq(&ev->lock);
1584
1585         disk_check_events(ev, &clearing);
1586         /*
1587          * if ev->clearing is not 0, the disk_flush_events got called in the
1588          * middle of this function, so we want to run the workfn without delay.
1589          */
1590         __disk_unblock_events(disk, ev->clearing ? true : false);
1591
1592         /* then, fetch and clear pending events */
1593         spin_lock_irq(&ev->lock);
1594         pending = ev->pending & mask;
1595         ev->pending &= ~mask;
1596         spin_unlock_irq(&ev->lock);
1597         WARN_ON_ONCE(clearing & mask);
1598
1599         return pending;
1600 }
1601
1602 /*
1603  * Separate this part out so that a different pointer for clearing_ptr can be
1604  * passed in for disk_clear_events.
1605  */
1606 static void disk_events_workfn(struct work_struct *work)
1607 {
1608         struct delayed_work *dwork = to_delayed_work(work);
1609         struct disk_events *ev = container_of(dwork, struct disk_events, dwork);
1610
1611         disk_check_events(ev, &ev->clearing);
1612 }
1613
1614 static void disk_check_events(struct disk_events *ev,
1615                               unsigned int *clearing_ptr)
1616 {
1617         struct gendisk *disk = ev->disk;
1618         char *envp[ARRAY_SIZE(disk_uevents) + 1] = { };
1619         unsigned int clearing = *clearing_ptr;
1620         unsigned int events;
1621         unsigned long intv;
1622         int nr_events = 0, i;
1623
1624         /* check events */
1625         events = disk->fops->check_events(disk, clearing);
1626
1627         /* accumulate pending events and schedule next poll if necessary */
1628         spin_lock_irq(&ev->lock);
1629
1630         events &= ~ev->pending;
1631         ev->pending |= events;
1632         *clearing_ptr &= ~clearing;
1633
1634         intv = disk_events_poll_jiffies(disk);
1635         if (!ev->block && intv)
1636                 queue_delayed_work(system_freezable_power_efficient_wq,
1637                                 &ev->dwork, intv);
1638
1639         spin_unlock_irq(&ev->lock);
1640
1641         /*
1642          * Tell userland about new events.  Only the events listed in
1643          * @disk->events are reported.  Unlisted events are processed the
1644          * same internally but never get reported to userland.
1645          */
1646         for (i = 0; i < ARRAY_SIZE(disk_uevents); i++)
1647                 if (events & disk->events & (1 << i))
1648                         envp[nr_events++] = disk_uevents[i];
1649
1650         if (nr_events)
1651                 kobject_uevent_env(&disk_to_dev(disk)->kobj, KOBJ_CHANGE, envp);
1652 }
1653
1654 /*
1655  * A disk events enabled device has the following sysfs nodes under
1656  * its /sys/block/X/ directory.
1657  *
1658  * events               : list of all supported events
1659  * events_async         : list of events which can be detected w/o polling
1660  * events_poll_msecs    : polling interval, 0: disable, -1: system default
1661  */
1662 static ssize_t __disk_events_show(unsigned int events, char *buf)
1663 {
1664         const char *delim = "";
1665         ssize_t pos = 0;
1666         int i;
1667
1668         for (i = 0; i < ARRAY_SIZE(disk_events_strs); i++)
1669                 if (events & (1 << i)) {
1670                         pos += sprintf(buf + pos, "%s%s",
1671                                        delim, disk_events_strs[i]);
1672                         delim = " ";
1673                 }
1674         if (pos)
1675                 pos += sprintf(buf + pos, "\n");
1676         return pos;
1677 }
1678
1679 static ssize_t disk_events_show(struct device *dev,
1680                                 struct device_attribute *attr, char *buf)
1681 {
1682         struct gendisk *disk = dev_to_disk(dev);
1683
1684         return __disk_events_show(disk->events, buf);
1685 }
1686
1687 static ssize_t disk_events_async_show(struct device *dev,
1688                                       struct device_attribute *attr, char *buf)
1689 {
1690         struct gendisk *disk = dev_to_disk(dev);
1691
1692         return __disk_events_show(disk->async_events, buf);
1693 }
1694
1695 static ssize_t disk_events_poll_msecs_show(struct device *dev,
1696                                            struct device_attribute *attr,
1697                                            char *buf)
1698 {
1699         struct gendisk *disk = dev_to_disk(dev);
1700
1701         return sprintf(buf, "%ld\n", disk->ev->poll_msecs);
1702 }
1703
1704 static ssize_t disk_events_poll_msecs_store(struct device *dev,
1705                                             struct device_attribute *attr,
1706                                             const char *buf, size_t count)
1707 {
1708         struct gendisk *disk = dev_to_disk(dev);
1709         long intv;
1710
1711         if (!count || !sscanf(buf, "%ld", &intv))
1712                 return -EINVAL;
1713
1714         if (intv < 0 && intv != -1)
1715                 return -EINVAL;
1716
1717         disk_block_events(disk);
1718         disk->ev->poll_msecs = intv;
1719         __disk_unblock_events(disk, true);
1720
1721         return count;
1722 }
1723
1724 static const DEVICE_ATTR(events, S_IRUGO, disk_events_show, NULL);
1725 static const DEVICE_ATTR(events_async, S_IRUGO, disk_events_async_show, NULL);
1726 static const DEVICE_ATTR(events_poll_msecs, S_IRUGO|S_IWUSR,
1727                          disk_events_poll_msecs_show,
1728                          disk_events_poll_msecs_store);
1729
1730 static const struct attribute *disk_events_attrs[] = {
1731         &dev_attr_events.attr,
1732         &dev_attr_events_async.attr,
1733         &dev_attr_events_poll_msecs.attr,
1734         NULL,
1735 };
1736
1737 /*
1738  * The default polling interval can be specified by the kernel
1739  * parameter block.events_dfl_poll_msecs which defaults to 0
1740  * (disable).  This can also be modified runtime by writing to
1741  * /sys/module/block/events_dfl_poll_msecs.
1742  */
1743 static int disk_events_set_dfl_poll_msecs(const char *val,
1744                                           const struct kernel_param *kp)
1745 {
1746         struct disk_events *ev;
1747         int ret;
1748
1749         ret = param_set_ulong(val, kp);
1750         if (ret < 0)
1751                 return ret;
1752
1753         mutex_lock(&disk_events_mutex);
1754
1755         list_for_each_entry(ev, &disk_events, node)
1756                 disk_flush_events(ev->disk, 0);
1757
1758         mutex_unlock(&disk_events_mutex);
1759
1760         return 0;
1761 }
1762
1763 static const struct kernel_param_ops disk_events_dfl_poll_msecs_param_ops = {
1764         .set    = disk_events_set_dfl_poll_msecs,
1765         .get    = param_get_ulong,
1766 };
1767
1768 #undef MODULE_PARAM_PREFIX
1769 #define MODULE_PARAM_PREFIX     "block."
1770
1771 module_param_cb(events_dfl_poll_msecs, &disk_events_dfl_poll_msecs_param_ops,
1772                 &disk_events_dfl_poll_msecs, 0644);
1773
1774 /*
1775  * disk_{alloc|add|del|release}_events - initialize and destroy disk_events.
1776  */
1777 static void disk_alloc_events(struct gendisk *disk)
1778 {
1779         struct disk_events *ev;
1780
1781         if (!disk->fops->check_events)
1782                 return;
1783
1784         ev = kzalloc(sizeof(*ev), GFP_KERNEL);
1785         if (!ev) {
1786                 pr_warn("%s: failed to initialize events\n", disk->disk_name);
1787                 return;
1788         }
1789
1790         INIT_LIST_HEAD(&ev->node);
1791         ev->disk = disk;
1792         spin_lock_init(&ev->lock);
1793         mutex_init(&ev->block_mutex);
1794         ev->block = 1;
1795         ev->poll_msecs = -1;
1796         INIT_DELAYED_WORK(&ev->dwork, disk_events_workfn);
1797
1798         disk->ev = ev;
1799 }
1800
1801 static void disk_add_events(struct gendisk *disk)
1802 {
1803         if (!disk->ev)
1804                 return;
1805
1806         /* FIXME: error handling */
1807         if (sysfs_create_files(&disk_to_dev(disk)->kobj, disk_events_attrs) < 0)
1808                 pr_warn("%s: failed to create sysfs files for events\n",
1809                         disk->disk_name);
1810
1811         mutex_lock(&disk_events_mutex);
1812         list_add_tail(&disk->ev->node, &disk_events);
1813         mutex_unlock(&disk_events_mutex);
1814
1815         /*
1816          * Block count is initialized to 1 and the following initial
1817          * unblock kicks it into action.
1818          */
1819         __disk_unblock_events(disk, true);
1820 }
1821
1822 static void disk_del_events(struct gendisk *disk)
1823 {
1824         if (!disk->ev)
1825                 return;
1826
1827         disk_block_events(disk);
1828
1829         mutex_lock(&disk_events_mutex);
1830         list_del_init(&disk->ev->node);
1831         mutex_unlock(&disk_events_mutex);
1832
1833         sysfs_remove_files(&disk_to_dev(disk)->kobj, disk_events_attrs);
1834 }
1835
1836 static void disk_release_events(struct gendisk *disk)
1837 {
1838         /* the block count should be 1 from disk_del_events() */
1839         WARN_ON_ONCE(disk->ev && disk->ev->block != 1);
1840         kfree(disk->ev);
1841 }