blob: a909d5f80aae001785df24f41ba7c2c1af931ee7 [file] [log] [blame]
Misha Brukman500bc302003-11-22 00:38:41 +00001<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
3<html>
4<head>
5 <link rel="stylesheet" href="llvm.css" type="text/css">
Chris Lattner2974b5b2004-04-01 00:41:31 +00006 <title>LLVM 1.3 Release Notes</title>
Misha Brukman500bc302003-11-22 00:38:41 +00007</head>
8<body>
Chris Lattner79c3fe12003-10-02 04:57:28 +00009
Chris Lattner2974b5b2004-04-01 00:41:31 +000010<div class="doc_title">LLVM 1.3 Release Notes</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +000011
12<ol>
Misha Brukman500bc302003-11-22 00:38:41 +000013 <li><a href="#intro">Introduction</a></li>
14 <li><a href="#whatsnew">What's New?</a></li>
15 <li><a href="#portability">Portability and Supported Platforms</a></li>
16 <li><a href="#install-instructions">Installation Instructions</a></li>
Chris Lattner79c3fe12003-10-02 04:57:28 +000017 <li><a href="#knownproblems">Known Problems</a>
18 <ul>
Chris Lattner2974b5b2004-04-01 00:41:31 +000019 <li><a href="#experimental">Experimental features included in this
20 release</a>
Chris Lattner79c3fe12003-10-02 04:57:28 +000021 <li><a href="#core">Known problems with the LLVM Core</a>
22 <li><a href="#c-fe">Known problems with the C Front-end</a>
23 <li><a href="#c++-fe">Known problems with the C++ Front-end</a>
24 <li><a href="#x86-be">Known problems with the X86 Back-end</a>
25 <li><a href="#sparc-be">Known problems with the Sparc Back-end</a>
26 <li><a href="#c-be">Known problems with the C back-end</a>
Misha Brukman500bc302003-11-22 00:38:41 +000027 </ul></li>
28 <li><a href="#additionalinfo">Additional Information</a></li>
Chris Lattner79c3fe12003-10-02 04:57:28 +000029</ol>
30
Misha Brukmane0c891c2003-11-22 01:00:11 +000031<div class="doc_text">
John Criswelld000e1d2003-12-18 16:43:17 +000032 <p><b>Written by the <a href="http://llvm.cs.uiuc.edu">LLVM team</a></b><p>
Misha Brukman500bc302003-11-22 00:38:41 +000033</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +000034
35<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +000036<div class="doc_section">
37 <a name="intro">Introduction</a>
38</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +000039<!-- *********************************************************************** -->
40
Misha Brukman500bc302003-11-22 00:38:41 +000041<div class="doc_text">
42
43<p>This document contains the release notes for the LLVM compiler
Chris Lattner2974b5b2004-04-01 00:41:31 +000044infrastructure, release 1.3. Here we describe the status of LLVM, including any
John Criswelld000e1d2003-12-18 16:43:17 +000045known problems and bug fixes from the previous release. The most up-to-date
Misha Brukman500bc302003-11-22 00:38:41 +000046version of this document can be found on the <a
Chris Lattner2974b5b2004-04-01 00:41:31 +000047href="http://llvm.cs.uiuc.edu/releases/1.3/">LLVM 1.3 web site</a>. If you are
John Criswelld000e1d2003-12-18 16:43:17 +000048not reading this on the LLVM web pages, you should probably go there because
Misha Brukman500bc302003-11-22 00:38:41 +000049this document may be updated after the release.</p>
Chris Lattner19092612003-10-02 16:38:05 +000050
Misha Brukman500bc302003-11-22 00:38:41 +000051<p>For more information about LLVM, including information about potentially more
Chris Lattner47ad72c2003-10-07 21:38:31 +000052current releases, please check out the <a href="http://llvm.cs.uiuc.edu">main
53web site</a>. If you have questions or comments, the <a
54href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM developer's mailing
Misha Brukman500bc302003-11-22 00:38:41 +000055list</a> is a good place to send them.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +000056
Chris Lattner9e848092003-12-12 04:25:33 +000057<p>Note that if you are reading this file from CVS, this document applies
58to the <i>next</i> release, not the current one. To see the release notes for
59the current or previous releases, see the <a
Misha Brukman500bc302003-11-22 00:38:41 +000060href="http://llvm.cs.uiuc.edu/releases/">releases page</a>.</p>
61
62</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +000063
64<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +000065<div class="doc_section">
66 <a name="whatsnew">What's New?</a>
67</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +000068<!-- *********************************************************************** -->
69
Misha Brukman500bc302003-11-22 00:38:41 +000070<div class="doc_text">
71
Chris Lattnera39719f2004-02-25 16:36:51 +000072<p>
Chris Lattner2974b5b2004-04-01 00:41:31 +000073This is the fourth public release of the LLVM compiler infrastructure.
Chris Lattnerb40efb32003-12-14 05:03:43 +000074</p>
Chris Lattnera5099962003-12-06 20:22:41 +000075
Chris Lattner835104c2004-03-17 03:54:41 +000076<p>
77At this time, LLVM is known to correctly compile and run all C &amp; C++ SPEC
78CPU2000 benchmarks, the Olden benchmarks, and the Ptrdist benchmarks. It has
79also been used to compile <b>many</b> other programs. LLVM now also works with
80a broad variety of C++ programs, though it has still received less testing than
81the C front-end.
Chris Lattnera5099962003-12-06 20:22:41 +000082</p>
83
Chris Lattnera5099962003-12-06 20:22:41 +000084<!--=========================================================================-->
85<div class="doc_subsubsection">
Chris Lattnera39719f2004-02-25 16:36:51 +000086<a name="newfeatures">This release implements the following new features:</a>
Chris Lattnera5099962003-12-06 20:22:41 +000087</div>
Chris Lattner47ad72c2003-10-07 21:38:31 +000088
89<ol>
Chris Lattner2974b5b2004-04-01 00:41:31 +000090<li>The LLVM <a href="LangRef.html#i_select"><tt>select</tt></a> instruction is
Brian Gaeke21a710a2004-04-20 18:18:46 +000091now fully implemented and supported by all targets, including
92<a href="http://llvm.cs.uiuc.edu/PR322">interpreter support.</a></li>
Misha Brukmana7aadf12004-04-19 02:56:49 +000093<li>Bugpoint can now narrow down code-generation bugs to a loop nest, where
94before it could only narrow them down to a function being miscompiled.</li>
Chris Lattner55ee0312003-11-19 22:05:38 +000095</ol>
Chris Lattner0ef19062003-11-08 04:28:55 +000096
Chris Lattnera5099962003-12-06 20:22:41 +000097
98<!--=========================================================================-->
99<div class="doc_subsubsection">
100In this release, the following missing features were implemented:
101</div>
Chris Lattner0ef19062003-11-08 04:28:55 +0000102
103<ol>
Misha Brukmana7aadf12004-04-19 02:56:49 +0000104<li><a href="http://llvm.cs.uiuc.edu/PR82">LLVM cannot handle structures with
105more than 256 elements</a></li>
Misha Brukmancb003362004-04-19 03:01:01 +0000106<li><a href="http://llvm.cs.uiuc.edu/PR38">[bugpoint] External functions used in
107non-instruction entities, such as global constant initializer</a></li>
108<li><a href="http://llvm.cs.uiuc.edu/PR290">Bugpoint doesn't support
109uses of external fns by immediate constant exprs</a></li>
Misha Brukman500bc302003-11-22 00:38:41 +0000110</ol>
Chris Lattner47ad72c2003-10-07 21:38:31 +0000111
Chris Lattnera5099962003-12-06 20:22:41 +0000112
113<!--=========================================================================-->
114<div class="doc_subsubsection">
Misha Brukmana7aadf12004-04-19 02:56:49 +0000115<a name="qualityofimp">In this release, the following Quality of Implementation
116issues were fixed:</a>
Chris Lattnere29ac162003-12-20 03:42:11 +0000117</div>
118
119<ol>
Misha Brukmana7aadf12004-04-19 02:56:49 +0000120<li><a href="http://llvm.cs.uiuc.edu/PR305">LLVM tools will happily spew
121bytecode onto your terminal</a></li>
Chris Lattnere29ac162003-12-20 03:42:11 +0000122</ol>
123
124<!--=========================================================================-->
125<div class="doc_subsubsection">
Chris Lattnera39719f2004-02-25 16:36:51 +0000126In this release, the following build problems were fixed:
Brian Gaeke6b31beb2004-01-16 21:55:04 +0000127</div>
128
129<ol>
Brian Gaeke21a710a2004-04-20 18:18:46 +0000130<li><a href="http://llvm.cs.uiuc.edu/PR301">Minor configure bugs with -disable/enable-povray and -disable-spec</a></li>
Brian Gaeke6b31beb2004-01-16 21:55:04 +0000131</ol>
132
133<!--=========================================================================-->
134<div class="doc_subsubsection">
Misha Brukmana7aadf12004-04-19 02:56:49 +0000135<a name="codequality">In this release, the following Code Quality issues were
136fixed:</a>
Chris Lattnera5099962003-12-06 20:22:41 +0000137</div>
Chris Lattner89ca2b82003-10-27 17:06:39 +0000138
139<ol>
Chris Lattner64913402004-04-13 14:43:35 +0000140<li><a href="http://llvm.cs.uiuc.edu/PR309">[vmcore] Code quality problem due to
141long operand of getelementptr</a></li>
142
143<li>The X86 backend now generates substantially better code for 64-bit integer
144and floating point operations.</li>
145
146<li>The -inline pass no longer inlines mutually recursive functions until it
147hits the inlining threshold.</li>
148
149<li>The -inline pass no longer misses obvious inlining opportunities just
150because the callee eventually calls into an external function.</li>
151
152<li>The -simplifycfg pass can now "if convert" simple statements into the new
153<tt>select</tt> instruction.</li>
154
155<li>The -loopsimplify pass can now break <a
156href="http://llvm.cs.uiuc.edu/PR35">natural loops with multiple backedges</a>
157into multiple nested loops. This enables a variety of subsequent
158optimizations.</li>
159
160<li>The -adce pass can now eliminate calls to functions that do not not write to
161memory.</li>
162
163<li>The link-time optimizer now runs the -prune-eh pass (to remove unused
164exception handlers.</li>
165
Misha Brukman500bc302003-11-22 00:38:41 +0000166</ol>
Chris Lattner89ca2b82003-10-27 17:06:39 +0000167
Chris Lattnera5099962003-12-06 20:22:41 +0000168
169<!--=========================================================================-->
170<div class="doc_subsubsection">
Misha Brukmana7aadf12004-04-19 02:56:49 +0000171<a name="bugfix">In this release, the following bugs in the previous release
172were fixed:</a>
Chris Lattnera5099962003-12-06 20:22:41 +0000173</div>
174
175<p>Bugs in the LLVM Core:</p>
Chris Lattner47ad72c2003-10-07 21:38:31 +0000176
177<ol>
Misha Brukmana7aadf12004-04-19 02:56:49 +0000178<li><a href="http://llvm.cs.uiuc.edu/PR306">[loopsimplify] Loop simplify
179incorrectly updates dominator information</a></li>
180<li><a href="http://llvm.cs.uiuc.edu/PR310">[tailduplicate] DemoteRegToStack
181breaks SSA form</a></li>
182<li><a href="http://llvm.cs.uiuc.edu/PR313">[X86] JIT miscompiles unsigned short
183to floating point cast</a></li>
Chris Lattnera5099962003-12-06 20:22:41 +0000184</ol>
185
186
Chris Lattner56e67052004-02-09 21:22:51 +0000187
Chris Lattnera5099962003-12-06 20:22:41 +0000188<p>Bugs in the C/C++ front-end:</p>
189
190<ol>
Chris Lattner2974b5b2004-04-01 00:41:31 +0000191<li></li>
Chris Lattnera5099962003-12-06 20:22:41 +0000192</ol>
Chris Lattner19092612003-10-02 16:38:05 +0000193
Misha Brukman500bc302003-11-22 00:38:41 +0000194</div>
Chris Lattner19092612003-10-02 16:38:05 +0000195
196<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000197<div class="doc_section">
198 <a name="portability">Portability and Supported Platforms</a>
199</div>
Chris Lattner19092612003-10-02 16:38:05 +0000200<!-- *********************************************************************** -->
201
Misha Brukman500bc302003-11-22 00:38:41 +0000202<div class="doc_text">
203
204<p>LLVM has been extensively tested on Intel and AMD machines running Red
Misha Brukmana7aadf12004-04-19 02:56:49 +0000205Hat Linux and FreeBSD. It has also been tested on Sun UltraSPARC workstations
206running Solaris 8. Additionally, LLVM works on Mac OS X 10.3 and above, but
207only with the C backend or interpreter (no native backend for the PowerPC is
208available yet). The core LLVM infrastructure uses "autoconf" for portability,
209so hopefully we work on more platforms than that. However, it is likely that we
210missed something and that minor porting is required to get LLVM to work on new
211platforms. We welcome portability patches and error messages.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000212
Misha Brukman500bc302003-11-22 00:38:41 +0000213</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000214
Brian Gaeke21a710a2004-04-20 18:18:46 +0000215<!--=========================================================================-->
216<div class="doc_subsection">
217In this release, the following portability problems were fixed:
218</div>
219
220<ol>
221<li><a href="http://llvm.cs.uiuc.edu/PR304">warnings compiling Stacker compiler on Mac OS X</a></li>
222<li><a href="http://llvm.cs.uiuc.edu/PR308">getObjectType doesn't understand abbreviated names in headers</a></li>
223</ol>
224
Chris Lattner79c3fe12003-10-02 04:57:28 +0000225<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000226<div class="doc_section">
227 <a name="knownproblems">Known Problems</a>
228</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000229<!-- *********************************************************************** -->
230
Misha Brukman500bc302003-11-22 00:38:41 +0000231<div class="doc_text">
232
233<p>This section contains all known problems with the LLVM system, listed by
Chris Lattner79c3fe12003-10-02 04:57:28 +0000234component. As new problems are discovered, they will be added to these
Chris Lattner5eccca42003-12-12 21:22:16 +0000235sections. If you run into a problem, please check the <a
John Criswelld000e1d2003-12-18 16:43:17 +0000236href="http://llvm.cs.uiuc.edu/bugs/">LLVM bug database</a> and submit a bug if
Chris Lattner5eccca42003-12-12 21:22:16 +0000237there isn't already one.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000238
Misha Brukman500bc302003-11-22 00:38:41 +0000239</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000240
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000241<!-- ======================================================================= -->
242<div class="doc_subsection">
243 <a name="experimental">Experimental features included with this release</a>
244</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000245
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000246<div class="doc_text">
247
248<p>
249The following components of this LLVM release are either untested, known to be
250broken or unreliable, or are in early development. These components should not
251be relied on, and bugs should not be filed against them, but they may be useful
252to some people. In particular, if you would like to work on one of these
253components, please contact us on the llvmdev list.
254</p>
255
256<ul>
257<li>The following passes are incomplete or buggy: <tt>-pgmdep, -memdep,
258 -ipmodref, -sortstructs, -swapstructs, -cee</tt></li>
259
260<li>The <tt>-pre</tt> pass is incomplete (there are cases it doesn't handle that
261 it should) and not thoroughly tested.</li>
262<li>The <tt>llvm-ar</tt> tool is incomplete and probably buggy.</li>
263<li>The <tt>llvm-db</tt> tool is in a very early stage of development.</li>
264</ul>
265
266</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000267
Misha Brukman500bc302003-11-22 00:38:41 +0000268<!-- ======================================================================= -->
269<div class="doc_subsection">
270 <a name="core">Known problems with the LLVM Core</a>
271</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000272
Misha Brukman500bc302003-11-22 00:38:41 +0000273<div class="doc_text">
274
275<ul>
276
277<li>In the JIT, <tt>dlsym</tt> on a symbol compiled by the JIT will not
278work.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000279
280<li>The JIT does not use mutexes to protect its internal data structures. As
Misha Brukman500bc302003-11-22 00:38:41 +0000281such, execution of a threaded program could cause these data structures to be
282corrupted.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000283
Misha Brukman500bc302003-11-22 00:38:41 +0000284<li>It is not possible to <tt>dlopen</tt> an LLVM bytecode file in the JIT.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000285
Chris Lattnere84843b2003-10-20 19:05:03 +0000286<li>Linking in static archive files (.a files) is very slow (there is no symbol
Misha Brukman500bc302003-11-22 00:38:41 +0000287table in the archive).</li>
Chris Lattner2855ecd2003-11-04 20:06:53 +0000288
Misha Brukmana7aadf12004-04-19 02:56:49 +0000289<li>The gccld program <a href="http://llvm.cs.uiuc.edu/PR139">does not link
290objects/archives in the order specified on the command line.</a></li>
Chris Lattner2e6fcaf2004-02-15 23:09:07 +0000291
292<li><a href="http://llvm.cs.uiuc.edu/PR240">The lower-invoke pass does not mark
John Criswelld46c6962004-03-12 21:29:42 +0000293values live across a setjmp as volatile</a>. This missing feature only affects
Chris Lattner2e6fcaf2004-02-15 23:09:07 +0000294targets whose setjmp/longjmp libraries do not save and restore the entire
295register file.</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000296</ul>
Misha Brukman500bc302003-11-22 00:38:41 +0000297</div>
298
299<!-- ======================================================================= -->
300<div class="doc_subsection">
301 <a name="c-fe">Known problems with the C front-end</a>
302</div>
Chris Lattner47588f92003-10-02 05:07:23 +0000303
Chris Lattner79c3fe12003-10-02 04:57:28 +0000304<!-- _______________________________________________________________________ -->
Chris Lattnerb40efb32003-12-14 05:03:43 +0000305<div class="doc_subsubsection">Bugs</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000306
Misha Brukman500bc302003-11-22 00:38:41 +0000307<div class="doc_text">
Misha Brukman500bc302003-11-22 00:38:41 +0000308<ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000309<li>C99 Variable sized arrays do not release stack memory when they go out of
310 scope. Thus, the following program may run out of stack space:
311<pre>
312 for (i = 0; i != 1000000; ++i) {
313 int X[n];
314 foo(X);
315 }
Misha Brukman500bc302003-11-22 00:38:41 +0000316</pre></li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000317
John Criswelld000e1d2003-12-18 16:43:17 +0000318<li>
319Initialization of global union variables can only be done
320<a href="http://llvm.cs.uiuc.edu/bugs/show_bug.cgi?id=162">with the largest
321union member</a>.
322</li>
Chris Lattnerf580cdc2004-03-16 21:39:04 +0000323
Misha Brukmana7aadf12004-04-19 02:56:49 +0000324<li><a href="http://llvm.cs.uiuc.edu/PR244">[llvm-gcc] Error when an implicitly
325external function is re-declared as static</a></li>
Chris Lattnerf580cdc2004-03-16 21:39:04 +0000326
John Criswelld000e1d2003-12-18 16:43:17 +0000327</ul>
Misha Brukman500bc302003-11-22 00:38:41 +0000328</div>
329
330<!-- _______________________________________________________________________ -->
331<div class="doc_subsubsection">
332 Notes
333</div>
334
335<div class="doc_text">
336
337<ul>
338
339<li>Inline assembly is not yet supported.</li>
Chris Lattnere01fcfb2003-10-27 18:30:37 +0000340
341<li>"long double" is transformed by the front-end into "double". There is no
Misha Brukman500bc302003-11-22 00:38:41 +0000342support for floating point data types of any size other than 32 and 64
343bits.</li>
344
345<li>The following Unix system functionality has not been tested and may not
346work:
Misha Brukmane0c891c2003-11-22 01:00:11 +0000347 <ol>
348 <li><tt>sigsetjmp</tt>, <tt>siglongjmp</tt> - These are not turned into the
349 appropriate <tt>invoke</tt>/<tt>unwind</tt> instructions. Note that
350 <tt>setjmp</tt> and <tt>longjmp</tt> <em>are</em> compiled correctly.
351 <li><tt>getcontext</tt>, <tt>setcontext</tt>, <tt>makecontext</tt>
352 - These functions have not been tested.
353 </ol></li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000354
355<li>Although many GCC extensions are supported, some are not. In particular,
356 the following extensions are known to <b>not be</b> supported:
357 <ol>
Misha Brukman500bc302003-11-22 00:38:41 +0000358 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Local-Labels.html#Local%20Labels">Local Labels</a>: Labels local to a block.</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000359 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Nested-Functions.html#Nested%20Functions">Nested Functions</a>: As in Algol and Pascal, lexical scoping of functions.</li>
360 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Constructing-Calls.html#Constructing%20Calls">Constructing Calls</a>: Dispatching a call to another function.</li>
361 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Extended-Asm.html#Extended%20Asm">Extended Asm</a>: Assembler instructions with C expressions as operands.</li>
John Criswelld000e1d2003-12-18 16:43:17 +0000362 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Constraints.html#Constraints">Constraints</a>: Constraints for asm operands.</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000363 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Asm-Labels.html#Asm%20Labels">Asm Labels</a>: Specifying the assembler name to use for a C symbol.</li>
364 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Explicit-Reg-Vars.html#Explicit%20Reg%20Vars">Explicit Reg Vars</a>: Defining variables residing in specified registers.</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000365 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Vector-Extensions.html#Vector%20Extensions">Vector Extensions</a>: Using vector instructions through built-in functions.</li>
366 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Target-Builtins.html#Target%20Builtins">Target Builtins</a>: Built-in functions specific to particular targets.</li>
367 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Thread-Local.html#Thread-Local">Thread-Local</a>: Per-thread variables.</li>
368 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Pragmas.html#Pragmas">Pragmas</a>: Pragmas accepted by GCC.</li>
Misha Brukmane0c891c2003-11-22 01:00:11 +0000369 </ol>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000370
Misha Brukman500bc302003-11-22 00:38:41 +0000371 <p>The following GCC extensions are <b>partially</b> supported. An ignored
Chris Lattner79c3fe12003-10-02 04:57:28 +0000372 attribute means that the LLVM compiler ignores the presence of the attribute,
373 but the code should still work. An unsupported attribute is one which is
John Criswelld000e1d2003-12-18 16:43:17 +0000374 ignored by the LLVM compiler and will cause a different interpretation of
Misha Brukman500bc302003-11-22 00:38:41 +0000375 the program.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000376
377 <ol>
378 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Length.html#Variable%20Length">Variable Length</a>:
379 Arrays whose length is computed at run time.<br>
Misha Brukman500bc302003-11-22 00:38:41 +0000380 Supported, but allocated stack space is not freed until the function returns (noted above).</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000381
382 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Attributes.html#Function%20Attributes">Function Attributes</a>:
Misha Brukman500bc302003-11-22 00:38:41 +0000383
John Criswelld000e1d2003-12-18 16:43:17 +0000384 Declaring that functions have no side effects or that they can never
Misha Brukman500bc302003-11-22 00:38:41 +0000385 return.<br>
386
387 <b>Supported:</b> <tt>format</tt>, <tt>format_arg</tt>, <tt>non_null</tt>,
388 <tt>constructor</tt>, <tt>destructor</tt>, <tt>unused</tt>,
389 <tt>deprecated</tt>, <tt>warn_unused_result</tt>, <tt>weak</tt><br>
390
391 <b>Ignored:</b> <tt>noreturn</tt>, <tt>noinline</tt>,
392 <tt>always_inline</tt>, <tt>pure</tt>, <tt>const</tt>, <tt>nothrow</tt>,
393 <tt>malloc</tt>, <tt>no_instrument_function</tt>, <tt>cdecl</tt><br>
394
395 <b>Unsupported:</b> <tt>used</tt>, <tt>section</tt>, <tt>alias</tt>,
396 <tt>visibility</tt>, <tt>regparm</tt>, <tt>stdcall</tt>,
397 <tt>fastcall</tt>, all other target specific attributes</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000398
399 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Attributes.html#Variable%20Attributes">Variable Attributes</a>:
400 Specifying attributes of variables.<br>
401 <b>Supported:</b> <tt>cleanup</tt>, <tt>common</tt>, <tt>nocommon</tt>,
402 <tt>deprecated</tt>, <tt>transparent_union</tt>,
403 <tt>unused</tt>, <tt>weak</tt><br>
Misha Brukman500bc302003-11-22 00:38:41 +0000404
Chris Lattner79c3fe12003-10-02 04:57:28 +0000405 <b>Unsupported:</b> <tt>aligned</tt>, <tt>mode</tt>, <tt>packed</tt>,
406 <tt>section</tt>, <tt>shared</tt>, <tt>tls_model</tt>,
407 <tt>vector_size</tt>, <tt>dllimport</tt>,
Misha Brukman500bc302003-11-22 00:38:41 +0000408 <tt>dllexport</tt>, all target specific attributes.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000409
Misha Brukmanc4b7bee2003-12-12 04:37:31 +0000410 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Type-Attributes.html#Type%20Attributes">Type Attributes</a>: Specifying attributes of types.<br>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000411 <b>Supported:</b> <tt>transparent_union</tt>, <tt>unused</tt>,
Misha Brukmanc4b7bee2003-12-12 04:37:31 +0000412 <tt>deprecated</tt>, <tt>may_alias</tt><br>
Misha Brukman500bc302003-11-22 00:38:41 +0000413
414 <b>Unsupported:</b> <tt>aligned</tt>, <tt>packed</tt>,
415 all target specific attributes.</li>
416
Chris Lattner79c3fe12003-10-02 04:57:28 +0000417 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Other-Builtins.html#Other%20Builtins">Other Builtins</a>:
418 Other built-in functions.<br>
419 We support all builtins which have a C language equivalent (e.g.,
420 <tt>__builtin_cos</tt>), <tt>__builtin_alloca</tt>,
421 <tt>__builtin_types_compatible_p</tt>, <tt>__builtin_choose_expr</tt>,
Misha Brukman500bc302003-11-22 00:38:41 +0000422 <tt>__builtin_constant_p</tt>, and <tt>__builtin_expect</tt> (ignored).</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000423
Misha Brukman500bc302003-11-22 00:38:41 +0000424 </ol>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000425
Misha Brukman500bc302003-11-22 00:38:41 +0000426 <p>The following extensions <b>are</b> known to be supported:</p>
427
Chris Lattner79c3fe12003-10-02 04:57:28 +0000428 <ol>
Chris Lattner7fe97dd2004-03-16 08:54:07 +0000429 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Labels-as-Values.html#Labels%20as%20Values">Labels as Values</a>: Getting pointers to labels and computed gotos.</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000430 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Statement-Exprs.html#Statement%20Exprs">Statement Exprs</a>: Putting statements and declarations inside expressions.</li>
431 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Typeof.html#Typeof">Typeof</a>: <code>typeof</code>: referring to the type of an expression.</li>
432 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Lvalues.html#Lvalues">Lvalues</a>: Using <code>?:</code>, "<code>,</code>" and casts in lvalues.</li>
433 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Conditionals.html#Conditionals">Conditionals</a>: Omitting the middle operand of a <code>?:</code> expression.</li>
434 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Long-Long.html#Long%20Long">Long Long</a>: Double-word integers.</li>
435 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Complex.html#Complex">Complex</a>: Data types for complex numbers.</li>
436 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Hex-Floats.html#Hex%20Floats">Hex Floats</a>:Hexadecimal floating-point constants.</li>
437 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Zero-Length.html#Zero%20Length">Zero Length</a>: Zero-length arrays.</li>
438 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Empty-Structures.html#Empty%20Structures">Empty Structures</a>: Structures with no members.</li>
439 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variadic-Macros.html#Variadic%20Macros">Variadic Macros</a>: Macros with a variable number of arguments.</li>
440 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Escaped-Newlines.html#Escaped%20Newlines">Escaped Newlines</a>: Slightly looser rules for escaped newlines.</li>
441 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Subscripting.html#Subscripting">Subscripting</a>: Any array can be subscripted, even if not an lvalue.</li>
Misha Brukmanc4b7bee2003-12-12 04:37:31 +0000442 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Pointer-Arith.html#Pointer%20Arith">Pointer Arith</a>: Arithmetic on <code>void</code>-pointers and function pointers.</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000443 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Initializers.html#Initializers">Initializers</a>: Non-constant initializers.</li>
John Criswelld000e1d2003-12-18 16:43:17 +0000444 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Compound-Literals.html#Compound%20Literals">Compound Literals</a>: Compound literals give structures, unions,
445or arrays as values.</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000446 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Designated-Inits.html#Designated%20Inits">Designated Inits</a>: Labeling elements of initializers.</li>
Misha Brukmanc4b7bee2003-12-12 04:37:31 +0000447 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Cast-to-Union.html#Cast%20to%20Union">Cast to Union</a>: Casting to union type from any member of the union.</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000448 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Case-Ranges.html#Case%20Ranges">Case Ranges</a>: `case 1 ... 9' and such.</li>
449 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Mixed-Declarations.html#Mixed%20Declarations">Mixed Declarations</a>: Mixing declarations and code.</li>
450 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Prototypes.html#Function%20Prototypes">Function Prototypes</a>: Prototype declarations and old-style definitions.</li>
451 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/C---Comments.html#C++%20Comments">C++ Comments</a>: C++ comments are recognized.</li>
452 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Dollar-Signs.html#Dollar%20Signs">Dollar Signs</a>: Dollar sign is allowed in identifiers.</li>
453 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Character-Escapes.html#Character%20Escapes">Character Escapes</a>: <code>\e</code> stands for the character &lt;ESC&gt;.</li>
454 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Alignment.html#Alignment">Alignment</a>: Inquiring about the alignment of a type or variable.</li>
455 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Inline.html#Inline">Inline</a>: Defining inline functions (as fast as macros).</li>
456 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Alternate-Keywords.html#Alternate%20Keywords">Alternate Keywords</a>:<code>__const__</code>, <code>__asm__</code>, etc., for header files.</li>
457 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Incomplete-Enums.html#Incomplete%20Enums">Incomplete Enums</a>: <code>enum foo;</code>, with details to follow.</li>
458 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Names.html#Function%20Names">Function Names</a>: Printable strings which are the name of the current function.</li>
Chris Lattner25795bc2004-02-14 04:08:29 +0000459 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Return-Address.html#Return%20Address">Return Address</a>: Getting the return or frame address of a function.</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000460 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Unnamed-Fields.html#Unnamed%20Fields">Unnamed Fields</a>: Unnamed struct/union fields within structs/unions.</li>
461 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Attribute-Syntax.html#Attribute%20Syntax">Attribute Syntax</a>: Formal syntax for attributes.</li>
Misha Brukmane0c891c2003-11-22 01:00:11 +0000462 </ol></li>
463
464</ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000465
Misha Brukman500bc302003-11-22 00:38:41 +0000466<p>If you run into GCC extensions which have not been included in any of these
467lists, please let us know (also including whether or not they work).</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000468
Misha Brukman500bc302003-11-22 00:38:41 +0000469</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000470
Misha Brukman500bc302003-11-22 00:38:41 +0000471<!-- ======================================================================= -->
472<div class="doc_subsection">
473 <a name="c++-fe">Known problems with the C++ front-end</a>
474</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000475
Misha Brukman500bc302003-11-22 00:38:41 +0000476<div class="doc_text">
477
John Criswelld000e1d2003-12-18 16:43:17 +0000478<p>For this release, the C++ front-end is considered to be fully functional but
Chris Lattner9e848092003-12-12 04:25:33 +0000479has not been tested as thoroughly as the C front-end. It has been tested and
480works for a number of non-trivial programs, but there may be lurking bugs.
481Please report any bugs or problems.</p>
Misha Brukman500bc302003-11-22 00:38:41 +0000482
483</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000484
485<!-- _______________________________________________________________________ -->
Chris Lattner3a51be12004-02-14 04:12:41 +0000486<div class="doc_subsubsection">Bugs</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000487
Misha Brukman500bc302003-11-22 00:38:41 +0000488<div class="doc_text">
Chris Lattner79c3fe12003-10-02 04:57:28 +0000489
Misha Brukman500bc302003-11-22 00:38:41 +0000490<ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000491<li>The C++ front-end inherits all problems afflicting the <a href="#c-fe">C
John Criswelld000e1d2003-12-18 16:43:17 +0000492 front-end</a>.</li>
John Criswelld000e1d2003-12-18 16:43:17 +0000493</ul>
Misha Brukman500bc302003-11-22 00:38:41 +0000494</div>
495
496<!-- _______________________________________________________________________ -->
497<div class="doc_subsubsection">
498 Notes
499</div>
500
501<div class="doc_text">
502
503<ul>
Chris Lattnere01fcfb2003-10-27 18:30:37 +0000504
Chris Lattner79c3fe12003-10-02 04:57:28 +0000505<li>The C++ front-end is based on a pre-release of the GCC 3.4 C++ parser. This
506parser is significantly more standards compliant (and picky) than prior GCC
507versions. For more information, see the C++ section of the <a
Chris Lattner9e848092003-12-12 04:25:33 +0000508href="http://gcc.gnu.org/gcc-3.4/changes.html">GCC 3.4 release notes</a>.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000509
510<li>Destructors for local objects are not always run when a <tt>longjmp</tt> is
Chris Lattner19092612003-10-02 16:38:05 +0000511 performed. In particular, destructors for objects in the <tt>longjmp</tt>ing
Chris Lattner79c3fe12003-10-02 04:57:28 +0000512 function and in the <tt>setjmp</tt> receiver function may not be run.
John Criswelld000e1d2003-12-18 16:43:17 +0000513 Objects in intervening stack frames will be destroyed, however (which is
Misha Brukman500bc302003-11-22 00:38:41 +0000514 better than most compilers).</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000515
Chris Lattner19092612003-10-02 16:38:05 +0000516<li>The LLVM C++ front-end follows the <a
517 href="http://www.codesourcery.com/cxx-abi">Itanium C++ ABI</a>.
518 This document, which is not Itanium specific, specifies a standard for name
519 mangling, class layout, v-table layout, RTTI formats, and other C++
520 representation issues. Because we use this API, code generated by the LLVM
521 compilers should be binary compatible with machine code generated by other
522 Itanium ABI C++ compilers (such as G++, the Intel and HP compilers, etc).
523 <i>However</i>, the exception handling mechanism used by LLVM is very
524 different from the model used in the Itanium ABI, so <b>exceptions will not
Misha Brukman500bc302003-11-22 00:38:41 +0000525 interact correctly</b>. </li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000526
Misha Brukman500bc302003-11-22 00:38:41 +0000527</ul>
Chris Lattnerfcc54b32003-10-07 22:14:37 +0000528
Misha Brukman500bc302003-11-22 00:38:41 +0000529</div>
530
531<!-- ======================================================================= -->
532<div class="doc_subsection">
533 <a name="x86-be">Known problems with the X86 back-end</a>
534</div>
535
536<div class="doc_text">
537
538<ul>
Chris Lattnerde4afdc2004-02-08 22:23:33 +0000539<li>None so far.
Misha Brukman500bc302003-11-22 00:38:41 +0000540</ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000541
Misha Brukman500bc302003-11-22 00:38:41 +0000542</div>
543
544<!-- ======================================================================= -->
545<div class="doc_subsection">
546 <a name="sparc-be">Known problems with the Sparc back-end</a>
547</div>
548
549<div class="doc_text">
550
551<ul>
Chris Lattner6a39aa52004-03-19 19:22:28 +0000552<li>There are several programs in the LLVM testsuite that the Sparc code generator is known to miscompile.</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000553</ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000554
Misha Brukman500bc302003-11-22 00:38:41 +0000555</div>
556
557<!-- ======================================================================= -->
558<div class="doc_subsection">
559 <a name="c-be">Known problems with the C back-end</a>
560</div>
561
562<div class="doc_text">
563
564<ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000565
566<li>The C back-end produces code that violates the ANSI C Type-Based Alias
567Analysis rules. As such, special options may be necessary to compile the code
568(for example, GCC requires the <tt>-fno-strict-aliasing</tt> option). This
Misha Brukman500bc302003-11-22 00:38:41 +0000569problem probably cannot be fixed.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000570
Chris Lattnere84843b2003-10-20 19:05:03 +0000571<li><a href="http://llvm.cs.uiuc.edu/PR33">Initializers for global variables</a>
Misha Brukman500bc302003-11-22 00:38:41 +0000572cannot include special floating point numbers like Not-A-Number or
573Infinity.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000574
Chris Lattner2855ecd2003-11-04 20:06:53 +0000575<li><a href="http://llvm.cs.uiuc.edu/PR56">Zero arg vararg functions are not
Chris Lattner2af46052003-10-24 04:03:19 +0000576supported</a>. This should not affect LLVM produced by the C or C++
Misha Brukman500bc302003-11-22 00:38:41 +0000577frontends.</li>
Chris Lattner2af46052003-10-24 04:03:19 +0000578
Misha Brukman500bc302003-11-22 00:38:41 +0000579</ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000580
Misha Brukman500bc302003-11-22 00:38:41 +0000581</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000582
583<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000584<div class="doc_section">
585 <a name="additionalinfo">Additional Information</a>
586</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000587<!-- *********************************************************************** -->
588
Misha Brukman500bc302003-11-22 00:38:41 +0000589<div class="doc_text">
590
591<p>A wide variety of additional information is available on the LLVM web page,
John Criswelld000e1d2003-12-18 16:43:17 +0000592including mailing lists and publications describing algorithms and components
Chris Lattner79c3fe12003-10-02 04:57:28 +0000593implemented in LLVM. The web page also contains versions of the API
594documentation which is up-to-date with the CVS version of the source code. You
595can access versions of these documents specific to this release by going into
Misha Brukman500bc302003-11-22 00:38:41 +0000596the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000597
Misha Brukman500bc302003-11-22 00:38:41 +0000598<p>If you have any questions or comments about LLVM, please feel free to contact
Chris Lattner5eccca42003-12-12 21:22:16 +0000599us via the <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">mailing
600lists</a>.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000601
Misha Brukman500bc302003-11-22 00:38:41 +0000602</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000603
604<!-- *********************************************************************** -->
Chris Lattner79c3fe12003-10-02 04:57:28 +0000605
Misha Brukman500bc302003-11-22 00:38:41 +0000606<hr>
Misha Brukman2061e892003-11-22 01:23:39 +0000607<address>
Misha Brukman38847d52003-12-21 22:53:21 +0000608 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman2061e892003-11-22 01:23:39 +0000609 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
610 <a href="http://validator.w3.org/check/referer"><img
611 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
612
Misha Brukmane0c891c2003-11-22 01:00:11 +0000613 <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br>
Misha Brukman500bc302003-11-22 00:38:41 +0000614 Last modified: $Date$
Misha Brukman2061e892003-11-22 01:23:39 +0000615</address>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000616
Misha Brukman500bc302003-11-22 00:38:41 +0000617</body>
618</html>