Stack map docs. Remove some stray markup.
[oota-llvm.git] / docs / GettingStarted.rst
1 ====================================
2 Getting Started with the LLVM System  
3 ====================================
4
5 .. contents::
6    :local:
7
8 Overview
9 ========
10
11 Welcome to LLVM! In order to get started, you first need to know some basic
12 information.
13
14 First, LLVM comes in three pieces. The first piece is the LLVM suite. This
15 contains all of the tools, libraries, and header files needed to use LLVM.  It
16 contains an assembler, disassembler, bitcode analyzer and bitcode optimizer.  It
17 also contains basic regression tests that can be used to test the LLVM tools and
18 the Clang front end.
19
20 The second piece is the `Clang <http://clang.llvm.org/>`_ front end.  This
21 component compiles C, C++, Objective C, and Objective C++ code into LLVM
22 bitcode. Once compiled into LLVM bitcode, a program can be manipulated with the
23 LLVM tools from the LLVM suite.
24
25 There is a third, optional piece called Test Suite.  It is a suite of programs
26 with a testing harness that can be used to further test LLVM's functionality
27 and performance.
28
29 Getting Started Quickly (A Summary)
30 ===================================
31
32 The LLVM Getting Started documentation may be out of date.  So, the `Clang
33 Getting Started <http://clang.llvm.org/get_started.html>`_ page might also be a
34 good place to start.
35
36 Here's the short story for getting up and running quickly with LLVM:
37
38 #. Read the documentation.
39 #. Read the documentation.
40 #. Remember that you were warned twice about reading the documentation.
41 #. Checkout LLVM:
42
43    * ``cd where-you-want-llvm-to-live``
44    * ``svn co http://llvm.org/svn/llvm-project/llvm/trunk llvm``
45
46 #. Checkout Clang:
47
48    * ``cd where-you-want-llvm-to-live``
49    * ``cd llvm/tools``
50    * ``svn co http://llvm.org/svn/llvm-project/cfe/trunk clang``
51
52 #. Checkout Compiler-RT:
53
54    * ``cd where-you-want-llvm-to-live``
55    * ``cd llvm/projects``
56    * ``svn co http://llvm.org/svn/llvm-project/compiler-rt/trunk compiler-rt``
57
58 #. Get the Test Suite Source Code **[Optional]**
59
60    * ``cd where-you-want-llvm-to-live``
61    * ``cd llvm/projects``
62    * ``svn co http://llvm.org/svn/llvm-project/test-suite/trunk test-suite``
63
64 #. Configure and build LLVM and Clang:
65
66    * ``cd where-you-want-to-build-llvm``
67    * ``mkdir build`` (for building without polluting the source dir)
68    * ``cd build``
69    * ``../llvm/configure [options]``
70      Some common options:
71
72      * ``--prefix=directory`` --- Specify for *directory* the full pathname of
73        where you want the LLVM tools and libraries to be installed (default
74        ``/usr/local``).
75
76      * ``--enable-optimized`` --- Compile with optimizations enabled (default
77        is NO).
78
79      * ``--enable-assertions`` --- Compile with assertion checks enabled
80        (default is YES).
81
82    * ``make [-j]`` --- The ``-j`` specifies the number of jobs (commands) to run
83      simultaneously.  This builds both LLVM and Clang for Debug+Asserts mode.
84      The ``--enable-optimized`` configure option is used to specify a Release
85      build.
86
87    * ``make check-all`` --- This run the regression tests to ensure everything
88      is in working order.
89
90    * It is also possible to use CMake instead of the makefiles. With CMake it is
91      possible to generate project files for several IDEs: Xcode, Eclipse CDT4,
92      CodeBlocks, Qt-Creator (use the CodeBlocks generator), KDevelop3.
93
94    * If you get an "internal compiler error (ICE)" or test failures, see
95      `below`.
96
97 Consult the `Getting Started with LLVM`_ section for detailed information on
98 configuring and compiling LLVM.  See `Setting Up Your Environment`_ for tips
99 that simplify working with the Clang front end and LLVM tools.  Go to `Program
100 Layout`_ to learn about the layout of the source code tree.
101
102 Requirements
103 ============
104
105 Before you begin to use the LLVM system, review the requirements given below.
106 This may save you some trouble by knowing ahead of time what hardware and
107 software you will need.
108
109 Hardware
110 --------
111
112 LLVM is known to work on the following host platforms:
113
114 ================== ===================== =============
115 OS                 Arch                  Compilers               
116 ================== ===================== =============
117 AuroraUX           x86\ :sup:`1`         GCC                     
118 Linux              x86\ :sup:`1`         GCC, Clang              
119 Linux              amd64                 GCC, Clang              
120 Linux              ARM\ :sup:`4`         GCC, Clang              
121 Linux              PowerPC               GCC, Clang              
122 Solaris            V9 (Ultrasparc)       GCC                     
123 FreeBSD            x86\ :sup:`1`         GCC, Clang              
124 FreeBSD            amd64                 GCC, Clang              
125 MacOS X\ :sup:`2`  PowerPC               GCC                     
126 MacOS X            x86                   GCC, Clang              
127 Cygwin/Win32       x86\ :sup:`1, 3`      GCC                     
128 Windows            x86\ :sup:`1`         Visual Studio           
129 Windows x64        x86-64                Visual Studio           
130 ================== ===================== =============
131
132 .. note::
133
134   #. Code generation supported for Pentium processors and up
135   #. Code generation supported for 32-bit ABI only
136   #. To use LLVM modules on Win32-based system, you may configure LLVM
137      with ``--enable-shared``.
138   #. MCJIT not working well pre-v7, old JIT engine not supported any more.
139
140 Note that you will need about 1-3 GB of space for a full LLVM build in Debug
141 mode, depending on the system (it is so large because of all the debugging
142 information and the fact that the libraries are statically linked into multiple
143 tools).  If you do not need many of the tools and you are space-conscious, you
144 can pass ``ONLY_TOOLS="tools you need"`` to make.  The Release build requires
145 considerably less space.
146
147 The LLVM suite *may* compile on other platforms, but it is not guaranteed to do
148 so.  If compilation is successful, the LLVM utilities should be able to
149 assemble, disassemble, analyze, and optimize LLVM bitcode.  Code generation
150 should work as well, although the generated native code may not work on your
151 platform.
152
153 Software
154 --------
155
156 Compiling LLVM requires that you have several software packages installed. The
157 table below lists those required packages. The Package column is the usual name
158 for the software package that LLVM depends on. The Version column provides
159 "known to work" versions of the package. The Notes column describes how LLVM
160 uses the package and provides other details.
161
162 =========================================================== ============ ==========================================
163 Package                                                     Version      Notes
164 =========================================================== ============ ==========================================
165 `GNU Make <http://savannah.gnu.org/projects/make>`_         3.79, 3.79.1 Makefile/build processor
166 `GCC <http://gcc.gnu.org/>`_                                >=4.7.0      C/C++ compiler\ :sup:`1`
167 `python <http://www.python.org/>`_                          >=2.5        Automated test suite\ :sup:`2`
168 `GNU M4 <http://savannah.gnu.org/projects/m4>`_             1.4          Macro processor for configuration\ :sup:`3`
169 `GNU Autoconf <http://www.gnu.org/software/autoconf/>`_     2.60         Configuration script builder\ :sup:`3`
170 `GNU Automake <http://www.gnu.org/software/automake/>`_     1.9.6        aclocal macro generator\ :sup:`3`
171 `libtool <http://savannah.gnu.org/projects/libtool>`_       1.5.22       Shared library manager\ :sup:`3`
172 `zlib <http://zlib.net>`_                                   >=1.2.3.4    Compression library\ :sup:`4`
173 =========================================================== ============ ==========================================
174
175 .. note::
176
177    #. Only the C and C++ languages are needed so there's no need to build the
178       other languages for LLVM's purposes. See `below` for specific version
179       info.
180    #. Only needed if you want to run the automated test suite in the
181       ``llvm/test`` directory.
182    #. If you want to make changes to the configure scripts, you will need GNU
183       autoconf (2.60), and consequently, GNU M4 (version 1.4 or higher). You
184       will also need automake (1.9.6). We only use aclocal from that package.
185    #. Optional, adds compression / uncompression capabilities to selected LLVM
186       tools.
187
188 Additionally, your compilation host is expected to have the usual plethora of
189 Unix utilities. Specifically:
190
191 * **ar** --- archive library builder
192 * **bzip2** --- bzip2 command for distribution generation
193 * **bunzip2** --- bunzip2 command for distribution checking
194 * **chmod** --- change permissions on a file
195 * **cat** --- output concatenation utility
196 * **cp** --- copy files
197 * **date** --- print the current date/time 
198 * **echo** --- print to standard output
199 * **egrep** --- extended regular expression search utility
200 * **find** --- find files/dirs in a file system
201 * **grep** --- regular expression search utility
202 * **gzip** --- gzip command for distribution generation
203 * **gunzip** --- gunzip command for distribution checking
204 * **install** --- install directories/files 
205 * **mkdir** --- create a directory
206 * **mv** --- move (rename) files
207 * **ranlib** --- symbol table builder for archive libraries
208 * **rm** --- remove (delete) files and directories
209 * **sed** --- stream editor for transforming output
210 * **sh** --- Bourne shell for make build scripts
211 * **tar** --- tape archive for distribution generation
212 * **test** --- test things in file system
213 * **unzip** --- unzip command for distribution checking
214 * **zip** --- zip command for distribution generation
215
216 .. _below:
217 .. _check here:
218
219 Host C++ Toolchain, both Compiler and Standard Library
220 ------------------------------------------------------
221
222 LLVM is very demanding of the host C++ compiler, and as such tends to expose
223 bugs in the compiler. We are also planning to follow improvements and
224 developments in the C++ language and library reasonably closely. As such, we
225 require a modern host C++ toolchain, both compiler and standard library, in
226 order to build LLVM.
227
228 For the most popular host toolchains we check for specific minimum versions in
229 our build systems:
230
231 * Clang 3.1
232 * GCC 4.7
233 * Visual Studio 2012
234
235 Anything older than these toolchains *may* work, but will require forcing the
236 build system with a special option and is not really a supported host platform.
237 Also note that older versions of these compilers have often crashed or
238 miscompiled LLVM.
239
240 For less widely used host toolchains such as ICC or xlC, be aware that a very
241 recent version may be required to support all of the C++ features used in LLVM.
242
243 We track certain versions of software that are *known* to fail when used as
244 part of the host toolchain. These even include linkers at times.
245
246 **GCC 4.6.3 on ARM**: Miscompiles ``llvm-readobj`` at ``-O3``. A test failure
247 in ``test/Object/readobj-shared-object.test`` is one symptom of the problem.
248
249 **GNU ld 2.16.X**. Some 2.16.X versions of the ld linker will produce very long
250 warning messages complaining that some "``.gnu.linkonce.t.*``" symbol was
251 defined in a discarded section. You can safely ignore these messages as they are
252 erroneous and the linkage is correct.  These messages disappear using ld 2.17.
253
254 **GNU binutils 2.17**: Binutils 2.17 contains `a bug
255 <http://sourceware.org/bugzilla/show_bug.cgi?id=3111>`__ which causes huge link
256 times (minutes instead of seconds) when building LLVM.  We recommend upgrading
257 to a newer version (2.17.50.0.4 or later).
258
259 **GNU Binutils 2.19.1 Gold**: This version of Gold contained `a bug
260 <http://sourceware.org/bugzilla/show_bug.cgi?id=9836>`__ which causes
261 intermittent failures when building LLVM with position independent code.  The
262 symptom is an error about cyclic dependencies.  We recommend upgrading to a
263 newer version of Gold.
264
265 **Clang 3.0 with libstdc++ 4.7.x**: a few Linux distributions (Ubuntu 12.10,
266 Fedora 17) have both Clang 3.0 and libstdc++ 4.7 in their repositories.  Clang
267 3.0 does not implement a few builtins that are used in this library.  We
268 recommend using the system GCC to compile LLVM and Clang in this case.
269
270 **Clang 3.0 on Mageia 2**.  There's a packaging issue: Clang can not find at
271 least some (``cxxabi.h``) libstdc++ headers.
272
273 **Clang in C++11 mode and libstdc++ 4.7.2**.  This version of libstdc++
274 contained `a bug <http://gcc.gnu.org/bugzilla/show_bug.cgi?id=53841>`__ which
275 causes Clang to refuse to compile condition_variable header file.  At the time
276 of writing, this breaks LLD build.
277
278 Getting a Modern Host C++ Toolchain
279 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
280
281 This section mostly applies to Linux and older BSDs. On Mac OS X, you should
282 have a sufficiently modern Xcode, or you will likely need to upgrade until you
283 do. On Windows, just use Visual Studio 2012 as the host compiler, it is
284 explicitly supported and widely available. FreeBSD 10.0 and newer have a modern
285 Clang as the system compiler.
286
287 However, some Linux distributions and some other or older BSDs sometimes have
288 extremely old versions of GCC. These steps attempt to help you upgrade you
289 compiler even on such a system. However, if at all possible, we encourage you
290 to use a recent version of a distribution with a modern system compiler that
291 meets these requirements. Note that it is tempting to to install a prior
292 version of Clang and libc++ to be the host compiler, however libc++ was not
293 well tested or set up to build on Linux until relatively recently. As
294 a consequence, this guide suggests just using libstdc++ and a modern GCC as the
295 initial host in a bootstrap, and then using Clang (and potentially libc++).
296
297 The first step is to get a recent GCC toolchain installed. The most common
298 distribution on which users have struggled with the version requirements is
299 Ubuntu Precise, 12.04 LTS. For this distribution, one easy option is to install
300 the `toolchain testing PPA`_ and use it to install a modern GCC. There is
301 a really nice discussions of this on the `ask ubuntu stack exchange`_. However,
302 not all users can use PPAs and there are many other distributions, so it may be
303 necessary (or just useful, if you're here you *are* doing compiler development
304 after all) to build and install GCC from source. It is also quite easy to do
305 these days.
306
307 .. _toolchain testing PPA:
308   https://launchpad.net/~ubuntu-toolchain-r/+archive/test
309 .. _ask ubuntu stack exchange:
310   http://askubuntu.com/questions/271388/how-to-install-gcc-4-8-in-ubuntu-12-04-from-the-terminal
311
312 Easy steps for installing GCC 4.8.2:
313
314 .. code-block:: console
315
316   % wget ftp://ftp.gnu.org/gnu/gcc/gcc-4.8.2/gcc-4.8.2.tar.bz2
317   % tar -xvjf gcc-4.8.2.tar.bz2
318   % cd gcc-4.8.2
319   % ./contrib/download_prerequisites
320   % cd ..
321   % mkdir gcc-4.8.2-build
322   % cd gcc-4.8.2-build
323   % $PWD/../gcc-4.8.2/configure --prefix=$HOME/toolchains --enable-languages=c,c++
324   % make -j$(nproc)
325   % make install
326
327 For more details, check out the excellent `GCC wiki entry`_, where I got most
328 of this information from.
329
330 .. _GCC wiki entry:
331   http://gcc.gnu.org/wiki/InstallingGCC
332
333 Once you have a GCC toolchain, use it as your host compiler. Things should
334 generally "just work". You may need to pass a special linker flag,
335 ``-Wl,-rpath,$HOME/toolchains/lib`` or some variant thereof to get things to
336 find the libstdc++ DSO in this toolchain.
337
338 When you build Clang, you will need to give *it* access to modern C++11
339 standard library in order to use it as your new host in part of a bootstrap.
340 There are two easy ways to do this, either build (and install) libc++ along
341 with Clang and then use it with the ``-stdlib=libc++`` compile and link flag,
342 or install Clang into the same prefix (``$HOME/toolchains`` above) as GCC.
343 Clang will look within its own prefix for libstdc++ and use it if found. You
344 can also add an explicit prefix for Clang to look in for a GCC toolchain with
345 the ``--gcc-toolchain=/opt/my/gcc/prefix`` flag, passing it to both compile and
346 link commands when using your just-built-Clang to bootstrap.
347
348 .. _Getting Started with LLVM:
349
350 Getting Started with LLVM
351 =========================
352
353 The remainder of this guide is meant to get you up and running with LLVM and to
354 give you some basic information about the LLVM environment.
355
356 The later sections of this guide describe the `general layout`_ of the LLVM
357 source tree, a `simple example`_ using the LLVM tool chain, and `links`_ to find
358 more information about LLVM or to get help via e-mail.
359
360 Terminology and Notation
361 ------------------------
362
363 Throughout this manual, the following names are used to denote paths specific to
364 the local system and working environment.  *These are not environment variables
365 you need to set but just strings used in the rest of this document below*.  In
366 any of the examples below, simply replace each of these names with the
367 appropriate pathname on your local system.  All these paths are absolute:
368
369 ``SRC_ROOT``
370
371   This is the top level directory of the LLVM source tree.
372
373 ``OBJ_ROOT``
374
375   This is the top level directory of the LLVM object tree (i.e. the tree where
376   object files and compiled programs will be placed.  It can be the same as
377   SRC_ROOT).
378
379 .. _Setting Up Your Environment:
380
381 Setting Up Your Environment
382 ---------------------------
383
384 In order to compile and use LLVM, you may need to set some environment
385 variables.
386
387 ``LLVM_LIB_SEARCH_PATH=/path/to/your/bitcode/libs``
388
389   [Optional] This environment variable helps LLVM linking tools find the
390   locations of your bitcode libraries. It is provided only as a convenience
391   since you can specify the paths using the -L options of the tools and the
392   C/C++ front-end will automatically use the bitcode files installed in its
393   ``lib`` directory.
394
395 Unpacking the LLVM Archives
396 ---------------------------
397
398 If you have the LLVM distribution, you will need to unpack it before you can
399 begin to compile it.  LLVM is distributed as a set of two files: the LLVM suite
400 and the LLVM GCC front end compiled for your platform.  There is an additional
401 test suite that is optional.  Each file is a TAR archive that is compressed with
402 the gzip program.
403
404 The files are as follows, with *x.y* marking the version number:
405
406 ``llvm-x.y.tar.gz``
407
408   Source release for the LLVM libraries and tools.
409
410 ``llvm-test-x.y.tar.gz``
411
412   Source release for the LLVM test-suite.
413
414 .. _checkout:
415
416 Checkout LLVM from Subversion
417 -----------------------------
418
419 If you have access to our Subversion repository, you can get a fresh copy of the
420 entire source code.  All you need to do is check it out from Subversion as
421 follows:
422
423 * ``cd where-you-want-llvm-to-live``
424 * Read-Only: ``svn co http://llvm.org/svn/llvm-project/llvm/trunk llvm``
425 * Read-Write:``svn co https://user@llvm.org/svn/llvm-project/llvm/trunk llvm``
426
427 This will create an '``llvm``' directory in the current directory and fully
428 populate it with the LLVM source code, Makefiles, test directories, and local
429 copies of documentation files.
430
431 If you want to get a specific release (as opposed to the most recent revision),
432 you can checkout it from the '``tags``' directory (instead of '``trunk``'). The
433 following releases are located in the following subdirectories of the '``tags``'
434 directory:
435
436 * Release 3.4: **RELEASE_34/final**
437 * Release 3.3: **RELEASE_33/final**
438 * Release 3.2: **RELEASE_32/final**
439 * Release 3.1: **RELEASE_31/final**
440 * Release 3.0: **RELEASE_30/final**
441 * Release 2.9: **RELEASE_29/final**
442 * Release 2.8: **RELEASE_28**
443 * Release 2.7: **RELEASE_27**
444 * Release 2.6: **RELEASE_26**
445 * Release 2.5: **RELEASE_25**
446 * Release 2.4: **RELEASE_24**
447 * Release 2.3: **RELEASE_23**
448 * Release 2.2: **RELEASE_22**
449 * Release 2.1: **RELEASE_21**
450 * Release 2.0: **RELEASE_20**
451 * Release 1.9: **RELEASE_19**
452 * Release 1.8: **RELEASE_18**
453 * Release 1.7: **RELEASE_17**
454 * Release 1.6: **RELEASE_16**
455 * Release 1.5: **RELEASE_15**
456 * Release 1.4: **RELEASE_14**
457 * Release 1.3: **RELEASE_13**
458 * Release 1.2: **RELEASE_12**
459 * Release 1.1: **RELEASE_11**
460 * Release 1.0: **RELEASE_1**
461
462 If you would like to get the LLVM test suite (a separate package as of 1.4), you
463 get it from the Subversion repository:
464
465 .. code-block:: console
466
467   % cd llvm/projects
468   % svn co http://llvm.org/svn/llvm-project/test-suite/trunk test-suite
469
470 By placing it in the ``llvm/projects``, it will be automatically configured by
471 the LLVM configure script as well as automatically updated when you run ``svn
472 update``.
473
474 Git Mirror
475 ----------
476
477 Git mirrors are available for a number of LLVM subprojects. These mirrors sync
478 automatically with each Subversion commit and contain all necessary git-svn
479 marks (so, you can recreate git-svn metadata locally). Note that right now
480 mirrors reflect only ``trunk`` for each project. You can do the read-only Git
481 clone of LLVM via:
482
483 .. code-block:: console
484
485   % git clone http://llvm.org/git/llvm.git
486
487 If you want to check out clang too, run:
488
489 .. code-block:: console
490
491   % cd llvm/tools
492   % git clone http://llvm.org/git/clang.git
493
494 If you want to check out compiler-rt too, run:
495
496 .. code-block:: console
497
498   % cd llvm/projects
499   % git clone http://llvm.org/git/compiler-rt.git
500
501 If you want to check out the Test Suite Source Code (optional), run:
502
503 .. code-block:: console
504
505   % cd llvm/projects
506   % git clone http://llvm.org/git/test-suite.git
507
508 Since the upstream repository is in Subversion, you should use ``git
509 pull --rebase`` instead of ``git pull`` to avoid generating a non-linear history
510 in your clone.  To configure ``git pull`` to pass ``--rebase`` by default on the
511 master branch, run the following command:
512
513 .. code-block:: console
514
515   % git config branch.master.rebase true
516
517 Sending patches with Git
518 ^^^^^^^^^^^^^^^^^^^^^^^^
519
520 Please read `Developer Policy <DeveloperPolicy.html#one-off-patches>`_, too.
521
522 Assume ``master`` points the upstream and ``mybranch`` points your working
523 branch, and ``mybranch`` is rebased onto ``master``.  At first you may check
524 sanity of whitespaces:
525
526 .. code-block:: console
527
528   % git diff --check master..mybranch
529
530 The easiest way to generate a patch is as below:
531
532 .. code-block:: console
533
534   % git diff master..mybranch > /path/to/mybranch.diff
535
536 It is a little different from svn-generated diff. git-diff-generated diff has
537 prefixes like ``a/`` and ``b/``. Don't worry, most developers might know it
538 could be accepted with ``patch -p1 -N``.
539
540 But you may generate patchset with git-format-patch. It generates by-each-commit
541 patchset. To generate patch files to attach to your article:
542
543 .. code-block:: console
544
545   % git format-patch --no-attach master..mybranch -o /path/to/your/patchset
546
547 If you would like to send patches directly, you may use git-send-email or
548 git-imap-send. Here is an example to generate the patchset in Gmail's [Drafts].
549
550 .. code-block:: console
551
552   % git format-patch --attach master..mybranch --stdout | git imap-send
553
554 Then, your .git/config should have [imap] sections.
555
556 .. code-block:: ini
557
558   [imap]
559         host = imaps://imap.gmail.com
560         user = your.gmail.account@gmail.com
561         pass = himitsu!
562         port = 993
563         sslverify = false
564   ; in English
565         folder = "[Gmail]/Drafts"
566   ; example for Japanese, "Modified UTF-7" encoded.
567         folder = "[Gmail]/&Tgtm+DBN-"
568   ; example for Traditional Chinese
569         folder = "[Gmail]/&g0l6Pw-"
570
571 For developers to work with git-svn
572 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
573
574 To set up clone from which you can submit code using ``git-svn``, run:
575
576 .. code-block:: console
577
578   % git clone http://llvm.org/git/llvm.git
579   % cd llvm
580   % git svn init https://llvm.org/svn/llvm-project/llvm/trunk --username=<username>
581   % git config svn-remote.svn.fetch :refs/remotes/origin/master
582   % git svn rebase -l  # -l avoids fetching ahead of the git mirror.
583
584   # If you have clang too:
585   % cd tools
586   % git clone http://llvm.org/git/clang.git
587   % cd clang
588   % git svn init https://llvm.org/svn/llvm-project/cfe/trunk --username=<username>
589   % git config svn-remote.svn.fetch :refs/remotes/origin/master
590   % git svn rebase -l
591
592 Likewise for compiler-rt and test-suite.
593
594 To update this clone without generating git-svn tags that conflict with the
595 upstream Git repo, run:
596
597 .. code-block:: console
598
599   % git fetch && (cd tools/clang && git fetch)  # Get matching revisions of both trees.
600   % git checkout master
601   % git svn rebase -l
602   % (cd tools/clang &&
603      git checkout master &&
604      git svn rebase -l)
605
606 Likewise for compiler-rt and test-suite.
607
608 This leaves your working directories on their master branches, so you'll need to
609 ``checkout`` each working branch individually and ``rebase`` it on top of its
610 parent branch.
611
612 For those who wish to be able to update an llvm repo/revert patches easily using
613 git-svn, please look in the directory for the scripts ``git-svnup`` and
614 ``git-svnrevert``.
615
616 To perform the aforementioned update steps go into your source directory and
617 just type ``git-svnup`` or ``git svnup`` and everything will just work.
618
619 If one wishes to revert a commit with git-svn, but do not want the git hash to
620 escape into the commit message, one can use the script ``git-svnrevert`` or
621 ``git svnrevert`` which will take in the git hash for the commit you want to
622 revert, look up the appropriate svn revision, and output a message where all
623 references to the git hash have been replaced with the svn revision.
624
625 To commit back changes via git-svn, use ``git svn dcommit``:
626
627 .. code-block:: console
628
629   % git svn dcommit
630
631 Note that git-svn will create one SVN commit for each Git commit you have pending,
632 so squash and edit each commit before executing ``dcommit`` to make sure they all
633 conform to the coding standards and the developers' policy.
634
635 On success, ``dcommit`` will rebase against the HEAD of SVN, so to avoid conflict,
636 please make sure your current branch is up-to-date (via fetch/rebase) before
637 proceeding.
638
639 The git-svn metadata can get out of sync after you mess around with branches and
640 ``dcommit``. When that happens, ``git svn dcommit`` stops working, complaining
641 about files with uncommitted changes. The fix is to rebuild the metadata:
642
643 .. code-block:: console
644
645   % rm -rf .git/svn
646   % git svn rebase -l
647
648 Please, refer to the Git-SVN manual (``man git-svn``) for more information.
649
650 Local LLVM Configuration
651 ------------------------
652
653 Once checked out from the Subversion repository, the LLVM suite source code must
654 be configured via the ``configure`` script.  This script sets variables in the
655 various ``*.in`` files, most notably ``llvm/Makefile.config`` and
656 ``llvm/include/Config/config.h``.  It also populates *OBJ_ROOT* with the
657 Makefiles needed to begin building LLVM.
658
659 The following environment variables are used by the ``configure`` script to
660 configure the build system:
661
662 +------------+-----------------------------------------------------------+
663 | Variable   | Purpose                                                   |
664 +============+===========================================================+
665 | CC         | Tells ``configure`` which C compiler to use.  By default, |
666 |            | ``configure`` will check ``PATH`` for ``clang`` and GCC C |
667 |            | compilers (in this order).  Use this variable to override |
668 |            | ``configure``\'s  default behavior.                       |
669 +------------+-----------------------------------------------------------+
670 | CXX        | Tells ``configure`` which C++ compiler to use.  By        |
671 |            | default, ``configure`` will check ``PATH`` for            |
672 |            | ``clang++`` and GCC C++ compilers (in this order).  Use   |
673 |            | this variable to override  ``configure``'s default        |
674 |            | behavior.                                                 |
675 +------------+-----------------------------------------------------------+
676
677 The following options can be used to set or enable LLVM specific options:
678
679 ``--enable-optimized``
680
681   Enables optimized compilation (debugging symbols are removed and GCC
682   optimization flags are enabled). Note that this is the default setting if you
683   are using the LLVM distribution. The default behavior of an Subversion
684   checkout is to use an unoptimized build (also known as a debug build).
685
686 ``--enable-debug-runtime``
687
688   Enables debug symbols in the runtime libraries. The default is to strip debug
689   symbols from the runtime libraries.
690
691 ``--enable-jit``
692
693   Compile the Just In Time (JIT) compiler functionality.  This is not available
694   on all platforms.  The default is dependent on platform, so it is best to
695   explicitly enable it if you want it.
696
697 ``--enable-targets=target-option``
698
699   Controls which targets will be built and linked into llc. The default value
700   for ``target_options`` is "all" which builds and links all available targets.
701   The value "host-only" can be specified to build only a native compiler (no
702   cross-compiler targets available). The "native" target is selected as the
703   target of the build host. You can also specify a comma separated list of
704   target names that you want available in llc. The target names use all lower
705   case. The current set of targets is:
706
707     ``arm, cpp, hexagon, mips, mipsel, msp430, powerpc, ptx, sparc, spu,
708     systemz, x86, x86_64, xcore``.
709
710 ``--enable-doxygen``
711
712   Look for the doxygen program and enable construction of doxygen based
713   documentation from the source code. This is disabled by default because
714   generating the documentation can take a long time and producess 100s of
715   megabytes of output.
716
717 ``--with-udis86``
718
719   LLVM can use external disassembler library for various purposes (now it's used
720   only for examining code produced by JIT). This option will enable usage of
721   `udis86 <http://udis86.sourceforge.net/>`_ x86 (both 32 and 64 bits)
722   disassembler library.
723
724 To configure LLVM, follow these steps:
725
726 #. Change directory into the object root directory:
727
728    .. code-block:: console
729
730      % cd OBJ_ROOT
731
732 #. Run the ``configure`` script located in the LLVM source tree:
733
734    .. code-block:: console
735
736      % SRC_ROOT/configure --prefix=/install/path [other options]
737
738 Compiling the LLVM Suite Source Code
739 ------------------------------------
740
741 Once you have configured LLVM, you can build it.  There are three types of
742 builds:
743
744 Debug Builds
745
746   These builds are the default when one is using an Subversion checkout and
747   types ``gmake`` (unless the ``--enable-optimized`` option was used during
748   configuration).  The build system will compile the tools and libraries with
749   debugging information.  To get a Debug Build using the LLVM distribution the
750   ``--disable-optimized`` option must be passed to ``configure``.
751
752 Release (Optimized) Builds
753
754   These builds are enabled with the ``--enable-optimized`` option to
755   ``configure`` or by specifying ``ENABLE_OPTIMIZED=1`` on the ``gmake`` command
756   line.  For these builds, the build system will compile the tools and libraries
757   with GCC optimizations enabled and strip debugging information from the
758   libraries and executables it generates.  Note that Release Builds are default
759   when using an LLVM distribution.
760
761 Profile Builds
762
763   These builds are for use with profiling.  They compile profiling information
764   into the code for use with programs like ``gprof``.  Profile builds must be
765   started by specifying ``ENABLE_PROFILING=1`` on the ``gmake`` command line.
766
767 Once you have LLVM configured, you can build it by entering the *OBJ_ROOT*
768 directory and issuing the following command:
769
770 .. code-block:: console
771
772   % gmake
773
774 If the build fails, please `check here`_ to see if you are using a version of
775 GCC that is known not to compile LLVM.
776
777 If you have multiple processors in your machine, you may wish to use some of the
778 parallel build options provided by GNU Make.  For example, you could use the
779 command:
780
781 .. code-block:: console
782
783   % gmake -j2
784
785 There are several special targets which are useful when working with the LLVM
786 source code:
787
788 ``gmake clean``
789
790   Removes all files generated by the build.  This includes object files,
791   generated C/C++ files, libraries, and executables.
792
793 ``gmake dist-clean``
794
795   Removes everything that ``gmake clean`` does, but also removes files generated
796   by ``configure``.  It attempts to return the source tree to the original state
797   in which it was shipped.
798
799 ``gmake install``
800
801   Installs LLVM header files, libraries, tools, and documentation in a hierarchy
802   under ``$PREFIX``, specified with ``./configure --prefix=[dir]``, which
803   defaults to ``/usr/local``.
804
805 ``gmake -C runtime install-bytecode``
806
807   Assuming you built LLVM into $OBJDIR, when this command is run, it will
808   install bitcode libraries into the GCC front end's bitcode library directory.
809   If you need to update your bitcode libraries, this is the target to use once
810   you've built them.
811
812 Please see the `Makefile Guide <MakefileGuide.html>`_ for further details on
813 these ``make`` targets and descriptions of other targets available.
814
815 It is also possible to override default values from ``configure`` by declaring
816 variables on the command line.  The following are some examples:
817
818 ``gmake ENABLE_OPTIMIZED=1``
819
820   Perform a Release (Optimized) build.
821
822 ``gmake ENABLE_OPTIMIZED=1 DISABLE_ASSERTIONS=1``
823
824   Perform a Release (Optimized) build without assertions enabled.
825  
826 ``gmake ENABLE_OPTIMIZED=0``
827
828   Perform a Debug build.
829
830 ``gmake ENABLE_PROFILING=1``
831
832   Perform a Profiling build.
833
834 ``gmake VERBOSE=1``
835
836   Print what ``gmake`` is doing on standard output.
837
838 ``gmake TOOL_VERBOSE=1``
839
840   Ask each tool invoked by the makefiles to print out what it is doing on 
841   the standard output. This also implies ``VERBOSE=1``.
842
843 Every directory in the LLVM object tree includes a ``Makefile`` to build it and
844 any subdirectories that it contains.  Entering any directory inside the LLVM
845 object tree and typing ``gmake`` should rebuild anything in or below that
846 directory that is out of date.
847
848 This does not apply to building the documentation.
849 LLVM's (non-Doxygen) documentation is produced with the
850 `Sphinx <http://sphinx-doc.org/>`_ documentation generation system.
851 There are some HTML documents that have not yet been converted to the new
852 system (which uses the easy-to-read and easy-to-write
853 `reStructuredText <http://sphinx-doc.org/rest.html>`_ plaintext markup
854 language).
855 The generated documentation is built in the ``SRC_ROOT/docs`` directory using
856 a special makefile.
857 For instructions on how to install Sphinx, see
858 `Sphinx Introduction for LLVM Developers
859 <http://lld.llvm.org/sphinx_intro.html>`_.
860 After following the instructions there for installing Sphinx, build the LLVM
861 HTML documentation by doing the following:
862
863 .. code-block:: console
864
865   $ cd SRC_ROOT/docs
866   $ make -f Makefile.sphinx
867
868 This creates a ``_build/html`` sub-directory with all of the HTML files, not
869 just the generated ones.
870 This directory corresponds to ``llvm.org/docs``.
871 For example, ``_build/html/SphinxQuickstartTemplate.html`` corresponds to
872 ``llvm.org/docs/SphinxQuickstartTemplate.html``.
873 The :doc:`SphinxQuickstartTemplate` is useful when creating a new document.
874
875 Cross-Compiling LLVM
876 --------------------
877
878 It is possible to cross-compile LLVM itself. That is, you can create LLVM
879 executables and libraries to be hosted on a platform different from the platform
880 where they are built (a Canadian Cross build). To configure a cross-compile,
881 supply the configure script with ``--build`` and ``--host`` options that are
882 different. The values of these options must be legal target triples that your
883 GCC compiler supports.
884
885 The result of such a build is executables that are not runnable on on the build
886 host (--build option) but can be executed on the compile host (--host option).
887
888 Check :doc:`HowToCrossCompileLLVM` and `Clang docs on how to cross-compile in general
889 <http://clang.llvm.org/docs/CrossCompilation.html>`_ for more information
890 about cross-compiling.
891
892 The Location of LLVM Object Files
893 ---------------------------------
894
895 The LLVM build system is capable of sharing a single LLVM source tree among
896 several LLVM builds.  Hence, it is possible to build LLVM for several different
897 platforms or configurations using the same source tree.
898
899 This is accomplished in the typical autoconf manner:
900
901 * Change directory to where the LLVM object files should live:
902
903   .. code-block:: console
904
905     % cd OBJ_ROOT
906
907 * Run the ``configure`` script found in the LLVM source directory:
908
909   .. code-block:: console
910
911     % SRC_ROOT/configure
912
913 The LLVM build will place files underneath *OBJ_ROOT* in directories named after
914 the build type:
915
916 Debug Builds with assertions enabled (the default)
917
918   Tools
919
920     ``OBJ_ROOT/Debug+Asserts/bin``
921
922   Libraries
923
924     ``OBJ_ROOT/Debug+Asserts/lib``
925
926 Release Builds
927
928   Tools
929
930     ``OBJ_ROOT/Release/bin``
931
932   Libraries
933
934     ``OBJ_ROOT/Release/lib``
935
936 Profile Builds
937
938   Tools
939
940     ``OBJ_ROOT/Profile/bin``
941
942   Libraries
943
944     ``OBJ_ROOT/Profile/lib``
945
946 Optional Configuration Items
947 ----------------------------
948
949 If you're running on a Linux system that supports the `binfmt_misc
950 <http://en.wikipedia.org/wiki/binfmt_misc>`_
951 module, and you have root access on the system, you can set your system up to
952 execute LLVM bitcode files directly. To do this, use commands like this (the
953 first command may not be required if you are already using the module):
954
955 .. code-block:: console
956
957   % mount -t binfmt_misc none /proc/sys/fs/binfmt_misc
958   % echo ':llvm:M::BC::/path/to/lli:' > /proc/sys/fs/binfmt_misc/register
959   % chmod u+x hello.bc   (if needed)
960   % ./hello.bc
961
962 This allows you to execute LLVM bitcode files directly.  On Debian, you can also
963 use this command instead of the 'echo' command above:
964
965 .. code-block:: console
966
967   % sudo update-binfmts --install llvm /path/to/lli --magic 'BC'
968
969 .. _Program Layout:
970 .. _general layout:
971
972 Program Layout
973 ==============
974
975 One useful source of information about the LLVM source base is the LLVM `doxygen
976 <http://www.doxygen.org/>`_ documentation available at
977 `<http://llvm.org/doxygen/>`_.  The following is a brief introduction to code
978 layout:
979
980 ``llvm/examples``
981 -----------------
982
983 This directory contains some simple examples of how to use the LLVM IR and JIT.
984
985 ``llvm/include``
986 ----------------
987
988 This directory contains public header files exported from the LLVM library. The
989 three main subdirectories of this directory are:
990
991 ``llvm/include/llvm``
992
993   This directory contains all of the LLVM specific header files.  This directory
994   also has subdirectories for different portions of LLVM: ``Analysis``,
995   ``CodeGen``, ``Target``, ``Transforms``, etc...
996
997 ``llvm/include/llvm/Support``
998
999   This directory contains generic support libraries that are provided with LLVM
1000   but not necessarily specific to LLVM. For example, some C++ STL utilities and
1001   a Command Line option processing library store their header files here.
1002
1003 ``llvm/include/llvm/Config``
1004
1005   This directory contains header files configured by the ``configure`` script.
1006   They wrap "standard" UNIX and C header files.  Source code can include these
1007   header files which automatically take care of the conditional #includes that
1008   the ``configure`` script generates.
1009
1010 ``llvm/lib``
1011 ------------
1012
1013 This directory contains most of the source files of the LLVM system. In LLVM,
1014 almost all code exists in libraries, making it very easy to share code among the
1015 different `tools`_.
1016
1017 ``llvm/lib/VMCore/``
1018
1019   This directory holds the core LLVM source files that implement core classes
1020   like Instruction and BasicBlock.
1021
1022 ``llvm/lib/AsmParser/``
1023
1024   This directory holds the source code for the LLVM assembly language parser
1025   library.
1026
1027 ``llvm/lib/Bitcode/``
1028
1029   This directory holds code for reading and write LLVM bitcode.
1030
1031 ``llvm/lib/Analysis/``
1032
1033   This directory contains a variety of different program analyses, such as
1034   Dominator Information, Call Graphs, Induction Variables, Interval
1035   Identification, Natural Loop Identification, etc.
1036
1037 ``llvm/lib/Transforms/``
1038
1039   This directory contains the source code for the LLVM to LLVM program
1040   transformations, such as Aggressive Dead Code Elimination, Sparse Conditional
1041   Constant Propagation, Inlining, Loop Invariant Code Motion, Dead Global
1042   Elimination, and many others.
1043
1044 ``llvm/lib/Target/``
1045
1046   This directory contains files that describe various target architectures for
1047   code generation.  For example, the ``llvm/lib/Target/X86`` directory holds the
1048   X86 machine description while ``llvm/lib/Target/ARM`` implements the ARM
1049   backend.
1050     
1051 ``llvm/lib/CodeGen/``
1052
1053   This directory contains the major parts of the code generator: Instruction
1054   Selector, Instruction Scheduling, and Register Allocation.
1055
1056 ``llvm/lib/MC/``
1057
1058   (FIXME: T.B.D.)
1059
1060 ``llvm/lib/Debugger/``
1061
1062   This directory contains the source level debugger library that makes it
1063   possible to instrument LLVM programs so that a debugger could identify source
1064   code locations at which the program is executing.
1065
1066 ``llvm/lib/ExecutionEngine/``
1067
1068   This directory contains libraries for executing LLVM bitcode directly at
1069   runtime in both interpreted and JIT compiled fashions.
1070
1071 ``llvm/lib/Support/``
1072
1073   This directory contains the source code that corresponds to the header files
1074   located in ``llvm/include/ADT/`` and ``llvm/include/Support/``.
1075
1076 ``llvm/projects``
1077 -----------------
1078
1079 This directory contains projects that are not strictly part of LLVM but are
1080 shipped with LLVM. This is also the directory where you should create your own
1081 LLVM-based projects.
1082
1083 ``llvm/runtime``
1084 ----------------
1085
1086 This directory contains libraries which are compiled into LLVM bitcode and used
1087 when linking programs with the Clang front end.  Most of these libraries are
1088 skeleton versions of real libraries; for example, libc is a stripped down
1089 version of glibc.
1090
1091 Unlike the rest of the LLVM suite, this directory needs the LLVM GCC front end
1092 to compile.
1093
1094 ``llvm/test``
1095 -------------
1096
1097 This directory contains feature and regression tests and other basic sanity
1098 checks on the LLVM infrastructure. These are intended to run quickly and cover a
1099 lot of territory without being exhaustive.
1100
1101 ``test-suite``
1102 --------------
1103
1104 This is not a directory in the normal llvm module; it is a separate Subversion
1105 module that must be checked out (usually to ``projects/test-suite``).  This
1106 module contains a comprehensive correctness, performance, and benchmarking test
1107 suite for LLVM. It is a separate Subversion module because not every LLVM user
1108 is interested in downloading or building such a comprehensive test suite. For
1109 further details on this test suite, please see the :doc:`Testing Guide
1110 <TestingGuide>` document.
1111
1112 .. _tools:
1113
1114 ``llvm/tools``
1115 --------------
1116
1117 The **tools** directory contains the executables built out of the libraries
1118 above, which form the main part of the user interface.  You can always get help
1119 for a tool by typing ``tool_name -help``.  The following is a brief introduction
1120 to the most important tools.  More detailed information is in
1121 the `Command Guide <CommandGuide/index.html>`_.
1122
1123 ``bugpoint``
1124
1125   ``bugpoint`` is used to debug optimization passes or code generation backends
1126   by narrowing down the given test case to the minimum number of passes and/or
1127   instructions that still cause a problem, whether it is a crash or
1128   miscompilation. See `<HowToSubmitABug.html>`_ for more information on using
1129   ``bugpoint``.
1130
1131 ``llvm-ar``
1132
1133   The archiver produces an archive containing the given LLVM bitcode files,
1134   optionally with an index for faster lookup.
1135   
1136 ``llvm-as``
1137
1138   The assembler transforms the human readable LLVM assembly to LLVM bitcode.
1139
1140 ``llvm-dis``
1141
1142   The disassembler transforms the LLVM bitcode to human readable LLVM assembly.
1143
1144 ``llvm-link``
1145
1146   ``llvm-link``, not surprisingly, links multiple LLVM modules into a single
1147   program.
1148   
1149 ``lli``
1150
1151   ``lli`` is the LLVM interpreter, which can directly execute LLVM bitcode
1152   (although very slowly...). For architectures that support it (currently x86,
1153   Sparc, and PowerPC), by default, ``lli`` will function as a Just-In-Time
1154   compiler (if the functionality was compiled in), and will execute the code
1155   *much* faster than the interpreter.
1156
1157 ``llc``
1158
1159   ``llc`` is the LLVM backend compiler, which translates LLVM bitcode to a
1160   native code assembly file or to C code (with the ``-march=c`` option).
1161
1162 ``opt``
1163
1164   ``opt`` reads LLVM bitcode, applies a series of LLVM to LLVM transformations
1165   (which are specified on the command line), and then outputs the resultant
1166   bitcode.  The '``opt -help``' command is a good way to get a list of the
1167   program transformations available in LLVM.
1168
1169   ``opt`` can also be used to run a specific analysis on an input LLVM bitcode
1170   file and print out the results.  It is primarily useful for debugging
1171   analyses, or familiarizing yourself with what an analysis does.
1172
1173 ``llvm/utils``
1174 --------------
1175
1176 This directory contains utilities for working with LLVM source code, and some of
1177 the utilities are actually required as part of the build process because they
1178 are code generators for parts of LLVM infrastructure.
1179
1180
1181 ``codegen-diff``
1182
1183   ``codegen-diff`` is a script that finds differences between code that LLC
1184   generates and code that LLI generates. This is a useful tool if you are
1185   debugging one of them, assuming that the other generates correct output. For
1186   the full user manual, run ```perldoc codegen-diff'``.
1187
1188 ``emacs/``
1189
1190   The ``emacs`` directory contains syntax-highlighting files which will work
1191   with Emacs and XEmacs editors, providing syntax highlighting support for LLVM
1192   assembly files and TableGen description files. For information on how to use
1193   the syntax files, consult the ``README`` file in that directory.
1194
1195 ``getsrcs.sh``
1196
1197   The ``getsrcs.sh`` script finds and outputs all non-generated source files,
1198   which is useful if one wishes to do a lot of development across directories
1199   and does not want to individually find each file. One way to use it is to run,
1200   for example: ``xemacs `utils/getsources.sh``` from the top of your LLVM source
1201   tree.
1202
1203 ``llvmgrep``
1204
1205   This little tool performs an ``egrep -H -n`` on each source file in LLVM and
1206   passes to it a regular expression provided on ``llvmgrep``'s command
1207   line. This is a very efficient way of searching the source base for a
1208   particular regular expression.
1209
1210 ``makellvm``
1211
1212   The ``makellvm`` script compiles all files in the current directory and then
1213   compiles and links the tool that is the first argument. For example, assuming
1214   you are in the directory ``llvm/lib/Target/Sparc``, if ``makellvm`` is in your
1215   path, simply running ``makellvm llc`` will make a build of the current
1216   directory, switch to directory ``llvm/tools/llc`` and build it, causing a
1217   re-linking of LLC.
1218
1219 ``TableGen/``
1220
1221   The ``TableGen`` directory contains the tool used to generate register
1222   descriptions, instruction set descriptions, and even assemblers from common
1223   TableGen description files.
1224
1225 ``vim/``
1226
1227   The ``vim`` directory contains syntax-highlighting files which will work with
1228   the VIM editor, providing syntax highlighting support for LLVM assembly files
1229   and TableGen description files. For information on how to use the syntax
1230   files, consult the ``README`` file in that directory.
1231
1232 .. _simple example:
1233
1234 An Example Using the LLVM Tool Chain
1235 ====================================
1236
1237 This section gives an example of using LLVM with the Clang front end.
1238
1239 Example with clang
1240 ------------------
1241
1242 #. First, create a simple C file, name it 'hello.c':
1243
1244    .. code-block:: c
1245
1246      #include <stdio.h>
1247
1248      int main() {
1249        printf("hello world\n");
1250        return 0;
1251      }
1252
1253 #. Next, compile the C file into a native executable:
1254
1255    .. code-block:: console
1256
1257      % clang hello.c -o hello
1258
1259    .. note::
1260
1261      Clang works just like GCC by default.  The standard -S and -c arguments
1262      work as usual (producing a native .s or .o file, respectively).
1263
1264 #. Next, compile the C file into an LLVM bitcode file:
1265
1266    .. code-block:: console
1267
1268      % clang -O3 -emit-llvm hello.c -c -o hello.bc
1269
1270    The -emit-llvm option can be used with the -S or -c options to emit an LLVM
1271    ``.ll`` or ``.bc`` file (respectively) for the code.  This allows you to use
1272    the `standard LLVM tools <CommandGuide/index.html>`_ on the bitcode file.
1273
1274 #. Run the program in both forms. To run the program, use:
1275
1276    .. code-block:: console
1277
1278       % ./hello
1279  
1280    and
1281
1282    .. code-block:: console
1283
1284      % lli hello.bc
1285
1286    The second examples shows how to invoke the LLVM JIT, :doc:`lli
1287    <CommandGuide/lli>`.
1288
1289 #. Use the ``llvm-dis`` utility to take a look at the LLVM assembly code:
1290
1291    .. code-block:: console
1292
1293      % llvm-dis < hello.bc | less
1294
1295 #. Compile the program to native assembly using the LLC code generator:
1296
1297    .. code-block:: console
1298
1299      % llc hello.bc -o hello.s
1300
1301 #. Assemble the native assembly language file into a program:
1302
1303    .. code-block:: console
1304
1305      % /opt/SUNWspro/bin/cc -xarch=v9 hello.s -o hello.native   # On Solaris
1306
1307      % gcc hello.s -o hello.native                              # On others
1308
1309 #. Execute the native code program:
1310
1311    .. code-block:: console
1312
1313      % ./hello.native
1314
1315    Note that using clang to compile directly to native code (i.e. when the
1316    ``-emit-llvm`` option is not present) does steps 6/7/8 for you.
1317
1318 Common Problems
1319 ===============
1320
1321 If you are having problems building or using LLVM, or if you have any other
1322 general questions about LLVM, please consult the `Frequently Asked
1323 Questions <FAQ.html>`_ page.
1324
1325 .. _links:
1326
1327 Links
1328 =====
1329
1330 This document is just an **introduction** on how to use LLVM to do some simple
1331 things... there are many more interesting and complicated things that you can do
1332 that aren't documented here (but we'll gladly accept a patch if you want to
1333 write something up!).  For more information about LLVM, check out:
1334
1335 * `LLVM Homepage <http://llvm.org/>`_
1336 * `LLVM Doxygen Tree <http://llvm.org/doxygen/>`_
1337 * `Starting a Project that Uses LLVM <http://llvm.org/docs/Projects.html>`_