Record the death of ModuleProvier and GhostLinkage in the release notes and
[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.7 Release Notes</title>
8 </head>
9 <body>
10
11 <div class="doc_title">LLVM 2.7 Release Notes</div>
12
13 <ol>
14   <li><a href="#intro">Introduction</a></li>
15   <li><a href="#subproj">Sub-project Status Update</a></li>
16   <li><a href="#externalproj">External Projects Using LLVM 2.7</a></li>
17   <li><a href="#whatsnew">What's New in LLVM 2.7?</a></li>
18   <li><a href="GettingStarted.html">Installation Instructions</a></li>
19   <li><a href="#portability">Portability and Supported Platforms</a></li>
20   <li><a href="#knownproblems">Known Problems</a></li>
21   <li><a href="#additionalinfo">Additional Information</a></li>
22 </ol>
23
24 <div class="doc_author">
25   <p>Written by the <a href="http://llvm.org">LLVM Team</a></p>
26 </div>
27
28 <h1 style="color:red">These are in-progress notes for the upcoming LLVM 2.7
29 release.<br>
30 You may prefer the
31 <a href="http://llvm.org/releases/2.6/docs/ReleaseNotes.html">LLVM 2.6
32 Release Notes</a>.</h1>
33
34 <!-- *********************************************************************** -->
35 <div class="doc_section">
36   <a name="intro">Introduction</a>
37 </div>
38 <!-- *********************************************************************** -->
39
40 <div class="doc_text">
41
42 <p>This document contains the release notes for the LLVM Compiler
43 Infrastructure, release 2.7.  Here we describe the status of LLVM, including
44 major improvements from the previous release and significant known problems.
45 All LLVM releases may be downloaded from the <a
46 href="http://llvm.org/releases/">LLVM releases web site</a>.</p>
47
48 <p>For more information about LLVM, including information about the latest
49 release, please check out the <a href="http://llvm.org/">main LLVM
50 web site</a>.  If you have questions or comments, the <a
51 href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM Developer's Mailing
52 List</a> is a good place to send them.</p>
53
54 <p>Note that if you are reading this file from a Subversion checkout or the
55 main LLVM web page, this document applies to the <i>next</i> release, not the
56 current one.  To see the release notes for a specific release, please see the
57 <a href="http://llvm.org/releases/">releases page</a>.</p>
58
59 </div>
60  
61
62 <!--
63 Almost dead code.
64   include/llvm/Analysis/LiveValues.h => Dan
65   lib/Transforms/IPO/MergeFunctions.cpp => consider for 2.8.
66   llvm/Analysis/PointerTracking.h => Edwin wants this, consider for 2.8.
67   ABCD, SCCVN, GEPSplitterPass
68   MSIL backend?
69 -->
70  
71    
72 <!-- Features that need text if they're finished for 2.7:
73   gcc plugin.
74   strong phi elim
75   variable debug info for optimized code
76   postalloc scheduler: anti dependence breaking, hazard recognizer?
77   metadata
78   loop dependence analysis
79   ELF Writer?  How stable?
80   <li>PostRA scheduler improvements, ARM adoption (David Goodwin).</li>
81   2.7 supports the GDB 7.0 jit interfaces for debug info.
82   2.7 eliminates ADT/iterator.h
83  -->
84
85  <!-- for announcement email:
86  Logo web page.
87  llvm devmtg
88  compiler_rt
89  KLEE web page at klee.llvm.org
90  Many new papers added to /pubs/
91    Mention gcc plugin.
92
93    -->
94
95 <!-- *********************************************************************** -->
96 <div class="doc_section">
97   <a name="subproj">Sub-project Status Update</a>
98 </div>
99 <!-- *********************************************************************** -->
100
101 <div class="doc_text">
102 <p>
103 The LLVM 2.7 distribution currently consists of code from the core LLVM
104 repository (which roughly includes the LLVM optimizers, code generators
105 and supporting tools), the Clang repository and the llvm-gcc repository.  In
106 addition to this code, the LLVM Project includes other sub-projects that are in
107 development.  Here we include updates on these subprojects.
108 </p>
109
110 </div>
111
112
113 <!--=========================================================================-->
114 <div class="doc_subsection">
115 <a name="clang">Clang: C/C++/Objective-C Frontend Toolkit</a>
116 </div>
117
118 <div class="doc_text">
119
120 <p>The <a href="http://clang.llvm.org/">Clang project</a> is ...</p>
121
122 <p>In the LLVM 2.7 time-frame, the Clang team has made many improvements:</p>
123
124 <ul>
125 <li>...</li>
126 </ul>
127 </div>
128
129 <!--=========================================================================-->
130 <div class="doc_subsection">
131 <a name="clangsa">Clang Static Analyzer</a>
132 </div>
133
134 <div class="doc_text">
135
136 <p>Previously announced in the 2.4, 2.5, and 2.6 LLVM releases, the Clang project also
137 includes an early stage static source code analysis tool for <a
138 href="http://clang.llvm.org/StaticAnalysis.html">automatically finding bugs</a>
139 in C and Objective-C programs. The tool performs checks to find
140 bugs that occur on a specific path within a program.</p>
141
142 <p>In the LLVM 2.7 time-frame, the analyzer core has ...</p>
143
144 </div>
145
146 <!--=========================================================================-->
147 <div class="doc_subsection">
148 <a name="vmkit">VMKit: JVM/CLI Virtual Machine Implementation</a>
149 </div>
150
151 <div class="doc_text">
152 <p>
153 The <a href="http://vmkit.llvm.org/">VMKit project</a> is an implementation of
154 a JVM and a CLI Virtual Machine (Microsoft .NET is an
155 implementation of the CLI) using LLVM for static and just-in-time
156 compilation.</p>
157
158 <p>
159 VMKit version ?? builds with LLVM 2.7 and you can find it on its
160 <a href="http://vmkit.llvm.org/releases/">web page</a>. The release includes
161 bug fixes, cleanup and new features. The major changes are:</p>
162
163 <ul>
164
165 <li>...</li>
166
167 </ul>
168 </div>
169
170
171 <!--=========================================================================-->
172 <div class="doc_subsection">
173 <a name="compiler-rt">compiler-rt: Compiler Runtime Library</a>
174 </div>
175
176 <div class="doc_text">
177 <p>
178 The new LLVM <a href="http://compiler-rt.llvm.org/">compiler-rt project</a>
179 is a simple library that provides an implementation of the low-level
180 target-specific hooks required by code generation and other runtime components.
181 For example, when compiling for a 32-bit target, converting a double to a 64-bit
182 unsigned integer is compiled into a runtime call to the "__fixunsdfdi"
183 function. The compiler-rt library provides highly optimized implementations of
184 this and other low-level routines (some are 3x faster than the equivalent
185 libgcc routines).</p>
186
187 <p>
188 All of the code in the compiler-rt project is available under the standard LLVM
189 License, a "BSD-style" license.</p>
190
191 </div>
192
193 <!--=========================================================================-->
194 <div class="doc_subsection">
195 <a name="klee">KLEE: Symbolic Execution and Automatic Test Case Generator</a>
196 </div>
197
198 <div class="doc_text">
199 <p>
200 The new LLVM <a href="http://klee.llvm.org/">KLEE project</a> is a symbolic
201 execution framework for programs in LLVM bitcode form.  KLEE tries to
202 symbolically evaluate "all" paths through the application and records state
203 transitions that lead to fault states.  This allows it to construct testcases
204 that lead to faults and can even be used to verify algorithms.  For more
205 details, please see the <a
206 href="http://llvm.org/pubs/2008-12-OSDI-KLEE.html">OSDI 2008 paper</a> about
207 KLEE.</p>
208
209 </div>
210
211 <!--=========================================================================-->
212 <div class="doc_subsection">
213 <a name="dragonegg">DragonEgg: GCC-4.5 as an LLVM frontend</a>
214 </div>
215
216 <div class="doc_text">
217 <p>
218 The goal of <a href="http://dragonegg.llvm.org/">DragonEgg</a> is to make
219 gcc-4.5 act like llvm-gcc without requiring any gcc modifications whatsoever.
220 <a href="http://dragonegg.llvm.org/">DragonEgg</a> is a shared library (dragonegg.so)
221 that is loaded by gcc at runtime.  It ...
222 </p>
223
224 </div>
225
226
227 <!--=========================================================================-->
228 <div class="doc_subsection">
229 <a name="mc">llvm-mc: Machine Code Toolkit</a>
230 </div>
231
232 <div class="doc_text">
233 <p>
234 The LLVM Machine Code (MC) Toolkit project is ...
235 </p>
236
237 </div>  
238
239
240 <!-- *********************************************************************** -->
241 <div class="doc_section">
242   <a name="externalproj">External Open Source Projects Using LLVM 2.7</a>
243 </div>
244 <!-- *********************************************************************** -->
245
246 <div class="doc_text">
247
248 <p>An exciting aspect of LLVM is that it is used as an enabling technology for
249    a lot of other language and tools projects.  This section lists some of the
250    projects that have already been updated to work with LLVM 2.7.</p>
251 </div>
252
253
254 <!--=========================================================================-->
255 <div class="doc_subsection">
256 <a name="Rubinius">Rubinius</a>
257 </div>
258
259 <div class="doc_text">
260 <p><a href="http://github.com/evanphx/rubinius">Rubinius</a> is an environment
261 for running Ruby code which strives to write as much of the core class
262 implementation in Ruby as possible. Combined with a bytecode interpreting VM, it
263 uses LLVM to optimize and compile ruby code down to machine code. Techniques
264 such as type feedback, method inlining, and uncommon traps are all used to
265 remove dynamism from ruby execution and increase performance.</p>
266
267 <p>Since LLVM 2.5, Rubinius has made several major leaps forward, implementing
268 a counter based JIT, type feedback and speculative method inlining.
269 </p>
270
271 </div>
272
273 <!--=========================================================================-->
274 <div class="doc_subsection">
275 <a name="macruby">MacRuby</a>
276 </div>
277
278 <div class="doc_text">
279
280 <p>
281 <a href="http://macruby.org">MacRuby</a> is an implementation of Ruby on top of
282 core Mac OS X technologies, such as the Objective-C common runtime and garbage
283 collector and the CoreFoundation framework. It is principally developed by
284 Apple and aims at enabling the creation of full-fledged Mac OS X applications.
285 </p>
286
287 <p>
288 MacRuby uses LLVM for optimization passes, JIT and AOT compilation of Ruby
289 expressions. It also uses zero-cost DWARF exceptions to implement Ruby exception
290 handling.</p>
291
292 </div>
293
294
295 <!--=========================================================================-->
296 <div class="doc_subsection">
297 <a name="pure">Pure</a>
298 </div>
299
300 <div class="doc_text">
301 <p>
302 <a href="http://pure-lang.googlecode.com/">Pure</a>
303 is an algebraic/functional programming language based on term rewriting.
304 Programs are collections of equations which are used to evaluate expressions in
305 a symbolic fashion. Pure offers dynamic typing, eager and lazy evaluation,
306 lexical closures, a hygienic macro system (also based on term rewriting),
307 built-in list and matrix support (including list and matrix comprehensions) and
308 an easy-to-use C interface. The interpreter uses LLVM as a backend to
309  JIT-compile Pure programs to fast native code.</p>
310
311 <p>Pure versions ??? and later have been tested and are known to work with
312 LLVM 2.7 (and continue to work with older LLVM releases >= 2.3 as well).
313 </p>
314 </div>
315
316
317 <!--=========================================================================-->
318 <div class="doc_subsection">
319 <a name="ldc">LLVM D Compiler</a>
320 </div>
321
322 <div class="doc_text">
323 <p>
324 <a href="http://www.dsource.org/projects/ldc">LDC</a> is an implementation of
325 the D Programming Language using the LLVM optimizer and code generator.
326 The LDC project works great with the LLVM 2.6 release.  General improvements in
327 this
328 cycle have included new inline asm constraint handling, better debug info
329 support, general bug fixes and better x86-64 support.  This has allowed
330 some major improvements in LDC, getting it much closer to being as
331 fully featured as the original DMD compiler from DigitalMars.
332 </p>
333 </div>
334
335 <!--=========================================================================-->
336 <div class="doc_subsection">
337 <a name="RoadsendPHP">Roadsend PHP</a>
338 </div>
339
340 <div class="doc_text">
341 <p>
342 <a href="http://code.roadsend.com/rphp">Roadsend PHP</a> (rphp) is an open
343 source implementation of the PHP programming 
344 language that uses LLVM for its optimizer, JIT and static compiler. This is a 
345 reimplementation of an earlier project that is now based on LLVM.</p>
346 </div>
347
348 <!--=========================================================================-->
349 <div class="doc_subsection">
350 <a name="UnladenSwallow">Unladen Swallow</a>
351 </div>
352
353 <div class="doc_text">
354 <p>
355 <a href="http://code.google.com/p/unladen-swallow/">Unladen Swallow</a> is a
356 branch of <a href="http://python.org/">Python</a> intended to be fully
357 compatible and significantly faster.  It uses LLVM's optimization passes and JIT
358 compiler.</p>
359 </div>
360
361 <!--=========================================================================-->
362 <div class="doc_subsection">
363 <a name="llvm-lua">llvm-lua</a>
364 </div>
365
366 <div class="doc_text">
367 <p>
368 <a href="http://code.google.com/p/llvm-lua/">LLVM-Lua</a> uses LLVM to add JIT
369 and static compiling support to the Lua VM.  Lua bytecode is analyzed to
370 remove type checks, then LLVM is used to compile the bytecode down to machine
371 code.</p>
372 </div>
373
374 <!--=========================================================================-->
375 <div class="doc_subsection">
376 <a name="icedtea">IcedTea Java Virtual Machine Implementation</a>
377 </div>
378
379 <div class="doc_text">
380 <p>
381 <a href="http://icedtea.classpath.org/wiki/Main_Page">IcedTea</a> provides a
382 harness to build OpenJDK using only free software build tools and to provide
383 replacements for the not-yet free parts of OpenJDK.  One of the extensions that
384 IcedTea provides is a new JIT compiler named <a
385 href="http://icedtea.classpath.org/wiki/ZeroSharkFaq">Shark</a> which uses LLVM
386 to provide native code generation without introducing processor-dependent
387 code.
388 </p>
389 </div>
390
391
392
393 <!-- *********************************************************************** -->
394 <div class="doc_section">
395   <a name="whatsnew">What's New in LLVM 2.7?</a>
396 </div>
397 <!-- *********************************************************************** -->
398
399 <div class="doc_text">
400
401 <p>This release includes a huge number of bug fixes, performance tweaks and
402 minor improvements.  Some of the major improvements and new features are listed
403 in this section.
404 </p>
405
406 </div>
407
408 <!--=========================================================================-->
409 <div class="doc_subsection">
410 <a name="majorfeatures">Major New Features</a>
411 </div>
412
413 <div class="doc_text">
414
415 <p>LLVM 2.7 includes several major new capabilities:</p>
416
417 <ul>
418 <li>...</li>
419 </ul>
420
421 </div>
422
423 <!--=========================================================================-->
424 <div class="doc_subsection">
425 <a name="coreimprovements">LLVM IR and Core Improvements</a>
426 </div>
427
428 <div class="doc_text">
429 <p>LLVM IR has several new features for better support of new targets and that
430 expose new optimization opportunities:</p>
431
432 <ul>
433 <li>...</li>
434 </ul>
435
436 </div>
437
438 <!--=========================================================================-->
439 <div class="doc_subsection">
440 <a name="optimizer">Optimizer Improvements</a>
441 </div>
442
443 <div class="doc_text">
444
445 <p>In addition to a large array of minor performance tweaks and bug fixes, this
446 release includes a few major enhancements and additions to the optimizers:</p>
447
448 <ul>
449
450 <li>...</li>
451
452 </ul>
453
454 </div>
455
456
457 <!--=========================================================================-->
458 <div class="doc_subsection">
459 <a name="executionengine">Interpreter and JIT Improvements</a>
460 </div>
461
462 <div class="doc_text">
463
464 <ul>
465 <li>...</li>
466 </ul>
467
468 </div>
469
470 <!--=========================================================================-->
471 <div class="doc_subsection">
472 <a name="codegen">Target Independent Code Generator Improvements</a>
473 </div>
474
475 <div class="doc_text">
476
477 <p>We have put a significant amount of work into the code generator
478 infrastructure, which allows us to implement more aggressive algorithms and make
479 it run faster:</p>
480
481 <ul>
482
483 <li>...</li>
484 </ul>
485 </div>
486
487 <!--=========================================================================-->
488 <div class="doc_subsection">
489 <a name="x86">X86-32 and X86-64 Target Improvements</a>
490 </div>
491
492 <div class="doc_text">
493 <p>New features of the X86 target include:
494 </p>
495
496 <ul>
497
498 <li>...</li>
499
500 </ul>
501
502 </div>
503
504 <!--=========================================================================-->
505 <div class="doc_subsection">
506 <a name="pic16">PIC16 Target Improvements</a>
507 </div>
508
509 <div class="doc_text">
510 <p>New features of the PIC16 target include:
511 </p>
512
513 <ul>
514 <li>...</li>
515 </ul>
516
517 <p>Things not yet supported:</p>
518
519 <ul>
520 <li>Variable arguments.</li>
521 <li>Interrupts/programs.</li>
522 </ul>
523
524 </div>
525
526 <!--=========================================================================-->
527 <div class="doc_subsection">
528 <a name="ARM">ARM Target Improvements</a>
529 </div>
530
531 <div class="doc_text">
532 <p>New features of the ARM target include:
533 </p>
534
535 <ul>
536
537 <li>...</li>
538 </ul>
539
540
541 </div>
542
543 <!--=========================================================================-->
544 <div class="doc_subsection">
545 <a name="OtherTarget">Other Target Specific Improvements</a>
546 </div>
547
548 <div class="doc_text">
549 <p>New features of other targets include:
550 </p>
551
552 <ul>
553 <li>...</li>
554 </ul>
555
556 </div>
557
558 <!--=========================================================================-->
559 <div class="doc_subsection">
560 <a name="newapis">New Useful APIs</a>
561 </div>
562
563 <div class="doc_text">
564
565 <p>This release includes a number of new APIs that are used internally, which
566    may also be useful for external clients.
567 </p>
568
569 <ul>
570 <li>...</li>
571 </ul>
572
573
574 </div>
575
576 <!--=========================================================================-->
577 <div class="doc_subsection">
578 <a name="otherimprovements">Other Improvements and New Features</a>
579 </div>
580
581 <div class="doc_text">
582 <p>Other miscellaneous features include:</p>
583
584 <ul>
585 <li>...</li>
586 </ul>
587
588 </div>
589
590
591 <!--=========================================================================-->
592 <div class="doc_subsection">
593 <a name="changes">Major Changes and Removed Features</a>
594 </div>
595
596 <div class="doc_text">
597
598 <p>If you're already an LLVM user or developer with out-of-tree changes based
599 on LLVM 2.6, this section lists some "gotchas" that you may run into upgrading
600 from the previous release.</p>
601
602 <ul>
603 <li>...</li>
604 </ul>
605
606
607 <p>In addition, many APIs have changed in this release.  Some of the major LLVM
608 API changes are:</p>
609
610 <ul>
611 <li><tt>ModuleProvider</tt> has been <a
612 href="http://llvm.org/viewvc/llvm-project?view=rev&revision=94686">removed</a>
613 and its methods moved to <tt>Module</tt> and <tt>GlobalValue</tt>.
614 Most clients can remove uses of <tt>ExistingModuleProvider</tt>,
615 replace <tt>getBitcodeModuleProvider</tt> with
616 <tt>getLazyBitcodeModule</tt>, and pass their <tt>Module</tt> to
617 functions that used to accept <tt>ModuleProvider</tt>.  Clients who
618 wrote their own <tt>ModuleProvider</tt>s will need to derive from
619 <tt>GVMaterializer</tt> instead and use
620 <tt>Module::setMaterializer</tt> to attach it to a
621 <tt>Module</tt>.</li>
622
623 <li><tt>GhostLinkage</tt> has given up the ghost.
624 <tt>GlobalValue</tt>s that have not yet been read from their backing
625 storage have the same linkage they will have after being read in.
626 Clients must replace calls to
627 <tt>GlobalValue::hasNotBeenReadFromBitcode</tt> with
628 <tt>GlobalValue::isMaterializable</tt>.</li>
629 </ul>
630
631 </div>
632
633
634
635 <!-- *********************************************************************** -->
636 <div class="doc_section">
637   <a name="portability">Portability and Supported Platforms</a>
638 </div>
639 <!-- *********************************************************************** -->
640
641 <div class="doc_text">
642
643 <p>LLVM is known to work on the following platforms:</p>
644
645 <ul>
646 <li>Intel and AMD machines (IA32, X86-64, AMD64, EMT-64) running Red Hat
647     Linux, Fedora Core, FreeBSD and AuroraUX (and probably other unix-like
648     systems).</li>
649 <li>PowerPC and X86-based Mac OS X systems, running 10.3 and above in 32-bit
650     and 64-bit modes.</li>
651 <li>Intel and AMD machines running on Win32 using MinGW libraries (native).</li>
652 <li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
653     support is available for native builds with Visual C++).</li>
654 <li>Sun x86 and AMD64 machines running Solaris 10, OpenSolaris 0906.</li>
655 <li>Alpha-based machines running Debian GNU/Linux.</li>
656 </ul>
657
658 <p>The core LLVM infrastructure uses GNU autoconf to adapt itself
659 to the machine and operating system on which it is built.  However, minor
660 porting may be required to get LLVM to work on new platforms.  We welcome your
661 portability patches and reports of successful builds or error messages.</p>
662
663 </div>
664
665 <!-- *********************************************************************** -->
666 <div class="doc_section">
667   <a name="knownproblems">Known Problems</a>
668 </div>
669 <!-- *********************************************************************** -->
670
671 <div class="doc_text">
672
673 <p>This section contains significant known problems with the LLVM system,
674 listed by component.  If you run into a problem, please check the <a
675 href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
676 there isn't already one.</p>
677
678 <ul>
679 <li>The llvm-gcc bootstrap will fail with some versions of binutils (e.g. 2.15)
680     with a message of "<tt><a href="http://llvm.org/PR5004">Error: can not do 8
681     byte pc-relative relocation</a></tt>" when building C++ code.  We intend to
682     fix this on mainline, but a workaround is to upgrade to binutils 2.17 or
683     later.</li>
684     
685 <li>LLVM will not correctly compile on Solaris and/or OpenSolaris
686 using the stock GCC 3.x.x series 'out the box',
687 See: <a href="GettingStarted.html#brokengcc">Broken versions of GCC and other tools</a>.
688 However, A <a href="http://pkg.auroraux.org/GCC">Modern GCC Build</a>
689 for x86/x86-64 has been made available from the third party AuroraUX Project
690 that has been meticulously tested for bootstrapping LLVM &amp; Clang.</li>
691 </ul>
692
693 </div>
694
695 <!-- ======================================================================= -->
696 <div class="doc_subsection">
697   <a name="experimental">Experimental features included with this release</a>
698 </div>
699
700 <div class="doc_text">
701
702 <p>The following components of this LLVM release are either untested, known to
703 be broken or unreliable, or are in early development.  These components should
704 not be relied on, and bugs should not be filed against them, but they may be
705 useful to some people.  In particular, if you would like to work on one of these
706 components, please contact us on the <a
707 href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p>
708
709 <ul>
710 <li>The MSIL, Alpha, SPU, MIPS, PIC16, Blackfin, MSP430 and SystemZ backends are
711     experimental.</li>
712 <li>The <tt>llc</tt> "<tt>-filetype=asm</tt>" (the default) is the only
713     supported value for this option.  The ELF writer is experimental.</li>
714 <li>The implementation of Andersen's Alias Analysis has many known bugs.</li>
715 </ul>
716
717 </div>
718
719 <!-- ======================================================================= -->
720 <div class="doc_subsection">
721   <a name="x86-be">Known problems with the X86 back-end</a>
722 </div>
723
724 <div class="doc_text">
725
726 <ul>
727   <li>The X86 backend does not yet support
728     all <a href="http://llvm.org/PR879">inline assembly that uses the X86
729     floating point stack</a>.  It supports the 'f' and 't' constraints, but not
730     'u'.</li>
731   <li>The X86 backend generates inefficient floating point code when configured
732     to generate code for systems that don't have SSE2.</li>
733   <li>Win64 code generation wasn't widely tested. Everything should work, but we
734     expect small issues to happen. Also, llvm-gcc cannot build the mingw64
735     runtime currently due
736     to <a href="http://llvm.org/PR2255">several</a>
737     <a href="http://llvm.org/PR2257">bugs</a> and due to lack of support for
738     the
739     'u' inline assembly constraint and for X87 floating point inline assembly.</li>
740   <li>The X86-64 backend does not yet support the LLVM IR instruction
741       <tt>va_arg</tt>. Currently, the llvm-gcc and front-ends support variadic
742       argument constructs on X86-64 by lowering them manually.</li>
743 </ul>
744
745 </div>
746
747 <!-- ======================================================================= -->
748 <div class="doc_subsection">
749   <a name="ppc-be">Known problems with the PowerPC back-end</a>
750 </div>
751
752 <div class="doc_text">
753
754 <ul>
755 <li>The Linux PPC32/ABI support needs testing for the interpreter and static
756 compilation, and lacks support for debug information.</li>
757 </ul>
758
759 </div>
760
761 <!-- ======================================================================= -->
762 <div class="doc_subsection">
763   <a name="arm-be">Known problems with the ARM back-end</a>
764 </div>
765
766 <div class="doc_text">
767
768 <ul>
769 <li>Support for the Advanced SIMD (Neon) instruction set is still incomplete
770 and not well tested.  Some features may not work at all, and the code quality
771 may be poor in some cases.</li>
772 <li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
773 processors, thumb programs can crash or produce wrong
774 results (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
775 <li>Compilation for ARM Linux OABI (old ABI) is supported but not fully tested.
776 </li>
777 </ul>
778
779 </div>
780
781 <!-- ======================================================================= -->
782 <div class="doc_subsection">
783   <a name="sparc-be">Known problems with the SPARC back-end</a>
784 </div>
785
786 <div class="doc_text">
787
788 <ul>
789 <li>The SPARC backend only supports the 32-bit SPARC ABI (-m32); it does not
790     support the 64-bit SPARC ABI (-m64).</li>
791 </ul>
792
793 </div>
794
795 <!-- ======================================================================= -->
796 <div class="doc_subsection">
797   <a name="mips-be">Known problems with the MIPS back-end</a>
798 </div>
799
800 <div class="doc_text">
801
802 <ul>
803 <li>64-bit MIPS targets are not supported yet.</li>
804 </ul>
805
806 </div>
807
808 <!-- ======================================================================= -->
809 <div class="doc_subsection">
810   <a name="alpha-be">Known problems with the Alpha back-end</a>
811 </div>
812
813 <div class="doc_text">
814
815 <ul>
816
817 <li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
818 appropriate nops inserted to ensure restartability.</li>
819
820 </ul>
821 </div>
822
823 <!-- ======================================================================= -->
824 <div class="doc_subsection">
825   <a name="c-be">Known problems with the C back-end</a>
826 </div>
827
828 <div class="doc_text">
829
830 <ul>
831 <li><a href="http://llvm.org/PR802">The C backend has only basic support for
832     inline assembly code</a>.</li>
833 <li><a href="http://llvm.org/PR1658">The C backend violates the ABI of common
834     C++ programs</a>, preventing intermixing between C++ compiled by the CBE and
835     C++ code compiled with <tt>llc</tt> or native compilers.</li>
836 <li>The C backend does not support all exception handling constructs.</li>
837 <li>The C backend does not support arbitrary precision integers.</li>
838 </ul>
839
840 </div>
841
842
843 <!-- ======================================================================= -->
844 <div class="doc_subsection">
845   <a name="c-fe">Known problems with the llvm-gcc C front-end</a>
846 </div>
847
848 <div class="doc_text">
849
850 <p>The only major language feature of GCC not supported by llvm-gcc is
851     the <tt>__builtin_apply</tt> family of builtins.   However, some extensions
852     are only supported on some targets.  For example, trampolines are only
853     supported on some targets (these are used when you take the address of a
854     nested function).</p>
855
856 <p>If you run into GCC extensions which are not supported, please let us know.
857 </p>
858
859 </div>
860
861 <!-- ======================================================================= -->
862 <div class="doc_subsection">
863   <a name="c++-fe">Known problems with the llvm-gcc C++ front-end</a>
864 </div>
865
866 <div class="doc_text">
867
868 <p>The C++ front-end is considered to be fully
869 tested and works for a number of non-trivial programs, including LLVM
870 itself, Qt, Mozilla, etc.</p>
871
872 <ul>
873 <li>Exception handling works well on the X86 and PowerPC targets. Currently
874   only Linux and Darwin targets are supported (both 32 and 64 bit).</li>
875 </ul>
876
877 </div>
878
879 <!-- ======================================================================= -->
880 <div class="doc_subsection">
881   <a name="fortran-fe">Known problems with the llvm-gcc Fortran front-end</a>
882 </div>
883
884 <div class="doc_text">
885 <ul>
886 <li>Fortran support generally works, but there are still several unresolved bugs
887     in <a href="http://llvm.org/bugs/">Bugzilla</a>.  Please see the
888     tools/gfortran component for details.</li>
889 </ul>
890 </div>
891
892 <!-- ======================================================================= -->
893 <div class="doc_subsection">
894   <a name="ada-fe">Known problems with the llvm-gcc Ada front-end</a>
895 </div>
896
897 <div class="doc_text">
898 The llvm-gcc 4.2 Ada compiler works fairly well; however, this is not a mature
899 technology, and problems should be expected.
900 <ul>
901 <li>The Ada front-end currently only builds on X86-32.  This is mainly due
902 to lack of trampoline support (pointers to nested functions) on other platforms.
903 However, it <a href="http://llvm.org/PR2006">also fails to build on X86-64</a>
904 which does support trampolines.</li>
905 <li>The Ada front-end <a href="http://llvm.org/PR2007">fails to bootstrap</a>.
906 This is due to lack of LLVM support for <tt>setjmp</tt>/<tt>longjmp</tt> style
907 exception handling, which is used internally by the compiler.
908 Workaround: configure with <tt>--disable-bootstrap</tt>.</li>
909 <li>The c380004, <a href="http://llvm.org/PR2010">c393010</a>
910 and <a href="http://llvm.org/PR2421">cxg2021</a> ACATS tests fail
911 (c380004 also fails with gcc-4.2 mainline).
912 If the compiler is built with checks disabled then <a href="http://llvm.org/PR2010">c393010</a>
913 causes the compiler to go into an infinite loop, using up all system memory.</li>
914 <li>Some GCC specific Ada tests continue to crash the compiler.</li>
915 <li>The <tt>-E</tt> binder option (exception backtraces)
916 <a href="http://llvm.org/PR1982">does not work</a> and will result in programs
917 crashing if an exception is raised.  Workaround: do not use <tt>-E</tt>.</li>
918 <li>Only discrete types <a href="http://llvm.org/PR1981">are allowed to start
919 or finish at a non-byte offset</a> in a record.  Workaround: do not pack records
920 or use representation clauses that result in a field of a non-discrete type
921 starting or finishing in the middle of a byte.</li>
922 <li>The <tt>lli</tt> interpreter <a href="http://llvm.org/PR2009">considers
923 'main' as generated by the Ada binder to be invalid</a>.
924 Workaround: hand edit the file to use pointers for <tt>argv</tt> and
925 <tt>envp</tt> rather than integers.</li>
926 <li>The <tt>-fstack-check</tt> option <a href="http://llvm.org/PR2008">is
927 ignored</a>.</li>
928 </ul>
929 </div>
930
931 <!-- ======================================================================= -->
932 <div class="doc_subsection">
933         <a name="ocaml-bindings">Known problems with the O'Caml bindings</a>
934 </div>
935
936 <div class="doc_text">
937
938 <p>The <tt>Llvm.Linkage</tt> module is broken, and has incorrect values. Only
939 <tt>Llvm.Linkage.External</tt>, <tt>Llvm.Linkage.Available_externally</tt>, and
940 <tt>Llvm.Linkage.Link_once</tt> will be correct. If you need any of the other linkage
941 modes, you'll have to write an external C library in order to expose the
942 functionality. This has been fixed in the trunk.</p>
943 </div>
944
945 <!-- *********************************************************************** -->
946 <div class="doc_section">
947   <a name="additionalinfo">Additional Information</a>
948 </div>
949 <!-- *********************************************************************** -->
950
951 <div class="doc_text">
952
953 <p>A wide variety of additional information is available on the <a
954 href="http://llvm.org">LLVM web page</a>, in particular in the <a
955 href="http://llvm.org/docs/">documentation</a> section.  The web page also
956 contains versions of the API documentation which is up-to-date with the
957 Subversion version of the source code.
958 You can access versions of these documents specific to this release by going
959 into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
960
961 <p>If you have any questions or comments about LLVM, please feel free to contact
962 us via the <a href="http://llvm.org/docs/#maillist"> mailing
963 lists</a>.</p>
964
965 </div>
966
967 <!-- *********************************************************************** -->
968
969 <hr>
970 <address>
971   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
972   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
973   <a href="http://validator.w3.org/check/referer"><img
974   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
975
976   <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
977   Last modified: $Date$
978 </address>
979
980 </body>
981 </html>