random notes
[oota-llvm.git] / docs / ReleaseNotes.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2                       "http://www.w3.org/TR/html4/strict.dtd">
3 <html>
4 <head>
5   <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
6   <link rel="stylesheet" href="llvm.css" type="text/css">
7   <title>LLVM 2.5 Release Notes</title>
8 </head>
9 <body>
10
11 <div class="doc_title">LLVM 2.5 Release Notes</div>
12
13 <ol>
14   <li><a href="#intro">Introduction</a></li>
15   <li><a href="#subproj">Sub-project Status Update</a></li>
16   <li><a href="#whatsnew">What's New in LLVM?</a></li>
17   <li><a href="GettingStarted.html">Installation Instructions</a></li>
18   <li><a href="#portability">Portability and Supported Platforms</a></li>
19   <li><a href="#knownproblems">Known Problems</a></li>
20   <li><a href="#additionalinfo">Additional Information</a></li>
21 </ol>
22
23 <div class="doc_author">
24   <p>Written by the <a href="http://llvm.org">LLVM Team</a></p>
25 </div>
26
27 <!-- *********************************************************************** -->
28 <div class="doc_section">
29   <a name="intro">Introduction</a>
30 </div>
31 <!-- *********************************************************************** -->
32
33 <div class="doc_text">
34
35 <p>This document contains the release notes for the LLVM Compiler
36 Infrastructure, release 2.5.  Here we describe the status of LLVM, including
37 major improvements from the previous release and significant known problems.
38 All LLVM releases may be downloaded from the <a 
39 href="http://llvm.org/releases/">LLVM releases web site</a>.</p>
40
41 <p>For more information about LLVM, including information about the latest
42 release, please check out the <a href="http://llvm.org/">main LLVM
43 web site</a>.  If you have questions or comments, the <a
44 href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM Developer's Mailing
45 List</a> is a good place to send them.</p>
46
47 <p>Note that if you are reading this file from a Subversion checkout or the
48 main LLVM web page, this document applies to the <i>next</i> release, not the
49 current one.  To see the release notes for a specific release, please see the
50 <a href="http://llvm.org/releases/">releases page</a>.</p>
51
52 </div>
53
54 <!-- Unfinished features in 2.5:
55   Machine LICM
56   Machine Sinking
57   target-specific intrinsics
58   gold lto plugin
59   pre-alloc splitter
60   llc -enable-value-prop, propagation of value info (sign/zero ext info) from
61        one MBB to another
62   debug info for optimized code
63  -->
64
65  <!-- for announcement email:
66    -->
67
68 <!-- *********************************************************************** -->
69 <div class="doc_section">
70   <a name="subproj">Sub-project Status Update</a>
71 </div>
72 <!-- *********************************************************************** -->
73
74 <div class="doc_text">
75 <p>
76 The LLVM 2.5 distribution currently consists of code from the core LLVM
77 repository (which roughly includes the LLVM optimizers, code generators and
78 supporting tools) and the llvm-gcc repository.  In addition to this code, the
79 LLVM Project includes other sub-projects that are in development.  The two which
80 are the most actively developed are the <a href="#clang">Clang Project</a> and
81 the <a href="#vmkit">VMKit Project</a>.
82 </p>
83
84 </div>
85
86
87 <!--=========================================================================-->
88 <div class="doc_subsection">
89 <a name="clang">Clang: C/C++/Objective-C Frontend Toolkit</a>
90 </div>
91
92 <div class="doc_text">
93
94 <p>The <a href="http://clang.llvm.org/">Clang project</a> is an effort to build
95 a set of new 'LLVM native' front-end technologies for the LLVM optimizer
96 and code generator.  While Clang is not included in the LLVM 2.5 release, it 
97 is continuing to make major strides forward in all areas.  Its C and Objective-C
98 parsing and code generation support is now very solid.  For example, it is
99 capable of successfully building many real applications for X86-32 and X86-64,
100 including the FreeBSD kernel.  C++ is also making <a
101 href="http://clang.llvm.org/cxx_status.html">incredible progress</a>, and work
102 on templates has recently started.</p>
103
104 <p>While Clang is not yet production quality, it is progressing very nicely and
105 is quite usable for building many C and Objective-C applications.  If you are
106 interested in fast compiles and good diagnostics, we encourage you to try it out
107 by <a href="http://clang.llvm.org/get_started.html">building from mainline</a>
108 and reporting any issues you hit to the <a 
109 href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-dev">Clang front-end mailing
110 list</a>.</p>
111
112 <p>In the LLVM 2.5 time-frame, the Clang team has made many improvements:</p>
113
114 <ul>
115 <li>Clang now has a new driver, which is focused on providing a GCC-compatible
116     interface.</li> 
117 <li>The X86-64 ABI is now supported.</li> 
118 <li>Precompiled header support is now implemented.</li> 
119 <li>Objective-C support is significantly improved beyond LLVM 2.4, supporting
120     many features, such as Objective-C Garbage Collection.</li>
121 <li>Many many bugs are fixed.</li>
122 </div>
123
124 <!--=========================================================================-->
125 <div class="doc_subsection">
126 <a name="clangsa">Clang Static Analyzer</a>
127 </div>
128
129 <div class="doc_text">
130
131 <p>The Clang project also includes an early stage static source code analysis
132 tool for <a href="http://clang.llvm.org/StaticAnalysis.html">automatically
133 finding bugs</a> in C and Objective-C programs. The tool performs a growing set
134 of checks to find bugs that occur on a specific path within a program.  Examples
135 of bugs the tool finds include logic errors such as null dereferences,
136 violations of various API rules, dead code, and potential memory leaks in
137 Objective-C programs. Since its inception, public feedback on the tool has been
138 extremely positive, and conservative estimates put the number of real bugs it
139 has found in industrial-quality software on the order of thousands.</p>
140
141 <p>The tool also provides a simple web GUI to inspect potential bugs found by
142 the tool.  While still early in development, the GUI illustrates some of the key
143 features of Clang: accurate source location information, which is used by the
144 GUI to highlight specific code expressions that relate to a bug (including those
145 that span multiple lines); and built-in knowledge of macros, which is used to
146 perform inline expansion of macros within the GUI itself.</p>
147
148 <p>The set of checks performed by the static analyzer is gradually expanding,
149 and future plans for the tool include full source-level inter-procedural
150 analysis and deeper checks such as buffer overrun detection. There are many
151 opportunities to extend and enhance the static analyzer, and anyone interested
152 in working on this project is encouraged to get involved!</p>
153
154 </div>
155
156 <!--=========================================================================-->
157 <div class="doc_subsection">
158 <a name="vmkit">VMKit: JVM/CLI Virtual Machine Implementation</a>
159 </div>
160
161 <div class="doc_text">
162 <p>
163 The <a href="http://vmkit.llvm.org/">VMKit project</a> is an implementation of
164 a JVM and a CLI Virtual Machines (Microsoft .NET is an
165 implementation of the CLI) using the Just-In-Time compiler of LLVM.</p>
166
167 <p>Following LLVM 2.5, VMKit has its first release ? that you can find on its
168 <a href="http://vmkit.llvm.org/releases/">webpage</a>. The release includes
169 bug fixes, cleanup and new features. The major changes are:</p>
170
171 <ul>
172
173 <li>?</li>
174
175 </ul>
176 </div>
177
178
179 <!-- *********************************************************************** -->
180 <div class="doc_section">
181   <a name="whatsnew">What's New in LLVM?</a>
182 </div>
183 <!-- *********************************************************************** -->
184
185 <div class="doc_text">
186
187 <p>This release includes a huge number of bug fixes, performance tweaks, and
188 minor improvements.  Some of the major improvements and new features are listed
189 in this section.
190 </p>
191 </div>
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.5 includes several major new capabilities:</p>
201
202 <ul>
203 <li><p> Legalize Types</p></li>
204
205 <!--
206 Random stuff:
207
208 .ll parser rewrite.
209 GCC inliner off.
210 cmake mature?
211 x86 backend FS/GS segment address spaces?
212 nocapture
213 memdep is faster / more aggressive.
214 how to write a backend doc
215 fastisel + exception handling
216 vector widening <3 x float> -> <4 x float>
217 -->
218
219 </ul>
220
221 </div>
222
223
224 <!--=========================================================================-->
225 <div class="doc_subsection">
226 <a name="llvm-gcc">llvm-gcc 4.2 Improvements</a>
227 </div>
228
229 <div class="doc_text">
230
231 <p>LLVM fully supports the llvm-gcc 4.2 front-end, which marries the GCC
232 front-ends and driver with the LLVM optimizer and code generator.  It currently
233 includes support for the C, C++, Objective-C, Ada, and Fortran front-ends.</p>
234
235 <ul>
236 <li>?</li>
237 </ul>
238
239 </div>
240
241
242 <!--=========================================================================-->
243 <div class="doc_subsection">
244 <a name="coreimprovements">LLVM Core Improvements</a>
245 </div>
246
247 <div class="doc_text">
248 <p>New features include:</p>
249
250 <ul>
251 <li>?</li>
252     
253 </ul>
254
255 </div>
256
257 <!--=========================================================================-->
258 <div class="doc_subsection">
259 <a name="optimizer">Optimizer Improvements</a>
260 </div>
261
262 <div class="doc_text">
263
264 <p>In addition to a huge array of bug fixes and minor performance tweaks, this
265 release includes a few major enhancements and additions to the optimizers:</p>
266
267 <ul>
268
269 <li>?</li>
270
271 </ul>
272
273 </div>
274
275 <!--=========================================================================-->
276 <div class="doc_subsection">
277 <a name="codegen">Code Generator Improvements</a>
278 </div>
279
280 <div class="doc_text">
281
282 <p>We have put a significant amount of work into the code generator infrastructure,
283 which allows us to implement more aggressive algorithms and make it run
284 faster:</p>
285
286 <ul>
287 <li>?</li>
288
289 </ul>
290
291 </div>
292
293
294 <!--=========================================================================-->
295 <div class="doc_subsection">
296 <a name="targetspecific">Target Specific Improvements</a>
297 </div>
298
299 <div class="doc_text">
300 <p>New target-specific features include:
301 </p>
302
303 <ul>
304 <li>?</li>
305 </ul>
306
307 </div>
308
309
310 <!--=========================================================================-->
311 <div class="doc_subsection">
312 <a name="otherimprovements">Other Improvements</a>
313 </div>
314
315 <div class="doc_text">
316 <p>New features include:
317 </p>
318
319 <ul>
320 <li>?</li>
321
322 </ul>
323
324 </div>
325
326 <!--=========================================================================-->
327 <div class="doc_subsection">
328 <a name="changes">Major Changes and Removed Features</a>
329 </div>
330
331 <div class="doc_text">
332
333 <p>If you're already an LLVM user or developer with out-of-tree changes based
334 on LLVM 2.4, this section lists some "gotchas" that you may run into upgrading
335 from the previous release.</p>
336
337 <ul>
338
339 <li>?</li>
340 </ul>
341
342
343 <p>In addition, many APIs have changed in this release.  Some of the major LLVM
344 API changes are:</p>
345
346 <ul>
347 <li>?</li>
348 </ul>
349
350 <li>?</li>
351 </ul>
352
353 </div>
354
355
356
357 <!-- *********************************************************************** -->
358 <div class="doc_section">
359   <a name="portability">Portability and Supported Platforms</a>
360 </div>
361 <!-- *********************************************************************** -->
362
363 <div class="doc_text">
364
365 <p>LLVM is known to work on the following platforms:</p>
366
367 <ul>
368 <li>Intel and AMD machines (IA32, X86-64, AMD64, EMT-64) running Red Hat 
369 Linux, Fedora Core and FreeBSD (and probably other unix-like systems).</li>
370 <li>PowerPC and X86-based Mac OS X systems, running 10.3 and above in 32-bit 
371 and 64-bit modes.</li>
372 <li>Intel and AMD machines running on Win32 using MinGW libraries (native).</li>
373 <li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
374     support is available for native builds with Visual C++).</li>
375 <li>Sun UltraSPARC workstations running Solaris 10.</li>
376 <li>Alpha-based machines running Debian GNU/Linux.</li>
377 <li>Itanium-based (IA64) machines running Linux and HP-UX.</li>
378 </ul>
379
380 <p>The core LLVM infrastructure uses GNU autoconf to adapt itself
381 to the machine and operating system on which it is built.  However, minor
382 porting may be required to get LLVM to work on new platforms.  We welcome your
383 portability patches and reports of successful builds or error messages.</p>
384
385 </div>
386
387 <!-- *********************************************************************** -->
388 <div class="doc_section">
389   <a name="knownproblems">Known Problems</a>
390 </div>
391 <!-- *********************************************************************** -->
392
393 <div class="doc_text">
394
395 <p>This section contains significant known problems with the LLVM system, 
396 listed by component.  If you run into a problem, please check the <a
397 href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
398 there isn't already one.</p>
399
400 </div>
401
402 <!-- ======================================================================= -->
403 <div class="doc_subsection">
404   <a name="experimental">Experimental features included with this release</a>
405 </div>
406
407 <div class="doc_text">
408
409 <p>The following components of this LLVM release are either untested, known to
410 be broken or unreliable, or are in early development.  These components should
411 not be relied on, and bugs should not be filed against them, but they may be
412 useful to some people.  In particular, if you would like to work on one of these
413 components, please contact us on the <a
414 href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p>
415
416 <ul>
417 <li>The MSIL, IA64, Alpha, SPU, MIPS, and PIC16 backends are experimental.</li>
418 <li>The llc "<tt>-filetype=asm</tt>" (the default) is the only supported
419     value for this option.</li>
420 </ul>
421
422 </div>
423
424 <!-- ======================================================================= -->
425 <div class="doc_subsection">
426   <a name="x86-be">Known problems with the X86 back-end</a>
427 </div>
428
429 <div class="doc_text">
430
431 <ul>
432   <li>The X86 backend does not yet support
433     all <a href="http://llvm.org/PR879">inline assembly that uses the X86
434     floating point stack</a>.  It supports the 'f' and 't' constraints, but not
435     'u'.</li>
436   <li>The X86 backend generates inefficient floating point code when configured
437     to generate code for systems that don't have SSE2.</li>
438   <li>Win64 code generation wasn't widely tested. Everything should work, but we
439     expect small issues to happen. Also, llvm-gcc cannot build mingw64 runtime
440     currently due
441     to <a href="http://llvm.org/PR2255">several</a>
442     <a href="http://llvm.org/PR2257">bugs</a> due to lack of support for the
443     'u' inline assembly constraint and X87 floating point inline assembly.</li>
444   <li>The X86-64 backend does not yet support the LLVM IR instruction
445       <tt>va_arg</tt>. Currently, the llvm-gcc front-end supports variadic
446       argument constructs on X86-64 by lowering them manually.</li>
447 </ul>
448
449 </div>
450
451 <!-- ======================================================================= -->
452 <div class="doc_subsection">
453   <a name="ppc-be">Known problems with the PowerPC back-end</a>
454 </div>
455
456 <div class="doc_text">
457
458 <ul>
459 <li>The Linux PPC32/ABI support needs testing for the interpreter and static
460 compilation, and lacks support for debug information.</li>
461 </ul>
462
463 </div>
464
465 <!-- ======================================================================= -->
466 <div class="doc_subsection">
467   <a name="arm-be">Known problems with the ARM back-end</a>
468 </div>
469
470 <div class="doc_text">
471
472 <ul>
473 <li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
474 processors, thumb programs can crash or produce wrong
475 results (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
476 <li>Compilation for ARM Linux OABI (old ABI) is supported, but not fully tested.
477 </li>
478 <li>There is a bug in QEMU-ARM (&lt;= 0.9.0) which causes it to incorrectly
479  execute
480 programs compiled with LLVM.  Please use more recent versions of QEMU.</li>
481 </ul>
482
483 </div>
484
485 <!-- ======================================================================= -->
486 <div class="doc_subsection">
487   <a name="sparc-be">Known problems with the SPARC back-end</a>
488 </div>
489
490 <div class="doc_text">
491
492 <ul>
493 <li>The SPARC backend only supports the 32-bit SPARC ABI (-m32), it does not
494     support the 64-bit SPARC ABI (-m64).</li>
495 </ul>
496
497 </div>
498
499 <!-- ======================================================================= -->
500 <div class="doc_subsection">
501   <a name="mips-be">Known problems with the MIPS back-end</a>
502 </div>
503
504 <div class="doc_text">
505
506 <ul>
507 <li>The O32 ABI is not fully supported.</li>
508 <li>64-bit MIPS targets are not supported yet.</li>
509 </ul>
510
511 </div>
512
513 <!-- ======================================================================= -->
514 <div class="doc_subsection">
515   <a name="alpha-be">Known problems with the Alpha back-end</a>
516 </div>
517
518 <div class="doc_text">
519
520 <ul>
521
522 <li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
523 appropriate nops inserted to ensure restartability.</li>
524
525 </ul>
526 </div>
527
528 <!-- ======================================================================= -->
529 <div class="doc_subsection">
530   <a name="ia64-be">Known problems with the IA64 back-end</a>
531 </div>
532
533 <div class="doc_text">
534
535 <ul>
536 <li>The Itanium backend is highly experimental, and has a number of known
537     issues.  We are looking for a maintainer for the Itanium backend.  If you
538     are interested, please contact the LLVMdev mailing list.</li>
539 </ul>
540
541 </div>
542
543 <!-- ======================================================================= -->
544 <div class="doc_subsection">
545   <a name="c-be">Known problems with the C back-end</a>
546 </div>
547
548 <div class="doc_text">
549
550 <ul>
551 <li><a href="http://llvm.org/PR802">The C backend has only basic support for
552     inline assembly code</a>.</li>
553 <li><a href="http://llvm.org/PR1658">The C backend violates the ABI of common
554     C++ programs</a>, preventing intermixing between C++ compiled by the CBE and
555     C++ code compiled with llc or native compilers.</li>
556 <li>The C backend does not support all exception handling constructs.</li>
557 </ul>
558
559 </div>
560
561
562 <!-- ======================================================================= -->
563 <div class="doc_subsection">
564   <a name="c-fe">Known problems with the llvm-gcc C front-end</a>
565 </div>
566
567 <div class="doc_text">
568
569 <p>llvm-gcc does not currently support <a href="http://llvm.org/PR869">Link-Time
570 Optimization</a> on most platforms "out-of-the-box".  Please inquire on the
571 LLVMdev mailing list if you are interested.</p>
572
573 <p>The only major language feature of GCC not supported by llvm-gcc is
574     the <tt>__builtin_apply</tt> family of builtins.   However, some extensions
575     are only supported on some targets.  For example, trampolines are only
576     supported on some targets (these are used when you take the address of a
577     nested function).</p>
578
579 <p>If you run into GCC extensions which are not supported, please let us know.
580 </p>
581
582 </div>
583
584 <!-- ======================================================================= -->
585 <div class="doc_subsection">
586   <a name="c++-fe">Known problems with the llvm-gcc C++ front-end</a>
587 </div>
588
589 <div class="doc_text">
590
591 <p>The C++ front-end is considered to be fully
592 tested and works for a number of non-trivial programs, including LLVM
593 itself, Qt, Mozilla, etc.</p>
594
595 <ul>
596 <li>Exception handling works well on the X86 and PowerPC targets. Currently
597   only Linux and Darwin targets are supported (both 32 and 64 bit).</li>
598 </ul>
599
600 </div>
601
602 <!-- ======================================================================= -->
603 <div class="doc_subsection">
604   <a name="fortran-fe">Known problems with the llvm-gcc Fortran front-end</a>
605 </div>
606
607 <div class="doc_text">
608 <ul>
609 <li>Fortran support generally works, but there are still several unresolved bugs
610     in Bugzilla.  Please see the tools/gfortran component for details.</li>
611     
612 <li>The Fortran front-end currently does not build on Darwin (without tweaks)
613     due to unresolved dependencies on the C front-end.</li>
614 </ul>
615 </div>
616
617 <!-- ======================================================================= -->
618 <div class="doc_subsection">
619   <a name="ada-fe">Known problems with the llvm-gcc Ada front-end</a>
620 </div>
621
622 <div class="doc_text">
623 The llvm-gcc 4.2 Ada compiler works fairly well, however this is not a mature
624 technology and problems should be expected.
625 <ul>
626 <li>The Ada front-end currently only builds on X86-32.  This is mainly due
627 to lack of trampoline support (pointers to nested functions) on other platforms,
628 however it <a href="http://llvm.org/PR2006">also fails to build on X86-64</a>
629 which does support trampolines.</li>
630 <li>The Ada front-end <a href="http://llvm.org/PR2007">fails to bootstrap</a>.
631 Workaround: configure with --disable-bootstrap.</li>
632 <li>The c380004, <a href="http://llvm.org/PR2010">c393010</a>
633 and <a href="http://llvm.org/PR2421">cxg2021</a> ACATS tests fail
634 (c380004 also fails with gcc-4.2 mainline).</li>
635 <li>Some gcc specific Ada tests continue to crash the compiler.</li>
636 <li>The -E binder option (exception backtraces)
637 <a href="http://llvm.org/PR1982">does not work</a> and will result in programs
638 crashing if an exception is raised.  Workaround: do not use -E.</li>
639 <li>Only discrete types <a href="http://llvm.org/PR1981">are allowed to start
640 or finish at a non-byte offset</a> in a record.  Workaround: do not pack records
641 or use representation clauses that result in a field of a non-discrete type
642 starting or finishing in the middle of a byte.</li>
643 <li>The <tt>lli</tt> interpreter <a href="http://llvm.org/PR2009">considers
644 'main' as generated by the Ada binder to be invalid</a>.
645 Workaround: hand edit the file to use pointers for <tt>argv</tt> and
646 <tt>envp</tt> rather than integers.</li>
647 <li>The <tt>-fstack-check</tt> option <a href="http://llvm.org/PR2008">is
648 ignored</a>.</li>
649 </ul>
650 </div>
651
652 <!-- *********************************************************************** -->
653 <div class="doc_section">
654   <a name="additionalinfo">Additional Information</a>
655 </div>
656 <!-- *********************************************************************** -->
657
658 <div class="doc_text">
659
660 <p>A wide variety of additional information is available on the <a
661 href="http://llvm.org">LLVM web page</a>, in particular in the <a
662 href="http://llvm.org/docs/">documentation</a> section.  The web page also
663 contains versions of the API documentation which is up-to-date with the
664 Subversion version of the source code.
665 You can access versions of these documents specific to this release by going
666 into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
667
668 <p>If you have any questions or comments about LLVM, please feel free to contact
669 us via the <a href="http://llvm.org/docs/#maillist"> mailing
670 lists</a>.</p>
671
672 </div>
673
674 <!-- *********************************************************************** -->
675
676 <hr>
677 <address>
678   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
679   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
680   <a href="http://validator.w3.org/check/referer"><img
681   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
682
683   <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
684   Last modified: $Date$
685 </address>
686
687 </body>
688 </html>