docs/CFEBuildInstrs.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
   5   <link rel="stylesheet" href="llvm.css" type="text/css" media="screen" />
   6   <title>Bootstrapping the C/C++ Front-End</title>
   7 </head>
   8 <body>
   9
  10 <div class="doc_title">
  11   Bootstrapping the C/C++ Front-End
  12 </div>
  13
  14 <p>This document is intended to explain the process of building the LLVM
  15 C/C++ front-end, based on GCC 3.4, from source.</p>
  16
  17 <p><b>NOTE:</b> This is currently a somewhat fragile, error-prone
  18 process, and you should only try to do it if
  19 <ul>
  20   <li>(A) you really, really, really can't use the binaries we distribute
  21   <li>(B) you need GCC to fix some of the header files on your system
  22   <li>(C) you are an elite GCC hacker.</p>
  23 </ul>
  24
  25 <p>We welcome patches to help make this process simpler.</p>
  26
  27 <!-- *********************************************************************** -->
  28 <div class="doc_section">
  29   <a name="instructions">Instructions</a>
  30 </div>
  31 <!-- *********************************************************************** -->
  32
  33 <div class="doc_text">
  34 <p>
  35 <ol>
  36 <li><p>Configure and build the LLVM libraries and tools using:</p>
  37 <pre>
  38  % cd llvm
  39  % ./configure [options...]
  40  % gmake tools-only
  41 </pre>
  42     <p>The use of the non-default target "tools-only" means that the
  43     LLVM tools and libraries will build, and the binaries will be
  44     deposited in llvm/tools/Debug, but the runtime (bytecode)
  45     libraries will not build.</p></li>
  46
  47 <li><p>Add the directory containing the tools to your PATH.</p>
  48 <pre>
  49  % set path = ( `cd llvm/tools/Debug &amp;&amp; pwd` $path )
  50 </pre></li>
  51
  52 <li><p>Unpack the C/C++ front-end source into cfrontend/src.</p></li>
  53
  54 <li><p>Edit src/configure.  Change the first line (starting w/ #!) to
  55        contain the correct full pathname of sh.</p></li>
  56
  57 <li><p>Make "build" and "install" directories as siblings of the "src"
  58        tree.</p>
  59 <pre>
  60  % pwd
  61  /usr/local/example/cfrontend/src
  62  % cd ..
  63  % mkdir build install
  64  % set CFEINSTALL = `pwd`/install
  65 </pre></li>
  66
  67 <li><p>Configure, build and install the C front-end:</p>
  68 <pre>
  69  % cd build
  70  % ../src/configure --prefix=$CFEINSTALL --disable-nls --disable-shared \
  71    --enable-languages=c,c++
  72  % gmake all-gcc
  73  % setenv LLVM_LIB_SEARCH_PATH `pwd`/gcc
  74  % gmake all; gmake install
  75 </pre>
  76
  77  <p><b>Common Problem:</b> You may get error messages regarding the fact
  78  that LLVM does not support inline assembly. Here are two common
  79  fixes:</p>
  80
  81  <ul>
  82   <li><p><b>Fix 1:</b> If you have system header files that include
  83    inline assembly, you may have to modify them to remove the inline
  84    assembly, and install the modified versions in
  85    <code>$CFEINSTALL/<i>target-triplet</i>/sys-include</code>.</p></li>
  86
  87   <li><b>Fix 2:</b> If you are building the C++ front-end on a CPU we
  88    haven't tried yet, you will probably have to edit the appropriate
  89    version of atomicity.h under
  90    <code>src/libstdc++-v3/config/cpu/<i>name-of-cpu</i>/atomicity.h</code>
  91    and apply a patch so that it does not use inline assembly.</p></li>
  92  </ul>
  93
  94  <p><b>Porting to a new architecture:</b> If you are porting the new front-end
  95  to a new architecture, or compiling in a different configuration that we have
  96  previously, there are probably several changes you will have to make to the GCC
  97  target to get it to work correctly.  These include:<p>
  98
  99  <ul>
 100   <li>Often targets include special or assembler linker flags which
 101       <tt>gccas</tt>/<tt>gccld</tt> does not understand.  In general, these can
 102       just be removed.</li>
 103   <li>LLVM currently does not support any floating point values other than
 104       32-bit and 64-bit IEEE floating point.  The primary effect of this is
 105       that you may have to map "long double" onto "double".</li>
 106   <li>The profiling hooks in GCC do not apply at all to the LLVM front-end.
 107       These may need to be disabled.</li>
 108   <li>No inline assembly for position independent code.  At the LLVM level,
 109       everything is position independent.</li>
 110   <li>We handle <tt>.init</tt> and <tt>.fini</tt> differently.</li>
 111   <li>You may have to disable multilib support in your target.  Using multilib
 112       support causes the GCC compiler driver to add a lot of "<tt>-L</tt>"
 113       options to the link line, which do not relate to LLVM and confuse
 114       <tt>gccld</tt>.  To disable multilibs, delete any
 115       <tt>MULTILIB_OPTIONS</tt> lines from your target files.</li>
 116   <li>Did we mention that we don't support inline assembly?  You'll probably
 117       have to add some fixinclude hacks to disable it in the system
 118       headers.</li>
 119  </ul>
 120 </li>
 121
 122 <li><p>Go back into the LLVM source tree proper. Edit Makefile.config
 123 to redefine <code>LLVMGCCDIR</code> to the full pathname of the
 124 <code>$CFEINSTALL</code> directory, which is the directory you just
 125 installed the C front-end into. (The ./configure script is likely to
 126 have set this to a directory which does not exist on your system.)</p></li>
 127
 128 <li><p>If you edited header files during the C/C++ front-end build as
 129 described in "Fix 1" above, you must now copy those header files from
 130 <code>$CFEINSTALL/<i>target-triplet</i>/sys-include</code> to
 131 <code>$CFEINSTALL/lib/gcc/<i>target-triplet</i>/3.4-llvm/include</code>.
 132 (This should be the "include" directory in the same directory as the
 133 libgcc.a library, which you can find by running
 134 <code>$CFEINSTALL/bin/gcc --print-libgcc-file-name</code>.)</p></li>
 135
 136 <li><p>Build and install the runtime (bytecode) libraries by running:</p>
 137 <pre>
 138  % gmake -C runtime
 139  % mkdir $CFEINSTALL/bytecode-libs
 140  % gmake -C runtime install
 141  % setenv LLVM_LIB_SEARCH_PATH $CFEINSTALL/bytecode-libs
 142 </pre></li>
 143
 144 <li><p>Test the newly-installed C frontend by one or more of the
 145 following means:</p>
 146  <ul>
 147   <li> compiling and running a "hello, LLVM" program in C and C++.</li>
 148   <li> running the tests under <tt>test/Programs</tt> using <code>gmake -C
 149    test/Programs</code></li>
 150  </ul>
 151   </p>
 152 </li>
 153 </ol>
 154 </div>
 155
 156 <!-- *********************************************************************** -->
 157
 158 <hr><font size="-1">
 159 <address><a href="mailto:gaeke -at- uiuc.edu">Brian Gaeke</a></address>
 160 <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a>
 161 <br>
 162 Last modified: $Date$
 163 </font>
 164
 165 </body>
 166 </html>