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