Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / llvm / dc910080fadd6429c02fdb460ee30cba3f3979ef / . / docs / ReleaseNotes.html
blob: 7f6ad47f8f4d4e90c6445e865252242c3390c5fc [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">
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000[diff] [blame]7 <title>LLVM 2.7 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
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000[diff] [blame]11<div class="doc_title">LLVM 2.7 Release Notes</div>
Mikhail Glushenkovea65d7d2008-10-13 02:08:34 +0000[diff] [blame]12
Chris Lattner0e464a92010-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
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]16<ol>
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]17 <li><a href="#intro">Introduction</a></li>
Chris Lattner96a445e2008-10-13 18:01:01 +0000[diff] [blame]18 <li><a href="#subproj">Sub-project Status Update</a></li>
Jeffrey Yasskinbec48772010-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>
Chris Lattner4b538b92004-04-30 22:17:12 +0000[diff] [blame]21 <li><a href="GettingStarted.html">Installation Instructions</a></li>
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]22 <li><a href="#portability">Portability and Supported Platforms</a></li>
Dan Gohman44aa9212008-10-14 16:23:02 +0000[diff] [blame]23 <li><a href="#knownproblems">Known Problems</a></li>
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]24 <li><a href="#additionalinfo">Additional Information</a></li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]25</ol>
26
Chris Lattner7911ce22004-05-23 21:07:27 +0000[diff] [blame]27<div class="doc_author">
Dan Gohman44aa9212008-10-14 16:23:02 +0000[diff] [blame]28 <p>Written by the <a href="http://llvm.org">LLVM Team</a></p>
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]29</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]30
Jeffrey Yasskinbec48772010-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
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]37<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]38<div class="doc_section">
39 <a name="intro">Introduction</a>
40</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]41<!-- *********************************************************************** -->
42
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]43<div class="doc_text">
44
Chris Lattnerf6662f92008-10-13 17:57:36 +0000[diff] [blame]45<p>This document contains the release notes for the LLVM Compiler
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000[diff] [blame]46Infrastructure, release 2.7. Here we describe the status of LLVM, including
Chris Lattnerf6662f92008-10-13 17:57:36 +0000[diff] [blame]47major improvements from the previous release and significant known problems.
Mikhail Glushenkovf795ef02009-03-01 18:09:47 +0000[diff] [blame]48All LLVM releases may be downloaded from the <a
Chris Lattnerf6662f92008-10-13 17:57:36 +0000[diff] [blame]49href="http://llvm.org/releases/">LLVM releases web site</a>.</p>
Chris Lattner19092612003-10-02 16:38:05 +0000[diff] [blame]50
Chris Lattner7506b1d2004-12-07 08:04:13 +0000[diff] [blame]51<p>For more information about LLVM, including information about the latest
Chris Lattnerc463b272005-10-29 07:07:09 +0000[diff] [blame]52release, please check out the <a href="http://llvm.org/">main LLVM
Chris Lattner47ad72c2003-10-07 21:38:31 +0000[diff] [blame]53web site</a>. If you have questions or comments, the <a
Chris Lattnerc66bfef2010-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>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]56
Mikhail Glushenkovea65d7d2008-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 Lattner84977642007-09-21 03:54:09 +0000[diff] [blame]58main LLVM web page, this document applies to the <i>next</i> release, not the
Gabor Greiffa933f82008-10-14 11:00:32 +0000[diff] [blame]59current one. To see the release notes for a specific release, please see the
Chris Lattner84977642007-09-21 03:54:09 +0000[diff] [blame]60<a href="http://llvm.org/releases/">releases page</a>.</p>
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]61
Chris Lattnerc66bfef2010-03-17 04:41:49 +0000[diff] [blame]62
Chris Lattnerdc910082010-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 Lattnerc66bfef2010-03-17 04:41:49 +0000[diff] [blame]65
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]66</div>
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]67
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]68
Chris Lattner61358ab2009-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 Lattner76ef2982010-01-09 22:30:40 +0000[diff] [blame]74 ABCD, SCCVN, GEPSplitterPass
Chris Lattner048fe3c2010-01-16 21:25:13 +0000[diff] [blame]75 MSIL backend?
Chris Lattnerdc910082010-03-17 06:41:58 +0000[diff] [blame^]76 lib/Transforms/Utils/SSI.cpp -> ABCD depends on it.
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]77-->
78
79
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000[diff] [blame]80<!-- Features that need text if they're finished for 2.7:
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]81 gcc plugin.
82 strong phi elim
83 variable debug info for optimized code
Chris Lattnerab68e9e2009-02-26 22:33:38 +0000[diff] [blame]84 postalloc scheduler: anti dependence breaking, hazard recognizer?
Chris Lattner61358ab2009-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 Lattneracce85d2008-02-10 07:46:44 +0000[diff] [blame]89 -->
Mikhail Glushenkovea65d7d2008-10-13 02:08:34 +0000[diff] [blame]90
Chris Lattner547a3912008-10-12 19:47:48 +0000[diff] [blame]91 <!-- for announcement email:
Chris Lattner61358ab2009-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 Lattnerdc910082010-03-17 06:41:58 +0000[diff] [blame^]97 Mention gcc plugin.
Chris Lattner74c80df2009-02-25 06:34:50 +0000[diff] [blame]98 -->
Chris Lattneracce85d2008-02-10 07:46:44 +0000[diff] [blame]99
Chris Lattner96a445e2008-10-13 18:01:01 +0000[diff] [blame]100<!-- *********************************************************************** -->
101<div class="doc_section">
102 <a name="subproj">Sub-project Status Update</a>
Chris Lattnerea34f642008-06-08 21:34:41 +0000[diff] [blame]103</div>
Chris Lattner96a445e2008-10-13 18:01:01 +0000[diff] [blame]104<!-- *********************************************************************** -->
Chris Lattnerea34f642008-06-08 21:34:41 +0000[diff] [blame]105
106<div class="doc_text">
Chris Lattner8348b472008-06-08 21:58:17 +0000[diff] [blame]107<p>
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000[diff] [blame]108The LLVM 2.7 distribution currently consists of code from the core LLVM
Chris Lattner61358ab2009-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 Wendling63d8c552009-03-02 04:28:57 +0000[diff] [blame]113</p>
Chris Lattner96a445e2008-10-13 18:01:01 +0000[diff] [blame]114
Chris Lattner8348b472008-06-08 21:58:17 +0000[diff] [blame]115</div>
116
Chris Lattner96a445e2008-10-13 18:01:01 +0000[diff] [blame]117
Chris Lattner8348b472008-06-08 21:58:17 +0000[diff] [blame]118<!--=========================================================================-->
Chris Lattner96a445e2008-10-13 18:01:01 +0000[diff] [blame]119<div class="doc_subsection">
Chris Lattnerfb97b2d2008-10-13 18:11:54 +0000[diff] [blame]120<a name="clang">Clang: C/C++/Objective-C Frontend Toolkit</a>
Chris Lattner8348b472008-06-08 21:58:17 +0000[diff] [blame]121</div>
122
123<div class="doc_text">
124
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000[diff] [blame]125<p>The <a href="http://clang.llvm.org/">Clang project</a> is ...</p>
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]126
Jeffrey Yasskinbec48772010-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 Wendling741748a2008-10-27 09:27:33 +0000[diff] [blame]128
Daniel Dunbar13739432008-10-14 23:25:09 +0000[diff] [blame]129<ul>
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000[diff] [blame]130<li>...</li>
Chris Lattnerdc910082010-03-17 06:41:58 +0000[diff] [blame^]131include a link to cxx_compatibility.html
Bill Wendling6bc15282009-03-02 04:28:18 +0000[diff] [blame]132</ul>
Chris Lattnerfb97b2d2008-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 Yasskinbec48772010-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 Kremenek8b3894c2009-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 Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]145in C and Objective-C programs. The tool performs checks to find
Ted Kremenek8b3894c2009-02-27 07:01:32 +0000[diff] [blame]146bugs that occur on a specific path within a program.</p>
Chris Lattnercc042612008-10-14 00:52:49 +0000[diff] [blame]147
Chris Lattner0e464a92010-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 Lattner8348b472008-06-08 21:58:17 +0000[diff] [blame]149
150</div>
151
Chris Lattner96a445e2008-10-13 18:01:01 +0000[diff] [blame]152<!--=========================================================================-->
153<div class="doc_subsection">
Nicolas Geoffray99a4d302008-10-14 19:23:04 +0000[diff] [blame]154<a name="vmkit">VMKit: JVM/CLI Virtual Machine Implementation</a>
Chris Lattner96a445e2008-10-13 18:01:01 +0000[diff] [blame]155</div>
156
157<div class="doc_text">
158<p>
Nicolas Geoffray99a4d302008-10-14 19:23:04 +0000[diff] [blame]159The <a href="http://vmkit.llvm.org/">VMKit project</a> is an implementation of
Chris Lattner61358ab2009-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 Lattner96a445e2008-10-13 18:01:01 +0000[diff] [blame]163
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]164<p>
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000[diff] [blame]165VMKit version ?? builds with LLVM 2.7 and you can find it on its
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]166<a href="http://vmkit.llvm.org/releases/">web page</a>. The release includes
Nicolas Geoffray56d313d2008-10-15 20:25:04 +0000[diff] [blame]167bug fixes, cleanup and new features. The major changes are:</p>
Chris Lattner96a445e2008-10-13 18:01:01 +0000[diff] [blame]168
Nicolas Geoffray99a4d302008-10-14 19:23:04 +0000[diff] [blame]169<ul>
170
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000[diff] [blame]171<li>...</li>
Nicolas Geoffray99a4d302008-10-14 19:23:04 +0000[diff] [blame]172
173</ul>
Chris Lattner96a445e2008-10-13 18:01:01 +0000[diff] [blame]174</div>
175
Chris Lattner61358ab2009-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 Sands78a1dcc2009-10-15 08:17:44 +0000[diff] [blame]226<a href="http://dragonegg.llvm.org/">DragonEgg</a> is a shared library (dragonegg.so)
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000[diff] [blame]227that is loaded by gcc at runtime. It ...
Chris Lattner61358ab2009-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 Yasskinbec48772010-01-28 01:14:43 +0000[diff] [blame]240The LLVM Machine Code (MC) Toolkit project is ...
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]241</p>
242
243</div>
244
245
Chris Lattnerab68e9e2009-02-26 22:33:38 +0000[diff] [blame]246<!-- *********************************************************************** -->
247<div class="doc_section">
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000[diff] [blame]248 <a name="externalproj">External Open Source Projects Using LLVM 2.7</a>
Chris Lattnerab68e9e2009-02-26 22:33:38 +0000[diff] [blame]249</div>
250<!-- *********************************************************************** -->
251
Chris Lattner61358ab2009-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 Yasskinbec48772010-01-28 01:14:43 +0000[diff] [blame]256 projects that have already been updated to work with LLVM 2.7.</p>
Chris Lattner61358ab2009-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 Lattner0e464a92010-03-17 04:02:39 +0000[diff] [blame]266Need update.
267<!--
Chris Lattner61358ab2009-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 Lattner0e464a92010-03-17 04:02:39 +0000[diff] [blame]277-->
Chris Lattner61358ab2009-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 Lattner0e464a92010-03-17 04:02:39 +0000[diff] [blame]290Need update.
291<!--
Chris Lattner61358ab2009-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 Lattner0e464a92010-03-17 04:02:39 +0000[diff] [blame]301handling.--> </p>
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]302
303</div>
304
305
Chris Lattnerab68e9e2009-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 Lattner0e464a92010-03-17 04:02:39 +0000[diff] [blame]313Need update.
314<!--
Chris Lattner917cc712009-03-02 02:37:32 +0000[diff] [blame]315<a href="http://pure-lang.googlecode.com/">Pure</a>
316is an algebraic/functional programming language based on term rewriting.
Chris Lattnerab68e9e2009-02-26 22:33:38 +0000[diff] [blame]317Programs are collections of equations which are used to evaluate expressions in
318a symbolic fashion. Pure offers dynamic typing, eager and lazy evaluation,
Mikhail Glushenkovf795ef02009-03-01 18:09:47 +0000[diff] [blame]319lexical closures, a hygienic macro system (also based on term rewriting),
Chris Lattnerab68e9e2009-02-26 22:33:38 +0000[diff] [blame]320built-in list and matrix support (including list and matrix comprehensions) and
321an easy-to-use C interface. The interpreter uses LLVM as a backend to
322 JIT-compile Pure programs to fast native code.</p>
323
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000[diff] [blame]324<p>Pure versions ??? and later have been tested and are known to work with
325LLVM 2.7 (and continue to work with older LLVM releases >= 2.3 as well).
Chris Lattner0e464a92010-03-17 04:02:39 +0000[diff] [blame]326--></p>
Chris Lattnerab68e9e2009-02-26 22:33:38 +0000[diff] [blame]327</div>
328
329
330<!--=========================================================================-->
331<div class="doc_subsection">
332<a name="ldc">LLVM D Compiler</a>
333</div>
334
335<div class="doc_text">
336<p>
Chris Lattner0e464a92010-03-17 04:02:39 +0000[diff] [blame]337Need update.
338<!--
Chris Lattner917cc712009-03-02 02:37:32 +0000[diff] [blame]339<a href="http://www.dsource.org/projects/ldc">LDC</a> is an implementation of
340the D Programming Language using the LLVM optimizer and code generator.
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]341The LDC project works great with the LLVM 2.6 release. General improvements in
John Criswell524a5dd2009-03-02 15:28:15 +0000[diff] [blame]342this
Chris Lattner917cc712009-03-02 02:37:32 +0000[diff] [blame]343cycle have included new inline asm constraint handling, better debug info
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]344support, general bug fixes and better x86-64 support. This has allowed
345some major improvements in LDC, getting it much closer to being as
Chris Lattner0e464a92010-03-17 04:02:39 +0000[diff] [blame]346fully featured as the original DMD compiler from DigitalMars.-->
Chris Lattnerab68e9e2009-02-26 22:33:38 +0000[diff] [blame]347</p>
348</div>
349
Chris Lattnerbc31caf2009-02-28 18:58:01 +0000[diff] [blame]350<!--=========================================================================-->
351<div class="doc_subsection">
352<a name="RoadsendPHP">Roadsend PHP</a>
353</div>
354
355<div class="doc_text">
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]356<p>
Chris Lattner0e464a92010-03-17 04:02:39 +0000[diff] [blame]357Need update.
358<!--
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]359<a href="http://code.roadsend.com/rphp">Roadsend PHP</a> (rphp) is an open
Chris Lattnercade8222009-03-02 19:07:24 +0000[diff] [blame]360source implementation of the PHP programming
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]361language that uses LLVM for its optimizer, JIT and static compiler. This is a
Chris Lattner0e464a92010-03-17 04:02:39 +0000[diff] [blame]362reimplementation of an earlier project that is now based on LLVM.
363--> </p>
Chris Lattnerbc31caf2009-02-28 18:58:01 +0000[diff] [blame]364</div>
Chris Lattnerab68e9e2009-02-26 22:33:38 +0000[diff] [blame]365
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]366<!--=========================================================================-->
367<div class="doc_subsection">
368<a name="UnladenSwallow">Unladen Swallow</a>
369</div>
370
371<div class="doc_text">
372<p>
Chris Lattner0e464a92010-03-17 04:02:39 +0000[diff] [blame]373Need update.
374<!--
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]375<a href="http://code.google.com/p/unladen-swallow/">Unladen Swallow</a> is a
376branch of <a href="http://python.org/">Python</a> intended to be fully
377compatible and significantly faster. It uses LLVM's optimization passes and JIT
Chris Lattner0e464a92010-03-17 04:02:39 +0000[diff] [blame]378compiler.-->
379</p>
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]380</div>
381
382<!--=========================================================================-->
383<div class="doc_subsection">
384<a name="llvm-lua">llvm-lua</a>
385</div>
386
387<div class="doc_text">
388<p>
Chris Lattner0e464a92010-03-17 04:02:39 +0000[diff] [blame]389Need update.
390<!--
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]391<a href="http://code.google.com/p/llvm-lua/">LLVM-Lua</a> uses LLVM to add JIT
392and static compiling support to the Lua VM. Lua bytecode is analyzed to
393remove type checks, then LLVM is used to compile the bytecode down to machine
Chris Lattner0e464a92010-03-17 04:02:39 +0000[diff] [blame]394code.-->
395</p>
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]396</div>
397
398<!--=========================================================================-->
399<div class="doc_subsection">
400<a name="icedtea">IcedTea Java Virtual Machine Implementation</a>
401</div>
402
403<div class="doc_text">
404<p>
Chris Lattner0e464a92010-03-17 04:02:39 +0000[diff] [blame]405Need update.
406<!--
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]407<a href="http://icedtea.classpath.org/wiki/Main_Page">IcedTea</a> provides a
408harness to build OpenJDK using only free software build tools and to provide
409replacements for the not-yet free parts of OpenJDK. One of the extensions that
410IcedTea provides is a new JIT compiler named <a
411href="http://icedtea.classpath.org/wiki/ZeroSharkFaq">Shark</a> which uses LLVM
412to provide native code generation without introducing processor-dependent
Chris Lattner0e464a92010-03-17 04:02:39 +0000[diff] [blame]413code.-->
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]414</p>
415</div>
416
417
Chris Lattner8348b472008-06-08 21:58:17 +0000[diff] [blame]418
419<!-- *********************************************************************** -->
420<div class="doc_section">
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000[diff] [blame]421 <a name="whatsnew">What's New in LLVM 2.7?</a>
Chris Lattner8348b472008-06-08 21:58:17 +0000[diff] [blame]422</div>
423<!-- *********************************************************************** -->
424
Chris Lattnerf8e0b4e2008-06-08 22:59:35 +0000[diff] [blame]425<div class="doc_text">
426
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]427<p>This release includes a huge number of bug fixes, performance tweaks and
Chris Lattnerf6662f92008-10-13 17:57:36 +0000[diff] [blame]428minor improvements. Some of the major improvements and new features are listed
429in this section.
Chris Lattnerf8e0b4e2008-06-08 22:59:35 +0000[diff] [blame]430</p>
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]431
Chris Lattnerf8e0b4e2008-06-08 22:59:35 +0000[diff] [blame]432</div>
433
Chris Lattner8348b472008-06-08 21:58:17 +0000[diff] [blame]434<!--=========================================================================-->
Chris Lattnerea34f642008-06-08 21:34:41 +0000[diff] [blame]435<div class="doc_subsection">
Chris Lattner252b83d2008-02-06 18:00:06 +0000[diff] [blame]436<a name="majorfeatures">Major New Features</a>
437</div>
438
439<div class="doc_text">
440
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000[diff] [blame]441<p>LLVM 2.7 includes several major new capabilities:</p>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000[diff] [blame]442
443<ul>
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000[diff] [blame]444<li>...</li>
Chris Lattner8170c102008-02-10 08:18:42 +0000[diff] [blame]445</ul>
446
Chris Lattnerc66bfef2010-03-17 04:41:49 +0000[diff] [blame]447Extensible metadata solid.
448
449Debug info improvements: using metadata instead of llvm.dbg global variables.
450This brings several enhancements including improved compile times.
451
452New instruction selector.
453GHC Haskell ABI/ calling conv support.
454Pre-Alpha support for unions in IR.
455New InlineHint and StackAlignment function attributes
456Code generator MC'ized except for debug info and EH.
457New SCEV AA pass: -scev-aa
458Inliner reuses arrays allocas when inlining multiple callers to reduce stack usage.
459MC encoding and disassembler apis.
460Optimal Edge Profiling?
461Instcombine is now a library, has its own IRBuilder to simplify itself.
462New llvm/Support/Regex.h API. FileCheck now does regex's
Chris Lattnerdc910082010-03-17 06:41:58 +0000[diff] [blame^]463Many subtle pointer invalidation bugs in Callgraph have been fixed and it now uses asserting value handles.
464MC Disassembler (with blog post), MCInstPrinter. Many X86 backend and AsmPrinter simplifications
465Various tools like llc and opt now read either .ll or .bc files as input.
466Malloc and free instructions got removed.
467compiler-rt support for ARM.
468completely llvm-gcc NEON support.
469Can transcode from GAS to intel syntax with "llvm-mc foo.s -output-asm-variant=1"
470JIT debug information with GDB 7.0
471New CodeGen Level LICM And CSE (did it make 2.7?)
472CMake can now run tests, what other improvements?
473ARM/Thumb register scavenging improvements?
474New SSAUpdater and MachineSSAUpdater classes for unstructured ssa updating,
475 changed jump threading, GVN, etc to use it which simplified them and speed
476 them up.
Chris Lattnerc66bfef2010-03-17 04:41:49 +0000[diff] [blame]477
Chris Lattnerdc910082010-03-17 06:41:58 +0000[diff] [blame^]478CondProp pass removed (functionality merged into jump threading).
Chris Lattnerc66bfef2010-03-17 04:41:49 +0000[diff] [blame]479AndersAA got removed (from 2.7 or mainline?)
Chris Lattnerdc910082010-03-17 06:41:58 +0000[diff] [blame^]480PredSimplify, LoopVR, GVNPRE got removed.
Chris Lattnerc66bfef2010-03-17 04:41:49 +0000[diff] [blame]481LLVM command line tools now overwrite their output, before they would only do this with -f.
482DOUT removed, use DEBUG(errs() instead.
483Much stuff converted to use raw_ostream instead of std::ostream.
484TargetAsmInfo renamed to MCAsmInfo
485llvm/ADT/iterator.h gone.
486
Chris Lattnerdc910082010-03-17 06:41:58 +0000[diff] [blame^]487
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000[diff] [blame]488</div>
489
Chris Lattner84977642007-09-21 03:54:09 +0000[diff] [blame]490<!--=========================================================================-->
491<div class="doc_subsection">
Chris Lattner917cc712009-03-02 02:37:32 +0000[diff] [blame]492<a name="coreimprovements">LLVM IR and Core Improvements</a>
Chris Lattnerf304ffc2008-02-10 08:17:19 +0000[diff] [blame]493</div>
494
495<div class="doc_text">
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]496<p>LLVM IR has several new features for better support of new targets and that
497expose new optimization opportunities:</p>
Chris Lattnerf304ffc2008-02-10 08:17:19 +0000[diff] [blame]498
Chris Lattner791f77b2008-06-05 06:25:56 +0000[diff] [blame]499<ul>
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000[diff] [blame]500<li>...</li>
Chris Lattnerf304ffc2008-02-10 08:17:19 +0000[diff] [blame]501</ul>
Mikhail Glushenkovea65d7d2008-10-13 02:08:34 +0000[diff] [blame]502
Chris Lattnerf304ffc2008-02-10 08:17:19 +0000[diff] [blame]503</div>
504
505<!--=========================================================================-->
506<div class="doc_subsection">
Chris Lattneracce85d2008-02-10 07:46:44 +0000[diff] [blame]507<a name="optimizer">Optimizer Improvements</a>
508</div>
509
510<div class="doc_text">
511
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]512<p>In addition to a large array of minor performance tweaks and bug fixes, this
Chris Lattnerf3013872008-10-13 21:50:36 +0000[diff] [blame]513release includes a few major enhancements and additions to the optimizers:</p>
Chris Lattneracce85d2008-02-10 07:46:44 +0000[diff] [blame]514
515<ul>
516
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000[diff] [blame]517<li>...</li>
Chris Lattner917cc712009-03-02 02:37:32 +0000[diff] [blame]518
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]519</ul>
Chris Lattner917cc712009-03-02 02:37:32 +0000[diff] [blame]520
Chris Lattnerf2201912010-03-01 19:29:17 +0000[diff] [blame]521<p>Also, -anders-aa was removed</p>
522
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]523</div>
Chris Lattner917cc712009-03-02 02:37:32 +0000[diff] [blame]524
Chris Lattner917cc712009-03-02 02:37:32 +0000[diff] [blame]525
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]526<!--=========================================================================-->
527<div class="doc_subsection">
528<a name="executionengine">Interpreter and JIT Improvements</a>
529</div>
Chris Lattnerf3013872008-10-13 21:50:36 +0000[diff] [blame]530
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]531<div class="doc_text">
532
533<ul>
Jeffrey Yasskin01eba392010-01-29 19:10:38 +0000[diff] [blame]534<li>The JIT now <a
535href="http://llvm.org/viewvc/llvm-project?view=rev&revision=85295">defaults
536to compiling eagerly</a> to avoid a race condition in the lazy JIT.
537Clients that still want the lazy JIT can switch it on by calling
538<tt>ExecutionEngine::DisableLazyCompilation(false)</tt>.</li>
Jeffrey Yasskin40966a72010-02-11 01:07:39 +0000[diff] [blame]539<li>It is now possible to create more than one JIT instance in the same process.
540These JITs can generate machine code in parallel,
541although <a href="http://llvm.org/docs/ProgrammersManual.html#jitthreading">you
542still have to obey the other threading restrictions</a>.</li>
Chris Lattner0b832202008-06-08 02:45:07 +0000[diff] [blame]543</ul>
544
545</div>
546
547<!--=========================================================================-->
548<div class="doc_subsection">
Chris Lattner511433e2009-03-02 03:24:11 +0000[diff] [blame]549<a name="codegen">Target Independent Code Generator Improvements</a>
Chris Lattner0b832202008-06-08 02:45:07 +0000[diff] [blame]550</div>
551
552<div class="doc_text">
553
Mikhail Glushenkovf795ef02009-03-01 18:09:47 +0000[diff] [blame]554<p>We have put a significant amount of work into the code generator
555infrastructure, which allows us to implement more aggressive algorithms and make
556it run faster:</p>
Chris Lattner0b832202008-06-08 02:45:07 +0000[diff] [blame]557
558<ul>
Chris Lattner511433e2009-03-02 03:24:11 +0000[diff] [blame]559
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000[diff] [blame]560<li>...</li>
Chris Lattner84977642007-09-21 03:54:09 +0000[diff] [blame]561</ul>
Chris Lattner84977642007-09-21 03:54:09 +0000[diff] [blame]562</div>
563
Chris Lattner917cc712009-03-02 02:37:32 +0000[diff] [blame]564<!--=========================================================================-->
565<div class="doc_subsection">
566<a name="x86">X86-32 and X86-64 Target Improvements</a>
567</div>
568
569<div class="doc_text">
570<p>New features of the X86 target include:
571</p>
572
573<ul>
Chris Lattner511433e2009-03-02 03:24:11 +0000[diff] [blame]574
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000[diff] [blame]575<li>...</li>
Chris Lattner511433e2009-03-02 03:24:11 +0000[diff] [blame]576
Chris Lattner917cc712009-03-02 02:37:32 +0000[diff] [blame]577</ul>
578
Chris Lattner917cc712009-03-02 02:37:32 +0000[diff] [blame]579</div>
Chris Lattner84977642007-09-21 03:54:09 +0000[diff] [blame]580
581<!--=========================================================================-->
582<div class="doc_subsection">
Chris Lattner11398992009-02-26 07:32:11 +0000[diff] [blame]583<a name="pic16">PIC16 Target Improvements</a>
584</div>
585
586<div class="doc_text">
587<p>New features of the PIC16 target include:
588</p>
589
590<ul>
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000[diff] [blame]591<li>...</li>
Chris Lattner11398992009-02-26 07:32:11 +0000[diff] [blame]592</ul>
593
594<p>Things not yet supported:</p>
595
596<ul>
Chris Lattner11398992009-02-26 07:32:11 +0000[diff] [blame]597<li>Variable arguments.</li>
Chris Lattner511433e2009-03-02 03:24:11 +0000[diff] [blame]598<li>Interrupts/programs.</li>
Chris Lattner11398992009-02-26 07:32:11 +0000[diff] [blame]599</ul>
600
601</div>
602
Chris Lattner11398992009-02-26 07:32:11 +0000[diff] [blame]603<!--=========================================================================-->
604<div class="doc_subsection">
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]605<a name="ARM">ARM Target Improvements</a>
Chris Lattnerc441fb82009-03-01 02:30:21 +0000[diff] [blame]606</div>
607
608<div class="doc_text">
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]609<p>New features of the ARM target include:
610</p>
Chris Lattnerc441fb82009-03-01 02:30:21 +0000[diff] [blame]611
612<ul>
Chris Lattnerc441fb82009-03-01 02:30:21 +0000[diff] [blame]613
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000[diff] [blame]614<li>...</li>
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]615</ul>
Chris Lattnerc441fb82009-03-01 02:30:21 +0000[diff] [blame]616
Chris Lattnerc441fb82009-03-01 02:30:21 +0000[diff] [blame]617
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]618</div>
Chris Lattnerc441fb82009-03-01 02:30:21 +0000[diff] [blame]619
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]620<!--=========================================================================-->
621<div class="doc_subsection">
622<a name="OtherTarget">Other Target Specific Improvements</a>
623</div>
Chris Lattnerc441fb82009-03-01 02:30:21 +0000[diff] [blame]624
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]625<div class="doc_text">
626<p>New features of other targets include:
627</p>
628
629<ul>
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000[diff] [blame]630<li>...</li>
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]631</ul>
632
633</div>
634
635<!--=========================================================================-->
636<div class="doc_subsection">
637<a name="newapis">New Useful APIs</a>
638</div>
639
640<div class="doc_text">
641
642<p>This release includes a number of new APIs that are used internally, which
643 may also be useful for external clients.
644</p>
645
646<ul>
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000[diff] [blame]647<li>...</li>
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]648</ul>
649
650
651</div>
652
653<!--=========================================================================-->
654<div class="doc_subsection">
655<a name="otherimprovements">Other Improvements and New Features</a>
656</div>
657
658<div class="doc_text">
659<p>Other miscellaneous features include:</p>
660
661<ul>
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000[diff] [blame]662<li>...</li>
Chris Lattnerc441fb82009-03-01 02:30:21 +0000[diff] [blame]663</ul>
664
665</div>
666
Chris Lattner77d29b12008-06-05 08:02:49 +0000[diff] [blame]667
668<!--=========================================================================-->
669<div class="doc_subsection">
Chris Lattnerf6662f92008-10-13 17:57:36 +0000[diff] [blame]670<a name="changes">Major Changes and Removed Features</a>
671</div>
672
673<div class="doc_text">
674
Chris Lattnereeb4da02008-10-13 22:06:31 +0000[diff] [blame]675<p>If you're already an LLVM user or developer with out-of-tree changes based
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000[diff] [blame]676on LLVM 2.6, this section lists some "gotchas" that you may run into upgrading
Chris Lattnereeb4da02008-10-13 22:06:31 +0000[diff] [blame]677from the previous release.</p>
Chris Lattnerf6662f92008-10-13 17:57:36 +0000[diff] [blame]678
679<ul>
Jeffrey Yasskinbc83d062010-02-09 23:03:44 +0000[diff] [blame]680<li>The LLVM interpreter now defaults to <em>not</em> using <tt>libffi</tt> even
681if you have it installed. This makes it more likely that an LLVM built on one
682system will work when copied to a similar system. To use <tt>libffi</tt>,
683configure with <tt>--enable-libffi</tt>.
684</li>
Chris Lattnereeb4da02008-10-13 22:06:31 +0000[diff] [blame]685</ul>
686
687
688<p>In addition, many APIs have changed in this release. Some of the major LLVM
689API changes are:</p>
690
691<ul>
Jeffrey Yasskin4fcd6072010-01-28 01:41:20 +0000[diff] [blame]692<li><tt>ModuleProvider</tt> has been <a
693href="http://llvm.org/viewvc/llvm-project?view=rev&revision=94686">removed</a>
694and its methods moved to <tt>Module</tt> and <tt>GlobalValue</tt>.
695Most clients can remove uses of <tt>ExistingModuleProvider</tt>,
696replace <tt>getBitcodeModuleProvider</tt> with
697<tt>getLazyBitcodeModule</tt>, and pass their <tt>Module</tt> to
698functions that used to accept <tt>ModuleProvider</tt>. Clients who
699wrote their own <tt>ModuleProvider</tt>s will need to derive from
700<tt>GVMaterializer</tt> instead and use
701<tt>Module::setMaterializer</tt> to attach it to a
702<tt>Module</tt>.</li>
703
704<li><tt>GhostLinkage</tt> has given up the ghost.
705<tt>GlobalValue</tt>s that have not yet been read from their backing
706storage have the same linkage they will have after being read in.
707Clients must replace calls to
708<tt>GlobalValue::hasNotBeenReadFromBitcode</tt> with
709<tt>GlobalValue::isMaterializable</tt>.</li>
Daniel Dunbar4acdede2010-02-10 04:09:52 +0000[diff] [blame]710
711<li>FIXME: Debug info has been totally redone. Add pointers to new APIs. Substantial caveats about compatibility of .ll and .bc files.</li>
712
Daniel Dunbarca1c8162010-02-14 01:47:19 +0000[diff] [blame]713<li>The <tt>llvm/Support/DataTypes.h</tt> header has moved
714to <tt>llvm/System/DataTypes.h</tt>.</li>
715
Duncan Sands411432d2010-02-17 17:20:17 +0000[diff] [blame]716<li>The <tt>isInteger</tt>, <tt>isIntOrIntVector</tt>, <tt>isFloatingPoint</tt>,
717<tt>isFPOrFPVector</tt> and <tt>isFPOrFPVector</tt> methods have been renamed
718<tt>isIntegerTy</tt>, <tt>isIntOrIntVectorTy</tt>, <tt>isFloatingPointTy</tt>,
719<tt>isFPOrFPVectorTy</tt> and <tt>isFPOrFPVectorTy</tt> respectively.</li>
Devang Patelb34dd132008-10-14 20:03:43 +0000[diff] [blame]720</ul>
Chris Lattnerf6662f92008-10-13 17:57:36 +0000[diff] [blame]721
Chris Lattnerf6662f92008-10-13 17:57:36 +0000[diff] [blame]722</div>
723
724
725
Chris Lattner19092612003-10-02 16:38:05 +0000[diff] [blame]726<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]727<div class="doc_section">
728 <a name="portability">Portability and Supported Platforms</a>
729</div>
Chris Lattner19092612003-10-02 16:38:05 +0000[diff] [blame]730<!-- *********************************************************************** -->
731
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]732<div class="doc_text">
733
John Criswell0b5b5e92004-12-08 20:35:47 +0000[diff] [blame]734<p>LLVM is known to work on the following platforms:</p>
Chris Lattner4654bdb2004-06-01 18:22:41 +0000[diff] [blame]735
736<ul>
Mikhail Glushenkovf795ef02009-03-01 18:09:47 +0000[diff] [blame]737<li>Intel and AMD machines (IA32, X86-64, AMD64, EMT-64) running Red Hat
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]738 Linux, Fedora Core, FreeBSD and AuroraUX (and probably other unix-like
739 systems).</li>
Mikhail Glushenkovf795ef02009-03-01 18:09:47 +0000[diff] [blame]740<li>PowerPC and X86-based Mac OS X systems, running 10.3 and above in 32-bit
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]741 and 64-bit modes.</li>
Chris Lattner252b83d2008-02-06 18:00:06 +0000[diff] [blame]742<li>Intel and AMD machines running on Win32 using MinGW libraries (native).</li>
Chris Lattner57a460e2007-05-23 04:39:32 +0000[diff] [blame]743<li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
744 support is available for native builds with Visual C++).</li>
Chris Lattner7e23d6e2009-10-16 16:30:58 +0000[diff] [blame]745<li>Sun x86 and AMD64 machines running Solaris 10, OpenSolaris 0906.</li>
John Criswell9321fa82005-05-13 20:28:15 +0000[diff] [blame]746<li>Alpha-based machines running Debian GNU/Linux.</li>
Chris Lattner4654bdb2004-06-01 18:22:41 +0000[diff] [blame]747</ul>
748
Chris Lattnerbc5786b2008-06-05 06:57:39 +0000[diff] [blame]749<p>The core LLVM infrastructure uses GNU autoconf to adapt itself
Brian Gaekeb0fd7612004-05-09 05:28:35 +0000[diff] [blame]750to the machine and operating system on which it is built. However, minor
751porting may be required to get LLVM to work on new platforms. We welcome your
752portability patches and reports of successful builds or error messages.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]753
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]754</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]755
756<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]757<div class="doc_section">
758 <a name="knownproblems">Known Problems</a>
759</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]760<!-- *********************************************************************** -->
761
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]762<div class="doc_text">
763
Mikhail Glushenkovf795ef02009-03-01 18:09:47 +0000[diff] [blame]764<p>This section contains significant known problems with the LLVM system,
Chris Lattnere18b32e2008-11-10 05:40:34 +0000[diff] [blame]765listed by component. If you run into a problem, please check the <a
Chris Lattnerc463b272005-10-29 07:07:09 +0000[diff] [blame]766href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
Chris Lattner5eccca42003-12-12 21:22:16 +0000[diff] [blame]767there isn't already one.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]768
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]769<ul>
770<li>The llvm-gcc bootstrap will fail with some versions of binutils (e.g. 2.15)
771 with a message of "<tt><a href="http://llvm.org/PR5004">Error: can not do 8
772 byte pc-relative relocation</a></tt>" when building C++ code. We intend to
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000[diff] [blame]773 fix this on mainline, but a workaround is to upgrade to binutils 2.17 or
774 later.</li>
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]775
776<li>LLVM will not correctly compile on Solaris and/or OpenSolaris
777using the stock GCC 3.x.x series 'out the box',
Chris Lattner554ee4a2009-11-03 21:50:09 +0000[diff] [blame]778See: <a href="GettingStarted.html#brokengcc">Broken versions of GCC and other tools</a>.
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]779However, A <a href="http://pkg.auroraux.org/GCC">Modern GCC Build</a>
780for x86/x86-64 has been made available from the third party AuroraUX Project
781that has been meticulously tested for bootstrapping LLVM &amp; Clang.</li>
782</ul>
783
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]784</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]785
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000[diff] [blame]786<!-- ======================================================================= -->
787<div class="doc_subsection">
788 <a name="experimental">Experimental features included with this release</a>
789</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]790
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000[diff] [blame]791<div class="doc_text">
792
Misha Brukman6df9e2c2004-05-12 21:46:05 +0000[diff] [blame]793<p>The following components of this LLVM release are either untested, known to
794be broken or unreliable, or are in early development. These components should
795not be relied on, and bugs should not be filed against them, but they may be
796useful 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]797components, please contact us on the <a
798href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p>
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000[diff] [blame]799
800<ul>
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]801<li>The MSIL, Alpha, SPU, MIPS, PIC16, Blackfin, MSP430 and SystemZ backends are
802 experimental.</li>
Bill Wendling99dac472009-03-02 07:54:14 +0000[diff] [blame]803<li>The <tt>llc</tt> "<tt>-filetype=asm</tt>" (the default) is the only
Chris Lattnerc66bfef2010-03-17 04:41:49 +0000[diff] [blame]804 supported value for this option. The MachO writer is experimental, and
805 works much better in mainline SVN.</li>
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000[diff] [blame]806</ul>
807
808</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]809
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]810<!-- ======================================================================= -->
811<div class="doc_subsection">
Chris Lattner26299222006-11-18 07:51:14 +0000[diff] [blame]812 <a name="x86-be">Known problems with the X86 back-end</a>
John Criswellc0c186d2005-11-08 21:11:33 +0000[diff] [blame]813</div>
814
815<div class="doc_text">
816
817<ul>
Anton Korobeynikova6094be2008-06-08 10:24:13 +0000[diff] [blame]818 <li>The X86 backend does not yet support
819 all <a href="http://llvm.org/PR879">inline assembly that uses the X86
820 floating point stack</a>. It supports the 'f' and 't' constraints, but not
821 'u'.</li>
Chris Lattnere6e1b352008-06-08 21:19:07 +0000[diff] [blame]822 <li>The X86 backend generates inefficient floating point code when configured
823 to generate code for systems that don't have SSE2.</li>
Duncan Sands47eff2b2008-06-08 19:38:43 +0000[diff] [blame]824 <li>Win64 code generation wasn't widely tested. Everything should work, but we
John Criswell524a5dd2009-03-02 15:28:15 +0000[diff] [blame]825 expect small issues to happen. Also, llvm-gcc cannot build the mingw64
826 runtime currently due
Anton Korobeynikova6094be2008-06-08 10:24:13 +0000[diff] [blame]827 to <a href="http://llvm.org/PR2255">several</a>
John Criswell524a5dd2009-03-02 15:28:15 +0000[diff] [blame]828 <a href="http://llvm.org/PR2257">bugs</a> and due to lack of support for
829 the
830 'u' inline assembly constraint and for X87 floating point inline assembly.</li>
Dan Gohman8207ba92008-06-08 23:05:11 +0000[diff] [blame]831 <li>The X86-64 backend does not yet support the LLVM IR instruction
Chris Lattner917cc712009-03-02 02:37:32 +0000[diff] [blame]832 <tt>va_arg</tt>. Currently, the llvm-gcc and front-ends support variadic
Dan Gohman8207ba92008-06-08 23:05:11 +0000[diff] [blame]833 argument constructs on X86-64 by lowering them manually.</li>
Chris Lattner26299222006-11-18 07:51:14 +0000[diff] [blame]834</ul>
835
836</div>
837
838<!-- ======================================================================= -->
839<div class="doc_subsection">
840 <a name="ppc-be">Known problems with the PowerPC back-end</a>
841</div>
842
843<div class="doc_text">
844
845<ul>
Nicolas Geoffraye4285dc2007-05-15 09:21:28 +0000[diff] [blame]846<li>The Linux PPC32/ABI support needs testing for the interpreter and static
Chris Lattner57a460e2007-05-23 04:39:32 +0000[diff] [blame]847compilation, and lacks support for debug information.</li>
Chris Lattner26299222006-11-18 07:51:14 +0000[diff] [blame]848</ul>
849
850</div>
851
852<!-- ======================================================================= -->
853<div class="doc_subsection">
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000[diff] [blame]854 <a name="arm-be">Known problems with the ARM back-end</a>
855</div>
856
857<div class="doc_text">
858
859<ul>
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]860<li>Support for the Advanced SIMD (Neon) instruction set is still incomplete
861and not well tested. Some features may not work at all, and the code quality
862may be poor in some cases.</li>
Chris Lattner57a460e2007-05-23 04:39:32 +0000[diff] [blame]863<li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
Duncan Sandsc90d68b2007-09-26 15:59:54 +0000[diff] [blame]864processors, thumb programs can crash or produce wrong
Chris Lattner57a460e2007-05-23 04:39:32 +0000[diff] [blame]865results (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
John Criswell524a5dd2009-03-02 15:28:15 +0000[diff] [blame]866<li>Compilation for ARM Linux OABI (old ABI) is supported but not fully tested.
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000[diff] [blame]867</li>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000[diff] [blame]868</ul>
869
870</div>
871
872<!-- ======================================================================= -->
873<div class="doc_subsection">
Chris Lattner26299222006-11-18 07:51:14 +0000[diff] [blame]874 <a name="sparc-be">Known problems with the SPARC back-end</a>
875</div>
876
877<div class="doc_text">
878
879<ul>
John Criswell524a5dd2009-03-02 15:28:15 +0000[diff] [blame]880<li>The SPARC backend only supports the 32-bit SPARC ABI (-m32); it does not
Chris Lattner26299222006-11-18 07:51:14 +0000[diff] [blame]881 support the 64-bit SPARC ABI (-m64).</li>
882</ul>
883
884</div>
885
886<!-- ======================================================================= -->
887<div class="doc_subsection">
Bruno Cardoso Lopesb7e1a4f2008-10-25 14:56:26 +0000[diff] [blame]888 <a name="mips-be">Known problems with the MIPS back-end</a>
889</div>
890
891<div class="doc_text">
892
893<ul>
Bruno Cardoso Lopesb7e1a4f2008-10-25 14:56:26 +0000[diff] [blame]894<li>64-bit MIPS targets are not supported yet.</li>
895</ul>
896
897</div>
898
899<!-- ======================================================================= -->
900<div class="doc_subsection">
Chris Lattner26299222006-11-18 07:51:14 +0000[diff] [blame]901 <a name="alpha-be">Known problems with the Alpha back-end</a>
902</div>
903
904<div class="doc_text">
905
906<ul>
907
908<li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
909appropriate nops inserted to ensure restartability.</li>
910
John Criswellc0c186d2005-11-08 21:11:33 +0000[diff] [blame]911</ul>
912</div>
913
Chris Lattner26299222006-11-18 07:51:14 +0000[diff] [blame]914<!-- ======================================================================= -->
915<div class="doc_subsection">
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000[diff] [blame]916 <a name="c-be">Known problems with the C back-end</a>
Chris Lattner26299222006-11-18 07:51:14 +0000[diff] [blame]917</div>
918
919<div class="doc_text">
920
921<ul>
Chris Lattner5733b272008-06-05 06:35:40 +0000[diff] [blame]922<li><a href="http://llvm.org/PR802">The C backend has only basic support for
923 inline assembly code</a>.</li>
Chris Lattner725a0d82007-09-26 06:01:35 +0000[diff] [blame]924<li><a href="http://llvm.org/PR1658">The C backend violates the ABI of common
925 C++ programs</a>, preventing intermixing between C++ compiled by the CBE and
Gabor Greif4906abe2009-03-02 12:02:51 +0000[diff] [blame]926 C++ code compiled with <tt>llc</tt> or native compilers.</li>
Duncan Sandsf74c0cc2008-02-10 13:40:55 +0000[diff] [blame]927<li>The C backend does not support all exception handling constructs.</li>
Duncan Sands50723a92009-02-25 11:51:54 +0000[diff] [blame]928<li>The C backend does not support arbitrary precision integers.</li>
Chris Lattner26299222006-11-18 07:51:14 +0000[diff] [blame]929</ul>
930
931</div>
John Criswellc0c186d2005-11-08 21:11:33 +0000[diff] [blame]932
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]933
934<!-- ======================================================================= -->
935<div class="doc_subsection">
Chris Lattnerc66bfef2010-03-17 04:41:49 +0000[diff] [blame]936 <a name="c-fe">Known problems with the llvm-gcc C and C++ front-end</a>
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]937</div>
Chris Lattner47588f92003-10-02 05:07:23 +0000[diff] [blame]938
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]939<div class="doc_text">
Chris Lattnerc5d658a2006-03-03 00:34:26 +0000[diff] [blame]940
Chris Lattner5733b272008-06-05 06:35:40 +0000[diff] [blame]941<p>The only major language feature of GCC not supported by llvm-gcc is
942 the <tt>__builtin_apply</tt> family of builtins. However, some extensions
943 are only supported on some targets. For example, trampolines are only
Duncan Sands27aff872008-06-08 20:18:35 +0000[diff] [blame]944 supported on some targets (these are used when you take the address of a
945 nested function).</p>
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]946
Chris Lattner5733b272008-06-05 06:35:40 +0000[diff] [blame]947<p>If you run into GCC extensions which are not supported, please let us know.
948</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]949
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]950</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]951
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]952<!-- ======================================================================= -->
953<div class="doc_subsection">
Chris Lattner1eb4df62008-10-30 03:58:13 +0000[diff] [blame]954 <a name="fortran-fe">Known problems with the llvm-gcc Fortran front-end</a>
955</div>
956
957<div class="doc_text">
Gabor Greifba10fe02008-11-04 21:50:59 +0000[diff] [blame]958<ul>
Chris Lattner1eb4df62008-10-30 03:58:13 +0000[diff] [blame]959<li>Fortran support generally works, but there are still several unresolved bugs
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]960 in <a href="http://llvm.org/bugs/">Bugzilla</a>. Please see the
961 tools/gfortran component for details.</li>
Gabor Greifba10fe02008-11-04 21:50:59 +0000[diff] [blame]962</ul>
Chris Lattner1eb4df62008-10-30 03:58:13 +0000[diff] [blame]963</div>
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]964
Chris Lattner2b659ef2008-02-12 06:29:45 +0000[diff] [blame]965<!-- ======================================================================= -->
966<div class="doc_subsection">
Chris Lattner5733b272008-06-05 06:35:40 +0000[diff] [blame]967 <a name="ada-fe">Known problems with the llvm-gcc Ada front-end</a>
Chris Lattner2b659ef2008-02-12 06:29:45 +0000[diff] [blame]968</div>
969
970<div class="doc_text">
John Criswell524a5dd2009-03-02 15:28:15 +0000[diff] [blame]971The llvm-gcc 4.2 Ada compiler works fairly well; however, this is not a mature
972technology, and problems should be expected.
Chris Lattner2b659ef2008-02-12 06:29:45 +0000[diff] [blame]973<ul>
Duncan Sands27aff872008-06-08 20:18:35 +0000[diff] [blame]974<li>The Ada front-end currently only builds on X86-32. This is mainly due
John Criswell524a5dd2009-03-02 15:28:15 +0000[diff] [blame]975to lack of trampoline support (pointers to nested functions) on other platforms.
976However, 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]977which does support trampolines.</li>
978<li>The Ada front-end <a href="http://llvm.org/PR2007">fails to bootstrap</a>.
Duncan Sands326a4982009-02-25 11:59:06 +0000[diff] [blame]979This is due to lack of LLVM support for <tt>setjmp</tt>/<tt>longjmp</tt> style
980exception handling, which is used internally by the compiler.
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]981Workaround: configure with <tt>--disable-bootstrap</tt>.</li>
Duncan Sands978bcee2008-10-13 17:27:23 +0000[diff] [blame]982<li>The c380004, <a href="http://llvm.org/PR2010">c393010</a>
983and <a href="http://llvm.org/PR2421">cxg2021</a> ACATS tests fail
Duncan Sands326a4982009-02-25 11:59:06 +0000[diff] [blame]984(c380004 also fails with gcc-4.2 mainline).
985If the compiler is built with checks disabled then <a href="http://llvm.org/PR2010">c393010</a>
986causes the compiler to go into an infinite loop, using up all system memory.</li>
Duncan Sandsdd3e6722009-03-02 16:35:57 +0000[diff] [blame]987<li>Some GCC specific Ada tests continue to crash the compiler.</li>
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]988<li>The <tt>-E</tt> binder option (exception backtraces)
Chris Lattner2b659ef2008-02-12 06:29:45 +0000[diff] [blame]989<a href="http://llvm.org/PR1982">does not work</a> and will result in programs
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]990crashing if an exception is raised. Workaround: do not use <tt>-E</tt>.</li>
Chris Lattner2b659ef2008-02-12 06:29:45 +0000[diff] [blame]991<li>Only discrete types <a href="http://llvm.org/PR1981">are allowed to start
992or finish at a non-byte offset</a> in a record. Workaround: do not pack records
993or use representation clauses that result in a field of a non-discrete type
994starting or finishing in the middle of a byte.</li>
Chris Lattnere6e1b352008-06-08 21:19:07 +0000[diff] [blame]995<li>The <tt>lli</tt> interpreter <a href="http://llvm.org/PR2009">considers
996'main' as generated by the Ada binder to be invalid</a>.
997Workaround: hand edit the file to use pointers for <tt>argv</tt> and
998<tt>envp</tt> rather than integers.</li>
999<li>The <tt>-fstack-check</tt> option <a href="http://llvm.org/PR2008">is
1000ignored</a>.</li>
Chris Lattner2b659ef2008-02-12 06:29:45 +0000[diff] [blame]1001</ul>
1002</div>
1003
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]1004<!-- ======================================================================= -->
1005<div class="doc_subsection">
1006 <a name="ocaml-bindings">Known problems with the O'Caml bindings</a>
1007</div>
1008
1009<div class="doc_text">
1010
1011<p>The <tt>Llvm.Linkage</tt> module is broken, and has incorrect values. Only
1012<tt>Llvm.Linkage.External</tt>, <tt>Llvm.Linkage.Available_externally</tt>, and
1013<tt>Llvm.Linkage.Link_once</tt> will be correct. If you need any of the other linkage
1014modes, you'll have to write an external C library in order to expose the
1015functionality. This has been fixed in the trunk.</p>
1016</div>
1017
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]1018<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]1019<div class="doc_section">
1020 <a name="additionalinfo">Additional Information</a>
1021</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]1022<!-- *********************************************************************** -->
1023
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]1024<div class="doc_text">
1025
Chris Lattner416db102005-05-16 17:13:10 +0000[diff] [blame]1026<p>A wide variety of additional information is available on the <a
Chris Lattnerb4b0ce72007-05-18 00:44:29 +0000[diff] [blame]1027href="http://llvm.org">LLVM web page</a>, in particular in the <a
1028href="http://llvm.org/docs/">documentation</a> section. The web page also
Reid Spencer669ed452007-07-09 08:04:31 +0000[diff] [blame]1029contains versions of the API documentation which is up-to-date with the
1030Subversion version of the source code.
Misha Brukman109d9e82005-03-30 19:14:24 +0000[diff] [blame]1031You can access versions of these documents specific to this release by going
1032into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]1033
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]1034<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]1035us via the <a href="http://llvm.org/docs/#maillist"> mailing
Chris Lattner5eccca42003-12-12 21:22:16 +0000[diff] [blame]1036lists</a>.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]1037
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]1038</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]1039
1040<!-- *********************************************************************** -->
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]1041
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]1042<hr>
Misha Brukman2061e892003-11-22 01:23:39 +0000[diff] [blame]1043<address>
Misha Brukman38847d52003-12-21 22:53:21 +0000[diff] [blame]1044 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman44408702008-12-11 17:34:48 +0000[diff] [blame]1045 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
Misha Brukman2061e892003-11-22 01:23:39 +0000[diff] [blame]1046 <a href="http://validator.w3.org/check/referer"><img
Misha Brukman44408702008-12-11 17:34:48 +0000[diff] [blame]1047 src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
Misha Brukman2061e892003-11-22 01:23:39 +0000[diff] [blame]1048
Chris Lattnerb4b0ce72007-05-18 00:44:29 +0000[diff] [blame]1049 <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]1050 Last modified: $Date$
Misha Brukman2061e892003-11-22 01:23:39 +0000[diff] [blame]1051</address>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]1052
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]1053</body>
1054</html>