linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Russell Harmon <eatnumber1@gmail.com>
To: bagasdotme@gmail.com
Cc: mpatocka@redhat.com, snitzer@redhat.com, dm-devel@redhat.com,
	linux-doc@vger.kernel.org, Russell Harmon <eatnumber1@gmail.com>
Subject: [PATCH v3 2/4] Documents the meaning of "buffer" in dm-integrity.
Date: Sun,  4 Jun 2023 12:06:02 -0700	[thread overview]
Message-ID: <20230604190604.4800-3-eatnumber1@gmail.com> (raw)
In-Reply-To: <20230604190604.4800-1-eatnumber1@gmail.com>

"Buffers" are buffers of the metadata/checksum area of dm-integrity.
They are always at most as large as a single metadata area on-disk, but
may be smaller.

Signed-off-by: Russell Harmon <eatnumber1@gmail.com>
---
 .../admin-guide/device-mapper/dm-integrity.rst      | 13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)

diff --git a/Documentation/admin-guide/device-mapper/dm-integrity.rst b/Documentation/admin-guide/device-mapper/dm-integrity.rst
index b2a698e955a3..31f514675809 100644
--- a/Documentation/admin-guide/device-mapper/dm-integrity.rst
+++ b/Documentation/admin-guide/device-mapper/dm-integrity.rst
@@ -38,6 +38,15 @@ the device. But it will only format the device if the superblock contains
 zeroes. If the superblock is neither valid nor zeroed, the dm-integrity
 target can't be loaded.
 
+Accesses to the on-disk metadata area containing checksums (aka tags) are
+buffered using dm-bufio. When an access to any given metadata area
+occurs, each unique metadata area gets its own buffer(s). The buffer size
+is capped at the size of the metadata area, but may be smaller, thereby
+requiring multiple buffers to represent the full metadata area. A smaller
+buffer size will produce a smaller resulting read/write operation to the
+metadata area for small reads/writes. The metadata is still read even in
+a full write to the data covered by a single buffer.
+
 To use the target for the first time:
 
 1. overwrite the superblock with zeroes
@@ -106,10 +115,6 @@ buffer_sectors:number
 	The number of sectors in one buffer. The value is rounded down to
 	a power of two.
 
-	The tag area is accessed using buffers, the buffer size is
-	configurable. The large buffer size means that the I/O size will
-	be larger, but there could be less I/Os issued.
-
 journal_watermark:number
 	The journal watermark in percents. When the size of the journal
 	exceeds this watermark, the thread that flushes the journal will
-- 
2.34.1


  parent reply	other threads:[~2023-06-04 19:06 UTC|newest]

Thread overview: 33+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <20230530002032.15227-1-eatnumber1@gmail.com>
2023-06-03 12:45 ` [dm-devel] [PATCH] Improve the dm-integrity documentation Bagas Sanjaya
2023-06-03 20:15   ` Russell Harmon
2023-06-03 20:15     ` [PATCH 1/4] Fix minor grammatical error in dm-integrity.rst Russell Harmon
2023-06-03 20:15     ` [PATCH 2/4] Documents the meaning of "buffer" in dm-integrity Russell Harmon
2023-06-03 20:15     ` [PATCH 3/4] Document dm-integrity default values Russell Harmon
2023-06-03 20:15     ` [PATCH 4/4] Document an example of how the tunables relate in dm-integrity Russell Harmon
2023-06-04 14:07     ` [PATCH] Improve the dm-integrity documentation Bagas Sanjaya
2023-06-04 18:25       ` Russell Harmon
2023-06-04 19:06         ` [PATCH v3 0/4] " Russell Harmon
2023-06-04 19:06           ` [PATCH v3 1/4] Fix minor grammatical error in dm-integrity.rst Russell Harmon
2023-06-05  3:03             ` Bagas Sanjaya
2023-06-05  5:00               ` Russell Harmon
2023-06-04 19:06           ` Russell Harmon [this message]
2023-06-05  3:05             ` [PATCH v3 2/4] Documents the meaning of "buffer" in dm-integrity Bagas Sanjaya
2023-06-05  3:07             ` Bagas Sanjaya
2023-06-05  5:01               ` Russell Harmon
2023-06-04 19:06           ` [PATCH v3 3/4] Document dm-integrity default values Russell Harmon
2023-06-05  3:16             ` Bagas Sanjaya
2023-06-05  5:05               ` Russell Harmon
2023-06-05 13:23               ` Jonathan Corbet
2023-06-06  2:16                 ` Bagas Sanjaya
2023-06-04 19:06           ` [PATCH v3 4/4] Document an example of how the tunables relate in dm-integrity Russell Harmon
2023-06-05  3:17             ` Bagas Sanjaya
2023-06-05  5:05               ` Russell Harmon
2023-06-05  5:08           ` [PATCH v4 0/4] Improve the dm-integrity documentation Russell Harmon
2023-06-05  5:08             ` [PATCH v4 1/4] Documentation: dm-integrity: Fix minor grammatical error Russell Harmon
2023-06-06  2:17               ` Bagas Sanjaya
2023-06-05  5:08             ` [PATCH v4 2/4] Documentation: dm-integrity: Document the meaning of "buffer" Russell Harmon
2023-06-06  2:18               ` Bagas Sanjaya
2023-06-05  5:08             ` [PATCH v4 3/4] Documentation: dm-integrity: Document default values Russell Harmon
2023-06-05  5:08             ` [PATCH v4 4/4] Documentation: dm-integrity: Document an example of how the tunables relate Russell Harmon
2023-06-17 19:37               ` Russell Harmon
     [not found] ` <CA+zrezTKon+02mfMRsW34Tkovqn3FsSD2_9tk-+a4icjt9PsDg@mail.gmail.com>
2023-06-03 12:50   ` [dm-devel] [PATCH] Improve the dm-integrity documentation Bagas Sanjaya

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=20230604190604.4800-3-eatnumber1@gmail.com \
    --to=eatnumber1@gmail.com \
    --cc=bagasdotme@gmail.com \
    --cc=dm-devel@redhat.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=mpatocka@redhat.com \
    --cc=snitzer@redhat.com \
    /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 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).