blob: 9da8786fe7ce334c9bdf9ad3366684884cd788a2 [file] [log] [blame]
Misha Brukman80731b92003-11-22 00:38:41 +00001<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
3<html>
4<head>
Reid Spencere4190fa2004-11-18 18:38:58 +00005 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
Misha Brukman80731b92003-11-22 00:38:41 +00006 <link rel="stylesheet" href="llvm.css" type="text/css">
Chris Lattnerf3a7c242004-12-09 22:22:58 +00007 <title>LLVM 1.5 Release Notes</title>
Misha Brukman80731b92003-11-22 00:38:41 +00008</head>
9<body>
Chris Lattner3d482502003-10-02 04:57:28 +000010
Chris Lattnerf3a7c242004-12-09 22:22:58 +000011<div class="doc_title">LLVM 1.5 Release Notes</div>
Chris Lattner3d482502003-10-02 04:57:28 +000012
13<ol>
Misha Brukman80731b92003-11-22 00:38:41 +000014 <li><a href="#intro">Introduction</a></li>
15 <li><a href="#whatsnew">What's New?</a></li>
Chris Lattner77a51732004-04-30 22:17:12 +000016 <li><a href="GettingStarted.html">Installation Instructions</a></li>
Misha Brukman80731b92003-11-22 00:38:41 +000017 <li><a href="#portability">Portability and Supported Platforms</a></li>
Chris Lattner3d482502003-10-02 04:57:28 +000018 <li><a href="#knownproblems">Known Problems</a>
19 <ul>
Chris Lattner1a7e43c2004-04-01 00:41:31 +000020 <li><a href="#experimental">Experimental features included in this
21 release</a>
Chris Lattner3d482502003-10-02 04:57:28 +000022 <li><a href="#core">Known problems with the LLVM Core</a>
23 <li><a href="#c-fe">Known problems with the C Front-end</a>
24 <li><a href="#c++-fe">Known problems with the C++ Front-end</a>
25 <li><a href="#x86-be">Known problems with the X86 Back-end</a>
Misha Brukmana516e992004-07-12 16:55:41 +000026 <li><a href="#sparcv9-be">Known problems with the SparcV9 Back-end</a>
Chris Lattnerdf925ce2004-11-07 01:55:32 +000027 <li><a href="#ppc-be">Known problems with the PowerPC Back-end</a>
Chris Lattner3d482502003-10-02 04:57:28 +000028 <li><a href="#c-be">Known problems with the C back-end</a>
Misha Brukman80731b92003-11-22 00:38:41 +000029 </ul></li>
30 <li><a href="#additionalinfo">Additional Information</a></li>
Chris Lattner3d482502003-10-02 04:57:28 +000031</ol>
32
Chris Lattner020e1fc2004-05-23 21:07:27 +000033<div class="doc_author">
Chris Lattnerf3a7c242004-12-09 22:22:58 +000034 <p>Written by the <a href="http://llvm.cs.uiuc.edu">LLVM Team</a><p>
Misha Brukman80731b92003-11-22 00:38:41 +000035</div>
Chris Lattner3d482502003-10-02 04:57:28 +000036
37<!-- *********************************************************************** -->
Misha Brukman80731b92003-11-22 00:38:41 +000038<div class="doc_section">
39 <a name="intro">Introduction</a>
40</div>
Chris Lattner3d482502003-10-02 04:57:28 +000041<!-- *********************************************************************** -->
42
Misha Brukman80731b92003-11-22 00:38:41 +000043<div class="doc_text">
44
45<p>This document contains the release notes for the LLVM compiler
Chris Lattnerf3a7c242004-12-09 22:22:58 +000046infrastructure, release 1.5. Here we describe the status of LLVM, including any
Chris Lattnerb5bb5972004-12-07 08:04:13 +000047known problems and improvements from the previous release. The most up-to-date
Misha Brukman80731b92003-11-22 00:38:41 +000048version of this document can be found on the <a
Chris Lattnerf3a7c242004-12-09 22:22:58 +000049href="http://llvm.cs.uiuc.edu/releases/1.5/">LLVM 1.5 web site</a>. If you are
John Criswell86a3a482003-12-18 16:43:17 +000050not reading this on the LLVM web pages, you should probably go there because
Misha Brukman80731b92003-11-22 00:38:41 +000051this document may be updated after the release.</p>
Chris Lattner62495762003-10-02 16:38:05 +000052
Chris Lattnerb5bb5972004-12-07 08:04:13 +000053<p>For more information about LLVM, including information about the latest
54release, please check out the <a href="http://llvm.cs.uiuc.edu">main LLVM
Chris Lattnere7525b52003-10-07 21:38:31 +000055web site</a>. If you have questions or comments, the <a
56href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM developer's mailing
Misha Brukman80731b92003-11-22 00:38:41 +000057list</a> is a good place to send them.</p>
Chris Lattner3d482502003-10-02 04:57:28 +000058
Chris Lattnerf3a7c242004-12-09 22:22:58 +000059<p>Note that if you are reading this file from CVS or the main LLVM web page,
60this document applies to the <i>next</i> release, not the current one. To see
61the release notes for the current or previous releases, see the <a
Misha Brukman80731b92003-11-22 00:38:41 +000062href="http://llvm.cs.uiuc.edu/releases/">releases page</a>.</p>
63
64</div>
Chris Lattner3d482502003-10-02 04:57:28 +000065
66<!-- *********************************************************************** -->
Misha Brukman80731b92003-11-22 00:38:41 +000067<div class="doc_section">
68 <a name="whatsnew">What's New?</a>
69</div>
Chris Lattner3d482502003-10-02 04:57:28 +000070<!-- *********************************************************************** -->
71
Misha Brukman80731b92003-11-22 00:38:41 +000072<div class="doc_text">
73
Chris Lattnerf3a7c242004-12-09 22:22:58 +000074<p>This is the sixth public release of the LLVM compiler infrastructure.</p>
Chris Lattnerba7bd472003-12-06 20:22:41 +000075
Chris Lattner7c0241c2004-12-10 16:27:34 +000076<p> At this time, LLVM is known to correctly compile a broad range of C and
Chris Lattnerf3a7c242004-12-09 22:22:58 +000077C++ programs, including the SPEC CPU95 &amp; 2000 suite. TODO. It also includes
78bug fixes for those problems found since the 1.4 release.</p>
Chris Lattnerba7bd472003-12-06 20:22:41 +000079
Chris Lattner21a90402004-05-24 04:50:25 +000080</div>
81
Chris Lattnerba7bd472003-12-06 20:22:41 +000082<!--=========================================================================-->
83<div class="doc_subsubsection">
Chris Lattner8ebf2532004-02-25 16:36:51 +000084<a name="newfeatures">This release implements the following new features:</a>
Chris Lattnerba7bd472003-12-06 20:22:41 +000085</div>
Chris Lattnere7525b52003-10-07 21:38:31 +000086
Chris Lattner21a90402004-05-24 04:50:25 +000087<div class="doc_text">
Chris Lattnere7525b52003-10-07 21:38:31 +000088<ol>
Chris Lattnerf3a7c242004-12-09 22:22:58 +000089 <li></li>
Chris Lattner592db402003-11-19 22:05:38 +000090</ol>
Chris Lattner4491de62003-11-08 04:28:55 +000091
Chris Lattner21a90402004-05-24 04:50:25 +000092</div>
93
Chris Lattnerba7bd472003-12-06 20:22:41 +000094
95<!--=========================================================================-->
96<div class="doc_subsubsection">
97In this release, the following missing features were implemented:
98</div>
Chris Lattner4491de62003-11-08 04:28:55 +000099
Chris Lattner21a90402004-05-24 04:50:25 +0000100<div class="doc_text">
101
Chris Lattner4491de62003-11-08 04:28:55 +0000102<ol>
Chris Lattnerf3a7c242004-12-09 22:22:58 +0000103 <li></li>
Misha Brukman80731b92003-11-22 00:38:41 +0000104</ol>
Chris Lattnere7525b52003-10-07 21:38:31 +0000105
Chris Lattner21a90402004-05-24 04:50:25 +0000106</div>
Chris Lattnerba7bd472003-12-06 20:22:41 +0000107
108<!--=========================================================================-->
109<div class="doc_subsubsection">
Misha Brukman017f2f32004-04-19 02:56:49 +0000110<a name="qualityofimp">In this release, the following Quality of Implementation
111issues were fixed:</a>
Chris Lattner4df78f02003-12-20 03:42:11 +0000112</div>
113
Chris Lattner21a90402004-05-24 04:50:25 +0000114<div class="doc_text">
115
Chris Lattner4df78f02003-12-20 03:42:11 +0000116<ol>
Chris Lattnerf3a7c242004-12-09 22:22:58 +0000117 <li></li>
Brian Gaeke8b05e4f2004-01-16 21:55:04 +0000118</ol>
Chris Lattner21a90402004-05-24 04:50:25 +0000119</div>
Brian Gaeke8b05e4f2004-01-16 21:55:04 +0000120
121<!--=========================================================================-->
122<div class="doc_subsubsection">
Chris Lattner2ad48782004-05-02 04:19:15 +0000123<a name="codequality">This release includes the following Code Quality
124improvements:</a>
Chris Lattner23257062004-05-23 20:42:08 +0000125</div>
Chris Lattner639579c2003-10-27 17:06:39 +0000126
Chris Lattner21a90402004-05-24 04:50:25 +0000127<div class="doc_text">
Chris Lattner639579c2003-10-27 17:06:39 +0000128<ol>
Chris Lattnerf3a7c242004-12-09 22:22:58 +0000129 <li></li>
Misha Brukman80731b92003-11-22 00:38:41 +0000130</ol>
Reid Spencer3e58f582004-05-23 17:23:13 +0000131</div>
Chris Lattnerba7bd472003-12-06 20:22:41 +0000132
133<!--=========================================================================-->
134<div class="doc_subsubsection">
Misha Brukman017f2f32004-04-19 02:56:49 +0000135<a name="bugfix">In this release, the following bugs in the previous release
136were fixed:</a>
Chris Lattnerba7bd472003-12-06 20:22:41 +0000137</div>
138
Chris Lattner21a90402004-05-24 04:50:25 +0000139<div class="doc_text">
140
Chris Lattner5cd40922004-08-02 20:28:44 +0000141<p>Bugs fixed in the LLVM Core:</p>
Chris Lattnere7525b52003-10-07 21:38:31 +0000142
143<ol>
Chris Lattnerf3a7c242004-12-09 22:22:58 +0000144 <li></li>
Chris Lattnerba7bd472003-12-06 20:22:41 +0000145</ol>
146
Chris Lattnerba7bd472003-12-06 20:22:41 +0000147<p>Bugs in the C/C++ front-end:</p>
148
149<ol>
Chris Lattnerf3a7c242004-12-09 22:22:58 +0000150 <li></li>
Brian Gaeke730d8d62004-08-24 07:43:48 +0000151</ol>
152
Chris Lattner21a90402004-05-24 04:50:25 +0000153</div>
Reid Spencer3e58f582004-05-23 17:23:13 +0000154
Chris Lattner62495762003-10-02 16:38:05 +0000155<!-- *********************************************************************** -->
Misha Brukman80731b92003-11-22 00:38:41 +0000156<div class="doc_section">
157 <a name="portability">Portability and Supported Platforms</a>
158</div>
Chris Lattner62495762003-10-02 16:38:05 +0000159<!-- *********************************************************************** -->
160
Misha Brukman80731b92003-11-22 00:38:41 +0000161<div class="doc_text">
162
John Criswell64307722004-12-08 20:35:47 +0000163<p>LLVM is known to work on the following platforms:</p>
Chris Lattner2c7b0872004-06-01 18:22:41 +0000164
165<ul>
166<li>Intel and AMD machines running Red Hat Linux and FreeBSD (and probably
167 other unix-like systems).</li>
168<li>Sun UltraSPARC workstations running Solaris 8.</li>
Chris Lattnerb5bb5972004-12-07 08:04:13 +0000169<li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
170 support is available for native builds with Visual C++).</li>
171<li>PowerPC-based Mac OS X systems, running 10.2 and above.</li>
Chris Lattner2c7b0872004-06-01 18:22:41 +0000172</ul>
173
Brian Gaekee3e557e2004-05-09 05:28:35 +0000174<p>The core LLVM infrastructure uses
175<a href="http://www.gnu.org/software/autoconf/">GNU autoconf</a> to adapt itself
176to the machine and operating system on which it is built. However, minor
177porting may be required to get LLVM to work on new platforms. We welcome your
178portability patches and reports of successful builds or error messages.</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000179
Misha Brukman80731b92003-11-22 00:38:41 +0000180</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000181
182<!-- *********************************************************************** -->
Misha Brukman80731b92003-11-22 00:38:41 +0000183<div class="doc_section">
184 <a name="knownproblems">Known Problems</a>
185</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000186<!-- *********************************************************************** -->
187
Misha Brukman80731b92003-11-22 00:38:41 +0000188<div class="doc_text">
189
190<p>This section contains all known problems with the LLVM system, listed by
Chris Lattner3d482502003-10-02 04:57:28 +0000191component. As new problems are discovered, they will be added to these
Chris Lattnerb84f3322003-12-12 21:22:16 +0000192sections. If you run into a problem, please check the <a
John Criswell86a3a482003-12-18 16:43:17 +0000193href="http://llvm.cs.uiuc.edu/bugs/">LLVM bug database</a> and submit a bug if
Chris Lattnerb84f3322003-12-12 21:22:16 +0000194there isn't already one.</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000195
Misha Brukman80731b92003-11-22 00:38:41 +0000196</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000197
Chris Lattnerb911de42004-03-14 02:03:02 +0000198<!-- ======================================================================= -->
199<div class="doc_subsection">
200 <a name="experimental">Experimental features included with this release</a>
201</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000202
Chris Lattnerb911de42004-03-14 02:03:02 +0000203<div class="doc_text">
204
Misha Brukmanfa50a222004-05-12 21:46:05 +0000205<p>The following components of this LLVM release are either untested, known to
206be broken or unreliable, or are in early development. These components should
207not be relied on, and bugs should not be filed against them, but they may be
208useful to some people. In particular, if you would like to work on one of these
209components, please contact us on the llvmdev list.</p>
Chris Lattnerb911de42004-03-14 02:03:02 +0000210
211<ul>
Chris Lattnerb5bb5972004-12-07 08:04:13 +0000212<li>The following passes are incomplete or buggy, and may be removed in future
213 releases: <tt>-pgmdep, -memdep, -ipmodref, -cee, -branch-combine,
214 -instloops, -paths, -pre</tt></li>
215<li>The <tt>llvm-db</tt> tool is in a very early stage of development, but can
216 be used to step through programs and inspect the stack.</li>
Chris Lattnerfa835102004-12-02 17:20:17 +0000217<li>The "iterative scan" register allocator (enabled with -regalloc=iterativescan)
218 is not stable.</li>
Chris Lattnerb911de42004-03-14 02:03:02 +0000219</ul>
220
221</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000222
Misha Brukman80731b92003-11-22 00:38:41 +0000223<!-- ======================================================================= -->
224<div class="doc_subsection">
225 <a name="core">Known problems with the LLVM Core</a>
226</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000227
Misha Brukman80731b92003-11-22 00:38:41 +0000228<div class="doc_text">
229
230<ul>
Reid Spencer493d9c22004-11-25 22:38:30 +0000231 <li>In the JIT, <tt>dlsym</tt> on a symbol compiled by the JIT will not work.
232 </li>
233 <li>The JIT does not use mutexes to protect its internal data structures. As
234 such, execution of a threaded program could cause these data structures to be
235 corrupted.
236 </li>
Reid Spencer493d9c22004-11-25 22:38:30 +0000237 <li><a href="http://llvm.cs.uiuc.edu/PR240">The lower-invoke pass does not
238 mark values live across a setjmp as volatile</a>. This missing feature
239 only affects targets whose setjmp/longjmp libraries do not save and restore
240 the entire register file.</li>
Misha Brukman80731b92003-11-22 00:38:41 +0000241</ul>
Misha Brukman80731b92003-11-22 00:38:41 +0000242</div>
243
244<!-- ======================================================================= -->
245<div class="doc_subsection">
246 <a name="c-fe">Known problems with the C front-end</a>
247</div>
Chris Lattner178f3db2003-10-02 05:07:23 +0000248
Chris Lattner3d482502003-10-02 04:57:28 +0000249<!-- _______________________________________________________________________ -->
Chris Lattner5a8a7282003-12-14 05:03:43 +0000250<div class="doc_subsubsection">Bugs</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000251
Misha Brukman80731b92003-11-22 00:38:41 +0000252<div class="doc_text">
Misha Brukman80731b92003-11-22 00:38:41 +0000253<ul>
Chris Lattner3d482502003-10-02 04:57:28 +0000254<li>C99 Variable sized arrays do not release stack memory when they go out of
255 scope. Thus, the following program may run out of stack space:
256<pre>
257 for (i = 0; i != 1000000; ++i) {
258 int X[n];
259 foo(X);
260 }
Misha Brukman80731b92003-11-22 00:38:41 +0000261</pre></li>
Chris Lattner3d482502003-10-02 04:57:28 +0000262
Misha Brukmanfa50a222004-05-12 21:46:05 +0000263<li>Initialization of global union variables can only be done <a
Misha Brukman68ef9a92004-12-04 00:45:09 +0000264href="http://llvm.cs.uiuc.edu/PR162">with the largest union member</a>.</li>
Chris Lattner1ab58dd2004-03-16 21:39:04 +0000265
John Criswell86a3a482003-12-18 16:43:17 +0000266</ul>
Misha Brukman80731b92003-11-22 00:38:41 +0000267</div>
268
269<!-- _______________________________________________________________________ -->
270<div class="doc_subsubsection">
271 Notes
272</div>
273
274<div class="doc_text">
275
276<ul>
277
278<li>Inline assembly is not yet supported.</li>
Chris Lattnerd2a74272003-10-27 18:30:37 +0000279
280<li>"long double" is transformed by the front-end into "double". There is no
Misha Brukman80731b92003-11-22 00:38:41 +0000281support for floating point data types of any size other than 32 and 64
282bits.</li>
283
284<li>The following Unix system functionality has not been tested and may not
285work:
Misha Brukman7cb4e382003-11-22 01:00:11 +0000286 <ol>
287 <li><tt>sigsetjmp</tt>, <tt>siglongjmp</tt> - These are not turned into the
288 appropriate <tt>invoke</tt>/<tt>unwind</tt> instructions. Note that
289 <tt>setjmp</tt> and <tt>longjmp</tt> <em>are</em> compiled correctly.
290 <li><tt>getcontext</tt>, <tt>setcontext</tt>, <tt>makecontext</tt>
291 - These functions have not been tested.
292 </ol></li>
Chris Lattner3d482502003-10-02 04:57:28 +0000293
294<li>Although many GCC extensions are supported, some are not. In particular,
295 the following extensions are known to <b>not be</b> supported:
296 <ol>
Misha Brukman80731b92003-11-22 00:38:41 +0000297 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Local-Labels.html#Local%20Labels">Local Labels</a>: Labels local to a block.</li>
Misha Brukman80731b92003-11-22 00:38:41 +0000298 <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>
299 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Constructing-Calls.html#Constructing%20Calls">Constructing Calls</a>: Dispatching a call to another function.</li>
300 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Extended-Asm.html#Extended%20Asm">Extended Asm</a>: Assembler instructions with C expressions as operands.</li>
John Criswell86a3a482003-12-18 16:43:17 +0000301 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Constraints.html#Constraints">Constraints</a>: Constraints for asm operands.</li>
Misha Brukman80731b92003-11-22 00:38:41 +0000302 <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>
303 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Explicit-Reg-Vars.html#Explicit%20Reg%20Vars">Explicit Reg Vars</a>: Defining variables residing in specified registers.</li>
Misha Brukman80731b92003-11-22 00:38:41 +0000304 <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>
305 <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>
Tanya Lattner63371342004-12-08 18:25:34 +0000306 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Thread_002dLocal.html">Thread-Local</a>: Per-thread variables.</li>
Misha Brukman80731b92003-11-22 00:38:41 +0000307 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Pragmas.html#Pragmas">Pragmas</a>: Pragmas accepted by GCC.</li>
Misha Brukman7cb4e382003-11-22 01:00:11 +0000308 </ol>
Chris Lattner3d482502003-10-02 04:57:28 +0000309
Misha Brukman80731b92003-11-22 00:38:41 +0000310 <p>The following GCC extensions are <b>partially</b> supported. An ignored
Chris Lattner3d482502003-10-02 04:57:28 +0000311 attribute means that the LLVM compiler ignores the presence of the attribute,
312 but the code should still work. An unsupported attribute is one which is
John Criswell86a3a482003-12-18 16:43:17 +0000313 ignored by the LLVM compiler and will cause a different interpretation of
Misha Brukman80731b92003-11-22 00:38:41 +0000314 the program.</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000315
316 <ol>
317 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Length.html#Variable%20Length">Variable Length</a>:
318 Arrays whose length is computed at run time.<br>
Misha Brukman80731b92003-11-22 00:38:41 +0000319 Supported, but allocated stack space is not freed until the function returns (noted above).</li>
Chris Lattner3d482502003-10-02 04:57:28 +0000320
321 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Attributes.html#Function%20Attributes">Function Attributes</a>:
Misha Brukman80731b92003-11-22 00:38:41 +0000322
John Criswell86a3a482003-12-18 16:43:17 +0000323 Declaring that functions have no side effects or that they can never
Misha Brukman80731b92003-11-22 00:38:41 +0000324 return.<br>
325
326 <b>Supported:</b> <tt>format</tt>, <tt>format_arg</tt>, <tt>non_null</tt>,
John Criswell64307722004-12-08 20:35:47 +0000327 <tt>noreturn</tt>, <tt>constructor</tt>, <tt>destructor</tt>,
328 <tt>unused</tt>,
Misha Brukman80731b92003-11-22 00:38:41 +0000329 <tt>deprecated</tt>, <tt>warn_unused_result</tt>, <tt>weak</tt><br>
330
John Criswell64307722004-12-08 20:35:47 +0000331 <b>Ignored:</b> <tt>noinline</tt>,
Misha Brukman80731b92003-11-22 00:38:41 +0000332 <tt>always_inline</tt>, <tt>pure</tt>, <tt>const</tt>, <tt>nothrow</tt>,
333 <tt>malloc</tt>, <tt>no_instrument_function</tt>, <tt>cdecl</tt><br>
334
335 <b>Unsupported:</b> <tt>used</tt>, <tt>section</tt>, <tt>alias</tt>,
336 <tt>visibility</tt>, <tt>regparm</tt>, <tt>stdcall</tt>,
337 <tt>fastcall</tt>, all other target specific attributes</li>
Chris Lattner3d482502003-10-02 04:57:28 +0000338
339 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Attributes.html#Variable%20Attributes">Variable Attributes</a>:
340 Specifying attributes of variables.<br>
341 <b>Supported:</b> <tt>cleanup</tt>, <tt>common</tt>, <tt>nocommon</tt>,
342 <tt>deprecated</tt>, <tt>transparent_union</tt>,
343 <tt>unused</tt>, <tt>weak</tt><br>
Misha Brukman80731b92003-11-22 00:38:41 +0000344
Chris Lattner3d482502003-10-02 04:57:28 +0000345 <b>Unsupported:</b> <tt>aligned</tt>, <tt>mode</tt>, <tt>packed</tt>,
346 <tt>section</tt>, <tt>shared</tt>, <tt>tls_model</tt>,
347 <tt>vector_size</tt>, <tt>dllimport</tt>,
Misha Brukman80731b92003-11-22 00:38:41 +0000348 <tt>dllexport</tt>, all target specific attributes.</li>
Chris Lattner3d482502003-10-02 04:57:28 +0000349
Misha Brukman8395d732003-12-12 04:37:31 +0000350 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Type-Attributes.html#Type%20Attributes">Type Attributes</a>: Specifying attributes of types.<br>
Chris Lattner3d482502003-10-02 04:57:28 +0000351 <b>Supported:</b> <tt>transparent_union</tt>, <tt>unused</tt>,
Misha Brukman8395d732003-12-12 04:37:31 +0000352 <tt>deprecated</tt>, <tt>may_alias</tt><br>
Misha Brukman80731b92003-11-22 00:38:41 +0000353
354 <b>Unsupported:</b> <tt>aligned</tt>, <tt>packed</tt>,
355 all target specific attributes.</li>
356
Chris Lattner3d482502003-10-02 04:57:28 +0000357 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Other-Builtins.html#Other%20Builtins">Other Builtins</a>:
358 Other built-in functions.<br>
359 We support all builtins which have a C language equivalent (e.g.,
360 <tt>__builtin_cos</tt>), <tt>__builtin_alloca</tt>,
361 <tt>__builtin_types_compatible_p</tt>, <tt>__builtin_choose_expr</tt>,
Chris Lattnerb7c4bac2004-06-18 06:26:29 +0000362 <tt>__builtin_constant_p</tt>, and <tt>__builtin_expect</tt>
363 (currently ignored). We also support builtins for ISO C99 floating
364 point comparison macros (e.g., <tt>__builtin_islessequal</tt>).</li>
Misha Brukman80731b92003-11-22 00:38:41 +0000365 </ol>
Chris Lattner3d482502003-10-02 04:57:28 +0000366
Misha Brukman80731b92003-11-22 00:38:41 +0000367 <p>The following extensions <b>are</b> known to be supported:</p>
368
Chris Lattner3d482502003-10-02 04:57:28 +0000369 <ol>
Chris Lattnerd3dc8502004-03-16 08:54:07 +0000370 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Labels-as-Values.html#Labels%20as%20Values">Labels as Values</a>: Getting pointers to labels and computed gotos.</li>
Misha Brukman80731b92003-11-22 00:38:41 +0000371 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Statement-Exprs.html#Statement%20Exprs">Statement Exprs</a>: Putting statements and declarations inside expressions.</li>
372 <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>
Tanya Lattnerce33a1b2004-06-22 03:48:17 +0000373 <li><a href="http://gcc.gnu.org/onlinedocs/gcc-3.4.0/gcc/Lvalues.html#Lvalues">Lvalues</a>: Using <code>?:</code>, "<code>,</code>" and casts in lvalues.</li>
Misha Brukman80731b92003-11-22 00:38:41 +0000374 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Conditionals.html#Conditionals">Conditionals</a>: Omitting the middle operand of a <code>?:</code> expression.</li>
375 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Long-Long.html#Long%20Long">Long Long</a>: Double-word integers.</li>
376 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Complex.html#Complex">Complex</a>: Data types for complex numbers.</li>
377 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Hex-Floats.html#Hex%20Floats">Hex Floats</a>:Hexadecimal floating-point constants.</li>
378 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Zero-Length.html#Zero%20Length">Zero Length</a>: Zero-length arrays.</li>
379 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Empty-Structures.html#Empty%20Structures">Empty Structures</a>: Structures with no members.</li>
380 <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>
381 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Escaped-Newlines.html#Escaped%20Newlines">Escaped Newlines</a>: Slightly looser rules for escaped newlines.</li>
382 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Subscripting.html#Subscripting">Subscripting</a>: Any array can be subscripted, even if not an lvalue.</li>
Misha Brukman8395d732003-12-12 04:37:31 +0000383 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Pointer-Arith.html#Pointer%20Arith">Pointer Arith</a>: Arithmetic on <code>void</code>-pointers and function pointers.</li>
Misha Brukman80731b92003-11-22 00:38:41 +0000384 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Initializers.html#Initializers">Initializers</a>: Non-constant initializers.</li>
John Criswell86a3a482003-12-18 16:43:17 +0000385 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Compound-Literals.html#Compound%20Literals">Compound Literals</a>: Compound literals give structures, unions,
386or arrays as values.</li>
Misha Brukman80731b92003-11-22 00:38:41 +0000387 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Designated-Inits.html#Designated%20Inits">Designated Inits</a>: Labeling elements of initializers.</li>
Misha Brukman8395d732003-12-12 04:37:31 +0000388 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Cast-to-Union.html#Cast%20to%20Union">Cast to Union</a>: Casting to union type from any member of the union.</li>
Misha Brukman80731b92003-11-22 00:38:41 +0000389 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Case-Ranges.html#Case%20Ranges">Case Ranges</a>: `case 1 ... 9' and such.</li>
390 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Mixed-Declarations.html#Mixed%20Declarations">Mixed Declarations</a>: Mixing declarations and code.</li>
391 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Prototypes.html#Function%20Prototypes">Function Prototypes</a>: Prototype declarations and old-style definitions.</li>
Tanya Lattner7591b822004-12-08 18:29:38 +0000392 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/C_002b_002b-Comments.html#C_002b_002b-Comments">C++ Comments</a>: C++ comments are recognized.</li>
Misha Brukman80731b92003-11-22 00:38:41 +0000393 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Dollar-Signs.html#Dollar%20Signs">Dollar Signs</a>: Dollar sign is allowed in identifiers.</li>
394 <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>
395 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Alignment.html#Alignment">Alignment</a>: Inquiring about the alignment of a type or variable.</li>
396 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Inline.html#Inline">Inline</a>: Defining inline functions (as fast as macros).</li>
397 <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>
398 <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>
399 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Names.html#Function%20Names">Function Names</a>: Printable strings which are the name of the current function.</li>
Chris Lattner3646dad2004-02-14 04:08:29 +0000400 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Return-Address.html#Return%20Address">Return Address</a>: Getting the return or frame address of a function.</li>
Misha Brukman80731b92003-11-22 00:38:41 +0000401 <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>
402 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Attribute-Syntax.html#Attribute%20Syntax">Attribute Syntax</a>: Formal syntax for attributes.</li>
Misha Brukman7cb4e382003-11-22 01:00:11 +0000403 </ol></li>
404
405</ul>
Chris Lattner3d482502003-10-02 04:57:28 +0000406
Misha Brukman80731b92003-11-22 00:38:41 +0000407<p>If you run into GCC extensions which have not been included in any of these
408lists, please let us know (also including whether or not they work).</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000409
Misha Brukman80731b92003-11-22 00:38:41 +0000410</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000411
Misha Brukman80731b92003-11-22 00:38:41 +0000412<!-- ======================================================================= -->
413<div class="doc_subsection">
414 <a name="c++-fe">Known problems with the C++ front-end</a>
415</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000416
Misha Brukman80731b92003-11-22 00:38:41 +0000417<div class="doc_text">
418
Reid Spencer55684c32004-12-07 08:39:08 +0000419<p>For this release, the C++ front-end is considered to be fully
Chris Lattnerb5bb5972004-12-07 08:04:13 +0000420tested and works for a number of non-trivial programs, including LLVM
421itself.</p>
Misha Brukman80731b92003-11-22 00:38:41 +0000422
423</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000424
425<!-- _______________________________________________________________________ -->
Chris Lattner141ebb62004-02-14 04:12:41 +0000426<div class="doc_subsubsection">Bugs</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000427
Misha Brukman80731b92003-11-22 00:38:41 +0000428<div class="doc_text">
Chris Lattner3d482502003-10-02 04:57:28 +0000429
Misha Brukman80731b92003-11-22 00:38:41 +0000430<ul>
Chris Lattner3d482502003-10-02 04:57:28 +0000431<li>The C++ front-end inherits all problems afflicting the <a href="#c-fe">C
John Criswell86a3a482003-12-18 16:43:17 +0000432 front-end</a>.</li>
Chris Lattner041e6c92004-07-17 02:04:41 +0000433
Chris Lattner5cd40922004-08-02 20:28:44 +0000434<li><b>IA-64 specific</b>: The C++ front-end does not use <a
435href="http://llvm.cs.uiuc.edu/PR406">IA64 ABI compliant layout of v-tables</a>.
Chris Lattner041e6c92004-07-17 02:04:41 +0000436In particular, it just stores function pointers instead of function
437descriptors in the vtable. This bug prevents mixing C++ code compiled with
Chris Lattner2fd93492004-08-02 20:29:51 +0000438LLVM with C++ objects compiled by other C++ compilers.</li>
Chris Lattner041e6c92004-07-17 02:04:41 +0000439
Chris Lattner5cd40922004-08-02 20:28:44 +0000440</ul>
441
Misha Brukman80731b92003-11-22 00:38:41 +0000442</div>
443
444<!-- _______________________________________________________________________ -->
445<div class="doc_subsubsection">
446 Notes
447</div>
448
449<div class="doc_text">
450
451<ul>
Chris Lattnerd2a74272003-10-27 18:30:37 +0000452
Chris Lattner3d482502003-10-02 04:57:28 +0000453<li>The C++ front-end is based on a pre-release of the GCC 3.4 C++ parser. This
454parser is significantly more standards compliant (and picky) than prior GCC
455versions. For more information, see the C++ section of the <a
Chris Lattnere76e9ab2003-12-12 04:25:33 +0000456href="http://gcc.gnu.org/gcc-3.4/changes.html">GCC 3.4 release notes</a>.</li>
Chris Lattner3d482502003-10-02 04:57:28 +0000457
458<li>Destructors for local objects are not always run when a <tt>longjmp</tt> is
Chris Lattner62495762003-10-02 16:38:05 +0000459 performed. In particular, destructors for objects in the <tt>longjmp</tt>ing
Chris Lattner3d482502003-10-02 04:57:28 +0000460 function and in the <tt>setjmp</tt> receiver function may not be run.
John Criswell86a3a482003-12-18 16:43:17 +0000461 Objects in intervening stack frames will be destroyed, however (which is
Misha Brukman80731b92003-11-22 00:38:41 +0000462 better than most compilers).</li>
Chris Lattner3d482502003-10-02 04:57:28 +0000463
Chris Lattner62495762003-10-02 16:38:05 +0000464<li>The LLVM C++ front-end follows the <a
465 href="http://www.codesourcery.com/cxx-abi">Itanium C++ ABI</a>.
466 This document, which is not Itanium specific, specifies a standard for name
467 mangling, class layout, v-table layout, RTTI formats, and other C++
468 representation issues. Because we use this API, code generated by the LLVM
469 compilers should be binary compatible with machine code generated by other
470 Itanium ABI C++ compilers (such as G++, the Intel and HP compilers, etc).
471 <i>However</i>, the exception handling mechanism used by LLVM is very
472 different from the model used in the Itanium ABI, so <b>exceptions will not
Misha Brukman80731b92003-11-22 00:38:41 +0000473 interact correctly</b>. </li>
Chris Lattner3d482502003-10-02 04:57:28 +0000474
Misha Brukman80731b92003-11-22 00:38:41 +0000475</ul>
Chris Lattner46ecf612003-10-07 22:14:37 +0000476
Misha Brukman80731b92003-11-22 00:38:41 +0000477</div>
478
479<!-- ======================================================================= -->
480<div class="doc_subsection">
481 <a name="x86-be">Known problems with the X86 back-end</a>
482</div>
483
484<div class="doc_text">
485
486<ul>
Chris Lattner5cd40922004-08-02 20:28:44 +0000487 <li>none yet</li>
Misha Brukman80731b92003-11-22 00:38:41 +0000488</ul>
Chris Lattner3d482502003-10-02 04:57:28 +0000489
Misha Brukman80731b92003-11-22 00:38:41 +0000490</div>
491
492<!-- ======================================================================= -->
493<div class="doc_subsection">
Misha Brukmana516e992004-07-12 16:55:41 +0000494 <a name="sparcv9-be">Known problems with the SparcV9 back-end</a>
Misha Brukman80731b92003-11-22 00:38:41 +0000495</div>
496
497<div class="doc_text">
498
499<ul>
Misha Brukmana516e992004-07-12 16:55:41 +0000500<li><a href="http://llvm.cs.uiuc.edu/PR60">[sparcv9] SparcV9 backend miscompiles
501several programs in the LLVM test suite</a></li>
Misha Brukman80731b92003-11-22 00:38:41 +0000502</ul>
Chris Lattner3d482502003-10-02 04:57:28 +0000503
Misha Brukman80731b92003-11-22 00:38:41 +0000504</div>
505
506<!-- ======================================================================= -->
507<div class="doc_subsection">
Chris Lattnerdf925ce2004-11-07 01:55:32 +0000508 <a name="ppc-be">Known problems with the PowerPC back-end</a>
509</div>
510
511<div class="doc_text">
512
513<ul>
514<li>none yet</li>
515</ul>
516
517</div>
518
519<!-- ======================================================================= -->
520<div class="doc_subsection">
Misha Brukman80731b92003-11-22 00:38:41 +0000521 <a name="c-be">Known problems with the C back-end</a>
522</div>
523
524<div class="doc_text">
525
526<ul>
Chris Lattner3d482502003-10-02 04:57:28 +0000527
528<li>The C back-end produces code that violates the ANSI C Type-Based Alias
529Analysis rules. As such, special options may be necessary to compile the code
530(for example, GCC requires the <tt>-fno-strict-aliasing</tt> option). This
Misha Brukman80731b92003-11-22 00:38:41 +0000531problem probably cannot be fixed.</li>
Chris Lattner3d482502003-10-02 04:57:28 +0000532
Chris Lattnerc679fbb2003-11-04 20:06:53 +0000533<li><a href="http://llvm.cs.uiuc.edu/PR56">Zero arg vararg functions are not
Chris Lattnerb28c3282003-10-24 04:03:19 +0000534supported</a>. This should not affect LLVM produced by the C or C++
Misha Brukman80731b92003-11-22 00:38:41 +0000535frontends.</li>
Chris Lattnerb28c3282003-10-24 04:03:19 +0000536
Misha Brukman80731b92003-11-22 00:38:41 +0000537</ul>
Chris Lattner3d482502003-10-02 04:57:28 +0000538
Misha Brukman80731b92003-11-22 00:38:41 +0000539</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000540
541<!-- *********************************************************************** -->
Misha Brukman80731b92003-11-22 00:38:41 +0000542<div class="doc_section">
543 <a name="additionalinfo">Additional Information</a>
544</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000545<!-- *********************************************************************** -->
546
Misha Brukman80731b92003-11-22 00:38:41 +0000547<div class="doc_text">
548
549<p>A wide variety of additional information is available on the LLVM web page,
John Criswell86a3a482003-12-18 16:43:17 +0000550including mailing lists and publications describing algorithms and components
Chris Lattner3d482502003-10-02 04:57:28 +0000551implemented in LLVM. The web page also contains versions of the API
552documentation which is up-to-date with the CVS version of the source code. You
553can access versions of these documents specific to this release by going into
Misha Brukman80731b92003-11-22 00:38:41 +0000554the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000555
Misha Brukman80731b92003-11-22 00:38:41 +0000556<p>If you have any questions or comments about LLVM, please feel free to contact
Chris Lattnerb84f3322003-12-12 21:22:16 +0000557us via the <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">mailing
558lists</a>.</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000559
Misha Brukman80731b92003-11-22 00:38:41 +0000560</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000561
562<!-- *********************************************************************** -->
Chris Lattner3d482502003-10-02 04:57:28 +0000563
Misha Brukman80731b92003-11-22 00:38:41 +0000564<hr>
Misha Brukman68aab3b2003-11-22 01:23:39 +0000565<address>
Misha Brukman8834af92003-12-21 22:53:21 +0000566 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman68aab3b2003-11-22 01:23:39 +0000567 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
568 <a href="http://validator.w3.org/check/referer"><img
569 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
570
Misha Brukman7cb4e382003-11-22 01:00:11 +0000571 <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br>
Misha Brukman80731b92003-11-22 00:38:41 +0000572 Last modified: $Date$
Misha Brukman68aab3b2003-11-22 01:23:39 +0000573</address>
Chris Lattner3d482502003-10-02 04:57:28 +0000574
Misha Brukman80731b92003-11-22 00:38:41 +0000575</body>
576</html>