blob: 19d15d97b36d229d6e9e4edc0c59cb7db376821e [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 Lattner000c73b2008-02-06 06:30:34 +00007 <title>LLVM 2.2 Release Notes</title>
Misha Brukman500bc302003-11-22 00:38:41 +00008</head>
9<body>
Chris Lattner79c3fe12003-10-02 04:57:28 +000010
Chris Lattner000c73b2008-02-06 06:30:34 +000011<div class="doc_title">LLVM 2.2 Release Notes</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +000012
13<ol>
Misha Brukman500bc302003-11-22 00:38:41 +000014 <li><a href="#intro">Introduction</a></li>
15 <li><a href="#whatsnew">What's New?</a></li>
Chris Lattner4b538b92004-04-30 22:17:12 +000016 <li><a href="GettingStarted.html">Installation Instructions</a></li>
Misha Brukman500bc302003-11-22 00:38:41 +000017 <li><a href="#portability">Portability and Supported Platforms</a></li>
Chris Lattner79c3fe12003-10-02 04:57:28 +000018 <li><a href="#knownproblems">Known Problems</a>
Misha Brukman500bc302003-11-22 00:38:41 +000019 <li><a href="#additionalinfo">Additional Information</a></li>
Chris Lattner79c3fe12003-10-02 04:57:28 +000020</ol>
21
Chris Lattner7911ce22004-05-23 21:07:27 +000022<div class="doc_author">
Chris Lattnerc463b272005-10-29 07:07:09 +000023 <p>Written by the <a href="http://llvm.org">LLVM Team</a><p>
Misha Brukman500bc302003-11-22 00:38:41 +000024</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +000025
Chris Lattner052bae62008-02-06 18:00:48 +000026<h1><font color="red">THIS IS A WORK IN PROGRESS FOR THE LLVM 2.2
27RELEASE</font</h1>
28
Chris Lattner79c3fe12003-10-02 04:57:28 +000029<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +000030<div class="doc_section">
31 <a name="intro">Introduction</a>
32</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +000033<!-- *********************************************************************** -->
34
Misha Brukman500bc302003-11-22 00:38:41 +000035<div class="doc_text">
36
37<p>This document contains the release notes for the LLVM compiler
Chris Lattner000c73b2008-02-06 06:30:34 +000038infrastructure, release 2.2. Here we describe the status of LLVM, including
Chris Lattner57a460e2007-05-23 04:39:32 +000039major improvements from the previous release and any known problems. All LLVM
Chris Lattnercaf06342007-05-09 04:58:11 +000040releases may be downloaded from the <a href="http://llvm.org/releases/">LLVM
Chris Lattner57a460e2007-05-23 04:39:32 +000041releases web site</a>.</p>
Chris Lattner19092612003-10-02 16:38:05 +000042
Chris Lattner7506b1d2004-12-07 08:04:13 +000043<p>For more information about LLVM, including information about the latest
Chris Lattnerc463b272005-10-29 07:07:09 +000044release, please check out the <a href="http://llvm.org/">main LLVM
Chris Lattner47ad72c2003-10-07 21:38:31 +000045web site</a>. If you have questions or comments, the <a
46href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM developer's mailing
Misha Brukman500bc302003-11-22 00:38:41 +000047list</a> is a good place to send them.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +000048
Reid Spencer669ed452007-07-09 08:04:31 +000049<p>Note that if you are reading this file from a Subversion checkout or the
Chris Lattner84977642007-09-21 03:54:09 +000050main LLVM web page, this document applies to the <i>next</i> release, not the
51current one. To see the release notes for a specific releases, please see the
52<a href="http://llvm.org/releases/">releases page</a>.</p>
Misha Brukman500bc302003-11-22 00:38:41 +000053
54</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +000055
56<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +000057<div class="doc_section">
58 <a name="whatsnew">What's New?</a>
59</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +000060<!-- *********************************************************************** -->
61
Misha Brukman500bc302003-11-22 00:38:41 +000062<div class="doc_text">
63
Chris Lattner000c73b2008-02-06 06:30:34 +000064<p>This is the thirteenth public release of the LLVM Compiler Infrastructure.
65It includes many features and refinements from LLVM 2.1.</p>
Chris Lattnera5099962003-12-06 20:22:41 +000066
Chris Lattner80453c92004-05-24 04:50:25 +000067</div>
68
Chris Lattnera5099962003-12-06 20:22:41 +000069<!--=========================================================================-->
Chris Lattner8a458762005-05-15 05:44:51 +000070<div class="doc_subsection">
Chris Lattner000c73b2008-02-06 06:30:34 +000071<a name="frontends">llvm-gcc 4.0, llvm-gcc 4.2, and clang</a>
Chris Lattner44c933e2006-04-18 06:18:36 +000072</div>
73
Chris Lattnerf3e5bc62007-05-14 06:56:09 +000074<div class="doc_text">
Chris Lattner60893e52007-05-18 06:33:02 +000075
Chris Lattner000c73b2008-02-06 06:30:34 +000076<p>LLVM 2.2 fully supports both the llvm-gcc 4.0 and llvm-gcc 4.2 front-ends (in
77LLVM 2.1, llvm-gcc 4.2 was beta). Since LLVM 2.1, the llvm-gcc 4.2 front-end
78has made leaps and bounds and is now at least as good as 4.0 in virtually every
79area, and is better in several areas (for example, exception handling
80correctness). We strongly recommend that you migrate from llvm-gcc 4.0 to
81llvm-gcc 4.2 in this release cycle because <b>LLVM 2.2 is the last release
82that will support llvm-gcc 4.0</b>: LLVM 2.3 will only support the llvm-gcc
834.2 front-end.</p>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +000084
Chris Lattner252b83d2008-02-06 18:00:06 +000085<p>The <a href="http://clang.llvm.org/">clang project</a> is an effort to build
86a set of new 'llvm native' front-end technologies for the LLVM optimizer
87and code generator. Currently, its C and Objective-C support is maturing
88nicely, and it has advanced source-to-source analysis and transformation
89capabilities. If you are interested in building source-level tools for C and
90Objective-C (and eventually C++), you should take a look. However, note that
91clang is not an official part of the LLVM 2.2 release. If you are interested in
92this project, please see the web site.</p>
93
94</div>
95
96<!--=========================================================================-->
97<div class="doc_subsection">
98<a name="majorfeatures">Major New Features</a>
99</div>
100
101<div class="doc_text">
102
103<p>Dale contributed full support for long double on x86/x86-64 (where it is 80
104bits) and on Darwin PPC/PPC64 (where it is 128 bits).</p>
105
106<p>Ada, gfortran</p>
107
108<p>
109debug improvements -O0
Chris Lattner252b83d2008-02-06 18:00:06 +0000110
111Gordon: GC Revamp. docs/GarbageCollection.html
112
Chris Lattner313d61f2008-02-09 22:58:07 +0000113Kaleidoscope: docs/tutorial
Chris Lattner252b83d2008-02-06 18:00:06 +0000114
115Gordon: C and Ocaml Bindings
Chris Lattner60893e52007-05-18 06:33:02 +0000116
Chris Lattner313d61f2008-02-09 22:58:07 +0000117Christopher Lamb: Multiple address spaces.
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000118</div>
119
Chris Lattner84977642007-09-21 03:54:09 +0000120<!--=========================================================================-->
121<div class="doc_subsection">
122<a name="optimizer">Optimizer Improvements</a>
123</div>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000124
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000125<div class="doc_text">
Chris Lattner84977642007-09-21 03:54:09 +0000126
Chris Lattnerd4298712007-09-26 05:44:21 +0000127<p>Some of the most noticable feature improvements this release have been in the
128optimizer, speeding it up and making it more aggressive. For example:</p>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000129
130<ul>
Tanya Lattnerb6ec3a92007-05-16 23:25:46 +0000131
Chris Lattner313d61f2008-02-09 22:58:07 +0000132<li>Daniel Berlin and Curtis Dunham rewrote Andersen's alias analysis (which is
133not enabled by default) to be several orders of magnitude faster, implemented
134Offline Variable Substitution.</li>
Chris Lattner252b83d2008-02-06 18:00:06 +0000135
136Devang: LoopIndexSplit is enabled by default.
Chris Lattner313d61f2008-02-09 22:58:07 +0000137
138Dan Gohman: LSR improvements for SSE intrinsics and
139
140Evan added simple exit value substitution to LSR.
141
142Anton added readnone/readonly attributes for modelling GCC pure/const
143attributes.
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000144</ul>
Chris Lattner84977642007-09-21 03:54:09 +0000145
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000146</div>
147
Chris Lattner84977642007-09-21 03:54:09 +0000148<!--=========================================================================-->
149<div class="doc_subsection">
150<a name="codegen">Code Generator Improvements</a>
151</div>
152
153<div class="doc_text">
154
Chris Lattner252b83d2008-02-06 18:00:06 +0000155<p>foci of this release was performance tuning and bug
Chris Lattnerd4298712007-09-26 05:44:21 +0000156 fixing. In addition to these, several new major changes occurred:</p>
157
Chris Lattner84977642007-09-21 03:54:09 +0000158<ul>
159
Chris Lattner6b1a4ec2008-02-06 18:32:06 +0000160<li>Owen contributed Machine Loop info, domintors, etc. Merged dom and
161 postdom.</li>
Chris Lattner84977642007-09-21 03:54:09 +0000162
Chris Lattner252b83d2008-02-06 18:00:06 +0000163<li>Dan added support for emitting debug information with .file and .loc on
164targets that support it</li>
165
166<li>Evan physical register dependencies in the BURR scheduler</li>
Chris Lattner6b1a4ec2008-02-06 18:32:06 +0000167
168<li>Evan EXTRACT_SUBREG coalescing support</li>
Chris Lattner313d61f2008-02-09 22:58:07 +0000169<li>Evan enhanced LSR to support induction variable reuse when the induction
170 variables have different widths.</li>
171
172<li>Rafael Espindola byval support, finished by Evan.</li>
173
174<li>mod/ref info for machineinstrs</li>
175
176<li>Evan: Live interval splitting on MBB boundaries.</li>
Chris Lattner84977642007-09-21 03:54:09 +0000177</ul>
178
179</div>
180
181
182<!--=========================================================================-->
183<div class="doc_subsection">
184<a name="targetspecific">Target Specific Improvements</a>
185</div>
Chris Lattner60893e52007-05-18 06:33:02 +0000186
Chris Lattner738bd302006-04-18 06:32:08 +0000187<div class="doc_text">
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000188<p>New features include:
189</p>
Chris Lattner26299222006-11-18 07:51:14 +0000190
191<ul>
Chris Lattner252b83d2008-02-06 18:00:06 +0000192<li>Evan X86 now models EFLAGS in instructions.</li>
193<li>Evan: If conversion on by default for ARM.</li>
Chris Lattner6b1a4ec2008-02-06 18:32:06 +0000194<li>Bruno: MIPS PIC support.</li>
195<li>Arnold Schwaighofer: X86 tail call support.</li>
Chris Lattner313d61f2008-02-09 22:58:07 +0000196<li>Dale darwin/x86-64 and darwin/ppc eh</li>
197<li>Evan: darwin/x86 debug info</li>
Chris Lattner84977642007-09-21 03:54:09 +0000198</ul>
199
200</div>
Chris Lattner57a460e2007-05-23 04:39:32 +0000201
Chris Lattner57a460e2007-05-23 04:39:32 +0000202
Chris Lattner84977642007-09-21 03:54:09 +0000203<!--=========================================================================-->
204<div class="doc_subsection">
205<a name="llvmgccimprovements">llvm-gcc Improvements</a>
206</div>
Tanya Lattnerb6ec3a92007-05-16 23:25:46 +0000207
Chris Lattner84977642007-09-21 03:54:09 +0000208<div class="doc_text">
209<p>New features include:
210</p>
Tanya Lattnerb6ec3a92007-05-16 23:25:46 +0000211
Chris Lattner84977642007-09-21 03:54:09 +0000212<ul>
Chris Lattner000c73b2008-02-06 06:30:34 +0000213<li>.</li>
Chris Lattner26299222006-11-18 07:51:14 +0000214</ul>
215
Chris Lattner738bd302006-04-18 06:32:08 +0000216</div>
217
Chris Lattner84977642007-09-21 03:54:09 +0000218
219<!--=========================================================================-->
220<div class="doc_subsection">
221<a name="coreimprovements">LLVM Core Improvements</a>
222</div>
Chris Lattner26299222006-11-18 07:51:14 +0000223
Chris Lattner1c1a85c2006-04-19 04:02:47 +0000224<div class="doc_text">
Chris Lattner84977642007-09-21 03:54:09 +0000225<p>New features include:
Chris Lattner26299222006-11-18 07:51:14 +0000226</p>
227
228<ul>
Chris Lattner6b1a4ec2008-02-06 18:32:06 +0000229<li>Devang added LLVMFoldingBuilder.</li>
230<li>Dan added support for vector sin, cos, and pow intrinsics.</li>
Chris Lattner313d61f2008-02-09 22:58:07 +0000231<li>Ted added a framework for generic object serialization to bitcode files,
232 only used by clang right now for ASTs but could be used for other
233 stuff.</li>
234<li>Duncan fixed TargetData to distinguish between the size/alignment of a type
235 in a register, in memory according to the platform ABI, and in memory when
236 we have a choice.</li>
Chris Lattnerbfb17ab2007-05-17 21:41:31 +0000237</ul>
Chris Lattner84977642007-09-21 03:54:09 +0000238
Chris Lattnerbfb17ab2007-05-17 21:41:31 +0000239</div>
Chris Lattnerc5d658a2006-03-03 00:34:26 +0000240
Chris Lattner84977642007-09-21 03:54:09 +0000241<!--=========================================================================-->
242<div class="doc_subsection">
243<a name="otherimprovements">Other Improvements</a>
244</div>
245
246<div class="doc_text">
247<p>New features include:
248</p>
249
250<ul>
Chris Lattner313d61f2008-02-09 22:58:07 +0000251<li>Gordon Henriksen updated docs/Passes.html</li>
252<li>New lexer and parser for tblgen, new lexer for asmparser</li>
Chris Lattner84977642007-09-21 03:54:09 +0000253</ul>
254
255</div>
Chris Lattnerc5d658a2006-03-03 00:34:26 +0000256
Chris Lattner19092612003-10-02 16:38:05 +0000257<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000258<div class="doc_section">
259 <a name="portability">Portability and Supported Platforms</a>
260</div>
Chris Lattner19092612003-10-02 16:38:05 +0000261<!-- *********************************************************************** -->
262
Misha Brukman500bc302003-11-22 00:38:41 +0000263<div class="doc_text">
264
John Criswell0b5b5e92004-12-08 20:35:47 +0000265<p>LLVM is known to work on the following platforms:</p>
Chris Lattner4654bdb2004-06-01 18:22:41 +0000266
267<ul>
Chris Lattner57a460e2007-05-23 04:39:32 +0000268<li>Intel and AMD machines running Red Hat Linux, Fedora Core and FreeBSD
Reid Spencer00812e22005-05-17 02:47:27 +0000269 (and probably other unix-like systems).</li>
Chris Lattner000c73b2008-02-06 06:30:34 +0000270<li>PowerPC and X86-based Mac OS X systems, running 10.3 and above in 32-bit and
Chris Lattner26299222006-11-18 07:51:14 +0000271 64-bit modes.</li>
Chris Lattner252b83d2008-02-06 18:00:06 +0000272<li>Intel and AMD machines running on Win32 using MinGW libraries (native).</li>
Chris Lattner57a460e2007-05-23 04:39:32 +0000273<li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
274 support is available for native builds with Visual C++).</li>
275<li>Sun UltraSPARC workstations running Solaris 8.</li>
John Criswell9321fa82005-05-13 20:28:15 +0000276<li>Alpha-based machines running Debian GNU/Linux.</li>
277<li>Itanium-based machines running Linux and HP-UX.</li>
Chris Lattner4654bdb2004-06-01 18:22:41 +0000278</ul>
279
Brian Gaekeb0fd7612004-05-09 05:28:35 +0000280<p>The core LLVM infrastructure uses
281<a href="http://www.gnu.org/software/autoconf/">GNU autoconf</a> to adapt itself
282to the machine and operating system on which it is built. However, minor
283porting may be required to get LLVM to work on new platforms. We welcome your
284portability patches and reports of successful builds or error messages.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000285
Misha Brukman500bc302003-11-22 00:38:41 +0000286</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000287
288<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000289<div class="doc_section">
290 <a name="knownproblems">Known Problems</a>
291</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000292<!-- *********************************************************************** -->
293
Misha Brukman500bc302003-11-22 00:38:41 +0000294<div class="doc_text">
295
296<p>This section contains all known problems with the LLVM system, listed by
Chris Lattner79c3fe12003-10-02 04:57:28 +0000297component. As new problems are discovered, they will be added to these
Chris Lattner5eccca42003-12-12 21:22:16 +0000298sections. If you run into a problem, please check the <a
Chris Lattnerc463b272005-10-29 07:07:09 +0000299href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
Chris Lattner5eccca42003-12-12 21:22:16 +0000300there isn't already one.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000301
Misha Brukman500bc302003-11-22 00:38:41 +0000302</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000303
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000304<!-- ======================================================================= -->
305<div class="doc_subsection">
306 <a name="experimental">Experimental features included with this release</a>
307</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000308
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000309<div class="doc_text">
310
Misha Brukman6df9e2c2004-05-12 21:46:05 +0000311<p>The following components of this LLVM release are either untested, known to
312be broken or unreliable, or are in early development. These components should
313not be relied on, and bugs should not be filed against them, but they may be
314useful to some people. In particular, if you would like to work on one of these
Chris Lattner49e693e2006-08-09 04:08:52 +0000315components, please contact us on the <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p>
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000316
317<ul>
Chris Lattner252b83d2008-02-06 18:00:06 +0000318<li>The <tt>-cee</tt> pass is known to be buggy and will be removed in
319 LLVM 2.3.</li>
Chris Lattner000c73b2008-02-06 06:30:34 +0000320<li>The MSIL, IA64, Alpha, and MIPS backends are experimental.</li>
321<li>The LLC "<tt>-filetype=asm</tt>" (the default) is the only supported
322 value for this option.</li>
323<li>The llvmc tool is not supported.</li>
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000324</ul>
325
326</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000327
Misha Brukman500bc302003-11-22 00:38:41 +0000328<!-- ======================================================================= -->
329<div class="doc_subsection">
Chris Lattner26299222006-11-18 07:51:14 +0000330 <a name="x86-be">Known problems with the X86 back-end</a>
John Criswellc0c186d2005-11-08 21:11:33 +0000331</div>
332
333<div class="doc_text">
334
335<ul>
Chris Lattner26299222006-11-18 07:51:14 +0000336<li>The X86 backend does not yet support <a href="http://llvm.org/PR879">inline
Chris Lattnercaf06342007-05-09 04:58:11 +0000337 assembly that uses the X86 floating point stack</a>.</li>
Chris Lattner725a0d82007-09-26 06:01:35 +0000338<li>The X86 backend occasionally has <a href="http://llvm.org/PR1649">alignment
339 problems</a> on operating systems that don't require 16-byte stack alignment
340 (including most non-darwin OS's like linux).</li>
Chris Lattner26299222006-11-18 07:51:14 +0000341</ul>
342
343</div>
344
345<!-- ======================================================================= -->
346<div class="doc_subsection">
347 <a name="ppc-be">Known problems with the PowerPC back-end</a>
348</div>
349
350<div class="doc_text">
351
352<ul>
Nicolas Geoffraye4285dc2007-05-15 09:21:28 +0000353<li>The Linux PPC32/ABI support needs testing for the interpreter and static
Chris Lattner57a460e2007-05-23 04:39:32 +0000354compilation, and lacks support for debug information.</li>
Chris Lattner26299222006-11-18 07:51:14 +0000355</ul>
356
357</div>
358
359<!-- ======================================================================= -->
360<div class="doc_subsection">
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000361 <a name="arm-be">Known problems with the ARM back-end</a>
362</div>
363
364<div class="doc_text">
365
366<ul>
Chris Lattner57a460e2007-05-23 04:39:32 +0000367<li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
Duncan Sandsc90d68b2007-09-26 15:59:54 +0000368processors, thumb programs can crash or produce wrong
Chris Lattner57a460e2007-05-23 04:39:32 +0000369results (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000370<li>Compilation for ARM Linux OABI (old ABI) is supported, but not fully tested.
371</li>
Chris Lattner57a460e2007-05-23 04:39:32 +0000372<li>There is a bug in QEMU-ARM (<= 0.9.0) which causes it to incorrectly execute
373programs compiled with LLVM. Please use more recent versions of QEMU.</li>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000374</ul>
375
376</div>
377
378<!-- ======================================================================= -->
379<div class="doc_subsection">
Chris Lattner26299222006-11-18 07:51:14 +0000380 <a name="sparc-be">Known problems with the SPARC back-end</a>
381</div>
382
383<div class="doc_text">
384
385<ul>
386<li>The SPARC backend only supports the 32-bit SPARC ABI (-m32), it does not
387 support the 64-bit SPARC ABI (-m64).</li>
388</ul>
389
390</div>
391
392<!-- ======================================================================= -->
393<div class="doc_subsection">
Chris Lattner26299222006-11-18 07:51:14 +0000394 <a name="alpha-be">Known problems with the Alpha back-end</a>
395</div>
396
397<div class="doc_text">
398
399<ul>
400
401<li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
402appropriate nops inserted to ensure restartability.</li>
403
John Criswellc0c186d2005-11-08 21:11:33 +0000404</ul>
405</div>
406
Chris Lattner26299222006-11-18 07:51:14 +0000407<!-- ======================================================================= -->
408<div class="doc_subsection">
409 <a name="ia64-be">Known problems with the IA64 back-end</a>
410</div>
411
412<div class="doc_text">
413
414<ul>
415
416<li>C++ programs are likely to fail on IA64, as calls to <tt>setjmp</tt> are
417made where the argument is not 16-byte aligned, as required on IA64. (Strictly
418speaking this is not a bug in the IA64 back-end; it will also be encountered
419when building C++ programs using the C back-end.)</li>
420
421<li>The C++ front-end does not use <a href="http://llvm.org/PR406">IA64
422ABI compliant layout of v-tables</a>. In particular, it just stores function
423pointers instead of function descriptors in the vtable. This bug prevents
424mixing C++ code compiled with LLVM with C++ objects compiled by other C++
425compilers.</li>
426
427<li>There are a few ABI violations which will lead to problems when mixing LLVM
428output with code built with other compilers, particularly for floating-point
429programs.</li>
430
431<li>Defining vararg functions is not supported (but calling them is ok).</li>
432
Chris Lattnercaf06342007-05-09 04:58:11 +0000433<li>The Itanium backend has bitrotted somewhat.</li>
Chris Lattner26299222006-11-18 07:51:14 +0000434</ul>
435
436</div>
437
438<!-- ======================================================================= -->
439<div class="doc_subsection">
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000440 <a name="c-be">Known problems with the C back-end</a>
Chris Lattner26299222006-11-18 07:51:14 +0000441</div>
442
443<div class="doc_text">
444
445<ul>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000446<li><a href="http://llvm.org/PR802">The C backend does not support inline
447 assembly code</a>.</li>
Chris Lattner725a0d82007-09-26 06:01:35 +0000448<li><a href="http://llvm.org/PR1126">The C backend does not support vectors
449 yet</a>.</li>
Chris Lattner725a0d82007-09-26 06:01:35 +0000450<li><a href="http://llvm.org/PR1658">The C backend violates the ABI of common
451 C++ programs</a>, preventing intermixing between C++ compiled by the CBE and
452 C++ code compiled with LLC or native compilers.</li>
Chris Lattner26299222006-11-18 07:51:14 +0000453</ul>
454
455</div>
John Criswellc0c186d2005-11-08 21:11:33 +0000456
Misha Brukman500bc302003-11-22 00:38:41 +0000457
458<!-- ======================================================================= -->
459<div class="doc_subsection">
460 <a name="c-fe">Known problems with the C front-end</a>
461</div>
Chris Lattner47588f92003-10-02 05:07:23 +0000462
Chris Lattner79c3fe12003-10-02 04:57:28 +0000463<!-- _______________________________________________________________________ -->
Chris Lattnerb40efb32003-12-14 05:03:43 +0000464<div class="doc_subsubsection">Bugs</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000465
Misha Brukman500bc302003-11-22 00:38:41 +0000466<div class="doc_text">
Chris Lattnerc5d658a2006-03-03 00:34:26 +0000467
Chris Lattner252b83d2008-02-06 18:00:06 +0000468<p>llvm-gcc does not currently support <a href="http://llvm.org/PR869">Link-Time
469Optimization</a> on most platforms "out-of-the-box". Please inquire on the
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000470llvmdev mailing list if you are interested.</p>
Chris Lattnerd9ea0172006-08-08 17:27:28 +0000471
Misha Brukman500bc302003-11-22 00:38:41 +0000472</div>
473
474<!-- _______________________________________________________________________ -->
475<div class="doc_subsubsection">
476 Notes
477</div>
478
479<div class="doc_text">
Misha Brukman500bc302003-11-22 00:38:41 +0000480<ul>
481
Chris Lattnerd09c4ec2007-05-17 22:02:24 +0000482<li><p>llvm-gcc does <b>not</b> support <tt>__builtin_apply</tt> yet.
483 See <a href="http://gcc.gnu.org/onlinedocs/gcc/Constructing-Calls.html#Constructing%20Calls">Constructing Calls</a>: Dispatching a call to another function.</p>
484</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000485
Duncan Sands32a83442007-05-18 09:04:20 +0000486<li><p>llvm-gcc <b>partially</b> supports these GCC extensions:</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000487 <ol>
Duncan Sandsc90d68b2007-09-26 15:59:54 +0000488 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Nested-Functions.html#Nested%20Functions">Nested Functions</a>:
489
490 As in Algol and Pascal, lexical scoping of functions.
491 Nested functions are supported, but llvm-gcc does not support
Duncan Sands0869f4a2007-09-26 16:24:52 +0000492 taking the address of a nested function (except on the X86-32 target)
Duncan Sandsc90d68b2007-09-26 15:59:54 +0000493 or non-local gotos.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000494
495 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Attributes.html#Function%20Attributes">Function Attributes</a>:
Misha Brukman500bc302003-11-22 00:38:41 +0000496
John Criswelld000e1d2003-12-18 16:43:17 +0000497 Declaring that functions have no side effects or that they can never
Misha Brukman500bc302003-11-22 00:38:41 +0000498 return.<br>
499
Anton Korobeynikovbe6fe282007-11-16 11:12:01 +0000500 <b>Supported:</b> <tt>alias</tt>, <tt>always_inline</tt>, <tt>cdecl</tt>,
501 <tt>const</tt>, <tt>constructor</tt>, <tt>destructor</tt>,
Anton Korobeynikov9413de32006-11-18 08:04:48 +0000502 <tt>deprecated</tt>, <tt>fastcall</tt>, <tt>format</tt>,
Anton Korobeynikovbe6fe282007-11-16 11:12:01 +0000503 <tt>format_arg</tt>, <tt>non_null</tt>, <tt>noinline</tt>,
504 <tt>noreturn</tt>, <tt>pure</tt>, <tt>regparm</tt>
Anton Korobeynikov8cea37b2007-01-23 12:35:46 +0000505 <tt>section</tt>, <tt>stdcall</tt>, <tt>unused</tt>, <tt>used</tt>,
506 <tt>visibility</tt>, <tt>warn_unused_result</tt>, <tt>weak</tt><br>
Misha Brukman500bc302003-11-22 00:38:41 +0000507
Anton Korobeynikovbe6fe282007-11-16 11:12:01 +0000508 <b>Ignored:</b> <tt>nothrow</tt>, <tt>malloc</tt>,
509 <tt>no_instrument_function</tt></li>
Misha Brukman500bc302003-11-22 00:38:41 +0000510 </ol>
Chris Lattnerd09c4ec2007-05-17 22:02:24 +0000511</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000512
Chris Lattnerd09c4ec2007-05-17 22:02:24 +0000513<li><p>llvm-gcc supports the vast majority of GCC extensions, including:</p>
Misha Brukman500bc302003-11-22 00:38:41 +0000514
Chris Lattner79c3fe12003-10-02 04:57:28 +0000515 <ol>
Chris Lattnerd09c4ec2007-05-17 22:02:24 +0000516 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Pragmas.html#Pragmas">Pragmas</a>: Pragmas accepted by GCC.</li>
517 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Local-Labels.html#Local%20Labels">Local Labels</a>: Labels local to a block.</li>
518 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Other-Builtins.html#Other%20Builtins">Other Builtins</a>:
519 Other built-in functions.</li>
520 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Attributes.html#Variable%20Attributes">Variable Attributes</a>:
521 Specifying attributes of variables.</li>
522 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Type-Attributes.html#Type%20Attributes">Type Attributes</a>: Specifying attributes of types.</li>
523 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Thread_002dLocal.html">Thread-Local</a>: Per-thread variables.</li>
524 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Length.html#Variable%20Length">Variable Length</a>:
525 Arrays whose length is computed at run time.</li>
Chris Lattner7fe97dd2004-03-16 08:54:07 +0000526 <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 +0000527 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Statement-Exprs.html#Statement%20Exprs">Statement Exprs</a>: Putting statements and declarations inside expressions.</li>
528 <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 +0000529 <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 +0000530 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Conditionals.html#Conditionals">Conditionals</a>: Omitting the middle operand of a <code>?:</code> expression.</li>
531 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Long-Long.html#Long%20Long">Long Long</a>: Double-word integers.</li>
532 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Complex.html#Complex">Complex</a>: Data types for complex numbers.</li>
533 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Hex-Floats.html#Hex%20Floats">Hex Floats</a>:Hexadecimal floating-point constants.</li>
534 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Zero-Length.html#Zero%20Length">Zero Length</a>: Zero-length arrays.</li>
535 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Empty-Structures.html#Empty%20Structures">Empty Structures</a>: Structures with no members.</li>
536 <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>
537 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Escaped-Newlines.html#Escaped%20Newlines">Escaped Newlines</a>: Slightly looser rules for escaped newlines.</li>
Chris Lattner26299222006-11-18 07:51:14 +0000538 <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>
539 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Constraints.html#Constraints">Constraints</a>: Constraints for asm operands.</li>
540 <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>
541 <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>
542 <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>
543 <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>
Misha Brukman500bc302003-11-22 00:38:41 +0000544 <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 +0000545 <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 +0000546 <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 +0000547 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Compound-Literals.html#Compound%20Literals">Compound Literals</a>: Compound literals give structures, unions,
548or arrays as values.</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000549 <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 +0000550 <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 +0000551 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Case-Ranges.html#Case%20Ranges">Case Ranges</a>: `case 1 ... 9' and such.</li>
552 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Mixed-Declarations.html#Mixed%20Declarations">Mixed Declarations</a>: Mixing declarations and code.</li>
553 <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 +0000554 <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 +0000555 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Dollar-Signs.html#Dollar%20Signs">Dollar Signs</a>: Dollar sign is allowed in identifiers.</li>
556 <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>
557 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Alignment.html#Alignment">Alignment</a>: Inquiring about the alignment of a type or variable.</li>
558 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Inline.html#Inline">Inline</a>: Defining inline functions (as fast as macros).</li>
559 <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>
560 <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>
561 <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 +0000562 <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 +0000563 <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>
564 <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 +0000565 </ol></li>
566
567</ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000568
Misha Brukman500bc302003-11-22 00:38:41 +0000569<p>If you run into GCC extensions which have not been included in any of these
570lists, please let us know (also including whether or not they work).</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000571
Misha Brukman500bc302003-11-22 00:38:41 +0000572</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000573
Misha Brukman500bc302003-11-22 00:38:41 +0000574<!-- ======================================================================= -->
575<div class="doc_subsection">
576 <a name="c++-fe">Known problems with the C++ front-end</a>
577</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000578
Misha Brukman500bc302003-11-22 00:38:41 +0000579<div class="doc_text">
580
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000581<p>The C++ front-end is considered to be fully
Chris Lattner7506b1d2004-12-07 08:04:13 +0000582tested and works for a number of non-trivial programs, including LLVM
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000583itself, Qt, Mozilla, etc.</p>
Misha Brukman500bc302003-11-22 00:38:41 +0000584
Misha Brukman500bc302003-11-22 00:38:41 +0000585<ul>
Chris Lattner000c73b2008-02-06 06:30:34 +0000586<li>Exception handling only works well on the X86 and PowerPC targets.</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000587</ul>
Chris Lattnerfcc54b32003-10-07 22:14:37 +0000588
Misha Brukman500bc302003-11-22 00:38:41 +0000589</div>
590
Misha Brukman500bc302003-11-22 00:38:41 +0000591
Chris Lattner98a493c2005-05-15 16:01:20 +0000592
Chris Lattner79c3fe12003-10-02 04:57:28 +0000593<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000594<div class="doc_section">
595 <a name="additionalinfo">Additional Information</a>
596</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000597<!-- *********************************************************************** -->
598
Misha Brukman500bc302003-11-22 00:38:41 +0000599<div class="doc_text">
600
Chris Lattner416db102005-05-16 17:13:10 +0000601<p>A wide variety of additional information is available on the <a
Chris Lattnerb4b0ce72007-05-18 00:44:29 +0000602href="http://llvm.org">LLVM web page</a>, in particular in the <a
603href="http://llvm.org/docs/">documentation</a> section. The web page also
Reid Spencer669ed452007-07-09 08:04:31 +0000604contains versions of the API documentation which is up-to-date with the
605Subversion version of the source code.
Misha Brukman109d9e82005-03-30 19:14:24 +0000606You can access versions of these documents specific to this release by going
607into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000608
Misha Brukman500bc302003-11-22 00:38:41 +0000609<p>If you have any questions or comments about LLVM, please feel free to contact
Chris Lattnerc463b272005-10-29 07:07:09 +0000610us via the <a href="http://llvm.org/docs/#maillist"> mailing
Chris Lattner5eccca42003-12-12 21:22:16 +0000611lists</a>.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000612
Misha Brukman500bc302003-11-22 00:38:41 +0000613</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000614
615<!-- *********************************************************************** -->
Chris Lattner79c3fe12003-10-02 04:57:28 +0000616
Misha Brukman500bc302003-11-22 00:38:41 +0000617<hr>
Misha Brukman2061e892003-11-22 01:23:39 +0000618<address>
Misha Brukman38847d52003-12-21 22:53:21 +0000619 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman2061e892003-11-22 01:23:39 +0000620 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
621 <a href="http://validator.w3.org/check/referer"><img
622 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
623
Chris Lattnerb4b0ce72007-05-18 00:44:29 +0000624 <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
Misha Brukman500bc302003-11-22 00:38:41 +0000625 Last modified: $Date$
Misha Brukman2061e892003-11-22 01:23:39 +0000626</address>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000627
Misha Brukman500bc302003-11-22 00:38:41 +0000628</body>
629</html>