Documentation/device-mapper/writecache.txt

   1 The writecache target caches writes on persistent memory or on SSD. It
   2 doesn't cache reads because reads are supposed to be cached in page cache
   3 in normal RAM.
   4
   5 When the device is constructed, the first sector should be zeroed or the
   6 first sector should contain valid superblock from previous invocation.
   7
   8 Constructor parameters:
   9 1. type of the cache device - "p" or "s"
  10         p - persistent memory
  11         s - SSD
  12 2. the underlying device that will be cached
  13 3. the cache device
  14 4. block size (4096 is recommended; the maximum block size is the page
  15    size)
  16 5. the number of optional parameters (the parameters with an argument
  17    count as two)
  18         high_watermark n        (default: 50)
  19                 start writeback when the number of used blocks reach this
  20                 watermark
  21         low_watermark x         (default: 45)
  22                 stop writeback when the number of used blocks drops below
  23                 this watermark
  24         writeback_jobs n        (default: unlimited)
  25                 limit the number of blocks that are in flight during
  26                 writeback. Setting this value reduces writeback
  27                 throughput, but it may improve latency of read requests
  28         autocommit_blocks n     (default: 64 for pmem, 65536 for ssd)
  29                 when the application writes this amount of blocks without
  30                 issuing the FLUSH request, the blocks are automatically
  31                 commited
  32         autocommit_time ms      (default: 1000)
  33                 autocommit time in milliseconds. The data is automatically
  34                 commited if this time passes and no FLUSH request is
  35                 received
  36         fua                     (by default on)
  37                 applicable only to persistent memory - use the FUA flag
  38                 when writing data from persistent memory back to the
  39                 underlying device
  40         nofua
  41                 applicable only to persistent memory - don't use the FUA
  42                 flag when writing back data and send the FLUSH request
  43                 afterwards
  44                 - some underlying devices perform better with fua, some
  45                   with nofua. The user should test it
  46
  47 Status:
  48 1. error indicator - 0 if there was no error, otherwise error number
  49 2. the number of blocks
  50 3. the number of free blocks
  51 4. the number of blocks under writeback
  52
  53 Messages:
  54         flush
  55                 flush the cache device. The message returns successfully
  56                 if the cache device was flushed without an error
  57         flush_on_suspend
  58                 flush the cache device on next suspend. Use this message
  59                 when you are going to remove the cache device. The proper
  60                 sequence for removing the cache device is:
  61                 1. send the "flush_on_suspend" message
  62                 2. load an inactive table with a linear target that maps
  63                    to the underlying device
  64                 3. suspend the device
  65                 4. ask for status and verify that there are no errors
  66                 5. resume the device, so that it will use the linear
  67                    target
  68                 6. the cache device is now inactive and it can be deleted