blob: ab1b6732702d445736280ea6de0d9fd792fbe334 [file] [log] [blame]
Misha Brukman500bc302003-11-22 00:38:41 +00001<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
3<html>
4<head>
5 <link rel="stylesheet" href="llvm.css" type="text/css">
Chris Lattner2974b5b2004-04-01 00:41:31 +00006 <title>LLVM 1.3 Release Notes</title>
Misha Brukman500bc302003-11-22 00:38:41 +00007</head>
8<body>
Chris Lattner79c3fe12003-10-02 04:57:28 +00009
Chris Lattner2974b5b2004-04-01 00:41:31 +000010<div class="doc_title">LLVM 1.3 Release Notes</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +000011
12<ol>
Misha Brukman500bc302003-11-22 00:38:41 +000013 <li><a href="#intro">Introduction</a></li>
14 <li><a href="#whatsnew">What's New?</a></li>
15 <li><a href="#portability">Portability and Supported Platforms</a></li>
16 <li><a href="#install-instructions">Installation Instructions</a></li>
Chris Lattner79c3fe12003-10-02 04:57:28 +000017 <li><a href="#knownproblems">Known Problems</a>
18 <ul>
Chris Lattner2974b5b2004-04-01 00:41:31 +000019 <li><a href="#experimental">Experimental features included in this
20 release</a>
Chris Lattner79c3fe12003-10-02 04:57:28 +000021 <li><a href="#core">Known problems with the LLVM Core</a>
22 <li><a href="#c-fe">Known problems with the C Front-end</a>
23 <li><a href="#c++-fe">Known problems with the C++ Front-end</a>
24 <li><a href="#x86-be">Known problems with the X86 Back-end</a>
25 <li><a href="#sparc-be">Known problems with the Sparc Back-end</a>
26 <li><a href="#c-be">Known problems with the C back-end</a>
Misha Brukman500bc302003-11-22 00:38:41 +000027 </ul></li>
28 <li><a href="#additionalinfo">Additional Information</a></li>
Chris Lattner79c3fe12003-10-02 04:57:28 +000029</ol>
30
Misha Brukmane0c891c2003-11-22 01:00:11 +000031<div class="doc_text">
John Criswelld000e1d2003-12-18 16:43:17 +000032 <p><b>Written by the <a href="http://llvm.cs.uiuc.edu">LLVM team</a></b><p>
Misha Brukman500bc302003-11-22 00:38:41 +000033</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +000034
35<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +000036<div class="doc_section">
37 <a name="intro">Introduction</a>
38</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +000039<!-- *********************************************************************** -->
40
Misha Brukman500bc302003-11-22 00:38:41 +000041<div class="doc_text">
42
43<p>This document contains the release notes for the LLVM compiler
Chris Lattner2974b5b2004-04-01 00:41:31 +000044infrastructure, release 1.3. Here we describe the status of LLVM, including any
John Criswelld000e1d2003-12-18 16:43:17 +000045known problems and bug fixes from the previous release. The most up-to-date
Misha Brukman500bc302003-11-22 00:38:41 +000046version of this document can be found on the <a
Chris Lattner2974b5b2004-04-01 00:41:31 +000047href="http://llvm.cs.uiuc.edu/releases/1.3/">LLVM 1.3 web site</a>. If you are
John Criswelld000e1d2003-12-18 16:43:17 +000048not reading this on the LLVM web pages, you should probably go there because
Misha Brukman500bc302003-11-22 00:38:41 +000049this document may be updated after the release.</p>
Chris Lattner19092612003-10-02 16:38:05 +000050
Misha Brukman500bc302003-11-22 00:38:41 +000051<p>For more information about LLVM, including information about potentially more
Chris Lattner47ad72c2003-10-07 21:38:31 +000052current releases, please check out the <a href="http://llvm.cs.uiuc.edu">main
53web site</a>. If you have questions or comments, the <a
54href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM developer's mailing
Misha Brukman500bc302003-11-22 00:38:41 +000055list</a> is a good place to send them.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +000056
Chris Lattner9e848092003-12-12 04:25:33 +000057<p>Note that if you are reading this file from CVS, this document applies
58to the <i>next</i> release, not the current one. To see the release notes for
59the current or previous releases, see the <a
Misha Brukman500bc302003-11-22 00:38:41 +000060href="http://llvm.cs.uiuc.edu/releases/">releases page</a>.</p>
61
62</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +000063
64<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +000065<div class="doc_section">
66 <a name="whatsnew">What's New?</a>
67</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +000068<!-- *********************************************************************** -->
69
Misha Brukman500bc302003-11-22 00:38:41 +000070<div class="doc_text">
71
Chris Lattnera39719f2004-02-25 16:36:51 +000072<p>
Chris Lattner2974b5b2004-04-01 00:41:31 +000073This is the fourth public release of the LLVM compiler infrastructure.
Chris Lattnerb40efb32003-12-14 05:03:43 +000074</p>
Chris Lattnera5099962003-12-06 20:22:41 +000075
Chris Lattner835104c2004-03-17 03:54:41 +000076<p>
77At this time, LLVM is known to correctly compile and run all C &amp; C++ SPEC
78CPU2000 benchmarks, the Olden benchmarks, and the Ptrdist benchmarks. It has
79also been used to compile <b>many</b> other programs. LLVM now also works with
80a broad variety of C++ programs, though it has still received less testing than
81the C front-end.
Chris Lattnera5099962003-12-06 20:22:41 +000082</p>
83
Chris Lattnera5099962003-12-06 20:22:41 +000084<!--=========================================================================-->
85<div class="doc_subsubsection">
Chris Lattnera39719f2004-02-25 16:36:51 +000086<a name="newfeatures">This release implements the following new features:</a>
Chris Lattnera5099962003-12-06 20:22:41 +000087</div>
Chris Lattner47ad72c2003-10-07 21:38:31 +000088
89<ol>
Chris Lattner2974b5b2004-04-01 00:41:31 +000090<li>The LLVM <a href="LangRef.html#i_select"><tt>select</tt></a> instruction is
91now fully implemented and supported by all targets.</li>
Misha Brukmana7aadf12004-04-19 02:56:49 +000092<li>Bugpoint can now narrow down code-generation bugs to a loop nest, where
93before it could only narrow them down to a function being miscompiled.</li>
Chris Lattner55ee0312003-11-19 22:05:38 +000094</ol>
Chris Lattner0ef19062003-11-08 04:28:55 +000095
Chris Lattnera5099962003-12-06 20:22:41 +000096
97<!--=========================================================================-->
98<div class="doc_subsubsection">
99In this release, the following missing features were implemented:
100</div>
Chris Lattner0ef19062003-11-08 04:28:55 +0000101
102<ol>
Misha Brukmana7aadf12004-04-19 02:56:49 +0000103<li><a href="http://llvm.cs.uiuc.edu/PR82">LLVM cannot handle structures with
104more than 256 elements</a></li>
Misha Brukman500bc302003-11-22 00:38:41 +0000105</ol>
Chris Lattner47ad72c2003-10-07 21:38:31 +0000106
Chris Lattnera5099962003-12-06 20:22:41 +0000107
108<!--=========================================================================-->
109<div class="doc_subsubsection">
Misha Brukmana7aadf12004-04-19 02:56:49 +0000110<a name="qualityofimp">In this release, the following Quality of Implementation
111issues were fixed:</a>
Chris Lattnere29ac162003-12-20 03:42:11 +0000112</div>
113
114<ol>
Misha Brukmana7aadf12004-04-19 02:56:49 +0000115<li><a href="http://llvm.cs.uiuc.edu/PR305">LLVM tools will happily spew
116bytecode onto your terminal</a></li>
Chris Lattnere29ac162003-12-20 03:42:11 +0000117</ol>
118
119<!--=========================================================================-->
120<div class="doc_subsubsection">
Chris Lattnera39719f2004-02-25 16:36:51 +0000121In this release, the following build problems were fixed:
Brian Gaeke6b31beb2004-01-16 21:55:04 +0000122</div>
123
124<ol>
Chris Lattner2974b5b2004-04-01 00:41:31 +0000125<li></li>
Brian Gaeke6b31beb2004-01-16 21:55:04 +0000126</ol>
127
128<!--=========================================================================-->
129<div class="doc_subsubsection">
Misha Brukmana7aadf12004-04-19 02:56:49 +0000130<a name="codequality">In this release, the following Code Quality issues were
131fixed:</a>
Chris Lattnera5099962003-12-06 20:22:41 +0000132</div>
Chris Lattner89ca2b82003-10-27 17:06:39 +0000133
134<ol>
Chris Lattner64913402004-04-13 14:43:35 +0000135<li><a href="http://llvm.cs.uiuc.edu/PR309">[vmcore] Code quality problem due to
136long operand of getelementptr</a></li>
137
138<li>The X86 backend now generates substantially better code for 64-bit integer
139and floating point operations.</li>
140
141<li>The -inline pass no longer inlines mutually recursive functions until it
142hits the inlining threshold.</li>
143
144<li>The -inline pass no longer misses obvious inlining opportunities just
145because the callee eventually calls into an external function.</li>
146
147<li>The -simplifycfg pass can now "if convert" simple statements into the new
148<tt>select</tt> instruction.</li>
149
150<li>The -loopsimplify pass can now break <a
151href="http://llvm.cs.uiuc.edu/PR35">natural loops with multiple backedges</a>
152into multiple nested loops. This enables a variety of subsequent
153optimizations.</li>
154
155<li>The -adce pass can now eliminate calls to functions that do not not write to
156memory.</li>
157
158<li>The link-time optimizer now runs the -prune-eh pass (to remove unused
159exception handlers.</li>
160
Misha Brukman500bc302003-11-22 00:38:41 +0000161</ol>
Chris Lattner89ca2b82003-10-27 17:06:39 +0000162
Chris Lattnera5099962003-12-06 20:22:41 +0000163
164<!--=========================================================================-->
165<div class="doc_subsubsection">
Misha Brukmana7aadf12004-04-19 02:56:49 +0000166<a name="bugfix">In this release, the following bugs in the previous release
167were fixed:</a>
Chris Lattnera5099962003-12-06 20:22:41 +0000168</div>
169
170<p>Bugs in the LLVM Core:</p>
Chris Lattner47ad72c2003-10-07 21:38:31 +0000171
172<ol>
Misha Brukmana7aadf12004-04-19 02:56:49 +0000173<li><a href="http://llvm.cs.uiuc.edu/PR306">[loopsimplify] Loop simplify
174incorrectly updates dominator information</a></li>
175<li><a href="http://llvm.cs.uiuc.edu/PR310">[tailduplicate] DemoteRegToStack
176breaks SSA form</a></li>
177<li><a href="http://llvm.cs.uiuc.edu/PR313">[X86] JIT miscompiles unsigned short
178to floating point cast</a></li>
Chris Lattnera5099962003-12-06 20:22:41 +0000179</ol>
180
181
Chris Lattner56e67052004-02-09 21:22:51 +0000182
Chris Lattnera5099962003-12-06 20:22:41 +0000183<p>Bugs in the C/C++ front-end:</p>
184
185<ol>
Chris Lattner2974b5b2004-04-01 00:41:31 +0000186<li></li>
Chris Lattnera5099962003-12-06 20:22:41 +0000187</ol>
Chris Lattner19092612003-10-02 16:38:05 +0000188
Misha Brukman500bc302003-11-22 00:38:41 +0000189</div>
Chris Lattner19092612003-10-02 16:38:05 +0000190
191<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000192<div class="doc_section">
193 <a name="portability">Portability and Supported Platforms</a>
194</div>
Chris Lattner19092612003-10-02 16:38:05 +0000195<!-- *********************************************************************** -->
196
Misha Brukman500bc302003-11-22 00:38:41 +0000197<div class="doc_text">
198
199<p>LLVM has been extensively tested on Intel and AMD machines running Red
Misha Brukmana7aadf12004-04-19 02:56:49 +0000200Hat Linux and FreeBSD. It has also been tested on Sun UltraSPARC workstations
201running Solaris 8. Additionally, LLVM works on Mac OS X 10.3 and above, but
202only with the C backend or interpreter (no native backend for the PowerPC is
203available yet). The core LLVM infrastructure uses "autoconf" for portability,
204so hopefully we work on more platforms than that. However, it is likely that we
205missed something and that minor porting is required to get LLVM to work on new
206platforms. We welcome portability patches and error messages.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000207
Misha Brukman500bc302003-11-22 00:38:41 +0000208</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000209
210<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000211<div class="doc_section">
212 <a name="knownproblems">Known Problems</a>
213</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000214<!-- *********************************************************************** -->
215
Misha Brukman500bc302003-11-22 00:38:41 +0000216<div class="doc_text">
217
218<p>This section contains all known problems with the LLVM system, listed by
Chris Lattner79c3fe12003-10-02 04:57:28 +0000219component. As new problems are discovered, they will be added to these
Chris Lattner5eccca42003-12-12 21:22:16 +0000220sections. If you run into a problem, please check the <a
John Criswelld000e1d2003-12-18 16:43:17 +0000221href="http://llvm.cs.uiuc.edu/bugs/">LLVM bug database</a> and submit a bug if
Chris Lattner5eccca42003-12-12 21:22:16 +0000222there isn't already one.</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
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000226<!-- ======================================================================= -->
227<div class="doc_subsection">
228 <a name="experimental">Experimental features included with this release</a>
229</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000230
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000231<div class="doc_text">
232
233<p>
234The following components of this LLVM release are either untested, known to be
235broken or unreliable, or are in early development. These components should not
236be relied on, and bugs should not be filed against them, but they may be useful
237to some people. In particular, if you would like to work on one of these
238components, please contact us on the llvmdev list.
239</p>
240
241<ul>
242<li>The following passes are incomplete or buggy: <tt>-pgmdep, -memdep,
243 -ipmodref, -sortstructs, -swapstructs, -cee</tt></li>
244
245<li>The <tt>-pre</tt> pass is incomplete (there are cases it doesn't handle that
246 it should) and not thoroughly tested.</li>
247<li>The <tt>llvm-ar</tt> tool is incomplete and probably buggy.</li>
248<li>The <tt>llvm-db</tt> tool is in a very early stage of development.</li>
249</ul>
250
251</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000252
Misha Brukman500bc302003-11-22 00:38:41 +0000253<!-- ======================================================================= -->
254<div class="doc_subsection">
255 <a name="core">Known problems with the LLVM Core</a>
256</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000257
Misha Brukman500bc302003-11-22 00:38:41 +0000258<div class="doc_text">
259
260<ul>
261
262<li>In the JIT, <tt>dlsym</tt> on a symbol compiled by the JIT will not
263work.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000264
265<li>The JIT does not use mutexes to protect its internal data structures. As
Misha Brukman500bc302003-11-22 00:38:41 +0000266such, execution of a threaded program could cause these data structures to be
267corrupted.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000268
Misha Brukman500bc302003-11-22 00:38:41 +0000269<li>It is not possible to <tt>dlopen</tt> an LLVM bytecode file in the JIT.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000270
Chris Lattnere84843b2003-10-20 19:05:03 +0000271<li>Linking in static archive files (.a files) is very slow (there is no symbol
Misha Brukman500bc302003-11-22 00:38:41 +0000272table in the archive).</li>
Chris Lattner2855ecd2003-11-04 20:06:53 +0000273
Misha Brukmana7aadf12004-04-19 02:56:49 +0000274<li>The gccld program <a href="http://llvm.cs.uiuc.edu/PR139">does not link
275objects/archives in the order specified on the command line.</a></li>
Chris Lattner2e6fcaf2004-02-15 23:09:07 +0000276
277<li><a href="http://llvm.cs.uiuc.edu/PR240">The lower-invoke pass does not mark
John Criswelld46c6962004-03-12 21:29:42 +0000278values live across a setjmp as volatile</a>. This missing feature only affects
Chris Lattner2e6fcaf2004-02-15 23:09:07 +0000279targets whose setjmp/longjmp libraries do not save and restore the entire
280register file.</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000281</ul>
Misha Brukman500bc302003-11-22 00:38:41 +0000282</div>
283
284<!-- ======================================================================= -->
285<div class="doc_subsection">
286 <a name="c-fe">Known problems with the C front-end</a>
287</div>
Chris Lattner47588f92003-10-02 05:07:23 +0000288
Chris Lattner79c3fe12003-10-02 04:57:28 +0000289<!-- _______________________________________________________________________ -->
Chris Lattnerb40efb32003-12-14 05:03:43 +0000290<div class="doc_subsubsection">Bugs</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000291
Misha Brukman500bc302003-11-22 00:38:41 +0000292<div class="doc_text">
Misha Brukman500bc302003-11-22 00:38:41 +0000293<ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000294<li>C99 Variable sized arrays do not release stack memory when they go out of
295 scope. Thus, the following program may run out of stack space:
296<pre>
297 for (i = 0; i != 1000000; ++i) {
298 int X[n];
299 foo(X);
300 }
Misha Brukman500bc302003-11-22 00:38:41 +0000301</pre></li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000302
John Criswelld000e1d2003-12-18 16:43:17 +0000303<li>
304Initialization of global union variables can only be done
305<a href="http://llvm.cs.uiuc.edu/bugs/show_bug.cgi?id=162">with the largest
306union member</a>.
307</li>
Chris Lattnerf580cdc2004-03-16 21:39:04 +0000308
Misha Brukmana7aadf12004-04-19 02:56:49 +0000309<li><a href="http://llvm.cs.uiuc.edu/PR244">[llvm-gcc] Error when an implicitly
310external function is re-declared as static</a></li>
Chris Lattnerf580cdc2004-03-16 21:39:04 +0000311
John Criswelld000e1d2003-12-18 16:43:17 +0000312</ul>
Misha Brukman500bc302003-11-22 00:38:41 +0000313</div>
314
315<!-- _______________________________________________________________________ -->
316<div class="doc_subsubsection">
317 Notes
318</div>
319
320<div class="doc_text">
321
322<ul>
323
324<li>Inline assembly is not yet supported.</li>
Chris Lattnere01fcfb2003-10-27 18:30:37 +0000325
326<li>"long double" is transformed by the front-end into "double". There is no
Misha Brukman500bc302003-11-22 00:38:41 +0000327support for floating point data types of any size other than 32 and 64
328bits.</li>
329
330<li>The following Unix system functionality has not been tested and may not
331work:
Misha Brukmane0c891c2003-11-22 01:00:11 +0000332 <ol>
333 <li><tt>sigsetjmp</tt>, <tt>siglongjmp</tt> - These are not turned into the
334 appropriate <tt>invoke</tt>/<tt>unwind</tt> instructions. Note that
335 <tt>setjmp</tt> and <tt>longjmp</tt> <em>are</em> compiled correctly.
336 <li><tt>getcontext</tt>, <tt>setcontext</tt>, <tt>makecontext</tt>
337 - These functions have not been tested.
338 </ol></li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000339
340<li>Although many GCC extensions are supported, some are not. In particular,
341 the following extensions are known to <b>not be</b> supported:
342 <ol>
Misha Brukman500bc302003-11-22 00:38:41 +0000343 <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 +0000344 <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>
345 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Constructing-Calls.html#Constructing%20Calls">Constructing Calls</a>: Dispatching a call to another function.</li>
346 <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 +0000347 <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 +0000348 <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>
349 <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 +0000350 <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>
351 <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>
352 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Thread-Local.html#Thread-Local">Thread-Local</a>: Per-thread variables.</li>
353 <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 +0000354 </ol>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000355
Misha Brukman500bc302003-11-22 00:38:41 +0000356 <p>The following GCC extensions are <b>partially</b> supported. An ignored
Chris Lattner79c3fe12003-10-02 04:57:28 +0000357 attribute means that the LLVM compiler ignores the presence of the attribute,
358 but the code should still work. An unsupported attribute is one which is
John Criswelld000e1d2003-12-18 16:43:17 +0000359 ignored by the LLVM compiler and will cause a different interpretation of
Misha Brukman500bc302003-11-22 00:38:41 +0000360 the program.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000361
362 <ol>
363 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Length.html#Variable%20Length">Variable Length</a>:
364 Arrays whose length is computed at run time.<br>
Misha Brukman500bc302003-11-22 00:38:41 +0000365 Supported, but allocated stack space is not freed until the function returns (noted above).</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000366
367 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Attributes.html#Function%20Attributes">Function Attributes</a>:
Misha Brukman500bc302003-11-22 00:38:41 +0000368
John Criswelld000e1d2003-12-18 16:43:17 +0000369 Declaring that functions have no side effects or that they can never
Misha Brukman500bc302003-11-22 00:38:41 +0000370 return.<br>
371
372 <b>Supported:</b> <tt>format</tt>, <tt>format_arg</tt>, <tt>non_null</tt>,
373 <tt>constructor</tt>, <tt>destructor</tt>, <tt>unused</tt>,
374 <tt>deprecated</tt>, <tt>warn_unused_result</tt>, <tt>weak</tt><br>
375
376 <b>Ignored:</b> <tt>noreturn</tt>, <tt>noinline</tt>,
377 <tt>always_inline</tt>, <tt>pure</tt>, <tt>const</tt>, <tt>nothrow</tt>,
378 <tt>malloc</tt>, <tt>no_instrument_function</tt>, <tt>cdecl</tt><br>
379
380 <b>Unsupported:</b> <tt>used</tt>, <tt>section</tt>, <tt>alias</tt>,
381 <tt>visibility</tt>, <tt>regparm</tt>, <tt>stdcall</tt>,
382 <tt>fastcall</tt>, all other target specific attributes</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000383
384 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Attributes.html#Variable%20Attributes">Variable Attributes</a>:
385 Specifying attributes of variables.<br>
386 <b>Supported:</b> <tt>cleanup</tt>, <tt>common</tt>, <tt>nocommon</tt>,
387 <tt>deprecated</tt>, <tt>transparent_union</tt>,
388 <tt>unused</tt>, <tt>weak</tt><br>
Misha Brukman500bc302003-11-22 00:38:41 +0000389
Chris Lattner79c3fe12003-10-02 04:57:28 +0000390 <b>Unsupported:</b> <tt>aligned</tt>, <tt>mode</tt>, <tt>packed</tt>,
391 <tt>section</tt>, <tt>shared</tt>, <tt>tls_model</tt>,
392 <tt>vector_size</tt>, <tt>dllimport</tt>,
Misha Brukman500bc302003-11-22 00:38:41 +0000393 <tt>dllexport</tt>, all target specific attributes.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000394
Misha Brukmanc4b7bee2003-12-12 04:37:31 +0000395 <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 +0000396 <b>Supported:</b> <tt>transparent_union</tt>, <tt>unused</tt>,
Misha Brukmanc4b7bee2003-12-12 04:37:31 +0000397 <tt>deprecated</tt>, <tt>may_alias</tt><br>
Misha Brukman500bc302003-11-22 00:38:41 +0000398
399 <b>Unsupported:</b> <tt>aligned</tt>, <tt>packed</tt>,
400 all target specific attributes.</li>
401
Chris Lattner79c3fe12003-10-02 04:57:28 +0000402 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Other-Builtins.html#Other%20Builtins">Other Builtins</a>:
403 Other built-in functions.<br>
404 We support all builtins which have a C language equivalent (e.g.,
405 <tt>__builtin_cos</tt>), <tt>__builtin_alloca</tt>,
406 <tt>__builtin_types_compatible_p</tt>, <tt>__builtin_choose_expr</tt>,
Misha Brukman500bc302003-11-22 00:38:41 +0000407 <tt>__builtin_constant_p</tt>, and <tt>__builtin_expect</tt> (ignored).</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000408
Misha Brukman500bc302003-11-22 00:38:41 +0000409 </ol>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000410
Misha Brukman500bc302003-11-22 00:38:41 +0000411 <p>The following extensions <b>are</b> known to be supported:</p>
412
Chris Lattner79c3fe12003-10-02 04:57:28 +0000413 <ol>
Chris Lattner7fe97dd2004-03-16 08:54:07 +0000414 <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 +0000415 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Statement-Exprs.html#Statement%20Exprs">Statement Exprs</a>: Putting statements and declarations inside expressions.</li>
416 <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>
417 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Lvalues.html#Lvalues">Lvalues</a>: Using <code>?:</code>, "<code>,</code>" and casts in lvalues.</li>
418 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Conditionals.html#Conditionals">Conditionals</a>: Omitting the middle operand of a <code>?:</code> expression.</li>
419 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Long-Long.html#Long%20Long">Long Long</a>: Double-word integers.</li>
420 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Complex.html#Complex">Complex</a>: Data types for complex numbers.</li>
421 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Hex-Floats.html#Hex%20Floats">Hex Floats</a>:Hexadecimal floating-point constants.</li>
422 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Zero-Length.html#Zero%20Length">Zero Length</a>: Zero-length arrays.</li>
423 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Empty-Structures.html#Empty%20Structures">Empty Structures</a>: Structures with no members.</li>
424 <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>
425 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Escaped-Newlines.html#Escaped%20Newlines">Escaped Newlines</a>: Slightly looser rules for escaped newlines.</li>
426 <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 +0000427 <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 +0000428 <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 +0000429 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Compound-Literals.html#Compound%20Literals">Compound Literals</a>: Compound literals give structures, unions,
430or arrays as values.</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000431 <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 +0000432 <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 +0000433 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Case-Ranges.html#Case%20Ranges">Case Ranges</a>: `case 1 ... 9' and such.</li>
434 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Mixed-Declarations.html#Mixed%20Declarations">Mixed Declarations</a>: Mixing declarations and code.</li>
435 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Prototypes.html#Function%20Prototypes">Function Prototypes</a>: Prototype declarations and old-style definitions.</li>
436 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/C---Comments.html#C++%20Comments">C++ Comments</a>: C++ comments are recognized.</li>
437 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Dollar-Signs.html#Dollar%20Signs">Dollar Signs</a>: Dollar sign is allowed in identifiers.</li>
438 <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>
439 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Alignment.html#Alignment">Alignment</a>: Inquiring about the alignment of a type or variable.</li>
440 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Inline.html#Inline">Inline</a>: Defining inline functions (as fast as macros).</li>
441 <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>
442 <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>
443 <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 +0000444 <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 +0000445 <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>
446 <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 +0000447 </ol></li>
448
449</ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000450
Misha Brukman500bc302003-11-22 00:38:41 +0000451<p>If you run into GCC extensions which have not been included in any of these
452lists, please let us know (also including whether or not they work).</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000453
Misha Brukman500bc302003-11-22 00:38:41 +0000454</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000455
Misha Brukman500bc302003-11-22 00:38:41 +0000456<!-- ======================================================================= -->
457<div class="doc_subsection">
458 <a name="c++-fe">Known problems with the C++ front-end</a>
459</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000460
Misha Brukman500bc302003-11-22 00:38:41 +0000461<div class="doc_text">
462
John Criswelld000e1d2003-12-18 16:43:17 +0000463<p>For this release, the C++ front-end is considered to be fully functional but
Chris Lattner9e848092003-12-12 04:25:33 +0000464has not been tested as thoroughly as the C front-end. It has been tested and
465works for a number of non-trivial programs, but there may be lurking bugs.
466Please report any bugs or problems.</p>
Misha Brukman500bc302003-11-22 00:38:41 +0000467
468</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000469
470<!-- _______________________________________________________________________ -->
Chris Lattner3a51be12004-02-14 04:12:41 +0000471<div class="doc_subsubsection">Bugs</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000472
Misha Brukman500bc302003-11-22 00:38:41 +0000473<div class="doc_text">
Chris Lattner79c3fe12003-10-02 04:57:28 +0000474
Misha Brukman500bc302003-11-22 00:38:41 +0000475<ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000476<li>The C++ front-end inherits all problems afflicting the <a href="#c-fe">C
John Criswelld000e1d2003-12-18 16:43:17 +0000477 front-end</a>.</li>
John Criswelld000e1d2003-12-18 16:43:17 +0000478</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 Lattnerde4afdc2004-02-08 22:23:33 +0000524<li>None so far.
Misha Brukman500bc302003-11-22 00:38:41 +0000525</ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000526
Misha Brukman500bc302003-11-22 00:38:41 +0000527</div>
528
529<!-- ======================================================================= -->
530<div class="doc_subsection">
531 <a name="sparc-be">Known problems with the Sparc back-end</a>
532</div>
533
534<div class="doc_text">
535
536<ul>
Chris Lattner6a39aa52004-03-19 19:22:28 +0000537<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 +0000538</ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000539
Misha Brukman500bc302003-11-22 00:38:41 +0000540</div>
541
542<!-- ======================================================================= -->
543<div class="doc_subsection">
544 <a name="c-be">Known problems with the C back-end</a>
545</div>
546
547<div class="doc_text">
548
549<ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000550
551<li>The C back-end produces code that violates the ANSI C Type-Based Alias
552Analysis rules. As such, special options may be necessary to compile the code
553(for example, GCC requires the <tt>-fno-strict-aliasing</tt> option). This
Misha Brukman500bc302003-11-22 00:38:41 +0000554problem probably cannot be fixed.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000555
Chris Lattnere84843b2003-10-20 19:05:03 +0000556<li><a href="http://llvm.cs.uiuc.edu/PR33">Initializers for global variables</a>
Misha Brukman500bc302003-11-22 00:38:41 +0000557cannot include special floating point numbers like Not-A-Number or
558Infinity.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000559
Chris Lattner2855ecd2003-11-04 20:06:53 +0000560<li><a href="http://llvm.cs.uiuc.edu/PR56">Zero arg vararg functions are not
Chris Lattner2af46052003-10-24 04:03:19 +0000561supported</a>. This should not affect LLVM produced by the C or C++
Misha Brukman500bc302003-11-22 00:38:41 +0000562frontends.</li>
Chris Lattner2af46052003-10-24 04:03:19 +0000563
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>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000567
568<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000569<div class="doc_section">
570 <a name="additionalinfo">Additional Information</a>
571</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000572<!-- *********************************************************************** -->
573
Misha Brukman500bc302003-11-22 00:38:41 +0000574<div class="doc_text">
575
576<p>A wide variety of additional information is available on the LLVM web page,
John Criswelld000e1d2003-12-18 16:43:17 +0000577including mailing lists and publications describing algorithms and components
Chris Lattner79c3fe12003-10-02 04:57:28 +0000578implemented in LLVM. The web page also contains versions of the API
579documentation which is up-to-date with the CVS version of the source code. You
580can access versions of these documents specific to this release by going into
Misha Brukman500bc302003-11-22 00:38:41 +0000581the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000582
Misha Brukman500bc302003-11-22 00:38:41 +0000583<p>If you have any questions or comments about LLVM, please feel free to contact
Chris Lattner5eccca42003-12-12 21:22:16 +0000584us via the <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">mailing
585lists</a>.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000586
Misha Brukman500bc302003-11-22 00:38:41 +0000587</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000588
589<!-- *********************************************************************** -->
Chris Lattner79c3fe12003-10-02 04:57:28 +0000590
Misha Brukman500bc302003-11-22 00:38:41 +0000591<hr>
Misha Brukman2061e892003-11-22 01:23:39 +0000592<address>
Misha Brukman38847d52003-12-21 22:53:21 +0000593 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman2061e892003-11-22 01:23:39 +0000594 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
595 <a href="http://validator.w3.org/check/referer"><img
596 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
597
Misha Brukmane0c891c2003-11-22 01:00:11 +0000598 <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br>
Misha Brukman500bc302003-11-22 00:38:41 +0000599 Last modified: $Date$
Misha Brukman2061e892003-11-22 01:23:39 +0000600</address>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000601
Misha Brukman500bc302003-11-22 00:38:41 +0000602</body>
603</html>