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