blob: edcef564ce1961dd9cf8f2f7a3b5cefb0c9cb64c [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.
62Being the first major release since 1.0, we took this as an opportunity to
63break backwards compatibility with the LLVM 1.x bytecode and .ll file format.
64If you have LLVM 1.9 .ll files that you would like to upgrade to LLVM 2.x, we
65recommend the use of the stand alone <a href=#llvm-upgrade">llvm-upgrade</a>
66tool. We intend to keep compatibility with .ll and .bc formats within the 2.x
67release series.</p>
68
69<p>Note that while
70 This
71release
72incorporates a large number of enhancements, new features, and bug
Chris Lattnerb81f10e2006-11-18 07:51:14 +000073fixes. We recommend that all users of previous LLVM versions upgrade.
Chris Lattner9f871732006-04-18 06:18:36 +000074</p>
Chris Lattnerba7bd472003-12-06 20:22:41 +000075
Chris Lattner21a90402004-05-24 04:50:25 +000076</div>
77
Chris Lattnerba7bd472003-12-06 20:22:41 +000078<!--=========================================================================-->
Chris Lattner406bddf2005-05-15 05:44:51 +000079<div class="doc_subsection">
Chris Lattner98a33492007-05-09 04:58:11 +000080<a name="newfeatures">New Features in LLVM 2.0</a>
Chris Lattner9f871732006-04-18 06:18:36 +000081</div>
82
Chris Lattner89e761c2006-04-18 06:32:08 +000083<!--_________________________________________________________________________-->
Chris Lattnerb81f10e2006-11-18 07:51:14 +000084<div class="doc_subsubsection"><a name="optimizer">Optimizer
85Improvements</a></div>
Chris Lattner89e761c2006-04-18 06:32:08 +000086<div class="doc_text">
Chris Lattnerb81f10e2006-11-18 07:51:14 +000087<p>The mid-level optimizer is now faster and produces better code in many cases.
88 Significant changes include:</p>
89
90<ul>
Chris Lattner98a33492007-05-09 04:58:11 +000091<li></li>
Chris Lattnerb81f10e2006-11-18 07:51:14 +000092</ul>
93
Chris Lattner89e761c2006-04-18 06:32:08 +000094</div>
95
Chris Lattner0b7fd712006-04-19 04:02:47 +000096<!--_________________________________________________________________________-->
Chris Lattnerb81f10e2006-11-18 07:51:14 +000097<div class="doc_subsubsection"><a name="codegen">Code
98Generator Enhancements</a></div>
99
Chris Lattner0b7fd712006-04-19 04:02:47 +0000100<div class="doc_text">
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000101<p>
102The LLVM Target-Independent code generator now supports more target features and
103optimizes many cases more aggressively. New features include:
104</p>
105
106<ul>
Chris Lattner98a33492007-05-09 04:58:11 +0000107<li></li>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000108</ul>
109
110<p>In addition, the LLVM target description format has itself been extended in
111 several ways:</p>
112
113<ul>
Chris Lattner98a33492007-05-09 04:58:11 +0000114<li></li>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000115</ul>
116
117<p>Further, several significant target-specific enhancements are included in
Chris Lattner98a33492007-05-09 04:58:11 +0000118LLVM 2.0:</p>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000119
120<ul>
Chris Lattner98a33492007-05-09 04:58:11 +0000121<li></li>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000122</ul>
123
Chris Lattner0b7fd712006-04-19 04:02:47 +0000124</div>
Chris Lattner9f871732006-04-18 06:18:36 +0000125
126<!--_________________________________________________________________________-->
Chris Lattner44124232006-08-08 17:27:28 +0000127<div class="doc_subsubsection"><a name="other">Other Improvements</a></div>
Chris Lattnera38fe5f2006-02-05 06:39:36 +0000128<div class="doc_text">
Chris Lattner98a33492007-05-09 04:58:11 +0000129<p></p>
Chris Lattner44124232006-08-08 17:27:28 +0000130
131<p>More specific changes include:</p>
132
Chris Lattnera38fe5f2006-02-05 06:39:36 +0000133<ul>
Chris Lattner98a33492007-05-09 04:58:11 +0000134<li></li>
Chris Lattnera38fe5f2006-02-05 06:39:36 +0000135</ul>
136</div>
John Criswell51e2a482005-06-29 16:22:34 +0000137
Chris Lattner72a269f2006-03-03 00:34:26 +0000138
139
Chris Lattner62495762003-10-02 16:38:05 +0000140<!-- *********************************************************************** -->
Misha Brukman80731b92003-11-22 00:38:41 +0000141<div class="doc_section">
142 <a name="portability">Portability and Supported Platforms</a>
143</div>
Chris Lattner62495762003-10-02 16:38:05 +0000144<!-- *********************************************************************** -->
145
Misha Brukman80731b92003-11-22 00:38:41 +0000146<div class="doc_text">
147
John Criswell64307722004-12-08 20:35:47 +0000148<p>LLVM is known to work on the following platforms:</p>
Chris Lattner2c7b0872004-06-01 18:22:41 +0000149
150<ul>
Reid Spencer9803b402005-05-17 02:47:27 +0000151 <li>Intel and AMD machines running Red Hat Linux, Fedora Core and FreeBSD
152 (and probably other unix-like systems).</li>
Chris Lattner4d918bb2006-08-09 04:10:32 +0000153<li>Intel and AMD machines running on Win32 using MinGW libraries (native)</li>
Chris Lattner2c7b0872004-06-01 18:22:41 +0000154<li>Sun UltraSPARC workstations running Solaris 8.</li>
Chris Lattnerb5bb5972004-12-07 08:04:13 +0000155<li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
156 support is available for native builds with Visual C++).</li>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000157<li>PowerPC and X86-based Mac OS X systems, running 10.2 and above in 32-bit and
158 64-bit modes.</li>
John Criswelld5234922005-05-13 20:28:15 +0000159<li>Alpha-based machines running Debian GNU/Linux.</li>
160<li>Itanium-based machines running Linux and HP-UX.</li>
Chris Lattner2c7b0872004-06-01 18:22:41 +0000161</ul>
162
Brian Gaekee3e557e2004-05-09 05:28:35 +0000163<p>The core LLVM infrastructure uses
164<a href="http://www.gnu.org/software/autoconf/">GNU autoconf</a> to adapt itself
165to the machine and operating system on which it is built. However, minor
166porting may be required to get LLVM to work on new platforms. We welcome your
167portability patches and reports of successful builds or error messages.</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000168
Misha Brukman80731b92003-11-22 00:38:41 +0000169</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000170
171<!-- *********************************************************************** -->
Misha Brukman80731b92003-11-22 00:38:41 +0000172<div class="doc_section">
173 <a name="knownproblems">Known Problems</a>
174</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000175<!-- *********************************************************************** -->
176
Misha Brukman80731b92003-11-22 00:38:41 +0000177<div class="doc_text">
178
179<p>This section contains all known problems with the LLVM system, listed by
Chris Lattner3d482502003-10-02 04:57:28 +0000180component. As new problems are discovered, they will be added to these
Chris Lattnerb84f3322003-12-12 21:22:16 +0000181sections. If you run into a problem, please check the <a
Chris Lattnera69595e2005-10-29 07:07:09 +0000182href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
Chris Lattnerb84f3322003-12-12 21:22:16 +0000183there isn't already one.</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000184
Misha Brukman80731b92003-11-22 00:38:41 +0000185</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000186
Chris Lattnerb911de42004-03-14 02:03:02 +0000187<!-- ======================================================================= -->
188<div class="doc_subsection">
189 <a name="experimental">Experimental features included with this release</a>
190</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000191
Chris Lattnerb911de42004-03-14 02:03:02 +0000192<div class="doc_text">
193
Misha Brukmanfa50a222004-05-12 21:46:05 +0000194<p>The following components of this LLVM release are either untested, known to
195be broken or unreliable, or are in early development. These components should
196not be relied on, and bugs should not be filed against them, but they may be
197useful to some people. In particular, if you would like to work on one of these
Chris Lattner05a225b2006-08-09 04:08:52 +0000198components, 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 +0000199
200<ul>
Chris Lattner9f871732006-04-18 06:18:36 +0000201<li>The <tt>-cee</tt> pass is known to be buggy, and may be removed in in a
202 future release.</li>
Chris Lattnera38fe5f2006-02-05 06:39:36 +0000203<li>The IA64 code generator is experimental.</li>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000204<li>The ARM code generator is experimental.</li>
Chris Lattnera69595e2005-10-29 07:07:09 +0000205<li>The Alpha JIT is experimental.</li>
Chris Lattner9f871732006-04-18 06:18:36 +0000206<li>"<tt>-filetype=asm</tt>" (the default) is the only supported value for the
207 <tt>-filetype</tt> llc option.</li>
Chris Lattnerb911de42004-03-14 02:03:02 +0000208</ul>
209
210</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000211
Misha Brukman80731b92003-11-22 00:38:41 +0000212<!-- ======================================================================= -->
213<div class="doc_subsection">
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000214 <a name="x86-be">Known problems with the X86 back-end</a>
John Criswell3bdbd302005-11-08 21:11:33 +0000215</div>
216
217<div class="doc_text">
218
219<ul>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000220<li>The X86 backend does not yet support <a href="http://llvm.org/PR879">inline
Chris Lattner98a33492007-05-09 04:58:11 +0000221 assembly that uses the X86 floating point stack</a>.</li>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000222</ul>
223
224</div>
225
226<!-- ======================================================================= -->
227<div class="doc_subsection">
228 <a name="ppc-be">Known problems with the PowerPC back-end</a>
229</div>
230
231<div class="doc_text">
232
233<ul>
234<li><a href="http://llvm.org/PR642">PowerPC backend does not correctly
235implement ordered FP comparisons</a>.</li>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000236</ul>
237
238</div>
239
240<!-- ======================================================================= -->
241<div class="doc_subsection">
242 <a name="sparc-be">Known problems with the SPARC back-end</a>
243</div>
244
245<div class="doc_text">
246
247<ul>
248<li>The SPARC backend only supports the 32-bit SPARC ABI (-m32), it does not
249 support the 64-bit SPARC ABI (-m64).</li>
250</ul>
251
252</div>
253
254<!-- ======================================================================= -->
255<div class="doc_subsection">
256 <a name="c-be">Known problems with the C back-end</a>
257</div>
258
259<div class="doc_text">
260
261<ul>
262
263<li>The C back-end produces code that violates the ANSI C Type-Based Alias
264Analysis rules. As such, special options may be necessary to compile the code
265(for example, GCC requires the <tt>-fno-strict-aliasing</tt> option). This
266problem probably cannot be fixed.</li>
267
268<li><a href="http://llvm.org/PR56">Zero arg vararg functions are not
269supported</a>. This should not affect LLVM produced by the C or C++
270frontends.</li>
271
272<li>The C backend does not correctly implement the <a
Reid Spencerca5fdf32007-04-04 04:14:31 +0000273href="LangRef.html#int_stacksave"><tt>llvm.stacksave</tt></a> or
274<a href="LangRef.html#int_stackrestore"><tt>llvm.stackrestore</tt></a>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000275intrinsics. This means that some code compiled by it can run out of stack
276space if they depend on these (e.g. C99 varargs).</li>
277
278<li><a href="http://llvm.org/PR802">The C backend does not support inline
279 assembly code</a>.</li>
280</ul>
281
282</div>
283
284<!-- ======================================================================= -->
285<div class="doc_subsection">
286 <a name="alpha-be">Known problems with the Alpha back-end</a>
287</div>
288
289<div class="doc_text">
290
291<ul>
292
293<li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
294appropriate nops inserted to ensure restartability.</li>
295
John Criswell3bdbd302005-11-08 21:11:33 +0000296</ul>
297</div>
298
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000299<!-- ======================================================================= -->
300<div class="doc_subsection">
301 <a name="ia64-be">Known problems with the IA64 back-end</a>
302</div>
303
304<div class="doc_text">
305
306<ul>
307
308<li>C++ programs are likely to fail on IA64, as calls to <tt>setjmp</tt> are
309made where the argument is not 16-byte aligned, as required on IA64. (Strictly
310speaking this is not a bug in the IA64 back-end; it will also be encountered
311when building C++ programs using the C back-end.)</li>
312
313<li>The C++ front-end does not use <a href="http://llvm.org/PR406">IA64
314ABI compliant layout of v-tables</a>. In particular, it just stores function
315pointers instead of function descriptors in the vtable. This bug prevents
316mixing C++ code compiled with LLVM with C++ objects compiled by other C++
317compilers.</li>
318
319<li>There are a few ABI violations which will lead to problems when mixing LLVM
320output with code built with other compilers, particularly for floating-point
321programs.</li>
322
323<li>Defining vararg functions is not supported (but calling them is ok).</li>
324
Chris Lattner98a33492007-05-09 04:58:11 +0000325<li>The Itanium backend has bitrotted somewhat.</li>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000326</ul>
327
328</div>
329
330<!-- ======================================================================= -->
331<div class="doc_subsection">
332 <a name="arm-be">Known problems with the ARM back-end</a>
333</div>
334
335<div class="doc_text">
336
337<ul>
338<li>The ARM backend is currently in early development stages, it is not
339ready for production use.</li>
340</ul>
341
342</div>
John Criswell3bdbd302005-11-08 21:11:33 +0000343
344<!-- ======================================================================= -->
345<div class="doc_subsection">
Misha Brukman80731b92003-11-22 00:38:41 +0000346 <a name="core">Known problems with the LLVM Core</a>
347</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000348
Misha Brukman80731b92003-11-22 00:38:41 +0000349<div class="doc_text">
350
351<ul>
Misha Brukman96158092005-03-30 19:14:24 +0000352 <li>In the JIT, <tt>dlsym()</tt> on a symbol compiled by the JIT will not
353 work.</li>
Misha Brukman80731b92003-11-22 00:38:41 +0000354</ul>
Misha Brukman80731b92003-11-22 00:38:41 +0000355</div>
356
357<!-- ======================================================================= -->
358<div class="doc_subsection">
359 <a name="c-fe">Known problems with the C front-end</a>
360</div>
Chris Lattner178f3db2003-10-02 05:07:23 +0000361
Chris Lattner3d482502003-10-02 04:57:28 +0000362<!-- _______________________________________________________________________ -->
Chris Lattner5a8a7282003-12-14 05:03:43 +0000363<div class="doc_subsubsection">Bugs</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000364
Misha Brukman80731b92003-11-22 00:38:41 +0000365<div class="doc_text">
Chris Lattner72a269f2006-03-03 00:34:26 +0000366
Chris Lattner9f871732006-04-18 06:18:36 +0000367<p>
Chris Lattner44124232006-08-08 17:27:28 +0000368
369<p>llvm-gcc4 is far more stable and produces better code than llvm-gcc3, but
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000370does not currently support <a href="http://llvm.org/PR869">Link-Time
371Optimization</a> or <a href="http://llvm.org/PR870">C++ Exception Handling</a>,
Chris Lattner44124232006-08-08 17:27:28 +0000372which llvm-gcc3 does.</p>
373
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000374<p>llvm-gcc4 does not support the <a href="http://llvm.org/PR947">GCC indirect
375goto extension</a>, but llvm-gcc3 does.</p>
376
Misha Brukman80731b92003-11-22 00:38:41 +0000377</div>
378
379<!-- _______________________________________________________________________ -->
380<div class="doc_subsubsection">
381 Notes
382</div>
383
384<div class="doc_text">
385
386<ul>
387
Chris Lattnerd2a74272003-10-27 18:30:37 +0000388<li>"long double" is transformed by the front-end into "double". There is no
Misha Brukman80731b92003-11-22 00:38:41 +0000389support for floating point data types of any size other than 32 and 64
390bits.</li>
391
Chris Lattner3d482502003-10-02 04:57:28 +0000392<li>Although many GCC extensions are supported, some are not. In particular,
393 the following extensions are known to <b>not be</b> supported:
394 <ol>
Misha Brukman80731b92003-11-22 00:38:41 +0000395 <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 +0000396 <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>
397 <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 +0000398 <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 +0000399 <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 +0000400 </ol>
Chris Lattner3d482502003-10-02 04:57:28 +0000401
Misha Brukman80731b92003-11-22 00:38:41 +0000402 <p>The following GCC extensions are <b>partially</b> supported. An ignored
Chris Lattner3d482502003-10-02 04:57:28 +0000403 attribute means that the LLVM compiler ignores the presence of the attribute,
404 but the code should still work. An unsupported attribute is one which is
John Criswell86a3a482003-12-18 16:43:17 +0000405 ignored by the LLVM compiler and will cause a different interpretation of
Misha Brukman80731b92003-11-22 00:38:41 +0000406 the program.</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000407
408 <ol>
409 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Length.html#Variable%20Length">Variable Length</a>:
410 Arrays whose length is computed at run time.<br>
Misha Brukman80731b92003-11-22 00:38:41 +0000411 Supported, but allocated stack space is not freed until the function returns (noted above).</li>
Chris Lattner3d482502003-10-02 04:57:28 +0000412
413 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Attributes.html#Function%20Attributes">Function Attributes</a>:
Misha Brukman80731b92003-11-22 00:38:41 +0000414
John Criswell86a3a482003-12-18 16:43:17 +0000415 Declaring that functions have no side effects or that they can never
Misha Brukman80731b92003-11-22 00:38:41 +0000416 return.<br>
417
Anton Korobeynikove7cbbfc2006-11-18 08:04:48 +0000418 <b>Supported:</b> <tt>constructor</tt>, <tt>destructor</tt>,
419 <tt>deprecated</tt>, <tt>fastcall</tt>, <tt>format</tt>,
420 <tt>format_arg</tt>, <tt>non_null</tt>, <tt>noreturn</tt>,
Anton Korobeynikovc7f9f3d2007-01-23 12:35:46 +0000421 <tt>section</tt>, <tt>stdcall</tt>, <tt>unused</tt>, <tt>used</tt>,
422 <tt>visibility</tt>, <tt>warn_unused_result</tt>, <tt>weak</tt><br>
Misha Brukman80731b92003-11-22 00:38:41 +0000423
John Criswell64307722004-12-08 20:35:47 +0000424 <b>Ignored:</b> <tt>noinline</tt>,
Misha Brukman80731b92003-11-22 00:38:41 +0000425 <tt>always_inline</tt>, <tt>pure</tt>, <tt>const</tt>, <tt>nothrow</tt>,
426 <tt>malloc</tt>, <tt>no_instrument_function</tt>, <tt>cdecl</tt><br>
427
Anton Korobeynikovc7f9f3d2007-01-23 12:35:46 +0000428 <b>Unsupported:</b> <tt>alias</tt>, <tt>regparm</tt>, all other target specific
Anton Korobeynikove7cbbfc2006-11-18 08:04:48 +0000429 attributes</li>
Chris Lattner3d482502003-10-02 04:57:28 +0000430
431 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Attributes.html#Variable%20Attributes">Variable Attributes</a>:
432 Specifying attributes of variables.<br>
433 <b>Supported:</b> <tt>cleanup</tt>, <tt>common</tt>, <tt>nocommon</tt>,
Anton Korobeynikovc7f9f3d2007-01-23 12:35:46 +0000434 <tt>deprecated</tt>, <tt>dllimport</tt>, <tt>dllexport</tt>,
435 <tt>section</tt>, <tt>transparent_union</tt>, <tt>unused</tt>,
436 <tt>used</tt>, <tt>weak</tt><br>
Misha Brukman80731b92003-11-22 00:38:41 +0000437
Chris Lattner3d482502003-10-02 04:57:28 +0000438 <b>Unsupported:</b> <tt>aligned</tt>, <tt>mode</tt>, <tt>packed</tt>,
Anton Korobeynikovc7f9f3d2007-01-23 12:35:46 +0000439 <tt>shared</tt>, <tt>tls_model</tt>,
440 <tt>vector_size</tt>, all target specific attributes.
Anton Korobeynikove7cbbfc2006-11-18 08:04:48 +0000441 </li>
Chris Lattner3d482502003-10-02 04:57:28 +0000442
Misha Brukman8395d732003-12-12 04:37:31 +0000443 <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 +0000444 <b>Supported:</b> <tt>transparent_union</tt>, <tt>unused</tt>,
Misha Brukman8395d732003-12-12 04:37:31 +0000445 <tt>deprecated</tt>, <tt>may_alias</tt><br>
Misha Brukman80731b92003-11-22 00:38:41 +0000446
447 <b>Unsupported:</b> <tt>aligned</tt>, <tt>packed</tt>,
448 all target specific attributes.</li>
449
Chris Lattner3d482502003-10-02 04:57:28 +0000450 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Other-Builtins.html#Other%20Builtins">Other Builtins</a>:
451 Other built-in functions.<br>
452 We support all builtins which have a C language equivalent (e.g.,
453 <tt>__builtin_cos</tt>), <tt>__builtin_alloca</tt>,
454 <tt>__builtin_types_compatible_p</tt>, <tt>__builtin_choose_expr</tt>,
Chris Lattnerb7c4bac2004-06-18 06:26:29 +0000455 <tt>__builtin_constant_p</tt>, and <tt>__builtin_expect</tt>
456 (currently ignored). We also support builtins for ISO C99 floating
Chris Lattnerb34b2732005-05-07 02:21:21 +0000457 point comparison macros (e.g., <tt>__builtin_islessequal</tt>),
458 <tt>__builtin_prefetch</tt>, <tt>__builtin_popcount[ll]</tt>,
459 <tt>__builtin_clz[ll]</tt>, and <tt>__builtin_ctz[ll]</tt>.</li>
Misha Brukman80731b92003-11-22 00:38:41 +0000460 </ol>
Chris Lattner3d482502003-10-02 04:57:28 +0000461
Misha Brukman80731b92003-11-22 00:38:41 +0000462 <p>The following extensions <b>are</b> known to be supported:</p>
463
Chris Lattner3d482502003-10-02 04:57:28 +0000464 <ol>
Chris Lattnerd3dc8502004-03-16 08:54:07 +0000465 <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 +0000466 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Statement-Exprs.html#Statement%20Exprs">Statement Exprs</a>: Putting statements and declarations inside expressions.</li>
467 <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 +0000468 <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 +0000469 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Conditionals.html#Conditionals">Conditionals</a>: Omitting the middle operand of a <code>?:</code> expression.</li>
470 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Long-Long.html#Long%20Long">Long Long</a>: Double-word integers.</li>
471 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Complex.html#Complex">Complex</a>: Data types for complex numbers.</li>
472 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Hex-Floats.html#Hex%20Floats">Hex Floats</a>:Hexadecimal floating-point constants.</li>
473 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Zero-Length.html#Zero%20Length">Zero Length</a>: Zero-length arrays.</li>
474 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Empty-Structures.html#Empty%20Structures">Empty Structures</a>: Structures with no members.</li>
475 <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>
476 <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 +0000477 <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>
478 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Constraints.html#Constraints">Constraints</a>: Constraints for asm operands.</li>
479 <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>
480 <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>
481 <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>
482 <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 +0000483 <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 +0000484 <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 +0000485 <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 +0000486 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Compound-Literals.html#Compound%20Literals">Compound Literals</a>: Compound literals give structures, unions,
487or arrays as values.</li>
Misha Brukman80731b92003-11-22 00:38:41 +0000488 <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 +0000489 <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 +0000490 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Case-Ranges.html#Case%20Ranges">Case Ranges</a>: `case 1 ... 9' and such.</li>
491 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Mixed-Declarations.html#Mixed%20Declarations">Mixed Declarations</a>: Mixing declarations and code.</li>
492 <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 +0000493 <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 +0000494 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Dollar-Signs.html#Dollar%20Signs">Dollar Signs</a>: Dollar sign is allowed in identifiers.</li>
495 <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>
496 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Alignment.html#Alignment">Alignment</a>: Inquiring about the alignment of a type or variable.</li>
497 <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Inline.html#Inline">Inline</a>: Defining inline functions (as fast as macros).</li>
498 <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>
499 <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>
500 <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 +0000501 <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 +0000502 <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>
503 <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 +0000504 </ol></li>
505
506</ul>
Chris Lattner3d482502003-10-02 04:57:28 +0000507
Misha Brukman80731b92003-11-22 00:38:41 +0000508<p>If you run into GCC extensions which have not been included in any of these
509lists, please let us know (also including whether or not they work).</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000510
Misha Brukman80731b92003-11-22 00:38:41 +0000511</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000512
Misha Brukman80731b92003-11-22 00:38:41 +0000513<!-- ======================================================================= -->
514<div class="doc_subsection">
515 <a name="c++-fe">Known problems with the C++ front-end</a>
516</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000517
Misha Brukman80731b92003-11-22 00:38:41 +0000518<div class="doc_text">
519
Reid Spencer55684c32004-12-07 08:39:08 +0000520<p>For this release, the C++ front-end is considered to be fully
Chris Lattnerb5bb5972004-12-07 08:04:13 +0000521tested and works for a number of non-trivial programs, including LLVM
522itself.</p>
Misha Brukman80731b92003-11-22 00:38:41 +0000523
524</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000525
526<!-- _______________________________________________________________________ -->
Misha Brukman80731b92003-11-22 00:38:41 +0000527<div class="doc_subsubsection">
528 Notes
529</div>
530
531<div class="doc_text">
Misha Brukman80731b92003-11-22 00:38:41 +0000532<ul>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000533<li>llvm-gcc4 does not support C++ exception handling at all yet.</li>
Chris Lattnerd2a74272003-10-27 18:30:37 +0000534
Chris Lattner3d482502003-10-02 04:57:28 +0000535<li>Destructors for local objects are not always run when a <tt>longjmp</tt> is
Chris Lattner62495762003-10-02 16:38:05 +0000536 performed. In particular, destructors for objects in the <tt>longjmp</tt>ing
Chris Lattner3d482502003-10-02 04:57:28 +0000537 function and in the <tt>setjmp</tt> receiver function may not be run.
John Criswell86a3a482003-12-18 16:43:17 +0000538 Objects in intervening stack frames will be destroyed, however (which is
Misha Brukman80731b92003-11-22 00:38:41 +0000539 better than most compilers).</li>
Chris Lattner3d482502003-10-02 04:57:28 +0000540
Chris Lattner62495762003-10-02 16:38:05 +0000541<li>The LLVM C++ front-end follows the <a
542 href="http://www.codesourcery.com/cxx-abi">Itanium C++ ABI</a>.
543 This document, which is not Itanium specific, specifies a standard for name
544 mangling, class layout, v-table layout, RTTI formats, and other C++
545 representation issues. Because we use this API, code generated by the LLVM
546 compilers should be binary compatible with machine code generated by other
547 Itanium ABI C++ compilers (such as G++, the Intel and HP compilers, etc).
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000548 <i>However</i>, the exception handling mechanism used by llvm-gcc3 is very
Chris Lattner62495762003-10-02 16:38:05 +0000549 different from the model used in the Itanium ABI, so <b>exceptions will not
Misha Brukman80731b92003-11-22 00:38:41 +0000550 interact correctly</b>. </li>
Chris Lattner3d482502003-10-02 04:57:28 +0000551
Misha Brukman80731b92003-11-22 00:38:41 +0000552</ul>
Chris Lattner46ecf612003-10-07 22:14:37 +0000553
Misha Brukman80731b92003-11-22 00:38:41 +0000554</div>
555
Misha Brukman80731b92003-11-22 00:38:41 +0000556
Chris Lattnerb62a5f02005-05-15 16:01:20 +0000557
Chris Lattner3d482502003-10-02 04:57:28 +0000558<!-- *********************************************************************** -->
Misha Brukman80731b92003-11-22 00:38:41 +0000559<div class="doc_section">
560 <a name="additionalinfo">Additional Information</a>
561</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000562<!-- *********************************************************************** -->
563
Misha Brukman80731b92003-11-22 00:38:41 +0000564<div class="doc_text">
565
Chris Lattnercb5596d2005-05-16 17:13:10 +0000566<p>A wide variety of additional information is available on the <a
Chris Lattnera69595e2005-10-29 07:07:09 +0000567href="http://llvm.org">LLVM web page</a>, including <a
568href="http://llvm.org/docs/">documentation</a> and <a
569href="http://llvm.org/pubs/">publications describing algorithms and
Misha Brukman96158092005-03-30 19:14:24 +0000570components implemented in LLVM</a>. The web page also contains versions of the
571API documentation which is up-to-date with the CVS version of the source code.
572You can access versions of these documents specific to this release by going
573into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000574
Misha Brukman80731b92003-11-22 00:38:41 +0000575<p>If you have any questions or comments about LLVM, please feel free to contact
Chris Lattnera69595e2005-10-29 07:07:09 +0000576us via the <a href="http://llvm.org/docs/#maillist"> mailing
Chris Lattnerb84f3322003-12-12 21:22:16 +0000577lists</a>.</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000578
Misha Brukman80731b92003-11-22 00:38:41 +0000579</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000580
581<!-- *********************************************************************** -->
Chris Lattner3d482502003-10-02 04:57:28 +0000582
Misha Brukman80731b92003-11-22 00:38:41 +0000583<hr>
Misha Brukman68aab3b2003-11-22 01:23:39 +0000584<address>
Misha Brukman8834af92003-12-21 22:53:21 +0000585 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman68aab3b2003-11-22 01:23:39 +0000586 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
587 <a href="http://validator.w3.org/check/referer"><img
588 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
589
Chris Lattnera69595e2005-10-29 07:07:09 +0000590 <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br>
Misha Brukman80731b92003-11-22 00:38:41 +0000591 Last modified: $Date$
Misha Brukman68aab3b2003-11-22 01:23:39 +0000592</address>
Chris Lattner3d482502003-10-02 04:57:28 +0000593
Misha Brukman80731b92003-11-22 00:38:41 +0000594</body>
595</html>