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