Merged in RELEASE_11.
[oota-llvm.git] / docs / ReleaseNotes.html
index a19c05f54ea6f7b16b01eee526f6f4615ebabb57..b5cd8f2f4a89b672b3b418f18e2fe915b9cd5d5c 100644 (file)
@@ -18,7 +18,6 @@
   <li><a href="#install-instructions">Installation Instructions</a></li>
   <li><a href="#knownproblems">Known Problems</a>
   <ul>
-<!--    <li><a href="#portabilityprobs">Portability Problems</a> -->
     <li><a href="#core">Known problems with the LLVM Core</a>
     <li><a href="#c-fe">Known problems with the C Front-end</a>
     <li><a href="#c++-fe">Known problems with the C++ Front-end</a>
@@ -30,7 +29,7 @@
 </ol>
 
 <div class="doc_text">
-  <p><b>Written by <a href="mailto:sabre@nondot.org">Chris Lattner</a></b><p>
+  <p><b>Written by the <a href="http://llvm.cs.uiuc.edu">LLVM team</a></b><p>
 </div>
 
 <!-- *********************************************************************** -->
 
 <p>This document contains the release notes for the LLVM compiler
 infrastructure, release 1.2.  Here we describe the status of LLVM, including any
-known problems, and bug fixes from the previous release.  The most up-to-date
+known problems and bug fixes from the previous release.  The most up-to-date
 version of this document can be found on the <a
 href="http://llvm.cs.uiuc.edu/releases/1.2/">LLVM 1.2 web site</a>.  If you are
-not reading this on the LLVM web pages, you should probably go there, because
+not reading this on the LLVM web pages, you should probably go there because
 this document may be updated after the release.</p>
 
 <p>For more information about LLVM, including information about potentially more
@@ -70,8 +69,7 @@ href="http://llvm.cs.uiuc.edu/releases/">releases page</a>.</p>
 
 <div class="doc_text">
 
-<p>This is the third public release of the LLVM compiler infrastructure.  OTHER
-OVERVIEW STUFF HERE.
+<p>This is the third public release of the LLVM compiler infrastructure.
 </p>
 
 <p>At this time, LLVM is known to correctly compile and run all non-unwinding C
@@ -82,10 +80,10 @@ received much less testing than the C front-end.
 </p>
 
 <p>
-The LLVM native code generators are very stable, but do not currently support
+The LLVM native code generators are very stable but do not currently support
 unwinding (exception throwing or <tt>longjmp</tt>ing), which prevent them from
 working with programs like the <tt>253.perlbmk</tt> in SPEC CPU2000.  The C
-backend and the rest of LLVM does support these programs however, so you can
+backend and the rest of LLVM supports these programs, so you can
 still use LLVM with them.  Support for unwinding will be added in a future
 release.
 </p>
@@ -164,11 +162,11 @@ management functions in libc runtime to allow them to be overriden</a></li>
 <p>LLVM has been extensively tested on Intel and AMD machines running Red
 Hat Linux and FreeBSD.  It has also been tested on Sun UltraSPARC workstations running Solaris 8.
 Additionally, 
-LLVM works on Mac OS/X 10.3 and above, but only with the C backend or 
+LLVM works on Mac OS X 10.3 and above, but only with the C backend or 
 interpreter (no native backend for the PowerPC is available yet).
 The core LLVM infrastructure uses "autoconf" for portability, so hopefully we
 work on more platforms than that.  However, it is likely that we
-missed something, and that minor porting is required to get LLVM to work on 
+missed something and that minor porting is required to get LLVM to work on 
 new platforms.  We welcome portability patches and error messages.</p>
 
 </div>
@@ -184,7 +182,7 @@ new platforms.  We welcome portability patches and error messages.</p>
 <p>This section contains all known problems with the LLVM system, listed by
 component.  As new problems are discovered, they will be added to these
 sections.  If you run into a problem, please check the <a
-href="http://llvm.cs.uiuc.edu/bugs/">LLVM bug database</a>, and submit a bug if
+href="http://llvm.cs.uiuc.edu/bugs/">LLVM bug database</a> and submit a bug if
 there isn't already one.</p>
 
 </div>
@@ -219,6 +217,18 @@ table in the archive).</li>
 <li><a href="http://llvm.cs.uiuc.edu/PR82">LLVM cannot handle structures with
 more than 256 elements</a>.</li>
 
+<li>
+The gccld program 
+<a href="http://llvm.cs.uiuc.edu/bugs/show_bug.cgi?id=139">
+does not link objects/archives in the order specified on the command line.
+</a>
+</li>
+
+<li>
+<a href="http://llvm.cs.uiuc.edu/bugs/show_bug.cgi?id=174">
+Tail duplication does not update SSA form correctly.
+</a>
+</li>
 </ul>
 
 </div>
@@ -232,9 +242,7 @@ more than 256 elements</a>.</li>
 <div class="doc_subsubsection">Bugs</div>
 
 <div class="doc_text">
-
 <ul>
-
 <li>C99 Variable sized arrays do not release stack memory when they go out of 
     scope.  Thus, the following program may run out of stack space:
 <pre>
