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