blob: 84200c3b7275218df378b56133ac4c1da643e945 [file] [log] [blame]
Misha Brukman80731b92003-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 Spencere4190fa2004-11-18 18:38:58 +00005 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
Misha Brukman80731b92003-11-22 00:38:41 +00006 <link rel="stylesheet" href="llvm.css" type="text/css">
Jeffrey Yasskin0830b972010-01-28 01:14:43 +00007 <title>LLVM 2.7 Release Notes</title>
Misha Brukman80731b92003-11-22 00:38:41 +00008</head>
9<body>
Chris Lattner3d482502003-10-02 04:57:28 +000010
Jeffrey Yasskin0830b972010-01-28 01:14:43 +000011<div class="doc_title">LLVM 2.7 Release Notes</div>
Mikhail Glushenkov024f7cf2008-10-13 02:08:34 +000012
Chris Lattner3d482502003-10-02 04:57:28 +000013<ol>
Misha Brukman80731b92003-11-22 00:38:41 +000014 <li><a href="#intro">Introduction</a></li>
Chris Lattnerf5cd9862008-10-13 18:01:01 +000015 <li><a href="#subproj">Sub-project Status Update</a></li>
Jeffrey Yasskin0830b972010-01-28 01:14:43 +000016 <li><a href="#externalproj">External Projects Using LLVM 2.7</a></li>
17 <li><a href="#whatsnew">What's New in LLVM 2.7?</a></li>
Chris Lattner77a51732004-04-30 22:17:12 +000018 <li><a href="GettingStarted.html">Installation Instructions</a></li>
Misha Brukman80731b92003-11-22 00:38:41 +000019 <li><a href="#portability">Portability and Supported Platforms</a></li>
Dan Gohmanad888912008-10-14 16:23:02 +000020 <li><a href="#knownproblems">Known Problems</a></li>
Misha Brukman80731b92003-11-22 00:38:41 +000021 <li><a href="#additionalinfo">Additional Information</a></li>
Chris Lattner3d482502003-10-02 04:57:28 +000022</ol>
23
Chris Lattner020e1fc2004-05-23 21:07:27 +000024<div class="doc_author">
Dan Gohmanad888912008-10-14 16:23:02 +000025 <p>Written by the <a href="http://llvm.org">LLVM Team</a></p>
Misha Brukman80731b92003-11-22 00:38:41 +000026</div>
Chris Lattner3d482502003-10-02 04:57:28 +000027
Jeffrey Yasskin0830b972010-01-28 01:14:43 +000028<h1 style="color:red">These are in-progress notes for the upcoming LLVM 2.7
29release.<br>
30You may prefer the
31<a href="http://llvm.org/releases/2.6/docs/ReleaseNotes.html">LLVM 2.6
32Release Notes</a>.</h1>
33
Chris Lattner3d482502003-10-02 04:57:28 +000034<!-- *********************************************************************** -->
Misha Brukman80731b92003-11-22 00:38:41 +000035<div class="doc_section">
36 <a name="intro">Introduction</a>
37</div>
Chris Lattner3d482502003-10-02 04:57:28 +000038<!-- *********************************************************************** -->
39
Misha Brukman80731b92003-11-22 00:38:41 +000040<div class="doc_text">
41
Chris Lattner1e4d5bc2008-10-13 17:57:36 +000042<p>This document contains the release notes for the LLVM Compiler
Jeffrey Yasskin0830b972010-01-28 01:14:43 +000043Infrastructure, release 2.7. Here we describe the status of LLVM, including
Chris Lattner1e4d5bc2008-10-13 17:57:36 +000044major improvements from the previous release and significant known problems.
Mikhail Glushenkov25422542009-03-01 18:09:47 +000045All LLVM releases may be downloaded from the <a
Chris Lattner1e4d5bc2008-10-13 17:57:36 +000046href="http://llvm.org/releases/">LLVM releases web site</a>.</p>
Chris Lattner62495762003-10-02 16:38:05 +000047
Chris Lattnerb5bb5972004-12-07 08:04:13 +000048<p>For more information about LLVM, including information about the latest
Chris Lattnera69595e2005-10-29 07:07:09 +000049release, please check out the <a href="http://llvm.org/">main LLVM
Chris Lattnere7525b52003-10-07 21:38:31 +000050web site</a>. If you have questions or comments, the <a
Chris Lattner1e4d5bc2008-10-13 17:57:36 +000051href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM Developer's Mailing
52List</a> is a good place to send them.</p>
Chris Lattner3d482502003-10-02 04:57:28 +000053
Mikhail Glushenkov024f7cf2008-10-13 02:08:34 +000054<p>Note that if you are reading this file from a Subversion checkout or the
Chris Lattner0a1fd102007-09-21 03:54:09 +000055main LLVM web page, this document applies to the <i>next</i> release, not the
Gabor Greif355f81c2008-10-14 11:00:32 +000056current one. To see the release notes for a specific release, please see the
Chris Lattner0a1fd102007-09-21 03:54:09 +000057<a href="http://llvm.org/releases/">releases page</a>.</p>
Misha Brukman80731b92003-11-22 00:38:41 +000058
59</div>
Chris Lattneraa61f412009-10-13 17:48:04 +000060
Chris Lattner3d482502003-10-02 04:57:28 +000061
Chris Lattneraa61f412009-10-13 17:48:04 +000062<!--
63Almost dead code.
64 include/llvm/Analysis/LiveValues.h => Dan
65 lib/Transforms/IPO/MergeFunctions.cpp => consider for 2.8.
66 llvm/Analysis/PointerTracking.h => Edwin wants this, consider for 2.8.
Chris Lattner2bfa1672010-01-09 22:30:40 +000067 ABCD, SCCVN, GEPSplitterPass
Chris Lattner89ea59d2010-01-16 21:25:13 +000068 MSIL backend?
Chris Lattner5cc165c2010-02-28 18:57:59 +000069 AndersAA -> Unsupported, zap after branch.
Chris Lattneraa61f412009-10-13 17:48:04 +000070-->
71
72
Jeffrey Yasskin0830b972010-01-28 01:14:43 +000073<!-- Features that need text if they're finished for 2.7:
Chris Lattneraa61f412009-10-13 17:48:04 +000074 gcc plugin.
75 strong phi elim
76 variable debug info for optimized code
Chris Lattner53e06f92009-02-26 22:33:38 +000077 postalloc scheduler: anti dependence breaking, hazard recognizer?
Chris Lattneraa61f412009-10-13 17:48:04 +000078 metadata
79 loop dependence analysis
80 ELF Writer? How stable?
81 <li>PostRA scheduler improvements, ARM adoption (David Goodwin).</li>
82 2.7 supports the GDB 7.0 jit interfaces for debug info.
83 2.7 eliminates ADT/iterator.h
Chris Lattner2b8a52e2008-02-10 07:46:44 +000084 -->
Mikhail Glushenkov024f7cf2008-10-13 02:08:34 +000085
Chris Lattnerc4d68542008-10-12 19:47:48 +000086 <!-- for announcement email:
Chris Lattneraa61f412009-10-13 17:48:04 +000087 Logo web page.
88 llvm devmtg
89 compiler_rt
90 KLEE web page at klee.llvm.org
91 Many new papers added to /pubs/
92 Mention gcc plugin.
93
Chris Lattnerd02da042009-02-25 06:34:50 +000094 -->
Chris Lattner2b8a52e2008-02-10 07:46:44 +000095
Chris Lattnerf5cd9862008-10-13 18:01:01 +000096<!-- *********************************************************************** -->
97<div class="doc_section">
98 <a name="subproj">Sub-project Status Update</a>
Chris Lattner625a3d82008-06-08 21:34:41 +000099</div>
Chris Lattnerf5cd9862008-10-13 18:01:01 +0000100<!-- *********************************************************************** -->
Chris Lattner625a3d82008-06-08 21:34:41 +0000101
102<div class="doc_text">
Chris Lattnerc75fd522008-06-08 21:58:17 +0000103<p>
Jeffrey Yasskin0830b972010-01-28 01:14:43 +0000104The LLVM 2.7 distribution currently consists of code from the core LLVM
Chris Lattneraa61f412009-10-13 17:48:04 +0000105repository (which roughly includes the LLVM optimizers, code generators
106and supporting tools), the Clang repository and the llvm-gcc repository. In
107addition to this code, the LLVM Project includes other sub-projects that are in
108development. Here we include updates on these subprojects.
Bill Wendlingf170d2e2009-03-02 04:28:57 +0000109</p>
Chris Lattnerf5cd9862008-10-13 18:01:01 +0000110
Chris Lattnerc75fd522008-06-08 21:58:17 +0000111</div>
112
Chris Lattnerf5cd9862008-10-13 18:01:01 +0000113
Chris Lattnerc75fd522008-06-08 21:58:17 +0000114<!--=========================================================================-->
Chris Lattnerf5cd9862008-10-13 18:01:01 +0000115<div class="doc_subsection">
Chris Lattner44c09cd2008-10-13 18:11:54 +0000116<a name="clang">Clang: C/C++/Objective-C Frontend Toolkit</a>
Chris Lattnerc75fd522008-06-08 21:58:17 +0000117</div>
118
119<div class="doc_text">
120
Jeffrey Yasskin0830b972010-01-28 01:14:43 +0000121<p>The <a href="http://clang.llvm.org/">Clang project</a> is ...</p>
Chris Lattneraa61f412009-10-13 17:48:04 +0000122
Jeffrey Yasskin0830b972010-01-28 01:14:43 +0000123<p>In the LLVM 2.7 time-frame, the Clang team has made many improvements:</p>
Bill Wendlingef362462008-10-27 09:27:33 +0000124
Daniel Dunbarc11b40f2008-10-14 23:25:09 +0000125<ul>
Jeffrey Yasskin0830b972010-01-28 01:14:43 +0000126<li>...</li>
Bill Wendling87adbe42009-03-02 04:28:18 +0000127</ul>
Chris Lattner44c09cd2008-10-13 18:11:54 +0000128</div>
129
130<!--=========================================================================-->
131<div class="doc_subsection">
132<a name="clangsa">Clang Static Analyzer</a>
133</div>
134
135<div class="doc_text">
136
Jeffrey Yasskin0830b972010-01-28 01:14:43 +0000137<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 +0000138includes an early stage static source code analysis tool for <a
139href="http://clang.llvm.org/StaticAnalysis.html">automatically finding bugs</a>
Chris Lattneraa61f412009-10-13 17:48:04 +0000140in C and Objective-C programs. The tool performs checks to find
Ted Kremenekc11fae82009-02-27 07:01:32 +0000141bugs that occur on a specific path within a program.</p>
Chris Lattnerbcffa5a2008-10-14 00:52:49 +0000142
Jeffrey Yasskin0830b972010-01-28 01:14:43 +0000143<p>In the LLVM 2.7 time-frame, the analyzer core has ...</p>
Chris Lattnerc75fd522008-06-08 21:58:17 +0000144
145</div>
146
Chris Lattnerf5cd9862008-10-13 18:01:01 +0000147<!--=========================================================================-->
148<div class="doc_subsection">
Nicolas Geoffraye5ec9322008-10-14 19:23:04 +0000149<a name="vmkit">VMKit: JVM/CLI Virtual Machine Implementation</a>
Chris Lattnerf5cd9862008-10-13 18:01:01 +0000150</div>
151
152<div class="doc_text">
153<p>
Nicolas Geoffraye5ec9322008-10-14 19:23:04 +0000154The <a href="http://vmkit.llvm.org/">VMKit project</a> is an implementation of
Chris Lattneraa61f412009-10-13 17:48:04 +0000155a JVM and a CLI Virtual Machine (Microsoft .NET is an
156implementation of the CLI) using LLVM for static and just-in-time
157compilation.</p>
Chris Lattnerf5cd9862008-10-13 18:01:01 +0000158
Chris Lattneraa61f412009-10-13 17:48:04 +0000159<p>
Jeffrey Yasskin0830b972010-01-28 01:14:43 +0000160VMKit version ?? builds with LLVM 2.7 and you can find it on its
Chris Lattneraa61f412009-10-13 17:48:04 +0000161<a href="http://vmkit.llvm.org/releases/">web page</a>. The release includes
Nicolas Geoffray54efd492008-10-15 20:25:04 +0000162bug fixes, cleanup and new features. The major changes are:</p>
Chris Lattnerf5cd9862008-10-13 18:01:01 +0000163
Nicolas Geoffraye5ec9322008-10-14 19:23:04 +0000164<ul>
165
Jeffrey Yasskin0830b972010-01-28 01:14:43 +0000166<li>...</li>
Nicolas Geoffraye5ec9322008-10-14 19:23:04 +0000167
168</ul>
Chris Lattnerf5cd9862008-10-13 18:01:01 +0000169</div>
170
Chris Lattneraa61f412009-10-13 17:48:04 +0000171
172<!--=========================================================================-->
173<div class="doc_subsection">
174<a name="compiler-rt">compiler-rt: Compiler Runtime Library</a>
175</div>
176
177<div class="doc_text">
178<p>
179The new LLVM <a href="http://compiler-rt.llvm.org/">compiler-rt project</a>
180is a simple library that provides an implementation of the low-level
181target-specific hooks required by code generation and other runtime components.
182For example, when compiling for a 32-bit target, converting a double to a 64-bit
183unsigned integer is compiled into a runtime call to the "__fixunsdfdi"
184function. The compiler-rt library provides highly optimized implementations of
185this and other low-level routines (some are 3x faster than the equivalent
186libgcc routines).</p>
187
188<p>
189All of the code in the compiler-rt project is available under the standard LLVM
190License, a "BSD-style" license.</p>
191
192</div>
193
194<!--=========================================================================-->
195<div class="doc_subsection">
196<a name="klee">KLEE: Symbolic Execution and Automatic Test Case Generator</a>
197</div>
198
199<div class="doc_text">
200<p>
201The new LLVM <a href="http://klee.llvm.org/">KLEE project</a> is a symbolic
202execution framework for programs in LLVM bitcode form. KLEE tries to
203symbolically evaluate "all" paths through the application and records state
204transitions that lead to fault states. This allows it to construct testcases
205that lead to faults and can even be used to verify algorithms. For more
206details, please see the <a
207href="http://llvm.org/pubs/2008-12-OSDI-KLEE.html">OSDI 2008 paper</a> about
208KLEE.</p>
209
210</div>
211
212<!--=========================================================================-->
213<div class="doc_subsection">
214<a name="dragonegg">DragonEgg: GCC-4.5 as an LLVM frontend</a>
215</div>
216
217<div class="doc_text">
218<p>
219The goal of <a href="http://dragonegg.llvm.org/">DragonEgg</a> is to make
220gcc-4.5 act like llvm-gcc without requiring any gcc modifications whatsoever.
Duncan Sands100d0e3c2009-10-15 08:17:44 +0000221<a href="http://dragonegg.llvm.org/">DragonEgg</a> is a shared library (dragonegg.so)
Jeffrey Yasskin0830b972010-01-28 01:14:43 +0000222that is loaded by gcc at runtime. It ...
Chris Lattneraa61f412009-10-13 17:48:04 +0000223</p>
224
225</div>
226
227
228<!--=========================================================================-->
229<div class="doc_subsection">
230<a name="mc">llvm-mc: Machine Code Toolkit</a>
231</div>
232
233<div class="doc_text">
234<p>
Jeffrey Yasskin0830b972010-01-28 01:14:43 +0000235The LLVM Machine Code (MC) Toolkit project is ...
Chris Lattneraa61f412009-10-13 17:48:04 +0000236</p>
237
238</div>
239
240
Chris Lattner53e06f92009-02-26 22:33:38 +0000241<!-- *********************************************************************** -->
242<div class="doc_section">
Jeffrey Yasskin0830b972010-01-28 01:14:43 +0000243 <a name="externalproj">External Open Source Projects Using LLVM 2.7</a>
Chris Lattner53e06f92009-02-26 22:33:38 +0000244</div>
245<!-- *********************************************************************** -->
246
Chris Lattneraa61f412009-10-13 17:48:04 +0000247<div class="doc_text">
248
249<p>An exciting aspect of LLVM is that it is used as an enabling technology for
250 a lot of other language and tools projects. This section lists some of the
Jeffrey Yasskin0830b972010-01-28 01:14:43 +0000251 projects that have already been updated to work with LLVM 2.7.</p>
Chris Lattneraa61f412009-10-13 17:48:04 +0000252</div>
253
254
255<!--=========================================================================-->
256<div class="doc_subsection">
257<a name="Rubinius">Rubinius</a>
258</div>
259
260<div class="doc_text">
261<p><a href="http://github.com/evanphx/rubinius">Rubinius</a> is an environment
262for running Ruby code which strives to write as much of the core class
263implementation in Ruby as possible. Combined with a bytecode interpreting VM, it
264uses LLVM to optimize and compile ruby code down to machine code. Techniques
265such as type feedback, method inlining, and uncommon traps are all used to
266remove dynamism from ruby execution and increase performance.</p>
267
268<p>Since LLVM 2.5, Rubinius has made several major leaps forward, implementing
269a counter based JIT, type feedback and speculative method inlining.
270</p>
271
272</div>
273
274<!--=========================================================================-->
275<div class="doc_subsection">
276<a name="macruby">MacRuby</a>
277</div>
278
279<div class="doc_text">
280
281<p>
282<a href="http://macruby.org">MacRuby</a> is an implementation of Ruby on top of
283core Mac OS X technologies, such as the Objective-C common runtime and garbage
284collector and the CoreFoundation framework. It is principally developed by
285Apple and aims at enabling the creation of full-fledged Mac OS X applications.
286</p>
287
288<p>
289MacRuby uses LLVM for optimization passes, JIT and AOT compilation of Ruby
290expressions. It also uses zero-cost DWARF exceptions to implement Ruby exception
291handling.</p>
292
293</div>
294
295
Chris Lattner53e06f92009-02-26 22:33:38 +0000296<!--=========================================================================-->
297<div class="doc_subsection">
298<a name="pure">Pure</a>
299</div>
300
301<div class="doc_text">
302<p>
Chris Lattnerd1094e02009-03-02 02:37:32 +0000303<a href="http://pure-lang.googlecode.com/">Pure</a>
304is an algebraic/functional programming language based on term rewriting.
Chris Lattner53e06f92009-02-26 22:33:38 +0000305Programs are collections of equations which are used to evaluate expressions in
306a symbolic fashion. Pure offers dynamic typing, eager and lazy evaluation,
Mikhail Glushenkov25422542009-03-01 18:09:47 +0000307lexical closures, a hygienic macro system (also based on term rewriting),
Chris Lattner53e06f92009-02-26 22:33:38 +0000308built-in list and matrix support (including list and matrix comprehensions) and
309an easy-to-use C interface. The interpreter uses LLVM as a backend to
310 JIT-compile Pure programs to fast native code.</p>
311
Jeffrey Yasskin0830b972010-01-28 01:14:43 +0000312<p>Pure versions ??? and later have been tested and are known to work with
313LLVM 2.7 (and continue to work with older LLVM releases >= 2.3 as well).
Chris Lattner53e06f92009-02-26 22:33:38 +0000314</p>
315</div>
316
317
318<!--=========================================================================-->
319<div class="doc_subsection">
320<a name="ldc">LLVM D Compiler</a>
321</div>
322
323<div class="doc_text">
324<p>
Chris Lattnerd1094e02009-03-02 02:37:32 +0000325<a href="http://www.dsource.org/projects/ldc">LDC</a> is an implementation of
326the D Programming Language using the LLVM optimizer and code generator.
Chris Lattneraa61f412009-10-13 17:48:04 +0000327The LDC project works great with the LLVM 2.6 release. General improvements in
John Criswellea03c9d2009-03-02 15:28:15 +0000328this
Chris Lattnerd1094e02009-03-02 02:37:32 +0000329cycle have included new inline asm constraint handling, better debug info
Chris Lattneraa61f412009-10-13 17:48:04 +0000330support, general bug fixes and better x86-64 support. This has allowed
331some major improvements in LDC, getting it much closer to being as
Chris Lattner53e06f92009-02-26 22:33:38 +0000332fully featured as the original DMD compiler from DigitalMars.
333</p>
334</div>
335
Chris Lattnerfb23a962009-02-28 18:58:01 +0000336<!--=========================================================================-->
337<div class="doc_subsection">
338<a name="RoadsendPHP">Roadsend PHP</a>
339</div>
340
341<div class="doc_text">
Chris Lattneraa61f412009-10-13 17:48:04 +0000342<p>
343<a href="http://code.roadsend.com/rphp">Roadsend PHP</a> (rphp) is an open
Chris Lattner0c72d8f2009-03-02 19:07:24 +0000344source implementation of the PHP programming
Chris Lattneraa61f412009-10-13 17:48:04 +0000345language that uses LLVM for its optimizer, JIT and static compiler. This is a
Chris Lattner0c72d8f2009-03-02 19:07:24 +0000346reimplementation of an earlier project that is now based on LLVM.</p>
Chris Lattnerfb23a962009-02-28 18:58:01 +0000347</div>
Chris Lattner53e06f92009-02-26 22:33:38 +0000348
Chris Lattneraa61f412009-10-13 17:48:04 +0000349<!--=========================================================================-->
350<div class="doc_subsection">
351<a name="UnladenSwallow">Unladen Swallow</a>
352</div>
353
354<div class="doc_text">
355<p>
356<a href="http://code.google.com/p/unladen-swallow/">Unladen Swallow</a> is a
357branch of <a href="http://python.org/">Python</a> intended to be fully
358compatible and significantly faster. It uses LLVM's optimization passes and JIT
359compiler.</p>
360</div>
361
362<!--=========================================================================-->
363<div class="doc_subsection">
364<a name="llvm-lua">llvm-lua</a>
365</div>
366
367<div class="doc_text">
368<p>
369<a href="http://code.google.com/p/llvm-lua/">LLVM-Lua</a> uses LLVM to add JIT
370and static compiling support to the Lua VM. Lua bytecode is analyzed to
371remove type checks, then LLVM is used to compile the bytecode down to machine
372code.</p>
373</div>
374
375<!--=========================================================================-->
376<div class="doc_subsection">
377<a name="icedtea">IcedTea Java Virtual Machine Implementation</a>
378</div>
379
380<div class="doc_text">
381<p>
382<a href="http://icedtea.classpath.org/wiki/Main_Page">IcedTea</a> provides a
383harness to build OpenJDK using only free software build tools and to provide
384replacements for the not-yet free parts of OpenJDK. One of the extensions that
385IcedTea provides is a new JIT compiler named <a
386href="http://icedtea.classpath.org/wiki/ZeroSharkFaq">Shark</a> which uses LLVM
387to provide native code generation without introducing processor-dependent
388code.
389</p>
390</div>
391
392
Chris Lattnerc75fd522008-06-08 21:58:17 +0000393
394<!-- *********************************************************************** -->
395<div class="doc_section">
Jeffrey Yasskin0830b972010-01-28 01:14:43 +0000396 <a name="whatsnew">What's New in LLVM 2.7?</a>
Chris Lattnerc75fd522008-06-08 21:58:17 +0000397</div>
398<!-- *********************************************************************** -->
399
Chris Lattnerb7bc2aa2008-06-08 22:59:35 +0000400<div class="doc_text">
401
Chris Lattneraa61f412009-10-13 17:48:04 +0000402<p>This release includes a huge number of bug fixes, performance tweaks and
Chris Lattner1e4d5bc2008-10-13 17:57:36 +0000403minor improvements. Some of the major improvements and new features are listed
404in this section.
Chris Lattnerb7bc2aa2008-06-08 22:59:35 +0000405</p>
Chris Lattneraa61f412009-10-13 17:48:04 +0000406
Chris Lattnerb7bc2aa2008-06-08 22:59:35 +0000407</div>
408
Chris Lattnerc75fd522008-06-08 21:58:17 +0000409<!--=========================================================================-->
Chris Lattner625a3d82008-06-08 21:34:41 +0000410<div class="doc_subsection">
Chris Lattnercdc44ed2008-02-06 18:00:06 +0000411<a name="majorfeatures">Major New Features</a>
412</div>
413
414<div class="doc_text">
415
Jeffrey Yasskin0830b972010-01-28 01:14:43 +0000416<p>LLVM 2.7 includes several major new capabilities:</p>
Chris Lattner97beb512007-05-14 06:56:09 +0000417
418<ul>
Jeffrey Yasskin0830b972010-01-28 01:14:43 +0000419<li>...</li>
Chris Lattner458e79f2008-02-10 08:18:42 +0000420</ul>
421
Chris Lattner97beb512007-05-14 06:56:09 +0000422</div>
423
Chris Lattner0a1fd102007-09-21 03:54:09 +0000424<!--=========================================================================-->
425<div class="doc_subsection">
Chris Lattnerd1094e02009-03-02 02:37:32 +0000426<a name="coreimprovements">LLVM IR and Core Improvements</a>
Chris Lattnerdd6acc02008-02-10 08:17:19 +0000427</div>
428
429<div class="doc_text">
Chris Lattneraa61f412009-10-13 17:48:04 +0000430<p>LLVM IR has several new features for better support of new targets and that
431expose new optimization opportunities:</p>
Chris Lattnerdd6acc02008-02-10 08:17:19 +0000432
Chris Lattnerb7112222008-06-05 06:25:56 +0000433<ul>
Jeffrey Yasskin0830b972010-01-28 01:14:43 +0000434<li>...</li>
Chris Lattnerdd6acc02008-02-10 08:17:19 +0000435</ul>
Mikhail Glushenkov024f7cf2008-10-13 02:08:34 +0000436
Chris Lattnerdd6acc02008-02-10 08:17:19 +0000437</div>
438
439<!--=========================================================================-->
440<div class="doc_subsection">
Chris Lattner2b8a52e2008-02-10 07:46:44 +0000441<a name="optimizer">Optimizer Improvements</a>
442</div>
443
444<div class="doc_text">
445
Chris Lattneraa61f412009-10-13 17:48:04 +0000446<p>In addition to a large array of minor performance tweaks and bug fixes, this
Chris Lattner25879d72008-10-13 21:50:36 +0000447release includes a few major enhancements and additions to the optimizers:</p>
Chris Lattner2b8a52e2008-02-10 07:46:44 +0000448
449<ul>
450
Jeffrey Yasskin0830b972010-01-28 01:14:43 +0000451<li>...</li>
Chris Lattnerd1094e02009-03-02 02:37:32 +0000452
Chris Lattneraa61f412009-10-13 17:48:04 +0000453</ul>
Chris Lattnerd1094e02009-03-02 02:37:32 +0000454
Chris Lattneraa61f412009-10-13 17:48:04 +0000455</div>
Chris Lattnerd1094e02009-03-02 02:37:32 +0000456
Chris Lattnerd1094e02009-03-02 02:37:32 +0000457
Chris Lattneraa61f412009-10-13 17:48:04 +0000458<!--=========================================================================-->
459<div class="doc_subsection">
460<a name="executionengine">Interpreter and JIT Improvements</a>
461</div>
Chris Lattner25879d72008-10-13 21:50:36 +0000462
Chris Lattneraa61f412009-10-13 17:48:04 +0000463<div class="doc_text">
464
465<ul>
Jeffrey Yasskin9fb8ce82010-01-29 19:10:38 +0000466<li>The JIT now <a
467href="http://llvm.org/viewvc/llvm-project?view=rev&revision=85295">defaults
468to compiling eagerly</a> to avoid a race condition in the lazy JIT.
469Clients that still want the lazy JIT can switch it on by calling
470<tt>ExecutionEngine::DisableLazyCompilation(false)</tt>.</li>
Jeffrey Yasskine0913882010-02-11 01:07:39 +0000471<li>It is now possible to create more than one JIT instance in the same process.
472These JITs can generate machine code in parallel,
473although <a href="http://llvm.org/docs/ProgrammersManual.html#jitthreading">you
474still have to obey the other threading restrictions</a>.</li>
Chris Lattner7795ea92008-06-08 02:45:07 +0000475</ul>
476
477</div>
478
479<!--=========================================================================-->
480<div class="doc_subsection">
Chris Lattnerd434bfb2009-03-02 03:24:11 +0000481<a name="codegen">Target Independent Code Generator Improvements</a>
Chris Lattner7795ea92008-06-08 02:45:07 +0000482</div>
483
484<div class="doc_text">
485
Mikhail Glushenkov25422542009-03-01 18:09:47 +0000486<p>We have put a significant amount of work into the code generator
487infrastructure, which allows us to implement more aggressive algorithms and make
488it run faster:</p>
Chris Lattner7795ea92008-06-08 02:45:07 +0000489
490<ul>
Chris Lattnerd434bfb2009-03-02 03:24:11 +0000491
Jeffrey Yasskin0830b972010-01-28 01:14:43 +0000492<li>...</li>
Chris Lattner0a1fd102007-09-21 03:54:09 +0000493</ul>
Chris Lattner0a1fd102007-09-21 03:54:09 +0000494</div>
495
Chris Lattnerd1094e02009-03-02 02:37:32 +0000496<!--=========================================================================-->
497<div class="doc_subsection">
498<a name="x86">X86-32 and X86-64 Target Improvements</a>
499</div>
500
501<div class="doc_text">
502<p>New features of the X86 target include:
503</p>
504
505<ul>
Chris Lattnerd434bfb2009-03-02 03:24:11 +0000506
Jeffrey Yasskin0830b972010-01-28 01:14:43 +0000507<li>...</li>
Chris Lattnerd434bfb2009-03-02 03:24:11 +0000508
Chris Lattnerd1094e02009-03-02 02:37:32 +0000509</ul>
510
Chris Lattnerd1094e02009-03-02 02:37:32 +0000511</div>
Chris Lattner0a1fd102007-09-21 03:54:09 +0000512
513<!--=========================================================================-->
514<div class="doc_subsection">
Chris Lattner6b8bf782009-02-26 07:32:11 +0000515<a name="pic16">PIC16 Target Improvements</a>
516</div>
517
518<div class="doc_text">
519<p>New features of the PIC16 target include:
520</p>
521
522<ul>
Jeffrey Yasskin0830b972010-01-28 01:14:43 +0000523<li>...</li>
Chris Lattner6b8bf782009-02-26 07:32:11 +0000524</ul>
525
526<p>Things not yet supported:</p>
527
528<ul>
Chris Lattner6b8bf782009-02-26 07:32:11 +0000529<li>Variable arguments.</li>
Chris Lattnerd434bfb2009-03-02 03:24:11 +0000530<li>Interrupts/programs.</li>
Chris Lattner6b8bf782009-02-26 07:32:11 +0000531</ul>
532
533</div>
534
Chris Lattner6b8bf782009-02-26 07:32:11 +0000535<!--=========================================================================-->
536<div class="doc_subsection">
Chris Lattneraa61f412009-10-13 17:48:04 +0000537<a name="ARM">ARM Target Improvements</a>
Chris Lattnerc92d7692009-03-01 02:30:21 +0000538</div>
539
540<div class="doc_text">
Chris Lattneraa61f412009-10-13 17:48:04 +0000541<p>New features of the ARM target include:
542</p>
Chris Lattnerc92d7692009-03-01 02:30:21 +0000543
544<ul>
Chris Lattnerc92d7692009-03-01 02:30:21 +0000545
Jeffrey Yasskin0830b972010-01-28 01:14:43 +0000546<li>...</li>
Chris Lattneraa61f412009-10-13 17:48:04 +0000547</ul>
Chris Lattnerc92d7692009-03-01 02:30:21 +0000548
Chris Lattnerc92d7692009-03-01 02:30:21 +0000549
Chris Lattneraa61f412009-10-13 17:48:04 +0000550</div>
Chris Lattnerc92d7692009-03-01 02:30:21 +0000551
Chris Lattneraa61f412009-10-13 17:48:04 +0000552<!--=========================================================================-->
553<div class="doc_subsection">
554<a name="OtherTarget">Other Target Specific Improvements</a>
555</div>
Chris Lattnerc92d7692009-03-01 02:30:21 +0000556
Chris Lattneraa61f412009-10-13 17:48:04 +0000557<div class="doc_text">
558<p>New features of other targets include:
559</p>
560
561<ul>
Jeffrey Yasskin0830b972010-01-28 01:14:43 +0000562<li>...</li>
Chris Lattneraa61f412009-10-13 17:48:04 +0000563</ul>
564
565</div>
566
567<!--=========================================================================-->
568<div class="doc_subsection">
569<a name="newapis">New Useful APIs</a>
570</div>
571
572<div class="doc_text">
573
574<p>This release includes a number of new APIs that are used internally, which
575 may also be useful for external clients.
576</p>
577
578<ul>
Jeffrey Yasskin0830b972010-01-28 01:14:43 +0000579<li>...</li>
Chris Lattneraa61f412009-10-13 17:48:04 +0000580</ul>
581
582
583</div>
584
585<!--=========================================================================-->
586<div class="doc_subsection">
587<a name="otherimprovements">Other Improvements and New Features</a>
588</div>
589
590<div class="doc_text">
591<p>Other miscellaneous features include:</p>
592
593<ul>
Jeffrey Yasskin0830b972010-01-28 01:14:43 +0000594<li>...</li>
Chris Lattnerc92d7692009-03-01 02:30:21 +0000595</ul>
596
597</div>
598
Chris Lattner6cb64032008-06-05 08:02:49 +0000599
600<!--=========================================================================-->
601<div class="doc_subsection">
Chris Lattner1e4d5bc2008-10-13 17:57:36 +0000602<a name="changes">Major Changes and Removed Features</a>
603</div>
604
605<div class="doc_text">
606
Chris Lattner934e2d42008-10-13 22:06:31 +0000607<p>If you're already an LLVM user or developer with out-of-tree changes based
Jeffrey Yasskin0830b972010-01-28 01:14:43 +0000608on LLVM 2.6, this section lists some "gotchas" that you may run into upgrading
Chris Lattner934e2d42008-10-13 22:06:31 +0000609from the previous release.</p>
Chris Lattner1e4d5bc2008-10-13 17:57:36 +0000610
611<ul>
Jeffrey Yasskin914050b2010-02-09 23:03:44 +0000612<li>The LLVM interpreter now defaults to <em>not</em> using <tt>libffi</tt> even
613if you have it installed. This makes it more likely that an LLVM built on one
614system will work when copied to a similar system. To use <tt>libffi</tt>,
615configure with <tt>--enable-libffi</tt>.
616</li>
Chris Lattner934e2d42008-10-13 22:06:31 +0000617</ul>
618
619
620<p>In addition, many APIs have changed in this release. Some of the major LLVM
621API changes are:</p>
622
623<ul>
Jeffrey Yasskin4a8b1da2010-01-28 01:41:20 +0000624<li><tt>ModuleProvider</tt> has been <a
625href="http://llvm.org/viewvc/llvm-project?view=rev&revision=94686">removed</a>
626and its methods moved to <tt>Module</tt> and <tt>GlobalValue</tt>.
627Most clients can remove uses of <tt>ExistingModuleProvider</tt>,
628replace <tt>getBitcodeModuleProvider</tt> with
629<tt>getLazyBitcodeModule</tt>, and pass their <tt>Module</tt> to
630functions that used to accept <tt>ModuleProvider</tt>. Clients who
631wrote their own <tt>ModuleProvider</tt>s will need to derive from
632<tt>GVMaterializer</tt> instead and use
633<tt>Module::setMaterializer</tt> to attach it to a
634<tt>Module</tt>.</li>
635
636<li><tt>GhostLinkage</tt> has given up the ghost.
637<tt>GlobalValue</tt>s that have not yet been read from their backing
638storage have the same linkage they will have after being read in.
639Clients must replace calls to
640<tt>GlobalValue::hasNotBeenReadFromBitcode</tt> with
641<tt>GlobalValue::isMaterializable</tt>.</li>
Daniel Dunbar1e96fca2010-02-10 04:09:52 +0000642
643<li>FIXME: Debug info has been totally redone. Add pointers to new APIs. Substantial caveats about compatibility of .ll and .bc files.</li>
644
Daniel Dunbar3e255da2010-02-14 01:47:19 +0000645<li>The <tt>llvm/Support/DataTypes.h</tt> header has moved
646to <tt>llvm/System/DataTypes.h</tt>.</li>
647
Duncan Sands80c430a2010-02-17 17:20:17 +0000648<li>The <tt>isInteger</tt>, <tt>isIntOrIntVector</tt>, <tt>isFloatingPoint</tt>,
649<tt>isFPOrFPVector</tt> and <tt>isFPOrFPVector</tt> methods have been renamed
650<tt>isIntegerTy</tt>, <tt>isIntOrIntVectorTy</tt>, <tt>isFloatingPointTy</tt>,
651<tt>isFPOrFPVectorTy</tt> and <tt>isFPOrFPVectorTy</tt> respectively.</li>
Devang Pateldbf83832008-10-14 20:03:43 +0000652</ul>
Chris Lattner1e4d5bc2008-10-13 17:57:36 +0000653
Chris Lattner1e4d5bc2008-10-13 17:57:36 +0000654</div>
655
656
657
Chris Lattner62495762003-10-02 16:38:05 +0000658<!-- *********************************************************************** -->
Misha Brukman80731b92003-11-22 00:38:41 +0000659<div class="doc_section">
660 <a name="portability">Portability and Supported Platforms</a>
661</div>
Chris Lattner62495762003-10-02 16:38:05 +0000662<!-- *********************************************************************** -->
663
Misha Brukman80731b92003-11-22 00:38:41 +0000664<div class="doc_text">
665
John Criswell64307722004-12-08 20:35:47 +0000666<p>LLVM is known to work on the following platforms:</p>
Chris Lattner2c7b0872004-06-01 18:22:41 +0000667
668<ul>
Mikhail Glushenkov25422542009-03-01 18:09:47 +0000669<li>Intel and AMD machines (IA32, X86-64, AMD64, EMT-64) running Red Hat
Chris Lattneraa61f412009-10-13 17:48:04 +0000670 Linux, Fedora Core, FreeBSD and AuroraUX (and probably other unix-like
671 systems).</li>
Mikhail Glushenkov25422542009-03-01 18:09:47 +0000672<li>PowerPC and X86-based Mac OS X systems, running 10.3 and above in 32-bit
Chris Lattneraa61f412009-10-13 17:48:04 +0000673 and 64-bit modes.</li>
Chris Lattnercdc44ed2008-02-06 18:00:06 +0000674<li>Intel and AMD machines running on Win32 using MinGW libraries (native).</li>
Chris Lattnerbee7b322007-05-23 04:39:32 +0000675<li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
676 support is available for native builds with Visual C++).</li>
Chris Lattner51948622009-10-16 16:30:58 +0000677<li>Sun x86 and AMD64 machines running Solaris 10, OpenSolaris 0906.</li>
John Criswelld5234922005-05-13 20:28:15 +0000678<li>Alpha-based machines running Debian GNU/Linux.</li>
Chris Lattner2c7b0872004-06-01 18:22:41 +0000679</ul>
680
Chris Lattner618a99f2008-06-05 06:57:39 +0000681<p>The core LLVM infrastructure uses GNU autoconf to adapt itself
Brian Gaekee3e557e2004-05-09 05:28:35 +0000682to the machine and operating system on which it is built. However, minor
683porting may be required to get LLVM to work on new platforms. We welcome your
684portability patches and reports of successful builds or error messages.</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000685
Misha Brukman80731b92003-11-22 00:38:41 +0000686</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000687
688<!-- *********************************************************************** -->
Misha Brukman80731b92003-11-22 00:38:41 +0000689<div class="doc_section">
690 <a name="knownproblems">Known Problems</a>
691</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000692<!-- *********************************************************************** -->
693
Misha Brukman80731b92003-11-22 00:38:41 +0000694<div class="doc_text">
695
Mikhail Glushenkov25422542009-03-01 18:09:47 +0000696<p>This section contains significant known problems with the LLVM system,
Chris Lattner2a092392008-11-10 05:40:34 +0000697listed by component. If you run into a problem, please check the <a
Chris Lattnera69595e2005-10-29 07:07:09 +0000698href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
Chris Lattnerb84f3322003-12-12 21:22:16 +0000699there isn't already one.</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000700
Chris Lattneraa61f412009-10-13 17:48:04 +0000701<ul>
702<li>The llvm-gcc bootstrap will fail with some versions of binutils (e.g. 2.15)
703 with a message of "<tt><a href="http://llvm.org/PR5004">Error: can not do 8
704 byte pc-relative relocation</a></tt>" when building C++ code. We intend to
Jeffrey Yasskin0830b972010-01-28 01:14:43 +0000705 fix this on mainline, but a workaround is to upgrade to binutils 2.17 or
706 later.</li>
Chris Lattneraa61f412009-10-13 17:48:04 +0000707
708<li>LLVM will not correctly compile on Solaris and/or OpenSolaris
709using the stock GCC 3.x.x series 'out the box',
Chris Lattner6e41c792009-11-03 21:50:09 +0000710See: <a href="GettingStarted.html#brokengcc">Broken versions of GCC and other tools</a>.
Chris Lattneraa61f412009-10-13 17:48:04 +0000711However, A <a href="http://pkg.auroraux.org/GCC">Modern GCC Build</a>
712for x86/x86-64 has been made available from the third party AuroraUX Project
713that has been meticulously tested for bootstrapping LLVM &amp; Clang.</li>
714</ul>
715
Misha Brukman80731b92003-11-22 00:38:41 +0000716</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000717
Chris Lattnerb911de42004-03-14 02:03:02 +0000718<!-- ======================================================================= -->
719<div class="doc_subsection">
720 <a name="experimental">Experimental features included with this release</a>
721</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000722
Chris Lattnerb911de42004-03-14 02:03:02 +0000723<div class="doc_text">
724
Misha Brukmanfa50a222004-05-12 21:46:05 +0000725<p>The following components of this LLVM release are either untested, known to
726be broken or unreliable, or are in early development. These components should
727not be relied on, and bugs should not be filed against them, but they may be
728useful to some people. In particular, if you would like to work on one of these
Chris Lattnere38ac152008-02-12 06:29:45 +0000729components, please contact us on the <a
730href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p>
Chris Lattnerb911de42004-03-14 02:03:02 +0000731
732<ul>
Chris Lattneraa61f412009-10-13 17:48:04 +0000733<li>The MSIL, Alpha, SPU, MIPS, PIC16, Blackfin, MSP430 and SystemZ backends are
734 experimental.</li>
Bill Wendling89cd82f2009-03-02 07:54:14 +0000735<li>The <tt>llc</tt> "<tt>-filetype=asm</tt>" (the default) is the only
Chris Lattneraa61f412009-10-13 17:48:04 +0000736 supported value for this option. The ELF writer is experimental.</li>
737<li>The implementation of Andersen's Alias Analysis has many known bugs.</li>
Chris Lattnerb911de42004-03-14 02:03:02 +0000738</ul>
739
740</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000741
Misha Brukman80731b92003-11-22 00:38:41 +0000742<!-- ======================================================================= -->
743<div class="doc_subsection">
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000744 <a name="x86-be">Known problems with the X86 back-end</a>
John Criswell3bdbd302005-11-08 21:11:33 +0000745</div>
746
747<div class="doc_text">
748
749<ul>
Anton Korobeynikov486c7d32008-06-08 10:24:13 +0000750 <li>The X86 backend does not yet support
751 all <a href="http://llvm.org/PR879">inline assembly that uses the X86
752 floating point stack</a>. It supports the 'f' and 't' constraints, but not
753 'u'.</li>
Chris Lattnerb076b002008-06-08 21:19:07 +0000754 <li>The X86 backend generates inefficient floating point code when configured
755 to generate code for systems that don't have SSE2.</li>
Duncan Sands0bc15262008-06-08 19:38:43 +0000756 <li>Win64 code generation wasn't widely tested. Everything should work, but we
John Criswellea03c9d2009-03-02 15:28:15 +0000757 expect small issues to happen. Also, llvm-gcc cannot build the mingw64
758 runtime currently due
Anton Korobeynikov486c7d32008-06-08 10:24:13 +0000759 to <a href="http://llvm.org/PR2255">several</a>
John Criswellea03c9d2009-03-02 15:28:15 +0000760 <a href="http://llvm.org/PR2257">bugs</a> and due to lack of support for
761 the
762 'u' inline assembly constraint and for X87 floating point inline assembly.</li>
Dan Gohman721b3722008-06-08 23:05:11 +0000763 <li>The X86-64 backend does not yet support the LLVM IR instruction
Chris Lattnerd1094e02009-03-02 02:37:32 +0000764 <tt>va_arg</tt>. Currently, the llvm-gcc and front-ends support variadic
Dan Gohman721b3722008-06-08 23:05:11 +0000765 argument constructs on X86-64 by lowering them manually.</li>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000766</ul>
767
768</div>
769
770<!-- ======================================================================= -->
771<div class="doc_subsection">
772 <a name="ppc-be">Known problems with the PowerPC back-end</a>
773</div>
774
775<div class="doc_text">
776
777<ul>
Nicolas Geoffray77d99502007-05-15 09:21:28 +0000778<li>The Linux PPC32/ABI support needs testing for the interpreter and static
Chris Lattnerbee7b322007-05-23 04:39:32 +0000779compilation, and lacks support for debug information.</li>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000780</ul>
781
782</div>
783
784<!-- ======================================================================= -->
785<div class="doc_subsection">
Chris Lattner97beb512007-05-14 06:56:09 +0000786 <a name="arm-be">Known problems with the ARM back-end</a>
787</div>
788
789<div class="doc_text">
790
791<ul>
Chris Lattneraa61f412009-10-13 17:48:04 +0000792<li>Support for the Advanced SIMD (Neon) instruction set is still incomplete
793and not well tested. Some features may not work at all, and the code quality
794may be poor in some cases.</li>
Chris Lattnerbee7b322007-05-23 04:39:32 +0000795<li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
Duncan Sands47fc0a22007-09-26 15:59:54 +0000796processors, thumb programs can crash or produce wrong
Chris Lattnerbee7b322007-05-23 04:39:32 +0000797results (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
John Criswellea03c9d2009-03-02 15:28:15 +0000798<li>Compilation for ARM Linux OABI (old ABI) is supported but not fully tested.
Chris Lattner97beb512007-05-14 06:56:09 +0000799</li>
Chris Lattner97beb512007-05-14 06:56:09 +0000800</ul>
801
802</div>
803
804<!-- ======================================================================= -->
805<div class="doc_subsection">
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000806 <a name="sparc-be">Known problems with the SPARC back-end</a>
807</div>
808
809<div class="doc_text">
810
811<ul>
John Criswellea03c9d2009-03-02 15:28:15 +0000812<li>The SPARC backend only supports the 32-bit SPARC ABI (-m32); it does not
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000813 support the 64-bit SPARC ABI (-m64).</li>
814</ul>
815
816</div>
817
818<!-- ======================================================================= -->
819<div class="doc_subsection">
Bruno Cardoso Lopes24eb3de2008-10-25 14:56:26 +0000820 <a name="mips-be">Known problems with the MIPS back-end</a>
821</div>
822
823<div class="doc_text">
824
825<ul>
Bruno Cardoso Lopes24eb3de2008-10-25 14:56:26 +0000826<li>64-bit MIPS targets are not supported yet.</li>
827</ul>
828
829</div>
830
831<!-- ======================================================================= -->
832<div class="doc_subsection">
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000833 <a name="alpha-be">Known problems with the Alpha back-end</a>
834</div>
835
836<div class="doc_text">
837
838<ul>
839
840<li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
841appropriate nops inserted to ensure restartability.</li>
842
John Criswell3bdbd302005-11-08 21:11:33 +0000843</ul>
844</div>
845
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000846<!-- ======================================================================= -->
847<div class="doc_subsection">
Chris Lattner97beb512007-05-14 06:56:09 +0000848 <a name="c-be">Known problems with the C back-end</a>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000849</div>
850
851<div class="doc_text">
852
853<ul>
Chris Lattnera1a4c9a2008-06-05 06:35:40 +0000854<li><a href="http://llvm.org/PR802">The C backend has only basic support for
855 inline assembly code</a>.</li>
Chris Lattner8e061162007-09-26 06:01:35 +0000856<li><a href="http://llvm.org/PR1658">The C backend violates the ABI of common
857 C++ programs</a>, preventing intermixing between C++ compiled by the CBE and
Gabor Greif75b2f762009-03-02 12:02:51 +0000858 C++ code compiled with <tt>llc</tt> or native compilers.</li>
Duncan Sandse09506a2008-02-10 13:40:55 +0000859<li>The C backend does not support all exception handling constructs.</li>
Duncan Sands3aa36732009-02-25 11:51:54 +0000860<li>The C backend does not support arbitrary precision integers.</li>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000861</ul>
862
863</div>
John Criswell3bdbd302005-11-08 21:11:33 +0000864
Misha Brukman80731b92003-11-22 00:38:41 +0000865
866<!-- ======================================================================= -->
867<div class="doc_subsection">
Chris Lattnera1a4c9a2008-06-05 06:35:40 +0000868 <a name="c-fe">Known problems with the llvm-gcc C front-end</a>
Misha Brukman80731b92003-11-22 00:38:41 +0000869</div>
Chris Lattner178f3db2003-10-02 05:07:23 +0000870
Misha Brukman80731b92003-11-22 00:38:41 +0000871<div class="doc_text">
Chris Lattner72a269f2006-03-03 00:34:26 +0000872
Chris Lattnera1a4c9a2008-06-05 06:35:40 +0000873<p>The only major language feature of GCC not supported by llvm-gcc is
874 the <tt>__builtin_apply</tt> family of builtins. However, some extensions
875 are only supported on some targets. For example, trampolines are only
Duncan Sands56448462008-06-08 20:18:35 +0000876 supported on some targets (these are used when you take the address of a
877 nested function).</p>
Misha Brukman80731b92003-11-22 00:38:41 +0000878
Chris Lattnera1a4c9a2008-06-05 06:35:40 +0000879<p>If you run into GCC extensions which are not supported, please let us know.
880</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000881
Misha Brukman80731b92003-11-22 00:38:41 +0000882</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000883
Misha Brukman80731b92003-11-22 00:38:41 +0000884<!-- ======================================================================= -->
885<div class="doc_subsection">
Chris Lattnera1a4c9a2008-06-05 06:35:40 +0000886 <a name="c++-fe">Known problems with the llvm-gcc C++ front-end</a>
Misha Brukman80731b92003-11-22 00:38:41 +0000887</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000888
Misha Brukman80731b92003-11-22 00:38:41 +0000889<div class="doc_text">
890
Chris Lattner97beb512007-05-14 06:56:09 +0000891<p>The C++ front-end is considered to be fully
Chris Lattnerb5bb5972004-12-07 08:04:13 +0000892tested and works for a number of non-trivial programs, including LLVM
Chris Lattner97beb512007-05-14 06:56:09 +0000893itself, Qt, Mozilla, etc.</p>
Misha Brukman80731b92003-11-22 00:38:41 +0000894
Misha Brukman80731b92003-11-22 00:38:41 +0000895<ul>
Anton Korobeynikov28f08aa2008-10-11 18:27:16 +0000896<li>Exception handling works well on the X86 and PowerPC targets. Currently
Chris Lattner2a092392008-11-10 05:40:34 +0000897 only Linux and Darwin targets are supported (both 32 and 64 bit).</li>
Misha Brukman80731b92003-11-22 00:38:41 +0000898</ul>
Chris Lattner46ecf612003-10-07 22:14:37 +0000899
Misha Brukman80731b92003-11-22 00:38:41 +0000900</div>
901
Chris Lattner7292fb12008-10-30 03:58:13 +0000902<!-- ======================================================================= -->
903<div class="doc_subsection">
904 <a name="fortran-fe">Known problems with the llvm-gcc Fortran front-end</a>
905</div>
906
907<div class="doc_text">
Gabor Greife5f9d672008-11-04 21:50:59 +0000908<ul>
Chris Lattner7292fb12008-10-30 03:58:13 +0000909<li>Fortran support generally works, but there are still several unresolved bugs
Chris Lattneraa61f412009-10-13 17:48:04 +0000910 in <a href="http://llvm.org/bugs/">Bugzilla</a>. Please see the
911 tools/gfortran component for details.</li>
Gabor Greife5f9d672008-11-04 21:50:59 +0000912</ul>
Chris Lattner7292fb12008-10-30 03:58:13 +0000913</div>
Misha Brukman80731b92003-11-22 00:38:41 +0000914
Chris Lattnere38ac152008-02-12 06:29:45 +0000915<!-- ======================================================================= -->
916<div class="doc_subsection">
Chris Lattnera1a4c9a2008-06-05 06:35:40 +0000917 <a name="ada-fe">Known problems with the llvm-gcc Ada front-end</a>
Chris Lattnere38ac152008-02-12 06:29:45 +0000918</div>
919
920<div class="doc_text">
John Criswellea03c9d2009-03-02 15:28:15 +0000921The llvm-gcc 4.2 Ada compiler works fairly well; however, this is not a mature
922technology, and problems should be expected.
Chris Lattnere38ac152008-02-12 06:29:45 +0000923<ul>
Duncan Sands56448462008-06-08 20:18:35 +0000924<li>The Ada front-end currently only builds on X86-32. This is mainly due
John Criswellea03c9d2009-03-02 15:28:15 +0000925to lack of trampoline support (pointers to nested functions) on other platforms.
926However, it <a href="http://llvm.org/PR2006">also fails to build on X86-64</a>
Chris Lattnere38ac152008-02-12 06:29:45 +0000927which does support trampolines.</li>
928<li>The Ada front-end <a href="http://llvm.org/PR2007">fails to bootstrap</a>.
Duncan Sandsd34bf762009-02-25 11:59:06 +0000929This is due to lack of LLVM support for <tt>setjmp</tt>/<tt>longjmp</tt> style
930exception handling, which is used internally by the compiler.
Chris Lattneraa61f412009-10-13 17:48:04 +0000931Workaround: configure with <tt>--disable-bootstrap</tt>.</li>
Duncan Sandsaef747f2008-10-13 17:27:23 +0000932<li>The c380004, <a href="http://llvm.org/PR2010">c393010</a>
933and <a href="http://llvm.org/PR2421">cxg2021</a> ACATS tests fail
Duncan Sandsd34bf762009-02-25 11:59:06 +0000934(c380004 also fails with gcc-4.2 mainline).
935If the compiler is built with checks disabled then <a href="http://llvm.org/PR2010">c393010</a>
936causes the compiler to go into an infinite loop, using up all system memory.</li>
Duncan Sands2dbb00e2009-03-02 16:35:57 +0000937<li>Some GCC specific Ada tests continue to crash the compiler.</li>
Chris Lattneraa61f412009-10-13 17:48:04 +0000938<li>The <tt>-E</tt> binder option (exception backtraces)
Chris Lattnere38ac152008-02-12 06:29:45 +0000939<a href="http://llvm.org/PR1982">does not work</a> and will result in programs
Chris Lattneraa61f412009-10-13 17:48:04 +0000940crashing if an exception is raised. Workaround: do not use <tt>-E</tt>.</li>
Chris Lattnere38ac152008-02-12 06:29:45 +0000941<li>Only discrete types <a href="http://llvm.org/PR1981">are allowed to start
942or finish at a non-byte offset</a> in a record. Workaround: do not pack records
943or use representation clauses that result in a field of a non-discrete type
944starting or finishing in the middle of a byte.</li>
Chris Lattnerb076b002008-06-08 21:19:07 +0000945<li>The <tt>lli</tt> interpreter <a href="http://llvm.org/PR2009">considers
946'main' as generated by the Ada binder to be invalid</a>.
947Workaround: hand edit the file to use pointers for <tt>argv</tt> and
948<tt>envp</tt> rather than integers.</li>
949<li>The <tt>-fstack-check</tt> option <a href="http://llvm.org/PR2008">is
950ignored</a>.</li>
Chris Lattnere38ac152008-02-12 06:29:45 +0000951</ul>
952</div>
953
Chris Lattneraa61f412009-10-13 17:48:04 +0000954<!-- ======================================================================= -->
955<div class="doc_subsection">
956 <a name="ocaml-bindings">Known problems with the O'Caml bindings</a>
957</div>
958
959<div class="doc_text">
960
961<p>The <tt>Llvm.Linkage</tt> module is broken, and has incorrect values. Only
962<tt>Llvm.Linkage.External</tt>, <tt>Llvm.Linkage.Available_externally</tt>, and
963<tt>Llvm.Linkage.Link_once</tt> will be correct. If you need any of the other linkage
964modes, you'll have to write an external C library in order to expose the
965functionality. This has been fixed in the trunk.</p>
966</div>
967
Chris Lattner3d482502003-10-02 04:57:28 +0000968<!-- *********************************************************************** -->
Misha Brukman80731b92003-11-22 00:38:41 +0000969<div class="doc_section">
970 <a name="additionalinfo">Additional Information</a>
971</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000972<!-- *********************************************************************** -->
973
Misha Brukman80731b92003-11-22 00:38:41 +0000974<div class="doc_text">
975
Chris Lattnercb5596d2005-05-16 17:13:10 +0000976<p>A wide variety of additional information is available on the <a
Chris Lattnere0c1df42007-05-18 00:44:29 +0000977href="http://llvm.org">LLVM web page</a>, in particular in the <a
978href="http://llvm.org/docs/">documentation</a> section. The web page also
Reid Spencerc7f87f22007-07-09 08:04:31 +0000979contains versions of the API documentation which is up-to-date with the
980Subversion version of the source code.
Misha Brukman96158092005-03-30 19:14:24 +0000981You can access versions of these documents specific to this release by going
982into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000983
Misha Brukman80731b92003-11-22 00:38:41 +0000984<p>If you have any questions or comments about LLVM, please feel free to contact
Chris Lattnera69595e2005-10-29 07:07:09 +0000985us via the <a href="http://llvm.org/docs/#maillist"> mailing
Chris Lattnerb84f3322003-12-12 21:22:16 +0000986lists</a>.</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000987
Misha Brukman80731b92003-11-22 00:38:41 +0000988</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000989
990<!-- *********************************************************************** -->
Chris Lattner3d482502003-10-02 04:57:28 +0000991
Misha Brukman80731b92003-11-22 00:38:41 +0000992<hr>
Misha Brukman68aab3b2003-11-22 01:23:39 +0000993<address>
Misha Brukman8834af92003-12-21 22:53:21 +0000994 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman86242e12008-12-11 17:34:48 +0000995 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
Misha Brukman68aab3b2003-11-22 01:23:39 +0000996 <a href="http://validator.w3.org/check/referer"><img
Misha Brukman86242e12008-12-11 17:34:48 +0000997 src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
Misha Brukman68aab3b2003-11-22 01:23:39 +0000998
Chris Lattnere0c1df42007-05-18 00:44:29 +0000999 <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
Misha Brukman80731b92003-11-22 00:38:41 +00001000 Last modified: $Date$
Misha Brukman68aab3b2003-11-22 01:23:39 +00001001</address>
Chris Lattner3d482502003-10-02 04:57:28 +00001002
Misha Brukman80731b92003-11-22 00:38:41 +00001003</body>
1004</html>