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