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