3689af18093f98da711f4354d569dcc1b7cd79d9
[oota-llvm.git] / docs / ReleaseNotes.rst
1 ======================
2 LLVM 3.3 Release Notes
3 ======================
4
5 .. contents::
6     :local:
7
8 .. warning::
9    These are in-progress notes for the upcoming LLVM 3.3 release.  You may
10    prefer the `LLVM 3.2 Release Notes <http://llvm.org/releases/3.2/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.3.  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 * The CellSPU port has been removed.  It can still be found in older versions.
45
46 * The IR-level extended linker APIs (for example, to link bitcode files out of
47   archives) have been removed. Any existing clients of these features should
48   move to using a linker with integrated LTO support.
49
50 * LLVM and Clang's documentation has been migrated to the `Sphinx
51   <http://sphinx-doc.org/>`_ documentation generation system which uses
52   easy-to-write reStructuredText. See `llvm/docs/README.txt` for more
53   information.
54
55 * TargetTransformInfo (TTI) is a new interface that can be used by IR-level
56   passes to obtain target-specific information, such as the costs of
57   instructions. Only "Lowering" passes such as LSR and the vectorizer are
58   allowed to use the TTI infrastructure.
59
60 * We've improved the X86 and ARM cost model.
61
62 * The Attributes classes have been completely rewritten and expanded. They now
63   support not only enumerated attributes and alignments, but "string"
64   attributes, which are useful for passing information to code generation. See
65   :doc:`HowToUseAttributes` for more details.
66
67 * TableGen's syntax for instruction selection patterns has been simplified.
68   Instead of specifying types indirectly with register classes, you should now
69   specify types directly in the input patterns. See ``SparcInstrInfo.td`` for
70   examples of the new syntax. The old syntax using register classes still
71   works, but it will be removed in a future LLVM release.
72
73 * MCJIT now supports exception handling. Support for it in the old jit will be
74   removed in the 3.4 release.
75
76 * ... next change ...
77
78 .. NOTE
79    If you would like to document a larger change, then you can add a
80    subsection about it right here. You can copy the following boilerplate
81    and un-indent it (the indentation causes it to be inside this comment).
82
83    Special New Feature
84    -------------------
85
86    Makes programs 10x faster by doing Special New Thing.
87
88 AArch64 target
89 --------------
90
91 We've added support for AArch64, ARM's 64-bit architecture. Development is still
92 in fairly early stages, but we expect successful compilation when:
93
94 - compiling standard compliant C99 and C++03 with Clang;
95 - using Linux as a target platform;
96 - where code + static data doesn't exceed 4GB in size (heap allocated data has
97   no limitation).
98
99 Some additional functionality is also implemented, notably DWARF debugging,
100 GNU-style thread local storage and inline assembly.
101
102 Hexagon Target
103 --------------
104
105 - Removed support for legacy hexagonv2 and hexagonv3 processor
106   architectures which are no longer in use. Currently supported
107   architectures are hexagonv4 and hexagonv5.
108
109 Loop Vectorizer
110 ---------------
111
112 We've continued the work on the loop vectorizer. The loop vectorizer now
113 has the following features:
114
115 - Loops with unknown trip counts.
116 - Runtime checks of pointers.
117 - Reductions, Inductions.
118 - Min/Max reductions of integers.
119 - If Conversion.
120 - Pointer induction variables.
121 - Reverse iterators.
122 - Vectorization of mixed types.
123 - Vectorization of function calls.
124 - Partial unrolling during vectorization.
125
126 The loop vectorizer is now enabled by default for -O3.
127
128 SLP Vectorizer
129 --------------
130
131 LLVM now has a new SLP vectorizer. The new SLP vectorizer is not enabled by
132 default but can be enabled using the clang flag -fslp-vectorize. The BB-vectorizer
133 can also be enabled using the command line flag -fslp-vectorize-aggressive.
134
135 R600 Backend
136 ------------
137
138 The R600 backend was added in this release, it supports AMD GPUs
139 (HD2XXX - HD7XXX).  This backend is used in AMD's Open Source
140 graphics / compute drivers which are developed as part of the `Mesa3D
141 <http://www.mesa3d.org>`_ project.
142
143 SystemZ/s390x Backend
144 ---------------------
145
146 LLVM and clang now support IBM's z/Architecture.  At present this support
147 is restricted to GNU/Linux (GNU triplet s390x-linux-gnu) and requires
148 z10 or greater.
149
150
151 External Open Source Projects Using LLVM 3.3
152 ============================================
153
154 An exciting aspect of LLVM is that it is used as an enabling technology for
155 a lot of other language and tools projects. This section lists some of the
156 projects that have already been updated to work with LLVM 3.3.
157
158
159 Portable Computing Language (pocl)
160 ----------------------------------
161
162 In addition to producing an easily portable open source OpenCL
163 implementation, another major goal of `pocl <http://pocl.sourceforge.net/>`_ 
164 is improving performance portability of OpenCL programs with
165 compiler optimizations, reducing the need for target-dependent manual
166 optimizations. An important part of pocl is a set of LLVM passes used to
167 statically parallelize multiple work-items with the kernel compiler, even in
168 the presence of work-group barriers. This enables static parallelization of
169 the fine-grained static concurrency in the work groups in multiple ways.
170
171 TTA-based Co-design Environment (TCE)
172 -------------------------------------
173
174 `TCE <http://tce.cs.tut.fi/>`_ is a toolset for designing new 
175 processors based on the Transport triggered architecture (TTA). 
176 The toolset provides a complete co-design flow from C/C++
177 programs down to synthesizable VHDL/Verilog and parallel program binaries.
178 Processor customization points include the register files, function units,
179 supported operations, and the interconnection network.
180
181 TCE uses Clang and LLVM for C/C++/OpenCL C language support, target independent
182 optimizations and also for parts of code generation. It generates new
183 LLVM-based code generators "on the fly" for the designed TTA processors and
184 loads them in to the compiler backend as runtime libraries to avoid
185 per-target recompilation of larger parts of the compiler chain.
186
187
188 Additional Information
189 ======================
190
191 A wide variety of additional information is available on the `LLVM web page
192 <http://llvm.org/>`_, in particular in the `documentation
193 <http://llvm.org/docs/>`_ section.  The web page also contains versions of the
194 API documentation which is up-to-date with the Subversion version of the source
195 code.  You can access versions of these documents specific to this release by
196 going into the ``llvm/docs/`` directory in the LLVM tree.
197
198 If you have any questions or comments about LLVM, please feel free to contact
199 us via the `mailing lists <http://llvm.org/docs/#maillist>`_.
200