From Gentoo Wiki
Jump to: navigation, search


zram (previously called compcache) can create RAM based block devices. It is a module of the mainline Linux kernel since 3.14. Starting with kernel version 3.15, zram supports multiple compression streams and the ability to change the compression algorithms used.


The zram driver creates a compressed block device in ram. That block device can then be used for swap or general purpose ram disk. The two most popular uses for it are swap to extend the available amount of ram to processes and /tmp. The ram used for the block device is dynamically obtained and released up to it's predefined uncompressed maximum size. The way it extends the amount of available ram to a system is by using a portion of the ram as compressed swap. It can therefore hold more pages of memory in the compressed swap than the amount of actual memory used. Typically it compresses to a 3:1 ratio. So, 1G of swap uses only 333MB of ram on average. The compression ratio including memory used for disk overhead varies depending on the % maximum space used. I found it to vary from 1.5:1 for a 1.5G disk with only 5% space used, to over 3:1 when nearly full. It also is much faster at swapping pages than typical hard disk swap.

My experience with using it, my system is still fully functional, with only slight slow downs at times. This is for a Xfce4 desktop with several apps and emerge running with PORTAGE_NICENESS=10. The memory and swap spaces were nearly maxed out. Intel Core2 Quad core 2.6Ghz, 4G ram. I had 4 - 1.5G zram disks for swap, plus 1G partition of hard drive swap as backup. At one point during linking chromium, I saw the system using just over 5G of zram swap, while using about 1.2G of ram, about 100MB of hard disk swap. The desktop was still responsive :)


Prior to kernel 3.15, each zram device contains it's own compression buffer, memory pools and other metadata as well as per-device locks. This can become a serious bottleneck for multi-core machines. To work around this problem, zram is capable of initializing multiple devices. For this reason, the recommended amount of devices for swap is 1 per cpu core for kernels prior to 3.15.

Another caveat for systems with limited memory, non swap use can reduce the amount of available memory to run applications.

Enabling zram

It is recommended that zram be built as a loadable module. Parameters specified at the loading of the module become the maximum settings that zram is capable of. For instance, the number of devices created is limited to 1 and its size set to 25% of total memory. It is possible to re-configure the size later, but you can only change the number of devices at boot time by using the kernel boot parameter


When it is a loadable module, the number of devices can be changed later without a reboot. You will however have to de-activate any existing devices before being able to increase or decrease the number of devices.

Kernel configuration

Processor type and features  --->
    <M> Memory allocator for compressed pages
Device Drivers  --->
    [*] Block devices --->
        <M> Compressed RAM block device support

In order to use the lz4 compression algorithm, you must also enable kernel support.

Cryptographic API --->
    *** Compression ***
    <*> LZ4 compression algorithm

Gentoo/OpenRC init script


By far the easiest method of utilizing zram disk(s) is by using Martin Väth's zram-init script. Note, that version 2.7 is fully compatible with kernels < 3.15. If version >= 3.0 is used, the maxs (maximum concurrent streams) and algo (compression algorithm selection) is only functional for kernels >= 3.15. Currently, both versions available in the main tree:

root #emerge --ask zram-init


Edit the /etc/conf.d/zram-init file and create/configure your desired zram devices. There is lots of comments/instructions in the file. So, proceed with editing, save it when your done.

  1. For multicore systems configure one zram swap per cpu core for linux < 3.15. For Linux >= 3.15, set maxs equal to the number of cores.
  2. Set the priority of all zram swap devices to the same value (high).
  3. Set priority of hard drive swap (low).

An example:

  • Specs: Dual core cpu, 2G total ram
  • Configure total 1G of swap, 512Mb of /tmp
FILE /etc/conf.d/zram-init
# zram settings...
# load zram kernel module on start?

# unload zram kernel module on stop?
# Number of devices.
# It is also passed to the kernel module on modprobe.

# For each device, specify type, size, maxs, algo, flags, opts mode, owgr.
# The last three can be omitted for swap but *must* be specified for others.
# Specify as empty if unneeded.
# type0, type1, ... are the variables for the types.
# size0, size1, ... are the variables for the sizes.
# maxs0, maxs1, ... are the variables for the maximal (parallel) streams.
# algo0, algo1, ... are the variables for the compression algorithms.
# flag0, flag1, ... are the variables for the flags.
# Except for swap:
# opts0, opts1, ... are the variables for the mount options.
# mode0, mode1, ... are the variables for the directory mode.
# owgr0, owgr1, ... are the variables for the directory owner:group.
# The size is in megabytes.
# If the size is 0 (or empty) the device is ignored by the script.
# Available types:
# "swap"  The device is initialized as a swap device.
#         The flags variable specifies the priority (16383 if empty).
#         Use "-" in the flags variable for the default priority (-1)
# "/..."  The device is mounted on /...
#         The flags variable specifies the type (ext2 or ext4, default is ext4)
# Devices with other types are ignored by the script
# Only variables with numbers  0 ... num_devices-1  are used by the script.





