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