docs/ReleaseNotes.rst

   1 ======================
   2 LLVM 3.8 Release Notes
   3 ======================
   4
   5 .. contents::
   6     :local:
   7
   8 .. warning::
   9    These are in-progress notes for the upcoming LLVM 3.8 release.  You may
  10    prefer the `LLVM 3.7 Release Notes <http://llvm.org/releases/3.7.0/docs
  11    /ReleaseNotes.html>`_.
  12
  13
  14 Introduction
  15 ============
  16
  17 This document contains the release notes for the LLVM Compiler Infrastructure,
  18 release 3.8.  Here we describe the status of LLVM, including major improvements
  19 from the previous release, improvements in various subprojects of LLVM, and
  20 some of the current users of the code.  All LLVM releases may be downloaded
  21 from the `LLVM releases web site <http://llvm.org/releases/>`_.
  22
  23 For more information about LLVM, including information about the latest
  24 release, please check out the `main LLVM web site <http://llvm.org/>`_.  If you
  25 have questions or comments, the `LLVM Developer's Mailing List
  26 <http://lists.llvm.org/mailman/listinfo/llvm-dev>`_ is a good place to send
  27 them.
  28
  29 Note that if you are reading this file from a Subversion checkout or the main
  30 LLVM web page, this document applies to the *next* release, not the current
  31 one.  To see the release notes for a specific release, please see the `releases
  32 page <http://llvm.org/releases/>`_.
  33
  34 Non-comprehensive list of changes in this release
  35 =================================================
  36 * With this release, the minimum Windows version required for running LLVM is
  37   Windows 7. Earlier versions, including Windows Vista and XP are no longer
  38   supported.
  39
  40 * With this release, the autoconf build system is deprecated. It will be removed
  41   in the 3.9 release. Please migrate to using CMake. For more information see:
  42   `Building LLVM with CMake <CMake.html>`_
  43
  44 * The C API function LLVMLinkModules is deprecated. It will be removed in the
  45   3.9 release. Please migrate to LLVMLinkModules2. Unlike the old function the
  46   new one
  47
  48    * Doesn't take an unused parameter.
  49    * Destroys the source instead of only damaging it.
  50    * Does not record a message. Use the diagnostic handler instead.
  51
  52 * The C API functions LLVMParseBitcode, LLVMParseBitcodeInContext,
  53   LLVMGetBitcodeModuleInContext and LLVMGetBitcodeModule have been deprecated.
  54   They will be removed in 3.9. Please migrate to the versions with a 2 suffix.
  55   Unlike the old ones the new ones do not record a diagnostic message. Use
  56   the diagnostic handler instead.
  57
  58 * The deprecated C APIs LLVMGetBitcodeModuleProviderInContext and
  59   LLVMGetBitcodeModuleProvider have been removed.
  60
  61 * The deprecated C APIs LLVMCreateExecutionEngine, LLVMCreateInterpreter,
  62   LLVMCreateJITCompiler, LLVMAddModuleProvider and LLVMRemoveModuleProvider
  63   have been removed.
  64
  65 * With this release, the C API headers have been reorganized to improve build
  66   time. Type specific declarations have been moved to Type.h, and error
  67   handling routines have been moved to ErrorHandling.h. Both are included in
  68   Core.h so nothing should change for projects directly including the headers,
  69   but transitive dependencies may be affected.
  70
  71 * llvm-ar now suports thin archives.
  72
  73 * llvm doesn't produce .data.rel.ro.local or .data.rel sections anymore.
  74
  75 * aliases to available_externally globals are now rejected by the verifier.
  76
  77 * the IR Linker has been split into IRMover that moves bits from one module to
  78   another and Linker proper that decides what to link.
  79
  80 * Support for dematerializing has been dropped.
  81
  82 .. NOTE
  83    For small 1-3 sentence descriptions, just add an entry at the end of
  84    this list. If your description won't fit comfortably in one bullet
  85    point (e.g. maybe you would like to give an example of the
  86    functionality, or simply have a lot to talk about), see the `NOTE` below
  87    for adding a new subsection.
  88
  89 * ... next change ...
  90
  91 .. NOTE
  92    If you would like to document a larger change, then you can add a
  93    subsection about it right here. You can copy the following boilerplate
  94    and un-indent it (the indentation causes it to be inside this comment).
  95
  96    Special New Feature
  97    -------------------
  98
  99    Makes programs 10x faster by doing Special New Thing.
 100
 101 Changes to the ARM Backend
 102 --------------------------
 103
 104  During this release ...
 105
 106
 107 Changes to the MIPS Target
 108 --------------------------
 109
 110 During this release the MIPS target has:
 111
 112 * Significantly extended support for the Integrated Assembler. See below for
 113   more information
 114 * Added support for the ``P5600`` processor.
 115 * Added support for the ``interrupt`` attribute for MIPS32R2 and later. This
 116   attribute will generate a function which can be used as a interrupt handler
 117   on bare metal MIPS targets using the static relocation model.
 118 * Added support for the ``ERETNC`` instruction found in MIPS32R5 and later.
 119 * Added support for OpenCL. See http://portablecl.org/.
 120
 121   * Address spaces 1 to 255 are now reserved for software use and conversions
 122     between them are no-op casts.
 123
 124 * Removed the ``mips16`` value for the -mcpu option since it is an :abbr:`ASE
 125   (Application Specific Extension)` and not a processor. If you were using this,
 126   please specify another CPU and use ``-mips16`` to enable MIPS16.
 127 * Removed ``copy_u.w`` from 32-bit MSA and ``copy_u.d`` from 64-bit MSA since
 128   they have been removed from the MSA specification due to forward compatibility
 129   issues.  For example, 32-bit MSA code containing ``copy_u.w`` would behave
 130   differently on a 64-bit processor supporting MSA. The corresponding intrinsics
 131   are still available and may expand to ``copy_s.[wd]`` where this is
 132   appropriate for forward compatibility purposes.
 133 * Relaxed the ``-mnan`` option to allow ``-mnan=2008`` on MIPS32R2/MIPS64R2 for
 134   compatibility with GCC.
 135 * Made MIPS64R6 the default CPU for 64-bit Android triples.
 136
 137 The MIPS target has also fixed various bugs including the following notable
 138 fixes:
 139
 140 * Fixed reversed operands on ``mthi``/``mtlo`` in the DSP :abbr:`ASE
 141   (Application Specific Extension)`.
 142 * The code generator no longer uses ``jal`` for calls to absolute immediate
 143   addresses.
 144 * Disabled fast instruction selection on MIPS32R6 and MIPS64R6 since this is not
 145   yet supported.
 146 * Corrected addend for ``R_MIPS_HI16`` and ``R_MIPS_PCHI16`` in MCJIT
 147 * The code generator no longer crashes when handling subregisters of an 64-bit
 148   FPU register with undefined value.
 149 * The code generator no longer attempts to use ``$zero`` for operands that do
 150   not permit ``$zero``.
 151 * Corrected the opcode used for ``ll``/``sc`` when using MIPS32R6/MIPS64R6 and
 152   the Integrated Assembler.
 153 * Added support for atomic load and atomic store.
 154 * Corrected debug info when dynamically re-aligning the stack.
 155
 156 Integrated Assembler
 157 ^^^^^^^^^^^^^^^^^^^^
 158 We have made a large number of improvements to the integrated assembler for
 159 MIPS. In this release, the integrated assembler isn't quite production-ready
 160 since there are a few known issues related to bare-metal support, checking
 161 immediates on instructions, and the N32/N64 ABI's. However, the current support
 162 should be sufficient for many users of the O32 ABI, particularly those targeting
 163 MIPS32 on Linux or bare-metal MIPS32.
 164
 165 If you would like to try the integrated assembler, please use
 166 ``-fintegrated-as``.
 167
 168 Changes to the PowerPC Target
 169 -----------------------------
 170
 171  During this release ...
 172
 173
 174 Changes to the X86 Target
 175 -----------------------------
 176
 177  During this release ...
 178
 179 * TLS is enabled for Cygwin as emutls.
 180
 181
 182 Changes to the OCaml bindings
 183 -----------------------------
 184
 185  During this release ...
 186
 187 * The ocaml function link_modules has been replaced with link_modules' which
 188   uses LLVMLinkModules2.
 189
 190
 191 External Open Source Projects Using LLVM 3.8
 192 ============================================
 193
 194 An exciting aspect of LLVM is that it is used as an enabling technology for
 195 a lot of other language and tools projects. This section lists some of the
 196 projects that have already been updated to work with LLVM 3.8.
 197
 198 * A project
 199
 200
 201 Additional Information
 202 ======================
 203
 204 A wide variety of additional information is available on the `LLVM web page
 205 <http://llvm.org/>`_, in particular in the `documentation
 206 <http://llvm.org/docs/>`_ section.  The web page also contains versions of the
 207 API documentation which is up-to-date with the Subversion version of the source
 208 code.  You can access versions of these documents specific to this release by
 209 going into the ``llvm/docs/`` directory in the LLVM tree.
 210
 211 If you have any questions or comments about LLVM, please feel free to contact
 212 us via the `mailing lists <http://llvm.org/docs/#maillist>`_.
 213