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