xref: /linux/block/bdev.c (revision eb7cca1faf9883d7b4da792281147dbedc449238)
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  *  Copyright (C) 1991, 1992  Linus Torvalds
4  *  Copyright (C) 2001  Andrea Arcangeli <andrea@suse.de> SuSE
5  *  Copyright (C) 2016 - 2020 Christoph Hellwig
6  */
7 
8 #include <linux/init.h>
9 #include <linux/mm.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/part_stat.h>
28 #include <linux/uaccess.h>
29 #include <linux/stat.h>
30 #include "../fs/internal.h"
31 #include "blk.h"
32 
33 /* Should we allow writing to mounted block devices? */
34 static bool bdev_allow_write_mounted = IS_ENABLED(CONFIG_BLK_DEV_WRITE_MOUNTED);
35 
36 struct bdev_inode {
37 	struct block_device bdev;
38 	struct inode vfs_inode;
39 };
40 
41 static inline struct bdev_inode *BDEV_I(struct inode *inode)
42 {
43 	return container_of(inode, struct bdev_inode, vfs_inode);
44 }
45 
46 struct block_device *I_BDEV(struct inode *inode)
47 {
48 	return &BDEV_I(inode)->bdev;
49 }
50 EXPORT_SYMBOL(I_BDEV);
51 
52 struct block_device *file_bdev(struct file *bdev_file)
53 {
54 	return I_BDEV(bdev_file->f_mapping->host);
55 }
56 EXPORT_SYMBOL(file_bdev);
57 
58 static void bdev_write_inode(struct block_device *bdev)
59 {
60 	struct inode *inode = bdev->bd_inode;
61 	int ret;
62 
63 	spin_lock(&inode->i_lock);
64 	while (inode->i_state & I_DIRTY) {
65 		spin_unlock(&inode->i_lock);
66 		ret = write_inode_now(inode, true);
67 		if (ret)
68 			pr_warn_ratelimited(
69 	"VFS: Dirty inode writeback failed for block device %pg (err=%d).\n",
70 				bdev, ret);
71 		spin_lock(&inode->i_lock);
72 	}
73 	spin_unlock(&inode->i_lock);
74 }
75 
76 /* Kill _all_ buffers and pagecache , dirty or not.. */
77 static void kill_bdev(struct block_device *bdev)
78 {
79 	struct address_space *mapping = bdev->bd_inode->i_mapping;
80 
81 	if (mapping_empty(mapping))
82 		return;
83 
84 	invalidate_bh_lrus();
85 	truncate_inode_pages(mapping, 0);
86 }
87 
88 /* Invalidate clean unused buffers and pagecache. */
89 void invalidate_bdev(struct block_device *bdev)
90 {
91 	struct address_space *mapping = bdev->bd_inode->i_mapping;
92 
93 	if (mapping->nrpages) {
94 		invalidate_bh_lrus();
95 		lru_add_drain_all();	/* make sure all lru add caches are flushed */
96 		invalidate_mapping_pages(mapping, 0, -1);
97 	}
98 }
99 EXPORT_SYMBOL(invalidate_bdev);
100 
101 /*
102  * Drop all buffers & page cache for given bdev range. This function bails
103  * with error if bdev has other exclusive owner (such as filesystem).
104  */
105 int truncate_bdev_range(struct block_device *bdev, blk_mode_t mode,
106 			loff_t lstart, loff_t lend)
107 {
108 	/*
109 	 * If we don't hold exclusive handle for the device, upgrade to it
110 	 * while we discard the buffer cache to avoid discarding buffers
111 	 * under live filesystem.
112 	 */
113 	if (!(mode & BLK_OPEN_EXCL)) {
114 		int err = bd_prepare_to_claim(bdev, truncate_bdev_range, NULL);
115 		if (err)
116 			goto invalidate;
117 	}
118 
119 	truncate_inode_pages_range(bdev->bd_inode->i_mapping, lstart, lend);
120 	if (!(mode & BLK_OPEN_EXCL))
121 		bd_abort_claiming(bdev, truncate_bdev_range);
122 	return 0;
123 
124 invalidate:
125 	/*
126 	 * Someone else has handle exclusively open. Try invalidating instead.
127 	 * The 'end' argument is inclusive so the rounding is safe.
128 	 */
129 	return invalidate_inode_pages2_range(bdev->bd_inode->i_mapping,
130 					     lstart >> PAGE_SHIFT,
131 					     lend >> PAGE_SHIFT);
132 }
133 
134 static void set_init_blocksize(struct block_device *bdev)
135 {
136 	unsigned int bsize = bdev_logical_block_size(bdev);
137 	loff_t size = i_size_read(bdev->bd_inode);
138 
139 	while (bsize < PAGE_SIZE) {
140 		if (size & bsize)
141 			break;
142 		bsize <<= 1;
143 	}
144 	bdev->bd_inode->i_blkbits = blksize_bits(bsize);
145 }
146 
147 int set_blocksize(struct block_device *bdev, int size)
148 {
149 	/* Size must be a power of two, and between 512 and PAGE_SIZE */
150 	if (size > PAGE_SIZE || size < 512 || !is_power_of_2(size))
151 		return -EINVAL;
152 
153 	/* Size cannot be smaller than the size supported by the device */
154 	if (size < bdev_logical_block_size(bdev))
155 		return -EINVAL;
156 
157 	/* Don't change the size if it is same as current */
158 	if (bdev->bd_inode->i_blkbits != blksize_bits(size)) {
159 		sync_blockdev(bdev);
160 		bdev->bd_inode->i_blkbits = blksize_bits(size);
161 		kill_bdev(bdev);
162 	}
163 	return 0;
164 }
165 
166 EXPORT_SYMBOL(set_blocksize);
167 
168 int sb_set_blocksize(struct super_block *sb, int size)
169 {
170 	if (set_blocksize(sb->s_bdev, size))
171 		return 0;
172 	/* If we get here, we know size is power of two
173 	 * and it's value is between 512 and PAGE_SIZE */
174 	sb->s_blocksize = size;
175 	sb->s_blocksize_bits = blksize_bits(size);
176 	return sb->s_blocksize;
177 }
178 
179 EXPORT_SYMBOL(sb_set_blocksize);
180 
181 int sb_min_blocksize(struct super_block *sb, int size)
182 {
183 	int minsize = bdev_logical_block_size(sb->s_bdev);
184 	if (size < minsize)
185 		size = minsize;
186 	return sb_set_blocksize(sb, size);
187 }
188 
189 EXPORT_SYMBOL(sb_min_blocksize);
190 
191 int sync_blockdev_nowait(struct block_device *bdev)
192 {
193 	if (!bdev)
194 		return 0;
195 	return filemap_flush(bdev->bd_inode->i_mapping);
196 }
197 EXPORT_SYMBOL_GPL(sync_blockdev_nowait);
198 
199 /*
200  * Write out and wait upon all the dirty data associated with a block
201  * device via its mapping.  Does not take the superblock lock.
202  */
203 int sync_blockdev(struct block_device *bdev)
204 {
205 	if (!bdev)
206 		return 0;
207 	return filemap_write_and_wait(bdev->bd_inode->i_mapping);
208 }
209 EXPORT_SYMBOL(sync_blockdev);
210 
211 int sync_blockdev_range(struct block_device *bdev, loff_t lstart, loff_t lend)
212 {
213 	return filemap_write_and_wait_range(bdev->bd_inode->i_mapping,
214 			lstart, lend);
215 }
216 EXPORT_SYMBOL(sync_blockdev_range);
217 
218 /**
219  * bdev_freeze - lock a filesystem and force it into a consistent state
220  * @bdev:	blockdevice to lock
221  *
222  * If a superblock is found on this device, we take the s_umount semaphore
223  * on it to make sure nobody unmounts until the snapshot creation is done.
224  * The reference counter (bd_fsfreeze_count) guarantees that only the last
225  * unfreeze process can unfreeze the frozen filesystem actually when multiple
226  * freeze requests arrive simultaneously. It counts up in bdev_freeze() and
227  * count down in bdev_thaw(). When it becomes 0, thaw_bdev() will unfreeze
228  * actually.
229  *
230  * Return: On success zero is returned, negative error code on failure.
231  */
232 int bdev_freeze(struct block_device *bdev)
233 {
234 	int error = 0;
235 
236 	mutex_lock(&bdev->bd_fsfreeze_mutex);
237 
238 	if (atomic_inc_return(&bdev->bd_fsfreeze_count) > 1) {
239 		mutex_unlock(&bdev->bd_fsfreeze_mutex);
240 		return 0;
241 	}
242 
243 	mutex_lock(&bdev->bd_holder_lock);
244 	if (bdev->bd_holder_ops && bdev->bd_holder_ops->freeze) {
245 		error = bdev->bd_holder_ops->freeze(bdev);
246 		lockdep_assert_not_held(&bdev->bd_holder_lock);
247 	} else {
248 		mutex_unlock(&bdev->bd_holder_lock);
249 		error = sync_blockdev(bdev);
250 	}
251 
252 	if (error)
253 		atomic_dec(&bdev->bd_fsfreeze_count);
254 
255 	mutex_unlock(&bdev->bd_fsfreeze_mutex);
256 	return error;
257 }
258 EXPORT_SYMBOL(bdev_freeze);
259 
260 /**
261  * bdev_thaw - unlock filesystem
262  * @bdev:	blockdevice to unlock
263  *
264  * Unlocks the filesystem and marks it writeable again after bdev_freeze().
265  *
266  * Return: On success zero is returned, negative error code on failure.
267  */
268 int bdev_thaw(struct block_device *bdev)
269 {
270 	int error = -EINVAL, nr_freeze;
271 
272 	mutex_lock(&bdev->bd_fsfreeze_mutex);
273 
274 	/*
275 	 * If this returns < 0 it means that @bd_fsfreeze_count was
276 	 * already 0 and no decrement was performed.
277 	 */
278 	nr_freeze = atomic_dec_if_positive(&bdev->bd_fsfreeze_count);
279 	if (nr_freeze < 0)
280 		goto out;
281 
282 	error = 0;
283 	if (nr_freeze > 0)
284 		goto out;
285 
286 	mutex_lock(&bdev->bd_holder_lock);
287 	if (bdev->bd_holder_ops && bdev->bd_holder_ops->thaw) {
288 		error = bdev->bd_holder_ops->thaw(bdev);
289 		lockdep_assert_not_held(&bdev->bd_holder_lock);
290 	} else {
291 		mutex_unlock(&bdev->bd_holder_lock);
292 	}
293 
294 	if (error)
295 		atomic_inc(&bdev->bd_fsfreeze_count);
296 out:
297 	mutex_unlock(&bdev->bd_fsfreeze_mutex);
298 	return error;
299 }
300 EXPORT_SYMBOL(bdev_thaw);
301 
302 /*
303  * pseudo-fs
304  */
305 
306 static  __cacheline_aligned_in_smp DEFINE_MUTEX(bdev_lock);
307 static struct kmem_cache *bdev_cachep __ro_after_init;
308 
309 static struct inode *bdev_alloc_inode(struct super_block *sb)
310 {
311 	struct bdev_inode *ei = alloc_inode_sb(sb, bdev_cachep, GFP_KERNEL);
312 
313 	if (!ei)
314 		return NULL;
315 	memset(&ei->bdev, 0, sizeof(ei->bdev));
316 	return &ei->vfs_inode;
317 }
318 
319 static void bdev_free_inode(struct inode *inode)
320 {
321 	struct block_device *bdev = I_BDEV(inode);
322 
323 	free_percpu(bdev->bd_stats);
324 	kfree(bdev->bd_meta_info);
325 
326 	if (!bdev_is_partition(bdev)) {
327 		if (bdev->bd_disk && bdev->bd_disk->bdi)
328 			bdi_put(bdev->bd_disk->bdi);
329 		kfree(bdev->bd_disk);
330 	}
331 
332 	if (MAJOR(bdev->bd_dev) == BLOCK_EXT_MAJOR)
333 		blk_free_ext_minor(MINOR(bdev->bd_dev));
334 
335 	kmem_cache_free(bdev_cachep, BDEV_I(inode));
336 }
337 
338 static void init_once(void *data)
339 {
340 	struct bdev_inode *ei = data;
341 
342 	inode_init_once(&ei->vfs_inode);
343 }
344 
345 static void bdev_evict_inode(struct inode *inode)
346 {
347 	truncate_inode_pages_final(&inode->i_data);
348 	invalidate_inode_buffers(inode); /* is it needed here? */
349 	clear_inode(inode);
350 }
351 
352 static const struct super_operations bdev_sops = {
353 	.statfs = simple_statfs,
354 	.alloc_inode = bdev_alloc_inode,
355 	.free_inode = bdev_free_inode,
356 	.drop_inode = generic_delete_inode,
357 	.evict_inode = bdev_evict_inode,
358 };
359 
360 static int bd_init_fs_context(struct fs_context *fc)
361 {
362 	struct pseudo_fs_context *ctx = init_pseudo(fc, BDEVFS_MAGIC);
363 	if (!ctx)
364 		return -ENOMEM;
365 	fc->s_iflags |= SB_I_CGROUPWB;
366 	ctx->ops = &bdev_sops;
367 	return 0;
368 }
369 
370 static struct file_system_type bd_type = {
371 	.name		= "bdev",
372 	.init_fs_context = bd_init_fs_context,
373 	.kill_sb	= kill_anon_super,
374 };
375 
376 struct super_block *blockdev_superblock __ro_after_init;
377 struct vfsmount *blockdev_mnt __ro_after_init;
378 EXPORT_SYMBOL_GPL(blockdev_superblock);
379 
380 void __init bdev_cache_init(void)
381 {
382 	int err;
383 
384 	bdev_cachep = kmem_cache_create("bdev_cache", sizeof(struct bdev_inode),
385 			0, (SLAB_HWCACHE_ALIGN|SLAB_RECLAIM_ACCOUNT|
386 				SLAB_ACCOUNT|SLAB_PANIC),
387 			init_once);
388 	err = register_filesystem(&bd_type);
389 	if (err)
390 		panic("Cannot register bdev pseudo-fs");
391 	blockdev_mnt = kern_mount(&bd_type);
392 	if (IS_ERR(blockdev_mnt))
393 		panic("Cannot create bdev pseudo-fs");
394 	blockdev_superblock = blockdev_mnt->mnt_sb;   /* For writeback */
395 }
396 
397 struct block_device *bdev_alloc(struct gendisk *disk, u8 partno)
398 {
399 	struct block_device *bdev;
400 	struct inode *inode;
401 
402 	inode = new_inode(blockdev_superblock);
403 	if (!inode)
404 		return NULL;
405 	inode->i_mode = S_IFBLK;
406 	inode->i_rdev = 0;
407 	inode->i_data.a_ops = &def_blk_aops;
408 	mapping_set_gfp_mask(&inode->i_data, GFP_USER);
409 
410 	bdev = I_BDEV(inode);
411 	mutex_init(&bdev->bd_fsfreeze_mutex);
412 	spin_lock_init(&bdev->bd_size_lock);
413 	mutex_init(&bdev->bd_holder_lock);
414 	bdev->bd_partno = partno;
415 	bdev->bd_inode = inode;
416 	bdev->bd_queue = disk->queue;
417 	if (partno)
418 		bdev->bd_has_submit_bio = disk->part0->bd_has_submit_bio;
419 	else
420 		bdev->bd_has_submit_bio = false;
421 	bdev->bd_stats = alloc_percpu(struct disk_stats);
422 	if (!bdev->bd_stats) {
423 		iput(inode);
424 		return NULL;
425 	}
426 	bdev->bd_disk = disk;
427 	return bdev;
428 }
429 
430 void bdev_set_nr_sectors(struct block_device *bdev, sector_t sectors)
431 {
432 	spin_lock(&bdev->bd_size_lock);
433 	i_size_write(bdev->bd_inode, (loff_t)sectors << SECTOR_SHIFT);
434 	bdev->bd_nr_sectors = sectors;
435 	spin_unlock(&bdev->bd_size_lock);
436 }
437 
438 void bdev_add(struct block_device *bdev, dev_t dev)
439 {
440 	if (bdev_stable_writes(bdev))
441 		mapping_set_stable_writes(bdev->bd_inode->i_mapping);
442 	bdev->bd_dev = dev;
443 	bdev->bd_inode->i_rdev = dev;
444 	bdev->bd_inode->i_ino = dev;
445 	insert_inode_hash(bdev->bd_inode);
446 }
447 
448 long nr_blockdev_pages(void)
449 {
450 	struct inode *inode;
451 	long ret = 0;
452 
453 	spin_lock(&blockdev_superblock->s_inode_list_lock);
454 	list_for_each_entry(inode, &blockdev_superblock->s_inodes, i_sb_list)
455 		ret += inode->i_mapping->nrpages;
456 	spin_unlock(&blockdev_superblock->s_inode_list_lock);
457 
458 	return ret;
459 }
460 
461 /**
462  * bd_may_claim - test whether a block device can be claimed
463  * @bdev: block device of interest
464  * @holder: holder trying to claim @bdev
465  * @hops: holder ops
466  *
467  * Test whether @bdev can be claimed by @holder.
468  *
469  * RETURNS:
470  * %true if @bdev can be claimed, %false otherwise.
471  */
472 static bool bd_may_claim(struct block_device *bdev, void *holder,
473 		const struct blk_holder_ops *hops)
474 {
475 	struct block_device *whole = bdev_whole(bdev);
476 
477 	lockdep_assert_held(&bdev_lock);
478 
479 	if (bdev->bd_holder) {
480 		/*
481 		 * The same holder can always re-claim.
482 		 */
483 		if (bdev->bd_holder == holder) {
484 			if (WARN_ON_ONCE(bdev->bd_holder_ops != hops))
485 				return false;
486 			return true;
487 		}
488 		return false;
489 	}
490 
491 	/*
492 	 * If the whole devices holder is set to bd_may_claim, a partition on
493 	 * the device is claimed, but not the whole device.
494 	 */
495 	if (whole != bdev &&
496 	    whole->bd_holder && whole->bd_holder != bd_may_claim)
497 		return false;
498 	return true;
499 }
500 
501 /**
502  * bd_prepare_to_claim - claim a block device
503  * @bdev: block device of interest
504  * @holder: holder trying to claim @bdev
505  * @hops: holder ops.
506  *
507  * Claim @bdev.  This function fails if @bdev is already claimed by another
508  * holder and waits if another claiming is in progress. return, the caller
509  * has ownership of bd_claiming and bd_holder[s].
510  *
511  * RETURNS:
512  * 0 if @bdev can be claimed, -EBUSY otherwise.
513  */
514 int bd_prepare_to_claim(struct block_device *bdev, void *holder,
515 		const struct blk_holder_ops *hops)
516 {
517 	struct block_device *whole = bdev_whole(bdev);
518 
519 	if (WARN_ON_ONCE(!holder))
520 		return -EINVAL;
521 retry:
522 	mutex_lock(&bdev_lock);
523 	/* if someone else claimed, fail */
524 	if (!bd_may_claim(bdev, holder, hops)) {
525 		mutex_unlock(&bdev_lock);
526 		return -EBUSY;
527 	}
528 
529 	/* if claiming is already in progress, wait for it to finish */
530 	if (whole->bd_claiming) {
531 		wait_queue_head_t *wq = bit_waitqueue(&whole->bd_claiming, 0);
532 		DEFINE_WAIT(wait);
533 
534 		prepare_to_wait(wq, &wait, TASK_UNINTERRUPTIBLE);
535 		mutex_unlock(&bdev_lock);
536 		schedule();
537 		finish_wait(wq, &wait);
538 		goto retry;
539 	}
540 
541 	/* yay, all mine */
542 	whole->bd_claiming = holder;
543 	mutex_unlock(&bdev_lock);
544 	return 0;
545 }
546 EXPORT_SYMBOL_GPL(bd_prepare_to_claim); /* only for the loop driver */
547 
548 static void bd_clear_claiming(struct block_device *whole, void *holder)
549 {
550 	lockdep_assert_held(&bdev_lock);
551 	/* tell others that we're done */
552 	BUG_ON(whole->bd_claiming != holder);
553 	whole->bd_claiming = NULL;
554 	wake_up_bit(&whole->bd_claiming, 0);
555 }
556 
557 /**
558  * bd_finish_claiming - finish claiming of a block device
559  * @bdev: block device of interest
560  * @holder: holder that has claimed @bdev
561  * @hops: block device holder operations
562  *
563  * Finish exclusive open of a block device. Mark the device as exlusively
564  * open by the holder and wake up all waiters for exclusive open to finish.
565  */
566 static void bd_finish_claiming(struct block_device *bdev, void *holder,
567 		const struct blk_holder_ops *hops)
568 {
569 	struct block_device *whole = bdev_whole(bdev);
570 
571 	mutex_lock(&bdev_lock);
572 	BUG_ON(!bd_may_claim(bdev, holder, hops));
573 	/*
574 	 * Note that for a whole device bd_holders will be incremented twice,
575 	 * and bd_holder will be set to bd_may_claim before being set to holder
576 	 */
577 	whole->bd_holders++;
578 	whole->bd_holder = bd_may_claim;
579 	bdev->bd_holders++;
580 	mutex_lock(&bdev->bd_holder_lock);
581 	bdev->bd_holder = holder;
582 	bdev->bd_holder_ops = hops;
583 	mutex_unlock(&bdev->bd_holder_lock);
584 	bd_clear_claiming(whole, holder);
585 	mutex_unlock(&bdev_lock);
586 }
587 
588 /**
589  * bd_abort_claiming - abort claiming of a block device
590  * @bdev: block device of interest
591  * @holder: holder that has claimed @bdev
592  *
593  * Abort claiming of a block device when the exclusive open failed. This can be
594  * also used when exclusive open is not actually desired and we just needed
595  * to block other exclusive openers for a while.
596  */
597 void bd_abort_claiming(struct block_device *bdev, void *holder)
598 {
599 	mutex_lock(&bdev_lock);
600 	bd_clear_claiming(bdev_whole(bdev), holder);
601 	mutex_unlock(&bdev_lock);
602 }
603 EXPORT_SYMBOL(bd_abort_claiming);
604 
605 static void bd_end_claim(struct block_device *bdev, void *holder)
606 {
607 	struct block_device *whole = bdev_whole(bdev);
608 	bool unblock = false;
609 
610 	/*
611 	 * Release a claim on the device.  The holder fields are protected with
612 	 * bdev_lock.  open_mutex is used to synchronize disk_holder unlinking.
613 	 */
614 	mutex_lock(&bdev_lock);
615 	WARN_ON_ONCE(bdev->bd_holder != holder);
616 	WARN_ON_ONCE(--bdev->bd_holders < 0);
617 	WARN_ON_ONCE(--whole->bd_holders < 0);
618 	if (!bdev->bd_holders) {
619 		mutex_lock(&bdev->bd_holder_lock);
620 		bdev->bd_holder = NULL;
621 		bdev->bd_holder_ops = NULL;
622 		mutex_unlock(&bdev->bd_holder_lock);
623 		if (bdev->bd_write_holder)
624 			unblock = true;
625 	}
626 	if (!whole->bd_holders)
627 		whole->bd_holder = NULL;
628 	mutex_unlock(&bdev_lock);
629 
630 	/*
631 	 * If this was the last claim, remove holder link and unblock evpoll if
632 	 * it was a write holder.
633 	 */
634 	if (unblock) {
635 		disk_unblock_events(bdev->bd_disk);
636 		bdev->bd_write_holder = false;
637 	}
638 }
639 
640 static void blkdev_flush_mapping(struct block_device *bdev)
641 {
642 	WARN_ON_ONCE(bdev->bd_holders);
643 	sync_blockdev(bdev);
644 	kill_bdev(bdev);
645 	bdev_write_inode(bdev);
646 }
647 
648 static int blkdev_get_whole(struct block_device *bdev, blk_mode_t mode)
649 {
650 	struct gendisk *disk = bdev->bd_disk;
651 	int ret;
652 
653 	if (disk->fops->open) {
654 		ret = disk->fops->open(disk, mode);
655 		if (ret) {
656 			/* avoid ghost partitions on a removed medium */
657 			if (ret == -ENOMEDIUM &&
658 			     test_bit(GD_NEED_PART_SCAN, &disk->state))
659 				bdev_disk_changed(disk, true);
660 			return ret;
661 		}
662 	}
663 
664 	if (!atomic_read(&bdev->bd_openers))
665 		set_init_blocksize(bdev);
666 	if (test_bit(GD_NEED_PART_SCAN, &disk->state))
667 		bdev_disk_changed(disk, false);
668 	atomic_inc(&bdev->bd_openers);
669 	return 0;
670 }
671 
672 static void blkdev_put_whole(struct block_device *bdev)
673 {
674 	if (atomic_dec_and_test(&bdev->bd_openers))
675 		blkdev_flush_mapping(bdev);
676 	if (bdev->bd_disk->fops->release)
677 		bdev->bd_disk->fops->release(bdev->bd_disk);
678 }
679 
680 static int blkdev_get_part(struct block_device *part, blk_mode_t mode)
681 {
682 	struct gendisk *disk = part->bd_disk;
683 	int ret;
684 
685 	ret = blkdev_get_whole(bdev_whole(part), mode);
686 	if (ret)
687 		return ret;
688 
689 	ret = -ENXIO;
690 	if (!bdev_nr_sectors(part))
691 		goto out_blkdev_put;
692 
693 	if (!atomic_read(&part->bd_openers)) {
694 		disk->open_partitions++;
695 		set_init_blocksize(part);
696 	}
697 	atomic_inc(&part->bd_openers);
698 	return 0;
699 
700 out_blkdev_put:
701 	blkdev_put_whole(bdev_whole(part));
702 	return ret;
703 }
704 
705 int bdev_permission(dev_t dev, blk_mode_t mode, void *holder)
706 {
707 	int ret;
708 
709 	ret = devcgroup_check_permission(DEVCG_DEV_BLOCK,
710 			MAJOR(dev), MINOR(dev),
711 			((mode & BLK_OPEN_READ) ? DEVCG_ACC_READ : 0) |
712 			((mode & BLK_OPEN_WRITE) ? DEVCG_ACC_WRITE : 0));
713 	if (ret)
714 		return ret;
715 
716 	/* Blocking writes requires exclusive opener */
717 	if (mode & BLK_OPEN_RESTRICT_WRITES && !holder)
718 		return -EINVAL;
719 
720 	/*
721 	 * We're using error pointers to indicate to ->release() when we
722 	 * failed to open that block device. Also this doesn't make sense.
723 	 */
724 	if (WARN_ON_ONCE(IS_ERR(holder)))
725 		return -EINVAL;
726 
727 	return 0;
728 }
729 
730 static void blkdev_put_part(struct block_device *part)
731 {
732 	struct block_device *whole = bdev_whole(part);
733 
734 	if (atomic_dec_and_test(&part->bd_openers)) {
735 		blkdev_flush_mapping(part);
736 		whole->bd_disk->open_partitions--;
737 	}
738 	blkdev_put_whole(whole);
739 }
740 
741 struct block_device *blkdev_get_no_open(dev_t dev)
742 {
743 	struct block_device *bdev;
744 	struct inode *inode;
745 
746 	inode = ilookup(blockdev_superblock, dev);
747 	if (!inode && IS_ENABLED(CONFIG_BLOCK_LEGACY_AUTOLOAD)) {
748 		blk_request_module(dev);
749 		inode = ilookup(blockdev_superblock, dev);
750 		if (inode)
751 			pr_warn_ratelimited(
752 "block device autoloading is deprecated and will be removed.\n");
753 	}
754 	if (!inode)
755 		return NULL;
756 
757 	/* switch from the inode reference to a device mode one: */
758 	bdev = &BDEV_I(inode)->bdev;
759 	if (!kobject_get_unless_zero(&bdev->bd_device.kobj))
760 		bdev = NULL;
761 	iput(inode);
762 	return bdev;
763 }
764 
765 void blkdev_put_no_open(struct block_device *bdev)
766 {
767 	put_device(&bdev->bd_device);
768 }
769 
770 static bool bdev_writes_blocked(struct block_device *bdev)
771 {
772 	return bdev->bd_writers == -1;
773 }
774 
775 static void bdev_block_writes(struct block_device *bdev)
776 {
777 	bdev->bd_writers = -1;
778 }
779 
780 static void bdev_unblock_writes(struct block_device *bdev)
781 {
782 	bdev->bd_writers = 0;
783 }
784 
785 static bool bdev_may_open(struct block_device *bdev, blk_mode_t mode)
786 {
787 	if (bdev_allow_write_mounted)
788 		return true;
789 	/* Writes blocked? */
790 	if (mode & BLK_OPEN_WRITE && bdev_writes_blocked(bdev))
791 		return false;
792 	if (mode & BLK_OPEN_RESTRICT_WRITES && bdev->bd_writers > 0)
793 		return false;
794 	return true;
795 }
796 
797 static void bdev_claim_write_access(struct block_device *bdev, blk_mode_t mode)
798 {
799 	if (bdev_allow_write_mounted)
800 		return;
801 
802 	/* Claim exclusive or shared write access. */
803 	if (mode & BLK_OPEN_RESTRICT_WRITES)
804 		bdev_block_writes(bdev);
805 	else if (mode & BLK_OPEN_WRITE)
806 		bdev->bd_writers++;
807 }
808 
809 static void bdev_yield_write_access(struct file *bdev_file)
810 {
811 	struct block_device *bdev;
812 
813 	if (bdev_allow_write_mounted)
814 		return;
815 
816 	bdev = file_bdev(bdev_file);
817 	/* Yield exclusive or shared write access. */
818 	if (bdev_file->f_mode & FMODE_WRITE) {
819 		if (bdev_writes_blocked(bdev))
820 			bdev_unblock_writes(bdev);
821 		else
822 			bdev->bd_writers--;
823 	}
824 }
825 
826 /**
827  * bdev_open - open a block device
828  * @bdev: block device to open
829  * @mode: open mode (BLK_OPEN_*)
830  * @holder: exclusive holder identifier
831  * @hops: holder operations
832  * @bdev_file: file for the block device
833  *
834  * Open the block device. If @holder is not %NULL, the block device is opened
835  * with exclusive access.  Exclusive opens may nest for the same @holder.
836  *
837  * CONTEXT:
838  * Might sleep.
839  *
840  * RETURNS:
841  * zero on success, -errno on failure.
842  */
843 int bdev_open(struct block_device *bdev, blk_mode_t mode, void *holder,
844 	      const struct blk_holder_ops *hops, struct file *bdev_file)
845 {
846 	bool unblock_events = true;
847 	struct gendisk *disk = bdev->bd_disk;
848 	int ret;
849 
850 	if (holder) {
851 		mode |= BLK_OPEN_EXCL;
852 		ret = bd_prepare_to_claim(bdev, holder, hops);
853 		if (ret)
854 			return ret;
855 	} else {
856 		if (WARN_ON_ONCE(mode & BLK_OPEN_EXCL))
857 			return -EIO;
858 	}
859 
860 	disk_block_events(disk);
861 
862 	mutex_lock(&disk->open_mutex);
863 	ret = -ENXIO;
864 	if (!disk_live(disk))
865 		goto abort_claiming;
866 	if (!try_module_get(disk->fops->owner))
867 		goto abort_claiming;
868 	ret = -EBUSY;
869 	if (!bdev_may_open(bdev, mode))
870 		goto abort_claiming;
871 	if (bdev_is_partition(bdev))
872 		ret = blkdev_get_part(bdev, mode);
873 	else
874 		ret = blkdev_get_whole(bdev, mode);
875 	if (ret)
876 		goto put_module;
877 	bdev_claim_write_access(bdev, mode);
878 	if (holder) {
879 		bd_finish_claiming(bdev, holder, hops);
880 
881 		/*
882 		 * Block event polling for write claims if requested.  Any write
883 		 * holder makes the write_holder state stick until all are
884 		 * released.  This is good enough and tracking individual
885 		 * writeable reference is too fragile given the way @mode is
886 		 * used in blkdev_get/put().
887 		 */
888 		if ((mode & BLK_OPEN_WRITE) && !bdev->bd_write_holder &&
889 		    (disk->event_flags & DISK_EVENT_FLAG_BLOCK_ON_EXCL_WRITE)) {
890 			bdev->bd_write_holder = true;
891 			unblock_events = false;
892 		}
893 	}
894 	mutex_unlock(&disk->open_mutex);
895 
896 	if (unblock_events)
897 		disk_unblock_events(disk);
898 
899 	bdev_file->f_flags |= O_LARGEFILE;
900 	bdev_file->f_mode |= FMODE_BUF_RASYNC | FMODE_CAN_ODIRECT;
901 	if (bdev_nowait(bdev))
902 		bdev_file->f_mode |= FMODE_NOWAIT;
903 	bdev_file->f_mapping = bdev->bd_inode->i_mapping;
904 	bdev_file->f_wb_err = filemap_sample_wb_err(bdev_file->f_mapping);
905 	bdev_file->private_data = holder;
906 
907 	return 0;
908 put_module:
909 	module_put(disk->fops->owner);
910 abort_claiming:
911 	if (holder)
912 		bd_abort_claiming(bdev, holder);
913 	mutex_unlock(&disk->open_mutex);
914 	disk_unblock_events(disk);
915 	return ret;
916 }
917 
918 /*
919  * If BLK_OPEN_WRITE_IOCTL is set then this is a historical quirk
920  * associated with the floppy driver where it has allowed ioctls if the
921  * file was opened for writing, but does not allow reads or writes.
922  * Make sure that this quirk is reflected in @f_flags.
923  *
924  * It can also happen if a block device is opened as O_RDWR | O_WRONLY.
925  */
926 static unsigned blk_to_file_flags(blk_mode_t mode)
927 {
928 	unsigned int flags = 0;
929 
930 	if ((mode & (BLK_OPEN_READ | BLK_OPEN_WRITE)) ==
931 	    (BLK_OPEN_READ | BLK_OPEN_WRITE))
932 		flags |= O_RDWR;
933 	else if (mode & BLK_OPEN_WRITE_IOCTL)
934 		flags |= O_RDWR | O_WRONLY;
935 	else if (mode & BLK_OPEN_WRITE)
936 		flags |= O_WRONLY;
937 	else if (mode & BLK_OPEN_READ)
938 		flags |= O_RDONLY; /* homeopathic, because O_RDONLY is 0 */
939 	else
940 		WARN_ON_ONCE(true);
941 
942 	if (mode & BLK_OPEN_NDELAY)
943 		flags |= O_NDELAY;
944 
945 	return flags;
946 }
947 
948 struct file *bdev_file_open_by_dev(dev_t dev, blk_mode_t mode, void *holder,
949 				   const struct blk_holder_ops *hops)
950 {
951 	struct file *bdev_file;
952 	struct block_device *bdev;
953 	unsigned int flags;
954 	int ret;
955 
956 	ret = bdev_permission(dev, mode, holder);
957 	if (ret)
958 		return ERR_PTR(ret);
959 
960 	bdev = blkdev_get_no_open(dev);
961 	if (!bdev)
962 		return ERR_PTR(-ENXIO);
963 
964 	flags = blk_to_file_flags(mode);
965 	bdev_file = alloc_file_pseudo_noaccount(bdev->bd_inode,
966 			blockdev_mnt, "", flags | O_LARGEFILE, &def_blk_fops);
967 	if (IS_ERR(bdev_file)) {
968 		blkdev_put_no_open(bdev);
969 		return bdev_file;
970 	}
971 	ihold(bdev->bd_inode);
972 
973 	ret = bdev_open(bdev, mode, holder, hops, bdev_file);
974 	if (ret) {
975 		/* We failed to open the block device. Let ->release() know. */
976 		bdev_file->private_data = ERR_PTR(ret);
977 		fput(bdev_file);
978 		return ERR_PTR(ret);
979 	}
980 	return bdev_file;
981 }
982 EXPORT_SYMBOL(bdev_file_open_by_dev);
983 
984 struct file *bdev_file_open_by_path(const char *path, blk_mode_t mode,
985 				    void *holder,
986 				    const struct blk_holder_ops *hops)
987 {
988 	struct file *file;
989 	dev_t dev;
990 	int error;
991 
992 	error = lookup_bdev(path, &dev);
993 	if (error)
994 		return ERR_PTR(error);
995 
996 	file = bdev_file_open_by_dev(dev, mode, holder, hops);
997 	if (!IS_ERR(file) && (mode & BLK_OPEN_WRITE)) {
998 		if (bdev_read_only(file_bdev(file))) {
999 			fput(file);
1000 			file = ERR_PTR(-EACCES);
1001 		}
1002 	}
1003 
1004 	return file;
1005 }
1006 EXPORT_SYMBOL(bdev_file_open_by_path);
1007 
1008 void bdev_release(struct file *bdev_file)
1009 {
1010 	struct block_device *bdev = file_bdev(bdev_file);
1011 	void *holder = bdev_file->private_data;
1012 	struct gendisk *disk = bdev->bd_disk;
1013 
1014 	/* We failed to open that block device. */
1015 	if (IS_ERR(holder))
1016 		goto put_no_open;
1017 
1018 	/*
1019 	 * Sync early if it looks like we're the last one.  If someone else
1020 	 * opens the block device between now and the decrement of bd_openers
1021 	 * then we did a sync that we didn't need to, but that's not the end
1022 	 * of the world and we want to avoid long (could be several minute)
1023 	 * syncs while holding the mutex.
1024 	 */
1025 	if (atomic_read(&bdev->bd_openers) == 1)
1026 		sync_blockdev(bdev);
1027 
1028 	mutex_lock(&disk->open_mutex);
1029 	bdev_yield_write_access(bdev_file);
1030 
1031 	if (holder)
1032 		bd_end_claim(bdev, holder);
1033 
1034 	/*
1035 	 * Trigger event checking and tell drivers to flush MEDIA_CHANGE
1036 	 * event.  This is to ensure detection of media removal commanded
1037 	 * from userland - e.g. eject(1).
1038 	 */
1039 	disk_flush_events(disk, DISK_EVENT_MEDIA_CHANGE);
1040 
1041 	if (bdev_is_partition(bdev))
1042 		blkdev_put_part(bdev);
1043 	else
1044 		blkdev_put_whole(bdev);
1045 	mutex_unlock(&disk->open_mutex);
1046 
1047 	module_put(disk->fops->owner);
1048 put_no_open:
1049 	blkdev_put_no_open(bdev);
1050 }
1051 
1052 /**
1053  * lookup_bdev() - Look up a struct block_device by name.
1054  * @pathname: Name of the block device in the filesystem.
1055  * @dev: Pointer to the block device's dev_t, if found.
1056  *
1057  * Lookup the block device's dev_t at @pathname in the current
1058  * namespace if possible and return it in @dev.
1059  *
1060  * Context: May sleep.
1061  * Return: 0 if succeeded, negative errno otherwise.
1062  */
1063 int lookup_bdev(const char *pathname, dev_t *dev)
1064 {
1065 	struct inode *inode;
1066 	struct path path;
1067 	int error;
1068 
1069 	if (!pathname || !*pathname)
1070 		return -EINVAL;
1071 
1072 	error = kern_path(pathname, LOOKUP_FOLLOW, &path);
1073 	if (error)
1074 		return error;
1075 
1076 	inode = d_backing_inode(path.dentry);
1077 	error = -ENOTBLK;
1078 	if (!S_ISBLK(inode->i_mode))
1079 		goto out_path_put;
1080 	error = -EACCES;
1081 	if (!may_open_dev(&path))
1082 		goto out_path_put;
1083 
1084 	*dev = inode->i_rdev;
1085 	error = 0;
1086 out_path_put:
1087 	path_put(&path);
1088 	return error;
1089 }
1090 EXPORT_SYMBOL(lookup_bdev);
1091 
1092 /**
1093  * bdev_mark_dead - mark a block device as dead
1094  * @bdev: block device to operate on
1095  * @surprise: indicate a surprise removal
1096  *
1097  * Tell the file system that this devices or media is dead.  If @surprise is set
1098  * to %true the device or media is already gone, if not we are preparing for an
1099  * orderly removal.
1100  *
1101  * This calls into the file system, which then typicall syncs out all dirty data
1102  * and writes back inodes and then invalidates any cached data in the inodes on
1103  * the file system.  In addition we also invalidate the block device mapping.
1104  */
1105 void bdev_mark_dead(struct block_device *bdev, bool surprise)
1106 {
1107 	mutex_lock(&bdev->bd_holder_lock);
1108 	if (bdev->bd_holder_ops && bdev->bd_holder_ops->mark_dead)
1109 		bdev->bd_holder_ops->mark_dead(bdev, surprise);
1110 	else {
1111 		mutex_unlock(&bdev->bd_holder_lock);
1112 		sync_blockdev(bdev);
1113 	}
1114 
1115 	invalidate_bdev(bdev);
1116 }
1117 /*
1118  * New drivers should not use this directly.  There are some drivers however
1119  * that needs this for historical reasons. For example, the DASD driver has
1120  * historically had a shutdown to offline mode that doesn't actually remove the
1121  * gendisk that otherwise looks a lot like a safe device removal.
1122  */
1123 EXPORT_SYMBOL_GPL(bdev_mark_dead);
1124 
1125 void sync_bdevs(bool wait)
1126 {
1127 	struct inode *inode, *old_inode = NULL;
1128 
1129 	spin_lock(&blockdev_superblock->s_inode_list_lock);
1130 	list_for_each_entry(inode, &blockdev_superblock->s_inodes, i_sb_list) {
1131 		struct address_space *mapping = inode->i_mapping;
1132 		struct block_device *bdev;
1133 
1134 		spin_lock(&inode->i_lock);
1135 		if (inode->i_state & (I_FREEING|I_WILL_FREE|I_NEW) ||
1136 		    mapping->nrpages == 0) {
1137 			spin_unlock(&inode->i_lock);
1138 			continue;
1139 		}
1140 		__iget(inode);
1141 		spin_unlock(&inode->i_lock);
1142 		spin_unlock(&blockdev_superblock->s_inode_list_lock);
1143 		/*
1144 		 * We hold a reference to 'inode' so it couldn't have been
1145 		 * removed from s_inodes list while we dropped the
1146 		 * s_inode_list_lock  We cannot iput the inode now as we can
1147 		 * be holding the last reference and we cannot iput it under
1148 		 * s_inode_list_lock. So we keep the reference and iput it
1149 		 * later.
1150 		 */
1151 		iput(old_inode);
1152 		old_inode = inode;
1153 		bdev = I_BDEV(inode);
1154 
1155 		mutex_lock(&bdev->bd_disk->open_mutex);
1156 		if (!atomic_read(&bdev->bd_openers)) {
1157 			; /* skip */
1158 		} else if (wait) {
1159 			/*
1160 			 * We keep the error status of individual mapping so
1161 			 * that applications can catch the writeback error using
1162 			 * fsync(2). See filemap_fdatawait_keep_errors() for
1163 			 * details.
1164 			 */
1165 			filemap_fdatawait_keep_errors(inode->i_mapping);
1166 		} else {
1167 			filemap_fdatawrite(inode->i_mapping);
1168 		}
1169 		mutex_unlock(&bdev->bd_disk->open_mutex);
1170 
1171 		spin_lock(&blockdev_superblock->s_inode_list_lock);
1172 	}
1173 	spin_unlock(&blockdev_superblock->s_inode_list_lock);
1174 	iput(old_inode);
1175 }
1176 
1177 /*
1178  * Handle STATX_DIOALIGN for block devices.
1179  *
1180  * Note that the inode passed to this is the inode of a block device node file,
1181  * not the block device's internal inode.  Therefore it is *not* valid to use
1182  * I_BDEV() here; the block device has to be looked up by i_rdev instead.
1183  */
1184 void bdev_statx_dioalign(struct inode *inode, struct kstat *stat)
1185 {
1186 	struct block_device *bdev;
1187 
1188 	bdev = blkdev_get_no_open(inode->i_rdev);
1189 	if (!bdev)
1190 		return;
1191 
1192 	stat->dio_mem_align = bdev_dma_alignment(bdev) + 1;
1193 	stat->dio_offset_align = bdev_logical_block_size(bdev);
1194 	stat->result_mask |= STATX_DIOALIGN;
1195 
1196 	blkdev_put_no_open(bdev);
1197 }
1198 
1199 static int __init setup_bdev_allow_write_mounted(char *str)
1200 {
1201 	if (kstrtobool(str, &bdev_allow_write_mounted))
1202 		pr_warn("Invalid option string for bdev_allow_write_mounted:"
1203 			" '%s'\n", str);
1204 	return 1;
1205 }
1206 __setup("bdev_allow_write_mounted=", setup_bdev_allow_write_mounted);
1207