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