Partial update for Release 1.9
[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.9 Release Notes</title>
8 </head>
9 <body>
10
11 <div class="doc_title">LLVM 1.9 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.org">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.9.  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 (corresponding to LLVM CVS) can be found
38 on the <a
39 href="http://llvm.org/releases/">LLVM releases web site</a>.  If you are
40 not reading this on the LLVM web pages, you should probably go there because
41 this document may be updated after the release.</p>
42
43 <p>For more information about LLVM, including information about the latest
44 release, please check out the <a href="http://llvm.org/">main LLVM
45 web site</a>.  If you have questions or comments, the <a
46 href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM developer's mailing
47 list</a> is a good place to send them.</p>
48
49 <p>Note that if you are reading this file from CVS or the main LLVM web page,
50 this document applies to the <i>next</i> release, not the current one.  To see
51 the release notes for the current or previous releases, see the <a
52 href="http://llvm.org/releases/">releases page</a>.</p>
53
54 </div>
55
56 <!-- *********************************************************************** -->
57 <div class="doc_section">
58   <a name="whatsnew">What's New?</a>
59 </div>
60 <!-- *********************************************************************** -->
61
62 <div class="doc_text">
63
64 <p>This is the tenth public release of the LLVM Compiler Infrastructure. This
65 release incorporates a large number of enhancements and new features.
66 </p>
67
68 </div>
69
70 <!--=========================================================================-->
71 <div class="doc_subsection">
72 <a name="newfeatures">New Features in LLVM 1.9</a>
73 </div>
74
75 <!--_________________________________________________________________________-->
76 <div class="doc_subsubsection"><a name="elfdwarf">DWARF debugging 
77 support for X86/ELF</a></div>
78 <div class="doc_text">
79 <p>The llvm-gcc4 C front-end now generates debugging info for C and C++ for
80 X86/ELF platforms (Linux).  This extends the PPC/Darwin and X86/Darwin debugging
81 support available in release 18.8 DWARF is a standard debugging format used on 
82 many platforms.</p>
83 </div>
84
85 <!--_________________________________________________________________________-->
86 <div class="doc_subsubsection"><a name="signedinst">Signed Instructions</a></div>
87 <div class="doc_text">
88 <p>As a step towards making LLVM's integer types signless, several new
89 instructions have been added to LLVM. The DIV instruction has become UDIV, SDIV,
90 and FDIV.  The REM instruction has become UREM, SREM and FREM. The SHR
91 instruction has become ASHR and LSHR. See the <a href="LangRef.html">Language
92   Reference</a> for details on these new instructions.</p>
93 </div>
94
95 <!--_________________________________________________________________________-->
96 <div class="doc_subsubsection"><a name="featureA">New Feature C</a></div>
97 <div class="doc_text">
98 <p>Describe feature C here.</p>
99 </div>
100
101 <!--_________________________________________________________________________-->
102 <div class="doc_subsubsection"><a name="featureB">New Feature D</a></div>
103 <div class="doc_text">
104 <p>Describe feature D here.</p>
105 </div>
106
107 <!--_________________________________________________________________________-->
108 <div class="doc_subsubsection"><a name="jitrelease">New Feature E</a></div>
109 <div class="doc_text">
110 <p>Describe feature E here.</p>
111 </div>
112
113 <!--_________________________________________________________________________-->
114 <div class="doc_subsubsection"><a name="other">Other Improvements</a></div>
115 <div class="doc_text">
116 <p>This release includes many other improvements, including improvements to
117    the optimizers and code generators (improving the generated code) changes to
118    speed up the compiler in many ways (improving algorithms and fine tuning 
119    code), and changes to reduce the code size of the compiler itself.</p>
120
121 <p>More specific changes include:</p>
122
123 <ul>
124 <li>LLVM 1.8 includes an initial ARM backend.  This backend is in early 
125     development stages.</li>
126 <li>LLVM 1.8 now includes significantly better support for mingw and 
127     cygwin.</li>
128 <li>The <a href="CommandGuide/html/llvm-config.html">llvm-config</a> tool is 
129     now built by default and has several new features.</li>
130 <li>The X86 and PPC backends now use the correct platform ABI for passing 
131     vectors as arguments to functions.</li>
132 <li>The X86 backend now includes support for the Microsoft ML assembler 
133     ("MASM").</li>
134 <li>The PowerPC backend now pattern matches the 'rlwimi' instruction more 
135     aggressively.</li>
136 <li>Most of LLVM is now built with "-pedantic", ensuring better portability 
137     to more C++ Compilers.</li>
138 <li>The PowerPC backend now includes initial 64-bit support.  The JIT is not
139     complete, and the static compiler has a couple of known bugs, but support
140     is mostly in place. LLVM 1.9 will include completed PPC-64 support. </li>
141
142 </ul>
143 </div>
144
145 <!--=========================================================================-->
146 <div class="doc_subsection">
147 <a name="changes">Significant Changes in LLVM 1.8</a>
148 </div>
149
150 <div class="doc_text">
151 <ul>
152 <li>The LLVM "SparcV9" backend (deprecated in LLVM 1.7) has been removed in 
153 LLVM 1.8.  The LLVM "Sparc" backend replaces it.</li>
154 <li>The --version option now prints more useful information, including the
155     build configuration for the tool.</li>
156 </ul>
157 </div>
158
159
160 <!-- *********************************************************************** -->
161 <div class="doc_section">
162   <a name="portability">Portability and Supported Platforms</a>
163 </div>
164 <!-- *********************************************************************** -->
165
166 <div class="doc_text">
167
168 <p>LLVM is known to work on the following platforms:</p>
169
170 <ul>
171   <li>Intel and AMD machines running Red Hat Linux, Fedora Core and FreeBSD 
172       (and probably other unix-like systems).</li>
173 <li>Intel and AMD machines running on Win32 using MinGW libraries (native)</li>
174 <li>Sun UltraSPARC workstations running Solaris 8.</li>
175 <li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
176     support is available for native builds with Visual C++).</li>
177 <li>PowerPC and X86-based Mac OS X systems, running 10.2 and above.</li>
178 <li>Alpha-based machines running Debian GNU/Linux.</li>
179 <li>Itanium-based machines running Linux and HP-UX.</li>
180 </ul>
181
182 <p>The core LLVM infrastructure uses
183 <a href="http://www.gnu.org/software/autoconf/">GNU autoconf</a> to adapt itself
184 to the machine and operating system on which it is built.  However, minor
185 porting may be required to get LLVM to work on new platforms.  We welcome your
186 portability patches and reports of successful builds or error messages.</p>
187
188 </div>
189
190 <!-- *********************************************************************** -->
191 <div class="doc_section">
192   <a name="knownproblems">Known Problems</a>
193 </div>
194 <!-- *********************************************************************** -->
195
196 <div class="doc_text">
197
198 <p>This section contains all known problems with the LLVM system, listed by
199 component.  As new problems are discovered, they will be added to these
200 sections.  If you run into a problem, please check the <a
201 href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
202 there isn't already one.</p>
203
204 </div>
205
206 <!-- ======================================================================= -->
207 <div class="doc_subsection">
208   <a name="experimental">Experimental features included with this release</a>
209 </div>
210
211 <div class="doc_text">
212
213 <p>The following components of this LLVM release are either untested, known to
214 be broken or unreliable, or are in early development.  These components should
215 not be relied on, and bugs should not be filed against them, but they may be
216 useful to some people.  In particular, if you would like to work on one of these
217 components, please contact us on the <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p>
218
219 <ul>
220 <li>The <tt>-cee</tt> pass is known to be buggy, and may be removed in in a 
221     future release.</li>
222 <li>The IA64 code generator is experimental.</li>
223 <li>The Alpha JIT is experimental.</li>
224 <li>"<tt>-filetype=asm</tt>" (the default) is the only supported value for the 
225     <tt>-filetype</tt> llc option.</li>
226 </ul>
227
228 </div>
229
230 <!-- ======================================================================= -->
231 <div class="doc_subsection">
232   <a name="build">Known problems with the Build System</a>
233 </div>
234
235 <div class="doc_text">
236
237 <ul>
238 <li>none yet</li>
239 </ul>
240 </div>
241
242
243 <!-- ======================================================================= -->
244 <div class="doc_subsection">
245   <a name="core">Known problems with the LLVM Core</a>
246 </div>
247
248 <div class="doc_text">
249
250 <ul>
251   <li>In the JIT, <tt>dlsym()</tt> on a symbol compiled by the JIT will not
252   work.</li>
253 </ul>
254 </div>
255
256 <!-- ======================================================================= -->
257 <div class="doc_subsection">
258   <a name="c-fe">Known problems with the C front-end</a>
259 </div>
260
261 <!-- _______________________________________________________________________ -->
262 <div class="doc_subsubsection">Bugs</div>
263
264 <div class="doc_text">
265
266 <p>
267 llvm-gcc3 has many significant problems that are fixed by llvm-gcc4.
268 Two major ones include:</p>
269
270 <ul>
271 <li>With llvm-gcc3, 
272     C99 variable sized arrays do not release stack memory when they go out of 
273     scope.  Thus, the following program may run out of stack space:
274 <pre>
275     for (i = 0; i != 1000000; ++i) {
276       int X[n];
277       foo(X);
278     }
279 </pre></li>
280
281 <li>With llvm-gcc3, Initialization of global union variables can only be done <a
282 href="http://llvm.org/PR162">with the largest union member</a>.</li>
283
284 </ul>
285
286 <p>llvm-gcc4 is far more stable and produces better code than llvm-gcc3, but
287 does not currently support Link-Time-Optimization or C++ Exception Handling,
288 which llvm-gcc3 does.</p>
289
290 </div>
291
292 <!-- _______________________________________________________________________ -->
293 <div class="doc_subsubsection">
294   Notes
295 </div>
296
297 <div class="doc_text">
298
299 <ul>
300
301 <li>"long double" is transformed by the front-end into "double".  There is no
302 support for floating point data types of any size other than 32 and 64
303 bits.</li>
304     
305 <li>The following Unix system functionality has not been tested and may not
306 work:
307   <ol>
308   <li><tt>sigsetjmp</tt>, <tt>siglongjmp</tt> - These are not turned into the
309       appropriate <tt>invoke</tt>/<tt>unwind</tt> instructions.  Note that
310       <tt>setjmp</tt> and <tt>longjmp</tt> <em>are</em> compiled correctly.
311   <li><tt>getcontext</tt>, <tt>setcontext</tt>, <tt>makecontext</tt>
312       - These functions have not been tested.
313   </ol></li>
314
315 <li>Although many GCC extensions are supported, some are not.  In particular,
316     the following extensions are known to <b>not be</b> supported:
317   <ol>
318   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Local-Labels.html#Local%20Labels">Local Labels</a>: Labels local to a block.</li>
319   <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>
320   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Constructing-Calls.html#Constructing%20Calls">Constructing Calls</a>: Dispatching a call to another function.</li>
321   <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>
322   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Constraints.html#Constraints">Constraints</a>: Constraints for asm operands.</li>
323   <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>
324   <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>
325   <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>
326   <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>
327   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Thread_002dLocal.html">Thread-Local</a>: Per-thread variables.</li>
328   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Pragmas.html#Pragmas">Pragmas</a>: Pragmas accepted by GCC.</li>
329   </ol>
330
331   <p>The following GCC extensions are <b>partially</b> supported.  An ignored
332   attribute means that the LLVM compiler ignores the presence of the attribute,
333   but the code should still work.  An unsupported attribute is one which is
334   ignored by the LLVM compiler and will cause a different interpretation of
335   the program.</p>
336
337   <ol>
338   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Length.html#Variable%20Length">Variable Length</a>:
339       Arrays whose length is computed at run time.<br>
340       Supported, but allocated stack space is not freed until the function returns (noted above).</li>
341
342   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Attributes.html#Function%20Attributes">Function Attributes</a>:
343
344       Declaring that functions have no side effects or that they can never
345       return.<br>
346
347       <b>Supported:</b> <tt>format</tt>, <tt>format_arg</tt>, <tt>non_null</tt>,
348       <tt>noreturn</tt>, <tt>constructor</tt>, <tt>destructor</tt>,
349       <tt>unused</tt>, <tt>used</tt>,
350       <tt>deprecated</tt>, <tt>warn_unused_result</tt>, <tt>weak</tt><br>
351
352       <b>Ignored:</b> <tt>noinline</tt>,
353       <tt>always_inline</tt>, <tt>pure</tt>, <tt>const</tt>, <tt>nothrow</tt>,
354       <tt>malloc</tt>, <tt>no_instrument_function</tt>, <tt>cdecl</tt><br>
355
356       <b>Unsupported:</b> <tt>section</tt>, <tt>alias</tt>,
357       <tt>visibility</tt>, <tt>regparm</tt>, <tt>stdcall</tt>,
358       <tt>fastcall</tt>, all other target specific attributes</li>
359    
360   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Attributes.html#Variable%20Attributes">Variable Attributes</a>:
361       Specifying attributes of variables.<br>
362       <b>Supported:</b> <tt>cleanup</tt>, <tt>common</tt>, <tt>nocommon</tt>,
363                         <tt>deprecated</tt>, <tt>transparent_union</tt>,
364                         <tt>unused</tt>, <tt>used</tt>, <tt>weak</tt><br>
365
366       <b>Unsupported:</b> <tt>aligned</tt>, <tt>mode</tt>, <tt>packed</tt>,
367                         <tt>section</tt>, <tt>shared</tt>, <tt>tls_model</tt>,
368                         <tt>vector_size</tt>, <tt>dllimport</tt>, 
369                         <tt>dllexport</tt>, all target specific attributes.</li>
370
371   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Type-Attributes.html#Type%20Attributes">Type Attributes</a>:   Specifying attributes of types.<br>
372       <b>Supported:</b> <tt>transparent_union</tt>, <tt>unused</tt>,
373                         <tt>deprecated</tt>, <tt>may_alias</tt><br>
374
375       <b>Unsupported:</b> <tt>aligned</tt>, <tt>packed</tt>, 
376                         all target specific attributes.</li>
377
378   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Other-Builtins.html#Other%20Builtins">Other Builtins</a>:
379       Other built-in functions.<br>
380       We support all builtins which have a C language equivalent (e.g., 
381          <tt>__builtin_cos</tt>),  <tt>__builtin_alloca</tt>, 
382          <tt>__builtin_types_compatible_p</tt>, <tt>__builtin_choose_expr</tt>,
383          <tt>__builtin_constant_p</tt>, and <tt>__builtin_expect</tt>
384          (currently ignored).  We also support builtins for ISO C99 floating
385          point comparison macros (e.g., <tt>__builtin_islessequal</tt>), 
386          <tt>__builtin_prefetch</tt>, <tt>__builtin_popcount[ll]</tt>,
387          <tt>__builtin_clz[ll]</tt>, and <tt>__builtin_ctz[ll]</tt>.</li>
388   </ol>
389
390   <p>The following extensions <b>are</b> known to be supported:</p>
391
392   <ol>
393   <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>
394   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Statement-Exprs.html#Statement%20Exprs">Statement Exprs</a>:   Putting statements and declarations inside expressions.</li>
395   <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>
396   <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>
397   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Conditionals.html#Conditionals">Conditionals</a>: Omitting the middle operand of a <code>?:</code> expression.</li>
398   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Long-Long.html#Long%20Long">Long Long</a>: Double-word integers.</li>
399   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Complex.html#Complex">Complex</a>:   Data types for complex numbers.</li>
400   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Hex-Floats.html#Hex%20Floats">Hex Floats</a>:Hexadecimal floating-point constants.</li>
401   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Zero-Length.html#Zero%20Length">Zero Length</a>: Zero-length arrays.</li>
402   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Empty-Structures.html#Empty%20Structures">Empty Structures</a>: Structures with no members.</li>
403   <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>
404   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Escaped-Newlines.html#Escaped%20Newlines">Escaped Newlines</a>:  Slightly looser rules for escaped newlines.</li>
405   <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>
406   <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>
407   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Initializers.html#Initializers">Initializers</a>: Non-constant initializers.</li>
408   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Compound-Literals.html#Compound%20Literals">Compound Literals</a>: Compound literals give structures, unions,
409 or arrays as values.</li>
410   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Designated-Inits.html#Designated%20Inits">Designated Inits</a>: Labeling elements of initializers.</li>
411   <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>
412   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Case-Ranges.html#Case%20Ranges">Case Ranges</a>: `case 1 ... 9' and such.</li>
413   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Mixed-Declarations.html#Mixed%20Declarations">Mixed Declarations</a>: Mixing declarations and code.</li>
414   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Prototypes.html#Function%20Prototypes">Function Prototypes</a>: Prototype declarations and old-style definitions.</li>
415   <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>
416   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Dollar-Signs.html#Dollar%20Signs">Dollar Signs</a>: Dollar sign is allowed in identifiers.</li>
417   <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>
418   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Alignment.html#Alignment">Alignment</a>: Inquiring about the alignment of a type or variable.</li>
419   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Inline.html#Inline">Inline</a>: Defining inline functions (as fast as macros).</li>
420   <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>
421   <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>
422   <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>
423   <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>
424   <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>
425   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Attribute-Syntax.html#Attribute%20Syntax">Attribute Syntax</a>: Formal syntax for attributes.</li>
426   </ol></li>
427
428 </ul>
429
430 <p>If you run into GCC extensions which have not been included in any of these
431 lists, please let us know (also including whether or not they work).</p>
432
433 </div>
434
435 <!-- ======================================================================= -->
436 <div class="doc_subsection">
437   <a name="c++-fe">Known problems with the C++ front-end</a>
438 </div>
439
440 <div class="doc_text">
441
442 <p>For this release, the C++ front-end is considered to be fully
443 tested and works for a number of non-trivial programs, including LLVM
444 itself.</p>
445
446 </div>
447
448 <!-- _______________________________________________________________________ -->
449 <div class="doc_subsubsection">Bugs</div>
450
451 <div class="doc_text">
452
453 <ul>
454 <li>The C++ front-end inherits all problems afflicting the <a href="#c-fe">C
455     front-end</a>.</li>
456
457 </ul>
458
459 </div>
460
461 <!-- _______________________________________________________________________ -->
462 <div class="doc_subsubsection">
463   Notes
464 </div>
465
466 <div class="doc_text">
467
468 <ul>
469
470 <li>Destructors for local objects are not always run when a <tt>longjmp</tt> is
471     performed. In particular, destructors for objects in the <tt>longjmp</tt>ing
472     function and in the <tt>setjmp</tt> receiver function may not be run.
473     Objects in intervening stack frames will be destroyed, however (which is
474     better than most compilers).</li>
475
476 <li>The LLVM C++ front-end follows the <a
477     href="http://www.codesourcery.com/cxx-abi">Itanium C++ ABI</a>.
478     This document, which is not Itanium specific, specifies a standard for name
479     mangling, class layout, v-table layout, RTTI formats, and other C++
480     representation issues.  Because we use this API, code generated by the LLVM
481     compilers should be binary compatible with machine code generated by other
482     Itanium ABI C++ compilers (such as G++, the Intel and HP compilers, etc).
483     <i>However</i>, the exception handling mechanism used by LLVM is very
484     different from the model used in the Itanium ABI, so <b>exceptions will not
485     interact correctly</b>. </li>
486
487 </ul>
488
489 </div>
490
491 <!-- ======================================================================= -->
492 <div class="doc_subsection">
493   <a name="c-be">Known problems with the C back-end</a>
494 </div>
495
496 <div class="doc_text">
497
498 <ul>
499
500 <li>The C back-end produces code that violates the ANSI C Type-Based Alias
501 Analysis rules.  As such, special options may be necessary to compile the code
502 (for example, GCC requires the <tt>-fno-strict-aliasing</tt> option).  This
503 problem probably cannot be fixed.</li>
504
505 <li><a href="http://llvm.org/PR56">Zero arg vararg functions are not 
506 supported</a>.  This should not affect LLVM produced by the C or C++ 
507 frontends.</li>
508
509 <li>The C backend does not correctly implement the <a 
510 href="LangRef.html#i_stacksave"><tt>llvm.stacksave</tt></a> or
511 <a href="LangRef.html#i_stackrestore"><tt>llvm.stackrestore</tt></a> 
512 intrinsics.  This means that some code compiled by it can run out of stack
513 space if they depend on these (e.g. C99 varargs).</li>
514
515 </ul>
516
517 </div>
518
519 <!-- ======================================================================= -->
520 <div class="doc_subsection">
521   <a name="x86-be">Known problems with the X86 back-end</a>
522 </div>
523
524 <div class="doc_text">
525
526 <ul>
527 <li>none yet.</li>
528 </ul>
529
530 </div>
531
532 <!-- ======================================================================= -->
533 <div class="doc_subsection">
534   <a name="ppc-be">Known problems with the PowerPC back-end</a>
535 </div>
536
537 <div class="doc_text">
538
539 <ul>
540 <li><a href="http://llvm.org/PR642">PowerPC backend does not correctly
541 implement ordered FP comparisons</a>.</li>
542 </ul>
543
544 </div>
545
546 <!-- ======================================================================= -->
547 <div class="doc_subsection">
548   <a name="alpha-be">Known problems with the Alpha back-end</a>
549 </div>
550
551 <div class="doc_text">
552
553 <ul>
554
555 <li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
556 appropriate nops inserted to ensure restartability.</li>
557
558 </ul>
559
560 </div>
561
562 <!-- ======================================================================= -->
563 <div class="doc_subsection">
564   <a name="ia64-be">Known problems with the IA64 back-end</a>
565 </div>
566
567 <div class="doc_text">
568
569 <ul>
570
571 <li>C++ programs are likely to fail on IA64, as calls to <tt>setjmp</tt> are
572 made where the argument is not 16-byte aligned, as required on IA64. (Strictly
573 speaking this is not a bug in the IA64 back-end; it will also be encountered
574 when building C++ programs using the C back-end.)</li>
575
576 <li>The C++ front-end does not use <a href="http://llvm.org/PR406">IA64
577 ABI compliant layout of v-tables</a>.  In particular, it just stores function
578 pointers instead of function descriptors in the vtable.  This bug prevents
579 mixing C++ code compiled with LLVM with C++ objects compiled by other C++
580 compilers.</li>
581
582 <li>There are a few ABI violations which will lead to problems when mixing LLVM
583 output with code built with other compilers, particularly for floating-point
584 programs.</li>
585
586 <li>Defining vararg functions is not supported (but calling them is ok).</li>
587
588 </ul>
589
590 </div>
591
592 <!-- ======================================================================= -->
593 <div class="doc_subsection">
594   <a name="sparc-be">Known problems with the SPARC back-end</a>
595 </div>
596
597 <div class="doc_text">
598
599 <ul>
600 <li>The SPARC backend only supports the 32-bit SPARC ABI (-m32), it does not
601     support the 64-bit SPARC ABI (-m64).</li>
602 </ul>
603
604 </div>
605
606 <!-- ======================================================================= -->
607 <div class="doc_subsection">
608   <a name="arm-be">Known problems with the ARM back-end</a>
609 </div>
610
611 <div class="doc_text">
612
613 <ul>
614 <li>The ARM backend is currently in early development stages, it is not 
615 ready for production use.</li>
616 </ul>
617
618 </div>
619
620 <!-- *********************************************************************** -->
621 <div class="doc_section">
622   <a name="additionalinfo">Additional Information</a>
623 </div>
624 <!-- *********************************************************************** -->
625
626 <div class="doc_text">
627
628 <p>A wide variety of additional information is available on the <a
629 href="http://llvm.org">LLVM web page</a>, including <a
630 href="http://llvm.org/docs/">documentation</a> and <a
631 href="http://llvm.org/pubs/">publications describing algorithms and
632 components implemented in LLVM</a>.  The web page also contains versions of the
633 API documentation which is up-to-date with the CVS version of the source code.
634 You can access versions of these documents specific to this release by going
635 into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
636
637 <p>If you have any questions or comments about LLVM, please feel free to contact
638 us via the <a href="http://llvm.org/docs/#maillist"> mailing
639 lists</a>.</p>
640
641 </div>
642
643 <!-- *********************************************************************** -->
644
645 <hr>
646 <address>
647   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
648   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
649   <a href="http://validator.w3.org/check/referer"><img
650   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
651
652   <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br>
653   Last modified: $Date$
654 </address>
655
656 </body>
657 </html>