blob: aa7c73dc558b5eb38b20ba85547c4debe7b8feed [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>
5 <link rel="stylesheet" href="llvm.css" type="text/css">
Chris Lattner2974b5b2004-04-01 00:41:31 +00006 <title>LLVM 1.3 Release Notes</title>
Misha Brukman500bc302003-11-22 00:38:41 +00007</head>
8<body>
Chris Lattner79c3fe12003-10-02 04:57:28 +00009
Chris Lattner2974b5b2004-04-01 00:41:31 +000010<div class="doc_title">LLVM 1.3 Release Notes</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +000011
12<ol>
Misha Brukman500bc302003-11-22 00:38:41 +000013 <li><a href="#intro">Introduction</a></li>
14 <li><a href="#whatsnew">What's New?</a></li>
Chris Lattner4b538b92004-04-30 22:17:12 +000015 <li><a href="GettingStarted.html">Installation Instructions</a></li>
Misha Brukman500bc302003-11-22 00:38:41 +000016 <li><a href="#portability">Portability and Supported Platforms</a></li>
Chris Lattner79c3fe12003-10-02 04:57:28 +000017 <li><a href="#knownproblems">Known Problems</a>
18 <ul>
Chris Lattner2974b5b2004-04-01 00:41:31 +000019 <li><a href="#experimental">Experimental features included in this
20 release</a>
Chris Lattner79c3fe12003-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 Brukmanadb1c392004-07-12 16:55:41 +000025 <li><a href="#sparcv9-be">Known problems with the SparcV9 Back-end</a>
Chris Lattner79c3fe12003-10-02 04:57:28 +000026 <li><a href="#c-be">Known problems with the C back-end</a>
Misha Brukman500bc302003-11-22 00:38:41 +000027 </ul></li>
28 <li><a href="#additionalinfo">Additional Information</a></li>
Chris Lattner79c3fe12003-10-02 04:57:28 +000029</ol>
30
Chris Lattner7911ce22004-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 Brukman500bc302003-11-22 00:38:41 +000033</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +000034
35<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +000036<div class="doc_section">
37 <a name="intro">Introduction</a>
38</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +000039<!-- *********************************************************************** -->
40
Misha Brukman500bc302003-11-22 00:38:41 +000041<div class="doc_text">
42
43<p>This document contains the release notes for the LLVM compiler
Chris Lattner2974b5b2004-04-01 00:41:31 +000044infrastructure, release 1.3. Here we describe the status of LLVM, including any
John Criswelld000e1d2003-12-18 16:43:17 +000045known problems and bug fixes from the previous release. The most up-to-date
Misha Brukman500bc302003-11-22 00:38:41 +000046version of this document can be found on the <a
Chris Lattner2974b5b2004-04-01 00:41:31 +000047href="http://llvm.cs.uiuc.edu/releases/1.3/">LLVM 1.3 web site</a>. If you are
John Criswelld000e1d2003-12-18 16:43:17 +000048not reading this on the LLVM web pages, you should probably go there because
Misha Brukman500bc302003-11-22 00:38:41 +000049this document may be updated after the release.</p>
Chris Lattner19092612003-10-02 16:38:05 +000050
Misha Brukman500bc302003-11-22 00:38:41 +000051<p>For more information about LLVM, including information about potentially more
Chris Lattner47ad72c2003-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 Brukman500bc302003-11-22 00:38:41 +000055list</a> is a good place to send them.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +000056
Chris Lattner9e848092003-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 Brukman500bc302003-11-22 00:38:41 +000060href="http://llvm.cs.uiuc.edu/releases/">releases page</a>.</p>
61
62</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +000063
64<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +000065<div class="doc_section">
66 <a name="whatsnew">What's New?</a>
67</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +000068<!-- *********************************************************************** -->
69
Misha Brukman500bc302003-11-22 00:38:41 +000070<div class="doc_text">
71
Misha Brukman6df9e2c2004-05-12 21:46:05 +000072<p>This is the fourth public release of the LLVM compiler infrastructure. This
Chris Lattnerd4594dc2004-05-04 17:04:09 +000073release primarily improves the <a href="#codequality">performance of the
Chris Lattnerd5713882004-08-02 20:28:44 +000074code</a> produced by all aspects of the LLVM compiler, adds many <a
75href="#newfeatures">new features</a>, <a href="#bugfix">fixes a few
76bugs</a>, and speeds up the compiler.</p>
Chris Lattnera5099962003-12-06 20:22:41 +000077
Misha Brukman6df9e2c2004-05-12 21:46:05 +000078<p> At this time, LLVM is known to correctly compile and run all C &amp; C++
Chris Lattnerd5713882004-08-02 20:28:44 +000079SPEC CPU95 &amp; 2000 benchmarks, the Olden benchmarks, and the Ptrdist
80benchmarks, and <b>many</b> other programs. LLVM now also works
81with a broad variety of C++ programs.</p>
Chris Lattnera5099962003-12-06 20:22:41 +000082
Chris Lattner80453c92004-05-24 04:50:25 +000083</div>
84
Chris Lattnera5099962003-12-06 20:22:41 +000085<!--=========================================================================-->
86<div class="doc_subsubsection">
Chris Lattnera39719f2004-02-25 16:36:51 +000087<a name="newfeatures">This release implements the following new features:</a>
Chris Lattnera5099962003-12-06 20:22:41 +000088</div>
Chris Lattner47ad72c2003-10-07 21:38:31 +000089
Chris Lattner80453c92004-05-24 04:50:25 +000090<div class="doc_text">
91
Chris Lattner47ad72c2003-10-07 21:38:31 +000092<ol>
Chris Lattner2974b5b2004-04-01 00:41:31 +000093<li>The LLVM <a href="LangRef.html#i_select"><tt>select</tt></a> instruction is
Chris Lattner6e1ef192004-05-02 04:19:15 +000094now fully implemented and supported by all transformations, native code
95generators, and the interpreter.</li>
Misha Brukmana7aadf12004-04-19 02:56:49 +000096<li>Bugpoint can now narrow down code-generation bugs to a loop nest, where
97before it could only narrow them down to a function being miscompiled.</li>
Brian Gaeke43be3112004-05-04 21:22:57 +000098<li><a href="http://llvm.cs.uiuc.edu/PR40">Bugpoint can now debug arbitrary
Chris Lattnerd5713882004-08-02 20:28:44 +000099modes of llc</a> and lli, by passing them command line flags (e.g.
100<tt>-regalloc=linearscan</tt>).</li>
Chris Lattner6e1ef192004-05-02 04:19:15 +0000101<li>The Control Flow Graph in the native code generators is no longer
102constrained to be the same as the CFG for the LLVM input code.</li>
103<li>The LLVM induction variable analysis routines have been rewritten.</li>
104<li>LLVM now has new loop unrolling and loop unswitching passes.</li>
105<li>The induction variable substitution pass performs linear function test
106replacement and exit value replacement optimizations.</li>
Misha Brukman0d4b67c2004-07-02 16:23:17 +0000107<li>LLVM now has first-class support for <a
108href="GarbageCollection.html">Accurate Garbage Collection</a>, enabling the use
109of aggressive copying and generational collectors.</li>
Chris Lattnerd5713882004-08-02 20:28:44 +0000110<li>LLVM now includes a simple implementation of <a
111href="AliasAnalysis.html#anders-aa">Andersen's interprocedural alias
112analysis</a> algorithm.</li>
Chris Lattner14cd5392004-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 Gaeke5beb8ba2004-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 Lattner4654bdb2004-06-01 18:22:41 +0000117This includes the JIT compiler.</li>
Misha Brukman0d4b67c2004-07-02 16:23:17 +0000118<li>The LLVM code generator is now being <a
119href="CodeGenerator.html">documented</a>.</li>
Chris Lattnerd5713882004-08-02 20:28:44 +0000120<li>LLVM includes a new tool, <a
121href="CommandGuide/html/llvm-bcanalyzer.html">llvm-bcanalyzer</a>, This tool
122can compute various statistics and dump information about LLVM bytecode
123encoding.</li>
124<li>The <a href="BytecodeFormat.html">LLVM bytecode file format</a> is now
Misha Brukman0d4b67c2004-07-02 16:23:17 +0000125documented.</li>
126<li>LLVM now provides an <a
127href="LangRef.html#i_isunordered">llvm.isunordered</a> intrinsic for efficient
128implementation of unordered floating point comparisons.</li>
Chris Lattnerceebeb62004-06-18 06:26:29 +0000129<li>The llvmgcc front-end now supports the GCC builtins for ISO C99 floating
130point comparison macros (e.g., <tt>__builtin_islessequal</tt>).</li>
Chris Lattnerd5713882004-08-02 20:28:44 +0000131<li>We now generate <a href="CommandGuide/">HTML documentation and man pages</a>
132for the tools from a single source (perl-style POD files).</li>
Chris Lattnerc8cd7e92004-07-12 17:09:23 +0000133<li>The LLVM code generator can now dynamically load targets from shared
134objects.</li>
Chris Lattnerd5713882004-08-02 20:28:44 +0000135<li>LLVM now includes a "skeleton" target, which makes it easier to get
136started porting LLVM to new architectures.</li>
137<li>The linear scan register allocator is now enabled by default in the
138target-independent code generator.</li>
139<li>LLVM now includes a dead store elimination pass.</li>
140<li>Bugpoint can now debug miscompilations that lead to the program going
141into an infinite loop.</li>
142<li>LLVM now provides interfaces to support ML-style pattern matching on the
143LLVM IR.</li>
144<li>LLVM now includes a <a
145href="AliasAnalysis.html#globalsmodref">context-sensitive mod/ref analysis</a>
146for global variables, which is now enabled by default in gccld.</li>
147<li>LLVM can now autogenerate assembly printers for code generators from the
148tablegen description of the target (before they were hand coded).</li>
Reid Spencer17c2b922004-08-04 00:43:50 +0000149<li>All LLVM tools will now respond to the
150<a href="http://llvm.cs.uiuc.edu/PR413"><tt>--version</tt> option</a> which
151will tell you the version of LLVM on which the tool is based.</li>
Chris Lattner55ee0312003-11-19 22:05:38 +0000152</ol>
Chris Lattner0ef19062003-11-08 04:28:55 +0000153
Chris Lattner80453c92004-05-24 04:50:25 +0000154</div>
155
Chris Lattnera5099962003-12-06 20:22:41 +0000156
157<!--=========================================================================-->
158<div class="doc_subsubsection">
159In this release, the following missing features were implemented:
160</div>
Chris Lattner0ef19062003-11-08 04:28:55 +0000161
Chris Lattner80453c92004-05-24 04:50:25 +0000162<div class="doc_text">
163
Chris Lattner0ef19062003-11-08 04:28:55 +0000164<ol>
Misha Brukmana7aadf12004-04-19 02:56:49 +0000165<li><a href="http://llvm.cs.uiuc.edu/PR82">LLVM cannot handle structures with
166more than 256 elements</a></li>
Misha Brukmancb003362004-04-19 03:01:01 +0000167<li><a href="http://llvm.cs.uiuc.edu/PR38">[bugpoint] External functions used in
168non-instruction entities, such as global constant initializer</a></li>
Reid Spencer44ff57a2004-05-09 23:32:39 +0000169<li><a href="http://llvm.cs.uiuc.edu/PR178">Stacker does not handle targets
170with 64-bit pointers.</a></li>
Misha Brukmancb003362004-04-19 03:01:01 +0000171<li><a href="http://llvm.cs.uiuc.edu/PR290">Bugpoint doesn't support
172uses of external fns by immediate constant exprs</a></li>
Chris Lattnerd5713882004-08-02 20:28:44 +0000173<li><a href="http://llvm.cs.uiuc.edu/PR407">Can't add function passes that
174depend on immutable passes to the FunctionPassManager</a>.</li>
175<li><a href="http://llvm.cs.uiuc.edu/PR308">Archive file reader doesn't
176understand abbreviated names in headers</a></li>
Misha Brukman500bc302003-11-22 00:38:41 +0000177</ol>
Chris Lattner47ad72c2003-10-07 21:38:31 +0000178
Chris Lattner80453c92004-05-24 04:50:25 +0000179</div>
Chris Lattnera5099962003-12-06 20:22:41 +0000180
181<!--=========================================================================-->
182<div class="doc_subsubsection">
Misha Brukmana7aadf12004-04-19 02:56:49 +0000183<a name="qualityofimp">In this release, the following Quality of Implementation
184issues were fixed:</a>
Chris Lattnere29ac162003-12-20 03:42:11 +0000185</div>
186
Chris Lattner80453c92004-05-24 04:50:25 +0000187<div class="doc_text">
188
Chris Lattnere29ac162003-12-20 03:42:11 +0000189<ol>
Misha Brukmana7aadf12004-04-19 02:56:49 +0000190<li><a href="http://llvm.cs.uiuc.edu/PR305">LLVM tools will happily spew
191bytecode onto your terminal</a></li>
Misha Brukman6df9e2c2004-05-12 21:46:05 +0000192<li><a href="http://llvm.cs.uiuc.edu/PR329">[llvmgcc] type names are not emitted
193for structure typedefs</a></li>
Chris Lattnerb9656692004-05-24 04:53:32 +0000194<li>All documentation is now conformant to the HTML 4.01 (Strict) level.</li>
Chris Lattnerea955512004-06-08 07:19:29 +0000195<li>The spurious "WARNING: Found global types that are not compatible" warning
196produced when linking C++ programs has been fixed.</li>
Reid Spencer421991c2004-07-07 21:06:28 +0000197<li><a href="http://llvm.cs.uiuc.edu/PR391">lli Doesn't Handle Exceptions From
198Bytecode Reader</a></li>
Reid Spencerf8474322004-07-25 22:15:33 +0000199<li><a href="http://llvm.cs.uiuc.edu/PR392">Global Vars Have (Somewhat) Limited
200 Type Range</a></li>
Chris Lattner9e229b22004-07-15 02:59:24 +0000201<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>
Reid Spencerf8474322004-07-25 22:15:33 +0000202<li><a href="http://llvm.cs.uiuc.edu/PR402">Bytecode Enhancements
203 Needed</a></li>
Chris Lattner6568fe82004-07-15 04:30:35 +0000204<li><a href="http://llvm.cs.uiuc.edu/PR404">[loopsimplify] Loop simplify is really slow on 252.eon</a></li>
Chris Lattnerd5713882004-08-02 20:28:44 +0000205<li><a href="Http://llvm.cs.uiuc.edu/PR122">[code-cleanup] SymbolTable
206 class cleanup, Type should not derive from Value, eliminate
207 ConstantPointerRef class</a>.</li>
208<li>The memory footprint of the LLVM IR has been reduced substantially.</li>
Chris Lattnera834fe22004-08-04 08:00:45 +0000209<li>The LLVM linker and many core classes have been sped up substantially.</li>
Chris Lattnere29ac162003-12-20 03:42:11 +0000210</ol>
211
Chris Lattner80453c92004-05-24 04:50:25 +0000212</div>
213
Chris Lattnere29ac162003-12-20 03:42:11 +0000214<!--=========================================================================-->
215<div class="doc_subsubsection">
Chris Lattnera39719f2004-02-25 16:36:51 +0000216In this release, the following build problems were fixed:
Brian Gaeke6b31beb2004-01-16 21:55:04 +0000217</div>
218
Chris Lattner80453c92004-05-24 04:50:25 +0000219<div class="doc_text">
Brian Gaeke6b31beb2004-01-16 21:55:04 +0000220<ol>
Misha Brukman6df9e2c2004-05-12 21:46:05 +0000221<li><a href="http://llvm.cs.uiuc.edu/PR301">Minor configure bugs with
222-disable/enable-povray and -disable-spec</a></li>
223<li><a href="http://llvm.cs.uiuc.edu/PR289">shell scripts output by gccld don't
224work if you change PATH</a></li>
Chris Lattner24738a72004-06-09 01:09:16 +0000225<li><a href="http://llvm.cs.uiuc.edu/PR364">[llvmgcc] llvmgcc does not compile
226with gcc 3.4</a></li>
Chris Lattnerf82bba92004-06-18 17:57:29 +0000227<li><a href="http://llvm.cs.uiuc.edu/PR373">[llvmgcc] obstack.h relies on
228obsolete casts-as-lvalues GCC extension</a></li>
Brian Gaeke6b31beb2004-01-16 21:55:04 +0000229</ol>
Chris Lattner80453c92004-05-24 04:50:25 +0000230</div>
Brian Gaeke6b31beb2004-01-16 21:55:04 +0000231
232<!--=========================================================================-->
233<div class="doc_subsubsection">
Chris Lattner6e1ef192004-05-02 04:19:15 +0000234<a name="codequality">This release includes the following Code Quality
235improvements:</a>
Chris Lattneraab56d42004-05-23 20:42:08 +0000236</div>
Chris Lattner89ca2b82003-10-27 17:06:39 +0000237
Chris Lattner80453c92004-05-24 04:50:25 +0000238<div class="doc_text">
Chris Lattner89ca2b82003-10-27 17:06:39 +0000239<ol>
Chris Lattner6e1ef192004-05-02 04:19:15 +0000240<li>Fixed: <a href="http://llvm.cs.uiuc.edu/PR309">[vmcore] Code quality problem
241due to long operand of getelementptr</a></li>
Chris Lattner64913402004-04-13 14:43:35 +0000242
243<li>The X86 backend now generates substantially better code for 64-bit integer
244and floating point operations.</li>
245
246<li>The -inline pass no longer inlines mutually recursive functions until it
247hits the inlining threshold.</li>
248
249<li>The -inline pass no longer misses obvious inlining opportunities just
250because the callee eventually calls into an external function.</li>
251
Chris Lattnerd5713882004-08-02 20:28:44 +0000252<li>The -simplifycfg pass can now "if convert" simple statements into the
Chris Lattner64913402004-04-13 14:43:35 +0000253<tt>select</tt> instruction.</li>
254
255<li>The -loopsimplify pass can now break <a
256href="http://llvm.cs.uiuc.edu/PR35">natural loops with multiple backedges</a>
257into multiple nested loops. This enables a variety of subsequent
258optimizations.</li>
259
260<li>The -adce pass can now eliminate calls to functions that do not not write to
261memory.</li>
262
263<li>The link-time optimizer now runs the -prune-eh pass (to remove unused
Chris Lattnerd4594dc2004-05-04 17:04:09 +0000264exception handlers).</li>
Chris Lattner64913402004-04-13 14:43:35 +0000265
Chris Lattnerd5713882004-08-02 20:28:44 +0000266<li>The link-time optimizer now runs dead store elimination and uses a simple
267interprocedural alias analysis.</li>
268
Chris Lattner6e1ef192004-05-02 04:19:15 +0000269<li>The -simplifycfg pass can now eliminate simple correlated branches (such as
270"<tt>if (A &lt; B &amp;&amp; A &lt; B)</tt>", and can turn short-circuiting
271operators into the strict versions when useful (such as "<tt>if (A &lt; B || A
272&gt; C)</tt>" into "<tt>if (A &lt; B | A &gt; C)</tt>"</li>
273
Chris Lattnerd4594dc2004-05-04 17:04:09 +0000274<li>LLVM now has infrastructure for (simple and sparse conditional) constant
275propagation of function calls. It currently supports a few math library
276functions like sqrt/sin/cos/etc.</li>
Chris Lattner3bff8f52004-06-03 22:35:13 +0000277
Chris Lattnerd5713882004-08-02 20:28:44 +0000278<li>The C backend now emits <a href="http://llvm.cs.uiuc.edu/PR334">syntactic
Chris Lattner3bff8f52004-06-03 22:35:13 +0000279loops</a> in the code to help C compilers whose optimizers do not recognize
280loops formed from gotos (like GCC).</li>
Brian Gaeke11074e32004-06-11 02:15:39 +0000281
Chris Lattnerd5713882004-08-02 20:28:44 +0000282<li>The SparcV9 backend no longers <a
283href="http://llvm.cs.uiuc.edu/PR368">spills the null constant to the constant
284pool</a>.</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000285</ol>
Reid Spencer8e0262f2004-05-23 17:23:13 +0000286</div>
Chris Lattnera5099962003-12-06 20:22:41 +0000287
288<!--=========================================================================-->
289<div class="doc_subsubsection">
Misha Brukmana7aadf12004-04-19 02:56:49 +0000290<a name="bugfix">In this release, the following bugs in the previous release
291were fixed:</a>
Chris Lattnera5099962003-12-06 20:22:41 +0000292</div>
293
Chris Lattner80453c92004-05-24 04:50:25 +0000294<div class="doc_text">
295
Chris Lattnerd5713882004-08-02 20:28:44 +0000296<p>Bugs fixed in the LLVM Core:</p>
Chris Lattner47ad72c2003-10-07 21:38:31 +0000297
298<ol>
Misha Brukmana7aadf12004-04-19 02:56:49 +0000299<li><a href="http://llvm.cs.uiuc.edu/PR306">[loopsimplify] Loop simplify
300incorrectly updates dominator information</a></li>
301<li><a href="http://llvm.cs.uiuc.edu/PR310">[tailduplicate] DemoteRegToStack
302breaks SSA form</a></li>
303<li><a href="http://llvm.cs.uiuc.edu/PR313">[X86] JIT miscompiles unsigned short
304to floating point cast</a></li>
Reid Spencer7b000962004-06-29 23:39:24 +0000305<li><a href="http://llvm.cs.uiuc.edu/PR330">[vmcore] Linker causes erroneous
306asssertion</a></li>
Misha Brukman6df9e2c2004-05-12 21:46:05 +0000307<li><a href="http://llvm.cs.uiuc.edu/PR332">[adce] Crash handling unreachable
308code that unwinds</a></li>
Misha Brukmanadb1c392004-07-12 16:55:41 +0000309<li><a href="http://llvm.cs.uiuc.edu/PR333">[sparcv9] LLC can't emit 2 functions
Misha Brukman6df9e2c2004-05-12 21:46:05 +0000310of the same name, both having constant pools</a></li>
311<li><a href="http://llvm.cs.uiuc.edu/PR337">[livevar] Live variables missed
312physical register use of aliased definition</a></li>
Reid Spencer7b000962004-06-29 23:39:24 +0000313<li><a href="http://llvm.cs.uiuc.edu/PR369">[X86] stackifier crash on floating
314point setcc X, X</a></li>
Chris Lattnera5099962003-12-06 20:22:41 +0000315</ol>
316
Chris Lattnera5099962003-12-06 20:22:41 +0000317<p>Bugs in the C/C++ front-end:</p>
318
319<ol>
Misha Brukman6df9e2c2004-05-12 21:46:05 +0000320<li><a href="http://llvm.cs.uiuc.edu/PR298">[llvmgcc] Variable length array
321indexing miscompiled</a></li>
Reid Spencer7b000962004-06-29 23:39:24 +0000322<li><a href="http://llvm.cs.uiuc.edu/PR326">[llvmgcc] Crash on use of undeclared
323enum type</a></li>
Chris Lattner19019602004-06-19 01:11:02 +0000324<li><a href="http://llvm.cs.uiuc.edu/PR355">[llvmgcc] Errors handling function
325prototypes that take opaque structs by-value</a></li>
326<li><a href="http://llvm.cs.uiuc.edu/PR374">[llvmgcc] Crash compiling variable
327length array of structures</a></li>
Misha Brukman0d4b67c2004-07-02 16:23:17 +0000328<li><a href="http://llvm.cs.uiuc.edu/PR377">[llvmgcc] miscompilation of staticly
Reid Spencer7b000962004-06-29 23:39:24 +0000329initialized unsigned bitfields</a></li>
Chris Lattner5171eb52004-07-07 02:25:24 +0000330<li><a href="http://llvm.cs.uiuc.edu/PR396">[llvm-gcc] Crash casting function to void</a></li>
Chris Lattnera5099962003-12-06 20:22:41 +0000331</ol>
Chris Lattner80453c92004-05-24 04:50:25 +0000332</div>
Reid Spencer8e0262f2004-05-23 17:23:13 +0000333
Chris Lattner19092612003-10-02 16:38:05 +0000334<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000335<div class="doc_section">
336 <a name="portability">Portability and Supported Platforms</a>
337</div>
Chris Lattner19092612003-10-02 16:38:05 +0000338<!-- *********************************************************************** -->
339
Misha Brukman500bc302003-11-22 00:38:41 +0000340<div class="doc_text">
341
Chris Lattner4654bdb2004-06-01 18:22:41 +0000342<p>LLVM is known to work in the following platforms:</p>
343
344<ul>
345<li>Intel and AMD machines running Red Hat Linux and FreeBSD (and probably
346 other unix-like systems).</li>
347<li>Sun UltraSPARC workstations running Solaris 8.</li>
348<li>PowerPC-based Mac OS X boxes, running 10.3 and above (C backend and
349 interpreter only, no native codegen is available yet).</li>
350<li>Intel and AMD machines running on Win32 with the Cygwin libraries.</li>
351</ul>
352
Brian Gaekeb0fd7612004-05-09 05:28:35 +0000353
354<p>The core LLVM infrastructure uses
355<a href="http://www.gnu.org/software/autoconf/">GNU autoconf</a> to adapt itself
356to the machine and operating system on which it is built. However, minor
357porting may be required to get LLVM to work on new platforms. We welcome your
358portability patches and reports of successful builds or error messages.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000359
Chris Lattner4654bdb2004-06-01 18:22:41 +0000360<p>Note that the LLVM build system does not currently support directories with
361spaces on them when running on Win32/cygwin. We strongly recommend running
362LLVM and the C frontend out of a top-level directory without spaces (e.g.,
Chris Lattner74032a52004-06-01 19:41:30 +0000363<tt>/cygdrive/c/llvm</tt>). Also, make sure to install <b>all</b> of the
364cygwin packages. By default, many important tools are not installed that
365are needed by the LLVM build process or test suite (e.g., /bin/time).</p>
Chris Lattner4654bdb2004-06-01 18:22:41 +0000366
Misha Brukman500bc302003-11-22 00:38:41 +0000367</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000368
369<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000370<div class="doc_section">
371 <a name="knownproblems">Known Problems</a>
372</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000373<!-- *********************************************************************** -->
374
Misha Brukman500bc302003-11-22 00:38:41 +0000375<div class="doc_text">
376
377<p>This section contains all known problems with the LLVM system, listed by
Chris Lattner79c3fe12003-10-02 04:57:28 +0000378component. As new problems are discovered, they will be added to these
Chris Lattner5eccca42003-12-12 21:22:16 +0000379sections. If you run into a problem, please check the <a
John Criswelld000e1d2003-12-18 16:43:17 +0000380href="http://llvm.cs.uiuc.edu/bugs/">LLVM bug database</a> and submit a bug if
Chris Lattner5eccca42003-12-12 21:22:16 +0000381there isn't already one.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000382
Misha Brukman500bc302003-11-22 00:38:41 +0000383</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000384
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000385<!-- ======================================================================= -->
386<div class="doc_subsection">
387 <a name="experimental">Experimental features included with this release</a>
388</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000389
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000390<div class="doc_text">
391
Misha Brukman6df9e2c2004-05-12 21:46:05 +0000392<p>The following components of this LLVM release are either untested, known to
393be broken or unreliable, or are in early development. These components should
394not be relied on, and bugs should not be filed against them, but they may be
395useful to some people. In particular, if you would like to work on one of these
396components, please contact us on the llvmdev list.</p>
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000397
398<ul>
399<li>The following passes are incomplete or buggy: <tt>-pgmdep, -memdep,
Chris Lattnercbabe702004-06-28 00:44:45 +0000400 -ipmodref, -cee</tt></li>
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000401
402<li>The <tt>-pre</tt> pass is incomplete (there are cases it doesn't handle that
403 it should) and not thoroughly tested.</li>
404<li>The <tt>llvm-ar</tt> tool is incomplete and probably buggy.</li>
405<li>The <tt>llvm-db</tt> tool is in a very early stage of development.</li>
406</ul>
407
408</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000409
Misha Brukman500bc302003-11-22 00:38:41 +0000410<!-- ======================================================================= -->
411<div class="doc_subsection">
412 <a name="core">Known problems with the LLVM Core</a>
413</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000414
Misha Brukman500bc302003-11-22 00:38:41 +0000415<div class="doc_text">
416
417<ul>
418
419<li>In the JIT, <tt>dlsym</tt> on a symbol compiled by the JIT will not
420work.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000421
422<li>The JIT does not use mutexes to protect its internal data structures. As
Misha Brukman500bc302003-11-22 00:38:41 +0000423such, execution of a threaded program could cause these data structures to be
424corrupted.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000425
Misha Brukman500bc302003-11-22 00:38:41 +0000426<li>It is not possible to <tt>dlopen</tt> an LLVM bytecode file in the JIT.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000427
Chris Lattnere84843b2003-10-20 19:05:03 +0000428<li>Linking in static archive files (.a files) is very slow (there is no symbol
Misha Brukman500bc302003-11-22 00:38:41 +0000429table in the archive).</li>
Chris Lattner2855ecd2003-11-04 20:06:53 +0000430
Misha Brukmana7aadf12004-04-19 02:56:49 +0000431<li>The gccld program <a href="http://llvm.cs.uiuc.edu/PR139">does not link
432objects/archives in the order specified on the command line.</a></li>
Chris Lattner2e6fcaf2004-02-15 23:09:07 +0000433
434<li><a href="http://llvm.cs.uiuc.edu/PR240">The lower-invoke pass does not mark
John Criswelld46c6962004-03-12 21:29:42 +0000435values live across a setjmp as volatile</a>. This missing feature only affects
Chris Lattner2e6fcaf2004-02-15 23:09:07 +0000436targets whose setjmp/longjmp libraries do not save and restore the entire
437register file.</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000438</ul>
Misha Brukman500bc302003-11-22 00:38:41 +0000439</div>
440
441<!-- ======================================================================= -->
442<div class="doc_subsection">
443 <a name="c-fe">Known problems with the C front-end</a>
444</div>
Chris Lattner47588f92003-10-02 05:07:23 +0000445
Chris Lattner79c3fe12003-10-02 04:57:28 +0000446<!-- _______________________________________________________________________ -->
Chris Lattnerb40efb32003-12-14 05:03:43 +0000447<div class="doc_subsubsection">Bugs</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000448
Misha Brukman500bc302003-11-22 00:38:41 +0000449<div class="doc_text">
Misha Brukman500bc302003-11-22 00:38:41 +0000450<ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000451<li>C99 Variable sized arrays do not release stack memory when they go out of
452 scope. Thus, the following program may run out of stack space:
453<pre>
454 for (i = 0; i != 1000000; ++i) {
455 int X[n];
456 foo(X);
457 }
Misha Brukman500bc302003-11-22 00:38:41 +0000458</pre></li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000459
Misha Brukman6df9e2c2004-05-12 21:46:05 +0000460<li>Initialization of global union variables can only be done <a
461href="http://llvm.cs.uiuc.edu/bugs/show_bug.cgi?id=162">with the largest union
462member</a>.</li>
Chris Lattnerf580cdc2004-03-16 21:39:04 +0000463
Misha Brukmana7aadf12004-04-19 02:56:49 +0000464<li><a href="http://llvm.cs.uiuc.edu/PR244">[llvm-gcc] Error when an implicitly
465external function is re-declared as static</a></li>
Chris Lattnerf580cdc2004-03-16 21:39:04 +0000466
John Criswelld000e1d2003-12-18 16:43:17 +0000467</ul>
Misha Brukman500bc302003-11-22 00:38:41 +0000468</div>
469
470<!-- _______________________________________________________________________ -->
471<div class="doc_subsubsection">
472 Notes
473</div>
474
475<div class="doc_text">
476
477<ul>
478
479<li>Inline assembly is not yet supported.</li>
Chris Lattnere01fcfb2003-10-27 18:30:37 +0000480
481<li>"long double" is transformed by the front-end into "double". There is no
Misha Brukman500bc302003-11-22 00:38:41 +0000482support for floating point data types of any size other than 32 and 64
483bits.</li>
484
485<li>The following Unix system functionality has not been tested and may not
486work:
Misha Brukmane0c891c2003-11-22 01:00:11 +0000487 <ol>
488 <li><tt>sigsetjmp</tt>, <tt>siglongjmp</tt> - These are not turned into the
489 appropriate <tt>invoke</tt>/<tt>unwind</tt> instructions. Note that
490 <tt>setjmp</tt> and <tt>longjmp</tt> <em>are</em> compiled correctly.
491 <li><tt>getcontext</tt>, <tt>setcontext</tt>, <tt>makecontext</tt>
492 - These functions have not been tested.
493 </ol></li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000494
495<li>Although many GCC extensions are supported, some are not. In particular,
496 the following extensions are known to <b>not be</b> supported:
497 <ol>
Misha Brukman500bc302003-11-22 00:38:41 +0000498 <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 +0000499 <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>
500 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Constructing-Calls.html#Constructing%20Calls">Constructing Calls</a>: Dispatching a call to another function.</li>
501 <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 +0000502 <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 +0000503 <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>
504 <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 +0000505 <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>
506 <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>
507 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Thread-Local.html#Thread-Local">Thread-Local</a>: Per-thread variables.</li>
508 <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 +0000509 </ol>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000510
Misha Brukman500bc302003-11-22 00:38:41 +0000511 <p>The following GCC extensions are <b>partially</b> supported. An ignored
Chris Lattner79c3fe12003-10-02 04:57:28 +0000512 attribute means that the LLVM compiler ignores the presence of the attribute,
513 but the code should still work. An unsupported attribute is one which is
John Criswelld000e1d2003-12-18 16:43:17 +0000514 ignored by the LLVM compiler and will cause a different interpretation of
Misha Brukman500bc302003-11-22 00:38:41 +0000515 the program.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000516
517 <ol>
518 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Length.html#Variable%20Length">Variable Length</a>:
519 Arrays whose length is computed at run time.<br>
Misha Brukman500bc302003-11-22 00:38:41 +0000520 Supported, but allocated stack space is not freed until the function returns (noted above).</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000521
522 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Attributes.html#Function%20Attributes">Function Attributes</a>:
Misha Brukman500bc302003-11-22 00:38:41 +0000523
John Criswelld000e1d2003-12-18 16:43:17 +0000524 Declaring that functions have no side effects or that they can never
Misha Brukman500bc302003-11-22 00:38:41 +0000525 return.<br>
526
527 <b>Supported:</b> <tt>format</tt>, <tt>format_arg</tt>, <tt>non_null</tt>,
528 <tt>constructor</tt>, <tt>destructor</tt>, <tt>unused</tt>,
529 <tt>deprecated</tt>, <tt>warn_unused_result</tt>, <tt>weak</tt><br>
530
531 <b>Ignored:</b> <tt>noreturn</tt>, <tt>noinline</tt>,
532 <tt>always_inline</tt>, <tt>pure</tt>, <tt>const</tt>, <tt>nothrow</tt>,
533 <tt>malloc</tt>, <tt>no_instrument_function</tt>, <tt>cdecl</tt><br>
534
535 <b>Unsupported:</b> <tt>used</tt>, <tt>section</tt>, <tt>alias</tt>,
536 <tt>visibility</tt>, <tt>regparm</tt>, <tt>stdcall</tt>,
537 <tt>fastcall</tt>, all other target specific attributes</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000538
539 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Attributes.html#Variable%20Attributes">Variable Attributes</a>:
540 Specifying attributes of variables.<br>
541 <b>Supported:</b> <tt>cleanup</tt>, <tt>common</tt>, <tt>nocommon</tt>,
542 <tt>deprecated</tt>, <tt>transparent_union</tt>,
543 <tt>unused</tt>, <tt>weak</tt><br>
Misha Brukman500bc302003-11-22 00:38:41 +0000544
Chris Lattner79c3fe12003-10-02 04:57:28 +0000545 <b>Unsupported:</b> <tt>aligned</tt>, <tt>mode</tt>, <tt>packed</tt>,
546 <tt>section</tt>, <tt>shared</tt>, <tt>tls_model</tt>,
547 <tt>vector_size</tt>, <tt>dllimport</tt>,
Misha Brukman500bc302003-11-22 00:38:41 +0000548 <tt>dllexport</tt>, all target specific attributes.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000549
Misha Brukmanc4b7bee2003-12-12 04:37:31 +0000550 <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 +0000551 <b>Supported:</b> <tt>transparent_union</tt>, <tt>unused</tt>,
Misha Brukmanc4b7bee2003-12-12 04:37:31 +0000552 <tt>deprecated</tt>, <tt>may_alias</tt><br>
Misha Brukman500bc302003-11-22 00:38:41 +0000553
554 <b>Unsupported:</b> <tt>aligned</tt>, <tt>packed</tt>,
555 all target specific attributes.</li>
556
Chris Lattner79c3fe12003-10-02 04:57:28 +0000557 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Other-Builtins.html#Other%20Builtins">Other Builtins</a>:
558 Other built-in functions.<br>
559 We support all builtins which have a C language equivalent (e.g.,
560 <tt>__builtin_cos</tt>), <tt>__builtin_alloca</tt>,
561 <tt>__builtin_types_compatible_p</tt>, <tt>__builtin_choose_expr</tt>,
Chris Lattnerceebeb62004-06-18 06:26:29 +0000562 <tt>__builtin_constant_p</tt>, and <tt>__builtin_expect</tt>
563 (currently ignored). We also support builtins for ISO C99 floating
564 point comparison macros (e.g., <tt>__builtin_islessequal</tt>).</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000565 </ol>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000566
Misha Brukman500bc302003-11-22 00:38:41 +0000567 <p>The following extensions <b>are</b> known to be supported:</p>
568
Chris Lattner79c3fe12003-10-02 04:57:28 +0000569 <ol>
Chris Lattner7fe97dd2004-03-16 08:54:07 +0000570 <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 +0000571 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Statement-Exprs.html#Statement%20Exprs">Statement Exprs</a>: Putting statements and declarations inside expressions.</li>
572 <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 +0000573 <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 +0000574 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Conditionals.html#Conditionals">Conditionals</a>: Omitting the middle operand of a <code>?:</code> expression.</li>
575 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Long-Long.html#Long%20Long">Long Long</a>: Double-word integers.</li>
576 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Complex.html#Complex">Complex</a>: Data types for complex numbers.</li>
577 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Hex-Floats.html#Hex%20Floats">Hex Floats</a>:Hexadecimal floating-point constants.</li>
578 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Zero-Length.html#Zero%20Length">Zero Length</a>: Zero-length arrays.</li>
579 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Empty-Structures.html#Empty%20Structures">Empty Structures</a>: Structures with no members.</li>
580 <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>
581 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Escaped-Newlines.html#Escaped%20Newlines">Escaped Newlines</a>: Slightly looser rules for escaped newlines.</li>
582 <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 +0000583 <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 +0000584 <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 +0000585 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Compound-Literals.html#Compound%20Literals">Compound Literals</a>: Compound literals give structures, unions,
586or arrays as values.</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000587 <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 +0000588 <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 +0000589 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Case-Ranges.html#Case%20Ranges">Case Ranges</a>: `case 1 ... 9' and such.</li>
590 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Mixed-Declarations.html#Mixed%20Declarations">Mixed Declarations</a>: Mixing declarations and code.</li>
591 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Prototypes.html#Function%20Prototypes">Function Prototypes</a>: Prototype declarations and old-style definitions.</li>
592 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/C---Comments.html#C++%20Comments">C++ Comments</a>: C++ comments are recognized.</li>
593 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Dollar-Signs.html#Dollar%20Signs">Dollar Signs</a>: Dollar sign is allowed in identifiers.</li>
594 <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>
595 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Alignment.html#Alignment">Alignment</a>: Inquiring about the alignment of a type or variable.</li>
596 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Inline.html#Inline">Inline</a>: Defining inline functions (as fast as macros).</li>
597 <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>
598 <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>
599 <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 +0000600 <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 +0000601 <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>
602 <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 +0000603 </ol></li>
604
605</ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000606
Misha Brukman500bc302003-11-22 00:38:41 +0000607<p>If you run into GCC extensions which have not been included in any of these
608lists, please let us know (also including whether or not they work).</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000609
Misha Brukman500bc302003-11-22 00:38:41 +0000610</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000611
Misha Brukman500bc302003-11-22 00:38:41 +0000612<!-- ======================================================================= -->
613<div class="doc_subsection">
614 <a name="c++-fe">Known problems with the C++ front-end</a>
615</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000616
Misha Brukman500bc302003-11-22 00:38:41 +0000617<div class="doc_text">
618
John Criswelld000e1d2003-12-18 16:43:17 +0000619<p>For this release, the C++ front-end is considered to be fully functional but
Chris Lattner9e848092003-12-12 04:25:33 +0000620has not been tested as thoroughly as the C front-end. It has been tested and
621works for a number of non-trivial programs, but there may be lurking bugs.
622Please report any bugs or problems.</p>
Misha Brukman500bc302003-11-22 00:38:41 +0000623
624</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000625
626<!-- _______________________________________________________________________ -->
Chris Lattner3a51be12004-02-14 04:12:41 +0000627<div class="doc_subsubsection">Bugs</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000628
Misha Brukman500bc302003-11-22 00:38:41 +0000629<div class="doc_text">
Chris Lattner79c3fe12003-10-02 04:57:28 +0000630
Misha Brukman500bc302003-11-22 00:38:41 +0000631<ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000632<li>The C++ front-end inherits all problems afflicting the <a href="#c-fe">C
John Criswelld000e1d2003-12-18 16:43:17 +0000633 front-end</a>.</li>
Chris Lattner7962f712004-07-17 02:04:41 +0000634
Chris Lattnerd5713882004-08-02 20:28:44 +0000635<li><b>IA-64 specific</b>: The C++ front-end does not use <a
636href="http://llvm.cs.uiuc.edu/PR406">IA64 ABI compliant layout of v-tables</a>.
Chris Lattner7962f712004-07-17 02:04:41 +0000637In particular, it just stores function pointers instead of function
638descriptors in the vtable. This bug prevents mixing C++ code compiled with
Chris Lattner04db8082004-08-02 20:29:51 +0000639LLVM with C++ objects compiled by other C++ compilers.</li>
Chris Lattner7962f712004-07-17 02:04:41 +0000640
Chris Lattnerd5713882004-08-02 20:28:44 +0000641</ul>
642
Misha Brukman500bc302003-11-22 00:38:41 +0000643</div>
644
645<!-- _______________________________________________________________________ -->
646<div class="doc_subsubsection">
647 Notes
648</div>
649
650<div class="doc_text">
651
652<ul>
Chris Lattnere01fcfb2003-10-27 18:30:37 +0000653
Chris Lattner79c3fe12003-10-02 04:57:28 +0000654<li>The C++ front-end is based on a pre-release of the GCC 3.4 C++ parser. This
655parser is significantly more standards compliant (and picky) than prior GCC
656versions. For more information, see the C++ section of the <a
Chris Lattner9e848092003-12-12 04:25:33 +0000657href="http://gcc.gnu.org/gcc-3.4/changes.html">GCC 3.4 release notes</a>.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000658
659<li>Destructors for local objects are not always run when a <tt>longjmp</tt> is
Chris Lattner19092612003-10-02 16:38:05 +0000660 performed. In particular, destructors for objects in the <tt>longjmp</tt>ing
Chris Lattner79c3fe12003-10-02 04:57:28 +0000661 function and in the <tt>setjmp</tt> receiver function may not be run.
John Criswelld000e1d2003-12-18 16:43:17 +0000662 Objects in intervening stack frames will be destroyed, however (which is
Misha Brukman500bc302003-11-22 00:38:41 +0000663 better than most compilers).</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000664
Chris Lattner19092612003-10-02 16:38:05 +0000665<li>The LLVM C++ front-end follows the <a
666 href="http://www.codesourcery.com/cxx-abi">Itanium C++ ABI</a>.
667 This document, which is not Itanium specific, specifies a standard for name
668 mangling, class layout, v-table layout, RTTI formats, and other C++
669 representation issues. Because we use this API, code generated by the LLVM
670 compilers should be binary compatible with machine code generated by other
671 Itanium ABI C++ compilers (such as G++, the Intel and HP compilers, etc).
672 <i>However</i>, the exception handling mechanism used by LLVM is very
673 different from the model used in the Itanium ABI, so <b>exceptions will not
Misha Brukman500bc302003-11-22 00:38:41 +0000674 interact correctly</b>. </li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000675
Misha Brukman500bc302003-11-22 00:38:41 +0000676</ul>
Chris Lattnerfcc54b32003-10-07 22:14:37 +0000677
Misha Brukman500bc302003-11-22 00:38:41 +0000678</div>
679
680<!-- ======================================================================= -->
681<div class="doc_subsection">
682 <a name="x86-be">Known problems with the X86 back-end</a>
683</div>
684
685<div class="doc_text">
686
687<ul>
Chris Lattnerd5713882004-08-02 20:28:44 +0000688 <li>none yet</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000689</ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000690
Misha Brukman500bc302003-11-22 00:38:41 +0000691</div>
692
693<!-- ======================================================================= -->
694<div class="doc_subsection">
Misha Brukmanadb1c392004-07-12 16:55:41 +0000695 <a name="sparcv9-be">Known problems with the SparcV9 back-end</a>
Misha Brukman500bc302003-11-22 00:38:41 +0000696</div>
697
698<div class="doc_text">
699
700<ul>
Misha Brukmanadb1c392004-07-12 16:55:41 +0000701<li><a href="http://llvm.cs.uiuc.edu/PR60">[sparcv9] SparcV9 backend miscompiles
702several programs in the LLVM test suite</a></li>
Misha Brukman500bc302003-11-22 00:38:41 +0000703</ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000704
Misha Brukman500bc302003-11-22 00:38:41 +0000705</div>
706
707<!-- ======================================================================= -->
708<div class="doc_subsection">
709 <a name="c-be">Known problems with the C back-end</a>
710</div>
711
712<div class="doc_text">
713
714<ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000715
716<li>The C back-end produces code that violates the ANSI C Type-Based Alias
717Analysis rules. As such, special options may be necessary to compile the code
718(for example, GCC requires the <tt>-fno-strict-aliasing</tt> option). This
Misha Brukman500bc302003-11-22 00:38:41 +0000719problem probably cannot be fixed.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000720
Chris Lattnere84843b2003-10-20 19:05:03 +0000721<li><a href="http://llvm.cs.uiuc.edu/PR33">Initializers for global variables</a>
Misha Brukman500bc302003-11-22 00:38:41 +0000722cannot include special floating point numbers like Not-A-Number or
723Infinity.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000724
Chris Lattner2855ecd2003-11-04 20:06:53 +0000725<li><a href="http://llvm.cs.uiuc.edu/PR56">Zero arg vararg functions are not
Chris Lattner2af46052003-10-24 04:03:19 +0000726supported</a>. This should not affect LLVM produced by the C or C++
Misha Brukman500bc302003-11-22 00:38:41 +0000727frontends.</li>
Chris Lattner2af46052003-10-24 04:03:19 +0000728
Misha Brukman500bc302003-11-22 00:38:41 +0000729</ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000730
Misha Brukman500bc302003-11-22 00:38:41 +0000731</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000732
733<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000734<div class="doc_section">
735 <a name="additionalinfo">Additional Information</a>
736</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000737<!-- *********************************************************************** -->
738
Misha Brukman500bc302003-11-22 00:38:41 +0000739<div class="doc_text">
740
741<p>A wide variety of additional information is available on the LLVM web page,
John Criswelld000e1d2003-12-18 16:43:17 +0000742including mailing lists and publications describing algorithms and components
Chris Lattner79c3fe12003-10-02 04:57:28 +0000743implemented in LLVM. The web page also contains versions of the API
744documentation which is up-to-date with the CVS version of the source code. You
745can access versions of these documents specific to this release by going into
Misha Brukman500bc302003-11-22 00:38:41 +0000746the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000747
Misha Brukman500bc302003-11-22 00:38:41 +0000748<p>If you have any questions or comments about LLVM, please feel free to contact
Chris Lattner5eccca42003-12-12 21:22:16 +0000749us via the <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">mailing
750lists</a>.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000751
Misha Brukman500bc302003-11-22 00:38:41 +0000752</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000753
754<!-- *********************************************************************** -->
Chris Lattner79c3fe12003-10-02 04:57:28 +0000755
Misha Brukman500bc302003-11-22 00:38:41 +0000756<hr>
Misha Brukman2061e892003-11-22 01:23:39 +0000757<address>
Misha Brukman38847d52003-12-21 22:53:21 +0000758 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman2061e892003-11-22 01:23:39 +0000759 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
760 <a href="http://validator.w3.org/check/referer"><img
761 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
762
Misha Brukmane0c891c2003-11-22 01:00:11 +0000763 <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br>
Misha Brukman500bc302003-11-22 00:38:41 +0000764 Last modified: $Date$
Misha Brukman2061e892003-11-22 01:23:39 +0000765</address>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000766
Misha Brukman500bc302003-11-22 00:38:41 +0000767</body>
768</html>