Bug fixed
[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.3 Release Notes</title>
7 </head>
8 <body>
9
10 <div class="doc_title">LLVM 1.3 Release Notes</div>
11  
12 <ol>
13   <li><a href="#intro">Introduction</a></li>
14   <li><a href="#whatsnew">What's New?</a></li>
15   <li><a href="GettingStarted.html">Installation Instructions</a></li>
16   <li><a href="#portability">Portability and Supported Platforms</a></li>
17   <li><a href="#knownproblems">Known Problems</a>
18   <ul>
19     <li><a href="#experimental">Experimental features included in this
20                                 release</a>
21     <li><a href="#core">Known problems with the LLVM Core</a>
22     <li><a href="#c-fe">Known problems with the C Front-end</a>
23     <li><a href="#c++-fe">Known problems with the C++ Front-end</a>
24     <li><a href="#x86-be">Known problems with the X86 Back-end</a>
25     <li><a href="#sparc-be">Known problems with the Sparc Back-end</a>
26     <li><a href="#c-be">Known problems with the C back-end</a>
27   </ul></li>
28   <li><a href="#additionalinfo">Additional Information</a></li>
29 </ol>
30
31 <div class="doc_author">
32   <p>Written by the <a href="http://llvm.cs.uiuc.edu">LLVM team</a><p>
33 </div>
34
35 <!-- *********************************************************************** -->
36 <div class="doc_section">
37   <a name="intro">Introduction</a>
38 </div>
39 <!-- *********************************************************************** -->
40
41 <div class="doc_text">
42
43 <p>This document contains the release notes for the LLVM compiler
44 infrastructure, release 1.3.  Here we describe the status of LLVM, including any
45 known problems and bug fixes from the previous release.  The most up-to-date
46 version of this document can be found on the <a
47 href="http://llvm.cs.uiuc.edu/releases/1.3/">LLVM 1.3 web site</a>.  If you are
48 not reading this on the LLVM web pages, you should probably go there because
49 this document may be updated after the release.</p>
50
51 <p>For more information about LLVM, including information about potentially more
52 current releases, please check out the <a href="http://llvm.cs.uiuc.edu">main
53 web site</a>.  If you have questions or comments, the <a
54 href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM developer's mailing
55 list</a> is a good place to send them.</p>
56
57 <p>Note that if you are reading this file from CVS, this document applies
58 to the <i>next</i> release, not the current one.  To see the release notes for
59 the current or previous releases, see the <a
60 href="http://llvm.cs.uiuc.edu/releases/">releases page</a>.</p>
61
62 </div>
63
64 <!-- *********************************************************************** -->
65 <div class="doc_section">
66   <a name="whatsnew">What's New?</a>
67 </div>
68 <!-- *********************************************************************** -->
69
70 <div class="doc_text">
71
72 <p>This is the fourth public release of the LLVM compiler infrastructure.  This
73 release primarily improves the <a href="#codequality">performance of the
74 code</a> produced by all aspects of the LLVM compiler and adds many <a
75 href="#newfeatures">new features</a>, and <a href="#bugfix">fixes a few
76 bugs</a> as well.</p>
77
78 <p> At this time, LLVM is known to correctly compile and run all C &amp; C++
79 SPEC CPU2000 benchmarks, the Olden benchmarks, and the Ptrdist benchmarks.  It
80 has also been used to compile <b>many</b> other programs.  LLVM now also works
81 with a broad variety of C++ programs, though it has still received less testing
82 than the C front-end.</p>
83
84 </div>
85
86 <!--=========================================================================-->
87 <div class="doc_subsubsection">
88 <a name="newfeatures">This release implements the following new features:</a>
89 </div>
90
91 <div class="doc_text">
92
93 <ol>
94 <li>The LLVM <a href="LangRef.html#i_select"><tt>select</tt></a> instruction is
95 now fully implemented and supported by all transformations, native code
96 generators, and the interpreter.</li>
97 <li>Bugpoint can now narrow down code-generation bugs to a loop nest, where
98 before it could only narrow them down to a function being miscompiled.</li>
99 <li><a href="http://llvm.cs.uiuc.edu/PR40">Bugpoint can now debug arbitrary
100 modes of llc</a> and lli, by passing them command line flags (e.g., 
101 <tt>-regalloc=linearscan</tt>, <tt>-enable-correct-eh-support</tt>, etc.) </li>
102 <li>The Control Flow Graph in the native code generators is no longer
103 constrained to be the same as the CFG for the LLVM input code.</li>
104 <li>The LLVM induction variable analysis routines have been rewritten.</li>
105 <li>LLVM now has new loop unrolling and loop unswitching passes.</li>
106 <li>The induction variable substitution pass performs linear function test
107 replacement and exit value replacement optimizations.</li>
108 <li>LLVM now has first-class support for <a href="GarbageCollection.html">Accurate 
109 Garbage Collection</a>, enabling the use of aggressive copying and generational 
110 collectors.</li>
111 <li>LLVM now includes an implementation of Andersen's interprocedural alias 
112 analysis algorithm.</li>
113 <li>Bugpoint can <a href="http://llvm.cs.uiuc.edu/PR327">extract individual
114 basic blocks</a> to track down reduce miscompilation testcases.</li>
115 <li>LLVM and the C front-end now work under Win32 using the
116 <a href="http://www.cygwin.com">Cygwin</a> runtime libraries.  
117 This includes the JIT compiler.</li>
118 <li>The LLVM code generator is now being <a 
119     href="CodeGenerator.html">documented</a>.</li>
120 <li>There is a new tool, llvm-abcd, the Analysis of ByteCode Dumper (abcd). 
121 This tool can compute basic statistics and bytecode density statistics on a
122 module or function basis and also dump out bytecode in a textual format that
123 is lower level than assembly (values are not resolved from slot numbers).
124 It should only be of interest to (a) those who are working to improve the
125 bytecode format and (b) those who really want to understand or document the
126 details of the bytecode format.</li>
127 <li>The <a href="BytecodeFormat.html">LLVM Bytecode file format</a> is now 
128     being documented.</li>
129 <li>LLVM now provides an <a href="LangRef.html#i_isunordered">llvm.isunordered</a> intrinsic
130 for efficient implementation of unordered floating point comparisons.</li>
131 <li>The llvmgcc front-end now supports the GCC builtins for ISO C99 floating
132 point comparison macros (e.g., <tt>__builtin_islessequal</tt>).</li>
133 </ol>
134
135 </div>
136
137
138 <!--=========================================================================-->
139 <div class="doc_subsubsection">
140 In this release, the following missing features were implemented:
141 </div>
142
143 <div class="doc_text">
144
145 <ol>
146 <li><a href="http://llvm.cs.uiuc.edu/PR82">LLVM cannot handle structures with
147 more than 256 elements</a></li>
148 <li><a href="http://llvm.cs.uiuc.edu/PR38">[bugpoint] External functions used in
149 non-instruction entities, such as global constant initializer</a></li>
150 <li><a href="http://llvm.cs.uiuc.edu/PR178">Stacker does not handle targets 
151 with 64-bit pointers.</a></li>
152 <li><a href="http://llvm.cs.uiuc.edu/PR290">Bugpoint doesn't support
153 uses of external fns by immediate constant exprs</a></li>
154 </ol>
155
156 </div>
157
158 <!--=========================================================================-->
159 <div class="doc_subsubsection">
160 <a name="qualityofimp">In this release, the following Quality of Implementation
161 issues were fixed:</a>
162 </div>
163
164 <div class="doc_text">
165
166 <ol>
167 <li><a href="http://llvm.cs.uiuc.edu/PR305">LLVM tools will happily spew
168 bytecode onto your terminal</a></li>
169 <li><a href="http://llvm.cs.uiuc.edu/PR329">[llvmgcc] type names are not emitted
170 for structure typedefs</a></li>
171 <li>All documentation is now conformant to the HTML 4.01 (Strict) level.</li>
172 <li>The spurious "WARNING: Found global types that are not compatible" warning
173 produced when linking C++ programs has been fixed.</li>
174 </ol>
175
176 </div>
177
178 <!--=========================================================================-->
179 <div class="doc_subsubsection">
180 In this release, the following build problems were fixed:
181 </div>
182
183 <div class="doc_text">
184 <ol>
185 <li><a href="http://llvm.cs.uiuc.edu/PR301">Minor configure bugs with
186 -disable/enable-povray and -disable-spec</a></li>
187 <li><a href="http://llvm.cs.uiuc.edu/PR289">shell scripts output by gccld don't
188 work if you change PATH</a></li>
189 <li><a href="http://llvm.cs.uiuc.edu/PR364">[llvmgcc] llvmgcc does not compile 
190 with gcc 3.4</a></li>
191 <li><a href="http://llvm.cs.uiuc.edu/PR373">[llvmgcc] obstack.h relies on 
192 obsolete casts-as-lvalues GCC extension</a></li>
193 </ol>
194 </div>
195
196 <!--=========================================================================-->
197 <div class="doc_subsubsection">
198 <a name="codequality">This release includes the following Code Quality
199 improvements:</a>
200 </div>
201
202 <div class="doc_text">
203 <ol>
204 <li>Fixed: <a href="http://llvm.cs.uiuc.edu/PR309">[vmcore] Code quality problem
205 due to long operand of getelementptr</a></li>
206
207 <li>The X86 backend now generates substantially better code for 64-bit integer
208 and floating point operations.</li>
209
210 <li>The -inline pass no longer inlines mutually recursive functions until it
211 hits the inlining threshold.</li>
212
213 <li>The -inline pass no longer misses obvious inlining opportunities just
214 because the callee eventually calls into an external function.</li>
215
216 <li>The -simplifycfg pass can now "if convert" simple statements into the new
217 <tt>select</tt> instruction.</li>
218
219 <li>The -loopsimplify pass can now break <a
220 href="http://llvm.cs.uiuc.edu/PR35">natural loops with multiple backedges</a>
221 into multiple nested loops.  This enables a variety of subsequent
222 optimizations.</li>
223
224 <li>The -adce pass can now eliminate calls to functions that do not not write to
225 memory.</li>
226
227 <li>The link-time optimizer now runs the -prune-eh pass (to remove unused
228 exception handlers).</li>
229
230 <li>The -simplifycfg pass can now eliminate simple correlated branches (such as
231 "<tt>if (A &lt; B &amp;&amp; A &lt; B)</tt>", and can turn short-circuiting
232 operators into the strict versions when useful (such as "<tt>if (A &lt; B || A
233 &gt; C)</tt>" into "<tt>if (A &lt; B | A &gt; C)</tt>"</li>
234
235 <li>LLVM now has infrastructure for (simple and sparse conditional) constant
236 propagation of function calls.  It currently supports a few math library
237 functions like sqrt/sin/cos/etc.</li>
238
239 <li>The C backend now emits <a href="http://llvm.cs.uiuc.edu/PR334">Syntactic
240 loops</a> in the code to help C compilers whose optimizers do not recognize 
241 loops formed from gotos (like GCC).</li>
242
243 <li>Fixed: <a href="http://llvm.cs.uiuc.edu/PR368">[sparcv9] null
244 often spilled to constant pool</a>.</li>
245 </ol>
246 </div>
247
248 <!--=========================================================================-->
249 <div class="doc_subsubsection">
250 <a name="bugfix">In this release, the following bugs in the previous release
251 were fixed:</a>
252 </div>
253
254 <div class="doc_text">
255
256 <p>Bugs in the LLVM Core:</p>
257
258 <ol>
259 <li><a href="http://llvm.cs.uiuc.edu/PR330">[vmcore] Linker causes erroneous
260 asssertion</a></li>
261 <li><a href="http://llvm.cs.uiuc.edu/PR306">[loopsimplify] Loop simplify
262 incorrectly updates dominator information</a></li>
263 <li><a href="http://llvm.cs.uiuc.edu/PR310">[tailduplicate] DemoteRegToStack
264 breaks SSA form</a></li>
265 <li><a href="http://llvm.cs.uiuc.edu/PR313">[X86] JIT miscompiles unsigned short
266 to floating point cast</a></li>
267 <li><a href="http://llvm.cs.uiuc.edu/PR332">[adce] Crash handling unreachable
268 code that unwinds</a></li>
269 <li><a href="http://llvm.cs.uiuc.edu/PR333">[sparc] LLC can't emit 2 functions
270 of the same name, both having constant pools</a></li>
271 <li><a href="http://llvm.cs.uiuc.edu/PR337">[livevar] Live variables missed
272 physical register use of aliased definition</a></li>
273 <li><a href="http://llvm.cs.uiuc.edu/PR340">Verifier misses malformed switch instruction</a></li>
274 <li><a href="http://llvm.cs.uiuc.edu/PR315">[jit] abort, don't warn, when missing external functions encountered</a></li>
275 <li><a href="http://llvm.cs.uiuc.edu/PR369">[X86] stackifier crash on floating point setcc X, X</a></li>
276 </ol>
277
278 <p>Bugs in the C/C++ front-end:</p>
279
280 <ol>
281 <li><a href="http://llvm.cs.uiuc.edu/PR377">[llvmgcc] miscompilation of staticly initialized unsigned bitfields</a></li>
282 <li><a href="http://llvm.cs.uiuc.edu/PR326">[llvmgcc] Crash on use of undeclared
283 enum type</a></li>
284 <li><a href="http://llvm.cs.uiuc.edu/PR298">[llvmgcc] Variable length array
285 indexing miscompiled</a></li>
286 <li><a href="http://llvm.cs.uiuc.edu/PR355">[llvmgcc] Errors handling function 
287 prototypes that take opaque structs by-value</a></li>
288 <li><a href="http://llvm.cs.uiuc.edu/PR374">[llvmgcc] Crash compiling variable 
289 length array of structures</a></li>
290 </ol>
291 </div>
292
293 <!-- *********************************************************************** -->
294 <div class="doc_section">
295   <a name="portability">Portability and Supported Platforms</a>
296 </div>
297 <!-- *********************************************************************** -->
298
299 <div class="doc_text">
300
301 <p>LLVM is known to work in the following platforms:</p>
302
303 <ul>
304 <li>Intel and AMD machines running Red Hat Linux and FreeBSD (and probably 
305     other unix-like systems).</li>
306 <li>Sun UltraSPARC workstations running Solaris 8.</li>
307 <li>PowerPC-based Mac OS X boxes, running 10.3 and above (C backend and 
308     interpreter only, no native codegen is available yet).</li>
309 <li>Intel and AMD machines running on Win32 with the Cygwin libraries.</li>
310 </ul>
311
312
313 <p>The core LLVM infrastructure uses
314 <a href="http://www.gnu.org/software/autoconf/">GNU autoconf</a> to adapt itself
315 to the machine and operating system on which it is built.  However, minor
316 porting may be required to get LLVM to work on new platforms.  We welcome your
317 portability patches and reports of successful builds or error messages.</p>
318
319 <p>Note that the LLVM build system does not currently support directories with 
320 spaces on them when running on Win32/cygwin.  We strongly recommend running
321 LLVM and the C frontend out of a top-level directory without spaces (e.g., 
322 <tt>/cygdrive/c/llvm</tt>).  Also, make sure to install <b>all</b> of the 
323 cygwin packages.  By default, many important tools are not installed that 
324 are needed by the LLVM build process or test suite (e.g., /bin/time).</p>
325
326 </div>
327
328 <!--=========================================================================-->
329 <div class="doc_subsection">
330 In this release, the following portability problems were fixed:
331 </div>
332
333 <div class="doc_text">
334
335 <ol>
336 <li><a href="http://llvm.cs.uiuc.edu/PR304">warnings compiling Stacker compiler
337 on Mac OS X</a></li>
338 <li><a href="http://llvm.cs.uiuc.edu/PR308">Archive file reader doesn't
339 understand abbreviated names in headers</a></li>
340 </ol>
341
342 </div>
343
344 <!-- *********************************************************************** -->
345 <div class="doc_section">
346   <a name="knownproblems">Known Problems</a>
347 </div>
348 <!-- *********************************************************************** -->
349
350 <div class="doc_text">
351
352 <p>This section contains all known problems with the LLVM system, listed by
353 component.  As new problems are discovered, they will be added to these
354 sections.  If you run into a problem, please check the <a
355 href="http://llvm.cs.uiuc.edu/bugs/">LLVM bug database</a> and submit a bug if
356 there isn't already one.</p>
357
358 </div>
359
360 <!-- ======================================================================= -->
361 <div class="doc_subsection">
362   <a name="experimental">Experimental features included with this release</a>
363 </div>
364
365 <div class="doc_text">
366
367 <p>The following components of this LLVM release are either untested, known to
368 be broken or unreliable, or are in early development.  These components should
369 not be relied on, and bugs should not be filed against them, but they may be
370 useful to some people.  In particular, if you would like to work on one of these
371 components, please contact us on the llvmdev list.</p>
372
373 <ul>
374 <li>The following passes are incomplete or buggy: <tt>-pgmdep, -memdep,
375     -ipmodref, -sortstructs, -swapstructs, -cee</tt></li>
376
377 <li>The <tt>-pre</tt> pass is incomplete (there are cases it doesn't handle that
378     it should) and not thoroughly tested.</li>
379 <li>The <tt>llvm-ar</tt> tool is incomplete and probably buggy.</li>
380 <li>The <tt>llvm-db</tt> tool is in a very early stage of development.</li>
381 </ul>
382
383 </div>
384
385 <!-- ======================================================================= -->
386 <div class="doc_subsection">
387   <a name="core">Known problems with the LLVM Core</a>
388 </div>
389
390 <div class="doc_text">
391
392 <ul>
393
394 <li>In the JIT, <tt>dlsym</tt> on a symbol compiled by the JIT will not
395 work.</li>
396
397 <li>The JIT does not use mutexes to protect its internal data structures.  As
398 such, execution of a threaded program could cause these data structures to be
399 corrupted.</li>
400
401 <li>It is not possible to <tt>dlopen</tt> an LLVM bytecode file in the JIT.</li>
402
403 <li>Linking in static archive files (.a files) is very slow (there is no symbol
404 table in the archive).</li>
405
406 <li>The gccld program <a href="http://llvm.cs.uiuc.edu/PR139">does not link
407 objects/archives in the order specified on the command line.</a></li>
408
409 <li><a href="http://llvm.cs.uiuc.edu/PR240">The lower-invoke pass does not mark
410 values live across a setjmp as volatile</a>.  This missing feature only affects
411 targets whose setjmp/longjmp libraries do not save and restore the entire
412 register file.</li>
413 </ul>
414 </div>
415
416 <!-- ======================================================================= -->
417 <div class="doc_subsection">
418   <a name="c-fe">Known problems with the C front-end</a>
419 </div>
420
421 <!-- _______________________________________________________________________ -->
422 <div class="doc_subsubsection">Bugs</div>
423
424 <div class="doc_text">
425 <ul>
426 <li>C99 Variable sized arrays do not release stack memory when they go out of 
427     scope.  Thus, the following program may run out of stack space:
428 <pre>
429     for (i = 0; i != 1000000; ++i) {
430       int X[n];
431       foo(X);
432     }
433 </pre></li>
434
435 <li>Initialization of global union variables can only be done <a
436 href="http://llvm.cs.uiuc.edu/bugs/show_bug.cgi?id=162">with the largest union
437 member</a>.</li>
438
439 <li><a href="http://llvm.cs.uiuc.edu/PR244">[llvm-gcc] Error when an implicitly
440 external function is re-declared as static</a></li>
441
442 </ul>
443 </div>
444
445 <!-- _______________________________________________________________________ -->
446 <div class="doc_subsubsection">
447   Notes
448 </div>
449
450 <div class="doc_text">
451
452 <ul>
453
454 <li>Inline assembly is not yet supported.</li>
455
456 <li>"long double" is transformed by the front-end into "double".  There is no
457 support for floating point data types of any size other than 32 and 64
458 bits.</li>
459     
460 <li>The following Unix system functionality has not been tested and may not
461 work:
462   <ol>
463   <li><tt>sigsetjmp</tt>, <tt>siglongjmp</tt> - These are not turned into the
464       appropriate <tt>invoke</tt>/<tt>unwind</tt> instructions.  Note that
465       <tt>setjmp</tt> and <tt>longjmp</tt> <em>are</em> compiled correctly.
466   <li><tt>getcontext</tt>, <tt>setcontext</tt>, <tt>makecontext</tt>
467       - These functions have not been tested.
468   </ol></li>
469
470 <li>Although many GCC extensions are supported, some are not.  In particular,
471     the following extensions are known to <b>not be</b> supported:
472   <ol>
473   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Local-Labels.html#Local%20Labels">Local Labels</a>: Labels local to a block.</li>
474   <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>
475   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Constructing-Calls.html#Constructing%20Calls">Constructing Calls</a>: Dispatching a call to another function.</li>
476   <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>
477   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Constraints.html#Constraints">Constraints</a>: Constraints for asm operands.</li>
478   <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>
479   <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>
480   <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>
481   <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>
482   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Thread-Local.html#Thread-Local">Thread-Local</a>: Per-thread variables.</li>
483   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Pragmas.html#Pragmas">Pragmas</a>: Pragmas accepted by GCC.</li>
484   </ol>
485
486   <p>The following GCC extensions are <b>partially</b> supported.  An ignored
487   attribute means that the LLVM compiler ignores the presence of the attribute,
488   but the code should still work.  An unsupported attribute is one which is
489   ignored by the LLVM compiler and will cause a different interpretation of
490   the program.</p>
491
492   <ol>
493   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Length.html#Variable%20Length">Variable Length</a>:
494       Arrays whose length is computed at run time.<br>
495       Supported, but allocated stack space is not freed until the function returns (noted above).</li>
496
497   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Attributes.html#Function%20Attributes">Function Attributes</a>:
498
499       Declaring that functions have no side effects or that they can never
500       return.<br>
501
502       <b>Supported:</b> <tt>format</tt>, <tt>format_arg</tt>, <tt>non_null</tt>,
503       <tt>constructor</tt>, <tt>destructor</tt>, <tt>unused</tt>,
504       <tt>deprecated</tt>, <tt>warn_unused_result</tt>, <tt>weak</tt><br>
505
506       <b>Ignored:</b> <tt>noreturn</tt>, <tt>noinline</tt>,
507       <tt>always_inline</tt>, <tt>pure</tt>, <tt>const</tt>, <tt>nothrow</tt>,
508       <tt>malloc</tt>, <tt>no_instrument_function</tt>, <tt>cdecl</tt><br>
509
510       <b>Unsupported:</b> <tt>used</tt>, <tt>section</tt>, <tt>alias</tt>,
511       <tt>visibility</tt>, <tt>regparm</tt>, <tt>stdcall</tt>,
512       <tt>fastcall</tt>, all other target specific attributes</li>
513    
514   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Attributes.html#Variable%20Attributes">Variable Attributes</a>:
515       Specifying attributes of variables.<br>
516       <b>Supported:</b> <tt>cleanup</tt>, <tt>common</tt>, <tt>nocommon</tt>,
517                         <tt>deprecated</tt>, <tt>transparent_union</tt>,
518                         <tt>unused</tt>, <tt>weak</tt><br>
519
520       <b>Unsupported:</b> <tt>aligned</tt>, <tt>mode</tt>, <tt>packed</tt>,
521                         <tt>section</tt>, <tt>shared</tt>, <tt>tls_model</tt>,
522                         <tt>vector_size</tt>, <tt>dllimport</tt>, 
523                         <tt>dllexport</tt>, all target specific attributes.</li>
524
525   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Type-Attributes.html#Type%20Attributes">Type Attributes</a>:   Specifying attributes of types.<br>
526       <b>Supported:</b> <tt>transparent_union</tt>, <tt>unused</tt>,
527                         <tt>deprecated</tt>, <tt>may_alias</tt><br>
528
529       <b>Unsupported:</b> <tt>aligned</tt>, <tt>packed</tt>, 
530                         all target specific attributes.</li>
531
532   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Other-Builtins.html#Other%20Builtins">Other Builtins</a>:
533       Other built-in functions.<br>
534       We support all builtins which have a C language equivalent (e.g., 
535          <tt>__builtin_cos</tt>),  <tt>__builtin_alloca</tt>, 
536          <tt>__builtin_types_compatible_p</tt>, <tt>__builtin_choose_expr</tt>,
537          <tt>__builtin_constant_p</tt>, and <tt>__builtin_expect</tt>
538          (currently ignored).  We also support builtins for ISO C99 floating
539          point comparison macros (e.g., <tt>__builtin_islessequal</tt>).</li>
540   </ol>
541
542   <p>The following extensions <b>are</b> known to be supported:</p>
543
544   <ol>
545   <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>
546   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Statement-Exprs.html#Statement%20Exprs">Statement Exprs</a>:   Putting statements and declarations inside expressions.</li>
547   <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>
548   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Lvalues.html#Lvalues">Lvalues</a>: Using <code>?:</code>, "<code>,</code>" and casts in lvalues.</li>
549   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Conditionals.html#Conditionals">Conditionals</a>: Omitting the middle operand of a <code>?:</code> expression.</li>
550   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Long-Long.html#Long%20Long">Long Long</a>: Double-word integers.</li>
551   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Complex.html#Complex">Complex</a>:   Data types for complex numbers.</li>
552   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Hex-Floats.html#Hex%20Floats">Hex Floats</a>:Hexadecimal floating-point constants.</li>
553   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Zero-Length.html#Zero%20Length">Zero Length</a>: Zero-length arrays.</li>
554   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Empty-Structures.html#Empty%20Structures">Empty Structures</a>: Structures with no members.</li>
555   <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>
556   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Escaped-Newlines.html#Escaped%20Newlines">Escaped Newlines</a>:  Slightly looser rules for escaped newlines.</li>
557   <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>
558   <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>
559   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Initializers.html#Initializers">Initializers</a>: Non-constant initializers.</li>
560   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Compound-Literals.html#Compound%20Literals">Compound Literals</a>: Compound literals give structures, unions,
561 or arrays as values.</li>
562   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Designated-Inits.html#Designated%20Inits">Designated Inits</a>: Labeling elements of initializers.</li>
563   <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>
564   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Case-Ranges.html#Case%20Ranges">Case Ranges</a>: `case 1 ... 9' and such.</li>
565   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Mixed-Declarations.html#Mixed%20Declarations">Mixed Declarations</a>: Mixing declarations and code.</li>
566   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Prototypes.html#Function%20Prototypes">Function Prototypes</a>: Prototype declarations and old-style definitions.</li>
567   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/C---Comments.html#C++%20Comments">C++ Comments</a>: C++ comments are recognized.</li>
568   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Dollar-Signs.html#Dollar%20Signs">Dollar Signs</a>: Dollar sign is allowed in identifiers.</li>
569   <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>
570   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Alignment.html#Alignment">Alignment</a>: Inquiring about the alignment of a type or variable.</li>
571   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Inline.html#Inline">Inline</a>: Defining inline functions (as fast as macros).</li>
572   <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>
573   <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>
574   <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>
575   <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>
576   <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>
577   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Attribute-Syntax.html#Attribute%20Syntax">Attribute Syntax</a>: Formal syntax for attributes.</li>
578   </ol></li>
579
580 </ul>
581
582 <p>If you run into GCC extensions which have not been included in any of these
583 lists, please let us know (also including whether or not they work).</p>
584
585 </div>
586
587 <!-- ======================================================================= -->
588 <div class="doc_subsection">
589   <a name="c++-fe">Known problems with the C++ front-end</a>
590 </div>
591
592 <div class="doc_text">
593
594 <p>For this release, the C++ front-end is considered to be fully functional but
595 has not been tested as thoroughly as the C front-end.  It has been tested and 
596 works for a number of non-trivial programs, but there may be lurking bugs.
597 Please report any bugs or problems.</p>
598
599 </div>
600
601 <!-- _______________________________________________________________________ -->
602 <div class="doc_subsubsection">Bugs</div>
603
604 <div class="doc_text">
605
606 <ul>
607 <li>The C++ front-end inherits all problems afflicting the <a href="#c-fe">C
608     front-end</a>.</li>
609 </ul>
610 </div>
611
612 <!-- _______________________________________________________________________ -->
613 <div class="doc_subsubsection">
614   Notes
615 </div>
616
617 <div class="doc_text">
618
619 <ul>
620
621 <li>The C++ front-end is based on a pre-release of the GCC 3.4 C++ parser.  This
622 parser is significantly more standards compliant (and picky) than prior GCC
623 versions.  For more information, see the C++ section of the <a
624 href="http://gcc.gnu.org/gcc-3.4/changes.html">GCC 3.4 release notes</a>.</li>
625
626 <li>Destructors for local objects are not always run when a <tt>longjmp</tt> is
627     performed. In particular, destructors for objects in the <tt>longjmp</tt>ing
628     function and in the <tt>setjmp</tt> receiver function may not be run.
629     Objects in intervening stack frames will be destroyed, however (which is
630     better than most compilers).</li>
631
632 <li>The LLVM C++ front-end follows the <a
633     href="http://www.codesourcery.com/cxx-abi">Itanium C++ ABI</a>.
634     This document, which is not Itanium specific, specifies a standard for name
635     mangling, class layout, v-table layout, RTTI formats, and other C++
636     representation issues.  Because we use this API, code generated by the LLVM
637     compilers should be binary compatible with machine code generated by other
638     Itanium ABI C++ compilers (such as G++, the Intel and HP compilers, etc).
639     <i>However</i>, the exception handling mechanism used by LLVM is very
640     different from the model used in the Itanium ABI, so <b>exceptions will not
641     interact correctly</b>. </li>
642
643 </ul>
644
645 </div>
646
647 <!-- ======================================================================= -->
648 <div class="doc_subsection">
649   <a name="x86-be">Known problems with the X86 back-end</a>
650 </div>
651
652 <div class="doc_text">
653
654 <ul>
655   <li>Optimized (Release) versions of LLVM built with GCC 3.3.2 or 3.3.3 will 
656   produce an llc tool that always enters an infinite loop due to what 
657   appears to be an optimization bug (-O2 and -O3) in those versions of GCC. 
658   This problem does not happen in GCC 3.3.1 nor GCC 3.4.0 nor does it happen if
659   you build a Debug version of LLVM. You are cautioned not to use GCC 3.3.2 or 
660   GCC 3.3.3 to build Optimized versions of LLVM. It is unclear whether this problem 
661   affects other backends but it is unlikely.</li>
662 </ul>
663
664 </div>
665
666 <!-- ======================================================================= -->
667 <div class="doc_subsection">
668   <a name="sparc-be">Known problems with the Sparc back-end</a>
669 </div>
670
671 <div class="doc_text">
672
673 <ul>
674 <li>There are several programs in the LLVM testsuite that the Sparc code generator is known to miscompile.</li>
675 </ul>
676
677 </div>
678
679 <!-- ======================================================================= -->
680 <div class="doc_subsection">
681   <a name="c-be">Known problems with the C back-end</a>
682 </div>
683
684 <div class="doc_text">
685
686 <ul>
687
688 <li>The C back-end produces code that violates the ANSI C Type-Based Alias
689 Analysis rules.  As such, special options may be necessary to compile the code
690 (for example, GCC requires the <tt>-fno-strict-aliasing</tt> option).  This
691 problem probably cannot be fixed.</li>
692
693 <li><a href="http://llvm.cs.uiuc.edu/PR33">Initializers for global variables</a>
694 cannot include special floating point numbers like Not-A-Number or
695 Infinity.</li>
696
697 <li><a href="http://llvm.cs.uiuc.edu/PR56">Zero arg vararg functions are not 
698 supported</a>.  This should not affect LLVM produced by the C or C++ 
699 frontends.</li>
700
701 </ul>
702
703 </div>
704
705 <!-- *********************************************************************** -->
706 <div class="doc_section">
707   <a name="additionalinfo">Additional Information</a>
708 </div>
709 <!-- *********************************************************************** -->
710
711 <div class="doc_text">
712
713 <p>A wide variety of additional information is available on the LLVM web page,
714 including mailing lists and publications describing algorithms and components
715 implemented in LLVM.  The web page also contains versions of the API
716 documentation which is up-to-date with the CVS version of the source code.  You
717 can access versions of these documents specific to this release by going into
718 the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
719
720 <p>If you have any questions or comments about LLVM, please feel free to contact
721 us via the <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">mailing
722 lists</a>.</p>
723
724 </div>
725
726 <!-- *********************************************************************** -->
727
728 <hr>
729 <address>
730   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
731   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
732   <a href="http://validator.w3.org/check/referer"><img
733   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
734
735   <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br>
736   Last modified: $Date$
737 </address>
738
739 </body>
740 </html>