drivers/staging/ramzswap/ramzswap.txt

   1 ramzswap: Compressed RAM based swap device
   2 -------------------------------------------
   3
   4 Project home: http://compcache.googlecode.com/
   5
   6 * Introduction
   7
   8 The ramzswap module creates RAM based block devices which can (only) be used as
   9 swap disks. Pages swapped to these devices are compressed and stored in memory
  10 itself. See project home for use cases, performance numbers and a lot more.
  11
  12 Individual ramzswap devices are configured and initialized using rzscontrol
  13 userspace utility as shown in examples below. See rzscontrol man page for more
  14 details.
  15
  16 * Usage
  17
  18 Following shows a typical sequence of steps for using ramzswap.
  19
  20 1) Load Modules:
  21         modprobe ramzswap num_devices=4
  22         This creates 4 (uninitialized) devices: /dev/ramzswap{0,1,2,3}
  23         (num_devices parameter is optional. Default: 1)
  24
  25 2) Initialize:
  26         Use rzscontrol utility to configure and initialize individual
  27         ramzswap devices. Example:
  28         rzscontrol /dev/ramzswap2 --init # uses default value of disksize_kb
  29
  30         *See rzscontrol man page for more details and examples*
  31
  32 3) Activate:
  33         swapon /dev/ramzswap2 # or any other initialized ramzswap device
  34
  35 4) Stats:
  36         rzscontrol /dev/ramzswap2 --stats
  37
  38 5) Deactivate:
  39         swapoff /dev/ramzswap2
  40
  41 6) Reset:
  42         rzscontrol /dev/ramzswap2 --reset
  43         (This frees all the memory allocated for this device).
  44
  45
  46 Please report any problems at:
  47  - Mailing list: linux-mm-cc at laptop dot org
  48  - Issue tracker: http://code.google.com/p/compcache/issues/list
  49
  50 Nitin Gupta
  51 ngupta@vflare.org