blob: 8baa90b38d351c8ef9a9af83894836e6ebd32e19 [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">
Chris Lattner78bf32b2004-12-09 22:22:58 +00007 <title>LLVM 1.5 Release Notes</title>
Misha Brukman500bc302003-11-22 00:38:41 +00008</head>
9<body>
Chris Lattner79c3fe12003-10-02 04:57:28 +000010
Chris Lattner78bf32b2004-12-09 22:22:58 +000011<div class="doc_title">LLVM 1.5 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
Chris Lattner78bf32b2004-12-09 22:22:58 +000035infrastructure, release 1.5. Here we describe the status of LLVM, including any
Chris Lattner7506b1d2004-12-07 08:04:13 +000036known problems and improvements from the previous release. The most up-to-date
Misha Brukman500bc302003-11-22 00:38:41 +000037version of this document can be found on the <a
Chris Lattner78bf32b2004-12-09 22:22:58 +000038href="http://llvm.cs.uiuc.edu/releases/1.5/">LLVM 1.5 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
Chris Lattner78bf32b2004-12-09 22:22:58 +000063<p>This is the sixth public release of the LLVM compiler infrastructure.</p>
Chris Lattnera5099962003-12-06 20:22:41 +000064
Chris Lattner0bce6ac2004-12-10 16:27:34 +000065<p> At this time, LLVM is known to correctly compile a broad range of C and
Chris Lattner78bf32b2004-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 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<!--=========================================================================-->
72<div class="doc_subsubsection">
Chris Lattnera39719f2004-02-25 16:36:51 +000073<a name="newfeatures">This release implements the following new features:</a>
Chris Lattnera5099962003-12-06 20:22:41 +000074</div>
Chris Lattner47ad72c2003-10-07 21:38:31 +000075
Chris Lattner80453c92004-05-24 04:50:25 +000076<div class="doc_text">
Chris Lattner47ad72c2003-10-07 21:38:31 +000077<ol>
Chris Lattner74d74cd2004-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 Lattner55ee0312003-11-19 22:05:38 +000081</ol>
Chris Lattner0ef19062003-11-08 04:28:55 +000082
Chris Lattner80453c92004-05-24 04:50:25 +000083</div>
84
Chris Lattnera5099962003-12-06 20:22:41 +000085
86<!--=========================================================================-->
87<div class="doc_subsubsection">
88In this release, the following missing features were implemented:
89</div>
Chris Lattner0ef19062003-11-08 04:28:55 +000090
Chris Lattner80453c92004-05-24 04:50:25 +000091<div class="doc_text">
92
Chris Lattner0ef19062003-11-08 04:28:55 +000093<ol>
Chris Lattner78bf32b2004-12-09 22:22:58 +000094 <li></li>
Misha Brukman500bc302003-11-22 00:38:41 +000095</ol>
Chris Lattner47ad72c2003-10-07 21:38:31 +000096
Chris Lattner80453c92004-05-24 04:50:25 +000097</div>
Chris Lattnera5099962003-12-06 20:22:41 +000098
99<!--=========================================================================-->
100<div class="doc_subsubsection">
Misha Brukmana7aadf12004-04-19 02:56:49 +0000101<a name="qualityofimp">In this release, the following Quality of Implementation
102issues were fixed:</a>
Chris Lattnere29ac162003-12-20 03:42:11 +0000103</div>
104
Chris Lattner80453c92004-05-24 04:50:25 +0000105<div class="doc_text">
106
Chris Lattnere29ac162003-12-20 03:42:11 +0000107<ol>
Chris Lattner78bf32b2004-12-09 22:22:58 +0000108 <li></li>
Brian Gaeke6b31beb2004-01-16 21:55:04 +0000109</ol>
Chris Lattner80453c92004-05-24 04:50:25 +0000110</div>
Brian Gaeke6b31beb2004-01-16 21:55:04 +0000111
112<!--=========================================================================-->
113<div class="doc_subsubsection">
Chris Lattner6e1ef192004-05-02 04:19:15 +0000114<a name="codequality">This release includes the following Code Quality
115improvements:</a>
Chris Lattneraab56d42004-05-23 20:42:08 +0000116</div>
Chris Lattner89ca2b82003-10-27 17:06:39 +0000117
Chris Lattner80453c92004-05-24 04:50:25 +0000118<div class="doc_text">
Chris Lattner89ca2b82003-10-27 17:06:39 +0000119<ol>
Chris Lattner78bf32b2004-12-09 22:22:58 +0000120 <li></li>
Misha Brukman500bc302003-11-22 00:38:41 +0000121</ol>
Reid Spencer8e0262f2004-05-23 17:23:13 +0000122</div>
Chris Lattnera5099962003-12-06 20:22:41 +0000123
124<!--=========================================================================-->
125<div class="doc_subsubsection">
Misha Brukmana7aadf12004-04-19 02:56:49 +0000126<a name="bugfix">In this release, the following bugs in the previous release
127were fixed:</a>
Chris Lattnera5099962003-12-06 20:22:41 +0000128</div>
129
Chris Lattner80453c92004-05-24 04:50:25 +0000130<div class="doc_text">
131
Chris Lattnerd5713882004-08-02 20:28:44 +0000132<p>Bugs fixed in the LLVM Core:</p>
Chris Lattner47ad72c2003-10-07 21:38:31 +0000133
134<ol>
Chris Lattnere9367712004-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 Lattnerbfd24682004-12-29 04:39:50 +0000137 <li><a href="http://llvm.cs.uiuc.edu/PR491">[dse] DSE deletes stores that
138 are partially overwritten by smaller stores</a></li>
Chris Lattnera5099962003-12-06 20:22:41 +0000139</ol>
140
Chris Lattnera5099962003-12-06 20:22:41 +0000141<p>Bugs in the C/C++ front-end:</p>
142
143<ol>
Chris Lattner8de9f232005-01-03 04:20:21 +0000144 <li><a href="http://llvm.cs.uiuc.edu/PR487">[llvmgcc] llvm-gcc incorrectly
145 rejects some constant initializers involving the addresses of array
146 elements</a></li>
Brian Gaekee77c8e72004-08-24 07:43:48 +0000147</ol>
148
Chris Lattner80453c92004-05-24 04:50:25 +0000149</div>
Reid Spencer8e0262f2004-05-23 17:23:13 +0000150
Chris Lattner19092612003-10-02 16:38:05 +0000151<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000152<div class="doc_section">
153 <a name="portability">Portability and Supported Platforms</a>
154</div>
Chris Lattner19092612003-10-02 16:38:05 +0000155<!-- *********************************************************************** -->
156
Misha Brukman500bc302003-11-22 00:38:41 +0000157<div class="doc_text">
158
John Criswell0b5b5e92004-12-08 20:35:47 +0000159<p>LLVM is known to work on the following platforms:</p>
Chris Lattner4654bdb2004-06-01 18:22:41 +0000160
161<ul>
162<li>Intel and AMD machines running Red Hat Linux and FreeBSD (and probably
163 other unix-like systems).</li>
164<li>Sun UltraSPARC workstations running Solaris 8.</li>
Chris Lattner7506b1d2004-12-07 08:04:13 +0000165<li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
166 support is available for native builds with Visual C++).</li>
167<li>PowerPC-based Mac OS X systems, running 10.2 and above.</li>
Chris Lattner4654bdb2004-06-01 18:22:41 +0000168</ul>
169
Brian Gaekeb0fd7612004-05-09 05:28:35 +0000170<p>The core LLVM infrastructure uses
171<a href="http://www.gnu.org/software/autoconf/">GNU autoconf</a> to adapt itself
172to the machine and operating system on which it is built. However, minor
173porting may be required to get LLVM to work on new platforms. We welcome your
174portability patches and reports of successful builds or error messages.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000175
Misha Brukman500bc302003-11-22 00:38:41 +0000176</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000177
178<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000179<div class="doc_section">
180 <a name="knownproblems">Known Problems</a>
181</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000182<!-- *********************************************************************** -->
183
Misha Brukman500bc302003-11-22 00:38:41 +0000184<div class="doc_text">
185
186<p>This section contains all known problems with the LLVM system, listed by
Chris Lattner79c3fe12003-10-02 04:57:28 +0000187component. As new problems are discovered, they will be added to these
Chris Lattner5eccca42003-12-12 21:22:16 +0000188sections. If you run into a problem, please check the <a
John Criswelld000e1d2003-12-18 16:43:17 +0000189href="http://llvm.cs.uiuc.edu/bugs/">LLVM bug database</a> and submit a bug if
Chris Lattner5eccca42003-12-12 21:22:16 +0000190there isn't already one.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000191
Misha Brukman500bc302003-11-22 00:38:41 +0000192</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000193
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000194<!-- ======================================================================= -->
195<div class="doc_subsection">
196 <a name="experimental">Experimental features included with this release</a>
197</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000198
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000199<div class="doc_text">
200
Misha Brukman6df9e2c2004-05-12 21:46:05 +0000201<p>The following components of this LLVM release are either untested, known to
202be broken or unreliable, or are in early development. These components should
203not be relied on, and bugs should not be filed against them, but they may be
204useful to some people. In particular, if you would like to work on one of these
205components, please contact us on the llvmdev list.</p>
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000206
207<ul>
Chris Lattner7506b1d2004-12-07 08:04:13 +0000208<li>The following passes are incomplete or buggy, and may be removed in future
209 releases: <tt>-pgmdep, -memdep, -ipmodref, -cee, -branch-combine,
210 -instloops, -paths, -pre</tt></li>
211<li>The <tt>llvm-db</tt> tool is in a very early stage of development, but can
212 be used to step through programs and inspect the stack.</li>
Chris Lattner0da7f492004-12-02 17:20:17 +0000213<li>The "iterative scan" register allocator (enabled with -regalloc=iterativescan)
214 is not stable.</li>
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000215</ul>
216
217</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000218
Misha Brukman500bc302003-11-22 00:38:41 +0000219<!-- ======================================================================= -->
220<div class="doc_subsection">
221 <a name="core">Known problems with the LLVM Core</a>
222</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000223
Misha Brukman500bc302003-11-22 00:38:41 +0000224<div class="doc_text">
225
226<ul>
Reid Spencer4f86f9c2004-11-25 22:38:30 +0000227 <li>In the JIT, <tt>dlsym</tt> on a symbol compiled by the JIT will not work.
228 </li>
229 <li>The JIT does not use mutexes to protect its internal data structures. As
230 such, execution of a threaded program could cause these data structures to be
231 corrupted.
232 </li>
Reid Spencer4f86f9c2004-11-25 22:38:30 +0000233 <li><a href="http://llvm.cs.uiuc.edu/PR240">The lower-invoke pass does not
234 mark values live across a setjmp as volatile</a>. This missing feature
235 only affects targets whose setjmp/longjmp libraries do not save and restore
236 the entire register file.</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000237</ul>
Misha Brukman500bc302003-11-22 00:38:41 +0000238</div>
239
240<!-- ======================================================================= -->
241<div class="doc_subsection">
242 <a name="c-fe">Known problems with the C front-end</a>
243</div>
Chris Lattner47588f92003-10-02 05:07:23 +0000244
Chris Lattner79c3fe12003-10-02 04:57:28 +0000245<!-- _______________________________________________________________________ -->
Chris Lattnerb40efb32003-12-14 05:03:43 +0000246<div class="doc_subsubsection">Bugs</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000247
Misha Brukman500bc302003-11-22 00:38:41 +0000248<div class="doc_text">
Misha Brukman500bc302003-11-22 00:38:41 +0000249<ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000250<li>C99 Variable sized arrays do not release stack memory when they go out of
251 scope. Thus, the following program may run out of stack space:
252<pre>
253 for (i = 0; i != 1000000; ++i) {
254 int X[n];
255 foo(X);
256 }
Misha Brukman500bc302003-11-22 00:38:41 +0000257</pre></li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000258
Misha Brukman6df9e2c2004-05-12 21:46:05 +0000259<li>Initialization of global union variables can only be done <a
Misha Brukman43ee2932004-12-04 00:45:09 +0000260href="http://llvm.cs.uiuc.edu/PR162">with the largest union member</a>.</li>
Chris Lattnerf580cdc2004-03-16 21:39:04 +0000261
John Criswelld000e1d2003-12-18 16:43:17 +0000262</ul>
Misha Brukman500bc302003-11-22 00:38:41 +0000263</div>
264
265<!-- _______________________________________________________________________ -->
266<div class="doc_subsubsection">
267 Notes
268</div>
269
270<div class="doc_text">
271
272<ul>
273
274<li>Inline assembly is not yet supported.</li>
Chris Lattnere01fcfb2003-10-27 18:30:37 +0000275
276<li>"long double" is transformed by the front-end into "double". There is no
Misha Brukman500bc302003-11-22 00:38:41 +0000277support for floating point data types of any size other than 32 and 64
278bits.</li>
279
280<li>The following Unix system functionality has not been tested and may not
281work:
Misha Brukmane0c891c2003-11-22 01:00:11 +0000282 <ol>
283 <li><tt>sigsetjmp</tt>, <tt>siglongjmp</tt> - These are not turned into the
284 appropriate <tt>invoke</tt>/<tt>unwind</tt> instructions. Note that
285 <tt>setjmp</tt> and <tt>longjmp</tt> <em>are</em> compiled correctly.
286 <li><tt>getcontext</tt>, <tt>setcontext</tt>, <tt>makecontext</tt>
287 - These functions have not been tested.
288 </ol></li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000289
290<li>Although many GCC extensions are supported, some are not. In particular,
291 the following extensions are known to <b>not be</b> supported:
292 <ol>
Misha Brukman500bc302003-11-22 00:38:41 +0000293 <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 +0000294 <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>
295 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Constructing-Calls.html#Constructing%20Calls">Constructing Calls</a>: Dispatching a call to another function.</li>
296 <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 +0000297 <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 +0000298 <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>
299 <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 +0000300 <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>
301 <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 +0000302 <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 +0000303 <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 +0000304 </ol>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000305
Misha Brukman500bc302003-11-22 00:38:41 +0000306 <p>The following GCC extensions are <b>partially</b> supported. An ignored
Chris Lattner79c3fe12003-10-02 04:57:28 +0000307 attribute means that the LLVM compiler ignores the presence of the attribute,
308 but the code should still work. An unsupported attribute is one which is
John Criswelld000e1d2003-12-18 16:43:17 +0000309 ignored by the LLVM compiler and will cause a different interpretation of
Misha Brukman500bc302003-11-22 00:38:41 +0000310 the program.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000311
312 <ol>
313 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Length.html#Variable%20Length">Variable Length</a>:
314 Arrays whose length is computed at run time.<br>
Misha Brukman500bc302003-11-22 00:38:41 +0000315 Supported, but allocated stack space is not freed until the function returns (noted above).</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000316
317 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Attributes.html#Function%20Attributes">Function Attributes</a>:
Misha Brukman500bc302003-11-22 00:38:41 +0000318
John Criswelld000e1d2003-12-18 16:43:17 +0000319 Declaring that functions have no side effects or that they can never
Misha Brukman500bc302003-11-22 00:38:41 +0000320 return.<br>
321
322 <b>Supported:</b> <tt>format</tt>, <tt>format_arg</tt>, <tt>non_null</tt>,
John Criswell0b5b5e92004-12-08 20:35:47 +0000323 <tt>noreturn</tt>, <tt>constructor</tt>, <tt>destructor</tt>,
324 <tt>unused</tt>,
Misha Brukman500bc302003-11-22 00:38:41 +0000325 <tt>deprecated</tt>, <tt>warn_unused_result</tt>, <tt>weak</tt><br>
326
John Criswell0b5b5e92004-12-08 20:35:47 +0000327 <b>Ignored:</b> <tt>noinline</tt>,
Misha Brukman500bc302003-11-22 00:38:41 +0000328 <tt>always_inline</tt>, <tt>pure</tt>, <tt>const</tt>, <tt>nothrow</tt>,
329 <tt>malloc</tt>, <tt>no_instrument_function</tt>, <tt>cdecl</tt><br>
330
331 <b>Unsupported:</b> <tt>used</tt>, <tt>section</tt>, <tt>alias</tt>,
332 <tt>visibility</tt>, <tt>regparm</tt>, <tt>stdcall</tt>,
333 <tt>fastcall</tt>, all other target specific attributes</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000334
335 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Attributes.html#Variable%20Attributes">Variable Attributes</a>:
336 Specifying attributes of variables.<br>
337 <b>Supported:</b> <tt>cleanup</tt>, <tt>common</tt>, <tt>nocommon</tt>,
338 <tt>deprecated</tt>, <tt>transparent_union</tt>,
339 <tt>unused</tt>, <tt>weak</tt><br>
Misha Brukman500bc302003-11-22 00:38:41 +0000340
Chris Lattner79c3fe12003-10-02 04:57:28 +0000341 <b>Unsupported:</b> <tt>aligned</tt>, <tt>mode</tt>, <tt>packed</tt>,
342 <tt>section</tt>, <tt>shared</tt>, <tt>tls_model</tt>,
343 <tt>vector_size</tt>, <tt>dllimport</tt>,
Misha Brukman500bc302003-11-22 00:38:41 +0000344 <tt>dllexport</tt>, all target specific attributes.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000345
Misha Brukmanc4b7bee2003-12-12 04:37:31 +0000346 <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 +0000347 <b>Supported:</b> <tt>transparent_union</tt>, <tt>unused</tt>,
Misha Brukmanc4b7bee2003-12-12 04:37:31 +0000348 <tt>deprecated</tt>, <tt>may_alias</tt><br>
Misha Brukman500bc302003-11-22 00:38:41 +0000349
350 <b>Unsupported:</b> <tt>aligned</tt>, <tt>packed</tt>,
351 all target specific attributes.</li>
352
Chris Lattner79c3fe12003-10-02 04:57:28 +0000353 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Other-Builtins.html#Other%20Builtins">Other Builtins</a>:
354 Other built-in functions.<br>
355 We support all builtins which have a C language equivalent (e.g.,
356 <tt>__builtin_cos</tt>), <tt>__builtin_alloca</tt>,
357 <tt>__builtin_types_compatible_p</tt>, <tt>__builtin_choose_expr</tt>,
Chris Lattnerceebeb62004-06-18 06:26:29 +0000358 <tt>__builtin_constant_p</tt>, and <tt>__builtin_expect</tt>
359 (currently ignored). We also support builtins for ISO C99 floating
360 point comparison macros (e.g., <tt>__builtin_islessequal</tt>).</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000361 </ol>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000362
Misha Brukman500bc302003-11-22 00:38:41 +0000363 <p>The following extensions <b>are</b> known to be supported:</p>
364
Chris Lattner79c3fe12003-10-02 04:57:28 +0000365 <ol>
Chris Lattner7fe97dd2004-03-16 08:54:07 +0000366 <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 +0000367 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Statement-Exprs.html#Statement%20Exprs">Statement Exprs</a>: Putting statements and declarations inside expressions.</li>
368 <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 +0000369 <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 +0000370 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Conditionals.html#Conditionals">Conditionals</a>: Omitting the middle operand of a <code>?:</code> expression.</li>
371 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Long-Long.html#Long%20Long">Long Long</a>: Double-word integers.</li>
372 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Complex.html#Complex">Complex</a>: Data types for complex numbers.</li>
373 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Hex-Floats.html#Hex%20Floats">Hex Floats</a>:Hexadecimal floating-point constants.</li>
374 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Zero-Length.html#Zero%20Length">Zero Length</a>: Zero-length arrays.</li>
375 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Empty-Structures.html#Empty%20Structures">Empty Structures</a>: Structures with no members.</li>
376 <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>
377 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Escaped-Newlines.html#Escaped%20Newlines">Escaped Newlines</a>: Slightly looser rules for escaped newlines.</li>
378 <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 +0000379 <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 +0000380 <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 +0000381 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Compound-Literals.html#Compound%20Literals">Compound Literals</a>: Compound literals give structures, unions,
382or arrays as values.</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000383 <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 +0000384 <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 +0000385 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Case-Ranges.html#Case%20Ranges">Case Ranges</a>: `case 1 ... 9' and such.</li>
386 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Mixed-Declarations.html#Mixed%20Declarations">Mixed Declarations</a>: Mixing declarations and code.</li>
387 <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 +0000388 <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 +0000389 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Dollar-Signs.html#Dollar%20Signs">Dollar Signs</a>: Dollar sign is allowed in identifiers.</li>
390 <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>
391 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Alignment.html#Alignment">Alignment</a>: Inquiring about the alignment of a type or variable.</li>
392 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Inline.html#Inline">Inline</a>: Defining inline functions (as fast as macros).</li>
393 <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>
394 <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>
395 <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 +0000396 <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 +0000397 <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>
398 <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 +0000399 </ol></li>
400
401</ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000402
Misha Brukman500bc302003-11-22 00:38:41 +0000403<p>If you run into GCC extensions which have not been included in any of these
404lists, please let us know (also including whether or not they work).</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000405
Misha Brukman500bc302003-11-22 00:38:41 +0000406</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000407
Misha Brukman500bc302003-11-22 00:38:41 +0000408<!-- ======================================================================= -->
409<div class="doc_subsection">
410 <a name="c++-fe">Known problems with the C++ front-end</a>
411</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000412
Misha Brukman500bc302003-11-22 00:38:41 +0000413<div class="doc_text">
414
Reid Spencere09ca642004-12-07 08:39:08 +0000415<p>For this release, the C++ front-end is considered to be fully
Chris Lattner7506b1d2004-12-07 08:04:13 +0000416tested and works for a number of non-trivial programs, including LLVM
417itself.</p>
Misha Brukman500bc302003-11-22 00:38:41 +0000418
419</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000420
421<!-- _______________________________________________________________________ -->
Chris Lattner3a51be12004-02-14 04:12:41 +0000422<div class="doc_subsubsection">Bugs</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000423
Misha Brukman500bc302003-11-22 00:38:41 +0000424<div class="doc_text">
Chris Lattner79c3fe12003-10-02 04:57:28 +0000425
Misha Brukman500bc302003-11-22 00:38:41 +0000426<ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000427<li>The C++ front-end inherits all problems afflicting the <a href="#c-fe">C
John Criswelld000e1d2003-12-18 16:43:17 +0000428 front-end</a>.</li>
Chris Lattner7962f712004-07-17 02:04:41 +0000429
Chris Lattnerd5713882004-08-02 20:28:44 +0000430<li><b>IA-64 specific</b>: The C++ front-end does not use <a
431href="http://llvm.cs.uiuc.edu/PR406">IA64 ABI compliant layout of v-tables</a>.
Chris Lattner7962f712004-07-17 02:04:41 +0000432In particular, it just stores function pointers instead of function
433descriptors in the vtable. This bug prevents mixing C++ code compiled with
Chris Lattner04db8082004-08-02 20:29:51 +0000434LLVM with C++ objects compiled by other C++ compilers.</li>
Chris Lattner7962f712004-07-17 02:04:41 +0000435
Chris Lattnerd5713882004-08-02 20:28:44 +0000436</ul>
437
Misha Brukman500bc302003-11-22 00:38:41 +0000438</div>
439
440<!-- _______________________________________________________________________ -->
441<div class="doc_subsubsection">
442 Notes
443</div>
444
445<div class="doc_text">
446
447<ul>
Chris Lattnere01fcfb2003-10-27 18:30:37 +0000448
Chris Lattner79c3fe12003-10-02 04:57:28 +0000449<li>The C++ front-end is based on a pre-release of the GCC 3.4 C++ parser. This
450parser is significantly more standards compliant (and picky) than prior GCC
451versions. For more information, see the C++ section of the <a
Chris Lattner9e848092003-12-12 04:25:33 +0000452href="http://gcc.gnu.org/gcc-3.4/changes.html">GCC 3.4 release notes</a>.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000453
454<li>Destructors for local objects are not always run when a <tt>longjmp</tt> is
Chris Lattner19092612003-10-02 16:38:05 +0000455 performed. In particular, destructors for objects in the <tt>longjmp</tt>ing
Chris Lattner79c3fe12003-10-02 04:57:28 +0000456 function and in the <tt>setjmp</tt> receiver function may not be run.
John Criswelld000e1d2003-12-18 16:43:17 +0000457 Objects in intervening stack frames will be destroyed, however (which is
Misha Brukman500bc302003-11-22 00:38:41 +0000458 better than most compilers).</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000459
Chris Lattner19092612003-10-02 16:38:05 +0000460<li>The LLVM C++ front-end follows the <a
461 href="http://www.codesourcery.com/cxx-abi">Itanium C++ ABI</a>.
462 This document, which is not Itanium specific, specifies a standard for name
463 mangling, class layout, v-table layout, RTTI formats, and other C++
464 representation issues. Because we use this API, code generated by the LLVM
465 compilers should be binary compatible with machine code generated by other
466 Itanium ABI C++ compilers (such as G++, the Intel and HP compilers, etc).
467 <i>However</i>, the exception handling mechanism used by LLVM is very
468 different from the model used in the Itanium ABI, so <b>exceptions will not
Misha Brukman500bc302003-11-22 00:38:41 +0000469 interact correctly</b>. </li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000470
Misha Brukman500bc302003-11-22 00:38:41 +0000471</ul>
Chris Lattnerfcc54b32003-10-07 22:14:37 +0000472
Misha Brukman500bc302003-11-22 00:38:41 +0000473</div>
474
475<!-- ======================================================================= -->
476<div class="doc_subsection">
477 <a name="x86-be">Known problems with the X86 back-end</a>
478</div>
479
480<div class="doc_text">
481
482<ul>
Chris Lattnerd5713882004-08-02 20:28:44 +0000483 <li>none yet</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000484</ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000485
Misha Brukman500bc302003-11-22 00:38:41 +0000486</div>
487
488<!-- ======================================================================= -->
489<div class="doc_subsection">
Misha Brukmanadb1c392004-07-12 16:55:41 +0000490 <a name="sparcv9-be">Known problems with the SparcV9 back-end</a>
Misha Brukman500bc302003-11-22 00:38:41 +0000491</div>
492
493<div class="doc_text">
494
495<ul>
Misha Brukmanadb1c392004-07-12 16:55:41 +0000496<li><a href="http://llvm.cs.uiuc.edu/PR60">[sparcv9] SparcV9 backend miscompiles
497several programs in the LLVM test suite</a></li>
Misha Brukman500bc302003-11-22 00:38:41 +0000498</ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000499
Misha Brukman500bc302003-11-22 00:38:41 +0000500</div>
501
502<!-- ======================================================================= -->
503<div class="doc_subsection">
Chris Lattnerf32a5f52004-11-07 01:55:32 +0000504 <a name="ppc-be">Known problems with the PowerPC back-end</a>
505</div>
506
507<div class="doc_text">
508
509<ul>
510<li>none yet</li>
511</ul>
512
513</div>
514
515<!-- ======================================================================= -->
516<div class="doc_subsection">
Misha Brukman500bc302003-11-22 00:38:41 +0000517 <a name="c-be">Known problems with the C back-end</a>
518</div>
519
520<div class="doc_text">
521
522<ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000523
524<li>The C back-end produces code that violates the ANSI C Type-Based Alias
525Analysis rules. As such, special options may be necessary to compile the code
526(for example, GCC requires the <tt>-fno-strict-aliasing</tt> option). This
Misha Brukman500bc302003-11-22 00:38:41 +0000527problem probably cannot be fixed.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000528
Chris Lattner2855ecd2003-11-04 20:06:53 +0000529<li><a href="http://llvm.cs.uiuc.edu/PR56">Zero arg vararg functions are not
Chris Lattner2af46052003-10-24 04:03:19 +0000530supported</a>. This should not affect LLVM produced by the C or C++
Misha Brukman500bc302003-11-22 00:38:41 +0000531frontends.</li>
Chris Lattner2af46052003-10-24 04:03:19 +0000532
Misha Brukman500bc302003-11-22 00:38:41 +0000533</ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000534
Misha Brukman500bc302003-11-22 00:38:41 +0000535</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000536
537<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000538<div class="doc_section">
539 <a name="additionalinfo">Additional Information</a>
540</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000541<!-- *********************************************************************** -->
542
Misha Brukman500bc302003-11-22 00:38:41 +0000543<div class="doc_text">
544
545<p>A wide variety of additional information is available on the LLVM web page,
John Criswelld000e1d2003-12-18 16:43:17 +0000546including mailing lists and publications describing algorithms and components
Chris Lattner79c3fe12003-10-02 04:57:28 +0000547implemented in LLVM. The web page also contains versions of the API
548documentation which is up-to-date with the CVS version of the source code. You
549can access versions of these documents specific to this release by going into
Misha Brukman500bc302003-11-22 00:38:41 +0000550the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000551
Misha Brukman500bc302003-11-22 00:38:41 +0000552<p>If you have any questions or comments about LLVM, please feel free to contact
Chris Lattner5eccca42003-12-12 21:22:16 +0000553us via the <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">mailing
554lists</a>.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000555
Misha Brukman500bc302003-11-22 00:38:41 +0000556</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000557
558<!-- *********************************************************************** -->
Chris Lattner79c3fe12003-10-02 04:57:28 +0000559
Misha Brukman500bc302003-11-22 00:38:41 +0000560<hr>
Misha Brukman2061e892003-11-22 01:23:39 +0000561<address>
Misha Brukman38847d52003-12-21 22:53:21 +0000562 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman2061e892003-11-22 01:23:39 +0000563 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
564 <a href="http://validator.w3.org/check/referer"><img
565 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
566
Misha Brukmane0c891c2003-11-22 01:00:11 +0000567 <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br>
Misha Brukman500bc302003-11-22 00:38:41 +0000568 Last modified: $Date$
Misha Brukman2061e892003-11-22 01:23:39 +0000569</address>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000570
Misha Brukman500bc302003-11-22 00:38:41 +0000571</body>
572</html>