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