# Using the Garbage Collector: A simple example

The following consists of step-by-step instructions for building and using the
collector. Let's assume a Linux/gcc platform and a single-threaded
application. The green text contains information about other platforms
or scenarios. It can be skipped, especially on first reading.

## Building the collector

If you have not so yet, unpack the collector and enter the newly created
directory with:

```sh
tar xvfz gc-<version>.tar.gz
cd gc-<version>
```

You can configure, build, and install the collector in a private directory,
say /home/xyz/gc, with the following commands:

```sh
./configure --prefix=/home/xyz/gc --disable-threads
make
make check
make install
```

Here the `make check` command is optional, but highly recommended. It runs
a basic correctness test which usually takes well under a minute.

### Other platforms

The old way, probably suitable for ancient platforms, is to build the
collector by copying the appropriate makefile (e.g., `Makefile.direct` file,
see the platform-specific `README` in `docs/platforms` folder in the
distribution) to the file `Makefile`, and then typing `make` (or `nmake`
or similar). This builds the library in the source tree. You may want
to move it and the files in the include directory to a more convenient place.

If you use a makefile that does not require running a configure script, you
should first look at the makefile, and adjust any options that are documented
there.

If your platform provides a `make` utility, that is generally preferred
to platform- and compiler-dependent "project" files. (At least that is the
strong preference of the would-be maintainer of those project files.)

### Threads

If you do not need thread support, configure the collector with
`--disable-threads` option.

Alternatively, if your target is a real old-fashioned uniprocessor (no
"hyperthreading", etc.), you may just want to turn off parallel marking with
`--disable-parallel-mark`.

### C++

You will need to include the C++ support, which unfortunately tends to be
among the least portable parts of the collector, since it seems to rely
on some corner cases of the language. On Linux, it suffices to add
`--enable-cplusplus` to the configure options.

## Writing the program

You will need to include `gc.h` file at the beginning of every file that
allocates memory through the garbage collector. Call `GC_MALLOC` wherever you
would have call `malloc`. This initializes memory to zero like `calloc`;
there is no need to explicitly clear the result.

If you know that an object will not contain pointers to the garbage-collected
heap, and you do not need it to be initialized, call `GC_MALLOC_ATOMIC`
instead.

A function `GC_FREE` is provided but need not be called. For very small
objects, your program will probably perform better if you do not call it, and
let the collector do its job.

A `GC_REALLOC` function behaves like the C library `realloc`. It allocates
uninitialized pointer-free memory if the original object was allocated that
way.

The following program `loop.c` is a trivial example:

```c
#include "gc.h"

#include <assert.h>
#include <stdio.h>

int main(void) {
  int i;

  GC_INIT();
  for (i = 0; i < 10000000; ++i) {
    int **p = (int **)GC_MALLOC(sizeof(int *));
    int *q = (int *)GC_MALLOC_ATOMIC(sizeof(int));
    assert(*p == 0);
    *p = (int *)GC_REALLOC(q, 2 * sizeof(int));
    if (i % 100000 == 0)
      printf("Heap size = %lu bytes\n",
             (unsigned long)GC_get_heap_size());
  }
  return 0;
}
```


### Interaction with the system malloc

It is usually best not to mix garbage-collected allocation with the system
`malloc`-`free`. If you do, you need to be careful not to store pointers
to the garbage-collected heap in memory allocated with the system `malloc`.

### Other Platforms

On some other platforms it is necessary to call `GC_INIT` from the main
program, which is presumed to be part of the main executable, not a dynamic
library. This can never hurt, and is thus generally good practice.

### Threads

For a multi-threaded program, some more rules apply:

  * Files that either allocate through the GC _or make thread-related calls_
  should first define the macro `GC_THREADS`, and then include `gc.h` file.
  On some platforms this will redefine some threads primitives, e.g. to let
  the collector keep track of thread creation.

### C++

In the case of C++, you need to be especially careful not to store pointers
to the garbage-collected heap in areas that are not traced by the collector.
The collector includes some _alternate interfaces_ to make that easier.

### Debugging

Additional debug checks can be performed by defining `GC_DEBUG` before
include `gc.h` file. Additional options are available if the collector is also
built with `--enable-gc-debug` and all allocations are performed with
`GC_DEBUG` defined.

### What if I cannot rewrite/recompile my program?

You may be able to build the collector with `--enable-redirect-malloc` and set
the `LD_PRELOAD` environment variable to point to the resulting library, thus
replacing the standard `malloc` with its garbage-collected counterpart. This
is rather platform dependent. See the _GC leak detection documentation_ for
some more details.

## Compiling and linking

The above application `loop.c` test program can be compiled and linked with:

```sh
cc -I/home/xyz/gc/include loop.c /home/xyz/gc/lib/libgc.a -o loop
```

The `-I` option directs the compiler to the right include directory. In this
case, we list the static library directly on the compile line; the dynamic
library could have been used instead, provided we arranged for the dynamic
loader to find it, e.g. by setting `LD_LIBRARY_PATH`.

### Threads

On `pthreads` platforms, you will of course also have to link with
`-lpthread`, and compile with any thread-safety options required by your
compiler. On some platforms, you may also need to link with `-ldl` or `-lrt`.
Looking at `tools/threadlibs.c` should give you the appropriate list if
a plain `-lpthread` does not work.

## Running the executable

The executable can of course be run normally, e.g. by typing:

```sh
./loop
```

The operation of the collector is affected by a number of environment
variables. For example, setting `GC_PRINT_STATS` produces some collector
statistics to `stdout`. See [environment.md](environment.md) file for the
details.
