docs/ReleaseNotes.rst

   1 =========================
   2 LLVM 10.0.0 Release Notes
   3 =========================
   4
   5 .. contents::
   6     :local:
   7
   8 .. warning::
   9    These are in-progress notes for the upcoming LLVM 10 release.
  10    Release notes for previous releases can be found on
  11    `the Download Page <https://releases.llvm.org/download.html>`_.
  12
  13
  14 Introduction
  15 ============
  16
  17 This document contains the release notes for the LLVM Compiler Infrastructure,
  18 release 10.0.0.  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 <https://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 <https://llvm.org/>`_.  If you
  25 have questions or comments, the `LLVM Developer's Mailing List
  26 <https://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 <https://llvm.org/releases/>`_.
  33
  34 Non-comprehensive list of changes in this release
  35 =================================================
  36 .. NOTE
  37    For small 1-3 sentence descriptions, just add an entry at the end of
  38    this list. If your description won't fit comfortably in one bullet
  39    point (e.g. maybe you would like to give an example of the
  40    functionality, or simply have a lot to talk about), see the `NOTE` below
  41    for adding a new subsection.
  42
  43 * The ISD::FP_ROUND_INREG opcode and related code was removed from SelectionDAG.
  44 * Enabled MemorySSA as a loop dependency. Since
  45   `r370957 <https://reviews.llvm.org/rL370957>`_
  46   (`D58311 <https://reviews.llvm.org/D58311>`_ ``[MemorySSA & LoopPassManager]
  47   Enable MemorySSA as loop dependency. Update tests.``), the MemorySSA analysis
  48   is being preserved and used by a series of loop passes. The most significant
  49   use is in LICM, where the instruction hoisting and sinking relies on aliasing
  50   information provided by MemorySSA vs previously creating an AliasSetTracker.
  51   The LICM step of promoting variables to scalars still relies on the creation
  52   of an AliasSetTracker, but its use is reduced to only be enabled for loops
  53   with a small number of overall memory instructions. This choice was motivated
  54   by experimental results showing compile and run time benefits or replacing the
  55   AliasSetTracker usage with MemorySSA without any performance penalties.
  56   The fact that MemorySSA is now preserved by and available in a series of loop
  57   passes, also opens up opportunities for its use in those respective passes.
  58
  59 .. NOTE
  60    If you would like to document a larger change, then you can add a
  61    subsection about it right here. You can copy the following boilerplate
  62    and un-indent it (the indentation causes it to be inside this comment).
  63
  64    Special New Feature
  65    -------------------
  66
  67    Makes programs 10x faster by doing Special New Thing.
  68
  69 * As per :ref:`LLVM Language Reference Manual <i_getelementptr>`,
  70   ``getelementptr inbounds`` can not change the null status of a pointer,
  71   meaning it can not produce non-null pointer given null base pointer, and
  72   likewise given non-null base pointer it can not produce null pointer; if it
  73   does, the result is a :ref:`poison value <poisonvalues>`.
  74   Since `r369789 <https://reviews.llvm.org/rL369789>`_
  75   (`D66608 <https://reviews.llvm.org/D66608>`_ ``[InstCombine] icmp eq/ne (gep
  76   inbounds P, Idx..), null -> icmp eq/ne P, null``) LLVM uses that for
  77   transformations. If the original source violates these requirements this
  78   may result in code being miscompiled. If you are using Clang front-end,
  79   Undefined Behaviour Sanitizer ``-fsanitize=pointer-overflow`` check
  80   will now catch such cases.
  81
  82 * The Loop Idiom Recognition (``-loop-idiom``) pass has learned to recognize
  83   ``bcmp`` pattern, and convert it into a call to ``bcmp`` (or ``memcmp``)
  84   function.
  85
  86 Changes to the LLVM IR
  87 ----------------------
  88
  89 * Unnamed function arguments now get printed with their automatically
  90   generated name (e.g. "i32 %0") in definitions. This may require front-ends
  91   to update their tests; if so there is a script utils/add_argument_names.py
  92   that correctly converted 80-90% of Clang tests. Some manual work will almost
  93   certainly still be needed.
  94
  95
  96 Changes to building LLVM
  97 ------------------------
  98
  99 Changes to the ARM Backend
 100 --------------------------
 101
 102  During this release ...
 103
 104
 105 Changes to the MIPS Target
 106 --------------------------
 107
 108  During this release ...
 109
 110
 111 Changes to the PowerPC Target
 112 -----------------------------
 113
 114  During this release ...
 115
 116 Changes to the X86 Target
 117 -------------------------
 118
 119  During this release ...
 120
 121 * Less than 128 bit vector types, v2i32, v4i16, v2i16, v8i8, v4i8, and v2i8, are
 122   now stored in the lower bits of an xmm register and the upper bits are
 123   undefined. Previously the elements were spread apart with undefined bits in
 124   between them.
 125 * v32i8 and v64i8 vectors with AVX512F enabled, but AVX512BW disabled will now
 126   be passed in ZMM registers for calls and returns. Previously they were passed
 127   in two YMM registers. Old behavior can be enabled by passing
 128   -x86-enable-old-knl-abi
 129 * -mprefer-vector-width=256 is now the default behavior skylake-avx512 and later
 130   Intel CPUs. This tries to limit the use of 512-bit registers which can cause a
 131   decrease in CPU frequency on these CPUs. This can be re-enabled by passing
 132   -mprefer-vector-width=512 to clang or passing -mattr=-prefer-256-bit to llc.
 133
 134 Changes to the AMDGPU Target
 135 -----------------------------
 136
 137 Changes to the AVR Target
 138 -----------------------------
 139
 140  During this release ...
 141
 142 * Deprecated the mpx feature flag for the Intel MPX instructions. There were no
 143   intrinsics for this feature. This change only this effects the results
 144   returned by getHostCPUFeatures on CPUs that implement the MPX instructions.
 145
 146 Changes to the WebAssembly Target
 147 ---------------------------------
 148
 149  During this release ...
 150
 151
 152 Changes to the OCaml bindings
 153 -----------------------------
 154
 155
 156
 157 Changes to the C API
 158 --------------------
 159
 160
 161 Changes to the DAG infrastructure
 162 ---------------------------------
 163
 164 Changes to LLDB
 165 ===============
 166
 167 External Open Source Projects Using LLVM 10
 168 ===========================================
 169
 170 * A project...
 171
 172
 173 Additional Information
 174 ======================
 175
 176 A wide variety of additional information is available on the `LLVM web page
 177 <https://llvm.org/>`_, in particular in the `documentation
 178 <https://llvm.org/docs/>`_ section.  The web page also contains versions of the
 179 API documentation which is up-to-date with the Subversion version of the source
 180 code.  You can access versions of these documents specific to this release by
 181 going into the ``llvm/docs/`` directory in the LLVM tree.
 182
 183 If you have any questions or comments about LLVM, please feel free to contact
 184 us via the `mailing lists <https://llvm.org/docs/#mailing-lists>`_.