A garbage collector for C and C++

http://www.hpl.hp.com/personal/Hans_Boehm/gc

http://reality.sgi.com/boehm/gc.html

ftp://parcftp.xerox.com/pub/gc/gc.html

The Boehm-Demers-Weiser conservative garbage collector can be used as a garbage collecting replacement for C malloc or C++ new . It allows you to allocate memory basically as you normally would, without explicitly deallocating memory that is no longer useful. The collector automatically recycles memory when it determines that it can no longer be otherwise accessed. A simple example of such a use is given here.

The collector is also used by a number of programming language implementations that either use C as intermediate code, want to facilitate easier interoperation with C libraries, or just prefer the simple collector interface. For a more detailed description of the interface, see here.

Alternatively, the garbage collector may be used as a leak detector for C or C++ programs, though that is not its primary goal.

The arguments for and against conservative garbage collection in C and C++ are briefly discussed in issues.html. The beginnings of a frequently-asked-questions list are here.

Empirically, this collector works with most unmodified C programs, simply by replacing malloc with GC_malloc calls, replacing realloc with GC_realloc calls, and removing free calls. Exceptions are discussed in issues.html.

Many versions are available in the gc_source subdirectory. Currently a fairly recent stable version is gc-8.0.4.tar.gz . Note that this uses the new version numbering scheme and may require a separate libatomic_ops download (see below).

If that fails, try the latest explicitly numbered version in gc_source . Later versions may contain additional features, platform support, or bug fixes, but are likely to be less well tested.

Version 7.3 and later require that you download a corresponding version of libatomic_ops, which should be available in https://github.com/ivmai/libatomic_ops/wiki/Download . The current version is also available as gc_source/libatomic_ops-7.6.10.tar.gz . You will need to place that in a libatomic_ops subdirectory.

Previously it was best to use corresponding versions of gc and libatomic_ops, but for recent versions, it should be OK to mix and match them.

Starting with 8.0, libatomic_ops is only required if the compiler does not understand C atomics.

The development version of the GC source code now resides on github, along with the downloadable packages. The GC tree itself is at https://github.com/ivmai/bdwgc/ . The libatomic_ops tree required by the GC is at https://github.com/ivmai/libatomic_ops/ .

To build a working version of the collector, you will need to do something like the following, where D is the absolute path to an installation directory:

cd D git clone git://github.com/ivmai/libatomic_ops.git git clone git://github.com/ivmai/bdwgc.git ln -s D/libatomic_ops D/bdwgc/libatomic_ops cd bdwgc autoreconf -vif automake --add-missing ./configure make

git

automake

autoconf

libtool

Historical versions of the source can still be found on the SourceForge site (project "bdwgc") here.

The garbage collector code is copyrighted by Hans-J. Boehm, Alan J. Demers, Xerox Corporation, Silicon Graphics, and Hewlett-Packard Company. It may be used and copied without payment of a fee under minimal restrictions. See the README file in the distribution or the license for more details. IT IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED OR IMPLIED. ANY USE IS AT YOUR OWN RISK.

Irix pthreads, Linux threads, Win32 threads, Solaris threads (old style and pthreads), HP/UX 11 pthreads, Tru64 pthreads, and MacOS X threads are supported in recent versions.

Separately distributed ports

http://homepage.mac.com/pcbeard/gc/

Several Linux and BSD versions provide prepacked versions of the collector. The Debian port can be found at https://packages.debian.org/sid/libgc-dev.

http://www.yl.is.s.u-tokyo.ac.jp/gc/

scale.html

gc.h

For an overview of the implementation, see here.

The garbage collector distribution includes a C string (cord) package that provides for fast concatenation and substring operations on long strings. A simple curses- and win32-based editor that represents the entire file as a cord is included as a sample application.

