linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Ming Lei <ming.lei@redhat.com>
To: Jens Axboe <axboe@kernel.dk>
Cc: linux-block@vger.kernel.org, linux-kernel@vger.kernel.org,
	Ming Lei <ming.lei@redhat.com>, Christoph Hellwig <hch@lst.de>
Subject: [PATCH V9 16/19] block: document usage of bio iterator helpers
Date: Tue, 13 Nov 2018 23:15:02 +0800	[thread overview]
Message-ID: <20181113151505.15498-17-ming.lei@redhat.com> (raw)
In-Reply-To: <20181113151505.15498-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.

Cc: Christoph Hellwig <hch@lst.de>
Signed-off-by: Ming Lei <ming.lei@redhat.com>
---
 Documentation/block/biovecs.txt | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/Documentation/block/biovecs.txt b/Documentation/block/biovecs.txt
index 25689584e6e0..bfafb70d0d9e 100644
--- a/Documentation/block/biovecs.txt
+++ b/Documentation/block/biovecs.txt
@@ -117,3 +117,29 @@ 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, and usually they are used by filesystem code, and driver
+shouldn't use them because bio may have been split before they got to 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 bvec, and the local
+variable of 'struct bio_vec' or the reference records single-page IO
+vector during the itearation:
+
+	bio_for_each_segment()
+	bio_for_each_segment_all()
+
+* The following helper iterates over multi-page bvec, and each bvec may
+include multiple physically contiguous pages, and the local variable of
+'struct bio_vec' or the reference records multi-page IO vector during the
+itearation:
+
+	bio_for_each_bvec()
-- 
2.9.5


  parent reply	other threads:[~2018-11-13 15:16 UTC|newest]

Thread overview: 24+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-11-13 15:14 [PATCH V9 00/19] block: support multi-page bvec Ming Lei
2018-11-13 15:14 ` [PATCH V9 01/19] block: introduce multi-page page bvec helpers Ming Lei
2018-11-13 15:14 ` [PATCH V9 02/19] block: introduce bio_for_each_bvec() Ming Lei
2018-11-13 15:14 ` [PATCH V9 03/19] block: use bio_for_each_bvec() to compute multi-page bvec count Ming Lei
2018-11-13 15:14 ` [PATCH V9 04/19] block: use bio_for_each_bvec() to map sg Ming Lei
2018-11-13 15:14 ` [PATCH V9 05/19] block: introduce bvec_last_segment() Ming Lei
2018-11-13 15:14 ` [PATCH V9 06/19] fs/buffer.c: use bvec iterator to truncate the bio Ming Lei
2018-11-13 15:14 ` [PATCH V9 07/19] btrfs: use bvec_last_segment to get bio's last page Ming Lei
2018-11-13 15:14 ` [PATCH V9 08/19] btrfs: move bio_pages_all() to btrfs Ming Lei
2018-11-13 15:14 ` [PATCH V9 09/19] block: introduce bio_bvecs() Ming Lei
2018-11-13 15:14 ` [PATCH V9 10/19] block: loop: pass multi-page bvec to iov_iter Ming Lei
2018-11-13 15:14 ` [PATCH V9 11/19] bcache: avoid to use bio_for_each_segment_all() in bch_bio_alloc_pages() Ming Lei
2018-11-13 15:14 ` [PATCH V9 12/19] block: allow bio_for_each_segment_all() to iterate over multi-page bvec Ming Lei
2018-11-13 15:14 ` [PATCH V9 13/19] iomap & xfs: only account for new added page Ming Lei
2018-11-13 15:15 ` [PATCH V9 14/19] block: enable multipage bvecs Ming Lei
2018-11-13 15:15 ` [PATCH V9 15/19] block: always define BIO_MAX_PAGES as 256 Ming Lei
2018-11-13 15:15 ` Ming Lei [this message]
2018-11-13 15:15 ` [PATCH V9 17/19] block: don't use bio->bi_vcnt to figure out segment number Ming Lei
2018-11-13 15:15 ` [PATCH V9 18/19] block: kill QUEUE_FLAG_NO_SG_MERGE Ming Lei
2018-11-13 15:15 ` [PATCH V9 19/19] block: kill BLK_MQ_F_SG_MERGE Ming Lei
2018-11-14  2:44 ` [PATCH V9 00/19] block: support multi-page bvec Dave Chinner
2018-11-14  2:57   ` Ming Lei
2018-11-14 15:22   ` Christoph Hellwig
2018-11-15  9:35     ` 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=20181113151505.15498-17-ming.lei@redhat.com \
    --to=ming.lei@redhat.com \
    --cc=axboe@kernel.dk \
    --cc=hch@lst.de \
    --cc=linux-block@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --subject='Re: [PATCH V9 16/19] block: document usage of bio iterator helpers' \
    /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

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).