blob: cad0b1579e1b4a99d547aa0ccde7912fb2087170 [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>
5 <link rel="stylesheet" href="llvm.css" type="text/css">
Chris Lattner1a7e43c2004-04-01 00:41:31 +00006 <title>LLVM 1.3 Release Notes</title>
Misha Brukman80731b92003-11-22 00:38:41 +00007</head>
8<body>
Chris Lattner3d482502003-10-02 04:57:28 +00009
Chris Lattner1a7e43c2004-04-01 00:41:31 +000010<div class="doc_title">LLVM 1.3 Release Notes</div>
Chris Lattner3d482502003-10-02 04:57:28 +000011
12<ol>
Misha Brukman80731b92003-11-22 00:38:41 +000013 <li><a href="#intro">Introduction</a></li>
14 <li><a href="#whatsnew">What's New?</a></li>
Chris Lattner77a51732004-04-30 22:17:12 +000015 <li><a href="GettingStarted.html">Installation Instructions</a></li>
Misha Brukman80731b92003-11-22 00:38:41 +000016 <li><a href="#portability">Portability and Supported Platforms</a></li>
Chris Lattner3d482502003-10-02 04:57:28 +000017 <li><a href="#knownproblems">Known Problems</a>
18 <ul>
Chris Lattner1a7e43c2004-04-01 00:41:31 +000019 <li><a href="#experimental">Experimental features included in this
20 release</a>
Chris Lattner3d482502003-10-02 04:57:28 +000021 <li><a href="#core">Known problems with the LLVM Core</a>
22 <li><a href="#c-fe">Known problems with the C Front-end</a>
23 <li><a href="#c++-fe">Known problems with the C++ Front-end</a>
24 <li><a href="#x86-be">Known problems with the X86 Back-end</a>
Misha Brukmana516e992004-07-12 16:55:41 +000025 <li><a href="#sparcv9-be">Known problems with the SparcV9 Back-end</a>
Chris Lattner3d482502003-10-02 04:57:28 +000026 <li><a href="#c-be">Known problems with the C back-end</a>
Misha Brukman80731b92003-11-22 00:38:41 +000027 </ul></li>
28 <li><a href="#additionalinfo">Additional Information</a></li>
Chris Lattner3d482502003-10-02 04:57:28 +000029</ol>
30
Chris Lattner020e1fc2004-05-23 21:07:27 +000031<div class="doc_author">
32 <p>Written by the <a href="http://llvm.cs.uiuc.edu">LLVM team</a><p>
Misha Brukman80731b92003-11-22 00:38:41 +000033</div>
Chris Lattner3d482502003-10-02 04:57:28 +000034
35<!-- *********************************************************************** -->
Misha Brukman80731b92003-11-22 00:38:41 +000036<div class="doc_section">
37 <a name="intro">Introduction</a>
38</div>
Chris Lattner3d482502003-10-02 04:57:28 +000039<!-- *********************************************************************** -->
40
Misha Brukman80731b92003-11-22 00:38:41 +000041<div class="doc_text">
42
43<p>This document contains the release notes for the LLVM compiler
Chris Lattner1a7e43c2004-04-01 00:41:31 +000044infrastructure, release 1.3. Here we describe the status of LLVM, including any
John Criswell86a3a482003-12-18 16:43:17 +000045known problems and bug fixes from the previous release. The most up-to-date
Misha Brukman80731b92003-11-22 00:38:41 +000046version of this document can be found on the <a
Chris Lattner1a7e43c2004-04-01 00:41:31 +000047href="http://llvm.cs.uiuc.edu/releases/1.3/">LLVM 1.3 web site</a>. If you are
John Criswell86a3a482003-12-18 16:43:17 +000048not reading this on the LLVM web pages, you should probably go there because
Misha Brukman80731b92003-11-22 00:38:41 +000049this document may be updated after the release.</p>
Chris Lattner62495762003-10-02 16:38:05 +000050
Misha Brukman80731b92003-11-22 00:38:41 +000051<p>For more information about LLVM, including information about potentially more
Chris Lattnere7525b52003-10-07 21:38:31 +000052current releases, please check out the <a href="http://llvm.cs.uiuc.edu">main
53web site</a>. If you have questions or comments, the <a
54href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM developer's mailing
Misha Brukman80731b92003-11-22 00:38:41 +000055list</a> is a good place to send them.</p>
Chris Lattner3d482502003-10-02 04:57:28 +000056
Chris Lattnere76e9ab2003-12-12 04:25:33 +000057<p>Note that if you are reading this file from CVS, this document applies
58to the <i>next</i> release, not the current one. To see the release notes for
59the current or previous releases, see the <a
Misha Brukman80731b92003-11-22 00:38:41 +000060href="http://llvm.cs.uiuc.edu/releases/">releases page</a>.</p>
61
62</div>
Chris Lattner3d482502003-10-02 04:57:28 +000063
64<!-- *********************************************************************** -->
Misha Brukman80731b92003-11-22 00:38:41 +000065<div class="doc_section">
66 <a name="whatsnew">What's New?</a>
67</div>
Chris Lattner3d482502003-10-02 04:57:28 +000068<!-- *********************************************************************** -->
69
Misha Brukman80731b92003-11-22 00:38:41 +000070<div class="doc_text">
71
Misha Brukmanfa50a222004-05-12 21:46:05 +000072<p>This is the fourth public release of the LLVM compiler infrastructure. This
Chris Lattnerea309ff2004-05-04 17:04:09 +000073release primarily improves the <a href="#codequality">performance of the
Chris Lattnerb7c4bac2004-06-18 06:26:29 +000074code</a> produced by all aspects of the LLVM compiler and adds many <a
75href="#newfeatures">new features</a>, and <a href="#bugfix">fixes a few
Misha Brukmanfa50a222004-05-12 21:46:05 +000076bugs</a> as well.</p>
Chris Lattnerba7bd472003-12-06 20:22:41 +000077
Misha Brukmanfa50a222004-05-12 21:46:05 +000078<p> At this time, LLVM is known to correctly compile and run all C &amp; C++
79SPEC CPU2000 benchmarks, the Olden benchmarks, and the Ptrdist benchmarks. It
80has also been used to compile <b>many</b> other programs. LLVM now also works
81with a broad variety of C++ programs, though it has still received less testing
82than the C front-end.</p>
Chris Lattnerba7bd472003-12-06 20:22:41 +000083
Chris Lattner21a90402004-05-24 04:50:25 +000084</div>
85
Chris Lattnerba7bd472003-12-06 20:22:41 +000086<!--=========================================================================-->
87<div class="doc_subsubsection">
Chris Lattner8ebf2532004-02-25 16:36:51 +000088<a name="newfeatures">This release implements the following new features:</a>
Chris Lattnerba7bd472003-12-06 20:22:41 +000089</div>
Chris Lattnere7525b52003-10-07 21:38:31 +000090
Chris Lattner21a90402004-05-24 04:50:25 +000091<div class="doc_text">
92
Chris Lattnere7525b52003-10-07 21:38:31 +000093<ol>
Chris Lattner1a7e43c2004-04-01 00:41:31 +000094<li>The LLVM <a href="LangRef.html#i_select"><tt>select</tt></a> instruction is
Chris Lattner2ad48782004-05-02 04:19:15 +000095now fully implemented and supported by all transformations, native code
96generators, and the interpreter.</li>
Misha Brukman017f2f32004-04-19 02:56:49 +000097<li>Bugpoint can now narrow down code-generation bugs to a loop nest, where
98before it could only narrow them down to a function being miscompiled.</li>
Brian Gaekee307f8a72004-05-04 21:22:57 +000099<li><a href="http://llvm.cs.uiuc.edu/PR40">Bugpoint can now debug arbitrary
100modes of llc</a> and lli, by passing them command line flags (e.g.,
101<tt>-regalloc=linearscan</tt>, <tt>-enable-correct-eh-support</tt>, etc.) </li>
Chris Lattner2ad48782004-05-02 04:19:15 +0000102<li>The Control Flow Graph in the native code generators is no longer
103constrained to be the same as the CFG for the LLVM input code.</li>
104<li>The LLVM induction variable analysis routines have been rewritten.</li>
105<li>LLVM now has new loop unrolling and loop unswitching passes.</li>
106<li>The induction variable substitution pass performs linear function test
107replacement and exit value replacement optimizations.</li>
Misha Brukman0fdfcf12004-07-02 16:23:17 +0000108<li>LLVM now has first-class support for <a
109href="GarbageCollection.html">Accurate Garbage Collection</a>, enabling the use
110of aggressive copying and generational collectors.</li>
Chris Lattnereda4f472004-05-24 04:45:52 +0000111<li>LLVM now includes an implementation of Andersen's interprocedural alias
112analysis algorithm.</li>
Chris Lattner57e7a4c2004-05-24 05:34:32 +0000113<li>Bugpoint can <a href="http://llvm.cs.uiuc.edu/PR327">extract individual
114basic blocks</a> to track down reduce miscompilation testcases.</li>
Brian Gaeke84c8bd02004-06-01 20:02:56 +0000115<li>LLVM and the C front-end now work under Win32 using the
116<a href="http://www.cygwin.com">Cygwin</a> runtime libraries.
Chris Lattner2c7b0872004-06-01 18:22:41 +0000117This includes the JIT compiler.</li>
Misha Brukman0fdfcf12004-07-02 16:23:17 +0000118<li>The LLVM code generator is now being <a
119href="CodeGenerator.html">documented</a>.</li>
120<li>There is a new tool, llvm-bcanalyzer. This tool can compute basic
121statistics and bytecode density statistics on a module or function basis and
122also dump out bytecode in a textual format that is lower level than assembly
123(values are not resolved from slot numbers). It should only be of interest to
124(a) those who are working to improve the bytecode format and (b) those who
125really want to understand or document the details of the bytecode format.</li>
Chris Lattner3a3e5c42004-07-09 06:58:43 +0000126<li>The <a href="BytecodeFormat.html">LLVM Bytecode file format</a> is now
Misha Brukman0fdfcf12004-07-02 16:23:17 +0000127documented.</li>
128<li>LLVM now provides an <a
129href="LangRef.html#i_isunordered">llvm.isunordered</a> intrinsic for efficient
130implementation of unordered floating point comparisons.</li>
Chris Lattnerb7c4bac2004-06-18 06:26:29 +0000131<li>The llvmgcc front-end now supports the GCC builtins for ISO C99 floating
132point comparison macros (e.g., <tt>__builtin_islessequal</tt>).</li>
Reid Spencer3a4916e2004-06-23 06:33:15 +0000133<li>Now that there are more source files than can fit on a 32Kbyte command
134line (Linux's limit), there's a new utility for searching the sources. The
135llvmgrep tool in the utils directory combines an egrep and a find without
136passing filenames through the command line. This improves performance
137slightly. Simply run llvmgrep like you might egrep but leave off the file
138names.</li>
Misha Brukman0fdfcf12004-07-02 16:23:17 +0000139<li>We now generate HTML documentation and man pages for the tools from a single
140source (perl-style POD files).</li>
Chris Lattner47bafde2004-07-12 17:09:23 +0000141<li>The LLVM code generator can now dynamically load targets from shared
142objects.</li>
Chris Lattner592db402003-11-19 22:05:38 +0000143</ol>
Chris Lattner4491de62003-11-08 04:28:55 +0000144
Chris Lattner21a90402004-05-24 04:50:25 +0000145</div>
146
Chris Lattnerba7bd472003-12-06 20:22:41 +0000147
148<!--=========================================================================-->
149<div class="doc_subsubsection">
150In this release, the following missing features were implemented:
151</div>
Chris Lattner4491de62003-11-08 04:28:55 +0000152
Chris Lattner21a90402004-05-24 04:50:25 +0000153<div class="doc_text">
154
Chris Lattner4491de62003-11-08 04:28:55 +0000155<ol>
Misha Brukman017f2f32004-04-19 02:56:49 +0000156<li><a href="http://llvm.cs.uiuc.edu/PR82">LLVM cannot handle structures with
157more than 256 elements</a></li>
Misha Brukmane7050232004-04-19 03:01:01 +0000158<li><a href="http://llvm.cs.uiuc.edu/PR38">[bugpoint] External functions used in
159non-instruction entities, such as global constant initializer</a></li>
Reid Spencer45e25d82004-05-09 23:32:39 +0000160<li><a href="http://llvm.cs.uiuc.edu/PR178">Stacker does not handle targets
161with 64-bit pointers.</a></li>
Misha Brukmane7050232004-04-19 03:01:01 +0000162<li><a href="http://llvm.cs.uiuc.edu/PR290">Bugpoint doesn't support
163uses of external fns by immediate constant exprs</a></li>
Misha Brukman80731b92003-11-22 00:38:41 +0000164</ol>
Chris Lattnere7525b52003-10-07 21:38:31 +0000165
Chris Lattner21a90402004-05-24 04:50:25 +0000166</div>
Chris Lattnerba7bd472003-12-06 20:22:41 +0000167
168<!--=========================================================================-->
169<div class="doc_subsubsection">
Misha Brukman017f2f32004-04-19 02:56:49 +0000170<a name="qualityofimp">In this release, the following Quality of Implementation
171issues were fixed:</a>
Chris Lattner4df78f02003-12-20 03:42:11 +0000172</div>
173
Chris Lattner21a90402004-05-24 04:50:25 +0000174<div class="doc_text">
175
Chris Lattner4df78f02003-12-20 03:42:11 +0000176<ol>
Misha Brukman017f2f32004-04-19 02:56:49 +0000177<li><a href="http://llvm.cs.uiuc.edu/PR305">LLVM tools will happily spew
178bytecode onto your terminal</a></li>
Misha Brukmanfa50a222004-05-12 21:46:05 +0000179<li><a href="http://llvm.cs.uiuc.edu/PR329">[llvmgcc] type names are not emitted
180for structure typedefs</a></li>
Chris Lattnerf10ccbf2004-05-24 04:53:32 +0000181<li>All documentation is now conformant to the HTML 4.01 (Strict) level.</li>
Chris Lattnerbd948cf2004-06-08 07:19:29 +0000182<li>The spurious "WARNING: Found global types that are not compatible" warning
183produced when linking C++ programs has been fixed.</li>
Reid Spencer66522522004-07-07 21:06:28 +0000184<li><a href="http://llvm.cs.uiuc.edu/PR391">lli Doesn't Handle Exceptions From
185Bytecode Reader</a></li>
Chris Lattnera4d8ce62004-07-15 02:59:24 +0000186<li><a href="http://llvm.cs.uiuc.edu/PR341">operator&lt;&lt; on a Value* now prints the address of the object instead of its contents.</a></li>
Chris Lattner4df78f02003-12-20 03:42:11 +0000187</ol>
188
Chris Lattner21a90402004-05-24 04:50:25 +0000189</div>
190
Chris Lattner4df78f02003-12-20 03:42:11 +0000191<!--=========================================================================-->
192<div class="doc_subsubsection">
Chris Lattner8ebf2532004-02-25 16:36:51 +0000193In this release, the following build problems were fixed:
Brian Gaeke8b05e4f2004-01-16 21:55:04 +0000194</div>
195
Chris Lattner21a90402004-05-24 04:50:25 +0000196<div class="doc_text">
Brian Gaeke8b05e4f2004-01-16 21:55:04 +0000197<ol>
Misha Brukmanfa50a222004-05-12 21:46:05 +0000198<li><a href="http://llvm.cs.uiuc.edu/PR301">Minor configure bugs with
199-disable/enable-povray and -disable-spec</a></li>
200<li><a href="http://llvm.cs.uiuc.edu/PR289">shell scripts output by gccld don't
201work if you change PATH</a></li>
Chris Lattner47696122004-06-09 01:09:16 +0000202<li><a href="http://llvm.cs.uiuc.edu/PR364">[llvmgcc] llvmgcc does not compile
203with gcc 3.4</a></li>
Chris Lattner3daf9842004-06-18 17:57:29 +0000204<li><a href="http://llvm.cs.uiuc.edu/PR373">[llvmgcc] obstack.h relies on
205obsolete casts-as-lvalues GCC extension</a></li>
Brian Gaeke8b05e4f2004-01-16 21:55:04 +0000206</ol>
Chris Lattner21a90402004-05-24 04:50:25 +0000207</div>
Brian Gaeke8b05e4f2004-01-16 21:55:04 +0000208
209<!--=========================================================================-->
210<div class="doc_subsubsection">
Chris Lattner2ad48782004-05-02 04:19:15 +0000211<a name="codequality">This release includes the following Code Quality
212improvements:</a>
Chris Lattner23257062004-05-23 20:42:08 +0000213</div>
Chris Lattner639579c2003-10-27 17:06:39 +0000214
Chris Lattner21a90402004-05-24 04:50:25 +0000215<div class="doc_text">
Chris Lattner639579c2003-10-27 17:06:39 +0000216<ol>
Chris Lattner2ad48782004-05-02 04:19:15 +0000217<li>Fixed: <a href="http://llvm.cs.uiuc.edu/PR309">[vmcore] Code quality problem
218due to long operand of getelementptr</a></li>
Chris Lattner54dcea82004-04-13 14:43:35 +0000219
220<li>The X86 backend now generates substantially better code for 64-bit integer
221and floating point operations.</li>
222
223<li>The -inline pass no longer inlines mutually recursive functions until it
224hits the inlining threshold.</li>
225
226<li>The -inline pass no longer misses obvious inlining opportunities just
227because the callee eventually calls into an external function.</li>
228
229<li>The -simplifycfg pass can now "if convert" simple statements into the new
230<tt>select</tt> instruction.</li>
231
232<li>The -loopsimplify pass can now break <a
233href="http://llvm.cs.uiuc.edu/PR35">natural loops with multiple backedges</a>
234into multiple nested loops. This enables a variety of subsequent
235optimizations.</li>
236
237<li>The -adce pass can now eliminate calls to functions that do not not write to
238memory.</li>
239
240<li>The link-time optimizer now runs the -prune-eh pass (to remove unused
Chris Lattnerea309ff2004-05-04 17:04:09 +0000241exception handlers).</li>
Chris Lattner54dcea82004-04-13 14:43:35 +0000242
Chris Lattner2ad48782004-05-02 04:19:15 +0000243<li>The -simplifycfg pass can now eliminate simple correlated branches (such as
244"<tt>if (A &lt; B &amp;&amp; A &lt; B)</tt>", and can turn short-circuiting
245operators into the strict versions when useful (such as "<tt>if (A &lt; B || A
246&gt; C)</tt>" into "<tt>if (A &lt; B | A &gt; C)</tt>"</li>
247
Chris Lattnerea309ff2004-05-04 17:04:09 +0000248<li>LLVM now has infrastructure for (simple and sparse conditional) constant
249propagation of function calls. It currently supports a few math library
250functions like sqrt/sin/cos/etc.</li>
Chris Lattner249b3552004-06-03 22:35:13 +0000251
252<li>The C backend now emits <a href="http://llvm.cs.uiuc.edu/PR334">Syntactic
253loops</a> in the code to help C compilers whose optimizers do not recognize
254loops formed from gotos (like GCC).</li>
Brian Gaeke522235e2004-06-11 02:15:39 +0000255
256<li>Fixed: <a href="http://llvm.cs.uiuc.edu/PR368">[sparcv9] null
257often spilled to constant pool</a>.</li>
Misha Brukman80731b92003-11-22 00:38:41 +0000258</ol>
Reid Spencer3e58f582004-05-23 17:23:13 +0000259</div>
Chris Lattnerba7bd472003-12-06 20:22:41 +0000260
261<!--=========================================================================-->
262<div class="doc_subsubsection">
Misha Brukman017f2f32004-04-19 02:56:49 +0000263<a name="bugfix">In this release, the following bugs in the previous release
264were fixed:</a>
Chris Lattnerba7bd472003-12-06 20:22:41 +0000265</div>
266
Chris Lattner21a90402004-05-24 04:50:25 +0000267<div class="doc_text">
268
Chris Lattnerba7bd472003-12-06 20:22:41 +0000269<p>Bugs in the LLVM Core:</p>
Chris Lattnere7525b52003-10-07 21:38:31 +0000270
271<ol>
Misha Brukman017f2f32004-04-19 02:56:49 +0000272<li><a href="http://llvm.cs.uiuc.edu/PR306">[loopsimplify] Loop simplify
273incorrectly updates dominator information</a></li>
274<li><a href="http://llvm.cs.uiuc.edu/PR310">[tailduplicate] DemoteRegToStack
275breaks SSA form</a></li>
276<li><a href="http://llvm.cs.uiuc.edu/PR313">[X86] JIT miscompiles unsigned short
277to floating point cast</a></li>
Reid Spencerb1076c42004-06-29 23:39:24 +0000278<li><a href="http://llvm.cs.uiuc.edu/PR315">[jit] abort, don't warn, when
279missing external functions encountered</a></li>
280<li><a href="http://llvm.cs.uiuc.edu/PR330">[vmcore] Linker causes erroneous
281asssertion</a></li>
Misha Brukmanfa50a222004-05-12 21:46:05 +0000282<li><a href="http://llvm.cs.uiuc.edu/PR332">[adce] Crash handling unreachable
283code that unwinds</a></li>
Misha Brukmana516e992004-07-12 16:55:41 +0000284<li><a href="http://llvm.cs.uiuc.edu/PR333">[sparcv9] LLC can't emit 2 functions
Misha Brukmanfa50a222004-05-12 21:46:05 +0000285of the same name, both having constant pools</a></li>
286<li><a href="http://llvm.cs.uiuc.edu/PR337">[livevar] Live variables missed
287physical register use of aliased definition</a></li>
Reid Spencerb1076c42004-06-29 23:39:24 +0000288<li><a href="http://llvm.cs.uiuc.edu/PR340">Verifier misses malformed switch
289instruction</a></li>
290<li><a href="http://llvm.cs.uiuc.edu/PR365">[asmwriter] Asm writer aborts if
291an instruction is not embedded into a function</a></li>
292<li><a href="http://llvm.cs.uiuc.edu/PR369">[X86] stackifier crash on floating
293point setcc X, X</a></li>
Chris Lattnerba7bd472003-12-06 20:22:41 +0000294</ol>
295
Chris Lattnerba7bd472003-12-06 20:22:41 +0000296<p>Bugs in the C/C++ front-end:</p>
297
298<ol>
Misha Brukmanfa50a222004-05-12 21:46:05 +0000299<li><a href="http://llvm.cs.uiuc.edu/PR298">[llvmgcc] Variable length array
300indexing miscompiled</a></li>
Reid Spencerb1076c42004-06-29 23:39:24 +0000301<li><a href="http://llvm.cs.uiuc.edu/PR326">[llvmgcc] Crash on use of undeclared
302enum type</a></li>
Chris Lattner2ef024b2004-06-19 01:11:02 +0000303<li><a href="http://llvm.cs.uiuc.edu/PR355">[llvmgcc] Errors handling function
304prototypes that take opaque structs by-value</a></li>
305<li><a href="http://llvm.cs.uiuc.edu/PR374">[llvmgcc] Crash compiling variable
306length array of structures</a></li>
Misha Brukman0fdfcf12004-07-02 16:23:17 +0000307<li><a href="http://llvm.cs.uiuc.edu/PR377">[llvmgcc] miscompilation of staticly
Reid Spencerb1076c42004-06-29 23:39:24 +0000308initialized unsigned bitfields</a></li>
Chris Lattnere5497172004-07-07 02:25:24 +0000309<li><a href="http://llvm.cs.uiuc.edu/PR396">[llvm-gcc] Crash casting function to void</a></li>
Chris Lattnerba7bd472003-12-06 20:22:41 +0000310</ol>
Chris Lattner21a90402004-05-24 04:50:25 +0000311</div>
Reid Spencer3e58f582004-05-23 17:23:13 +0000312
Chris Lattner62495762003-10-02 16:38:05 +0000313<!-- *********************************************************************** -->
Misha Brukman80731b92003-11-22 00:38:41 +0000314<div class="doc_section">
315 <a name="portability">Portability and Supported Platforms</a>
316</div>
Chris Lattner62495762003-10-02 16:38:05 +0000317<!-- *********************************************************************** -->
318
Misha Brukman80731b92003-11-22 00:38:41 +0000319<div class="doc_text">
320
Chris Lattner2c7b0872004-06-01 18:22:41 +0000321<p>LLVM is known to work in the following platforms:</p>
322
323<ul>
324<li>Intel and AMD machines running Red Hat Linux and FreeBSD (and probably
325 other unix-like systems).</li>
326<li>Sun UltraSPARC workstations running Solaris 8.</li>
327<li>PowerPC-based Mac OS X boxes, running 10.3 and above (C backend and
328 interpreter only, no native codegen is available yet).</li>
329<li>Intel and AMD machines running on Win32 with the Cygwin libraries.</li>
330</ul>
331
Brian Gaekee3e557e2004-05-09 05:28:35 +0000332
333<p>The core LLVM infrastructure uses
334<a href="http://www.gnu.org/software/autoconf/">GNU autoconf</a> to adapt itself
335to the machine and operating system on which it is built. However, minor
336porting may be required to get LLVM to work on new platforms. We welcome your
337portability patches and reports of successful builds or error messages.</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000338
Chris Lattner2c7b0872004-06-01 18:22:41 +0000339<p>Note that the LLVM build system does not currently support directories with
340spaces on them when running on Win32/cygwin. We strongly recommend running
341LLVM and the C frontend out of a top-level directory without spaces (e.g.,
Chris Lattnerce1a3842004-06-01 19:41:30 +0000342<tt>/cygdrive/c/llvm</tt>). Also, make sure to install <b>all</b> of the
343cygwin packages. By default, many important tools are not installed that
344are needed by the LLVM build process or test suite (e.g., /bin/time).</p>
Chris Lattner2c7b0872004-06-01 18:22:41 +0000345
Misha Brukman80731b92003-11-22 00:38:41 +0000346</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000347
Brian Gaeke86a6c752004-04-20 18:18:46 +0000348<!--=========================================================================-->
349<div class="doc_subsection">
350In this release, the following portability problems were fixed:
351</div>
352
Chris Lattner21a90402004-05-24 04:50:25 +0000353<div class="doc_text">
354
Brian Gaeke86a6c752004-04-20 18:18:46 +0000355<ol>
Misha Brukmanfa50a222004-05-12 21:46:05 +0000356<li><a href="http://llvm.cs.uiuc.edu/PR304">warnings compiling Stacker compiler
357on Mac OS X</a></li>
358<li><a href="http://llvm.cs.uiuc.edu/PR308">Archive file reader doesn't
359understand abbreviated names in headers</a></li>
Brian Gaeke86a6c752004-04-20 18:18:46 +0000360</ol>
361
Chris Lattner21a90402004-05-24 04:50:25 +0000362</div>
363
Chris Lattner3d482502003-10-02 04:57:28 +0000364<!-- *********************************************************************** -->
Misha Brukman80731b92003-11-22 00:38:41 +0000365<div class="doc_section">
366 <a name="knownproblems">Known Problems</a>
367</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000368<!-- *********************************************************************** -->
369
Misha Brukman80731b92003-11-22 00:38:41 +0000370<div class="doc_text">
371
372<p>This section contains all known problems with the LLVM system, listed by
Chris Lattner3d482502003-10-02 04:57:28 +0000373component. As new problems are discovered, they will be added to these
Chris Lattnerb84f3322003-12-12 21:22:16 +0000374sections. If you run into a problem, please check the <a
John Criswell86a3a482003-12-18 16:43:17 +0000375href="http://llvm.cs.uiuc.edu/bugs/">LLVM bug database</a> and submit a bug if
Chris Lattnerb84f3322003-12-12 21:22:16 +0000376there isn't already one.</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000377
Misha Brukman80731b92003-11-22 00:38:41 +0000378</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000379
Chris Lattnerb911de42004-03-14 02:03:02 +0000380<!-- ======================================================================= -->
381<div class="doc_subsection">
382 <a name="experimental">Experimental features included with this release</a>
383</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000384
Chris Lattnerb911de42004-03-14 02:03:02 +0000385<div class="doc_text">
386
Misha Brukmanfa50a222004-05-12 21:46:05 +0000387<p>The following components of this LLVM release are either untested, known to
388be broken or unreliable, or are in early development. These components should
389not be relied on, and bugs should not be filed against them, but they may be
390useful to some people. In particular, if you would like to work on one of these
391components, please contact us on the llvmdev list.</p>
Chris Lattnerb911de42004-03-14 02:03:02 +0000392
393<ul>
394<li>The following passes are incomplete or buggy: <tt>-pgmdep, -memdep,
Chris Lattner99583502004-06-28 00:44:45 +0000395 -ipmodref, -cee</tt></li>
Chris Lattnerb911de42004-03-14 02:03:02 +0000396
397<li>The <tt>-pre</tt> pass is incomplete (there are cases it doesn't handle that
398 it should) and not thoroughly tested.</li>
399<li>The <tt>llvm-ar</tt> tool is incomplete and probably buggy.</li>
400<li>The <tt>llvm-db</tt> tool is in a very early stage of development.</li>
401</ul>
402
403</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000404
Misha Brukman80731b92003-11-22 00:38:41 +0000405<!-- ======================================================================= -->
406<div class="doc_subsection">
407 <a name="core">Known problems with the LLVM Core</a>
408</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000409
Misha Brukman80731b92003-11-22 00:38:41 +0000410<div class="doc_text">
411
412<ul>
413
414<li>In the JIT, <tt>dlsym</tt> on a symbol compiled by the JIT will not
415work.</li>
Chris Lattner3d482502003-10-02 04:57:28 +0000416
417<li>The JIT does not use mutexes to protect its internal data structures. As
Misha Brukman80731b92003-11-22 00:38:41 +0000418such, execution of a threaded program could cause these data structures to be
419corrupted.</li>
Chris Lattner3d482502003-10-02 04:57:28 +0000420
Misha Brukman80731b92003-11-22 00:38:41 +0000421<li>It is not possible to <tt>dlopen</tt> an LLVM bytecode file in the JIT.</li>
Chris Lattner3d482502003-10-02 04:57:28 +0000422
Chris Lattnera623e482003-10-20 19:05:03 +0000423<li>Linking in static archive files (.a files) is very slow (there is no symbol
Misha Brukman80731b92003-11-22 00:38:41 +0000424table in the archive).</li>
Chris Lattnerc679fbb2003-11-04 20:06:53 +0000425
Misha Brukman017f2f32004-04-19 02:56:49 +0000426<li>The gccld program <a href="http://llvm.cs.uiuc.edu/PR139">does not link
427objects/archives in the order specified on the command line.</a></li>
Chris Lattneraebc66a2004-02-15 23:09:07 +0000428
429<li><a href="http://llvm.cs.uiuc.edu/PR240">The lower-invoke pass does not mark
John Criswell5d6345a2004-03-12 21:29:42 +0000430values live across a setjmp as volatile</a>. This missing feature only affects
Chris Lattneraebc66a2004-02-15 23:09:07 +0000431targets whose setjmp/longjmp libraries do not save and restore the entire
432register file.</li>
Misha Brukman80731b92003-11-22 00:38:41 +0000433</ul>
Misha Brukman80731b92003-11-22 00:38:41 +0000434</div>
435
436<!-- ======================================================================= -->
437<div class="doc_subsection">
438 <a name="c-fe">Known problems with the C front-end</a>
439</div>
Chris Lattner178f3db2003-10-02 05:07:23 +0000440
Chris Lattner3d482502003-10-02 04:57:28 +0000441<!-- _______________________________________________________________________ -->
Chris Lattner5a8a7282003-12-14 05:03:43 +0000442<div class="doc_subsubsection">Bugs</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000443
Misha Brukman80731b92003-11-22 00:38:41 +0000444<div class="doc_text">
Misha Brukman80731b92003-11-22 00:38:41 +0000445<ul>
Chris Lattner3d482502003-10-02 04:57:28 +0000446<li>C99 Variable sized arrays do not release stack memory when they go out of
447 scope. Thus, the following program may run out of stack space:
448<pre>
449 for (i = 0; i != 1000000; ++i) {
450 int X[n];
451 foo(X);
452 }
Misha Brukman80731b92003-11-22 00:38:41 +0000453</pre></li>
Chris Lattner3d482502003-10-02 04:57:28 +0000454
Misha Brukmanfa50a222004-05-12 21:46:05 +0000455<li>Initialization of global union variables can only be done <a
456href="http://llvm.cs.uiuc.edu/bugs/show_bug.cgi?id=162">with the largest union
457member</a>.</li>
Chris Lattner1ab58dd2004-03-16 21:39:04 +0000458
Misha Brukman017f2f32004-04-19 02:56:49 +0000459<li><a href="http://llvm.cs.uiuc.edu/PR244">[llvm-gcc] Error when an implicitly
460external function is re-declared as static</a></li>
Chris Lattner1ab58dd2004-03-16 21:39:04 +0000461
John Criswell86a3a482003-12-18 16:43:17 +0000462</ul>
Misha Brukman80731b92003-11-22 00:38:41 +0000463</div>
464
465<!-- _______________________________________________________________________ -->
466<div class="doc_subsubsection">
467 Notes
468</div>
469
470<div class="doc_text">
471
472<ul>
473
474<li>Inline assembly is not yet supported.</li>
Chris Lattnerd2a74272003-10-27 18:30:37 +0000475
476<li>"long double" is transformed by the front-end into "double". There is no
Misha Brukman80731b92003-11-22 00:38:41 +0000477support for floating point data types of any size other than 32 and 64
478bits.</li>
479
480<li>The following Unix system functionality has not been tested and may not
481work:
Misha Brukman7cb4e382003-11-22 01:00:11 +0000482 <ol>
483 <li><tt>sigsetjmp</tt>, <tt>siglongjmp</tt> - These are not turned into the
484 appropriate <tt>invoke</tt>/<tt>unwind</tt> instructions. Note that
485 <tt>setjmp</tt> and <tt>longjmp</tt> <em>are</em> compiled correctly.
486 <li><tt>getcontext</tt>, <tt>setcontext</tt>, <tt>makecontext</tt>
487 - These functions have not been tested.
488 </ol></li>
Chris Lattner3d482502003-10-02 04:57:28 +0000489
490<li>Although many GCC extensions are supported, some are not. In particular,
491 the following extensions are known to <b>not be</b> supported:
492 <ol>
Misha Brukman80731b92003-11-22 00:38:41 +0000493 <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 +0000494 <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>
495 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Constructing-Calls.html#Constructing%20Calls">Constructing Calls</a>: Dispatching a call to another function.</li>
496 <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 +0000497 <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 +0000498 <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>
499 <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 +0000500 <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>
501 <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>
502 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Thread-Local.html#Thread-Local">Thread-Local</a>: Per-thread variables.</li>
503 <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 +0000504 </ol>
Chris Lattner3d482502003-10-02 04:57:28 +0000505
Misha Brukman80731b92003-11-22 00:38:41 +0000506 <p>The following GCC extensions are <b>partially</b> supported. An ignored
Chris Lattner3d482502003-10-02 04:57:28 +0000507 attribute means that the LLVM compiler ignores the presence of the attribute,
508 but the code should still work. An unsupported attribute is one which is
John Criswell86a3a482003-12-18 16:43:17 +0000509 ignored by the LLVM compiler and will cause a different interpretation of
Misha Brukman80731b92003-11-22 00:38:41 +0000510 the program.</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000511
512 <ol>
513 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Length.html#Variable%20Length">Variable Length</a>:
514 Arrays whose length is computed at run time.<br>
Misha Brukman80731b92003-11-22 00:38:41 +0000515 Supported, but allocated stack space is not freed until the function returns (noted above).</li>
Chris Lattner3d482502003-10-02 04:57:28 +0000516
517 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Attributes.html#Function%20Attributes">Function Attributes</a>:
Misha Brukman80731b92003-11-22 00:38:41 +0000518
John Criswell86a3a482003-12-18 16:43:17 +0000519 Declaring that functions have no side effects or that they can never
Misha Brukman80731b92003-11-22 00:38:41 +0000520 return.<br>
521
522 <b>Supported:</b> <tt>format</tt>, <tt>format_arg</tt>, <tt>non_null</tt>,
523 <tt>constructor</tt>, <tt>destructor</tt>, <tt>unused</tt>,
524 <tt>deprecated</tt>, <tt>warn_unused_result</tt>, <tt>weak</tt><br>
525
526 <b>Ignored:</b> <tt>noreturn</tt>, <tt>noinline</tt>,
527 <tt>always_inline</tt>, <tt>pure</tt>, <tt>const</tt>, <tt>nothrow</tt>,
528 <tt>malloc</tt>, <tt>no_instrument_function</tt>, <tt>cdecl</tt><br>
529
530 <b>Unsupported:</b> <tt>used</tt>, <tt>section</tt>, <tt>alias</tt>,
531 <tt>visibility</tt>, <tt>regparm</tt>, <tt>stdcall</tt>,
532 <tt>fastcall</tt>, all other target specific attributes</li>
Chris Lattner3d482502003-10-02 04:57:28 +0000533
534 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Attributes.html#Variable%20Attributes">Variable Attributes</a>:
535 Specifying attributes of variables.<br>
536 <b>Supported:</b> <tt>cleanup</tt>, <tt>common</tt>, <tt>nocommon</tt>,
537 <tt>deprecated</tt>, <tt>transparent_union</tt>,
538 <tt>unused</tt>, <tt>weak</tt><br>
Misha Brukman80731b92003-11-22 00:38:41 +0000539
Chris Lattner3d482502003-10-02 04:57:28 +0000540 <b>Unsupported:</b> <tt>aligned</tt>, <tt>mode</tt>, <tt>packed</tt>,
541 <tt>section</tt>, <tt>shared</tt>, <tt>tls_model</tt>,
542 <tt>vector_size</tt>, <tt>dllimport</tt>,
Misha Brukman80731b92003-11-22 00:38:41 +0000543 <tt>dllexport</tt>, all target specific attributes.</li>
Chris Lattner3d482502003-10-02 04:57:28 +0000544
Misha Brukman8395d732003-12-12 04:37:31 +0000545 <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 +0000546 <b>Supported:</b> <tt>transparent_union</tt>, <tt>unused</tt>,
Misha Brukman8395d732003-12-12 04:37:31 +0000547 <tt>deprecated</tt>, <tt>may_alias</tt><br>
Misha Brukman80731b92003-11-22 00:38:41 +0000548
549 <b>Unsupported:</b> <tt>aligned</tt>, <tt>packed</tt>,
550 all target specific attributes.</li>
551
Chris Lattner3d482502003-10-02 04:57:28 +0000552 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Other-Builtins.html#Other%20Builtins">Other Builtins</a>:
553 Other built-in functions.<br>
554 We support all builtins which have a C language equivalent (e.g.,
555 <tt>__builtin_cos</tt>), <tt>__builtin_alloca</tt>,
556 <tt>__builtin_types_compatible_p</tt>, <tt>__builtin_choose_expr</tt>,
Chris Lattnerb7c4bac2004-06-18 06:26:29 +0000557 <tt>__builtin_constant_p</tt>, and <tt>__builtin_expect</tt>
558 (currently ignored). We also support builtins for ISO C99 floating
559 point comparison macros (e.g., <tt>__builtin_islessequal</tt>).</li>
Misha Brukman80731b92003-11-22 00:38:41 +0000560 </ol>
Chris Lattner3d482502003-10-02 04:57:28 +0000561
Misha Brukman80731b92003-11-22 00:38:41 +0000562 <p>The following extensions <b>are</b> known to be supported:</p>
563
Chris Lattner3d482502003-10-02 04:57:28 +0000564 <ol>
Chris Lattnerd3dc8502004-03-16 08:54:07 +0000565 <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 +0000566 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Statement-Exprs.html#Statement%20Exprs">Statement Exprs</a>: Putting statements and declarations inside expressions.</li>
567 <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 +0000568 <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 +0000569 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Conditionals.html#Conditionals">Conditionals</a>: Omitting the middle operand of a <code>?:</code> expression.</li>
570 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Long-Long.html#Long%20Long">Long Long</a>: Double-word integers.</li>
571 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Complex.html#Complex">Complex</a>: Data types for complex numbers.</li>
572 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Hex-Floats.html#Hex%20Floats">Hex Floats</a>:Hexadecimal floating-point constants.</li>
573 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Zero-Length.html#Zero%20Length">Zero Length</a>: Zero-length arrays.</li>
574 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Empty-Structures.html#Empty%20Structures">Empty Structures</a>: Structures with no members.</li>
575 <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>
576 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Escaped-Newlines.html#Escaped%20Newlines">Escaped Newlines</a>: Slightly looser rules for escaped newlines.</li>
577 <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 +0000578 <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 +0000579 <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 +0000580 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Compound-Literals.html#Compound%20Literals">Compound Literals</a>: Compound literals give structures, unions,
581or arrays as values.</li>
Misha Brukman80731b92003-11-22 00:38:41 +0000582 <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 +0000583 <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 +0000584 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Case-Ranges.html#Case%20Ranges">Case Ranges</a>: `case 1 ... 9' and such.</li>
585 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Mixed-Declarations.html#Mixed%20Declarations">Mixed Declarations</a>: Mixing declarations and code.</li>
586 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Prototypes.html#Function%20Prototypes">Function Prototypes</a>: Prototype declarations and old-style definitions.</li>
587 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/C---Comments.html#C++%20Comments">C++ Comments</a>: C++ comments are recognized.</li>
588 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Dollar-Signs.html#Dollar%20Signs">Dollar Signs</a>: Dollar sign is allowed in identifiers.</li>
589 <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>
590 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Alignment.html#Alignment">Alignment</a>: Inquiring about the alignment of a type or variable.</li>
591 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Inline.html#Inline">Inline</a>: Defining inline functions (as fast as macros).</li>
592 <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>
593 <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>
594 <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 +0000595 <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 +0000596 <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>
597 <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 +0000598 </ol></li>
599
600</ul>
Chris Lattner3d482502003-10-02 04:57:28 +0000601
Misha Brukman80731b92003-11-22 00:38:41 +0000602<p>If you run into GCC extensions which have not been included in any of these
603lists, please let us know (also including whether or not they work).</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000604
Misha Brukman80731b92003-11-22 00:38:41 +0000605</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000606
Misha Brukman80731b92003-11-22 00:38:41 +0000607<!-- ======================================================================= -->
608<div class="doc_subsection">
609 <a name="c++-fe">Known problems with the C++ front-end</a>
610</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000611
Misha Brukman80731b92003-11-22 00:38:41 +0000612<div class="doc_text">
613
John Criswell86a3a482003-12-18 16:43:17 +0000614<p>For this release, the C++ front-end is considered to be fully functional but
Chris Lattnere76e9ab2003-12-12 04:25:33 +0000615has not been tested as thoroughly as the C front-end. It has been tested and
616works for a number of non-trivial programs, but there may be lurking bugs.
617Please report any bugs or problems.</p>
Misha Brukman80731b92003-11-22 00:38:41 +0000618
619</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000620
621<!-- _______________________________________________________________________ -->
Chris Lattner141ebb62004-02-14 04:12:41 +0000622<div class="doc_subsubsection">Bugs</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000623
Misha Brukman80731b92003-11-22 00:38:41 +0000624<div class="doc_text">
Chris Lattner3d482502003-10-02 04:57:28 +0000625
Misha Brukman80731b92003-11-22 00:38:41 +0000626<ul>
Chris Lattner3d482502003-10-02 04:57:28 +0000627<li>The C++ front-end inherits all problems afflicting the <a href="#c-fe">C
John Criswell86a3a482003-12-18 16:43:17 +0000628 front-end</a>.</li>
John Criswell86a3a482003-12-18 16:43:17 +0000629</ul>
Misha Brukman80731b92003-11-22 00:38:41 +0000630</div>
631
632<!-- _______________________________________________________________________ -->
633<div class="doc_subsubsection">
634 Notes
635</div>
636
637<div class="doc_text">
638
639<ul>
Chris Lattnerd2a74272003-10-27 18:30:37 +0000640
Chris Lattner3d482502003-10-02 04:57:28 +0000641<li>The C++ front-end is based on a pre-release of the GCC 3.4 C++ parser. This
642parser is significantly more standards compliant (and picky) than prior GCC
643versions. For more information, see the C++ section of the <a
Chris Lattnere76e9ab2003-12-12 04:25:33 +0000644href="http://gcc.gnu.org/gcc-3.4/changes.html">GCC 3.4 release notes</a>.</li>
Chris Lattner3d482502003-10-02 04:57:28 +0000645
646<li>Destructors for local objects are not always run when a <tt>longjmp</tt> is
Chris Lattner62495762003-10-02 16:38:05 +0000647 performed. In particular, destructors for objects in the <tt>longjmp</tt>ing
Chris Lattner3d482502003-10-02 04:57:28 +0000648 function and in the <tt>setjmp</tt> receiver function may not be run.
John Criswell86a3a482003-12-18 16:43:17 +0000649 Objects in intervening stack frames will be destroyed, however (which is
Misha Brukman80731b92003-11-22 00:38:41 +0000650 better than most compilers).</li>
Chris Lattner3d482502003-10-02 04:57:28 +0000651
Chris Lattner62495762003-10-02 16:38:05 +0000652<li>The LLVM C++ front-end follows the <a
653 href="http://www.codesourcery.com/cxx-abi">Itanium C++ ABI</a>.
654 This document, which is not Itanium specific, specifies a standard for name
655 mangling, class layout, v-table layout, RTTI formats, and other C++
656 representation issues. Because we use this API, code generated by the LLVM
657 compilers should be binary compatible with machine code generated by other
658 Itanium ABI C++ compilers (such as G++, the Intel and HP compilers, etc).
659 <i>However</i>, the exception handling mechanism used by LLVM is very
660 different from the model used in the Itanium ABI, so <b>exceptions will not
Misha Brukman80731b92003-11-22 00:38:41 +0000661 interact correctly</b>. </li>
Chris Lattner3d482502003-10-02 04:57:28 +0000662
Misha Brukman80731b92003-11-22 00:38:41 +0000663</ul>
Chris Lattner46ecf612003-10-07 22:14:37 +0000664
Misha Brukman80731b92003-11-22 00:38:41 +0000665</div>
666
667<!-- ======================================================================= -->
668<div class="doc_subsection">
669 <a name="x86-be">Known problems with the X86 back-end</a>
670</div>
671
672<div class="doc_text">
673
674<ul>
Reid Spencer006b3862004-06-19 18:24:05 +0000675 <li>Optimized (Release) versions of LLVM built with GCC 3.3.2 or 3.3.3 will
676 produce an llc tool that always enters an infinite loop due to what
677 appears to be an optimization bug (-O2 and -O3) in those versions of GCC.
678 This problem does not happen in GCC 3.3.1 nor GCC 3.4.0 nor does it happen if
679 you build a Debug version of LLVM. You are cautioned not to use GCC 3.3.2 or
680 GCC 3.3.3 to build Optimized versions of LLVM. It is unclear whether this problem
681 affects other backends but it is unlikely.</li>
Misha Brukman80731b92003-11-22 00:38:41 +0000682</ul>
Chris Lattner3d482502003-10-02 04:57:28 +0000683
Misha Brukman80731b92003-11-22 00:38:41 +0000684</div>
685
686<!-- ======================================================================= -->
687<div class="doc_subsection">
Misha Brukmana516e992004-07-12 16:55:41 +0000688 <a name="sparcv9-be">Known problems with the SparcV9 back-end</a>
Misha Brukman80731b92003-11-22 00:38:41 +0000689</div>
690
691<div class="doc_text">
692
693<ul>
Misha Brukmana516e992004-07-12 16:55:41 +0000694<li><a href="http://llvm.cs.uiuc.edu/PR60">[sparcv9] SparcV9 backend miscompiles
695several programs in the LLVM test suite</a></li>
Misha Brukman80731b92003-11-22 00:38:41 +0000696</ul>
Chris Lattner3d482502003-10-02 04:57:28 +0000697
Misha Brukman80731b92003-11-22 00:38:41 +0000698</div>
699
700<!-- ======================================================================= -->
701<div class="doc_subsection">
702 <a name="c-be">Known problems with the C back-end</a>
703</div>
704
705<div class="doc_text">
706
707<ul>
Chris Lattner3d482502003-10-02 04:57:28 +0000708
709<li>The C back-end produces code that violates the ANSI C Type-Based Alias
710Analysis rules. As such, special options may be necessary to compile the code
711(for example, GCC requires the <tt>-fno-strict-aliasing</tt> option). This
Misha Brukman80731b92003-11-22 00:38:41 +0000712problem probably cannot be fixed.</li>
Chris Lattner3d482502003-10-02 04:57:28 +0000713
Chris Lattnera623e482003-10-20 19:05:03 +0000714<li><a href="http://llvm.cs.uiuc.edu/PR33">Initializers for global variables</a>
Misha Brukman80731b92003-11-22 00:38:41 +0000715cannot include special floating point numbers like Not-A-Number or
716Infinity.</li>
Chris Lattner3d482502003-10-02 04:57:28 +0000717
Chris Lattnerc679fbb2003-11-04 20:06:53 +0000718<li><a href="http://llvm.cs.uiuc.edu/PR56">Zero arg vararg functions are not
Chris Lattnerb28c3282003-10-24 04:03:19 +0000719supported</a>. This should not affect LLVM produced by the C or C++
Misha Brukman80731b92003-11-22 00:38:41 +0000720frontends.</li>
Chris Lattnerb28c3282003-10-24 04:03:19 +0000721
Misha Brukman80731b92003-11-22 00:38:41 +0000722</ul>
Chris Lattner3d482502003-10-02 04:57:28 +0000723
Misha Brukman80731b92003-11-22 00:38:41 +0000724</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000725
726<!-- *********************************************************************** -->
Misha Brukman80731b92003-11-22 00:38:41 +0000727<div class="doc_section">
728 <a name="additionalinfo">Additional Information</a>
729</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000730<!-- *********************************************************************** -->
731
Misha Brukman80731b92003-11-22 00:38:41 +0000732<div class="doc_text">
733
734<p>A wide variety of additional information is available on the LLVM web page,
John Criswell86a3a482003-12-18 16:43:17 +0000735including mailing lists and publications describing algorithms and components
Chris Lattner3d482502003-10-02 04:57:28 +0000736implemented in LLVM. The web page also contains versions of the API
737documentation which is up-to-date with the CVS version of the source code. You
738can access versions of these documents specific to this release by going into
Misha Brukman80731b92003-11-22 00:38:41 +0000739the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000740
Misha Brukman80731b92003-11-22 00:38:41 +0000741<p>If you have any questions or comments about LLVM, please feel free to contact
Chris Lattnerb84f3322003-12-12 21:22:16 +0000742us via the <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">mailing
743lists</a>.</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000744
Misha Brukman80731b92003-11-22 00:38:41 +0000745</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000746
747<!-- *********************************************************************** -->
Chris Lattner3d482502003-10-02 04:57:28 +0000748
Misha Brukman80731b92003-11-22 00:38:41 +0000749<hr>
Misha Brukman68aab3b2003-11-22 01:23:39 +0000750<address>
Misha Brukman8834af92003-12-21 22:53:21 +0000751 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman68aab3b2003-11-22 01:23:39 +0000752 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
753 <a href="http://validator.w3.org/check/referer"><img
754 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
755
Misha Brukman7cb4e382003-11-22 01:00:11 +0000756 <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br>
Misha Brukman80731b92003-11-22 00:38:41 +0000757 Last modified: $Date$
Misha Brukman68aab3b2003-11-22 01:23:39 +0000758</address>
Chris Lattner3d482502003-10-02 04:57:28 +0000759
Misha Brukman80731b92003-11-22 00:38:41 +0000760</body>
761</html>