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.8: <b>RELEASE_28</b></li>
 747 <li>Release 2.7: <b>RELEASE_27</b></li>
 748 <li>Release 2.6: <b>RELEASE_26</b></li>
 749 <li>Release 2.5: <b>RELEASE_25</b></li>
 750 <li>Release 2.4: <b>RELEASE_24</b></li>
 751 <li>Release 2.3: <b>RELEASE_23</b></li>
 752 <li>Release 2.2: <b>RELEASE_22</b></li>
 753 <li>Release 2.1: <b>RELEASE_21</b></li>
 754 <li>Release 2.0: <b>RELEASE_20</b></li>
 755 <li>Release 1.9: <b>RELEASE_19</b></li>
 756 <li>Release 1.8: <b>RELEASE_18</b></li>
 757 <li>Release 1.7: <b>RELEASE_17</b></li>
 758 <li>Release 1.6: <b>RELEASE_16</b></li>
 759 <li>Release 1.5: <b>RELEASE_15</b></li>
 760 <li>Release 1.4: <b>RELEASE_14</b></li>
 761 <li>Release 1.3: <b>RELEASE_13</b></li>
 762 <li>Release 1.2: <b>RELEASE_12</b></li>
 763 <li>Release 1.1: <b>RELEASE_11</b></li>
 764 <li>Release 1.0: <b>RELEASE_1</b></li>
 765 </ul>
 766
 767 <p>If you would like to get the LLVM test suite (a separate package as of 1.4),
 768 you get it from the Subversion repository:</p>
 769
 770 <div class="doc_code">
 771 <pre>
 772 % cd llvm/projects
 773 % svn co http://llvm.org/svn/llvm-project/test-suite/trunk test-suite
 774 </pre>
 775 </div>
 776
 777 <p>By placing it in the <tt>llvm/projects</tt>, it will be automatically
 778 configured by the LLVM configure script as well as automatically updated when
 779 you run <tt>svn update</tt>.</p>
 780
 781 <p>If you would like to get the GCC front end source code, you can also get it
 782 and build it yourself.  Please follow <a href="GCCFEBuildInstrs.html">these
 783 instructions</a> to successfully get and build the LLVM GCC front-end.</p>
 784
 785 </div>
 786
 787 <!-- ======================================================================= -->
 788 <div class="doc_subsection">
 789   <a name="git_mirror">GIT mirror</a>
 790 </div>
 791
 792 <div class="doc_text">
 793
 794 <p>GIT mirrors are available for a number of LLVM subprojects. These mirrors
 795   sync automatically with each Subversion commit and contain all necessary
 796   git-svn marks (so, you can recreate git-svn metadata locally). Note that right
 797   now mirrors reflect only <tt>trunk</tt> for each project. You can do the
 798   read-only GIT clone of LLVM via:
 799 <pre>
 800 % git clone http://llvm.org/git/llvm.git
 801 </pre>
 802 </p>
 803
 804 </div>
 805
 806 <!-- ======================================================================= -->
 807 <div class="doc_subsection">
 808   <a name="installcf">Install the GCC Front End</a>
 809 </div>
 810
 811 <div class="doc_text">
 812
 813 <p>Before configuring and compiling the LLVM suite (or if you want to use just the LLVM
 814 GCC front end) you can optionally extract the front end from the binary distribution.
 815 It is used for running the LLVM test-suite and for compiling C/C++ programs.  Note that
 816 you can optionally <a href="GCCFEBuildInstrs.html">build llvm-gcc yourself</a> after building the
 817 main LLVM repository.</p>
 818
 819 <p>To install the GCC front end, do the following (on Windows, use an archival tool
 820 like <a href="http://www.7-zip.org">7-zip</a> that understands gzipped tars):</p>
 821
 822 <ol>
 823   <li><tt>cd <i>where-you-want-the-front-end-to-live</i></tt></li>
 824   <li><tt>gunzip --stdout llvm-gcc-4.2-<i>version</i>-<i>platform</i>.tar.gz | tar -xvf
 825       -</tt></li>
 826 </ol>
 827
 828 <p>Once the binary is uncompressed, if you're using a *nix-based system, add a symlink for
 829 <tt>llvm-gcc</tt> and <tt>llvm-g++</tt> to some directory in your path.  If you're using a
 830 Windows-based system, add the <tt>bin</tt> subdirectory of your front end installation directory
 831 to your <tt>PATH</tt> environment variable.  For example, if you uncompressed the binary to
 832 <tt>c:\llvm-gcc</tt>, add <tt>c:\llvm-gcc\bin</tt> to your <tt>PATH</tt>.</p>
 833
 834 <p>If you now want to build LLVM from source, when you configure LLVM, it will
 835 automatically detect <tt>llvm-gcc</tt>'s presence (if it is in your path) enabling its
 836 use in test-suite.  Note that you can always build or install <tt>llvm-gcc</tt> at any
 837 point after building the main LLVM repository: just reconfigure llvm and
 838 test-suite will pick it up.
 839 </p>
 840
 841 <p>As a convenience for Windows users, the front end binaries for MinGW/x86 include
 842 versions of the required w32api and mingw-runtime binaries.  The last remaining step for
 843 Windows users is to simply uncompress the binary binutils package from
 844 <a href="http://mingw.org/">MinGW</a> into your front end installation directory.  While the
 845 front end installation steps are not quite the same as a typical manual MinGW installation,
 846 they should be similar enough to those who have previously installed MinGW on Windows systems.</p>
 847
 848 <p>To install binutils on Windows:</p>
 849
 850 <ol>
 851   <li><tt><i>download GNU Binutils from <a href="http://sourceforge.net/projects/mingw/files/">MinGW Downloads</a></i></tt></li>
 852   <li><tt>cd <i>where-you-uncompressed-the-front-end</i></tt></li>
 853   <li><tt><i>uncompress archived binutils directories (not the tar file) into the current directory</i></tt></li>
 854 </ol>
 855
 856 <p>The binary versions of the LLVM GCC front end may not suit all of your needs.  For
 857 example, the binary distribution may include an old version of a system header
 858 file, not "fix" a header file that needs to be fixed for GCC, or it may be linked with
 859 libraries not available on your system.  In cases like these, you may want to try
 860 <a href="GCCFEBuildInstrs.html">building the GCC front end from source</a>.  Thankfully,
 861 this is much easier now than it was in the past.</p>
 862
 863 <p>We also do not currently support updating of the GCC front end by manually overlaying
 864 newer versions of the w32api and mingw-runtime binary packages that may become available
 865 from MinGW.  At this time, it's best to think of the MinGW LLVM GCC front end binary as
 866 a self-contained convenience package that requires Windows users to simply download and
 867 uncompress the GNU Binutils binary package from the MinGW project.</p>
 868
 869 <p>Regardless of your platform, if you discover that installing the LLVM GCC front end
 870 binaries is not as easy as previously described, or you would like to suggest improvements,
 871 please let us know how you would like to see things improved by dropping us a note on our
 872 <a href="http://llvm.org/docs/#maillist">mailing list</a>.</p>
 873
 874 </div>
 875
 876 <!-- ======================================================================= -->
 877 <div class="doc_subsection">
 878   <a name="config">Local LLVM Configuration</a>
 879 </div>
 880
 881 <div class="doc_text">
 882
 883   <p>Once checked out from the Subversion repository, the LLVM suite source
 884   code must be
 885 configured via the <tt>configure</tt> script.  This script sets variables in the
 886 various <tt>*.in</tt> files, most notably <tt>llvm/Makefile.config</tt> and
 887 <tt>llvm/include/Config/config.h</tt>.  It also populates <i>OBJ_ROOT</i> with
 888 the Makefiles needed to begin building LLVM.</p>
 889
 890 <p>The following environment variables are used by the <tt>configure</tt>
 891 script to configure the build system:</p>
 892
 893 <table summary="LLVM configure script environment variables">
 894   <tr><th>Variable</th><th>Purpose</th></tr>
 895   <tr>
 896     <td>CC</td>
 897     <td>Tells <tt>configure</tt> which C compiler to use.  By default,
 898         <tt>configure</tt> will look for the first GCC C compiler in
 899         <tt>PATH</tt>.  Use this variable to override
 900         <tt>configure</tt>'s default behavior.</td>
 901   </tr>
 902   <tr>
 903     <td>CXX</td>
 904     <td>Tells <tt>configure</tt> which C++ compiler to use.  By default,
 905        <tt>configure</tt> will look for the first GCC C++ compiler in
 906        <tt>PATH</tt>.  Use this variable to override
 907        <tt>configure</tt>'s default behavior.</td>
 908   </tr>
 909 </table>
 910
 911 <p>The following options can be used to set or enable LLVM specific options:</p>
 912
 913 <dl>
 914   <dt><i>--with-llvmgccdir</i></dt>
 915   <dd>Path to the LLVM C/C++ FrontEnd to be used with this LLVM configuration.
 916   The value of this option should specify the full pathname of the C/C++ Front
 917   End to be used. If this option is not provided, the PATH will be searched for
 918   a program named <i>llvm-gcc</i> and the C/C++ FrontEnd install directory will
 919   be inferred from the path found. If the option is not given, and no llvm-gcc
 920   can be found in the path then a warning will be produced by
 921   <tt>configure</tt> indicating this situation. LLVM may still be built with
 922   the <tt>tools-only</tt> target but attempting to build the runtime libraries
 923   will fail as these libraries require llvm-gcc and llvm-g++. See
 924   <a href="#installcf">Install the GCC Front End</a> for details on installing
 925   the C/C++ Front End. See
 926   <a href="GCCFEBuildInstrs.html">Bootstrapping the LLVM C/C++ Front-End</a>
 927   for details on building the C/C++ Front End.</dd>
 928   <dt><i>--with-tclinclude</i></dt>
 929   <dd>Path to the tcl include directory under which <tt>tclsh</tt> can be
 930   found. Use this if you have multiple tcl installations on your machine and you
 931   want to use a specific one (8.x) for LLVM. LLVM only uses tcl for running the
 932   dejagnu based test suite in <tt>llvm/test</tt>. If you don't specify this
 933   option, the LLVM configure script will search for the tcl 8.4 and 8.3
 934   releases.
 935   <br><br>
 936   </dd>
 937   <dt><i>--enable-optimized</i></dt>
 938   <dd>
 939     Enables optimized compilation (debugging symbols are removed
 940     and GCC optimization flags are enabled). Note that this is the default
 941     setting     if you are using the LLVM distribution. The default behavior
 942     of an Subversion checkout is to use an unoptimized build (also known as a
 943     debug build).
 944     <br><br>
 945   </dd>
 946   <dt><i>--enable-debug-runtime</i></dt>
 947   <dd>
 948     Enables debug symbols in the runtime libraries. The default is to strip
 949     debug symbols from the runtime libraries.
 950   </dd>
 951   <dt><i>--enable-jit</i></dt>
 952   <dd>
 953     Compile the Just In Time (JIT) compiler functionality.  This is not
 954     available
 955     on all platforms.  The default is dependent on platform, so it is best
 956     to explicitly enable it if you want it.
 957     <br><br>
 958   </dd>
 959   <dt><i>--enable-targets=</i><tt>target-option</tt></dt>
 960   <dd>Controls which targets will be built and linked into llc. The default
 961   value for <tt>target_options</tt> is "all" which builds and links all
 962   available targets.  The value "host-only" can be specified to build only a
 963   native compiler (no cross-compiler targets available). The "native" target is
 964   selected as the target of the build host. You can also specify a comma
 965   separated list of target names that you want available in llc. The target
 966   names use all lower case. The current set of targets is: <br>
 967   <tt>alpha, ia64, powerpc, skeleton, sparc, x86</tt>.
 968   <br><br></dd>
 969   <dt><i>--enable-doxygen</i></dt>
 970   <dd>Look for the doxygen program and enable construction of doxygen based
 971   documentation from the source code. This is disabled by default because
 972   generating the documentation can take a long time and producess 100s of
 973   megabytes of output.</dd>
 974   <dt><i>--with-udis86</i></dt>
 975   <dd>LLVM can use external disassembler library for various purposes (now it's
 976   used only for examining code produced by JIT). This option will enable usage
 977   of <a href="http://udis86.sourceforge.net/">udis86</a> x86 (both 32 and 64
 978   bits) disassembler library.</dd>
 979 </dl>
 980
 981 <p>To configure LLVM, follow these steps:</p>
 982
 983 <ol>
 984     <li><p>Change directory into the object root directory:</p>
 985
 986     <div class="doc_code"><pre>% cd <i>OBJ_ROOT</i></pre></div></li>
 987
 988     <li><p>Run the <tt>configure</tt> script located in the LLVM source
 989     tree:</p>
 990
 991     <div class="doc_code">
 992     <pre>% <i>SRC_ROOT</i>/configure --prefix=/install/path [other options]</pre>
 993     </div></li>
 994 </ol>
 995
 996 </div>
 997
 998 <!-- ======================================================================= -->
 999 <div class="doc_subsection">
