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