BOOK/chapter06/libffi.xml

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   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-libffi" role="wrap">
   9   <?dbhtml filename="libffi.html"?>
  10
  11   <sect1info condition="script">
  12     <productname>libffi</productname>
  13     <productnumber>&libffi-version;</productnumber>
  14     <address>&libffi-url;</address>
  15   </sect1info>
  16
  17   <title>Libffi-&libffi-version;</title>
  18
  19   <indexterm zone="ch-system-libffi">
  20     <primary sortas="a-libffi">libffi</primary>
  21   </indexterm>
  22
  23   <sect2 role="package">
  24     <title/>
  25
  26     <para>The Libffi library provides a portable, high level programming
  27     interface to various calling conventions. This allows a programmer to call
  28     any function specified by a call interface description at run time.</para>
  29
  30     <segmentedlist>
  31       <segtitle>&buildtime;</segtitle>
  32       <segtitle>&diskspace;</segtitle>
  33
  34       <seglistitem>
  35         <seg>&libffi-ch6-sbu;</seg>
  36         <seg>&libffi-ch6-du;</seg>
  37       </seglistitem>
  38     </segmentedlist>
  39
  40   </sect2>
  41
  42   <sect2 role="installation">
  43     <title>Installation of Libffi</title>
  44
  45     <note>
  46       <para>Similar to GMP, libffi builds with optimizations specific
  47       to the proccesor in use. If building for another system, export
  48       CFLAGS and CXXFLAGS to specify a generic build for your architecture.
  49       If this is not done, all applications that link to libffi will trigger
  50       Illegal Operation Errors.</para>
  51     </note>
  52
  53     <para>Modify the Makefile to install headers into the standard
  54     <filename class="directory">/usr/include</filename> directory instead of
  55     <filename class="directory">/usr/lib/libffi-3.2.1/include</filename>.</para>
  56
  57 <screen><userinput remap="pre">sed -e '/^includesdir/ s/$(libdir).*$/$(includedir)/' \
  58     -i include/Makefile.in
  59
  60 sed -e '/^includedir/ s/=.*$/=@includedir@/' \
  61     -e 's/^Cflags: -I${includedir}/Cflags:/' \
  62     -i libffi.pc.in</userinput></screen>
  63
  64     <para>Prepare libffi for compilation:</para>
  65
  66 <screen><userinput remap="configure">./configure --prefix=/usr --disable-static --with-gcc-arch=native</userinput></screen>
  67
  68     <variablelist>
  69       <title>The meaning of the configure option:</title>
  70
  71       <varlistentry>
  72         <term><parameter>--with-gcc-arch=native</parameter></term>
  73         <listitem>
  74           <para>Ensure gcc optimizes for the current system.  If this
  75           is not specified, the system is guessed and the code generated
  76           may not be correct for some systems.  If the generated code
  77           will be copied from the native system to a less capable
  78           system, use the less capable system as a parameter. For details
  79           about alternative system types, see <ulink
  80           url='https://gcc.gnu.org/onlinedocs/gcc-&gcc-version;/gcc/x86-Options.html'>
  81           the x86 options in the gcc manual</ulink>.</para>
  82         </listitem>
  83       </varlistentry>
  84
  85     </variablelist>
  86
  87     <para>Compile the package:</para>
  88
  89 <screen><userinput remap="make">make</userinput></screen>
  90
  91     <para>To test the results, issue:</para>
  92
  93 <screen><userinput remap="test">make check</userinput></screen>
  94
  95     <para>Install the package:</para>
  96
  97 <screen><userinput remap="install">make install</userinput></screen>
  98
  99   </sect2>
 100
 101   <sect2 id="contents-libffi" role="content">
 102     <title>Contents of Libffi</title>
 103
 104     <segmentedlist>
 105       <segtitle>Installed library</segtitle>
 106
 107       <seglistitem>
 108         <seg>libffi.so</seg>
 109       </seglistitem>
 110     </segmentedlist>
 111
 112     <variablelist>
 113       <bridgehead renderas="sect3">Short Descriptions</bridgehead>
 114       <?dbfo list-presentation="list"?>
 115       <?dbhtml list-presentation="table"?>
 116
 117       <varlistentry id="libffi">
 118         <term><filename class="libraryfile">libffi</filename></term>
 119         <listitem>
 120           <para>contains the libffi API functions.</para>
 121           <indexterm zone="ch-system-libffi">
 122             <primary sortas="c-libffi">libffi</primary>
 123           </indexterm>
 124         </listitem>
 125       </varlistentry>
 126     </variablelist>
 127
 128   </sect2>
 129
 130 </sect1>
 131