blob: 9079cf53f06d48e346f917a435c3e3f65ecd6fc1 [file] [log] [blame]
Misha Brukman80731b92003-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 Lattner1a7e43c2004-04-01 00:41:31 +00006 <title>LLVM 1.3 Release Notes</title>
Misha Brukman80731b92003-11-22 00:38:41 +00007</head>
8<body>
Chris Lattner3d482502003-10-02 04:57:28 +00009
Chris Lattner1a7e43c2004-04-01 00:41:31 +000010<div class="doc_title">LLVM 1.3 Release Notes</div>
Chris Lattner3d482502003-10-02 04:57:28 +000011
12<ol>
Misha Brukman80731b92003-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 Lattner3d482502003-10-02 04:57:28 +000017 <li><a href="#knownproblems">Known Problems</a>
18 <ul>
Chris Lattner1a7e43c2004-04-01 00:41:31 +000019 <li><a href="#experimental">Experimental features included in this
20 release</a>
Chris Lattner3d482502003-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 Brukman80731b92003-11-22 00:38:41 +000027 </ul></li>
28 <li><a href="#additionalinfo">Additional Information</a></li>
Chris Lattner3d482502003-10-02 04:57:28 +000029</ol>
30
Misha Brukman7cb4e382003-11-22 01:00:11 +000031<div class="doc_text">
John Criswell86a3a482003-12-18 16:43:17 +000032 <p><b>Written by the <a href="http://llvm.cs.uiuc.edu">LLVM team</a></b><p>
Misha Brukman80731b92003-11-22 00:38:41 +000033</div>
Chris Lattner3d482502003-10-02 04:57:28 +000034
35<!-- *********************************************************************** -->
Misha Brukman80731b92003-11-22 00:38:41 +000036<div class="doc_section">
37 <a name="intro">Introduction</a>
38</div>
Chris Lattner3d482502003-10-02 04:57:28 +000039<!-- *********************************************************************** -->
40
Misha Brukman80731b92003-11-22 00:38:41 +000041<div class="doc_text">
42
43<p>This document contains the release notes for the LLVM compiler
Chris Lattner1a7e43c2004-04-01 00:41:31 +000044infrastructure, release 1.3. Here we describe the status of LLVM, including any
John Criswell86a3a482003-12-18 16:43:17 +000045known problems and bug fixes from the previous release. The most up-to-date
Misha Brukman80731b92003-11-22 00:38:41 +000046version of this document can be found on the <a
Chris Lattner1a7e43c2004-04-01 00:41:31 +000047href="http://llvm.cs.uiuc.edu/releases/1.3/">LLVM 1.3 web site</a>. If you are
John Criswell86a3a482003-12-18 16:43:17 +000048not reading this on the LLVM web pages, you should probably go there because
Misha Brukman80731b92003-11-22 00:38:41 +000049this document may be updated after the release.</p>
Chris Lattner62495762003-10-02 16:38:05 +000050
Misha Brukman80731b92003-11-22 00:38:41 +000051<p>For more information about LLVM, including information about potentially more
Chris Lattnere7525b52003-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 Brukman80731b92003-11-22 00:38:41 +000055list</a> is a good place to send them.</p>
Chris Lattner3d482502003-10-02 04:57:28 +000056
Chris Lattnere76e9ab2003-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 Brukman80731b92003-11-22 00:38:41 +000060href="http://llvm.cs.uiuc.edu/releases/">releases page</a>.</p>
61
62</div>
Chris Lattner3d482502003-10-02 04:57:28 +000063
64<!-- *********************************************************************** -->
Misha Brukman80731b92003-11-22 00:38:41 +000065<div class="doc_section">
66 <a name="whatsnew">What's New?</a>
67</div>
Chris Lattner3d482502003-10-02 04:57:28 +000068<!-- *********************************************************************** -->
69
Misha Brukman80731b92003-11-22 00:38:41 +000070<div class="doc_text">
71
Chris Lattner8ebf2532004-02-25 16:36:51 +000072<p>
Chris Lattner1a7e43c2004-04-01 00:41:31 +000073This is the fourth public release of the LLVM compiler infrastructure.
Chris Lattner5a8a7282003-12-14 05:03:43 +000074</p>
Chris Lattnerba7bd472003-12-06 20:22:41 +000075
Chris Lattner28202352004-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 Lattnerba7bd472003-12-06 20:22:41 +000082</p>
83
Chris Lattnerba7bd472003-12-06 20:22:41 +000084<!--=========================================================================-->
85<div class="doc_subsubsection">
Chris Lattner8ebf2532004-02-25 16:36:51 +000086<a name="newfeatures">This release implements the following new features:</a>
Chris Lattnerba7bd472003-12-06 20:22:41 +000087</div>
Chris Lattnere7525b52003-10-07 21:38:31 +000088
89<ol>
Chris Lattner1a7e43c2004-04-01 00:41:31 +000090<li>The LLVM <a href="LangRef.html#i_select"><tt>select</tt></a> instruction is
91now fully implemented and supported by all targets.</li>
Misha Brukman017f2f32004-04-19 02:56:49 +000092<li>Bugpoint can now narrow down code-generation bugs to a loop nest, where
93before it could only narrow them down to a function being miscompiled.</li>
Chris Lattner592db402003-11-19 22:05:38 +000094</ol>
Chris Lattner4491de62003-11-08 04:28:55 +000095
Chris Lattnerba7bd472003-12-06 20:22:41 +000096
97<!--=========================================================================-->
98<div class="doc_subsubsection">
99In this release, the following missing features were implemented:
100</div>
Chris Lattner4491de62003-11-08 04:28:55 +0000101
102<ol>
Misha Brukman017f2f32004-04-19 02:56:49 +0000103<li><a href="http://llvm.cs.uiuc.edu/PR82">LLVM cannot handle structures with
104more than 256 elements</a></li>
Misha Brukmane7050232004-04-19 03:01:01 +0000105<li><a href="http://llvm.cs.uiuc.edu/PR38">[bugpoint] External functions used in
106non-instruction entities, such as global constant initializer</a></li>
107<li><a href="http://llvm.cs.uiuc.edu/PR290">Bugpoint doesn't support
108uses of external fns by immediate constant exprs</a></li>
Misha Brukman80731b92003-11-22 00:38:41 +0000109</ol>
Chris Lattnere7525b52003-10-07 21:38:31 +0000110
Chris Lattnerba7bd472003-12-06 20:22:41 +0000111
112<!--=========================================================================-->
113<div class="doc_subsubsection">
Misha Brukman017f2f32004-04-19 02:56:49 +0000114<a name="qualityofimp">In this release, the following Quality of Implementation
115issues were fixed:</a>
Chris Lattner4df78f02003-12-20 03:42:11 +0000116</div>
117
118<ol>
Misha Brukman017f2f32004-04-19 02:56:49 +0000119<li><a href="http://llvm.cs.uiuc.edu/PR305">LLVM tools will happily spew
120bytecode onto your terminal</a></li>
Chris Lattner4df78f02003-12-20 03:42:11 +0000121</ol>
122
123<!--=========================================================================-->
124<div class="doc_subsubsection">
Chris Lattner8ebf2532004-02-25 16:36:51 +0000125In this release, the following build problems were fixed:
Brian Gaeke8b05e4f2004-01-16 21:55:04 +0000126</div>
127
128<ol>
Chris Lattner1a7e43c2004-04-01 00:41:31 +0000129<li></li>
Brian Gaeke8b05e4f2004-01-16 21:55:04 +0000130</ol>
131
132<!--=========================================================================-->
133<div class="doc_subsubsection">
Misha Brukman017f2f32004-04-19 02:56:49 +0000134<a name="codequality">In this release, the following Code Quality issues were
135fixed:</a>
Chris Lattnerba7bd472003-12-06 20:22:41 +0000136</div>
Chris Lattner639579c2003-10-27 17:06:39 +0000137
138<ol>
Chris Lattner54dcea82004-04-13 14:43:35 +0000139<li><a href="http://llvm.cs.uiuc.edu/PR309">[vmcore] Code quality problem due to
140long operand of getelementptr</a></li>
141
142<li>The X86 backend now generates substantially better code for 64-bit integer
143and floating point operations.</li>
144
145<li>The -inline pass no longer inlines mutually recursive functions until it
146hits the inlining threshold.</li>
147
148<li>The -inline pass no longer misses obvious inlining opportunities just
149because the callee eventually calls into an external function.</li>
150
151<li>The -simplifycfg pass can now "if convert" simple statements into the new
152<tt>select</tt> instruction.</li>
153
154<li>The -loopsimplify pass can now break <a
155href="http://llvm.cs.uiuc.edu/PR35">natural loops with multiple backedges</a>
156into multiple nested loops. This enables a variety of subsequent
157optimizations.</li>
158
159<li>The -adce pass can now eliminate calls to functions that do not not write to
160memory.</li>
161
162<li>The link-time optimizer now runs the -prune-eh pass (to remove unused
163exception handlers.</li>
164
Misha Brukman80731b92003-11-22 00:38:41 +0000165</ol>
Chris Lattner639579c2003-10-27 17:06:39 +0000166
Chris Lattnerba7bd472003-12-06 20:22:41 +0000167
168<!--=========================================================================-->
169<div class="doc_subsubsection">
Misha Brukman017f2f32004-04-19 02:56:49 +0000170<a name="bugfix">In this release, the following bugs in the previous release
171were fixed:</a>
Chris Lattnerba7bd472003-12-06 20:22:41 +0000172</div>
173
174<p>Bugs in the LLVM Core:</p>
Chris Lattnere7525b52003-10-07 21:38:31 +0000175
176<ol>
Misha Brukman017f2f32004-04-19 02:56:49 +0000177<li><a href="http://llvm.cs.uiuc.edu/PR306">[loopsimplify] Loop simplify
178incorrectly updates dominator information</a></li>
179<li><a href="http://llvm.cs.uiuc.edu/PR310">[tailduplicate] DemoteRegToStack
180breaks SSA form</a></li>
181<li><a href="http://llvm.cs.uiuc.edu/PR313">[X86] JIT miscompiles unsigned short
182to floating point cast</a></li>
Chris Lattnerba7bd472003-12-06 20:22:41 +0000183</ol>
184
185
Chris Lattner24fa5662004-02-09 21:22:51 +0000186
Chris Lattnerba7bd472003-12-06 20:22:41 +0000187<p>Bugs in the C/C++ front-end:</p>
188
189<ol>
Chris Lattner1a7e43c2004-04-01 00:41:31 +0000190<li></li>
Chris Lattnerba7bd472003-12-06 20:22:41 +0000191</ol>
Chris Lattner62495762003-10-02 16:38:05 +0000192
Misha Brukman80731b92003-11-22 00:38:41 +0000193</div>
Chris Lattner62495762003-10-02 16:38:05 +0000194
195<!-- *********************************************************************** -->
Misha Brukman80731b92003-11-22 00:38:41 +0000196<div class="doc_section">
197 <a name="portability">Portability and Supported Platforms</a>
198</div>
Chris Lattner62495762003-10-02 16:38:05 +0000199<!-- *********************************************************************** -->
200
Misha Brukman80731b92003-11-22 00:38:41 +0000201<div class="doc_text">
202
203<p>LLVM has been extensively tested on Intel and AMD machines running Red
Misha Brukman017f2f32004-04-19 02:56:49 +0000204Hat Linux and FreeBSD. It has also been tested on Sun UltraSPARC workstations
205running Solaris 8. Additionally, LLVM works on Mac OS X 10.3 and above, but
206only with the C backend or interpreter (no native backend for the PowerPC is
207available yet). The core LLVM infrastructure uses "autoconf" for portability,
208so hopefully we work on more platforms than that. However, it is likely that we
209missed something and that minor porting is required to get LLVM to work on new
210platforms. We welcome portability patches and error messages.</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000211
Misha Brukman80731b92003-11-22 00:38:41 +0000212</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000213
214<!-- *********************************************************************** -->
Misha Brukman80731b92003-11-22 00:38:41 +0000215<div class="doc_section">
216 <a name="knownproblems">Known Problems</a>
217</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000218<!-- *********************************************************************** -->
219
Misha Brukman80731b92003-11-22 00:38:41 +0000220<div class="doc_text">
221
222<p>This section contains all known problems with the LLVM system, listed by
Chris Lattner3d482502003-10-02 04:57:28 +0000223component. As new problems are discovered, they will be added to these
Chris Lattnerb84f3322003-12-12 21:22:16 +0000224sections. If you run into a problem, please check the <a
John Criswell86a3a482003-12-18 16:43:17 +0000225href="http://llvm.cs.uiuc.edu/bugs/">LLVM bug database</a> and submit a bug if
Chris Lattnerb84f3322003-12-12 21:22:16 +0000226there isn't already one.</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000227
Misha Brukman80731b92003-11-22 00:38:41 +0000228</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000229
Chris Lattnerb911de42004-03-14 02:03:02 +0000230<!-- ======================================================================= -->
231<div class="doc_subsection">
232 <a name="experimental">Experimental features included with this release</a>
233</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000234
Chris Lattnerb911de42004-03-14 02:03:02 +0000235<div class="doc_text">
236
237<p>
238The following components of this LLVM release are either untested, known to be
239broken or unreliable, or are in early development. These components should not
240be relied on, and bugs should not be filed against them, but they may be useful
241to some people. In particular, if you would like to work on one of these
242components, please contact us on the llvmdev list.
243</p>
244
245<ul>
246<li>The following passes are incomplete or buggy: <tt>-pgmdep, -memdep,
247 -ipmodref, -sortstructs, -swapstructs, -cee</tt></li>
248
249<li>The <tt>-pre</tt> pass is incomplete (there are cases it doesn't handle that
250 it should) and not thoroughly tested.</li>
251<li>The <tt>llvm-ar</tt> tool is incomplete and probably buggy.</li>
252<li>The <tt>llvm-db</tt> tool is in a very early stage of development.</li>
253</ul>
254
255</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000256
Misha Brukman80731b92003-11-22 00:38:41 +0000257<!-- ======================================================================= -->
258<div class="doc_subsection">
259 <a name="core">Known problems with the LLVM Core</a>
260</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000261
Misha Brukman80731b92003-11-22 00:38:41 +0000262<div class="doc_text">
263
264<ul>
265
266<li>In the JIT, <tt>dlsym</tt> on a symbol compiled by the JIT will not
267work.</li>
Chris Lattner3d482502003-10-02 04:57:28 +0000268
269<li>The JIT does not use mutexes to protect its internal data structures. As
Misha Brukman80731b92003-11-22 00:38:41 +0000270such, execution of a threaded program could cause these data structures to be
271corrupted.</li>
Chris Lattner3d482502003-10-02 04:57:28 +0000272
Misha Brukman80731b92003-11-22 00:38:41 +0000273<li>It is not possible to <tt>dlopen</tt> an LLVM bytecode file in the JIT.</li>
Chris Lattner3d482502003-10-02 04:57:28 +0000274
Chris Lattnera623e482003-10-20 19:05:03 +0000275<li>Linking in static archive files (.a files) is very slow (there is no symbol
Misha Brukman80731b92003-11-22 00:38:41 +0000276table in the archive).</li>
Chris Lattnerc679fbb2003-11-04 20:06:53 +0000277
Misha Brukman017f2f32004-04-19 02:56:49 +0000278<li>The gccld program <a href="http://llvm.cs.uiuc.edu/PR139">does not link
279objects/archives in the order specified on the command line.</a></li>
Chris Lattneraebc66a2004-02-15 23:09:07 +0000280
281<li><a href="http://llvm.cs.uiuc.edu/PR240">The lower-invoke pass does not mark
John Criswell5d6345a2004-03-12 21:29:42 +0000282values live across a setjmp as volatile</a>. This missing feature only affects
Chris Lattneraebc66a2004-02-15 23:09:07 +0000283targets whose setjmp/longjmp libraries do not save and restore the entire
284register file.</li>
Misha Brukman80731b92003-11-22 00:38:41 +0000285</ul>
Misha Brukman80731b92003-11-22 00:38:41 +0000286</div>
287
288<!-- ======================================================================= -->
289<div class="doc_subsection">
290 <a name="c-fe">Known problems with the C front-end</a>
291</div>
Chris Lattner178f3db2003-10-02 05:07:23 +0000292
Chris Lattner3d482502003-10-02 04:57:28 +0000293<!-- _______________________________________________________________________ -->
Chris Lattner5a8a7282003-12-14 05:03:43 +0000294<div class="doc_subsubsection">Bugs</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000295
Misha Brukman80731b92003-11-22 00:38:41 +0000296<div class="doc_text">
Misha Brukman80731b92003-11-22 00:38:41 +0000297<ul>
Chris Lattner3d482502003-10-02 04:57:28 +0000298<li>C99 Variable sized arrays do not release stack memory when they go out of
299 scope. Thus, the following program may run out of stack space:
300<pre>
301 for (i = 0; i != 1000000; ++i) {
302 int X[n];
303 foo(X);
304 }
Misha Brukman80731b92003-11-22 00:38:41 +0000305</pre></li>
Chris Lattner3d482502003-10-02 04:57:28 +0000306
John Criswell86a3a482003-12-18 16:43:17 +0000307<li>
308Initialization of global union variables can only be done
309<a href="http://llvm.cs.uiuc.edu/bugs/show_bug.cgi?id=162">with the largest
310union member</a>.
311</li>
Chris Lattner1ab58dd2004-03-16 21:39:04 +0000312
Misha Brukman017f2f32004-04-19 02:56:49 +0000313<li><a href="http://llvm.cs.uiuc.edu/PR244">[llvm-gcc] Error when an implicitly
314external function is re-declared as static</a></li>
Chris Lattner1ab58dd2004-03-16 21:39:04 +0000315
John Criswell86a3a482003-12-18 16:43:17 +0000316</ul>
Misha Brukman80731b92003-11-22 00:38:41 +0000317</div>
318
319<!-- _______________________________________________________________________ -->
320<div class="doc_subsubsection">
321 Notes
322</div>
323
324<div class="doc_text">
325
326<ul>
327
328<li>Inline assembly is not yet supported.</li>
Chris Lattnerd2a74272003-10-27 18:30:37 +0000329
330<li>"long double" is transformed by the front-end into "double". There is no
Misha Brukman80731b92003-11-22 00:38:41 +0000331support for floating point data types of any size other than 32 and 64
332bits.</li>
333
334<li>The following Unix system functionality has not been tested and may not
335work:
Misha Brukman7cb4e382003-11-22 01:00:11 +0000336 <ol>
337 <li><tt>sigsetjmp</tt>, <tt>siglongjmp</tt> - These are not turned into the
338 appropriate <tt>invoke</tt>/<tt>unwind</tt> instructions. Note that
339 <tt>setjmp</tt> and <tt>longjmp</tt> <em>are</em> compiled correctly.
340 <li><tt>getcontext</tt>, <tt>setcontext</tt>, <tt>makecontext</tt>
341 - These functions have not been tested.
342 </ol></li>
Chris Lattner3d482502003-10-02 04:57:28 +0000343
344<li>Although many GCC extensions are supported, some are not. In particular,
345 the following extensions are known to <b>not be</b> supported:
346 <ol>
Misha Brukman80731b92003-11-22 00:38:41 +0000347 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Local-Labels.html#Local%20Labels">Local Labels</a>: Labels local to a block.</li>
Misha Brukman80731b92003-11-22 00:38:41 +0000348 <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>
349 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Constructing-Calls.html#Constructing%20Calls">Constructing Calls</a>: Dispatching a call to another function.</li>
350 <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 Criswell86a3a482003-12-18 16:43:17 +0000351 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Constraints.html#Constraints">Constraints</a>: Constraints for asm operands.</li>
Misha Brukman80731b92003-11-22 00:38:41 +0000352 <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>
353 <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 Brukman80731b92003-11-22 00:38:41 +0000354 <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>
355 <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>
356 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Thread-Local.html#Thread-Local">Thread-Local</a>: Per-thread variables.</li>
357 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Pragmas.html#Pragmas">Pragmas</a>: Pragmas accepted by GCC.</li>
Misha Brukman7cb4e382003-11-22 01:00:11 +0000358 </ol>
Chris Lattner3d482502003-10-02 04:57:28 +0000359
Misha Brukman80731b92003-11-22 00:38:41 +0000360 <p>The following GCC extensions are <b>partially</b> supported. An ignored
Chris Lattner3d482502003-10-02 04:57:28 +0000361 attribute means that the LLVM compiler ignores the presence of the attribute,
362 but the code should still work. An unsupported attribute is one which is
John Criswell86a3a482003-12-18 16:43:17 +0000363 ignored by the LLVM compiler and will cause a different interpretation of
Misha Brukman80731b92003-11-22 00:38:41 +0000364 the program.</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000365
366 <ol>
367 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Length.html#Variable%20Length">Variable Length</a>:
368 Arrays whose length is computed at run time.<br>
Misha Brukman80731b92003-11-22 00:38:41 +0000369 Supported, but allocated stack space is not freed until the function returns (noted above).</li>
Chris Lattner3d482502003-10-02 04:57:28 +0000370
371 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Attributes.html#Function%20Attributes">Function Attributes</a>:
Misha Brukman80731b92003-11-22 00:38:41 +0000372
John Criswell86a3a482003-12-18 16:43:17 +0000373 Declaring that functions have no side effects or that they can never
Misha Brukman80731b92003-11-22 00:38:41 +0000374 return.<br>
375
376 <b>Supported:</b> <tt>format</tt>, <tt>format_arg</tt>, <tt>non_null</tt>,
377 <tt>constructor</tt>, <tt>destructor</tt>, <tt>unused</tt>,
378 <tt>deprecated</tt>, <tt>warn_unused_result</tt>, <tt>weak</tt><br>
379
380 <b>Ignored:</b> <tt>noreturn</tt>, <tt>noinline</tt>,
381 <tt>always_inline</tt>, <tt>pure</tt>, <tt>const</tt>, <tt>nothrow</tt>,
382 <tt>malloc</tt>, <tt>no_instrument_function</tt>, <tt>cdecl</tt><br>
383
384 <b>Unsupported:</b> <tt>used</tt>, <tt>section</tt>, <tt>alias</tt>,
385 <tt>visibility</tt>, <tt>regparm</tt>, <tt>stdcall</tt>,
386 <tt>fastcall</tt>, all other target specific attributes</li>
Chris Lattner3d482502003-10-02 04:57:28 +0000387
388 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Attributes.html#Variable%20Attributes">Variable Attributes</a>:
389 Specifying attributes of variables.<br>
390 <b>Supported:</b> <tt>cleanup</tt>, <tt>common</tt>, <tt>nocommon</tt>,
391 <tt>deprecated</tt>, <tt>transparent_union</tt>,
392 <tt>unused</tt>, <tt>weak</tt><br>
Misha Brukman80731b92003-11-22 00:38:41 +0000393
Chris Lattner3d482502003-10-02 04:57:28 +0000394 <b>Unsupported:</b> <tt>aligned</tt>, <tt>mode</tt>, <tt>packed</tt>,
395 <tt>section</tt>, <tt>shared</tt>, <tt>tls_model</tt>,
396 <tt>vector_size</tt>, <tt>dllimport</tt>,
Misha Brukman80731b92003-11-22 00:38:41 +0000397 <tt>dllexport</tt>, all target specific attributes.</li>
Chris Lattner3d482502003-10-02 04:57:28 +0000398
Misha Brukman8395d732003-12-12 04:37:31 +0000399 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Type-Attributes.html#Type%20Attributes">Type Attributes</a>: Specifying attributes of types.<br>
Chris Lattner3d482502003-10-02 04:57:28 +0000400 <b>Supported:</b> <tt>transparent_union</tt>, <tt>unused</tt>,
Misha Brukman8395d732003-12-12 04:37:31 +0000401 <tt>deprecated</tt>, <tt>may_alias</tt><br>
Misha Brukman80731b92003-11-22 00:38:41 +0000402
403 <b>Unsupported:</b> <tt>aligned</tt>, <tt>packed</tt>,
404 all target specific attributes.</li>
405
Chris Lattner3d482502003-10-02 04:57:28 +0000406 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Other-Builtins.html#Other%20Builtins">Other Builtins</a>:
407 Other built-in functions.<br>
408 We support all builtins which have a C language equivalent (e.g.,
409 <tt>__builtin_cos</tt>), <tt>__builtin_alloca</tt>,
410 <tt>__builtin_types_compatible_p</tt>, <tt>__builtin_choose_expr</tt>,
Misha Brukman80731b92003-11-22 00:38:41 +0000411 <tt>__builtin_constant_p</tt>, and <tt>__builtin_expect</tt> (ignored).</li>
Chris Lattner3d482502003-10-02 04:57:28 +0000412
Misha Brukman80731b92003-11-22 00:38:41 +0000413 </ol>
Chris Lattner3d482502003-10-02 04:57:28 +0000414
Misha Brukman80731b92003-11-22 00:38:41 +0000415 <p>The following extensions <b>are</b> known to be supported:</p>
416
Chris Lattner3d482502003-10-02 04:57:28 +0000417 <ol>
Chris Lattnerd3dc8502004-03-16 08:54:07 +0000418 <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 Brukman80731b92003-11-22 00:38:41 +0000419 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Statement-Exprs.html#Statement%20Exprs">Statement Exprs</a>: Putting statements and declarations inside expressions.</li>
420 <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>
421 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Lvalues.html#Lvalues">Lvalues</a>: Using <code>?:</code>, "<code>,</code>" and casts in lvalues.</li>
422 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Conditionals.html#Conditionals">Conditionals</a>: Omitting the middle operand of a <code>?:</code> expression.</li>
423 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Long-Long.html#Long%20Long">Long Long</a>: Double-word integers.</li>
424 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Complex.html#Complex">Complex</a>: Data types for complex numbers.</li>
425 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Hex-Floats.html#Hex%20Floats">Hex Floats</a>:Hexadecimal floating-point constants.</li>
426 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Zero-Length.html#Zero%20Length">Zero Length</a>: Zero-length arrays.</li>
427 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Empty-Structures.html#Empty%20Structures">Empty Structures</a>: Structures with no members.</li>
428 <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>
429 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Escaped-Newlines.html#Escaped%20Newlines">Escaped Newlines</a>: Slightly looser rules for escaped newlines.</li>
430 <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 Brukman8395d732003-12-12 04:37:31 +0000431 <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 Brukman80731b92003-11-22 00:38:41 +0000432 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Initializers.html#Initializers">Initializers</a>: Non-constant initializers.</li>
John Criswell86a3a482003-12-18 16:43:17 +0000433 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Compound-Literals.html#Compound%20Literals">Compound Literals</a>: Compound literals give structures, unions,
434or arrays as values.</li>
Misha Brukman80731b92003-11-22 00:38:41 +0000435 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Designated-Inits.html#Designated%20Inits">Designated Inits</a>: Labeling elements of initializers.</li>
Misha Brukman8395d732003-12-12 04:37:31 +0000436 <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 Brukman80731b92003-11-22 00:38:41 +0000437 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Case-Ranges.html#Case%20Ranges">Case Ranges</a>: `case 1 ... 9' and such.</li>
438 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Mixed-Declarations.html#Mixed%20Declarations">Mixed Declarations</a>: Mixing declarations and code.</li>
439 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Prototypes.html#Function%20Prototypes">Function Prototypes</a>: Prototype declarations and old-style definitions.</li>
440 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/C---Comments.html#C++%20Comments">C++ Comments</a>: C++ comments are recognized.</li>
441 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Dollar-Signs.html#Dollar%20Signs">Dollar Signs</a>: Dollar sign is allowed in identifiers.</li>
442 <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>
443 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Alignment.html#Alignment">Alignment</a>: Inquiring about the alignment of a type or variable.</li>
444 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Inline.html#Inline">Inline</a>: Defining inline functions (as fast as macros).</li>
445 <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>
446 <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>
447 <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 Lattner3646dad2004-02-14 04:08:29 +0000448 <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 Brukman80731b92003-11-22 00:38:41 +0000449 <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>
450 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Attribute-Syntax.html#Attribute%20Syntax">Attribute Syntax</a>: Formal syntax for attributes.</li>
Misha Brukman7cb4e382003-11-22 01:00:11 +0000451 </ol></li>
452
453</ul>
Chris Lattner3d482502003-10-02 04:57:28 +0000454
Misha Brukman80731b92003-11-22 00:38:41 +0000455<p>If you run into GCC extensions which have not been included in any of these
456lists, please let us know (also including whether or not they work).</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000457
Misha Brukman80731b92003-11-22 00:38:41 +0000458</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000459
Misha Brukman80731b92003-11-22 00:38:41 +0000460<!-- ======================================================================= -->
461<div class="doc_subsection">
462 <a name="c++-fe">Known problems with the C++ front-end</a>
463</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000464
Misha Brukman80731b92003-11-22 00:38:41 +0000465<div class="doc_text">
466
John Criswell86a3a482003-12-18 16:43:17 +0000467<p>For this release, the C++ front-end is considered to be fully functional but
Chris Lattnere76e9ab2003-12-12 04:25:33 +0000468has not been tested as thoroughly as the C front-end. It has been tested and
469works for a number of non-trivial programs, but there may be lurking bugs.
470Please report any bugs or problems.</p>
Misha Brukman80731b92003-11-22 00:38:41 +0000471
472</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000473
474<!-- _______________________________________________________________________ -->
Chris Lattner141ebb62004-02-14 04:12:41 +0000475<div class="doc_subsubsection">Bugs</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000476
Misha Brukman80731b92003-11-22 00:38:41 +0000477<div class="doc_text">
Chris Lattner3d482502003-10-02 04:57:28 +0000478
Misha Brukman80731b92003-11-22 00:38:41 +0000479<ul>
Chris Lattner3d482502003-10-02 04:57:28 +0000480<li>The C++ front-end inherits all problems afflicting the <a href="#c-fe">C
John Criswell86a3a482003-12-18 16:43:17 +0000481 front-end</a>.</li>
John Criswell86a3a482003-12-18 16:43:17 +0000482</ul>
Misha Brukman80731b92003-11-22 00:38:41 +0000483</div>
484
485<!-- _______________________________________________________________________ -->
486<div class="doc_subsubsection">
487 Notes
488</div>
489
490<div class="doc_text">
491
492<ul>
Chris Lattnerd2a74272003-10-27 18:30:37 +0000493
Chris Lattner3d482502003-10-02 04:57:28 +0000494<li>The C++ front-end is based on a pre-release of the GCC 3.4 C++ parser. This
495parser is significantly more standards compliant (and picky) than prior GCC
496versions. For more information, see the C++ section of the <a
Chris Lattnere76e9ab2003-12-12 04:25:33 +0000497href="http://gcc.gnu.org/gcc-3.4/changes.html">GCC 3.4 release notes</a>.</li>
Chris Lattner3d482502003-10-02 04:57:28 +0000498
499<li>Destructors for local objects are not always run when a <tt>longjmp</tt> is
Chris Lattner62495762003-10-02 16:38:05 +0000500 performed. In particular, destructors for objects in the <tt>longjmp</tt>ing
Chris Lattner3d482502003-10-02 04:57:28 +0000501 function and in the <tt>setjmp</tt> receiver function may not be run.
John Criswell86a3a482003-12-18 16:43:17 +0000502 Objects in intervening stack frames will be destroyed, however (which is
Misha Brukman80731b92003-11-22 00:38:41 +0000503 better than most compilers).</li>
Chris Lattner3d482502003-10-02 04:57:28 +0000504
Chris Lattner62495762003-10-02 16:38:05 +0000505<li>The LLVM C++ front-end follows the <a
506 href="http://www.codesourcery.com/cxx-abi">Itanium C++ ABI</a>.
507 This document, which is not Itanium specific, specifies a standard for name
508 mangling, class layout, v-table layout, RTTI formats, and other C++
509 representation issues. Because we use this API, code generated by the LLVM
510 compilers should be binary compatible with machine code generated by other
511 Itanium ABI C++ compilers (such as G++, the Intel and HP compilers, etc).
512 <i>However</i>, the exception handling mechanism used by LLVM is very
513 different from the model used in the Itanium ABI, so <b>exceptions will not
Misha Brukman80731b92003-11-22 00:38:41 +0000514 interact correctly</b>. </li>
Chris Lattner3d482502003-10-02 04:57:28 +0000515
Misha Brukman80731b92003-11-22 00:38:41 +0000516</ul>
Chris Lattner46ecf612003-10-07 22:14:37 +0000517
Misha Brukman80731b92003-11-22 00:38:41 +0000518</div>
519
520<!-- ======================================================================= -->
521<div class="doc_subsection">
522 <a name="x86-be">Known problems with the X86 back-end</a>
523</div>
524
525<div class="doc_text">
526
527<ul>
Chris Lattnerc5b7b242004-02-08 22:23:33 +0000528<li>None so far.
Misha Brukman80731b92003-11-22 00:38:41 +0000529</ul>
Chris Lattner3d482502003-10-02 04:57:28 +0000530
Misha Brukman80731b92003-11-22 00:38:41 +0000531</div>
532
533<!-- ======================================================================= -->
534<div class="doc_subsection">
535 <a name="sparc-be">Known problems with the Sparc back-end</a>
536</div>
537
538<div class="doc_text">
539
540<ul>
Chris Lattner9e0b81c2004-03-19 19:22:28 +0000541<li>There are several programs in the LLVM testsuite that the Sparc code generator is known to miscompile.</li>
Misha Brukman80731b92003-11-22 00:38:41 +0000542</ul>
Chris Lattner3d482502003-10-02 04:57:28 +0000543
Misha Brukman80731b92003-11-22 00:38:41 +0000544</div>
545
546<!-- ======================================================================= -->
547<div class="doc_subsection">
548 <a name="c-be">Known problems with the C back-end</a>
549</div>
550
551<div class="doc_text">
552
553<ul>
Chris Lattner3d482502003-10-02 04:57:28 +0000554
555<li>The C back-end produces code that violates the ANSI C Type-Based Alias
556Analysis rules. As such, special options may be necessary to compile the code
557(for example, GCC requires the <tt>-fno-strict-aliasing</tt> option). This
Misha Brukman80731b92003-11-22 00:38:41 +0000558problem probably cannot be fixed.</li>
Chris Lattner3d482502003-10-02 04:57:28 +0000559
Chris Lattnera623e482003-10-20 19:05:03 +0000560<li><a href="http://llvm.cs.uiuc.edu/PR33">Initializers for global variables</a>
Misha Brukman80731b92003-11-22 00:38:41 +0000561cannot include special floating point numbers like Not-A-Number or
562Infinity.</li>
Chris Lattner3d482502003-10-02 04:57:28 +0000563
Chris Lattnerc679fbb2003-11-04 20:06:53 +0000564<li><a href="http://llvm.cs.uiuc.edu/PR56">Zero arg vararg functions are not
Chris Lattnerb28c3282003-10-24 04:03:19 +0000565supported</a>. This should not affect LLVM produced by the C or C++
Misha Brukman80731b92003-11-22 00:38:41 +0000566frontends.</li>
Chris Lattnerb28c3282003-10-24 04:03:19 +0000567
Misha Brukman80731b92003-11-22 00:38:41 +0000568</ul>
Chris Lattner3d482502003-10-02 04:57:28 +0000569
Misha Brukman80731b92003-11-22 00:38:41 +0000570</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000571
572<!-- *********************************************************************** -->
Misha Brukman80731b92003-11-22 00:38:41 +0000573<div class="doc_section">
574 <a name="additionalinfo">Additional Information</a>
575</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000576<!-- *********************************************************************** -->
577
Misha Brukman80731b92003-11-22 00:38:41 +0000578<div class="doc_text">
579
580<p>A wide variety of additional information is available on the LLVM web page,
John Criswell86a3a482003-12-18 16:43:17 +0000581including mailing lists and publications describing algorithms and components
Chris Lattner3d482502003-10-02 04:57:28 +0000582implemented in LLVM. The web page also contains versions of the API
583documentation which is up-to-date with the CVS version of the source code. You
584can access versions of these documents specific to this release by going into
Misha Brukman80731b92003-11-22 00:38:41 +0000585the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000586
Misha Brukman80731b92003-11-22 00:38:41 +0000587<p>If you have any questions or comments about LLVM, please feel free to contact
Chris Lattnerb84f3322003-12-12 21:22:16 +0000588us via the <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">mailing
589lists</a>.</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000590
Misha Brukman80731b92003-11-22 00:38:41 +0000591</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000592
593<!-- *********************************************************************** -->
Chris Lattner3d482502003-10-02 04:57:28 +0000594
Misha Brukman80731b92003-11-22 00:38:41 +0000595<hr>
Misha Brukman68aab3b2003-11-22 01:23:39 +0000596<address>
Misha Brukman8834af92003-12-21 22:53:21 +0000597 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman68aab3b2003-11-22 01:23:39 +0000598 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
599 <a href="http://validator.w3.org/check/referer"><img
600 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
601
Misha Brukman7cb4e382003-11-22 01:00:11 +0000602 <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br>
Misha Brukman80731b92003-11-22 00:38:41 +0000603 Last modified: $Date$
Misha Brukman68aab3b2003-11-22 01:23:39 +0000604</address>
Chris Lattner3d482502003-10-02 04:57:28 +0000605
Misha Brukman80731b92003-11-22 00:38:41 +0000606</body>
607</html>