]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - block/bdev.c
KVM: x86/speculation: Disable Fill buffer clear within guests
[mirror_ubuntu-jammy-kernel.git] / block / bdev.c
CommitLineData
457c8996 1// SPDX-License-Identifier: GPL-2.0-only
1da177e4 2/*
1da177e4
LT
3 * Copyright (C) 1991, 1992 Linus Torvalds
4 * Copyright (C) 2001 Andrea Arcangeli <andrea@suse.de> SuSE
7b51e703 5 * Copyright (C) 2016 - 2020 Christoph Hellwig
1da177e4
LT
6 */
7
1da177e4
LT
8#include <linux/init.h>
9#include <linux/mm.h>
1da177e4
LT
10#include <linux/slab.h>
11#include <linux/kmod.h>
12#include <linux/major.h>
7db9cfd3 13#include <linux/device_cgroup.h>
1da177e4 14#include <linux/blkdev.h>
66114cad 15#include <linux/backing-dev.h>
1da177e4
LT
16#include <linux/module.h>
17#include <linux/blkpg.h>
b502bd11 18#include <linux/magic.h>
1da177e4 19#include <linux/buffer_head.h>
ff01bb48 20#include <linux/swap.h>
811d736f 21#include <linux/writeback.h>
1da177e4 22#include <linux/mount.h>
9030d16e 23#include <linux/pseudo_fs.h>
1da177e4
LT
24#include <linux/uio.h>
25#include <linux/namei.h>
ff01bb48 26#include <linux/cleancache.h>
15e3d2c5 27#include <linux/part_stat.h>
7c0f6ba6 28#include <linux/uaccess.h>
0dca4462
CH
29#include "../fs/internal.h"
30#include "blk.h"
1da177e4
LT
31
32struct bdev_inode {
33 struct block_device bdev;
34 struct inode vfs_inode;
35};
36
37static inline struct bdev_inode *BDEV_I(struct inode *inode)
38{
39 return container_of(inode, struct bdev_inode, vfs_inode);
40}
41
ff5053f6 42struct block_device *I_BDEV(struct inode *inode)
1da177e4
LT
43{
44 return &BDEV_I(inode)->bdev;
45}
1da177e4
LT
46EXPORT_SYMBOL(I_BDEV);
47
dbd3ca50 48static void bdev_write_inode(struct block_device *bdev)
564f00f6 49{
dbd3ca50
VG
50 struct inode *inode = bdev->bd_inode;
51 int ret;
52
564f00f6
CH
53 spin_lock(&inode->i_lock);
54 while (inode->i_state & I_DIRTY) {
55 spin_unlock(&inode->i_lock);
dbd3ca50
VG
56 ret = write_inode_now(inode, true);
57 if (ret) {
58 char name[BDEVNAME_SIZE];
59 pr_warn_ratelimited("VFS: Dirty inode writeback failed "
60 "for block device %s (err=%d).\n",
61 bdevname(bdev, name), ret);
62 }
564f00f6
CH
63 spin_lock(&inode->i_lock);
64 }
65 spin_unlock(&inode->i_lock);
66}
67
f9a14399 68/* Kill _all_ buffers and pagecache , dirty or not.. */
3373a346 69static void kill_bdev(struct block_device *bdev)
1da177e4 70{
ff01bb48
AV
71 struct address_space *mapping = bdev->bd_inode->i_mapping;
72
7716506a 73 if (mapping_empty(mapping))
f9a14399 74 return;
ff01bb48 75
f9a14399 76 invalidate_bh_lrus();
ff01bb48 77 truncate_inode_pages(mapping, 0);
3373a346 78}
ff01bb48
AV
79
80/* Invalidate clean unused buffers and pagecache. */
81void invalidate_bdev(struct block_device *bdev)
82{
83 struct address_space *mapping = bdev->bd_inode->i_mapping;
84
a5f6a6a9
AR
85 if (mapping->nrpages) {
86 invalidate_bh_lrus();
87 lru_add_drain_all(); /* make sure all lru add caches are flushed */
88 invalidate_mapping_pages(mapping, 0, -1);
89 }
ff01bb48
AV
90 /* 99% of the time, we don't need to flush the cleancache on the bdev.
91 * But, for the strange corners, lets be cautious
92 */
3167760f 93 cleancache_invalidate_inode(mapping);
ff01bb48
AV
94}
95EXPORT_SYMBOL(invalidate_bdev);
1da177e4 96
384d87ef
JK
97/*
98 * Drop all buffers & page cache for given bdev range. This function bails
99 * with error if bdev has other exclusive owner (such as filesystem).
100 */
101int truncate_bdev_range(struct block_device *bdev, fmode_t mode,
102 loff_t lstart, loff_t lend)
103{
384d87ef
JK
104 /*
105 * If we don't hold exclusive handle for the device, upgrade to it
106 * while we discard the buffer cache to avoid discarding buffers
107 * under live filesystem.
108 */
109 if (!(mode & FMODE_EXCL)) {
37c3fc9a 110 int err = bd_prepare_to_claim(bdev, truncate_bdev_range);
384d87ef 111 if (err)
56887cff 112 goto invalidate;
384d87ef 113 }
37c3fc9a 114
384d87ef 115 truncate_inode_pages_range(bdev->bd_inode->i_mapping, lstart, lend);
37c3fc9a
CH
116 if (!(mode & FMODE_EXCL))
117 bd_abort_claiming(bdev, truncate_bdev_range);
384d87ef 118 return 0;
56887cff
JK
119
120invalidate:
121 /*
122 * Someone else has handle exclusively open. Try invalidating instead.
123 * The 'end' argument is inclusive so the rounding is safe.
124 */
125 return invalidate_inode_pages2_range(bdev->bd_inode->i_mapping,
126 lstart >> PAGE_SHIFT,
127 lend >> PAGE_SHIFT);
384d87ef 128}
384d87ef 129
04906b2f
JK
130static void set_init_blocksize(struct block_device *bdev)
131{
8dc932d3
MM
132 unsigned int bsize = bdev_logical_block_size(bdev);
133 loff_t size = i_size_read(bdev->bd_inode);
134
135 while (bsize < PAGE_SIZE) {
136 if (size & bsize)
137 break;
138 bsize <<= 1;
139 }
140 bdev->bd_inode->i_blkbits = blksize_bits(bsize);
04906b2f
JK
141}
142
1da177e4
LT
143int set_blocksize(struct block_device *bdev, int size)
144{
145 /* Size must be a power of two, and between 512 and PAGE_SIZE */
1368c4f2 146 if (size > PAGE_SIZE || size < 512 || !is_power_of_2(size))
1da177e4
LT
147 return -EINVAL;
148
149 /* Size cannot be smaller than the size supported by the device */
e1defc4f 150 if (size < bdev_logical_block_size(bdev))
1da177e4
LT
151 return -EINVAL;
152
153 /* Don't change the size if it is same as current */
6b7b181b 154 if (bdev->bd_inode->i_blkbits != blksize_bits(size)) {
1da177e4 155 sync_blockdev(bdev);
1da177e4
LT
156 bdev->bd_inode->i_blkbits = blksize_bits(size);
157 kill_bdev(bdev);
158 }
159 return 0;
160}
161
162EXPORT_SYMBOL(set_blocksize);
163
164int sb_set_blocksize(struct super_block *sb, int size)
165{
1da177e4
LT
166 if (set_blocksize(sb->s_bdev, size))
167 return 0;
168 /* If we get here, we know size is power of two
169 * and it's value is between 512 and PAGE_SIZE */
170 sb->s_blocksize = size;
38885bd4 171 sb->s_blocksize_bits = blksize_bits(size);
1da177e4
LT
172 return sb->s_blocksize;
173}
174
175EXPORT_SYMBOL(sb_set_blocksize);
176
177int sb_min_blocksize(struct super_block *sb, int size)
178{
e1defc4f 179 int minsize = bdev_logical_block_size(sb->s_bdev);
1da177e4
LT
180 if (size < minsize)
181 size = minsize;
182 return sb_set_blocksize(sb, size);
183}
184
185EXPORT_SYMBOL(sb_min_blocksize);
186
5cee5815
JK
187int __sync_blockdev(struct block_device *bdev, int wait)
188{
189 if (!bdev)
190 return 0;
191 if (!wait)
192 return filemap_flush(bdev->bd_inode->i_mapping);
193 return filemap_write_and_wait(bdev->bd_inode->i_mapping);
194}
195
585d3bc0
NP
196/*
197 * Write out and wait upon all the dirty data associated with a block
198 * device via its mapping. Does not take the superblock lock.
199 */
200int sync_blockdev(struct block_device *bdev)
201{
5cee5815 202 return __sync_blockdev(bdev, 1);
585d3bc0
NP
203}
204EXPORT_SYMBOL(sync_blockdev);
205
206/*
207 * Write out and wait upon all dirty data associated with this
208 * device. Filesystem data as well as the underlying block
209 * device. Takes the superblock lock.
210 */
211int fsync_bdev(struct block_device *bdev)
212{
213 struct super_block *sb = get_super(bdev);
214 if (sb) {
60b0680f 215 int res = sync_filesystem(sb);
585d3bc0
NP
216 drop_super(sb);
217 return res;
218 }
219 return sync_blockdev(bdev);
220}
47e4491b 221EXPORT_SYMBOL(fsync_bdev);
585d3bc0
NP
222
223/**
224 * freeze_bdev -- lock a filesystem and force it into a consistent state
225 * @bdev: blockdevice to lock
226 *
585d3bc0
NP
227 * If a superblock is found on this device, we take the s_umount semaphore
228 * on it to make sure nobody unmounts until the snapshot creation is done.
229 * The reference counter (bd_fsfreeze_count) guarantees that only the last
230 * unfreeze process can unfreeze the frozen filesystem actually when multiple
231 * freeze requests arrive simultaneously. It counts up in freeze_bdev() and
232 * count down in thaw_bdev(). When it becomes 0, thaw_bdev() will unfreeze
233 * actually.
234 */
040f04bd 235int freeze_bdev(struct block_device *bdev)
585d3bc0
NP
236{
237 struct super_block *sb;
238 int error = 0;
239
240 mutex_lock(&bdev->bd_fsfreeze_mutex);
040f04bd
CH
241 if (++bdev->bd_fsfreeze_count > 1)
242 goto done;
4504230a
CH
243
244 sb = get_active_super(bdev);
245 if (!sb)
040f04bd 246 goto sync;
48b6bca6
BM
247 if (sb->s_op->freeze_super)
248 error = sb->s_op->freeze_super(sb);
249 else
250 error = freeze_super(sb);
040f04bd
CH
251 deactivate_super(sb);
252
18e9e510 253 if (error) {
18e9e510 254 bdev->bd_fsfreeze_count--;
040f04bd 255 goto done;
585d3bc0 256 }
040f04bd
CH
257 bdev->bd_fsfreeze_sb = sb;
258
259sync:
585d3bc0 260 sync_blockdev(bdev);
040f04bd 261done:
585d3bc0 262 mutex_unlock(&bdev->bd_fsfreeze_mutex);
040f04bd 263 return error;
585d3bc0
NP
264}
265EXPORT_SYMBOL(freeze_bdev);
266
267/**
268 * thaw_bdev -- unlock filesystem
269 * @bdev: blockdevice to unlock
585d3bc0
NP
270 *
271 * Unlocks the filesystem and marks it writeable again after freeze_bdev().
272 */
040f04bd 273int thaw_bdev(struct block_device *bdev)
585d3bc0 274{
040f04bd 275 struct super_block *sb;
4504230a 276 int error = -EINVAL;
585d3bc0
NP
277
278 mutex_lock(&bdev->bd_fsfreeze_mutex);
4504230a 279 if (!bdev->bd_fsfreeze_count)
18e9e510 280 goto out;
4504230a
CH
281
282 error = 0;
283 if (--bdev->bd_fsfreeze_count > 0)
18e9e510 284 goto out;
4504230a 285
040f04bd 286 sb = bdev->bd_fsfreeze_sb;
4504230a 287 if (!sb)
18e9e510 288 goto out;
4504230a 289
48b6bca6
BM
290 if (sb->s_op->thaw_super)
291 error = sb->s_op->thaw_super(sb);
292 else
293 error = thaw_super(sb);
997198ba 294 if (error)
18e9e510 295 bdev->bd_fsfreeze_count++;
04a6a536
ST
296 else
297 bdev->bd_fsfreeze_sb = NULL;
18e9e510 298out:
585d3bc0 299 mutex_unlock(&bdev->bd_fsfreeze_mutex);
997198ba 300 return error;
585d3bc0
NP
301}
302EXPORT_SYMBOL(thaw_bdev);
303
47a191fd
MW
304/**
305 * bdev_read_page() - Start reading a page from a block device
306 * @bdev: The device to read the page from
307 * @sector: The offset on the device to read the page to (need not be aligned)
308 * @page: The page to read
309 *
310 * On entry, the page should be locked. It will be unlocked when the page
311 * has been read. If the block driver implements rw_page synchronously,
312 * that will be true on exit from this function, but it need not be.
313 *
314 * Errors returned by this function are usually "soft", eg out of memory, or
315 * queue full; callers should try a different route to read this page rather
316 * than propagate an error back up the stack.
317 *
318 * Return: negative errno if an error occurs, 0 if submission was successful.
319 */
320int bdev_read_page(struct block_device *bdev, sector_t sector,
321 struct page *page)
322{
323 const struct block_device_operations *ops = bdev->bd_disk->fops;
2e6edc95
DW
324 int result = -EOPNOTSUPP;
325
f68eb1e7 326 if (!ops->rw_page || bdev_get_integrity(bdev))
2e6edc95
DW
327 return result;
328
e556f6ba 329 result = blk_queue_enter(bdev->bd_disk->queue, 0);
2e6edc95
DW
330 if (result)
331 return result;
3f289dcb
TH
332 result = ops->rw_page(bdev, sector + get_start_sect(bdev), page,
333 REQ_OP_READ);
e556f6ba 334 blk_queue_exit(bdev->bd_disk->queue);
2e6edc95 335 return result;
47a191fd 336}
47a191fd
MW
337
338/**
339 * bdev_write_page() - Start writing a page to a block device
340 * @bdev: The device to write the page to
341 * @sector: The offset on the device to write the page to (need not be aligned)
342 * @page: The page to write
343 * @wbc: The writeback_control for the write
344 *
345 * On entry, the page should be locked and not currently under writeback.
346 * On exit, if the write started successfully, the page will be unlocked and
347 * under writeback. If the write failed already (eg the driver failed to
348 * queue the page to the device), the page will still be locked. If the
349 * caller is a ->writepage implementation, it will need to unlock the page.
350 *
351 * Errors returned by this function are usually "soft", eg out of memory, or
352 * queue full; callers should try a different route to write this page rather
353 * than propagate an error back up the stack.
354 *
355 * Return: negative errno if an error occurs, 0 if submission was successful.
356 */
357int bdev_write_page(struct block_device *bdev, sector_t sector,
358 struct page *page, struct writeback_control *wbc)
359{
360 int result;
47a191fd 361 const struct block_device_operations *ops = bdev->bd_disk->fops;
2e6edc95 362
f68eb1e7 363 if (!ops->rw_page || bdev_get_integrity(bdev))
47a191fd 364 return -EOPNOTSUPP;
e556f6ba 365 result = blk_queue_enter(bdev->bd_disk->queue, 0);
2e6edc95
DW
366 if (result)
367 return result;
368
47a191fd 369 set_page_writeback(page);
3f289dcb
TH
370 result = ops->rw_page(bdev, sector + get_start_sect(bdev), page,
371 REQ_OP_WRITE);
f892760a 372 if (result) {
47a191fd 373 end_page_writeback(page);
f892760a
MW
374 } else {
375 clean_page_buffers(page);
47a191fd 376 unlock_page(page);
f892760a 377 }
e556f6ba 378 blk_queue_exit(bdev->bd_disk->queue);
47a191fd
MW
379 return result;
380}
47a191fd 381
1da177e4
LT
382/*
383 * pseudo-fs
384 */
385
386static __cacheline_aligned_in_smp DEFINE_SPINLOCK(bdev_lock);
e18b890b 387static struct kmem_cache * bdev_cachep __read_mostly;
1da177e4
LT
388
389static struct inode *bdev_alloc_inode(struct super_block *sb)
390{
e94b1766 391 struct bdev_inode *ei = kmem_cache_alloc(bdev_cachep, GFP_KERNEL);
2d2f6f1b 392
1da177e4
LT
393 if (!ei)
394 return NULL;
2d2f6f1b 395 memset(&ei->bdev, 0, sizeof(ei->bdev));
1da177e4
LT
396 return &ei->vfs_inode;
397}
398
41149cb0 399static void bdev_free_inode(struct inode *inode)
1da177e4 400{
15e3d2c5
CH
401 struct block_device *bdev = I_BDEV(inode);
402
403 free_percpu(bdev->bd_stats);
231926db 404 kfree(bdev->bd_meta_info);
15e3d2c5 405
889c05cc
CH
406 if (!bdev_is_partition(bdev)) {
407 if (bdev->bd_disk && bdev->bd_disk->bdi)
408 bdi_put(bdev->bd_disk->bdi);
340e8457 409 kfree(bdev->bd_disk);
889c05cc 410 }
9451aa0a
CH
411
412 if (MAJOR(bdev->bd_dev) == BLOCK_EXT_MAJOR)
413 blk_free_ext_minor(MINOR(bdev->bd_dev));
414
41149cb0 415 kmem_cache_free(bdev_cachep, BDEV_I(inode));
fa0d7e3d
NP
416}
417
e6cb5382 418static void init_once(void *data)
1da177e4 419{
e6cb5382 420 struct bdev_inode *ei = data;
1da177e4 421
a35afb83 422 inode_init_once(&ei->vfs_inode);
1da177e4
LT
423}
424
b57922d9 425static void bdev_evict_inode(struct inode *inode)
1da177e4 426{
91b0abe3 427 truncate_inode_pages_final(&inode->i_data);
b57922d9 428 invalidate_inode_buffers(inode); /* is it needed here? */
dbd5768f 429 clear_inode(inode);
1da177e4
LT
430}
431
ee9b6d61 432static const struct super_operations bdev_sops = {
1da177e4
LT
433 .statfs = simple_statfs,
434 .alloc_inode = bdev_alloc_inode,
41149cb0 435 .free_inode = bdev_free_inode,
1da177e4 436 .drop_inode = generic_delete_inode,
b57922d9 437 .evict_inode = bdev_evict_inode,
1da177e4
LT
438};
439
9030d16e 440static int bd_init_fs_context(struct fs_context *fc)
1da177e4 441{
9030d16e
DH
442 struct pseudo_fs_context *ctx = init_pseudo(fc, BDEVFS_MAGIC);
443 if (!ctx)
444 return -ENOMEM;
445 fc->s_iflags |= SB_I_CGROUPWB;
446 ctx->ops = &bdev_sops;
447 return 0;
1da177e4
LT
448}
449
450static struct file_system_type bd_type = {
451 .name = "bdev",
9030d16e 452 .init_fs_context = bd_init_fs_context,
1da177e4
LT
453 .kill_sb = kill_anon_super,
454};
455
a212b105
TH
456struct super_block *blockdev_superblock __read_mostly;
457EXPORT_SYMBOL_GPL(blockdev_superblock);
1da177e4
LT
458
459void __init bdev_cache_init(void)
460{
461 int err;
ace8577a 462 static struct vfsmount *bd_mnt;
c2acf7b9 463
1da177e4 464 bdev_cachep = kmem_cache_create("bdev_cache", sizeof(struct bdev_inode),
fffb60f9 465 0, (SLAB_HWCACHE_ALIGN|SLAB_RECLAIM_ACCOUNT|
5d097056 466 SLAB_MEM_SPREAD|SLAB_ACCOUNT|SLAB_PANIC),
20c2df83 467 init_once);
1da177e4
LT
468 err = register_filesystem(&bd_type);
469 if (err)
470 panic("Cannot register bdev pseudo-fs");
471 bd_mnt = kern_mount(&bd_type);
1da177e4
LT
472 if (IS_ERR(bd_mnt))
473 panic("Cannot create bdev pseudo-fs");
ace8577a 474 blockdev_superblock = bd_mnt->mnt_sb; /* For writeback */
1da177e4
LT
475}
476
22ae8ce8 477struct block_device *bdev_alloc(struct gendisk *disk, u8 partno)
1da177e4
LT
478{
479 struct block_device *bdev;
480 struct inode *inode;
481
22ae8ce8 482 inode = new_inode(blockdev_superblock);
1da177e4
LT
483 if (!inode)
484 return NULL;
22ae8ce8
CH
485 inode->i_mode = S_IFBLK;
486 inode->i_rdev = 0;
487 inode->i_data.a_ops = &def_blk_aops;
488 mapping_set_gfp_mask(&inode->i_data, GFP_USER);
489
490 bdev = I_BDEV(inode);
e6cb5382 491 mutex_init(&bdev->bd_fsfreeze_mutex);
22ae8ce8 492 spin_lock_init(&bdev->bd_size_lock);
22ae8ce8 493 bdev->bd_partno = partno;
22ae8ce8 494 bdev->bd_inode = inode;
15e3d2c5
CH
495 bdev->bd_stats = alloc_percpu(struct disk_stats);
496 if (!bdev->bd_stats) {
497 iput(inode);
498 return NULL;
499 }
06cc978d 500 bdev->bd_disk = disk;
22ae8ce8
CH
501 return bdev;
502}
1da177e4 503
22ae8ce8
CH
504void bdev_add(struct block_device *bdev, dev_t dev)
505{
506 bdev->bd_dev = dev;
507 bdev->bd_inode->i_rdev = dev;
508 bdev->bd_inode->i_ino = dev;
509 insert_inode_hash(bdev->bd_inode);
510}
1da177e4 511
1da177e4
LT
512long nr_blockdev_pages(void)
513{
1008fe6d 514 struct inode *inode;
1da177e4 515 long ret = 0;
1008fe6d
CH
516
517 spin_lock(&blockdev_superblock->s_inode_list_lock);
518 list_for_each_entry(inode, &blockdev_superblock->s_inodes, i_sb_list)
519 ret += inode->i_mapping->nrpages;
520 spin_unlock(&blockdev_superblock->s_inode_list_lock);
521
1da177e4
LT
522 return ret;
523}
524
1a3cbbc5
TH
525/**
526 * bd_may_claim - test whether a block device can be claimed
527 * @bdev: block device of interest
528 * @whole: whole block device containing @bdev, may equal @bdev
529 * @holder: holder trying to claim @bdev
530 *
25985edc 531 * Test whether @bdev can be claimed by @holder.
1a3cbbc5
TH
532 *
533 * CONTEXT:
534 * spin_lock(&bdev_lock).
535 *
536 * RETURNS:
537 * %true if @bdev can be claimed, %false otherwise.
538 */
539static bool bd_may_claim(struct block_device *bdev, struct block_device *whole,
540 void *holder)
1da177e4 541{
1da177e4 542 if (bdev->bd_holder == holder)
1a3cbbc5 543 return true; /* already a holder */
1da177e4 544 else if (bdev->bd_holder != NULL)
1a3cbbc5 545 return false; /* held by someone else */
bcc7f5b4 546 else if (whole == bdev)
1a3cbbc5 547 return true; /* is a whole device which isn't held */
1da177e4 548
e525fd89 549 else if (whole->bd_holder == bd_may_claim)
1a3cbbc5
TH
550 return true; /* is a partition of a device that is being partitioned */
551 else if (whole->bd_holder != NULL)
552 return false; /* is a partition of a held device */
1da177e4 553 else
1a3cbbc5
TH
554 return true; /* is a partition of an un-held device */
555}
556
6b4517a7 557/**
58e46ed9 558 * bd_prepare_to_claim - claim a block device
6b4517a7 559 * @bdev: block device of interest
6b4517a7
TH
560 * @holder: holder trying to claim @bdev
561 *
58e46ed9
CH
562 * Claim @bdev. This function fails if @bdev is already claimed by another
563 * holder and waits if another claiming is in progress. return, the caller
564 * has ownership of bd_claiming and bd_holder[s].
6b4517a7
TH
565 *
566 * RETURNS:
567 * 0 if @bdev can be claimed, -EBUSY otherwise.
568 */
37c3fc9a 569int bd_prepare_to_claim(struct block_device *bdev, void *holder)
6b4517a7 570{
37c3fc9a
CH
571 struct block_device *whole = bdev_whole(bdev);
572
573 if (WARN_ON_ONCE(!holder))
574 return -EINVAL;
6b4517a7 575retry:
58e46ed9 576 spin_lock(&bdev_lock);
6b4517a7 577 /* if someone else claimed, fail */
58e46ed9
CH
578 if (!bd_may_claim(bdev, whole, holder)) {
579 spin_unlock(&bdev_lock);
6b4517a7 580 return -EBUSY;
58e46ed9 581 }
6b4517a7 582
e75aa858
TH
583 /* if claiming is already in progress, wait for it to finish */
584 if (whole->bd_claiming) {
6b4517a7
TH
585 wait_queue_head_t *wq = bit_waitqueue(&whole->bd_claiming, 0);
586 DEFINE_WAIT(wait);
587
588 prepare_to_wait(wq, &wait, TASK_UNINTERRUPTIBLE);
589 spin_unlock(&bdev_lock);
590 schedule();
591 finish_wait(wq, &wait);
6b4517a7
TH
592 goto retry;
593 }
594
595 /* yay, all mine */
58e46ed9
CH
596 whole->bd_claiming = holder;
597 spin_unlock(&bdev_lock);
6b4517a7
TH
598 return 0;
599}
ecbe6bc0 600EXPORT_SYMBOL_GPL(bd_prepare_to_claim); /* only for the loop driver */
6b4517a7 601
89e524c0
JK
602static void bd_clear_claiming(struct block_device *whole, void *holder)
603{
604 lockdep_assert_held(&bdev_lock);
605 /* tell others that we're done */
606 BUG_ON(whole->bd_claiming != holder);
607 whole->bd_claiming = NULL;
608 wake_up_bit(&whole->bd_claiming, 0);
609}
610
611/**
612 * bd_finish_claiming - finish claiming of a block device
613 * @bdev: block device of interest
89e524c0
JK
614 * @holder: holder that has claimed @bdev
615 *
616 * Finish exclusive open of a block device. Mark the device as exlusively
617 * open by the holder and wake up all waiters for exclusive open to finish.
618 */
37c3fc9a 619static void bd_finish_claiming(struct block_device *bdev, void *holder)
89e524c0 620{
37c3fc9a
CH
621 struct block_device *whole = bdev_whole(bdev);
622
89e524c0
JK
623 spin_lock(&bdev_lock);
624 BUG_ON(!bd_may_claim(bdev, whole, holder));
625 /*
626 * Note that for a whole device bd_holders will be incremented twice,
627 * and bd_holder will be set to bd_may_claim before being set to holder
628 */
629 whole->bd_holders++;
630 whole->bd_holder = bd_may_claim;
631 bdev->bd_holders++;
632 bdev->bd_holder = holder;
633 bd_clear_claiming(whole, holder);
634 spin_unlock(&bdev_lock);
635}
89e524c0
JK
636
637/**
638 * bd_abort_claiming - abort claiming of a block device
639 * @bdev: block device of interest
89e524c0
JK
640 * @holder: holder that has claimed @bdev
641 *
642 * Abort claiming of a block device when the exclusive open failed. This can be
643 * also used when exclusive open is not actually desired and we just needed
644 * to block other exclusive openers for a while.
645 */
37c3fc9a 646void bd_abort_claiming(struct block_device *bdev, void *holder)
89e524c0
JK
647{
648 spin_lock(&bdev_lock);
37c3fc9a 649 bd_clear_claiming(bdev_whole(bdev), holder);
89e524c0
JK
650 spin_unlock(&bdev_lock);
651}
652EXPORT_SYMBOL(bd_abort_claiming);
6b4517a7 653
c8276b95
CH
654static void blkdev_flush_mapping(struct block_device *bdev)
655{
656 WARN_ON_ONCE(bdev->bd_holders);
657 sync_blockdev(bdev);
658 kill_bdev(bdev);
659 bdev_write_inode(bdev);
660}
37be4124 661
362529d9 662static int blkdev_get_whole(struct block_device *bdev, fmode_t mode)
a1548b67 663{
142fe8f4 664 struct gendisk *disk = bdev->bd_disk;
d173b65a 665 int ret = 0;
a1548b67 666
362529d9
CH
667 if (disk->fops->open) {
668 ret = disk->fops->open(bdev, mode);
669 if (ret) {
670 /* avoid ghost partitions on a removed medium */
671 if (ret == -ENOMEDIUM &&
672 test_bit(GD_NEED_PART_SCAN, &disk->state))
0384264e 673 bdev_disk_changed(disk, true);
362529d9
CH
674 return ret;
675 }
d981cb5b 676 }
a1548b67 677
a11d7fc2 678 if (!bdev->bd_openers)
362529d9 679 set_init_blocksize(bdev);
362529d9 680 if (test_bit(GD_NEED_PART_SCAN, &disk->state))
0384264e 681 bdev_disk_changed(disk, false);
362529d9
CH
682 bdev->bd_openers++;
683 return 0;;
684}
a1548b67 685
c8276b95
CH
686static void blkdev_put_whole(struct block_device *bdev, fmode_t mode)
687{
688 if (!--bdev->bd_openers)
689 blkdev_flush_mapping(bdev);
690 if (bdev->bd_disk->fops->release)
691 bdev->bd_disk->fops->release(bdev->bd_disk, mode);
a1548b67
CH
692}
693
362529d9 694static int blkdev_get_part(struct block_device *part, fmode_t mode)
1da177e4 695{
362529d9 696 struct gendisk *disk = part->bd_disk;
362529d9 697 int ret;
5b642d8b 698
362529d9
CH
699 if (part->bd_openers)
700 goto done;
6c60ff04 701
9d3b8813 702 ret = blkdev_get_whole(bdev_whole(part), mode);
a8698707 703 if (ret)
9d3b8813 704 return ret;
7e69723f 705
362529d9
CH
706 ret = -ENXIO;
707 if (!bdev_nr_sectors(part))
708 goto out_blkdev_put;
7e69723f 709
ab4b5705 710 disk->open_partitions++;
362529d9 711 set_init_blocksize(part);
362529d9
CH
712done:
713 part->bd_openers++;
1da177e4 714 return 0;
5a023cdb 715
362529d9 716out_blkdev_put:
9d3b8813 717 blkdev_put_whole(bdev_whole(part), mode);
362529d9 718 return ret;
1da177e4 719}
5b56b6ed 720
c8276b95
CH
721static void blkdev_put_part(struct block_device *part, fmode_t mode)
722{
723 struct block_device *whole = bdev_whole(part);
03e26279 724
c8276b95
CH
725 if (--part->bd_openers)
726 return;
727 blkdev_flush_mapping(part);
ab4b5705 728 whole->bd_disk->open_partitions--;
c8276b95 729 blkdev_put_whole(whole, mode);
1da177e4
LT
730}
731
22ae8ce8
CH
732struct block_device *blkdev_get_no_open(dev_t dev)
733{
734 struct block_device *bdev;
9d3b8813 735 struct inode *inode;
22ae8ce8 736
9d3b8813
CH
737 inode = ilookup(blockdev_superblock, dev);
738 if (!inode) {
22ae8ce8 739 blk_request_module(dev);
9d3b8813
CH
740 inode = ilookup(blockdev_superblock, dev);
741 if (!inode)
6c60ff04 742 return NULL;
22ae8ce8
CH
743 }
744
9d3b8813
CH
745 /* switch from the inode reference to a device mode one: */
746 bdev = &BDEV_I(inode)->bdev;
747 if (!kobject_get_unless_zero(&bdev->bd_device.kobj))
748 bdev = NULL;
749 iput(inode);
750
751 if (!bdev)
752 return NULL;
753 if ((bdev->bd_disk->flags & GENHD_FL_HIDDEN) ||
754 !try_module_get(bdev->bd_disk->fops->owner)) {
755 put_device(&bdev->bd_device);
756 return NULL;
757 }
758
22ae8ce8 759 return bdev;
22ae8ce8
CH
760}
761
762void blkdev_put_no_open(struct block_device *bdev)
763{
764 module_put(bdev->bd_disk->fops->owner);
9d3b8813 765 put_device(&bdev->bd_device);
22ae8ce8
CH
766}
767
d4d77629 768/**
4e7b5671
CH
769 * blkdev_get_by_dev - open a block device by device number
770 * @dev: device number of block device to open
d4d77629
TH
771 * @mode: FMODE_* mask
772 * @holder: exclusive holder identifier
773 *
4e7b5671
CH
774 * Open the block device described by device number @dev. If @mode includes
775 * %FMODE_EXCL, the block device is opened with exclusive access. Specifying
776 * %FMODE_EXCL with a %NULL @holder is invalid. Exclusive opens may nest for
777 * the same @holder.
d4d77629 778 *
4e7b5671
CH
779 * Use this interface ONLY if you really do not have anything better - i.e. when
780 * you are behind a truly sucky interface and all you are given is a device
781 * number. Everything else should use blkdev_get_by_path().
d4d77629
TH
782 *
783 * CONTEXT:
784 * Might sleep.
785 *
786 * RETURNS:
4e7b5671 787 * Reference to the block_device on success, ERR_PTR(-errno) on failure.
d4d77629 788 */
4e7b5671 789struct block_device *blkdev_get_by_dev(dev_t dev, fmode_t mode, void *holder)
1da177e4 790{
5b56b6ed 791 bool unblock_events = true;
4e7b5671 792 struct block_device *bdev;
5b56b6ed 793 struct gendisk *disk;
5b56b6ed 794 int ret;
e525fd89 795
7918f0f6 796 ret = devcgroup_check_permission(DEVCG_DEV_BLOCK,
4e7b5671 797 MAJOR(dev), MINOR(dev),
7918f0f6
CH
798 ((mode & FMODE_READ) ? DEVCG_ACC_READ : 0) |
799 ((mode & FMODE_WRITE) ? DEVCG_ACC_WRITE : 0));
e5c7fb40 800 if (ret)
4e7b5671
CH
801 return ERR_PTR(ret);
802
22ae8ce8
CH
803 bdev = blkdev_get_no_open(dev);
804 if (!bdev)
805 return ERR_PTR(-ENXIO);
806 disk = bdev->bd_disk;
e5c7fb40 807
5b56b6ed 808 if (mode & FMODE_EXCL) {
37c3fc9a 809 ret = bd_prepare_to_claim(bdev, holder);
5b56b6ed 810 if (ret)
37c3fc9a 811 goto put_blkdev;
5b56b6ed
CH
812 }
813
814 disk_block_events(disk);
815
a8698707 816 mutex_lock(&disk->open_mutex);
362529d9 817 ret = -ENXIO;
50b4aecf 818 if (!disk_live(disk))
362529d9
CH
819 goto abort_claiming;
820 if (bdev_is_partition(bdev))
821 ret = blkdev_get_part(bdev, mode);
822 else
823 ret = blkdev_get_whole(bdev, mode);
22ae8ce8
CH
824 if (ret)
825 goto abort_claiming;
826 if (mode & FMODE_EXCL) {
37c3fc9a 827 bd_finish_claiming(bdev, holder);
5b56b6ed
CH
828
829 /*
830 * Block event polling for write claims if requested. Any write
831 * holder makes the write_holder state stick until all are
832 * released. This is good enough and tracking individual
833 * writeable reference is too fragile given the way @mode is
834 * used in blkdev_get/put().
835 */
836 if ((mode & FMODE_WRITE) && !bdev->bd_write_holder &&
837 (disk->flags & GENHD_FL_BLOCK_EVENTS_ON_EXCL_WRITE)) {
838 bdev->bd_write_holder = true;
839 unblock_events = false;
840 }
841 }
a8698707 842 mutex_unlock(&disk->open_mutex);
5b56b6ed
CH
843
844 if (unblock_events)
845 disk_unblock_events(disk);
22ae8ce8 846 return bdev;
5b56b6ed 847
22ae8ce8
CH
848abort_claiming:
849 if (mode & FMODE_EXCL)
37c3fc9a 850 bd_abort_claiming(bdev, holder);
a8698707 851 mutex_unlock(&disk->open_mutex);
22ae8ce8 852 disk_unblock_events(disk);
22ae8ce8
CH
853put_blkdev:
854 blkdev_put_no_open(bdev);
22ae8ce8 855 return ERR_PTR(ret);
37be4124 856}
4e7b5671 857EXPORT_SYMBOL(blkdev_get_by_dev);
1da177e4 858
d4d77629
TH
859/**
860 * blkdev_get_by_path - open a block device by name
861 * @path: path to the block device to open
862 * @mode: FMODE_* mask
863 * @holder: exclusive holder identifier
864 *
4e7b5671
CH
865 * Open the block device described by the device file at @path. If @mode
866 * includes %FMODE_EXCL, the block device is opened with exclusive access.
867 * Specifying %FMODE_EXCL with a %NULL @holder is invalid. Exclusive opens may
868 * nest for the same @holder.
d4d77629
TH
869 *
870 * CONTEXT:
871 * Might sleep.
872 *
873 * RETURNS:
4e7b5671 874 * Reference to the block_device on success, ERR_PTR(-errno) on failure.
d4d77629
TH
875 */
876struct block_device *blkdev_get_by_path(const char *path, fmode_t mode,
877 void *holder)
878{
879 struct block_device *bdev;
4e7b5671
CH
880 dev_t dev;
881 int error;
d4d77629 882
4e7b5671
CH
883 error = lookup_bdev(path, &dev);
884 if (error)
885 return ERR_PTR(error);
d4d77629 886
4e7b5671
CH
887 bdev = blkdev_get_by_dev(dev, mode, holder);
888 if (!IS_ERR(bdev) && (mode & FMODE_WRITE) && bdev_read_only(bdev)) {
e51900f7
CE
889 blkdev_put(bdev, mode);
890 return ERR_PTR(-EACCES);
891 }
892
d4d77629
TH
893 return bdev;
894}
895EXPORT_SYMBOL(blkdev_get_by_path);
896
4385bab1 897void blkdev_put(struct block_device *bdev, fmode_t mode)
2e7b651d 898{
2e7b651d
PZ
899 struct gendisk *disk = bdev->bd_disk;
900
b849dd84
DA
901 /*
902 * Sync early if it looks like we're the last one. If someone else
903 * opens the block device between now and the decrement of bd_openers
904 * then we did a sync that we didn't need to, but that's not the end
905 * of the world and we want to avoid long (could be several minute)
906 * syncs while holding the mutex.
907 */
908 if (bdev->bd_openers == 1)
909 sync_blockdev(bdev);
910
a8698707 911 mutex_lock(&disk->open_mutex);
e525fd89 912 if (mode & FMODE_EXCL) {
a954ea81 913 struct block_device *whole = bdev_whole(bdev);
6a027eff
TH
914 bool bdev_free;
915
916 /*
917 * Release a claim on the device. The holder fields
a8698707 918 * are protected with bdev_lock. open_mutex is to
6a027eff
TH
919 * synchronize disk_holder unlinking.
920 */
6a027eff
TH
921 spin_lock(&bdev_lock);
922
923 WARN_ON_ONCE(--bdev->bd_holders < 0);
a954ea81 924 WARN_ON_ONCE(--whole->bd_holders < 0);
6a027eff 925
6a027eff
TH
926 if ((bdev_free = !bdev->bd_holders))
927 bdev->bd_holder = NULL;
a954ea81
CH
928 if (!whole->bd_holders)
929 whole->bd_holder = NULL;
6a027eff
TH
930
931 spin_unlock(&bdev_lock);
932
77ea887e
TH
933 /*
934 * If this was the last claim, remove holder link and
935 * unblock evpoll if it was a write holder.
936 */
85ef06d1 937 if (bdev_free && bdev->bd_write_holder) {
5b56b6ed 938 disk_unblock_events(disk);
85ef06d1 939 bdev->bd_write_holder = false;
77ea887e 940 }
6936217c 941 }
77ea887e 942
85ef06d1
TH
943 /*
944 * Trigger event checking and tell drivers to flush MEDIA_CHANGE
945 * event. This is to ensure detection of media removal commanded
946 * from userland - e.g. eject(1).
947 */
5b56b6ed 948 disk_flush_events(disk, DISK_EVENT_MEDIA_CHANGE);
85ef06d1 949
c8276b95
CH
950 if (bdev_is_partition(bdev))
951 blkdev_put_part(bdev, mode);
952 else
953 blkdev_put_whole(bdev, mode);
a8698707
CH
954 mutex_unlock(&disk->open_mutex);
955
22ae8ce8 956 blkdev_put_no_open(bdev);
37be4124 957}
2e7b651d
PZ
958EXPORT_SYMBOL(blkdev_put);
959
1da177e4
LT
960/**
961 * lookup_bdev - lookup a struct block_device by name
94e2959e 962 * @pathname: special file representing the block device
875b2376 963 * @dev: return value of the block device's dev_t
1da177e4 964 *
57d1b536 965 * Get a reference to the blockdevice at @pathname in the current
1da177e4
LT
966 * namespace if possible and return it. Return ERR_PTR(error)
967 * otherwise.
968 */
4e7b5671 969int lookup_bdev(const char *pathname, dev_t *dev)
1da177e4 970{
1da177e4 971 struct inode *inode;
421748ec 972 struct path path;
1da177e4
LT
973 int error;
974
421748ec 975 if (!pathname || !*pathname)
4e7b5671 976 return -EINVAL;
1da177e4 977
421748ec 978 error = kern_path(pathname, LOOKUP_FOLLOW, &path);
1da177e4 979 if (error)
4e7b5671 980 return error;
1da177e4 981
bb668734 982 inode = d_backing_inode(path.dentry);
1da177e4
LT
983 error = -ENOTBLK;
984 if (!S_ISBLK(inode->i_mode))
4e7b5671 985 goto out_path_put;
1da177e4 986 error = -EACCES;
a2982cc9 987 if (!may_open_dev(&path))
4e7b5671
CH
988 goto out_path_put;
989
990 *dev = inode->i_rdev;
991 error = 0;
992out_path_put:
421748ec 993 path_put(&path);
4e7b5671 994 return error;
1da177e4 995}
d5686b44 996EXPORT_SYMBOL(lookup_bdev);
1da177e4 997
93b270f7 998int __invalidate_device(struct block_device *bdev, bool kill_dirty)
b71e8a4c
DH
999{
1000 struct super_block *sb = get_super(bdev);
1001 int res = 0;
1002
1003 if (sb) {
1004 /*
1005 * no need to lock the super, get_super holds the
1006 * read mutex so the filesystem cannot go away
1007 * under us (->put_super runs with the write lock
1008 * hold).
1009 */
1010 shrink_dcache_sb(sb);
93b270f7 1011 res = invalidate_inodes(sb, kill_dirty);
b71e8a4c
DH
1012 drop_super(sb);
1013 }
f98393a6 1014 invalidate_bdev(bdev);
b71e8a4c
DH
1015 return res;
1016}
1017EXPORT_SYMBOL(__invalidate_device);
5c0d6b60
JK
1018
1019void iterate_bdevs(void (*func)(struct block_device *, void *), void *arg)
1020{
1021 struct inode *inode, *old_inode = NULL;
1022
74278da9 1023 spin_lock(&blockdev_superblock->s_inode_list_lock);
5c0d6b60
JK
1024 list_for_each_entry(inode, &blockdev_superblock->s_inodes, i_sb_list) {
1025 struct address_space *mapping = inode->i_mapping;
af309226 1026 struct block_device *bdev;
5c0d6b60
JK
1027
1028 spin_lock(&inode->i_lock);
1029 if (inode->i_state & (I_FREEING|I_WILL_FREE|I_NEW) ||
1030 mapping->nrpages == 0) {
1031 spin_unlock(&inode->i_lock);
1032 continue;
1033 }
1034 __iget(inode);
1035 spin_unlock(&inode->i_lock);
74278da9 1036 spin_unlock(&blockdev_superblock->s_inode_list_lock);
5c0d6b60
JK
1037 /*
1038 * We hold a reference to 'inode' so it couldn't have been
1039 * removed from s_inodes list while we dropped the
74278da9 1040 * s_inode_list_lock We cannot iput the inode now as we can
5c0d6b60 1041 * be holding the last reference and we cannot iput it under
74278da9 1042 * s_inode_list_lock. So we keep the reference and iput it
5c0d6b60
JK
1043 * later.
1044 */
1045 iput(old_inode);
1046 old_inode = inode;
af309226 1047 bdev = I_BDEV(inode);
5c0d6b60 1048
a8698707 1049 mutex_lock(&bdev->bd_disk->open_mutex);
af309226
RV
1050 if (bdev->bd_openers)
1051 func(bdev, arg);
a8698707 1052 mutex_unlock(&bdev->bd_disk->open_mutex);
5c0d6b60 1053
74278da9 1054 spin_lock(&blockdev_superblock->s_inode_list_lock);
5c0d6b60 1055 }
74278da9 1056 spin_unlock(&blockdev_superblock->s_inode_list_lock);
5c0d6b60
JK
1057 iput(old_inode);
1058}