^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) What: /sys/block/<disk>/bcache/unregister
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) Date: November 2010
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) Contact: Kent Overstreet <kent.overstreet@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) A write to this file causes the backing device or cache to be
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) unregistered. If a backing device had dirty data in the cache,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) writeback mode is automatically disabled and all dirty data is
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) flushed before the device is unregistered. Caches unregister
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) all associated backing devices before unregistering themselves.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) What: /sys/block/<disk>/bcache/clear_stats
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) Date: November 2010
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) Contact: Kent Overstreet <kent.overstreet@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) Writing to this file resets all the statistics for the device.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) What: /sys/block/<disk>/bcache/cache
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) Date: November 2010
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) Contact: Kent Overstreet <kent.overstreet@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) For a backing device that has cache, a symlink to
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) the bcache/ dir of that cache.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) What: /sys/block/<disk>/bcache/cache_hits
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) Date: November 2010
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) Contact: Kent Overstreet <kent.overstreet@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) For backing devices: integer number of full cache hits,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) counted per bio. A partial cache hit counts as a miss.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) What: /sys/block/<disk>/bcache/cache_misses
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) Date: November 2010
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) Contact: Kent Overstreet <kent.overstreet@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) For backing devices: integer number of cache misses.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) What: /sys/block/<disk>/bcache/cache_hit_ratio
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) Date: November 2010
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) Contact: Kent Overstreet <kent.overstreet@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) For backing devices: cache hits as a percentage.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) What: /sys/block/<disk>/bcache/sequential_cutoff
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) Date: November 2010
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) Contact: Kent Overstreet <kent.overstreet@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) For backing devices: Threshold past which sequential IO will
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) skip the cache. Read and written as bytes in human readable
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) units (i.e. echo 10M > sequntial_cutoff).
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) What: /sys/block/<disk>/bcache/bypassed
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) Date: November 2010
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) Contact: Kent Overstreet <kent.overstreet@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) Sum of all reads and writes that have bypassed the cache (due
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) to the sequential cutoff). Expressed as bytes in human
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) readable units.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) What: /sys/block/<disk>/bcache/writeback
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) Date: November 2010
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) Contact: Kent Overstreet <kent.overstreet@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) For backing devices: When on, writeback caching is enabled and
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) writes will be buffered in the cache. When off, caching is in
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) writethrough mode; reads and writes will be added to the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) cache but no write buffering will take place.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) What: /sys/block/<disk>/bcache/writeback_running
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) Date: November 2010
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) Contact: Kent Overstreet <kent.overstreet@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) For backing devices: when off, dirty data will not be written
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) from the cache to the backing device. The cache will still be
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) used to buffer writes until it is mostly full, at which point
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) writes transparently revert to writethrough mode. Intended only
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) for benchmarking/testing.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) What: /sys/block/<disk>/bcache/writeback_delay
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) Date: November 2010
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) Contact: Kent Overstreet <kent.overstreet@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) For backing devices: In writeback mode, when dirty data is
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) written to the cache and the cache held no dirty data for that
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) backing device, writeback from cache to backing device starts
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) after this delay, expressed as an integer number of seconds.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) What: /sys/block/<disk>/bcache/writeback_percent
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) Date: November 2010
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) Contact: Kent Overstreet <kent.overstreet@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) For backing devices: If nonzero, writeback from cache to
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92) backing device only takes place when more than this percentage
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) of the cache is used, allowing more write coalescing to take
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) place and reducing total number of writes sent to the backing
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95) device. Integer between 0 and 40.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) What: /sys/block/<disk>/bcache/synchronous
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) Date: November 2010
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) Contact: Kent Overstreet <kent.overstreet@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) For a cache, a boolean that allows synchronous mode to be
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) switched on and off. In synchronous mode all writes are ordered
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) such that the cache can reliably recover from unclean shutdown;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) if disabled bcache will not generally wait for writes to
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) complete but if the cache is not shut down cleanly all data
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) will be discarded from the cache. Should not be turned off with
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) writeback caching enabled.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) What: /sys/block/<disk>/bcache/discard
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) Date: November 2010
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) Contact: Kent Overstreet <kent.overstreet@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) For a cache, a boolean allowing discard/TRIM to be turned off
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) or back on if the device supports it.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) What: /sys/block/<disk>/bcache/bucket_size
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) Date: November 2010
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) Contact: Kent Overstreet <kent.overstreet@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) For a cache, bucket size in human readable units, as set at
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) cache creation time; should match the erase block size of the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) SSD for optimal performance.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) What: /sys/block/<disk>/bcache/nbuckets
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) Date: November 2010
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) Contact: Kent Overstreet <kent.overstreet@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) For a cache, the number of usable buckets.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) What: /sys/block/<disk>/bcache/tree_depth
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) Date: November 2010
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) Contact: Kent Overstreet <kent.overstreet@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) For a cache, height of the btree excluding leaf nodes (i.e. a
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) one node tree will have a depth of 0).
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) What: /sys/block/<disk>/bcache/btree_cache_size
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138) Date: November 2010
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) Contact: Kent Overstreet <kent.overstreet@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) Number of btree buckets/nodes that are currently cached in
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) memory; cache dynamically grows and shrinks in response to
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) memory pressure from the rest of the system.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) What: /sys/block/<disk>/bcache/written
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) Date: November 2010
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147) Contact: Kent Overstreet <kent.overstreet@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149) For a cache, total amount of data in human readable units
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150) written to the cache, excluding all metadata.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152) What: /sys/block/<disk>/bcache/btree_written
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153) Date: November 2010
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154) Contact: Kent Overstreet <kent.overstreet@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156) For a cache, sum of all btree writes in human readable units.