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