3 ====================================
4 Getting Started with the LLVM System
5 ====================================
13 Welcome to LLVM! In order to get started, you first need to know some basic
16 First, LLVM comes in three pieces. The first piece is the LLVM suite. This
17 contains all of the tools, libraries, and header files needed to use LLVM. It
18 contains an assembler, disassembler, bitcode analyzer and bitcode optimizer. It
19 also contains basic regression tests that can be used to test the LLVM tools and
22 The second piece is the `Clang <http://clang.llvm.org/>`_ front end. This
23 component compiles C, C++, Objective C, and Objective C++ code into LLVM
24 bitcode. Once compiled into LLVM bitcode, a program can be manipulated with the
25 LLVM tools from the LLVM suite.
27 There is a third, optional piece called Test Suite. It is a suite of programs
28 with a testing harness that can be used to further test LLVM's functionality
31 Getting Started Quickly (A Summary)
32 ===================================
34 The LLVM Getting Started documentation may be out of date. So, the `Clang
35 Getting Started <http://clang.llvm.org/get_started.html>`_ page might also be a
38 Here's the short story for getting up and running quickly with LLVM:
40 #. Read the documentation.
41 #. Read the documentation.
42 #. Remember that you were warned twice about reading the documentation.
45 * ``cd where-you-want-llvm-to-live``
46 * ``svn co http://llvm.org/svn/llvm-project/llvm/trunk llvm``
50 * ``cd where-you-want-llvm-to-live``
52 * ``svn co http://llvm.org/svn/llvm-project/cfe/trunk clang``
54 #. Checkout Compiler-RT:
56 * ``cd where-you-want-llvm-to-live``
57 * ``cd llvm/projects``
58 * ``svn co http://llvm.org/svn/llvm-project/compiler-rt/trunk compiler-rt``
60 #. Get the Test Suite Source Code **[Optional]**
62 * ``cd where-you-want-llvm-to-live``
63 * ``cd llvm/projects``
64 * ``svn co http://llvm.org/svn/llvm-project/test-suite/trunk test-suite``
66 #. Configure and build LLVM and Clang:
68 * ``cd where-you-want-to-build-llvm``
69 * ``mkdir build`` (for building without polluting the source dir)
71 * ``../llvm/configure [options]``
74 * ``--prefix=directory`` --- Specify for *directory* the full pathname of
75 where you want the LLVM tools and libraries to be installed (default
78 * ``--enable-optimized`` --- Compile with optimizations enabled (default
81 * ``--enable-assertions`` --- Compile with assertion checks enabled
84 * ``make [-j]`` --- The ``-j`` specifies the number of jobs (commands) to run
85 simultaneously. This builds both LLVM and Clang for Debug+Asserts mode.
86 The ``--enabled-optimized`` configure option is used to specify a Release
89 * ``make check-all`` --- This run the regression tests to ensure everything
92 * ``make update`` --- This command is used to update all the svn repositories
93 at once, rather then having to ``cd`` into the individual repositories and
94 running ``svn update``.
96 * It is also possible to use CMake instead of the makefiles. With CMake it is
97 possible to generate project files for several IDEs: Xcode, Eclipse CDT4,
98 CodeBlocks, Qt-Creator (use the CodeBlocks generator), KDevelop3.
100 * If you get an "internal compiler error (ICE)" or test failures, see
103 Consult the `Getting Started with LLVM`_ section for detailed information on
104 configuring and compiling LLVM. See `Setting Up Your Environment`_ for tips
105 that simplify working with the Clang front end and LLVM tools. Go to `Program
106 Layout`_ to learn about the layout of the source code tree.
111 Before you begin to use the LLVM system, review the requirements given below.
112 This may save you some trouble by knowing ahead of time what hardware and
113 software you will need.
118 LLVM is known to work on the following platforms:
120 +-----------------+----------------------+-------------------------+
121 |OS | Arch | Compilers |
122 +=================+======================+=========================+
123 |AuroraUX | x86\ :sup:`1` | GCC |
124 +-----------------+----------------------+-------------------------+
125 |Linux | x86\ :sup:`1` | GCC |
126 +-----------------+----------------------+-------------------------+
127 |Linux | amd64 | GCC |
128 +-----------------+----------------------+-------------------------+
129 |Solaris | V9 (Ultrasparc) | GCC |
130 +-----------------+----------------------+-------------------------+
131 |FreeBSD | x86\ :sup:`1` | GCC |
132 +-----------------+----------------------+-------------------------+
133 |FreeBSD | amd64 | GCC |
134 +-----------------+----------------------+-------------------------+
135 |MacOS X\ :sup:`2`| PowerPC | GCC |
136 +-----------------+----------------------+-------------------------+
137 |MacOS X\ :sup:`9`| x86 | GCC |
138 +-----------------+----------------------+-------------------------+
139 |Cygwin/Win32 | x86\ :sup:`1, 8, 11` | GCC 3.4.X, binutils 2.20|
140 +-----------------+----------------------+-------------------------+
142 LLVM has partial support for the following platforms:
144 +-------------------+----------------------+-------------------------------------------+
145 |OS | Arch | Compilers |
146 +===================+======================+===========================================+
147 | Windows | x86\ :sup:`1` | Visual Studio 2000 or higher\ :sup:`4,5` |
148 +-------------------+----------------------+-------------------------------------------+
149 | AIX\ :sup:`3,4` | PowerPC | GCC |
150 +-------------------+----------------------+-------------------------------------------+
151 | Linux\ :sup:`3,5` | PowerPC | GCC |
152 +-------------------+----------------------+-------------------------------------------+
153 | Linux\ :sup:`7` | Alpha | GCC |
154 +-------------------+----------------------+-------------------------------------------+
155 | Linux\ :sup:`7` | Itanium (IA-64) | GCC |
156 +-------------------+----------------------+-------------------------------------------+
157 | HP-UX\ :sup:`7` | Itanium (IA-64) | HP aCC |
158 +-------------------+----------------------+-------------------------------------------+
159 | Windows x64 | x86-64 | mingw-w64's GCC-4.5.x\ :sup:`12` |
160 +-------------------+----------------------+-------------------------------------------+
164 Code generation supported for Pentium processors and up
166 #. Code generation supported for Pentium processors and up
167 #. Code generation supported for 32-bit ABI only
168 #. No native code generation
169 #. Build is not complete: one or more tools do not link or function
170 #. The GCC-based C/C++ frontend does not build
171 #. The port is done using the MSYS shell.
172 #. Native code generation exists but is not complete.
173 #. Binutils 2.20 or later is required to build the assembler generated by LLVM properly.
174 #. Xcode 2.5 and gcc 4.0.1 (Apple Build 5370) will trip internal LLVM assert
175 messages when compiled for Release at optimization levels greater than 0
176 (i.e., ``-O1`` and higher). Add ``OPTIMIZE_OPTION="-O0"`` to the build
177 command line if compiling for LLVM Release or bootstrapping the LLVM
179 #. For MSYS/MinGW on Windows, be sure to install the MSYS version of the perl
180 package, and be sure it appears in your path before any Windows-based
181 versions such as Strawberry Perl and ActivePerl, as these have
182 Windows-specifics that will cause the build to fail.
183 #. To use LLVM modules on Win32-based system, you may configure LLVM
184 with ``--enable-shared``.
186 #. To compile SPU backend, you need to add ``LDFLAGS=-Wl,--stack,16777216`` to
189 Note that you will need about 1-3 GB of space for a full LLVM build in Debug
190 mode, depending on the system (it is so large because of all the debugging
191 information and the fact that the libraries are statically linked into multiple
192 tools). If you do not need many of the tools and you are space-conscious, you
193 can pass ``ONLY_TOOLS="tools you need"`` to make. The Release build requires
194 considerably less space.
196 The LLVM suite *may* compile on other platforms, but it is not guaranteed to do
197 so. If compilation is successful, the LLVM utilities should be able to
198 assemble, disassemble, analyze, and optimize LLVM bitcode. Code generation
199 should work as well, although the generated native code may not work on your
205 Compiling LLVM requires that you have several software packages installed. The
206 table below lists those required packages. The Package column is the usual name
207 for the software package that LLVM depends on. The Version column provides
208 "known to work" versions of the package. The Notes column describes how LLVM
209 uses the package and provides other details.
211 +--------------------------------------------------------------+-----------------+---------------------------------------------+
212 | Package | Version | Notes |
213 +==============================================================+=================+=============================================+
214 | `GNU Make <http://savannah.gnu.org/projects/make>`_ | 3.79, 3.79.1 | Makefile/build processor |
215 +--------------------------------------------------------------+-----------------+---------------------------------------------+
216 | `GCC <http://gcc.gnu.org/>`_ | 3.4.2 | C/C++ compiler\ :sup:`1` |
217 +--------------------------------------------------------------+-----------------+---------------------------------------------+
218 | `TeXinfo <http://www.gnu.org/software/texinfo/>`_ | 4.5 | For building the CFE |
219 +--------------------------------------------------------------+-----------------+---------------------------------------------+
220 | `SVN <http://subversion.tigris.org/project_packages.html>`_ | >=1.3 | Subversion access to LLVM\ :sup:`2` |
221 +--------------------------------------------------------------+-----------------+---------------------------------------------+
222 | `DejaGnu <http://savannah.gnu.org/projects/dejagnu>`_ | 1.4.2 | Automated test suite\ :sup:`3` |
223 +--------------------------------------------------------------+-----------------+---------------------------------------------+
224 | `tcl <http://www.tcl.tk/software/tcltk/>`_ | 8.3, 8.4 | Automated test suite\ :sup:`3` |
225 +--------------------------------------------------------------+-----------------+---------------------------------------------+
226 | `expect <http://expect.nist.gov/>`_ | 5.38.0 | Automated test suite\ :sup:`3` |
227 +--------------------------------------------------------------+-----------------+---------------------------------------------+
228 | `perl <http://www.perl.com/download.csp>`_ | >=5.6.0 | Utilities |
229 +--------------------------------------------------------------+-----------------+---------------------------------------------+
230 | `GNU M4 <http://savannah.gnu.org/projects/m4>`_ | 1.4 | Macro processor for configuration\ :sup:`4` |
231 +--------------------------------------------------------------+-----------------+---------------------------------------------+
232 | `GNU Autoconf <http://www.gnu.org/software/autoconf/>`_ | 2.60 | Configuration script builder\ :sup:`4` |
233 +--------------------------------------------------------------+-----------------+---------------------------------------------+
234 | `GNU Automake <http://www.gnu.org/software/automake/>`_ | 1.9.6 | aclocal macro generator\ :sup:`4` |
235 +--------------------------------------------------------------+-----------------+---------------------------------------------+
236 | `libtool <http://savannah.gnu.org/projects/libtool>`_ | 1.5.22 | Shared library manager\ :sup:`4` |
237 +--------------------------------------------------------------+-----------------+---------------------------------------------+
241 #. Only the C and C++ languages are needed so there's no need to build the
242 other languages for LLVM's purposes. See `below` for specific version
244 #. You only need Subversion if you intend to build from the latest LLVM
245 sources. If you're working from a release distribution, you don't need
247 #. Only needed if you want to run the automated test suite in the
248 ``llvm/test`` directory.
249 #. If you want to make changes to the configure scripts, you will need GNU
250 autoconf (2.60), and consequently, GNU M4 (version 1.4 or higher). You
251 will also need automake (1.9.6). We only use aclocal from that package.
253 Additionally, your compilation host is expected to have the usual plethora of
254 Unix utilities. Specifically:
256 * **ar** --- archive library builder
257 * **bzip2** --- bzip2 command for distribution generation
258 * **bunzip2** --- bunzip2 command for distribution checking
259 * **chmod** --- change permissions on a file
260 * **cat** --- output concatenation utility
261 * **cp** --- copy files
262 * **date** --- print the current date/time
263 * **echo** --- print to standard output
264 * **egrep** --- extended regular expression search utility
265 * **find** --- find files/dirs in a file system
266 * **grep** --- regular expression search utility
267 * **gzip** --- gzip command for distribution generation
268 * **gunzip** --- gunzip command for distribution checking
269 * **install** --- install directories/files
270 * **mkdir** --- create a directory
271 * **mv** --- move (rename) files
272 * **ranlib** --- symbol table builder for archive libraries
273 * **rm** --- remove (delete) files and directories
274 * **sed** --- stream editor for transforming output
275 * **sh** --- Bourne shell for make build scripts
276 * **tar** --- tape archive for distribution generation
277 * **test** --- test things in file system
278 * **unzip** --- unzip command for distribution checking
279 * **zip** --- zip command for distribution generation
284 Broken versions of GCC and other tools
285 --------------------------------------
287 LLVM is very demanding of the host C++ compiler, and as such tends to expose
288 bugs in the compiler. In particular, several versions of GCC crash when trying
289 to compile LLVM. We routinely use GCC 4.2 (and higher) or Clang. Other
290 versions of GCC will probably work as well. GCC versions listed here are known
291 to not work. If you are using one of these versions, please try to upgrade your
292 GCC to something more recent. If you run into a problem with a version of GCC
293 not listed here, please `let us know <mailto:llvmdev@cs.uiuc.edu>`_. Please use
294 the "``gcc -v``" command to find out which version of GCC you are using.
296 **GCC versions prior to 3.0**: GCC 2.96.x and before had several problems in the
297 STL that effectively prevent it from compiling LLVM.
299 **GCC 3.2.2 and 3.2.3**: These versions of GCC fails to compile LLVM with a
300 bogus template error. This was fixed in later GCCs.
302 **GCC 3.3.2**: This version of GCC suffered from a `serious bug
303 <http://gcc.gnu.org/PR13392>`_ which causes it to crash in the
304 "``convert_from_eh_region_ranges_1``" GCC function.
306 **Cygwin GCC 3.3.3**: The version of GCC 3.3.3 commonly shipped with Cygwin does
309 **SuSE GCC 3.3.3**: The version of GCC 3.3.3 shipped with SuSE 9.1 (and possibly
310 others) does not compile LLVM correctly (it appears that exception handling is
311 broken in some cases). Please download the FSF 3.3.3 or upgrade to a newer
314 **GCC 3.4.0 on linux/x86 (32-bit)**: GCC miscompiles portions of the code
315 generator, causing an infinite loop in the llvm-gcc build when built with
316 optimizations enabled (i.e. a release build).
318 **GCC 3.4.2 on linux/x86 (32-bit)**: GCC miscompiles portions of the code
319 generator at -O3, as with 3.4.0. However gcc 3.4.2 (unlike 3.4.0) correctly
320 compiles LLVM at -O2. A work around is to build release LLVM builds with
321 "``make ENABLE_OPTIMIZED=1 OPTIMIZE_OPTION=-O2 ...``"
323 **GCC 3.4.x on X86-64/amd64**: GCC `miscompiles portions of LLVM
324 <http://llvm.org/PR1056>`__.
326 **GCC 3.4.4 (CodeSourcery ARM 2005q3-2)**: this compiler miscompiles LLVM when
327 building with optimizations enabled. It appears to work with "``make
328 ENABLE_OPTIMIZED=1 OPTIMIZE_OPTION=-O1``" or build a debug build.
330 **IA-64 GCC 4.0.0**: The IA-64 version of GCC 4.0.0 is known to miscompile LLVM.
332 **Apple Xcode 2.3**: GCC crashes when compiling LLVM at -O3 (which is the
333 default with ENABLE_OPTIMIZED=1. To work around this, build with
334 "``ENABLE_OPTIMIZED=1 OPTIMIZE_OPTION=-O2``".
336 **GCC 4.1.1**: GCC fails to build LLVM with template concept check errors
337 compiling some files. At the time of this writing, GCC mainline (4.2) did not
340 **GCC 4.1.1 on X86-64/amd64**: GCC `miscompiles portions of LLVM
341 <http://llvm.org/PR1063>`__ when compiling llvm itself into 64-bit code. LLVM
342 will appear to mostly work but will be buggy, e.g. failing portions of its
345 **GCC 4.1.2 on OpenSUSE**: Seg faults during libstdc++ build and on x86_64
346 platforms compiling md5.c gets a mangled constant.
348 **GCC 4.1.2 (20061115 (prerelease) (Debian 4.1.1-21)) on Debian**: Appears to
349 miscompile parts of LLVM 2.4. One symptom is ValueSymbolTable complaining about
350 symbols remaining in the table on destruction.
352 **GCC 4.1.2 20071124 (Red Hat 4.1.2-42)**: Suffers from the same symptoms as the
353 previous one. It appears to work with ENABLE_OPTIMIZED=0 (the default).
355 **Cygwin GCC 4.3.2 20080827 (beta) 2**: Users `reported
356 <http://llvm.org/PR4145>`_ various problems related with link errors when using
359 **Debian GCC 4.3.2 on X86**: Crashes building some files in LLVM 2.6.
361 **GCC 4.3.3 (Debian 4.3.3-10) on ARM**: Miscompiles parts of LLVM 2.6 when
362 optimizations are turned on. The symptom is an infinite loop in
363 ``FoldingSetImpl::RemoveNode`` while running the code generator.
365 **SUSE 11 GCC 4.3.4**: Miscompiles LLVM, causing crashes in ValueHandle logic.
367 **GCC 4.3.5 and GCC 4.4.5 on ARM**: These can miscompile ``value >> 1`` even at
368 ``-O0``. A test failure in ``test/Assembler/alignstack.ll`` is one symptom of
371 **GNU ld 2.16.X**. Some 2.16.X versions of the ld linker will produce very long
372 warning messages complaining that some "``.gnu.linkonce.t.*``" symbol was
373 defined in a discarded section. You can safely ignore these messages as they are
374 erroneous and the linkage is correct. These messages disappear using ld 2.17.
376 **GNU binutils 2.17**: Binutils 2.17 contains `a bug
377 <http://sourceware.org/bugzilla/show_bug.cgi?id=3111>`__ which causes huge link
378 times (minutes instead of seconds) when building LLVM. We recommend upgrading
379 to a newer version (2.17.50.0.4 or later).
381 **GNU Binutils 2.19.1 Gold**: This version of Gold contained `a bug
382 <http://sourceware.org/bugzilla/show_bug.cgi?id=9836>`__ which causes
383 intermittent failures when building LLVM with position independent code. The
384 symptom is an error about cyclic dependencies. We recommend upgrading to a
385 newer version of Gold.
387 .. _Getting Started with LLVM:
389 Getting Started with LLVM
390 =========================
392 The remainder of this guide is meant to get you up and running with LLVM and to
393 give you some basic information about the LLVM environment.
395 The later sections of this guide describe the `general layout`_ of the LLVM
396 source tree, a `simple example`_ using the LLVM tool chain, and `links`_ to find
397 more information about LLVM or to get help via e-mail.
399 Terminology and Notation
400 ------------------------
402 Throughout this manual, the following names are used to denote paths specific to
403 the local system and working environment. *These are not environment variables
404 you need to set but just strings used in the rest of this document below*. In
405 any of the examples below, simply replace each of these names with the
406 appropriate pathname on your local system. All these paths are absolute:
410 This is the top level directory of the LLVM source tree.
414 This is the top level directory of the LLVM object tree (i.e. the tree where
415 object files and compiled programs will be placed. It can be the same as
418 .. _Setting Up Your Environment:
420 Setting Up Your Environment
421 ---------------------------
423 In order to compile and use LLVM, you may need to set some environment
426 ``LLVM_LIB_SEARCH_PATH=/path/to/your/bitcode/libs``
428 [Optional] This environment variable helps LLVM linking tools find the
429 locations of your bitcode libraries. It is provided only as a convenience
430 since you can specify the paths using the -L options of the tools and the
431 C/C++ front-end will automatically use the bitcode files installed in its
434 Unpacking the LLVM Archives
435 ---------------------------
437 If you have the LLVM distribution, you will need to unpack it before you can
438 begin to compile it. LLVM is distributed as a set of two files: the LLVM suite
439 and the LLVM GCC front end compiled for your platform. There is an additional
440 test suite that is optional. Each file is a TAR archive that is compressed with
443 The files are as follows, with *x.y* marking the version number:
447 Source release for the LLVM libraries and tools.
449 ``llvm-test-x.y.tar.gz``
451 Source release for the LLVM test-suite.
453 ``llvm-gcc-4.2-x.y.source.tar.gz``
455 Source release of the llvm-gcc-4.2 front end. See README.LLVM in the root
456 directory for build instructions.
458 ``llvm-gcc-4.2-x.y-platform.tar.gz``
460 Binary release of the llvm-gcc-4.2 front end for a specific platform.
462 Checkout LLVM from Subversion
463 -----------------------------
465 If you have access to our Subversion repository, you can get a fresh copy of the
466 entire source code. All you need to do is check it out from Subversion as
469 * ``cd where-you-want-llvm-to-live``
470 * Read-Only: ``svn co http://llvm.org/svn/llvm-project/llvm/trunk llvm``
471 * Read-Write:``svn co https://user@llvm.org/svn/llvm-project/llvm/trunk llvm``
473 This will create an '``llvm``' directory in the current directory and fully
474 populate it with the LLVM source code, Makefiles, test directories, and local
475 copies of documentation files.
477 If you want to get a specific release (as opposed to the most recent revision),
478 you can checkout it from the '``tags``' directory (instead of '``trunk``'). The
479 following releases are located in the following subdirectories of the '``tags``'
482 * Release 3.1: **RELEASE_31/final**
483 * Release 3.0: **RELEASE_30/final**
484 * Release 2.9: **RELEASE_29/final**
485 * Release 2.8: **RELEASE_28**
486 * Release 2.7: **RELEASE_27**
487 * Release 2.6: **RELEASE_26**
488 * Release 2.5: **RELEASE_25**
489 * Release 2.4: **RELEASE_24**
490 * Release 2.3: **RELEASE_23**
491 * Release 2.2: **RELEASE_22**
492 * Release 2.1: **RELEASE_21**
493 * Release 2.0: **RELEASE_20**
494 * Release 1.9: **RELEASE_19**
495 * Release 1.8: **RELEASE_18**
496 * Release 1.7: **RELEASE_17**
497 * Release 1.6: **RELEASE_16**
498 * Release 1.5: **RELEASE_15**
499 * Release 1.4: **RELEASE_14**
500 * Release 1.3: **RELEASE_13**
501 * Release 1.2: **RELEASE_12**
502 * Release 1.1: **RELEASE_11**
503 * Release 1.0: **RELEASE_1**
505 If you would like to get the LLVM test suite (a separate package as of 1.4), you
506 get it from the Subversion repository:
508 .. code-block:: console
511 % svn co http://llvm.org/svn/llvm-project/test-suite/trunk test-suite
513 By placing it in the ``llvm/projects``, it will be automatically configured by
514 the LLVM configure script as well as automatically updated when you run ``svn
520 GIT mirrors are available for a number of LLVM subprojects. These mirrors sync
521 automatically with each Subversion commit and contain all necessary git-svn
522 marks (so, you can recreate git-svn metadata locally). Note that right now
523 mirrors reflect only ``trunk`` for each project. You can do the read-only GIT
526 .. code-block:: console
528 % git clone http://llvm.org/git/llvm.git
530 If you want to check out clang too, run:
532 .. code-block:: console
534 % git clone http://llvm.org/git/llvm.git
536 % git clone http://llvm.org/git/clang.git
538 Since the upstream repository is in Subversion, you should use ``git
539 pull --rebase`` instead of ``git pull`` to avoid generating a non-linear history
540 in your clone. To configure ``git pull`` to pass ``--rebase`` by default on the
541 master branch, run the following command:
543 .. code-block:: console
545 % git config branch.master.rebase true
547 Sending patches with Git
548 ^^^^^^^^^^^^^^^^^^^^^^^^
550 Please read `Developer Policy <DeveloperPolicy.html#one-off-patches>`_, too.
552 Assume ``master`` points the upstream and ``mybranch`` points your working
553 branch, and ``mybranch`` is rebased onto ``master``. At first you may check
554 sanity of whitespaces:
556 .. code-block:: console
558 % git diff --check master..mybranch
560 The easiest way to generate a patch is as below:
562 .. code-block:: console
564 % git diff master..mybranch > /path/to/mybranch.diff
566 It is a little different from svn-generated diff. git-diff-generated diff has
567 prefixes like ``a/`` and ``b/``. Don't worry, most developers might know it
568 could be accepted with ``patch -p1 -N``.
570 But you may generate patchset with git-format-patch. It generates by-each-commit
571 patchset. To generate patch files to attach to your article:
573 .. code-block:: console
575 % git format-patch --no-attach master..mybranch -o /path/to/your/patchset
577 If you would like to send patches directly, you may use git-send-email or
578 git-imap-send. Here is an example to generate the patchset in Gmail's [Drafts].
580 .. code-block:: console
582 % git format-patch --attach master..mybranch --stdout | git imap-send
584 Then, your .git/config should have [imap] sections.
589 host = imaps://imap.gmail.com
590 user = your.gmail.account@gmail.com
595 folder = "[Gmail]/Drafts"
596 ; example for Japanese, "Modified UTF-7" encoded.
597 folder = "[Gmail]/&Tgtm+DBN-"
598 ; example for Traditional Chinese
599 folder = "[Gmail]/&g0l6Pw-"
601 For developers to work with git-svn
602 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
604 To set up clone from which you can submit code using ``git-svn``, run:
606 .. code-block:: console
608 % git clone http://llvm.org/git/llvm.git
610 % git svn init https://llvm.org/svn/llvm-project/llvm/trunk --username=<username>
611 % git config svn-remote.svn.fetch :refs/remotes/origin/master
612 % git svn rebase -l # -l avoids fetching ahead of the git mirror.
614 # If you have clang too:
616 % git clone http://llvm.org/git/clang.git
618 % git svn init https://llvm.org/svn/llvm-project/cfe/trunk --username=<username>
619 % git config svn-remote.svn.fetch :refs/remotes/origin/master
622 To update this clone without generating git-svn tags that conflict with the
623 upstream git repo, run:
625 .. code-block:: console
627 % git fetch && (cd tools/clang && git fetch) # Get matching revisions of both trees.
628 % git checkout master
631 git checkout master &&
634 This leaves your working directories on their master branches, so you'll need to
635 ``checkout`` each working branch individually and ``rebase`` it on top of its
638 To commit back changes via git-svn, use ``dcommit``:
640 .. code-block:: console
644 Note that git-svn will create one SVN commit for each Git commit you have pending,
645 so squash and edit each commit before executing ``dcommit`` to make sure they all
646 conform to the coding standards and the developers' policy.
648 On success, ``dcommit`` will rebase against the HEAD of SVN, so to avoid conflict,
649 please make sure your current branch is up-to-date (via fetch/rebase) before
652 The git-svn metadata can get out of sync after you mess around with branches and
653 ``dcommit``. When that happens, ``git svn dcommit`` stops working, complaining
654 about files with uncommitted changes. The fix is to rebuild the metadata:
656 .. code-block:: console
661 Please, refer to the Git-SVN manual (``man git-svn``) for more information.
663 Local LLVM Configuration
664 ------------------------
666 Once checked out from the Subversion repository, the LLVM suite source code must
667 be configured via the ``configure`` script. This script sets variables in the
668 various ``*.in`` files, most notably ``llvm/Makefile.config`` and
669 ``llvm/include/Config/config.h``. It also populates *OBJ_ROOT* with the
670 Makefiles needed to begin building LLVM.
672 The following environment variables are used by the ``configure`` script to
673 configure the build system:
675 +------------+-----------------------------------------------------------+
676 | Variable | Purpose |
677 +============+===========================================================+
678 | CC | Tells ``configure`` which C compiler to use. By default, |
679 | | ``configure`` will check ``PATH`` for ``clang`` and GCC C |
680 | | compilers (in this order). Use this variable to override |
681 | | ``configure``\'s default behavior. |
682 +------------+-----------------------------------------------------------+
683 | CXX | Tells ``configure`` which C++ compiler to use. By |
684 | | default, ``configure`` will check ``PATH`` for |
685 | | ``clang++`` and GCC C++ compilers (in this order). Use |
686 | | this variable to override ``configure``'s default |
688 +------------+-----------------------------------------------------------+
690 The following options can be used to set or enable LLVM specific options:
692 ``--enable-optimized``
694 Enables optimized compilation (debugging symbols are removed and GCC
695 optimization flags are enabled). Note that this is the default setting if you
696 are using the LLVM distribution. The default behavior of an Subversion
697 checkout is to use an unoptimized build (also known as a debug build).
699 ``--enable-debug-runtime``
701 Enables debug symbols in the runtime libraries. The default is to strip debug
702 symbols from the runtime libraries.
706 Compile the Just In Time (JIT) compiler functionality. This is not available
707 on all platforms. The default is dependent on platform, so it is best to
708 explicitly enable it if you want it.
710 ``--enable-targets=target-option``
712 Controls which targets will be built and linked into llc. The default value
713 for ``target_options`` is "all" which builds and links all available targets.
714 The value "host-only" can be specified to build only a native compiler (no
715 cross-compiler targets available). The "native" target is selected as the
716 target of the build host. You can also specify a comma separated list of
717 target names that you want available in llc. The target names use all lower
718 case. The current set of targets is:
720 ``arm, cpp, hexagon, mblaze, mips, mipsel, msp430, powerpc, ptx, sparc, spu,
721 x86, x86_64, xcore``.
725 Look for the doxygen program and enable construction of doxygen based
726 documentation from the source code. This is disabled by default because
727 generating the documentation can take a long time and producess 100s of
732 LLVM can use external disassembler library for various purposes (now it's used
733 only for examining code produced by JIT). This option will enable usage of
734 `udis86 <http://udis86.sourceforge.net/>`_ x86 (both 32 and 64 bits)
735 disassembler library.
737 To configure LLVM, follow these steps:
739 #. Change directory into the object root directory:
741 .. code-block:: console
745 #. Run the ``configure`` script located in the LLVM source tree:
747 .. code-block:: console
749 % SRC_ROOT/configure --prefix=/install/path [other options]
751 Compiling the LLVM Suite Source Code
752 ------------------------------------
754 Once you have configured LLVM, you can build it. There are three types of
759 These builds are the default when one is using an Subversion checkout and
760 types ``gmake`` (unless the ``--enable-optimized`` option was used during
761 configuration). The build system will compile the tools and libraries with
762 debugging information. To get a Debug Build using the LLVM distribution the
763 ``--disable-optimized`` option must be passed to ``configure``.
765 Release (Optimized) Builds
767 These builds are enabled with the ``--enable-optimized`` option to
768 ``configure`` or by specifying ``ENABLE_OPTIMIZED=1`` on the ``gmake`` command
769 line. For these builds, the build system will compile the tools and libraries
770 with GCC optimizations enabled and strip debugging information from the
771 libraries and executables it generates. Note that Release Builds are default
772 when using an LLVM distribution.
776 These builds are for use with profiling. They compile profiling information
777 into the code for use with programs like ``gprof``. Profile builds must be
778 started by specifying ``ENABLE_PROFILING=1`` on the ``gmake`` command line.
780 Once you have LLVM configured, you can build it by entering the *OBJ_ROOT*
781 directory and issuing the following command:
783 .. code-block:: console
787 If the build fails, please `check here`_ to see if you are using a version of
788 GCC that is known not to compile LLVM.
790 If you have multiple processors in your machine, you may wish to use some of the
791 parallel build options provided by GNU Make. For example, you could use the
794 .. code-block:: console
798 There are several special targets which are useful when working with the LLVM
803 Removes all files generated by the build. This includes object files,
804 generated C/C++ files, libraries, and executables.
808 Removes everything that ``gmake clean`` does, but also removes files generated
809 by ``configure``. It attempts to return the source tree to the original state
810 in which it was shipped.
814 Installs LLVM header files, libraries, tools, and documentation in a hierarchy
815 under ``$PREFIX``, specified with ``./configure --prefix=[dir]``, which
816 defaults to ``/usr/local``.
818 ``gmake -C runtime install-bytecode``
820 Assuming you built LLVM into $OBJDIR, when this command is run, it will
821 install bitcode libraries into the GCC front end's bitcode library directory.
822 If you need to update your bitcode libraries, this is the target to use once
825 Please see the `Makefile Guide <MakefileGuide.html>`_ for further details on
826 these ``make`` targets and descriptions of other targets available.
828 It is also possible to override default values from ``configure`` by declaring
829 variables on the command line. The following are some examples:
831 ``gmake ENABLE_OPTIMIZED=1``
833 Perform a Release (Optimized) build.
835 ``gmake ENABLE_OPTIMIZED=1 DISABLE_ASSERTIONS=1``
837 Perform a Release (Optimized) build without assertions enabled.
839 ``gmake ENABLE_OPTIMIZED=0``
841 Perform a Debug build.
843 ``gmake ENABLE_PROFILING=1``
845 Perform a Profiling build.
849 Print what ``gmake`` is doing on standard output.
851 ``gmake TOOL_VERBOSE=1``
853 Ask each tool invoked by the makefiles to print out what it is doing on
854 the standard output. This also implies ``VERBOSE=1``.
856 Every directory in the LLVM object tree includes a ``Makefile`` to build it and
857 any subdirectories that it contains. Entering any directory inside the LLVM
858 object tree and typing ``gmake`` should rebuild anything in or below that
859 directory that is out of date.
861 This does not apply to building the documentation.
862 LLVM's (non-Doxygen) documentation is produced with the
863 `Sphinx <http://sphinx-doc.org/>`_ documentation generation system.
864 There are some HTML documents that have not yet been converted to the new
865 system (which uses the easy-to-read and easy-to-write
866 `reStructuredText <http://sphinx-doc.org/rest.html>`_ plaintext markup
868 The generated documentation is built in the ``SRC_ROOT/docs`` directory using
870 For instructions on how to install Sphinx, see
871 `Sphinx Introduction for LLVM Developers
872 <http://lld.llvm.org/sphinx_intro.html>`_.
873 After following the instructions there for installing Sphinx, build the LLVM
874 HTML documentation by doing the following:
876 .. code-block:: console
879 $ make -f Makefile.sphinx
881 This creates a ``_build/html`` sub-directory with all of the HTML files, not
882 just the generated ones.
883 This directory corresponds to ``llvm.org/docs``.
884 For example, ``_build/html/SphinxQuickstartTemplate.html`` corresponds to
885 ``llvm.org/docs/SphinxQuickstartTemplate.html``.
886 The :doc:`SphinxQuickstartTemplate` is useful when creating a new document.
891 It is possible to cross-compile LLVM itself. That is, you can create LLVM
892 executables and libraries to be hosted on a platform different from the platform
893 where they are built (a Canadian Cross build). To configure a cross-compile,
894 supply the configure script with ``--build`` and ``--host`` options that are
895 different. The values of these options must be legal target triples that your
896 GCC compiler supports.
898 The result of such a build is executables that are not runnable on on the build
899 host (--build option) but can be executed on the compile host (--host option).
901 The Location of LLVM Object Files
902 ---------------------------------
904 The LLVM build system is capable of sharing a single LLVM source tree among
905 several LLVM builds. Hence, it is possible to build LLVM for several different
906 platforms or configurations using the same source tree.
908 This is accomplished in the typical autoconf manner:
910 * Change directory to where the LLVM object files should live:
912 .. code-block:: console
916 * Run the ``configure`` script found in the LLVM source directory:
918 .. code-block:: console
922 The LLVM build will place files underneath *OBJ_ROOT* in directories named after
925 Debug Builds with assertions enabled (the default)
929 ``OBJ_ROOT/Debug+Asserts/bin``
933 ``OBJ_ROOT/Debug+Asserts/lib``
939 ``OBJ_ROOT/Release/bin``
943 ``OBJ_ROOT/Release/lib``
949 ``OBJ_ROOT/Profile/bin``
953 ``OBJ_ROOT/Profile/lib``
955 Optional Configuration Items
956 ----------------------------
958 If you're running on a Linux system that supports the `binfmt_misc
959 <http://www.tat.physik.uni-tuebingen.de/~rguenth/linux/binfmt_misc.html>`_
960 module, and you have root access on the system, you can set your system up to
961 execute LLVM bitcode files directly. To do this, use commands like this (the
962 first command may not be required if you are already using the module):
964 .. code-block:: console
966 % mount -t binfmt_misc none /proc/sys/fs/binfmt_misc
967 % echo ':llvm:M::BC::/path/to/lli:' > /proc/sys/fs/binfmt_misc/register
968 % chmod u+x hello.bc (if needed)
971 This allows you to execute LLVM bitcode files directly. On Debian, you can also
972 use this command instead of the 'echo' command above:
974 .. code-block:: console
976 % sudo update-binfmts --install llvm /path/to/lli --magic 'BC'
984 One useful source of information about the LLVM source base is the LLVM `doxygen
985 <http://www.doxygen.org/>`_ documentation available at
986 `<http://llvm.org/doxygen/>`_. The following is a brief introduction to code
992 This directory contains some simple examples of how to use the LLVM IR and JIT.
997 This directory contains public header files exported from the LLVM library. The
998 three main subdirectories of this directory are:
1000 ``llvm/include/llvm``
1002 This directory contains all of the LLVM specific header files. This directory
1003 also has subdirectories for different portions of LLVM: ``Analysis``,
1004 ``CodeGen``, ``Target``, ``Transforms``, etc...
1006 ``llvm/include/llvm/Support``
1008 This directory contains generic support libraries that are provided with LLVM
1009 but not necessarily specific to LLVM. For example, some C++ STL utilities and
1010 a Command Line option processing library store their header files here.
1012 ``llvm/include/llvm/Config``
1014 This directory contains header files configured by the ``configure`` script.
1015 They wrap "standard" UNIX and C header files. Source code can include these
1016 header files which automatically take care of the conditional #includes that
1017 the ``configure`` script generates.
1022 This directory contains most of the source files of the LLVM system. In LLVM,
1023 almost all code exists in libraries, making it very easy to share code among the
1026 ``llvm/lib/VMCore/``
1028 This directory holds the core LLVM source files that implement core classes
1029 like Instruction and BasicBlock.
1031 ``llvm/lib/AsmParser/``
1033 This directory holds the source code for the LLVM assembly language parser
1036 ``llvm/lib/BitCode/``
1038 This directory holds code for reading and write LLVM bitcode.
1040 ``llvm/lib/Analysis/``
1042 This directory contains a variety of different program analyses, such as
1043 Dominator Information, Call Graphs, Induction Variables, Interval
1044 Identification, Natural Loop Identification, etc.
1046 ``llvm/lib/Transforms/``
1048 This directory contains the source code for the LLVM to LLVM program
1049 transformations, such as Aggressive Dead Code Elimination, Sparse Conditional
1050 Constant Propagation, Inlining, Loop Invariant Code Motion, Dead Global
1051 Elimination, and many others.
1053 ``llvm/lib/Target/``
1055 This directory contains files that describe various target architectures for
1056 code generation. For example, the ``llvm/lib/Target/X86`` directory holds the
1057 X86 machine description while ``llvm/lib/Target/ARM`` implements the ARM
1060 ``llvm/lib/CodeGen/``
1062 This directory contains the major parts of the code generator: Instruction
1063 Selector, Instruction Scheduling, and Register Allocation.
1069 ``llvm/lib/Debugger/``
1071 This directory contains the source level debugger library that makes it
1072 possible to instrument LLVM programs so that a debugger could identify source
1073 code locations at which the program is executing.
1075 ``llvm/lib/ExecutionEngine/``
1077 This directory contains libraries for executing LLVM bitcode directly at
1078 runtime in both interpreted and JIT compiled fashions.
1080 ``llvm/lib/Support/``
1082 This directory contains the source code that corresponds to the header files
1083 located in ``llvm/include/ADT/`` and ``llvm/include/Support/``.
1088 This directory contains projects that are not strictly part of LLVM but are
1089 shipped with LLVM. This is also the directory where you should create your own
1090 LLVM-based projects. See ``llvm/projects/sample`` for an example of how to set
1091 up your own project.
1096 This directory contains libraries which are compiled into LLVM bitcode and used
1097 when linking programs with the Clang front end. Most of these libraries are
1098 skeleton versions of real libraries; for example, libc is a stripped down
1101 Unlike the rest of the LLVM suite, this directory needs the LLVM GCC front end
1107 This directory contains feature and regression tests and other basic sanity
1108 checks on the LLVM infrastructure. These are intended to run quickly and cover a
1109 lot of territory without being exhaustive.
1114 This is not a directory in the normal llvm module; it is a separate Subversion
1115 module that must be checked out (usually to ``projects/test-suite``). This
1116 module contains a comprehensive correctness, performance, and benchmarking test
1117 suite for LLVM. It is a separate Subversion module because not every LLVM user
1118 is interested in downloading or building such a comprehensive test suite. For
1119 further details on this test suite, please see the :doc:`Testing Guide
1120 <TestingGuide>` document.
1127 The **tools** directory contains the executables built out of the libraries
1128 above, which form the main part of the user interface. You can always get help
1129 for a tool by typing ``tool_name -help``. The following is a brief introduction
1130 to the most important tools. More detailed information is in
1131 the `Command Guide <CommandGuide/index.html>`_.
1135 ``bugpoint`` is used to debug optimization passes or code generation backends
1136 by narrowing down the given test case to the minimum number of passes and/or
1137 instructions that still cause a problem, whether it is a crash or
1138 miscompilation. See `<HowToSubmitABug.html>`_ for more information on using
1143 The archiver produces an archive containing the given LLVM bitcode files,
1144 optionally with an index for faster lookup.
1148 The assembler transforms the human readable LLVM assembly to LLVM bitcode.
1152 The disassembler transforms the LLVM bitcode to human readable LLVM assembly.
1156 ``llvm-link``, not surprisingly, links multiple LLVM modules into a single
1161 ``lli`` is the LLVM interpreter, which can directly execute LLVM bitcode
1162 (although very slowly...). For architectures that support it (currently x86,
1163 Sparc, and PowerPC), by default, ``lli`` will function as a Just-In-Time
1164 compiler (if the functionality was compiled in), and will execute the code
1165 *much* faster than the interpreter.
1169 ``llc`` is the LLVM backend compiler, which translates LLVM bitcode to a
1170 native code assembly file or to C code (with the ``-march=c`` option).
1174 ``opt`` reads LLVM bitcode, applies a series of LLVM to LLVM transformations
1175 (which are specified on the command line), and then outputs the resultant
1176 bitcode. The '``opt -help``' command is a good way to get a list of the
1177 program transformations available in LLVM.
1179 ``opt`` can also be used to run a specific analysis on an input LLVM bitcode
1180 file and print out the results. It is primarily useful for debugging
1181 analyses, or familiarizing yourself with what an analysis does.
1186 This directory contains utilities for working with LLVM source code, and some of
1187 the utilities are actually required as part of the build process because they
1188 are code generators for parts of LLVM infrastructure.
1193 ``codegen-diff`` is a script that finds differences between code that LLC
1194 generates and code that LLI generates. This is a useful tool if you are
1195 debugging one of them, assuming that the other generates correct output. For
1196 the full user manual, run ```perldoc codegen-diff'``.
1200 The ``emacs`` directory contains syntax-highlighting files which will work
1201 with Emacs and XEmacs editors, providing syntax highlighting support for LLVM
1202 assembly files and TableGen description files. For information on how to use
1203 the syntax files, consult the ``README`` file in that directory.
1207 The ``getsrcs.sh`` script finds and outputs all non-generated source files,
1208 which is useful if one wishes to do a lot of development across directories
1209 and does not want to individually find each file. One way to use it is to run,
1210 for example: ``xemacs `utils/getsources.sh``` from the top of your LLVM source
1215 This little tool performs an ``egrep -H -n`` on each source file in LLVM and
1216 passes to it a regular expression provided on ``llvmgrep``'s command
1217 line. This is a very efficient way of searching the source base for a
1218 particular regular expression.
1222 The ``makellvm`` script compiles all files in the current directory and then
1223 compiles and links the tool that is the first argument. For example, assuming
1224 you are in the directory ``llvm/lib/Target/Sparc``, if ``makellvm`` is in your
1225 path, simply running ``makellvm llc`` will make a build of the current
1226 directory, switch to directory ``llvm/tools/llc`` and build it, causing a
1231 The ``TableGen`` directory contains the tool used to generate register
1232 descriptions, instruction set descriptions, and even assemblers from common
1233 TableGen description files.
1237 The ``vim`` directory contains syntax-highlighting files which will work with
1238 the VIM editor, providing syntax highlighting support for LLVM assembly files
1239 and TableGen description files. For information on how to use the syntax
1240 files, consult the ``README`` file in that directory.
1244 An Example Using the LLVM Tool Chain
1245 ====================================
1247 This section gives an example of using LLVM with the Clang front end.
1252 #. First, create a simple C file, name it 'hello.c':
1259 printf("hello world\n");
1263 #. Next, compile the C file into a native executable:
1265 .. code-block:: console
1267 % clang hello.c -o hello
1271 Clang works just like GCC by default. The standard -S and -c arguments
1272 work as usual (producing a native .s or .o file, respectively).
1274 #. Next, compile the C file into a LLVM bitcode file:
1276 .. code-block:: console
1278 % clang -O3 -emit-llvm hello.c -c -o hello.bc
1280 The -emit-llvm option can be used with the -S or -c options to emit an LLVM
1281 ``.ll`` or ``.bc`` file (respectively) for the code. This allows you to use
1282 the `standard LLVM tools <CommandGuide/index.html>`_ on the bitcode file.
1284 #. Run the program in both forms. To run the program, use:
1286 .. code-block:: console
1292 .. code-block:: console
1296 The second examples shows how to invoke the LLVM JIT, :doc:`lli
1297 <CommandGuide/lli>`.
1299 #. Use the ``llvm-dis`` utility to take a look at the LLVM assembly code:
1301 .. code-block:: console
1303 % llvm-dis < hello.bc | less
1305 #. Compile the program to native assembly using the LLC code generator:
1307 .. code-block:: console
1309 % llc hello.bc -o hello.s
1311 #. Assemble the native assembly language file into a program:
1313 .. code-block:: console
1315 % /opt/SUNWspro/bin/cc -xarch=v9 hello.s -o hello.native # On Solaris
1317 % gcc hello.s -o hello.native # On others
1319 #. Execute the native code program:
1321 .. code-block:: console
1325 Note that using clang to compile directly to native code (i.e. when the
1326 ``-emit-llvm`` option is not present) does steps 6/7/8 for you.
1331 If you are having problems building or using LLVM, or if you have any other
1332 general questions about LLVM, please consult the `Frequently Asked
1333 Questions <FAQ.html>`_ page.
1340 This document is just an **introduction** on how to use LLVM to do some simple
1341 things... there are many more interesting and complicated things that you can do
1342 that aren't documented here (but we'll gladly accept a patch if you want to
1343 write something up!). For more information about LLVM, check out:
1345 * `LLVM Homepage <http://llvm.org/>`_
1346 * `LLVM Doxygen Tree <http://llvm.org/doxygen/>`_
1347 * `Starting a Project that Uses LLVM <http://llvm.org/docs/Projects.html>`_