blob: df23d297a12a0358de73c2882fb83f32cb28a955 [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 Lattner98a33492007-05-09 04:58:11 +00007 <title>LLVM 2.0 Release Notes</title>
Misha Brukman80731b92003-11-22 00:38:41 +00008</head>
9<body>
Chris Lattner3d482502003-10-02 04:57:28 +000010
Chris Lattner98a33492007-05-09 04:58:11 +000011<div class="doc_title">LLVM 2.0 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 Lattner98a33492007-05-09 04:58:11 +000035infrastructure, release 2.0. Here we describe the status of LLVM, including any
36known problems and major improvements from the previous release. All LLVM
37releases may be downloaded from the <a href="http://llvm.org/releases/">LLVM
38releases web site</a>.
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
Chris Lattnerf3a7c242004-12-09 22:22:58 +000046<p>Note that if you are reading this file from CVS or the main LLVM web page,
47this document applies to the <i>next</i> release, not the current one. To see
48the release notes for the current or previous releases, see the <a
Chris Lattnera69595e2005-10-29 07:07:09 +000049href="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 Lattner98a33492007-05-09 04:58:11 +000061<p>This is the eleventh public release of the LLVM Compiler Infrastructure.
Chris Lattner2d47f922007-05-09 05:27:05 +000062Being the first major release since 1.0, this release is different in several
63ways from our previous releases:</p>
64
65<ol>
66<li>We took this as an opportunity to
Chris Lattner98a33492007-05-09 04:58:11 +000067break backwards compatibility with the LLVM 1.x bytecode and .ll file format.
68If you have LLVM 1.9 .ll files that you would like to upgrade to LLVM 2.x, we
Lauro Ramos Venancio997a0102007-05-12 02:36:41 +000069recommend the use of the stand alone <a href="#llvm-upgrade">llvm-upgrade</a>
Chris Lattner98a33492007-05-09 04:58:11 +000070tool. We intend to keep compatibility with .ll and .bc formats within the 2.x
Chris Lattner2d47f922007-05-09 05:27:05 +000071release series, like we did within the 1.x series.</li>
72<li>There are several significant change to the LLVM IR and internal APIs, such
73 as a major overhaul of the type system, the completely new bitcode file
74 format, etc.</li>
75<li>We designed the release around a 6 month release cycle instead of the usual
76 3-month cycle. This gave us extra time to develop and test some of the
77 more invasive features in this release.</li>
78<li>LLVM 2.0 no longer supports the llvm-gcc3 front-end.</li>
79</ol>
Chris Lattner98a33492007-05-09 04:58:11 +000080
Chris Lattner2d47f922007-05-09 05:27:05 +000081<p>Note that while this is a major version bump, this release has been
82 extensively tested on a wide range of software. It is easy to say that this
83 is our best release yet, in terms of both features and correctness.</p>
Chris Lattnerba7bd472003-12-06 20:22:41 +000084
Chris Lattner21a90402004-05-24 04:50:25 +000085</div>
86
Chris Lattnerba7bd472003-12-06 20:22:41 +000087<!--=========================================================================-->
Chris Lattner406bddf2005-05-15 05:44:51 +000088<div class="doc_subsection">
Chris Lattner98a33492007-05-09 04:58:11 +000089<a name="newfeatures">New Features in LLVM 2.0</a>
Chris Lattner9f871732006-04-18 06:18:36 +000090</div>
91
Chris Lattner89e761c2006-04-18 06:32:08 +000092<!--_________________________________________________________________________-->
Chris Lattner97beb512007-05-14 06:56:09 +000093<div class="doc_subsubsection"><a name="majorchanges">Major Changes</a></div>
94<div class="doc_text">
95<p>blah
96</p>
97
98<ul>
99<li>ding dong llvm-gcc3 is dead</li>
100<li>bytecode -> bitcode</li>
101</ul>
102
103</div>
104
105
106<!--_________________________________________________________________________-->
107<div class="doc_subsubsection"><a name="llvmgccfeatures">llvm-gcc
108Improvements</a></div>
109<div class="doc_text">
110<p>New features include:
111</p>
112
113<ul>
114<li>many new supported things</li>
115<li>easier to configure on linux</li>
116</ul>
117
118</div>
119
120<!--_________________________________________________________________________-->
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000121<div class="doc_subsubsection"><a name="optimizer">Optimizer
122Improvements</a></div>
Chris Lattner89e761c2006-04-18 06:32:08 +0000123<div class="doc_text">
Chris Lattner97beb512007-05-14 06:56:09 +0000124<p>New features include:
125</p>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000126
127<ul>
Chris Lattner98a33492007-05-09 04:58:11 +0000128<li></li>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000129</ul>
130
Chris Lattner89e761c2006-04-18 06:32:08 +0000131</div>
132
Chris Lattner0b7fd712006-04-19 04:02:47 +0000133<!--_________________________________________________________________________-->
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000134<div class="doc_subsubsection"><a name="codegen">Code
135Generator Enhancements</a></div>
136
Chris Lattner0b7fd712006-04-19 04:02:47 +0000137<div class="doc_text">
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000138<p>
Chris Lattner97beb512007-05-14 06:56:09 +0000139New features include:
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000140</p>
141
142<ul>
Chris Lattner98a33492007-05-09 04:58:11 +0000143<li></li>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000144</ul>
145
146<p>In addition, the LLVM target description format has itself been extended in
147 several ways:</p>
148
149<ul>
Chris Lattner98a33492007-05-09 04:58:11 +0000150<li></li>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000151</ul>
152
153<p>Further, several significant target-specific enhancements are included in
Chris Lattner98a33492007-05-09 04:58:11 +0000154LLVM 2.0:</p>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000155
156<ul>
Chris Lattner98a33492007-05-09 04:58:11 +0000157<li></li>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000158</ul>
159
Chris Lattner0b7fd712006-04-19 04:02:47 +0000160</div>
Chris Lattner9f871732006-04-18 06:18:36 +0000161
162<!--_________________________________________________________________________-->
Chris Lattner97beb512007-05-14 06:56:09 +0000163<div class="doc_subsubsection"><a name="specifictargets">Target-Specific
164Improvements</a></div>
165
166<div class="doc_text">
167
168<p>New features include:
169</p>
170
171<ul>
172<li></li>
173</ul>
174
175</div>
176
177
178<!--_________________________________________________________________________-->
Chris Lattner44124232006-08-08 17:27:28 +0000179<div class="doc_subsubsection"><a name="other">Other Improvements</a></div>
Chris Lattnera38fe5f2006-02-05 06:39:36 +0000180<div class="doc_text">
Chris Lattner98a33492007-05-09 04:58:11 +0000181<p></p>
Chris Lattner44124232006-08-08 17:27:28 +0000182
183<p>More specific changes include:</p>
184
Chris Lattnera38fe5f2006-02-05 06:39:36 +0000185<ul>
Chris Lattner98a33492007-05-09 04:58:11 +0000186<li></li>
Chris Lattnera38fe5f2006-02-05 06:39:36 +0000187</ul>
188</div>
John Criswell51e2a482005-06-29 16:22:34 +0000189
Chris Lattner72a269f2006-03-03 00:34:26 +0000190
191
Chris Lattner62495762003-10-02 16:38:05 +0000192<!-- *********************************************************************** -->
Misha Brukman80731b92003-11-22 00:38:41 +0000193<div class="doc_section">
194 <a name="portability">Portability and Supported Platforms</a>
195</div>
Chris Lattner62495762003-10-02 16:38:05 +0000196<!-- *********************************************************************** -->
197
Misha Brukman80731b92003-11-22 00:38:41 +0000198<div class="doc_text">
199
John Criswell64307722004-12-08 20:35:47 +0000200<p>LLVM is known to work on the following platforms:</p>
Chris Lattner2c7b0872004-06-01 18:22:41 +0000201
202<ul>
Reid Spencer9803b402005-05-17 02:47:27 +0000203 <li>Intel and AMD machines running Red Hat Linux, Fedora Core and FreeBSD
204 (and probably other unix-like systems).</li>
Chris Lattner4d918bb2006-08-09 04:10:32 +0000205<li>Intel and AMD machines running on Win32 using MinGW libraries (native)</li>
Chris Lattner2c7b0872004-06-01 18:22:41 +0000206<li>Sun UltraSPARC workstations running Solaris 8.</li>
Chris Lattnerb5bb5972004-12-07 08:04:13 +0000207<li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
208 support is available for native builds with Visual C++).</li>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000209<li>PowerPC and X86-based Mac OS X systems, running 10.2 and above in 32-bit and
210 64-bit modes.</li>
John Criswelld5234922005-05-13 20:28:15 +0000211<li>Alpha-based machines running Debian GNU/Linux.</li>
212<li>Itanium-based machines running Linux and HP-UX.</li>
Chris Lattner2c7b0872004-06-01 18:22:41 +0000213</ul>
214
Brian Gaekee3e557e2004-05-09 05:28:35 +0000215<p>The core LLVM infrastructure uses
216<a href="http://www.gnu.org/software/autoconf/">GNU autoconf</a> to adapt itself
217to the machine and operating system on which it is built. However, minor
218porting may be required to get LLVM to work on new platforms. We welcome your
219portability patches and reports of successful builds or error messages.</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000220
Misha Brukman80731b92003-11-22 00:38:41 +0000221</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000222
223<!-- *********************************************************************** -->
Misha Brukman80731b92003-11-22 00:38:41 +0000224<div class="doc_section">
225 <a name="knownproblems">Known Problems</a>
226</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000227<!-- *********************************************************************** -->
228
Misha Brukman80731b92003-11-22 00:38:41 +0000229<div class="doc_text">
230
231<p>This section contains all known problems with the LLVM system, listed by
Chris Lattner3d482502003-10-02 04:57:28 +0000232component. As new problems are discovered, they will be added to these
Chris Lattnerb84f3322003-12-12 21:22:16 +0000233sections. If you run into a problem, please check the <a
Chris Lattnera69595e2005-10-29 07:07:09 +0000234href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
Chris Lattnerb84f3322003-12-12 21:22:16 +0000235there isn't already one.</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000236
Misha Brukman80731b92003-11-22 00:38:41 +0000237</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000238
Chris Lattnerb911de42004-03-14 02:03:02 +0000239<!-- ======================================================================= -->
240<div class="doc_subsection">
241 <a name="experimental">Experimental features included with this release</a>
242</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000243
Chris Lattnerb911de42004-03-14 02:03:02 +0000244<div class="doc_text">
245
Misha Brukmanfa50a222004-05-12 21:46:05 +0000246<p>The following components of this LLVM release are either untested, known to
247be broken or unreliable, or are in early development. These components should
248not be relied on, and bugs should not be filed against them, but they may be
249useful to some people. In particular, if you would like to work on one of these
Chris Lattner05a225b2006-08-09 04:08:52 +0000250components, 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 +0000251
252<ul>
Chris Lattner9f871732006-04-18 06:18:36 +0000253<li>The <tt>-cee</tt> pass is known to be buggy, and may be removed in in a
254 future release.</li>
Chris Lattnerc9757932007-05-09 06:23:58 +0000255<li>C++ EH support</li>
Chris Lattnera38fe5f2006-02-05 06:39:36 +0000256<li>The IA64 code generator is experimental.</li>
Chris Lattnera69595e2005-10-29 07:07:09 +0000257<li>The Alpha JIT is experimental.</li>
Chris Lattner9f871732006-04-18 06:18:36 +0000258<li>"<tt>-filetype=asm</tt>" (the default) is the only supported value for the
259 <tt>-filetype</tt> llc option.</li>
Chris Lattnerb911de42004-03-14 02:03:02 +0000260</ul>
261
262</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000263
Misha Brukman80731b92003-11-22 00:38:41 +0000264<!-- ======================================================================= -->
265<div class="doc_subsection">
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000266 <a name="x86-be">Known problems with the X86 back-end</a>
John Criswell3bdbd302005-11-08 21:11:33 +0000267</div>
268
269<div class="doc_text">
270
271<ul>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000272<li>The X86 backend does not yet support <a href="http://llvm.org/PR879">inline
Chris Lattner98a33492007-05-09 04:58:11 +0000273 assembly that uses the X86 floating point stack</a>.</li>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000274</ul>
275
276</div>
277
278<!-- ======================================================================= -->
279<div class="doc_subsection">
280 <a name="ppc-be">Known problems with the PowerPC back-end</a>
281</div>
282
283<div class="doc_text">
284
285<ul>
286<li><a href="http://llvm.org/PR642">PowerPC backend does not correctly
287implement ordered FP comparisons</a>.</li>
Nicolas Geoffray77d99502007-05-15 09:21:28 +0000288<li>The Linux PPC32/ABI support needs testing for the interpreter and static
289compilation, and lacks Dwarf debugging informations.
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000290</ul>
291
292</div>
293
294<!-- ======================================================================= -->
295<div class="doc_subsection">
Chris Lattner97beb512007-05-14 06:56:09 +0000296 <a name="arm-be">Known problems with the ARM back-end</a>
297</div>
298
299<div class="doc_text">
300
301<ul>
302<li>The Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
303processors, any thumb program compiled with LLVM crashes or produces wrong
304results. (<a href="http://llvm.org/PR1388">PR1388</a>)</li>
305<li>Compilation for ARM Linux OABI (old ABI) is supported, but not fully tested.
306</li>
307<li>QEMU-ARM (<= 0.9.0) wrongly executes programs compiled with LLVM. A non-affected QEMU version must be used or this
308<a href="http://cvs.savannah.nongnu.org/viewcvs/qemu/target-arm/translate.c?root=qemu&r1=1.46&r2=1.47&makepatch=1&diff_format=h">
309patch</a> must be applied on QEMU.</li>
310</ul>
311
312</div>
313
314<!-- ======================================================================= -->
315<div class="doc_subsection">
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000316 <a name="sparc-be">Known problems with the SPARC back-end</a>
317</div>
318
319<div class="doc_text">
320
321<ul>
322<li>The SPARC backend only supports the 32-bit SPARC ABI (-m32), it does not
323 support the 64-bit SPARC ABI (-m64).</li>
324</ul>
325
326</div>
327
328<!-- ======================================================================= -->
329<div class="doc_subsection">
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000330 <a name="alpha-be">Known problems with the Alpha back-end</a>
331</div>
332
333<div class="doc_text">
334
335<ul>
336
337<li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
338appropriate nops inserted to ensure restartability.</li>
339
John Criswell3bdbd302005-11-08 21:11:33 +0000340</ul>
341</div>
342
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000343<!-- ======================================================================= -->
344<div class="doc_subsection">
345 <a name="ia64-be">Known problems with the IA64 back-end</a>
346</div>
347
348<div class="doc_text">
349
350<ul>
351
352<li>C++ programs are likely to fail on IA64, as calls to <tt>setjmp</tt> are
353made where the argument is not 16-byte aligned, as required on IA64. (Strictly
354speaking this is not a bug in the IA64 back-end; it will also be encountered
355when building C++ programs using the C back-end.)</li>
356
357<li>The C++ front-end does not use <a href="http://llvm.org/PR406">IA64
358ABI compliant layout of v-tables</a>. In particular, it just stores function
359pointers instead of function descriptors in the vtable. This bug prevents
360mixing C++ code compiled with LLVM with C++ objects compiled by other C++
361compilers.</li>
362
363<li>There are a few ABI violations which will lead to problems when mixing LLVM
364output with code built with other compilers, particularly for floating-point
365programs.</li>
366
367<li>Defining vararg functions is not supported (but calling them is ok).</li>
368
Chris Lattner98a33492007-05-09 04:58:11 +0000369<li>The Itanium backend has bitrotted somewhat.</li>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000370</ul>
371
372</div>
373
374<!-- ======================================================================= -->
375<div class="doc_subsection">
Chris Lattner97beb512007-05-14 06:56:09 +0000376 <a name="c-be">Known problems with the C back-end</a>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000377</div>
378
379<div class="doc_text">
380
381<ul>
Chris Lattner97beb512007-05-14 06:56:09 +0000382<li><a href="http://llvm.org/PR802">The C backend does not support inline
383 assembly code</a>.</li>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000384</ul>
385
386</div>
John Criswell3bdbd302005-11-08 21:11:33 +0000387
Misha Brukman80731b92003-11-22 00:38:41 +0000388
389<!-- ======================================================================= -->
390<div class="doc_subsection">
391 <a name="c-fe">Known problems with the C front-end</a>
392</div>
Chris Lattner178f3db2003-10-02 05:07:23 +0000393
Chris Lattner3d482502003-10-02 04:57:28 +0000394<!-- _______________________________________________________________________ -->
Chris Lattner5a8a7282003-12-14 05:03:43 +0000395<div class="doc_subsubsection">Bugs</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000396
Misha Brukman80731b92003-11-22 00:38:41 +0000397<div class="doc_text">
Chris Lattner72a269f2006-03-03 00:34:26 +0000398
Chris Lattner97beb512007-05-14 06:56:09 +0000399<p>llvm-gcc4 does not currently support <a href="http://llvm.org/PR869">Link-Time
400Optimization</a> on most platforms "out-of-the-box". Please inquire on the
401llvmdev mailing list if you are interested.</p>
Chris Lattner44124232006-08-08 17:27:28 +0000402
Chris Lattner97beb512007-05-14 06:56:09 +0000403<p>FIXME: the list of supported stuff below needs to be updated. We do support
404tls now, what else??</p>
Misha Brukman80731b92003-11-22 00:38:41 +0000405</div>
406
407<!-- _______________________________________________________________________ -->
408<div class="doc_subsubsection">
409 Notes
410</div>
411
412<div class="doc_text">
413
414<ul>
415
Chris Lattnerd2a74272003-10-27 18:30:37 +0000416<li>"long double" is transformed by the front-end into "double". There is no
Misha Brukman80731b92003-11-22 00:38:41 +0000417support for floating point data types of any size other than 32 and 64
418bits.</li>
419
Chris Lattner3d482502003-10-02 04:57:28 +0000420<li>Although many GCC extensions are supported, some are not. In particular,
421 the following extensions are known to <b>not be</b> supported:
422 <ol>
Misha Brukman80731b92003-11-22 00:38:41 +0000423 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Local-Labels.html#Local%20Labels">Local Labels</a>: Labels local to a block.</li>
Misha Brukman80731b92003-11-22 00:38:41 +0000424 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Nested-Functions.html#Nested%20Functions">Nested Functions</a>: As in Algol and Pascal, lexical scoping of functions.</li>
425 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Constructing-Calls.html#Constructing%20Calls">Constructing Calls</a>: Dispatching a call to another function.</li>
Tanya Lattner63371342004-12-08 18:25:34 +0000426 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Thread_002dLocal.html">Thread-Local</a>: Per-thread variables.</li>
Misha Brukman80731b92003-11-22 00:38:41 +0000427 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Pragmas.html#Pragmas">Pragmas</a>: Pragmas accepted by GCC.</li>
Misha Brukman7cb4e382003-11-22 01:00:11 +0000428 </ol>
Chris Lattner3d482502003-10-02 04:57:28 +0000429
Misha Brukman80731b92003-11-22 00:38:41 +0000430 <p>The following GCC extensions are <b>partially</b> supported. An ignored
Chris Lattner3d482502003-10-02 04:57:28 +0000431 attribute means that the LLVM compiler ignores the presence of the attribute,
432 but the code should still work. An unsupported attribute is one which is
John Criswell86a3a482003-12-18 16:43:17 +0000433 ignored by the LLVM compiler and will cause a different interpretation of
Misha Brukman80731b92003-11-22 00:38:41 +0000434 the program.</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000435
436 <ol>
437 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Length.html#Variable%20Length">Variable Length</a>:
438 Arrays whose length is computed at run time.<br>
Misha Brukman80731b92003-11-22 00:38:41 +0000439 Supported, but allocated stack space is not freed until the function returns (noted above).</li>
Chris Lattner3d482502003-10-02 04:57:28 +0000440
441 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Attributes.html#Function%20Attributes">Function Attributes</a>:
Misha Brukman80731b92003-11-22 00:38:41 +0000442
John Criswell86a3a482003-12-18 16:43:17 +0000443 Declaring that functions have no side effects or that they can never
Misha Brukman80731b92003-11-22 00:38:41 +0000444 return.<br>
445
Anton Korobeynikovc52614b2007-05-10 08:26:24 +0000446 <b>Supported:</b> <tt>alias</tt>, <tt>constructor</tt>, <tt>destructor</tt>,
Anton Korobeynikove7cbbfc2006-11-18 08:04:48 +0000447 <tt>deprecated</tt>, <tt>fastcall</tt>, <tt>format</tt>,
Anton Korobeynikovc52614b2007-05-10 08:26:24 +0000448 <tt>format_arg</tt>, <tt>non_null</tt>, <tt>noreturn</tt>, <tt>regparm</tt>
Anton Korobeynikovc7f9f3d2007-01-23 12:35:46 +0000449 <tt>section</tt>, <tt>stdcall</tt>, <tt>unused</tt>, <tt>used</tt>,
450 <tt>visibility</tt>, <tt>warn_unused_result</tt>, <tt>weak</tt><br>
Misha Brukman80731b92003-11-22 00:38:41 +0000451
John Criswell64307722004-12-08 20:35:47 +0000452 <b>Ignored:</b> <tt>noinline</tt>,
Misha Brukman80731b92003-11-22 00:38:41 +0000453 <tt>always_inline</tt>, <tt>pure</tt>, <tt>const</tt>, <tt>nothrow</tt>,
454 <tt>malloc</tt>, <tt>no_instrument_function</tt>, <tt>cdecl</tt><br>
455
Anton Korobeynikovc52614b2007-05-10 08:26:24 +0000456 <b>Unsupported:</b> All other target specific attributes</li>
Chris Lattner3d482502003-10-02 04:57:28 +0000457
458 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Attributes.html#Variable%20Attributes">Variable Attributes</a>:
459 Specifying attributes of variables.<br>
Anton Korobeynikovc52614b2007-05-10 08:26:24 +0000460 <b>Supported:</b> <tt>alias</tt>, <tt>cleanup</tt>, <tt>common</tt>,
461 <tt>nocommon</tt>, <tt>deprecated</tt>, <tt>dllimport</tt>,
462 <tt>dllexport</tt>, <tt>section</tt>, <tt>transparent_union</tt>,
463 <tt>unused</tt>, <tt>used</tt>, <tt>weak</tt><br>
Misha Brukman80731b92003-11-22 00:38:41 +0000464
Chris Lattner3d482502003-10-02 04:57:28 +0000465 <b>Unsupported:</b> <tt>aligned</tt>, <tt>mode</tt>, <tt>packed</tt>,
Anton Korobeynikovc7f9f3d2007-01-23 12:35:46 +0000466 <tt>shared</tt>, <tt>tls_model</tt>,
467 <tt>vector_size</tt>, all target specific attributes.
Anton Korobeynikove7cbbfc2006-11-18 08:04:48 +0000468 </li>
Chris Lattner3d482502003-10-02 04:57:28 +0000469
Misha Brukman8395d732003-12-12 04:37:31 +0000470 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Type-Attributes.html#Type%20Attributes">Type Attributes</a>: Specifying attributes of types.<br>
Chris Lattner3d482502003-10-02 04:57:28 +0000471 <b>Supported:</b> <tt>transparent_union</tt>, <tt>unused</tt>,
Misha Brukman8395d732003-12-12 04:37:31 +0000472 <tt>deprecated</tt>, <tt>may_alias</tt><br>
Misha Brukman80731b92003-11-22 00:38:41 +0000473
474 <b>Unsupported:</b> <tt>aligned</tt>, <tt>packed</tt>,
475 all target specific attributes.</li>
476
Chris Lattner3d482502003-10-02 04:57:28 +0000477 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Other-Builtins.html#Other%20Builtins">Other Builtins</a>:
478 Other built-in functions.<br>
479 We support all builtins which have a C language equivalent (e.g.,
480 <tt>__builtin_cos</tt>), <tt>__builtin_alloca</tt>,
481 <tt>__builtin_types_compatible_p</tt>, <tt>__builtin_choose_expr</tt>,
Chris Lattnerb7c4bac2004-06-18 06:26:29 +0000482 <tt>__builtin_constant_p</tt>, and <tt>__builtin_expect</tt>
483 (currently ignored). We also support builtins for ISO C99 floating
Chris Lattnerb34b2732005-05-07 02:21:21 +0000484 point comparison macros (e.g., <tt>__builtin_islessequal</tt>),
485 <tt>__builtin_prefetch</tt>, <tt>__builtin_popcount[ll]</tt>,
486 <tt>__builtin_clz[ll]</tt>, and <tt>__builtin_ctz[ll]</tt>.</li>
Misha Brukman80731b92003-11-22 00:38:41 +0000487 </ol>
Chris Lattner3d482502003-10-02 04:57:28 +0000488
Misha Brukman80731b92003-11-22 00:38:41 +0000489 <p>The following extensions <b>are</b> known to be supported:</p>
490
Chris Lattner3d482502003-10-02 04:57:28 +0000491 <ol>
Chris Lattnerd3dc8502004-03-16 08:54:07 +0000492 <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 +0000493 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Statement-Exprs.html#Statement%20Exprs">Statement Exprs</a>: Putting statements and declarations inside expressions.</li>
494 <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 +0000495 <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 +0000496 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Conditionals.html#Conditionals">Conditionals</a>: Omitting the middle operand of a <code>?:</code> expression.</li>
497 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Long-Long.html#Long%20Long">Long Long</a>: Double-word integers.</li>
498 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Complex.html#Complex">Complex</a>: Data types for complex numbers.</li>
499 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Hex-Floats.html#Hex%20Floats">Hex Floats</a>:Hexadecimal floating-point constants.</li>
500 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Zero-Length.html#Zero%20Length">Zero Length</a>: Zero-length arrays.</li>
501 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Empty-Structures.html#Empty%20Structures">Empty Structures</a>: Structures with no members.</li>
502 <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>
503 <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 +0000504 <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>
505 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Constraints.html#Constraints">Constraints</a>: Constraints for asm operands.</li>
506 <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>
507 <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>
508 <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>
509 <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 +0000510 <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 +0000511 <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 +0000512 <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 +0000513 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Compound-Literals.html#Compound%20Literals">Compound Literals</a>: Compound literals give structures, unions,
514or arrays as values.</li>
Misha Brukman80731b92003-11-22 00:38:41 +0000515 <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 +0000516 <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 +0000517 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Case-Ranges.html#Case%20Ranges">Case Ranges</a>: `case 1 ... 9' and such.</li>
518 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Mixed-Declarations.html#Mixed%20Declarations">Mixed Declarations</a>: Mixing declarations and code.</li>
519 <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 +0000520 <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 +0000521 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Dollar-Signs.html#Dollar%20Signs">Dollar Signs</a>: Dollar sign is allowed in identifiers.</li>
522 <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>
523 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Alignment.html#Alignment">Alignment</a>: Inquiring about the alignment of a type or variable.</li>
524 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Inline.html#Inline">Inline</a>: Defining inline functions (as fast as macros).</li>
525 <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>
526 <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>
527 <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 +0000528 <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 +0000529 <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>
530 <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 +0000531 </ol></li>
532
533</ul>
Chris Lattner3d482502003-10-02 04:57:28 +0000534
Misha Brukman80731b92003-11-22 00:38:41 +0000535<p>If you run into GCC extensions which have not been included in any of these
536lists, please let us know (also including whether or not they work).</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000537
Misha Brukman80731b92003-11-22 00:38:41 +0000538</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000539
Misha Brukman80731b92003-11-22 00:38:41 +0000540<!-- ======================================================================= -->
541<div class="doc_subsection">
542 <a name="c++-fe">Known problems with the C++ front-end</a>
543</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000544
Misha Brukman80731b92003-11-22 00:38:41 +0000545<div class="doc_text">
546
Chris Lattner97beb512007-05-14 06:56:09 +0000547<p>The C++ front-end is considered to be fully
Chris Lattnerb5bb5972004-12-07 08:04:13 +0000548tested and works for a number of non-trivial programs, including LLVM
Chris Lattner97beb512007-05-14 06:56:09 +0000549itself, Qt, Mozilla, etc.</p>
Misha Brukman80731b92003-11-22 00:38:41 +0000550
Misha Brukman80731b92003-11-22 00:38:41 +0000551<ul>
Chris Lattner97beb512007-05-14 06:56:09 +0000552<li>llvm-gcc4 only has partial support for <a href="http://llvm.org/PR870">C++
553Exception Handling</a>, and it is not enabled by default.</li>
554
555<!-- NO EH Support!
Chris Lattnerd2a74272003-10-27 18:30:37 +0000556
Chris Lattner3d482502003-10-02 04:57:28 +0000557<li>Destructors for local objects are not always run when a <tt>longjmp</tt> is
Chris Lattner62495762003-10-02 16:38:05 +0000558 performed. In particular, destructors for objects in the <tt>longjmp</tt>ing
Chris Lattner3d482502003-10-02 04:57:28 +0000559 function and in the <tt>setjmp</tt> receiver function may not be run.
John Criswell86a3a482003-12-18 16:43:17 +0000560 Objects in intervening stack frames will be destroyed, however (which is
Misha Brukman80731b92003-11-22 00:38:41 +0000561 better than most compilers).</li>
Chris Lattner3d482502003-10-02 04:57:28 +0000562
Chris Lattner62495762003-10-02 16:38:05 +0000563<li>The LLVM C++ front-end follows the <a
564 href="http://www.codesourcery.com/cxx-abi">Itanium C++ ABI</a>.
565 This document, which is not Itanium specific, specifies a standard for name
566 mangling, class layout, v-table layout, RTTI formats, and other C++
567 representation issues. Because we use this API, code generated by the LLVM
568 compilers should be binary compatible with machine code generated by other
569 Itanium ABI C++ compilers (such as G++, the Intel and HP compilers, etc).
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000570 <i>However</i>, the exception handling mechanism used by llvm-gcc3 is very
Chris Lattner62495762003-10-02 16:38:05 +0000571 different from the model used in the Itanium ABI, so <b>exceptions will not
Misha Brukman80731b92003-11-22 00:38:41 +0000572 interact correctly</b>. </li>
Chris Lattner97beb512007-05-14 06:56:09 +0000573-->
Misha Brukman80731b92003-11-22 00:38:41 +0000574</ul>
Chris Lattner46ecf612003-10-07 22:14:37 +0000575
Misha Brukman80731b92003-11-22 00:38:41 +0000576</div>
577
Misha Brukman80731b92003-11-22 00:38:41 +0000578
Chris Lattnerb62a5f02005-05-15 16:01:20 +0000579
Chris Lattner3d482502003-10-02 04:57:28 +0000580<!-- *********************************************************************** -->
Misha Brukman80731b92003-11-22 00:38:41 +0000581<div class="doc_section">
582 <a name="additionalinfo">Additional Information</a>
583</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000584<!-- *********************************************************************** -->
585
Misha Brukman80731b92003-11-22 00:38:41 +0000586<div class="doc_text">
587
Chris Lattnercb5596d2005-05-16 17:13:10 +0000588<p>A wide variety of additional information is available on the <a
Chris Lattnera69595e2005-10-29 07:07:09 +0000589href="http://llvm.org">LLVM web page</a>, including <a
590href="http://llvm.org/docs/">documentation</a> and <a
591href="http://llvm.org/pubs/">publications describing algorithms and
Misha Brukman96158092005-03-30 19:14:24 +0000592components implemented in LLVM</a>. The web page also contains versions of the
593API documentation which is up-to-date with the CVS version of the source code.
594You can access versions of these documents specific to this release by going
595into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000596
Misha Brukman80731b92003-11-22 00:38:41 +0000597<p>If you have any questions or comments about LLVM, please feel free to contact
Chris Lattnera69595e2005-10-29 07:07:09 +0000598us via the <a href="http://llvm.org/docs/#maillist"> mailing
Chris Lattnerb84f3322003-12-12 21:22:16 +0000599lists</a>.</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000600
Misha Brukman80731b92003-11-22 00:38:41 +0000601</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000602
603<!-- *********************************************************************** -->
Chris Lattner3d482502003-10-02 04:57:28 +0000604
Misha Brukman80731b92003-11-22 00:38:41 +0000605<hr>
Misha Brukman68aab3b2003-11-22 01:23:39 +0000606<address>
Misha Brukman8834af92003-12-21 22:53:21 +0000607 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman68aab3b2003-11-22 01:23:39 +0000608 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
609 <a href="http://validator.w3.org/check/referer"><img
610 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
611
Chris Lattnera69595e2005-10-29 07:07:09 +0000612 <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br>
Misha Brukman80731b92003-11-22 00:38:41 +0000613 Last modified: $Date$
Misha Brukman68aab3b2003-11-22 01:23:39 +0000614</address>
Chris Lattner3d482502003-10-02 04:57:28 +0000615
Misha Brukman80731b92003-11-22 00:38:41 +0000616</body>
617</html>