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