blob: 035dace224d2b47e80bac383de6ed5810d13dbf5 [file] [log] [blame]
Misha Brukman500bc302003-11-22 00:38:41 +00001<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
3<html>
4<head>
Reid Spencer6454ed32004-11-18 18:38:58 +00005 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
Misha Brukman500bc302003-11-22 00:38:41 +00006 <link rel="stylesheet" href="llvm.css" type="text/css">
Chris Lattner38ab04c2009-02-25 04:41:31 +00007 <title>LLVM 2.5 Release Notes</title>
Misha Brukman500bc302003-11-22 00:38:41 +00008</head>
9<body>
Chris Lattner79c3fe12003-10-02 04:57:28 +000010
Chris Lattner38ab04c2009-02-25 04:41:31 +000011<div class="doc_title">LLVM 2.5 Release Notes</div>
Mikhail Glushenkovea65d7d2008-10-13 02:08:34 +000012
Chris Lattner79c3fe12003-10-02 04:57:28 +000013<ol>
Misha Brukman500bc302003-11-22 00:38:41 +000014 <li><a href="#intro">Introduction</a></li>
Chris Lattner96a445e2008-10-13 18:01:01 +000015 <li><a href="#subproj">Sub-project Status Update</a></li>
Chris Lattnerab68e9e2009-02-26 22:33:38 +000016 <li><a href="#externalproj">External Projects Using LLVM 2.5</a></li>
Chris Lattner96a445e2008-10-13 18:01:01 +000017 <li><a href="#whatsnew">What's New in LLVM?</a></li>
Chris Lattner4b538b92004-04-30 22:17:12 +000018 <li><a href="GettingStarted.html">Installation Instructions</a></li>
Misha Brukman500bc302003-11-22 00:38:41 +000019 <li><a href="#portability">Portability and Supported Platforms</a></li>
Dan Gohman44aa9212008-10-14 16:23:02 +000020 <li><a href="#knownproblems">Known Problems</a></li>
Misha Brukman500bc302003-11-22 00:38:41 +000021 <li><a href="#additionalinfo">Additional Information</a></li>
Chris Lattner79c3fe12003-10-02 04:57:28 +000022</ol>
23
Chris Lattner7911ce22004-05-23 21:07:27 +000024<div class="doc_author">
Dan Gohman44aa9212008-10-14 16:23:02 +000025 <p>Written by the <a href="http://llvm.org">LLVM Team</a></p>
Misha Brukman500bc302003-11-22 00:38:41 +000026</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +000027
28<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +000029<div class="doc_section">
30 <a name="intro">Introduction</a>
31</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +000032<!-- *********************************************************************** -->
33
Misha Brukman500bc302003-11-22 00:38:41 +000034<div class="doc_text">
35
Chris Lattnerf6662f92008-10-13 17:57:36 +000036<p>This document contains the release notes for the LLVM Compiler
Chris Lattner38ab04c2009-02-25 04:41:31 +000037Infrastructure, release 2.5. Here we describe the status of LLVM, including
Chris Lattnerf6662f92008-10-13 17:57:36 +000038major improvements from the previous release and significant known problems.
Mikhail Glushenkovf795ef02009-03-01 18:09:47 +000039All LLVM releases may be downloaded from the <a
Chris Lattnerf6662f92008-10-13 17:57:36 +000040href="http://llvm.org/releases/">LLVM releases web site</a>.</p>
Chris Lattner19092612003-10-02 16:38:05 +000041
Chris Lattner7506b1d2004-12-07 08:04:13 +000042<p>For more information about LLVM, including information about the latest
Chris Lattnerc463b272005-10-29 07:07:09 +000043release, please check out the <a href="http://llvm.org/">main LLVM
Chris Lattner47ad72c2003-10-07 21:38:31 +000044web site</a>. If you have questions or comments, the <a
Chris Lattnerf6662f92008-10-13 17:57:36 +000045href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM Developer's Mailing
46List</a> is a good place to send them.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +000047
Mikhail Glushenkovea65d7d2008-10-13 02:08:34 +000048<p>Note that if you are reading this file from a Subversion checkout or the
Chris Lattner84977642007-09-21 03:54:09 +000049main LLVM web page, this document applies to the <i>next</i> release, not the
Gabor Greiffa933f82008-10-14 11:00:32 +000050current one. To see the release notes for a specific release, please see the
Chris Lattner84977642007-09-21 03:54:09 +000051<a href="http://llvm.org/releases/">releases page</a>.</p>
Misha Brukman500bc302003-11-22 00:38:41 +000052
53</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +000054
Chris Lattner38ab04c2009-02-25 04:41:31 +000055<!-- Unfinished features in 2.5:
Chris Lattneracce85d2008-02-10 07:46:44 +000056 Machine LICM
57 Machine Sinking
Chris Lattner74c80df2009-02-25 06:34:50 +000058 target-specific intrinsics
59 gold lto plugin
Chris Lattner99f375b2009-02-25 07:32:53 +000060 pre-alloc splitter, strong phi elim
Chris Lattner547a3912008-10-12 19:47:48 +000061 llc -enable-value-prop, propagation of value info (sign/zero ext info) from
62 one MBB to another
Chris Lattner74c80df2009-02-25 06:34:50 +000063 debug info for optimized code
Chris Lattnerc1771e32009-02-26 07:29:17 +000064 interpreter + libffi
Chris Lattnerab68e9e2009-02-26 22:33:38 +000065 postalloc scheduler: anti dependence breaking, hazard recognizer?
66
Chris Lattneracce85d2008-02-10 07:46:44 +000067 -->
Mikhail Glushenkovea65d7d2008-10-13 02:08:34 +000068
Chris Lattner547a3912008-10-12 19:47:48 +000069 <!-- for announcement email:
Chris Lattner74c80df2009-02-25 06:34:50 +000070 -->
Chris Lattneracce85d2008-02-10 07:46:44 +000071
Chris Lattner96a445e2008-10-13 18:01:01 +000072<!-- *********************************************************************** -->
73<div class="doc_section">
74 <a name="subproj">Sub-project Status Update</a>
Chris Lattnerea34f642008-06-08 21:34:41 +000075</div>
Chris Lattner96a445e2008-10-13 18:01:01 +000076<!-- *********************************************************************** -->
Chris Lattnerea34f642008-06-08 21:34:41 +000077
78<div class="doc_text">
Chris Lattner8348b472008-06-08 21:58:17 +000079<p>
Chris Lattner38ab04c2009-02-25 04:41:31 +000080The LLVM 2.5 distribution currently consists of code from the core LLVM
Chris Lattnerfb97b2d2008-10-13 18:11:54 +000081repository (which roughly includes the LLVM optimizers, code generators and
Chris Lattner8348b472008-06-08 21:58:17 +000082supporting tools) and the llvm-gcc repository. In addition to this code, the
83LLVM Project includes other sub-projects that are in development. The two which
Chris Lattner857fb132008-10-11 18:18:28 +000084are the most actively developed are the <a href="#clang">Clang Project</a> and
Nicolas Geoffray99a4d302008-10-14 19:23:04 +000085the <a href="#vmkit">VMKit Project</a>.
Chris Lattner8348b472008-06-08 21:58:17 +000086</p>
Chris Lattner96a445e2008-10-13 18:01:01 +000087
Chris Lattner8348b472008-06-08 21:58:17 +000088</div>
89
Chris Lattner96a445e2008-10-13 18:01:01 +000090
Chris Lattner8348b472008-06-08 21:58:17 +000091<!--=========================================================================-->
Chris Lattner96a445e2008-10-13 18:01:01 +000092<div class="doc_subsection">
Chris Lattnerfb97b2d2008-10-13 18:11:54 +000093<a name="clang">Clang: C/C++/Objective-C Frontend Toolkit</a>
Chris Lattner8348b472008-06-08 21:58:17 +000094</div>
95
96<div class="doc_text">
97
98<p>The <a href="http://clang.llvm.org/">Clang project</a> is an effort to build
99a set of new 'LLVM native' front-end technologies for the LLVM optimizer
Mikhail Glushenkovf795ef02009-03-01 18:09:47 +0000100and code generator. While Clang is not included in the LLVM 2.5 release, it
Chris Lattnerf40c40b2009-02-25 05:09:54 +0000101is continuing to make major strides forward in all areas. Its C and Objective-C
102parsing and code generation support is now very solid. For example, it is
103capable of successfully building many real applications for X86-32 and X86-64,
Chris Lattnerab68e9e2009-02-26 22:33:38 +0000104including <a href="http://wiki.freebsd.org/BuildingFreeBSDWithClang">the FreeBSD
105kernel</a>. C++ is also making <a
Chris Lattnerf40c40b2009-02-25 05:09:54 +0000106href="http://clang.llvm.org/cxx_status.html">incredible progress</a>, and work
107on templates has recently started.</p>
Chris Lattner8348b472008-06-08 21:58:17 +0000108
Chris Lattnerf40c40b2009-02-25 05:09:54 +0000109<p>While Clang is not yet production quality, it is progressing very nicely and
110is quite usable for building many C and Objective-C applications. If you are
111interested in fast compiles and good diagnostics, we encourage you to try it out
Chris Lattner74c80df2009-02-25 06:34:50 +0000112by <a href="http://clang.llvm.org/get_started.html">building from mainline</a>
Mikhail Glushenkovf795ef02009-03-01 18:09:47 +0000113and reporting any issues you hit to the <a
Chris Lattnerf40c40b2009-02-25 05:09:54 +0000114href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-dev">Clang front-end mailing
115list</a>.</p>
116
117<p>In the LLVM 2.5 time-frame, the Clang team has made many improvements:</p>
Bill Wendling741748a2008-10-27 09:27:33 +0000118
Daniel Dunbar13739432008-10-14 23:25:09 +0000119<ul>
Chris Lattnerf40c40b2009-02-25 05:09:54 +0000120<li>Clang now has a new driver, which is focused on providing a GCC-compatible
Mikhail Glushenkovf795ef02009-03-01 18:09:47 +0000121 interface.</li>
122<li>The X86-64 ABI is now supported.</li>
123<li>Precompiled header support is now implemented.</li>
Chris Lattnerf40c40b2009-02-25 05:09:54 +0000124<li>Objective-C support is significantly improved beyond LLVM 2.4, supporting
125 many features, such as Objective-C Garbage Collection.</li>
126<li>Many many bugs are fixed.</li>
Chris Lattnerfb97b2d2008-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
Ted Kremenek8b3894c2009-02-27 07:01:32 +0000136<p>Previously announced in the last LLVM release, the Clang project also
137includes an early stage static source code analysis tool for <a
138href="http://clang.llvm.org/StaticAnalysis.html">automatically finding bugs</a>
139in C and Objective-C programs. The tool performs a growing set of checks to find
140bugs that occur on a specific path within a program.</p>
Chris Lattnercc042612008-10-14 00:52:49 +0000141
Ted Kremenek8b3894c2009-02-27 07:01:32 +0000142<p>In the LLVM 2.5 time-frame there have been many significant improvements to
143the analyzer's core path simulation engine and machinery for generating
144path-based bug reports to end-users. Particularly noteworthy improvements
145include experimental support for full field-sensitivity and reasoning about heap
146objects as well as an improved value-constraints subengine that does a much
147better job of reasoning about inequality relationships (e.g., <tt>x &gt; 2</tt>)
148between variables and constants.
Ted Kremenek3c3ec0c2008-10-14 05:14:21 +0000149
Ted Kremenek8b3894c2009-02-27 07:01:32 +0000150<p>The set of checks performed by the static analyzer continue to expand, and
151future plans for the tool include full source-level inter-procedural analysis
152and deeper checks such as buffer overrun detection. There are many opportunities
153to extend and enhance the static analyzer, and anyone interested in working on
154this project is encouraged to get involved!</p>
Chris Lattner8348b472008-06-08 21:58:17 +0000155
156</div>
157
Chris Lattner96a445e2008-10-13 18:01:01 +0000158<!--=========================================================================-->
159<div class="doc_subsection">
Nicolas Geoffray99a4d302008-10-14 19:23:04 +0000160<a name="vmkit">VMKit: JVM/CLI Virtual Machine Implementation</a>
Chris Lattner96a445e2008-10-13 18:01:01 +0000161</div>
162
163<div class="doc_text">
164<p>
Nicolas Geoffray99a4d302008-10-14 19:23:04 +0000165The <a href="http://vmkit.llvm.org/">VMKit project</a> is an implementation of
Chris Lattner96a445e2008-10-13 18:01:01 +0000166a JVM and a CLI Virtual Machines (Microsoft .NET is an
167implementation of the CLI) using the Just-In-Time compiler of LLVM.</p>
168
Chris Lattner1f859862009-02-25 05:45:05 +0000169<p>Following LLVM 2.5, VMKit has its first release ? that you can find on its
Nicolas Geoffray56d313d2008-10-15 20:25:04 +0000170<a href="http://vmkit.llvm.org/releases/">webpage</a>. The release includes
171bug fixes, cleanup and new features. The major changes are:</p>
Chris Lattner96a445e2008-10-13 18:01:01 +0000172
Nicolas Geoffray99a4d302008-10-14 19:23:04 +0000173<ul>
174
Chris Lattner75e26ca2009-02-26 05:20:36 +0000175<li>Ahead of Time compiler: compiles .class files to llvm .bc. VMKit uses this
176functionality to native compile the standard classes (eg java.lang.String).
177Users can compile AOT .class files into dynamic libraries and run them with the
178help of VMKit.</li>
179
180<li>New exception model: the dwarf exception model is very slow for
181exception-intensive applications, so the JVM has had a new implementation of
182exceptions which check at each function call if an exception happened. There is
183a low performance penalty on applications without exceptions, but it is a big
184gain for exception-intensive applications. For example the jack benchmark in
185Spec JVM98 is 6x faster (performance gain of 83%).</li>
186
187<li>New support for OSX/X64, Linux/X64 (with the Boehm GC), Linux/ppc32.</li>
Nicolas Geoffray99a4d302008-10-14 19:23:04 +0000188
189</ul>
Chris Lattner96a445e2008-10-13 18:01:01 +0000190</div>
191
Chris Lattnerab68e9e2009-02-26 22:33:38 +0000192<!-- *********************************************************************** -->
193<div class="doc_section">
194 <a name="externalproj">External Projects Using LLVM 2.5</a>
195</div>
196<!-- *********************************************************************** -->
197
198<!--=========================================================================-->
199<div class="doc_subsection">
200<a name="pure">Pure</a>
201</div>
202
203<div class="doc_text">
204<p>
205http://pure-lang.googlecode.com/
206</p>
207
208<p>
209Pure is an algebraic/functional programming language based on term rewriting.
210Programs are collections of equations which are used to evaluate expressions in
211a symbolic fashion. Pure offers dynamic typing, eager and lazy evaluation,
Mikhail Glushenkovf795ef02009-03-01 18:09:47 +0000212lexical closures, a hygienic macro system (also based on term rewriting),
Chris Lattnerab68e9e2009-02-26 22:33:38 +0000213built-in list and matrix support (including list and matrix comprehensions) and
214an easy-to-use C interface. The interpreter uses LLVM as a backend to
215 JIT-compile Pure programs to fast native code.</p>
216
217<p>In addition to the usual algebraic data structures, Pure also has
218MATLAB-style matrices in order to support numeric computations and signal
219processing in an efficient way. Pure is mainly aimed at mathematical
220applications right now, but it has been designed as a general purpose language.
221The dynamic interpreter environment and the C interface make it possible to use
222it as a kind of functional scripting language for many application areas.
223</p>
224</div>
225
226
227<!--=========================================================================-->
228<div class="doc_subsection">
229<a name="ldc">LLVM D Compiler</a>
230</div>
231
232<div class="doc_text">
233<p>
234http://www.dsource.org/projects/ldc
235</p>
236
237<p>
238I'd like to inform that the LDC project (LLVM D
239Compiler) is working with release 2.5 of LLVM. In fact we've required
2402.5 in our trunk since the release was branched.
241The improvements in 2.5 have fixed a lot of problems with LDC, more
242specifically the new inline asm constraints, better debug info
243support, general bugfixes :) and better x86-64 support have allowed
244some major improvements in LDC, getting us much closer to being as
245fully featured as the original DMD compiler from DigitalMars.
246</p>
247</div>
248
Chris Lattnerbc31caf2009-02-28 18:58:01 +0000249<!--=========================================================================-->
250<div class="doc_subsection">
251<a name="RoadsendPHP">Roadsend PHP</a>
252</div>
253
254<div class="doc_text">
255<p>http://code.roadsend.com/rphp</p>
256
257<p>Roadsend PHP is using LLVM for code generation. This is an open source
258project.
259</p>
260</div>
Chris Lattnerab68e9e2009-02-26 22:33:38 +0000261
Chris Lattner8348b472008-06-08 21:58:17 +0000262
263<!-- *********************************************************************** -->
264<div class="doc_section">
Chris Lattner96a445e2008-10-13 18:01:01 +0000265 <a name="whatsnew">What's New in LLVM?</a>
Chris Lattner8348b472008-06-08 21:58:17 +0000266</div>
267<!-- *********************************************************************** -->
268
Chris Lattnerf8e0b4e2008-06-08 22:59:35 +0000269<div class="doc_text">
270
Bill Wendling741748a2008-10-27 09:27:33 +0000271<p>This release includes a huge number of bug fixes, performance tweaks, and
Chris Lattnerf6662f92008-10-13 17:57:36 +0000272minor improvements. Some of the major improvements and new features are listed
273in this section.
Chris Lattnerf8e0b4e2008-06-08 22:59:35 +0000274</p>
275</div>
276
Chris Lattner8348b472008-06-08 21:58:17 +0000277<!--=========================================================================-->
Chris Lattnerea34f642008-06-08 21:34:41 +0000278<div class="doc_subsection">
Chris Lattner252b83d2008-02-06 18:00:06 +0000279<a name="majorfeatures">Major New Features</a>
280</div>
281
282<div class="doc_text">
283
Chris Lattner38ab04c2009-02-25 04:41:31 +0000284<p>LLVM 2.5 includes several major new capabilities:</p>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000285
286<ul>
Duncan Sands8524cb92009-02-25 11:37:39 +0000287<li><p>The code generator now supports arbitrary precision integers.
288Types like <tt>i33</tt> have long been valid in the LLVM IR, but previously
289could only be used with the interpreter.
290Now IR using such types can be compiled to native code on all targets.
291All operations are supported if the integer is not bigger than twice the
292target machine word size.
293Simple operations like loads, stores and shifts by a constant amount are
294supported for integers of any size.
295</p></li>
Chris Lattner74c80df2009-02-25 06:34:50 +0000296
297<!--
298Random stuff:
299
Chris Lattnerc1771e32009-02-26 07:29:17 +0000300Pure project: http://code.google.com/p/pure-lang/
301
302
Chris Lattner99f375b2009-02-25 07:32:53 +0000303xcore backend!
304fortran on darwin!
305
Chris Lattnerc1771e32009-02-26 07:29:17 +0000306.ll parser rewrite, caret diags, better errors, less fragile (less likely to
307 crash on strange things). No longer depends on flex/bison.
Chris Lattnerd838fcd2009-02-26 06:47:09 +0000308GCC inliner off, llvm handles always-inline.
Chris Lattner74c80df2009-02-25 06:34:50 +0000309cmake mature?
Chris Lattnerc1771e32009-02-26 07:29:17 +0000310x86 backend GS segment -> addr space 256 (r62980)
Chris Lattner74c80df2009-02-25 06:34:50 +0000311nocapture
Duncan Sandsf910fd32009-03-01 08:26:19 +0000312addreadattrs pass renamed to functionattrs; now calculates nocapture
Chris Lattnerd838fcd2009-02-26 06:47:09 +0000313memdep (used by GVN and memcpyopt) is faster / more aggressive.
Chris Lattner99f375b2009-02-25 07:32:53 +0000314how to write a backend doc docs/WritingAnLLVMBackend.html
Chris Lattner74c80df2009-02-25 06:34:50 +0000315fastisel + exception handling
316vector widening <3 x float> -> <4 x float>
Chris Lattner99f375b2009-02-25 07:32:53 +0000317arm port improvements? arm jit encoding stuff, constant island support?
Chris Lattnerab68e9e2009-02-26 22:33:38 +0000318JIT TLS support on x86-32 but not x86-64.
Chris Lattner99f375b2009-02-25 07:32:53 +0000319mem2reg now faster on code with huge basic blocks
Mikhail Glushenkovf795ef02009-03-01 18:09:47 +0000320stack protectors/stack canaries, -fstack-protector, controllable on a
Chris Lattner99f375b2009-02-25 07:32:53 +0000321 per-function basis with attributes.
322shufflevector is generalized to allow different shuffle mask width than its
323 input vectors.
324loop optimizer improves floating point induction variables
325llvm/Analysis/DebugInfo.h classes, llvm-gcc and clang and codegen use them.
Chris Lattnerc1771e32009-02-26 07:29:17 +0000326 DebugInfoBuilder gone.
Chris Lattner99f375b2009-02-25 07:32:53 +0000327asmprinters seperate from targets for jits
Chris Lattner75e26ca2009-02-26 05:20:36 +0000328PBQP register allocator now supports register coalescing.
Chris Lattnerab68e9e2009-02-26 22:33:38 +0000329JIT supports exceptions on linux/x86-64 and linux/x86-64.
Chris Lattnerd838fcd2009-02-26 06:47:09 +0000330integer overflow intrinsics for [us](add/sub/mul). Supported on all targets,
331 but only generates efficient code on x86.
332X86 backend now supports -disable-mmx.
333noalias attribute on return value indicates that function returns new memory
334 (e.g. malloc).
Chris Lattnerd838fcd2009-02-26 06:47:09 +0000335Jump threading more powerful: it is iterative, handles threading based on values
336 with fully redundant and partially redundant loads.
337LSR improvements?
338ARM debug info support?
339unit test framework based on Google Test.
340
341vector shift support + X86 backend.
Chris Lattnerc1771e32009-02-26 07:29:17 +0000342x86 JIT now detects core i7 and atom, autoconfiguring itself appropriately.
343SROA is more aggressive about promoting unions.
344non-zero __builtin_return_address values on X86.
345x86-64 now uses red zone (unless -mno-red-zone option is specified).
346private linkage.
Chris Lattner75e26ca2009-02-26 05:20:36 +0000347
Chris Lattnerc1771e32009-02-26 07:29:17 +0000348llvm-gcc defaults to -fno-math-errno on all x86 targets.
349
350initial support for debug line numbers when optimization enabled, not useful in
351 2.5 but will be for 2.6.
Chris Lattner74c80df2009-02-25 06:34:50 +0000352-->
Chris Lattnerbc5786b2008-06-05 06:57:39 +0000353
Chris Lattner8170c102008-02-10 08:18:42 +0000354</ul>
355
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000356</div>
357
Chris Lattner791f77b2008-06-05 06:25:56 +0000358
359<!--=========================================================================-->
360<div class="doc_subsection">
Chris Lattnerea34f642008-06-08 21:34:41 +0000361<a name="llvm-gcc">llvm-gcc 4.2 Improvements</a>
Chris Lattner791f77b2008-06-05 06:25:56 +0000362</div>
363
364<div class="doc_text">
365
Chris Lattnerb82eb062008-10-13 20:47:20 +0000366<p>LLVM fully supports the llvm-gcc 4.2 front-end, which marries the GCC
367front-ends and driver with the LLVM optimizer and code generator. It currently
368includes support for the C, C++, Objective-C, Ada, and Fortran front-ends.</p>
Chris Lattner791f77b2008-06-05 06:25:56 +0000369
Chris Lattnerf8e0b4e2008-06-08 22:59:35 +0000370<ul>
Chris Lattner38ab04c2009-02-25 04:41:31 +0000371<li>?</li>
Gabor Greifa3bd11d2008-06-09 06:06:18 +0000372</ul>
Chris Lattner791f77b2008-06-05 06:25:56 +0000373
Chris Lattner791f77b2008-06-05 06:25:56 +0000374</div>
375
376
Chris Lattner84977642007-09-21 03:54:09 +0000377<!--=========================================================================-->
378<div class="doc_subsection">
Chris Lattnerf304ffc2008-02-10 08:17:19 +0000379<a name="coreimprovements">LLVM Core Improvements</a>
380</div>
381
382<div class="doc_text">
Bill Wendling741748a2008-10-27 09:27:33 +0000383<p>New features include:</p>
Chris Lattnerf304ffc2008-02-10 08:17:19 +0000384
Chris Lattner791f77b2008-06-05 06:25:56 +0000385<ul>
Chris Lattner38ab04c2009-02-25 04:41:31 +0000386<li>?</li>
Mikhail Glushenkovf795ef02009-03-01 18:09:47 +0000387
Chris Lattnerf304ffc2008-02-10 08:17:19 +0000388</ul>
Mikhail Glushenkovea65d7d2008-10-13 02:08:34 +0000389
Chris Lattnerf304ffc2008-02-10 08:17:19 +0000390</div>
391
392<!--=========================================================================-->
393<div class="doc_subsection">
Chris Lattneracce85d2008-02-10 07:46:44 +0000394<a name="optimizer">Optimizer Improvements</a>
395</div>
396
397<div class="doc_text">
398
Chris Lattnerf3013872008-10-13 21:50:36 +0000399<p>In addition to a huge array of bug fixes and minor performance tweaks, this
400release includes a few major enhancements and additions to the optimizers:</p>
Chris Lattneracce85d2008-02-10 07:46:44 +0000401
402<ul>
403
Chris Lattner38ab04c2009-02-25 04:41:31 +0000404<li>?</li>
Chris Lattnerf3013872008-10-13 21:50:36 +0000405
Chris Lattner0b832202008-06-08 02:45:07 +0000406</ul>
407
408</div>
409
410<!--=========================================================================-->
411<div class="doc_subsection">
412<a name="codegen">Code Generator Improvements</a>
413</div>
414
415<div class="doc_text">
416
Mikhail Glushenkovf795ef02009-03-01 18:09:47 +0000417<p>We have put a significant amount of work into the code generator
418infrastructure, which allows us to implement more aggressive algorithms and make
419it run faster:</p>
Chris Lattner0b832202008-06-08 02:45:07 +0000420
421<ul>
Duncan Sands07636ea2009-02-25 11:50:08 +0000422<li>The type legalization logic has been completely rewritten, and is now
423more powerful (it supports arbitrary precision integer types for example)
424and hopefully more correct.
425The type legalizer converts operations on types that are not natively
426supported by the target machine into equivalent code sequences that only use
427natively supported types.
428The old type legalizer is still available and will be used if
429<tt>-disable-legalize-types</tt> is passed to <tt>llc</tt>.
430</li>
Chris Lattner38ab04c2009-02-25 04:41:31 +0000431<li>?</li>
Chris Lattner0b832202008-06-08 02:45:07 +0000432
Chris Lattner84977642007-09-21 03:54:09 +0000433</ul>
434
435</div>
436
437
438<!--=========================================================================-->
439<div class="doc_subsection">
Chris Lattner11398992009-02-26 07:32:11 +0000440<a name="pic16">PIC16 Target Improvements</a>
441</div>
442
443<div class="doc_text">
444<p>New features of the PIC16 target include:
445</p>
446
447<ul>
448<li>Both direct and indirect load/stores work now.</li>
449<li>Logical, bitwise and conditional operations now work for integer data
450types.</li>
451<li>Function calls involving basic types work now.</li>
452<li>Support for integer arrays.</li>
453<li>Compiler can now emit libcalls for operations not support by m/c insns.</li>
454<li>Support for both data and rom address spaces.</li>
455</li>
456</ul>
457
458<p>Things not yet supported:</p>
459
460<ul>
461<li>Floating point.</li>
462<li>Passing/returning aggregate types to/from functions.</li>
463<li>Variable arguments.</li>
464<li>Indirect function calls.</li>
465<li>Interrupts/prgrams.</li>
466<li>Debug info.</li>
467</li>
468</ul>
469
470</div>
471
472
473<!--=========================================================================-->
474<div class="doc_subsection">
475<a name="othertargetspecific">Other Target Specific Improvements</a>
Chris Lattner84977642007-09-21 03:54:09 +0000476</div>
Chris Lattner60893e52007-05-18 06:33:02 +0000477
Chris Lattner738bd302006-04-18 06:32:08 +0000478<div class="doc_text">
Chris Lattnerf304ffc2008-02-10 08:17:19 +0000479<p>New target-specific features include:
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000480</p>
Chris Lattner26299222006-11-18 07:51:14 +0000481
482<ul>
Chris Lattner38ab04c2009-02-25 04:41:31 +0000483<li>?</li>
Chris Lattner77d29b12008-06-05 08:02:49 +0000484</ul>
Chris Lattner77d29b12008-06-05 08:02:49 +0000485
Mikhail Glushenkovea65d7d2008-10-13 02:08:34 +0000486</div>
Chris Lattner77d29b12008-06-05 08:02:49 +0000487
Chris Lattnerc441fb82009-03-01 02:30:21 +0000488<!--=========================================================================-->
489<div class="doc_subsection">
490<a name="llvmc">Improvements in LLVMC</a>
491</div>
492
493<div class="doc_text">
494<p>New features include:</p>
495
496<ul>
Mikhail Glushenkovf795ef02009-03-01 18:09:47 +0000497<li>Beginning with LLVM 2.5, <tt>llvmc2</tt> is known as
498 just <tt>llvmc</tt>. The old <tt>llvmc</tt> driver was removed.</li>
Chris Lattnerc441fb82009-03-01 02:30:21 +0000499
500<li>The Clang plugin was substantially improved and is now enabled
Mikhail Glushenkovf795ef02009-03-01 18:09:47 +0000501 by default. The command <tt>llvmc --clang</tt> can be now used as a
502 synonym to <tt>ccc</tt>.</li>
Chris Lattnerc441fb82009-03-01 02:30:21 +0000503
Mikhail Glushenkovf795ef02009-03-01 18:09:47 +0000504<li>There is now a <tt>--check-graph</tt> option which is supposed to catch
505 common errors like multiple default edges, mismatched output/input language
506 names and cycles. In general, these checks can't be done at compile-time
507 because of the need to support plugins.</li>
Chris Lattnerc441fb82009-03-01 02:30:21 +0000508
Mikhail Glushenkovf795ef02009-03-01 18:09:47 +0000509<li>Plugins are now more flexible and can refer to compilation graph nodes and
510 options defined in other plugins. To manage dependencies, a priority-sorting
511 mechanism was introduced. This change affects the TableGen file syntax; see the
512 documentation for details.</li>
Chris Lattnerc441fb82009-03-01 02:30:21 +0000513
Mikhail Glushenkovf795ef02009-03-01 18:09:47 +0000514<li>Hooks can now be provided with arguments. The syntax is "<tt>$CALL(MyHook,
515 'Arg1', 'Arg2', 'Arg #3')</tt>".</li>
Chris Lattnerc441fb82009-03-01 02:30:21 +0000516
Mikhail Glushenkovf795ef02009-03-01 18:09:47 +0000517<li>A new option type: multi-valued option, for options that take more than one
518 argument (for example, "<tt>-foo a b c</tt>").</li>
Chris Lattnerc441fb82009-03-01 02:30:21 +0000519
Mikhail Glushenkovf795ef02009-03-01 18:09:47 +0000520<li>New option properties: '<tt>one_or_more</tt>', '<tt>zero_or_more</tt>',
521'<tt>hidden</tt>' and '<tt>really_hidden</tt>'.</li>
Chris Lattnerc441fb82009-03-01 02:30:21 +0000522
Mikhail Glushenkovf795ef02009-03-01 18:09:47 +0000523<li>The '<tt>case</tt>' expression gained an '<tt>error</tt>' action and
524 an '<tt>empty</tt>' test (equivalent to "<tt>(not (not_empty ...))</tt>").</li>
Chris Lattnerc441fb82009-03-01 02:30:21 +0000525
526<li>Documentation now looks more consistent to the rest of the LLVM
527 docs. There is also a man page now.</li>
Mikhail Glushenkovf795ef02009-03-01 18:09:47 +0000528
Chris Lattnerc441fb82009-03-01 02:30:21 +0000529</ul>
530
531</div>
532
Chris Lattner77d29b12008-06-05 08:02:49 +0000533
534<!--=========================================================================-->
535<div class="doc_subsection">
Chris Lattner84977642007-09-21 03:54:09 +0000536<a name="otherimprovements">Other Improvements</a>
537</div>
538
539<div class="doc_text">
540<p>New features include:
541</p>
542
543<ul>
Chris Lattner38ab04c2009-02-25 04:41:31 +0000544<li>?</li>
Tanya Lattnera7ec7062008-11-04 18:40:27 +0000545
Chris Lattner84977642007-09-21 03:54:09 +0000546</ul>
Mikhail Glushenkovea65d7d2008-10-13 02:08:34 +0000547
Chris Lattner84977642007-09-21 03:54:09 +0000548</div>
Chris Lattnerc5d658a2006-03-03 00:34:26 +0000549
Chris Lattnerf6662f92008-10-13 17:57:36 +0000550<!--=========================================================================-->
551<div class="doc_subsection">
552<a name="changes">Major Changes and Removed Features</a>
553</div>
554
555<div class="doc_text">
556
Chris Lattnereeb4da02008-10-13 22:06:31 +0000557<p>If you're already an LLVM user or developer with out-of-tree changes based
Chris Lattner38ab04c2009-02-25 04:41:31 +0000558on LLVM 2.4, this section lists some "gotchas" that you may run into upgrading
Chris Lattnereeb4da02008-10-13 22:06:31 +0000559from the previous release.</p>
Chris Lattnerf6662f92008-10-13 17:57:36 +0000560
561<ul>
562
Chris Lattner38ab04c2009-02-25 04:41:31 +0000563<li>?</li>
Chris Lattnereeb4da02008-10-13 22:06:31 +0000564</ul>
565
566
567<p>In addition, many APIs have changed in this release. Some of the major LLVM
568API changes are:</p>
569
570<ul>
Chris Lattner38ab04c2009-02-25 04:41:31 +0000571<li>?</li>
Devang Patelb34dd132008-10-14 20:03:43 +0000572</ul>
Chris Lattnerf6662f92008-10-13 17:57:36 +0000573
Chris Lattner38ab04c2009-02-25 04:41:31 +0000574<li>?</li>
Chris Lattnerf6662f92008-10-13 17:57:36 +0000575</ul>
576
577</div>
578
579
580
Chris Lattner19092612003-10-02 16:38:05 +0000581<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000582<div class="doc_section">
583 <a name="portability">Portability and Supported Platforms</a>
584</div>
Chris Lattner19092612003-10-02 16:38:05 +0000585<!-- *********************************************************************** -->
586
Misha Brukman500bc302003-11-22 00:38:41 +0000587<div class="doc_text">
588
John Criswell0b5b5e92004-12-08 20:35:47 +0000589<p>LLVM is known to work on the following platforms:</p>
Chris Lattner4654bdb2004-06-01 18:22:41 +0000590
591<ul>
Mikhail Glushenkovf795ef02009-03-01 18:09:47 +0000592<li>Intel and AMD machines (IA32, X86-64, AMD64, EMT-64) running Red Hat
Chris Lattnere18b32e2008-11-10 05:40:34 +0000593Linux, Fedora Core and FreeBSD (and probably other unix-like systems).</li>
Mikhail Glushenkovf795ef02009-03-01 18:09:47 +0000594<li>PowerPC and X86-based Mac OS X systems, running 10.3 and above in 32-bit
Chris Lattnere18b32e2008-11-10 05:40:34 +0000595and 64-bit modes.</li>
Chris Lattner252b83d2008-02-06 18:00:06 +0000596<li>Intel and AMD machines running on Win32 using MinGW libraries (native).</li>
Chris Lattner57a460e2007-05-23 04:39:32 +0000597<li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
598 support is available for native builds with Visual C++).</li>
Gabor Greif96a89c72008-06-05 18:39:01 +0000599<li>Sun UltraSPARC workstations running Solaris 10.</li>
John Criswell9321fa82005-05-13 20:28:15 +0000600<li>Alpha-based machines running Debian GNU/Linux.</li>
Gabor Greif96a89c72008-06-05 18:39:01 +0000601<li>Itanium-based (IA64) machines running Linux and HP-UX.</li>
Chris Lattner4654bdb2004-06-01 18:22:41 +0000602</ul>
603
Chris Lattnerbc5786b2008-06-05 06:57:39 +0000604<p>The core LLVM infrastructure uses GNU autoconf to adapt itself
Brian Gaekeb0fd7612004-05-09 05:28:35 +0000605to the machine and operating system on which it is built. However, minor
606porting may be required to get LLVM to work on new platforms. We welcome your
607portability patches and reports of successful builds or error messages.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000608
Misha Brukman500bc302003-11-22 00:38:41 +0000609</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000610
611<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000612<div class="doc_section">
613 <a name="knownproblems">Known Problems</a>
614</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000615<!-- *********************************************************************** -->
616
Misha Brukman500bc302003-11-22 00:38:41 +0000617<div class="doc_text">
618
Mikhail Glushenkovf795ef02009-03-01 18:09:47 +0000619<p>This section contains significant known problems with the LLVM system,
Chris Lattnere18b32e2008-11-10 05:40:34 +0000620listed by component. If you run into a problem, please check the <a
Chris Lattnerc463b272005-10-29 07:07:09 +0000621href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
Chris Lattner5eccca42003-12-12 21:22:16 +0000622there isn't already one.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000623
Misha Brukman500bc302003-11-22 00:38:41 +0000624</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000625
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000626<!-- ======================================================================= -->
627<div class="doc_subsection">
628 <a name="experimental">Experimental features included with this release</a>
629</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000630
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000631<div class="doc_text">
632
Misha Brukman6df9e2c2004-05-12 21:46:05 +0000633<p>The following components of this LLVM release are either untested, known to
634be broken or unreliable, or are in early development. These components should
635not be relied on, and bugs should not be filed against them, but they may be
636useful to some people. In particular, if you would like to work on one of these
Chris Lattner2b659ef2008-02-12 06:29:45 +0000637components, please contact us on the <a
638href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p>
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000639
640<ul>
Gabor Greifa8b84902008-10-14 11:31:14 +0000641<li>The MSIL, IA64, Alpha, SPU, MIPS, and PIC16 backends are experimental.</li>
Duncan Sands27aff872008-06-08 20:18:35 +0000642<li>The llc "<tt>-filetype=asm</tt>" (the default) is the only supported
Chris Lattner000c73b2008-02-06 06:30:34 +0000643 value for this option.</li>
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000644</ul>
645
646</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000647
Misha Brukman500bc302003-11-22 00:38:41 +0000648<!-- ======================================================================= -->
649<div class="doc_subsection">
Chris Lattner26299222006-11-18 07:51:14 +0000650 <a name="x86-be">Known problems with the X86 back-end</a>
John Criswellc0c186d2005-11-08 21:11:33 +0000651</div>
652
653<div class="doc_text">
654
655<ul>
Anton Korobeynikova6094be2008-06-08 10:24:13 +0000656 <li>The X86 backend does not yet support
657 all <a href="http://llvm.org/PR879">inline assembly that uses the X86
658 floating point stack</a>. It supports the 'f' and 't' constraints, but not
659 'u'.</li>
Chris Lattnere6e1b352008-06-08 21:19:07 +0000660 <li>The X86 backend generates inefficient floating point code when configured
661 to generate code for systems that don't have SSE2.</li>
Duncan Sands47eff2b2008-06-08 19:38:43 +0000662 <li>Win64 code generation wasn't widely tested. Everything should work, but we
Anton Korobeynikova6094be2008-06-08 10:24:13 +0000663 expect small issues to happen. Also, llvm-gcc cannot build mingw64 runtime
664 currently due
665 to <a href="http://llvm.org/PR2255">several</a>
Chris Lattner04af7cb2008-06-08 23:12:47 +0000666 <a href="http://llvm.org/PR2257">bugs</a> due to lack of support for the
667 'u' inline assembly constraint and X87 floating point inline assembly.</li>
Dan Gohman8207ba92008-06-08 23:05:11 +0000668 <li>The X86-64 backend does not yet support the LLVM IR instruction
669 <tt>va_arg</tt>. Currently, the llvm-gcc front-end supports variadic
670 argument constructs on X86-64 by lowering them manually.</li>
Chris Lattner26299222006-11-18 07:51:14 +0000671</ul>
672
673</div>
674
675<!-- ======================================================================= -->
676<div class="doc_subsection">
677 <a name="ppc-be">Known problems with the PowerPC back-end</a>
678</div>
679
680<div class="doc_text">
681
682<ul>
Nicolas Geoffraye4285dc2007-05-15 09:21:28 +0000683<li>The Linux PPC32/ABI support needs testing for the interpreter and static
Chris Lattner57a460e2007-05-23 04:39:32 +0000684compilation, and lacks support for debug information.</li>
Chris Lattner26299222006-11-18 07:51:14 +0000685</ul>
686
687</div>
688
689<!-- ======================================================================= -->
690<div class="doc_subsection">
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000691 <a name="arm-be">Known problems with the ARM back-end</a>
692</div>
693
694<div class="doc_text">
695
696<ul>
Chris Lattner57a460e2007-05-23 04:39:32 +0000697<li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
Duncan Sandsc90d68b2007-09-26 15:59:54 +0000698processors, thumb programs can crash or produce wrong
Chris Lattner57a460e2007-05-23 04:39:32 +0000699results (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000700<li>Compilation for ARM Linux OABI (old ABI) is supported, but not fully tested.
701</li>
Chris Lattnere6e1b352008-06-08 21:19:07 +0000702<li>There is a bug in QEMU-ARM (&lt;= 0.9.0) which causes it to incorrectly
703 execute
Chris Lattner57a460e2007-05-23 04:39:32 +0000704programs compiled with LLVM. Please use more recent versions of QEMU.</li>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000705</ul>
706
707</div>
708
709<!-- ======================================================================= -->
710<div class="doc_subsection">
Chris Lattner26299222006-11-18 07:51:14 +0000711 <a name="sparc-be">Known problems with the SPARC back-end</a>
712</div>
713
714<div class="doc_text">
715
716<ul>
717<li>The SPARC backend only supports the 32-bit SPARC ABI (-m32), it does not
718 support the 64-bit SPARC ABI (-m64).</li>
719</ul>
720
721</div>
722
723<!-- ======================================================================= -->
724<div class="doc_subsection">
Bruno Cardoso Lopesb7e1a4f2008-10-25 14:56:26 +0000725 <a name="mips-be">Known problems with the MIPS back-end</a>
726</div>
727
728<div class="doc_text">
729
730<ul>
731<li>The O32 ABI is not fully supported.</li>
732<li>64-bit MIPS targets are not supported yet.</li>
733</ul>
734
735</div>
736
737<!-- ======================================================================= -->
738<div class="doc_subsection">
Chris Lattner26299222006-11-18 07:51:14 +0000739 <a name="alpha-be">Known problems with the Alpha back-end</a>
740</div>
741
742<div class="doc_text">
743
744<ul>
745
746<li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
747appropriate nops inserted to ensure restartability.</li>
748
John Criswellc0c186d2005-11-08 21:11:33 +0000749</ul>
750</div>
751
Chris Lattner26299222006-11-18 07:51:14 +0000752<!-- ======================================================================= -->
753<div class="doc_subsection">
754 <a name="ia64-be">Known problems with the IA64 back-end</a>
755</div>
756
757<div class="doc_text">
758
759<ul>
Chris Lattner04af7cb2008-06-08 23:12:47 +0000760<li>The Itanium backend is highly experimental, and has a number of known
761 issues. We are looking for a maintainer for the Itanium backend. If you
Gabor Greif3bd3a262008-10-15 10:47:24 +0000762 are interested, please contact the LLVMdev mailing list.</li>
Chris Lattner26299222006-11-18 07:51:14 +0000763</ul>
764
765</div>
766
767<!-- ======================================================================= -->
768<div class="doc_subsection">
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000769 <a name="c-be">Known problems with the C back-end</a>
Chris Lattner26299222006-11-18 07:51:14 +0000770</div>
771
772<div class="doc_text">
773
774<ul>
Chris Lattner5733b272008-06-05 06:35:40 +0000775<li><a href="http://llvm.org/PR802">The C backend has only basic support for
776 inline assembly code</a>.</li>
Chris Lattner725a0d82007-09-26 06:01:35 +0000777<li><a href="http://llvm.org/PR1658">The C backend violates the ABI of common
778 C++ programs</a>, preventing intermixing between C++ compiled by the CBE and
Duncan Sands27aff872008-06-08 20:18:35 +0000779 C++ code compiled with llc or native compilers.</li>
Duncan Sandsf74c0cc2008-02-10 13:40:55 +0000780<li>The C backend does not support all exception handling constructs.</li>
Duncan Sands50723a92009-02-25 11:51:54 +0000781<li>The C backend does not support arbitrary precision integers.</li>
Chris Lattner26299222006-11-18 07:51:14 +0000782</ul>
783
784</div>
John Criswellc0c186d2005-11-08 21:11:33 +0000785
Misha Brukman500bc302003-11-22 00:38:41 +0000786
787<!-- ======================================================================= -->
788<div class="doc_subsection">
Chris Lattner5733b272008-06-05 06:35:40 +0000789 <a name="c-fe">Known problems with the llvm-gcc C front-end</a>
Misha Brukman500bc302003-11-22 00:38:41 +0000790</div>
Chris Lattner47588f92003-10-02 05:07:23 +0000791
Misha Brukman500bc302003-11-22 00:38:41 +0000792<div class="doc_text">
Chris Lattnerc5d658a2006-03-03 00:34:26 +0000793
Chris Lattner252b83d2008-02-06 18:00:06 +0000794<p>llvm-gcc does not currently support <a href="http://llvm.org/PR869">Link-Time
795Optimization</a> on most platforms "out-of-the-box". Please inquire on the
Gabor Greif3bd3a262008-10-15 10:47:24 +0000796LLVMdev mailing list if you are interested.</p>
Chris Lattnerd9ea0172006-08-08 17:27:28 +0000797
Chris Lattner5733b272008-06-05 06:35:40 +0000798<p>The only major language feature of GCC not supported by llvm-gcc is
799 the <tt>__builtin_apply</tt> family of builtins. However, some extensions
800 are only supported on some targets. For example, trampolines are only
Duncan Sands27aff872008-06-08 20:18:35 +0000801 supported on some targets (these are used when you take the address of a
802 nested function).</p>
Misha Brukman500bc302003-11-22 00:38:41 +0000803
Chris Lattner5733b272008-06-05 06:35:40 +0000804<p>If you run into GCC extensions which are not supported, please let us know.
805</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000806
Misha Brukman500bc302003-11-22 00:38:41 +0000807</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000808
Misha Brukman500bc302003-11-22 00:38:41 +0000809<!-- ======================================================================= -->
810<div class="doc_subsection">
Chris Lattner5733b272008-06-05 06:35:40 +0000811 <a name="c++-fe">Known problems with the llvm-gcc C++ front-end</a>
Misha Brukman500bc302003-11-22 00:38:41 +0000812</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000813
Misha Brukman500bc302003-11-22 00:38:41 +0000814<div class="doc_text">
815
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000816<p>The C++ front-end is considered to be fully
Chris Lattner7506b1d2004-12-07 08:04:13 +0000817tested and works for a number of non-trivial programs, including LLVM
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000818itself, Qt, Mozilla, etc.</p>
Misha Brukman500bc302003-11-22 00:38:41 +0000819
Misha Brukman500bc302003-11-22 00:38:41 +0000820<ul>
Anton Korobeynikov0021fc12008-10-11 18:27:16 +0000821<li>Exception handling works well on the X86 and PowerPC targets. Currently
Chris Lattnere18b32e2008-11-10 05:40:34 +0000822 only Linux and Darwin targets are supported (both 32 and 64 bit).</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000823</ul>
Chris Lattnerfcc54b32003-10-07 22:14:37 +0000824
Misha Brukman500bc302003-11-22 00:38:41 +0000825</div>
826
Chris Lattner1eb4df62008-10-30 03:58:13 +0000827<!-- ======================================================================= -->
828<div class="doc_subsection">
829 <a name="fortran-fe">Known problems with the llvm-gcc Fortran front-end</a>
830</div>
831
832<div class="doc_text">
Gabor Greifba10fe02008-11-04 21:50:59 +0000833<ul>
Chris Lattner1eb4df62008-10-30 03:58:13 +0000834<li>Fortran support generally works, but there are still several unresolved bugs
835 in Bugzilla. Please see the tools/gfortran component for details.</li>
Mikhail Glushenkovf795ef02009-03-01 18:09:47 +0000836
Chris Lattner1eb4df62008-10-30 03:58:13 +0000837<li>The Fortran front-end currently does not build on Darwin (without tweaks)
838 due to unresolved dependencies on the C front-end.</li>
Gabor Greifba10fe02008-11-04 21:50:59 +0000839</ul>
Chris Lattner1eb4df62008-10-30 03:58:13 +0000840</div>
Misha Brukman500bc302003-11-22 00:38:41 +0000841
Chris Lattner2b659ef2008-02-12 06:29:45 +0000842<!-- ======================================================================= -->
843<div class="doc_subsection">
Chris Lattner5733b272008-06-05 06:35:40 +0000844 <a name="ada-fe">Known problems with the llvm-gcc Ada front-end</a>
Chris Lattner2b659ef2008-02-12 06:29:45 +0000845</div>
846
847<div class="doc_text">
848The llvm-gcc 4.2 Ada compiler works fairly well, however this is not a mature
849technology and problems should be expected.
850<ul>
Duncan Sands27aff872008-06-08 20:18:35 +0000851<li>The Ada front-end currently only builds on X86-32. This is mainly due
Chris Lattner2b659ef2008-02-12 06:29:45 +0000852to lack of trampoline support (pointers to nested functions) on other platforms,
Duncan Sands27aff872008-06-08 20:18:35 +0000853however it <a href="http://llvm.org/PR2006">also fails to build on X86-64</a>
Chris Lattner2b659ef2008-02-12 06:29:45 +0000854which does support trampolines.</li>
855<li>The Ada front-end <a href="http://llvm.org/PR2007">fails to bootstrap</a>.
Duncan Sands326a4982009-02-25 11:59:06 +0000856This is due to lack of LLVM support for <tt>setjmp</tt>/<tt>longjmp</tt> style
857exception handling, which is used internally by the compiler.
Chris Lattner2b659ef2008-02-12 06:29:45 +0000858Workaround: configure with --disable-bootstrap.</li>
Duncan Sands978bcee2008-10-13 17:27:23 +0000859<li>The c380004, <a href="http://llvm.org/PR2010">c393010</a>
860and <a href="http://llvm.org/PR2421">cxg2021</a> ACATS tests fail
Duncan Sands326a4982009-02-25 11:59:06 +0000861(c380004 also fails with gcc-4.2 mainline).
862If the compiler is built with checks disabled then <a href="http://llvm.org/PR2010">c393010</a>
863causes the compiler to go into an infinite loop, using up all system memory.</li>
Duncan Sands978bcee2008-10-13 17:27:23 +0000864<li>Some gcc specific Ada tests continue to crash the compiler.</li>
Chris Lattner2b659ef2008-02-12 06:29:45 +0000865<li>The -E binder option (exception backtraces)
866<a href="http://llvm.org/PR1982">does not work</a> and will result in programs
867crashing if an exception is raised. Workaround: do not use -E.</li>
868<li>Only discrete types <a href="http://llvm.org/PR1981">are allowed to start
869or finish at a non-byte offset</a> in a record. Workaround: do not pack records
870or use representation clauses that result in a field of a non-discrete type
871starting or finishing in the middle of a byte.</li>
Chris Lattnere6e1b352008-06-08 21:19:07 +0000872<li>The <tt>lli</tt> interpreter <a href="http://llvm.org/PR2009">considers
873'main' as generated by the Ada binder to be invalid</a>.
874Workaround: hand edit the file to use pointers for <tt>argv</tt> and
875<tt>envp</tt> rather than integers.</li>
876<li>The <tt>-fstack-check</tt> option <a href="http://llvm.org/PR2008">is
877ignored</a>.</li>
Chris Lattner2b659ef2008-02-12 06:29:45 +0000878</ul>
879</div>
880
Chris Lattner79c3fe12003-10-02 04:57:28 +0000881<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000882<div class="doc_section">
883 <a name="additionalinfo">Additional Information</a>
884</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000885<!-- *********************************************************************** -->
886
Misha Brukman500bc302003-11-22 00:38:41 +0000887<div class="doc_text">
888
Chris Lattner416db102005-05-16 17:13:10 +0000889<p>A wide variety of additional information is available on the <a
Chris Lattnerb4b0ce72007-05-18 00:44:29 +0000890href="http://llvm.org">LLVM web page</a>, in particular in the <a
891href="http://llvm.org/docs/">documentation</a> section. The web page also
Reid Spencer669ed452007-07-09 08:04:31 +0000892contains versions of the API documentation which is up-to-date with the
893Subversion version of the source code.
Misha Brukman109d9e82005-03-30 19:14:24 +0000894You can access versions of these documents specific to this release by going
895into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000896
Misha Brukman500bc302003-11-22 00:38:41 +0000897<p>If you have any questions or comments about LLVM, please feel free to contact
Chris Lattnerc463b272005-10-29 07:07:09 +0000898us via the <a href="http://llvm.org/docs/#maillist"> mailing
Chris Lattner5eccca42003-12-12 21:22:16 +0000899lists</a>.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000900
Misha Brukman500bc302003-11-22 00:38:41 +0000901</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000902
903<!-- *********************************************************************** -->
Chris Lattner79c3fe12003-10-02 04:57:28 +0000904
Misha Brukman500bc302003-11-22 00:38:41 +0000905<hr>
Misha Brukman2061e892003-11-22 01:23:39 +0000906<address>
Misha Brukman38847d52003-12-21 22:53:21 +0000907 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman44408702008-12-11 17:34:48 +0000908 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
Misha Brukman2061e892003-11-22 01:23:39 +0000909 <a href="http://validator.w3.org/check/referer"><img
Misha Brukman44408702008-12-11 17:34:48 +0000910 src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
Misha Brukman2061e892003-11-22 01:23:39 +0000911
Chris Lattnerb4b0ce72007-05-18 00:44:29 +0000912 <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
Misha Brukman500bc302003-11-22 00:38:41 +0000913 Last modified: $Date$
Misha Brukman2061e892003-11-22 01:23:39 +0000914</address>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000915
Misha Brukman500bc302003-11-22 00:38:41 +0000916</body>
917</html>