Merge tag 'ieee802154-for-davem-2021-06-03' of git://git.kernel.org/pub/scm/linux...
[linux-2.6-microblaze.git] / fs / block_dev.c
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/fcntl.h>
11 #include <linux/slab.h>
12 #include <linux/kmod.h>
13 #include <linux/major.h>
14 #include <linux/device_cgroup.h>
15 #include <linux/highmem.h>
16 #include <linux/blkdev.h>
17 #include <linux/backing-dev.h>
18 #include <linux/module.h>
19 #include <linux/blkpg.h>
20 #include <linux/magic.h>
21 #include <linux/buffer_head.h>
22 #include <linux/swap.h>
23 #include <linux/pagevec.h>
24 #include <linux/writeback.h>
25 #include <linux/mpage.h>
26 #include <linux/mount.h>
27 #include <linux/pseudo_fs.h>
28 #include <linux/uio.h>
29 #include <linux/namei.h>
30 #include <linux/log2.h>
31 #include <linux/cleancache.h>
32 #include <linux/task_io_accounting_ops.h>
33 #include <linux/falloc.h>
34 #include <linux/part_stat.h>
35 #include <linux/uaccess.h>
36 #include <linux/suspend.h>
37 #include "internal.h"
38
39 struct bdev_inode {
40         struct block_device bdev;
41         struct inode vfs_inode;
42 };
43
44 static const struct address_space_operations def_blk_aops;
45
46 static inline struct bdev_inode *BDEV_I(struct inode *inode)
47 {
48         return container_of(inode, struct bdev_inode, vfs_inode);
49 }
50
51 struct block_device *I_BDEV(struct inode *inode)
52 {
53         return &BDEV_I(inode)->bdev;
54 }
55 EXPORT_SYMBOL(I_BDEV);
56
57 static void bdev_write_inode(struct block_device *bdev)
58 {
59         struct inode *inode = bdev->bd_inode;
60         int ret;
61
62         spin_lock(&inode->i_lock);
63         while (inode->i_state & I_DIRTY) {
64                 spin_unlock(&inode->i_lock);
65                 ret = write_inode_now(inode, true);
66                 if (ret) {
67                         char name[BDEVNAME_SIZE];
68                         pr_warn_ratelimited("VFS: Dirty inode writeback failed "
69                                             "for block device %s (err=%d).\n",
70                                             bdevname(bdev, name), ret);
71                 }
72                 spin_lock(&inode->i_lock);
73         }
74         spin_unlock(&inode->i_lock);
75 }
76
77 /* Kill _all_ buffers and pagecache , dirty or not.. */
78 static void kill_bdev(struct block_device *bdev)
79 {
80         struct address_space *mapping = bdev->bd_inode->i_mapping;
81
82         if (mapping_empty(mapping))
83                 return;
84
85         invalidate_bh_lrus();
86         truncate_inode_pages(mapping, 0);
87 }
88
89 /* Invalidate clean unused buffers and pagecache. */
90 void invalidate_bdev(struct block_device *bdev)
91 {
92         struct address_space *mapping = bdev->bd_inode->i_mapping;
93
94         if (mapping->nrpages) {
95                 invalidate_bh_lrus();
96                 lru_add_drain_all();    /* make sure all lru add caches are flushed */
97                 invalidate_mapping_pages(mapping, 0, -1);
98         }
99         /* 99% of the time, we don't need to flush the cleancache on the bdev.
100          * But, for the strange corners, lets be cautious
101          */
102         cleancache_invalidate_inode(mapping);
103 }
104 EXPORT_SYMBOL(invalidate_bdev);
105
106 /*
107  * Drop all buffers & page cache for given bdev range. This function bails
108  * with error if bdev has other exclusive owner (such as filesystem).
109  */
110 int truncate_bdev_range(struct block_device *bdev, fmode_t mode,
111                         loff_t lstart, loff_t lend)
112 {
113         /*
114          * If we don't hold exclusive handle for the device, upgrade to it
115          * while we discard the buffer cache to avoid discarding buffers
116          * under live filesystem.
117          */
118         if (!(mode & FMODE_EXCL)) {
119                 int err = bd_prepare_to_claim(bdev, truncate_bdev_range);
120                 if (err)
121                         goto invalidate;
122         }
123
124         truncate_inode_pages_range(bdev->bd_inode->i_mapping, lstart, lend);
125         if (!(mode & FMODE_EXCL))
126                 bd_abort_claiming(bdev, truncate_bdev_range);
127         return 0;
128
129 invalidate:
130         /*
131          * Someone else has handle exclusively open. Try invalidating instead.
132          * The 'end' argument is inclusive so the rounding is safe.
133          */
134         return invalidate_inode_pages2_range(bdev->bd_inode->i_mapping,
135                                              lstart >> PAGE_SHIFT,
136                                              lend >> PAGE_SHIFT);
137 }
138
139 static void set_init_blocksize(struct block_device *bdev)
140 {
141         unsigned int bsize = bdev_logical_block_size(bdev);
142         loff_t size = i_size_read(bdev->bd_inode);
143
144         while (bsize < PAGE_SIZE) {
145                 if (size & bsize)
146                         break;
147                 bsize <<= 1;
148         }
149         bdev->bd_inode->i_blkbits = blksize_bits(bsize);
150 }
151
152 int set_blocksize(struct block_device *bdev, int size)
153 {
154         /* Size must be a power of two, and between 512 and PAGE_SIZE */
155         if (size > PAGE_SIZE || size < 512 || !is_power_of_2(size))
156                 return -EINVAL;
157
158         /* Size cannot be smaller than the size supported by the device */
159         if (size < bdev_logical_block_size(bdev))
160                 return -EINVAL;
161
162         /* Don't change the size if it is same as current */
163         if (bdev->bd_inode->i_blkbits != blksize_bits(size)) {
164                 sync_blockdev(bdev);
165                 bdev->bd_inode->i_blkbits = blksize_bits(size);
166                 kill_bdev(bdev);
167         }
168         return 0;
169 }
170
171 EXPORT_SYMBOL(set_blocksize);
172
173 int sb_set_blocksize(struct super_block *sb, int size)
174 {
175         if (set_blocksize(sb->s_bdev, size))
176                 return 0;
177         /* If we get here, we know size is power of two
178          * and it's value is between 512 and PAGE_SIZE */
179         sb->s_blocksize = size;
180         sb->s_blocksize_bits = blksize_bits(size);
181         return sb->s_blocksize;
182 }
183
184 EXPORT_SYMBOL(sb_set_blocksize);
185
186 int sb_min_blocksize(struct super_block *sb, int size)
187 {
188         int minsize = bdev_logical_block_size(sb->s_bdev);
189         if (size < minsize)
190                 size = minsize;
191         return sb_set_blocksize(sb, size);
192 }
193
194 EXPORT_SYMBOL(sb_min_blocksize);
195
196 static int
197 blkdev_get_block(struct inode *inode, sector_t iblock,
198                 struct buffer_head *bh, int create)
199 {
200         bh->b_bdev = I_BDEV(inode);
201         bh->b_blocknr = iblock;
202         set_buffer_mapped(bh);
203         return 0;
204 }
205
206 static struct inode *bdev_file_inode(struct file *file)
207 {
208         return file->f_mapping->host;
209 }
210
211 static unsigned int dio_bio_write_op(struct kiocb *iocb)
212 {
213         unsigned int op = REQ_OP_WRITE | REQ_SYNC | REQ_IDLE;
214
215         /* avoid the need for a I/O completion work item */
216         if (iocb->ki_flags & IOCB_DSYNC)
217                 op |= REQ_FUA;
218         return op;
219 }
220
221 #define DIO_INLINE_BIO_VECS 4
222
223 static void blkdev_bio_end_io_simple(struct bio *bio)
224 {
225         struct task_struct *waiter = bio->bi_private;
226
227         WRITE_ONCE(bio->bi_private, NULL);
228         blk_wake_io_task(waiter);
229 }
230
231 static ssize_t
232 __blkdev_direct_IO_simple(struct kiocb *iocb, struct iov_iter *iter,
233                 unsigned int nr_pages)
234 {
235         struct file *file = iocb->ki_filp;
236         struct block_device *bdev = I_BDEV(bdev_file_inode(file));
237         struct bio_vec inline_vecs[DIO_INLINE_BIO_VECS], *vecs;
238         loff_t pos = iocb->ki_pos;
239         bool should_dirty = false;
240         struct bio bio;
241         ssize_t ret;
242         blk_qc_t qc;
243
244         if ((pos | iov_iter_alignment(iter)) &
245             (bdev_logical_block_size(bdev) - 1))
246                 return -EINVAL;
247
248         if (nr_pages <= DIO_INLINE_BIO_VECS)
249                 vecs = inline_vecs;
250         else {
251                 vecs = kmalloc_array(nr_pages, sizeof(struct bio_vec),
252                                      GFP_KERNEL);
253                 if (!vecs)
254                         return -ENOMEM;
255         }
256
257         bio_init(&bio, vecs, nr_pages);
258         bio_set_dev(&bio, bdev);
259         bio.bi_iter.bi_sector = pos >> 9;
260         bio.bi_write_hint = iocb->ki_hint;
261         bio.bi_private = current;
262         bio.bi_end_io = blkdev_bio_end_io_simple;
263         bio.bi_ioprio = iocb->ki_ioprio;
264
265         ret = bio_iov_iter_get_pages(&bio, iter);
266         if (unlikely(ret))
267                 goto out;
268         ret = bio.bi_iter.bi_size;
269
270         if (iov_iter_rw(iter) == READ) {
271                 bio.bi_opf = REQ_OP_READ;
272                 if (iter_is_iovec(iter))
273                         should_dirty = true;
274         } else {
275                 bio.bi_opf = dio_bio_write_op(iocb);
276                 task_io_account_write(ret);
277         }
278         if (iocb->ki_flags & IOCB_NOWAIT)
279                 bio.bi_opf |= REQ_NOWAIT;
280         if (iocb->ki_flags & IOCB_HIPRI)
281                 bio_set_polled(&bio, iocb);
282
283         qc = submit_bio(&bio);
284         for (;;) {
285                 set_current_state(TASK_UNINTERRUPTIBLE);
286                 if (!READ_ONCE(bio.bi_private))
287                         break;
288                 if (!(iocb->ki_flags & IOCB_HIPRI) ||
289                     !blk_poll(bdev_get_queue(bdev), qc, true))
290                         blk_io_schedule();
291         }
292         __set_current_state(TASK_RUNNING);
293
294         bio_release_pages(&bio, should_dirty);
295         if (unlikely(bio.bi_status))
296                 ret = blk_status_to_errno(bio.bi_status);
297
298 out:
299         if (vecs != inline_vecs)
300                 kfree(vecs);
301
302         bio_uninit(&bio);
303
304         return ret;
305 }
306
307 struct blkdev_dio {
308         union {
309                 struct kiocb            *iocb;
310                 struct task_struct      *waiter;
311         };
312         size_t                  size;
313         atomic_t                ref;
314         bool                    multi_bio : 1;
315         bool                    should_dirty : 1;
316         bool                    is_sync : 1;
317         struct bio              bio;
318 };
319
320 static struct bio_set blkdev_dio_pool;
321
322 static int blkdev_iopoll(struct kiocb *kiocb, bool wait)
323 {
324         struct block_device *bdev = I_BDEV(kiocb->ki_filp->f_mapping->host);
325         struct request_queue *q = bdev_get_queue(bdev);
326
327         return blk_poll(q, READ_ONCE(kiocb->ki_cookie), wait);
328 }
329
330 static void blkdev_bio_end_io(struct bio *bio)
331 {
332         struct blkdev_dio *dio = bio->bi_private;
333         bool should_dirty = dio->should_dirty;
334
335         if (bio->bi_status && !dio->bio.bi_status)
336                 dio->bio.bi_status = bio->bi_status;
337
338         if (!dio->multi_bio || atomic_dec_and_test(&dio->ref)) {
339                 if (!dio->is_sync) {
340                         struct kiocb *iocb = dio->iocb;
341                         ssize_t ret;
342
343                         if (likely(!dio->bio.bi_status)) {
344                                 ret = dio->size;
345                                 iocb->ki_pos += ret;
346                         } else {
347                                 ret = blk_status_to_errno(dio->bio.bi_status);
348                         }
349
350                         dio->iocb->ki_complete(iocb, ret, 0);
351                         if (dio->multi_bio)
352                                 bio_put(&dio->bio);
353                 } else {
354                         struct task_struct *waiter = dio->waiter;
355
356                         WRITE_ONCE(dio->waiter, NULL);
357                         blk_wake_io_task(waiter);
358                 }
359         }
360
361         if (should_dirty) {
362                 bio_check_pages_dirty(bio);
363         } else {
364                 bio_release_pages(bio, false);
365                 bio_put(bio);
366         }
367 }
368
369 static ssize_t __blkdev_direct_IO(struct kiocb *iocb, struct iov_iter *iter,
370                 unsigned int nr_pages)
371 {
372         struct file *file = iocb->ki_filp;
373         struct inode *inode = bdev_file_inode(file);
374         struct block_device *bdev = I_BDEV(inode);
375         struct blk_plug plug;
376         struct blkdev_dio *dio;
377         struct bio *bio;
378         bool is_poll = (iocb->ki_flags & IOCB_HIPRI) != 0;
379         bool is_read = (iov_iter_rw(iter) == READ), is_sync;
380         loff_t pos = iocb->ki_pos;
381         blk_qc_t qc = BLK_QC_T_NONE;
382         int ret = 0;
383
384         if ((pos | iov_iter_alignment(iter)) &
385             (bdev_logical_block_size(bdev) - 1))
386                 return -EINVAL;
387
388         bio = bio_alloc_bioset(GFP_KERNEL, nr_pages, &blkdev_dio_pool);
389
390         dio = container_of(bio, struct blkdev_dio, bio);
391         dio->is_sync = is_sync = is_sync_kiocb(iocb);
392         if (dio->is_sync) {
393                 dio->waiter = current;
394                 bio_get(bio);
395         } else {
396                 dio->iocb = iocb;
397         }
398
399         dio->size = 0;
400         dio->multi_bio = false;
401         dio->should_dirty = is_read && iter_is_iovec(iter);
402
403         /*
404          * Don't plug for HIPRI/polled IO, as those should go straight
405          * to issue
406          */
407         if (!is_poll)
408                 blk_start_plug(&plug);
409
410         for (;;) {
411                 bio_set_dev(bio, bdev);
412                 bio->bi_iter.bi_sector = pos >> 9;
413                 bio->bi_write_hint = iocb->ki_hint;
414                 bio->bi_private = dio;
415                 bio->bi_end_io = blkdev_bio_end_io;
416                 bio->bi_ioprio = iocb->ki_ioprio;
417
418                 ret = bio_iov_iter_get_pages(bio, iter);
419                 if (unlikely(ret)) {
420                         bio->bi_status = BLK_STS_IOERR;
421                         bio_endio(bio);
422                         break;
423                 }
424
425                 if (is_read) {
426                         bio->bi_opf = REQ_OP_READ;
427                         if (dio->should_dirty)
428                                 bio_set_pages_dirty(bio);
429                 } else {
430                         bio->bi_opf = dio_bio_write_op(iocb);
431                         task_io_account_write(bio->bi_iter.bi_size);
432                 }
433                 if (iocb->ki_flags & IOCB_NOWAIT)
434                         bio->bi_opf |= REQ_NOWAIT;
435
436                 dio->size += bio->bi_iter.bi_size;
437                 pos += bio->bi_iter.bi_size;
438
439                 nr_pages = bio_iov_vecs_to_alloc(iter, BIO_MAX_VECS);
440                 if (!nr_pages) {
441                         bool polled = false;
442
443                         if (iocb->ki_flags & IOCB_HIPRI) {
444                                 bio_set_polled(bio, iocb);
445                                 polled = true;
446                         }
447
448                         qc = submit_bio(bio);
449
450                         if (polled)
451                                 WRITE_ONCE(iocb->ki_cookie, qc);
452                         break;
453                 }
454
455                 if (!dio->multi_bio) {
456                         /*
457                          * AIO needs an extra reference to ensure the dio
458                          * structure which is embedded into the first bio
459                          * stays around.
460                          */
461                         if (!is_sync)
462                                 bio_get(bio);
463                         dio->multi_bio = true;
464                         atomic_set(&dio->ref, 2);
465                 } else {
466                         atomic_inc(&dio->ref);
467                 }
468
469                 submit_bio(bio);
470                 bio = bio_alloc(GFP_KERNEL, nr_pages);
471         }
472
473         if (!is_poll)
474                 blk_finish_plug(&plug);
475
476         if (!is_sync)
477                 return -EIOCBQUEUED;
478
479         for (;;) {
480                 set_current_state(TASK_UNINTERRUPTIBLE);
481                 if (!READ_ONCE(dio->waiter))
482                         break;
483
484                 if (!(iocb->ki_flags & IOCB_HIPRI) ||
485                     !blk_poll(bdev_get_queue(bdev), qc, true))
486                         blk_io_schedule();
487         }
488         __set_current_state(TASK_RUNNING);
489
490         if (!ret)
491                 ret = blk_status_to_errno(dio->bio.bi_status);
492         if (likely(!ret))
493                 ret = dio->size;
494
495         bio_put(&dio->bio);
496         return ret;
497 }
498
499 static ssize_t
500 blkdev_direct_IO(struct kiocb *iocb, struct iov_iter *iter)
501 {
502         unsigned int nr_pages;
503
504         if (!iov_iter_count(iter))
505                 return 0;
506
507         nr_pages = bio_iov_vecs_to_alloc(iter, BIO_MAX_VECS + 1);
508         if (is_sync_kiocb(iocb) && nr_pages <= BIO_MAX_VECS)
509                 return __blkdev_direct_IO_simple(iocb, iter, nr_pages);
510
511         return __blkdev_direct_IO(iocb, iter, bio_max_segs(nr_pages));
512 }
513
514 static __init int blkdev_init(void)
515 {
516         return bioset_init(&blkdev_dio_pool, 4, offsetof(struct blkdev_dio, bio), BIOSET_NEED_BVECS);
517 }
518 module_init(blkdev_init);
519
520 int __sync_blockdev(struct block_device *bdev, int wait)
521 {
522         if (!bdev)
523                 return 0;
524         if (!wait)
525                 return filemap_flush(bdev->bd_inode->i_mapping);
526         return filemap_write_and_wait(bdev->bd_inode->i_mapping);
527 }
528
529 /*
530  * Write out and wait upon all the dirty data associated with a block
531  * device via its mapping.  Does not take the superblock lock.
532  */
533 int sync_blockdev(struct block_device *bdev)
534 {
535         return __sync_blockdev(bdev, 1);
536 }
537 EXPORT_SYMBOL(sync_blockdev);
538
539 /*
540  * Write out and wait upon all dirty data associated with this
541  * device.   Filesystem data as well as the underlying block
542  * device.  Takes the superblock lock.
543  */
544 int fsync_bdev(struct block_device *bdev)
545 {
546         struct super_block *sb = get_super(bdev);
547         if (sb) {
548                 int res = sync_filesystem(sb);
549                 drop_super(sb);
550                 return res;
551         }
552         return sync_blockdev(bdev);
553 }
554 EXPORT_SYMBOL(fsync_bdev);
555
556 /**
557  * freeze_bdev  --  lock a filesystem and force it into a consistent state
558  * @bdev:       blockdevice to lock
559  *
560  * If a superblock is found on this device, we take the s_umount semaphore
561  * on it to make sure nobody unmounts until the snapshot creation is done.
562  * The reference counter (bd_fsfreeze_count) guarantees that only the last
563  * unfreeze process can unfreeze the frozen filesystem actually when multiple
564  * freeze requests arrive simultaneously. It counts up in freeze_bdev() and
565  * count down in thaw_bdev(). When it becomes 0, thaw_bdev() will unfreeze
566  * actually.
567  */
568 int freeze_bdev(struct block_device *bdev)
569 {
570         struct super_block *sb;
571         int error = 0;
572
573         mutex_lock(&bdev->bd_fsfreeze_mutex);
574         if (++bdev->bd_fsfreeze_count > 1)
575                 goto done;
576
577         sb = get_active_super(bdev);
578         if (!sb)
579                 goto sync;
580         if (sb->s_op->freeze_super)
581                 error = sb->s_op->freeze_super(sb);
582         else
583                 error = freeze_super(sb);
584         deactivate_super(sb);
585
586         if (error) {
587                 bdev->bd_fsfreeze_count--;
588                 goto done;
589         }
590         bdev->bd_fsfreeze_sb = sb;
591
592 sync:
593         sync_blockdev(bdev);
594 done:
595         mutex_unlock(&bdev->bd_fsfreeze_mutex);
596         return error;
597 }
598 EXPORT_SYMBOL(freeze_bdev);
599
600 /**
601  * thaw_bdev  -- unlock filesystem
602  * @bdev:       blockdevice to unlock
603  *
604  * Unlocks the filesystem and marks it writeable again after freeze_bdev().
605  */
606 int thaw_bdev(struct block_device *bdev)
607 {
608         struct super_block *sb;
609         int error = -EINVAL;
610
611         mutex_lock(&bdev->bd_fsfreeze_mutex);
612         if (!bdev->bd_fsfreeze_count)
613                 goto out;
614
615         error = 0;
616         if (--bdev->bd_fsfreeze_count > 0)
617                 goto out;
618
619         sb = bdev->bd_fsfreeze_sb;
620         if (!sb)
621                 goto out;
622
623         if (sb->s_op->thaw_super)
624                 error = sb->s_op->thaw_super(sb);
625         else
626                 error = thaw_super(sb);
627         if (error)
628                 bdev->bd_fsfreeze_count++;
629         else
630                 bdev->bd_fsfreeze_sb = NULL;
631 out:
632         mutex_unlock(&bdev->bd_fsfreeze_mutex);
633         return error;
634 }
635 EXPORT_SYMBOL(thaw_bdev);
636
637 static int blkdev_writepage(struct page *page, struct writeback_control *wbc)
638 {
639         return block_write_full_page(page, blkdev_get_block, wbc);
640 }
641
642 static int blkdev_readpage(struct file * file, struct page * page)
643 {
644         return block_read_full_page(page, blkdev_get_block);
645 }
646
647 static void blkdev_readahead(struct readahead_control *rac)
648 {
649         mpage_readahead(rac, blkdev_get_block);
650 }
651
652 static int blkdev_write_begin(struct file *file, struct address_space *mapping,
653                         loff_t pos, unsigned len, unsigned flags,
654                         struct page **pagep, void **fsdata)
655 {
656         return block_write_begin(mapping, pos, len, flags, pagep,
657                                  blkdev_get_block);
658 }
659
660 static int blkdev_write_end(struct file *file, struct address_space *mapping,
661                         loff_t pos, unsigned len, unsigned copied,
662                         struct page *page, void *fsdata)
663 {
664         int ret;
665         ret = block_write_end(file, mapping, pos, len, copied, page, fsdata);
666
667         unlock_page(page);
668         put_page(page);
669
670         return ret;
671 }
672
673 /*
674  * private llseek:
675  * for a block special file file_inode(file)->i_size is zero
676  * so we compute the size by hand (just as in block_read/write above)
677  */
678 static loff_t block_llseek(struct file *file, loff_t offset, int whence)
679 {
680         struct inode *bd_inode = bdev_file_inode(file);
681         loff_t retval;
682
683         inode_lock(bd_inode);
684         retval = fixed_size_llseek(file, offset, whence, i_size_read(bd_inode));
685         inode_unlock(bd_inode);
686         return retval;
687 }
688         
689 int blkdev_fsync(struct file *filp, loff_t start, loff_t end, int datasync)
690 {
691         struct inode *bd_inode = bdev_file_inode(filp);
692         struct block_device *bdev = I_BDEV(bd_inode);
693         int error;
694         
695         error = file_write_and_wait_range(filp, start, end);
696         if (error)
697                 return error;
698
699         /*
700          * There is no need to serialise calls to blkdev_issue_flush with
701          * i_mutex and doing so causes performance issues with concurrent
702          * O_SYNC writers to a block device.
703          */
704         error = blkdev_issue_flush(bdev);
705         if (error == -EOPNOTSUPP)
706                 error = 0;
707
708         return error;
709 }
710 EXPORT_SYMBOL(blkdev_fsync);
711
712 /**
713  * bdev_read_page() - Start reading a page from a block device
714  * @bdev: The device to read the page from
715  * @sector: The offset on the device to read the page to (need not be aligned)
716  * @page: The page to read
717  *
718  * On entry, the page should be locked.  It will be unlocked when the page
719  * has been read.  If the block driver implements rw_page synchronously,
720  * that will be true on exit from this function, but it need not be.
721  *
722  * Errors returned by this function are usually "soft", eg out of memory, or
723  * queue full; callers should try a different route to read this page rather
724  * than propagate an error back up the stack.
725  *
726  * Return: negative errno if an error occurs, 0 if submission was successful.
727  */
728 int bdev_read_page(struct block_device *bdev, sector_t sector,
729                         struct page *page)
730 {
731         const struct block_device_operations *ops = bdev->bd_disk->fops;
732         int result = -EOPNOTSUPP;
733
734         if (!ops->rw_page || bdev_get_integrity(bdev))
735                 return result;
736
737         result = blk_queue_enter(bdev->bd_disk->queue, 0);
738         if (result)
739                 return result;
740         result = ops->rw_page(bdev, sector + get_start_sect(bdev), page,
741                               REQ_OP_READ);
742         blk_queue_exit(bdev->bd_disk->queue);
743         return result;
744 }
745
746 /**
747  * bdev_write_page() - Start writing a page to a block device
748  * @bdev: The device to write the page to
749  * @sector: The offset on the device to write the page to (need not be aligned)
750  * @page: The page to write
751  * @wbc: The writeback_control for the write
752  *
753  * On entry, the page should be locked and not currently under writeback.
754  * On exit, if the write started successfully, the page will be unlocked and
755  * under writeback.  If the write failed already (eg the driver failed to
756  * queue the page to the device), the page will still be locked.  If the
757  * caller is a ->writepage implementation, it will need to unlock the page.
758  *
759  * Errors returned by this function are usually "soft", eg out of memory, or
760  * queue full; callers should try a different route to write this page rather
761  * than propagate an error back up the stack.
762  *
763  * Return: negative errno if an error occurs, 0 if submission was successful.
764  */
765 int bdev_write_page(struct block_device *bdev, sector_t sector,
766                         struct page *page, struct writeback_control *wbc)
767 {
768         int result;
769         const struct block_device_operations *ops = bdev->bd_disk->fops;
770
771         if (!ops->rw_page || bdev_get_integrity(bdev))
772                 return -EOPNOTSUPP;
773         result = blk_queue_enter(bdev->bd_disk->queue, 0);
774         if (result)
775                 return result;
776
777         set_page_writeback(page);
778         result = ops->rw_page(bdev, sector + get_start_sect(bdev), page,
779                               REQ_OP_WRITE);
780         if (result) {
781                 end_page_writeback(page);
782         } else {
783                 clean_page_buffers(page);
784                 unlock_page(page);
785         }
786         blk_queue_exit(bdev->bd_disk->queue);
787         return result;
788 }
789
790 /*
791  * pseudo-fs
792  */
793
794 static  __cacheline_aligned_in_smp DEFINE_SPINLOCK(bdev_lock);
795 static struct kmem_cache * bdev_cachep __read_mostly;
796
797 static struct inode *bdev_alloc_inode(struct super_block *sb)
798 {
799         struct bdev_inode *ei = kmem_cache_alloc(bdev_cachep, GFP_KERNEL);
800
801         if (!ei)
802                 return NULL;
803         memset(&ei->bdev, 0, sizeof(ei->bdev));
804         ei->bdev.bd_bdi = &noop_backing_dev_info;
805         return &ei->vfs_inode;
806 }
807
808 static void bdev_free_inode(struct inode *inode)
809 {
810         struct block_device *bdev = I_BDEV(inode);
811
812         free_percpu(bdev->bd_stats);
813         kfree(bdev->bd_meta_info);
814
815         kmem_cache_free(bdev_cachep, BDEV_I(inode));
816 }
817
818 static void init_once(void *data)
819 {
820         struct bdev_inode *ei = data;
821
822         inode_init_once(&ei->vfs_inode);
823 }
824
825 static void bdev_evict_inode(struct inode *inode)
826 {
827         struct block_device *bdev = &BDEV_I(inode)->bdev;
828         truncate_inode_pages_final(&inode->i_data);
829         invalidate_inode_buffers(inode); /* is it needed here? */
830         clear_inode(inode);
831         /* Detach inode from wb early as bdi_put() may free bdi->wb */
832         inode_detach_wb(inode);
833         if (bdev->bd_bdi != &noop_backing_dev_info) {
834                 bdi_put(bdev->bd_bdi);
835                 bdev->bd_bdi = &noop_backing_dev_info;
836         }
837 }
838
839 static const struct super_operations bdev_sops = {
840         .statfs = simple_statfs,
841         .alloc_inode = bdev_alloc_inode,
842         .free_inode = bdev_free_inode,
843         .drop_inode = generic_delete_inode,
844         .evict_inode = bdev_evict_inode,
845 };
846
847 static int bd_init_fs_context(struct fs_context *fc)
848 {
849         struct pseudo_fs_context *ctx = init_pseudo(fc, BDEVFS_MAGIC);
850         if (!ctx)
851                 return -ENOMEM;
852         fc->s_iflags |= SB_I_CGROUPWB;
853         ctx->ops = &bdev_sops;
854         return 0;
855 }
856
857 static struct file_system_type bd_type = {
858         .name           = "bdev",
859         .init_fs_context = bd_init_fs_context,
860         .kill_sb        = kill_anon_super,
861 };
862
863 struct super_block *blockdev_superblock __read_mostly;
864 EXPORT_SYMBOL_GPL(blockdev_superblock);
865
866 void __init bdev_cache_init(void)
867 {
868         int err;
869         static struct vfsmount *bd_mnt;
870
871         bdev_cachep = kmem_cache_create("bdev_cache", sizeof(struct bdev_inode),
872                         0, (SLAB_HWCACHE_ALIGN|SLAB_RECLAIM_ACCOUNT|
873                                 SLAB_MEM_SPREAD|SLAB_ACCOUNT|SLAB_PANIC),
874                         init_once);
875         err = register_filesystem(&bd_type);
876         if (err)
877                 panic("Cannot register bdev pseudo-fs");
878         bd_mnt = kern_mount(&bd_type);
879         if (IS_ERR(bd_mnt))
880                 panic("Cannot create bdev pseudo-fs");
881         blockdev_superblock = bd_mnt->mnt_sb;   /* For writeback */
882 }
883
884 struct block_device *bdev_alloc(struct gendisk *disk, u8 partno)
885 {
886         struct block_device *bdev;
887         struct inode *inode;
888
889         inode = new_inode(blockdev_superblock);
890         if (!inode)
891                 return NULL;
892         inode->i_mode = S_IFBLK;
893         inode->i_rdev = 0;
894         inode->i_data.a_ops = &def_blk_aops;
895         mapping_set_gfp_mask(&inode->i_data, GFP_USER);
896
897         bdev = I_BDEV(inode);
898         mutex_init(&bdev->bd_mutex);
899         mutex_init(&bdev->bd_fsfreeze_mutex);
900         spin_lock_init(&bdev->bd_size_lock);
901         bdev->bd_disk = disk;
902         bdev->bd_partno = partno;
903         bdev->bd_inode = inode;
904 #ifdef CONFIG_SYSFS
905         INIT_LIST_HEAD(&bdev->bd_holder_disks);
906 #endif
907         bdev->bd_stats = alloc_percpu(struct disk_stats);
908         if (!bdev->bd_stats) {
909                 iput(inode);
910                 return NULL;
911         }
912         return bdev;
913 }
914
915 void bdev_add(struct block_device *bdev, dev_t dev)
916 {
917         bdev->bd_dev = dev;
918         bdev->bd_inode->i_rdev = dev;
919         bdev->bd_inode->i_ino = dev;
920         insert_inode_hash(bdev->bd_inode);
921 }
922
923 static struct block_device *bdget(dev_t dev)
924 {
925         struct inode *inode;
926
927         inode = ilookup(blockdev_superblock, dev);
928         if (!inode)
929                 return NULL;
930         return &BDEV_I(inode)->bdev;
931 }
932
933 /**
934  * bdgrab -- Grab a reference to an already referenced block device
935  * @bdev:       Block device to grab a reference to.
936  *
937  * Returns the block_device with an additional reference when successful,
938  * or NULL if the inode is already beeing freed.
939  */
940 struct block_device *bdgrab(struct block_device *bdev)
941 {
942         if (!igrab(bdev->bd_inode))
943                 return NULL;
944         return bdev;
945 }
946 EXPORT_SYMBOL(bdgrab);
947
948 long nr_blockdev_pages(void)
949 {
950         struct inode *inode;
951         long ret = 0;
952
953         spin_lock(&blockdev_superblock->s_inode_list_lock);
954         list_for_each_entry(inode, &blockdev_superblock->s_inodes, i_sb_list)
955                 ret += inode->i_mapping->nrpages;
956         spin_unlock(&blockdev_superblock->s_inode_list_lock);
957
958         return ret;
959 }
960
961 void bdput(struct block_device *bdev)
962 {
963         iput(bdev->bd_inode);
964 }
965 EXPORT_SYMBOL(bdput);
966  
967 /**
968  * bd_may_claim - test whether a block device can be claimed
969  * @bdev: block device of interest
970  * @whole: whole block device containing @bdev, may equal @bdev
971  * @holder: holder trying to claim @bdev
972  *
973  * Test whether @bdev can be claimed by @holder.
974  *
975  * CONTEXT:
976  * spin_lock(&bdev_lock).
977  *
978  * RETURNS:
979  * %true if @bdev can be claimed, %false otherwise.
980  */
981 static bool bd_may_claim(struct block_device *bdev, struct block_device *whole,
982                          void *holder)
983 {
984         if (bdev->bd_holder == holder)
985                 return true;     /* already a holder */
986         else if (bdev->bd_holder != NULL)
987                 return false;    /* held by someone else */
988         else if (whole == bdev)
989                 return true;     /* is a whole device which isn't held */
990
991         else if (whole->bd_holder == bd_may_claim)
992                 return true;     /* is a partition of a device that is being partitioned */
993         else if (whole->bd_holder != NULL)
994                 return false;    /* is a partition of a held device */
995         else
996                 return true;     /* is a partition of an un-held device */
997 }
998
999 /**
1000  * bd_prepare_to_claim - claim a block device
1001  * @bdev: block device of interest
1002  * @holder: holder trying to claim @bdev
1003  *
1004  * Claim @bdev.  This function fails if @bdev is already claimed by another
1005  * holder and waits if another claiming is in progress. return, the caller
1006  * has ownership of bd_claiming and bd_holder[s].
1007  *
1008  * RETURNS:
1009  * 0 if @bdev can be claimed, -EBUSY otherwise.
1010  */
1011 int bd_prepare_to_claim(struct block_device *bdev, void *holder)
1012 {
1013         struct block_device *whole = bdev_whole(bdev);
1014
1015         if (WARN_ON_ONCE(!holder))
1016                 return -EINVAL;
1017 retry:
1018         spin_lock(&bdev_lock);
1019         /* if someone else claimed, fail */
1020         if (!bd_may_claim(bdev, whole, holder)) {
1021                 spin_unlock(&bdev_lock);
1022                 return -EBUSY;
1023         }
1024
1025         /* if claiming is already in progress, wait for it to finish */
1026         if (whole->bd_claiming) {
1027                 wait_queue_head_t *wq = bit_waitqueue(&whole->bd_claiming, 0);
1028                 DEFINE_WAIT(wait);
1029
1030                 prepare_to_wait(wq, &wait, TASK_UNINTERRUPTIBLE);
1031                 spin_unlock(&bdev_lock);
1032                 schedule();
1033                 finish_wait(wq, &wait);
1034                 goto retry;
1035         }
1036
1037         /* yay, all mine */
1038         whole->bd_claiming = holder;
1039         spin_unlock(&bdev_lock);
1040         return 0;
1041 }
1042 EXPORT_SYMBOL_GPL(bd_prepare_to_claim); /* only for the loop driver */
1043
1044 static void bd_clear_claiming(struct block_device *whole, void *holder)
1045 {
1046         lockdep_assert_held(&bdev_lock);
1047         /* tell others that we're done */
1048         BUG_ON(whole->bd_claiming != holder);
1049         whole->bd_claiming = NULL;
1050         wake_up_bit(&whole->bd_claiming, 0);
1051 }
1052
1053 /**
1054  * bd_finish_claiming - finish claiming of a block device
1055  * @bdev: block device of interest
1056  * @holder: holder that has claimed @bdev
1057  *
1058  * Finish exclusive open of a block device. Mark the device as exlusively
1059  * open by the holder and wake up all waiters for exclusive open to finish.
1060  */
1061 static void bd_finish_claiming(struct block_device *bdev, void *holder)
1062 {
1063         struct block_device *whole = bdev_whole(bdev);
1064
1065         spin_lock(&bdev_lock);
1066         BUG_ON(!bd_may_claim(bdev, whole, holder));
1067         /*
1068          * Note that for a whole device bd_holders will be incremented twice,
1069          * and bd_holder will be set to bd_may_claim before being set to holder
1070          */
1071         whole->bd_holders++;
1072         whole->bd_holder = bd_may_claim;
1073         bdev->bd_holders++;
1074         bdev->bd_holder = holder;
1075         bd_clear_claiming(whole, holder);
1076         spin_unlock(&bdev_lock);
1077 }
1078
1079 /**
1080  * bd_abort_claiming - abort claiming of a block device
1081  * @bdev: block device of interest
1082  * @holder: holder that has claimed @bdev
1083  *
1084  * Abort claiming of a block device when the exclusive open failed. This can be
1085  * also used when exclusive open is not actually desired and we just needed
1086  * to block other exclusive openers for a while.
1087  */
1088 void bd_abort_claiming(struct block_device *bdev, void *holder)
1089 {
1090         spin_lock(&bdev_lock);
1091         bd_clear_claiming(bdev_whole(bdev), holder);
1092         spin_unlock(&bdev_lock);
1093 }
1094 EXPORT_SYMBOL(bd_abort_claiming);
1095
1096 #ifdef CONFIG_SYSFS
1097 struct bd_holder_disk {
1098         struct list_head        list;
1099         struct gendisk          *disk;
1100         int                     refcnt;
1101 };
1102
1103 static struct bd_holder_disk *bd_find_holder_disk(struct block_device *bdev,
1104                                                   struct gendisk *disk)
1105 {
1106         struct bd_holder_disk *holder;
1107
1108         list_for_each_entry(holder, &bdev->bd_holder_disks, list)
1109                 if (holder->disk == disk)
1110                         return holder;
1111         return NULL;
1112 }
1113
1114 static int add_symlink(struct kobject *from, struct kobject *to)
1115 {
1116         return sysfs_create_link(from, to, kobject_name(to));
1117 }
1118
1119 static void del_symlink(struct kobject *from, struct kobject *to)
1120 {
1121         sysfs_remove_link(from, kobject_name(to));
1122 }
1123
1124 /**
1125  * bd_link_disk_holder - create symlinks between holding disk and slave bdev
1126  * @bdev: the claimed slave bdev
1127  * @disk: the holding disk
1128  *
1129  * DON'T USE THIS UNLESS YOU'RE ALREADY USING IT.
1130  *
1131  * This functions creates the following sysfs symlinks.
1132  *
1133  * - from "slaves" directory of the holder @disk to the claimed @bdev
1134  * - from "holders" directory of the @bdev to the holder @disk
1135  *
1136  * For example, if /dev/dm-0 maps to /dev/sda and disk for dm-0 is
1137  * passed to bd_link_disk_holder(), then:
1138  *
1139  *   /sys/block/dm-0/slaves/sda --> /sys/block/sda
1140  *   /sys/block/sda/holders/dm-0 --> /sys/block/dm-0
1141  *
1142  * The caller must have claimed @bdev before calling this function and
1143  * ensure that both @bdev and @disk are valid during the creation and
1144  * lifetime of these symlinks.
1145  *
1146  * CONTEXT:
1147  * Might sleep.
1148  *
1149  * RETURNS:
1150  * 0 on success, -errno on failure.
1151  */
1152 int bd_link_disk_holder(struct block_device *bdev, struct gendisk *disk)
1153 {
1154         struct bd_holder_disk *holder;
1155         int ret = 0;
1156
1157         mutex_lock(&bdev->bd_mutex);
1158
1159         WARN_ON_ONCE(!bdev->bd_holder);
1160
1161         /* FIXME: remove the following once add_disk() handles errors */
1162         if (WARN_ON(!disk->slave_dir || !bdev->bd_holder_dir))
1163                 goto out_unlock;
1164
1165         holder = bd_find_holder_disk(bdev, disk);
1166         if (holder) {
1167                 holder->refcnt++;
1168                 goto out_unlock;
1169         }
1170
1171         holder = kzalloc(sizeof(*holder), GFP_KERNEL);
1172         if (!holder) {
1173                 ret = -ENOMEM;
1174                 goto out_unlock;
1175         }
1176
1177         INIT_LIST_HEAD(&holder->list);
1178         holder->disk = disk;
1179         holder->refcnt = 1;
1180
1181         ret = add_symlink(disk->slave_dir, bdev_kobj(bdev));
1182         if (ret)
1183                 goto out_free;
1184
1185         ret = add_symlink(bdev->bd_holder_dir, &disk_to_dev(disk)->kobj);
1186         if (ret)
1187                 goto out_del;
1188         /*
1189          * bdev could be deleted beneath us which would implicitly destroy
1190          * the holder directory.  Hold on to it.
1191          */
1192         kobject_get(bdev->bd_holder_dir);
1193
1194         list_add(&holder->list, &bdev->bd_holder_disks);
1195         goto out_unlock;
1196
1197 out_del:
1198         del_symlink(disk->slave_dir, bdev_kobj(bdev));
1199 out_free:
1200         kfree(holder);
1201 out_unlock:
1202         mutex_unlock(&bdev->bd_mutex);
1203         return ret;
1204 }
1205 EXPORT_SYMBOL_GPL(bd_link_disk_holder);
1206
1207 /**
1208  * bd_unlink_disk_holder - destroy symlinks created by bd_link_disk_holder()
1209  * @bdev: the calimed slave bdev
1210  * @disk: the holding disk
1211  *
1212  * DON'T USE THIS UNLESS YOU'RE ALREADY USING IT.
1213  *
1214  * CONTEXT:
1215  * Might sleep.
1216  */
1217 void bd_unlink_disk_holder(struct block_device *bdev, struct gendisk *disk)
1218 {
1219         struct bd_holder_disk *holder;
1220
1221         mutex_lock(&bdev->bd_mutex);
1222
1223         holder = bd_find_holder_disk(bdev, disk);
1224
1225         if (!WARN_ON_ONCE(holder == NULL) && !--holder->refcnt) {
1226                 del_symlink(disk->slave_dir, bdev_kobj(bdev));
1227                 del_symlink(bdev->bd_holder_dir, &disk_to_dev(disk)->kobj);
1228                 kobject_put(bdev->bd_holder_dir);
1229                 list_del_init(&holder->list);
1230                 kfree(holder);
1231         }
1232
1233         mutex_unlock(&bdev->bd_mutex);
1234 }
1235 EXPORT_SYMBOL_GPL(bd_unlink_disk_holder);
1236 #endif
1237
1238 static void __blkdev_put(struct block_device *bdev, fmode_t mode, int for_part);
1239
1240 int bdev_disk_changed(struct block_device *bdev, bool invalidate)
1241 {
1242         struct gendisk *disk = bdev->bd_disk;
1243         int ret = 0;
1244
1245         lockdep_assert_held(&bdev->bd_mutex);
1246
1247         if (!(disk->flags & GENHD_FL_UP))
1248                 return -ENXIO;
1249
1250 rescan:
1251         if (bdev->bd_part_count)
1252                 return -EBUSY;
1253         sync_blockdev(bdev);
1254         invalidate_bdev(bdev);
1255         blk_drop_partitions(disk);
1256
1257         clear_bit(GD_NEED_PART_SCAN, &disk->state);
1258
1259         /*
1260          * Historically we only set the capacity to zero for devices that
1261          * support partitions (independ of actually having partitions created).
1262          * Doing that is rather inconsistent, but changing it broke legacy
1263          * udisks polling for legacy ide-cdrom devices.  Use the crude check
1264          * below to get the sane behavior for most device while not breaking
1265          * userspace for this particular setup.
1266          */
1267         if (invalidate) {
1268                 if (disk_part_scan_enabled(disk) ||
1269                     !(disk->flags & GENHD_FL_REMOVABLE))
1270                         set_capacity(disk, 0);
1271         }
1272
1273         if (get_capacity(disk)) {
1274                 ret = blk_add_partitions(disk, bdev);
1275                 if (ret == -EAGAIN)
1276                         goto rescan;
1277         } else if (invalidate) {
1278                 /*
1279                  * Tell userspace that the media / partition table may have
1280                  * changed.
1281                  */
1282                 kobject_uevent(&disk_to_dev(disk)->kobj, KOBJ_CHANGE);
1283         }
1284
1285         return ret;
1286 }
1287 /*
1288  * Only exported for loop and dasd for historic reasons.  Don't use in new
1289  * code!
1290  */
1291 EXPORT_SYMBOL_GPL(bdev_disk_changed);
1292
1293 /*
1294  * bd_mutex locking:
1295  *
1296  *  mutex_lock(part->bd_mutex)
1297  *    mutex_lock_nested(whole->bd_mutex, 1)
1298  */
1299 static int __blkdev_get(struct block_device *bdev, fmode_t mode)
1300 {
1301         struct gendisk *disk = bdev->bd_disk;
1302         int ret = 0;
1303
1304         if (!(disk->flags & GENHD_FL_UP))
1305                 return -ENXIO;
1306
1307         if (!bdev->bd_openers) {
1308                 if (!bdev_is_partition(bdev)) {
1309                         ret = 0;
1310                         if (disk->fops->open)
1311                                 ret = disk->fops->open(bdev, mode);
1312
1313                         if (!ret)
1314                                 set_init_blocksize(bdev);
1315
1316                         /*
1317                          * If the device is invalidated, rescan partition
1318                          * if open succeeded or failed with -ENOMEDIUM.
1319                          * The latter is necessary to prevent ghost
1320                          * partitions on a removed medium.
1321                          */
1322                         if (test_bit(GD_NEED_PART_SCAN, &disk->state) &&
1323                             (!ret || ret == -ENOMEDIUM))
1324                                 bdev_disk_changed(bdev, ret == -ENOMEDIUM);
1325
1326                         if (ret)
1327                                 return ret;
1328                 } else {
1329                         struct block_device *whole = bdgrab(disk->part0);
1330
1331                         mutex_lock_nested(&whole->bd_mutex, 1);
1332                         ret = __blkdev_get(whole, mode);
1333                         if (ret) {
1334                                 mutex_unlock(&whole->bd_mutex);
1335                                 bdput(whole);
1336                                 return ret;
1337                         }
1338                         whole->bd_part_count++;
1339                         mutex_unlock(&whole->bd_mutex);
1340
1341                         if (!bdev_nr_sectors(bdev)) {
1342                                 __blkdev_put(whole, mode, 1);
1343                                 bdput(whole);
1344                                 return -ENXIO;
1345                         }
1346                         set_init_blocksize(bdev);
1347                 }
1348
1349                 if (bdev->bd_bdi == &noop_backing_dev_info)
1350                         bdev->bd_bdi = bdi_get(disk->queue->backing_dev_info);
1351         } else {
1352                 if (!bdev_is_partition(bdev)) {
1353                         if (bdev->bd_disk->fops->open)
1354                                 ret = bdev->bd_disk->fops->open(bdev, mode);
1355                         /* the same as first opener case, read comment there */
1356                         if (test_bit(GD_NEED_PART_SCAN, &disk->state) &&
1357                             (!ret || ret == -ENOMEDIUM))
1358                                 bdev_disk_changed(bdev, ret == -ENOMEDIUM);
1359                         if (ret)
1360                                 return ret;
1361                 }
1362         }
1363         bdev->bd_openers++;
1364         return 0;
1365 }
1366
1367 struct block_device *blkdev_get_no_open(dev_t dev)
1368 {
1369         struct block_device *bdev;
1370         struct gendisk *disk;
1371
1372         bdev = bdget(dev);
1373         if (!bdev) {
1374                 blk_request_module(dev);
1375                 bdev = bdget(dev);
1376                 if (!bdev)
1377                         return NULL;
1378         }
1379
1380         disk = bdev->bd_disk;
1381         if (!kobject_get_unless_zero(&disk_to_dev(disk)->kobj))
1382                 goto bdput;
1383         if ((disk->flags & (GENHD_FL_UP | GENHD_FL_HIDDEN)) != GENHD_FL_UP)
1384                 goto put_disk;
1385         if (!try_module_get(bdev->bd_disk->fops->owner))
1386                 goto put_disk;
1387         return bdev;
1388 put_disk:
1389         put_disk(disk);
1390 bdput:
1391         bdput(bdev);
1392         return NULL;
1393 }
1394
1395 void blkdev_put_no_open(struct block_device *bdev)
1396 {
1397         module_put(bdev->bd_disk->fops->owner);
1398         put_disk(bdev->bd_disk);
1399         bdput(bdev);
1400 }
1401
1402 /**
1403  * blkdev_get_by_dev - open a block device by device number
1404  * @dev: device number of block device to open
1405  * @mode: FMODE_* mask
1406  * @holder: exclusive holder identifier
1407  *
1408  * Open the block device described by device number @dev. If @mode includes
1409  * %FMODE_EXCL, the block device is opened with exclusive access.  Specifying
1410  * %FMODE_EXCL with a %NULL @holder is invalid.  Exclusive opens may nest for
1411  * the same @holder.
1412  *
1413  * Use this interface ONLY if you really do not have anything better - i.e. when
1414  * you are behind a truly sucky interface and all you are given is a device
1415  * number.  Everything else should use blkdev_get_by_path().
1416  *
1417  * CONTEXT:
1418  * Might sleep.
1419  *
1420  * RETURNS:
1421  * Reference to the block_device on success, ERR_PTR(-errno) on failure.
1422  */
1423 struct block_device *blkdev_get_by_dev(dev_t dev, fmode_t mode, void *holder)
1424 {
1425         bool unblock_events = true;
1426         struct block_device *bdev;
1427         struct gendisk *disk;
1428         int ret;
1429
1430         ret = devcgroup_check_permission(DEVCG_DEV_BLOCK,
1431                         MAJOR(dev), MINOR(dev),
1432                         ((mode & FMODE_READ) ? DEVCG_ACC_READ : 0) |
1433                         ((mode & FMODE_WRITE) ? DEVCG_ACC_WRITE : 0));
1434         if (ret)
1435                 return ERR_PTR(ret);
1436
1437         bdev = blkdev_get_no_open(dev);
1438         if (!bdev)
1439                 return ERR_PTR(-ENXIO);
1440         disk = bdev->bd_disk;
1441
1442         if (mode & FMODE_EXCL) {
1443                 ret = bd_prepare_to_claim(bdev, holder);
1444                 if (ret)
1445                         goto put_blkdev;
1446         }
1447
1448         disk_block_events(disk);
1449
1450         mutex_lock(&bdev->bd_mutex);
1451         ret =__blkdev_get(bdev, mode);
1452         if (ret)
1453                 goto abort_claiming;
1454         if (mode & FMODE_EXCL) {
1455                 bd_finish_claiming(bdev, holder);
1456
1457                 /*
1458                  * Block event polling for write claims if requested.  Any write
1459                  * holder makes the write_holder state stick until all are
1460                  * released.  This is good enough and tracking individual
1461                  * writeable reference is too fragile given the way @mode is
1462                  * used in blkdev_get/put().
1463                  */
1464                 if ((mode & FMODE_WRITE) && !bdev->bd_write_holder &&
1465                     (disk->flags & GENHD_FL_BLOCK_EVENTS_ON_EXCL_WRITE)) {
1466                         bdev->bd_write_holder = true;
1467                         unblock_events = false;
1468                 }
1469         }
1470         mutex_unlock(&bdev->bd_mutex);
1471
1472         if (unblock_events)
1473                 disk_unblock_events(disk);
1474         return bdev;
1475
1476 abort_claiming:
1477         if (mode & FMODE_EXCL)
1478                 bd_abort_claiming(bdev, holder);
1479         mutex_unlock(&bdev->bd_mutex);
1480         disk_unblock_events(disk);
1481 put_blkdev:
1482         blkdev_put_no_open(bdev);
1483         return ERR_PTR(ret);
1484 }
1485 EXPORT_SYMBOL(blkdev_get_by_dev);
1486
1487 /**
1488  * blkdev_get_by_path - open a block device by name
1489  * @path: path to the block device to open
1490  * @mode: FMODE_* mask
1491  * @holder: exclusive holder identifier
1492  *
1493  * Open the block device described by the device file at @path.  If @mode
1494  * includes %FMODE_EXCL, the block device is opened with exclusive access.
1495  * Specifying %FMODE_EXCL with a %NULL @holder is invalid.  Exclusive opens may
1496  * nest for the same @holder.
1497  *
1498  * CONTEXT:
1499  * Might sleep.
1500  *
1501  * RETURNS:
1502  * Reference to the block_device on success, ERR_PTR(-errno) on failure.
1503  */
1504 struct block_device *blkdev_get_by_path(const char *path, fmode_t mode,
1505                                         void *holder)
1506 {
1507         struct block_device *bdev;
1508         dev_t dev;
1509         int error;
1510
1511         error = lookup_bdev(path, &dev);
1512         if (error)
1513                 return ERR_PTR(error);
1514
1515         bdev = blkdev_get_by_dev(dev, mode, holder);
1516         if (!IS_ERR(bdev) && (mode & FMODE_WRITE) && bdev_read_only(bdev)) {
1517                 blkdev_put(bdev, mode);
1518                 return ERR_PTR(-EACCES);
1519         }
1520
1521         return bdev;
1522 }
1523 EXPORT_SYMBOL(blkdev_get_by_path);
1524
1525 static int blkdev_open(struct inode * inode, struct file * filp)
1526 {
1527         struct block_device *bdev;
1528
1529         /*
1530          * Preserve backwards compatibility and allow large file access
1531          * even if userspace doesn't ask for it explicitly. Some mkfs
1532          * binary needs it. We might want to drop this workaround
1533          * during an unstable branch.
1534          */
1535         filp->f_flags |= O_LARGEFILE;
1536
1537         filp->f_mode |= FMODE_NOWAIT | FMODE_BUF_RASYNC;
1538
1539         if (filp->f_flags & O_NDELAY)
1540                 filp->f_mode |= FMODE_NDELAY;
1541         if (filp->f_flags & O_EXCL)
1542                 filp->f_mode |= FMODE_EXCL;
1543         if ((filp->f_flags & O_ACCMODE) == 3)
1544                 filp->f_mode |= FMODE_WRITE_IOCTL;
1545
1546         bdev = blkdev_get_by_dev(inode->i_rdev, filp->f_mode, filp);
1547         if (IS_ERR(bdev))
1548                 return PTR_ERR(bdev);
1549         filp->f_mapping = bdev->bd_inode->i_mapping;
1550         filp->f_wb_err = filemap_sample_wb_err(filp->f_mapping);
1551         return 0;
1552 }
1553
1554 static void __blkdev_put(struct block_device *bdev, fmode_t mode, int for_part)
1555 {
1556         struct gendisk *disk = bdev->bd_disk;
1557         struct block_device *victim = NULL;
1558
1559         /*
1560          * Sync early if it looks like we're the last one.  If someone else
1561          * opens the block device between now and the decrement of bd_openers
1562          * then we did a sync that we didn't need to, but that's not the end
1563          * of the world and we want to avoid long (could be several minute)
1564          * syncs while holding the mutex.
1565          */
1566         if (bdev->bd_openers == 1)
1567                 sync_blockdev(bdev);
1568
1569         mutex_lock_nested(&bdev->bd_mutex, for_part);
1570         if (for_part)
1571                 bdev->bd_part_count--;
1572
1573         if (!--bdev->bd_openers) {
1574                 WARN_ON_ONCE(bdev->bd_holders);
1575                 sync_blockdev(bdev);
1576                 kill_bdev(bdev);
1577                 bdev_write_inode(bdev);
1578                 if (bdev_is_partition(bdev))
1579                         victim = bdev_whole(bdev);
1580         }
1581
1582         if (!bdev_is_partition(bdev) && disk->fops->release)
1583                 disk->fops->release(disk, mode);
1584         mutex_unlock(&bdev->bd_mutex);
1585         if (victim) {
1586                 __blkdev_put(victim, mode, 1);
1587                 bdput(victim);
1588         }
1589 }
1590
1591 void blkdev_put(struct block_device *bdev, fmode_t mode)
1592 {
1593         struct gendisk *disk = bdev->bd_disk;
1594
1595         mutex_lock(&bdev->bd_mutex);
1596
1597         if (mode & FMODE_EXCL) {
1598                 struct block_device *whole = bdev_whole(bdev);
1599                 bool bdev_free;
1600
1601                 /*
1602                  * Release a claim on the device.  The holder fields
1603                  * are protected with bdev_lock.  bd_mutex is to
1604                  * synchronize disk_holder unlinking.
1605                  */
1606                 spin_lock(&bdev_lock);
1607
1608                 WARN_ON_ONCE(--bdev->bd_holders < 0);
1609                 WARN_ON_ONCE(--whole->bd_holders < 0);
1610
1611                 if ((bdev_free = !bdev->bd_holders))
1612                         bdev->bd_holder = NULL;
1613                 if (!whole->bd_holders)
1614                         whole->bd_holder = NULL;
1615
1616                 spin_unlock(&bdev_lock);
1617
1618                 /*
1619                  * If this was the last claim, remove holder link and
1620                  * unblock evpoll if it was a write holder.
1621                  */
1622                 if (bdev_free && bdev->bd_write_holder) {
1623                         disk_unblock_events(disk);
1624                         bdev->bd_write_holder = false;
1625                 }
1626         }
1627
1628         /*
1629          * Trigger event checking and tell drivers to flush MEDIA_CHANGE
1630          * event.  This is to ensure detection of media removal commanded
1631          * from userland - e.g. eject(1).
1632          */
1633         disk_flush_events(disk, DISK_EVENT_MEDIA_CHANGE);
1634         mutex_unlock(&bdev->bd_mutex);
1635
1636         __blkdev_put(bdev, mode, 0);
1637         blkdev_put_no_open(bdev);
1638 }
1639 EXPORT_SYMBOL(blkdev_put);
1640
1641 static int blkdev_close(struct inode * inode, struct file * filp)
1642 {
1643         struct block_device *bdev = I_BDEV(bdev_file_inode(filp));
1644         blkdev_put(bdev, filp->f_mode);
1645         return 0;
1646 }
1647
1648 static long block_ioctl(struct file *file, unsigned cmd, unsigned long arg)
1649 {
1650         struct block_device *bdev = I_BDEV(bdev_file_inode(file));
1651         fmode_t mode = file->f_mode;
1652
1653         /*
1654          * O_NDELAY can be altered using fcntl(.., F_SETFL, ..), so we have
1655          * to updated it before every ioctl.
1656          */
1657         if (file->f_flags & O_NDELAY)
1658                 mode |= FMODE_NDELAY;
1659         else
1660                 mode &= ~FMODE_NDELAY;
1661
1662         return blkdev_ioctl(bdev, mode, cmd, arg);
1663 }
1664
1665 /*
1666  * Write data to the block device.  Only intended for the block device itself
1667  * and the raw driver which basically is a fake block device.
1668  *
1669  * Does not take i_mutex for the write and thus is not for general purpose
1670  * use.
1671  */
1672 ssize_t blkdev_write_iter(struct kiocb *iocb, struct iov_iter *from)
1673 {
1674         struct file *file = iocb->ki_filp;
1675         struct inode *bd_inode = bdev_file_inode(file);
1676         loff_t size = i_size_read(bd_inode);
1677         struct blk_plug plug;
1678         size_t shorted = 0;
1679         ssize_t ret;
1680
1681         if (bdev_read_only(I_BDEV(bd_inode)))
1682                 return -EPERM;
1683
1684         if (IS_SWAPFILE(bd_inode) && !is_hibernate_resume_dev(bd_inode->i_rdev))
1685                 return -ETXTBSY;
1686
1687         if (!iov_iter_count(from))
1688                 return 0;
1689
1690         if (iocb->ki_pos >= size)
1691                 return -ENOSPC;
1692
1693         if ((iocb->ki_flags & (IOCB_NOWAIT | IOCB_DIRECT)) == IOCB_NOWAIT)
1694                 return -EOPNOTSUPP;
1695
1696         size -= iocb->ki_pos;
1697         if (iov_iter_count(from) > size) {
1698                 shorted = iov_iter_count(from) - size;
1699                 iov_iter_truncate(from, size);
1700         }
1701
1702         blk_start_plug(&plug);
1703         ret = __generic_file_write_iter(iocb, from);
1704         if (ret > 0)
1705                 ret = generic_write_sync(iocb, ret);
1706         iov_iter_reexpand(from, iov_iter_count(from) + shorted);
1707         blk_finish_plug(&plug);
1708         return ret;
1709 }
1710 EXPORT_SYMBOL_GPL(blkdev_write_iter);
1711
1712 ssize_t blkdev_read_iter(struct kiocb *iocb, struct iov_iter *to)
1713 {
1714         struct file *file = iocb->ki_filp;
1715         struct inode *bd_inode = bdev_file_inode(file);
1716         loff_t size = i_size_read(bd_inode);
1717         loff_t pos = iocb->ki_pos;
1718         size_t shorted = 0;
1719         ssize_t ret;
1720
1721         if (pos >= size)
1722                 return 0;
1723
1724         size -= pos;
1725         if (iov_iter_count(to) > size) {
1726                 shorted = iov_iter_count(to) - size;
1727                 iov_iter_truncate(to, size);
1728         }
1729
1730         ret = generic_file_read_iter(iocb, to);
1731         iov_iter_reexpand(to, iov_iter_count(to) + shorted);
1732         return ret;
1733 }
1734 EXPORT_SYMBOL_GPL(blkdev_read_iter);
1735
1736 /*
1737  * Try to release a page associated with block device when the system
1738  * is under memory pressure.
1739  */
1740 static int blkdev_releasepage(struct page *page, gfp_t wait)
1741 {
1742         struct super_block *super = BDEV_I(page->mapping->host)->bdev.bd_super;
1743
1744         if (super && super->s_op->bdev_try_to_free_page)
1745                 return super->s_op->bdev_try_to_free_page(super, page, wait);
1746
1747         return try_to_free_buffers(page);
1748 }
1749
1750 static int blkdev_writepages(struct address_space *mapping,
1751                              struct writeback_control *wbc)
1752 {
1753         return generic_writepages(mapping, wbc);
1754 }
1755
1756 static const struct address_space_operations def_blk_aops = {
1757         .readpage       = blkdev_readpage,
1758         .readahead      = blkdev_readahead,
1759         .writepage      = blkdev_writepage,
1760         .write_begin    = blkdev_write_begin,
1761         .write_end      = blkdev_write_end,
1762         .writepages     = blkdev_writepages,
1763         .releasepage    = blkdev_releasepage,
1764         .direct_IO      = blkdev_direct_IO,
1765         .migratepage    = buffer_migrate_page_norefs,
1766         .is_dirty_writeback = buffer_check_dirty_writeback,
1767 };
1768
1769 #define BLKDEV_FALLOC_FL_SUPPORTED                                      \
1770                 (FALLOC_FL_KEEP_SIZE | FALLOC_FL_PUNCH_HOLE |           \
1771                  FALLOC_FL_ZERO_RANGE | FALLOC_FL_NO_HIDE_STALE)
1772
1773 static long blkdev_fallocate(struct file *file, int mode, loff_t start,
1774                              loff_t len)
1775 {
1776         struct block_device *bdev = I_BDEV(bdev_file_inode(file));
1777         loff_t end = start + len - 1;
1778         loff_t isize;
1779         int error;
1780
1781         /* Fail if we don't recognize the flags. */
1782         if (mode & ~BLKDEV_FALLOC_FL_SUPPORTED)
1783                 return -EOPNOTSUPP;
1784
1785         /* Don't go off the end of the device. */
1786         isize = i_size_read(bdev->bd_inode);
1787         if (start >= isize)
1788                 return -EINVAL;
1789         if (end >= isize) {
1790                 if (mode & FALLOC_FL_KEEP_SIZE) {
1791                         len = isize - start;
1792                         end = start + len - 1;
1793                 } else
1794                         return -EINVAL;
1795         }
1796
1797         /*
1798          * Don't allow IO that isn't aligned to logical block size.
1799          */
1800         if ((start | len) & (bdev_logical_block_size(bdev) - 1))
1801                 return -EINVAL;
1802
1803         /* Invalidate the page cache, including dirty pages. */
1804         error = truncate_bdev_range(bdev, file->f_mode, start, end);
1805         if (error)
1806                 return error;
1807
1808         switch (mode) {
1809         case FALLOC_FL_ZERO_RANGE:
1810         case FALLOC_FL_ZERO_RANGE | FALLOC_FL_KEEP_SIZE:
1811                 error = blkdev_issue_zeroout(bdev, start >> 9, len >> 9,
1812                                             GFP_KERNEL, BLKDEV_ZERO_NOUNMAP);
1813                 break;
1814         case FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE:
1815                 error = blkdev_issue_zeroout(bdev, start >> 9, len >> 9,
1816                                              GFP_KERNEL, BLKDEV_ZERO_NOFALLBACK);
1817                 break;
1818         case FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE | FALLOC_FL_NO_HIDE_STALE:
1819                 error = blkdev_issue_discard(bdev, start >> 9, len >> 9,
1820                                              GFP_KERNEL, 0);
1821                 break;
1822         default:
1823                 return -EOPNOTSUPP;
1824         }
1825         if (error)
1826                 return error;
1827
1828         /*
1829          * Invalidate the page cache again; if someone wandered in and dirtied
1830          * a page, we just discard it - userspace has no way of knowing whether
1831          * the write happened before or after discard completing...
1832          */
1833         return truncate_bdev_range(bdev, file->f_mode, start, end);
1834 }
1835
1836 const struct file_operations def_blk_fops = {
1837         .open           = blkdev_open,
1838         .release        = blkdev_close,
1839         .llseek         = block_llseek,
1840         .read_iter      = blkdev_read_iter,
1841         .write_iter     = blkdev_write_iter,
1842         .iopoll         = blkdev_iopoll,
1843         .mmap           = generic_file_mmap,
1844         .fsync          = blkdev_fsync,
1845         .unlocked_ioctl = block_ioctl,
1846 #ifdef CONFIG_COMPAT
1847         .compat_ioctl   = compat_blkdev_ioctl,
1848 #endif
1849         .splice_read    = generic_file_splice_read,
1850         .splice_write   = iter_file_splice_write,
1851         .fallocate      = blkdev_fallocate,
1852 };
1853
1854 /**
1855  * lookup_bdev  - lookup a struct block_device by name
1856  * @pathname:   special file representing the block device
1857  * @dev:        return value of the block device's dev_t
1858  *
1859  * Get a reference to the blockdevice at @pathname in the current
1860  * namespace if possible and return it.  Return ERR_PTR(error)
1861  * otherwise.
1862  */
1863 int lookup_bdev(const char *pathname, dev_t *dev)
1864 {
1865         struct inode *inode;
1866         struct path path;
1867         int error;
1868
1869         if (!pathname || !*pathname)
1870                 return -EINVAL;
1871
1872         error = kern_path(pathname, LOOKUP_FOLLOW, &path);
1873         if (error)
1874                 return error;
1875
1876         inode = d_backing_inode(path.dentry);
1877         error = -ENOTBLK;
1878         if (!S_ISBLK(inode->i_mode))
1879                 goto out_path_put;
1880         error = -EACCES;
1881         if (!may_open_dev(&path))
1882                 goto out_path_put;
1883
1884         *dev = inode->i_rdev;
1885         error = 0;
1886 out_path_put:
1887         path_put(&path);
1888         return error;
1889 }
1890 EXPORT_SYMBOL(lookup_bdev);
1891
1892 int __invalidate_device(struct block_device *bdev, bool kill_dirty)
1893 {
1894         struct super_block *sb = get_super(bdev);
1895         int res = 0;
1896
1897         if (sb) {
1898                 /*
1899                  * no need to lock the super, get_super holds the
1900                  * read mutex so the filesystem cannot go away
1901                  * under us (->put_super runs with the write lock
1902                  * hold).
1903                  */
1904                 shrink_dcache_sb(sb);
1905                 res = invalidate_inodes(sb, kill_dirty);
1906                 drop_super(sb);
1907         }
1908         invalidate_bdev(bdev);
1909         return res;
1910 }
1911 EXPORT_SYMBOL(__invalidate_device);
1912
1913 void iterate_bdevs(void (*func)(struct block_device *, void *), void *arg)
1914 {
1915         struct inode *inode, *old_inode = NULL;
1916
1917         spin_lock(&blockdev_superblock->s_inode_list_lock);
1918         list_for_each_entry(inode, &blockdev_superblock->s_inodes, i_sb_list) {
1919                 struct address_space *mapping = inode->i_mapping;
1920                 struct block_device *bdev;
1921
1922                 spin_lock(&inode->i_lock);
1923                 if (inode->i_state & (I_FREEING|I_WILL_FREE|I_NEW) ||
1924                     mapping->nrpages == 0) {
1925                         spin_unlock(&inode->i_lock);
1926                         continue;
1927                 }
1928                 __iget(inode);
1929                 spin_unlock(&inode->i_lock);
1930                 spin_unlock(&blockdev_superblock->s_inode_list_lock);
1931                 /*
1932                  * We hold a reference to 'inode' so it couldn't have been
1933                  * removed from s_inodes list while we dropped the
1934                  * s_inode_list_lock  We cannot iput the inode now as we can
1935                  * be holding the last reference and we cannot iput it under
1936                  * s_inode_list_lock. So we keep the reference and iput it
1937                  * later.
1938                  */
1939                 iput(old_inode);
1940                 old_inode = inode;
1941                 bdev = I_BDEV(inode);
1942
1943                 mutex_lock(&bdev->bd_mutex);
1944                 if (bdev->bd_openers)
1945                         func(bdev, arg);
1946                 mutex_unlock(&bdev->bd_mutex);
1947
1948                 spin_lock(&blockdev_superblock->s_inode_list_lock);
1949         }
1950         spin_unlock(&blockdev_superblock->s_inode_list_lock);
1951         iput(old_inode);
1952 }