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