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