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