1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (C) 1991, 1992 Linus Torvalds
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>
20 static inline struct inode *bdev_file_inode(struct file *file)
22 return file->f_mapping->host;
25 static int blkdev_get_block(struct inode *inode, sector_t iblock,
26 struct buffer_head *bh, int create)
28 bh->b_bdev = I_BDEV(inode);
29 bh->b_blocknr = iblock;
30 set_buffer_mapped(bh);
34 static unsigned int dio_bio_write_op(struct kiocb *iocb)
36 unsigned int op = REQ_OP_WRITE | REQ_SYNC | REQ_IDLE;
38 /* avoid the need for a I/O completion work item */
39 if (iocb->ki_flags & IOCB_DSYNC)
44 #define DIO_INLINE_BIO_VECS 4
46 static void blkdev_bio_end_io_simple(struct bio *bio)
48 struct task_struct *waiter = bio->bi_private;
50 WRITE_ONCE(bio->bi_private, NULL);
51 blk_wake_io_task(waiter);
54 static ssize_t __blkdev_direct_IO_simple(struct kiocb *iocb,
55 struct iov_iter *iter, unsigned int nr_pages)
57 struct block_device *bdev = iocb->ki_filp->private_data;
58 struct bio_vec inline_vecs[DIO_INLINE_BIO_VECS], *vecs;
59 loff_t pos = iocb->ki_pos;
60 bool should_dirty = false;
64 if ((pos | iov_iter_alignment(iter)) &
65 (bdev_logical_block_size(bdev) - 1))
68 if (nr_pages <= DIO_INLINE_BIO_VECS)
71 vecs = kmalloc_array(nr_pages, sizeof(struct bio_vec),
77 bio_init(&bio, vecs, nr_pages);
78 bio_set_dev(&bio, bdev);
79 bio.bi_iter.bi_sector = pos >> SECTOR_SHIFT;
80 bio.bi_write_hint = iocb->ki_hint;
81 bio.bi_private = current;
82 bio.bi_end_io = blkdev_bio_end_io_simple;
83 bio.bi_ioprio = iocb->ki_ioprio;
85 ret = bio_iov_iter_get_pages(&bio, iter);
88 ret = bio.bi_iter.bi_size;
90 if (iov_iter_rw(iter) == READ) {
91 bio.bi_opf = REQ_OP_READ;
92 if (iter_is_iovec(iter))
95 bio.bi_opf = dio_bio_write_op(iocb);
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 loff_t pos = iocb->ki_pos;
195 if ((pos | iov_iter_alignment(iter)) &
196 (bdev_logical_block_size(bdev) - 1))
199 bio = bio_alloc_kiocb(iocb, nr_pages, &blkdev_dio_pool);
201 dio = container_of(bio, struct blkdev_dio, bio);
202 atomic_set(&dio->ref, 1);
204 * Grab an extra reference to ensure the dio structure which is embedded
205 * into the first bio stays around.
209 is_sync = is_sync_kiocb(iocb);
211 dio->flags = DIO_IS_SYNC;
212 dio->waiter = current;
219 if (is_read && iter_is_iovec(iter))
220 dio->flags |= DIO_SHOULD_DIRTY;
222 blk_start_plug(&plug);
225 bio_set_dev(bio, bdev);
226 bio->bi_iter.bi_sector = pos >> SECTOR_SHIFT;
227 bio->bi_write_hint = iocb->ki_hint;
228 bio->bi_private = dio;
229 bio->bi_end_io = blkdev_bio_end_io;
230 bio->bi_ioprio = iocb->ki_ioprio;
232 ret = bio_iov_iter_get_pages(bio, iter);
234 bio->bi_status = BLK_STS_IOERR;
240 bio->bi_opf = REQ_OP_READ;
241 if (dio->flags & DIO_SHOULD_DIRTY)
242 bio_set_pages_dirty(bio);
244 bio->bi_opf = dio_bio_write_op(iocb);
245 task_io_account_write(bio->bi_iter.bi_size);
247 if (iocb->ki_flags & IOCB_NOWAIT)
248 bio->bi_opf |= REQ_NOWAIT;
250 dio->size += bio->bi_iter.bi_size;
251 pos += bio->bi_iter.bi_size;
253 nr_pages = bio_iov_vecs_to_alloc(iter, BIO_MAX_VECS);
258 atomic_inc(&dio->ref);
260 bio = bio_alloc(GFP_KERNEL, nr_pages);
263 blk_finish_plug(&plug);
269 set_current_state(TASK_UNINTERRUPTIBLE);
270 if (!READ_ONCE(dio->waiter))
274 __set_current_state(TASK_RUNNING);
277 ret = blk_status_to_errno(dio->bio.bi_status);
285 static void blkdev_bio_end_io_async(struct bio *bio)
287 struct blkdev_dio *dio = container_of(bio, struct blkdev_dio, bio);
288 struct kiocb *iocb = dio->iocb;
291 if (likely(!bio->bi_status)) {
295 ret = blk_status_to_errno(bio->bi_status);
298 iocb->ki_complete(iocb, ret);
300 if (dio->flags & DIO_SHOULD_DIRTY) {
301 bio_check_pages_dirty(bio);
303 bio_release_pages(bio, false);
308 static ssize_t __blkdev_direct_IO_async(struct kiocb *iocb,
309 struct iov_iter *iter,
310 unsigned int nr_pages)
312 struct block_device *bdev = iocb->ki_filp->private_data;
313 struct blkdev_dio *dio;
315 loff_t pos = iocb->ki_pos;
318 if ((pos | iov_iter_alignment(iter)) &
319 (bdev_logical_block_size(bdev) - 1))
322 bio = bio_alloc_kiocb(iocb, nr_pages, &blkdev_dio_pool);
323 dio = container_of(bio, struct blkdev_dio, bio);
326 bio_set_dev(bio, bdev);
327 bio->bi_iter.bi_sector = pos >> SECTOR_SHIFT;
328 bio->bi_write_hint = iocb->ki_hint;
329 bio->bi_end_io = blkdev_bio_end_io_async;
330 bio->bi_ioprio = iocb->ki_ioprio;
332 if (iov_iter_is_bvec(iter)) {
334 * Users don't rely on the iterator being in any particular
335 * state for async I/O returning -EIOCBQUEUED, hence we can
336 * avoid expensive iov_iter_advance(). Bypass
337 * bio_iov_iter_get_pages() and set the bvec directly.
339 bio_iov_bvec_set(bio, iter);
341 ret = bio_iov_iter_get_pages(bio, iter);
343 bio->bi_status = BLK_STS_IOERR;
348 dio->size = bio->bi_iter.bi_size;
350 if (iov_iter_rw(iter) == READ) {
351 bio->bi_opf = REQ_OP_READ;
352 if (iter_is_iovec(iter)) {
353 dio->flags |= DIO_SHOULD_DIRTY;
354 bio_set_pages_dirty(bio);
357 bio->bi_opf = dio_bio_write_op(iocb);
358 task_io_account_write(bio->bi_iter.bi_size);
361 if (iocb->ki_flags & IOCB_HIPRI) {
362 bio->bi_opf |= REQ_POLLED | REQ_NOWAIT;
364 WRITE_ONCE(iocb->private, bio);
366 if (iocb->ki_flags & IOCB_NOWAIT)
367 bio->bi_opf |= REQ_NOWAIT;
373 static ssize_t blkdev_direct_IO(struct kiocb *iocb, struct iov_iter *iter)
375 unsigned int nr_pages;
377 if (!iov_iter_count(iter))
380 nr_pages = bio_iov_vecs_to_alloc(iter, BIO_MAX_VECS + 1);
381 if (likely(nr_pages <= BIO_MAX_VECS)) {
382 if (is_sync_kiocb(iocb))
383 return __blkdev_direct_IO_simple(iocb, iter, nr_pages);
384 return __blkdev_direct_IO_async(iocb, iter, nr_pages);
386 return __blkdev_direct_IO(iocb, iter, bio_max_segs(nr_pages));
389 static int blkdev_writepage(struct page *page, struct writeback_control *wbc)
391 return block_write_full_page(page, blkdev_get_block, wbc);
394 static int blkdev_readpage(struct file * file, struct page * page)
396 return block_read_full_page(page, blkdev_get_block);
399 static void blkdev_readahead(struct readahead_control *rac)
401 mpage_readahead(rac, blkdev_get_block);
404 static int blkdev_write_begin(struct file *file, struct address_space *mapping,
405 loff_t pos, unsigned len, unsigned flags, struct page **pagep,
408 return block_write_begin(mapping, pos, len, flags, pagep,
412 static int blkdev_write_end(struct file *file, struct address_space *mapping,
413 loff_t pos, unsigned len, unsigned copied, struct page *page,
417 ret = block_write_end(file, mapping, pos, len, copied, page, fsdata);
425 static int blkdev_writepages(struct address_space *mapping,
426 struct writeback_control *wbc)
428 return generic_writepages(mapping, wbc);
431 const struct address_space_operations def_blk_aops = {
432 .set_page_dirty = __set_page_dirty_buffers,
433 .readpage = blkdev_readpage,
434 .readahead = blkdev_readahead,
435 .writepage = blkdev_writepage,
436 .write_begin = blkdev_write_begin,
437 .write_end = blkdev_write_end,
438 .writepages = blkdev_writepages,
439 .direct_IO = blkdev_direct_IO,
440 .migratepage = buffer_migrate_page_norefs,
441 .is_dirty_writeback = buffer_check_dirty_writeback,
445 * for a block special file file_inode(file)->i_size is zero
446 * so we compute the size by hand (just as in block_read/write above)
448 static loff_t blkdev_llseek(struct file *file, loff_t offset, int whence)
450 struct inode *bd_inode = bdev_file_inode(file);
453 inode_lock(bd_inode);
454 retval = fixed_size_llseek(file, offset, whence, i_size_read(bd_inode));
455 inode_unlock(bd_inode);
459 static int blkdev_fsync(struct file *filp, loff_t start, loff_t end,
462 struct block_device *bdev = filp->private_data;
465 error = file_write_and_wait_range(filp, start, end);
470 * There is no need to serialise calls to blkdev_issue_flush with
471 * i_mutex and doing so causes performance issues with concurrent
472 * O_SYNC writers to a block device.
474 error = blkdev_issue_flush(bdev);
475 if (error == -EOPNOTSUPP)
481 static int blkdev_open(struct inode *inode, struct file *filp)
483 struct block_device *bdev;
486 * Preserve backwards compatibility and allow large file access
487 * even if userspace doesn't ask for it explicitly. Some mkfs
488 * binary needs it. We might want to drop this workaround
489 * during an unstable branch.
491 filp->f_flags |= O_LARGEFILE;
492 filp->f_mode |= FMODE_NOWAIT | FMODE_BUF_RASYNC;
494 if (filp->f_flags & O_NDELAY)
495 filp->f_mode |= FMODE_NDELAY;
496 if (filp->f_flags & O_EXCL)
497 filp->f_mode |= FMODE_EXCL;
498 if ((filp->f_flags & O_ACCMODE) == 3)
499 filp->f_mode |= FMODE_WRITE_IOCTL;
501 bdev = blkdev_get_by_dev(inode->i_rdev, filp->f_mode, filp);
503 return PTR_ERR(bdev);
505 filp->private_data = bdev;
506 filp->f_mapping = bdev->bd_inode->i_mapping;
507 filp->f_wb_err = filemap_sample_wb_err(filp->f_mapping);
511 static int blkdev_close(struct inode *inode, struct file *filp)
513 struct block_device *bdev = filp->private_data;
515 blkdev_put(bdev, filp->f_mode);
520 * Write data to the block device. Only intended for the block device itself
521 * and the raw driver which basically is a fake block device.
523 * Does not take i_mutex for the write and thus is not for general purpose
526 static ssize_t blkdev_write_iter(struct kiocb *iocb, struct iov_iter *from)
528 struct block_device *bdev = iocb->ki_filp->private_data;
529 struct inode *bd_inode = bdev->bd_inode;
530 loff_t size = bdev_nr_bytes(bdev);
531 struct blk_plug plug;
535 if (bdev_read_only(bdev))
538 if (IS_SWAPFILE(bd_inode) && !is_hibernate_resume_dev(bd_inode->i_rdev))
541 if (!iov_iter_count(from))
544 if (iocb->ki_pos >= size)
547 if ((iocb->ki_flags & (IOCB_NOWAIT | IOCB_DIRECT)) == IOCB_NOWAIT)
550 size -= iocb->ki_pos;
551 if (iov_iter_count(from) > size) {
552 shorted = iov_iter_count(from) - size;
553 iov_iter_truncate(from, size);
556 blk_start_plug(&plug);
557 ret = __generic_file_write_iter(iocb, from);
559 ret = generic_write_sync(iocb, ret);
560 iov_iter_reexpand(from, iov_iter_count(from) + shorted);
561 blk_finish_plug(&plug);
565 static ssize_t blkdev_read_iter(struct kiocb *iocb, struct iov_iter *to)
567 struct block_device *bdev = iocb->ki_filp->private_data;
568 loff_t size = bdev_nr_bytes(bdev);
569 loff_t pos = iocb->ki_pos;
573 if (unlikely(pos + iov_iter_count(to) > size)) {
577 if (iov_iter_count(to) > size) {
578 shorted = iov_iter_count(to) - size;
579 iov_iter_truncate(to, size);
583 ret = generic_file_read_iter(iocb, to);
585 if (unlikely(shorted))
586 iov_iter_reexpand(to, iov_iter_count(to) + shorted);
590 #define BLKDEV_FALLOC_FL_SUPPORTED \
591 (FALLOC_FL_KEEP_SIZE | FALLOC_FL_PUNCH_HOLE | \
592 FALLOC_FL_ZERO_RANGE | FALLOC_FL_NO_HIDE_STALE)
594 static long blkdev_fallocate(struct file *file, int mode, loff_t start,
597 struct inode *inode = bdev_file_inode(file);
598 struct block_device *bdev = I_BDEV(inode);
599 loff_t end = start + len - 1;
603 /* Fail if we don't recognize the flags. */
604 if (mode & ~BLKDEV_FALLOC_FL_SUPPORTED)
607 /* Don't go off the end of the device. */
608 isize = bdev_nr_bytes(bdev);
612 if (mode & FALLOC_FL_KEEP_SIZE) {
614 end = start + len - 1;
620 * Don't allow IO that isn't aligned to logical block size.
622 if ((start | len) & (bdev_logical_block_size(bdev) - 1))
625 filemap_invalidate_lock(inode->i_mapping);
627 /* Invalidate the page cache, including dirty pages. */
628 error = truncate_bdev_range(bdev, file->f_mode, start, end);
633 case FALLOC_FL_ZERO_RANGE:
634 case FALLOC_FL_ZERO_RANGE | FALLOC_FL_KEEP_SIZE:
635 error = blkdev_issue_zeroout(bdev, start >> SECTOR_SHIFT,
636 len >> SECTOR_SHIFT, GFP_KERNEL,
637 BLKDEV_ZERO_NOUNMAP);
639 case FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE:
640 error = blkdev_issue_zeroout(bdev, start >> SECTOR_SHIFT,
641 len >> SECTOR_SHIFT, GFP_KERNEL,
642 BLKDEV_ZERO_NOFALLBACK);
644 case FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE | FALLOC_FL_NO_HIDE_STALE:
645 error = blkdev_issue_discard(bdev, start >> SECTOR_SHIFT,
646 len >> SECTOR_SHIFT, GFP_KERNEL, 0);
653 filemap_invalidate_unlock(inode->i_mapping);
657 const struct file_operations def_blk_fops = {
659 .release = blkdev_close,
660 .llseek = blkdev_llseek,
661 .read_iter = blkdev_read_iter,
662 .write_iter = blkdev_write_iter,
663 .iopoll = iocb_bio_iopoll,
664 .mmap = generic_file_mmap,
665 .fsync = blkdev_fsync,
666 .unlocked_ioctl = blkdev_ioctl,
668 .compat_ioctl = compat_blkdev_ioctl,
670 .splice_read = generic_file_splice_read,
671 .splice_write = iter_file_splice_write,
672 .fallocate = blkdev_fallocate,
675 static __init int blkdev_init(void)
677 return bioset_init(&blkdev_dio_pool, 4,
678 offsetof(struct blkdev_dio, bio),
679 BIOSET_NEED_BVECS|BIOSET_PERCPU_CACHE);
681 module_init(blkdev_init);