Before you begin to use the LLVM system, review the requirements given below. This may save you some trouble by knowing ahead of time what hardware and software you will need.

- -

- Hardware -

+ Hardware +

LLVM is known to work on the following platforms:

@@ -268,7 +266,8 @@ software you will need.

MinGW/Win32 x86^{1,6,
- 8, 10} + 8, 10, + 11 GCC 3.4.X, binutils 2.20 @@ -311,6 +310,11 @@ software you will need.

Itanium (IA-64) HP aCC + + Windows x64 + x86-64 + mingw-w64's GCC-4.5.x¹² +

Notes:

@@ -337,9 +341,10 @@ up before any Windows-based versions such as Strawberry Perl and ActivePerl, as these have Windows-specifics that will cause the build to fail. -

In general, LLVM modules requiring dynamic linking can - not be built on Windows. However, you can build LLVM tools using - "make tools-only".

To use LLVM modules on Win32-based system, + you may configure LLVM with "--enable-shared".

To compile SPU backend, you need to add + "LDFLAGS=-Wl,--stack,16777216" to configure.

@@ -363,8 +368,10 @@ href="GCCFEBuildInstrs.html">try to compile it on your platform.

Software

Compiling LLVM requires that you have several software packages installed. The table below lists those required packages. The Package column is the usual name for the software package that LLVM depends on. The Version @@ -380,13 +387,13 @@ href="GCCFEBuildInstrs.html">try to compile it on your platform.

- GCC + GCC 3.4.2 C/C++ compiler¹ - TeXinfo + TeXinfo 4.5 For building the CFE @@ -397,6 +404,11 @@ href="GCCFEBuildInstrs.html">try to compile it on your platform.

Subversion access to LLVM² + + DejaGnu 1.4.2 @@ -428,13 +440,13 @@ href="GCCFEBuildInstrs.html">try to compile it on your platform.

- GNU Autoconf + GNU Autoconf 2.60 Configuration script builder⁴ - GNU Automake + GNU Automake 1.9.6 aclocal macro generator⁴ @@ -496,11 +508,11 @@ href="GCCFEBuildInstrs.html">try to compile it on your platform.

Broken versions of GCC and other tools -

+ -

LLVM is very demanding of the host C++ compiler, and as such tends to expose bugs in the compiler. In particular, several versions of GCC crash when trying @@ -593,15 +605,15 @@ upgrading to a newer version of Gold.

- +

- Getting Started with LLVM -

+ Getting Started with LLVM +

The remainder of this guide is meant to get you up and running with LLVM and to give you some basic information about the LLVM environment.

@@ -611,14 +623,13 @@ href="#layout">general layout of the the LLVM source tree, a simple example using the LLVM tool chain, and links to find more information about LLVM or to get help via e-mail.

Terminology and Notation -

+ -

Throughout this manual, the following names are used to denote paths specific to the local system and working environment. These are not @@ -651,11 +662,11 @@ All these paths are absolute:

-
+
Setting Up Your Environment -
+ -
+

In order to compile and use LLVM, you may need to set some environment @@ -674,11 +685,11 @@ variables.
-
+
Unpacking the LLVM Archives -
+ -
+

If you have the LLVM distribution, you will need to unpack it before you @@ -708,11 +719,11 @@ compressed with the gzip program.
-
+
Checkout LLVM from Subversion -
+ -
+

If you have access to our Subversion repository, you can get a fresh copy of the entire source code. All you need to do is check it out from Subversion as @@ -736,6 +747,7 @@ revision), you can checkout it from the 'tags' directory (instead of subdirectories of the 'tags' directory:

+
Release 2.9: RELEASE_29/final

Release 2.8: RELEASE_28

Release 2.7: RELEASE_27

Release 2.6: RELEASE_26
@@ -778,30 +790,30 @@ instructions to successfully get and build the LLVM GCC front-end.

-
+
GIT mirror -
+ -
+

GIT mirrors are available for a number of LLVM subprojects. These mirrors sync automatically with each Subversion commit and contain all necessary git-svn marks (so, you can recreate git-svn metadata locally). Note that right now mirrors reflect only trunk for each project. You can do the - read-only GIT clone of LLVM via: + read-only GIT clone of LLVM via:
+
% git clone http://llvm.org/git/llvm.git
-

-
+
Install the GCC Front End -
+ -
+

Before configuring and compiling the LLVM suite (or if you want to use just the LLVM GCC front end) you can optionally extract the front end from the binary distribution. @@ -810,7 +822,7 @@ you can optionally build llvm-gcc yourself a main LLVM repository.

To install the GCC front end, do the following (on Windows, use an archival tool -like 7-zip that understands gzipped tars):
+like 7-zip that understands gzipped tars):

cd where-you-want-the-front-end-to-live
@@ -867,11 +879,11 @@ please let us know how you would like to see things improved by dropping us a no
-
+
Local LLVM Configuration -
+ -
+

Once checked out from the Subversion repository, the LLVM suite source code must be @@ -989,11 +1001,11 @@ script to configure the build system:

-
+
Compiling the LLVM Suite Source Code -
+ -
+

Once you have configured LLVM, you can build it. There are three types of builds:
@@ -1123,11 +1135,11 @@ that directory that is out of date.

-
+
Cross-Compiling LLVM -
+ -
+

It is possible to cross-compile LLVM itself. That is, you can create LLVM executables and libraries to be hosted on a platform different from the platform where they are build (a Canadian Cross build). To configure a @@ -1141,11 +1153,11 @@ that directory that is out of date.

