blob: e1c62c9475010ef53ec32900d7c129408f7d70f7 [file] [log] [blame]
Misha Brukman500bc302003-11-22 00:38:41 +00001<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
3<html>
4<head>
Reid Spencer6454ed32004-11-18 18:38:58 +00005 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
Misha Brukman500bc302003-11-22 00:38:41 +00006 <link rel="stylesheet" href="llvm.css" type="text/css">
Chris Lattner38ab04c2009-02-25 04:41:31 +00007 <title>LLVM 2.5 Release Notes</title>
Misha Brukman500bc302003-11-22 00:38:41 +00008</head>
9<body>
Chris Lattner79c3fe12003-10-02 04:57:28 +000010
Chris Lattner38ab04c2009-02-25 04:41:31 +000011<div class="doc_title">LLVM 2.5 Release Notes</div>
Mikhail Glushenkovea65d7d2008-10-13 02:08:34 +000012
Chris Lattner79c3fe12003-10-02 04:57:28 +000013<ol>
Misha Brukman500bc302003-11-22 00:38:41 +000014 <li><a href="#intro">Introduction</a></li>
Chris Lattner96a445e2008-10-13 18:01:01 +000015 <li><a href="#subproj">Sub-project Status Update</a></li>
16 <li><a href="#whatsnew">What's New in LLVM?</a></li>
Chris Lattner4b538b92004-04-30 22:17:12 +000017 <li><a href="GettingStarted.html">Installation Instructions</a></li>
Misha Brukman500bc302003-11-22 00:38:41 +000018 <li><a href="#portability">Portability and Supported Platforms</a></li>
Dan Gohman44aa9212008-10-14 16:23:02 +000019 <li><a href="#knownproblems">Known Problems</a></li>
Misha Brukman500bc302003-11-22 00:38:41 +000020 <li><a href="#additionalinfo">Additional Information</a></li>
Chris Lattner79c3fe12003-10-02 04:57:28 +000021</ol>
22
Chris Lattner7911ce22004-05-23 21:07:27 +000023<div class="doc_author">
Dan Gohman44aa9212008-10-14 16:23:02 +000024 <p>Written by the <a href="http://llvm.org">LLVM Team</a></p>
Misha Brukman500bc302003-11-22 00:38:41 +000025</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +000026
27<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +000028<div class="doc_section">
29 <a name="intro">Introduction</a>
30</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +000031<!-- *********************************************************************** -->
32
Misha Brukman500bc302003-11-22 00:38:41 +000033<div class="doc_text">
34
Chris Lattnerf6662f92008-10-13 17:57:36 +000035<p>This document contains the release notes for the LLVM Compiler
Chris Lattner38ab04c2009-02-25 04:41:31 +000036Infrastructure, release 2.5. Here we describe the status of LLVM, including
Chris Lattnerf6662f92008-10-13 17:57:36 +000037major 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>
Chris Lattner19092612003-10-02 16:38:05 +000040
Chris Lattner7506b1d2004-12-07 08:04:13 +000041<p>For more information about LLVM, including information about the latest
Chris Lattnerc463b272005-10-29 07:07:09 +000042release, please check out the <a href="http://llvm.org/">main LLVM
Chris Lattner47ad72c2003-10-07 21:38:31 +000043web site</a>. If you have questions or comments, the <a
Chris Lattnerf6662f92008-10-13 17:57:36 +000044href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM Developer's Mailing
45List</a> is a good place to send them.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +000046
Mikhail Glushenkovea65d7d2008-10-13 02:08:34 +000047<p>Note that if you are reading this file from a Subversion checkout or the
Chris Lattner84977642007-09-21 03:54:09 +000048main LLVM web page, this document applies to the <i>next</i> release, not the
Gabor Greiffa933f82008-10-14 11:00:32 +000049current one. To see the release notes for a specific release, please see the
Chris Lattner84977642007-09-21 03:54:09 +000050<a href="http://llvm.org/releases/">releases page</a>.</p>
Misha Brukman500bc302003-11-22 00:38:41 +000051
52</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +000053
Chris Lattner38ab04c2009-02-25 04:41:31 +000054<!-- Unfinished features in 2.5:
Chris Lattneracce85d2008-02-10 07:46:44 +000055 Machine LICM
56 Machine Sinking
Chris Lattner74c80df2009-02-25 06:34:50 +000057 target-specific intrinsics
58 gold lto plugin
Chris Lattner99f375b2009-02-25 07:32:53 +000059 pre-alloc splitter, strong phi elim
Chris Lattner547a3912008-10-12 19:47:48 +000060 llc -enable-value-prop, propagation of value info (sign/zero ext info) from
61 one MBB to another
Chris Lattner74c80df2009-02-25 06:34:50 +000062 debug info for optimized code
Chris Lattner99f375b2009-02-25 07:32:53 +000063
Chris Lattneracce85d2008-02-10 07:46:44 +000064 -->
Mikhail Glushenkovea65d7d2008-10-13 02:08:34 +000065
Chris Lattner547a3912008-10-12 19:47:48 +000066 <!-- for announcement email:
Chris Lattner74c80df2009-02-25 06:34:50 +000067 -->
Chris Lattneracce85d2008-02-10 07:46:44 +000068
Chris Lattner96a445e2008-10-13 18:01:01 +000069<!-- *********************************************************************** -->
70<div class="doc_section">
71 <a name="subproj">Sub-project Status Update</a>
Chris Lattnerea34f642008-06-08 21:34:41 +000072</div>
Chris Lattner96a445e2008-10-13 18:01:01 +000073<!-- *********************************************************************** -->
Chris Lattnerea34f642008-06-08 21:34:41 +000074
75<div class="doc_text">
Chris Lattner8348b472008-06-08 21:58:17 +000076<p>
Chris Lattner38ab04c2009-02-25 04:41:31 +000077The LLVM 2.5 distribution currently consists of code from the core LLVM
Chris Lattnerfb97b2d2008-10-13 18:11:54 +000078repository (which roughly includes the LLVM optimizers, code generators and
Chris Lattner8348b472008-06-08 21:58:17 +000079supporting tools) and the llvm-gcc repository. In addition to this code, the
80LLVM Project includes other sub-projects that are in development. The two which
Chris Lattner857fb132008-10-11 18:18:28 +000081are the most actively developed are the <a href="#clang">Clang Project</a> and
Nicolas Geoffray99a4d302008-10-14 19:23:04 +000082the <a href="#vmkit">VMKit Project</a>.
Chris Lattner8348b472008-06-08 21:58:17 +000083</p>
Chris Lattner96a445e2008-10-13 18:01:01 +000084
Chris Lattner8348b472008-06-08 21:58:17 +000085</div>
86
Chris Lattner96a445e2008-10-13 18:01:01 +000087
Chris Lattner8348b472008-06-08 21:58:17 +000088<!--=========================================================================-->
Chris Lattner96a445e2008-10-13 18:01:01 +000089<div class="doc_subsection">
Chris Lattnerfb97b2d2008-10-13 18:11:54 +000090<a name="clang">Clang: C/C++/Objective-C Frontend Toolkit</a>
Chris Lattner8348b472008-06-08 21:58:17 +000091</div>
92
93<div class="doc_text">
94
95<p>The <a href="http://clang.llvm.org/">Clang project</a> is an effort to build
96a set of new 'LLVM native' front-end technologies for the LLVM optimizer
Chris Lattnerf40c40b2009-02-25 05:09:54 +000097and code generator. While Clang is not included in the LLVM 2.5 release, it
98is continuing to make major strides forward in all areas. Its C and Objective-C
99parsing and code generation support is now very solid. For example, it is
100capable of successfully building many real applications for X86-32 and X86-64,
101including the FreeBSD kernel. C++ is also making <a
102href="http://clang.llvm.org/cxx_status.html">incredible progress</a>, and work
103on templates has recently started.</p>
Chris Lattner8348b472008-06-08 21:58:17 +0000104
Chris Lattnerf40c40b2009-02-25 05:09:54 +0000105<p>While Clang is not yet production quality, it is progressing very nicely and
106is quite usable for building many C and Objective-C applications. If you are
107interested in fast compiles and good diagnostics, we encourage you to try it out
Chris Lattner74c80df2009-02-25 06:34:50 +0000108by <a href="http://clang.llvm.org/get_started.html">building from mainline</a>
Chris Lattnerf40c40b2009-02-25 05:09:54 +0000109and reporting any issues you hit to the <a
110href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-dev">Clang front-end mailing
111list</a>.</p>
112
113<p>In the LLVM 2.5 time-frame, the Clang team has made many improvements:</p>
Bill Wendling741748a2008-10-27 09:27:33 +0000114
Daniel Dunbar13739432008-10-14 23:25:09 +0000115<ul>
Chris Lattnerf40c40b2009-02-25 05:09:54 +0000116<li>Clang now has a new driver, which is focused on providing a GCC-compatible
117 interface.</li>
118<li>The X86-64 ABI is now supported.</li>
119<li>Precompiled header support is now implemented.</li>
120<li>Objective-C support is significantly improved beyond LLVM 2.4, supporting
121 many features, such as Objective-C Garbage Collection.</li>
122<li>Many many bugs are fixed.</li>
Chris Lattnerfb97b2d2008-10-13 18:11:54 +0000123</div>
124
125<!--=========================================================================-->
126<div class="doc_subsection">
127<a name="clangsa">Clang Static Analyzer</a>
128</div>
129
130<div class="doc_text">
131
Ted Kremenek3c3ec0c2008-10-14 05:14:21 +0000132<p>The Clang project also includes an early stage static source code analysis
133tool for <a href="http://clang.llvm.org/StaticAnalysis.html">automatically
134finding bugs</a> in C and Objective-C programs. The tool performs a growing set
Chris Lattnerc702d162008-10-14 06:02:29 +0000135of checks to find bugs that occur on a specific path within a program. Examples
Ted Kremenek3c3ec0c2008-10-14 05:14:21 +0000136of bugs the tool finds include logic errors such as null dereferences,
137violations of various API rules, dead code, and potential memory leaks in
Chris Lattnerc702d162008-10-14 06:02:29 +0000138Objective-C programs. Since its inception, public feedback on the tool has been
139extremely positive, and conservative estimates put the number of real bugs it
140has found in industrial-quality software on the order of thousands.</p>
Chris Lattnercc042612008-10-14 00:52:49 +0000141
Ted Kremenek3c3ec0c2008-10-14 05:14:21 +0000142<p>The tool also provides a simple web GUI to inspect potential bugs found by
Chris Lattnerc702d162008-10-14 06:02:29 +0000143the tool. While still early in development, the GUI illustrates some of the key
Ted Kremenek3c3ec0c2008-10-14 05:14:21 +0000144features of Clang: accurate source location information, which is used by the
145GUI to highlight specific code expressions that relate to a bug (including those
Bill Wendling741748a2008-10-27 09:27:33 +0000146that span multiple lines); and built-in knowledge of macros, which is used to
Ted Kremenek3c3ec0c2008-10-14 05:14:21 +0000147perform inline expansion of macros within the GUI itself.</p>
148
Chris Lattnerc702d162008-10-14 06:02:29 +0000149<p>The set of checks performed by the static analyzer is gradually expanding,
Bill Wendling741748a2008-10-27 09:27:33 +0000150and future plans for the tool include full source-level inter-procedural
151analysis and deeper checks such as buffer overrun detection. There are many
152opportunities to extend and enhance the static analyzer, and anyone interested
153in working on this project is encouraged to get involved!</p>
Chris Lattner8348b472008-06-08 21:58:17 +0000154
155</div>
156
Chris Lattner96a445e2008-10-13 18:01:01 +0000157<!--=========================================================================-->
158<div class="doc_subsection">
Nicolas Geoffray99a4d302008-10-14 19:23:04 +0000159<a name="vmkit">VMKit: JVM/CLI Virtual Machine Implementation</a>
Chris Lattner96a445e2008-10-13 18:01:01 +0000160</div>
161
162<div class="doc_text">
163<p>
Nicolas Geoffray99a4d302008-10-14 19:23:04 +0000164The <a href="http://vmkit.llvm.org/">VMKit project</a> is an implementation of
Chris Lattner96a445e2008-10-13 18:01:01 +0000165a JVM and a CLI Virtual Machines (Microsoft .NET is an
166implementation of the CLI) using the Just-In-Time compiler of LLVM.</p>
167
Chris Lattner1f859862009-02-25 05:45:05 +0000168<p>Following LLVM 2.5, VMKit has its first release ? that you can find on its
Nicolas Geoffray56d313d2008-10-15 20:25:04 +0000169<a href="http://vmkit.llvm.org/releases/">webpage</a>. The release includes
170bug fixes, cleanup and new features. The major changes are:</p>
Chris Lattner96a445e2008-10-13 18:01:01 +0000171
Nicolas Geoffray99a4d302008-10-14 19:23:04 +0000172<ul>
173
Chris Lattner38ab04c2009-02-25 04:41:31 +0000174<li>?</li>
Nicolas Geoffray99a4d302008-10-14 19:23:04 +0000175
176</ul>
Chris Lattner96a445e2008-10-13 18:01:01 +0000177</div>
178
Chris Lattner8348b472008-06-08 21:58:17 +0000179
180<!-- *********************************************************************** -->
181<div class="doc_section">
Chris Lattner96a445e2008-10-13 18:01:01 +0000182 <a name="whatsnew">What's New in LLVM?</a>
Chris Lattner8348b472008-06-08 21:58:17 +0000183</div>
184<!-- *********************************************************************** -->
185
Chris Lattnerf8e0b4e2008-06-08 22:59:35 +0000186<div class="doc_text">
187
Bill Wendling741748a2008-10-27 09:27:33 +0000188<p>This release includes a huge number of bug fixes, performance tweaks, and
Chris Lattnerf6662f92008-10-13 17:57:36 +0000189minor improvements. Some of the major improvements and new features are listed
190in this section.
Chris Lattnerf8e0b4e2008-06-08 22:59:35 +0000191</p>
192</div>
193
Chris Lattner8348b472008-06-08 21:58:17 +0000194<!--=========================================================================-->
Chris Lattnerea34f642008-06-08 21:34:41 +0000195<div class="doc_subsection">
Chris Lattner252b83d2008-02-06 18:00:06 +0000196<a name="majorfeatures">Major New Features</a>
197</div>
198
199<div class="doc_text">
200
Chris Lattner38ab04c2009-02-25 04:41:31 +0000201<p>LLVM 2.5 includes several major new capabilities:</p>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000202
203<ul>
Duncan Sands8524cb92009-02-25 11:37:39 +0000204<li><p>The code generator now supports arbitrary precision integers.
205Types like <tt>i33</tt> have long been valid in the LLVM IR, but previously
206could only be used with the interpreter.
207Now IR using such types can be compiled to native code on all targets.
208All operations are supported if the integer is not bigger than twice the
209target machine word size.
210Simple operations like loads, stores and shifts by a constant amount are
211supported for integers of any size.
212</p></li>
Chris Lattner74c80df2009-02-25 06:34:50 +0000213
214<!--
215Random stuff:
216
Chris Lattner99f375b2009-02-25 07:32:53 +0000217xcore backend!
218fortran on darwin!
219
Chris Lattner74c80df2009-02-25 06:34:50 +0000220.ll parser rewrite.
221GCC inliner off.
222cmake mature?
223x86 backend FS/GS segment address spaces?
224nocapture
225memdep is faster / more aggressive.
Chris Lattner99f375b2009-02-25 07:32:53 +0000226how to write a backend doc docs/WritingAnLLVMBackend.html
Chris Lattner74c80df2009-02-25 06:34:50 +0000227fastisel + exception handling
228vector widening <3 x float> -> <4 x float>
Chris Lattner99f375b2009-02-25 07:32:53 +0000229arm port improvements? arm jit encoding stuff, constant island support?
230JIT TLS support on x86
231mem2reg now faster on code with huge basic blocks
232stack protectors/stack canaries, -fstack-protector, controllable on a
233 per-function basis with attributes.
234shufflevector is generalized to allow different shuffle mask width than its
235 input vectors.
236loop optimizer improves floating point induction variables
237llvm/Analysis/DebugInfo.h classes, llvm-gcc and clang and codegen use them.
238asmprinters seperate from targets for jits
Chris Lattner74c80df2009-02-25 06:34:50 +0000239-->
Chris Lattnerbc5786b2008-06-05 06:57:39 +0000240
Chris Lattner8170c102008-02-10 08:18:42 +0000241</ul>
242
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000243</div>
244
Chris Lattner791f77b2008-06-05 06:25:56 +0000245
246<!--=========================================================================-->
247<div class="doc_subsection">
Chris Lattnerea34f642008-06-08 21:34:41 +0000248<a name="llvm-gcc">llvm-gcc 4.2 Improvements</a>
Chris Lattner791f77b2008-06-05 06:25:56 +0000249</div>
250
251<div class="doc_text">
252
Chris Lattnerb82eb062008-10-13 20:47:20 +0000253<p>LLVM fully supports the llvm-gcc 4.2 front-end, which marries the GCC
254front-ends and driver with the LLVM optimizer and code generator. It currently
255includes support for the C, C++, Objective-C, Ada, and Fortran front-ends.</p>
Chris Lattner791f77b2008-06-05 06:25:56 +0000256
Chris Lattnerf8e0b4e2008-06-08 22:59:35 +0000257<ul>
Chris Lattner38ab04c2009-02-25 04:41:31 +0000258<li>?</li>
Gabor Greifa3bd11d2008-06-09 06:06:18 +0000259</ul>
Chris Lattner791f77b2008-06-05 06:25:56 +0000260
Chris Lattner791f77b2008-06-05 06:25:56 +0000261</div>
262
263
Chris Lattner84977642007-09-21 03:54:09 +0000264<!--=========================================================================-->
265<div class="doc_subsection">
Chris Lattnerf304ffc2008-02-10 08:17:19 +0000266<a name="coreimprovements">LLVM Core Improvements</a>
267</div>
268
269<div class="doc_text">
Bill Wendling741748a2008-10-27 09:27:33 +0000270<p>New features include:</p>
Chris Lattnerf304ffc2008-02-10 08:17:19 +0000271
Chris Lattner791f77b2008-06-05 06:25:56 +0000272<ul>
Chris Lattner38ab04c2009-02-25 04:41:31 +0000273<li>?</li>
Chris Lattner7752d1a2008-10-13 20:59:32 +0000274
Chris Lattnerf304ffc2008-02-10 08:17:19 +0000275</ul>
Mikhail Glushenkovea65d7d2008-10-13 02:08:34 +0000276
Chris Lattnerf304ffc2008-02-10 08:17:19 +0000277</div>
278
279<!--=========================================================================-->
280<div class="doc_subsection">
Chris Lattneracce85d2008-02-10 07:46:44 +0000281<a name="optimizer">Optimizer Improvements</a>
282</div>
283
284<div class="doc_text">
285
Chris Lattnerf3013872008-10-13 21:50:36 +0000286<p>In addition to a huge array of bug fixes and minor performance tweaks, this
287release includes a few major enhancements and additions to the optimizers:</p>
Chris Lattneracce85d2008-02-10 07:46:44 +0000288
289<ul>
290
Chris Lattner38ab04c2009-02-25 04:41:31 +0000291<li>?</li>
Chris Lattnerf3013872008-10-13 21:50:36 +0000292
Chris Lattner0b832202008-06-08 02:45:07 +0000293</ul>
294
295</div>
296
297<!--=========================================================================-->
298<div class="doc_subsection">
299<a name="codegen">Code Generator Improvements</a>
300</div>
301
302<div class="doc_text">
303
Gabor Greifa8b84902008-10-14 11:31:14 +0000304<p>We have put a significant amount of work into the code generator infrastructure,
Chris Lattner0b832202008-06-08 02:45:07 +0000305which allows us to implement more aggressive algorithms and make it run
306faster:</p>
307
308<ul>
Duncan Sands07636ea2009-02-25 11:50:08 +0000309<li>The type legalization logic has been completely rewritten, and is now
310more powerful (it supports arbitrary precision integer types for example)
311and hopefully more correct.
312The type legalizer converts operations on types that are not natively
313supported by the target machine into equivalent code sequences that only use
314natively supported types.
315The old type legalizer is still available and will be used if
316<tt>-disable-legalize-types</tt> is passed to <tt>llc</tt>.
317</li>
Chris Lattner38ab04c2009-02-25 04:41:31 +0000318<li>?</li>
Chris Lattner0b832202008-06-08 02:45:07 +0000319
Chris Lattner84977642007-09-21 03:54:09 +0000320</ul>
321
322</div>
323
324
325<!--=========================================================================-->
326<div class="doc_subsection">
Chris Lattnereeb4da02008-10-13 22:06:31 +0000327<a name="targetspecific">Target Specific Improvements</a>
Chris Lattner84977642007-09-21 03:54:09 +0000328</div>
Chris Lattner60893e52007-05-18 06:33:02 +0000329
Chris Lattner738bd302006-04-18 06:32:08 +0000330<div class="doc_text">
Chris Lattnerf304ffc2008-02-10 08:17:19 +0000331<p>New target-specific features include:
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000332</p>
Chris Lattner26299222006-11-18 07:51:14 +0000333
334<ul>
Chris Lattner38ab04c2009-02-25 04:41:31 +0000335<li>?</li>
Chris Lattner77d29b12008-06-05 08:02:49 +0000336</ul>
Chris Lattner77d29b12008-06-05 08:02:49 +0000337
Mikhail Glushenkovea65d7d2008-10-13 02:08:34 +0000338</div>
Chris Lattner77d29b12008-06-05 08:02:49 +0000339
340
341<!--=========================================================================-->
342<div class="doc_subsection">
Chris Lattner84977642007-09-21 03:54:09 +0000343<a name="otherimprovements">Other Improvements</a>
344</div>
345
346<div class="doc_text">
347<p>New features include:
348</p>
349
350<ul>
Chris Lattner38ab04c2009-02-25 04:41:31 +0000351<li>?</li>
Tanya Lattnera7ec7062008-11-04 18:40:27 +0000352
Chris Lattner84977642007-09-21 03:54:09 +0000353</ul>
Mikhail Glushenkovea65d7d2008-10-13 02:08:34 +0000354
Chris Lattner84977642007-09-21 03:54:09 +0000355</div>
Chris Lattnerc5d658a2006-03-03 00:34:26 +0000356
Chris Lattnerf6662f92008-10-13 17:57:36 +0000357<!--=========================================================================-->
358<div class="doc_subsection">
359<a name="changes">Major Changes and Removed Features</a>
360</div>
361
362<div class="doc_text">
363
Chris Lattnereeb4da02008-10-13 22:06:31 +0000364<p>If you're already an LLVM user or developer with out-of-tree changes based
Chris Lattner38ab04c2009-02-25 04:41:31 +0000365on LLVM 2.4, this section lists some "gotchas" that you may run into upgrading
Chris Lattnereeb4da02008-10-13 22:06:31 +0000366from the previous release.</p>
Chris Lattnerf6662f92008-10-13 17:57:36 +0000367
368<ul>
369
Chris Lattner38ab04c2009-02-25 04:41:31 +0000370<li>?</li>
Chris Lattnereeb4da02008-10-13 22:06:31 +0000371</ul>
372
373
374<p>In addition, many APIs have changed in this release. Some of the major LLVM
375API changes are:</p>
376
377<ul>
Chris Lattner38ab04c2009-02-25 04:41:31 +0000378<li>?</li>
Devang Patelb34dd132008-10-14 20:03:43 +0000379</ul>
Chris Lattnerf6662f92008-10-13 17:57:36 +0000380
Chris Lattner38ab04c2009-02-25 04:41:31 +0000381<li>?</li>
Chris Lattnerf6662f92008-10-13 17:57:36 +0000382</ul>
383
384</div>
385
386
387
Chris Lattner19092612003-10-02 16:38:05 +0000388<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000389<div class="doc_section">
390 <a name="portability">Portability and Supported Platforms</a>
391</div>
Chris Lattner19092612003-10-02 16:38:05 +0000392<!-- *********************************************************************** -->
393
Misha Brukman500bc302003-11-22 00:38:41 +0000394<div class="doc_text">
395
John Criswell0b5b5e92004-12-08 20:35:47 +0000396<p>LLVM is known to work on the following platforms:</p>
Chris Lattner4654bdb2004-06-01 18:22:41 +0000397
398<ul>
Chris Lattnere18b32e2008-11-10 05:40:34 +0000399<li>Intel and AMD machines (IA32, X86-64, AMD64, EMT-64) running Red Hat
400Linux, Fedora Core and FreeBSD (and probably other unix-like systems).</li>
401<li>PowerPC and X86-based Mac OS X systems, running 10.3 and above in 32-bit
402and 64-bit modes.</li>
Chris Lattner252b83d2008-02-06 18:00:06 +0000403<li>Intel and AMD machines running on Win32 using MinGW libraries (native).</li>
Chris Lattner57a460e2007-05-23 04:39:32 +0000404<li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
405 support is available for native builds with Visual C++).</li>
Gabor Greif96a89c72008-06-05 18:39:01 +0000406<li>Sun UltraSPARC workstations running Solaris 10.</li>
John Criswell9321fa82005-05-13 20:28:15 +0000407<li>Alpha-based machines running Debian GNU/Linux.</li>
Gabor Greif96a89c72008-06-05 18:39:01 +0000408<li>Itanium-based (IA64) machines running Linux and HP-UX.</li>
Chris Lattner4654bdb2004-06-01 18:22:41 +0000409</ul>
410
Chris Lattnerbc5786b2008-06-05 06:57:39 +0000411<p>The core LLVM infrastructure uses GNU autoconf to adapt itself
Brian Gaekeb0fd7612004-05-09 05:28:35 +0000412to the machine and operating system on which it is built. However, minor
413porting may be required to get LLVM to work on new platforms. We welcome your
414portability patches and reports of successful builds or error messages.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000415
Misha Brukman500bc302003-11-22 00:38:41 +0000416</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000417
418<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000419<div class="doc_section">
420 <a name="knownproblems">Known Problems</a>
421</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000422<!-- *********************************************************************** -->
423
Misha Brukman500bc302003-11-22 00:38:41 +0000424<div class="doc_text">
425
Chris Lattnere18b32e2008-11-10 05:40:34 +0000426<p>This section contains significant known problems with the LLVM system,
427listed by component. If you run into a problem, please check the <a
Chris Lattnerc463b272005-10-29 07:07:09 +0000428href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
Chris Lattner5eccca42003-12-12 21:22:16 +0000429there isn't already one.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000430
Misha Brukman500bc302003-11-22 00:38:41 +0000431</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000432
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000433<!-- ======================================================================= -->
434<div class="doc_subsection">
435 <a name="experimental">Experimental features included with this release</a>
436</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000437
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000438<div class="doc_text">
439
Misha Brukman6df9e2c2004-05-12 21:46:05 +0000440<p>The following components of this LLVM release are either untested, known to
441be broken or unreliable, or are in early development. These components should
442not be relied on, and bugs should not be filed against them, but they may be
443useful to some people. In particular, if you would like to work on one of these
Chris Lattner2b659ef2008-02-12 06:29:45 +0000444components, please contact us on the <a
445href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p>
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000446
447<ul>
Gabor Greifa8b84902008-10-14 11:31:14 +0000448<li>The MSIL, IA64, Alpha, SPU, MIPS, and PIC16 backends are experimental.</li>
Duncan Sands27aff872008-06-08 20:18:35 +0000449<li>The llc "<tt>-filetype=asm</tt>" (the default) is the only supported
Chris Lattner000c73b2008-02-06 06:30:34 +0000450 value for this option.</li>
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000451</ul>
452
453</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000454
Misha Brukman500bc302003-11-22 00:38:41 +0000455<!-- ======================================================================= -->
456<div class="doc_subsection">
Chris Lattner26299222006-11-18 07:51:14 +0000457 <a name="x86-be">Known problems with the X86 back-end</a>
John Criswellc0c186d2005-11-08 21:11:33 +0000458</div>
459
460<div class="doc_text">
461
462<ul>
Anton Korobeynikova6094be2008-06-08 10:24:13 +0000463 <li>The X86 backend does not yet support
464 all <a href="http://llvm.org/PR879">inline assembly that uses the X86
465 floating point stack</a>. It supports the 'f' and 't' constraints, but not
466 'u'.</li>
Chris Lattnere6e1b352008-06-08 21:19:07 +0000467 <li>The X86 backend generates inefficient floating point code when configured
468 to generate code for systems that don't have SSE2.</li>
Duncan Sands47eff2b2008-06-08 19:38:43 +0000469 <li>Win64 code generation wasn't widely tested. Everything should work, but we
Anton Korobeynikova6094be2008-06-08 10:24:13 +0000470 expect small issues to happen. Also, llvm-gcc cannot build mingw64 runtime
471 currently due
472 to <a href="http://llvm.org/PR2255">several</a>
Chris Lattner04af7cb2008-06-08 23:12:47 +0000473 <a href="http://llvm.org/PR2257">bugs</a> due to lack of support for the
474 'u' inline assembly constraint and X87 floating point inline assembly.</li>
Dan Gohman8207ba92008-06-08 23:05:11 +0000475 <li>The X86-64 backend does not yet support the LLVM IR instruction
476 <tt>va_arg</tt>. Currently, the llvm-gcc front-end supports variadic
477 argument constructs on X86-64 by lowering them manually.</li>
Chris Lattner26299222006-11-18 07:51:14 +0000478</ul>
479
480</div>
481
482<!-- ======================================================================= -->
483<div class="doc_subsection">
484 <a name="ppc-be">Known problems with the PowerPC back-end</a>
485</div>
486
487<div class="doc_text">
488
489<ul>
Nicolas Geoffraye4285dc2007-05-15 09:21:28 +0000490<li>The Linux PPC32/ABI support needs testing for the interpreter and static
Chris Lattner57a460e2007-05-23 04:39:32 +0000491compilation, and lacks support for debug information.</li>
Chris Lattner26299222006-11-18 07:51:14 +0000492</ul>
493
494</div>
495
496<!-- ======================================================================= -->
497<div class="doc_subsection">
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000498 <a name="arm-be">Known problems with the ARM back-end</a>
499</div>
500
501<div class="doc_text">
502
503<ul>
Chris Lattner57a460e2007-05-23 04:39:32 +0000504<li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
Duncan Sandsc90d68b2007-09-26 15:59:54 +0000505processors, thumb programs can crash or produce wrong
Chris Lattner57a460e2007-05-23 04:39:32 +0000506results (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000507<li>Compilation for ARM Linux OABI (old ABI) is supported, but not fully tested.
508</li>
Chris Lattnere6e1b352008-06-08 21:19:07 +0000509<li>There is a bug in QEMU-ARM (&lt;= 0.9.0) which causes it to incorrectly
510 execute
Chris Lattner57a460e2007-05-23 04:39:32 +0000511programs compiled with LLVM. Please use more recent versions of QEMU.</li>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000512</ul>
513
514</div>
515
516<!-- ======================================================================= -->
517<div class="doc_subsection">
Chris Lattner26299222006-11-18 07:51:14 +0000518 <a name="sparc-be">Known problems with the SPARC back-end</a>
519</div>
520
521<div class="doc_text">
522
523<ul>
524<li>The SPARC backend only supports the 32-bit SPARC ABI (-m32), it does not
525 support the 64-bit SPARC ABI (-m64).</li>
526</ul>
527
528</div>
529
530<!-- ======================================================================= -->
531<div class="doc_subsection">
Bruno Cardoso Lopesb7e1a4f2008-10-25 14:56:26 +0000532 <a name="mips-be">Known problems with the MIPS back-end</a>
533</div>
534
535<div class="doc_text">
536
537<ul>
538<li>The O32 ABI is not fully supported.</li>
539<li>64-bit MIPS targets are not supported yet.</li>
540</ul>
541
542</div>
543
544<!-- ======================================================================= -->
545<div class="doc_subsection">
Chris Lattner26299222006-11-18 07:51:14 +0000546 <a name="alpha-be">Known problems with the Alpha back-end</a>
547</div>
548
549<div class="doc_text">
550
551<ul>
552
553<li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
554appropriate nops inserted to ensure restartability.</li>
555
John Criswellc0c186d2005-11-08 21:11:33 +0000556</ul>
557</div>
558
Chris Lattner26299222006-11-18 07:51:14 +0000559<!-- ======================================================================= -->
560<div class="doc_subsection">
561 <a name="ia64-be">Known problems with the IA64 back-end</a>
562</div>
563
564<div class="doc_text">
565
566<ul>
Chris Lattner04af7cb2008-06-08 23:12:47 +0000567<li>The Itanium backend is highly experimental, and has a number of known
568 issues. We are looking for a maintainer for the Itanium backend. If you
Gabor Greif3bd3a262008-10-15 10:47:24 +0000569 are interested, please contact the LLVMdev mailing list.</li>
Chris Lattner26299222006-11-18 07:51:14 +0000570</ul>
571
572</div>
573
574<!-- ======================================================================= -->
575<div class="doc_subsection">
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000576 <a name="c-be">Known problems with the C back-end</a>
Chris Lattner26299222006-11-18 07:51:14 +0000577</div>
578
579<div class="doc_text">
580
581<ul>
Chris Lattner5733b272008-06-05 06:35:40 +0000582<li><a href="http://llvm.org/PR802">The C backend has only basic support for
583 inline assembly code</a>.</li>
Chris Lattner725a0d82007-09-26 06:01:35 +0000584<li><a href="http://llvm.org/PR1658">The C backend violates the ABI of common
585 C++ programs</a>, preventing intermixing between C++ compiled by the CBE and
Duncan Sands27aff872008-06-08 20:18:35 +0000586 C++ code compiled with llc or native compilers.</li>
Duncan Sandsf74c0cc2008-02-10 13:40:55 +0000587<li>The C backend does not support all exception handling constructs.</li>
Chris Lattner26299222006-11-18 07:51:14 +0000588</ul>
589
590</div>
John Criswellc0c186d2005-11-08 21:11:33 +0000591
Misha Brukman500bc302003-11-22 00:38:41 +0000592
593<!-- ======================================================================= -->
594<div class="doc_subsection">
Chris Lattner5733b272008-06-05 06:35:40 +0000595 <a name="c-fe">Known problems with the llvm-gcc C front-end</a>
Misha Brukman500bc302003-11-22 00:38:41 +0000596</div>
Chris Lattner47588f92003-10-02 05:07:23 +0000597
Misha Brukman500bc302003-11-22 00:38:41 +0000598<div class="doc_text">
Chris Lattnerc5d658a2006-03-03 00:34:26 +0000599
Chris Lattner252b83d2008-02-06 18:00:06 +0000600<p>llvm-gcc does not currently support <a href="http://llvm.org/PR869">Link-Time
601Optimization</a> on most platforms "out-of-the-box". Please inquire on the
Gabor Greif3bd3a262008-10-15 10:47:24 +0000602LLVMdev mailing list if you are interested.</p>
Chris Lattnerd9ea0172006-08-08 17:27:28 +0000603
Chris Lattner5733b272008-06-05 06:35:40 +0000604<p>The only major language feature of GCC not supported by llvm-gcc is
605 the <tt>__builtin_apply</tt> family of builtins. However, some extensions
606 are only supported on some targets. For example, trampolines are only
Duncan Sands27aff872008-06-08 20:18:35 +0000607 supported on some targets (these are used when you take the address of a
608 nested function).</p>
Misha Brukman500bc302003-11-22 00:38:41 +0000609
Chris Lattner5733b272008-06-05 06:35:40 +0000610<p>If you run into GCC extensions which are not supported, please let us know.
611</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000612
Misha Brukman500bc302003-11-22 00:38:41 +0000613</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000614
Misha Brukman500bc302003-11-22 00:38:41 +0000615<!-- ======================================================================= -->
616<div class="doc_subsection">
Chris Lattner5733b272008-06-05 06:35:40 +0000617 <a name="c++-fe">Known problems with the llvm-gcc C++ front-end</a>
Misha Brukman500bc302003-11-22 00:38:41 +0000618</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000619
Misha Brukman500bc302003-11-22 00:38:41 +0000620<div class="doc_text">
621
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000622<p>The C++ front-end is considered to be fully
Chris Lattner7506b1d2004-12-07 08:04:13 +0000623tested and works for a number of non-trivial programs, including LLVM
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000624itself, Qt, Mozilla, etc.</p>
Misha Brukman500bc302003-11-22 00:38:41 +0000625
Misha Brukman500bc302003-11-22 00:38:41 +0000626<ul>
Anton Korobeynikov0021fc12008-10-11 18:27:16 +0000627<li>Exception handling works well on the X86 and PowerPC targets. Currently
Chris Lattnere18b32e2008-11-10 05:40:34 +0000628 only Linux and Darwin targets are supported (both 32 and 64 bit).</li>
Misha Brukman500bc302003-11-22 00:38:41 +0000629</ul>
Chris Lattnerfcc54b32003-10-07 22:14:37 +0000630
Misha Brukman500bc302003-11-22 00:38:41 +0000631</div>
632
Chris Lattner1eb4df62008-10-30 03:58:13 +0000633<!-- ======================================================================= -->
634<div class="doc_subsection">
635 <a name="fortran-fe">Known problems with the llvm-gcc Fortran front-end</a>
636</div>
637
638<div class="doc_text">
Gabor Greifba10fe02008-11-04 21:50:59 +0000639<ul>
Chris Lattner1eb4df62008-10-30 03:58:13 +0000640<li>Fortran support generally works, but there are still several unresolved bugs
641 in Bugzilla. Please see the tools/gfortran component for details.</li>
642
643<li>The Fortran front-end currently does not build on Darwin (without tweaks)
644 due to unresolved dependencies on the C front-end.</li>
Gabor Greifba10fe02008-11-04 21:50:59 +0000645</ul>
Chris Lattner1eb4df62008-10-30 03:58:13 +0000646</div>
Misha Brukman500bc302003-11-22 00:38:41 +0000647
Chris Lattner2b659ef2008-02-12 06:29:45 +0000648<!-- ======================================================================= -->
649<div class="doc_subsection">
Chris Lattner5733b272008-06-05 06:35:40 +0000650 <a name="ada-fe">Known problems with the llvm-gcc Ada front-end</a>
Chris Lattner2b659ef2008-02-12 06:29:45 +0000651</div>
652
653<div class="doc_text">
654The llvm-gcc 4.2 Ada compiler works fairly well, however this is not a mature
655technology and problems should be expected.
656<ul>
Duncan Sands27aff872008-06-08 20:18:35 +0000657<li>The Ada front-end currently only builds on X86-32. This is mainly due
Chris Lattner2b659ef2008-02-12 06:29:45 +0000658to lack of trampoline support (pointers to nested functions) on other platforms,
Duncan Sands27aff872008-06-08 20:18:35 +0000659however it <a href="http://llvm.org/PR2006">also fails to build on X86-64</a>
Chris Lattner2b659ef2008-02-12 06:29:45 +0000660which does support trampolines.</li>
661<li>The Ada front-end <a href="http://llvm.org/PR2007">fails to bootstrap</a>.
662Workaround: configure with --disable-bootstrap.</li>
Duncan Sands978bcee2008-10-13 17:27:23 +0000663<li>The c380004, <a href="http://llvm.org/PR2010">c393010</a>
664and <a href="http://llvm.org/PR2421">cxg2021</a> ACATS tests fail
665(c380004 also fails with gcc-4.2 mainline).</li>
666<li>Some gcc specific Ada tests continue to crash the compiler.</li>
Chris Lattner2b659ef2008-02-12 06:29:45 +0000667<li>The -E binder option (exception backtraces)
668<a href="http://llvm.org/PR1982">does not work</a> and will result in programs
669crashing if an exception is raised. Workaround: do not use -E.</li>
670<li>Only discrete types <a href="http://llvm.org/PR1981">are allowed to start
671or finish at a non-byte offset</a> in a record. Workaround: do not pack records
672or use representation clauses that result in a field of a non-discrete type
673starting or finishing in the middle of a byte.</li>
Chris Lattnere6e1b352008-06-08 21:19:07 +0000674<li>The <tt>lli</tt> interpreter <a href="http://llvm.org/PR2009">considers
675'main' as generated by the Ada binder to be invalid</a>.
676Workaround: hand edit the file to use pointers for <tt>argv</tt> and
677<tt>envp</tt> rather than integers.</li>
678<li>The <tt>-fstack-check</tt> option <a href="http://llvm.org/PR2008">is
679ignored</a>.</li>
Chris Lattner2b659ef2008-02-12 06:29:45 +0000680</ul>
681</div>
682
Chris Lattner79c3fe12003-10-02 04:57:28 +0000683<!-- *********************************************************************** -->
Misha Brukman500bc302003-11-22 00:38:41 +0000684<div class="doc_section">
685 <a name="additionalinfo">Additional Information</a>
686</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000687<!-- *********************************************************************** -->
688
Misha Brukman500bc302003-11-22 00:38:41 +0000689<div class="doc_text">
690
Chris Lattner416db102005-05-16 17:13:10 +0000691<p>A wide variety of additional information is available on the <a
Chris Lattnerb4b0ce72007-05-18 00:44:29 +0000692href="http://llvm.org">LLVM web page</a>, in particular in the <a
693href="http://llvm.org/docs/">documentation</a> section. The web page also
Reid Spencer669ed452007-07-09 08:04:31 +0000694contains versions of the API documentation which is up-to-date with the
695Subversion version of the source code.
Misha Brukman109d9e82005-03-30 19:14:24 +0000696You can access versions of these documents specific to this release by going
697into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000698
Misha Brukman500bc302003-11-22 00:38:41 +0000699<p>If you have any questions or comments about LLVM, please feel free to contact
Chris Lattnerc463b272005-10-29 07:07:09 +0000700us via the <a href="http://llvm.org/docs/#maillist"> mailing
Chris Lattner5eccca42003-12-12 21:22:16 +0000701lists</a>.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000702
Misha Brukman500bc302003-11-22 00:38:41 +0000703</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000704
705<!-- *********************************************************************** -->
Chris Lattner79c3fe12003-10-02 04:57:28 +0000706
Misha Brukman500bc302003-11-22 00:38:41 +0000707<hr>
Misha Brukman2061e892003-11-22 01:23:39 +0000708<address>
Misha Brukman38847d52003-12-21 22:53:21 +0000709 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman44408702008-12-11 17:34:48 +0000710 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
Misha Brukman2061e892003-11-22 01:23:39 +0000711 <a href="http://validator.w3.org/check/referer"><img
Misha Brukman44408702008-12-11 17:34:48 +0000712 src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
Misha Brukman2061e892003-11-22 01:23:39 +0000713
Chris Lattnerb4b0ce72007-05-18 00:44:29 +0000714 <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
Misha Brukman500bc302003-11-22 00:38:41 +0000715 Last modified: $Date$
Misha Brukman2061e892003-11-22 01:23:39 +0000716</address>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000717
Misha Brukman500bc302003-11-22 00:38:41 +0000718</body>
719</html>