blob: 938a2645f4ce3a1e62adde79143d272b41e28ff8 [file] [log] [blame]
Misha Brukman500bc302003-11-22 00:38:41 +00001<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
3<html>
4<head>
Reid Spencer6454ed32004-11-18 18:38:58 +00005 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
Misha Brukman500bc302003-11-22 00:38:41 +00006 <link rel="stylesheet" href="llvm.css" type="text/css">
Chris Lattner5c3389a2004-08-16 00:20:18 +00007 <title>LLVM 1.4 Release Notes</title>
Misha Brukman500bc302003-11-22 00:38:41 +00008</head>
9<body>
Chris Lattner79c3fe12003-10-02 04:57:28 +000010
Chris Lattner5c3389a2004-08-16 00:20:18 +000011<div class="doc_title">LLVM 1.4 Release Notes</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +000012
13<ol>
Misha Brukman500bc302003-11-22 00:38:41 +000014 <li><a href="#intro">Introduction</a></li>
15 <li><a href="#whatsnew">What's New?</a></li>
Chris Lattner4b538b92004-04-30 22:17:12 +000016 <li><a href="GettingStarted.html">Installation Instructions</a></li>
Misha Brukman500bc302003-11-22 00:38:41 +000017 <li><a href="#portability">Portability and Supported Platforms</a></li>
Chris Lattner79c3fe12003-10-02 04:57:28 +000018 <li><a href="#knownproblems">Known Problems</a>
19 <ul>
Chris Lattner2974b5b2004-04-01 00:41:31 +000020 <li><a href="#experimental">Experimental features included in this
21 release</a>
Chris Lattner79c3fe12003-10-02 04:57:28 +000022 <li><a href="#core">Known problems with the LLVM Core</a>
23 <li><a href="#c-fe">Known problems with the C Front-end</a>
24 <li><a href="#c++-fe">Known problems with the C++ Front-end</a>
25 <li><a href="#x86-be">Known problems with the X86 Back-end</a>
Misha Brukmanadb1c392004-07-12 16:55:41 +000026 <li><a href="#sparcv9-be">Known problems with the SparcV9 Back-end</a>
Chris Lattnerf32a5f52004-11-07 01:55:32 +000027 <li><a href="#ppc-be">Known problems with the PowerPC Back-end</a>
Chris Lattner79c3fe12003-10-02 04:57:28 +000028 <li><a href="#c-be">Known problems with the C back-end</a>
Misha Brukman500bc302003-11-22 00:38:41 +000029 </ul></li>
30 <li><a href="#additionalinfo">Additional Information</a></li>
Chris Lattner79c3fe12003-10-02 04:57:28 +000031</ol>
32
Chris Lattner7911ce22004-05-23 21:07:27 +000033<div class="doc_author">
34 <p>Written by the <a href="http://llvm.cs.uiuc.edu">LLVM team</a><p>
Misha Brukman500bc302003-11-22 00:38:41 +000035</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +000036
37<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +000038<div class="doc_section">
39 <a name="intro">Introduction</a>
40</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +000041<!-- *********************************************************************** -->
42
Misha Brukman500bc302003-11-22 00:38:41 +000043<div class="doc_text">
44
45<p>This document contains the release notes for the LLVM compiler
Chris Lattner5c3389a2004-08-16 00:20:18 +000046infrastructure, release 1.4. Here we describe the status of LLVM, including any
Chris Lattner7506b1d2004-12-07 08:04:13 +000047known problems and improvements from the previous release. The most up-to-date
Misha Brukman500bc302003-11-22 00:38:41 +000048version of this document can be found on the <a
Chris Lattner5c3389a2004-08-16 00:20:18 +000049href="http://llvm.cs.uiuc.edu/releases/1.4/">LLVM 1.4 web site</a>. If you are
John Criswelld000e1d2003-12-18 16:43:17 +000050not reading this on the LLVM web pages, you should probably go there because
Misha Brukman500bc302003-11-22 00:38:41 +000051this document may be updated after the release.</p>
Chris Lattner19092612003-10-02 16:38:05 +000052
Chris Lattner7506b1d2004-12-07 08:04:13 +000053<p>For more information about LLVM, including information about the latest
54release, please check out the <a href="http://llvm.cs.uiuc.edu">main LLVM
Chris Lattner47ad72c2003-10-07 21:38:31 +000055web site</a>. If you have questions or comments, the <a
56href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM developer's mailing
Misha Brukman500bc302003-11-22 00:38:41 +000057list</a> is a good place to send them.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +000058
Chris Lattner9e848092003-12-12 04:25:33 +000059<p>Note that if you are reading this file from CVS, this document applies
60to the <i>next</i> release, not the current one. To see the release notes for
61the current or previous releases, see the <a
Misha Brukman500bc302003-11-22 00:38:41 +000062href="http://llvm.cs.uiuc.edu/releases/">releases page</a>.</p>
63
64</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +000065
66<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +000067<div class="doc_section">
68 <a name="whatsnew">What's New?</a>
69</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +000070<!-- *********************************************************************** -->
71
Misha Brukman500bc302003-11-22 00:38:41 +000072<div class="doc_text">
73
Chris Lattner5c3389a2004-08-16 00:20:18 +000074<p>This is the fifth public release of the LLVM compiler infrastructure.</p>
Chris Lattnera5099962003-12-06 20:22:41 +000075
Reid Spencere09ca642004-12-07 08:39:08 +000076<p> At this time, LLVM is known to correctly compile on a broad range of
Chris Lattner7506b1d2004-12-07 08:04:13 +000077C and C++ programs, including the SPEC CPU95 &amp; 2000 suite. This release
78includes several major enhancements to the LLVM system, including a new
79PowerPC JIT, enhancements to the C/C++ front-end to provide source line number
80information in LLVM, a new <a href="CommandGuide/html/llvmc.html">compiler
81driver</a>, and several other enhancements listed below. It also includes
82bug fixes for those problems found since the 1.3 release.</p>
83
84<p>Note that this release seperates the LLVM Program Testsuite out of the
85main LLVM distribution into a seperate CVS repository and tarball. This
86reduces the size of the main LLVM distribution. Also note that LLVM now
87builds tools into llvm/Debug/bin by default instead of llvm/tools/Debug.</p>
Chris Lattnera5099962003-12-06 20:22:41 +000088
Chris Lattner80453c92004-05-24 04:50:25 +000089</div>
90
Chris Lattnera5099962003-12-06 20:22:41 +000091<!--=========================================================================-->
92<div class="doc_subsubsection">
Chris Lattnera39719f2004-02-25 16:36:51 +000093<a name="newfeatures">This release implements the following new features:</a>
Chris Lattnera5099962003-12-06 20:22:41 +000094</div>
Chris Lattner47ad72c2003-10-07 21:38:31 +000095
Chris Lattner80453c92004-05-24 04:50:25 +000096<div class="doc_text">
Chris Lattner47ad72c2003-10-07 21:38:31 +000097<ol>
Chris Lattner7506b1d2004-12-07 08:04:13 +000098 <li>LLVM now includes a Just-In-Time compiler for the PowerPC target.</li>
99 <li>llvmgcc and llvmg++ now emit source line number information when '-g' is
Reid Spencere09ca642004-12-07 08:39:08 +0000100 passed in, making it possible to map from LLVM code back to source.
101 This information is currently used by llvm-db and can be used with other
102 tools and passes.</li>
Chris Lattner7506b1d2004-12-07 08:04:13 +0000103 <li>The test/Programs hierarchy <a href="http://llvm.cs.uiuc.edu/PR257">has
104 been moved out of the main LLVM tree</a> into a separate CVS repository and
105 tarball. This shrinks the distribution size of LLVM itself significantly.
Reid Spencer6454ed32004-11-18 18:38:58 +0000106 </li>
Chris Lattner7506b1d2004-12-07 08:04:13 +0000107 <li>LLVM now optimizes global variables more aggressively than it did
108 before.</li>
Reid Spencer4f86f9c2004-11-25 22:38:30 +0000109 <li>LLVM now includes the new '<tt>undef</tt>' value and
110 <a href="LangRef.html#i_unreachable"><tt>unreachable</tt></a> instruction,
111 which give the optimizer more information about the behavior of the
112 program.
113 </li>
Reid Spencer4f86f9c2004-11-25 22:38:30 +0000114 <li>Bytecode compression with bzip2 has been implemented. All bytecode files
115 generated by LLVM will now be compressed by default. Compression can be
116 disabled with the <tt>-disable-compression</tt> option to the tools that can
117 generate bytecode files.
118 </li>
Chris Lattner7506b1d2004-12-07 08:04:13 +0000119 <li>A generic <a href="CommandGuide/html/llvmc.html">compiler driver</a>
120 (llvmc) and
121 an associated <a href="CommandGuide/html/llvm-ld.html">generic linker</a>
122 (llvm-ld) have been added. The compiler driver is generic because it can be
123 configured
Reid Spencer4f86f9c2004-11-25 22:38:30 +0000124 to pre-process, translate, optimize, assemble, and link code from any source
Chris Lattner7506b1d2004-12-07 08:04:13 +0000125 language with an LLVM front-end. This makes it easier for compiler writers
126 to hide the multiple steps required to compile a program (compiling,
127 optimizing, linking runtime libraries, etc) in one simple command.
Reid Spencer4f86f9c2004-11-25 22:38:30 +0000128 </li>
129 <li>The <a href="http://llvm.cs.uiuc.edu/PR263">dependent libraries</a>
130 feature has been implemented. This allows front end compilers to indicate in
131 the bytecode which libraries the bytecode needs to be linked with. Both the
Reid Spencere09ca642004-12-07 08:39:08 +0000132 C/C++ and Stacker front ends support generating the required dependencies.
133 The linker now supports using this information to ensure required libaries are
Reid Spencer4f86f9c2004-11-25 22:38:30 +0000134 linked into the module. This minimizes the need to use the <tt>-l</tt> option
John Criswell0b5b5e92004-12-08 20:35:47 +0000135 when using <a href="CommandGuide/html/llvmc.html"><tt>llvmc</tt></a>.
Reid Spencer4f86f9c2004-11-25 22:38:30 +0000136 </li>
Chris Lattner7506b1d2004-12-07 08:04:13 +0000137 <li>The LLVM makefiles have been improved to build LLVM much faster and
138 includes new targets (like dist-check, uninstall). One important user-visible
139 change is that libraries and tools will now be built into
140 <tt>$builddir/Debug/{bin,lib}</tt>
141 instead of <tt>$builddir/tools/Debug</tt> and <tt>$builddir/lib/Debug</tt>
142 (Similarly for <tt>Release</tt> and <tt>Profile</tt> builds).
Reid Spencer6454ed32004-11-18 18:38:58 +0000143 </li>
Chris Lattner7c8dd7f2004-11-17 18:19:32 +0000144 <li>The LLVM source code is much more compatible with Microsoft Visual C++,
Reid Spencer4f86f9c2004-11-25 22:38:30 +0000145 including the JIT and runtime-code generation, though the entire system
146 may not work with it.
147 </li>
Chris Lattner7506b1d2004-12-07 08:04:13 +0000148 <li>The JIT-Target interfaces <a href="http://llvm.cs.uiuc.edu/PR283">are
Reid Spencer4f86f9c2004-11-25 22:38:30 +0000149 now much simpler</a> and more powerful.
150 </li>
Chris Lattner7506b1d2004-12-07 08:04:13 +0000151 <li>LLVM now provides llvm-ar and llvm-ranlib tools for working with archives
152 of LLVM bytecode files.</li>
Chris Lattnera4bcecf2004-11-27 19:24:06 +0000153 <li>zlib and libpng are <a href="http://llvm.cs.uiuc.edu/PR417">no longer
154 included in the main LLVM tarball</a>.</li>
Chris Lattner7506b1d2004-12-07 08:04:13 +0000155 <li>The LLVM code generator now automatically generates assembly code writers
156 from an abstract target descriptions, eliminating the need to write
157 assembly printers manually.</li>
Reid Spencere09ca642004-12-07 08:39:08 +0000158 <li>LLVM regression and feature tests now use DejaGNU instead of QMTest.</li>
Chris Lattner55ee0312003-11-19 22:05:38 +0000159</ol>
Chris Lattner0ef19062003-11-08 04:28:55 +0000160
Chris Lattner80453c92004-05-24 04:50:25 +0000161</div>
162
Chris Lattnera5099962003-12-06 20:22:41 +0000163
164<!--=========================================================================-->
165<div class="doc_subsubsection">
166In this release, the following missing features were implemented:
167</div>
Chris Lattner0ef19062003-11-08 04:28:55 +0000168
Chris Lattner80453c92004-05-24 04:50:25 +0000169<div class="doc_text">
170
Chris Lattner0ef19062003-11-08 04:28:55 +0000171<ol>
Reid Spencer6454ed32004-11-18 18:38:58 +0000172 <li><a href="http://llvm.cs.uiuc.edu/PR419">JIT interface should support
Reid Spencer4f86f9c2004-11-25 22:38:30 +0000173 arbitrary calls</a>
174 </li>
Reid Spencer6454ed32004-11-18 18:38:58 +0000175 <li>The <tt>llvm-ar</tt> tool was previously incomplete and didn't properly
176 support other ar(1) implementations. This has been corrected. <tt>llvm-ar</tt>
177 now fully supports all archive editing functions, table of contents listing,
178 extraction, and printing. It can also read BSD4.4/MacOSX and SVR4 style
Reid Spencer4f86f9c2004-11-25 22:38:30 +0000179 archives. See <a href="CommandGuide/html/llvm-ar.html">llvm-ar</a> for
180 details.
181 </li>
Misha Brukman500bc302003-11-22 00:38:41 +0000182</ol>
Chris Lattner47ad72c2003-10-07 21:38:31 +0000183
Chris Lattner80453c92004-05-24 04:50:25 +0000184</div>
Chris Lattnera5099962003-12-06 20:22:41 +0000185
186<!--=========================================================================-->
187<div class="doc_subsubsection">
Misha Brukmana7aadf12004-04-19 02:56:49 +0000188<a name="qualityofimp">In this release, the following Quality of Implementation
189issues were fixed:</a>
Chris Lattnere29ac162003-12-20 03:42:11 +0000190</div>
191
Chris Lattner80453c92004-05-24 04:50:25 +0000192<div class="doc_text">
193
Chris Lattnere29ac162003-12-20 03:42:11 +0000194<ol>
Chris Lattner7506b1d2004-12-07 08:04:13 +0000195 <li>The linker no longer <a href="http://llvm.cs.uiuc.edu/PR426">emits many
Reid Spencere09ca642004-12-07 08:39:08 +0000196 useless warnings</a> when linking C++ programs.
Reid Spencer4e69a5b2004-12-06 22:32:33 +0000197 </li>
Chris Lattner7506b1d2004-12-07 08:04:13 +0000198 <li>The LLVM <a href="http://llvm.cs.uiuc.edu/PR352">#include namespace</a>
199 has been made consistent. Files in <tt>llvm/include/{Support,Config}</tt>
Reid Spencere09ca642004-12-07 08:39:08 +0000200 are now located in <tt>llvm/include/llvm/{Support,Config}</tt>.
Reid Spencer4f86f9c2004-11-25 22:38:30 +0000201 </li>
Reid Spencerccbc9cf2004-11-22 18:40:51 +0000202 <li>The names of the libraries generated by compiling LLVM source have been
203 changed to ensure they do not conflict with other packages upon installation.
204 Each LLVM library is now prefixed with LLVM and uses mixed clase. For example,
205 the library <tt>libasmparser.a</tt> in 1.3 has become
Reid Spencer4f86f9c2004-11-25 22:38:30 +0000206 <tt>libLLVMAsmParser.a</tt> in release 1.4.
207 </li>
Chris Lattner7506b1d2004-12-07 08:04:13 +0000208 <li>The C++ frontend no longer expands and emits <a
209 href="http://llvm.cs.uiuc.edu/PR459">all inline functions, even if they
210 are unused</a>. It now properly tracks which functions are needed and
211 only compiles those.</li>
Chris Lattnere29ac162003-12-20 03:42:11 +0000212
Chris Lattner7506b1d2004-12-07 08:04:13 +0000213 <li>Many improvements in the <a href="http://llvm.cs.uiuc.edu/PR256">autoconf
214 and makefile systems</a> have been implemented.</li>
Brian Gaeke6b31beb2004-01-16 21:55:04 +0000215</ol>
Chris Lattner80453c92004-05-24 04:50:25 +0000216</div>
Brian Gaeke6b31beb2004-01-16 21:55:04 +0000217
218<!--=========================================================================-->
219<div class="doc_subsubsection">
Chris Lattner6e1ef192004-05-02 04:19:15 +0000220<a name="codequality">This release includes the following Code Quality
221improvements:</a>
Chris Lattneraab56d42004-05-23 20:42:08 +0000222</div>
Chris Lattner89ca2b82003-10-27 17:06:39 +0000223
Chris Lattner80453c92004-05-24 04:50:25 +0000224<div class="doc_text">
Chris Lattner89ca2b82003-10-27 17:06:39 +0000225<ol>
Chris Lattner7506b1d2004-12-07 08:04:13 +0000226 <li>The optimizer produces <a href="http://llvm.cs.uiuc.edu/PR362">more
227 efficient code for std::min/std::max</a> and other similar functions.</li>
228 <li>The X86 backend generates substantially faster code for floating point
229 intensive programs.</li>
230 <li>The PowerPC backend generates more efficient code in many common
231 scenarios.</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000232</ol>
Reid Spencer8e0262f2004-05-23 17:23:13 +0000233</div>
Chris Lattnera5099962003-12-06 20:22:41 +0000234
235<!--=========================================================================-->
236<div class="doc_subsubsection">
Misha Brukmana7aadf12004-04-19 02:56:49 +0000237<a name="bugfix">In this release, the following bugs in the previous release
238were fixed:</a>
Chris Lattnera5099962003-12-06 20:22:41 +0000239</div>
240
Chris Lattner80453c92004-05-24 04:50:25 +0000241<div class="doc_text">
242
Chris Lattnerd5713882004-08-02 20:28:44 +0000243<p>Bugs fixed in the LLVM Core:</p>
Chris Lattner47ad72c2003-10-07 21:38:31 +0000244
245<ol>
Reid Spencer4f86f9c2004-11-25 22:38:30 +0000246 <li><a href="http://llvm.cs.uiuc.edu/PR420">[licm] LICM invalidates alias
247 analysis info and uses broken information</a> (optimizer crash)</li>
248 <li><a href="http://llvm.cs.uiuc.edu/PR422">[asmwriter] Asmwriter is really
249 slow for functions with lots of values</a></li>
250 <li><a href="http://llvm.cs.uiuc.edu/PR423">[anders-aa] Andersen's AA is
251 completely broken in LLVM 1.3</a></li>
252 <li><a href="http://llvm.cs.uiuc.edu/PR430">[bcwriter] Empty compaction
253 tables defined</a></li>
Chris Lattner7506b1d2004-12-07 08:04:13 +0000254 <li><a href="http://llvm.cs.uiuc.edu/PR227">[X86] llc output for functions
255 w/certain names tickles GNU 'as' bugs</a></li>
Chris Lattner14d6b752004-12-03 17:21:33 +0000256 <li><a href="http://llvm.cs.uiuc.edu/PR472">[cbackend] Static globals are
257 prototyped as 'extern'</a></li>
Chris Lattnera5099962003-12-06 20:22:41 +0000258</ol>
259
Chris Lattnera5099962003-12-06 20:22:41 +0000260<p>Bugs in the C/C++ front-end:</p>
261
262<ol>
Reid Spencer4f86f9c2004-11-25 22:38:30 +0000263 <li><a href="http://llvm.cs.uiuc.edu/PR445">[llvmg++] not enough templates are
264 instantiated</a></li>
265 <li><a href="http://llvm.cs.uiuc.edu/PR450">[llvmg++] Extern const globals
266 cannot be marked 'constant' if they have nontrivial ctors or dtors</a></li>
267 <li><a href="http://llvm.cs.uiuc.edu/PR461">[llvmgcc] Crash compiling unnamed
Chris Lattner4df69b82004-11-25 06:31:42 +0000268 bitfield which does not increase struct size</a></li>
Chris Lattner748e58b2004-11-27 19:50:58 +0000269 <li><a href="http://llvm.cs.uiuc.edu/PR424">[llvmgcc] llvmgcc emits invalid
270 constant exprs</a></li>
Chris Lattner7506b1d2004-12-07 08:04:13 +0000271 <li><a href="http://llvm.cs.uiuc.edu/PR421">[llvmg++] Crash initializing
Chris Lattner0db649c2004-11-27 22:47:08 +0000272 array with constructors in hard EH situations</a></li>
Chris Lattnereeeff012004-11-27 23:27:26 +0000273 <li><a href="http://llvm.cs.uiuc.edu/PR397">[llvm-gcc] Inline function
274 redefinitions error due to 'asm' function rename</a></li>
Chris Lattner87c74b72004-11-28 00:43:59 +0000275 <li><a href="http://llvm.cs.uiuc.edu/PR244">[llvm-gcc] Error when an
Chris Lattner9b5d3952004-11-28 00:09:38 +0000276 implicitly external function is re-declared as static</a></li>
Chris Lattner87c74b72004-11-28 00:43:59 +0000277 <li><a href="http://llvm.cs.uiuc.edu/PR360">[llvmgcc] Structure field with
278 non-constant offset crashes llvmgcc</a></li>
Chris Lattner04cf0c22004-11-28 01:25:20 +0000279 <li><a href="http://llvm.cs.uiuc.edu/PR447">[llvmg++] Crash compiling
280 friend with default argument</a></li>
Chris Lattnera5099962003-12-06 20:22:41 +0000281</ol>
Brian Gaekee77c8e72004-08-24 07:43:48 +0000282
283<p>Bugs fixed in the Sparc V9 back-end:</p>
284
285<ol>
Reid Spencer4f86f9c2004-11-25 22:38:30 +0000286 <li><a href="http://llvm.cs.uiuc.edu/PR428">[sparcv9] regalloc assertion
Brian Gaekee77c8e72004-08-24 07:43:48 +0000287 failure with certain indirect calls</a></li>
288</ol>
289
Chris Lattner80453c92004-05-24 04:50:25 +0000290</div>
Reid Spencer8e0262f2004-05-23 17:23:13 +0000291
Chris Lattner19092612003-10-02 16:38:05 +0000292<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000293<div class="doc_section">
294 <a name="portability">Portability and Supported Platforms</a>
295</div>
Chris Lattner19092612003-10-02 16:38:05 +0000296<!-- *********************************************************************** -->
297
Misha Brukman500bc302003-11-22 00:38:41 +0000298<div class="doc_text">
299
John Criswell0b5b5e92004-12-08 20:35:47 +0000300<p>LLVM is known to work on the following platforms:</p>
Chris Lattner4654bdb2004-06-01 18:22:41 +0000301
302<ul>
303<li>Intel and AMD machines running Red Hat Linux and FreeBSD (and probably
304 other unix-like systems).</li>
305<li>Sun UltraSPARC workstations running Solaris 8.</li>
Chris Lattner7506b1d2004-12-07 08:04:13 +0000306<li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
307 support is available for native builds with Visual C++).</li>
308<li>PowerPC-based Mac OS X systems, running 10.2 and above.</li>
Chris Lattner4654bdb2004-06-01 18:22:41 +0000309</ul>
310
Brian Gaekeb0fd7612004-05-09 05:28:35 +0000311<p>The core LLVM infrastructure uses
312<a href="http://www.gnu.org/software/autoconf/">GNU autoconf</a> to adapt itself
313to the machine and operating system on which it is built. However, minor
314porting may be required to get LLVM to work on new platforms. We welcome your
315portability patches and reports of successful builds or error messages.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000316
Chris Lattner7506b1d2004-12-07 08:04:13 +0000317<!--
Chris Lattner4654bdb2004-06-01 18:22:41 +0000318<p>Note that the LLVM build system does not currently support directories with
319spaces on them when running on Win32/cygwin. We strongly recommend running
320LLVM and the C frontend out of a top-level directory without spaces (e.g.,
Chris Lattner74032a52004-06-01 19:41:30 +0000321<tt>/cygdrive/c/llvm</tt>). Also, make sure to install <b>all</b> of the
322cygwin packages. By default, many important tools are not installed that
Chris Lattner5aff3552004-08-16 20:20:46 +0000323are needed by the LLVM build process or test suite (e.g., /bin/time). Finally,
324please make sure that there are no directories with spaces in them in your
325PATH environment variable.</p>
Chris Lattner7506b1d2004-12-07 08:04:13 +0000326-->
Chris Lattner4654bdb2004-06-01 18:22:41 +0000327
Misha Brukman500bc302003-11-22 00:38:41 +0000328</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000329
330<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000331<div class="doc_section">
332 <a name="knownproblems">Known Problems</a>
333</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000334<!-- *********************************************************************** -->
335
Misha Brukman500bc302003-11-22 00:38:41 +0000336<div class="doc_text">
337
338<p>This section contains all known problems with the LLVM system, listed by
Chris Lattner79c3fe12003-10-02 04:57:28 +0000339component. As new problems are discovered, they will be added to these
Chris Lattner5eccca42003-12-12 21:22:16 +0000340sections. If you run into a problem, please check the <a
John Criswelld000e1d2003-12-18 16:43:17 +0000341href="http://llvm.cs.uiuc.edu/bugs/">LLVM bug database</a> and submit a bug if
Chris Lattner5eccca42003-12-12 21:22:16 +0000342there isn't already one.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000343
Misha Brukman500bc302003-11-22 00:38:41 +0000344</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000345
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000346<!-- ======================================================================= -->
347<div class="doc_subsection">
348 <a name="experimental">Experimental features included with this release</a>
349</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000350
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000351<div class="doc_text">
352
Misha Brukman6df9e2c2004-05-12 21:46:05 +0000353<p>The following components of this LLVM release are either untested, known to
354be broken or unreliable, or are in early development. These components should
355not be relied on, and bugs should not be filed against them, but they may be
356useful to some people. In particular, if you would like to work on one of these
357components, please contact us on the llvmdev list.</p>
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000358
359<ul>
Chris Lattner7506b1d2004-12-07 08:04:13 +0000360<li>The following passes are incomplete or buggy, and may be removed in future
361 releases: <tt>-pgmdep, -memdep, -ipmodref, -cee, -branch-combine,
362 -instloops, -paths, -pre</tt></li>
363<li>The <tt>llvm-db</tt> tool is in a very early stage of development, but can
364 be used to step through programs and inspect the stack.</li>
Chris Lattner0da7f492004-12-02 17:20:17 +0000365<li>The "iterative scan" register allocator (enabled with -regalloc=iterativescan)
366 is not stable.</li>
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000367</ul>
368
369</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000370
Misha Brukman500bc302003-11-22 00:38:41 +0000371<!-- ======================================================================= -->
372<div class="doc_subsection">
373 <a name="core">Known problems with the LLVM Core</a>
374</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000375
Misha Brukman500bc302003-11-22 00:38:41 +0000376<div class="doc_text">
377
378<ul>
Reid Spencer4f86f9c2004-11-25 22:38:30 +0000379 <li>In the JIT, <tt>dlsym</tt> on a symbol compiled by the JIT will not work.
380 </li>
381 <li>The JIT does not use mutexes to protect its internal data structures. As
382 such, execution of a threaded program could cause these data structures to be
383 corrupted.
384 </li>
Reid Spencer4f86f9c2004-11-25 22:38:30 +0000385 <li><a href="http://llvm.cs.uiuc.edu/PR240">The lower-invoke pass does not
386 mark values live across a setjmp as volatile</a>. This missing feature
387 only affects targets whose setjmp/longjmp libraries do not save and restore
388 the entire register file.</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000389</ul>
Misha Brukman500bc302003-11-22 00:38:41 +0000390</div>
391
392<!-- ======================================================================= -->
393<div class="doc_subsection">
394 <a name="c-fe">Known problems with the C front-end</a>
395</div>
Chris Lattner47588f92003-10-02 05:07:23 +0000396
Chris Lattner79c3fe12003-10-02 04:57:28 +0000397<!-- _______________________________________________________________________ -->
Chris Lattnerb40efb32003-12-14 05:03:43 +0000398<div class="doc_subsubsection">Bugs</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000399
Misha Brukman500bc302003-11-22 00:38:41 +0000400<div class="doc_text">
Misha Brukman500bc302003-11-22 00:38:41 +0000401<ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000402<li>C99 Variable sized arrays do not release stack memory when they go out of
403 scope. Thus, the following program may run out of stack space:
404<pre>
405 for (i = 0; i != 1000000; ++i) {
406 int X[n];
407 foo(X);
408 }
Misha Brukman500bc302003-11-22 00:38:41 +0000409</pre></li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000410
Misha Brukman6df9e2c2004-05-12 21:46:05 +0000411<li>Initialization of global union variables can only be done <a
Misha Brukman43ee2932004-12-04 00:45:09 +0000412href="http://llvm.cs.uiuc.edu/PR162">with the largest union member</a>.</li>
Chris Lattnerf580cdc2004-03-16 21:39:04 +0000413
John Criswelld000e1d2003-12-18 16:43:17 +0000414</ul>
Misha Brukman500bc302003-11-22 00:38:41 +0000415</div>
416
417<!-- _______________________________________________________________________ -->
418<div class="doc_subsubsection">
419 Notes
420</div>
421
422<div class="doc_text">
423
424<ul>
425
426<li>Inline assembly is not yet supported.</li>
Chris Lattnere01fcfb2003-10-27 18:30:37 +0000427
428<li>"long double" is transformed by the front-end into "double". There is no
Misha Brukman500bc302003-11-22 00:38:41 +0000429support for floating point data types of any size other than 32 and 64
430bits.</li>
431
432<li>The following Unix system functionality has not been tested and may not
433work:
Misha Brukmane0c891c2003-11-22 01:00:11 +0000434 <ol>
435 <li><tt>sigsetjmp</tt>, <tt>siglongjmp</tt> - These are not turned into the
436 appropriate <tt>invoke</tt>/<tt>unwind</tt> instructions. Note that
437 <tt>setjmp</tt> and <tt>longjmp</tt> <em>are</em> compiled correctly.
438 <li><tt>getcontext</tt>, <tt>setcontext</tt>, <tt>makecontext</tt>
439 - These functions have not been tested.
440 </ol></li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000441
442<li>Although many GCC extensions are supported, some are not. In particular,
443 the following extensions are known to <b>not be</b> supported:
444 <ol>
Misha Brukman500bc302003-11-22 00:38:41 +0000445 <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 +0000446 <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>
447 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Constructing-Calls.html#Constructing%20Calls">Constructing Calls</a>: Dispatching a call to another function.</li>
448 <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 +0000449 <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 +0000450 <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>
451 <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 +0000452 <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>
453 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Target-Builtins.html#Target%20Builtins">Target Builtins</a>: Built-in functions specific to particular targets.</li>
Tanya Lattner014e5f52004-12-08 18:25:34 +0000454 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Thread_002dLocal.html">Thread-Local</a>: Per-thread variables.</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000455 <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 +0000456 </ol>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000457
Misha Brukman500bc302003-11-22 00:38:41 +0000458 <p>The following GCC extensions are <b>partially</b> supported. An ignored
Chris Lattner79c3fe12003-10-02 04:57:28 +0000459 attribute means that the LLVM compiler ignores the presence of the attribute,
460 but the code should still work. An unsupported attribute is one which is
John Criswelld000e1d2003-12-18 16:43:17 +0000461 ignored by the LLVM compiler and will cause a different interpretation of
Misha Brukman500bc302003-11-22 00:38:41 +0000462 the program.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000463
464 <ol>
465 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Length.html#Variable%20Length">Variable Length</a>:
466 Arrays whose length is computed at run time.<br>
Misha Brukman500bc302003-11-22 00:38:41 +0000467 Supported, but allocated stack space is not freed until the function returns (noted above).</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000468
469 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Attributes.html#Function%20Attributes">Function Attributes</a>:
Misha Brukman500bc302003-11-22 00:38:41 +0000470
John Criswelld000e1d2003-12-18 16:43:17 +0000471 Declaring that functions have no side effects or that they can never
Misha Brukman500bc302003-11-22 00:38:41 +0000472 return.<br>
473
474 <b>Supported:</b> <tt>format</tt>, <tt>format_arg</tt>, <tt>non_null</tt>,
John Criswell0b5b5e92004-12-08 20:35:47 +0000475 <tt>noreturn</tt>, <tt>constructor</tt>, <tt>destructor</tt>,
476 <tt>unused</tt>,
Misha Brukman500bc302003-11-22 00:38:41 +0000477 <tt>deprecated</tt>, <tt>warn_unused_result</tt>, <tt>weak</tt><br>
478
John Criswell0b5b5e92004-12-08 20:35:47 +0000479 <b>Ignored:</b> <tt>noinline</tt>,
Misha Brukman500bc302003-11-22 00:38:41 +0000480 <tt>always_inline</tt>, <tt>pure</tt>, <tt>const</tt>, <tt>nothrow</tt>,
481 <tt>malloc</tt>, <tt>no_instrument_function</tt>, <tt>cdecl</tt><br>
482
483 <b>Unsupported:</b> <tt>used</tt>, <tt>section</tt>, <tt>alias</tt>,
484 <tt>visibility</tt>, <tt>regparm</tt>, <tt>stdcall</tt>,
485 <tt>fastcall</tt>, all other target specific attributes</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000486
487 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Attributes.html#Variable%20Attributes">Variable Attributes</a>:
488 Specifying attributes of variables.<br>
489 <b>Supported:</b> <tt>cleanup</tt>, <tt>common</tt>, <tt>nocommon</tt>,
490 <tt>deprecated</tt>, <tt>transparent_union</tt>,
491 <tt>unused</tt>, <tt>weak</tt><br>
Misha Brukman500bc302003-11-22 00:38:41 +0000492
Chris Lattner79c3fe12003-10-02 04:57:28 +0000493 <b>Unsupported:</b> <tt>aligned</tt>, <tt>mode</tt>, <tt>packed</tt>,
494 <tt>section</tt>, <tt>shared</tt>, <tt>tls_model</tt>,
495 <tt>vector_size</tt>, <tt>dllimport</tt>,
Misha Brukman500bc302003-11-22 00:38:41 +0000496 <tt>dllexport</tt>, all target specific attributes.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000497
Misha Brukmanc4b7bee2003-12-12 04:37:31 +0000498 <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 +0000499 <b>Supported:</b> <tt>transparent_union</tt>, <tt>unused</tt>,
Misha Brukmanc4b7bee2003-12-12 04:37:31 +0000500 <tt>deprecated</tt>, <tt>may_alias</tt><br>
Misha Brukman500bc302003-11-22 00:38:41 +0000501
502 <b>Unsupported:</b> <tt>aligned</tt>, <tt>packed</tt>,
503 all target specific attributes.</li>
504
Chris Lattner79c3fe12003-10-02 04:57:28 +0000505 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Other-Builtins.html#Other%20Builtins">Other Builtins</a>:
506 Other built-in functions.<br>
507 We support all builtins which have a C language equivalent (e.g.,
508 <tt>__builtin_cos</tt>), <tt>__builtin_alloca</tt>,
509 <tt>__builtin_types_compatible_p</tt>, <tt>__builtin_choose_expr</tt>,
Chris Lattnerceebeb62004-06-18 06:26:29 +0000510 <tt>__builtin_constant_p</tt>, and <tt>__builtin_expect</tt>
511 (currently ignored). We also support builtins for ISO C99 floating
512 point comparison macros (e.g., <tt>__builtin_islessequal</tt>).</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000513 </ol>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000514
Misha Brukman500bc302003-11-22 00:38:41 +0000515 <p>The following extensions <b>are</b> known to be supported:</p>
516
Chris Lattner79c3fe12003-10-02 04:57:28 +0000517 <ol>
Chris Lattner7fe97dd2004-03-16 08:54:07 +0000518 <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 +0000519 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Statement-Exprs.html#Statement%20Exprs">Statement Exprs</a>: Putting statements and declarations inside expressions.</li>
520 <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 +0000521 <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 +0000522 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Conditionals.html#Conditionals">Conditionals</a>: Omitting the middle operand of a <code>?:</code> expression.</li>
523 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Long-Long.html#Long%20Long">Long Long</a>: Double-word integers.</li>
524 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Complex.html#Complex">Complex</a>: Data types for complex numbers.</li>
525 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Hex-Floats.html#Hex%20Floats">Hex Floats</a>:Hexadecimal floating-point constants.</li>
526 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Zero-Length.html#Zero%20Length">Zero Length</a>: Zero-length arrays.</li>
527 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Empty-Structures.html#Empty%20Structures">Empty Structures</a>: Structures with no members.</li>
528 <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>
529 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Escaped-Newlines.html#Escaped%20Newlines">Escaped Newlines</a>: Slightly looser rules for escaped newlines.</li>
530 <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 +0000531 <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 +0000532 <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 +0000533 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Compound-Literals.html#Compound%20Literals">Compound Literals</a>: Compound literals give structures, unions,
534or arrays as values.</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000535 <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 +0000536 <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 +0000537 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Case-Ranges.html#Case%20Ranges">Case Ranges</a>: `case 1 ... 9' and such.</li>
538 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Mixed-Declarations.html#Mixed%20Declarations">Mixed Declarations</a>: Mixing declarations and code.</li>
539 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Prototypes.html#Function%20Prototypes">Function Prototypes</a>: Prototype declarations and old-style definitions.</li>
Tanya Lattner78537e42004-12-08 18:29:38 +0000540 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/C_002b_002b-Comments.html#C_002b_002b-Comments">C++ Comments</a>: C++ comments are recognized.</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000541 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Dollar-Signs.html#Dollar%20Signs">Dollar Signs</a>: Dollar sign is allowed in identifiers.</li>
542 <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>
543 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Alignment.html#Alignment">Alignment</a>: Inquiring about the alignment of a type or variable.</li>
544 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Inline.html#Inline">Inline</a>: Defining inline functions (as fast as macros).</li>
545 <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>
546 <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>
547 <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 +0000548 <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 +0000549 <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>
550 <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 +0000551 </ol></li>
552
553</ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000554
Misha Brukman500bc302003-11-22 00:38:41 +0000555<p>If you run into GCC extensions which have not been included in any of these
556lists, please let us know (also including whether or not they work).</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000557
Misha Brukman500bc302003-11-22 00:38:41 +0000558</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000559
Misha Brukman500bc302003-11-22 00:38:41 +0000560<!-- ======================================================================= -->
561<div class="doc_subsection">
562 <a name="c++-fe">Known problems with the C++ front-end</a>
563</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000564
Misha Brukman500bc302003-11-22 00:38:41 +0000565<div class="doc_text">
566
Reid Spencere09ca642004-12-07 08:39:08 +0000567<p>For this release, the C++ front-end is considered to be fully
Chris Lattner7506b1d2004-12-07 08:04:13 +0000568tested and works for a number of non-trivial programs, including LLVM
569itself.</p>
Misha Brukman500bc302003-11-22 00:38:41 +0000570
571</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000572
573<!-- _______________________________________________________________________ -->
Chris Lattner3a51be12004-02-14 04:12:41 +0000574<div class="doc_subsubsection">Bugs</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000575
Misha Brukman500bc302003-11-22 00:38:41 +0000576<div class="doc_text">
Chris Lattner79c3fe12003-10-02 04:57:28 +0000577
Misha Brukman500bc302003-11-22 00:38:41 +0000578<ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000579<li>The C++ front-end inherits all problems afflicting the <a href="#c-fe">C
John Criswelld000e1d2003-12-18 16:43:17 +0000580 front-end</a>.</li>
Chris Lattner7962f712004-07-17 02:04:41 +0000581
Chris Lattnerd5713882004-08-02 20:28:44 +0000582<li><b>IA-64 specific</b>: The C++ front-end does not use <a
583href="http://llvm.cs.uiuc.edu/PR406">IA64 ABI compliant layout of v-tables</a>.
Chris Lattner7962f712004-07-17 02:04:41 +0000584In particular, it just stores function pointers instead of function
585descriptors in the vtable. This bug prevents mixing C++ code compiled with
Chris Lattner04db8082004-08-02 20:29:51 +0000586LLVM with C++ objects compiled by other C++ compilers.</li>
Chris Lattner7962f712004-07-17 02:04:41 +0000587
Chris Lattnerd5713882004-08-02 20:28:44 +0000588</ul>
589
Misha Brukman500bc302003-11-22 00:38:41 +0000590</div>
591
592<!-- _______________________________________________________________________ -->
593<div class="doc_subsubsection">
594 Notes
595</div>
596
597<div class="doc_text">
598
599<ul>
Chris Lattnere01fcfb2003-10-27 18:30:37 +0000600
Chris Lattner79c3fe12003-10-02 04:57:28 +0000601<li>The C++ front-end is based on a pre-release of the GCC 3.4 C++ parser. This
602parser is significantly more standards compliant (and picky) than prior GCC
603versions. For more information, see the C++ section of the <a
Chris Lattner9e848092003-12-12 04:25:33 +0000604href="http://gcc.gnu.org/gcc-3.4/changes.html">GCC 3.4 release notes</a>.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000605
606<li>Destructors for local objects are not always run when a <tt>longjmp</tt> is
Chris Lattner19092612003-10-02 16:38:05 +0000607 performed. In particular, destructors for objects in the <tt>longjmp</tt>ing
Chris Lattner79c3fe12003-10-02 04:57:28 +0000608 function and in the <tt>setjmp</tt> receiver function may not be run.
John Criswelld000e1d2003-12-18 16:43:17 +0000609 Objects in intervening stack frames will be destroyed, however (which is
Misha Brukman500bc302003-11-22 00:38:41 +0000610 better than most compilers).</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000611
Chris Lattner19092612003-10-02 16:38:05 +0000612<li>The LLVM C++ front-end follows the <a
613 href="http://www.codesourcery.com/cxx-abi">Itanium C++ ABI</a>.
614 This document, which is not Itanium specific, specifies a standard for name
615 mangling, class layout, v-table layout, RTTI formats, and other C++
616 representation issues. Because we use this API, code generated by the LLVM
617 compilers should be binary compatible with machine code generated by other
618 Itanium ABI C++ compilers (such as G++, the Intel and HP compilers, etc).
619 <i>However</i>, the exception handling mechanism used by LLVM is very
620 different from the model used in the Itanium ABI, so <b>exceptions will not
Misha Brukman500bc302003-11-22 00:38:41 +0000621 interact correctly</b>. </li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000622
Misha Brukman500bc302003-11-22 00:38:41 +0000623</ul>
Chris Lattnerfcc54b32003-10-07 22:14:37 +0000624
Misha Brukman500bc302003-11-22 00:38:41 +0000625</div>
626
627<!-- ======================================================================= -->
628<div class="doc_subsection">
629 <a name="x86-be">Known problems with the X86 back-end</a>
630</div>
631
632<div class="doc_text">
633
634<ul>
Chris Lattnerd5713882004-08-02 20:28:44 +0000635 <li>none yet</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000636</ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000637
Misha Brukman500bc302003-11-22 00:38:41 +0000638</div>
639
640<!-- ======================================================================= -->
641<div class="doc_subsection">
Misha Brukmanadb1c392004-07-12 16:55:41 +0000642 <a name="sparcv9-be">Known problems with the SparcV9 back-end</a>
Misha Brukman500bc302003-11-22 00:38:41 +0000643</div>
644
645<div class="doc_text">
646
647<ul>
Misha Brukmanadb1c392004-07-12 16:55:41 +0000648<li><a href="http://llvm.cs.uiuc.edu/PR60">[sparcv9] SparcV9 backend miscompiles
649several programs in the LLVM test suite</a></li>
Misha Brukman500bc302003-11-22 00:38:41 +0000650</ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000651
Misha Brukman500bc302003-11-22 00:38:41 +0000652</div>
653
654<!-- ======================================================================= -->
655<div class="doc_subsection">
Chris Lattnerf32a5f52004-11-07 01:55:32 +0000656 <a name="ppc-be">Known problems with the PowerPC back-end</a>
657</div>
658
659<div class="doc_text">
660
661<ul>
662<li>none yet</li>
663</ul>
664
665</div>
666
667<!-- ======================================================================= -->
668<div class="doc_subsection">
Misha Brukman500bc302003-11-22 00:38:41 +0000669 <a name="c-be">Known problems with the C back-end</a>
670</div>
671
672<div class="doc_text">
673
674<ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000675
676<li>The C back-end produces code that violates the ANSI C Type-Based Alias
677Analysis rules. As such, special options may be necessary to compile the code
678(for example, GCC requires the <tt>-fno-strict-aliasing</tt> option). This
Misha Brukman500bc302003-11-22 00:38:41 +0000679problem probably cannot be fixed.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000680
Chris Lattner2855ecd2003-11-04 20:06:53 +0000681<li><a href="http://llvm.cs.uiuc.edu/PR56">Zero arg vararg functions are not
Chris Lattner2af46052003-10-24 04:03:19 +0000682supported</a>. This should not affect LLVM produced by the C or C++
Misha Brukman500bc302003-11-22 00:38:41 +0000683frontends.</li>
Chris Lattner2af46052003-10-24 04:03:19 +0000684
Misha Brukman500bc302003-11-22 00:38:41 +0000685</ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000686
Misha Brukman500bc302003-11-22 00:38:41 +0000687</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000688
689<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000690<div class="doc_section">
691 <a name="additionalinfo">Additional Information</a>
692</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000693<!-- *********************************************************************** -->
694
Misha Brukman500bc302003-11-22 00:38:41 +0000695<div class="doc_text">
696
697<p>A wide variety of additional information is available on the LLVM web page,
John Criswelld000e1d2003-12-18 16:43:17 +0000698including mailing lists and publications describing algorithms and components
Chris Lattner79c3fe12003-10-02 04:57:28 +0000699implemented in LLVM. The web page also contains versions of the API
700documentation which is up-to-date with the CVS version of the source code. You
701can access versions of these documents specific to this release by going into
Misha Brukman500bc302003-11-22 00:38:41 +0000702the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000703
Misha Brukman500bc302003-11-22 00:38:41 +0000704<p>If you have any questions or comments about LLVM, please feel free to contact
Chris Lattner5eccca42003-12-12 21:22:16 +0000705us via the <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">mailing
706lists</a>.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000707
Misha Brukman500bc302003-11-22 00:38:41 +0000708</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000709
710<!-- *********************************************************************** -->
Chris Lattner79c3fe12003-10-02 04:57:28 +0000711
Misha Brukman500bc302003-11-22 00:38:41 +0000712<hr>
Misha Brukman2061e892003-11-22 01:23:39 +0000713<address>
Misha Brukman38847d52003-12-21 22:53:21 +0000714 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman2061e892003-11-22 01:23:39 +0000715 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
716 <a href="http://validator.w3.org/check/referer"><img
717 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
718
Misha Brukmane0c891c2003-11-22 01:00:11 +0000719 <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br>
Misha Brukman500bc302003-11-22 00:38:41 +0000720 Last modified: $Date$
Misha Brukman2061e892003-11-22 01:23:39 +0000721</address>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000722
Misha Brukman500bc302003-11-22 00:38:41 +0000723</body>
724</html>