Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / llvm / 13739433d0b0edbb5e2432b6591e08d636e87594 / . / docs / ReleaseNotes.html
blob: 95674d73db80a29d800e28720d414ffc5db35f00 [file] [log] [blame]
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
3<html>
4<head>
Reid Spencer6454ed32004-11-18 18:38:58 +0000[diff] [blame]5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]6 <link rel="stylesheet" href="llvm.css" type="text/css">
Chris Lattner857fb132008-10-11 18:18:28 +0000[diff] [blame]7 <title>LLVM 2.4 Release Notes</title>
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]8</head>
9<body>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]10
Chris Lattner857fb132008-10-11 18:18:28 +0000[diff] [blame]11<div class="doc_title">LLVM 2.4 Release Notes</div>
Mikhail Glushenkovea65d7d2008-10-13 02:08:34 +0000[diff] [blame]12
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]13<ol>
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]14 <li><a href="#intro">Introduction</a></li>
Chris Lattner96a445e2008-10-13 18:01:01 +0000[diff] [blame]15 <li><a href="#subproj">Sub-project Status Update</a></li>
16 <li><a href="#whatsnew">What's New in LLVM?</a></li>
Chris Lattner4b538b92004-04-30 22:17:12 +0000[diff] [blame]17 <li><a href="GettingStarted.html">Installation Instructions</a></li>
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]18 <li><a href="#portability">Portability and Supported Platforms</a></li>
Dan Gohman44aa9212008-10-14 16:23:02 +0000[diff] [blame]19 <li><a href="#knownproblems">Known Problems</a></li>
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]20 <li><a href="#additionalinfo">Additional Information</a></li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]21</ol>
22
Chris Lattner7911ce22004-05-23 21:07:27 +0000[diff] [blame]23<div class="doc_author">
Dan Gohman44aa9212008-10-14 16:23:02 +0000[diff] [blame]24 <p>Written by the <a href="http://llvm.org">LLVM Team</a></p>
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]25</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]26
27<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]28<div class="doc_section">
29 <a name="intro">Introduction</a>
30</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]31<!-- *********************************************************************** -->
32
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]33<div class="doc_text">
34
Chris Lattnerf6662f92008-10-13 17:57:36 +0000[diff] [blame]35<p>This document contains the release notes for the LLVM Compiler
36Infrastructure, release 2.4. Here we describe the status of LLVM, including
37major improvements from the previous release and significant known problems.
38All LLVM releases may be downloaded from the <a
39href="http://llvm.org/releases/">LLVM releases web site</a>.</p>
Chris Lattner19092612003-10-02 16:38:05 +0000[diff] [blame]40
Chris Lattner7506b1d2004-12-07 08:04:13 +0000[diff] [blame]41<p>For more information about LLVM, including information about the latest
Chris Lattnerc463b272005-10-29 07:07:09 +0000[diff] [blame]42release, please check out the <a href="http://llvm.org/">main LLVM
Chris Lattner47ad72c2003-10-07 21:38:31 +0000[diff] [blame]43web site</a>. If you have questions or comments, the <a
Chris Lattnerf6662f92008-10-13 17:57:36 +0000[diff] [blame]44href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM Developer's Mailing
45List</a> is a good place to send them.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]46
Mikhail Glushenkovea65d7d2008-10-13 02:08:34 +0000[diff] [blame]47<p>Note that if you are reading this file from a Subversion checkout or the
Chris Lattner84977642007-09-21 03:54:09 +0000[diff] [blame]48main LLVM web page, this document applies to the <i>next</i> release, not the
Gabor Greiffa933f82008-10-14 11:00:32 +0000[diff] [blame]49current one. To see the release notes for a specific release, please see the
Chris Lattner84977642007-09-21 03:54:09 +0000[diff] [blame]50<a href="http://llvm.org/releases/">releases page</a>.</p>
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]51
52</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]53
Chris Lattner857fb132008-10-11 18:18:28 +0000[diff] [blame]54<!-- Unfinished features in 2.4:
Chris Lattneracce85d2008-02-10 07:46:44 +0000[diff] [blame]55 Machine LICM
56 Machine Sinking
57 LegalizeDAGTypes
Chris Lattner547a3912008-10-12 19:47:48 +0000[diff] [blame]58 llc -enable-value-prop, propagation of value info (sign/zero ext info) from
59 one MBB to another
Chris Lattneracce85d2008-02-10 07:46:44 +0000[diff] [blame]60 -->
Mikhail Glushenkovea65d7d2008-10-13 02:08:34 +0000[diff] [blame]61
Chris Lattner547a3912008-10-12 19:47:48 +0000[diff] [blame]62 <!-- for announcement email:
63 mention dev mtg
Chris Lattnercdb0e4c2008-10-12 22:57:58 +0000[diff] [blame]64 Xcode 3.1 and 3.1.1.
Chris Lattner547a3912008-10-12 19:47:48 +0000[diff] [blame]65 -->
Chris Lattneracce85d2008-02-10 07:46:44 +0000[diff] [blame]66
Chris Lattner96a445e2008-10-13 18:01:01 +0000[diff] [blame]67<!-- *********************************************************************** -->
68<div class="doc_section">
69 <a name="subproj">Sub-project Status Update</a>
Chris Lattnerea34f642008-06-08 21:34:41 +0000[diff] [blame]70</div>
Chris Lattner96a445e2008-10-13 18:01:01 +0000[diff] [blame]71<!-- *********************************************************************** -->
Chris Lattnerea34f642008-06-08 21:34:41 +0000[diff] [blame]72
73<div class="doc_text">
Chris Lattner8348b472008-06-08 21:58:17 +0000[diff] [blame]74<p>
Chris Lattner96a445e2008-10-13 18:01:01 +0000[diff] [blame]75The LLVM 2.4 distribution currently consists of code from the core LLVM
Chris Lattnerfb97b2d2008-10-13 18:11:54 +0000[diff] [blame]76repository (which roughly includes the LLVM optimizers, code generators and
Chris Lattner8348b472008-06-08 21:58:17 +0000[diff] [blame]77supporting tools) and the llvm-gcc repository. In addition to this code, the
78LLVM Project includes other sub-projects that are in development. The two which
Chris Lattner857fb132008-10-11 18:18:28 +0000[diff] [blame]79are the most actively developed are the <a href="#clang">Clang Project</a> and
Nicolas Geoffray99a4d302008-10-14 19:23:04 +0000[diff] [blame]80the <a href="#vmkit">VMKit Project</a>.
Chris Lattner8348b472008-06-08 21:58:17 +0000[diff] [blame]81</p>
Chris Lattner96a445e2008-10-13 18:01:01 +0000[diff] [blame]82
Chris Lattner8348b472008-06-08 21:58:17 +0000[diff] [blame]83</div>
84
Chris Lattner96a445e2008-10-13 18:01:01 +0000[diff] [blame]85
Chris Lattner8348b472008-06-08 21:58:17 +0000[diff] [blame]86<!--=========================================================================-->
Chris Lattner96a445e2008-10-13 18:01:01 +0000[diff] [blame]87<div class="doc_subsection">
Chris Lattnerfb97b2d2008-10-13 18:11:54 +0000[diff] [blame]88<a name="clang">Clang: C/C++/Objective-C Frontend Toolkit</a>
Chris Lattner8348b472008-06-08 21:58:17 +0000[diff] [blame]89</div>
90
91<div class="doc_text">
92
93<p>The <a href="http://clang.llvm.org/">Clang project</a> is an effort to build
94a set of new 'LLVM native' front-end technologies for the LLVM optimizer
95and code generator. Clang is continuing to make major strides forward in all
96areas. Its C and Objective-C parsing support is very solid, and the code
97generation support is far enough along to build many C applications. While not
98yet production quality, it is progressing very nicely. In addition, C++
99front-end work has started to make significant progress.</p>
100
Daniel Dunbar13739432008-10-14 23:25:09 +0000[diff] [blame^]101Clang, in conjunction with the <tt>ccc</tt> driver, is now usable as a
102replacement for gcc for building some small- to medium-sized C applications.
103Additionally, Clang now has code generation support for Objective-C on Mac OS X
104platform. Major highlights include:
105<ul>
106 <li> Clang/ccc pass almost all of the LLVM test suite on Mac OS X and Linux
107on the 32-bit x86 architecture. This includes significant C
108applications such as <a href="http://www.sqlite.org">sqlite3</a>,
109<a href="http://www.lua.org">lua</a>, and
110<a href="http://www.clamav.net">Clam AntiVirus</a>.
111
112 <li> Clang can build the majority of Objective-C examples shipped with the
113Mac OS X Developer Tools.
114</ul>
115
116Clang code generation still needs considerable testing and development, however.
117Some areas under active development include:
118<ul>
119 <li> Improved support for C and Objective-C features, for example
120 variable-length arries, va_arg, exception handling (Obj-C), and garbage
121 collection (Obj-C).
122 <li> ABI compatibility, especially for platforms other than 32-bit x86.
123</ul>
Chris Lattner857fb132008-10-11 18:18:28 +0000[diff] [blame]124
Chris Lattnerfb97b2d2008-10-13 18:11:54 +0000[diff] [blame]125</div>
126
127<!--=========================================================================-->
128<div class="doc_subsection">
129<a name="clangsa">Clang Static Analyzer</a>
130</div>
131
132<div class="doc_text">
133
Ted Kremenek3c3ec0c2008-10-14 05:14:21 +0000[diff] [blame]134<p>The Clang project also includes an early stage static source code analysis
135tool for <a href="http://clang.llvm.org/StaticAnalysis.html">automatically
136finding bugs</a> in C and Objective-C programs. The tool performs a growing set
Chris Lattnerc702d162008-10-14 06:02:29 +0000[diff] [blame]137of checks to find bugs that occur on a specific path within a program. Examples
Ted Kremenek3c3ec0c2008-10-14 05:14:21 +0000[diff] [blame]138of bugs the tool finds include logic errors such as null dereferences,
139violations of various API rules, dead code, and potential memory leaks in
Chris Lattnerc702d162008-10-14 06:02:29 +0000[diff] [blame]140Objective-C programs. Since its inception, public feedback on the tool has been
141extremely positive, and conservative estimates put the number of real bugs it
142has found in industrial-quality software on the order of thousands.</p>
Chris Lattnercc042612008-10-14 00:52:49 +0000[diff] [blame]143
Ted Kremenek3c3ec0c2008-10-14 05:14:21 +0000[diff] [blame]144<p>The tool also provides a simple web GUI to inspect potential bugs found by
Chris Lattnerc702d162008-10-14 06:02:29 +0000[diff] [blame]145the tool. While still early in development, the GUI illustrates some of the key
Ted Kremenek3c3ec0c2008-10-14 05:14:21 +0000[diff] [blame]146features of Clang: accurate source location information, which is used by the
147GUI to highlight specific code expressions that relate to a bug (including those
148that span multiple lines) and built-in knowledge of macros, which is used to
149perform inline expansion of macros within the GUI itself.</p>
150
Chris Lattnerc702d162008-10-14 06:02:29 +0000[diff] [blame]151<p>The set of checks performed by the static analyzer is gradually expanding,
152and
Ted Kremenek3c3ec0c2008-10-14 05:14:21 +0000[diff] [blame]153future plans for the tool include full source-level inter-procedural analysis
154and deeper checks such as buffer overrun detection. There are many opportunities
155to extend and enhance the static analyzer, and anyone interested in working on
156this project is encouraged to get involved!</p>
Chris Lattner8348b472008-06-08 21:58:17 +0000[diff] [blame]157
158</div>
159
Chris Lattner96a445e2008-10-13 18:01:01 +0000[diff] [blame]160<!--=========================================================================-->
161<div class="doc_subsection">
Nicolas Geoffray99a4d302008-10-14 19:23:04 +0000[diff] [blame]162<a name="vmkit">VMKit: JVM/CLI Virtual Machine Implementation</a>
Chris Lattner96a445e2008-10-13 18:01:01 +0000[diff] [blame]163</div>
164
165<div class="doc_text">
166<p>
Nicolas Geoffray99a4d302008-10-14 19:23:04 +0000[diff] [blame]167The <a href="http://vmkit.llvm.org/">VMKit project</a> is an implementation of
Chris Lattner96a445e2008-10-13 18:01:01 +0000[diff] [blame]168a JVM and a CLI Virtual Machines (Microsoft .NET is an
169implementation of the CLI) using the Just-In-Time compiler of LLVM.</p>
170
Nicolas Geoffray99a4d302008-10-14 19:23:04 +0000[diff] [blame]171<p>Following LLVM 2.4, VMKit has its first release 0.24 that you can find on
172the <a href="http://llvm.org/releases/">release page</a>. The release includes
173bug fixes, cleanup and new features. The major changes include:</p>
Chris Lattner96a445e2008-10-13 18:01:01 +0000[diff] [blame]174
Nicolas Geoffray99a4d302008-10-14 19:23:04 +0000[diff] [blame]175<ul>
176
177<li><p>Support for generics in the .Net virtual machine. This was implemented
178by Tilmann Scheller during his Google Summer of Code project.</li></p>
179<li><p>Initial support for the Mono class libraries.</p></li>
180<li><p>Support for MacOSX/x86, following LLVM's support for exceptions in
181JIT on MacOSX/x86.
182<li><p>A new vmkit driver: a program to run java or .net applications. The
183driver supports llvm command line arguments including the new "-fast" option.
184</p></li>
185<li><p>A new memory allocation scheme in the JVM that makes unloading a
186class loader very fast.</p></li>
187<li><p>VMKit now follows the LLVM Makefile machinery.</p></li>
188
189
190</ul>
Chris Lattner96a445e2008-10-13 18:01:01 +0000[diff] [blame]191</div>
192
Chris Lattner8348b472008-06-08 21:58:17 +0000[diff] [blame]193
194<!-- *********************************************************************** -->
195<div class="doc_section">
Chris Lattner96a445e2008-10-13 18:01:01 +0000[diff] [blame]196 <a name="whatsnew">What's New in LLVM?</a>
Chris Lattner8348b472008-06-08 21:58:17 +0000[diff] [blame]197</div>
198<!-- *********************************************************************** -->
199
Chris Lattnerf8e0b4e2008-06-08 22:59:35 +0000[diff] [blame]200<div class="doc_text">
201
Chris Lattnerf6662f92008-10-13 17:57:36 +0000[diff] [blame]202<p>This release includes a huge number of bug fixes, performance tweaks and
203minor improvements. Some of the major improvements and new features are listed
204in this section.
Chris Lattnerf8e0b4e2008-06-08 22:59:35 +0000[diff] [blame]205</p>
206</div>
207
Chris Lattner8348b472008-06-08 21:58:17 +0000[diff] [blame]208<!--=========================================================================-->
Chris Lattnerea34f642008-06-08 21:34:41 +0000[diff] [blame]209<div class="doc_subsection">
Chris Lattner252b83d2008-02-06 18:00:06 +0000[diff] [blame]210<a name="majorfeatures">Major New Features</a>
211</div>
212
213<div class="doc_text">
214
Chris Lattner857fb132008-10-11 18:18:28 +0000[diff] [blame]215<p>LLVM 2.4 includes several major new capabilities:</p>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000[diff] [blame]216
217<ul>
Chris Lattnerb82eb062008-10-13 20:47:20 +0000[diff] [blame]218<li><p>The most visible end-user change in LLVM 2.4 is that it includes many
Chris Lattnerf3013872008-10-13 21:50:36 +0000[diff] [blame]219optimizations and changes to make -O0 compile times much faster. You should see
Gabor Greiffa933f82008-10-14 11:00:32 +0000[diff] [blame]220improvements on the order of 30% (or more) faster than LLVM 2.3. There are many
Chris Lattnerb82eb062008-10-13 20:47:20 +0000[diff] [blame]221pieces to this change, described in more detail below. The speedups and new
222components can also be used for JIT compilers that want fast compilation as
223well.</p></li>
Chris Lattner857fb132008-10-11 18:18:28 +0000[diff] [blame]224
Chris Lattnerb82eb062008-10-13 20:47:20 +0000[diff] [blame]225<li><p>The biggest change to the LLVM IR is that Multiple Return Values (which
226were introduced in LLVM 2.3) have been generalized to full support for "First
227Class Aggregate" values in LLVM 2.4. This means that LLVM IR supports using
228structs and arrays as values in a function. This capability is mostly useful
229for front-end authors, who prefer to treat things like complex numbers, simple
230tuples, dope vectors, etc as Value*'s instead of as a tuple of Value*'s or as
Gabor Greiffa933f82008-10-14 11:00:32 +0000[diff] [blame]231memory values. Bitcode files from LLVM 2.3 will automatically migrate to the
232general representation.</p></li>
Mikhail Glushenkovea65d7d2008-10-13 02:08:34 +0000[diff] [blame]233
Chris Lattnerb82eb062008-10-13 20:47:20 +0000[diff] [blame]234<li><p>LLVM 2.4 also includes an initial port for the PIC16 microprocessor. This
Duncan Sands9ba23792008-10-14 07:06:37 +0000[diff] [blame]235is the LLVM target that only has support for 8 bit registers, and a number of
Chris Lattnerb82eb062008-10-13 20:47:20 +0000[diff] [blame]236other crazy constraints. While the port is still in early development stages,
237it shows some interesting things you can do with LLVM.</p></li>
Chris Lattnerbc5786b2008-06-05 06:57:39 +0000[diff] [blame]238
Chris Lattner8170c102008-02-10 08:18:42 +0000[diff] [blame]239</ul>
240
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000[diff] [blame]241</div>
242
Chris Lattner791f77b2008-06-05 06:25:56 +0000[diff] [blame]243
244<!--=========================================================================-->
245<div class="doc_subsection">
Chris Lattnerea34f642008-06-08 21:34:41 +0000[diff] [blame]246<a name="llvm-gcc">llvm-gcc 4.2 Improvements</a>
Chris Lattner791f77b2008-06-05 06:25:56 +0000[diff] [blame]247</div>
248
249<div class="doc_text">
250
Chris Lattnerb82eb062008-10-13 20:47:20 +0000[diff] [blame]251<p>LLVM fully supports the llvm-gcc 4.2 front-end, which marries the GCC
252front-ends and driver with the LLVM optimizer and code generator. It currently
253includes support for the C, C++, Objective-C, Ada, and Fortran front-ends.</p>
Chris Lattner791f77b2008-06-05 06:25:56 +0000[diff] [blame]254
Chris Lattnerf8e0b4e2008-06-08 22:59:35 +0000[diff] [blame]255<ul>
Chris Lattner7752d1a2008-10-13 20:59:32 +0000[diff] [blame]256<li>LLVM 2.4 supports the full set of atomic <tt>__sync_*</tt> builtins. LLVM
2572.3 only supported those used by OpenMP, but 2.4 supports them all. While
Chris Lattnerf3013872008-10-13 21:50:36 +0000[diff] [blame]258llvm-gcc supports all of these builtins, note that not all targets do. X86
259support them all in both 32-bit and 64-bit mode and PowerPC supports them all
260except for the 64-bit operations when in 32-bit mode.</li>
Chris Lattnerf8e0b4e2008-06-08 22:59:35 +0000[diff] [blame]261
Chris Lattner7752d1a2008-10-13 20:59:32 +0000[diff] [blame]262<li>llvm-gcc now supports an <tt>-flimited-precision</tt> option, which tells
263the compiler that it is ok to use low-precision approximations of certain libm
Chris Lattnerb82eb062008-10-13 20:47:20 +0000[diff] [blame]264functions (like tan, log, etc). This allows you to get high performance if you
265only need (say) 14-bits of precision.</li>
266
267<li>llvm-gcc now supports a C language extension known as "<a
268href="http://lists.cs.uiuc.edu/pipermail/cfe-dev/2008-August/002670.html">Blocks
Gabor Greiffa933f82008-10-14 11:00:32 +0000[diff] [blame]269</a>". This feature is similar to nested functions and closures, but does not
Chris Lattnerb82eb062008-10-13 20:47:20 +0000[diff] [blame]270require stack trampolines (with most ABIs) and supports returning closures
271from functions that define them. Note that actually <em>using</em> Blocks
272requires a small runtime that is not included with llvm-gcc.</li>
273
274<li>llvm-gcc now supports a new <tt>-flto</tt> option. On systems that support
275transparent Link Time Optimization (currently Darwin systems with Xcode 3.1 and
276later) this allows the use of LTO with other optimization levels like -Os.
277Previously, LTO could only be used with -O4, which implied optimizations in
278-O3 that can increase code size.</li>
Gabor Greifa3bd11d2008-06-09 06:06:18 +0000[diff] [blame]279</ul>
Chris Lattner791f77b2008-06-05 06:25:56 +0000[diff] [blame]280
Chris Lattner791f77b2008-06-05 06:25:56 +0000[diff] [blame]281</div>
282
283
Chris Lattner84977642007-09-21 03:54:09 +0000[diff] [blame]284<!--=========================================================================-->
285<div class="doc_subsection">
Chris Lattnerf304ffc2008-02-10 08:17:19 +0000[diff] [blame]286<a name="coreimprovements">LLVM Core Improvements</a>
287</div>
288
289<div class="doc_text">
290<p>New features include:
291</p>
292
Chris Lattner791f77b2008-06-05 06:25:56 +0000[diff] [blame]293<ul>
Gabor Greiffa933f82008-10-14 11:00:32 +0000[diff] [blame]294<li>A major change to the <tt>Use</tt> class landed, which shrank it by 25%. Since
Chris Lattner7752d1a2008-10-13 20:59:32 +0000[diff] [blame]295this is a pervasive part of the LLVM, it ended up reducing the memory use of
296LLVM IR in general by 15% for most programs.</li>
297
298<li>Values with no names are now pretty printed by <tt>llvm-dis</tt> more
299nicely. They now print as "<tt>%3 = add i32 %A, 4</tt>" instead of
300"<tt>add i32 %A, 4 ; &lt;i32&gt;:3</tt>", which makes it much easier to read.
301</li>
302
303<li>LLVM 2.4 includes some changes for better vector support. First, the shift
304operations (<tt>shl</tt>, <tt>ashr</tt>, <tt>lshr</tt>) now all support vectors
305and do an element-by-element shift (shifts of the whole vector can be
306accomplished by bitcasting the vector to &lt;1 x i128&gt; for example). Second,
Chris Lattnercc042612008-10-14 00:52:49 +0000[diff] [blame]307there is initial support in development for vector comparisons with the
308<a href="LangRef.html#i_fcmp">fcmp</a>/<a href="LangRef.html#i_icmp">icmp</a>
309instructions. These instructions compare two vectors and return a vector of
310i1's for each result. Note that there is very little codegen support available
311for any of these IR features though.</li>
Chris Lattner7752d1a2008-10-13 20:59:32 +0000[diff] [blame]312
313<li>A new <tt>DebugInfoBuilder</tt> class is available, which makes it much
314easier for front-ends to create debug info descriptors, similar to the way that
Gabor Greifa8b84902008-10-14 11:31:14 +0000[diff] [blame]315<tt>IRBuilder</tt> makes it easier to create LLVM IR.</li>
Chris Lattner7752d1a2008-10-13 20:59:32 +0000[diff] [blame]316
Dan Gohman1bbddce2008-10-14 16:13:59 +0000[diff] [blame]317<li>The <tt>IRBuilder</tt> class is now parameterized by a class responsible
Gabor Greiffa933f82008-10-14 11:00:32 +0000[diff] [blame]318for constant folding. The default <tt>ConstantFolder</tt> class does target independent
319constant folding. The <tt>NoFolder</tt> class does no constant folding at all, which is
320useful when learning how LLVM works. The <tt>TargetFolder</tt> class folds the most,
Duncan Sands9ba23792008-10-14 07:06:37 +0000[diff] [blame]321doing target dependent constant folding.</li>
322
323<li>LLVM now supports "function attributes", which allows us to separate return
Chris Lattner7752d1a2008-10-13 20:59:32 +0000[diff] [blame]324value attributes from function attributes. LLVM now supports attributes on a
325function itself, a return value, and its parameters. New supported function
326attributes include noinline/alwaysinline and the "opt-size" flag which says the
327function should be optimized for code size.</li>
328
Chris Lattnercce6d4b2008-10-12 18:30:33 +0000[diff] [blame]329<li>LLVM IR now directly represents "common" linkage, instead of
330 representing it as a form of weak linkage.</li>
Chris Lattner7752d1a2008-10-13 20:59:32 +0000[diff] [blame]331
Chris Lattnerf304ffc2008-02-10 08:17:19 +0000[diff] [blame]332</ul>
Mikhail Glushenkovea65d7d2008-10-13 02:08:34 +0000[diff] [blame]333
Chris Lattnerf304ffc2008-02-10 08:17:19 +0000[diff] [blame]334</div>
335
336<!--=========================================================================-->
337<div class="doc_subsection">
Chris Lattneracce85d2008-02-10 07:46:44 +0000[diff] [blame]338<a name="optimizer">Optimizer Improvements</a>
339</div>
340
341<div class="doc_text">
342
Chris Lattnerf3013872008-10-13 21:50:36 +0000[diff] [blame]343<p>In addition to a huge array of bug fixes and minor performance tweaks, this
344release includes a few major enhancements and additions to the optimizers:</p>
Chris Lattneracce85d2008-02-10 07:46:44 +0000[diff] [blame]345
346<ul>
347
Chris Lattnerf3013872008-10-13 21:50:36 +0000[diff] [blame]348<li>The Global Value Numbering (GVN) pass now does local Partial Redundancy
349Elimination (PRE) to eliminate some partially redundant expressions in cases
350where doing so won't grow code size.</li>
Chris Lattner547a3912008-10-12 19:47:48 +0000[diff] [blame]351
Chris Lattnerf3013872008-10-13 21:50:36 +0000[diff] [blame]352<li>LLVM 2.4 includes a new loop deletion pass (which removes output-free
353provably-finite loops) and a rewritten Aggressive Dead Code Elimination (ADCE)
354pass that no longer uses control dependence information. These changes speed up
Gabor Greifa8b84902008-10-14 11:31:14 +0000[diff] [blame]355the optimizer and also prevent it from deleting output-free infinite
Chris Lattnerf3013872008-10-13 21:50:36 +0000[diff] [blame]356loops.</li>
Chris Lattner547a3912008-10-12 19:47:48 +0000[diff] [blame]357
Duncan Sands1050d732008-10-13 18:42:43 +0000[diff] [blame]358<li>The new AddReadAttrs pass works out which functions are read-only or
Gabor Greifa8b84902008-10-14 11:31:14 +0000[diff] [blame]359read-none (these correspond to 'pure' and 'const' in GCC) and marks them
Duncan Sands1050d732008-10-13 18:42:43 +0000[diff] [blame]360with the appropriate attribute.</li>
Chris Lattnerf3013872008-10-13 21:50:36 +0000[diff] [blame]361
362<li>LLVM 2.4 now includes a new SparsePropagation framework, which makes it
363trivial to build lattice-based dataflow solvers that operate over LLVM IR. Using
364this interface means that you just define objects to represent your lattice
365values and the transfer functions that operate on them. It handles the
366mechanics of worklist processing, liveness tracking, handling PHI nodes,
367etc.</li>
368
Chris Lattnerc702d162008-10-14 06:02:29 +0000[diff] [blame]369<li>The Loop Strength Reduction and induction variable optimization passes have
370several improvements to avoid inserting MAX expressions, to optimize simple
371floating point induction variables and to analyze trip counts of more
372loops.</li>
373
Chris Lattnerf3013872008-10-13 21:50:36 +0000[diff] [blame]374<li>Various helper functions (ComputeMaskedBits, ComputeNumSignBits, etc) were
375pulled out of the Instruction Combining pass and put into a new
376<tt>ValueTracking.h</tt> header, where they can be reused by other passes.</li>
377
378<li>The tail duplication pass has been removed from the standard optimizer
379sequence used by llvm-gcc. This pass still exists, but the benefits it once
380provided are now achieved by other passes.</li>
381
Chris Lattner0b832202008-06-08 02:45:07 +0000[diff] [blame]382</ul>
383
384</div>
385
386<!--=========================================================================-->
387<div class="doc_subsection">
388<a name="codegen">Code Generator Improvements</a>
389</div>
390
391<div class="doc_text">
392
Gabor Greifa8b84902008-10-14 11:31:14 +0000[diff] [blame]393<p>We have put a significant amount of work into the code generator infrastructure,
Chris Lattner0b832202008-06-08 02:45:07 +0000[diff] [blame]394which allows us to implement more aggressive algorithms and make it run
395faster:</p>
396
397<ul>
Chris Lattnerf3013872008-10-13 21:50:36 +0000[diff] [blame]398<li>The target-independent code generator supports (and the X86 backend
399 currently implements) a new interface for "fast" instruction selection. This
400 interface is optimized to produce code as quickly as possible, sacrificing
401 code quality to do it. This is used by default at -O0 or when using
402 "llc -fast" on X86. It is straight-forward to add support for
403 other targets if faster -O0 compilation is desired.</li>
404
405<li>In addition to the new 'fast' instruction selection path, many existing
406 pieces of the code generator have been optimized in significant ways.
407 SelectionDAG's are now pool allocated and use better algorithms in many
Gabor Greifa8b84902008-10-14 11:31:14 +0000[diff] [blame]408 places, the ".s" file printers now use <tt>raw_ostream</tt> to emit text much faster,
Chris Lattnerf3013872008-10-13 21:50:36 +0000[diff] [blame]409 etc. The end result of these improvements is that the compiler also takes
410 substantially less time to generate code that is just as good (and often
411 better) than before.</li>
412
Gabor Greifa8b84902008-10-14 11:31:14 +0000[diff] [blame]413<li>Each target has been split to separate the ".s" file printing logic from the
Chris Lattnerf3013872008-10-13 21:50:36 +0000[diff] [blame]414 rest of the target. This enables JIT compilers that don't link in the
Gabor Greifa8b84902008-10-14 11:31:14 +0000[diff] [blame]415 (somewhat large) code and data tables used for printing a ".s" file.</li>
Chris Lattnerf3013872008-10-13 21:50:36 +0000[diff] [blame]416
417<li>The code generator now includes a "stack slot coloring" pass, which packs
418 together individual spilled values into common stack slots. This reduces
419 the size of stack frames with many spills, which tends to increase L1 cache
420 effectiveness.</li>
421
422<li>Various pieces of the register allocator (e.g. the coalescer and two-address
423 operation elimination pass) now know how to rematerialize trivial operations
424 to avoid copies and include several other optimizations.</li>
425
426<li>The <a href="CodeGenerator.html#selectiondag_process">graphs</a> produced by
427 the <tt>llc -view-*-dags</tt> options are now significantly prettier and
428 easier to read.</li>
429
430<li>LLVM 2.4 includes a new register allocator based on Partitioned Boolean
431 Quadratic Programming (PBQP). This register allocator is still in
432 development, but is very simple and clean.</li>
Chris Lattner0b832202008-06-08 02:45:07 +0000[diff] [blame]433
Chris Lattner84977642007-09-21 03:54:09 +0000[diff] [blame]434</ul>
435
436</div>
437
438
439<!--=========================================================================-->
440<div class="doc_subsection">
Chris Lattnereeb4da02008-10-13 22:06:31 +0000[diff] [blame]441<a name="targetspecific">Target Specific Improvements</a>
Chris Lattner84977642007-09-21 03:54:09 +0000[diff] [blame]442</div>
Chris Lattner60893e52007-05-18 06:33:02 +0000[diff] [blame]443
Chris Lattner738bd302006-04-18 06:32:08 +0000[diff] [blame]444<div class="doc_text">
Chris Lattnerf304ffc2008-02-10 08:17:19 +0000[diff] [blame]445<p>New target-specific features include:
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000[diff] [blame]446</p>
Chris Lattner26299222006-11-18 07:51:14 +0000[diff] [blame]447
448<ul>
Chris Lattner547a3912008-10-12 19:47:48 +0000[diff] [blame]449<li>Exception handling is supported by default on Linux/x86-64.</li>
Duncan Sandsbbf379a2008-10-13 17:32:15 +0000[diff] [blame]450<li>Position Independent Code (PIC) is now supported on Linux/x86-64.</li>
Chris Lattnerc702d162008-10-14 06:02:29 +0000[diff] [blame]451<li>@llvm.frameaddress now supports getting the frame address of stack frames
452 &gt; 0 on x86/x86-64.</li>
Chris Lattnereeb4da02008-10-13 22:06:31 +0000[diff] [blame]453<li>MIPS floating point support? [BRUNO]</li>
454<li>The PowerPC backend now supports trampolines.</li>
Chris Lattner77d29b12008-06-05 08:02:49 +0000[diff] [blame]455</ul>
Chris Lattner77d29b12008-06-05 08:02:49 +0000[diff] [blame]456
Mikhail Glushenkovea65d7d2008-10-13 02:08:34 +0000[diff] [blame]457</div>
Chris Lattner77d29b12008-06-05 08:02:49 +0000[diff] [blame]458
459
460<!--=========================================================================-->
461<div class="doc_subsection">
Chris Lattner84977642007-09-21 03:54:09 +0000[diff] [blame]462<a name="otherimprovements">Other Improvements</a>
463</div>
464
465<div class="doc_text">
466<p>New features include:
467</p>
468
469<ul>
Mikhail Glushenkov49feb452008-10-13 02:46:01 +0000[diff] [blame]470<li><tt>llvmc2</tt> (the generic compiler driver) gained plugin
Chris Lattnereeb4da02008-10-13 22:06:31 +0000[diff] [blame]471 support. It is now easier to experiment with <tt>llvmc2</tt> and
472 build your own tools based on it.</li>
473
474<li>LLVM 2.4 includes a number of new generic algorithms and data structures,
Dan Gohmanbd9f9af2008-10-14 15:14:55 +0000[diff] [blame]475 include a scoped hash table, 'immutable' data structures, a simple
476 free-list manager, and a <tt>raw_ostream</tt> class.
477 The <tt>raw_ostream</tt> class and
Chris Lattnereeb4da02008-10-13 22:06:31 +0000[diff] [blame]478 <tt>format</tt> allow for efficient file output, and various pieces of LLVM
479 have switched over to use it. The eventual goal is to eliminate
480 std::ostream in favor of it.</li>
481
Chris Lattner84977642007-09-21 03:54:09 +0000[diff] [blame]482</ul>
Mikhail Glushenkovea65d7d2008-10-13 02:08:34 +0000[diff] [blame]483
Chris Lattner84977642007-09-21 03:54:09 +0000[diff] [blame]484</div>
Chris Lattnerc5d658a2006-03-03 00:34:26 +0000[diff] [blame]485
Chris Lattnerf6662f92008-10-13 17:57:36 +0000[diff] [blame]486<!--=========================================================================-->
487<div class="doc_subsection">
488<a name="changes">Major Changes and Removed Features</a>
489</div>
490
491<div class="doc_text">
492
Chris Lattnereeb4da02008-10-13 22:06:31 +0000[diff] [blame]493<p>If you're already an LLVM user or developer with out-of-tree changes based
494on LLVM 2.3, this section lists some "gotchas" that you may run into upgrading
495from the previous release.</p>
Chris Lattnerf6662f92008-10-13 17:57:36 +0000[diff] [blame]496
497<ul>
498
Chris Lattnereeb4da02008-10-13 22:06:31 +0000[diff] [blame]499<li>The LLVM IR generated by llvm-gcc no longer names all instructions. This
500 makes it run faster, but may be more confusing to some people. If you
501 prefer to have names, the '<tt>opt -instnamer</tt>' pass will add names to
502 all instructions.</li>
503
504<li>The LoadVN and GCSE passes have been removed from the tree. They are
505 obsolete and have been replaced with the GVN and MemoryDependence passes.
506 </li>
507</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>
514
Devang Patelb34dd132008-10-14 20:03:43 +0000[diff] [blame]515<li>Now, function attributes and return value attributes are managed
516sepearately. Interface exported by <tt>ParameterAttributes.h</tt> header is now
517experted by <tt>Attributes.h</tt> header. The new attributes interface changes are:
518<ul>
519<li><tt>getParamAttrs</tt> method is now replaced by
520<tt>getParamAttributes</tt>, <tt>getRetAttributes</tt> and
521<tt>getFnAttributes</tt> methods.</li>
522<li> Return value attributes are stored at index 0. Function attributes are
523stored at index ~0U. Parameter attributes are stored at index that matches
524parameter number.</li>
525<li> <tt>ParamAttr</tt> namespace is now renamed as <tt>Attribute</tt>.</li>
526<li> The name of the class</tt> that manages reference count of opaque
527attributes is changed from <tt>PAListPtr</tt> to <tt>AttrListPtr</tt>.</li>
528<li> <tt>ParamAttrsWithIndex</tt> is now renamed as <tt>AttributeWithIndex</tt>.
529</li>
530</ul>
531</li>
Chris Lattnerf6662f92008-10-13 17:57:36 +0000[diff] [blame]532
533<li>The <tt>DbgStopPointInst</tt> methods <tt>getDirectory</tt> and
534<tt>getFileName</tt> now return <tt>Value*</tt> instead of strings. These can be
535converted to strings using <tt>llvm::GetConstantStringInfo</tt> defined via
Gabor Greifa8b84902008-10-14 11:31:14 +0000[diff] [blame]536"<tt>llvm/Analysis/ValueTracking.h</tt>".</li>
Chris Lattnerf6662f92008-10-13 17:57:36 +0000[diff] [blame]537
Chris Lattnereeb4da02008-10-13 22:06:31 +0000[diff] [blame]538<li>The APIs to create various instructions have changed from lower case
539 "create" methods to upper case "Create" methods (e.g.
540 <tt>BinaryOperator::create</tt>). LLVM 2.4 includes both cases, but the
541 lower case ones are removed in mainline, please migrate.</li>
542
Gabor Greifa8b84902008-10-14 11:31:14 +0000[diff] [blame]543<li>Various header files like "<tt>llvm/ADT/iterator</tt>" were given a ".h" suffix.
544 Change your code to #include "<tt>llvm/ADT/iterator.h</tt>" instead.</li>
Chris Lattnerf6662f92008-10-13 17:57:36 +0000[diff] [blame]545
Gabor Greifa8b84902008-10-14 11:31:14 +0000[diff] [blame]546<li>In the code generator, many <tt>MachineOperand</tt> predicates were renamed to be
Chris Lattnerf1796b62008-10-14 06:37:11 +0000[diff] [blame]547 shorter (e.g. <tt>isFrameIndex()</tt> -&gt; <tt>isFI()</tt>),
548 <tt>SDOperand</tt> was renamed to <tt>SDValue</tt> (and the "<tt>Val</tt>"
549 member was changed to be the <tt>getNode()</tt> accessor), and the
550 <tt>MVT::ValueType</tt> enum has been replaced with an "<tt>MVT</tt>"
Dan Gohman9aeea5b2008-10-14 17:06:44 +0000[diff] [blame]551 struct. The <tt>getSignExtended</tt> and <tt>getValue</tt> methods in the
552 ConstantSDNode class were renamed to <tt>getSExtValue</tt> and
553 <tt>getZExtValue</tt> respectively, to be more consistent with
554 the <tt>ConstantInt</tt> class.</li>
Chris Lattnerf6662f92008-10-13 17:57:36 +0000[diff] [blame]555</ul>
556
557</div>
558
559
560
Chris Lattner19092612003-10-02 16:38:05 +0000[diff] [blame]561<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]562<div class="doc_section">
563 <a name="portability">Portability and Supported Platforms</a>
564</div>
Chris Lattner19092612003-10-02 16:38:05 +0000[diff] [blame]565<!-- *********************************************************************** -->
566
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]567<div class="doc_text">
568
John Criswell0b5b5e92004-12-08 20:35:47 +0000[diff] [blame]569<p>LLVM is known to work on the following platforms:</p>
Chris Lattner4654bdb2004-06-01 18:22:41 +0000[diff] [blame]570
571<ul>
Mikhail Glushenkovea65d7d2008-10-13 02:08:34 +0000[diff] [blame]572<li>Intel and AMD machines (IA32) running Red Hat Linux, Fedora Core and FreeBSD
Reid Spencer00812e22005-05-17 02:47:27 +0000[diff] [blame]573 (and probably other unix-like systems).</li>
Chris Lattner000c73b2008-02-06 06:30:34 +0000[diff] [blame]574<li>PowerPC and X86-based Mac OS X systems, running 10.3 and above in 32-bit and
Chris Lattner26299222006-11-18 07:51:14 +0000[diff] [blame]575 64-bit modes.</li>
Chris Lattner252b83d2008-02-06 18:00:06 +0000[diff] [blame]576<li>Intel and AMD machines running on Win32 using MinGW libraries (native).</li>
Chris Lattner57a460e2007-05-23 04:39:32 +0000[diff] [blame]577<li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
578 support is available for native builds with Visual C++).</li>
Gabor Greif96a89c72008-06-05 18:39:01 +0000[diff] [blame]579<li>Sun UltraSPARC workstations running Solaris 10.</li>
John Criswell9321fa82005-05-13 20:28:15 +0000[diff] [blame]580<li>Alpha-based machines running Debian GNU/Linux.</li>
Gabor Greif96a89c72008-06-05 18:39:01 +0000[diff] [blame]581<li>Itanium-based (IA64) machines running Linux and HP-UX.</li>
Chris Lattner4654bdb2004-06-01 18:22:41 +0000[diff] [blame]582</ul>
583
Chris Lattnerbc5786b2008-06-05 06:57:39 +0000[diff] [blame]584<p>The core LLVM infrastructure uses GNU autoconf to adapt itself
Brian Gaekeb0fd7612004-05-09 05:28:35 +0000[diff] [blame]585to the machine and operating system on which it is built. However, minor
586porting may be required to get LLVM to work on new platforms. We welcome your
587portability patches and reports of successful builds or error messages.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]588
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]589</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]590
591<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]592<div class="doc_section">
593 <a name="knownproblems">Known Problems</a>
594</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]595<!-- *********************************************************************** -->
596
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]597<div class="doc_text">
598
599<p>This section contains all known problems with the LLVM system, listed by
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]600component. As new problems are discovered, they will be added to these
Chris Lattner5eccca42003-12-12 21:22:16 +0000[diff] [blame]601sections. If you run into a problem, please check the <a
Chris Lattnerc463b272005-10-29 07:07:09 +0000[diff] [blame]602href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
Chris Lattner5eccca42003-12-12 21:22:16 +0000[diff] [blame]603there isn't already one.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]604
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]605</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]606
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000[diff] [blame]607<!-- ======================================================================= -->
608<div class="doc_subsection">
609 <a name="experimental">Experimental features included with this release</a>
610</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]611
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000[diff] [blame]612<div class="doc_text">
613
Misha Brukman6df9e2c2004-05-12 21:46:05 +0000[diff] [blame]614<p>The following components of this LLVM release are either untested, known to
615be broken or unreliable, or are in early development. These components should
616not be relied on, and bugs should not be filed against them, but they may be
617useful to some people. In particular, if you would like to work on one of these
Chris Lattner2b659ef2008-02-12 06:29:45 +0000[diff] [blame]618components, please contact us on the <a
619href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p>
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000[diff] [blame]620
621<ul>
Gabor Greifa8b84902008-10-14 11:31:14 +0000[diff] [blame]622<li>The MSIL, IA64, Alpha, SPU, MIPS, and PIC16 backends are experimental.</li>
Duncan Sands27aff872008-06-08 20:18:35 +0000[diff] [blame]623<li>The llc "<tt>-filetype=asm</tt>" (the default) is the only supported
Chris Lattner000c73b2008-02-06 06:30:34 +0000[diff] [blame]624 value for this option.</li>
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000[diff] [blame]625</ul>
626
627</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]628
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]629<!-- ======================================================================= -->
630<div class="doc_subsection">
Chris Lattner26299222006-11-18 07:51:14 +0000[diff] [blame]631 <a name="x86-be">Known problems with the X86 back-end</a>
John Criswellc0c186d2005-11-08 21:11:33 +0000[diff] [blame]632</div>
633
634<div class="doc_text">
635
636<ul>
Anton Korobeynikova6094be2008-06-08 10:24:13 +0000[diff] [blame]637 <li>The X86 backend does not yet support
638 all <a href="http://llvm.org/PR879">inline assembly that uses the X86
639 floating point stack</a>. It supports the 'f' and 't' constraints, but not
640 'u'.</li>
Chris Lattnere6e1b352008-06-08 21:19:07 +0000[diff] [blame]641 <li>The X86 backend generates inefficient floating point code when configured
642 to generate code for systems that don't have SSE2.</li>
Duncan Sands47eff2b2008-06-08 19:38:43 +0000[diff] [blame]643 <li>Win64 code generation wasn't widely tested. Everything should work, but we
Anton Korobeynikova6094be2008-06-08 10:24:13 +0000[diff] [blame]644 expect small issues to happen. Also, llvm-gcc cannot build mingw64 runtime
645 currently due
646 to <a href="http://llvm.org/PR2255">several</a>
Chris Lattner04af7cb2008-06-08 23:12:47 +0000[diff] [blame]647 <a href="http://llvm.org/PR2257">bugs</a> due to lack of support for the
648 'u' inline assembly constraint and X87 floating point inline assembly.</li>
Dan Gohman8207ba92008-06-08 23:05:11 +0000[diff] [blame]649 <li>The X86-64 backend does not yet support the LLVM IR instruction
650 <tt>va_arg</tt>. Currently, the llvm-gcc front-end supports variadic
651 argument constructs on X86-64 by lowering them manually.</li>
Chris Lattner26299222006-11-18 07:51:14 +0000[diff] [blame]652</ul>
653
654</div>
655
656<!-- ======================================================================= -->
657<div class="doc_subsection">
658 <a name="ppc-be">Known problems with the PowerPC back-end</a>
659</div>
660
661<div class="doc_text">
662
663<ul>
Nicolas Geoffraye4285dc2007-05-15 09:21:28 +0000[diff] [blame]664<li>The Linux PPC32/ABI support needs testing for the interpreter and static
Chris Lattner57a460e2007-05-23 04:39:32 +0000[diff] [blame]665compilation, and lacks support for debug information.</li>
Chris Lattner26299222006-11-18 07:51:14 +0000[diff] [blame]666</ul>
667
668</div>
669
670<!-- ======================================================================= -->
671<div class="doc_subsection">
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000[diff] [blame]672 <a name="arm-be">Known problems with the ARM back-end</a>
673</div>
674
675<div class="doc_text">
676
677<ul>
Chris Lattner57a460e2007-05-23 04:39:32 +0000[diff] [blame]678<li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
Duncan Sandsc90d68b2007-09-26 15:59:54 +0000[diff] [blame]679processors, thumb programs can crash or produce wrong
Chris Lattner57a460e2007-05-23 04:39:32 +0000[diff] [blame]680results (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000[diff] [blame]681<li>Compilation for ARM Linux OABI (old ABI) is supported, but not fully tested.
682</li>
Chris Lattnere6e1b352008-06-08 21:19:07 +0000[diff] [blame]683<li>There is a bug in QEMU-ARM (&lt;= 0.9.0) which causes it to incorrectly
684 execute
Chris Lattner57a460e2007-05-23 04:39:32 +0000[diff] [blame]685programs compiled with LLVM. Please use more recent versions of QEMU.</li>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000[diff] [blame]686</ul>
687
688</div>
689
690<!-- ======================================================================= -->
691<div class="doc_subsection">
Chris Lattner26299222006-11-18 07:51:14 +0000[diff] [blame]692 <a name="sparc-be">Known problems with the SPARC back-end</a>
693</div>
694
695<div class="doc_text">
696
697<ul>
698<li>The SPARC backend only supports the 32-bit SPARC ABI (-m32), it does not
699 support the 64-bit SPARC ABI (-m64).</li>
700</ul>
701
702</div>
703
704<!-- ======================================================================= -->
705<div class="doc_subsection">
Chris Lattner26299222006-11-18 07:51:14 +0000[diff] [blame]706 <a name="alpha-be">Known problems with the Alpha back-end</a>
707</div>
708
709<div class="doc_text">
710
711<ul>
712
713<li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
714appropriate nops inserted to ensure restartability.</li>
715
John Criswellc0c186d2005-11-08 21:11:33 +0000[diff] [blame]716</ul>
717</div>
718
Chris Lattner26299222006-11-18 07:51:14 +0000[diff] [blame]719<!-- ======================================================================= -->
720<div class="doc_subsection">
721 <a name="ia64-be">Known problems with the IA64 back-end</a>
722</div>
723
724<div class="doc_text">
725
726<ul>
Chris Lattner04af7cb2008-06-08 23:12:47 +0000[diff] [blame]727<li>The Itanium backend is highly experimental, and has a number of known
728 issues. We are looking for a maintainer for the Itanium backend. If you
729 are interested, please contact the llvmdev mailing list.</li>
Chris Lattner26299222006-11-18 07:51:14 +0000[diff] [blame]730</ul>
731
732</div>
733
734<!-- ======================================================================= -->
735<div class="doc_subsection">
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000[diff] [blame]736 <a name="c-be">Known problems with the C back-end</a>
Chris Lattner26299222006-11-18 07:51:14 +0000[diff] [blame]737</div>
738
739<div class="doc_text">
740
741<ul>
Chris Lattner5733b272008-06-05 06:35:40 +0000[diff] [blame]742<li><a href="http://llvm.org/PR802">The C backend has only basic support for
743 inline assembly code</a>.</li>
Chris Lattner725a0d82007-09-26 06:01:35 +0000[diff] [blame]744<li><a href="http://llvm.org/PR1658">The C backend violates the ABI of common
745 C++ programs</a>, preventing intermixing between C++ compiled by the CBE and
Duncan Sands27aff872008-06-08 20:18:35 +0000[diff] [blame]746 C++ code compiled with llc or native compilers.</li>
Duncan Sandsf74c0cc2008-02-10 13:40:55 +0000[diff] [blame]747<li>The C backend does not support all exception handling constructs.</li>
Chris Lattner26299222006-11-18 07:51:14 +0000[diff] [blame]748</ul>
749
750</div>
John Criswellc0c186d2005-11-08 21:11:33 +0000[diff] [blame]751
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]752
753<!-- ======================================================================= -->
754<div class="doc_subsection">
Chris Lattner5733b272008-06-05 06:35:40 +0000[diff] [blame]755 <a name="c-fe">Known problems with the llvm-gcc C front-end</a>
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]756</div>
Chris Lattner47588f92003-10-02 05:07:23 +0000[diff] [blame]757
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]758<div class="doc_text">
Chris Lattnerc5d658a2006-03-03 00:34:26 +0000[diff] [blame]759
Chris Lattner252b83d2008-02-06 18:00:06 +0000[diff] [blame]760<p>llvm-gcc does not currently support <a href="http://llvm.org/PR869">Link-Time
761Optimization</a> on most platforms "out-of-the-box". Please inquire on the
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000[diff] [blame]762llvmdev mailing list if you are interested.</p>
Chris Lattnerd9ea0172006-08-08 17:27:28 +0000[diff] [blame]763
Chris Lattner5733b272008-06-05 06:35:40 +0000[diff] [blame]764<p>The only major language feature of GCC not supported by llvm-gcc is
765 the <tt>__builtin_apply</tt> family of builtins. However, some extensions
766 are only supported on some targets. For example, trampolines are only
Duncan Sands27aff872008-06-08 20:18:35 +0000[diff] [blame]767 supported on some targets (these are used when you take the address of a
768 nested function).</p>
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]769
Chris Lattner5733b272008-06-05 06:35:40 +0000[diff] [blame]770<p>If you run into GCC extensions which are not supported, please let us know.
771</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]772
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]773</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]774
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]775<!-- ======================================================================= -->
776<div class="doc_subsection">
Chris Lattner5733b272008-06-05 06:35:40 +0000[diff] [blame]777 <a name="c++-fe">Known problems with the llvm-gcc C++ front-end</a>
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]778</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]779
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]780<div class="doc_text">
781
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000[diff] [blame]782<p>The C++ front-end is considered to be fully
Chris Lattner7506b1d2004-12-07 08:04:13 +0000[diff] [blame]783tested and works for a number of non-trivial programs, including LLVM
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000[diff] [blame]784itself, Qt, Mozilla, etc.</p>
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]785
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]786<ul>
Anton Korobeynikov0021fc12008-10-11 18:27:16 +0000[diff] [blame]787<li>Exception handling works well on the X86 and PowerPC targets. Currently
788 only linux and darwin targets are supported (both 32 and 64 bit).</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]789</ul>
Chris Lattnerfcc54b32003-10-07 22:14:37 +0000[diff] [blame]790
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]791</div>
792
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]793
Chris Lattner2b659ef2008-02-12 06:29:45 +0000[diff] [blame]794<!-- ======================================================================= -->
795<div class="doc_subsection">
Chris Lattner5733b272008-06-05 06:35:40 +0000[diff] [blame]796 <a name="ada-fe">Known problems with the llvm-gcc Ada front-end</a>
Chris Lattner2b659ef2008-02-12 06:29:45 +0000[diff] [blame]797</div>
798
799<div class="doc_text">
800The llvm-gcc 4.2 Ada compiler works fairly well, however this is not a mature
801technology and problems should be expected.
802<ul>
Duncan Sands27aff872008-06-08 20:18:35 +0000[diff] [blame]803<li>The Ada front-end currently only builds on X86-32. This is mainly due
Chris Lattner2b659ef2008-02-12 06:29:45 +0000[diff] [blame]804to lack of trampoline support (pointers to nested functions) on other platforms,
Duncan Sands27aff872008-06-08 20:18:35 +0000[diff] [blame]805however it <a href="http://llvm.org/PR2006">also fails to build on X86-64</a>
Chris Lattner2b659ef2008-02-12 06:29:45 +0000[diff] [blame]806which does support trampolines.</li>
807<li>The Ada front-end <a href="http://llvm.org/PR2007">fails to bootstrap</a>.
808Workaround: configure with --disable-bootstrap.</li>
Duncan Sands978bcee2008-10-13 17:27:23 +0000[diff] [blame]809<li>The c380004, <a href="http://llvm.org/PR2010">c393010</a>
810and <a href="http://llvm.org/PR2421">cxg2021</a> ACATS tests fail
811(c380004 also fails with gcc-4.2 mainline).</li>
812<li>Some gcc specific Ada tests continue to crash the compiler.</li>
Chris Lattner2b659ef2008-02-12 06:29:45 +0000[diff] [blame]813<li>The -E binder option (exception backtraces)
814<a href="http://llvm.org/PR1982">does not work</a> and will result in programs
815crashing if an exception is raised. Workaround: do not use -E.</li>
816<li>Only discrete types <a href="http://llvm.org/PR1981">are allowed to start
817or finish at a non-byte offset</a> in a record. Workaround: do not pack records
818or use representation clauses that result in a field of a non-discrete type
819starting or finishing in the middle of a byte.</li>
Chris Lattnere6e1b352008-06-08 21:19:07 +0000[diff] [blame]820<li>The <tt>lli</tt> interpreter <a href="http://llvm.org/PR2009">considers
821'main' as generated by the Ada binder to be invalid</a>.
822Workaround: hand edit the file to use pointers for <tt>argv</tt> and
823<tt>envp</tt> rather than integers.</li>
824<li>The <tt>-fstack-check</tt> option <a href="http://llvm.org/PR2008">is
825ignored</a>.</li>
Chris Lattner2b659ef2008-02-12 06:29:45 +0000[diff] [blame]826</ul>
827</div>
828
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]829<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]830<div class="doc_section">
831 <a name="additionalinfo">Additional Information</a>
832</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]833<!-- *********************************************************************** -->
834
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]835<div class="doc_text">
836
Chris Lattner416db102005-05-16 17:13:10 +0000[diff] [blame]837<p>A wide variety of additional information is available on the <a
Chris Lattnerb4b0ce72007-05-18 00:44:29 +0000[diff] [blame]838href="http://llvm.org">LLVM web page</a>, in particular in the <a
839href="http://llvm.org/docs/">documentation</a> section. The web page also
Reid Spencer669ed452007-07-09 08:04:31 +0000[diff] [blame]840contains versions of the API documentation which is up-to-date with the
841Subversion version of the source code.
Misha Brukman109d9e82005-03-30 19:14:24 +0000[diff] [blame]842You can access versions of these documents specific to this release by going
843into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]844
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]845<p>If you have any questions or comments about LLVM, please feel free to contact
Chris Lattnerc463b272005-10-29 07:07:09 +0000[diff] [blame]846us via the <a href="http://llvm.org/docs/#maillist"> mailing
Chris Lattner5eccca42003-12-12 21:22:16 +0000[diff] [blame]847lists</a>.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]848
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]849</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]850
851<!-- *********************************************************************** -->
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]852
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]853<hr>
Misha Brukman2061e892003-11-22 01:23:39 +0000[diff] [blame]854<address>
Misha Brukman38847d52003-12-21 22:53:21 +0000[diff] [blame]855 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman2061e892003-11-22 01:23:39 +0000[diff] [blame]856 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
857 <a href="http://validator.w3.org/check/referer"><img
Chris Lattner8170c102008-02-10 08:18:42 +0000[diff] [blame]858 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
Misha Brukman2061e892003-11-22 01:23:39 +0000[diff] [blame]859
Chris Lattnerb4b0ce72007-05-18 00:44:29 +0000[diff] [blame]860 <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]861 Last modified: $Date$
Misha Brukman2061e892003-11-22 01:23:39 +0000[diff] [blame]862</address>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]863
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]864</body>
865</html>