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