Performance of the nonincremental collector is typically competitive with malloc/free implementations. Both space and time overhead are likely to be only slightly higher for programs written for malloc/free (see Detlefs, Dosser and Zorn's Memory Allocation Costs in Large C and C++ Programs.) For programs allocating primarily very small objects, the collector may be faster; for programs allocating primarily large objects it will be slower. If the collector is used in a multithreaded environment and configured for thread-local allocation, it may in some cases significantly outperform malloc/free allocation in time.

We also expect that in many cases any additional overhead will be more than compensated for by decreased copying etc. if programs are written and tuned for garbage collection.

The following provide information on garbage collection in general:

Paul Wilson's garbage collection ftp archive and GC survey.

The Ravenbrook Memory Management Reference.

David Chase's GC FAQ.

Richard Jones' GC page and his book.

The following papers describe the collector algorithms we use and the underlying design decisions at a higher level.

(Some of the lower level details can be found here.)

The first one is not available electronically due to copyright considerations. Most of the others are subject to ACM copyright.

Boehm, H., "Dynamic Memory Allocation and Garbage Collection", Computers in Physics 9, 3, May/June 1995, pp. 297-303. This is directed at an otherwise sophisticated audience unfamiliar with memory allocation issues. The algorithmic details differ from those in the implementation. There is a related letter to the editor and a minor correction in the next issue.

Boehm, H., and M. Weiser, "Garbage Collection in an Uncooperative Environment", Software Practice & Experience, September 1988, pp. 807-820.

Boehm, H., A. Demers, and S. Shenker, "Mostly Parallel Garbage Collection", Proceedings of the ACM SIGPLAN '91 Conference on Programming Language Design and Implementation, SIGPLAN Notices 26, 6 (June 1991), pp. 157-164.

Boehm, H., "Space Efficient Conservative Garbage Collection", Proceedings of the ACM SIGPLAN '93 Conference on Programming Language Design and Implementation, SIGPLAN Notices 28, 6 (June 1993), pp. 197-206.

Boehm, H., "Reducing Garbage Collector Cache Misses", Proceedings of the 2000 International Symposium on Memory Management . Official version. Technical report version. Describes the prefetch strategy incorporated into the collector for some platforms. Explains why the sweep phase of a "mark-sweep" collector should not really be a distinct phase.

M. Serrano, H. Boehm, "Understanding Memory Allocation of Scheme Programs", Proceedings of the Fifth ACM SIGPLAN International Conference on Functional Programming, 2000, Montreal, Canada, pp. 245-256. Official version. Earlier Technical Report version. Includes some discussion of the collector debugging facilities for identifying causes of memory retention.

Boehm, H., "Fast Multiprocessor Memory Allocation and Garbage Collection", HP Labs Technical Report HPL 2000-165. Discusses the parallel collection algorithms, and presents some performance results.

Boehm, H., "Bounding Space Usage of Conservative Garbage Collectors", Proceeedings of the 2002 ACM SIGPLAN-SIGACT Symposium on Principles of Programming Languages, Jan. 2002, pp. 93-100. Official version. Technical report version. Includes a discussion of a collector facility to much more reliably test for the potential of unbounded heap growth.

The following papers discuss language and compiler restrictions necessary to guaranteed safety of conservative garbage collection.

We thank John Levine and JCLT for allowing us to make the second paper available electronically, and providing PostScript for the final version.

Boehm, H., ``Simple Garbage-Collector-Safety'', Proceedings of the ACM SIGPLAN '96 Conference on Programming Language Design and Implementation.

Boehm, H., and D. Chase, ``A Proposal for Garbage-Collector-Safe C Compilation'', Journal of C Language Translation 4, 2 (Decemeber 1992), pp. 126-141.

Other related information:

The Detlefs, Dosser and Zorn's Memory Allocation Costs in Large C and C++ Programs. This is a performance comparison of the Boehm-Demers-Weiser collector to malloc/free, using programs written for malloc/free.

Joel Bartlett's mostly copying conservative garbage collector for C++.

John Ellis and David Detlef's Safe Efficient Garbage Collection for C++ proposal.

Henry Baker's paper collection.

Slides for Hans Boehm's Allocation and GC Myths talk.

This section has not been updated recently.

Known current users of some variant of this collector include:

The runtime system for GCJ, the static GNU java compiler.

W3m, a text-based web browser.

Some versions of the Xerox DocuPrint printer software.

The Mozilla project, as leak detector.

The Mono project, an open source implementation of the .NET development framework.

The DotGNU Portable.NET project, another open source .NET implementation.

The Irssi IRC client.

The Berkeley Titanium project.

The NAGWare f90 Fortran 90 compiler.

Elwood Corporation's Eclipse Common Lisp system, C library, and translator.

The Bigloo Scheme and Camloo ML compilers written by Manuel Serrano and others.

Brent Benson's libscheme.

The MzScheme scheme implementation.

The University of Washington Cecil Implementation.

The Berkeley Sather implementation.

The Berkeley Harmonia Project.

The Toba Java Virtual Machine to C translator.

The Gwydion Dylan compiler.

The GNU Objective C runtime.

Macaulay 2, a system to support research in algebraic geometry and commutative algebra.

The Vesta configuration management system.

Visual Prolog 6.

Asymptote LaTeX-compatible vector graphics language.

Description of alternate interfaces to the garbage collector.

Slides from an ISMM 2004 tutorial about the GC.

A FAQ (frequently asked questions) list.

How to use the garbage collector as a leak detector.

Some hints on debugging garbage collected applications.

An overview of the implementation of the garbage collector.

Instructions for porting the collector to new platforms.

The data structure used for fast pointer lookups.

Scalability of the collector to multiprocessors.

Directory containing garbage collector source.

Mark-sweep versus copying garbage collectors and their complexity.

Pros and cons of conservative garbage collectors, in comparison to other collectors.

Issues related to garbage collection vs. manual memory management in C/C++.

An example of a case in which garbage collection results in a much faster implementation as a result of reduced synchronization.

Slide set discussing performance of nonmoving garbage collectors.

Slide set discussing Destructors, Finalizers, and Synchronization (POPL 2003).

Paper corresponding to above slide set. ( Technical Report version.)

A Java/Scheme/C/C++ garbage collection benchmark.

Slides for talk on memory allocation myths.

Slides for OOPSLA 98 garbage collection talk.

Related papers.

For current updates on the collector and information on reporting issues, please see the bdwgc github page.

There used to be a pair of mailing lists for GC discussions. Those are no longer active. Please see the above page for pointers to the archives.

Some now ancient discussion of the collector took place on the gcc java mailing list, whose archives appear here, and also on gclist@iecc.com.

Comments and bug reports may also be sent to (boehm@acm.org), but reporting issues on github is strongly preferred.