blob: d8835b10273143983956e312b91967cbefdf8d30 [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
110EH.
111
112Gordon: GC Revamp. docs/GarbageCollection.html
113
114Kaleidescope: docs/tutorial
115
116Gordon: C and Ocaml Bindings
Chris Lattner60893e52007-05-18 06:33:02 +0000117
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 Lattner252b83d2008-02-06 18:00:06 +0000132<li>Daniel Berlin and (?) rewrote Andersen's alias analysis (which is not
133enabled by default) to be several orders of magnitude faster, implmented Offline
134Variable Substitution.</li>
Tanya Lattnerb6ec3a92007-05-16 23:25:46 +0000135
Chris Lattner252b83d2008-02-06 18:00:06 +0000136
137Devang: LoopIndexSplit is enabled by default.
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000138</ul>
Chris Lattner84977642007-09-21 03:54:09 +0000139
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000140</div>
141
Chris Lattner84977642007-09-21 03:54:09 +0000142<!--=========================================================================-->
143<div class="doc_subsection">
144<a name="codegen">Code Generator Improvements</a>
145</div>
146
147<div class="doc_text">
148
Chris Lattner252b83d2008-02-06 18:00:06 +0000149<p>foci of this release was performance tuning and bug
Chris Lattnerd4298712007-09-26 05:44:21 +0000150 fixing. In addition to these, several new major changes occurred:</p>
151
Chris Lattner84977642007-09-21 03:54:09 +0000152<ul>
153
Chris Lattner252b83d2008-02-06 18:00:06 +0000154<li>Owen contributed Machine Loop info, domintors, etc.</li>
Chris Lattner84977642007-09-21 03:54:09 +0000155
Chris Lattner252b83d2008-02-06 18:00:06 +0000156<li>Dan added support for emitting debug information with .file and .loc on
157targets that support it</li>
158
159<li>Evan physical register dependencies in the BURR scheduler</li>
Chris Lattner84977642007-09-21 03:54:09 +0000160</ul>
161
162</div>
163
164
165<!--=========================================================================-->
166<div class="doc_subsection">
167<a name="targetspecific">Target Specific Improvements</a>
168</div>
Chris Lattner60893e52007-05-18 06:33:02 +0000169
Chris Lattner738bd302006-04-18 06:32:08 +0000170<div class="doc_text">
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000171<p>New features include:
172</p>
Chris Lattner26299222006-11-18 07:51:14 +0000173
174<ul>
Chris Lattner252b83d2008-02-06 18:00:06 +0000175<li>Evan X86 now models EFLAGS in instructions.</li>
176<li>Evan: If conversion on by default for ARM.</li>
Chris Lattner84977642007-09-21 03:54:09 +0000177</ul>
178
179</div>
Chris Lattner57a460e2007-05-23 04:39:32 +0000180
Chris Lattner57a460e2007-05-23 04:39:32 +0000181
Chris Lattner84977642007-09-21 03:54:09 +0000182<!--=========================================================================-->
183<div class="doc_subsection">
184<a name="llvmgccimprovements">llvm-gcc Improvements</a>
185</div>
Tanya Lattnerb6ec3a92007-05-16 23:25:46 +0000186
Chris Lattner84977642007-09-21 03:54:09 +0000187<div class="doc_text">
188<p>New features include:
189</p>
Tanya Lattnerb6ec3a92007-05-16 23:25:46 +0000190
Chris Lattner84977642007-09-21 03:54:09 +0000191<ul>
Chris Lattner000c73b2008-02-06 06:30:34 +0000192<li>.</li>
Chris Lattner26299222006-11-18 07:51:14 +0000193</ul>
194
Chris Lattner738bd302006-04-18 06:32:08 +0000195</div>
196
Chris Lattner84977642007-09-21 03:54:09 +0000197
198<!--=========================================================================-->
199<div class="doc_subsection">
200<a name="coreimprovements">LLVM Core Improvements</a>
201</div>
Chris Lattner26299222006-11-18 07:51:14 +0000202
Chris Lattner1c1a85c2006-04-19 04:02:47 +0000203<div class="doc_text">
Chris Lattner84977642007-09-21 03:54:09 +0000204<p>New features include:
Chris Lattner26299222006-11-18 07:51:14 +0000205</p>
206
207<ul>
Chris Lattner000c73b2008-02-06 06:30:34 +0000208<li>.</li>
Chris Lattnerbfb17ab2007-05-17 21:41:31 +0000209</ul>
Chris Lattner84977642007-09-21 03:54:09 +0000210
Chris Lattnerbfb17ab2007-05-17 21:41:31 +0000211</div>
Chris Lattnerc5d658a2006-03-03 00:34:26 +0000212
Chris Lattner84977642007-09-21 03:54:09 +0000213<!--=========================================================================-->
214<div class="doc_subsection">
215<a name="otherimprovements">Other Improvements</a>
216</div>
217
218<div class="doc_text">
219<p>New features include:
220</p>
221
222<ul>
Chris Lattner000c73b2008-02-06 06:30:34 +0000223<li>.</li>
Chris Lattner84977642007-09-21 03:54:09 +0000224</ul>
225
226</div>
Chris Lattnerc5d658a2006-03-03 00:34:26 +0000227
Chris Lattner19092612003-10-02 16:38:05 +0000228<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000229<div class="doc_section">
230 <a name="portability">Portability and Supported Platforms</a>
231</div>
Chris Lattner19092612003-10-02 16:38:05 +0000232<!-- *********************************************************************** -->
233
Misha Brukman500bc302003-11-22 00:38:41 +0000234<div class="doc_text">
235
John Criswell0b5b5e92004-12-08 20:35:47 +0000236<p>LLVM is known to work on the following platforms:</p>
Chris Lattner4654bdb2004-06-01 18:22:41 +0000237
238<ul>
Chris Lattner57a460e2007-05-23 04:39:32 +0000239<li>Intel and AMD machines running Red Hat Linux, Fedora Core and FreeBSD
Reid Spencer00812e22005-05-17 02:47:27 +0000240 (and probably other unix-like systems).</li>
Chris Lattner000c73b2008-02-06 06:30:34 +0000241<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 +0000242 64-bit modes.</li>
Chris Lattner252b83d2008-02-06 18:00:06 +0000243<li>Intel and AMD machines running on Win32 using MinGW libraries (native).</li>
Chris Lattner57a460e2007-05-23 04:39:32 +0000244<li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
245 support is available for native builds with Visual C++).</li>
246<li>Sun UltraSPARC workstations running Solaris 8.</li>
John Criswell9321fa82005-05-13 20:28:15 +0000247<li>Alpha-based machines running Debian GNU/Linux.</li>
248<li>Itanium-based machines running Linux and HP-UX.</li>
Chris Lattner4654bdb2004-06-01 18:22:41 +0000249</ul>
250
Brian Gaekeb0fd7612004-05-09 05:28:35 +0000251<p>The core LLVM infrastructure uses
252<a href="http://www.gnu.org/software/autoconf/">GNU autoconf</a> to adapt itself
253to the machine and operating system on which it is built. However, minor
254porting may be required to get LLVM to work on new platforms. We welcome your
255portability patches and reports of successful builds or error messages.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000256
Misha Brukman500bc302003-11-22 00:38:41 +0000257</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000258
259<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000260<div class="doc_section">
261 <a name="knownproblems">Known Problems</a>
262</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000263<!-- *********************************************************************** -->
264
Misha Brukman500bc302003-11-22 00:38:41 +0000265<div class="doc_text">
266
267<p>This section contains all known problems with the LLVM system, listed by
Chris Lattner79c3fe12003-10-02 04:57:28 +0000268component. As new problems are discovered, they will be added to these
Chris Lattner5eccca42003-12-12 21:22:16 +0000269sections. If you run into a problem, please check the <a
Chris Lattnerc463b272005-10-29 07:07:09 +0000270href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
Chris Lattner5eccca42003-12-12 21:22:16 +0000271there isn't already one.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000272
Misha Brukman500bc302003-11-22 00:38:41 +0000273</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000274
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000275<!-- ======================================================================= -->
276<div class="doc_subsection">
277 <a name="experimental">Experimental features included with this release</a>
278</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000279
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000280<div class="doc_text">
281
Misha Brukman6df9e2c2004-05-12 21:46:05 +0000282<p>The following components of this LLVM release are either untested, known to
283be broken or unreliable, or are in early development. These components should
284not be relied on, and bugs should not be filed against them, but they may be
285useful to some people. In particular, if you would like to work on one of these
Chris Lattner49e693e2006-08-09 04:08:52 +0000286components, 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 +0000287
288<ul>
Chris Lattner252b83d2008-02-06 18:00:06 +0000289<li>The <tt>-cee</tt> pass is known to be buggy and will be removed in
290 LLVM 2.3.</li>
Chris Lattner000c73b2008-02-06 06:30:34 +0000291<li>The MSIL, IA64, Alpha, and MIPS backends are experimental.</li>
292<li>The LLC "<tt>-filetype=asm</tt>" (the default) is the only supported
293 value for this option.</li>
294<li>The llvmc tool is not supported.</li>
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000295</ul>
296
297</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000298
Misha Brukman500bc302003-11-22 00:38:41 +0000299<!-- ======================================================================= -->
300<div class="doc_subsection">
Chris Lattner26299222006-11-18 07:51:14 +0000301 <a name="x86-be">Known problems with the X86 back-end</a>
John Criswellc0c186d2005-11-08 21:11:33 +0000302</div>
303
304<div class="doc_text">
305
306<ul>
Chris Lattner26299222006-11-18 07:51:14 +0000307<li>The X86 backend does not yet support <a href="http://llvm.org/PR879">inline
Chris Lattnercaf06342007-05-09 04:58:11 +0000308 assembly that uses the X86 floating point stack</a>.</li>
Chris Lattner725a0d82007-09-26 06:01:35 +0000309<li>The X86 backend occasionally has <a href="http://llvm.org/PR1649">alignment
310 problems</a> on operating systems that don't require 16-byte stack alignment
311 (including most non-darwin OS's like linux).</li>
Chris Lattner26299222006-11-18 07:51:14 +0000312</ul>
313
314</div>
315
316<!-- ======================================================================= -->
317<div class="doc_subsection">
318 <a name="ppc-be">Known problems with the PowerPC back-end</a>
319</div>
320
321<div class="doc_text">
322
323<ul>
Nicolas Geoffraye4285dc2007-05-15 09:21:28 +0000324<li>The Linux PPC32/ABI support needs testing for the interpreter and static
Chris Lattner57a460e2007-05-23 04:39:32 +0000325compilation, and lacks support for debug information.</li>
Chris Lattner26299222006-11-18 07:51:14 +0000326</ul>
327
328</div>
329
330<!-- ======================================================================= -->
331<div class="doc_subsection">
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000332 <a name="arm-be">Known problems with the ARM back-end</a>
333</div>
334
335<div class="doc_text">
336
337<ul>
Chris Lattner57a460e2007-05-23 04:39:32 +0000338<li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
Duncan Sandsc90d68b2007-09-26 15:59:54 +0000339processors, thumb programs can crash or produce wrong
Chris Lattner57a460e2007-05-23 04:39:32 +0000340results (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000341<li>Compilation for ARM Linux OABI (old ABI) is supported, but not fully tested.
342</li>
Chris Lattner57a460e2007-05-23 04:39:32 +0000343<li>There is a bug in QEMU-ARM (<= 0.9.0) which causes it to incorrectly execute
344programs compiled with LLVM. Please use more recent versions of QEMU.</li>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000345</ul>
346
347</div>
348
349<!-- ======================================================================= -->
350<div class="doc_subsection">
Chris Lattner26299222006-11-18 07:51:14 +0000351 <a name="sparc-be">Known problems with the SPARC back-end</a>
352</div>
353
354<div class="doc_text">
355
356<ul>
357<li>The SPARC backend only supports the 32-bit SPARC ABI (-m32), it does not
358 support the 64-bit SPARC ABI (-m64).</li>
359</ul>
360
361</div>
362
363<!-- ======================================================================= -->
364<div class="doc_subsection">
Chris Lattner26299222006-11-18 07:51:14 +0000365 <a name="alpha-be">Known problems with the Alpha back-end</a>
366</div>
367
368<div class="doc_text">
369
370<ul>
371
372<li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
373appropriate nops inserted to ensure restartability.</li>
374
John Criswellc0c186d2005-11-08 21:11:33 +0000375</ul>
376</div>
377
Chris Lattner26299222006-11-18 07:51:14 +0000378<!-- ======================================================================= -->
379<div class="doc_subsection">
380 <a name="ia64-be">Known problems with the IA64 back-end</a>
381</div>
382
383<div class="doc_text">
384
385<ul>
386
387<li>C++ programs are likely to fail on IA64, as calls to <tt>setjmp</tt> are
388made where the argument is not 16-byte aligned, as required on IA64. (Strictly
389speaking this is not a bug in the IA64 back-end; it will also be encountered
390when building C++ programs using the C back-end.)</li>
391
392<li>The C++ front-end does not use <a href="http://llvm.org/PR406">IA64
393ABI compliant layout of v-tables</a>. In particular, it just stores function
394pointers instead of function descriptors in the vtable. This bug prevents
395mixing C++ code compiled with LLVM with C++ objects compiled by other C++
396compilers.</li>
397
398<li>There are a few ABI violations which will lead to problems when mixing LLVM
399output with code built with other compilers, particularly for floating-point
400programs.</li>
401
402<li>Defining vararg functions is not supported (but calling them is ok).</li>
403
Chris Lattnercaf06342007-05-09 04:58:11 +0000404<li>The Itanium backend has bitrotted somewhat.</li>
Chris Lattner26299222006-11-18 07:51:14 +0000405</ul>
406
407</div>
408
409<!-- ======================================================================= -->
410<div class="doc_subsection">
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000411 <a name="c-be">Known problems with the C back-end</a>
Chris Lattner26299222006-11-18 07:51:14 +0000412</div>
413
414<div class="doc_text">
415
416<ul>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000417<li><a href="http://llvm.org/PR802">The C backend does not support inline
418 assembly code</a>.</li>
Chris Lattner725a0d82007-09-26 06:01:35 +0000419<li><a href="http://llvm.org/PR1126">The C backend does not support vectors
420 yet</a>.</li>
Chris Lattner725a0d82007-09-26 06:01:35 +0000421<li><a href="http://llvm.org/PR1658">The C backend violates the ABI of common
422 C++ programs</a>, preventing intermixing between C++ compiled by the CBE and
423 C++ code compiled with LLC or native compilers.</li>
Chris Lattner26299222006-11-18 07:51:14 +0000424</ul>
425
426</div>
John Criswellc0c186d2005-11-08 21:11:33 +0000427
Misha Brukman500bc302003-11-22 00:38:41 +0000428
429<!-- ======================================================================= -->
430<div class="doc_subsection">
431 <a name="c-fe">Known problems with the C front-end</a>
432</div>
Chris Lattner47588f92003-10-02 05:07:23 +0000433
Chris Lattner79c3fe12003-10-02 04:57:28 +0000434<!-- _______________________________________________________________________ -->
Chris Lattnerb40efb32003-12-14 05:03:43 +0000435<div class="doc_subsubsection">Bugs</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000436
Misha Brukman500bc302003-11-22 00:38:41 +0000437<div class="doc_text">
Chris Lattnerc5d658a2006-03-03 00:34:26 +0000438
Chris Lattner252b83d2008-02-06 18:00:06 +0000439<p>llvm-gcc does not currently support <a href="http://llvm.org/PR869">Link-Time
440Optimization</a> on most platforms "out-of-the-box". Please inquire on the
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000441llvmdev mailing list if you are interested.</p>
Chris Lattnerd9ea0172006-08-08 17:27:28 +0000442
Misha Brukman500bc302003-11-22 00:38:41 +0000443</div>
444
445<!-- _______________________________________________________________________ -->
446<div class="doc_subsubsection">
447 Notes
448</div>
449
450<div class="doc_text">
Misha Brukman500bc302003-11-22 00:38:41 +0000451<ul>
452
Chris Lattnerd09c4ec2007-05-17 22:02:24 +0000453<li><p>llvm-gcc does <b>not</b> support <tt>__builtin_apply</tt> yet.
454 See <a href="http://gcc.gnu.org/onlinedocs/gcc/Constructing-Calls.html#Constructing%20Calls">Constructing Calls</a>: Dispatching a call to another function.</p>
455</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000456
Duncan Sands32a83442007-05-18 09:04:20 +0000457<li><p>llvm-gcc <b>partially</b> supports these GCC extensions:</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000458 <ol>
Duncan Sandsc90d68b2007-09-26 15:59:54 +0000459 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Nested-Functions.html#Nested%20Functions">Nested Functions</a>:
460
461 As in Algol and Pascal, lexical scoping of functions.
462 Nested functions are supported, but llvm-gcc does not support
Duncan Sands0869f4a2007-09-26 16:24:52 +0000463 taking the address of a nested function (except on the X86-32 target)
Duncan Sandsc90d68b2007-09-26 15:59:54 +0000464 or non-local gotos.</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000465
466 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Attributes.html#Function%20Attributes">Function Attributes</a>:
Misha Brukman500bc302003-11-22 00:38:41 +0000467
John Criswelld000e1d2003-12-18 16:43:17 +0000468 Declaring that functions have no side effects or that they can never
Misha Brukman500bc302003-11-22 00:38:41 +0000469 return.<br>
470
Anton Korobeynikovbe6fe282007-11-16 11:12:01 +0000471 <b>Supported:</b> <tt>alias</tt>, <tt>always_inline</tt>, <tt>cdecl</tt>,
472 <tt>const</tt>, <tt>constructor</tt>, <tt>destructor</tt>,
Anton Korobeynikov9413de32006-11-18 08:04:48 +0000473 <tt>deprecated</tt>, <tt>fastcall</tt>, <tt>format</tt>,
Anton Korobeynikovbe6fe282007-11-16 11:12:01 +0000474 <tt>format_arg</tt>, <tt>non_null</tt>, <tt>noinline</tt>,
475 <tt>noreturn</tt>, <tt>pure</tt>, <tt>regparm</tt>
Anton Korobeynikov8cea37b2007-01-23 12:35:46 +0000476 <tt>section</tt>, <tt>stdcall</tt>, <tt>unused</tt>, <tt>used</tt>,
477 <tt>visibility</tt>, <tt>warn_unused_result</tt>, <tt>weak</tt><br>
Misha Brukman500bc302003-11-22 00:38:41 +0000478
Anton Korobeynikovbe6fe282007-11-16 11:12:01 +0000479 <b>Ignored:</b> <tt>nothrow</tt>, <tt>malloc</tt>,
480 <tt>no_instrument_function</tt></li>
Misha Brukman500bc302003-11-22 00:38:41 +0000481 </ol>
Chris Lattnerd09c4ec2007-05-17 22:02:24 +0000482</li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000483
Chris Lattnerd09c4ec2007-05-17 22:02:24 +0000484<li><p>llvm-gcc supports the vast majority of GCC extensions, including:</p>
Misha Brukman500bc302003-11-22 00:38:41 +0000485
Chris Lattner79c3fe12003-10-02 04:57:28 +0000486 <ol>
Chris Lattnerd09c4ec2007-05-17 22:02:24 +0000487 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Pragmas.html#Pragmas">Pragmas</a>: Pragmas accepted by GCC.</li>
488 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Local-Labels.html#Local%20Labels">Local Labels</a>: Labels local to a block.</li>
489 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Other-Builtins.html#Other%20Builtins">Other Builtins</a>:
490 Other built-in functions.</li>
491 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Attributes.html#Variable%20Attributes">Variable Attributes</a>:
492 Specifying attributes of variables.</li>
493 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Type-Attributes.html#Type%20Attributes">Type Attributes</a>: Specifying attributes of types.</li>
494 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Thread_002dLocal.html">Thread-Local</a>: Per-thread variables.</li>
495 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Length.html#Variable%20Length">Variable Length</a>:
496 Arrays whose length is computed at run time.</li>
Chris Lattner7fe97dd2004-03-16 08:54:07 +0000497 <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 +0000498 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Statement-Exprs.html#Statement%20Exprs">Statement Exprs</a>: Putting statements and declarations inside expressions.</li>
499 <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 +0000500 <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 +0000501 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Conditionals.html#Conditionals">Conditionals</a>: Omitting the middle operand of a <code>?:</code> expression.</li>
502 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Long-Long.html#Long%20Long">Long Long</a>: Double-word integers.</li>
503 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Complex.html#Complex">Complex</a>: Data types for complex numbers.</li>
504 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Hex-Floats.html#Hex%20Floats">Hex Floats</a>:Hexadecimal floating-point constants.</li>
505 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Zero-Length.html#Zero%20Length">Zero Length</a>: Zero-length arrays.</li>
506 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Empty-Structures.html#Empty%20Structures">Empty Structures</a>: Structures with no members.</li>
507 <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>
508 <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 +0000509 <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>
510 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Constraints.html#Constraints">Constraints</a>: Constraints for asm operands.</li>
511 <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>
512 <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>
513 <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>
514 <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 +0000515 <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 +0000516 <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 +0000517 <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 +0000518 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Compound-Literals.html#Compound%20Literals">Compound Literals</a>: Compound literals give structures, unions,
519or arrays as values.</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000520 <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 +0000521 <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 +0000522 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Case-Ranges.html#Case%20Ranges">Case Ranges</a>: `case 1 ... 9' and such.</li>
523 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Mixed-Declarations.html#Mixed%20Declarations">Mixed Declarations</a>: Mixing declarations and code.</li>
524 <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 +0000525 <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 +0000526 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Dollar-Signs.html#Dollar%20Signs">Dollar Signs</a>: Dollar sign is allowed in identifiers.</li>
527 <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>
528 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Alignment.html#Alignment">Alignment</a>: Inquiring about the alignment of a type or variable.</li>
529 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Inline.html#Inline">Inline</a>: Defining inline functions (as fast as macros).</li>
530 <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>
531 <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>
532 <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 +0000533 <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 +0000534 <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>
535 <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 +0000536 </ol></li>
537
538</ul>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000539
Misha Brukman500bc302003-11-22 00:38:41 +0000540<p>If you run into GCC extensions which have not been included in any of these
541lists, please let us know (also including whether or not they work).</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000542
Misha Brukman500bc302003-11-22 00:38:41 +0000543</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000544
Misha Brukman500bc302003-11-22 00:38:41 +0000545<!-- ======================================================================= -->
546<div class="doc_subsection">
547 <a name="c++-fe">Known problems with the C++ front-end</a>
548</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000549
Misha Brukman500bc302003-11-22 00:38:41 +0000550<div class="doc_text">
551
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000552<p>The C++ front-end is considered to be fully
Chris Lattner7506b1d2004-12-07 08:04:13 +0000553tested and works for a number of non-trivial programs, including LLVM
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000554itself, Qt, Mozilla, etc.</p>
Misha Brukman500bc302003-11-22 00:38:41 +0000555
Misha Brukman500bc302003-11-22 00:38:41 +0000556<ul>
Chris Lattner000c73b2008-02-06 06:30:34 +0000557<li>Exception handling only works well on the X86 and PowerPC targets.</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000558</ul>
Chris Lattnerfcc54b32003-10-07 22:14:37 +0000559
Misha Brukman500bc302003-11-22 00:38:41 +0000560</div>
561
Misha Brukman500bc302003-11-22 00:38:41 +0000562
Chris Lattner98a493c2005-05-15 16:01:20 +0000563
Chris Lattner79c3fe12003-10-02 04:57:28 +0000564<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000565<div class="doc_section">
566 <a name="additionalinfo">Additional Information</a>
567</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000568<!-- *********************************************************************** -->
569
Misha Brukman500bc302003-11-22 00:38:41 +0000570<div class="doc_text">
571
Chris Lattner416db102005-05-16 17:13:10 +0000572<p>A wide variety of additional information is available on the <a
Chris Lattnerb4b0ce72007-05-18 00:44:29 +0000573href="http://llvm.org">LLVM web page</a>, in particular in the <a
574href="http://llvm.org/docs/">documentation</a> section. The web page also
Reid Spencer669ed452007-07-09 08:04:31 +0000575contains versions of the API documentation which is up-to-date with the
576Subversion version of the source code.
Misha Brukman109d9e82005-03-30 19:14:24 +0000577You can access versions of these documents specific to this release by going
578into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000579
Misha Brukman500bc302003-11-22 00:38:41 +0000580<p>If you have any questions or comments about LLVM, please feel free to contact
Chris Lattnerc463b272005-10-29 07:07:09 +0000581us via the <a href="http://llvm.org/docs/#maillist"> mailing
Chris Lattner5eccca42003-12-12 21:22:16 +0000582lists</a>.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000583
Misha Brukman500bc302003-11-22 00:38:41 +0000584</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000585
586<!-- *********************************************************************** -->
Chris Lattner79c3fe12003-10-02 04:57:28 +0000587
Misha Brukman500bc302003-11-22 00:38:41 +0000588<hr>
Misha Brukman2061e892003-11-22 01:23:39 +0000589<address>
Misha Brukman38847d52003-12-21 22:53:21 +0000590 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman2061e892003-11-22 01:23:39 +0000591 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
592 <a href="http://validator.w3.org/check/referer"><img
593 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
594
Chris Lattnerb4b0ce72007-05-18 00:44:29 +0000595 <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
Misha Brukman500bc302003-11-22 00:38:41 +0000596 Last modified: $Date$
Misha Brukman2061e892003-11-22 01:23:39 +0000597</address>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000598
Misha Brukman500bc302003-11-22 00:38:41 +0000599</body>
600</html>