Instruction encoding bug
[oota-llvm.git] / docs / ReleaseNotes.html
index 961dab1f74555d2319d8f443388d1253be36cdbb..dc2af9c06da713227cb0c5ef1d66ab01073eee66 100644 (file)
@@ -4,11 +4,11 @@
 <head>
   <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
   <link rel="stylesheet" href="llvm.css" type="text/css">
-  <title>LLVM 1.5 Release Notes</title>
+  <title>LLVM 1.7cvs Release Notes</title>
 </head>
 <body>
 
-<div class="doc_title">LLVM 1.5 Release Notes</div>
+<div class="doc_title">LLVM 1.7 Release Notes</div>
  
 <ol>
   <li><a href="#intro">Introduction</a></li>
@@ -20,7 +20,7 @@
 </ol>
 
 <div class="doc_author">
-  <p>Written by the <a href="http://llvm.cs.uiuc.edu">LLVM Team</a><p>
+  <p>Written by the <a href="http://llvm.org">LLVM Team</a><p>
 </div>
 
 <!-- *********************************************************************** -->
 <div class="doc_text">
 
 <p>This document contains the release notes for the LLVM compiler
-infrastructure, release 1.5.  Here we describe the status of LLVM, including any
-known problems and improvements 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.5/">LLVM 1.5 web site</a>.  If you are
+infrastructure, release 1.7.  Here we describe the status of LLVM, including any
+known problems and major improvements from the previous release.  The most
+up-to-date version of this document can be found on the <a
+href="http://llvm.org/releases/">LLVM releases web site</a>.  If you are
 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 the latest
-release, please check out the <a href="http://llvm.cs.uiuc.edu">main LLVM
+release, please check out the <a href="http://llvm.org/">main LLVM
 web site</a>.  If you have questions or comments, the <a
 href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM developer's mailing
 list</a> is a good place to send them.</p>
@@ -48,7 +48,7 @@ list</a> is a good place to send them.</p>
 <p>Note that if you are reading this file from CVS or the main LLVM web page,
 this document applies to the <i>next</i> release, not the current one.  To see
 the release notes for the current or previous releases, see the <a
-href="http://llvm.cs.uiuc.edu/releases/">releases page</a>.</p>
+href="http://llvm.org/releases/">releases page</a>.</p>
 
 </div>
 
@@ -60,117 +60,41 @@ href="http://llvm.cs.uiuc.edu/releases/">releases page</a>.</p>
 
 <div class="doc_text">
 
-<p>This is the sixth public release of the LLVM compiler infrastructure.</p>
-
-<p> At this time, LLVM is known to correctly compile a broad range of C and
-C++ programs, including the SPEC CPU95 &amp; 2000 suite. TODO.  It also includes
-bug fixes for those problems found since the 1.4 release.</p>
-
-</div>
-
-<!--=========================================================================-->
-<div class="doc_subsubsection">
-<a name="newfeatures">This release implements the following new features:</a>
-</div>
-
-<div class="doc_text">
-<ol>
-  <li>LLVM now includes an <a href="http://llvm.cs.uiuc.edu/PR415">
-      Interprocedural Sparse Conditional Constant Propagation</a> pass, named
-     -ipsccp, which is run by default at link-time.</li>
-  <li>LLVM 1.5 is now about 15% faster than LLVM 1.4 and its core data structures
-      use about 30% less memory.</li>
-  <li>LLVM includes new experimental native code generators for SparcV8 and 
-      Alpha.</li>
-  <li>Support for Microsoft Visual Studio is improved, and <a 
-      href="GettingStartedVS.html">now documented</a>.</li>
-</ol>
+<p>This is the seventh public release of the LLVM Compiler Infrastructure. This
+release incorporates a large number of enhancements and additions (primarily in
+the code generator), which combine to improve the quality of the code generated
+by LLVM by up to 30% in some cases.  This release is also the first release to
+have first-class support for Mac OS X: all of the major bugs have been shaken
+out and it is now as well supported as Linux on X86.</p>
 
 </div>
 
-
 <!--=========================================================================-->
