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