1000   <a name="compile">Compiling the LLVM Suite Source Code</a>
1001 </div>
1002
1003 <div class="doc_text">
1004
1005 <p>Once you have configured LLVM, you can build it.  There are three types of
1006 builds:</p>
1007
1008 <dl>
1009     <dt>Debug Builds
1010     <dd>
1011     These builds are the default when one is using an Subversion checkout and
1012     types <tt>gmake</tt> (unless the <tt>--enable-optimized</tt> option was
1013     used during configuration).  The build system will compile the tools and
1014     libraries with debugging information.  To get a Debug Build using the
1015     LLVM distribution the <tt>--disable-optimized</tt> option must be passed
1016     to <tt>configure</tt>.
1017     <br><br>
1018
1019     <dt>Release (Optimized) Builds
1020     <dd>
1021     These builds are enabled with the <tt>--enable-optimized</tt> option to
1022     <tt>configure</tt> or by specifying <tt>ENABLE_OPTIMIZED=1</tt> on the
1023     <tt>gmake</tt> command line.  For these builds, the build system will
1024     compile the tools and libraries with GCC optimizations enabled and strip
1025     debugging information from the libraries and executables it generates.
1026     Note that Release Builds are default when using an LLVM distribution.
1027     <br><br>
1028
1029     <dt>Profile Builds
1030     <dd>
1031     These builds are for use with profiling.  They compile profiling
1032     information into the code for use with programs like <tt>gprof</tt>.
1033     Profile builds must be started by specifying <tt>ENABLE_PROFILING=1</tt>
1034     on the <tt>gmake</tt> command line.
1035 </dl>
1036
1037 <p>Once you have LLVM configured, you can build it by entering the
1038 <i>OBJ_ROOT</i> directory and issuing the following command:</p>
1039
1040 <div class="doc_code"><pre>% gmake</pre></div>
1041
1042 <p>If the build fails, please <a href="#brokengcc">check here</a> to see if you
1043 are using a version of GCC that is known not to compile LLVM.</p>
1044
1045 <p>
1046 If you have multiple processors in your machine, you may wish to use some of
1047 the parallel build options provided by GNU Make.  For example, you could use the
1048 command:</p>
1049
1050 <div class="doc_code"><pre>% gmake -j2</pre></div>
1051
1052 <p>There are several special targets which are useful when working with the LLVM
1053 source code:</p>
1054
1055 <dl>
1056   <dt><tt>gmake clean</tt>
1057   <dd>
1058   Removes all files generated by the build.  This includes object files,
1059   generated C/C++ files, libraries, and executables.
1060   <br><br>
1061
1062   <dt><tt>gmake dist-clean</tt>
1063   <dd>
1064   Removes everything that <tt>gmake clean</tt> does, but also removes files
1065   generated by <tt>configure</tt>.  It attempts to return the source tree to the
1066   original state in which it was shipped.
1067   <br><br>
1068
1069   <dt><tt>gmake install</tt>
1070   <dd>
1071   Installs LLVM header files, libraries, tools, and documentation in a
1072   hierarchy
1073   under $PREFIX, specified with <tt>./configure --prefix=[dir]</tt>, which
1074   defaults to <tt>/usr/local</tt>.
1075   <br><br>
1076
1077   <dt><tt>gmake -C runtime install-bytecode</tt>
1078   <dd>
1079   Assuming you built LLVM into $OBJDIR, when this command is run, it will
1080   install bitcode libraries into the GCC front end's bitcode library
1081   directory.  If you need to update your bitcode libraries,
1082   this is the target to use once you've built them.
1083   <br><br>
1084 </dl>
1085
1086 <p>Please see the <a href="MakefileGuide.html">Makefile Guide</a> for further
1087 details on these <tt>make</tt> targets and descriptions of other targets
1088 available.</p>
1089
1090 <p>It is also possible to override default values from <tt>configure</tt> by
1091 declaring variables on the command line.  The following are some examples:</p>
1092
1093 <dl>
1094   <dt><tt>gmake ENABLE_OPTIMIZED=1</tt>
1095   <dd>
1096   Perform a Release (Optimized) build.
1097   <br><br>
1098
1099   <dt><tt>gmake ENABLE_OPTIMIZED=1 DISABLE_ASSERTIONS=1</tt>
1100   <dd>
1101   Perform a Release (Optimized) build without assertions enabled.
1102   <br><br>
1103
1104   <dt><tt>gmake ENABLE_OPTIMIZED=0</tt>
1105   <dd>
1106   Perform a Debug build.
1107   <br><br>
1108
1109   <dt><tt>gmake ENABLE_PROFILING=1</tt>
1110   <dd>
1111   Perform a Profiling build.
1112   <br><br>
1113
1114   <dt><tt>gmake VERBOSE=1</tt>
1115   <dd>
1116   Print what <tt>gmake</tt> is doing on standard output.
1117   <br><br>
1118
1119   <dt><tt>gmake TOOL_VERBOSE=1</tt></dt>
1120   <dd>Ask each tool invoked by the makefiles to print out what it is doing on
1121   the standard output. This also implies <tt>VERBOSE=1</tt>.
1122   <br><br></dd>
1123 </dl>
1124
1125 <p>Every directory in the LLVM object tree includes a <tt>Makefile</tt> to build
1126 it and any subdirectories that it contains.  Entering any directory inside the
1127 LLVM object tree and typing <tt>gmake</tt> should rebuild anything in or below
1128 that directory that is out of date.</p>
1129
1130 </div>
1131
1132 <!-- ======================================================================= -->
1133 <div class="doc_subsection">
1134   <a name="cross-compile">Cross-Compiling LLVM</a>
1135 </div>
1136
1137 <div class="doc_text">
1138   <p>It is possible to cross-compile LLVM itself. That is, you can create LLVM
1139   executables and libraries to be hosted on a platform different from the
1140   platform where they are build (a Canadian Cross build). To configure a
1141   cross-compile, supply the configure script with <tt>--build</tt> and
1142   <tt>--host</tt> options that are different. The values of these options must
1143   be legal target triples that your GCC compiler supports.</p>
1144
1145   <p>The result of such a build is executables that are not runnable on
1146   on the build host (--build option) but can be executed on the compile host
1147   (--host option).</p>
1148 </div>
1149
1150 <!-- ======================================================================= -->
1151 <div class="doc_subsection">
1152   <a name="objfiles">The Location of LLVM Object Files</a>
1153 </div>
1154
1155 <div class="doc_text">
1156
1157 <p>The LLVM build system is capable of sharing a single LLVM source tree among
1158 several LLVM builds.  Hence, it is possible to build LLVM for several different
1159 platforms or configurations using the same source tree.</p>
1160
1161 <p>This is accomplished in the typical autoconf manner:</p>
1162
1163 <ul>
1164   <li><p>Change directory to where the LLVM object files should live:</p>
1165
1166       <div class="doc_code"><pre>% cd <i>OBJ_ROOT</i></pre></div></li>
1167
1168   <li><p>Run the <tt>configure</tt> script found in the LLVM source
1169       directory:</p>
1170
1171       <div class="doc_code"><pre>% <i>SRC_ROOT</i>/configure</pre></div></li>
1172 </ul>
1173
1174 <p>The LLVM build will place files underneath <i>OBJ_ROOT</i> in directories
1175 named after the build type:</p>
1176
1177 <dl>
1178   <dt>Debug Builds with assertions enabled (the default)
1179   <dd>
1180   <dl>
1181     <dt>Tools
1182     <dd><tt><i>OBJ_ROOT</i>/Debug+Asserts/bin</tt>
1183     <dt>Libraries
1184     <dd><tt><i>OBJ_ROOT</i>/Debug+Asserts/lib</tt>
1185   </dl>
1186   <br><br>
1187
1188   <dt>Release Builds
1189   <dd>
1190   <dl>
1191     <dt>Tools
1192     <dd><tt><i>OBJ_ROOT</i>/Release/bin</tt>
1193     <dt>Libraries
1194     <dd><tt><i>OBJ_ROOT</i>/Release/lib</tt>
1195   </dl>
1196   <br><br>
1197
1198   <dt>Profile Builds
1199   <dd>
1200   <dl>
1201     <dt>Tools
1202     <dd><tt><i>OBJ_ROOT</i>/Profile/bin</tt>
1203     <dt>Libraries
1204     <dd><tt><i>OBJ_ROOT</i>/Profile/lib</tt>
1205   </dl>
1206 </dl>
1207
1208 </div>
1209
1210 <!-- ======================================================================= -->
1211 <div class="doc_subsection">
1212   <a name="optionalconfig">Optional Configuration Items</a>
1213 </div>
1214
1215 <div class="doc_text">
1216
1217 <p>
1218 If you're running on a Linux system that supports the "<a
1219 href="http://www.tat.physik.uni-tuebingen.de/~rguenth/linux/binfmt_misc.html">binfmt_misc</a>"
1220 module, and you have root access on the system, you can set your system up to
1221 execute LLVM bitcode files directly. To do this, use commands like this (the
1222 first command may not be required if you are already using the module):</p>
1223
1224 <div class="doc_code">
1225 <pre>
1226 $ mount -t binfmt_misc none /proc/sys/fs/binfmt_misc
1227 $ echo ':llvm:M::BC::/path/to/lli:' &gt; /proc/sys/fs/binfmt_misc/register
1228 $ chmod u+x hello.bc   (if needed)
1229 $ ./hello.bc
1230 </pre>
1231 </div>
1232
1233 <p>
1234 This allows you to execute LLVM bitcode files directly.  On Debian, you
1235 can also use this command instead of the 'echo' command above:</p>
1236 </p>
1237
1238 <div class="doc_code">
1239 <pre>
1240 $ sudo update-binfmts --install llvm /path/to/lli --magic 'BC'
1241 </pre>
1242 </div>
1243
1244 </div>
1245
1246 <!-- *********************************************************************** -->
1247 <div class="doc_section">
1248   <a name="layout"><b>Program Layout</b></a>
1249 </div>
1250 <!-- *********************************************************************** -->
1251
1252 <div class="doc_text">
1253
1254 <p>One useful source of information about the LLVM source base is the LLVM <a
1255 href="http://www.doxygen.org">doxygen</a> documentation available at <tt><a
1256 href="http://llvm.org/doxygen/">http://llvm.org/doxygen/</a></tt>.
1257 The following is a brief introduction to code layout:</p>
1258
1259 </div>
1260
1261 <!-- ======================================================================= -->
1262 <div class="doc_subsection"><a name="examples"><tt>llvm/examples</tt></a></div>
1263 <div class="doc_text">
1264   <p>This directory contains some simple examples of how to use the LLVM IR and
1265   JIT.</p>
1266 </div>
1267
1268 <!-- ======================================================================= -->
1269 <div class="doc_subsection"><a name="include"><tt>llvm/include</tt></a></div>
1270 <div class="doc_text">
1271
1272 <p>This directory contains public header files exported from the LLVM
1273 library. The three main subdirectories of this directory are:</p>
1274
1275 <dl>
1276   <dt><tt><b>llvm/include/llvm</b></tt></dt>
1277   <dd>This directory contains all of the LLVM specific header files.  This
1278   directory also has subdirectories for different portions of LLVM:
1279   <tt>Analysis</tt>, <tt>CodeGen</tt>, <tt>Target</tt>, <tt>Transforms</tt>,
1280   etc...</dd>
1281
1282   <dt><tt><b>llvm/include/llvm/Support</b></tt></dt>
1283   <dd>This directory contains generic support libraries that are provided with
1284   LLVM but not necessarily specific to LLVM. For example, some C++ STL utilities
1285   and a Command Line option processing library store their header files here.
1286   </dd>
1287
1288   <dt><tt><b>llvm/include/llvm/Config</b></tt></dt>
1289   <dd>This directory contains header files configured by the <tt>configure</tt>
1290   script.  They wrap "standard" UNIX and C header files.  Source code can
1291   include these header files which automatically take care of the conditional
1292   #includes that the <tt>configure</tt> script generates.</dd>
1293 </dl>
1294 </div>
1295
1296 <!-- ======================================================================= -->
1297 <div class="doc_subsection"><a name="lib"><tt>llvm/lib</tt></a></div>
1298 <div class="doc_text">
1299
1300 <p>This directory contains most of the source files of the LLVM system. In LLVM,
1301 almost all code exists in libraries, making it very easy to share code among the
1302 different <a href="#tools">tools</a>.</p>
1303
1304 <dl>
1305   <dt><tt><b>llvm/lib/VMCore/</b></tt></dt>
1306   <dd> This directory holds the core LLVM source files that implement core
1307   classes like Instruction and BasicBlock.</dd>
1308
1309   <dt><tt><b>llvm/lib/AsmParser/</b></tt></dt>
1310   <dd>This directory holds the source code for the LLVM assembly language parser
1311   library.</dd>
1312
1313   <dt><tt><b>llvm/lib/BitCode/</b></tt></dt>
1314   <dd>This directory holds code for reading and write LLVM bitcode.</dd>
1315
1316   <dt><tt><b>llvm/lib/Analysis/</b></tt><dd>This directory contains a variety of
1317   different program analyses, such as Dominator Information, Call Graphs,
1318   Induction Variables, Interval Identification, Natural Loop Identification,
1319   etc.</dd>
1320
1321   <dt><tt><b>llvm/lib/Transforms/</b></tt></dt>
1322   <dd> This directory contains the source code for the LLVM to LLVM program
1323   transformations, such as Aggressive Dead Code Elimination, Sparse Conditional
1324   Constant Propagation, Inlining, Loop Invariant Code Motion, Dead Global
1325   Elimination, and many others.</dd>
1326
1327   <dt><tt><b>llvm/lib/Target/</b></tt></dt>
1328   <dd> This directory contains files that describe various target architectures
1329   for code generation.  For example, the <tt>llvm/lib/Target/X86</tt>
1330   directory holds the X86 machine description while
1331   <tt>llvm/lib/Target/CBackend</tt> implements the LLVM-to-C converter.</dd>
1332
1333   <dt><tt><b>llvm/lib/CodeGen/</b></tt></dt>
1334   <dd> This directory contains the major parts of the code generator: Instruction
1335   Selector, Instruction Scheduling, and Register Allocation.</dd>
1336
1337   <dt><tt><b>llvm/lib/Debugger/</b></tt></dt>
1338   <dd> This directory contains the source level debugger library that makes
1339   it possible to instrument LLVM programs so that a debugger could identify
1340   source code locations at which the program is executing.</dd>
1341
1342   <dt><tt><b>llvm/lib/ExecutionEngine/</b></tt></dt>
1343   <dd> This directory contains libraries for executing LLVM bitcode directly
1344   at runtime in both interpreted and JIT compiled fashions.</dd>
1345
1346   <dt><tt><b>llvm/lib/Support/</b></tt></dt>
1347   <dd> This directory contains the source code that corresponds to the header
1348   files located in <tt>llvm/include/Support/</tt>.</dd>
1349
1350   <dt><tt><b>llvm/lib/System/</b></tt></dt>
1351   <dd>This directory contains the operating system abstraction layer that
1352   shields LLVM from platform-specific coding.</dd>
1353 </dl>
1354
1355 </div>
1356
1357 <!-- ======================================================================= -->
1358 <div class="doc_subsection"><a name="projects"><tt>llvm/projects</tt></a></div>
1359 <div class="doc_text">
1360   <p>This directory contains projects that are not strictly part of LLVM but are
1361   shipped with LLVM. This is also the directory where you should create your own
1362   LLVM-based projects. See <tt>llvm/projects/sample</tt> for an example of how
1363   to set up your own project.</p>
1364 </div>
1365
1366 <!-- ======================================================================= -->
1367 <div class="doc_subsection"><a name="runtime"><tt>llvm/runtime</tt></a></div>
1368 <div class="doc_text">
1369
1370 <p>This directory contains libraries which are compiled into LLVM bitcode and
1371 used when linking programs with the GCC front end.  Most of these libraries are
1372 skeleton versions of real libraries; for example, libc is a stripped down
1373 version of glibc.</p>
1374
1375 <p>Unlike the rest of the LLVM suite, this directory needs the LLVM GCC front
1376 end to compile.</p>
1377
1378 </div>
1379
1380 <!-- ======================================================================= -->
1381 <div class="doc_subsection"><a name="test"><tt>llvm/test</tt></a></div>
1382 <div class="doc_text">
1383   <p>This directory contains feature and regression tests and other basic sanity
1384   checks on the LLVM infrastructure. These are intended to run quickly and cover
1385   a lot of territory without being exhaustive.</p>
1386 </div>
1387
1388 <!-- ======================================================================= -->
1389 <div class="doc_subsection"><a name="test-suite"><tt>test-suite</tt></a></div>
1390 <div class="doc_text">
1391   <p>This is not a directory in the normal llvm module; it is a separate
1392   Subversion
1393   module that must be checked out (usually to <tt>projects/test-suite</tt>).
1394   This
1395   module contains a comprehensive correctness, performance, and benchmarking
1396   test
1397   suite for LLVM. It is a separate Subversion module because not every LLVM
1398   user is
1399   interested in downloading or building such a comprehensive test suite. For
1400   further details on this test suite, please see the
1401   <a href="TestingGuide.html">Testing Guide</a> document.</p>
1402 </div>
1403
1404 <!-- ======================================================================= -->
1405 <div class="doc_subsection"><a name="tools"><tt>llvm/tools</tt></a></div>
1406 <div class="doc_text">
1407
1408 <p>The <b>tools</b> directory contains the executables built out of the
1409 libraries above, which form the main part of the user interface.  You can
1410 always get help for a tool by typing <tt>tool_name -help</tt>.  The
1411 following is a brief introduction to the most important tools.  More detailed
1412 information is in the <a href="CommandGuide/index.html">Command Guide</a>.</p>
1413
1414 <dl>
1415
1416   <dt><tt><b>bugpoint</b></tt></dt>
1417   <dd><tt>bugpoint</tt> is used to debug
1418   optimization passes or code generation backends by narrowing down the
1419   given test case to the minimum number of passes and/or instructions that
1420   still cause a problem, whether it is a crash or miscompilation. See <a
1421   href="HowToSubmitABug.html">HowToSubmitABug.html</a> for more information
1422   on using <tt>bugpoint</tt>.</dd>
1423
1424   <dt><tt><b>llvmc</b></tt></dt>
1425   <dd>The LLVM Compiler Driver. This program can
1426   be configured to utilize both LLVM and non-LLVM compilation tools to enable
1427   pre-processing, translation, optimization, assembly, and linking of programs
1428   all from one command line. <tt>llvmc</tt> also takes care of processing the
1429   dependent libraries found in bitcode. This reduces the need to get the
1430   traditional <tt>-l&lt;name&gt;</tt> options right on the command line. Please
1431   note that this tool, while functional, is still experimental and not feature
1432   complete.</dd>
1433
1434   <dt><tt><b>llvm-ar</b></tt></dt>
1435   <dd>The archiver produces an archive containing
1436   the given LLVM bitcode files, optionally with an index for faster
1437   lookup.</dd>
1438
1439   <dt><tt><b>llvm-as</b></tt></dt>
1440   <dd>The assembler transforms the human readable LLVM assembly to LLVM
1441   bitcode.</dd>
1442
1443   <dt><tt><b>llvm-dis</b></tt></dt>
1444   <dd>The disassembler transforms the LLVM bitcode to human readable
1445   LLVM assembly.</dd>
1446
1447   <dt><tt><b>llvm-ld</b></tt></dt>
1448   <dd><tt>llvm-ld</tt> is a general purpose and extensible linker for LLVM.
1449   This is the linker invoked by <tt>llvmc</tt>. It performs standard link time
1450   optimizations and allows optimization modules to be loaded and run so that
1451   language specific optimizations can be applied at link time.</dd>
1452
1453   <dt><tt><b>llvm-link</b></tt></dt>
1454   <dd><tt>llvm-link</tt>, not surprisingly, links multiple LLVM modules into
1455   a single program.</dd>
1456
1457   <dt><tt><b>lli</b></tt></dt>
1458   <dd><tt>lli</tt> is the LLVM interpreter, which
1459   can directly execute LLVM bitcode (although very slowly...). For architectures
1460   that support it (currently x86, Sparc, and PowerPC), by default, <tt>lli</tt>
1461   will function as a Just-In-Time compiler (if the functionality was compiled
1462   in), and will execute the code <i>much</i> faster than the interpreter.</dd>
1463
1464   <dt><tt><b>llc</b></tt></dt>
1465   <dd> <tt>llc</tt> is the LLVM backend compiler, which
1466   translates LLVM bitcode to a native code assembly file or to C code (with
1467   the -march=c option).</dd>
1468
1469   <dt><tt><b>llvm-gcc</b></tt></dt>
1470   <dd><tt>llvm-gcc</tt> is a GCC-based C frontend that has been retargeted to
1471   use LLVM as its backend instead of GCC's RTL backend. It can also emit LLVM
1472   bitcode or assembly (with the <tt>-emit-llvm</tt> option) instead of the
1473   usual machine code output.  It works just like any other GCC compiler,
1474   taking the typical <tt>-c, -S, -E, -o</tt> options that are typically used.
1475   Additionally, the the source code for <tt>llvm-gcc</tt> is available as a
1476   separate Subversion module.</dd>
1477
1478   <dt><tt><b>opt</b></tt></dt>
1479   <dd><tt>opt</tt> reads LLVM bitcode, applies a series of LLVM to LLVM
1480   transformations (which are specified on the command line), and then outputs
1481   the resultant bitcode.  The '<tt>opt -help</tt>' command is a good way to
1482   get a list of the program transformations available in LLVM.<br>
1483   <dd><tt>opt</tt> can also be used to run a specific analysis on an input
1484   LLVM bitcode file and print out the results.  It is primarily useful for
1485   debugging analyses, or familiarizing yourself with what an analysis does.</dd>
1486 </dl>
1487 </div>
1488
1489 <!-- ======================================================================= -->
1490 <div class="doc_subsection"><a name="utils"><tt>llvm/utils</tt></a></div>
1491 <div class="doc_text">
1492
1493 <p>This directory contains utilities for working with LLVM source code, and some
1494 of the utilities are actually required as part of the build process because they
1495 are code generators for parts of LLVM infrastructure.</p>
1496
1497 <dl>
1498   <dt><tt><b>codegen-diff</b></tt> <dd><tt>codegen-diff</tt> is a script
1499   that finds differences between code that LLC generates and code that LLI
1500   generates. This is a useful tool if you are debugging one of them,
1501   assuming that the other generates correct output. For the full user
1502   manual, run <tt>`perldoc codegen-diff'</tt>.<br><br>
1503
1504   <dt><tt><b>emacs/</b></tt> <dd>The <tt>emacs</tt> directory contains
1505   syntax-highlighting files which will work with Emacs and XEmacs editors,
1506   providing syntax highlighting support for LLVM assembly files and TableGen
1507   description files. For information on how to use the syntax files, consult
1508   the <tt>README</tt> file in that directory.<br><br>
1509
1510   <dt><tt><b>getsrcs.sh</b></tt> <dd>The <tt>getsrcs.sh</tt> script finds
1511   and outputs all non-generated source files, which is useful if one wishes
1512   to do a lot of development across directories and does not want to
1513   individually find each file. One way to use it is to run, for example:
1514   <tt>xemacs `utils/getsources.sh`</tt> from the top of your LLVM source
1515   tree.<br><br>
1516
1517   <dt><tt><b>llvmgrep</b></tt></dt>
1518   <dd>This little tool performs an "egrep -H -n" on each source file in LLVM and
1519   passes to it a regular expression provided on <tt>llvmgrep</tt>'s command
1520   line. This is a very efficient way of searching the source base for a
1521   particular regular expression.</dd>
1522
1523   <dt><tt><b>makellvm</b></tt> <dd>The <tt>makellvm</tt> script compiles all
1524   files in the current directory and then compiles and links the tool that
1525   is the first argument. For example, assuming you are in the directory
1526   <tt>llvm/lib/Target/Sparc</tt>, if <tt>makellvm</tt> is in your path,
1527   simply running <tt>makellvm llc</tt> will make a build of the current
1528   directory, switch to directory <tt>llvm/tools/llc</tt> and build it,
1529   causing a re-linking of LLC.<br><br>
1530
1531   <dt><tt><b>NewNightlyTest.pl</b></tt> and
1532   <tt><b>NightlyTestTemplate.html</b></tt> <dd>These files are used in a
1533   cron script to generate nightly status reports of the functionality of
1534   tools, and the results can be seen by following the appropriate link on
1535   the <a href="http://llvm.org/">LLVM homepage</a>.<br><br>
1536
1537   <dt><tt><b>TableGen/</b></tt> <dd>The <tt>TableGen</tt> directory contains
1538   the tool used to generate register descriptions, instruction set
1539   descriptions, and even assemblers from common TableGen description
1540   files.<br><br>
1541
1542   <dt><tt><b>vim/</b></tt> <dd>The <tt>vim</tt> directory contains
1543   syntax-highlighting files which will work with the VIM editor, providing
1544   syntax highlighting support for LLVM assembly files and TableGen
1545   description files. For information on how to use the syntax files, consult
1546   the <tt>README</tt> file in that directory.<br><br>
1547
1548 </dl>
1549
1550 </div>
1551
1552 <!-- *********************************************************************** -->
1553 <div class="doc_section">
1554   <a name="tutorial">An Example Using the LLVM Tool Chain</a>
1555 </div>
1556 <!-- *********************************************************************** -->
1557
1558 <div class="doc_text">
1559 <p>This section gives an example of using LLVM.  llvm-gcc3 is now obsolete,
1560 so we only include instructions for llvm-gcc4.
1561 </p>
1562
1563 <p><b>Note:</b> The <i>gcc4</i> frontend's invocation is <b><i>considerably different</i></b>
1564 from the previous <i>gcc3</i> frontend. In particular, the <i>gcc4</i> frontend <b><i>does not</i></b>
1565 create bitcode by default: <i>gcc4</i> produces native code. As the example below illustrates,
1566 the '--emit-llvm' flag is needed to produce LLVM bitcode output. For <i>makefiles</i> and
1567 <i>configure</i> scripts, the CFLAGS variable needs '--emit-llvm' to produce bitcode
1568 output.</p>
1569 </div>
1570
1571 <!-- ======================================================================= -->
1572 <div class="doc_subsection"><a name="tutorial4">Example with llvm-gcc4</a></div>
1573
1574 <div class="doc_text">
1575
1576 <ol>
1577   <li><p>First, create a simple C file, name it 'hello.c':</p>
1578
1579 <div class="doc_code">
1580 <pre>
1581 #include &lt;stdio.h&gt;
1582
1583 int main() {
1584   printf("hello world\n");
1585   return 0;
1586 }
1587 </pre></div></li>
1588
1589   <li><p>Next, compile the C file into a native executable:</p>
1590
1591       <div class="doc_code"><pre>% llvm-gcc hello.c -o hello</pre></div>
1592
1593       <p>Note that llvm-gcc works just like GCC by default.  The standard -S and
1594         -c arguments work as usual (producing a native .s or .o file,
1595         respectively).</p></li>
1596
1597   <li><p>Next, compile the C file into a LLVM bitcode file:</p>
1598
1599       <div class="doc_code">
1600       <pre>% llvm-gcc -O3 -emit-llvm hello.c -c -o hello.bc</pre></div>
1601
1602       <p>The -emit-llvm option can be used with the -S or -c options to emit an
1603          LLVM ".ll" or ".bc" file (respectively) for the code.  This allows you
1604          to use the <a href="CommandGuide/index.html">standard LLVM tools</a> on
1605          the bitcode file.</p>
1606
1607       <p>Unlike llvm-gcc3, llvm-gcc4 correctly responds to -O[0123] arguments.
1608          </p></li>
1609
1610   <li><p>Run the program in both forms. To run the program, use:</p>
1611
1612       <div class="doc_code"><pre>% ./hello</pre></div>
1613
1614       <p>and</p>
1615
1616       <div class="doc_code"><pre>% lli hello.bc</pre></div>
1617
1618       <p>The second examples shows how to invoke the LLVM JIT, <a
1619        href="CommandGuide/html/lli.html">lli</a>.</p></li>
1620
1621   <li><p>Use the <tt>llvm-dis</tt> utility to take a look at the LLVM assembly
1622       code:</p>
1623
1624 <div class="doc_code">
1625 <pre>llvm-dis &lt; hello.bc | less</pre>
1626 </div></li>
1627
1628   <li><p>Compile the program to native assembly using the LLC code
1629       generator:</p>
1630
1631       <div class="doc_code"><pre>% llc hello.bc -o hello.s</pre></div></li>
1632
1633   <li><p>Assemble the native assembly language file into a program:</p>
1634
1635 <div class="doc_code">
1636 <pre>
1637 <b>Solaris:</b> % /opt/SUNWspro/bin/cc -xarch=v9 hello.s -o hello.native
1638
1639 <b>Others:</b>  % gcc hello.s -o hello.native
1640 </pre>
1641 </div></li>
1642
1643   <li><p>Execute the native code program:</p>
1644
1645       <div class="doc_code"><pre>% ./hello.native</pre></div>
1646
1647       <p>Note that using llvm-gcc to compile directly to native code (i.e. when
1648          the -emit-llvm option is not present) does steps 6/7/8 for you.</p>
1649         </li>
1650
1651 </ol>
1652
1653 </div>
1654
1655
1656 <!-- *********************************************************************** -->
1657 <div class="doc_section">
1658   <a name="problems">Common Problems</a>
1659 </div>
1660 <!-- *********************************************************************** -->
1661
1662 <div class="doc_text">
1663
1664 <p>If you are having problems building or using LLVM, or if you have any other
1665 general questions about LLVM, please consult the <a href="FAQ.html">Frequently
1666 Asked Questions</a> page.</p>
1667
1668 </div>
1669
1670 <!-- *********************************************************************** -->
1671 <div class="doc_section">
1672   <a name="links">Links</a>
1673 </div>
1674 <!-- *********************************************************************** -->
1675
1676 <div class="doc_text">
1677
1678 <p>This document is just an <b>introduction</b> on how to use LLVM to do
1679 some simple things... there are many more interesting and complicated things
1680 that you can do that aren't documented here (but we'll gladly accept a patch
1681 if you want to write something up!).  For more information about LLVM, check
1682 out:</p>
1683
1684 <ul>
1685   <li><a href="http://llvm.org/">LLVM homepage</a></li>
1686   <li><a href="http://llvm.org/doxygen/">LLVM doxygen tree</a></li>
1687   <li><a href="http://llvm.org/docs/Projects.html">Starting a Project
1688   that Uses LLVM</a></li>
1689 </ul>
1690
1691 </div>
1692
1693 <!-- *********************************************************************** -->
1694
1695 <hr>
1696 <address>
1697   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
1698   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
1699   <a href="http://validator.w3.org/check/referer"><img
1700   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
1701
1702   <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
1703   <a href="http://llvm.x10sys.com/rspencer/">Reid Spencer</a><br>
1704   <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br>
1705   Last modified: $Date$
1706 </address>
1707 </body>
1708 </html>