Skip to content

Commit cd039af

Browse files
committed
dm writecache: add "cleaner" and "max_age" to Documentation
Backfill missing Documentation. Fixes: 93de44e ("dm writecache: implement the "cleaner" policy") Fixes: 3923d48 ("dm writecache: implement gradual cleanup") Signed-off-by: Mike Snitzer <[email protected]>
1 parent 867de40 commit cd039af

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

Documentation/admin-guide/device-mapper/writecache.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,21 @@ Constructor parameters:
5353

5454
- some underlying devices perform better with fua, some
5555
with nofua. The user should test it
56+
cleaner
57+
when this option is activated (either in the constructor
58+
arguments or by a message), the cache will not promote
59+
new writes (however, writes to already cached blocks are
60+
promoted, to avoid data corruption due to misordered
61+
writes) and it will gradually writeback any cached
62+
data. The userspace can then monitor the cleaning
63+
process with "dmsetup status". When the number of cached
64+
blocks drops to zero, userspace can unload the
65+
dm-writecache target and replace it with dm-linear or
66+
other targets.
67+
max_age n
68+
specifies the maximum age of a block in milliseconds. If
69+
a block is stored in the cache for too long, it will be
70+
written to the underlying device and cleaned up.
5671

5772
Status:
5873
1. error indicator - 0 if there was no error, otherwise error number
@@ -77,3 +92,5 @@ Messages:
7792
5. resume the device, so that it will use the linear
7893
target
7994
6. the cache device is now inactive and it can be deleted
95+
cleaner
96+
See above "cleaner" constructor documentation.

0 commit comments

Comments
 (0)