Documentation/blockdev/zram.txt

   1 zram: Compressed RAM based block devices
   2 ----------------------------------------
   3
   4 * Introduction
   5
   6 The zram module creates RAM based block devices named /dev/zram<id>
   7 (<id> = 0, 1, ...). Pages written to these disks are compressed and stored
   8 in memory itself. These disks allow very fast I/O and compression provides
   9 good amounts of memory savings. Some of the usecases include /tmp storage,
  10 use as swap disks, various caches under /var and maybe many more :)
  11
  12 Statistics for individual zram devices are exported through sysfs nodes at
  13 /sys/block/zram<id>/
  14
  15 * Usage
  16
  17 Following shows a typical sequence of steps for using zram.
  18
  19 1) Load Module:
  20         modprobe zram num_devices=4
  21         This creates 4 devices: /dev/zram{0,1,2,3}
  22         (num_devices parameter is optional. Default: 1)
  23
  24 2) Set Disksize
  25         Set disk size by writing the value to sysfs node 'disksize'.
  26         The value can be either in bytes or you can use mem suffixes.
  27         Examples:
  28             # Initialize /dev/zram0 with 50MB disksize
  29             echo $((50*1024*1024)) > /sys/block/zram0/disksize
  30
  31             # Using mem suffixes
  32             echo 256K > /sys/block/zram0/disksize
  33             echo 512M > /sys/block/zram0/disksize
  34             echo 1G > /sys/block/zram0/disksize
  35
  36 Note:
  37 There is little point creating a zram of greater than twice the size of memory
  38 since we expect a 2:1 compression ratio. Note that zram uses about 0.1% of the
  39 size of the disk when not in use so a huge zram is wasteful.
  40
  41 3) Activate:
  42         mkswap /dev/zram0
  43         swapon /dev/zram0
  44
  45         mkfs.ext4 /dev/zram1
  46         mount /dev/zram1 /tmp
  47
  48 4) Stats:
  49         Per-device statistics are exported as various nodes under
  50         /sys/block/zram<id>/
  51                 disksize
  52                 num_reads
  53                 num_writes
  54                 failed_reads
  55                 failed_writes
  56                 invalid_io
  57                 notify_free
  58                 zero_pages
  59                 orig_data_size
  60                 compr_data_size
  61                 mem_used_total
  62
  63 5) Deactivate:
  64         swapoff /dev/zram0
  65         umount /dev/zram1
  66
  67 6) Reset:
  68         Write any positive value to 'reset' sysfs node
  69         echo 1 > /sys/block/zram0/reset
  70         echo 1 > /sys/block/zram1/reset
  71
  72         This frees all the memory allocated for the given device and
  73         resets the disksize to zero. You must set the disksize again
  74         before reusing the device.
  75
  76 Nitin Gupta
  77 ngupta@vflare.org