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