-<div class="doc_subsubsection">
-In this release, the following missing features were implemented:
-</div>
-
-<div class="doc_text">
-
-<ol>
-   <li></li>
-</ol>
-
-</div>
-
-<!--=========================================================================-->
-<div class="doc_subsubsection">
-<a name="qualityofimp">In this release, the following Quality of Implementation
-issues were fixed:</a>
+<div class="doc_subsection">
+<a name="newfeatures">New Features in LLVM 1.7cvs</a>
 </div>
 
 <div class="doc_text">
-
-<ol>
-   <li><a href="http://llvm.cs.uiuc.edu/PR448">Building LLVM in optimized mode
-       should no longer cause GCC to hit swap in the PowerPC backend.</a></li>
-</ol>
+<ul>
+<li>New C front-end.</li>
+<li>New SPARC backend.</li>
+<li>Inline assembly support.</li>
+</ul>
 </div>
 
 <!--=========================================================================-->
-<div class="doc_subsubsection">
-<a name="codequality">This release includes the following Code Quality
-improvements:</a>
+<div class="doc_subsection">
+<a name="changes">Significant changes in LLVM 1.7cvs</a>
 </div>
 
 <div class="doc_text">
-<ol>
-   <li></li>
-</ol>
-</div>
-
-<!--=========================================================================-->
-<div class="doc_subsubsection">
-<a name="bugfix">In this release, the following bugs in the previous release
-were fixed:</a>
+<ul>
+<li>Removed the llvm.readport/llvm.writeport/llvm.readio/llvm.writeio
+    intrinsics.</li>
+<li>Separated the other intrinsics based on type.</li>
+</ul>
 </div>
 
-<div class="doc_text">
-
-
-<p>Bugs fixed in the LLVM Core:</p>
-<ol>
-   <li><a href="http://llvm.cs.uiuc.edu/PR491">[dse] DSE deletes stores that 
-       are partially overwritten by smaller stores</a></li>
-</ol>
-
-<p>Code Generator Bugs:</p>
-<ol>
-   <li><a href="http://llvm.cs.uiuc.edu/PR490">[cbackend] Logical constant 
-       expressions (and/or/xor) not implemented</a></li>
-   <li><a href="http://llvm.cs.uiuc.edu/PR511">[cbackend] C backend does not 
-       respect 'volatile'</a></li>
-</ol>
-
-<p>Bugs in the C/C++ front-end:</p>
-<ol>
-   <li><a href="http://llvm.cs.uiuc.edu/PR487">[llvmgcc] llvm-gcc incorrectly 
-       rejects some constant initializers involving the addresses of array 
-       elements</a></li>
-   <li><a href="http://llvm.cs.uiuc.edu/PR501">[llvm-g++] Crash compiling 
-       anonymous union</a></li>
-   <li><a href="http://llvm.cs.uiuc.edu/PR509">[llvm-g++] Do not use dynamic 
-       initialization where static init will do</a></li>
-   <li><a href="http://llvm.cs.uiuc.edu/PR510">[llvmgcc] Field offset 
-       miscalculated for some structure fields following bit fields</a></li>
-   <li><a href="http://llvm.cs.uiuc.edu/PR513">[llvm-g++] Temporary lifetimes 
-       incorrect for short circuit logical operations</a></li>
-   <li><a href="http://llvm.cs.uiuc.edu/PR517">[llvm-gcc] Crash compiling 
-       bitfield &lt;-&gt; aggregate assignment</a></li>
-   <li><a href="http://llvm.cs.uiuc.edu/PR520">[llvm-g++] Error compiling 
-       virtual function thunk with an unnamed argument</a></li>
-</ol>
-
-</div>
 
 <!-- *********************************************************************** -->
 <div class="doc_section">
@@ -183,12 +107,14 @@ were fixed:</a>
 <p>LLVM is known to work on the following platforms:</p>
 
 <ul>
-<li>Intel and AMD machines running Red Hat Linux and FreeBSD (and probably 
-    other unix-like systems).</li>
+  <li>Intel and AMD machines running Red Hat Linux, Fedora Core and FreeBSD 
+      (and probably other unix-like systems).</li>
 <li>Sun UltraSPARC workstations running Solaris 8.</li>
 <li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
     support is available for native builds with Visual C++).</li>
