Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / llvm / 3e2889135e4b11ec59744f6aae9d8f4ed64a28bb / . / docs / ReleaseNotes.html
blob: e26c92079f94fd3e2a954c9a7781287ae4382cc4 [file] [log] [blame]
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
3<html>
4<head>
5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
6 <link rel="stylesheet" href="llvm.css" type="text/css">
Chris Lattner95d25072009-02-25 04:41:31 +0000[diff] [blame]7 <title>LLVM 2.5 Release Notes</title>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]8</head>
9<body>
10
Chris Lattner95d25072009-02-25 04:41:31 +0000[diff] [blame]11<div class="doc_title">LLVM 2.5 Release Notes</div>
Mikhail Glushenkov808cd3e2008-10-13 02:08:34 +0000[diff] [blame]12
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]13<ol>
14 <li><a href="#intro">Introduction</a></li>
Chris Lattner78a130b2008-10-13 18:01:01 +0000[diff] [blame]15 <li><a href="#subproj">Sub-project Status Update</a></li>
16 <li><a href="#whatsnew">What's New in LLVM?</a></li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]17 <li><a href="GettingStarted.html">Installation Instructions</a></li>
18 <li><a href="#portability">Portability and Supported Platforms</a></li>
Dan Gohman0de549c2008-10-14 16:23:02 +0000[diff] [blame]19 <li><a href="#knownproblems">Known Problems</a></li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]20 <li><a href="#additionalinfo">Additional Information</a></li>
21</ol>
22
23<div class="doc_author">
Dan Gohman0de549c2008-10-14 16:23:02 +0000[diff] [blame]24 <p>Written by the <a href="http://llvm.org">LLVM Team</a></p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]25</div>
26
27<!-- *********************************************************************** -->
28<div class="doc_section">
29 <a name="intro">Introduction</a>
30</div>
31<!-- *********************************************************************** -->
32
33<div class="doc_text">
34
Chris Lattner92eacf82008-10-13 17:57:36 +0000[diff] [blame]35<p>This document contains the release notes for the LLVM Compiler
Chris Lattner95d25072009-02-25 04:41:31 +0000[diff] [blame]36Infrastructure, release 2.5. Here we describe the status of LLVM, including
Chris Lattner92eacf82008-10-13 17:57:36 +0000[diff] [blame]37major improvements from the previous release and significant known problems.
38All LLVM releases may be downloaded from the <a
39href="http://llvm.org/releases/">LLVM releases web site</a>.</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]40
41<p>For more information about LLVM, including information about the latest
42release, please check out the <a href="http://llvm.org/">main LLVM
43web site</a>. If you have questions or comments, the <a
Chris Lattner92eacf82008-10-13 17:57:36 +0000[diff] [blame]44href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM Developer's Mailing
45List</a> is a good place to send them.</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]46
Mikhail Glushenkov808cd3e2008-10-13 02:08:34 +0000[diff] [blame]47<p>Note that if you are reading this file from a Subversion checkout or the
Chris Lattnerb0d6c502007-09-21 03:54:09 +0000[diff] [blame]48main LLVM web page, this document applies to the <i>next</i> release, not the
Gabor Greif7c65c4f2008-10-14 11:00:32 +0000[diff] [blame]49current one. To see the release notes for a specific release, please see the
Chris Lattnerb0d6c502007-09-21 03:54:09 +0000[diff] [blame]50<a href="http://llvm.org/releases/">releases page</a>.</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]51
52</div>
53
Chris Lattner95d25072009-02-25 04:41:31 +0000[diff] [blame]54<!-- Unfinished features in 2.5:
Chris Lattner8fda4952008-02-10 07:46:44 +0000[diff] [blame]55 Machine LICM
56 Machine Sinking
Chris Lattnera53f4972009-02-25 06:34:50 +0000[diff] [blame]57 target-specific intrinsics
58 gold lto plugin
59 pre-alloc splitter
Chris Lattner4f076402008-10-12 19:47:48 +0000[diff] [blame]60 llc -enable-value-prop, propagation of value info (sign/zero ext info) from
61 one MBB to another
Chris Lattnera53f4972009-02-25 06:34:50 +0000[diff] [blame]62 debug info for optimized code
Chris Lattner8fda4952008-02-10 07:46:44 +0000[diff] [blame]63 -->
Mikhail Glushenkov808cd3e2008-10-13 02:08:34 +0000[diff] [blame]64
Chris Lattner4f076402008-10-12 19:47:48 +0000[diff] [blame]65 <!-- for announcement email:
Chris Lattnera53f4972009-02-25 06:34:50 +0000[diff] [blame]66 -->
Chris Lattner8fda4952008-02-10 07:46:44 +0000[diff] [blame]67
Chris Lattner78a130b2008-10-13 18:01:01 +0000[diff] [blame]68<!-- *********************************************************************** -->
69<div class="doc_section">
70 <a name="subproj">Sub-project Status Update</a>
Chris Lattnerf65224f2008-06-08 21:34:41 +0000[diff] [blame]71</div>
Chris Lattner78a130b2008-10-13 18:01:01 +0000[diff] [blame]72<!-- *********************************************************************** -->
Chris Lattnerf65224f2008-06-08 21:34:41 +0000[diff] [blame]73
74<div class="doc_text">
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000[diff] [blame]75<p>
Chris Lattner95d25072009-02-25 04:41:31 +0000[diff] [blame]76The LLVM 2.5 distribution currently consists of code from the core LLVM
Chris Lattnera3c683b2008-10-13 18:11:54 +0000[diff] [blame]77repository (which roughly includes the LLVM optimizers, code generators and
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000[diff] [blame]78supporting tools) and the llvm-gcc repository. In addition to this code, the
79LLVM Project includes other sub-projects that are in development. The two which
Chris Lattner2c3ef982008-10-11 18:18:28 +0000[diff] [blame]80are the most actively developed are the <a href="#clang">Clang Project</a> and
Nicolas Geoffray2b139382008-10-14 19:23:04 +0000[diff] [blame]81the <a href="#vmkit">VMKit Project</a>.
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000[diff] [blame]82</p>
Chris Lattner78a130b2008-10-13 18:01:01 +0000[diff] [blame]83
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000[diff] [blame]84</div>
85
Chris Lattner78a130b2008-10-13 18:01:01 +0000[diff] [blame]86
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000[diff] [blame]87<!--=========================================================================-->
Chris Lattner78a130b2008-10-13 18:01:01 +0000[diff] [blame]88<div class="doc_subsection">
Chris Lattnera3c683b2008-10-13 18:11:54 +0000[diff] [blame]89<a name="clang">Clang: C/C++/Objective-C Frontend Toolkit</a>
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000[diff] [blame]90</div>
91
92<div class="doc_text">
93
94<p>The <a href="http://clang.llvm.org/">Clang project</a> is an effort to build
95a set of new 'LLVM native' front-end technologies for the LLVM optimizer
Chris Lattnerc97507b2009-02-25 05:09:54 +0000[diff] [blame]96and code generator. While Clang is not included in the LLVM 2.5 release, it
97is continuing to make major strides forward in all areas. Its C and Objective-C
98parsing and code generation support is now very solid. For example, it is
99capable of successfully building many real applications for X86-32 and X86-64,
100including the FreeBSD kernel. C++ is also making <a
101href="http://clang.llvm.org/cxx_status.html">incredible progress</a>, and work
102on templates has recently started.</p>
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000[diff] [blame]103
Chris Lattnerc97507b2009-02-25 05:09:54 +0000[diff] [blame]104<p>While Clang is not yet production quality, it is progressing very nicely and
105is quite usable for building many C and Objective-C applications. If you are
106interested in fast compiles and good diagnostics, we encourage you to try it out
Chris Lattnera53f4972009-02-25 06:34:50 +0000[diff] [blame]107by <a href="http://clang.llvm.org/get_started.html">building from mainline</a>
Chris Lattnerc97507b2009-02-25 05:09:54 +0000[diff] [blame]108and reporting any issues you hit to the <a
109href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-dev">Clang front-end mailing
110list</a>.</p>
111
112<p>In the LLVM 2.5 time-frame, the Clang team has made many improvements:</p>
Bill Wendling385b0d32008-10-27 09:27:33 +0000[diff] [blame]113
Daniel Dunbarf3e35782008-10-14 23:25:09 +0000[diff] [blame]114<ul>
Chris Lattnerc97507b2009-02-25 05:09:54 +0000[diff] [blame]115<li>Clang now has a new driver, which is focused on providing a GCC-compatible
116 interface.</li>
117<li>The X86-64 ABI is now supported.</li>
118<li>Precompiled header support is now implemented.</li>
119<li>Objective-C support is significantly improved beyond LLVM 2.4, supporting
120 many features, such as Objective-C Garbage Collection.</li>
121<li>Many many bugs are fixed.</li>
Chris Lattnera3c683b2008-10-13 18:11:54 +0000[diff] [blame]122</div>
123
124<!--=========================================================================-->
125<div class="doc_subsection">
126<a name="clangsa">Clang Static Analyzer</a>
127</div>
128
129<div class="doc_text">
130
Ted Kremenek0437b2c2008-10-14 05:14:21 +0000[diff] [blame]131<p>The Clang project also includes an early stage static source code analysis
132tool for <a href="http://clang.llvm.org/StaticAnalysis.html">automatically
133finding bugs</a> in C and Objective-C programs. The tool performs a growing set
Chris Lattnerff170152008-10-14 06:02:29 +0000[diff] [blame]134of checks to find bugs that occur on a specific path within a program. Examples
Ted Kremenek0437b2c2008-10-14 05:14:21 +0000[diff] [blame]135of bugs the tool finds include logic errors such as null dereferences,
136violations of various API rules, dead code, and potential memory leaks in
Chris Lattnerff170152008-10-14 06:02:29 +0000[diff] [blame]137Objective-C programs. Since its inception, public feedback on the tool has been
138extremely positive, and conservative estimates put the number of real bugs it
139has found in industrial-quality software on the order of thousands.</p>
Chris Lattnerc2d84672008-10-14 00:52:49 +0000[diff] [blame]140
Ted Kremenek0437b2c2008-10-14 05:14:21 +0000[diff] [blame]141<p>The tool also provides a simple web GUI to inspect potential bugs found by
Chris Lattnerff170152008-10-14 06:02:29 +0000[diff] [blame]142the tool. While still early in development, the GUI illustrates some of the key
Ted Kremenek0437b2c2008-10-14 05:14:21 +0000[diff] [blame]143features of Clang: accurate source location information, which is used by the
144GUI to highlight specific code expressions that relate to a bug (including those
Bill Wendling385b0d32008-10-27 09:27:33 +0000[diff] [blame]145that span multiple lines); and built-in knowledge of macros, which is used to
Ted Kremenek0437b2c2008-10-14 05:14:21 +0000[diff] [blame]146perform inline expansion of macros within the GUI itself.</p>
147
Chris Lattnerff170152008-10-14 06:02:29 +0000[diff] [blame]148<p>The set of checks performed by the static analyzer is gradually expanding,
Bill Wendling385b0d32008-10-27 09:27:33 +0000[diff] [blame]149and future plans for the tool include full source-level inter-procedural
150analysis and deeper checks such as buffer overrun detection. There are many
151opportunities to extend and enhance the static analyzer, and anyone interested
152in working on this project is encouraged to get involved!</p>
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000[diff] [blame]153
154</div>
155
Chris Lattner78a130b2008-10-13 18:01:01 +0000[diff] [blame]156<!--=========================================================================-->
157<div class="doc_subsection">
Nicolas Geoffray2b139382008-10-14 19:23:04 +0000[diff] [blame]158<a name="vmkit">VMKit: JVM/CLI Virtual Machine Implementation</a>
Chris Lattner78a130b2008-10-13 18:01:01 +0000[diff] [blame]159</div>
160
161<div class="doc_text">
162<p>
Nicolas Geoffray2b139382008-10-14 19:23:04 +0000[diff] [blame]163The <a href="http://vmkit.llvm.org/">VMKit project</a> is an implementation of
Chris Lattner78a130b2008-10-13 18:01:01 +0000[diff] [blame]164a JVM and a CLI Virtual Machines (Microsoft .NET is an
165implementation of the CLI) using the Just-In-Time compiler of LLVM.</p>
166
Chris Lattner02408742009-02-25 05:45:05 +0000[diff] [blame]167<p>Following LLVM 2.5, VMKit has its first release ? that you can find on its
Nicolas Geoffray20cfdd42008-10-15 20:25:04 +0000[diff] [blame]168<a href="http://vmkit.llvm.org/releases/">webpage</a>. The release includes
169bug fixes, cleanup and new features. The major changes are:</p>
Chris Lattner78a130b2008-10-13 18:01:01 +0000[diff] [blame]170
Nicolas Geoffray2b139382008-10-14 19:23:04 +0000[diff] [blame]171<ul>
172
Chris Lattner95d25072009-02-25 04:41:31 +0000[diff] [blame]173<li>?</li>
Nicolas Geoffray2b139382008-10-14 19:23:04 +0000[diff] [blame]174
175</ul>
Chris Lattner78a130b2008-10-13 18:01:01 +0000[diff] [blame]176</div>
177
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000[diff] [blame]178
179<!-- *********************************************************************** -->
180<div class="doc_section">
Chris Lattner78a130b2008-10-13 18:01:01 +0000[diff] [blame]181 <a name="whatsnew">What's New in LLVM?</a>
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000[diff] [blame]182</div>
183<!-- *********************************************************************** -->
184
Chris Lattner5cce7a52008-06-08 22:59:35 +0000[diff] [blame]185<div class="doc_text">
186
Bill Wendling385b0d32008-10-27 09:27:33 +0000[diff] [blame]187<p>This release includes a huge number of bug fixes, performance tweaks, and
Chris Lattner92eacf82008-10-13 17:57:36 +0000[diff] [blame]188minor improvements. Some of the major improvements and new features are listed
189in this section.
Chris Lattner5cce7a52008-06-08 22:59:35 +0000[diff] [blame]190</p>
191</div>
192
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000[diff] [blame]193<!--=========================================================================-->
Chris Lattnerf65224f2008-06-08 21:34:41 +0000[diff] [blame]194<div class="doc_subsection">
Chris Lattnere0798082008-02-06 18:00:06 +0000[diff] [blame]195<a name="majorfeatures">Major New Features</a>
196</div>
197
198<div class="doc_text">
199
Chris Lattner95d25072009-02-25 04:41:31 +0000[diff] [blame]200<p>LLVM 2.5 includes several major new capabilities:</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]201
202<ul>
Chris Lattnera53f4972009-02-25 06:34:50 +0000[diff] [blame]203<li><p> Legalize Types</p></li>
204
205<!--
206Random stuff:
207
208.ll parser rewrite.
209GCC inliner off.
210cmake mature?
211x86 backend FS/GS segment address spaces?
212nocapture
213memdep is faster / more aggressive.
214how to write a backend doc
215fastisel + exception handling
216vector widening <3 x float> -> <4 x float>
217-->
Chris Lattnerba948522008-06-05 06:57:39 +0000[diff] [blame]218
Chris Lattner5ba16862008-02-10 08:18:42 +0000[diff] [blame]219</ul>
220
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]221</div>
222
Chris Lattnerc5a4e312008-06-05 06:25:56 +0000[diff] [blame]223
224<!--=========================================================================-->
225<div class="doc_subsection">
Chris Lattnerf65224f2008-06-08 21:34:41 +0000[diff] [blame]226<a name="llvm-gcc">llvm-gcc 4.2 Improvements</a>
Chris Lattnerc5a4e312008-06-05 06:25:56 +0000[diff] [blame]227</div>
228
229<div class="doc_text">
230
Chris Lattner4352cc82008-10-13 20:47:20 +0000[diff] [blame]231<p>LLVM fully supports the llvm-gcc 4.2 front-end, which marries the GCC
232front-ends and driver with the LLVM optimizer and code generator. It currently
233includes support for the C, C++, Objective-C, Ada, and Fortran front-ends.</p>
Chris Lattnerc5a4e312008-06-05 06:25:56 +0000[diff] [blame]234
Chris Lattner5cce7a52008-06-08 22:59:35 +0000[diff] [blame]235<ul>
Chris Lattner95d25072009-02-25 04:41:31 +0000[diff] [blame]236<li>?</li>
Gabor Greif0e49cc82008-06-09 06:06:18 +0000[diff] [blame]237</ul>
Chris Lattnerc5a4e312008-06-05 06:25:56 +0000[diff] [blame]238
Chris Lattnerc5a4e312008-06-05 06:25:56 +0000[diff] [blame]239</div>
240
241
Chris Lattnerb0d6c502007-09-21 03:54:09 +0000[diff] [blame]242<!--=========================================================================-->
243<div class="doc_subsection">
Chris Lattnerc3649452008-02-10 08:17:19 +0000[diff] [blame]244<a name="coreimprovements">LLVM Core Improvements</a>
245</div>
246
247<div class="doc_text">
Bill Wendling385b0d32008-10-27 09:27:33 +0000[diff] [blame]248<p>New features include:</p>
Chris Lattnerc3649452008-02-10 08:17:19 +0000[diff] [blame]249
Chris Lattnerc5a4e312008-06-05 06:25:56 +0000[diff] [blame]250<ul>
Chris Lattner95d25072009-02-25 04:41:31 +0000[diff] [blame]251<li>?</li>
Chris Lattnerf7bae6d2008-10-13 20:59:32 +0000[diff] [blame]252
Chris Lattnerc3649452008-02-10 08:17:19 +0000[diff] [blame]253</ul>
Mikhail Glushenkov808cd3e2008-10-13 02:08:34 +0000[diff] [blame]254
Chris Lattnerc3649452008-02-10 08:17:19 +0000[diff] [blame]255</div>
256
257<!--=========================================================================-->
258<div class="doc_subsection">
Chris Lattner8fda4952008-02-10 07:46:44 +0000[diff] [blame]259<a name="optimizer">Optimizer Improvements</a>
260</div>
261
262<div class="doc_text">
263
Chris Lattnerea9c2242008-10-13 21:50:36 +0000[diff] [blame]264<p>In addition to a huge array of bug fixes and minor performance tweaks, this
265release includes a few major enhancements and additions to the optimizers:</p>
Chris Lattner8fda4952008-02-10 07:46:44 +0000[diff] [blame]266
267<ul>
268
Chris Lattner95d25072009-02-25 04:41:31 +0000[diff] [blame]269<li>?</li>
Chris Lattnerea9c2242008-10-13 21:50:36 +0000[diff] [blame]270
Chris Lattner0eef6e42008-06-08 02:45:07 +0000[diff] [blame]271</ul>
272
273</div>
274
275<!--=========================================================================-->
276<div class="doc_subsection">
277<a name="codegen">Code Generator Improvements</a>
278</div>
279
280<div class="doc_text">
281
Gabor Greifaa53e562008-10-14 11:31:14 +0000[diff] [blame]282<p>We have put a significant amount of work into the code generator infrastructure,
Chris Lattner0eef6e42008-06-08 02:45:07 +0000[diff] [blame]283which allows us to implement more aggressive algorithms and make it run
284faster:</p>
285
286<ul>
Chris Lattner95d25072009-02-25 04:41:31 +0000[diff] [blame]287<li>?</li>
Chris Lattner0eef6e42008-06-08 02:45:07 +0000[diff] [blame]288
Chris Lattnerb0d6c502007-09-21 03:54:09 +0000[diff] [blame]289</ul>
290
291</div>
292
293
294<!--=========================================================================-->
295<div class="doc_subsection">
Chris Lattnercc64a322008-10-13 22:06:31 +0000[diff] [blame]296<a name="targetspecific">Target Specific Improvements</a>
Chris Lattnerb0d6c502007-09-21 03:54:09 +0000[diff] [blame]297</div>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]298
299<div class="doc_text">
Chris Lattnerc3649452008-02-10 08:17:19 +0000[diff] [blame]300<p>New target-specific features include:
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]301</p>
302
303<ul>
Chris Lattner95d25072009-02-25 04:41:31 +0000[diff] [blame]304<li>?</li>
Chris Lattnere45f18b2008-06-05 08:02:49 +0000[diff] [blame]305</ul>
Chris Lattnere45f18b2008-06-05 08:02:49 +0000[diff] [blame]306
Mikhail Glushenkov808cd3e2008-10-13 02:08:34 +0000[diff] [blame]307</div>
Chris Lattnere45f18b2008-06-05 08:02:49 +0000[diff] [blame]308
309
310<!--=========================================================================-->
311<div class="doc_subsection">
Chris Lattnerb0d6c502007-09-21 03:54:09 +0000[diff] [blame]312<a name="otherimprovements">Other Improvements</a>
313</div>
314
315<div class="doc_text">
316<p>New features include:
317</p>
318
319<ul>
Chris Lattner95d25072009-02-25 04:41:31 +0000[diff] [blame]320<li>?</li>
Tanya Lattnerc79f7542008-11-04 18:40:27 +0000[diff] [blame]321
Chris Lattnerb0d6c502007-09-21 03:54:09 +0000[diff] [blame]322</ul>
Mikhail Glushenkov808cd3e2008-10-13 02:08:34 +0000[diff] [blame]323
Chris Lattnerb0d6c502007-09-21 03:54:09 +0000[diff] [blame]324</div>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]325
Chris Lattner92eacf82008-10-13 17:57:36 +0000[diff] [blame]326<!--=========================================================================-->
327<div class="doc_subsection">
328<a name="changes">Major Changes and Removed Features</a>
329</div>
330
331<div class="doc_text">
332
Chris Lattnercc64a322008-10-13 22:06:31 +0000[diff] [blame]333<p>If you're already an LLVM user or developer with out-of-tree changes based
Chris Lattner95d25072009-02-25 04:41:31 +0000[diff] [blame]334on LLVM 2.4, this section lists some "gotchas" that you may run into upgrading
Chris Lattnercc64a322008-10-13 22:06:31 +0000[diff] [blame]335from the previous release.</p>
Chris Lattner92eacf82008-10-13 17:57:36 +0000[diff] [blame]336
337<ul>
338
Chris Lattner95d25072009-02-25 04:41:31 +0000[diff] [blame]339<li>?</li>
Chris Lattnercc64a322008-10-13 22:06:31 +0000[diff] [blame]340</ul>
341
342
343<p>In addition, many APIs have changed in this release. Some of the major LLVM
344API changes are:</p>
345
346<ul>
Chris Lattner95d25072009-02-25 04:41:31 +0000[diff] [blame]347<li>?</li>
Devang Patel0e3da1a2008-10-14 20:03:43 +0000[diff] [blame]348</ul>
Chris Lattner92eacf82008-10-13 17:57:36 +0000[diff] [blame]349
Chris Lattner95d25072009-02-25 04:41:31 +0000[diff] [blame]350<li>?</li>
Chris Lattner92eacf82008-10-13 17:57:36 +0000[diff] [blame]351</ul>
352
353</div>
354
355
356
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]357<!-- *********************************************************************** -->
358<div class="doc_section">
359 <a name="portability">Portability and Supported Platforms</a>
360</div>
361<!-- *********************************************************************** -->
362
363<div class="doc_text">
364
365<p>LLVM is known to work on the following platforms:</p>
366
367<ul>
Chris Lattnerb1ad47c2008-11-10 05:40:34 +0000[diff] [blame]368<li>Intel and AMD machines (IA32, X86-64, AMD64, EMT-64) running Red Hat
369Linux, Fedora Core and FreeBSD (and probably other unix-like systems).</li>
370<li>PowerPC and X86-based Mac OS X systems, running 10.3 and above in 32-bit
371and 64-bit modes.</li>
Chris Lattnere0798082008-02-06 18:00:06 +0000[diff] [blame]372<li>Intel and AMD machines running on Win32 using MinGW libraries (native).</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]373<li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
374 support is available for native builds with Visual C++).</li>
Gabor Greif5e75e652008-06-05 18:39:01 +0000[diff] [blame]375<li>Sun UltraSPARC workstations running Solaris 10.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]376<li>Alpha-based machines running Debian GNU/Linux.</li>
Gabor Greif5e75e652008-06-05 18:39:01 +0000[diff] [blame]377<li>Itanium-based (IA64) machines running Linux and HP-UX.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]378</ul>
379
Chris Lattnerba948522008-06-05 06:57:39 +0000[diff] [blame]380<p>The core LLVM infrastructure uses GNU autoconf to adapt itself
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]381to the machine and operating system on which it is built. However, minor
382porting may be required to get LLVM to work on new platforms. We welcome your
383portability patches and reports of successful builds or error messages.</p>
384
385</div>
386
387<!-- *********************************************************************** -->
388<div class="doc_section">
389 <a name="knownproblems">Known Problems</a>
390</div>
391<!-- *********************************************************************** -->
392
393<div class="doc_text">
394
Chris Lattnerb1ad47c2008-11-10 05:40:34 +0000[diff] [blame]395<p>This section contains significant known problems with the LLVM system,
396listed by component. If you run into a problem, please check the <a
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]397href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
398there isn't already one.</p>
399
400</div>
401
402<!-- ======================================================================= -->
403<div class="doc_subsection">
404 <a name="experimental">Experimental features included with this release</a>
405</div>
406
407<div class="doc_text">
408
409<p>The following components of this LLVM release are either untested, known to
410be broken or unreliable, or are in early development. These components should
411not be relied on, and bugs should not be filed against them, but they may be
412useful to some people. In particular, if you would like to work on one of these
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000[diff] [blame]413components, please contact us on the <a
414href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]415
416<ul>
Gabor Greifaa53e562008-10-14 11:31:14 +0000[diff] [blame]417<li>The MSIL, IA64, Alpha, SPU, MIPS, and PIC16 backends are experimental.</li>
Duncan Sandsa73561c2008-06-08 20:18:35 +0000[diff] [blame]418<li>The llc "<tt>-filetype=asm</tt>" (the default) is the only supported
Chris Lattnerbd633de92008-02-06 06:30:34 +0000[diff] [blame]419 value for this option.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]420</ul>
421
422</div>
423
424<!-- ======================================================================= -->
425<div class="doc_subsection">
426 <a name="x86-be">Known problems with the X86 back-end</a>
427</div>
428
429<div class="doc_text">
430
431<ul>
Anton Korobeynikov77d15e22008-06-08 10:24:13 +0000[diff] [blame]432 <li>The X86 backend does not yet support
433 all <a href="http://llvm.org/PR879">inline assembly that uses the X86
434 floating point stack</a>. It supports the 'f' and 't' constraints, but not
435 'u'.</li>
Chris Lattnerd95b5962008-06-08 21:19:07 +0000[diff] [blame]436 <li>The X86 backend generates inefficient floating point code when configured
437 to generate code for systems that don't have SSE2.</li>
Duncan Sands8b4f3772008-06-08 19:38:43 +0000[diff] [blame]438 <li>Win64 code generation wasn't widely tested. Everything should work, but we
Anton Korobeynikov77d15e22008-06-08 10:24:13 +0000[diff] [blame]439 expect small issues to happen. Also, llvm-gcc cannot build mingw64 runtime
440 currently due
441 to <a href="http://llvm.org/PR2255">several</a>
Chris Lattnerf06141a2008-06-08 23:12:47 +0000[diff] [blame]442 <a href="http://llvm.org/PR2257">bugs</a> due to lack of support for the
443 'u' inline assembly constraint and X87 floating point inline assembly.</li>
Dan Gohman3882ecb2008-06-08 23:05:11 +0000[diff] [blame]444 <li>The X86-64 backend does not yet support the LLVM IR instruction
445 <tt>va_arg</tt>. Currently, the llvm-gcc front-end supports variadic
446 argument constructs on X86-64 by lowering them manually.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]447</ul>
448
449</div>
450
451<!-- ======================================================================= -->
452<div class="doc_subsection">
453 <a name="ppc-be">Known problems with the PowerPC back-end</a>
454</div>
455
456<div class="doc_text">
457
458<ul>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]459<li>The Linux PPC32/ABI support needs testing for the interpreter and static
460compilation, and lacks support for debug information.</li>
461</ul>
462
463</div>
464
465<!-- ======================================================================= -->
466<div class="doc_subsection">
467 <a name="arm-be">Known problems with the ARM back-end</a>
468</div>
469
470<div class="doc_text">
471
472<ul>
473<li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
Duncan Sands1827fa62007-09-26 15:59:54 +0000[diff] [blame]474processors, thumb programs can crash or produce wrong
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]475results (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
476<li>Compilation for ARM Linux OABI (old ABI) is supported, but not fully tested.
477</li>
Chris Lattnerd95b5962008-06-08 21:19:07 +0000[diff] [blame]478<li>There is a bug in QEMU-ARM (&lt;= 0.9.0) which causes it to incorrectly
479 execute
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]480programs compiled with LLVM. Please use more recent versions of QEMU.</li>
481</ul>
482
483</div>
484
485<!-- ======================================================================= -->
486<div class="doc_subsection">
487 <a name="sparc-be">Known problems with the SPARC back-end</a>
488</div>
489
490<div class="doc_text">
491
492<ul>
493<li>The SPARC backend only supports the 32-bit SPARC ABI (-m32), it does not
494 support the 64-bit SPARC ABI (-m64).</li>
495</ul>
496
497</div>
498
499<!-- ======================================================================= -->
500<div class="doc_subsection">
Bruno Cardoso Lopes62d45d72008-10-25 14:56:26 +0000[diff] [blame]501 <a name="mips-be">Known problems with the MIPS back-end</a>
502</div>
503
504<div class="doc_text">
505
506<ul>
507<li>The O32 ABI is not fully supported.</li>
508<li>64-bit MIPS targets are not supported yet.</li>
509</ul>
510
511</div>
512
513<!-- ======================================================================= -->
514<div class="doc_subsection">
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]515 <a name="alpha-be">Known problems with the Alpha back-end</a>
516</div>
517
518<div class="doc_text">
519
520<ul>
521
522<li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
523appropriate nops inserted to ensure restartability.</li>
524
525</ul>
526</div>
527
528<!-- ======================================================================= -->
529<div class="doc_subsection">
530 <a name="ia64-be">Known problems with the IA64 back-end</a>
531</div>
532
533<div class="doc_text">
534
535<ul>
Chris Lattnerf06141a2008-06-08 23:12:47 +0000[diff] [blame]536<li>The Itanium backend is highly experimental, and has a number of known
537 issues. We are looking for a maintainer for the Itanium backend. If you
Gabor Greif45fc8b12008-10-15 10:47:24 +0000[diff] [blame]538 are interested, please contact the LLVMdev mailing list.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]539</ul>
540
541</div>
542
543<!-- ======================================================================= -->
544<div class="doc_subsection">
545 <a name="c-be">Known problems with the C back-end</a>
546</div>
547
548<div class="doc_text">
549
550<ul>
Chris Lattner499c07c2008-06-05 06:35:40 +0000[diff] [blame]551<li><a href="http://llvm.org/PR802">The C backend has only basic support for
552 inline assembly code</a>.</li>
Chris Lattnere0194462007-09-26 06:01:35 +0000[diff] [blame]553<li><a href="http://llvm.org/PR1658">The C backend violates the ABI of common
554 C++ programs</a>, preventing intermixing between C++ compiled by the CBE and
Duncan Sandsa73561c2008-06-08 20:18:35 +0000[diff] [blame]555 C++ code compiled with llc or native compilers.</li>
Duncan Sandsbd0ad6e2008-02-10 13:40:55 +0000[diff] [blame]556<li>The C backend does not support all exception handling constructs.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]557</ul>
558
559</div>
560
561
562<!-- ======================================================================= -->
563<div class="doc_subsection">
Chris Lattner499c07c2008-06-05 06:35:40 +0000[diff] [blame]564 <a name="c-fe">Known problems with the llvm-gcc C front-end</a>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]565</div>
566
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]567<div class="doc_text">
568
Chris Lattnere0798082008-02-06 18:00:06 +0000[diff] [blame]569<p>llvm-gcc does not currently support <a href="http://llvm.org/PR869">Link-Time
570Optimization</a> on most platforms "out-of-the-box". Please inquire on the
Gabor Greif45fc8b12008-10-15 10:47:24 +0000[diff] [blame]571LLVMdev mailing list if you are interested.</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]572
Chris Lattner499c07c2008-06-05 06:35:40 +0000[diff] [blame]573<p>The only major language feature of GCC not supported by llvm-gcc is
574 the <tt>__builtin_apply</tt> family of builtins. However, some extensions
575 are only supported on some targets. For example, trampolines are only
Duncan Sandsa73561c2008-06-08 20:18:35 +0000[diff] [blame]576 supported on some targets (these are used when you take the address of a
577 nested function).</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]578
Chris Lattner499c07c2008-06-05 06:35:40 +0000[diff] [blame]579<p>If you run into GCC extensions which are not supported, please let us know.
580</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]581
582</div>
583
584<!-- ======================================================================= -->
585<div class="doc_subsection">
Chris Lattner499c07c2008-06-05 06:35:40 +0000[diff] [blame]586 <a name="c++-fe">Known problems with the llvm-gcc C++ front-end</a>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]587</div>
588
589<div class="doc_text">
590
591<p>The C++ front-end is considered to be fully
592tested and works for a number of non-trivial programs, including LLVM
593itself, Qt, Mozilla, etc.</p>
594
595<ul>
Anton Korobeynikovd9a17932008-10-11 18:27:16 +0000[diff] [blame]596<li>Exception handling works well on the X86 and PowerPC targets. Currently
Chris Lattnerb1ad47c2008-11-10 05:40:34 +0000[diff] [blame]597 only Linux and Darwin targets are supported (both 32 and 64 bit).</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]598</ul>
599
600</div>
601
Chris Lattner6c8a1b82008-10-30 03:58:13 +0000[diff] [blame]602<!-- ======================================================================= -->
603<div class="doc_subsection">
604 <a name="fortran-fe">Known problems with the llvm-gcc Fortran front-end</a>
605</div>
606
607<div class="doc_text">
Gabor Greif1fc8fbc2008-11-04 21:50:59 +0000[diff] [blame]608<ul>
Chris Lattner6c8a1b82008-10-30 03:58:13 +0000[diff] [blame]609<li>Fortran support generally works, but there are still several unresolved bugs
610 in Bugzilla. Please see the tools/gfortran component for details.</li>
611
612<li>The Fortran front-end currently does not build on Darwin (without tweaks)
613 due to unresolved dependencies on the C front-end.</li>
Gabor Greif1fc8fbc2008-11-04 21:50:59 +0000[diff] [blame]614</ul>
Chris Lattner6c8a1b82008-10-30 03:58:13 +0000[diff] [blame]615</div>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]616
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000[diff] [blame]617<!-- ======================================================================= -->
618<div class="doc_subsection">
Chris Lattner499c07c2008-06-05 06:35:40 +0000[diff] [blame]619 <a name="ada-fe">Known problems with the llvm-gcc Ada front-end</a>
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000[diff] [blame]620</div>
621
622<div class="doc_text">
623The llvm-gcc 4.2 Ada compiler works fairly well, however this is not a mature
624technology and problems should be expected.
625<ul>
Duncan Sandsa73561c2008-06-08 20:18:35 +0000[diff] [blame]626<li>The Ada front-end currently only builds on X86-32. This is mainly due
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000[diff] [blame]627to lack of trampoline support (pointers to nested functions) on other platforms,
Duncan Sandsa73561c2008-06-08 20:18:35 +0000[diff] [blame]628however it <a href="http://llvm.org/PR2006">also fails to build on X86-64</a>
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000[diff] [blame]629which does support trampolines.</li>
630<li>The Ada front-end <a href="http://llvm.org/PR2007">fails to bootstrap</a>.
631Workaround: configure with --disable-bootstrap.</li>
Duncan Sands2dbc2e82008-10-13 17:27:23 +0000[diff] [blame]632<li>The c380004, <a href="http://llvm.org/PR2010">c393010</a>
633and <a href="http://llvm.org/PR2421">cxg2021</a> ACATS tests fail
634(c380004 also fails with gcc-4.2 mainline).</li>
635<li>Some gcc specific Ada tests continue to crash the compiler.</li>
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000[diff] [blame]636<li>The -E binder option (exception backtraces)
637<a href="http://llvm.org/PR1982">does not work</a> and will result in programs
638crashing if an exception is raised. Workaround: do not use -E.</li>
639<li>Only discrete types <a href="http://llvm.org/PR1981">are allowed to start
640or finish at a non-byte offset</a> in a record. Workaround: do not pack records
641or use representation clauses that result in a field of a non-discrete type
642starting or finishing in the middle of a byte.</li>
Chris Lattnerd95b5962008-06-08 21:19:07 +0000[diff] [blame]643<li>The <tt>lli</tt> interpreter <a href="http://llvm.org/PR2009">considers
644'main' as generated by the Ada binder to be invalid</a>.
645Workaround: hand edit the file to use pointers for <tt>argv</tt> and
646<tt>envp</tt> rather than integers.</li>
647<li>The <tt>-fstack-check</tt> option <a href="http://llvm.org/PR2008">is
648ignored</a>.</li>
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000[diff] [blame]649</ul>
650</div>
651
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]652<!-- *********************************************************************** -->
653<div class="doc_section">
654 <a name="additionalinfo">Additional Information</a>
655</div>
656<!-- *********************************************************************** -->
657
658<div class="doc_text">
659
660<p>A wide variety of additional information is available on the <a
661href="http://llvm.org">LLVM web page</a>, in particular in the <a
662href="http://llvm.org/docs/">documentation</a> section. The web page also
663contains versions of the API documentation which is up-to-date with the
664Subversion version of the source code.
665You can access versions of these documents specific to this release by going
666into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
667
668<p>If you have any questions or comments about LLVM, please feel free to contact
669us via the <a href="http://llvm.org/docs/#maillist"> mailing
670lists</a>.</p>
671
672</div>
673
674<!-- *********************************************************************** -->
675
676<hr>
677<address>
678 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman947321d2008-12-11 17:34:48 +0000[diff] [blame]679 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]680 <a href="http://validator.w3.org/check/referer"><img
Misha Brukman947321d2008-12-11 17:34:48 +0000[diff] [blame]681 src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]682
683 <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
684 Last modified: $Date$
685</address>
686
687</body>
688</html>