@@ -244,8 +252,27 @@ more than 256 elements</a>.</li>
     }
 </pre></li>
 
+<li>
+Initialization of global union variables can only be done
+<a href="http://llvm.cs.uiuc.edu/bugs/show_bug.cgi?id=162">with the largest
+union member</a>.
+</li>
+
+<li>
+<a href="http://llvm.cs.uiuc.edu/bugs/show_bug.cgi?id=182">
+Functions marked "extern inline" are not compiled into LLVM with linkonce
+linkage.
+</a>
+</li>
+
+
+<li>
+The memory management functions in the libc runtime
+<a href="http://llvm.cs.uiuc.edu/PR186">need weak linkage so that they can be
+overridden.
+</a>
+</li>
 </ul>
-
 </div>
 
 <!-- _______________________________________________________________________ -->
@@ -277,11 +304,11 @@ work:
     the following extensions are known to <b>not be</b> supported:
   <ol>
   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Local-Labels.html#Local%20Labels">Local Labels</a>: Labels local to a block.</li>
-  <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>
+  <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>
   <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>
   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Constructing-Calls.html#Constructing%20Calls">Constructing Calls</a>: Dispatching a call to another function.</li>
   <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>
-  <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Constraints.html#Constraints">Constraints</a>: Constraints for asm operands</li>
+  <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Constraints.html#Constraints">Constraints</a>: Constraints for asm operands.</li>
   <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>
   <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>
   <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>
@@ -294,7 +321,7 @@ work:
   <p>The following GCC extensions are <b>partially</b> supported.  An ignored
   attribute means that the LLVM compiler ignores the presence of the attribute,
   but the code should still work.  An unsupported attribute is one which is
-  ignored by the LLVM compiler, which will cause a different interpretation of
+  ignored by the LLVM compiler and will cause a different interpretation of
   the program.</p>
 
   <ol>
@@ -304,7 +331,7 @@ work:
 
   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Attributes.html#Function%20Attributes">Function Attributes</a>:
 
-      Declaring that functions have no side effects, or that they can never
+      Declaring that functions have no side effects or that they can never
       return.<br>
 
       <b>Supported:</b> <tt>format</tt>, <tt>format_arg</tt>, <tt>non_null</tt>,
@@ -363,7 +390,8 @@ work:
   <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>
   <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>
   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Initializers.html#Initializers">Initializers</a>: Non-constant initializers.</li>
-  <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.</li>
+  <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.</li>
   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Designated-Inits.html#Designated%20Inits">Designated Inits</a>: Labeling elements of initializers.</li>
   <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>
   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Case-Ranges.html#Case%20Ranges">Case Ranges</a>: `case 1 ... 9' and such.</li>
@@ -395,7 +423,7 @@ lists, please let us know (also including whether or not they work).</p>
 
 <div class="doc_text">
 
-<p>For this release, the C++ front-end is considered to be fully functional, but
+<p>For this release, the C++ front-end is considered to be fully functional but
 has not been tested as thoroughly as the C front-end.  It has been tested and 
 works for a number of non-trivial programs, but there may be lurking bugs.
 Please report any bugs or problems.</p>
@@ -411,9 +439,14 @@ Please report any bugs or problems.</p>
 
 <ul>
 <li>The C++ front-end inherits all problems afflicting the <a href="#c-fe">C
-    front-end</a></li>
-</ul>
+    front-end</a>.</li>
 
+<li>
+<a href="http://llvm.cs.uiuc.edu/bugs/show_bug.cgi?id=137">
+Code is generated for empty classes.
+</a>
+</li>
+</ul>
 </div>
 
 <!-- _______________________________________________________________________ -->
@@ -433,7 +466,7 @@ href="http://gcc.gnu.org/gcc-3.4/changes.html">GCC 3.4 release notes</a>.</li>
 <li>Destructors for local objects are not always run when a <tt>longjmp</tt> is
     performed. In particular, destructors for objects in the <tt>longjmp</tt>ing
     function and in the <tt>setjmp</tt> receiver function may not be run.
-    Objects in intervening stack frames will be destroyed however (which is
+    Objects in intervening stack frames will be destroyed, however (which is
     better than most compilers).</li>
 
 <li>The LLVM C++ front-end follows the <a
@@ -483,6 +516,11 @@ href="http://llvm.cs.uiuc.edu/PR15">does not currently
 support the <tt>unwind</tt> instruction</a>, so code that throws a C++ exception
 or calls the C <tt>longjmp</tt> function will abort.</li>
 
+<li>
+<a href="http://llvm.cs.uiuc.edu/bugs/show_bug.cgi?id=167">
+The llc program can crash on legal code.
+</a>
+</li>
 </ul>
 
 </div>
@@ -522,7 +560,7 @@ frontends.</li>
 <div class="doc_text">
 
 <p>A wide variety of additional information is available on the LLVM web page,
-including mailing lists publications describing algorithms and components
+including mailing lists and publications describing algorithms and components
 implemented in LLVM.  The web page also contains versions of the API
 documentation which is up-to-date with the CVS version of the source code.  You
 can access versions of these documents specific to this release by going into