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