96c5592cdb78d43326428a36a11b6ca5df462f0c
[oota-llvm.git] / docs / ReleaseNotes.html
1
2 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
3                       "http://www.w3.org/TR/html4/strict.dtd">
4 <html>
5 <head>
6   <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
7   <link rel="stylesheet" href="llvm.css" type="text/css">
8   <title>LLVM 2.3 Release Notes</title>
9 </head>
10 <body>
11
12 <div class="doc_title">LLVM 2.3 Release Notes</div>
13  
14 <ol>
15   <li><a href="#intro">Introduction</a></li>
16   <li><a href="#changes">Major Changes and Sub-project Status</a></li>
17   <li><a href="#whatsnew">What's New?</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>
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 <!-- Done through Week-of-Mon-20080324.txt -->
29
30 <!-- *********************************************************************** -->
31 <div class="doc_section">
32   <a name="intro">Introduction</a>
33 </div>
34 <!-- *********************************************************************** -->
35
36 <div class="doc_text">
37
38 <p>This document contains the release notes for the LLVM compiler
39 infrastructure, release 2.3.  Here we describe the status of LLVM, including
40 major improvements from the previous release and any known problems.  All LLVM
41 releases may be downloaded from the <a href="http://llvm.org/releases/">LLVM
42 releases web site</a>.</p>
43
44 <p>For more information about LLVM, including information about the latest
45 release, please check out the <a href="http://llvm.org/">main LLVM
46 web site</a>.  If you have questions or comments, the <a
47 href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM developer's mailing
48 list</a> is a good place to send them.</p>
49
50 <p>Note that if you are reading this file from a Subversion checkout or the 
51 main LLVM web page, this document applies to the <i>next</i> release, not the
52 current one.  To see the release notes for a specific releases, please see the
53 <a href="http://llvm.org/releases/">releases page</a>.</p>
54
55 </div>
56
57 <!-- *********************************************************************** -->
58 <div class="doc_section">
59   <a name="changes">Major Changes and Sub-project Status</a>
60 </div>
61 <!-- *********************************************************************** -->
62
63 <div class="doc_text">
64
65 <p>This is the fourteenth public release of the LLVM Compiler Infrastructure. 
66 It includes a large number of features and refinements from LLVM 2.2.</p>
67
68 </div>
69
70 <!-- Unfinished features in 2.3:
71   Machine LICM
72   Machine Sinking
73   LegalizeDAGTypes
74  -->
75
76 <!--=========================================================================-->
77 <div class="doc_subsection">
78 <a name="changes">Major Changes in LLVM 2.3</a>
79 </div>
80
81 <div class="doc_text">
82
83 <p>LLVM 2.3 no longer supports llvm-gcc 4.0, it has been replaced with
84    llvm-gcc 4.2.</p>
85
86 <p>LLVM 2.3 no longer includes the <tt>llvm-upgrade</tt> tool.  It was useful
87    for upgrading LLVM 1.9 files to LLVM 2.x syntax, but you can always use a
88    previous LLVM release to do this.  One nice impact of this is that the LLVM
89    regression test suite no longer depends on llvm-upgrade, which makes it run
90    faster.</p>
91
92 <p>The <tt>llvm2cpp</tt> tool has been folded into llc, use
93     <tt>llc -march=cpp</tt> instead of <tt>llvm2cpp</tt>.</p>
94
95 <p>LLVM API Changes:</p>
96
97 <ul>
98 <li>Several core LLVM IR classes have migrated to use the
99     '<tt>FOOCLASS::Create(...)</tt>' pattern instead of '<tt>new 
100     FOOCLASS(...)</tt>' (e.g. where FOOCLASS=<tt>BasicBlock</tt>).  We hope to
101     standardize on <tt>FOOCLASS::Create</tt> for all IR classes in the future,
102     but not all of them have been moved over yet.</li>
103 <li>LLVM 2.3 renames the LLVMBuilder and LLVMFoldingBuilder classes to
104     <a href="http://llvm.org/doxygen/classllvm_1_1IRBuilder.html">IRBuilder</a>.
105     </li>
106 <li>MRegisterInfo was renamed to
107     <a href="http://llvm.org/doxygen/classllvm_1_1TargetRegisterInfo.html">
108     TargetRegisterInfo</a>.</li>
109 <li>The MappedFile class is gone, please use
110     <a href="http://llvm.org/doxygen/classllvm_1_1MemoryBuffer.html">
111     MemoryBuffer</a> instead.</li>
112 <li>The '<tt>-enable-eh</tt>' flag to llc has been removed.  Now code should 
113     encode whether it is safe to omit unwind information for a function by
114     tagging the Function object with the '<tt>nounwind</tt>' attribute.</li>
115
116 </ul>
117 </div>
118
119 <!--=========================================================================-->
120 <div class="doc_subsection">
121 <a name="otherprojects">Other LLVM Sub-Projects</a>
122 </div>
123
124 <div class="doc_text">
125 <p>
126 The core LLVM 2.3 distribution currently consists of code from the core LLVM
127 repository (which roughly contains the LLVM optimizer, code generators and
128 supporting tools) and the llvm-gcc repository.  In addition to this code, the
129 LLVM Project includes other sub-projects that are in development.  The two which
130 are the most actively developed are the new <a href="#vmkit">vmkit Project</a>
131 and the <a href="#clang">Clang Project</a>. 
132 </p>
133 </div>
134
135 <!--=========================================================================-->
136 <div class="doc_subsubsection">
137 <a name="vmkit">vmkit</a>
138 </div>
139
140 <div class="doc_text">
141 <p>
142 The "vmkit" project is a new addition to the LLVM family.  It is an
143 implementation of a JVM and a CLI Virtual Machines (Microsoft .NET is an
144 implementation of the CLI) using the Just-In-Time compiler of LLVM.</p>
145
146 <p>The JVM, called JnJVM, executes real-world applications such as Apache
147 projects (e.g. Felix and Tomcat) and the SpecJVM98 benchmark.  It uses the GNU
148 Classpath project for the base classes.  The CLI implementation, called N3, is
149 its in early stages but can execute simple applications and the "pnetmark"
150 benchmark. It uses the pnetlib project as its core library.</p>
151
152 <p>The 'vmkit' VMs compare in performance with industrial and top open-source
153 VMs on scientific applications.  Besides the JIT, the VMs use many features of
154 the LLVM framework, including the standard set of optimizations, atomic
155 operations, custom function provider and memory manager for JITed methods, and
156 specific virtual machine optimizations. vmkit is not an official part of LLVM
157 2.3 release. It is publicly available under the LLVM license and can be
158 downloaded from:
159 </p>
160
161 <p>
162 <tt>svn co http://llvm.org/svn/llvm-project/vmkit/trunk vmkit</tt>
163 </p>
164
165 </div>
166
167 <!--=========================================================================-->
168 <div class="doc_subsubsection">
169 <a name="clang">Clang</a>
170 </div>
171
172 <div class="doc_text">
173
174 <p>The <a href="http://clang.llvm.org/">Clang project</a> is an effort to build
175 a set of new 'LLVM native' front-end technologies for the LLVM optimizer
176 and code generator.  Clang is continuing to make major strides forward in all
177 areas.  Its C and Objective-C parsing support is very solid, and the code
178 generation support is far enough along to build many C applications.  While not
179 yet production quality, it is progressing very nicely.  In addition, C++
180 front-end work has started to make significant progress.</p>
181
182 <p>At this point, Clang is most useful if you are interested in source-to-source
183 transformations (such as refactoring) and other source-level tools for C and
184 Objective-C.  Clang now also includes tools for turning C code into pretty HTML,
185 and includes a new <a href="http://clang.llvm.org/StaticAnalysis.html">static
186 analysis tool</a> in development.  This tool is automatically focused on finding
187 bugs in C and Objective-C code.</p>
188
189 </div>
190
191
192 <!-- *********************************************************************** -->
193 <div class="doc_section">
194   <a name="whatsnew">What's New?</a>
195 </div>
196 <!-- *********************************************************************** -->
197
198 <div class="doc_text">
199
200 <p>LLVM 2.3 includes a huge number of bug fixes, performance tweaks and minor
201 improvements.  Some of the major improvements and new features are listed in
202 this section.
203 </p>
204 </div>
205
206 <!--=========================================================================-->
207 <div class="doc_subsection">
208 <a name="majorfeatures">Major New Features</a>
209 </div>
210
211 <div class="doc_text">
212
213 <p>LLVM 2.3 includes several major new capabilities:</p>
214
215 <ul>
216 <li><p>The biggest change in LLVM 2.3 is Multiple Return Value (MRV) support.
217     MRVs allow LLVM IR to directly represent functions that return multiple
218     values without having to pass them "by reference" in the LLVM IR.  This
219     allows a front-end to generate more efficient code, as MRVs are generally
220     returned in registers if a target supports them.  See the <a
221     href="LangRef.html#i_getresult">LLVM IR Reference</a> for more details.</p>
222     
223  <p>MRVs are fully supported in the LLVM IR, but are not yet fully supported in
224     on all targets.  However, it is generally safe to return up to 2 values from
225     a function: most targets should be able to handle at least that.  MRV
226     support is a critical requirement for X86-64 ABI support, as X86-64 requires
227     the ability to return multiple registers from functions, and we use MRVs to
228     accomplish this in a direct way.</p></li>
229
230 <li><p>LLVM 2.3 includes a complete reimplementation of the "<tt>llvmc</tt>"
231     tool.  It is designed to overcome several problems with the original 
232     <tt>llvmc</tt> and to provide a superset of the features of the
233     '<tt>gcc</tt>' driver.</p>
234
235 <p>The main features of <tt>llvmc2</tt> are:
236     <ul>
237     <li>Extended handling of command line options and smart rules for
238     dispatching them to different tools.</li>
239     <li>Flexible (and extensible) rules for defining different tools.</li>
240     <li>The different intermediate steps performed by tools are represented
241     as edges in the abstract graph.</li>
242     <li>The 'language' for driver behavior definition is tablegen and thus
243     it's relatively easy to add new features.</li>
244     <li>The definition of driver is transformed into set of C++ classes, thus
245     no runtime interpretation is needed.</li>
246     </ul></p>
247     </li>
248
249 <li><p>LLVM 2.3 includes a completely rewritten interface for <a
250     href="LinkTimeOptimization.html">Link Time Optimization</a>.  This interface
251     is written in C, which allows for easier integration with C code bases, and
252     incorporates improvements we learned about from the first incarnation of the
253     interface.</p></li>
254
255 <li><p>The <a href="tutorial/LangImpl1.html">Kaleidoscope tutorial</a> now
256     includes a "port" of the tutorial that <a 
257     href="tutorial/OCamlLangImpl1.html">uses the Ocaml bindings</a> to implement
258     the Kaleidoscope language.</p></li>
259
260 </ul>
261
262 </div>
263
264
265 <!--=========================================================================-->
266 <div class="doc_subsection">
267 <a name="llvm-gcc">llvm-gcc 4.2 Improvements</a>
268 </div>
269
270 <div class="doc_text">
271
272 <p>LLVM 2.3 fully supports the llvm-gcc 4.2 front-end, and includes support
273 for the C, C++, Objective-C, Ada, and Fortran front-ends.</p>
274
275 <p>
276 <ul>
277 <li>llvm-gcc 4.2 includes numerous fixes to better support the Objective-C
278 front-end.  Objective-C now works very well on Mac OS/X.</li>
279
280 <li>Fortran EQUIVALENCEs are now supported by the gfortran front-end.</li>
281
282 <li>llvm-gcc 4.2 includes many other fixes which improve conformance with the
283 relevant parts of the GCC testsuite.</li>
284
285 </ul></p>
286
287 </div>
288
289
290 <!--=========================================================================-->
291 <div class="doc_subsection">
292 <a name="coreimprovements">LLVM Core Improvements</a>
293 </div>
294
295 <div class="doc_text">
296 <p>New features include:
297 </p>
298
299 <ul>
300 <li>LLVM IR now directly represents "common" linkage, instead of representing it
301 as a form of weak linkage.</li>
302
303 <li>LLVM IR now has support for atomic operations, and this functionality can
304 be accessed through the llvm-gcc "__sync_synchronize",
305 "__sync_val_compare_and_swap", and related builtins.  Support for atomics are
306 available in the Alpha, X86, X86-64, and PowerPC backends.</li>
307
308 <li>The C and Ocaml bindings have extended to cover pass managers, several
309 transformation passes, iteration over the LLVM IR, target data, and parameter
310 attribute lists.</li>
311 </ul>
312   
313 </div>
314
315 <!--=========================================================================-->
316 <div class="doc_subsection">
317 <a name="optimizer">Optimizer Improvements</a>
318 </div>
319
320 <div class="doc_text">
321
322 <p>In addition to a huge array of bug fixes and minor performance tweaks, the 
323 LLVM 2.3 optimizers support a few major enhancements:</p>
324
325 <ul>
326
327 <li><p>Loop index set splitting on by default.
328 This transformation hoists conditions from loop bodies and reduces a loop's
329 iteration space to improve performance. For example,</p>
330
331 <pre>
332 for (i = LB; i &lt; UB; ++i)
333   if (i &lt;= NV)
334     LOOP_BODY
335 </pre>
336
337 <p>is transformed into:</p>
338
339 <pre>
340 NUB = min(NV+1, UB)
341 for (i = LB; i &lt; NUB; ++i)
342   LOOP_BODY
343 </pre>
344 </li>
345
346 <li>LLVM now includes a new <tt>memcpy</tt> optimization pass which removes
347 dead <tt>memcpy</tt> calls, unneeded copies of aggregates, and performs
348 return slot optimization.  The LLVM optimizer now notices long sequences of
349 consecutive stores and merges them into <tt>memcpy</tt>'s where profitable.</li>
350
351 <li>Alignment detection for vector memory references and for <tt>memcpy</tt> and
352 <tt>memset</tt> is now more aggressive.</li> 
353
354 <li>The Aggressive Dead Code Elimination (ADCE) optimization has been rewritten
355 to make it both faster and safer in the presence of code containing infinite
356 loops.  Some of its prior functionality has been factored out into the loop
357 deletion pass, which <em>is</em> safe for infinite loops.  The new ADCE pass is
358 no longer based on control dependence, making it run faster.</li>
359
360 <li>The 'SimplifyLibCalls' pass, which optimizes calls to libc and libm
361     functions for C-based languages, has been rewritten to be a FunctionPass
362     instead a ModulePass.  This allows it to be run more often and to be
363     included at -O1 in llvm-gcc.  It was also extended to include more
364     optimizations and several corner case bugs were fixed.</li>
365
366 <li>LLVM now includes a simple 'Jump Threading' pass, which attempts to simplify
367     conditional branches using information about predecessor blocks, simplifying
368     the control flow graph.  This pass is pretty basic at this point, but
369     catches some important cases and provides a foundation to build on.</li>
370     
371 <li>Several corner case bugs which could lead to deleting volatile memory
372     accesses have been fixed.</li>
373
374 <li>Several optimizations have been sped up, leading to faster code generation
375     with the same code quality.</li>
376   
377 </ul>
378
379 </div>
380
381 <!--=========================================================================-->
382 <div class="doc_subsection">
383 <a name="codegen">Code Generator Improvements</a>
384 </div>
385
386 <div class="doc_text">
387
388 <p>We put a significant amount of work into the code generator infrastructure,
389 which allows us to implement more aggressive algorithms and make it run
390 faster:</p>
391
392 <ul>
393 <li>The code generator now has support for carrying information about memory
394     references throughout the entire code generation process, via the
395     <a href="http://llvm.org/doxygen/classllvm_1_1MachineMemOperand.html">
396     MachineMemOperand</a> class. In the future this will be used to improve
397     both pre-pass and post-pass scheduling, and to improve compiler-debugging
398     output.</li>
399
400 <li>The target-independent code generator infrastructure now uses LLVM's
401     <a href="http://llvm.org/doxygen/classllvm_1_1APInt.html">APInt</a>
402     class to handle integer values, which allows it to support integer types
403     larger than 64 bits (for example i128). Note that support for such types is
404     also dependent on target-specific support.  Use of APInt is also a step
405     toward support for non-power-of-2 integer sizes.</li>
406     
407 <li>LLVM 2.3 includes several compile time speedups for code with large basic
408     blocks, particularly in the instruction selection phase, register
409     allocation, scheduling, and tail merging/jump threading.</li>
410
411 <li>LLVM 2.3 includes several improvements which make llc's
412     <tt>--view-sunit-dags</tt> visualization of scheduling dependency graphs
413     easier to understand.</li>
414     
415 <li>The code generator allows targets to write patterns that generate subreg
416     references directly in .td files now.</li>
417     
418 <li><tt>memcpy</tt> lowering in the backend is more aggressive, particularly for
419     <tt>memcpy</tt> calls introduced by the code generator when handling
420     pass-by-value structure argument copies.</li>
421     
422 <li>Inline assembly with multiple register results now returns those results
423     directly in the appropriate registers, rather than going through memory.
424     Inline assembly that uses constraints like "ir" with immediates now use the
425     'i' form when possible instead of always loading the value in a register.
426     This saves an instruction and reduces register use.</li>
427
428 <li>Added support for PIC/GOT style tail calls on x86/32 and initial support
429     for tail calls on PowerPC 32 (it may also work on ppc64 but not
430     thoroughly tested).</li>
431 </ul>
432
433 </div>
434
435
436 <!--=========================================================================-->
437 <div class="doc_subsection">
438 <a name="x86specific">X86/X86-64 Specific Improvements</a>
439 </div>
440
441 <div class="doc_text">
442 <p>New target-specific features include:
443 </p>
444
445 <ul>
446 <li>llvm-gcc's X86-64 ABI conformance is far improved, particularly in the
447     area of passing and returning structures by value.  llvm-gcc compiled code
448     now interoperates very well on X86-64 systems with other compilers.</li>
449
450 <li>Support for Win64 was added. This includes code generation itself, JIT
451     support, and necessary changes to llvm-gcc.</li>
452
453 <li>The LLVM X86 backend now supports the support SSE 4.1 instruction set, and
454     the llvm-gcc 4.2 front-end supports the SSE 4.1 compiler builtins.  Various
455     generic vector operations (insert/extract/shuffle) are much more efficient
456     when SSE 4.1 is enabled.  The JIT automatically takes advantage of these
457     instructions, but llvm-gcc must be explicitly told to use them, e.g. with
458     <tt>-march=penryn</tt>.</li>
459
460 <li>The X86 backend now does a number of optimizations that aim to avoid
461     converting numbers back and forth from SSE registers to the X87 floating
462     point stack.  This is important because most X86 ABIs require return values
463     to be on the X87 Floating Point stack, but most CPUs prefer computation in
464     the SSE units.</li>
465
466 <li>The X86 backend supports stack realignment, which is particularly useful for
467     vector code on OS's without 16-byte aligned stacks, such as Linux and
468     Windows.</li>
469
470 <li>The X86 backend now supports the "sseregparm" options in GCC, which allow
471     functions to be tagged as passing floating point values in SSE
472     registers.</li>
473
474 <li>Trampolines (taking the address of a nested function) now work on
475     Linux/X86-64.</li>
476
477 <li><tt>__builtin_prefetch</tt> is now compiled into the appropriate prefetch
478     instructions instead of being ignored.</li>
479
480 <li>128-bit integers are now supported on X86-64 targets.  This can be used
481     through <tt>__attribute__((TImode))</tt> in llvm-gcc.</li>
482
483 <li>The register allocator can now rematerialize PIC-base computations, which is
484     an important optimization for register use.</li>
485
486 <li>The "t" and "f" inline assembly constraints for the X87 floating point stack
487     now work.  However, the "u" constraint is still not fully supported.</li>
488
489 </ul>
490   
491 </div>
492
493 <!--=========================================================================-->
494 <div class="doc_subsection">
495 <a name="targetspecific">Other Target Specific Improvements</a>
496 </div>
497
498 <div class="doc_text">
499 <p>New target-specific features include:
500 </p>
501
502 <ul>
503 <li>The LLVM C backend now supports vector code.</li>
504 <li>The Cell SPU backend includes a number of improvements. It generates better
505     code and its stability/completeness is improving.</li>
506 </ul>
507   
508 </div>
509
510
511
512 <!--=========================================================================-->
513 <div class="doc_subsection">
514 <a name="otherimprovements">Other Improvements</a>
515 </div>
516
517 <div class="doc_text">
518 <p>New features include:
519 </p>
520
521 <ul>
522 <li>LLVM now builds with GCC 4.3.</li>
523 <li>Bugpoint now supports running custom scripts (with the <tt>-run-custom</tt>
524     option) to determine how to execute the command and whether it is making
525     forward process.</li>
526 </ul>
527   
528 </div>
529
530 <!-- *********************************************************************** -->
531 <div class="doc_section">
532   <a name="portability">Portability and Supported Platforms</a>
533 </div>
534 <!-- *********************************************************************** -->
535
536 <div class="doc_text">
537
538 <p>LLVM is known to work on the following platforms:</p>
539
540 <ul>
541 <li>Intel and AMD machines (IA32) running Red Hat Linux, Fedora Core and FreeBSD 
542       (and probably other unix-like systems).</li>
543 <li>PowerPC and X86-based Mac OS X systems, running 10.3 and above in 32-bit and
544     64-bit modes.</li>
545 <li>Intel and AMD machines running on Win32 using MinGW libraries (native).</li>
546 <li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
547     support is available for native builds with Visual C++).</li>
548 <li>Sun UltraSPARC workstations running Solaris 10.</li>
549 <li>Alpha-based machines running Debian GNU/Linux.</li>
550 <li>Itanium-based (IA64) machines running Linux and HP-UX.</li>
551 </ul>
552
553 <p>The core LLVM infrastructure uses GNU autoconf to adapt itself
554 to the machine and operating system on which it is built.  However, minor
555 porting may be required to get LLVM to work on new platforms.  We welcome your
556 portability patches and reports of successful builds or error messages.</p>
557
558 </div>
559
560 <!-- *********************************************************************** -->
561 <div class="doc_section">
562   <a name="knownproblems">Known Problems</a>
563 </div>
564 <!-- *********************************************************************** -->
565
566 <div class="doc_text">
567
568 <p>This section contains all known problems with the LLVM system, listed by
569 component.  As new problems are discovered, they will be added to these
570 sections.  If you run into a problem, please check the <a
571 href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
572 there isn't already one.</p>
573
574 </div>
575
576 <!-- ======================================================================= -->
577 <div class="doc_subsection">
578   <a name="experimental">Experimental features included with this release</a>
579 </div>
580
581 <div class="doc_text">
582
583 <p>The following components of this LLVM release are either untested, known to
584 be broken or unreliable, or are in early development.  These components should
585 not be relied on, and bugs should not be filed against them, but they may be
586 useful to some people.  In particular, if you would like to work on one of these
587 components, please contact us on the <a
588 href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p>
589
590 <ul>
591 <li>The MSIL, IA64, Alpha, SPU, and MIPS backends are experimental.</li>
592 <li>The llc "<tt>-filetype=asm</tt>" (the default) is the only supported
593     value for this option.</li>
594 </ul>
595
596 </div>
597
598 <!-- ======================================================================= -->
599 <div class="doc_subsection">
600   <a name="x86-be">Known problems with the X86 back-end</a>
601 </div>
602
603 <div class="doc_text">
604
605 <ul>
606   <li>The X86 backend does not yet support
607     all <a href="http://llvm.org/PR879">inline assembly that uses the X86
608     floating point stack</a>.  It supports the 'f' and 't' constraints, but not
609     'u'.</li>
610   <li>The X86 backend generates inefficient floating point code when configured
611     to generate code for systems that don't have SSE2.</li>
612   <li>Win64 code generation wasn't widely tested. Everything should work, but we
613     expect small issues to happen. Also, llvm-gcc cannot build mingw64 runtime
614     currently due
615     to <a href="http://llvm.org/PR2255">several</a>
616     <a href="http://llvm.org/PR2257">bugs</a> due to lack of support for the
617     'u' inline assembly constraint and X87 floating point inline assembly.</li>
618   <li>The X86-64 backend does not yet support position-independent code (PIC)
619       generation on Linux targets.</li>
620   <li>The X86-64 backend does not yet support the LLVM IR instruction
621       <tt>va_arg</tt>. Currently, the llvm-gcc front-end supports variadic
622       argument constructs on X86-64 by lowering them manually.</li>
623 </ul>
624
625 </div>
626
627 <!-- ======================================================================= -->
628 <div class="doc_subsection">
629   <a name="ppc-be">Known problems with the PowerPC back-end</a>
630 </div>
631
632 <div class="doc_text">
633
634 <ul>
635 <li>The Linux PPC32/ABI support needs testing for the interpreter and static
636 compilation, and lacks support for debug information.</li>
637 </ul>
638
639 </div>
640
641 <!-- ======================================================================= -->
642 <div class="doc_subsection">
643   <a name="arm-be">Known problems with the ARM back-end</a>
644 </div>
645
646 <div class="doc_text">
647
648 <ul>
649 <li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
650 processors, thumb programs can crash or produce wrong
651 results (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
652 <li>Compilation for ARM Linux OABI (old ABI) is supported, but not fully tested.
653 </li>
654 <li>There is a bug in QEMU-ARM (&lt;= 0.9.0) which causes it to incorrectly
655  execute
656 programs compiled with LLVM.  Please use more recent versions of QEMU.</li>
657 </ul>
658
659 </div>
660
661 <!-- ======================================================================= -->
662 <div class="doc_subsection">
663   <a name="sparc-be">Known problems with the SPARC back-end</a>
664 </div>
665
666 <div class="doc_text">
667
668 <ul>
669 <li>The SPARC backend only supports the 32-bit SPARC ABI (-m32), it does not
670     support the 64-bit SPARC ABI (-m64).</li>
671 </ul>
672
673 </div>
674
675 <!-- ======================================================================= -->
676 <div class="doc_subsection">
677   <a name="alpha-be">Known problems with the Alpha back-end</a>
678 </div>
679
680 <div class="doc_text">
681
682 <ul>
683
684 <li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
685 appropriate nops inserted to ensure restartability.</li>
686
687 </ul>
688 </div>
689
690 <!-- ======================================================================= -->
691 <div class="doc_subsection">
692   <a name="ia64-be">Known problems with the IA64 back-end</a>
693 </div>
694
695 <div class="doc_text">
696
697 <ul>
698 <li>The Itanium backend is highly experimental, and has a number of known
699     issues.  We are looking for a maintainer for the Itanium backend.  If you
700     are interested, please contact the llvmdev mailing list.</li>
701 </ul>
702
703 </div>
704
705 <!-- ======================================================================= -->
706 <div class="doc_subsection">
707   <a name="c-be">Known problems with the C back-end</a>
708 </div>
709
710 <div class="doc_text">
711
712 <ul>
713 <li><a href="http://llvm.org/PR802">The C backend has only basic support for
714     inline assembly code</a>.</li>
715 <li><a href="http://llvm.org/PR1658">The C backend violates the ABI of common
716     C++ programs</a>, preventing intermixing between C++ compiled by the CBE and
717     C++ code compiled with llc or native compilers.</li>
718 <li>The C backend does not support all exception handling constructs.</li>
719 </ul>
720
721 </div>
722
723
724 <!-- ======================================================================= -->
725 <div class="doc_subsection">
726   <a name="c-fe">Known problems with the llvm-gcc C front-end</a>
727 </div>
728
729 <div class="doc_text">
730
731 <p>llvm-gcc does not currently support <a href="http://llvm.org/PR869">Link-Time
732 Optimization</a> on most platforms "out-of-the-box".  Please inquire on the
733 llvmdev mailing list if you are interested.</p>
734
735 <p>The only major language feature of GCC not supported by llvm-gcc is
736     the <tt>__builtin_apply</tt> family of builtins.   However, some extensions
737     are only supported on some targets.  For example, trampolines are only
738     supported on some targets (these are used when you take the address of a
739     nested function).</p>
740
741 <p>If you run into GCC extensions which are not supported, please let us know.
742 </p>
743
744 </div>
745
746 <!-- ======================================================================= -->
747 <div class="doc_subsection">
748   <a name="c++-fe">Known problems with the llvm-gcc C++ front-end</a>
749 </div>
750
751 <div class="doc_text">
752
753 <p>The C++ front-end is considered to be fully
754 tested and works for a number of non-trivial programs, including LLVM
755 itself, Qt, Mozilla, etc.</p>
756
757 <ul>
758 <li>Exception handling works well on the X86 and PowerPC targets, including
759 X86-64 darwin.  This works when linking to a libstdc++ compiled by GCC.  It is
760 supported on X86-64 linux, but that is disabled by default in this release.</li>
761 </ul>
762
763 </div>
764
765
766 <!-- ======================================================================= -->
767 <div class="doc_subsection">
768   <a name="ada-fe">Known problems with the llvm-gcc Ada front-end</a>
769 </div>
770
771 <div class="doc_text">
772 The llvm-gcc 4.2 Ada compiler works fairly well, however this is not a mature
773 technology and problems should be expected.
774 <ul>
775 <li>The Ada front-end currently only builds on X86-32.  This is mainly due
776 to lack of trampoline support (pointers to nested functions) on other platforms,
777 however it <a href="http://llvm.org/PR2006">also fails to build on X86-64</a>
778 which does support trampolines.</li>
779 <li>The Ada front-end <a href="http://llvm.org/PR2007">fails to bootstrap</a>.
780 Workaround: configure with --disable-bootstrap.</li>
781 <li>The c380004 and <a href="http://llvm.org/PR2010">c393010</a> ACATS tests
782 fail (c380004 also fails with gcc-4.2 mainline).  When built at -O3, the
783 <a href="http://llvm.org/PR2421">cxg2021</a> ACATS test also fails.</li>
784 <li>Some gcc specific Ada tests continue to crash the compiler.  The testsuite
785 reports most tests as having failed even though they pass.</li>
786 <li>The -E binder option (exception backtraces)
787 <a href="http://llvm.org/PR1982">does not work</a> and will result in programs
788 crashing if an exception is raised.  Workaround: do not use -E.</li>
789 <li>Only discrete types <a href="http://llvm.org/PR1981">are allowed to start
790 or finish at a non-byte offset</a> in a record.  Workaround: do not pack records
791 or use representation clauses that result in a field of a non-discrete type
792 starting or finishing in the middle of a byte.</li>
793 <li>The <tt>lli</tt> interpreter <a href="http://llvm.org/PR2009">considers
794 'main' as generated by the Ada binder to be invalid</a>.
795 Workaround: hand edit the file to use pointers for <tt>argv</tt> and
796 <tt>envp</tt> rather than integers.</li>
797 <li>The <tt>-fstack-check</tt> option <a href="http://llvm.org/PR2008">is
798 ignored</a>.</li>
799 </ul>
800 </div>
801
802 <!-- *********************************************************************** -->
803 <div class="doc_section">
804   <a name="additionalinfo">Additional Information</a>
805 </div>
806 <!-- *********************************************************************** -->
807
808 <div class="doc_text">
809
810 <p>A wide variety of additional information is available on the <a
811 href="http://llvm.org">LLVM web page</a>, in particular in the <a
812 href="http://llvm.org/docs/">documentation</a> section.  The web page also
813 contains versions of the API documentation which is up-to-date with the
814 Subversion version of the source code.
815 You can access versions of these documents specific to this release by going
816 into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
817
818 <p>If you have any questions or comments about LLVM, please feel free to contact
819 us via the <a href="http://llvm.org/docs/#maillist"> mailing
820 lists</a>.</p>
821
822 </div>
823
824 <!-- *********************************************************************** -->
825
826 <hr>
827 <address>
828   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
829   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
830   <a href="http://validator.w3.org/check/referer"><img
831   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
832
833   <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
834   Last modified: $Date$
835 </address>
836
837 </body>
838 </html>