6b4bc451e1738e5e0c5750496c029b563eb28f8e
[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.3 Release Notes</title>
8 </head>
9 <body>
10
11 <div class="doc_title">LLVM 2.3 Release Notes</div>
12  
13 <ol>
14   <li><a href="#intro">Introduction</a></li>
15   <li><a href="#whatsnew">What's New?</a></li>
16   <li><a href="GettingStarted.html">Installation Instructions</a></li>
17   <li><a href="#portability">Portability and Supported Platforms</a></li>
18   <li><a href="#knownproblems">Known Problems</a>
19   <li><a href="#additionalinfo">Additional Information</a></li>
20 </ol>
21
22 <div class="doc_author">
23   <p>Written by the <a href="http://llvm.org">LLVM Team</a><p>
24 </div>
25
26 <!-- *********************************************************************** -->
27 <div class="doc_section">
28   <a name="intro">Introduction</a>
29 </div>
30 <!-- *********************************************************************** -->
31
32 <div class="doc_text">
33
34 <p>This document contains the release notes for the LLVM compiler
35 infrastructure, release 2.3.  Here we describe the status of LLVM, including
36 major improvements from the previous release and any known problems.  All LLVM
37 releases may be downloaded from the <a href="http://llvm.org/releases/">LLVM
38 releases web site</a>.</p>
39
40 <p>For more information about LLVM, including information about the latest
41 release, please check out the <a href="http://llvm.org/">main LLVM
42 web site</a>.  If you have questions or comments, the <a
43 href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM developer's mailing
44 list</a> is a good place to send them.</p>
45
46 <p>Note that if you are reading this file from a Subversion checkout or the 
47 main LLVM web page, this document applies to the <i>next</i> release, not the
48 current one.  To see the release notes for a specific releases, please see the
49 <a href="http://llvm.org/releases/">releases page</a>.</p>
50
51 </div>
52
53 <!-- *********************************************************************** -->
54 <div class="doc_section">
55   <a name="whatsnew">What's New?</a>
56 </div>
57 <!-- *********************************************************************** -->
58
59 <div class="doc_text">
60
61 <p>This is the fourteenth public release of the LLVM Compiler Infrastructure. 
62 It includes a large number of features and refinements from LLVM 2.2.</p>
63
64 </div>
65
66 <!-- Unfinished features in 2.3:
67   Index Set Splitting not enabled by default
68   Machine LICM
69   Machine Sinking
70   LegalizeDAGTypes
71  -->
72
73 <!--=========================================================================-->
74 <div class="doc_subsection">
75 <a name="deprecation">Removed features in LLVM 2.3</a>
76 </div>
77
78 <div class="doc_text">
79
80 <p>LLVM 2.2 was the last LLVM release to support llvm-gcc 4.0 and llvm-upgrade.
81 llvm-gcc 4.0 has been replaced with llvm-gcc 4.2.  llvm-upgrade was useful for
82 upgrading LLVM 1.9 files to LLVM 2.x syntax, but you can always use a previous
83 LLVM release to do this.  One nice impact of this is that the LLVM regressionn
84 test suite no longer depends on llvm-upgrade, which makes it run faster.</p>
85
86 </div>
87
88 <!--=========================================================================-->
89 <div class="doc_subsection">
90 <a name="majorfeatures">Major New Features</a>
91 </div>
92
93 <div class="doc_text">
94
95 <p>LLVM 2.3 includes several major new capabilities:</p>
96
97 <ul>
98 <li>Multiple Return Value Support</li>
99 </ul>
100
101 </div>
102
103
104 <!--=========================================================================-->
105 <div class="doc_subsection">
106 <a name="frontends">llvm-gcc 4.2 Improvements and Clang</a>
107 </div>
108
109 <div class="doc_text">
110
111 <p>LLVM 2.3 fully supports llvm-gcc 4.2 front-end.</p>
112
113 <p>llvm-gcc 4.2 includes numerous fixes to better support the Objective-C
114 front-end.  Objective-C now works very well on Mac OS/X.</p>
115
116 <p>llvm-gcc 4.2 includes many other fixes which improve conformance with the
117 relevant parts of the GCC testsuite.</p>
118
119 <p>The <a href="http://clang.llvm.org/">clang project</a> is an effort to build
120 a set of new 'llvm native' front-end technologies for the LLVM optimizer
121 and code generator.  Currently, its C and Objective-C support is maturing 
122 nicely, and it has advanced source-to-source analysis and transformation
123 capabilities.  If you are interested in building source-level tools for C and
124 Objective-C (and eventually C++), you should take a look.  However, note that
125 clang is not an official part of the LLVM 2.3 release.  If you are interested in
126 this project, please see its <a href="http://clang.llvm.org/">web site</a>.</p>
127
128 </div>
129
130
131 <!--=========================================================================-->
132 <div class="doc_subsection">
133 <a name="coreimprovements">LLVM Core Improvements</a>
134 </div>
135
136 <div class="doc_text">
137 <p>New features include:
138 </p>
139
140
141 Common linkage?
142
143 Atomic operation support, Alpha, X86, PowerPC. "__sync_syncronize"
144
145 <ul>
146 </ul>
147   
148 </div>
149
150 <!--=========================================================================-->
151 <div class="doc_subsection">
152 <a name="codegen">Code Generator Improvements</a>
153 </div>
154
155 <div class="doc_text">
156
157 <p>We put a significant amount of work into the code generator infrastructure,
158 which allows us to implement more aggressive algorithms and make it run
159 faster:</p>
160
161 <ul>
162 <li>MemOperand in the code generator: describe me!.</li>
163 <li>i128 support and APInt through most of codegen.</li>
164 </ul>
165
166 </div>
167
168 <!--=========================================================================-->
169 <div class="doc_subsection">
170 <a name="optimizer">Optimizer Improvements</a>
171 </div>
172
173 <div class="doc_text">
174
175 <p>In addition to a huge array of bug fixes and minor performance tweaks, the 
176 LLVM 2.3 optimizers support a few major enhancements:</p>
177
178 <ul>
179
180 <li>Loop index set splitting on by default: describe me.</li>
181 <li>LLVM includes a new memcpy optimization pass which optimizes out dead
182 memcpy calls and unneeded copies of aggregates.</li>
183 </ul>
184
185 </div>
186
187
188 <!--=========================================================================-->
189 <div class="doc_subsection">
190 <a name="targetspecific">Target Specific Improvements</a>
191 </div>
192
193 <div class="doc_text">
194 <p>New target-specific features include:
195 </p>
196
197 <ul>
198 <li>llvm-gcc's X86-64 ABI conformance is far improved, particularly in the
199     area of passing and returning structures by value.  llvm-gcc Compiled code
200     now interoperates very well on X86-64 systems with other compilers.</li>
201
202 <li>The LLVM X86 backend now supports the support SSE 4.1 instruction set, and
203     the llvm-gcc 4.2 front-end supports the SSE 4.1 compiler builtins.</li>
204        
205 <li>The X86 backend now does a number of optimizations that aim to avoid
206     converting numbers back and forth from SSE registers to the X87 floating
207     point stack.</li>
208
209 <li>The X86 backend now supports the "sseregparm" options in GCC, which allow
210     functions to be tagged as passing floating point values in SSE
211     registers.</li>
212
213 <li>Trampolines (taking the address of a nested function) now work on
214     Linux/x86-64.</li>
215     
216
217 </ul>
218   
219 </div>
220
221 <!--=========================================================================-->
222 <div class="doc_subsection">
223 <a name="otherimprovements">Other Improvements</a>
224 </div>
225
226 <div class="doc_text">
227 <p>New features include:
228 </p>
229
230 <ul>
231 </ul>
232   
233 </div>
234
235 <!-- *********************************************************************** -->
236 <div class="doc_section">
237   <a name="portability">Portability and Supported Platforms</a>
238 </div>
239 <!-- *********************************************************************** -->
240
241 <div class="doc_text">
242
243 <p>LLVM is known to work on the following platforms:</p>
244
245 <ul>
246 <li>Intel and AMD machines running Red Hat Linux, Fedora Core and FreeBSD 
247       (and probably other unix-like systems).</li>
248 <li>PowerPC and X86-based Mac OS X systems, running 10.3 and above in 32-bit and
249     64-bit modes.</li>
250 <li>Intel and AMD machines running on Win32 using MinGW libraries (native).</li>
251 <li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
252     support is available for native builds with Visual C++).</li>
253 <li>Sun UltraSPARC workstations running Solaris 8.</li>
254 <li>Alpha-based machines running Debian GNU/Linux.</li>
255 <li>Itanium-based machines running Linux and HP-UX.</li>
256 </ul>
257
258 <p>The core LLVM infrastructure uses
259 <a href="http://www.gnu.org/software/autoconf/">GNU autoconf</a> to adapt itself
260 to the machine and operating system on which it is built.  However, minor
261 porting may be required to get LLVM to work on new platforms.  We welcome your
262 portability patches and reports of successful builds or error messages.</p>
263
264 </div>
265
266 <!-- *********************************************************************** -->
267 <div class="doc_section">
268   <a name="knownproblems">Known Problems</a>
269 </div>
270 <!-- *********************************************************************** -->
271
272 <div class="doc_text">
273
274 <p>This section contains all known problems with the LLVM system, listed by
275 component.  As new problems are discovered, they will be added to these
276 sections.  If you run into a problem, please check the <a
277 href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
278 there isn't already one.</p>
279
280 </div>
281
282 <!-- ======================================================================= -->
283 <div class="doc_subsection">
284   <a name="experimental">Experimental features included with this release</a>
285 </div>
286
287 <div class="doc_text">
288
289 <p>The following components of this LLVM release are either untested, known to
290 be broken or unreliable, or are in early development.  These components should
291 not be relied on, and bugs should not be filed against them, but they may be
292 useful to some people.  In particular, if you would like to work on one of these
293 components, please contact us on the <a
294 href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p>
295
296 <ul>
297 <li>The MSIL, IA64, Alpha, SPU, and MIPS backends are experimental.</li>
298 <li>The LLC "<tt>-filetype=asm</tt>" (the default) is the only supported
299     value for this option.</li>
300 <li>The llvmc tool is not supported.</li>
301 </ul>
302
303 </div>
304
305 <!-- ======================================================================= -->
306 <div class="doc_subsection">
307   <a name="x86-be">Known problems with the X86 back-end</a>
308 </div>
309
310 <div class="doc_text">
311
312 <ul>
313 <li>The X86 backend does not yet support <a href="http://llvm.org/PR879">inline
314     assembly that uses the X86 floating point stack</a>.</li>
315 <li>The X86 backend generates inefficient floating point code when configured to
316     generate code for systems that don't have SSE2.</li>
317 </ul>
318
319 </div>
320
321 <!-- ======================================================================= -->
322 <div class="doc_subsection">
323   <a name="ppc-be">Known problems with the PowerPC back-end</a>
324 </div>
325
326 <div class="doc_text">
327
328 <ul>
329 <li>The Linux PPC32/ABI support needs testing for the interpreter and static
330 compilation, and lacks support for debug information.</li>
331 </ul>
332
333 </div>
334
335 <!-- ======================================================================= -->
336 <div class="doc_subsection">
337   <a name="arm-be">Known problems with the ARM back-end</a>
338 </div>
339
340 <div class="doc_text">
341
342 <ul>
343 <li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
344 processors, thumb programs can crash or produce wrong
345 results (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
346 <li>Compilation for ARM Linux OABI (old ABI) is supported, but not fully tested.
347 </li>
348 <li>There is a bug in QEMU-ARM (&lt;= 0.9.0) which causes it to incorrectly execute
349 programs compiled with LLVM.  Please use more recent versions of QEMU.</li>
350 </ul>
351
352 </div>
353
354 <!-- ======================================================================= -->
355 <div class="doc_subsection">
356   <a name="sparc-be">Known problems with the SPARC back-end</a>
357 </div>
358
359 <div class="doc_text">
360
361 <ul>
362 <li>The SPARC backend only supports the 32-bit SPARC ABI (-m32), it does not
363     support the 64-bit SPARC ABI (-m64).</li>
364 </ul>
365
366 </div>
367
368 <!-- ======================================================================= -->
369 <div class="doc_subsection">
370   <a name="alpha-be">Known problems with the Alpha back-end</a>
371 </div>
372
373 <div class="doc_text">
374
375 <ul>
376
377 <li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
378 appropriate nops inserted to ensure restartability.</li>
379
380 </ul>
381 </div>
382
383 <!-- ======================================================================= -->
384 <div class="doc_subsection">
385   <a name="ia64-be">Known problems with the IA64 back-end</a>
386 </div>
387
388 <div class="doc_text">
389
390 <ul>
391
392 <li>C++ programs are likely to fail on IA64, as calls to <tt>setjmp</tt> are
393 made where the argument is not 16-byte aligned, as required on IA64. (Strictly
394 speaking this is not a bug in the IA64 back-end; it will also be encountered
395 when building C++ programs using the C back-end.)</li>
396
397 <li>The C++ front-end does not use <a href="http://llvm.org/PR406">IA64
398 ABI compliant layout of v-tables</a>.  In particular, it just stores function
399 pointers instead of function descriptors in the vtable.  This bug prevents
400 mixing C++ code compiled with LLVM with C++ objects compiled by other C++
401 compilers.</li>
402
403 <li>There are a few ABI violations which will lead to problems when mixing LLVM
404 output with code built with other compilers, particularly for floating-point
405 programs.</li>
406
407 <li>Defining vararg functions is not supported (but calling them is ok).</li>
408
409 <li>The Itanium backend has bitrotted somewhat.</li>
410 </ul>
411
412 </div>
413
414 <!-- ======================================================================= -->
415 <div class="doc_subsection">
416   <a name="c-be">Known problems with the C back-end</a>
417 </div>
418
419 <div class="doc_text">
420
421 <ul>
422 <li><a href="http://llvm.org/PR802">The C backend has only basic support for
423     inline assembly code</a>.</li>
424 <li><a href="http://llvm.org/PR1658">The C backend violates the ABI of common
425     C++ programs</a>, preventing intermixing between C++ compiled by the CBE and
426     C++ code compiled with LLC or native compilers.</li>
427 <li>The C backend does not support all exception handling constructs.</li>
428 </ul>
429
430 </div>
431
432
433 <!-- ======================================================================= -->
434 <div class="doc_subsection">
435   <a name="c-fe">Known problems with the llvm-gcc C front-end</a>
436 </div>
437
438 <!-- _______________________________________________________________________ -->
439 <div class="doc_subsubsection">Bugs</div>
440
441 <div class="doc_text">
442
443 <p>llvm-gcc does not currently support <a href="http://llvm.org/PR869">Link-Time
444 Optimization</a> on most platforms "out-of-the-box".  Please inquire on the
445 llvmdev mailing list if you are interested.</p>
446
447 <p>The only major language feature of GCC not supported by llvm-gcc is
448     the <tt>__builtin_apply</tt> family of builtins.   However, some extensions
449     are only supported on some targets.  For example, trampolines are only
450     supported on some targets, which are used when you take the address of a
451     nested function.</p>
452
453 <p>If you run into GCC extensions which are not supported, please let us know.
454 </p>
455
456 </div>
457
458 <!-- ======================================================================= -->
459 <div class="doc_subsection">
460   <a name="c++-fe">Known problems with the llvm-gcc C++ front-end</a>
461 </div>
462
463 <div class="doc_text">
464
465 <p>The C++ front-end is considered to be fully
466 tested and works for a number of non-trivial programs, including LLVM
467 itself, Qt, Mozilla, etc.</p>
468
469 <ul>
470 <li>Exception handling works well on the X86 and PowerPC targets, including
471 x86-64 darwin.  This works when linking to a libstdc++ compiled by GCC.  It is
472 supported on x86-64 linux, but that is disabled by default in this release.</li>
473 </ul>
474
475 </div>
476
477
478 <!-- ======================================================================= -->
479 <div class="doc_subsection">
480   <a name="ada-fe">Known problems with the llvm-gcc Ada front-end</a>
481 </div>
482
483 <div class="doc_text">
484 The llvm-gcc 4.2 Ada compiler works fairly well, however this is not a mature
485 technology and problems should be expected.
486 <ul>
487 <li>The Ada front-end currently only builds on x86-32.  This is mainly due
488 to lack of trampoline support (pointers to nested functions) on other platforms,
489 however it <a href="http://llvm.org/PR2006">also fails to build on x86-64</a>
490 which does support trampolines.</li>
491 <li>The Ada front-end <a href="http://llvm.org/PR2007">fails to bootstrap</a>.
492 Workaround: configure with --disable-bootstrap.</li>
493 <li>The c380004 and <a href="http://llvm.org/PR2010">c393010</a> ACATS tests
494 fail (c380004 also fails with gcc-4.2 mainline).</li>
495 <li>Many gcc specific Ada tests continue to crash the compiler.</li>
496 <li>The -E binder option (exception backtraces)
497 <a href="http://llvm.org/PR1982">does not work</a> and will result in programs
498 crashing if an exception is raised.  Workaround: do not use -E.</li>
499 <li>Only discrete types <a href="http://llvm.org/PR1981">are allowed to start
500 or finish at a non-byte offset</a> in a record.  Workaround: do not pack records
501 or use representation clauses that result in a field of a non-discrete type
502 starting or finishing in the middle of a byte.</li>
503 <li>The lli interpreter <a href="http://llvm.org/PR2009">considers 'main'
504 as generated by the Ada binder to be invalid</a>.
505 Workaround: hand edit the file to use pointers for argv and envp rather than
506 integers.</li>
507 <li>The -fstack-check option <a href="http://llvm.org/PR2008">is ignored</a>.</li>
508 </ul>
509 </div>
510
511 <!-- ======================================================================= -->
512 <div class="doc_subsection">
513   <a name="fortran-fe">Known problems with the llvm-gcc Fortran front-end</a>
514 </div>
515
516 <div class="doc_text">
517
518 <ul>
519 <li>The llvm-gcc 4.2 gfortran front-end supports a broad range of Fortran code, but does
520 <a href="http://llvm.org/PR1971">not support EQUIVALENCE yet</a>.</li>
521 </ul>
522 </div>
523
524
525
526 <!-- *********************************************************************** -->
527 <div class="doc_section">
528   <a name="additionalinfo">Additional Information</a>
529 </div>
530 <!-- *********************************************************************** -->
531
532 <div class="doc_text">
533
534 <p>A wide variety of additional information is available on the <a
535 href="http://llvm.org">LLVM web page</a>, in particular in the <a
536 href="http://llvm.org/docs/">documentation</a> section.  The web page also
537 contains versions of the API documentation which is up-to-date with the
538 Subversion version of the source code.
539 You can access versions of these documents specific to this release by going
540 into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
541
542 <p>If you have any questions or comments about LLVM, please feel free to contact
543 us via the <a href="http://llvm.org/docs/#maillist"> mailing
544 lists</a>.</p>
545
546 </div>
547
548 <!-- *********************************************************************** -->
549
550 <hr>
551 <address>
552   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
553   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
554   <a href="http://validator.w3.org/check/referer"><img
555   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
556
557   <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
558   Last modified: $Date$
559 </address>
560
561 </body>
562 </html>