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