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