GNU Linux-libre 5.19-rc6-gnu
[releases.git] / Documentation / ABI / testing / sysfs-class-bdi
1 What:           /sys/class/bdi/<bdi>/
2 Date:           January 2008
3 Contact:        Peter Zijlstra <a.p.zijlstra@chello.nl>
4 Description:
5
6 Provide a place in sysfs for the backing_dev_info object.  This allows
7 setting and retrieving various BDI specific variables.
8
9 The <bdi> identifier can be either of the following:
10
11 MAJOR:MINOR
12
13         Device number for block devices, or value of st_dev on
14         non-block filesystems which provide their own BDI, such as NFS
15         and FUSE.
16
17 MAJOR:MINOR-fuseblk
18
19         Value of st_dev on fuseblk filesystems.
20
21 default
22
23         The default backing dev, used for non-block device backed
24         filesystems which do not provide their own BDI.
25
26 What:           /sys/class/bdi/<bdi>/read_ahead_kb
27 Date:           January 2008
28 Contact:        Peter Zijlstra <a.p.zijlstra@chello.nl>
29 Description:
30         Size of the read-ahead window in kilobytes
31
32         (read-write)
33 What:           /sys/class/bdi/<bdi>/min_ratio
34 Date:           January 2008
35 Contact:        Peter Zijlstra <a.p.zijlstra@chello.nl>
36 Description:
37         Under normal circumstances each device is given a part of the
38         total write-back cache that relates to its current average
39         writeout speed in relation to the other devices.
40
41         The 'min_ratio' parameter allows assigning a minimum
42         percentage of the write-back cache to a particular device.
43         For example, this is useful for providing a minimum QoS.
44
45         (read-write)
46
47 What:           /sys/class/bdi/<bdi>/max_ratio
48 Date:           January 2008
49 Contact:        Peter Zijlstra <a.p.zijlstra@chello.nl>
50 Description:
51         Allows limiting a particular device to use not more than the
52         given percentage of the write-back cache.  This is useful in
53         situations where we want to avoid one device taking all or
54         most of the write-back cache.  For example in case of an NFS
55         mount that is prone to get stuck, or a FUSE mount which cannot
56         be trusted to play fair.
57
58         (read-write)
59 What:           /sys/class/bdi/<bdi>/stable_pages_required
60 Date:           January 2008
61 Contact:        Peter Zijlstra <a.p.zijlstra@chello.nl>
62 Description:
63         If set, the backing device requires that all pages comprising a write
64         request must not be changed until writeout is complete.
65
66         (read-only)