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