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