Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / llvm / 808cd3e257dff8becadfb91b01c4f09c9ffdf96e / . / docs / ReleaseNotes.html
blob: a67a4d87204c2569f92b2aeefbaef7456cdbb735 [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 Lattner2c3ef982008-10-11 18:18:28 +0000[diff] [blame]7 <title>LLVM 2.4 Release Notes</title>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]8</head>
9<body>
10
Chris Lattner2c3ef982008-10-11 18:18:28 +0000[diff] [blame]11<div class="doc_title">LLVM 2.4 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 Lattnerf6a0d382008-06-08 21:58:17 +0000[diff] [blame]15 <li><a href="#changes">Major Changes and Sub-project Status</a></li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]16 <li><a href="#whatsnew">What's New?</a></li>
17 <li><a href="GettingStarted.html">Installation Instructions</a></li>
18 <li><a href="#portability">Portability and Supported Platforms</a></li>
19 <li><a href="#knownproblems">Known Problems</a>
20 <li><a href="#additionalinfo">Additional Information</a></li>
21</ol>
22
23<div class="doc_author">
24 <p>Written by the <a href="http://llvm.org">LLVM Team</a><p>
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
35<p>This document contains the release notes for the LLVM compiler
Chris Lattner2c3ef982008-10-11 18:18:28 +0000[diff] [blame]36infrastructure, release 2.4. Here we describe the status of LLVM, including
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]37major improvements from the previous release and any known problems. All LLVM
38releases may be downloaded from the <a href="http://llvm.org/releases/">LLVM
39releases web site</a>.</p>
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
44href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM developer's mailing
45list</a> is a good place to send them.</p>
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
49current one. To see the release notes for a specific releases, please see the
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
54<!-- *********************************************************************** -->
55<div class="doc_section">
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000[diff] [blame]56 <a name="changes">Major Changes and Sub-project Status</a>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]57</div>
58<!-- *********************************************************************** -->
59
60<div class="doc_text">
61
Mikhail Glushenkov808cd3e2008-10-13 02:08:34 +0000[diff] [blame^]62<p>This is the fifteenth public release of the LLVM Compiler Infrastructure.
Chris Lattner2c3ef982008-10-11 18:18:28 +0000[diff] [blame]63It includes a large number of features and refinements from LLVM 2.3.</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]64
65</div>
66
Chris Lattner2c3ef982008-10-11 18:18:28 +0000[diff] [blame]67<!-- Unfinished features in 2.4:
Chris Lattner8fda4952008-02-10 07:46:44 +0000[diff] [blame]68 Machine LICM
69 Machine Sinking
70 LegalizeDAGTypes
Chris Lattner4f076402008-10-12 19:47:48 +0000[diff] [blame]71 llc -enable-value-prop, propagation of value info (sign/zero ext info) from
72 one MBB to another
Chris Lattner8fda4952008-02-10 07:46:44 +0000[diff] [blame]73 -->
Mikhail Glushenkov808cd3e2008-10-13 02:08:34 +0000[diff] [blame^]74
Chris Lattner4f076402008-10-12 19:47:48 +0000[diff] [blame]75 <!-- for announcement email:
76 mention dev mtg
Chris Lattner548493b2008-10-12 22:57:58 +0000[diff] [blame]77 Xcode 3.1 and 3.1.1.
Chris Lattner4f076402008-10-12 19:47:48 +0000[diff] [blame]78 -->
Chris Lattner8fda4952008-02-10 07:46:44 +0000[diff] [blame]79
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]80<!--=========================================================================-->
81<div class="doc_subsection">
Chris Lattner2c3ef982008-10-11 18:18:28 +0000[diff] [blame]82<a name="changes">Major Changes in LLVM 2.4</a>
Chris Lattner41bf8e92008-02-10 07:04:35 +0000[diff] [blame]83</div>
84
85<div class="doc_text">
86
Chris Lattner4f076402008-10-12 19:47:48 +0000[diff] [blame]87<p>The LLVM IR generated by llvm-gcc now doesn't name instructions. Use the
88 instnamer pass if you want them.</p>
89
Chris Lattner548493b2008-10-12 22:57:58 +0000[diff] [blame]90<li>LoadVN and GCSE are completely gone.</li>
Chris Lattner4f076402008-10-12 19:47:48 +0000[diff] [blame]91
Chris Lattnerd95b5962008-06-08 21:19:07 +0000[diff] [blame]92
Chris Lattner0eef6e42008-06-08 02:45:07 +0000[diff] [blame]93<p>LLVM API Changes:</p>
Chris Lattnere45f18b2008-06-05 08:02:49 +0000[diff] [blame]94
Chris Lattner0eef6e42008-06-08 02:45:07 +0000[diff] [blame]95<ul>
Chris Lattner2c3ef982008-10-11 18:18:28 +0000[diff] [blame]96<li>....</li>
Daniel Dunbardcb129a2008-10-11 21:26:56 +0000[diff] [blame]97
98<li>... Attributes changes ... </li>
99
Chris Lattnera5a49382008-10-12 18:30:33 +0000[diff] [blame]100<li>The <tt>DbgStopPointInst</tt> methods <tt>getDirectory</tt> and
101<tt>getFileName</tt> now return <tt>Value*</tt> instead of strings. These can be
102converted to strings using <tt>llvm::GetConstantStringInfo</tt> defined via
103"llvm/Analysis/ValueTracking.h".</li>
Daniel Dunbardcb129a2008-10-11 21:26:56 +0000[diff] [blame]104
Chris Lattnera5a49382008-10-12 18:30:33 +0000[diff] [blame]105<li>API change: BinaryOperator::create -> Create (CmpInst, CastInst too)</li>
Chris Lattner4f076402008-10-12 19:47:48 +0000[diff] [blame]106<li>Various header files like "llvm/ADT/iterator" were given a .h suffix.
107 Change your code to #include "llvm/ADT/iterator.h" instead.</li>
Mikhail Glushenkov808cd3e2008-10-13 02:08:34 +0000[diff] [blame^]108
Chris Lattner0eef6e42008-06-08 02:45:07 +0000[diff] [blame]109</ul>
Chris Lattner548493b2008-10-12 22:57:58 +0000[diff] [blame]110
Chris Lattnere0798082008-02-06 18:00:06 +0000[diff] [blame]111</div>
112
113<!--=========================================================================-->
114<div class="doc_subsection">
Chris Lattnerf65224f2008-06-08 21:34:41 +0000[diff] [blame]115<a name="otherprojects">Other LLVM Sub-Projects</a>
116</div>
117
118<div class="doc_text">
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000[diff] [blame]119<p>
Chris Lattner2c3ef982008-10-11 18:18:28 +0000[diff] [blame]120The core LLVM 2.4 distribution currently consists of code from the core LLVM
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000[diff] [blame]121repository (which roughly contains the LLVM optimizer, code generators and
122supporting tools) and the llvm-gcc repository. In addition to this code, the
123LLVM Project includes other sub-projects that are in development. The two which
Chris Lattner2c3ef982008-10-11 18:18:28 +0000[diff] [blame]124are the most actively developed are the <a href="#clang">Clang Project</a> and
Mikhail Glushenkov808cd3e2008-10-13 02:08:34 +0000[diff] [blame^]125<a href="#vmkit">vmkit Project</a>.
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000[diff] [blame]126</p>
127</div>
128
129<!--=========================================================================-->
130<div class="doc_subsubsection">
131<a name="vmkit">vmkit</a>
132</div>
133
134<div class="doc_text">
135<p>
Chris Lattner2c3ef982008-10-11 18:18:28 +0000[diff] [blame]136The <a href="http://vmkit.llvm.org/">"vmkit" project</a> is an implementation of
137a JVM and a CLI Virtual Machines (Microsoft .NET is an
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000[diff] [blame]138implementation of the CLI) using the Just-In-Time compiler of LLVM.</p>
139
Chris Lattner2c3ef982008-10-11 18:18:28 +0000[diff] [blame]140<p>...</p>
Chris Lattnerf65224f2008-06-08 21:34:41 +0000[diff] [blame]141
142</div>
143
144<!--=========================================================================-->
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000[diff] [blame]145<div class="doc_subsubsection">
146<a name="clang">Clang</a>
147</div>
148
149<div class="doc_text">
150
151<p>The <a href="http://clang.llvm.org/">Clang project</a> is an effort to build
152a set of new 'LLVM native' front-end technologies for the LLVM optimizer
153and code generator. Clang is continuing to make major strides forward in all
154areas. Its C and Objective-C parsing support is very solid, and the code
155generation support is far enough along to build many C applications. While not
156yet production quality, it is progressing very nicely. In addition, C++
157front-end work has started to make significant progress.</p>
158
Chris Lattner2c3ef982008-10-11 18:18:28 +0000[diff] [blame]159<p>Codegen progress/state
160</p>
161
162<p>
163<a href="http://clang.llvm.org/StaticAnalysis.html">static analysis tool</a>
164</p>
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000[diff] [blame]165
166</div>
167
168
169<!-- *********************************************************************** -->
170<div class="doc_section">
171 <a name="whatsnew">What's New?</a>
172</div>
173<!-- *********************************************************************** -->
174
Chris Lattner5cce7a52008-06-08 22:59:35 +0000[diff] [blame]175<div class="doc_text">
176
Chris Lattner2c3ef982008-10-11 18:18:28 +0000[diff] [blame]177<p>LLVM 2.4 includes a huge number of bug fixes, performance tweaks and minor
Chris Lattner5cce7a52008-06-08 22:59:35 +0000[diff] [blame]178improvements. Some of the major improvements and new features are listed in
179this section.
180</p>
181</div>
182
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000[diff] [blame]183<!--=========================================================================-->
Chris Lattnerf65224f2008-06-08 21:34:41 +0000[diff] [blame]184<div class="doc_subsection">
Chris Lattnere0798082008-02-06 18:00:06 +0000[diff] [blame]185<a name="majorfeatures">Major New Features</a>
186</div>
187
188<div class="doc_text">
189
Chris Lattner2c3ef982008-10-11 18:18:28 +0000[diff] [blame]190<p>LLVM 2.4 includes several major new capabilities:</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]191
192<ul>
Chris Lattner2c3ef982008-10-11 18:18:28 +0000[diff] [blame]193<li>
Chris Lattnera5a49382008-10-12 18:30:33 +0000[diff] [blame]194 <p>MRVs got generalized to FCAs. getresult is gone, ret with multiple values
195 is gone.</p>
Chris Lattner2c3ef982008-10-11 18:18:28 +0000[diff] [blame]196 </li>
197
Chris Lattner4f076402008-10-12 19:47:48 +0000[diff] [blame]198<li><p>-O0 compile times overall much faster</p></li>
Mikhail Glushenkov808cd3e2008-10-13 02:08:34 +0000[diff] [blame^]199
Chris Lattner2c3ef982008-10-11 18:18:28 +0000[diff] [blame]200<li><p>Attrs changes?</p></li>
Chris Lattnerba948522008-06-05 06:57:39 +0000[diff] [blame]201
Chris Lattnera5a49382008-10-12 18:30:33 +0000[diff] [blame]202
203<li><p>Initial PIC16 port</p></li>
204
Chris Lattner4f076402008-10-12 19:47:48 +0000[diff] [blame]205<li><p> Support the rest of the atomic __sync builtins</p></li>
Chris Lattnera5a49382008-10-12 18:30:33 +0000[diff] [blame]206
Chris Lattner2c3ef982008-10-11 18:18:28 +0000[diff] [blame]207<li><p>...</p></li>
Chris Lattnerba948522008-06-05 06:57:39 +0000[diff] [blame]208
Chris Lattner5ba16862008-02-10 08:18:42 +0000[diff] [blame]209</ul>
210
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]211</div>
212
Chris Lattnerc5a4e312008-06-05 06:25:56 +0000[diff] [blame]213
214<!--=========================================================================-->
215<div class="doc_subsection">
Chris Lattnerf65224f2008-06-08 21:34:41 +0000[diff] [blame]216<a name="llvm-gcc">llvm-gcc 4.2 Improvements</a>
Chris Lattnerc5a4e312008-06-05 06:25:56 +0000[diff] [blame]217</div>
218
219<div class="doc_text">
220
Chris Lattner2c3ef982008-10-11 18:18:28 +0000[diff] [blame]221<p>LLVM 2.4 fully supports the llvm-gcc 4.2 front-end, and includes support
Chris Lattner5cce7a52008-06-08 22:59:35 +0000[diff] [blame]222for the C, C++, Objective-C, Ada, and Fortran front-ends.</p>
Chris Lattnerc5a4e312008-06-05 06:25:56 +0000[diff] [blame]223
Chris Lattner5cce7a52008-06-08 22:59:35 +0000[diff] [blame]224<p>
225<ul>
Chris Lattner2c3ef982008-10-11 18:18:28 +0000[diff] [blame]226<li>...</li>
Chris Lattner5cce7a52008-06-08 22:59:35 +0000[diff] [blame]227
Gabor Greif0e49cc82008-06-09 06:06:18 +0000[diff] [blame]228</ul>
Chris Lattnerc5a4e312008-06-05 06:25:56 +0000[diff] [blame]229
Chris Lattnerc5a4e312008-06-05 06:25:56 +0000[diff] [blame]230</div>
231
232
Chris Lattnerb0d6c502007-09-21 03:54:09 +0000[diff] [blame]233<!--=========================================================================-->
234<div class="doc_subsection">
Chris Lattnerc3649452008-02-10 08:17:19 +0000[diff] [blame]235<a name="coreimprovements">LLVM Core Improvements</a>
236</div>
237
238<div class="doc_text">
239<p>New features include:
240</p>
241
Chris Lattnerc5a4e312008-06-05 06:25:56 +0000[diff] [blame]242<ul>
Chris Lattner548493b2008-10-12 22:57:58 +0000[diff] [blame]243<li>vector shifts in the IR: no codegen support yet</li>
Chris Lattnera5a49382008-10-12 18:30:33 +0000[diff] [blame]244<li>use diet patch landed: saved 15% IR memory footprint</li>
245<li>LLVM IR now directly represents "common" linkage, instead of
246 representing it as a form of weak linkage.</li>
Chris Lattner4f076402008-10-12 19:47:48 +0000[diff] [blame]247<li>DebugInfoBuilder</li>
Chris Lattner548493b2008-10-12 22:57:58 +0000[diff] [blame]248<li>.ll printing format change: %3 = add i32 4, 2</li>
Chris Lattner2c3ef982008-10-11 18:18:28 +0000[diff] [blame]249<li>...</li>
Chris Lattnerc3649452008-02-10 08:17:19 +0000[diff] [blame]250</ul>
Mikhail Glushenkov808cd3e2008-10-13 02:08:34 +0000[diff] [blame^]251
Chris Lattnerc3649452008-02-10 08:17:19 +0000[diff] [blame]252</div>
253
254<!--=========================================================================-->
255<div class="doc_subsection">
Chris Lattner8fda4952008-02-10 07:46:44 +0000[diff] [blame]256<a name="optimizer">Optimizer Improvements</a>
257</div>
258
259<div class="doc_text">
260
Mikhail Glushenkov808cd3e2008-10-13 02:08:34 +0000[diff] [blame^]261<p>In addition to a huge array of bug fixes and minor performance tweaks, the
Chris Lattner2c3ef982008-10-11 18:18:28 +0000[diff] [blame]262LLVM 2.4 optimizers support a few major enhancements:</p>
Chris Lattner8fda4952008-02-10 07:46:44 +0000[diff] [blame]263
264<ul>
265
Chris Lattner4f076402008-10-12 19:47:48 +0000[diff] [blame]266<li>GVN now does local PRE?</li>
267
268<li>Matthijs' Dead argument elimination rewrite</li>
269
Chris Lattnera5a49382008-10-12 18:30:33 +0000[diff] [blame]270<li>Old-ADCE used control dependence and deleted output-free infinite loops.
271Added a new Loop deletion pass (for deleting output free provably-finite loops)
272and rewrote ADCE to be simpler faster, and not need control dependence.</li>
273
274<li>SparsePropagation framework for lattice-based dataflow solvers.</li>
275
Chris Lattner548493b2008-10-12 22:57:58 +0000[diff] [blame]276<li>Tail duplication was removed from the standard optimizer sequence.</li>
Chris Lattnera5a49382008-10-12 18:30:33 +0000[diff] [blame]277
Chris Lattner4f076402008-10-12 19:47:48 +0000[diff] [blame]278<li>Various helper functions (ComputeMaskedBits, ComputeNumSignBits, etc) were
279pulled out of instcombine and put into a new ValueTracking.h file, where they
280can be reused by other passes.</li>
281
Chris Lattner548493b2008-10-12 22:57:58 +0000[diff] [blame]282<li>MarkModRef etc</li>
Chris Lattner0eef6e42008-06-08 02:45:07 +0000[diff] [blame]283</ul>
284
285</div>
286
287<!--=========================================================================-->
288<div class="doc_subsection">
289<a name="codegen">Code Generator Improvements</a>
290</div>
291
292<div class="doc_text">
293
294<p>We put a significant amount of work into the code generator infrastructure,
295which allows us to implement more aggressive algorithms and make it run
296faster:</p>
297
298<ul>
Chris Lattner548493b2008-10-12 22:57:58 +0000[diff] [blame]299<li>asm writers split out to their own library to avoid JITs having to link
300 them in.</li>
301<li>Big asm writer refactoring + TargetAsmInfo</li>
302<li>2-addr pass and coalescer can now remat trivial insts to avoid a copy.</li>
Chris Lattner4f076402008-10-12 19:47:48 +0000[diff] [blame]303<li>spiller to commute instructions in order to fold a reload</li>
304<li>Stack slot coloring?</li>
305<li>Live intervals renumbering? Is this useful to external people?</li>
306<li>'is as cheap as a move' instruction flag</li>
307<li>Improvements to selection dag viewing</li>
308<li>fast isel</li>
Chris Lattner2c3ef982008-10-11 18:18:28 +0000[diff] [blame]309<li>Selection dag speedups</li>
Chris Lattner4f076402008-10-12 19:47:48 +0000[diff] [blame]310<li>asmwriter + raw_ostream -> fastah</li>
Chris Lattner2c3ef982008-10-11 18:18:28 +0000[diff] [blame]311<li>...</li>
Chris Lattner0eef6e42008-06-08 02:45:07 +0000[diff] [blame]312
Chris Lattnerb0d6c502007-09-21 03:54:09 +0000[diff] [blame]313</ul>
314
315</div>
316
317
318<!--=========================================================================-->
319<div class="doc_subsection">
Chris Lattnere45f18b2008-06-05 08:02:49 +0000[diff] [blame]320<a name="x86specific">X86/X86-64 Specific Improvements</a>
Chris Lattnerb0d6c502007-09-21 03:54:09 +0000[diff] [blame]321</div>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]322
323<div class="doc_text">
Chris Lattnerc3649452008-02-10 08:17:19 +0000[diff] [blame]324<p>New target-specific features include:
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]325</p>
326
327<ul>
Chris Lattner4f076402008-10-12 19:47:48 +0000[diff] [blame]328<li>Exception handling is supported by default on Linux/x86-64.</li>
329<li>Position Independent Code (PIC) is now support on Linux/x86-64.</li>
Chris Lattner2c3ef982008-10-11 18:18:28 +0000[diff] [blame]330<li>...</li>
Chris Lattnerd95b5962008-06-08 21:19:07 +0000[diff] [blame]331
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]332</ul>
Mikhail Glushenkov808cd3e2008-10-13 02:08:34 +0000[diff] [blame^]333
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]334</div>
335
Chris Lattnerb0d6c502007-09-21 03:54:09 +0000[diff] [blame]336<!--=========================================================================-->
337<div class="doc_subsection">
Chris Lattnere45f18b2008-06-05 08:02:49 +0000[diff] [blame]338<a name="targetspecific">Other Target Specific Improvements</a>
339</div>
340
341<div class="doc_text">
342<p>New target-specific features include:
343</p>
344
345<ul>
Chris Lattner548493b2008-10-12 22:57:58 +0000[diff] [blame]346<li>MIPS floating point support?</li>
Chris Lattner2c3ef982008-10-11 18:18:28 +0000[diff] [blame]347<li>....</li>
Chris Lattnere45f18b2008-06-05 08:02:49 +0000[diff] [blame]348</ul>
Chris Lattnere45f18b2008-06-05 08:02:49 +0000[diff] [blame]349
Mikhail Glushenkov808cd3e2008-10-13 02:08:34 +0000[diff] [blame^]350</div>
Chris Lattnere45f18b2008-06-05 08:02:49 +0000[diff] [blame]351
352
353<!--=========================================================================-->
354<div class="doc_subsection">
Chris Lattnerb0d6c502007-09-21 03:54:09 +0000[diff] [blame]355<a name="otherimprovements">Other Improvements</a>
356</div>
357
358<div class="doc_text">
359<p>New features include:
360</p>
361
362<ul>
Mikhail Glushenkov808cd3e2008-10-13 02:08:34 +0000[diff] [blame^]363<li><tt>llvmc2</tt>(the generic compiler driver) gained plugin
364 support. It is now easier to experiment with <tt>llvmc2</tt> and
365 build your own tools based on it. </li>
Chris Lattner4f076402008-10-12 19:47:48 +0000[diff] [blame]366<li>raw_ostream + formatting</li>
Chris Lattner548493b2008-10-12 22:57:58 +0000[diff] [blame]367<li>Recycler + pool allocation stuff?</li>
Chris Lattner2c3ef982008-10-11 18:18:28 +0000[diff] [blame]368<li>...</li>
Chris Lattnerb0d6c502007-09-21 03:54:09 +0000[diff] [blame]369</ul>
Mikhail Glushenkov808cd3e2008-10-13 02:08:34 +0000[diff] [blame^]370
Chris Lattnerb0d6c502007-09-21 03:54:09 +0000[diff] [blame]371</div>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]372
373<!-- *********************************************************************** -->
374<div class="doc_section">
375 <a name="portability">Portability and Supported Platforms</a>
376</div>
377<!-- *********************************************************************** -->
378
379<div class="doc_text">
380
381<p>LLVM is known to work on the following platforms:</p>
382
383<ul>
Mikhail Glushenkov808cd3e2008-10-13 02:08:34 +0000[diff] [blame^]384<li>Intel and AMD machines (IA32) running Red Hat Linux, Fedora Core and FreeBSD
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]385 (and probably other unix-like systems).</li>
Chris Lattnerbd633de92008-02-06 06:30:34 +0000[diff] [blame]386<li>PowerPC and X86-based Mac OS X systems, running 10.3 and above in 32-bit and
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]387 64-bit modes.</li>
Chris Lattnere0798082008-02-06 18:00:06 +0000[diff] [blame]388<li>Intel and AMD machines running on Win32 using MinGW libraries (native).</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]389<li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
390 support is available for native builds with Visual C++).</li>
Gabor Greif5e75e652008-06-05 18:39:01 +0000[diff] [blame]391<li>Sun UltraSPARC workstations running Solaris 10.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]392<li>Alpha-based machines running Debian GNU/Linux.</li>
Gabor Greif5e75e652008-06-05 18:39:01 +0000[diff] [blame]393<li>Itanium-based (IA64) machines running Linux and HP-UX.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]394</ul>
395
Chris Lattnerba948522008-06-05 06:57:39 +0000[diff] [blame]396<p>The core LLVM infrastructure uses GNU autoconf to adapt itself
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]397to the machine and operating system on which it is built. However, minor
398porting may be required to get LLVM to work on new platforms. We welcome your
399portability patches and reports of successful builds or error messages.</p>
400
401</div>
402
403<!-- *********************************************************************** -->
404<div class="doc_section">
405 <a name="knownproblems">Known Problems</a>
406</div>
407<!-- *********************************************************************** -->
408
409<div class="doc_text">
410
411<p>This section contains all known problems with the LLVM system, listed by
412component. As new problems are discovered, they will be added to these
413sections. If you run into a problem, please check the <a
414href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
415there isn't already one.</p>
416
417</div>
418
419<!-- ======================================================================= -->
420<div class="doc_subsection">
421 <a name="experimental">Experimental features included with this release</a>
422</div>
423
424<div class="doc_text">
425
426<p>The following components of this LLVM release are either untested, known to
427be broken or unreliable, or are in early development. These components should
428not be relied on, and bugs should not be filed against them, but they may be
429useful 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]430components, please contact us on the <a
431href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]432
433<ul>
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000[diff] [blame]434<li>The MSIL, IA64, Alpha, SPU, and MIPS backends are experimental.</li>
Duncan Sandsa73561c2008-06-08 20:18:35 +0000[diff] [blame]435<li>The llc "<tt>-filetype=asm</tt>" (the default) is the only supported
Chris Lattnerbd633de92008-02-06 06:30:34 +0000[diff] [blame]436 value for this option.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]437</ul>
438
439</div>
440
441<!-- ======================================================================= -->
442<div class="doc_subsection">
443 <a name="x86-be">Known problems with the X86 back-end</a>
444</div>
445
446<div class="doc_text">
447
448<ul>
Anton Korobeynikov77d15e22008-06-08 10:24:13 +0000[diff] [blame]449 <li>The X86 backend does not yet support
450 all <a href="http://llvm.org/PR879">inline assembly that uses the X86
451 floating point stack</a>. It supports the 'f' and 't' constraints, but not
452 'u'.</li>
Chris Lattnerd95b5962008-06-08 21:19:07 +0000[diff] [blame]453 <li>The X86 backend generates inefficient floating point code when configured
454 to generate code for systems that don't have SSE2.</li>
Duncan Sands8b4f3772008-06-08 19:38:43 +0000[diff] [blame]455 <li>Win64 code generation wasn't widely tested. Everything should work, but we
Anton Korobeynikov77d15e22008-06-08 10:24:13 +0000[diff] [blame]456 expect small issues to happen. Also, llvm-gcc cannot build mingw64 runtime
457 currently due
458 to <a href="http://llvm.org/PR2255">several</a>
Chris Lattnerf06141a2008-06-08 23:12:47 +0000[diff] [blame]459 <a href="http://llvm.org/PR2257">bugs</a> due to lack of support for the
460 'u' inline assembly constraint and X87 floating point inline assembly.</li>
Dan Gohman3882ecb2008-06-08 23:05:11 +0000[diff] [blame]461 <li>The X86-64 backend does not yet support the LLVM IR instruction
462 <tt>va_arg</tt>. Currently, the llvm-gcc front-end supports variadic
463 argument constructs on X86-64 by lowering them manually.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]464</ul>
465
466</div>
467
468<!-- ======================================================================= -->
469<div class="doc_subsection">
470 <a name="ppc-be">Known problems with the PowerPC back-end</a>
471</div>
472
473<div class="doc_text">
474
475<ul>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]476<li>The Linux PPC32/ABI support needs testing for the interpreter and static
477compilation, and lacks support for debug information.</li>
478</ul>
479
480</div>
481
482<!-- ======================================================================= -->
483<div class="doc_subsection">
484 <a name="arm-be">Known problems with the ARM back-end</a>
485</div>
486
487<div class="doc_text">
488
489<ul>
490<li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
Duncan Sands1827fa62007-09-26 15:59:54 +0000[diff] [blame]491processors, thumb programs can crash or produce wrong
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]492results (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
493<li>Compilation for ARM Linux OABI (old ABI) is supported, but not fully tested.
494</li>
Chris Lattnerd95b5962008-06-08 21:19:07 +0000[diff] [blame]495<li>There is a bug in QEMU-ARM (&lt;= 0.9.0) which causes it to incorrectly
496 execute
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]497programs compiled with LLVM. Please use more recent versions of QEMU.</li>
498</ul>
499
500</div>
501
502<!-- ======================================================================= -->
503<div class="doc_subsection">
504 <a name="sparc-be">Known problems with the SPARC back-end</a>
505</div>
506
507<div class="doc_text">
508
509<ul>
510<li>The SPARC backend only supports the 32-bit SPARC ABI (-m32), it does not
511 support the 64-bit SPARC ABI (-m64).</li>
512</ul>
513
514</div>
515
516<!-- ======================================================================= -->
517<div class="doc_subsection">
518 <a name="alpha-be">Known problems with the Alpha back-end</a>
519</div>
520
521<div class="doc_text">
522
523<ul>
524
525<li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
526appropriate nops inserted to ensure restartability.</li>
527
528</ul>
529</div>
530
531<!-- ======================================================================= -->
532<div class="doc_subsection">
533 <a name="ia64-be">Known problems with the IA64 back-end</a>
534</div>
535
536<div class="doc_text">
537
538<ul>
Chris Lattnerf06141a2008-06-08 23:12:47 +0000[diff] [blame]539<li>The Itanium backend is highly experimental, and has a number of known
540 issues. We are looking for a maintainer for the Itanium backend. If you
541 are interested, please contact the llvmdev mailing list.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]542</ul>
543
544</div>
545
546<!-- ======================================================================= -->
547<div class="doc_subsection">
548 <a name="c-be">Known problems with the C back-end</a>
549</div>
550
551<div class="doc_text">
552
553<ul>
Chris Lattner499c07c2008-06-05 06:35:40 +0000[diff] [blame]554<li><a href="http://llvm.org/PR802">The C backend has only basic support for
555 inline assembly code</a>.</li>
Chris Lattnere0194462007-09-26 06:01:35 +0000[diff] [blame]556<li><a href="http://llvm.org/PR1658">The C backend violates the ABI of common
557 C++ programs</a>, preventing intermixing between C++ compiled by the CBE and
Duncan Sandsa73561c2008-06-08 20:18:35 +0000[diff] [blame]558 C++ code compiled with llc or native compilers.</li>
Duncan Sandsbd0ad6e2008-02-10 13:40:55 +0000[diff] [blame]559<li>The C backend does not support all exception handling constructs.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]560</ul>
561
562</div>
563
564
565<!-- ======================================================================= -->
566<div class="doc_subsection">
Chris Lattner499c07c2008-06-05 06:35:40 +0000[diff] [blame]567 <a name="c-fe">Known problems with the llvm-gcc C front-end</a>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]568</div>
569
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]570<div class="doc_text">
571
Chris Lattnere0798082008-02-06 18:00:06 +0000[diff] [blame]572<p>llvm-gcc does not currently support <a href="http://llvm.org/PR869">Link-Time
573Optimization</a> on most platforms "out-of-the-box". Please inquire on the
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]574llvmdev mailing list if you are interested.</p>
575
Chris Lattner499c07c2008-06-05 06:35:40 +0000[diff] [blame]576<p>The only major language feature of GCC not supported by llvm-gcc is
577 the <tt>__builtin_apply</tt> family of builtins. However, some extensions
578 are only supported on some targets. For example, trampolines are only
Duncan Sandsa73561c2008-06-08 20:18:35 +0000[diff] [blame]579 supported on some targets (these are used when you take the address of a
580 nested function).</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]581
Chris Lattner499c07c2008-06-05 06:35:40 +0000[diff] [blame]582<p>If you run into GCC extensions which are not supported, please let us know.
583</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]584
585</div>
586
587<!-- ======================================================================= -->
588<div class="doc_subsection">
Chris Lattner499c07c2008-06-05 06:35:40 +0000[diff] [blame]589 <a name="c++-fe">Known problems with the llvm-gcc C++ front-end</a>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]590</div>
591
592<div class="doc_text">
593
594<p>The C++ front-end is considered to be fully
595tested and works for a number of non-trivial programs, including LLVM
596itself, Qt, Mozilla, etc.</p>
597
598<ul>
Anton Korobeynikovd9a17932008-10-11 18:27:16 +0000[diff] [blame]599<li>Exception handling works well on the X86 and PowerPC targets. Currently
600 only linux and darwin targets are supported (both 32 and 64 bit).</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]601</ul>
602
603</div>
604
605
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000[diff] [blame]606<!-- ======================================================================= -->
607<div class="doc_subsection">
Chris Lattner499c07c2008-06-05 06:35:40 +0000[diff] [blame]608 <a name="ada-fe">Known problems with the llvm-gcc Ada front-end</a>
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000[diff] [blame]609</div>
610
611<div class="doc_text">
612The llvm-gcc 4.2 Ada compiler works fairly well, however this is not a mature
613technology and problems should be expected.
614<ul>
Duncan Sandsa73561c2008-06-08 20:18:35 +0000[diff] [blame]615<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]616to lack of trampoline support (pointers to nested functions) on other platforms,
Duncan Sandsa73561c2008-06-08 20:18:35 +0000[diff] [blame]617however 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]618which does support trampolines.</li>
619<li>The Ada front-end <a href="http://llvm.org/PR2007">fails to bootstrap</a>.
620Workaround: configure with --disable-bootstrap.</li>
621<li>The c380004 and <a href="http://llvm.org/PR2010">c393010</a> ACATS tests
Duncan Sandsa73561c2008-06-08 20:18:35 +0000[diff] [blame]622fail (c380004 also fails with gcc-4.2 mainline). When built at -O3, the
623<a href="http://llvm.org/PR2421">cxg2021</a> ACATS test also fails.</li>
624<li>Some gcc specific Ada tests continue to crash the compiler. The testsuite
625reports most tests as having failed even though they pass.</li>
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000[diff] [blame]626<li>The -E binder option (exception backtraces)
627<a href="http://llvm.org/PR1982">does not work</a> and will result in programs
628crashing if an exception is raised. Workaround: do not use -E.</li>
629<li>Only discrete types <a href="http://llvm.org/PR1981">are allowed to start
630or finish at a non-byte offset</a> in a record. Workaround: do not pack records
631or use representation clauses that result in a field of a non-discrete type
632starting or finishing in the middle of a byte.</li>
Chris Lattnerd95b5962008-06-08 21:19:07 +0000[diff] [blame]633<li>The <tt>lli</tt> interpreter <a href="http://llvm.org/PR2009">considers
634'main' as generated by the Ada binder to be invalid</a>.
635Workaround: hand edit the file to use pointers for <tt>argv</tt> and
636<tt>envp</tt> rather than integers.</li>
637<li>The <tt>-fstack-check</tt> option <a href="http://llvm.org/PR2008">is
638ignored</a>.</li>
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000[diff] [blame]639</ul>
640</div>
641
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]642<!-- *********************************************************************** -->
643<div class="doc_section">
644 <a name="additionalinfo">Additional Information</a>
645</div>
646<!-- *********************************************************************** -->
647
648<div class="doc_text">
649
650<p>A wide variety of additional information is available on the <a
651href="http://llvm.org">LLVM web page</a>, in particular in the <a
652href="http://llvm.org/docs/">documentation</a> section. The web page also
653contains versions of the API documentation which is up-to-date with the
654Subversion version of the source code.
655You can access versions of these documents specific to this release by going
656into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
657
658<p>If you have any questions or comments about LLVM, please feel free to contact
659us via the <a href="http://llvm.org/docs/#maillist"> mailing
660lists</a>.</p>
661
662</div>
663
664<!-- *********************************************************************** -->
665
666<hr>
667<address>
668 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
669 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
670 <a href="http://validator.w3.org/check/referer"><img
Chris Lattner5ba16862008-02-10 08:18:42 +0000[diff] [blame]671 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]672
673 <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
674 Last modified: $Date$
675</address>
676
677</body>
678</html>