[Cygwin] Enable TLS as emutls.
[oota-llvm.git] / docs / ReleaseNotes.rst
index 5f40a2c453c8714103aaad68a89838d2571ab51d..b3f7c005ed1914ff9aa75c01c78d12700abb33e8 100644 (file)
@@ -1,13 +1,13 @@
 ======================
-LLVM 3.6 Release Notes
+LLVM 3.8 Release Notes
 ======================
 
 .. contents::
     :local:
 
 .. warning::
-   These are in-progress notes for the upcoming LLVM 3.6 release.  You may
-   prefer the `LLVM 3.5 Release Notes <http://llvm.org/releases/3.5.0/docs
+   These are in-progress notes for the upcoming LLVM 3.8 release.  You may
+   prefer the `LLVM 3.7 Release Notes <http://llvm.org/releases/3.7.0/docs
    /ReleaseNotes.html>`_.
 
 
@@ -15,7 +15,7 @@ Introduction
 ============
 
 This document contains the release notes for the LLVM Compiler Infrastructure,
-release 3.6.  Here we describe the status of LLVM, including major improvements
+release 3.8.  Here we describe the status of LLVM, including major improvements
 from the previous release, improvements in various subprojects of LLVM, and
 some of the current users of the code.  All LLVM releases may be downloaded
 from the `LLVM releases web site <http://llvm.org/releases/>`_.
@@ -23,7 +23,7 @@ from the `LLVM releases web site <http://llvm.org/releases/>`_.
 For more information about LLVM, including information about the latest
 release, please check out the `main LLVM web site <http://llvm.org/>`_.  If you
 have questions or comments, the `LLVM Developer's Mailing List
-<http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev>`_ is a good place to send
+<http://lists.llvm.org/mailman/listinfo/llvm-dev>`_ is a good place to send
 them.
 
 Note that if you are reading this file from a Subversion checkout or the main
@@ -33,6 +33,40 @@ page <http://llvm.org/releases/>`_.
 
 Non-comprehensive list of changes in this release
 =================================================
+* With this release, the minimum Windows version required for running LLVM is
+  Windows 7. Earlier versions, including Windows Vista and XP are no longer
+  supported.
+
+* With this release, the autoconf build system is deprecated. It will be removed
+  in the 3.9 release. Please migrate to using CMake. For more information see:
+  `Building LLVM with CMake <CMake.html>`_
+
+* The C API function LLVMLinkModules is deprecated. It will be removed in the
+  3.9 release. Please migrate to LLVMLinkModules2. Unlike the old function the
+  new one
+
+   * Doesn't take an unused parameter.
+   * Destroys the source instead of only damaging it.
+   * Does not record a message. Use the diagnostic handler instead.
+
+* The C API functions LLVMParseBitcode, LLVMParseBitcodeInContext,
+  LLVMGetBitcodeModuleInContext and LLVMGetBitcodeModule have been deprecated.
+  They will be removed in 3.9. Please migrate to the versions with a 2 suffix.
+  Unlike the old ones the new ones do not record a diagnostic message. Use
+  the diagnostic handler instead.
+
+* The deprecated C APIs LLVMGetBitcodeModuleProviderInContext and
+  LLVMGetBitcodeModuleProvider have been removed.
+
+* The deprecated C APIs LLVMCreateExecutionEngine, LLVMCreateInterpreter,
+  LLVMCreateJITCompiler, LLVMAddModuleProvider and LLVMRemoveModuleProvider
+  have been removed.
+
+* With this release, the C API headers have been reorganized to improve build
+  time. Type specific declarations have been moved to Type.h, and error
+  handling routines have been moved to ErrorHandling.h. Both are included in
+  Core.h so nothing should change for projects directly including the headers,
+  but transitive dependencies may be affected.
 
 .. NOTE
    For small 1-3 sentence descriptions, just add an entry at the end of
@@ -41,11 +75,6 @@ Non-comprehensive list of changes in this release
    functionality, or simply have a lot to talk about), see the `NOTE` below
    for adding a new subsection.
 
-* Support for AuroraUX has been removed.
-
-* Added support for a `native object file-based bitcode wrapper format
-  <BitCodeFormat.html#native-object-file>`_.
-
 * ... next change ...
 
 .. NOTE
@@ -58,50 +87,6 @@ Non-comprehensive list of changes in this release
 
    Makes programs 10x faster by doing Special New Thing.
 
