fs/btrfs/bio.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * Copyright (C) 2007 Oracle.  All rights reserved.
   4  * Copyright (C) 2022 Christoph Hellwig.
   5  */
   6
   7 #ifndef BTRFS_BIO_H
   8 #define BTRFS_BIO_H
   9
  10 #include <linux/bio.h>
  11 #include <linux/workqueue.h>
  12 #include "tree-checker.h"
  13
  14 struct btrfs_bio;
  15 struct btrfs_fs_info;
  16
  17 #define BTRFS_BIO_INLINE_CSUM_SIZE      64
  18
  19 /*
  20  * Maximum number of sectors for a single bio to limit the size of the
  21  * checksum array.  This matches the number of bio_vecs per bio and thus the
  22  * I/O size for buffered I/O.
  23  */
  24 #define BTRFS_MAX_BIO_SECTORS           (256)
  25
  26 typedef void (*btrfs_bio_end_io_t)(struct btrfs_bio *bbio);
  27
  28 /*
  29  * Highlevel btrfs I/O structure.  It is allocated by btrfs_bio_alloc and
  30  * passed to btrfs_submit_bio for mapping to the physical devices.
  31  */
  32 struct btrfs_bio {
  33         /*
  34          * Inode and offset into it that this I/O operates on.
  35          * Only set for data I/O.
  36          */
  37         struct btrfs_inode *inode;
  38         u64 file_offset;
  39
  40         union {
  41                 /*
  42                  * Data checksumming and original I/O information for internal
  43                  * use in the btrfs_submit_bio machinery.
  44                  */
  45                 struct {
  46                         u8 *csum;
  47                         u8 csum_inline[BTRFS_BIO_INLINE_CSUM_SIZE];
  48                         struct bvec_iter saved_iter;
  49                 };
  50
  51                 /* For metadata parentness verification. */
  52                 struct btrfs_tree_parent_check parent_check;
  53         };
  54
  55         /* End I/O information supplied to btrfs_bio_alloc */
  56         btrfs_bio_end_io_t end_io;
  57         void *private;
  58
  59         /* For internal use in read end I/O handling */
  60         unsigned int mirror_num;
  61         atomic_t pending_ios;
  62         struct work_struct end_io_work;
  63
  64         /* File system that this I/O operates on. */
  65         struct btrfs_fs_info *fs_info;
  66
  67         /*
  68          * This member must come last, bio_alloc_bioset will allocate enough
  69          * bytes for entire btrfs_bio but relies on bio being last.
  70          */
  71         struct bio bio;
  72 };
  73
  74 static inline struct btrfs_bio *btrfs_bio(struct bio *bio)
  75 {
  76         return container_of(bio, struct btrfs_bio, bio);
  77 }
  78
  79 int __init btrfs_bioset_init(void);
  80 void __cold btrfs_bioset_exit(void);
  81
  82 void btrfs_bio_init(struct btrfs_bio *bbio, struct btrfs_fs_info *fs_info,
  83                     btrfs_bio_end_io_t end_io, void *private);
  84 struct btrfs_bio *btrfs_bio_alloc(unsigned int nr_vecs, blk_opf_t opf,
  85                                   struct btrfs_fs_info *fs_info,
  86                                   btrfs_bio_end_io_t end_io, void *private);
  87
  88 static inline void btrfs_bio_end_io(struct btrfs_bio *bbio, blk_status_t status)
  89 {
  90         bbio->bio.bi_status = status;
  91         bbio->end_io(bbio);
  92 }
  93
  94 /* Bio only refers to one ordered extent. */
  95 #define REQ_BTRFS_ONE_ORDERED                   REQ_DRV
  96
  97 /* Submit using blkcg_punt_bio_submit. */
  98 #define REQ_BTRFS_CGROUP_PUNT                   REQ_FS_PRIVATE
  99
 100 void btrfs_submit_bio(struct btrfs_bio *bbio, int mirror_num);
 101 void btrfs_submit_repair_write(struct btrfs_bio *bbio, int mirror_num, bool dev_replace);
 102 int btrfs_repair_io_failure(struct btrfs_fs_info *fs_info, u64 ino, u64 start,
 103                             u64 length, u64 logical, struct page *page,
 104                             unsigned int pg_offset, int mirror_num);
 105
 106 #endif