ublk: support user copy
[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 */
96int truncate_bdev_range(struct block_device *bdev, fmode_t mode,
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 */
104 if (!(mode & FMODE_EXCL)) {
37c3fc9a 105 int err = bd_prepare_to_claim(bdev, truncate_bdev_range);
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);
37c3fc9a
CH
111 if (!(mode & FMODE_EXCL))
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
311static __cacheline_aligned_in_smp DEFINE_SPINLOCK(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);
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
466 * @whole: whole block device containing @bdev, may equal @bdev
467 * @holder: holder trying to claim @bdev
468 *
25985edc 469 * Test whether @bdev can be claimed by @holder.
1a3cbbc5
TH
470 *
471 * CONTEXT:
472 * spin_lock(&bdev_lock).
473 *
474 * RETURNS:
475 * %true if @bdev can be claimed, %false otherwise.
476 */
477static bool bd_may_claim(struct block_device *bdev, struct block_device *whole,
478 void *holder)
1da177e4 479{
1da177e4 480 if (bdev->bd_holder == holder)
1a3cbbc5 481 return true; /* already a holder */
1da177e4 482 else if (bdev->bd_holder != NULL)
1a3cbbc5 483 return false; /* held by someone else */
bcc7f5b4 484 else if (whole == bdev)
1a3cbbc5 485 return true; /* is a whole device which isn't held */
1da177e4 486
e525fd89 487 else if (whole->bd_holder == bd_may_claim)
1a3cbbc5
TH
488 return true; /* is a partition of a device that is being partitioned */
489 else if (whole->bd_holder != NULL)
490 return false; /* is a partition of a held device */
1da177e4 491 else
1a3cbbc5
TH
492 return true; /* is a partition of an un-held device */
493}
494
6b4517a7 495/**
58e46ed9 496 * bd_prepare_to_claim - claim a block device
6b4517a7 497 * @bdev: block device of interest
6b4517a7
TH
498 * @holder: holder trying to claim @bdev
499 *
58e46ed9
CH
500 * Claim @bdev. This function fails if @bdev is already claimed by another
501 * holder and waits if another claiming is in progress. return, the caller
502 * has ownership of bd_claiming and bd_holder[s].
6b4517a7
TH
503 *
504 * RETURNS:
505 * 0 if @bdev can be claimed, -EBUSY otherwise.
506 */
37c3fc9a 507int bd_prepare_to_claim(struct block_device *bdev, void *holder)
6b4517a7 508{
37c3fc9a
CH
509 struct block_device *whole = bdev_whole(bdev);
510
511 if (WARN_ON_ONCE(!holder))
512 return -EINVAL;
6b4517a7 513retry:
58e46ed9 514 spin_lock(&bdev_lock);
6b4517a7 515 /* if someone else claimed, fail */
58e46ed9
CH
516 if (!bd_may_claim(bdev, whole, holder)) {
517 spin_unlock(&bdev_lock);
6b4517a7 518 return -EBUSY;
58e46ed9 519 }
6b4517a7 520
e75aa858
TH
521 /* if claiming is already in progress, wait for it to finish */
522 if (whole->bd_claiming) {
6b4517a7
TH
523 wait_queue_head_t *wq = bit_waitqueue(&whole->bd_claiming, 0);
524 DEFINE_WAIT(wait);
525
526 prepare_to_wait(wq, &wait, TASK_UNINTERRUPTIBLE);
527 spin_unlock(&bdev_lock);
528 schedule();
529 finish_wait(wq, &wait);
6b4517a7
TH
530 goto retry;
531 }
532
533 /* yay, all mine */
58e46ed9
CH
534 whole->bd_claiming = holder;
535 spin_unlock(&bdev_lock);
6b4517a7
TH
536 return 0;
537}
ecbe6bc0 538EXPORT_SYMBOL_GPL(bd_prepare_to_claim); /* only for the loop driver */
6b4517a7 539
89e524c0
JK
540static void bd_clear_claiming(struct block_device *whole, void *holder)
541{
542 lockdep_assert_held(&bdev_lock);
543 /* tell others that we're done */
544 BUG_ON(whole->bd_claiming != holder);
545 whole->bd_claiming = NULL;
546 wake_up_bit(&whole->bd_claiming, 0);
547}
548
549/**
550 * bd_finish_claiming - finish claiming of a block device
551 * @bdev: block device of interest
89e524c0
JK
552 * @holder: holder that has claimed @bdev
553 *
554 * Finish exclusive open of a block device. Mark the device as exlusively
555 * open by the holder and wake up all waiters for exclusive open to finish.
556 */
37c3fc9a 557static void bd_finish_claiming(struct block_device *bdev, void *holder)
89e524c0 558{
37c3fc9a
CH
559 struct block_device *whole = bdev_whole(bdev);
560
89e524c0
JK
561 spin_lock(&bdev_lock);
562 BUG_ON(!bd_may_claim(bdev, whole, holder));
563 /*
564 * Note that for a whole device bd_holders will be incremented twice,
565 * and bd_holder will be set to bd_may_claim before being set to holder
566 */
567 whole->bd_holders++;
568 whole->bd_holder = bd_may_claim;
569 bdev->bd_holders++;
570 bdev->bd_holder = holder;
571 bd_clear_claiming(whole, holder);
572 spin_unlock(&bdev_lock);
573}
89e524c0
JK
574
575/**
576 * bd_abort_claiming - abort claiming of a block device
577 * @bdev: block device of interest
89e524c0
JK
578 * @holder: holder that has claimed @bdev
579 *
580 * Abort claiming of a block device when the exclusive open failed. This can be
581 * also used when exclusive open is not actually desired and we just needed
582 * to block other exclusive openers for a while.
583 */
37c3fc9a 584void bd_abort_claiming(struct block_device *bdev, void *holder)
89e524c0
JK
585{
586 spin_lock(&bdev_lock);
37c3fc9a 587 bd_clear_claiming(bdev_whole(bdev), holder);
89e524c0
JK
588 spin_unlock(&bdev_lock);
589}
590EXPORT_SYMBOL(bd_abort_claiming);
6b4517a7 591
c8276b95
CH
592static void blkdev_flush_mapping(struct block_device *bdev)
593{
594 WARN_ON_ONCE(bdev->bd_holders);
595 sync_blockdev(bdev);
596 kill_bdev(bdev);
597 bdev_write_inode(bdev);
598}
37be4124 599
362529d9 600static int blkdev_get_whole(struct block_device *bdev, fmode_t mode)
a1548b67 601{
142fe8f4 602 struct gendisk *disk = bdev->bd_disk;
af22fef3 603 int ret;
a1548b67 604
362529d9
CH
605 if (disk->fops->open) {
606 ret = disk->fops->open(bdev, mode);
607 if (ret) {
608 /* avoid ghost partitions on a removed medium */
609 if (ret == -ENOMEDIUM &&
610 test_bit(GD_NEED_PART_SCAN, &disk->state))
0384264e 611 bdev_disk_changed(disk, true);
362529d9
CH
612 return ret;
613 }
d981cb5b 614 }
a1548b67 615
9acf381f 616 if (!atomic_read(&bdev->bd_openers))
362529d9 617 set_init_blocksize(bdev);
362529d9 618 if (test_bit(GD_NEED_PART_SCAN, &disk->state))
0384264e 619 bdev_disk_changed(disk, false);
9acf381f 620 atomic_inc(&bdev->bd_openers);
483546c1 621 return 0;
362529d9 622}
a1548b67 623
c8276b95
CH
624static void blkdev_put_whole(struct block_device *bdev, fmode_t mode)
625{
9acf381f 626 if (atomic_dec_and_test(&bdev->bd_openers))
c8276b95
CH
627 blkdev_flush_mapping(bdev);
628 if (bdev->bd_disk->fops->release)
629 bdev->bd_disk->fops->release(bdev->bd_disk, mode);
a1548b67
CH
630}
631
362529d9 632static int blkdev_get_part(struct block_device *part, fmode_t mode)
1da177e4 633{
362529d9 634 struct gendisk *disk = part->bd_disk;
362529d9 635 int ret;
5b642d8b 636
9acf381f 637 if (atomic_read(&part->bd_openers))
362529d9 638 goto done;
6c60ff04 639
9d3b8813 640 ret = blkdev_get_whole(bdev_whole(part), mode);
a8698707 641 if (ret)
9d3b8813 642 return ret;
7e69723f 643
362529d9
CH
644 ret = -ENXIO;
645 if (!bdev_nr_sectors(part))
646 goto out_blkdev_put;
7e69723f 647
ab4b5705 648 disk->open_partitions++;
362529d9 649 set_init_blocksize(part);
362529d9 650done:
9acf381f 651 atomic_inc(&part->bd_openers);
1da177e4 652 return 0;
5a023cdb 653
362529d9 654out_blkdev_put:
9d3b8813 655 blkdev_put_whole(bdev_whole(part), mode);
362529d9 656 return ret;
1da177e4 657}
5b56b6ed 658
c8276b95
CH
659static void blkdev_put_part(struct block_device *part, fmode_t mode)
660{
661 struct block_device *whole = bdev_whole(part);
03e26279 662
9acf381f 663 if (!atomic_dec_and_test(&part->bd_openers))
c8276b95
CH
664 return;
665 blkdev_flush_mapping(part);
ab4b5705 666 whole->bd_disk->open_partitions--;
c8276b95 667 blkdev_put_whole(whole, mode);
1da177e4
LT
668}
669
22ae8ce8
CH
670struct block_device *blkdev_get_no_open(dev_t dev)
671{
672 struct block_device *bdev;
9d3b8813 673 struct inode *inode;
22ae8ce8 674
9d3b8813 675 inode = ilookup(blockdev_superblock, dev);
fbdee71b 676 if (!inode && IS_ENABLED(CONFIG_BLOCK_LEGACY_AUTOLOAD)) {
22ae8ce8 677 blk_request_module(dev);
9d3b8813 678 inode = ilookup(blockdev_superblock, dev);
fbdee71b
CH
679 if (inode)
680 pr_warn_ratelimited(
451f0b6f 681"block device autoloading is deprecated and will be removed.\n");
22ae8ce8 682 }
fbdee71b
CH
683 if (!inode)
684 return NULL;
22ae8ce8 685
9d3b8813
CH
686 /* switch from the inode reference to a device mode one: */
687 bdev = &BDEV_I(inode)->bdev;
688 if (!kobject_get_unless_zero(&bdev->bd_device.kobj))
689 bdev = NULL;
690 iput(inode);
22ae8ce8 691 return bdev;
22ae8ce8
CH
692}
693
694void blkdev_put_no_open(struct block_device *bdev)
695{
9d3b8813 696 put_device(&bdev->bd_device);
22ae8ce8
CH
697}
698
d4d77629 699/**
4e7b5671
CH
700 * blkdev_get_by_dev - open a block device by device number
701 * @dev: device number of block device to open
d4d77629
TH
702 * @mode: FMODE_* mask
703 * @holder: exclusive holder identifier
704 *
4e7b5671
CH
705 * Open the block device described by device number @dev. If @mode includes
706 * %FMODE_EXCL, the block device is opened with exclusive access. Specifying
707 * %FMODE_EXCL with a %NULL @holder is invalid. Exclusive opens may nest for
708 * the same @holder.
d4d77629 709 *
4e7b5671
CH
710 * Use this interface ONLY if you really do not have anything better - i.e. when
711 * you are behind a truly sucky interface and all you are given is a device
712 * number. Everything else should use blkdev_get_by_path().
d4d77629
TH
713 *
714 * CONTEXT:
715 * Might sleep.
716 *
717 * RETURNS:
4e7b5671 718 * Reference to the block_device on success, ERR_PTR(-errno) on failure.
d4d77629 719 */
4e7b5671 720struct block_device *blkdev_get_by_dev(dev_t dev, fmode_t mode, void *holder)
1da177e4 721{
5b56b6ed 722 bool unblock_events = true;
4e7b5671 723 struct block_device *bdev;
5b56b6ed 724 struct gendisk *disk;
5b56b6ed 725 int ret;
e525fd89 726
7918f0f6 727 ret = devcgroup_check_permission(DEVCG_DEV_BLOCK,
4e7b5671 728 MAJOR(dev), MINOR(dev),
7918f0f6
CH
729 ((mode & FMODE_READ) ? DEVCG_ACC_READ : 0) |
730 ((mode & FMODE_WRITE) ? DEVCG_ACC_WRITE : 0));
e5c7fb40 731 if (ret)
4e7b5671
CH
732 return ERR_PTR(ret);
733
22ae8ce8
CH
734 bdev = blkdev_get_no_open(dev);
735 if (!bdev)
736 return ERR_PTR(-ENXIO);
737 disk = bdev->bd_disk;
e5c7fb40 738
5b56b6ed 739 if (mode & FMODE_EXCL) {
37c3fc9a 740 ret = bd_prepare_to_claim(bdev, holder);
5b56b6ed 741 if (ret)
37c3fc9a 742 goto put_blkdev;
5b56b6ed
CH
743 }
744
745 disk_block_events(disk);
746
a8698707 747 mutex_lock(&disk->open_mutex);
362529d9 748 ret = -ENXIO;
50b4aecf 749 if (!disk_live(disk))
362529d9 750 goto abort_claiming;
efcf5932
ML
751 if (!try_module_get(disk->fops->owner))
752 goto abort_claiming;
362529d9
CH
753 if (bdev_is_partition(bdev))
754 ret = blkdev_get_part(bdev, mode);
755 else
756 ret = blkdev_get_whole(bdev, mode);
22ae8ce8 757 if (ret)
efcf5932 758 goto put_module;
22ae8ce8 759 if (mode & FMODE_EXCL) {
37c3fc9a 760 bd_finish_claiming(bdev, holder);
5b56b6ed
CH
761
762 /*
763 * Block event polling for write claims if requested. Any write
764 * holder makes the write_holder state stick until all are
765 * released. This is good enough and tracking individual
766 * writeable reference is too fragile given the way @mode is
767 * used in blkdev_get/put().
768 */
769 if ((mode & FMODE_WRITE) && !bdev->bd_write_holder &&
1545e0b4 770 (disk->event_flags & DISK_EVENT_FLAG_BLOCK_ON_EXCL_WRITE)) {
5b56b6ed
CH
771 bdev->bd_write_holder = true;
772 unblock_events = false;
773 }
774 }
a8698707 775 mutex_unlock(&disk->open_mutex);
5b56b6ed
CH
776
777 if (unblock_events)
778 disk_unblock_events(disk);
22ae8ce8 779 return bdev;
efcf5932
ML
780put_module:
781 module_put(disk->fops->owner);
22ae8ce8
CH
782abort_claiming:
783 if (mode & FMODE_EXCL)
37c3fc9a 784 bd_abort_claiming(bdev, holder);
a8698707 785 mutex_unlock(&disk->open_mutex);
22ae8ce8 786 disk_unblock_events(disk);
22ae8ce8
CH
787put_blkdev:
788 blkdev_put_no_open(bdev);
22ae8ce8 789 return ERR_PTR(ret);
37be4124 790}
4e7b5671 791EXPORT_SYMBOL(blkdev_get_by_dev);
1da177e4 792
d4d77629
TH
793/**
794 * blkdev_get_by_path - open a block device by name
795 * @path: path to the block device to open
796 * @mode: FMODE_* mask
797 * @holder: exclusive holder identifier
798 *
4e7b5671
CH
799 * Open the block device described by the device file at @path. If @mode
800 * includes %FMODE_EXCL, the block device is opened with exclusive access.
801 * Specifying %FMODE_EXCL with a %NULL @holder is invalid. Exclusive opens may
802 * nest for the same @holder.
d4d77629
TH
803 *
804 * CONTEXT:
805 * Might sleep.
806 *
807 * RETURNS:
4e7b5671 808 * Reference to the block_device on success, ERR_PTR(-errno) on failure.
d4d77629
TH
809 */
810struct block_device *blkdev_get_by_path(const char *path, fmode_t mode,
811 void *holder)
812{
813 struct block_device *bdev;
4e7b5671
CH
814 dev_t dev;
815 int error;
d4d77629 816
4e7b5671
CH
817 error = lookup_bdev(path, &dev);
818 if (error)
819 return ERR_PTR(error);
d4d77629 820
4e7b5671
CH
821 bdev = blkdev_get_by_dev(dev, mode, holder);
822 if (!IS_ERR(bdev) && (mode & FMODE_WRITE) && bdev_read_only(bdev)) {
e51900f7
CE
823 blkdev_put(bdev, mode);
824 return ERR_PTR(-EACCES);
825 }
826
d4d77629
TH
827 return bdev;
828}
829EXPORT_SYMBOL(blkdev_get_by_path);
830
4385bab1 831void blkdev_put(struct block_device *bdev, fmode_t mode)
2e7b651d 832{
2e7b651d
PZ
833 struct gendisk *disk = bdev->bd_disk;
834
b849dd84
DA
835 /*
836 * Sync early if it looks like we're the last one. If someone else
837 * opens the block device between now and the decrement of bd_openers
838 * then we did a sync that we didn't need to, but that's not the end
839 * of the world and we want to avoid long (could be several minute)
840 * syncs while holding the mutex.
841 */
9acf381f 842 if (atomic_read(&bdev->bd_openers) == 1)
b849dd84
DA
843 sync_blockdev(bdev);
844
a8698707 845 mutex_lock(&disk->open_mutex);
e525fd89 846 if (mode & FMODE_EXCL) {
a954ea81 847 struct block_device *whole = bdev_whole(bdev);
6a027eff
TH
848 bool bdev_free;
849
850 /*
851 * Release a claim on the device. The holder fields
a8698707 852 * are protected with bdev_lock. open_mutex is to
6a027eff
TH
853 * synchronize disk_holder unlinking.
854 */
6a027eff
TH
855 spin_lock(&bdev_lock);
856
857 WARN_ON_ONCE(--bdev->bd_holders < 0);
a954ea81 858 WARN_ON_ONCE(--whole->bd_holders < 0);
6a027eff 859
6a027eff
TH
860 if ((bdev_free = !bdev->bd_holders))
861 bdev->bd_holder = NULL;
a954ea81
CH
862 if (!whole->bd_holders)
863 whole->bd_holder = NULL;
6a027eff
TH
864
865 spin_unlock(&bdev_lock);
866
77ea887e
TH
867 /*
868 * If this was the last claim, remove holder link and
869 * unblock evpoll if it was a write holder.
870 */
85ef06d1 871 if (bdev_free && bdev->bd_write_holder) {
5b56b6ed 872 disk_unblock_events(disk);
85ef06d1 873 bdev->bd_write_holder = false;
77ea887e 874 }
6936217c 875 }
77ea887e 876
85ef06d1
TH
877 /*
878 * Trigger event checking and tell drivers to flush MEDIA_CHANGE
879 * event. This is to ensure detection of media removal commanded
880 * from userland - e.g. eject(1).
881 */
5b56b6ed 882 disk_flush_events(disk, DISK_EVENT_MEDIA_CHANGE);
85ef06d1 883
c8276b95
CH
884 if (bdev_is_partition(bdev))
885 blkdev_put_part(bdev, mode);
886 else
887 blkdev_put_whole(bdev, mode);
a8698707
CH
888 mutex_unlock(&disk->open_mutex);
889
efcf5932 890 module_put(disk->fops->owner);
22ae8ce8 891 blkdev_put_no_open(bdev);
37be4124 892}
2e7b651d
PZ
893EXPORT_SYMBOL(blkdev_put);
894
1da177e4 895/**
0ba4566c
MWO
896 * lookup_bdev() - Look up a struct block_device by name.
897 * @pathname: Name of the block device in the filesystem.
898 * @dev: Pointer to the block device's dev_t, if found.
1da177e4 899 *
057178cf 900 * Lookup the block device's dev_t at @pathname in the current
0ba4566c 901 * namespace if possible and return it in @dev.
057178cf 902 *
0ba4566c
MWO
903 * Context: May sleep.
904 * Return: 0 if succeeded, negative errno otherwise.
1da177e4 905 */
4e7b5671 906int lookup_bdev(const char *pathname, dev_t *dev)
1da177e4 907{
1da177e4 908 struct inode *inode;
421748ec 909 struct path path;
1da177e4
LT
910 int error;
911
421748ec 912 if (!pathname || !*pathname)
4e7b5671 913 return -EINVAL;
1da177e4 914
421748ec 915 error = kern_path(pathname, LOOKUP_FOLLOW, &path);
1da177e4 916 if (error)
4e7b5671 917 return error;
1da177e4 918
bb668734 919 inode = d_backing_inode(path.dentry);
1da177e4
LT
920 error = -ENOTBLK;
921 if (!S_ISBLK(inode->i_mode))
4e7b5671 922 goto out_path_put;
1da177e4 923 error = -EACCES;
a2982cc9 924 if (!may_open_dev(&path))
4e7b5671
CH
925 goto out_path_put;
926
927 *dev = inode->i_rdev;
928 error = 0;
929out_path_put:
421748ec 930 path_put(&path);
4e7b5671 931 return error;
1da177e4 932}
d5686b44 933EXPORT_SYMBOL(lookup_bdev);
1da177e4 934
93b270f7 935int __invalidate_device(struct block_device *bdev, bool kill_dirty)
b71e8a4c
DH
936{
937 struct super_block *sb = get_super(bdev);
938 int res = 0;
939
940 if (sb) {
941 /*
942 * no need to lock the super, get_super holds the
943 * read mutex so the filesystem cannot go away
944 * under us (->put_super runs with the write lock
945 * hold).
946 */
947 shrink_dcache_sb(sb);
93b270f7 948 res = invalidate_inodes(sb, kill_dirty);
b71e8a4c
DH
949 drop_super(sb);
950 }
f98393a6 951 invalidate_bdev(bdev);
b71e8a4c
DH
952 return res;
953}
954EXPORT_SYMBOL(__invalidate_device);
5c0d6b60 955
1e03a36b 956void sync_bdevs(bool wait)
5c0d6b60
JK
957{
958 struct inode *inode, *old_inode = NULL;
959
74278da9 960 spin_lock(&blockdev_superblock->s_inode_list_lock);
5c0d6b60
JK
961 list_for_each_entry(inode, &blockdev_superblock->s_inodes, i_sb_list) {
962 struct address_space *mapping = inode->i_mapping;
af309226 963 struct block_device *bdev;
5c0d6b60
JK
964
965 spin_lock(&inode->i_lock);
966 if (inode->i_state & (I_FREEING|I_WILL_FREE|I_NEW) ||
967 mapping->nrpages == 0) {
968 spin_unlock(&inode->i_lock);
969 continue;
970 }
971 __iget(inode);
972 spin_unlock(&inode->i_lock);
74278da9 973 spin_unlock(&blockdev_superblock->s_inode_list_lock);
5c0d6b60
JK
974 /*
975 * We hold a reference to 'inode' so it couldn't have been
976 * removed from s_inodes list while we dropped the
74278da9 977 * s_inode_list_lock We cannot iput the inode now as we can
5c0d6b60 978 * be holding the last reference and we cannot iput it under
74278da9 979 * s_inode_list_lock. So we keep the reference and iput it
5c0d6b60
JK
980 * later.
981 */
982 iput(old_inode);
983 old_inode = inode;
af309226 984 bdev = I_BDEV(inode);
5c0d6b60 985
a8698707 986 mutex_lock(&bdev->bd_disk->open_mutex);
9acf381f 987 if (!atomic_read(&bdev->bd_openers)) {
1e03a36b
CH
988 ; /* skip */
989 } else if (wait) {
990 /*
991 * We keep the error status of individual mapping so
992 * that applications can catch the writeback error using
993 * fsync(2). See filemap_fdatawait_keep_errors() for
994 * details.
995 */
996 filemap_fdatawait_keep_errors(inode->i_mapping);
997 } else {
998 filemap_fdatawrite(inode->i_mapping);
999 }
a8698707 1000 mutex_unlock(&bdev->bd_disk->open_mutex);
5c0d6b60 1001
74278da9 1002 spin_lock(&blockdev_superblock->s_inode_list_lock);
5c0d6b60 1003 }
74278da9 1004 spin_unlock(&blockdev_superblock->s_inode_list_lock);
5c0d6b60
JK
1005 iput(old_inode);
1006}
2d985f8c
EB
1007
1008/*
1009 * Handle STATX_DIOALIGN for block devices.
1010 *
1011 * Note that the inode passed to this is the inode of a block device node file,
1012 * not the block device's internal inode. Therefore it is *not* valid to use
1013 * I_BDEV() here; the block device has to be looked up by i_rdev instead.
1014 */
1015void bdev_statx_dioalign(struct inode *inode, struct kstat *stat)
1016{
1017 struct block_device *bdev;
1018
1019 bdev = blkdev_get_no_open(inode->i_rdev);
1020 if (!bdev)
1021 return;
1022
1023 stat->dio_mem_align = bdev_dma_alignment(bdev) + 1;
1024 stat->dio_offset_align = bdev_logical_block_size(bdev);
1025 stat->result_mask |= STATX_DIOALIGN;
1026
1027 blkdev_put_no_open(bdev);
1028}