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 are an elite GCC hacker.</li>
  49   <li>you want to use the latest bits from CVS.</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 GCC 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 <p>It has been found that the GCC 3.3.3 compiler provided with recent Cygwin
  71 versions is incapable of compiling the LLVM CFE correctly. If your Cygwin
  72 installation includes GCC 3.3.3, we <i>strongly</i> recommend that you download
  73 GCC 3.4.3, build it separately, and use it for compiling LLVM CFE. This has been
  74 shown to work correctly.</p>
  75 <p>Some versions of Cygwin utilize an experimental version of GNU binutils that
  76 will cause the GNU <tt>ld</tt> linker to fail an assertion when linking
  77 components of the libstdc++. It is recommended that you replace the entire
  78 binutils package with version 2.15 such that "<tt>ld --version</tt>" responds
  79 with</p>
  80 <pre>GNU ld version 2.15</pre>
  81 not with:<br/>
  82 <pre>GNU ld version 2.15.91 20040725</pre>
  83 </div>
  84
  85 <!--=========================================================================-->
  86 <div class="doc_subsection"><a name="aix">Building under AIX</a></div>
  87 <div class="doc_text">
  88 <p>If you are building LLVM and the GCC front-end under AIX, do NOT use GNU
  89 Binutils.  They are not stable under AIX and may produce incorrect and/or
  90 invalid code.  Instead, use the system assembler and linker.
  91 </p>
  92 </div>
  93
  94 <!-- *********************************************************************** -->
  95 <div class="doc_section">
  96   <a name="instructions">Instructions</a>
  97 </div>
  98 <!-- *********************************************************************** -->
  99
 100 <div class="doc_text">
 101 <p>
 102 <ol>
 103 <li><p>Configure and build the LLVM libraries and tools. There are two ways to
 104 do this: either with <i>objdir</i> == <i>srcdir</i> or
 105 <i>objdir</i> != <i>srcdir</i>. It is recommended
 106 that <i>srcdir</i> not be the same as <i>objdir</i>:</p>
 107 <ul>
 108   <li>With <i>objdir</i> != <i>srcdir</i>:<pre>
 109  % cd <i>objdir</i>
 110  % <i>srcdir</i>/configure --prefix=/some/path/you/can/install/to [options...]
 111  % gmake tools-only
 112   </pre></li>
 113   <li>With <i>objdir</i> == <i>srcdir</i>:<pre>
 114  % cd llvm
 115  % ./configure --prefix=/some/path/you/can/install/to [options...]
 116  % gmake tools-only
 117   </pre></li>
 118 </ul>
 119 <p>This will build all of the LLVM tools and libraries. The <tt>--prefix</tt>
 120 option defaults to /usr/local (per configure standards) but unless you are a
 121 system administrator, you probably won't be able to install LLVM there because
 122 of permissions. Specify a path into which LLVM can be installed (e.g.
 123 <tt>--prefix=/home/user/llvm</tt>).</p>
 124 </li>
 125
 126 <li><p>Add the directory containing the tools to your PATH.</p>
 127 <pre>
 128  % set path = ( `cd llvm/Debug/bin &amp;&amp; pwd` $path )
 129 </pre></li>
 130
 131 <li><p>Unpack the C/C++ front-end source into cfrontend/src, either by
 132        untar'ing a cfrontend.source.tar.gz file or checking out CVS into this
 133        directory.</p></li>
 134
 135 <li><p>Make "build" and "install" directories as siblings of the "src" tree:</p>
 136 <pre>
 137  % pwd
 138  /usr/local/example/cfrontend/src
 139  % cd ..
 140  % mkdir build install
 141  % set CFEINSTALL = `pwd`/install
 142 </pre></li>
 143
 144
 145 <li><p>Configure, build, and install the GCC front-end:</p>
 146
 147 <p>
 148 <b>Linux/x86:</b><br>
 149 <b>Linux/IA-64:</b><br>
 150 <b>MacOS X/PowerPC</b> (requires dlcompat library):<br>
 151 <b>AIX/PowerPC:</b>
 152 </p>
 153
 154 <pre>
 155  % cd build
 156  % ../src/configure --prefix=$CFEINSTALL --disable-threads --disable-nls \
 157    --disable-shared --enable-languages=c,c++ --program-prefix=llvm-
 158  % gmake all; gmake install
 159 </pre>
 160
 161 <p><b>Cygwin/x86:</b></p>
 162
 163 <pre>
 164  % cd build
 165  % ../src/configure --prefix=$CFEINSTALL --disable-threads --disable-nls \
 166    --disable-shared --enable-languages=c,c++ --disable-c-mbchar \
 167    --program-prefix=llvm-
 168  % gmake all; gmake install
 169 </pre>
 170
 171 <p><b>Solaris/SPARC:</b></p>
 172
 173 <p>
 174 The GCC front-end can be configured for either SPARC V8 (32 bit) or SPARC V9 (64
 175 bit).  This changes, among other things, the sizes of integer types and the
 176 macros defined for conditional compilation.
 177 </p>
 178
 179 <p>
 180 The SPARC V8 backend is still beta quality software.  Unless you are working on
 181 the SPARC V8 backend, you should specify sparcv9 on the configure command line,
 182 as shown below. Also,
 183 note that Solaris has trouble with various wide (multibyte) character
 184 functions from C as referenced from C++, so we typically configure with
 185 --disable-c-mbchar (cf. <a href="http://llvm.cs.uiuc.edu/PR206">Bug 206</a>).
 186 </p>
 187
 188 <pre>
 189  % cd build
 190  % ../src/configure --prefix=$CFEINSTALL --disable-threads --disable-nls \
 191    --disable-shared --enable-languages=c,c++ --host=sparcv9-sun-solaris2.8 \
 192    --disable-c-mbchar --program-prefix=llvm-
 193  % gmake all; gmake install
 194 </pre>
 195
 196  <p><b>Common Problem:</b> You may get error messages regarding the fact
 197  that LLVM does not support inline assembly. Here are two common
 198  fixes:</p>
 199
 200  <ul>
 201   <li><p><b>Fix 1:</b> If you have system header files that include
 202    inline assembly, you may have to modify them to remove the inline
 203    assembly and install the modified versions in
 204    <code>$CFEINSTALL/lib/gcc/<i>target-triplet</i>/3.4-llvm/include</code>.</li>
 205
 206   <li><b>Fix 2:</b> If you are building the C++ front-end on a CPU we
 207    haven't tried yet, you will probably have to edit the appropriate
 208    version of atomicity.h under
 209    <code>src/libstdc++-v3/config/cpu/<i>name-of-cpu</i>/atomicity.h</code>
 210    and apply a patch so that it does not use inline assembly.</li>
 211  </ul>
 212
 213  <p><b>Porting to a new architecture:</b> If you are porting the front-end
 214  to a new architecture or compiling in a configuration that we have
 215  not tried previously, there are probably several changes you will have to make
 216  to the GCC target to get it to work correctly.  These include:<p>
 217
 218  <ul>
 219   <li>Often targets include special assembler or linker flags which
 220       <tt>gccas</tt>/<tt>gccld</tt> does not understand.  In general, these can
 221       just be removed.</li>
 222   <li>LLVM currently does not support any floating point values other than
 223       32-bit and 64-bit IEEE floating point.  The primary effect of this is
 224       that you may have to map "long double" onto "double".</li>
 225   <li>The profiling hooks in GCC do not apply at all to the LLVM front-end.
 226       These may need to be disabled.</li>
 227   <li>No inline assembly for position independent code.  At the LLVM level,
 228       everything is position independent.</li>
 229   <li>We handle <tt>.init</tt> and <tt>.fini</tt> differently.</li>
 230   <li>You may have to disable multilib support in your target.  Using multilib
 231       support causes the GCC compiler driver to add a lot of "<tt>-L</tt>"
 232       options to the link line, which do not relate to LLVM and confuse
 233       <tt>gccld</tt>.  To disable multilibs, delete any
 234       <tt>MULTILIB_OPTIONS</tt> lines from your target files.</li>
 235   <li>Did we mention that we don't support inline assembly?  You'll probably
 236       have to add some fixinclude hacks to disable it in the system
 237       headers.</li>
 238  </ul>
 239 </li>
 240
 241 <li><p>Put <tt>$CFEINSTALL/bin</tt> into your <tt>PATH</tt> environment
 242 variable.</p>
 243   <ul>
 244     <li>sh: <tt>export PATH=$CFEINSTALL/bin:$PATH</tt></li>
 245     <li>csh: <tt>setenv PATH $CFEINSTALL/bin:$PATH</tt></li>
 246   </ul>
 247 </li>
 248
 249 <li><p>Go back into the LLVM source tree proper.  Rerun configure, using
 250 the same options as the last time. This will cause the configuration to now find
 251 the newly built llvm-gcc and llvm-g++ executables. </p></li>
 252
 253 <li><p>Rebuild your CVS tree.  This shouldn't cause the whole thing to be
 254   rebuilt, but it should build the runtime libraries.  After the tree is
 255   built, install the runtime libraries into your GCC front-end build tree.
 256   These are the commands you need:</p>
 257 <pre>
 258  % gmake
 259  % gmake -C runtime install-bytecode
 260 </pre></li>
 261
 262 <li><p>Optionally, build a symbol table for the newly installed runtime
 263 libraries. Although this step is optional, you are strongly encouraged to
 264 do this as the symbol tables will make a significant difference in your
 265 link times. Use the <tt>llvm-ranlib</tt> tool to do this, as follows:</p>
 266 <pre>
 267  % cd $CFEINSTALL/lib
 268  % llvm-ranlib libiberty.a
 269  % llvm-ranlib libstdc++.a
 270  % llvm-ranlib libsupc++.a
 271  % cd $CFEINSTALL/lib/gcc/<i>target-triplet</i>/3.4-llvm
 272  % llvm-ranlib libgcc.a
 273  % llvm-ranlib libgcov.a
 274 </pre>
 275
 276 <li><p>Test the newly-installed C frontend by one or more of the
 277 following means:</p>
 278  <ul>
 279   <li> running the feature &amp; regression tests via <tt>make check</tt></li>
 280   <li> compiling and running a "hello, LLVM" program in C and C++.</li>
 281   <li> running the tests found in the <tt>llvm-test</tt> CVS module</li>
 282  </ul></li>
 283 </ol>
 284 </div>
 285
 286 <!-- *********************************************************************** -->
 287 <div class="doc_section">
 288   <a name="license">License Information</a>
 289 </div>
 290
 291 <div class="doc_text">
 292 <p>
 293 The LLVM GCC frontend is licensed to you under the GNU General Public License
 294 and the GNU Lesser General Public License.  Please see the files COPYING and
 295 COPYING.LIB for more details.
 296 </p>
 297
 298 <p>
 299 The software also has the following additional copyrights:
 300 </p>
 301
 302 <pre>
 303
 304 Copyright (c) 2003, 2004, 2005 University of Illinois at Urbana-Champaign.
 305 All rights reserved.
 306
 307 Developed by:
 308
 309     LLVM Team
 310
 311     University of Illinois at Urbana-Champaign
 312
 313     http://llvm.cs.uiuc.edu
 314
 315 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 316 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 317 FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
 318 CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 319 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 320 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS WITH THE
 321 SOFTWARE.
 322
 323 Copyright (c) 1994
 324 Hewlett-Packard Company
 325
 326 Permission to use, copy, modify, distribute and sell this software
 327 and its documentation for any purpose is hereby granted without fee,
 328 provided that the above copyright notice appear in all copies and
 329 that both that copyright notice and this permission notice appear
 330 in supporting documentation.  Hewlett-Packard Company makes no
 331 representations about the suitability of this software for any
 332 purpose.  It is provided "as is" without express or implied warranty.
 333
 334 Copyright (c) 1996, 1997, 1998, 1999
 335 Silicon Graphics Computer Systems, Inc.
 336
 337 Permission to use, copy, modify, distribute and sell this software
 338 and its documentation for any purpose is hereby granted without fee,
 339 provided that the above copyright notice appear in all copies and
 340 that both that copyright notice and this permission notice appear
 341 in supporting documentation.  Silicon Graphics makes no
 342 representations about the suitability of this software for any
 343 purpose.  It is provided "as is" without express or implied warranty.
 344 </pre>
 345 </div>
 346
 347 <!-- *********************************************************************** -->
 348
 349 <hr>
 350 <address>
 351   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
 352   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
 353   <a href="http://validator.w3.org/check/referer"><img
 354   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
 355
 356   Brian Gaeke<br>
 357   <a href="http://llvm.cs.uiuc.edu">LLVM Compiler Infrastructure</a><br>
 358   Last modified: $Date$
 359 </address>
 360
 361 </body>
 362 </html>