3199c2b7c0f24e8af06c651dd9c583f9971ae8f7
[oota-llvm.git] / docs / ReleaseNotes.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   <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
6   <link rel="stylesheet" href="llvm.css" type="text/css">
7   <title>LLVM 2.5 Release Notes</title>
8 </head>
9 <body>
10
11 <div class="doc_title">LLVM 2.5 Release Notes</div>
12
13 <ol>
14   <li><a href="#intro">Introduction</a></li>
15   <li><a href="#subproj">Sub-project Status Update</a></li>
16   <li><a href="#externalproj">External Projects Using LLVM 2.5</a></li>
17   <li><a href="#whatsnew">What's New in LLVM?</a></li>
18   <li><a href="GettingStarted.html">Installation Instructions</a></li>
19   <li><a href="#portability">Portability and Supported Platforms</a></li>
20   <li><a href="#knownproblems">Known Problems</a></li>
21   <li><a href="#additionalinfo">Additional Information</a></li>
22 </ol>
23
24 <div class="doc_author">
25   <p>Written by the <a href="http://llvm.org">LLVM Team</a></p>
26 </div>
27
28 <!-- *********************************************************************** -->
29 <div class="doc_section">
30   <a name="intro">Introduction</a>
31 </div>
32 <!-- *********************************************************************** -->
33
34 <div class="doc_text">
35
36 <p>This document contains the release notes for the LLVM Compiler
37 Infrastructure, release 2.5.  Here we describe the status of LLVM, including
38 major improvements from the previous release and significant known problems.
39 All LLVM releases may be downloaded from the <a 
40 href="http://llvm.org/releases/">LLVM releases web site</a>.</p>
41
42 <p>For more information about LLVM, including information about the latest
43 release, please check out the <a href="http://llvm.org/">main LLVM
44 web site</a>.  If you have questions or comments, the <a
45 href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM Developer's Mailing
46 List</a> is a good place to send them.</p>
47
48 <p>Note that if you are reading this file from a Subversion checkout or the
49 main LLVM web page, this document applies to the <i>next</i> release, not the
50 current one.  To see the release notes for a specific release, please see the
51 <a href="http://llvm.org/releases/">releases page</a>.</p>
52
53 </div>
54
55 <!-- Unfinished features in 2.5:
56   Machine LICM
57   Machine Sinking
58   target-specific intrinsics
59   gold lto plugin
60   pre-alloc splitter, strong phi elim
61   llc -enable-value-prop, propagation of value info (sign/zero ext info) from
62        one MBB to another
63   debug info for optimized code
64   interpreter + libffi
65   postalloc scheduler: anti dependence breaking, hazard recognizer?
66
67  -->
68
69  <!-- for announcement email:
70    -->
71
72 <!-- *********************************************************************** -->
73 <div class="doc_section">
74   <a name="subproj">Sub-project Status Update</a>
75 </div>
76 <!-- *********************************************************************** -->
77
78 <div class="doc_text">
79 <p>
80 The LLVM 2.5 distribution currently consists of code from the core LLVM
81 repository (which roughly includes the LLVM optimizers, code generators and
82 supporting tools) and the llvm-gcc repository.  In addition to this code, the
83 LLVM Project includes other sub-projects that are in development.  The two which
84 are the most actively developed are the <a href="#clang">Clang Project</a> and
85 the <a href="#vmkit">VMKit Project</a>.
86 </p>
87
88 </div>
89
90
91 <!--=========================================================================-->
92 <div class="doc_subsection">
93 <a name="clang">Clang: C/C++/Objective-C Frontend Toolkit</a>
94 </div>
95
96 <div class="doc_text">
97
98 <p>The <a href="http://clang.llvm.org/">Clang project</a> is an effort to build
99 a set of new 'LLVM native' front-end technologies for the LLVM optimizer
100 and code generator.  While Clang is not included in the LLVM 2.5 release, it 
101 is continuing to make major strides forward in all areas.  Its C and Objective-C
102 parsing and code generation support is now very solid.  For example, it is
103 capable of successfully building many real applications for X86-32 and X86-64,
104 including <a href="http://wiki.freebsd.org/BuildingFreeBSDWithClang">the FreeBSD
105 kernel</a>.  C++ is also making <a
106 href="http://clang.llvm.org/cxx_status.html">incredible progress</a>, and work
107 on templates has recently started.</p>
108
109 <p>While Clang is not yet production quality, it is progressing very nicely and
110 is quite usable for building many C and Objective-C applications.  If you are
111 interested in fast compiles and good diagnostics, we encourage you to try it out
112 by <a href="http://clang.llvm.org/get_started.html">building from mainline</a>
113 and reporting any issues you hit to the <a 
114 href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-dev">Clang front-end mailing
115 list</a>.</p>
116
117 <p>In the LLVM 2.5 time-frame, the Clang team has made many improvements:</p>
118
119 <ul>
120 <li>Clang now has a new driver, which is focused on providing a GCC-compatible
121     interface.</li> 
122 <li>The X86-64 ABI is now supported.</li> 
123 <li>Precompiled header support is now implemented.</li> 
124 <li>Objective-C support is significantly improved beyond LLVM 2.4, supporting
125     many features, such as Objective-C Garbage Collection.</li>
126 <li>Many many bugs are fixed.</li>
127 </div>
128
129 <!--=========================================================================-->
130 <div class="doc_subsection">
131 <a name="clangsa">Clang Static Analyzer</a>
132 </div>
133
134 <div class="doc_text">
135
136 <p>The Clang project also includes an early stage static source code analysis
137 tool for <a href="http://clang.llvm.org/StaticAnalysis.html">automatically
138 finding bugs</a> in C and Objective-C programs. The tool performs a growing set
139 of checks to find bugs that occur on a specific path within a program.  Examples
140 of bugs the tool finds include logic errors such as null dereferences,
141 violations of various API rules, dead code, and potential memory leaks in
142 Objective-C programs. Since its inception, public feedback on the tool has been
143 extremely positive, and conservative estimates put the number of real bugs it
144 has found in industrial-quality software on the order of thousands.</p>
145
146 <p>The tool also provides a simple web GUI to inspect potential bugs found by
147 the tool.  While still early in development, the GUI illustrates some of the key
148 features of Clang: accurate source location information, which is used by the
149 GUI to highlight specific code expressions that relate to a bug (including those
150 that span multiple lines); and built-in knowledge of macros, which is used to
151 perform inline expansion of macros within the GUI itself.</p>
152
153 <p>The set of checks performed by the static analyzer is gradually expanding,
154 and future plans for the tool include full source-level inter-procedural
155 analysis and deeper checks such as buffer overrun detection. There are many
156 opportunities to extend and enhance the static analyzer, and anyone interested
157 in working on this project is encouraged to get involved!</p>
158
159 </div>
160
161 <!--=========================================================================-->
162 <div class="doc_subsection">
163 <a name="vmkit">VMKit: JVM/CLI Virtual Machine Implementation</a>
164 </div>
165
166 <div class="doc_text">
167 <p>
168 The <a href="http://vmkit.llvm.org/">VMKit project</a> is an implementation of
169 a JVM and a CLI Virtual Machines (Microsoft .NET is an
170 implementation of the CLI) using the Just-In-Time compiler of LLVM.</p>
171
172 <p>Following LLVM 2.5, VMKit has its first release ? that you can find on its
173 <a href="http://vmkit.llvm.org/releases/">webpage</a>. The release includes
174 bug fixes, cleanup and new features. The major changes are:</p>
175
176 <ul>
177
178 <li>Ahead of Time compiler: compiles .class files to llvm .bc. VMKit uses this
179 functionality to native compile the standard classes (eg java.lang.String).
180 Users can compile AOT .class files into dynamic libraries and run them with the
181 help of VMKit.</li>
182
183 <li>New exception model: the dwarf exception model is very slow for
184 exception-intensive applications, so the JVM has had a new implementation of
185 exceptions which check at each function call if an exception happened. There is
186 a low performance penalty on applications without exceptions, but it is a big
187 gain for exception-intensive applications. For example the jack benchmark in
188 Spec JVM98 is 6x faster (performance gain of 83%).</li>
189
190 <li>New support for OSX/X64, Linux/X64 (with the Boehm GC), Linux/ppc32.</li>
191
192 </ul>
193 </div>
194
195 <!-- *********************************************************************** -->
196 <div class="doc_section">
197   <a name="externalproj">External Projects Using LLVM 2.5</a>
198 </div>
199 <!-- *********************************************************************** -->
200
201 <!--=========================================================================-->
202 <div class="doc_subsection">
203 <a name="pure">Pure</a>
204 </div>
205
206 <div class="doc_text">
207 <p>
208 http://pure-lang.googlecode.com/
209 </p>
210
211 <p>
212 Pure is an algebraic/functional programming language based on term rewriting.
213 Programs are collections of equations which are used to evaluate expressions in
214 a symbolic fashion. Pure offers dynamic typing, eager and lazy evaluation,
215 lexical closures, a hygienic macro system (also based on term rewriting), 
216 built-in list and matrix support (including list and matrix comprehensions) and
217 an easy-to-use C interface. The interpreter uses LLVM as a backend to
218  JIT-compile Pure programs to fast native code.</p>
219
220 <p>In addition to the usual algebraic data structures, Pure also has
221 MATLAB-style matrices in order to support numeric computations and signal
222 processing in an efficient way. Pure is mainly aimed at mathematical
223 applications right now, but it has been designed as a general purpose language.
224 The dynamic interpreter environment and the C interface make it possible to use
225 it as a kind of functional scripting language for many application areas.
226 </p>
227 </div>
228
229
230 <!--=========================================================================-->
231 <div class="doc_subsection">
232 <a name="ldc">LLVM D Compiler</a>
233 </div>
234
235 <div class="doc_text">
236 <p>
237 http://www.dsource.org/projects/ldc
238 </p>
239
240 <p>
241 I'd like to inform that the LDC project (LLVM D
242 Compiler) is working with release 2.5 of LLVM. In fact we've required
243 2.5 in our trunk since the release was branched.
244 The improvements in 2.5 have fixed a lot of problems with LDC, more
245 specifically the new inline asm constraints, better debug info
246 support, general bugfixes :) and better x86-64 support have allowed
247 some major improvements in LDC, getting us much closer to being as
248 fully featured as the original DMD compiler from DigitalMars.
249 </p>
250 </div>
251
252
253
254 <!-- *********************************************************************** -->
255 <div class="doc_section">
256   <a name="whatsnew">What's New in LLVM?</a>
257 </div>
258 <!-- *********************************************************************** -->
259
260 <div class="doc_text">
261
262 <p>This release includes a huge number of bug fixes, performance tweaks, and
263 minor improvements.  Some of the major improvements and new features are listed
264 in this section.
265 </p>
266 </div>
267
268 <!--=========================================================================-->
269 <div class="doc_subsection">
270 <a name="majorfeatures">Major New Features</a>
271 </div>
272
273 <div class="doc_text">
274
275 <p>LLVM 2.5 includes several major new capabilities:</p>
276
277 <ul>
278 <li><p>The code generator now supports arbitrary precision integers.
279 Types like <tt>i33</tt> have long been valid in the LLVM IR, but previously
280 could only be used with the interpreter.
281 Now IR using such types can be compiled to native code on all targets.
282 All operations are supported if the integer is not bigger than twice the
283 target machine word size.
284 Simple operations like loads, stores and shifts by a constant amount are
285 supported for integers of any size.
286 </p></li>
287
288 <!--
289 Random stuff:
290
291 Pure project: http://code.google.com/p/pure-lang/
292
293
294 xcore backend!
295 fortran on darwin!
296
297 .ll parser rewrite, caret diags, better errors, less fragile (less likely to
298    crash on strange things).  No longer depends on flex/bison.
299 GCC inliner off, llvm handles always-inline.
300 cmake mature?
301 x86 backend GS segment -> addr space 256 (r62980)
302 nocapture
303 memdep (used by GVN and memcpyopt) is faster / more aggressive.
304 how to write a backend doc docs/WritingAnLLVMBackend.html
305 fastisel + exception handling
306 vector widening <3 x float> -> <4 x float>
307 arm port improvements? arm jit encoding stuff, constant island support?
308 JIT TLS support on x86-32 but not x86-64.
309 mem2reg now faster on code with huge basic blocks
310 stack protectors/stack canaries, -fstack-protector, controllable on a 
311   per-function basis with attributes.
312 shufflevector is generalized to allow different shuffle mask width than its
313   input vectors.
314 loop optimizer improves floating point induction variables
315 llvm/Analysis/DebugInfo.h classes, llvm-gcc and clang and codegen use them.
316     DebugInfoBuilder gone.
317 asmprinters seperate from targets for jits
318 PBQP register allocator now supports register coalescing.
319 JIT supports exceptions on linux/x86-64 and linux/x86-64.
320 integer overflow intrinsics for [us](add/sub/mul).  Supported on all targets,
321   but only generates efficient code on x86.
322 X86 backend now supports -disable-mmx.
323 noalias attribute on return value indicates that function returns new memory
324   (e.g. malloc).
325 llvmc2 renamed to llvmc
326 Jump threading more powerful: it is iterative, handles threading based on values
327   with fully redundant and partially redundant loads.
328 LSR improvements?
329 ARM debug info support?
330 unit test framework based on Google Test.
331
332 vector shift support + X86 backend.
333 x86 JIT now detects core i7 and atom, autoconfiguring itself appropriately.
334 SROA is more aggressive about promoting unions.
335 non-zero __builtin_return_address values on X86.
336 x86-64 now uses red zone (unless -mno-red-zone option is specified).
337 private linkage.
338
339 llvm-gcc defaults to -fno-math-errno on all x86 targets.
340
341 initial support for debug line numbers when optimization enabled, not useful in
342   2.5 but will be for 2.6.
343 -->
344
345 </ul>
346
347 </div>
348
349
350 <!--=========================================================================-->
351 <div class="doc_subsection">
352 <a name="llvm-gcc">llvm-gcc 4.2 Improvements</a>
353 </div>
354
355 <div class="doc_text">
356
357 <p>LLVM fully supports the llvm-gcc 4.2 front-end, which marries the GCC
358 front-ends and driver with the LLVM optimizer and code generator.  It currently
359 includes support for the C, C++, Objective-C, Ada, and Fortran front-ends.</p>
360
361 <ul>
362 <li>?</li>
363 </ul>
364
365 </div>
366
367
368 <!--=========================================================================-->
369 <div class="doc_subsection">
370 <a name="coreimprovements">LLVM Core Improvements</a>
371 </div>
372
373 <div class="doc_text">
374 <p>New features include:</p>
375
376 <ul>
377 <li>?</li>
378     
379 </ul>
380
381 </div>
382
383 <!--=========================================================================-->
384 <div class="doc_subsection">
385 <a name="optimizer">Optimizer Improvements</a>
386 </div>
387
388 <div class="doc_text">
389
390 <p>In addition to a huge array of bug fixes and minor performance tweaks, this
391 release includes a few major enhancements and additions to the optimizers:</p>
392
393 <ul>
394
395 <li>?</li>
396
397 </ul>
398
399 </div>
400
401 <!--=========================================================================-->
402 <div class="doc_subsection">
403 <a name="codegen">Code Generator Improvements</a>
404 </div>
405
406 <div class="doc_text">
407
408 <p>We have put a significant amount of work into the code generator infrastructure,
409 which allows us to implement more aggressive algorithms and make it run
410 faster:</p>
411
412 <ul>
413 <li>The type legalization logic has been completely rewritten, and is now
414 more powerful (it supports arbitrary precision integer types for example)
415 and hopefully more correct.
416 The type legalizer converts operations on types that are not natively
417 supported by the target machine into equivalent code sequences that only use
418 natively supported types.
419 The old type legalizer is still available and will be used if
420 <tt>-disable-legalize-types</tt> is passed to <tt>llc</tt>.
421 </li>
422 <li>?</li>
423
424 </ul>
425
426 </div>
427
428
429 <!--=========================================================================-->
430 <div class="doc_subsection">
431 <a name="pic16">PIC16 Target Improvements</a>
432 </div>
433
434 <div class="doc_text">
435 <p>New features of the PIC16 target include:
436 </p>
437
438 <ul>
439 <li>Both direct and indirect load/stores work now.</li>
440 <li>Logical, bitwise and conditional operations now work for integer data
441 types.</li>
442 <li>Function calls involving basic types work now.</li>
443 <li>Support for integer arrays.</li>
444 <li>Compiler can now emit libcalls for operations not support by m/c insns.</li>
445 <li>Support for both data and rom address spaces.</li>
446 </li>
447 </ul>
448
449 <p>Things not yet supported:</p>
450
451 <ul>
452 <li>Floating point.</li>
453 <li>Passing/returning aggregate types to/from functions.</li>
454 <li>Variable arguments.</li>
455 <li>Indirect function calls.</li>
456 <li>Interrupts/prgrams.</li>
457 <li>Debug info.</li>
458 </li>
459 </ul>
460
461 </div>
462
463
464 <!--=========================================================================-->
465 <div class="doc_subsection">
466 <a name="othertargetspecific">Other Target Specific Improvements</a>
467 </div>
468
469 <div class="doc_text">
470 <p>New target-specific features include:
471 </p>
472
473 <ul>
474 <li>?</li>
475 </ul>
476
477 </div>
478
479
480 <!--=========================================================================-->
481 <div class="doc_subsection">
482 <a name="otherimprovements">Other Improvements</a>
483 </div>
484
485 <div class="doc_text">
486 <p>New features include:
487 </p>
488
489 <ul>
490 <li>?</li>
491
492 </ul>
493
494 </div>
495
496 <!--=========================================================================-->
497 <div class="doc_subsection">
498 <a name="changes">Major Changes and Removed Features</a>
499 </div>
500
501 <div class="doc_text">
502
503 <p>If you're already an LLVM user or developer with out-of-tree changes based
504 on LLVM 2.4, this section lists some "gotchas" that you may run into upgrading
505 from the previous release.</p>
506
507 <ul>
508
509 <li>?</li>
510 </ul>
511
512
513 <p>In addition, many APIs have changed in this release.  Some of the major LLVM
514 API changes are:</p>
515
516 <ul>
517 <li>?</li>
518 </ul>
519
520 <li>?</li>
521 </ul>
522
523 </div>
524
525
526
527 <!-- *********************************************************************** -->
528 <div class="doc_section">
529   <a name="portability">Portability and Supported Platforms</a>
530 </div>
531 <!-- *********************************************************************** -->
532
533 <div class="doc_text">
534
535 <p>LLVM is known to work on the following platforms:</p>
536
537 <ul>
538 <li>Intel and AMD machines (IA32, X86-64, AMD64, EMT-64) running Red Hat 
539 Linux, Fedora Core and FreeBSD (and probably other unix-like systems).</li>
540 <li>PowerPC and X86-based Mac OS X systems, running 10.3 and above in 32-bit 
541 and 64-bit modes.</li>
542 <li>Intel and AMD machines running on Win32 using MinGW libraries (native).</li>
543 <li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
544     support is available for native builds with Visual C++).</li>
545 <li>Sun UltraSPARC workstations running Solaris 10.</li>
546 <li>Alpha-based machines running Debian GNU/Linux.</li>
547 <li>Itanium-based (IA64) machines running Linux and HP-UX.</li>
548 </ul>
549
550 <p>The core LLVM infrastructure uses GNU autoconf to adapt itself
551 to the machine and operating system on which it is built.  However, minor
552 porting may be required to get LLVM to work on new platforms.  We welcome your
553 portability patches and reports of successful builds or error messages.</p>
554
555 </div>
556
557 <!-- *********************************************************************** -->
558 <div class="doc_section">
559   <a name="knownproblems">Known Problems</a>
560 </div>
561 <!-- *********************************************************************** -->
562
563 <div class="doc_text">
564
565 <p>This section contains significant known problems with the LLVM system, 
566 listed by component.  If you run into a problem, please check the <a
567 href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
568 there isn't already one.</p>
569
570 </div>
571
572 <!-- ======================================================================= -->
573 <div class="doc_subsection">
574   <a name="experimental">Experimental features included with this release</a>
575 </div>
576
577 <div class="doc_text">
578
579 <p>The following components of this LLVM release are either untested, known to
580 be broken or unreliable, or are in early development.  These components should
581 not be relied on, and bugs should not be filed against them, but they may be
582 useful to some people.  In particular, if you would like to work on one of these
583 components, please contact us on the <a
584 href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p>
585
586 <ul>
587 <li>The MSIL, IA64, Alpha, SPU, MIPS, and PIC16 backends are experimental.</li>
588 <li>The llc "<tt>-filetype=asm</tt>" (the default) is the only supported
589     value for this option.</li>
590 </ul>
591
592 </div>
593
594 <!-- ======================================================================= -->
595 <div class="doc_subsection">
596   <a name="x86-be">Known problems with the X86 back-end</a>
597 </div>
598
599 <div class="doc_text">
600
601 <ul>
602   <li>The X86 backend does not yet support
603     all <a href="http://llvm.org/PR879">inline assembly that uses the X86
604     floating point stack</a>.  It supports the 'f' and 't' constraints, but not
605     'u'.</li>
606   <li>The X86 backend generates inefficient floating point code when configured
607     to generate code for systems that don't have SSE2.</li>
608   <li>Win64 code generation wasn't widely tested. Everything should work, but we
609     expect small issues to happen. Also, llvm-gcc cannot build mingw64 runtime
610     currently due
611     to <a href="http://llvm.org/PR2255">several</a>
612     <a href="http://llvm.org/PR2257">bugs</a> due to lack of support for the
613     'u' inline assembly constraint and X87 floating point inline assembly.</li>
614   <li>The X86-64 backend does not yet support the LLVM IR instruction
615       <tt>va_arg</tt>. Currently, the llvm-gcc front-end supports variadic
616       argument constructs on X86-64 by lowering them manually.</li>
617 </ul>
618
619 </div>
620
621 <!-- ======================================================================= -->
622 <div class="doc_subsection">
623   <a name="ppc-be">Known problems with the PowerPC back-end</a>
624 </div>
625
626 <div class="doc_text">
627
628 <ul>
629 <li>The Linux PPC32/ABI support needs testing for the interpreter and static
630 compilation, and lacks support for debug information.</li>
631 </ul>
632
633 </div>
634
635 <!-- ======================================================================= -->
636 <div class="doc_subsection">
637   <a name="arm-be">Known problems with the ARM back-end</a>
638 </div>
639
640 <div class="doc_text">
641
642 <ul>
643 <li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
644 processors, thumb programs can crash or produce wrong
645 results (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
646 <li>Compilation for ARM Linux OABI (old ABI) is supported, but not fully tested.
647 </li>
648 <li>There is a bug in QEMU-ARM (&lt;= 0.9.0) which causes it to incorrectly
649  execute
650 programs compiled with LLVM.  Please use more recent versions of QEMU.</li>
651 </ul>
652
653 </div>
654
655 <!-- ======================================================================= -->
656 <div class="doc_subsection">
657   <a name="sparc-be">Known problems with the SPARC back-end</a>
658 </div>
659
660 <div class="doc_text">
661
662 <ul>
663 <li>The SPARC backend only supports the 32-bit SPARC ABI (-m32), it does not
664     support the 64-bit SPARC ABI (-m64).</li>
665 </ul>
666
667 </div>
668
669 <!-- ======================================================================= -->
670 <div class="doc_subsection">
671   <a name="mips-be">Known problems with the MIPS back-end</a>
672 </div>
673
674 <div class="doc_text">
675
676 <ul>
677 <li>The O32 ABI is not fully supported.</li>
678 <li>64-bit MIPS targets are not supported yet.</li>
679 </ul>
680
681 </div>
682
683 <!-- ======================================================================= -->
684 <div class="doc_subsection">
685   <a name="alpha-be">Known problems with the Alpha back-end</a>
686 </div>
687
688 <div class="doc_text">
689
690 <ul>
691
692 <li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
693 appropriate nops inserted to ensure restartability.</li>
694
695 </ul>
696 </div>
697
698 <!-- ======================================================================= -->
699 <div class="doc_subsection">
700   <a name="ia64-be">Known problems with the IA64 back-end</a>
701 </div>
702
703 <div class="doc_text">
704
705 <ul>
706 <li>The Itanium backend is highly experimental, and has a number of known
707     issues.  We are looking for a maintainer for the Itanium backend.  If you
708     are interested, please contact the LLVMdev mailing list.</li>
709 </ul>
710
711 </div>
712
713 <!-- ======================================================================= -->
714 <div class="doc_subsection">
715   <a name="c-be">Known problems with the C back-end</a>
716 </div>
717
718 <div class="doc_text">
719
720 <ul>
721 <li><a href="http://llvm.org/PR802">The C backend has only basic support for
722     inline assembly code</a>.</li>
723 <li><a href="http://llvm.org/PR1658">The C backend violates the ABI of common
724     C++ programs</a>, preventing intermixing between C++ compiled by the CBE and
725     C++ code compiled with llc or native compilers.</li>
726 <li>The C backend does not support all exception handling constructs.</li>
727 <li>The C backend does not support arbitrary precision integers.</li>
728 </ul>
729
730 </div>
731
732
733 <!-- ======================================================================= -->
734 <div class="doc_subsection">
735   <a name="c-fe">Known problems with the llvm-gcc C front-end</a>
736 </div>
737
738 <div class="doc_text">
739
740 <p>llvm-gcc does not currently support <a href="http://llvm.org/PR869">Link-Time
741 Optimization</a> on most platforms "out-of-the-box".  Please inquire on the
742 LLVMdev mailing list if you are interested.</p>
743
744 <p>The only major language feature of GCC not supported by llvm-gcc is
745     the <tt>__builtin_apply</tt> family of builtins.   However, some extensions
746     are only supported on some targets.  For example, trampolines are only
747     supported on some targets (these are used when you take the address of a
748     nested function).</p>
749
750 <p>If you run into GCC extensions which are not supported, please let us know.
751 </p>
752
753 </div>
754
755 <!-- ======================================================================= -->
756 <div class="doc_subsection">
757   <a name="c++-fe">Known problems with the llvm-gcc C++ front-end</a>
758 </div>
759
760 <div class="doc_text">
761
762 <p>The C++ front-end is considered to be fully
763 tested and works for a number of non-trivial programs, including LLVM
764 itself, Qt, Mozilla, etc.</p>
765
766 <ul>
767 <li>Exception handling works well on the X86 and PowerPC targets. Currently
768   only Linux and Darwin targets are supported (both 32 and 64 bit).</li>
769 </ul>
770
771 </div>
772
773 <!-- ======================================================================= -->
774 <div class="doc_subsection">
775   <a name="fortran-fe">Known problems with the llvm-gcc Fortran front-end</a>
776 </div>
777
778 <div class="doc_text">
779 <ul>
780 <li>Fortran support generally works, but there are still several unresolved bugs
781     in Bugzilla.  Please see the tools/gfortran component for details.</li>
782     
783 <li>The Fortran front-end currently does not build on Darwin (without tweaks)
784     due to unresolved dependencies on the C front-end.</li>
785 </ul>
786 </div>
787
788 <!-- ======================================================================= -->
789 <div class="doc_subsection">
790   <a name="ada-fe">Known problems with the llvm-gcc Ada front-end</a>
791 </div>
792
793 <div class="doc_text">
794 The llvm-gcc 4.2 Ada compiler works fairly well, however this is not a mature
795 technology and problems should be expected.
796 <ul>
797 <li>The Ada front-end currently only builds on X86-32.  This is mainly due
798 to lack of trampoline support (pointers to nested functions) on other platforms,
799 however it <a href="http://llvm.org/PR2006">also fails to build on X86-64</a>
800 which does support trampolines.</li>
801 <li>The Ada front-end <a href="http://llvm.org/PR2007">fails to bootstrap</a>.
802 This is due to lack of LLVM support for <tt>setjmp</tt>/<tt>longjmp</tt> style
803 exception handling, which is used internally by the compiler.
804 Workaround: configure with --disable-bootstrap.</li>
805 <li>The c380004, <a href="http://llvm.org/PR2010">c393010</a>
806 and <a href="http://llvm.org/PR2421">cxg2021</a> ACATS tests fail
807 (c380004 also fails with gcc-4.2 mainline).
808 If the compiler is built with checks disabled then <a href="http://llvm.org/PR2010">c393010</a>
809 causes the compiler to go into an infinite loop, using up all system memory.</li>
810 <li>Some gcc specific Ada tests continue to crash the compiler.</li>
811 <li>The -E binder option (exception backtraces)
812 <a href="http://llvm.org/PR1982">does not work</a> and will result in programs
813 crashing if an exception is raised.  Workaround: do not use -E.</li>
814 <li>Only discrete types <a href="http://llvm.org/PR1981">are allowed to start
815 or finish at a non-byte offset</a> in a record.  Workaround: do not pack records
816 or use representation clauses that result in a field of a non-discrete type
817 starting or finishing in the middle of a byte.</li>
818 <li>The <tt>lli</tt> interpreter <a href="http://llvm.org/PR2009">considers
819 'main' as generated by the Ada binder to be invalid</a>.
820 Workaround: hand edit the file to use pointers for <tt>argv</tt> and
821 <tt>envp</tt> rather than integers.</li>
822 <li>The <tt>-fstack-check</tt> option <a href="http://llvm.org/PR2008">is
823 ignored</a>.</li>
824 </ul>
825 </div>
826
827 <!-- *********************************************************************** -->
828 <div class="doc_section">
829   <a name="additionalinfo">Additional Information</a>
830 </div>
831 <!-- *********************************************************************** -->
832
833 <div class="doc_text">
834
835 <p>A wide variety of additional information is available on the <a
836 href="http://llvm.org">LLVM web page</a>, in particular in the <a
837 href="http://llvm.org/docs/">documentation</a> section.  The web page also
838 contains versions of the API documentation which is up-to-date with the
839 Subversion version of the source code.
840 You can access versions of these documents specific to this release by going
841 into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
842
843 <p>If you have any questions or comments about LLVM, please feel free to contact
844 us via the <a href="http://llvm.org/docs/#maillist"> mailing
845 lists</a>.</p>
846
847 </div>
848
849 <!-- *********************************************************************** -->
850
851 <hr>
852 <address>
853   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
854   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
855   <a href="http://validator.w3.org/check/referer"><img
856   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
857
858   <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
859   Last modified: $Date$
860 </address>
861
862 </body>
863 </html>