blob: 10d4f750b5feb3b921c282494a0f62ebb62e6a96 [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 Lattnerd4594dc2004-05-04 17:04:09 +000073This is the fourth public release of the LLVM compiler infrastructure. This
74release primarily improves the <a href="#codequality">performance of the
75code</a> produced by all aspects of the LLVM compiler and adds some <a
76href="#newfeatures">new features</a>, though it does <a href="#bugfix">fix a few
77bugs</a> as well.
Chris Lattnerb40efb32003-12-14 05:03:43 +000078</p>
Chris Lattnera5099962003-12-06 20:22:41 +000079
Chris Lattner835104c2004-03-17 03:54:41 +000080<p>
81At this time, LLVM is known to correctly compile and run all C &amp; C++ SPEC
82CPU2000 benchmarks, the Olden benchmarks, and the Ptrdist benchmarks. It has
83also been used to compile <b>many</b> other programs. LLVM now also works with
84a broad variety of C++ programs, though it has still received less testing than
85the C front-end.
Chris Lattnera5099962003-12-06 20:22:41 +000086</p>
87
Chris Lattnera5099962003-12-06 20:22:41 +000088<!--=========================================================================-->
89<div class="doc_subsubsection">
Chris Lattnera39719f2004-02-25 16:36:51 +000090<a name="newfeatures">This release implements the following new features:</a>
Chris Lattnera5099962003-12-06 20:22:41 +000091</div>
Chris Lattner47ad72c2003-10-07 21:38:31 +000092
93<ol>
Chris Lattner2974b5b2004-04-01 00:41:31 +000094<li>The LLVM <a href="LangRef.html#i_select"><tt>select</tt></a> instruction is
Chris Lattner6e1ef192004-05-02 04:19:15 +000095now fully implemented and supported by all transformations, native code
96generators, and the interpreter.</li>
Misha Brukmana7aadf12004-04-19 02:56:49 +000097<li>Bugpoint can now narrow down code-generation bugs to a loop nest, where
98before it could only narrow them down to a function being miscompiled.</li>
Chris Lattner6e1ef192004-05-02 04:19:15 +000099<li>The Control Flow Graph in the native code generators is no longer
100constrained to be the same as the CFG for the LLVM input code.</li>
101<li>The LLVM induction variable analysis routines have been rewritten.</li>
102<li>LLVM now has new loop unrolling and loop unswitching passes.</li>
103<li>The induction variable substitution pass performs linear function test
104replacement and exit value replacement optimizations.</li>
Chris Lattner55ee0312003-11-19 22:05:38 +0000105</ol>
Chris Lattner0ef19062003-11-08 04:28:55 +0000106
Chris Lattnera5099962003-12-06 20:22:41 +0000107
108<!--=========================================================================-->
109<div class="doc_subsubsection">
110In this release, the following missing features were implemented:
111</div>
Chris Lattner0ef19062003-11-08 04:28:55 +0000112
113<ol>
Misha Brukmana7aadf12004-04-19 02:56:49 +0000114<li><a href="http://llvm.cs.uiuc.edu/PR82">LLVM cannot handle structures with
115more than 256 elements</a></li>
Misha Brukmancb003362004-04-19 03:01:01 +0000116<li><a href="http://llvm.cs.uiuc.edu/PR38">[bugpoint] External functions used in
117non-instruction entities, such as global constant initializer</a></li>
118<li><a href="http://llvm.cs.uiuc.edu/PR290">Bugpoint doesn't support
119uses of external fns by immediate constant exprs</a></li>
Misha Brukman500bc302003-11-22 00:38:41 +0000120</ol>
Chris Lattner47ad72c2003-10-07 21:38:31 +0000121
Chris Lattnera5099962003-12-06 20:22:41 +0000122
123<!--=========================================================================-->
124<div class="doc_subsubsection">
Misha Brukmana7aadf12004-04-19 02:56:49 +0000125<a name="qualityofimp">In this release, the following Quality of Implementation
126issues were fixed:</a>
Chris Lattnere29ac162003-12-20 03:42:11 +0000127</div>
128
129<ol>
Misha Brukmana7aadf12004-04-19 02:56:49 +0000130<li><a href="http://llvm.cs.uiuc.edu/PR305">LLVM tools will happily spew
131bytecode onto your terminal</a></li>
Chris Lattnere29ac162003-12-20 03:42:11 +0000132</ol>
133
134<!--=========================================================================-->
135<div class="doc_subsubsection">
Chris Lattnera39719f2004-02-25 16:36:51 +0000136In this release, the following build problems were fixed:
Brian Gaeke6b31beb2004-01-16 21:55:04 +0000137</div>
138
139<ol>
Brian Gaeke21a710a2004-04-20 18:18:46 +0000140<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 +0000141</ol>
142
143<!--=========================================================================-->
144<div class="doc_subsubsection">
Chris Lattner6e1ef192004-05-02 04:19:15 +0000145<a name="codequality">This release includes the following Code Quality
146improvements:</a>
Chris Lattnera5099962003-12-06 20:22:41 +0000147</div>
Chris Lattner89ca2b82003-10-27 17:06:39 +0000148
149<ol>
Chris Lattner6e1ef192004-05-02 04:19:15 +0000150<li>Fixed: <a href="http://llvm.cs.uiuc.edu/PR309">[vmcore] Code quality problem
151due to long operand of getelementptr</a></li>
Chris Lattner64913402004-04-13 14:43:35 +0000152
153<li>The X86 backend now generates substantially better code for 64-bit integer
154and floating point operations.</li>
155
156<li>The -inline pass no longer inlines mutually recursive functions until it
157hits the inlining threshold.</li>
158
159<li>The -inline pass no longer misses obvious inlining opportunities just
160because the callee eventually calls into an external function.</li>
161
162<li>The -simplifycfg pass can now "if convert" simple statements into the new
163<tt>select</tt> instruction.</li>
164
165<li>The -loopsimplify pass can now break <a
166href="http://llvm.cs.uiuc.edu/PR35">natural loops with multiple backedges</a>
167into multiple nested loops. This enables a variety of subsequent
168optimizations.</li>
169
170<li>The -adce pass can now eliminate calls to functions that do not not write to
171memory.</li>
172
173<li>The link-time optimizer now runs the -prune-eh pass (to remove unused
Chris Lattnerd4594dc2004-05-04 17:04:09 +0000174exception handlers).</li>
Chris Lattner64913402004-04-13 14:43:35 +0000175
Chris Lattner6e1ef192004-05-02 04:19:15 +0000176<li>The -simplifycfg pass can now eliminate simple correlated branches (such as
177"<tt>if (A &lt; B &amp;&amp; A &lt; B)</tt>", and can turn short-circuiting
178operators into the strict versions when useful (such as "<tt>if (A &lt; B || A
179&gt; C)</tt>" into "<tt>if (A &lt; B | A &gt; C)</tt>"</li>
180
Chris Lattnerd4594dc2004-05-04 17:04:09 +0000181<li>LLVM now has infrastructure for (simple and sparse conditional) constant
182propagation of function calls. It currently supports a few math library
183functions like sqrt/sin/cos/etc.</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000184</ol>
Chris Lattner89ca2b82003-10-27 17:06:39 +0000185
Chris Lattnera5099962003-12-06 20:22:41 +0000186
187<!--=========================================================================-->
188<div class="doc_subsubsection">
Misha Brukmana7aadf12004-04-19 02:56:49 +0000189<a name="bugfix">In this release, the following bugs in the previous release
190were fixed:</a>
Chris Lattnera5099962003-12-06 20:22:41 +0000191</div>
192
193<p>Bugs in the LLVM Core:</p>
Chris Lattner47ad72c2003-10-07 21:38:31 +0000194
195<ol>
Misha Brukmana7aadf12004-04-19 02:56:49 +0000196<li><a href="http://llvm.cs.uiuc.edu/PR306">[loopsimplify] Loop simplify
197incorrectly updates dominator information</a></li>
198<li><a href="http://llvm.cs.uiuc.edu/PR310">[tailduplicate] DemoteRegToStack
199breaks SSA form</a></li>
200<li><a href="http://llvm.cs.uiuc.edu/PR313">[X86] JIT miscompiles unsigned short
201to floating point cast</a></li>
Chris Lattnerd4594dc2004-05-04 17:04:09 +0000202<li><a href="http://llvm.cs.uiuc.edu/PR332">[adce] Crash handling unreachable code that unwinds</a></li>
Chris Lattnera5099962003-12-06 20:22:41 +0000203</ol>
204
205
Chris Lattner56e67052004-02-09 21:22:51 +0000206
Chris Lattnera5099962003-12-06 20:22:41 +0000207<p>Bugs in the C/C++ front-end:</p>
208
209<ol>
Chris Lattner6df29c62004-04-21 18:52:06 +0000210<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 +0000211</ol>
Chris Lattner19092612003-10-02 16:38:05 +0000212
Misha Brukman500bc302003-11-22 00:38:41 +0000213</div>
Chris Lattner19092612003-10-02 16:38:05 +0000214
215<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000216<div class="doc_section">
217 <a name="portability">Portability and Supported Platforms</a>
218</div>
Chris Lattner19092612003-10-02 16:38:05 +0000219<!-- *********************************************************************** -->
220
Misha Brukman500bc302003-11-22 00:38:41 +0000221<div class="doc_text">
222
223<p>LLVM has been extensively tested on Intel and AMD machines running Red
Misha Brukmana7aadf12004-04-19 02:56:49 +0000224Hat Linux and FreeBSD. It has also been tested on Sun UltraSPARC workstations
225running Solaris 8. Additionally, LLVM works on Mac OS X 10.3 and above, but
226only with the C backend or interpreter (no native backend for the PowerPC is
227available yet). The core LLVM infrastructure uses "autoconf" for portability,
228so hopefully we work on more platforms than that. However, it is likely that we
229missed something and that minor porting is required to get LLVM to work on new
230platforms. We welcome portability patches and error messages.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000231
Misha Brukman500bc302003-11-22 00:38:41 +0000232</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000233
Brian Gaeke21a710a2004-04-20 18:18:46 +0000234<!--=========================================================================-->
235<div class="doc_subsection">
236In this release, the following portability problems were fixed:
237</div>
238
239<ol>
240<li><a href="http://llvm.cs.uiuc.edu/PR304">warnings compiling Stacker compiler on Mac OS X</a></li>
Chris Lattnerd4594dc2004-05-04 17:04:09 +0000241<li><a href="http://llvm.cs.uiuc.edu/PR308">Archive file reader doesn't understand abbreviated names in headers</a></li>
Brian Gaeke21a710a2004-04-20 18:18:46 +0000242</ol>
243
Chris Lattner79c3fe12003-10-02 04:57:28 +0000244<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000245<div class="doc_section">
246 <a name="knownproblems">Known Problems</a>
247</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000248<!-- *********************************************************************** -->
249
Misha Brukman500bc302003-11-22 00:38:41 +0000250<div class="doc_text">
251
252<p>This section contains all known problems with the LLVM system, listed by
Chris Lattner79c3fe12003-10-02 04:57:28 +0000253component. As new problems are discovered, they will be added to these
Chris Lattner5eccca42003-12-12 21:22:16 +0000254sections. If you run into a problem, please check the <a
John Criswelld000e1d2003-12-18 16:43:17 +0000255href="http://llvm.cs.uiuc.edu/bugs/">LLVM bug database</a> and submit a bug if
Chris Lattner5eccca42003-12-12 21:22:16 +0000256there isn't already one.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000257
Misha Brukman500bc302003-11-22 00:38:41 +0000258</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000259
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000260<!-- ======================================================================= -->
261<div class="doc_subsection">
262 <a name="experimental">Experimental features included with this release</a>
263</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000264
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000265<div class="doc_text">
266
267<p>
268The following components of this LLVM release are either untested, known to be
269broken or unreliable, or are in early development. These components should not
270be relied on, and bugs should not be filed against them, but they may be useful
271to some people. In particular, if you would like to work on one of these
272components, please contact us on the llvmdev list.
273</p>
274
275<ul>
276<li>The following passes are incomplete or buggy: <tt>-pgmdep, -memdep,
277 -ipmodref, -sortstructs, -swapstructs, -cee</tt></li>
278
279<li>The <tt>-pre</tt> pass is incomplete (there are cases it doesn't handle that
280 it should) and not thoroughly tested.</li>
281<li>The <tt>llvm-ar</tt> tool is incomplete and probably buggy.</li>
282<li>The <tt>llvm-db</tt> tool is in a very early stage of development.</li>
283</ul>
284
285</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000286
Misha Brukman500bc302003-11-22 00:38:41 +0000287<!-- ======================================================================= -->
288<div class="doc_subsection">
289 <a name="core">Known problems with the LLVM Core</a>
290</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000291
Misha Brukman500bc302003-11-22 00:38:41 +0000292<div class="doc_text">
293
294<ul>
295
296<li>In the JIT, <tt>dlsym</tt> on a symbol compiled by the JIT will not
297work.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000298
299<li>The JIT does not use mutexes to protect its internal data structures. As
Misha Brukman500bc302003-11-22 00:38:41 +0000300such, execution of a threaded program could cause these data structures to be
301corrupted.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000302
Misha Brukman500bc302003-11-22 00:38:41 +0000303<li>It is not possible to <tt>dlopen</tt> an LLVM bytecode file in the JIT.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000304
Chris Lattnere84843b2003-10-20 19:05:03 +0000305<li>Linking in static archive files (.a files) is very slow (there is no symbol
Misha Brukman500bc302003-11-22 00:38:41 +0000306table in the archive).</li>
Chris Lattner2855ecd2003-11-04 20:06:53 +0000307
Misha Brukmana7aadf12004-04-19 02:56:49 +0000308<li>The gccld program <a href="http://llvm.cs.uiuc.edu/PR139">does not link
309objects/archives in the order specified on the command line.</a></li>
Chris Lattner2e6fcaf2004-02-15 23:09:07 +0000310
311<li><a href="http://llvm.cs.uiuc.edu/PR240">The lower-invoke pass does not mark
John Criswelld46c6962004-03-12 21:29:42 +0000312values live across a setjmp as volatile</a>. This missing feature only affects
Chris Lattner2e6fcaf2004-02-15 23:09:07 +0000313targets whose setjmp/longjmp libraries do not save and restore the entire
314register file.</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000315</ul>
Misha Brukman500bc302003-11-22 00:38:41 +0000316</div>
317
318<!-- ======================================================================= -->
319<div class="doc_subsection">
320 <a name="c-fe">Known problems with the C front-end</a>
321</div>
Chris Lattner47588f92003-10-02 05:07:23 +0000322
Chris Lattner79c3fe12003-10-02 04:57:28 +0000323<!-- _______________________________________________________________________ -->
Chris Lattnerb40efb32003-12-14 05:03:43 +0000324<div class="doc_subsubsection">Bugs</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000325
Misha Brukman500bc302003-11-22 00:38:41 +0000326<div class="doc_text">
Misha Brukman500bc302003-11-22 00:38:41 +0000327<ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000328<li>C99 Variable sized arrays do not release stack memory when they go out of
329 scope. Thus, the following program may run out of stack space:
330<pre>
331 for (i = 0; i != 1000000; ++i) {
332 int X[n];
333 foo(X);
334 }
Misha Brukman500bc302003-11-22 00:38:41 +0000335</pre></li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000336
John Criswelld000e1d2003-12-18 16:43:17 +0000337<li>
338Initialization of global union variables can only be done
339<a href="http://llvm.cs.uiuc.edu/bugs/show_bug.cgi?id=162">with the largest
340union member</a>.
341</li>
Chris Lattnerf580cdc2004-03-16 21:39:04 +0000342
Misha Brukmana7aadf12004-04-19 02:56:49 +0000343<li><a href="http://llvm.cs.uiuc.edu/PR244">[llvm-gcc] Error when an implicitly
344external function is re-declared as static</a></li>
Chris Lattnerf580cdc2004-03-16 21:39:04 +0000345
John Criswelld000e1d2003-12-18 16:43:17 +0000346</ul>
Misha Brukman500bc302003-11-22 00:38:41 +0000347</div>
348
349<!-- _______________________________________________________________________ -->
350<div class="doc_subsubsection">
351 Notes
352</div>
353
354<div class="doc_text">
355
356<ul>
357
358<li>Inline assembly is not yet supported.</li>
Chris Lattnere01fcfb2003-10-27 18:30:37 +0000359
360<li>"long double" is transformed by the front-end into "double". There is no
Misha Brukman500bc302003-11-22 00:38:41 +0000361support for floating point data types of any size other than 32 and 64
362bits.</li>
363
364<li>The following Unix system functionality has not been tested and may not
365work:
Misha Brukmane0c891c2003-11-22 01:00:11 +0000366 <ol>
367 <li><tt>sigsetjmp</tt>, <tt>siglongjmp</tt> - These are not turned into the
368 appropriate <tt>invoke</tt>/<tt>unwind</tt> instructions. Note that
369 <tt>setjmp</tt> and <tt>longjmp</tt> <em>are</em> compiled correctly.
370 <li><tt>getcontext</tt>, <tt>setcontext</tt>, <tt>makecontext</tt>
371 - These functions have not been tested.
372 </ol></li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000373
374<li>Although many GCC extensions are supported, some are not. In particular,
375 the following extensions are known to <b>not be</b> supported:
376 <ol>
Misha Brukman500bc302003-11-22 00:38:41 +0000377 <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 +0000378 <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>
379 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Constructing-Calls.html#Constructing%20Calls">Constructing Calls</a>: Dispatching a call to another function.</li>
380 <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 +0000381 <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 +0000382 <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>
383 <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 +0000384 <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>
385 <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>
386 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Thread-Local.html#Thread-Local">Thread-Local</a>: Per-thread variables.</li>
387 <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 +0000388 </ol>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000389
Misha Brukman500bc302003-11-22 00:38:41 +0000390 <p>The following GCC extensions are <b>partially</b> supported. An ignored
Chris Lattner79c3fe12003-10-02 04:57:28 +0000391 attribute means that the LLVM compiler ignores the presence of the attribute,
392 but the code should still work. An unsupported attribute is one which is
John Criswelld000e1d2003-12-18 16:43:17 +0000393 ignored by the LLVM compiler and will cause a different interpretation of
Misha Brukman500bc302003-11-22 00:38:41 +0000394 the program.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000395
396 <ol>
397 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Length.html#Variable%20Length">Variable Length</a>:
398 Arrays whose length is computed at run time.<br>
Misha Brukman500bc302003-11-22 00:38:41 +0000399 Supported, but allocated stack space is not freed until the function returns (noted above).</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000400
401 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Attributes.html#Function%20Attributes">Function Attributes</a>:
Misha Brukman500bc302003-11-22 00:38:41 +0000402
John Criswelld000e1d2003-12-18 16:43:17 +0000403 Declaring that functions have no side effects or that they can never
Misha Brukman500bc302003-11-22 00:38:41 +0000404 return.<br>
405
406 <b>Supported:</b> <tt>format</tt>, <tt>format_arg</tt>, <tt>non_null</tt>,
407 <tt>constructor</tt>, <tt>destructor</tt>, <tt>unused</tt>,
408 <tt>deprecated</tt>, <tt>warn_unused_result</tt>, <tt>weak</tt><br>
409
410 <b>Ignored:</b> <tt>noreturn</tt>, <tt>noinline</tt>,
411 <tt>always_inline</tt>, <tt>pure</tt>, <tt>const</tt>, <tt>nothrow</tt>,
412 <tt>malloc</tt>, <tt>no_instrument_function</tt>, <tt>cdecl</tt><br>
413
414 <b>Unsupported:</b> <tt>used</tt>, <tt>section</tt>, <tt>alias</tt>,
415 <tt>visibility</tt>, <tt>regparm</tt>, <tt>stdcall</tt>,
416 <tt>fastcall</tt>, all other target specific attributes</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000417
418 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Attributes.html#Variable%20Attributes">Variable Attributes</a>:
419 Specifying attributes of variables.<br>
420 <b>Supported:</b> <tt>cleanup</tt>, <tt>common</tt>, <tt>nocommon</tt>,
421 <tt>deprecated</tt>, <tt>transparent_union</tt>,
422 <tt>unused</tt>, <tt>weak</tt><br>
Misha Brukman500bc302003-11-22 00:38:41 +0000423
Chris Lattner79c3fe12003-10-02 04:57:28 +0000424 <b>Unsupported:</b> <tt>aligned</tt>, <tt>mode</tt>, <tt>packed</tt>,
425 <tt>section</tt>, <tt>shared</tt>, <tt>tls_model</tt>,
426 <tt>vector_size</tt>, <tt>dllimport</tt>,
Misha Brukman500bc302003-11-22 00:38:41 +0000427 <tt>dllexport</tt>, all target specific attributes.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000428
Misha Brukmanc4b7bee2003-12-12 04:37:31 +0000429 <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 +0000430 <b>Supported:</b> <tt>transparent_union</tt>, <tt>unused</tt>,
Misha Brukmanc4b7bee2003-12-12 04:37:31 +0000431 <tt>deprecated</tt>, <tt>may_alias</tt><br>
Misha Brukman500bc302003-11-22 00:38:41 +0000432
433 <b>Unsupported:</b> <tt>aligned</tt>, <tt>packed</tt>,
434 all target specific attributes.</li>
435
Chris Lattner79c3fe12003-10-02 04:57:28 +0000436 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Other-Builtins.html#Other%20Builtins">Other Builtins</a>:
437 Other built-in functions.<br>
438 We support all builtins which have a C language equivalent (e.g.,
439 <tt>__builtin_cos</tt>), <tt>__builtin_alloca</tt>,
440 <tt>__builtin_types_compatible_p</tt>, <tt>__builtin_choose_expr</tt>,
Misha Brukman500bc302003-11-22 00:38:41 +0000441 <tt>__builtin_constant_p</tt>, and <tt>__builtin_expect</tt> (ignored).</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000442
Misha Brukman500bc302003-11-22 00:38:41 +0000443 </ol>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000444
Misha Brukman500bc302003-11-22 00:38:41 +0000445 <p>The following extensions <b>are</b> known to be supported:</p>
446
Chris Lattner79c3fe12003-10-02 04:57:28 +0000447 <ol>
Chris Lattner7fe97dd2004-03-16 08:54:07 +0000448 <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 +0000449 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Statement-Exprs.html#Statement%20Exprs">Statement Exprs</a>: Putting statements and declarations inside expressions.</li>
450 <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>
451 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Lvalues.html#Lvalues">Lvalues</a>: Using <code>?:</code>, "<code>,</code>" and casts in lvalues.</li>
452 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Conditionals.html#Conditionals">Conditionals</a>: Omitting the middle operand of a <code>?:</code> expression.</li>
453 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Long-Long.html#Long%20Long">Long Long</a>: Double-word integers.</li>
454 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Complex.html#Complex">Complex</a>: Data types for complex numbers.</li>
455 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Hex-Floats.html#Hex%20Floats">Hex Floats</a>:Hexadecimal floating-point constants.</li>
456 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Zero-Length.html#Zero%20Length">Zero Length</a>: Zero-length arrays.</li>
457 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Empty-Structures.html#Empty%20Structures">Empty Structures</a>: Structures with no members.</li>
458 <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>
459 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Escaped-Newlines.html#Escaped%20Newlines">Escaped Newlines</a>: Slightly looser rules for escaped newlines.</li>
460 <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 +0000461 <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 +0000462 <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 +0000463 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Compound-Literals.html#Compound%20Literals">Compound Literals</a>: Compound literals give structures, unions,
464or arrays as values.</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000465 <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 +0000466 <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 +0000467 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Case-Ranges.html#Case%20Ranges">Case Ranges</a>: `case 1 ... 9' and such.</li>
468 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Mixed-Declarations.html#Mixed%20Declarations">Mixed Declarations</a>: Mixing declarations and code.</li>
469 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Prototypes.html#Function%20Prototypes">Function Prototypes</a>: Prototype declarations and old-style definitions.</li>
470 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/C---Comments.html#C++%20Comments">C++ Comments</a>: C++ comments are recognized.</li>
471 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Dollar-Signs.html#Dollar%20Signs">Dollar Signs</a>: Dollar sign is allowed in identifiers.</li>
472 <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>
473 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Alignment.html#Alignment">Alignment</a>: Inquiring about the alignment of a type or variable.</li>
474 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Inline.html#Inline">Inline</a>: Defining inline functions (as fast as macros).</li>
475 <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>
476 <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>
477 <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 +0000478 <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 +0000479 <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>
480 <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 +0000481 </ol></li>
482
483</ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000484
Misha Brukman500bc302003-11-22 00:38:41 +0000485<p>If you run into GCC extensions which have not been included in any of these
486lists, please let us know (also including whether or not they work).</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000487
Misha Brukman500bc302003-11-22 00:38:41 +0000488</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000489
Misha Brukman500bc302003-11-22 00:38:41 +0000490<!-- ======================================================================= -->
491<div class="doc_subsection">
492 <a name="c++-fe">Known problems with the C++ front-end</a>
493</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000494
Misha Brukman500bc302003-11-22 00:38:41 +0000495<div class="doc_text">
496
John Criswelld000e1d2003-12-18 16:43:17 +0000497<p>For this release, the C++ front-end is considered to be fully functional but
Chris Lattner9e848092003-12-12 04:25:33 +0000498has not been tested as thoroughly as the C front-end. It has been tested and
499works for a number of non-trivial programs, but there may be lurking bugs.
500Please report any bugs or problems.</p>
Misha Brukman500bc302003-11-22 00:38:41 +0000501
502</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000503
504<!-- _______________________________________________________________________ -->
Chris Lattner3a51be12004-02-14 04:12:41 +0000505<div class="doc_subsubsection">Bugs</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000506
Misha Brukman500bc302003-11-22 00:38:41 +0000507<div class="doc_text">
Chris Lattner79c3fe12003-10-02 04:57:28 +0000508
Misha Brukman500bc302003-11-22 00:38:41 +0000509<ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000510<li>The C++ front-end inherits all problems afflicting the <a href="#c-fe">C
John Criswelld000e1d2003-12-18 16:43:17 +0000511 front-end</a>.</li>
John Criswelld000e1d2003-12-18 16:43:17 +0000512</ul>
Misha Brukman500bc302003-11-22 00:38:41 +0000513</div>
514
515<!-- _______________________________________________________________________ -->
516<div class="doc_subsubsection">
517 Notes
518</div>
519
520<div class="doc_text">
521
522<ul>
Chris Lattnere01fcfb2003-10-27 18:30:37 +0000523
Chris Lattner79c3fe12003-10-02 04:57:28 +0000524<li>The C++ front-end is based on a pre-release of the GCC 3.4 C++ parser. This
525parser is significantly more standards compliant (and picky) than prior GCC
526versions. For more information, see the C++ section of the <a
Chris Lattner9e848092003-12-12 04:25:33 +0000527href="http://gcc.gnu.org/gcc-3.4/changes.html">GCC 3.4 release notes</a>.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000528
529<li>Destructors for local objects are not always run when a <tt>longjmp</tt> is
Chris Lattner19092612003-10-02 16:38:05 +0000530 performed. In particular, destructors for objects in the <tt>longjmp</tt>ing
Chris Lattner79c3fe12003-10-02 04:57:28 +0000531 function and in the <tt>setjmp</tt> receiver function may not be run.
John Criswelld000e1d2003-12-18 16:43:17 +0000532 Objects in intervening stack frames will be destroyed, however (which is
Misha Brukman500bc302003-11-22 00:38:41 +0000533 better than most compilers).</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000534
Chris Lattner19092612003-10-02 16:38:05 +0000535<li>The LLVM C++ front-end follows the <a
536 href="http://www.codesourcery.com/cxx-abi">Itanium C++ ABI</a>.
537 This document, which is not Itanium specific, specifies a standard for name
538 mangling, class layout, v-table layout, RTTI formats, and other C++
539 representation issues. Because we use this API, code generated by the LLVM
540 compilers should be binary compatible with machine code generated by other
541 Itanium ABI C++ compilers (such as G++, the Intel and HP compilers, etc).
542 <i>However</i>, the exception handling mechanism used by LLVM is very
543 different from the model used in the Itanium ABI, so <b>exceptions will not
Misha Brukman500bc302003-11-22 00:38:41 +0000544 interact correctly</b>. </li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000545
Misha Brukman500bc302003-11-22 00:38:41 +0000546</ul>
Chris Lattnerfcc54b32003-10-07 22:14:37 +0000547
Misha Brukman500bc302003-11-22 00:38:41 +0000548</div>
549
550<!-- ======================================================================= -->
551<div class="doc_subsection">
552 <a name="x86-be">Known problems with the X86 back-end</a>
553</div>
554
555<div class="doc_text">
556
557<ul>
Chris Lattnerde4afdc2004-02-08 22:23:33 +0000558<li>None so far.
Misha Brukman500bc302003-11-22 00:38:41 +0000559</ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000560
Misha Brukman500bc302003-11-22 00:38:41 +0000561</div>
562
563<!-- ======================================================================= -->
564<div class="doc_subsection">
565 <a name="sparc-be">Known problems with the Sparc back-end</a>
566</div>
567
568<div class="doc_text">
569
570<ul>
Chris Lattner6a39aa52004-03-19 19:22:28 +0000571<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 +0000572</ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000573
Misha Brukman500bc302003-11-22 00:38:41 +0000574</div>
575
576<!-- ======================================================================= -->
577<div class="doc_subsection">
578 <a name="c-be">Known problems with the C back-end</a>
579</div>
580
581<div class="doc_text">
582
583<ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000584
585<li>The C back-end produces code that violates the ANSI C Type-Based Alias
586Analysis rules. As such, special options may be necessary to compile the code
587(for example, GCC requires the <tt>-fno-strict-aliasing</tt> option). This
Misha Brukman500bc302003-11-22 00:38:41 +0000588problem probably cannot be fixed.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000589
Chris Lattnere84843b2003-10-20 19:05:03 +0000590<li><a href="http://llvm.cs.uiuc.edu/PR33">Initializers for global variables</a>
Misha Brukman500bc302003-11-22 00:38:41 +0000591cannot include special floating point numbers like Not-A-Number or
592Infinity.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000593
Chris Lattner2855ecd2003-11-04 20:06:53 +0000594<li><a href="http://llvm.cs.uiuc.edu/PR56">Zero arg vararg functions are not
Chris Lattner2af46052003-10-24 04:03:19 +0000595supported</a>. This should not affect LLVM produced by the C or C++
Misha Brukman500bc302003-11-22 00:38:41 +0000596frontends.</li>
Chris Lattner2af46052003-10-24 04:03:19 +0000597
Misha Brukman500bc302003-11-22 00:38:41 +0000598</ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000599
Misha Brukman500bc302003-11-22 00:38:41 +0000600</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000601
602<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000603<div class="doc_section">
604 <a name="additionalinfo">Additional Information</a>
605</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000606<!-- *********************************************************************** -->
607
Misha Brukman500bc302003-11-22 00:38:41 +0000608<div class="doc_text">
609
610<p>A wide variety of additional information is available on the LLVM web page,
John Criswelld000e1d2003-12-18 16:43:17 +0000611including mailing lists and publications describing algorithms and components
Chris Lattner79c3fe12003-10-02 04:57:28 +0000612implemented in LLVM. The web page also contains versions of the API
613documentation which is up-to-date with the CVS version of the source code. You
614can access versions of these documents specific to this release by going into
Misha Brukman500bc302003-11-22 00:38:41 +0000615the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000616
Misha Brukman500bc302003-11-22 00:38:41 +0000617<p>If you have any questions or comments about LLVM, please feel free to contact
Chris Lattner5eccca42003-12-12 21:22:16 +0000618us via the <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">mailing
619lists</a>.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000620
Misha Brukman500bc302003-11-22 00:38:41 +0000621</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000622
623<!-- *********************************************************************** -->
Chris Lattner79c3fe12003-10-02 04:57:28 +0000624
Misha Brukman500bc302003-11-22 00:38:41 +0000625<hr>
Misha Brukman2061e892003-11-22 01:23:39 +0000626<address>
Misha Brukman38847d52003-12-21 22:53:21 +0000627 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman2061e892003-11-22 01:23:39 +0000628 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
629 <a href="http://validator.w3.org/check/referer"><img
630 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
631
Misha Brukmane0c891c2003-11-22 01:00:11 +0000632 <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br>
Misha Brukman500bc302003-11-22 00:38:41 +0000633 Last modified: $Date$
Misha Brukman2061e892003-11-22 01:23:39 +0000634</address>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000635
Misha Brukman500bc302003-11-22 00:38:41 +0000636</body>
637</html>