docs/ReleaseNotes.rst

   1 ========================
   2 LLVM 7.0.0 Release Notes
   3 ========================
   4
   5 .. contents::
   6     :local:
   7
   8 .. warning::
   9    These are in-progress notes for the upcoming LLVM 7 release.
  10    Release notes for previous releases can be found on
  11    `the Download Page <http://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 7.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 <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 .. 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 * Libraries have been renamed from 7.0 to 7. This change also impacts
  44   downstream libraries like lldb.
  45
  46 * The LoopInstSimplify pass (-loop-instsimplify) has been removed.
  47
  48 * Symbols starting with ``?`` are no longer mangled by LLVM when using the
  49   Windows ``x`` or ``w`` IR mangling schemes.
  50
  51 * A new tool named :doc:`llvm-exegesis <CommandGuide/llvm-exegesis>` has been
  52   added. :program:`llvm-exegesis` automatically measures instruction scheduling
  53   properties (latency/uops) and provides a principled way to edit scheduling
  54   models.
  55
  56 * A new tool named :doc:`llvm-mca <CommandGuide/llvm-mca>` has been added.
  57   :program:`llvm-mca` is a  static performance analysis tool that uses
  58   information available in LLVM to statically predict the performance of
  59   machine code for a specific CPU.
  60
  61 * The optimization flag to merge constants (-fmerge-all-constants) is no longer
  62   applied by default.
  63
  64 * Optimization of floating-point casts is improved. This may cause surprising
  65   results for code that is relying on the undefined behavior of overflowing
  66   casts. The optimization can be disabled by specifying a function attribute:
  67   "strict-float-cast-overflow"="false". This attribute may be created by the
  68   clang option :option:`-fno-strict-float-cast-overflow`.
  69   Code sanitizers can be used to detect affected patterns. The option for
  70   detecting this problem alone is "-fsanitize=float-cast-overflow":
  71
  72 .. code-block:: c
  73
  74     int main() {
  75       float x = 4294967296.0f;
  76       x = (float)((int)x);
  77       printf("junk in the ftrunc: %f\n", x);
  78       return 0;
  79     }
  80
  81 .. code-block:: bash
  82
  83     clang -O1 ftrunc.c -fsanitize=float-cast-overflow ; ./a.out
  84     ftrunc.c:5:15: runtime error: 4.29497e+09 is outside the range of representable values of type 'int'
  85     junk in the ftrunc: 0.000000
  86
  87 * ``LLVM_ON_WIN32`` is no longer set by ``llvm/Config/config.h`` and
  88   ``llvm/Config/llvm-config.h``.  If you used this macro, use the compiler-set
  89   ``_WIN32`` instead which is set exactly when ``LLVM_ON_WIN32`` used to be set.
  90
  91 * Note..
  92
  93 .. NOTE
  94    If you would like to document a larger change, then you can add a
  95    subsection about it right here. You can copy the following boilerplate
  96    and un-indent it (the indentation causes it to be inside this comment).
  97
  98    Special New Feature
  99    -------------------
 100
 101    Makes programs 10x faster by doing Special New Thing.
 102
 103 Changes to the LLVM IR
 104 ----------------------
 105
 106 * The signatures for the builtins @llvm.memcpy, @llvm.memmove, and @llvm.memset
 107   have changed. Alignment is no longer an argument, and are instead conveyed as
 108   parameter attributes.
 109
 110 * invariant.group.barrier has been renamed to launder.invariant.group.
 111
 112 * invariant.group metadata can now refer only empty metadata nodes.
 113
 114 Changes to the ARM Backend
 115 --------------------------
 116
 117  During this release ...
 118
 119
 120 Changes to the MIPS Target
 121 --------------------------
 122
 123  During this release ...
 124
 125
 126 Changes to the PowerPC Target
 127 -----------------------------
 128
 129  During this release ...
 130
 131 Changes to the X86 Target
 132 -------------------------
 133
 134  During this release ...
 135
 136 Changes to the AMDGPU Target
 137 -----------------------------
 138
 139  During this release ...
 140
 141 Changes to the AVR Target
 142 -----------------------------
 143
 144  During this release ...
 145
 146 Changes to the OCaml bindings
 147 -----------------------------
 148
 149 * Remove ``add_bb_vectorize``.
 150
 151
 152 Changes to the C API
 153 --------------------
 154
 155 * Remove ``LLVMAddBBVectorizePass``. The implementation was removed and the C
 156   interface was made a deprecated no-op in LLVM 5. Use
 157   ``LLVMAddSLPVectorizePass`` instead to get the supported SLP vectorizer.
 158
 159
 160 External Open Source Projects Using LLVM 7
 161 ==========================================
 162
 163 * A project...
 164
 165
 166 Additional Information
 167 ======================
 168
 169 A wide variety of additional information is available on the `LLVM web page
 170 <http://llvm.org/>`_, in particular in the `documentation
 171 <http://llvm.org/docs/>`_ section.  The web page also contains versions of the
 172 API documentation which is up-to-date with the Subversion version of the source
 173 code.  You can access versions of these documents specific to this release by
 174 going into the ``llvm/docs/`` directory in the LLVM tree.
 175
 176 If you have any questions or comments about LLVM, please feel free to contact
 177 us via the `mailing lists <http://llvm.org/docs/#maillist>`_.