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