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