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