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