-<li>PowerPC-based Mac OS X systems, running 10.2 and above.</li>
+<li>PowerPC and X86-based Mac OS X systems, running 10.2 and above.</li>
+<li>Alpha-based machines running Debian GNU/Linux.</li>
+<li>Itanium-based machines running Linux and HP-UX.</li>
 </ul>
 
 <p>The core LLVM infrastructure uses
@@ -210,7 +136,7 @@ portability patches and reports of successful builds or 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.org/bugs/">LLVM bug database</a> and submit a bug if
 there isn't already one.</p>
 
 </div>
@@ -230,16 +156,28 @@ components, please contact us on the llvmdev list.</p>
 
 <ul>
 <li>The following passes are incomplete or buggy, and may be removed in future
-    releases: <tt>-cee, -branch-combine, -instloops, -paths, -pre</tt></li>
+    releases: <tt>-cee</tt></li>
 <li>The <tt>llvm-db</tt> tool is in a very early stage of development, but can
     be used to step through programs and inspect the stack.</li>
-<li>The "iterative scan" register allocator (enabled with -regalloc=iterativescan)
-    is not stable.</li>
-<li>The SparcV8 and Alpha ports are experimental.</li>
+<li>The IA64 code generator is experimental.</li>
+<li>The Alpha JIT is experimental.</li>
 </ul>
 
 </div>
 
+<!-- ======================================================================= -->
+<div class="doc_subsection">
+  <a name="build">Known problems with the Build System</a>
+</div>
+
+<div class="doc_text">
+
+<ul>
+  <li>The <a href="http://llvm.org/PR656">configure script sometimes fails on Solaris/Sparc</a>. A work around is documented in <a href="http://llvm.org/PR656">PR656.</a></li>
+</ul>
+</div>
+
+
 <!-- ======================================================================= -->
 <div class="doc_subsection">
   <a name="core">Known problems with the LLVM Core</a>
@@ -248,16 +186,8 @@ components, please contact us on the llvmdev list.</p>
 <div class="doc_text">
 
 <ul>
-  <li>In the JIT, <tt>dlsym</tt> on a symbol compiled by the JIT will not work.
-  </li>
-  <li>The JIT does not use mutexes to protect its internal data structures. As
-  such, execution of a threaded program could cause these data structures to be
-  corrupted.
-  </li>
-  <li><a href="http://llvm.cs.uiuc.edu/PR240">The lower-invoke pass does not 
-    mark values live across a setjmp as volatile</a>. This missing feature 
-  only affects targets whose setjmp/longjmp libraries do not save and restore 
-  the entire register file.</li>
+  <li>In the JIT, <tt>dlsym()</tt> on a symbol compiled by the JIT will not
+  work.</li>
 </ul>
 </div>
 
@@ -270,6 +200,10 @@ components, please contact us on the llvmdev list.</p>
 <div class="doc_subsubsection">Bugs</div>
 
 <div class="doc_text">
+
+These bugs are known for the old front-end.  The new GCC-4-based C front-end
+suffers from none of these.
+
 <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:
@@ -281,7 +215,7 @@ components, please contact us on the llvmdev list.</p>
 </pre></li>
 
 <li>Initialization of global union variables can only be done <a
-href="http://llvm.cs.uiuc.edu/PR162">with the largest union member</a>.</li>
+href="http://llvm.org/PR162">with the largest union member</a>.</li>
 
 </ul>
 </div>
@@ -295,8 +229,6 @@ href="http://llvm.cs.uiuc.edu/PR162">with the largest union member</a>.</li>
 
 <ul>
 
-<li>Inline assembly is not yet supported.</li>
-
 <li>"long double" is transformed by the front-end into "double".  There is no
 support for floating point data types of any size other than 32 and 64
 bits.</li>
@@ -345,14 +277,14 @@ work:
 
       <b>Supported:</b> <tt>format</tt>, <tt>format_arg</tt>, <tt>non_null</tt>,
       <tt>noreturn</tt>, <tt>constructor</tt>, <tt>destructor</tt>,
