blob: fa357786dc3a5e67c5ff7021cba7974c23c2f9f1 [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>
Reid Spencer6454ed32004-11-18 18:38:58 +00005 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
Misha Brukman500bc302003-11-22 00:38:41 +00006 <link rel="stylesheet" href="llvm.css" type="text/css">
John Criswell98391ce2005-05-18 20:28:46 +00007 <title>LLVM 1.6 Release Notes</title>
Misha Brukman500bc302003-11-22 00:38:41 +00008</head>
9<body>
Chris Lattner79c3fe12003-10-02 04:57:28 +000010
John Criswell98391ce2005-05-18 20:28:46 +000011<div class="doc_title">LLVM 1.6 Release Notes</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +000012
13<ol>
Misha Brukman500bc302003-11-22 00:38:41 +000014 <li><a href="#intro">Introduction</a></li>
15 <li><a href="#whatsnew">What's New?</a></li>
Chris Lattner4b538b92004-04-30 22:17:12 +000016 <li><a href="GettingStarted.html">Installation Instructions</a></li>
Misha Brukman500bc302003-11-22 00:38:41 +000017 <li><a href="#portability">Portability and Supported Platforms</a></li>
Chris Lattner79c3fe12003-10-02 04:57:28 +000018 <li><a href="#knownproblems">Known Problems</a>
Misha Brukman500bc302003-11-22 00:38:41 +000019 <li><a href="#additionalinfo">Additional Information</a></li>
Chris Lattner79c3fe12003-10-02 04:57:28 +000020</ol>
21
Chris Lattner7911ce22004-05-23 21:07:27 +000022<div class="doc_author">
Chris Lattner78bf32b2004-12-09 22:22:58 +000023 <p>Written by the <a href="http://llvm.cs.uiuc.edu">LLVM Team</a><p>
Misha Brukman500bc302003-11-22 00:38:41 +000024</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +000025
26<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +000027<div class="doc_section">
28 <a name="intro">Introduction</a>
29</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +000030<!-- *********************************************************************** -->
31
Misha Brukman500bc302003-11-22 00:38:41 +000032<div class="doc_text">
33
34<p>This document contains the release notes for the LLVM compiler
John Criswell98391ce2005-05-18 20:28:46 +000035infrastructure, release 1.6. Here we describe the status of LLVM, including any
Chris Lattner8a458762005-05-15 05:44:51 +000036known problems and major improvements from the previous release. The most
37up-to-date version of this document can be found on the <a
John Criswell98391ce2005-05-18 20:28:46 +000038href="http://llvm.cs.uiuc.edu/releases/1.6/">LLVM 1.6 web site</a>. If you are
John Criswelld000e1d2003-12-18 16:43:17 +000039not reading this on the LLVM web pages, you should probably go there because
Misha Brukman500bc302003-11-22 00:38:41 +000040this document may be updated after the release.</p>
Chris Lattner19092612003-10-02 16:38:05 +000041
Chris Lattner7506b1d2004-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 Lattner47ad72c2003-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 Brukman500bc302003-11-22 00:38:41 +000046list</a> is a good place to send them.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +000047
Chris Lattner78bf32b2004-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 Brukman500bc302003-11-22 00:38:41 +000051href="http://llvm.cs.uiuc.edu/releases/">releases page</a>.</p>
52
53</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +000054
55<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +000056<div class="doc_section">
57 <a name="whatsnew">What's New?</a>
58</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +000059<!-- *********************************************************************** -->
60
Misha Brukman500bc302003-11-22 00:38:41 +000061<div class="doc_text">
62
John Criswell98391ce2005-05-18 20:28:46 +000063<p>This is the seventh public release of the LLVM Compiler Infrastructure.</p>
Chris Lattnera5099962003-12-06 20:22:41 +000064
John Criswell98391ce2005-05-18 20:28:46 +000065<p>LLVM 1.6 is known to correctly compile a wide range of C and C++ programs,
66includes bug fixes for those problems found since the 1.5 release, and includes
Chris Lattnerbf307012005-05-16 16:56:09 +000067a large number of new features and enhancements, described below.</p>
Chris Lattnera5099962003-12-06 20:22:41 +000068
Chris Lattner80453c92004-05-24 04:50:25 +000069</div>
70
Chris Lattnera5099962003-12-06 20:22:41 +000071<!--=========================================================================-->
Chris Lattner8a458762005-05-15 05:44:51 +000072<div class="doc_subsection">
John Criswell98391ce2005-05-18 20:28:46 +000073<a name="newfeatures">New Features in LLVM 1.6</a>
Chris Lattner80453c92004-05-24 04:50:25 +000074</div>
Brian Gaeke6b31beb2004-01-16 21:55:04 +000075
Chris Lattnerebc8c7d2005-05-18 22:23:56 +000076<div class="doc_text">
77<h1>
78 See <a href="/releases/1.5/docs/ReleaseNotes.html">LLVM 1.5 Release Notes</a>
79</h1>
80</div>
81
Brian Gaeke6b31beb2004-01-16 21:55:04 +000082<!--=========================================================================-->
Chris Lattner8a458762005-05-15 05:44:51 +000083<div class="doc_subsection">
John Criswell98391ce2005-05-18 20:28:46 +000084<a name="codequality">Code Quality Improvements in LLVM 1.6</a>
Chris Lattneraab56d42004-05-23 20:42:08 +000085</div>
Chris Lattner89ca2b82003-10-27 17:06:39 +000086
Chris Lattnerbf307012005-05-16 16:56:09 +000087<!--=========================================================================-->
88<div class="doc_subsection">
John Criswell98391ce2005-05-18 20:28:46 +000089<a name="codequality">Code Generator Improvements in LLVM 1.6</a>
Chris Lattnerbf307012005-05-16 16:56:09 +000090</div>
91
Chris Lattnera5099962003-12-06 20:22:41 +000092<!--=========================================================================-->
Chris Lattner8a458762005-05-15 05:44:51 +000093<div class="doc_subsection">
John Criswell98391ce2005-05-18 20:28:46 +000094<a name="bugfix">Significant Bugs Fixed in LLVM 1.6</a>
Chris Lattner80453c92004-05-24 04:50:25 +000095</div>
Reid Spencer8e0262f2004-05-23 17:23:13 +000096
John Criswelle531ec52005-06-29 16:22:34 +000097<div class="doc_text">
98<ol>
99 <li><a href="http://llvm.cs.uiuc.edu/PR591">[simplify-libcalls] The simplify-libcalls pass generates ill-formed LLVM code</a>.</li>
100</ol>
101</div>
102
Chris Lattner19092612003-10-02 16:38:05 +0000103<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000104<div class="doc_section">
105 <a name="portability">Portability and Supported Platforms</a>
106</div>
Chris Lattner19092612003-10-02 16:38:05 +0000107<!-- *********************************************************************** -->
108
Misha Brukman500bc302003-11-22 00:38:41 +0000109<div class="doc_text">
110
John Criswell0b5b5e92004-12-08 20:35:47 +0000111<p>LLVM is known to work on the following platforms:</p>
Chris Lattner4654bdb2004-06-01 18:22:41 +0000112
113<ul>
Reid Spencer00812e22005-05-17 02:47:27 +0000114 <li>Intel and AMD machines running Red Hat Linux, Fedora Core and FreeBSD
115 (and probably other unix-like systems).</li>
Chris Lattner4654bdb2004-06-01 18:22:41 +0000116<li>Sun UltraSPARC workstations running Solaris 8.</li>
Chris Lattner7506b1d2004-12-07 08:04:13 +0000117<li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
118 support is available for native builds with Visual C++).</li>
119<li>PowerPC-based Mac OS X systems, running 10.2 and above.</li>
John Criswell9321fa82005-05-13 20:28:15 +0000120<li>Alpha-based machines running Debian GNU/Linux.</li>
121<li>Itanium-based machines running Linux and HP-UX.</li>
Chris Lattner4654bdb2004-06-01 18:22:41 +0000122</ul>
123
Brian Gaekeb0fd7612004-05-09 05:28:35 +0000124<p>The core LLVM infrastructure uses
125<a href="http://www.gnu.org/software/autoconf/">GNU autoconf</a> to adapt itself
126to the machine and operating system on which it is built. However, minor
127porting may be required to get LLVM to work on new platforms. We welcome your
128portability patches and reports of successful builds or error messages.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000129
Misha Brukman500bc302003-11-22 00:38:41 +0000130</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000131
132<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000133<div class="doc_section">
134 <a name="knownproblems">Known Problems</a>
135</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000136<!-- *********************************************************************** -->
137
Misha Brukman500bc302003-11-22 00:38:41 +0000138<div class="doc_text">
139
140<p>This section contains all known problems with the LLVM system, listed by
Chris Lattner79c3fe12003-10-02 04:57:28 +0000141component. As new problems are discovered, they will be added to these
Chris Lattner5eccca42003-12-12 21:22:16 +0000142sections. If you run into a problem, please check the <a
John Criswelld000e1d2003-12-18 16:43:17 +0000143href="http://llvm.cs.uiuc.edu/bugs/">LLVM bug database</a> and submit a bug if
Chris Lattner5eccca42003-12-12 21:22:16 +0000144there isn't already one.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000145
Misha Brukman500bc302003-11-22 00:38:41 +0000146</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000147
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000148<!-- ======================================================================= -->
149<div class="doc_subsection">
150 <a name="experimental">Experimental features included with this release</a>
151</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000152
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000153<div class="doc_text">
154
Misha Brukman6df9e2c2004-05-12 21:46:05 +0000155<p>The following components of this LLVM release are either untested, known to
156be broken or unreliable, or are in early development. These components should
157not be relied on, and bugs should not be filed against them, but they may be
158useful to some people. In particular, if you would like to work on one of these
159components, please contact us on the llvmdev list.</p>
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000160
161<ul>
Chris Lattner7506b1d2004-12-07 08:04:13 +0000162<li>The following passes are incomplete or buggy, and may be removed in future
Chris Lattner1fe848e2005-01-28 06:13:52 +0000163 releases: <tt>-cee, -branch-combine, -instloops, -paths, -pre</tt></li>
Chris Lattner7506b1d2004-12-07 08:04:13 +0000164<li>The <tt>llvm-db</tt> tool is in a very early stage of development, but can
165 be used to step through programs and inspect the stack.</li>
Misha Brukman109d9e82005-03-30 19:14:24 +0000166<li>The "iterative scan" register allocator (enabled with
167 <tt>-regalloc=iterativescan</tt>) is not stable.</li>
John Criswell9321fa82005-05-13 20:28:15 +0000168<li>The SparcV8, Alpha, and IA64 code generators are experimental.</li>
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000169</ul>
170
171</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000172
Misha Brukman500bc302003-11-22 00:38:41 +0000173<!-- ======================================================================= -->
174<div class="doc_subsection">
175 <a name="core">Known problems with the LLVM Core</a>
176</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000177
Misha Brukman500bc302003-11-22 00:38:41 +0000178<div class="doc_text">
179
180<ul>
Misha Brukman109d9e82005-03-30 19:14:24 +0000181 <li>In the JIT, <tt>dlsym()</tt> on a symbol compiled by the JIT will not
182 work.</li>
Reid Spencer4f86f9c2004-11-25 22:38:30 +0000183 <li>The JIT does not use mutexes to protect its internal data structures. As
184 such, execution of a threaded program could cause these data structures to be
185 corrupted.
186 </li>
Reid Spencer4f86f9c2004-11-25 22:38:30 +0000187 <li><a href="http://llvm.cs.uiuc.edu/PR240">The lower-invoke pass does not
188 mark values live across a setjmp as volatile</a>. This missing feature
189 only affects targets whose setjmp/longjmp libraries do not save and restore
190 the entire register file.</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000191</ul>
Misha Brukman500bc302003-11-22 00:38:41 +0000192</div>
193
194<!-- ======================================================================= -->
195<div class="doc_subsection">
196 <a name="c-fe">Known problems with the C front-end</a>
197</div>
Chris Lattner47588f92003-10-02 05:07:23 +0000198
Chris Lattner79c3fe12003-10-02 04:57:28 +0000199<!-- _______________________________________________________________________ -->
Chris Lattnerb40efb32003-12-14 05:03:43 +0000200<div class="doc_subsubsection">Bugs</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000201
Misha Brukman500bc302003-11-22 00:38:41 +0000202<div class="doc_text">
Misha Brukman500bc302003-11-22 00:38:41 +0000203<ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000204<li>C99 Variable sized arrays do not release stack memory when they go out of
205 scope. Thus, the following program may run out of stack space:
206<pre>
207 for (i = 0; i != 1000000; ++i) {
208 int X[n];
209 foo(X);
210 }
Misha Brukman500bc302003-11-22 00:38:41 +0000211</pre></li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000212
Misha Brukman6df9e2c2004-05-12 21:46:05 +0000213<li>Initialization of global union variables can only be done <a
Misha Brukman43ee2932004-12-04 00:45:09 +0000214href="http://llvm.cs.uiuc.edu/PR162">with the largest union member</a>.</li>
Chris Lattnerf580cdc2004-03-16 21:39:04 +0000215
John Criswelld000e1d2003-12-18 16:43:17 +0000216</ul>
Misha Brukman500bc302003-11-22 00:38:41 +0000217</div>
218
219<!-- _______________________________________________________________________ -->
220<div class="doc_subsubsection">
221 Notes
222</div>
223
224<div class="doc_text">
225
226<ul>
227
228<li>Inline assembly is not yet supported.</li>
Chris Lattnere01fcfb2003-10-27 18:30:37 +0000229
230<li>"long double" is transformed by the front-end into "double". There is no
Misha Brukman500bc302003-11-22 00:38:41 +0000231support for floating point data types of any size other than 32 and 64
232bits.</li>
233
234<li>The following Unix system functionality has not been tested and may not
235work:
Misha Brukmane0c891c2003-11-22 01:00:11 +0000236 <ol>
237 <li><tt>sigsetjmp</tt>, <tt>siglongjmp</tt> - These are not turned into the
238 appropriate <tt>invoke</tt>/<tt>unwind</tt> instructions. Note that
239 <tt>setjmp</tt> and <tt>longjmp</tt> <em>are</em> compiled correctly.
240 <li><tt>getcontext</tt>, <tt>setcontext</tt>, <tt>makecontext</tt>
241 - These functions have not been tested.
242 </ol></li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000243
244<li>Although many GCC extensions are supported, some are not. In particular,
245 the following extensions are known to <b>not be</b> supported:
246 <ol>
Misha Brukman500bc302003-11-22 00:38:41 +0000247 <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 +0000248 <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>
249 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Constructing-Calls.html#Constructing%20Calls">Constructing Calls</a>: Dispatching a call to another function.</li>
250 <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 +0000251 <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 +0000252 <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>
253 <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 +0000254 <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>
255 <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 Lattner014e5f52004-12-08 18:25:34 +0000256 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Thread_002dLocal.html">Thread-Local</a>: Per-thread variables.</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000257 <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 +0000258 </ol>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000259
Misha Brukman500bc302003-11-22 00:38:41 +0000260 <p>The following GCC extensions are <b>partially</b> supported. An ignored
Chris Lattner79c3fe12003-10-02 04:57:28 +0000261 attribute means that the LLVM compiler ignores the presence of the attribute,
262 but the code should still work. An unsupported attribute is one which is
John Criswelld000e1d2003-12-18 16:43:17 +0000263 ignored by the LLVM compiler and will cause a different interpretation of
Misha Brukman500bc302003-11-22 00:38:41 +0000264 the program.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000265
266 <ol>
267 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Length.html#Variable%20Length">Variable Length</a>:
268 Arrays whose length is computed at run time.<br>
Misha Brukman500bc302003-11-22 00:38:41 +0000269 Supported, but allocated stack space is not freed until the function returns (noted above).</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000270
271 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Attributes.html#Function%20Attributes">Function Attributes</a>:
Misha Brukman500bc302003-11-22 00:38:41 +0000272
John Criswelld000e1d2003-12-18 16:43:17 +0000273 Declaring that functions have no side effects or that they can never
Misha Brukman500bc302003-11-22 00:38:41 +0000274 return.<br>
275
276 <b>Supported:</b> <tt>format</tt>, <tt>format_arg</tt>, <tt>non_null</tt>,
John Criswell0b5b5e92004-12-08 20:35:47 +0000277 <tt>noreturn</tt>, <tt>constructor</tt>, <tt>destructor</tt>,
278 <tt>unused</tt>,
Misha Brukman500bc302003-11-22 00:38:41 +0000279 <tt>deprecated</tt>, <tt>warn_unused_result</tt>, <tt>weak</tt><br>
280
John Criswell0b5b5e92004-12-08 20:35:47 +0000281 <b>Ignored:</b> <tt>noinline</tt>,
Misha Brukman500bc302003-11-22 00:38:41 +0000282 <tt>always_inline</tt>, <tt>pure</tt>, <tt>const</tt>, <tt>nothrow</tt>,
283 <tt>malloc</tt>, <tt>no_instrument_function</tt>, <tt>cdecl</tt><br>
284
285 <b>Unsupported:</b> <tt>used</tt>, <tt>section</tt>, <tt>alias</tt>,
286 <tt>visibility</tt>, <tt>regparm</tt>, <tt>stdcall</tt>,
287 <tt>fastcall</tt>, all other target specific attributes</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000288
289 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Attributes.html#Variable%20Attributes">Variable Attributes</a>:
290 Specifying attributes of variables.<br>
291 <b>Supported:</b> <tt>cleanup</tt>, <tt>common</tt>, <tt>nocommon</tt>,
292 <tt>deprecated</tt>, <tt>transparent_union</tt>,
293 <tt>unused</tt>, <tt>weak</tt><br>
Misha Brukman500bc302003-11-22 00:38:41 +0000294
Chris Lattner79c3fe12003-10-02 04:57:28 +0000295 <b>Unsupported:</b> <tt>aligned</tt>, <tt>mode</tt>, <tt>packed</tt>,
296 <tt>section</tt>, <tt>shared</tt>, <tt>tls_model</tt>,
297 <tt>vector_size</tt>, <tt>dllimport</tt>,
Misha Brukman500bc302003-11-22 00:38:41 +0000298 <tt>dllexport</tt>, all target specific attributes.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000299
Misha Brukmanc4b7bee2003-12-12 04:37:31 +0000300 <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 +0000301 <b>Supported:</b> <tt>transparent_union</tt>, <tt>unused</tt>,
Misha Brukmanc4b7bee2003-12-12 04:37:31 +0000302 <tt>deprecated</tt>, <tt>may_alias</tt><br>
Misha Brukman500bc302003-11-22 00:38:41 +0000303
304 <b>Unsupported:</b> <tt>aligned</tt>, <tt>packed</tt>,
305 all target specific attributes.</li>
306
Chris Lattner79c3fe12003-10-02 04:57:28 +0000307 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Other-Builtins.html#Other%20Builtins">Other Builtins</a>:
308 Other built-in functions.<br>
309 We support all builtins which have a C language equivalent (e.g.,
310 <tt>__builtin_cos</tt>), <tt>__builtin_alloca</tt>,
311 <tt>__builtin_types_compatible_p</tt>, <tt>__builtin_choose_expr</tt>,
Chris Lattnerceebeb62004-06-18 06:26:29 +0000312 <tt>__builtin_constant_p</tt>, and <tt>__builtin_expect</tt>
313 (currently ignored). We also support builtins for ISO C99 floating
Chris Lattner7939b782005-05-07 02:21:21 +0000314 point comparison macros (e.g., <tt>__builtin_islessequal</tt>),
315 <tt>__builtin_prefetch</tt>, <tt>__builtin_popcount[ll]</tt>,
316 <tt>__builtin_clz[ll]</tt>, and <tt>__builtin_ctz[ll]</tt>.</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000317 </ol>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000318
Misha Brukman500bc302003-11-22 00:38:41 +0000319 <p>The following extensions <b>are</b> known to be supported:</p>
320
Chris Lattner79c3fe12003-10-02 04:57:28 +0000321 <ol>
Chris Lattner7fe97dd2004-03-16 08:54:07 +0000322 <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 +0000323 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Statement-Exprs.html#Statement%20Exprs">Statement Exprs</a>: Putting statements and declarations inside expressions.</li>
324 <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 Lattnerca26c3e2004-06-22 03:48:17 +0000325 <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 Brukman500bc302003-11-22 00:38:41 +0000326 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Conditionals.html#Conditionals">Conditionals</a>: Omitting the middle operand of a <code>?:</code> expression.</li>
327 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Long-Long.html#Long%20Long">Long Long</a>: Double-word integers.</li>
328 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Complex.html#Complex">Complex</a>: Data types for complex numbers.</li>
329 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Hex-Floats.html#Hex%20Floats">Hex Floats</a>:Hexadecimal floating-point constants.</li>
330 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Zero-Length.html#Zero%20Length">Zero Length</a>: Zero-length arrays.</li>
331 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Empty-Structures.html#Empty%20Structures">Empty Structures</a>: Structures with no members.</li>
332 <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>
333 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Escaped-Newlines.html#Escaped%20Newlines">Escaped Newlines</a>: Slightly looser rules for escaped newlines.</li>
334 <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 +0000335 <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 +0000336 <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 +0000337 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Compound-Literals.html#Compound%20Literals">Compound Literals</a>: Compound literals give structures, unions,
338or arrays as values.</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000339 <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 +0000340 <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 +0000341 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Case-Ranges.html#Case%20Ranges">Case Ranges</a>: `case 1 ... 9' and such.</li>
342 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Mixed-Declarations.html#Mixed%20Declarations">Mixed Declarations</a>: Mixing declarations and code.</li>
343 <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 Lattner78537e42004-12-08 18:29:38 +0000344 <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 Brukman500bc302003-11-22 00:38:41 +0000345 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Dollar-Signs.html#Dollar%20Signs">Dollar Signs</a>: Dollar sign is allowed in identifiers.</li>
346 <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>
347 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Alignment.html#Alignment">Alignment</a>: Inquiring about the alignment of a type or variable.</li>
348 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Inline.html#Inline">Inline</a>: Defining inline functions (as fast as macros).</li>
349 <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>
350 <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>
351 <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 +0000352 <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 +0000353 <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>
354 <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 +0000355 </ol></li>
356
357</ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000358
Misha Brukman500bc302003-11-22 00:38:41 +0000359<p>If you run into GCC extensions which have not been included in any of these
360lists, please let us know (also including whether or not they work).</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000361
Misha Brukman500bc302003-11-22 00:38:41 +0000362</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000363
Misha Brukman500bc302003-11-22 00:38:41 +0000364<!-- ======================================================================= -->
365<div class="doc_subsection">
366 <a name="c++-fe">Known problems with the C++ front-end</a>
367</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000368
Misha Brukman500bc302003-11-22 00:38:41 +0000369<div class="doc_text">
370
Reid Spencere09ca642004-12-07 08:39:08 +0000371<p>For this release, the C++ front-end is considered to be fully
Chris Lattner7506b1d2004-12-07 08:04:13 +0000372tested and works for a number of non-trivial programs, including LLVM
373itself.</p>
Misha Brukman500bc302003-11-22 00:38:41 +0000374
375</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000376
377<!-- _______________________________________________________________________ -->
Chris Lattner3a51be12004-02-14 04:12:41 +0000378<div class="doc_subsubsection">Bugs</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000379
Misha Brukman500bc302003-11-22 00:38:41 +0000380<div class="doc_text">
Chris Lattner79c3fe12003-10-02 04:57:28 +0000381
Misha Brukman500bc302003-11-22 00:38:41 +0000382<ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000383<li>The C++ front-end inherits all problems afflicting the <a href="#c-fe">C
John Criswelld000e1d2003-12-18 16:43:17 +0000384 front-end</a>.</li>
Chris Lattner7962f712004-07-17 02:04:41 +0000385
Chris Lattnerd5713882004-08-02 20:28:44 +0000386</ul>
387
Misha Brukman500bc302003-11-22 00:38:41 +0000388</div>
389
390<!-- _______________________________________________________________________ -->
391<div class="doc_subsubsection">
392 Notes
393</div>
394
395<div class="doc_text">
396
397<ul>
Chris Lattnere01fcfb2003-10-27 18:30:37 +0000398
Chris Lattner79c3fe12003-10-02 04:57:28 +0000399<li>The C++ front-end is based on a pre-release of the GCC 3.4 C++ parser. This
400parser is significantly more standards compliant (and picky) than prior GCC
401versions. For more information, see the C++ section of the <a
Chris Lattner9e848092003-12-12 04:25:33 +0000402href="http://gcc.gnu.org/gcc-3.4/changes.html">GCC 3.4 release notes</a>.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000403
404<li>Destructors for local objects are not always run when a <tt>longjmp</tt> is
Chris Lattner19092612003-10-02 16:38:05 +0000405 performed. In particular, destructors for objects in the <tt>longjmp</tt>ing
Chris Lattner79c3fe12003-10-02 04:57:28 +0000406 function and in the <tt>setjmp</tt> receiver function may not be run.
John Criswelld000e1d2003-12-18 16:43:17 +0000407 Objects in intervening stack frames will be destroyed, however (which is
Misha Brukman500bc302003-11-22 00:38:41 +0000408 better than most compilers).</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000409
Chris Lattner19092612003-10-02 16:38:05 +0000410<li>The LLVM C++ front-end follows the <a
411 href="http://www.codesourcery.com/cxx-abi">Itanium C++ ABI</a>.
412 This document, which is not Itanium specific, specifies a standard for name
413 mangling, class layout, v-table layout, RTTI formats, and other C++
414 representation issues. Because we use this API, code generated by the LLVM
415 compilers should be binary compatible with machine code generated by other
416 Itanium ABI C++ compilers (such as G++, the Intel and HP compilers, etc).
417 <i>However</i>, the exception handling mechanism used by LLVM is very
418 different from the model used in the Itanium ABI, so <b>exceptions will not
Misha Brukman500bc302003-11-22 00:38:41 +0000419 interact correctly</b>. </li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000420
Misha Brukman500bc302003-11-22 00:38:41 +0000421</ul>
Chris Lattnerfcc54b32003-10-07 22:14:37 +0000422
Misha Brukman500bc302003-11-22 00:38:41 +0000423</div>
424
425<!-- ======================================================================= -->
426<div class="doc_subsection">
Misha Brukman500bc302003-11-22 00:38:41 +0000427 <a name="c-be">Known problems with the C back-end</a>
428</div>
429
430<div class="doc_text">
431
432<ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000433
434<li>The C back-end produces code that violates the ANSI C Type-Based Alias
435Analysis rules. As such, special options may be necessary to compile the code
436(for example, GCC requires the <tt>-fno-strict-aliasing</tt> option). This
Misha Brukman500bc302003-11-22 00:38:41 +0000437problem probably cannot be fixed.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000438
Chris Lattner2855ecd2003-11-04 20:06:53 +0000439<li><a href="http://llvm.cs.uiuc.edu/PR56">Zero arg vararg functions are not
Chris Lattner2af46052003-10-24 04:03:19 +0000440supported</a>. This should not affect LLVM produced by the C or C++
Misha Brukman500bc302003-11-22 00:38:41 +0000441frontends.</li>
Chris Lattner2af46052003-10-24 04:03:19 +0000442
Misha Brukman500bc302003-11-22 00:38:41 +0000443</ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000444
Misha Brukman500bc302003-11-22 00:38:41 +0000445</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000446
Andrew Lenharth30a1f8f2005-05-03 16:59:09 +0000447<!-- ======================================================================= -->
448<div class="doc_subsection">
Chris Lattnerf9b1f462005-05-16 17:06:29 +0000449 <a name="x86-be">Known problems with the X86 back-end</a>
450</div>
451
452<div class="doc_text">
453
454<ul>
John Criswell8bfe6a72005-05-18 19:43:33 +0000455<li><a href="http://llvm.cs.uiuc.edu/PR566">Memory Mapped I/O Intrinsics do not fence memory</a></li>
Chris Lattnerf9b1f462005-05-16 17:06:29 +0000456</ul>
457
458</div>
459
460<!-- ======================================================================= -->
461<div class="doc_subsection">
462 <a name="ppc-be">Known problems with the PowerPC back-end</a>
463</div>
464
465<div class="doc_text">
466
467<ul>
468<li>None yet</li>
469</ul>
470
471</div>
472
473<!-- ======================================================================= -->
474<div class="doc_subsection">
475 <a name="sparcv9-be">Known problems with the SparcV9 back-end</a>
476</div>
477
478<div class="doc_text">
479
480<ul>
481<li><a href="http://llvm.cs.uiuc.edu/PR60">[sparcv9] SparcV9 backend miscompiles
482several programs in the LLVM test suite</a></li>
483</ul>
484
485</div>
486
487<!-- ======================================================================= -->
488<div class="doc_subsection">
Andrew Lenharth30a1f8f2005-05-03 16:59:09 +0000489 <a name="alpha-be">Known problems with the Alpha back-end</a>
490</div>
491
492<div class="doc_text">
493
494<ul>
495
Chris Lattnerf9b1f462005-05-16 17:06:29 +0000496<li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
497appropriate nops inserted to ensure restartability.</li>
Andrew Lenharth30a1f8f2005-05-03 16:59:09 +0000498
Chris Lattnerf9b1f462005-05-16 17:06:29 +0000499<li>Defining vararg functions is not supported (but calling them is ok).</li>
Andrew Lenharth30a1f8f2005-05-03 16:59:09 +0000500
Andrew Lenharth01f40b32005-05-14 17:43:00 +0000501<li>Due to the vararg problems, C++ exceptions do not work. Small changes are required to the CFE (which break correctness in the exception handler) to compile the exception handling library (and thus the C++ standard library).</li>
502
Andrew Lenharth30a1f8f2005-05-03 16:59:09 +0000503</ul>
504
505</div>
506
Duraid Madina2e36d6e2005-05-14 05:48:13 +0000507<!-- ======================================================================= -->
508<div class="doc_subsection">
509 <a name="ia64-be">Known problems with the IA64 back-end</a>
510</div>
511
512<div class="doc_text">
513
514<ul>
515
516<li>C++ programs are likely to fail on IA64, as calls to <tt>setjmp</tt> are
517made where the argument is not 16-byte aligned, as required on IA64. (Strictly
518speaking this is not a bug in the IA64 back-end; it will also be encountered
519when building C++ programs using the C back-end.)</li>
520
Chris Lattnerf9b1f462005-05-16 17:06:29 +0000521<li>The C++ front-end does not use <a href="http://llvm.cs.uiuc.edu/PR406">IA64
522ABI compliant layout of v-tables</a>. In particular, it just stores function
523pointers instead of function descriptors in the vtable. This bug prevents
524mixing C++ code compiled with LLVM with C++ objects compiled by other C++
525compilers.</li>
Duraid Madina2e36d6e2005-05-14 05:48:13 +0000526
Chris Lattnerf9b1f462005-05-16 17:06:29 +0000527<li>There are a few ABI violations which will lead to problems when mixing LLVM
528output with code built with other compilers, particularly for floating-point
529programs.</li>
530
531<li>Defining vararg functions is not supported (but calling them is ok).</li>
Duraid Madina2e36d6e2005-05-14 05:48:13 +0000532
533</ul>
534
535</div>
536
Chris Lattner98a493c2005-05-15 16:01:20 +0000537<!-- ======================================================================= -->
538<div class="doc_subsection">
539 <a name="sparcv8">Known problems with the SPARC-V8 back-end</a>
540</div>
541
542<div class="doc_text">
543
544<ul>
545<li>Many features are still missing (e.g. support for 64-bit integer
546arithmetic).</li>
547
548<li>This backend needs to be updated to use the SelectionDAG instruction
549selection framework.</li>
550</ul>
551
552</div>
553
Chris Lattner79c3fe12003-10-02 04:57:28 +0000554<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000555<div class="doc_section">
556 <a name="additionalinfo">Additional Information</a>
557</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000558<!-- *********************************************************************** -->
559
Misha Brukman500bc302003-11-22 00:38:41 +0000560<div class="doc_text">
561
Chris Lattner416db102005-05-16 17:13:10 +0000562<p>A wide variety of additional information is available on the <a
563href="http://llvm.cs.uiuc.edu">LLVM web page</a>, including <a
564href="http://llvm.cs.uiuc.edu/docs/">documentation</a> and <a
565href="http://llvm.cs.uiuc.edu/pubs/">publications describing algorithms and
Misha Brukman109d9e82005-03-30 19:14:24 +0000566components implemented in LLVM</a>. The web page also contains versions of the
567API documentation which is up-to-date with the CVS version of the source code.
568You can access versions of these documents specific to this release by going
569into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000570
Misha Brukman500bc302003-11-22 00:38:41 +0000571<p>If you have any questions or comments about LLVM, please feel free to contact
Chris Lattner416db102005-05-16 17:13:10 +0000572us via the <a href="http://llvm.cs.uiuc.edu/docs/#maillist"> mailing
Chris Lattner5eccca42003-12-12 21:22:16 +0000573lists</a>.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000574
Misha Brukman500bc302003-11-22 00:38:41 +0000575</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000576
577<!-- *********************************************************************** -->
Chris Lattner79c3fe12003-10-02 04:57:28 +0000578
Misha Brukman500bc302003-11-22 00:38:41 +0000579<hr>
Misha Brukman2061e892003-11-22 01:23:39 +0000580<address>
Misha Brukman38847d52003-12-21 22:53:21 +0000581 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman2061e892003-11-22 01:23:39 +0000582 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
583 <a href="http://validator.w3.org/check/referer"><img
584 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
585
Misha Brukmane0c891c2003-11-22 01:00:11 +0000586 <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br>
Misha Brukman500bc302003-11-22 00:38:41 +0000587 Last modified: $Date$
Misha Brukman2061e892003-11-22 01:23:39 +0000588</address>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000589
Misha Brukman500bc302003-11-22 00:38:41 +0000590</body>
591</html>