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