Note about bytecode format
[oota-llvm.git] / docs / ReleaseNotes.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2                       "http://www.w3.org/TR/html4/strict.dtd">
3 <html>
4 <head>
5   <link rel="stylesheet" href="llvm.css" type="text/css">
6   <title>LLVM 1.1 Release Notes</title>
7 </head>
8 <body>
9
10 <div class="doc_title">
11   LLVM 1.1 Release Notes
12 </div>
13  
14 <ol>
15   <li><a href="#intro">Introduction</a></li>
16   <li><a href="#whatsnew">What's New?</a></li>
17   <li><a href="#portability">Portability and Supported Platforms</a></li>
18   <li><a href="#install-instructions">Installation Instructions</a></li>
19   <li><a href="#knownproblems">Known Problems</a>
20   <ul>
21 <!--    <li><a href="#portabilityprobs">Portability Problems</a> -->
22     <li><a href="#core">Known problems with the LLVM Core</a>
23     <li><a href="#c-fe">Known problems with the C Front-end</a>
24     <li><a href="#c++-fe">Known problems with the C++ Front-end</a>
25     <li><a href="#x86-be">Known problems with the X86 Back-end</a>
26     <li><a href="#sparc-be">Known problems with the Sparc Back-end</a>
27     <li><a href="#c-be">Known problems with the C back-end</a>
28   </ul></li>
29   <li><a href="#additionalinfo">Additional Information</a></li>
30 </ol>
31
32 <div class="doc_text">
33   <p><b>Written by <a href="mailto:sabre@nondot.org">Chris Lattner</a></b><p>
34 </div>
35
36 <!-- *********************************************************************** -->
37 <div class="doc_section">
38   <a name="intro">Introduction</a>
39 </div>
40 <!-- *********************************************************************** -->
41
42 <div class="doc_text">
43
44 <p>This document contains the release notes for the LLVM compiler
45 infrastructure, release 1.1.  Here we describe the status of LLVM, including any
46 known problems, and bug fixes from the previous release.  The most up-to-date
47 version of this document can be found on the <a
48 href="http://llvm.cs.uiuc.edu/releases/1.1/">LLVM 1.1 web site</a>.  If you are
49 not reading this on the LLVM web pages, you should probably go there, because
50 this document may be updated after the release.</p>
51
52 <p>For more information about LLVM, including information about potentially more
53 current releases, please check out the <a href="http://llvm.cs.uiuc.edu">main
54 web site</a>.  If you have questions or comments, the <a
55 href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM developer's mailing
56 list</a> is a good place to send them.</p>
57
58 <p>Note that if you are reading this file from CVS, this document applies
59 to the <i>next</i> release, not the current one.  To see the release notes for
60 the current or previous releases, see the <a
61 href="http://llvm.cs.uiuc.edu/releases/">releases page</a>.</p>
62
63 </div>
64
65 <!-- *********************************************************************** -->
66 <div class="doc_section">
67   <a name="whatsnew">What's New?</a>
68 </div>
69 <!-- *********************************************************************** -->
70
71 <div class="doc_text">
72
73 <p>This is the second public release of the LLVM compiler infrastructure.  This
74 release is primarily a bugfix release, dramatically improving the C/C++
75 front-end, and improving support for C++ in the LLVM core.  This release also
76 includes a few new features, such as a simple profiler, support for Mac OS/X,
77 better interoperability with external source bases, a new example language
78 front-end, and improves a few optimizations.</p>
79
80 <p>At this time, LLVM is known to correctly compile the C &amp; C++ SPEC CPU2000
81 benchmarks (X86 only), the Olden benchmarks, and the Ptrdist benchmarks along
82 with <b>many</b> other programs.  LLVM now also works with a broad variety of
83 C++ programs, though it has still received much less testing than the C
84 front-end.
85 </p>
86
87 <p>
88 Note that the Sparc and X86 backends do not currently support exception throwing
89 or long jumping (including 253.perlbmk in SPEC).  For these programs, you must
90 use the C backend.  Support for unwinding will be added in a future release.
91 </p>
92
93
94 <!--=========================================================================-->
95 <div class="doc_subsubsection">
96 This release implements the following new features:
97 </div>
98
99 <ol>
100 <li><a
101 href="http://mail.cs.uiuc.edu/pipermail/llvmdev/2003-November/000528.html">A new
102 LLVM profiler, similar to gprof</a> is available</li>
103
104 <li>LLVM and the C/C++ front-end now compile on Mac OS/X!  Mac OS/X users can
105 now explore the LLVM optimizer with the C backend and interpreter.  Note that
106 LLVM requires GCC 3.3 on Mac OS/X.</li>
107
108 <li>LLVM has been <a
109 href="http://mail.cs.uiuc.edu/pipermail/llvmdev/2003-November/000554.html">moved
110 into an 'llvm' C++ namespace</a>, for easier integration with third-party
111 code. Note that due to lack of namespace support in GDB 5.x, you will probably
112 want to upgrade to GDB 6 or better to debug LLVM code.</li>
113
114 <li>
115 The build system now copies Makefiles dynamically from the source tree to the
116 object tree as subdirectories are built.  This means that:
117   <ol>
118   <li>
119   New directories can be added to the source tree, and the build will
120   automatically pick them up (i.e. no need to re-run <tt>configure</tt>).
121   </li>
122
123   <li>
124   You will need to build LLVM from the top of the object tree once to ensure
125   that all of the Makefiles are copied into the object tree subdirectories.
126   </li>
127   </ol>
128 </li>
129
130 <li>A front-end for "Stacker" (a simple Forth-like language) is now
131     <a href="http://llvm.cs.uiuc.edu/PR136">included in the main LLVM tree</a>.
132     Additionally, Reid Spencer, the author, contributed a document <a href="Stacker.html">describing his experiences writing Stacker, and the language itself</a>.  This document is invaluable for others writing front-ends targetting LLVM.</li>
133
134 <li>The <tt>configure</tt> script will now configure all projects placed in the
135 <tt>llvm/projects</tt> directory.</li>
136
137 <li>The <tt>-tailcallelim</tt> pass can now introduce "accumulator" variables
138     to transform functions in many common cases that it could not before.</li>
139
140 <li>The <tt>-licm</tt> pass can now sink instructions out the bottom of loops
141 in addition to being able to hoist them out the top.</li>
142
143 <li>The <tt>-basicaa</tt> pass (the default alias analysis) has been upgraded
144 to be <a href="http://llvm.cs.uiuc.edu/PR86">significantly more 
145 precise</a>.</li>
146
147 <li>LLVM 1.1 implements a simple size optimization for LLVM bytecode files.  
148     This means that the 1.1 files are smaller than 1.0, but that 1.0 won't 
149     read 1.1 bytecode files.</li>
150 </ol>
151
152
153 <!--=========================================================================-->
154 <div class="doc_subsubsection">
155 In this release, the following missing features were implemented:
156 </div>
157
158 <ol>
159 <li><a href="http://llvm.cs.uiuc.edu/PR88">The interpreter does not support
160 invoke or unwind</a></li>
161
162 <li><a href="http://llvm.cs.uiuc.edu/PR99">Interpreter does not support the
163 <tt>vaarg</tt> instruction</a></li>
164
165 <li><a href="http://llvm.cs.uiuc.edu/PR117">llvm-nm cannot read archive
166 files</a></li>
167
168 <li><a href="http://llvm.cs.uiuc.edu/PR146">Interpreter does not handle
169 setne constant expression</a></li>
170
171 </ol>
172
173
174 <!--=========================================================================-->
175 <div class="doc_subsubsection">
176 In this release, the following Quality of Implementation issues were
177 fixed:
178 </div>
179
180 <ol>
181
182 <li>The C++ front-end now compiles functions to 
183     <a href="http://llvm.cs.uiuc.edu/PR29">use the linkonce linkage type</a> 
184     more, giving the optimizer more freedom.</a></li>
185
186 <li>The C front-end now <a href="http://llvm.cs.uiuc.edu/PR84">generates 
187     type-safe code</a> in several cases that it did not before, which prevented
188     some important optimizations.</li>
189
190 <li>The LLVM build system has been taught to catch some common configuration 
191     problems that <a href="http://llvm.cs.uiuc.edu/PR96">caused it to get 
192     horribly confused</a> before.</li>
193
194 <li>The LLVM header files are now 
195     <a href="http://llvm.cs.uiuc.edu/PR114">-Wold-style-cast clean</a>.</li>
196
197 <li>The LLVM bytecode reader has been <a
198 href="http://llvm.cs.uiuc.edu/PR127">sped up a lot</a> (up to 4x in some
199 cases).</li>
200
201 <li>In C++, methods and functions in anonymous namespaces <a href="http://llvm.cs.uiuc.edu/PR85">now get internal linkage</a>.</li>
202
203 <li>Constant initializers now generate loops instead of potentially <a href="http://llvm.cs.uiuc.edu/PR75">huge amounts of straight-line code</a>.</li>
204
205 <li>Code for running C++ destructors is now properly shared when possible.  Before, the C++ front-end
206 <a href="http://llvm.cs.uiuc.edu/PR11">generated N^2 amounts of duplicated cleanup code</a> in some cases.</li>
207 </ol>
208
209
210 <!--=========================================================================-->
211 <div class="doc_subsubsection">
212 In this release, the following bugs in the previous release were fixed:
213 </div>
214
215 <p>Bugs in the LLVM Core:</p>
216
217 <ol>
218 <li><a href="http://llvm.cs.uiuc.edu/PR57">[inliner] Inlining invoke with PHI in unwind target is broken</a></li>
219 <li><a href="http://llvm.cs.uiuc.edu/PR58">[linker] linkonce globals should link successfully to external globals</a></li>
220 <li><a href="http://llvm.cs.uiuc.edu/PR64">[constmerge] Constant merging pass merges constants with external linkage</a></li>
221 <li><a href="http://llvm.cs.uiuc.edu/PR66">[scalarrepl] Scalar Replacement of aggregates is decimating structures it shouldn't be</a></li>
222 <li><a href="http://llvm.cs.uiuc.edu/PR70">[instcombine] Resolving invoke inserts cast after terminator</a></li>
223 <li><a href="http://llvm.cs.uiuc.edu/PR71">llvm-as crashes when labels are used in phi nodes</a></li>
224 <li><a href="http://llvm.cs.uiuc.edu/PR72">[build problem] Callgraph.cpp not pulled in from libipa.a</a></li>
225 <li><a href="http://llvm.cs.uiuc.edu/PR77">Variables in scope of output setjmp
226 calls should be volatile</a> (Note that this does not effect correctness on
227 many platforms, such as X86).</li>
228 <li><a href="http://llvm.cs.uiuc.edu/PR83">[X86] Emission of global bool initializers broken</a></li>
229 <li><a href="http://llvm.cs.uiuc.edu/PR91">[gccld] The -r (relinking) option does not work correctly</a></li>
230 <li><a href="http://llvm.cs.uiuc.edu/PR92">[bcreader] Cannot read shift constant expressions from bytecode file</a></li>
231 <li><a href="http://llvm.cs.uiuc.edu/PR93">[lowersetjmp] Lowersetjmp pass breaks dominance properties!</a></li>
232 <li><a href="http://llvm.cs.uiuc.edu/PR95">SymbolTable::getUniqueName is very inefficient</a></li>
233 <li><a href="http://llvm.cs.uiuc.edu/PR97">bugpoint must not pass -R&lt;directory&gt; to Mach-O linker</a></li>
234 <li><a href="http://llvm.cs.uiuc.edu/PR98">[buildscripts] Building into objdir with .o in it fails</a></li>
235 <li><a href="http://llvm.cs.uiuc.edu/PR101">[setjmp/longjmp] Linking C programs which use setjmp/longjmp sometimes fail with references to the C++ runtime library!</a></li>
236 <li><a href="http://llvm.cs.uiuc.edu/PR107">AsmParser Misses Symbol Redefinition Error</a></li>
237 <li><a href="http://llvm.cs.uiuc.edu/PR108">gccld -Lfoo -lfoo fails to find ./foo/libfoo.a</a></li>
238 <li><a href="http://llvm.cs.uiuc.edu/PR110">[bcreader] Incorrect cast causes misread forward constant references</a></li>
239 <li><a href="http://llvm.cs.uiuc.edu/PR116">[adce] ADCE considers blocks without postdominators to be unreachable</a></li>
240 <li><a href="http://llvm.cs.uiuc.edu/PR123">[X86] div and rem constant exprs invalidate iterators!</a></li>
241 <li><a href="http://llvm.cs.uiuc.edu/PR130">[vmcore] Symbol table doesn't rename colliding variables during type resolution</a></li>
242 <li><a href="http://llvm.cs.uiuc.edu/PR138">Archive reader does not understand 4.4BSD/Mac OS X long filenames</a></li>
243 <li><a href="http://llvm.cs.uiuc.edu/PR140">gccld produces a runner script that includes command-line options to load the necessary shared objects</a></li>
244 </ol>
245
246
247 <p>Bugs in the C/C++ front-end:</p>
248
249 <ol>
250 <li><a href="http://llvm.cs.uiuc.edu/PR59">C++ frontend can crash when compiling virtual base classes</a></li>
251 <li><a href="http://llvm.cs.uiuc.edu/PR62">C backend fails on constant cast expr to ptr-to-anonymous struct</a></li>
252 <li><a href="http://llvm.cs.uiuc.edu/PR63">#ident is not recognized by C frontend</a></li>
253 <li><a href="http://llvm.cs.uiuc.edu/PR65">C front-end miscompiles the builtin_expect intrinsic!</a></li>
254 <li><a href="http://llvm.cs.uiuc.edu/PR67">1.0 precompiled libstdc++ does not include wchar_t support</a></li>
255 <li><a href="http://llvm.cs.uiuc.edu/PR68">llvmgcc asserts when compiling functions renamed with asm's</a></li>
256 <li><a href="http://llvm.cs.uiuc.edu/PR69">C frontend crashes on some programs with lots of types.</a></li>
257 <li><a href="http://llvm.cs.uiuc.edu/PR79">llvm-gcc crashes compiling global union initializer</a></li>
258 <li><a href="http://llvm.cs.uiuc.edu/PR80">C front-end crash on empty structure</a></li>
259 <li><a href="http://llvm.cs.uiuc.edu/PR81">CFrontend crashes when compiling C99 compound expressions</a></li>
260 <li><a href="http://llvm.cs.uiuc.edu/PR87">llvm-gcc infinite loops on "case MAXINT:"</a></li>
261 <li><a href="http://llvm.cs.uiuc.edu/PR89">[C++] Catch blocks make unparsable labels</a></li>
262 <li><a href="http://llvm.cs.uiuc.edu/PR90">[C++] Initializing array with constructable objects fail</a></li>
263 <li><a href="http://llvm.cs.uiuc.edu/PR94">llvm-gcc tries to add bools</a></li>
264 <li><a href="http://llvm.cs.uiuc.edu/PR104">[c++] C++ Frontend lays out superclasses like anonymous bitfields!</a></li>
265 <li><a href="http://llvm.cs.uiuc.edu/PR54">C front-end miscompiles unsigned enums whose LLVM types are signed</a></li>
266 <li><a href="http://llvm.cs.uiuc.edu/PR112">Casting a string constant to void crashes llvm-gcc</a></li>
267 <li><a href="http://llvm.cs.uiuc.edu/PR125">[llvmg++] Enum types are incorrectly shrunk to smaller than 'int' size</a></li>
268 <li><a href="http://llvm.cs.uiuc.edu/PR128">[llvmg++] Cannot use pointer to member to initialize global</a></li>
269 <li><a href="http://llvm.cs.uiuc.edu/PR131">[llvm-gcc] ?: operator as lvalue not implemented</a></li>
270 <li><a href="http://llvm.cs.uiuc.edu/PR133">[C/C++] Bogus warning about taking the address of 'register' variable</a></li>
271 <li><a href="http://llvm.cs.uiuc.edu/PR113">crash assigning into an array in a struct which contains a bitfield</a>.</li>
272 <li><a href="http://llvm.cs.uiuc.edu/PR6">Oversized integer bitfields cause crash</a></li>
273 <li><a href="http://llvm.cs.uiuc.edu/PR141">[llvm-gcc] Bitfields &amp; large array don't mix well</a></li>
274 <li><a href="http://llvm.cs.uiuc.edu/PR132">[llvm-gcc] Complex division is not supported</a></li>
275 <li><a href="http://llvm.cs.uiuc.edu/PR143">[llvm-gcc] Illegal union field reference</a></li>
276 <li><a href="http://llvm.cs.uiuc.edu/PR148">[llvmg++] Front-end attempts to return structure by value</a></li>
277 <li><a href="http://llvm.cs.uiuc.edu/PR152">[llvmg++] Pointer to member initializers not supported in constructors</a></li>
278 <li><a href="http://llvm.cs.uiuc.edu/PR155">[llvm-gcc] crash on union initialization</a></li>
279 <li><a href="http://llvm.cs.uiuc.edu/PR124">[llvm-g++] ?: expressions do not run correct number of destructors!</a></li>
280 <li><a href="http://llvm.cs.uiuc.edu/PR157">[llvm-gcc] Pointer & constant results in invalid shift</a></li>
281 <li><a href="http://llvm.cs.uiuc.edu/PR165">[llvmg++] call through array of pointers to member functions causes assertion</a></li>
282 </ol>
283
284 </div>
285
286 <!-- *********************************************************************** -->
287 <div class="doc_section">
288   <a name="portability">Portability and Supported Platforms</a>
289 </div>
290 <!-- *********************************************************************** -->
291
292 <div class="doc_text">
293
294 <p>LLVM has been extensively tested on Intel and AMD machines running Red
295 Hat Linux, and Sun UltraSPARC workstations running Solaris 8.  Additionally, 
296 LLVM works on Mac OS/X 10.3 and above, but only with the C backend or 
297 interpreter (no native backend for the PowerPC is available yet).
298 The core LLVM infrastructure uses "autoconf" for portability, so hopefully we
299 work on more platforms than that.  However, it is likely that we
300 missed something, and that minor porting is required to get LLVM to work on 
301 new platforms.  We welcome portability patches and error messages.</p>
302
303 </div>
304
305 <!-- *********************************************************************** -->
306 <div class="doc_section">
307   <a name="knownproblems">Known Problems</a>
308 </div>
309 <!-- *********************************************************************** -->
310
311 <div class="doc_text">
312
313 <p>This section contains all known problems with the LLVM system, listed by
314 component.  As new problems are discovered, they will be added to these
315 sections.</p>
316
317 </div>
318
319 <!-- _______________________________________________________________________ -->
320 <!--
321 </ul><h4><a name="portability"><hr size=0>Portability Problems</h4><ul>
322 -->
323
324
325 <!-- ======================================================================= -->
326 <div class="doc_subsection">
327   <a name="core">Known problems with the LLVM Core</a>
328 </div>
329
330 <div class="doc_text">
331
332 <ul>
333
334 <li>In the JIT, <tt>dlsym</tt> on a symbol compiled by the JIT will not
335 work.</li>
336
337 <li>The JIT does not use mutexes to protect its internal data structures.  As
338 such, execution of a threaded program could cause these data structures to be
339 corrupted.</li>
340
341 <li>It is not possible to <tt>dlopen</tt> an LLVM bytecode file in the JIT.</li>
342
343 <li>Linking in static archive files (.a files) is very slow (there is no symbol
344 table in the archive).</li>
345
346 <li><a href="http://llvm.cs.uiuc.edu/PR82">LLVM cannot handle structures with
347 more than 256 elements</a>.</li>
348
349 </ul>
350
351 </div>
352
353 <!-- ======================================================================= -->
354 <div class="doc_subsection">
355   <a name="c-fe">Known problems with the C front-end</a>
356 </div>
357
358 <!-- _______________________________________________________________________ -->
359 <div class="doc_subsubsection">
360   Bugs
361 </div>
362
363 <div class="doc_text">
364
365 <ul>
366
367 <li>C99 Variable sized arrays do not release stack memory when they go out of 
368     scope.  Thus, the following program may run out of stack space:
369 <pre>
370     for (i = 0; i != 1000000; ++i) {
371       int X[n];
372       foo(X);
373     }
374 </pre></li>
375
376 </ul>
377
378 </div>
379
380 <!-- _______________________________________________________________________ -->
381 <div class="doc_subsubsection">
382   Notes
383 </div>
384
385 <div class="doc_text">
386
387 <ul>
388
389 <li>Inline assembly is not yet supported.</li>
390
391 <li>"long double" is transformed by the front-end into "double".  There is no
392 support for floating point data types of any size other than 32 and 64
393 bits.</li>
394     
395 <li>The following Unix system functionality has not been tested and may not
396 work:
397   <ol>
398   <li><tt>sigsetjmp</tt>, <tt>siglongjmp</tt> - These are not turned into the
399       appropriate <tt>invoke</tt>/<tt>unwind</tt> instructions.  Note that
400       <tt>setjmp</tt> and <tt>longjmp</tt> <em>are</em> compiled correctly.
401   <li><tt>getcontext</tt>, <tt>setcontext</tt>, <tt>makecontext</tt>
402       - These functions have not been tested.
403   </ol></li>
404
405 <li>Although many GCC extensions are supported, some are not.  In particular,
406     the following extensions are known to <b>not be</b> supported:
407   <ol>
408   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Local-Labels.html#Local%20Labels">Local Labels</a>: Labels local to a block.</li>
409   <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>
410   <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>
411   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Constructing-Calls.html#Constructing%20Calls">Constructing Calls</a>: Dispatching a call to another function.</li>
412   <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>
413   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Constraints.html#Constraints">Constraints</a>: Constraints for asm operands</li>
414   <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>
415   <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>
416   <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>
417   <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>
418   <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>
419   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Thread-Local.html#Thread-Local">Thread-Local</a>: Per-thread variables.</li>
420   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Pragmas.html#Pragmas">Pragmas</a>: Pragmas accepted by GCC.</li>
421   </ol>
422
423   <p>The following GCC extensions are <b>partially</b> supported.  An ignored
424   attribute means that the LLVM compiler ignores the presence of the attribute,
425   but the code should still work.  An unsupported attribute is one which is
426   ignored by the LLVM compiler, which will cause a different interpretation of
427   the program.</p>
428
429   <ol>
430   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Length.html#Variable%20Length">Variable Length</a>:
431       Arrays whose length is computed at run time.<br>
432       Supported, but allocated stack space is not freed until the function returns (noted above).</li>
433
434   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Attributes.html#Function%20Attributes">Function Attributes</a>:
435
436       Declaring that functions have no side effects, or that they can never
437       return.<br>
438
439       <b>Supported:</b> <tt>format</tt>, <tt>format_arg</tt>, <tt>non_null</tt>,
440       <tt>constructor</tt>, <tt>destructor</tt>, <tt>unused</tt>,
441       <tt>deprecated</tt>, <tt>warn_unused_result</tt>, <tt>weak</tt><br>
442
443       <b>Ignored:</b> <tt>noreturn</tt>, <tt>noinline</tt>,
444       <tt>always_inline</tt>, <tt>pure</tt>, <tt>const</tt>, <tt>nothrow</tt>,
445       <tt>malloc</tt>, <tt>no_instrument_function</tt>, <tt>cdecl</tt><br>
446
447       <b>Unsupported:</b> <tt>used</tt>, <tt>section</tt>, <tt>alias</tt>,
448       <tt>visibility</tt>, <tt>regparm</tt>, <tt>stdcall</tt>,
449       <tt>fastcall</tt>, all other target specific attributes</li>
450    
451   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Attributes.html#Variable%20Attributes">Variable Attributes</a>:
452       Specifying attributes of variables.<br>
453       <b>Supported:</b> <tt>cleanup</tt>, <tt>common</tt>, <tt>nocommon</tt>,
454                         <tt>deprecated</tt>, <tt>transparent_union</tt>,
455                         <tt>unused</tt>, <tt>weak</tt><br>
456
457       <b>Unsupported:</b> <tt>aligned</tt>, <tt>mode</tt>, <tt>packed</tt>,
458                         <tt>section</tt>, <tt>shared</tt>, <tt>tls_model</tt>,
459                         <tt>vector_size</tt>, <tt>dllimport</tt>, 
460                         <tt>dllexport</tt>, all target specific attributes.</li>
461
462   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Type-Attributes.html#Type%20Attributes">Type Attributes</a>:   Specifying attributes of types.<br>
463       <b>Supported:</b> <tt>transparent_union</tt>, <tt>unused</tt>,
464                         <tt>deprecated</tt>, <tt>may_alias</tt><br>
465
466       <b>Unsupported:</b> <tt>aligned</tt>, <tt>packed</tt>, 
467                         all target specific attributes.</li>
468
469   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Other-Builtins.html#Other%20Builtins">Other Builtins</a>:
470       Other built-in functions.<br>
471       We support all builtins which have a C language equivalent (e.g., 
472          <tt>__builtin_cos</tt>),  <tt>__builtin_alloca</tt>, 
473          <tt>__builtin_types_compatible_p</tt>, <tt>__builtin_choose_expr</tt>,
474          <tt>__builtin_constant_p</tt>, and <tt>__builtin_expect</tt> (ignored).</li>
475
476   </ol>
477
478   <p>The following extensions <b>are</b> known to be supported:</p>
479
480   <ol>
481   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Statement-Exprs.html#Statement%20Exprs">Statement Exprs</a>:   Putting statements and declarations inside expressions.</li>
482   <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>
483   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Lvalues.html#Lvalues">Lvalues</a>: Using <code>?:</code>, "<code>,</code>" and casts in lvalues.</li>
484   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Conditionals.html#Conditionals">Conditionals</a>: Omitting the middle operand of a <code>?:</code> expression.</li>
485   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Long-Long.html#Long%20Long">Long Long</a>: Double-word integers.</li>
486   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Complex.html#Complex">Complex</a>:   Data types for complex numbers.</li>
487   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Hex-Floats.html#Hex%20Floats">Hex Floats</a>:Hexadecimal floating-point constants.</li>
488   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Zero-Length.html#Zero%20Length">Zero Length</a>: Zero-length arrays.</li>
489   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Empty-Structures.html#Empty%20Structures">Empty Structures</a>: Structures with no members.</li>
490   <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>
491   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Escaped-Newlines.html#Escaped%20Newlines">Escaped Newlines</a>:  Slightly looser rules for escaped newlines.</li>
492   <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>
493   <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>
494   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Initializers.html#Initializers">Initializers</a>: Non-constant initializers.</li>
495   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Compound-Literals.html#Compound%20Literals">Compound Literals</a>: Compound literals give structures, unions or arrays as values.</li>
496   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Designated-Inits.html#Designated%20Inits">Designated Inits</a>: Labeling elements of initializers.</li>
497   <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>
498   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Case-Ranges.html#Case%20Ranges">Case Ranges</a>: `case 1 ... 9' and such.</li>
499   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Mixed-Declarations.html#Mixed%20Declarations">Mixed Declarations</a>: Mixing declarations and code.</li>
500   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Prototypes.html#Function%20Prototypes">Function Prototypes</a>: Prototype declarations and old-style definitions.</li>
501   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/C---Comments.html#C++%20Comments">C++ Comments</a>: C++ comments are recognized.</li>
502   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Dollar-Signs.html#Dollar%20Signs">Dollar Signs</a>: Dollar sign is allowed in identifiers.</li>
503   <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>
504   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Alignment.html#Alignment">Alignment</a>: Inquiring about the alignment of a type or variable.</li>
505   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Inline.html#Inline">Inline</a>: Defining inline functions (as fast as macros).</li>
506   <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>
507   <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>
508   <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>
509   <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>
510   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Attribute-Syntax.html#Attribute%20Syntax">Attribute Syntax</a>: Formal syntax for attributes.</li>
511   </ol></li>
512
513 </ul>
514
515 <p>If you run into GCC extensions which have not been included in any of these
516 lists, please let us know (also including whether or not they work).</p>
517
518 </div>
519
520 <!-- ======================================================================= -->
521 <div class="doc_subsection">
522   <a name="c++-fe">Known problems with the C++ front-end</a>
523 </div>
524
525 <div class="doc_text">
526
527 <p>For this release, the C++ front-end is considered to be fully functional, but
528 has not been tested as thoroughly as the C front-end.  It has been tested and 
529 works for a number of non-trivial programs, but there may be lurking bugs.
530 Please report any bugs or problems.</p>
531
532 </div>
533
534 <!-- _______________________________________________________________________ -->
535 <div class="doc_subsubsection">
536   Bugs
537 </div>
538
539 <div class="doc_text">
540
541 <ul>
542 <li>The C++ front-end inherits all problems afflicting the <a href="#c-fe">C
543     front-end</a></li>
544 </ul>
545
546 </div>
547
548 <!-- _______________________________________________________________________ -->
549 <div class="doc_subsubsection">
550   Notes
551 </div>
552
553 <div class="doc_text">
554
555 <ul>
556
557 <li>The C++ front-end is based on a pre-release of the GCC 3.4 C++ parser.  This
558 parser is significantly more standards compliant (and picky) than prior GCC
559 versions.  For more information, see the C++ section of the <a
560 href="http://gcc.gnu.org/gcc-3.4/changes.html">GCC 3.4 release notes</a>.</li>
561
562 <li>Destructors for local objects are not always run when a <tt>longjmp</tt> is
563     performed. In particular, destructors for objects in the <tt>longjmp</tt>ing
564     function and in the <tt>setjmp</tt> receiver function may not be run.
565     Objects in intervening stack frames will be destroyed however (which is
566     better than most compilers).</li>
567
568 <li>The LLVM C++ front-end follows the <a
569     href="http://www.codesourcery.com/cxx-abi">Itanium C++ ABI</a>.
570     This document, which is not Itanium specific, specifies a standard for name
571     mangling, class layout, v-table layout, RTTI formats, and other C++
572     representation issues.  Because we use this API, code generated by the LLVM
573     compilers should be binary compatible with machine code generated by other
574     Itanium ABI C++ compilers (such as G++, the Intel and HP compilers, etc).
575     <i>However</i>, the exception handling mechanism used by LLVM is very
576     different from the model used in the Itanium ABI, so <b>exceptions will not
577     interact correctly</b>. </li>
578
579 </ul>
580
581 </div>
582
583 <!-- ======================================================================= -->
584 <div class="doc_subsection">
585   <a name="x86-be">Known problems with the X86 back-end</a>
586 </div>
587
588 <div class="doc_text">
589
590 <ul>
591
592 <li>The X86 code generator <a
593 href="http://llvm.cs.uiuc.edu/PR16">does not currently
594 support the <tt>unwind</tt> instruction</a>, so code that throws a C++ exception
595 or calls the C <tt>longjmp</tt> function will abort.</li>
596
597 </ul>
598
599 </div>
600
601 <!-- ======================================================================= -->
602 <div class="doc_subsection">
603   <a name="sparc-be">Known problems with the Sparc back-end</a>
604 </div>
605
606 <div class="doc_text">
607
608 <ul>
609
610 <li>The Sparc code generator <a
611 href="http://llvm.cs.uiuc.edu/PR15">does not currently
612 support the <tt>unwind</tt> instruction</a>, so code that throws a C++ exception
613 or calls the C <tt>longjmp</tt> function will abort.</li>
614
615 </ul>
616
617 </div>
618
619 <!-- ======================================================================= -->
620 <div class="doc_subsection">
621   <a name="c-be">Known problems with the C back-end</a>
622 </div>
623
624 <div class="doc_text">
625
626 <ul>
627
628 <li>The C back-end produces code that violates the ANSI C Type-Based Alias
629 Analysis rules.  As such, special options may be necessary to compile the code
630 (for example, GCC requires the <tt>-fno-strict-aliasing</tt> option).  This
631 problem probably cannot be fixed.</li>
632
633 <li><a href="http://llvm.cs.uiuc.edu/PR33">Initializers for global variables</a>
634 cannot include special floating point numbers like Not-A-Number or
635 Infinity.</li>
636
637 <li><a href="http://llvm.cs.uiuc.edu/PR56">Zero arg vararg functions are not 
638 supported</a>.  This should not affect LLVM produced by the C or C++ 
639 frontends.</li>
640
641 </ul>
642
643 </div>
644
645 <!-- *********************************************************************** -->
646 <div class="doc_section">
647   <a name="additionalinfo">Additional Information</a>
648 </div>
649 <!-- *********************************************************************** -->
650
651 <div class="doc_text">
652
653 <p>A wide variety of additional information is available on the LLVM web page,
654 including mailing lists publications describing algorithms and components
655 implemented in LLVM.  The web page also contains versions of the API
656 documentation which is up-to-date with the CVS version of the source code.  You
657 can access versions of these documents specific to this release by going into
658 the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
659
660 <p>If you have any questions or comments about LLVM, please feel free to contact
661 us via the mailing lists.</p>
662
663 </div>
664
665 <!-- *********************************************************************** -->
666
667 <hr>
668 <address>
669   <a href="http://jigsaw.w3.org/css-validator/"><img
670   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
671   <a href="http://validator.w3.org/check/referer"><img
672   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
673
674   <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br>
675   Last modified: $Date$
676 </address>
677
678 </body>
679 </html>