blob: ce3aa4e0ed3725ef1c853ab77ea780983f817ea7 [file] [log] [blame]
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
3<html>
4<head>
5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
6 <link rel="stylesheet" href="llvm.css" type="text/css">
Chris Lattner95d25072009-02-25 04:41:31 +00007 <title>LLVM 2.5 Release Notes</title>
Dan Gohmanf17a25c2007-07-18 16:29:46 +00008</head>
9<body>
10
Chris Lattner95d25072009-02-25 04:41:31 +000011<div class="doc_title">LLVM 2.5 Release Notes</div>
Mikhail Glushenkov808cd3e2008-10-13 02:08:34 +000012
Dan Gohmanf17a25c2007-07-18 16:29:46 +000013<ol>
14 <li><a href="#intro">Introduction</a></li>
Chris Lattner78a130b2008-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>
Dan Gohmanf17a25c2007-07-18 16:29:46 +000017 <li><a href="GettingStarted.html">Installation Instructions</a></li>
18 <li><a href="#portability">Portability and Supported Platforms</a></li>
Dan Gohman0de549c2008-10-14 16:23:02 +000019 <li><a href="#knownproblems">Known Problems</a></li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +000020 <li><a href="#additionalinfo">Additional Information</a></li>
21</ol>
22
23<div class="doc_author">
Dan Gohman0de549c2008-10-14 16:23:02 +000024 <p>Written by the <a href="http://llvm.org">LLVM Team</a></p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +000025</div>
26
27<!-- *********************************************************************** -->
28<div class="doc_section">
29 <a name="intro">Introduction</a>
30</div>
31<!-- *********************************************************************** -->
32
33<div class="doc_text">
34
Chris Lattner92eacf82008-10-13 17:57:36 +000035<p>This document contains the release notes for the LLVM Compiler
Chris Lattner95d25072009-02-25 04:41:31 +000036Infrastructure, release 2.5. Here we describe the status of LLVM, including
Chris Lattner92eacf82008-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>
Dan Gohmanf17a25c2007-07-18 16:29:46 +000040
41<p>For more information about LLVM, including information about the latest
42release, please check out the <a href="http://llvm.org/">main LLVM
43web site</a>. If you have questions or comments, the <a
Chris Lattner92eacf82008-10-13 17:57:36 +000044href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM Developer's Mailing
45List</a> is a good place to send them.</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +000046
Mikhail Glushenkov808cd3e2008-10-13 02:08:34 +000047<p>Note that if you are reading this file from a Subversion checkout or the
Chris Lattnerb0d6c502007-09-21 03:54:09 +000048main LLVM web page, this document applies to the <i>next</i> release, not the
Gabor Greif7c65c4f2008-10-14 11:00:32 +000049current one. To see the release notes for a specific release, please see the
Chris Lattnerb0d6c502007-09-21 03:54:09 +000050<a href="http://llvm.org/releases/">releases page</a>.</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +000051
52</div>
53
Chris Lattner95d25072009-02-25 04:41:31 +000054<!-- Unfinished features in 2.5:
Chris Lattner8fda4952008-02-10 07:46:44 +000055 Machine LICM
56 Machine Sinking
Chris Lattnera53f4972009-02-25 06:34:50 +000057 target-specific intrinsics
58 gold lto plugin
Chris Lattner56b64702009-02-25 07:32:53 +000059 pre-alloc splitter, strong phi elim
Chris Lattner4f076402008-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 Lattnera53f4972009-02-25 06:34:50 +000062 debug info for optimized code
Chris Lattner56b64702009-02-25 07:32:53 +000063
Chris Lattner8fda4952008-02-10 07:46:44 +000064 -->
Mikhail Glushenkov808cd3e2008-10-13 02:08:34 +000065
Chris Lattner4f076402008-10-12 19:47:48 +000066 <!-- for announcement email:
Chris Lattnera53f4972009-02-25 06:34:50 +000067 -->
Chris Lattner8fda4952008-02-10 07:46:44 +000068
Chris Lattner78a130b2008-10-13 18:01:01 +000069<!-- *********************************************************************** -->
70<div class="doc_section">
71 <a name="subproj">Sub-project Status Update</a>
Chris Lattnerf65224f2008-06-08 21:34:41 +000072</div>
Chris Lattner78a130b2008-10-13 18:01:01 +000073<!-- *********************************************************************** -->
Chris Lattnerf65224f2008-06-08 21:34:41 +000074
75<div class="doc_text">
Chris Lattnerf6a0d382008-06-08 21:58:17 +000076<p>
Chris Lattner95d25072009-02-25 04:41:31 +000077The LLVM 2.5 distribution currently consists of code from the core LLVM
Chris Lattnera3c683b2008-10-13 18:11:54 +000078repository (which roughly includes the LLVM optimizers, code generators and
Chris Lattnerf6a0d382008-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 Lattner2c3ef982008-10-11 18:18:28 +000081are the most actively developed are the <a href="#clang">Clang Project</a> and
Nicolas Geoffray2b139382008-10-14 19:23:04 +000082the <a href="#vmkit">VMKit Project</a>.
Chris Lattnerf6a0d382008-06-08 21:58:17 +000083</p>
Chris Lattner78a130b2008-10-13 18:01:01 +000084
Chris Lattnerf6a0d382008-06-08 21:58:17 +000085</div>
86
Chris Lattner78a130b2008-10-13 18:01:01 +000087
Chris Lattnerf6a0d382008-06-08 21:58:17 +000088<!--=========================================================================-->
Chris Lattner78a130b2008-10-13 18:01:01 +000089<div class="doc_subsection">
Chris Lattnera3c683b2008-10-13 18:11:54 +000090<a name="clang">Clang: C/C++/Objective-C Frontend Toolkit</a>
Chris Lattnerf6a0d382008-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 Lattnerc97507b2009-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 Lattnerf6a0d382008-06-08 21:58:17 +0000104
Chris Lattnerc97507b2009-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 Lattnera53f4972009-02-25 06:34:50 +0000108by <a href="http://clang.llvm.org/get_started.html">building from mainline</a>
Chris Lattnerc97507b2009-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 Wendling385b0d32008-10-27 09:27:33 +0000114
Daniel Dunbarf3e35782008-10-14 23:25:09 +0000115<ul>
Chris Lattnerc97507b2009-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 Lattnera3c683b2008-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 Kremenek0437b2c2008-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 Lattnerff170152008-10-14 06:02:29 +0000135of checks to find bugs that occur on a specific path within a program. Examples
Ted Kremenek0437b2c2008-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 Lattnerff170152008-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 Lattnerc2d84672008-10-14 00:52:49 +0000141
Ted Kremenek0437b2c2008-10-14 05:14:21 +0000142<p>The tool also provides a simple web GUI to inspect potential bugs found by
Chris Lattnerff170152008-10-14 06:02:29 +0000143the tool. While still early in development, the GUI illustrates some of the key
Ted Kremenek0437b2c2008-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 Wendling385b0d32008-10-27 09:27:33 +0000146that span multiple lines); and built-in knowledge of macros, which is used to
Ted Kremenek0437b2c2008-10-14 05:14:21 +0000147perform inline expansion of macros within the GUI itself.</p>
148
Chris Lattnerff170152008-10-14 06:02:29 +0000149<p>The set of checks performed by the static analyzer is gradually expanding,
Bill Wendling385b0d32008-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 Lattnerf6a0d382008-06-08 21:58:17 +0000154
155</div>
156
Chris Lattner78a130b2008-10-13 18:01:01 +0000157<!--=========================================================================-->
158<div class="doc_subsection">
Nicolas Geoffray2b139382008-10-14 19:23:04 +0000159<a name="vmkit">VMKit: JVM/CLI Virtual Machine Implementation</a>
Chris Lattner78a130b2008-10-13 18:01:01 +0000160</div>
161
162<div class="doc_text">
163<p>
Nicolas Geoffray2b139382008-10-14 19:23:04 +0000164The <a href="http://vmkit.llvm.org/">VMKit project</a> is an implementation of
Chris Lattner78a130b2008-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 Lattner02408742009-02-25 05:45:05 +0000168<p>Following LLVM 2.5, VMKit has its first release ? that you can find on its
Nicolas Geoffray20cfdd42008-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 Lattner78a130b2008-10-13 18:01:01 +0000171
Nicolas Geoffray2b139382008-10-14 19:23:04 +0000172<ul>
173
Chris Lattner95d25072009-02-25 04:41:31 +0000174<li>?</li>
Nicolas Geoffray2b139382008-10-14 19:23:04 +0000175
176</ul>
Chris Lattner78a130b2008-10-13 18:01:01 +0000177</div>
178
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000179
180<!-- *********************************************************************** -->
181<div class="doc_section">
Chris Lattner78a130b2008-10-13 18:01:01 +0000182 <a name="whatsnew">What's New in LLVM?</a>
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000183</div>
184<!-- *********************************************************************** -->
185
Chris Lattner5cce7a52008-06-08 22:59:35 +0000186<div class="doc_text">
187
Bill Wendling385b0d32008-10-27 09:27:33 +0000188<p>This release includes a huge number of bug fixes, performance tweaks, and
Chris Lattner92eacf82008-10-13 17:57:36 +0000189minor improvements. Some of the major improvements and new features are listed
190in this section.
Chris Lattner5cce7a52008-06-08 22:59:35 +0000191</p>
192</div>
193
Chris Lattnerf6a0d382008-06-08 21:58:17 +0000194<!--=========================================================================-->
Chris Lattnerf65224f2008-06-08 21:34:41 +0000195<div class="doc_subsection">
Chris Lattnere0798082008-02-06 18:00:06 +0000196<a name="majorfeatures">Major New Features</a>
197</div>
198
199<div class="doc_text">
200
Chris Lattner95d25072009-02-25 04:41:31 +0000201<p>LLVM 2.5 includes several major new capabilities:</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000202
203<ul>
Duncan Sandse2cd8182009-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 Lattnera53f4972009-02-25 06:34:50 +0000213
214<!--
215Random stuff:
216
Chris Lattner56b64702009-02-25 07:32:53 +0000217xcore backend!
218fortran on darwin!
219
Chris Lattnera53f4972009-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 Lattner56b64702009-02-25 07:32:53 +0000226how to write a backend doc docs/WritingAnLLVMBackend.html
Chris Lattnera53f4972009-02-25 06:34:50 +0000227fastisel + exception handling
228vector widening <3 x float> -> <4 x float>
Chris Lattner56b64702009-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 Lattnera53f4972009-02-25 06:34:50 +0000239-->
Chris Lattnerba948522008-06-05 06:57:39 +0000240
Chris Lattner5ba16862008-02-10 08:18:42 +0000241</ul>
242
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000243</div>
244
Chris Lattnerc5a4e312008-06-05 06:25:56 +0000245
246<!--=========================================================================-->
247<div class="doc_subsection">
Chris Lattnerf65224f2008-06-08 21:34:41 +0000248<a name="llvm-gcc">llvm-gcc 4.2 Improvements</a>
Chris Lattnerc5a4e312008-06-05 06:25:56 +0000249</div>
250
251<div class="doc_text">
252
Chris Lattner4352cc82008-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 Lattnerc5a4e312008-06-05 06:25:56 +0000256
Chris Lattner5cce7a52008-06-08 22:59:35 +0000257<ul>
Chris Lattner95d25072009-02-25 04:41:31 +0000258<li>?</li>
Gabor Greif0e49cc82008-06-09 06:06:18 +0000259</ul>
Chris Lattnerc5a4e312008-06-05 06:25:56 +0000260
Chris Lattnerc5a4e312008-06-05 06:25:56 +0000261</div>
262
263
Chris Lattnerb0d6c502007-09-21 03:54:09 +0000264<!--=========================================================================-->
265<div class="doc_subsection">
Chris Lattnerc3649452008-02-10 08:17:19 +0000266<a name="coreimprovements">LLVM Core Improvements</a>
267</div>
268
269<div class="doc_text">
Bill Wendling385b0d32008-10-27 09:27:33 +0000270<p>New features include:</p>
Chris Lattnerc3649452008-02-10 08:17:19 +0000271
Chris Lattnerc5a4e312008-06-05 06:25:56 +0000272<ul>
Chris Lattner95d25072009-02-25 04:41:31 +0000273<li>?</li>
Chris Lattnerf7bae6d2008-10-13 20:59:32 +0000274
Chris Lattnerc3649452008-02-10 08:17:19 +0000275</ul>
Mikhail Glushenkov808cd3e2008-10-13 02:08:34 +0000276
Chris Lattnerc3649452008-02-10 08:17:19 +0000277</div>
278
279<!--=========================================================================-->
280<div class="doc_subsection">
Chris Lattner8fda4952008-02-10 07:46:44 +0000281<a name="optimizer">Optimizer Improvements</a>
282</div>
283
284<div class="doc_text">
285
Chris Lattnerea9c2242008-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 Lattner8fda4952008-02-10 07:46:44 +0000288
289<ul>
290
Chris Lattner95d25072009-02-25 04:41:31 +0000291<li>?</li>
Chris Lattnerea9c2242008-10-13 21:50:36 +0000292
Chris Lattner0eef6e42008-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 Greifaa53e562008-10-14 11:31:14 +0000304<p>We have put a significant amount of work into the code generator infrastructure,
Chris Lattner0eef6e42008-06-08 02:45:07 +0000305which allows us to implement more aggressive algorithms and make it run
306faster:</p>
307
308<ul>
Duncan Sands335d5e42009-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 Lattner95d25072009-02-25 04:41:31 +0000318<li>?</li>
Chris Lattner0eef6e42008-06-08 02:45:07 +0000319
Chris Lattnerb0d6c502007-09-21 03:54:09 +0000320</ul>
321
322</div>
323
324
325<!--=========================================================================-->
326<div class="doc_subsection">
Chris Lattnercc64a322008-10-13 22:06:31 +0000327<a name="targetspecific">Target Specific Improvements</a>
Chris Lattnerb0d6c502007-09-21 03:54:09 +0000328</div>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000329
330<div class="doc_text">
Chris Lattnerc3649452008-02-10 08:17:19 +0000331<p>New target-specific features include:
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000332</p>
333
334<ul>
Chris Lattner95d25072009-02-25 04:41:31 +0000335<li>?</li>
Chris Lattnere45f18b2008-06-05 08:02:49 +0000336</ul>
Chris Lattnere45f18b2008-06-05 08:02:49 +0000337
Mikhail Glushenkov808cd3e2008-10-13 02:08:34 +0000338</div>
Chris Lattnere45f18b2008-06-05 08:02:49 +0000339
340
341<!--=========================================================================-->
342<div class="doc_subsection">
Chris Lattnerb0d6c502007-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 Lattner95d25072009-02-25 04:41:31 +0000351<li>?</li>
Tanya Lattnerc79f7542008-11-04 18:40:27 +0000352
Chris Lattnerb0d6c502007-09-21 03:54:09 +0000353</ul>
Mikhail Glushenkov808cd3e2008-10-13 02:08:34 +0000354
Chris Lattnerb0d6c502007-09-21 03:54:09 +0000355</div>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000356
Chris Lattner92eacf82008-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 Lattnercc64a322008-10-13 22:06:31 +0000364<p>If you're already an LLVM user or developer with out-of-tree changes based
Chris Lattner95d25072009-02-25 04:41:31 +0000365on LLVM 2.4, this section lists some "gotchas" that you may run into upgrading
Chris Lattnercc64a322008-10-13 22:06:31 +0000366from the previous release.</p>
Chris Lattner92eacf82008-10-13 17:57:36 +0000367
368<ul>
369
Chris Lattner95d25072009-02-25 04:41:31 +0000370<li>?</li>
Chris Lattnercc64a322008-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 Lattner95d25072009-02-25 04:41:31 +0000378<li>?</li>
Devang Patel0e3da1a2008-10-14 20:03:43 +0000379</ul>
Chris Lattner92eacf82008-10-13 17:57:36 +0000380
Chris Lattner95d25072009-02-25 04:41:31 +0000381<li>?</li>
Chris Lattner92eacf82008-10-13 17:57:36 +0000382</ul>
383
384</div>
385
386
387
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000388<!-- *********************************************************************** -->
389<div class="doc_section">
390 <a name="portability">Portability and Supported Platforms</a>
391</div>
392<!-- *********************************************************************** -->
393
394<div class="doc_text">
395
396<p>LLVM is known to work on the following platforms:</p>
397
398<ul>
Chris Lattnerb1ad47c2008-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 Lattnere0798082008-02-06 18:00:06 +0000403<li>Intel and AMD machines running on Win32 using MinGW libraries (native).</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +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 Greif5e75e652008-06-05 18:39:01 +0000406<li>Sun UltraSPARC workstations running Solaris 10.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000407<li>Alpha-based machines running Debian GNU/Linux.</li>
Gabor Greif5e75e652008-06-05 18:39:01 +0000408<li>Itanium-based (IA64) machines running Linux and HP-UX.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000409</ul>
410
Chris Lattnerba948522008-06-05 06:57:39 +0000411<p>The core LLVM infrastructure uses GNU autoconf to adapt itself
Dan Gohmanf17a25c2007-07-18 16:29:46 +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>
415
416</div>
417
418<!-- *********************************************************************** -->
419<div class="doc_section">
420 <a name="knownproblems">Known Problems</a>
421</div>
422<!-- *********************************************************************** -->
423
424<div class="doc_text">
425
Chris Lattnerb1ad47c2008-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
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000428href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
429there isn't already one.</p>
430
431</div>
432
433<!-- ======================================================================= -->
434<div class="doc_subsection">
435 <a name="experimental">Experimental features included with this release</a>
436</div>
437
438<div class="doc_text">
439
440<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 Lattnerdaeb3232008-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>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000446
447<ul>
Gabor Greifaa53e562008-10-14 11:31:14 +0000448<li>The MSIL, IA64, Alpha, SPU, MIPS, and PIC16 backends are experimental.</li>
Duncan Sandsa73561c2008-06-08 20:18:35 +0000449<li>The llc "<tt>-filetype=asm</tt>" (the default) is the only supported
Chris Lattnerbd633de92008-02-06 06:30:34 +0000450 value for this option.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000451</ul>
452
453</div>
454
455<!-- ======================================================================= -->
456<div class="doc_subsection">
457 <a name="x86-be">Known problems with the X86 back-end</a>
458</div>
459
460<div class="doc_text">
461
462<ul>
Anton Korobeynikov77d15e22008-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 Lattnerd95b5962008-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 Sands8b4f3772008-06-08 19:38:43 +0000469 <li>Win64 code generation wasn't widely tested. Everything should work, but we
Anton Korobeynikov77d15e22008-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 Lattnerf06141a2008-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 Gohman3882ecb2008-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>
Dan Gohmanf17a25c2007-07-18 16:29:46 +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>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000490<li>The Linux PPC32/ABI support needs testing for the interpreter and static
491compilation, and lacks support for debug information.</li>
492</ul>
493
494</div>
495
496<!-- ======================================================================= -->
497<div class="doc_subsection">
498 <a name="arm-be">Known problems with the ARM back-end</a>
499</div>
500
501<div class="doc_text">
502
503<ul>
504<li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
Duncan Sands1827fa62007-09-26 15:59:54 +0000505processors, thumb programs can crash or produce wrong
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000506results (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
507<li>Compilation for ARM Linux OABI (old ABI) is supported, but not fully tested.
508</li>
Chris Lattnerd95b5962008-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
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000511programs compiled with LLVM. Please use more recent versions of QEMU.</li>
512</ul>
513
514</div>
515
516<!-- ======================================================================= -->
517<div class="doc_subsection">
518 <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 Lopes62d45d72008-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">
Dan Gohmanf17a25c2007-07-18 16:29:46 +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
556</ul>
557</div>
558
559<!-- ======================================================================= -->
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 Lattnerf06141a2008-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 Greif45fc8b12008-10-15 10:47:24 +0000569 are interested, please contact the LLVMdev mailing list.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000570</ul>
571
572</div>
573
574<!-- ======================================================================= -->
575<div class="doc_subsection">
576 <a name="c-be">Known problems with the C back-end</a>
577</div>
578
579<div class="doc_text">
580
581<ul>
Chris Lattner499c07c2008-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 Lattnere0194462007-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 Sandsa73561c2008-06-08 20:18:35 +0000586 C++ code compiled with llc or native compilers.</li>
Duncan Sandsbd0ad6e2008-02-10 13:40:55 +0000587<li>The C backend does not support all exception handling constructs.</li>
Duncan Sandse6e264c2009-02-25 11:51:54 +0000588<li>The C backend does not support arbitrary precision integers.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000589</ul>
590
591</div>
592
593
594<!-- ======================================================================= -->
595<div class="doc_subsection">
Chris Lattner499c07c2008-06-05 06:35:40 +0000596 <a name="c-fe">Known problems with the llvm-gcc C front-end</a>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000597</div>
598
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000599<div class="doc_text">
600
Chris Lattnere0798082008-02-06 18:00:06 +0000601<p>llvm-gcc does not currently support <a href="http://llvm.org/PR869">Link-Time
602Optimization</a> on most platforms "out-of-the-box". Please inquire on the
Gabor Greif45fc8b12008-10-15 10:47:24 +0000603LLVMdev mailing list if you are interested.</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000604
Chris Lattner499c07c2008-06-05 06:35:40 +0000605<p>The only major language feature of GCC not supported by llvm-gcc is
606 the <tt>__builtin_apply</tt> family of builtins. However, some extensions
607 are only supported on some targets. For example, trampolines are only
Duncan Sandsa73561c2008-06-08 20:18:35 +0000608 supported on some targets (these are used when you take the address of a
609 nested function).</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000610
Chris Lattner499c07c2008-06-05 06:35:40 +0000611<p>If you run into GCC extensions which are not supported, please let us know.
612</p>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000613
614</div>
615
616<!-- ======================================================================= -->
617<div class="doc_subsection">
Chris Lattner499c07c2008-06-05 06:35:40 +0000618 <a name="c++-fe">Known problems with the llvm-gcc C++ front-end</a>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000619</div>
620
621<div class="doc_text">
622
623<p>The C++ front-end is considered to be fully
624tested and works for a number of non-trivial programs, including LLVM
625itself, Qt, Mozilla, etc.</p>
626
627<ul>
Anton Korobeynikovd9a17932008-10-11 18:27:16 +0000628<li>Exception handling works well on the X86 and PowerPC targets. Currently
Chris Lattnerb1ad47c2008-11-10 05:40:34 +0000629 only Linux and Darwin targets are supported (both 32 and 64 bit).</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000630</ul>
631
632</div>
633
Chris Lattner6c8a1b82008-10-30 03:58:13 +0000634<!-- ======================================================================= -->
635<div class="doc_subsection">
636 <a name="fortran-fe">Known problems with the llvm-gcc Fortran front-end</a>
637</div>
638
639<div class="doc_text">
Gabor Greif1fc8fbc2008-11-04 21:50:59 +0000640<ul>
Chris Lattner6c8a1b82008-10-30 03:58:13 +0000641<li>Fortran support generally works, but there are still several unresolved bugs
642 in Bugzilla. Please see the tools/gfortran component for details.</li>
643
644<li>The Fortran front-end currently does not build on Darwin (without tweaks)
645 due to unresolved dependencies on the C front-end.</li>
Gabor Greif1fc8fbc2008-11-04 21:50:59 +0000646</ul>
Chris Lattner6c8a1b82008-10-30 03:58:13 +0000647</div>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000648
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000649<!-- ======================================================================= -->
650<div class="doc_subsection">
Chris Lattner499c07c2008-06-05 06:35:40 +0000651 <a name="ada-fe">Known problems with the llvm-gcc Ada front-end</a>
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000652</div>
653
654<div class="doc_text">
655The llvm-gcc 4.2 Ada compiler works fairly well, however this is not a mature
656technology and problems should be expected.
657<ul>
Duncan Sandsa73561c2008-06-08 20:18:35 +0000658<li>The Ada front-end currently only builds on X86-32. This is mainly due
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000659to lack of trampoline support (pointers to nested functions) on other platforms,
Duncan Sandsa73561c2008-06-08 20:18:35 +0000660however it <a href="http://llvm.org/PR2006">also fails to build on X86-64</a>
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000661which does support trampolines.</li>
662<li>The Ada front-end <a href="http://llvm.org/PR2007">fails to bootstrap</a>.
Duncan Sandsf73473e2009-02-25 11:59:06 +0000663This is due to lack of LLVM support for <tt>setjmp</tt>/<tt>longjmp</tt> style
664exception handling, which is used internally by the compiler.
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000665Workaround: configure with --disable-bootstrap.</li>
Duncan Sands2dbc2e82008-10-13 17:27:23 +0000666<li>The c380004, <a href="http://llvm.org/PR2010">c393010</a>
667and <a href="http://llvm.org/PR2421">cxg2021</a> ACATS tests fail
Duncan Sandsf73473e2009-02-25 11:59:06 +0000668(c380004 also fails with gcc-4.2 mainline).
669If the compiler is built with checks disabled then <a href="http://llvm.org/PR2010">c393010</a>
670causes the compiler to go into an infinite loop, using up all system memory.</li>
Duncan Sands2dbc2e82008-10-13 17:27:23 +0000671<li>Some gcc specific Ada tests continue to crash the compiler.</li>
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000672<li>The -E binder option (exception backtraces)
673<a href="http://llvm.org/PR1982">does not work</a> and will result in programs
674crashing if an exception is raised. Workaround: do not use -E.</li>
675<li>Only discrete types <a href="http://llvm.org/PR1981">are allowed to start
676or finish at a non-byte offset</a> in a record. Workaround: do not pack records
677or use representation clauses that result in a field of a non-discrete type
678starting or finishing in the middle of a byte.</li>
Chris Lattnerd95b5962008-06-08 21:19:07 +0000679<li>The <tt>lli</tt> interpreter <a href="http://llvm.org/PR2009">considers
680'main' as generated by the Ada binder to be invalid</a>.
681Workaround: hand edit the file to use pointers for <tt>argv</tt> and
682<tt>envp</tt> rather than integers.</li>
683<li>The <tt>-fstack-check</tt> option <a href="http://llvm.org/PR2008">is
684ignored</a>.</li>
Chris Lattnerdaeb3232008-02-12 06:29:45 +0000685</ul>
686</div>
687
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000688<!-- *********************************************************************** -->
689<div class="doc_section">
690 <a name="additionalinfo">Additional Information</a>
691</div>
692<!-- *********************************************************************** -->
693
694<div class="doc_text">
695
696<p>A wide variety of additional information is available on the <a
697href="http://llvm.org">LLVM web page</a>, in particular in the <a
698href="http://llvm.org/docs/">documentation</a> section. The web page also
699contains versions of the API documentation which is up-to-date with the
700Subversion version of the source code.
701You can access versions of these documents specific to this release by going
702into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
703
704<p>If you have any questions or comments about LLVM, please feel free to contact
705us via the <a href="http://llvm.org/docs/#maillist"> mailing
706lists</a>.</p>
707
708</div>
709
710<!-- *********************************************************************** -->
711
712<hr>
713<address>
714 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman947321d2008-12-11 17:34:48 +0000715 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000716 <a href="http://validator.w3.org/check/referer"><img
Misha Brukman947321d2008-12-11 17:34:48 +0000717 src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000718
719 <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
720 Last modified: $Date$
721</address>
722
723</body>
724</html>