blob: 690c7fdd8af3f4cca5334b26a4b2134b6360f855 [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>
Chris Lattner4b538b92004-04-30 22:17:12 +000015 <li><a href="GettingStarted.html">Installation Instructions</a></li>
Misha Brukman500bc302003-11-22 00:38:41 +000016 <li><a href="#portability">Portability and Supported Platforms</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
Chris Lattner6e1ef192004-05-02 04:19:15 +000091now fully implemented and supported by all transformations, native code
92generators, and the interpreter.</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 Lattner6e1ef192004-05-02 04:19:15 +000095<li>The Control Flow Graph in the native code generators is no longer
96constrained to be the same as the CFG for the LLVM input code.</li>
97<li>The LLVM induction variable analysis routines have been rewritten.</li>
98<li>LLVM now has new loop unrolling and loop unswitching passes.</li>
99<li>The induction variable substitution pass performs linear function test
100replacement and exit value replacement optimizations.</li>
Chris Lattner55ee0312003-11-19 22:05:38 +0000101</ol>
Chris Lattner0ef19062003-11-08 04:28:55 +0000102
Chris Lattnera5099962003-12-06 20:22:41 +0000103
104<!--=========================================================================-->
105<div class="doc_subsubsection">
106In this release, the following missing features were implemented:
107</div>
Chris Lattner0ef19062003-11-08 04:28:55 +0000108
109<ol>
Misha Brukmana7aadf12004-04-19 02:56:49 +0000110<li><a href="http://llvm.cs.uiuc.edu/PR82">LLVM cannot handle structures with
111more than 256 elements</a></li>
Misha Brukmancb003362004-04-19 03:01:01 +0000112<li><a href="http://llvm.cs.uiuc.edu/PR38">[bugpoint] External functions used in
113non-instruction entities, such as global constant initializer</a></li>
114<li><a href="http://llvm.cs.uiuc.edu/PR290">Bugpoint doesn't support
115uses of external fns by immediate constant exprs</a></li>
Misha Brukman500bc302003-11-22 00:38:41 +0000116</ol>
Chris Lattner47ad72c2003-10-07 21:38:31 +0000117
Chris Lattnera5099962003-12-06 20:22:41 +0000118
119<!--=========================================================================-->
120<div class="doc_subsubsection">
Misha Brukmana7aadf12004-04-19 02:56:49 +0000121<a name="qualityofimp">In this release, the following Quality of Implementation
122issues were fixed:</a>
Chris Lattnere29ac162003-12-20 03:42:11 +0000123</div>
124
125<ol>
Misha Brukmana7aadf12004-04-19 02:56:49 +0000126<li><a href="http://llvm.cs.uiuc.edu/PR305">LLVM tools will happily spew
127bytecode onto your terminal</a></li>
Chris Lattnere29ac162003-12-20 03:42:11 +0000128</ol>
129
130<!--=========================================================================-->
131<div class="doc_subsubsection">
Chris Lattnera39719f2004-02-25 16:36:51 +0000132In this release, the following build problems were fixed:
Brian Gaeke6b31beb2004-01-16 21:55:04 +0000133</div>
134
135<ol>
Brian Gaeke21a710a2004-04-20 18:18:46 +0000136<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 +0000137</ol>
138
139<!--=========================================================================-->
140<div class="doc_subsubsection">
Chris Lattner6e1ef192004-05-02 04:19:15 +0000141<a name="codequality">This release includes the following Code Quality
142improvements:</a>
Chris Lattnera5099962003-12-06 20:22:41 +0000143</div>
Chris Lattner89ca2b82003-10-27 17:06:39 +0000144
145<ol>
Chris Lattner6e1ef192004-05-02 04:19:15 +0000146<li>Fixed: <a href="http://llvm.cs.uiuc.edu/PR309">[vmcore] Code quality problem
147due to long operand of getelementptr</a></li>
Chris Lattner64913402004-04-13 14:43:35 +0000148
149<li>The X86 backend now generates substantially better code for 64-bit integer
150and floating point operations.</li>
151
152<li>The -inline pass no longer inlines mutually recursive functions until it
153hits the inlining threshold.</li>
154
155<li>The -inline pass no longer misses obvious inlining opportunities just
156because the callee eventually calls into an external function.</li>
157
158<li>The -simplifycfg pass can now "if convert" simple statements into the new
159<tt>select</tt> instruction.</li>
160
161<li>The -loopsimplify pass can now break <a
162href="http://llvm.cs.uiuc.edu/PR35">natural loops with multiple backedges</a>
163into multiple nested loops. This enables a variety of subsequent
164optimizations.</li>
165
166<li>The -adce pass can now eliminate calls to functions that do not not write to
167memory.</li>
168
169<li>The link-time optimizer now runs the -prune-eh pass (to remove unused
170exception handlers.</li>
171
Chris Lattner6e1ef192004-05-02 04:19:15 +0000172<li>The -simplifycfg pass can now eliminate simple correlated branches (such as
173"<tt>if (A &lt; B &amp;&amp; A &lt; B)</tt>", and can turn short-circuiting
174operators into the strict versions when useful (such as "<tt>if (A &lt; B || A
175&gt; C)</tt>" into "<tt>if (A &lt; B | A &gt; C)</tt>"</li>
176
Misha Brukman500bc302003-11-22 00:38:41 +0000177</ol>
Chris Lattner89ca2b82003-10-27 17:06:39 +0000178
Chris Lattnera5099962003-12-06 20:22:41 +0000179
180<!--=========================================================================-->
181<div class="doc_subsubsection">
Misha Brukmana7aadf12004-04-19 02:56:49 +0000182<a name="bugfix">In this release, the following bugs in the previous release
183were fixed:</a>
Chris Lattnera5099962003-12-06 20:22:41 +0000184</div>
185
186<p>Bugs in the LLVM Core:</p>
Chris Lattner47ad72c2003-10-07 21:38:31 +0000187
188<ol>
Misha Brukmana7aadf12004-04-19 02:56:49 +0000189<li><a href="http://llvm.cs.uiuc.edu/PR306">[loopsimplify] Loop simplify
190incorrectly updates dominator information</a></li>
191<li><a href="http://llvm.cs.uiuc.edu/PR310">[tailduplicate] DemoteRegToStack
192breaks SSA form</a></li>
193<li><a href="http://llvm.cs.uiuc.edu/PR313">[X86] JIT miscompiles unsigned short
194to floating point cast</a></li>
Chris Lattnera5099962003-12-06 20:22:41 +0000195</ol>
196
197
Chris Lattner56e67052004-02-09 21:22:51 +0000198
Chris Lattnera5099962003-12-06 20:22:41 +0000199<p>Bugs in the C/C++ front-end:</p>
200
201<ol>
Chris Lattner6df29c62004-04-21 18:52:06 +0000202<li><a href="http://llvm.cs.uiuc.edu/PR326">[llvmgcc] Crash on use of undeclared enum type</a></li></li>
Chris Lattnera5099962003-12-06 20:22:41 +0000203</ol>
Chris Lattner19092612003-10-02 16:38:05 +0000204
Misha Brukman500bc302003-11-22 00:38:41 +0000205</div>
Chris Lattner19092612003-10-02 16:38:05 +0000206
207<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000208<div class="doc_section">
209 <a name="portability">Portability and Supported Platforms</a>
210</div>
Chris Lattner19092612003-10-02 16:38:05 +0000211<!-- *********************************************************************** -->
212
Misha Brukman500bc302003-11-22 00:38:41 +0000213<div class="doc_text">
214
215<p>LLVM has been extensively tested on Intel and AMD machines running Red
Misha Brukmana7aadf12004-04-19 02:56:49 +0000216Hat Linux and FreeBSD. It has also been tested on Sun UltraSPARC workstations
217running Solaris 8. Additionally, LLVM works on Mac OS X 10.3 and above, but
218only with the C backend or interpreter (no native backend for the PowerPC is
219available yet). The core LLVM infrastructure uses "autoconf" for portability,
220so hopefully we work on more platforms than that. However, it is likely that we
221missed something and that minor porting is required to get LLVM to work on new
222platforms. We welcome portability patches and error messages.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000223
Misha Brukman500bc302003-11-22 00:38:41 +0000224</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000225
Brian Gaeke21a710a2004-04-20 18:18:46 +0000226<!--=========================================================================-->
227<div class="doc_subsection">
228In this release, the following portability problems were fixed:
229</div>
230
231<ol>
232<li><a href="http://llvm.cs.uiuc.edu/PR304">warnings compiling Stacker compiler on Mac OS X</a></li>
233<li><a href="http://llvm.cs.uiuc.edu/PR308">getObjectType doesn't understand abbreviated names in headers</a></li>
234</ol>
235
Chris Lattner79c3fe12003-10-02 04:57:28 +0000236<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000237<div class="doc_section">
238 <a name="knownproblems">Known Problems</a>
239</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000240<!-- *********************************************************************** -->
241
Misha Brukman500bc302003-11-22 00:38:41 +0000242<div class="doc_text">
243
244<p>This section contains all known problems with the LLVM system, listed by
Chris Lattner79c3fe12003-10-02 04:57:28 +0000245component. As new problems are discovered, they will be added to these
Chris Lattner5eccca42003-12-12 21:22:16 +0000246sections. If you run into a problem, please check the <a
John Criswelld000e1d2003-12-18 16:43:17 +0000247href="http://llvm.cs.uiuc.edu/bugs/">LLVM bug database</a> and submit a bug if
Chris Lattner5eccca42003-12-12 21:22:16 +0000248there isn't already one.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000249
Misha Brukman500bc302003-11-22 00:38:41 +0000250</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000251
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000252<!-- ======================================================================= -->
253<div class="doc_subsection">
254 <a name="experimental">Experimental features included with this release</a>
255</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000256
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000257<div class="doc_text">
258
259<p>
260The following components of this LLVM release are either untested, known to be
261broken or unreliable, or are in early development. These components should not
262be relied on, and bugs should not be filed against them, but they may be useful
263to some people. In particular, if you would like to work on one of these
264components, please contact us on the llvmdev list.
265</p>
266
267<ul>
268<li>The following passes are incomplete or buggy: <tt>-pgmdep, -memdep,
269 -ipmodref, -sortstructs, -swapstructs, -cee</tt></li>
270
271<li>The <tt>-pre</tt> pass is incomplete (there are cases it doesn't handle that
272 it should) and not thoroughly tested.</li>
273<li>The <tt>llvm-ar</tt> tool is incomplete and probably buggy.</li>
274<li>The <tt>llvm-db</tt> tool is in a very early stage of development.</li>
275</ul>
276
277</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000278
Misha Brukman500bc302003-11-22 00:38:41 +0000279<!-- ======================================================================= -->
280<div class="doc_subsection">
281 <a name="core">Known problems with the LLVM Core</a>
282</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000283
Misha Brukman500bc302003-11-22 00:38:41 +0000284<div class="doc_text">
285
286<ul>
287
288<li>In the JIT, <tt>dlsym</tt> on a symbol compiled by the JIT will not
289work.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000290
291<li>The JIT does not use mutexes to protect its internal data structures. As
Misha Brukman500bc302003-11-22 00:38:41 +0000292such, execution of a threaded program could cause these data structures to be
293corrupted.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000294
Misha Brukman500bc302003-11-22 00:38:41 +0000295<li>It is not possible to <tt>dlopen</tt> an LLVM bytecode file in the JIT.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000296
Chris Lattnere84843b2003-10-20 19:05:03 +0000297<li>Linking in static archive files (.a files) is very slow (there is no symbol
Misha Brukman500bc302003-11-22 00:38:41 +0000298table in the archive).</li>
Chris Lattner2855ecd2003-11-04 20:06:53 +0000299
Misha Brukmana7aadf12004-04-19 02:56:49 +0000300<li>The gccld program <a href="http://llvm.cs.uiuc.edu/PR139">does not link
301objects/archives in the order specified on the command line.</a></li>
Chris Lattner2e6fcaf2004-02-15 23:09:07 +0000302
303<li><a href="http://llvm.cs.uiuc.edu/PR240">The lower-invoke pass does not mark
John Criswelld46c6962004-03-12 21:29:42 +0000304values live across a setjmp as volatile</a>. This missing feature only affects
Chris Lattner2e6fcaf2004-02-15 23:09:07 +0000305targets whose setjmp/longjmp libraries do not save and restore the entire
306register file.</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000307</ul>
Misha Brukman500bc302003-11-22 00:38:41 +0000308</div>
309
310<!-- ======================================================================= -->
311<div class="doc_subsection">
312 <a name="c-fe">Known problems with the C front-end</a>
313</div>
Chris Lattner47588f92003-10-02 05:07:23 +0000314
Chris Lattner79c3fe12003-10-02 04:57:28 +0000315<!-- _______________________________________________________________________ -->
Chris Lattnerb40efb32003-12-14 05:03:43 +0000316<div class="doc_subsubsection">Bugs</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000317
Misha Brukman500bc302003-11-22 00:38:41 +0000318<div class="doc_text">
Misha Brukman500bc302003-11-22 00:38:41 +0000319<ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000320<li>C99 Variable sized arrays do not release stack memory when they go out of
321 scope. Thus, the following program may run out of stack space:
322<pre>
323 for (i = 0; i != 1000000; ++i) {
324 int X[n];
325 foo(X);
326 }
Misha Brukman500bc302003-11-22 00:38:41 +0000327</pre></li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000328
John Criswelld000e1d2003-12-18 16:43:17 +0000329<li>
330Initialization of global union variables can only be done
331<a href="http://llvm.cs.uiuc.edu/bugs/show_bug.cgi?id=162">with the largest
332union member</a>.
333</li>
Chris Lattnerf580cdc2004-03-16 21:39:04 +0000334
Misha Brukmana7aadf12004-04-19 02:56:49 +0000335<li><a href="http://llvm.cs.uiuc.edu/PR244">[llvm-gcc] Error when an implicitly
336external function is re-declared as static</a></li>
Chris Lattnerf580cdc2004-03-16 21:39:04 +0000337
John Criswelld000e1d2003-12-18 16:43:17 +0000338</ul>
Misha Brukman500bc302003-11-22 00:38:41 +0000339</div>
340
341<!-- _______________________________________________________________________ -->
342<div class="doc_subsubsection">
343 Notes
344</div>
345
346<div class="doc_text">
347
348<ul>
349
350<li>Inline assembly is not yet supported.</li>
Chris Lattnere01fcfb2003-10-27 18:30:37 +0000351
352<li>"long double" is transformed by the front-end into "double". There is no
Misha Brukman500bc302003-11-22 00:38:41 +0000353support for floating point data types of any size other than 32 and 64
354bits.</li>
355
356<li>The following Unix system functionality has not been tested and may not
357work:
Misha Brukmane0c891c2003-11-22 01:00:11 +0000358 <ol>
359 <li><tt>sigsetjmp</tt>, <tt>siglongjmp</tt> - These are not turned into the
360 appropriate <tt>invoke</tt>/<tt>unwind</tt> instructions. Note that
361 <tt>setjmp</tt> and <tt>longjmp</tt> <em>are</em> compiled correctly.
362 <li><tt>getcontext</tt>, <tt>setcontext</tt>, <tt>makecontext</tt>
363 - These functions have not been tested.
364 </ol></li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000365
366<li>Although many GCC extensions are supported, some are not. In particular,
367 the following extensions are known to <b>not be</b> supported:
368 <ol>
Misha Brukman500bc302003-11-22 00:38:41 +0000369 <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 +0000370 <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>
371 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Constructing-Calls.html#Constructing%20Calls">Constructing Calls</a>: Dispatching a call to another function.</li>
372 <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 +0000373 <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 +0000374 <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>
375 <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 +0000376 <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>
377 <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>
378 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Thread-Local.html#Thread-Local">Thread-Local</a>: Per-thread variables.</li>
379 <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 +0000380 </ol>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000381
Misha Brukman500bc302003-11-22 00:38:41 +0000382 <p>The following GCC extensions are <b>partially</b> supported. An ignored
Chris Lattner79c3fe12003-10-02 04:57:28 +0000383 attribute means that the LLVM compiler ignores the presence of the attribute,
384 but the code should still work. An unsupported attribute is one which is
John Criswelld000e1d2003-12-18 16:43:17 +0000385 ignored by the LLVM compiler and will cause a different interpretation of
Misha Brukman500bc302003-11-22 00:38:41 +0000386 the program.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000387
388 <ol>
389 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Length.html#Variable%20Length">Variable Length</a>:
390 Arrays whose length is computed at run time.<br>
Misha Brukman500bc302003-11-22 00:38:41 +0000391 Supported, but allocated stack space is not freed until the function returns (noted above).</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000392
393 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Attributes.html#Function%20Attributes">Function Attributes</a>:
Misha Brukman500bc302003-11-22 00:38:41 +0000394
John Criswelld000e1d2003-12-18 16:43:17 +0000395 Declaring that functions have no side effects or that they can never
Misha Brukman500bc302003-11-22 00:38:41 +0000396 return.<br>
397
398 <b>Supported:</b> <tt>format</tt>, <tt>format_arg</tt>, <tt>non_null</tt>,
399 <tt>constructor</tt>, <tt>destructor</tt>, <tt>unused</tt>,
400 <tt>deprecated</tt>, <tt>warn_unused_result</tt>, <tt>weak</tt><br>
401
402 <b>Ignored:</b> <tt>noreturn</tt>, <tt>noinline</tt>,
403 <tt>always_inline</tt>, <tt>pure</tt>, <tt>const</tt>, <tt>nothrow</tt>,
404 <tt>malloc</tt>, <tt>no_instrument_function</tt>, <tt>cdecl</tt><br>
405
406 <b>Unsupported:</b> <tt>used</tt>, <tt>section</tt>, <tt>alias</tt>,
407 <tt>visibility</tt>, <tt>regparm</tt>, <tt>stdcall</tt>,
408 <tt>fastcall</tt>, all other target specific attributes</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000409
410 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Attributes.html#Variable%20Attributes">Variable Attributes</a>:
411 Specifying attributes of variables.<br>
412 <b>Supported:</b> <tt>cleanup</tt>, <tt>common</tt>, <tt>nocommon</tt>,
413 <tt>deprecated</tt>, <tt>transparent_union</tt>,
414 <tt>unused</tt>, <tt>weak</tt><br>
Misha Brukman500bc302003-11-22 00:38:41 +0000415
Chris Lattner79c3fe12003-10-02 04:57:28 +0000416 <b>Unsupported:</b> <tt>aligned</tt>, <tt>mode</tt>, <tt>packed</tt>,
417 <tt>section</tt>, <tt>shared</tt>, <tt>tls_model</tt>,
418 <tt>vector_size</tt>, <tt>dllimport</tt>,
Misha Brukman500bc302003-11-22 00:38:41 +0000419 <tt>dllexport</tt>, all target specific attributes.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000420
Misha Brukmanc4b7bee2003-12-12 04:37:31 +0000421 <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 +0000422 <b>Supported:</b> <tt>transparent_union</tt>, <tt>unused</tt>,
Misha Brukmanc4b7bee2003-12-12 04:37:31 +0000423 <tt>deprecated</tt>, <tt>may_alias</tt><br>
Misha Brukman500bc302003-11-22 00:38:41 +0000424
425 <b>Unsupported:</b> <tt>aligned</tt>, <tt>packed</tt>,
426 all target specific attributes.</li>
427
Chris Lattner79c3fe12003-10-02 04:57:28 +0000428 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Other-Builtins.html#Other%20Builtins">Other Builtins</a>:
429 Other built-in functions.<br>
430 We support all builtins which have a C language equivalent (e.g.,
431 <tt>__builtin_cos</tt>), <tt>__builtin_alloca</tt>,
432 <tt>__builtin_types_compatible_p</tt>, <tt>__builtin_choose_expr</tt>,
Misha Brukman500bc302003-11-22 00:38:41 +0000433 <tt>__builtin_constant_p</tt>, and <tt>__builtin_expect</tt> (ignored).</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000434
Misha Brukman500bc302003-11-22 00:38:41 +0000435 </ol>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000436
Misha Brukman500bc302003-11-22 00:38:41 +0000437 <p>The following extensions <b>are</b> known to be supported:</p>
438
Chris Lattner79c3fe12003-10-02 04:57:28 +0000439 <ol>
Chris Lattner7fe97dd2004-03-16 08:54:07 +0000440 <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 +0000441 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Statement-Exprs.html#Statement%20Exprs">Statement Exprs</a>: Putting statements and declarations inside expressions.</li>
442 <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>
443 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Lvalues.html#Lvalues">Lvalues</a>: Using <code>?:</code>, "<code>,</code>" and casts in lvalues.</li>
444 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Conditionals.html#Conditionals">Conditionals</a>: Omitting the middle operand of a <code>?:</code> expression.</li>
445 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Long-Long.html#Long%20Long">Long Long</a>: Double-word integers.</li>
446 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Complex.html#Complex">Complex</a>: Data types for complex numbers.</li>
447 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Hex-Floats.html#Hex%20Floats">Hex Floats</a>:Hexadecimal floating-point constants.</li>
448 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Zero-Length.html#Zero%20Length">Zero Length</a>: Zero-length arrays.</li>
449 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Empty-Structures.html#Empty%20Structures">Empty Structures</a>: Structures with no members.</li>
450 <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>
451 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Escaped-Newlines.html#Escaped%20Newlines">Escaped Newlines</a>: Slightly looser rules for escaped newlines.</li>
452 <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 +0000453 <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 +0000454 <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 +0000455 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Compound-Literals.html#Compound%20Literals">Compound Literals</a>: Compound literals give structures, unions,
456or arrays as values.</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000457 <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 +0000458 <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 +0000459 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Case-Ranges.html#Case%20Ranges">Case Ranges</a>: `case 1 ... 9' and such.</li>
460 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Mixed-Declarations.html#Mixed%20Declarations">Mixed Declarations</a>: Mixing declarations and code.</li>
461 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Prototypes.html#Function%20Prototypes">Function Prototypes</a>: Prototype declarations and old-style definitions.</li>
462 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/C---Comments.html#C++%20Comments">C++ Comments</a>: C++ comments are recognized.</li>
463 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Dollar-Signs.html#Dollar%20Signs">Dollar Signs</a>: Dollar sign is allowed in identifiers.</li>
464 <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>
465 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Alignment.html#Alignment">Alignment</a>: Inquiring about the alignment of a type or variable.</li>
466 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Inline.html#Inline">Inline</a>: Defining inline functions (as fast as macros).</li>
467 <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>
468 <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>
469 <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 +0000470 <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 +0000471 <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>
472 <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 +0000473 </ol></li>
474
475</ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000476
Misha Brukman500bc302003-11-22 00:38:41 +0000477<p>If you run into GCC extensions which have not been included in any of these
478lists, please let us know (also including whether or not they work).</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000479
Misha Brukman500bc302003-11-22 00:38:41 +0000480</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000481
Misha Brukman500bc302003-11-22 00:38:41 +0000482<!-- ======================================================================= -->
483<div class="doc_subsection">
484 <a name="c++-fe">Known problems with the C++ front-end</a>
485</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000486
Misha Brukman500bc302003-11-22 00:38:41 +0000487<div class="doc_text">
488
John Criswelld000e1d2003-12-18 16:43:17 +0000489<p>For this release, the C++ front-end is considered to be fully functional but
Chris Lattner9e848092003-12-12 04:25:33 +0000490has not been tested as thoroughly as the C front-end. It has been tested and
491works for a number of non-trivial programs, but there may be lurking bugs.
492Please report any bugs or problems.</p>
Misha Brukman500bc302003-11-22 00:38:41 +0000493
494</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000495
496<!-- _______________________________________________________________________ -->
Chris Lattner3a51be12004-02-14 04:12:41 +0000497<div class="doc_subsubsection">Bugs</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000498
Misha Brukman500bc302003-11-22 00:38:41 +0000499<div class="doc_text">
Chris Lattner79c3fe12003-10-02 04:57:28 +0000500
Misha Brukman500bc302003-11-22 00:38:41 +0000501<ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000502<li>The C++ front-end inherits all problems afflicting the <a href="#c-fe">C
John Criswelld000e1d2003-12-18 16:43:17 +0000503 front-end</a>.</li>
John Criswelld000e1d2003-12-18 16:43:17 +0000504</ul>
Misha Brukman500bc302003-11-22 00:38:41 +0000505</div>
506
507<!-- _______________________________________________________________________ -->
508<div class="doc_subsubsection">
509 Notes
510</div>
511
512<div class="doc_text">
513
514<ul>
Chris Lattnere01fcfb2003-10-27 18:30:37 +0000515
Chris Lattner79c3fe12003-10-02 04:57:28 +0000516<li>The C++ front-end is based on a pre-release of the GCC 3.4 C++ parser. This
517parser is significantly more standards compliant (and picky) than prior GCC
518versions. For more information, see the C++ section of the <a
Chris Lattner9e848092003-12-12 04:25:33 +0000519href="http://gcc.gnu.org/gcc-3.4/changes.html">GCC 3.4 release notes</a>.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000520
521<li>Destructors for local objects are not always run when a <tt>longjmp</tt> is
Chris Lattner19092612003-10-02 16:38:05 +0000522 performed. In particular, destructors for objects in the <tt>longjmp</tt>ing
Chris Lattner79c3fe12003-10-02 04:57:28 +0000523 function and in the <tt>setjmp</tt> receiver function may not be run.
John Criswelld000e1d2003-12-18 16:43:17 +0000524 Objects in intervening stack frames will be destroyed, however (which is
Misha Brukman500bc302003-11-22 00:38:41 +0000525 better than most compilers).</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000526
Chris Lattner19092612003-10-02 16:38:05 +0000527<li>The LLVM C++ front-end follows the <a
528 href="http://www.codesourcery.com/cxx-abi">Itanium C++ ABI</a>.
529 This document, which is not Itanium specific, specifies a standard for name
530 mangling, class layout, v-table layout, RTTI formats, and other C++
531 representation issues. Because we use this API, code generated by the LLVM
532 compilers should be binary compatible with machine code generated by other
533 Itanium ABI C++ compilers (such as G++, the Intel and HP compilers, etc).
534 <i>However</i>, the exception handling mechanism used by LLVM is very
535 different from the model used in the Itanium ABI, so <b>exceptions will not
Misha Brukman500bc302003-11-22 00:38:41 +0000536 interact correctly</b>. </li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000537
Misha Brukman500bc302003-11-22 00:38:41 +0000538</ul>
Chris Lattnerfcc54b32003-10-07 22:14:37 +0000539
Misha Brukman500bc302003-11-22 00:38:41 +0000540</div>
541
542<!-- ======================================================================= -->
543<div class="doc_subsection">
544 <a name="x86-be">Known problems with the X86 back-end</a>
545</div>
546
547<div class="doc_text">
548
549<ul>
Chris Lattnerde4afdc2004-02-08 22:23:33 +0000550<li>None so far.
Misha Brukman500bc302003-11-22 00:38:41 +0000551</ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000552
Misha Brukman500bc302003-11-22 00:38:41 +0000553</div>
554
555<!-- ======================================================================= -->
556<div class="doc_subsection">
557 <a name="sparc-be">Known problems with the Sparc back-end</a>
558</div>
559
560<div class="doc_text">
561
562<ul>
Chris Lattner6a39aa52004-03-19 19:22:28 +0000563<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 +0000564</ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000565
Misha Brukman500bc302003-11-22 00:38:41 +0000566</div>
567
568<!-- ======================================================================= -->
569<div class="doc_subsection">
570 <a name="c-be">Known problems with the C back-end</a>
571</div>
572
573<div class="doc_text">
574
575<ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000576
577<li>The C back-end produces code that violates the ANSI C Type-Based Alias
578Analysis rules. As such, special options may be necessary to compile the code
579(for example, GCC requires the <tt>-fno-strict-aliasing</tt> option). This
Misha Brukman500bc302003-11-22 00:38:41 +0000580problem probably cannot be fixed.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000581
Chris Lattnere84843b2003-10-20 19:05:03 +0000582<li><a href="http://llvm.cs.uiuc.edu/PR33">Initializers for global variables</a>
Misha Brukman500bc302003-11-22 00:38:41 +0000583cannot include special floating point numbers like Not-A-Number or
584Infinity.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000585
Chris Lattner2855ecd2003-11-04 20:06:53 +0000586<li><a href="http://llvm.cs.uiuc.edu/PR56">Zero arg vararg functions are not
Chris Lattner2af46052003-10-24 04:03:19 +0000587supported</a>. This should not affect LLVM produced by the C or C++
Misha Brukman500bc302003-11-22 00:38:41 +0000588frontends.</li>
Chris Lattner2af46052003-10-24 04:03:19 +0000589
Misha Brukman500bc302003-11-22 00:38:41 +0000590</ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000591
Misha Brukman500bc302003-11-22 00:38:41 +0000592</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000593
594<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000595<div class="doc_section">
596 <a name="additionalinfo">Additional Information</a>
597</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000598<!-- *********************************************************************** -->
599
Misha Brukman500bc302003-11-22 00:38:41 +0000600<div class="doc_text">
601
602<p>A wide variety of additional information is available on the LLVM web page,
John Criswelld000e1d2003-12-18 16:43:17 +0000603including mailing lists and publications describing algorithms and components
Chris Lattner79c3fe12003-10-02 04:57:28 +0000604implemented in LLVM. The web page also contains versions of the API
605documentation which is up-to-date with the CVS version of the source code. You
606can access versions of these documents specific to this release by going into
Misha Brukman500bc302003-11-22 00:38:41 +0000607the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000608
Misha Brukman500bc302003-11-22 00:38:41 +0000609<p>If you have any questions or comments about LLVM, please feel free to contact
Chris Lattner5eccca42003-12-12 21:22:16 +0000610us via the <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">mailing
611lists</a>.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000612
Misha Brukman500bc302003-11-22 00:38:41 +0000613</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000614
615<!-- *********************************************************************** -->
Chris Lattner79c3fe12003-10-02 04:57:28 +0000616
Misha Brukman500bc302003-11-22 00:38:41 +0000617<hr>
Misha Brukman2061e892003-11-22 01:23:39 +0000618<address>
Misha Brukman38847d52003-12-21 22:53:21 +0000619 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman2061e892003-11-22 01:23:39 +0000620 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
621 <a href="http://validator.w3.org/check/referer"><img
622 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
623
Misha Brukmane0c891c2003-11-22 01:00:11 +0000624 <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br>
Misha Brukman500bc302003-11-22 00:38:41 +0000625 Last modified: $Date$
Misha Brukman2061e892003-11-22 01:23:39 +0000626</address>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000627
Misha Brukman500bc302003-11-22 00:38:41 +0000628</body>
629</html>