blob: b373e9f14c33f656561a688a9486df492081e32c [file] [log] [blame]
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
3<html>
4<head>
5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
6 <link rel="stylesheet" href="llvm.css" type="text/css">
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +00007 <title>LLVM 2.7 Release Notes</title>
Dan Gohmanf17a25c2007-07-18 16:29:46 +00008</head>
9<body>
10
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +000011<div class="doc_title">LLVM 2.7 Release Notes</div>
Mikhail Glushenkov808cd3e2008-10-13 02:08:34 +000012
Dan Gohmanf17a25c2007-07-18 16:29:46 +000013<ol>
14 <li><a href="#intro">Introduction</a></li>
Chris Lattner78a130b2008-10-13 18:01:01 +000015 <li><a href="#subproj">Sub-project Status Update</a></li>
Jeffrey Yasskin8ee1b0a2010-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>
Dan Gohmanf17a25c2007-07-18 16:29:46 +000018 <li><a href="GettingStarted.html">Installation Instructions</a></li>
19 <li><a href="#portability">Portability and Supported Platforms</a></li>
Dan Gohman0de549c2008-10-14 16:23:02 +000020 <li><a href="#knownproblems">Known Problems</a></li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +000021 <li><a href="#additionalinfo">Additional Information</a></li>
22</ol>
23
24<div class="doc_author">
Dan Gohman0de549c2008-10-14 16:23:02 +000025 <p>Written by the <a href="http://llvm.org">LLVM Team</a></p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +000026</div>
27
Jeffrey Yasskin8ee1b0a2010-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
Dan Gohmanf17a25c2007-07-18 16:29:46 +000034<!-- *********************************************************************** -->
35<div class="doc_section">
36 <a name="intro">Introduction</a>
37</div>
38<!-- *********************************************************************** -->
39
40<div class="doc_text">
41
Chris Lattner92eacf82008-10-13 17:57:36 +000042<p>This document contains the release notes for the LLVM Compiler
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +000043Infrastructure, release 2.7. Here we describe the status of LLVM, including
Chris Lattner92eacf82008-10-13 17:57:36 +000044major improvements from the previous release and significant known problems.
Mikhail Glushenkovf61066a2009-03-01 18:09:47 +000045All LLVM releases may be downloaded from the <a
Chris Lattner92eacf82008-10-13 17:57:36 +000046href="http://llvm.org/releases/">LLVM releases web site</a>.</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +000047
48<p>For more information about LLVM, including information about the latest
49release, please check out the <a href="http://llvm.org/">main LLVM
50web site</a>. If you have questions or comments, the <a
Chris Lattner92eacf82008-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>
Dan Gohmanf17a25c2007-07-18 16:29:46 +000053
Mikhail Glushenkov808cd3e2008-10-13 02:08:34 +000054<p>Note that if you are reading this file from a Subversion checkout or the
Chris Lattnerb0d6c502007-09-21 03:54:09 +000055main LLVM web page, this document applies to the <i>next</i> release, not the
Gabor Greif7c65c4f2008-10-14 11:00:32 +000056current one. To see the release notes for a specific release, please see the
Chris Lattnerb0d6c502007-09-21 03:54:09 +000057<a href="http://llvm.org/releases/">releases page</a>.</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +000058
59</div>
Chris Lattner0b6ea7a2009-10-13 17:48:04 +000060
Dan Gohmanf17a25c2007-07-18 16:29:46 +000061
Chris Lattner0b6ea7a2009-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 Lattner35da3812010-01-09 22:30:40 +000067 ABCD, SCCVN, GEPSplitterPass
Chris Lattner2bd5e652010-01-16 21:25:13 +000068 MSIL backend?
Chris Lattner0b6ea7a2009-10-13 17:48:04 +000069-->
70
71
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +000072<!-- Features that need text if they're finished for 2.7:
Chris Lattner0b6ea7a2009-10-13 17:48:04 +000073 gcc plugin.
74 strong phi elim
75 variable debug info for optimized code
Chris Lattnerb2cc5022009-02-26 22:33:38 +000076 postalloc scheduler: anti dependence breaking, hazard recognizer?
Chris Lattner0b6ea7a2009-10-13 17:48:04 +000077 metadata
78 loop dependence analysis
79 ELF Writer? How stable?
80 <li>PostRA scheduler improvements, ARM adoption (David Goodwin).</li>
81 2.7 supports the GDB 7.0 jit interfaces for debug info.
82 2.7 eliminates ADT/iterator.h
Chris Lattner8fda4952008-02-10 07:46:44 +000083 -->
Mikhail Glushenkov808cd3e2008-10-13 02:08:34 +000084
Chris Lattner4f076402008-10-12 19:47:48 +000085 <!-- for announcement email:
Chris Lattner0b6ea7a2009-10-13 17:48:04 +000086 Logo web page.
87 llvm devmtg
88 compiler_rt
89 KLEE web page at klee.llvm.org
90 Many new papers added to /pubs/
91 Mention gcc plugin.
92
Chris Lattnera53f4972009-02-25 06:34:50 +000093 -->
Chris Lattner8fda4952008-02-10 07:46:44 +000094
Chris Lattner78a130b2008-10-13 18:01:01 +000095<!-- *********************************************************************** -->
96<div class="doc_section">
97 <a name="subproj">Sub-project Status Update</a>
Chris Lattnerf65224f2008-06-08 21:34:41 +000098</div>
Chris Lattner78a130b2008-10-13 18:01:01 +000099<!-- *********************************************************************** -->
Chris Lattnerf65224f2008-06-08 21:34:41 +0000100
101<div class="doc_text">
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000102<p>
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000103The LLVM 2.7 distribution currently consists of code from the core LLVM
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000104repository (which roughly includes the LLVM optimizers, code generators
105and supporting tools), the Clang repository and the llvm-gcc repository. In
106addition to this code, the LLVM Project includes other sub-projects that are in
107development. Here we include updates on these subprojects.
Bill Wendlingdde41b82009-03-02 04:28:57 +0000108</p>
Chris Lattner78a130b2008-10-13 18:01:01 +0000109
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000110</div>
111
Chris Lattner78a130b2008-10-13 18:01:01 +0000112
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000113<!--=========================================================================-->
Chris Lattner78a130b2008-10-13 18:01:01 +0000114<div class="doc_subsection">
Chris Lattnera3c683b2008-10-13 18:11:54 +0000115<a name="clang">Clang: C/C++/Objective-C Frontend Toolkit</a>
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000116</div>
117
118<div class="doc_text">
119
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000120<p>The <a href="http://clang.llvm.org/">Clang project</a> is ...</p>
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000121
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000122<p>In the LLVM 2.7 time-frame, the Clang team has made many improvements:</p>
Bill Wendling385b0d32008-10-27 09:27:33 +0000123
Daniel Dunbarf3e35782008-10-14 23:25:09 +0000124<ul>
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000125<li>...</li>
Bill Wendlinga8fb81d2009-03-02 04:28:18 +0000126</ul>
Chris Lattnera3c683b2008-10-13 18:11:54 +0000127</div>
128
129<!--=========================================================================-->
130<div class="doc_subsection">
131<a name="clangsa">Clang Static Analyzer</a>
132</div>
133
134<div class="doc_text">
135
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000136<p>Previously announced in the 2.4, 2.5, and 2.6 LLVM releases, the Clang project also
Ted Kremeneka0d77d72009-02-27 07:01:32 +0000137includes an early stage static source code analysis tool for <a
138href="http://clang.llvm.org/StaticAnalysis.html">automatically finding bugs</a>
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000139in C and Objective-C programs. The tool performs checks to find
Ted Kremeneka0d77d72009-02-27 07:01:32 +0000140bugs that occur on a specific path within a program.</p>
Chris Lattnerc2d84672008-10-14 00:52:49 +0000141
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000142<p>In the LLVM 2.7 time-frame, the analyzer core has ...</p>
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000143
144</div>
145
Chris Lattner78a130b2008-10-13 18:01:01 +0000146<!--=========================================================================-->
147<div class="doc_subsection">
Nicolas Geoffray2b139382008-10-14 19:23:04 +0000148<a name="vmkit">VMKit: JVM/CLI Virtual Machine Implementation</a>
Chris Lattner78a130b2008-10-13 18:01:01 +0000149</div>
150
151<div class="doc_text">
152<p>
Nicolas Geoffray2b139382008-10-14 19:23:04 +0000153The <a href="http://vmkit.llvm.org/">VMKit project</a> is an implementation of
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000154a JVM and a CLI Virtual Machine (Microsoft .NET is an
155implementation of the CLI) using LLVM for static and just-in-time
156compilation.</p>
Chris Lattner78a130b2008-10-13 18:01:01 +0000157
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000158<p>
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000159VMKit version ?? builds with LLVM 2.7 and you can find it on its
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000160<a href="http://vmkit.llvm.org/releases/">web page</a>. The release includes
Nicolas Geoffray20cfdd42008-10-15 20:25:04 +0000161bug fixes, cleanup and new features. The major changes are:</p>
Chris Lattner78a130b2008-10-13 18:01:01 +0000162
Nicolas Geoffray2b139382008-10-14 19:23:04 +0000163<ul>
164
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000165<li>...</li>
Nicolas Geoffray2b139382008-10-14 19:23:04 +0000166
167</ul>
Chris Lattner78a130b2008-10-13 18:01:01 +0000168</div>
169
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000170
171<!--=========================================================================-->
172<div class="doc_subsection">
173<a name="compiler-rt">compiler-rt: Compiler Runtime Library</a>
174</div>
175
176<div class="doc_text">
177<p>
178The new LLVM <a href="http://compiler-rt.llvm.org/">compiler-rt project</a>
179is a simple library that provides an implementation of the low-level
180target-specific hooks required by code generation and other runtime components.
181For example, when compiling for a 32-bit target, converting a double to a 64-bit
182unsigned integer is compiled into a runtime call to the "__fixunsdfdi"
183function. The compiler-rt library provides highly optimized implementations of
184this and other low-level routines (some are 3x faster than the equivalent
185libgcc routines).</p>
186
187<p>
188All of the code in the compiler-rt project is available under the standard LLVM
189License, a "BSD-style" license.</p>
190
191</div>
192
193<!--=========================================================================-->
194<div class="doc_subsection">
195<a name="klee">KLEE: Symbolic Execution and Automatic Test Case Generator</a>
196</div>
197
198<div class="doc_text">
199<p>
200The new LLVM <a href="http://klee.llvm.org/">KLEE project</a> is a symbolic
201execution framework for programs in LLVM bitcode form. KLEE tries to
202symbolically evaluate "all" paths through the application and records state
203transitions that lead to fault states. This allows it to construct testcases
204that lead to faults and can even be used to verify algorithms. For more
205details, please see the <a
206href="http://llvm.org/pubs/2008-12-OSDI-KLEE.html">OSDI 2008 paper</a> about
207KLEE.</p>
208
209</div>
210
211<!--=========================================================================-->
212<div class="doc_subsection">
213<a name="dragonegg">DragonEgg: GCC-4.5 as an LLVM frontend</a>
214</div>
215
216<div class="doc_text">
217<p>
218The goal of <a href="http://dragonegg.llvm.org/">DragonEgg</a> is to make
219gcc-4.5 act like llvm-gcc without requiring any gcc modifications whatsoever.
Duncan Sandsf6fb7142009-10-15 08:17:44 +0000220<a href="http://dragonegg.llvm.org/">DragonEgg</a> is a shared library (dragonegg.so)
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000221that is loaded by gcc at runtime. It ...
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000222</p>
223
224</div>
225
226
227<!--=========================================================================-->
228<div class="doc_subsection">
229<a name="mc">llvm-mc: Machine Code Toolkit</a>
230</div>
231
232<div class="doc_text">
233<p>
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000234The LLVM Machine Code (MC) Toolkit project is ...
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000235</p>
236
237</div>
238
239
Chris Lattnerb2cc5022009-02-26 22:33:38 +0000240<!-- *********************************************************************** -->
241<div class="doc_section">
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000242 <a name="externalproj">External Open Source Projects Using LLVM 2.7</a>
Chris Lattnerb2cc5022009-02-26 22:33:38 +0000243</div>
244<!-- *********************************************************************** -->
245
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000246<div class="doc_text">
247
248<p>An exciting aspect of LLVM is that it is used as an enabling technology for
249 a lot of other language and tools projects. This section lists some of the
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000250 projects that have already been updated to work with LLVM 2.7.</p>
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000251</div>
252
253
254<!--=========================================================================-->
255<div class="doc_subsection">
256<a name="Rubinius">Rubinius</a>
257</div>
258
259<div class="doc_text">
260<p><a href="http://github.com/evanphx/rubinius">Rubinius</a> is an environment
261for running Ruby code which strives to write as much of the core class
262implementation in Ruby as possible. Combined with a bytecode interpreting VM, it
263uses LLVM to optimize and compile ruby code down to machine code. Techniques
264such as type feedback, method inlining, and uncommon traps are all used to
265remove dynamism from ruby execution and increase performance.</p>
266
267<p>Since LLVM 2.5, Rubinius has made several major leaps forward, implementing
268a counter based JIT, type feedback and speculative method inlining.
269</p>
270
271</div>
272
273<!--=========================================================================-->
274<div class="doc_subsection">
275<a name="macruby">MacRuby</a>
276</div>
277
278<div class="doc_text">
279
280<p>
281<a href="http://macruby.org">MacRuby</a> is an implementation of Ruby on top of
282core Mac OS X technologies, such as the Objective-C common runtime and garbage
283collector and the CoreFoundation framework. It is principally developed by
284Apple and aims at enabling the creation of full-fledged Mac OS X applications.
285</p>
286
287<p>
288MacRuby uses LLVM for optimization passes, JIT and AOT compilation of Ruby
289expressions. It also uses zero-cost DWARF exceptions to implement Ruby exception
290handling.</p>
291
292</div>
293
294
Chris Lattnerb2cc5022009-02-26 22:33:38 +0000295<!--=========================================================================-->
296<div class="doc_subsection">
297<a name="pure">Pure</a>
298</div>
299
300<div class="doc_text">
301<p>
Chris Lattner47202c32009-03-02 02:37:32 +0000302<a href="http://pure-lang.googlecode.com/">Pure</a>
303is an algebraic/functional programming language based on term rewriting.
Chris Lattnerb2cc5022009-02-26 22:33:38 +0000304Programs are collections of equations which are used to evaluate expressions in
305a symbolic fashion. Pure offers dynamic typing, eager and lazy evaluation,
Mikhail Glushenkovf61066a2009-03-01 18:09:47 +0000306lexical closures, a hygienic macro system (also based on term rewriting),
Chris Lattnerb2cc5022009-02-26 22:33:38 +0000307built-in list and matrix support (including list and matrix comprehensions) and
308an easy-to-use C interface. The interpreter uses LLVM as a backend to
309 JIT-compile Pure programs to fast native code.</p>
310
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000311<p>Pure versions ??? and later have been tested and are known to work with
312LLVM 2.7 (and continue to work with older LLVM releases >= 2.3 as well).
Chris Lattnerb2cc5022009-02-26 22:33:38 +0000313</p>
314</div>
315
316
317<!--=========================================================================-->
318<div class="doc_subsection">
319<a name="ldc">LLVM D Compiler</a>
320</div>
321
322<div class="doc_text">
323<p>
Chris Lattner47202c32009-03-02 02:37:32 +0000324<a href="http://www.dsource.org/projects/ldc">LDC</a> is an implementation of
325the D Programming Language using the LLVM optimizer and code generator.
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000326The LDC project works great with the LLVM 2.6 release. General improvements in
John Criswellaea8c752009-03-02 15:28:15 +0000327this
Chris Lattner47202c32009-03-02 02:37:32 +0000328cycle have included new inline asm constraint handling, better debug info
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000329support, general bug fixes and better x86-64 support. This has allowed
330some major improvements in LDC, getting it much closer to being as
Chris Lattnerb2cc5022009-02-26 22:33:38 +0000331fully featured as the original DMD compiler from DigitalMars.
332</p>
333</div>
334
Chris Lattner1ad599a2009-02-28 18:58:01 +0000335<!--=========================================================================-->
336<div class="doc_subsection">
337<a name="RoadsendPHP">Roadsend PHP</a>
338</div>
339
340<div class="doc_text">
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000341<p>
342<a href="http://code.roadsend.com/rphp">Roadsend PHP</a> (rphp) is an open
Chris Lattner9e08de12009-03-02 19:07:24 +0000343source implementation of the PHP programming
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000344language that uses LLVM for its optimizer, JIT and static compiler. This is a
Chris Lattner9e08de12009-03-02 19:07:24 +0000345reimplementation of an earlier project that is now based on LLVM.</p>
Chris Lattner1ad599a2009-02-28 18:58:01 +0000346</div>
Chris Lattnerb2cc5022009-02-26 22:33:38 +0000347
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000348<!--=========================================================================-->
349<div class="doc_subsection">
350<a name="UnladenSwallow">Unladen Swallow</a>
351</div>
352
353<div class="doc_text">
354<p>
355<a href="http://code.google.com/p/unladen-swallow/">Unladen Swallow</a> is a
356branch of <a href="http://python.org/">Python</a> intended to be fully
357compatible and significantly faster. It uses LLVM's optimization passes and JIT
358compiler.</p>
359</div>
360
361<!--=========================================================================-->
362<div class="doc_subsection">
363<a name="llvm-lua">llvm-lua</a>
364</div>
365
366<div class="doc_text">
367<p>
368<a href="http://code.google.com/p/llvm-lua/">LLVM-Lua</a> uses LLVM to add JIT
369and static compiling support to the Lua VM. Lua bytecode is analyzed to
370remove type checks, then LLVM is used to compile the bytecode down to machine
371code.</p>
372</div>
373
374<!--=========================================================================-->
375<div class="doc_subsection">
376<a name="icedtea">IcedTea Java Virtual Machine Implementation</a>
377</div>
378
379<div class="doc_text">
380<p>
381<a href="http://icedtea.classpath.org/wiki/Main_Page">IcedTea</a> provides a
382harness to build OpenJDK using only free software build tools and to provide
383replacements for the not-yet free parts of OpenJDK. One of the extensions that
384IcedTea provides is a new JIT compiler named <a
385href="http://icedtea.classpath.org/wiki/ZeroSharkFaq">Shark</a> which uses LLVM
386to provide native code generation without introducing processor-dependent
387code.
388</p>
389</div>
390
391
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000392
393<!-- *********************************************************************** -->
394<div class="doc_section">
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000395 <a name="whatsnew">What's New in LLVM 2.7?</a>
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000396</div>
397<!-- *********************************************************************** -->
398
Chris Lattner5cce7a52008-06-08 22:59:35 +0000399<div class="doc_text">
400
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000401<p>This release includes a huge number of bug fixes, performance tweaks and
Chris Lattner92eacf82008-10-13 17:57:36 +0000402minor improvements. Some of the major improvements and new features are listed
403in this section.
Chris Lattner5cce7a52008-06-08 22:59:35 +0000404</p>
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000405
Chris Lattner5cce7a52008-06-08 22:59:35 +0000406</div>
407
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000408<!--=========================================================================-->
Chris Lattnerf65224f2008-06-08 21:34:41 +0000409<div class="doc_subsection">
Chris Lattnere0798082008-02-06 18:00:06 +0000410<a name="majorfeatures">Major New Features</a>
411</div>
412
413<div class="doc_text">
414
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000415<p>LLVM 2.7 includes several major new capabilities:</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000416
417<ul>
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000418<li>...</li>
Chris Lattner5ba16862008-02-10 08:18:42 +0000419</ul>
420
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000421</div>
422
Chris Lattnerb0d6c502007-09-21 03:54:09 +0000423<!--=========================================================================-->
424<div class="doc_subsection">
Chris Lattner47202c32009-03-02 02:37:32 +0000425<a name="coreimprovements">LLVM IR and Core Improvements</a>
Chris Lattnerc3649452008-02-10 08:17:19 +0000426</div>
427
428<div class="doc_text">
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000429<p>LLVM IR has several new features for better support of new targets and that
430expose new optimization opportunities:</p>
Chris Lattnerc3649452008-02-10 08:17:19 +0000431
Chris Lattnerc5a4e312008-06-05 06:25:56 +0000432<ul>
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000433<li>...</li>
Chris Lattnerc3649452008-02-10 08:17:19 +0000434</ul>
Mikhail Glushenkov808cd3e2008-10-13 02:08:34 +0000435
Chris Lattnerc3649452008-02-10 08:17:19 +0000436</div>
437
438<!--=========================================================================-->
439<div class="doc_subsection">
Chris Lattner8fda4952008-02-10 07:46:44 +0000440<a name="optimizer">Optimizer Improvements</a>
441</div>
442
443<div class="doc_text">
444
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000445<p>In addition to a large array of minor performance tweaks and bug fixes, this
Chris Lattnerea9c2242008-10-13 21:50:36 +0000446release includes a few major enhancements and additions to the optimizers:</p>
Chris Lattner8fda4952008-02-10 07:46:44 +0000447
448<ul>
449
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000450<li>...</li>
Chris Lattner47202c32009-03-02 02:37:32 +0000451
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000452</ul>
Chris Lattner47202c32009-03-02 02:37:32 +0000453
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000454</div>
Chris Lattner47202c32009-03-02 02:37:32 +0000455
Chris Lattner47202c32009-03-02 02:37:32 +0000456
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000457<!--=========================================================================-->
458<div class="doc_subsection">
459<a name="executionengine">Interpreter and JIT Improvements</a>
460</div>
Chris Lattnerea9c2242008-10-13 21:50:36 +0000461
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000462<div class="doc_text">
463
464<ul>
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000465<li>...</li>
Chris Lattner0eef6e42008-06-08 02:45:07 +0000466</ul>
467
468</div>
469
470<!--=========================================================================-->
471<div class="doc_subsection">
Chris Lattner5f393542009-03-02 03:24:11 +0000472<a name="codegen">Target Independent Code Generator Improvements</a>
Chris Lattner0eef6e42008-06-08 02:45:07 +0000473</div>
474
475<div class="doc_text">
476
Mikhail Glushenkovf61066a2009-03-01 18:09:47 +0000477<p>We have put a significant amount of work into the code generator
478infrastructure, which allows us to implement more aggressive algorithms and make
479it run faster:</p>
Chris Lattner0eef6e42008-06-08 02:45:07 +0000480
481<ul>
Chris Lattner5f393542009-03-02 03:24:11 +0000482
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000483<li>...</li>
Chris Lattnerb0d6c502007-09-21 03:54:09 +0000484</ul>
Chris Lattnerb0d6c502007-09-21 03:54:09 +0000485</div>
486
Chris Lattner47202c32009-03-02 02:37:32 +0000487<!--=========================================================================-->
488<div class="doc_subsection">
489<a name="x86">X86-32 and X86-64 Target Improvements</a>
490</div>
491
492<div class="doc_text">
493<p>New features of the X86 target include:
494</p>
495
496<ul>
Chris Lattner5f393542009-03-02 03:24:11 +0000497
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000498<li>...</li>
Chris Lattner5f393542009-03-02 03:24:11 +0000499
Chris Lattner47202c32009-03-02 02:37:32 +0000500</ul>
501
Chris Lattner47202c32009-03-02 02:37:32 +0000502</div>
Chris Lattnerb0d6c502007-09-21 03:54:09 +0000503
504<!--=========================================================================-->
505<div class="doc_subsection">
Chris Lattnere1fbd752009-02-26 07:32:11 +0000506<a name="pic16">PIC16 Target Improvements</a>
507</div>
508
509<div class="doc_text">
510<p>New features of the PIC16 target include:
511</p>
512
513<ul>
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000514<li>...</li>
Chris Lattnere1fbd752009-02-26 07:32:11 +0000515</ul>
516
517<p>Things not yet supported:</p>
518
519<ul>
Chris Lattnere1fbd752009-02-26 07:32:11 +0000520<li>Variable arguments.</li>
Chris Lattner5f393542009-03-02 03:24:11 +0000521<li>Interrupts/programs.</li>
Chris Lattnere1fbd752009-02-26 07:32:11 +0000522</ul>
523
524</div>
525
Chris Lattnere1fbd752009-02-26 07:32:11 +0000526<!--=========================================================================-->
527<div class="doc_subsection">
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000528<a name="ARM">ARM Target Improvements</a>
Chris Lattner7ccc40d2009-03-01 02:30:21 +0000529</div>
530
531<div class="doc_text">
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000532<p>New features of the ARM target include:
533</p>
Chris Lattner7ccc40d2009-03-01 02:30:21 +0000534
535<ul>
Chris Lattner7ccc40d2009-03-01 02:30:21 +0000536
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000537<li>...</li>
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000538</ul>
Chris Lattner7ccc40d2009-03-01 02:30:21 +0000539
Chris Lattner7ccc40d2009-03-01 02:30:21 +0000540
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000541</div>
Chris Lattner7ccc40d2009-03-01 02:30:21 +0000542
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000543<!--=========================================================================-->
544<div class="doc_subsection">
545<a name="OtherTarget">Other Target Specific Improvements</a>
546</div>
Chris Lattner7ccc40d2009-03-01 02:30:21 +0000547
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000548<div class="doc_text">
549<p>New features of other targets include:
550</p>
551
552<ul>
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000553<li>...</li>
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000554</ul>
555
556</div>
557
558<!--=========================================================================-->
559<div class="doc_subsection">
560<a name="newapis">New Useful APIs</a>
561</div>
562
563<div class="doc_text">
564
565<p>This release includes a number of new APIs that are used internally, which
566 may also be useful for external clients.
567</p>
568
569<ul>
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000570<li>...</li>
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000571</ul>
572
573
574</div>
575
576<!--=========================================================================-->
577<div class="doc_subsection">
578<a name="otherimprovements">Other Improvements and New Features</a>
579</div>
580
581<div class="doc_text">
582<p>Other miscellaneous features include:</p>
583
584<ul>
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000585<li>...</li>
Chris Lattner7ccc40d2009-03-01 02:30:21 +0000586</ul>
587
588</div>
589
Chris Lattnere45f18b2008-06-05 08:02:49 +0000590
591<!--=========================================================================-->
592<div class="doc_subsection">
Chris Lattner92eacf82008-10-13 17:57:36 +0000593<a name="changes">Major Changes and Removed Features</a>
594</div>
595
596<div class="doc_text">
597
Chris Lattnercc64a322008-10-13 22:06:31 +0000598<p>If you're already an LLVM user or developer with out-of-tree changes based
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000599on LLVM 2.6, this section lists some "gotchas" that you may run into upgrading
Chris Lattnercc64a322008-10-13 22:06:31 +0000600from the previous release.</p>
Chris Lattner92eacf82008-10-13 17:57:36 +0000601
602<ul>
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000603<li>...</li>
Chris Lattnercc64a322008-10-13 22:06:31 +0000604</ul>
605
606
607<p>In addition, many APIs have changed in this release. Some of the major LLVM
608API changes are:</p>
609
610<ul>
Jeffrey Yasskin2ca16212010-01-28 01:41:20 +0000611<li><tt>ModuleProvider</tt> has been <a
612href="http://llvm.org/viewvc/llvm-project?view=rev&revision=94686">removed</a>
613and its methods moved to <tt>Module</tt> and <tt>GlobalValue</tt>.
614Most clients can remove uses of <tt>ExistingModuleProvider</tt>,
615replace <tt>getBitcodeModuleProvider</tt> with
616<tt>getLazyBitcodeModule</tt>, and pass their <tt>Module</tt> to
617functions that used to accept <tt>ModuleProvider</tt>. Clients who
618wrote their own <tt>ModuleProvider</tt>s will need to derive from
619<tt>GVMaterializer</tt> instead and use
620<tt>Module::setMaterializer</tt> to attach it to a
621<tt>Module</tt>.</li>
622
623<li><tt>GhostLinkage</tt> has given up the ghost.
624<tt>GlobalValue</tt>s that have not yet been read from their backing
625storage have the same linkage they will have after being read in.
626Clients must replace calls to
627<tt>GlobalValue::hasNotBeenReadFromBitcode</tt> with
628<tt>GlobalValue::isMaterializable</tt>.</li>
Devang Patel0e3da1a2008-10-14 20:03:43 +0000629</ul>
Chris Lattner92eacf82008-10-13 17:57:36 +0000630
Chris Lattner92eacf82008-10-13 17:57:36 +0000631</div>
632
633
634
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000635<!-- *********************************************************************** -->
636<div class="doc_section">
637 <a name="portability">Portability and Supported Platforms</a>
638</div>
639<!-- *********************************************************************** -->
640
641<div class="doc_text">
642
643<p>LLVM is known to work on the following platforms:</p>
644
645<ul>
Mikhail Glushenkovf61066a2009-03-01 18:09:47 +0000646<li>Intel and AMD machines (IA32, X86-64, AMD64, EMT-64) running Red Hat
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000647 Linux, Fedora Core, FreeBSD and AuroraUX (and probably other unix-like
648 systems).</li>
Mikhail Glushenkovf61066a2009-03-01 18:09:47 +0000649<li>PowerPC and X86-based Mac OS X systems, running 10.3 and above in 32-bit
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000650 and 64-bit modes.</li>
Chris Lattnere0798082008-02-06 18:00:06 +0000651<li>Intel and AMD machines running on Win32 using MinGW libraries (native).</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000652<li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
653 support is available for native builds with Visual C++).</li>
Chris Lattner9235ce52009-10-16 16:30:58 +0000654<li>Sun x86 and AMD64 machines running Solaris 10, OpenSolaris 0906.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000655<li>Alpha-based machines running Debian GNU/Linux.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000656</ul>
657
Chris Lattnerba948522008-06-05 06:57:39 +0000658<p>The core LLVM infrastructure uses GNU autoconf to adapt itself
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000659to the machine and operating system on which it is built. However, minor
660porting may be required to get LLVM to work on new platforms. We welcome your
661portability patches and reports of successful builds or error messages.</p>
662
663</div>
664
665<!-- *********************************************************************** -->
666<div class="doc_section">
667 <a name="knownproblems">Known Problems</a>
668</div>
669<!-- *********************************************************************** -->
670
671<div class="doc_text">
672
Mikhail Glushenkovf61066a2009-03-01 18:09:47 +0000673<p>This section contains significant known problems with the LLVM system,
Chris Lattnerb1ad47c2008-11-10 05:40:34 +0000674listed by component. If you run into a problem, please check the <a
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000675href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
676there isn't already one.</p>
677
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000678<ul>
679<li>The llvm-gcc bootstrap will fail with some versions of binutils (e.g. 2.15)
680 with a message of "<tt><a href="http://llvm.org/PR5004">Error: can not do 8
681 byte pc-relative relocation</a></tt>" when building C++ code. We intend to
Jeffrey Yasskin8ee1b0a2010-01-28 01:14:43 +0000682 fix this on mainline, but a workaround is to upgrade to binutils 2.17 or
683 later.</li>
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000684
685<li>LLVM will not correctly compile on Solaris and/or OpenSolaris
686using the stock GCC 3.x.x series 'out the box',
Chris Lattnerc09ffd22009-11-03 21:50:09 +0000687See: <a href="GettingStarted.html#brokengcc">Broken versions of GCC and other tools</a>.
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000688However, A <a href="http://pkg.auroraux.org/GCC">Modern GCC Build</a>
689for x86/x86-64 has been made available from the third party AuroraUX Project
690that has been meticulously tested for bootstrapping LLVM &amp; Clang.</li>
691</ul>
692
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000693</div>
694
695<!-- ======================================================================= -->
696<div class="doc_subsection">
697 <a name="experimental">Experimental features included with this release</a>
698</div>
699
700<div class="doc_text">
701
702<p>The following components of this LLVM release are either untested, known to
703be broken or unreliable, or are in early development. These components should
704not be relied on, and bugs should not be filed against them, but they may be
705useful to some people. In particular, if you would like to work on one of these
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000706components, please contact us on the <a
707href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000708
709<ul>
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000710<li>The MSIL, Alpha, SPU, MIPS, PIC16, Blackfin, MSP430 and SystemZ backends are
711 experimental.</li>
Bill Wendling9c7c4382009-03-02 07:54:14 +0000712<li>The <tt>llc</tt> "<tt>-filetype=asm</tt>" (the default) is the only
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000713 supported value for this option. The ELF writer is experimental.</li>
714<li>The implementation of Andersen's Alias Analysis has many known bugs.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000715</ul>
716
717</div>
718
719<!-- ======================================================================= -->
720<div class="doc_subsection">
721 <a name="x86-be">Known problems with the X86 back-end</a>
722</div>
723
724<div class="doc_text">
725
726<ul>
Anton Korobeynikov77d15e22008-06-08 10:24:13 +0000727 <li>The X86 backend does not yet support
728 all <a href="http://llvm.org/PR879">inline assembly that uses the X86
729 floating point stack</a>. It supports the 'f' and 't' constraints, but not
730 'u'.</li>
Chris Lattnerd95b5962008-06-08 21:19:07 +0000731 <li>The X86 backend generates inefficient floating point code when configured
732 to generate code for systems that don't have SSE2.</li>
Duncan Sands8b4f3772008-06-08 19:38:43 +0000733 <li>Win64 code generation wasn't widely tested. Everything should work, but we
John Criswellaea8c752009-03-02 15:28:15 +0000734 expect small issues to happen. Also, llvm-gcc cannot build the mingw64
735 runtime currently due
Anton Korobeynikov77d15e22008-06-08 10:24:13 +0000736 to <a href="http://llvm.org/PR2255">several</a>
John Criswellaea8c752009-03-02 15:28:15 +0000737 <a href="http://llvm.org/PR2257">bugs</a> and due to lack of support for
738 the
739 'u' inline assembly constraint and for X87 floating point inline assembly.</li>
Dan Gohman3882ecb2008-06-08 23:05:11 +0000740 <li>The X86-64 backend does not yet support the LLVM IR instruction
Chris Lattner47202c32009-03-02 02:37:32 +0000741 <tt>va_arg</tt>. Currently, the llvm-gcc and front-ends support variadic
Dan Gohman3882ecb2008-06-08 23:05:11 +0000742 argument constructs on X86-64 by lowering them manually.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000743</ul>
744
745</div>
746
747<!-- ======================================================================= -->
748<div class="doc_subsection">
749 <a name="ppc-be">Known problems with the PowerPC back-end</a>
750</div>
751
752<div class="doc_text">
753
754<ul>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000755<li>The Linux PPC32/ABI support needs testing for the interpreter and static
756compilation, and lacks support for debug information.</li>
757</ul>
758
759</div>
760
761<!-- ======================================================================= -->
762<div class="doc_subsection">
763 <a name="arm-be">Known problems with the ARM back-end</a>
764</div>
765
766<div class="doc_text">
767
768<ul>
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000769<li>Support for the Advanced SIMD (Neon) instruction set is still incomplete
770and not well tested. Some features may not work at all, and the code quality
771may be poor in some cases.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000772<li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
Duncan Sands1827fa62007-09-26 15:59:54 +0000773processors, thumb programs can crash or produce wrong
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000774results (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
John Criswellaea8c752009-03-02 15:28:15 +0000775<li>Compilation for ARM Linux OABI (old ABI) is supported but not fully tested.
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000776</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000777</ul>
778
779</div>
780
781<!-- ======================================================================= -->
782<div class="doc_subsection">
783 <a name="sparc-be">Known problems with the SPARC back-end</a>
784</div>
785
786<div class="doc_text">
787
788<ul>
John Criswellaea8c752009-03-02 15:28:15 +0000789<li>The SPARC backend only supports the 32-bit SPARC ABI (-m32); it does not
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000790 support the 64-bit SPARC ABI (-m64).</li>
791</ul>
792
793</div>
794
795<!-- ======================================================================= -->
796<div class="doc_subsection">
Bruno Cardoso Lopes62d45d72008-10-25 14:56:26 +0000797 <a name="mips-be">Known problems with the MIPS back-end</a>
798</div>
799
800<div class="doc_text">
801
802<ul>
Bruno Cardoso Lopes62d45d72008-10-25 14:56:26 +0000803<li>64-bit MIPS targets are not supported yet.</li>
804</ul>
805
806</div>
807
808<!-- ======================================================================= -->
809<div class="doc_subsection">
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000810 <a name="alpha-be">Known problems with the Alpha back-end</a>
811</div>
812
813<div class="doc_text">
814
815<ul>
816
817<li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
818appropriate nops inserted to ensure restartability.</li>
819
820</ul>
821</div>
822
823<!-- ======================================================================= -->
824<div class="doc_subsection">
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000825 <a name="c-be">Known problems with the C back-end</a>
826</div>
827
828<div class="doc_text">
829
830<ul>
Chris Lattner499c07c2008-06-05 06:35:40 +0000831<li><a href="http://llvm.org/PR802">The C backend has only basic support for
832 inline assembly code</a>.</li>
Chris Lattnere0194462007-09-26 06:01:35 +0000833<li><a href="http://llvm.org/PR1658">The C backend violates the ABI of common
834 C++ programs</a>, preventing intermixing between C++ compiled by the CBE and
Gabor Greife33c5322009-03-02 12:02:51 +0000835 C++ code compiled with <tt>llc</tt> or native compilers.</li>
Duncan Sandsbd0ad6e2008-02-10 13:40:55 +0000836<li>The C backend does not support all exception handling constructs.</li>
Duncan Sandse6e264c2009-02-25 11:51:54 +0000837<li>The C backend does not support arbitrary precision integers.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000838</ul>
839
840</div>
841
842
843<!-- ======================================================================= -->
844<div class="doc_subsection">
Chris Lattner499c07c2008-06-05 06:35:40 +0000845 <a name="c-fe">Known problems with the llvm-gcc C front-end</a>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000846</div>
847
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000848<div class="doc_text">
849
Chris Lattner499c07c2008-06-05 06:35:40 +0000850<p>The only major language feature of GCC not supported by llvm-gcc is
851 the <tt>__builtin_apply</tt> family of builtins. However, some extensions
852 are only supported on some targets. For example, trampolines are only
Duncan Sandsa73561c2008-06-08 20:18:35 +0000853 supported on some targets (these are used when you take the address of a
854 nested function).</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000855
Chris Lattner499c07c2008-06-05 06:35:40 +0000856<p>If you run into GCC extensions which are not supported, please let us know.
857</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000858
859</div>
860
861<!-- ======================================================================= -->
862<div class="doc_subsection">
Chris Lattner499c07c2008-06-05 06:35:40 +0000863 <a name="c++-fe">Known problems with the llvm-gcc C++ front-end</a>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000864</div>
865
866<div class="doc_text">
867
868<p>The C++ front-end is considered to be fully
869tested and works for a number of non-trivial programs, including LLVM
870itself, Qt, Mozilla, etc.</p>
871
872<ul>
Anton Korobeynikovd9a17932008-10-11 18:27:16 +0000873<li>Exception handling works well on the X86 and PowerPC targets. Currently
Chris Lattnerb1ad47c2008-11-10 05:40:34 +0000874 only Linux and Darwin targets are supported (both 32 and 64 bit).</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000875</ul>
876
877</div>
878
Chris Lattner6c8a1b82008-10-30 03:58:13 +0000879<!-- ======================================================================= -->
880<div class="doc_subsection">
881 <a name="fortran-fe">Known problems with the llvm-gcc Fortran front-end</a>
882</div>
883
884<div class="doc_text">
Gabor Greif1fc8fbc2008-11-04 21:50:59 +0000885<ul>
Chris Lattner6c8a1b82008-10-30 03:58:13 +0000886<li>Fortran support generally works, but there are still several unresolved bugs
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000887 in <a href="http://llvm.org/bugs/">Bugzilla</a>. Please see the
888 tools/gfortran component for details.</li>
Gabor Greif1fc8fbc2008-11-04 21:50:59 +0000889</ul>
Chris Lattner6c8a1b82008-10-30 03:58:13 +0000890</div>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000891
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000892<!-- ======================================================================= -->
893<div class="doc_subsection">
Chris Lattner499c07c2008-06-05 06:35:40 +0000894 <a name="ada-fe">Known problems with the llvm-gcc Ada front-end</a>
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000895</div>
896
897<div class="doc_text">
John Criswellaea8c752009-03-02 15:28:15 +0000898The llvm-gcc 4.2 Ada compiler works fairly well; however, this is not a mature
899technology, and problems should be expected.
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000900<ul>
Duncan Sandsa73561c2008-06-08 20:18:35 +0000901<li>The Ada front-end currently only builds on X86-32. This is mainly due
John Criswellaea8c752009-03-02 15:28:15 +0000902to lack of trampoline support (pointers to nested functions) on other platforms.
903However, it <a href="http://llvm.org/PR2006">also fails to build on X86-64</a>
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000904which does support trampolines.</li>
905<li>The Ada front-end <a href="http://llvm.org/PR2007">fails to bootstrap</a>.
Duncan Sandsf73473e2009-02-25 11:59:06 +0000906This is due to lack of LLVM support for <tt>setjmp</tt>/<tt>longjmp</tt> style
907exception handling, which is used internally by the compiler.
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000908Workaround: configure with <tt>--disable-bootstrap</tt>.</li>
Duncan Sands2dbc2e82008-10-13 17:27:23 +0000909<li>The c380004, <a href="http://llvm.org/PR2010">c393010</a>
910and <a href="http://llvm.org/PR2421">cxg2021</a> ACATS tests fail
Duncan Sandsf73473e2009-02-25 11:59:06 +0000911(c380004 also fails with gcc-4.2 mainline).
912If the compiler is built with checks disabled then <a href="http://llvm.org/PR2010">c393010</a>
913causes the compiler to go into an infinite loop, using up all system memory.</li>
Duncan Sandsc2a29a02009-03-02 16:35:57 +0000914<li>Some GCC specific Ada tests continue to crash the compiler.</li>
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000915<li>The <tt>-E</tt> binder option (exception backtraces)
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000916<a href="http://llvm.org/PR1982">does not work</a> and will result in programs
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000917crashing if an exception is raised. Workaround: do not use <tt>-E</tt>.</li>
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000918<li>Only discrete types <a href="http://llvm.org/PR1981">are allowed to start
919or finish at a non-byte offset</a> in a record. Workaround: do not pack records
920or use representation clauses that result in a field of a non-discrete type
921starting or finishing in the middle of a byte.</li>
Chris Lattnerd95b5962008-06-08 21:19:07 +0000922<li>The <tt>lli</tt> interpreter <a href="http://llvm.org/PR2009">considers
923'main' as generated by the Ada binder to be invalid</a>.
924Workaround: hand edit the file to use pointers for <tt>argv</tt> and
925<tt>envp</tt> rather than integers.</li>
926<li>The <tt>-fstack-check</tt> option <a href="http://llvm.org/PR2008">is
927ignored</a>.</li>
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000928</ul>
929</div>
930
Chris Lattner0b6ea7a2009-10-13 17:48:04 +0000931<!-- ======================================================================= -->
932<div class="doc_subsection">
933 <a name="ocaml-bindings">Known problems with the O'Caml bindings</a>
934</div>
935
936<div class="doc_text">
937
938<p>The <tt>Llvm.Linkage</tt> module is broken, and has incorrect values. Only
939<tt>Llvm.Linkage.External</tt>, <tt>Llvm.Linkage.Available_externally</tt>, and
940<tt>Llvm.Linkage.Link_once</tt> will be correct. If you need any of the other linkage
941modes, you'll have to write an external C library in order to expose the
942functionality. This has been fixed in the trunk.</p>
943</div>
944
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000945<!-- *********************************************************************** -->
946<div class="doc_section">
947 <a name="additionalinfo">Additional Information</a>
948</div>
949<!-- *********************************************************************** -->
950
951<div class="doc_text">
952
953<p>A wide variety of additional information is available on the <a
954href="http://llvm.org">LLVM web page</a>, in particular in the <a
955href="http://llvm.org/docs/">documentation</a> section. The web page also
956contains versions of the API documentation which is up-to-date with the
957Subversion version of the source code.
958You can access versions of these documents specific to this release by going
959into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
960
961<p>If you have any questions or comments about LLVM, please feel free to contact
962us via the <a href="http://llvm.org/docs/#maillist"> mailing
963lists</a>.</p>
964
965</div>
966
967<!-- *********************************************************************** -->
968
969<hr>
970<address>
971 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman947321d2008-12-11 17:34:48 +0000972 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000973 <a href="http://validator.w3.org/check/referer"><img
Misha Brukman947321d2008-12-11 17:34:48 +0000974 src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000975
976 <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
977 Last modified: $Date$
978</address>
979
980</body>
981</html>