[PATCH 10/10] Document sysfs entries

Previous message: [thread] [date] [author]
Next message: [thread] [date] [author]
From: Nitin Gupta
Date: Monday, August 9, 2010 - 10:26 am

Signed-off-by: Nitin Gupta <ngupta@vflare.org>
---
 Documentation/ABI/testing/sysfs-block-zram |   99 ++++++++++++++++++++++++++++
 1 files changed, 99 insertions(+), 0 deletions(-)
 create mode 100644 Documentation/ABI/testing/sysfs-block-zram

diff --git a/Documentation/ABI/testing/sysfs-block-zram b/Documentation/ABI/testing/sysfs-block-zram
new file mode 100644
index 0000000..c8b3b48
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-block-zram
@@ -0,0 +1,99 @@
+What:		/sys/block/zram<id>/disksize
+Date:		August 2010
+Contact:	Nitin Gupta <ngupta@vflare.org>
+Description:
+		The disksize file is read-write and specifies the disk size
+		which represents the limit on the *uncompressed* worth of data
+		that can be stored in this disk.
+
+What:		/sys/block/zram<id>/initstate
+Date:		August 2010
+Contact:	Nitin Gupta <ngupta@vflare.org>
+Description:
+		The disksize file is read-only and shows the initialization
+		state of the device.
+
+What:		/sys/block/zram<id>/reset
+Date:		August 2010
+Contact:	Nitin Gupta <ngupta@vflare.org>
+Description:
+		The disksize file is write-only and allows resetting the
+		device. The reset operation frees all the memory assocaited
+		with this device.
+
+What:		/sys/block/zram<id>/num_reads
+Date:		August 2010
+Contact:	Nitin Gupta <ngupta@vflare.org>
+Description:
+		The num_reads file is read-only and specifies the number of
+		reads (failed or successful) done on this device.
+
+What:		/sys/block/zram<id>/num_writes
+Date:		August 2010
+Contact:	Nitin Gupta <ngupta@vflare.org>
+Description:
+		The num_writes file is read-only and specifies the number of
+		writes (failed or successful) done on this device.
+
+What:		/sys/block/zram<id>/invalid_io
+Date:		August 2010
+Contact:	Nitin Gupta <ngupta@vflare.org>
+Description:
+		The invalid_io file is read-only and specifies the number of
+		non-page-size-aligned I/O requests issued to this device.
+
+What:		/sys/block/zram<id>/notify_free
+Date:		August 2010
+Contact:	Nitin Gupta <ngupta@vflare.org>
+Description:
+		The notify_free file is read-only and specifies the number of
+		swap slot free notifications received by this device. These
+		notifications are send to a swap block device when a swap slot
+		is freed. This statistic is applicable only when this disk is
+		being used as a swap disk.
+
+What:		/sys/block/zram<id>/discard
+Date:		August 2010
+Contact:	Nitin Gupta <ngupta@vflare.org>
+Description:
+		The discard file is read-only and specifies the number of
+		discard requests received by this device. These requests
+		provide information to block device regarding blocks which are
+		no longer used by filesystem.
+
+What:		/sys/block/zram<id>/zero_pages
+Date:		August 2010
+Contact:	Nitin Gupta <ngupta@vflare.org>
+Description:
+		The zero_pages file is read-only and specifies number of zero
+		filled pages written to this disk. No memory is allocated for
+		such pages.
+
+What:		/sys/block/zram<id>/orig_data_size
+Date:		August 2010
+Contact:	Nitin Gupta <ngupta@vflare.org>
+Description:
+		The orig_data_size file is read-only and specifies uncompressed
+		size of data stored in this disk. This excludes zero-filled
+		pages (zero_pages) since no memory is allocated for them.
+		Unit: bytes
+
+What:		/sys/block/zram<id>/compr_data_size
+Date:		August 2010
+Contact:	Nitin Gupta <ngupta@vflare.org>
+Description:
+		The compr_data_size file is read-only and specifies compressed
+		size of data stored in this disk. So, compression ratio can be
+		calculated using orig_data_size and this statistic.
+		Unit: bytes
+
+What:		/sys/block/zram<id>/mem_used_total
+Date:		August 2010
+Contact:	Nitin Gupta <ngupta@vflare.org>
+Description:
+		The mem_used_total file is read-only and specifies the amount
+		of memory, including allocator fragmentation and metadata
+		overhead, allocated for this disk. So, allocator space
+		efficiency can be calculated using compr_data_size and this
+		statistic.
+		Unit: bytes
\ No newline at end of file
-- 
1.7.2.1

--
Previous message: [thread] [date] [author]
Next message: [thread] [date] [author]

