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