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