-      <tt>unused</tt>,
+      <tt>unused</tt>, <tt>used</tt>,
       <tt>deprecated</tt>, <tt>warn_unused_result</tt>, <tt>weak</tt><br>
 
       <b>Ignored:</b> <tt>noinline</tt>,
       <tt>always_inline</tt>, <tt>pure</tt>, <tt>const</tt>, <tt>nothrow</tt>,
       <tt>malloc</tt>, <tt>no_instrument_function</tt>, <tt>cdecl</tt><br>
 
-      <b>Unsupported:</b> <tt>used</tt>, <tt>section</tt>, <tt>alias</tt>,
+      <b>Unsupported:</b> <tt>section</tt>, <tt>alias</tt>,
       <tt>visibility</tt>, <tt>regparm</tt>, <tt>stdcall</tt>,
       <tt>fastcall</tt>, all other target specific attributes</li>
    
@@ -360,7 +292,7 @@ work:
       Specifying attributes of variables.<br>
       <b>Supported:</b> <tt>cleanup</tt>, <tt>common</tt>, <tt>nocommon</tt>,
                         <tt>deprecated</tt>, <tt>transparent_union</tt>,
-                        <tt>unused</tt>, <tt>weak</tt><br>
+                        <tt>unused</tt>, <tt>used</tt>, <tt>weak</tt><br>
 
       <b>Unsupported:</b> <tt>aligned</tt>, <tt>mode</tt>, <tt>packed</tt>,
                         <tt>section</tt>, <tt>shared</tt>, <tt>tls_model</tt>,
@@ -381,7 +313,9 @@ work:
          <tt>__builtin_types_compatible_p</tt>, <tt>__builtin_choose_expr</tt>,
          <tt>__builtin_constant_p</tt>, and <tt>__builtin_expect</tt>
          (currently ignored).  We also support builtins for ISO C99 floating
-         point comparison macros (e.g., <tt>__builtin_islessequal</tt>).</li>
+         point comparison macros (e.g., <tt>__builtin_islessequal</tt>), 
+         <tt>__builtin_prefetch</tt>, <tt>__builtin_popcount[ll]</tt>,
+         <tt>__builtin_clz[ll]</tt>, and <tt>__builtin_ctz[ll]</tt>.</li>
   </ol>
 
   <p>The following extensions <b>are</b> known to be supported:</p>
@@ -451,12 +385,6 @@ itself.</p>
 <li>The C++ front-end inherits all problems afflicting the <a href="#c-fe">C
     front-end</a>.</li>
 
-<li><b>IA-64 specific</b>: The C++ front-end does not use <a 
-href="http://llvm.cs.uiuc.edu/PR406">IA64 ABI compliant layout of v-tables</a>.
-In particular, it just stores function pointers instead of function
-descriptors in the vtable.  This bug prevents mixing C++ code compiled with
-LLVM with C++ objects compiled by other C++ compilers.</li>
-
 </ul>
 
 </div>
@@ -496,6 +424,28 @@ href="http://gcc.gnu.org/gcc-3.4/changes.html">GCC 3.4 release notes</a>.</li>
 
 </div>
 
+<!-- ======================================================================= -->
+<div class="doc_subsection">
+  <a name="c-be">Known problems with the C back-end</a>
+</div>
+
+<div class="doc_text">
+
+<ul>
+
+<li>The C back-end produces code that violates the ANSI C Type-Based Alias
+Analysis rules.  As such, special options may be necessary to compile the code
+(for example, GCC requires the <tt>-fno-strict-aliasing</tt> option).  This
+problem probably cannot be fixed.</li>
+
+<li><a href="http://llvm.org/PR56">Zero arg vararg functions are not 
+supported</a>.  This should not affect LLVM produced by the C or C++ 
+frontends.</li>
+
+</ul>
+
+</div>
+
 <!-- ======================================================================= -->
 <div class="doc_subsection">
   <a name="x86-be">Known problems with the X86 back-end</a>
@@ -504,7 +454,20 @@ href="http://gcc.gnu.org/gcc-3.4/changes.html">GCC 3.4 release notes</a>.</li>
 <div class="doc_text">
 
 <ul>
