From: Ming Lei <ming.lei@redhat.com>
To: Jens Axboe <axboe@kernel.dk>
Cc: linux-block@vger.kernel.org, linux-kernel@vger.kernel.org,
linux-mm@kvack.org, Theodore Ts'o <tytso@mit.edu>,
Omar Sandoval <osandov@fb.com>, Sagi Grimberg <sagi@grimberg.me>,
Dave Chinner <dchinner@redhat.com>,
Kent Overstreet <kent.overstreet@gmail.com>,
Mike Snitzer <snitzer@redhat.com>,
dm-devel@redhat.com, Alexander Viro <viro@zeniv.linux.org.uk>,
linux-fsdevel@vger.kernel.org, Shaohua Li <shli@kernel.org>,
linux-raid@vger.kernel.org, David Sterba <dsterba@suse.com>,
linux-btrfs@vger.kernel.org,
"Darrick J . Wong" <darrick.wong@oracle.com>,
linux-xfs@vger.kernel.org, Gao Xiang <gaoxiang25@huawei.com>,
Christoph Hellwig <hch@lst.de>,
linux-ext4@vger.kernel.org, Coly Li <colyli@suse.de>,
linux-bcache@vger.kernel.org,
Boaz Harrosh <ooo@electrozaur.com>Bo
Subject: [PATCH V12 18/20] block: document usage of bio iterator helpers
Date: Mon, 26 Nov 2018 10:17:18 +0800 [thread overview]
Message-ID: <20181126021720.19471-19-ming.lei@redhat.com> (raw)
In-Reply-To: <20181126021720.19471-1-ming.lei@redhat.com>
Now multi-page bvec is supported, some helpers may return page by
page, meantime some may return segment by segment, this patch
documents the usage.
Signed-off-by: Ming Lei <ming.lei@redhat.com>
---
Documentation/block/biovecs.txt | 25 +++++++++++++++++++++++++
1 file changed, 25 insertions(+)
diff --git a/Documentation/block/biovecs.txt b/Documentation/block/biovecs.txt
index 25689584e6e0..ce6eccaf5df7 100644
--- a/Documentation/block/biovecs.txt
+++ b/Documentation/block/biovecs.txt
@@ -117,3 +117,28 @@ Other implications:
size limitations and the limitations of the underlying devices. Thus
there's no need to define ->merge_bvec_fn() callbacks for individual block
drivers.
+
+Usage of helpers:
+=================
+
+* The following helpers whose names have the suffix of "_all" can only be used
+on non-BIO_CLONED bio. They are usually used by filesystem code. Drivers
+shouldn't use them because the bio may have been split before it reached the
+driver.
+
+ bio_for_each_segment_all()
+ bio_first_bvec_all()
+ bio_first_page_all()
+ bio_last_bvec_all()
+
+* The following helpers iterate over single-page segment. The passed 'struct
+bio_vec' will contain a single-page IO vector during the iteration
+
+ bio_for_each_segment()
+ bio_for_each_segment_all()
+
+* The following helpers iterate over multi-page bvec. The passed 'struct
+bio_vec' will contain a multi-page IO vector during the iteration
+
+ bio_for_each_bvec()
+ rq_for_each_bvec()
--
2.9.5
WARNING: multiple messages have this Message-ID (diff)
From: Ming Lei <ming.lei@redhat.com>
To: Jens Axboe <axboe@kernel.dk>
Cc: linux-block@vger.kernel.org, linux-kernel@vger.kernel.org,
linux-mm@kvack.org, Theodore Ts'o <tytso@mit.edu>,
Omar Sandoval <osandov@fb.com>, Sagi Grimberg <sagi@grimberg.me>,
Dave Chinner <dchinner@redhat.com>,
Kent Overstreet <kent.overstreet@gmail.com>,
Mike Snitzer <snitzer@redhat.com>,
dm-devel@redhat.com, Alexander Viro <viro@zeniv.linux.org.uk>,
linux-fsdevel@vger.kernel.org, Shaohua Li <shli@kernel.org>,
linux-raid@vger.kernel.org, David Sterba <dsterba@suse.com>,
linux-btrfs@vger.kernel.org,
"Darrick J . Wong" <darrick.wong@oracle.com>,
linux-xfs@vger.kernel.org, Gao Xiang <gaoxiang25@huawei.com>,
Christoph Hellwig <hch@lst.de>,
linux-ext4@vger.kernel.org, Coly Li <colyli@suse.de>,
linux-bcache@vger.kernel.org, Boaz Harrosh <ooo@electrozaur.com>,
Bob Peterson <rpeterso@redhat.com>,
cluster-devel@redhat.com, Ming Lei <ming.lei@redhat.com>
Subject: [PATCH V12 18/20] block: document usage of bio iterator helpers
Date: Mon, 26 Nov 2018 10:17:18 +0800 [thread overview]
Message-ID: <20181126021720.19471-19-ming.lei@redhat.com> (raw)
In-Reply-To: <20181126021720.19471-1-ming.lei@redhat.com>
Now multi-page bvec is supported, some helpers may return page by
page, meantime some may return segment by segment, this patch
documents the usage.
Signed-off-by: Ming Lei <ming.lei@redhat.com>
---
Documentation/block/biovecs.txt | 25 +++++++++++++++++++++++++
1 file changed, 25 insertions(+)
diff --git a/Documentation/block/biovecs.txt b/Documentation/block/biovecs.txt
index 25689584e6e0..ce6eccaf5df7 100644
--- a/Documentation/block/biovecs.txt
+++ b/Documentation/block/biovecs.txt
@@ -117,3 +117,28 @@ Other implications:
size limitations and the limitations of the underlying devices. Thus
there's no need to define ->merge_bvec_fn() callbacks for individual block
drivers.
+
+Usage of helpers:
+=================
+
+* The following helpers whose names have the suffix of "_all" can only be used
+on non-BIO_CLONED bio. They are usually used by filesystem code. Drivers
+shouldn't use them because the bio may have been split before it reached the
+driver.
+
+ bio_for_each_segment_all()
+ bio_first_bvec_all()
+ bio_first_page_all()
+ bio_last_bvec_all()
+
+* The following helpers iterate over single-page segment. The passed 'struct
+bio_vec' will contain a single-page IO vector during the iteration
+
+ bio_for_each_segment()
+ bio_for_each_segment_all()
+
+* The following helpers iterate over multi-page bvec. The passed 'struct
+bio_vec' will contain a multi-page IO vector during the iteration
+
+ bio_for_each_bvec()
+ rq_for_each_bvec()
--
2.9.5
WARNING: multiple messages have this Message-ID (diff)
From: Ming Lei <ming.lei@redhat.com>
To: cluster-devel.redhat.com
Subject: [Cluster-devel] [PATCH V12 18/20] block: document usage of bio iterator helpers
Date: Mon, 26 Nov 2018 10:17:18 +0800 [thread overview]
Message-ID: <20181126021720.19471-19-ming.lei@redhat.com> (raw)
In-Reply-To: <20181126021720.19471-1-ming.lei@redhat.com>
Now multi-page bvec is supported, some helpers may return page by
page, meantime some may return segment by segment, this patch
documents the usage.
Signed-off-by: Ming Lei <ming.lei@redhat.com>
---
Documentation/block/biovecs.txt | 25 +++++++++++++++++++++++++
1 file changed, 25 insertions(+)
diff --git a/Documentation/block/biovecs.txt b/Documentation/block/biovecs.txt
index 25689584e6e0..ce6eccaf5df7 100644
--- a/Documentation/block/biovecs.txt
+++ b/Documentation/block/biovecs.txt
@@ -117,3 +117,28 @@ Other implications:
size limitations and the limitations of the underlying devices. Thus
there's no need to define ->merge_bvec_fn() callbacks for individual block
drivers.
+
+Usage of helpers:
+=================
+
+* The following helpers whose names have the suffix of "_all" can only be used
+on non-BIO_CLONED bio. They are usually used by filesystem code. Drivers
+shouldn't use them because the bio may have been split before it reached the
+driver.
+
+ bio_for_each_segment_all()
+ bio_first_bvec_all()
+ bio_first_page_all()
+ bio_last_bvec_all()
+
+* The following helpers iterate over single-page segment. The passed 'struct
+bio_vec' will contain a single-page IO vector during the iteration
+
+ bio_for_each_segment()
+ bio_for_each_segment_all()
+
+* The following helpers iterate over multi-page bvec. The passed 'struct
+bio_vec' will contain a multi-page IO vector during the iteration
+
+ bio_for_each_bvec()
+ rq_for_each_bvec()
--
2.9.5
next prev parent reply other threads:[~2018-11-26 2:17 UTC|newest]
Thread overview: 144+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-11-26 2:17 [PATCH V12 00/20] block: support multi-page bvec Ming Lei
2018-11-26 2:17 ` [Cluster-devel] " Ming Lei
2018-11-26 2:17 ` Ming Lei
2018-11-26 2:17 ` [PATCH V12 01/20] btrfs: remove various bio_offset arguments Ming Lei
2018-11-26 2:17 ` [Cluster-devel] " Ming Lei
2018-11-26 2:17 ` Ming Lei
2018-11-26 22:28 ` Omar Sandoval
2018-11-26 22:28 ` [Cluster-devel] " Omar Sandoval
2018-11-26 22:28 ` Omar Sandoval
2018-11-26 2:17 ` [PATCH V12 02/20] btrfs: look at bi_size for repair decisions Ming Lei
2018-11-26 2:17 ` [Cluster-devel] " Ming Lei
2018-11-26 2:17 ` Ming Lei
2018-11-26 22:46 ` Omar Sandoval
2018-11-26 22:46 ` [Cluster-devel] " Omar Sandoval
2018-11-26 22:46 ` Omar Sandoval
2018-11-26 2:17 ` [PATCH V12 03/20] block: remove the "cluster" flag Ming Lei
2018-11-26 2:17 ` [Cluster-devel] " Ming Lei
2018-11-26 2:17 ` Ming Lei
2018-11-26 22:12 ` Omar Sandoval
2018-11-26 22:12 ` [Cluster-devel] " Omar Sandoval
2018-11-26 22:12 ` Omar Sandoval
2018-11-26 2:17 ` [PATCH V12 04/20] block: don't use bio->bi_vcnt to figure out segment number Ming Lei
2018-11-26 2:17 ` [Cluster-devel] " Ming Lei
2018-11-26 2:17 ` Ming Lei
2018-11-26 22:14 ` Omar Sandoval
2018-11-26 22:14 ` [Cluster-devel] " Omar Sandoval
2018-11-26 22:14 ` Omar Sandoval
2018-11-26 2:17 ` [PATCH V12 05/20] block: remove bvec_iter_rewind() Ming Lei
2018-11-26 2:17 ` [Cluster-devel] " Ming Lei
2018-11-26 2:17 ` Ming Lei
2018-11-26 12:53 ` Christoph Hellwig
2018-11-26 12:53 ` [Cluster-devel] " Christoph Hellwig
2018-11-26 12:53 ` Christoph Hellwig
2018-11-26 22:16 ` Omar Sandoval
2018-11-26 22:16 ` [Cluster-devel] " Omar Sandoval
2018-11-26 22:16 ` Omar Sandoval
2018-11-26 2:17 ` [PATCH V12 06/20] block: rename bvec helpers Ming Lei
2018-11-26 2:17 ` [Cluster-devel] " Ming Lei
2018-11-26 2:17 ` Ming Lei
2018-11-26 8:17 ` Miguel Ojeda
2018-11-26 8:17 ` [Cluster-devel] " Miguel Ojeda
2018-11-26 12:54 ` Christoph Hellwig
2018-11-26 12:54 ` [Cluster-devel] " Christoph Hellwig
2018-11-26 12:54 ` Christoph Hellwig
2018-11-26 22:18 ` Omar Sandoval
2018-11-26 22:18 ` [Cluster-devel] " Omar Sandoval
2018-11-26 22:18 ` Omar Sandoval
2018-11-26 2:17 ` [PATCH V12 07/20] block: introduce multi-page " Ming Lei
2018-11-26 2:17 ` [Cluster-devel] " Ming Lei
2018-11-26 2:17 ` Ming Lei
2018-11-26 12:55 ` Christoph Hellwig
2018-11-26 12:55 ` [Cluster-devel] " Christoph Hellwig
2018-11-26 12:55 ` Christoph Hellwig
2018-11-26 2:17 ` [PATCH V12 08/20] block: introduce bio_for_each_bvec() and rq_for_each_bvec() Ming Lei
2018-11-26 2:17 ` [Cluster-devel] " Ming Lei
2018-11-26 2:17 ` Ming Lei
2018-11-26 12:55 ` Christoph Hellwig
2018-11-26 12:55 ` [Cluster-devel] " Christoph Hellwig
2018-11-26 12:55 ` Christoph Hellwig
2018-11-26 2:17 ` [PATCH V12 09/20] block: use bio_for_each_bvec() to compute multi-page bvec count Ming Lei
2018-11-26 2:17 ` [Cluster-devel] " Ming Lei
2018-11-26 2:17 ` Ming Lei
2018-11-26 13:11 ` Christoph Hellwig
2018-11-26 13:11 ` [Cluster-devel] " Christoph Hellwig
2018-11-26 13:11 ` Christoph Hellwig
2018-11-26 22:37 ` Omar Sandoval
2018-11-26 22:37 ` [Cluster-devel] " Omar Sandoval
2018-11-26 22:37 ` Omar Sandoval
2018-11-26 2:17 ` [PATCH V12 10/20] block: use bio_for_each_bvec() to map sg Ming Lei
2018-11-26 2:17 ` [Cluster-devel] " Ming Lei
2018-11-26 2:17 ` Ming Lei
2018-11-26 13:11 ` Christoph Hellwig
2018-11-26 13:11 ` [Cluster-devel] " Christoph Hellwig
2018-11-26 13:11 ` Christoph Hellwig
2018-11-26 2:17 ` [PATCH V12 11/20] block: introduce bvec_last_segment() Ming Lei
2018-11-26 2:17 ` [Cluster-devel] " Ming Lei
2018-11-26 2:17 ` Ming Lei
2018-11-26 2:17 ` [PATCH V12 12/20] fs/buffer.c: use bvec iterator to truncate the bio Ming Lei
2018-11-26 2:17 ` [Cluster-devel] " Ming Lei
2018-11-26 2:17 ` Ming Lei
2018-11-26 2:17 ` [PATCH V12 13/20] block: loop: pass multi-page bvec to iov_iter Ming Lei
2018-11-26 2:17 ` [Cluster-devel] " Ming Lei
2018-11-26 2:17 ` Ming Lei
2018-11-26 22:39 ` Omar Sandoval
2018-11-26 22:39 ` [Cluster-devel] " Omar Sandoval
2018-11-26 22:39 ` Omar Sandoval
2018-11-26 2:17 ` [PATCH V12 14/20] bcache: avoid to use bio_for_each_segment_all() in bch_bio_alloc_pages() Ming Lei
2018-11-26 2:17 ` [Cluster-devel] " Ming Lei
2018-11-26 2:17 ` Ming Lei
2018-11-26 22:40 ` Omar Sandoval
2018-11-26 22:40 ` [Cluster-devel] " Omar Sandoval
2018-11-26 22:40 ` Omar Sandoval
2018-11-26 2:17 ` [PATCH V12 15/20] block: allow bio_for_each_segment_all() to iterate over multi-page bvec Ming Lei
2018-11-26 2:17 ` [Cluster-devel] " Ming Lei
2018-11-26 2:17 ` Ming Lei
2018-11-26 22:42 ` Omar Sandoval
2018-11-26 22:42 ` [Cluster-devel] " Omar Sandoval
2018-11-26 22:42 ` Omar Sandoval
2018-11-26 2:17 ` [PATCH V12 16/20] block: enable multipage bvecs Ming Lei
2018-11-26 2:17 ` [Cluster-devel] " Ming Lei
2018-11-26 2:17 ` Ming Lei
2018-11-26 12:58 ` Christoph Hellwig
2018-11-26 12:58 ` [Cluster-devel] " Christoph Hellwig
2018-11-26 12:58 ` Christoph Hellwig
2018-11-27 2:25 ` Ming Lei
2018-11-27 2:25 ` [Cluster-devel] " Ming Lei
2018-11-27 2:25 ` Ming Lei
2018-11-26 22:56 ` Omar Sandoval
2018-11-26 22:56 ` [Cluster-devel] " Omar Sandoval
2018-11-26 22:56 ` Omar Sandoval
2018-11-26 2:17 ` [PATCH V12 17/20] block: always define BIO_MAX_PAGES as 256 Ming Lei
2018-11-26 2:17 ` [Cluster-devel] " Ming Lei
2018-11-26 2:17 ` Ming Lei
2018-11-26 22:44 ` Omar Sandoval
2018-11-26 22:44 ` [Cluster-devel] " Omar Sandoval
2018-11-26 22:44 ` Omar Sandoval
2018-11-26 2:17 ` Ming Lei [this message]
2018-11-26 2:17 ` [Cluster-devel] [PATCH V12 18/20] block: document usage of bio iterator helpers Ming Lei
2018-11-26 2:17 ` Ming Lei
2018-11-26 12:59 ` Christoph Hellwig
2018-11-26 12:59 ` [Cluster-devel] " Christoph Hellwig
2018-11-26 12:59 ` Christoph Hellwig
2018-11-26 22:43 ` Omar Sandoval
2018-11-26 22:43 ` [Cluster-devel] " Omar Sandoval
2018-11-26 22:43 ` Omar Sandoval
2018-11-26 2:17 ` [PATCH V12 19/20] block: kill QUEUE_FLAG_NO_SG_MERGE Ming Lei
2018-11-26 2:17 ` [Cluster-devel] " Ming Lei
2018-11-26 2:17 ` Ming Lei
2018-11-26 2:17 ` [PATCH V12 20/20] block: kill BLK_MQ_F_SG_MERGE Ming Lei
2018-11-26 2:17 ` [Cluster-devel] " Ming Lei
2018-11-26 2:17 ` Ming Lei
2018-11-28 13:44 ` [PATCH V12 00/20] block: support multi-page bvec Jens Axboe
2018-11-28 13:44 ` [Cluster-devel] " Jens Axboe
2018-11-28 13:44 ` Jens Axboe
2018-11-29 1:30 ` Ming Lei
2018-11-29 1:30 ` [Cluster-devel] " Ming Lei
2018-11-29 1:30 ` Ming Lei
2018-11-29 1:30 ` Ming Lei
2018-11-29 2:20 ` Jens Axboe
2018-11-29 2:20 ` [Cluster-devel] " Jens Axboe
2018-11-29 2:20 ` Jens Axboe
2018-11-29 3:30 ` Ming Lei
2018-11-29 3:30 ` [Cluster-devel] " Ming Lei
2018-11-29 3:30 ` Ming Lei
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20181126021720.19471-19-ming.lei@redhat.com \
--to=ming.lei@redhat.com \
--cc=axboe@kernel.dk \
--cc=colyli@suse.de \
--cc=darrick.wong@oracle.com \
--cc=dchinner@redhat.com \
--cc=dm-devel@redhat.com \
--cc=dsterba@suse.com \
--cc=gaoxiang25@huawei.com \
--cc=hch@lst.de \
--cc=kent.overstreet@gmail.com \
--cc=linux-bcache@vger.kernel.org \
--cc=linux-block@vger.kernel.org \
--cc=linux-btrfs@vger.kernel.org \
--cc=linux-ext4@vger.kernel.org \
--cc=linux-fsdevel@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mm@kvack.org \
--cc=linux-raid@vger.kernel.org \
--cc=linux-xfs@vger.kernel.org \
--cc=ooo@electrozaur.com \
--cc=osandov@fb.com \
--cc=sagi@grimberg.me \
--cc=shli@kernel.org \
--cc=snitzer@redhat.com \
--cc=tytso@mit.edu \
--cc=viro@zeniv.linux.org.uk \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.