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 * RegisterScheduler::setDefault was removed. Targets that used to call into the
  73   command line parser to set the DAGScheduler, and that don't have enough
  74   control with setSchedulingPreference, should look into overriding the
  75   SubTargetHook "getDAGScheduler()".
  76
  77 * ``ilist_iterator<T>`` no longer has implicit conversions to and from ``T*``,
  78   since ``ilist_iterator<T>`` may be pointing at the sentinel (which is usually
  79   not of type ``T`` at all).  To convert from an iterator ``I`` to a pointer,
  80   use ``&*I``; to convert from a pointer ``P`` to an iterator, use
  81   ``P->getIterator()``.  Alternatively, explicit conversions via
  82   ``static_cast<T>(U)`` are still available.
  83
  84 * ``ilist_node<T>::getNextNode()`` and ``ilist_node<T>::getPrevNode()`` now
  85   fail at compile time when the node cannot access its parent list.
  86   Previously, when the sentinel was was an ``ilist_half_node<T>``, this API
  87   could return the sentinal instead of ``nullptr``.  Frustrated callers should
  88   be updated to use ``iplist<T>::getNextNode(T*)`` instead.  Alternatively, if
  89   the node ``N`` is guaranteed not to be the last in the list, it is safe to
  90   call ``&*++N->getIterator()`` directly.
  91
  92 * The `Kaleidoscope tutorials <tutorial/index.html>`_ have been updated to use
  93   the ORC JIT APIs.
  94
  95 * ORC now has a basic set of C bindings.
  96
  97 * Optional support for linking clang and the LLVM tools with a single libLLVM
  98   shared library. To enable this, pass ``-DLLVM_LINK_LLVM_DYLIB=ON`` to CMake.
  99   See `Building LLVM with CMake`_ for more details.
 100
 101 * The optimization to move the prologue and epilogue of functions in colder
 102   code path (shrink-wrapping) is now enabled by default.
 103
 104 .. NOTE
 105    For small 1-3 sentence descriptions, just add an entry at the end of
 106    this list. If your description won't fit comfortably in one bullet
 107    point (e.g. maybe you would like to give an example of the
 108    functionality, or simply have a lot to talk about), see the `NOTE` below
 109    for adding a new subsection.
 110
 111 * ... next change ...
 112
 113 .. NOTE
 114    If you would like to document a larger change, then you can add a
 115    subsection about it right here. You can copy the following boilerplate
 116    and un-indent it (the indentation causes it to be inside this comment).
 117
 118    Special New Feature
 119    -------------------
 120
 121    Makes programs 10x faster by doing Special New Thing.
 122
 123
 124 Changes to the ARM Backends
 125 ---------------------------
 126
 127 During this release the AArch64 target has:
 128
 129 * Added support for more sanitizers (MSAN, TSAN) and made them compatible with
 130   all VMA kernel configurations (currently tested on 39 and 42 bits).
 131 * Gained initial LLD support in the new ELF back-end
 132 * Extended the Load/Store optimiser and cleaned up some of the bad decisions
 133   made earlier.
 134 * Expanded LLDB support, including watchpoints, native building, Renderscript,
 135   LLDB-server, debugging 32-bit applications.
 136 * Added support for the ``Exynos M1`` chip.
 137
 138 During this release the ARM target has:
 139
 140 * Gained massive performance improvements on embedded benchmarks due to finally
 141   running the stride vectorizer in full form, incrementing the performance gains
 142   that we already had in the previous releases with limited stride vectorization.
 143 * Expanded LLDB support, including watchpoints, unwind tables
 144 * Extended the Load/Store optimiser and cleaned up some of the bad decisions
 145   made earlier.
 146 * Simplified code generation for global variable addresses in ELF, resulting in
 147   a significant (4% in Chromium) reduction in code size.
 148 * Gained some additional code size improvements, though there's still a long road
 149   ahead, especially for older cores.
 150 * Added some EABI floating point comparison functions to Compiler-RT
 151 * Added support for Windows+GNU triple, +features in -mcpu/-march options.
 152
 153
 154 Changes to the MIPS Target
 155 --------------------------
 156
 157 During this release the MIPS target has:
 158
 159 * Significantly extended support for the Integrated Assembler. See below for
 160   more information
 161 * Added support for the ``P5600`` processor.
 162 * Added support for the ``interrupt`` attribute for MIPS32R2 and later. This
 163   attribute will generate a function which can be used as a interrupt handler
 164   on bare metal MIPS targets using the static relocation model.
 165 * Added support for the ``ERETNC`` instruction found in MIPS32R5 and later.
 166 * Added support for OpenCL. See http://portablecl.org/.
 167
 168   * Address spaces 1 to 255 are now reserved for software use and conversions
 169     between them are no-op casts.
 170
 171 * Removed the ``mips16`` value for the -mcpu option since it is an :abbr:`ASE
 172   (Application Specific Extension)` and not a processor. If you were using this,
 173   please specify another CPU and use ``-mips16`` to enable MIPS16.
 174 * Removed ``copy_u.w`` from 32-bit MSA and ``copy_u.d`` from 64-bit MSA since
 175   they have been removed from the MSA specification due to forward compatibility
 176   issues.  For example, 32-bit MSA code containing ``copy_u.w`` would behave
 177   differently on a 64-bit processor supporting MSA. The corresponding intrinsics
 178   are still available and may expand to ``copy_s.[wd]`` where this is
 179   appropriate for forward compatibility purposes.
 180 * Relaxed the ``-mnan`` option to allow ``-mnan=2008`` on MIPS32R2/MIPS64R2 for
 181   compatibility with GCC.
 182 * Made MIPS64R6 the default CPU for 64-bit Android triples.
 183
 184 The MIPS target has also fixed various bugs including the following notable
 185 fixes:
 186
 187 * Fixed reversed operands on ``mthi``/``mtlo`` in the DSP :abbr:`ASE
 188   (Application Specific Extension)`.
 189 * The code generator no longer uses ``jal`` for calls to absolute immediate
 190   addresses.
 191 * Disabled fast instruction selection on MIPS32R6 and MIPS64R6 since this is not
 192   yet supported.
 193 * Corrected addend for ``R_MIPS_HI16`` and ``R_MIPS_PCHI16`` in MCJIT
 194 * The code generator no longer crashes when handling subregisters of an 64-bit
 195   FPU register with undefined value.
 196 * The code generator no longer attempts to use ``$zero`` for operands that do
 197   not permit ``$zero``.
 198 * Corrected the opcode used for ``ll``/``sc`` when using MIPS32R6/MIPS64R6 and
 199   the Integrated Assembler.
 200 * Added support for atomic load and atomic store.
 201 * Corrected debug info when dynamically re-aligning the stack.
 202
 203 Integrated Assembler
 204 ^^^^^^^^^^^^^^^^^^^^
 205 We have made a large number of improvements to the integrated assembler for
 206 MIPS. In this release, the integrated assembler isn't quite production-ready
 207 since there are a few known issues related to bare-metal support, checking
 208 immediates on instructions, and the N32/N64 ABI's. However, the current support
 209 should be sufficient for many users of the O32 ABI, particularly those targeting
 210 MIPS32 on Linux or bare-metal MIPS32.
 211
 212 If you would like to try the integrated assembler, please use
 213 ``-fintegrated-as``.
 214
 215 Changes to the PowerPC Target
 216 -----------------------------
 217
 218  During this release ...
 219
 220
 221 Changes to the X86 Target
 222 -----------------------------
 223
 224  During this release ...
 225
 226 * TLS is enabled for Cygwin as emutls.
 227
 228 * Smaller code for materializing 32-bit 1 and -1 constants at ``-Os``.
 229
 230 * More efficient code for wide integer compares. (E.g. 64-bit compares
 231   on 32-bit targets.)
 232
 233 * Tail call support for ``thiscall``, ``stdcall``, ``vectorcall``, and
 234   ``fastcall`` functions.
 235
 236 Changes to the Hexagon Target
 237 -----------------------------
 238
 239 In addition to general code size and performance improvements, Hexagon target
 240 now has basic support for Hexagon V60 architecture and Hexagon Vector
 241 Extensions (HVX).
 242
 243 Changes to the AVR Target
 244 -------------------------
 245
 246 Slightly less than half of the AVR backend has been merged in at this point. It is still
 247 missing a number large parts which cause it to be unusable, but is well on the
 248 road to being completely merged and workable.
 249
 250 Changes to the OCaml bindings
 251 -----------------------------
 252
 253  During this release ...
 254
 255 * The ocaml function link_modules has been replaced with link_modules' which
 256   uses LLVMLinkModules2.
 257
 258
 259 External Open Source Projects Using LLVM 3.8
 260 ============================================
 261
 262 An exciting aspect of LLVM is that it is used as an enabling technology for
 263 a lot of other language and tools projects. This section lists some of the
 264 projects that have already been updated to work with LLVM 3.8.
 265
 266 LDC - the LLVM-based D compiler
 267 -------------------------------
 268
 269 `D <http://dlang.org>`_ is a language with C-like syntax and static typing. It
 270 pragmatically combines efficiency, control, and modeling power, with safety and
 271 programmer productivity. D supports powerful concepts like Compile-Time Function
 272 Execution (CTFE) and Template Meta-Programming, provides an innovative approach
 273 to concurrency and offers many classical paradigms.
 274
 275 `LDC <http://wiki.dlang.org/LDC>`_ uses the frontend from the reference compiler
 276 combined with LLVM as backend to produce efficient native code. LDC targets
 277 x86/x86_64 systems like Linux, OS X and Windows and also PowerPC (32/64 bit)
 278 and ARM. Ports to other architectures like AArch64 and MIPS64 are underway.
 279
 280
 281 Additional Information
 282 ======================
 283
 284 A wide variety of additional information is available on the `LLVM web page
 285 <http://llvm.org/>`_, in particular in the `documentation
 286 <http://llvm.org/docs/>`_ section.  The web page also contains versions of the
 287 API documentation which is up-to-date with the Subversion version of the source
 288 code.  You can access versions of these documents specific to this release by
 289 going into the ``llvm/docs/`` directory in the LLVM tree.
 290
 291 If you have any questions or comments about LLVM, please feel free to contact
 292 us via the `mailing lists <http://llvm.org/docs/#maillist>`_.
 293