Pileus Git - ~andy/linux/blob - 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 MAX_EXT_DEVT            (1 << MINORBITS)
  30
  31 /* For extended devt allocation.  ext_devt_mutex prevents look up
  32  * results from going away underneath its user.
  33  */
  34 static DEFINE_MUTEX(ext_devt_mutex);
  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, rc;
 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         do {
 424                 if (!idr_pre_get(&ext_devt_idr, GFP_KERNEL))
 425                         return -ENOMEM;
 426                 rc = idr_get_new(&ext_devt_idr, part, &idx);
 427         } while (rc == -EAGAIN);
 428
 429         if (rc)
 430                 return rc;
 431
 432         if (idx > MAX_EXT_DEVT) {
 433                 idr_remove(&ext_devt_idr, idx);
 434                 return -EBUSY;
 435         }
 436
 437         *devt = MKDEV(BLOCK_EXT_MAJOR, blk_mangle_minor(idx));
 438         return 0;
 439 }
 440
 441 /**
 442  * blk_free_devt - free a dev_t
 443  * @devt: dev_t to free
 444  *
 445  * Free @devt which was allocated using blk_alloc_devt().
 446  *
 447  * CONTEXT:
 448  * Might sleep.
 449  */
 450 void blk_free_devt(dev_t devt)
 451 {
 452         might_sleep();
 453
 454         if (devt == MKDEV(0, 0))
 455                 return;
 456
 457         if (MAJOR(devt) == BLOCK_EXT_MAJOR) {
 458                 mutex_lock(&ext_devt_mutex);
 459                 idr_remove(&ext_devt_idr, blk_mangle_minor(MINOR(devt)));
 460                 mutex_unlock(&ext_devt_mutex);
 461         }
 462 }
 463
 464 static char *bdevt_str(dev_t devt, char *buf)
 465 {
 466         if (MAJOR(devt) <= 0xff && MINOR(devt) <= 0xff) {
 467                 char tbuf[BDEVT_SIZE];
 468                 snprintf(tbuf, BDEVT_SIZE, "%02x%02x", MAJOR(devt), MINOR(devt));
 469                 snprintf(buf, BDEVT_SIZE, "%-9s", tbuf);
 470         } else
 471                 snprintf(buf, BDEVT_SIZE, "%03x:%05x", MAJOR(devt), MINOR(devt));
 472
 473         return buf;
 474 }
 475
 476 /*
 477  * Register device numbers dev..(dev+range-1)
 478  * range must be nonzero
 479  * The hash chain is sorted on range, so that subranges can override.
 480  */
 481 void blk_register_region(dev_t devt, unsigned long range, struct module *module,
 482                          struct kobject *(*probe)(dev_t, int *, void *),
 483                          int (*lock)(dev_t, void *), void *data)
 484 {
 485         kobj_map(bdev_map, devt, range, module, probe, lock, data);
 486 }
 487
 488 EXPORT_SYMBOL(blk_register_region);
 489
 490 void blk_unregister_region(dev_t devt, unsigned long range)
 491 {
 492         kobj_unmap(bdev_map, devt, range);
 493 }
 494
 495 EXPORT_SYMBOL(blk_unregister_region);
 496
 497 static struct kobject *exact_match(dev_t devt, int *partno, void *data)
 498 {
 499         struct gendisk *p = data;
 500
 501         return &disk_to_dev(p)->kobj;
 502 }
 503
 504 static int exact_lock(dev_t devt, void *data)
 505 {
 506         struct gendisk *p = data;
 507
 508         if (!get_disk(p))
 509                 return -1;
 510         return 0;
 511 }
 512
 513 static void register_disk(struct gendisk *disk)
 514 {
 515         struct device *ddev = disk_to_dev(disk);
 516         struct block_device *bdev;
 517         struct disk_part_iter piter;
 518         struct hd_struct *part;
 519         int err;
 520
 521         ddev->parent = disk->driverfs_dev;
 522
 523         dev_set_name(ddev, disk->disk_name);
 524
 525         /* delay uevents, until we scanned partition table */
 526         dev_set_uevent_suppress(ddev, 1);
 527
 528         if (device_add(ddev))
 529                 return;
 530         if (!sysfs_deprecated) {
 531                 err = sysfs_create_link(block_depr, &ddev->kobj,
 532                                         kobject_name(&ddev->kobj));
 533                 if (err) {
 534                         device_del(ddev);
 535                         return;
 536                 }
 537         }
 538
 539         /*
 540          * avoid probable deadlock caused by allocating memory with
 541          * GFP_KERNEL in runtime_resume callback of its all ancestor
 542          * devices
 543          */
 544         pm_runtime_set_memalloc_noio(ddev, true);
 545
 546         disk->part0.holder_dir = kobject_create_and_add("holders", &ddev->kobj);
 547         disk->slave_dir = kobject_create_and_add("slaves", &ddev->kobj);
 548
 549         /* No minors to use for partitions */
 550         if (!disk_part_scan_enabled(disk))
 551                 goto exit;
 552
 553         /* No such device (e.g., media were just removed) */
 554         if (!get_capacity(disk))
 555                 goto exit;
 556
 557         bdev = bdget_disk(disk, 0);
 558         if (!bdev)
 559                 goto exit;
 560
 561         bdev->bd_invalidated = 1;
 562         err = blkdev_get(bdev, FMODE_READ, NULL);
 563         if (err < 0)
 564                 goto exit;
 565         blkdev_put(bdev, FMODE_READ);
 566
 567 exit:
 568         /* announce disk after possible partitions are created */
 569         dev_set_uevent_suppress(ddev, 0);
 570         kobject_uevent(&ddev->kobj, KOBJ_ADD);
 571
 572         /* announce possible partitions */
 573         disk_part_iter_init(&piter, disk, 0);
 574         while ((part = disk_part_iter_next(&piter)))
 575                 kobject_uevent(&part_to_dev(part)->kobj, KOBJ_ADD);
 576         disk_part_iter_exit(&piter);
 577 }
 578
 579 /**
 580  * add_disk - add partitioning information to kernel list
 581  * @disk: per-device partitioning information
 582  *
 583  * This function registers the partitioning information in @disk
 584  * with the kernel.
 585  *
 586  * FIXME: error handling
 587  */
 588 void add_disk(struct gendisk *disk)
 589 {
 590         struct backing_dev_info *bdi;
 591         dev_t devt;
 592         int retval;
 593
 594         /* minors == 0 indicates to use ext devt from part0 and should
 595          * be accompanied with EXT_DEVT flag.  Make sure all
 596          * parameters make sense.
 597          */
 598         WARN_ON(disk->minors && !(disk->major || disk->first_minor));
 599         WARN_ON(!disk->minors && !(disk->flags & GENHD_FL_EXT_DEVT));
 600
 601         disk->flags |= GENHD_FL_UP;
 602
 603         retval = blk_alloc_devt(&disk->part0, &devt);
 604         if (retval) {
 605                 WARN_ON(1);
 606                 return;
 607         }
 608         disk_to_dev(disk)->devt = devt;
 609
 610         /* ->major and ->first_minor aren't supposed to be
 611          * dereferenced from here on, but set them just in case.
 612          */
 613         disk->major = MAJOR(devt);
 614         disk->first_minor = MINOR(devt);
 615
 616         disk_alloc_events(disk);
 617
 618         /* Register BDI before referencing it from bdev */
 619         bdi = &disk->queue->backing_dev_info;
 620         bdi_register_dev(bdi, disk_devt(disk));
 621
 622         blk_register_region(disk_devt(disk), disk->minors, NULL,
 623                             exact_match, exact_lock, disk);
 624         register_disk(disk);
 625         blk_register_queue(disk);
 626
 627         /*
 628          * Take an extra ref on queue which will be put on disk_release()
 629          * so that it sticks around as long as @disk is there.
 630          */
 631         WARN_ON_ONCE(!blk_get_queue(disk->queue));
 632
 633         retval = sysfs_create_link(&disk_to_dev(disk)->kobj, &bdi->dev->kobj,
 634                                    "bdi");
 635         WARN_ON(retval);
 636
 637         disk_add_events(disk);
 638 }
 639 EXPORT_SYMBOL(add_disk);
 640
 641 void del_gendisk(struct gendisk *disk)
 642 {
 643         struct disk_part_iter piter;
 644         struct hd_struct *part;
 645
 646         disk_del_events(disk);
 647
 648         /* invalidate stuff */
 649         disk_part_iter_init(&piter, disk,
 650                              DISK_PITER_INCL_EMPTY | DISK_PITER_REVERSE);
 651         while ((part = disk_part_iter_next(&piter))) {
 652                 invalidate_partition(disk, part->partno);
 653                 delete_partition(disk, part->partno);
 654         }
 655         disk_part_iter_exit(&piter);
 656
 657         invalidate_partition(disk, 0);
 658         blk_free_devt(disk_to_dev(disk)->devt);
 659         set_capacity(disk, 0);
 660         disk->flags &= ~GENHD_FL_UP;
 661
 662         sysfs_remove_link(&disk_to_dev(disk)->kobj, "bdi");
 663         bdi_unregister(&disk->queue->backing_dev_info);
 664         blk_unregister_queue(disk);
 665         blk_unregister_region(disk_devt(disk), disk->minors);
 666
 667         part_stat_set_all(&disk->part0, 0);
 668         disk->part0.stamp = 0;
 669
 670         kobject_put(disk->part0.holder_dir);
 671         kobject_put(disk->slave_dir);
 672         disk->driverfs_dev = NULL;
 673         if (!sysfs_deprecated)
 674                 sysfs_remove_link(block_depr, dev_name(disk_to_dev(disk)));
 675         pm_runtime_set_memalloc_noio(disk_to_dev(disk), false);
 676         device_del(disk_to_dev(disk));
 677 }
 678 EXPORT_SYMBOL(del_gendisk);
 679
 680 /**
 681  * get_gendisk - get partitioning information for a given device
 682  * @devt: device to get partitioning information for
 683  * @partno: returned partition index
 684  *
 685  * This function gets the structure containing partitioning
 686  * information for the given device @devt.
 687  */
 688 struct gendisk *get_gendisk(dev_t devt, int *partno)
 689 {
 690         struct gendisk *disk = NULL;
 691
 692         if (MAJOR(devt) != BLOCK_EXT_MAJOR) {
 693                 struct kobject *kobj;
 694
 695                 kobj = kobj_lookup(bdev_map, devt, partno);
 696                 if (kobj)
 697                         disk = dev_to_disk(kobj_to_dev(kobj));
 698         } else {
 699                 struct hd_struct *part;
 700
 701                 mutex_lock(&ext_devt_mutex);
 702                 part = idr_find(&ext_devt_idr, blk_mangle_minor(MINOR(devt)));
 703                 if (part && get_disk(part_to_disk(part))) {
 704                         *partno = part->partno;
 705                         disk = part_to_disk(part);
 706                 }
 707                 mutex_unlock(&ext_devt_mutex);
 708         }
 709
 710         return disk;
 711 }
 712 EXPORT_SYMBOL(get_gendisk);
 713
 714 /**
 715  * bdget_disk - do bdget() by gendisk and partition number
 716  * @disk: gendisk of interest
 717  * @partno: partition number
 718  *
 719  * Find partition @partno from @disk, do bdget() on it.
 720  *
 721  * CONTEXT:
 722  * Don't care.
 723  *
 724  * RETURNS:
 725  * Resulting block_device on success, NULL on failure.
 726  */
 727 struct block_device *bdget_disk(struct gendisk *disk, int partno)
 728 {
 729         struct hd_struct *part;
 730         struct block_device *bdev = NULL;
 731
 732         part = disk_get_part(disk, partno);
 733         if (part)
 734                 bdev = bdget(part_devt(part));
 735         disk_put_part(part);
 736
 737         return bdev;
 738 }
 739 EXPORT_SYMBOL(bdget_disk);
 740
 741 /*
 742  * print a full list of all partitions - intended for places where the root
 743  * filesystem can't be mounted and thus to give the victim some idea of what
 744  * went wrong
 745  */
 746 void __init printk_all_partitions(void)
 747 {
 748         struct class_dev_iter iter;
 749         struct device *dev;
 750
 751         class_dev_iter_init(&iter, &block_class, NULL, &disk_type);
 752         while ((dev = class_dev_iter_next(&iter))) {
 753                 struct gendisk *disk = dev_to_disk(dev);
 754                 struct disk_part_iter piter;
 755                 struct hd_struct *part;
 756                 char name_buf[BDEVNAME_SIZE];
 757                 char devt_buf[BDEVT_SIZE];
 758
 759                 /*
 760                  * Don't show empty devices or things that have been
 761                  * suppressed
 762                  */
 763                 if (get_capacity(disk) == 0 ||
 764                     (disk->flags & GENHD_FL_SUPPRESS_PARTITION_INFO))
 765                         continue;
 766
 767                 /*
 768                  * Note, unlike /proc/partitions, I am showing the
 769                  * numbers in hex - the same format as the root=
 770                  * option takes.
 771                  */
 772                 disk_part_iter_init(&piter, disk, DISK_PITER_INCL_PART0);
 773                 while ((part = disk_part_iter_next(&piter))) {
 774                         bool is_part0 = part == &disk->part0;
 775
 776                         printk("%s%s %10llu %s %s", is_part0 ? "" : "  ",
 777                                bdevt_str(part_devt(part), devt_buf),
 778                                (unsigned long long)part_nr_sects_read(part) >> 1
 779                                , disk_name(disk, part->partno, name_buf),
 780                                part->info ? part->info->uuid : "");
 781                         if (is_part0) {
 782                                 if (disk->driverfs_dev != NULL &&
 783                                     disk->driverfs_dev->driver != NULL)
 784                                         printk(" driver: %s\n",
 785                                               disk->driverfs_dev->driver->name);
 786                                 else
 787                                         printk(" (driver?)\n");
 788                         } else
 789                                 printk("\n");
 790                 }
 791                 disk_part_iter_exit(&piter);
 792         }
 793         class_dev_iter_exit(&iter);
 794 }
 795
 796 #ifdef CONFIG_PROC_FS
 797 /* iterator */
 798 static void *disk_seqf_start(struct seq_file *seqf, loff_t *pos)
 799 {
 800         loff_t skip = *pos;
 801         struct class_dev_iter *iter;
 802         struct device *dev;
 803
 804         iter = kmalloc(sizeof(*iter), GFP_KERNEL);
 805         if (!iter)
 806                 return ERR_PTR(-ENOMEM);
 807
 808         seqf->private = iter;
 809         class_dev_iter_init(iter, &block_class, NULL, &disk_type);
 810         do {
 811                 dev = class_dev_iter_next(iter);
 812                 if (!dev)
 813                         return NULL;
 814         } while (skip--);
 815
 816         return dev_to_disk(dev);
 817 }
 818
 819 static void *disk_seqf_next(struct seq_file *seqf, void *v, loff_t *pos)
 820 {
 821         struct device *dev;
 822
 823         (*pos)++;
 824         dev = class_dev_iter_next(seqf->private);
 825         if (dev)
 826                 return dev_to_disk(dev);
 827
 828         return NULL;
 829 }
 830
 831 static void disk_seqf_stop(struct seq_file *seqf, void *v)
 832 {
 833         struct class_dev_iter *iter = seqf->private;
 834
 835         /* stop is called even after start failed :-( */
 836         if (iter) {
 837                 class_dev_iter_exit(iter);
 838                 kfree(iter);
 839         }
 840 }
 841
 842 static void *show_partition_start(struct seq_file *seqf, loff_t *pos)
 843 {
 844         void *p;
 845
 846         p = disk_seqf_start(seqf, pos);
 847         if (!IS_ERR_OR_NULL(p) && !*pos)
 848                 seq_puts(seqf, "major minor  #blocks  name\n\n");
 849         return p;
 850 }
 851
 852 static int show_partition(struct seq_file *seqf, void *v)
 853 {
 854         struct gendisk *sgp = v;
 855         struct disk_part_iter piter;
 856         struct hd_struct *part;
 857         char buf[BDEVNAME_SIZE];
 858
 859         /* Don't show non-partitionable removeable devices or empty devices */
 860         if (!get_capacity(sgp) || (!disk_max_parts(sgp) &&
 861                                    (sgp->flags & GENHD_FL_REMOVABLE)))
 862                 return 0;
 863         if (sgp->flags & GENHD_FL_SUPPRESS_PARTITION_INFO)
 864                 return 0;
 865
 866         /* show the full disk and all non-0 size partitions of it */
 867         disk_part_iter_init(&piter, sgp, DISK_PITER_INCL_PART0);
 868         while ((part = disk_part_iter_next(&piter)))
 869                 seq_printf(seqf, "%4d  %7d %10llu %s\n",
 870                            MAJOR(part_devt(part)), MINOR(part_devt(part)),
 871                            (unsigned long long)part_nr_sects_read(part) >> 1,
 872                            disk_name(sgp, part->partno, buf));
 873         disk_part_iter_exit(&piter);
 874
 875         return 0;
 876 }
 877
 878 static const struct seq_operations partitions_op = {
 879         .start  = show_partition_start,
 880         .next   = disk_seqf_next,
 881         .stop   = disk_seqf_stop,
 882         .show   = show_partition
 883 };
 884
 885 static int partitions_open(struct inode *inode, struct file *file)
 886 {
 887         return seq_open(file, &partitions_op);
 888 }
 889
 890 static const struct file_operations proc_partitions_operations = {
 891         .open           = partitions_open,
 892         .read           = seq_read,
 893         .llseek         = seq_lseek,
 894         .release        = seq_release,
 895 };
 896 #endif
 897
 898
 899 static struct kobject *base_probe(dev_t devt, int *partno, void *data)
 900 {
 901         if (request_module("block-major-%d-%d", MAJOR(devt), MINOR(devt)) > 0)
 902                 /* Make old-style 2.4 aliases work */
 903                 request_module("block-major-%d", MAJOR(devt));
 904         return NULL;
 905 }
 906
 907 static int __init genhd_device_init(void)
 908 {
 909         int error;
 910
 911         block_class.dev_kobj = sysfs_dev_block_kobj;
 912         error = class_register(&block_class);
 913         if (unlikely(error))
 914                 return error;
 915         bdev_map = kobj_map_init(base_probe, &block_class_lock);
 916         blk_dev_init();
 917
 918         register_blkdev(BLOCK_EXT_MAJOR, "blkext");
 919
 920         /* create top-level block dir */
 921         if (!sysfs_deprecated)
 922                 block_depr = kobject_create_and_add("block", NULL);
 923         return 0;
 924 }
 925
 926 subsys_initcall(genhd_device_init);
 927
 928 static ssize_t disk_range_show(struct device *dev,
 929                                struct device_attribute *attr, char *buf)
 930 {
 931         struct gendisk *disk = dev_to_disk(dev);
 932
 933         return sprintf(buf, "%d\n", disk->minors);
 934 }
 935
 936 static ssize_t disk_ext_range_show(struct device *dev,
 937                                    struct device_attribute *attr, char *buf)
 938 {
 939         struct gendisk *disk = dev_to_disk(dev);
 940
 941         return sprintf(buf, "%d\n", disk_max_parts(disk));
 942 }
 943
 944 static ssize_t disk_removable_show(struct device *dev,
 945                                    struct device_attribute *attr, char *buf)
 946 {
 947         struct gendisk *disk = dev_to_disk(dev);
 948
 949         return sprintf(buf, "%d\n",
 950                        (disk->flags & GENHD_FL_REMOVABLE ? 1 : 0));
 951 }
 952
 953 static ssize_t disk_ro_show(struct device *dev,
 954                                    struct device_attribute *attr, char *buf)
 955 {
 956         struct gendisk *disk = dev_to_disk(dev);
 957
 958         return sprintf(buf, "%d\n", get_disk_ro(disk) ? 1 : 0);
 959 }
 960
 961 static ssize_t disk_capability_show(struct device *dev,
 962                                     struct device_attribute *attr, char *buf)
 963 {
 964         struct gendisk *disk = dev_to_disk(dev);
 965
 966         return sprintf(buf, "%x\n", disk->flags);
 967 }
 968
 969 static ssize_t disk_alignment_offset_show(struct device *dev,
 970                                           struct device_attribute *attr,
 971                                           char *buf)
 972 {
 973         struct gendisk *disk = dev_to_disk(dev);
 974
 975         return sprintf(buf, "%d\n", queue_alignment_offset(disk->queue));
 976 }
 977
 978 static ssize_t disk_discard_alignment_show(struct device *dev,
 979                                            struct device_attribute *attr,
 980                                            char *buf)
 981 {
 982         struct gendisk *disk = dev_to_disk(dev);
 983
 984         return sprintf(buf, "%d\n", queue_discard_alignment(disk->queue));
 985 }
 986
 987 static DEVICE_ATTR(range, S_IRUGO, disk_range_show, NULL);
 988 static DEVICE_ATTR(ext_range, S_IRUGO, disk_ext_range_show, NULL);
 989 static DEVICE_ATTR(removable, S_IRUGO, disk_removable_show, NULL);
 990 static DEVICE_ATTR(ro, S_IRUGO, disk_ro_show, NULL);
 991 static DEVICE_ATTR(size, S_IRUGO, part_size_show, NULL);
 992 static DEVICE_ATTR(alignment_offset, S_IRUGO, disk_alignment_offset_show, NULL);
 993 static DEVICE_ATTR(discard_alignment, S_IRUGO, disk_discard_alignment_show,
 994                    NULL);
 995 static DEVICE_ATTR(capability, S_IRUGO, disk_capability_show, NULL);
 996 static DEVICE_ATTR(stat, S_IRUGO, part_stat_show, NULL);
 997 static DEVICE_ATTR(inflight, S_IRUGO, part_inflight_show, NULL);
 998 #ifdef CONFIG_FAIL_MAKE_REQUEST
 999 static struct device_attribute dev_attr_fail =
