blob: a66a51f957e95c02f017b2cadab6ea42807123a8 [file] [log] [blame]
Misha Brukman500bc302003-11-22 00:38:41 +00001<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
3<html>
4<head>
Reid Spencer6454ed32004-11-18 18:38:58 +00005 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
Misha Brukman500bc302003-11-22 00:38:41 +00006 <link rel="stylesheet" href="llvm.css" type="text/css">
Jeffrey Yasskinbec48772010-01-28 01:14:43 +00007 <title>LLVM 2.7 Release Notes</title>
Misha Brukman500bc302003-11-22 00:38:41 +00008</head>
9<body>
Chris Lattner79c3fe12003-10-02 04:57:28 +000010
Jeffrey Yasskinbec48772010-01-28 01:14:43 +000011<div class="doc_title">LLVM 2.7 Release Notes</div>
Mikhail Glushenkovea65d7d2008-10-13 02:08:34 +000012
Chris Lattner0e464a92010-03-17 04:02:39 +000013<img align=right src="http://llvm.org/img/DragonSmall.png"
14 width="136" height="136">
15
Chris Lattner79c3fe12003-10-02 04:57:28 +000016<ol>
Misha Brukman500bc302003-11-22 00:38:41 +000017 <li><a href="#intro">Introduction</a></li>
Chris Lattner96a445e2008-10-13 18:01:01 +000018 <li><a href="#subproj">Sub-project Status Update</a></li>
Jeffrey Yasskinbec48772010-01-28 01:14:43 +000019 <li><a href="#externalproj">External Projects Using LLVM 2.7</a></li>
20 <li><a href="#whatsnew">What's New in LLVM 2.7?</a></li>
Chris Lattner4b538b92004-04-30 22:17:12 +000021 <li><a href="GettingStarted.html">Installation Instructions</a></li>
Misha Brukman500bc302003-11-22 00:38:41 +000022 <li><a href="#portability">Portability and Supported Platforms</a></li>
Dan Gohman44aa9212008-10-14 16:23:02 +000023 <li><a href="#knownproblems">Known Problems</a></li>
Misha Brukman500bc302003-11-22 00:38:41 +000024 <li><a href="#additionalinfo">Additional Information</a></li>
Chris Lattner79c3fe12003-10-02 04:57:28 +000025</ol>
26
Chris Lattner7911ce22004-05-23 21:07:27 +000027<div class="doc_author">
Dan Gohman44aa9212008-10-14 16:23:02 +000028 <p>Written by the <a href="http://llvm.org">LLVM Team</a></p>
Misha Brukman500bc302003-11-22 00:38:41 +000029</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +000030
Jeffrey Yasskinbec48772010-01-28 01:14:43 +000031<h1 style="color:red">These are in-progress notes for the upcoming LLVM 2.7
32release.<br>
33You may prefer the
34<a href="http://llvm.org/releases/2.6/docs/ReleaseNotes.html">LLVM 2.6
35Release Notes</a>.</h1>
36
Chris Lattner79c3fe12003-10-02 04:57:28 +000037<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +000038<div class="doc_section">
39 <a name="intro">Introduction</a>
40</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +000041<!-- *********************************************************************** -->
42
Misha Brukman500bc302003-11-22 00:38:41 +000043<div class="doc_text">
44
Chris Lattnerf6662f92008-10-13 17:57:36 +000045<p>This document contains the release notes for the LLVM Compiler
Jeffrey Yasskinbec48772010-01-28 01:14:43 +000046Infrastructure, release 2.7. Here we describe the status of LLVM, including
Chris Lattnerf6662f92008-10-13 17:57:36 +000047major improvements from the previous release and significant known problems.
Mikhail Glushenkovf795ef02009-03-01 18:09:47 +000048All LLVM releases may be downloaded from the <a
Chris Lattnerf6662f92008-10-13 17:57:36 +000049href="http://llvm.org/releases/">LLVM releases web site</a>.</p>
Chris Lattner19092612003-10-02 16:38:05 +000050
Chris Lattner7506b1d2004-12-07 08:04:13 +000051<p>For more information about LLVM, including information about the latest
Chris Lattnerc463b272005-10-29 07:07:09 +000052release, please check out the <a href="http://llvm.org/">main LLVM
Chris Lattner47ad72c2003-10-07 21:38:31 +000053web site</a>. If you have questions or comments, the <a
Chris Lattnerc66bfef2010-03-17 04:41:49 +000054href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM Developer's
55Mailing List</a> is a good place to send them.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +000056
Mikhail Glushenkovea65d7d2008-10-13 02:08:34 +000057<p>Note that if you are reading this file from a Subversion checkout or the
Chris Lattner84977642007-09-21 03:54:09 +000058main LLVM web page, this document applies to the <i>next</i> release, not the
Gabor Greiffa933f82008-10-14 11:00:32 +000059current one. To see the release notes for a specific release, please see the
Chris Lattner84977642007-09-21 03:54:09 +000060<a href="http://llvm.org/releases/">releases page</a>.</p>
Misha Brukman500bc302003-11-22 00:38:41 +000061
Chris Lattnerc66bfef2010-03-17 04:41:49 +000062
Chris Lattnerdc910082010-03-17 06:41:58 +000063<p>FIXME: llvm.org moved to new server, mention new logo, Ted and Doug new code
64 owners.</p>
Chris Lattnerc66bfef2010-03-17 04:41:49 +000065
Misha Brukman500bc302003-11-22 00:38:41 +000066</div>
Chris Lattner61358ab2009-10-13 17:48:04 +000067
Chris Lattner79c3fe12003-10-02 04:57:28 +000068
Chris Lattner61358ab2009-10-13 17:48:04 +000069<!--
70Almost dead code.
71 include/llvm/Analysis/LiveValues.h => Dan
72 lib/Transforms/IPO/MergeFunctions.cpp => consider for 2.8.
73 llvm/Analysis/PointerTracking.h => Edwin wants this, consider for 2.8.
Chris Lattner76ef2982010-01-09 22:30:40 +000074 ABCD, SCCVN, GEPSplitterPass
Chris Lattner048fe3c2010-01-16 21:25:13 +000075 MSIL backend?
Chris Lattnerdc910082010-03-17 06:41:58 +000076 lib/Transforms/Utils/SSI.cpp -> ABCD depends on it.
Chris Lattner61358ab2009-10-13 17:48:04 +000077-->
78
79
Jeffrey Yasskinbec48772010-01-28 01:14:43 +000080<!-- Features that need text if they're finished for 2.7:
Chris Lattner61358ab2009-10-13 17:48:04 +000081 gcc plugin.
82 strong phi elim
83 variable debug info for optimized code
Chris Lattnerab68e9e2009-02-26 22:33:38 +000084 postalloc scheduler: anti dependence breaking, hazard recognizer?
Chris Lattner61358ab2009-10-13 17:48:04 +000085 metadata
86 loop dependence analysis
87 ELF Writer? How stable?
88 <li>PostRA scheduler improvements, ARM adoption (David Goodwin).</li>
Chris Lattneracce85d2008-02-10 07:46:44 +000089 -->
Mikhail Glushenkovea65d7d2008-10-13 02:08:34 +000090
Chris Lattner547a3912008-10-12 19:47:48 +000091 <!-- for announcement email:
Chris Lattner61358ab2009-10-13 17:48:04 +000092 Logo web page.
93 llvm devmtg
94 compiler_rt
95 KLEE web page at klee.llvm.org
96 Many new papers added to /pubs/
Chris Lattnerdc910082010-03-17 06:41:58 +000097 Mention gcc plugin.
Chris Lattner74c80df2009-02-25 06:34:50 +000098 -->
Chris Lattneracce85d2008-02-10 07:46:44 +000099
Chris Lattner96a445e2008-10-13 18:01:01 +0000100<!-- *********************************************************************** -->
101<div class="doc_section">
102 <a name="subproj">Sub-project Status Update</a>
Chris Lattnerea34f642008-06-08 21:34:41 +0000103</div>
Chris Lattner96a445e2008-10-13 18:01:01 +0000104<!-- *********************************************************************** -->
Chris Lattnerea34f642008-06-08 21:34:41 +0000105
106<div class="doc_text">
Chris Lattner8348b472008-06-08 21:58:17 +0000107<p>
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000108The LLVM 2.7 distribution currently consists of code from the core LLVM
Chris Lattner61358ab2009-10-13 17:48:04 +0000109repository (which roughly includes the LLVM optimizers, code generators
110and supporting tools), the Clang repository and the llvm-gcc repository. In
111addition to this code, the LLVM Project includes other sub-projects that are in
112development. Here we include updates on these subprojects.
Bill Wendling63d8c552009-03-02 04:28:57 +0000113</p>
Chris Lattner96a445e2008-10-13 18:01:01 +0000114
Chris Lattner8348b472008-06-08 21:58:17 +0000115</div>
116
Chris Lattner96a445e2008-10-13 18:01:01 +0000117
Chris Lattner8348b472008-06-08 21:58:17 +0000118<!--=========================================================================-->
Chris Lattner96a445e2008-10-13 18:01:01 +0000119<div class="doc_subsection">
Chris Lattnerfb97b2d2008-10-13 18:11:54 +0000120<a name="clang">Clang: C/C++/Objective-C Frontend Toolkit</a>
Chris Lattner8348b472008-06-08 21:58:17 +0000121</div>
122
123<div class="doc_text">
124
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000125<p>The <a href="http://clang.llvm.org/">Clang project</a> is ...</p>
Chris Lattner61358ab2009-10-13 17:48:04 +0000126
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000127<p>In the LLVM 2.7 time-frame, the Clang team has made many improvements:</p>
Bill Wendling741748a2008-10-27 09:27:33 +0000128
Daniel Dunbar13739432008-10-14 23:25:09 +0000129<ul>
Daniel Dunbar60dadb62010-03-25 16:09:18 +0000130<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 Wendling6bc15282009-03-02 04:28:18 +0000145</ul>
Chris Lattnerfb97b2d2008-10-13 18:11:54 +0000146</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 Yasskinbec48772010-01-28 01:14:43 +0000155<p>Previously announced in the 2.4, 2.5, and 2.6 LLVM releases, the Clang project also
Ted Kremenek8b3894c2009-02-27 07:01:32 +0000156includes an early stage static source code analysis tool for <a
157href="http://clang.llvm.org/StaticAnalysis.html">automatically finding bugs</a>
Chris Lattner61358ab2009-10-13 17:48:04 +0000158in C and Objective-C programs. The tool performs checks to find
Ted Kremenek8b3894c2009-02-27 07:01:32 +0000159bugs that occur on a specific path within a program.</p>
Chris Lattnercc042612008-10-14 00:52:49 +0000160
Chris Lattner0e464a92010-03-17 04:02:39 +0000161<p>In the LLVM 2.7 time-frame, the analyzer core has sprouted legs and...</p>
Chris Lattner8348b472008-06-08 21:58:17 +0000162
163</div>
164
Chris Lattner96a445e2008-10-13 18:01:01 +0000165<!--=========================================================================-->
166<div class="doc_subsection">
Nicolas Geoffray99a4d302008-10-14 19:23:04 +0000167<a name="vmkit">VMKit: JVM/CLI Virtual Machine Implementation</a>
Chris Lattner96a445e2008-10-13 18:01:01 +0000168</div>
169
170<div class="doc_text">
171<p>
Nicolas Geoffray99a4d302008-10-14 19:23:04 +0000172The <a href="http://vmkit.llvm.org/">VMKit project</a> is an implementation of
Chris Lattner61358ab2009-10-13 17:48:04 +0000173a 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 Lattner96a445e2008-10-13 18:01:01 +0000176
Chris Lattner61358ab2009-10-13 17:48:04 +0000177<p>
Chris Lattnerbf8e5162010-03-29 18:34:13 +0000178With the release of LLVM 2.7, VMKit has shifted to a great framework for writing
179virtual machines. VMKit now offers precise and efficient garbage collection with
180multi-threading support, thanks to the MMTk memory management toolkit, as well
181as just in time and ahead of time compilation with LLVM. The major changes in
182VMKit 0.27 are:</p>
Chris Lattner96a445e2008-10-13 18:01:01 +0000183
Nicolas Geoffray99a4d302008-10-14 19:23:04 +0000184<ul>
185
Chris Lattnerbf8e5162010-03-29 18:34:13 +0000186<li>Garbage collection: VMKit now uses the MMTk toolkit for garbage collectors.
187 The first collector to be ported is the MarkSweep collector, which is precise,
188 and drastically improves the performance of VMKit.</li>
189<li>Line number information in the JVM: by using the debug metadata of LLVM, the
190 JVM now supports precise line number information, useful when printing a stack
191 trace.</li>
192<li>Interface calls in the JVM: we implemented a variant of the Interface Method
193 Table technique for interface calls in the JVM.
194</li>
Nicolas Geoffray99a4d302008-10-14 19:23:04 +0000195
196</ul>
Chris Lattner96a445e2008-10-13 18:01:01 +0000197</div>
198
Chris Lattner61358ab2009-10-13 17:48:04 +0000199
200<!--=========================================================================-->
201<div class="doc_subsection">
202<a name="compiler-rt">compiler-rt: Compiler Runtime Library</a>
203</div>
204
205<div class="doc_text">
206<p>
207The new LLVM <a href="http://compiler-rt.llvm.org/">compiler-rt project</a>
208is a simple library that provides an implementation of the low-level
209target-specific hooks required by code generation and other runtime components.
210For example, when compiling for a 32-bit target, converting a double to a 64-bit
211unsigned integer is compiled into a runtime call to the "__fixunsdfdi"
212function. The compiler-rt library provides highly optimized implementations of
213this and other low-level routines (some are 3x faster than the equivalent
214libgcc routines).</p>
215
216<p>
217All of the code in the compiler-rt project is available under the standard LLVM
218License, a "BSD-style" license.</p>
219
220</div>
221
222<!--=========================================================================-->
223<div class="doc_subsection">
Duncan Sands749fd832010-04-02 09:23:15 +0000224<a name="dragonegg">DragonEgg: llvm-gcc ported to gcc-4.5</a>
Chris Lattner61358ab2009-10-13 17:48:04 +0000225</div>
226
227<div class="doc_text">
228<p>
Duncan Sands749fd832010-04-02 09:23:15 +0000229<a href="http://dragonegg.llvm.org/">DragonEgg</a> is a port of llvm-gcc to
230gcc-4.5. Unlike llvm-gcc, which makes many intrusive changes to the underlying
231gcc-4.2 code, dragonegg in theory does not require any gcc-4.5 modifications
232whatsoever (currently one small patch is needed). This is thanks to the new
233<a href="http://gcc.gnu.org/wiki/plugins">gcc plugin architecture</a>, which
234makes it possible to modify the behaviour of gcc at runtime by loading a plugin,
235which is nothing more than a dynamic library which conforms to the gcc plugin
236interface. DragonEgg is a gcc plugin that causes the LLVM optimizers to be run
237instead of the gcc optimizers, and the LLVM code generators instead of the gcc
238code generators, just like llvm-gcc. To use it, you add
239"-fplugin=path/dragonegg.so" to the gcc-4.5 command line, and gcc-4.5 magically
240becomes llvm-gcc-4.5!
241</p>
242
243<p>
244DragonEgg is still a work in progress. Currently C works very well, while C++,
245Ada and Fortran work fairly well. All other languages either don't work at all,
246or only work poorly. For the moment only the x86-32 and x86-64 targets are
247supported, and only on linux.
248</p>
249
250<p>
251DragonEgg has not yet been released. Once gcc-4.5 has been released, dragonegg
252will probably be released as part of the following LLVM release.
Chris Lattner61358ab2009-10-13 17:48:04 +0000253</p>
254
255</div>
256
257
258<!--=========================================================================-->
259<div class="doc_subsection">
260<a name="mc">llvm-mc: Machine Code Toolkit</a>
261</div>
262
263<div class="doc_text">
264<p>
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000265The LLVM Machine Code (MC) Toolkit project is ...
Chris Lattner61358ab2009-10-13 17:48:04 +0000266</p>
267
268</div>
269
270
Chris Lattnerab68e9e2009-02-26 22:33:38 +0000271<!-- *********************************************************************** -->
272<div class="doc_section">
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000273 <a name="externalproj">External Open Source Projects Using LLVM 2.7</a>
Chris Lattnerab68e9e2009-02-26 22:33:38 +0000274</div>
275<!-- *********************************************************************** -->
276
Chris Lattner61358ab2009-10-13 17:48:04 +0000277<div class="doc_text">
278
279<p>An exciting aspect of LLVM is that it is used as an enabling technology for
280 a lot of other language and tools projects. This section lists some of the
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000281 projects that have already been updated to work with LLVM 2.7.</p>
Chris Lattner61358ab2009-10-13 17:48:04 +0000282</div>
283
284
285<!--=========================================================================-->
286<div class="doc_subsection">
287<a name="Rubinius">Rubinius</a>
288</div>
289
290<div class="doc_text">
Chris Lattner0e464a92010-03-17 04:02:39 +0000291Need update.
292<!--
Chris Lattner61358ab2009-10-13 17:48:04 +0000293<p><a href="http://github.com/evanphx/rubinius">Rubinius</a> is an environment
294for running Ruby code which strives to write as much of the core class
295implementation in Ruby as possible. Combined with a bytecode interpreting VM, it
296uses LLVM to optimize and compile ruby code down to machine code. Techniques
297such as type feedback, method inlining, and uncommon traps are all used to
298remove dynamism from ruby execution and increase performance.</p>
299
300<p>Since LLVM 2.5, Rubinius has made several major leaps forward, implementing
301a counter based JIT, type feedback and speculative method inlining.
Chris Lattner0e464a92010-03-17 04:02:39 +0000302-->
Chris Lattner61358ab2009-10-13 17:48:04 +0000303</p>
304
305</div>
306
307<!--=========================================================================-->
308<div class="doc_subsection">
309<a name="macruby">MacRuby</a>
310</div>
311
312<div class="doc_text">
313
314<p>
Chris Lattner0e464a92010-03-17 04:02:39 +0000315Need update.
316<!--
Chris Lattner61358ab2009-10-13 17:48:04 +0000317<a href="http://macruby.org">MacRuby</a> is an implementation of Ruby on top of
318core Mac OS X technologies, such as the Objective-C common runtime and garbage
319collector and the CoreFoundation framework. It is principally developed by
320Apple and aims at enabling the creation of full-fledged Mac OS X applications.
321</p>
322
323<p>
324MacRuby uses LLVM for optimization passes, JIT and AOT compilation of Ruby
325expressions. It also uses zero-cost DWARF exceptions to implement Ruby exception
Chris Lattner0e464a92010-03-17 04:02:39 +0000326handling.--> </p>
Chris Lattner61358ab2009-10-13 17:48:04 +0000327
328</div>
329
330
Chris Lattnerab68e9e2009-02-26 22:33:38 +0000331<!--=========================================================================-->
332<div class="doc_subsection">
333<a name="pure">Pure</a>
334</div>
335
336<div class="doc_text">
337<p>
Chris Lattner917cc712009-03-02 02:37:32 +0000338<a href="http://pure-lang.googlecode.com/">Pure</a>
339is an algebraic/functional programming language based on term rewriting.
Chris Lattnerab68e9e2009-02-26 22:33:38 +0000340Programs are collections of equations which are used to evaluate expressions in
341a symbolic fashion. Pure offers dynamic typing, eager and lazy evaluation,
Mikhail Glushenkovf795ef02009-03-01 18:09:47 +0000342lexical closures, a hygienic macro system (also based on term rewriting),
Chris Lattnerab68e9e2009-02-26 22:33:38 +0000343built-in list and matrix support (including list and matrix comprehensions) and
344an easy-to-use C interface. The interpreter uses LLVM as a backend to
345 JIT-compile Pure programs to fast native code.</p>
346
Chris Lattner477a1fd2010-03-17 17:25:49 +0000347<p>Pure versions 0.43 and later have been tested and are known to work with
348LLVM 2.7 (and continue to work with older LLVM releases >= 2.5).</p>
349
Chris Lattnerab68e9e2009-02-26 22:33:38 +0000350</div>
351
352
353<!--=========================================================================-->
354<div class="doc_subsection">
355<a name="ldc">LLVM D Compiler</a>
356</div>
357
358<div class="doc_text">
359<p>
Chris Lattner0e464a92010-03-17 04:02:39 +0000360Need update.
361<!--
Chris Lattner917cc712009-03-02 02:37:32 +0000362<a href="http://www.dsource.org/projects/ldc">LDC</a> is an implementation of
363the D Programming Language using the LLVM optimizer and code generator.
Chris Lattner61358ab2009-10-13 17:48:04 +0000364The LDC project works great with the LLVM 2.6 release. General improvements in
John Criswell524a5dd2009-03-02 15:28:15 +0000365this
Chris Lattner917cc712009-03-02 02:37:32 +0000366cycle have included new inline asm constraint handling, better debug info
Chris Lattner61358ab2009-10-13 17:48:04 +0000367support, general bug fixes and better x86-64 support. This has allowed
368some major improvements in LDC, getting it much closer to being as
Chris Lattner0e464a92010-03-17 04:02:39 +0000369fully featured as the original DMD compiler from DigitalMars.-->
Chris Lattnerab68e9e2009-02-26 22:33:38 +0000370</p>
371</div>
372
Chris Lattnerbc31caf2009-02-28 18:58:01 +0000373<!--=========================================================================-->
374<div class="doc_subsection">
375<a name="RoadsendPHP">Roadsend PHP</a>
376</div>
377
378<div class="doc_text">
Chris Lattner61358ab2009-10-13 17:48:04 +0000379<p>
380<a href="http://code.roadsend.com/rphp">Roadsend PHP</a> (rphp) is an open
Chris Lattnercade8222009-03-02 19:07:24 +0000381source implementation of the PHP programming
Chris Lattner61358ab2009-10-13 17:48:04 +0000382language that uses LLVM for its optimizer, JIT and static compiler. This is a
Chris Lattner0e464a92010-03-17 04:02:39 +0000383reimplementation of an earlier project that is now based on LLVM.
Chris Lattner477a1fd2010-03-17 17:25:49 +0000384</p>
Chris Lattnerbc31caf2009-02-28 18:58:01 +0000385</div>
Chris Lattnerab68e9e2009-02-26 22:33:38 +0000386
Chris Lattner61358ab2009-10-13 17:48:04 +0000387<!--=========================================================================-->
388<div class="doc_subsection">
389<a name="UnladenSwallow">Unladen Swallow</a>
390</div>
391
392<div class="doc_text">
393<p>
394<a href="http://code.google.com/p/unladen-swallow/">Unladen Swallow</a> is a
395branch of <a href="http://python.org/">Python</a> intended to be fully
396compatible and significantly faster. It uses LLVM's optimization passes and JIT
Chris Lattnerb5f6feb2010-03-18 06:52:15 +0000397compiler.
Chris Lattner0e464a92010-03-17 04:02:39 +0000398</p>
Chris Lattner61358ab2009-10-13 17:48:04 +0000399</div>
400
401<!--=========================================================================-->
402<div class="doc_subsection">
403<a name="llvm-lua">llvm-lua</a>
404</div>
405
406<div class="doc_text">
407<p>
Chris Lattner0e464a92010-03-17 04:02:39 +0000408Need update.
409<!--
Chris Lattner61358ab2009-10-13 17:48:04 +0000410<a href="http://code.google.com/p/llvm-lua/">LLVM-Lua</a> uses LLVM to add JIT
411and static compiling support to the Lua VM. Lua bytecode is analyzed to
412remove type checks, then LLVM is used to compile the bytecode down to machine
Chris Lattner0e464a92010-03-17 04:02:39 +0000413code.-->
414</p>
Chris Lattner61358ab2009-10-13 17:48:04 +0000415</div>
416
417<!--=========================================================================-->
418<div class="doc_subsection">
419<a name="icedtea">IcedTea Java Virtual Machine Implementation</a>
420</div>
421
422<div class="doc_text">
423<p>
Chris Lattner0e464a92010-03-17 04:02:39 +0000424Need update.
425<!--
Chris Lattner61358ab2009-10-13 17:48:04 +0000426<a href="http://icedtea.classpath.org/wiki/Main_Page">IcedTea</a> provides a
427harness to build OpenJDK using only free software build tools and to provide
428replacements for the not-yet free parts of OpenJDK. One of the extensions that
429IcedTea provides is a new JIT compiler named <a
430href="http://icedtea.classpath.org/wiki/ZeroSharkFaq">Shark</a> which uses LLVM
431to provide native code generation without introducing processor-dependent
Chris Lattner0e464a92010-03-17 04:02:39 +0000432code.-->
Chris Lattner61358ab2009-10-13 17:48:04 +0000433</p>
434</div>
435
436
Chris Lattner8d4bbbe2010-03-29 17:50:39 +0000437<!--=========================================================================-->
438<div class="doc_subsection">
439<a name="tce">TTA-based Codesign Environment (TCE)</a>
440</div>
441
442<div class="doc_text">
443<p>
444<a href="http://tce.cs.tut.fi/">TCE</a> is a toolset for designing
445application-specific processors (ASP) based on the Transport triggered
446architecture (TTA). The toolset provides a complete co-design flow from C/C++
447programs down to synthesizable VHDL and parallel program binaries. Processor
448customization points include the register files, function units, supported
449operations, and the interconnection network.</p>
450
451<p>TCE uses llvm-gcc/Clang and LLVM for C/C++ language support, target
452independent optimizations and also for parts of code generation. It generates
453new LLVM-based code generators "on the fly" for the designed TTA processors and
454loads them in to the compiler backend as runtime libraries to avoid per-target
455recompilation of larger parts of the compiler chain.</p>
456
457</div>
Chris Lattner8348b472008-06-08 21:58:17 +0000458
John Criswellf77cdab2010-04-06 14:52:14 +0000459<!--=========================================================================-->
460<div class="doc_subsection">
461<a name="safecode">SAFECode Compiler</a>
462</div>
463
464<div class="doc_text">
465<p>
466<a href="http://safecode.cs.illinois.edu">SAFECode</a> is a memory safe C
467compiler built using LLVM. It takes standard, unannotated C code, analyzes the
468code to ensure that memory accesses and array indexing operations are safe, and
469instruments the code with run-time checks when safety cannot be proven
470statically.
471</p>
472</div>
473
474
Chris Lattner8348b472008-06-08 21:58:17 +0000475<!-- *********************************************************************** -->
476<div class="doc_section">
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000477 <a name="whatsnew">What's New in LLVM 2.7?</a>
Chris Lattner8348b472008-06-08 21:58:17 +0000478</div>
479<!-- *********************************************************************** -->
480
Chris Lattnerf8e0b4e2008-06-08 22:59:35 +0000481<div class="doc_text">
482
Chris Lattner61358ab2009-10-13 17:48:04 +0000483<p>This release includes a huge number of bug fixes, performance tweaks and
Chris Lattnerf6662f92008-10-13 17:57:36 +0000484minor improvements. Some of the major improvements and new features are listed
485in this section.
Chris Lattnerf8e0b4e2008-06-08 22:59:35 +0000486</p>
Chris Lattner61358ab2009-10-13 17:48:04 +0000487
Chris Lattnerf8e0b4e2008-06-08 22:59:35 +0000488</div>
489
Chris Lattner8348b472008-06-08 21:58:17 +0000490<!--=========================================================================-->
Chris Lattnerea34f642008-06-08 21:34:41 +0000491<div class="doc_subsection">
Chris Lattner252b83d2008-02-06 18:00:06 +0000492<a name="majorfeatures">Major New Features</a>
493</div>
494
495<div class="doc_text">
496
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000497<p>LLVM 2.7 includes several major new capabilities:</p>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000498
499<ul>
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000500<li>...</li>
Chris Lattner8170c102008-02-10 08:18:42 +0000501</ul>
502
Chris Lattnerc66bfef2010-03-17 04:41:49 +0000503Extensible metadata solid.
504
505Debug info improvements: using metadata instead of llvm.dbg global variables.
506This brings several enhancements including improved compile times.
507
508New instruction selector.
509GHC Haskell ABI/ calling conv support.
510Pre-Alpha support for unions in IR.
511New InlineHint and StackAlignment function attributes
512Code generator MC'ized except for debug info and EH.
513New SCEV AA pass: -scev-aa
514Inliner reuses arrays allocas when inlining multiple callers to reduce stack usage.
515MC encoding and disassembler apis.
516Optimal Edge Profiling?
517Instcombine is now a library, has its own IRBuilder to simplify itself.
518New llvm/Support/Regex.h API. FileCheck now does regex's
Chris Lattnerdc910082010-03-17 06:41:58 +0000519Many subtle pointer invalidation bugs in Callgraph have been fixed and it now uses asserting value handles.
520MC Disassembler (with blog post), MCInstPrinter. Many X86 backend and AsmPrinter simplifications
521Various tools like llc and opt now read either .ll or .bc files as input.
Chris Lattner8e7f1b12010-03-29 18:42:42 +0000522Malloc and free instructions got removed, along with LowerAllocations pass.
Chris Lattnerdc910082010-03-17 06:41:58 +0000523compiler-rt support for ARM.
524completely llvm-gcc NEON support.
525Can transcode from GAS to intel syntax with "llvm-mc foo.s -output-asm-variant=1"
526JIT debug information with GDB 7.0
Chris Lattnerf04bdc52010-03-17 18:15:52 +0000527New CodeGen Level CSE
Chris Lattnerdc910082010-03-17 06:41:58 +0000528CMake can now run tests, what other improvements?
Chris Lattnerf04bdc52010-03-17 18:15:52 +0000529ARM/Thumb using reg scavenging for stack object address materialization (PEI).
Chris Lattnerdc910082010-03-17 06:41:58 +0000530New SSAUpdater and MachineSSAUpdater classes for unstructured ssa updating,
531 changed jump threading, GVN, etc to use it which simplified them and speed
532 them up.
Chris Lattner15a06112010-03-17 06:42:25 +0000533Combiner-AA improvements, why not on by default?
Chris Lattnerf04bdc52010-03-17 18:15:52 +0000534Pre-regalloc tail duplication
535x86 sibcall optimization
536New LSR with full strength reduction mode
537The most awesome sext / zext optimization pass. ?
538
Chris Lattnerb22060d2010-03-29 18:39:28 +0000539The ARM backend now has good support for ARMv4 backend (tested on StrongARM
540 hardware), previously only supported ARMv4T and newer.
541
Chris Lattnerf04bdc52010-03-17 18:15:52 +0000542
Chris Lattnerc66bfef2010-03-17 04:41:49 +0000543
Chris Lattner8e7f1b12010-03-29 18:42:42 +0000544Defaults to RTTI off, packagers should build with make REQUIRE_RTTI=1.
Chris Lattnerdc910082010-03-17 06:41:58 +0000545CondProp pass removed (functionality merged into jump threading).
Chris Lattnerc66bfef2010-03-17 04:41:49 +0000546AndersAA got removed (from 2.7 or mainline?)
Chris Lattnerdc910082010-03-17 06:41:58 +0000547PredSimplify, LoopVR, GVNPRE got removed.
Chris Lattnerc66bfef2010-03-17 04:41:49 +0000548LLVM command line tools now overwrite their output, before they would only do this with -f.
549DOUT removed, use DEBUG(errs() instead.
550Much stuff converted to use raw_ostream instead of std::ostream.
551TargetAsmInfo renamed to MCAsmInfo
552llvm/ADT/iterator.h gone.
553
Chris Lattnerdc910082010-03-17 06:41:58 +0000554
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000555</div>
556
Chris Lattner84977642007-09-21 03:54:09 +0000557<!--=========================================================================-->
558<div class="doc_subsection">
Chris Lattner917cc712009-03-02 02:37:32 +0000559<a name="coreimprovements">LLVM IR and Core Improvements</a>
Chris Lattnerf304ffc2008-02-10 08:17:19 +0000560</div>
561
562<div class="doc_text">
Chris Lattner61358ab2009-10-13 17:48:04 +0000563<p>LLVM IR has several new features for better support of new targets and that
564expose new optimization opportunities:</p>
Chris Lattnerf304ffc2008-02-10 08:17:19 +0000565
Chris Lattner791f77b2008-06-05 06:25:56 +0000566<ul>
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000567<li>...</li>
Chris Lattnerf304ffc2008-02-10 08:17:19 +0000568</ul>
Mikhail Glushenkovea65d7d2008-10-13 02:08:34 +0000569
Chris Lattnerf304ffc2008-02-10 08:17:19 +0000570</div>
571
572<!--=========================================================================-->
573<div class="doc_subsection">
Chris Lattneracce85d2008-02-10 07:46:44 +0000574<a name="optimizer">Optimizer Improvements</a>
575</div>
576
577<div class="doc_text">
578
Chris Lattner61358ab2009-10-13 17:48:04 +0000579<p>In addition to a large array of minor performance tweaks and bug fixes, this
Chris Lattnerf3013872008-10-13 21:50:36 +0000580release includes a few major enhancements and additions to the optimizers:</p>
Chris Lattneracce85d2008-02-10 07:46:44 +0000581
582<ul>
583
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000584<li>...</li>
Chris Lattner917cc712009-03-02 02:37:32 +0000585
Chris Lattner61358ab2009-10-13 17:48:04 +0000586</ul>
Chris Lattner917cc712009-03-02 02:37:32 +0000587
Chris Lattnerf2201912010-03-01 19:29:17 +0000588<p>Also, -anders-aa was removed</p>
589
Chris Lattner61358ab2009-10-13 17:48:04 +0000590</div>
Chris Lattner917cc712009-03-02 02:37:32 +0000591
Chris Lattner917cc712009-03-02 02:37:32 +0000592
Chris Lattner61358ab2009-10-13 17:48:04 +0000593<!--=========================================================================-->
594<div class="doc_subsection">
595<a name="executionengine">Interpreter and JIT Improvements</a>
596</div>
Chris Lattnerf3013872008-10-13 21:50:36 +0000597
Chris Lattner61358ab2009-10-13 17:48:04 +0000598<div class="doc_text">
599
600<ul>
Jeffrey Yasskin01eba392010-01-29 19:10:38 +0000601<li>The JIT now <a
602href="http://llvm.org/viewvc/llvm-project?view=rev&revision=85295">defaults
603to compiling eagerly</a> to avoid a race condition in the lazy JIT.
604Clients that still want the lazy JIT can switch it on by calling
605<tt>ExecutionEngine::DisableLazyCompilation(false)</tt>.</li>
Jeffrey Yasskin40966a72010-02-11 01:07:39 +0000606<li>It is now possible to create more than one JIT instance in the same process.
607These JITs can generate machine code in parallel,
608although <a href="http://llvm.org/docs/ProgrammersManual.html#jitthreading">you
609still have to obey the other threading restrictions</a>.</li>
Chris Lattner0b832202008-06-08 02:45:07 +0000610</ul>
611
612</div>
613
614<!--=========================================================================-->
615<div class="doc_subsection">
Chris Lattner511433e2009-03-02 03:24:11 +0000616<a name="codegen">Target Independent Code Generator Improvements</a>
Chris Lattner0b832202008-06-08 02:45:07 +0000617</div>
618
619<div class="doc_text">
620
Mikhail Glushenkovf795ef02009-03-01 18:09:47 +0000621<p>We have put a significant amount of work into the code generator
622infrastructure, which allows us to implement more aggressive algorithms and make
623it run faster:</p>
Chris Lattner0b832202008-06-08 02:45:07 +0000624
625<ul>
Chris Lattner511433e2009-03-02 03:24:11 +0000626
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000627<li>...</li>
Chris Lattner84977642007-09-21 03:54:09 +0000628</ul>
Chris Lattner84977642007-09-21 03:54:09 +0000629</div>
630
Chris Lattner917cc712009-03-02 02:37:32 +0000631<!--=========================================================================-->
632<div class="doc_subsection">
633<a name="x86">X86-32 and X86-64 Target Improvements</a>
634</div>
635
636<div class="doc_text">
637<p>New features of the X86 target include:
638</p>
639
640<ul>
Chris Lattner511433e2009-03-02 03:24:11 +0000641
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000642<li>...</li>
Chris Lattner511433e2009-03-02 03:24:11 +0000643
Chris Lattner917cc712009-03-02 02:37:32 +0000644</ul>
645
Chris Lattner917cc712009-03-02 02:37:32 +0000646</div>
Chris Lattner84977642007-09-21 03:54:09 +0000647
648<!--=========================================================================-->
649<div class="doc_subsection">
Chris Lattner11398992009-02-26 07:32:11 +0000650<a name="pic16">PIC16 Target Improvements</a>
651</div>
652
653<div class="doc_text">
654<p>New features of the PIC16 target include:
655</p>
656
657<ul>
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000658<li>...</li>
Chris Lattner11398992009-02-26 07:32:11 +0000659</ul>
660
661<p>Things not yet supported:</p>
662
663<ul>
Chris Lattner11398992009-02-26 07:32:11 +0000664<li>Variable arguments.</li>
Chris Lattner511433e2009-03-02 03:24:11 +0000665<li>Interrupts/programs.</li>
Chris Lattner11398992009-02-26 07:32:11 +0000666</ul>
667
668</div>
669
Chris Lattner11398992009-02-26 07:32:11 +0000670<!--=========================================================================-->
671<div class="doc_subsection">
Chris Lattner61358ab2009-10-13 17:48:04 +0000672<a name="ARM">ARM Target Improvements</a>
Chris Lattnerc441fb82009-03-01 02:30:21 +0000673</div>
674
675<div class="doc_text">
Chris Lattner61358ab2009-10-13 17:48:04 +0000676<p>New features of the ARM target include:
677</p>
Chris Lattnerc441fb82009-03-01 02:30:21 +0000678
679<ul>
Chris Lattnerc441fb82009-03-01 02:30:21 +0000680
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000681<li>...</li>
Chris Lattner61358ab2009-10-13 17:48:04 +0000682</ul>
Chris Lattnerc441fb82009-03-01 02:30:21 +0000683
Chris Lattnerc441fb82009-03-01 02:30:21 +0000684
Chris Lattner61358ab2009-10-13 17:48:04 +0000685</div>
Chris Lattnerc441fb82009-03-01 02:30:21 +0000686
Chris Lattner61358ab2009-10-13 17:48:04 +0000687<!--=========================================================================-->
688<div class="doc_subsection">
689<a name="OtherTarget">Other Target Specific Improvements</a>
690</div>
Chris Lattnerc441fb82009-03-01 02:30:21 +0000691
Chris Lattner61358ab2009-10-13 17:48:04 +0000692<div class="doc_text">
693<p>New features of other targets include:
694</p>
695
696<ul>
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000697<li>...</li>
Chris Lattner61358ab2009-10-13 17:48:04 +0000698</ul>
699
700</div>
701
702<!--=========================================================================-->
703<div class="doc_subsection">
704<a name="newapis">New Useful APIs</a>
705</div>
706
707<div class="doc_text">
708
709<p>This release includes a number of new APIs that are used internally, which
710 may also be useful for external clients.
711</p>
712
713<ul>
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000714<li>...</li>
Chris Lattner61358ab2009-10-13 17:48:04 +0000715</ul>
716
717
718</div>
719
720<!--=========================================================================-->
721<div class="doc_subsection">
722<a name="otherimprovements">Other Improvements and New Features</a>
723</div>
724
725<div class="doc_text">
726<p>Other miscellaneous features include:</p>
727
728<ul>
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000729<li>...</li>
Chris Lattnerc441fb82009-03-01 02:30:21 +0000730</ul>
731
732</div>
733
Chris Lattner77d29b12008-06-05 08:02:49 +0000734
735<!--=========================================================================-->
736<div class="doc_subsection">
Chris Lattnerf6662f92008-10-13 17:57:36 +0000737<a name="changes">Major Changes and Removed Features</a>
738</div>
739
740<div class="doc_text">
741
Chris Lattnereeb4da02008-10-13 22:06:31 +0000742<p>If you're already an LLVM user or developer with out-of-tree changes based
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000743on LLVM 2.6, this section lists some "gotchas" that you may run into upgrading
Chris Lattnereeb4da02008-10-13 22:06:31 +0000744from the previous release.</p>
Chris Lattnerf6662f92008-10-13 17:57:36 +0000745
746<ul>
Jeffrey Yasskinbc83d062010-02-09 23:03:44 +0000747<li>The LLVM interpreter now defaults to <em>not</em> using <tt>libffi</tt> even
748if you have it installed. This makes it more likely that an LLVM built on one
749system will work when copied to a similar system. To use <tt>libffi</tt>,
750configure with <tt>--enable-libffi</tt>.
751</li>
Chris Lattnereeb4da02008-10-13 22:06:31 +0000752</ul>
753
754
755<p>In addition, many APIs have changed in this release. Some of the major LLVM
756API changes are:</p>
757
758<ul>
Jeffrey Yasskin4fcd6072010-01-28 01:41:20 +0000759<li><tt>ModuleProvider</tt> has been <a
760href="http://llvm.org/viewvc/llvm-project?view=rev&revision=94686">removed</a>
761and its methods moved to <tt>Module</tt> and <tt>GlobalValue</tt>.
762Most clients can remove uses of <tt>ExistingModuleProvider</tt>,
763replace <tt>getBitcodeModuleProvider</tt> with
764<tt>getLazyBitcodeModule</tt>, and pass their <tt>Module</tt> to
765functions that used to accept <tt>ModuleProvider</tt>. Clients who
766wrote their own <tt>ModuleProvider</tt>s will need to derive from
767<tt>GVMaterializer</tt> instead and use
768<tt>Module::setMaterializer</tt> to attach it to a
769<tt>Module</tt>.</li>
770
771<li><tt>GhostLinkage</tt> has given up the ghost.
772<tt>GlobalValue</tt>s that have not yet been read from their backing
773storage have the same linkage they will have after being read in.
774Clients must replace calls to
775<tt>GlobalValue::hasNotBeenReadFromBitcode</tt> with
776<tt>GlobalValue::isMaterializable</tt>.</li>
Daniel Dunbar4acdede2010-02-10 04:09:52 +0000777
778<li>FIXME: Debug info has been totally redone. Add pointers to new APIs. Substantial caveats about compatibility of .ll and .bc files.</li>
779
Daniel Dunbarca1c8162010-02-14 01:47:19 +0000780<li>The <tt>llvm/Support/DataTypes.h</tt> header has moved
781to <tt>llvm/System/DataTypes.h</tt>.</li>
782
Duncan Sands411432d2010-02-17 17:20:17 +0000783<li>The <tt>isInteger</tt>, <tt>isIntOrIntVector</tt>, <tt>isFloatingPoint</tt>,
784<tt>isFPOrFPVector</tt> and <tt>isFPOrFPVector</tt> methods have been renamed
785<tt>isIntegerTy</tt>, <tt>isIntOrIntVectorTy</tt>, <tt>isFloatingPointTy</tt>,
786<tt>isFPOrFPVectorTy</tt> and <tt>isFPOrFPVectorTy</tt> respectively.</li>
Devang Patelb34dd132008-10-14 20:03:43 +0000787</ul>
Chris Lattnerf6662f92008-10-13 17:57:36 +0000788
Chris Lattnerf6662f92008-10-13 17:57:36 +0000789</div>
790
791
792
Chris Lattner19092612003-10-02 16:38:05 +0000793<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000794<div class="doc_section">
795 <a name="portability">Portability and Supported Platforms</a>
796</div>
Chris Lattner19092612003-10-02 16:38:05 +0000797<!-- *********************************************************************** -->
798
Misha Brukman500bc302003-11-22 00:38:41 +0000799<div class="doc_text">
800
John Criswell0b5b5e92004-12-08 20:35:47 +0000801<p>LLVM is known to work on the following platforms:</p>
Chris Lattner4654bdb2004-06-01 18:22:41 +0000802
803<ul>
Mikhail Glushenkovf795ef02009-03-01 18:09:47 +0000804<li>Intel and AMD machines (IA32, X86-64, AMD64, EMT-64) running Red Hat
Chris Lattner61358ab2009-10-13 17:48:04 +0000805 Linux, Fedora Core, FreeBSD and AuroraUX (and probably other unix-like
806 systems).</li>
Mikhail Glushenkovf795ef02009-03-01 18:09:47 +0000807<li>PowerPC and X86-based Mac OS X systems, running 10.3 and above in 32-bit
Chris Lattner61358ab2009-10-13 17:48:04 +0000808 and 64-bit modes.</li>
Chris Lattner252b83d2008-02-06 18:00:06 +0000809<li>Intel and AMD machines running on Win32 using MinGW libraries (native).</li>
Chris Lattner57a460e2007-05-23 04:39:32 +0000810<li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
811 support is available for native builds with Visual C++).</li>
Chris Lattner7e23d6e2009-10-16 16:30:58 +0000812<li>Sun x86 and AMD64 machines running Solaris 10, OpenSolaris 0906.</li>
John Criswell9321fa82005-05-13 20:28:15 +0000813<li>Alpha-based machines running Debian GNU/Linux.</li>
Chris Lattner4654bdb2004-06-01 18:22:41 +0000814</ul>
815
Chris Lattnerbc5786b2008-06-05 06:57:39 +0000816<p>The core LLVM infrastructure uses GNU autoconf to adapt itself
Brian Gaekeb0fd7612004-05-09 05:28:35 +0000817to the machine and operating system on which it is built. However, minor
818porting may be required to get LLVM to work on new platforms. We welcome your
819portability patches and reports of successful builds or error messages.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000820
Misha Brukman500bc302003-11-22 00:38:41 +0000821</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000822
823<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000824<div class="doc_section">
825 <a name="knownproblems">Known Problems</a>
826</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000827<!-- *********************************************************************** -->
828
Misha Brukman500bc302003-11-22 00:38:41 +0000829<div class="doc_text">
830
Mikhail Glushenkovf795ef02009-03-01 18:09:47 +0000831<p>This section contains significant known problems with the LLVM system,
Chris Lattnere18b32e2008-11-10 05:40:34 +0000832listed by component. If you run into a problem, please check the <a
Chris Lattnerc463b272005-10-29 07:07:09 +0000833href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
Chris Lattner5eccca42003-12-12 21:22:16 +0000834there isn't already one.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000835
Chris Lattner477a1fd2010-03-17 17:25:49 +0000836<ul>
Chris Lattner61358ab2009-10-13 17:48:04 +0000837<li>LLVM will not correctly compile on Solaris and/or OpenSolaris
838using the stock GCC 3.x.x series 'out the box',
Chris Lattner554ee4a2009-11-03 21:50:09 +0000839See: <a href="GettingStarted.html#brokengcc">Broken versions of GCC and other tools</a>.
Chris Lattner61358ab2009-10-13 17:48:04 +0000840However, A <a href="http://pkg.auroraux.org/GCC">Modern GCC Build</a>
841for x86/x86-64 has been made available from the third party AuroraUX Project
842that has been meticulously tested for bootstrapping LLVM &amp; Clang.</li>
843</ul>
844
Misha Brukman500bc302003-11-22 00:38:41 +0000845</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000846
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000847<!-- ======================================================================= -->
848<div class="doc_subsection">
849 <a name="experimental">Experimental features included with this release</a>
850</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000851
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000852<div class="doc_text">
853
Misha Brukman6df9e2c2004-05-12 21:46:05 +0000854<p>The following components of this LLVM release are either untested, known to
855be broken or unreliable, or are in early development. These components should
856not be relied on, and bugs should not be filed against them, but they may be
857useful to some people. In particular, if you would like to work on one of these
Chris Lattner2b659ef2008-02-12 06:29:45 +0000858components, please contact us on the <a
859href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p>
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000860
861<ul>
Wesley Peck7c4a1212010-03-18 14:31:30 +0000862<li>The MSIL, Alpha, SPU, MIPS, PIC16, Blackfin, MSP430, SystemZ and MicroBlaze
863 backends are experimental.</li>
Bill Wendling99dac472009-03-02 07:54:14 +0000864<li>The <tt>llc</tt> "<tt>-filetype=asm</tt>" (the default) is the only
Chris Lattnerc66bfef2010-03-17 04:41:49 +0000865 supported value for this option. The MachO writer is experimental, and
866 works much better in mainline SVN.</li>
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000867</ul>
868
869</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000870
Misha Brukman500bc302003-11-22 00:38:41 +0000871<!-- ======================================================================= -->
872<div class="doc_subsection">
Chris Lattner26299222006-11-18 07:51:14 +0000873 <a name="x86-be">Known problems with the X86 back-end</a>
John Criswellc0c186d2005-11-08 21:11:33 +0000874</div>
875
876<div class="doc_text">
877
878<ul>
Anton Korobeynikova6094be2008-06-08 10:24:13 +0000879 <li>The X86 backend does not yet support
880 all <a href="http://llvm.org/PR879">inline assembly that uses the X86
881 floating point stack</a>. It supports the 'f' and 't' constraints, but not
882 'u'.</li>
Chris Lattnere6e1b352008-06-08 21:19:07 +0000883 <li>The X86 backend generates inefficient floating point code when configured
884 to generate code for systems that don't have SSE2.</li>
Duncan Sands47eff2b2008-06-08 19:38:43 +0000885 <li>Win64 code generation wasn't widely tested. Everything should work, but we
John Criswell524a5dd2009-03-02 15:28:15 +0000886 expect small issues to happen. Also, llvm-gcc cannot build the mingw64
887 runtime currently due
Anton Korobeynikova6094be2008-06-08 10:24:13 +0000888 to <a href="http://llvm.org/PR2255">several</a>
John Criswell524a5dd2009-03-02 15:28:15 +0000889 <a href="http://llvm.org/PR2257">bugs</a> and due to lack of support for
890 the
891 'u' inline assembly constraint and for X87 floating point inline assembly.</li>
Dan Gohman8207ba92008-06-08 23:05:11 +0000892 <li>The X86-64 backend does not yet support the LLVM IR instruction
Chris Lattner917cc712009-03-02 02:37:32 +0000893 <tt>va_arg</tt>. Currently, the llvm-gcc and front-ends support variadic
Dan Gohman8207ba92008-06-08 23:05:11 +0000894 argument constructs on X86-64 by lowering them manually.</li>
Chris Lattner26299222006-11-18 07:51:14 +0000895</ul>
896
897</div>
898
899<!-- ======================================================================= -->
900<div class="doc_subsection">
901 <a name="ppc-be">Known problems with the PowerPC back-end</a>
902</div>
903
904<div class="doc_text">
905
906<ul>
Nicolas Geoffraye4285dc2007-05-15 09:21:28 +0000907<li>The Linux PPC32/ABI support needs testing for the interpreter and static
Chris Lattner57a460e2007-05-23 04:39:32 +0000908compilation, and lacks support for debug information.</li>
Chris Lattner26299222006-11-18 07:51:14 +0000909</ul>
910
911</div>
912
913<!-- ======================================================================= -->
914<div class="doc_subsection">
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000915 <a name="arm-be">Known problems with the ARM back-end</a>
916</div>
917
918<div class="doc_text">
919
920<ul>
Chris Lattner61358ab2009-10-13 17:48:04 +0000921<li>Support for the Advanced SIMD (Neon) instruction set is still incomplete
922and not well tested. Some features may not work at all, and the code quality
923may be poor in some cases.</li>
Chris Lattner57a460e2007-05-23 04:39:32 +0000924<li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
Duncan Sandsc90d68b2007-09-26 15:59:54 +0000925processors, thumb programs can crash or produce wrong
Chris Lattner57a460e2007-05-23 04:39:32 +0000926results (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
John Criswell524a5dd2009-03-02 15:28:15 +0000927<li>Compilation for ARM Linux OABI (old ABI) is supported but not fully tested.
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000928</li>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000929</ul>
930
931</div>
932
933<!-- ======================================================================= -->
934<div class="doc_subsection">
Chris Lattner26299222006-11-18 07:51:14 +0000935 <a name="sparc-be">Known problems with the SPARC back-end</a>
936</div>
937
938<div class="doc_text">
939
940<ul>
John Criswell524a5dd2009-03-02 15:28:15 +0000941<li>The SPARC backend only supports the 32-bit SPARC ABI (-m32); it does not
Chris Lattner26299222006-11-18 07:51:14 +0000942 support the 64-bit SPARC ABI (-m64).</li>
943</ul>
944
945</div>
946
947<!-- ======================================================================= -->
948<div class="doc_subsection">
Bruno Cardoso Lopesb7e1a4f2008-10-25 14:56:26 +0000949 <a name="mips-be">Known problems with the MIPS back-end</a>
950</div>
951
952<div class="doc_text">
953
954<ul>
Bruno Cardoso Lopesb7e1a4f2008-10-25 14:56:26 +0000955<li>64-bit MIPS targets are not supported yet.</li>
956</ul>
957
958</div>
959
960<!-- ======================================================================= -->
961<div class="doc_subsection">
Chris Lattner26299222006-11-18 07:51:14 +0000962 <a name="alpha-be">Known problems with the Alpha back-end</a>
963</div>
964
965<div class="doc_text">
966
967<ul>
968
969<li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
970appropriate nops inserted to ensure restartability.</li>
971
John Criswellc0c186d2005-11-08 21:11:33 +0000972</ul>
973</div>
974
Chris Lattner26299222006-11-18 07:51:14 +0000975<!-- ======================================================================= -->
976<div class="doc_subsection">
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000977 <a name="c-be">Known problems with the C back-end</a>
Chris Lattner26299222006-11-18 07:51:14 +0000978</div>
979
980<div class="doc_text">
981
982<ul>
Chris Lattner5733b272008-06-05 06:35:40 +0000983<li><a href="http://llvm.org/PR802">The C backend has only basic support for
984 inline assembly code</a>.</li>
Chris Lattner725a0d82007-09-26 06:01:35 +0000985<li><a href="http://llvm.org/PR1658">The C backend violates the ABI of common
986 C++ programs</a>, preventing intermixing between C++ compiled by the CBE and
Gabor Greif4906abe2009-03-02 12:02:51 +0000987 C++ code compiled with <tt>llc</tt> or native compilers.</li>
Duncan Sandsf74c0cc2008-02-10 13:40:55 +0000988<li>The C backend does not support all exception handling constructs.</li>
Duncan Sands50723a92009-02-25 11:51:54 +0000989<li>The C backend does not support arbitrary precision integers.</li>
Chris Lattner26299222006-11-18 07:51:14 +0000990</ul>
991
992</div>
John Criswellc0c186d2005-11-08 21:11:33 +0000993
Misha Brukman500bc302003-11-22 00:38:41 +0000994
995<!-- ======================================================================= -->
996<div class="doc_subsection">
Chris Lattnerc66bfef2010-03-17 04:41:49 +0000997 <a name="c-fe">Known problems with the llvm-gcc C and C++ front-end</a>
Misha Brukman500bc302003-11-22 00:38:41 +0000998</div>
Chris Lattner47588f92003-10-02 05:07:23 +0000999
Misha Brukman500bc302003-11-22 00:38:41 +00001000<div class="doc_text">
Chris Lattnerc5d658a2006-03-03 00:34:26 +00001001
Chris Lattner5733b272008-06-05 06:35:40 +00001002<p>The only major language feature of GCC not supported by llvm-gcc is
1003 the <tt>__builtin_apply</tt> family of builtins. However, some extensions
1004 are only supported on some targets. For example, trampolines are only
Duncan Sands27aff872008-06-08 20:18:35 +00001005 supported on some targets (these are used when you take the address of a
1006 nested function).</p>
Misha Brukman500bc302003-11-22 00:38:41 +00001007
Chris Lattner5733b272008-06-05 06:35:40 +00001008<p>If you run into GCC extensions which are not supported, please let us know.
1009</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +00001010
Misha Brukman500bc302003-11-22 00:38:41 +00001011</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +00001012
Misha Brukman500bc302003-11-22 00:38:41 +00001013<!-- ======================================================================= -->
1014<div class="doc_subsection">
Chris Lattner1eb4df62008-10-30 03:58:13 +00001015 <a name="fortran-fe">Known problems with the llvm-gcc Fortran front-end</a>
1016</div>
1017
1018<div class="doc_text">
Gabor Greifba10fe02008-11-04 21:50:59 +00001019<ul>
Chris Lattner1eb4df62008-10-30 03:58:13 +00001020<li>Fortran support generally works, but there are still several unresolved bugs
Chris Lattner61358ab2009-10-13 17:48:04 +00001021 in <a href="http://llvm.org/bugs/">Bugzilla</a>. Please see the
1022 tools/gfortran component for details.</li>
Gabor Greifba10fe02008-11-04 21:50:59 +00001023</ul>
Chris Lattner1eb4df62008-10-30 03:58:13 +00001024</div>
Misha Brukman500bc302003-11-22 00:38:41 +00001025
Chris Lattner2b659ef2008-02-12 06:29:45 +00001026<!-- ======================================================================= -->
1027<div class="doc_subsection">
Chris Lattner5733b272008-06-05 06:35:40 +00001028 <a name="ada-fe">Known problems with the llvm-gcc Ada front-end</a>
Chris Lattner2b659ef2008-02-12 06:29:45 +00001029</div>
1030
1031<div class="doc_text">
John Criswell524a5dd2009-03-02 15:28:15 +00001032The llvm-gcc 4.2 Ada compiler works fairly well; however, this is not a mature
1033technology, and problems should be expected.
Chris Lattner2b659ef2008-02-12 06:29:45 +00001034<ul>
Duncan Sands27aff872008-06-08 20:18:35 +00001035<li>The Ada front-end currently only builds on X86-32. This is mainly due
John Criswell524a5dd2009-03-02 15:28:15 +00001036to lack of trampoline support (pointers to nested functions) on other platforms.
1037However, it <a href="http://llvm.org/PR2006">also fails to build on X86-64</a>
Chris Lattner2b659ef2008-02-12 06:29:45 +00001038which does support trampolines.</li>
1039<li>The Ada front-end <a href="http://llvm.org/PR2007">fails to bootstrap</a>.
Duncan Sands326a4982009-02-25 11:59:06 +00001040This is due to lack of LLVM support for <tt>setjmp</tt>/<tt>longjmp</tt> style
1041exception handling, which is used internally by the compiler.
Chris Lattner61358ab2009-10-13 17:48:04 +00001042Workaround: configure with <tt>--disable-bootstrap</tt>.</li>
Duncan Sands978bcee2008-10-13 17:27:23 +00001043<li>The c380004, <a href="http://llvm.org/PR2010">c393010</a>
1044and <a href="http://llvm.org/PR2421">cxg2021</a> ACATS tests fail
Duncan Sands326a4982009-02-25 11:59:06 +00001045(c380004 also fails with gcc-4.2 mainline).
1046If the compiler is built with checks disabled then <a href="http://llvm.org/PR2010">c393010</a>
1047causes the compiler to go into an infinite loop, using up all system memory.</li>
Duncan Sandsdd3e6722009-03-02 16:35:57 +00001048<li>Some GCC specific Ada tests continue to crash the compiler.</li>
Chris Lattner61358ab2009-10-13 17:48:04 +00001049<li>The <tt>-E</tt> binder option (exception backtraces)
Chris Lattner2b659ef2008-02-12 06:29:45 +00001050<a href="http://llvm.org/PR1982">does not work</a> and will result in programs
Chris Lattner61358ab2009-10-13 17:48:04 +00001051crashing if an exception is raised. Workaround: do not use <tt>-E</tt>.</li>
Chris Lattner2b659ef2008-02-12 06:29:45 +00001052<li>Only discrete types <a href="http://llvm.org/PR1981">are allowed to start
1053or finish at a non-byte offset</a> in a record. Workaround: do not pack records
1054or use representation clauses that result in a field of a non-discrete type
1055starting or finishing in the middle of a byte.</li>
Chris Lattnere6e1b352008-06-08 21:19:07 +00001056<li>The <tt>lli</tt> interpreter <a href="http://llvm.org/PR2009">considers
1057'main' as generated by the Ada binder to be invalid</a>.
1058Workaround: hand edit the file to use pointers for <tt>argv</tt> and
1059<tt>envp</tt> rather than integers.</li>
1060<li>The <tt>-fstack-check</tt> option <a href="http://llvm.org/PR2008">is
1061ignored</a>.</li>
Chris Lattner2b659ef2008-02-12 06:29:45 +00001062</ul>
1063</div>
1064
Chris Lattner79c3fe12003-10-02 04:57:28 +00001065<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +00001066<div class="doc_section">
1067 <a name="additionalinfo">Additional Information</a>
1068</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +00001069<!-- *********************************************************************** -->
1070
Misha Brukman500bc302003-11-22 00:38:41 +00001071<div class="doc_text">
1072
Chris Lattner416db102005-05-16 17:13:10 +00001073<p>A wide variety of additional information is available on the <a
Chris Lattnerb4b0ce72007-05-18 00:44:29 +00001074href="http://llvm.org">LLVM web page</a>, in particular in the <a
1075href="http://llvm.org/docs/">documentation</a> section. The web page also
Reid Spencer669ed452007-07-09 08:04:31 +00001076contains versions of the API documentation which is up-to-date with the
1077Subversion version of the source code.
Misha Brukman109d9e82005-03-30 19:14:24 +00001078You can access versions of these documents specific to this release by going
1079into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +00001080
Misha Brukman500bc302003-11-22 00:38:41 +00001081<p>If you have any questions or comments about LLVM, please feel free to contact
Chris Lattnerc463b272005-10-29 07:07:09 +00001082us via the <a href="http://llvm.org/docs/#maillist"> mailing
Chris Lattner5eccca42003-12-12 21:22:16 +00001083lists</a>.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +00001084
Misha Brukman500bc302003-11-22 00:38:41 +00001085</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +00001086
1087<!-- *********************************************************************** -->
Chris Lattner79c3fe12003-10-02 04:57:28 +00001088
Misha Brukman500bc302003-11-22 00:38:41 +00001089<hr>
Misha Brukman2061e892003-11-22 01:23:39 +00001090<address>
Misha Brukman38847d52003-12-21 22:53:21 +00001091 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman44408702008-12-11 17:34:48 +00001092 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
Misha Brukman2061e892003-11-22 01:23:39 +00001093 <a href="http://validator.w3.org/check/referer"><img
Misha Brukman44408702008-12-11 17:34:48 +00001094 src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
Misha Brukman2061e892003-11-22 01:23:39 +00001095
Chris Lattnerb4b0ce72007-05-18 00:44:29 +00001096 <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
Misha Brukman500bc302003-11-22 00:38:41 +00001097 Last modified: $Date$
Misha Brukman2061e892003-11-22 01:23:39 +00001098</address>
Chris Lattner79c3fe12003-10-02 04:57:28 +00001099
Misha Brukman500bc302003-11-22 00:38:41 +00001100</body>
1101</html>