Skip to content

Commit 3b67145

Browse files
eatnumber1Mike Snitzer
authored andcommitted
Documentation: dm-integrity: Document the meaning of "buffer".
"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 <[email protected]> Reviewed-by: Bagas Sanjaya <[email protected]> Signed-off-by: Mike Snitzer <[email protected]>
1 parent c3ba5aa commit 3b67145

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

Documentation/admin-guide/device-mapper/dm-integrity.rst

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,15 @@ the device. But it will only format the device if the superblock contains
3838
zeroes. If the superblock is neither valid nor zeroed, the dm-integrity
3939
target can't be loaded.
4040

41+
Accesses to the on-disk metadata area containing checksums (aka tags) are
42+
buffered using dm-bufio. When an access to any given metadata area
43+
occurs, each unique metadata area gets its own buffer(s). The buffer size
44+
is capped at the size of the metadata area, but may be smaller, thereby
45+
requiring multiple buffers to represent the full metadata area. A smaller
46+
buffer size will produce a smaller resulting read/write operation to the
47+
metadata area for small reads/writes. The metadata is still read even in
48+
a full write to the data covered by a single buffer.
49+
4150
To use the target for the first time:
4251

4352
1. overwrite the superblock with zeroes
@@ -106,10 +115,6 @@ buffer_sectors:number
106115
The number of sectors in one buffer. The value is rounded down to
107116
a power of two.
108117

109-
The tag area is accessed using buffers, the buffer size is
110-
configurable. The large buffer size means that the I/O size will
111-
be larger, but there could be less I/Os issued.
112-
113118
journal_watermark:number
114119
The journal watermark in percents. When the size of the journal
115120
exceeds this watermark, the thread that flushes the journal will

0 commit comments

Comments
 (0)