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