-  <li>none yet</li>
+<li>None yet</li>
+</ul>
+
+</div>
+
+<!-- ======================================================================= -->
+<div class="doc_subsection">
+  <a name="ppc-be">Known problems with the PowerPC back-end</a>
+</div>
+
+<div class="doc_text">
+
+<ul>
+<li>None yet</li>
 </ul>
 
 </div>
@@ -517,7 +480,7 @@ href="http://gcc.gnu.org/gcc-3.4/changes.html">GCC 3.4 release notes</a>.</li>
 <div class="doc_text">
 
 <ul>
-<li><a href="http://llvm.cs.uiuc.edu/PR60">[sparcv9] SparcV9 backend miscompiles
+<li><a href="http://llvm.org/PR60">[sparcv9] SparcV9 backend miscompiles
 several programs in the LLVM test suite</a></li>
 </ul>
 
@@ -525,39 +488,62 @@ several programs in the LLVM test suite</a></li>
 
 <!-- ======================================================================= -->
 <div class="doc_subsection">
-  <a name="ppc-be">Known problems with the PowerPC back-end</a>
+  <a name="alpha-be">Known problems with the Alpha back-end</a>
 </div>
 
 <div class="doc_text">
 
 <ul>
-<li>none yet</li>
+
+<li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
+appropriate nops inserted to ensure restartability.</li>
+
 </ul>
 
 </div>
 
 <!-- ======================================================================= -->
 <div class="doc_subsection">
-  <a name="c-be">Known problems with the C back-end</a>
+  <a name="ia64-be">Known problems with the IA64 back-end</a>
 </div>
 
 <div class="doc_text">
 
 <ul>
 
-<li>The C back-end produces code that violates the ANSI C Type-Based Alias
-Analysis rules.  As such, special options may be necessary to compile the code
-(for example, GCC requires the <tt>-fno-strict-aliasing</tt> option).  This
-problem probably cannot be fixed.</li>
+<li>C++ programs are likely to fail on IA64, as calls to <tt>setjmp</tt> are
+made where the argument is not 16-byte aligned, as required on IA64. (Strictly
+speaking this is not a bug in the IA64 back-end; it will also be encountered
+when building C++ programs using the C back-end.)</li>
 
-<li><a href="http://llvm.cs.uiuc.edu/PR56">Zero arg vararg functions are not 
-supported</a>.  This should not affect LLVM produced by the C or C++ 
-frontends.</li>
+<li>The C++ front-end does not use <a href="http://llvm.org/PR406">IA64
+ABI compliant layout of v-tables</a>.  In particular, it just stores function
+pointers instead of function descriptors in the vtable.  This bug prevents
+mixing C++ code compiled with LLVM with C++ objects compiled by other C++
+compilers.</li>
+
+<li>There are a few ABI violations which will lead to problems when mixing LLVM
+output with code built with other compilers, particularly for floating-point
+programs.</li>
+
+<li>Defining vararg functions is not supported (but calling them is ok).</li>
 
 </ul>
 
 </div>
 
+<!-- ======================================================================= -->
+<div class="doc_subsection">
+  <a name="sparc">Known problems with the SPARC back-end</a>
+</div>
+
+<div class="doc_text">
+
+<ul>
+<li>None yet.</li>
+</ul>
+</div>
+
 <!-- *********************************************************************** -->
 <div class="doc_section">
   <a name="additionalinfo">Additional Information</a>
@@ -566,15 +552,17 @@ frontends.</li>
 
 <div class="doc_text">
 
-<p>A wide variety of additional information is available on the LLVM web page,
-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
-the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
+<p>A wide variety of additional information is available on the <a
+href="http://llvm.org">LLVM web page</a>, including <a
+href="http://llvm.org/docs/">documentation</a> and <a
+href="http://llvm.org/pubs/">publications describing algorithms and
+components implemented in LLVM</a>.  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 the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
 
 <p>If you have any questions or comments about LLVM, please feel free to contact
-us via the <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">mailing
+us via the <a href="http://llvm.org/docs/#maillist"> mailing
 lists</a>.</p>
 
 </div>
@@ -588,7 +576,7 @@ lists</a>.</p>
   <a href="http://validator.w3.org/check/referer"><img
   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
 
-  <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br>
+  <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br>
   Last modified: $Date$
 </address>