For PR814:
[oota-llvm.git] / docs / CFEBuildInstrs.html
index d895583d489135de288d5e0cdb7d8d1e7ce1b9f0..fa49c29e0b8cfd6ac38c69d8bd6e532acc39e378 100644 (file)
@@ -19,7 +19,8 @@
       <li><a href="#aix">Building under AIX</a></li>
     </ul>
   </li>
-  <li><a href="#instructions">Instructions</a></li>
+  <li><a href="#instructions">llvm-gcc4 Instructions</a></li>
+  <li><a href="#llvm-gcc3-instructions">llvm-gcc3 Instructions</a></li>
   <li><a href="#license">License Information</a></li>
 </ol>
 
 
 <div class="doc_text">
 <p>This document is intended to explain the process of building the
-LLVM C/C++ front-end, based on GCC 3.4, from its source code. You
-would have to do this, for example, if you are porting LLVM to a new
-architecture or operating system.</p>
+LLVM C/C++ front-end from its source code. You have to do this, for example, if
+you are porting LLVM to a new architecture or operating system, if you are
+working from Top-Of-Tree CVS/SVN, or if there is no precompiled snapshot
+available.</p>
 
 <p><b>NOTE:</b> This is currently a somewhat fragile, error-prone
 process, and you should <b>only</b> try to do it if:</p>
@@ -46,6 +48,7 @@ process, and you should <b>only</b> try to do it if:</p>
 <ol>
   <li>you really, really, really can't use the binaries we distribute</li>
   <li>you are an elite GCC hacker.</li>
+  <li>you want to use the latest bits from CVS.</li>
 </ol>
 
 <p>We welcome patches to help make this process simpler.</p>
@@ -67,26 +70,24 @@ located in a top-level directory (like <tt>/cygdrive/c/llvm</tt> and
 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
+versions is incapable of compiling the LLVM GCC front-end 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 the LLVM GCC front-end.
+ 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/>
+with</p>
 <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_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
@@ -96,24 +97,74 @@ invalid code.  Instead, use the system assembler and linker.
 
 <!-- *********************************************************************** -->
 <div class="doc_section">
-  <a name="instructions">Instructions</a>
+  <a name="instructions">llvm-gcc4 Instructions</a>
 </div>
 <!-- *********************************************************************** -->
 
 <div class="doc_text">
-<p>
+
+<p>This section describes how to aquire and build llvm-gcc4, which is based on
+the GCC 4.0.1 front-end.  This front-end supports C, C++, Objective-C, and 
+Objective-C++.  Note that the instructions for building this front-end are
+completely different than those for building llvm-gcc3.
+</p>
+
 <ol>
-<li><p>Configure and build the LLVM libraries and tools using:</p>
-<pre>
+<li>
+<p>Retrieve the appropriate llvm-gcc4-x.y.source.tar.gz archive from the llvm
+web site.</p>
+<p>It is also possible to download the sources of the llvm-gcc4 front end from
+a read-only mirror using subversion.  To check out the code the first time use:
+</p>
+
+<tt>svn co svn://anonsvn.opensource.apple.com/svn/llvm <i>dst-directory</i></tt>
+
+<p>After that, the code can be be updated in the destination directory using;
+</p>
+
+<tt>svn update</tt>
+
+<p>The mirror is brought up to date every evening.</p>
+</li>
+
+<li>Follow the directions in the top-level README.LLVM file for up-to-date
+    instructions on how to build llvm-gcc4.</li>
+</ol>
+</div>
+
+<!-- *********************************************************************** -->
+<div class="doc_section">
+  <a name="llvm-gcc3-instructions">llvm-gcc3 Instructions</a>
+</div>
+<!-- *********************************************************************** -->
+
+<div class="doc_text">
+<ol>
+<li>Aquire llvm-gcc3 from <a href="GettingStarted.html#checkout">LLVM CVS</a> or
+from a <a href="http://llvm.org/releases/">release tarball</a>.</li>
+
+<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
+<i>objdir</i> != <i>srcdir</i>. It is recommended 
+that <i>srcdir</i> be the same as <i>objdir</i> for your LLVM tree (but note
+that you should always use <i>srcdir</i> != <i>objdir</i> for llvm-gcc):</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 --prefix=/some/path/you/can/install/to [options...]
  % gmake tools-only
-</pre>
-  <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>
+  </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>
@@ -121,9 +172,11 @@ invalid code.  Instead, use the system assembler and linker.
  % set path = ( `cd llvm/Debug/bin &amp;&amp; pwd` $path )
 </pre></li>
 
-<li><p>Unpack the C/C++ front-end source into cfrontend/src.</p></li>
+<li><p>Unpack the C/C++ front-end source into cfrontend/src, either by
+       untar'ing a cfrontend.source.tar.gz file or checking out CVS into this
+       directory.</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
@@ -137,6 +190,7 @@ invalid code.  Instead, use the system assembler and linker.
 
 <p>
 <b>Linux/x86:</b><br>
+<b>Linux/IA-64:</b><br>
 <b>MacOS X/PowerPC</b> (requires dlcompat library):<br>
 <b>AIX/PowerPC:</b>
 </p>
@@ -161,17 +215,24 @@ invalid code.  Instead, use the system assembler and linker.
 <p><b>Solaris/SPARC:</b></p>
 
 <p>
-For Solaris/SPARC, LLVM only supports the SPARC V9 architecture.  Therefore,
-the configure command line should specify sparcv9, as shown below. Also,
+The GCC front-end can be configured for either SPARC V8 (32 bit) or SPARC V9 (64
+bit).  This changes, among other things, the sizes of integer types and the
+macros defined for conditional compilation.
+</p>
+
+<p>
+The SPARC V8 ABI support is more robust than the V9 ABI support and can generate
+SPARC V9 code.  It is highly recommended that you use the V8 ABI with LLVM, 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>).
+--disable-c-mbchar (cf. <a href="http://llvm.org/PR206">Bug 206</a>).
 </p>
 
 <pre>
  % cd build
  % ../src/configure --prefix=$CFEINSTALL --disable-threads --disable-nls \
