blob: 3199c2b7c0f24e8af06c651dd9c583f9971ae8f7 [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 Kremenek0437b2c2008-10-14 05:14:21 +0000136<p>The Clang project also includes an early stage static source code analysis
137tool for <a href="http://clang.llvm.org/StaticAnalysis.html">automatically
138finding bugs</a> in C and Objective-C programs. The tool performs a growing set
Chris Lattnerff170152008-10-14 06:02:29 +0000139of checks to find bugs that occur on a specific path within a program. Examples
Ted Kremenek0437b2c2008-10-14 05:14:21 +0000140of bugs the tool finds include logic errors such as null dereferences,
141violations of various API rules, dead code, and potential memory leaks in
Chris Lattnerff170152008-10-14 06:02:29 +0000142Objective-C programs. Since its inception, public feedback on the tool has been
143extremely positive, and conservative estimates put the number of real bugs it
144has found in industrial-quality software on the order of thousands.</p>
Chris Lattnerc2d84672008-10-14 00:52:49 +0000145
Ted Kremenek0437b2c2008-10-14 05:14:21 +0000146<p>The tool also provides a simple web GUI to inspect potential bugs found by
Chris Lattnerff170152008-10-14 06:02:29 +0000147the tool. While still early in development, the GUI illustrates some of the key
Ted Kremenek0437b2c2008-10-14 05:14:21 +0000148features of Clang: accurate source location information, which is used by the
149GUI to highlight specific code expressions that relate to a bug (including those
Bill Wendling385b0d32008-10-27 09:27:33 +0000150that span multiple lines); and built-in knowledge of macros, which is used to
Ted Kremenek0437b2c2008-10-14 05:14:21 +0000151perform inline expansion of macros within the GUI itself.</p>
152
Chris Lattnerff170152008-10-14 06:02:29 +0000153<p>The set of checks performed by the static analyzer is gradually expanding,
Bill Wendling385b0d32008-10-27 09:27:33 +0000154and future plans for the tool include full source-level inter-procedural
155analysis and deeper checks such as buffer overrun detection. There are many
156opportunities to extend and enhance the static analyzer, and anyone interested
157in working on this project is encouraged to get involved!</p>
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000158
159</div>
160
Chris Lattner78a130b2008-10-13 18:01:01 +0000161<!--=========================================================================-->
162<div class="doc_subsection">
Nicolas Geoffray2b139382008-10-14 19:23:04 +0000163<a name="vmkit">VMKit: JVM/CLI Virtual Machine Implementation</a>
Chris Lattner78a130b2008-10-13 18:01:01 +0000164</div>
165
166<div class="doc_text">
167<p>
Nicolas Geoffray2b139382008-10-14 19:23:04 +0000168The <a href="http://vmkit.llvm.org/">VMKit project</a> is an implementation of
Chris Lattner78a130b2008-10-13 18:01:01 +0000169a JVM and a CLI Virtual Machines (Microsoft .NET is an
170implementation of the CLI) using the Just-In-Time compiler of LLVM.</p>
171
Chris Lattner02408742009-02-25 05:45:05 +0000172<p>Following LLVM 2.5, VMKit has its first release ? that you can find on its
Nicolas Geoffray20cfdd42008-10-15 20:25:04 +0000173<a href="http://vmkit.llvm.org/releases/">webpage</a>. The release includes
174bug fixes, cleanup and new features. The major changes are:</p>
Chris Lattner78a130b2008-10-13 18:01:01 +0000175
Nicolas Geoffray2b139382008-10-14 19:23:04 +0000176<ul>
177
Chris Lattner47bcf612009-02-26 05:20:36 +0000178<li>Ahead of Time compiler: compiles .class files to llvm .bc. VMKit uses this
179functionality to native compile the standard classes (eg java.lang.String).
180Users can compile AOT .class files into dynamic libraries and run them with the
181help of VMKit.</li>
182
183<li>New exception model: the dwarf exception model is very slow for
184exception-intensive applications, so the JVM has had a new implementation of
185exceptions which check at each function call if an exception happened. There is
186a low performance penalty on applications without exceptions, but it is a big
187gain for exception-intensive applications. For example the jack benchmark in
188Spec JVM98 is 6x faster (performance gain of 83%).</li>
189
190<li>New support for OSX/X64, Linux/X64 (with the Boehm GC), Linux/ppc32.</li>
Nicolas Geoffray2b139382008-10-14 19:23:04 +0000191
192</ul>
Chris Lattner78a130b2008-10-13 18:01:01 +0000193</div>
194
Chris Lattnerb2cc5022009-02-26 22:33:38 +0000195<!-- *********************************************************************** -->
196<div class="doc_section">
197 <a name="externalproj">External Projects Using LLVM 2.5</a>
198</div>
199<!-- *********************************************************************** -->
200
201<!--=========================================================================-->
202<div class="doc_subsection">
203<a name="pure">Pure</a>
204</div>
205
206<div class="doc_text">
207<p>
208http://pure-lang.googlecode.com/
209</p>
210
211<p>
212Pure is an algebraic/functional programming language based on term rewriting.
213Programs are collections of equations which are used to evaluate expressions in
214a symbolic fashion. Pure offers dynamic typing, eager and lazy evaluation,
215lexical closures, a hygienic macro system (also based on term rewriting),
216built-in list and matrix support (including list and matrix comprehensions) and
217an easy-to-use C interface. The interpreter uses LLVM as a backend to
218 JIT-compile Pure programs to fast native code.</p>
219
220<p>In addition to the usual algebraic data structures, Pure also has
221MATLAB-style matrices in order to support numeric computations and signal
222processing in an efficient way. Pure is mainly aimed at mathematical
223applications right now, but it has been designed as a general purpose language.
224The dynamic interpreter environment and the C interface make it possible to use
225it as a kind of functional scripting language for many application areas.
226</p>
227</div>
228
229
230<!--=========================================================================-->
231<div class="doc_subsection">
232<a name="ldc">LLVM D Compiler</a>
233</div>
234
235<div class="doc_text">
236<p>
237http://www.dsource.org/projects/ldc
238</p>
239
240<p>
241I'd like to inform that the LDC project (LLVM D
242Compiler) is working with release 2.5 of LLVM. In fact we've required
2432.5 in our trunk since the release was branched.
244The improvements in 2.5 have fixed a lot of problems with LDC, more
245specifically the new inline asm constraints, better debug info
246support, general bugfixes :) and better x86-64 support have allowed
247some major improvements in LDC, getting us much closer to being as
248fully featured as the original DMD compiler from DigitalMars.
249</p>
250</div>
251
252
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000253
254<!-- *********************************************************************** -->
255<div class="doc_section">
Chris Lattner78a130b2008-10-13 18:01:01 +0000256 <a name="whatsnew">What's New in LLVM?</a>
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000257</div>
258<!-- *********************************************************************** -->
259
Chris Lattner5cce7a52008-06-08 22:59:35 +0000260<div class="doc_text">
261
Bill Wendling385b0d32008-10-27 09:27:33 +0000262<p>This release includes a huge number of bug fixes, performance tweaks, and
Chris Lattner92eacf82008-10-13 17:57:36 +0000263minor improvements. Some of the major improvements and new features are listed
264in this section.
Chris Lattner5cce7a52008-06-08 22:59:35 +0000265</p>
266</div>
267
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000268<!--=========================================================================-->
Chris Lattnerf65224f2008-06-08 21:34:41 +0000269<div class="doc_subsection">
Chris Lattnere0798082008-02-06 18:00:06 +0000270<a name="majorfeatures">Major New Features</a>
271</div>
272
273<div class="doc_text">
274
Chris Lattner95d25072009-02-25 04:41:31 +0000275<p>LLVM 2.5 includes several major new capabilities:</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000276
277<ul>
Duncan Sandse2cd8182009-02-25 11:37:39 +0000278<li><p>The code generator now supports arbitrary precision integers.
279Types like <tt>i33</tt> have long been valid in the LLVM IR, but previously
280could only be used with the interpreter.
281Now IR using such types can be compiled to native code on all targets.
282All operations are supported if the integer is not bigger than twice the
283target machine word size.
284Simple operations like loads, stores and shifts by a constant amount are
285supported for integers of any size.
286</p></li>
Chris Lattnera53f4972009-02-25 06:34:50 +0000287
288<!--
289Random stuff:
290
Chris Lattner5c109932009-02-26 07:29:17 +0000291Pure project: http://code.google.com/p/pure-lang/
292
293
Chris Lattner56b64702009-02-25 07:32:53 +0000294xcore backend!
295fortran on darwin!
296
Chris Lattner5c109932009-02-26 07:29:17 +0000297.ll parser rewrite, caret diags, better errors, less fragile (less likely to
298 crash on strange things). No longer depends on flex/bison.
Chris Lattnera79cc152009-02-26 06:47:09 +0000299GCC inliner off, llvm handles always-inline.
Chris Lattnera53f4972009-02-25 06:34:50 +0000300cmake mature?
Chris Lattner5c109932009-02-26 07:29:17 +0000301x86 backend GS segment -> addr space 256 (r62980)
Chris Lattnera53f4972009-02-25 06:34:50 +0000302nocapture
Chris Lattnera79cc152009-02-26 06:47:09 +0000303memdep (used by GVN and memcpyopt) is faster / more aggressive.
Chris Lattner56b64702009-02-25 07:32:53 +0000304how to write a backend doc docs/WritingAnLLVMBackend.html
Chris Lattnera53f4972009-02-25 06:34:50 +0000305fastisel + exception handling
306vector widening <3 x float> -> <4 x float>
Chris Lattner56b64702009-02-25 07:32:53 +0000307arm port improvements? arm jit encoding stuff, constant island support?
Chris Lattnerb2cc5022009-02-26 22:33:38 +0000308JIT TLS support on x86-32 but not x86-64.
Chris Lattner56b64702009-02-25 07:32:53 +0000309mem2reg now faster on code with huge basic blocks
310stack protectors/stack canaries, -fstack-protector, controllable on a
311 per-function basis with attributes.
312shufflevector is generalized to allow different shuffle mask width than its
313 input vectors.
314loop optimizer improves floating point induction variables
315llvm/Analysis/DebugInfo.h classes, llvm-gcc and clang and codegen use them.
Chris Lattner5c109932009-02-26 07:29:17 +0000316 DebugInfoBuilder gone.
Chris Lattner56b64702009-02-25 07:32:53 +0000317asmprinters seperate from targets for jits
Chris Lattner47bcf612009-02-26 05:20:36 +0000318PBQP register allocator now supports register coalescing.
Chris Lattnerb2cc5022009-02-26 22:33:38 +0000319JIT supports exceptions on linux/x86-64 and linux/x86-64.
Chris Lattnera79cc152009-02-26 06:47:09 +0000320integer overflow intrinsics for [us](add/sub/mul). Supported on all targets,
321 but only generates efficient code on x86.
322X86 backend now supports -disable-mmx.
323noalias attribute on return value indicates that function returns new memory
324 (e.g. malloc).
Chris Lattnera79cc152009-02-26 06:47:09 +0000325llvmc2 renamed to llvmc
326Jump threading more powerful: it is iterative, handles threading based on values
327 with fully redundant and partially redundant loads.
328LSR improvements?
329ARM debug info support?
330unit test framework based on Google Test.
331
332vector shift support + X86 backend.
Chris Lattner5c109932009-02-26 07:29:17 +0000333x86 JIT now detects core i7 and atom, autoconfiguring itself appropriately.
334SROA is more aggressive about promoting unions.
335non-zero __builtin_return_address values on X86.
336x86-64 now uses red zone (unless -mno-red-zone option is specified).
337private linkage.
Chris Lattner47bcf612009-02-26 05:20:36 +0000338
Chris Lattner5c109932009-02-26 07:29:17 +0000339llvm-gcc defaults to -fno-math-errno on all x86 targets.
340
341initial support for debug line numbers when optimization enabled, not useful in
342 2.5 but will be for 2.6.
Chris Lattnera53f4972009-02-25 06:34:50 +0000343-->
Chris Lattnerba948522008-06-05 06:57:39 +0000344
Chris Lattner5ba16862008-02-10 08:18:42 +0000345</ul>
346
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000347</div>
348
Chris Lattnerc5a4e312008-06-05 06:25:56 +0000349
350<!--=========================================================================-->
351<div class="doc_subsection">
Chris Lattnerf65224f2008-06-08 21:34:41 +0000352<a name="llvm-gcc">llvm-gcc 4.2 Improvements</a>
Chris Lattnerc5a4e312008-06-05 06:25:56 +0000353</div>
354
355<div class="doc_text">
356
Chris Lattner4352cc82008-10-13 20:47:20 +0000357<p>LLVM fully supports the llvm-gcc 4.2 front-end, which marries the GCC
358front-ends and driver with the LLVM optimizer and code generator. It currently
359includes support for the C, C++, Objective-C, Ada, and Fortran front-ends.</p>
Chris Lattnerc5a4e312008-06-05 06:25:56 +0000360
Chris Lattner5cce7a52008-06-08 22:59:35 +0000361<ul>
Chris Lattner95d25072009-02-25 04:41:31 +0000362<li>?</li>
Gabor Greif0e49cc82008-06-09 06:06:18 +0000363</ul>
Chris Lattnerc5a4e312008-06-05 06:25:56 +0000364
Chris Lattnerc5a4e312008-06-05 06:25:56 +0000365</div>
366
367
Chris Lattnerb0d6c502007-09-21 03:54:09 +0000368<!--=========================================================================-->
369<div class="doc_subsection">
Chris Lattnerc3649452008-02-10 08:17:19 +0000370<a name="coreimprovements">LLVM Core Improvements</a>
371</div>
372
373<div class="doc_text">
Bill Wendling385b0d32008-10-27 09:27:33 +0000374<p>New features include:</p>
Chris Lattnerc3649452008-02-10 08:17:19 +0000375
Chris Lattnerc5a4e312008-06-05 06:25:56 +0000376<ul>
Chris Lattner95d25072009-02-25 04:41:31 +0000377<li>?</li>
Chris Lattnerf7bae6d2008-10-13 20:59:32 +0000378
Chris Lattnerc3649452008-02-10 08:17:19 +0000379</ul>
Mikhail Glushenkov808cd3e2008-10-13 02:08:34 +0000380
Chris Lattnerc3649452008-02-10 08:17:19 +0000381</div>
382
383<!--=========================================================================-->
384<div class="doc_subsection">
Chris Lattner8fda4952008-02-10 07:46:44 +0000385<a name="optimizer">Optimizer Improvements</a>
386</div>
387
388<div class="doc_text">
389
Chris Lattnerea9c2242008-10-13 21:50:36 +0000390<p>In addition to a huge array of bug fixes and minor performance tweaks, this
391release includes a few major enhancements and additions to the optimizers:</p>
Chris Lattner8fda4952008-02-10 07:46:44 +0000392
393<ul>
394
Chris Lattner95d25072009-02-25 04:41:31 +0000395<li>?</li>
Chris Lattnerea9c2242008-10-13 21:50:36 +0000396
Chris Lattner0eef6e42008-06-08 02:45:07 +0000397</ul>
398
399</div>
400
401<!--=========================================================================-->
402<div class="doc_subsection">
403<a name="codegen">Code Generator Improvements</a>
404</div>
405
406<div class="doc_text">
407
Gabor Greifaa53e562008-10-14 11:31:14 +0000408<p>We have put a significant amount of work into the code generator infrastructure,
Chris Lattner0eef6e42008-06-08 02:45:07 +0000409which allows us to implement more aggressive algorithms and make it run
410faster:</p>
411
412<ul>
Duncan Sands335d5e42009-02-25 11:50:08 +0000413<li>The type legalization logic has been completely rewritten, and is now
414more powerful (it supports arbitrary precision integer types for example)
415and hopefully more correct.
416The type legalizer converts operations on types that are not natively
417supported by the target machine into equivalent code sequences that only use
418natively supported types.
419The old type legalizer is still available and will be used if
420<tt>-disable-legalize-types</tt> is passed to <tt>llc</tt>.
421</li>
Chris Lattner95d25072009-02-25 04:41:31 +0000422<li>?</li>
Chris Lattner0eef6e42008-06-08 02:45:07 +0000423
Chris Lattnerb0d6c502007-09-21 03:54:09 +0000424</ul>
425
426</div>
427
428
429<!--=========================================================================-->
430<div class="doc_subsection">
Chris Lattnere1fbd752009-02-26 07:32:11 +0000431<a name="pic16">PIC16 Target Improvements</a>
432</div>
433
434<div class="doc_text">
435<p>New features of the PIC16 target include:
436</p>
437
438<ul>
439<li>Both direct and indirect load/stores work now.</li>
440<li>Logical, bitwise and conditional operations now work for integer data
441types.</li>
442<li>Function calls involving basic types work now.</li>
443<li>Support for integer arrays.</li>
444<li>Compiler can now emit libcalls for operations not support by m/c insns.</li>
445<li>Support for both data and rom address spaces.</li>
446</li>
447</ul>
448
449<p>Things not yet supported:</p>
450
451<ul>
452<li>Floating point.</li>
453<li>Passing/returning aggregate types to/from functions.</li>
454<li>Variable arguments.</li>
455<li>Indirect function calls.</li>
456<li>Interrupts/prgrams.</li>
457<li>Debug info.</li>
458</li>
459</ul>
460
461</div>
462
463
464<!--=========================================================================-->
465<div class="doc_subsection">
466<a name="othertargetspecific">Other Target Specific Improvements</a>
Chris Lattnerb0d6c502007-09-21 03:54:09 +0000467</div>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000468
469<div class="doc_text">
Chris Lattnerc3649452008-02-10 08:17:19 +0000470<p>New target-specific features include:
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000471</p>
472
473<ul>
Chris Lattner95d25072009-02-25 04:41:31 +0000474<li>?</li>
Chris Lattnere45f18b2008-06-05 08:02:49 +0000475</ul>
Chris Lattnere45f18b2008-06-05 08:02:49 +0000476
Mikhail Glushenkov808cd3e2008-10-13 02:08:34 +0000477</div>
Chris Lattnere45f18b2008-06-05 08:02:49 +0000478
479
480<!--=========================================================================-->
481<div class="doc_subsection">
Chris Lattnerb0d6c502007-09-21 03:54:09 +0000482<a name="otherimprovements">Other Improvements</a>
483</div>
484
485<div class="doc_text">
486<p>New features include:
487</p>
488
489<ul>
Chris Lattner95d25072009-02-25 04:41:31 +0000490<li>?</li>
Tanya Lattnerc79f7542008-11-04 18:40:27 +0000491
Chris Lattnerb0d6c502007-09-21 03:54:09 +0000492</ul>
Mikhail Glushenkov808cd3e2008-10-13 02:08:34 +0000493
Chris Lattnerb0d6c502007-09-21 03:54:09 +0000494</div>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000495
Chris Lattner92eacf82008-10-13 17:57:36 +0000496<!--=========================================================================-->
497<div class="doc_subsection">
498<a name="changes">Major Changes and Removed Features</a>
499</div>
500
501<div class="doc_text">
502
Chris Lattnercc64a322008-10-13 22:06:31 +0000503<p>If you're already an LLVM user or developer with out-of-tree changes based
Chris Lattner95d25072009-02-25 04:41:31 +0000504on LLVM 2.4, this section lists some "gotchas" that you may run into upgrading
Chris Lattnercc64a322008-10-13 22:06:31 +0000505from the previous release.</p>
Chris Lattner92eacf82008-10-13 17:57:36 +0000506
507<ul>
508
Chris Lattner95d25072009-02-25 04:41:31 +0000509<li>?</li>
Chris Lattnercc64a322008-10-13 22:06:31 +0000510</ul>
511
512
513<p>In addition, many APIs have changed in this release. Some of the major LLVM
514API changes are:</p>
515
516<ul>
Chris Lattner95d25072009-02-25 04:41:31 +0000517<li>?</li>
Devang Patel0e3da1a2008-10-14 20:03:43 +0000518</ul>
Chris Lattner92eacf82008-10-13 17:57:36 +0000519
Chris Lattner95d25072009-02-25 04:41:31 +0000520<li>?</li>
Chris Lattner92eacf82008-10-13 17:57:36 +0000521</ul>
522
523</div>
524
525
526
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000527<!-- *********************************************************************** -->
528<div class="doc_section">
529 <a name="portability">Portability and Supported Platforms</a>
530</div>
531<!-- *********************************************************************** -->
532
533<div class="doc_text">
534
535<p>LLVM is known to work on the following platforms:</p>
536
537<ul>
Chris Lattnerb1ad47c2008-11-10 05:40:34 +0000538<li>Intel and AMD machines (IA32, X86-64, AMD64, EMT-64) running Red Hat
539Linux, Fedora Core and FreeBSD (and probably other unix-like systems).</li>
540<li>PowerPC and X86-based Mac OS X systems, running 10.3 and above in 32-bit
541and 64-bit modes.</li>
Chris Lattnere0798082008-02-06 18:00:06 +0000542<li>Intel and AMD machines running on Win32 using MinGW libraries (native).</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000543<li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
544 support is available for native builds with Visual C++).</li>
Gabor Greif5e75e652008-06-05 18:39:01 +0000545<li>Sun UltraSPARC workstations running Solaris 10.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000546<li>Alpha-based machines running Debian GNU/Linux.</li>
Gabor Greif5e75e652008-06-05 18:39:01 +0000547<li>Itanium-based (IA64) machines running Linux and HP-UX.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000548</ul>
549
Chris Lattnerba948522008-06-05 06:57:39 +0000550<p>The core LLVM infrastructure uses GNU autoconf to adapt itself
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000551to the machine and operating system on which it is built. However, minor
552porting may be required to get LLVM to work on new platforms. We welcome your
553portability patches and reports of successful builds or error messages.</p>
554
555</div>
556
557<!-- *********************************************************************** -->
558<div class="doc_section">
559 <a name="knownproblems">Known Problems</a>
560</div>
561<!-- *********************************************************************** -->
562
563<div class="doc_text">
564
Chris Lattnerb1ad47c2008-11-10 05:40:34 +0000565<p>This section contains significant known problems with the LLVM system,
566listed by component. If you run into a problem, please check the <a
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000567href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
568there isn't already one.</p>
569
570</div>
571
572<!-- ======================================================================= -->
573<div class="doc_subsection">
574 <a name="experimental">Experimental features included with this release</a>
575</div>
576
577<div class="doc_text">
578
579<p>The following components of this LLVM release are either untested, known to
580be broken or unreliable, or are in early development. These components should
581not be relied on, and bugs should not be filed against them, but they may be
582useful to some people. In particular, if you would like to work on one of these
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000583components, please contact us on the <a
584href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000585
586<ul>
Gabor Greifaa53e562008-10-14 11:31:14 +0000587<li>The MSIL, IA64, Alpha, SPU, MIPS, and PIC16 backends are experimental.</li>
Duncan Sandsa73561c2008-06-08 20:18:35 +0000588<li>The llc "<tt>-filetype=asm</tt>" (the default) is the only supported
Chris Lattnerbd633de92008-02-06 06:30:34 +0000589 value for this option.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000590</ul>
591
592</div>
593
594<!-- ======================================================================= -->
595<div class="doc_subsection">
596 <a name="x86-be">Known problems with the X86 back-end</a>
597</div>
598
599<div class="doc_text">
600
601<ul>
Anton Korobeynikov77d15e22008-06-08 10:24:13 +0000602 <li>The X86 backend does not yet support
603 all <a href="http://llvm.org/PR879">inline assembly that uses the X86
604 floating point stack</a>. It supports the 'f' and 't' constraints, but not
605 'u'.</li>
Chris Lattnerd95b5962008-06-08 21:19:07 +0000606 <li>The X86 backend generates inefficient floating point code when configured
607 to generate code for systems that don't have SSE2.</li>
Duncan Sands8b4f3772008-06-08 19:38:43 +0000608 <li>Win64 code generation wasn't widely tested. Everything should work, but we
Anton Korobeynikov77d15e22008-06-08 10:24:13 +0000609 expect small issues to happen. Also, llvm-gcc cannot build mingw64 runtime
610 currently due
611 to <a href="http://llvm.org/PR2255">several</a>
Chris Lattnerf06141a2008-06-08 23:12:47 +0000612 <a href="http://llvm.org/PR2257">bugs</a> due to lack of support for the
613 'u' inline assembly constraint and X87 floating point inline assembly.</li>
Dan Gohman3882ecb2008-06-08 23:05:11 +0000614 <li>The X86-64 backend does not yet support the LLVM IR instruction
615 <tt>va_arg</tt>. Currently, the llvm-gcc front-end supports variadic
616 argument constructs on X86-64 by lowering them manually.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000617</ul>
618
619</div>
620
621<!-- ======================================================================= -->
622<div class="doc_subsection">
623 <a name="ppc-be">Known problems with the PowerPC back-end</a>
624</div>
625
626<div class="doc_text">
627
628<ul>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000629<li>The Linux PPC32/ABI support needs testing for the interpreter and static
630compilation, and lacks support for debug information.</li>
631</ul>
632
633</div>
634
635<!-- ======================================================================= -->
636<div class="doc_subsection">
637 <a name="arm-be">Known problems with the ARM back-end</a>
638</div>
639
640<div class="doc_text">
641
642<ul>
643<li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
Duncan Sands1827fa62007-09-26 15:59:54 +0000644processors, thumb programs can crash or produce wrong
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000645results (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
646<li>Compilation for ARM Linux OABI (old ABI) is supported, but not fully tested.
647</li>
Chris Lattnerd95b5962008-06-08 21:19:07 +0000648<li>There is a bug in QEMU-ARM (&lt;= 0.9.0) which causes it to incorrectly
649 execute
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000650programs compiled with LLVM. Please use more recent versions of QEMU.</li>
651</ul>
652
653</div>
654
655<!-- ======================================================================= -->
656<div class="doc_subsection">
657 <a name="sparc-be">Known problems with the SPARC back-end</a>
658</div>
659
660<div class="doc_text">
661
662<ul>
663<li>The SPARC backend only supports the 32-bit SPARC ABI (-m32), it does not
664 support the 64-bit SPARC ABI (-m64).</li>
665</ul>
666
667</div>
668
669<!-- ======================================================================= -->
670<div class="doc_subsection">
Bruno Cardoso Lopes62d45d72008-10-25 14:56:26 +0000671 <a name="mips-be">Known problems with the MIPS back-end</a>
672</div>
673
674<div class="doc_text">
675
676<ul>
677<li>The O32 ABI is not fully supported.</li>
678<li>64-bit MIPS targets are not supported yet.</li>
679</ul>
680
681</div>
682
683<!-- ======================================================================= -->
684<div class="doc_subsection">
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000685 <a name="alpha-be">Known problems with the Alpha back-end</a>
686</div>
687
688<div class="doc_text">
689
690<ul>
691
692<li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
693appropriate nops inserted to ensure restartability.</li>
694
695</ul>
696</div>
697
698<!-- ======================================================================= -->
699<div class="doc_subsection">
700 <a name="ia64-be">Known problems with the IA64 back-end</a>
701</div>
702
703<div class="doc_text">
704
705<ul>
Chris Lattnerf06141a2008-06-08 23:12:47 +0000706<li>The Itanium backend is highly experimental, and has a number of known
707 issues. We are looking for a maintainer for the Itanium backend. If you
Gabor Greif45fc8b12008-10-15 10:47:24 +0000708 are interested, please contact the LLVMdev mailing list.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000709</ul>
710
711</div>
712
713<!-- ======================================================================= -->
714<div class="doc_subsection">
715 <a name="c-be">Known problems with the C back-end</a>
716</div>
717
718<div class="doc_text">
719
720<ul>
Chris Lattner499c07c2008-06-05 06:35:40 +0000721<li><a href="http://llvm.org/PR802">The C backend has only basic support for
722 inline assembly code</a>.</li>
Chris Lattnere0194462007-09-26 06:01:35 +0000723<li><a href="http://llvm.org/PR1658">The C backend violates the ABI of common
724 C++ programs</a>, preventing intermixing between C++ compiled by the CBE and
Duncan Sandsa73561c2008-06-08 20:18:35 +0000725 C++ code compiled with llc or native compilers.</li>
Duncan Sandsbd0ad6e2008-02-10 13:40:55 +0000726<li>The C backend does not support all exception handling constructs.</li>
Duncan Sandse6e264c2009-02-25 11:51:54 +0000727<li>The C backend does not support arbitrary precision integers.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000728</ul>
729
730</div>
731
732
733<!-- ======================================================================= -->
734<div class="doc_subsection">
Chris Lattner499c07c2008-06-05 06:35:40 +0000735 <a name="c-fe">Known problems with the llvm-gcc C front-end</a>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000736</div>
737
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000738<div class="doc_text">
739
Chris Lattnere0798082008-02-06 18:00:06 +0000740<p>llvm-gcc does not currently support <a href="http://llvm.org/PR869">Link-Time
741Optimization</a> on most platforms "out-of-the-box". Please inquire on the
Gabor Greif45fc8b12008-10-15 10:47:24 +0000742LLVMdev mailing list if you are interested.</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000743
Chris Lattner499c07c2008-06-05 06:35:40 +0000744<p>The only major language feature of GCC not supported by llvm-gcc is
745 the <tt>__builtin_apply</tt> family of builtins. However, some extensions
746 are only supported on some targets. For example, trampolines are only
Duncan Sandsa73561c2008-06-08 20:18:35 +0000747 supported on some targets (these are used when you take the address of a
748 nested function).</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000749
Chris Lattner499c07c2008-06-05 06:35:40 +0000750<p>If you run into GCC extensions which are not supported, please let us know.
751</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000752
753</div>
754
755<!-- ======================================================================= -->
756<div class="doc_subsection">
Chris Lattner499c07c2008-06-05 06:35:40 +0000757 <a name="c++-fe">Known problems with the llvm-gcc C++ front-end</a>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000758</div>
759
760<div class="doc_text">
761
762<p>The C++ front-end is considered to be fully
763tested and works for a number of non-trivial programs, including LLVM
764itself, Qt, Mozilla, etc.</p>
765
766<ul>
Anton Korobeynikovd9a17932008-10-11 18:27:16 +0000767<li>Exception handling works well on the X86 and PowerPC targets. Currently
Chris Lattnerb1ad47c2008-11-10 05:40:34 +0000768 only Linux and Darwin targets are supported (both 32 and 64 bit).</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000769</ul>
770
771</div>
772
Chris Lattner6c8a1b82008-10-30 03:58:13 +0000773<!-- ======================================================================= -->
774<div class="doc_subsection">
775 <a name="fortran-fe">Known problems with the llvm-gcc Fortran front-end</a>
776</div>
777
778<div class="doc_text">
Gabor Greif1fc8fbc2008-11-04 21:50:59 +0000779<ul>
Chris Lattner6c8a1b82008-10-30 03:58:13 +0000780<li>Fortran support generally works, but there are still several unresolved bugs
781 in Bugzilla. Please see the tools/gfortran component for details.</li>
782
783<li>The Fortran front-end currently does not build on Darwin (without tweaks)
784 due to unresolved dependencies on the C front-end.</li>
Gabor Greif1fc8fbc2008-11-04 21:50:59 +0000785</ul>
Chris Lattner6c8a1b82008-10-30 03:58:13 +0000786</div>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000787
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000788<!-- ======================================================================= -->
789<div class="doc_subsection">
Chris Lattner499c07c2008-06-05 06:35:40 +0000790 <a name="ada-fe">Known problems with the llvm-gcc Ada front-end</a>
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000791</div>
792
793<div class="doc_text">
794The llvm-gcc 4.2 Ada compiler works fairly well, however this is not a mature
795technology and problems should be expected.
796<ul>
Duncan Sandsa73561c2008-06-08 20:18:35 +0000797<li>The Ada front-end currently only builds on X86-32. This is mainly due
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000798to lack of trampoline support (pointers to nested functions) on other platforms,
Duncan Sandsa73561c2008-06-08 20:18:35 +0000799however it <a href="http://llvm.org/PR2006">also fails to build on X86-64</a>
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000800which does support trampolines.</li>
801<li>The Ada front-end <a href="http://llvm.org/PR2007">fails to bootstrap</a>.
Duncan Sandsf73473e2009-02-25 11:59:06 +0000802This is due to lack of LLVM support for <tt>setjmp</tt>/<tt>longjmp</tt> style
803exception handling, which is used internally by the compiler.
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000804Workaround: configure with --disable-bootstrap.</li>
Duncan Sands2dbc2e82008-10-13 17:27:23 +0000805<li>The c380004, <a href="http://llvm.org/PR2010">c393010</a>
806and <a href="http://llvm.org/PR2421">cxg2021</a> ACATS tests fail
Duncan Sandsf73473e2009-02-25 11:59:06 +0000807(c380004 also fails with gcc-4.2 mainline).
808If the compiler is built with checks disabled then <a href="http://llvm.org/PR2010">c393010</a>
809causes the compiler to go into an infinite loop, using up all system memory.</li>
Duncan Sands2dbc2e82008-10-13 17:27:23 +0000810<li>Some gcc specific Ada tests continue to crash the compiler.</li>
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000811<li>The -E binder option (exception backtraces)
812<a href="http://llvm.org/PR1982">does not work</a> and will result in programs
813crashing if an exception is raised. Workaround: do not use -E.</li>
814<li>Only discrete types <a href="http://llvm.org/PR1981">are allowed to start
815or finish at a non-byte offset</a> in a record. Workaround: do not pack records
816or use representation clauses that result in a field of a non-discrete type
817starting or finishing in the middle of a byte.</li>
Chris Lattnerd95b5962008-06-08 21:19:07 +0000818<li>The <tt>lli</tt> interpreter <a href="http://llvm.org/PR2009">considers
819'main' as generated by the Ada binder to be invalid</a>.
820Workaround: hand edit the file to use pointers for <tt>argv</tt> and
821<tt>envp</tt> rather than integers.</li>
822<li>The <tt>-fstack-check</tt> option <a href="http://llvm.org/PR2008">is
823ignored</a>.</li>
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000824</ul>
825</div>
826
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000827<!-- *********************************************************************** -->
828<div class="doc_section">
829 <a name="additionalinfo">Additional Information</a>
830</div>
831<!-- *********************************************************************** -->
832
833<div class="doc_text">
834
835<p>A wide variety of additional information is available on the <a
836href="http://llvm.org">LLVM web page</a>, in particular in the <a
837href="http://llvm.org/docs/">documentation</a> section. The web page also
838contains versions of the API documentation which is up-to-date with the
839Subversion version of the source code.
840You can access versions of these documents specific to this release by going
841into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
842
843<p>If you have any questions or comments about LLVM, please feel free to contact
844us via the <a href="http://llvm.org/docs/#maillist"> mailing
845lists</a>.</p>
846
847</div>
848
849<!-- *********************************************************************** -->
850
851<hr>
852<address>
853 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman947321d2008-12-11 17:34:48 +0000854 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000855 <a href="http://validator.w3.org/check/referer"><img
Misha Brukman947321d2008-12-11 17:34:48 +0000856 src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000857
858 <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
859 Last modified: $Date$
860</address>
861
862</body>
863</html>