Add the init script to the desired runlevel, usually boot:

root #rc-config add zram-init boot
root #/etc/init.d/zram-init start

In this case, boot is preferable to default because if your zram is providing a filesystem such as /tmp or /var/tmp, it would need to be mounted prior to any access to it during the default runtime.

Systemd support

sys-block/zram-init also provides systemd units with self explaining names:

  • zram_swap.service
  • zram_tmp.service
  • zram_var_tmp.service

Manual method

For manual creation, you can use /etc/local.d and supply it with 2 files. A zram.start and a zram.stop. OpenRC will run these as appropriate as part of it's normal operation.

An example:

  • Specs: 4 cpu cores, 4G ram total
  • Configure 4 1.5G zram swap and activate.
  • Estimated maximum ram used 2G @ 3:1 compression
FILE /etc/local.d/zram.start

modprobe zram num_devices=4

echo $(($SIZE*1024*1024)) > /sys/block/zram0/disksize
echo $(($SIZE*1024*1024)) > /sys/block/zram1/disksize
echo $(($SIZE*1024*1024)) > /sys/block/zram2/disksize
echo $(($SIZE*1024*1024)) > /sys/block/zram3/disksize

mkswap /dev/zram0
mkswap /dev/zram1
mkswap /dev/zram2
mkswap /dev/zram3

swapon /dev/zram0 -p 10
swapon /dev/zram1 -p 10
swapon /dev/zram2 -p 10
swapon /dev/zram3 -p 10
FILE /etc/local.d/zram.stop

swapoff /dev/zram0
swapoff /dev/zram1
swapoff /dev/zram2
swapoff /dev/zram3

echo 1 > /sys/block/zram0/reset
echo 1 > /sys/block/zram1/reset
echo 1 > /sys/block/zram2/reset
echo 1 > /sys/block/zram3/reset

modprobe -r zram
Disksize may also be specified using mem suffixes (K, M, G): echo 1536M > /sys/block/zram0/disksize

Using existing tools

Other possibility is to use existing configuration files - this option works on vanilla Gentoo without need to install additional software, also useful if you are using systemd instead of OpenRC. The first example can be implemented using:

FILE /etc/udev/rules.d/10-zram.rules
KERNEL=="zram0", SUBSYSTEM=="block", DRIVER=="", ACTION=="add", ATTR{disksize}=="0", ATTR{disksize}="512M", RUN+="/sbin/mkswap $env{DEVNAME}"
KERNEL=="zram1", SUBSYSTEM=="block", DRIVER=="", ACTION=="add", ATTR{disksize}=="0", ATTR{disksize}="512M", RUN+="/sbin/mkswap $env{DEVNAME}"
KERNEL=="zram2", SUBSYSTEM=="block", DRIVER=="", ACTION=="add", ATTR{disksize}=="0", ATTR{disksize}="512M", RUN+="/sbin/mkfs.ext4 $env{DEVNAME}"
# if you want lz4 support (since kernel 3.15) and without ext4 journaling 
# KERNEL=="zram2", SUBSYSTEM=="block", DRIVER=="", ACTION=="add", ATTR{initstate}=="0", ATTR{comp_algorithm}="lz4", ATTR{disksize}="512M", RUN+="/sbin/mkfs.ext4 -O ^has_journal -L $name $env{DEVNAME}"
FILE /etc/fstab
/dev/zram0              swap                    swap            pri=16383                                                       0 0
/dev/zram1              swap                    swap            pri=16383                                                       0 0
/dev/zram2              /tmp                    ext4            defaults                                                        0 0
FILE /etc/modprobe.d/zram.conf
options zram num_devices=3

Additionally, the zramctl utility is part of sys-apps/util-linux and can be used to configure zram devices. See man zramctl for examples of usage.

Usage with an SSD

When using this with a really fast SSD (e.g. Samsung 840 Pro), avoid setting rc_parallel=YES in /etc/rc.conf. Depending on the size of the zram partitions and the speed of your RAM, some swap partitions and filesystems might not be ready when the swap and localmount services are started. In such case, if you absolutely have to use parallel, consider removing these services from runlevel boot and adding them to default instead.