blob: 9c2e13ce0d19554a01eb72c03d5c0fcba7a67a5a [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
Shin'ichiro Kawasakib53df2e2020-02-21 10:37:08 +0900304/**
305 * disk_has_partitions
306 * @disk: gendisk of interest
307 *
308 * Walk through the partition table and check if valid partition exists.
309 *
310 * CONTEXT:
311 * Don't care.
312 *
313 * RETURNS:
314 * True if the gendisk has at least one valid non-zero size partition.
315 * Otherwise false.
316 */
317bool disk_has_partitions(struct gendisk *disk)
318{
319 struct disk_part_tbl *ptbl;
320 int i;
321 bool ret = false;
322
323 rcu_read_lock();
324 ptbl = rcu_dereference(disk->part_tbl);
325
326 /* Iterate partitions skipping the whole device at index 0 */
327 for (i = 1; i < ptbl->len; i++) {
328 if (rcu_dereference(ptbl->part[i])) {
329 ret = true;
330 break;
331 }
332 }
333
334 rcu_read_unlock();
335
336 return ret;
337}
338EXPORT_SYMBOL_GPL(disk_has_partitions);
339
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340/*
341 * Can be deleted altogether. Later.
342 *
343 */
Logan Gunthorpe133d55c2017-06-16 17:48:21 -0600344#define BLKDEV_MAJOR_HASH_SIZE 255
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345static struct blk_major_name {
346 struct blk_major_name *next;
347 int major;
348 char name[16];
Joe Korty68eef3b2006-03-31 02:30:32 -0800349} *major_names[BLKDEV_MAJOR_HASH_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350
351/* index in the above - for now: assume no multimajor ranges */
Yang Zhange61eb2e2010-12-17 09:00:18 +0100352static inline int major_to_index(unsigned major)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353{
Joe Korty68eef3b2006-03-31 02:30:32 -0800354 return major % BLKDEV_MAJOR_HASH_SIZE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355}
356
Joe Korty68eef3b2006-03-31 02:30:32 -0800357#ifdef CONFIG_PROC_FS
Tejun Heocf771cb2008-09-03 09:01:09 +0200358void blkdev_show(struct seq_file *seqf, off_t offset)
Neil Horman7170be52006-01-14 13:20:38 -0800359{
Joe Korty68eef3b2006-03-31 02:30:32 -0800360 struct blk_major_name *dp;
Neil Horman7170be52006-01-14 13:20:38 -0800361
Logan Gunthorpe133d55c2017-06-16 17:48:21 -0600362 mutex_lock(&block_class_lock);
363 for (dp = major_names[major_to_index(offset)]; dp; dp = dp->next)
364 if (dp->major == offset)
Tejun Heocf771cb2008-09-03 09:01:09 +0200365 seq_printf(seqf, "%3d %s\n", dp->major, dp->name);
Logan Gunthorpe133d55c2017-06-16 17:48:21 -0600366 mutex_unlock(&block_class_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367}
Joe Korty68eef3b2006-03-31 02:30:32 -0800368#endif /* CONFIG_PROC_FS */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369
Márton Németh9e8c0bc2009-02-20 08:12:51 +0100370/**
371 * register_blkdev - register a new block device
372 *
Srivatsa S. Bhatf33ff112018-02-05 18:25:27 -0800373 * @major: the requested major device number [1..BLKDEV_MAJOR_MAX-1]. If
374 * @major = 0, try to allocate any unused major number.
Márton Németh9e8c0bc2009-02-20 08:12:51 +0100375 * @name: the name of the new block device as a zero terminated string
376 *
377 * The @name must be unique within the system.
378 *
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -0300379 * The return value depends on the @major input parameter:
380 *
Srivatsa S. Bhatf33ff112018-02-05 18:25:27 -0800381 * - if a major device number was requested in range [1..BLKDEV_MAJOR_MAX-1]
382 * then the function returns zero on success, or a negative error code
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -0300383 * - if any unused major number was requested with @major = 0 parameter
Márton Németh9e8c0bc2009-02-20 08:12:51 +0100384 * then the return value is the allocated major number in range
Srivatsa S. Bhatf33ff112018-02-05 18:25:27 -0800385 * [1..BLKDEV_MAJOR_MAX-1] or a negative error code otherwise
386 *
387 * See Documentation/admin-guide/devices.txt for the list of allocated
388 * major numbers.
Márton Németh9e8c0bc2009-02-20 08:12:51 +0100389 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390int register_blkdev(unsigned int major, const char *name)
391{
392 struct blk_major_name **n, *p;
393 int index, ret = 0;
394
Kay Sieversedfaa7c2007-05-21 22:08:01 +0200395 mutex_lock(&block_class_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396
397 /* temporary */
398 if (major == 0) {
399 for (index = ARRAY_SIZE(major_names)-1; index > 0; index--) {
400 if (major_names[index] == NULL)
401 break;
402 }
403
404 if (index == 0) {
Keyur Pateldfc76d12019-02-17 10:21:56 -0500405 printk("%s: failed to get major for %s\n",
406 __func__, name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407 ret = -EBUSY;
408 goto out;
409 }
410 major = index;
411 ret = major;
412 }
413
Logan Gunthorpe133d55c2017-06-16 17:48:21 -0600414 if (major >= BLKDEV_MAJOR_MAX) {
Keyur Pateldfc76d12019-02-17 10:21:56 -0500415 pr_err("%s: major requested (%u) is greater than the maximum (%u) for %s\n",
416 __func__, major, BLKDEV_MAJOR_MAX-1, name);
Logan Gunthorpe133d55c2017-06-16 17:48:21 -0600417
418 ret = -EINVAL;
419 goto out;
420 }
421
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422 p = kmalloc(sizeof(struct blk_major_name), GFP_KERNEL);
423 if (p == NULL) {
424 ret = -ENOMEM;
425 goto out;
426 }
427
428 p->major = major;
429 strlcpy(p->name, name, sizeof(p->name));
430 p->next = NULL;
431 index = major_to_index(major);
432
433 for (n = &major_names[index]; *n; n = &(*n)->next) {
434 if ((*n)->major == major)
435 break;
436 }
437 if (!*n)
438 *n = p;
439 else
440 ret = -EBUSY;
441
442 if (ret < 0) {
Srivatsa S. Bhatf33ff112018-02-05 18:25:27 -0800443 printk("register_blkdev: cannot get major %u for %s\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444 major, name);
445 kfree(p);
446 }
447out:
Kay Sieversedfaa7c2007-05-21 22:08:01 +0200448 mutex_unlock(&block_class_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449 return ret;
450}
451
452EXPORT_SYMBOL(register_blkdev);
453
Akinobu Mitaf4480242007-07-17 04:03:47 -0700454void unregister_blkdev(unsigned int major, const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455{
456 struct blk_major_name **n;
457 struct blk_major_name *p = NULL;
458 int index = major_to_index(major);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459
Kay Sieversedfaa7c2007-05-21 22:08:01 +0200460 mutex_lock(&block_class_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461 for (n = &major_names[index]; *n; n = &(*n)->next)
462 if ((*n)->major == major)
463 break;
Akinobu Mita294462a2007-07-17 04:03:45 -0700464 if (!*n || strcmp((*n)->name, name)) {
465 WARN_ON(1);
Akinobu Mita294462a2007-07-17 04:03:45 -0700466 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467 p = *n;
468 *n = p->next;
469 }
Kay Sieversedfaa7c2007-05-21 22:08:01 +0200470 mutex_unlock(&block_class_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471 kfree(p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472}
473
474EXPORT_SYMBOL(unregister_blkdev);
475
476static struct kobj_map *bdev_map;
477
Tejun Heobcce3de2008-08-25 19:47:22 +0900478/**
Tejun Heo870d6652008-08-25 19:47:25 +0900479 * blk_mangle_minor - scatter minor numbers apart
480 * @minor: minor number to mangle
481 *
482 * Scatter consecutively allocated @minor number apart if MANGLE_DEVT
483 * is enabled. Mangling twice gives the original value.
484 *
485 * RETURNS:
486 * Mangled value.
487 *
488 * CONTEXT:
489 * Don't care.
490 */
491static int blk_mangle_minor(int minor)
492{
493#ifdef CONFIG_DEBUG_BLOCK_EXT_DEVT
494 int i;
495
496 for (i = 0; i < MINORBITS / 2; i++) {
497 int low = minor & (1 << i);
498 int high = minor & (1 << (MINORBITS - 1 - i));
499 int distance = MINORBITS - 1 - 2 * i;
500
501 minor ^= low | high; /* clear both bits */
502 low <<= distance; /* swap the positions */
503 high >>= distance;
504 minor |= low | high; /* and set */
505 }
506#endif
507 return minor;
508}
509
510/**
Tejun Heobcce3de2008-08-25 19:47:22 +0900511 * blk_alloc_devt - allocate a dev_t for a partition
512 * @part: partition to allocate dev_t for
Tejun Heobcce3de2008-08-25 19:47:22 +0900513 * @devt: out parameter for resulting dev_t
514 *
515 * Allocate a dev_t for block device.
516 *
517 * RETURNS:
518 * 0 on success, allocated dev_t is returned in *@devt. -errno on
519 * failure.
520 *
521 * CONTEXT:
522 * Might sleep.
523 */
524int blk_alloc_devt(struct hd_struct *part, dev_t *devt)
525{
526 struct gendisk *disk = part_to_disk(part);
Tejun Heobab998d2013-02-27 17:03:57 -0800527 int idx;
Tejun Heobcce3de2008-08-25 19:47:22 +0900528
529 /* in consecutive minor range? */
530 if (part->partno < disk->minors) {
531 *devt = MKDEV(disk->major, disk->first_minor + part->partno);
532 return 0;
533 }
534
535 /* allocate ext devt */
Keith Busch2da78092014-08-26 09:05:36 -0600536 idr_preload(GFP_KERNEL);
537
Dan Williams4d66e5e2015-06-10 23:47:14 -0400538 spin_lock_bh(&ext_devt_lock);
Keith Busch2da78092014-08-26 09:05:36 -0600539 idx = idr_alloc(&ext_devt_idr, part, 0, NR_EXT_DEVT, GFP_NOWAIT);
Dan Williams4d66e5e2015-06-10 23:47:14 -0400540 spin_unlock_bh(&ext_devt_lock);
Keith Busch2da78092014-08-26 09:05:36 -0600541
542 idr_preload_end();
Tejun Heobab998d2013-02-27 17:03:57 -0800543 if (idx < 0)
544 return idx == -ENOSPC ? -EBUSY : idx;
Tejun Heobcce3de2008-08-25 19:47:22 +0900545
Tejun Heo870d6652008-08-25 19:47:25 +0900546 *devt = MKDEV(BLOCK_EXT_MAJOR, blk_mangle_minor(idx));
Tejun Heobcce3de2008-08-25 19:47:22 +0900547 return 0;
548}
549
550/**
551 * blk_free_devt - free a dev_t
552 * @devt: dev_t to free
553 *
554 * Free @devt which was allocated using blk_alloc_devt().
555 *
556 * CONTEXT:
557 * Might sleep.
558 */
559void blk_free_devt(dev_t devt)
560{
Tejun Heobcce3de2008-08-25 19:47:22 +0900561 if (devt == MKDEV(0, 0))
562 return;
563
564 if (MAJOR(devt) == BLOCK_EXT_MAJOR) {
Dan Williams4d66e5e2015-06-10 23:47:14 -0400565 spin_lock_bh(&ext_devt_lock);
Tejun Heo870d6652008-08-25 19:47:25 +0900566 idr_remove(&ext_devt_idr, blk_mangle_minor(MINOR(devt)));
Dan Williams4d66e5e2015-06-10 23:47:14 -0400567 spin_unlock_bh(&ext_devt_lock);
Tejun Heobcce3de2008-08-25 19:47:22 +0900568 }
569}
570
Bart Van Assche33c826e2019-05-30 17:00:47 -0700571/*
572 * We invalidate devt by assigning NULL pointer for devt in idr.
Yufen Yu6fcc44d2019-04-02 20:06:34 +0800573 */
574void blk_invalidate_devt(dev_t devt)
575{
576 if (MAJOR(devt) == BLOCK_EXT_MAJOR) {
577 spin_lock_bh(&ext_devt_lock);
578 idr_replace(&ext_devt_idr, NULL, blk_mangle_minor(MINOR(devt)));
579 spin_unlock_bh(&ext_devt_lock);
580 }
581}
582
Tejun Heo1f014292008-08-25 19:47:23 +0900583static char *bdevt_str(dev_t devt, char *buf)
584{
585 if (MAJOR(devt) <= 0xff && MINOR(devt) <= 0xff) {
586 char tbuf[BDEVT_SIZE];
587 snprintf(tbuf, BDEVT_SIZE, "%02x%02x", MAJOR(devt), MINOR(devt));
588 snprintf(buf, BDEVT_SIZE, "%-9s", tbuf);
589 } else
590 snprintf(buf, BDEVT_SIZE, "%03x:%05x", MAJOR(devt), MINOR(devt));
591
592 return buf;
593}
594
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595/*
596 * Register device numbers dev..(dev+range-1)
597 * range must be nonzero
598 * The hash chain is sorted on range, so that subranges can override.
599 */
Kay Sieversedfaa7c2007-05-21 22:08:01 +0200600void blk_register_region(dev_t devt, unsigned long range, struct module *module,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601 struct kobject *(*probe)(dev_t, int *, void *),
602 int (*lock)(dev_t, void *), void *data)
603{
Kay Sieversedfaa7c2007-05-21 22:08:01 +0200604 kobj_map(bdev_map, devt, range, module, probe, lock, data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605}
606
607EXPORT_SYMBOL(blk_register_region);
608
Kay Sieversedfaa7c2007-05-21 22:08:01 +0200609void blk_unregister_region(dev_t devt, unsigned long range)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610{
Kay Sieversedfaa7c2007-05-21 22:08:01 +0200611 kobj_unmap(bdev_map, devt, range);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612}
613
614EXPORT_SYMBOL(blk_unregister_region);
615
Tejun Heocf771cb2008-09-03 09:01:09 +0200616static struct kobject *exact_match(dev_t devt, int *partno, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617{
618 struct gendisk *p = data;
Kay Sieversedfaa7c2007-05-21 22:08:01 +0200619
Tejun Heoed9e1982008-08-25 19:56:05 +0900620 return &disk_to_dev(p)->kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621}
622
Kay Sieversedfaa7c2007-05-21 22:08:01 +0200623static int exact_lock(dev_t devt, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624{
625 struct gendisk *p = data;
626
Jan Kara3079c222018-02-26 13:01:38 +0100627 if (!get_disk_and_module(p))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628 return -1;
629 return 0;
630}
631
Hannes Reineckefef912b2018-09-28 08:17:19 +0200632static void register_disk(struct device *parent, struct gendisk *disk,
633 const struct attribute_group **groups)
Tejun Heod2bf1b62010-12-08 20:57:36 +0100634{
635 struct device *ddev = disk_to_dev(disk);
636 struct block_device *bdev;
637 struct disk_part_iter piter;
638 struct hd_struct *part;
639 int err;
640
Dan Williamse63a46b2016-06-15 18:17:27 -0700641 ddev->parent = parent;
Tejun Heod2bf1b62010-12-08 20:57:36 +0100642
Kees Cookffc8b302013-07-03 15:01:14 -0700643 dev_set_name(ddev, "%s", disk->disk_name);
Tejun Heod2bf1b62010-12-08 20:57:36 +0100644
645 /* delay uevents, until we scanned partition table */
646 dev_set_uevent_suppress(ddev, 1);
647
Hannes Reineckefef912b2018-09-28 08:17:19 +0200648 if (groups) {
649 WARN_ON(ddev->groups);
650 ddev->groups = groups;
651 }
Tejun Heod2bf1b62010-12-08 20:57:36 +0100652 if (device_add(ddev))
653 return;
654 if (!sysfs_deprecated) {
655 err = sysfs_create_link(block_depr, &ddev->kobj,
656 kobject_name(&ddev->kobj));
657 if (err) {
658 device_del(ddev);
659 return;
660 }
661 }
Ming Lei25e823c2013-02-22 16:34:13 -0800662
663 /*
664 * avoid probable deadlock caused by allocating memory with
665 * GFP_KERNEL in runtime_resume callback of its all ancestor
666 * devices
667 */
668 pm_runtime_set_memalloc_noio(ddev, true);
669
Tejun Heod2bf1b62010-12-08 20:57:36 +0100670 disk->part0.holder_dir = kobject_create_and_add("holders", &ddev->kobj);
671 disk->slave_dir = kobject_create_and_add("slaves", &ddev->kobj);
672
Christoph Hellwig8ddcd652017-11-02 21:29:53 +0300673 if (disk->flags & GENHD_FL_HIDDEN) {
674 dev_set_uevent_suppress(ddev, 0);
675 return;
676 }
677
Tejun Heod2bf1b62010-12-08 20:57:36 +0100678 /* No minors to use for partitions */
Tejun Heod27769e2011-08-23 20:01:04 +0200679 if (!disk_part_scan_enabled(disk))
Tejun Heod2bf1b62010-12-08 20:57:36 +0100680 goto exit;
681
682 /* No such device (e.g., media were just removed) */
683 if (!get_capacity(disk))
684 goto exit;
685
686 bdev = bdget_disk(disk, 0);
687 if (!bdev)
688 goto exit;
689
690 bdev->bd_invalidated = 1;
691 err = blkdev_get(bdev, FMODE_READ, NULL);
692 if (err < 0)
693 goto exit;
694 blkdev_put(bdev, FMODE_READ);
695
696exit:
697 /* announce disk after possible partitions are created */
698 dev_set_uevent_suppress(ddev, 0);
699 kobject_uevent(&ddev->kobj, KOBJ_ADD);
700
701 /* announce possible partitions */
702 disk_part_iter_init(&piter, disk, 0);
703 while ((part = disk_part_iter_next(&piter)))
704 kobject_uevent(&part_to_dev(part)->kobj, KOBJ_ADD);
705 disk_part_iter_exit(&piter);
Christoph Hellwig8ddcd652017-11-02 21:29:53 +0300706
zhengbin4d7c1d32019-02-20 21:27:05 +0800707 if (disk->queue->backing_dev_info->dev) {
708 err = sysfs_create_link(&ddev->kobj,
709 &disk->queue->backing_dev_info->dev->kobj,
710 "bdi");
711 WARN_ON(err);
712 }
Tejun Heod2bf1b62010-12-08 20:57:36 +0100713}
714
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715/**
Mike Snitzerfa70d2e2018-01-08 22:01:13 -0500716 * __device_add_disk - add disk information to kernel list
Dan Williamse63a46b2016-06-15 18:17:27 -0700717 * @parent: parent device for the disk
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718 * @disk: per-device partitioning information
Hannes Reineckefef912b2018-09-28 08:17:19 +0200719 * @groups: Additional per-device sysfs groups
Mike Snitzerfa70d2e2018-01-08 22:01:13 -0500720 * @register_queue: register the queue if set to true
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721 *
722 * This function registers the partitioning information in @disk
723 * with the kernel.
Tejun Heo3e1a7ff2008-08-25 19:56:17 +0900724 *
725 * FIXME: error handling
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726 */
Mike Snitzerfa70d2e2018-01-08 22:01:13 -0500727static void __device_add_disk(struct device *parent, struct gendisk *disk,
Hannes Reineckefef912b2018-09-28 08:17:19 +0200728 const struct attribute_group **groups,
Mike Snitzerfa70d2e2018-01-08 22:01:13 -0500729 bool register_queue)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730{
Tejun Heo3e1a7ff2008-08-25 19:56:17 +0900731 dev_t devt;
Greg Kroah-Hartman6ffeea72008-05-22 17:21:08 -0400732 int retval;
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700733
Damien Le Moal737eb782019-09-05 18:51:33 +0900734 /*
735 * The disk queue should now be all set with enough information about
736 * the device for the elevator code to pick an adequate default
737 * elevator if one is needed, that is, for devices requesting queue
738 * registration.
739 */
740 if (register_queue)
741 elevator_init_mq(disk->queue);
742
Tejun Heo3e1a7ff2008-08-25 19:56:17 +0900743 /* minors == 0 indicates to use ext devt from part0 and should
744 * be accompanied with EXT_DEVT flag. Make sure all
745 * parameters make sense.
746 */
747 WARN_ON(disk->minors && !(disk->major || disk->first_minor));
Christoph Hellwig8ddcd652017-11-02 21:29:53 +0300748 WARN_ON(!disk->minors &&
749 !(disk->flags & (GENHD_FL_EXT_DEVT | GENHD_FL_HIDDEN)));
Tejun Heo3e1a7ff2008-08-25 19:56:17 +0900750
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 disk->flags |= GENHD_FL_UP;
Tejun Heo3e1a7ff2008-08-25 19:56:17 +0900752
753 retval = blk_alloc_devt(&disk->part0, &devt);
754 if (retval) {
755 WARN_ON(1);
756 return;
757 }
Tejun Heo3e1a7ff2008-08-25 19:56:17 +0900758 disk->major = MAJOR(devt);
759 disk->first_minor = MINOR(devt);
760
Stanislaw Gruszka9f53d2fe2012-03-02 10:43:28 +0100761 disk_alloc_events(disk);
762
Christoph Hellwig8ddcd652017-11-02 21:29:53 +0300763 if (disk->flags & GENHD_FL_HIDDEN) {
764 /*
765 * Don't let hidden disks show up in /proc/partitions,
766 * and don't bother scanning for partitions either.
767 */
768 disk->flags |= GENHD_FL_SUPPRESS_PARTITION_INFO;
769 disk->flags |= GENHD_FL_NO_PART_SCAN;
770 } else {
weiping zhang3a921682017-10-31 18:38:59 +0800771 int ret;
772
Christoph Hellwig8ddcd652017-11-02 21:29:53 +0300773 /* Register BDI before referencing it from bdev */
774 disk_to_dev(disk)->devt = devt;
weiping zhang3a921682017-10-31 18:38:59 +0800775 ret = bdi_register_owner(disk->queue->backing_dev_info,
776 disk_to_dev(disk));
777 WARN_ON(ret);
Christoph Hellwig8ddcd652017-11-02 21:29:53 +0300778 blk_register_region(disk_devt(disk), disk->minors, NULL,
779 exact_match, exact_lock, disk);
780 }
Hannes Reineckefef912b2018-09-28 08:17:19 +0200781 register_disk(parent, disk, groups);
Mike Snitzerfa70d2e2018-01-08 22:01:13 -0500782 if (register_queue)
783 blk_register_queue(disk);
Peter Zijlstracf0ca9f2008-04-30 00:54:32 -0700784
Tejun Heo523e1d32011-10-19 14:31:07 +0200785 /*
786 * Take an extra ref on queue which will be put on disk_release()
787 * so that it sticks around as long as @disk is there.
788 */
Tejun Heo09ac46c2011-12-14 00:33:38 +0100789 WARN_ON_ONCE(!blk_get_queue(disk->queue));
Tejun Heo523e1d32011-10-19 14:31:07 +0200790
Tejun Heo77ea8872010-12-08 20:57:37 +0100791 disk_add_events(disk);
Martin K. Petersen25520d52015-10-21 13:19:49 -0400792 blk_integrity_add(disk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793}
Mike Snitzerfa70d2e2018-01-08 22:01:13 -0500794
Hannes Reineckefef912b2018-09-28 08:17:19 +0200795void device_add_disk(struct device *parent, struct gendisk *disk,
796 const struct attribute_group **groups)
797
Mike Snitzerfa70d2e2018-01-08 22:01:13 -0500798{
Hannes Reineckefef912b2018-09-28 08:17:19 +0200799 __device_add_disk(parent, disk, groups, true);
Mike Snitzerfa70d2e2018-01-08 22:01:13 -0500800}
Dan Williamse63a46b2016-06-15 18:17:27 -0700801EXPORT_SYMBOL(device_add_disk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802
Mike Snitzerfa70d2e2018-01-08 22:01:13 -0500803void device_add_disk_no_queue_reg(struct device *parent, struct gendisk *disk)
804{
Hannes Reineckefef912b2018-09-28 08:17:19 +0200805 __device_add_disk(parent, disk, NULL, false);
Mike Snitzerfa70d2e2018-01-08 22:01:13 -0500806}
807EXPORT_SYMBOL(device_add_disk_no_queue_reg);
808
Tejun Heod2bf1b62010-12-08 20:57:36 +0100809void del_gendisk(struct gendisk *disk)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810{
Tejun Heod2bf1b62010-12-08 20:57:36 +0100811 struct disk_part_iter piter;
812 struct hd_struct *part;
813
Martin K. Petersen25520d52015-10-21 13:19:49 -0400814 blk_integrity_del(disk);
Tejun Heo77ea8872010-12-08 20:57:37 +0100815 disk_del_events(disk);
816
Jan Kara56c09082018-02-26 13:01:41 +0100817 /*
818 * Block lookups of the disk until all bdevs are unhashed and the
819 * disk is marked as dead (GENHD_FL_UP cleared).
820 */
821 down_write(&disk->lookup_sem);
Tejun Heod2bf1b62010-12-08 20:57:36 +0100822 /* invalidate stuff */
823 disk_part_iter_init(&piter, disk,
824 DISK_PITER_INCL_EMPTY | DISK_PITER_REVERSE);
825 while ((part = disk_part_iter_next(&piter))) {
826 invalidate_partition(disk, part->partno);
Jan Kara4b8c8612017-02-21 18:09:46 +0100827 bdev_unhash_inode(part_devt(part));
Tejun Heod2bf1b62010-12-08 20:57:36 +0100828 delete_partition(disk, part->partno);
829 }
830 disk_part_iter_exit(&piter);
831
832 invalidate_partition(disk, 0);
Jan Karad06e05c2017-02-21 18:09:47 +0100833 bdev_unhash_inode(disk_devt(disk));
Tejun Heod2bf1b62010-12-08 20:57:36 +0100834 set_capacity(disk, 0);
835 disk->flags &= ~GENHD_FL_UP;
Jan Kara56c09082018-02-26 13:01:41 +0100836 up_write(&disk->lookup_sem);
Tejun Heod2bf1b62010-12-08 20:57:36 +0100837
Christoph Hellwig8ddcd652017-11-02 21:29:53 +0300838 if (!(disk->flags & GENHD_FL_HIDDEN))
839 sysfs_remove_link(&disk_to_dev(disk)->kobj, "bdi");
Jan Kara90f16fd2017-03-08 17:48:33 +0100840 if (disk->queue) {
841 /*
842 * Unregister bdi before releasing device numbers (as they can
843 * get reused and we'd get clashes in sysfs).
844 */
Mike Snitzerbc8d0622018-01-09 20:46:49 -0500845 if (!(disk->flags & GENHD_FL_HIDDEN))
846 bdi_unregister(disk->queue->backing_dev_info);
Jan Kara90f16fd2017-03-08 17:48:33 +0100847 blk_unregister_queue(disk);
848 } else {
849 WARN_ON(1);
850 }
Tejun Heod2bf1b62010-12-08 20:57:36 +0100851
Hannes Reinecke17eac092017-11-09 17:57:06 +0100852 if (!(disk->flags & GENHD_FL_HIDDEN))
Christoph Hellwig8ddcd652017-11-02 21:29:53 +0300853 blk_unregister_region(disk_devt(disk), disk->minors);
Yufen Yu6fcc44d2019-04-02 20:06:34 +0800854 /*
855 * Remove gendisk pointer from idr so that it cannot be looked up
856 * while RCU period before freeing gendisk is running to prevent
857 * use-after-free issues. Note that the device number stays
858 * "in-use" until we really free the gendisk.
859 */
860 blk_invalidate_devt(disk_devt(disk));
Tejun Heod2bf1b62010-12-08 20:57:36 +0100861
862 kobject_put(disk->part0.holder_dir);
863 kobject_put(disk->slave_dir);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864
865 part_stat_set_all(&disk->part0, 0);
Tejun Heoed9e1982008-08-25 19:56:05 +0900866 disk->part0.stamp = 0;
Tejun Heod2bf1b62010-12-08 20:57:36 +0100867 if (!sysfs_deprecated)
868 sysfs_remove_link(block_depr, dev_name(disk_to_dev(disk)));
Ming Lei25e823c2013-02-22 16:34:13 -0800869 pm_runtime_set_memalloc_noio(disk_to_dev(disk), false);
Tejun Heod2bf1b62010-12-08 20:57:36 +0100870 device_del(disk_to_dev(disk));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871}
Tejun Heod2bf1b62010-12-08 20:57:36 +0100872EXPORT_SYMBOL(del_gendisk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873
Vishal Verma99e66082016-01-09 08:36:51 -0800874/* sysfs access to bad-blocks list. */
875static ssize_t disk_badblocks_show(struct device *dev,
876 struct device_attribute *attr,
877 char *page)
878{
879 struct gendisk *disk = dev_to_disk(dev);
880
881 if (!disk->bb)
882 return sprintf(page, "\n");
883
884 return badblocks_show(disk->bb, page, 0);
885}
886
887static ssize_t disk_badblocks_store(struct device *dev,
888 struct device_attribute *attr,
889 const char *page, size_t len)
890{
891 struct gendisk *disk = dev_to_disk(dev);
892
893 if (!disk->bb)
894 return -ENXIO;
895
896 return badblocks_store(disk->bb, page, len, 0);
897}
898
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899/**
900 * get_gendisk - get partitioning information for a given device
Randy Dunlap710027a2008-08-19 20:13:11 +0200901 * @devt: device to get partitioning information for
Randy Dunlap496aa8a2008-10-16 07:46:23 +0200902 * @partno: returned partition index
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903 *
904 * This function gets the structure containing partitioning
Randy Dunlap710027a2008-08-19 20:13:11 +0200905 * information for the given device @devt.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906 */
Tejun Heocf771cb2008-09-03 09:01:09 +0200907struct gendisk *get_gendisk(dev_t devt, int *partno)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700908{
Tejun Heobcce3de2008-08-25 19:47:22 +0900909 struct gendisk *disk = NULL;
Kay Sieversedfaa7c2007-05-21 22:08:01 +0200910
Tejun Heobcce3de2008-08-25 19:47:22 +0900911 if (MAJOR(devt) != BLOCK_EXT_MAJOR) {
912 struct kobject *kobj;
913
914 kobj = kobj_lookup(bdev_map, devt, partno);
915 if (kobj)
916 disk = dev_to_disk(kobj_to_dev(kobj));
917 } else {
918 struct hd_struct *part;
919
Dan Williams4d66e5e2015-06-10 23:47:14 -0400920 spin_lock_bh(&ext_devt_lock);
Tejun Heo870d6652008-08-25 19:47:25 +0900921 part = idr_find(&ext_devt_idr, blk_mangle_minor(MINOR(devt)));
Jan Kara3079c222018-02-26 13:01:38 +0100922 if (part && get_disk_and_module(part_to_disk(part))) {
Tejun Heobcce3de2008-08-25 19:47:22 +0900923 *partno = part->partno;
924 disk = part_to_disk(part);
925 }
Dan Williams4d66e5e2015-06-10 23:47:14 -0400926 spin_unlock_bh(&ext_devt_lock);
Tejun Heobcce3de2008-08-25 19:47:22 +0900927 }
928
Jan Kara56c09082018-02-26 13:01:41 +0100929 if (!disk)
930 return NULL;
931
932 /*
933 * Synchronize with del_gendisk() to not return disk that is being
934 * destroyed.
935 */
936 down_read(&disk->lookup_sem);
937 if (unlikely((disk->flags & GENHD_FL_HIDDEN) ||
938 !(disk->flags & GENHD_FL_UP))) {
939 up_read(&disk->lookup_sem);
Jan Kara9df6c292018-02-26 13:01:39 +0100940 put_disk_and_module(disk);
Christoph Hellwig8ddcd652017-11-02 21:29:53 +0300941 disk = NULL;
Jan Kara56c09082018-02-26 13:01:41 +0100942 } else {
943 up_read(&disk->lookup_sem);
Christoph Hellwig8ddcd652017-11-02 21:29:53 +0300944 }
Tejun Heobcce3de2008-08-25 19:47:22 +0900945 return disk;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700946}
Divyesh Shahb6ac23af2010-04-15 08:54:59 +0200947EXPORT_SYMBOL(get_gendisk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700948
Tejun Heof331c022008-09-03 09:01:48 +0200949/**
950 * bdget_disk - do bdget() by gendisk and partition number
951 * @disk: gendisk of interest
952 * @partno: partition number
953 *
954 * Find partition @partno from @disk, do bdget() on it.
955 *
956 * CONTEXT:
957 * Don't care.
958 *
959 * RETURNS:
960 * Resulting block_device on success, NULL on failure.
961 */
Harvey Harrisonaeb3d3a2008-08-28 09:27:42 +0200962struct block_device *bdget_disk(struct gendisk *disk, int partno)
Tejun Heof331c022008-09-03 09:01:48 +0200963{
Tejun Heo548b10e2008-08-29 09:01:47 +0200964 struct hd_struct *part;
965 struct block_device *bdev = NULL;
Tejun Heof331c022008-09-03 09:01:48 +0200966
Tejun Heo548b10e2008-08-29 09:01:47 +0200967 part = disk_get_part(disk, partno);
Tejun Heo2bbedcb2008-08-29 11:41:51 +0200968 if (part)
Tejun Heo548b10e2008-08-29 09:01:47 +0200969 bdev = bdget(part_devt(part));
970 disk_put_part(part);
Tejun Heof331c022008-09-03 09:01:48 +0200971
Tejun Heo548b10e2008-08-29 09:01:47 +0200972 return bdev;
Tejun Heof331c022008-09-03 09:01:48 +0200973}
974EXPORT_SYMBOL(bdget_disk);
975
Dave Gilbertdd2a3452007-05-09 02:33:24 -0700976/*
977 * print a full list of all partitions - intended for places where the root
978 * filesystem can't be mounted and thus to give the victim some idea of what
979 * went wrong
980 */
981void __init printk_all_partitions(void)
982{
Tejun Heodef4e382008-09-03 08:57:12 +0200983 struct class_dev_iter iter;
984 struct device *dev;
985
986 class_dev_iter_init(&iter, &block_class, NULL, &disk_type);
987 while ((dev = class_dev_iter_next(&iter))) {
988 struct gendisk *disk = dev_to_disk(dev);
Tejun Heoe71bf0d2008-09-03 09:03:02 +0200989 struct disk_part_iter piter;
990 struct hd_struct *part;
Tejun Heo1f014292008-08-25 19:47:23 +0900991 char name_buf[BDEVNAME_SIZE];
992 char devt_buf[BDEVT_SIZE];
Tejun Heodef4e382008-09-03 08:57:12 +0200993
994 /*
995 * Don't show empty devices or things that have been
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300996 * suppressed
Tejun Heodef4e382008-09-03 08:57:12 +0200997 */
998 if (get_capacity(disk) == 0 ||
999 (disk->flags & GENHD_FL_SUPPRESS_PARTITION_INFO))
1000 continue;
1001
1002 /*
1003 * Note, unlike /proc/partitions, I am showing the
1004 * numbers in hex - the same format as the root=
1005 * option takes.
1006 */
Tejun Heo074a7ac2008-08-25 19:56:14 +09001007 disk_part_iter_init(&piter, disk, DISK_PITER_INCL_PART0);
1008 while ((part = disk_part_iter_next(&piter))) {
1009 bool is_part0 = part == &disk->part0;
Tejun Heodef4e382008-09-03 08:57:12 +02001010
Will Drewryb5af9212010-08-31 15:47:07 -05001011 printk("%s%s %10llu %s %s", is_part0 ? "" : " ",
Tejun Heo1f014292008-08-25 19:47:23 +09001012 bdevt_str(part_devt(part), devt_buf),
Vivek Goyalc83f6bf2012-08-01 12:24:18 +02001013 (unsigned long long)part_nr_sects_read(part) >> 1
1014 , disk_name(disk, part->partno, name_buf),
Stephen Warren1ad7e892012-11-08 16:12:25 -08001015 part->info ? part->info->uuid : "");
Tejun Heo074a7ac2008-08-25 19:56:14 +09001016 if (is_part0) {
Dan Williams52c44d92016-06-15 19:43:07 -07001017 if (dev->parent && dev->parent->driver)
Tejun Heo074a7ac2008-08-25 19:56:14 +09001018 printk(" driver: %s\n",
Dan Williams52c44d92016-06-15 19:43:07 -07001019 dev->parent->driver->name);
Tejun Heo074a7ac2008-08-25 19:56:14 +09001020 else
1021 printk(" (driver?)\n");
1022 } else
1023 printk("\n");
1024 }
Tejun Heoe71bf0d2008-09-03 09:03:02 +02001025 disk_part_iter_exit(&piter);
Tejun Heodef4e382008-09-03 08:57:12 +02001026 }
1027 class_dev_iter_exit(&iter);
Dave Gilbertdd2a3452007-05-09 02:33:24 -07001028}
1029
Linus Torvalds1da177e2005-04-16 15:20:36 -07001030#ifdef CONFIG_PROC_FS
1031/* iterator */
Tejun Heodef4e382008-09-03 08:57:12 +02001032static void *disk_seqf_start(struct seq_file *seqf, loff_t *pos)
Greg Kroah-Hartman68c4d4a2008-05-22 17:21:08 -04001033{
Tejun Heodef4e382008-09-03 08:57:12 +02001034 loff_t skip = *pos;
1035 struct class_dev_iter *iter;
1036 struct device *dev;
Greg Kroah-Hartman68c4d4a2008-05-22 17:21:08 -04001037
Harvey Harrisonaeb3d3a2008-08-28 09:27:42 +02001038 iter = kmalloc(sizeof(*iter), GFP_KERNEL);
Tejun Heodef4e382008-09-03 08:57:12 +02001039 if (!iter)
1040 return ERR_PTR(-ENOMEM);
1041
1042 seqf->private = iter;
1043 class_dev_iter_init(iter, &block_class, NULL, &disk_type);
1044 do {
1045 dev = class_dev_iter_next(iter);
1046 if (!dev)
1047 return NULL;
1048 } while (skip--);
1049
1050 return dev_to_disk(dev);
Greg Kroah-Hartman68c4d4a2008-05-22 17:21:08 -04001051}
1052
Tejun Heodef4e382008-09-03 08:57:12 +02001053static void *disk_seqf_next(struct seq_file *seqf, void *v, loff_t *pos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054{
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001055 struct device *dev;
Greg Kroah-Hartman66c64af2008-05-22 17:21:08 -04001056
Tejun Heodef4e382008-09-03 08:57:12 +02001057 (*pos)++;
1058 dev = class_dev_iter_next(seqf->private);
Tejun Heo2ac3cee2008-09-03 08:53:37 +02001059 if (dev)
Greg Kroah-Hartman68c4d4a2008-05-22 17:21:08 -04001060 return dev_to_disk(dev);
Tejun Heo2ac3cee2008-09-03 08:53:37 +02001061
Linus Torvalds1da177e2005-04-16 15:20:36 -07001062 return NULL;
1063}
1064
Tejun Heodef4e382008-09-03 08:57:12 +02001065static void disk_seqf_stop(struct seq_file *seqf, void *v)
Greg Kroah-Hartman27f30252008-05-22 17:21:08 -04001066{
Tejun Heodef4e382008-09-03 08:57:12 +02001067 struct class_dev_iter *iter = seqf->private;
Greg Kroah-Hartman27f30252008-05-22 17:21:08 -04001068
Tejun Heodef4e382008-09-03 08:57:12 +02001069 /* stop is called even after start failed :-( */
1070 if (iter) {
1071 class_dev_iter_exit(iter);
1072 kfree(iter);
Vegard Nossum77da1602016-07-29 10:40:31 +02001073 seqf->private = NULL;
Kay Sievers5c0ef6d2008-08-16 14:30:30 +02001074 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001075}
1076
Tejun Heodef4e382008-09-03 08:57:12 +02001077static void *show_partition_start(struct seq_file *seqf, loff_t *pos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001078{
Jianpeng Ma06768062012-08-03 10:42:00 +02001079 void *p;
Tejun Heodef4e382008-09-03 08:57:12 +02001080
1081 p = disk_seqf_start(seqf, pos);
Yang Zhangb9f985b2010-12-17 08:58:36 +01001082 if (!IS_ERR_OR_NULL(p) && !*pos)
Tejun Heodef4e382008-09-03 08:57:12 +02001083 seq_puts(seqf, "major minor #blocks name\n\n");
1084 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085}
1086
Tejun Heocf771cb2008-09-03 09:01:09 +02001087static int show_partition(struct seq_file *seqf, void *v)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001088{
1089 struct gendisk *sgp = v;
Tejun Heoe71bf0d2008-09-03 09:03:02 +02001090 struct disk_part_iter piter;
1091 struct hd_struct *part;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001092 char buf[BDEVNAME_SIZE];
1093
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094 /* Don't show non-partitionable removeable devices or empty devices */
Tejun Heod27769e2011-08-23 20:01:04 +02001095 if (!get_capacity(sgp) || (!disk_max_parts(sgp) &&
Tejun Heof331c022008-09-03 09:01:48 +02001096 (sgp->flags & GENHD_FL_REMOVABLE)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097 return 0;
1098 if (sgp->flags & GENHD_FL_SUPPRESS_PARTITION_INFO)
1099 return 0;
1100
1101 /* show the full disk and all non-0 size partitions of it */
Tejun Heo074a7ac2008-08-25 19:56:14 +09001102 disk_part_iter_init(&piter, sgp, DISK_PITER_INCL_PART0);
Tejun Heoe71bf0d2008-09-03 09:03:02 +02001103 while ((part = disk_part_iter_next(&piter)))
Tejun Heo1f014292008-08-25 19:47:23 +09001104 seq_printf(seqf, "%4d %7d %10llu %s\n",
Tejun Heof331c022008-09-03 09:01:48 +02001105 MAJOR(part_devt(part)), MINOR(part_devt(part)),
Vivek Goyalc83f6bf2012-08-01 12:24:18 +02001106 (unsigned long long)part_nr_sects_read(part) >> 1,
Tejun Heof331c022008-09-03 09:01:48 +02001107 disk_name(sgp, part->partno, buf));
Tejun Heoe71bf0d2008-09-03 09:03:02 +02001108 disk_part_iter_exit(&piter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109
1110 return 0;
1111}
1112
Alexey Dobriyanf5009752008-10-04 23:53:21 +04001113static const struct seq_operations partitions_op = {
Tejun Heodef4e382008-09-03 08:57:12 +02001114 .start = show_partition_start,
1115 .next = disk_seqf_next,
1116 .stop = disk_seqf_stop,
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001117 .show = show_partition
Linus Torvalds1da177e2005-04-16 15:20:36 -07001118};
1119#endif
1120
1121
Tejun Heocf771cb2008-09-03 09:01:09 +02001122static struct kobject *base_probe(dev_t devt, int *partno, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001123{
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001124 if (request_module("block-major-%d-%d", MAJOR(devt), MINOR(devt)) > 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001125 /* Make old-style 2.4 aliases work */
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001126 request_module("block-major-%d", MAJOR(devt));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001127 return NULL;
1128}
1129
1130static int __init genhd_device_init(void)
1131{
Dan Williamse105b8b2008-04-21 10:51:07 -07001132 int error;
1133
1134 block_class.dev_kobj = sysfs_dev_block_kobj;
1135 error = class_register(&block_class);
Roland McGrathee27a552008-03-11 17:13:15 -07001136 if (unlikely(error))
1137 return error;
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001138 bdev_map = kobj_map_init(base_probe, &block_class_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139 blk_dev_init();
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001140
Zhang, Yanmin561ec682008-11-14 08:26:30 +01001141 register_blkdev(BLOCK_EXT_MAJOR, "blkext");
1142
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001143 /* create top-level block dir */
Andi Kleene52eec12010-09-08 16:54:17 +02001144 if (!sysfs_deprecated)
1145 block_depr = kobject_create_and_add("block", NULL);
Greg Kroah-Hartman830d3cf2007-11-06 10:36:58 -08001146 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001147}
1148
1149subsys_initcall(genhd_device_init);
1150
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001151static ssize_t disk_range_show(struct device *dev,
1152 struct device_attribute *attr, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001153{
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001154 struct gendisk *disk = dev_to_disk(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001155
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001156 return sprintf(buf, "%d\n", disk->minors);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001157}
1158
Tejun Heo1f014292008-08-25 19:47:23 +09001159static ssize_t disk_ext_range_show(struct device *dev,
1160 struct device_attribute *attr, char *buf)
1161{
1162 struct gendisk *disk = dev_to_disk(dev);
1163
Tejun Heob5d0b9d2008-09-03 09:06:42 +02001164 return sprintf(buf, "%d\n", disk_max_parts(disk));
Tejun Heo1f014292008-08-25 19:47:23 +09001165}
1166
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001167static ssize_t disk_removable_show(struct device *dev,
1168 struct device_attribute *attr, char *buf)
Kay Sieversa7fd6702005-10-01 14:49:43 +02001169{
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001170 struct gendisk *disk = dev_to_disk(dev);
Kay Sieversa7fd6702005-10-01 14:49:43 +02001171
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001172 return sprintf(buf, "%d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173 (disk->flags & GENHD_FL_REMOVABLE ? 1 : 0));
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001174}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001175
Christoph Hellwig8ddcd652017-11-02 21:29:53 +03001176static ssize_t disk_hidden_show(struct device *dev,
1177 struct device_attribute *attr, char *buf)
1178{
1179 struct gendisk *disk = dev_to_disk(dev);
1180
1181 return sprintf(buf, "%d\n",
1182 (disk->flags & GENHD_FL_HIDDEN ? 1 : 0));
1183}
1184
Kay Sievers1c9ce522008-06-13 09:41:00 +02001185static ssize_t disk_ro_show(struct device *dev,
1186 struct device_attribute *attr, char *buf)
1187{
1188 struct gendisk *disk = dev_to_disk(dev);
1189
Tejun Heob7db9952008-08-25 19:56:10 +09001190 return sprintf(buf, "%d\n", get_disk_ro(disk) ? 1 : 0);
Kay Sievers1c9ce522008-06-13 09:41:00 +02001191}
1192
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001193static ssize_t disk_capability_show(struct device *dev,
1194 struct device_attribute *attr, char *buf)
Kristen Carlson Accardi86ce18d2007-05-23 13:57:38 -07001195{
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001196 struct gendisk *disk = dev_to_disk(dev);
1197
1198 return sprintf(buf, "%x\n", disk->flags);
Kristen Carlson Accardi86ce18d2007-05-23 13:57:38 -07001199}
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001200
Martin K. Petersenc72758f2009-05-22 17:17:53 -04001201static ssize_t disk_alignment_offset_show(struct device *dev,
1202 struct device_attribute *attr,
1203 char *buf)
1204{
1205 struct gendisk *disk = dev_to_disk(dev);
1206
1207 return sprintf(buf, "%d\n", queue_alignment_offset(disk->queue));
1208}
1209
Martin K. Petersen86b37282009-11-10 11:50:21 +01001210static ssize_t disk_discard_alignment_show(struct device *dev,
1211 struct device_attribute *attr,
1212 char *buf)
1213{
1214 struct gendisk *disk = dev_to_disk(dev);
1215
Martin K. Petersendd3d1452010-01-11 03:21:48 -05001216 return sprintf(buf, "%d\n", queue_discard_alignment(disk->queue));
Martin K. Petersen86b37282009-11-10 11:50:21 +01001217}
1218
Joe Perches5657a812018-05-24 13:38:59 -06001219static DEVICE_ATTR(range, 0444, disk_range_show, NULL);
1220static DEVICE_ATTR(ext_range, 0444, disk_ext_range_show, NULL);
1221static DEVICE_ATTR(removable, 0444, disk_removable_show, NULL);
1222static DEVICE_ATTR(hidden, 0444, disk_hidden_show, NULL);
1223static DEVICE_ATTR(ro, 0444, disk_ro_show, NULL);
1224static DEVICE_ATTR(size, 0444, part_size_show, NULL);
1225static DEVICE_ATTR(alignment_offset, 0444, disk_alignment_offset_show, NULL);
1226static DEVICE_ATTR(discard_alignment, 0444, disk_discard_alignment_show, NULL);
1227static DEVICE_ATTR(capability, 0444, disk_capability_show, NULL);
1228static DEVICE_ATTR(stat, 0444, part_stat_show, NULL);
1229static DEVICE_ATTR(inflight, 0444, part_inflight_show, NULL);
1230static DEVICE_ATTR(badblocks, 0644, disk_badblocks_show, disk_badblocks_store);
Akinobu Mitac17bb492006-12-08 02:39:46 -08001231#ifdef CONFIG_FAIL_MAKE_REQUEST
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001232static struct device_attribute dev_attr_fail =
Joe Perches5657a812018-05-24 13:38:59 -06001233 __ATTR(make-it-fail, 0644, part_fail_show, part_fail_store);
Akinobu Mitac17bb492006-12-08 02:39:46 -08001234#endif
Jens Axboe581d4e22008-09-14 05:56:33 -07001235#ifdef CONFIG_FAIL_IO_TIMEOUT
1236static struct device_attribute dev_attr_fail_timeout =
Joe Perches5657a812018-05-24 13:38:59 -06001237 __ATTR(io-timeout-fail, 0644, part_timeout_show, part_timeout_store);
Jens Axboe581d4e22008-09-14 05:56:33 -07001238#endif
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001239
1240static struct attribute *disk_attrs[] = {
1241 &dev_attr_range.attr,
Tejun Heo1f014292008-08-25 19:47:23 +09001242 &dev_attr_ext_range.attr,
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001243 &dev_attr_removable.attr,
Christoph Hellwig8ddcd652017-11-02 21:29:53 +03001244 &dev_attr_hidden.attr,
Kay Sievers1c9ce522008-06-13 09:41:00 +02001245 &dev_attr_ro.attr,
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001246 &dev_attr_size.attr,
Martin K. Petersenc72758f2009-05-22 17:17:53 -04001247 &dev_attr_alignment_offset.attr,
Martin K. Petersen86b37282009-11-10 11:50:21 +01001248 &dev_attr_discard_alignment.attr,
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001249 &dev_attr_capability.attr,
1250 &dev_attr_stat.attr,
Nikanth Karthikesan316d3152009-10-06 20:16:55 +02001251 &dev_attr_inflight.attr,
Vishal Verma99e66082016-01-09 08:36:51 -08001252 &dev_attr_badblocks.attr,
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001253#ifdef CONFIG_FAIL_MAKE_REQUEST
1254 &dev_attr_fail.attr,
1255#endif
Jens Axboe581d4e22008-09-14 05:56:33 -07001256#ifdef CONFIG_FAIL_IO_TIMEOUT
1257 &dev_attr_fail_timeout.attr,
1258#endif
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001259 NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07001260};
1261
Dan Williams9438b3e02017-04-27 14:46:26 -07001262static umode_t disk_visible(struct kobject *kobj, struct attribute *a, int n)
1263{
1264 struct device *dev = container_of(kobj, typeof(*dev), kobj);
1265 struct gendisk *disk = dev_to_disk(dev);
1266
1267 if (a == &dev_attr_badblocks.attr && !disk->bb)
1268 return 0;
1269 return a->mode;
1270}
1271
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001272static struct attribute_group disk_attr_group = {
1273 .attrs = disk_attrs,
Dan Williams9438b3e02017-04-27 14:46:26 -07001274 .is_visible = disk_visible,
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001275};
1276
David Brownella4dbd672009-06-24 10:06:31 -07001277static const struct attribute_group *disk_attr_groups[] = {
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001278 &disk_attr_group,
1279 NULL
1280};
1281
Tejun Heo540eed52008-08-25 19:56:15 +09001282/**
1283 * disk_replace_part_tbl - replace disk->part_tbl in RCU-safe way
1284 * @disk: disk to replace part_tbl for
1285 * @new_ptbl: new part_tbl to install
1286 *
1287 * Replace disk->part_tbl with @new_ptbl in RCU-safe way. The
1288 * original ptbl is freed using RCU callback.
1289 *
1290 * LOCKING:
Bart Van Assche6d2cf6f2017-08-17 16:23:06 -07001291 * Matching bd_mutex locked or the caller is the only user of @disk.
Tejun Heo540eed52008-08-25 19:56:15 +09001292 */
1293static void disk_replace_part_tbl(struct gendisk *disk,
1294 struct disk_part_tbl *new_ptbl)
1295{
Bart Van Assche6d2cf6f2017-08-17 16:23:06 -07001296 struct disk_part_tbl *old_ptbl =
1297 rcu_dereference_protected(disk->part_tbl, 1);
Tejun Heo540eed52008-08-25 19:56:15 +09001298
1299 rcu_assign_pointer(disk->part_tbl, new_ptbl);
Jens Axboea6f23652008-10-24 12:52:42 +02001300
1301 if (old_ptbl) {
1302 rcu_assign_pointer(old_ptbl->last_lookup, NULL);
Lai Jiangshan57bdfbf2011-03-18 11:42:58 +08001303 kfree_rcu(old_ptbl, rcu_head);
Jens Axboea6f23652008-10-24 12:52:42 +02001304 }
Tejun Heo540eed52008-08-25 19:56:15 +09001305}
1306
1307/**
1308 * disk_expand_part_tbl - expand disk->part_tbl
1309 * @disk: disk to expand part_tbl for
1310 * @partno: expand such that this partno can fit in
1311 *
1312 * Expand disk->part_tbl such that @partno can fit in. disk->part_tbl
1313 * uses RCU to allow unlocked dereferencing for stats and other stuff.
1314 *
1315 * LOCKING:
Bart Van Assche6d2cf6f2017-08-17 16:23:06 -07001316 * Matching bd_mutex locked or the caller is the only user of @disk.
1317 * Might sleep.
Tejun Heo540eed52008-08-25 19:56:15 +09001318 *
1319 * RETURNS:
1320 * 0 on success, -errno on failure.
1321 */
1322int disk_expand_part_tbl(struct gendisk *disk, int partno)
1323{
Bart Van Assche6d2cf6f2017-08-17 16:23:06 -07001324 struct disk_part_tbl *old_ptbl =
1325 rcu_dereference_protected(disk->part_tbl, 1);
Tejun Heo540eed52008-08-25 19:56:15 +09001326 struct disk_part_tbl *new_ptbl;
1327 int len = old_ptbl ? old_ptbl->len : 0;
Jens Axboe5fabcb42014-11-19 13:06:22 -07001328 int i, target;
Jens Axboe5fabcb42014-11-19 13:06:22 -07001329
1330 /*
1331 * check for int overflow, since we can get here from blkpg_ioctl()
1332 * with a user passed 'partno'.
1333 */
1334 target = partno + 1;
1335 if (target < 0)
1336 return -EINVAL;
Tejun Heo540eed52008-08-25 19:56:15 +09001337
1338 /* disk_max_parts() is zero during initialization, ignore if so */
1339 if (disk_max_parts(disk) && target > disk_max_parts(disk))
1340 return -EINVAL;
1341
1342 if (target <= len)
1343 return 0;
1344
Gustavo A. R. Silva78b90a22019-05-31 13:47:54 -05001345 new_ptbl = kzalloc_node(struct_size(new_ptbl, part, target), GFP_KERNEL,
1346 disk->node_id);
Tejun Heo540eed52008-08-25 19:56:15 +09001347 if (!new_ptbl)
1348 return -ENOMEM;
1349
Tejun Heo540eed52008-08-25 19:56:15 +09001350 new_ptbl->len = target;
1351
1352 for (i = 0; i < len; i++)
1353 rcu_assign_pointer(new_ptbl->part[i], old_ptbl->part[i]);
1354
1355 disk_replace_part_tbl(disk, new_ptbl);
1356 return 0;
1357}
1358
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001359static void disk_release(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360{
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001361 struct gendisk *disk = dev_to_disk(dev);
1362
Keith Busch2da78092014-08-26 09:05:36 -06001363 blk_free_devt(dev->devt);
Tejun Heo77ea8872010-12-08 20:57:37 +01001364 disk_release_events(disk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365 kfree(disk->random);
Tejun Heo540eed52008-08-25 19:56:15 +09001366 disk_replace_part_tbl(disk, NULL);
Ming Leib54e5ed2015-07-16 11:16:44 +08001367 hd_free_part(&disk->part0);
Tejun Heo523e1d32011-10-19 14:31:07 +02001368 if (disk->queue)
1369 blk_put_queue(disk->queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370 kfree(disk);
1371}
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001372struct class block_class = {
1373 .name = "block",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001374};
1375
Kay Sievers3c2670e2013-04-06 09:56:00 -07001376static char *block_devnode(struct device *dev, umode_t *mode,
Greg Kroah-Hartman4e4098a2013-04-11 11:43:29 -07001377 kuid_t *uid, kgid_t *gid)
Kay Sieversb03f38b2009-04-30 15:23:42 +02001378{
1379 struct gendisk *disk = dev_to_disk(dev);
1380
Kay Sieverse454cea2009-09-18 23:01:12 +02001381 if (disk->devnode)
1382 return disk->devnode(disk, mode);
Kay Sieversb03f38b2009-04-30 15:23:42 +02001383 return NULL;
1384}
1385
Bart Van Asscheedf8ff52017-06-20 11:15:48 -07001386static const struct device_type disk_type = {
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001387 .name = "disk",
1388 .groups = disk_attr_groups,
1389 .release = disk_release,
Kay Sieverse454cea2009-09-18 23:01:12 +02001390 .devnode = block_devnode,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391};
1392
Randy Dunlapa6e2ba82008-05-23 09:44:11 -07001393#ifdef CONFIG_PROC_FS
Tejun Heocf771cb2008-09-03 09:01:09 +02001394/*
1395 * aggregate disk stat collector. Uses the same stats that the sysfs
1396 * entries do, above, but makes them available through one seq_file.
1397 *
1398 * The output looks suspiciously like /proc/partitions with a bunch of
1399 * extra fields.
1400 */
1401static int diskstats_show(struct seq_file *seqf, void *v)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402{
1403 struct gendisk *gp = v;
Tejun Heoe71bf0d2008-09-03 09:03:02 +02001404 struct disk_part_iter piter;
1405 struct hd_struct *hd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001406 char buf[BDEVNAME_SIZE];
Mikulas Patockae016b782018-12-06 11:41:21 -05001407 unsigned int inflight;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408
1409 /*
Tejun Heoed9e1982008-08-25 19:56:05 +09001410 if (&disk_to_dev(gp)->kobj.entry == block_class.devices.next)
Tejun Heocf771cb2008-09-03 09:01:09 +02001411 seq_puts(seqf, "major minor name"
Linus Torvalds1da177e2005-04-16 15:20:36 -07001412 " rio rmerge rsect ruse wio wmerge "
1413 "wsect wuse running use aveq"
1414 "\n\n");
1415 */
Wanlong Gao9f5e4862011-06-13 10:45:43 +02001416
Tejun Heo71982a42009-04-17 08:34:48 +02001417 disk_part_iter_init(&piter, gp, DISK_PITER_INCL_EMPTY_PART0);
Tejun Heoe71bf0d2008-09-03 09:03:02 +02001418 while ((hd = disk_part_iter_next(&piter))) {
Mikulas Patockae016b782018-12-06 11:41:21 -05001419 inflight = part_in_flight(gp->queue, hd);
Michael Callahanbdca3c82018-07-18 04:47:40 -07001420 seq_printf(seqf, "%4d %7d %s "
1421 "%lu %lu %lu %u "
1422 "%lu %lu %lu %u "
1423 "%u %u %u "
Konstantin Khlebnikovb6866312019-11-21 13:40:26 +03001424 "%lu %lu %lu %u "
1425 "%lu %u"
1426 "\n",
Tejun Heof331c022008-09-03 09:01:48 +02001427 MAJOR(part_devt(hd)), MINOR(part_devt(hd)),
1428 disk_name(gp, hd->partno, buf),
Michael Callahandbae2c52018-07-18 04:47:38 -07001429 part_stat_read(hd, ios[STAT_READ]),
1430 part_stat_read(hd, merges[STAT_READ]),
1431 part_stat_read(hd, sectors[STAT_READ]),
Omar Sandovalb57e99b2018-09-21 16:44:34 -07001432 (unsigned int)part_stat_read_msecs(hd, STAT_READ),
Michael Callahandbae2c52018-07-18 04:47:38 -07001433 part_stat_read(hd, ios[STAT_WRITE]),
1434 part_stat_read(hd, merges[STAT_WRITE]),
1435 part_stat_read(hd, sectors[STAT_WRITE]),
Omar Sandovalb57e99b2018-09-21 16:44:34 -07001436 (unsigned int)part_stat_read_msecs(hd, STAT_WRITE),
Mikulas Patockae016b782018-12-06 11:41:21 -05001437 inflight,
Jerome Marchand28f39d52008-02-08 11:04:56 +01001438 jiffies_to_msecs(part_stat_read(hd, io_ticks)),
Michael Callahanbdca3c82018-07-18 04:47:40 -07001439 jiffies_to_msecs(part_stat_read(hd, time_in_queue)),
1440 part_stat_read(hd, ios[STAT_DISCARD]),
1441 part_stat_read(hd, merges[STAT_DISCARD]),
1442 part_stat_read(hd, sectors[STAT_DISCARD]),
Konstantin Khlebnikovb6866312019-11-21 13:40:26 +03001443 (unsigned int)part_stat_read_msecs(hd, STAT_DISCARD),
1444 part_stat_read(hd, ios[STAT_FLUSH]),
1445 (unsigned int)part_stat_read_msecs(hd, STAT_FLUSH)
Jerome Marchand28f39d52008-02-08 11:04:56 +01001446 );
Linus Torvalds1da177e2005-04-16 15:20:36 -07001447 }
Tejun Heoe71bf0d2008-09-03 09:03:02 +02001448 disk_part_iter_exit(&piter);
Wanlong Gao9f5e4862011-06-13 10:45:43 +02001449
Linus Torvalds1da177e2005-04-16 15:20:36 -07001450 return 0;
1451}
1452
Alexey Dobriyan31d85ab2008-10-06 12:55:38 +04001453static const struct seq_operations diskstats_op = {
Tejun Heodef4e382008-09-03 08:57:12 +02001454 .start = disk_seqf_start,
1455 .next = disk_seqf_next,
1456 .stop = disk_seqf_stop,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457 .show = diskstats_show
1458};
Alexey Dobriyanf5009752008-10-04 23:53:21 +04001459
1460static int __init proc_genhd_init(void)
1461{
Christoph Hellwigfddda2b2018-04-13 19:44:18 +02001462 proc_create_seq("diskstats", 0, NULL, &diskstats_op);
1463 proc_create_seq("partitions", 0, NULL, &partitions_op);
Alexey Dobriyanf5009752008-10-04 23:53:21 +04001464 return 0;
1465}
1466module_init(proc_genhd_init);
Randy Dunlapa6e2ba82008-05-23 09:44:11 -07001467#endif /* CONFIG_PROC_FS */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468
Tejun Heocf771cb2008-09-03 09:01:09 +02001469dev_t blk_lookup_devt(const char *name, int partno)
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001470{
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001471 dev_t devt = MKDEV(0, 0);
Tejun Heodef4e382008-09-03 08:57:12 +02001472 struct class_dev_iter iter;
1473 struct device *dev;
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001474
Tejun Heodef4e382008-09-03 08:57:12 +02001475 class_dev_iter_init(&iter, &block_class, NULL, &disk_type);
1476 while ((dev = class_dev_iter_next(&iter))) {
1477 struct gendisk *disk = dev_to_disk(dev);
Tejun Heo548b10e2008-08-29 09:01:47 +02001478 struct hd_struct *part;
Tejun Heodef4e382008-09-03 08:57:12 +02001479
Kay Sievers3ada8b72009-01-06 10:44:43 -08001480 if (strcmp(dev_name(dev), name))
Tejun Heof331c022008-09-03 09:01:48 +02001481 continue;
Tejun Heof331c022008-09-03 09:01:48 +02001482
Neil Brown41b8c852009-02-18 10:33:59 +01001483 if (partno < disk->minors) {
1484 /* We need to return the right devno, even
1485 * if the partition doesn't exist yet.
1486 */
1487 devt = MKDEV(MAJOR(dev->devt),
1488 MINOR(dev->devt) + partno);
1489 break;
1490 }
Tejun Heo548b10e2008-08-29 09:01:47 +02001491 part = disk_get_part(disk, partno);
Tejun Heo2bbedcb2008-08-29 11:41:51 +02001492 if (part) {
Tejun Heof331c022008-09-03 09:01:48 +02001493 devt = part_devt(part);
Tejun Heoe71bf0d2008-09-03 09:03:02 +02001494 disk_put_part(part);
Tejun Heo548b10e2008-08-29 09:01:47 +02001495 break;
Tejun Heodef4e382008-09-03 08:57:12 +02001496 }
Tejun Heo548b10e2008-08-29 09:01:47 +02001497 disk_put_part(part);
Kay Sievers5c0ef6d2008-08-16 14:30:30 +02001498 }
Tejun Heodef4e382008-09-03 08:57:12 +02001499 class_dev_iter_exit(&iter);
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001500 return devt;
1501}
Kay Sieversedfaa7c2007-05-21 22:08:01 +02001502EXPORT_SYMBOL(blk_lookup_devt);
1503
Byungchul Parke319e1f2017-10-25 17:56:05 +09001504struct gendisk *__alloc_disk_node(int minors, int node_id)
Christoph Lameter19460892005-06-23 00:08:19 -07001505{
1506 struct gendisk *disk;
Bart Van Assche6d2cf6f2017-08-17 16:23:06 -07001507 struct disk_part_tbl *ptbl;
Christoph Lameter19460892005-06-23 00:08:19 -07001508
Christoph Hellwigde65b012017-08-23 19:10:29 +02001509 if (minors > DISK_MAX_PARTS) {
1510 printk(KERN_ERR
Randy Dunlap7fb52622017-11-18 17:43:38 -08001511 "block: can't allocate more than %d partitions\n",
Christoph Hellwigde65b012017-08-23 19:10:29 +02001512 DISK_MAX_PARTS);
1513 minors = DISK_MAX_PARTS;
1514 }
Christoph Lameter19460892005-06-23 00:08:19 -07001515
Joe Perchesc1b511e2013-08-29 15:21:42 -07001516 disk = kzalloc_node(sizeof(struct gendisk), GFP_KERNEL, node_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001517 if (disk) {
Tejun Heo074a7ac2008-08-25 19:56:14 +09001518 if (!init_part_stats(&disk->part0)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001519 kfree(disk);
1520 return NULL;
1521 }
Jan Kara56c09082018-02-26 13:01:41 +01001522 init_rwsem(&disk->lookup_sem);
Cheng Renquanbf91db12008-11-20 08:37:37 +01001523 disk->node_id = node_id;
Tejun Heo540eed52008-08-25 19:56:15 +09001524 if (disk_expand_part_tbl(disk, 0)) {
1525 free_part_stats(&disk->part0);
Tejun Heob5d0b9d2008-09-03 09:06:42 +02001526 kfree(disk);
1527 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528 }
Bart Van Assche6d2cf6f2017-08-17 16:23:06 -07001529 ptbl = rcu_dereference_protected(disk->part_tbl, 1);
1530 rcu_assign_pointer(ptbl->part[0], &disk->part0);
Jens Axboe6c23a962011-01-07 08:43:37 +01001531
Vivek Goyalc83f6bf2012-08-01 12:24:18 +02001532 /*
1533 * set_capacity() and get_capacity() currently don't use
1534 * seqcounter to read/update the part0->nr_sects. Still init
1535 * the counter as we can read the sectors in IO submission
1536 * patch using seqence counters.
1537 *
1538 * TODO: Ideally set_capacity() and get_capacity() should be
1539 * converted to make use of bd_mutex and sequence counters.
1540 */
1541 seqcount_init(&disk->part0.nr_sects_seq);
Ming Lei6c710132015-07-16 11:16:45 +08001542 if (hd_ref_init(&disk->part0)) {
1543 hd_free_part(&disk->part0);
1544 kfree(disk);
1545 return NULL;
1546 }
Tejun Heob5d0b9d2008-09-03 09:06:42 +02001547
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548 disk->minors = minors;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001549 rand_initialize_disk(disk);
Tejun Heoed9e1982008-08-25 19:56:05 +09001550 disk_to_dev(disk)->class = &block_class;
1551 disk_to_dev(disk)->type = &disk_type;
1552 device_initialize(disk_to_dev(disk));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001553 }
1554 return disk;
1555}
Byungchul Parke319e1f2017-10-25 17:56:05 +09001556EXPORT_SYMBOL(__alloc_disk_node);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001557
Jan Kara3079c222018-02-26 13:01:38 +01001558struct kobject *get_disk_and_module(struct gendisk *disk)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559{
1560 struct module *owner;
1561 struct kobject *kobj;
1562
1563 if (!disk->fops)
1564 return NULL;
1565 owner = disk->fops->owner;
1566 if (owner && !try_module_get(owner))
1567 return NULL;
Jan Karad01b2dc2017-03-23 01:37:02 +01001568 kobj = kobject_get_unless_zero(&disk_to_dev(disk)->kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001569 if (kobj == NULL) {
1570 module_put(owner);
1571 return NULL;
1572 }
1573 return kobj;
1574
1575}
Jan Kara3079c222018-02-26 13:01:38 +01001576EXPORT_SYMBOL(get_disk_and_module);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001577
1578void put_disk(struct gendisk *disk)
1579{
1580 if (disk)
Tejun Heoed9e1982008-08-25 19:56:05 +09001581 kobject_put(&disk_to_dev(disk)->kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001582}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001583EXPORT_SYMBOL(put_disk);
1584
Jan Kara9df6c292018-02-26 13:01:39 +01001585/*
1586 * This is a counterpart of get_disk_and_module() and thus also of
1587 * get_gendisk().
1588 */
1589void put_disk_and_module(struct gendisk *disk)
1590{
1591 if (disk) {
1592 struct module *owner = disk->fops->owner;
1593
1594 put_disk(disk);
1595 module_put(owner);
1596 }
1597}
1598EXPORT_SYMBOL(put_disk_and_module);
1599
Hannes Reineckee3264a42009-07-28 09:13:13 +02001600static void set_disk_ro_uevent(struct gendisk *gd, int ro)
1601{
1602 char event[] = "DISK_RO=1";
1603 char *envp[] = { event, NULL };
1604
1605 if (!ro)
1606 event[8] = '0';
1607 kobject_uevent_env(&disk_to_dev(gd)->kobj, KOBJ_CHANGE, envp);
1608}
1609
Linus Torvalds1da177e2005-04-16 15:20:36 -07001610void set_device_ro(struct block_device *bdev, int flag)
1611{
Tejun Heob7db9952008-08-25 19:56:10 +09001612 bdev->bd_part->policy = flag;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613}
1614
1615EXPORT_SYMBOL(set_device_ro);
1616
1617void set_disk_ro(struct gendisk *disk, int flag)
1618{
Tejun Heoe71bf0d2008-09-03 09:03:02 +02001619 struct disk_part_iter piter;
1620 struct hd_struct *part;
1621
Hannes Reineckee3264a42009-07-28 09:13:13 +02001622 if (disk->part0.policy != flag) {
1623 set_disk_ro_uevent(disk, flag);
1624 disk->part0.policy = flag;
1625 }
1626
1627 disk_part_iter_init(&piter, disk, DISK_PITER_INCL_EMPTY);
Tejun Heoe71bf0d2008-09-03 09:03:02 +02001628 while ((part = disk_part_iter_next(&piter)))
1629 part->policy = flag;
1630 disk_part_iter_exit(&piter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001631}
1632
1633EXPORT_SYMBOL(set_disk_ro);
1634
1635int bdev_read_only(struct block_device *bdev)
1636{
1637 if (!bdev)
1638 return 0;
Tejun Heob7db9952008-08-25 19:56:10 +09001639 return bdev->bd_part->policy;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001640}
1641
1642EXPORT_SYMBOL(bdev_read_only);
1643
Tejun Heocf771cb2008-09-03 09:01:09 +02001644int invalidate_partition(struct gendisk *disk, int partno)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645{
1646 int res = 0;
Tejun Heocf771cb2008-09-03 09:01:09 +02001647 struct block_device *bdev = bdget_disk(disk, partno);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001648 if (bdev) {
Christoph Hellwig2ef41632005-05-05 16:15:59 -07001649 fsync_bdev(bdev);
NeilBrown93b270f2011-02-24 17:25:47 +11001650 res = __invalidate_device(bdev, true);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001651 bdput(bdev);
1652 }
1653 return res;
1654}
1655
1656EXPORT_SYMBOL(invalidate_partition);
Tejun Heo77ea8872010-12-08 20:57:37 +01001657
1658/*
1659 * Disk events - monitor disk events like media change and eject request.
1660 */
1661struct disk_events {
1662 struct list_head node; /* all disk_event's */
1663 struct gendisk *disk; /* the associated disk */
1664 spinlock_t lock;
1665
Tejun Heofdd514e2011-06-09 20:43:59 +02001666 struct mutex block_mutex; /* protects blocking */
Tejun Heo77ea8872010-12-08 20:57:37 +01001667 int block; /* event blocking depth */
1668 unsigned int pending; /* events already sent out */
1669 unsigned int clearing; /* events being cleared */
1670
1671 long poll_msecs; /* interval, -1 for default */
1672 struct delayed_work dwork;
1673};
1674
1675static const char *disk_events_strs[] = {
1676 [ilog2(DISK_EVENT_MEDIA_CHANGE)] = "media_change",
1677 [ilog2(DISK_EVENT_EJECT_REQUEST)] = "eject_request",
1678};
1679
1680static char *disk_uevents[] = {
1681 [ilog2(DISK_EVENT_MEDIA_CHANGE)] = "DISK_MEDIA_CHANGE=1",
1682 [ilog2(DISK_EVENT_EJECT_REQUEST)] = "DISK_EJECT_REQUEST=1",
1683};
1684
1685/* list of all disk_events */
1686static DEFINE_MUTEX(disk_events_mutex);
1687static LIST_HEAD(disk_events);
1688
1689/* disable in-kernel polling by default */
Wei Tang1fe8f342015-11-24 09:58:46 +08001690static unsigned long disk_events_dfl_poll_msecs;
Tejun Heo77ea8872010-12-08 20:57:37 +01001691
1692static unsigned long disk_events_poll_jiffies(struct gendisk *disk)
1693{
1694 struct disk_events *ev = disk->ev;
1695 long intv_msecs = 0;
1696
1697 /*
1698 * If device-specific poll interval is set, always use it. If
Martin Wilck673387a2019-03-27 14:51:01 +01001699 * the default is being used, poll if the POLL flag is set.
Tejun Heo77ea8872010-12-08 20:57:37 +01001700 */
1701 if (ev->poll_msecs >= 0)
1702 intv_msecs = ev->poll_msecs;
Martin Wilckc92e2f02019-03-27 14:51:02 +01001703 else if (disk->event_flags & DISK_EVENT_FLAG_POLL)
Tejun Heo77ea8872010-12-08 20:57:37 +01001704 intv_msecs = disk_events_dfl_poll_msecs;
1705
1706 return msecs_to_jiffies(intv_msecs);
1707}
1708
Tejun Heoc3af54a2011-06-09 20:43:55 +02001709/**
1710 * disk_block_events - block and flush disk event checking
1711 * @disk: disk to block events for
1712 *
1713 * On return from this function, it is guaranteed that event checking
1714 * isn't in progress and won't happen until unblocked by
1715 * disk_unblock_events(). Events blocking is counted and the actual
1716 * unblocking happens after the matching number of unblocks are done.
1717 *
1718 * Note that this intentionally does not block event checking from
1719 * disk_clear_events().
1720 *
1721 * CONTEXT:
1722 * Might sleep.
1723 */
1724void disk_block_events(struct gendisk *disk)
Tejun Heo77ea8872010-12-08 20:57:37 +01001725{
1726 struct disk_events *ev = disk->ev;
1727 unsigned long flags;
1728 bool cancel;
1729
Tejun Heoc3af54a2011-06-09 20:43:55 +02001730 if (!ev)
1731 return;
1732
Tejun Heofdd514e2011-06-09 20:43:59 +02001733 /*
1734 * Outer mutex ensures that the first blocker completes canceling
1735 * the event work before further blockers are allowed to finish.
1736 */
1737 mutex_lock(&ev->block_mutex);
1738
Tejun Heo77ea8872010-12-08 20:57:37 +01001739 spin_lock_irqsave(&ev->lock, flags);
1740 cancel = !ev->block++;
1741 spin_unlock_irqrestore(&ev->lock, flags);
1742
Tejun Heoc3af54a2011-06-09 20:43:55 +02001743 if (cancel)
1744 cancel_delayed_work_sync(&disk->ev->dwork);
Tejun Heofdd514e2011-06-09 20:43:59 +02001745
1746 mutex_unlock(&ev->block_mutex);
Tejun Heo77ea8872010-12-08 20:57:37 +01001747}
1748
1749static void __disk_unblock_events(struct gendisk *disk, bool check_now)
1750{
1751 struct disk_events *ev = disk->ev;
1752 unsigned long intv;
1753 unsigned long flags;
1754
1755 spin_lock_irqsave(&ev->lock, flags);
1756
1757 if (WARN_ON_ONCE(ev->block <= 0))
1758 goto out_unlock;
1759
1760 if (--ev->block)
1761 goto out_unlock;
1762
Tejun Heo77ea8872010-12-08 20:57:37 +01001763 intv = disk_events_poll_jiffies(disk);
Tejun Heo77ea8872010-12-08 20:57:37 +01001764 if (check_now)
Viresh Kumar695588f2013-04-24 17:12:56 +05301765 queue_delayed_work(system_freezable_power_efficient_wq,
1766 &ev->dwork, 0);
Tejun Heo77ea8872010-12-08 20:57:37 +01001767 else if (intv)
Viresh Kumar695588f2013-04-24 17:12:56 +05301768 queue_delayed_work(system_freezable_power_efficient_wq,
1769 &ev->dwork, intv);
Tejun Heo77ea8872010-12-08 20:57:37 +01001770out_unlock:
1771 spin_unlock_irqrestore(&ev->lock, flags);
1772}
1773
1774/**
Tejun Heo77ea8872010-12-08 20:57:37 +01001775 * disk_unblock_events - unblock disk event checking
1776 * @disk: disk to unblock events for
1777 *
1778 * Undo disk_block_events(). When the block count reaches zero, it
1779 * starts events polling if configured.
1780 *
1781 * CONTEXT:
1782 * Don't care. Safe to call from irq context.
1783 */
1784void disk_unblock_events(struct gendisk *disk)
1785{
1786 if (disk->ev)
Tejun Heofacc31d2011-03-09 19:54:27 +01001787 __disk_unblock_events(disk, false);
Tejun Heo77ea8872010-12-08 20:57:37 +01001788}
1789
1790/**
Tejun Heo85ef06d2011-07-01 16:17:47 +02001791 * disk_flush_events - schedule immediate event checking and flushing
1792 * @disk: disk to check and flush events for
1793 * @mask: events to flush
Tejun Heo77ea8872010-12-08 20:57:37 +01001794 *
Tejun Heo85ef06d2011-07-01 16:17:47 +02001795 * Schedule immediate event checking on @disk if not blocked. Events in
1796 * @mask are scheduled to be cleared from the driver. Note that this
1797 * doesn't clear the events from @disk->ev.
Tejun Heo77ea8872010-12-08 20:57:37 +01001798 *
1799 * CONTEXT:
Tejun Heo85ef06d2011-07-01 16:17:47 +02001800 * If @mask is non-zero must be called with bdev->bd_mutex held.
Tejun Heo77ea8872010-12-08 20:57:37 +01001801 */
Tejun Heo85ef06d2011-07-01 16:17:47 +02001802void disk_flush_events(struct gendisk *disk, unsigned int mask)
Tejun Heo77ea8872010-12-08 20:57:37 +01001803{
Tejun Heoa9dce2a2011-06-09 20:43:54 +02001804 struct disk_events *ev = disk->ev;
Tejun Heoa9dce2a2011-06-09 20:43:54 +02001805
1806 if (!ev)
1807 return;
1808
Tejun Heo85ef06d2011-07-01 16:17:47 +02001809 spin_lock_irq(&ev->lock);
1810 ev->clearing |= mask;
Tejun Heo41f63c52012-08-03 10:30:47 -07001811 if (!ev->block)
Viresh Kumar695588f2013-04-24 17:12:56 +05301812 mod_delayed_work(system_freezable_power_efficient_wq,
1813 &ev->dwork, 0);
Tejun Heo85ef06d2011-07-01 16:17:47 +02001814 spin_unlock_irq(&ev->lock);
Tejun Heo77ea8872010-12-08 20:57:37 +01001815}
Tejun Heo77ea8872010-12-08 20:57:37 +01001816
1817/**
1818 * disk_clear_events - synchronously check, clear and return pending events
1819 * @disk: disk to fetch and clear events from
Masanari Iidada3dae52014-09-09 01:27:23 +09001820 * @mask: mask of events to be fetched and cleared
Tejun Heo77ea8872010-12-08 20:57:37 +01001821 *
1822 * Disk events are synchronously checked and pending events in @mask
1823 * are cleared and returned. This ignores the block count.
1824 *
1825 * CONTEXT:
1826 * Might sleep.
1827 */
1828unsigned int disk_clear_events(struct gendisk *disk, unsigned int mask)
1829{
1830 const struct block_device_operations *bdops = disk->fops;
1831 struct disk_events *ev = disk->ev;
1832 unsigned int pending;
Derek Basehore12c2bdb2012-12-18 12:27:20 -08001833 unsigned int clearing = mask;
Tejun Heo77ea8872010-12-08 20:57:37 +01001834
1835 if (!ev) {
1836 /* for drivers still using the old ->media_changed method */
1837 if ((mask & DISK_EVENT_MEDIA_CHANGE) &&
1838 bdops->media_changed && bdops->media_changed(disk))
1839 return DISK_EVENT_MEDIA_CHANGE;
1840 return 0;
1841 }
1842
Derek Basehore12c2bdb2012-12-18 12:27:20 -08001843 disk_block_events(disk);
1844
1845 /*
1846 * store the union of mask and ev->clearing on the stack so that the
1847 * race with disk_flush_events does not cause ambiguity (ev->clearing
1848 * can still be modified even if events are blocked).
1849 */
Tejun Heo77ea8872010-12-08 20:57:37 +01001850 spin_lock_irq(&ev->lock);
Derek Basehore12c2bdb2012-12-18 12:27:20 -08001851 clearing |= ev->clearing;
1852 ev->clearing = 0;
Tejun Heo77ea8872010-12-08 20:57:37 +01001853 spin_unlock_irq(&ev->lock);
1854
Derek Basehore12c2bdb2012-12-18 12:27:20 -08001855 disk_check_events(ev, &clearing);
Derek Basehoreaea24a82012-12-18 12:27:18 -08001856 /*
Derek Basehore12c2bdb2012-12-18 12:27:20 -08001857 * if ev->clearing is not 0, the disk_flush_events got called in the
1858 * middle of this function, so we want to run the workfn without delay.
Derek Basehoreaea24a82012-12-18 12:27:18 -08001859 */
Derek Basehore12c2bdb2012-12-18 12:27:20 -08001860 __disk_unblock_events(disk, ev->clearing ? true : false);
Tejun Heo77ea8872010-12-08 20:57:37 +01001861
1862 /* then, fetch and clear pending events */
1863 spin_lock_irq(&ev->lock);
Tejun Heo77ea8872010-12-08 20:57:37 +01001864 pending = ev->pending & mask;
1865 ev->pending &= ~mask;
1866 spin_unlock_irq(&ev->lock);
Derek Basehore12c2bdb2012-12-18 12:27:20 -08001867 WARN_ON_ONCE(clearing & mask);
Tejun Heo77ea8872010-12-08 20:57:37 +01001868
1869 return pending;
1870}
1871
Derek Basehore12c2bdb2012-12-18 12:27:20 -08001872/*
1873 * Separate this part out so that a different pointer for clearing_ptr can be
1874 * passed in for disk_clear_events.
1875 */
Tejun Heo77ea8872010-12-08 20:57:37 +01001876static void disk_events_workfn(struct work_struct *work)
1877{
1878 struct delayed_work *dwork = to_delayed_work(work);
1879 struct disk_events *ev = container_of(dwork, struct disk_events, dwork);
Derek Basehore12c2bdb2012-12-18 12:27:20 -08001880
1881 disk_check_events(ev, &ev->clearing);
1882}
1883
1884static void disk_check_events(struct disk_events *ev,
1885 unsigned int *clearing_ptr)
1886{
Tejun Heo77ea8872010-12-08 20:57:37 +01001887 struct gendisk *disk = ev->disk;
1888 char *envp[ARRAY_SIZE(disk_uevents) + 1] = { };
Derek Basehore12c2bdb2012-12-18 12:27:20 -08001889 unsigned int clearing = *clearing_ptr;
Tejun Heo77ea8872010-12-08 20:57:37 +01001890 unsigned int events;
1891 unsigned long intv;
1892 int nr_events = 0, i;
1893
1894 /* check events */
1895 events = disk->fops->check_events(disk, clearing);
1896
1897 /* accumulate pending events and schedule next poll if necessary */
1898 spin_lock_irq(&ev->lock);
1899
1900 events &= ~ev->pending;
1901 ev->pending |= events;
Derek Basehore12c2bdb2012-12-18 12:27:20 -08001902 *clearing_ptr &= ~clearing;
Tejun Heo77ea8872010-12-08 20:57:37 +01001903
1904 intv = disk_events_poll_jiffies(disk);
1905 if (!ev->block && intv)
Viresh Kumar695588f2013-04-24 17:12:56 +05301906 queue_delayed_work(system_freezable_power_efficient_wq,
1907 &ev->dwork, intv);
Tejun Heo77ea8872010-12-08 20:57:37 +01001908
1909 spin_unlock_irq(&ev->lock);
1910
Tejun Heo7c88a162011-04-21 19:43:58 +02001911 /*
1912 * Tell userland about new events. Only the events listed in
Martin Wilckc92e2f02019-03-27 14:51:02 +01001913 * @disk->events are reported, and only if DISK_EVENT_FLAG_UEVENT
1914 * is set. Otherwise, events are processed internally but never
1915 * get reported to userland.
Tejun Heo7c88a162011-04-21 19:43:58 +02001916 */
Tejun Heo77ea8872010-12-08 20:57:37 +01001917 for (i = 0; i < ARRAY_SIZE(disk_uevents); i++)
Martin Wilckc92e2f02019-03-27 14:51:02 +01001918 if ((events & disk->events & (1 << i)) &&
1919 (disk->event_flags & DISK_EVENT_FLAG_UEVENT))
Tejun Heo77ea8872010-12-08 20:57:37 +01001920 envp[nr_events++] = disk_uevents[i];
1921
1922 if (nr_events)
1923 kobject_uevent_env(&disk_to_dev(disk)->kobj, KOBJ_CHANGE, envp);
1924}
1925
1926/*
1927 * A disk events enabled device has the following sysfs nodes under
1928 * its /sys/block/X/ directory.
1929 *
1930 * events : list of all supported events
1931 * events_async : list of events which can be detected w/o polling
Martin Wilck673387a2019-03-27 14:51:01 +01001932 * (always empty, only for backwards compatibility)
Tejun Heo77ea8872010-12-08 20:57:37 +01001933 * events_poll_msecs : polling interval, 0: disable, -1: system default
1934 */
1935static ssize_t __disk_events_show(unsigned int events, char *buf)
1936{
1937 const char *delim = "";
1938 ssize_t pos = 0;
1939 int i;
1940
1941 for (i = 0; i < ARRAY_SIZE(disk_events_strs); i++)
1942 if (events & (1 << i)) {
1943 pos += sprintf(buf + pos, "%s%s",
1944 delim, disk_events_strs[i]);
1945 delim = " ";
1946 }
1947 if (pos)
1948 pos += sprintf(buf + pos, "\n");
1949 return pos;
1950}
1951
1952static ssize_t disk_events_show(struct device *dev,
1953 struct device_attribute *attr, char *buf)
1954{
1955 struct gendisk *disk = dev_to_disk(dev);
1956
Martin Wilckc92e2f02019-03-27 14:51:02 +01001957 if (!(disk->event_flags & DISK_EVENT_FLAG_UEVENT))
1958 return 0;
1959
Tejun Heo77ea8872010-12-08 20:57:37 +01001960 return __disk_events_show(disk->events, buf);
1961}
1962
1963static ssize_t disk_events_async_show(struct device *dev,
1964 struct device_attribute *attr, char *buf)
1965{
Martin Wilck673387a2019-03-27 14:51:01 +01001966 return 0;
Tejun Heo77ea8872010-12-08 20:57:37 +01001967}
1968
1969static ssize_t disk_events_poll_msecs_show(struct device *dev,
1970 struct device_attribute *attr,
1971 char *buf)
1972{
1973 struct gendisk *disk = dev_to_disk(dev);
1974
Martin Wilckcdf3e3d2019-03-27 14:51:05 +01001975 if (!disk->ev)
1976 return sprintf(buf, "-1\n");
1977
Tejun Heo77ea8872010-12-08 20:57:37 +01001978 return sprintf(buf, "%ld\n", disk->ev->poll_msecs);
1979}
1980
1981static ssize_t disk_events_poll_msecs_store(struct device *dev,
1982 struct device_attribute *attr,
1983 const char *buf, size_t count)
1984{
1985 struct gendisk *disk = dev_to_disk(dev);
1986 long intv;
1987
1988 if (!count || !sscanf(buf, "%ld", &intv))
1989 return -EINVAL;
1990
1991 if (intv < 0 && intv != -1)
1992 return -EINVAL;
1993
Martin Wilckcdf3e3d2019-03-27 14:51:05 +01001994 if (!disk->ev)
1995 return -ENODEV;
1996
Tejun Heoc3af54a2011-06-09 20:43:55 +02001997 disk_block_events(disk);
Tejun Heo77ea8872010-12-08 20:57:37 +01001998 disk->ev->poll_msecs = intv;
1999 __disk_unblock_events(disk, true);
2000
2001 return count;
2002}
2003
Joe Perches5657a812018-05-24 13:38:59 -06002004static const DEVICE_ATTR(events, 0444, disk_events_show, NULL);
2005static const DEVICE_ATTR(events_async, 0444, disk_events_async_show, NULL);
2006static const DEVICE_ATTR(events_poll_msecs, 0644,
Tejun Heo77ea8872010-12-08 20:57:37 +01002007 disk_events_poll_msecs_show,
2008 disk_events_poll_msecs_store);
2009
2010static const struct attribute *disk_events_attrs[] = {
2011 &dev_attr_events.attr,
2012 &dev_attr_events_async.attr,
2013 &dev_attr_events_poll_msecs.attr,
2014 NULL,
2015};
2016
2017/*
2018 * The default polling interval can be specified by the kernel
2019 * parameter block.events_dfl_poll_msecs which defaults to 0
2020 * (disable). This can also be modified runtime by writing to
Akinobu Mita1624b0b2019-07-16 21:59:35 +09002021 * /sys/module/block/parameters/events_dfl_poll_msecs.
Tejun Heo77ea8872010-12-08 20:57:37 +01002022 */
2023static int disk_events_set_dfl_poll_msecs(const char *val,
2024 const struct kernel_param *kp)
2025{
2026 struct disk_events *ev;
2027 int ret;
2028
2029 ret = param_set_ulong(val, kp);
2030 if (ret < 0)
2031 return ret;
2032
2033 mutex_lock(&disk_events_mutex);
2034
2035 list_for_each_entry(ev, &disk_events, node)
Tejun Heo85ef06d2011-07-01 16:17:47 +02002036 disk_flush_events(ev->disk, 0);
Tejun Heo77ea8872010-12-08 20:57:37 +01002037
2038 mutex_unlock(&disk_events_mutex);
2039
2040 return 0;
2041}
2042
2043static const struct kernel_param_ops disk_events_dfl_poll_msecs_param_ops = {
2044 .set = disk_events_set_dfl_poll_msecs,
2045 .get = param_get_ulong,
2046};
2047
2048#undef MODULE_PARAM_PREFIX
2049#define MODULE_PARAM_PREFIX "block."
2050
2051module_param_cb(events_dfl_poll_msecs, &disk_events_dfl_poll_msecs_param_ops,
2052 &disk_events_dfl_poll_msecs, 0644);
2053
2054/*
Stanislaw Gruszka9f53d2fe2012-03-02 10:43:28 +01002055 * disk_{alloc|add|del|release}_events - initialize and destroy disk_events.
Tejun Heo77ea8872010-12-08 20:57:37 +01002056 */
Stanislaw Gruszka9f53d2fe2012-03-02 10:43:28 +01002057static void disk_alloc_events(struct gendisk *disk)
Tejun Heo77ea8872010-12-08 20:57:37 +01002058{
2059 struct disk_events *ev;
2060
Martin Wilckcdf3e3d2019-03-27 14:51:05 +01002061 if (!disk->fops->check_events || !disk->events)
Tejun Heo77ea8872010-12-08 20:57:37 +01002062 return;
2063
2064 ev = kzalloc(sizeof(*ev), GFP_KERNEL);
2065 if (!ev) {
2066 pr_warn("%s: failed to initialize events\n", disk->disk_name);
2067 return;
2068 }
2069
Tejun Heo77ea8872010-12-08 20:57:37 +01002070 INIT_LIST_HEAD(&ev->node);
2071 ev->disk = disk;
2072 spin_lock_init(&ev->lock);
Tejun Heofdd514e2011-06-09 20:43:59 +02002073 mutex_init(&ev->block_mutex);
Tejun Heo77ea8872010-12-08 20:57:37 +01002074 ev->block = 1;
2075 ev->poll_msecs = -1;
2076 INIT_DELAYED_WORK(&ev->dwork, disk_events_workfn);
2077
Stanislaw Gruszka9f53d2fe2012-03-02 10:43:28 +01002078 disk->ev = ev;
2079}
2080
2081static void disk_add_events(struct gendisk *disk)
2082{
Stanislaw Gruszka9f53d2fe2012-03-02 10:43:28 +01002083 /* FIXME: error handling */
2084 if (sysfs_create_files(&disk_to_dev(disk)->kobj, disk_events_attrs) < 0)
2085 pr_warn("%s: failed to create sysfs files for events\n",
2086 disk->disk_name);
2087
Martin Wilckcdf3e3d2019-03-27 14:51:05 +01002088 if (!disk->ev)
2089 return;
2090
Tejun Heo77ea8872010-12-08 20:57:37 +01002091 mutex_lock(&disk_events_mutex);
Stanislaw Gruszka9f53d2fe2012-03-02 10:43:28 +01002092 list_add_tail(&disk->ev->node, &disk_events);
Tejun Heo77ea8872010-12-08 20:57:37 +01002093 mutex_unlock(&disk_events_mutex);
2094
2095 /*
2096 * Block count is initialized to 1 and the following initial
2097 * unblock kicks it into action.
2098 */
2099 __disk_unblock_events(disk, true);
2100}
2101
2102static void disk_del_events(struct gendisk *disk)
2103{
Martin Wilckcdf3e3d2019-03-27 14:51:05 +01002104 if (disk->ev) {
2105 disk_block_events(disk);
Tejun Heo77ea8872010-12-08 20:57:37 +01002106
Martin Wilckcdf3e3d2019-03-27 14:51:05 +01002107 mutex_lock(&disk_events_mutex);
2108 list_del_init(&disk->ev->node);
2109 mutex_unlock(&disk_events_mutex);
2110 }
Tejun Heo77ea8872010-12-08 20:57:37 +01002111
2112 sysfs_remove_files(&disk_to_dev(disk)->kobj, disk_events_attrs);
2113}
2114
2115static void disk_release_events(struct gendisk *disk)
2116{
2117 /* the block count should be 1 from disk_del_events() */
2118 WARN_ON_ONCE(disk->ev && disk->ev->block != 1);
2119 kfree(disk->ev);
2120}