
compcache: Compressed RAM based swap device
-------------------------------------------

Project home: http://code.google.com/p/compcache

* Introduction
This is a RAM based block device which acts as swap disk.
Pages swapped to this device are compressed and stored in
memory itself.

* Use cases
 - (Swapless) Embedded devices.
 - Desktops with limited memory (Virtual Machines!).

* Compiling
 - Run 'make': this will compile all modules against your kernel.

 - Following kernel modules are created:
   - lzo1x_compress.ko
   - lzo1x_decompress.ko
   - tlsf.ko
   - compcache.ko

* Using
 - Following scipts are included
   - use_compcache.sh <size (in KB)>
     This loads all required modules and sets up swap device.
     Size for this swap device is optional parameter. If missing,
     default size of 25% of RAM is taken.

   - unuse_compcache.sh
     Unloads all modules and turns off swap device.

* Common Problems
 - If you get lots of compile errors, make sure you have package for
   kernel source installed. For e.g., on Fedora its 'kernel-devel' package.

 - If (un)use_compcache scripts fail to work, refer to wiki:
   http://code.google.com/p/compcache/wiki/CompilingAndUsing

* Notes
 - Allocator and compcache statistics are now exported via /proc interface:
   - /proc/tlsfinfo
   - /proc/compcache
   They give useful insight into performance of these components.

Please consider using Issue Tracker:
http://code.google.com/p/compcache/issues/list
for reporting any bugs/feature requests.


Cheers!
- Nitin Gupta
(nitingupta910 at gmail dot com)

