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