1000         __ATTR(make-it-fail, S_IRUGO|S_IWUSR, part_fail_show, part_fail_store);
1001 #endif
1002 #ifdef CONFIG_FAIL_IO_TIMEOUT
1003 static struct device_attribute dev_attr_fail_timeout =
1004         __ATTR(io-timeout-fail,  S_IRUGO|S_IWUSR, part_timeout_show,
1005                 part_timeout_store);
1006 #endif
1007
1008 static struct attribute *disk_attrs[] = {
1009         &dev_attr_range.attr,
1010         &dev_attr_ext_range.attr,
1011         &dev_attr_removable.attr,
1012         &dev_attr_ro.attr,
1013         &dev_attr_size.attr,
1014         &dev_attr_alignment_offset.attr,
1015         &dev_attr_discard_alignment.attr,
1016         &dev_attr_capability.attr,
1017         &dev_attr_stat.attr,
1018         &dev_attr_inflight.attr,
1019 #ifdef CONFIG_FAIL_MAKE_REQUEST
1020         &dev_attr_fail.attr,
1021 #endif
1022 #ifdef CONFIG_FAIL_IO_TIMEOUT
1023         &dev_attr_fail_timeout.attr,
1024 #endif
1025         NULL
1026 };
1027
1028 static struct attribute_group disk_attr_group = {
1029         .attrs = disk_attrs,
1030 };
1031
1032 static const struct attribute_group *disk_attr_groups[] = {
1033         &disk_attr_group,
1034         NULL
1035 };
1036
1037 /**
1038  * disk_replace_part_tbl - replace disk->part_tbl in RCU-safe way
1039  * @disk: disk to replace part_tbl for
1040  * @new_ptbl: new part_tbl to install
1041  *
1042  * Replace disk->part_tbl with @new_ptbl in RCU-safe way.  The
1043  * original ptbl is freed using RCU callback.
1044  *
1045  * LOCKING:
1046  * Matching bd_mutx locked.
1047  */
1048 static void disk_replace_part_tbl(struct gendisk *disk,
1049                                   struct disk_part_tbl *new_ptbl)
1050 {
1051         struct disk_part_tbl *old_ptbl = disk->part_tbl;
1052
1053         rcu_assign_pointer(disk->part_tbl, new_ptbl);
1054
1055         if (old_ptbl) {
1056                 rcu_assign_pointer(old_ptbl->last_lookup, NULL);
1057                 kfree_rcu(old_ptbl, rcu_head);
1058         }
1059 }
1060
1061 /**
1062  * disk_expand_part_tbl - expand disk->part_tbl
1063  * @disk: disk to expand part_tbl for
1064  * @partno: expand such that this partno can fit in
1065  *
1066  * Expand disk->part_tbl such that @partno can fit in.  disk->part_tbl
1067  * uses RCU to allow unlocked dereferencing for stats and other stuff.
1068  *
1069  * LOCKING:
1070  * Matching bd_mutex locked, might sleep.
1071  *
1072  * RETURNS:
1073  * 0 on success, -errno on failure.
1074  */
1075 int disk_expand_part_tbl(struct gendisk *disk, int partno)
1076 {
1077         struct disk_part_tbl *old_ptbl = disk->part_tbl;
1078         struct disk_part_tbl *new_ptbl;
1079         int len = old_ptbl ? old_ptbl->len : 0;
1080         int target = partno + 1;
1081         size_t size;
1082         int i;
1083
1084         /* disk_max_parts() is zero during initialization, ignore if so */
1085         if (disk_max_parts(disk) && target > disk_max_parts(disk))
1086                 return -EINVAL;
1087
1088         if (target <= len)
1089                 return 0;
1090
1091         size = sizeof(*new_ptbl) + target * sizeof(new_ptbl->part[0]);
1092         new_ptbl = kzalloc_node(size, GFP_KERNEL, disk->node_id);
1093         if (!new_ptbl)
1094                 return -ENOMEM;
1095
1096         new_ptbl->len = target;
1097
1098         for (i = 0; i < len; i++)
1099                 rcu_assign_pointer(new_ptbl->part[i], old_ptbl->part[i]);
1100
1101         disk_replace_part_tbl(disk, new_ptbl);
1102         return 0;
1103 }
1104
1105 static void disk_release(struct device *dev)
1106 {
1107         struct gendisk *disk = dev_to_disk(dev);
1108
1109         disk_release_events(disk);
1110         kfree(disk->random);
1111         disk_replace_part_tbl(disk, NULL);
1112         free_part_stats(&disk->part0);
1113         free_part_info(&disk->part0);
1114         if (disk->queue)
1115                 blk_put_queue(disk->queue);
1116         kfree(disk);
1117 }
1118 struct class block_class = {
1119         .name           = "block",
1120 };
1121
1122 static char *block_devnode(struct device *dev, umode_t *mode)
1123 {
1124         struct gendisk *disk = dev_to_disk(dev);
1125
1126         if (disk->devnode)
1127                 return disk->devnode(disk, mode);
1128         return NULL;
1129 }
1130
1131 static struct device_type disk_type = {
1132         .name           = "disk",
1133         .groups         = disk_attr_groups,
1134         .release        = disk_release,
1135         .devnode        = block_devnode,
1136 };
1137
1138 #ifdef CONFIG_PROC_FS
1139 /*
1140  * aggregate disk stat collector.  Uses the same stats that the sysfs
1141  * entries do, above, but makes them available through one seq_file.
1142  *
1143  * The output looks suspiciously like /proc/partitions with a bunch of
1144  * extra fields.
1145  */
1146 static int diskstats_show(struct seq_file *seqf, void *v)
1147 {
1148         struct gendisk *gp = v;
1149         struct disk_part_iter piter;
1150         struct hd_struct *hd;
1151         char buf[BDEVNAME_SIZE];
1152         int cpu;
1153
1154         /*
1155         if (&disk_to_dev(gp)->kobj.entry == block_class.devices.next)
1156                 seq_puts(seqf,  "major minor name"
1157                                 "     rio rmerge rsect ruse wio wmerge "
1158                                 "wsect wuse running use aveq"
1159                                 "\n\n");
1160         */
1161
1162         disk_part_iter_init(&piter, gp, DISK_PITER_INCL_EMPTY_PART0);
1163         while ((hd = disk_part_iter_next(&piter))) {
1164                 cpu = part_stat_lock();
1165                 part_round_stats(cpu, hd);
1166                 part_stat_unlock();
1167                 seq_printf(seqf, "%4d %7d %s %lu %lu %lu "
1168                            "%u %lu %lu %lu %u %u %u %u\n",
1169                            MAJOR(part_devt(hd)), MINOR(part_devt(hd)),
1170                            disk_name(gp, hd->partno, buf),
1171                            part_stat_read(hd, ios[READ]),
1172                            part_stat_read(hd, merges[READ]),
1173                            part_stat_read(hd, sectors[READ]),
1174                            jiffies_to_msecs(part_stat_read(hd, ticks[READ])),
1175                            part_stat_read(hd, ios[WRITE]),
1176                            part_stat_read(hd, merges[WRITE]),
1177                            part_stat_read(hd, sectors[WRITE]),
1178                            jiffies_to_msecs(part_stat_read(hd, ticks[WRITE])),
1179                            part_in_flight(hd),
1180                            jiffies_to_msecs(part_stat_read(hd, io_ticks)),
1181                            jiffies_to_msecs(part_stat_read(hd, time_in_queue))
1182                         );
1183         }
1184         disk_part_iter_exit(&piter);
1185
1186         return 0;
1187 }
1188
1189 static const struct seq_operations diskstats_op = {
1190         .start  = disk_seqf_start,
1191         .next   = disk_seqf_next,
1192         .stop   = disk_seqf_stop,
1193         .show   = diskstats_show
1194 };
1195
1196 static int diskstats_open(struct inode *inode, struct file *file)
1197 {
1198         return seq_open(file, &diskstats_op);
1199 }
1200
1201 static const struct file_operations proc_diskstats_operations = {
1202         .open           = diskstats_open,
1203         .read           = seq_read,
1204         .llseek         = seq_lseek,
1205         .release        = seq_release,
1206 };
1207
1208 static int __init proc_genhd_init(void)
1209 {
1210         proc_create("diskstats", 0, NULL, &proc_diskstats_operations);
1211         proc_create("partitions", 0, NULL, &proc_partitions_operations);
1212         return 0;
1213 }
1214 module_init(proc_genhd_init);
1215 #endif /* CONFIG_PROC_FS */
1216
1217 dev_t blk_lookup_devt(const char *name, int partno)
1218 {
1219         dev_t devt = MKDEV(0, 0);
1220         struct class_dev_iter iter;
1221         struct device *dev;
1222
1223         class_dev_iter_init(&iter, &block_class, NULL, &disk_type);
1224         while ((dev = class_dev_iter_next(&iter))) {
1225                 struct gendisk *disk = dev_to_disk(dev);
1226                 struct hd_struct *part;
1227
1228                 if (strcmp(dev_name(dev), name))
1229                         continue;
1230
1231                 if (partno < disk->minors) {
1232                         /* We need to return the right devno, even
1233                          * if the partition doesn't exist yet.
1234                          */
1235                         devt = MKDEV(MAJOR(dev->devt),
1236                                      MINOR(dev->devt) + partno);
1237                         break;
1238                 }
1239                 part = disk_get_part(disk, partno);
1240                 if (part) {
1241                         devt = part_devt(part);
1242                         disk_put_part(part);
1243                         break;
1244                 }
1245                 disk_put_part(part);
1246         }
1247         class_dev_iter_exit(&iter);
1248         return devt;
1249 }
1250 EXPORT_SYMBOL(blk_lookup_devt);
1251
1252 struct gendisk *alloc_disk(int minors)
1253 {
1254         return alloc_disk_node(minors, NUMA_NO_NODE);
1255 }
1256 EXPORT_SYMBOL(alloc_disk);
1257
1258 struct gendisk *alloc_disk_node(int minors, int node_id)
1259 {
1260         struct gendisk *disk;
1261
1262         disk = kmalloc_node(sizeof(struct gendisk),
1263                                 GFP_KERNEL | __GFP_ZERO, node_id);
1264         if (disk) {
1265                 if (!init_part_stats(&disk->part0)) {
1266                         kfree(disk);
1267                         return NULL;
1268                 }
1269                 disk->node_id = node_id;
1270                 if (disk_expand_part_tbl(disk, 0)) {
1271                         free_part_stats(&disk->part0);
1272                         kfree(disk);
1273                         return NULL;
1274                 }
1275                 disk->part_tbl->part[0] = &disk->part0;
1276
1277                 /*
1278                  * set_capacity() and get_capacity() currently don't use
1279                  * seqcounter to read/update the part0->nr_sects. Still init
1280                  * the counter as we can read the sectors in IO submission
1281                  * patch using seqence counters.
1282                  *
1283                  * TODO: Ideally set_capacity() and get_capacity() should be
1284                  * converted to make use of bd_mutex and sequence counters.
1285                  */
1286                 seqcount_init(&disk->part0.nr_sects_seq);
1287                 hd_ref_init(&disk->part0);
1288
1289                 disk->minors = minors;
1290                 rand_initialize_disk(disk);
1291                 disk_to_dev(disk)->class = &block_class;
1292                 disk_to_dev(disk)->type = &disk_type;
1293                 device_initialize(disk_to_dev(disk));
1294         }
1295         return disk;
1296 }
1297 EXPORT_SYMBOL(alloc_disk_node);
1298
1299 struct kobject *get_disk(struct gendisk *disk)
1300 {
1301         struct module *owner;
1302         struct kobject *kobj;
1303
1304         if (!disk->fops)
1305                 return NULL;
1306         owner = disk->fops->owner;
1307         if (owner && !try_module_get(owner))
1308                 return NULL;
1309         kobj = kobject_get(&disk_to_dev(disk)->kobj);
1310         if (kobj == NULL) {
1311                 module_put(owner);
1312                 return NULL;
1313         }
1314         return kobj;
1315
1316 }
1317
1318 EXPORT_SYMBOL(get_disk);
1319
1320 void put_disk(struct gendisk *disk)
1321 {
1322         if (disk)
1323                 kobject_put(&disk_to_dev(disk)->kobj);
1324 }
1325
1326 EXPORT_SYMBOL(put_disk);
1327
1328 static void set_disk_ro_uevent(struct gendisk *gd, int ro)
1329 {
1330         char event[] = "DISK_RO=1";
1331         char *envp[] = { event, NULL };
1332
1333         if (!ro)
1334                 event[8] = '0';
1335         kobject_uevent_env(&disk_to_dev(gd)->kobj, KOBJ_CHANGE, envp);
1336 }
1337
1338 void set_device_ro(struct block_device *bdev, int flag)
1339 {
1340         bdev->bd_part->policy = flag;
1341 }
1342
1343 EXPORT_SYMBOL(set_device_ro);
1344
1345 void set_disk_ro(struct gendisk *disk, int flag)
1346 {
1347         struct disk_part_iter piter;
1348         struct hd_struct *part;
1349
1350         if (disk->part0.policy != flag) {
1351                 set_disk_ro_uevent(disk, flag);
1352                 disk->part0.policy = flag;
1353         }
1354
1355         disk_part_iter_init(&piter, disk, DISK_PITER_INCL_EMPTY);
1356         while ((part = disk_part_iter_next(&piter)))
1357                 part->policy = flag;
1358         disk_part_iter_exit(&piter);
1359 }
1360
1361 EXPORT_SYMBOL(set_disk_ro);
1362
1363 int bdev_read_only(struct block_device *bdev)
1364 {
1365         if (!bdev)
1366                 return 0;
1367         return bdev->bd_part->policy;
1368 }
1369
1370 EXPORT_SYMBOL(bdev_read_only);
1371
1372 int invalidate_partition(struct gendisk *disk, int partno)
1373 {
1374         int res = 0;
1375         struct block_device *bdev = bdget_disk(disk, partno);
1376         if (bdev) {
1377                 fsync_bdev(bdev);
1378                 res = __invalidate_device(bdev, true);
1379                 bdput(bdev);
1380         }
1381         return res;
1382 }
1383
1384 EXPORT_SYMBOL(invalidate_partition);
1385
1386 /*
1387  * Disk events - monitor disk events like media change and eject request.
1388  */
1389 struct disk_events {
1390         struct list_head        node;           /* all disk_event's */
1391         struct gendisk          *disk;          /* the associated disk */
1392         spinlock_t              lock;
1393
1394         struct mutex            block_mutex;    /* protects blocking */
1395         int                     block;          /* event blocking depth */
1396         unsigned int            pending;        /* events already sent out */
1397         unsigned int            clearing;       /* events being cleared */
1398
1399         long                    poll_msecs;     /* interval, -1 for default */
1400         struct delayed_work     dwork;
1401 };
1402
1403 static const char *disk_events_strs[] = {
1404         [ilog2(DISK_EVENT_MEDIA_CHANGE)]        = "media_change",
1405         [ilog2(DISK_EVENT_EJECT_REQUEST)]       = "eject_request",
1406 };
1407
1408 static char *disk_uevents[] = {
1409         [ilog2(DISK_EVENT_MEDIA_CHANGE)]        = "DISK_MEDIA_CHANGE=1",
1410         [ilog2(DISK_EVENT_EJECT_REQUEST)]       = "DISK_EJECT_REQUEST=1",
1411 };
1412
1413 /* list of all disk_events */
1414 static DEFINE_MUTEX(disk_events_mutex);
1415 static LIST_HEAD(disk_events);
1416
1417 /* disable in-kernel polling by default */
1418 static unsigned long disk_events_dfl_poll_msecs = 0;
1419
1420 static unsigned long disk_events_poll_jiffies(struct gendisk *disk)
1421 {
1422         struct disk_events *ev = disk->ev;
1423         long intv_msecs = 0;
1424
1425         /*
1426          * If device-specific poll interval is set, always use it.  If
1427          * the default is being used, poll iff there are events which
1428          * can't be monitored asynchronously.
1429          */
1430         if (ev->poll_msecs >= 0)
1431                 intv_msecs = ev->poll_msecs;
1432         else if (disk->events & ~disk->async_events)
1433                 intv_msecs = disk_events_dfl_poll_msecs;
1434
1435         return msecs_to_jiffies(intv_msecs);
1436 }
1437
1438 /**
1439  * disk_block_events - block and flush disk event checking
1440  * @disk: disk to block events for
1441  *
1442  * On return from this function, it is guaranteed that event checking
1443  * isn't in progress and won't happen until unblocked by
1444  * disk_unblock_events().  Events blocking is counted and the actual
1445  * unblocking happens after the matching number of unblocks are done.
1446  *
1447  * Note that this intentionally does not block event checking from
1448  * disk_clear_events().
1449  *
1450  * CONTEXT:
1451  * Might sleep.
1452  */
1453 void disk_block_events(struct gendisk *disk)
1454 {
1455         struct disk_events *ev = disk->ev;
1456         unsigned long flags;
1457         bool cancel;
1458
1459         if (!ev)
1460                 return;
1461
1462         /*
1463          * Outer mutex ensures that the first blocker completes canceling
1464          * the event work before further blockers are allowed to finish.
1465          */
1466         mutex_lock(&ev->block_mutex);
1467
1468         spin_lock_irqsave(&ev->lock, flags);
1469         cancel = !ev->block++;
1470         spin_unlock_irqrestore(&ev->lock, flags);
1471
1472         if (cancel)
1473                 cancel_delayed_work_sync(&disk->ev->dwork);
1474
1475         mutex_unlock(&ev->block_mutex);
1476 }
1477
1478 static void __disk_unblock_events(struct gendisk *disk, bool check_now)
1479 {
1480         struct disk_events *ev = disk->ev;
1481         unsigned long intv;
1482         unsigned long flags;
1483
1484         spin_lock_irqsave(&ev->lock, flags);
1485
1486         if (WARN_ON_ONCE(ev->block <= 0))
1487                 goto out_unlock;
1488
1489         if (--ev->block)
1490                 goto out_unlock;
1491
1492         /*
1493          * Not exactly a latency critical operation, set poll timer
1494          * slack to 25% and kick event check.
1495          */
1496         intv = disk_events_poll_jiffies(disk);
1497         set_timer_slack(&ev->dwork.timer, intv / 4);
1498         if (check_now)
1499                 queue_delayed_work(system_freezable_wq, &ev->dwork, 0);
1500         else if (intv)
1501                 queue_delayed_work(system_freezable_wq, &ev->dwork, intv);
1502 out_unlock:
1503         spin_unlock_irqrestore(&ev->lock, flags);
1504 }
1505
1506 /**
1507  * disk_unblock_events - unblock disk event checking
1508  * @disk: disk to unblock events for
1509  *
1510  * Undo disk_block_events().  When the block count reaches zero, it
1511  * starts events polling if configured.
1512  *
1513  * CONTEXT:
1514  * Don't care.  Safe to call from irq context.
1515  */
1516 void disk_unblock_events(struct gendisk *disk)
1517 {
1518         if (disk->ev)
1519                 __disk_unblock_events(disk, false);
1520 }
1521
1522 /**
1523  * disk_flush_events - schedule immediate event checking and flushing
1524  * @disk: disk to check and flush events for
1525  * @mask: events to flush
1526  *
1527  * Schedule immediate event checking on @disk if not blocked.  Events in
1528  * @mask are scheduled to be cleared from the driver.  Note that this
1529  * doesn't clear the events from @disk->ev.
1530  *
1531  * CONTEXT:
1532  * If @mask is non-zero must be called with bdev->bd_mutex held.
1533  */
1534 void disk_flush_events(struct gendisk *disk, unsigned int mask)
1535 {
1536         struct disk_events *ev = disk->ev;
1537
1538         if (!ev)
1539                 return;
1540
1541         spin_lock_irq(&ev->lock);
1542         ev->clearing |= mask;
1543         if (!ev->block)
1544                 mod_delayed_work(system_freezable_wq, &ev->dwork, 0);
1545         spin_unlock_irq(&ev->lock);
1546 }
1547
1548 /**
1549  * disk_clear_events - synchronously check, clear and return pending events
1550  * @disk: disk to fetch and clear events from
1551  * @mask: mask of events to be fetched and clearted
1552  *
1553  * Disk events are synchronously checked and pending events in @mask
1554  * are cleared and returned.  This ignores the block count.
1555  *
1556  * CONTEXT:
1557  * Might sleep.
1558  */
1559 unsigned int disk_clear_events(struct gendisk *disk, unsigned int mask)
1560 {
1561         const struct block_device_operations *bdops = disk->fops;
1562         struct disk_events *ev = disk->ev;
1563         unsigned int pending;
1564         unsigned int clearing = mask;
1565
1566         if (!ev) {
1567                 /* for drivers still using the old ->media_changed method */
1568                 if ((mask & DISK_EVENT_MEDIA_CHANGE) &&
1569                     bdops->media_changed && bdops->media_changed(disk))
1570                         return DISK_EVENT_MEDIA_CHANGE;
1571                 return 0;
1572         }
1573
1574         disk_block_events(disk);
1575
1576         /*
1577          * store the union of mask and ev->clearing on the stack so that the
1578          * race with disk_flush_events does not cause ambiguity (ev->clearing
1579          * can still be modified even if events are blocked).
1580          */
1581         spin_lock_irq(&ev->lock);
1582         clearing |= ev->clearing;
1583         ev->clearing = 0;
1584         spin_unlock_irq(&ev->lock);
1585
1586         disk_check_events(ev, &clearing);
1587         /*
1588          * if ev->clearing is not 0, the disk_flush_events got called in the
1589          * middle of this function, so we want to run the workfn without delay.
1590          */
1591         __disk_unblock_events(disk, ev->clearing ? true : false);
1592
1593         /* then, fetch and clear pending events */
1594         spin_lock_irq(&ev->lock);
1595         pending = ev->pending & mask;
1596         ev->pending &= ~mask;
1597         spin_unlock_irq(&ev->lock);
1598         WARN_ON_ONCE(clearing & mask);
1599
1600         return pending;
1601 }
1602
1603 /*
1604  * Separate this part out so that a different pointer for clearing_ptr can be
1605  * passed in for disk_clear_events.
1606  */
1607 static void disk_events_workfn(struct work_struct *work)
1608 {
1609         struct delayed_work *dwork = to_delayed_work(work);
1610         struct disk_events *ev = container_of(dwork, struct disk_events, dwork);
1611
1612         disk_check_events(ev, &ev->clearing);
1613 }
1614
1615 static void disk_check_events(struct disk_events *ev,
1616                               unsigned int *clearing_ptr)
1617 {
1618         struct gendisk *disk = ev->disk;
1619         char *envp[ARRAY_SIZE(disk_uevents) + 1] = { };
1620         unsigned int clearing = *clearing_ptr;
1621         unsigned int events;
1622         unsigned long intv;
1623         int nr_events = 0, i;
1624
1625         /* check events */
1626         events = disk->fops->check_events(disk, clearing);
1627
1628         /* accumulate pending events and schedule next poll if necessary */
1629         spin_lock_irq(&ev->lock);
1630
1631         events &= ~ev->pending;
1632         ev->pending |= events;
1633         *clearing_ptr &= ~clearing;
1634
1635         intv = disk_events_poll_jiffies(disk);
1636         if (!ev->block && intv)
1637                 queue_delayed_work(system_freezable_wq, &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 }