Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / clang / fa5fa97a1428e95540cbe95138e781a59bff7e39 / . / www / get_started.html
blob: 6d4e75f330f3ce83ccf8d4cfa26b1544789b6477 [file] [log] [blame]
Eric Christopher7dc0e572008-02-08 06:45:49 +0000[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
3<html>
4<head>
5 <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
6 <title>Clang - Getting Started</title>
7 <link type="text/css" rel="stylesheet" href="menu.css" />
8 <link type="text/css" rel="stylesheet" href="content.css" />
9</head>
10<body>
11
12<!--#include virtual="menu.html.incl"-->
13
14<div id="content">
15
16<h1>Getting Started: Building and Running Clang</h1>
17
Ted Kremenek9b16da32009-03-27 16:32:57 +0000[diff] [blame]18<p>This page gives you the shortest path to checking out Clang and demos a few
Eric Christopher7dc0e572008-02-08 06:45:49 +0000[diff] [blame]19options. This should get you up and running with the minimum of muss and fuss.
20If you like what you see, please consider <a href="get_involved.html">getting
Chris Lattnerd2c1c602009-11-09 03:18:18 +0000[diff] [blame]21involved</a> with the Clang community. If you run into problems, please file
Douglas Gregor9ff3e662010-10-07 20:20:57 +0000[diff] [blame]22bugs in <a href="http://llvm.org/bugs/">LLVM Bugzilla</a>.</p>
Eric Christopher7dc0e572008-02-08 06:45:49 +0000[diff] [blame]23
Ted Kremenek9b16da32009-03-27 16:32:57 +0000[diff] [blame]24<h2 id="build">Building Clang and Working with the Code</h2>
Eric Christopher7dc0e572008-02-08 06:45:49 +0000[diff] [blame]25
Eli Friedmand1e1ef32009-08-03 19:42:28 +0000[diff] [blame]26<h3 id="buildNix">On Unix-like Systems</h3>
27
Ted Kremenek9b16da32009-03-27 16:32:57 +0000[diff] [blame]28<p>If you would like to check out and build Clang, the current procedure is as
29follows:</p>
Eric Christopher7dc0e572008-02-08 06:45:49 +0000[diff] [blame]30
31<ol>
Anton Korobeynikov1816e482009-08-06 13:00:08 +0000[diff] [blame]32 <li>Get the required tools.
33 <ul>
34 <li>See
35 <a href="http://llvm.org/docs/GettingStarted.html#requirements">
36 Getting Started with the LLVM System - Requirements</a>.</li>
37 <li>Note also that Python is needed for running the test suite.
38 Get it at: <a href="http://www.python.org/download">
39 http://www.python.org/download</a></li>
40 </ul>
41
Chris Lattner357f7ce2009-08-20 06:17:11 +0000[diff] [blame]42 <li>Checkout LLVM:</li>
Eric Christopher7dc0e572008-02-08 06:45:49 +0000[diff] [blame]43 <ul>
Chris Lattner357f7ce2009-08-20 06:17:11 +0000[diff] [blame]44 <li>Change directory to where you want the llvm directory placed.</li>
Eric Christopher7dc0e572008-02-08 06:45:49 +0000[diff] [blame]45 <li><tt>svn co http://llvm.org/svn/llvm-project/llvm/trunk llvm</tt></li>
Eric Christopher7dc0e572008-02-08 06:45:49 +0000[diff] [blame]46 </ul>
Ted Kremenek9b16da32009-03-27 16:32:57 +0000[diff] [blame]47 <li>Checkout Clang:</li>
Eric Christopher7dc0e572008-02-08 06:45:49 +0000[diff] [blame]48 <ul>
Chris Lattner357f7ce2009-08-20 06:17:11 +0000[diff] [blame]49 <li><tt>cd llvm/tools</tt>
50 <li><tt>svn co http://llvm.org/svn/llvm-project/cfe/trunk clang</tt></li>
51 </ul>
52 <li>Build LLVM and Clang:</li>
53 <ul>
Rafael Espindolafa5fa972010-10-29 22:05:17 +0000[diff] [blame^]54 <li><tt>cd ../..</tt> (back to where you started)</li>
55 <li><tt>mkdir build</tt> (for building without polluting the source dir)
56 </li>
57 <li><tt>cd build</tt></li>
58 <li><tt>../llvm/configure</tt></li>
Chris Lattner357f7ce2009-08-20 06:17:11 +0000[diff] [blame]59 <li><tt>make</tt></li>
60 <li>This builds both LLVM and Clang for debug mode.</li>
61 <li>Note: For subsequent Clang development, you can just do make at the
62 clang directory level.</li>
Eric Christopher7dc0e572008-02-08 06:45:49 +0000[diff] [blame]63 </ul>
Chris Lattner78781782010-05-06 21:57:57 +0000[diff] [blame]64
65 <p>It is also possible to use CMake instead of the makefiles. With CMake it
66 is also possible to generate project files for several IDEs: Eclipse CDT4,
67 CodeBlocks, Qt-Creator (use the CodeBlocks generator), KDevelop3.</p>
68
Ted Kremenek9b16da32009-03-27 16:32:57 +0000[diff] [blame]69 <li>If you intend to work on Clang C++ support, you may need to tell it how
70 to find your C++ standard library headers. If Clang cannot find your
Chris Lattnerca8c49f2009-03-10 16:01:44 +0000[diff] [blame]71 system libstdc++ headers, please follow these instructions:</li>
Eric Christopher7dc0e572008-02-08 06:45:49 +0000[diff] [blame]72 <ul>
Gabor Greif74350822010-03-29 21:36:06 +0000[diff] [blame]73 <li>'<tt>gcc -v -x c++ /dev/null -fsyntax-only</tt>' to get the
Eric Christopher7dc0e572008-02-08 06:45:49 +0000[diff] [blame]74 path.</li>
75 <li>Look for the comment "FIXME: temporary hack:
Chris Lattnerca8c49f2009-03-10 16:01:44 +0000[diff] [blame]76 hard-coded paths" in <tt>clang/lib/Frontend/InitHeaderSearch.cpp</tt> and
Eric Christopher7dc0e572008-02-08 06:45:49 +0000[diff] [blame]77 change the lines below to include that path.</li>
78 </ul>
Chris Lattnerbe9a5ca2010-07-26 22:51:00 +0000[diff] [blame]79 <li>Try it out (assuming you add llvm/Debug+Asserts/bin to your path):</li>
Eric Christopher7dc0e572008-02-08 06:45:49 +0000[diff] [blame]80 <ul>
Daniel Dunbardd63b282009-12-11 23:04:35 +0000[diff] [blame]81 <li><tt>clang --help</tt></li>
82 <li><tt>clang file.c -fsyntax-only</tt> (check for correctness)</li>
83 <li><tt>clang file.c -S -emit-llvm -o -</tt> (print out unoptimized llvm code)</li>
84 <li><tt>clang file.c -S -emit-llvm -o - -O3</tt></li>
85 <li><tt>clang file.c -S -O3 -o -</tt> (output native machine code)</li>
Eric Christopher7dc0e572008-02-08 06:45:49 +0000[diff] [blame]86 </ul>
87</ol>
88
Ted Kremenek9b16da32009-03-27 16:32:57 +0000[diff] [blame]89<p>Note that the C front-end uses LLVM, but does not depend on llvm-gcc. If you
90encounter problems with building Clang, make sure you have the latest SVN
91version of LLVM. LLVM contains support libraries for Clang that will be updated
92as well as development on Clang progresses.</p>
Ted Kremenek675a9ba2008-02-08 07:32:26 +0000[diff] [blame]93
Ted Kremenek9b16da32009-03-27 16:32:57 +0000[diff] [blame]94<h3>Simultaneously Building Clang and LLVM:</h3>
Eric Christopher562b4f32008-02-08 07:10:48 +0000[diff] [blame]95
Ted Kremenek9b16da32009-03-27 16:32:57 +0000[diff] [blame]96<p>Once you have checked out Clang into the llvm source tree it will build along
97with the rest of <tt>llvm</tt>. To build all of LLVM and Clang together all at
98once simply run <tt>make</tt> from the root LLVM directory.</p>
99
100<p><em>Note:</em> Observe that Clang is technically part of a separate
101Subversion repository. As mentioned above, the latest Clang sources are tied to
102the latest sources in the LLVM tree. You can update your toplevel LLVM project
103and all (possibly unrelated) projects inside it with <tt><b>make
104update</b></tt>. This will run <tt>svn update</tt> on all subdirectories related
105to subversion. </p>
Eric Christopher7dc0e572008-02-08 06:45:49 +0000[diff] [blame]106
Eli Friedmand1e1ef32009-08-03 19:42:28 +0000[diff] [blame]107<h3 id="buildWindows">Using Visual Studio</h3>
108
109<p>The following details setting up for and building Clang on Windows using
110Visual Studio:</p>
111
112<ol>
113 <li>Get the required tools:</li>
114 <ul>
115 <li><b>Subversion</b>. Source code control program. Get it from:
116 <a href="http://subversion.tigris.org/getting.html">
117 http://subversion.tigris.org/getting.html</a></li>
118 <li><b>cmake</b>. This is used for generating Visual Studio solution and
119 project files. Get it from:
120 <a href="http://www.cmake.org/cmake/resources/software.html">
121 http://www.cmake.org/cmake/resources/software.html</a></li>
Cedric Venet6bfc8b62009-09-27 10:34:36 +0000[diff] [blame]122 <li><b>Visual Studio 2005 or 2008</b></li>
Chris Lattner357f7ce2009-08-20 06:17:11 +0000[diff] [blame]123 <li><b>Python</b>. This is needed only if you will be running the tests
Eli Friedmand1e1ef32009-08-03 19:42:28 +0000[diff] [blame]124 (which is essential, if you will be developing for clang).
125 Get it from:
126 <a href="http://www.python.org/download">
127 http://www.python.org/download</a></li>
Chris Lattner357f7ce2009-08-20 06:17:11 +0000[diff] [blame]128 <li><b>GnuWin32 tools</b>
129 These are also necessary for running the tests.
130 (Note that the grep from MSYS or Cygwin doesn't work with the tests
131 because of embedded double-quotes in the search strings. The GNU
132 grep does work in this case.)
133 Get them from <a href="http://getgnuwin32.sourceforge.net">
134 http://getgnuwin32.sourceforge.net</a>.</li>
Eli Friedmand1e1ef32009-08-03 19:42:28 +0000[diff] [blame]135 </ul>
136
137 <li>Checkout LLVM:</li>
138 <ul>
139 <li><tt>svn co http://llvm.org/svn/llvm-project/llvm/trunk llvm</tt></li>
140 </ul>
141 <li>Checkout Clang:</li>
142 <ul>
143 <li><tt>cd llvm\tools</tt>
144 <li><tt>svn co http://llvm.org/svn/llvm-project/cfe/trunk clang</tt></li>
145 </ul>
146 <li>Run cmake to generate the Visual Studio solution and project files:</li>
147 <ul>
148 <li><tt>cd ..</tt> (Change directory back to the llvm top.)</li>
John Thompson99ff8da2009-11-06 00:06:29 +0000[diff] [blame]149 <li>If you are using Visual Studio 2005: <tt>cmake .</tt></li>
150 <li>Or if you are using Visual Studio 2008: <tt>cmake -G "Visual Studio 9 2008" .</tt></li>
Eli Friedmand1e1ef32009-08-03 19:42:28 +0000[diff] [blame]151 <li>The above, if successful, will have created an LLVM.sln file in the
152 llvm directory.
153 </ul>
154 <li>Build Clang:</li>
155 <ul>
156 <li>Open LLVM.sln in Visual Studio.</li>
Daniel Dunbardd63b282009-12-11 23:04:35 +0000[diff] [blame]157 <li>Build the "clang" project for just the compiler driver and front end, or
158 the "ALL_BUILD" project to build everything, including tools.</li>
Eli Friedmand1e1ef32009-08-03 19:42:28 +0000[diff] [blame]159 </ul>
160 <li>Try it out (assuming you added llvm/debug/bin to your path). (See the
161 running examples from above.)</li>
162 <li>See <a href="hacking.html#testingWindows">
163 Hacking on clang - Testing using Visual Studio on Windows</a> for information
164 on running regression tests on Windows.</li>
165</ol>
166
167<p>Note that once you have checked out both llvm and clang, to synchronize
168to the latest code base, use the <tt>svn update</tt> command in both the
169llvm and llvm\tools\clang directories, as they are separate repositories.</p>
170
Daniel Dunbardd63b282009-12-11 23:04:35 +0000[diff] [blame]171<a name="driver"><h2>Clang Compiler Driver (Drop-in Substitute for GCC)</h2></a>
Ted Kremenek9b16da32009-03-27 16:32:57 +0000[diff] [blame]172
Daniel Dunbardd63b282009-12-11 23:04:35 +0000[diff] [blame]173<p>The <tt>clang</tt> tool is the compiler driver and front-end, which is
174designed to be a drop-in replacement for the <tt>gcc</tt> command. Here are
175some examples of how to use the high-level driver:
Ted Kremenek9b16da32009-03-27 16:32:57 +0000[diff] [blame]176</p>
177
178<pre class="code">
179$ <b>cat t.c</b>
180#include &lt;stdio.h&gt;
181int main(int argc, char **argv) { printf("hello world\n"); }
182$ <b>clang t.c</b>
183$ <b>./a.out</b>
184hello world
185</pre>
186
Chris Lattner63d423d2009-11-09 03:21:02 +0000[diff] [blame]187<p>The 'clang' driver is designed to work as closely to GCC as possible to
188 maximize portability. The only major difference between the two is that
189 Clang defaults to gnu99 mode while GCC defaults to gnu89 mode. If you see
Chris Lattnerd73fef62009-11-09 04:04:07 +0000[diff] [blame]190 weird link-time errors relating to inline functions, try passing -std=gnu89
Chris Lattner63d423d2009-11-09 03:21:02 +0000[diff] [blame]191 to clang.</p>
192
Ted Kremenek9b16da32009-03-27 16:32:57 +0000[diff] [blame]193<h2>Examples of using Clang</h2>
194
Eric Christopher7dc0e572008-02-08 06:45:49 +0000[diff] [blame]195<!-- Thanks to
196 http://shiflett.org/blog/2006/oct/formatting-and-highlighting-php-code-listings
197Site suggested using pre in CSS, but doesn't work in IE, so went for the <pre>
198tag. -->
199
200<pre class="code">
201$ <b>cat ~/t.c</b>
202typedef float V __attribute__((vector_size(16)));
203V foo(V a, V b) { return a+b*a; }
204</pre>
205
206
Ted Kremenek35f29c52008-06-17 13:48:36 +0000[diff] [blame]207<h3>Preprocessing:</h3>
Eric Christopher7dc0e572008-02-08 06:45:49 +0000[diff] [blame]208
209<pre class="code">
210$ <b>clang ~/t.c -E</b>
211# 1 "/Users/sabre/t.c" 1
212
213typedef float V __attribute__((vector_size(16)));
214
215V foo(V a, V b) { return a+b*a; }
216</pre>
217
218
Ted Kremenek35f29c52008-06-17 13:48:36 +0000[diff] [blame]219<h3>Type checking:</h3>
Eric Christopher7dc0e572008-02-08 06:45:49 +0000[diff] [blame]220
221<pre class="code">
222$ <b>clang -fsyntax-only ~/t.c</b>
223</pre>
224
225
Ted Kremenek35f29c52008-06-17 13:48:36 +0000[diff] [blame]226<h3>GCC options:</h3>
Eric Christopher7dc0e572008-02-08 06:45:49 +0000[diff] [blame]227
228<pre class="code">
229$ <b>clang -fsyntax-only ~/t.c -pedantic</b>
230/Users/sabre/t.c:2:17: warning: extension used
231typedef float V __attribute__((vector_size(16)));
232 ^
2331 diagnostic generated.
234</pre>
235
236
Ted Kremenek35f29c52008-06-17 13:48:36 +0000[diff] [blame]237<h3>Pretty printing from the AST:</h3>
Eric Christopher7dc0e572008-02-08 06:45:49 +0000[diff] [blame]238
Daniel Dunbardd63b282009-12-11 23:04:35 +0000[diff] [blame]239<p>Note, the <tt>-cc1</tt> argument indicates the the compiler front-end, and
240not the driver, should be run. The compiler front-end has several additional
241Clang specific features which are not exposed through the GCC compatible driver
242interface.</p>
243
Eric Christopher7dc0e572008-02-08 06:45:49 +0000[diff] [blame]244<pre class="code">
Daniel Dunbardd63b282009-12-11 23:04:35 +0000[diff] [blame]245$ <b>clang -cc1 ~/t.c -ast-print</b>
Eric Christopher7dc0e572008-02-08 06:45:49 +0000[diff] [blame]246typedef float V __attribute__(( vector_size(16) ));
247V foo(V a, V b) {
248 return a + b * a;
249}
250</pre>
251
252
Ted Kremenek35f29c52008-06-17 13:48:36 +0000[diff] [blame]253<h3>Code generation with LLVM:</h3>
Eric Christopher7dc0e572008-02-08 06:45:49 +0000[diff] [blame]254
255<pre class="code">
Daniel Dunbardd63b282009-12-11 23:04:35 +0000[diff] [blame]256$ <b>clang ~/t.c -S -emit-llvm -o -</b>
Eric Christopher7dc0e572008-02-08 06:45:49 +0000[diff] [blame]257define &lt;4 x float&gt; @foo(&lt;4 x float&gt; %a, &lt;4 x float&gt; %b) {
258entry:
259 %mul = mul &lt;4 x float&gt; %b, %a
260 %add = add &lt;4 x float&gt; %mul, %a
261 ret &lt;4 x float&gt; %add
262}
Daniel Dunbardd63b282009-12-11 23:04:35 +0000[diff] [blame]263$ <b>clang -fomit-frame-pointer -O3 -S -o - t.c</b> <i># On x86_64</i>
264...
Eric Christopher7dc0e572008-02-08 06:45:49 +0000[diff] [blame]265_foo:
Daniel Dunbardd63b282009-12-11 23:04:35 +0000[diff] [blame]266Leh_func_begin1:
267 mulps %xmm0, %xmm1
268 addps %xmm1, %xmm0
269 ret
270Leh_func_end1:
Eric Christopher7dc0e572008-02-08 06:45:49 +0000[diff] [blame]271</pre>
272
Eric Christopher7dc0e572008-02-08 06:45:49 +0000[diff] [blame]273</div>
274</body>
275</html>