Wrap (some) lines to 80 cols.
[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="#portability">Portability and Supported Platforms</a></li>
16   <li><a href="#install-instructions">Installation Instructions</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_text">
32   <p><b>Written by the <a href="http://llvm.cs.uiuc.edu">LLVM team</a></b><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>
73 This is the fourth public release of the LLVM compiler infrastructure. 
74 </p>
75
76 <p>
77 At this time, LLVM is known to correctly compile and run all C &amp; C++ SPEC
78 CPU2000 benchmarks, the Olden benchmarks, and the Ptrdist benchmarks.  It has
79 also been used to compile <b>many</b> other programs.  LLVM now also works with
80 a broad variety of C++ programs, though it has still received less testing than
81 the C front-end.
82 </p>
83
84 <!--=========================================================================-->
85 <div class="doc_subsubsection">
86 <a name="newfeatures">This release implements the following new features:</a>
87 </div>
88
89 <ol>
90 <li>The LLVM <a href="LangRef.html#i_select"><tt>select</tt></a> instruction is
91 now fully implemented and supported by all targets.</li>
92 <li>Bugpoint can now narrow down code-generation bugs to a loop nest, where
93 before it could only narrow them down to a function being miscompiled.</li>
94 </ol>
95
96
97 <!--=========================================================================-->
98 <div class="doc_subsubsection">
99 In this release, the following missing features were implemented:
100 </div>
101
102 <ol>
103 <li><a href="http://llvm.cs.uiuc.edu/PR82">LLVM cannot handle structures with
104 more than 256 elements</a></li>
105 </ol>
106
107
108 <!--=========================================================================-->
109 <div class="doc_subsubsection">
110 <a name="qualityofimp">In this release, the following Quality of Implementation
111 issues were fixed:</a>
112 </div>
113
114 <ol>
115 <li><a href="http://llvm.cs.uiuc.edu/PR305">LLVM tools will happily spew
116 bytecode onto your terminal</a></li>
117 </ol>
118
119 <!--=========================================================================-->
120 <div class="doc_subsubsection">
121 In this release, the following build problems were fixed:
122 </div>
123
124 <ol>
125 <li></li>
126 </ol>
127
128 <!--=========================================================================-->
129 <div class="doc_subsubsection">
130 <a name="codequality">In this release, the following Code Quality issues were
131 fixed:</a>
132 </div>
133
134 <ol>
135 <li><a href="http://llvm.cs.uiuc.edu/PR309">[vmcore] Code quality problem due to
136 long operand of getelementptr</a></li>
137
138 <li>The X86 backend now generates substantially better code for 64-bit integer
139 and floating point operations.</li>
140
141 <li>The -inline pass no longer inlines mutually recursive functions until it
142 hits the inlining threshold.</li>
143
144 <li>The -inline pass no longer misses obvious inlining opportunities just
145 because the callee eventually calls into an external function.</li>
146
147 <li>The -simplifycfg pass can now "if convert" simple statements into the new
148 <tt>select</tt> instruction.</li>
149
150 <li>The -loopsimplify pass can now break <a
151 href="http://llvm.cs.uiuc.edu/PR35">natural loops with multiple backedges</a>
152 into multiple nested loops.  This enables a variety of subsequent
153 optimizations.</li>
154
155 <li>The -adce pass can now eliminate calls to functions that do not not write to
156 memory.</li>
157
158 <li>The link-time optimizer now runs the -prune-eh pass (to remove unused
159 exception handlers.</li>
160
161 </ol>
162
163
164 <!--=========================================================================-->
165 <div class="doc_subsubsection">
166 <a name="bugfix">In this release, the following bugs in the previous release
167 were fixed:</a>
168 </div>
169
170 <p>Bugs in the LLVM Core:</p>
171
172 <ol>
173 <li><a href="http://llvm.cs.uiuc.edu/PR306">[loopsimplify] Loop simplify
174 incorrectly updates dominator information</a></li>
175 <li><a href="http://llvm.cs.uiuc.edu/PR310">[tailduplicate] DemoteRegToStack
176 breaks SSA form</a></li>
177 <li><a href="http://llvm.cs.uiuc.edu/PR313">[X86] JIT miscompiles unsigned short
178 to floating point cast</a></li>
179 </ol>
180
181
182
183 <p>Bugs in the C/C++ front-end:</p>
184
185 <ol>
186 <li></li>
187 </ol>
188
189 </div>
190
191 <!-- *********************************************************************** -->
192 <div class="doc_section">
193   <a name="portability">Portability and Supported Platforms</a>
194 </div>
195 <!-- *********************************************************************** -->
196
197 <div class="doc_text">
198
199 <p>LLVM has been extensively tested on Intel and AMD machines running Red
200 Hat Linux and FreeBSD.  It has also been tested on Sun UltraSPARC workstations
201 running Solaris 8.  Additionally, LLVM works on Mac OS X 10.3 and above, but
202 only with the C backend or interpreter (no native backend for the PowerPC is
203 available yet).  The core LLVM infrastructure uses "autoconf" for portability,
204 so hopefully we work on more platforms than that.  However, it is likely that we
205 missed something and that minor porting is required to get LLVM to work on new
206 platforms.  We welcome portability patches and error messages.</p>
207
208 </div>
209
210 <!-- *********************************************************************** -->
211 <div class="doc_section">
212   <a name="knownproblems">Known Problems</a>
213 </div>
214 <!-- *********************************************************************** -->
215
216 <div class="doc_text">
217
218 <p>This section contains all known problems with the LLVM system, listed by
219 component.  As new problems are discovered, they will be added to these
220 sections.  If you run into a problem, please check the <a
221 href="http://llvm.cs.uiuc.edu/bugs/">LLVM bug database</a> and submit a bug if
222 there isn't already one.</p>
223
224 </div>
225
226 <!-- ======================================================================= -->
227 <div class="doc_subsection">
228   <a name="experimental">Experimental features included with this release</a>
229 </div>
230
231 <div class="doc_text">
232
233 <p>
234 The following components of this LLVM release are either untested, known to be
235 broken or unreliable, or are in early development.  These components should not
236 be relied on, and bugs should not be filed against them, but they may be useful
237 to some people.  In particular, if you would like to work on one of these
238 components, please contact us on the llvmdev list.
239 </p>
240
241 <ul>
242 <li>The following passes are incomplete or buggy: <tt>-pgmdep, -memdep,
243     -ipmodref, -sortstructs, -swapstructs, -cee</tt></li>
244
245 <li>The <tt>-pre</tt> pass is incomplete (there are cases it doesn't handle that
246     it should) and not thoroughly tested.</li>
247 <li>The <tt>llvm-ar</tt> tool is incomplete and probably buggy.</li>
248 <li>The <tt>llvm-db</tt> tool is in a very early stage of development.</li>
249 </ul>
250
251 </div>
252
253 <!-- ======================================================================= -->
254 <div class="doc_subsection">
255   <a name="core">Known problems with the LLVM Core</a>
256 </div>
257
258 <div class="doc_text">
259
260 <ul>
261
262 <li>In the JIT, <tt>dlsym</tt> on a symbol compiled by the JIT will not
263 work.</li>
264
265 <li>The JIT does not use mutexes to protect its internal data structures.  As
266 such, execution of a threaded program could cause these data structures to be
267 corrupted.</li>
268
269 <li>It is not possible to <tt>dlopen</tt> an LLVM bytecode file in the JIT.</li>
270
271 <li>Linking in static archive files (.a files) is very slow (there is no symbol
272 table in the archive).</li>
273
274 <li>The gccld program <a href="http://llvm.cs.uiuc.edu/PR139">does not link
275 objects/archives in the order specified on the command line.</a></li>
276
277 <li><a href="http://llvm.cs.uiuc.edu/PR240">The lower-invoke pass does not mark
278 values live across a setjmp as volatile</a>.  This missing feature only affects
279 targets whose setjmp/longjmp libraries do not save and restore the entire
280 register file.</li>
281 </ul>
282 </div>
283
284 <!-- ======================================================================= -->
285 <div class="doc_subsection">
286   <a name="c-fe">Known problems with the C front-end</a>
287 </div>
288
289 <!-- _______________________________________________________________________ -->
290 <div class="doc_subsubsection">Bugs</div>
291
292 <div class="doc_text">
293 <ul>
294 <li>C99 Variable sized arrays do not release stack memory when they go out of 
295     scope.  Thus, the following program may run out of stack space:
296 <pre>
297     for (i = 0; i != 1000000; ++i) {
298       int X[n];
299       foo(X);
300     }
301 </pre></li>
302
303 <li>
304 Initialization of global union variables can only be done
305 <a href="http://llvm.cs.uiuc.edu/bugs/show_bug.cgi?id=162">with the largest
306 union member</a>.
307 </li>
308
309 <li><a href="http://llvm.cs.uiuc.edu/PR244">[llvm-gcc] Error when an implicitly
310 external function is re-declared as static</a></li>
311
312 </ul>
313 </div>
314
315 <!-- _______________________________________________________________________ -->
316 <div class="doc_subsubsection">
317   Notes
318 </div>
319
320 <div class="doc_text">
321
322 <ul>
323
324 <li>Inline assembly is not yet supported.</li>
325
326 <li>"long double" is transformed by the front-end into "double".  There is no
327 support for floating point data types of any size other than 32 and 64
328 bits.</li>
329     
330 <li>The following Unix system functionality has not been tested and may not
331 work:
332   <ol>
333   <li><tt>sigsetjmp</tt>, <tt>siglongjmp</tt> - These are not turned into the
334       appropriate <tt>invoke</tt>/<tt>unwind</tt> instructions.  Note that
335       <tt>setjmp</tt> and <tt>longjmp</tt> <em>are</em> compiled correctly.
336   <li><tt>getcontext</tt>, <tt>setcontext</tt>, <tt>makecontext</tt>
337       - These functions have not been tested.
338   </ol></li>
339
340 <li>Although many GCC extensions are supported, some are not.  In particular,
341     the following extensions are known to <b>not be</b> supported:
342   <ol>
343   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Local-Labels.html#Local%20Labels">Local Labels</a>: Labels local to a block.</li>
344   <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>
345   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Constructing-Calls.html#Constructing%20Calls">Constructing Calls</a>: Dispatching a call to another function.</li>
346   <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>
347   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Constraints.html#Constraints">Constraints</a>: Constraints for asm operands.</li>
348   <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>
349   <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>
350   <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>
351   <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>
352   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Thread-Local.html#Thread-Local">Thread-Local</a>: Per-thread variables.</li>
353   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Pragmas.html#Pragmas">Pragmas</a>: Pragmas accepted by GCC.</li>
354   </ol>
355
356   <p>The following GCC extensions are <b>partially</b> supported.  An ignored
357   attribute means that the LLVM compiler ignores the presence of the attribute,
358   but the code should still work.  An unsupported attribute is one which is
359   ignored by the LLVM compiler and will cause a different interpretation of
360   the program.</p>
361
362   <ol>
363   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Length.html#Variable%20Length">Variable Length</a>:
364       Arrays whose length is computed at run time.<br>
365       Supported, but allocated stack space is not freed until the function returns (noted above).</li>
366
367   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Attributes.html#Function%20Attributes">Function Attributes</a>:
368
369       Declaring that functions have no side effects or that they can never
370       return.<br>
371
372       <b>Supported:</b> <tt>format</tt>, <tt>format_arg</tt>, <tt>non_null</tt>,
373       <tt>constructor</tt>, <tt>destructor</tt>, <tt>unused</tt>,
374       <tt>deprecated</tt>, <tt>warn_unused_result</tt>, <tt>weak</tt><br>
375
376       <b>Ignored:</b> <tt>noreturn</tt>, <tt>noinline</tt>,
377       <tt>always_inline</tt>, <tt>pure</tt>, <tt>const</tt>, <tt>nothrow</tt>,
378       <tt>malloc</tt>, <tt>no_instrument_function</tt>, <tt>cdecl</tt><br>
379
380       <b>Unsupported:</b> <tt>used</tt>, <tt>section</tt>, <tt>alias</tt>,
381       <tt>visibility</tt>, <tt>regparm</tt>, <tt>stdcall</tt>,
382       <tt>fastcall</tt>, all other target specific attributes</li>
383    
384   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Attributes.html#Variable%20Attributes">Variable Attributes</a>:
385       Specifying attributes of variables.<br>
386       <b>Supported:</b> <tt>cleanup</tt>, <tt>common</tt>, <tt>nocommon</tt>,
387                         <tt>deprecated</tt>, <tt>transparent_union</tt>,
388                         <tt>unused</tt>, <tt>weak</tt><br>
389
390       <b>Unsupported:</b> <tt>aligned</tt>, <tt>mode</tt>, <tt>packed</tt>,
391                         <tt>section</tt>, <tt>shared</tt>, <tt>tls_model</tt>,
392                         <tt>vector_size</tt>, <tt>dllimport</tt>, 
393                         <tt>dllexport</tt>, all target specific attributes.</li>
394
395   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Type-Attributes.html#Type%20Attributes">Type Attributes</a>:   Specifying attributes of types.<br>
396       <b>Supported:</b> <tt>transparent_union</tt>, <tt>unused</tt>,
397                         <tt>deprecated</tt>, <tt>may_alias</tt><br>
398
399       <b>Unsupported:</b> <tt>aligned</tt>, <tt>packed</tt>, 
400                         all target specific attributes.</li>
401
402   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Other-Builtins.html#Other%20Builtins">Other Builtins</a>:
403       Other built-in functions.<br>
404       We support all builtins which have a C language equivalent (e.g., 
405          <tt>__builtin_cos</tt>),  <tt>__builtin_alloca</tt>, 
406          <tt>__builtin_types_compatible_p</tt>, <tt>__builtin_choose_expr</tt>,
407          <tt>__builtin_constant_p</tt>, and <tt>__builtin_expect</tt> (ignored).</li>
408
409   </ol>
410
411   <p>The following extensions <b>are</b> known to be supported:</p>
412
413   <ol>
414   <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>
415   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Statement-Exprs.html#Statement%20Exprs">Statement Exprs</a>:   Putting statements and declarations inside expressions.</li>
416   <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>
417   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Lvalues.html#Lvalues">Lvalues</a>: Using <code>?:</code>, "<code>,</code>" and casts in lvalues.</li>
418   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Conditionals.html#Conditionals">Conditionals</a>: Omitting the middle operand of a <code>?:</code> expression.</li>
419   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Long-Long.html#Long%20Long">Long Long</a>: Double-word integers.</li>
420   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Complex.html#Complex">Complex</a>:   Data types for complex numbers.</li>
421   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Hex-Floats.html#Hex%20Floats">Hex Floats</a>:Hexadecimal floating-point constants.</li>
422   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Zero-Length.html#Zero%20Length">Zero Length</a>: Zero-length arrays.</li>
423   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Empty-Structures.html#Empty%20Structures">Empty Structures</a>: Structures with no members.</li>
424   <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>
425   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Escaped-Newlines.html#Escaped%20Newlines">Escaped Newlines</a>:  Slightly looser rules for escaped newlines.</li>
426   <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>
427   <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>
428   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Initializers.html#Initializers">Initializers</a>: Non-constant initializers.</li>
429   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Compound-Literals.html#Compound%20Literals">Compound Literals</a>: Compound literals give structures, unions,
430 or arrays as values.</li>
431   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Designated-Inits.html#Designated%20Inits">Designated Inits</a>: Labeling elements of initializers.</li>
432   <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>
433   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Case-Ranges.html#Case%20Ranges">Case Ranges</a>: `case 1 ... 9' and such.</li>
434   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Mixed-Declarations.html#Mixed%20Declarations">Mixed Declarations</a>: Mixing declarations and code.</li>
435   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Prototypes.html#Function%20Prototypes">Function Prototypes</a>: Prototype declarations and old-style definitions.</li>
436   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/C---Comments.html#C++%20Comments">C++ Comments</a>: C++ comments are recognized.</li>
437   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Dollar-Signs.html#Dollar%20Signs">Dollar Signs</a>: Dollar sign is allowed in identifiers.</li>
438   <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>
439   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Alignment.html#Alignment">Alignment</a>: Inquiring about the alignment of a type or variable.</li>
440   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Inline.html#Inline">Inline</a>: Defining inline functions (as fast as macros).</li>
441   <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>
442   <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>
443   <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>
444   <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>
445   <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>
446   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Attribute-Syntax.html#Attribute%20Syntax">Attribute Syntax</a>: Formal syntax for attributes.</li>
447   </ol></li>
448
449 </ul>
450
451 <p>If you run into GCC extensions which have not been included in any of these
452 lists, please let us know (also including whether or not they work).</p>
453
454 </div>
455
456 <!-- ======================================================================= -->
457 <div class="doc_subsection">
458   <a name="c++-fe">Known problems with the C++ front-end</a>
459 </div>
460
461 <div class="doc_text">
462
463 <p>For this release, the C++ front-end is considered to be fully functional but
464 has not been tested as thoroughly as the C front-end.  It has been tested and 
465 works for a number of non-trivial programs, but there may be lurking bugs.
466 Please report any bugs or problems.</p>
467
468 </div>
469
470 <!-- _______________________________________________________________________ -->
471 <div class="doc_subsubsection">Bugs</div>
472
473 <div class="doc_text">
474
475 <ul>
476 <li>The C++ front-end inherits all problems afflicting the <a href="#c-fe">C
477     front-end</a>.</li>
478 </ul>
479 </div>
480
481 <!-- _______________________________________________________________________ -->
482 <div class="doc_subsubsection">
483   Notes
484 </div>
485
486 <div class="doc_text">
487
488 <ul>
489
490 <li>The C++ front-end is based on a pre-release of the GCC 3.4 C++ parser.  This
491 parser is significantly more standards compliant (and picky) than prior GCC
492 versions.  For more information, see the C++ section of the <a
493 href="http://gcc.gnu.org/gcc-3.4/changes.html">GCC 3.4 release notes</a>.</li>
494
495 <li>Destructors for local objects are not always run when a <tt>longjmp</tt> is
496     performed. In particular, destructors for objects in the <tt>longjmp</tt>ing
497     function and in the <tt>setjmp</tt> receiver function may not be run.
498     Objects in intervening stack frames will be destroyed, however (which is
499     better than most compilers).</li>
500
501 <li>The LLVM C++ front-end follows the <a
502     href="http://www.codesourcery.com/cxx-abi">Itanium C++ ABI</a>.
503     This document, which is not Itanium specific, specifies a standard for name
504     mangling, class layout, v-table layout, RTTI formats, and other C++
505     representation issues.  Because we use this API, code generated by the LLVM
506     compilers should be binary compatible with machine code generated by other
507     Itanium ABI C++ compilers (such as G++, the Intel and HP compilers, etc).
508     <i>However</i>, the exception handling mechanism used by LLVM is very
509     different from the model used in the Itanium ABI, so <b>exceptions will not
510     interact correctly</b>. </li>
511
512 </ul>
513
514 </div>
515
516 <!-- ======================================================================= -->
517 <div class="doc_subsection">
518   <a name="x86-be">Known problems with the X86 back-end</a>
519 </div>
520
521 <div class="doc_text">
522
523 <ul>
524 <li>None so far.
525 </ul>
526
527 </div>
528
529 <!-- ======================================================================= -->
530 <div class="doc_subsection">
531   <a name="sparc-be">Known problems with the Sparc back-end</a>
532 </div>
533
534 <div class="doc_text">
535
536 <ul>
537 <li>There are several programs in the LLVM testsuite that the Sparc code generator is known to miscompile.</li>
538 </ul>
539
540 </div>
541
542 <!-- ======================================================================= -->
543 <div class="doc_subsection">
544   <a name="c-be">Known problems with the C back-end</a>
545 </div>
546
547 <div class="doc_text">
548
549 <ul>
550
551 <li>The C back-end produces code that violates the ANSI C Type-Based Alias
552 Analysis rules.  As such, special options may be necessary to compile the code
553 (for example, GCC requires the <tt>-fno-strict-aliasing</tt> option).  This
554 problem probably cannot be fixed.</li>
555
556 <li><a href="http://llvm.cs.uiuc.edu/PR33">Initializers for global variables</a>
557 cannot include special floating point numbers like Not-A-Number or
558 Infinity.</li>
559
560 <li><a href="http://llvm.cs.uiuc.edu/PR56">Zero arg vararg functions are not 
561 supported</a>.  This should not affect LLVM produced by the C or C++ 
562 frontends.</li>
563
564 </ul>
565
566 </div>
567
568 <!-- *********************************************************************** -->
569 <div class="doc_section">
570   <a name="additionalinfo">Additional Information</a>
571 </div>
572 <!-- *********************************************************************** -->
573
574 <div class="doc_text">
575
576 <p>A wide variety of additional information is available on the LLVM web page,
577 including mailing lists and publications describing algorithms and components
578 implemented in LLVM.  The web page also contains versions of the API
579 documentation which is up-to-date with the CVS version of the source code.  You
580 can access versions of these documents specific to this release by going into
581 the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
582
583 <p>If you have any questions or comments about LLVM, please feel free to contact
584 us via the <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">mailing
585 lists</a>.</p>
586
587 </div>
588
589 <!-- *********************************************************************** -->
590
591 <hr>
592 <address>
593   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
594   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
595   <a href="http://validator.w3.org/check/referer"><img
596   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
597
598   <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br>
599   Last modified: $Date$
600 </address>
601
602 </body>
603 </html>