Clarify situation w.r.t the -lowerinvoke pass.
[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.2 Release Notes</title>
7 </head>
8 <body>
9
10 <div class="doc_title">
11   LLVM 1.2 Release Notes
12 </div>
13  
14 <ol>
15   <li><a href="#intro">Introduction</a></li>
16   <li><a href="#whatsnew">What's New?</a></li>
17   <li><a href="#portability">Portability and Supported Platforms</a></li>
18   <li><a href="#install-instructions">Installation Instructions</a></li>
19   <li><a href="#knownproblems">Known Problems</a>
20   <ul>
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.2.  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.2/">LLVM 1.2 web site</a>.  If you are
48 not reading this on the LLVM web pages, you should probably go there because
49 this document may be updated after the release.</p>
50
51 <p>For more information about LLVM, including information about potentially more
52 current releases, please check out the <a href="http://llvm.cs.uiuc.edu">main
53 web site</a>.  If you have questions or comments, the <a
54 href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM developer's mailing
55 list</a> is a good place to send them.</p>
56
57 <p>Note that if you are reading this file from CVS, this document applies
58 to the <i>next</i> release, not the current one.  To see the release notes for
59 the current or previous releases, see the <a
60 href="http://llvm.cs.uiuc.edu/releases/">releases page</a>.</p>
61
62 </div>
63
64 <!-- *********************************************************************** -->
65 <div class="doc_section">
66   <a name="whatsnew">What's New?</a>
67 </div>
68 <!-- *********************************************************************** -->
69
70 <div class="doc_text">
71
72 <p>This is the third public release of the LLVM compiler infrastructure.
73 </p>
74
75 <p>At this time, LLVM is known to correctly compile and run all non-unwinding C
76 &amp; C++ SPEC CPU2000 benchmarks, the Olden benchmarks, and the Ptrdist
77 benchmarks.  It has also been used to compile <b>many</b> other programs.  LLVM
78 now also works with a broad variety of C++ programs, though it has still
79 received much less testing than the C front-end.
80 </p>
81
82 <p>
83 The LLVM native code generators are very stable but do not currently support
84 unwinding (exception throwing or <tt>longjmp</tt>ing), which prevent them from
85 working with programs like the <tt>253.perlbmk</tt> in SPEC CPU2000.  The C
86 backend and the rest of LLVM supports these programs, so you can
87 still use LLVM with them.  Support for unwinding will be added in a future
88 release.
89 </p>
90
91
92 <!--=========================================================================-->
93 <div class="doc_subsubsection">
94 This release implements the following new features:
95 </div>
96
97 <ol>
98 <li></li>
99 <li></li>
100 </ol>
101
102
103 <!--=========================================================================-->
104 <div class="doc_subsubsection">
105 In this release, the following missing features were implemented:
106 </div>
107
108 <ol>
109 <li></li>
110 <li></li>
111 </ol>
112
113
114 <!--=========================================================================-->
115 <div class="doc_subsubsection">
116 In this release, the following Quality of Implementation issues were fixed:
117 </div>
118
119 <ol>
120
121 <li><a href="http://llvm.cs.uiuc.edu/PR135">JIT should lazily initialize global variables</a></li>
122 <li><a href="http://llvm.cs.uiuc.edu/PR192">[X86] X86 Backend never releases memory for machine code structures</a></li>
123 <li><a href="http://llvm.cs.uiuc.edu/PR196">[vmcore] OpaqueType objects memory leak</a></li>
124 <li><a href="http://llvm.cs.uiuc.edu/PR182">[llvmgcc] C front-end does not compile "extern inline" into linkonce</a></li>
125 <li><a href="http://llvm.cs.uiuc.edu/PR73">Bytecode format inconsistent</a></li>
126 </ol>
127
128 <!--=========================================================================-->
129 <div class="doc_subsubsection">
130 In this release, the following build problems were fixed:
131 </div>
132
133 <ol>
134 <li><a href="http://llvm.cs.uiuc.edu/PR210">[build] Makefiles break if C frontend target string has unexpected value</a></li>
135 </ol>
136
137 <!--=========================================================================-->
138 <div class="doc_subsubsection">
139 In this release, the following Code Quality issues were fixed:
140 </div>
141
142 <ol>
143 <li><a href="http://llvm.cs.uiuc.edu/PR187">[loopsimplify] Many pointless phi nodes are created</a></li>
144 </ol>
145
146
147 <!--=========================================================================-->
148 <div class="doc_subsubsection">
149 In this release, the following bugs in the previous release were fixed:
150 </div>
151
152 <p>Bugs in the LLVM Core:</p>
153
154 <ol>
155 <li><a href="http://llvm.cs.uiuc.edu/PR179">[licm] LICM promotes volatile memory
156 locations to registers</a></li>
157 <li><a href="http://llvm.cs.uiuc.edu/PR191">[licm] Memory read after free causes 
158 infrequent crash</a></li>
159 <li><a href="http://llvm.cs.uiuc.edu/PR194">[indvars] Induction variable 
160 canonicalization always makes 32-bit indvars</a></li>
161 <li><a href="http://llvm.cs.uiuc.edu/PR193">[constantmerge] Merging globals can
162 cause use of invalid pointers!</a></li>
163
164 </ol>
165
166
167 <p>Bugs in the C/C++ front-end:</p>
168
169 <ol>
170 <li><a href="http://llvm.cs.uiuc.edu/PR186">Need weak linkage on memory
171 management functions in libc runtime to allow them to be overriden</a></li>
172 <li><a href="http://llvm.cs.uiuc.edu/PR202">[llvm-gcc] asserts when an extern inline function is redefined</a></li>
173 <li><a href="http://llvm.cs.uiuc.edu/PR204">[llvmg++] Dynamically initialized constants cannot be marked 'constant'</a></li>
174 </ol>
175
176 </div>
177
178 <!-- *********************************************************************** -->
179 <div class="doc_section">
180   <a name="portability">Portability and Supported Platforms</a>
181 </div>
182 <!-- *********************************************************************** -->
183
184 <div class="doc_text">
185
186 <p>LLVM has been extensively tested on Intel and AMD machines running Red
187 Hat Linux and FreeBSD.  It has also been tested on Sun UltraSPARC workstations running Solaris 8.
188 Additionally, 
189 LLVM works on Mac OS X 10.3 and above, but only with the C backend or 
190 interpreter (no native backend for the PowerPC is available yet).
191 The core LLVM infrastructure uses "autoconf" for portability, so hopefully we
192 work on more platforms than that.  However, it is likely that we
193 missed something and that minor porting is required to get LLVM to work on 
194 new platforms.  We welcome portability patches and error messages.</p>
195
196 </div>
197
198 <!-- *********************************************************************** -->
199 <div class="doc_section">
200   <a name="knownproblems">Known Problems</a>
201 </div>
202 <!-- *********************************************************************** -->
203
204 <div class="doc_text">
205
206 <p>This section contains all known problems with the LLVM system, listed by
207 component.  As new problems are discovered, they will be added to these
208 sections.  If you run into a problem, please check the <a
209 href="http://llvm.cs.uiuc.edu/bugs/">LLVM bug database</a> and submit a bug if
210 there isn't already one.</p>
211
212 </div>
213
214 <!-- _______________________________________________________________________ -->
215 <!--
216 </ul><h4><a name="portability"><hr size=0>Portability Problems</h4><ul>
217 -->
218
219
220 <!-- ======================================================================= -->
221 <div class="doc_subsection">
222   <a name="core">Known problems with the LLVM Core</a>
223 </div>
224
225 <div class="doc_text">
226
227 <ul>
228
229 <li>In the JIT, <tt>dlsym</tt> on a symbol compiled by the JIT will not
230 work.</li>
231
232 <li>The JIT does not use mutexes to protect its internal data structures.  As
233 such, execution of a threaded program could cause these data structures to be
234 corrupted.</li>
235
236 <li>It is not possible to <tt>dlopen</tt> an LLVM bytecode file in the JIT.</li>
237
238 <li>Linking in static archive files (.a files) is very slow (there is no symbol
239 table in the archive).</li>
240
241 <li><a href="http://llvm.cs.uiuc.edu/PR82">LLVM cannot handle structures with
242 more than 256 elements</a>.</li>
243
244 <li>
245 The gccld program 
246 <a href="http://llvm.cs.uiuc.edu/bugs/show_bug.cgi?id=139">
247 does not link objects/archives in the order specified on the command line.
248 </a>
249 </li>
250
251 <li>
252 <a href="http://llvm.cs.uiuc.edu/bugs/show_bug.cgi?id=174">
253 Tail duplication does not update SSA form correctly.
254 </a>
255 </li>
256
257 <li><a href="http://llvm.cs.uiuc.edu/PR16">[lowerinvoke] The -lowerinvoke pass
258 does not insert calls to setjmp/longjmp</a>.</li>
259
260 </ul>
261
262 </div>
263
264 <!-- ======================================================================= -->
265 <div class="doc_subsection">
266   <a name="c-fe">Known problems with the C front-end</a>
267 </div>
268
269 <!-- _______________________________________________________________________ -->
270 <div class="doc_subsubsection">Bugs</div>
271
272 <div class="doc_text">
273 <ul>
274 <li>C99 Variable sized arrays do not release stack memory when they go out of 
275     scope.  Thus, the following program may run out of stack space:
276 <pre>
277     for (i = 0; i != 1000000; ++i) {
278       int X[n];
279       foo(X);
280     }
281 </pre></li>
282
283 <li>
284 Initialization of global union variables can only be done
285 <a href="http://llvm.cs.uiuc.edu/bugs/show_bug.cgi?id=162">with the largest
286 union member</a>.
287 </li>
288
289 <li>
290 <a href="http://llvm.cs.uiuc.edu/bugs/show_bug.cgi?id=182">
291 Functions marked "extern inline" are not compiled into LLVM with linkonce
292 linkage.
293 </a>
294 </li>
295
296
297 <li>
298 The memory management functions in the libc runtime
299 <a href="http://llvm.cs.uiuc.edu/PR186">need weak linkage so that they can be
300 overridden.
301 </a>
302 </li>
303 </ul>
304 </div>
305
306 <!-- _______________________________________________________________________ -->
307 <div class="doc_subsubsection">
308   Notes
309 </div>
310
311 <div class="doc_text">
312
313 <ul>
314
315 <li>Inline assembly is not yet supported.</li>
316
317 <li>"long double" is transformed by the front-end into "double".  There is no
318 support for floating point data types of any size other than 32 and 64
319 bits.</li>
320     
321 <li>The following Unix system functionality has not been tested and may not
322 work:
323   <ol>
324   <li><tt>sigsetjmp</tt>, <tt>siglongjmp</tt> - These are not turned into the
325       appropriate <tt>invoke</tt>/<tt>unwind</tt> instructions.  Note that
326       <tt>setjmp</tt> and <tt>longjmp</tt> <em>are</em> compiled correctly.
327   <li><tt>getcontext</tt>, <tt>setcontext</tt>, <tt>makecontext</tt>
328       - These functions have not been tested.
329   </ol></li>
330
331 <li>Although many GCC extensions are supported, some are not.  In particular,
332     the following extensions are known to <b>not be</b> supported:
333   <ol>
334   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Local-Labels.html#Local%20Labels">Local Labels</a>: Labels local to a block.</li>
335   <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>
336   <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>
337   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Constructing-Calls.html#Constructing%20Calls">Constructing Calls</a>: Dispatching a call to another function.</li>
338   <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>
339   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Constraints.html#Constraints">Constraints</a>: Constraints for asm operands.</li>
340   <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>
341   <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>
342   <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>
343   <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>
344   <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>
345   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Thread-Local.html#Thread-Local">Thread-Local</a>: Per-thread variables.</li>
346   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Pragmas.html#Pragmas">Pragmas</a>: Pragmas accepted by GCC.</li>
347   </ol>
348
349   <p>The following GCC extensions are <b>partially</b> supported.  An ignored
350   attribute means that the LLVM compiler ignores the presence of the attribute,
351   but the code should still work.  An unsupported attribute is one which is
352   ignored by the LLVM compiler and will cause a different interpretation of
353   the program.</p>
354
355   <ol>
356   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Length.html#Variable%20Length">Variable Length</a>:
357       Arrays whose length is computed at run time.<br>
358       Supported, but allocated stack space is not freed until the function returns (noted above).</li>
359
360   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Attributes.html#Function%20Attributes">Function Attributes</a>:
361
362       Declaring that functions have no side effects or that they can never
363       return.<br>
364
365       <b>Supported:</b> <tt>format</tt>, <tt>format_arg</tt>, <tt>non_null</tt>,
366       <tt>constructor</tt>, <tt>destructor</tt>, <tt>unused</tt>,
367       <tt>deprecated</tt>, <tt>warn_unused_result</tt>, <tt>weak</tt><br>
368
369       <b>Ignored:</b> <tt>noreturn</tt>, <tt>noinline</tt>,
370       <tt>always_inline</tt>, <tt>pure</tt>, <tt>const</tt>, <tt>nothrow</tt>,
371       <tt>malloc</tt>, <tt>no_instrument_function</tt>, <tt>cdecl</tt><br>
372
373       <b>Unsupported:</b> <tt>used</tt>, <tt>section</tt>, <tt>alias</tt>,
374       <tt>visibility</tt>, <tt>regparm</tt>, <tt>stdcall</tt>,
375       <tt>fastcall</tt>, all other target specific attributes</li>
376    
377   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Attributes.html#Variable%20Attributes">Variable Attributes</a>:
378       Specifying attributes of variables.<br>
379       <b>Supported:</b> <tt>cleanup</tt>, <tt>common</tt>, <tt>nocommon</tt>,
380                         <tt>deprecated</tt>, <tt>transparent_union</tt>,
381                         <tt>unused</tt>, <tt>weak</tt><br>
382
383       <b>Unsupported:</b> <tt>aligned</tt>, <tt>mode</tt>, <tt>packed</tt>,
384                         <tt>section</tt>, <tt>shared</tt>, <tt>tls_model</tt>,
385                         <tt>vector_size</tt>, <tt>dllimport</tt>, 
386                         <tt>dllexport</tt>, all target specific attributes.</li>
387
388   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Type-Attributes.html#Type%20Attributes">Type Attributes</a>:   Specifying attributes of types.<br>
389       <b>Supported:</b> <tt>transparent_union</tt>, <tt>unused</tt>,
390                         <tt>deprecated</tt>, <tt>may_alias</tt><br>
391
392       <b>Unsupported:</b> <tt>aligned</tt>, <tt>packed</tt>, 
393                         all target specific attributes.</li>
394
395   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Other-Builtins.html#Other%20Builtins">Other Builtins</a>:
396       Other built-in functions.<br>
397       We support all builtins which have a C language equivalent (e.g., 
398          <tt>__builtin_cos</tt>),  <tt>__builtin_alloca</tt>, 
399          <tt>__builtin_types_compatible_p</tt>, <tt>__builtin_choose_expr</tt>,
400          <tt>__builtin_constant_p</tt>, and <tt>__builtin_expect</tt> (ignored).</li>
401
402   </ol>
403
404   <p>The following extensions <b>are</b> known to be supported:</p>
405
406   <ol>
407   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Statement-Exprs.html#Statement%20Exprs">Statement Exprs</a>:   Putting statements and declarations inside expressions.</li>
408   <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>
409   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Lvalues.html#Lvalues">Lvalues</a>: Using <code>?:</code>, "<code>,</code>" and casts in lvalues.</li>
410   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Conditionals.html#Conditionals">Conditionals</a>: Omitting the middle operand of a <code>?:</code> expression.</li>
411   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Long-Long.html#Long%20Long">Long Long</a>: Double-word integers.</li>
412   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Complex.html#Complex">Complex</a>:   Data types for complex numbers.</li>
413   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Hex-Floats.html#Hex%20Floats">Hex Floats</a>:Hexadecimal floating-point constants.</li>
414   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Zero-Length.html#Zero%20Length">Zero Length</a>: Zero-length arrays.</li>
415   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Empty-Structures.html#Empty%20Structures">Empty Structures</a>: Structures with no members.</li>
416   <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>
417   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Escaped-Newlines.html#Escaped%20Newlines">Escaped Newlines</a>:  Slightly looser rules for escaped newlines.</li>
418   <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>
419   <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>
420   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Initializers.html#Initializers">Initializers</a>: Non-constant initializers.</li>
421   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Compound-Literals.html#Compound%20Literals">Compound Literals</a>: Compound literals give structures, unions,
422 or arrays as values.</li>
423   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Designated-Inits.html#Designated%20Inits">Designated Inits</a>: Labeling elements of initializers.</li>
424   <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>
425   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Case-Ranges.html#Case%20Ranges">Case Ranges</a>: `case 1 ... 9' and such.</li>
426   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Mixed-Declarations.html#Mixed%20Declarations">Mixed Declarations</a>: Mixing declarations and code.</li>
427   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Prototypes.html#Function%20Prototypes">Function Prototypes</a>: Prototype declarations and old-style definitions.</li>
428   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/C---Comments.html#C++%20Comments">C++ Comments</a>: C++ comments are recognized.</li>
429   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Dollar-Signs.html#Dollar%20Signs">Dollar Signs</a>: Dollar sign is allowed in identifiers.</li>
430   <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>
431   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Alignment.html#Alignment">Alignment</a>: Inquiring about the alignment of a type or variable.</li>
432   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Inline.html#Inline">Inline</a>: Defining inline functions (as fast as macros).</li>
433   <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>
434   <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>
435   <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>
436   <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>
437   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Attribute-Syntax.html#Attribute%20Syntax">Attribute Syntax</a>: Formal syntax for attributes.</li>
438   </ol></li>
439
440 </ul>
441
442 <p>If you run into GCC extensions which have not been included in any of these
443 lists, please let us know (also including whether or not they work).</p>
444
445 </div>
446
447 <!-- ======================================================================= -->
448 <div class="doc_subsection">
449   <a name="c++-fe">Known problems with the C++ front-end</a>
450 </div>
451
452 <div class="doc_text">
453
454 <p>For this release, the C++ front-end is considered to be fully functional but
455 has not been tested as thoroughly as the C front-end.  It has been tested and 
456 works for a number of non-trivial programs, but there may be lurking bugs.
457 Please report any bugs or problems.</p>
458
459 </div>
460
461 <!-- _______________________________________________________________________ -->
462 <div class="doc_subsubsection">
463   Bugs
464 </div>
465
466 <div class="doc_text">
467
468 <ul>
469 <li>The C++ front-end inherits all problems afflicting the <a href="#c-fe">C
470     front-end</a>.</li>
471
472 <li>
473 <a href="http://llvm.cs.uiuc.edu/bugs/show_bug.cgi?id=137">
474 Code is generated for empty classes.
475 </a>
476 </li>
477 </ul>
478 </div>
479
480 <!-- _______________________________________________________________________ -->
481 <div class="doc_subsubsection">
482   Notes
483 </div>
484
485 <div class="doc_text">
486
487 <ul>
488
489 <li>The C++ front-end is based on a pre-release of the GCC 3.4 C++ parser.  This
490 parser is significantly more standards compliant (and picky) than prior GCC
491 versions.  For more information, see the C++ section of the <a
492 href="http://gcc.gnu.org/gcc-3.4/changes.html">GCC 3.4 release notes</a>.</li>
493
494 <li>Destructors for local objects are not always run when a <tt>longjmp</tt> is
495     performed. In particular, destructors for objects in the <tt>longjmp</tt>ing
496     function and in the <tt>setjmp</tt> receiver function may not be run.
497     Objects in intervening stack frames will be destroyed, however (which is
498     better than most compilers).</li>
499
500 <li>The LLVM C++ front-end follows the <a
501     href="http://www.codesourcery.com/cxx-abi">Itanium C++ ABI</a>.
502     This document, which is not Itanium specific, specifies a standard for name
503     mangling, class layout, v-table layout, RTTI formats, and other C++
504     representation issues.  Because we use this API, code generated by the LLVM
505     compilers should be binary compatible with machine code generated by other
506     Itanium ABI C++ compilers (such as G++, the Intel and HP compilers, etc).
507     <i>However</i>, the exception handling mechanism used by LLVM is very
508     different from the model used in the Itanium ABI, so <b>exceptions will not
509     interact correctly</b>. </li>
510
511 </ul>
512
513 </div>
514
515 <!-- ======================================================================= -->
516 <div class="doc_subsection">
517   <a name="x86-be">Known problems with the X86 back-end</a>
518 </div>
519
520 <div class="doc_text">
521
522 <ul>
523
524 <li>The X86 code generator <a
525 href="http://llvm.cs.uiuc.edu/PR16">does not currently
526 support the <tt>unwind</tt> instruction</a>, so code that throws a C++ exception
527 or calls the C <tt>longjmp</tt> function will abort.</li>
528
529 </ul>
530
531 </div>
532
533 <!-- ======================================================================= -->
534 <div class="doc_subsection">
535   <a name="sparc-be">Known problems with the Sparc back-end</a>
536 </div>
537
538 <div class="doc_text">
539
540 <ul>
541
542 <li>The Sparc code generator <a
543 href="http://llvm.cs.uiuc.edu/PR16">does not currently
544 support the <tt>unwind</tt> instruction</a>, so code that throws a C++ exception
545 or calls the C <tt>longjmp</tt> function will abort.</li>
546
547 <li>
548 <a href="http://llvm.cs.uiuc.edu/bugs/show_bug.cgi?id=167">
549 The llc program can crash on legal code.
550 </a>
551 </li>
552 </ul>
553
554 </div>
555
556 <!-- ======================================================================= -->
557 <div class="doc_subsection">
558   <a name="c-be">Known problems with the C back-end</a>
559 </div>
560
561 <div class="doc_text">
562
563 <ul>
564
565 <li>The C back-end produces code that violates the ANSI C Type-Based Alias
566 Analysis rules.  As such, special options may be necessary to compile the code
567 (for example, GCC requires the <tt>-fno-strict-aliasing</tt> option).  This
568 problem probably cannot be fixed.</li>
569
570 <li><a href="http://llvm.cs.uiuc.edu/PR33">Initializers for global variables</a>
571 cannot include special floating point numbers like Not-A-Number or
572 Infinity.</li>
573
574 <li><a href="http://llvm.cs.uiuc.edu/PR56">Zero arg vararg functions are not 
575 supported</a>.  This should not affect LLVM produced by the C or C++ 
576 frontends.</li>
577
578 </ul>
579
580 </div>
581
582 <!-- *********************************************************************** -->
583 <div class="doc_section">
584   <a name="additionalinfo">Additional Information</a>
585 </div>
586 <!-- *********************************************************************** -->
587
588 <div class="doc_text">
589
590 <p>A wide variety of additional information is available on the LLVM web page,
591 including mailing lists and publications describing algorithms and components
592 implemented in LLVM.  The web page also contains versions of the API
593 documentation which is up-to-date with the CVS version of the source code.  You
594 can access versions of these documents specific to this release by going into
595 the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
596
597 <p>If you have any questions or comments about LLVM, please feel free to contact
598 us via the <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">mailing
599 lists</a>.</p>
600
601 </div>
602
603 <!-- *********************************************************************** -->
604
605 <hr>
606 <address>
607   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
608   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
609   <a href="http://validator.w3.org/check/referer"><img
610   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
611
612   <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br>
613   Last modified: $Date$
614 </address>
615
616 </body>
617 </html>