-   --disable-shared --enable-languages=c,c++ --host=sparcv9-sun-solaris2.8 \
+   --disable-shared --enable-languages=c,c++ --host=sparc-sun-solaris2.8 \
    --disable-c-mbchar --program-prefix=llvm-
  % gmake all; gmake install
 </pre>
@@ -236,7 +297,7 @@ 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 GCC front-end build tree.
-  These are the commands you need.</p>
+  These are the commands you need:</p>
 <pre>
  % gmake
  % gmake -C runtime install-bytecode
@@ -279,51 +340,8 @@ COPYING.LIB for more details.
 </p>
 
 <p>
-The software also has the following additional copyrights:
+More information is <a href="FAQ.html#license">available in the FAQ</a>.
 </p>
-
-<pre>
-
-Copyright (c) 2003, 2004 University of Illinois at Urbana-Champaign.
-All rights reserved.
-
-Developed by:
-
-    LLVM Team
-
-    University of Illinois at Urbana-Champaign
-
-    http://llvm.cs.uiuc.edu
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
-CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS WITH THE
-SOFTWARE.
-
-Copyright (c) 1994
-Hewlett-Packard Company
-
-Permission to use, copy, modify, distribute and sell this software
-and its documentation for any purpose is hereby granted without fee,
-provided that the above copyright notice appear in all copies and
-that both that copyright notice and this permission notice appear
-in supporting documentation.  Hewlett-Packard Company makes no
-representations about the suitability of this software for any
-purpose.  It is provided "as is" without express or implied warranty.
-
-Copyright (c) 1996, 1997, 1998, 1999
-Silicon Graphics Computer Systems, Inc.
-
-Permission to use, copy, modify, distribute and sell this software
-and its documentation for any purpose is hereby granted without fee,
-provided that the above copyright notice appear in all copies and
-that both that copyright notice and this permission notice appear
-in supporting documentation.  Silicon Graphics makes no
-representations about the suitability of this software for any
-purpose.  It is provided "as is" without express or implied warranty.
 </pre>
 </div>
 
@@ -337,7 +355,7 @@ purpose.  It is provided "as is" without express or implied warranty.
   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
 
   Brian Gaeke<br>
-  <a href="http://llvm.cs.uiuc.edu">LLVM Compiler Infrastructure</a><br>
+  <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br>
   Last modified: $Date$
 </address>