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