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