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