docs/ReleaseNotes.rst

   1 ======================
   2 LLVM 3.6 Release Notes
   3 ======================
   4
   5 .. contents::
   6     :local:
   7
   8 .. warning::
   9    These are in-progress notes for the upcoming LLVM 3.6 release.  You may
  10    prefer the `LLVM 3.5 Release Notes <http://llvm.org/releases/3.5.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.6.  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.cs.uiuc.edu/mailman/listinfo/llvmdev>`_ 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
  37 .. NOTE
  38    For small 1-3 sentence descriptions, just add an entry at the end of
  39    this list. If your description won't fit comfortably in one bullet
  40    point (e.g. maybe you would like to give an example of the
  41    functionality, or simply have a lot to talk about), see the `NOTE` below
  42    for adding a new subsection.
  43
  44 * Support for AuroraUX has been removed.
  45
  46 * Added support for a `native object file-based bitcode wrapper format
  47   <BitCodeFormat.html#native-object-file>`_.
  48
  49 * ... next change ...
  50
  51 .. NOTE
  52    If you would like to document a larger change, then you can add a
  53    subsection about it right here. You can copy the following boilerplate
  54    and un-indent it (the indentation causes it to be inside this comment).
  55
  56    Special New Feature
  57    -------------------
  58
  59    Makes programs 10x faster by doing Special New Thing.
  60
  61 Prefix data rework
  62 ------------------
  63
  64 The semantics of the ``prefix`` attribute have been changed. Users
  65 that want the previous ``prefix`` semantics should instead use
  66 ``prologue``.  To motivate this change, let's examine the primary
  67 usecases that these attributes aim to serve,
  68
  69   1. Code sanitization metadata (e.g. Clang's undefined behavior
  70      sanitizer)
  71
  72   2. Function hot-patching: Enable the user to insert ``nop`` operations
  73      at the beginning of the function which can later be safely replaced
  74      with a call to some instrumentation facility.
  75
  76   3. Language runtime metadata: Allow a compiler to insert data for
  77      use by the runtime during execution. GHC is one example of a
  78      compiler that needs this functionality for its
  79      tables-next-to-code functionality.
  80
  81 Previously ``prefix`` served cases (1) and (2) quite well by allowing the user
  82 to introduce arbitrary data at the entrypoint but before the function
  83 body. Case (3), however, was poorly handled by this approach as it
  84 required that prefix data was valid executable code.
  85
  86 In this release the concept of prefix data has been redefined to be
  87 data which occurs immediately before the function entrypoint (i.e. the
  88 symbol address). Since prefix data now occurs before the function
  89 entrypoint, there is no need for the data to be valid code.
  90
  91 The previous notion of prefix data now goes under the name "prologue
  92 data" to emphasize its duality with the function epilogue.
  93
  94 The intention here is to handle cases (1) and (2) with prologue data and
  95 case (3) with prefix data. See the language reference for further details
  96 on the semantics of these attributes.
  97
  98 This refactoring arose out of discussions_ with Reid Kleckner in
  99 response to a proposal to introduce the notion of symbol offsets to
 100 enable handling of case (3).
 101
 102 .. _discussions: http://lists.cs.uiuc.edu/pipermail/llvmdev/2014-May/073235.html
 103
 104
 105 Changes to the ARM Backend
 106 --------------------------
 107
 108  During this release ...
 109
 110
 111 Changes to the MIPS Target
 112 --------------------------
 113
 114 During this release ...
 115
 116 Changes to the PowerPC Target
 117 -----------------------------
 118
 119 During this release ...
 120
 121 External Open Source Projects Using LLVM 3.6
 122 ============================================
 123
 124 An exciting aspect of LLVM is that it is used as an enabling technology for
 125 a lot of other language and tools projects. This section lists some of the
 126 projects that have already been updated to work with LLVM 3.6.
 127
 128 * A project
 129
 130
 131 Additional Information
 132 ======================
 133
 134 A wide variety of additional information is available on the `LLVM web page
 135 <http://llvm.org/>`_, in particular in the `documentation
 136 <http://llvm.org/docs/>`_ section.  The web page also contains versions of the
 137 API documentation which is up-to-date with the Subversion version of the source
 138 code.  You can access versions of these documents specific to this release by
 139 going into the ``llvm/docs/`` directory in the LLVM tree.
 140
 141 If you have any questions or comments about LLVM, please feel free to contact
 142 us via the `mailing lists <http://llvm.org/docs/#maillist>`_.
 143