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
7 #include <linux/init.h>
9 #include <linux/blkdev.h>
10 #include <linux/buffer_head.h>
11 #include <linux/mpage.h>
12 #include <linux/uio.h>
13 #include <linux/namei.h>
14 #include <linux/task_io_accounting_ops.h>
15 #include <linux/falloc.h>
16 #include <linux/suspend.h>
18 #include <linux/module.h>
21 static inline struct inode *bdev_file_inode(struct file *file)
23 return file->f_mapping->host;
26 static int blkdev_get_block(struct inode *inode, sector_t iblock,
27 struct buffer_head *bh, int create)
29 bh->b_bdev = I_BDEV(inode);
30 bh->b_blocknr = iblock;
31 set_buffer_mapped(bh);
35 static unsigned int dio_bio_write_op(struct kiocb *iocb)
37 unsigned int op = REQ_OP_WRITE | REQ_SYNC | REQ_IDLE;
39 /* avoid the need for a I/O completion work item */
40 if (iocb->ki_flags & IOCB_DSYNC)
45 #define DIO_INLINE_BIO_VECS 4
47 static void blkdev_bio_end_io_simple(struct bio *bio)
49 struct task_struct *waiter = bio->bi_private;
51 WRITE_ONCE(bio->bi_private, NULL);
52 blk_wake_io_task(waiter);
55 static ssize_t __blkdev_direct_IO_simple(struct kiocb *iocb,
56 struct iov_iter *iter, unsigned int nr_pages)
58 struct block_device *bdev = iocb->ki_filp->private_data;
59 struct bio_vec inline_vecs[DIO_INLINE_BIO_VECS], *vecs;
60 loff_t pos = iocb->ki_pos;
61 bool should_dirty = false;
65 if ((pos | iov_iter_alignment(iter)) &
66 (bdev_logical_block_size(bdev) - 1))
69 if (nr_pages <= DIO_INLINE_BIO_VECS)
72 vecs = kmalloc_array(nr_pages, sizeof(struct bio_vec),
78 if (iov_iter_rw(iter) == READ) {
79 bio_init(&bio, bdev, vecs, nr_pages, REQ_OP_READ);
80 if (iter_is_iovec(iter))
83 bio_init(&bio, bdev, vecs, nr_pages, dio_bio_write_op(iocb));
85 bio.bi_iter.bi_sector = pos >> SECTOR_SHIFT;
86 bio.bi_private = current;
87 bio.bi_end_io = blkdev_bio_end_io_simple;
88 bio.bi_ioprio = iocb->ki_ioprio;
90 ret = bio_iov_iter_get_pages(&bio, iter);
93 ret = bio.bi_iter.bi_size;
95 if (iov_iter_rw(iter) == WRITE)
96 task_io_account_write(ret);
98 if (iocb->ki_flags & IOCB_NOWAIT)
99 bio.bi_opf |= REQ_NOWAIT;
100 if (iocb->ki_flags & IOCB_HIPRI)
101 bio_set_polled(&bio, iocb);
105 set_current_state(TASK_UNINTERRUPTIBLE);
106 if (!READ_ONCE(bio.bi_private))
108 if (!(iocb->ki_flags & IOCB_HIPRI) || !bio_poll(&bio, NULL, 0))
111 __set_current_state(TASK_RUNNING);
113 bio_release_pages(&bio, should_dirty);
114 if (unlikely(bio.bi_status))
115 ret = blk_status_to_errno(bio.bi_status);
118 if (vecs != inline_vecs)
127 DIO_SHOULD_DIRTY = 1,
134 struct task_struct *waiter;
139 struct bio bio ____cacheline_aligned_in_smp;
142 static struct bio_set blkdev_dio_pool;
144 static void blkdev_bio_end_io(struct bio *bio)
146 struct blkdev_dio *dio = bio->bi_private;
147 bool should_dirty = dio->flags & DIO_SHOULD_DIRTY;
149 if (bio->bi_status && !dio->bio.bi_status)
150 dio->bio.bi_status = bio->bi_status;
152 if (atomic_dec_and_test(&dio->ref)) {
153 if (!(dio->flags & DIO_IS_SYNC)) {
154 struct kiocb *iocb = dio->iocb;
157 WRITE_ONCE(iocb->private, NULL);
159 if (likely(!dio->bio.bi_status)) {
163 ret = blk_status_to_errno(dio->bio.bi_status);
166 dio->iocb->ki_complete(iocb, ret);
169 struct task_struct *waiter = dio->waiter;
171 WRITE_ONCE(dio->waiter, NULL);
172 blk_wake_io_task(waiter);
177 bio_check_pages_dirty(bio);
179 bio_release_pages(bio, false);
184 static ssize_t __blkdev_direct_IO(struct kiocb *iocb, struct iov_iter *iter,
185 unsigned int nr_pages)
187 struct block_device *bdev = iocb->ki_filp->private_data;
188 struct blk_plug plug;
189 struct blkdev_dio *dio;
191 bool is_read = (iov_iter_rw(iter) == READ), is_sync;
192 unsigned int opf = is_read ? REQ_OP_READ : dio_bio_write_op(iocb);
193 loff_t pos = iocb->ki_pos;
196 if ((pos | iov_iter_alignment(iter)) &
197 (bdev_logical_block_size(bdev) - 1))
200 bio = bio_alloc_kiocb(iocb, bdev, nr_pages, opf, &blkdev_dio_pool);
202 dio = container_of(bio, struct blkdev_dio, bio);
203 atomic_set(&dio->ref, 1);
205 * Grab an extra reference to ensure the dio structure which is embedded
206 * into the first bio stays around.
210 is_sync = is_sync_kiocb(iocb);
212 dio->flags = DIO_IS_SYNC;
213 dio->waiter = current;
220 if (is_read && iter_is_iovec(iter))
221 dio->flags |= DIO_SHOULD_DIRTY;
223 blk_start_plug(&plug);
226 bio->bi_iter.bi_sector = pos >> SECTOR_SHIFT;
227 bio->bi_private = dio;
228 bio->bi_end_io = blkdev_bio_end_io;
229 bio->bi_ioprio = iocb->ki_ioprio;
231 ret = bio_iov_iter_get_pages(bio, iter);
233 bio->bi_status = BLK_STS_IOERR;
239 if (dio->flags & DIO_SHOULD_DIRTY)
240 bio_set_pages_dirty(bio);
242 task_io_account_write(bio->bi_iter.bi_size);
244 if (iocb->ki_flags & IOCB_NOWAIT)
245 bio->bi_opf |= REQ_NOWAIT;
247 dio->size += bio->bi_iter.bi_size;
248 pos += bio->bi_iter.bi_size;
250 nr_pages = bio_iov_vecs_to_alloc(iter, BIO_MAX_VECS);
255 atomic_inc(&dio->ref);
257 bio = bio_alloc(bdev, nr_pages, opf, GFP_KERNEL);
260 blk_finish_plug(&plug);
266 set_current_state(TASK_UNINTERRUPTIBLE);
267 if (!READ_ONCE(dio->waiter))
271 __set_current_state(TASK_RUNNING);
274 ret = blk_status_to_errno(dio->bio.bi_status);
282 static void blkdev_bio_end_io_async(struct bio *bio)
284 struct blkdev_dio *dio = container_of(bio, struct blkdev_dio, bio);
285 struct kiocb *iocb = dio->iocb;
288 WRITE_ONCE(iocb->private, NULL);
290 if (likely(!bio->bi_status)) {
294 ret = blk_status_to_errno(bio->bi_status);
297 iocb->ki_complete(iocb, ret);
299 if (dio->flags & DIO_SHOULD_DIRTY) {
300 bio_check_pages_dirty(bio);
302 bio_release_pages(bio, false);
307 static ssize_t __blkdev_direct_IO_async(struct kiocb *iocb,
308 struct iov_iter *iter,
309 unsigned int nr_pages)
311 struct block_device *bdev = iocb->ki_filp->private_data;
312 bool is_read = iov_iter_rw(iter) == READ;
313 unsigned int opf = is_read ? REQ_OP_READ : dio_bio_write_op(iocb);
314 struct blkdev_dio *dio;
316 loff_t pos = iocb->ki_pos;
319 if ((pos | iov_iter_alignment(iter)) &
320 (bdev_logical_block_size(bdev) - 1))
323 bio = bio_alloc_kiocb(iocb, bdev, nr_pages, opf, &blkdev_dio_pool);
324 dio = container_of(bio, struct blkdev_dio, bio);
327 bio->bi_iter.bi_sector = pos >> SECTOR_SHIFT;
328 bio->bi_end_io = blkdev_bio_end_io_async;
329 bio->bi_ioprio = iocb->ki_ioprio;
331 if (iov_iter_is_bvec(iter)) {
333 * Users don't rely on the iterator being in any particular
334 * state for async I/O returning -EIOCBQUEUED, hence we can
335 * avoid expensive iov_iter_advance(). Bypass
336 * bio_iov_iter_get_pages() and set the bvec directly.
338 bio_iov_bvec_set(bio, iter);
340 ret = bio_iov_iter_get_pages(bio, iter);
346 dio->size = bio->bi_iter.bi_size;
349 if (iter_is_iovec(iter)) {
350 dio->flags |= DIO_SHOULD_DIRTY;
351 bio_set_pages_dirty(bio);
354 task_io_account_write(bio->bi_iter.bi_size);
357 if (iocb->ki_flags & IOCB_HIPRI) {
358 bio->bi_opf |= REQ_POLLED | REQ_NOWAIT;
360 WRITE_ONCE(iocb->private, bio);
362 if (iocb->ki_flags & IOCB_NOWAIT)
363 bio->bi_opf |= REQ_NOWAIT;
369 static ssize_t blkdev_direct_IO(struct kiocb *iocb, struct iov_iter *iter)
371 unsigned int nr_pages;
373 if (!iov_iter_count(iter))
376 nr_pages = bio_iov_vecs_to_alloc(iter, BIO_MAX_VECS + 1);
377 if (likely(nr_pages <= BIO_MAX_VECS)) {
378 if (is_sync_kiocb(iocb))
379 return __blkdev_direct_IO_simple(iocb, iter, nr_pages);
380 return __blkdev_direct_IO_async(iocb, iter, nr_pages);
382 return __blkdev_direct_IO(iocb, iter, bio_max_segs(nr_pages));
385 static int blkdev_writepage(struct page *page, struct writeback_control *wbc)
387 return block_write_full_page(page, blkdev_get_block, wbc);
390 static int blkdev_read_folio(struct file *file, struct folio *folio)
392 return block_read_full_folio(folio, blkdev_get_block);
395 static void blkdev_readahead(struct readahead_control *rac)
397 mpage_readahead(rac, blkdev_get_block);
400 static int blkdev_write_begin(struct file *file, struct address_space *mapping,
401 loff_t pos, unsigned len, struct page **pagep, void **fsdata)
403 return block_write_begin(mapping, pos, len, pagep, blkdev_get_block);
406 static int blkdev_write_end(struct file *file, struct address_space *mapping,
407 loff_t pos, unsigned len, unsigned copied, struct page *page,
411 ret = block_write_end(file, mapping, pos, len, copied, page, fsdata);
419 static int blkdev_writepages(struct address_space *mapping,
420 struct writeback_control *wbc)
422 return generic_writepages(mapping, wbc);
425 const struct address_space_operations def_blk_aops = {
426 .dirty_folio = block_dirty_folio,
427 .invalidate_folio = block_invalidate_folio,
428 .read_folio = blkdev_read_folio,
429 .readahead = blkdev_readahead,
430 .writepage = blkdev_writepage,
431 .write_begin = blkdev_write_begin,
432 .write_end = blkdev_write_end,
433 .writepages = blkdev_writepages,
434 .direct_IO = blkdev_direct_IO,
435 .migratepage = buffer_migrate_page_norefs,
436 .is_dirty_writeback = buffer_check_dirty_writeback,
440 * for a block special file file_inode(file)->i_size is zero
441 * so we compute the size by hand (just as in block_read/write above)
443 static loff_t blkdev_llseek(struct file *file, loff_t offset, int whence)
445 struct inode *bd_inode = bdev_file_inode(file);
448 inode_lock(bd_inode);
449 retval = fixed_size_llseek(file, offset, whence, i_size_read(bd_inode));
450 inode_unlock(bd_inode);
454 static int blkdev_fsync(struct file *filp, loff_t start, loff_t end,
457 struct block_device *bdev = filp->private_data;
460 error = file_write_and_wait_range(filp, start, end);
465 * There is no need to serialise calls to blkdev_issue_flush with
466 * i_mutex and doing so causes performance issues with concurrent
467 * O_SYNC writers to a block device.
469 error = blkdev_issue_flush(bdev);
470 if (error == -EOPNOTSUPP)
476 static int blkdev_open(struct inode *inode, struct file *filp)
478 struct block_device *bdev;
481 * Preserve backwards compatibility and allow large file access
482 * even if userspace doesn't ask for it explicitly. Some mkfs
483 * binary needs it. We might want to drop this workaround
484 * during an unstable branch.
486 filp->f_flags |= O_LARGEFILE;
487 filp->f_mode |= FMODE_NOWAIT | FMODE_BUF_RASYNC;
489 if (filp->f_flags & O_NDELAY)
490 filp->f_mode |= FMODE_NDELAY;
491 if (filp->f_flags & O_EXCL)
492 filp->f_mode |= FMODE_EXCL;
493 if ((filp->f_flags & O_ACCMODE) == 3)
494 filp->f_mode |= FMODE_WRITE_IOCTL;
496 bdev = blkdev_get_by_dev(inode->i_rdev, filp->f_mode, filp);
498 return PTR_ERR(bdev);
500 filp->private_data = bdev;
501 filp->f_mapping = bdev->bd_inode->i_mapping;
502 filp->f_wb_err = filemap_sample_wb_err(filp->f_mapping);
506 static int blkdev_close(struct inode *inode, struct file *filp)
508 struct block_device *bdev = filp->private_data;
510 blkdev_put(bdev, filp->f_mode);
515 * Write data to the block device. Only intended for the block device itself
516 * and the raw driver which basically is a fake block device.
518 * Does not take i_mutex for the write and thus is not for general purpose
521 static ssize_t blkdev_write_iter(struct kiocb *iocb, struct iov_iter *from)
523 struct block_device *bdev = iocb->ki_filp->private_data;
524 struct inode *bd_inode = bdev->bd_inode;
525 loff_t size = bdev_nr_bytes(bdev);
526 struct blk_plug plug;
530 if (bdev_read_only(bdev))
533 if (IS_SWAPFILE(bd_inode) && !is_hibernate_resume_dev(bd_inode->i_rdev))
536 if (!iov_iter_count(from))
539 if (iocb->ki_pos >= size)
542 if ((iocb->ki_flags & (IOCB_NOWAIT | IOCB_DIRECT)) == IOCB_NOWAIT)
545 size -= iocb->ki_pos;
546 if (iov_iter_count(from) > size) {
547 shorted = iov_iter_count(from) - size;
548 iov_iter_truncate(from, size);
551 blk_start_plug(&plug);
552 ret = __generic_file_write_iter(iocb, from);
554 ret = generic_write_sync(iocb, ret);
555 iov_iter_reexpand(from, iov_iter_count(from) + shorted);
556 blk_finish_plug(&plug);
560 static ssize_t blkdev_read_iter(struct kiocb *iocb, struct iov_iter *to)
562 struct block_device *bdev = iocb->ki_filp->private_data;
563 loff_t size = bdev_nr_bytes(bdev);
564 loff_t pos = iocb->ki_pos;
569 if (unlikely(pos + iov_iter_count(to) > size)) {
573 shorted = iov_iter_count(to) - size;
574 iov_iter_truncate(to, size);
577 count = iov_iter_count(to);
579 goto reexpand; /* skip atime */
581 if (iocb->ki_flags & IOCB_DIRECT) {
582 struct address_space *mapping = iocb->ki_filp->f_mapping;
584 if (iocb->ki_flags & IOCB_NOWAIT) {
585 if (filemap_range_needs_writeback(mapping, pos,
591 ret = filemap_write_and_wait_range(mapping, pos,
597 file_accessed(iocb->ki_filp);
599 ret = blkdev_direct_IO(iocb, to);
604 iov_iter_revert(to, count - iov_iter_count(to));
605 if (ret < 0 || !count)
609 ret = filemap_read(iocb, to, ret);
612 if (unlikely(shorted))
613 iov_iter_reexpand(to, iov_iter_count(to) + shorted);
617 #define BLKDEV_FALLOC_FL_SUPPORTED \
618 (FALLOC_FL_KEEP_SIZE | FALLOC_FL_PUNCH_HOLE | \
619 FALLOC_FL_ZERO_RANGE | FALLOC_FL_NO_HIDE_STALE)
621 static long blkdev_fallocate(struct file *file, int mode, loff_t start,
624 struct inode *inode = bdev_file_inode(file);
625 struct block_device *bdev = I_BDEV(inode);
626 loff_t end = start + len - 1;
630 /* Fail if we don't recognize the flags. */
631 if (mode & ~BLKDEV_FALLOC_FL_SUPPORTED)
634 /* Don't go off the end of the device. */
635 isize = bdev_nr_bytes(bdev);
639 if (mode & FALLOC_FL_KEEP_SIZE) {
641 end = start + len - 1;
647 * Don't allow IO that isn't aligned to logical block size.
649 if ((start | len) & (bdev_logical_block_size(bdev) - 1))
652 filemap_invalidate_lock(inode->i_mapping);
654 /* Invalidate the page cache, including dirty pages. */
655 error = truncate_bdev_range(bdev, file->f_mode, start, end);
660 case FALLOC_FL_ZERO_RANGE:
661 case FALLOC_FL_ZERO_RANGE | FALLOC_FL_KEEP_SIZE:
662 error = blkdev_issue_zeroout(bdev, start >> SECTOR_SHIFT,
663 len >> SECTOR_SHIFT, GFP_KERNEL,
664 BLKDEV_ZERO_NOUNMAP);
666 case FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE:
667 error = blkdev_issue_zeroout(bdev, start >> SECTOR_SHIFT,
668 len >> SECTOR_SHIFT, GFP_KERNEL,
669 BLKDEV_ZERO_NOFALLBACK);
671 case FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE | FALLOC_FL_NO_HIDE_STALE:
672 error = blkdev_issue_discard(bdev, start >> SECTOR_SHIFT,
673 len >> SECTOR_SHIFT, GFP_KERNEL, 0);
680 filemap_invalidate_unlock(inode->i_mapping);
684 const struct file_operations def_blk_fops = {
686 .release = blkdev_close,
687 .llseek = blkdev_llseek,
688 .read_iter = blkdev_read_iter,
689 .write_iter = blkdev_write_iter,
690 .iopoll = iocb_bio_iopoll,
691 .mmap = generic_file_mmap,
692 .fsync = blkdev_fsync,
693 .unlocked_ioctl = blkdev_ioctl,
695 .compat_ioctl = compat_blkdev_ioctl,
697 .splice_read = generic_file_splice_read,
698 .splice_write = iter_file_splice_write,
699 .fallocate = blkdev_fallocate,
702 static __init int blkdev_init(void)
704 return bioset_init(&blkdev_dio_pool, 4,
705 offsetof(struct blkdev_dio, bio),
706 BIOSET_NEED_BVECS|BIOSET_PERCPU_CACHE);
708 module_init(blkdev_init);