<li><a href="#cautionarynote">A Cautionary Note</a>
<ul>
<li><a href="#cygwin">Building under Cygwin</a></li>
+ <li><a href="#aix">Building under AIX</a></li>
</ul>
</li>
<li><a href="#instructions">Instructions</a></li>
<ol>
<li>you really, really, really can't use the binaries we distribute</li>
- <li>you need GCC to fix some of the header files on your system</li>
<li>you are an elite GCC hacker.</li>
</ol>
<!--=========================================================================-->
<div class="doc_text">
-<p>If you are building LLVM and the C front-end under Cygwin, please note that
+<p>If you are building LLVM and the GCC front-end under Cygwin, please note that
the LLVM and GCC makefiles do not correctly handle spaces in paths. To deal
with this issue, make sure that your LLVM and GCC source and build trees are
located in a top-level directory (like <tt>/cygdrive/c/llvm</tt> and
(which includes your "home directory", because it lives under the "Documents
and Settings" directory). We welcome patches to fix this issue.
</p>
+<p>It has been found that the GCC 3.3.3 compiler provided with recent Cygwin
+versions is incapable of compiling the LLVM CFE correctly. If your Cygwin
+installation includes GCC 3.3.3 we <i>strongly</i> recommend that you download
+GCC 3.4.3, build it separately, and use it for compiling LLVM CFE. This has been
+shown to work correctly.</p>
+<p>Some versions of Cygwin utilize an experimental version of GNU binutils that
+will cause the GNU <tt>ld</tt> linker to fail an assertion when linking
+components of the libstdc++. It is recommended that you replace the entire
+binutils package with version 2.15 such that "<tt>ld --version</tt>" responds
+with<br/>
+<pre>GNU ld version 2.15</pre>
+not with:<br/>
+<pre>GNU ld version 2.15.91 20040725</pre>
+</p></div>
+
+<!--=========================================================================-->
+<div class="doc_subsection"><a name="aix">Building under AIX</a></div>
+<div class="doc_text">
+<p>If you are building LLVM and the GCC front-end under AIX, do NOT use GNU
+Binutils. They are not stable under AIX and may produce incorrect and/or
+invalid code. Instead, use the system assembler and linker.
+</p>
</div>
<!-- *********************************************************************** -->
<div class="doc_text">
<p>
<ol>
-<li><p>Configure and build the LLVM libraries and tools using:</p>
-<pre>
+<li><p>Configure and build the LLVM libraries and tools. There are two ways to
+do this: either with <i>objdir</i> == <i>srcdir</i> or not. It is recommended
+that <i>srcdir</i> not be the same as <i>objdir</i>:</p>
+<ul>
+ <li>With <i>objdir</i> != <i>srcdir</i>:<pre>
+ % cd <i>objdir</i>
+ % <i>srcdir</i>/configure --prefix=/some/path/you/can/install/to [options...]
+ % gmake tools-only
+ </pre></li>
+ <li>With <i>objdir</i> == <i>srcdir</i>:<pre>
% cd llvm
- % ./configure [options...]
- % gmake
-</pre>
- <p>This will build all of the LLVM tools and libraries, but you will see
- warnings about missing the C front-end (certain runtime libraries can't
- be built without it). Ignore these warnings for now.</p></li>
+ % ./configure --prefix=/some/path/you/can/install/to [options...]
+ % gmake tools-only
+ </pre></li>
+</ul>
+<p>This will build all of the LLVM tools and libraries. The <tt>--prefix</tt>
+option defaults to /usr/local (per configure standards) but unless you are a
+system administrator, you probably won't be able to install LLVM there because
+of permissions. Specify a path into which LLVM can be installed (e.g.
+<tt>--prefix=/home/user/llvm</tt>).</p>
+</li>
<li><p>Add the directory containing the tools to your PATH.</p>
<pre>
- % set path = ( `cd llvm/tools/Debug && pwd` $path )
+ % set path = ( `cd llvm/Debug/bin && pwd` $path )
</pre></li>
<li><p>Unpack the C/C++ front-end source into cfrontend/src.</p></li>
-<li><p>Make "build" and "install" directories as siblings of the "src"
- tree.</p>
+<li><p>Make "build" and "install" directories as siblings of the "src" tree.</p>
<pre>
% pwd
/usr/local/example/cfrontend/src
</pre></li>
-<li><p>Configure, build, and install the C front-end:</p>
+<li><p>Configure, build, and install the GCC front-end:</p>
<p>
<b>Linux/x86:</b><br>
<pre>
% cd build
% ../src/configure --prefix=$CFEINSTALL --disable-threads --disable-nls \
- --disable-shared --enable-languages=c,c++
- % gmake
- % setenv LLVM_LIB_SEARCH_PATH `pwd`/gcc
+ --disable-shared --enable-languages=c,c++ --program-prefix=llvm-
% gmake all; gmake install
</pre>
<pre>
% cd build
% ../src/configure --prefix=$CFEINSTALL --disable-threads --disable-nls \
- --disable-shared --enable-languages=c,c++ --disable-c-mbchar
- % gmake
- % setenv LLVM_LIB_SEARCH_PATH `pwd`/gcc
+ --disable-shared --enable-languages=c,c++ --disable-c-mbchar \
+ --program-prefix=llvm-
% gmake all; gmake install
</pre>
<p><b>Solaris/SPARC:</b></p>
<p>
-For Solaris/SPARC, LLVM only supports the SPARC V9. Therefore, the
-configure command line should specify sparcv9, as shown below. Also,
+For Solaris/SPARC, LLVM only supports the SPARC V9 architecture. Therefore,
+the configure command line should specify sparcv9, as shown below. Also,
note that Solaris has trouble with various wide (multibyte) character
functions from C as referenced from C++, so we typically configure with
--disable-c-mbchar (cf. <a href="http://llvm.cs.uiuc.edu/PR206">Bug 206</a>).
% cd build
% ../src/configure --prefix=$CFEINSTALL --disable-threads --disable-nls \
--disable-shared --enable-languages=c,c++ --host=sparcv9-sun-solaris2.8 \
- --disable-c-mbchar
- % gmake
- % setenv LLVM_LIB_SEARCH_PATH `pwd`/gcc
+ --disable-c-mbchar --program-prefix=llvm-
% gmake all; gmake install
</pre>
<ul>
<li><p><b>Fix 1:</b> If you have system header files that include
inline assembly, you may have to modify them to remove the inline
- assembly, and install the modified versions in
- <code>$CFEINSTALL/<i>target-triplet</i>/sys-include</code>.</li>
+ assembly and install the modified versions in
+ <code>$CFEINSTALL/lib/gcc/<i>target-triplet</i>/3.4-llvm/include</code>.</li>
<li><b>Fix 2:</b> If you are building the C++ front-end on a CPU we
haven't tried yet, you will probably have to edit the appropriate
and apply a patch so that it does not use inline assembly.</li>
</ul>
- <p><b>Porting to a new architecture:</b> If you are porting the new front-end
- to a new architecture, or compiling in a different configuration that we have
- previously, there are probably several changes you will have to make to the GCC
- target to get it to work correctly. These include:<p>
+ <p><b>Porting to a new architecture:</b> If you are porting the front-end
+ to a new architecture or compiling in a configuration that we have
+ not tried previously, there are probably several changes you will have to make
+ t
o the GCC target to get it to work correctly. These include:<p>
<ul>
- <li>Often targets include special or assembler linker flags which
+ <li>Often targets include special assembler or linker flags which
<tt>gccas</tt>/<tt>gccld</tt> does not understand. In general, these can
just be removed.</li>
<li>LLVM currently does not support any floating point values other than
</ul>
</li>
-<li><p>Go back into the LLVM source tree proper. Rerun configure, using
-the <code>--with-llvmgccdir=$CFEINSTALL</code> option to specify the path
-to the newly built C front-end.</p></li>
+<li><p>Put <tt>$CFEINSTALL/bin</tt> into your <tt>PATH</tt> environment
+variable.</p>
+ <ul>
+ <li>sh: <tt>export PATH=$CFEINSTALL/bin:$PATH</tt></li>
+ <li>csh: <tt>setenv PATH $CFEINSTALL/bin:$PATH</tt></li>
+ </ul>
+</li>
-<li><p>If you edited header files during the C/C++ front-end build as
-described in "Fix 1" above, you must now copy those header files from
-<code>$CFEINSTALL/<i>target-triplet</i>/sys-include</code> to
-<code>$CFEINSTALL/lib/gcc/<i>target-triplet</i>/3.4-llvm/include</code>.
-(This should be the "include" directory in the same directory as the
-libgcc.a library, which you can find by running
-<code>$CFEINSTALL/bin/gcc --print-libgcc-file-name</code>.)</p></li>
+<li><p>Go back into the LLVM source tree proper. Rerun configure, using
+the same options as the last time. This will cause the configuration to now find
+the newly built llvm-gcc and llvm-g++ executables. </p></li>
<li><p>Rebuild your CVS tree. This shouldn't cause the whole thing to be
rebuilt, but it should build the runtime libraries. After the tree is
- built, install the runtime libraries into your C front-end build tree.
+ built, install the runtime libraries into your GCC front-end build tree.
These are the commands you need.</p>
<pre>
% gmake
- % mkdir $CFEINSTALL/bytecode-libs
% gmake -C runtime install-bytecode
- % setenv LLVM_LIB_SEARCH_PATH $CFEINSTALL/bytecode-libs
</pre></li>
+<li><p>Optionally, build a symbol table for the newly installed runtime
+libraries. Although this step is optional, you are strongly encouraged to
+do this as the symbol tables will make a significant difference in your
+link times. Use the <tt>llvm-ranlib</tt> tool to do this, as follows:</p>
+<pre>
+ % cd $CFEINSTALL/lib
+ % llvm-ranlib libiberty.a
+ % llvm-ranlib libstdc++.a
+ % llvm-ranlib libsupc++.a
+ % cd $CFEINSTALL/lib/gcc/<i>target-triplet</i>/3.4-llvm
+ % llvm-ranlib libgcc.a
+ % llvm-ranlib libgcov.a
+</pre>
+
<li><p>Test the newly-installed C frontend by one or more of the
following means:</p>
<ul>
+ <li> running the feature & regression tests via <tt>make check</tt></li>
<li> compiling and running a "hello, LLVM" program in C and C++.</li>
- <li> running the tests under <tt>test/Programs</tt> using <code>gmake -C
- test/Programs</code></li>
+ <li> running the tests found in the <tt>llvm-test</tt> CVS module</li>
</ul></li>
</ol>
</div>
projects / oota-llvm.git / blobdiff