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