blob: 4c9f30f7b2a7f5901c07bdea83d4a027dced0c32 [file] [log] [blame]
Misha Brukman80731b92003-11-22 00:38:41 +00001<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
3<html>
4<head>
Reid Spencere4190fa2004-11-18 18:38:58 +00005 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
Misha Brukman80731b92003-11-22 00:38:41 +00006 <link rel="stylesheet" href="llvm.css" type="text/css">
Chris Lattner0a1fd102007-09-21 03:54:09 +00007 <title>LLVM 2.1 Release Notes</title>
Misha Brukman80731b92003-11-22 00:38:41 +00008</head>
9<body>
Chris Lattner3d482502003-10-02 04:57:28 +000010
Chris Lattner0a1fd102007-09-21 03:54:09 +000011<div class="doc_title">LLVM 2.1 Release Notes</div>
Chris Lattner3d482502003-10-02 04:57:28 +000012
13<ol>
Misha Brukman80731b92003-11-22 00:38:41 +000014 <li><a href="#intro">Introduction</a></li>
15 <li><a href="#whatsnew">What's New?</a></li>
Chris Lattner77a51732004-04-30 22:17:12 +000016 <li><a href="GettingStarted.html">Installation Instructions</a></li>
Misha Brukman80731b92003-11-22 00:38:41 +000017 <li><a href="#portability">Portability and Supported Platforms</a></li>
Chris Lattner3d482502003-10-02 04:57:28 +000018 <li><a href="#knownproblems">Known Problems</a>
Misha Brukman80731b92003-11-22 00:38:41 +000019 <li><a href="#additionalinfo">Additional Information</a></li>
Chris Lattner3d482502003-10-02 04:57:28 +000020</ol>
21
Chris Lattner020e1fc2004-05-23 21:07:27 +000022<div class="doc_author">
Chris Lattnera69595e2005-10-29 07:07:09 +000023 <p>Written by the <a href="http://llvm.org">LLVM Team</a><p>
Misha Brukman80731b92003-11-22 00:38:41 +000024</div>
Chris Lattner3d482502003-10-02 04:57:28 +000025
26<!-- *********************************************************************** -->
Misha Brukman80731b92003-11-22 00:38:41 +000027<div class="doc_section">
28 <a name="intro">Introduction</a>
29</div>
Chris Lattner3d482502003-10-02 04:57:28 +000030<!-- *********************************************************************** -->
31
Misha Brukman80731b92003-11-22 00:38:41 +000032<div class="doc_text">
33
34<p>This document contains the release notes for the LLVM compiler
Chris Lattner0a1fd102007-09-21 03:54:09 +000035infrastructure, release 2.1. Here we describe the status of LLVM, including
Chris Lattnerbee7b322007-05-23 04:39:32 +000036major improvements from the previous release and any known problems. All LLVM
Chris Lattner98a33492007-05-09 04:58:11 +000037releases may be downloaded from the <a href="http://llvm.org/releases/">LLVM
Chris Lattnerbee7b322007-05-23 04:39:32 +000038releases web site</a>.</p>
Chris Lattner62495762003-10-02 16:38:05 +000039
Chris Lattnerb5bb5972004-12-07 08:04:13 +000040<p>For more information about LLVM, including information about the latest
Chris Lattnera69595e2005-10-29 07:07:09 +000041release, please check out the <a href="http://llvm.org/">main LLVM
Chris Lattnere7525b52003-10-07 21:38:31 +000042web site</a>. If you have questions or comments, the <a
43href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM developer's mailing
Misha Brukman80731b92003-11-22 00:38:41 +000044list</a> is a good place to send them.</p>
Chris Lattner3d482502003-10-02 04:57:28 +000045
Reid Spencerc7f87f22007-07-09 08:04:31 +000046<p>Note that if you are reading this file from a Subversion checkout or the
Chris Lattner0a1fd102007-09-21 03:54:09 +000047main LLVM web page, this document applies to the <i>next</i> release, not the
48current one. To see the release notes for a specific releases, please see the
49<a href="http://llvm.org/releases/">releases page</a>.</p>
Misha Brukman80731b92003-11-22 00:38:41 +000050
51</div>
Chris Lattner3d482502003-10-02 04:57:28 +000052
53<!-- *********************************************************************** -->
Misha Brukman80731b92003-11-22 00:38:41 +000054<div class="doc_section">
55 <a name="whatsnew">What's New?</a>
56</div>
Chris Lattner3d482502003-10-02 04:57:28 +000057<!-- *********************************************************************** -->
58
Misha Brukman80731b92003-11-22 00:38:41 +000059<div class="doc_text">
60
Chris Lattner0a1fd102007-09-21 03:54:09 +000061<p>This is the twelfth public release of the LLVM Compiler Infrastructure.
62It includes many features and refinements from LLVM 2.0.</p>
Chris Lattnerba7bd472003-12-06 20:22:41 +000063
Chris Lattner21a90402004-05-24 04:50:25 +000064</div>
65
Chris Lattnerba7bd472003-12-06 20:22:41 +000066<!--=========================================================================-->
Chris Lattner406bddf2005-05-15 05:44:51 +000067<div class="doc_subsection">
Chris Lattner0a1fd102007-09-21 03:54:09 +000068<a name="frontends">New Frontends</a>
Chris Lattner9f871732006-04-18 06:18:36 +000069</div>
70
Chris Lattner97beb512007-05-14 06:56:09 +000071<div class="doc_text">
Chris Lattner727c3742007-05-18 06:33:02 +000072
Chris Lattner0a1fd102007-09-21 03:54:09 +000073<p>LLVM 2.1 brings two new beta C front-ends. First, Duncan, Anton and Devang
74start syncing up llvm-gcc with GCC 4.2, yielding "llvm-gcc 4.2" (creative,
75huh?). llvm-gcc 4.2 has the promise to bring much better FORTRAN and Ada
76support to LLVM as well as features like atomic builtins, OpenMP, and many other
77things. Check it out!</p>
Chris Lattner97beb512007-05-14 06:56:09 +000078
Chris Lattner0a1fd102007-09-21 03:54:09 +000079<p>Second, LLVM now includes its own native C and Objective-C front-end (C++ is
80in progress, but is not very far along) code named "<a
81href="http://clang.llvm.org/">clang</a>". This front-end has a number of great
82features, primarily aimed at source-level analysis and speeding up compile-time.
83At this point though, the LLVM Code Generator component is still very early in
84development, so it's mostly useful for people looking to build source-level
85analysis tools or source-to-source translators.</p>
Chris Lattner727c3742007-05-18 06:33:02 +000086
Chris Lattner97beb512007-05-14 06:56:09 +000087</div>
88
Chris Lattner0a1fd102007-09-21 03:54:09 +000089<!--=========================================================================-->
90<div class="doc_subsection">
91<a name="optimizer">Optimizer Improvements</a>
92</div>
Chris Lattner97beb512007-05-14 06:56:09 +000093
Chris Lattner97beb512007-05-14 06:56:09 +000094<div class="doc_text">
Chris Lattner0a1fd102007-09-21 03:54:09 +000095
96<p>Some of the most noticable improvements this release have been in the
97optimizer, speeding it up and making it more aggressive</p>
Chris Lattner97beb512007-05-14 06:56:09 +000098
99<ul>
Tanya Lattner6ee68ca2007-05-16 23:25:46 +0000100
Chris Lattner0a1fd102007-09-21 03:54:09 +0000101<li>Owen DSE and MemDep analysis</li>
102<li>Owen GVN</li>
103<li>Owen GVN-PRE, not in llvm-gcc</li>
104<li>Devang merged ETForest and DomTree into a single easier to use data
105structure.</li>
106<li>Nick Lewycky improved loop trip count analysis to handle many more common
107cases.</li>
Tanya Lattner6ee68ca2007-05-16 23:25:46 +0000108
Chris Lattner97beb512007-05-14 06:56:09 +0000109</ul>
Chris Lattner0a1fd102007-09-21 03:54:09 +0000110
Chris Lattner97beb512007-05-14 06:56:09 +0000111</div>
112
Chris Lattner0a1fd102007-09-21 03:54:09 +0000113<!--=========================================================================-->
114<div class="doc_subsection">
115<a name="codegen">Code Generator Improvements</a>
116</div>
117
118<div class="doc_text">
119
120<p>foo</p>
121
122<ul>
123
124<li>Dale finished up the Tail Merging optimization in the code generator,
125enabling it by default. This produces smaller code that is also faster in some
126cases.</li>
127
128<li>Dan Gohman changed the way we represent vectors before legalization,
129significantly simplifying the SelectionDAG representation for these and making
130the code generator faster for vector code.</li>
131
Chris Lattner1af762f2007-09-21 17:43:52 +0000132<li>Evan remat rewrite (coalesced intervals + folding of remat'd loads) and
Chris Lattner0a1fd102007-09-21 03:54:09 +0000133live intervals improvements.</li>
134
135<li>Dan Gohman contributed support for better alignment and volatility handling
136in the code generator, and significantly enhanced alignment analysis for SSE
137load/store instructions.</li>
138
139<li>Christopher Lamb virtual register sub-register support, better truncates and
140extends on X86.</li>
141
142<li>Duraid Madina contributed a new "bigblock" register allocator, and Roman
143Levenstein contributed several big improvements. BigBlock is optimized for code
144that uses very large basic blocks. It is slightly slower than the "local"
145allocator, but produces much better code.</li>
146
Chris Lattner1af762f2007-09-21 17:43:52 +0000147<li>David Greene refactored the register allocator to split coalescing out from
148allocation, making coalescers pluggable.</li>
Chris Lattner0a1fd102007-09-21 03:54:09 +0000149
150</ul>
151
152</div>
153
154
155<!--=========================================================================-->
156<div class="doc_subsection">
157<a name="targetspecific">Target Specific Improvements</a>
158</div>
Chris Lattner727c3742007-05-18 06:33:02 +0000159
Chris Lattner89e761c2006-04-18 06:32:08 +0000160<div class="doc_text">
Chris Lattner97beb512007-05-14 06:56:09 +0000161<p>New features include:
162</p>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000163
164<ul>
Chris Lattner0a1fd102007-09-21 03:54:09 +0000165<li>Bruno Cardoso Lopes contributed initial MIPS support.</li>
166<li>Bill Wendling added SSSE3 support.</li>
167<li>New Target independent if converter, ARM uses it so far</li>
168<li>Nicholas Geoffray contributed improved linux/ppc ABI and JIT support.</li>
169<li>Dale Johannesen rewrote handling of 32-bit float values in the X86 backend
170when using the floating point stack, fixing several nasty bugs.</li>
171<li>Dan contributed rematerialization support for the X86 backend.</li>
172</ul>
173
174</div>
Chris Lattnerbee7b322007-05-23 04:39:32 +0000175
Chris Lattnerbee7b322007-05-23 04:39:32 +0000176
Chris Lattner0a1fd102007-09-21 03:54:09 +0000177<!--=========================================================================-->
178<div class="doc_subsection">
179<a name="llvmgccimprovements">llvm-gcc Improvements</a>
180</div>
Tanya Lattner6ee68ca2007-05-16 23:25:46 +0000181
Chris Lattner0a1fd102007-09-21 03:54:09 +0000182<div class="doc_text">
183<p>New features include:
184</p>
Tanya Lattner6ee68ca2007-05-16 23:25:46 +0000185
Chris Lattner0a1fd102007-09-21 03:54:09 +0000186<ul>
187<li>Duncan and Anton exception handling in llvm-gcc 4.0/4.2</li>
Tanya Lattner6ee68ca2007-05-16 23:25:46 +0000188
Chris Lattner0a1fd102007-09-21 03:54:09 +0000189<li>Devang and Duncan: Bitfields, pragma pack</li>
Chris Lattner727c3742007-05-18 06:33:02 +0000190
Chris Lattner0a1fd102007-09-21 03:54:09 +0000191<li>Tanya implemented support for __attribute__((noinline)) in llvm-gcc, and
192added support for generic variable annotations which are propagated into the
193LLVM IR, e.g. "<tt>int X __attribute__((annotate("myproperty")));</tt>".</li>
194
195<li>Sheng Zhou and Christopher Lamb implemented alias analysis support for
196'restrict' arguments to functions.</li>
197
198<li>Duncan contributed support for trampolines (pointers to nested functions),
199currently only supported on x86 target.</li>
Tanya Lattner6ee68ca2007-05-16 23:25:46 +0000200
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000201</ul>
202
Chris Lattner89e761c2006-04-18 06:32:08 +0000203</div>
204
Chris Lattner0a1fd102007-09-21 03:54:09 +0000205
206<!--=========================================================================-->
207<div class="doc_subsection">
208<a name="coreimprovements">LLVM Core Improvements</a>
209</div>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000210
Chris Lattner0b7fd712006-04-19 04:02:47 +0000211<div class="doc_text">
Chris Lattner0a1fd102007-09-21 03:54:09 +0000212<p>New features include:
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000213</p>
214
215<ul>
Chris Lattner0a1fd102007-09-21 03:54:09 +0000216<li>Neil Booth APFloat, foundation for long double support that will be wrapped
217up in 2.2. Dale contributed most of long double support, will be enabled in
2182.2.</li>
Tanya Lattner6ee68ca2007-05-16 23:25:46 +0000219
Chris Lattner0a1fd102007-09-21 03:54:09 +0000220<li>LLVM now provides an LLVMBuilder class which makes it significantly easier
221to create LLVM IR instructions.</li>
Tanya Lattner6ee68ca2007-05-16 23:25:46 +0000222
Chris Lattner0a1fd102007-09-21 03:54:09 +0000223<li>Reid contributed support for intrinsics that take arbitrary integer typed
224arguments, Dan Gohman and Chandler extended it to support FP and vectors.</li>
Chris Lattner8ce1ba42007-05-17 21:41:31 +0000225</li>
226
Chris Lattner8ce1ba42007-05-17 21:41:31 +0000227</ul>
Chris Lattner0a1fd102007-09-21 03:54:09 +0000228
Chris Lattner8ce1ba42007-05-17 21:41:31 +0000229</div>
Chris Lattner72a269f2006-03-03 00:34:26 +0000230
Chris Lattner0a1fd102007-09-21 03:54:09 +0000231<!--=========================================================================-->
232<div class="doc_subsection">
233<a name="otherimprovements">Other Improvements</a>
234</div>
235
236<div class="doc_text">
237<p>New features include:
238</p>
239
240<ul>
241<li>BrainF frontend by Sterling Stein.</li>
242
243<li>David Green contributed a new --enable-expensive-checks configure option
244which enables STL checking, and fixed several bugs exposed by it.</li>
245
246</li>
247
248</ul>
249
250</div>
Chris Lattner72a269f2006-03-03 00:34:26 +0000251
Chris Lattner62495762003-10-02 16:38:05 +0000252<!-- *********************************************************************** -->
Misha Brukman80731b92003-11-22 00:38:41 +0000253<div class="doc_section">
254 <a name="portability">Portability and Supported Platforms</a>
255</div>
Chris Lattner62495762003-10-02 16:38:05 +0000256<!-- *********************************************************************** -->
257
Misha Brukman80731b92003-11-22 00:38:41 +0000258<div class="doc_text">
259
John Criswell64307722004-12-08 20:35:47 +0000260<p>LLVM is known to work on the following platforms:</p>
Chris Lattner2c7b0872004-06-01 18:22:41 +0000261
262<ul>
Chris Lattnerbee7b322007-05-23 04:39:32 +0000263<li>Intel and AMD machines running Red Hat Linux, Fedora Core and FreeBSD
Reid Spencer9803b402005-05-17 02:47:27 +0000264 (and probably other unix-like systems).</li>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000265<li>PowerPC and X86-based Mac OS X systems, running 10.2 and above in 32-bit and
266 64-bit modes.</li>
Chris Lattnerbee7b322007-05-23 04:39:32 +0000267<li>Intel and AMD machines running on Win32 using MinGW libraries (native)</li>
268<li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
269 support is available for native builds with Visual C++).</li>
270<li>Sun UltraSPARC workstations running Solaris 8.</li>
John Criswelld5234922005-05-13 20:28:15 +0000271<li>Alpha-based machines running Debian GNU/Linux.</li>
272<li>Itanium-based machines running Linux and HP-UX.</li>
Chris Lattner2c7b0872004-06-01 18:22:41 +0000273</ul>
274
Brian Gaekee3e557e2004-05-09 05:28:35 +0000275<p>The core LLVM infrastructure uses
276<a href="http://www.gnu.org/software/autoconf/">GNU autoconf</a> to adapt itself
277to the machine and operating system on which it is built. However, minor
278porting may be required to get LLVM to work on new platforms. We welcome your
279portability patches and reports of successful builds or error messages.</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000280
Misha Brukman80731b92003-11-22 00:38:41 +0000281</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000282
283<!-- *********************************************************************** -->
Misha Brukman80731b92003-11-22 00:38:41 +0000284<div class="doc_section">
285 <a name="knownproblems">Known Problems</a>
286</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000287<!-- *********************************************************************** -->
288
Misha Brukman80731b92003-11-22 00:38:41 +0000289<div class="doc_text">
290
291<p>This section contains all known problems with the LLVM system, listed by
Chris Lattner3d482502003-10-02 04:57:28 +0000292component. As new problems are discovered, they will be added to these
Chris Lattnerb84f3322003-12-12 21:22:16 +0000293sections. If you run into a problem, please check the <a
Chris Lattnera69595e2005-10-29 07:07:09 +0000294href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
Chris Lattnerb84f3322003-12-12 21:22:16 +0000295there isn't already one.</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000296
Misha Brukman80731b92003-11-22 00:38:41 +0000297</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000298
Chris Lattnerb911de42004-03-14 02:03:02 +0000299<!-- ======================================================================= -->
300<div class="doc_subsection">
301 <a name="experimental">Experimental features included with this release</a>
302</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000303
Chris Lattnerb911de42004-03-14 02:03:02 +0000304<div class="doc_text">
305
Misha Brukmanfa50a222004-05-12 21:46:05 +0000306<p>The following components of this LLVM release are either untested, known to
307be broken or unreliable, or are in early development. These components should
308not be relied on, and bugs should not be filed against them, but they may be
309useful to some people. In particular, if you would like to work on one of these
Chris Lattner05a225b2006-08-09 04:08:52 +0000310components, please contact us on the <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p>
Chris Lattnerb911de42004-03-14 02:03:02 +0000311
312<ul>
Chris Lattner9f871732006-04-18 06:18:36 +0000313<li>The <tt>-cee</tt> pass is known to be buggy, and may be removed in in a
314 future release.</li>
Chris Lattnerbee7b322007-05-23 04:39:32 +0000315<li>C++ EH support is disabled for this release.</li>
316<li>The MSIL backend is experimental.</li>
Chris Lattnera38fe5f2006-02-05 06:39:36 +0000317<li>The IA64 code generator is experimental.</li>
Chris Lattnera69595e2005-10-29 07:07:09 +0000318<li>The Alpha JIT is experimental.</li>
Chris Lattner9f871732006-04-18 06:18:36 +0000319<li>"<tt>-filetype=asm</tt>" (the default) is the only supported value for the
320 <tt>-filetype</tt> llc option.</li>
Chris Lattnerb911de42004-03-14 02:03:02 +0000321</ul>
322
323</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000324
Misha Brukman80731b92003-11-22 00:38:41 +0000325<!-- ======================================================================= -->
326<div class="doc_subsection">
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000327 <a name="x86-be">Known problems with the X86 back-end</a>
John Criswell3bdbd302005-11-08 21:11:33 +0000328</div>
329
330<div class="doc_text">
331
332<ul>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000333<li>The X86 backend does not yet support <a href="http://llvm.org/PR879">inline
Chris Lattner98a33492007-05-09 04:58:11 +0000334 assembly that uses the X86 floating point stack</a>.</li>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000335</ul>
336
337</div>
338
339<!-- ======================================================================= -->
340<div class="doc_subsection">
341 <a name="ppc-be">Known problems with the PowerPC back-end</a>
342</div>
343
344<div class="doc_text">
345
346<ul>
347<li><a href="http://llvm.org/PR642">PowerPC backend does not correctly
348implement ordered FP comparisons</a>.</li>
Nicolas Geoffray77d99502007-05-15 09:21:28 +0000349<li>The Linux PPC32/ABI support needs testing for the interpreter and static
Chris Lattnerbee7b322007-05-23 04:39:32 +0000350compilation, and lacks support for debug information.</li>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000351</ul>
352
353</div>
354
355<!-- ======================================================================= -->
356<div class="doc_subsection">
Chris Lattner97beb512007-05-14 06:56:09 +0000357 <a name="arm-be">Known problems with the ARM back-end</a>
358</div>
359
360<div class="doc_text">
361
362<ul>
Chris Lattnerbee7b322007-05-23 04:39:32 +0000363<li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
364processors, thumb program can crash or produces wrong
365results (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
Chris Lattner97beb512007-05-14 06:56:09 +0000366<li>Compilation for ARM Linux OABI (old ABI) is supported, but not fully tested.
367</li>
Chris Lattnerbee7b322007-05-23 04:39:32 +0000368<li>There is a bug in QEMU-ARM (<= 0.9.0) which causes it to incorrectly execute
369programs compiled with LLVM. Please use more recent versions of QEMU.</li>
Chris Lattner97beb512007-05-14 06:56:09 +0000370</ul>
371
372</div>
373
374<!-- ======================================================================= -->
375<div class="doc_subsection">
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000376 <a name="sparc-be">Known problems with the SPARC back-end</a>
377</div>
378
379<div class="doc_text">
380
381<ul>
382<li>The SPARC backend only supports the 32-bit SPARC ABI (-m32), it does not
383 support the 64-bit SPARC ABI (-m64).</li>
384</ul>
385
386</div>
387
388<!-- ======================================================================= -->
389<div class="doc_subsection">
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000390 <a name="alpha-be">Known problems with the Alpha back-end</a>
391</div>
392
393<div class="doc_text">
394
395<ul>
396
397<li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
398appropriate nops inserted to ensure restartability.</li>
399
John Criswell3bdbd302005-11-08 21:11:33 +0000400</ul>
401</div>
402
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000403<!-- ======================================================================= -->
404<div class="doc_subsection">
405 <a name="ia64-be">Known problems with the IA64 back-end</a>
406</div>
407
408<div class="doc_text">
409
410<ul>
411
412<li>C++ programs are likely to fail on IA64, as calls to <tt>setjmp</tt> are
413made where the argument is not 16-byte aligned, as required on IA64. (Strictly
414speaking this is not a bug in the IA64 back-end; it will also be encountered
415when building C++ programs using the C back-end.)</li>
416
417<li>The C++ front-end does not use <a href="http://llvm.org/PR406">IA64
418ABI compliant layout of v-tables</a>. In particular, it just stores function
419pointers instead of function descriptors in the vtable. This bug prevents
420mixing C++ code compiled with LLVM with C++ objects compiled by other C++
421compilers.</li>
422
423<li>There are a few ABI violations which will lead to problems when mixing LLVM
424output with code built with other compilers, particularly for floating-point
425programs.</li>
426
427<li>Defining vararg functions is not supported (but calling them is ok).</li>
428
Chris Lattner98a33492007-05-09 04:58:11 +0000429<li>The Itanium backend has bitrotted somewhat.</li>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000430</ul>
431
432</div>
433
434<!-- ======================================================================= -->
435<div class="doc_subsection">
Chris Lattner97beb512007-05-14 06:56:09 +0000436 <a name="c-be">Known problems with the C back-end</a>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000437</div>
438
439<div class="doc_text">
440
441<ul>
Chris Lattner97beb512007-05-14 06:56:09 +0000442<li><a href="http://llvm.org/PR802">The C backend does not support inline
443 assembly code</a>.</li>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000444</ul>
445
446</div>
John Criswell3bdbd302005-11-08 21:11:33 +0000447
Misha Brukman80731b92003-11-22 00:38:41 +0000448
449<!-- ======================================================================= -->
450<div class="doc_subsection">
451 <a name="c-fe">Known problems with the C front-end</a>
452</div>
Chris Lattner178f3db2003-10-02 05:07:23 +0000453
Chris Lattner3d482502003-10-02 04:57:28 +0000454<!-- _______________________________________________________________________ -->
Chris Lattner5a8a7282003-12-14 05:03:43 +0000455<div class="doc_subsubsection">Bugs</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000456
Misha Brukman80731b92003-11-22 00:38:41 +0000457<div class="doc_text">
Chris Lattner72a269f2006-03-03 00:34:26 +0000458
Chris Lattner97beb512007-05-14 06:56:09 +0000459<p>llvm-gcc4 does not currently support <a href="http://llvm.org/PR869">Link-Time
460Optimization</a> on most platforms "out-of-the-box". Please inquire on the
461llvmdev mailing list if you are interested.</p>
Chris Lattner44124232006-08-08 17:27:28 +0000462
Misha Brukman80731b92003-11-22 00:38:41 +0000463</div>
464
465<!-- _______________________________________________________________________ -->
466<div class="doc_subsubsection">
467 Notes
468</div>
469
470<div class="doc_text">
Misha Brukman80731b92003-11-22 00:38:41 +0000471<ul>
472
Chris Lattner2f131fe2007-05-17 22:02:24 +0000473<li><p>"long double" is silently transformed by the front-end into "double". There
474is no support for floating point data types of any size other than 32 and 64
475bits.</p></li>
Misha Brukman80731b92003-11-22 00:38:41 +0000476
Chris Lattner2f131fe2007-05-17 22:02:24 +0000477<li><p>llvm-gcc does <b>not</b> support <tt>__builtin_apply</tt> yet.
478 See <a href="http://gcc.gnu.org/onlinedocs/gcc/Constructing-Calls.html#Constructing%20Calls">Constructing Calls</a>: Dispatching a call to another function.</p>
479</li>
Chris Lattner3d482502003-10-02 04:57:28 +0000480
Duncan Sandsea7a3262007-05-18 09:04:20 +0000481<li><p>llvm-gcc <b>partially</b> supports these GCC extensions:</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000482 <ol>
Chris Lattner2f131fe2007-05-17 22:02:24 +0000483 <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.<br>
484 Nested functions are supported, but llvm-gcc does not support non-local
485 gotos or taking the address of a nested function.</li>
Chris Lattner3d482502003-10-02 04:57:28 +0000486
487 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Attributes.html#Function%20Attributes">Function Attributes</a>:
Misha Brukman80731b92003-11-22 00:38:41 +0000488
John Criswell86a3a482003-12-18 16:43:17 +0000489 Declaring that functions have no side effects or that they can never
Misha Brukman80731b92003-11-22 00:38:41 +0000490 return.<br>
491
Chris Lattner2f131fe2007-05-17 22:02:24 +0000492 <b>Supported:</b> <tt>alias</tt>, <tt>always_inline</tt>, <tt>cdecl</tt>,
493 <tt>constructor</tt>, <tt>destructor</tt>,
Anton Korobeynikove7cbbfc2006-11-18 08:04:48 +0000494 <tt>deprecated</tt>, <tt>fastcall</tt>, <tt>format</tt>,
Anton Korobeynikovc52614b2007-05-10 08:26:24 +0000495 <tt>format_arg</tt>, <tt>non_null</tt>, <tt>noreturn</tt>, <tt>regparm</tt>
Anton Korobeynikovc7f9f3d2007-01-23 12:35:46 +0000496 <tt>section</tt>, <tt>stdcall</tt>, <tt>unused</tt>, <tt>used</tt>,
497 <tt>visibility</tt>, <tt>warn_unused_result</tt>, <tt>weak</tt><br>
Misha Brukman80731b92003-11-22 00:38:41 +0000498
Chris Lattner2f131fe2007-05-17 22:02:24 +0000499 <b>Ignored:</b> <tt>noinline</tt>, <tt>pure</tt>, <tt>const</tt>, <tt>nothrow</tt>,
500 <tt>malloc</tt>, <tt>no_instrument_function</tt></li>
Misha Brukman80731b92003-11-22 00:38:41 +0000501 </ol>
Chris Lattner2f131fe2007-05-17 22:02:24 +0000502</li>
Chris Lattner3d482502003-10-02 04:57:28 +0000503
Chris Lattner2f131fe2007-05-17 22:02:24 +0000504<li><p>llvm-gcc supports the vast majority of GCC extensions, including:</p>
Misha Brukman80731b92003-11-22 00:38:41 +0000505
Chris Lattner3d482502003-10-02 04:57:28 +0000506 <ol>
Chris Lattner2f131fe2007-05-17 22:02:24 +0000507 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Pragmas.html#Pragmas">Pragmas</a>: Pragmas accepted by GCC.</li>
508 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Local-Labels.html#Local%20Labels">Local Labels</a>: Labels local to a block.</li>
509 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Other-Builtins.html#Other%20Builtins">Other Builtins</a>:
510 Other built-in functions.</li>
511 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Attributes.html#Variable%20Attributes">Variable Attributes</a>:
512 Specifying attributes of variables.</li>
513 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Type-Attributes.html#Type%20Attributes">Type Attributes</a>: Specifying attributes of types.</li>
514 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Thread_002dLocal.html">Thread-Local</a>: Per-thread variables.</li>
515 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Length.html#Variable%20Length">Variable Length</a>:
516 Arrays whose length is computed at run time.</li>
Chris Lattnerd3dc8502004-03-16 08:54:07 +0000517 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Labels-as-Values.html#Labels%20as%20Values">Labels as Values</a>: Getting pointers to labels and computed gotos.</li>
Misha Brukman80731b92003-11-22 00:38:41 +0000518 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Statement-Exprs.html#Statement%20Exprs">Statement Exprs</a>: Putting statements and declarations inside expressions.</li>
519 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Typeof.html#Typeof">Typeof</a>: <code>typeof</code>: referring to the type of an expression.</li>
Tanya Lattnerce33a1b2004-06-22 03:48:17 +0000520 <li><a href="http://gcc.gnu.org/onlinedocs/gcc-3.4.0/gcc/Lvalues.html#Lvalues">Lvalues</a>: Using <code>?:</code>, "<code>,</code>" and casts in lvalues.</li>
Misha Brukman80731b92003-11-22 00:38:41 +0000521 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Conditionals.html#Conditionals">Conditionals</a>: Omitting the middle operand of a <code>?:</code> expression.</li>
522 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Long-Long.html#Long%20Long">Long Long</a>: Double-word integers.</li>
523 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Complex.html#Complex">Complex</a>: Data types for complex numbers.</li>
524 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Hex-Floats.html#Hex%20Floats">Hex Floats</a>:Hexadecimal floating-point constants.</li>
525 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Zero-Length.html#Zero%20Length">Zero Length</a>: Zero-length arrays.</li>
526 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Empty-Structures.html#Empty%20Structures">Empty Structures</a>: Structures with no members.</li>
527 <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>
528 <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 Lattnerb81f10e2006-11-18 07:51:14 +0000529 <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>
530 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Constraints.html#Constraints">Constraints</a>: Constraints for asm operands.</li>
531 <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>
532 <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>
533 <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>
534 <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 Brukman80731b92003-11-22 00:38:41 +0000535 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Subscripting.html#Subscripting">Subscripting</a>: Any array can be subscripted, even if not an lvalue.</li>
Misha Brukman8395d732003-12-12 04:37:31 +0000536 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Pointer-Arith.html#Pointer%20Arith">Pointer Arith</a>: Arithmetic on <code>void</code>-pointers and function pointers.</li>
Misha Brukman80731b92003-11-22 00:38:41 +0000537 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Initializers.html#Initializers">Initializers</a>: Non-constant initializers.</li>
John Criswell86a3a482003-12-18 16:43:17 +0000538 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Compound-Literals.html#Compound%20Literals">Compound Literals</a>: Compound literals give structures, unions,
539or arrays as values.</li>
Misha Brukman80731b92003-11-22 00:38:41 +0000540 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Designated-Inits.html#Designated%20Inits">Designated Inits</a>: Labeling elements of initializers.</li>
Misha Brukman8395d732003-12-12 04:37:31 +0000541 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Cast-to-Union.html#Cast%20to%20Union">Cast to Union</a>: Casting to union type from any member of the union.</li>
Misha Brukman80731b92003-11-22 00:38:41 +0000542 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Case-Ranges.html#Case%20Ranges">Case Ranges</a>: `case 1 ... 9' and such.</li>
543 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Mixed-Declarations.html#Mixed%20Declarations">Mixed Declarations</a>: Mixing declarations and code.</li>
544 <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 Lattner7591b822004-12-08 18:29:38 +0000545 <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 Brukman80731b92003-11-22 00:38:41 +0000546 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Dollar-Signs.html#Dollar%20Signs">Dollar Signs</a>: Dollar sign is allowed in identifiers.</li>
547 <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>
548 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Alignment.html#Alignment">Alignment</a>: Inquiring about the alignment of a type or variable.</li>
549 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Inline.html#Inline">Inline</a>: Defining inline functions (as fast as macros).</li>
550 <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>
551 <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>
552 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Names.html#Function%20Names">Function Names</a>: Printable strings which are the name of the current function.</li>
Chris Lattner3646dad2004-02-14 04:08:29 +0000553 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Return-Address.html#Return%20Address">Return Address</a>: Getting the return or frame address of a function.</li>
Misha Brukman80731b92003-11-22 00:38:41 +0000554 <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>
555 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Attribute-Syntax.html#Attribute%20Syntax">Attribute Syntax</a>: Formal syntax for attributes.</li>
Misha Brukman7cb4e382003-11-22 01:00:11 +0000556 </ol></li>
557
558</ul>
Chris Lattner3d482502003-10-02 04:57:28 +0000559
Misha Brukman80731b92003-11-22 00:38:41 +0000560<p>If you run into GCC extensions which have not been included in any of these
561lists, please let us know (also including whether or not they work).</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000562
Misha Brukman80731b92003-11-22 00:38:41 +0000563</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000564
Misha Brukman80731b92003-11-22 00:38:41 +0000565<!-- ======================================================================= -->
566<div class="doc_subsection">
567 <a name="c++-fe">Known problems with the C++ front-end</a>
568</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000569
Misha Brukman80731b92003-11-22 00:38:41 +0000570<div class="doc_text">
571
Chris Lattner97beb512007-05-14 06:56:09 +0000572<p>The C++ front-end is considered to be fully
Chris Lattnerb5bb5972004-12-07 08:04:13 +0000573tested and works for a number of non-trivial programs, including LLVM
Chris Lattner97beb512007-05-14 06:56:09 +0000574itself, Qt, Mozilla, etc.</p>
Misha Brukman80731b92003-11-22 00:38:41 +0000575
Misha Brukman80731b92003-11-22 00:38:41 +0000576<ul>
Chris Lattner97beb512007-05-14 06:56:09 +0000577<li>llvm-gcc4 only has partial support for <a href="http://llvm.org/PR870">C++
578Exception Handling</a>, and it is not enabled by default.</li>
579
580<!-- NO EH Support!
Chris Lattnerd2a74272003-10-27 18:30:37 +0000581
Chris Lattner3d482502003-10-02 04:57:28 +0000582<li>Destructors for local objects are not always run when a <tt>longjmp</tt> is
Chris Lattner62495762003-10-02 16:38:05 +0000583 performed. In particular, destructors for objects in the <tt>longjmp</tt>ing
Chris Lattner3d482502003-10-02 04:57:28 +0000584 function and in the <tt>setjmp</tt> receiver function may not be run.
John Criswell86a3a482003-12-18 16:43:17 +0000585 Objects in intervening stack frames will be destroyed, however (which is
Misha Brukman80731b92003-11-22 00:38:41 +0000586 better than most compilers).</li>
Chris Lattner3d482502003-10-02 04:57:28 +0000587
Chris Lattner62495762003-10-02 16:38:05 +0000588<li>The LLVM C++ front-end follows the <a
589 href="http://www.codesourcery.com/cxx-abi">Itanium C++ ABI</a>.
590 This document, which is not Itanium specific, specifies a standard for name
591 mangling, class layout, v-table layout, RTTI formats, and other C++
592 representation issues. Because we use this API, code generated by the LLVM
593 compilers should be binary compatible with machine code generated by other
594 Itanium ABI C++ compilers (such as G++, the Intel and HP compilers, etc).
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000595 <i>However</i>, the exception handling mechanism used by llvm-gcc3 is very
Chris Lattner62495762003-10-02 16:38:05 +0000596 different from the model used in the Itanium ABI, so <b>exceptions will not
Misha Brukman80731b92003-11-22 00:38:41 +0000597 interact correctly</b>. </li>
Chris Lattner97beb512007-05-14 06:56:09 +0000598-->
Misha Brukman80731b92003-11-22 00:38:41 +0000599</ul>
Chris Lattner46ecf612003-10-07 22:14:37 +0000600
Misha Brukman80731b92003-11-22 00:38:41 +0000601</div>
602
Misha Brukman80731b92003-11-22 00:38:41 +0000603
Chris Lattnerb62a5f02005-05-15 16:01:20 +0000604
Chris Lattner3d482502003-10-02 04:57:28 +0000605<!-- *********************************************************************** -->
Misha Brukman80731b92003-11-22 00:38:41 +0000606<div class="doc_section">
607 <a name="additionalinfo">Additional Information</a>
608</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000609<!-- *********************************************************************** -->
610
Misha Brukman80731b92003-11-22 00:38:41 +0000611<div class="doc_text">
612
Chris Lattnercb5596d2005-05-16 17:13:10 +0000613<p>A wide variety of additional information is available on the <a
Chris Lattnere0c1df42007-05-18 00:44:29 +0000614href="http://llvm.org">LLVM web page</a>, in particular in the <a
615href="http://llvm.org/docs/">documentation</a> section. The web page also
Reid Spencerc7f87f22007-07-09 08:04:31 +0000616contains versions of the API documentation which is up-to-date with the
617Subversion version of the source code.
Misha Brukman96158092005-03-30 19:14:24 +0000618You can access versions of these documents specific to this release by going
619into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000620
Misha Brukman80731b92003-11-22 00:38:41 +0000621<p>If you have any questions or comments about LLVM, please feel free to contact
Chris Lattnera69595e2005-10-29 07:07:09 +0000622us via the <a href="http://llvm.org/docs/#maillist"> mailing
Chris Lattnerb84f3322003-12-12 21:22:16 +0000623lists</a>.</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000624
Misha Brukman80731b92003-11-22 00:38:41 +0000625</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000626
627<!-- *********************************************************************** -->
Chris Lattner3d482502003-10-02 04:57:28 +0000628
Misha Brukman80731b92003-11-22 00:38:41 +0000629<hr>
Misha Brukman68aab3b2003-11-22 01:23:39 +0000630<address>
Misha Brukman8834af92003-12-21 22:53:21 +0000631 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman68aab3b2003-11-22 01:23:39 +0000632 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
633 <a href="http://validator.w3.org/check/referer"><img
634 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
635
Chris Lattnere0c1df42007-05-18 00:44:29 +0000636 <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
Misha Brukman80731b92003-11-22 00:38:41 +0000637 Last modified: $Date$
Misha Brukman68aab3b2003-11-22 01:23:39 +0000638</address>
Chris Lattner3d482502003-10-02 04:57:28 +0000639
Misha Brukman80731b92003-11-22 00:38:41 +0000640</body>
641</html>