[7152faa] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[6cc0516] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 | ]>
|
---|
| 7 |
|
---|
| 8 | <sect1 id="ch-system-gmp" role="wrap">
|
---|
| 9 | <?dbhtml filename="gmp.html"?>
|
---|
| 10 |
|
---|
| 11 | <sect1info condition="script">
|
---|
| 12 | <productname>gmp</productname>
|
---|
| 13 | <productnumber>&gmp-version;</productnumber>
|
---|
| 14 | <address>&gmp-url;</address>
|
---|
| 15 | </sect1info>
|
---|
| 16 |
|
---|
| 17 | <title>GMP-&gmp-version;</title>
|
---|
| 18 |
|
---|
| 19 | <indexterm zone="ch-system-gmp">
|
---|
| 20 | <primary sortas="a-GMP">GMP</primary>
|
---|
| 21 | </indexterm>
|
---|
| 22 |
|
---|
| 23 | <sect2 role="package">
|
---|
| 24 | <title/>
|
---|
| 25 |
|
---|
| 26 | <para>The GMP package contains math libraries. These have useful functions
|
---|
| 27 | for arbitrary precision arithmetic.</para>
|
---|
| 28 |
|
---|
| 29 | <segmentedlist>
|
---|
| 30 | <segtitle>&buildtime;</segtitle>
|
---|
| 31 | <segtitle>&diskspace;</segtitle>
|
---|
| 32 |
|
---|
| 33 | <seglistitem>
|
---|
[fb386e0] | 34 | <seg>&gmp-fin-sbu;</seg>
|
---|
| 35 | <seg>&gmp-fin-du;</seg>
|
---|
[6cc0516] | 36 | </seglistitem>
|
---|
| 37 | </segmentedlist>
|
---|
| 38 |
|
---|
| 39 | </sect2>
|
---|
| 40 |
|
---|
| 41 | <sect2 role="installation">
|
---|
| 42 | <title>Installation of GMP</title>
|
---|
| 43 |
|
---|
[e4eb4cce] | 44 | <note>
|
---|
[1018fd3] | 45 | <para>If you are building for 32-bit x86, but you have a CPU which is
|
---|
| 46 | capable of running 64-bit code <emphasis>and</emphasis> you have specified
|
---|
| 47 | <envar>CFLAGS</envar> in the environment, the configure script will
|
---|
| 48 | attempt to configure for 64-bits and fail.
|
---|
| 49 | Avoid this by invoking the configure command below with
|
---|
[b21778b] | 50 | <screen role="nodump"><userinput><parameter>ABI=32</parameter> ./configure ...</userinput></screen></para>
|
---|
[e4eb4cce] | 51 | </note>
|
---|
| 52 |
|
---|
[f63c0c3] | 53 | <note>
|
---|
| 54 | <para>The default settings of GMP produce libraries optimized for
|
---|
| 55 | the host processor. If libraries suitable for processors less
|
---|
[d672ab7] | 56 | capable than the host's CPU are desired, generic libraries can be
|
---|
[d0de26c] | 57 | created by appending the <option>--host=none-linux-gnu</option> option
|
---|
| 58 | to the <command>configure</command> command.</para>
|
---|
[f63c0c3] | 59 |
|
---|
[d0de26c] | 60 | <!-- To editors: the configure script says "the none host is obsolete,
|
---|
[360fdfca] | 61 | use - -disable-assembly," but don't believe it: with the latter
|
---|
[d0de26c] | 62 | CFLAGS is still automatically set to -march=something. -->
|
---|
[f63c0c3] | 63 | </note>
|
---|
| 64 |
|
---|
[6cc0516] | 65 | <para>Prepare GMP for compilation:</para>
|
---|
| 66 |
|
---|
[73b2841] | 67 | <screen><userinput remap="configure">./configure --prefix=/usr \
|
---|
| 68 | --enable-cxx \
|
---|
| 69 | --disable-static \
|
---|
[c296646] | 70 | --docdir=/usr/share/doc/gmp-&gmp-version;</userinput></screen>
|
---|
[6cc0516] | 71 |
|
---|
[0bb67603] | 72 | <variablelist>
|
---|
[f1994dc] | 73 | <title>The meaning of the new configure options:</title>
|
---|
[0bb67603] | 74 |
|
---|
| 75 | <varlistentry>
|
---|
| 76 | <term><parameter>--enable-cxx</parameter></term>
|
---|
| 77 | <listitem>
|
---|
| 78 | <para>This parameter enables C++ support</para>
|
---|
| 79 | </listitem>
|
---|
| 80 | </varlistentry>
|
---|
| 81 |
|
---|
[b06fc9c] | 82 | <varlistentry>
|
---|
[94ea3c4] | 83 | <term><parameter>--docdir=/usr/share/doc/gmp-&gmp-version;</parameter></term>
|
---|
[b06fc9c] | 84 | <listitem>
|
---|
| 85 | <para>This variable specifies the correct place for the
|
---|
| 86 | documentation.</para>
|
---|
| 87 | </listitem>
|
---|
| 88 | </varlistentry>
|
---|
| 89 |
|
---|
[0bb67603] | 90 | </variablelist>
|
---|
| 91 |
|
---|
[b06fc9c] | 92 | <para>Compile the package and generate the HTML documentation:</para>
|
---|
[6cc0516] | 93 |
|
---|
[b06fc9c] | 94 | <screen><userinput remap="make">make
|
---|
| 95 | make html</userinput></screen>
|
---|
[6cc0516] | 96 |
|
---|
| 97 | <important>
|
---|
| 98 | <para>The test suite for GMP in this section is considered critical.
|
---|
| 99 | Do not skip it under any circumstances.</para>
|
---|
| 100 | </important>
|
---|
| 101 |
|
---|
| 102 | <para>Test the results:</para>
|
---|
| 103 |
|
---|
[10d231d] | 104 | <screen><userinput remap="test">make check 2>&1 | tee gmp-check-log</userinput></screen>
|
---|
[d672ab7] | 105 |
|
---|
[98bed7f] | 106 | <caution><para>The code in gmp is highly optimized for the processor where
|
---|
[1118b17] | 107 | it is built. Occasionally, the code that detects the processor misidentifies
|
---|
[98bed7f] | 108 | the system capabilities and there will be errors in the tests or other
|
---|
[360fdfca] | 109 | applications using the gmp libraries with the message
|
---|
| 110 | <computeroutput>Illegal instruction</computeroutput>.
|
---|
| 111 | In this case, gmp should be reconfigured with the option
|
---|
[d0de26c] | 112 | <option>--host=none-linux-gnu</option> and rebuilt.</para></caution>
|
---|
[10d231d] | 113 |
|
---|
[d78b550] | 114 | <!-- Some tests PASS on a specific uarch but SKIP on other CPUs.
|
---|
| 115 | For example on K8 the following command outputs 200. -->
|
---|
| 116 | <para>Ensure that at least 199 tests in the test suite passed.
|
---|
[98d78cf] | 117 | Check the results by issuing the following command:</para>
|
---|
[10d231d] | 118 |
|
---|
[53366411] | 119 | <screen><userinput remap="test">awk '/# PASS:/{total+=$3} ; END{print total}' gmp-check-log</userinput></screen>
|
---|
[10d231d] | 120 |
|
---|
[b06fc9c] | 121 | <para>Install the package and its documentation:</para>
|
---|
[e7c8034] | 122 |
|
---|
[b06fc9c] | 123 | <screen><userinput remap="install">make install
|
---|
| 124 | make install-html</userinput></screen>
|
---|
[6cc0516] | 125 |
|
---|
[e7c8034] | 126 | </sect2>
|
---|
[6cc0516] | 127 |
|
---|
| 128 | <sect2 id="contents-gmp" role="content">
|
---|
| 129 | <title>Contents of GMP</title>
|
---|
| 130 |
|
---|
| 131 | <segmentedlist>
|
---|
[ab31b97] | 132 | <segtitle>Installed libraries</segtitle>
|
---|
[fe05b08] | 133 | <segtitle>Installed directory</segtitle>
|
---|
[6cc0516] | 134 |
|
---|
| 135 | <seglistitem>
|
---|
[040ecb6] | 136 | <seg>libgmp.so and libgmpxx.so</seg>
|
---|
[fe05b08] | 137 | <seg>/usr/share/doc/gmp-&gmp-version;</seg>
|
---|
[6cc0516] | 138 | </seglistitem>
|
---|
| 139 | </segmentedlist>
|
---|
| 140 |
|
---|
| 141 | <variablelist>
|
---|
| 142 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 143 | <?dbfo list-presentation="list"?>
|
---|
| 144 | <?dbhtml list-presentation="table"?>
|
---|
| 145 |
|
---|
[0bb67603] | 146 | <varlistentry id="libgmp">
|
---|
[5f7456b] | 147 | <term><filename class="libraryfile">libgmp</filename></term>
|
---|
[6cc0516] | 148 | <listitem>
|
---|
[afba93b] | 149 | <para>Contains precision math functions</para>
|
---|
[0bb67603] | 150 | <indexterm zone="ch-system-gmp libgmp">
|
---|
| 151 | <primary sortas="c-libgmp">libgmp</primary>
|
---|
| 152 | </indexterm>
|
---|
| 153 | </listitem>
|
---|
| 154 | </varlistentry>
|
---|
| 155 |
|
---|
| 156 | <varlistentry id="libgmpxx">
|
---|
[5f7456b] | 157 | <term><filename class="libraryfile">libgmpxx</filename></term>
|
---|
[0bb67603] | 158 | <listitem>
|
---|
[afba93b] | 159 | <para>Contains C++ precision math functions</para>
|
---|
[0bb67603] | 160 | <indexterm zone="ch-system-gmp libgmpxx">
|
---|
| 161 | <primary sortas="c-libgmpxx">libgmpxx</primary>
|
---|
| 162 | </indexterm>
|
---|
| 163 | </listitem>
|
---|
| 164 | </varlistentry>
|
---|
[6cc0516] | 165 | </variablelist>
|
---|
| 166 |
|
---|
| 167 | </sect2>
|
---|
| 168 |
|
---|
| 169 | </sect1>
|
---|