blob: d9f32c3ac0d758efcc3fe22819f7aa37c5169ffb [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>
Misha Brukman80731b92003-11-22 00:38:41 +000019 <li><a href="#additionalinfo">Additional Information</a></li>
Chris Lattner3d482502003-10-02 04:57:28 +000020</ol>
21
Chris Lattner020e1fc2004-05-23 21:07:27 +000022<div class="doc_author">
Chris Lattnerf3a7c242004-12-09 22:22:58 +000023 <p>Written by the <a href="http://llvm.cs.uiuc.edu">LLVM Team</a><p>
Misha Brukman80731b92003-11-22 00:38:41 +000024</div>
Chris Lattner3d482502003-10-02 04:57:28 +000025
26<!-- *********************************************************************** -->
Misha Brukman80731b92003-11-22 00:38:41 +000027<div class="doc_section">
28 <a name="intro">Introduction</a>
29</div>
Chris Lattner3d482502003-10-02 04:57:28 +000030<!-- *********************************************************************** -->
31
Misha Brukman80731b92003-11-22 00:38:41 +000032<div class="doc_text">
33
34<p>This document contains the release notes for the LLVM compiler
Chris Lattnerf3a7c242004-12-09 22:22:58 +000035infrastructure, release 1.5. Here we describe the status of LLVM, including any
Chris Lattnerb5bb5972004-12-07 08:04:13 +000036known problems and improvements from the previous release. The most up-to-date
Misha Brukman80731b92003-11-22 00:38:41 +000037version of this document can be found on the <a
Chris Lattnerf3a7c242004-12-09 22:22:58 +000038href="http://llvm.cs.uiuc.edu/releases/1.5/">LLVM 1.5 web site</a>. If you are
John Criswell86a3a482003-12-18 16:43:17 +000039not reading this on the LLVM web pages, you should probably go there because
Misha Brukman80731b92003-11-22 00:38:41 +000040this document may be updated after the release.</p>
Chris Lattner62495762003-10-02 16:38:05 +000041
Chris Lattnerb5bb5972004-12-07 08:04:13 +000042<p>For more information about LLVM, including information about the latest
43release, please check out the <a href="http://llvm.cs.uiuc.edu">main LLVM
Chris Lattnere7525b52003-10-07 21:38:31 +000044web site</a>. If you have questions or comments, the <a
45href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM developer's mailing
Misha Brukman80731b92003-11-22 00:38:41 +000046list</a> is a good place to send them.</p>
Chris Lattner3d482502003-10-02 04:57:28 +000047
Chris Lattnerf3a7c242004-12-09 22:22:58 +000048<p>Note that if you are reading this file from CVS or the main LLVM web page,
49this document applies to the <i>next</i> release, not the current one. To see
50the release notes for the current or previous releases, see the <a
Misha Brukman80731b92003-11-22 00:38:41 +000051href="http://llvm.cs.uiuc.edu/releases/">releases page</a>.</p>
52
53</div>
Chris Lattner3d482502003-10-02 04:57:28 +000054
55<!-- *********************************************************************** -->
Misha Brukman80731b92003-11-22 00:38:41 +000056<div class="doc_section">
57 <a name="whatsnew">What's New?</a>
58</div>
Chris Lattner3d482502003-10-02 04:57:28 +000059<!-- *********************************************************************** -->
60
Misha Brukman80731b92003-11-22 00:38:41 +000061<div class="doc_text">
62
Chris Lattnerf3a7c242004-12-09 22:22:58 +000063<p>This is the sixth public release of the LLVM compiler infrastructure.</p>
Chris Lattnerba7bd472003-12-06 20:22:41 +000064
Chris Lattner7c0241c2004-12-10 16:27:34 +000065<p> At this time, LLVM is known to correctly compile a broad range of C and
Chris Lattnerf3a7c242004-12-09 22:22:58 +000066C++ programs, including the SPEC CPU95 &amp; 2000 suite. TODO. It also includes
67bug fixes for those problems found since the 1.4 release.</p>
Chris Lattnerba7bd472003-12-06 20:22:41 +000068
Chris Lattner21a90402004-05-24 04:50:25 +000069</div>
70
Chris Lattnerba7bd472003-12-06 20:22:41 +000071<!--=========================================================================-->
72<div class="doc_subsubsection">
Chris Lattner8ebf2532004-02-25 16:36:51 +000073<a name="newfeatures">This release implements the following new features:</a>
Chris Lattnerba7bd472003-12-06 20:22:41 +000074</div>
Chris Lattnere7525b52003-10-07 21:38:31 +000075
Chris Lattner21a90402004-05-24 04:50:25 +000076<div class="doc_text">
Chris Lattnere7525b52003-10-07 21:38:31 +000077<ol>
Chris Lattner7bf2e542004-12-11 06:10:52 +000078 <li>LLVM now includes an <a href="http://llvm.cs.uiuc.edu/PR415">
79 Inter-Procedural Sparse Conditional Constant Propagation</a> pass, named
80 -ipsccp, which is run by default at link-time.</li>
Chris Lattner592db402003-11-19 22:05:38 +000081</ol>
Chris Lattner4491de62003-11-08 04:28:55 +000082
Chris Lattner21a90402004-05-24 04:50:25 +000083</div>
84
Chris Lattnerba7bd472003-12-06 20:22:41 +000085
86<!--=========================================================================-->
87<div class="doc_subsubsection">
88In this release, the following missing features were implemented:
89</div>
Chris Lattner4491de62003-11-08 04:28:55 +000090
Chris Lattner21a90402004-05-24 04:50:25 +000091<div class="doc_text">
92
Chris Lattner4491de62003-11-08 04:28:55 +000093<ol>
Chris Lattnerf3a7c242004-12-09 22:22:58 +000094 <li></li>
Misha Brukman80731b92003-11-22 00:38:41 +000095</ol>
Chris Lattnere7525b52003-10-07 21:38:31 +000096
Chris Lattner21a90402004-05-24 04:50:25 +000097</div>
Chris Lattnerba7bd472003-12-06 20:22:41 +000098
99<!--=========================================================================-->
100<div class="doc_subsubsection">
Misha Brukman017f2f32004-04-19 02:56:49 +0000101<a name="qualityofimp">In this release, the following Quality of Implementation
102issues were fixed:</a>
Chris Lattner4df78f02003-12-20 03:42:11 +0000103</div>
104
Chris Lattner21a90402004-05-24 04:50:25 +0000105<div class="doc_text">
106
Chris Lattner4df78f02003-12-20 03:42:11 +0000107<ol>
Chris Lattnerf3a7c242004-12-09 22:22:58 +0000108 <li></li>
Brian Gaeke8b05e4f2004-01-16 21:55:04 +0000109</ol>
Chris Lattner21a90402004-05-24 04:50:25 +0000110</div>
Brian Gaeke8b05e4f2004-01-16 21:55:04 +0000111
112<!--=========================================================================-->
113<div class="doc_subsubsection">
Chris Lattner2ad48782004-05-02 04:19:15 +0000114<a name="codequality">This release includes the following Code Quality
115improvements:</a>
Chris Lattner23257062004-05-23 20:42:08 +0000116</div>
Chris Lattner639579c2003-10-27 17:06:39 +0000117
Chris Lattner21a90402004-05-24 04:50:25 +0000118<div class="doc_text">
Chris Lattner639579c2003-10-27 17:06:39 +0000119<ol>
Chris Lattnerf3a7c242004-12-09 22:22:58 +0000120 <li></li>
Misha Brukman80731b92003-11-22 00:38:41 +0000121</ol>
Reid Spencer3e58f582004-05-23 17:23:13 +0000122</div>
Chris Lattnerba7bd472003-12-06 20:22:41 +0000123
124<!--=========================================================================-->
125<div class="doc_subsubsection">
Misha Brukman017f2f32004-04-19 02:56:49 +0000126<a name="bugfix">In this release, the following bugs in the previous release
127were fixed:</a>
Chris Lattnerba7bd472003-12-06 20:22:41 +0000128</div>
129
Chris Lattner21a90402004-05-24 04:50:25 +0000130<div class="doc_text">
131
Chris Lattner5cd40922004-08-02 20:28:44 +0000132<p>Bugs fixed in the LLVM Core:</p>
Chris Lattnere7525b52003-10-07 21:38:31 +0000133
134<ol>
Chris Lattnerc6141112004-12-29 04:03:23 +0000135 <li><a href="http://llvm.cs.uiuc.edu/PR490">[cbackend] Logical constant
136 expressions (and/or/xor) not implemented</a></li>
Chris Lattnerba7bd472003-12-06 20:22:41 +0000137</ol>
138
Chris Lattnerba7bd472003-12-06 20:22:41 +0000139<p>Bugs in the C/C++ front-end:</p>
140
141<ol>
Chris Lattnerf3a7c242004-12-09 22:22:58 +0000142 <li></li>
Brian Gaeke730d8d62004-08-24 07:43:48 +0000143</ol>
144
Chris Lattner21a90402004-05-24 04:50:25 +0000145</div>
Reid Spencer3e58f582004-05-23 17:23:13 +0000146
Chris Lattner62495762003-10-02 16:38:05 +0000147<!-- *********************************************************************** -->
Misha Brukman80731b92003-11-22 00:38:41 +0000148<div class="doc_section">
149 <a name="portability">Portability and Supported Platforms</a>
150</div>
Chris Lattner62495762003-10-02 16:38:05 +0000151<!-- *********************************************************************** -->
152
Misha Brukman80731b92003-11-22 00:38:41 +0000153<div class="doc_text">
154
John Criswell64307722004-12-08 20:35:47 +0000155<p>LLVM is known to work on the following platforms:</p>
Chris Lattner2c7b0872004-06-01 18:22:41 +0000156
157<ul>
158<li>Intel and AMD machines running Red Hat Linux and FreeBSD (and probably
159 other unix-like systems).</li>
160<li>Sun UltraSPARC workstations running Solaris 8.</li>
Chris Lattnerb5bb5972004-12-07 08:04:13 +0000161<li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
162 support is available for native builds with Visual C++).</li>
163<li>PowerPC-based Mac OS X systems, running 10.2 and above.</li>
Chris Lattner2c7b0872004-06-01 18:22:41 +0000164</ul>
165
Brian Gaekee3e557e2004-05-09 05:28:35 +0000166<p>The core LLVM infrastructure uses
167<a href="http://www.gnu.org/software/autoconf/">GNU autoconf</a> to adapt itself
168to the machine and operating system on which it is built. However, minor
169porting may be required to get LLVM to work on new platforms. We welcome your
170portability patches and reports of successful builds or error messages.</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000171
Misha Brukman80731b92003-11-22 00:38:41 +0000172</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000173
174<!-- *********************************************************************** -->
Misha Brukman80731b92003-11-22 00:38:41 +0000175<div class="doc_section">
176 <a name="knownproblems">Known Problems</a>
177</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000178<!-- *********************************************************************** -->
179
Misha Brukman80731b92003-11-22 00:38:41 +0000180<div class="doc_text">
181
182<p>This section contains all known problems with the LLVM system, listed by
Chris Lattner3d482502003-10-02 04:57:28 +0000183component. As new problems are discovered, they will be added to these
Chris Lattnerb84f3322003-12-12 21:22:16 +0000184sections. If you run into a problem, please check the <a
John Criswell86a3a482003-12-18 16:43:17 +0000185href="http://llvm.cs.uiuc.edu/bugs/">LLVM bug database</a> and submit a bug if
Chris Lattnerb84f3322003-12-12 21:22:16 +0000186there isn't already one.</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000187
Misha Brukman80731b92003-11-22 00:38:41 +0000188</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000189
Chris Lattnerb911de42004-03-14 02:03:02 +0000190<!-- ======================================================================= -->
191<div class="doc_subsection">
192 <a name="experimental">Experimental features included with this release</a>
193</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000194
Chris Lattnerb911de42004-03-14 02:03:02 +0000195<div class="doc_text">
196
Misha Brukmanfa50a222004-05-12 21:46:05 +0000197<p>The following components of this LLVM release are either untested, known to
198be broken or unreliable, or are in early development. These components should
199not be relied on, and bugs should not be filed against them, but they may be
200useful to some people. In particular, if you would like to work on one of these
201components, please contact us on the llvmdev list.</p>
Chris Lattnerb911de42004-03-14 02:03:02 +0000202
203<ul>
Chris Lattnerb5bb5972004-12-07 08:04:13 +0000204<li>The following passes are incomplete or buggy, and may be removed in future
205 releases: <tt>-pgmdep, -memdep, -ipmodref, -cee, -branch-combine,
206 -instloops, -paths, -pre</tt></li>
207<li>The <tt>llvm-db</tt> tool is in a very early stage of development, but can
208 be used to step through programs and inspect the stack.</li>
Chris Lattnerfa835102004-12-02 17:20:17 +0000209<li>The "iterative scan" register allocator (enabled with -regalloc=iterativescan)
210 is not stable.</li>
Chris Lattnerb911de42004-03-14 02:03:02 +0000211</ul>
212
213</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000214
Misha Brukman80731b92003-11-22 00:38:41 +0000215<!-- ======================================================================= -->
216<div class="doc_subsection">
217 <a name="core">Known problems with the LLVM Core</a>
218</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000219
Misha Brukman80731b92003-11-22 00:38:41 +0000220<div class="doc_text">
221
222<ul>
Reid Spencer493d9c22004-11-25 22:38:30 +0000223 <li>In the JIT, <tt>dlsym</tt> on a symbol compiled by the JIT will not work.
224 </li>
225 <li>The JIT does not use mutexes to protect its internal data structures. As
226 such, execution of a threaded program could cause these data structures to be
227 corrupted.
228 </li>
Reid Spencer493d9c22004-11-25 22:38:30 +0000229 <li><a href="http://llvm.cs.uiuc.edu/PR240">The lower-invoke pass does not
230 mark values live across a setjmp as volatile</a>. This missing feature
231 only affects targets whose setjmp/longjmp libraries do not save and restore
232 the entire register file.</li>
Misha Brukman80731b92003-11-22 00:38:41 +0000233</ul>
Misha Brukman80731b92003-11-22 00:38:41 +0000234</div>
235
236<!-- ======================================================================= -->
237<div class="doc_subsection">
238 <a name="c-fe">Known problems with the C front-end</a>
239</div>
Chris Lattner178f3db2003-10-02 05:07:23 +0000240
Chris Lattner3d482502003-10-02 04:57:28 +0000241<!-- _______________________________________________________________________ -->
Chris Lattner5a8a7282003-12-14 05:03:43 +0000242<div class="doc_subsubsection">Bugs</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000243
Misha Brukman80731b92003-11-22 00:38:41 +0000244<div class="doc_text">
Misha Brukman80731b92003-11-22 00:38:41 +0000245<ul>
Chris Lattner3d482502003-10-02 04:57:28 +0000246<li>C99 Variable sized arrays do not release stack memory when they go out of
247 scope. Thus, the following program may run out of stack space:
248<pre>
249 for (i = 0; i != 1000000; ++i) {
250 int X[n];
251 foo(X);
252 }
Misha Brukman80731b92003-11-22 00:38:41 +0000253</pre></li>
Chris Lattner3d482502003-10-02 04:57:28 +0000254
Misha Brukmanfa50a222004-05-12 21:46:05 +0000255<li>Initialization of global union variables can only be done <a
Misha Brukman68ef9a92004-12-04 00:45:09 +0000256href="http://llvm.cs.uiuc.edu/PR162">with the largest union member</a>.</li>
Chris Lattner1ab58dd2004-03-16 21:39:04 +0000257
John Criswell86a3a482003-12-18 16:43:17 +0000258</ul>
Misha Brukman80731b92003-11-22 00:38:41 +0000259</div>
260
261<!-- _______________________________________________________________________ -->
262<div class="doc_subsubsection">
263 Notes
264</div>
265
266<div class="doc_text">
267
268<ul>
269
270<li>Inline assembly is not yet supported.</li>
Chris Lattnerd2a74272003-10-27 18:30:37 +0000271
272<li>"long double" is transformed by the front-end into "double". There is no
Misha Brukman80731b92003-11-22 00:38:41 +0000273support for floating point data types of any size other than 32 and 64
274bits.</li>
275
276<li>The following Unix system functionality has not been tested and may not
277work:
Misha Brukman7cb4e382003-11-22 01:00:11 +0000278 <ol>
279 <li><tt>sigsetjmp</tt>, <tt>siglongjmp</tt> - These are not turned into the
280 appropriate <tt>invoke</tt>/<tt>unwind</tt> instructions. Note that
281 <tt>setjmp</tt> and <tt>longjmp</tt> <em>are</em> compiled correctly.
282 <li><tt>getcontext</tt>, <tt>setcontext</tt>, <tt>makecontext</tt>
283 - These functions have not been tested.
284 </ol></li>
Chris Lattner3d482502003-10-02 04:57:28 +0000285
286<li>Although many GCC extensions are supported, some are not. In particular,
287 the following extensions are known to <b>not be</b> supported:
288 <ol>
Misha Brukman80731b92003-11-22 00:38:41 +0000289 <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 +0000290 <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>
291 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Constructing-Calls.html#Constructing%20Calls">Constructing Calls</a>: Dispatching a call to another function.</li>
292 <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 +0000293 <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 +0000294 <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>
295 <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 +0000296 <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>
297 <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 +0000298 <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 +0000299 <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 +0000300 </ol>
Chris Lattner3d482502003-10-02 04:57:28 +0000301
Misha Brukman80731b92003-11-22 00:38:41 +0000302 <p>The following GCC extensions are <b>partially</b> supported. An ignored
Chris Lattner3d482502003-10-02 04:57:28 +0000303 attribute means that the LLVM compiler ignores the presence of the attribute,
304 but the code should still work. An unsupported attribute is one which is
John Criswell86a3a482003-12-18 16:43:17 +0000305 ignored by the LLVM compiler and will cause a different interpretation of
Misha Brukman80731b92003-11-22 00:38:41 +0000306 the program.</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000307
308 <ol>
309 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Length.html#Variable%20Length">Variable Length</a>:
310 Arrays whose length is computed at run time.<br>
Misha Brukman80731b92003-11-22 00:38:41 +0000311 Supported, but allocated stack space is not freed until the function returns (noted above).</li>
Chris Lattner3d482502003-10-02 04:57:28 +0000312
313 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Attributes.html#Function%20Attributes">Function Attributes</a>:
Misha Brukman80731b92003-11-22 00:38:41 +0000314
John Criswell86a3a482003-12-18 16:43:17 +0000315 Declaring that functions have no side effects or that they can never
Misha Brukman80731b92003-11-22 00:38:41 +0000316 return.<br>
317
318 <b>Supported:</b> <tt>format</tt>, <tt>format_arg</tt>, <tt>non_null</tt>,
John Criswell64307722004-12-08 20:35:47 +0000319 <tt>noreturn</tt>, <tt>constructor</tt>, <tt>destructor</tt>,
320 <tt>unused</tt>,
Misha Brukman80731b92003-11-22 00:38:41 +0000321 <tt>deprecated</tt>, <tt>warn_unused_result</tt>, <tt>weak</tt><br>
322
John Criswell64307722004-12-08 20:35:47 +0000323 <b>Ignored:</b> <tt>noinline</tt>,
Misha Brukman80731b92003-11-22 00:38:41 +0000324 <tt>always_inline</tt>, <tt>pure</tt>, <tt>const</tt>, <tt>nothrow</tt>,
325 <tt>malloc</tt>, <tt>no_instrument_function</tt>, <tt>cdecl</tt><br>
326
327 <b>Unsupported:</b> <tt>used</tt>, <tt>section</tt>, <tt>alias</tt>,
328 <tt>visibility</tt>, <tt>regparm</tt>, <tt>stdcall</tt>,
329 <tt>fastcall</tt>, all other target specific attributes</li>
Chris Lattner3d482502003-10-02 04:57:28 +0000330
331 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Attributes.html#Variable%20Attributes">Variable Attributes</a>:
332 Specifying attributes of variables.<br>
333 <b>Supported:</b> <tt>cleanup</tt>, <tt>common</tt>, <tt>nocommon</tt>,
334 <tt>deprecated</tt>, <tt>transparent_union</tt>,
335 <tt>unused</tt>, <tt>weak</tt><br>
Misha Brukman80731b92003-11-22 00:38:41 +0000336
Chris Lattner3d482502003-10-02 04:57:28 +0000337 <b>Unsupported:</b> <tt>aligned</tt>, <tt>mode</tt>, <tt>packed</tt>,
338 <tt>section</tt>, <tt>shared</tt>, <tt>tls_model</tt>,
339 <tt>vector_size</tt>, <tt>dllimport</tt>,
Misha Brukman80731b92003-11-22 00:38:41 +0000340 <tt>dllexport</tt>, all target specific attributes.</li>
Chris Lattner3d482502003-10-02 04:57:28 +0000341
Misha Brukman8395d732003-12-12 04:37:31 +0000342 <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 +0000343 <b>Supported:</b> <tt>transparent_union</tt>, <tt>unused</tt>,
Misha Brukman8395d732003-12-12 04:37:31 +0000344 <tt>deprecated</tt>, <tt>may_alias</tt><br>
Misha Brukman80731b92003-11-22 00:38:41 +0000345
346 <b>Unsupported:</b> <tt>aligned</tt>, <tt>packed</tt>,
347 all target specific attributes.</li>
348
Chris Lattner3d482502003-10-02 04:57:28 +0000349 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Other-Builtins.html#Other%20Builtins">Other Builtins</a>:
350 Other built-in functions.<br>
351 We support all builtins which have a C language equivalent (e.g.,
352 <tt>__builtin_cos</tt>), <tt>__builtin_alloca</tt>,
353 <tt>__builtin_types_compatible_p</tt>, <tt>__builtin_choose_expr</tt>,
Chris Lattnerb7c4bac2004-06-18 06:26:29 +0000354 <tt>__builtin_constant_p</tt>, and <tt>__builtin_expect</tt>
355 (currently ignored). We also support builtins for ISO C99 floating
356 point comparison macros (e.g., <tt>__builtin_islessequal</tt>).</li>
Misha Brukman80731b92003-11-22 00:38:41 +0000357 </ol>
Chris Lattner3d482502003-10-02 04:57:28 +0000358
Misha Brukman80731b92003-11-22 00:38:41 +0000359 <p>The following extensions <b>are</b> known to be supported:</p>
360
Chris Lattner3d482502003-10-02 04:57:28 +0000361 <ol>
Chris Lattnerd3dc8502004-03-16 08:54:07 +0000362 <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 +0000363 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Statement-Exprs.html#Statement%20Exprs">Statement Exprs</a>: Putting statements and declarations inside expressions.</li>
364 <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 +0000365 <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 +0000366 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Conditionals.html#Conditionals">Conditionals</a>: Omitting the middle operand of a <code>?:</code> expression.</li>
367 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Long-Long.html#Long%20Long">Long Long</a>: Double-word integers.</li>
368 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Complex.html#Complex">Complex</a>: Data types for complex numbers.</li>
369 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Hex-Floats.html#Hex%20Floats">Hex Floats</a>:Hexadecimal floating-point constants.</li>
370 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Zero-Length.html#Zero%20Length">Zero Length</a>: Zero-length arrays.</li>
371 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Empty-Structures.html#Empty%20Structures">Empty Structures</a>: Structures with no members.</li>
372 <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>
373 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Escaped-Newlines.html#Escaped%20Newlines">Escaped Newlines</a>: Slightly looser rules for escaped newlines.</li>
374 <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 +0000375 <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 +0000376 <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 +0000377 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Compound-Literals.html#Compound%20Literals">Compound Literals</a>: Compound literals give structures, unions,
378or arrays as values.</li>
Misha Brukman80731b92003-11-22 00:38:41 +0000379 <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 +0000380 <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 +0000381 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Case-Ranges.html#Case%20Ranges">Case Ranges</a>: `case 1 ... 9' and such.</li>
382 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Mixed-Declarations.html#Mixed%20Declarations">Mixed Declarations</a>: Mixing declarations and code.</li>
383 <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 +0000384 <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 +0000385 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Dollar-Signs.html#Dollar%20Signs">Dollar Signs</a>: Dollar sign is allowed in identifiers.</li>
386 <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>
387 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Alignment.html#Alignment">Alignment</a>: Inquiring about the alignment of a type or variable.</li>
388 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Inline.html#Inline">Inline</a>: Defining inline functions (as fast as macros).</li>
389 <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>
390 <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>
391 <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 +0000392 <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 +0000393 <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>
394 <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 +0000395 </ol></li>
396
397</ul>
Chris Lattner3d482502003-10-02 04:57:28 +0000398
Misha Brukman80731b92003-11-22 00:38:41 +0000399<p>If you run into GCC extensions which have not been included in any of these
400lists, please let us know (also including whether or not they work).</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000401
Misha Brukman80731b92003-11-22 00:38:41 +0000402</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000403
Misha Brukman80731b92003-11-22 00:38:41 +0000404<!-- ======================================================================= -->
405<div class="doc_subsection">
406 <a name="c++-fe">Known problems with the C++ front-end</a>
407</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000408
Misha Brukman80731b92003-11-22 00:38:41 +0000409<div class="doc_text">
410
Reid Spencer55684c32004-12-07 08:39:08 +0000411<p>For this release, the C++ front-end is considered to be fully
Chris Lattnerb5bb5972004-12-07 08:04:13 +0000412tested and works for a number of non-trivial programs, including LLVM
413itself.</p>
Misha Brukman80731b92003-11-22 00:38:41 +0000414
415</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000416
417<!-- _______________________________________________________________________ -->
Chris Lattner141ebb62004-02-14 04:12:41 +0000418<div class="doc_subsubsection">Bugs</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000419
Misha Brukman80731b92003-11-22 00:38:41 +0000420<div class="doc_text">
Chris Lattner3d482502003-10-02 04:57:28 +0000421
Misha Brukman80731b92003-11-22 00:38:41 +0000422<ul>
Chris Lattner3d482502003-10-02 04:57:28 +0000423<li>The C++ front-end inherits all problems afflicting the <a href="#c-fe">C
John Criswell86a3a482003-12-18 16:43:17 +0000424 front-end</a>.</li>
Chris Lattner041e6c92004-07-17 02:04:41 +0000425
Chris Lattner5cd40922004-08-02 20:28:44 +0000426<li><b>IA-64 specific</b>: The C++ front-end does not use <a
427href="http://llvm.cs.uiuc.edu/PR406">IA64 ABI compliant layout of v-tables</a>.
Chris Lattner041e6c92004-07-17 02:04:41 +0000428In particular, it just stores function pointers instead of function
429descriptors in the vtable. This bug prevents mixing C++ code compiled with
Chris Lattner2fd93492004-08-02 20:29:51 +0000430LLVM with C++ objects compiled by other C++ compilers.</li>
Chris Lattner041e6c92004-07-17 02:04:41 +0000431
Chris Lattner5cd40922004-08-02 20:28:44 +0000432</ul>
433
Misha Brukman80731b92003-11-22 00:38:41 +0000434</div>
435
436<!-- _______________________________________________________________________ -->
437<div class="doc_subsubsection">
438 Notes
439</div>
440
441<div class="doc_text">
442
443<ul>
Chris Lattnerd2a74272003-10-27 18:30:37 +0000444
Chris Lattner3d482502003-10-02 04:57:28 +0000445<li>The C++ front-end is based on a pre-release of the GCC 3.4 C++ parser. This
446parser is significantly more standards compliant (and picky) than prior GCC
447versions. For more information, see the C++ section of the <a
Chris Lattnere76e9ab2003-12-12 04:25:33 +0000448href="http://gcc.gnu.org/gcc-3.4/changes.html">GCC 3.4 release notes</a>.</li>
Chris Lattner3d482502003-10-02 04:57:28 +0000449
450<li>Destructors for local objects are not always run when a <tt>longjmp</tt> is
Chris Lattner62495762003-10-02 16:38:05 +0000451 performed. In particular, destructors for objects in the <tt>longjmp</tt>ing
Chris Lattner3d482502003-10-02 04:57:28 +0000452 function and in the <tt>setjmp</tt> receiver function may not be run.
John Criswell86a3a482003-12-18 16:43:17 +0000453 Objects in intervening stack frames will be destroyed, however (which is
Misha Brukman80731b92003-11-22 00:38:41 +0000454 better than most compilers).</li>
Chris Lattner3d482502003-10-02 04:57:28 +0000455
Chris Lattner62495762003-10-02 16:38:05 +0000456<li>The LLVM C++ front-end follows the <a
457 href="http://www.codesourcery.com/cxx-abi">Itanium C++ ABI</a>.
458 This document, which is not Itanium specific, specifies a standard for name
459 mangling, class layout, v-table layout, RTTI formats, and other C++
460 representation issues. Because we use this API, code generated by the LLVM
461 compilers should be binary compatible with machine code generated by other
462 Itanium ABI C++ compilers (such as G++, the Intel and HP compilers, etc).
463 <i>However</i>, the exception handling mechanism used by LLVM is very
464 different from the model used in the Itanium ABI, so <b>exceptions will not
Misha Brukman80731b92003-11-22 00:38:41 +0000465 interact correctly</b>. </li>
Chris Lattner3d482502003-10-02 04:57:28 +0000466
Misha Brukman80731b92003-11-22 00:38:41 +0000467</ul>
Chris Lattner46ecf612003-10-07 22:14:37 +0000468
Misha Brukman80731b92003-11-22 00:38:41 +0000469</div>
470
471<!-- ======================================================================= -->
472<div class="doc_subsection">
473 <a name="x86-be">Known problems with the X86 back-end</a>
474</div>
475
476<div class="doc_text">
477
478<ul>
Chris Lattner5cd40922004-08-02 20:28:44 +0000479 <li>none yet</li>
Misha Brukman80731b92003-11-22 00:38:41 +0000480</ul>
Chris Lattner3d482502003-10-02 04:57:28 +0000481
Misha Brukman80731b92003-11-22 00:38:41 +0000482</div>
483
484<!-- ======================================================================= -->
485<div class="doc_subsection">
Misha Brukmana516e992004-07-12 16:55:41 +0000486 <a name="sparcv9-be">Known problems with the SparcV9 back-end</a>
Misha Brukman80731b92003-11-22 00:38:41 +0000487</div>
488
489<div class="doc_text">
490
491<ul>
Misha Brukmana516e992004-07-12 16:55:41 +0000492<li><a href="http://llvm.cs.uiuc.edu/PR60">[sparcv9] SparcV9 backend miscompiles
493several programs in the LLVM test suite</a></li>
Misha Brukman80731b92003-11-22 00:38:41 +0000494</ul>
Chris Lattner3d482502003-10-02 04:57:28 +0000495
Misha Brukman80731b92003-11-22 00:38:41 +0000496</div>
497
498<!-- ======================================================================= -->
499<div class="doc_subsection">
Chris Lattnerdf925ce2004-11-07 01:55:32 +0000500 <a name="ppc-be">Known problems with the PowerPC back-end</a>
501</div>
502
503<div class="doc_text">
504
505<ul>
506<li>none yet</li>
507</ul>
508
509</div>
510
511<!-- ======================================================================= -->
512<div class="doc_subsection">
Misha Brukman80731b92003-11-22 00:38:41 +0000513 <a name="c-be">Known problems with the C back-end</a>
514</div>
515
516<div class="doc_text">
517
518<ul>
Chris Lattner3d482502003-10-02 04:57:28 +0000519
520<li>The C back-end produces code that violates the ANSI C Type-Based Alias
521Analysis rules. As such, special options may be necessary to compile the code
522(for example, GCC requires the <tt>-fno-strict-aliasing</tt> option). This
Misha Brukman80731b92003-11-22 00:38:41 +0000523problem probably cannot be fixed.</li>
Chris Lattner3d482502003-10-02 04:57:28 +0000524
Chris Lattnerc679fbb2003-11-04 20:06:53 +0000525<li><a href="http://llvm.cs.uiuc.edu/PR56">Zero arg vararg functions are not
Chris Lattnerb28c3282003-10-24 04:03:19 +0000526supported</a>. This should not affect LLVM produced by the C or C++
Misha Brukman80731b92003-11-22 00:38:41 +0000527frontends.</li>
Chris Lattnerb28c3282003-10-24 04:03:19 +0000528
Misha Brukman80731b92003-11-22 00:38:41 +0000529</ul>
Chris Lattner3d482502003-10-02 04:57:28 +0000530
Misha Brukman80731b92003-11-22 00:38:41 +0000531</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000532
533<!-- *********************************************************************** -->
Misha Brukman80731b92003-11-22 00:38:41 +0000534<div class="doc_section">
535 <a name="additionalinfo">Additional Information</a>
536</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000537<!-- *********************************************************************** -->
538
Misha Brukman80731b92003-11-22 00:38:41 +0000539<div class="doc_text">
540
541<p>A wide variety of additional information is available on the LLVM web page,
John Criswell86a3a482003-12-18 16:43:17 +0000542including mailing lists and publications describing algorithms and components
Chris Lattner3d482502003-10-02 04:57:28 +0000543implemented in LLVM. The web page also contains versions of the API
544documentation which is up-to-date with the CVS version of the source code. You
545can access versions of these documents specific to this release by going into
Misha Brukman80731b92003-11-22 00:38:41 +0000546the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000547
Misha Brukman80731b92003-11-22 00:38:41 +0000548<p>If you have any questions or comments about LLVM, please feel free to contact
Chris Lattnerb84f3322003-12-12 21:22:16 +0000549us via the <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">mailing
550lists</a>.</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000551
Misha Brukman80731b92003-11-22 00:38:41 +0000552</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000553
554<!-- *********************************************************************** -->
Chris Lattner3d482502003-10-02 04:57:28 +0000555
Misha Brukman80731b92003-11-22 00:38:41 +0000556<hr>
Misha Brukman68aab3b2003-11-22 01:23:39 +0000557<address>
Misha Brukman8834af92003-12-21 22:53:21 +0000558 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman68aab3b2003-11-22 01:23:39 +0000559 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
560 <a href="http://validator.w3.org/check/referer"><img
561 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
562
Misha Brukman7cb4e382003-11-22 01:00:11 +0000563 <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br>
Misha Brukman80731b92003-11-22 00:38:41 +0000564 Last modified: $Date$
Misha Brukman68aab3b2003-11-22 01:23:39 +0000565</address>
Chris Lattner3d482502003-10-02 04:57:28 +0000566
Misha Brukman80731b92003-11-22 00:38:41 +0000567</body>
568</html>