docs/CFEBuildInstrs.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
   2                       "http://www.w3.org/TR/html4/strict.dtd">
   3 <html>
   4 <head>
   5   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   6   <link rel="stylesheet" href="llvm.css" type="text/css" media="screen">
   7   <title>Bootstrapping the LLVM C/C++ Front-End</title>
   8 </head>
   9 <body>
  10
  11 <div class="doc_title">
  12   Bootstrapping the LLVM C/C++ Front-End
  13 </div>
  14
  15 <ol>
  16   <li><a href="#cautionarynote">A Cautionary Note</a>
  17     <ul>
  18       <li><a href="#cygwin">Building under Cygwin</a></li>
  19       <li><a href="#aix">Building under AIX</a></li>
  20     </ul>
  21   </li>
  22   <li><a href="#instructions">Instructions</a></li>
  23   <li><a href="#license">License Information</a></li>
  24 </ol>
  25
  26 <div class="doc_author">
  27   <p>Written by Brian R. Gaeke and
  28      <a href="http://nondot.org/sabre">Chris Lattner</a></p>
  29 </div>
  30
  31 <!-- *********************************************************************** -->
  32 <div class="doc_section">
  33   <a name="cautionarynote">A Cautionary Note</a>
  34 </div>
  35 <!-- *********************************************************************** -->
  36
  37 <div class="doc_text">
  38 <p>This document is intended to explain the process of building the
  39 LLVM C/C++ front-end, based on GCC 3.4, from its source code. You
  40 would have to do this, for example, if you are porting LLVM to a new
  41 architecture or operating system.</p>
  42
  43 <p><b>NOTE:</b> This is currently a somewhat fragile, error-prone
  44 process, and you should <b>only</b> try to do it if:</p>
  45
  46 <ol>
  47   <li>you really, really, really can't use the binaries we distribute</li>
  48   <li>you need GCC to fix some of the header files on your system</li>
  49   <li>you are an elite GCC hacker.</li>
  50 </ol>
  51
  52 <p>We welcome patches to help make this process simpler.</p>
  53 </div>
  54
  55 <!--=========================================================================-->
  56 <div class="doc_subsection">
  57   <a name="cygwin">Building under Cygwin</a>
  58 </div>
  59 <!--=========================================================================-->
  60
  61 <div class="doc_text">
  62 <p>If you are building LLVM and the C front-end under Cygwin, please note that
  63 the LLVM and GCC makefiles do not correctly handle spaces in paths.  To deal
  64 with this issue, make sure that your LLVM and GCC source and build trees are
  65 located in a top-level directory (like <tt>/cygdrive/c/llvm</tt> and
  66 <tt>/cygdrive/c/llvm-cfrontend</tt>), not in a directory that contains a space
  67 (which includes your "home directory", because it lives under the "Documents
  68 and Settings" directory).  We welcome patches to fix this issue.
  69 </p>
  70 </div>
  71
  72 <!--=========================================================================-->
  73 <div class="doc_subsection">
  74   <a name="aix">Building under AIX</a>
  75 </div>
  76 <!--=========================================================================-->
  77
  78 <div class="doc_text">
  79 <p>If you are building LLVM and the C front-end under AIX, do NOT use GNU
  80 Binutils.  They are not stable under AIX and may produce incorrect and/or
  81 invalid code.  Instead, use the system assembler and linker.
  82 </p>
  83 </div>
  84
  85 <!-- *********************************************************************** -->
  86 <div class="doc_section">
  87   <a name="instructions">Instructions</a>
  88 </div>
  89 <!-- *********************************************************************** -->
  90
  91 <div class="doc_text">
  92 <p>
  93 <ol>
  94 <li><p>Configure and build the LLVM libraries and tools using:</p>
  95 <pre>
  96  % cd llvm
  97  % ./configure [options...]
  98  % gmake tools-only
  99 </pre>
 100     <p>This will build all of the LLVM tools and libraries.</p></li>
 101
 102 <li><p>Add the directory containing the tools to your PATH.</p>
 103 <pre>
 104  % set path = ( `cd llvm/tools/Debug &amp;&amp; pwd` $path )
 105 </pre></li>
 106
 107 <li><p>Unpack the C/C++ front-end source into cfrontend/src.</p></li>
 108
 109 <li><p>Make "build" and "install" directories as siblings of the "src" tree.</p>
 110 <pre>
 111  % pwd
 112  /usr/local/example/cfrontend/src
 113  % cd ..
 114  % mkdir build install
 115  % set CFEINSTALL = `pwd`/install
 116 </pre></li>
 117
 118
 119 <li><p>Configure, build, and install the C front-end:</p>
 120
 121 <p>
 122 <b>Linux/x86:</b><br>
 123 <b>MacOS X/PowerPC</b> (requires dlcompat library):<br>
 124 <b>AIX/PowerPC:</b>
 125 </p>
 126
 127 <pre>
 128  % cd build
 129  % ../src/configure --prefix=$CFEINSTALL --disable-threads --disable-nls \
 130    --disable-shared --enable-languages=c,c++
 131  % gmake
 132  % setenv LLVM_LIB_SEARCH_PATH `pwd`/gcc
 133  % gmake all; gmake install
 134 </pre>
 135
 136 <p><b>Cygwin/x86:</b></p>
 137
 138 <pre>
 139  % cd build
 140  % ../src/configure --prefix=$CFEINSTALL --disable-threads --disable-nls \
 141    --disable-shared --enable-languages=c,c++ --disable-c-mbchar
 142  % gmake
 143  % setenv LLVM_LIB_SEARCH_PATH `pwd`/gcc
 144  % gmake all; gmake install
 145 </pre>
 146
 147 <p><b>Solaris/SPARC:</b></p>
 148
 149 <p>
 150 For Solaris/SPARC, LLVM only supports the SPARC V9.  Therefore, the
 151 configure command line should specify sparcv9, as shown below. Also,
 152 note that Solaris has trouble with various wide (multibyte) character
 153 functions from C as referenced from C++, so we typically configure with
 154 --disable-c-mbchar (cf. <a href="http://llvm.cs.uiuc.edu/PR206">Bug 206</a>).
 155 </p>
 156
 157 <pre>
 158  % cd build
 159  % ../src/configure --prefix=$CFEINSTALL --disable-threads --disable-nls \
 160    --disable-shared --enable-languages=c,c++ --host=sparcv9-sun-solaris2.8 \
 161    --disable-c-mbchar
 162  % gmake
 163  % setenv LLVM_LIB_SEARCH_PATH `pwd`/gcc
 164  % gmake all; gmake install
 165 </pre>
 166
 167  <p><b>Common Problem:</b> You may get error messages regarding the fact
 168  that LLVM does not support inline assembly. Here are two common
 169  fixes:</p>
 170
 171  <ul>
 172   <li><p><b>Fix 1:</b> If you have system header files that include
 173    inline assembly, you may have to modify them to remove the inline
 174    assembly, and install the modified versions in
 175    <code>$CFEINSTALL/lib/gcc/<i>target-triplet</i>/3.4-llvm/include</code>.</li>
 176
 177   <li><b>Fix 2:</b> If you are building the C++ front-end on a CPU we
 178    haven't tried yet, you will probably have to edit the appropriate
 179    version of atomicity.h under
 180    <code>src/libstdc++-v3/config/cpu/<i>name-of-cpu</i>/atomicity.h</code>
 181    and apply a patch so that it does not use inline assembly.</li>
 182  </ul>
 183
 184  <p><b>Porting to a new architecture:</b> If you are porting the new front-end
 185  to a new architecture, or compiling in a different configuration that we have
 186  previously, there are probably several changes you will have to make to the GCC
 187  target to get it to work correctly.  These include:<p>
 188
 189  <ul>
 190   <li>Often targets include special or assembler linker flags which
 191       <tt>gccas</tt>/<tt>gccld</tt> does not understand.  In general, these can
 192       just be removed.</li>
 193   <li>LLVM currently does not support any floating point values other than
 194       32-bit and 64-bit IEEE floating point.  The primary effect of this is
 195       that you may have to map "long double" onto "double".</li>
 196   <li>The profiling hooks in GCC do not apply at all to the LLVM front-end.
 197       These may need to be disabled.</li>
 198   <li>No inline assembly for position independent code.  At the LLVM level,
 199       everything is position independent.</li>
 200   <li>We handle <tt>.init</tt> and <tt>.fini</tt> differently.</li>
 201   <li>You may have to disable multilib support in your target.  Using multilib
 202       support causes the GCC compiler driver to add a lot of "<tt>-L</tt>"
 203       options to the link line, which do not relate to LLVM and confuse
 204       <tt>gccld</tt>.  To disable multilibs, delete any
 205       <tt>MULTILIB_OPTIONS</tt> lines from your target files.</li>
 206   <li>Did we mention that we don't support inline assembly?  You'll probably
 207       have to add some fixinclude hacks to disable it in the system
 208       headers.</li>
 209  </ul>
 210 </li>
 211
 212 <li><p>Go back into the LLVM source tree proper.  Rerun configure, using
 213 the <code>--with-llvmgccdir=$CFEINSTALL</code> option to specify the path
 214 to the newly built C front-end.</p></li>
 215
 216 <li><p>If you edited header files during the C/C++ front-end build as
 217 described in "Fix 1" above, you must now copy those header files from
 218 <code>$CFEINSTALL/<i>target-triplet</i>/sys-include</code> to
 219 <code>$CFEINSTALL/lib/gcc/<i>target-triplet</i>/3.4-llvm/include</code>.
 220 (This should be the "include" directory in the same directory as the
 221 libgcc.a library, which you can find by running
 222 <code>$CFEINSTALL/bin/gcc --print-libgcc-file-name</code>.)</p></li>
 223
 224 <li><p>Rebuild your CVS tree.  This shouldn't cause the whole thing to be
 225   rebuilt, but it should build the runtime libraries.  After the tree is
 226   built, install the runtime libraries into your C front-end build tree.
 227   These are the commands you need.</p>
 228 <pre>
 229  % gmake
 230  % mkdir $CFEINSTALL/bytecode-libs
 231  % gmake -C runtime install
 232  % setenv LLVM_LIB_SEARCH_PATH $CFEINSTALL/bytecode-libs
 233 </pre></li>
 234
 235 <li><p>Test the newly-installed C frontend by one or more of the
 236 following means:</p>
 237  <ul>
 238   <li> compiling and running a "hello, LLVM" program in C and C++.</li>
 239   <li> running the tests under <tt>test/Programs</tt> using <code>gmake -C
 240    test/Programs</code></li>
 241  </ul></li>
 242 </ol>
 243 </div>
 244
 245 <!-- *********************************************************************** -->
 246 <div class="doc_section">
 247   <a name="license">License Information</a>
 248 </div>
 249
 250 <div class="doc_text">
 251 <p>
 252 The LLVM GCC frontend is licensed to you under the GNU General Public License
 253 and the GNU Lesser General Public License.  Please see the files COPYING and
 254 COPYING.LIB for more details.
 255 </p>
 256
 257 <p>
 258 The software also has the following additional copyrights:
 259 </p>
 260
 261 <pre>
 262
 263 Copyright (c) 2003, 2004 University of Illinois at Urbana-Champaign.
 264 All rights reserved.
 265
 266 Developed by:
 267
 268     LLVM Team
 269
 270     University of Illinois at Urbana-Champaign
 271
 272     http://llvm.cs.uiuc.edu
 273
 274 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 275 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 276 FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
 277 CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 278 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 279 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS WITH THE
 280 SOFTWARE.
 281
 282 Copyright (c) 1994
 283 Hewlett-Packard Company
 284
 285 Permission to use, copy, modify, distribute and sell this software
 286 and its documentation for any purpose is hereby granted without fee,
 287 provided that the above copyright notice appear in all copies and
 288 that both that copyright notice and this permission notice appear
 289 in supporting documentation.  Hewlett-Packard Company makes no
 290 representations about the suitability of this software for any
 291 purpose.  It is provided "as is" without express or implied warranty.
 292
 293 Copyright (c) 1996, 1997, 1998, 1999
 294 Silicon Graphics Computer Systems, Inc.
 295
 296 Permission to use, copy, modify, distribute and sell this software
 297 and its documentation for any purpose is hereby granted without fee,
 298 provided that the above copyright notice appear in all copies and
 299 that both that copyright notice and this permission notice appear
 300 in supporting documentation.  Silicon Graphics makes no
 301 representations about the suitability of this software for any
 302 purpose.  It is provided "as is" without express or implied warranty.
 303 </pre>
 304 </div>
 305
 306 <!-- *********************************************************************** -->
 307
 308 <hr>
 309 <address>
 310   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
 311   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
 312   <a href="http://validator.w3.org/check/referer"><img
 313   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
 314
 315   Brian Gaeke<br>
 316   <a href="http://llvm.cs.uiuc.edu">LLVM Compiler Infrastructure</a><br>
 317   Last modified: $Date$
 318 </address>
 319
 320 </body>
 321 </html>