add generated code
[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   <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
6   <link rel="stylesheet" href="llvm.css" type="text/css">
7   <title>LLVM 1.5 Release Notes</title>
8 </head>
9 <body>
10
11 <div class="doc_title">LLVM 1.5 Release Notes</div>
12  
13 <ol>
14   <li><a href="#intro">Introduction</a></li>
15   <li><a href="#whatsnew">What's New?</a></li>
16   <li><a href="GettingStarted.html">Installation Instructions</a></li>
17   <li><a href="#portability">Portability and Supported Platforms</a></li>
18   <li><a href="#knownproblems">Known Problems</a>
19   <li><a href="#additionalinfo">Additional Information</a></li>
20 </ol>
21
22 <div class="doc_author">
23   <p>Written by the <a href="http://llvm.cs.uiuc.edu">LLVM Team</a><p>
24 </div>
25
26 <!-- *********************************************************************** -->
27 <div class="doc_section">
28   <a name="intro">Introduction</a>
29 </div>
30 <!-- *********************************************************************** -->
31
32 <div class="doc_text">
33
34 <p>This document contains the release notes for the LLVM compiler
35 infrastructure, release 1.5.  Here we describe the status of LLVM, including any
36 known problems and major improvements from the previous release.  The most
37 up-to-date version of this document can be found on the <a
38 href="http://llvm.cs.uiuc.edu/releases/1.5/">LLVM 1.5 web site</a>.  If you are
39 not reading this on the LLVM web pages, you should probably go there because
40 this document may be updated after the release.</p>
41
42 <p>For more information about LLVM, including information about the latest
43 release, please check out the <a href="http://llvm.cs.uiuc.edu">main LLVM
44 web site</a>.  If you have questions or comments, the <a
45 href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM developer's mailing
46 list</a> is a good place to send them.</p>
47
48 <p>Note that if you are reading this file from CVS or the main LLVM web page,
49 this document applies to the <i>next</i> release, not the current one.  To see
50 the release notes for the current or previous releases, see the <a
51 href="http://llvm.cs.uiuc.edu/releases/">releases page</a>.</p>
52
53 </div>
54
55 <!-- *********************************************************************** -->
56 <div class="doc_section">
57   <a name="whatsnew">What's New?</a>
58 </div>
59 <!-- *********************************************************************** -->
60
61 <div class="doc_text">
62
63 <p>This is the sixth public release of the LLVM Compiler Infrastructure.</p>
64
65 <p> At this time, LLVM is known to correctly compile a wide range of C and C++
66 programs, including the SPEC CPU95 &amp; 2000 suite.  It includes bug fixes for
67 those problems found since the 1.4 release and a large number of new features
68 and enhancements, described below.</p>
69
70 </div>
71
72 <!--=========================================================================-->
73 <div class="doc_subsection">
74 <a name="newfeatures">New Features in LLVM 1.5</a>
75 </div>
76
77 <!--_________________________________________________________________________-->
78 <div class="doc_subsubsection">New Native Code Generators</div>
79
80 <div class="doc_text">
81 <p>
82 This release includes new native code generators for <a
83 href="#alpha-be">Alpha</a>, <a href="#ia64-be">IA-64</a>, and SPARC-V8 (32-bit
84 SPARC).  These code generators are still beta quality, but are progressing
85 rapidly.
86 </p>
87 </div>
88
89 <!--_________________________________________________________________________-->
90 <div class="doc_subsubsection">New Instruction Selector Framework</div>
91
92 <div class="doc_text">
93 <p>This release includes a <a href="CodeGenerator.html#instselect">new framework
94 for building instruction selectors</a>, which has long been the hardest part of
95 building a new LLVM target.  This framework handles a lot of the mundane (but
96 easy to get wrong) details of writing the instruction selector, such as
97 generating efficient code for <a
98 href="LangRef.html#i_getelementptr">getelementptr</a> instructions, promoting
99 small integer types to larger types (e.g.  for RISC targets with one size of
100 integer registers), expanding 64-bit integer operations for 32-bit hosts, etc.
101 Currently, the X86, PowerPC, Alpha, and IA-64 backends use this framework.  The
102 SPARC backends will be migrated when time permits.
103 </p>
104 </div>
105
106 <!--_________________________________________________________________________-->
107 <div class="doc_subsubsection">New Support For Custom Calling Convetions</div>
108
109 <div class="doc_text">
110 <p>LLVM 1.5 adds supports for <a href="LangRef.html#callingconv">custom and
111 target-specific calling conventions</a>.  Traditionally, the LLVM code
112 generators match the native C calling conventions for a target.  This is
113 important for compatibility, but is not very flexible.  This release allows
114 custom calling conventions to be established for functions, and defines three
115 target-independent conventions (C call, fast call, and cold call) which may be
116 supported by code generators.  When possible, the LLVM optimizer promotes C
117 functions to use the "fastcc" convention, allowing the use of more efficient
118 calling sequences (e.g., parameters are passed in registers in the X86 target).
119 </p>
120
121 <p>Targets may now also define target-specific calling conventions, allowing
122 LLVM to fully support calling convention altering options (e.g. GCC's
123 <tt>-mregparm</tt> flag) and well-defined target conventions (e.g. stdcall and
124 fastcall on X86).</p>
125 </div>
126
127 <!--_________________________________________________________________________-->
128 <div class="doc_subsubsection">New Support for "Proper Tail Calls"</div>
129
130 <div class="doc_text">
131 <p>The release now includes support for <a
132 href="http://doi.acm.org/10.1145/277650.277719">proper tail calls</a>, as
133 required to implement languages like Scheme.  Tail calls make use of two
134 features: custom calling conventions (described above), which allow the code
135 generator to emit code for the caller to deallocate its own stack when it
136 returns.  The second feature is a flag on the <a href="LangRef.html#i_call">call
137 instruction</a>, which indicates that the callee does not access the callers
138 stack frame (indicating that it is acceptable to deallocate the caller stack
139 before invoking the callee).  LLVM proper tail calls run on the system stack (as
140 do normal calls), supports indirect tail calls, tail calls with arbitrary
141 numbers of arguments, tail calls where the callee requires more argument space
142 than the caller, etc.  The only case not supported are varargs calls, but that
143 could be added if desired.
144 </p>
145
146 <p>In order for a front-end to get guaranteed tail call, it must mark functions
147 as "fastcc", mark calls with the 'tail' marker, and follow the call with a
148 return of the called value (or void).  The optimizer and code generator attempt
149 to handle more general cases, but the simple case will always work if the code
150 generator supports tail calls.  Here is a simple example:</p>
151
152 <p><pre>
153     fastcc int %bar(int %X, int(double, int)* %FP) {       ;<i> fastcc</i>
154         %Y = tail call fastcc int %FP(double 0.0, int %X)  ;<i> tail, fastcc</i>
155         ret int %Y
156     }
157 </pre></p>
158
159 <p>In LLVM 1.5, the X86 code generator is the only target that has been enhanced
160 to support proper tail calls (other targets will be enhanced in future).
161 Further, because this support was added very close to the release, it is
162 disabled by default.  Pass <tt>-enable-x86-fastcc</tt> to llc to enable it (this
163 will be enabled by default in the next release).  The example above compiles to:
164 </p>
165
166 <p><pre>
167     bar:
168         sub ESP, 8                   # Callee uses more space than the caller
169         mov ECX, DWORD PTR [ESP + 8] # Get the old return address
170         mov DWORD PTR [ESP + 4], 0   # First half of 0.0
171         mov DWORD PTR [ESP + 8], 0   # Second half of 0.0
172         mov DWORD PTR [ESP], ECX     # Put the return address where it belongs
173         jmp EDX                      # Tail call "FP"
174 </pre></p>
175
176 <p>
177 With fastcc on X86, the first two integer arguments are passed in EAX/EDX, the
178 callee pops its arguments off the stack, and the argument area is always a
179 multiple of 8 bytes in size.
180 </p>
181
182 </div>
183
184 <!--_________________________________________________________________________-->
185 <div class="doc_subsubsection">Other New Features</div>
186
187 <div class="doc_text">
188 <ol>
189   <li>LLVM now includes an <a href="http://llvm.cs.uiuc.edu/PR415">
190       Interprocedural Sparse Conditional Constant Propagation</a> pass, named
191      -ipsccp, which is run by default at link-time.</li>
192   <li>LLVM 1.5 is now about 15% faster than LLVM 1.4 and its core data 
193       structures use about 30% less memory.</li>
194   <li>Support for Microsoft Visual Studio is improved, and <a 
195       href="GettingStartedVS.html">now documented</a>.</li>
196   <li><a href="GettingStarted.html#config">Configuring LLVM to build a subset
197       of the available targets</a> is now implemented, via the
198       <tt>--enable-targets=</tt> option.</li>
199    <li>LLVM can now create native shared libraries with '<tt>llvm-gcc ...
200        -shared -Wl,-native</tt>' (or with <tt>-Wl,-native-cbe</tt>).</li>
201    <li>LLVM now supports a new "<a href="LangRef.html#i_prefetch">llvm.prefetch
202        </a>" intrinsic, and llvm-gcc now supports __builtin_prefetch.
203   <li>LLVM now supports intrinsics for <a href="LangRef.html#int_count">bit
204       counting</a> and llvm-gcc now implements the GCC
205       <tt>__builtin_popcount</tt>, <tt>__builtin_ctz</tt>, and
206       <tt>__builtin_clz</tt> builtins.</li>
207   <li>LLVM now builds on HP-UX with the HP aCC Compiler.</li>
208   <li>The LLVM X86 backend can now emit Cygwin-compatible .s files.</li>
209   <li>LLVM now includes workarounds in the code generator generator which
210       reduces the likelyhood of <a href="http://llvm.cs.uiuc.edu/PR448">GCC
211       hitting swap during optimized builds</a>.</li>
212 </ol>
213 </div>
214
215 <!--=========================================================================-->
216 <div class="doc_subsection">
217 <a name="codequality">Code Quality Improvements in LLVM 1.5</a>
218 </div>
219
220 <div class="doc_text">
221 <ol>
222 <li>The -globalopt pass now promotes non-address-taken static globals that are
223 only accessed in main to SSA registers.</li>
224
225 <li>Loops with trip counts based on array pointer comparisons (e.g. "<tt>for (i
226 = 0; &amp;A[i] != &amp;A[100]; ++i) ...</tt>") are optimized better than before,
227 which primarily helps iterator-intensive C++ codes.</li>
228
229 <li>The code generator now uses information about takes advantage of commutative
230 two-address instructions when performing register allocation.</li>
231
232 <li>A new pass has been added to gccas to simplify well-known library calls. The
233 pass will short circuit calls to many of the string, memory, and printf type 
234 functions or replace the calls with simpler/faster calls, where possible given
235 information known statically about the arguments to the call. To use the
236 pass, specify <tt>-simplify-libcalls</tt> to the <tt>opt</tt> tool.</li>
237
238    
239 </ol>
240 </div>
241
242 <!--=========================================================================-->
243 <div class="doc_subsection">
244 <a name="bugfix">Significant Bugs Fixed in LLVM 1.5</a>
245 </div>
246
247 <div class="doc_text">
248
249
250 <p>Bugs fixed in the LLVM Core:</p>
251 <ol>
252    <li><a href="http://llvm.cs.uiuc.edu/PR491">[dse] DSE deletes stores that 
253        are partially overwritten by smaller stores</a></li>
254    <li><a href="http://llvm.cs.uiuc.edu/PR548">[instcombine] miscompilation of 
255        setcc or setcc in one case</a></li>
256    <li>Transition code for LLVM 1.0 style varargs was removed from the .ll file
257    parser.  LLVM 1.0 bytecode files are still supported. </li>
258 </ol>
259
260 <p>Code Generator Bugs:</p>
261 <ol>
262    <li><a href="http://llvm.cs.uiuc.edu/PR490">[cbackend] Logical constant 
263        expressions (and/or/xor) not implemented</a></li>
264    <li><a href="http://llvm.cs.uiuc.edu/PR511">[cbackend] C backend does not 
265        respect 'volatile'</a></li>
266 </ol>
267
268 <p>Bugs in the C/C++ front-end:</p>
269 <ol>
270    <li><a href="http://llvm.cs.uiuc.edu/PR487">[llvmgcc] llvm-gcc incorrectly 
271        rejects some constant initializers involving the addresses of array 
272        elements</a></li>
273    <li><a href="http://llvm.cs.uiuc.edu/PR501">[llvm-g++] Crash compiling 
274        anonymous union</a></li>
275    <li><a href="http://llvm.cs.uiuc.edu/PR509">[llvm-g++] Do not use dynamic 
276        initialization where static init will do</a></li>
277    <li><a href="http://llvm.cs.uiuc.edu/PR510">[llvmgcc] Field offset 
278        miscalculated for some structure fields following bit fields</a></li>
279    <li><a href="http://llvm.cs.uiuc.edu/PR513">[llvm-g++] Temporary lifetimes 
280        incorrect for short circuit logical operations</a></li>
281    <li><a href="http://llvm.cs.uiuc.edu/PR517">[llvm-gcc] Crash compiling 
282        bitfield &lt;-&gt; aggregate assignment</a></li>
283    <li><a href="http://llvm.cs.uiuc.edu/PR520">[llvm-g++] Error compiling 
284        virtual function thunk with an unnamed argument</a></li>
285    <li><a href="http://llvm.cs.uiuc.edu/PR522">[llvm-gcc] Crash on certain 
286        C99 complex number routines</a></li>
287    <li><a href="http://llvm.cs.uiuc.edu/PR529">[llvm-g++] Crash using placement
288        new on an array type</a></li>
289 </ol>
290
291 </div>
292
293 <!-- *********************************************************************** -->
294 <div class="doc_section">
295   <a name="portability">Portability and Supported Platforms</a>
296 </div>
297 <!-- *********************************************************************** -->
298
299 <div class="doc_text">
300
301 <p>LLVM is known to work on the following platforms:</p>
302
303 <ul>
304 <li>Intel and AMD machines running Red Hat Linux and FreeBSD (and probably 
305     other unix-like systems).</li>
306 <li>Sun UltraSPARC workstations running Solaris 8.</li>
307 <li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
308     support is available for native builds with Visual C++).</li>
309 <li>PowerPC-based Mac OS X systems, running 10.2 and above.</li>
310 <li>Alpha-based machines running Debian GNU/Linux.</li>
311 <li>Itanium-based machines running Linux and HP-UX.</li>
312 </ul>
313
314 <p>The core LLVM infrastructure uses
315 <a href="http://www.gnu.org/software/autoconf/">GNU autoconf</a> to adapt itself
316 to the machine and operating system on which it is built.  However, minor
317 porting may be required to get LLVM to work on new platforms.  We welcome your
318 portability patches and reports of successful builds or error messages.</p>
319
320 </div>
321
322 <!-- *********************************************************************** -->
323 <div class="doc_section">
324   <a name="knownproblems">Known Problems</a>
325 </div>
326 <!-- *********************************************************************** -->
327
328 <div class="doc_text">
329
330 <p>This section contains all known problems with the LLVM system, listed by
331 component.  As new problems are discovered, they will be added to these
332 sections.  If you run into a problem, please check the <a
333 href="http://llvm.cs.uiuc.edu/bugs/">LLVM bug database</a> and submit a bug if
334 there isn't already one.</p>
335
336 </div>
337
338 <!-- ======================================================================= -->
339 <div class="doc_subsection">
340   <a name="experimental">Experimental features included with this release</a>
341 </div>
342
343 <div class="doc_text">
344
345 <p>The following components of this LLVM release are either untested, known to
346 be broken or unreliable, or are in early development.  These components should
347 not be relied on, and bugs should not be filed against them, but they may be
348 useful to some people.  In particular, if you would like to work on one of these
349 components, please contact us on the llvmdev list.</p>
350
351 <ul>
352 <li>The following passes are incomplete or buggy, and may be removed in future
353     releases: <tt>-cee, -branch-combine, -instloops, -paths, -pre</tt></li>
354 <li>The <tt>llvm-db</tt> tool is in a very early stage of development, but can
355     be used to step through programs and inspect the stack.</li>
356 <li>The "iterative scan" register allocator (enabled with 
357     <tt>-regalloc=iterativescan</tt>) is not stable.</li>
358 <li>The SparcV8, Alpha, and IA64 code generators are experimental.</li>
359 </ul>
360
361 </div>
362
363 <!-- ======================================================================= -->
364 <div class="doc_subsection">
365   <a name="core">Known problems with the LLVM Core</a>
366 </div>
367
368 <div class="doc_text">
369
370 <ul>
371   <li>In the JIT, <tt>dlsym()</tt> on a symbol compiled by the JIT will not
372   work.</li>
373   <li>The JIT does not use mutexes to protect its internal data structures. As
374   such, execution of a threaded program could cause these data structures to be
375   corrupted.
376   </li>
377   <li><a href="http://llvm.cs.uiuc.edu/PR240">The lower-invoke pass does not 
378     mark values live across a setjmp as volatile</a>. This missing feature 
379   only affects targets whose setjmp/longjmp libraries do not save and restore 
380   the entire register file.</li>
381 </ul>
382 </div>
383
384 <!-- ======================================================================= -->
385 <div class="doc_subsection">
386   <a name="c-fe">Known problems with the C front-end</a>
387 </div>
388
389 <!-- _______________________________________________________________________ -->
390 <div class="doc_subsubsection">Bugs</div>
391
392 <div class="doc_text">
393 <ul>
394 <li>C99 Variable sized arrays do not release stack memory when they go out of 
395     scope.  Thus, the following program may run out of stack space:
396 <pre>
397     for (i = 0; i != 1000000; ++i) {
398       int X[n];
399       foo(X);
400     }
401 </pre></li>
402
403 <li>Initialization of global union variables can only be done <a
404 href="http://llvm.cs.uiuc.edu/PR162">with the largest union member</a>.</li>
405
406 </ul>
407 </div>
408
409 <!-- _______________________________________________________________________ -->
410 <div class="doc_subsubsection">
411   Notes
412 </div>
413
414 <div class="doc_text">
415
416 <ul>
417
418 <li>Inline assembly is not yet supported.</li>
419
420 <li>"long double" is transformed by the front-end into "double".  There is no
421 support for floating point data types of any size other than 32 and 64
422 bits.</li>
423     
424 <li>The following Unix system functionality has not been tested and may not
425 work:
426   <ol>
427   <li><tt>sigsetjmp</tt>, <tt>siglongjmp</tt> - These are not turned into the
428       appropriate <tt>invoke</tt>/<tt>unwind</tt> instructions.  Note that
429       <tt>setjmp</tt> and <tt>longjmp</tt> <em>are</em> compiled correctly.
430   <li><tt>getcontext</tt>, <tt>setcontext</tt>, <tt>makecontext</tt>
431       - These functions have not been tested.
432   </ol></li>
433
434 <li>Although many GCC extensions are supported, some are not.  In particular,
435     the following extensions are known to <b>not be</b> supported:
436   <ol>
437   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Local-Labels.html#Local%20Labels">Local Labels</a>: Labels local to a block.</li>
438   <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>
439   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Constructing-Calls.html#Constructing%20Calls">Constructing Calls</a>: Dispatching a call to another function.</li>
440   <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>
441   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Constraints.html#Constraints">Constraints</a>: Constraints for asm operands.</li>
442   <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>
443   <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>
444   <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>
445   <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>
446   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Thread_002dLocal.html">Thread-Local</a>: Per-thread variables.</li>
447   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Pragmas.html#Pragmas">Pragmas</a>: Pragmas accepted by GCC.</li>
448   </ol>
449
450   <p>The following GCC extensions are <b>partially</b> supported.  An ignored
451   attribute means that the LLVM compiler ignores the presence of the attribute,
452   but the code should still work.  An unsupported attribute is one which is
453   ignored by the LLVM compiler and will cause a different interpretation of
454   the program.</p>
455
456   <ol>
457   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Length.html#Variable%20Length">Variable Length</a>:
458       Arrays whose length is computed at run time.<br>
459       Supported, but allocated stack space is not freed until the function returns (noted above).</li>
460
461   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Attributes.html#Function%20Attributes">Function Attributes</a>:
462
463       Declaring that functions have no side effects or that they can never
464       return.<br>
465
466       <b>Supported:</b> <tt>format</tt>, <tt>format_arg</tt>, <tt>non_null</tt>,
467       <tt>noreturn</tt>, <tt>constructor</tt>, <tt>destructor</tt>,
468       <tt>unused</tt>,
469       <tt>deprecated</tt>, <tt>warn_unused_result</tt>, <tt>weak</tt><br>
470
471       <b>Ignored:</b> <tt>noinline</tt>,
472       <tt>always_inline</tt>, <tt>pure</tt>, <tt>const</tt>, <tt>nothrow</tt>,
473       <tt>malloc</tt>, <tt>no_instrument_function</tt>, <tt>cdecl</tt><br>
474
475       <b>Unsupported:</b> <tt>used</tt>, <tt>section</tt>, <tt>alias</tt>,
476       <tt>visibility</tt>, <tt>regparm</tt>, <tt>stdcall</tt>,
477       <tt>fastcall</tt>, all other target specific attributes</li>
478    
479   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Attributes.html#Variable%20Attributes">Variable Attributes</a>:
480       Specifying attributes of variables.<br>
481       <b>Supported:</b> <tt>cleanup</tt>, <tt>common</tt>, <tt>nocommon</tt>,
482                         <tt>deprecated</tt>, <tt>transparent_union</tt>,
483                         <tt>unused</tt>, <tt>weak</tt><br>
484
485       <b>Unsupported:</b> <tt>aligned</tt>, <tt>mode</tt>, <tt>packed</tt>,
486                         <tt>section</tt>, <tt>shared</tt>, <tt>tls_model</tt>,
487                         <tt>vector_size</tt>, <tt>dllimport</tt>, 
488                         <tt>dllexport</tt>, all target specific attributes.</li>
489
490   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Type-Attributes.html#Type%20Attributes">Type Attributes</a>:   Specifying attributes of types.<br>
491       <b>Supported:</b> <tt>transparent_union</tt>, <tt>unused</tt>,
492                         <tt>deprecated</tt>, <tt>may_alias</tt><br>
493
494       <b>Unsupported:</b> <tt>aligned</tt>, <tt>packed</tt>, 
495                         all target specific attributes.</li>
496
497   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Other-Builtins.html#Other%20Builtins">Other Builtins</a>:
498       Other built-in functions.<br>
499       We support all builtins which have a C language equivalent (e.g., 
500          <tt>__builtin_cos</tt>),  <tt>__builtin_alloca</tt>, 
501          <tt>__builtin_types_compatible_p</tt>, <tt>__builtin_choose_expr</tt>,
502          <tt>__builtin_constant_p</tt>, and <tt>__builtin_expect</tt>
503          (currently ignored).  We also support builtins for ISO C99 floating
504          point comparison macros (e.g., <tt>__builtin_islessequal</tt>), 
505          <tt>__builtin_prefetch</tt>, <tt>__builtin_popcount[ll]</tt>,
506          <tt>__builtin_clz[ll]</tt>, and <tt>__builtin_ctz[ll]</tt>.</li>
507   </ol>
508
509   <p>The following extensions <b>are</b> known to be supported:</p>
510
511   <ol>
512   <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>
513   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Statement-Exprs.html#Statement%20Exprs">Statement Exprs</a>:   Putting statements and declarations inside expressions.</li>
514   <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>
515   <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>
516   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Conditionals.html#Conditionals">Conditionals</a>: Omitting the middle operand of a <code>?:</code> expression.</li>
517   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Long-Long.html#Long%20Long">Long Long</a>: Double-word integers.</li>
518   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Complex.html#Complex">Complex</a>:   Data types for complex numbers.</li>
519   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Hex-Floats.html#Hex%20Floats">Hex Floats</a>:Hexadecimal floating-point constants.</li>
520   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Zero-Length.html#Zero%20Length">Zero Length</a>: Zero-length arrays.</li>
521   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Empty-Structures.html#Empty%20Structures">Empty Structures</a>: Structures with no members.</li>
522   <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>
523   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Escaped-Newlines.html#Escaped%20Newlines">Escaped Newlines</a>:  Slightly looser rules for escaped newlines.</li>
524   <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>
525   <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>
526   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Initializers.html#Initializers">Initializers</a>: Non-constant initializers.</li>
527   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Compound-Literals.html#Compound%20Literals">Compound Literals</a>: Compound literals give structures, unions,
528 or arrays as values.</li>
529   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Designated-Inits.html#Designated%20Inits">Designated Inits</a>: Labeling elements of initializers.</li>
530   <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>
531   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Case-Ranges.html#Case%20Ranges">Case Ranges</a>: `case 1 ... 9' and such.</li>
532   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Mixed-Declarations.html#Mixed%20Declarations">Mixed Declarations</a>: Mixing declarations and code.</li>
533   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Prototypes.html#Function%20Prototypes">Function Prototypes</a>: Prototype declarations and old-style definitions.</li>
534   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/C_002b_002b-Comments.html#C_002b_002b-Comments">C++ Comments</a>: C++ comments are recognized.</li>
535   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Dollar-Signs.html#Dollar%20Signs">Dollar Signs</a>: Dollar sign is allowed in identifiers.</li>
536   <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>
537   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Alignment.html#Alignment">Alignment</a>: Inquiring about the alignment of a type or variable.</li>
538   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Inline.html#Inline">Inline</a>: Defining inline functions (as fast as macros).</li>
539   <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>
540   <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>
541   <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>
542   <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>
543   <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>
544   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Attribute-Syntax.html#Attribute%20Syntax">Attribute Syntax</a>: Formal syntax for attributes.</li>
545   </ol></li>
546
547 </ul>
548
549 <p>If you run into GCC extensions which have not been included in any of these
550 lists, please let us know (also including whether or not they work).</p>
551
552 </div>
553
554 <!-- ======================================================================= -->
555 <div class="doc_subsection">
556   <a name="c++-fe">Known problems with the C++ front-end</a>
557 </div>
558
559 <div class="doc_text">
560
561 <p>For this release, the C++ front-end is considered to be fully
562 tested and works for a number of non-trivial programs, including LLVM
563 itself.</p>
564
565 </div>
566
567 <!-- _______________________________________________________________________ -->
568 <div class="doc_subsubsection">Bugs</div>
569
570 <div class="doc_text">
571
572 <ul>
573 <li>The C++ front-end inherits all problems afflicting the <a href="#c-fe">C
574     front-end</a>.</li>
575
576 <li><b>IA-64 specific</b>: The C++ front-end does not use <a 
577 href="http://llvm.cs.uiuc.edu/PR406">IA64 ABI compliant layout of v-tables</a>.
578 In particular, it just stores function pointers instead of function
579 descriptors in the vtable.  This bug prevents mixing C++ code compiled with
580 LLVM with C++ objects compiled by other C++ compilers.</li>
581
582 </ul>
583
584 </div>
585
586 <!-- _______________________________________________________________________ -->
587 <div class="doc_subsubsection">
588   Notes
589 </div>
590
591 <div class="doc_text">
592
593 <ul>
594
595 <li>The C++ front-end is based on a pre-release of the GCC 3.4 C++ parser.  This
596 parser is significantly more standards compliant (and picky) than prior GCC
597 versions.  For more information, see the C++ section of the <a
598 href="http://gcc.gnu.org/gcc-3.4/changes.html">GCC 3.4 release notes</a>.</li>
599
600 <li>Destructors for local objects are not always run when a <tt>longjmp</tt> is
601     performed. In particular, destructors for objects in the <tt>longjmp</tt>ing
602     function and in the <tt>setjmp</tt> receiver function may not be run.
603     Objects in intervening stack frames will be destroyed, however (which is
604     better than most compilers).</li>
605
606 <li>The LLVM C++ front-end follows the <a
607     href="http://www.codesourcery.com/cxx-abi">Itanium C++ ABI</a>.
608     This document, which is not Itanium specific, specifies a standard for name
609     mangling, class layout, v-table layout, RTTI formats, and other C++
610     representation issues.  Because we use this API, code generated by the LLVM
611     compilers should be binary compatible with machine code generated by other
612     Itanium ABI C++ compilers (such as G++, the Intel and HP compilers, etc).
613     <i>However</i>, the exception handling mechanism used by LLVM is very
614     different from the model used in the Itanium ABI, so <b>exceptions will not
615     interact correctly</b>. </li>
616
617 </ul>
618
619 </div>
620
621 <!-- ======================================================================= -->
622 <div class="doc_subsection">
623   <a name="x86-be">Known problems with the X86 back-end</a>
624 </div>
625
626 <div class="doc_text">
627
628 <ul>
629   <li>None yet</li>
630 </ul>
631
632 </div>
633
634 <!-- ======================================================================= -->
635 <div class="doc_subsection">
636   <a name="sparcv9-be">Known problems with the SparcV9 back-end</a>
637 </div>
638
639 <div class="doc_text">
640
641 <ul>
642 <li><a href="http://llvm.cs.uiuc.edu/PR60">[sparcv9] SparcV9 backend miscompiles
643 several programs in the LLVM test suite</a></li>
644 </ul>
645
646 </div>
647
648 <!-- ======================================================================= -->
649 <div class="doc_subsection">
650   <a name="ppc-be">Known problems with the PowerPC back-end</a>
651 </div>
652
653 <div class="doc_text">
654
655 <ul>
656 <li>None yet</li>
657 </ul>
658
659 </div>
660
661 <!-- ======================================================================= -->
662 <div class="doc_subsection">
663   <a name="c-be">Known problems with the C back-end</a>
664 </div>
665
666 <div class="doc_text">
667
668 <ul>
669
670 <li>The C back-end produces code that violates the ANSI C Type-Based Alias
671 Analysis rules.  As such, special options may be necessary to compile the code
672 (for example, GCC requires the <tt>-fno-strict-aliasing</tt> option).  This
673 problem probably cannot be fixed.</li>
674
675 <li><a href="http://llvm.cs.uiuc.edu/PR56">Zero arg vararg functions are not 
676 supported</a>.  This should not affect LLVM produced by the C or C++ 
677 frontends.</li>
678
679 </ul>
680
681 </div>
682
683 <!-- ======================================================================= -->
684 <div class="doc_subsection">
685   <a name="alpha-be">Known problems with the Alpha back-end</a>
686 </div>
687
688 <div class="doc_text">
689
690 <ul>
691
692 <li>On 21164s, some rare FP arithmatic sequences which may trap do not have the appropriate nops inserted to ensure restartability.</li>
693
694 <li>Vararg functions are not supported.</li>
695
696 <li>Due to the vararg problems, C++ exceptions do not work.  Small changes are required to the CFE (which break correctness in the exception handler) to compile the exception handling library (and thus the C++ standard library).</li>
697
698 </ul>
699
700 </div>
701
702 <!-- ======================================================================= -->
703 <div class="doc_subsection">
704   <a name="ia64-be">Known problems with the IA64 back-end</a>
705 </div>
706
707 <div class="doc_text">
708
709 <ul>
710
711 <li>C++ programs are likely to fail on IA64, as calls to <tt>setjmp</tt> are
712 made where the argument is not 16-byte aligned, as required on IA64. (Strictly
713 speaking this is not a bug in the IA64 back-end; it will also be encountered
714 when building C++ programs using the C back-end.)</li>
715
716 <li>There are a few ABI violations which will lead to problems
717 when mixing LLVM output with code built with other compilers,
718 particularly for C++ and floating-point programs.</li>
719
720 <li>Vararg functions are not supported.</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 <a href="http://llvm.cs.uiuc.edu/docs/#maillist">mailing lists</a> and
736 <a href="http://llvm.cs.uiuc.edu/pubs/">publications describing algorithms and
737 components implemented in LLVM</a>.  The web page also contains versions of the
738 API documentation which is up-to-date with the CVS version of the source code.
739 You can access versions of these documents specific to this release by going
740 into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
741
742 <p>If you have any questions or comments about LLVM, please feel free to contact
743 us via the <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">mailing
744 lists</a>.</p>
745
746 </div>
747
748 <!-- *********************************************************************** -->
749
750 <hr>
751 <address>
752   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
753   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
754   <a href="http://validator.w3.org/check/referer"><img
755   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
756
757   <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br>
758   Last modified: $Date$
759 </address>
760
761 </body>
762 </html>