blob: 13ef51fb144ad4b79b2928dae0bdbf60b9b22930 [file] [log] [blame]
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
3<html>
4<head>
5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
6 <link rel="stylesheet" href="llvm.css" type="text/css">
Chris Lattner95d25072009-02-25 04:41:31 +00007 <title>LLVM 2.5 Release Notes</title>
Dan Gohmanf17a25c2007-07-18 16:29:46 +00008</head>
9<body>
10
Chris Lattner95d25072009-02-25 04:41:31 +000011<div class="doc_title">LLVM 2.5 Release Notes</div>
Mikhail Glushenkov808cd3e2008-10-13 02:08:34 +000012
Dan Gohmanf17a25c2007-07-18 16:29:46 +000013<ol>
14 <li><a href="#intro">Introduction</a></li>
Chris Lattner78a130b2008-10-13 18:01:01 +000015 <li><a href="#subproj">Sub-project Status Update</a></li>
Chris Lattnerb2cc5022009-02-26 22:33:38 +000016 <li><a href="#externalproj">External Projects Using LLVM 2.5</a></li>
Chris Lattner78a130b2008-10-13 18:01:01 +000017 <li><a href="#whatsnew">What's New in LLVM?</a></li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +000018 <li><a href="GettingStarted.html">Installation Instructions</a></li>
19 <li><a href="#portability">Portability and Supported Platforms</a></li>
Dan Gohman0de549c2008-10-14 16:23:02 +000020 <li><a href="#knownproblems">Known Problems</a></li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +000021 <li><a href="#additionalinfo">Additional Information</a></li>
22</ol>
23
24<div class="doc_author">
Dan Gohman0de549c2008-10-14 16:23:02 +000025 <p>Written by the <a href="http://llvm.org">LLVM Team</a></p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +000026</div>
27
28<!-- *********************************************************************** -->
29<div class="doc_section">
30 <a name="intro">Introduction</a>
31</div>
32<!-- *********************************************************************** -->
33
34<div class="doc_text">
35
Chris Lattner92eacf82008-10-13 17:57:36 +000036<p>This document contains the release notes for the LLVM Compiler
Chris Lattner95d25072009-02-25 04:41:31 +000037Infrastructure, release 2.5. Here we describe the status of LLVM, including
Chris Lattner92eacf82008-10-13 17:57:36 +000038major improvements from the previous release and significant known problems.
39All LLVM releases may be downloaded from the <a
40href="http://llvm.org/releases/">LLVM releases web site</a>.</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +000041
42<p>For more information about LLVM, including information about the latest
43release, please check out the <a href="http://llvm.org/">main LLVM
44web site</a>. If you have questions or comments, the <a
Chris Lattner92eacf82008-10-13 17:57:36 +000045href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM Developer's Mailing
46List</a> is a good place to send them.</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +000047
Mikhail Glushenkov808cd3e2008-10-13 02:08:34 +000048<p>Note that if you are reading this file from a Subversion checkout or the
Chris Lattnerb0d6c502007-09-21 03:54:09 +000049main LLVM web page, this document applies to the <i>next</i> release, not the
Gabor Greif7c65c4f2008-10-14 11:00:32 +000050current one. To see the release notes for a specific release, please see the
Chris Lattnerb0d6c502007-09-21 03:54:09 +000051<a href="http://llvm.org/releases/">releases page</a>.</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +000052
53</div>
54
Chris Lattner95d25072009-02-25 04:41:31 +000055<!-- Unfinished features in 2.5:
Chris Lattner8fda4952008-02-10 07:46:44 +000056 Machine LICM
57 Machine Sinking
Chris Lattnera53f4972009-02-25 06:34:50 +000058 target-specific intrinsics
59 gold lto plugin
Chris Lattner56b64702009-02-25 07:32:53 +000060 pre-alloc splitter, strong phi elim
Chris Lattner4f076402008-10-12 19:47:48 +000061 llc -enable-value-prop, propagation of value info (sign/zero ext info) from
62 one MBB to another
Chris Lattnera53f4972009-02-25 06:34:50 +000063 debug info for optimized code
Chris Lattner5c109932009-02-26 07:29:17 +000064 interpreter + libffi
Chris Lattnerb2cc5022009-02-26 22:33:38 +000065 postalloc scheduler: anti dependence breaking, hazard recognizer?
66
Chris Lattner8fda4952008-02-10 07:46:44 +000067 -->
Mikhail Glushenkov808cd3e2008-10-13 02:08:34 +000068
Chris Lattner4f076402008-10-12 19:47:48 +000069 <!-- for announcement email:
Chris Lattnera53f4972009-02-25 06:34:50 +000070 -->
Chris Lattner8fda4952008-02-10 07:46:44 +000071
Chris Lattner78a130b2008-10-13 18:01:01 +000072<!-- *********************************************************************** -->
73<div class="doc_section">
74 <a name="subproj">Sub-project Status Update</a>
Chris Lattnerf65224f2008-06-08 21:34:41 +000075</div>
Chris Lattner78a130b2008-10-13 18:01:01 +000076<!-- *********************************************************************** -->
Chris Lattnerf65224f2008-06-08 21:34:41 +000077
78<div class="doc_text">
Chris Lattnerf6a0d382008-06-08 21:58:17 +000079<p>
Chris Lattner95d25072009-02-25 04:41:31 +000080The LLVM 2.5 distribution currently consists of code from the core LLVM
Chris Lattnera3c683b2008-10-13 18:11:54 +000081repository (which roughly includes the LLVM optimizers, code generators and
Chris Lattnerf6a0d382008-06-08 21:58:17 +000082supporting tools) and the llvm-gcc repository. In addition to this code, the
83LLVM Project includes other sub-projects that are in development. The two which
Chris Lattner2c3ef982008-10-11 18:18:28 +000084are the most actively developed are the <a href="#clang">Clang Project</a> and
Nicolas Geoffray2b139382008-10-14 19:23:04 +000085the <a href="#vmkit">VMKit Project</a>.
Chris Lattnerf6a0d382008-06-08 21:58:17 +000086</p>
Chris Lattner78a130b2008-10-13 18:01:01 +000087
Chris Lattnerf6a0d382008-06-08 21:58:17 +000088</div>
89
Chris Lattner78a130b2008-10-13 18:01:01 +000090
Chris Lattnerf6a0d382008-06-08 21:58:17 +000091<!--=========================================================================-->
Chris Lattner78a130b2008-10-13 18:01:01 +000092<div class="doc_subsection">
Chris Lattnera3c683b2008-10-13 18:11:54 +000093<a name="clang">Clang: C/C++/Objective-C Frontend Toolkit</a>
Chris Lattnerf6a0d382008-06-08 21:58:17 +000094</div>
95
96<div class="doc_text">
97
98<p>The <a href="http://clang.llvm.org/">Clang project</a> is an effort to build
99a set of new 'LLVM native' front-end technologies for the LLVM optimizer
Chris Lattnerc97507b2009-02-25 05:09:54 +0000100and code generator. While Clang is not included in the LLVM 2.5 release, it
101is continuing to make major strides forward in all areas. Its C and Objective-C
102parsing and code generation support is now very solid. For example, it is
103capable of successfully building many real applications for X86-32 and X86-64,
Chris Lattnerb2cc5022009-02-26 22:33:38 +0000104including <a href="http://wiki.freebsd.org/BuildingFreeBSDWithClang">the FreeBSD
105kernel</a>. C++ is also making <a
Chris Lattnerc97507b2009-02-25 05:09:54 +0000106href="http://clang.llvm.org/cxx_status.html">incredible progress</a>, and work
107on templates has recently started.</p>
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000108
Chris Lattnerc97507b2009-02-25 05:09:54 +0000109<p>While Clang is not yet production quality, it is progressing very nicely and
110is quite usable for building many C and Objective-C applications. If you are
111interested in fast compiles and good diagnostics, we encourage you to try it out
Chris Lattnera53f4972009-02-25 06:34:50 +0000112by <a href="http://clang.llvm.org/get_started.html">building from mainline</a>
Chris Lattnerc97507b2009-02-25 05:09:54 +0000113and reporting any issues you hit to the <a
114href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-dev">Clang front-end mailing
115list</a>.</p>
116
117<p>In the LLVM 2.5 time-frame, the Clang team has made many improvements:</p>
Bill Wendling385b0d32008-10-27 09:27:33 +0000118
Daniel Dunbarf3e35782008-10-14 23:25:09 +0000119<ul>
Chris Lattnerc97507b2009-02-25 05:09:54 +0000120<li>Clang now has a new driver, which is focused on providing a GCC-compatible
121 interface.</li>
122<li>The X86-64 ABI is now supported.</li>
123<li>Precompiled header support is now implemented.</li>
124<li>Objective-C support is significantly improved beyond LLVM 2.4, supporting
125 many features, such as Objective-C Garbage Collection.</li>
126<li>Many many bugs are fixed.</li>
Chris Lattnera3c683b2008-10-13 18:11:54 +0000127</div>
128
129<!--=========================================================================-->
130<div class="doc_subsection">
131<a name="clangsa">Clang Static Analyzer</a>
132</div>
133
134<div class="doc_text">
135
Ted Kremeneka0d77d72009-02-27 07:01:32 +0000136<p>Previously announced in the last LLVM release, the Clang project also
137includes an early stage static source code analysis tool for <a
138href="http://clang.llvm.org/StaticAnalysis.html">automatically finding bugs</a>
139in C and Objective-C programs. The tool performs a growing set of checks to find
140bugs that occur on a specific path within a program.</p>
Chris Lattnerc2d84672008-10-14 00:52:49 +0000141
Ted Kremeneka0d77d72009-02-27 07:01:32 +0000142<p>In the LLVM 2.5 time-frame there have been many significant improvements to
143the analyzer's core path simulation engine and machinery for generating
144path-based bug reports to end-users. Particularly noteworthy improvements
145include experimental support for full field-sensitivity and reasoning about heap
146objects as well as an improved value-constraints subengine that does a much
147better job of reasoning about inequality relationships (e.g., <tt>x &gt; 2</tt>)
148between variables and constants.
Ted Kremenek0437b2c2008-10-14 05:14:21 +0000149
Ted Kremeneka0d77d72009-02-27 07:01:32 +0000150<p>The set of checks performed by the static analyzer continue to expand, and
151future plans for the tool include full source-level inter-procedural analysis
152and deeper checks such as buffer overrun detection. There are many opportunities
153to extend and enhance the static analyzer, and anyone interested in working on
154this project is encouraged to get involved!</p>
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000155
156</div>
157
Chris Lattner78a130b2008-10-13 18:01:01 +0000158<!--=========================================================================-->
159<div class="doc_subsection">
Nicolas Geoffray2b139382008-10-14 19:23:04 +0000160<a name="vmkit">VMKit: JVM/CLI Virtual Machine Implementation</a>
Chris Lattner78a130b2008-10-13 18:01:01 +0000161</div>
162
163<div class="doc_text">
164<p>
Nicolas Geoffray2b139382008-10-14 19:23:04 +0000165The <a href="http://vmkit.llvm.org/">VMKit project</a> is an implementation of
Chris Lattner78a130b2008-10-13 18:01:01 +0000166a JVM and a CLI Virtual Machines (Microsoft .NET is an
167implementation of the CLI) using the Just-In-Time compiler of LLVM.</p>
168
Chris Lattner02408742009-02-25 05:45:05 +0000169<p>Following LLVM 2.5, VMKit has its first release ? that you can find on its
Nicolas Geoffray20cfdd42008-10-15 20:25:04 +0000170<a href="http://vmkit.llvm.org/releases/">webpage</a>. The release includes
171bug fixes, cleanup and new features. The major changes are:</p>
Chris Lattner78a130b2008-10-13 18:01:01 +0000172
Nicolas Geoffray2b139382008-10-14 19:23:04 +0000173<ul>
174
Chris Lattner47bcf612009-02-26 05:20:36 +0000175<li>Ahead of Time compiler: compiles .class files to llvm .bc. VMKit uses this
176functionality to native compile the standard classes (eg java.lang.String).
177Users can compile AOT .class files into dynamic libraries and run them with the
178help of VMKit.</li>
179
180<li>New exception model: the dwarf exception model is very slow for
181exception-intensive applications, so the JVM has had a new implementation of
182exceptions which check at each function call if an exception happened. There is
183a low performance penalty on applications without exceptions, but it is a big
184gain for exception-intensive applications. For example the jack benchmark in
185Spec JVM98 is 6x faster (performance gain of 83%).</li>
186
187<li>New support for OSX/X64, Linux/X64 (with the Boehm GC), Linux/ppc32.</li>
Nicolas Geoffray2b139382008-10-14 19:23:04 +0000188
189</ul>
Chris Lattner78a130b2008-10-13 18:01:01 +0000190</div>
191
Chris Lattnerb2cc5022009-02-26 22:33:38 +0000192<!-- *********************************************************************** -->
193<div class="doc_section">
194 <a name="externalproj">External Projects Using LLVM 2.5</a>
195</div>
196<!-- *********************************************************************** -->
197
198<!--=========================================================================-->
199<div class="doc_subsection">
200<a name="pure">Pure</a>
201</div>
202
203<div class="doc_text">
204<p>
205http://pure-lang.googlecode.com/
206</p>
207
208<p>
209Pure is an algebraic/functional programming language based on term rewriting.
210Programs are collections of equations which are used to evaluate expressions in
211a symbolic fashion. Pure offers dynamic typing, eager and lazy evaluation,
212lexical closures, a hygienic macro system (also based on term rewriting),
213built-in list and matrix support (including list and matrix comprehensions) and
214an easy-to-use C interface. The interpreter uses LLVM as a backend to
215 JIT-compile Pure programs to fast native code.</p>
216
217<p>In addition to the usual algebraic data structures, Pure also has
218MATLAB-style matrices in order to support numeric computations and signal
219processing in an efficient way. Pure is mainly aimed at mathematical
220applications right now, but it has been designed as a general purpose language.
221The dynamic interpreter environment and the C interface make it possible to use
222it as a kind of functional scripting language for many application areas.
223</p>
224</div>
225
226
227<!--=========================================================================-->
228<div class="doc_subsection">
229<a name="ldc">LLVM D Compiler</a>
230</div>
231
232<div class="doc_text">
233<p>
234http://www.dsource.org/projects/ldc
235</p>
236
237<p>
238I'd like to inform that the LDC project (LLVM D
239Compiler) is working with release 2.5 of LLVM. In fact we've required
2402.5 in our trunk since the release was branched.
241The improvements in 2.5 have fixed a lot of problems with LDC, more
242specifically the new inline asm constraints, better debug info
243support, general bugfixes :) and better x86-64 support have allowed
244some major improvements in LDC, getting us much closer to being as
245fully featured as the original DMD compiler from DigitalMars.
246</p>
247</div>
248
249
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000250
251<!-- *********************************************************************** -->
252<div class="doc_section">
Chris Lattner78a130b2008-10-13 18:01:01 +0000253 <a name="whatsnew">What's New in LLVM?</a>
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000254</div>
255<!-- *********************************************************************** -->
256
Chris Lattner5cce7a52008-06-08 22:59:35 +0000257<div class="doc_text">
258
Bill Wendling385b0d32008-10-27 09:27:33 +0000259<p>This release includes a huge number of bug fixes, performance tweaks, and
Chris Lattner92eacf82008-10-13 17:57:36 +0000260minor improvements. Some of the major improvements and new features are listed
261in this section.
Chris Lattner5cce7a52008-06-08 22:59:35 +0000262</p>
263</div>
264
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000265<!--=========================================================================-->
Chris Lattnerf65224f2008-06-08 21:34:41 +0000266<div class="doc_subsection">
Chris Lattnere0798082008-02-06 18:00:06 +0000267<a name="majorfeatures">Major New Features</a>
268</div>
269
270<div class="doc_text">
271
Chris Lattner95d25072009-02-25 04:41:31 +0000272<p>LLVM 2.5 includes several major new capabilities:</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000273
274<ul>
Duncan Sandse2cd8182009-02-25 11:37:39 +0000275<li><p>The code generator now supports arbitrary precision integers.
276Types like <tt>i33</tt> have long been valid in the LLVM IR, but previously
277could only be used with the interpreter.
278Now IR using such types can be compiled to native code on all targets.
279All operations are supported if the integer is not bigger than twice the
280target machine word size.
281Simple operations like loads, stores and shifts by a constant amount are
282supported for integers of any size.
283</p></li>
Chris Lattnera53f4972009-02-25 06:34:50 +0000284
285<!--
286Random stuff:
287
Chris Lattner5c109932009-02-26 07:29:17 +0000288Pure project: http://code.google.com/p/pure-lang/
289
290
Chris Lattner56b64702009-02-25 07:32:53 +0000291xcore backend!
292fortran on darwin!
293
Chris Lattner5c109932009-02-26 07:29:17 +0000294.ll parser rewrite, caret diags, better errors, less fragile (less likely to
295 crash on strange things). No longer depends on flex/bison.
Chris Lattnera79cc152009-02-26 06:47:09 +0000296GCC inliner off, llvm handles always-inline.
Chris Lattnera53f4972009-02-25 06:34:50 +0000297cmake mature?
Chris Lattner5c109932009-02-26 07:29:17 +0000298x86 backend GS segment -> addr space 256 (r62980)
Chris Lattnera53f4972009-02-25 06:34:50 +0000299nocapture
Chris Lattnera79cc152009-02-26 06:47:09 +0000300memdep (used by GVN and memcpyopt) is faster / more aggressive.
Chris Lattner56b64702009-02-25 07:32:53 +0000301how to write a backend doc docs/WritingAnLLVMBackend.html
Chris Lattnera53f4972009-02-25 06:34:50 +0000302fastisel + exception handling
303vector widening <3 x float> -> <4 x float>
Chris Lattner56b64702009-02-25 07:32:53 +0000304arm port improvements? arm jit encoding stuff, constant island support?
Chris Lattnerb2cc5022009-02-26 22:33:38 +0000305JIT TLS support on x86-32 but not x86-64.
Chris Lattner56b64702009-02-25 07:32:53 +0000306mem2reg now faster on code with huge basic blocks
307stack protectors/stack canaries, -fstack-protector, controllable on a
308 per-function basis with attributes.
309shufflevector is generalized to allow different shuffle mask width than its
310 input vectors.
311loop optimizer improves floating point induction variables
312llvm/Analysis/DebugInfo.h classes, llvm-gcc and clang and codegen use them.
Chris Lattner5c109932009-02-26 07:29:17 +0000313 DebugInfoBuilder gone.
Chris Lattner56b64702009-02-25 07:32:53 +0000314asmprinters seperate from targets for jits
Chris Lattner47bcf612009-02-26 05:20:36 +0000315PBQP register allocator now supports register coalescing.
Chris Lattnerb2cc5022009-02-26 22:33:38 +0000316JIT supports exceptions on linux/x86-64 and linux/x86-64.
Chris Lattnera79cc152009-02-26 06:47:09 +0000317integer overflow intrinsics for [us](add/sub/mul). Supported on all targets,
318 but only generates efficient code on x86.
319X86 backend now supports -disable-mmx.
320noalias attribute on return value indicates that function returns new memory
321 (e.g. malloc).
Chris Lattnera79cc152009-02-26 06:47:09 +0000322llvmc2 renamed to llvmc
323Jump threading more powerful: it is iterative, handles threading based on values
324 with fully redundant and partially redundant loads.
325LSR improvements?
326ARM debug info support?
327unit test framework based on Google Test.
328
329vector shift support + X86 backend.
Chris Lattner5c109932009-02-26 07:29:17 +0000330x86 JIT now detects core i7 and atom, autoconfiguring itself appropriately.
331SROA is more aggressive about promoting unions.
332non-zero __builtin_return_address values on X86.
333x86-64 now uses red zone (unless -mno-red-zone option is specified).
334private linkage.
Chris Lattner47bcf612009-02-26 05:20:36 +0000335
Chris Lattner5c109932009-02-26 07:29:17 +0000336llvm-gcc defaults to -fno-math-errno on all x86 targets.
337
338initial support for debug line numbers when optimization enabled, not useful in
339 2.5 but will be for 2.6.
Chris Lattnera53f4972009-02-25 06:34:50 +0000340-->
Chris Lattnerba948522008-06-05 06:57:39 +0000341
Chris Lattner5ba16862008-02-10 08:18:42 +0000342</ul>
343
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000344</div>
345
Chris Lattnerc5a4e312008-06-05 06:25:56 +0000346
347<!--=========================================================================-->
348<div class="doc_subsection">
Chris Lattnerf65224f2008-06-08 21:34:41 +0000349<a name="llvm-gcc">llvm-gcc 4.2 Improvements</a>
Chris Lattnerc5a4e312008-06-05 06:25:56 +0000350</div>
351
352<div class="doc_text">
353
Chris Lattner4352cc82008-10-13 20:47:20 +0000354<p>LLVM fully supports the llvm-gcc 4.2 front-end, which marries the GCC
355front-ends and driver with the LLVM optimizer and code generator. It currently
356includes support for the C, C++, Objective-C, Ada, and Fortran front-ends.</p>
Chris Lattnerc5a4e312008-06-05 06:25:56 +0000357
Chris Lattner5cce7a52008-06-08 22:59:35 +0000358<ul>
Chris Lattner95d25072009-02-25 04:41:31 +0000359<li>?</li>
Gabor Greif0e49cc82008-06-09 06:06:18 +0000360</ul>
Chris Lattnerc5a4e312008-06-05 06:25:56 +0000361
Chris Lattnerc5a4e312008-06-05 06:25:56 +0000362</div>
363
364
Chris Lattnerb0d6c502007-09-21 03:54:09 +0000365<!--=========================================================================-->
366<div class="doc_subsection">
Chris Lattnerc3649452008-02-10 08:17:19 +0000367<a name="coreimprovements">LLVM Core Improvements</a>
368</div>
369
370<div class="doc_text">
Bill Wendling385b0d32008-10-27 09:27:33 +0000371<p>New features include:</p>
Chris Lattnerc3649452008-02-10 08:17:19 +0000372
Chris Lattnerc5a4e312008-06-05 06:25:56 +0000373<ul>
Chris Lattner95d25072009-02-25 04:41:31 +0000374<li>?</li>
Chris Lattnerf7bae6d2008-10-13 20:59:32 +0000375
Chris Lattnerc3649452008-02-10 08:17:19 +0000376</ul>
Mikhail Glushenkov808cd3e2008-10-13 02:08:34 +0000377
Chris Lattnerc3649452008-02-10 08:17:19 +0000378</div>
379
380<!--=========================================================================-->
381<div class="doc_subsection">
Chris Lattner8fda4952008-02-10 07:46:44 +0000382<a name="optimizer">Optimizer Improvements</a>
383</div>
384
385<div class="doc_text">
386
Chris Lattnerea9c2242008-10-13 21:50:36 +0000387<p>In addition to a huge array of bug fixes and minor performance tweaks, this
388release includes a few major enhancements and additions to the optimizers:</p>
Chris Lattner8fda4952008-02-10 07:46:44 +0000389
390<ul>
391
Chris Lattner95d25072009-02-25 04:41:31 +0000392<li>?</li>
Chris Lattnerea9c2242008-10-13 21:50:36 +0000393
Chris Lattner0eef6e42008-06-08 02:45:07 +0000394</ul>
395
396</div>
397
398<!--=========================================================================-->
399<div class="doc_subsection">
400<a name="codegen">Code Generator Improvements</a>
401</div>
402
403<div class="doc_text">
404
Gabor Greifaa53e562008-10-14 11:31:14 +0000405<p>We have put a significant amount of work into the code generator infrastructure,
Chris Lattner0eef6e42008-06-08 02:45:07 +0000406which allows us to implement more aggressive algorithms and make it run
407faster:</p>
408
409<ul>
Duncan Sands335d5e42009-02-25 11:50:08 +0000410<li>The type legalization logic has been completely rewritten, and is now
411more powerful (it supports arbitrary precision integer types for example)
412and hopefully more correct.
413The type legalizer converts operations on types that are not natively
414supported by the target machine into equivalent code sequences that only use
415natively supported types.
416The old type legalizer is still available and will be used if
417<tt>-disable-legalize-types</tt> is passed to <tt>llc</tt>.
418</li>
Chris Lattner95d25072009-02-25 04:41:31 +0000419<li>?</li>
Chris Lattner0eef6e42008-06-08 02:45:07 +0000420
Chris Lattnerb0d6c502007-09-21 03:54:09 +0000421</ul>
422
423</div>
424
425
426<!--=========================================================================-->
427<div class="doc_subsection">
Chris Lattnere1fbd752009-02-26 07:32:11 +0000428<a name="pic16">PIC16 Target Improvements</a>
429</div>
430
431<div class="doc_text">
432<p>New features of the PIC16 target include:
433</p>
434
435<ul>
436<li>Both direct and indirect load/stores work now.</li>
437<li>Logical, bitwise and conditional operations now work for integer data
438types.</li>
439<li>Function calls involving basic types work now.</li>
440<li>Support for integer arrays.</li>
441<li>Compiler can now emit libcalls for operations not support by m/c insns.</li>
442<li>Support for both data and rom address spaces.</li>
443</li>
444</ul>
445
446<p>Things not yet supported:</p>
447
448<ul>
449<li>Floating point.</li>
450<li>Passing/returning aggregate types to/from functions.</li>
451<li>Variable arguments.</li>
452<li>Indirect function calls.</li>
453<li>Interrupts/prgrams.</li>
454<li>Debug info.</li>
455</li>
456</ul>
457
458</div>
459
460
461<!--=========================================================================-->
462<div class="doc_subsection">
463<a name="othertargetspecific">Other Target Specific Improvements</a>
Chris Lattnerb0d6c502007-09-21 03:54:09 +0000464</div>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000465
466<div class="doc_text">
Chris Lattnerc3649452008-02-10 08:17:19 +0000467<p>New target-specific features include:
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000468</p>
469
470<ul>
Chris Lattner95d25072009-02-25 04:41:31 +0000471<li>?</li>
Chris Lattnere45f18b2008-06-05 08:02:49 +0000472</ul>
Chris Lattnere45f18b2008-06-05 08:02:49 +0000473
Mikhail Glushenkov808cd3e2008-10-13 02:08:34 +0000474</div>
Chris Lattnere45f18b2008-06-05 08:02:49 +0000475
476
477<!--=========================================================================-->
478<div class="doc_subsection">
Chris Lattnerb0d6c502007-09-21 03:54:09 +0000479<a name="otherimprovements">Other Improvements</a>
480</div>
481
482<div class="doc_text">
483<p>New features include:
484</p>
485
486<ul>
Chris Lattner95d25072009-02-25 04:41:31 +0000487<li>?</li>
Tanya Lattnerc79f7542008-11-04 18:40:27 +0000488
Chris Lattnerb0d6c502007-09-21 03:54:09 +0000489</ul>
Mikhail Glushenkov808cd3e2008-10-13 02:08:34 +0000490
Chris Lattnerb0d6c502007-09-21 03:54:09 +0000491</div>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000492
Chris Lattner92eacf82008-10-13 17:57:36 +0000493<!--=========================================================================-->
494<div class="doc_subsection">
495<a name="changes">Major Changes and Removed Features</a>
496</div>
497
498<div class="doc_text">
499
Chris Lattnercc64a322008-10-13 22:06:31 +0000500<p>If you're already an LLVM user or developer with out-of-tree changes based
Chris Lattner95d25072009-02-25 04:41:31 +0000501on LLVM 2.4, this section lists some "gotchas" that you may run into upgrading
Chris Lattnercc64a322008-10-13 22:06:31 +0000502from the previous release.</p>
Chris Lattner92eacf82008-10-13 17:57:36 +0000503
504<ul>
505
Chris Lattner95d25072009-02-25 04:41:31 +0000506<li>?</li>
Chris Lattnercc64a322008-10-13 22:06:31 +0000507</ul>
508
509
510<p>In addition, many APIs have changed in this release. Some of the major LLVM
511API changes are:</p>
512
513<ul>
Chris Lattner95d25072009-02-25 04:41:31 +0000514<li>?</li>
Devang Patel0e3da1a2008-10-14 20:03:43 +0000515</ul>
Chris Lattner92eacf82008-10-13 17:57:36 +0000516
Chris Lattner95d25072009-02-25 04:41:31 +0000517<li>?</li>
Chris Lattner92eacf82008-10-13 17:57:36 +0000518</ul>
519
520</div>
521
522
523
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000524<!-- *********************************************************************** -->
525<div class="doc_section">
526 <a name="portability">Portability and Supported Platforms</a>
527</div>
528<!-- *********************************************************************** -->
529
530<div class="doc_text">
531
532<p>LLVM is known to work on the following platforms:</p>
533
534<ul>
Chris Lattnerb1ad47c2008-11-10 05:40:34 +0000535<li>Intel and AMD machines (IA32, X86-64, AMD64, EMT-64) running Red Hat
536Linux, Fedora Core and FreeBSD (and probably other unix-like systems).</li>
537<li>PowerPC and X86-based Mac OS X systems, running 10.3 and above in 32-bit
538and 64-bit modes.</li>
Chris Lattnere0798082008-02-06 18:00:06 +0000539<li>Intel and AMD machines running on Win32 using MinGW libraries (native).</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000540<li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
541 support is available for native builds with Visual C++).</li>
Gabor Greif5e75e652008-06-05 18:39:01 +0000542<li>Sun UltraSPARC workstations running Solaris 10.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000543<li>Alpha-based machines running Debian GNU/Linux.</li>
Gabor Greif5e75e652008-06-05 18:39:01 +0000544<li>Itanium-based (IA64) machines running Linux and HP-UX.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000545</ul>
546
Chris Lattnerba948522008-06-05 06:57:39 +0000547<p>The core LLVM infrastructure uses GNU autoconf to adapt itself
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000548to the machine and operating system on which it is built. However, minor
549porting may be required to get LLVM to work on new platforms. We welcome your
550portability patches and reports of successful builds or error messages.</p>
551
552</div>
553
554<!-- *********************************************************************** -->
555<div class="doc_section">
556 <a name="knownproblems">Known Problems</a>
557</div>
558<!-- *********************************************************************** -->
559
560<div class="doc_text">
561
Chris Lattnerb1ad47c2008-11-10 05:40:34 +0000562<p>This section contains significant known problems with the LLVM system,
563listed by component. If you run into a problem, please check the <a
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000564href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
565there isn't already one.</p>
566
567</div>
568
569<!-- ======================================================================= -->
570<div class="doc_subsection">
571 <a name="experimental">Experimental features included with this release</a>
572</div>
573
574<div class="doc_text">
575
576<p>The following components of this LLVM release are either untested, known to
577be broken or unreliable, or are in early development. These components should
578not be relied on, and bugs should not be filed against them, but they may be
579useful to some people. In particular, if you would like to work on one of these
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000580components, please contact us on the <a
581href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000582
583<ul>
Gabor Greifaa53e562008-10-14 11:31:14 +0000584<li>The MSIL, IA64, Alpha, SPU, MIPS, and PIC16 backends are experimental.</li>
Duncan Sandsa73561c2008-06-08 20:18:35 +0000585<li>The llc "<tt>-filetype=asm</tt>" (the default) is the only supported
Chris Lattnerbd633de92008-02-06 06:30:34 +0000586 value for this option.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000587</ul>
588
589</div>
590
591<!-- ======================================================================= -->
592<div class="doc_subsection">
593 <a name="x86-be">Known problems with the X86 back-end</a>
594</div>
595
596<div class="doc_text">
597
598<ul>
Anton Korobeynikov77d15e22008-06-08 10:24:13 +0000599 <li>The X86 backend does not yet support
600 all <a href="http://llvm.org/PR879">inline assembly that uses the X86
601 floating point stack</a>. It supports the 'f' and 't' constraints, but not
602 'u'.</li>
Chris Lattnerd95b5962008-06-08 21:19:07 +0000603 <li>The X86 backend generates inefficient floating point code when configured
604 to generate code for systems that don't have SSE2.</li>
Duncan Sands8b4f3772008-06-08 19:38:43 +0000605 <li>Win64 code generation wasn't widely tested. Everything should work, but we
Anton Korobeynikov77d15e22008-06-08 10:24:13 +0000606 expect small issues to happen. Also, llvm-gcc cannot build mingw64 runtime
607 currently due
608 to <a href="http://llvm.org/PR2255">several</a>
Chris Lattnerf06141a2008-06-08 23:12:47 +0000609 <a href="http://llvm.org/PR2257">bugs</a> due to lack of support for the
610 'u' inline assembly constraint and X87 floating point inline assembly.</li>
Dan Gohman3882ecb2008-06-08 23:05:11 +0000611 <li>The X86-64 backend does not yet support the LLVM IR instruction
612 <tt>va_arg</tt>. Currently, the llvm-gcc front-end supports variadic
613 argument constructs on X86-64 by lowering them manually.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000614</ul>
615
616</div>
617
618<!-- ======================================================================= -->
619<div class="doc_subsection">
620 <a name="ppc-be">Known problems with the PowerPC back-end</a>
621</div>
622
623<div class="doc_text">
624
625<ul>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000626<li>The Linux PPC32/ABI support needs testing for the interpreter and static
627compilation, and lacks support for debug information.</li>
628</ul>
629
630</div>
631
632<!-- ======================================================================= -->
633<div class="doc_subsection">
634 <a name="arm-be">Known problems with the ARM back-end</a>
635</div>
636
637<div class="doc_text">
638
639<ul>
640<li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
Duncan Sands1827fa62007-09-26 15:59:54 +0000641processors, thumb programs can crash or produce wrong
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000642results (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
643<li>Compilation for ARM Linux OABI (old ABI) is supported, but not fully tested.
644</li>
Chris Lattnerd95b5962008-06-08 21:19:07 +0000645<li>There is a bug in QEMU-ARM (&lt;= 0.9.0) which causes it to incorrectly
646 execute
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000647programs compiled with LLVM. Please use more recent versions of QEMU.</li>
648</ul>
649
650</div>
651
652<!-- ======================================================================= -->
653<div class="doc_subsection">
654 <a name="sparc-be">Known problems with the SPARC back-end</a>
655</div>
656
657<div class="doc_text">
658
659<ul>
660<li>The SPARC backend only supports the 32-bit SPARC ABI (-m32), it does not
661 support the 64-bit SPARC ABI (-m64).</li>
662</ul>
663
664</div>
665
666<!-- ======================================================================= -->
667<div class="doc_subsection">
Bruno Cardoso Lopes62d45d72008-10-25 14:56:26 +0000668 <a name="mips-be">Known problems with the MIPS back-end</a>
669</div>
670
671<div class="doc_text">
672
673<ul>
674<li>The O32 ABI is not fully supported.</li>
675<li>64-bit MIPS targets are not supported yet.</li>
676</ul>
677
678</div>
679
680<!-- ======================================================================= -->
681<div class="doc_subsection">
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000682 <a name="alpha-be">Known problems with the Alpha back-end</a>
683</div>
684
685<div class="doc_text">
686
687<ul>
688
689<li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
690appropriate nops inserted to ensure restartability.</li>
691
692</ul>
693</div>
694
695<!-- ======================================================================= -->
696<div class="doc_subsection">
697 <a name="ia64-be">Known problems with the IA64 back-end</a>
698</div>
699
700<div class="doc_text">
701
702<ul>
Chris Lattnerf06141a2008-06-08 23:12:47 +0000703<li>The Itanium backend is highly experimental, and has a number of known
704 issues. We are looking for a maintainer for the Itanium backend. If you
Gabor Greif45fc8b12008-10-15 10:47:24 +0000705 are interested, please contact the LLVMdev mailing list.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000706</ul>
707
708</div>
709
710<!-- ======================================================================= -->
711<div class="doc_subsection">
712 <a name="c-be">Known problems with the C back-end</a>
713</div>
714
715<div class="doc_text">
716
717<ul>
Chris Lattner499c07c2008-06-05 06:35:40 +0000718<li><a href="http://llvm.org/PR802">The C backend has only basic support for
719 inline assembly code</a>.</li>
Chris Lattnere0194462007-09-26 06:01:35 +0000720<li><a href="http://llvm.org/PR1658">The C backend violates the ABI of common
721 C++ programs</a>, preventing intermixing between C++ compiled by the CBE and
Duncan Sandsa73561c2008-06-08 20:18:35 +0000722 C++ code compiled with llc or native compilers.</li>
Duncan Sandsbd0ad6e2008-02-10 13:40:55 +0000723<li>The C backend does not support all exception handling constructs.</li>
Duncan Sandse6e264c2009-02-25 11:51:54 +0000724<li>The C backend does not support arbitrary precision integers.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000725</ul>
726
727</div>
728
729
730<!-- ======================================================================= -->
731<div class="doc_subsection">
Chris Lattner499c07c2008-06-05 06:35:40 +0000732 <a name="c-fe">Known problems with the llvm-gcc C front-end</a>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000733</div>
734
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000735<div class="doc_text">
736
Chris Lattnere0798082008-02-06 18:00:06 +0000737<p>llvm-gcc does not currently support <a href="http://llvm.org/PR869">Link-Time
738Optimization</a> on most platforms "out-of-the-box". Please inquire on the
Gabor Greif45fc8b12008-10-15 10:47:24 +0000739LLVMdev mailing list if you are interested.</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000740
Chris Lattner499c07c2008-06-05 06:35:40 +0000741<p>The only major language feature of GCC not supported by llvm-gcc is
742 the <tt>__builtin_apply</tt> family of builtins. However, some extensions
743 are only supported on some targets. For example, trampolines are only
Duncan Sandsa73561c2008-06-08 20:18:35 +0000744 supported on some targets (these are used when you take the address of a
745 nested function).</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000746
Chris Lattner499c07c2008-06-05 06:35:40 +0000747<p>If you run into GCC extensions which are not supported, please let us know.
748</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000749
750</div>
751
752<!-- ======================================================================= -->
753<div class="doc_subsection">
Chris Lattner499c07c2008-06-05 06:35:40 +0000754 <a name="c++-fe">Known problems with the llvm-gcc C++ front-end</a>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000755</div>
756
757<div class="doc_text">
758
759<p>The C++ front-end is considered to be fully
760tested and works for a number of non-trivial programs, including LLVM
761itself, Qt, Mozilla, etc.</p>
762
763<ul>
Anton Korobeynikovd9a17932008-10-11 18:27:16 +0000764<li>Exception handling works well on the X86 and PowerPC targets. Currently
Chris Lattnerb1ad47c2008-11-10 05:40:34 +0000765 only Linux and Darwin targets are supported (both 32 and 64 bit).</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000766</ul>
767
768</div>
769
Chris Lattner6c8a1b82008-10-30 03:58:13 +0000770<!-- ======================================================================= -->
771<div class="doc_subsection">
772 <a name="fortran-fe">Known problems with the llvm-gcc Fortran front-end</a>
773</div>
774
775<div class="doc_text">
Gabor Greif1fc8fbc2008-11-04 21:50:59 +0000776<ul>
Chris Lattner6c8a1b82008-10-30 03:58:13 +0000777<li>Fortran support generally works, but there are still several unresolved bugs
778 in Bugzilla. Please see the tools/gfortran component for details.</li>
779
780<li>The Fortran front-end currently does not build on Darwin (without tweaks)
781 due to unresolved dependencies on the C front-end.</li>
Gabor Greif1fc8fbc2008-11-04 21:50:59 +0000782</ul>
Chris Lattner6c8a1b82008-10-30 03:58:13 +0000783</div>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000784
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000785<!-- ======================================================================= -->
786<div class="doc_subsection">
Chris Lattner499c07c2008-06-05 06:35:40 +0000787 <a name="ada-fe">Known problems with the llvm-gcc Ada front-end</a>
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000788</div>
789
790<div class="doc_text">
791The llvm-gcc 4.2 Ada compiler works fairly well, however this is not a mature
792technology and problems should be expected.
793<ul>
Duncan Sandsa73561c2008-06-08 20:18:35 +0000794<li>The Ada front-end currently only builds on X86-32. This is mainly due
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000795to lack of trampoline support (pointers to nested functions) on other platforms,
Duncan Sandsa73561c2008-06-08 20:18:35 +0000796however it <a href="http://llvm.org/PR2006">also fails to build on X86-64</a>
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000797which does support trampolines.</li>
798<li>The Ada front-end <a href="http://llvm.org/PR2007">fails to bootstrap</a>.
Duncan Sandsf73473e2009-02-25 11:59:06 +0000799This is due to lack of LLVM support for <tt>setjmp</tt>/<tt>longjmp</tt> style
800exception handling, which is used internally by the compiler.
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000801Workaround: configure with --disable-bootstrap.</li>
Duncan Sands2dbc2e82008-10-13 17:27:23 +0000802<li>The c380004, <a href="http://llvm.org/PR2010">c393010</a>
803and <a href="http://llvm.org/PR2421">cxg2021</a> ACATS tests fail
Duncan Sandsf73473e2009-02-25 11:59:06 +0000804(c380004 also fails with gcc-4.2 mainline).
805If the compiler is built with checks disabled then <a href="http://llvm.org/PR2010">c393010</a>
806causes the compiler to go into an infinite loop, using up all system memory.</li>
Duncan Sands2dbc2e82008-10-13 17:27:23 +0000807<li>Some gcc specific Ada tests continue to crash the compiler.</li>
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000808<li>The -E binder option (exception backtraces)
809<a href="http://llvm.org/PR1982">does not work</a> and will result in programs
810crashing if an exception is raised. Workaround: do not use -E.</li>
811<li>Only discrete types <a href="http://llvm.org/PR1981">are allowed to start
812or finish at a non-byte offset</a> in a record. Workaround: do not pack records
813or use representation clauses that result in a field of a non-discrete type
814starting or finishing in the middle of a byte.</li>
Chris Lattnerd95b5962008-06-08 21:19:07 +0000815<li>The <tt>lli</tt> interpreter <a href="http://llvm.org/PR2009">considers
816'main' as generated by the Ada binder to be invalid</a>.
817Workaround: hand edit the file to use pointers for <tt>argv</tt> and
818<tt>envp</tt> rather than integers.</li>
819<li>The <tt>-fstack-check</tt> option <a href="http://llvm.org/PR2008">is
820ignored</a>.</li>
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000821</ul>
822</div>
823
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000824<!-- *********************************************************************** -->
825<div class="doc_section">
826 <a name="additionalinfo">Additional Information</a>
827</div>
828<!-- *********************************************************************** -->
829
830<div class="doc_text">
831
832<p>A wide variety of additional information is available on the <a
833href="http://llvm.org">LLVM web page</a>, in particular in the <a
834href="http://llvm.org/docs/">documentation</a> section. The web page also
835contains versions of the API documentation which is up-to-date with the
836Subversion version of the source code.
837You can access versions of these documents specific to this release by going
838into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
839
840<p>If you have any questions or comments about LLVM, please feel free to contact
841us via the <a href="http://llvm.org/docs/#maillist"> mailing
842lists</a>.</p>
843
844</div>
845
846<!-- *********************************************************************** -->
847
848<hr>
849<address>
850 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman947321d2008-12-11 17:34:48 +0000851 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000852 <a href="http://validator.w3.org/check/referer"><img
Misha Brukman947321d2008-12-11 17:34:48 +0000853 src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000854
855 <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
856 Last modified: $Date$
857</address>
858
859</body>
860</html>