1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
6 <title>Getting Started with LLVM System</title>
7 <link rel="stylesheet" href="llvm.css" type="text/css">
11 <div class="doc_title">
12 Getting Started with the LLVM System
16 <li><a href="#overview">Overview</a>
17 <li><a href="#quickstart">Getting Started Quickly (A Summary)</a>
18 <li><a href="#requirements">Requirements</a>
20 <li><a href="#hardware">Hardware</a>
21 <li><a href="#software">Software</a>
22 <li><a href="#brokengcc">Broken versions of GCC</a>
25 <li><a href="#starting">Getting Started with LLVM</a>
27 <li><a href="#terminology">Terminology and Notation</a>
28 <li><a href="#environment">Setting Up Your Environment</a>
29 <li><a href="#unpack">Unpacking the LLVM Archives</a>
30 <li><a href="#checkout">Checkout LLVM from CVS</a>
31 <li><a href="#installcf">Install the GCC Front End</a>
32 <li><a href="#config">Local LLVM Configuration</a>
33 <li><a href="#compile">Compiling the LLVM Suite Source Code</a>
34 <li><a href="#objfiles">The Location of LLVM Object Files</a>
35 <li><a href="#optionalconfig">Optional Configuration Items</a>
38 <li><a href="#layout">Program layout</a>
40 <li><a href="#cvsdir"><tt>CVS</tt> directories</a>
41 <li><a href="#examples"><tt>llvm/examples</tt></a>
42 <li><a href="#include"><tt>llvm/include</tt></a>
43 <li><a href="#lib"><tt>llvm/lib</tt></a>
44 <li><a href="#projects"><tt>llvm/projects</tt></a>
45 <li><a href="#runtime"><tt>llvm/runtime</tt></a>
46 <li><a href="#test"><tt>llvm/test</tt></a>
47 <li><a href="#llvmtest"><tt>llvm-test</tt></a>
48 <li><a href="#tools"><tt>llvm/tools</tt></a>
49 <li><a href="#utils"><tt>llvm/utils</tt></a>
50 <li><a href="#win32"><tt>llvm/win32</tt></a>
53 <li><a href="#tutorial">An Example Using the LLVM Tool Chain</a>
54 <li><a href="#problems">Common Problems</a>
55 <li><a href="#links">Links</a>
58 <div class="doc_author">
60 <a href="mailto:criswell@uiuc.edu">John Criswell</a>,
61 <a href="mailto:sabre@nondot.org">Chris Lattner</a>,
62 <a href="http://misha.brukman.net">Misha Brukman</a>,
63 <a href="http://www.cs.uiuc.edu/~vadve">Vikram Adve</a>, and
64 <a href="mailto:gshi1@uiuc.edu">Guochun Shi</a>.
69 <!-- *********************************************************************** -->
70 <div class="doc_section">
71 <a name="overview"><b>Overview</b></a>
73 <!-- *********************************************************************** -->
75 <div class="doc_text">
77 <p>Welcome to LLVM! In order to get started, you first need to know some
78 basic information.</p>
80 <p>First, LLVM comes in two pieces. The first piece is the LLVM suite. This
81 contains all of the tools, libraries, and header files needed to use the low
82 level virtual machine. It contains an assembler, disassembler, bytecode
83 analyzer, and bytecode optimizer. It also contains a test suite that can be
84 used to test the LLVM tools and the GCC front end.</p>
86 <p>The second piece is the GCC front end. This component provides a version of
87 GCC that compiles C and C++ code into LLVM bytecode. Currently, the GCC front
88 end is a modified version of GCC 3.4 (we track the GCC 3.4 development). Once
89 compiled into LLVM bytecode, a program can be manipulated with the LLVM tools
90 from the LLVM suite.</p>
93 There is a third, optional piece called llvm-test. It is a suite of programs
94 with a testing harness that can be used to further test LLVM's functionality
100 <!-- *********************************************************************** -->
101 <div class="doc_section">
102 <a name="quickstart"><b>Getting Started Quickly (A Summary)</b></a>
104 <!-- *********************************************************************** -->
106 <div class="doc_text">
108 <p>Here's the short story for getting up and running quickly with LLVM:</p>
111 <li>Read the documentation.</li>
112 <li>Read the documentation.</li>
113 <li>Remember that you were warned twice about reading the documentation.</li>
114 <li>Install the GCC front end:
116 <li><tt>cd <i>where-you-want-the-C-front-end-to-live</i></tt></li>
117 <li><tt>gunzip --stdout cfrontend.<i>platform</i>.tar.gz | tar -xvf -</tt>
119 <li><tt>cd cfrontend/<i>platform</i><br>
120 ./fixheaders</tt></li>
121 <li>Add the cfrontend's "bin" directory to your PATH variable</li>
124 <li>Get the Source Code
126 <li>With the distributed files:
128 <li><tt>cd <i>where-you-want-llvm-to-live</i></tt>
129 <li><tt>gunzip --stdout llvm-<i>version</i>.tar.gz | tar -xvf -</tt>
130 <li><tt>cd llvm</tt></li>
133 <li>With anonymous CVS access (or use a <a href="#mirror">mirror</a>):
135 <li><tt>cd <i>where-you-want-llvm-to-live</i></tt></li>
137 :pserver:anon@llvm-cvs.cs.uiuc.edu:/var/cvs/llvm login</tt></li>
138 <li>Hit the return key when prompted for the password.
139 <li><tt>cvs -z3 -d :pserver:anon@llvm-cvs.cs.uiuc.edu:/var/cvs/llvm
141 <li><tt>cd llvm</tt></li>
142 <li><tt>cvs up -P -d</tt></li>
146 <li>Get the Test Suite Source Code (<em>optional</em>)
148 <li>With the distributed files:
150 <li><tt>cd <i>where-you-want-llvm-to-live</i></tt>
151 <li><tt>cd llvm/projects</tt>
152 <li><tt>gunzip --stdout llvm-test-<i>version</i>.tar.gz | tar -xvf -</tt>
153 <li><tt>cd ..</tt></li>
156 <li>With anonymous CVS access (or use a <a href="#mirror">mirror</a>):
158 <li><tt>cd <i>where-you-want-llvm-to-live</i></tt></li>
159 <li><tt>cd llvm/projects</tt>
161 :pserver:anon@llvm-cvs.cs.uiuc.edu:/var/cvs/llvm login</tt></li>
162 <li>Hit the return key when prompted for the password.
163 <li><tt>cvs -z3 -d :pserver:anon@llvm-cvs.cs.uiuc.edu:/var/cvs/llvm
164 co llvm-test</tt></li>
165 <li><tt>cd llvm-test</tt></li>
166 <li><tt>cvs up -P -d</tt></li>
167 <li><tt>cd ..</tt></li>
172 <li>Configure the LLVM Build Environment
174 <li>Change directory to where you want to store the LLVM object
175 files and run <tt>configure</tt> to configure the Makefiles and
176 header files for the default platform. Useful options include:
178 <li><tt>--prefix=<i>directory</i></tt>
179 <p>Specify for <i>directory</i> the full pathname of where you
180 want the LLVM tools and libraries to be installed.</p></li>
181 <li><tt>--with-llvmgccdir=<i>directory</i></tt>
182 <p>Optionally, specify for <i>directory</i> the full pathname of the
183 C/C++ FrontEnd installation to use with this LLVM configuration. If
184 not specified, the PATH will be searched.</p></li>
185 <li><tt>--enable-spec2000=<i>directory</i></tt>
186 <p>Enable the SPEC2000 benchmarks for testing. The SPEC2000
187 benchmarks should be available in
188 <tt><i>directory</i></tt>.</p></li>
192 <li>Build the LLVM Suite:
194 <li><tt>gmake -k |& tee gnumake.out
195 # this is csh or tcsh syntax</tt></li>
196 <li>If you get an "internal compiler error (ICE)" see <a href="#brokengcc">below</a>.</li>
201 <p>Consult the <a href="#starting">Getting Started with LLVM</a> section for
202 detailed information on configuring and compiling LLVM. See <a
203 href="#environment">Setting Up Your Environment</a> for tips that simplify
204 working with the GCC front end and LLVM tools. Go to <a href="#layout">Program
205 Layout</a> to learn about the layout of the source code tree.</p>
209 <!-- *********************************************************************** -->
210 <div class="doc_section">
211 <a name="requirements"><b>Requirements</b></a>
213 <!-- *********************************************************************** -->
215 <div class="doc_text">
217 <p>Before you begin to use the LLVM system, review the requirements given below.
218 This may save you some trouble by knowing ahead of time what hardware and
219 software you will need.</p>
223 <!-- ======================================================================= -->
224 <div class="doc_subsection">
225 <a name="hardware"><b>Hardware</b></a>
228 <div class="doc_text">
230 <p>LLVM is known to work on the following platforms:</p>
232 <table cellpadding="3">
240 <td>x86<sup>1</sup></td>
245 <td>V9 (Ultrasparc)</td>
250 <td>x86<sup>1</sup></td>
254 <td>MacOS X<sup>2</sup></td>
259 <td>Cygwin/Win32</td>
260 <td>x86<sup>1</sup></td>
261 <td>GCC 3.4.X, binutils 2.15</td>
265 <td>amd64<sup>3</sup></td>
270 <p>LLVM has partial support for the following platforms:</p>
280 <td>x86<sup>1</sup></td>
281 <td>Visual Studio .NET<sup>4,5</sup>, MinGW</td>
283 <td>AIX<sup>3,4</sup></td>
288 <td>Linux<sup>3,5</sup></td>
296 <sup>1</sup> Code generation supported for Pentium processors and up<br>
297 <sup>2</sup> Code generation supported for 32-bit ABI only<br>
298 <sup>3</sup> No native code generation<br>
299 <sup>4</sup> Build is not complete: one or more tools don't link<br>
300 <sup>5</sup> The GCC-based C/C++ frontend does not build<br>
303 <p>Note that you will need about 1-3 GB of space for a full LLVM build in Debug
304 mode, depending on the system (because of all the debug info), and the libraries
305 appear in more than one of the tools that get linked, so there is some
306 duplication. If you do not need many of the tools and you are space-conscious,
307 you can disable them individually in <tt>llvm/tools/Makefile</tt>. The Release
308 build requires considerably less space.</p>
310 <p>The LLVM suite <i>may</i> compile on other platforms, but it is not
311 guaranteed to do so. If compilation is successful, the LLVM utilities should be
312 able to assemble, disassemble, analyze, and optimize LLVM bytecode. Code
313 generation should work as well, although the generated native code may not work
314 on your platform.</p>
316 <p>The GCC front end is not very portable at the moment. If you want to get it
317 to work on another platform, you can download a copy of the source and <a
318 href="CFEBuildInstrs.html">try to compile it</a> on your platform.</p>
322 <!-- ======================================================================= -->
323 <div class="doc_subsection"><a name="software"><b>Software</b></a></div>
324 <div class="doc_text">
325 <p>Compiling LLVM requires that you have several software packages
326 installed. The table below lists those required packages. The Package column
327 is the usual name for the software package that LLVM depends on. The Version
328 column provides "known to work" versions of the package. The Notes column
329 describes how LLVM uses the package and provides other details.</p>
331 <tr><th>Package</th><th>Version</th><th>Notes</th></tr>
334 <td><a href="http://savannah.gnu.org/projects/make">GNU Make</a></td>
335 <td>3.79, 3.79.1</td>
336 <td>Makefile/build processor</td>
340 <td><a href="http://gcc.gnu.org">GCC</a></td>
342 <td>C/C++ compiler (<a href="#Note3">Note 3</a>)</td>
346 <td><a href="http://www.gnu.org/software/flex">Flex</a></td>
348 <td>LEX compiler</td>
352 <td><a href="http://www.gnu.org/software/bison/bison.html">Bison</a></td>
354 <td>YACC compiler</td>
358 <td><a href="http://savannah.gnu.org/projects/dejagnu">DejaGnu</a></td>
360 <td>Automated test suite (<a href="#Note2">Note 2</a>)</td>
364 <td><a href="http://www.tcl.tk/software/tcltk/">tcl</a></td>
366 <td>Automated test suite (<a href="#Note2">Note 2</a>)</td>
370 <td><a href="http://expect.nist.gov/">expect</a></td>
372 <td>Automated test suite (<a href="#Note2">Note 2</a>)</td>
376 <td><a href="http://savannah.gnu.org/projects/m4">GNU M4</a>
378 <td>Macro processor for configuration (<a href="#Note1">Note 1</a>)</td>
382 <td><a href="http://www.gnu.org/software/autoconf">GNU Autoconf</a></td>
384 <td>Configuration script builder (<a href="#Note1">Note 1</a>)</td>
388 <td><a href="http://www.gnu.org/software/automake">GNU Automake</a></td>
390 <td>aclocal macro generator (<a href="#Note1">Note 1</a>)</td>
394 <td><a href="http://www.perl.com/download.csp">perl</a></td>
396 <td>Nightly tester, utilities</td>
400 <td><a href="http://savannah.gnu.org/projects/libtool">libtool</a></td>
402 <td>Shared library manager (<a href="#Note1">Note 1</a>)</td>
406 <td><a href="https://www.cvshome.org/downloads.html">CVS</a></td>
408 <td>CVS access to LLVM (<a href="#Note4">Note 4</a>)</td>
415 <li><a name="Note1">If you want to make changes to the configure scripts,
416 you will need GNU autoconf (2.59), and consequently, GNU M4 (version 1.4
417 or higher). You will also need automake (1.9.2). We only use aclocal
418 from that package.</a></li>
419 <li><a name="Note2">Only needed if you want to run the automated test
420 suite in the <tt>test</tt> directory.</a></li>
422 <li><a name="Note3">Only the C and C++ languages are needed so there's no
423 need to build the other languages for LLVM's purposes.</a> See
424 <a href="#brokengcc">below</a> for specific version info.
426 <li><a name="Note4">You only need CVS if you intend to build from the
427 latest LLVM sources. If you're working from a release distribution, you
428 don't need CVS.</a></li>
430 <p>Additionally, your compilation host is expected to have the usual
431 plethora of Unix utilities. Specifically:</p>
433 <li><b>ar</b> - archive library builder</li>
434 <li><b>bzip2*</b> - bzip2 command for distribution generation</li>
435 <li><b>bunzip2*</b> - bunzip2 command for distribution checking</li>
436 <li><b>chmod</b> - change permissions on a file</li>
437 <li><b>cat</b> - output concatenation utility</li>
438 <li><b>cp</b> - copy files</li>
439 <li><b>date</b> - print the current date/time </li>
440 <li><b>echo</b> - print to standard output</li>
441 <li><b>egrep</b> - extended regular expression search utility</li>
442 <li><b>etags</b> - C/C++ tag file creator for vim/emacs</li>
443 <li><b>find</b> - find files/dirs in a file system</li>
444 <li><b>grep</b> - regular expression search utility</li>
445 <li><b>gzip*</b> - gzip command for distribution generation</li>
446 <li><b>gunzip*</b> - gunzip command for distribution checking</li>
447 <li><b>install</b> - install directories/files </li>
448 <li><b>mkdir</b> - create a directory</li>
449 <li><b>mv</b> - move (rename) files</li>
450 <li><b>ranlib</b> - symbol table builder for archive libraries</li>
451 <li><b>rm</b> - remove (delete) files and directories</li>
452 <li><b>sed</b> - stream editor for transforming output</li>
453 <li><b>sh</b> - Bourne shell for make build scripts</li>
454 <li><b>tar</b> - tape archive for distribution generation</li>
455 <li><b>test</b> - test things in file system</li>
456 <li><b>unzip*</b> - unzip command for distribution checking</li>
457 <li><b>zip*</b> - zip command for distribution generation</li>
461 <!-- ======================================================================= -->
462 <div class="doc_subsection">
463 <a name="brokengcc">Broken versions of GCC</a>
466 <div class="doc_text">
468 <p>LLVM is very demanding of the host C++ compiler, and as such tends to expose
469 bugs in the compiler. In particular, several versions of GCC crash when trying
470 to compile LLVM. We routinely use GCC 3.3.3 and GCC 3.4.0 and have had success
471 with them. Other versions of GCC will probably work as well. GCC versions listed
472 here are known to not work. If you are using one of these versions, please try
473 to upgrade your GCC to something more recent. If you run into a problem with a
474 version of GCC not listed here, please <a href="mailto:llvmdev@cs.uiuc.edu">let
475 us know</a>. Please use the "<tt>gcc -v</tt>" command to find out which version
476 of GCC you are using.
479 <p><b>GCC versions prior to 3.0</b>: GCC 2.96.x and before had several
480 problems in the STL that effectively prevent it from compiling LLVM.
483 <p><b>GCC 3.2.2</b>: This version of GCC fails to compile LLVM.</p>
485 <p><b>GCC 3.3.2</b>: This version of GCC suffered from a <a
486 href="http://gcc.gnu.org/PR13392">serious bug</a> which causes it to crash in
487 the "<tt>convert_from_eh_region_ranges_1</tt>" GCC function.</p>
492 <!-- *********************************************************************** -->
493 <div class="doc_section">
494 <a name="starting"><b>Getting Started with LLVM</b></a>
496 <!-- *********************************************************************** -->
498 <div class="doc_text">
500 <p>The remainder of this guide is meant to get you up and running with
501 LLVM and to give you some basic information about the LLVM environment.</p>
503 <p>The later sections of this guide describe the <a
504 href="#layout">general layout</a> of the the LLVM source tree, a <a
505 href="#tutorial">simple example</a> using the LLVM tool chain, and <a
506 href="#links">links</a> to find more information about LLVM or to get
510 <!-- ======================================================================= -->
511 <div class="doc_subsection">
512 <a name="terminology">Terminology and Notation</a>
515 <div class="doc_text">
517 <p>Throughout this manual, the following names are used to denote paths
518 specific to the local system and working environment. <i>These are not
519 environment variables you need to set but just strings used in the rest
520 of this document below</i>. In any of the examples below, simply replace
521 each of these names with the appropriate pathname on your local system.
522 All these paths are absolute:</p>
527 This is the top level directory of the LLVM source tree.
532 This is the top level directory of the LLVM object tree (i.e. the
533 tree where object files and compiled programs will be placed. It
534 can be the same as SRC_ROOT).
539 This is where the LLVM GCC Front End is installed.
541 For the pre-built GCC front end binaries, the LLVMGCCDIR is
542 <tt>cfrontend/<i>platform</i>/llvm-gcc</tt>.
547 <!-- ======================================================================= -->
548 <div class="doc_subsection">
549 <a name="environment">Setting Up Your Environment</a>
552 <div class="doc_text">
555 In order to compile and use LLVM, you will need to set some environment
556 variables. There are also some shell aliases which you may find useful.
557 You can set these on the command line, or better yet, set them in your
558 <tt>.cshrc</tt> or <tt>.profile</tt>.
561 <dt><tt>LLVM_LIB_SEARCH_PATH</tt>=<tt>/path/to/your/bytecode/libs</tt></dt>
562 <dd>This environment variable helps LLVM linking tools find the locations
563 of your bytecode libraries. It is optional and provided only a convenience
564 since you can specify the paths using the -L options of the tools.</dd>
566 <dt><tt>alias llvmgcc='llvm-gcc'</tt></dt>
567 <dt><tt>alias llvmg++='llvm-g++'</tt></dt>
568 <dd></dt>These aliases allow you to use the LLVM C and C++ front ends
569 under alternative names. It is assumed that llvm-gcc and llvm-g++ are
570 in your path. The LLVM makefiles will use llvm-gcc and llvm-g++ directly.</dd>
575 <!-- ======================================================================= -->
576 <div class="doc_subsection">
577 <a name="unpack">Unpacking the LLVM Archives</a>
580 <div class="doc_text">
583 If you have the LLVM distribution, you will need to unpack it before you
584 can begin to compile it. LLVM is distributed as a set of two files: the LLVM
585 suite and the LLVM GCC front end compiled for your platform. There is an
586 additional test suite that is optional. Each file is a TAR archive that is
587 compressed with the gzip program.
590 <p> The files are as follows:
592 <dt><tt>llvm-1.4.tar.gz</tt></dt>
593 <dd>This is the source code for the LLVM libraries and tools.<br/></dd>
595 <dt><tt>llvm-test-1.4.tar.gz</tt></dt>
596 <dd>This is the source code for the LLVM test suite.</tt></dd>
598 <dt><tt>cfrontend-1.4.source.tar.gz</tt></dt>
599 <dd>This is the source release of the GCC front end.<br/></dd>
601 <dt><tt>cfrontend-1.4.sparc-sun-solaris2.8.tar.gz</tt></dt>
602 <dd>This is the binary release of the GCC front end for Solaris/Sparc.
605 <dt><tt>cfrontend-1.4.i686-redhat-linux-gnu.tar.gz</tt></dt>
606 <dd>This is the binary release of the GCC front end for Linux/x86.<br/></dd>
608 <dt><tt>cfrontend-1.4.i386-unknown-freebsd5.1.tar.gz</tt></dt>
609 <dd>This is the binary release of the GCC front end for FreeBSD/x86.<br/></dd>
611 <dt><tt>cfrontend-1.4.powerpc-apple-darwin7.6.0.tar.gz</tt></dt>
612 <dd>This is the binary release of the GCC front end for MacOS X/PPC.<br/></dd>
617 <!-- ======================================================================= -->
618 <div class="doc_subsection">
619 <a name="checkout">Checkout LLVM from CVS</a>
622 <div class="doc_text">
624 <p>If you have access to our CVS repository, you can get a fresh copy of
625 the entire source code. All you need to do is check it out from CVS as
629 <li><tt>cd <i>where-you-want-llvm-to-live</i></tt>
630 <li><tt>cvs -d :pserver:anon@llvm-cvs.cs.uiuc.edu:/var/cvs/llvm login</tt>
631 <li>Hit the return key when prompted for the password.
632 <li><tt>cvs -z3 -d :pserver:anon@llvm-cvs.cs.uiuc.edu:/var/cvs/llvm co
636 <p>This will create an '<tt>llvm</tt>' directory in the current
637 directory and fully populate it with the LLVM source code, Makefiles,
638 test directories, and local copies of documentation files.</p>
640 <p>If you want to get a specific release (as opposed to the most recent
641 revision), you can specify a label. The following releases have the following
645 <li>Release 1.4: <b>RELEASE_14</b></li>
646 <li>Release 1.3: <b>RELEASE_13</b></li>
647 <li>Release 1.2: <b>RELEASE_12</b></li>
648 <li>Release 1.1: <b>RELEASE_11</b></li>
649 <li>Release 1.0: <b>RELEASE_1</b></li>
652 <p>If you would like to get the LLVM test suite (a separate package as of 1.4),
653 you get it from the CVS repository:</p>
656 cvs -z3 -d :pserver:anon@llvm-cvs.cs.uiuc.edu:/var/cvs/llvm co llvm-test
658 <p>By placing it in the <tt>llvm/projects</tt>, it will be automatically
659 configured by the LLVM configure script as well as automatically updated when
660 you run <tt>cvs update</tt>.</p>
662 <p>If you would like to get the GCC front end source code, you can also get it
663 from the CVS repository:</p>
666 cvs -z3 -d :pserver:anon@llvm-cvs.cs.uiuc.edu:/var/cvs/llvm co llvm-gcc
669 <p>Please note that you must follow <a href="CFEBuildInstrs.html">these
670 instructions</a> to successfully build the LLVM GCC front-end.</p>
674 <!-- ======================================================================= -->
675 <div class="doc_subsubsection">
676 <a name="mirrors">LLVM CVS Mirrors</a>
679 <div class="doc_text">
681 <p>If the main CVS server is overloaded or inaccessible, you can try one of
682 these user-hosted mirrors:</p>
685 <li><a href="http://llvm.x10sys.com/">Mirror hosted by eXtensible Systems
690 <!-- ======================================================================= -->
691 <div class="doc_subsection">
692 <a name="installcf">Install the GCC Front End</a>
695 <div class="doc_text">
697 <p>Before configuring and compiling the LLVM suite, you need to extract the LLVM
698 GCC front end from the binary distribution. It is used for building the
699 bytecode libraries later used by the GCC front end for linking programs, and its
700 location must be specified when the LLVM suite is configured.</p>
702 <p>To install the GCC front end, do the following:</p>
705 <li><tt>cd <i>where-you-want-the-front-end-to-live</i></tt></li>
706 <li><tt>gunzip --stdout cfrontend-<i>version</i>.<i>platform</i>.tar.gz | tar -xvf
710 <p>Next, you will need to fix your system header files:</p>
712 <p><tt>cd cfrontend/<i>platform</i><br>
713 ./fixheaders</tt></p>
715 <p>The binary versions of the GCC front end may not suit all of your needs. For
716 example, the binary distribution may include an old version of a system header
717 file, not "fix" a header file that needs to be fixed for GCC, or it may be
718 linked with libraries not available on your system.</p>
720 <p>In cases like these, you may want to try <a
721 href="CFEBuildInstrs.html">building the GCC front end from source.</a> This is
722 not for the faint of heart, so be forewarned.</p>
726 <!-- ======================================================================= -->
727 <div class="doc_subsection">
728 <a name="config">Local LLVM Configuration</a>
731 <div class="doc_text">
733 <p>Once checked out from the CVS repository, the LLVM suite source code must be
734 configured via the <tt>configure</tt> script. This script sets variables in the
735 various <tt>*.in</tt> files, most notably <tt>llvm/Makefile.config</tt> and
736 <tt>llvm/include/Config/config.h</tt>. It also populates <i>OBJ_ROOT</i> with
737 the Makefiles needed to begin building LLVM.</p>
739 <p>The following environment variables are used by the <tt>configure</tt>
740 script to configure the build system:</p>
743 <tr><th>Variable</th><th>Purpose</th></tr>
746 <td>Tells <tt>configure</tt> which C compiler to use. By default,
747 <tt>configure</tt> will look for the first GCC C compiler in
748 <tt>PATH</tt>. Use this variable to override
749 <tt>configure</tt>'s default behavior.</td>
753 <td>Tells <tt>configure</tt> which C++ compiler to use. By default,
754 <tt>configure</tt> will look for the first GCC C++ compiler in
755 <tt>PATH</tt>. Use this variable to override
756 <tt>configure</tt>'s default behavior.</td>
760 <p>The following options can be used to set or enable LLVM specific options:</p>
763 <dt><i>--with-llvmgccdir</i></dt>
764 <dd>Path to the LLVM C/C++ FrontEnd to be used with this LLVM configuration.
765 The value of this option should specify the full pathname of the C/C++ Front
766 End to be used. If this option is not provided, the PATH will be searched for
767 a program named <i>llvm-gcc</i> and the C/C++ FrontEnd install directory will
768 be inferred from the path found. If the option is not given, and no llvm-gcc
769 can be found in the path then a warning will be produced by
770 <tt>configure</tt> indicating this situation. LLVM may still be built with
771 the <tt>tools-only</tt> target but attempting to build the runtime libraries
772 will fail as these libraries require llvm-gcc and llvm-g++. See
773 <a href="#installcf">Install the GCC Front End</a> for details on installing
774 the C/C++ Front End. See
775 <a href="CFEBuildInstrs.html">Bootstrapping the LLVM C/C++ Front-End</a>
776 for details on building the C/C++ Front End.</dd>
777 <dt><i>--with-tclinclude</i></dt>
778 <dd>Path to the tcl include directory under which the <tt>tclsh</tt> can be
779 found. Use this if you have multiple tcl installations on your machine and you
780 want to use a specific one (8.x) for LLVM. LLVM only uses tcl for running the
781 dejagnu based test suite in <tt>llvm/test</tt>. If you don't specify this
782 option, the LLVM configure script will search for tcl 8.4 and 8.3 releases.
785 <dt><i>--enable-optimized</i></dt>
787 Enables optimized compilation by default (debugging symbols are removed
788 and GCC optimization flags are enabled). The default is to use an
789 unoptimized build (also known as a debug build).
792 <dt><i>--enable-jit</i></dt>
794 Compile the Just In Time (JIT) compiler functionality. This is not
796 on all platforms. The default is dependent on platform, so it is best
797 to explicitly enable it if you want it.
800 <dt><i>--enable-doxygen</i></dt>
801 <dd>Look for the doxygen program and enable construction of doxygen based
802 documentation from the source code. This is disabled by default because
803 generating the documentation can take a long time and producess 100s of
804 megabytes of output.</dd>
807 <p>To configure LLVM, follow these steps:</p>
810 <li>Change directory into the object root directory:
812 <tt>cd <i>OBJ_ROOT</i></tt>
815 <li>Run the <tt>configure</tt> script located in the LLVM source tree:
817 <tt><i>SRC_ROOT</i>/configure --prefix=/install/path [other options]</tt>
823 <!-- ======================================================================= -->
824 <div class="doc_subsection">
825 <a name="compile">Compiling the LLVM Suite Source Code</a>
828 <div class="doc_text">
830 <p>Once you have configured LLVM, you can build it. There are three types of
836 These builds are the default when one types <tt>gmake</tt> (unless the
837 <tt>--enable-optimized</tt> option was used during configuration). The
838 build system will compile the tools and libraries with debugging
842 <dt>Release (Optimized) Builds
844 These builds are enabled with the <tt>--enable-optimized</tt> option to
845 <tt>configure</tt> or by specifying <tt>ENABLE_OPTIMIZED=1</tt> on the
846 <tt>gmake</tt> command line. For these builds, the build system will
847 compile the tools and libraries with GCC optimizations enabled and strip
848 debugging information from the libraries and executables it generates.
853 These builds are for use with profiling. They compile profiling
854 information into the code for use with programs like <tt>gprof</tt>.
855 Profile builds must be started by specifying <tt>ENABLE_PROFILING=1</tt>
856 on the <tt>gmake</tt> command line.
859 <p>Once you have LLVM configured, you can build it by entering the
860 <i>OBJ_ROOT</i> directory and issuing the following command:</p>
862 <p><tt>gmake</tt></p>
864 <p>If the build fails, please <a href="#brokengcc">check here</a> to see if you
865 are using a version of GCC that is known not to compile LLVM.</p>
868 If you have multiple processors in your machine, you may wish to use some of
869 the parallel build options provided by GNU Make. For example, you could use the
872 <p><tt>gmake -j2</tt></p>
874 <p>There are several special targets which are useful when working with the LLVM
878 <dt><tt>gmake clean</tt>
880 Removes all files generated by the build. This includes object files,
881 generated C/C++ files, libraries, and executables.
884 <dt><tt>gmake dist-clean</tt>
886 Removes everything that <tt>gmake clean</tt> does, but also removes files
887 generated by <tt>configure</tt>. It attempts to return the source tree to the
888 original state in which it was shipped.
891 <dt><tt>gmake install</tt>
893 Installs LLVM header files, libraries, tools, and documentation in a
895 under $PREFIX, specified with <tt>./configure --prefix=[dir]</tt>, which
896 defaults to <tt>/usr/local</tt>.
899 <dt><tt>gmake -C runtime install-bytecode</tt>
901 Assuming you built LLVM into $OBJDIR, when this command is run, it will
902 install bytecode libraries into the GCC front end's bytecode library
903 directory. If you need to update your bytecode libraries,
904 this is the target to use once you've built them.
908 <p>Please see the <a href="MakefileGuide.html">Makefile Guide</a> for further
909 details on these <tt>make</tt> targets and descriptions of other targets
912 <p>It is also possible to override default values from <tt>configure</tt> by
913 declaring variables on the command line. The following are some examples:</p>
916 <dt><tt>gmake ENABLE_OPTIMIZED=1</tt>
918 Perform a Release (Optimized) build.
921 <dt><tt>gmake ENABLE_PROFILING=1</tt>
923 Perform a Profiling build.
926 <dt><tt>gmake VERBOSE=1</tt>
928 Print what <tt>gmake</tt> is doing on standard output.
931 <dt><tt>gmake TOOL_VERBOSE=1</tt></dt>
932 <dd>Ask each tool invoked by the makefiles to print out what it is doing on
933 the standard output. This also implies <tt>VERBOSE=1</tt>.
937 <p>Every directory in the LLVM object tree includes a <tt>Makefile</tt> to build
938 it and any subdirectories that it contains. Entering any directory inside the
939 LLVM object tree and typing <tt>gmake</tt> should rebuild anything in or below
940 that directory that is out of date.</p>
944 <!-- ======================================================================= -->
945 <div class="doc_subsection">
946 <a name="objfiles">The Location of LLVM Object Files</a>
949 <div class="doc_text">
951 <p>The LLVM build system is capable of sharing a single LLVM source tree among
952 several LLVM builds. Hence, it is possible to build LLVM for several different
953 platforms or configurations using the same source tree.</p>
955 <p>This is accomplished in the typical autoconf manner:</p>
958 <li><p>Change directory to where the LLVM object files should live:</p>
960 <p><tt>cd <i>OBJ_ROOT</i></tt></p></li>
962 <li><p>Run the <tt>configure</tt> script found in the LLVM source
965 <p><tt><i>SRC_ROOT</i>/configure</tt></p></li>
968 <p>The LLVM build will place files underneath <i>OBJ_ROOT</i> in directories
969 named after the build type:</p>
976 <dd><tt><i>OBJ_ROOT</i>/Debug/bin</tt>
978 <dd><tt><i>OBJ_ROOT</i>/Debug/lib</tt>
986 <dd><tt><i>OBJ_ROOT</i>/Release/bin</tt>
988 <dd><tt><i>OBJ_ROOT</i>/Release/lib</tt>
996 <dd><tt><i>OBJ_ROOT</i>/Profile/bin</tt>
998 <dd><tt><i>OBJ_ROOT</i>/Profile/lib</tt>
1004 <!-- ======================================================================= -->
1005 <div class="doc_subsection">
1006 <a name="optionalconfig">Optional Configuration Items</a>
1009 <div class="doc_text">
1012 If you're running on a linux system that supports the "<a
1013 href="http://www.tat.physik.uni-tuebingen.de/~rguenth/linux/binfmt_misc.html">
1015 module, and you have root access on the system, you can set your system up to
1016 execute LLVM bytecode files directly. To do this, use commands like this (the
1017 first command may not be required if you are already using the module):</p>
1020 $ mount -t binfmt_misc none /proc/sys/fs/binfmt_misc
1021 $ echo ':llvm:M::llvm::/path/to/lli:' > /proc/sys/fs/binfmt_misc/register
1022 $ chmod u+x hello.bc (if needed)
1027 This allows you to execute LLVM bytecode files directly. Thanks to Jack
1028 Cummings for pointing this out!
1034 <!-- *********************************************************************** -->
1035 <div class="doc_section">
1036 <a name="layout"><b>Program Layout</b></a>
1038 <!-- *********************************************************************** -->
1040 <div class="doc_text">
1042 <p>One useful source of information about the LLVM source base is the LLVM <a
1043 href="http://www.doxygen.org">doxygen</a> documentation available at <tt><a
1044 href="http://llvm.cs.uiuc.edu/doxygen/">http://llvm.cs.uiuc.edu/doxygen/</a></tt>.
1045 The following is a brief introduction to code layout:</p>
1049 <!-- ======================================================================= -->
1050 <div class="doc_subsection"><a name="cvsdir"><tt>CVS</tt> directories</a></div>
1051 <div class="doc_text">
1052 <p>Every directory checked out of CVS will contain a <tt>CVS</tt> directory; for
1053 the most part these can just be ignored.</p>
1056 <!-- ======================================================================= -->
1057 <div class="doc_subsection"><a name="examples"><tt>llvm/examples</tt></a></div>
1058 <div class="doc_text">
1059 <p>This directory contains some simple examples of how to use the LLVM IR and
1063 <!-- ======================================================================= -->
1064 <div class="doc_subsection"><a name="include"><tt>llvm/include</tt></a></div>
1065 <div class="doc_text">
1067 <p>This directory contains public header files exported from the LLVM
1068 library. The three main subdirectories of this directory are:</p>
1071 <dt><tt><b>llvm/include/llvm</b></tt></dt>
1072 <dd>This directory contains all of the LLVM specific header files. This
1073 directory also has subdirectories for different portions of LLVM:
1074 <tt>Analysis</tt>, <tt>CodeGen</tt>, <tt>Target</tt>, <tt>Transforms</tt>,
1077 <dt><tt><b>llvm/include/llvm/Support</b></tt></dt>
1078 <dd>This directory contains generic support libraries that are provided with
1079 LLVM but not necessarily specific to LLVM. For example, some C++ STL utilities
1080 and a Command Line option processing library store their header files here.
1083 <dt><tt><b>llvm/include/llvm/Config</b></tt></dt>
1084 <dd>This directory contains header files configured by the <tt>configure</tt>
1085 script. They wrap "standard" UNIX and C header files. Source code can
1086 include these header files which automatically take care of the conditional
1087 #includes that the <tt>configure</tt> script generates.</dd>
1091 <!-- ======================================================================= -->
1092 <div class="doc_subsection"><a name="lib"><tt>llvm/lib</tt></a></div>
1093 <div class="doc_text">
1095 <p>This directory contains most of the source files of the LLVM system. In LLVM,
1096 almost all code exists in libraries, making it very easy to share code among the
1097 different <a href="#tools">tools</a>.</p>
1100 <dt><tt><b>llvm/lib/VMCore/</b></tt></dt>
1101 <dd> This directory holds the core LLVM source files that implement core
1102 classes like Instruction and BasicBlock.</dd>
1104 <dt><tt><b>llvm/lib/AsmParser/</b></tt></dt>
1105 <dd>This directory holds the source code for the LLVM assembly language parser
1108 <dt><tt><b>llvm/lib/ByteCode/</b></tt></dt>
1109 <dd>This directory holds code for reading and write LLVM bytecode.</dd>
1111 <dt><tt><b>llvm/lib/Analysis/</b></tt><dd>This directory contains a variety of
1112 different program analyses, such as Dominator Information, Call Graphs,
1113 Induction Variables, Interval Identification, Natural Loop Identification,
1116 <dt><tt><b>llvm/lib/Transforms/</b></tt></dt>
1117 <dd> This directory contains the source code for the LLVM to LLVM program
1118 transformations, such as Aggressive Dead Code Elimination, Sparse Conditional
1119 Constant Propagation, Inlining, Loop Invariant Code Motion, Dead Global
1120 Elimination, and many others.</dd>
1122 <dt><tt><b>llvm/lib/Target/</b></tt></dt>
1123 <dd> This directory contains files that describe various target architectures
1124 for code generation. For example, the <tt>llvm/lib/Target/SparcV9</tt>
1125 directory holds the Sparc machine description while
1126 <tt>llvm/lib/Target/CBackend</tt> implements the LLVM-to-C converter</dd>
1128 <dt><tt><b>llvm/lib/CodeGen/</b></tt></dt>
1129 <dd> This directory contains the major parts of the code generator: Instruction
1130 Selector, Instruction Scheduling, and Register Allocation.</dd>
1132 <dt><tt><b>llvm/lib/Debugger/</b></tt></dt>
1133 <dd> This directory contains the source level debugger library that makes
1134 it possible to instrument LLVM programs so that a debugger could identify
1135 source code locations at which the program is executing.</dd>
1137 <dt><tt><b>llvm/lib/ExecutionEngine/</b></tt></dt>
1138 <dd> This directory contains libraries for executing LLVM bytecode directly
1139 at runtime in both interpreted and JIT compiled fashions.</dd>
1141 <dt><tt><b>llvm/lib/Support/</b></tt></dt>
1142 <dd> This directory contains the source code that corresponds to the header
1143 files located in <tt>llvm/include/Support/</tt>.</dd>
1145 <dt><tt><b>llvm/lib/System/</b></tt></dt>
1146 <dd>This directory contains the operating system abstraction layer that
1147 shields LLVM from platform-specific coding.</dd>
1152 <!-- ======================================================================= -->
1153 <div class="doc_subsection"><a name="projects"><tt>llvm/projects</tt></a></div>
1154 <div class="doc_text">
1155 <p>This directory contains projects that are not strictly part of LLVM but are
1156 shipped with LLVM. This is also the directory where you should create your own
1157 LLVM-based projects. See <tt>llvm/projects/sample</tt> for an example of how
1158 to set up your own project. See <tt>llvm/projects/Stacker</tt> for a fully
1159 functional example of a compiler front end.</p>
1162 <!-- ======================================================================= -->
1163 <div class="doc_subsection"><a name="runtime"><tt>llvm/runtime</tt></a></div>
1164 <div class="doc_text">
1166 <p>This directory contains libraries which are compiled into LLVM bytecode and
1167 used when linking programs with the GCC front end. Most of these libraries are
1168 skeleton versions of real libraries; for example, libc is a stripped down
1169 version of glibc.</p>
1171 <p>Unlike the rest of the LLVM suite, this directory needs the LLVM GCC front
1176 <!-- ======================================================================= -->
1177 <div class="doc_subsection"><a name="test"><tt>llvm/test</tt></a></div>
1178 <div class="doc_text">
1179 <p>This directory contains feature and regression tests and other basic sanity
1180 checks on the LLVM infrastructure. These are intended to run quickly and cover
1181 a lot of territory without being exhaustive.</p>
1184 <!-- ======================================================================= -->
1185 <div class="doc_subsection"><a name="llvmtest"><tt>llvm-test</tt></a></div>
1186 <div class="doc_text">
1187 <p>This is not a directory in the normal llvm module; it is a separate CVS
1188 module that must be checked out (usually to <tt>projects/llvm-test</tt>). This
1189 module contains a comprehensive correctness, performance, and benchmarking
1191 suite for LLVM. It is a separate CVS module because not every LLVM user is
1192 interested in downloading or building such a comprehensive test. For further
1193 details on this test suite, please see the
1194 <a href="TestingGuide.html">Testing Guide</a> document.</p>
1197 <!-- ======================================================================= -->
1198 <div class="doc_subsection"><a name="tools"><tt>llvm/tools</tt></a></div>
1199 <div class="doc_text">
1201 <p>The <b>tools</b> directory contains the executables built out of the
1202 libraries above, which form the main part of the user interface. You can
1203 always get help for a tool by typing <tt>tool_name --help</tt>. The
1204 following is a brief introduction to the most important tools. More detailed
1205 information is in the <a href="CommandGuide/index.html">Command Guide</a>.</p>
1208 <dt><tt><b>analyze</b></tt></dt>
1209 <dd><tt>analyze</tt> is used to run a specific
1210 analysis on an input LLVM bytecode file and print out the results. It is
1211 primarily useful for debugging analyses, or familiarizing yourself with
1212 what an analysis does.</dd>
1214 <dt><tt><b>bugpoint</b></tt></dt>
1215 <dd><tt>bugpoint</tt> is used to debug
1216 optimization passes or code generation backends by narrowing down the
1217 given test case to the minimum number of passes and/or instructions that
1218 still cause a problem, whether it is a crash or miscompilation. See <a
1219 href="HowToSubmitABug.html">HowToSubmitABug.html</a> for more information
1220 on using <tt>bugpoint</tt>.</dd>
1222 <dt><tt><b>llvmc</b></tt></dt>
1223 <dd>The LLVM Compiler Driver. This program can
1224 be configured to utilize both LLVM and non-LLVM compilation tools to enable
1225 pre-processing, translation, optimization, assembly, and linking of programs
1226 all from one command line. <tt>llvmc</tt> also takes care of processing the
1227 dependent libraries found in bytecode. This reduces the need to get the
1228 traditional <tt>-l<name></tt> options right on the command line. Please
1229 note that this tool is new in 1.4 and considered experimental. It will be
1230 fully supported in 1.5.</dd>
1232 <dt><tt><b>llvm-ar</b></tt></dt>
1233 <dd>The archiver produces an archive containing
1234 the given LLVM bytecode files, optionally with an index for faster
1237 <dt><tt><b>llvm-as</b></tt></dt>
1238 <dd>The assembler transforms the human readable LLVM assembly to LLVM
1241 <dt><tt><b>llvm-dis</b></tt></dt>
1242 <dd>The disassembler transforms the LLVM bytecode to human readable
1245 <dt><tt><b>llvm-ld</b></tt></dt>
1246 <dd><tt>llvm-ld</tt> is very similar to gccld and provides a general purpose
1247 and extensible linker for LLVM. This is the linker invoked by <tt>llvmc</tt>.
1248 It allows optimization modules to be loaded so that language specific
1249 optimizations can be applied at link time. Please note that this tool is new
1250 in LLVM 1.4 and still considered experimental. It will be fully supported in
1253 <dt><tt><b>llvm-link</b></tt></dt>
1254 <dd><tt>llvm-link</tt>, not surprisingly, links multiple LLVM modules into
1255 a single program.</dd>
1257 <dt><tt><b>lli</b></tt></dt>
1258 <dd><tt>lli</tt> is the LLVM interpreter, which
1259 can directly execute LLVM bytecode (although very slowly...). In addition
1260 to a simple interpreter, <tt>lli</tt> also has a tracing mode (entered by
1261 specifying <tt>-trace</tt> on the command line). Finally, for
1262 architectures that support it (currently x86, Sparc, and PowerPC), by default,
1263 <tt>lli</tt> will function as a Just-In-Time compiler (if the
1264 functionality was compiled in), and will execute the code <i>much</i>
1265 faster than the interpreter.</dd>
1267 <dt><tt><b>llc</b></tt></dt>
1268 <dd> <tt>llc</tt> is the LLVM backend compiler, which
1269 translates LLVM bytecode to a SPARC or x86 assembly file, or to C code (with
1270 the -march=c option).</dd>
1272 <dt><tt><b>llvm-gcc</b></tt></dt>
1273 <dd><tt>llvm-gcc</tt> is a GCC-based C frontend
1274 that has been retargeted to emit LLVM code as the machine code output. It
1275 works just like any other GCC compiler, taking the typical <tt>-c, -S, -E,
1276 -o</tt> options that are typically used. The source code for the
1277 <tt>llvm-gcc</tt> tool is currently not included in the LLVM CVS tree
1278 because it is quite large and not very interesting.
1281 <dt><tt><b>gccas</b></tt></dt>
1282 <dd>This tool is invoked by the <tt>llvm-gcc</tt> frontend as the
1283 "assembler" part of the compiler. This tool actually assembles LLVM
1284 assembly to LLVM bytecode, performs a variety of optimizations, and
1285 outputs LLVM bytecode. Thus when you invoke
1286 <tt>llvm-gcc -c x.c -o x.o</tt>, you are causing <tt>gccas</tt> to be
1287 run, which writes the <tt>x.o</tt> file (which is an LLVM bytecode file
1288 that can be disassembled or manipulated just like any other bytecode
1289 file). The command line interface to <tt>gccas</tt> is designed to be
1290 as close as possible to the <b>system</b> `<tt>as</tt>' utility so that
1291 the gcc frontend itself did not have to be modified to interface to
1292 a "weird" assembler.</dd>
1294 <dt><tt><b>gccld</b></tt></dt>
1295 <dd><tt>gccld</tt> links together several LLVM bytecode files into one
1296 bytecode file and does some optimization. It is the linker invoked by
1297 the GCC frontend when multiple .o files need to be linked together.
1298 Like <tt>gccas</tt>, the command line interface of <tt>gccld</tt> is
1299 designed to match the system linker, to aid interfacing with the GCC
1305 <dt><tt><b>opt</b></tt></dt>
1306 <dd><tt>opt</tt> reads LLVM bytecode, applies a
1307 series of LLVM to LLVM transformations (which are specified on the command
1308 line), and then outputs the resultant bytecode. The '<tt>opt --help</tt>'
1309 command is a good way to get a list of the program transformations
1310 available in LLVM.</dd>
1314 <!-- ======================================================================= -->
1315 <div class="doc_subsection"><a name="utils"><tt>llvm/utils</tt></a></div>
1316 <div class="doc_text">
1318 <p>This directory contains utilities for working with LLVM source code, and some
1319 of the utilities are actually required as part of the build process because they
1320 are code generators for parts of LLVM infrastructure.</p>
1323 <dt><tt><b>Burg/</b></tt> <dd><tt>Burg</tt> is an instruction selector
1324 generator -- it builds trees on which it then performs pattern-matching to
1325 select instructions according to the patterns the user has specified. Burg
1326 is currently used in the Sparc V9 backend.<p>
1328 <dt><tt><b>codegen-diff</b></tt> <dd><tt>codegen-diff</tt> is a script
1329 that finds differences between code that LLC generates and code that LLI
1330 generates. This is a useful tool if you are debugging one of them,
1331 assuming that the other generates correct output. For the full user
1332 manual, run <tt>`perldoc codegen-diff'</tt>.<p>
1334 <dt><tt><b>cvsupdate</b></tt> <dd><tt>cvsupdate</tt> is a script that will
1335 update your CVS tree, but produce a much cleaner and more organized output
1336 than simply running <tt>`cvs -z3 up -dP'</tt> will. For example, it will group
1337 together all the new and updated files and modified files in separate
1338 sections, so you can see at a glance what has changed. If you are at the
1339 top of your LLVM CVS tree, running <tt>utils/cvsupdate</tt> is the
1340 preferred way of updating the tree.<p>
1342 <dt><tt><b>emacs/</b></tt> <dd>The <tt>emacs</tt> directory contains
1343 syntax-highlighting files which will work with Emacs and XEmacs editors,
1344 providing syntax highlighting support for LLVM assembly files and TableGen
1345 description files. For information on how to use the syntax files, consult
1346 the <tt>README</tt> file in that directory.<p>
1348 <dt><tt><b>getsrcs.sh</b></tt> <dd>The <tt>getsrcs.sh</tt> script finds
1349 and outputs all non-generated source files, which is useful if one wishes
1350 to do a lot of development across directories and does not want to
1351 individually find each file. One way to use it is to run, for example:
1352 <tt>xemacs `utils/getsources.sh`</tt> from the top of your LLVM source
1355 <dt><tt><b>llvmgrep</b></tt></dt>
1356 <dd>This little tool performs an "egrep -H -n" on each source file in LLVM and
1357 passes to it a regular expression provided on <tt>llvmgrep</tt>'s command
1358 line. This is a very efficient way of searching the source base for a
1359 particular regular expression.</dd>
1361 <dt><tt><b>makellvm</b></tt> <dd>The <tt>makellvm</tt> script compiles all
1362 files in the current directory and then compiles and links the tool that
1363 is the first argument. For example, assuming you are in the directory
1364 <tt>llvm/lib/Target/Sparc</tt>, if <tt>makellvm</tt> is in your path,
1365 simply running <tt>makellvm llc</tt> will make a build of the current
1366 directory, switch to directory <tt>llvm/tools/llc</tt> and build it,
1367 causing a re-linking of LLC.<p>
1369 <dt><tt><b>NightlyTest.pl</b></tt> and
1370 <tt><b>NightlyTestTemplate.html</b></tt> <dd>These files are used in a
1371 cron script to generate nightly status reports of the functionality of
1372 tools, and the results can be seen by following the appropriate link on
1373 the <a href="http://llvm.cs.uiuc.edu/">LLVM homepage</a>.<p>
1375 <dt><tt><b>TableGen/</b></tt> <dd>The <tt>TableGen</tt> directory contains
1376 the tool used to generate register descriptions, instruction set
1377 descriptions, and even assemblers from common TableGen description
1380 <dt><tt><b>vim/</b></tt> <dd>The <tt>vim</tt> directory contains
1381 syntax-highlighting files which will work with the VIM editor, providing
1382 syntax highlighting support for LLVM assembly files and TableGen
1383 description files. For information on how to use the syntax files, consult
1384 the <tt>README</tt> file in that directory.<p>
1390 <!-- ======================================================================= -->
1391 <div class="doc_subsection"><a name="win32"><tt>llvm/win32</tt></a></div>
1392 <div class="doc_text">
1393 <p>This directory contains build scripts and project files for use with
1394 Visual C++. This allows developers on Windows to build LLVM without the need
1395 for Cygwin. The contents of this directory should be considered experimental
1399 <!-- *********************************************************************** -->
1400 <div class="doc_section">
1401 <a name="tutorial">An Example Using the LLVM Tool Chain</a>
1403 <!-- *********************************************************************** -->
1405 <div class="doc_text">
1408 <li>First, create a simple C file, name it 'hello.c':
1410 #include <stdio.h>
1412 printf("hello world\n");
1417 <li><p>Next, compile the C file into a LLVM bytecode file:</p>
1418 <p><tt>% llvm-gcc hello.c -o hello</tt></p>
1420 <p>Note that you should have already built the tools and they have to be
1421 in your path, at least <tt>gccas</tt> and <tt>gccld</tt>.</p>
1423 <p>This will create two result files: <tt>hello</tt> and
1424 <tt>hello.bc</tt>. The <tt>hello.bc</tt> is the LLVM bytecode that
1425 corresponds the the compiled program and the library facilities that it
1426 required. <tt>hello</tt> is a simple shell script that runs the bytecode
1427 file with <tt>lli</tt>, making the result directly executable. Note that
1428 all LLVM optimizations are enabled by default, so there is no need for a
1429 "-O3" switch.</p></li>
1431 <li><p>Run the program. To make sure the program ran, execute one of the
1432 following commands:</p>
1434 <p><tt>% ./hello</tt></p>
1438 <p><tt>% lli hello.bc</tt></p></li>
1440 <li><p>Use the <tt>llvm-dis</tt> utility to take a look at the LLVM assembly
1443 <p><tt>% llvm-dis < hello.bc | less</tt><p></li>
1445 <li><p>Compile the program to native assembly using the LLC code
1448 <p><tt>% llc hello.bc -o hello.s</tt></p>
1450 <li><p>Assemble the native assembly language file into a program:</p>
1452 <p><b>Solaris:</b><tt>% /opt/SUNWspro/bin/cc -xarch=v9 hello.s -o hello.native</tt></p>
1453 <p><b>Others:</b><tt>% gcc hello.s -o hello.native</tt></p>
1455 <li><p>Execute the native code program:</p>
1457 <p><tt>% ./hello.native</tt></p></li>
1463 <!-- *********************************************************************** -->
1464 <div class="doc_section">
1465 <a name="problems">Common Problems</a>
1467 <!-- *********************************************************************** -->
1469 <div class="doc_text">
1471 <p>If you are having problems building or using LLVM, or if you have any other
1472 general questions about LLVM, please consult the <a href="FAQ.html">Frequently
1473 Asked Questions</a> page.</p>
1477 <!-- *********************************************************************** -->
1478 <div class="doc_section">
1479 <a name="links">Links</a>
1481 <!-- *********************************************************************** -->
1483 <div class="doc_text">
1485 <p>This document is just an <b>introduction</b> to how to use LLVM to do
1486 some simple things... there are many more interesting and complicated things
1487 that you can do that aren't documented here (but we'll gladly accept a patch
1488 if you want to write something up!). For more information about LLVM, check
1492 <li><a href="http://llvm.cs.uiuc.edu/">LLVM homepage</a></li>
1493 <li><a href="http://llvm.cs.uiuc.edu/doxygen/">LLVM doxygen tree</a></li>
1494 <li><a href="http://llvm.cs.uiuc.edu/docs/Projects.html">Starting a Project
1495 that Uses LLVM</a></li>
1500 <!-- *********************************************************************** -->
1504 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
1505 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
1506 <a href="http://validator.w3.org/check/referer"><img
1507 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
1509 <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
1510 <a href="http://llvm.x10sys.com/rspencer/">Reid Spencer</a><br>
1511 <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br>
1512 Last modified: $Date$