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