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