-
+
The Location of LLVM Object Files -
+ -
+

The LLVM build system is capable of sharing a single LLVM source tree among several LLVM builds. Hence, it is possible to build LLVM for several different @@ -1201,11 +1213,11 @@ named after the build type:

-
+
Optional Configuration Items -
+ -
+

If you're running on a Linux system that supports the " This allows you to execute LLVM bitcode files directly. On Debian, you -can also use this command instead of the 'echo' command above:
+can also use this command instead of the 'echo' command above:

@@ -1236,31 +1248,37 @@ $ sudo update-binfmts --install llvm /path/to/lli --magic 'BC'
- -
- Program Layout
+ + +
+ Program Layout +
-
+

One useful source of information about the LLVM source base is the LLVM doxygen documentation available at doxygen documentation available at http://llvm.org/doxygen/. The following is a brief introduction to code layout:
-
- -llvm/examples - + + llvm/examples + + + This directory contains some simple examples of how to use the LLVM IR and JIT. -llvm/include - + + llvm/include + + + This directory contains public header files exported from the LLVM library. The three main subdirectories of this directory are: @@ -1287,8 +1305,11 @@ library. The three main subdirectories of this directory are: -llvm/lib - + + llvm/lib + + + This directory contains most of the source files of the LLVM system. In LLVM, almost all code exists in libraries, making it very easy to share code among the @@ -1327,6 +1348,10 @@ different tools. This directory contains the major parts of the code generator: Instruction Selector, Instruction Scheduling, and Register Allocation. + llvm/lib/MC/ + (FIXME: T.B.D.) + + llvm/lib/Debugger/ This directory contains the source level debugger library that makes it possible to instrument LLVM programs so that a debugger could identify @@ -1340,6 +1365,7 @@ different tools. This directory contains the source code that corresponds to the header files located in llvm/include/Support/. + llvm/lib/System/ This directory contains the operating system abstraction layer that shields LLVM from platform-specific coding. @@ -1348,8 +1374,11 @@ different tools. -llvm/projects - + + llvm/projects + + + This directory contains projects that are not strictly part of LLVM but are shipped with LLVM. This is also the directory where you should create your own LLVM-based projects. See llvm/projects/sample for an example of how @@ -1357,8 +1386,11 @@ different tools. -llvm/runtime - + + llvm/runtime + + + This directory contains libraries which are compiled into LLVM bitcode and used when linking programs with the GCC front end. Most of these libraries are @@ -1371,16 +1403,22 @@ end to compile. -llvm/test - + + llvm/test + + + This directory contains feature and regression tests and other basic sanity checks on the LLVM infrastructure. These are intended to run quickly and cover a lot of territory without being exhaustive. -test-suite - + + test-suite + + + This is not a directory in the normal llvm module; it is a separate Subversion module that must be checked out (usually to projects/test-suite). @@ -1395,8 +1433,11 @@ end to compile. -llvm/tools - + + llvm/tools + + + The tools directory contains the executables built out of the libraries above, which form the main part of the user interface. You can @@ -1480,8 +1521,11 @@ information is in the Command Guide. -llvm/utils - + + llvm/utils + + + This directory contains utilities for working with LLVM source code, and some of the utilities are actually required as part of the build process because they @@ -1542,13 +1586,15 @@ are code generators for parts of LLVM infrastructure. + + - + An Example Using the LLVM Tool Chain - + - + This section gives an example of using LLVM. llvm-gcc3 is now obsolete, so we only include instructions for llvm-gcc4. @@ -1559,12 +1605,13 @@ create bitcode by default: gcc4 produces native code. As the example belo the '--emit-llvm' flag is needed to produce LLVM bitcode output. For makefiles and configure scripts, the CFLAGS variable needs '--emit-llvm' to produce bitcode output. - -Example with llvm-gcc4 + + Example with llvm-gcc4 + - + First, create a simple C file, name it 'hello.c': @@ -1645,14 +1692,15 @@ int main() { + - + Common Problems - + - + If you are having problems building or using LLVM, or if you have any other general questions about LLVM, please consult the Frequently @@ -1661,12 +1709,12 @@ Asked Questions page. - + Links - + - + This document is just an introduction on how to use LLVM to do some simple things... there are many more interesting and complicated things @@ -1694,8 +1742,8 @@ out: Chris Lattner Reid Spencer - The LLVM Compiler Infrastructure - Last modified: $Date: 2011-02-01 21:08:28 +0100 (Tue, 01 Feb 2011) $ + The LLVM Compiler Infrastructure + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ -- cgit v1.1

Getting Started with the LLVM System -

+ Overview +

+ Getting Started Quickly (A Summary) +

+ Requirements +

+ Hardware +

+ Software +

Broken versions of GCC and other tools -

+ Getting Started with LLVM +

Terminology and Notation -

Setting Up Your Environment -

Unpacking the LLVM Archives -

Checkout LLVM from Subversion -

GIT mirror -

Install the GCC Front End -

Local LLVM Configuration -

Compiling the LLVM Suite Source Code -

Cross-Compiling LLVM -

The Location of LLVM Object Files -

Optional Configuration Items -

+ Program Layout +

+ `llvm/examples` +

+ `llvm/include` +

+ `llvm/lib` +

+ `llvm/projects` +

+ `llvm/runtime` +

+ `llvm/test` +

+ `test-suite` +

+ `llvm/tools` +

+ `llvm/utils` +

An Example Using the LLVM Tool Chain -

+ Example with llvm-gcc4 +

Common Problems -

Links -