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