Date:2010-05-26 07:24:21 (12 years 4 months ago)
Author:Nitin Gupta
Commit:8b74237fa21aee6caf700e5a23c89d67c999804e
Message:Rename ramzswap to zram in documentation

Related changes:
- Included example to show usage as generic
(non-swap) disk with ext4 filesystem.
- Renamed rzscontrol to zramconfig to match
with new device naming.

Signed-off-by: Nitin Gupta <ngupta@vflare.org>
Files: drivers/staging/zram/zram.txt (1 diff)

Change Details

drivers/staging/zram/zram.txt
1ramzswap: Compressed RAM based swap device
1zram: Compressed RAM based block devices
2----------------------------------------
23
34Project home: http://compcache.googlecode.com/
45
56* Introduction
67
7The ramzswap module creates RAM based block devices which can (only) be used as
8swap disks. Pages swapped to these devices are compressed and stored in memory
9itself. See project home for use cases, performance numbers and a lot more.
8The zram module creates RAM based block devices: /dev/ramX (X = 0, 1, ...).
9Pages written to these disks are compressed and stored in memory itself.
10These disks allow very fast I/O and compression provides good amounts of
11memory savings.
1012
11Individual ramzswap devices are configured and initialized using rzscontrol
12userspace utility as shown in examples below. See rzscontrol man page for more
13details.
13See project home for use cases, performance numbers and a lot more.
14
15Individual zram devices are configured and initialized using zramconfig
16userspace utility as shown in examples below. See zramconfig man page for
17more details.
1418
1519* Usage
1620
17Following shows a typical sequence of steps for using ramzswap.
21Following shows a typical sequence of steps for using zram.
1822
19231) Load Modules:
20    modprobe ramzswap num_devices=4
21    This creates 4 (uninitialized) devices: /dev/ramzswap{0,1,2,3}
24    modprobe zram num_devices=4
25    This creates 4 (uninitialized) devices: /dev/zram{0,1,2,3}
2226    (num_devices parameter is optional. Default: 1)
2327
24282) Initialize:
25    Use rzscontrol utility to configure and initialize individual
26    ramzswap devices. Example:
27    rzscontrol /dev/ramzswap2 --init # uses default value of disksize_kb
29    Use zramconfig utility to configure and initialize individual
30    zram devices. For example:
31    zramconfig /dev/zram0 --init # uses default value of disksize_kb
32    zramconfig /dev/zram1 --disksize_kb=102400 # 100MB /dev/zram1
2833
29    *See rzscontrol man page for more details and examples*
34    *See zramconfig man page for more details and examples*
3035
31363) Activate:
32    swapon /dev/ramzswap2 # or any other initialized ramzswap device
37    mkswap /dev/zram0
38    swapon /dev/zram0
39
40    mkfs.ext4 /dev/zram1
41    mount /dev/zram1 /tmp
3342
34434) Stats:
35    rzscontrol /dev/ramzswap2 --stats
44    zramconfig /dev/zram0 --stats
45    zramconfig /dev/zram1 --stats
3646
37475) Deactivate:
38    swapoff /dev/ramzswap2
48    swapoff /dev/zram0
49    umount /dev/zram1
3950
40516) Reset:
41    rzscontrol /dev/ramzswap2 --reset
42    (This frees all the memory allocated for this device).
52    zramconfig /dev/zram0 --reset
53    zramconfig /dev/zram1 --reset
54    (This frees memory allocated for the given device).
4355
4456
4557Please report any problems at:

Archive Download the corresponding diff file



interactive