Merge tag 'arm64-upstream' of git://git.kernel.org/pub/scm/linux/kernel/git/arm64...
[linux/fpc-iii.git] / block / genhd.c
blobcff6bdf27226bb597066bc377af3760b38a8250a
1 /*
2 * gendisk handling
3 */
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/backing-dev.h>
12 #include <linux/init.h>
13 #include <linux/spinlock.h>
14 #include <linux/proc_fs.h>
15 #include <linux/seq_file.h>
16 #include <linux/slab.h>
17 #include <linux/kmod.h>
18 #include <linux/kobj_map.h>
19 #include <linux/mutex.h>
20 #include <linux/idr.h>
21 #include <linux/log2.h>
22 #include <linux/pm_runtime.h>
23 #include <linux/badblocks.h>
25 #include "blk.h"
27 static DEFINE_MUTEX(block_class_lock);
28 struct kobject *block_depr;
30 /* for extended dynamic devt allocation, currently only one major is used */
31 #define NR_EXT_DEVT (1 << MINORBITS)
33 /* For extended devt allocation. ext_devt_lock prevents look up
34 * results from going away underneath its user.
36 static DEFINE_SPINLOCK(ext_devt_lock);
37 static DEFINE_IDR(ext_devt_idr);
39 static const struct device_type disk_type;
41 static void disk_check_events(struct disk_events *ev,
42 unsigned int *clearing_ptr);
43 static void disk_alloc_events(struct gendisk *disk);
44 static void disk_add_events(struct gendisk *disk);
45 static void disk_del_events(struct gendisk *disk);
46 static void disk_release_events(struct gendisk *disk);
48 void part_inc_in_flight(struct request_queue *q, struct hd_struct *part, int rw)
50 if (q->mq_ops)
51 return;
53 atomic_inc(&part->in_flight[rw]);
54 if (part->partno)
55 atomic_inc(&part_to_disk(part)->part0.in_flight[rw]);
58 void part_dec_in_flight(struct request_queue *q, struct hd_struct *part, int rw)
60 if (q->mq_ops)
61 return;
63 atomic_dec(&part->in_flight[rw]);
64 if (part->partno)
65 atomic_dec(&part_to_disk(part)->part0.in_flight[rw]);
68 void part_in_flight(struct request_queue *q, struct hd_struct *part,
69 unsigned int inflight[2])
71 if (q->mq_ops) {
72 blk_mq_in_flight(q, part, inflight);
73 return;
76 inflight[0] = atomic_read(&part->in_flight[0]) +
77 atomic_read(&part->in_flight[1]);
78 if (part->partno) {
79 part = &part_to_disk(part)->part0;
80 inflight[1] = atomic_read(&part->in_flight[0]) +
81 atomic_read(&part->in_flight[1]);
85 void part_in_flight_rw(struct request_queue *q, struct hd_struct *part,
86 unsigned int inflight[2])
88 if (q->mq_ops) {
89 blk_mq_in_flight_rw(q, part, inflight);
90 return;
93 inflight[0] = atomic_read(&part->in_flight[0]);
94 inflight[1] = atomic_read(&part->in_flight[1]);
97 struct hd_struct *__disk_get_part(struct gendisk *disk, int partno)
99 struct disk_part_tbl *ptbl = rcu_dereference(disk->part_tbl);
101 if (unlikely(partno < 0 || partno >= ptbl->len))
102 return NULL;
103 return rcu_dereference(ptbl->part[partno]);
107 * disk_get_part - get partition
108 * @disk: disk to look partition from
109 * @partno: partition number
111 * Look for partition @partno from @disk. If found, increment
112 * reference count and return it.
114 * CONTEXT:
115 * Don't care.
117 * RETURNS:
118 * Pointer to the found partition on success, NULL if not found.
120 struct hd_struct *disk_get_part(struct gendisk *disk, int partno)
122 struct hd_struct *part;
124 rcu_read_lock();
125 part = __disk_get_part(disk, partno);
126 if (part)
127 get_device(part_to_dev(part));
128 rcu_read_unlock();
130 return part;
132 EXPORT_SYMBOL_GPL(disk_get_part);
135 * disk_part_iter_init - initialize partition iterator
136 * @piter: iterator to initialize
137 * @disk: disk to iterate over
138 * @flags: DISK_PITER_* flags
140 * Initialize @piter so that it iterates over partitions of @disk.
142 * CONTEXT:
143 * Don't care.
145 void disk_part_iter_init(struct disk_part_iter *piter, struct gendisk *disk,
146 unsigned int flags)
148 struct disk_part_tbl *ptbl;
150 rcu_read_lock();
151 ptbl = rcu_dereference(disk->part_tbl);
153 piter->disk = disk;
154 piter->part = NULL;
156 if (flags & DISK_PITER_REVERSE)
157 piter->idx = ptbl->len - 1;
158 else if (flags & (DISK_PITER_INCL_PART0 | DISK_PITER_INCL_EMPTY_PART0))
159 piter->idx = 0;
160 else
161 piter->idx = 1;
163 piter->flags = flags;
165 rcu_read_unlock();
167 EXPORT_SYMBOL_GPL(disk_part_iter_init);
170 * disk_part_iter_next - proceed iterator to the next partition and return it
171 * @piter: iterator of interest
173 * Proceed @piter to the next partition and return it.
175 * CONTEXT:
176 * Don't care.
178 struct hd_struct *disk_part_iter_next(struct disk_part_iter *piter)
180 struct disk_part_tbl *ptbl;
181 int inc, end;
183 /* put the last partition */
184 disk_put_part(piter->part);
185 piter->part = NULL;
187 /* get part_tbl */
188 rcu_read_lock();
189 ptbl = rcu_dereference(piter->disk->part_tbl);
191 /* determine iteration parameters */
192 if (piter->flags & DISK_PITER_REVERSE) {
193 inc = -1;
194 if (piter->flags & (DISK_PITER_INCL_PART0 |
195 DISK_PITER_INCL_EMPTY_PART0))
196 end = -1;
197 else
198 end = 0;
199 } else {
200 inc = 1;
201 end = ptbl->len;
204 /* iterate to the next partition */
205 for (; piter->idx != end; piter->idx += inc) {
206 struct hd_struct *part;
208 part = rcu_dereference(ptbl->part[piter->idx]);
209 if (!part)
210 continue;
211 if (!part_nr_sects_read(part) &&
212 !(piter->flags & DISK_PITER_INCL_EMPTY) &&
213 !(piter->flags & DISK_PITER_INCL_EMPTY_PART0 &&
214 piter->idx == 0))
215 continue;
217 get_device(part_to_dev(part));
218 piter->part = part;
219 piter->idx += inc;
220 break;
223 rcu_read_unlock();
225 return piter->part;
227 EXPORT_SYMBOL_GPL(disk_part_iter_next);
230 * disk_part_iter_exit - finish up partition iteration
231 * @piter: iter of interest
233 * Called when iteration is over. Cleans up @piter.
235 * CONTEXT:
236 * Don't care.
238 void disk_part_iter_exit(struct disk_part_iter *piter)
240 disk_put_part(piter->part);
241 piter->part = NULL;
243 EXPORT_SYMBOL_GPL(disk_part_iter_exit);
245 static inline int sector_in_part(struct hd_struct *part, sector_t sector)
247 return part->start_sect <= sector &&
248 sector < part->start_sect + part_nr_sects_read(part);
252 * disk_map_sector_rcu - map sector to partition
253 * @disk: gendisk of interest
254 * @sector: sector to map
256 * Find out which partition @sector maps to on @disk. This is
257 * primarily used for stats accounting.
259 * CONTEXT:
260 * RCU read locked. The returned partition pointer is valid only
261 * while preemption is disabled.
263 * RETURNS:
264 * Found partition on success, part0 is returned if no partition matches
266 struct hd_struct *disk_map_sector_rcu(struct gendisk *disk, sector_t sector)
268 struct disk_part_tbl *ptbl;
269 struct hd_struct *part;
270 int i;
272 ptbl = rcu_dereference(disk->part_tbl);
274 part = rcu_dereference(ptbl->last_lookup);
275 if (part && sector_in_part(part, sector))
276 return part;
278 for (i = 1; i < ptbl->len; i++) {
279 part = rcu_dereference(ptbl->part[i]);
281 if (part && sector_in_part(part, sector)) {
282 rcu_assign_pointer(ptbl->last_lookup, part);
283 return part;
286 return &disk->part0;
288 EXPORT_SYMBOL_GPL(disk_map_sector_rcu);
291 * Can be deleted altogether. Later.
294 #define BLKDEV_MAJOR_HASH_SIZE 255
295 static struct blk_major_name {
296 struct blk_major_name *next;
297 int major;
298 char name[16];
299 } *major_names[BLKDEV_MAJOR_HASH_SIZE];
301 /* index in the above - for now: assume no multimajor ranges */
302 static inline int major_to_index(unsigned major)
304 return major % BLKDEV_MAJOR_HASH_SIZE;
307 #ifdef CONFIG_PROC_FS
308 void blkdev_show(struct seq_file *seqf, off_t offset)
310 struct blk_major_name *dp;
312 mutex_lock(&block_class_lock);
313 for (dp = major_names[major_to_index(offset)]; dp; dp = dp->next)
314 if (dp->major == offset)
315 seq_printf(seqf, "%3d %s\n", dp->major, dp->name);
316 mutex_unlock(&block_class_lock);
318 #endif /* CONFIG_PROC_FS */
321 * register_blkdev - register a new block device
323 * @major: the requested major device number [1..BLKDEV_MAJOR_MAX-1]. If
324 * @major = 0, try to allocate any unused major number.
325 * @name: the name of the new block device as a zero terminated string
327 * The @name must be unique within the system.
329 * The return value depends on the @major input parameter:
331 * - if a major device number was requested in range [1..BLKDEV_MAJOR_MAX-1]
332 * then the function returns zero on success, or a negative error code
333 * - if any unused major number was requested with @major = 0 parameter
334 * then the return value is the allocated major number in range
335 * [1..BLKDEV_MAJOR_MAX-1] or a negative error code otherwise
337 * See Documentation/admin-guide/devices.txt for the list of allocated
338 * major numbers.
340 int register_blkdev(unsigned int major, const char *name)
342 struct blk_major_name **n, *p;
343 int index, ret = 0;
345 mutex_lock(&block_class_lock);
347 /* temporary */
348 if (major == 0) {
349 for (index = ARRAY_SIZE(major_names)-1; index > 0; index--) {
350 if (major_names[index] == NULL)
351 break;
354 if (index == 0) {
355 printk("register_blkdev: failed to get major for %s\n",
356 name);
357 ret = -EBUSY;
358 goto out;
360 major = index;
361 ret = major;
364 if (major >= BLKDEV_MAJOR_MAX) {
365 pr_err("register_blkdev: major requested (%u) is greater than the maximum (%u) for %s\n",
366 major, BLKDEV_MAJOR_MAX-1, name);
368 ret = -EINVAL;
369 goto out;
372 p = kmalloc(sizeof(struct blk_major_name), GFP_KERNEL);
373 if (p == NULL) {
374 ret = -ENOMEM;
375 goto out;
378 p->major = major;
379 strlcpy(p->name, name, sizeof(p->name));
380 p->next = NULL;
381 index = major_to_index(major);
383 for (n = &major_names[index]; *n; n = &(*n)->next) {
384 if ((*n)->major == major)
385 break;
387 if (!*n)
388 *n = p;
389 else
390 ret = -EBUSY;
392 if (ret < 0) {
393 printk("register_blkdev: cannot get major %u for %s\n",
394 major, name);
395 kfree(p);
397 out:
398 mutex_unlock(&block_class_lock);
399 return ret;
402 EXPORT_SYMBOL(register_blkdev);
404 void unregister_blkdev(unsigned int major, const char *name)
406 struct blk_major_name **n;
407 struct blk_major_name *p = NULL;
408 int index = major_to_index(major);
410 mutex_lock(&block_class_lock);
411 for (n = &major_names[index]; *n; n = &(*n)->next)
412 if ((*n)->major == major)
413 break;
414 if (!*n || strcmp((*n)->name, name)) {
415 WARN_ON(1);
416 } else {
417 p = *n;
418 *n = p->next;
420 mutex_unlock(&block_class_lock);
421 kfree(p);
424 EXPORT_SYMBOL(unregister_blkdev);
426 static struct kobj_map *bdev_map;
429 * blk_mangle_minor - scatter minor numbers apart
430 * @minor: minor number to mangle
432 * Scatter consecutively allocated @minor number apart if MANGLE_DEVT
433 * is enabled. Mangling twice gives the original value.
435 * RETURNS:
436 * Mangled value.
438 * CONTEXT:
439 * Don't care.
441 static int blk_mangle_minor(int minor)
443 #ifdef CONFIG_DEBUG_BLOCK_EXT_DEVT
444 int i;
446 for (i = 0; i < MINORBITS / 2; i++) {
447 int low = minor & (1 << i);
448 int high = minor & (1 << (MINORBITS - 1 - i));
449 int distance = MINORBITS - 1 - 2 * i;
451 minor ^= low | high; /* clear both bits */
452 low <<= distance; /* swap the positions */
453 high >>= distance;
454 minor |= low | high; /* and set */
456 #endif
457 return minor;
461 * blk_alloc_devt - allocate a dev_t for a partition
462 * @part: partition to allocate dev_t for
463 * @devt: out parameter for resulting dev_t
465 * Allocate a dev_t for block device.
467 * RETURNS:
468 * 0 on success, allocated dev_t is returned in *@devt. -errno on
469 * failure.
471 * CONTEXT:
472 * Might sleep.
474 int blk_alloc_devt(struct hd_struct *part, dev_t *devt)
476 struct gendisk *disk = part_to_disk(part);
477 int idx;
479 /* in consecutive minor range? */
480 if (part->partno < disk->minors) {
481 *devt = MKDEV(disk->major, disk->first_minor + part->partno);
482 return 0;
485 /* allocate ext devt */
486 idr_preload(GFP_KERNEL);
488 spin_lock_bh(&ext_devt_lock);
489 idx = idr_alloc(&ext_devt_idr, part, 0, NR_EXT_DEVT, GFP_NOWAIT);
490 spin_unlock_bh(&ext_devt_lock);
492 idr_preload_end();
493 if (idx < 0)
494 return idx == -ENOSPC ? -EBUSY : idx;
496 *devt = MKDEV(BLOCK_EXT_MAJOR, blk_mangle_minor(idx));
497 return 0;
501 * blk_free_devt - free a dev_t
502 * @devt: dev_t to free
504 * Free @devt which was allocated using blk_alloc_devt().
506 * CONTEXT:
507 * Might sleep.
509 void blk_free_devt(dev_t devt)
511 if (devt == MKDEV(0, 0))
512 return;
514 if (MAJOR(devt) == BLOCK_EXT_MAJOR) {
515 spin_lock_bh(&ext_devt_lock);
516 idr_remove(&ext_devt_idr, blk_mangle_minor(MINOR(devt)));
517 spin_unlock_bh(&ext_devt_lock);
521 static char *bdevt_str(dev_t devt, char *buf)
523 if (MAJOR(devt) <= 0xff && MINOR(devt) <= 0xff) {
524 char tbuf[BDEVT_SIZE];
525 snprintf(tbuf, BDEVT_SIZE, "%02x%02x", MAJOR(devt), MINOR(devt));
526 snprintf(buf, BDEVT_SIZE, "%-9s", tbuf);
527 } else
528 snprintf(buf, BDEVT_SIZE, "%03x:%05x", MAJOR(devt), MINOR(devt));
530 return buf;
534 * Register device numbers dev..(dev+range-1)
535 * range must be nonzero
536 * The hash chain is sorted on range, so that subranges can override.
538 void blk_register_region(dev_t devt, unsigned long range, struct module *module,
539 struct kobject *(*probe)(dev_t, int *, void *),
540 int (*lock)(dev_t, void *), void *data)
542 kobj_map(bdev_map, devt, range, module, probe, lock, data);
545 EXPORT_SYMBOL(blk_register_region);
547 void blk_unregister_region(dev_t devt, unsigned long range)
549 kobj_unmap(bdev_map, devt, range);
552 EXPORT_SYMBOL(blk_unregister_region);
554 static struct kobject *exact_match(dev_t devt, int *partno, void *data)
556 struct gendisk *p = data;
558 return &disk_to_dev(p)->kobj;
561 static int exact_lock(dev_t devt, void *data)
563 struct gendisk *p = data;
565 if (!get_disk_and_module(p))
566 return -1;
567 return 0;
570 static void register_disk(struct device *parent, struct gendisk *disk,
571 const struct attribute_group **groups)
573 struct device *ddev = disk_to_dev(disk);
574 struct block_device *bdev;
575 struct disk_part_iter piter;
576 struct hd_struct *part;
577 int err;
579 ddev->parent = parent;
581 dev_set_name(ddev, "%s", disk->disk_name);
583 /* delay uevents, until we scanned partition table */
584 dev_set_uevent_suppress(ddev, 1);
586 if (groups) {
587 WARN_ON(ddev->groups);
588 ddev->groups = groups;
590 if (device_add(ddev))
591 return;
592 if (!sysfs_deprecated) {
593 err = sysfs_create_link(block_depr, &ddev->kobj,
594 kobject_name(&ddev->kobj));
595 if (err) {
596 device_del(ddev);
597 return;
602 * avoid probable deadlock caused by allocating memory with
603 * GFP_KERNEL in runtime_resume callback of its all ancestor
604 * devices
606 pm_runtime_set_memalloc_noio(ddev, true);
608 disk->part0.holder_dir = kobject_create_and_add("holders", &ddev->kobj);
609 disk->slave_dir = kobject_create_and_add("slaves", &ddev->kobj);
611 if (disk->flags & GENHD_FL_HIDDEN) {
612 dev_set_uevent_suppress(ddev, 0);
613 return;
616 /* No minors to use for partitions */
617 if (!disk_part_scan_enabled(disk))
618 goto exit;
620 /* No such device (e.g., media were just removed) */
621 if (!get_capacity(disk))
622 goto exit;
624 bdev = bdget_disk(disk, 0);
625 if (!bdev)
626 goto exit;
628 bdev->bd_invalidated = 1;
629 err = blkdev_get(bdev, FMODE_READ, NULL);
630 if (err < 0)
631 goto exit;
632 blkdev_put(bdev, FMODE_READ);
634 exit:
635 /* announce disk after possible partitions are created */
636 dev_set_uevent_suppress(ddev, 0);
637 kobject_uevent(&ddev->kobj, KOBJ_ADD);
639 /* announce possible partitions */
640 disk_part_iter_init(&piter, disk, 0);
641 while ((part = disk_part_iter_next(&piter)))
642 kobject_uevent(&part_to_dev(part)->kobj, KOBJ_ADD);
643 disk_part_iter_exit(&piter);
645 err = sysfs_create_link(&ddev->kobj,
646 &disk->queue->backing_dev_info->dev->kobj,
647 "bdi");
648 WARN_ON(err);
652 * __device_add_disk - add disk information to kernel list
653 * @parent: parent device for the disk
654 * @disk: per-device partitioning information
655 * @groups: Additional per-device sysfs groups
656 * @register_queue: register the queue if set to true
658 * This function registers the partitioning information in @disk
659 * with the kernel.
661 * FIXME: error handling
663 static void __device_add_disk(struct device *parent, struct gendisk *disk,
664 const struct attribute_group **groups,
665 bool register_queue)
667 dev_t devt;
668 int retval;
670 /* minors == 0 indicates to use ext devt from part0 and should
671 * be accompanied with EXT_DEVT flag. Make sure all
672 * parameters make sense.
674 WARN_ON(disk->minors && !(disk->major || disk->first_minor));
675 WARN_ON(!disk->minors &&
676 !(disk->flags & (GENHD_FL_EXT_DEVT | GENHD_FL_HIDDEN)));
678 disk->flags |= GENHD_FL_UP;
680 retval = blk_alloc_devt(&disk->part0, &devt);
681 if (retval) {
682 WARN_ON(1);
683 return;
685 disk->major = MAJOR(devt);
686 disk->first_minor = MINOR(devt);
688 disk_alloc_events(disk);
690 if (disk->flags & GENHD_FL_HIDDEN) {
692 * Don't let hidden disks show up in /proc/partitions,
693 * and don't bother scanning for partitions either.
695 disk->flags |= GENHD_FL_SUPPRESS_PARTITION_INFO;
696 disk->flags |= GENHD_FL_NO_PART_SCAN;
697 } else {
698 int ret;
700 /* Register BDI before referencing it from bdev */
701 disk_to_dev(disk)->devt = devt;
702 ret = bdi_register_owner(disk->queue->backing_dev_info,
703 disk_to_dev(disk));
704 WARN_ON(ret);
705 blk_register_region(disk_devt(disk), disk->minors, NULL,
706 exact_match, exact_lock, disk);
708 register_disk(parent, disk, groups);
709 if (register_queue)
710 blk_register_queue(disk);
713 * Take an extra ref on queue which will be put on disk_release()
714 * so that it sticks around as long as @disk is there.
716 WARN_ON_ONCE(!blk_get_queue(disk->queue));
718 disk_add_events(disk);
719 blk_integrity_add(disk);
722 void device_add_disk(struct device *parent, struct gendisk *disk,
723 const struct attribute_group **groups)
726 __device_add_disk(parent, disk, groups, true);
728 EXPORT_SYMBOL(device_add_disk);
730 void device_add_disk_no_queue_reg(struct device *parent, struct gendisk *disk)
732 __device_add_disk(parent, disk, NULL, false);
734 EXPORT_SYMBOL(device_add_disk_no_queue_reg);
736 void del_gendisk(struct gendisk *disk)
738 struct disk_part_iter piter;
739 struct hd_struct *part;
741 blk_integrity_del(disk);
742 disk_del_events(disk);
745 * Block lookups of the disk until all bdevs are unhashed and the
746 * disk is marked as dead (GENHD_FL_UP cleared).
748 down_write(&disk->lookup_sem);
749 /* invalidate stuff */
750 disk_part_iter_init(&piter, disk,
751 DISK_PITER_INCL_EMPTY | DISK_PITER_REVERSE);
752 while ((part = disk_part_iter_next(&piter))) {
753 invalidate_partition(disk, part->partno);
754 bdev_unhash_inode(part_devt(part));
755 delete_partition(disk, part->partno);
757 disk_part_iter_exit(&piter);
759 invalidate_partition(disk, 0);
760 bdev_unhash_inode(disk_devt(disk));
761 set_capacity(disk, 0);
762 disk->flags &= ~GENHD_FL_UP;
763 up_write(&disk->lookup_sem);
765 if (!(disk->flags & GENHD_FL_HIDDEN))
766 sysfs_remove_link(&disk_to_dev(disk)->kobj, "bdi");
767 if (disk->queue) {
769 * Unregister bdi before releasing device numbers (as they can
770 * get reused and we'd get clashes in sysfs).
772 if (!(disk->flags & GENHD_FL_HIDDEN))
773 bdi_unregister(disk->queue->backing_dev_info);
774 blk_unregister_queue(disk);
775 } else {
776 WARN_ON(1);
779 if (!(disk->flags & GENHD_FL_HIDDEN))
780 blk_unregister_region(disk_devt(disk), disk->minors);
782 kobject_put(disk->part0.holder_dir);
783 kobject_put(disk->slave_dir);
785 part_stat_set_all(&disk->part0, 0);
786 disk->part0.stamp = 0;
787 if (!sysfs_deprecated)
788 sysfs_remove_link(block_depr, dev_name(disk_to_dev(disk)));
789 pm_runtime_set_memalloc_noio(disk_to_dev(disk), false);
790 device_del(disk_to_dev(disk));
792 EXPORT_SYMBOL(del_gendisk);
794 /* sysfs access to bad-blocks list. */
795 static ssize_t disk_badblocks_show(struct device *dev,
796 struct device_attribute *attr,
797 char *page)
799 struct gendisk *disk = dev_to_disk(dev);
801 if (!disk->bb)
802 return sprintf(page, "\n");
804 return badblocks_show(disk->bb, page, 0);
807 static ssize_t disk_badblocks_store(struct device *dev,
808 struct device_attribute *attr,
809 const char *page, size_t len)
811 struct gendisk *disk = dev_to_disk(dev);
813 if (!disk->bb)
814 return -ENXIO;
816 return badblocks_store(disk->bb, page, len, 0);
820 * get_gendisk - get partitioning information for a given device
821 * @devt: device to get partitioning information for
822 * @partno: returned partition index
824 * This function gets the structure containing partitioning
825 * information for the given device @devt.
827 struct gendisk *get_gendisk(dev_t devt, int *partno)
829 struct gendisk *disk = NULL;
831 if (MAJOR(devt) != BLOCK_EXT_MAJOR) {
832 struct kobject *kobj;
834 kobj = kobj_lookup(bdev_map, devt, partno);
835 if (kobj)
836 disk = dev_to_disk(kobj_to_dev(kobj));
837 } else {
838 struct hd_struct *part;
840 spin_lock_bh(&ext_devt_lock);
841 part = idr_find(&ext_devt_idr, blk_mangle_minor(MINOR(devt)));
842 if (part && get_disk_and_module(part_to_disk(part))) {
843 *partno = part->partno;
844 disk = part_to_disk(part);
846 spin_unlock_bh(&ext_devt_lock);
849 if (!disk)
850 return NULL;
853 * Synchronize with del_gendisk() to not return disk that is being
854 * destroyed.
856 down_read(&disk->lookup_sem);
857 if (unlikely((disk->flags & GENHD_FL_HIDDEN) ||
858 !(disk->flags & GENHD_FL_UP))) {
859 up_read(&disk->lookup_sem);
860 put_disk_and_module(disk);
861 disk = NULL;
862 } else {
863 up_read(&disk->lookup_sem);
865 return disk;
867 EXPORT_SYMBOL(get_gendisk);
870 * bdget_disk - do bdget() by gendisk and partition number
871 * @disk: gendisk of interest
872 * @partno: partition number
874 * Find partition @partno from @disk, do bdget() on it.
876 * CONTEXT:
877 * Don't care.
879 * RETURNS:
880 * Resulting block_device on success, NULL on failure.
882 struct block_device *bdget_disk(struct gendisk *disk, int partno)
884 struct hd_struct *part;
885 struct block_device *bdev = NULL;
887 part = disk_get_part(disk, partno);
888 if (part)
889 bdev = bdget(part_devt(part));
890 disk_put_part(part);
892 return bdev;
894 EXPORT_SYMBOL(bdget_disk);
897 * print a full list of all partitions - intended for places where the root
898 * filesystem can't be mounted and thus to give the victim some idea of what
899 * went wrong
901 void __init printk_all_partitions(void)
903 struct class_dev_iter iter;
904 struct device *dev;
906 class_dev_iter_init(&iter, &block_class, NULL, &disk_type);
907 while ((dev = class_dev_iter_next(&iter))) {
908 struct gendisk *disk = dev_to_disk(dev);
909 struct disk_part_iter piter;
910 struct hd_struct *part;
911 char name_buf[BDEVNAME_SIZE];
912 char devt_buf[BDEVT_SIZE];
915 * Don't show empty devices or things that have been
916 * suppressed
918 if (get_capacity(disk) == 0 ||
919 (disk->flags & GENHD_FL_SUPPRESS_PARTITION_INFO))
920 continue;
923 * Note, unlike /proc/partitions, I am showing the
924 * numbers in hex - the same format as the root=
925 * option takes.
927 disk_part_iter_init(&piter, disk, DISK_PITER_INCL_PART0);
928 while ((part = disk_part_iter_next(&piter))) {
929 bool is_part0 = part == &disk->part0;
931 printk("%s%s %10llu %s %s", is_part0 ? "" : " ",
932 bdevt_str(part_devt(part), devt_buf),
933 (unsigned long long)part_nr_sects_read(part) >> 1
934 , disk_name(disk, part->partno, name_buf),
935 part->info ? part->info->uuid : "");
936 if (is_part0) {
937 if (dev->parent && dev->parent->driver)
938 printk(" driver: %s\n",
939 dev->parent->driver->name);
940 else
941 printk(" (driver?)\n");
942 } else
943 printk("\n");
945 disk_part_iter_exit(&piter);
947 class_dev_iter_exit(&iter);
950 #ifdef CONFIG_PROC_FS
951 /* iterator */
952 static void *disk_seqf_start(struct seq_file *seqf, loff_t *pos)
954 loff_t skip = *pos;
955 struct class_dev_iter *iter;
956 struct device *dev;
958 iter = kmalloc(sizeof(*iter), GFP_KERNEL);
959 if (!iter)
960 return ERR_PTR(-ENOMEM);
962 seqf->private = iter;
963 class_dev_iter_init(iter, &block_class, NULL, &disk_type);
964 do {
965 dev = class_dev_iter_next(iter);
966 if (!dev)
967 return NULL;
968 } while (skip--);
970 return dev_to_disk(dev);
973 static void *disk_seqf_next(struct seq_file *seqf, void *v, loff_t *pos)
975 struct device *dev;
977 (*pos)++;
978 dev = class_dev_iter_next(seqf->private);
979 if (dev)
980 return dev_to_disk(dev);
982 return NULL;
985 static void disk_seqf_stop(struct seq_file *seqf, void *v)
987 struct class_dev_iter *iter = seqf->private;
989 /* stop is called even after start failed :-( */
990 if (iter) {
991 class_dev_iter_exit(iter);
992 kfree(iter);
993 seqf->private = NULL;
997 static void *show_partition_start(struct seq_file *seqf, loff_t *pos)
999 void *p;
1001 p = disk_seqf_start(seqf, pos);
1002 if (!IS_ERR_OR_NULL(p) && !*pos)
1003 seq_puts(seqf, "major minor #blocks name\n\n");
1004 return p;
1007 static int show_partition(struct seq_file *seqf, void *v)
1009 struct gendisk *sgp = v;
1010 struct disk_part_iter piter;
1011 struct hd_struct *part;
1012 char buf[BDEVNAME_SIZE];
1014 /* Don't show non-partitionable removeable devices or empty devices */
1015 if (!get_capacity(sgp) || (!disk_max_parts(sgp) &&
1016 (sgp->flags & GENHD_FL_REMOVABLE)))
1017 return 0;
1018 if (sgp->flags & GENHD_FL_SUPPRESS_PARTITION_INFO)
1019 return 0;
1021 /* show the full disk and all non-0 size partitions of it */
1022 disk_part_iter_init(&piter, sgp, DISK_PITER_INCL_PART0);
1023 while ((part = disk_part_iter_next(&piter)))
1024 seq_printf(seqf, "%4d %7d %10llu %s\n",
1025 MAJOR(part_devt(part)), MINOR(part_devt(part)),
1026 (unsigned long long)part_nr_sects_read(part) >> 1,
1027 disk_name(sgp, part->partno, buf));
1028 disk_part_iter_exit(&piter);
1030 return 0;
1033 static const struct seq_operations partitions_op = {
1034 .start = show_partition_start,
1035 .next = disk_seqf_next,
1036 .stop = disk_seqf_stop,
1037 .show = show_partition
1039 #endif
1042 static struct kobject *base_probe(dev_t devt, int *partno, void *data)
1044 if (request_module("block-major-%d-%d", MAJOR(devt), MINOR(devt)) > 0)
1045 /* Make old-style 2.4 aliases work */
1046 request_module("block-major-%d", MAJOR(devt));
1047 return NULL;
1050 static int __init genhd_device_init(void)
1052 int error;
1054 block_class.dev_kobj = sysfs_dev_block_kobj;
1055 error = class_register(&block_class);
1056 if (unlikely(error))
1057 return error;
1058 bdev_map = kobj_map_init(base_probe, &block_class_lock);
1059 blk_dev_init();
1061 register_blkdev(BLOCK_EXT_MAJOR, "blkext");
1063 /* create top-level block dir */
1064 if (!sysfs_deprecated)
1065 block_depr = kobject_create_and_add("block", NULL);
1066 return 0;
1069 subsys_initcall(genhd_device_init);
1071 static ssize_t disk_range_show(struct device *dev,
1072 struct device_attribute *attr, char *buf)
1074 struct gendisk *disk = dev_to_disk(dev);
1076 return sprintf(buf, "%d\n", disk->minors);
1079 static ssize_t disk_ext_range_show(struct device *dev,
1080 struct device_attribute *attr, char *buf)
1082 struct gendisk *disk = dev_to_disk(dev);
1084 return sprintf(buf, "%d\n", disk_max_parts(disk));
1087 static ssize_t disk_removable_show(struct device *dev,
1088 struct device_attribute *attr, char *buf)
1090 struct gendisk *disk = dev_to_disk(dev);
1092 return sprintf(buf, "%d\n",
1093 (disk->flags & GENHD_FL_REMOVABLE ? 1 : 0));
1096 static ssize_t disk_hidden_show(struct device *dev,
1097 struct device_attribute *attr, char *buf)
1099 struct gendisk *disk = dev_to_disk(dev);
1101 return sprintf(buf, "%d\n",
1102 (disk->flags & GENHD_FL_HIDDEN ? 1 : 0));
1105 static ssize_t disk_ro_show(struct device *dev,
1106 struct device_attribute *attr, char *buf)
1108 struct gendisk *disk = dev_to_disk(dev);
1110 return sprintf(buf, "%d\n", get_disk_ro(disk) ? 1 : 0);
1113 static ssize_t disk_capability_show(struct device *dev,
1114 struct device_attribute *attr, char *buf)
1116 struct gendisk *disk = dev_to_disk(dev);
1118 return sprintf(buf, "%x\n", disk->flags);
1121 static ssize_t disk_alignment_offset_show(struct device *dev,
1122 struct device_attribute *attr,
1123 char *buf)
1125 struct gendisk *disk = dev_to_disk(dev);
1127 return sprintf(buf, "%d\n", queue_alignment_offset(disk->queue));
1130 static ssize_t disk_discard_alignment_show(struct device *dev,
1131 struct device_attribute *attr,
1132 char *buf)
1134 struct gendisk *disk = dev_to_disk(dev);
1136 return sprintf(buf, "%d\n", queue_discard_alignment(disk->queue));
1139 static DEVICE_ATTR(range, 0444, disk_range_show, NULL);
1140 static DEVICE_ATTR(ext_range, 0444, disk_ext_range_show, NULL);
1141 static DEVICE_ATTR(removable, 0444, disk_removable_show, NULL);
1142 static DEVICE_ATTR(hidden, 0444, disk_hidden_show, NULL);
1143 static DEVICE_ATTR(ro, 0444, disk_ro_show, NULL);
1144 static DEVICE_ATTR(size, 0444, part_size_show, NULL);
1145 static DEVICE_ATTR(alignment_offset, 0444, disk_alignment_offset_show, NULL);
1146 static DEVICE_ATTR(discard_alignment, 0444, disk_discard_alignment_show, NULL);
1147 static DEVICE_ATTR(capability, 0444, disk_capability_show, NULL);
1148 static DEVICE_ATTR(stat, 0444, part_stat_show, NULL);
1149 static DEVICE_ATTR(inflight, 0444, part_inflight_show, NULL);
1150 static DEVICE_ATTR(badblocks, 0644, disk_badblocks_show, disk_badblocks_store);
1151 #ifdef CONFIG_FAIL_MAKE_REQUEST
1152 static struct device_attribute dev_attr_fail =
1153 __ATTR(make-it-fail, 0644, part_fail_show, part_fail_store);
1154 #endif
1155 #ifdef CONFIG_FAIL_IO_TIMEOUT
1156 static struct device_attribute dev_attr_fail_timeout =
1157 __ATTR(io-timeout-fail, 0644, part_timeout_show, part_timeout_store);
1158 #endif
1160 static struct attribute *disk_attrs[] = {
1161 &dev_attr_range.attr,
1162 &dev_attr_ext_range.attr,
1163 &dev_attr_removable.attr,
1164 &dev_attr_hidden.attr,
1165 &dev_attr_ro.attr,
1166 &dev_attr_size.attr,
1167 &dev_attr_alignment_offset.attr,
1168 &dev_attr_discard_alignment.attr,
1169 &dev_attr_capability.attr,
1170 &dev_attr_stat.attr,
1171 &dev_attr_inflight.attr,
1172 &dev_attr_badblocks.attr,
1173 #ifdef CONFIG_FAIL_MAKE_REQUEST
1174 &dev_attr_fail.attr,
1175 #endif
1176 #ifdef CONFIG_FAIL_IO_TIMEOUT
1177 &dev_attr_fail_timeout.attr,
1178 #endif
1179 NULL
1182 static umode_t disk_visible(struct kobject *kobj, struct attribute *a, int n)
1184 struct device *dev = container_of(kobj, typeof(*dev), kobj);
1185 struct gendisk *disk = dev_to_disk(dev);
1187 if (a == &dev_attr_badblocks.attr && !disk->bb)
1188 return 0;
1189 return a->mode;
1192 static struct attribute_group disk_attr_group = {
1193 .attrs = disk_attrs,
1194 .is_visible = disk_visible,
1197 static const struct attribute_group *disk_attr_groups[] = {
1198 &disk_attr_group,
1199 NULL
1203 * disk_replace_part_tbl - replace disk->part_tbl in RCU-safe way
1204 * @disk: disk to replace part_tbl for
1205 * @new_ptbl: new part_tbl to install
1207 * Replace disk->part_tbl with @new_ptbl in RCU-safe way. The
1208 * original ptbl is freed using RCU callback.
1210 * LOCKING:
1211 * Matching bd_mutex locked or the caller is the only user of @disk.
1213 static void disk_replace_part_tbl(struct gendisk *disk,
1214 struct disk_part_tbl *new_ptbl)
1216 struct disk_part_tbl *old_ptbl =
1217 rcu_dereference_protected(disk->part_tbl, 1);
1219 rcu_assign_pointer(disk->part_tbl, new_ptbl);
1221 if (old_ptbl) {
1222 rcu_assign_pointer(old_ptbl->last_lookup, NULL);
1223 kfree_rcu(old_ptbl, rcu_head);
1228 * disk_expand_part_tbl - expand disk->part_tbl
1229 * @disk: disk to expand part_tbl for
1230 * @partno: expand such that this partno can fit in
1232 * Expand disk->part_tbl such that @partno can fit in. disk->part_tbl
1233 * uses RCU to allow unlocked dereferencing for stats and other stuff.
1235 * LOCKING:
1236 * Matching bd_mutex locked or the caller is the only user of @disk.
1237 * Might sleep.
1239 * RETURNS:
1240 * 0 on success, -errno on failure.
1242 int disk_expand_part_tbl(struct gendisk *disk, int partno)
1244 struct disk_part_tbl *old_ptbl =
1245 rcu_dereference_protected(disk->part_tbl, 1);
1246 struct disk_part_tbl *new_ptbl;
1247 int len = old_ptbl ? old_ptbl->len : 0;
1248 int i, target;
1249 size_t size;
1252 * check for int overflow, since we can get here from blkpg_ioctl()
1253 * with a user passed 'partno'.
1255 target = partno + 1;
1256 if (target < 0)
1257 return -EINVAL;
1259 /* disk_max_parts() is zero during initialization, ignore if so */
1260 if (disk_max_parts(disk) && target > disk_max_parts(disk))
1261 return -EINVAL;
1263 if (target <= len)
1264 return 0;
1266 size = sizeof(*new_ptbl) + target * sizeof(new_ptbl->part[0]);
1267 new_ptbl = kzalloc_node(size, GFP_KERNEL, disk->node_id);
1268 if (!new_ptbl)
1269 return -ENOMEM;
1271 new_ptbl->len = target;
1273 for (i = 0; i < len; i++)
1274 rcu_assign_pointer(new_ptbl->part[i], old_ptbl->part[i]);
1276 disk_replace_part_tbl(disk, new_ptbl);
1277 return 0;
1280 static void disk_release(struct device *dev)
1282 struct gendisk *disk = dev_to_disk(dev);
1284 blk_free_devt(dev->devt);
1285 disk_release_events(disk);
1286 kfree(disk->random);
1287 disk_replace_part_tbl(disk, NULL);
1288 hd_free_part(&disk->part0);
1289 if (disk->queue)
1290 blk_put_queue(disk->queue);
1291 kfree(disk);
1293 struct class block_class = {
1294 .name = "block",
1297 static char *block_devnode(struct device *dev, umode_t *mode,
1298 kuid_t *uid, kgid_t *gid)
1300 struct gendisk *disk = dev_to_disk(dev);
1302 if (disk->devnode)
1303 return disk->devnode(disk, mode);
1304 return NULL;
1307 static const struct device_type disk_type = {
1308 .name = "disk",
1309 .groups = disk_attr_groups,
1310 .release = disk_release,
1311 .devnode = block_devnode,
1314 #ifdef CONFIG_PROC_FS
1316 * aggregate disk stat collector. Uses the same stats that the sysfs
1317 * entries do, above, but makes them available through one seq_file.
1319 * The output looks suspiciously like /proc/partitions with a bunch of
1320 * extra fields.
1322 static int diskstats_show(struct seq_file *seqf, void *v)
1324 struct gendisk *gp = v;
1325 struct disk_part_iter piter;
1326 struct hd_struct *hd;
1327 char buf[BDEVNAME_SIZE];
1328 unsigned int inflight[2];
1329 int cpu;
1332 if (&disk_to_dev(gp)->kobj.entry == block_class.devices.next)
1333 seq_puts(seqf, "major minor name"
1334 " rio rmerge rsect ruse wio wmerge "
1335 "wsect wuse running use aveq"
1336 "\n\n");
1339 disk_part_iter_init(&piter, gp, DISK_PITER_INCL_EMPTY_PART0);
1340 while ((hd = disk_part_iter_next(&piter))) {
1341 cpu = part_stat_lock();
1342 part_round_stats(gp->queue, cpu, hd);
1343 part_stat_unlock();
1344 part_in_flight(gp->queue, hd, inflight);
1345 seq_printf(seqf, "%4d %7d %s "
1346 "%lu %lu %lu %u "
1347 "%lu %lu %lu %u "
1348 "%u %u %u "
1349 "%lu %lu %lu %u\n",
1350 MAJOR(part_devt(hd)), MINOR(part_devt(hd)),
1351 disk_name(gp, hd->partno, buf),
1352 part_stat_read(hd, ios[STAT_READ]),
1353 part_stat_read(hd, merges[STAT_READ]),
1354 part_stat_read(hd, sectors[STAT_READ]),
1355 (unsigned int)part_stat_read_msecs(hd, STAT_READ),
1356 part_stat_read(hd, ios[STAT_WRITE]),
1357 part_stat_read(hd, merges[STAT_WRITE]),
1358 part_stat_read(hd, sectors[STAT_WRITE]),
1359 (unsigned int)part_stat_read_msecs(hd, STAT_WRITE),
1360 inflight[0],
1361 jiffies_to_msecs(part_stat_read(hd, io_ticks)),
1362 jiffies_to_msecs(part_stat_read(hd, time_in_queue)),
1363 part_stat_read(hd, ios[STAT_DISCARD]),
1364 part_stat_read(hd, merges[STAT_DISCARD]),
1365 part_stat_read(hd, sectors[STAT_DISCARD]),
1366 (unsigned int)part_stat_read_msecs(hd, STAT_DISCARD)
1369 disk_part_iter_exit(&piter);
1371 return 0;
1374 static const struct seq_operations diskstats_op = {
1375 .start = disk_seqf_start,
1376 .next = disk_seqf_next,
1377 .stop = disk_seqf_stop,
1378 .show = diskstats_show
1381 static int __init proc_genhd_init(void)
1383 proc_create_seq("diskstats", 0, NULL, &diskstats_op);
1384 proc_create_seq("partitions", 0, NULL, &partitions_op);
1385 return 0;
1387 module_init(proc_genhd_init);
1388 #endif /* CONFIG_PROC_FS */
1390 dev_t blk_lookup_devt(const char *name, int partno)
1392 dev_t devt = MKDEV(0, 0);
1393 struct class_dev_iter iter;
1394 struct device *dev;
1396 class_dev_iter_init(&iter, &block_class, NULL, &disk_type);
1397 while ((dev = class_dev_iter_next(&iter))) {
1398 struct gendisk *disk = dev_to_disk(dev);
1399 struct hd_struct *part;
1401 if (strcmp(dev_name(dev), name))
1402 continue;
1404 if (partno < disk->minors) {
1405 /* We need to return the right devno, even
1406 * if the partition doesn't exist yet.
1408 devt = MKDEV(MAJOR(dev->devt),
1409 MINOR(dev->devt) + partno);
1410 break;
1412 part = disk_get_part(disk, partno);
1413 if (part) {
1414 devt = part_devt(part);
1415 disk_put_part(part);
1416 break;
1418 disk_put_part(part);
1420 class_dev_iter_exit(&iter);
1421 return devt;
1423 EXPORT_SYMBOL(blk_lookup_devt);
1425 struct gendisk *__alloc_disk_node(int minors, int node_id)
1427 struct gendisk *disk;
1428 struct disk_part_tbl *ptbl;
1430 if (minors > DISK_MAX_PARTS) {
1431 printk(KERN_ERR
1432 "block: can't allocate more than %d partitions\n",
1433 DISK_MAX_PARTS);
1434 minors = DISK_MAX_PARTS;
1437 disk = kzalloc_node(sizeof(struct gendisk), GFP_KERNEL, node_id);
1438 if (disk) {
1439 if (!init_part_stats(&disk->part0)) {
1440 kfree(disk);
1441 return NULL;
1443 init_rwsem(&disk->lookup_sem);
1444 disk->node_id = node_id;
1445 if (disk_expand_part_tbl(disk, 0)) {
1446 free_part_stats(&disk->part0);
1447 kfree(disk);
1448 return NULL;
1450 ptbl = rcu_dereference_protected(disk->part_tbl, 1);
1451 rcu_assign_pointer(ptbl->part[0], &disk->part0);
1454 * set_capacity() and get_capacity() currently don't use
1455 * seqcounter to read/update the part0->nr_sects. Still init
1456 * the counter as we can read the sectors in IO submission
1457 * patch using seqence counters.
1459 * TODO: Ideally set_capacity() and get_capacity() should be
1460 * converted to make use of bd_mutex and sequence counters.
1462 seqcount_init(&disk->part0.nr_sects_seq);
1463 if (hd_ref_init(&disk->part0)) {
1464 hd_free_part(&disk->part0);
1465 kfree(disk);
1466 return NULL;
1469 disk->minors = minors;
1470 rand_initialize_disk(disk);
1471 disk_to_dev(disk)->class = &block_class;
1472 disk_to_dev(disk)->type = &disk_type;
1473 device_initialize(disk_to_dev(disk));
1475 return disk;
1477 EXPORT_SYMBOL(__alloc_disk_node);
1479 struct kobject *get_disk_and_module(struct gendisk *disk)
1481 struct module *owner;
1482 struct kobject *kobj;
1484 if (!disk->fops)
1485 return NULL;
1486 owner = disk->fops->owner;
1487 if (owner && !try_module_get(owner))
1488 return NULL;
1489 kobj = kobject_get_unless_zero(&disk_to_dev(disk)->kobj);
1490 if (kobj == NULL) {
1491 module_put(owner);
1492 return NULL;
1494 return kobj;
1497 EXPORT_SYMBOL(get_disk_and_module);
1499 void put_disk(struct gendisk *disk)
1501 if (disk)
1502 kobject_put(&disk_to_dev(disk)->kobj);
1504 EXPORT_SYMBOL(put_disk);
1507 * This is a counterpart of get_disk_and_module() and thus also of
1508 * get_gendisk().
1510 void put_disk_and_module(struct gendisk *disk)
1512 if (disk) {
1513 struct module *owner = disk->fops->owner;
1515 put_disk(disk);
1516 module_put(owner);
1519 EXPORT_SYMBOL(put_disk_and_module);
1521 static void set_disk_ro_uevent(struct gendisk *gd, int ro)
1523 char event[] = "DISK_RO=1";
1524 char *envp[] = { event, NULL };
1526 if (!ro)
1527 event[8] = '0';
1528 kobject_uevent_env(&disk_to_dev(gd)->kobj, KOBJ_CHANGE, envp);
1531 void set_device_ro(struct block_device *bdev, int flag)
1533 bdev->bd_part->policy = flag;
1536 EXPORT_SYMBOL(set_device_ro);
1538 void set_disk_ro(struct gendisk *disk, int flag)
1540 struct disk_part_iter piter;
1541 struct hd_struct *part;
1543 if (disk->part0.policy != flag) {
1544 set_disk_ro_uevent(disk, flag);
1545 disk->part0.policy = flag;
1548 disk_part_iter_init(&piter, disk, DISK_PITER_INCL_EMPTY);
1549 while ((part = disk_part_iter_next(&piter)))
1550 part->policy = flag;
1551 disk_part_iter_exit(&piter);
1554 EXPORT_SYMBOL(set_disk_ro);
1556 int bdev_read_only(struct block_device *bdev)
1558 if (!bdev)
1559 return 0;
1560 return bdev->bd_part->policy;
1563 EXPORT_SYMBOL(bdev_read_only);
1565 int invalidate_partition(struct gendisk *disk, int partno)
1567 int res = 0;
1568 struct block_device *bdev = bdget_disk(disk, partno);
1569 if (bdev) {
1570 fsync_bdev(bdev);
1571 res = __invalidate_device(bdev, true);
1572 bdput(bdev);
1574 return res;
1577 EXPORT_SYMBOL(invalidate_partition);
1580 * Disk events - monitor disk events like media change and eject request.
1582 struct disk_events {
1583 struct list_head node; /* all disk_event's */
1584 struct gendisk *disk; /* the associated disk */
1585 spinlock_t lock;
1587 struct mutex block_mutex; /* protects blocking */
1588 int block; /* event blocking depth */
1589 unsigned int pending; /* events already sent out */
1590 unsigned int clearing; /* events being cleared */
1592 long poll_msecs; /* interval, -1 for default */
1593 struct delayed_work dwork;
1596 static const char *disk_events_strs[] = {
1597 [ilog2(DISK_EVENT_MEDIA_CHANGE)] = "media_change",
1598 [ilog2(DISK_EVENT_EJECT_REQUEST)] = "eject_request",
1601 static char *disk_uevents[] = {
1602 [ilog2(DISK_EVENT_MEDIA_CHANGE)] = "DISK_MEDIA_CHANGE=1",
1603 [ilog2(DISK_EVENT_EJECT_REQUEST)] = "DISK_EJECT_REQUEST=1",
1606 /* list of all disk_events */
1607 static DEFINE_MUTEX(disk_events_mutex);
1608 static LIST_HEAD(disk_events);
1610 /* disable in-kernel polling by default */
1611 static unsigned long disk_events_dfl_poll_msecs;
1613 static unsigned long disk_events_poll_jiffies(struct gendisk *disk)
1615 struct disk_events *ev = disk->ev;
1616 long intv_msecs = 0;
1619 * If device-specific poll interval is set, always use it. If
1620 * the default is being used, poll iff there are events which
1621 * can't be monitored asynchronously.
1623 if (ev->poll_msecs >= 0)
1624 intv_msecs = ev->poll_msecs;
1625 else if (disk->events & ~disk->async_events)
1626 intv_msecs = disk_events_dfl_poll_msecs;
1628 return msecs_to_jiffies(intv_msecs);
1632 * disk_block_events - block and flush disk event checking
1633 * @disk: disk to block events for
1635 * On return from this function, it is guaranteed that event checking
1636 * isn't in progress and won't happen until unblocked by
1637 * disk_unblock_events(). Events blocking is counted and the actual
1638 * unblocking happens after the matching number of unblocks are done.
1640 * Note that this intentionally does not block event checking from
1641 * disk_clear_events().
1643 * CONTEXT:
1644 * Might sleep.
1646 void disk_block_events(struct gendisk *disk)
1648 struct disk_events *ev = disk->ev;
1649 unsigned long flags;
1650 bool cancel;
1652 if (!ev)
1653 return;
1656 * Outer mutex ensures that the first blocker completes canceling
1657 * the event work before further blockers are allowed to finish.
1659 mutex_lock(&ev->block_mutex);
1661 spin_lock_irqsave(&ev->lock, flags);
1662 cancel = !ev->block++;
1663 spin_unlock_irqrestore(&ev->lock, flags);
1665 if (cancel)
1666 cancel_delayed_work_sync(&disk->ev->dwork);
1668 mutex_unlock(&ev->block_mutex);
1671 static void __disk_unblock_events(struct gendisk *disk, bool check_now)
1673 struct disk_events *ev = disk->ev;
1674 unsigned long intv;
1675 unsigned long flags;
1677 spin_lock_irqsave(&ev->lock, flags);
1679 if (WARN_ON_ONCE(ev->block <= 0))
1680 goto out_unlock;
1682 if (--ev->block)
1683 goto out_unlock;
1685 intv = disk_events_poll_jiffies(disk);
1686 if (check_now)
1687 queue_delayed_work(system_freezable_power_efficient_wq,
1688 &ev->dwork, 0);
1689 else if (intv)
1690 queue_delayed_work(system_freezable_power_efficient_wq,
1691 &ev->dwork, intv);
1692 out_unlock:
1693 spin_unlock_irqrestore(&ev->lock, flags);
1697 * disk_unblock_events - unblock disk event checking
1698 * @disk: disk to unblock events for
1700 * Undo disk_block_events(). When the block count reaches zero, it
1701 * starts events polling if configured.
1703 * CONTEXT:
1704 * Don't care. Safe to call from irq context.
1706 void disk_unblock_events(struct gendisk *disk)
1708 if (disk->ev)
1709 __disk_unblock_events(disk, false);
1713 * disk_flush_events - schedule immediate event checking and flushing
1714 * @disk: disk to check and flush events for
1715 * @mask: events to flush
1717 * Schedule immediate event checking on @disk if not blocked. Events in
1718 * @mask are scheduled to be cleared from the driver. Note that this
1719 * doesn't clear the events from @disk->ev.
1721 * CONTEXT:
1722 * If @mask is non-zero must be called with bdev->bd_mutex held.
1724 void disk_flush_events(struct gendisk *disk, unsigned int mask)
1726 struct disk_events *ev = disk->ev;
1728 if (!ev)
1729 return;
1731 spin_lock_irq(&ev->lock);
1732 ev->clearing |= mask;
1733 if (!ev->block)
1734 mod_delayed_work(system_freezable_power_efficient_wq,
1735 &ev->dwork, 0);
1736 spin_unlock_irq(&ev->lock);
1740 * disk_clear_events - synchronously check, clear and return pending events
1741 * @disk: disk to fetch and clear events from
1742 * @mask: mask of events to be fetched and cleared
1744 * Disk events are synchronously checked and pending events in @mask
1745 * are cleared and returned. This ignores the block count.
1747 * CONTEXT:
1748 * Might sleep.
1750 unsigned int disk_clear_events(struct gendisk *disk, unsigned int mask)
1752 const struct block_device_operations *bdops = disk->fops;
1753 struct disk_events *ev = disk->ev;
1754 unsigned int pending;
1755 unsigned int clearing = mask;
1757 if (!ev) {
1758 /* for drivers still using the old ->media_changed method */
1759 if ((mask & DISK_EVENT_MEDIA_CHANGE) &&
1760 bdops->media_changed && bdops->media_changed(disk))
1761 return DISK_EVENT_MEDIA_CHANGE;
1762 return 0;
1765 disk_block_events(disk);
1768 * store the union of mask and ev->clearing on the stack so that the
1769 * race with disk_flush_events does not cause ambiguity (ev->clearing
1770 * can still be modified even if events are blocked).
1772 spin_lock_irq(&ev->lock);
1773 clearing |= ev->clearing;
1774 ev->clearing = 0;
1775 spin_unlock_irq(&ev->lock);
1777 disk_check_events(ev, &clearing);
1779 * if ev->clearing is not 0, the disk_flush_events got called in the
1780 * middle of this function, so we want to run the workfn without delay.
1782 __disk_unblock_events(disk, ev->clearing ? true : false);
1784 /* then, fetch and clear pending events */
1785 spin_lock_irq(&ev->lock);
1786 pending = ev->pending & mask;
1787 ev->pending &= ~mask;
1788 spin_unlock_irq(&ev->lock);
1789 WARN_ON_ONCE(clearing & mask);
1791 return pending;
1795 * Separate this part out so that a different pointer for clearing_ptr can be
1796 * passed in for disk_clear_events.
1798 static void disk_events_workfn(struct work_struct *work)
1800 struct delayed_work *dwork = to_delayed_work(work);
1801 struct disk_events *ev = container_of(dwork, struct disk_events, dwork);
1803 disk_check_events(ev, &ev->clearing);
1806 static void disk_check_events(struct disk_events *ev,
1807 unsigned int *clearing_ptr)
1809 struct gendisk *disk = ev->disk;
1810 char *envp[ARRAY_SIZE(disk_uevents) + 1] = { };
1811 unsigned int clearing = *clearing_ptr;
1812 unsigned int events;
1813 unsigned long intv;
1814 int nr_events = 0, i;
1816 /* check events */
1817 events = disk->fops->check_events(disk, clearing);
1819 /* accumulate pending events and schedule next poll if necessary */
1820 spin_lock_irq(&ev->lock);
1822 events &= ~ev->pending;
1823 ev->pending |= events;
1824 *clearing_ptr &= ~clearing;
1826 intv = disk_events_poll_jiffies(disk);
1827 if (!ev->block && intv)
1828 queue_delayed_work(system_freezable_power_efficient_wq,
1829 &ev->dwork, intv);
1831 spin_unlock_irq(&ev->lock);
1834 * Tell userland about new events. Only the events listed in
1835 * @disk->events are reported. Unlisted events are processed the
1836 * same internally but never get reported to userland.
1838 for (i = 0; i < ARRAY_SIZE(disk_uevents); i++)
1839 if (events & disk->events & (1 << i))
1840 envp[nr_events++] = disk_uevents[i];
1842 if (nr_events)
1843 kobject_uevent_env(&disk_to_dev(disk)->kobj, KOBJ_CHANGE, envp);
1847 * A disk events enabled device has the following sysfs nodes under
1848 * its /sys/block/X/ directory.
1850 * events : list of all supported events
1851 * events_async : list of events which can be detected w/o polling
1852 * events_poll_msecs : polling interval, 0: disable, -1: system default
1854 static ssize_t __disk_events_show(unsigned int events, char *buf)
1856 const char *delim = "";
1857 ssize_t pos = 0;
1858 int i;
1860 for (i = 0; i < ARRAY_SIZE(disk_events_strs); i++)
1861 if (events & (1 << i)) {
1862 pos += sprintf(buf + pos, "%s%s",
1863 delim, disk_events_strs[i]);
1864 delim = " ";
1866 if (pos)
1867 pos += sprintf(buf + pos, "\n");
1868 return pos;
1871 static ssize_t disk_events_show(struct device *dev,
1872 struct device_attribute *attr, char *buf)
1874 struct gendisk *disk = dev_to_disk(dev);
1876 return __disk_events_show(disk->events, buf);
1879 static ssize_t disk_events_async_show(struct device *dev,
1880 struct device_attribute *attr, char *buf)
1882 struct gendisk *disk = dev_to_disk(dev);
1884 return __disk_events_show(disk->async_events, buf);
1887 static ssize_t disk_events_poll_msecs_show(struct device *dev,
1888 struct device_attribute *attr,
1889 char *buf)
1891 struct gendisk *disk = dev_to_disk(dev);
1893 return sprintf(buf, "%ld\n", disk->ev->poll_msecs);
1896 static ssize_t disk_events_poll_msecs_store(struct device *dev,
1897 struct device_attribute *attr,
1898 const char *buf, size_t count)
1900 struct gendisk *disk = dev_to_disk(dev);
1901 long intv;
1903 if (!count || !sscanf(buf, "%ld", &intv))
1904 return -EINVAL;
1906 if (intv < 0 && intv != -1)
1907 return -EINVAL;
1909 disk_block_events(disk);
1910 disk->ev->poll_msecs = intv;
1911 __disk_unblock_events(disk, true);
1913 return count;
1916 static const DEVICE_ATTR(events, 0444, disk_events_show, NULL);
1917 static const DEVICE_ATTR(events_async, 0444, disk_events_async_show, NULL);
1918 static const DEVICE_ATTR(events_poll_msecs, 0644,
1919 disk_events_poll_msecs_show,
1920 disk_events_poll_msecs_store);
1922 static const struct attribute *disk_events_attrs[] = {
1923 &dev_attr_events.attr,
1924 &dev_attr_events_async.attr,
1925 &dev_attr_events_poll_msecs.attr,
1926 NULL,
1930 * The default polling interval can be specified by the kernel
1931 * parameter block.events_dfl_poll_msecs which defaults to 0
1932 * (disable). This can also be modified runtime by writing to
1933 * /sys/module/block/events_dfl_poll_msecs.
1935 static int disk_events_set_dfl_poll_msecs(const char *val,
1936 const struct kernel_param *kp)
1938 struct disk_events *ev;
1939 int ret;
1941 ret = param_set_ulong(val, kp);
1942 if (ret < 0)
1943 return ret;
1945 mutex_lock(&disk_events_mutex);
1947 list_for_each_entry(ev, &disk_events, node)
1948 disk_flush_events(ev->disk, 0);
1950 mutex_unlock(&disk_events_mutex);
1952 return 0;
1955 static const struct kernel_param_ops disk_events_dfl_poll_msecs_param_ops = {
1956 .set = disk_events_set_dfl_poll_msecs,
1957 .get = param_get_ulong,
1960 #undef MODULE_PARAM_PREFIX
1961 #define MODULE_PARAM_PREFIX "block."
1963 module_param_cb(events_dfl_poll_msecs, &disk_events_dfl_poll_msecs_param_ops,
1964 &disk_events_dfl_poll_msecs, 0644);
1967 * disk_{alloc|add|del|release}_events - initialize and destroy disk_events.
1969 static void disk_alloc_events(struct gendisk *disk)
1971 struct disk_events *ev;
1973 if (!disk->fops->check_events)
1974 return;
1976 ev = kzalloc(sizeof(*ev), GFP_KERNEL);
1977 if (!ev) {
1978 pr_warn("%s: failed to initialize events\n", disk->disk_name);
1979 return;
1982 INIT_LIST_HEAD(&ev->node);
1983 ev->disk = disk;
1984 spin_lock_init(&ev->lock);
1985 mutex_init(&ev->block_mutex);
1986 ev->block = 1;
1987 ev->poll_msecs = -1;
1988 INIT_DELAYED_WORK(&ev->dwork, disk_events_workfn);
1990 disk->ev = ev;
1993 static void disk_add_events(struct gendisk *disk)
1995 if (!disk->ev)
1996 return;
1998 /* FIXME: error handling */
1999 if (sysfs_create_files(&disk_to_dev(disk)->kobj, disk_events_attrs) < 0)
2000 pr_warn("%s: failed to create sysfs files for events\n",
2001 disk->disk_name);
2003 mutex_lock(&disk_events_mutex);
2004 list_add_tail(&disk->ev->node, &disk_events);
2005 mutex_unlock(&disk_events_mutex);
2008 * Block count is initialized to 1 and the following initial
2009 * unblock kicks it into action.
2011 __disk_unblock_events(disk, true);
2014 static void disk_del_events(struct gendisk *disk)
2016 if (!disk->ev)
2017 return;
2019 disk_block_events(disk);
2021 mutex_lock(&disk_events_mutex);
2022 list_del_init(&disk->ev->node);
2023 mutex_unlock(&disk_events_mutex);
2025 sysfs_remove_files(&disk_to_dev(disk)->kobj, disk_events_attrs);
2028 static void disk_release_events(struct gendisk *disk)
2030 /* the block count should be 1 from disk_del_events() */
2031 WARN_ON_ONCE(disk->ev && disk->ev->block != 1);
2032 kfree(disk->ev);