Fix bug with APInt::getBitsNeeded with for base 10 numbers 0-9.
[oota-llvm.git] / docs / ReleaseNotes-2.6.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.6 Release Notes</title>
8 </head>
9 <body>
10
11 <div class="doc_title">LLVM 2.6 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.6</a></li>
17   <li><a href="#whatsnew">What's New in LLVM 2.6?</a></li>
18   <li><a href="GettingStarted.html">Installation Instructions</a></li>
19   <li><a href="#portability">Portability and Supported Platforms</a></li>
20   <li><a href="#knownproblems">Known Problems</a></li>
21   <li><a href="#additionalinfo">Additional Information</a></li>
22 </ol>
23
24 <div class="doc_author">
25   <p>Written by the <a href="http://llvm.org">LLVM Team</a></p>
26 </div>
27
28 <!-- *********************************************************************** -->
29 <div class="doc_section">
30   <a name="intro">Introduction</a>
31 </div>
32 <!-- *********************************************************************** -->
33
34 <div class="doc_text">
35
36 <p>This document contains the release notes for the LLVM Compiler
37 Infrastructure, release 2.6.  Here we describe the status of LLVM, including
38 major improvements from the previous release and significant known problems.
39 All LLVM releases may be downloaded from the <a
40 href="http://llvm.org/releases/">LLVM releases web site</a>.</p>
41
42 <p>For more information about LLVM, including information about the latest
43 release, please check out the <a href="http://llvm.org/">main LLVM
44 web site</a>.  If you have questions or comments, the <a
45 href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM Developer's Mailing
46 List</a> is a good place to send them.</p>
47
48 <p>Note that if you are reading this file from a Subversion checkout or the
49 main LLVM web page, this document applies to the <i>next</i> release, not the
50 current one.  To see the release notes for a specific release, please see the
51 <a href="http://llvm.org/releases/">releases page</a>.</p>
52
53 </div>
54
55 <!-- Unfinished features in 2.5:
56   Machine LICM
57   Machine Sinking
58   target-specific intrinsics
59   gold lto plugin
60   pre-alloc splitter, strong phi elim
61   <tt>llc -enable-value-prop</tt>, propagation of value info
62        (sign/zero ext info) from one MBB to another
63   debug info for optimized code
64   interpreter + libffi
65   postalloc scheduler: anti dependence breaking, hazard recognizer?
66
67 initial support for debug line numbers when optimization enabled, not useful in
68   2.5 but will be for 2.6.
69
70  -->
71
72  <!-- for announcement email:
73    -->
74
75 <!-- *********************************************************************** -->
76 <div class="doc_section">
77   <a name="subproj">Sub-project Status Update</a>
78 </div>
79 <!-- *********************************************************************** -->
80
81 <div class="doc_text">
82 <p>
83 The LLVM 2.6 distribution currently consists of code from the core LLVM
84 repository &mdash;which roughly includes the LLVM optimizers, code generators
85 and supporting tools &mdash; and the llvm-gcc repository.  In addition to this
86 code, the LLVM Project includes other sub-projects that are in development.  The
87 two which are the most actively developed are the <a href="#clang">Clang
88 Project</a> and the <a href="#vmkit">VMKit Project</a>.
89 </p>
90
91 </div>
92
93
94 <!--=========================================================================-->
95 <div class="doc_subsection">
96 <a name="clang">Clang: C/C++/Objective-C Frontend Toolkit</a>
97 </div>
98
99 <div class="doc_text">
100
101 <p>The <a href="http://clang.llvm.org/">Clang project</a> is an effort to build
102 a set of new 'LLVM native' front-end technologies for the LLVM optimizer and
103 code generator.  While Clang is not included in the LLVM 2.6 release, it is
104 continuing to make major strides forward in all areas.  Its C and Objective-C
105 parsing and code generation support is now very solid.  For example, it is
106 capable of successfully building many real-world applications for X86-32
107 and X86-64,
108 including the <a href="http://wiki.freebsd.org/BuildingFreeBSDWithClang">FreeBSD
109 kernel</a> and <a href="http://gcc.gnu.org/gcc-4.2/">gcc 4.2</a>.  C++ is also
110 making <a href="http://clang.llvm.org/cxx_status.html">incredible progress</a>,
111 and work on templates has recently started.  If you are
112 interested in fast compiles and good diagnostics, we encourage you to try it out
113 by <a href="http://clang.llvm.org/get_started.html">building from mainline</a>
114 and reporting any issues you hit to the <a
115 href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-dev">Clang front-end mailing
116 list</a>.</p>
117
118 <p>In the LLVM 2.6 time-frame, the Clang team has made many improvements:</p>
119
120 <ul>
121 <li>Something wonderful!</li>
122 <li>Many many bugs are fixed and many features have been added.</li>
123 </ul>
124 </div>
125
126 <!--=========================================================================-->
127 <div class="doc_subsection">
128 <a name="clangsa">Clang Static Analyzer</a>
129 </div>
130
131 <div class="doc_text">
132
133 <p>Previously announced in the 2.4 LLVM release, the Clang project also
134 includes an early stage static source code analysis tool for <a
135 href="http://clang.llvm.org/StaticAnalysis.html">automatically finding bugs</a>
136 in C and Objective-C programs. The tool performs a growing set of checks to find
137 bugs that occur on a specific path within a program.</p>
138
139 <p>In the LLVM 2.6 time-frame there have been many significant improvements to
140 XYZ.</p>
141
142 <p>The set of checks performed by the static analyzer continues to expand, and
143 future plans for the tool include full source-level inter-procedural analysis
144 and deeper checks such as buffer overrun detection. There are many opportunities
145 to extend and enhance the static analyzer, and anyone interested in working on
146 this project is encouraged to get involved!</p>
147
148 </div>
149
150 <!--=========================================================================-->
151 <div class="doc_subsection">
152 <a name="vmkit">VMKit: JVM/CLI Virtual Machine Implementation</a>
153 </div>
154
155 <div class="doc_text">
156 <p>
157 The <a href="http://vmkit.llvm.org/">VMKit project</a> is an implementation of
158 a JVM and a CLI Virtual Machines (Microsoft .NET is an
159 implementation of the CLI) using the Just-In-Time compiler of LLVM.</p>
160
161 <p>Following LLVM 2.6, VMKit has its XYZ release that you can find on its
162 <a href="http://vmkit.llvm.org/releases/">webpage</a>. The release includes
163 bug fixes, cleanup and new features. The major changes are:</p>
164
165 <ul>
166
167 <li>Something wonderful!</li>
168
169 </ul>
170 </div>
171
172 <!-- *********************************************************************** -->
173 <div class="doc_section">
174   <a name="externalproj">External Projects Using LLVM 2.6</a>
175 </div>
176 <!-- *********************************************************************** -->
177
178 <!--=========================================================================-->
179 <div class="doc_subsection">
180 <a name="pure">Pure</a>
181 </div>
182
183 <div class="doc_text">
184 <p>
185 <a href="http://pure-lang.googlecode.com/">Pure</a>
186 is an algebraic/functional programming language based on term rewriting.
187 Programs are collections of equations which are used to evaluate expressions in
188 a symbolic fashion. Pure offers dynamic typing, eager and lazy evaluation,
189 lexical closures, a hygienic macro system (also based on term rewriting),
190 built-in list and matrix support (including list and matrix comprehensions) and
191 an easy-to-use C interface. The interpreter uses LLVM as a backend to
192  JIT-compile Pure programs to fast native code.</p>
193
194 <p>In addition to the usual algebraic data structures, Pure also has
195 MATLAB-style matrices in order to support numeric computations and signal
196 processing in an efficient way. Pure is mainly aimed at mathematical
197 applications right now, but it has been designed as a general purpose language.
198 The dynamic interpreter environment and the C interface make it possible to use
199 it as a kind of functional scripting language for many application areas.
200 </p>
201 </div>
202
203
204 <!--=========================================================================-->
205 <div class="doc_subsection">
206 <a name="ldc">LLVM D Compiler</a>
207 </div>
208
209 <div class="doc_text">
210 <p>
211 <a href="http://www.dsource.org/projects/ldc">LDC</a> is an implementation of
212 the D Programming Language using the LLVM optimizer and code generator.
213 The LDC project works great with the LLVM 2.6 release.  General improvements in
214 this
215 cycle have included new inline asm constraint handling, better debug info
216 support, general bugfixes, and better x86-64 support.  This has allowed
217 some major improvements in LDC, getting us much closer to being as
218 fully featured as the original DMD compiler from DigitalMars.
219 </p>
220 </div>
221
222 <!--=========================================================================-->
223 <div class="doc_subsection">
224 <a name="RoadsendPHP">Roadsend PHP</a>
225 </div>
226
227 <div class="doc_text">
228 <p><a href="http://code.roadsend.com/rphp">Roadsend PHP</a> (rphp) is an open
229 source implementation of the PHP programming 
230 language that uses LLVM for its optimizer, JIT, and static compiler. This is a 
231 reimplementation of an earlier project that is now based on LLVM.</p>
232 </div>
233
234 <!--=========================================================================-->
235 <div class="doc_subsection">
236 <a name="Unladen Swallow">Unladen Swallow</a>
237 </div>
238
239 <div class="doc_text">
240 <p><a href="http://code.google.com/p/unladen-swallow/">Unladen Swallow</a> is a
241 branch of <a href="http://python.org/">Python</a> intended to be fully
242 compatible and significantly faster.  It uses LLVM's optimization passes and JIT
243 compiler.</p>
244 </div>
245
246 <!--=========================================================================-->
247 <div class="doc_subsection">
248 <a name="Rubinius">Rubinius</a>
249 </div>
250
251 <div class="doc_text">
252 <p><a href="http://github.com/evanphx/rubinius">Rubinius</a> is a new virtual
253 machine for Ruby. It leverages LLVM to dynamically compile Ruby code down to
254 machine code using LLVM's JIT.</p>
255 </div>
256
257
258 <!-- *********************************************************************** -->
259 <div class="doc_section">
260   <a name="whatsnew">What's New in LLVM 2.6?</a>
261 </div>
262 <!-- *********************************************************************** -->
263
264 <div class="doc_text">
265
266 <p>This release includes a huge number of bug fixes, performance tweaks, and
267 minor improvements.  Some of the major improvements and new features are listed
268 in this section.
269 </p>
270 </div>
271
272 <!--=========================================================================-->
273 <div class="doc_subsection">
274 <a name="majorfeatures">Major New Features</a>
275 </div>
276
277 <div class="doc_text">
278
279 <p>LLVM 2.6 includes several major new capabilities:</p>
280
281 <ul>
282 <li>Something wonderful!</li>
283 </ul>
284
285 </div>
286
287
288 <!--=========================================================================-->
289 <div class="doc_subsection">
290 <a name="llvm-gcc">llvm-gcc 4.2 Improvements</a>
291 </div>
292
293 <div class="doc_text">
294
295 <p>LLVM fully supports the llvm-gcc 4.2 front-end, which marries the GCC
296 front-ends and driver with the LLVM optimizer and code generator.  It currently
297 includes support for the C, C++, Objective-C, Ada, and Fortran front-ends.</p>
298
299 <ul>
300 <li>Something wonderful!</li>
301 </ul>
302
303 </div>
304
305
306 <!--=========================================================================-->
307 <div class="doc_subsection">
308 <a name="coreimprovements">LLVM IR and Core Improvements</a>
309 </div>
310
311 <div class="doc_text">
312 <p>LLVM IR has several new features that are used by our existing front-ends and
313 can be useful if you are writing a front-end for LLVM:</p>
314
315 <ul>
316 <li>Something wonderful!</li>
317 </ul>
318
319 </div>
320
321 <!--=========================================================================-->
322 <div class="doc_subsection">
323 <a name="optimizer">Optimizer Improvements</a>
324 </div>
325
326 <div class="doc_text">
327
328 <p>In addition to a large array of bug fixes and minor performance tweaks, this
329 release includes a few major enhancements and additions to the optimizers:</p>
330
331 <ul>
332
333 <li>Something wonderful!</li>
334
335 </ul>
336
337 </div>
338
339 <!--=========================================================================-->
340 <div class="doc_subsection">
341 <a name="codegen">Target Independent Code Generator Improvements</a>
342 </div>
343
344 <div class="doc_text">
345
346 <p>We have put a significant amount of work into the code generator
347 infrastructure, which allows us to implement more aggressive algorithms and make
348 it run faster:</p>
349
350 <ul>
351
352 <li>Something wonderful!</li>
353 </ul>
354 </div>
355
356 <!--=========================================================================-->
357 <div class="doc_subsection">
358 <a name="x86">X86-32 and X86-64 Target Improvements</a>
359 </div>
360
361 <div class="doc_text">
362 <p>New features of the X86 target include:
363 </p>
364
365 <ul>
366
367 <li>Something wonderful!</li>
368 </ul>
369
370 </div>
371
372 <!--=========================================================================-->
373 <div class="doc_subsection">
374 <a name="pic16">PIC16 Target Improvements</a>
375 </div>
376
377 <div class="doc_text">
378 <p>New features of the PIC16 target include:
379 </p>
380
381 <ul>
382 <li>Something wonderful!</li>
383 </ul>
384
385 <p>Things not yet supported:</p>
386
387 <ul>
388 <li>Floating point.</li>
389 <li>Passing/returning aggregate types to and from functions.</li>
390 <li>Variable arguments.</li>
391 <li>Indirect function calls.</li>
392 <li>Interrupts/programs.</li>
393 <li>Debug info.</li>
394 </ul>
395
396 </div>
397
398 <!--=========================================================================-->
399 <div class="doc_subsection">
400 <a name="ARM">ARM Target Improvements</a>
401 </div>
402
403 <div class="doc_text">
404 <p>New features of the ARM target include:
405 </p>
406
407 <ul>
408
409 <li>Preliminary support for processors, such as the Cortex-A8 and Cortex-A9,
410 that implement version v7-A of the ARM architecture.  The ARM backend now
411 supports both the Thumb2 and Advanced SIMD (Neon) instruction sets. The
412 AAPCS-VFP "hard float" calling conventions are also supported with the
413 <tt>-float-abi=hard</tt> flag. These features are still somewhat experimental
414 and subject to change. The Neon intrinsics, in particular, may change in future
415 releases of LLVM.
416 </li>
417 </ul>
418
419 </div>
420
421
422 <!--=========================================================================-->
423 <div class="doc_subsection">
424 <a name="llvmc">Improvements in LLVMC</a>
425 </div>
426
427 <div class="doc_text">
428 <p>New features include:</p>
429
430 <ul>
431 <li>Something wonderful!</li>
432 </ul>
433
434 </div>
435
436
437 <!--=========================================================================-->
438 <div class="doc_subsection">
439 <a name="changes">Major Changes and Removed Features</a>
440 </div>
441
442 <div class="doc_text">
443
444 <p>If you're already an LLVM user or developer with out-of-tree changes based
445 on LLVM 2.5, this section lists some "gotchas" that you may run into upgrading
446 from the previous release.</p>
447
448 <ul>
449
450 <li>Something horrible!</li>
451
452 </ul>
453
454
455 <p>In addition, many APIs have changed in this release.  Some of the major LLVM
456 API changes are:</p>
457
458 <ul>
459 <li>LLVM's global uniquing tables for <tt>Type</tt>s and <tt>Constant</tt>s have
460     been privatized into members of an <tt>LLVMContext</tt>.  A number of APIs
461     now take an <tt>LLVMContext</tt> as a parameter.  To smooth the transition
462     for clients that will only ever use a single context, the new 
463     <tt>getGlobalContext()</tt> API can be used to access a default global 
464     context which can be passed in any and all cases where a context is 
465     required.
466 <li>The <tt>getABITypeSize</tt> methods are now called <tt>getAllocSize</tt>.</li>
467 <li>The <tt>Add</tt>, <tt>Sub</tt>, and <tt>Mul</tt> operators are no longer
468     overloaded for floating-point types. Floating-point addition, subtraction,
469     and multiplication are now represented with new operators <tt>FAdd</tt>,
470     <tt>FSub</tt>, and <tt>FMul</tt>. In the <tt>IRBuilder</tt> API,
471     <tt>CreateAdd</tt>, <tt>CreateSub</tt>, <tt>CreateMul</tt>, and
472     <tt>CreateNeg</tt> should only be used for integer arithmetic now;
473     <tt>CreateFAdd</tt>, <tt>CreateFSub</tt>, <tt>CreateFMul</tt>, and
474     <tt>CreateFNeg</tt> should now be used for floating-point arithmetic.</li>
475 <li>The DynamicLibrary class can no longer be constructed, its functionality has
476     moved to static member functions.</li>
477 <li><tt>raw_fd_ostream</tt>'s constructor for opening a given filename now
478     takes an extra <tt>Force</tt> argument. If <tt>Force</tt> is set to
479     <tt>false</tt>, an error will be reported if a file with the given name
480     already exists. If <tt>Force</tt> is set to <tt>true</tt>, the file will
481     be silently truncated (which is the behavior before this flag was
482     added).</li>
483 <li><tt>SCEVHandle</tt> no longer exists, because reference counting is no
484 longer done for <tt>SCEV*</tt> objects, instead <tt>const SCEV*</tt> should be
485 used.</li>
486
487 <li>Many APIs, notably <tt>llvm::Value</tt>, now use the <tt>StringRef</tt>
488 and <tt>Twine</tt> classes instead of passing <tt>const char*</tt>
489 or <tt>std::string</tt>, as described in
490 the <a href="ProgrammersManual.html#string_apis">Programmer's Manual</a>. Most
491 clients should be unaffected by this transition, unless they are used to <tt>Value::getName()</tt> returning a string. Here are some tips on updating to 2.6:
492   <ul>
493     <li><tt>getNameStr()</tt> is still available, and matches the old
494       behavior. Replacing <tt>getName()</tt> calls with this is an safe option,
495       although more efficient alternatives are now possible.</li>
496
497     <li>If you were just relying on <tt>getName()</tt> being able to be sent to
498       a <tt>std::ostream</tt>, consider migrating
499       to <tt>llvm::raw_ostream</tt>.</li>
500       
501     <li>If you were using <tt>getName().c_str()</tt> to get a <tt>const
502         char*</tt> pointer to the name, you can use <tt>getName().data()</tt>.
503         Note that this string (as before), may not be the entire name if the
504         name containts embedded null characters.</li>
505
506     <li>If you were using operator plus on the result of <tt>getName()</tt> and
507       treating the result as an <tt>std::string</tt>, you can either
508       uses <tt>Twine::str</tt> to get the result as an <tt>std::string</tt>, or
509       could move to a <tt>Twine</tt> based design.</li>
510
511     <li><tt>isName()</tt> should be replaced with comparison
512       against <tt>getName()</tt> (this is now efficient).
513   </ul>
514 </li>
515
516 <li>The registration interfaces for backend Targets has changed (what was
517 previously TargetMachineRegistry). For backend authors, see the <a href="WritingAnLLVMBackend.html#TargetRegistration">Writing An LLVM Backend</a> guide. For clients, the notable API changes are:
518   <ul>
519     <li><tt>TargetMachineRegistry</tt> has been renamed
520       to <tt>TargetRegistry</tt>.</li>
521
522     <li>Clients should move to using the <tt>TargetRegistry::lookupTarget()</tt>
523       function to find targets.</li>
524   </ul>
525 </li>
526
527 <li>llvm-dis now fails if output file exists, instead of dumping to stdout.
528 FIXME: describe any other tool changes due to the raw_fd_ostream change.  FIXME:
529 This is not an API change, maybe there should be a tool changes section?</li>
530 <li>temporarely due to Context API change passes should call doInitialization()
531 method of the pass they inherit from, otherwise Context is NULL.
532 FIXME: remove this entry when this is no longer needed.<li>
533 </ul>
534
535 </div>
536
537
538
539 <!-- *********************************************************************** -->
540 <div class="doc_section">
541   <a name="portability">Portability and Supported Platforms</a>
542 </div>
543 <!-- *********************************************************************** -->
544
545 <div class="doc_text">
546
547 <p>LLVM is known to work on the following platforms:</p>
548
549 <ul>
550 <li>Intel and AMD machines (IA32, X86-64, AMD64, EMT-64) running Red Hat
551 Linux, Fedora Core, FreeBSD and AuroraUX (and probably other unix-like systems).</li>
552 <li>PowerPC and X86-based Mac OS X systems, running 10.3 and above in 32-bit
553 and 64-bit modes.</li>
554 <li>Intel and AMD machines running on Win32 using MinGW libraries (native).</li>
555 <li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
556     support is available for native builds with Visual C++).</li>
557 <li>Sun UltraSPARC workstations running Solaris 10.</li>
558 <li>Alpha-based machines running Debian GNU/Linux.</li>
559 </ul>
560
561 <p>The core LLVM infrastructure uses GNU autoconf to adapt itself
562 to the machine and operating system on which it is built.  However, minor
563 porting may be required to get LLVM to work on new platforms.  We welcome your
564 portability patches and reports of successful builds or error messages.</p>
565
566 </div>
567
568 <!-- *********************************************************************** -->
569 <div class="doc_section">
570   <a name="knownproblems">Known Problems</a>
571 </div>
572 <!-- *********************************************************************** -->
573
574 <div class="doc_text">
575
576 <p>This section contains significant known problems with the LLVM system,
577 listed by component.  If you run into a problem, please check the <a
578 href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
579 there isn't already one.</p>
580
581 <ul>
582 <li>LLVM will not correctly compile on Solaris and/or OpenSolaris
583 using the stock GCC 3.x.x series 'out the box',
584 See: <a href="#brokengcc">Broken versions of GCC and other tools</a>.
585 However, A <a href="http://pkg.auroraux.org/GCC">Modern GCC Build</a>
586 for x86/x64 has been made available from the third party AuroraUX Project
587 that has been meticulously tested for bootstrapping LLVM & Clang.</li>
588 </ul>
589
590 </div>
591
592 <!-- ======================================================================= -->
593 <div class="doc_subsection">
594   <a name="experimental">Experimental features included with this release</a>
595 </div>
596
597 <div class="doc_text">
598
599 <p>The following components of this LLVM release are either untested, known to
600 be broken or unreliable, or are in early development.  These components should
601 not be relied on, and bugs should not be filed against them, but they may be
602 useful to some people.  In particular, if you would like to work on one of these
603 components, please contact us on the <a
604 href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p>
605
606 <ul>
607 <li>The MSIL, Alpha, SPU, MIPS, and PIC16 backends are experimental.</li>
608 <li>The <tt>llc</tt> "<tt>-filetype=asm</tt>" (the default) is the only
609     supported value for this option.</li>
610 </ul>
611
612 </div>
613
614 <!-- ======================================================================= -->
615 <div class="doc_subsection">
616   <a name="x86-be">Known problems with the X86 back-end</a>
617 </div>
618
619 <div class="doc_text">
620
621 <ul>
622   <li>The X86 backend does not yet support
623     all <a href="http://llvm.org/PR879">inline assembly that uses the X86
624     floating point stack</a>.  It supports the 'f' and 't' constraints, but not
625     'u'.</li>
626   <li>The X86 backend generates inefficient floating point code when configured
627     to generate code for systems that don't have SSE2.</li>
628   <li>Win64 code generation wasn't widely tested. Everything should work, but we
629     expect small issues to happen. Also, llvm-gcc cannot build the mingw64
630     runtime currently due
631     to <a href="http://llvm.org/PR2255">several</a>
632     <a href="http://llvm.org/PR2257">bugs</a> and due to lack of support for
633     the
634     'u' inline assembly constraint and for X87 floating point inline assembly.</li>
635   <li>The X86-64 backend does not yet support the LLVM IR instruction
636       <tt>va_arg</tt>. Currently, the llvm-gcc and front-ends support variadic
637       argument constructs on X86-64 by lowering them manually.</li>
638 </ul>
639
640 </div>
641
642 <!-- ======================================================================= -->
643 <div class="doc_subsection">
644   <a name="ppc-be">Known problems with the PowerPC back-end</a>
645 </div>
646
647 <div class="doc_text">
648
649 <ul>
650 <li>The Linux PPC32/ABI support needs testing for the interpreter and static
651 compilation, and lacks support for debug information.</li>
652 </ul>
653
654 </div>
655
656 <!-- ======================================================================= -->
657 <div class="doc_subsection">
658   <a name="arm-be">Known problems with the ARM back-end</a>
659 </div>
660
661 <div class="doc_text">
662
663 <ul>
664 <li>Support for the Advanced SIMD (Neon) instruction set is still incomplete
665 and not well tested.  Some features may not work at all, and the code quality
666 may be poor in some cases.</li>
667 <li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
668 processors, thumb programs can crash or produce wrong
669 results (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
670 <li>Compilation for ARM Linux OABI (old ABI) is supported but not fully tested.
671 </li>
672 <li>There is a bug in QEMU-ARM (&lt;= 0.9.0) which causes it to incorrectly
673  execute
674 programs compiled with LLVM.  Please use more recent versions of QEMU.</li>
675 </ul>
676
677 </div>
678
679 <!-- ======================================================================= -->
680 <div class="doc_subsection">
681   <a name="sparc-be">Known problems with the SPARC back-end</a>
682 </div>
683
684 <div class="doc_text">
685
686 <ul>
687 <li>The SPARC backend only supports the 32-bit SPARC ABI (-m32); it does not
688     support the 64-bit SPARC ABI (-m64).</li>
689 </ul>
690
691 </div>
692
693 <!-- ======================================================================= -->
694 <div class="doc_subsection">
695   <a name="mips-be">Known problems with the MIPS back-end</a>
696 </div>
697
698 <div class="doc_text">
699
700 <ul>
701 <li>The O32 ABI is not fully supported.</li>
702 <li>64-bit MIPS targets are not supported yet.</li>
703 </ul>
704
705 </div>
706
707 <!-- ======================================================================= -->
708 <div class="doc_subsection">
709   <a name="alpha-be">Known problems with the Alpha back-end</a>
710 </div>
711
712 <div class="doc_text">
713
714 <ul>
715
716 <li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
717 appropriate nops inserted to ensure restartability.</li>
718
719 </ul>
720 </div>
721
722 <!-- ======================================================================= -->
723 <div class="doc_subsection">
724   <a name="c-be">Known problems with the C back-end</a>
725 </div>
726
727 <div class="doc_text">
728
729 <ul>
730 <li><a href="http://llvm.org/PR802">The C backend has only basic support for
731     inline assembly code</a>.</li>
732 <li><a href="http://llvm.org/PR1658">The C backend violates the ABI of common
733     C++ programs</a>, preventing intermixing between C++ compiled by the CBE and
734     C++ code compiled with <tt>llc</tt> or native compilers.</li>
735 <li>The C backend does not support all exception handling constructs.</li>
736 <li>The C backend does not support arbitrary precision integers.</li>
737 </ul>
738
739 </div>
740
741
742 <!-- ======================================================================= -->
743 <div class="doc_subsection">
744   <a name="c-fe">Known problems with the llvm-gcc C front-end</a>
745 </div>
746
747 <div class="doc_text">
748
749 <p>llvm-gcc does not currently support <a href="http://llvm.org/PR869">Link-Time
750 Optimization</a> on most platforms "out-of-the-box".  Please inquire on the
751 LLVMdev mailing list if you are interested.</p>
752
753 <p>The only major language feature of GCC not supported by llvm-gcc is
754     the <tt>__builtin_apply</tt> family of builtins.   However, some extensions
755     are only supported on some targets.  For example, trampolines are only
756     supported on some targets (these are used when you take the address of a
757     nested function).</p>
758
759 <p>If you run into GCC extensions which are not supported, please let us know.
760 </p>
761
762 </div>
763
764 <!-- ======================================================================= -->
765 <div class="doc_subsection">
766   <a name="c++-fe">Known problems with the llvm-gcc C++ front-end</a>
767 </div>
768
769 <div class="doc_text">
770
771 <p>The C++ front-end is considered to be fully
772 tested and works for a number of non-trivial programs, including LLVM
773 itself, Qt, Mozilla, etc.</p>
774
775 <ul>
776 <li>Exception handling works well on the X86 and PowerPC targets. Currently
777   only Linux and Darwin targets are supported (both 32 and 64 bit).</li>
778 </ul>
779
780 </div>
781
782 <!-- ======================================================================= -->
783 <div class="doc_subsection">
784   <a name="fortran-fe">Known problems with the llvm-gcc Fortran front-end</a>
785 </div>
786
787 <div class="doc_text">
788 <ul>
789 <li>Fortran support generally works, but there are still several unresolved bugs
790     in Bugzilla.  Please see the tools/gfortran component for details.</li>
791 </ul>
792 </div>
793
794 <!-- ======================================================================= -->
795 <div class="doc_subsection">
796   <a name="ada-fe">Known problems with the llvm-gcc Ada front-end</a>
797 </div>
798
799 <div class="doc_text">
800 The llvm-gcc 4.2 Ada compiler works fairly well; however, this is not a mature
801 technology, and problems should be expected.
802 <ul>
803 <li>The Ada front-end currently only builds on X86-32.  This is mainly due
804 to lack of trampoline support (pointers to nested functions) on other platforms.
805 However, it <a href="http://llvm.org/PR2006">also fails to build on X86-64</a>
806 which does support trampolines.</li>
807 <li>The Ada front-end <a href="http://llvm.org/PR2007">fails to bootstrap</a>.
808 This is due to lack of LLVM support for <tt>setjmp</tt>/<tt>longjmp</tt> style
809 exception handling, which is used internally by the compiler.
810 Workaround: configure with --disable-bootstrap.</li>
811 <li>The c380004, <a href="http://llvm.org/PR2010">c393010</a>
812 and <a href="http://llvm.org/PR2421">cxg2021</a> ACATS tests fail
813 (c380004 also fails with gcc-4.2 mainline).
814 If the compiler is built with checks disabled then <a href="http://llvm.org/PR2010">c393010</a>
815 causes the compiler to go into an infinite loop, using up all system memory.</li>
816 <li>Some GCC specific Ada tests continue to crash the compiler.</li>
817 <li>The -E binder option (exception backtraces)
818 <a href="http://llvm.org/PR1982">does not work</a> and will result in programs
819 crashing if an exception is raised.  Workaround: do not use -E.</li>
820 <li>Only discrete types <a href="http://llvm.org/PR1981">are allowed to start
821 or finish at a non-byte offset</a> in a record.  Workaround: do not pack records
822 or use representation clauses that result in a field of a non-discrete type
823 starting or finishing in the middle of a byte.</li>
824 <li>The <tt>lli</tt> interpreter <a href="http://llvm.org/PR2009">considers
825 'main' as generated by the Ada binder to be invalid</a>.
826 Workaround: hand edit the file to use pointers for <tt>argv</tt> and
827 <tt>envp</tt> rather than integers.</li>
828 <li>The <tt>-fstack-check</tt> option <a href="http://llvm.org/PR2008">is
829 ignored</a>.</li>
830 </ul>
831 </div>
832
833 <!-- *********************************************************************** -->
834 <div class="doc_section">
835   <a name="additionalinfo">Additional Information</a>
836 </div>
837 <!-- *********************************************************************** -->
838
839 <div class="doc_text">
840
841 <p>A wide variety of additional information is available on the <a
842 href="http://llvm.org">LLVM web page</a>, in particular in the <a
843 href="http://llvm.org/docs/">documentation</a> section.  The web page also
844 contains versions of the API documentation which is up-to-date with the
845 Subversion version of the source code.
846 You can access versions of these documents specific to this release by going
847 into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
848
849 <p>If you have any questions or comments about LLVM, please feel free to contact
850 us via the <a href="http://llvm.org/docs/#maillist"> mailing
851 lists</a>.</p>
852
853 </div>
854
855 <!-- *********************************************************************** -->
856
857 <hr>
858 <address>
859   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
860   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
861   <a href="http://validator.w3.org/check/referer"><img
862   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
863
864   <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
865   Last modified: $Date$
866 </address>
867
868 </body>
869 </html>