1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (C) 1991, 1992 Linus Torvalds
4 * Copyright (C) 2001 Andrea Arcangeli <andrea@suse.de> SuSE
5 * Copyright (C) 2016 - 2020 Christoph Hellwig
8 #include <linux/init.h>
10 #include <linux/slab.h>
11 #include <linux/kmod.h>
12 #include <linux/major.h>
13 #include <linux/device_cgroup.h>
14 #include <linux/blkdev.h>
15 #include <linux/blk-integrity.h>
16 #include <linux/backing-dev.h>
17 #include <linux/module.h>
18 #include <linux/blkpg.h>
19 #include <linux/magic.h>
20 #include <linux/buffer_head.h>
21 #include <linux/swap.h>
22 #include <linux/writeback.h>
23 #include <linux/mount.h>
24 #include <linux/pseudo_fs.h>
25 #include <linux/uio.h>
26 #include <linux/namei.h>
27 #include <linux/security.h>
28 #include <linux/part_stat.h>
29 #include <linux/uaccess.h>
30 #include <linux/stat.h>
31 #include "../fs/internal.h"
34 /* Should we allow writing to mounted block devices? */
35 static bool bdev_allow_write_mounted
= IS_ENABLED(CONFIG_BLK_DEV_WRITE_MOUNTED
);
38 struct block_device bdev
;
39 struct inode vfs_inode
;
42 static inline struct bdev_inode
*BDEV_I(struct inode
*inode
)
44 return container_of(inode
, struct bdev_inode
, vfs_inode
);
47 static inline struct inode
*BD_INODE(struct block_device
*bdev
)
49 return &container_of(bdev
, struct bdev_inode
, bdev
)->vfs_inode
;
52 struct block_device
*I_BDEV(struct inode
*inode
)
54 return &BDEV_I(inode
)->bdev
;
56 EXPORT_SYMBOL(I_BDEV
);
58 struct block_device
*file_bdev(struct file
*bdev_file
)
60 return I_BDEV(bdev_file
->f_mapping
->host
);
62 EXPORT_SYMBOL(file_bdev
);
64 static void bdev_write_inode(struct block_device
*bdev
)
66 struct inode
*inode
= BD_INODE(bdev
);
69 spin_lock(&inode
->i_lock
);
70 while (inode
->i_state
& I_DIRTY
) {
71 spin_unlock(&inode
->i_lock
);
72 ret
= write_inode_now(inode
, true);
75 "VFS: Dirty inode writeback failed for block device %pg (err=%d).\n",
77 spin_lock(&inode
->i_lock
);
79 spin_unlock(&inode
->i_lock
);
82 /* Kill _all_ buffers and pagecache , dirty or not.. */
83 static void kill_bdev(struct block_device
*bdev
)
85 struct address_space
*mapping
= bdev
->bd_mapping
;
87 if (mapping_empty(mapping
))
91 truncate_inode_pages(mapping
, 0);
94 /* Invalidate clean unused buffers and pagecache. */
95 void invalidate_bdev(struct block_device
*bdev
)
97 struct address_space
*mapping
= bdev
->bd_mapping
;
99 if (mapping
->nrpages
) {
100 invalidate_bh_lrus();
101 lru_add_drain_all(); /* make sure all lru add caches are flushed */
102 invalidate_mapping_pages(mapping
, 0, -1);
105 EXPORT_SYMBOL(invalidate_bdev
);
108 * Drop all buffers & page cache for given bdev range. This function bails
109 * with error if bdev has other exclusive owner (such as filesystem).
111 int truncate_bdev_range(struct block_device
*bdev
, blk_mode_t mode
,
112 loff_t lstart
, loff_t lend
)
115 * If we don't hold exclusive handle for the device, upgrade to it
116 * while we discard the buffer cache to avoid discarding buffers
117 * under live filesystem.
119 if (!(mode
& BLK_OPEN_EXCL
)) {
120 int err
= bd_prepare_to_claim(bdev
, truncate_bdev_range
, NULL
);
125 truncate_inode_pages_range(bdev
->bd_mapping
, lstart
, lend
);
126 if (!(mode
& BLK_OPEN_EXCL
))
127 bd_abort_claiming(bdev
, truncate_bdev_range
);
132 * Someone else has handle exclusively open. Try invalidating instead.
133 * The 'end' argument is inclusive so the rounding is safe.
135 return invalidate_inode_pages2_range(bdev
->bd_mapping
,
136 lstart
>> PAGE_SHIFT
,
140 static void set_init_blocksize(struct block_device
*bdev
)
142 unsigned int bsize
= bdev_logical_block_size(bdev
);
143 loff_t size
= i_size_read(BD_INODE(bdev
));
145 while (bsize
< PAGE_SIZE
) {
150 BD_INODE(bdev
)->i_blkbits
= blksize_bits(bsize
);
153 int set_blocksize(struct file
*file
, int size
)
155 struct inode
*inode
= file
->f_mapping
->host
;
156 struct block_device
*bdev
= I_BDEV(inode
);
158 if (blk_validate_block_size(size
))
161 /* Size cannot be smaller than the size supported by the device */
162 if (size
< bdev_logical_block_size(bdev
))
165 if (!file
->private_data
)
168 /* Don't change the size if it is same as current */
169 if (inode
->i_blkbits
!= blksize_bits(size
)) {
171 inode
->i_blkbits
= blksize_bits(size
);
177 EXPORT_SYMBOL(set_blocksize
);
179 int sb_set_blocksize(struct super_block
*sb
, int size
)
181 if (set_blocksize(sb
->s_bdev_file
, size
))
183 /* If we get here, we know size is power of two
184 * and it's value is between 512 and PAGE_SIZE */
185 sb
->s_blocksize
= size
;
186 sb
->s_blocksize_bits
= blksize_bits(size
);
187 return sb
->s_blocksize
;
190 EXPORT_SYMBOL(sb_set_blocksize
);
192 int sb_min_blocksize(struct super_block
*sb
, int size
)
194 int minsize
= bdev_logical_block_size(sb
->s_bdev
);
197 return sb_set_blocksize(sb
, size
);
200 EXPORT_SYMBOL(sb_min_blocksize
);
202 int sync_blockdev_nowait(struct block_device
*bdev
)
206 return filemap_flush(bdev
->bd_mapping
);
208 EXPORT_SYMBOL_GPL(sync_blockdev_nowait
);
211 * Write out and wait upon all the dirty data associated with a block
212 * device via its mapping. Does not take the superblock lock.
214 int sync_blockdev(struct block_device
*bdev
)
218 return filemap_write_and_wait(bdev
->bd_mapping
);
220 EXPORT_SYMBOL(sync_blockdev
);
222 int sync_blockdev_range(struct block_device
*bdev
, loff_t lstart
, loff_t lend
)
224 return filemap_write_and_wait_range(bdev
->bd_mapping
,
227 EXPORT_SYMBOL(sync_blockdev_range
);
230 * bdev_freeze - lock a filesystem and force it into a consistent state
231 * @bdev: blockdevice to lock
233 * If a superblock is found on this device, we take the s_umount semaphore
234 * on it to make sure nobody unmounts until the snapshot creation is done.
235 * The reference counter (bd_fsfreeze_count) guarantees that only the last
236 * unfreeze process can unfreeze the frozen filesystem actually when multiple
237 * freeze requests arrive simultaneously. It counts up in bdev_freeze() and
238 * count down in bdev_thaw(). When it becomes 0, thaw_bdev() will unfreeze
241 * Return: On success zero is returned, negative error code on failure.
243 int bdev_freeze(struct block_device
*bdev
)
247 mutex_lock(&bdev
->bd_fsfreeze_mutex
);
249 if (atomic_inc_return(&bdev
->bd_fsfreeze_count
) > 1) {
250 mutex_unlock(&bdev
->bd_fsfreeze_mutex
);
254 mutex_lock(&bdev
->bd_holder_lock
);
255 if (bdev
->bd_holder_ops
&& bdev
->bd_holder_ops
->freeze
) {
256 error
= bdev
->bd_holder_ops
->freeze(bdev
);
257 lockdep_assert_not_held(&bdev
->bd_holder_lock
);
259 mutex_unlock(&bdev
->bd_holder_lock
);
260 error
= sync_blockdev(bdev
);
264 atomic_dec(&bdev
->bd_fsfreeze_count
);
266 mutex_unlock(&bdev
->bd_fsfreeze_mutex
);
269 EXPORT_SYMBOL(bdev_freeze
);
272 * bdev_thaw - unlock filesystem
273 * @bdev: blockdevice to unlock
275 * Unlocks the filesystem and marks it writeable again after bdev_freeze().
277 * Return: On success zero is returned, negative error code on failure.
279 int bdev_thaw(struct block_device
*bdev
)
281 int error
= -EINVAL
, nr_freeze
;
283 mutex_lock(&bdev
->bd_fsfreeze_mutex
);
286 * If this returns < 0 it means that @bd_fsfreeze_count was
287 * already 0 and no decrement was performed.
289 nr_freeze
= atomic_dec_if_positive(&bdev
->bd_fsfreeze_count
);
297 mutex_lock(&bdev
->bd_holder_lock
);
298 if (bdev
->bd_holder_ops
&& bdev
->bd_holder_ops
->thaw
) {
299 error
= bdev
->bd_holder_ops
->thaw(bdev
);
300 lockdep_assert_not_held(&bdev
->bd_holder_lock
);
302 mutex_unlock(&bdev
->bd_holder_lock
);
306 atomic_inc(&bdev
->bd_fsfreeze_count
);
308 mutex_unlock(&bdev
->bd_fsfreeze_mutex
);
311 EXPORT_SYMBOL(bdev_thaw
);
317 static __cacheline_aligned_in_smp
DEFINE_MUTEX(bdev_lock
);
318 static struct kmem_cache
*bdev_cachep __ro_after_init
;
320 static struct inode
*bdev_alloc_inode(struct super_block
*sb
)
322 struct bdev_inode
*ei
= alloc_inode_sb(sb
, bdev_cachep
, GFP_KERNEL
);
326 memset(&ei
->bdev
, 0, sizeof(ei
->bdev
));
328 if (security_bdev_alloc(&ei
->bdev
)) {
329 kmem_cache_free(bdev_cachep
, ei
);
332 return &ei
->vfs_inode
;
335 static void bdev_free_inode(struct inode
*inode
)
337 struct block_device
*bdev
= I_BDEV(inode
);
339 free_percpu(bdev
->bd_stats
);
340 kfree(bdev
->bd_meta_info
);
341 security_bdev_free(bdev
);
343 if (!bdev_is_partition(bdev
)) {
344 if (bdev
->bd_disk
&& bdev
->bd_disk
->bdi
)
345 bdi_put(bdev
->bd_disk
->bdi
);
346 kfree(bdev
->bd_disk
);
349 if (MAJOR(bdev
->bd_dev
) == BLOCK_EXT_MAJOR
)
350 blk_free_ext_minor(MINOR(bdev
->bd_dev
));
352 kmem_cache_free(bdev_cachep
, BDEV_I(inode
));
355 static void init_once(void *data
)
357 struct bdev_inode
*ei
= data
;
359 inode_init_once(&ei
->vfs_inode
);
362 static void bdev_evict_inode(struct inode
*inode
)
364 truncate_inode_pages_final(&inode
->i_data
);
365 invalidate_inode_buffers(inode
); /* is it needed here? */
369 static const struct super_operations bdev_sops
= {
370 .statfs
= simple_statfs
,
371 .alloc_inode
= bdev_alloc_inode
,
372 .free_inode
= bdev_free_inode
,
373 .drop_inode
= generic_delete_inode
,
374 .evict_inode
= bdev_evict_inode
,
377 static int bd_init_fs_context(struct fs_context
*fc
)
379 struct pseudo_fs_context
*ctx
= init_pseudo(fc
, BDEVFS_MAGIC
);
382 fc
->s_iflags
|= SB_I_CGROUPWB
;
383 ctx
->ops
= &bdev_sops
;
387 static struct file_system_type bd_type
= {
389 .init_fs_context
= bd_init_fs_context
,
390 .kill_sb
= kill_anon_super
,
393 struct super_block
*blockdev_superblock __ro_after_init
;
394 static struct vfsmount
*blockdev_mnt __ro_after_init
;
395 EXPORT_SYMBOL_GPL(blockdev_superblock
);
397 void __init
bdev_cache_init(void)
401 bdev_cachep
= kmem_cache_create("bdev_cache", sizeof(struct bdev_inode
),
402 0, (SLAB_HWCACHE_ALIGN
|SLAB_RECLAIM_ACCOUNT
|
403 SLAB_ACCOUNT
|SLAB_PANIC
),
405 err
= register_filesystem(&bd_type
);
407 panic("Cannot register bdev pseudo-fs");
408 blockdev_mnt
= kern_mount(&bd_type
);
409 if (IS_ERR(blockdev_mnt
))
410 panic("Cannot create bdev pseudo-fs");
411 blockdev_superblock
= blockdev_mnt
->mnt_sb
; /* For writeback */
414 struct block_device
*bdev_alloc(struct gendisk
*disk
, u8 partno
)
416 struct block_device
*bdev
;
419 inode
= new_inode(blockdev_superblock
);
422 inode
->i_mode
= S_IFBLK
;
424 inode
->i_data
.a_ops
= &def_blk_aops
;
425 mapping_set_gfp_mask(&inode
->i_data
, GFP_USER
);
427 bdev
= I_BDEV(inode
);
428 mutex_init(&bdev
->bd_fsfreeze_mutex
);
429 spin_lock_init(&bdev
->bd_size_lock
);
430 mutex_init(&bdev
->bd_holder_lock
);
431 atomic_set(&bdev
->__bd_flags
, partno
);
432 bdev
->bd_mapping
= &inode
->i_data
;
433 bdev
->bd_queue
= disk
->queue
;
434 if (partno
&& bdev_test_flag(disk
->part0
, BD_HAS_SUBMIT_BIO
))
435 bdev_set_flag(bdev
, BD_HAS_SUBMIT_BIO
);
436 bdev
->bd_stats
= alloc_percpu(struct disk_stats
);
437 if (!bdev
->bd_stats
) {
441 bdev
->bd_disk
= disk
;
445 void bdev_set_nr_sectors(struct block_device
*bdev
, sector_t sectors
)
447 spin_lock(&bdev
->bd_size_lock
);
448 i_size_write(BD_INODE(bdev
), (loff_t
)sectors
<< SECTOR_SHIFT
);
449 bdev
->bd_nr_sectors
= sectors
;
450 spin_unlock(&bdev
->bd_size_lock
);
453 void bdev_add(struct block_device
*bdev
, dev_t dev
)
455 struct inode
*inode
= BD_INODE(bdev
);
456 if (bdev_stable_writes(bdev
))
457 mapping_set_stable_writes(bdev
->bd_mapping
);
461 insert_inode_hash(inode
);
464 void bdev_unhash(struct block_device
*bdev
)
466 remove_inode_hash(BD_INODE(bdev
));
469 void bdev_drop(struct block_device
*bdev
)
471 iput(BD_INODE(bdev
));
474 long nr_blockdev_pages(void)
479 spin_lock(&blockdev_superblock
->s_inode_list_lock
);
480 list_for_each_entry(inode
, &blockdev_superblock
->s_inodes
, i_sb_list
)
481 ret
+= inode
->i_mapping
->nrpages
;
482 spin_unlock(&blockdev_superblock
->s_inode_list_lock
);
488 * bd_may_claim - test whether a block device can be claimed
489 * @bdev: block device of interest
490 * @holder: holder trying to claim @bdev
493 * Test whether @bdev can be claimed by @holder.
496 * %true if @bdev can be claimed, %false otherwise.
498 static bool bd_may_claim(struct block_device
*bdev
, void *holder
,
499 const struct blk_holder_ops
*hops
)
501 struct block_device
*whole
= bdev_whole(bdev
);
503 lockdep_assert_held(&bdev_lock
);
505 if (bdev
->bd_holder
) {
507 * The same holder can always re-claim.
509 if (bdev
->bd_holder
== holder
) {
510 if (WARN_ON_ONCE(bdev
->bd_holder_ops
!= hops
))
518 * If the whole devices holder is set to bd_may_claim, a partition on
519 * the device is claimed, but not the whole device.
522 whole
->bd_holder
&& whole
->bd_holder
!= bd_may_claim
)
528 * bd_prepare_to_claim - claim a block device
529 * @bdev: block device of interest
530 * @holder: holder trying to claim @bdev
533 * Claim @bdev. This function fails if @bdev is already claimed by another
534 * holder and waits if another claiming is in progress. return, the caller
535 * has ownership of bd_claiming and bd_holder[s].
538 * 0 if @bdev can be claimed, -EBUSY otherwise.
540 int bd_prepare_to_claim(struct block_device
*bdev
, void *holder
,
541 const struct blk_holder_ops
*hops
)
543 struct block_device
*whole
= bdev_whole(bdev
);
545 if (WARN_ON_ONCE(!holder
))
548 mutex_lock(&bdev_lock
);
549 /* if someone else claimed, fail */
550 if (!bd_may_claim(bdev
, holder
, hops
)) {
551 mutex_unlock(&bdev_lock
);
555 /* if claiming is already in progress, wait for it to finish */
556 if (whole
->bd_claiming
) {
557 wait_queue_head_t
*wq
= __var_waitqueue(&whole
->bd_claiming
);
560 prepare_to_wait(wq
, &wait
, TASK_UNINTERRUPTIBLE
);
561 mutex_unlock(&bdev_lock
);
563 finish_wait(wq
, &wait
);
568 whole
->bd_claiming
= holder
;
569 mutex_unlock(&bdev_lock
);
572 EXPORT_SYMBOL_GPL(bd_prepare_to_claim
); /* only for the loop driver */
574 static void bd_clear_claiming(struct block_device
*whole
, void *holder
)
576 lockdep_assert_held(&bdev_lock
);
577 /* tell others that we're done */
578 BUG_ON(whole
->bd_claiming
!= holder
);
579 whole
->bd_claiming
= NULL
;
580 wake_up_var(&whole
->bd_claiming
);
584 * bd_finish_claiming - finish claiming of a block device
585 * @bdev: block device of interest
586 * @holder: holder that has claimed @bdev
587 * @hops: block device holder operations
589 * Finish exclusive open of a block device. Mark the device as exlusively
590 * open by the holder and wake up all waiters for exclusive open to finish.
592 static void bd_finish_claiming(struct block_device
*bdev
, void *holder
,
593 const struct blk_holder_ops
*hops
)
595 struct block_device
*whole
= bdev_whole(bdev
);
597 mutex_lock(&bdev_lock
);
598 BUG_ON(!bd_may_claim(bdev
, holder
, hops
));
600 * Note that for a whole device bd_holders will be incremented twice,
601 * and bd_holder will be set to bd_may_claim before being set to holder
604 whole
->bd_holder
= bd_may_claim
;
606 mutex_lock(&bdev
->bd_holder_lock
);
607 bdev
->bd_holder
= holder
;
608 bdev
->bd_holder_ops
= hops
;
609 mutex_unlock(&bdev
->bd_holder_lock
);
610 bd_clear_claiming(whole
, holder
);
611 mutex_unlock(&bdev_lock
);
615 * bd_abort_claiming - abort claiming of a block device
616 * @bdev: block device of interest
617 * @holder: holder that has claimed @bdev
619 * Abort claiming of a block device when the exclusive open failed. This can be
620 * also used when exclusive open is not actually desired and we just needed
621 * to block other exclusive openers for a while.
623 void bd_abort_claiming(struct block_device
*bdev
, void *holder
)
625 mutex_lock(&bdev_lock
);
626 bd_clear_claiming(bdev_whole(bdev
), holder
);
627 mutex_unlock(&bdev_lock
);
629 EXPORT_SYMBOL(bd_abort_claiming
);
631 static void bd_end_claim(struct block_device
*bdev
, void *holder
)
633 struct block_device
*whole
= bdev_whole(bdev
);
634 bool unblock
= false;
637 * Release a claim on the device. The holder fields are protected with
638 * bdev_lock. open_mutex is used to synchronize disk_holder unlinking.
640 mutex_lock(&bdev_lock
);
641 WARN_ON_ONCE(bdev
->bd_holder
!= holder
);
642 WARN_ON_ONCE(--bdev
->bd_holders
< 0);
643 WARN_ON_ONCE(--whole
->bd_holders
< 0);
644 if (!bdev
->bd_holders
) {
645 mutex_lock(&bdev
->bd_holder_lock
);
646 bdev
->bd_holder
= NULL
;
647 bdev
->bd_holder_ops
= NULL
;
648 mutex_unlock(&bdev
->bd_holder_lock
);
649 if (bdev_test_flag(bdev
, BD_WRITE_HOLDER
))
652 if (!whole
->bd_holders
)
653 whole
->bd_holder
= NULL
;
654 mutex_unlock(&bdev_lock
);
657 * If this was the last claim, remove holder link and unblock evpoll if
658 * it was a write holder.
661 disk_unblock_events(bdev
->bd_disk
);
662 bdev_clear_flag(bdev
, BD_WRITE_HOLDER
);
666 static void blkdev_flush_mapping(struct block_device
*bdev
)
668 WARN_ON_ONCE(bdev
->bd_holders
);
671 bdev_write_inode(bdev
);
674 static void blkdev_put_whole(struct block_device
*bdev
)
676 if (atomic_dec_and_test(&bdev
->bd_openers
))
677 blkdev_flush_mapping(bdev
);
678 if (bdev
->bd_disk
->fops
->release
)
679 bdev
->bd_disk
->fops
->release(bdev
->bd_disk
);
682 static int blkdev_get_whole(struct block_device
*bdev
, blk_mode_t mode
)
684 struct gendisk
*disk
= bdev
->bd_disk
;
687 if (disk
->fops
->open
) {
688 ret
= disk
->fops
->open(disk
, mode
);
690 /* avoid ghost partitions on a removed medium */
691 if (ret
== -ENOMEDIUM
&&
692 test_bit(GD_NEED_PART_SCAN
, &disk
->state
))
693 bdev_disk_changed(disk
, true);
698 if (!atomic_read(&bdev
->bd_openers
))
699 set_init_blocksize(bdev
);
700 atomic_inc(&bdev
->bd_openers
);
701 if (test_bit(GD_NEED_PART_SCAN
, &disk
->state
)) {
703 * Only return scanning errors if we are called from contexts
704 * that explicitly want them, e.g. the BLKRRPART ioctl.
706 ret
= bdev_disk_changed(disk
, false);
707 if (ret
&& (mode
& BLK_OPEN_STRICT_SCAN
)) {
708 blkdev_put_whole(bdev
);
715 static int blkdev_get_part(struct block_device
*part
, blk_mode_t mode
)
717 struct gendisk
*disk
= part
->bd_disk
;
720 ret
= blkdev_get_whole(bdev_whole(part
), mode
);
725 if (!bdev_nr_sectors(part
))
728 if (!atomic_read(&part
->bd_openers
)) {
729 disk
->open_partitions
++;
730 set_init_blocksize(part
);
732 atomic_inc(&part
->bd_openers
);
736 blkdev_put_whole(bdev_whole(part
));
740 int bdev_permission(dev_t dev
, blk_mode_t mode
, void *holder
)
744 ret
= devcgroup_check_permission(DEVCG_DEV_BLOCK
,
745 MAJOR(dev
), MINOR(dev
),
746 ((mode
& BLK_OPEN_READ
) ? DEVCG_ACC_READ
: 0) |
747 ((mode
& BLK_OPEN_WRITE
) ? DEVCG_ACC_WRITE
: 0));
751 /* Blocking writes requires exclusive opener */
752 if (mode
& BLK_OPEN_RESTRICT_WRITES
&& !holder
)
756 * We're using error pointers to indicate to ->release() when we
757 * failed to open that block device. Also this doesn't make sense.
759 if (WARN_ON_ONCE(IS_ERR(holder
)))
765 static void blkdev_put_part(struct block_device
*part
)
767 struct block_device
*whole
= bdev_whole(part
);
769 if (atomic_dec_and_test(&part
->bd_openers
)) {
770 blkdev_flush_mapping(part
);
771 whole
->bd_disk
->open_partitions
--;
773 blkdev_put_whole(whole
);
776 struct block_device
*blkdev_get_no_open(dev_t dev
)
778 struct block_device
*bdev
;
781 inode
= ilookup(blockdev_superblock
, dev
);
782 if (!inode
&& IS_ENABLED(CONFIG_BLOCK_LEGACY_AUTOLOAD
)) {
783 blk_request_module(dev
);
784 inode
= ilookup(blockdev_superblock
, dev
);
787 "block device autoloading is deprecated and will be removed.\n");
792 /* switch from the inode reference to a device mode one: */
793 bdev
= &BDEV_I(inode
)->bdev
;
794 if (!kobject_get_unless_zero(&bdev
->bd_device
.kobj
))
800 void blkdev_put_no_open(struct block_device
*bdev
)
802 put_device(&bdev
->bd_device
);
805 static bool bdev_writes_blocked(struct block_device
*bdev
)
807 return bdev
->bd_writers
< 0;
810 static void bdev_block_writes(struct block_device
*bdev
)
815 static void bdev_unblock_writes(struct block_device
*bdev
)
820 static bool bdev_may_open(struct block_device
*bdev
, blk_mode_t mode
)
822 if (bdev_allow_write_mounted
)
824 /* Writes blocked? */
825 if (mode
& BLK_OPEN_WRITE
&& bdev_writes_blocked(bdev
))
827 if (mode
& BLK_OPEN_RESTRICT_WRITES
&& bdev
->bd_writers
> 0)
832 static void bdev_claim_write_access(struct block_device
*bdev
, blk_mode_t mode
)
834 if (bdev_allow_write_mounted
)
837 /* Claim exclusive or shared write access. */
838 if (mode
& BLK_OPEN_RESTRICT_WRITES
)
839 bdev_block_writes(bdev
);
840 else if (mode
& BLK_OPEN_WRITE
)
844 static inline bool bdev_unclaimed(const struct file
*bdev_file
)
846 return bdev_file
->private_data
== BDEV_I(bdev_file
->f_mapping
->host
);
849 static void bdev_yield_write_access(struct file
*bdev_file
)
851 struct block_device
*bdev
;
853 if (bdev_allow_write_mounted
)
856 if (bdev_unclaimed(bdev_file
))
859 bdev
= file_bdev(bdev_file
);
861 if (bdev_file
->f_mode
& FMODE_WRITE_RESTRICTED
)
862 bdev_unblock_writes(bdev
);
863 else if (bdev_file
->f_mode
& FMODE_WRITE
)
868 * bdev_open - open a block device
869 * @bdev: block device to open
870 * @mode: open mode (BLK_OPEN_*)
871 * @holder: exclusive holder identifier
872 * @hops: holder operations
873 * @bdev_file: file for the block device
875 * Open the block device. If @holder is not %NULL, the block device is opened
876 * with exclusive access. Exclusive opens may nest for the same @holder.
882 * zero on success, -errno on failure.
884 int bdev_open(struct block_device
*bdev
, blk_mode_t mode
, void *holder
,
885 const struct blk_holder_ops
*hops
, struct file
*bdev_file
)
887 bool unblock_events
= true;
888 struct gendisk
*disk
= bdev
->bd_disk
;
892 mode
|= BLK_OPEN_EXCL
;
893 ret
= bd_prepare_to_claim(bdev
, holder
, hops
);
897 if (WARN_ON_ONCE(mode
& BLK_OPEN_EXCL
))
901 disk_block_events(disk
);
903 mutex_lock(&disk
->open_mutex
);
905 if (!disk_live(disk
))
907 if (!try_module_get(disk
->fops
->owner
))
910 if (!bdev_may_open(bdev
, mode
))
912 if (bdev_is_partition(bdev
))
913 ret
= blkdev_get_part(bdev
, mode
);
915 ret
= blkdev_get_whole(bdev
, mode
);
918 bdev_claim_write_access(bdev
, mode
);
920 bd_finish_claiming(bdev
, holder
, hops
);
923 * Block event polling for write claims if requested. Any write
924 * holder makes the write_holder state stick until all are
925 * released. This is good enough and tracking individual
926 * writeable reference is too fragile given the way @mode is
927 * used in blkdev_get/put().
929 if ((mode
& BLK_OPEN_WRITE
) &&
930 !bdev_test_flag(bdev
, BD_WRITE_HOLDER
) &&
931 (disk
->event_flags
& DISK_EVENT_FLAG_BLOCK_ON_EXCL_WRITE
)) {
932 bdev_set_flag(bdev
, BD_WRITE_HOLDER
);
933 unblock_events
= false;
936 mutex_unlock(&disk
->open_mutex
);
939 disk_unblock_events(disk
);
941 bdev_file
->f_flags
|= O_LARGEFILE
;
942 bdev_file
->f_mode
|= FMODE_CAN_ODIRECT
;
943 if (bdev_nowait(bdev
))
944 bdev_file
->f_mode
|= FMODE_NOWAIT
;
945 if (mode
& BLK_OPEN_RESTRICT_WRITES
)
946 bdev_file
->f_mode
|= FMODE_WRITE_RESTRICTED
;
947 bdev_file
->f_mapping
= bdev
->bd_mapping
;
948 bdev_file
->f_wb_err
= filemap_sample_wb_err(bdev_file
->f_mapping
);
949 bdev_file
->private_data
= holder
;
953 module_put(disk
->fops
->owner
);
956 bd_abort_claiming(bdev
, holder
);
957 mutex_unlock(&disk
->open_mutex
);
958 disk_unblock_events(disk
);
963 * If BLK_OPEN_WRITE_IOCTL is set then this is a historical quirk
964 * associated with the floppy driver where it has allowed ioctls if the
965 * file was opened for writing, but does not allow reads or writes.
966 * Make sure that this quirk is reflected in @f_flags.
968 * It can also happen if a block device is opened as O_RDWR | O_WRONLY.
970 static unsigned blk_to_file_flags(blk_mode_t mode
)
972 unsigned int flags
= 0;
974 if ((mode
& (BLK_OPEN_READ
| BLK_OPEN_WRITE
)) ==
975 (BLK_OPEN_READ
| BLK_OPEN_WRITE
))
977 else if (mode
& BLK_OPEN_WRITE_IOCTL
)
978 flags
|= O_RDWR
| O_WRONLY
;
979 else if (mode
& BLK_OPEN_WRITE
)
981 else if (mode
& BLK_OPEN_READ
)
982 flags
|= O_RDONLY
; /* homeopathic, because O_RDONLY is 0 */
986 if (mode
& BLK_OPEN_NDELAY
)
992 struct file
*bdev_file_open_by_dev(dev_t dev
, blk_mode_t mode
, void *holder
,
993 const struct blk_holder_ops
*hops
)
995 struct file
*bdev_file
;
996 struct block_device
*bdev
;
1000 ret
= bdev_permission(dev
, mode
, holder
);
1002 return ERR_PTR(ret
);
1004 bdev
= blkdev_get_no_open(dev
);
1006 return ERR_PTR(-ENXIO
);
1008 flags
= blk_to_file_flags(mode
);
1009 bdev_file
= alloc_file_pseudo_noaccount(BD_INODE(bdev
),
1010 blockdev_mnt
, "", flags
| O_LARGEFILE
, &def_blk_fops
);
1011 if (IS_ERR(bdev_file
)) {
1012 blkdev_put_no_open(bdev
);
1015 ihold(BD_INODE(bdev
));
1017 ret
= bdev_open(bdev
, mode
, holder
, hops
, bdev_file
);
1019 /* We failed to open the block device. Let ->release() know. */
1020 bdev_file
->private_data
= ERR_PTR(ret
);
1022 return ERR_PTR(ret
);
1026 EXPORT_SYMBOL(bdev_file_open_by_dev
);
1028 struct file
*bdev_file_open_by_path(const char *path
, blk_mode_t mode
,
1030 const struct blk_holder_ops
*hops
)
1036 error
= lookup_bdev(path
, &dev
);
1038 return ERR_PTR(error
);
1040 file
= bdev_file_open_by_dev(dev
, mode
, holder
, hops
);
1041 if (!IS_ERR(file
) && (mode
& BLK_OPEN_WRITE
)) {
1042 if (bdev_read_only(file_bdev(file
))) {
1044 file
= ERR_PTR(-EACCES
);
1050 EXPORT_SYMBOL(bdev_file_open_by_path
);
1052 static inline void bd_yield_claim(struct file
*bdev_file
)
1054 struct block_device
*bdev
= file_bdev(bdev_file
);
1055 void *holder
= bdev_file
->private_data
;
1057 lockdep_assert_held(&bdev
->bd_disk
->open_mutex
);
1059 if (WARN_ON_ONCE(IS_ERR_OR_NULL(holder
)))
1062 if (!bdev_unclaimed(bdev_file
))
1063 bd_end_claim(bdev
, holder
);
1066 void bdev_release(struct file
*bdev_file
)
1068 struct block_device
*bdev
= file_bdev(bdev_file
);
1069 void *holder
= bdev_file
->private_data
;
1070 struct gendisk
*disk
= bdev
->bd_disk
;
1072 /* We failed to open that block device. */
1077 * Sync early if it looks like we're the last one. If someone else
1078 * opens the block device between now and the decrement of bd_openers
1079 * then we did a sync that we didn't need to, but that's not the end
1080 * of the world and we want to avoid long (could be several minute)
1081 * syncs while holding the mutex.
1083 if (atomic_read(&bdev
->bd_openers
) == 1)
1084 sync_blockdev(bdev
);
1086 mutex_lock(&disk
->open_mutex
);
1087 bdev_yield_write_access(bdev_file
);
1090 bd_yield_claim(bdev_file
);
1093 * Trigger event checking and tell drivers to flush MEDIA_CHANGE
1094 * event. This is to ensure detection of media removal commanded
1095 * from userland - e.g. eject(1).
1097 disk_flush_events(disk
, DISK_EVENT_MEDIA_CHANGE
);
1099 if (bdev_is_partition(bdev
))
1100 blkdev_put_part(bdev
);
1102 blkdev_put_whole(bdev
);
1103 mutex_unlock(&disk
->open_mutex
);
1105 module_put(disk
->fops
->owner
);
1107 blkdev_put_no_open(bdev
);
1111 * bdev_fput - yield claim to the block device and put the file
1112 * @bdev_file: open block device
1114 * Yield claim on the block device and put the file. Ensure that the
1115 * block device can be reclaimed before the file is closed which is a
1116 * deferred operation.
1118 void bdev_fput(struct file
*bdev_file
)
1120 if (WARN_ON_ONCE(bdev_file
->f_op
!= &def_blk_fops
))
1123 if (bdev_file
->private_data
) {
1124 struct block_device
*bdev
= file_bdev(bdev_file
);
1125 struct gendisk
*disk
= bdev
->bd_disk
;
1127 mutex_lock(&disk
->open_mutex
);
1128 bdev_yield_write_access(bdev_file
);
1129 bd_yield_claim(bdev_file
);
1131 * Tell release we already gave up our hold on the
1132 * device and if write restrictions are available that
1133 * we already gave up write access to the device.
1135 bdev_file
->private_data
= BDEV_I(bdev_file
->f_mapping
->host
);
1136 mutex_unlock(&disk
->open_mutex
);
1141 EXPORT_SYMBOL(bdev_fput
);
1144 * lookup_bdev() - Look up a struct block_device by name.
1145 * @pathname: Name of the block device in the filesystem.
1146 * @dev: Pointer to the block device's dev_t, if found.
1148 * Lookup the block device's dev_t at @pathname in the current
1149 * namespace if possible and return it in @dev.
1151 * Context: May sleep.
1152 * Return: 0 if succeeded, negative errno otherwise.
1154 int lookup_bdev(const char *pathname
, dev_t
*dev
)
1156 struct inode
*inode
;
1160 if (!pathname
|| !*pathname
)
1163 error
= kern_path(pathname
, LOOKUP_FOLLOW
, &path
);
1167 inode
= d_backing_inode(path
.dentry
);
1169 if (!S_ISBLK(inode
->i_mode
))
1172 if (!may_open_dev(&path
))
1175 *dev
= inode
->i_rdev
;
1181 EXPORT_SYMBOL(lookup_bdev
);
1184 * bdev_mark_dead - mark a block device as dead
1185 * @bdev: block device to operate on
1186 * @surprise: indicate a surprise removal
1188 * Tell the file system that this devices or media is dead. If @surprise is set
1189 * to %true the device or media is already gone, if not we are preparing for an
1192 * This calls into the file system, which then typicall syncs out all dirty data
1193 * and writes back inodes and then invalidates any cached data in the inodes on
1194 * the file system. In addition we also invalidate the block device mapping.
1196 void bdev_mark_dead(struct block_device
*bdev
, bool surprise
)
1198 mutex_lock(&bdev
->bd_holder_lock
);
1199 if (bdev
->bd_holder_ops
&& bdev
->bd_holder_ops
->mark_dead
)
1200 bdev
->bd_holder_ops
->mark_dead(bdev
, surprise
);
1202 mutex_unlock(&bdev
->bd_holder_lock
);
1203 sync_blockdev(bdev
);
1206 invalidate_bdev(bdev
);
1209 * New drivers should not use this directly. There are some drivers however
1210 * that needs this for historical reasons. For example, the DASD driver has
1211 * historically had a shutdown to offline mode that doesn't actually remove the
1212 * gendisk that otherwise looks a lot like a safe device removal.
1214 EXPORT_SYMBOL_GPL(bdev_mark_dead
);
1216 void sync_bdevs(bool wait
)
1218 struct inode
*inode
, *old_inode
= NULL
;
1220 spin_lock(&blockdev_superblock
->s_inode_list_lock
);
1221 list_for_each_entry(inode
, &blockdev_superblock
->s_inodes
, i_sb_list
) {
1222 struct address_space
*mapping
= inode
->i_mapping
;
1223 struct block_device
*bdev
;
1225 spin_lock(&inode
->i_lock
);
1226 if (inode
->i_state
& (I_FREEING
|I_WILL_FREE
|I_NEW
) ||
1227 mapping
->nrpages
== 0) {
1228 spin_unlock(&inode
->i_lock
);
1232 spin_unlock(&inode
->i_lock
);
1233 spin_unlock(&blockdev_superblock
->s_inode_list_lock
);
1235 * We hold a reference to 'inode' so it couldn't have been
1236 * removed from s_inodes list while we dropped the
1237 * s_inode_list_lock We cannot iput the inode now as we can
1238 * be holding the last reference and we cannot iput it under
1239 * s_inode_list_lock. So we keep the reference and iput it
1244 bdev
= I_BDEV(inode
);
1246 mutex_lock(&bdev
->bd_disk
->open_mutex
);
1247 if (!atomic_read(&bdev
->bd_openers
)) {
1251 * We keep the error status of individual mapping so
1252 * that applications can catch the writeback error using
1253 * fsync(2). See filemap_fdatawait_keep_errors() for
1256 filemap_fdatawait_keep_errors(inode
->i_mapping
);
1258 filemap_fdatawrite(inode
->i_mapping
);
1260 mutex_unlock(&bdev
->bd_disk
->open_mutex
);
1262 spin_lock(&blockdev_superblock
->s_inode_list_lock
);
1264 spin_unlock(&blockdev_superblock
->s_inode_list_lock
);
1269 * Handle STATX_{DIOALIGN, WRITE_ATOMIC} for block devices.
1271 void bdev_statx(struct path
*path
, struct kstat
*stat
,
1274 struct inode
*backing_inode
;
1275 struct block_device
*bdev
;
1277 if (!(request_mask
& (STATX_DIOALIGN
| STATX_WRITE_ATOMIC
)))
1280 backing_inode
= d_backing_inode(path
->dentry
);
1283 * Note that backing_inode is the inode of a block device node file,
1284 * not the block device's internal inode. Therefore it is *not* valid
1285 * to use I_BDEV() here; the block device has to be looked up by i_rdev
1288 bdev
= blkdev_get_no_open(backing_inode
->i_rdev
);
1292 if (request_mask
& STATX_DIOALIGN
) {
1293 stat
->dio_mem_align
= bdev_dma_alignment(bdev
) + 1;
1294 stat
->dio_offset_align
= bdev_logical_block_size(bdev
);
1295 stat
->result_mask
|= STATX_DIOALIGN
;
1298 if (request_mask
& STATX_WRITE_ATOMIC
&& bdev_can_atomic_write(bdev
)) {
1299 struct request_queue
*bd_queue
= bdev
->bd_queue
;
1301 generic_fill_statx_atomic_writes(stat
,
1302 queue_atomic_write_unit_min_bytes(bd_queue
),
1303 queue_atomic_write_unit_max_bytes(bd_queue
));
1306 blkdev_put_no_open(bdev
);
1309 bool disk_live(struct gendisk
*disk
)
1311 return !inode_unhashed(BD_INODE(disk
->part0
));
1313 EXPORT_SYMBOL_GPL(disk_live
);
1315 unsigned int block_size(struct block_device
*bdev
)
1317 return 1 << BD_INODE(bdev
)->i_blkbits
;
1319 EXPORT_SYMBOL_GPL(block_size
);
1321 static int __init
setup_bdev_allow_write_mounted(char *str
)
1323 if (kstrtobool(str
, &bdev_allow_write_mounted
))
1324 pr_warn("Invalid option string for bdev_allow_write_mounted:"
1328 __setup("bdev_allow_write_mounted=", setup_bdev_allow_write_mounted
);