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