docs/GettingStarted.html

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