docs/ReleaseNotes.rst

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