README


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

compll - A compressed memory allocator
======================================

DESCRIPTION

  compll is a small library that provides replacement functions for malloc()
  and free() that allow the application memory to be compressed.


INSTALLATION

  Due to the small size of this library, it is recommended to simply add the
  compll.h and compll.c files to your project and compile and statically link
  them into your application as if they were part of your project.

  The library should compile on any conforming C99 compiler, or a C89 compiler
  with support for 'long long' integers. [unsigned] short types are assumed to
  be exactly 16 bits wide. So far, only GCC has been tested.

  A minimal Makefile is included to build an object file from the library and
  to run the tests. The test suite requires quite a bit of memory in addition
  to the 'prove' program, which should come with a default installation of
  Perl.


USAGE

  Read the compll.h header file for the function prototypes and documentation
  on how to use these in your application. Refer to the report "Design and
  implementation of a compressed linked list library" for a more detailed
  explanation of the API and inner workings of the library.