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