-Prefix data rework
-------------------
-
-The semantics of the ``prefix`` attribute have been changed. Users
-that want the previous ``prefix`` semantics should instead use
-``prologue``.  To motivate this change, let's examine the primary
-usecases that these attributes aim to serve,
-
-  1. Code sanitization metadata (e.g. Clang's undefined behavior
-     sanitizer)
-
-  2. Function hot-patching: Enable the user to insert ``nop`` operations
-     at the beginning of the function which can later be safely replaced
-     with a call to some instrumentation facility.
-
-  3. Language runtime metadata: Allow a compiler to insert data for
-     use by the runtime during execution. GHC is one example of a
-     compiler that needs this functionality for its
-     tables-next-to-code functionality.
-
-Previously ``prefix`` served cases (1) and (2) quite well by allowing the user
-to introduce arbitrary data at the entrypoint but before the function
-body. Case (3), however, was poorly handled by this approach as it
-required that prefix data was valid executable code.
-
-In this release the concept of prefix data has been redefined to be
-data which occurs immediately before the function entrypoint (i.e. the
-symbol address). Since prefix data now occurs before the function
-entrypoint, there is no need for the data to be valid code.
-
-The previous notion of prefix data now goes under the name "prologue
-data" to emphasize its duality with the function epilogue.
-
-The intention here is to handle cases (1) and (2) with prologue data and
-case (3) with prefix data. See the language reference for further details
-on the semantics of these attributes.
-
-This refactoring arose out of discussions_ with Reid Kleckner in
-response to a proposal to introduce the notion of symbol offsets to
-enable handling of case (3).
-
-.. _discussions: http://lists.cs.uiuc.edu/pipermail/llvmdev/2014-May/073235.html
-
-
 Changes to the ARM Backend
 --------------------------
 
@@ -111,86 +96,38 @@ Changes to the ARM Backend
 Changes to the MIPS Target
 --------------------------
 
-During this release the MIPS target has reached a few major milestones. It has
-gained support for MIPS-II and MIPS-III, become ABI-compatible with GCC for big
-and little endian O32, N32, and N64, and we are now able to compile the Linux
-kernel for 32-bit targets.
-
-ABI
-^^^
-
-A large number of bugs have been fixed for big-endian MIPS targets using the
-N32 and N64 ABI's as well as a small number of bugs affecting other ABI's.
-Please note that some of these bugs will still affect LLVM-IR generated by
-LLVM 3.5 since correct code generation depends on appropriate usage of the
-``inreg``, ``signext``, and ``zeroext`` attributes on all function arguments
-and returns.
-
-There are far too many corrections to provide a complete list but here are a
-few notable ones:
-
-* Big-endian N32 and N64 now interlinks successfully with GCC compiled code.
-  Previously this didn't work for the majority of cases.
-
-* The registers used to return a structure containing a single 128-bit floating
-  point member on the N32/N64 ABI's have been changed from those specified by
-  the ABI documentation to match those used by GCC. The documentation specifies
-  that ``$f0`` and ``$f2`` should be used but GCC has used ``$f0`` and ``$f1``
-  for many years.
-
-* Returning a zero-byte struct no longer causes arguments to be read from the
-  wrong registers when using the O32 ABI.
-
-* The exception personality has been changed for 64-bit MIPS targets to
-  eliminate warnings about relocations in a read-only section.
-
-* Incorrect usage of odd-numbered single-precision floating point registers
-  has been fixed when the fastcc calling convention is used with 64-bit FPU's
-  and -mno-odd-spreg.
+ During this release ...
 
-LLVMLinux
-^^^^^^^^^
 
-It is now possible to compile the Linux kernel. This currently requires a small
-number of kernel patches. See the `LLVMLinux project
-<http://llvm.linuxfoundation.org/index.php/Main_Page>`_ for details.
+Changes to the PowerPC Target
+-----------------------------
 
-* Added -mabicalls and -mno-abicalls. The implementation may not be complete
-  but works sufficiently well for the Linux kernel.
+ During this release ...
 
-* Fixed multiple compatibility issues between LLVM's inline assembly support
-  and GCC's.
 
-* Added support for a number of directives used by Linux to the Integrated
-  Assembler.
+Changes to the X86 Target
+-----------------------------
 
-Miscellaneous
-^^^^^^^^^^^^^
+ During this release ...
 
-* Attempting to disassemble l[wd]c[23], s[wd]c[23], cache, and pref no longer
-  triggers an assertion.
+* TLS is enabled for Cygwin as emutls.
 
-* Added -muclibc and -mglibc to support toolchains that provide both uClibC and
-  GLibC.
 
-* __SIZEOF_INT128__ is no longer defined for 64-bit targets since 128-bit
-  integers do not work at this time for this target.
+Changes to the OCaml bindings
+-----------------------------
 
-* Using $t4-$t7 with the N32 and N64 ABI is deprecated when ``-fintegrated-as``
-  is in use and will be removed in LLVM 3.7. These names have never been
-  supported by the GNU Assembler for these ABI's.
+ During this release ...
 
-Changes to the PowerPC Target
------------------------------
+* The ocaml function link_modules has been replaced with link_modules' which
+  uses LLVMLinkModules2.
 
-During this release ...
 
-External Open Source Projects Using LLVM 3.6
+External Open Source Projects Using LLVM 3.8
 ============================================
 
 An exciting aspect of LLVM is that it is used as an enabling technology for
 a lot of other language and tools projects. This section lists some of the
-projects that have already been updated to work with LLVM 3.6.
+projects that have already been updated to work with LLVM 3.8.
 
 * A project