Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / llvm / 09a43769d7a947c7af72c74955aac4dd12dbaaca / . / docs / ReleaseNotes.html
blob: 86a10605287bd2fb888c008ee1fd331b14116801 [file] [log] [blame]
Dan Gohmanf17a25c2007-07-18 16:29:46 +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>
5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
6 <link rel="stylesheet" href="llvm.css" type="text/css">
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000[diff] [blame]7 <title>LLVM 2.7 Release Notes</title>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]8</head>
9<body>
10
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000[diff] [blame]11<div class="doc_title">LLVM 2.7 Release Notes</div>
Mikhail Glushenkov808cd3e2008-10-13 02:08:34 +0000[diff] [blame]12
Chris Lattnere5236102010-03-17 04:02:39 +0000[diff] [blame]13<img align=right src="http://llvm.org/img/DragonSmall.png"
14 width="136" height="136">
15
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]16<ol>
17 <li><a href="#intro">Introduction</a></li>
Chris Lattner78a130b2008-10-13 18:01:01 +0000[diff] [blame]18 <li><a href="#subproj">Sub-project Status Update</a></li>
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000[diff] [blame]19 <li><a href="#externalproj">External Projects Using LLVM 2.7</a></li>
20 <li><a href="#whatsnew">What's New in LLVM 2.7?</a></li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]21 <li><a href="GettingStarted.html">Installation Instructions</a></li>
22 <li><a href="#portability">Portability and Supported Platforms</a></li>
Dan Gohman0de549c2008-10-14 16:23:02 +0000[diff] [blame]23 <li><a href="#knownproblems">Known Problems</a></li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]24 <li><a href="#additionalinfo">Additional Information</a></li>
25</ol>
26
27<div class="doc_author">
Dan Gohman0de549c2008-10-14 16:23:02 +0000[diff] [blame]28 <p>Written by the <a href="http://llvm.org">LLVM Team</a></p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]29</div>
30
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000[diff] [blame]31<h1 style="color:red">These are in-progress notes for the upcoming LLVM 2.7
32release.<br>
33You may prefer the
34<a href="http://llvm.org/releases/2.6/docs/ReleaseNotes.html">LLVM 2.6
35Release Notes</a>.</h1>
36
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]37<!-- *********************************************************************** -->
38<div class="doc_section">
39 <a name="intro">Introduction</a>
40</div>
41<!-- *********************************************************************** -->
42
43<div class="doc_text">
44
Chris Lattner92eacf82008-10-13 17:57:36 +0000[diff] [blame]45<p>This document contains the release notes for the LLVM Compiler
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000[diff] [blame]46Infrastructure, release 2.7. Here we describe the status of LLVM, including
Chris Lattner92eacf82008-10-13 17:57:36 +0000[diff] [blame]47major improvements from the previous release and significant known problems.
Mikhail Glushenkovf61066a2009-03-01 18:09:47 +0000[diff] [blame]48All LLVM releases may be downloaded from the <a
Chris Lattner92eacf82008-10-13 17:57:36 +0000[diff] [blame]49href="http://llvm.org/releases/">LLVM releases web site</a>.</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]50
51<p>For more information about LLVM, including information about the latest
52release, please check out the <a href="http://llvm.org/">main LLVM
53web site</a>. If you have questions or comments, the <a
Chris Lattner58b1d0f2010-03-17 04:41:49 +0000[diff] [blame]54href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM Developer's
55Mailing List</a> is a good place to send them.</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]56
Mikhail Glushenkov808cd3e2008-10-13 02:08:34 +0000[diff] [blame]57<p>Note that if you are reading this file from a Subversion checkout or the
Chris Lattnerb0d6c502007-09-21 03:54:09 +0000[diff] [blame]58main LLVM web page, this document applies to the <i>next</i> release, not the
Gabor Greif7c65c4f2008-10-14 11:00:32 +0000[diff] [blame]59current one. To see the release notes for a specific release, please see the
Chris Lattnerb0d6c502007-09-21 03:54:09 +0000[diff] [blame]60<a href="http://llvm.org/releases/">releases page</a>.</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]61
Chris Lattner58b1d0f2010-03-17 04:41:49 +0000[diff] [blame]62
Chris Lattner2b656342010-03-17 06:41:58 +0000[diff] [blame]63<p>FIXME: llvm.org moved to new server, mention new logo, Ted and Doug new code
64 owners.</p>
Chris Lattner58b1d0f2010-03-17 04:41:49 +0000[diff] [blame]65
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]66</div>
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]67
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]68
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]69<!--
70Almost dead code.
71 include/llvm/Analysis/LiveValues.h => Dan
72 lib/Transforms/IPO/MergeFunctions.cpp => consider for 2.8.
73 llvm/Analysis/PointerTracking.h => Edwin wants this, consider for 2.8.
Chris Lattner35da3812010-01-09 22:30:40 +0000[diff] [blame]74 ABCD, SCCVN, GEPSplitterPass
Chris Lattner2bd5e652010-01-16 21:25:13 +0000[diff] [blame]75 MSIL backend?
Chris Lattner2b656342010-03-17 06:41:58 +0000[diff] [blame]76 lib/Transforms/Utils/SSI.cpp -> ABCD depends on it.
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]77-->
78
79
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000[diff] [blame]80<!-- Features that need text if they're finished for 2.7:
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]81 gcc plugin.
82 strong phi elim
83 variable debug info for optimized code
Chris Lattnerb2cc5022009-02-26 22:33:38 +0000[diff] [blame]84 postalloc scheduler: anti dependence breaking, hazard recognizer?
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]85 metadata
86 loop dependence analysis
87 ELF Writer? How stable?
88 <li>PostRA scheduler improvements, ARM adoption (David Goodwin).</li>
Chris Lattner8fda4952008-02-10 07:46:44 +0000[diff] [blame]89 -->
Mikhail Glushenkov808cd3e2008-10-13 02:08:34 +0000[diff] [blame]90
Chris Lattner4f076402008-10-12 19:47:48 +0000[diff] [blame]91 <!-- for announcement email:
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]92 Logo web page.
93 llvm devmtg
94 compiler_rt
95 KLEE web page at klee.llvm.org
96 Many new papers added to /pubs/
Chris Lattner2b656342010-03-17 06:41:58 +0000[diff] [blame]97 Mention gcc plugin.
Chris Lattnera53f4972009-02-25 06:34:50 +0000[diff] [blame]98 -->
Chris Lattner8fda4952008-02-10 07:46:44 +0000[diff] [blame]99
Chris Lattner78a130b2008-10-13 18:01:01 +0000[diff] [blame]100<!-- *********************************************************************** -->
101<div class="doc_section">
102 <a name="subproj">Sub-project Status Update</a>
Chris Lattnerf65224f2008-06-08 21:34:41 +0000[diff] [blame]103</div>
Chris Lattner78a130b2008-10-13 18:01:01 +0000[diff] [blame]104<!-- *********************************************************************** -->
Chris Lattnerf65224f2008-06-08 21:34:41 +0000[diff] [blame]105
106<div class="doc_text">
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000[diff] [blame]107<p>
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000[diff] [blame]108The LLVM 2.7 distribution currently consists of code from the core LLVM
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]109repository (which roughly includes the LLVM optimizers, code generators
110and supporting tools), the Clang repository and the llvm-gcc repository. In
111addition to this code, the LLVM Project includes other sub-projects that are in
112development. Here we include updates on these subprojects.
Bill Wendlingdde41b82009-03-02 04:28:57 +0000[diff] [blame]113</p>
Chris Lattner78a130b2008-10-13 18:01:01 +0000[diff] [blame]114
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000[diff] [blame]115</div>
116
Chris Lattner78a130b2008-10-13 18:01:01 +0000[diff] [blame]117
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000[diff] [blame]118<!--=========================================================================-->
Chris Lattner78a130b2008-10-13 18:01:01 +0000[diff] [blame]119<div class="doc_subsection">
Chris Lattnera3c683b2008-10-13 18:11:54 +0000[diff] [blame]120<a name="clang">Clang: C/C++/Objective-C Frontend Toolkit</a>
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000[diff] [blame]121</div>
122
123<div class="doc_text">
124
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000[diff] [blame]125<p>The <a href="http://clang.llvm.org/">Clang project</a> is ...</p>
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]126
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000[diff] [blame]127<p>In the LLVM 2.7 time-frame, the Clang team has made many improvements:</p>
Bill Wendling385b0d32008-10-27 09:27:33 +0000[diff] [blame]128
Daniel Dunbarf3e35782008-10-14 23:25:09 +0000[diff] [blame]129<ul>
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000[diff] [blame]130<li>...</li>
Chris Lattner2b656342010-03-17 06:41:58 +0000[diff] [blame]131include a link to cxx_compatibility.html
Bill Wendlinga8fb81d2009-03-02 04:28:18 +0000[diff] [blame]132</ul>
Chris Lattnera3c683b2008-10-13 18:11:54 +0000[diff] [blame]133</div>
134
135<!--=========================================================================-->
136<div class="doc_subsection">
137<a name="clangsa">Clang Static Analyzer</a>
138</div>
139
140<div class="doc_text">
141
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000[diff] [blame]142<p>Previously announced in the 2.4, 2.5, and 2.6 LLVM releases, the Clang project also
Ted Kremeneka0d77d72009-02-27 07:01:32 +0000[diff] [blame]143includes an early stage static source code analysis tool for <a
144href="http://clang.llvm.org/StaticAnalysis.html">automatically finding bugs</a>
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]145in C and Objective-C programs. The tool performs checks to find
Ted Kremeneka0d77d72009-02-27 07:01:32 +0000[diff] [blame]146bugs that occur on a specific path within a program.</p>
Chris Lattnerc2d84672008-10-14 00:52:49 +0000[diff] [blame]147
Chris Lattnere5236102010-03-17 04:02:39 +0000[diff] [blame]148<p>In the LLVM 2.7 time-frame, the analyzer core has sprouted legs and...</p>
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000[diff] [blame]149
150</div>
151
Chris Lattner78a130b2008-10-13 18:01:01 +0000[diff] [blame]152<!--=========================================================================-->
153<div class="doc_subsection">
Nicolas Geoffray2b139382008-10-14 19:23:04 +0000[diff] [blame]154<a name="vmkit">VMKit: JVM/CLI Virtual Machine Implementation</a>
Chris Lattner78a130b2008-10-13 18:01:01 +0000[diff] [blame]155</div>
156
157<div class="doc_text">
158<p>
Nicolas Geoffray2b139382008-10-14 19:23:04 +0000[diff] [blame]159The <a href="http://vmkit.llvm.org/">VMKit project</a> is an implementation of
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]160a JVM and a CLI Virtual Machine (Microsoft .NET is an
161implementation of the CLI) using LLVM for static and just-in-time
162compilation.</p>
Chris Lattner78a130b2008-10-13 18:01:01 +0000[diff] [blame]163
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]164<p>
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000[diff] [blame]165VMKit version ?? builds with LLVM 2.7 and you can find it on its
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]166<a href="http://vmkit.llvm.org/releases/">web page</a>. The release includes
Nicolas Geoffray20cfdd42008-10-15 20:25:04 +0000[diff] [blame]167bug fixes, cleanup and new features. The major changes are:</p>
Chris Lattner78a130b2008-10-13 18:01:01 +0000[diff] [blame]168
Nicolas Geoffray2b139382008-10-14 19:23:04 +0000[diff] [blame]169<ul>
170
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000[diff] [blame]171<li>...</li>
Nicolas Geoffray2b139382008-10-14 19:23:04 +0000[diff] [blame]172
173</ul>
Chris Lattner78a130b2008-10-13 18:01:01 +0000[diff] [blame]174</div>
175
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]176
177<!--=========================================================================-->
178<div class="doc_subsection">
179<a name="compiler-rt">compiler-rt: Compiler Runtime Library</a>
180</div>
181
182<div class="doc_text">
183<p>
184The new LLVM <a href="http://compiler-rt.llvm.org/">compiler-rt project</a>
185is a simple library that provides an implementation of the low-level
186target-specific hooks required by code generation and other runtime components.
187For example, when compiling for a 32-bit target, converting a double to a 64-bit
188unsigned integer is compiled into a runtime call to the "__fixunsdfdi"
189function. The compiler-rt library provides highly optimized implementations of
190this and other low-level routines (some are 3x faster than the equivalent
191libgcc routines).</p>
192
193<p>
194All of the code in the compiler-rt project is available under the standard LLVM
195License, a "BSD-style" license.</p>
196
197</div>
198
199<!--=========================================================================-->
200<div class="doc_subsection">
201<a name="klee">KLEE: Symbolic Execution and Automatic Test Case Generator</a>
202</div>
203
204<div class="doc_text">
205<p>
206The new LLVM <a href="http://klee.llvm.org/">KLEE project</a> is a symbolic
207execution framework for programs in LLVM bitcode form. KLEE tries to
208symbolically evaluate "all" paths through the application and records state
209transitions that lead to fault states. This allows it to construct testcases
210that lead to faults and can even be used to verify algorithms. For more
211details, please see the <a
212href="http://llvm.org/pubs/2008-12-OSDI-KLEE.html">OSDI 2008 paper</a> about
213KLEE.</p>
214
215</div>
216
217<!--=========================================================================-->
218<div class="doc_subsection">
219<a name="dragonegg">DragonEgg: GCC-4.5 as an LLVM frontend</a>
220</div>
221
222<div class="doc_text">
223<p>
224The goal of <a href="http://dragonegg.llvm.org/">DragonEgg</a> is to make
225gcc-4.5 act like llvm-gcc without requiring any gcc modifications whatsoever.
Duncan Sandsf6fb7142009-10-15 08:17:44 +0000[diff] [blame]226<a href="http://dragonegg.llvm.org/">DragonEgg</a> is a shared library (dragonegg.so)
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000[diff] [blame]227that is loaded by gcc at runtime. It ...
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]228</p>
229
230</div>
231
232
233<!--=========================================================================-->
234<div class="doc_subsection">
235<a name="mc">llvm-mc: Machine Code Toolkit</a>
236</div>
237
238<div class="doc_text">
239<p>
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000[diff] [blame]240The LLVM Machine Code (MC) Toolkit project is ...
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]241</p>
242
243</div>
244
245
Chris Lattnerb2cc5022009-02-26 22:33:38 +0000[diff] [blame]246<!-- *********************************************************************** -->
247<div class="doc_section">
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000[diff] [blame]248 <a name="externalproj">External Open Source Projects Using LLVM 2.7</a>
Chris Lattnerb2cc5022009-02-26 22:33:38 +0000[diff] [blame]249</div>
250<!-- *********************************************************************** -->
251
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]252<div class="doc_text">
253
254<p>An exciting aspect of LLVM is that it is used as an enabling technology for
255 a lot of other language and tools projects. This section lists some of the
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000[diff] [blame]256 projects that have already been updated to work with LLVM 2.7.</p>
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]257</div>
258
259
260<!--=========================================================================-->
261<div class="doc_subsection">
262<a name="Rubinius">Rubinius</a>
263</div>
264
265<div class="doc_text">
Chris Lattnere5236102010-03-17 04:02:39 +0000[diff] [blame]266Need update.
267<!--
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]268<p><a href="http://github.com/evanphx/rubinius">Rubinius</a> is an environment
269for running Ruby code which strives to write as much of the core class
270implementation in Ruby as possible. Combined with a bytecode interpreting VM, it
271uses LLVM to optimize and compile ruby code down to machine code. Techniques
272such as type feedback, method inlining, and uncommon traps are all used to
273remove dynamism from ruby execution and increase performance.</p>
274
275<p>Since LLVM 2.5, Rubinius has made several major leaps forward, implementing
276a counter based JIT, type feedback and speculative method inlining.
Chris Lattnere5236102010-03-17 04:02:39 +0000[diff] [blame]277-->
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]278</p>
279
280</div>
281
282<!--=========================================================================-->
283<div class="doc_subsection">
284<a name="macruby">MacRuby</a>
285</div>
286
287<div class="doc_text">
288
289<p>
Chris Lattnere5236102010-03-17 04:02:39 +0000[diff] [blame]290Need update.
291<!--
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]292<a href="http://macruby.org">MacRuby</a> is an implementation of Ruby on top of
293core Mac OS X technologies, such as the Objective-C common runtime and garbage
294collector and the CoreFoundation framework. It is principally developed by
295Apple and aims at enabling the creation of full-fledged Mac OS X applications.
296</p>
297
298<p>
299MacRuby uses LLVM for optimization passes, JIT and AOT compilation of Ruby
300expressions. It also uses zero-cost DWARF exceptions to implement Ruby exception
Chris Lattnere5236102010-03-17 04:02:39 +0000[diff] [blame]301handling.--> </p>
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]302
303</div>
304
305
Chris Lattnerb2cc5022009-02-26 22:33:38 +0000[diff] [blame]306<!--=========================================================================-->
307<div class="doc_subsection">
308<a name="pure">Pure</a>
309</div>
310
311<div class="doc_text">
312<p>
Chris Lattner47202c32009-03-02 02:37:32 +0000[diff] [blame]313<a href="http://pure-lang.googlecode.com/">Pure</a>
314is an algebraic/functional programming language based on term rewriting.
Chris Lattnerb2cc5022009-02-26 22:33:38 +0000[diff] [blame]315Programs are collections of equations which are used to evaluate expressions in
316a symbolic fashion. Pure offers dynamic typing, eager and lazy evaluation,
Mikhail Glushenkovf61066a2009-03-01 18:09:47 +0000[diff] [blame]317lexical closures, a hygienic macro system (also based on term rewriting),
Chris Lattnerb2cc5022009-02-26 22:33:38 +0000[diff] [blame]318built-in list and matrix support (including list and matrix comprehensions) and
319an easy-to-use C interface. The interpreter uses LLVM as a backend to
320 JIT-compile Pure programs to fast native code.</p>
321
Chris Lattner1f8dc512010-03-17 17:25:49 +0000[diff] [blame]322<p>Pure versions 0.43 and later have been tested and are known to work with
323LLVM 2.7 (and continue to work with older LLVM releases >= 2.5).</p>
324
Chris Lattnerb2cc5022009-02-26 22:33:38 +0000[diff] [blame]325</div>
326
327
328<!--=========================================================================-->
329<div class="doc_subsection">
330<a name="ldc">LLVM D Compiler</a>
331</div>
332
333<div class="doc_text">
334<p>
Chris Lattnere5236102010-03-17 04:02:39 +0000[diff] [blame]335Need update.
336<!--
Chris Lattner47202c32009-03-02 02:37:32 +0000[diff] [blame]337<a href="http://www.dsource.org/projects/ldc">LDC</a> is an implementation of
338the D Programming Language using the LLVM optimizer and code generator.
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]339The LDC project works great with the LLVM 2.6 release. General improvements in
John Criswellaea8c752009-03-02 15:28:15 +0000[diff] [blame]340this
Chris Lattner47202c32009-03-02 02:37:32 +0000[diff] [blame]341cycle have included new inline asm constraint handling, better debug info
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]342support, general bug fixes and better x86-64 support. This has allowed
343some major improvements in LDC, getting it much closer to being as
Chris Lattnere5236102010-03-17 04:02:39 +0000[diff] [blame]344fully featured as the original DMD compiler from DigitalMars.-->
Chris Lattnerb2cc5022009-02-26 22:33:38 +0000[diff] [blame]345</p>
346</div>
347
Chris Lattner1ad599a2009-02-28 18:58:01 +0000[diff] [blame]348<!--=========================================================================-->
349<div class="doc_subsection">
350<a name="RoadsendPHP">Roadsend PHP</a>
351</div>
352
353<div class="doc_text">
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]354<p>
355<a href="http://code.roadsend.com/rphp">Roadsend PHP</a> (rphp) is an open
Chris Lattner9e08de12009-03-02 19:07:24 +0000[diff] [blame]356source implementation of the PHP programming
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]357language that uses LLVM for its optimizer, JIT and static compiler. This is a
Chris Lattnere5236102010-03-17 04:02:39 +0000[diff] [blame]358reimplementation of an earlier project that is now based on LLVM.
Chris Lattner1f8dc512010-03-17 17:25:49 +0000[diff] [blame]359</p>
Chris Lattner1ad599a2009-02-28 18:58:01 +0000[diff] [blame]360</div>
Chris Lattnerb2cc5022009-02-26 22:33:38 +0000[diff] [blame]361
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]362<!--=========================================================================-->
363<div class="doc_subsection">
364<a name="UnladenSwallow">Unladen Swallow</a>
365</div>
366
367<div class="doc_text">
368<p>
Chris Lattnere5236102010-03-17 04:02:39 +0000[diff] [blame]369Need update.
370<!--
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]371<a href="http://code.google.com/p/unladen-swallow/">Unladen Swallow</a> is a
372branch of <a href="http://python.org/">Python</a> intended to be fully
373compatible and significantly faster. It uses LLVM's optimization passes and JIT
Chris Lattnere5236102010-03-17 04:02:39 +0000[diff] [blame]374compiler.-->
375</p>
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]376</div>
377
378<!--=========================================================================-->
379<div class="doc_subsection">
380<a name="llvm-lua">llvm-lua</a>
381</div>
382
383<div class="doc_text">
384<p>
Chris Lattnere5236102010-03-17 04:02:39 +0000[diff] [blame]385Need update.
386<!--
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]387<a href="http://code.google.com/p/llvm-lua/">LLVM-Lua</a> uses LLVM to add JIT
388and static compiling support to the Lua VM. Lua bytecode is analyzed to
389remove type checks, then LLVM is used to compile the bytecode down to machine
Chris Lattnere5236102010-03-17 04:02:39 +0000[diff] [blame]390code.-->
391</p>
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]392</div>
393
394<!--=========================================================================-->
395<div class="doc_subsection">
396<a name="icedtea">IcedTea Java Virtual Machine Implementation</a>
397</div>
398
399<div class="doc_text">
400<p>
Chris Lattnere5236102010-03-17 04:02:39 +0000[diff] [blame]401Need update.
402<!--
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]403<a href="http://icedtea.classpath.org/wiki/Main_Page">IcedTea</a> provides a
404harness to build OpenJDK using only free software build tools and to provide
405replacements for the not-yet free parts of OpenJDK. One of the extensions that
406IcedTea provides is a new JIT compiler named <a
407href="http://icedtea.classpath.org/wiki/ZeroSharkFaq">Shark</a> which uses LLVM
408to provide native code generation without introducing processor-dependent
Chris Lattnere5236102010-03-17 04:02:39 +0000[diff] [blame]409code.-->
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]410</p>
411</div>
412
413
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000[diff] [blame]414
415<!-- *********************************************************************** -->
416<div class="doc_section">
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000[diff] [blame]417 <a name="whatsnew">What's New in LLVM 2.7?</a>
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000[diff] [blame]418</div>
419<!-- *********************************************************************** -->
420
Chris Lattner5cce7a52008-06-08 22:59:35 +0000[diff] [blame]421<div class="doc_text">
422
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]423<p>This release includes a huge number of bug fixes, performance tweaks and
Chris Lattner92eacf82008-10-13 17:57:36 +0000[diff] [blame]424minor improvements. Some of the major improvements and new features are listed
425in this section.
Chris Lattner5cce7a52008-06-08 22:59:35 +0000[diff] [blame]426</p>
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]427
Chris Lattner5cce7a52008-06-08 22:59:35 +0000[diff] [blame]428</div>
429
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000[diff] [blame]430<!--=========================================================================-->
Chris Lattnerf65224f2008-06-08 21:34:41 +0000[diff] [blame]431<div class="doc_subsection">
Chris Lattnere0798082008-02-06 18:00:06 +0000[diff] [blame]432<a name="majorfeatures">Major New Features</a>
433</div>
434
435<div class="doc_text">
436
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000[diff] [blame]437<p>LLVM 2.7 includes several major new capabilities:</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]438
439<ul>
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000[diff] [blame]440<li>...</li>
Chris Lattner5ba16862008-02-10 08:18:42 +0000[diff] [blame]441</ul>
442
Chris Lattner58b1d0f2010-03-17 04:41:49 +0000[diff] [blame]443Extensible metadata solid.
444
445Debug info improvements: using metadata instead of llvm.dbg global variables.
446This brings several enhancements including improved compile times.
447
448New instruction selector.
449GHC Haskell ABI/ calling conv support.
450Pre-Alpha support for unions in IR.
451New InlineHint and StackAlignment function attributes
452Code generator MC'ized except for debug info and EH.
453New SCEV AA pass: -scev-aa
454Inliner reuses arrays allocas when inlining multiple callers to reduce stack usage.
455MC encoding and disassembler apis.
456Optimal Edge Profiling?
457Instcombine is now a library, has its own IRBuilder to simplify itself.
458New llvm/Support/Regex.h API. FileCheck now does regex's
Chris Lattner2b656342010-03-17 06:41:58 +0000[diff] [blame]459Many subtle pointer invalidation bugs in Callgraph have been fixed and it now uses asserting value handles.
460MC Disassembler (with blog post), MCInstPrinter. Many X86 backend and AsmPrinter simplifications
461Various tools like llc and opt now read either .ll or .bc files as input.
462Malloc and free instructions got removed.
463compiler-rt support for ARM.
464completely llvm-gcc NEON support.
465Can transcode from GAS to intel syntax with "llvm-mc foo.s -output-asm-variant=1"
466JIT debug information with GDB 7.0
467New CodeGen Level LICM And CSE (did it make 2.7?)
468CMake can now run tests, what other improvements?
469ARM/Thumb register scavenging improvements?
470New SSAUpdater and MachineSSAUpdater classes for unstructured ssa updating,
471 changed jump threading, GVN, etc to use it which simplified them and speed
472 them up.
Chris Lattner99bfacb2010-03-17 06:42:25 +0000[diff] [blame]473Combiner-AA improvements, why not on by default?
Chris Lattner58b1d0f2010-03-17 04:41:49 +0000[diff] [blame]474
Chris Lattner2b656342010-03-17 06:41:58 +0000[diff] [blame]475CondProp pass removed (functionality merged into jump threading).
Chris Lattner58b1d0f2010-03-17 04:41:49 +0000[diff] [blame]476AndersAA got removed (from 2.7 or mainline?)
Chris Lattner2b656342010-03-17 06:41:58 +0000[diff] [blame]477PredSimplify, LoopVR, GVNPRE got removed.
Chris Lattner58b1d0f2010-03-17 04:41:49 +0000[diff] [blame]478LLVM command line tools now overwrite their output, before they would only do this with -f.
479DOUT removed, use DEBUG(errs() instead.
480Much stuff converted to use raw_ostream instead of std::ostream.
481TargetAsmInfo renamed to MCAsmInfo
482llvm/ADT/iterator.h gone.
483
Chris Lattner2b656342010-03-17 06:41:58 +0000[diff] [blame]484
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]485</div>
486
Chris Lattnerb0d6c502007-09-21 03:54:09 +0000[diff] [blame]487<!--=========================================================================-->
488<div class="doc_subsection">
Chris Lattner47202c32009-03-02 02:37:32 +0000[diff] [blame]489<a name="coreimprovements">LLVM IR and Core Improvements</a>
Chris Lattnerc3649452008-02-10 08:17:19 +0000[diff] [blame]490</div>
491
492<div class="doc_text">
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]493<p>LLVM IR has several new features for better support of new targets and that
494expose new optimization opportunities:</p>
Chris Lattnerc3649452008-02-10 08:17:19 +0000[diff] [blame]495
Chris Lattnerc5a4e312008-06-05 06:25:56 +0000[diff] [blame]496<ul>
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000[diff] [blame]497<li>...</li>
Chris Lattnerc3649452008-02-10 08:17:19 +0000[diff] [blame]498</ul>
Mikhail Glushenkov808cd3e2008-10-13 02:08:34 +0000[diff] [blame]499
Chris Lattnerc3649452008-02-10 08:17:19 +0000[diff] [blame]500</div>
501
502<!--=========================================================================-->
503<div class="doc_subsection">
Chris Lattner8fda4952008-02-10 07:46:44 +0000[diff] [blame]504<a name="optimizer">Optimizer Improvements</a>
505</div>
506
507<div class="doc_text">
508
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]509<p>In addition to a large array of minor performance tweaks and bug fixes, this
Chris Lattnerea9c2242008-10-13 21:50:36 +0000[diff] [blame]510release includes a few major enhancements and additions to the optimizers:</p>
Chris Lattner8fda4952008-02-10 07:46:44 +0000[diff] [blame]511
512<ul>
513
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000[diff] [blame]514<li>...</li>
Chris Lattner47202c32009-03-02 02:37:32 +0000[diff] [blame]515
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]516</ul>
Chris Lattner47202c32009-03-02 02:37:32 +0000[diff] [blame]517
Chris Lattner317685c2010-03-01 19:29:17 +0000[diff] [blame]518<p>Also, -anders-aa was removed</p>
519
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]520</div>
Chris Lattner47202c32009-03-02 02:37:32 +0000[diff] [blame]521
Chris Lattner47202c32009-03-02 02:37:32 +0000[diff] [blame]522
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]523<!--=========================================================================-->
524<div class="doc_subsection">
525<a name="executionengine">Interpreter and JIT Improvements</a>
526</div>
Chris Lattnerea9c2242008-10-13 21:50:36 +0000[diff] [blame]527
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]528<div class="doc_text">
529
530<ul>
Jeffrey Yasskin40715142010-01-29 19:10:38 +0000[diff] [blame]531<li>The JIT now <a
532href="http://llvm.org/viewvc/llvm-project?view=rev&revision=85295">defaults
533to compiling eagerly</a> to avoid a race condition in the lazy JIT.
534Clients that still want the lazy JIT can switch it on by calling
535<tt>ExecutionEngine::DisableLazyCompilation(false)</tt>.</li>
Jeffrey Yasskinc0577082010-02-11 01:07:39 +0000[diff] [blame]536<li>It is now possible to create more than one JIT instance in the same process.
537These JITs can generate machine code in parallel,
538although <a href="http://llvm.org/docs/ProgrammersManual.html#jitthreading">you
539still have to obey the other threading restrictions</a>.</li>
Chris Lattner0eef6e42008-06-08 02:45:07 +0000[diff] [blame]540</ul>
541
542</div>
543
544<!--=========================================================================-->
545<div class="doc_subsection">
Chris Lattner5f393542009-03-02 03:24:11 +0000[diff] [blame]546<a name="codegen">Target Independent Code Generator Improvements</a>
Chris Lattner0eef6e42008-06-08 02:45:07 +0000[diff] [blame]547</div>
548
549<div class="doc_text">
550
Mikhail Glushenkovf61066a2009-03-01 18:09:47 +0000[diff] [blame]551<p>We have put a significant amount of work into the code generator
552infrastructure, which allows us to implement more aggressive algorithms and make
553it run faster:</p>
Chris Lattner0eef6e42008-06-08 02:45:07 +0000[diff] [blame]554
555<ul>
Chris Lattner5f393542009-03-02 03:24:11 +0000[diff] [blame]556
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000[diff] [blame]557<li>...</li>
Chris Lattnerb0d6c502007-09-21 03:54:09 +0000[diff] [blame]558</ul>
Chris Lattnerb0d6c502007-09-21 03:54:09 +0000[diff] [blame]559</div>
560
Chris Lattner47202c32009-03-02 02:37:32 +0000[diff] [blame]561<!--=========================================================================-->
562<div class="doc_subsection">
563<a name="x86">X86-32 and X86-64 Target Improvements</a>
564</div>
565
566<div class="doc_text">
567<p>New features of the X86 target include:
568</p>
569
570<ul>
Chris Lattner5f393542009-03-02 03:24:11 +0000[diff] [blame]571
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000[diff] [blame]572<li>...</li>
Chris Lattner5f393542009-03-02 03:24:11 +0000[diff] [blame]573
Chris Lattner47202c32009-03-02 02:37:32 +0000[diff] [blame]574</ul>
575
Chris Lattner47202c32009-03-02 02:37:32 +0000[diff] [blame]576</div>
Chris Lattnerb0d6c502007-09-21 03:54:09 +0000[diff] [blame]577
578<!--=========================================================================-->
579<div class="doc_subsection">
Chris Lattnere1fbd752009-02-26 07:32:11 +0000[diff] [blame]580<a name="pic16">PIC16 Target Improvements</a>
581</div>
582
583<div class="doc_text">
584<p>New features of the PIC16 target include:
585</p>
586
587<ul>
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000[diff] [blame]588<li>...</li>
Chris Lattnere1fbd752009-02-26 07:32:11 +0000[diff] [blame]589</ul>
590
591<p>Things not yet supported:</p>
592
593<ul>
Chris Lattnere1fbd752009-02-26 07:32:11 +0000[diff] [blame]594<li>Variable arguments.</li>
Chris Lattner5f393542009-03-02 03:24:11 +0000[diff] [blame]595<li>Interrupts/programs.</li>
Chris Lattnere1fbd752009-02-26 07:32:11 +0000[diff] [blame]596</ul>
597
598</div>
599
Chris Lattnere1fbd752009-02-26 07:32:11 +0000[diff] [blame]600<!--=========================================================================-->
601<div class="doc_subsection">
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]602<a name="ARM">ARM Target Improvements</a>
Chris Lattner7ccc40d2009-03-01 02:30:21 +0000[diff] [blame]603</div>
604
605<div class="doc_text">
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]606<p>New features of the ARM target include:
607</p>
Chris Lattner7ccc40d2009-03-01 02:30:21 +0000[diff] [blame]608
609<ul>
Chris Lattner7ccc40d2009-03-01 02:30:21 +0000[diff] [blame]610
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000[diff] [blame]611<li>...</li>
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]612</ul>
Chris Lattner7ccc40d2009-03-01 02:30:21 +0000[diff] [blame]613
Chris Lattner7ccc40d2009-03-01 02:30:21 +0000[diff] [blame]614
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]615</div>
Chris Lattner7ccc40d2009-03-01 02:30:21 +0000[diff] [blame]616
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]617<!--=========================================================================-->
618<div class="doc_subsection">
619<a name="OtherTarget">Other Target Specific Improvements</a>
620</div>
Chris Lattner7ccc40d2009-03-01 02:30:21 +0000[diff] [blame]621
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]622<div class="doc_text">
623<p>New features of other targets include:
624</p>
625
626<ul>
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000[diff] [blame]627<li>...</li>
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]628</ul>
629
630</div>
631
632<!--=========================================================================-->
633<div class="doc_subsection">
634<a name="newapis">New Useful APIs</a>
635</div>
636
637<div class="doc_text">
638
639<p>This release includes a number of new APIs that are used internally, which
640 may also be useful for external clients.
641</p>
642
643<ul>
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000[diff] [blame]644<li>...</li>
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]645</ul>
646
647
648</div>
649
650<!--=========================================================================-->
651<div class="doc_subsection">
652<a name="otherimprovements">Other Improvements and New Features</a>
653</div>
654
655<div class="doc_text">
656<p>Other miscellaneous features include:</p>
657
658<ul>
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000[diff] [blame]659<li>...</li>
Chris Lattner7ccc40d2009-03-01 02:30:21 +0000[diff] [blame]660</ul>
661
662</div>
663
Chris Lattnere45f18b2008-06-05 08:02:49 +0000[diff] [blame]664
665<!--=========================================================================-->
666<div class="doc_subsection">
Chris Lattner92eacf82008-10-13 17:57:36 +0000[diff] [blame]667<a name="changes">Major Changes and Removed Features</a>
668</div>
669
670<div class="doc_text">
671
Chris Lattnercc64a322008-10-13 22:06:31 +0000[diff] [blame]672<p>If you're already an LLVM user or developer with out-of-tree changes based
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000[diff] [blame]673on LLVM 2.6, this section lists some "gotchas" that you may run into upgrading
Chris Lattnercc64a322008-10-13 22:06:31 +0000[diff] [blame]674from the previous release.</p>
Chris Lattner92eacf82008-10-13 17:57:36 +0000[diff] [blame]675
676<ul>
Jeffrey Yasskin260af332010-02-09 23:03:44 +0000[diff] [blame]677<li>The LLVM interpreter now defaults to <em>not</em> using <tt>libffi</tt> even
678if you have it installed. This makes it more likely that an LLVM built on one
679system will work when copied to a similar system. To use <tt>libffi</tt>,
680configure with <tt>--enable-libffi</tt>.
681</li>
Chris Lattnercc64a322008-10-13 22:06:31 +0000[diff] [blame]682</ul>
683
684
685<p>In addition, many APIs have changed in this release. Some of the major LLVM
686API changes are:</p>
687
688<ul>
Jeffrey Yasskin2ca16212010-01-28 01:41:20 +0000[diff] [blame]689<li><tt>ModuleProvider</tt> has been <a
690href="http://llvm.org/viewvc/llvm-project?view=rev&revision=94686">removed</a>
691and its methods moved to <tt>Module</tt> and <tt>GlobalValue</tt>.
692Most clients can remove uses of <tt>ExistingModuleProvider</tt>,
693replace <tt>getBitcodeModuleProvider</tt> with
694<tt>getLazyBitcodeModule</tt>, and pass their <tt>Module</tt> to
695functions that used to accept <tt>ModuleProvider</tt>. Clients who
696wrote their own <tt>ModuleProvider</tt>s will need to derive from
697<tt>GVMaterializer</tt> instead and use
698<tt>Module::setMaterializer</tt> to attach it to a
699<tt>Module</tt>.</li>
700
701<li><tt>GhostLinkage</tt> has given up the ghost.
702<tt>GlobalValue</tt>s that have not yet been read from their backing
703storage have the same linkage they will have after being read in.
704Clients must replace calls to
705<tt>GlobalValue::hasNotBeenReadFromBitcode</tt> with
706<tt>GlobalValue::isMaterializable</tt>.</li>
Daniel Dunbar61f41422010-02-10 04:09:52 +0000[diff] [blame]707
708<li>FIXME: Debug info has been totally redone. Add pointers to new APIs. Substantial caveats about compatibility of .ll and .bc files.</li>
709
Daniel Dunbar369889a2010-02-14 01:47:19 +0000[diff] [blame]710<li>The <tt>llvm/Support/DataTypes.h</tt> header has moved
711to <tt>llvm/System/DataTypes.h</tt>.</li>
712
Duncan Sandsdd29fc82010-02-17 17:20:17 +0000[diff] [blame]713<li>The <tt>isInteger</tt>, <tt>isIntOrIntVector</tt>, <tt>isFloatingPoint</tt>,
714<tt>isFPOrFPVector</tt> and <tt>isFPOrFPVector</tt> methods have been renamed
715<tt>isIntegerTy</tt>, <tt>isIntOrIntVectorTy</tt>, <tt>isFloatingPointTy</tt>,
716<tt>isFPOrFPVectorTy</tt> and <tt>isFPOrFPVectorTy</tt> respectively.</li>
Devang Patel0e3da1a2008-10-14 20:03:43 +0000[diff] [blame]717</ul>
Chris Lattner92eacf82008-10-13 17:57:36 +0000[diff] [blame]718
Chris Lattner92eacf82008-10-13 17:57:36 +0000[diff] [blame]719</div>
720
721
722
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]723<!-- *********************************************************************** -->
724<div class="doc_section">
725 <a name="portability">Portability and Supported Platforms</a>
726</div>
727<!-- *********************************************************************** -->
728
729<div class="doc_text">
730
731<p>LLVM is known to work on the following platforms:</p>
732
733<ul>
Mikhail Glushenkovf61066a2009-03-01 18:09:47 +0000[diff] [blame]734<li>Intel and AMD machines (IA32, X86-64, AMD64, EMT-64) running Red Hat
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]735 Linux, Fedora Core, FreeBSD and AuroraUX (and probably other unix-like
736 systems).</li>
Mikhail Glushenkovf61066a2009-03-01 18:09:47 +0000[diff] [blame]737<li>PowerPC and X86-based Mac OS X systems, running 10.3 and above in 32-bit
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]738 and 64-bit modes.</li>
Chris Lattnere0798082008-02-06 18:00:06 +0000[diff] [blame]739<li>Intel and AMD machines running on Win32 using MinGW libraries (native).</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]740<li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
741 support is available for native builds with Visual C++).</li>
Chris Lattner9235ce52009-10-16 16:30:58 +0000[diff] [blame]742<li>Sun x86 and AMD64 machines running Solaris 10, OpenSolaris 0906.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]743<li>Alpha-based machines running Debian GNU/Linux.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]744</ul>
745
Chris Lattnerba948522008-06-05 06:57:39 +0000[diff] [blame]746<p>The core LLVM infrastructure uses GNU autoconf to adapt itself
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]747to the machine and operating system on which it is built. However, minor
748porting may be required to get LLVM to work on new platforms. We welcome your
749portability patches and reports of successful builds or error messages.</p>
750
751</div>
752
753<!-- *********************************************************************** -->
754<div class="doc_section">
755 <a name="knownproblems">Known Problems</a>
756</div>
757<!-- *********************************************************************** -->
758
759<div class="doc_text">
760
Mikhail Glushenkovf61066a2009-03-01 18:09:47 +0000[diff] [blame]761<p>This section contains significant known problems with the LLVM system,
Chris Lattnerb1ad47c2008-11-10 05:40:34 +0000[diff] [blame]762listed by component. If you run into a problem, please check the <a
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]763href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
764there isn't already one.</p>
765
Chris Lattner1f8dc512010-03-17 17:25:49 +0000[diff] [blame]766<ul>
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]767<li>LLVM will not correctly compile on Solaris and/or OpenSolaris
768using the stock GCC 3.x.x series 'out the box',
Chris Lattnerc09ffd22009-11-03 21:50:09 +0000[diff] [blame]769See: <a href="GettingStarted.html#brokengcc">Broken versions of GCC and other tools</a>.
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]770However, A <a href="http://pkg.auroraux.org/GCC">Modern GCC Build</a>
771for x86/x86-64 has been made available from the third party AuroraUX Project
772that has been meticulously tested for bootstrapping LLVM &amp; Clang.</li>
773</ul>
774
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]775</div>
776
777<!-- ======================================================================= -->
778<div class="doc_subsection">
779 <a name="experimental">Experimental features included with this release</a>
780</div>
781
782<div class="doc_text">
783
784<p>The following components of this LLVM release are either untested, known to
785be broken or unreliable, or are in early development. These components should
786not be relied on, and bugs should not be filed against them, but they may be
787useful to some people. In particular, if you would like to work on one of these
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000[diff] [blame]788components, please contact us on the <a
789href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]790
791<ul>
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]792<li>The MSIL, Alpha, SPU, MIPS, PIC16, Blackfin, MSP430 and SystemZ backends are
793 experimental.</li>
Bill Wendling9c7c4382009-03-02 07:54:14 +0000[diff] [blame]794<li>The <tt>llc</tt> "<tt>-filetype=asm</tt>" (the default) is the only
Chris Lattner58b1d0f2010-03-17 04:41:49 +0000[diff] [blame]795 supported value for this option. The MachO writer is experimental, and
796 works much better in mainline SVN.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]797</ul>
798
799</div>
800
801<!-- ======================================================================= -->
802<div class="doc_subsection">
803 <a name="x86-be">Known problems with the X86 back-end</a>
804</div>
805
806<div class="doc_text">
807
808<ul>
Anton Korobeynikov77d15e22008-06-08 10:24:13 +0000[diff] [blame]809 <li>The X86 backend does not yet support
810 all <a href="http://llvm.org/PR879">inline assembly that uses the X86
811 floating point stack</a>. It supports the 'f' and 't' constraints, but not
812 'u'.</li>
Chris Lattnerd95b5962008-06-08 21:19:07 +0000[diff] [blame]813 <li>The X86 backend generates inefficient floating point code when configured
814 to generate code for systems that don't have SSE2.</li>
Duncan Sands8b4f3772008-06-08 19:38:43 +0000[diff] [blame]815 <li>Win64 code generation wasn't widely tested. Everything should work, but we
John Criswellaea8c752009-03-02 15:28:15 +0000[diff] [blame]816 expect small issues to happen. Also, llvm-gcc cannot build the mingw64
817 runtime currently due
Anton Korobeynikov77d15e22008-06-08 10:24:13 +0000[diff] [blame]818 to <a href="http://llvm.org/PR2255">several</a>
John Criswellaea8c752009-03-02 15:28:15 +0000[diff] [blame]819 <a href="http://llvm.org/PR2257">bugs</a> and due to lack of support for
820 the
821 'u' inline assembly constraint and for X87 floating point inline assembly.</li>
Dan Gohman3882ecb2008-06-08 23:05:11 +0000[diff] [blame]822 <li>The X86-64 backend does not yet support the LLVM IR instruction
Chris Lattner47202c32009-03-02 02:37:32 +0000[diff] [blame]823 <tt>va_arg</tt>. Currently, the llvm-gcc and front-ends support variadic
Dan Gohman3882ecb2008-06-08 23:05:11 +0000[diff] [blame]824 argument constructs on X86-64 by lowering them manually.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]825</ul>
826
827</div>
828
829<!-- ======================================================================= -->
830<div class="doc_subsection">
831 <a name="ppc-be">Known problems with the PowerPC back-end</a>
832</div>
833
834<div class="doc_text">
835
836<ul>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]837<li>The Linux PPC32/ABI support needs testing for the interpreter and static
838compilation, and lacks support for debug information.</li>
839</ul>
840
841</div>
842
843<!-- ======================================================================= -->
844<div class="doc_subsection">
845 <a name="arm-be">Known problems with the ARM back-end</a>
846</div>
847
848<div class="doc_text">
849
850<ul>
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]851<li>Support for the Advanced SIMD (Neon) instruction set is still incomplete
852and not well tested. Some features may not work at all, and the code quality
853may be poor in some cases.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]854<li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
Duncan Sands1827fa62007-09-26 15:59:54 +0000[diff] [blame]855processors, thumb programs can crash or produce wrong
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]856results (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
John Criswellaea8c752009-03-02 15:28:15 +0000[diff] [blame]857<li>Compilation for ARM Linux OABI (old ABI) is supported but not fully tested.
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]858</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]859</ul>
860
861</div>
862
863<!-- ======================================================================= -->
864<div class="doc_subsection">
865 <a name="sparc-be">Known problems with the SPARC back-end</a>
866</div>
867
868<div class="doc_text">
869
870<ul>
John Criswellaea8c752009-03-02 15:28:15 +0000[diff] [blame]871<li>The SPARC backend only supports the 32-bit SPARC ABI (-m32); it does not
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]872 support the 64-bit SPARC ABI (-m64).</li>
873</ul>
874
875</div>
876
877<!-- ======================================================================= -->
878<div class="doc_subsection">
Bruno Cardoso Lopes62d45d72008-10-25 14:56:26 +0000[diff] [blame]879 <a name="mips-be">Known problems with the MIPS back-end</a>
880</div>
881
882<div class="doc_text">
883
884<ul>
Bruno Cardoso Lopes62d45d72008-10-25 14:56:26 +0000[diff] [blame]885<li>64-bit MIPS targets are not supported yet.</li>
886</ul>
887
888</div>
889
890<!-- ======================================================================= -->
891<div class="doc_subsection">
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]892 <a name="alpha-be">Known problems with the Alpha back-end</a>
893</div>
894
895<div class="doc_text">
896
897<ul>
898
899<li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
900appropriate nops inserted to ensure restartability.</li>
901
902</ul>
903</div>
904
905<!-- ======================================================================= -->
906<div class="doc_subsection">
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]907 <a name="c-be">Known problems with the C back-end</a>
908</div>
909
910<div class="doc_text">
911
912<ul>
Chris Lattner499c07c2008-06-05 06:35:40 +0000[diff] [blame]913<li><a href="http://llvm.org/PR802">The C backend has only basic support for
914 inline assembly code</a>.</li>
Chris Lattnere0194462007-09-26 06:01:35 +0000[diff] [blame]915<li><a href="http://llvm.org/PR1658">The C backend violates the ABI of common
916 C++ programs</a>, preventing intermixing between C++ compiled by the CBE and
Gabor Greife33c5322009-03-02 12:02:51 +0000[diff] [blame]917 C++ code compiled with <tt>llc</tt> or native compilers.</li>
Duncan Sandsbd0ad6e2008-02-10 13:40:55 +0000[diff] [blame]918<li>The C backend does not support all exception handling constructs.</li>
Duncan Sandse6e264c2009-02-25 11:51:54 +0000[diff] [blame]919<li>The C backend does not support arbitrary precision integers.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]920</ul>
921
922</div>
923
924
925<!-- ======================================================================= -->
926<div class="doc_subsection">
Chris Lattner58b1d0f2010-03-17 04:41:49 +0000[diff] [blame]927 <a name="c-fe">Known problems with the llvm-gcc C and C++ front-end</a>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]928</div>
929
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]930<div class="doc_text">
931
Chris Lattner499c07c2008-06-05 06:35:40 +0000[diff] [blame]932<p>The only major language feature of GCC not supported by llvm-gcc is
933 the <tt>__builtin_apply</tt> family of builtins. However, some extensions
934 are only supported on some targets. For example, trampolines are only
Duncan Sandsa73561c2008-06-08 20:18:35 +0000[diff] [blame]935 supported on some targets (these are used when you take the address of a
936 nested function).</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]937
Chris Lattner499c07c2008-06-05 06:35:40 +0000[diff] [blame]938<p>If you run into GCC extensions which are not supported, please let us know.
939</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]940
941</div>
942
943<!-- ======================================================================= -->
944<div class="doc_subsection">
Chris Lattner6c8a1b82008-10-30 03:58:13 +0000[diff] [blame]945 <a name="fortran-fe">Known problems with the llvm-gcc Fortran front-end</a>
946</div>
947
948<div class="doc_text">
Gabor Greif1fc8fbc2008-11-04 21:50:59 +0000[diff] [blame]949<ul>
Chris Lattner6c8a1b82008-10-30 03:58:13 +0000[diff] [blame]950<li>Fortran support generally works, but there are still several unresolved bugs
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]951 in <a href="http://llvm.org/bugs/">Bugzilla</a>. Please see the
952 tools/gfortran component for details.</li>
Gabor Greif1fc8fbc2008-11-04 21:50:59 +0000[diff] [blame]953</ul>
Chris Lattner6c8a1b82008-10-30 03:58:13 +0000[diff] [blame]954</div>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]955
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000[diff] [blame]956<!-- ======================================================================= -->
957<div class="doc_subsection">
Chris Lattner499c07c2008-06-05 06:35:40 +0000[diff] [blame]958 <a name="ada-fe">Known problems with the llvm-gcc Ada front-end</a>
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000[diff] [blame]959</div>
960
961<div class="doc_text">
John Criswellaea8c752009-03-02 15:28:15 +0000[diff] [blame]962The llvm-gcc 4.2 Ada compiler works fairly well; however, this is not a mature
963technology, and problems should be expected.
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000[diff] [blame]964<ul>
Duncan Sandsa73561c2008-06-08 20:18:35 +0000[diff] [blame]965<li>The Ada front-end currently only builds on X86-32. This is mainly due
John Criswellaea8c752009-03-02 15:28:15 +0000[diff] [blame]966to lack of trampoline support (pointers to nested functions) on other platforms.
967However, it <a href="http://llvm.org/PR2006">also fails to build on X86-64</a>
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000[diff] [blame]968which does support trampolines.</li>
969<li>The Ada front-end <a href="http://llvm.org/PR2007">fails to bootstrap</a>.
Duncan Sandsf73473e2009-02-25 11:59:06 +0000[diff] [blame]970This is due to lack of LLVM support for <tt>setjmp</tt>/<tt>longjmp</tt> style
971exception handling, which is used internally by the compiler.
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]972Workaround: configure with <tt>--disable-bootstrap</tt>.</li>
Duncan Sands2dbc2e82008-10-13 17:27:23 +0000[diff] [blame]973<li>The c380004, <a href="http://llvm.org/PR2010">c393010</a>
974and <a href="http://llvm.org/PR2421">cxg2021</a> ACATS tests fail
Duncan Sandsf73473e2009-02-25 11:59:06 +0000[diff] [blame]975(c380004 also fails with gcc-4.2 mainline).
976If the compiler is built with checks disabled then <a href="http://llvm.org/PR2010">c393010</a>
977causes the compiler to go into an infinite loop, using up all system memory.</li>
Duncan Sandsc2a29a02009-03-02 16:35:57 +0000[diff] [blame]978<li>Some GCC specific Ada tests continue to crash the compiler.</li>
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]979<li>The <tt>-E</tt> binder option (exception backtraces)
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000[diff] [blame]980<a href="http://llvm.org/PR1982">does not work</a> and will result in programs
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]981crashing if an exception is raised. Workaround: do not use <tt>-E</tt>.</li>
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000[diff] [blame]982<li>Only discrete types <a href="http://llvm.org/PR1981">are allowed to start
983or finish at a non-byte offset</a> in a record. Workaround: do not pack records
984or use representation clauses that result in a field of a non-discrete type
985starting or finishing in the middle of a byte.</li>
Chris Lattnerd95b5962008-06-08 21:19:07 +0000[diff] [blame]986<li>The <tt>lli</tt> interpreter <a href="http://llvm.org/PR2009">considers
987'main' as generated by the Ada binder to be invalid</a>.
988Workaround: hand edit the file to use pointers for <tt>argv</tt> and
989<tt>envp</tt> rather than integers.</li>
990<li>The <tt>-fstack-check</tt> option <a href="http://llvm.org/PR2008">is
991ignored</a>.</li>
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000[diff] [blame]992</ul>
993</div>
994
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000[diff] [blame]995<!-- ======================================================================= -->
996<div class="doc_subsection">
997 <a name="ocaml-bindings">Known problems with the O'Caml bindings</a>
998</div>
999
1000<div class="doc_text">
1001
1002<p>The <tt>Llvm.Linkage</tt> module is broken, and has incorrect values. Only
1003<tt>Llvm.Linkage.External</tt>, <tt>Llvm.Linkage.Available_externally</tt>, and
1004<tt>Llvm.Linkage.Link_once</tt> will be correct. If you need any of the other linkage
1005modes, you'll have to write an external C library in order to expose the
1006functionality. This has been fixed in the trunk.</p>
1007</div>
1008
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]1009<!-- *********************************************************************** -->
1010<div class="doc_section">
1011 <a name="additionalinfo">Additional Information</a>
1012</div>
1013<!-- *********************************************************************** -->
1014
1015<div class="doc_text">
1016
1017<p>A wide variety of additional information is available on the <a
1018href="http://llvm.org">LLVM web page</a>, in particular in the <a
1019href="http://llvm.org/docs/">documentation</a> section. The web page also
1020contains versions of the API documentation which is up-to-date with the
1021Subversion version of the source code.
1022You can access versions of these documents specific to this release by going
1023into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
1024
1025<p>If you have any questions or comments about LLVM, please feel free to contact
1026us via the <a href="http://llvm.org/docs/#maillist"> mailing
1027lists</a>.</p>
1028
1029</div>
1030
1031<!-- *********************************************************************** -->
1032
1033<hr>
1034<address>
1035 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman947321d2008-12-11 17:34:48 +0000[diff] [blame]1036 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]1037 <a href="http://validator.w3.org/check/referer"><img
Misha Brukman947321d2008-12-11 17:34:48 +0000[diff] [blame]1038 src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]1039
1040 <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
1041 Last modified: $Date$
1042</address>
1043
1044</body>
1045</html>