Bump the release number, add a skeleton to be filled in as stuff changes.
[oota-llvm.git] / docs / ReleaseNotes.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html><head><title>LLVM 1.1 Release Notes</title></head>
3 <body bgcolor=white>
4
5 <table width="100%" bgcolor="#330077" border=0 cellpadding=4 cellspacing=0>
6 <tr><td>&nbsp; <font size=+3 color="#EEEEFF" face="Georgia,Palatino,Times,Roman"><b>LLVM 1.1 Release Notes</b></font></td>
7 </tr></table>
8  
9 <ol>
10   <li><a href="#intro">Introduction</a>
11   <li><a href="#whatsnew">What's New?</a>
12   <li><a href="#portability">Portability and Supported Platforms</a>
13   <li><a href="#install-instructions">Installation Instructions</a>
14   <li><a href="#knownproblems">Known Problems</a>
15   <ul>
16 <!--    <li><a href="#portabilityprobs">Portability Problems</a> -->
17     <li><a href="#core">Known problems with the LLVM Core</a>
18     <li><a href="#c-fe">Known problems with the C Front-end</a>
19     <li><a href="#c++-fe">Known problems with the C++ Front-end</a>
20     <li><a href="#x86-be">Known problems with the X86 Back-end</a>
21     <li><a href="#sparc-be">Known problems with the Sparc Back-end</a>
22     <li><a href="#c-be">Known problems with the C back-end</a>
23   </ul>
24   <li><a href="#additionalinfo">Additional Information</a>
25   </ul>
26
27   <p><b>Written by <a href="mailto:sabre@nondot.org">Chris Lattner</a></b><p>
28 </ol>
29
30
31 <!-- *********************************************************************** -->
32 <table width="100%" bgcolor="#330077" border=0 cellpadding=4 cellspacing=0>
33 <tr><td align=center><font color="#EEEEFF" size=+2 face="Georgia,Palatino"><b>
34 <a name="intro">Introduction
35 </b></font></td></tr></table><ul>
36 <!-- *********************************************************************** -->
37
38 This document contains the release notes for the LLVM compiler infrastructure,
39 release 1.1.  Here we describe the status of LLVM, including any known problems,
40 and bug fixes from the previous release.  The most up-to-date version of this
41 document can be found on the <a
42 href="http://llvm.cs.uiuc.edu/releases/1.1/">LLVM 1.1 web site</a>.  If you are
43 not reading this on the LLVM web pages, you should probably go there, because
44 this document may be updated after the release.<p>
45
46 For more information about LLVM, including information about potentially more
47 current releases, please check out the <a href="http://llvm.cs.uiuc.edu">main
48 web site</a>.  If you have questions or comments, the <a
49 href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM developer's mailing
50 list</a> is a good place to send them.<p>
51
52 Note that if you are reading this file from CVS, that this document applies to
53 the <i>next</i> release, not the previous one.  To see the release notes for the
54 previous release, see the <a href="http://llvm.cs.uiuc.edu/releases/">releases
55 page</a>.<p>
56
57 <!-- *********************************************************************** -->
58 </ul><table width="100%" bgcolor="#330077" border=0 cellpadding=4 cellspacing=0>
59 <tr><td align=center><font color="#EEEEFF" size=+2 face="Georgia,Palatino"><b>
60 <a name="whatsnew">What's New?
61 </b></font></td></tr></table><ul>
62 <!-- *********************************************************************** -->
63
64 This is the second public release of the LLVM compiler infrastructure.  This
65 release implements the following new features:<p>
66
67 <ol>
68 <li>temp</li>
69 <li>temp</li>
70 <li>temp</li>
71 </ol><p>
72
73 In this release, the following bugs were fixed:<p>
74
75 <ol>
76 <li>temp</li>
77 <li>temp</li>
78 <li>temp</li>
79 </ol><p>
80
81 At this time, LLVM is known to work properly with SPEC CPU 2000, the Olden
82 benchmarks, and the Ptrdist benchmarks among many other programs.  Note however
83 that the Sparc and X86 backends do not currently support exception throwing or
84 long jumping (including 253.perlbmk in SPEC).  For these programs you must use
85 the C backend.<p>
86
87
88 <!-- *********************************************************************** -->
89 </ul><table width="100%" bgcolor="#330077" border=0 cellpadding=4 cellspacing=0>
90 <tr><td align=center><font color="#EEEEFF" size=+2 face="Georgia,Palatino"><b>
91 <a name="portability">Portability and Supported Platforms
92 </b></font></td></tr></table><ul>
93 <!-- *********************************************************************** -->
94
95 LLVM has only been extensively tested on Intel and AMD machines running Red
96 Hat Linux, and Sun UltraSPARC workstations running Solaris 8.
97 The core LLVM infrastructure uses "autoconf" for portability, so hopefully we
98 work on more platforms than that.  However, it is extremely likely that we
99 missed something.  We welcome portability patches and error messages.<p>
100
101
102 <!-- *********************************************************************** -->
103 </ul><table width="100%" bgcolor="#330077" border=0 cellpadding=4 cellspacing=0>
104 <tr><td align=center><font color="#EEEEFF" size=+2 face="Georgia,Palatino"><b>
105 <a name="knownproblems">Known Problems
106 </b></font></td></tr></table><ul>
107 <!-- *********************************************************************** -->
108
109 This section contains all known problems with the LLVM system, listed by
110 component.  As new problems are discovered, they will be added to these
111 sections.
112
113
114 <!-- _______________________________________________________________________ -->
115 <!--
116 </ul><h4><a name="portability"><hr size=0>Portability Problems</h4><ul>
117 -->
118
119
120 <!-- _______________________________________________________________________ -->
121 </ul><h4><a name="core"><hr size=0>Known problems with the LLVM Core</h4><ul>
122
123 <li>In the JIT, <tt>dlsym</tt> on a symbol compiled by the JIT will not work.<p>
124
125 <li>The JIT does not use mutexes to protect its internal data structures.  As
126     such, execution of a threaded program could cause these data structures to
127     be corrupted.<p>
128
129 <li>It is not possible to <tt>dlopen</tt> an LLVM bytecode file in the JIT.<p>
130
131 <li>Linking in static archive files (.a files) is very slow (there is no symbol
132 table in the archive).
133
134 <!-- _______________________________________________________________________ -->
135 </ul><h4><a name="c-fe"><hr size=0>Known problems with the C front-end</h4><ul>
136
137 <li>Inline assembly is not yet supported.<p>
138
139 <li>"long double" is transformed by the front-end into "double".  There is no
140     support for floating point data types of any size other than 32 and 64 bits.
141     <p>
142 <li>C99 Variable sized arrays do not release stack memory when they go out of 
143     scope.  Thus, the following program may run out of stack space:
144 <pre>
145     for (i = 0; i != 1000000; ++i) {
146       int X[n];
147       foo(X);
148     }
149 </pre><p>
150
151 <li>The following Unix system functionality has not been tested and may not work:
152 <ol>
153    <li><tt>sigsetjmp</tt>, <tt>siglongjmp</tt> - These are not turned into the
154        appropriate <tt>invoke</tt>/<tt>unwind</tt> instructions.
155    <li><tt>getcontext</tt>, <tt>setcontext</tt>, <tt>makecontext</tt>
156        - These functions have not been tested.
157 </ol><p>
158
159 <li>Bugs:<br>
160   <a href="http://llvm.cs.uiuc.edu/PR6">Oversized integer bitfields cause crash</a>.<br>
161 <p>
162
163 <li>Although many GCC extensions are supported, some are not.  In particular,
164     the following extensions are known to <b>not be</b> supported:
165   <ol>
166   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Local-Labels.html#Local%20Labels">Local Labels</a>: Labels local to a block. 
167   <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. 
168   <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. 
169   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Constructing-Calls.html#Constructing%20Calls">Constructing Calls</a>:  Dispatching a call to another function. 
170   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Extended-Asm.html#Extended%20Asm">Extended Asm</a>: Assembler instructions with C expressions as operands. 
171   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Constraints.html#Constraints">Constraints</a>:  Constraints for asm operands
172   <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. 
173   <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. 
174   <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. 
175   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Vector-Extensions.html#Vector%20Extensions">Vector Extensions</a>: Using vector instructions through built-in functions. 
176   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Target-Builtins.html#Target%20Builtins">Target Builtins</a>:   Built-in functions specific to particular targets. 
177   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Thread-Local.html#Thread-Local">Thread-Local</a>: Per-thread variables. 
178   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Pragmas.html#Pragmas">Pragmas</a>: Pragmas accepted by GCC. 
179   </ol><p>
180
181   The following GCC extensions are <b>partially</b> supported.  An ignored
182   attribute means that the LLVM compiler ignores the presence of the attribute,
183   but the code should still work.  An unsupported attribute is one which is
184   ignored by the LLVM compiler, which will cause a different interpretation of
185   the program.<p>
186
187   <ol>
188   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Length.html#Variable%20Length">Variable Length</a>:
189       Arrays whose length is computed at run time.<br>
190       Supported, but allocated stack space is not freed until the function returns (noted above).
191
192   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Attributes.html#Function%20Attributes">Function Attributes</a>:
193       Declaring that functions have no side effects, or that they can never return.<br>
194       <b>Supported:</b> <tt>format</tt>, <tt>format_arg</tt>, <tt>non_null</tt>, <tt>constructor</tt>, <tt>destructor</tt>, <tt>unused</tt>, <tt>deprecated</tt>,
195                  <tt>warn_unused_result</tt>, <tt>weak</tt><br>
196       <b>Ignored:</b> <tt>noreturn</tt>, <tt>noinline</tt>, <tt>always_inline</tt>, <tt>pure</tt>, <tt>const</tt>, <tt>nothrow</tt>,  <tt>malloc</tt>
197                <tt>no_instrument_function</tt>, <tt>cdecl</tt><br>
198       <b>Unsupported:</b> <tt>used</tt>, <tt>section</tt>, <tt>alias</tt>, <tt>visibility</tt>, <tt>regparm</tt>, <tt>stdcall</tt>,
199                <tt>fastcall</tt>, all other target specific attributes
200    
201   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Attributes.html#Variable%20Attributes">Variable Attributes</a>:
202       Specifying attributes of variables.<br>
203       <b>Supported:</b> <tt>cleanup</tt>, <tt>common</tt>, <tt>nocommon</tt>,
204                         <tt>deprecated</tt>, <tt>transparent_union</tt>,
205                         <tt>unused</tt>, <tt>weak</tt><br>
206       <b>Unsupported:</b> <tt>aligned</tt>, <tt>mode</tt>, <tt>packed</tt>,
207                         <tt>section</tt>, <tt>shared</tt>, <tt>tls_model</tt>,
208                         <tt>vector_size</tt>, <tt>dllimport</tt>, 
209                         <tt>dllexport</tt>, all target specific attributes.<br>
210
211   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Type-Attributes.html#Type%20Attributes">Type Attributes</a>:   Specifying attributes of types. 
212       <b>Supported:</b> <tt>transparent_union</tt>, <tt>unused</tt>,
213                         <tt>deprecated</tt>, <tt>may_alias</tt>
214       <b>Unsupported:</b> <tt>aligned</tt>, <tt>packed</tt>
215                         all target specific attributes.<br>
216   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Other-Builtins.html#Other%20Builtins">Other Builtins</a>:
217       Other built-in functions.<br>
218       We support all builtins which have a C language equivalent (e.g., 
219          <tt>__builtin_cos</tt>),  <tt>__builtin_alloca</tt>, 
220          <tt>__builtin_types_compatible_p</tt>, <tt>__builtin_choose_expr</tt>,
221          <tt>__builtin_constant_p</tt>, and <tt>__builtin_expect</tt> (ignored).
222   </ol><p>
223
224
225   The following extensions <b>are</b> known to be supported:
226   <ol>
227   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Statement-Exprs.html#Statement%20Exprs">Statement Exprs</a>:   Putting statements and declarations inside expressions. 
228   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Typeof.html#Typeof">Typeof</a>: <code>typeof</code>: referring to the type of an expression. 
229   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Lvalues.html#Lvalues">Lvalues</a>:   Using <code>?:</code>, "<code>,</code>" and casts in lvalues. 
230   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Conditionals.html#Conditionals">Conditionals</a>: Omitting the middle operand of a <code>?:</code> expression. 
231   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Long-Long.html#Long%20Long">Long Long</a>: Double-word integers.
232   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Complex.html#Complex">Complex</a>:   Data types for complex numbers. 
233   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Hex-Floats.html#Hex%20Floats">Hex Floats</a>:Hexadecimal floating-point constants. 
234   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Zero-Length.html#Zero%20Length">Zero Length</a>:  Zero-length arrays. 
235   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Empty-Structures.html#Empty%20Structures">Empty Structures</a>:  Structures with no members. 
236   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variadic-Macros.html#Variadic%20Macros">Variadic Macros</a>:   Macros with a variable number of arguments. 
237   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Escaped-Newlines.html#Escaped%20Newlines">Escaped Newlines</a>:  Slightly looser rules for escaped newlines. 
238   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Subscripting.html#Subscripting">Subscripting</a>: Any array can be subscripted, even if not an lvalue. 
239   <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. 
240   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Initializers.html#Initializers">Initializers</a>: Non-constant initializers. 
241   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Compound-Literals.html#Compound%20Literals">Compound Literals</a>: Compound literals give structures, unions or arrays as values. 
242   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Designated-Inits.html#Designated%20Inits">Designated Inits</a>: Labeling elements of initializers. 
243
244   <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. 
245   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Case-Ranges.html#Case%20Ranges">Case Ranges</a>: `case 1 ... 9' and such. 
246   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Mixed-Declarations.html#Mixed%20Declarations">Mixed Declarations</a>:  Mixing declarations and code. 
247
248   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Prototypes.html#Function%20Prototypes">Function Prototypes</a>:  Prototype declarations and old-style definitions. 
249   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/C---Comments.html#C++%20Comments">C++ Comments</a>: C++ comments are recognized. 
250   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Dollar-Signs.html#Dollar%20Signs">Dollar Signs</a>: Dollar sign is allowed in identifiers. 
251   <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;. 
252   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Alignment.html#Alignment">Alignment</a>: Inquiring about the alignment of a type or variable. 
253   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Inline.html#Inline">Inline</a>: Defining inline functions (as fast as macros). 
254   <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. 
255   <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. 
256   <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. 
257   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Unnamed-Fields.html#Unnamed%20Fields">Unnamed Fields</a>: Unnamed struct/union fields within structs/unions.
258   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Attribute-Syntax.html#Attribute%20Syntax">Attribute Syntax</a>:  Formal syntax for attributes. 
259   </ol><p>
260
261   If you run into GCC extensions which have not been included in any of these
262   lists, please let us know (also including whether or not they work).
263
264
265 <!-- _______________________________________________________________________ -->
266 </ul><h4><a name="c++-fe"><hr size=0>Known problems with the C++ front-end</h4><ul>
267
268 For this release, the C++ front-end is considered to be of <b>beta</b> quality.
269 It works for a large number of simple programs, but has not been extensively
270 tested.  We welcome bug reports though!<p>
271
272 <li>The C++ front-end inherits all problems afflicting the <a href="#c-fe">C
273     front-end</a><p>
274
275 <li>The C++ front-end is based on a pre-release of the GCC 3.4 C++ parser.  This
276 parser is significantly more standards compliant (and picky) than prior GCC
277 versions.  For more information, see the C++ section of the <a
278 href="http://gcc.gnu.org/gcc-3.4/changes.html">GCC 3.4 release notes</a>.<p>
279
280 <li>Destructors for local objects are not always run when a <tt>longjmp</tt> is
281     performed. In particular, destructors for objects in the <tt>longjmp</tt>ing
282     function and in the <tt>setjmp</tt> receiver function may not be run.
283     Objects in intervening stack frames will be destroyed however (which is
284     better than most compilers).<p> 
285
286 <li>The LLVM C++ front-end follows the <a
287     href="http://www.codesourcery.com/cxx-abi">Itanium C++ ABI</a>.
288     This document, which is not Itanium specific, specifies a standard for name
289     mangling, class layout, v-table layout, RTTI formats, and other C++
290     representation issues.  Because we use this API, code generated by the LLVM
291     compilers should be binary compatible with machine code generated by other
292     Itanium ABI C++ compilers (such as G++, the Intel and HP compilers, etc).
293     <i>However</i>, the exception handling mechanism used by LLVM is very
294     different from the model used in the Itanium ABI, so <b>exceptions will not
295     interact correctly</b> .
296
297 <li><a href="http://llvm.cs.uiuc.edu/PR11">Code for executing
298 destructors when unwinding is not shared</a>.
299
300
301 <!-- _______________________________________________________________________ -->
302 </ul><h4><a name="x86-be"><hr size=0>Known problems with the X86 back-end</h4><ul>
303
304 <li>The X86 code generator <a
305 href="http://llvm.cs.uiuc.edu/PR16">does not currently
306 support the <tt>unwind</tt> instruction</a>, so code that throws a C++ exception
307 or calls the C <tt>longjmp</tt> function will abort.<p>
308
309
310 <!-- _______________________________________________________________________ -->
311 </ul><h4><a name="sparc-be"><hr size=0>Known problems with the Sparc back-end</h4><ul>
312
313 <li>The Sparc code generator <a
314 href="http://llvm.cs.uiuc.edu/PR15">does not currently
315 support the <tt>unwind</tt> instruction</a>, so code that throws a C++ exception
316 or calls the C <tt>longjmp</tt> function will abort.<p>
317
318
319 <!-- _______________________________________________________________________ -->
320 </ul><h4><a name="c-be"><hr size=0>Known problems with the C back-end</h4><ul>
321
322 <li>The C back-end produces code that violates the ANSI C Type-Based Alias
323 Analysis rules.  As such, special options may be necessary to compile the code
324 (for example, GCC requires the <tt>-fno-strict-aliasing</tt> option).  This
325 problem probably cannot be fixed.<p>
326
327 <li><a href="http://llvm.cs.uiuc.edu/PR33">Initializers for global variables</a>
328 cannot include special floating point numbers like Not-A-Number or Infinity.<p>
329
330 <li><a href="http://zion.cs.uiuc.edu/PR56">Zero arg vararg functions are not 
331 supported</a>.  This should not affect LLVM produced by the C or C++ 
332 frontends.<p>
333
334 <li>The code produces by the C back-end has only been tested with the Sun CC and
335 GCC compilers.  It is possible that it will have to be adjusted to support other
336 C compilers.<p>
337
338
339
340 <!-- *********************************************************************** -->
341 </ul><table width="100%" bgcolor="#330077" border=0 cellpadding=4 cellspacing=0>
342 <tr><td align=center><font color="#EEEEFF" size=+2 face="Georgia,Palatino"><b>
343 <a name="additionalinfo">Additional Information
344 </b></font></td></tr></table><ul>
345 <!-- *********************************************************************** -->
346
347 A wide variety of additional information is available on the LLVM web page,
348 including mailing lists publications describing algorithms and components
349 implemented in LLVM.  The web page also contains versions of the API
350 documentation which is up-to-date with the CVS version of the source code.  You
351 can access versions of these documents specific to this release by going into
352 the "<tt>llvm/doc/</tt>" directory in the LLVM tree.<p>
353
354 If you have any questions or comments about LLVM, please feel free to contact us
355 via the mailing lists.<p>
356
357
358 <!-- *********************************************************************** -->
359 </ul>
360 <!-- *********************************************************************** -->
361
362 <hr><font size-1>
363
364 Maintained By: <a href="http://llvm.cs.uiuc.edu/">The LLVM Team</a><br>
365 <!-- Created: Wed Oct  1 17:38:54 CDT 2003 -->
366 <!-- hhmts start -->
367 Last modified: Sun Oct 26 19:30:33 CST 2003
368 <!-- hhmts end -->
369 </body></html>