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