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