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