docs/GettingStarted.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   <title>Getting Started with LLVM System</title>
   7   <link rel="stylesheet" href="llvm.css" type="text/css">
   8 </head>
   9 <body>
  10
  11 <div class="doc_title">
  12   Getting Started with the LLVM System
  13 </div>
  14
  15 <ul>
  16   <li><a href="#overview">Overview</a>
  17   <li><a href="#quickstart">Getting Started Quickly (A Summary)</a>
  18   <li><a href="#requirements">Requirements</a>
  19     <ol>
  20       <li><a href="#hardware">Hardware</a></li>
  21       <li><a href="#software">Software</a></li>
  22       <li><a href="#brokengcc">Broken versions of GCC and other tools</a></li>
  23     </ol></li>
  24
  25   <li><a href="#starting">Getting Started with LLVM</a>
  26     <ol>
  27       <li><a href="#terminology">Terminology and Notation</a></li>
  28       <li><a href="#environment">Setting Up Your Environment</a></li>
  29       <li><a href="#unpack">Unpacking the LLVM Archives</a></li>
  30       <li><a href="#checkout">Checkout LLVM from Subversion</a></li>
  31       <li><a href="#git_mirror">LLVM GIT mirror</a></li>
  32       <li><a href="#installcf">Install the GCC Front End</a></li>
  33       <li><a href="#config">Local LLVM Configuration</a></li>
  34       <li><a href="#compile">Compiling the LLVM Suite Source Code</a></li>
  35       <li><a href="#cross-compile">Cross-Compiling LLVM</a></li>
  36       <li><a href="#objfiles">The Location of LLVM Object Files</a></li>
  37       <li><a href="#optionalconfig">Optional Configuration Items</a></li>
  38     </ol></li>
  39
  40   <li><a href="#layout">Program layout</a>
  41     <ol>
  42       <li><a href="#examples"><tt>llvm/examples</tt></a></li>
  43       <li><a href="#include"><tt>llvm/include</tt></a></li>
  44       <li><a href="#lib"><tt>llvm/lib</tt></a></li>
  45       <li><a href="#projects"><tt>llvm/projects</tt></a></li>
  46       <li><a href="#runtime"><tt>llvm/runtime</tt></a></li>
  47       <li><a href="#test"><tt>llvm/test</tt></a></li>
  48       <li><a href="#test-suite"><tt>test-suite</tt></a></li>
  49       <li><a href="#tools"><tt>llvm/tools</tt></a></li>
  50       <li><a href="#utils"><tt>llvm/utils</tt></a></li>
  51     </ol></li>
  52
  53   <li><a href="#tutorial">An Example Using the LLVM Tool Chain</a>
  54       <ol>
  55          <li><a href="#tutorial4">Example with llvm-gcc4</a></li>
  56       </ol>
  57   <li><a href="#problems">Common Problems</a>
  58   <li><a href="#links">Links</a>
  59 </ul>
  60
  61 <div class="doc_author">
  62   <p>Written by:
  63     <a href="mailto:criswell@uiuc.edu">John Criswell</a>,
  64     <a href="mailto:sabre@nondot.org">Chris Lattner</a>,
  65     <a href="http://misha.brukman.net">Misha Brukman</a>,
  66     <a href="http://www.cs.uiuc.edu/~vadve">Vikram Adve</a>, and
  67     <a href="mailto:gshi1@uiuc.edu">Guochun Shi</a>.
  68   </p>
  69 </div>
  70
  71
  72 <!-- *********************************************************************** -->
  73 <div class="doc_section">
  74   <a name="overview"><b>Overview</b></a>
  75 </div>
  76 <!-- *********************************************************************** -->
  77
  78 <div class="doc_text">
  79
  80 <p>Welcome to LLVM! In order to get started, you first need to know some
  81 basic information.</p>
  82
  83 <p>First, LLVM comes in three pieces. The first piece is the LLVM
  84 suite. This contains all of the tools, libraries, and header files
  85 needed to use the low level virtual machine.  It contains an
  86 assembler, disassembler, bitcode analyzer and bitcode optimizer.  It
  87 also contains basic regression tests that can be used to test the LLVM
  88 tools and the GCC front end.</p>
  89
  90 <p>The second piece is the GCC front end.  This component provides a version of
  91 GCC that compiles C and C++ code into LLVM bitcode.  Currently, the GCC front
  92 end uses the GCC parser to convert code to LLVM.  Once
  93 compiled into LLVM bitcode, a program can be manipulated with the LLVM tools
  94 from the LLVM suite.</p>
  95
  96 <p>
  97 There is a third, optional piece called Test Suite.  It is a suite of programs
  98 with a testing harness that can be used to further test LLVM's functionality
  99 and performance.
 100 </p>
 101
 102 </div>
 103
 104 <!-- *********************************************************************** -->
 105 <div class="doc_section">
 106   <a name="quickstart"><b>Getting Started Quickly (A Summary)</b></a>
 107 </div>
 108 <!-- *********************************************************************** -->
 109
 110 <div class="doc_text">
 111
 112 <p>Here's the short story for getting up and running quickly with LLVM:</p>
 113
 114 <ol>
 115   <li>Read the documentation.</li>
 116   <li>Read the documentation.</li>
 117   <li>Remember that you were warned twice about reading the documentation.</li>
 118   <li>Install the llvm-gcc-4.2 front end if you intend to compile C or C++
 119       (see <a href="#installcf">Install the GCC Front End</a> for details):</li>
 120     <ol>
 121       <li><tt>cd <i>where-you-want-the-C-front-end-to-live</i></tt></li>
 122       <li><tt>gunzip --stdout llvm-gcc-4.2-<i>version</i>-<i>platform</i>.tar.gz | tar -xvf -</tt></li>
 123           <li><tt><i>install-binutils-binary-from-MinGW</i></tt> (Windows only)</li>
 124           <li>Note: If the binary extension is "<tt>.bz</tt>" use <tt>bunzip2</tt> instead of <tt>gunzip</tt>.</li>
 125           <li>Note: On Windows, use <a href="http://www.7-zip.org">7-Zip</a> or a similar archiving tool.</li>
 126           <li>Add <tt>llvm-gcc</tt>'s "<tt>bin</tt>" directory to your <tt>PATH</tt> environment variable.</li>
 127     </ol></li>
 128
 129   <li>Get the LLVM Source Code
 130   <ul>
 131     <li>With the distributed files (or use <a href="#checkout">SVN</a>):
 132     <ol>
 133       <li><tt>cd <i>where-you-want-llvm-to-live</i></tt>
 134       <li><tt>gunzip --stdout llvm-<i>version</i>.tar.gz | tar -xvf -</tt>
 135     </ol></li>
 136
 137   </ul></li>
 138
 139   <li><b>[Optional]</b> Get the Test Suite Source Code
 140   <ul>
 141     <li>With the distributed files (or use <a href="#checkout">SVN</a>):
 142     <ol>
 143       <li><tt>cd <i>where-you-want-llvm-to-live</i></tt>
 144       <li><tt>cd llvm/projects</tt>
 145       <li><tt>gunzip --stdout llvm-test-<i>version</i>.tar.gz | tar -xvf -</tt>
 146       <li><tt>mv llvm-test-<i>version</i> test-suite</tt>
 147     </ol></li>
 148
 149   </ul></li>
 150
 151
 152   <li>Configure the LLVM Build Environment
 153   <ol>
 154     <li><tt>cd <i>where-you-want-to-build-llvm</i></tt></li>
 155     <li><tt><i>/path/to/llvm/</i>configure [options]</tt><br>
 156     Some common options:
 157
 158       <ul>
 159         <li><tt>--prefix=<i>directory</i></tt>
 160         <p>Specify for <i>directory</i> the full pathname of where you
 161         want the LLVM tools and libraries to be installed (default
 162         <tt>/usr/local</tt>).</p></li>
 163         <li><tt>--with-llvmgccdir=<i>directory</i></tt>
 164         <p>Optionally, specify for <i>directory</i> the full pathname of the
 165         C/C++ front end installation to use with this LLVM configuration. If
 166         not specified, the PATH will be searched.  This is only needed if you
 167         want to run test-suite or do some special kinds of LLVM builds.</p></li>
 168         <li><tt>--enable-spec2000=<i>directory</i></tt>
 169             <p>Enable the SPEC2000 benchmarks for testing.  The SPEC2000
 170             benchmarks should be available in
 171             <tt><i>directory</i></tt>.</p></li>
 172       </ul>
 173   </ol></li>
 174
 175   <li>Build the LLVM Suite:
 176   <ol>
 177       <li><tt>gmake -k |&amp; tee gnumake.out
 178       &nbsp;&nbsp;&nbsp;# this is csh or tcsh syntax</tt></li>
 179       <li>If you get an "internal compiler error (ICE)" or test failures, see
 180           <a href="#brokengcc">below</a>.</li>
 181   </ol>
 182
 183 </ol>
 184
 185 <p>Consult the <a href="#starting">Getting Started with LLVM</a> section for
 186 detailed information on configuring and compiling LLVM.  See <a
 187 href="#environment">Setting Up Your Environment</a> for tips that simplify
 188 working with the GCC front end and LLVM tools.  Go to <a href="#layout">Program
 189 Layout</a> to learn about the layout of the source code tree.</p>
 190
 191 </div>
 192
 193 <!-- *********************************************************************** -->
 194 <div class="doc_section">
 195   <a name="requirements"><b>Requirements</b></a>
 196 </div>
 197 <!-- *********************************************************************** -->
 198
 199 <div class="doc_text">
 200
 201 <p>Before you begin to use the LLVM system, review the requirements given below.
 202 This may save you some trouble by knowing ahead of time what hardware and
 203 software you will need.</p>
 204
 205 </div>
 206
 207 <!-- ======================================================================= -->
 208 <div class="doc_subsection">
 209   <a name="hardware"><b>Hardware</b></a>
 210 </div>
 211
 212 <div class="doc_text">
 213
 214 <p>LLVM is known to work on the following platforms:</p>
 215
 216 <table cellpadding="3" summary="Known LLVM platforms">
 217 <tr>
 218   <th>OS</th>
 219   <th>Arch</th>
 220   <th>Compilers</th>
 221 </tr>
 222 <tr>
 223   <td>AuroraUX</td>
 224   <td>x86<sup><a href="#pf_1">1</a></sup></td>
 225   <td>GCC</td>
 226 </tr>
 227 <tr>
 228   <td>Linux</td>
 229   <td>x86<sup><a href="#pf_1">1</a></sup></td>
 230   <td>GCC</td>
 231 </tr>
 232 <tr>
 233   <td>Linux</td>
 234   <td>amd64</td>
 235   <td>GCC</td>
 236 </tr>
 237 <tr>
 238   <td>Solaris</td>
 239   <td>V9 (Ultrasparc)</td>
 240   <td>GCC</td>
 241 </tr>
 242 <tr>
 243   <td>FreeBSD</td>
 244   <td>x86<sup><a href="#pf_1">1</a></sup></td>
 245   <td>GCC</td>
 246 </tr>
 247 <tr>
 248   <td>FreeBSD</td>
 249   <td>amd64</td>
 250   <td>GCC</td>
 251 </tr>
 252 <tr>
 253   <td>MacOS X<sup><a href="#pf_2">2</a></sup></td>
 254   <td>PowerPC</td>
 255   <td>GCC</td>
 256 </tr>
 257 <tr>
 258   <td>MacOS X<sup><a href="#pf_2">2</a>,<a href="#pf_9">9</a></sup></td>
 259   <td>x86</td>
 260   <td>GCC</td>
 261 </tr>
 262 <tr>
 263   <td>Cygwin/Win32</td>
 264   <td>x86<sup><a href="#pf_1">1</a>,<a href="#pf_8">8</a>,
 265      <a href="#pf_11">11</a></sup></td>
 266   <td>GCC 3.4.X, binutils 2.20</td>
 267 </tr>
 268 <tr>
 269   <td>MinGW/Win32</td>
 270   <td>x86<sup><a href="#pf_1">1</a>,<a href="#pf_6">6</a>,
 271      <a href="#pf_8">8</a>, <a href="#pf_10">10</a>,
 272      <a href="#pf_11">11</a></sup></td>
 273   <td>GCC 3.4.X, binutils 2.20</td>
 274 </tr>
 275 </table>
 276
 277 <p>LLVM has partial support for the following platforms:</p>
 278
 279 <table summary="LLVM partial platform support">
 280 <tr>
 281   <th>OS</th>
 282   <th>Arch</th>
 283   <th>Compilers</th>
 284 </tr>
 285 <tr>
 286   <td>Windows</td>
 287   <td>x86<sup><a href="#pf_1">1</a></sup></td>
 288   <td>Visual Studio 2005 SP1 or higher<sup><a href="#pf_4">4</a>,<a href="#pf_5">5</a></sup></td>
 289 <tr>
 290   <td>AIX<sup><a href="#pf_3">3</a>,<a href="#pf_4">4</a></sup></td>
 291   <td>PowerPC</td>
 292   <td>GCC</td>
 293 </tr>
 294 <tr>
 295   <td>Linux<sup><a href="#pf_3">3</a>,<a href="#pf_5">5</a></sup></td>
 296   <td>PowerPC</td>
 297   <td>GCC</td>
 298 </tr>
 299
 300 <tr>
 301   <td>Linux<sup><a href="#pf_7">7</a></sup></td>
 302   <td>Alpha</td>
 303   <td>GCC</td>
 304 </tr>
 305 <tr>
 306   <td>Linux<sup><a href="#pf_7">7</a></sup></td>
 307   <td>Itanium (IA-64)</td>
 308   <td>GCC</td>
 309 </tr>
 310 <tr>
 311   <td>HP-UX<sup><a href="#pf_7">7</a></sup></td>
 312   <td>Itanium (IA-64)</td>
 313   <td>HP aCC</td>
 314 </tr>
 315 <tr>
 316   <td>Windows x64</td>
 317   <td>x86-64</td>
 318   <td>mingw-w64's GCC-4.5.x<sup><a href="#pf_12">12</a></sup></td>
 319 </tr>
 320 </table>
 321
 322 <p><b>Notes:</b></p>
 323
 324 <div class="doc_notes">
 325 <ol>
 326 <li><a name="pf_1">Code generation supported for Pentium processors and
 327 up</a></li>
 328 <li><a name="pf_2">Code generation supported for 32-bit ABI only</a></li>
 329 <li><a name="pf_3">No native code generation</a></li>
 330 <li><a name="pf_4">Build is not complete: one or more tools do not link or function</a></li>
 331 <li><a name="pf_5">The GCC-based C/C++ frontend does not build</a></li>
 332 <li><a name="pf_6">The port is done using the MSYS shell.</a></li>
 333 <li><a name="pf_7">Native code generation exists but is not complete.</a></li>
 334 <li><a name="pf_8">Binutils 2.20 or later is required to build the assembler
 335     generated by LLVM properly.</a></li>
 336 <li><a name="pf_9">XCode 2.5 and gcc 4.0.1</a> (Apple Build 5370) will trip
 337     internal LLVM assert messages when compiled for Release at optimization
 338     levels greater than 0 (i.e., <i>"-O1"</i> and higher).
 339     Add <i>OPTIMIZE_OPTION="-O0"</i> to the build command line
 340     if compiling for LLVM Release or bootstrapping the LLVM toolchain.</li>
 341 <li><a name="pf_10">For MSYS/MinGW on Windows, be sure to install the MSYS
 342     version of the perl package, and be sure it appears in your path
 343     before any Windows-based versions such as Strawberry Perl and
 344     ActivePerl, as these have Windows-specifics that will cause the
 345     build to fail.</a></li>
 346 <li><a name="pf_11">To use LLVM modules on Win32-based system,
 347     you may configure LLVM with <i>&quot;--enable-shared&quot;</i>.</li>
 348 <li><a name="pf_12">To compile SPU backend, you need to add
 349     <tt>&quot;LDFLAGS=-Wl,--stack,16777216&quot;</tt> to configure.</li>
 350 </ol>
 351 </div>
 352
 353 <p>Note that you will need about 1-3 GB of space for a full LLVM build in Debug
 354 mode, depending on the system (it is so large because of all the debugging
 355 information and the fact that the libraries are statically linked into multiple
 356 tools).  If you do not need many of the tools and you are space-conscious, you
 357 can pass <tt>ONLY_TOOLS="tools you need"</tt> to make.  The Release build
 358 requires considerably less space.</p>
 359
 360 <p>The LLVM suite <i>may</i> compile on other platforms, but it is not
 361 guaranteed to do so.  If compilation is successful, the LLVM utilities should be
 362 able to assemble, disassemble, analyze, and optimize LLVM bitcode.  Code
 363 generation should work as well, although the generated native code may not work
 364 on your platform.</p>
 365
 366 <p>The GCC front end is not very portable at the moment.  If you want to get it
 367 to work on another platform, you can download a copy of the source and <a
 368 href="GCCFEBuildInstrs.html">try to compile it</a> on your platform.</p>
 369
 370 </div>
 371
 372 <!-- ======================================================================= -->
 373 <div class="doc_subsection"><a name="software"><b>Software</b></a></div>
 374 <div class="doc_text">
 375   <p>Compiling LLVM requires that you have several software packages
 376   installed. The table below lists those required packages. The Package column
 377   is the usual name for the software package that LLVM depends on. The Version
 378   column provides "known to work" versions of the package. The Notes column
 379   describes how LLVM uses the package and provides other details.</p>
 380   <table summary="Packages required to compile LLVM">
 381     <tr><th>Package</th><th>Version</th><th>Notes</th></tr>
 382
 383     <tr>
 384       <td><a href="http://savannah.gnu.org/projects/make">GNU Make</a></td>
 385       <td>3.79, 3.79.1</td>
 386       <td>Makefile/build processor</td>
 387     </tr>
 388
 389     <tr>
 390       <td><a href="http://gcc.gnu.org">GCC</a></td>
 391       <td>3.4.2</td>
 392       <td>C/C++ compiler<sup><a href="#sf1">1</a></sup></td>
 393     </tr>
 394
 395     <tr>
 396       <td><a href="http://www.gnu.org/software/texinfo">TeXinfo</a></td>
 397       <td>4.5</td>
 398       <td>For building the CFE</td>
 399     </tr>
 400
 401     <tr>
 402       <td><a href="http://subversion.tigris.org/project_packages.html">SVN</a></td>
 403       <td>&ge;1.3</td>
 404       <td>Subversion access to LLVM<sup><a href="#sf2">2</a></sup></td>
 405     </tr>
 406
 407     <tr>
 408       <td><a href="http://savannah.gnu.org/projects/dejagnu">DejaGnu</a></td>
 409       <td>1.4.2</td>
 410       <td>Automated test suite<sup><a href="#sf3">3</a></sup></td>
 411     </tr>
 412
 413     <tr>
 414       <td><a href="http://www.tcl.tk/software/tcltk/">tcl</a></td>
 415       <td>8.3, 8.4</td>
 416       <td>Automated test suite<sup><a href="#sf3">3</a></sup></td>
 417     </tr>
 418
 419     <tr>
 420       <td><a href="http://expect.nist.gov/">expect</a></td>
 421       <td>5.38.0</td>
 422       <td>Automated test suite<sup><a href="#sf3">3</a></sup></td>
 423     </tr>
 424
 425     <tr>
 426       <td><a href="http://www.perl.com/download.csp">perl</a></td>
 427       <td>&ge;5.6.0</td>
 428       <td>Nightly tester, utilities</td>
 429     </tr>
 430
 431     <tr>
 432       <td><a href="http://savannah.gnu.org/projects/m4">GNU M4</a>
 433       <td>1.4</td>
 434       <td>Macro processor for configuration<sup><a href="#sf4">4</a></sup></td>
 435     </tr>
 436
 437     <tr>
 438       <td><a href="http://www.gnu.org/software/autoconf">GNU Autoconf</a></td>
 439       <td>2.60</td>
 440       <td>Configuration script builder<sup><a href="#sf4">4</a></sup></td>
 441     </tr>
 442
 443     <tr>
 444       <td><a href="http://www.gnu.org/software/automake">GNU Automake</a></td>
 445       <td>1.9.6</td>
 446       <td>aclocal macro generator<sup><a href="#sf4">4</a></sup></td>
 447     </tr>
 448
 449     <tr>
 450       <td><a href="http://savannah.gnu.org/projects/libtool">libtool</a></td>
 451       <td>1.5.22</td>
 452       <td>Shared library manager<sup><a href="#sf4">4</a></sup></td>
 453     </tr>
 454
 455   </table>
 456
 457   <p><b>Notes:</b></p>
 458   <div class="doc_notes">
 459   <ol>
 460     <li><a name="sf1">Only the C and C++ languages are needed so there's no
 461       need to build the other languages for LLVM's purposes.</a> See
 462       <a href="#brokengcc">below</a> for specific version info.</li>
 463     <li><a name="sf2">You only need Subversion if you intend to build from the
 464       latest LLVM sources. If you're working from a release distribution, you
 465       don't need Subversion.</a></li>
 466     <li><a name="sf3">Only needed if you want to run the automated test
 467       suite in the <tt>llvm/test</tt> directory.</a></li>
 468     <li><a name="sf4">If you want to make changes to the configure scripts,
 469       you will need GNU autoconf (2.60), and consequently, GNU M4 (version 1.4
 470       or higher). You will also need automake (1.9.6). We only use aclocal
 471       from that package.</a></li>
 472   </ol>
 473   </div>
 474
 475   <p>Additionally, your compilation host is expected to have the usual
 476   plethora of Unix utilities. Specifically:</p>
 477   <ul>
 478     <li><b>ar</b> - archive library builder</li>
 479     <li><b>bzip2*</b> - bzip2 command for distribution generation</li>
 480     <li><b>bunzip2*</b> - bunzip2 command for distribution checking</li>
 481     <li><b>chmod</b> - change permissions on a file</li>
 482     <li><b>cat</b> - output concatenation utility</li>
 483     <li><b>cp</b> - copy files</li>
 484     <li><b>date</b> - print the current date/time </li>
 485     <li><b>echo</b> - print to standard output</li>
 486     <li><b>egrep</b> - extended regular expression search utility</li>
 487     <li><b>find</b> - find files/dirs in a file system</li>
 488     <li><b>grep</b> - regular expression search utility</li>
 489     <li><b>gzip*</b> - gzip command for distribution generation</li>
 490     <li><b>gunzip*</b> - gunzip command for distribution checking</li>
 491     <li><b>install</b> - install directories/files </li>
 492     <li><b>mkdir</b> - create a directory</li>
 493     <li><b>mv</b> - move (rename) files</li>
 494     <li><b>ranlib</b> - symbol table builder for archive libraries</li>
 495     <li><b>rm</b> - remove (delete) files and directories</li>
 496     <li><b>sed</b> - stream editor for transforming output</li>
 497     <li><b>sh</b> - Bourne shell for make build scripts</li>
 498     <li><b>tar</b> - tape archive for distribution generation</li>
 499     <li><b>test</b> - test things in file system</li>
 500     <li><b>unzip*</b> - unzip command for distribution checking</li>
 501     <li><b>zip*</b> - zip command for distribution generation</li>
 502   </ul>
 503 </div>
 504
 505 <!-- ======================================================================= -->
 506 <div class="doc_subsection">
 507   <a name="brokengcc">Broken versions of GCC and other tools</a>
 508 </div>
 509
 510 <div class="doc_text">
 511
 512 <p>LLVM is very demanding of the host C++ compiler, and as such tends to expose
 513 bugs in the compiler.  In particular, several versions of GCC crash when trying
 514 to compile LLVM.  We routinely use GCC 3.3.3, 3.4.0, and Apple 4.0.1
 515 successfully with them (however, see important notes below).  Other versions
 516 of GCC will probably work as well.  GCC versions listed
 517 here are known to not work.  If you are using one of these versions, please try
 518 to upgrade your GCC to something more recent.  If you run into a problem with a
 519 version of GCC not listed here, please <a href="mailto:llvmdev@cs.uiuc.edu">let
 520 us know</a>.  Please use the "<tt>gcc -v</tt>" command to find out which version
 521 of GCC you are using.
 522 </p>
 523
 524 <p><b>GCC versions prior to 3.0</b>: GCC 2.96.x and before had several
 525 problems in the STL that effectively prevent it from compiling LLVM.
 526 </p>
 527
 528 <p><b>GCC 3.2.2 and 3.2.3</b>: These versions of GCC fails to compile LLVM with
 529 a bogus template error.  This was fixed in later GCCs.</p>
 530
 531 <p><b>GCC 3.3.2</b>: This version of GCC suffered from a <a
 532 href="http://gcc.gnu.org/PR13392">serious bug</a> which causes it to crash in
 533 the "<tt>convert_from_eh_region_ranges_1</tt>" GCC function.</p>
 534
 535 <p><b>Cygwin GCC 3.3.3</b>: The version of GCC 3.3.3 commonly shipped with
 536    Cygwin does not work.  Please <a href="GCCFEBuildInstrs.html#cygwin">upgrade
 537    to a newer version</a> if possible.</p>
 538 <p><b>SuSE GCC 3.3.3</b>: The version of GCC 3.3.3 shipped with SuSE 9.1 (and
 539    possibly others) does not compile LLVM correctly (it appears that exception
 540    handling is broken in some cases).  Please download the FSF 3.3.3 or upgrade
 541    to a newer version of GCC.</p>
 542 <p><b>GCC 3.4.0 on linux/x86 (32-bit)</b>: GCC miscompiles portions of the
 543    code generator, causing an infinite loop in the llvm-gcc build when built
 544    with optimizations enabled (i.e. a release build).</p>
 545 <p><b>GCC 3.4.2 on linux/x86 (32-bit)</b>: GCC miscompiles portions of the
 546    code generator at -O3, as with 3.4.0.  However gcc 3.4.2 (unlike 3.4.0)
 547    correctly compiles LLVM at -O2.  A work around is to build release LLVM
 548    builds with "make ENABLE_OPTIMIZED=1 OPTIMIZE_OPTION=-O2 ..."</p>
 549 <p><b>GCC 3.4.x on X86-64/amd64</b>: GCC <a href="http://llvm.org/PR1056">
 550    miscompiles portions of LLVM</a>.</p>
 551 <p><b>GCC 3.4.4 (CodeSourcery ARM 2005q3-2)</b>: this compiler miscompiles LLVM
 552    when building with optimizations enabled.  It appears to work with
 553    "<tt>make ENABLE_OPTIMIZED=1 OPTIMIZE_OPTION=-O1</tt>" or build a debug
 554    build.</p>
 555 <p><b>IA-64 GCC 4.0.0</b>: The IA-64 version of GCC 4.0.0 is known to
 556    miscompile LLVM.</p>
 557 <p><b>Apple Xcode 2.3</b>: GCC crashes when compiling LLVM at -O3 (which is the
 558    default with ENABLE_OPTIMIZED=1.  To work around this, build with
 559    "ENABLE_OPTIMIZED=1 OPTIMIZE_OPTION=-O2".</p>
 560 <p><b>GCC 4.1.1</b>: GCC fails to build LLVM with template concept check errors
 561       compiling some files.  At the time of this writing, GCC mainline (4.2)
 562       did not share the problem.</p>
 563 <p><b>GCC 4.1.1 on X86-64/amd64</b>: GCC <a href="http://llvm.org/PR1063">
 564    miscompiles portions of LLVM</a> when compiling llvm itself into 64-bit
 565    code.  LLVM will appear to mostly work but will be buggy, e.g. failing
 566    portions of its testsuite.</p>
 567 <p><b>GCC 4.1.2 on OpenSUSE</b>: Seg faults during libstdc++ build and on x86_64
 568 platforms compiling md5.c gets a mangled constant.</p>
 569 <p><b>GCC 4.1.2 (20061115 (prerelease) (Debian 4.1.1-21)) on Debian</b>: Appears
 570 to miscompile parts of LLVM 2.4. One symptom is ValueSymbolTable complaining
 571 about symbols remaining in the table on destruction.</p>
 572 <p><b>GCC 4.1.2 20071124 (Red Hat 4.1.2-42)</b>: Suffers from the same symptoms
 573 as the previous one. It appears to work with ENABLE_OPTIMIZED=0 (the default).</p>
 574 <p><b>Cygwin GCC 4.3.2 20080827 (beta) 2</b>:
 575   Users <a href="http://llvm.org/PR4145">reported</a> various problems related
 576   with link errors when using this GCC version.</p>
 577 <p><b>Debian GCC 4.3.2 on X86</b>: Crashes building some files in LLVM 2.6.</p>
 578 <p><b>GCC 4.3.3 (Debian 4.3.3-10) on ARM</b>: Miscompiles parts of LLVM 2.6
 579 when optimizations are turned on. The symptom is an infinite loop in
 580 FoldingSetImpl::RemoveNode while running the code generator.</p>
 581 <p><b>GCC 4.3.5 and GCC 4.4.5 on ARM</b>: These can miscompile <tt>value >>
 582 1</tt> even at -O0. A test failure in <tt>test/Assembler/alignstack.ll</tt> is
 583 one symptom of the problem.
 584 <p><b>GNU ld 2.16.X</b>. Some 2.16.X versions of the ld linker will produce very
 585 long warning messages complaining that some ".gnu.linkonce.t.*" symbol was
 586 defined in a discarded section. You can safely ignore these messages as they are
 587 erroneous and the linkage is correct.  These messages disappear using ld
 588 2.17.</p>
 589
 590 <p><b>GNU binutils 2.17</b>: Binutils 2.17 contains <a
 591 href="http://sourceware.org/bugzilla/show_bug.cgi?id=3111">a bug</a> which
 592 causes huge link times (minutes instead of seconds) when building LLVM.  We
 593 recommend upgrading to a newer version (2.17.50.0.4 or later).</p>
 594
 595 <p><b>GNU Binutils 2.19.1 Gold</b>: This version of Gold contained
 596 <a href="http://sourceware.org/bugzilla/show_bug.cgi?id=9836">a bug</a>
 597 which causes intermittent failures when building LLVM with position independent
 598 code.  The symptom is an error about cyclic dependencies.  We recommend
 599 upgrading to a newer version of Gold.</p>
 600
 601 </div>
 602
 603
 604
 605 <!-- *********************************************************************** -->
 606 <div class="doc_section">
 607   <a name="starting"><b>Getting Started with LLVM</b></a>
 608 </div>
 609 <!-- *********************************************************************** -->
 610
 611 <div class="doc_text">
 612
 613 <p>The remainder of this guide is meant to get you up and running with
 614 LLVM and to give you some basic information about the LLVM environment.</p>
 615
 616 <p>The later sections of this guide describe the <a
 617 href="#layout">general layout</a> of the the LLVM source tree, a <a
 618 href="#tutorial">simple example</a> using the LLVM tool chain, and <a
 619 href="#links">links</a> to find more information about LLVM or to get
 620 help via e-mail.</p>
 621 </div>
 622
 623 <!-- ======================================================================= -->
 624 <div class="doc_subsection">
 625   <a name="terminology">Terminology and Notation</a>
 626 </div>
 627
 628 <div class="doc_text">
 629
 630 <p>Throughout this manual, the following names are used to denote paths
 631 specific to the local system and working environment.  <i>These are not
 632 environment variables you need to set but just strings used in the rest
 633 of this document below</i>.  In any of the examples below, simply replace
 634 each of these names with the appropriate pathname on your local system.
 635 All these paths are absolute:</p>
 636
 637 <dl>
 638     <dt>SRC_ROOT
 639     <dd>
 640     This is the top level directory of the LLVM source tree.
 641     <br><br>
 642
 643     <dt>OBJ_ROOT
 644     <dd>
 645     This is the top level directory of the LLVM object tree (i.e. the
 646     tree where object files and compiled programs will be placed.  It
 647     can be the same as SRC_ROOT).
 648     <br><br>
 649
 650     <dt>LLVMGCCDIR
 651     <dd>
 652     This is where the LLVM GCC Front End is installed.
 653     <p>
 654     For the pre-built GCC front end binaries, the LLVMGCCDIR is
 655     <tt>llvm-gcc/<i>platform</i>/llvm-gcc</tt>.
 656 </dl>
 657
 658 </div>
 659
 660 <!-- ======================================================================= -->
 661 <div class="doc_subsection">
 662   <a name="environment">Setting Up Your Environment</a>
 663 </div>
 664
 665 <div class="doc_text">
 666
 667 <p>
 668 In order to compile and use LLVM, you may need to set some environment
 669 variables.
 670
 671 <dl>
 672   <dt><tt>LLVM_LIB_SEARCH_PATH</tt>=<tt>/path/to/your/bitcode/libs</tt></dt>
 673   <dd>[Optional] This environment variable helps LLVM linking tools find the
 674   locations of your bitcode libraries. It is provided only as a
 675   convenience since you can specify the paths using the -L options of the
 676   tools and the C/C++ front-end will automatically use the bitcode files
 677   installed in its
 678   <tt>lib</tt> directory.</dd>
 679 </dl>
 680
 681 </div>
 682
 683 <!-- ======================================================================= -->
 684 <div class="doc_subsection">
 685   <a name="unpack">Unpacking the LLVM Archives</a>
 686 </div>
 687
 688 <div class="doc_text">
 689
 690 <p>
 691 If you have the LLVM distribution, you will need to unpack it before you
 692 can begin to compile it.  LLVM is distributed as a set of two files: the LLVM
 693 suite and the LLVM GCC front end compiled for your platform.  There is an
 694 additional test suite that is optional.  Each file is a TAR archive that is
 695 compressed with the gzip program.
 696 </p>
 697
 698 <p>The files are as follows, with <em>x.y</em> marking the version number:
 699 <dl>
 700   <dt><tt>llvm-x.y.tar.gz</tt></dt>
 701   <dd>Source release for the LLVM libraries and tools.<br></dd>
 702
 703   <dt><tt>llvm-test-x.y.tar.gz</tt></dt>
 704   <dd>Source release for the LLVM test-suite.</dd>
 705
 706   <dt><tt>llvm-gcc-4.2-x.y.source.tar.gz</tt></dt>
 707   <dd>Source release of the llvm-gcc-4.2 front end.  See README.LLVM in the root
 708       directory for build instructions.<br></dd>
 709
 710   <dt><tt>llvm-gcc-4.2-x.y-platform.tar.gz</tt></dt>
 711   <dd>Binary release of the llvm-gcc-4.2 front end for a specific platform.<br></dd>
 712
 713 </dl>
 714
 715 </div>
 716
 717 <!-- ======================================================================= -->
 718 <div class="doc_subsection">
 719   <a name="checkout">Checkout LLVM from Subversion</a>
 720 </div>
 721
 722 <div class="doc_text">
 723
 724 <p>If you have access to our Subversion repository, you can get a fresh copy of
 725 the entire source code.  All you need to do is check it out from Subversion as
 726 follows:</p>
 727
 728 <ul>
 729   <li><tt>cd <i>where-you-want-llvm-to-live</i></tt></li>
 730   <li>Read-Only: <tt>svn co http://llvm.org/svn/llvm-project/llvm/trunk llvm</tt></li>
 731   <li>Read-Write:<tt>svn co https://user@llvm.org/svn/llvm-project/llvm/trunk
 732     llvm</tt></li>
 733 </ul>
 734
 735
 736 <p>This will create an '<tt>llvm</tt>' directory in the current
 737 directory and fully populate it with the LLVM source code, Makefiles,
 738 test directories, and local copies of documentation files.</p>
 739
 740 <p>If you want to get a specific release (as opposed to the most recent
 741 revision), you can checkout it from the '<tt>tags</tt>' directory (instead of
 742 '<tt>trunk</tt>'). The following releases are located in the following
 743 subdirectories of the '<tt>tags</tt>' directory:</p>
 744
 745 <ul>
 746 <li>Release 2.9: <b>RELEASE_29/final</b></li>
 747 <li>Release 2.8: <b>RELEASE_28</b></li>
 748 <li>Release 2.7: <b>RELEASE_27</b></li>
 749 <li>Release 2.6: <b>RELEASE_26</b></li>
 750 <li>Release 2.5: <b>RELEASE_25</b></li>
 751 <li>Release 2.4: <b>RELEASE_24</b></li>
 752 <li>Release 2.3: <b>RELEASE_23</b></li>
 753 <li>Release 2.2: <b>RELEASE_22</b></li>
 754 <li>Release 2.1: <b>RELEASE_21</b></li>
 755 <li>Release 2.0: <b>RELEASE_20</b></li>
 756 <li>Release 1.9: <b>RELEASE_19</b></li>
 757 <li>Release 1.8: <b>RELEASE_18</b></li>
 758 <li>Release 1.7: <b>RELEASE_17</b></li>
 759 <li>Release 1.6: <b>RELEASE_16</b></li>
 760 <li>Release 1.5: <b>RELEASE_15</b></li>
 761 <li>Release 1.4: <b>RELEASE_14</b></li>
 762 <li>Release 1.3: <b>RELEASE_13</b></li>
 763 <li>Release 1.2: <b>RELEASE_12</b></li>
 764 <li>Release 1.1: <b>RELEASE_11</b></li>
 765 <li>Release 1.0: <b>RELEASE_1</b></li>
 766 </ul>
 767
 768 <p>If you would like to get the LLVM test suite (a separate package as of 1.4),
 769 you get it from the Subversion repository:</p>
 770
 771 <div class="doc_code">
 772 <pre>
 773 % cd llvm/projects
 774 % svn co http://llvm.org/svn/llvm-project/test-suite/trunk test-suite
 775 </pre>
 776 </div>
 777
 778 <p>By placing it in the <tt>llvm/projects</tt>, it will be automatically
 779 configured by the LLVM configure script as well as automatically updated when
 780 you run <tt>svn update</tt>.</p>
 781
 782 <p>If you would like to get the GCC front end source code, you can also get it
 783 and build it yourself.  Please follow <a href="GCCFEBuildInstrs.html">these
 784 instructions</a> to successfully get and build the LLVM GCC front-end.</p>
 785
 786 </div>
 787
 788 <!-- ======================================================================= -->
 789 <div class="doc_subsection">
 790   <a name="git_mirror">GIT mirror</a>
 791 </div>
 792
 793 <div class="doc_text">
 794
 795 <p>GIT mirrors are available for a number of LLVM subprojects. These mirrors
 796   sync automatically with each Subversion commit and contain all necessary
 797   git-svn marks (so, you can recreate git-svn metadata locally). Note that right
 798   now mirrors reflect only <tt>trunk</tt> for each project. You can do the
 799   read-only GIT clone of LLVM via:
 800 <pre>
 801 % git clone http://llvm.org/git/llvm.git
 802 </pre>
 803 </p>
 804
 805 </div>
 806
 807 <!-- ======================================================================= -->
 808 <div class="doc_subsection">
 809   <a name="installcf">Install the GCC Front End</a>
 810 </div>
 811
 812 <div class="doc_text">
 813
 814 <p>Before configuring and compiling the LLVM suite (or if you want to use just the LLVM
 815 GCC front end) you can optionally extract the front end from the binary distribution.
 816 It is used for running the LLVM test-suite and for compiling C/C++ programs.  Note that
 817 you can optionally <a href="GCCFEBuildInstrs.html">build llvm-gcc yourself</a> after building the
 818 main LLVM repository.</p>
 819
 820 <p>To install the GCC front end, do the following (on Windows, use an archival tool
 821 like <a href="http://www.7-zip.org">7-zip</a> that understands gzipped tars):</p>
 822
 823 <ol>
 824   <li><tt>cd <i>where-you-want-the-front-end-to-live</i></tt></li>
 825   <li><tt>gunzip --stdout llvm-gcc-4.2-<i>version</i>-<i>platform</i>.tar.gz | tar -xvf
 826       -</tt></li>
 827 </ol>
 828
 829 <p>Once the binary is uncompressed, if you're using a *nix-based system, add a symlink for
 830 <tt>llvm-gcc</tt> and <tt>llvm-g++</tt> to some directory in your path.  If you're using a
 831 Windows-based system, add the <tt>bin</tt> subdirectory of your front end installation directory
 832 to your <tt>PATH</tt> environment variable.  For example, if you uncompressed the binary to
 833 <tt>c:\llvm-gcc</tt>, add <tt>c:\llvm-gcc\bin</tt> to your <tt>PATH</tt>.</p>
 834
 835 <p>If you now want to build LLVM from source, when you configure LLVM, it will
 836 automatically detect <tt>llvm-gcc</tt>'s presence (if it is in your path) enabling its
 837 use in test-suite.  Note that you can always build or install <tt>llvm-gcc</tt> at any
 838 point after building the main LLVM repository: just reconfigure llvm and
 839 test-suite will pick it up.
 840 </p>
 841
 842 <p>As a convenience for Windows users, the front end binaries for MinGW/x86 include
 843 versions of the required w32api and mingw-runtime binaries.  The last remaining step for
 844 Windows users is to simply uncompress the binary binutils package from
 845 <a href="http://mingw.org/">MinGW</a> into your front end installation directory.  While the
 846 front end installation steps are not quite the same as a typical manual MinGW installation,
 847 they should be similar enough to those who have previously installed MinGW on Windows systems.</p>
 848
 849 <p>To install binutils on Windows:</p>
 850
 851 <ol>
 852   <li><tt><i>download GNU Binutils from <a href="http://sourceforge.net/projects/mingw/files/">MinGW Downloads</a></i></tt></li>
 853   <li><tt>cd <i>where-you-uncompressed-the-front-end</i></tt></li>
 854   <li><tt><i>uncompress archived binutils directories (not the tar file) into the current directory</i></tt></li>
 855 </ol>
 856
 857 <p>The binary versions of the LLVM GCC front end may not suit all of your needs.  For
 858 example, the binary distribution may include an old version of a system header
 859 file, not "fix" a header file that needs to be fixed for GCC, or it may be linked with
 860 libraries not available on your system.  In cases like these, you may want to try
 861 <a href="GCCFEBuildInstrs.html">building the GCC front end from source</a>.  Thankfully,
 862 this is much easier now than it was in the past.</p>
 863
 864 <p>We also do not currently support updating of the GCC front end by manually overlaying
 865 newer versions of the w32api and mingw-runtime binary packages that may become available
 866 from MinGW.  At this time, it's best to think of the MinGW LLVM GCC front end binary as
 867 a self-contained convenience package that requires Windows users to simply download and
 868 uncompress the GNU Binutils binary package from the MinGW project.</p>
 869
 870 <p>Regardless of your platform, if you discover that installing the LLVM GCC front end
 871 binaries is not as easy as previously described, or you would like to suggest improvements,
 872 please let us know how you would like to see things improved by dropping us a note on our
 873 <a href="http://llvm.org/docs/#maillist">mailing list</a>.</p>
 874
 875 </div>
 876
 877 <!-- ======================================================================= -->
 878 <div class="doc_subsection">
 879   <a name="config">Local LLVM Configuration</a>
 880 </div>
 881
 882 <div class="doc_text">
 883
 884   <p>Once checked out from the Subversion repository, the LLVM suite source
 885   code must be
 886 configured via the <tt>configure</tt> script.  This script sets variables in the
 887 various <tt>*.in</tt> files, most notably <tt>llvm/Makefile.config</tt> and
 888 <tt>llvm/include/Config/config.h</tt>.  It also populates <i>OBJ_ROOT</i> with
 889 the Makefiles needed to begin building LLVM.</p>
 890
 891 <p>The following environment variables are used by the <tt>configure</tt>
 892 script to configure the build system:</p>
 893
 894 <table summary="LLVM configure script environment variables">
 895   <tr><th>Variable</th><th>Purpose</th></tr>
 896   <tr>
 897     <td>CC</td>
 898     <td>Tells <tt>configure</tt> which C compiler to use.  By default,
 899         <tt>configure</tt> will look for the first GCC C compiler in
 900         <tt>PATH</tt>.  Use this variable to override
 901         <tt>configure</tt>'s default behavior.</td>
 902   </tr>
 903   <tr>
 904     <td>CXX</td>
 905     <td>Tells <tt>configure</tt> which C++ compiler to use.  By default,
 906        <tt>configure</tt> will look for the first GCC C++ compiler in
 907        <tt>PATH</tt>.  Use this variable to override
 908        <tt>configure</tt>'s default behavior.</td>
 909   </tr>
 910 </table>
 911
 912 <p>The following options can be used to set or enable LLVM specific options:</p>
 913
 914 <dl>
 915   <dt><i>--with-llvmgccdir</i></dt>
 916   <dd>Path to the LLVM C/C++ FrontEnd to be used with this LLVM configuration.
 917   The value of this option should specify the full pathname of the C/C++ Front
 918   End to be used. If this option is not provided, the PATH will be searched for
 919   a program named <i>llvm-gcc</i> and the C/C++ FrontEnd install directory will
 920   be inferred from the path found. If the option is not given, and no llvm-gcc
 921   can be found in the path then a warning will be produced by
 922   <tt>configure</tt> indicating this situation. LLVM may still be built with
 923   the <tt>tools-only</tt> target but attempting to build the runtime libraries
 924   will fail as these libraries require llvm-gcc and llvm-g++. See
 925   <a href="#installcf">Install the GCC Front End</a> for details on installing
 926   the C/C++ Front End. See
 927   <a href="GCCFEBuildInstrs.html">Bootstrapping the LLVM C/C++ Front-End</a>
 928   for details on building the C/C++ Front End.</dd>
 929   <dt><i>--with-tclinclude</i></dt>
 930   <dd>Path to the tcl include directory under which <tt>tclsh</tt> can be
 931   found. Use this if you have multiple tcl installations on your machine and you
 932   want to use a specific one (8.x) for LLVM. LLVM only uses tcl for running the
 933   dejagnu based test suite in <tt>llvm/test</tt>. If you don't specify this
 934   option, the LLVM configure script will search for the tcl 8.4 and 8.3
 935   releases.
 936   <br><br>
 937   </dd>
 938   <dt><i>--enable-optimized</i></dt>
 939   <dd>
 940     Enables optimized compilation (debugging symbols are removed
 941     and GCC optimization flags are enabled). Note that this is the default
 942     setting     if you are using the LLVM distribution. The default behavior
 943     of an Subversion checkout is to use an unoptimized build (also known as a
 944     debug build).
 945     <br><br>
 946   </dd>
 947   <dt><i>--enable-debug-runtime</i></dt>
 948   <dd>
 949     Enables debug symbols in the runtime libraries. The default is to strip
 950     debug symbols from the runtime libraries.
 951   </dd>
 952   <dt><i>--enable-jit</i></dt>
 953   <dd>
 954     Compile the Just In Time (JIT) compiler functionality.  This is not
 955     available
 956     on all platforms.  The default is dependent on platform, so it is best
 957     to explicitly enable it if you want it.
 958     <br><br>
 959   </dd>
 960   <dt><i>--enable-targets=</i><tt>target-option</tt></dt>
 961   <dd>Controls which targets will be built and linked into llc. The default
 962   value for <tt>target_options</tt> is "all" which builds and links all
 963   available targets.  The value "host-only" can be specified to build only a
 964   native compiler (no cross-compiler targets available). The "native" target is
 965   selected as the target of the build host. You can also specify a comma
 966   separated list of target names that you want available in llc. The target
 967   names use all lower case. The current set of targets is: <br>
 968   <tt>alpha, ia64, powerpc, skeleton, sparc, x86</tt>.
 969   <br><br></dd>
 970   <dt><i>--enable-doxygen</i></dt>
 971   <dd>Look for the doxygen program and enable construction of doxygen based
 972   documentation from the source code. This is disabled by default because
 973   generating the documentation can take a long time and producess 100s of
 974   megabytes of output.</dd>
 975   <dt><i>--with-udis86</i></dt>
 976   <dd>LLVM can use external disassembler library for various purposes (now it's
 977   used only for examining code produced by JIT). This option will enable usage
 978   of <a href="http://udis86.sourceforge.net/">udis86</a> x86 (both 32 and 64
 979   bits) disassembler library.</dd>
 980 </dl>
 981
 982 <p>To configure LLVM, follow these steps:</p>
 983
 984 <ol>
 985     <li><p>Change directory into the object root directory:</p>
 986
 987     <div class="doc_code"><pre>% cd <i>OBJ_ROOT</i></pre></div></li>
 988
 989     <li><p>Run the <tt>configure</tt> script located in the LLVM source
 990     tree:</p>
 991
 992     <div class="doc_code">
 993     <pre>% <i>SRC_ROOT</i>/configure --prefix=/install/path [other options]</pre>
 994     </div></li>
 995 </ol>
 996
 997 </div>
 998
 999 <!-- ======================================================================= -->
1000 <div class="doc_subsection">
1001   <a name="compile">Compiling the LLVM Suite Source Code</a>
1002 </div>
1003
1004 <div class="doc_text">
1005
1006 <p>Once you have configured LLVM, you can build it.  There are three types of
1007 builds:</p>
1008
1009 <dl>
1010     <dt>Debug Builds
1011     <dd>
1012     These builds are the default when one is using an Subversion checkout and
1013     types <tt>gmake</tt> (unless the <tt>--enable-optimized</tt> option was
1014     used during configuration).  The build system will compile the tools and
1015     libraries with debugging information.  To get a Debug Build using the
1016     LLVM distribution the <tt>--disable-optimized</tt> option must be passed
1017     to <tt>configure</tt>.
1018     <br><br>
1019
1020     <dt>Release (Optimized) Builds
1021     <dd>
1022     These builds are enabled with the <tt>--enable-optimized</tt> option to
1023     <tt>configure</tt> or by specifying <tt>ENABLE_OPTIMIZED=1</tt> on the
1024     <tt>gmake</tt> command line.  For these builds, the build system will
1025     compile the tools and libraries with GCC optimizations enabled and strip
1026     debugging information from the libraries and executables it generates.
1027     Note that Release Builds are default when using an LLVM distribution.
1028     <br><br>
1029
1030     <dt>Profile Builds
1031     <dd>
1032     These builds are for use with profiling.  They compile profiling
1033     information into the code for use with programs like <tt>gprof</tt>.
1034     Profile builds must be started by specifying <tt>ENABLE_PROFILING=1</tt>
1035     on the <tt>gmake</tt> command line.
1036 </dl>
1037
1038 <p>Once you have LLVM configured, you can build it by entering the
1039 <i>OBJ_ROOT</i> directory and issuing the following command:</p>
1040
1041 <div class="doc_code"><pre>% gmake</pre></div>
1042
1043 <p>If the build fails, please <a href="#brokengcc">check here</a> to see if you
1044 are using a version of GCC that is known not to compile LLVM.</p>
1045
1046 <p>
1047 If you have multiple processors in your machine, you may wish to use some of
1048 the parallel build options provided by GNU Make.  For example, you could use the
1049 command:</p>
1050
1051 <div class="doc_code"><pre>% gmake -j2</pre></div>
1052
1053 <p>There are several special targets which are useful when working with the LLVM
1054 source code:</p>
1055
1056 <dl>
1057   <dt><tt>gmake clean</tt>
1058   <dd>
1059   Removes all files generated by the build.  This includes object files,
1060   generated C/C++ files, libraries, and executables.
1061   <br><br>
1062
1063   <dt><tt>gmake dist-clean</tt>
1064   <dd>
1065   Removes everything that <tt>gmake clean</tt> does, but also removes files
1066   generated by <tt>configure</tt>.  It attempts to return the source tree to the
1067   original state in which it was shipped.
1068   <br><br>
1069
1070   <dt><tt>gmake install</tt>
1071   <dd>
1072   Installs LLVM header files, libraries, tools, and documentation in a
1073   hierarchy
1074   under $PREFIX, specified with <tt>./configure --prefix=[dir]</tt>, which
1075   defaults to <tt>/usr/local</tt>.
1076   <br><br>
1077
1078   <dt><tt>gmake -C runtime install-bytecode</tt>
1079   <dd>
1080   Assuming you built LLVM into $OBJDIR, when this command is run, it will
1081   install bitcode libraries into the GCC front end's bitcode library
1082   directory.  If you need to update your bitcode libraries,
1083   this is the target to use once you've built them.
1084   <br><br>
1085 </dl>
1086
1087 <p>Please see the <a href="MakefileGuide.html">Makefile Guide</a> for further
1088 details on these <tt>make</tt> targets and descriptions of other targets
1089 available.</p>
1090
1091 <p>It is also possible to override default values from <tt>configure</tt> by
1092 declaring variables on the command line.  The following are some examples:</p>
1093
1094 <dl>
1095   <dt><tt>gmake ENABLE_OPTIMIZED=1</tt>
1096   <dd>
1097   Perform a Release (Optimized) build.
1098   <br><br>
1099
1100   <dt><tt>gmake ENABLE_OPTIMIZED=1 DISABLE_ASSERTIONS=1</tt>
1101   <dd>
1102   Perform a Release (Optimized) build without assertions enabled.
1103   <br><br>
1104
1105   <dt><tt>gmake ENABLE_OPTIMIZED=0</tt>
1106   <dd>
1107   Perform a Debug build.
1108   <br><br>
1109
1110   <dt><tt>gmake ENABLE_PROFILING=1</tt>
1111   <dd>
1112   Perform a Profiling build.
1113   <br><br>
1114
1115   <dt><tt>gmake VERBOSE=1</tt>
1116   <dd>
1117   Print what <tt>gmake</tt> is doing on standard output.
1118   <br><br>
1119
1120   <dt><tt>gmake TOOL_VERBOSE=1</tt></dt>
1121   <dd>Ask each tool invoked by the makefiles to print out what it is doing on
1122   the standard output. This also implies <tt>VERBOSE=1</tt>.
1123   <br><br></dd>
1124 </dl>
1125
1126 <p>Every directory in the LLVM object tree includes a <tt>Makefile</tt> to build
1127 it and any subdirectories that it contains.  Entering any directory inside the
1128 LLVM object tree and typing <tt>gmake</tt> should rebuild anything in or below
1129 that directory that is out of date.</p>
1130
1131 </div>
1132
1133 <!-- ======================================================================= -->
1134 <div class="doc_subsection">
1135   <a name="cross-compile">Cross-Compiling LLVM</a>
1136 </div>
1137
1138 <div class="doc_text">
1139   <p>It is possible to cross-compile LLVM itself. That is, you can create LLVM
1140   executables and libraries to be hosted on a platform different from the
1141   platform where they are build (a Canadian Cross build). To configure a
1142   cross-compile, supply the configure script with <tt>--build</tt> and
1143   <tt>--host</tt> options that are different. The values of these options must
1144   be legal target triples that your GCC compiler supports.</p>
1145
1146   <p>The result of such a build is executables that are not runnable on
1147   on the build host (--build option) but can be executed on the compile host
1148   (--host option).</p>
1149 </div>
1150
1151 <!-- ======================================================================= -->
1152 <div class="doc_subsection">
1153   <a name="objfiles">The Location of LLVM Object Files</a>
1154 </div>
1155
1156 <div class="doc_text">
1157
1158 <p>The LLVM build system is capable of sharing a single LLVM source tree among
1159 several LLVM builds.  Hence, it is possible to build LLVM for several different
1160 platforms or configurations using the same source tree.</p>
1161
1162 <p>This is accomplished in the typical autoconf manner:</p>
1163
1164 <ul>
1165   <li><p>Change directory to where the LLVM object files should live:</p>
1166
1167       <div class="doc_code"><pre>% cd <i>OBJ_ROOT</i></pre></div></li>
1168
1169   <li><p>Run the <tt>configure</tt> script found in the LLVM source
1170       directory:</p>
1171
1172       <div class="doc_code"><pre>% <i>SRC_ROOT</i>/configure</pre></div></li>
1173 </ul>
1174
1175 <p>The LLVM build will place files underneath <i>OBJ_ROOT</i> in directories
1176 named after the build type:</p>
1177
1178 <dl>
1179   <dt>Debug Builds with assertions enabled (the default)
1180   <dd>
1181   <dl>
1182     <dt>Tools
1183     <dd><tt><i>OBJ_ROOT</i>/Debug+Asserts/bin</tt>
1184     <dt>Libraries
1185     <dd><tt><i>OBJ_ROOT</i>/Debug+Asserts/lib</tt>
1186   </dl>
1187   <br><br>
1188
1189   <dt>Release Builds
1190   <dd>
1191   <dl>
1192     <dt>Tools
1193     <dd><tt><i>OBJ_ROOT</i>/Release/bin</tt>
1194     <dt>Libraries
1195     <dd><tt><i>OBJ_ROOT</i>/Release/lib</tt>
1196   </dl>
1197   <br><br>
1198
1199   <dt>Profile Builds
1200   <dd>
1201   <dl>
1202     <dt>Tools
1203     <dd><tt><i>OBJ_ROOT</i>/Profile/bin</tt>
1204     <dt>Libraries
1205     <dd><tt><i>OBJ_ROOT</i>/Profile/lib</tt>
1206   </dl>
1207 </dl>
1208
1209 </div>
1210
1211 <!-- ======================================================================= -->
1212 <div class="doc_subsection">
1213   <a name="optionalconfig">Optional Configuration Items</a>
1214 </div>
1215
1216 <div class="doc_text">
1217
1218 <p>
1219 If you're running on a Linux system that supports the "<a
1220 href="http://www.tat.physik.uni-tuebingen.de/~rguenth/linux/binfmt_misc.html">binfmt_misc</a>"
1221 module, and you have root access on the system, you can set your system up to
1222 execute LLVM bitcode files directly. To do this, use commands like this (the
1223 first command may not be required if you are already using the module):</p>
1224
1225 <div class="doc_code">
1226 <pre>
1227 $ mount -t binfmt_misc none /proc/sys/fs/binfmt_misc
1228 $ echo ':llvm:M::BC::/path/to/lli:' &gt; /proc/sys/fs/binfmt_misc/register
1229 $ chmod u+x hello.bc   (if needed)
1230 $ ./hello.bc
1231 </pre>
1232 </div>
1233
1234 <p>
1235 This allows you to execute LLVM bitcode files directly.  On Debian, you
1236 can also use this command instead of the 'echo' command above:</p>
1237 </p>
1238
1239 <div class="doc_code">
1240 <pre>
1241 $ sudo update-binfmts --install llvm /path/to/lli --magic 'BC'
1242 </pre>
1243 </div>
1244
1245 </div>
1246
1247 <!-- *********************************************************************** -->
1248 <div class="doc_section">
1249   <a name="layout"><b>Program Layout</b></a>
1250 </div>
1251 <!-- *********************************************************************** -->
1252
1253 <div class="doc_text">
1254
1255 <p>One useful source of information about the LLVM source base is the LLVM <a
1256 href="http://www.doxygen.org">doxygen</a> documentation available at <tt><a
1257 href="http://llvm.org/doxygen/">http://llvm.org/doxygen/</a></tt>.
1258 The following is a brief introduction to code layout:</p>
1259
1260 </div>
1261
1262 <!-- ======================================================================= -->
1263 <div class="doc_subsection"><a name="examples"><tt>llvm/examples</tt></a></div>
1264 <div class="doc_text">
1265   <p>This directory contains some simple examples of how to use the LLVM IR and
1266   JIT.</p>
1267 </div>
1268
1269 <!-- ======================================================================= -->
1270 <div class="doc_subsection"><a name="include"><tt>llvm/include</tt></a></div>
1271 <div class="doc_text">
1272
1273 <p>This directory contains public header files exported from the LLVM
1274 library. The three main subdirectories of this directory are:</p>
1275
1276 <dl>
1277   <dt><tt><b>llvm/include/llvm</b></tt></dt>
1278   <dd>This directory contains all of the LLVM specific header files.  This
1279   directory also has subdirectories for different portions of LLVM:
1280   <tt>Analysis</tt>, <tt>CodeGen</tt>, <tt>Target</tt>, <tt>Transforms</tt>,
1281   etc...</dd>
1282
1283   <dt><tt><b>llvm/include/llvm/Support</b></tt></dt>
1284   <dd>This directory contains generic support libraries that are provided with
1285   LLVM but not necessarily specific to LLVM. For example, some C++ STL utilities
1286   and a Command Line option processing library store their header files here.
1287   </dd>
1288
1289   <dt><tt><b>llvm/include/llvm/Config</b></tt></dt>
1290   <dd>This directory contains header files configured by the <tt>configure</tt>
1291   script.  They wrap "standard" UNIX and C header files.  Source code can
1292   include these header files which automatically take care of the conditional
1293   #includes that the <tt>configure</tt> script generates.</dd>
1294 </dl>
1295 </div>
1296
1297 <!-- ======================================================================= -->
1298 <div class="doc_subsection"><a name="lib"><tt>llvm/lib</tt></a></div>
1299 <div class="doc_text">
1300
1301 <p>This directory contains most of the source files of the LLVM system. In LLVM,
1302 almost all code exists in libraries, making it very easy to share code among the
1303 different <a href="#tools">tools</a>.</p>
1304
1305 <dl>
1306   <dt><tt><b>llvm/lib/VMCore/</b></tt></dt>
1307   <dd> This directory holds the core LLVM source files that implement core
1308   classes like Instruction and BasicBlock.</dd>
1309
1310   <dt><tt><b>llvm/lib/AsmParser/</b></tt></dt>
1311   <dd>This directory holds the source code for the LLVM assembly language parser
1312   library.</dd>
1313
1314   <dt><tt><b>llvm/lib/BitCode/</b></tt></dt>
1315   <dd>This directory holds code for reading and write LLVM bitcode.</dd>
1316
1317   <dt><tt><b>llvm/lib/Analysis/</b></tt><dd>This directory contains a variety of
1318   different program analyses, such as Dominator Information, Call Graphs,
1319   Induction Variables, Interval Identification, Natural Loop Identification,
1320   etc.</dd>
1321
1322   <dt><tt><b>llvm/lib/Transforms/</b></tt></dt>
1323   <dd> This directory contains the source code for the LLVM to LLVM program
1324   transformations, such as Aggressive Dead Code Elimination, Sparse Conditional
1325   Constant Propagation, Inlining, Loop Invariant Code Motion, Dead Global
1326   Elimination, and many others.</dd>
1327
1328   <dt><tt><b>llvm/lib/Target/</b></tt></dt>
1329   <dd> This directory contains files that describe various target architectures
1330   for code generation.  For example, the <tt>llvm/lib/Target/X86</tt>
1331   directory holds the X86 machine description while
1332   <tt>llvm/lib/Target/CBackend</tt> implements the LLVM-to-C converter.</dd>
1333
1334   <dt><tt><b>llvm/lib/CodeGen/</b></tt></dt>
1335   <dd> This directory contains the major parts of the code generator: Instruction
1336   Selector, Instruction Scheduling, and Register Allocation.</dd>
1337
1338   <dt><tt><b>llvm/lib/Debugger/</b></tt></dt>
1339   <dd> This directory contains the source level debugger library that makes
1340   it possible to instrument LLVM programs so that a debugger could identify
1341   source code locations at which the program is executing.</dd>
1342
1343   <dt><tt><b>llvm/lib/ExecutionEngine/</b></tt></dt>
1344   <dd> This directory contains libraries for executing LLVM bitcode directly
1345   at runtime in both interpreted and JIT compiled fashions.</dd>
1346
1347   <dt><tt><b>llvm/lib/Support/</b></tt></dt>
1348   <dd> This directory contains the source code that corresponds to the header
1349   files located in <tt>llvm/include/Support/</tt>.</dd>
1350
1351   <dt><tt><b>llvm/lib/System/</b></tt></dt>
1352   <dd>This directory contains the operating system abstraction layer that
1353   shields LLVM from platform-specific coding.</dd>
1354 </dl>
1355
1356 </div>
1357
1358 <!-- ======================================================================= -->
1359 <div class="doc_subsection"><a name="projects"><tt>llvm/projects</tt></a></div>
1360 <div class="doc_text">
1361   <p>This directory contains projects that are not strictly part of LLVM but are
1362   shipped with LLVM. This is also the directory where you should create your own
1363   LLVM-based projects. See <tt>llvm/projects/sample</tt> for an example of how
1364   to set up your own project.</p>
1365 </div>
1366
1367 <!-- ======================================================================= -->
1368 <div class="doc_subsection"><a name="runtime"><tt>llvm/runtime</tt></a></div>
1369 <div class="doc_text">
1370
1371 <p>This directory contains libraries which are compiled into LLVM bitcode and
1372 used when linking programs with the GCC front end.  Most of these libraries are
1373 skeleton versions of real libraries; for example, libc is a stripped down
1374 version of glibc.</p>
1375
1376 <p>Unlike the rest of the LLVM suite, this directory needs the LLVM GCC front
1377 end to compile.</p>
1378
1379 </div>
1380
1381 <!-- ======================================================================= -->
1382 <div class="doc_subsection"><a name="test"><tt>llvm/test</tt></a></div>
1383 <div class="doc_text">
1384   <p>This directory contains feature and regression tests and other basic sanity
1385   checks on the LLVM infrastructure. These are intended to run quickly and cover
1386   a lot of territory without being exhaustive.</p>
1387 </div>
1388
1389 <!-- ======================================================================= -->
1390 <div class="doc_subsection"><a name="test-suite"><tt>test-suite</tt></a></div>
1391 <div class="doc_text">
1392   <p>This is not a directory in the normal llvm module; it is a separate
1393   Subversion
1394   module that must be checked out (usually to <tt>projects/test-suite</tt>).
1395   This
1396   module contains a comprehensive correctness, performance, and benchmarking
1397   test
1398   suite for LLVM. It is a separate Subversion module because not every LLVM
1399   user is
1400   interested in downloading or building such a comprehensive test suite. For
1401   further details on this test suite, please see the
1402   <a href="TestingGuide.html">Testing Guide</a> document.</p>
1403 </div>
1404
1405 <!-- ======================================================================= -->
1406 <div class="doc_subsection"><a name="tools"><tt>llvm/tools</tt></a></div>
1407 <div class="doc_text">
1408
1409 <p>The <b>tools</b> directory contains the executables built out of the
1410 libraries above, which form the main part of the user interface.  You can
1411 always get help for a tool by typing <tt>tool_name -help</tt>.  The
1412 following is a brief introduction to the most important tools.  More detailed
1413 information is in the <a href="CommandGuide/index.html">Command Guide</a>.</p>
1414
1415 <dl>
1416
1417   <dt><tt><b>bugpoint</b></tt></dt>
1418   <dd><tt>bugpoint</tt> is used to debug
1419   optimization passes or code generation backends by narrowing down the
1420   given test case to the minimum number of passes and/or instructions that
1421   still cause a problem, whether it is a crash or miscompilation. See <a
1422   href="HowToSubmitABug.html">HowToSubmitABug.html</a> for more information
1423   on using <tt>bugpoint</tt>.</dd>
1424
1425   <dt><tt><b>llvmc</b></tt></dt>
1426   <dd>The LLVM Compiler Driver. This program can
1427   be configured to utilize both LLVM and non-LLVM compilation tools to enable
1428   pre-processing, translation, optimization, assembly, and linking of programs
1429   all from one command line. <tt>llvmc</tt> also takes care of processing the
1430   dependent libraries found in bitcode. This reduces the need to get the
1431   traditional <tt>-l&lt;name&gt;</tt> options right on the command line. Please
1432   note that this tool, while functional, is still experimental and not feature
1433   complete.</dd>
1434
1435   <dt><tt><b>llvm-ar</b></tt></dt>
1436   <dd>The archiver produces an archive containing
1437   the given LLVM bitcode files, optionally with an index for faster
1438   lookup.</dd>
1439
1440   <dt><tt><b>llvm-as</b></tt></dt>
1441   <dd>The assembler transforms the human readable LLVM assembly to LLVM
1442   bitcode.</dd>
1443
1444   <dt><tt><b>llvm-dis</b></tt></dt>
1445   <dd>The disassembler transforms the LLVM bitcode to human readable
1446   LLVM assembly.</dd>
1447
1448   <dt><tt><b>llvm-ld</b></tt></dt>
1449   <dd><tt>llvm-ld</tt> is a general purpose and extensible linker for LLVM.
1450   This is the linker invoked by <tt>llvmc</tt>. It performs standard link time
1451   optimizations and allows optimization modules to be loaded and run so that
1452   language specific optimizations can be applied at link time.</dd>
1453
1454   <dt><tt><b>llvm-link</b></tt></dt>
1455   <dd><tt>llvm-link</tt>, not surprisingly, links multiple LLVM modules into
1456   a single program.</dd>
1457
1458   <dt><tt><b>lli</b></tt></dt>
1459   <dd><tt>lli</tt> is the LLVM interpreter, which
1460   can directly execute LLVM bitcode (although very slowly...). For architectures
1461   that support it (currently x86, Sparc, and PowerPC), by default, <tt>lli</tt>
1462   will function as a Just-In-Time compiler (if the functionality was compiled
1463   in), and will execute the code <i>much</i> faster than the interpreter.</dd>
1464
1465   <dt><tt><b>llc</b></tt></dt>
1466   <dd> <tt>llc</tt> is the LLVM backend compiler, which
1467   translates LLVM bitcode to a native code assembly file or to C code (with
1468   the -march=c option).</dd>
1469
1470   <dt><tt><b>llvm-gcc</b></tt></dt>
1471   <dd><tt>llvm-gcc</tt> is a GCC-based C frontend that has been retargeted to
1472   use LLVM as its backend instead of GCC's RTL backend. It can also emit LLVM
1473   bitcode or assembly (with the <tt>-emit-llvm</tt> option) instead of the
1474   usual machine code output.  It works just like any other GCC compiler,
1475   taking the typical <tt>-c, -S, -E, -o</tt> options that are typically used.
1476   Additionally, the the source code for <tt>llvm-gcc</tt> is available as a
1477   separate Subversion module.</dd>
1478
1479   <dt><tt><b>opt</b></tt></dt>
1480   <dd><tt>opt</tt> reads LLVM bitcode, applies a series of LLVM to LLVM
1481   transformations (which are specified on the command line), and then outputs
1482   the resultant bitcode.  The '<tt>opt -help</tt>' command is a good way to
1483   get a list of the program transformations available in LLVM.<br>
1484   <dd><tt>opt</tt> can also be used to run a specific analysis on an input
1485   LLVM bitcode file and print out the results.  It is primarily useful for
1486   debugging analyses, or familiarizing yourself with what an analysis does.</dd>
1487 </dl>
1488 </div>
1489
1490 <!-- ======================================================================= -->
1491 <div class="doc_subsection"><a name="utils"><tt>llvm/utils</tt></a></div>
1492 <div class="doc_text">
1493
1494 <p>This directory contains utilities for working with LLVM source code, and some
1495 of the utilities are actually required as part of the build process because they
1496 are code generators for parts of LLVM infrastructure.</p>
1497
1498 <dl>
1499   <dt><tt><b>codegen-diff</b></tt> <dd><tt>codegen-diff</tt> is a script
1500   that finds differences between code that LLC generates and code that LLI
1501   generates. This is a useful tool if you are debugging one of them,
1502   assuming that the other generates correct output. For the full user
1503   manual, run <tt>`perldoc codegen-diff'</tt>.<br><br>
1504
1505   <dt><tt><b>emacs/</b></tt> <dd>The <tt>emacs</tt> directory contains
1506   syntax-highlighting files which will work with Emacs and XEmacs editors,
1507   providing syntax highlighting support for LLVM assembly files and TableGen
1508   description files. For information on how to use the syntax files, consult
1509   the <tt>README</tt> file in that directory.<br><br>
1510
1511   <dt><tt><b>getsrcs.sh</b></tt> <dd>The <tt>getsrcs.sh</tt> script finds
1512   and outputs all non-generated source files, which is useful if one wishes
1513   to do a lot of development across directories and does not want to
1514   individually find each file. One way to use it is to run, for example:
1515   <tt>xemacs `utils/getsources.sh`</tt> from the top of your LLVM source
1516   tree.<br><br>
1517
1518   <dt><tt><b>llvmgrep</b></tt></dt>
1519   <dd>This little tool performs an "egrep -H -n" on each source file in LLVM and
1520   passes to it a regular expression provided on <tt>llvmgrep</tt>'s command
1521   line. This is a very efficient way of searching the source base for a
1522   particular regular expression.</dd>
1523
1524   <dt><tt><b>makellvm</b></tt> <dd>The <tt>makellvm</tt> script compiles all
1525   files in the current directory and then compiles and links the tool that
1526   is the first argument. For example, assuming you are in the directory
1527   <tt>llvm/lib/Target/Sparc</tt>, if <tt>makellvm</tt> is in your path,
1528   simply running <tt>makellvm llc</tt> will make a build of the current
1529   directory, switch to directory <tt>llvm/tools/llc</tt> and build it,
1530   causing a re-linking of LLC.<br><br>
1531
1532   <dt><tt><b>NewNightlyTest.pl</b></tt> and
1533   <tt><b>NightlyTestTemplate.html</b></tt> <dd>These files are used in a
1534   cron script to generate nightly status reports of the functionality of
1535   tools, and the results can be seen by following the appropriate link on
1536   the <a href="http://llvm.org/">LLVM homepage</a>.<br><br>
1537
1538   <dt><tt><b>TableGen/</b></tt> <dd>The <tt>TableGen</tt> directory contains
1539   the tool used to generate register descriptions, instruction set
1540   descriptions, and even assemblers from common TableGen description
1541   files.<br><br>
1542
1543   <dt><tt><b>vim/</b></tt> <dd>The <tt>vim</tt> directory contains
1544   syntax-highlighting files which will work with the VIM editor, providing
1545   syntax highlighting support for LLVM assembly files and TableGen
1546   description files. For information on how to use the syntax files, consult
1547   the <tt>README</tt> file in that directory.<br><br>
1548
1549 </dl>
1550
1551 </div>
1552
1553 <!-- *********************************************************************** -->
1554 <div class="doc_section">
1555   <a name="tutorial">An Example Using the LLVM Tool Chain</a>
1556 </div>
1557 <!-- *********************************************************************** -->
1558
1559 <div class="doc_text">
1560 <p>This section gives an example of using LLVM.  llvm-gcc3 is now obsolete,
1561 so we only include instructions for llvm-gcc4.
1562 </p>
1563
1564 <p><b>Note:</b> The <i>gcc4</i> frontend's invocation is <b><i>considerably different</i></b>
1565 from the previous <i>gcc3</i> frontend. In particular, the <i>gcc4</i> frontend <b><i>does not</i></b>
1566 create bitcode by default: <i>gcc4</i> produces native code. As the example below illustrates,
1567 the '--emit-llvm' flag is needed to produce LLVM bitcode output. For <i>makefiles</i> and
1568 <i>configure</i> scripts, the CFLAGS variable needs '--emit-llvm' to produce bitcode
1569 output.</p>
1570 </div>
1571
1572 <!-- ======================================================================= -->
1573 <div class="doc_subsection"><a name="tutorial4">Example with llvm-gcc4</a></div>
1574
1575 <div class="doc_text">
1576
1577 <ol>
1578   <li><p>First, create a simple C file, name it 'hello.c':</p>
1579
1580 <div class="doc_code">
1581 <pre>
1582 #include &lt;stdio.h&gt;
1583
1584 int main() {
1585   printf("hello world\n");
1586   return 0;
1587 }
1588 </pre></div></li>
1589
1590   <li><p>Next, compile the C file into a native executable:</p>
1591
1592       <div class="doc_code"><pre>% llvm-gcc hello.c -o hello</pre></div>
1593
1594       <p>Note that llvm-gcc works just like GCC by default.  The standard -S and
1595         -c arguments work as usual (producing a native .s or .o file,
1596         respectively).</p></li>
1597
1598   <li><p>Next, compile the C file into a LLVM bitcode file:</p>
1599
1600       <div class="doc_code">
1601       <pre>% llvm-gcc -O3 -emit-llvm hello.c -c -o hello.bc</pre></div>
1602
1603       <p>The -emit-llvm option can be used with the -S or -c options to emit an
1604          LLVM ".ll" or ".bc" file (respectively) for the code.  This allows you
1605          to use the <a href="CommandGuide/index.html">standard LLVM tools</a> on
1606          the bitcode file.</p>
1607
1608       <p>Unlike llvm-gcc3, llvm-gcc4 correctly responds to -O[0123] arguments.
1609          </p></li>
1610
1611   <li><p>Run the program in both forms. To run the program, use:</p>
1612
1613       <div class="doc_code"><pre>% ./hello</pre></div>
1614
1615       <p>and</p>
1616
1617       <div class="doc_code"><pre>% lli hello.bc</pre></div>
1618
1619       <p>The second examples shows how to invoke the LLVM JIT, <a
1620        href="CommandGuide/html/lli.html">lli</a>.</p></li>
1621
1622   <li><p>Use the <tt>llvm-dis</tt> utility to take a look at the LLVM assembly
1623       code:</p>
1624
1625 <div class="doc_code">
1626 <pre>llvm-dis &lt; hello.bc | less</pre>
1627 </div></li>
1628
1629   <li><p>Compile the program to native assembly using the LLC code
1630       generator:</p>
1631
1632       <div class="doc_code"><pre>% llc hello.bc -o hello.s</pre></div></li>
1633
1634   <li><p>Assemble the native assembly language file into a program:</p>
1635
1636 <div class="doc_code">
1637 <pre>
1638 <b>Solaris:</b> % /opt/SUNWspro/bin/cc -xarch=v9 hello.s -o hello.native
1639
1640 <b>Others:</b>  % gcc hello.s -o hello.native
1641 </pre>
1642 </div></li>
1643
1644   <li><p>Execute the native code program:</p>
1645
1646       <div class="doc_code"><pre>% ./hello.native</pre></div>
1647
1648       <p>Note that using llvm-gcc to compile directly to native code (i.e. when
1649          the -emit-llvm option is not present) does steps 6/7/8 for you.</p>
1650         </li>
1651
1652 </ol>
1653
1654 </div>
1655
1656
1657 <!-- *********************************************************************** -->
1658 <div class="doc_section">
1659   <a name="problems">Common Problems</a>
1660 </div>
1661 <!-- *********************************************************************** -->
1662
1663 <div class="doc_text">
1664
1665 <p>If you are having problems building or using LLVM, or if you have any other
1666 general questions about LLVM, please consult the <a href="FAQ.html">Frequently
1667 Asked Questions</a> page.</p>
1668
1669 </div>
1670
1671 <!-- *********************************************************************** -->
1672 <div class="doc_section">
1673   <a name="links">Links</a>
1674 </div>
1675 <!-- *********************************************************************** -->
1676
1677 <div class="doc_text">
1678
1679 <p>This document is just an <b>introduction</b> on how to use LLVM to do
1680 some simple things... there are many more interesting and complicated things
1681 that you can do that aren't documented here (but we'll gladly accept a patch
1682 if you want to write something up!).  For more information about LLVM, check
1683 out:</p>
1684
1685 <ul>
1686   <li><a href="http://llvm.org/">LLVM homepage</a></li>
1687   <li><a href="http://llvm.org/doxygen/">LLVM doxygen tree</a></li>
1688   <li><a href="http://llvm.org/docs/Projects.html">Starting a Project
1689   that Uses LLVM</a></li>
1690 </ul>
1691
1692 </div>
1693
1694 <!-- *********************************************************************** -->
1695
1696 <hr>
1697 <address>
1698   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
1699   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
1700   <a href="http://validator.w3.org/check/referer"><img
1701   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
1702
1703   <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
1704   <a href="http://llvm.x10sys.com/rspencer/">Reid Spencer</a><br>
1705   <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br>
1706   Last modified: $Date$
1707 </address>
1708 </body>
1709 </html>