btrfs: better document struct btrfs_bio

Update the comments on btrfs_bio to better describe the structure.

Reviewed-by: Anand Jain <anand.jain@oracle.com>
Reviewed-by: Johannes Thumshirn <johannes.thumshirn@wdc.com>
Signed-off-by: Christoph Hellwig <hch@lst.de>
Reviewed-by: David Sterba <dsterba@suse.com>
Signed-off-by: David Sterba <dsterba@suse.com>
This commit is contained in:
Christoph Hellwig 2023-01-21 07:49:59 +01:00 committed by David Sterba
parent fd8f8ede23
commit e0cfbb2cca

View File

@ -26,9 +26,8 @@ struct btrfs_fs_info;
typedef void (*btrfs_bio_end_io_t)(struct btrfs_bio *bbio); typedef void (*btrfs_bio_end_io_t)(struct btrfs_bio *bbio);
/* /*
* Additional info to pass along bio. * Highlevel btrfs I/O structure. It is allocated by btrfs_bio_alloc and
* * passed to btrfs_submit_bio for mapping to the physical devices.
* Mostly for btrfs specific features like csum and mirror_num.
*/ */
struct btrfs_bio { struct btrfs_bio {
unsigned int mirror_num:7; unsigned int mirror_num:7;
@ -42,7 +41,7 @@ struct btrfs_bio {
unsigned int is_metadata:1; unsigned int is_metadata:1;
struct bvec_iter iter; struct bvec_iter iter;
/* for direct I/O */ /* File offset that this I/O operates on. */
u64 file_offset; u64 file_offset;
/* @device is for stripe IO submission. */ /* @device is for stripe IO submission. */
@ -62,7 +61,7 @@ struct btrfs_bio {
btrfs_bio_end_io_t end_io; btrfs_bio_end_io_t end_io;
void *private; void *private;
/* For read end I/O handling */ /* For internal use in read end I/O handling */
struct work_struct end_io_work; struct work_struct end_io_work;
/* /*