From 270d30de1594f150c3a3cc8f7dcde15c6de5acc9 Mon Sep 17 00:00:00 2001 From: Naresh Kamboju Date: Sat, 20 Jun 2015 01:00:34 +0530 Subject: zram: Adding README Signed-off-by: Naresh Kamboju --- README | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 README diff --git a/README b/README new file mode 100644 index 0000000..c59c53e --- /dev/null +++ b/README @@ -0,0 +1,29 @@ +zram: Compressed RAM based block devices +---------------------------------------- +* Introduction + +The zram module creates RAM based block devices named /dev/zram +( = 0, 1, ...). Pages written to these disks are compressed and stored +in memory itself. These disks allow very fast I/O and compression provides +good amounts of memory savings. Some of the usecases include /tmp storage, +use as swap disks, various caches under /var and maybe many more :) + +Statistics for individual zram devices are exported through sysfs nodes at +/sys/block/zram/ + +ZRAM Testcases +-------------- +zram_lib.sh: create library with initialization/cleanup functions + +Two functional tests: zram01 and zram02: +zram01.sh: creates general purpose ram disks with ext4 filesystems +zram02.sh: creates block device for swap + +Kconfig required: +CONFIG_ZRAM=y +CONFIG_ZRAM_LZ4_COMPRESS=y +CONFIG_ZPOOL=y +CONFIG_ZSMALLOC=y + +For more information please refer: +kernel-source-tree/Documentation/blockdev/zram.txt -- cgit v1.2.3