1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
5 <title>Getting Started with LLVM System</title>
6 <link rel="stylesheet" href="llvm.css" type="text/css">
10 <div class="doc_title">
11 Getting Started with the LLVM System
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>
19 <li><a href="#hardware">Hardware</a>
20 <li><a href="#software">Software</a>
21 <li><a href="#brokengcc">Broken versions of GCC</a>
24 <li><a href="#starting">Getting Started with LLVM</a>
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>
37 <li><a href="#layout">Program layout</a>
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>
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>
53 <div class="doc_author">
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>.
64 <!-- *********************************************************************** -->
65 <div class="doc_section">
66 <a name="overview"><b>Overview</b></a>
68 <!-- *********************************************************************** -->
70 <div class="doc_text">
72 <p>Welcome to LLVM! In order to get started, you first need to know some
73 basic information.</p>
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>
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>
89 <!-- *********************************************************************** -->
90 <div class="doc_section">
91 <a name="quickstart"><b>Getting Started Quickly (A Summary)</b></a>
93 <!-- *********************************************************************** -->
95 <div class="doc_text">
97 <p>Here's the short story for getting up and running quickly with LLVM:</p>
100 <li>Install the GCC front end:
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>
109 <li>Get the Source Code
111 <li>With the distributed files:
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>
118 <li>With anonymous CVS access (or use a <a href="#mirror">mirror</a>):
120 <li><tt>cd <i>where-you-want-llvm-to-live</i></tt></li>
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
126 <li><tt>cd llvm</tt></li>
130 <li>Configure the LLVM Build Environment
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:
136 <li><tt>--with-llvmgccdir=<i>directory</i></tt>
137 <p>Specify the full pathname of where the LLVM GCC frontend is
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>
146 <li>Build the LLVM Suite:
148 <li>Set your LLVM_LIB_SEARCH_PATH environment variable.</li>
149 <li><tt>gmake -k |& tee gnumake.out
150 # 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>
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>
164 <!-- *********************************************************************** -->
165 <div class="doc_section">
166 <a name="requirements"><b>Requirements</b></a>
168 <!-- *********************************************************************** -->
170 <div class="doc_text">
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>
178 <!-- ======================================================================= -->
179 <div class="doc_subsection">
180 <a name="hardware"><b>Hardware</b></a>
183 <div class="doc_text">
185 <p>LLVM is known to work on the following platforms:</p>
189 <li>Linux on x86 (Pentium and above)
191 <li>Approximately 2.6 GB of Free Disk Space
193 <li>Source code: 57 MB</li>
194 <li>Object code: 2.5 GB</li>
195 <li>GCC front end: 30 MB</li>
200 <li>Solaris on SparcV9 (Ultrasparc)
202 <li>Approximately 2.6 GB of Free Disk Space
204 <li>Source code: 57 MB</li>
205 <li>Object code: 2.5 GB</li>
206 <li>GCC front end: 46 MB</li>
211 <li>FreeBSD on x86 (Pentium and above)
213 <li>Approximately 1 GB of Free Disk Space
215 <li>Source code: 57 MB</li>
216 <li>Object code: 850 MB</li>
217 <li>GCC front end: 40 MB</li>
222 <li>MacOS X on PowerPC
224 <li>Experimental support for static native code generation
225 <li>Approximately 1.6 GB of Free Disk Space
227 <li>Source code: 57 MB</li>
228 <li>Object code: 1.5 GB</li>
229 <li>GCC front end: 36 MB</li>
236 <li><div class="doc_warning">No native code generation</div>
237 <li>Approximately 2 GB of Free Disk Space
239 <li>Source code: 92 MB</li>
240 <li>Object code: 2.8 GB</li>
241 <li>GCC front end: 123 MB</li>
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>
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>
260 <!-- ======================================================================= -->
261 <div class="doc_subsection">
262 <a name="software"><b>Software</b></a>
265 <div class="doc_text">
267 <p>Compiling LLVM requires that you have several software packages
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>
274 <li><a href="http://savannah.gnu.org/projects/make">GNU Make</a></li>
276 <li><a href="http://www.gnu.org/software/flex">Flex</a></li>
278 <li><a href="http://www.gnu.org/software/bison/bison.html">Bison</a></li>
281 <p>There are some additional tools that you may want to have when working with
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>
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
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>
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
304 <li><tt>cvs -d :pserver:anoncvs@cvs.codesourcery.com:/home/qm/Repository login</tt>
306 <li>When prompted, use <tt>anoncvs</tt> as the password.
308 <li><tt>cvs -d :pserver:anoncvs@cvs.codesourcery.com:/home/qm/Repository co -r release-2-0-3 qm</tt>
316 <!-- ======================================================================= -->
317 <div class="doc_subsection">
318 <a name="brokengcc">Broken versions of GCC</a>
321 <div class="doc_text">
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.
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.
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>
346 <!-- *********************************************************************** -->
347 <div class="doc_section">
348 <a name="starting"><b>Getting Started with LLVM</b></a>
350 <!-- *********************************************************************** -->
352 <div class="doc_text">
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>
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
364 <!-- ======================================================================= -->
365 <div class="doc_subsection">
366 <a name="terminology">Terminology and Notation</a>
369 <div class="doc_text">
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>
381 This is the top level directory of the LLVM source tree.
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).
393 This is the where the LLVM GCC Front End is installed.
395 For the pre-built GCC front end binaries, the LLVMGCCDIR is
396 <tt>cfrontend/<i>platform</i>/llvm-gcc</tt>.
401 <!-- ======================================================================= -->
402 <div class="doc_subsection">
403 <a name="environment">Setting Up Your Environment</a>
406 <div class="doc_text">
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>.
415 <dt><tt>LLVM_LIB_SEARCH_PATH</tt>=<tt><i>LLVMGCCDIR</i>/bytecode-libs</tt>
417 This environment variable helps the LLVM GCC front end find bytecode
418 libraries that it will need for compilation.
421 <dt>alias llvmgcc <i>LLVMGCCDIR</i><tt>/bin/gcc</tt>
422 <dt>alias llvmg++ <i>LLVMGCCDIR</i><tt>/bin/g++</tt>
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.
430 <!-- ======================================================================= -->
431 <div class="doc_subsection">
432 <a name="unpack">Unpacking the LLVM Archives</a>
435 <div class="doc_text">
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.
444 <p> The files are as follows:
447 <dd>This is the source code to the LLVM suite.
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.
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.
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.
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.
468 <!-- ======================================================================= -->
469 <div class="doc_subsection">
470 <a name="checkout">Checkout LLVM from CVS</a>
473 <div class="doc_text">
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
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
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>
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
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>
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>
506 cvs -z3 -d :pserver:anon@llvm-cvs.cs.uiuc.edu:/var/cvs/llvm co llvm-gcc
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>
514 <!-- ======================================================================= -->
515 <div class="doc_subsubsection">
516 <a name="mirrors">LLVM CVS Mirrors</a>
519 <div class="doc_text">
521 <p>If the main CVS server is overloaded or inaccessible, you can try one of
522 these user-hosted mirrors:</p>
525 <li><a href="http://llvm.x10sys.com/">Mirror hosted by eXtensible Systems
530 <!-- ======================================================================= -->
531 <div class="doc_subsection">
532 <a name="installcf">Install the GCC Front End</a>
535 <div class="doc_text">
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>
542 <p>To install the GCC front end, do the following:</p>
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
550 <p>If you are using Solaris/Sparc or MacOS X/PPC, you will need to fix the
553 <p><tt>cd cfrontend/<i>platform</i><br>
554 ./fixheaders</tt></p>
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>
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>
567 <!-- ======================================================================= -->
568 <div class="doc_subsection">
569 <a name="config">Local LLVM Configuration</a>
572 <div class="doc_text">
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
580 <p>The following environment variables are used by the <tt>configure</tt>
581 script to configure the build system:</p>
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>
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>
606 <p>The following options can be used to set or enable LLVM specific options:</p>
609 <dt><i>--with-llvmgccdir=LLVMGCCDIR</i>
611 Path to the location where the LLVM GCC front end binaries and
612 associated libraries were installed. This must be specified as an
615 <dt><i>--enable-optimized</i>
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).
621 <dt><i>--enable-jit</i>
623 Compile the Just In Time (JIT) compiler functionality. This is not
625 on all platforms. The default is dependent on platform, so it is best
626 to explicitly enable it if you want it.
628 <dt><i>--enable-spec2000</i>
629 <dt><i>--enable-spec2000=<<tt>directory</tt>></i>
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>.
638 <dt><i>--enable-spec95</i>
639 <dt><i>--enable-spec95=<<tt>directory</tt>></i>
641 Enable the use of SPEC95 when testing LLVM. It is similar to the
642 <i>--enable-spec2000</i> option.
644 <dt><i>--enable-povray</i>
645 <dt><i>--enable-povray=<<tt>directory</tt>></i>
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>
652 <p>To configure LLVM, follow these steps:</p>
655 <li>Change directory into the object root directory:
657 <tt>cd <i>OBJ_ROOT</i></tt>
660 <li>Run the <tt>configure</tt> script located in the LLVM source tree:
662 <tt><i>SRC_ROOT</i>/configure</tt>
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>
678 <!-- ======================================================================= -->
679 <div class="doc_subsection">
680 <a name="compile">Compiling the LLVM Suite Source Code</a>
683 <div class="doc_text">
685 <p>Once you have configured LLVM, you can build it. There are three types of
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
697 <dt>Release (Optimized) Builds
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.
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.
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>
717 <p><tt>gmake</tt></p>
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>
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
727 <p><tt>gmake -j2</tt></p>
729 <p>There are several special targets which are useful when working with the LLVM
733 <dt><tt>gmake clean</tt>
735 Removes all files generated by the build. This includes object files,
736 generated C/C++ files, libraries, and executables.
739 <dt><tt>gmake distclean</tt>
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.
746 <dt><tt>gmake install</tt>
748 Installs LLVM libraries and tools in a heirarchy under $PREFIX, specified with
749 <tt>./configure --prefix=[dir]</tt>, defaults to <tt>/usr/local</tt>.
752 <dt><tt>gmake install-bytecode</tt>
754 Assuming you built LLVM into $OBJDIR, when this command is run in
755 $OBJDIR/runtime, it will install bytecode libraries into the GCC front end's
756 bytecode library directory. If you need to update your bytecode libraries,
757 this is the target to use once you've built them.
761 <p>It is also possible to override default values from <tt>configure</tt> by
762 declaring variables on the command line. The following are some examples:</p>
765 <dt><tt>gmake ENABLE_OPTIMIZED=1</tt>
767 Perform a Release (Optimized) build.
770 <dt><tt>gmake ENABLE_PROFILING=1</tt>
772 Perform a Profiling build.
775 <dt><tt>gmake VERBOSE=1</tt>
777 Print what <tt>gmake</tt> is doing on standard output.
781 <p>Every directory in the LLVM object tree includes a <tt>Makefile</tt> to build
782 it and any subdirectories that it contains. Entering any directory inside the
783 LLVM object tree and typing <tt>gmake</tt> should rebuild anything in or below
784 that directory that is out of date.</p>
788 <!-- ======================================================================= -->
789 <div class="doc_subsection">
790 <a name="objfiles">The Location of LLVM Object Files</a>
793 <div class="doc_text">
795 <p>The LLVM build system is capable of sharing a single LLVM source tree among
796 several LLVM builds. Hence, it is possible to build LLVM for several different
797 platforms or configurations using the same source tree.</p>
799 <p>This is accomplished in the typical autoconf manner:</p>
802 <li><p>Change directory to where the LLVM object files should live:</p>
804 <p><tt>cd <i>OBJ_ROOT</i></tt></p></li>
806 <li><p>Run the <tt>configure</tt> script found in the LLVM source
809 <p><tt><i>SRC_ROOT</i>/configure</tt></p></li>
812 <p>The LLVM build will place files underneath <i>OBJ_ROOT</i> in directories
813 named after the build type:</p>
820 <dd><tt><i>OBJ_ROOT</i>/tools/Debug</tt>
822 <dd><tt><i>OBJ_ROOT</i>/lib/Debug</tt>
830 <dd><tt><i>OBJ_ROOT</i>/tools/Release</tt>
832 <dd><tt><i>OBJ_ROOT</i>/lib/Release</tt>
840 <dd><tt><i>OBJ_ROOT</i>/tools/Profile</tt>
842 <dd><tt><i>OBJ_ROOT</i>/lib/Profile</tt>
848 <!-- ======================================================================= -->
849 <div class="doc_subsection">
850 <a name="optionalconfig">Optional Configuration Items</a>
853 <div class="doc_text">
856 If you're running on a linux system that supports the "<a
857 href="http://www.tat.physik.uni-tuebingen.de/~rguenth/linux/binfmt_misc.html">binfmt_misc</a>"
858 module, and you have root access on the system, you can set your system up to
859 execute LLVM bytecode files directly. To do this, use commands like this (the
860 first command may not be required if you are already using the module):</p>
863 $ mount -t binfmt_misc none /proc/sys/fs/binfmt_misc
864 $ echo ':llvm:M::llvm::/path/to/lli:' > /proc/sys/fs/binfmt_misc/register
865 $ chmod u+x hello.bc (if needed)
870 This allows you to execute LLVM bytecode files directly. Thanks to Jack
871 Cummings for pointing this out!
877 <!-- *********************************************************************** -->
878 <div class="doc_section">
879 <a name="layout"><b>Program Layout</b></a>
881 <!-- *********************************************************************** -->
883 <div class="doc_text">
885 <p>One useful source of information about the LLVM source base is the LLVM <a
886 href="http://www.doxygen.org">doxygen</a> documentation available at <tt><a
887 href="http://llvm.cs.uiuc.edu/doxygen/">http://llvm.cs.uiuc.edu/doxygen/</a></tt>.
888 The following is a brief introduction to code layout:</p>
892 <!-- ======================================================================= -->
893 <div class="doc_subsection">
894 <a name="cvsdir"><tt>CVS</tt> directories</a>
897 <div class="doc_text">
899 <p>Every directory checked out of CVS will contain a <tt>CVS</tt> directory; for
900 the most part these can just be ignored.</p>
904 <!-- ======================================================================= -->
905 <div class="doc_subsection">
906 <a name="include"><tt>llvm/include</tt></a>
909 <div class="doc_text">
911 <p>This directory contains public header files exported from the LLVM
912 library. The three main subdirectories of this directory are:</p>
915 <li><tt>llvm/include/llvm</tt> - This directory contains all of the LLVM
916 specific header files. This directory also has subdirectories for
917 different portions of LLVM: <tt>Analysis</tt>, <tt>CodeGen</tt>,
918 <tt>Target</tt>, <tt>Transforms</tt>, etc...</li>
920 <li><tt>llvm/include/Support</tt> - This directory contains generic
921 support libraries that are independent of LLVM, but are used by LLVM.
922 For example, some C++ STL utilities and a Command Line option processing
923 library store their header files here.</li>
925 <li><tt>llvm/include/Config</tt> - This directory contains header files
926 configured by the <tt>configure</tt> script. They wrap "standard" UNIX
927 and C header files. Source code can include these header files which
928 automatically take care of the conditional #includes that the
929 <tt>configure</tt> script generates.</li>
934 <!-- ======================================================================= -->
935 <div class="doc_subsection">
936 <a name="lib"><tt>llvm/lib</tt></a>
939 <div class="doc_text">
941 <p>This directory contains most of the source files of the LLVM system. In LLVM,
942 almost all code exists in libraries, making it very easy to share code among the
943 different <a href="#tools">tools</a>.</p>
946 <dt><tt>llvm/lib/VMCore/</tt><dd> This directory holds the core LLVM
947 source files that implement core classes like Instruction and BasicBlock.
949 <dt><tt>llvm/lib/AsmParser/</tt><dd> This directory holds the source code
950 for the LLVM assembly language parser library.
952 <dt><tt>llvm/lib/ByteCode/</tt><dd> This directory holds code for reading
953 and write LLVM bytecode.
955 <dt><tt>llvm/lib/CWriter/</tt><dd> This directory implements the LLVM to C
958 <dt><tt>llvm/lib/Analysis/</tt><dd> This directory contains a variety of
959 different program analyses, such as Dominator Information, Call Graphs,
960 Induction Variables, Interval Identification, Natural Loop Identification,
963 <dt><tt>llvm/lib/Transforms/</tt><dd> This directory contains the source
964 code for the LLVM to LLVM program transformations, such as Aggressive Dead
965 Code Elimination, Sparse Conditional Constant Propagation, Inlining, Loop
966 Invariant Code Motion, Dead Global Elimination, and many others...
968 <dt><tt>llvm/lib/Target/</tt><dd> This directory contains files that
969 describe various target architectures for code generation. For example,
970 the llvm/lib/Target/SparcV9 directory holds the Sparc machine
973 <dt><tt>llvm/lib/CodeGen/</tt><dd> This directory contains the major parts
974 of the code generator: Instruction Selector, Instruction Scheduling, and
977 <dt><tt>llvm/lib/Support/</tt><dd> This directory contains the source code
978 that corresponds to the header files located in
979 <tt>llvm/include/Support/</tt>.
984 <!-- ======================================================================= -->
985 <div class="doc_subsection">
986 <a name="runtime"><tt>llvm/runtime</tt></a>
989 <div class="doc_text">
991 <p>This directory contains libraries which are compiled into LLVM bytecode and
992 used when linking programs with the GCC front end. Most of these libraries are
993 skeleton versions of real libraries; for example, libc is a stripped down
994 version of glibc.</p>
996 <p>Unlike the rest of the LLVM suite, this directory needs the LLVM GCC front
1001 <!-- ======================================================================= -->
1002 <div class="doc_subsection">
1003 <a name="test"><tt>llvm/test</tt></a>
1006 <div class="doc_text">
1008 <p>This directory contains regression tests and source code that is used to test
1009 the LLVM infrastructure.</p>
1013 <!-- ======================================================================= -->
1014 <div class="doc_subsection">
1015 <a name="tools"><tt>llvm/tools</tt></a>
1018 <div class="doc_text">
1020 <p>The <b>tools</b> directory contains the executables built out of the
1021 libraries above, which form the main part of the user interface. You can
1022 always get help for a tool by typing <tt>tool_name --help</tt>. The
1023 following is a brief introduction to the most important tools:</p>
1026 <dt><tt><b>analyze</b></tt> <dd><tt>analyze</tt> is used to run a specific
1027 analysis on an input LLVM bytecode file and print out the results. It is
1028 primarily useful for debugging analyses, or familiarizing yourself with
1029 what an analysis does.<p>
1031 <dt><tt><b>bugpoint</b></tt> <dd><tt>bugpoint</tt> is used to debug
1032 optimization passes or code generation backends by narrowing down the
1033 given test case to the minimum number of passes and/or instructions that
1034 still cause a problem, whether it is a crash or miscompilation. See <a
1035 href="HowToSubmitABug.html">HowToSubmitABug.html</a> for more information
1036 on using <tt>bugpoint</tt>.<p>
1038 <dt><tt><b>llvm-ar</b></tt> <dd>The archiver produces an archive containing
1039 the given LLVM bytecode files, optionally with an index for faster
1042 <dt><tt><b>llvm-as</b></tt> <dd>The assembler transforms the human readable
1043 LLVM assembly to LLVM bytecode.<p>
1045 <dt><tt><b>llvm-dis</b></tt><dd>The disassembler transforms the LLVM
1046 bytecode to human readable LLVM assembly.<p>
1048 <dt><tt><b>llvm-link</b></tt><dd> <tt>llvm-link</tt>, not surprisingly,
1049 links multiple LLVM modules into a single program.<p>
1051 <dt><tt><b>lli</b></tt><dd> <tt>lli</tt> is the LLVM interpreter, which
1052 can directly execute LLVM bytecode (although very slowly...). In addition
1053 to a simple interpreter, <tt>lli</tt> also has a tracing mode (entered by
1054 specifying <tt>-trace</tt> on the command line). Finally, for
1055 architectures that support it (currently only x86 and Sparc), by default,
1056 <tt>lli</tt> will function as a Just-In-Time compiler (if the
1057 functionality was compiled in), and will execute the code <i>much</i>
1058 faster than the interpreter.<p>
1060 <dt><tt><b>llc</b></tt><dd> <tt>llc</tt> is the LLVM backend compiler, which
1061 translates LLVM bytecode to a SPARC or x86 assembly file, or to C code (with
1062 the -march=c option).<p>
1064 <dt><tt><b>llvmgcc</b></tt><dd> <tt>llvmgcc</tt> is a GCC-based C frontend
1065 that has been retargeted to emit LLVM code as the machine code output. It
1066 works just like any other GCC compiler, taking the typical <tt>-c, -S, -E,
1067 -o</tt> options that are typically used. The source code for the
1068 <tt>llvmgcc</tt> tool is currently not included in the LLVM CVS tree
1069 because it is quite large and not very interesting.<p>
1073 <dt><tt><b>gccas</b></tt> <dd>This tool is invoked by the
1074 <tt>llvmgcc</tt> frontend as the "assembler" part of the compiler. This
1075 tool actually assembles LLVM assembly to LLVM bytecode,
1076 performs a variety of optimizations, and outputs LLVM bytecode. Thus
1077 when you invoke <tt>llvmgcc -c x.c -o x.o</tt>, you are causing
1078 <tt>gccas</tt> to be run, which writes the <tt>x.o</tt> file (which is
1079 an LLVM bytecode file that can be disassembled or manipulated just like
1080 any other bytecode file). The command line interface to <tt>gccas</tt>
1081 is designed to be as close as possible to the <b>system</b>
1082 `<tt>as</tt>' utility so that the gcc frontend itself did not have to be
1083 modified to interface to a "weird" assembler.<p>
1085 <dt><tt><b>gccld</b></tt> <dd><tt>gccld</tt> links together several LLVM
1086 bytecode files into one bytecode file and does some optimization. It is
1087 the linker invoked by the GCC frontend when multiple .o files need to be
1088 linked together. Like <tt>gccas</tt>, the command line interface of
1089 <tt>gccld</tt> is designed to match the system linker, to aid
1090 interfacing with the GCC frontend.</dl><p>
1093 <dt><tt><b>opt</b></tt><dd> <tt>opt</tt> reads LLVM bytecode, applies a
1094 series of LLVM to LLVM transformations (which are specified on the command
1095 line), and then outputs the resultant bytecode. The '<tt>opt --help</tt>'
1096 command is a good way to get a list of the program transformations
1103 <!-- ======================================================================= -->
1104 <div class="doc_subsection">
1105 <a name="utils"><tt>llvm/utils</tt></a>
1108 <div class="doc_text">
1110 <p>This directory contains utilities for working with LLVM source code, and some
1111 of the utilities are actually required as part of the build process because they
1112 are code generators for parts of LLVM infrastructure.</p>
1115 <dt><tt><b>Burg/</b></tt> <dd><tt>Burg</tt> is an instruction selector
1116 generator -- it builds trees on which it then performs pattern-matching to
1117 select instructions according to the patterns the user has specified. Burg
1118 is currently used in the Sparc V9 backend.<p>
1120 <dt><tt><b>codegen-diff</b></tt> <dd><tt>codegen-diff</tt> is a script
1121 that finds differences between code that LLC generates and code that LLI
1122 generates. This is a useful tool if you are debugging one of them,
1123 assuming that the other generates correct output. For the full user
1124 manual, run <tt>`perldoc codegen-diff'</tt>.<p>
1126 <dt><tt><b>cvsupdate</b></tt> <dd><tt>cvsupdate</tt> is a script that will
1127 update your CVS tree, but produce a much cleaner and more organized output
1128 than simply running <tt>`cvs -z3 up -dP'</tt> will. For example, it will group
1129 together all the new and updated files and modified files in separate
1130 sections, so you can see at a glance what has changed. If you are at the
1131 top of your LLVM CVS tree, running <tt>utils/cvsupdate</tt> is the
1132 preferred way of updating the tree.<p>
1134 <dt><tt><b>emacs/</b></tt> <dd>The <tt>emacs</tt> directory contains
1135 syntax-highlighting files which will work with Emacs and XEmacs editors,
1136 providing syntax highlighting support for LLVM assembly files and TableGen
1137 description files. For information on how to use the syntax files, consult
1138 the <tt>README</tt> file in that directory.<p>
1140 <dt><tt><b>getsrcs.sh</b></tt> <dd>The <tt>getsrcs.sh</tt> script finds
1141 and outputs all non-generated source files, which is useful if one wishes
1142 to do a lot of development across directories and does not want to
1143 individually find each file. One way to use it is to run, for example:
1144 <tt>xemacs `utils/getsources.sh`</tt> from the top of your LLVM source
1147 <dt><tt><b>makellvm</b></tt> <dd>The <tt>makellvm</tt> script compiles all
1148 files in the current directory and then compiles and links the tool that
1149 is the first argument. For example, assuming you are in the directory
1150 <tt>llvm/lib/Target/Sparc</tt>, if <tt>makellvm</tt> is in your path,
1151 simply running <tt>makellvm llc</tt> will make a build of the current
1152 directory, switch to directory <tt>llvm/tools/llc</tt> and build it,
1153 causing a re-linking of LLC.<p>
1155 <dt><tt><b>NightlyTest.pl</b></tt> and
1156 <tt><b>NightlyTestTemplate.html</b></tt> <dd>These files are used in a
1157 cron script to generate nightly status reports of the functionality of
1158 tools, and the results can be seen by following the appropriate link on
1159 the <a href="http://llvm.cs.uiuc.edu/">LLVM homepage</a>.<p>
1161 <dt><tt><b>TableGen/</b></tt> <dd>The <tt>TableGen</tt> directory contains
1162 the tool used to generate register descriptions, instruction set
1163 descriptions, and even assemblers from common TableGen description
1166 <dt><tt><b>vim/</b></tt> <dd>The <tt>vim</tt> directory contains
1167 syntax-highlighting files which will work with the VIM editor, providing
1168 syntax highlighting support for LLVM assembly files and TableGen
1169 description files. For information on how to use the syntax files, consult
1170 the <tt>README</tt> file in that directory.<p>
1176 <!-- *********************************************************************** -->
1177 <div class="doc_section">
1178 <a name="tutorial">An Example Using the LLVM Tool Chain</a>
1180 <!-- *********************************************************************** -->
1182 <div class="doc_text">
1185 <li>First, create a simple C file, name it 'hello.c':
1187 #include <stdio.h>
1189 printf("hello world\n");
1194 <li><p>Next, compile the C file into a LLVM bytecode file:</p>
1195 <p><tt>% llvmgcc hello.c -o hello</tt></p>
1197 <p>Note that you should have already built the tools and they have to be
1198 in your path, at least <tt>gccas</tt> and <tt>gccld</tt>.</p>
1200 <p>This will create two result files: <tt>hello</tt> and
1201 <tt>hello.bc</tt>. The <tt>hello.bc</tt> is the LLVM bytecode that
1202 corresponds the the compiled program and the library facilities that it
1203 required. <tt>hello</tt> is a simple shell script that runs the bytecode
1204 file with <tt>lli</tt>, making the result directly executable. Note that
1205 all LLVM optimizations are enabled by default, so there is no need for a
1206 "-O3" switch.</p></li>
1208 <li><p>Run the program. To make sure the program ran, execute one of the
1209 following commands:</p>
1211 <p><tt>% ./hello</tt></p>
1215 <p><tt>% lli hello.bc</tt></p></li>
1217 <li><p>Use the <tt>llvm-dis</tt> utility to take a look at the LLVM assembly
1220 <p><tt>% llvm-dis < hello.bc | less</tt><p></li>
1222 <li><p>Compile the program to native assembly using the LLC code
1225 <p><tt>% llc hello.bc -o hello.s</tt></p>
1227 <li><p>Assemble the native assembly language file into a program:</p>
1229 <p><b>Solaris:</b><tt>% /opt/SUNWspro/bin/cc -xarch=v9 hello.s -o hello.native</tt></p>
1230 <p><b>Others:</b><tt>% gcc hello.s -o hello.native</tt></p>
1232 <li><p>Execute the native code program:</p>
1234 <p><tt>% ./hello.native</tt></p></li>
1240 <!-- *********************************************************************** -->
1241 <div class="doc_section">
1242 <a name="problems">Common Problems</a>
1244 <!-- *********************************************************************** -->
1246 <div class="doc_text">
1248 <p>If you are having problems building or using LLVM, or if you have any other
1249 general questions about LLVM, please consult the <a href="FAQ.html">Frequently
1250 Asked Questions</a> page.</p>
1254 <!-- *********************************************************************** -->
1255 <div class="doc_section">
1256 <a name="links">Links</a>
1258 <!-- *********************************************************************** -->
1260 <div class="doc_text">
1262 <p>This document is just an <b>introduction</b> to how to use LLVM to do
1263 some simple things... there are many more interesting and complicated things
1264 that you can do that aren't documented here (but we'll gladly accept a patch
1265 if you want to write something up!). For more information about LLVM, check
1269 <li><a href="http://llvm.cs.uiuc.edu/">LLVM homepage</a></li>
1270 <li><a href="http://llvm.cs.uiuc.edu/doxygen/">LLVM doxygen tree</a></li>
1271 <li><a href="http://llvm.cs.uiuc.edu/docs/Projects.html">Starting a Project
1272 that Uses LLVM</a></li>
1277 <!-- *********************************************************************** -->
1281 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
1282 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
1283 <a href="http://validator.w3.org/check/referer"><img
1284 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
1286 <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
1287 <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br>
1288 Last modified: $Date$