c8b3b48ec62c29232ed10db7b3443c6189f21a2d
[linux-3.10.git] / Documentation / ABI / testing / sysfs-block-zram
1 What:           /sys/block/zram<id>/disksize
2 Date:           August 2010
3 Contact:        Nitin Gupta <ngupta@vflare.org>
4 Description:
5                 The disksize file is read-write and specifies the disk size
6                 which represents the limit on the *uncompressed* worth of data
7                 that can be stored in this disk.
8
9 What:           /sys/block/zram<id>/initstate
10 Date:           August 2010
11 Contact:        Nitin Gupta <ngupta@vflare.org>
12 Description:
13                 The disksize file is read-only and shows the initialization
14                 state of the device.
15
16 What:           /sys/block/zram<id>/reset
17 Date:           August 2010
18 Contact:        Nitin Gupta <ngupta@vflare.org>
19 Description:
20                 The disksize file is write-only and allows resetting the
21                 device. The reset operation frees all the memory assocaited
22                 with this device.
23
24 What:           /sys/block/zram<id>/num_reads
25 Date:           August 2010
26 Contact:        Nitin Gupta <ngupta@vflare.org>
27 Description:
28                 The num_reads file is read-only and specifies the number of
29                 reads (failed or successful) done on this device.
30
31 What:           /sys/block/zram<id>/num_writes
32 Date:           August 2010
33 Contact:        Nitin Gupta <ngupta@vflare.org>
34 Description:
35                 The num_writes file is read-only and specifies the number of
36                 writes (failed or successful) done on this device.
37
38 What:           /sys/block/zram<id>/invalid_io
39 Date:           August 2010
40 Contact:        Nitin Gupta <ngupta@vflare.org>
41 Description:
42                 The invalid_io file is read-only and specifies the number of
43                 non-page-size-aligned I/O requests issued to this device.
44
45 What:           /sys/block/zram<id>/notify_free
46 Date:           August 2010
47 Contact:        Nitin Gupta <ngupta@vflare.org>
48 Description:
49                 The notify_free file is read-only and specifies the number of
50                 swap slot free notifications received by this device. These
51                 notifications are send to a swap block device when a swap slot
52                 is freed. This statistic is applicable only when this disk is
53                 being used as a swap disk.
54
55 What:           /sys/block/zram<id>/discard
56 Date:           August 2010
57 Contact:        Nitin Gupta <ngupta@vflare.org>
58 Description:
59                 The discard file is read-only and specifies the number of
60                 discard requests received by this device. These requests
61                 provide information to block device regarding blocks which are
62                 no longer used by filesystem.
63
64 What:           /sys/block/zram<id>/zero_pages
65 Date:           August 2010
66 Contact:        Nitin Gupta <ngupta@vflare.org>
67 Description:
68                 The zero_pages file is read-only and specifies number of zero
69                 filled pages written to this disk. No memory is allocated for
70                 such pages.
71
72 What:           /sys/block/zram<id>/orig_data_size
73 Date:           August 2010
74 Contact:        Nitin Gupta <ngupta@vflare.org>
75 Description:
76                 The orig_data_size file is read-only and specifies uncompressed
77                 size of data stored in this disk. This excludes zero-filled
78                 pages (zero_pages) since no memory is allocated for them.
79                 Unit: bytes
80
81 What:           /sys/block/zram<id>/compr_data_size
82 Date:           August 2010
83 Contact:        Nitin Gupta <ngupta@vflare.org>
84 Description:
85                 The compr_data_size file is read-only and specifies compressed
86                 size of data stored in this disk. So, compression ratio can be
87                 calculated using orig_data_size and this statistic.
88                 Unit: bytes
89
90 What:           /sys/block/zram<id>/mem_used_total
91 Date:           August 2010
92 Contact:        Nitin Gupta <ngupta@vflare.org>
93 Description:
94                 The mem_used_total file is read-only and specifies the amount
95                 of memory, including allocator fragmentation and metadata
96                 overhead, allocated for this disk. So, allocator space
97                 efficiency can be calculated using compr_data_size and this
98                 statistic.
99                 Unit: bytes