Add static analyzer notes.
[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.4 Release Notes</title>
8 </head>
9 <body>
10
11 <div class="doc_title">LLVM 2.4 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="#whatsnew">What's New in LLVM?</a></li>
17   <li><a href="GettingStarted.html">Installation Instructions</a></li>
18   <li><a href="#portability">Portability and Supported Platforms</a></li>
19   <li><a href="#knownproblems">Known Problems</a>
20   <li><a href="#additionalinfo">Additional Information</a></li>
21 </ol>
22
23 <div class="doc_author">
24   <p>Written by the <a href="http://llvm.org">LLVM Team</a><p>
25 </div>
26
27 <!-- *********************************************************************** -->
28 <div class="doc_section">
29   <a name="intro">Introduction</a>
30 </div>
31 <!-- *********************************************************************** -->
32
33 <div class="doc_text">
34
35 <p>This document contains the release notes for the LLVM Compiler
36 Infrastructure, release 2.4.  Here we describe the status of LLVM, including
37 major improvements from the previous release and significant known problems.
38 All LLVM releases may be downloaded from the <a 
39 href="http://llvm.org/releases/">LLVM releases web site</a>.</p>
40
41 <p>For more information about LLVM, including information about the latest
42 release, please check out the <a href="http://llvm.org/">main LLVM
43 web site</a>.  If you have questions or comments, the <a
44 href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM Developer's Mailing
45 List</a> is a good place to send them.</p>
46
47 <p>Note that if you are reading this file from a Subversion checkout or the
48 main LLVM web page, this document applies to the <i>next</i> release, not the
49 current one.  To see the release notes for a specific releases, please see the
50 <a href="http://llvm.org/releases/">releases page</a>.</p>
51
52 </div>
53
54 <!-- Unfinished features in 2.4:
55   Machine LICM
56   Machine Sinking
57   LegalizeDAGTypes
58   llc -enable-value-prop, propagation of value info (sign/zero ext info) from
59        one MBB to another
60  -->
61
62  <!-- for announcement email:
63     mention dev mtg
64     Xcode 3.1 and 3.1.1.
65   -->
66
67 <!-- *********************************************************************** -->
68 <div class="doc_section">
69   <a name="subproj">Sub-project Status Update</a>
70 </div>
71 <!-- *********************************************************************** -->
72
73 <div class="doc_text">
74 <p>
75 The LLVM 2.4 distribution currently consists of code from the core LLVM
76 repository (which roughly includes the LLVM optimizers, code generators and
77 supporting tools) and the llvm-gcc repository.  In addition to this code, the
78 LLVM Project includes other sub-projects that are in development.  The two which
79 are the most actively developed are the <a href="#clang">Clang Project</a> and
80 the <a href="#vmkit">vmkit Project</a>.
81 </p>
82
83 </div>
84
85
86 <!--=========================================================================-->
87 <div class="doc_subsection">
88 <a name="clang">Clang: C/C++/Objective-C Frontend Toolkit</a>
89 </div>
90
91 <div class="doc_text">
92
93 <p>The <a href="http://clang.llvm.org/">Clang project</a> is an effort to build
94 a set of new 'LLVM native' front-end technologies for the LLVM optimizer
95 and code generator.  Clang is continuing to make major strides forward in all
96 areas.  Its C and Objective-C parsing support is very solid, and the code
97 generation support is far enough along to build many C applications.  While not
98 yet production quality, it is progressing very nicely.  In addition, C++
99 front-end work has started to make significant progress.</p>
100
101 <p>Codegen progress/state [DANIEL]</p>
102
103 </div>
104
105 <!--=========================================================================-->
106 <div class="doc_subsection">
107 <a name="clangsa">Clang Static Analyzer</a>
108 </div>
109
110 <div class="doc_text">
111
112 <p>The Clang project also includes an early stage static source code analysis
113 tool for <a href="http://clang.llvm.org/StaticAnalysis.html">automatically
114 finding bugs</a> in C and Objective-C programs. The tool performs a growing set
115 of checks to find bugs that occur on a specific path within a program. Examples
116 of bugs the tool finds include logic errors such as null dereferences,
117 violations of various API rules, dead code, and potential memory leaks in
118 Objective-C programs. Since its public announcement at Apple's WWDC 2008
119 conference, the public feedback on the tool has been extremely positive, and
120 conservative estimates put the number of real bugs it has found in
121 industrial-quality software on the order of thousands.</p>
122
123 <p>The tool also provides a simple web GUI to inspect potential bugs found by
124 the tool. While still early in development, the GUI illustrates some of the key
125 features of Clang: accurate source location information, which is used by the
126 GUI to highlight specific code expressions that relate to a bug (including those
127 that span multiple lines) and built-in knowledge of macros, which is used to
128 perform inline expansion of macros within the GUI itself.</p>
129
130 <p>The set of checks perform by the static analyzer is gradually expanding, and
131 future plans for the tool include full source-level inter-procedural analysis
132 and deeper checks such as buffer overrun detection. There are many opportunities
133 to extend and enhance the static analyzer, and anyone interested in working on
134 this project is encouraged to get involved!</p>
135
136 </div>
137
138 <!--=========================================================================-->
139 <div class="doc_subsection">
140 <a name="vmkit">vmkit: JVM/CLI Virtual Machine Implementation</a>
141 </div>
142
143 <div class="doc_text">
144 <p>
145 The <a href="http://vmkit.llvm.org/">vmkit project</a> is an implementation of
146 a JVM and a CLI Virtual Machines (Microsoft .NET is an
147 implementation of the CLI) using the Just-In-Time compiler of LLVM.</p>
148
149 <p>[NICOLAS]</p>
150
151 </div>
152
153
154 <!-- *********************************************************************** -->
155 <div class="doc_section">
156   <a name="whatsnew">What's New in LLVM?</a>
157 </div>
158 <!-- *********************************************************************** -->
159
160 <div class="doc_text">
161
162 <p>This release includes a huge number of bug fixes, performance tweaks and
163 minor improvements.  Some of the major improvements and new features are listed
164 in this section.
165 </p>
166 </div>
167
168 <!--=========================================================================-->
169 <div class="doc_subsection">
170 <a name="majorfeatures">Major New Features</a>
171 </div>
172
173 <div class="doc_text">
174
175 <p>LLVM 2.4 includes several major new capabilities:</p>
176
177 <ul>
178 <li><p>The most visible end-user change in LLVM 2.4 is that it includes many
179 optimizations and changes to make -O0 compile times much faster.  You should see
180 improvements on the order of 30% or more faster than LLVM 2.3.  There are many
181 pieces to this change, described in more detail below.  The speedups and new
182 components can also be used for JIT compilers that want fast compilation as
183 well.</p></li>
184
185 <li><p>The biggest change to the LLVM IR is that Multiple Return Values (which
186 were introduced in LLVM 2.3) have been generalized to full support for "First
187 Class Aggregate" values in LLVM 2.4.  This means that LLVM IR supports using
188 structs and arrays as values in a function.  This capability is mostly useful
189 for front-end authors, who prefer to treat things like complex numbers, simple
190 tuples, dope vectors, etc as Value*'s instead of as a tuple of Value*'s or as
191 memory values.</p></li>
192
193 <li><p>LLVM 2.4 also includes an initial port for the PIC16 microprocessor. This
194 is the LLVM targer that only has support for 8 bit registers, and a number of
195 other crazy constraints.  While the port is still in early development stages,
196 it shows some interesting things you can do with LLVM.</p></li>
197
198 </ul>
199
200 </div>
201
202
203 <!--=========================================================================-->
204 <div class="doc_subsection">
205 <a name="llvm-gcc">llvm-gcc 4.2 Improvements</a>
206 </div>
207
208 <div class="doc_text">
209
210 <p>LLVM fully supports the llvm-gcc 4.2 front-end, which marries the GCC
211 front-ends and driver with the LLVM optimizer and code generator.  It currently
212 includes support for the C, C++, Objective-C, Ada, and Fortran front-ends.</p>
213
214 <ul>
215 <li>LLVM 2.4 supports the full set of atomic <tt>__sync_*</tt> builtins.  LLVM
216 2.3 only supported those used by OpenMP, but 2.4 supports them all.  While
217 llvm-gcc supports all of these builtins, note that not all targets do.  X86 
218 support them all in both 32-bit and 64-bit mode and PowerPC supports them all
219 except for the 64-bit operations when in 32-bit mode.</li>
220
221 <li>llvm-gcc now supports an <tt>-flimited-precision</tt> option, which tells
222 the compiler that it is ok to use low-precision approximations of certain libm
223 functions (like tan, log, etc).  This allows you to get high performance if you
224 only need (say) 14-bits of precision.</li>
225
226 <li>llvm-gcc now supports a C language extension known as "<a 
227 href="http://lists.cs.uiuc.edu/pipermail/cfe-dev/2008-August/002670.html">Blocks
228 </a>.  This feature is similar to nested functions and closures, but does not
229 require stack trampolines (with most ABIs) and supports returning closures 
230 from functions that define them.  Note that actually <em>using</em> Blocks
231 requires a small runtime that is not included with llvm-gcc.</li>
232
233 <li>llvm-gcc now supports a new <tt>-flto</tt> option.  On systems that support
234 transparent Link Time Optimization (currently Darwin systems with Xcode 3.1 and
235 later) this allows the use of LTO with other optimization levels like -Os.
236 Previously, LTO could only be used with -O4, which implied optimizations in
237 -O3 that can increase code size.</li>
238 </ul>
239
240 </div>
241
242
243 <!--=========================================================================-->
244 <div class="doc_subsection">
245 <a name="coreimprovements">LLVM Core Improvements</a>
246 </div>
247
248 <div class="doc_text">
249 <p>New features include:
250 </p>
251
252 <ul>
253 <li>A major change to the "Use" class landed, which shrank it by 25%.  Since
254 this is a pervasive part of the LLVM, it ended up reducing the memory use of
255 LLVM IR in general by 15% for most programs.</li>
256
257 <li>Values with no names are now pretty printed by <tt>llvm-dis</tt> more
258 nicely.  They now print as "<tt>%3 = add i32 %A, 4</tt>" instead of
259 "<tt>add i32 %A, 4   ; &lt;i32&gt;:3</tt>", which makes it much easier to read.
260 </li>
261
262 <li>LLVM 2.4 includes some changes for better vector support.  First, the shift
263 operations (<tt>shl</tt>, <tt>ashr</tt>, <tt>lshr</tt>) now all support vectors
264 and do an element-by-element shift (shifts of the whole vector can be
265 accomplished by bitcasting the vector to &lt;1 x i128&gt; for example).  Second,
266 there is initial support in development for vector comparisons with the 
267 <a href="LangRef.html#i_fcmp">fcmp</a>/<a href="LangRef.html#i_icmp">icmp</a>
268 instructions.  These instructions compare two vectors and return a vector of
269 i1's for each result.  Note that there is very little codegen support available
270 for any of these IR features though.</li>
271
272 <li>A new <tt>DebugInfoBuilder</tt> class is available, which makes it much
273 easier for front-ends to create debug info descriptors, similar to the way that
274 IRBuilder makes it easier to create LLVM IR.</li>
275
276 <li>LLVM now supports "function attributes", which allows us to seperate return
277 value attributes from function attributes.  LLVM now supports attributes on a
278 function itself, a return value, and its parameters.  New supported function
279 attributes include noinline/alwaysinline and the "opt-size" flag which says the
280 function should be optimized for code size.</li>
281
282 <li>LLVM IR now directly represents "common" linkage, instead of
283     representing it as a form of weak linkage.</li>
284     
285 </ul>
286
287 </div>
288
289 <!--=========================================================================-->
290 <div class="doc_subsection">
291 <a name="optimizer">Optimizer Improvements</a>
292 </div>
293
294 <div class="doc_text">
295
296 <p>In addition to a huge array of bug fixes and minor performance tweaks, this
297 release includes a few major enhancements and additions to the optimizers:</p>
298
299 <ul>
300
301 <li>The Global Value Numbering (GVN) pass now does local Partial Redundancy
302 Elimination (PRE) to eliminate some partially redundant expressions in cases
303 where doing so won't grow code size.</li>
304
305 <li>LLVM 2.4 includes a new loop deletion pass (which removes output-free
306 provably-finite loops) and a rewritten Aggressive Dead Code Elimination (ADCE)
307 pass that no longer uses control dependence information.  These changes speed up
308 the optimizer and also prevents it from deleting output-free infinite
309 loops.</li>
310
311 <li>The new AddReadAttrs pass works out which functions are read-only or
312 read-none (these correspond to 'pure' and 'const' in C) and marks them
313 with the appropriate attribute.</li>
314
315 <li>LLVM 2.4 now includes a new SparsePropagation framework, which makes it
316 trivial to build lattice-based dataflow solvers that operate over LLVM IR. Using
317 this interface means that you just define objects to represent your lattice
318 values and the transfer functions that operate on them.  It handles the
319 mechanics of worklist processing, liveness tracking, handling PHI nodes,
320 etc.</li>
321
322 <li>Various helper functions (ComputeMaskedBits, ComputeNumSignBits, etc) were
323 pulled out of the Instruction Combining pass and put into a new 
324 <tt>ValueTracking.h</tt> header, where they can be reused by other passes.</li>
325
326 <li>The tail duplication pass has been removed from the standard optimizer
327 sequence used by llvm-gcc.  This pass still exists, but the benefits it once
328 provided are now achieved by other passes.</li>
329
330 </ul>
331
332 </div>
333
334 <!--=========================================================================-->
335 <div class="doc_subsection">
336 <a name="codegen">Code Generator Improvements</a>
337 </div>
338
339 <div class="doc_text">
340
341 <p>We put a significant amount of work into the code generator infrastructure,
342 which allows us to implement more aggressive algorithms and make it run
343 faster:</p>
344
345 <ul>
346 <li>The target-independent code generator supports (and the X86 backend
347     currently implements) a new interface for "fast" instruction selection. This
348     interface is optimized to produce code as quickly as possible, sacrificing
349     code quality to do it.  This is used by default at -O0 or when using
350     "llc -fast" on X86.  It is straight-forward to add support for
351     other targets if faster -O0 compilation is desired.</li>
352
353 <li>In addition to the new 'fast' instruction selection path, many existing
354     pieces of the code generator have been optimized in significant ways.
355     SelectionDAG's are now pool allocated and use better algorithms in many
356     places, the ".s" file printers now use raw_ostream to emit text much faster,
357     etc.  The end result of these improvements is that the compiler also takes
358     substantially less time to generate code that is just as good (and often
359     better) than before.</li>
360
361 <li>Each target has been split to separate the .s file printing logic from the
362     rest of the target.  This enables JIT compilers that don't link in the
363     (somewhat large) code and data tables used for printing a .s file.</li>
364
365 <li>The code generator now includes a "stack slot coloring" pass, which packs
366     together individual spilled values into common stack slots.  This reduces
367     the size of stack frames with many spills, which tends to increase L1 cache
368     effectiveness.</li>
369
370 <li>Various pieces of the register allocator (e.g. the coalescer and two-address
371     operation elimination pass) now know how to rematerialize trivial operations
372     to avoid copies and include several other optimizations.</li>
373
374 <li>The <a href="CodeGenerator.html#selectiondag_process">graphs</a> produced by
375     the <tt>llc -view-*-dags</tt> options are now significantly prettier and
376     easier to read.</li>
377
378 <li>LLVM 2.4 includes a new register allocator based on Partitioned Boolean
379     Quadratic Programming (PBQP).  This register allocator is still in
380     development, but is very simple and clean.</li>
381
382 </ul>
383
384 </div>
385
386
387 <!--=========================================================================-->
388 <div class="doc_subsection">
389 <a name="targetspecific">Target Specific Improvements</a>
390 </div>
391
392 <div class="doc_text">
393 <p>New target-specific features include:
394 </p>
395
396 <ul>
397 <li>Exception handling is supported by default on Linux/x86-64.</li>
398 <li>Position Independent Code (PIC) is now supported on Linux/x86-64.</li>
399 <li>MIPS floating point support? [BRUNO]</li>
400 <li>The PowerPC backend now supports trampolines.</li>
401 </ul>
402
403 </div>
404
405
406 <!--=========================================================================-->
407 <div class="doc_subsection">
408 <a name="otherimprovements">Other Improvements</a>
409 </div>
410
411 <div class="doc_text">
412 <p>New features include:
413 </p>
414
415 <ul>
416 <li><tt>llvmc2</tt> (the generic compiler driver) gained plugin
417     support. It is now easier to experiment with <tt>llvmc2</tt> and
418     build your own tools based on it.</li>
419
420 <li>LLVM 2.4 includes a number of new generic algorithms and data structures,
421     include a scoped hash table, 'immutable' data structures, and a 
422     <tt>raw_ostream</tt> class.  The <tt>raw_ostream</tt> class and
423     <tt>format</tt> allow for efficient file output, and various pieces of LLVM
424     have switched over to use it.   The eventual goal is to eliminate
425     std::ostream in favor of it.</li>
426
427 <li>Recycler + pool allocation stuff? [DAN]</li>
428 </ul>
429
430 </div>
431
432 <!--=========================================================================-->
433 <div class="doc_subsection">
434 <a name="changes">Major Changes and Removed Features</a>
435 </div>
436
437 <div class="doc_text">
438
439 <p>If you're already an LLVM user or developer with out-of-tree changes based
440 on LLVM 2.3, this section lists some "gotchas" that you may run into upgrading
441 from the previous release.</p>
442
443 <ul>
444
445 <li>The LLVM IR generated by llvm-gcc no longer names all instructions.  This
446     makes it run faster, but may be more confusing to some people.  If you
447     prefer to have names, the '<tt>opt -instnamer</tt>' pass will add names to
448     all instructions.</li>
449
450 <li>The LoadVN and GCSE passes have been removed from the tree.  They are
451     obsolete and have been replaced with the GVN and MemoryDependence passes.
452     </li>
453 </ul>
454
455
456 <p>In addition, many APIs have changed in this release.  Some of the major LLVM
457 API changes are:</p>
458
459 <ul>
460
461 <li>Attributes changes [DEVANG] </li>
462
463 <li>The <tt>DbgStopPointInst</tt> methods <tt>getDirectory</tt> and
464 <tt>getFileName</tt> now return <tt>Value*</tt> instead of strings. These can be
465 converted to strings using <tt>llvm::GetConstantStringInfo</tt> defined via
466 "llvm/Analysis/ValueTracking.h".</li>
467
468 <li>The APIs to create various instructions have changed from lower case
469    "create" methods to upper case "Create" methods (e.g. 
470    <tt>BinaryOperator::create</tt>).  LLVM 2.4 includes both cases, but the
471    lower case ones are removed in mainline, please migrate.</li>
472
473 <li>Various header files like "llvm/ADT/iterator" were given a .h suffix.
474     Change your code to #include "llvm/ADT/iterator.h" instead.</li>
475
476 </ul>
477
478 </div>
479
480
481
482 <!-- *********************************************************************** -->
483 <div class="doc_section">
484   <a name="portability">Portability and Supported Platforms</a>
485 </div>
486 <!-- *********************************************************************** -->
487
488 <div class="doc_text">
489
490 <p>LLVM is known to work on the following platforms:</p>
491
492 <ul>
493 <li>Intel and AMD machines (IA32) running Red Hat Linux, Fedora Core and FreeBSD
494       (and probably other unix-like systems).</li>
495 <li>PowerPC and X86-based Mac OS X systems, running 10.3 and above in 32-bit and
496     64-bit modes.</li>
497 <li>Intel and AMD machines running on Win32 using MinGW libraries (native).</li>
498 <li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
499     support is available for native builds with Visual C++).</li>
500 <li>Sun UltraSPARC workstations running Solaris 10.</li>
501 <li>Alpha-based machines running Debian GNU/Linux.</li>
502 <li>Itanium-based (IA64) machines running Linux and HP-UX.</li>
503 </ul>
504
505 <p>The core LLVM infrastructure uses GNU autoconf to adapt itself
506 to the machine and operating system on which it is built.  However, minor
507 porting may be required to get LLVM to work on new platforms.  We welcome your
508 portability patches and reports of successful builds or error messages.</p>
509
510 </div>
511
512 <!-- *********************************************************************** -->
513 <div class="doc_section">
514   <a name="knownproblems">Known Problems</a>
515 </div>
516 <!-- *********************************************************************** -->
517
518 <div class="doc_text">
519
520 <p>This section contains all known problems with the LLVM system, listed by
521 component.  As new problems are discovered, they will be added to these
522 sections.  If you run into a problem, please check the <a
523 href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
524 there isn't already one.</p>
525
526 </div>
527
528 <!-- ======================================================================= -->
529 <div class="doc_subsection">
530   <a name="experimental">Experimental features included with this release</a>
531 </div>
532
533 <div class="doc_text">
534
535 <p>The following components of this LLVM release are either untested, known to
536 be broken or unreliable, or are in early development.  These components should
537 not be relied on, and bugs should not be filed against them, but they may be
538 useful to some people.  In particular, if you would like to work on one of these
539 components, please contact us on the <a
540 href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p>
541
542 <ul>
543 <li>The MSIL, IA64, Alpha, SPU, and MIPS backends are experimental.</li>
544 <li>The llc "<tt>-filetype=asm</tt>" (the default) is the only supported
545     value for this option.</li>
546 </ul>
547
548 </div>
549
550 <!-- ======================================================================= -->
551 <div class="doc_subsection">
552   <a name="x86-be">Known problems with the X86 back-end</a>
553 </div>
554
555 <div class="doc_text">
556
557 <ul>
558   <li>The X86 backend does not yet support
559     all <a href="http://llvm.org/PR879">inline assembly that uses the X86
560     floating point stack</a>.  It supports the 'f' and 't' constraints, but not
561     'u'.</li>
562   <li>The X86 backend generates inefficient floating point code when configured
563     to generate code for systems that don't have SSE2.</li>
564   <li>Win64 code generation wasn't widely tested. Everything should work, but we
565     expect small issues to happen. Also, llvm-gcc cannot build mingw64 runtime
566     currently due
567     to <a href="http://llvm.org/PR2255">several</a>
568     <a href="http://llvm.org/PR2257">bugs</a> due to lack of support for the
569     'u' inline assembly constraint and X87 floating point inline assembly.</li>
570   <li>The X86-64 backend does not yet support the LLVM IR instruction
571       <tt>va_arg</tt>. Currently, the llvm-gcc front-end supports variadic
572       argument constructs on X86-64 by lowering them manually.</li>
573 </ul>
574
575 </div>
576
577 <!-- ======================================================================= -->
578 <div class="doc_subsection">
579   <a name="ppc-be">Known problems with the PowerPC back-end</a>
580 </div>
581
582 <div class="doc_text">
583
584 <ul>
585 <li>The Linux PPC32/ABI support needs testing for the interpreter and static
586 compilation, and lacks support for debug information.</li>
587 </ul>
588
589 </div>
590
591 <!-- ======================================================================= -->
592 <div class="doc_subsection">
593   <a name="arm-be">Known problems with the ARM back-end</a>
594 </div>
595
596 <div class="doc_text">
597
598 <ul>
599 <li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
600 processors, thumb programs can crash or produce wrong
601 results (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
602 <li>Compilation for ARM Linux OABI (old ABI) is supported, but not fully tested.
603 </li>
604 <li>There is a bug in QEMU-ARM (&lt;= 0.9.0) which causes it to incorrectly
605  execute
606 programs compiled with LLVM.  Please use more recent versions of QEMU.</li>
607 </ul>
608
609 </div>
610
611 <!-- ======================================================================= -->
612 <div class="doc_subsection">
613   <a name="sparc-be">Known problems with the SPARC back-end</a>
614 </div>
615
616 <div class="doc_text">
617
618 <ul>
619 <li>The SPARC backend only supports the 32-bit SPARC ABI (-m32), it does not
620     support the 64-bit SPARC ABI (-m64).</li>
621 </ul>
622
623 </div>
624
625 <!-- ======================================================================= -->
626 <div class="doc_subsection">
627   <a name="alpha-be">Known problems with the Alpha back-end</a>
628 </div>
629
630 <div class="doc_text">
631
632 <ul>
633
634 <li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
635 appropriate nops inserted to ensure restartability.</li>
636
637 </ul>
638 </div>
639
640 <!-- ======================================================================= -->
641 <div class="doc_subsection">
642   <a name="ia64-be">Known problems with the IA64 back-end</a>
643 </div>
644
645 <div class="doc_text">
646
647 <ul>
648 <li>The Itanium backend is highly experimental, and has a number of known
649     issues.  We are looking for a maintainer for the Itanium backend.  If you
650     are interested, please contact the llvmdev mailing list.</li>
651 </ul>
652
653 </div>
654
655 <!-- ======================================================================= -->
656 <div class="doc_subsection">
657   <a name="c-be">Known problems with the C back-end</a>
658 </div>
659
660 <div class="doc_text">
661
662 <ul>
663 <li><a href="http://llvm.org/PR802">The C backend has only basic support for
664     inline assembly code</a>.</li>
665 <li><a href="http://llvm.org/PR1658">The C backend violates the ABI of common
666     C++ programs</a>, preventing intermixing between C++ compiled by the CBE and
667     C++ code compiled with llc or native compilers.</li>
668 <li>The C backend does not support all exception handling constructs.</li>
669 </ul>
670
671 </div>
672
673
674 <!-- ======================================================================= -->
675 <div class="doc_subsection">
676   <a name="c-fe">Known problems with the llvm-gcc C front-end</a>
677 </div>
678
679 <div class="doc_text">
680
681 <p>llvm-gcc does not currently support <a href="http://llvm.org/PR869">Link-Time
682 Optimization</a> on most platforms "out-of-the-box".  Please inquire on the
683 llvmdev mailing list if you are interested.</p>
684
685 <p>The only major language feature of GCC not supported by llvm-gcc is
686     the <tt>__builtin_apply</tt> family of builtins.   However, some extensions
687     are only supported on some targets.  For example, trampolines are only
688     supported on some targets (these are used when you take the address of a
689     nested function).</p>
690
691 <p>If you run into GCC extensions which are not supported, please let us know.
692 </p>
693
694 </div>
695
696 <!-- ======================================================================= -->
697 <div class="doc_subsection">
698   <a name="c++-fe">Known problems with the llvm-gcc C++ front-end</a>
699 </div>
700
701 <div class="doc_text">
702
703 <p>The C++ front-end is considered to be fully
704 tested and works for a number of non-trivial programs, including LLVM
705 itself, Qt, Mozilla, etc.</p>
706
707 <ul>
708 <li>Exception handling works well on the X86 and PowerPC targets. Currently
709   only linux and darwin targets are supported (both 32 and 64 bit).</li>
710 </ul>
711
712 </div>
713
714
715 <!-- ======================================================================= -->
716 <div class="doc_subsection">
717   <a name="ada-fe">Known problems with the llvm-gcc Ada front-end</a>
718 </div>
719
720 <div class="doc_text">
721 The llvm-gcc 4.2 Ada compiler works fairly well, however this is not a mature
722 technology and problems should be expected.
723 <ul>
724 <li>The Ada front-end currently only builds on X86-32.  This is mainly due
725 to lack of trampoline support (pointers to nested functions) on other platforms,
726 however it <a href="http://llvm.org/PR2006">also fails to build on X86-64</a>
727 which does support trampolines.</li>
728 <li>The Ada front-end <a href="http://llvm.org/PR2007">fails to bootstrap</a>.
729 Workaround: configure with --disable-bootstrap.</li>
730 <li>The c380004, <a href="http://llvm.org/PR2010">c393010</a>
731 and <a href="http://llvm.org/PR2421">cxg2021</a> ACATS tests fail
732 (c380004 also fails with gcc-4.2 mainline).</li>
733 <li>Some gcc specific Ada tests continue to crash the compiler.</li>
734 <li>The -E binder option (exception backtraces)
735 <a href="http://llvm.org/PR1982">does not work</a> and will result in programs
736 crashing if an exception is raised.  Workaround: do not use -E.</li>
737 <li>Only discrete types <a href="http://llvm.org/PR1981">are allowed to start
738 or finish at a non-byte offset</a> in a record.  Workaround: do not pack records
739 or use representation clauses that result in a field of a non-discrete type
740 starting or finishing in the middle of a byte.</li>
741 <li>The <tt>lli</tt> interpreter <a href="http://llvm.org/PR2009">considers
742 'main' as generated by the Ada binder to be invalid</a>.
743 Workaround: hand edit the file to use pointers for <tt>argv</tt> and
744 <tt>envp</tt> rather than integers.</li>
745 <li>The <tt>-fstack-check</tt> option <a href="http://llvm.org/PR2008">is
746 ignored</a>.</li>
747 </ul>
748 </div>
749
750 <!-- *********************************************************************** -->
751 <div class="doc_section">
752   <a name="additionalinfo">Additional Information</a>
753 </div>
754 <!-- *********************************************************************** -->
755
756 <div class="doc_text">
757
758 <p>A wide variety of additional information is available on the <a
759 href="http://llvm.org">LLVM web page</a>, in particular in the <a
760 href="http://llvm.org/docs/">documentation</a> section.  The web page also
761 contains versions of the API documentation which is up-to-date with the
762 Subversion version of the source code.
763 You can access versions of these documents specific to this release by going
764 into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
765
766 <p>If you have any questions or comments about LLVM, please feel free to contact
767 us via the <a href="http://llvm.org/docs/#maillist"> mailing
768 lists</a>.</p>
769
770 </div>
771
772 <!-- *********************************************************************** -->
773
774 <hr>
775 <address>
776   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
777   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
778   <a href="http://validator.w3.org/check/referer"><img
779   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
780
781   <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
782   Last modified: $Date$
783 </address>
784
785 </body>
786 </html>