blob: ad6826628e79816c671d173d6cd47f9fe793313f [file] [log] [blame]
Christoph Hellwig3dcf60b2019-04-30 14:42:43 -04001// SPDX-License-Identifier: GPL-2.0
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
3 * gendisk handling
4 */
5
Linus Torvalds1da177e2005-04-16 15:20:36 -07006#include <linux/module.h>
7#include <linux/fs.h>
8#include <linux/genhd.h>
Andrew Mortonb446b602007-02-20 13:57:48 -08009#include <linux/kdev_t.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070010#include <linux/kernel.h>
11#include <linux/blkdev.h>
Tejun Heo66114ca2015-05-22 17:13:32 -040012#include <linux/backing-dev.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070013#include <linux/init.h>
14#include <linux/spinlock.h>
Alexey Dobriyanf5009752008-10-04 23:53:21 +040015#include <linux/proc_fs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#include <linux/seq_file.h>
17#include <linux/slab.h>
18#include <linux/kmod.h>
19#include <linux/kobj_map.h>
Jes Sorensen58383af2006-02-06 14:12:43 -080020#include <linux/mutex.h>
Tejun Heobcce3de2008-08-25 19:47:22 +090021#include <linux/idr.h>
Tejun Heo77ea8872010-12-08 20:57:37 +010022#include <linux/log2.h>
Ming Lei25e823c2013-02-22 16:34:13 -080023#include <linux/pm_runtime.h>
Vishal Verma99e66082016-01-09 08:36:51 -080024#include <linux/badblocks.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025
Adrian Bunkff889722008-03-04 11:23:45 +010026#include "blk.h"
27
Kay Sieversedfaa7c2007-05-21 22:08:01 +020028static DEFINE_MUTEX(block_class_lock);
Kay Sieversedfaa7c2007-05-21 22:08:01 +020029struct kobject *block_depr;
Linus Torvalds1da177e2005-04-16 15:20:36 -070030
Tejun Heobcce3de2008-08-25 19:47:22 +090031/* for extended dynamic devt allocation, currently only one major is used */
Tejun Heoce23bba2013-02-27 17:03:56 -080032#define NR_EXT_DEVT (1 << MINORBITS)
Tejun Heobcce3de2008-08-25 19:47:22 +090033
Keith Busch2da78092014-08-26 09:05:36 -060034/* For extended devt allocation. ext_devt_lock prevents look up
Tejun Heobcce3de2008-08-25 19:47:22 +090035 * results from going away underneath its user.
36 */
Keith Busch2da78092014-08-26 09:05:36 -060037static DEFINE_SPINLOCK(ext_devt_lock);
Tejun Heobcce3de2008-08-25 19:47:22 +090038static DEFINE_IDR(ext_devt_idr);
39
Bart Van Asscheedf8ff52017-06-20 11:15:48 -070040static const struct device_type disk_type;
Adrian Bunk1826ead2008-03-04 11:23:46 +010041
Derek Basehore12c2bdb2012-12-18 12:27:20 -080042static void disk_check_events(struct disk_events *ev,
43 unsigned int *clearing_ptr);
Stanislaw Gruszka9f53d2fe2012-03-02 10:43:28 +010044static void disk_alloc_events(struct gendisk *disk);
Tejun Heo77ea8872010-12-08 20:57:37 +010045static void disk_add_events(struct gendisk *disk);
46static void disk_del_events(struct gendisk *disk);
47static void disk_release_events(struct gendisk *disk);
48
Jens Axboef299b7c2017-08-08 17:51:45 -060049void part_inc_in_flight(struct request_queue *q, struct hd_struct *part, int rw)
50{
Jens Axboe344e9ff2018-11-15 12:22:51 -070051 if (queue_is_mq(q))
Jens Axboef299b7c2017-08-08 17:51:45 -060052 return;
53
Mikulas Patocka1226b8d2018-12-06 11:41:20 -050054 part_stat_local_inc(part, in_flight[rw]);
Jens Axboef299b7c2017-08-08 17:51:45 -060055 if (part->partno)
Mikulas Patocka1226b8d2018-12-06 11:41:20 -050056 part_stat_local_inc(&part_to_disk(part)->part0, in_flight[rw]);
Jens Axboef299b7c2017-08-08 17:51:45 -060057}
58
59void part_dec_in_flight(struct request_queue *q, struct hd_struct *part, int rw)
60{
Jens Axboe344e9ff2018-11-15 12:22:51 -070061 if (queue_is_mq(q))
Jens Axboef299b7c2017-08-08 17:51:45 -060062 return;
63
Mikulas Patocka1226b8d2018-12-06 11:41:20 -050064 part_stat_local_dec(part, in_flight[rw]);
Jens Axboef299b7c2017-08-08 17:51:45 -060065 if (part->partno)
Mikulas Patocka1226b8d2018-12-06 11:41:20 -050066 part_stat_local_dec(&part_to_disk(part)->part0, in_flight[rw]);
Jens Axboef299b7c2017-08-08 17:51:45 -060067}
68
Mikulas Patockae016b782018-12-06 11:41:21 -050069unsigned int part_in_flight(struct request_queue *q, struct hd_struct *part)
Jens Axboef299b7c2017-08-08 17:51:45 -060070{
Mikulas Patocka1226b8d2018-12-06 11:41:20 -050071 int cpu;
Mikulas Patockae016b782018-12-06 11:41:21 -050072 unsigned int inflight;
Mikulas Patocka1226b8d2018-12-06 11:41:20 -050073
Jens Axboe344e9ff2018-11-15 12:22:51 -070074 if (queue_is_mq(q)) {
Mikulas Patockae016b782018-12-06 11:41:21 -050075 return blk_mq_in_flight(q, part);
Jens Axboef299b7c2017-08-08 17:51:45 -060076 }
77
Mikulas Patockae016b782018-12-06 11:41:21 -050078 inflight = 0;
Mikulas Patocka1226b8d2018-12-06 11:41:20 -050079 for_each_possible_cpu(cpu) {
Mikulas Patockae016b782018-12-06 11:41:21 -050080 inflight += part_stat_local_read_cpu(part, in_flight[0], cpu) +
81 part_stat_local_read_cpu(part, in_flight[1], cpu);
Mikulas Patocka1226b8d2018-12-06 11:41:20 -050082 }
Mikulas Patockae016b782018-12-06 11:41:21 -050083 if ((int)inflight < 0)
84 inflight = 0;
Mikulas Patocka1226b8d2018-12-06 11:41:20 -050085
Mikulas Patockae016b782018-12-06 11:41:21 -050086 return inflight;
Jens Axboef299b7c2017-08-08 17:51:45 -060087}
88
Omar Sandovalbf0ddab2018-04-26 00:21:59 -070089void part_in_flight_rw(struct request_queue *q, struct hd_struct *part,
90 unsigned int inflight[2])
91{
Mikulas Patocka1226b8d2018-12-06 11:41:20 -050092 int cpu;
93
Jens Axboe344e9ff2018-11-15 12:22:51 -070094 if (queue_is_mq(q)) {
Omar Sandovalbf0ddab2018-04-26 00:21:59 -070095 blk_mq_in_flight_rw(q, part, inflight);
96 return;
97 }
98
Mikulas Patocka1226b8d2018-12-06 11:41:20 -050099 inflight[0] = 0;
100 inflight[1] = 0;
101 for_each_possible_cpu(cpu) {
102 inflight[0] += part_stat_local_read_cpu(part, in_flight[0], cpu);
103 inflight[1] += part_stat_local_read_cpu(part, in_flight[1], cpu);
104 }
105 if ((int)inflight[0] < 0)
106 inflight[0] = 0;
107 if ((int)inflight[1] < 0)
108 inflight[1] = 0;
Omar Sandovalbf0ddab2018-04-26 00:21:59 -0700109}
110
Christoph Hellwig807d4af2017-08-23 19:10:30 +0200111struct hd_struct *__disk_get_part(struct gendisk *disk, int partno)
112{
113 struct disk_part_tbl *ptbl = rcu_dereference(disk->part_tbl);
114
115 if (unlikely(partno < 0 || partno >= ptbl->len))
116 return NULL;
117 return rcu_dereference(ptbl->part[partno]);
118}
119
Tejun Heoe71bf0d2008-09-03 09:03:02 +0200120/**
121 * disk_get_part - get partition
122 * @disk: disk to look partition from
123 * @partno: partition number
124 *
125 * Look for partition @partno from @disk. If found, increment
126 * reference count and return it.
127 *
128 * CONTEXT:
129 * Don't care.
130 *
131 * RETURNS:
132 * Pointer to the found partition on success, NULL if not found.
133 */
134struct hd_struct *disk_get_part(struct gendisk *disk, int partno)
135{
Christoph Hellwig807d4af2017-08-23 19:10:30 +0200136 struct hd_struct *part;
Tejun Heo540eed52008-08-25 19:56:15 +0900137
Tejun Heoe71bf0d2008-09-03 09:03:02 +0200138 rcu_read_lock();
Christoph Hellwig807d4af2017-08-23 19:10:30 +0200139 part = __disk_get_part(disk, partno);
140 if (part)
141 get_device(part_to_dev(part));
Tejun Heoe71bf0d2008-09-03 09:03:02 +0200142 rcu_read_unlock();
143
144 return part;
145}
146EXPORT_SYMBOL_GPL(disk_get_part);
147
148/**
149 * disk_part_iter_init - initialize partition iterator
150 * @piter: iterator to initialize
151 * @disk: disk to iterate over
152 * @flags: DISK_PITER_* flags
153 *
154 * Initialize @piter so that it iterates over partitions of @disk.
155 *
156 * CONTEXT:
157 * Don't care.
158 */
159void disk_part_iter_init(struct disk_part_iter *piter, struct gendisk *disk,
160 unsigned int flags)
161{
Tejun Heo540eed52008-08-25 19:56:15 +0900162 struct disk_part_tbl *ptbl;
163
164 rcu_read_lock();
165 ptbl = rcu_dereference(disk->part_tbl);
166
Tejun Heoe71bf0d2008-09-03 09:03:02 +0200167 piter->disk = disk;
168 piter->part = NULL;
169
170 if (flags & DISK_PITER_REVERSE)
Tejun Heo540eed52008-08-25 19:56:15 +0900171 piter->idx = ptbl->len - 1;
Tejun Heo71982a42009-04-17 08:34:48 +0200172 else if (flags & (DISK_PITER_INCL_PART0 | DISK_PITER_INCL_EMPTY_PART0))
Tejun Heoe71bf0d2008-09-03 09:03:02 +0200173 piter->idx = 0;
Tejun Heob5d0b9d2008-09-03 09:06:42 +0200174 else
175 piter->idx = 1;
Tejun Heoe71bf0d2008-09-03 09:03:02 +0200176
177 piter->flags = flags;
Tejun Heo540eed52008-08-25 19:56:15 +0900178
179 rcu_read_unlock();
Tejun Heoe71bf0d2008-09-03 09:03:02 +0200180}
181EXPORT_SYMBOL_GPL(disk_part_iter_init);
182
183/**
184 * disk_part_iter_next - proceed iterator to the next partition and return it
185 * @piter: iterator of interest
186 *
187 * Proceed @piter to the next partition and return it.
188 *
189 * CONTEXT:
190 * Don't care.
191 */
192struct hd_struct *disk_part_iter_next(struct disk_part_iter *piter)
193{
Tejun Heo540eed52008-08-25 19:56:15 +0900194 struct disk_part_tbl *ptbl;
Tejun Heoe71bf0d2008-09-03 09:03:02 +0200195 int inc, end;
196
197 /* put the last partition */
198 disk_put_part(piter->part);
199 piter->part = NULL;
200
Tejun Heo540eed52008-08-25 19:56:15 +0900201 /* get part_tbl */
Tejun Heoe71bf0d2008-09-03 09:03:02 +0200202 rcu_read_lock();
Tejun Heo540eed52008-08-25 19:56:15 +0900203 ptbl = rcu_dereference(piter->disk->part_tbl);
Tejun Heoe71bf0d2008-09-03 09:03:02 +0200204
205 /* determine iteration parameters */
206 if (piter->flags & DISK_PITER_REVERSE) {
207 inc = -1;
Tejun Heo71982a42009-04-17 08:34:48 +0200208 if (piter->flags & (DISK_PITER_INCL_PART0 |
209 DISK_PITER_INCL_EMPTY_PART0))
Tejun Heob5d0b9d2008-09-03 09:06:42 +0200210 end = -1;
211 else
212 end = 0;
Tejun Heoe71bf0d2008-09-03 09:03:02 +0200213 } else {
214 inc = 1;
Tejun Heo540eed52008-08-25 19:56:15 +0900215 end = ptbl->len;
Tejun Heoe71bf0d2008-09-03 09:03:02 +0200216 }
217
218 /* iterate to the next partition */
219 for (; piter->idx != end; piter->idx += inc) {
220 struct hd_struct *part;
221
Tejun Heo540eed52008-08-25 19:56:15 +0900222 part = rcu_dereference(ptbl->part[piter->idx]);
Tejun Heoe71bf0d2008-09-03 09:03:02 +0200223 if (!part)
224 continue;
Vivek Goyalc83f6bf2012-08-01 12:24:18 +0200225 if (!part_nr_sects_read(part) &&
Tejun Heo71982a42009-04-17 08:34:48 +0200226 !(piter->flags & DISK_PITER_INCL_EMPTY) &&
227 !(piter->flags & DISK_PITER_INCL_EMPTY_PART0 &&
228 piter->idx == 0))
Tejun Heoe71bf0d2008-09-03 09:03:02 +0200229 continue;
230
Tejun Heoed9e1982008-08-25 19:56:05 +0900231 get_device(part_to_dev(part));
Tejun Heoe71bf0d2008-09-03 09:03:02 +0200232 piter->part = part;
233 piter->idx += inc;
234 break;
235 }
236
237 rcu_read_unlock();
238
239 return piter->part;
240}
241EXPORT_SYMBOL_GPL(disk_part_iter_next);
242
243/**
244 * disk_part_iter_exit - finish up partition iteration
245 * @piter: iter of interest
246 *
247 * Called when iteration is over. Cleans up @piter.
248 *
249 * CONTEXT:
250 * Don't care.
251 */
252void disk_part_iter_exit(struct disk_part_iter *piter)
253{
254 disk_put_part(piter->part);
255 piter->part = NULL;
256}
257EXPORT_SYMBOL_GPL(disk_part_iter_exit);
258
Jens Axboea6f23652008-10-24 12:52:42 +0200259static inline int sector_in_part(struct hd_struct *part, sector_t sector)
260{
261 return part->start_sect <= sector &&
Vivek Goyalc83f6bf2012-08-01 12:24:18 +0200262 sector < part->start_sect + part_nr_sects_read(part);
Jens Axboea6f23652008-10-24 12:52:42 +0200263}
264
Tejun Heoe71bf0d2008-09-03 09:03:02 +0200265/**
266 * disk_map_sector_rcu - map sector to partition
267 * @disk: gendisk of interest
268 * @sector: sector to map
269 *
270 * Find out which partition @sector maps to on @disk. This is
271 * primarily used for stats accounting.
272 *
273 * CONTEXT:
274 * RCU read locked. The returned partition pointer is valid only
275 * while preemption is disabled.
276 *
277 * RETURNS:
Tejun Heo074a7ac2008-08-25 19:56:14 +0900278 * Found partition on success, part0 is returned if no partition matches
Tejun Heoe71bf0d2008-09-03 09:03:02 +0200279 */
280struct hd_struct *disk_map_sector_rcu(struct gendisk *disk, sector_t sector)
281{
Tejun Heo540eed52008-08-25 19:56:15 +0900282 struct disk_part_tbl *ptbl;
Jens Axboea6f23652008-10-24 12:52:42 +0200283 struct hd_struct *part;
Tejun Heoe71bf0d2008-09-03 09:03:02 +0200284 int i;
285
Tejun Heo540eed52008-08-25 19:56:15 +0900286 ptbl = rcu_dereference(disk->part_tbl);
287
Jens Axboea6f23652008-10-24 12:52:42 +0200288 part = rcu_dereference(ptbl->last_lookup);
289 if (part && sector_in_part(part, sector))
290 return part;
Tejun Heoe71bf0d2008-09-03 09:03:02 +0200291
Jens Axboea6f23652008-10-24 12:52:42 +0200292 for (i = 1; i < ptbl->len; i++) {
293 part = rcu_dereference(ptbl->part[i]);
294
295 if (part && sector_in_part(part, sector)) {
296 rcu_assign_pointer(ptbl->last_lookup, part);
Tejun Heoe71bf0d2008-09-03 09:03:02 +0200297 return part;
Jens Axboea6f23652008-10-24 12:52:42 +0200298 }
Tejun Heoe71bf0d2008-09-03 09:03:02 +0200299 }
Tejun Heo074a7ac2008-08-25 19:56:14 +0900300 return &disk->part0;
Tejun Heoe71bf0d2008-09-03 09:03:02 +0200301}
302EXPORT_SYMBOL_GPL(disk_map_sector_rcu);
303
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304/*
305 * Can be deleted altogether. Later.
306 *
307 */
Logan Gunthorpe133d55c2017-06-16 17:48:21 -0600308#define BLKDEV_MAJOR_HASH_SIZE 255
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309static struct blk_major_name {
310 struct blk_major_name *next;
311 int major;
312 char name[16];
Joe Korty68eef3b2006-03-31 02:30:32 -0800313} *major_names[BLKDEV_MAJOR_HASH_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314
315/* index in the above - for now: assume no multimajor ranges */
Yang Zhange61eb2e2010-12-17 09:00:18 +0100316static inline int major_to_index(unsigned major)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317{
Joe Korty68eef3b2006-03-31 02:30:32 -0800318 return major % BLKDEV_MAJOR_HASH_SIZE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319}
320
Joe Korty68eef3b2006-03-31 02:30:32 -0800321#ifdef CONFIG_PROC_FS
Tejun Heocf771cb2008-09-03 09:01:09 +0200322void blkdev_show(struct seq_file *seqf, off_t offset)
Neil Horman7170be52006-01-14 13:20:38 -0800323{
Joe Korty68eef3b2006-03-31 02:30:32 -0800324 struct blk_major_name *dp;
Neil Horman7170be52006-01-14 13:20:38 -0800325
Logan Gunthorpe133d55c2017-06-16 17:48:21 -0600326 mutex_lock(&block_class_lock);
327 for (dp = major_names[major_to_index(offset)]; dp; dp = dp->next)
328 if (dp->major == offset)
Tejun Heocf771cb2008-09-03 09:01:09 +0200329 seq_printf(seqf, "%3d %s\n", dp->major, dp->name);
Logan Gunthorpe133d55c2017-06-16 17:48:21 -0600330 mutex_unlock(&block_class_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331}
Joe Korty68eef3b2006-03-31 02:30:32 -0800332#endif /* CONFIG_PROC_FS */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333
Márton Németh9e8c0bc2009-02-20 08:12:51 +0100334/**
335 * register_blkdev - register a new block device
336 *
Srivatsa S. Bhatf33ff112018-02-05 18:25:27 -0800337 * @major: the requested major device number [1..BLKDEV_MAJOR_MAX-1]. If
338 * @major = 0, try to allocate any unused major number.
Márton Németh9e8c0bc2009-02-20 08:12:51 +0100339 * @name: the name of the new block device as a zero terminated string
340 *
341 * The @name must be unique within the system.
342 *
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -0300343 * The return value depends on the @major input parameter:
344 *
Srivatsa S. Bhatf33ff112018-02-05 18:25:27 -0800345 * - if a major device number was requested in range [1..BLKDEV_MAJOR_MAX-1]
346 * then the function returns zero on success, or a negative error code
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -0300347 * - if any unused major number was requested with @major = 0 parameter
Márton Németh9e8c0bc2009-02-20 08:12:51 +0100348 * then the return value is the allocated major number in range
Srivatsa S. Bhatf33ff112018-02-05 18:25:27 -0800349 * [1..BLKDEV_MAJOR_MAX-1] or a negative error code otherwise
350 *
351 * See Documentation/admin-guide/devices.txt for the list of allocated
352 * major numbers.
Márton Németh9e8c0bc2009-02-20 08:12:51 +0100353 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354int register_blkdev(unsigned int major, const char *name)
355{
356 struct blk_major_name **n, *p;
357 int index, ret = 0;
358
Kay Sieversedfaa7c2007-05-21 22:08:01 +0200359 mutex_lock(&block_class_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360
361 /* temporary */
362 if (major == 0) {
363 for (index = ARRAY_SIZE(major_names)-1; index > 0; index--) {
364 if (major_names[index] == NULL)
365 break;
366 }
367
368 if (index == 0) {
Keyur Pateldfc76d12019-02-17 10:21:56 -0500369 printk("%s: failed to get major for %s\n",
370 __func__, name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371 ret = -EBUSY;
372 goto out;
373 }
374 major = index;
375 ret = major;
376 }
377
Logan Gunthorpe133d55c2017-06-16 17:48:21 -0600378 if (major >= BLKDEV_MAJOR_MAX) {
Keyur Pateldfc76d12019-02-17 10:21:56 -0500379 pr_err("%s: major requested (%u) is greater than the maximum (%u) for %s\n",
380 __func__, major, BLKDEV_MAJOR_MAX-1, name);
Logan Gunthorpe133d55c2017-06-16 17:48:21 -0600381
382 ret = -EINVAL;
383 goto out;
384 }
385
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386 p = kmalloc(sizeof(struct blk_major_name), GFP_KERNEL);
387 if (p == NULL) {
388 ret = -ENOMEM;
389 goto out;
390 }
391
392 p->major = major;
393 strlcpy(p->name, name, sizeof(p->name));
394 p->next = NULL;
395 index = major_to_index(major);
396
397 for (n = &major_names[index]; *n; n = &(*n)->next) {
398 if ((*n)->major == major)
399 break;
400 }
401 if (!*n)
402 *n = p;
403 else
404 ret = -EBUSY;
405
406 if (ret < 0) {
Srivatsa S. Bhatf33ff112018-02-05 18:25:27 -0800407 printk("register_blkdev: cannot get major %u for %s\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408 major, name);
409 kfree(p);
410 }
411out:
Kay Sieversedfaa7c2007-05-21 22:08:01 +0200412 mutex_unlock(&block_class_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413 return ret;
414}
415
416EXPORT_SYMBOL(register_blkdev);
417
Akinobu Mitaf4480242007-07-17 04:03:47 -0700418void unregister_blkdev(unsigned int major, const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419{
420 struct blk_major_name **n;
421 struct blk_major_name *p = NULL;
422 int index = major_to_index(major);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423
Kay Sieversedfaa7c2007-05-21 22:08:01 +0200424 mutex_lock(&block_class_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 for (n = &major_names[index]; *n; n = &(*n)->next)
426 if ((*n)->major == major)
427 break;
Akinobu Mita294462a2007-07-17 04:03:45 -0700428 if (!*n || strcmp((*n)->name, name)) {
429 WARN_ON(1);
Akinobu Mita294462a2007-07-17 04:03:45 -0700430 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 p = *n;
432 *n = p->next;
433 }
Kay Sieversedfaa7c2007-05-21 22:08:01 +0200434 mutex_unlock(&block_class_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435 kfree(p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436}
437
438EXPORT_SYMBOL(unregister_blkdev);
439
440static struct kobj_map *bdev_map;
441
Tejun Heobcce3de2008-08-25 19:47:22 +0900442/**
Tejun Heo870d6652008-08-25 19:47:25 +0900443 * blk_mangle_minor - scatter minor numbers apart
444 * @minor: minor number to mangle
445 *
446 * Scatter consecutively allocated @minor number apart if MANGLE_DEVT
447 * is enabled. Mangling twice gives the original value.
448 *
449 * RETURNS:
450 * Mangled value.
451 *
452 * CONTEXT:
453 * Don't care.
454 */
455static int blk_mangle_minor(int minor)
456{
457#ifdef CONFIG_DEBUG_BLOCK_EXT_DEVT
458 int i;
459
460 for (i = 0; i < MINORBITS / 2; i++) {
461 int low = minor & (1 << i);
462 int high = minor & (1 << (MINORBITS - 1 - i));
463 int distance = MINORBITS - 1 - 2 * i;
464
465 minor ^= low | high; /* clear both bits */
466 low <<= distance; /* swap the positions */
467 high >>= distance;
468 minor |= low | high; /* and set */
469 }
470#endif
471 return minor;
472}
473
474/**
Tejun Heobcce3de2008-08-25 19:47:22 +0900475 * blk_alloc_devt - allocate a dev_t for a partition
476 * @part: partition to allocate dev_t for
Tejun Heobcce3de2008-08-25 19:47:22 +0900477 * @devt: out parameter for resulting dev_t
478 *
479 * Allocate a dev_t for block device.
480 *
481 * RETURNS:
482 * 0 on success, allocated dev_t is returned in *@devt. -errno on
483 * failure.
484 *
485 * CONTEXT:
486 * Might sleep.
487 */
488int blk_alloc_devt(struct hd_struct *part, dev_t *devt)
489{
490 struct gendisk *disk = part_to_disk(part);
Tejun Heobab998d2013-02-27 17:03:57 -0800491 int idx;
Tejun Heobcce3de2008-08-25 19:47:22 +0900492
493 /* in consecutive minor range? */
494 if (part->partno < disk->minors) {
495 *devt = MKDEV(disk->major, disk->first_minor + part->partno);
496 return 0;
497 }
498
499 /* allocate ext devt */
Keith Busch2da78092014-08-26 09:05:36 -0600500 idr_preload(GFP_KERNEL);
501
Dan Williams4d66e5e2015-06-10 23:47:14 -0400502 spin_lock_bh(&ext_devt_lock);
Keith Busch2da78092014-08-26 09:05:36 -0600503 idx = idr_alloc(&ext_devt_idr, part, 0, NR_EXT_DEVT, GFP_NOWAIT);
Dan Williams4d66e5e2015-06-10 23:47:14 -0400504 spin_unlock_bh(&ext_devt_lock);
Keith Busch2da78092014-08-26 09:05:36 -0600505
506 idr_preload_end();
Tejun Heobab998d2013-02-27 17:03:57 -0800507 if (idx < 0)
508 return idx == -ENOSPC ? -EBUSY : idx;
Tejun Heobcce3de2008-08-25 19:47:22 +0900509
Tejun Heo870d6652008-08-25 19:47:25 +0900510 *devt = MKDEV(BLOCK_EXT_MAJOR, blk_mangle_minor(idx));
Tejun Heobcce3de2008-08-25 19:47:22 +0900511 return 0;
512}
513
514/**
515 * blk_free_devt - free a dev_t
516 * @devt: dev_t to free
517 *
518 * Free @devt which was allocated using blk_alloc_devt().
519 *
520 * CONTEXT:
521 * Might sleep.
522 */
523void blk_free_devt(dev_t devt)
524{
Tejun Heobcce3de2008-08-25 19:47:22 +0900525 if (devt == MKDEV(0, 0))
526 return;
527
528 if (MAJOR(devt) == BLOCK_EXT_MAJOR) {
Dan Williams4d66e5e2015-06-10 23:47:14 -0400529 spin_lock_bh(&ext_devt_lock);
Tejun Heo870d6652008-08-25 19:47:25 +0900530 idr_remove(&ext_devt_idr, blk_mangle_minor(MINOR(devt)));
Dan Williams4d66e5e2015-06-10 23:47:14 -0400531 spin_unlock_bh(&ext_devt_lock);
Tejun Heobcce3de2008-08-25 19:47:22 +0900532 }
533}
534
Yufen Yu6fcc44d2019-04-02 20:06:34 +0800535/**
536 * We invalidate devt by assigning NULL pointer for devt in idr.
537 */
538void blk_invalidate_devt(dev_t devt)
539{
540 if (MAJOR(devt) == BLOCK_EXT_MAJOR) {
541 spin_lock_bh(&ext_devt_lock);
542 idr_replace(&ext_devt_idr, NULL, blk_mangle_minor(MINOR(devt)));
543 spin_unlock_bh(&ext_devt_lock);
544 }
545}
546
Tejun Heo1f014292008-08-25 19:47:23 +0900547static char *bdevt_str(dev_t devt, char *buf)
548{
549 if (MAJOR(devt) <= 0xff && MINOR(devt) <= 0xff) {
550 char tbuf[BDEVT_SIZE];
551 snprintf(tbuf, BDEVT_SIZE, "%02x%02x", MAJOR(devt), MINOR(devt));
552 snprintf(buf, BDEVT_SIZE, "%-9s", tbuf);
553 } else
554 snprintf(buf, BDEVT_SIZE, "%03x:%05x", MAJOR(devt), MINOR(devt));
555
556 return buf;
557}
558
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559/*
560 * Register device numbers dev..(dev+range-1)
561 * range must be nonzero
562 * The hash chain is sorted on range, so that subranges can override.
563 */
Kay Sieversedfaa7c2007-05-21 22:08:01 +0200564void blk_register_region(dev_t devt, unsigned long range, struct module *module,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565 struct kobject *(*probe)(dev_t, int *, void *),
566 int (*lock)(dev_t, void *), void *data)
567{
Kay Sieversedfaa7c2007-05-21 22:08:01 +0200568 kobj_map(bdev_map, devt, range, module, probe, lock, data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569}
570
571EXPORT_SYMBOL(blk_register_region);
572
Kay Sieversedfaa7c2007-05-21 22:08:01 +0200573void blk_unregister_region(dev_t devt, unsigned long range)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574{
Kay Sieversedfaa7c2007-05-21 22:08:01 +0200575 kobj_unmap(bdev_map, devt, range);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576}
577
578EXPORT_SYMBOL(blk_unregister_region);
579
Tejun Heocf771cb2008-09-03 09:01:09 +0200580static struct kobject *exact_match(dev_t devt, int *partno, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581{
582 struct gendisk *p = data;
Kay Sieversedfaa7c2007-05-21 22:08:01 +0200583
Tejun Heoed9e1982008-08-25 19:56:05 +0900584 return &disk_to_dev(p)->kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585}
586
Kay Sieversedfaa7c2007-05-21 22:08:01 +0200587static int exact_lock(dev_t devt, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588{
589 struct gendisk *p = data;
590
Jan Kara3079c222018-02-26 13:01:38 +0100591 if (!get_disk_and_module(p))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592 return -1;
593 return 0;
594}
595
Hannes Reineckefef912b2018-09-28 08:17:19 +0200596static void register_disk(struct device *parent, struct gendisk *disk,
597 const struct attribute_group **groups)
Tejun Heod2bf1b62010-12-08 20:57:36 +0100598{
599 struct device *ddev = disk_to_dev(disk);
600 struct block_device *bdev;
601 struct disk_part_iter piter;
602 struct hd_struct *part;
603 int err;
604
Dan Williamse63a46b2016-06-15 18:17:27 -0700605 ddev->parent = parent;
Tejun Heod2bf1b62010-12-08 20:57:36 +0100606
Kees Cookffc8b302013-07-03 15:01:14 -0700607 dev_set_name(ddev, "%s", disk->disk_name);
Tejun Heod2bf1b62010-12-08 20:57:36 +0100608
609 /* delay uevents, until we scanned partition table */
610 dev_set_uevent_suppress(ddev, 1);
611
Hannes Reineckefef912b2018-09-28 08:17:19 +0200612 if (groups) {
613 WARN_ON(ddev->groups);
614 ddev->groups = groups;
615 }
Tejun Heod2bf1b62010-12-08 20:57:36 +0100616 if (device_add(ddev))
617 return;
618 if (!sysfs_deprecated) {
619 err = sysfs_create_link(block_depr, &ddev->kobj,
620 kobject_name(&ddev->kobj));
621 if (err) {
622 device_del(ddev);
623 return;
624 }
625 }
Ming Lei25e823c2013-02-22 16:34:13 -0800626
627 /*
628 * avoid probable deadlock caused by allocating memory with
629 * GFP_KERNEL in runtime_resume callback of its all ancestor
630 * devices
631 */
632 pm_runtime_set_memalloc_noio(ddev, true);
633
Tejun Heod2bf1b62010-12-08 20:57:36 +0100634 disk->part0.holder_dir = kobject_create_and_add("holders", &ddev->kobj);
635 disk->slave_dir = kobject_create_and_add("slaves", &ddev->kobj);
636
Christoph Hellwig8ddcd652017-11-02 21:29:53 +0300637 if (disk->flags & GENHD_FL_HIDDEN) {
638 dev_set_uevent_suppress(ddev, 0);
639 return;
640 }
641
Tejun Heod2bf1b62010-12-08 20:57:36 +0100642 /* No minors to use for partitions */
Tejun Heod27769e2011-08-23 20:01:04 +0200643 if (!disk_part_scan_enabled(disk))
Tejun Heod2bf1b62010-12-08 20:57:36 +0100644 goto exit;
645
646 /* No such device (e.g., media were just removed) */
647 if (!get_capacity(disk))
648 goto exit;
649
650 bdev = bdget_disk(disk, 0);
651 if (!bdev)
652 goto exit;
653
654 bdev->bd_invalidated = 1;
655 err = blkdev_get(bdev, FMODE_READ, NULL);
656 if (err < 0)
657 goto exit;
658 blkdev_put(bdev, FMODE_READ);
659
660exit:
661 /* announce disk after possible partitions are created */
662 dev_set_uevent_suppress(ddev, 0);
663 kobject_uevent(&ddev->kobj, KOBJ_ADD);
664
665 /* announce possible partitions */
666 disk_part_iter_init(&piter, disk, 0);
667 while ((part = disk_part_iter_next(&piter)))
668 kobject_uevent(&part_to_dev(part)->kobj, KOBJ_ADD);
669 disk_part_iter_exit(&piter);
Christoph Hellwig8ddcd652017-11-02 21:29:53 +0300670
zhengbin4d7c1d32019-02-20 21:27:05 +0800671 if (disk->queue->backing_dev_info->dev) {
672 err = sysfs_create_link(&ddev->kobj,
673 &disk->queue->backing_dev_info->dev->kobj,
674 "bdi");
675 WARN_ON(err);
676 }
Tejun Heod2bf1b62010-12-08 20:57:36 +0100677}
678
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679/**
Mike Snitzerfa70d2e2018-01-08 22:01:13 -0500680 * __device_add_disk - add disk information to kernel list
Dan Williamse63a46b2016-06-15 18:17:27 -0700681 * @parent: parent device for the disk
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682 * @disk: per-device partitioning information
Hannes Reineckefef912b2018-09-28 08:17:19 +0200683 * @groups: Additional per-device sysfs groups
Mike Snitzerfa70d2e2018-01-08 22:01:13 -0500684 * @register_queue: register the queue if set to true
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685 *
686 * This function registers the partitioning information in @disk
687 * with the kernel.
Tejun Heo3e1a7ff2008-08-25 19:56:17 +0900688 *
689 * FIXME: error handling
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690 */
Mike Snitzerfa70d2e2018-01-08 22:01:13 -0500691static void __device_add_disk(struct device *parent, struct gendisk *disk,
Hannes Reineckefef912b2018-09-28 08:17:19 +0200692 const struct attribute_group **groups,
Mike Snitzerfa70d2e2018-01-08 22:01:13 -0500693 bool register_queue)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694{
Tejun Heo3e1a7ff2008-08-25 19:56:17 +0900695 dev_t devt;
Greg Kroah-Hartman6ffeea72008-05-22 17:21:08 -0400696 int retval;
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700697
Tejun Heo3e1a7ff2008-08-25 19:56:17 +0900698 /* minors == 0 indicates to use ext devt from part0 and should
699 * be accompanied with EXT_DEVT flag. Make sure all
700 * parameters make sense.
701 */
702 WARN_ON(disk->minors && !(disk->major || disk->first_minor));
Christoph Hellwig8ddcd652017-11-02 21:29:53 +0300703 WARN_ON(!disk->minors &&
704 !(disk->flags & (GENHD_FL_EXT_DEVT | GENHD_FL_HIDDEN)));
Tejun Heo3e1a7ff2008-08-25 19:56:17 +0900705
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706 disk->flags |= GENHD_FL_UP;
Tejun Heo3e1a7ff2008-08-25 19:56:17 +0900707
708 retval = blk_alloc_devt(&disk->part0, &devt);
709 if (retval) {
710 WARN_ON(1);
711 return;
712 }
Tejun Heo3e1a7ff2008-08-25 19:56:17 +0900713 disk->major = MAJOR(devt);
714 disk->first_minor = MINOR(devt);
715
Stanislaw Gruszka9f53d2fe2012-03-02 10:43:28 +0100716 disk_alloc_events(disk);
717
Christoph Hellwig8ddcd652017-11-02 21:29:53 +0300718 if (disk->flags & GENHD_FL_HIDDEN) {
719 /*
720 * Don't let hidden disks show up in /proc/partitions,
721 * and don't bother scanning for partitions either.
722 */
723 disk->flags |= GENHD_FL_SUPPRESS_PARTITION_INFO;
724 disk->flags |= GENHD_FL_NO_PART_SCAN;
725 } else {
weiping zhang3a921682017-10-31 18:38:59 +0800726 int ret;
727
Christoph Hellwig8ddcd652017-11-02 21:29:53 +0300728 /* Register BDI before referencing it from bdev */
729 disk_to_dev(disk)->devt = devt;
weiping zhang3a921682017-10-31 18:38:59 +0800730 ret = bdi_register_owner(disk->queue->backing_dev_info,
731 disk_to_dev(disk));
732 WARN_ON(ret);
Christoph Hellwig8ddcd652017-11-02 21:29:53 +0300733 blk_register_region(disk_devt(disk), disk->minors, NULL,
734 exact_match, exact_lock, disk);
735 }
Hannes Reineckefef912b2018-09-28 08:17:19 +0200736 register_disk(parent, disk, groups);
Mike Snitzerfa70d2e2018-01-08 22:01:13 -0500737 if (register_queue)
738 blk_register_queue(disk);
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700739
Tejun Heo523e1d32011-10-19 14:31:07 +0200740 /*
741 * Take an extra ref on queue which will be put on disk_release()
742 * so that it sticks around as long as @disk is there.
743 */
Tejun Heo09ac46c2011-12-14 00:33:38 +0100744 WARN_ON_ONCE(!blk_get_queue(disk->queue));
Tejun Heo523e1d32011-10-19 14:31:07 +0200745
Tejun Heo77ea8872010-12-08 20:57:37 +0100746 disk_add_events(disk);
Martin K. Petersen25520d52015-10-21 13:19:49 -0400747 blk_integrity_add(disk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748}
Mike Snitzerfa70d2e2018-01-08 22:01:13 -0500749
Hannes Reineckefef912b2018-09-28 08:17:19 +0200750void device_add_disk(struct device *parent, struct gendisk *disk,
751 const struct attribute_group **groups)
752
Mike Snitzerfa70d2e2018-01-08 22:01:13 -0500753{
Hannes Reineckefef912b2018-09-28 08:17:19 +0200754 __device_add_disk(parent, disk, groups, true);
Mike Snitzerfa70d2e2018-01-08 22:01:13 -0500755}
Dan Williamse63a46b2016-06-15 18:17:27 -0700756EXPORT_SYMBOL(device_add_disk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757
Mike Snitzerfa70d2e2018-01-08 22:01:13 -0500758void device_add_disk_no_queue_reg(struct device *parent, struct gendisk *disk)
759{
Hannes Reineckefef912b2018-09-28 08:17:19 +0200760 __device_add_disk(parent, disk, NULL, false);
Mike Snitzerfa70d2e2018-01-08 22:01:13 -0500761}
762EXPORT_SYMBOL(device_add_disk_no_queue_reg);
763
Tejun Heod2bf1b62010-12-08 20:57:36 +0100764void del_gendisk(struct gendisk *disk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765{
Tejun Heod2bf1b62010-12-08 20:57:36 +0100766 struct disk_part_iter piter;
767 struct hd_struct *part;
768
Martin K. Petersen25520d52015-10-21 13:19:49 -0400769 blk_integrity_del(disk);
Tejun Heo77ea8872010-12-08 20:57:37 +0100770 disk_del_events(disk);
771
Jan Kara56c09082018-02-26 13:01:41 +0100772 /*
773 * Block lookups of the disk until all bdevs are unhashed and the
774 * disk is marked as dead (GENHD_FL_UP cleared).
775 */
776 down_write(&disk->lookup_sem);
Tejun Heod2bf1b62010-12-08 20:57:36 +0100777 /* invalidate stuff */
778 disk_part_iter_init(&piter, disk,
779 DISK_PITER_INCL_EMPTY | DISK_PITER_REVERSE);
780 while ((part = disk_part_iter_next(&piter))) {
781 invalidate_partition(disk, part->partno);
Jan Kara4b8c8612017-02-21 18:09:46 +0100782 bdev_unhash_inode(part_devt(part));
Tejun Heod2bf1b62010-12-08 20:57:36 +0100783 delete_partition(disk, part->partno);
784 }
785 disk_part_iter_exit(&piter);
786
787 invalidate_partition(disk, 0);
Jan Karad06e05c2017-02-21 18:09:47 +0100788 bdev_unhash_inode(disk_devt(disk));
Tejun Heod2bf1b62010-12-08 20:57:36 +0100789 set_capacity(disk, 0);
790 disk->flags &= ~GENHD_FL_UP;
Jan Kara56c09082018-02-26 13:01:41 +0100791 up_write(&disk->lookup_sem);
Tejun Heod2bf1b62010-12-08 20:57:36 +0100792
Christoph Hellwig8ddcd652017-11-02 21:29:53 +0300793 if (!(disk->flags & GENHD_FL_HIDDEN))
794 sysfs_remove_link(&disk_to_dev(disk)->kobj, "bdi");
Jan Kara90f16fd2017-03-08 17:48:33 +0100795 if (disk->queue) {
796 /*
797 * Unregister bdi before releasing device numbers (as they can
798 * get reused and we'd get clashes in sysfs).
799 */
Mike Snitzerbc8d0622018-01-09 20:46:49 -0500800 if (!(disk->flags & GENHD_FL_HIDDEN))
801 bdi_unregister(disk->queue->backing_dev_info);
Jan Kara90f16fd2017-03-08 17:48:33 +0100802 blk_unregister_queue(disk);
803 } else {
804 WARN_ON(1);
805 }
Tejun Heod2bf1b62010-12-08 20:57:36 +0100806
Hannes Reinecke17eac092017-11-09 17:57:06 +0100807 if (!(disk->flags & GENHD_FL_HIDDEN))
Christoph Hellwig8ddcd652017-11-02 21:29:53 +0300808 blk_unregister_region(disk_devt(disk), disk->minors);
Yufen Yu6fcc44d2019-04-02 20:06:34 +0800809 /*
810 * Remove gendisk pointer from idr so that it cannot be looked up
811 * while RCU period before freeing gendisk is running to prevent
812 * use-after-free issues. Note that the device number stays
813 * "in-use" until we really free the gendisk.
814 */
815 blk_invalidate_devt(disk_devt(disk));
Tejun Heod2bf1b62010-12-08 20:57:36 +0100816
817 kobject_put(disk->part0.holder_dir);
818 kobject_put(disk->slave_dir);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819
820 part_stat_set_all(&disk->part0, 0);
Tejun Heoed9e1982008-08-25 19:56:05 +0900821 disk->part0.stamp = 0;
Tejun Heod2bf1b62010-12-08 20:57:36 +0100822 if (!sysfs_deprecated)
823 sysfs_remove_link(block_depr, dev_name(disk_to_dev(disk)));
Ming Lei25e823c2013-02-22 16:34:13 -0800824 pm_runtime_set_memalloc_noio(disk_to_dev(disk), false);
Tejun Heod2bf1b62010-12-08 20:57:36 +0100825 device_del(disk_to_dev(disk));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826}
Tejun Heod2bf1b62010-12-08 20:57:36 +0100827EXPORT_SYMBOL(del_gendisk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828
Vishal Verma99e66082016-01-09 08:36:51 -0800829/* sysfs access to bad-blocks list. */
830static ssize_t disk_badblocks_show(struct device *dev,
831 struct device_attribute *attr,
832 char *page)
833{
834 struct gendisk *disk = dev_to_disk(dev);
835
836 if (!disk->bb)
837 return sprintf(page, "\n");
838
839 return badblocks_show(disk->bb, page, 0);
840}
841
842static ssize_t disk_badblocks_store(struct device *dev,
843 struct device_attribute *attr,
844 const char *page, size_t len)
845{
846 struct gendisk *disk = dev_to_disk(dev);
847
848 if (!disk->bb)
849 return -ENXIO;
850
851 return badblocks_store(disk->bb, page, len, 0);
852}
853
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854/**
855 * get_gendisk - get partitioning information for a given device
Randy Dunlap710027a2008-08-19 20:13:11 +0200856 * @devt: device to get partitioning information for
Randy Dunlap496aa8a2008-10-16 07:46:23 +0200857 * @partno: returned partition index
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858 *
859 * This function gets the structure containing partitioning
Randy Dunlap710027a2008-08-19 20:13:11 +0200860 * information for the given device @devt.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861 */
Tejun Heocf771cb2008-09-03 09:01:09 +0200862struct gendisk *get_gendisk(dev_t devt, int *partno)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863{
Tejun Heobcce3de2008-08-25 19:47:22 +0900864 struct gendisk *disk = NULL;
Kay Sieversedfaa7c2007-05-21 22:08:01 +0200865
Tejun Heobcce3de2008-08-25 19:47:22 +0900866 if (MAJOR(devt) != BLOCK_EXT_MAJOR) {
867 struct kobject *kobj;
868
869 kobj = kobj_lookup(bdev_map, devt, partno);
870 if (kobj)
871 disk = dev_to_disk(kobj_to_dev(kobj));
872 } else {
873 struct hd_struct *part;
874
Dan Williams4d66e5e2015-06-10 23:47:14 -0400875 spin_lock_bh(&ext_devt_lock);
Tejun Heo870d6652008-08-25 19:47:25 +0900876 part = idr_find(&ext_devt_idr, blk_mangle_minor(MINOR(devt)));
Jan Kara3079c222018-02-26 13:01:38 +0100877 if (part && get_disk_and_module(part_to_disk(part))) {
Tejun Heobcce3de2008-08-25 19:47:22 +0900878 *partno = part->partno;
879 disk = part_to_disk(part);
880 }
Dan Williams4d66e5e2015-06-10 23:47:14 -0400881 spin_unlock_bh(&ext_devt_lock);
Tejun Heobcce3de2008-08-25 19:47:22 +0900882 }
883
Jan Kara56c09082018-02-26 13:01:41 +0100884 if (!disk)
885 return NULL;
886
887 /*
888 * Synchronize with del_gendisk() to not return disk that is being
889 * destroyed.
890 */
891 down_read(&disk->lookup_sem);
892 if (unlikely((disk->flags & GENHD_FL_HIDDEN) ||
893 !(disk->flags & GENHD_FL_UP))) {
894 up_read(&disk->lookup_sem);
Jan Kara9df6c292018-02-26 13:01:39 +0100895 put_disk_and_module(disk);
Christoph Hellwig8ddcd652017-11-02 21:29:53 +0300896 disk = NULL;
Jan Kara56c09082018-02-26 13:01:41 +0100897 } else {
898 up_read(&disk->lookup_sem);
Christoph Hellwig8ddcd652017-11-02 21:29:53 +0300899 }
Tejun Heobcce3de2008-08-25 19:47:22 +0900900 return disk;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901}
Divyesh Shahb6ac23af2010-04-15 08:54:59 +0200902EXPORT_SYMBOL(get_gendisk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903
Tejun Heof331c022008-09-03 09:01:48 +0200904/**
905 * bdget_disk - do bdget() by gendisk and partition number
906 * @disk: gendisk of interest
907 * @partno: partition number
908 *
909 * Find partition @partno from @disk, do bdget() on it.
910 *
911 * CONTEXT:
912 * Don't care.
913 *
914 * RETURNS:
915 * Resulting block_device on success, NULL on failure.
916 */
Harvey Harrisonaeb3d3a2008-08-28 09:27:42 +0200917struct block_device *bdget_disk(struct gendisk *disk, int partno)
Tejun Heof331c022008-09-03 09:01:48 +0200918{
Tejun Heo548b10e2008-08-29 09:01:47 +0200919 struct hd_struct *part;
920 struct block_device *bdev = NULL;
Tejun Heof331c022008-09-03 09:01:48 +0200921
Tejun Heo548b10e2008-08-29 09:01:47 +0200922 part = disk_get_part(disk, partno);
Tejun Heo2bbedcb2008-08-29 11:41:51 +0200923 if (part)
Tejun Heo548b10e2008-08-29 09:01:47 +0200924 bdev = bdget(part_devt(part));
925 disk_put_part(part);
Tejun Heof331c022008-09-03 09:01:48 +0200926
Tejun Heo548b10e2008-08-29 09:01:47 +0200927 return bdev;
Tejun Heof331c022008-09-03 09:01:48 +0200928}
929EXPORT_SYMBOL(bdget_disk);
930
Dave Gilbertdd2a3452007-05-09 02:33:24 -0700931/*
932 * print a full list of all partitions - intended for places where the root
933 * filesystem can't be mounted and thus to give the victim some idea of what
934 * went wrong
935 */
936void __init printk_all_partitions(void)
937{
Tejun Heodef4e382008-09-03 08:57:12 +0200938 struct class_dev_iter iter;
939 struct device *dev;
940
941 class_dev_iter_init(&iter, &block_class, NULL, &disk_type);
942 while ((dev = class_dev_iter_next(&iter))) {
943 struct gendisk *disk = dev_to_disk(dev);
Tejun Heoe71bf0d2008-09-03 09:03:02 +0200944 struct disk_part_iter piter;
945 struct hd_struct *part;
Tejun Heo1f014292008-08-25 19:47:23 +0900946 char name_buf[BDEVNAME_SIZE];
947 char devt_buf[BDEVT_SIZE];
Tejun Heodef4e382008-09-03 08:57:12 +0200948
949 /*
950 * Don't show empty devices or things that have been
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300951 * suppressed
Tejun Heodef4e382008-09-03 08:57:12 +0200952 */
953 if (get_capacity(disk) == 0 ||
954 (disk->flags & GENHD_FL_SUPPRESS_PARTITION_INFO))
955 continue;
956
957 /*
958 * Note, unlike /proc/partitions, I am showing the
959 * numbers in hex - the same format as the root=
960 * option takes.
961 */
Tejun Heo074a7ac2008-08-25 19:56:14 +0900962 disk_part_iter_init(&piter, disk, DISK_PITER_INCL_PART0);
963 while ((part = disk_part_iter_next(&piter))) {
964 bool is_part0 = part == &disk->part0;
Tejun Heodef4e382008-09-03 08:57:12 +0200965
Will Drewryb5af9212010-08-31 15:47:07 -0500966 printk("%s%s %10llu %s %s", is_part0 ? "" : " ",
Tejun Heo1f014292008-08-25 19:47:23 +0900967 bdevt_str(part_devt(part), devt_buf),
Vivek Goyalc83f6bf2012-08-01 12:24:18 +0200968 (unsigned long long)part_nr_sects_read(part) >> 1
969 , disk_name(disk, part->partno, name_buf),
Stephen Warren1ad7e892012-11-08 16:12:25 -0800970 part->info ? part->info->uuid : "");
Tejun Heo074a7ac2008-08-25 19:56:14 +0900971 if (is_part0) {
Dan Williams52c44d92016-06-15 19:43:07 -0700972 if (dev->parent && dev->parent->driver)
Tejun Heo074a7ac2008-08-25 19:56:14 +0900973 printk(" driver: %s\n",
Dan Williams52c44d92016-06-15 19:43:07 -0700974 dev->parent->driver->name);
Tejun Heo074a7ac2008-08-25 19:56:14 +0900975 else
976 printk(" (driver?)\n");
977 } else
978 printk("\n");
979 }
Tejun Heoe71bf0d2008-09-03 09:03:02 +0200980 disk_part_iter_exit(&piter);
Tejun Heodef4e382008-09-03 08:57:12 +0200981 }
982 class_dev_iter_exit(&iter);
Dave Gilbertdd2a3452007-05-09 02:33:24 -0700983}
984
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985#ifdef CONFIG_PROC_FS
986/* iterator */
Tejun Heodef4e382008-09-03 08:57:12 +0200987static void *disk_seqf_start(struct seq_file *seqf, loff_t *pos)
Greg Kroah-Hartman68c4d4a2008-05-22 17:21:08 -0400988{
Tejun Heodef4e382008-09-03 08:57:12 +0200989 loff_t skip = *pos;
990 struct class_dev_iter *iter;
991 struct device *dev;
Greg Kroah-Hartman68c4d4a2008-05-22 17:21:08 -0400992
Harvey Harrisonaeb3d3a2008-08-28 09:27:42 +0200993 iter = kmalloc(sizeof(*iter), GFP_KERNEL);
Tejun Heodef4e382008-09-03 08:57:12 +0200994 if (!iter)
995 return ERR_PTR(-ENOMEM);
996
997 seqf->private = iter;
998 class_dev_iter_init(iter, &block_class, NULL, &disk_type);
999 do {
1000 dev = class_dev_iter_next(iter);
1001 if (!dev)
1002 return NULL;
1003 } while (skip--);
1004
1005 return dev_to_disk(dev);
Greg Kroah-Hartman68c4d4a2008-05-22 17:21:08 -04001006}
1007
Tejun Heodef4e382008-09-03 08:57:12 +02001008static void *disk_seqf_next(struct seq_file *seqf, void *v, loff_t *pos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001009{
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001010 struct device *dev;
Greg Kroah-Hartman66c64af2008-05-22 17:21:08 -04001011
Tejun Heodef4e382008-09-03 08:57:12 +02001012 (*pos)++;
1013 dev = class_dev_iter_next(seqf->private);
Tejun Heo2ac3cee2008-09-03 08:53:37 +02001014 if (dev)
Greg Kroah-Hartman68c4d4a2008-05-22 17:21:08 -04001015 return dev_to_disk(dev);
Tejun Heo2ac3cee2008-09-03 08:53:37 +02001016
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017 return NULL;
1018}
1019
Tejun Heodef4e382008-09-03 08:57:12 +02001020static void disk_seqf_stop(struct seq_file *seqf, void *v)
Greg Kroah-Hartman27f30252008-05-22 17:21:08 -04001021{
Tejun Heodef4e382008-09-03 08:57:12 +02001022 struct class_dev_iter *iter = seqf->private;
Greg Kroah-Hartman27f30252008-05-22 17:21:08 -04001023
Tejun Heodef4e382008-09-03 08:57:12 +02001024 /* stop is called even after start failed :-( */
1025 if (iter) {
1026 class_dev_iter_exit(iter);
1027 kfree(iter);
Vegard Nossum77da1602016-07-29 10:40:31 +02001028 seqf->private = NULL;
Kay Sievers5c0ef6d2008-08-16 14:30:30 +02001029 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001030}
1031
Tejun Heodef4e382008-09-03 08:57:12 +02001032static void *show_partition_start(struct seq_file *seqf, loff_t *pos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033{
Jianpeng Ma06768062012-08-03 10:42:00 +02001034 void *p;
Tejun Heodef4e382008-09-03 08:57:12 +02001035
1036 p = disk_seqf_start(seqf, pos);
Yang Zhangb9f985b2010-12-17 08:58:36 +01001037 if (!IS_ERR_OR_NULL(p) && !*pos)
Tejun Heodef4e382008-09-03 08:57:12 +02001038 seq_puts(seqf, "major minor #blocks name\n\n");
1039 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001040}
1041
Tejun Heocf771cb2008-09-03 09:01:09 +02001042static int show_partition(struct seq_file *seqf, void *v)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043{
1044 struct gendisk *sgp = v;
Tejun Heoe71bf0d2008-09-03 09:03:02 +02001045 struct disk_part_iter piter;
1046 struct hd_struct *part;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047 char buf[BDEVNAME_SIZE];
1048
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049 /* Don't show non-partitionable removeable devices or empty devices */
Tejun Heod27769e2011-08-23 20:01:04 +02001050 if (!get_capacity(sgp) || (!disk_max_parts(sgp) &&
Tejun Heof331c022008-09-03 09:01:48 +02001051 (sgp->flags & GENHD_FL_REMOVABLE)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052 return 0;
1053 if (sgp->flags & GENHD_FL_SUPPRESS_PARTITION_INFO)
1054 return 0;
1055
1056 /* show the full disk and all non-0 size partitions of it */
Tejun Heo074a7ac2008-08-25 19:56:14 +09001057 disk_part_iter_init(&piter, sgp, DISK_PITER_INCL_PART0);
Tejun Heoe71bf0d2008-09-03 09:03:02 +02001058 while ((part = disk_part_iter_next(&piter)))
Tejun Heo1f014292008-08-25 19:47:23 +09001059 seq_printf(seqf, "%4d %7d %10llu %s\n",
Tejun Heof331c022008-09-03 09:01:48 +02001060 MAJOR(part_devt(part)), MINOR(part_devt(part)),
Vivek Goyalc83f6bf2012-08-01 12:24:18 +02001061 (unsigned long long)part_nr_sects_read(part) >> 1,
Tejun Heof331c022008-09-03 09:01:48 +02001062 disk_name(sgp, part->partno, buf));
Tejun Heoe71bf0d2008-09-03 09:03:02 +02001063 disk_part_iter_exit(&piter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001064
1065 return 0;
1066}
1067
Alexey Dobriyanf5009752008-10-04 23:53:21 +04001068static const struct seq_operations partitions_op = {
Tejun Heodef4e382008-09-03 08:57:12 +02001069 .start = show_partition_start,
1070 .next = disk_seqf_next,
1071 .stop = disk_seqf_stop,
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001072 .show = show_partition
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073};
1074#endif
1075
1076
Tejun Heocf771cb2008-09-03 09:01:09 +02001077static struct kobject *base_probe(dev_t devt, int *partno, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001078{
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001079 if (request_module("block-major-%d-%d", MAJOR(devt), MINOR(devt)) > 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080 /* Make old-style 2.4 aliases work */
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001081 request_module("block-major-%d", MAJOR(devt));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082 return NULL;
1083}
1084
1085static int __init genhd_device_init(void)
1086{
Dan Williamse105b8b2008-04-21 10:51:07 -07001087 int error;
1088
1089 block_class.dev_kobj = sysfs_dev_block_kobj;
1090 error = class_register(&block_class);
Roland McGrathee27a552008-03-11 17:13:15 -07001091 if (unlikely(error))
1092 return error;
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001093 bdev_map = kobj_map_init(base_probe, &block_class_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094 blk_dev_init();
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001095
Zhang, Yanmin561ec682008-11-14 08:26:30 +01001096 register_blkdev(BLOCK_EXT_MAJOR, "blkext");
1097
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001098 /* create top-level block dir */
Andi Kleene52eec12010-09-08 16:54:17 +02001099 if (!sysfs_deprecated)
1100 block_depr = kobject_create_and_add("block", NULL);
Greg Kroah-Hartman830d3cf2007-11-06 10:36:58 -08001101 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001102}
1103
1104subsys_initcall(genhd_device_init);
1105
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001106static ssize_t disk_range_show(struct device *dev,
1107 struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001108{
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001109 struct gendisk *disk = dev_to_disk(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001110
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001111 return sprintf(buf, "%d\n", disk->minors);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001112}
1113
Tejun Heo1f014292008-08-25 19:47:23 +09001114static ssize_t disk_ext_range_show(struct device *dev,
1115 struct device_attribute *attr, char *buf)
1116{
1117 struct gendisk *disk = dev_to_disk(dev);
1118
Tejun Heob5d0b9d2008-09-03 09:06:42 +02001119 return sprintf(buf, "%d\n", disk_max_parts(disk));
Tejun Heo1f014292008-08-25 19:47:23 +09001120}
1121
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001122static ssize_t disk_removable_show(struct device *dev,
1123 struct device_attribute *attr, char *buf)
Kay Sieversa7fd6702005-10-01 14:49:43 +02001124{
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001125 struct gendisk *disk = dev_to_disk(dev);
Kay Sieversa7fd6702005-10-01 14:49:43 +02001126
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001127 return sprintf(buf, "%d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001128 (disk->flags & GENHD_FL_REMOVABLE ? 1 : 0));
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001129}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001130
Christoph Hellwig8ddcd652017-11-02 21:29:53 +03001131static ssize_t disk_hidden_show(struct device *dev,
1132 struct device_attribute *attr, char *buf)
1133{
1134 struct gendisk *disk = dev_to_disk(dev);
1135
1136 return sprintf(buf, "%d\n",
1137 (disk->flags & GENHD_FL_HIDDEN ? 1 : 0));
1138}
1139
Kay Sievers1c9ce522008-06-13 09:41:00 +02001140static ssize_t disk_ro_show(struct device *dev,
1141 struct device_attribute *attr, char *buf)
1142{
1143 struct gendisk *disk = dev_to_disk(dev);
1144
Tejun Heob7db9952008-08-25 19:56:10 +09001145 return sprintf(buf, "%d\n", get_disk_ro(disk) ? 1 : 0);
Kay Sievers1c9ce522008-06-13 09:41:00 +02001146}
1147
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001148static ssize_t disk_capability_show(struct device *dev,
1149 struct device_attribute *attr, char *buf)
Kristen Carlson Accardi86ce18d2007-05-23 13:57:38 -07001150{
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001151 struct gendisk *disk = dev_to_disk(dev);
1152
1153 return sprintf(buf, "%x\n", disk->flags);
Kristen Carlson Accardi86ce18d2007-05-23 13:57:38 -07001154}
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001155
Martin K. Petersenc72758f2009-05-22 17:17:53 -04001156static ssize_t disk_alignment_offset_show(struct device *dev,
1157 struct device_attribute *attr,
1158 char *buf)
1159{
1160 struct gendisk *disk = dev_to_disk(dev);
1161
1162 return sprintf(buf, "%d\n", queue_alignment_offset(disk->queue));
1163}
1164
Martin K. Petersen86b37282009-11-10 11:50:21 +01001165static ssize_t disk_discard_alignment_show(struct device *dev,
1166 struct device_attribute *attr,
1167 char *buf)
1168{
1169 struct gendisk *disk = dev_to_disk(dev);
1170
Martin K. Petersendd3d1452010-01-11 03:21:48 -05001171 return sprintf(buf, "%d\n", queue_discard_alignment(disk->queue));
Martin K. Petersen86b37282009-11-10 11:50:21 +01001172}
1173
Joe Perches5657a812018-05-24 13:38:59 -06001174static DEVICE_ATTR(range, 0444, disk_range_show, NULL);
1175static DEVICE_ATTR(ext_range, 0444, disk_ext_range_show, NULL);
1176static DEVICE_ATTR(removable, 0444, disk_removable_show, NULL);
1177static DEVICE_ATTR(hidden, 0444, disk_hidden_show, NULL);
1178static DEVICE_ATTR(ro, 0444, disk_ro_show, NULL);
1179static DEVICE_ATTR(size, 0444, part_size_show, NULL);
1180static DEVICE_ATTR(alignment_offset, 0444, disk_alignment_offset_show, NULL);
1181static DEVICE_ATTR(discard_alignment, 0444, disk_discard_alignment_show, NULL);
1182static DEVICE_ATTR(capability, 0444, disk_capability_show, NULL);
1183static DEVICE_ATTR(stat, 0444, part_stat_show, NULL);
1184static DEVICE_ATTR(inflight, 0444, part_inflight_show, NULL);
1185static DEVICE_ATTR(badblocks, 0644, disk_badblocks_show, disk_badblocks_store);
Akinobu Mitac17bb492006-12-08 02:39:46 -08001186#ifdef CONFIG_FAIL_MAKE_REQUEST
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001187static struct device_attribute dev_attr_fail =
Joe Perches5657a812018-05-24 13:38:59 -06001188 __ATTR(make-it-fail, 0644, part_fail_show, part_fail_store);
Akinobu Mitac17bb492006-12-08 02:39:46 -08001189#endif
Jens Axboe581d4e22008-09-14 05:56:33 -07001190#ifdef CONFIG_FAIL_IO_TIMEOUT
1191static struct device_attribute dev_attr_fail_timeout =
Joe Perches5657a812018-05-24 13:38:59 -06001192 __ATTR(io-timeout-fail, 0644, part_timeout_show, part_timeout_store);
Jens Axboe581d4e22008-09-14 05:56:33 -07001193#endif
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001194
1195static struct attribute *disk_attrs[] = {
1196 &dev_attr_range.attr,
Tejun Heo1f014292008-08-25 19:47:23 +09001197 &dev_attr_ext_range.attr,
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001198 &dev_attr_removable.attr,
Christoph Hellwig8ddcd652017-11-02 21:29:53 +03001199 &dev_attr_hidden.attr,
Kay Sievers1c9ce522008-06-13 09:41:00 +02001200 &dev_attr_ro.attr,
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001201 &dev_attr_size.attr,
Martin K. Petersenc72758f2009-05-22 17:17:53 -04001202 &dev_attr_alignment_offset.attr,
Martin K. Petersen86b37282009-11-10 11:50:21 +01001203 &dev_attr_discard_alignment.attr,
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001204 &dev_attr_capability.attr,
1205 &dev_attr_stat.attr,
Nikanth Karthikesan316d3152009-10-06 20:16:55 +02001206 &dev_attr_inflight.attr,
Vishal Verma99e66082016-01-09 08:36:51 -08001207 &dev_attr_badblocks.attr,
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001208#ifdef CONFIG_FAIL_MAKE_REQUEST
1209 &dev_attr_fail.attr,
1210#endif
Jens Axboe581d4e22008-09-14 05:56:33 -07001211#ifdef CONFIG_FAIL_IO_TIMEOUT
1212 &dev_attr_fail_timeout.attr,
1213#endif
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001214 NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215};
1216
Dan Williams9438b3e02017-04-27 14:46:26 -07001217static umode_t disk_visible(struct kobject *kobj, struct attribute *a, int n)
1218{
1219 struct device *dev = container_of(kobj, typeof(*dev), kobj);
1220 struct gendisk *disk = dev_to_disk(dev);
1221
1222 if (a == &dev_attr_badblocks.attr && !disk->bb)
1223 return 0;
1224 return a->mode;
1225}
1226
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001227static struct attribute_group disk_attr_group = {
1228 .attrs = disk_attrs,
Dan Williams9438b3e02017-04-27 14:46:26 -07001229 .is_visible = disk_visible,
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001230};
1231
David Brownella4dbd672009-06-24 10:06:31 -07001232static const struct attribute_group *disk_attr_groups[] = {
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001233 &disk_attr_group,
1234 NULL
1235};
1236
Tejun Heo540eed52008-08-25 19:56:15 +09001237/**
1238 * disk_replace_part_tbl - replace disk->part_tbl in RCU-safe way
1239 * @disk: disk to replace part_tbl for
1240 * @new_ptbl: new part_tbl to install
1241 *
1242 * Replace disk->part_tbl with @new_ptbl in RCU-safe way. The
1243 * original ptbl is freed using RCU callback.
1244 *
1245 * LOCKING:
Bart Van Assche6d2cf6f2017-08-17 16:23:06 -07001246 * Matching bd_mutex locked or the caller is the only user of @disk.
Tejun Heo540eed52008-08-25 19:56:15 +09001247 */
1248static void disk_replace_part_tbl(struct gendisk *disk,
1249 struct disk_part_tbl *new_ptbl)
1250{
Bart Van Assche6d2cf6f2017-08-17 16:23:06 -07001251 struct disk_part_tbl *old_ptbl =
1252 rcu_dereference_protected(disk->part_tbl, 1);
Tejun Heo540eed52008-08-25 19:56:15 +09001253
1254 rcu_assign_pointer(disk->part_tbl, new_ptbl);
Jens Axboea6f23652008-10-24 12:52:42 +02001255
1256 if (old_ptbl) {
1257 rcu_assign_pointer(old_ptbl->last_lookup, NULL);
Lai Jiangshan57bdfbf2011-03-18 11:42:58 +08001258 kfree_rcu(old_ptbl, rcu_head);
Jens Axboea6f23652008-10-24 12:52:42 +02001259 }
Tejun Heo540eed52008-08-25 19:56:15 +09001260}
1261
1262/**
1263 * disk_expand_part_tbl - expand disk->part_tbl
1264 * @disk: disk to expand part_tbl for
1265 * @partno: expand such that this partno can fit in
1266 *
1267 * Expand disk->part_tbl such that @partno can fit in. disk->part_tbl
1268 * uses RCU to allow unlocked dereferencing for stats and other stuff.
1269 *
1270 * LOCKING:
Bart Van Assche6d2cf6f2017-08-17 16:23:06 -07001271 * Matching bd_mutex locked or the caller is the only user of @disk.
1272 * Might sleep.
Tejun Heo540eed52008-08-25 19:56:15 +09001273 *
1274 * RETURNS:
1275 * 0 on success, -errno on failure.
1276 */
1277int disk_expand_part_tbl(struct gendisk *disk, int partno)
1278{
Bart Van Assche6d2cf6f2017-08-17 16:23:06 -07001279 struct disk_part_tbl *old_ptbl =
1280 rcu_dereference_protected(disk->part_tbl, 1);
Tejun Heo540eed52008-08-25 19:56:15 +09001281 struct disk_part_tbl *new_ptbl;
1282 int len = old_ptbl ? old_ptbl->len : 0;
Jens Axboe5fabcb42014-11-19 13:06:22 -07001283 int i, target;
Tejun Heo540eed52008-08-25 19:56:15 +09001284 size_t size;
Jens Axboe5fabcb42014-11-19 13:06:22 -07001285
1286 /*
1287 * check for int overflow, since we can get here from blkpg_ioctl()
1288 * with a user passed 'partno'.
1289 */
1290 target = partno + 1;
1291 if (target < 0)
1292 return -EINVAL;
Tejun Heo540eed52008-08-25 19:56:15 +09001293
1294 /* disk_max_parts() is zero during initialization, ignore if so */
1295 if (disk_max_parts(disk) && target > disk_max_parts(disk))
1296 return -EINVAL;
1297
1298 if (target <= len)
1299 return 0;
1300
1301 size = sizeof(*new_ptbl) + target * sizeof(new_ptbl->part[0]);
1302 new_ptbl = kzalloc_node(size, GFP_KERNEL, disk->node_id);
1303 if (!new_ptbl)
1304 return -ENOMEM;
1305
Tejun Heo540eed52008-08-25 19:56:15 +09001306 new_ptbl->len = target;
1307
1308 for (i = 0; i < len; i++)
1309 rcu_assign_pointer(new_ptbl->part[i], old_ptbl->part[i]);
1310
1311 disk_replace_part_tbl(disk, new_ptbl);
1312 return 0;
1313}
1314
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001315static void disk_release(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316{
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001317 struct gendisk *disk = dev_to_disk(dev);
1318
Keith Busch2da78092014-08-26 09:05:36 -06001319 blk_free_devt(dev->devt);
Tejun Heo77ea8872010-12-08 20:57:37 +01001320 disk_release_events(disk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321 kfree(disk->random);
Tejun Heo540eed52008-08-25 19:56:15 +09001322 disk_replace_part_tbl(disk, NULL);
Ming Leib54e5ed2015-07-16 11:16:44 +08001323 hd_free_part(&disk->part0);
Tejun Heo523e1d32011-10-19 14:31:07 +02001324 if (disk->queue)
1325 blk_put_queue(disk->queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326 kfree(disk);
1327}
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001328struct class block_class = {
1329 .name = "block",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330};
1331
Kay Sievers3c2670e2013-04-06 09:56:00 -07001332static char *block_devnode(struct device *dev, umode_t *mode,
Greg Kroah-Hartman4e4098a2013-04-11 11:43:29 -07001333 kuid_t *uid, kgid_t *gid)
Kay Sieversb03f38b2009-04-30 15:23:42 +02001334{
1335 struct gendisk *disk = dev_to_disk(dev);
1336
Kay Sieverse454cea2009-09-18 23:01:12 +02001337 if (disk->devnode)
1338 return disk->devnode(disk, mode);
Kay Sieversb03f38b2009-04-30 15:23:42 +02001339 return NULL;
1340}
1341
Bart Van Asscheedf8ff52017-06-20 11:15:48 -07001342static const struct device_type disk_type = {
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001343 .name = "disk",
1344 .groups = disk_attr_groups,
1345 .release = disk_release,
Kay Sieverse454cea2009-09-18 23:01:12 +02001346 .devnode = block_devnode,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001347};
1348
Randy Dunlapa6e2ba82008-05-23 09:44:11 -07001349#ifdef CONFIG_PROC_FS
Tejun Heocf771cb2008-09-03 09:01:09 +02001350/*
1351 * aggregate disk stat collector. Uses the same stats that the sysfs
1352 * entries do, above, but makes them available through one seq_file.
1353 *
1354 * The output looks suspiciously like /proc/partitions with a bunch of
1355 * extra fields.
1356 */
1357static int diskstats_show(struct seq_file *seqf, void *v)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358{
1359 struct gendisk *gp = v;
Tejun Heoe71bf0d2008-09-03 09:03:02 +02001360 struct disk_part_iter piter;
1361 struct hd_struct *hd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362 char buf[BDEVNAME_SIZE];
Mikulas Patockae016b782018-12-06 11:41:21 -05001363 unsigned int inflight;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364
1365 /*
Tejun Heoed9e1982008-08-25 19:56:05 +09001366 if (&disk_to_dev(gp)->kobj.entry == block_class.devices.next)
Tejun Heocf771cb2008-09-03 09:01:09 +02001367 seq_puts(seqf, "major minor name"
Linus Torvalds1da177e2005-04-16 15:20:36 -07001368 " rio rmerge rsect ruse wio wmerge "
1369 "wsect wuse running use aveq"
1370 "\n\n");
1371 */
Wanlong Gao9f5e4862011-06-13 10:45:43 +02001372
Tejun Heo71982a42009-04-17 08:34:48 +02001373 disk_part_iter_init(&piter, gp, DISK_PITER_INCL_EMPTY_PART0);
Tejun Heoe71bf0d2008-09-03 09:03:02 +02001374 while ((hd = disk_part_iter_next(&piter))) {
Mikulas Patockae016b782018-12-06 11:41:21 -05001375 inflight = part_in_flight(gp->queue, hd);
Michael Callahanbdca3c82018-07-18 04:47:40 -07001376 seq_printf(seqf, "%4d %7d %s "
1377 "%lu %lu %lu %u "
1378 "%lu %lu %lu %u "
1379 "%u %u %u "
1380 "%lu %lu %lu %u\n",
Tejun Heof331c022008-09-03 09:01:48 +02001381 MAJOR(part_devt(hd)), MINOR(part_devt(hd)),
1382 disk_name(gp, hd->partno, buf),
Michael Callahandbae2c52018-07-18 04:47:38 -07001383 part_stat_read(hd, ios[STAT_READ]),
1384 part_stat_read(hd, merges[STAT_READ]),
1385 part_stat_read(hd, sectors[STAT_READ]),
Omar Sandovalb57e99b2018-09-21 16:44:34 -07001386 (unsigned int)part_stat_read_msecs(hd, STAT_READ),
Michael Callahandbae2c52018-07-18 04:47:38 -07001387 part_stat_read(hd, ios[STAT_WRITE]),
1388 part_stat_read(hd, merges[STAT_WRITE]),
1389 part_stat_read(hd, sectors[STAT_WRITE]),
Omar Sandovalb57e99b2018-09-21 16:44:34 -07001390 (unsigned int)part_stat_read_msecs(hd, STAT_WRITE),
Mikulas Patockae016b782018-12-06 11:41:21 -05001391 inflight,
Jerome Marchand28f39d52008-02-08 11:04:56 +01001392 jiffies_to_msecs(part_stat_read(hd, io_ticks)),
Michael Callahanbdca3c82018-07-18 04:47:40 -07001393 jiffies_to_msecs(part_stat_read(hd, time_in_queue)),
1394 part_stat_read(hd, ios[STAT_DISCARD]),
1395 part_stat_read(hd, merges[STAT_DISCARD]),
1396 part_stat_read(hd, sectors[STAT_DISCARD]),
Omar Sandovalb57e99b2018-09-21 16:44:34 -07001397 (unsigned int)part_stat_read_msecs(hd, STAT_DISCARD)
Jerome Marchand28f39d52008-02-08 11:04:56 +01001398 );
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399 }
Tejun Heoe71bf0d2008-09-03 09:03:02 +02001400 disk_part_iter_exit(&piter);
Wanlong Gao9f5e4862011-06-13 10:45:43 +02001401
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402 return 0;
1403}
1404
Alexey Dobriyan31d85ab2008-10-06 12:55:38 +04001405static const struct seq_operations diskstats_op = {
Tejun Heodef4e382008-09-03 08:57:12 +02001406 .start = disk_seqf_start,
1407 .next = disk_seqf_next,
1408 .stop = disk_seqf_stop,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001409 .show = diskstats_show
1410};
Alexey Dobriyanf5009752008-10-04 23:53:21 +04001411
1412static int __init proc_genhd_init(void)
1413{
Christoph Hellwigfddda2b2018-04-13 19:44:18 +02001414 proc_create_seq("diskstats", 0, NULL, &diskstats_op);
1415 proc_create_seq("partitions", 0, NULL, &partitions_op);
Alexey Dobriyanf5009752008-10-04 23:53:21 +04001416 return 0;
1417}
1418module_init(proc_genhd_init);
Randy Dunlapa6e2ba82008-05-23 09:44:11 -07001419#endif /* CONFIG_PROC_FS */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001420
Tejun Heocf771cb2008-09-03 09:01:09 +02001421dev_t blk_lookup_devt(const char *name, int partno)
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001422{
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001423 dev_t devt = MKDEV(0, 0);
Tejun Heodef4e382008-09-03 08:57:12 +02001424 struct class_dev_iter iter;
1425 struct device *dev;
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001426
Tejun Heodef4e382008-09-03 08:57:12 +02001427 class_dev_iter_init(&iter, &block_class, NULL, &disk_type);
1428 while ((dev = class_dev_iter_next(&iter))) {
1429 struct gendisk *disk = dev_to_disk(dev);
Tejun Heo548b10e2008-08-29 09:01:47 +02001430 struct hd_struct *part;
Tejun Heodef4e382008-09-03 08:57:12 +02001431
Kay Sievers3ada8b72009-01-06 10:44:43 -08001432 if (strcmp(dev_name(dev), name))
Tejun Heof331c022008-09-03 09:01:48 +02001433 continue;
Tejun Heof331c022008-09-03 09:01:48 +02001434
Neil Brown41b8c852009-02-18 10:33:59 +01001435 if (partno < disk->minors) {
1436 /* We need to return the right devno, even
1437 * if the partition doesn't exist yet.
1438 */
1439 devt = MKDEV(MAJOR(dev->devt),
1440 MINOR(dev->devt) + partno);
1441 break;
1442 }
Tejun Heo548b10e2008-08-29 09:01:47 +02001443 part = disk_get_part(disk, partno);
Tejun Heo2bbedcb2008-08-29 11:41:51 +02001444 if (part) {
Tejun Heof331c022008-09-03 09:01:48 +02001445 devt = part_devt(part);
Tejun Heoe71bf0d2008-09-03 09:03:02 +02001446 disk_put_part(part);
Tejun Heo548b10e2008-08-29 09:01:47 +02001447 break;
Tejun Heodef4e382008-09-03 08:57:12 +02001448 }
Tejun Heo548b10e2008-08-29 09:01:47 +02001449 disk_put_part(part);
Kay Sievers5c0ef6d2008-08-16 14:30:30 +02001450 }
Tejun Heodef4e382008-09-03 08:57:12 +02001451 class_dev_iter_exit(&iter);
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001452 return devt;
1453}
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001454EXPORT_SYMBOL(blk_lookup_devt);
1455
Byungchul Parke319e1f2017-10-25 17:56:05 +09001456struct gendisk *__alloc_disk_node(int minors, int node_id)
Christoph Lameter19460892005-06-23 00:08:19 -07001457{
1458 struct gendisk *disk;
Bart Van Assche6d2cf6f2017-08-17 16:23:06 -07001459 struct disk_part_tbl *ptbl;
Christoph Lameter19460892005-06-23 00:08:19 -07001460
Christoph Hellwigde65b012017-08-23 19:10:29 +02001461 if (minors > DISK_MAX_PARTS) {
1462 printk(KERN_ERR
Randy Dunlap7fb52622017-11-18 17:43:38 -08001463 "block: can't allocate more than %d partitions\n",
Christoph Hellwigde65b012017-08-23 19:10:29 +02001464 DISK_MAX_PARTS);
1465 minors = DISK_MAX_PARTS;
1466 }
Christoph Lameter19460892005-06-23 00:08:19 -07001467
Joe Perchesc1b511e2013-08-29 15:21:42 -07001468 disk = kzalloc_node(sizeof(struct gendisk), GFP_KERNEL, node_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001469 if (disk) {
Tejun Heo074a7ac2008-08-25 19:56:14 +09001470 if (!init_part_stats(&disk->part0)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001471 kfree(disk);
1472 return NULL;
1473 }
Jan Kara56c09082018-02-26 13:01:41 +01001474 init_rwsem(&disk->lookup_sem);
Cheng Renquanbf91db12008-11-20 08:37:37 +01001475 disk->node_id = node_id;
Tejun Heo540eed52008-08-25 19:56:15 +09001476 if (disk_expand_part_tbl(disk, 0)) {
1477 free_part_stats(&disk->part0);
Tejun Heob5d0b9d2008-09-03 09:06:42 +02001478 kfree(disk);
1479 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001480 }
Bart Van Assche6d2cf6f2017-08-17 16:23:06 -07001481 ptbl = rcu_dereference_protected(disk->part_tbl, 1);
1482 rcu_assign_pointer(ptbl->part[0], &disk->part0);
Jens Axboe6c23a962011-01-07 08:43:37 +01001483
Vivek Goyalc83f6bf2012-08-01 12:24:18 +02001484 /*
1485 * set_capacity() and get_capacity() currently don't use
1486 * seqcounter to read/update the part0->nr_sects. Still init
1487 * the counter as we can read the sectors in IO submission
1488 * patch using seqence counters.
1489 *
1490 * TODO: Ideally set_capacity() and get_capacity() should be
1491 * converted to make use of bd_mutex and sequence counters.
1492 */
1493 seqcount_init(&disk->part0.nr_sects_seq);
Ming Lei6c710132015-07-16 11:16:45 +08001494 if (hd_ref_init(&disk->part0)) {
1495 hd_free_part(&disk->part0);
1496 kfree(disk);
1497 return NULL;
1498 }
Tejun Heob5d0b9d2008-09-03 09:06:42 +02001499
Linus Torvalds1da177e2005-04-16 15:20:36 -07001500 disk->minors = minors;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501 rand_initialize_disk(disk);
Tejun Heoed9e1982008-08-25 19:56:05 +09001502 disk_to_dev(disk)->class = &block_class;
1503 disk_to_dev(disk)->type = &disk_type;
1504 device_initialize(disk_to_dev(disk));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001505 }
1506 return disk;
1507}
Byungchul Parke319e1f2017-10-25 17:56:05 +09001508EXPORT_SYMBOL(__alloc_disk_node);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509
Jan Kara3079c222018-02-26 13:01:38 +01001510struct kobject *get_disk_and_module(struct gendisk *disk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001511{
1512 struct module *owner;
1513 struct kobject *kobj;
1514
1515 if (!disk->fops)
1516 return NULL;
1517 owner = disk->fops->owner;
1518 if (owner && !try_module_get(owner))
1519 return NULL;
Jan Karad01b2dc2017-03-23 01:37:02 +01001520 kobj = kobject_get_unless_zero(&disk_to_dev(disk)->kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521 if (kobj == NULL) {
1522 module_put(owner);
1523 return NULL;
1524 }
1525 return kobj;
1526
1527}
Jan Kara3079c222018-02-26 13:01:38 +01001528EXPORT_SYMBOL(get_disk_and_module);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001529
1530void put_disk(struct gendisk *disk)
1531{
1532 if (disk)
Tejun Heoed9e1982008-08-25 19:56:05 +09001533 kobject_put(&disk_to_dev(disk)->kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001534}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535EXPORT_SYMBOL(put_disk);
1536
Jan Kara9df6c292018-02-26 13:01:39 +01001537/*
1538 * This is a counterpart of get_disk_and_module() and thus also of
1539 * get_gendisk().
1540 */
1541void put_disk_and_module(struct gendisk *disk)
1542{
1543 if (disk) {
1544 struct module *owner = disk->fops->owner;
1545
1546 put_disk(disk);
1547 module_put(owner);
1548 }
1549}
1550EXPORT_SYMBOL(put_disk_and_module);
1551
Hannes Reineckee3264a42009-07-28 09:13:13 +02001552static void set_disk_ro_uevent(struct gendisk *gd, int ro)
1553{
1554 char event[] = "DISK_RO=1";
1555 char *envp[] = { event, NULL };
1556
1557 if (!ro)
1558 event[8] = '0';
1559 kobject_uevent_env(&disk_to_dev(gd)->kobj, KOBJ_CHANGE, envp);
1560}
1561
Linus Torvalds1da177e2005-04-16 15:20:36 -07001562void set_device_ro(struct block_device *bdev, int flag)
1563{
Tejun Heob7db9952008-08-25 19:56:10 +09001564 bdev->bd_part->policy = flag;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565}
1566
1567EXPORT_SYMBOL(set_device_ro);
1568
1569void set_disk_ro(struct gendisk *disk, int flag)
1570{
Tejun Heoe71bf0d2008-09-03 09:03:02 +02001571 struct disk_part_iter piter;
1572 struct hd_struct *part;
1573
Hannes Reineckee3264a42009-07-28 09:13:13 +02001574 if (disk->part0.policy != flag) {
1575 set_disk_ro_uevent(disk, flag);
1576 disk->part0.policy = flag;
1577 }
1578
1579 disk_part_iter_init(&piter, disk, DISK_PITER_INCL_EMPTY);
Tejun Heoe71bf0d2008-09-03 09:03:02 +02001580 while ((part = disk_part_iter_next(&piter)))
1581 part->policy = flag;
1582 disk_part_iter_exit(&piter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001583}
1584
1585EXPORT_SYMBOL(set_disk_ro);
1586
1587int bdev_read_only(struct block_device *bdev)
1588{
1589 if (!bdev)
1590 return 0;
Tejun Heob7db9952008-08-25 19:56:10 +09001591 return bdev->bd_part->policy;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001592}
1593
1594EXPORT_SYMBOL(bdev_read_only);
1595
Tejun Heocf771cb2008-09-03 09:01:09 +02001596int invalidate_partition(struct gendisk *disk, int partno)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001597{
1598 int res = 0;
Tejun Heocf771cb2008-09-03 09:01:09 +02001599 struct block_device *bdev = bdget_disk(disk, partno);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001600 if (bdev) {
Christoph Hellwig2ef41632005-05-05 16:15:59 -07001601 fsync_bdev(bdev);
NeilBrown93b270f2011-02-24 17:25:47 +11001602 res = __invalidate_device(bdev, true);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001603 bdput(bdev);
1604 }
1605 return res;
1606}
1607
1608EXPORT_SYMBOL(invalidate_partition);
Tejun Heo77ea8872010-12-08 20:57:37 +01001609
1610/*
1611 * Disk events - monitor disk events like media change and eject request.
1612 */
1613struct disk_events {
1614 struct list_head node; /* all disk_event's */
1615 struct gendisk *disk; /* the associated disk */
1616 spinlock_t lock;
1617
Tejun Heofdd514e2011-06-09 20:43:59 +02001618 struct mutex block_mutex; /* protects blocking */
Tejun Heo77ea8872010-12-08 20:57:37 +01001619 int block; /* event blocking depth */
1620 unsigned int pending; /* events already sent out */
1621 unsigned int clearing; /* events being cleared */
1622
1623 long poll_msecs; /* interval, -1 for default */
1624 struct delayed_work dwork;
1625};
1626
1627static const char *disk_events_strs[] = {
1628 [ilog2(DISK_EVENT_MEDIA_CHANGE)] = "media_change",
1629 [ilog2(DISK_EVENT_EJECT_REQUEST)] = "eject_request",
1630};
1631
1632static char *disk_uevents[] = {
1633 [ilog2(DISK_EVENT_MEDIA_CHANGE)] = "DISK_MEDIA_CHANGE=1",
1634 [ilog2(DISK_EVENT_EJECT_REQUEST)] = "DISK_EJECT_REQUEST=1",
1635};
1636
1637/* list of all disk_events */
1638static DEFINE_MUTEX(disk_events_mutex);
1639static LIST_HEAD(disk_events);
1640
1641/* disable in-kernel polling by default */
Wei Tang1fe8f342015-11-24 09:58:46 +08001642static unsigned long disk_events_dfl_poll_msecs;
Tejun Heo77ea8872010-12-08 20:57:37 +01001643
1644static unsigned long disk_events_poll_jiffies(struct gendisk *disk)
1645{
1646 struct disk_events *ev = disk->ev;
1647 long intv_msecs = 0;
1648
1649 /*
1650 * If device-specific poll interval is set, always use it. If
Martin Wilck673387a2019-03-27 14:51:01 +01001651 * the default is being used, poll if the POLL flag is set.
Tejun Heo77ea8872010-12-08 20:57:37 +01001652 */
1653 if (ev->poll_msecs >= 0)
1654 intv_msecs = ev->poll_msecs;
Martin Wilckc92e2f02019-03-27 14:51:02 +01001655 else if (disk->event_flags & DISK_EVENT_FLAG_POLL)
Tejun Heo77ea8872010-12-08 20:57:37 +01001656 intv_msecs = disk_events_dfl_poll_msecs;
1657
1658 return msecs_to_jiffies(intv_msecs);
1659}
1660
Tejun Heoc3af54a2011-06-09 20:43:55 +02001661/**
1662 * disk_block_events - block and flush disk event checking
1663 * @disk: disk to block events for
1664 *
1665 * On return from this function, it is guaranteed that event checking
1666 * isn't in progress and won't happen until unblocked by
1667 * disk_unblock_events(). Events blocking is counted and the actual
1668 * unblocking happens after the matching number of unblocks are done.
1669 *
1670 * Note that this intentionally does not block event checking from
1671 * disk_clear_events().
1672 *
1673 * CONTEXT:
1674 * Might sleep.
1675 */
1676void disk_block_events(struct gendisk *disk)
Tejun Heo77ea8872010-12-08 20:57:37 +01001677{
1678 struct disk_events *ev = disk->ev;
1679 unsigned long flags;
1680 bool cancel;
1681
Tejun Heoc3af54a2011-06-09 20:43:55 +02001682 if (!ev)
1683 return;
1684
Tejun Heofdd514e2011-06-09 20:43:59 +02001685 /*
1686 * Outer mutex ensures that the first blocker completes canceling
1687 * the event work before further blockers are allowed to finish.
1688 */
1689 mutex_lock(&ev->block_mutex);
1690
Tejun Heo77ea8872010-12-08 20:57:37 +01001691 spin_lock_irqsave(&ev->lock, flags);
1692 cancel = !ev->block++;
1693 spin_unlock_irqrestore(&ev->lock, flags);
1694
Tejun Heoc3af54a2011-06-09 20:43:55 +02001695 if (cancel)
1696 cancel_delayed_work_sync(&disk->ev->dwork);
Tejun Heofdd514e2011-06-09 20:43:59 +02001697
1698 mutex_unlock(&ev->block_mutex);
Tejun Heo77ea8872010-12-08 20:57:37 +01001699}
1700
1701static void __disk_unblock_events(struct gendisk *disk, bool check_now)
1702{
1703 struct disk_events *ev = disk->ev;
1704 unsigned long intv;
1705 unsigned long flags;
1706
1707 spin_lock_irqsave(&ev->lock, flags);
1708
1709 if (WARN_ON_ONCE(ev->block <= 0))
1710 goto out_unlock;
1711
1712 if (--ev->block)
1713 goto out_unlock;
1714
Tejun Heo77ea8872010-12-08 20:57:37 +01001715 intv = disk_events_poll_jiffies(disk);
Tejun Heo77ea8872010-12-08 20:57:37 +01001716 if (check_now)
Viresh Kumar695588f2013-04-24 17:12:56 +05301717 queue_delayed_work(system_freezable_power_efficient_wq,
1718 &ev->dwork, 0);
Tejun Heo77ea8872010-12-08 20:57:37 +01001719 else if (intv)
Viresh Kumar695588f2013-04-24 17:12:56 +05301720 queue_delayed_work(system_freezable_power_efficient_wq,
1721 &ev->dwork, intv);
Tejun Heo77ea8872010-12-08 20:57:37 +01001722out_unlock:
1723 spin_unlock_irqrestore(&ev->lock, flags);
1724}
1725
1726/**
Tejun Heo77ea8872010-12-08 20:57:37 +01001727 * disk_unblock_events - unblock disk event checking
1728 * @disk: disk to unblock events for
1729 *
1730 * Undo disk_block_events(). When the block count reaches zero, it
1731 * starts events polling if configured.
1732 *
1733 * CONTEXT:
1734 * Don't care. Safe to call from irq context.
1735 */
1736void disk_unblock_events(struct gendisk *disk)
1737{
1738 if (disk->ev)
Tejun Heofacc31d2011-03-09 19:54:27 +01001739 __disk_unblock_events(disk, false);
Tejun Heo77ea8872010-12-08 20:57:37 +01001740}
1741
1742/**
Tejun Heo85ef06d2011-07-01 16:17:47 +02001743 * disk_flush_events - schedule immediate event checking and flushing
1744 * @disk: disk to check and flush events for
1745 * @mask: events to flush
Tejun Heo77ea8872010-12-08 20:57:37 +01001746 *
Tejun Heo85ef06d2011-07-01 16:17:47 +02001747 * Schedule immediate event checking on @disk if not blocked. Events in
1748 * @mask are scheduled to be cleared from the driver. Note that this
1749 * doesn't clear the events from @disk->ev.
Tejun Heo77ea8872010-12-08 20:57:37 +01001750 *
1751 * CONTEXT:
Tejun Heo85ef06d2011-07-01 16:17:47 +02001752 * If @mask is non-zero must be called with bdev->bd_mutex held.
Tejun Heo77ea8872010-12-08 20:57:37 +01001753 */
Tejun Heo85ef06d2011-07-01 16:17:47 +02001754void disk_flush_events(struct gendisk *disk, unsigned int mask)
Tejun Heo77ea8872010-12-08 20:57:37 +01001755{
Tejun Heoa9dce2a2011-06-09 20:43:54 +02001756 struct disk_events *ev = disk->ev;
Tejun Heoa9dce2a2011-06-09 20:43:54 +02001757
1758 if (!ev)
1759 return;
1760
Tejun Heo85ef06d2011-07-01 16:17:47 +02001761 spin_lock_irq(&ev->lock);
1762 ev->clearing |= mask;
Tejun Heo41f63c52012-08-03 10:30:47 -07001763 if (!ev->block)
Viresh Kumar695588f2013-04-24 17:12:56 +05301764 mod_delayed_work(system_freezable_power_efficient_wq,
1765 &ev->dwork, 0);
Tejun Heo85ef06d2011-07-01 16:17:47 +02001766 spin_unlock_irq(&ev->lock);
Tejun Heo77ea8872010-12-08 20:57:37 +01001767}
Tejun Heo77ea8872010-12-08 20:57:37 +01001768
1769/**
1770 * disk_clear_events - synchronously check, clear and return pending events
1771 * @disk: disk to fetch and clear events from
Masanari Iidada3dae52014-09-09 01:27:23 +09001772 * @mask: mask of events to be fetched and cleared
Tejun Heo77ea8872010-12-08 20:57:37 +01001773 *
1774 * Disk events are synchronously checked and pending events in @mask
1775 * are cleared and returned. This ignores the block count.
1776 *
1777 * CONTEXT:
1778 * Might sleep.
1779 */
1780unsigned int disk_clear_events(struct gendisk *disk, unsigned int mask)
1781{
1782 const struct block_device_operations *bdops = disk->fops;
1783 struct disk_events *ev = disk->ev;
1784 unsigned int pending;
Derek Basehore12c2bdb2012-12-18 12:27:20 -08001785 unsigned int clearing = mask;
Tejun Heo77ea8872010-12-08 20:57:37 +01001786
1787 if (!ev) {
1788 /* for drivers still using the old ->media_changed method */
1789 if ((mask & DISK_EVENT_MEDIA_CHANGE) &&
1790 bdops->media_changed && bdops->media_changed(disk))
1791 return DISK_EVENT_MEDIA_CHANGE;
1792 return 0;
1793 }
1794
Derek Basehore12c2bdb2012-12-18 12:27:20 -08001795 disk_block_events(disk);
1796
1797 /*
1798 * store the union of mask and ev->clearing on the stack so that the
1799 * race with disk_flush_events does not cause ambiguity (ev->clearing
1800 * can still be modified even if events are blocked).
1801 */
Tejun Heo77ea8872010-12-08 20:57:37 +01001802 spin_lock_irq(&ev->lock);
Derek Basehore12c2bdb2012-12-18 12:27:20 -08001803 clearing |= ev->clearing;
1804 ev->clearing = 0;
Tejun Heo77ea8872010-12-08 20:57:37 +01001805 spin_unlock_irq(&ev->lock);
1806
Derek Basehore12c2bdb2012-12-18 12:27:20 -08001807 disk_check_events(ev, &clearing);
Derek Basehoreaea24a82012-12-18 12:27:18 -08001808 /*
Derek Basehore12c2bdb2012-12-18 12:27:20 -08001809 * if ev->clearing is not 0, the disk_flush_events got called in the
1810 * middle of this function, so we want to run the workfn without delay.
Derek Basehoreaea24a82012-12-18 12:27:18 -08001811 */
Derek Basehore12c2bdb2012-12-18 12:27:20 -08001812 __disk_unblock_events(disk, ev->clearing ? true : false);
Tejun Heo77ea8872010-12-08 20:57:37 +01001813
1814 /* then, fetch and clear pending events */
1815 spin_lock_irq(&ev->lock);
Tejun Heo77ea8872010-12-08 20:57:37 +01001816 pending = ev->pending & mask;
1817 ev->pending &= ~mask;
1818 spin_unlock_irq(&ev->lock);
Derek Basehore12c2bdb2012-12-18 12:27:20 -08001819 WARN_ON_ONCE(clearing & mask);
Tejun Heo77ea8872010-12-08 20:57:37 +01001820
1821 return pending;
1822}
1823
Derek Basehore12c2bdb2012-12-18 12:27:20 -08001824/*
1825 * Separate this part out so that a different pointer for clearing_ptr can be
1826 * passed in for disk_clear_events.
1827 */
Tejun Heo77ea8872010-12-08 20:57:37 +01001828static void disk_events_workfn(struct work_struct *work)
1829{
1830 struct delayed_work *dwork = to_delayed_work(work);
1831 struct disk_events *ev = container_of(dwork, struct disk_events, dwork);
Derek Basehore12c2bdb2012-12-18 12:27:20 -08001832
1833 disk_check_events(ev, &ev->clearing);
1834}
1835
1836static void disk_check_events(struct disk_events *ev,
1837 unsigned int *clearing_ptr)
1838{
Tejun Heo77ea8872010-12-08 20:57:37 +01001839 struct gendisk *disk = ev->disk;
1840 char *envp[ARRAY_SIZE(disk_uevents) + 1] = { };
Derek Basehore12c2bdb2012-12-18 12:27:20 -08001841 unsigned int clearing = *clearing_ptr;
Tejun Heo77ea8872010-12-08 20:57:37 +01001842 unsigned int events;
1843 unsigned long intv;
1844 int nr_events = 0, i;
1845
1846 /* check events */
1847 events = disk->fops->check_events(disk, clearing);
1848
1849 /* accumulate pending events and schedule next poll if necessary */
1850 spin_lock_irq(&ev->lock);
1851
1852 events &= ~ev->pending;
1853 ev->pending |= events;
Derek Basehore12c2bdb2012-12-18 12:27:20 -08001854 *clearing_ptr &= ~clearing;
Tejun Heo77ea8872010-12-08 20:57:37 +01001855
1856 intv = disk_events_poll_jiffies(disk);
1857 if (!ev->block && intv)
Viresh Kumar695588f2013-04-24 17:12:56 +05301858 queue_delayed_work(system_freezable_power_efficient_wq,
1859 &ev->dwork, intv);
Tejun Heo77ea8872010-12-08 20:57:37 +01001860
1861 spin_unlock_irq(&ev->lock);
1862
Tejun Heo7c88a162011-04-21 19:43:58 +02001863 /*
1864 * Tell userland about new events. Only the events listed in
Martin Wilckc92e2f02019-03-27 14:51:02 +01001865 * @disk->events are reported, and only if DISK_EVENT_FLAG_UEVENT
1866 * is set. Otherwise, events are processed internally but never
1867 * get reported to userland.
Tejun Heo7c88a162011-04-21 19:43:58 +02001868 */
Tejun Heo77ea8872010-12-08 20:57:37 +01001869 for (i = 0; i < ARRAY_SIZE(disk_uevents); i++)
Martin Wilckc92e2f02019-03-27 14:51:02 +01001870 if ((events & disk->events & (1 << i)) &&
1871 (disk->event_flags & DISK_EVENT_FLAG_UEVENT))
Tejun Heo77ea8872010-12-08 20:57:37 +01001872 envp[nr_events++] = disk_uevents[i];
1873
1874 if (nr_events)
1875 kobject_uevent_env(&disk_to_dev(disk)->kobj, KOBJ_CHANGE, envp);
1876}
1877
1878/*
1879 * A disk events enabled device has the following sysfs nodes under
1880 * its /sys/block/X/ directory.
1881 *
1882 * events : list of all supported events
1883 * events_async : list of events which can be detected w/o polling
Martin Wilck673387a2019-03-27 14:51:01 +01001884 * (always empty, only for backwards compatibility)
Tejun Heo77ea8872010-12-08 20:57:37 +01001885 * events_poll_msecs : polling interval, 0: disable, -1: system default
1886 */
1887static ssize_t __disk_events_show(unsigned int events, char *buf)
1888{
1889 const char *delim = "";
1890 ssize_t pos = 0;
1891 int i;
1892
1893 for (i = 0; i < ARRAY_SIZE(disk_events_strs); i++)
1894 if (events & (1 << i)) {
1895 pos += sprintf(buf + pos, "%s%s",
1896 delim, disk_events_strs[i]);
1897 delim = " ";
1898 }
1899 if (pos)
1900 pos += sprintf(buf + pos, "\n");
1901 return pos;
1902}
1903
1904static ssize_t disk_events_show(struct device *dev,
1905 struct device_attribute *attr, char *buf)
1906{
1907 struct gendisk *disk = dev_to_disk(dev);
1908
Martin Wilckc92e2f02019-03-27 14:51:02 +01001909 if (!(disk->event_flags & DISK_EVENT_FLAG_UEVENT))
1910 return 0;
1911
Tejun Heo77ea8872010-12-08 20:57:37 +01001912 return __disk_events_show(disk->events, buf);
1913}
1914
1915static ssize_t disk_events_async_show(struct device *dev,
1916 struct device_attribute *attr, char *buf)
1917{
Martin Wilck673387a2019-03-27 14:51:01 +01001918 return 0;
Tejun Heo77ea8872010-12-08 20:57:37 +01001919}
1920
1921static ssize_t disk_events_poll_msecs_show(struct device *dev,
1922 struct device_attribute *attr,
1923 char *buf)
1924{
1925 struct gendisk *disk = dev_to_disk(dev);
1926
Martin Wilckcdf3e3d2019-03-27 14:51:05 +01001927 if (!disk->ev)
1928 return sprintf(buf, "-1\n");
1929
Tejun Heo77ea8872010-12-08 20:57:37 +01001930 return sprintf(buf, "%ld\n", disk->ev->poll_msecs);
1931}
1932
1933static ssize_t disk_events_poll_msecs_store(struct device *dev,
1934 struct device_attribute *attr,
1935 const char *buf, size_t count)
1936{
1937 struct gendisk *disk = dev_to_disk(dev);
1938 long intv;
1939
1940 if (!count || !sscanf(buf, "%ld", &intv))
1941 return -EINVAL;
1942
1943 if (intv < 0 && intv != -1)
1944 return -EINVAL;
1945
Martin Wilckcdf3e3d2019-03-27 14:51:05 +01001946 if (!disk->ev)
1947 return -ENODEV;
1948
Tejun Heoc3af54a2011-06-09 20:43:55 +02001949 disk_block_events(disk);
Tejun Heo77ea8872010-12-08 20:57:37 +01001950 disk->ev->poll_msecs = intv;
1951 __disk_unblock_events(disk, true);
1952
1953 return count;
1954}
1955
Joe Perches5657a812018-05-24 13:38:59 -06001956static const DEVICE_ATTR(events, 0444, disk_events_show, NULL);
1957static const DEVICE_ATTR(events_async, 0444, disk_events_async_show, NULL);
1958static const DEVICE_ATTR(events_poll_msecs, 0644,
Tejun Heo77ea8872010-12-08 20:57:37 +01001959 disk_events_poll_msecs_show,
1960 disk_events_poll_msecs_store);
1961
1962static const struct attribute *disk_events_attrs[] = {
1963 &dev_attr_events.attr,
1964 &dev_attr_events_async.attr,
1965 &dev_attr_events_poll_msecs.attr,
1966 NULL,
1967};
1968
1969/*
1970 * The default polling interval can be specified by the kernel
1971 * parameter block.events_dfl_poll_msecs which defaults to 0
1972 * (disable). This can also be modified runtime by writing to
1973 * /sys/module/block/events_dfl_poll_msecs.
1974 */
1975static int disk_events_set_dfl_poll_msecs(const char *val,
1976 const struct kernel_param *kp)
1977{
1978 struct disk_events *ev;
1979 int ret;
1980
1981 ret = param_set_ulong(val, kp);
1982 if (ret < 0)
1983 return ret;
1984
1985 mutex_lock(&disk_events_mutex);
1986
1987 list_for_each_entry(ev, &disk_events, node)
Tejun Heo85ef06d2011-07-01 16:17:47 +02001988 disk_flush_events(ev->disk, 0);
Tejun Heo77ea8872010-12-08 20:57:37 +01001989
1990 mutex_unlock(&disk_events_mutex);
1991
1992 return 0;
1993}
1994
1995static const struct kernel_param_ops disk_events_dfl_poll_msecs_param_ops = {
1996 .set = disk_events_set_dfl_poll_msecs,
1997 .get = param_get_ulong,
1998};
1999
2000#undef MODULE_PARAM_PREFIX
2001#define MODULE_PARAM_PREFIX "block."
2002
2003module_param_cb(events_dfl_poll_msecs, &disk_events_dfl_poll_msecs_param_ops,
2004 &disk_events_dfl_poll_msecs, 0644);
2005
2006/*
Stanislaw Gruszka9f53d2fe2012-03-02 10:43:28 +01002007 * disk_{alloc|add|del|release}_events - initialize and destroy disk_events.
Tejun Heo77ea8872010-12-08 20:57:37 +01002008 */
Stanislaw Gruszka9f53d2fe2012-03-02 10:43:28 +01002009static void disk_alloc_events(struct gendisk *disk)
Tejun Heo77ea8872010-12-08 20:57:37 +01002010{
2011 struct disk_events *ev;
2012
Martin Wilckcdf3e3d2019-03-27 14:51:05 +01002013 if (!disk->fops->check_events || !disk->events)
Tejun Heo77ea8872010-12-08 20:57:37 +01002014 return;
2015
2016 ev = kzalloc(sizeof(*ev), GFP_KERNEL);
2017 if (!ev) {
2018 pr_warn("%s: failed to initialize events\n", disk->disk_name);
2019 return;
2020 }
2021
Tejun Heo77ea8872010-12-08 20:57:37 +01002022 INIT_LIST_HEAD(&ev->node);
2023 ev->disk = disk;
2024 spin_lock_init(&ev->lock);
Tejun Heofdd514e2011-06-09 20:43:59 +02002025 mutex_init(&ev->block_mutex);
Tejun Heo77ea8872010-12-08 20:57:37 +01002026 ev->block = 1;
2027 ev->poll_msecs = -1;
2028 INIT_DELAYED_WORK(&ev->dwork, disk_events_workfn);
2029
Stanislaw Gruszka9f53d2fe2012-03-02 10:43:28 +01002030 disk->ev = ev;
2031}
2032
2033static void disk_add_events(struct gendisk *disk)
2034{
Stanislaw Gruszka9f53d2fe2012-03-02 10:43:28 +01002035 /* FIXME: error handling */
2036 if (sysfs_create_files(&disk_to_dev(disk)->kobj, disk_events_attrs) < 0)
2037 pr_warn("%s: failed to create sysfs files for events\n",
2038 disk->disk_name);
2039
Martin Wilckcdf3e3d2019-03-27 14:51:05 +01002040 if (!disk->ev)
2041 return;
2042
Tejun Heo77ea8872010-12-08 20:57:37 +01002043 mutex_lock(&disk_events_mutex);
Stanislaw Gruszka9f53d2fe2012-03-02 10:43:28 +01002044 list_add_tail(&disk->ev->node, &disk_events);
Tejun Heo77ea8872010-12-08 20:57:37 +01002045 mutex_unlock(&disk_events_mutex);
2046
2047 /*
2048 * Block count is initialized to 1 and the following initial
2049 * unblock kicks it into action.
2050 */
2051 __disk_unblock_events(disk, true);
2052}
2053
2054static void disk_del_events(struct gendisk *disk)
2055{
Martin Wilckcdf3e3d2019-03-27 14:51:05 +01002056 if (disk->ev) {
2057 disk_block_events(disk);
Tejun Heo77ea8872010-12-08 20:57:37 +01002058
Martin Wilckcdf3e3d2019-03-27 14:51:05 +01002059 mutex_lock(&disk_events_mutex);
2060 list_del_init(&disk->ev->node);
2061 mutex_unlock(&disk_events_mutex);
2062 }
Tejun Heo77ea8872010-12-08 20:57:37 +01002063
2064 sysfs_remove_files(&disk_to_dev(disk)->kobj, disk_events_attrs);
2065}
2066
2067static void disk_release_events(struct gendisk *disk)
2068{
2069 /* the block count should be 1 from disk_del_events() */
2070 WARN_ON_ONCE(disk->ev && disk->ev->block != 1);
2071 kfree(disk->ev);
2072}