[3bbd5fe9] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[6732c094] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[3bbd5fe9] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[67cd226] | 7 | <!ENTITY gc-download-http "https://github.com/ivmai/bdwgc/releases/download/v&gc-version;/gc-&gc-version;.tar.gz">
|
---|
[8057fc4] | 8 | <!ENTITY gc-download-ftp " ">
|
---|
[67cd226] | 9 | <!ENTITY gc-md5sum "787177b1b15aa19ffa0d61d8f508b69d">
|
---|
[663957f] | 10 | <!ENTITY gc-size "1.1 MB">
|
---|
[2593c4a] | 11 | <!ENTITY gc-buildsize "11 MB (with tests)">
|
---|
[67cd226] | 12 | <!ENTITY gc-time "0.3 SBU (with tests)">
|
---|
[3bbd5fe9] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="gc" xreflabel="GC-&gc-version;">
|
---|
| 16 | <?dbhtml filename="gc.html"?>
|
---|
| 17 |
|
---|
| 18 |
|
---|
| 19 | <title>GC-&gc-version;</title>
|
---|
| 20 |
|
---|
| 21 | <indexterm zone="gc">
|
---|
| 22 | <primary sortas="a-GC">GC</primary>
|
---|
| 23 | </indexterm>
|
---|
| 24 |
|
---|
| 25 | <sect2 role="package">
|
---|
| 26 | <title>Introduction to GC</title>
|
---|
| 27 |
|
---|
[b3bb56b] | 28 | <para>
|
---|
| 29 | The <application>GC</application> package contains the Boehm-Demers-Weiser
|
---|
| 30 | conservative garbage collector, which can be used as a garbage collecting
|
---|
| 31 | replacement for the C malloc function or C++ new operator. It allows you
|
---|
| 32 | to allocate memory basically as you normally would, without explicitly
|
---|
| 33 | deallocating memory that is no longer useful. The collector automatically
|
---|
| 34 | recycles memory when it determines that it can no longer be otherwise
|
---|
| 35 | accessed. The collector is also used by a number of programming language
|
---|
| 36 | implementations that either use C as intermediate code, want to facilitate
|
---|
| 37 | easier interoperation with C libraries, or just prefer the simple
|
---|
| 38 | collector interface. Alternatively, the garbage collector may be used as a
|
---|
| 39 | leak detector for C or C++ programs, though that is not its primary goal.
|
---|
| 40 | </para>
|
---|
| 41 |
|
---|
[046d740] | 42 | &lfs112_checked;
|
---|
[d4796f8b] | 43 |
|
---|
[3bbd5fe9] | 44 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 45 | <itemizedlist spacing="compact">
|
---|
| 46 | <listitem>
|
---|
[4355dbcf] | 47 | <para>
|
---|
| 48 | Download (HTTP): <ulink url="&gc-download-http;"/>
|
---|
| 49 | </para>
|
---|
[3bbd5fe9] | 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
[4355dbcf] | 52 | <para>
|
---|
| 53 | Download (FTP): <ulink url="&gc-download-ftp;"/>
|
---|
| 54 | </para>
|
---|
[3bbd5fe9] | 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
[4355dbcf] | 57 | <para>
|
---|
| 58 | Download MD5 sum: &gc-md5sum;
|
---|
| 59 | </para>
|
---|
[3bbd5fe9] | 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
[4355dbcf] | 62 | <para>
|
---|
| 63 | Download size: &gc-size;
|
---|
| 64 | </para>
|
---|
[3bbd5fe9] | 65 | </listitem>
|
---|
| 66 | <listitem>
|
---|
[4355dbcf] | 67 | <para>
|
---|
| 68 | Estimated disk space required: &gc-buildsize;
|
---|
| 69 | </para>
|
---|
[3bbd5fe9] | 70 | </listitem>
|
---|
| 71 | <listitem>
|
---|
[4355dbcf] | 72 | <para>
|
---|
| 73 | Estimated build time: &gc-time;
|
---|
| 74 | </para>
|
---|
[3bbd5fe9] | 75 | </listitem>
|
---|
| 76 | </itemizedlist>
|
---|
| 77 |
|
---|
[946f08a] | 78 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 79 | <para role="optional">
|
---|
[663957f] | 80 | <xref linkend="libatomic_ops"/>
|
---|
| 81 | </para>
|
---|
[1039de3] | 82 |
|
---|
[b3bb56b] | 83 | <para condition="html" role="usernotes">
|
---|
| 84 | User Notes: <ulink url="&blfs-wiki;/gc"/>
|
---|
| 85 | </para>
|
---|
[3bbd5fe9] | 86 | </sect2>
|
---|
| 87 |
|
---|
| 88 | <sect2 role="installation">
|
---|
| 89 | <title>Installation of GC</title>
|
---|
| 90 |
|
---|
[b3bb56b] | 91 | <para>
|
---|
| 92 | Install <application>GC</application> by running the following commands:
|
---|
| 93 | </para>
|
---|
[3bbd5fe9] | 94 |
|
---|
[33d86da] | 95 | <screen><userinput>./configure --prefix=/usr \
|
---|
[1eb827c6] | 96 | --enable-cplusplus \
|
---|
| 97 | --disable-static \
|
---|
| 98 | --docdir=/usr/share/doc/gc-&gc-version; &&
|
---|
[3bbd5fe9] | 99 | make</userinput></screen>
|
---|
| 100 |
|
---|
[4355dbcf] | 101 | <para>
|
---|
| 102 | To test the results, issue: <command>make check</command>.
|
---|
| 103 | </para>
|
---|
[3bbd5fe9] | 104 |
|
---|
[b3bb56b] | 105 | <para>
|
---|
| 106 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 107 | </para>
|
---|
[3bbd5fe9] | 108 |
|
---|
| 109 | <screen role="root"><userinput>make install &&
|
---|
[33d86da] | 110 | install -v -m644 doc/gc.man /usr/share/man/man3/gc_malloc.3</userinput></screen>
|
---|
[3bbd5fe9] | 111 | </sect2>
|
---|
| 112 |
|
---|
| 113 | <sect2 role="commands">
|
---|
| 114 | <title>Command Explanations</title>
|
---|
| 115 |
|
---|
[4355dbcf] | 116 | <para>
|
---|
[f1d7196] | 117 | <parameter>--docdir=/usr/share/doc/gc-&gc-version;</parameter>:
|
---|
[33d86da] | 118 | This option is used so the package will install the
|
---|
[4355dbcf] | 119 | documentation in a versioned directory.
|
---|
| 120 | </para>
|
---|
| 121 |
|
---|
[b3bb56b] | 122 | <para>
|
---|
| 123 | <parameter>--enable-cplusplus</parameter>: This parameter enables the
|
---|
[8558044] | 124 | building and installing of the C++ library along with the standard
|
---|
[9f574bb] | 125 | C library.
|
---|
[b3bb56b] | 126 | </para>
|
---|
[4e143323] | 127 |
|
---|
| 128 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 129 | href="../../xincludes/static-libraries.xml"/>
|
---|
| 130 |
|
---|
[3bbd5fe9] | 131 | </sect2>
|
---|
| 132 |
|
---|
| 133 | <sect2 role="content">
|
---|
| 134 | <title>Contents</title>
|
---|
| 135 |
|
---|
| 136 | <segmentedlist>
|
---|
[c3c56b2] | 137 | <segtitle>Installed Programs</segtitle>
|
---|
[3bbd5fe9] | 138 | <segtitle>Installed Libraries</segtitle>
|
---|
| 139 | <segtitle>Installed Directories</segtitle>
|
---|
| 140 |
|
---|
| 141 | <seglistitem>
|
---|
[c3c56b2] | 142 | <seg>
|
---|
| 143 | None
|
---|
| 144 | </seg>
|
---|
[b3bb56b] | 145 | <seg>
|
---|
[8558044] | 146 | libcord.so,
|
---|
[67cd226] | 147 | libgc.so,
|
---|
| 148 | libgccpp.so, and
|
---|
| 149 | libgctba.so
|
---|
[b3bb56b] | 150 | </seg>
|
---|
| 151 | <seg>
|
---|
| 152 | /usr/include/gc and
|
---|
[bfefc696] | 153 | /usr/share/doc/gc-&gc-version;
|
---|
[b3bb56b] | 154 | </seg>
|
---|
[3bbd5fe9] | 155 | </seglistitem>
|
---|
| 156 | </segmentedlist>
|
---|
| 157 |
|
---|
| 158 | <variablelist>
|
---|
| 159 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 160 | <?dbfo list-presentation="list"?>
|
---|
| 161 | <?dbhtml list-presentation="table"?>
|
---|
| 162 |
|
---|
[7d50f20] | 163 | <varlistentry id="libcord">
|
---|
| 164 | <term><filename class="libraryfile">libcord.so</filename></term>
|
---|
| 165 | <listitem>
|
---|
| 166 | <para>
|
---|
[eed90c8] | 167 | contains a tree-based string library
|
---|
[7d50f20] | 168 | </para>
|
---|
| 169 | <indexterm zone="gc libcord">
|
---|
| 170 | <primary sortas="c-libcord">libcord.so</primary>
|
---|
| 171 | </indexterm>
|
---|
| 172 | </listitem>
|
---|
| 173 | </varlistentry>
|
---|
| 174 |
|
---|
[3bbd5fe9] | 175 | <varlistentry id="libgc">
|
---|
[4355dbcf] | 176 | <term><filename class="libraryfile">libgc.so</filename></term>
|
---|
[3bbd5fe9] | 177 | <listitem>
|
---|
[b3bb56b] | 178 | <para>
|
---|
| 179 | contains a C interface to the conservative garbage collector,
|
---|
[4c24eb0a] | 180 | primarily designed to replace the C malloc function
|
---|
[b3bb56b] | 181 | </para>
|
---|
[3bbd5fe9] | 182 | <indexterm zone="gc libgc">
|
---|
[b3bb56b] | 183 | <primary sortas="c-libgc">libgc.so</primary>
|
---|
[3bbd5fe9] | 184 | </indexterm>
|
---|
| 185 | </listitem>
|
---|
| 186 | </varlistentry>
|
---|
| 187 |
|
---|
| 188 | <varlistentry id="libgccpp">
|
---|
[4355dbcf] | 189 | <term><filename class="libraryfile">libgccpp.so</filename></term>
|
---|
[3bbd5fe9] | 190 | <listitem>
|
---|
[b3bb56b] | 191 | <para>
|
---|
[4c24eb0a] | 192 | contains a C++ interface to the conservative garbage collector
|
---|
[b3bb56b] | 193 | </para>
|
---|
[3bbd5fe9] | 194 | <indexterm zone="gc libgccpp">
|
---|
[b3bb56b] | 195 | <primary sortas="c-libgccpp">libgccpp.so</primary>
|
---|
[3bbd5fe9] | 196 | </indexterm>
|
---|
| 197 | </listitem>
|
---|
| 198 | </varlistentry>
|
---|
[4e143323] | 199 |
|
---|
[67cd226] | 200 | <varlistentry id="libgctba">
|
---|
| 201 | <term><filename class="libraryfile">libgctba.so</filename></term>
|
---|
| 202 | <listitem>
|
---|
| 203 | <para>
|
---|
| 204 | contains a C++ interface to throw bad allocations
|
---|
| 205 | </para>
|
---|
| 206 | <indexterm zone="gc libgctba">
|
---|
| 207 | <primary sortas="c-libgctba">libgctba.so</primary>
|
---|
| 208 | </indexterm>
|
---|
| 209 | </listitem>
|
---|
| 210 | </varlistentry>
|
---|
| 211 |
|
---|
[3bbd5fe9] | 212 | </variablelist>
|
---|
[4e143323] | 213 |
|
---|
[3bbd5fe9] | 214 | </sect2>
|
---|
[4e143323] | 215 |
|
---|
[3bbd5fe9] | 216 | </sect1>
|
---|