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