Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / llvm / 947321d15e8740b933cb891974b1f44c5bbfd61b / . / docs / FAQ.html
blob: b43705a175e1b976b2d8ed869330b9ce8436e8c4 [file] [log] [blame]
Dan Gohmanf17a25c2007-07-18 16:29:46 +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 <title>LLVM: Frequently Asked Questions</title>
6 <style type="text/css">
7 @import url("llvm.css");
8 .question { font-weight: bold }
9 .answer { margin-left: 2em }
10 </style>
11</head>
12<body>
13
14<div class="doc_title">
15 LLVM: Frequently Asked Questions
16</div>
17
18<ol>
19 <li><a href="#license">License</a>
20 <ol>
21 <li>Why are the LLVM source code and the front-end distributed under different
22 licenses?</li>
23 <li>Does the University of Illinois Open Source License really qualify as an
24 "open source" license?</li>
25 <li>Can I modify LLVM source code and redistribute the modified source?</li>
26 <li>Can I modify LLVM source code and redistribute binaries or other tools
27 based on it, without redistributing the source?</li>
28 </ol></li>
29
30 <li><a href="#source">Source code</a>
31 <ol>
32 <li>In what language is LLVM written?</li>
33 <li>How portable is the LLVM source code?</li>
34 </ol></li>
35
36 <li><a href="#build">Build Problems</a>
37 <ol>
38 <li>When I run configure, it finds the wrong C compiler.</li>
39 <li>The <tt>configure</tt> script finds the right C compiler, but it uses the
40 LLVM linker from a previous build. What do I do?</li>
41 <li>When creating a dynamic library, I get a strange GLIBC error.</li>
42 <li>I've updated my source tree from Subversion, and now my build is trying
43 to use a file/directory that doesn't exist.</li>
44 <li>I've modified a Makefile in my source tree, but my build tree keeps using
45 the old version. What do I do?</li>
46 <li>I've upgraded to a new version of LLVM, and I get strange build
47 errors.</li>
48 <li>I've built LLVM and am testing it, but the tests freeze.</li>
49 <li>Why do test results differ when I perform different types of builds?</li>
50 <li>Compiling LLVM with GCC 3.3.2 fails, what should I do?</li>
51 <li>When I use the test suite, all of the C Backend tests fail. What is
52 wrong?</li>
53 <li>After Subversion update, rebuilding gives the error "No rule to make
54 target".</li>
55 <li><a href="#llvmc">The <tt>llvmc</tt> program gives me errors/doesn't
Bill Wendling4e05864c2007-09-22 09:54:47 +0000[diff] [blame]56 work.</a></li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]57 </ol></li>
58
59 <li><a href="#felangs">Source Languages</a>
60 <ol>
61 <li><a href="#langs">What source languages are supported?</a></li>
Gordon Henriksendb0558b2008-02-22 21:55:51 +0000[diff] [blame]62 <li><a href="#langirgen">I'd like to write a self-hosting LLVM compiler. How
63 should I interface with the LLVM middle-end optimizers and back-end code
Dan Gohman4dfac702008-11-24 17:18:39 +0000[diff] [blame]64 generators?</a></li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]65 <li><a href="#langhlsupp">What support is there for higher level source
66 language constructs for building a compiler?</a></li>
67 <li><a href="GetElementPtr.html">I don't understand the GetElementPtr
68 instruction. Help!</a></li>
69 </ol>
70
71 <li><a href="#cfe">Using the GCC Front End</a>
72 <ol>
73 <li>
74 When I compile software that uses a configure script, the configure script
75 thinks my system has all of the header files and libraries it is testing
76 for. How do I get configure to work correctly?
77 </li>
78
79 <li>
80 When I compile code using the LLVM GCC front end, it complains that it
81 cannot find libcrtend.a.
82 </li>
83
84 <li>
85 How can I disable all optimizations when compiling code using the LLVM GCC front end?
86 </li>
87
Dan Gohman4dfac702008-11-24 17:18:39 +0000[diff] [blame]88 <li><a href="#translatecxx">Can I use LLVM to convert C++ code to C code?</a></li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]89
90 </ol>
91 </li>
92
93 <li><a href="#cfe_code">Questions about code generated by the GCC front-end</a>
94 <ol>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]95 <li><a href="#iosinit">What is this <tt>llvm.global_ctors</tt> and
96 <tt>_GLOBAL__I__tmp_webcompile...</tt> stuff that happens when I
97 #include &lt;iostream&gt;?</a></li>
98 <li><a href="#codedce">Where did all of my code go??</a></li>
99 <li><a href="#undef">What is this "<tt>undef</tt>" thing that shows up in my code?</a></li>
100 </ol>
101 </li>
102</ol>
103
104<div class="doc_author">
105 <p>Written by <a href="http://llvm.org">The LLVM Team</a></p>
106</div>
107
108
109<!-- *********************************************************************** -->
110<div class="doc_section">
111 <a name="license">License</a>
112</div>
113<!-- *********************************************************************** -->
114
115<div class="question">
116<p>Why are the LLVM source code and the front-end distributed under different
117licenses?</p>
118</div>
119
120<div class="answer">
121<p>The C/C++ front-ends are based on GCC and must be distributed under the GPL.
122Our aim is to distribute LLVM source code under a <em>much less restrictive</em>
123license, in particular one that does not compel users who distribute tools based
124on modifying the source to redistribute the modified source code as well.</p>
125</div>
126
127<div class="question">
128<p>Does the University of Illinois Open Source License really qualify as an
129"open source" license?</p>
130</div>
131
132<div class="answer">
133<p>Yes, the license is <a
134href="http://www.opensource.org/licenses/UoI-NCSA.php">certified</a> by the Open
135Source Initiative (OSI).</p>
136</div>
137
138<div class="question">
139<p>Can I modify LLVM source code and redistribute the modified source?</p>
140</div>
141
142<div class="answer">
143<p>Yes. The modified source distribution must retain the copyright notice and
144follow the three bulletted conditions listed in the <a
Daniel Dunbar595b8562008-09-26 21:12:29 +0000[diff] [blame]145href="http://llvm.org/releases/2.3/LICENSE.TXT">LLVM license</a>.</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]146</div>
147
148<div class="question">
149<p>Can I modify LLVM source code and redistribute binaries or other tools based
150on it, without redistributing the source?</p>
151</div>
152
153<div class="answer">
154<p>Yes, this is why we distribute LLVM under a less restrictive license than
155GPL, as explained in the first question above.</p>
156</div>
157
158<!-- *********************************************************************** -->
159<div class="doc_section">
160 <a name="source">Source Code</a>
161</div>
162<!-- *********************************************************************** -->
163
164<div class="question">
165<p>In what language is LLVM written?</p>
166</div>
167
168<div class="answer">
169<p>All of the LLVM tools and libraries are written in C++ with extensive use of
170the STL.</p>
171</div>
172
173<div class="question">
174<p>How portable is the LLVM source code?</p>
175</div>
176
177<div class="answer">
178<p>The LLVM source code should be portable to most modern UNIX-like operating
179systems. Most of the code is written in standard C++ with operating system
180services abstracted to a support library. The tools required to build and test
181LLVM have been ported to a plethora of platforms.</p>
182
183<p>Some porting problems may exist in the following areas:</p>
184
185<ul>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]186 <li>The GCC front end code is not as portable as the LLVM suite, so it may not
Bill Wendling4e05864c2007-09-22 09:54:47 +0000[diff] [blame]187 compile as well on unsupported platforms.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]188
189 <li>The LLVM build system relies heavily on UNIX shell tools, like the Bourne
Bill Wendling4e05864c2007-09-22 09:54:47 +0000[diff] [blame]190 Shell and sed. Porting to systems without these tools (MacOS 9, Plan 9)
191 will require more effort.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]192</ul>
193
194</div>
195
196<!-- *********************************************************************** -->
197<div class="doc_section">
198 <a name="build">Build Problems</a>
199</div>
200<!-- *********************************************************************** -->
201
202<div class="question">
203<p>When I run configure, it finds the wrong C compiler.</p>
204</div>
205
206<div class="answer">
207
208<p>The <tt>configure</tt> script attempts to locate first <tt>gcc</tt> and then
209<tt>cc</tt>, unless it finds compiler paths set in <tt>CC</tt> and <tt>CXX</tt>
210for the C and C++ compiler, respectively.</p>
211
212<p>If <tt>configure</tt> finds the wrong compiler, either adjust your
213<tt>PATH</tt> environment variable or set <tt>CC</tt> and <tt>CXX</tt>
214explicitly.</p>
215
216</div>
217
218<div class="question">
219<p>The <tt>configure</tt> script finds the right C compiler, but it uses the
220LLVM linker from a previous build. What do I do?</p>
221</div>
222
223<div class="answer">
224<p>The <tt>configure</tt> script uses the <tt>PATH</tt> to find executables, so
225if it's grabbing the wrong linker/assembler/etc, there are two ways to fix
226it:</p>
227
228<ol>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]229 <li><p>Adjust your <tt>PATH</tt> environment variable so that the correct
Bill Wendling4e05864c2007-09-22 09:54:47 +0000[diff] [blame]230 program appears first in the <tt>PATH</tt>. This may work, but may not be
231 convenient when you want them <i>first</i> in your path for other
232 work.</p></li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]233
234 <li><p>Run <tt>configure</tt> with an alternative <tt>PATH</tt> that is
Bill Wendling4e05864c2007-09-22 09:54:47 +0000[diff] [blame]235 correct. In a Borne compatible shell, the syntax would be:</p>
236
237<div class="doc_code">
238<pre>
239% PATH=[the path without the bad program] ./configure ...
240</pre>
241</div>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]242
243 <p>This is still somewhat inconvenient, but it allows <tt>configure</tt>
Bill Wendling4e05864c2007-09-22 09:54:47 +0000[diff] [blame]244 to do its work without having to adjust your <tt>PATH</tt>
245 permanently.</p></li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]246</ol>
247
248</div>
249
250<div class="question">
251<p>When creating a dynamic library, I get a strange GLIBC error.</p>
252</div>
253
254<div class="answer">
255<p>Under some operating systems (i.e. Linux), libtool does not work correctly if
256GCC was compiled with the --disable-shared option. To work around this, install
257your own version of GCC that has shared libraries enabled by default.</p>
258</div>
259
260<div class="question">
Bill Wendling4e05864c2007-09-22 09:54:47 +0000[diff] [blame]261<p>I've updated my source tree from Subversion, and now my build is trying to
262use a file/directory that doesn't exist.</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]263</div>
264
265<div class="answer">
266<p>You need to re-run configure in your object directory. When new Makefiles
267are added to the source tree, they have to be copied over to the object tree in
268order to be used by the build.</p>
269</div>
270
271<div class="question">
272<p>I've modified a Makefile in my source tree, but my build tree keeps using the
273old version. What do I do?</p>
274</div>
275
276<div class="answer">
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]277<p>If the Makefile already exists in your object tree, you
278can just run the following command in the top level directory of your object
279tree:</p>
280
Bill Wendling4e05864c2007-09-22 09:54:47 +0000[diff] [blame]281<div class="doc_code">
282<pre>% ./config.status &lt;relative path to Makefile&gt;</pre>
283</div>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]284
285<p>If the Makefile is new, you will have to modify the configure script to copy
286it over.</p>
287
288</div>
289
290<div class="question">
291<p>I've upgraded to a new version of LLVM, and I get strange build errors.</p>
292</div>
293
294<div class="answer">
295
296<p>Sometimes, changes to the LLVM source code alters how the build system works.
297Changes in libtool, autoconf, or header file dependencies are especially prone
298to this sort of problem.</p>
299
300<p>The best thing to try is to remove the old files and re-build. In most
301cases, this takes care of the problem. To do this, just type <tt>make
302clean</tt> and then <tt>make</tt> in the directory that fails to build.</p>
303
304</div>
305
306<div class="question">
307<p>I've built LLVM and am testing it, but the tests freeze.</p>
308</div>
309
310<div class="answer">
311
312<p>This is most likely occurring because you built a profile or release
313(optimized) build of LLVM and have not specified the same information on the
314<tt>gmake</tt> command line.</p>
315
316<p>For example, if you built LLVM with the command:</p>
317
318<div class="doc_code">
Bill Wendling4e05864c2007-09-22 09:54:47 +0000[diff] [blame]319<pre>% gmake ENABLE_PROFILING=1</pre>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]320</div>
321
322<p>...then you must run the tests with the following commands:</p>
323
324<div class="doc_code">
325<pre>
326% cd llvm/test
327% gmake ENABLE_PROFILING=1
328</pre>
329</div>
330
331</div>
332
333<div class="question">
334<p>Why do test results differ when I perform different types of builds?</p>
335</div>
336
337<div class="answer">
338
339<p>The LLVM test suite is dependent upon several features of the LLVM tools and
340libraries.</p>
341
342<p>First, the debugging assertions in code are not enabled in optimized or
343profiling builds. Hence, tests that used to fail may pass.</p>
344
345<p>Second, some tests may rely upon debugging options or behavior that is only
346available in the debug build. These tests will fail in an optimized or profile
347build.</p>
348
349</div>
350
351<div class="question">
352<p>Compiling LLVM with GCC 3.3.2 fails, what should I do?</p>
353</div>
354
355<div class="answer">
356<p>This is <a href="http://gcc.gnu.org/PR?13392">a bug in GCC</a>, and
Bill Wendling4e05864c2007-09-22 09:54:47 +0000[diff] [blame]357affects projects other than LLVM. Try upgrading or downgrading your GCC.</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]358</div>
359
360<div class="question">
Bill Wendling4e05864c2007-09-22 09:54:47 +0000[diff] [blame]361<p>After Subversion update, rebuilding gives the error "No rule to make
362target".</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]363</div>
364
365<div class="answer">
366<p>If the error is of the form:</p>
367
368<div class="doc_code">
369<pre>
370gmake[2]: *** No rule to make target `/path/to/somefile', needed by
371`/path/to/another/file.d'.<br>
372Stop.
373</pre>
374</div>
375
376<p>This may occur anytime files are moved within the Subversion repository or
377removed entirely. In this case, the best solution is to erase all
378<tt>.d</tt> files, which list dependencies for source files, and rebuild:</p>
379
380<div class="doc_code">
381<pre>
382% cd $LLVM_OBJ_DIR
383% rm -f `find . -name \*\.d`
384% gmake
385</pre>
386</div>
387
388<p>In other cases, it may be necessary to run <tt>make clean</tt> before
389rebuilding.</p>
390</div>
391
Bill Wendling4e05864c2007-09-22 09:54:47 +0000[diff] [blame]392<div class="question"><p><a name="llvmc">
393The <tt>llvmc</tt> program gives me errors/doesn't work.</a></p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]394</div>
395
396<div class="answer">
Bill Wendling4e05864c2007-09-22 09:54:47 +0000[diff] [blame]397<p><tt>llvmc</tt> is experimental and isn't really supported. We suggest
398using <tt>llvm-gcc</tt> instead.</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]399</div>
400
401<!-- *********************************************************************** -->
402<div class="doc_section"><a name="felangs">Source Languages</a></div>
403
404<div class="question"><p>
405 <a name="langs">What source languages are supported?</a></p>
406</div>
407<div class="answer">
408 <p>LLVM currently has full support for C and C++ source languages. These are
409 available through a special version of GCC that LLVM calls the
410 <a href="#cfe">C Front End</a></p>
411 <p>There is an incomplete version of a Java front end available in the
412 <tt>java</tt> module. There is no documentation on this yet so
413 you'll need to download the code, compile it, and try it.</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]414 <p>The PyPy developers are working on integrating LLVM into the PyPy backend
415 so that PyPy language can translate to LLVM.</p>
416</div>
Gordon Henriksen2c2e1482008-02-22 20:58:29 +0000[diff] [blame]417
418<div class="question"><p><a name="langirgen">
Gordon Henriksendb0558b2008-02-22 21:55:51 +0000[diff] [blame]419 I'd like to write a self-hosting LLVM compiler. How should I interface with
420 the LLVM middle-end optimizers and back-end code generators?
Gordon Henriksen2c2e1482008-02-22 20:58:29 +0000[diff] [blame]421</a></p></div>
422<div class="answer">
423 <p>Your compiler front-end will communicate with LLVM by creating a module in
Gordon Henriksendb0558b2008-02-22 21:55:51 +0000[diff] [blame]424 the LLVM intermediate representation (IR) format. Assuming you want to
425 write your language's compiler in the language itself (rather than C++),
426 there are 3 major ways to tackle generating LLVM IR from a front-end:</p>
Gordon Henriksen2c2e1482008-02-22 20:58:29 +0000[diff] [blame]427 <ul>
428 <li>
429 <strong>Call into the LLVM libraries code using your language's FFI
430 (foreign function interface).</strong>
431 <ul>
432 <li><em>for:</em> best tracks changes to the LLVM IR, .ll syntax,
433 and .bc format</li>
434 <li><em>for:</em> enables running LLVM optimization passes without a
435 emit/parse overhead</li>
436 <li><em>for:</em> adapts well to a JIT context</li>
437 <li><em>against:</em> lots of ugly glue code to write</li>
438 </ul>
439 </li>
440 <li>
441 <strong>Emit LLVM assembly from your compiler's native language.</strong>
442 <ul>
443 <li><em>for:</em> very straightforward to get started</li>
444 <li><em>against:</em> the .ll parser is slower than the bitcode reader
445 when interfacing to the middle end</li>
446 <li><em>against:</em> you'll have to re-engineer the LLVM IR object
447 model and asm writer in your language</li>
448 <li><em>against:</em> it may be harder to track changes to the IR</li>
449 </ul>
450 </li>
451 <li>
452 <strong>Emit LLVM bitcode from your compiler's native language.</strong>
453 <ul>
454 <li><em>for:</em> can use the more-efficient bitcode reader when
455 interfacing to the middle end</li>
456 <li><em>against:</em> you'll have to re-engineer the LLVM IR object
457 model and bitcode writer in your language</li>
458 <li><em>against:</em> it may be harder to track changes to the IR</li>
459 </ul>
460 </li>
461 </ul>
462 <p>If you go with the first option, the C bindings in include/llvm-c should
463 help a lot, since most languages have strong support for interfacing with
464 C. The most common hurdle with calling C from managed code is interfacing
465 with the garbage collector. The C interface was designed to require very
466 little memory management, and so is straightforward in this regard.</p>
467</div>
468
Bill Wendling4e05864c2007-09-22 09:54:47 +0000[diff] [blame]469<div class="question"><p><a name="langhlsupp">
470 What support is there for a higher level source language constructs for
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]471 building a compiler?</a></p>
472</div>
473<div class="answer">
474 <p>Currently, there isn't much. LLVM supports an intermediate representation
475 which is useful for code representation but will not support the high level
476 (abstract syntax tree) representation needed by most compilers. There are no
477 facilities for lexical nor semantic analysis. There is, however, a <i>mostly
478 implemented</i> configuration-driven
479 <a href="CompilerDriver.html">compiler driver</a> which simplifies the task
480 of running optimizations, linking, and executable generation.</p>
481</div>
482
Dan Gohman4dfac702008-11-24 17:18:39 +0000[diff] [blame]483<div class="question"><p><a name="getelementptr">
Bill Wendling4e05864c2007-09-22 09:54:47 +0000[diff] [blame]484 I don't understand the GetElementPtr instruction. Help!</a></p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]485</div>
486<div class="answer">
487 <p>See <a href="GetElementPtr.html">The Often Misunderstood GEP
Bill Wendling4e05864c2007-09-22 09:54:47 +0000[diff] [blame]488 Instruction</a>.</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]489</div>
490
491<!-- *********************************************************************** -->
492<div class="doc_section">
493 <a name="cfe">Using the GCC Front End</a>
494</div>
495
496<div class="question">
497<p>
498When I compile software that uses a configure script, the configure script
499thinks my system has all of the header files and libraries it is testing for.
500How do I get configure to work correctly?
501</p>
502</div>
503
504<div class="answer">
505<p>
506The configure script is getting things wrong because the LLVM linker allows
507symbols to be undefined at link time (so that they can be resolved during JIT
508or translation to the C back end). That is why configure thinks your system
509"has everything."
510</p>
511<p>
512To work around this, perform the following steps:
513</p>
514<ol>
515 <li>Make sure the CC and CXX environment variables contains the full path to
516 the LLVM GCC front end.</li>
517
518 <li>Make sure that the regular C compiler is first in your PATH. </li>
519
520 <li>Add the string "-Wl,-native" to your CFLAGS environment variable.</li>
521</ol>
522
523<p>
524This will allow the <tt>llvm-ld</tt> linker to create a native code executable
525instead of shell script that runs the JIT. Creating native code requires
526standard linkage, which in turn will allow the configure script to find out if
527code is not linking on your system because the feature isn't available on your
528system.</p>
529</div>
530
531<div class="question">
532<p>
533When I compile code using the LLVM GCC front end, it complains that it cannot
534find libcrtend.a.
535</p>
536</div>
537
538<div class="answer">
539<p>
540The only way this can happen is if you haven't installed the runtime library. To
541correct this, do:</p>
542
543<div class="doc_code">
544<pre>
545% cd llvm/runtime
546% make clean ; make install-bytecode
547</pre>
548</div>
549</div>
550
551<div class="question">
552<p>
553How can I disable all optimizations when compiling code using the LLVM GCC front end?
554</p>
555</div>
556
557<div class="answer">
558<p>
559Passing "-Wa,-disable-opt -Wl,-disable-opt" will disable *all* cleanup and
560optimizations done at the llvm level, leaving you with the truly horrible
561code that you desire.
562</p>
563</div>
564
565
566<div class="question">
567<p>
Dan Gohman4dfac702008-11-24 17:18:39 +0000[diff] [blame]568<a name="translatecxx">Can I use LLVM to convert C++ code to C code?</a>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]569</p>
570</div>
571
572<div class="answer">
573<p>Yes, you can use LLVM to convert code from any language LLVM supports to C.
574Note that the generated C code will be very low level (all loops are lowered
575to gotos, etc) and not very pretty (comments are stripped, original source
576formatting is totally lost, variables are renamed, expressions are regrouped),
577so this may not be what you're looking for. However, this is a good way to add
578C++ support for a processor that does not otherwise have a C++ compiler.
579</p>
580
581<p>Use commands like this:</p>
582
583<ol>
Bill Wendling4e05864c2007-09-22 09:54:47 +0000[diff] [blame]584 <li><p>Compile your program as normal with llvm-g++:</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]585
586<div class="doc_code">
587<pre>
588% llvm-g++ x.cpp -o program
589</pre>
590</div>
591
Bill Wendling4e05864c2007-09-22 09:54:47 +0000[diff] [blame]592 <p>or:</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]593
594<div class="doc_code">
595<pre>
596% llvm-g++ a.cpp -c
597% llvm-g++ b.cpp -c
598% llvm-g++ a.o b.o -o program
599</pre>
600</div>
601
Bill Wendling4e05864c2007-09-22 09:54:47 +0000[diff] [blame]602 <p>With llvm-gcc3, this will generate program and program.bc. The .bc
603 file is the LLVM version of the program all linked together.</p></li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]604
Bill Wendling4e05864c2007-09-22 09:54:47 +0000[diff] [blame]605 <li><p>Convert the LLVM code to C code, using the LLC tool with the C
606 backend:</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]607
608<div class="doc_code">
609<pre>
610% llc -march=c program.bc -o program.c
611</pre>
Bill Wendling4e05864c2007-09-22 09:54:47 +0000[diff] [blame]612</div></li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]613
Bill Wendling4e05864c2007-09-22 09:54:47 +0000[diff] [blame]614<li><p>Finally, compile the C file:</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]615
616<div class="doc_code">
617<pre>
618% cc x.c
619</pre>
Bill Wendling4e05864c2007-09-22 09:54:47 +0000[diff] [blame]620</div></li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]621
622</ol>
623
Bill Wendling4e05864c2007-09-22 09:54:47 +0000[diff] [blame]624<p>Note that, by default, the C backend does not support exception handling. If
625you want/need it for a certain program, you can enable it by passing
626"-enable-correct-eh-support" to the llc program. The resultant code will use
627setjmp/longjmp to implement exception support that is correct but relatively
628slow.</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]629
Bill Wendling4e05864c2007-09-22 09:54:47 +0000[diff] [blame]630<p>Also note: this specific sequence of commands won't work if you use a
631function defined in the C++ runtime library (or any other C++ library). To
632access an external C++ library, you must manually compile libstdc++ to LLVM
633bitcode, statically link it into your program, then use the commands above to
634convert the whole result into C code. Alternatively, you can compile the
635libraries and your application into two different chunks of C code and link
636them.</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]637
638</div>
639
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]640<!-- *********************************************************************** -->
641<div class="doc_section">
642 <a name="cfe_code">Questions about code generated by the GCC front-end</a>
643</div>
644
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]645<div class="question">
646<a name="iosinit"></a>
647<p> What is this <tt>llvm.global_ctors</tt> and
648<tt>_GLOBAL__I__tmp_webcompile...</tt> stuff that happens when I #include
649&lt;iostream&gt;?</p>
650</div>
651
652<div class="answer">
653
654<p>If you #include the &lt;iostream&gt; header into a C++ translation unit, the
655file will probably use the <tt>std::cin</tt>/<tt>std::cout</tt>/... global
656objects. However, C++ does not guarantee an order of initialization between
657static objects in different translation units, so if a static ctor/dtor in your
658.cpp file used <tt>std::cout</tt>, for example, the object would not necessarily
659be automatically initialized before your use.</p>
660
661<p>To make <tt>std::cout</tt> and friends work correctly in these scenarios, the
662STL that we use declares a static object that gets created in every translation
663unit that includes <tt>&lt;iostream&gt;</tt>. This object has a static
664constructor and destructor that initializes and destroys the global iostream
665objects before they could possibly be used in the file. The code that you see
666in the .ll file corresponds to the constructor and destructor registration code.
667</p>
668
669<p>If you would like to make it easier to <b>understand</b> the LLVM code
670generated by the compiler in the demo page, consider using <tt>printf()</tt>
671instead of <tt>iostream</tt>s to print values.</p>
672
673</div>
674
675<!--=========================================================================-->
676
677<div class="question"><p>
678<a name="codedce"></a>
679Where did all of my code go??
680</p></div>
681
682<div class="answer">
683<p>
684If you are using the LLVM demo page, you may often wonder what happened to all
685of the code that you typed in. Remember that the demo script is running the
686code through the LLVM optimizers, so if your code doesn't actually do anything
687useful, it might all be deleted.
688</p>
689
690<p>
691To prevent this, make sure that the code is actually needed. For example, if
692you are computing some expression, return the value from the function instead of
693leaving it in a local variable. If you really want to constrain the optimizer,
694you can read from and assign to <tt>volatile</tt> global variables.
695</p>
696</div>
697
698<!--=========================================================================-->
699
700<div class="question"><p>
701<a name="undef"></a>
702<p>What is this "<tt>undef</tt>" thing that shows up in my code?
703</p></div>
704
705<div class="answer">
706<p>
707<a href="LangRef.html#undef"><tt>undef</tt></a> is the LLVM way of representing
708a value that is not defined. You can get these if you do not initialize a
709variable before you use it. For example, the C function:</p>
710
711<div class="doc_code">
712<pre>
713int X() { int i; return i; }
714</pre>
715</div>
716
717<p>Is compiled to "<tt>ret i32 undef</tt>" because "<tt>i</tt>" never has
718a value specified for it.</p>
719</div>
720
721<!-- *********************************************************************** -->
722
723<hr>
724<address>
725 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman947321d2008-12-11 17:34:48 +0000[diff] [blame^]726 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]727 <a href="http://validator.w3.org/check/referer"><img
Misha Brukman947321d2008-12-11 17:34:48 +0000[diff] [blame^]728 src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]729
730 <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br>
731 Last modified: $Date$
732</address>
733
734</body>
735</html>