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