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