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