Messages in current thread:
[PATCH 00/10] zram: various improvements and cleanups, Nitin Gupta, (Mon Aug 9, 10:26 am)
[PATCH 01/10] Replace ioctls with sysfs interface, Nitin Gupta, (Mon Aug 9, 10:26 am)
[PATCH 03/10] Use percpu stats, Nitin Gupta, (Mon Aug 9, 10:26 am)
[PATCH 04/10] Use percpu buffers, Nitin Gupta, (Mon Aug 9, 10:26 am)
[PATCH 06/10] Block discard support, Nitin Gupta, (Mon Aug 9, 10:26 am)
[PATCH 07/10] Increase compressed page size threshold, Nitin Gupta, (Mon Aug 9, 10:26 am)
[PATCH 08/10] Some cleanups, Nitin Gupta, (Mon Aug 9, 10:26 am)
[PATCH 09/10] Update zram documentation, Nitin Gupta, (Mon Aug 9, 10:26 am)
[PATCH 10/10] Document sysfs entries, Nitin Gupta, (Mon Aug 9, 10:26 am)
Re: [PATCH 01/10] Replace ioctls with sysfs interface, Pekka Enberg, (Mon Aug 9, 11:34 am)
Re: [PATCH 03/10] Use percpu stats, Pekka Enberg, (Mon Aug 9, 11:44 am)
Re: [PATCH 04/10] Use percpu buffers, Pekka Enberg, (Mon Aug 9, 11:57 am)
Re: [PATCH 08/10] Some cleanups, Pekka Enberg, (Mon Aug 9, 12:02 pm)
Re: [PATCH 10/10] Document sysfs entries, Pekka Enberg, (Mon Aug 9, 12:02 pm)
Re: [PATCH 06/10] Block discard support, Pekka Enberg, (Mon Aug 9, 12:03 pm)
Re: [PATCH 06/10] Block discard support, Jens Axboe, (Mon Aug 9, 7:23 pm)
Re: [PATCH 03/10] Use percpu stats, Andrew Morton, (Mon Aug 9, 9:34 pm)
Re: [PATCH 04/10] Use percpu buffers, Nitin Gupta, (Mon Aug 9, 9:47 pm)
Re: [PATCH 06/10] Block discard support, Nitin Gupta, (Mon Aug 9, 9:54 pm)
Re: [PATCH 04/10] Use percpu buffers, Pekka Enberg, (Mon Aug 9, 10:05 pm)
Re: [PATCH 04/10] Use percpu buffers, Nitin Gupta, (Mon Aug 9, 10:32 pm)
Re: [PATCH 04/10] Use percpu buffers, Pekka Enberg, (Tue Aug 10, 12:36 am)
Re: [PATCH 06/10] Block discard support, Jens Axboe, (Tue Aug 10, 8:54 am)
Re: [PATCH 03/10] Use percpu stats, Nitin Gupta, (Wed Aug 11, 9:39 am)
Re: [PATCH 03/10] Use percpu stats, Andrew Morton, (Wed Aug 11, 10:18 am)
Re: [PATCH 03/10] Use percpu stats, Christoph Lameter, (Mon Aug 30, 9:20 am)
Re: [PATCH 03/10] Use percpu stats, Nitin Gupta, (Tue Aug 31, 1:31 pm)
Re: [PATCH 03/10] Use percpu stats, Eric Dumazet, (Tue Aug 31, 2:28 pm)
Re: [PATCH 03/10] Use percpu stats, Christoph Lameter, (Tue Aug 31, 2:35 pm)
Re: [PATCH 03/10] Use percpu stats, Eric Dumazet, (Tue Aug 31, 2:41 pm)
Re: [PATCH 01/10] Replace ioctls with sysfs interface, Dave Hansen, (Tue Aug 31, 4:06 pm)
Re: [PATCH 00/10] zram: various improvements and cleanups, Anton Blanchard, (Tue Aug 31, 8:32 pm)
Re: [PATCH 03/10] Use percpu stats, Anton Blanchard, (Tue Aug 31, 8:41 pm)
Re: [PATCH 03/10] Use percpu stats, Anton Blanchard, (Tue Aug 31, 8:51 pm)
Re: [PATCH 03/10] Use percpu stats, Christoph Lameter, (Wed Sep 1, 1:05 pm)
Re: [PATCH 03/10] Use percpu stats, Eric Dumazet, (Wed Sep 1, 1:38 pm)
Re: [PATCH 03/10] Use percpu stats, Christoph Lameter, (Wed Sep 1, 5:34 pm)
Re: [PATCH 03/10] Use percpu stats, Andrew Morton, (Fri Sep 17, 1:59 pm)
Re: OOM panics with zram, Nitin Gupta, (Sun Oct 3, 11:41 am)
Re: OOM panics with zram, Dave Hansen, (Sun Oct 3, 12:27 pm)
Re: OOM panics with zram, Nitin Gupta, (Sun Oct 3, 12:40 pm)
Re: OOM panics with zram, Ed Tomlinson, (Mon Oct 4, 4:08 am)
Re: OOM panics with zram, Greg KH, (Tue Oct 5, 4:43 pm)
Re: OOM panics with zram, Nitin Gupta, (Tue Oct 5, 7:29 pm)
Re: OOM panics with zram, Greg KH, (Tue Oct 5, 7:36 pm)
Re: OOM panics with zram, Nitin Gupta, (Tue Oct 5, 9:30 pm)
Re: OOM panics with zram, Pekka Enberg, (Wed Oct 6, 12:38 am)
Re: OOM panics with zram, Greg KH, (Wed Oct 6, 7:02 am)
Re: OOM panics with zram, Greg KH, (Wed Oct 6, 7:03 am)
Re: OOM panics with zram, Pekka Enberg, (Wed Oct 6, 7:16 am)
Re: OOM panics with zram, Nitin Gupta, (Wed Oct 6, 7:53 am)