blob: 1e2caefca4e44fa6be7b594714edecc7c61fe2e2 [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 Lattnerb40efb32003-12-14 05:03:43 +00006 <title>LLVM 1.2 Release Notes</title>
Misha Brukman500bc302003-11-22 00:38:41 +00007</head>
8<body>
Chris Lattner79c3fe12003-10-02 04:57:28 +00009
Misha Brukman500bc302003-11-22 00:38:41 +000010<div class="doc_title">
Chris Lattnerb40efb32003-12-14 05:03:43 +000011 LLVM 1.2 Release Notes
Misha Brukman500bc302003-11-22 00:38:41 +000012</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +000013
14<ol>
Misha Brukman500bc302003-11-22 00:38:41 +000015 <li><a href="#intro">Introduction</a></li>
16 <li><a href="#whatsnew">What's New?</a></li>
17 <li><a href="#portability">Portability and Supported Platforms</a></li>
18 <li><a href="#install-instructions">Installation Instructions</a></li>
Chris Lattner79c3fe12003-10-02 04:57:28 +000019 <li><a href="#knownproblems">Known Problems</a>
20 <ul>
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 Lattnerb40efb32003-12-14 05:03:43 +000044infrastructure, release 1.2. 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 Lattnerb40efb32003-12-14 05:03:43 +000047href="http://llvm.cs.uiuc.edu/releases/1.2/">LLVM 1.2 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
John Criswelld000e1d2003-12-18 16:43:17 +000072<p>This is the third public release of the LLVM compiler infrastructure.
Chris Lattnerb40efb32003-12-14 05:03:43 +000073</p>
Chris Lattnera5099962003-12-06 20:22:41 +000074
Chris Lattner1124e2c2003-12-12 21:33:08 +000075<p>At this time, LLVM is known to correctly compile and run all non-unwinding C
76&amp; C++ SPEC CPU2000 benchmarks, the Olden benchmarks, and the Ptrdist
77benchmarks. It has also been used to compile <b>many</b> other programs. LLVM
78now also works with a broad variety of C++ programs, though it has still
79received much less testing than the C front-end.
Chris Lattnera5099962003-12-06 20:22:41 +000080</p>
81
82<p>
John Criswelld000e1d2003-12-18 16:43:17 +000083The LLVM native code generators are very stable but do not currently support
Chris Lattner1124e2c2003-12-12 21:33:08 +000084unwinding (exception throwing or <tt>longjmp</tt>ing), which prevent them from
85working with programs like the <tt>253.perlbmk</tt> in SPEC CPU2000. The C
John Criswelld000e1d2003-12-18 16:43:17 +000086backend and the rest of LLVM supports these programs, so you can
Chris Lattner1124e2c2003-12-12 21:33:08 +000087still use LLVM with them. Support for unwinding will be added in a future
88release.
Chris Lattnera5099962003-12-06 20:22:41 +000089</p>
90
91
92<!--=========================================================================-->
93<div class="doc_subsubsection">
94This release implements the following new features:
95</div>
Chris Lattner47ad72c2003-10-07 21:38:31 +000096
97<ol>
Chris Lattnerb40efb32003-12-14 05:03:43 +000098<li></li>
99<li></li>
Chris Lattner55ee0312003-11-19 22:05:38 +0000100</ol>
Chris Lattner0ef19062003-11-08 04:28:55 +0000101
Chris Lattnera5099962003-12-06 20:22:41 +0000102
103<!--=========================================================================-->
104<div class="doc_subsubsection">
105In this release, the following missing features were implemented:
106</div>
Chris Lattner0ef19062003-11-08 04:28:55 +0000107
108<ol>
Chris Lattnerb40efb32003-12-14 05:03:43 +0000109<li></li>
110<li></li>
Misha Brukman500bc302003-11-22 00:38:41 +0000111</ol>
Chris Lattner47ad72c2003-10-07 21:38:31 +0000112
Chris Lattnera5099962003-12-06 20:22:41 +0000113
114<!--=========================================================================-->
115<div class="doc_subsubsection">
Chris Lattnere29ac162003-12-20 03:42:11 +0000116In this release, the following Quality of Implementation issues were fixed:
117</div>
118
119<ol>
120
121<li><a href="http://llvm.cs.uiuc.edu/PR135">JIT should lazily initialize global variables</a></li>
Chris Lattneref56a192003-12-20 10:29:02 +0000122<li><a href="http://llvm.cs.uiuc.edu/PR192">[X86] X86 Backend never releases memory for machine code structures</a></li>
Chris Lattner71f0a822003-12-23 23:50:31 +0000123<li><a href="http://llvm.cs.uiuc.edu/PR196">[vmcore] OpaqueType objects memory leak</a></li>
Chris Lattner1abc87e2004-01-08 17:20:50 +0000124<li><a href="http://llvm.cs.uiuc.edu/PR182">[llvmgcc] C front-end does not compile "extern inline" into linkonce</a></li>
Chris Lattner23632f12004-01-15 17:59:29 +0000125<li><a href="http://llvm.cs.uiuc.edu/PR73">Bytecode format inconsistent</a></li>
Chris Lattnere29ac162003-12-20 03:42:11 +0000126</ol>
127
128<!--=========================================================================-->
129<div class="doc_subsubsection">
Brian Gaeke6b31beb2004-01-16 21:55:04 +0000130In this release, the following build problems were fixed:
131</div>
132
133<ol>
134<li><a href="http://llvm.cs.uiuc.edu/PR210">[build] Makefiles break if C frontend target string has unexpected value</a></li>
135</ol>
136
137<!--=========================================================================-->
138<div class="doc_subsubsection">
Chris Lattnere29ac162003-12-20 03:42:11 +0000139In this release, the following Code Quality issues were fixed:
Chris Lattnera5099962003-12-06 20:22:41 +0000140</div>
Chris Lattner89ca2b82003-10-27 17:06:39 +0000141
142<ol>
Chris Lattner9e259062003-12-19 06:31:56 +0000143<li><a href="http://llvm.cs.uiuc.edu/PR187">[loopsimplify] Many pointless phi nodes are created</a></li>
Misha Brukman500bc302003-11-22 00:38:41 +0000144</ol>
Chris Lattner89ca2b82003-10-27 17:06:39 +0000145
Chris Lattnera5099962003-12-06 20:22:41 +0000146
147<!--=========================================================================-->
148<div class="doc_subsubsection">
149In this release, the following bugs in the previous release were fixed:
150</div>
151
152<p>Bugs in the LLVM Core:</p>
Chris Lattner47ad72c2003-10-07 21:38:31 +0000153
154<ol>
Misha Brukmanad643852003-12-15 22:48:12 +0000155<li><a href="http://llvm.cs.uiuc.edu/PR179">[licm] LICM promotes volatile memory
156locations to registers</a></li>
Chris Lattner5b7142a2003-12-18 08:16:25 +0000157<li><a href="http://llvm.cs.uiuc.edu/PR191">[licm] Memory read after free causes
158infrequent crash</a></li>
Chris Lattner5de946f2003-12-22 04:06:24 +0000159<li><a href="http://llvm.cs.uiuc.edu/PR194">[indvars] Induction variable
160canonicalization always makes 32-bit indvars</a></li>
Chris Lattner0cbdd972003-12-22 23:56:37 +0000161<li><a href="http://llvm.cs.uiuc.edu/PR193">[constantmerge] Merging globals can
162cause use of invalid pointers!</a></li>
Chris Lattnerae3664b2004-01-20 19:16:50 +0000163<li><a href="http://llvm.cs.uiuc.edu/PR212">[bcreader] Bytecode reader misreads 'long -9223372036854775808'!</a></li>
Chris Lattnerb40efb32003-12-14 05:03:43 +0000164
Chris Lattnera5099962003-12-06 20:22:41 +0000165</ol>
166
167
168<p>Bugs in the C/C++ front-end:</p>
169
170<ol>
Misha Brukmanad643852003-12-15 22:48:12 +0000171<li><a href="http://llvm.cs.uiuc.edu/PR186">Need weak linkage on memory
172management functions in libc runtime to allow them to be overriden</a></li>
Chris Lattner1abc87e2004-01-08 17:20:50 +0000173<li><a href="http://llvm.cs.uiuc.edu/PR202">[llvm-gcc] asserts when an extern inline function is redefined</a></li>
Chris Lattnerc43f91f2004-01-12 05:15:04 +0000174<li><a href="http://llvm.cs.uiuc.edu/PR204">[llvmg++] Dynamically initialized constants cannot be marked 'constant'</a></li>
Chris Lattnera5099962003-12-06 20:22:41 +0000175</ol>
Chris Lattner19092612003-10-02 16:38:05 +0000176
Misha Brukman500bc302003-11-22 00:38:41 +0000177</div>
Chris Lattner19092612003-10-02 16:38:05 +0000178
179<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000180<div class="doc_section">
181 <a name="portability">Portability and Supported Platforms</a>
182</div>
Chris Lattner19092612003-10-02 16:38:05 +0000183<!-- *********************************************************************** -->
184
Misha Brukman500bc302003-11-22 00:38:41 +0000185<div class="doc_text">
186
187<p>LLVM has been extensively tested on Intel and AMD machines running Red
Chris Lattnerb40efb32003-12-14 05:03:43 +0000188Hat Linux and FreeBSD. It has also been tested on Sun UltraSPARC workstations running Solaris 8.
John Criswellbb1bad52003-12-12 19:54:20 +0000189Additionally,
John Criswelld000e1d2003-12-18 16:43:17 +0000190LLVM works on Mac OS X 10.3 and above, but only with the C backend or
Chris Lattner9e848092003-12-12 04:25:33 +0000191interpreter (no native backend for the PowerPC is available yet).
Chris Lattner19092612003-10-02 16:38:05 +0000192The core LLVM infrastructure uses "autoconf" for portability, so hopefully we
Chris Lattner3e2959e2003-11-08 05:22:09 +0000193work on more platforms than that. However, it is likely that we
John Criswelld000e1d2003-12-18 16:43:17 +0000194missed something and that minor porting is required to get LLVM to work on
Misha Brukman500bc302003-11-22 00:38:41 +0000195new platforms. We welcome portability patches and error messages.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000196
Misha Brukman500bc302003-11-22 00:38:41 +0000197</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000198
199<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000200<div class="doc_section">
201 <a name="knownproblems">Known Problems</a>
202</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000203<!-- *********************************************************************** -->
204
Misha Brukman500bc302003-11-22 00:38:41 +0000205<div class="doc_text">
206
207<p>This section contains all known problems with the LLVM system, listed by
Chris Lattner79c3fe12003-10-02 04:57:28 +0000208component. As new problems are discovered, they will be added to these
Chris Lattner5eccca42003-12-12 21:22:16 +0000209sections. If you run into a problem, please check the <a
John Criswelld000e1d2003-12-18 16:43:17 +0000210href="http://llvm.cs.uiuc.edu/bugs/">LLVM bug database</a> and submit a bug if
Chris Lattner5eccca42003-12-12 21:22:16 +0000211there isn't already one.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000212
Misha Brukman500bc302003-11-22 00:38:41 +0000213</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000214
215<!-- _______________________________________________________________________ -->
Chris Lattner19092612003-10-02 16:38:05 +0000216<!--
Chris Lattner79c3fe12003-10-02 04:57:28 +0000217</ul><h4><a name="portability"><hr size=0>Portability Problems</h4><ul>
Chris Lattner19092612003-10-02 16:38:05 +0000218-->
Chris Lattner79c3fe12003-10-02 04:57:28 +0000219
220
Misha Brukman500bc302003-11-22 00:38:41 +0000221<!-- ======================================================================= -->
222<div class="doc_subsection">
223 <a name="core">Known problems with the LLVM Core</a>
224</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000225
Misha Brukman500bc302003-11-22 00:38:41 +0000226<div class="doc_text">
227
228<ul>
229
230<li>In the JIT, <tt>dlsym</tt> on a symbol compiled by the JIT will not
231work.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000232
233<li>The JIT does not use mutexes to protect its internal data structures. As
Misha Brukman500bc302003-11-22 00:38:41 +0000234such, execution of a threaded program could cause these data structures to be
235corrupted.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000236
Misha Brukman500bc302003-11-22 00:38:41 +0000237<li>It is not possible to <tt>dlopen</tt> an LLVM bytecode file in the JIT.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000238
Chris Lattnere84843b2003-10-20 19:05:03 +0000239<li>Linking in static archive files (.a files) is very slow (there is no symbol
Misha Brukman500bc302003-11-22 00:38:41 +0000240table in the archive).</li>
Chris Lattner2855ecd2003-11-04 20:06:53 +0000241
Chris Lattner2855ecd2003-11-04 20:06:53 +0000242<li><a href="http://llvm.cs.uiuc.edu/PR82">LLVM cannot handle structures with
Misha Brukman500bc302003-11-22 00:38:41 +0000243more than 256 elements</a>.</li>
244
John Criswelld000e1d2003-12-18 16:43:17 +0000245<li>
246The gccld program
247<a href="http://llvm.cs.uiuc.edu/bugs/show_bug.cgi?id=139">
248does not link objects/archives in the order specified on the command line.
249</a>
250</li>
251
252<li>
253<a href="http://llvm.cs.uiuc.edu/bugs/show_bug.cgi?id=174">
254Tail duplication does not update SSA form correctly.
255</a>
256</li>
Chris Lattner655c8d62004-01-18 20:13:43 +0000257
258<li><a href="http://llvm.cs.uiuc.edu/PR16">[lowerinvoke] The -lowerinvoke pass
259does not insert calls to setjmp/longjmp</a>.</li>
260
Misha Brukman500bc302003-11-22 00:38:41 +0000261</ul>
262
263</div>
264
265<!-- ======================================================================= -->
266<div class="doc_subsection">
267 <a name="c-fe">Known problems with the C front-end</a>
268</div>
Chris Lattner47588f92003-10-02 05:07:23 +0000269
Chris Lattner79c3fe12003-10-02 04:57:28 +0000270<!-- _______________________________________________________________________ -->
Chris Lattnerb40efb32003-12-14 05:03:43 +0000271<div class="doc_subsubsection">Bugs</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000272
Misha Brukman500bc302003-11-22 00:38:41 +0000273<div class="doc_text">
Misha Brukman500bc302003-11-22 00:38:41 +0000274<ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000275<li>C99 Variable sized arrays do not release stack memory when they go out of
276 scope. Thus, the following program may run out of stack space:
277<pre>
278 for (i = 0; i != 1000000; ++i) {
279 int X[n];
280 foo(X);
281 }
Misha Brukman500bc302003-11-22 00:38:41 +0000282</pre></li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000283
John Criswelld000e1d2003-12-18 16:43:17 +0000284<li>
285Initialization of global union variables can only be done
286<a href="http://llvm.cs.uiuc.edu/bugs/show_bug.cgi?id=162">with the largest
287union member</a>.
288</li>
Chris Lattnere01fcfb2003-10-27 18:30:37 +0000289
John Criswelld000e1d2003-12-18 16:43:17 +0000290<li>
291<a href="http://llvm.cs.uiuc.edu/bugs/show_bug.cgi?id=182">
292Functions marked "extern inline" are not compiled into LLVM with linkonce
293linkage.
294</a>
295</li>
296
297
298<li>
299The memory management functions in the libc runtime
300<a href="http://llvm.cs.uiuc.edu/PR186">need weak linkage so that they can be
301overridden.
302</a>
303</li>
304</ul>
Misha Brukman500bc302003-11-22 00:38:41 +0000305</div>
306
307<!-- _______________________________________________________________________ -->
308<div class="doc_subsubsection">
309 Notes
310</div>
311
312<div class="doc_text">
313
314<ul>
315
316<li>Inline assembly is not yet supported.</li>
Chris Lattnere01fcfb2003-10-27 18:30:37 +0000317
318<li>"long double" is transformed by the front-end into "double". There is no
Misha Brukman500bc302003-11-22 00:38:41 +0000319support for floating point data types of any size other than 32 and 64
320bits.</li>
321
322<li>The following Unix system functionality has not been tested and may not
323work:
Misha Brukmane0c891c2003-11-22 01:00:11 +0000324 <ol>
325 <li><tt>sigsetjmp</tt>, <tt>siglongjmp</tt> - These are not turned into the
326 appropriate <tt>invoke</tt>/<tt>unwind</tt> instructions. Note that
327 <tt>setjmp</tt> and <tt>longjmp</tt> <em>are</em> compiled correctly.
328 <li><tt>getcontext</tt>, <tt>setcontext</tt>, <tt>makecontext</tt>
329 - These functions have not been tested.
330 </ol></li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000331
332<li>Although many GCC extensions are supported, some are not. In particular,
333 the following extensions are known to <b>not be</b> supported:
334 <ol>
Misha Brukman500bc302003-11-22 00:38:41 +0000335 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Local-Labels.html#Local%20Labels">Local Labels</a>: Labels local to a block.</li>
John Criswelld000e1d2003-12-18 16:43:17 +0000336 <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 +0000337 <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>
338 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Constructing-Calls.html#Constructing%20Calls">Constructing Calls</a>: Dispatching a call to another function.</li>
339 <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 +0000340 <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 +0000341 <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>
342 <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>
343 <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>
344 <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>
345 <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>
346 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Thread-Local.html#Thread-Local">Thread-Local</a>: Per-thread variables.</li>
347 <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 +0000348 </ol>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000349
Misha Brukman500bc302003-11-22 00:38:41 +0000350 <p>The following GCC extensions are <b>partially</b> supported. An ignored
Chris Lattner79c3fe12003-10-02 04:57:28 +0000351 attribute means that the LLVM compiler ignores the presence of the attribute,
352 but the code should still work. An unsupported attribute is one which is
John Criswelld000e1d2003-12-18 16:43:17 +0000353 ignored by the LLVM compiler and will cause a different interpretation of
Misha Brukman500bc302003-11-22 00:38:41 +0000354 the program.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000355
356 <ol>
357 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Length.html#Variable%20Length">Variable Length</a>:
358 Arrays whose length is computed at run time.<br>
Misha Brukman500bc302003-11-22 00:38:41 +0000359 Supported, but allocated stack space is not freed until the function returns (noted above).</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000360
361 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Attributes.html#Function%20Attributes">Function Attributes</a>:
Misha Brukman500bc302003-11-22 00:38:41 +0000362
John Criswelld000e1d2003-12-18 16:43:17 +0000363 Declaring that functions have no side effects or that they can never
Misha Brukman500bc302003-11-22 00:38:41 +0000364 return.<br>
365
366 <b>Supported:</b> <tt>format</tt>, <tt>format_arg</tt>, <tt>non_null</tt>,
367 <tt>constructor</tt>, <tt>destructor</tt>, <tt>unused</tt>,
368 <tt>deprecated</tt>, <tt>warn_unused_result</tt>, <tt>weak</tt><br>
369
370 <b>Ignored:</b> <tt>noreturn</tt>, <tt>noinline</tt>,
371 <tt>always_inline</tt>, <tt>pure</tt>, <tt>const</tt>, <tt>nothrow</tt>,
372 <tt>malloc</tt>, <tt>no_instrument_function</tt>, <tt>cdecl</tt><br>
373
374 <b>Unsupported:</b> <tt>used</tt>, <tt>section</tt>, <tt>alias</tt>,
375 <tt>visibility</tt>, <tt>regparm</tt>, <tt>stdcall</tt>,
376 <tt>fastcall</tt>, all other target specific attributes</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000377
378 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Attributes.html#Variable%20Attributes">Variable Attributes</a>:
379 Specifying attributes of variables.<br>
380 <b>Supported:</b> <tt>cleanup</tt>, <tt>common</tt>, <tt>nocommon</tt>,
381 <tt>deprecated</tt>, <tt>transparent_union</tt>,
382 <tt>unused</tt>, <tt>weak</tt><br>
Misha Brukman500bc302003-11-22 00:38:41 +0000383
Chris Lattner79c3fe12003-10-02 04:57:28 +0000384 <b>Unsupported:</b> <tt>aligned</tt>, <tt>mode</tt>, <tt>packed</tt>,
385 <tt>section</tt>, <tt>shared</tt>, <tt>tls_model</tt>,
386 <tt>vector_size</tt>, <tt>dllimport</tt>,
Misha Brukman500bc302003-11-22 00:38:41 +0000387 <tt>dllexport</tt>, all target specific attributes.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000388
Misha Brukmanc4b7bee2003-12-12 04:37:31 +0000389 <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 +0000390 <b>Supported:</b> <tt>transparent_union</tt>, <tt>unused</tt>,
Misha Brukmanc4b7bee2003-12-12 04:37:31 +0000391 <tt>deprecated</tt>, <tt>may_alias</tt><br>
Misha Brukman500bc302003-11-22 00:38:41 +0000392
393 <b>Unsupported:</b> <tt>aligned</tt>, <tt>packed</tt>,
394 all target specific attributes.</li>
395
Chris Lattner79c3fe12003-10-02 04:57:28 +0000396 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Other-Builtins.html#Other%20Builtins">Other Builtins</a>:
397 Other built-in functions.<br>
398 We support all builtins which have a C language equivalent (e.g.,
399 <tt>__builtin_cos</tt>), <tt>__builtin_alloca</tt>,
400 <tt>__builtin_types_compatible_p</tt>, <tt>__builtin_choose_expr</tt>,
Misha Brukman500bc302003-11-22 00:38:41 +0000401 <tt>__builtin_constant_p</tt>, and <tt>__builtin_expect</tt> (ignored).</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000402
Misha Brukman500bc302003-11-22 00:38:41 +0000403 </ol>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000404
Misha Brukman500bc302003-11-22 00:38:41 +0000405 <p>The following extensions <b>are</b> known to be supported:</p>
406
Chris Lattner79c3fe12003-10-02 04:57:28 +0000407 <ol>
Misha Brukman500bc302003-11-22 00:38:41 +0000408 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Statement-Exprs.html#Statement%20Exprs">Statement Exprs</a>: Putting statements and declarations inside expressions.</li>
409 <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>
410 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Lvalues.html#Lvalues">Lvalues</a>: Using <code>?:</code>, "<code>,</code>" and casts in lvalues.</li>
411 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Conditionals.html#Conditionals">Conditionals</a>: Omitting the middle operand of a <code>?:</code> expression.</li>
412 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Long-Long.html#Long%20Long">Long Long</a>: Double-word integers.</li>
413 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Complex.html#Complex">Complex</a>: Data types for complex numbers.</li>
414 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Hex-Floats.html#Hex%20Floats">Hex Floats</a>:Hexadecimal floating-point constants.</li>
415 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Zero-Length.html#Zero%20Length">Zero Length</a>: Zero-length arrays.</li>
416 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Empty-Structures.html#Empty%20Structures">Empty Structures</a>: Structures with no members.</li>
417 <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>
418 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Escaped-Newlines.html#Escaped%20Newlines">Escaped Newlines</a>: Slightly looser rules for escaped newlines.</li>
419 <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 +0000420 <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 +0000421 <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 +0000422 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Compound-Literals.html#Compound%20Literals">Compound Literals</a>: Compound literals give structures, unions,
423or arrays as values.</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000424 <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 +0000425 <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 +0000426 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Case-Ranges.html#Case%20Ranges">Case Ranges</a>: `case 1 ... 9' and such.</li>
427 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Mixed-Declarations.html#Mixed%20Declarations">Mixed Declarations</a>: Mixing declarations and code.</li>
428 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Prototypes.html#Function%20Prototypes">Function Prototypes</a>: Prototype declarations and old-style definitions.</li>
429 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/C---Comments.html#C++%20Comments">C++ Comments</a>: C++ comments are recognized.</li>
430 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Dollar-Signs.html#Dollar%20Signs">Dollar Signs</a>: Dollar sign is allowed in identifiers.</li>
431 <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>
432 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Alignment.html#Alignment">Alignment</a>: Inquiring about the alignment of a type or variable.</li>
433 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Inline.html#Inline">Inline</a>: Defining inline functions (as fast as macros).</li>
434 <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>
435 <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>
436 <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>
437 <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>
438 <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 +0000439 </ol></li>
440
441</ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000442
Misha Brukman500bc302003-11-22 00:38:41 +0000443<p>If you run into GCC extensions which have not been included in any of these
444lists, please let us know (also including whether or not they work).</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000445
Misha Brukman500bc302003-11-22 00:38:41 +0000446</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000447
Misha Brukman500bc302003-11-22 00:38:41 +0000448<!-- ======================================================================= -->
449<div class="doc_subsection">
450 <a name="c++-fe">Known problems with the C++ front-end</a>
451</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000452
Misha Brukman500bc302003-11-22 00:38:41 +0000453<div class="doc_text">
454
John Criswelld000e1d2003-12-18 16:43:17 +0000455<p>For this release, the C++ front-end is considered to be fully functional but
Chris Lattner9e848092003-12-12 04:25:33 +0000456has not been tested as thoroughly as the C front-end. It has been tested and
457works for a number of non-trivial programs, but there may be lurking bugs.
458Please report any bugs or problems.</p>
Misha Brukman500bc302003-11-22 00:38:41 +0000459
460</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000461
462<!-- _______________________________________________________________________ -->
Misha Brukman500bc302003-11-22 00:38:41 +0000463<div class="doc_subsubsection">
464 Bugs
465</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000466
Misha Brukman500bc302003-11-22 00:38:41 +0000467<div class="doc_text">
Chris Lattner79c3fe12003-10-02 04:57:28 +0000468
Misha Brukman500bc302003-11-22 00:38:41 +0000469<ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000470<li>The C++ front-end inherits all problems afflicting the <a href="#c-fe">C
John Criswelld000e1d2003-12-18 16:43:17 +0000471 front-end</a>.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000472
John Criswelld000e1d2003-12-18 16:43:17 +0000473<li>
474<a href="http://llvm.cs.uiuc.edu/bugs/show_bug.cgi?id=137">
475Code is generated for empty classes.
476</a>
477</li>
478</ul>
Misha Brukman500bc302003-11-22 00:38:41 +0000479</div>
480
481<!-- _______________________________________________________________________ -->
482<div class="doc_subsubsection">
483 Notes
484</div>
485
486<div class="doc_text">
487
488<ul>
Chris Lattnere01fcfb2003-10-27 18:30:37 +0000489
Chris Lattner79c3fe12003-10-02 04:57:28 +0000490<li>The C++ front-end is based on a pre-release of the GCC 3.4 C++ parser. This
491parser is significantly more standards compliant (and picky) than prior GCC
492versions. For more information, see the C++ section of the <a
Chris Lattner9e848092003-12-12 04:25:33 +0000493href="http://gcc.gnu.org/gcc-3.4/changes.html">GCC 3.4 release notes</a>.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000494
495<li>Destructors for local objects are not always run when a <tt>longjmp</tt> is
Chris Lattner19092612003-10-02 16:38:05 +0000496 performed. In particular, destructors for objects in the <tt>longjmp</tt>ing
Chris Lattner79c3fe12003-10-02 04:57:28 +0000497 function and in the <tt>setjmp</tt> receiver function may not be run.
John Criswelld000e1d2003-12-18 16:43:17 +0000498 Objects in intervening stack frames will be destroyed, however (which is
Misha Brukman500bc302003-11-22 00:38:41 +0000499 better than most compilers).</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000500
Chris Lattner19092612003-10-02 16:38:05 +0000501<li>The LLVM C++ front-end follows the <a
502 href="http://www.codesourcery.com/cxx-abi">Itanium C++ ABI</a>.
503 This document, which is not Itanium specific, specifies a standard for name
504 mangling, class layout, v-table layout, RTTI formats, and other C++
505 representation issues. Because we use this API, code generated by the LLVM
506 compilers should be binary compatible with machine code generated by other
507 Itanium ABI C++ compilers (such as G++, the Intel and HP compilers, etc).
508 <i>However</i>, the exception handling mechanism used by LLVM is very
509 different from the model used in the Itanium ABI, so <b>exceptions will not
Misha Brukman500bc302003-11-22 00:38:41 +0000510 interact correctly</b>. </li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000511
Misha Brukman500bc302003-11-22 00:38:41 +0000512</ul>
Chris Lattnerfcc54b32003-10-07 22:14:37 +0000513
Misha Brukman500bc302003-11-22 00:38:41 +0000514</div>
515
516<!-- ======================================================================= -->
517<div class="doc_subsection">
518 <a name="x86-be">Known problems with the X86 back-end</a>
519</div>
520
521<div class="doc_text">
522
523<ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000524
Chris Lattnerfcc54b32003-10-07 22:14:37 +0000525<li>The X86 code generator <a
Chris Lattner0d4379a2003-10-08 06:01:38 +0000526href="http://llvm.cs.uiuc.edu/PR16">does not currently
Chris Lattnerfcc54b32003-10-07 22:14:37 +0000527support the <tt>unwind</tt> instruction</a>, so code that throws a C++ exception
Misha Brukman500bc302003-11-22 00:38:41 +0000528or calls the C <tt>longjmp</tt> function will abort.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000529
Misha Brukman500bc302003-11-22 00:38:41 +0000530</ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000531
Misha Brukman500bc302003-11-22 00:38:41 +0000532</div>
533
534<!-- ======================================================================= -->
535<div class="doc_subsection">
536 <a name="sparc-be">Known problems with the Sparc back-end</a>
537</div>
538
539<div class="doc_text">
540
541<ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000542
Chris Lattnerfcc54b32003-10-07 22:14:37 +0000543<li>The Sparc code generator <a
Chris Lattner655c8d62004-01-18 20:13:43 +0000544href="http://llvm.cs.uiuc.edu/PR16">does not currently
Chris Lattnerfcc54b32003-10-07 22:14:37 +0000545support the <tt>unwind</tt> instruction</a>, so code that throws a C++ exception
Misha Brukman500bc302003-11-22 00:38:41 +0000546or calls the C <tt>longjmp</tt> function will abort.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000547
John Criswelld000e1d2003-12-18 16:43:17 +0000548<li>
549<a href="http://llvm.cs.uiuc.edu/bugs/show_bug.cgi?id=167">
550The llc program can crash on legal code.
551</a>
552</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000553</ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000554
Misha Brukman500bc302003-11-22 00:38:41 +0000555</div>
556
557<!-- ======================================================================= -->
558<div class="doc_subsection">
559 <a name="c-be">Known problems with the C back-end</a>
560</div>
561
562<div class="doc_text">
563
564<ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000565
566<li>The C back-end produces code that violates the ANSI C Type-Based Alias
567Analysis rules. As such, special options may be necessary to compile the code
568(for example, GCC requires the <tt>-fno-strict-aliasing</tt> option). This
Misha Brukman500bc302003-11-22 00:38:41 +0000569problem probably cannot be fixed.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000570
Chris Lattnere84843b2003-10-20 19:05:03 +0000571<li><a href="http://llvm.cs.uiuc.edu/PR33">Initializers for global variables</a>
Misha Brukman500bc302003-11-22 00:38:41 +0000572cannot include special floating point numbers like Not-A-Number or
573Infinity.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000574
Chris Lattner2855ecd2003-11-04 20:06:53 +0000575<li><a href="http://llvm.cs.uiuc.edu/PR56">Zero arg vararg functions are not
Chris Lattner2af46052003-10-24 04:03:19 +0000576supported</a>. This should not affect LLVM produced by the C or C++
Misha Brukman500bc302003-11-22 00:38:41 +0000577frontends.</li>
Chris Lattner2af46052003-10-24 04:03:19 +0000578
Misha Brukman500bc302003-11-22 00:38:41 +0000579</ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000580
Misha Brukman500bc302003-11-22 00:38:41 +0000581</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000582
583<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000584<div class="doc_section">
585 <a name="additionalinfo">Additional Information</a>
586</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000587<!-- *********************************************************************** -->
588
Misha Brukman500bc302003-11-22 00:38:41 +0000589<div class="doc_text">
590
591<p>A wide variety of additional information is available on the LLVM web page,
John Criswelld000e1d2003-12-18 16:43:17 +0000592including mailing lists and publications describing algorithms and components
Chris Lattner79c3fe12003-10-02 04:57:28 +0000593implemented in LLVM. The web page also contains versions of the API
594documentation which is up-to-date with the CVS version of the source code. You
595can access versions of these documents specific to this release by going into
Misha Brukman500bc302003-11-22 00:38:41 +0000596the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000597
Misha Brukman500bc302003-11-22 00:38:41 +0000598<p>If you have any questions or comments about LLVM, please feel free to contact
Chris Lattner5eccca42003-12-12 21:22:16 +0000599us via the <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">mailing
600lists</a>.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000601
Misha Brukman500bc302003-11-22 00:38:41 +0000602</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000603
604<!-- *********************************************************************** -->
Chris Lattner79c3fe12003-10-02 04:57:28 +0000605
Misha Brukman500bc302003-11-22 00:38:41 +0000606<hr>
Misha Brukman2061e892003-11-22 01:23:39 +0000607<address>
Misha Brukman38847d52003-12-21 22:53:21 +0000608 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman2061e892003-11-22 01:23:39 +0000609 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
610 <a href="http://validator.w3.org/check/referer"><img
611 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
612
Misha Brukmane0c891c2003-11-22 01:00:11 +0000613 <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br>
Misha Brukman500bc302003-11-22 00:38:41 +0000614 Last modified: $Date$
Misha Brukman2061e892003-11-22 01:23:39 +0000615</address>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000616
Misha Brukman500bc302003-11-22 00:38:41 +0000617</body>
618</html>