README

 1zram: Compressed RAM based block devices
 2----------------------------------------
 3* Introduction
 4
 5The zram module creates RAM based block devices named /dev/zram<id>
 6(<id> = 0, 1, ...). Pages written to these disks are compressed and stored
 7in memory itself. These disks allow very fast I/O and compression provides
 8good amounts of memory savings. Some of the usecases include /tmp storage,
 9use as swap disks, various caches under /var and maybe many more :)
10
11Statistics for individual zram devices are exported through sysfs nodes at
12/sys/block/zram<id>/
13
14Kconfig required:
15CONFIG_ZRAM=y
16CONFIG_CRYPTO_LZ4=y
17CONFIG_ZSMALLOC=y
18
19ZRAM Testcases
20--------------
21zram_lib.sh: create library with initialization/cleanup functions
22zram.sh: For sanity check of CONFIG_ZRAM and to run zram01 and zram02
23
24Two functional tests: zram01 and zram02:
25zram01.sh: creates general purpose ram disks with ext4 filesystems
26zram02.sh: creates block device for swap
27
28Commands required for testing:
29 - bc
30 - dd
31 - free
32 - awk
33 - mkswap
34 - swapon
35 - swapoff
36 - mkfs/ mkfs.ext4
37
38For more information please refer:
39kernel-source-tree/Documentation/admin-guide/blockdev/zram.rst