Update README.md

README.md

@@ -1,50 +1,59 @@
-# dm-cache
+dm-cache
-Tool to create and manage device-mapper cache devices.
+![](dm-cache.jpg "dm-cache.jpg") Device Mapper Cache, is a Linux kernel feature designed to enhance storage performance by
-
+implementing a block-level cache on a separate cache device.
-DM-cache, or Device Mapper Cache, is a Linux kernel feature designed to enhance storage performance by implementing a block-level cache on a separate cache device.
+`dm-cache` is a tool that helps the user setup cache devices.
 
 The goal with dm-cache is to improve random read/write performance of a slow HDD by using a small but fast SSD or NVME device.
 
-The main advantage of dm-cache over lvmcache and bcache is that it is possible to setup on devices that already have a filesystem with data on them. Both LVM and Bcache requires unformatted, empty devices (there are ways to get around, but can be risky).
+The main advantage of dm-cache over [LVM](https://sourceware.org/lvm2/) and [Bcache](https://bcache.evilpiepirate.org/) is that it is possible to setup on devices that already have a filesystem with data on them. Both LVM and Bcache requires unformatted, empty devices, to setup (there are ways to get around, but can be risky).
 
 ## Requirements
-dm-cache requires three devices:
+dm-cache utilises the `dmsetup` utility which usually can be found in [lvm2](https://packages.debian.org/bookworm/lvm2) or [device-mapper](https://pkgs.alpinelinux.org/packages?name=device-mapper&branch=edge&repo=&arch=&maintainer=) packages.
+
+dm-cache requires three devices
 -   **origin**: The slow device.
 -   **cache**: A fast SSD or NVME device. Can be of any size.
 -   **meta**: A small device that holds dm-cache metadata.
 
-The metadata device size depends on how many cache blocks fit on the cache device. With default setting it should be a least 0.01% of the cache device size. If the cache device is 50GiB, and a cache block size of 128KiB, a metadata device of 5MiB is enough. It is important to have spare space, or dm-cache can become corrupted!
+The metadata device size depends on how many cache blocks fit on the cache device. With **default** setting it should be a least 0.01% of the cache device size. If the cache device is 50GiB, and a cache block size of 128KiB, a metadata device of 5MiB is enough. Smaller block sizes requires more metadata and memory, while larger block sizes may reduce effectiveness of the cache by storing cold data. Check metadata usage with `cachestats.sh` to ensure you are within limits.
 
-## Setup
+It is important to mount the filesystem on the dm-cache using the
-### Using `dmcache.sh`
+`/dev/mapper/dmname` path and not with the filesystem UUID as is commonly done. This is because the kernel might still see the
-Edit `dmcache.sh` and modify thd following variables:
+UUID from the origin device, and this can cause data loss!
-- **dmname**: Choose a new name for the assembled dm-cache. It will be exposed as a block device as `/dev/mapper/dmname`
-- **origindev**: Path to the slow device that shoulf be accelerated with dm-cache. Use a stable device ID, not FS UUID.
-- **cachedev**: The fast cache device, usually an SSD or NVME disk.
-- **metadev**: A small decice to hold cache metadata.
-- **cachemode**: Choose writethrough or writeback cache.
 
-**It is important to mount the filesystem on the dm-cache using the `/dev/mapper/dmname` path and not with the filesystem UUID as is commonly done. This is because the kernel might still see the UUID from the origin device, and this can cause data loss!**
+If you\'re using Btrfs, the following message can be seen in the kernel log:
+```text
+# dmesg
+BTRFS warning: duplicate device /dev/sdj1 devid 1 generation 182261 scanned by mount (13706)
+```
+There is a udev rule that prevents this issue by removing the `/dev/disk/by-uuid/` symlink to the  origin device.
 
-Note that the dm-cache mapping is not persistent. After a reboot, the dm-cache must be assembled before the filesystem safely can be mounted. 
+## Documentation
+Full documentation is available at https://wiki.tnonline.net/w/Linux/dm-cache
 
-The writethrough cache mode minimises the risk of problems by only accelerating reads. It makes sure that dirty data is written to the origin device before acknowledging to the application. In theory, it should be possible to use the origin device without dmcache after a reboot or a crash, but it is no guarantee.
+## Cache Statistics
-
+`cachestats.sh` is used to see current stats of the dm-cache device.
-Manually stopping dm-cache is done with `dmsetup remove <dmname>`.
+```text
-
+# cachestats.sh data2
-### OpenRC
+DEVICE
-The OpenRC init script can automate setting up and stopping dm-cache during boot.
+========
-- Install `conf.d/dmcache` and `init.d/dmscript
+Device-mapper name:       /dev/mapper/data2
-- Modify `conf.d/dmcache` to suit your setup
+Origin size:              9 TiB
-- Add a udev rule to block FS UUID device symlinks
+Discards:                 no_discard_passdown
-- Add dmcache to boot runlevel: `rc-update add dmcache boot`
+CACHE
-
+========
-#### Multiple devices
+Size / Usage:             100 GiB / 100 GiB (99 %)
-If you have several devices you can simply make a copy of the init.d and conf.d files to a new name. The filenames in init.d and conf.d must be the same.
+Read Hit Rate:            335117403 / 520337199 (64 %)
-
+Write Hit Rate:           24747253 / 31885008 (77 %)
-- `cp /etc/conf.d/dmcache /etc/conf.d/dmcache.new`
+Dirty:                    0 bytes
-- `ln -s /etc/init.d/dmcache /etc/init.d/dmcache.new`
+Block Size:               128 KiB
-- update `/etc/conf.d/dmcache.new`
+Promotions / Demotions:   648844 / 648844
-- update udev rules
+Migration Threshold:      1 MiB
-- `rc-service dmcache.new start`
+Read-Write mode:          rw
-- `rc-update add dmcache.new boot`
+Type:                     writeback
+Policy:                   smq
+Status:                   OK
+METADATA
+========
+Size / Usage:             256 MiB / 10 MiB (3 %)
+```