Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / llvm / ef22f78c68d3f096b3c8aac2752ca8e3e25106a6 / . / docs / ReleaseNotes.html
blob: 36711cba983935a12d9bf94aa97ae4bef8b20b8d [file] [log] [blame]
Misha Brukman500bc302003-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 Spencer6454ed32004-11-18 18:38:58 +0000[diff] [blame]5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]6 <link rel="stylesheet" href="llvm.css" type="text/css">
Chad Rosiere6291d02011-05-27 22:50:46 +0000[diff] [blame]7 <title>LLVM 3.0 Release Notes</title>
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]8</head>
9<body>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]10
Chad Rosiere6291d02011-05-27 22:50:46 +0000[diff] [blame]11<h1>LLVM 3.0 Release Notes</h1>
Mikhail Glushenkovea65d7d2008-10-13 02:08:34 +0000[diff] [blame]12
Chris Lattner0e464a92010-03-17 04:02:39 +0000[diff] [blame]13<img align=right src="http://llvm.org/img/DragonSmall.png"
Gabor Greifee2187a2010-04-22 10:21:43 +0000[diff] [blame]14 width="136" height="136" alt="LLVM Dragon Logo">
Chris Lattner0e464a92010-03-17 04:02:39 +0000[diff] [blame]15
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]16<ol>
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]17 <li><a href="#intro">Introduction</a></li>
Chris Lattner96a445e2008-10-13 18:01:01 +0000[diff] [blame]18 <li><a href="#subproj">Sub-project Status Update</a></li>
Chad Rosiere6291d02011-05-27 22:50:46 +0000[diff] [blame]19 <li><a href="#externalproj">External Projects Using LLVM 3.0</a></li>
20 <li><a href="#whatsnew">What's New in LLVM 3.0?</a></li>
Chris Lattner4b538b92004-04-30 22:17:12 +0000[diff] [blame]21 <li><a href="GettingStarted.html">Installation Instructions</a></li>
Dan Gohman44aa9212008-10-14 16:23:02 +0000[diff] [blame]22 <li><a href="#knownproblems">Known Problems</a></li>
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]23 <li><a href="#additionalinfo">Additional Information</a></li>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]24</ol>
25
Chris Lattner7911ce22004-05-23 21:07:27 +0000[diff] [blame]26<div class="doc_author">
NAKAMURA Takumib9a33632011-04-09 02:13:37 +0000[diff] [blame]27 <p>Written by the <a href="http://llvm.org/">LLVM Team</a></p>
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]28</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]29
Chris Lattner49123fd2011-04-06 06:29:50 +0000[diff] [blame]30<!--
Chad Rosiere6291d02011-05-27 22:50:46 +0000[diff] [blame]31<h1 style="color:red">These are in-progress notes for the upcoming LLVM 3.0
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000[diff] [blame]32release.<br>
33You may prefer the
Chad Rosiere6291d02011-05-27 22:50:46 +0000[diff] [blame]34<a href="http://llvm.org/releases/2.9/docs/ReleaseNotes.html">LLVM 2.9
Dan Gohmanb44f6c62010-05-03 23:51:05 +0000[diff] [blame]35Release Notes</a>.</h1>
Chris Lattner49123fd2011-04-06 06:29:50 +0000[diff] [blame]36 -->
Jeffrey Yasskinbec48772010-01-28 01:14:43 +0000[diff] [blame]37
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]38<!-- *********************************************************************** -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]39<h2>
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]40 <a name="intro">Introduction</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]41</h2>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]42<!-- *********************************************************************** -->
43
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000[diff] [blame]44<div>
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]45
Chris Lattnerf6662f92008-10-13 17:57:36 +0000[diff] [blame]46<p>This document contains the release notes for the LLVM Compiler
Chad Rosiere6291d02011-05-27 22:50:46 +0000[diff] [blame]47Infrastructure, release 3.0. Here we describe the status of LLVM, including
Chris Lattnerf6662f92008-10-13 17:57:36 +0000[diff] [blame]48major improvements from the previous release and significant known problems.
Mikhail Glushenkovf795ef02009-03-01 18:09:47 +0000[diff] [blame]49All LLVM releases may be downloaded from the <a
Chris Lattnerf6662f92008-10-13 17:57:36 +0000[diff] [blame]50href="http://llvm.org/releases/">LLVM releases web site</a>.</p>
Chris Lattner19092612003-10-02 16:38:05 +0000[diff] [blame]51
Chris Lattner7506b1d2004-12-07 08:04:13 +0000[diff] [blame]52<p>For more information about LLVM, including information about the latest
Chris Lattnerc463b272005-10-29 07:07:09 +0000[diff] [blame]53release, please check out the <a href="http://llvm.org/">main LLVM
Chris Lattner47ad72c2003-10-07 21:38:31 +0000[diff] [blame]54web site</a>. If you have questions or comments, the <a
Chris Lattnerc66bfef2010-03-17 04:41:49 +0000[diff] [blame]55href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM Developer's
56Mailing List</a> is a good place to send them.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]57
Mikhail Glushenkovea65d7d2008-10-13 02:08:34 +0000[diff] [blame]58<p>Note that if you are reading this file from a Subversion checkout or the
Chris Lattner84977642007-09-21 03:54:09 +0000[diff] [blame]59main LLVM web page, this document applies to the <i>next</i> release, not the
Gabor Greiffa933f82008-10-14 11:00:32 +0000[diff] [blame]60current one. To see the release notes for a specific release, please see the
Chris Lattner84977642007-09-21 03:54:09 +0000[diff] [blame]61<a href="http://llvm.org/releases/">releases page</a>.</p>
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]62
63</div>
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]64
Chris Lattnere4dc1962011-04-05 23:22:33 +0000[diff] [blame]65<!-- Features that need text if they're finished for 3.1:
66 ARM EHABI
Chris Lattner914ce462010-04-22 06:28:20 +0000[diff] [blame]67 combiner-aa?
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]68 strong phi elim
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]69 loop dependence analysis
Chris Lattnere07043c2010-09-29 05:30:03 +0000[diff] [blame]70 CorrelatedValuePropagation
Chris Lattnere4dc1962011-04-05 23:22:33 +0000[diff] [blame]71 lib/Transforms/IPO/MergeFunctions.cpp => consider for 3.1.
Chris Lattneracce85d2008-02-10 07:46:44 +0000[diff] [blame]72 -->
Chris Lattnere07043c2010-09-29 05:30:03 +0000[diff] [blame]73
Chris Lattner96a445e2008-10-13 18:01:01 +0000[diff] [blame]74<!-- *********************************************************************** -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]75<h2>
Chris Lattner96a445e2008-10-13 18:01:01 +0000[diff] [blame]76 <a name="subproj">Sub-project Status Update</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]77</h2>
Chris Lattner96a445e2008-10-13 18:01:01 +0000[diff] [blame]78<!-- *********************************************************************** -->
Chris Lattnerea34f642008-06-08 21:34:41 +0000[diff] [blame]79
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000[diff] [blame]80<div>
Chris Lattner8348b472008-06-08 21:58:17 +0000[diff] [blame]81<p>
Chad Rosiere6291d02011-05-27 22:50:46 +0000[diff] [blame]82The LLVM 3.0 distribution currently consists of code from the core LLVM
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]83repository (which roughly includes the LLVM optimizers, code generators
84and supporting tools), the Clang repository and the llvm-gcc repository. In
85addition to this code, the LLVM Project includes other sub-projects that are in
86development. Here we include updates on these subprojects.
Bill Wendling63d8c552009-03-02 04:28:57 +0000[diff] [blame]87</p>
Chris Lattner96a445e2008-10-13 18:01:01 +0000[diff] [blame]88
Chris Lattner8348b472008-06-08 21:58:17 +0000[diff] [blame]89<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]90<h3>
Chris Lattnerfb97b2d2008-10-13 18:11:54 +0000[diff] [blame]91<a name="clang">Clang: C/C++/Objective-C Frontend Toolkit</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]92</h3>
Chris Lattner8348b472008-06-08 21:58:17 +0000[diff] [blame]93
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000[diff] [blame]94<div>
Chris Lattner8348b472008-06-08 21:58:17 +0000[diff] [blame]95
Chris Lattner095539f2010-04-26 17:42:18 +0000[diff] [blame]96<p><a href="http://clang.llvm.org/">Clang</a> is an LLVM front end for the C,
97C++, and Objective-C languages. Clang aims to provide a better user experience
98through expressive diagnostics, a high level of conformance to language
99standards, fast compilation, and low memory use. Like LLVM, Clang provides a
100modular, library-based architecture that makes it suitable for creating or
101integrating with other development tools. Clang is considered a
Chris Lattnere07043c2010-09-29 05:30:03 +0000[diff] [blame]102production-quality compiler for C, Objective-C, C++ and Objective-C++ on x86
Chris Lattner1efe27e2011-04-06 00:45:11 +0000[diff] [blame]103(32- and 64-bit), and for darwin/arm targets.</p>
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]104
Chad Rosiere6291d02011-05-27 22:50:46 +0000[diff] [blame]105<p>In the LLVM 3.0 time-frame, the Clang team has made many improvements:</p>
Douglas Gregorba087df2011-10-15 00:48:01 +0000[diff] [blame]106
107<ul>
108 <li>Greatly improved support for building C++ applications, with greater stability and better diagnostics.</li>
109
110 <li><a href="http://clang.llvm.org/cxx_status.html">Improved support</a> for the <a href="http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=50372 ">C++ 2011</a> standard, including implementations of non-static data member initializers, alias templates, delegating constructors, the range-based for loop, and implicitly-generated move constructors and move assignment operators, among others.</li>
111
112 <li>Implemented support for some features of the upcoming C1x standard, including static assertions and generic selections.</li>
113
114 <li>Better detection of include and linking paths for system headers and libraries, especially for Linux distributions.</li>
115
116 <li>Implemented support for <a href="http://clang.llvm.org/docs/AutomaticReferenceCounting.html">Automatic Reference Counting</a> for Objective-C.</li>
117
118 <li>Implemented a number of optimizations in <tt>libclang</tt>, the Clang C interface, to improve the performance of code completion and the mapping from source locations to abstract syntax tree nodes.</li>
119</ul>
120
Chris Lattner0a6f6d52011-04-05 07:19:28 +0000[diff] [blame]121
Duncan Sandsf3ba7af2011-04-06 08:07:40 +0000[diff] [blame]122<p>If Clang rejects your code but another compiler accepts it, please take a
Chris Lattner0a6f6d52011-04-05 07:19:28 +0000[diff] [blame]123look at the <a href="http://clang.llvm.org/compatibility.html">language
Duncan Sandsf3ba7af2011-04-06 08:07:40 +0000[diff] [blame]124compatibility</a> guide to make sure this is not intentional or a known issue.
Chris Lattner0a6f6d52011-04-05 07:19:28 +0000[diff] [blame]125</p>
Bill Wendling741748a2008-10-27 09:27:33 +0000[diff] [blame]126
Chris Lattnerfb97b2d2008-10-13 18:11:54 +0000[diff] [blame]127</div>
128
129<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]130<h3>
Duncan Sands528a5102011-04-04 11:09:08 +0000[diff] [blame]131<a name="dragonegg">DragonEgg: GCC front-ends, LLVM back-end</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]132</h3>
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]133
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000[diff] [blame]134<div>
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]135<p>
Duncan Sands528a5102011-04-04 11:09:08 +0000[diff] [blame]136<a href="http://dragonegg.llvm.org/">DragonEgg</a> is a
137<a href="http://gcc.gnu.org/wiki/plugins">gcc plugin</a> that replaces GCC's
138optimizers and code generators with LLVM's.
139Currently it requires a patched version of gcc-4.5.
140The plugin can target the x86-32 and x86-64 processor families and has been
141used successfully on the Darwin, FreeBSD and Linux platforms.
142The Ada, C, C++ and Fortran languages work well.
143The plugin is capable of compiling plenty of Obj-C, Obj-C++ and Java but it is
144not known whether the compiled code actually works or not!
Duncan Sands749fd832010-04-02 09:23:15 +0000[diff] [blame]145</p>
146
147<p>
Chad Rosiere6291d02011-05-27 22:50:46 +0000[diff] [blame]148The 3.0 release has the following notable changes:
Duncan Sands4b1da2b2010-09-30 17:37:34 +0000[diff] [blame]149<ul>
Chad Rosiere6291d02011-05-27 22:50:46 +0000[diff] [blame]150<!--
151<li></li>
152-->
Duncan Sands4b1da2b2010-09-30 17:37:34 +0000[diff] [blame]153</ul>
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]154
155</div>
156
Chris Lattner75547712010-10-03 23:49:06 +0000[diff] [blame]157<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]158<h3>
Chris Lattner75547712010-10-03 23:49:06 +0000[diff] [blame]159<a name="compiler-rt">compiler-rt: Compiler Runtime Library</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]160</h3>
Chris Lattner75547712010-10-03 23:49:06 +0000[diff] [blame]161
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000[diff] [blame]162<div>
Chris Lattner75547712010-10-03 23:49:06 +0000[diff] [blame]163<p>
164The new LLVM <a href="http://compiler-rt.llvm.org/">compiler-rt project</a>
165is a simple library that provides an implementation of the low-level
166target-specific hooks required by code generation and other runtime components.
167For example, when compiling for a 32-bit target, converting a double to a 64-bit
168unsigned integer is compiled into a runtime call to the "__fixunsdfdi"
169function. The compiler-rt library provides highly optimized implementations of
170this and other low-level routines (some are 3x faster than the equivalent
171libgcc routines).</p>
172
Chad Rosiere6291d02011-05-27 22:50:46 +0000[diff] [blame]173<p>In the LLVM 3.0 timeframe,</p>
Chris Lattner75547712010-10-03 23:49:06 +0000[diff] [blame]174
175</div>
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]176
177<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]178<h3>
Chris Lattnere07043c2010-09-29 05:30:03 +0000[diff] [blame]179<a name="lldb">LLDB: Low Level Debugger</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]180</h3>
Chris Lattnere07043c2010-09-29 05:30:03 +0000[diff] [blame]181
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000[diff] [blame]182<div>
Chris Lattnere07043c2010-09-29 05:30:03 +0000[diff] [blame]183<p>
Chris Lattner75547712010-10-03 23:49:06 +0000[diff] [blame]184<a href="http://lldb.llvm.org/">LLDB</a> is a brand new member of the LLVM
185umbrella of projects. LLDB is a next generation, high-performance debugger. It
186is built as a set of reusable components which highly leverage existing
187libraries in the larger LLVM Project, such as the Clang expression parser, the
188LLVM disassembler and the LLVM JIT.</p>
Chris Lattnere07043c2010-09-29 05:30:03 +0000[diff] [blame]189
190<p>
Chad Rosiere6291d02011-05-27 22:50:46 +0000[diff] [blame]191LLDB is has advanced by leaps and bounds in the 3.0 timeframe. It is
Chris Lattnerdf448a32011-04-06 00:56:12 +0000[diff] [blame]192dramatically more stable and useful, and includes both a new <a
193href="http://lldb.llvm.org/tutorial.html">tutorial</a> and a <a
194href="http://lldb.llvm.org/lldb-gdb.html">side-by-side comparison with
195GDB</a>.</p>
Chris Lattnere07043c2010-09-29 05:30:03 +0000[diff] [blame]196
197</div>
198
199<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]200<h3>
Chris Lattnere07043c2010-09-29 05:30:03 +0000[diff] [blame]201<a name="libc++">libc++: C++ Standard Library</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]202</h3>
Chris Lattnere07043c2010-09-29 05:30:03 +0000[diff] [blame]203
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000[diff] [blame]204<div>
Chris Lattnere07043c2010-09-29 05:30:03 +0000[diff] [blame]205<p>
Tobias Grossercdce44b2010-10-06 21:07:30 +0000[diff] [blame]206<a href="http://libcxx.llvm.org/">libc++</a> is another new member of the LLVM
Chris Lattner75547712010-10-03 23:49:06 +0000[diff] [blame]207family. It is an implementation of the C++ standard library, written from the
208ground up to specifically target the forthcoming C++'0X standard and focus on
209delivering great performance.</p>
Chris Lattnere07043c2010-09-29 05:30:03 +0000[diff] [blame]210
211<p>
Chad Rosiere6291d02011-05-27 22:50:46 +0000[diff] [blame]212In the LLVM 3.0 timeframe,</p>
Chris Lattner0a6f6d52011-04-05 07:19:28 +0000[diff] [blame]213
Chris Lattner2009c492011-04-06 00:59:18 +0000[diff] [blame]214<p>
215Like compiler_rt, libc++ is now <a href="DeveloperPolicy.html#license">dual
216 licensed</a> under the MIT and UIUC license, allowing it to be used more
217 permissively.
Chris Lattnere07043c2010-09-29 05:30:03 +0000[diff] [blame]218</p>
219
220</div>
221
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]222
Chris Lattner3d6a80a2011-04-07 03:08:22 +0000[diff] [blame]223<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]224<h3>
Chris Lattner3d6a80a2011-04-07 03:08:22 +0000[diff] [blame]225<a name="LLBrowse">LLBrowse: IR Browser</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]226</h3>
Daniel Dunbar97b01a82010-10-04 17:39:47 +0000[diff] [blame]227
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000[diff] [blame]228<div>
Chris Lattner3d6a80a2011-04-07 03:08:22 +0000[diff] [blame]229<p>
230<a href="http://llvm.org/svn/llvm-project/llbrowse/trunk/doc/LLBrowse.html">
231 LLBrowse</a> is an interactive viewer for LLVM modules. It can load any LLVM
232 module and displays its contents as an expandable tree view, facilitating an
233 easy way to inspect types, functions, global variables, or metadata nodes. It
234 is fully cross-platform, being based on the popular wxWidgets GUI toolkit.
235</p>
236</div>
237
238<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]239<h3>
Chris Lattner3d6a80a2011-04-07 03:08:22 +0000[diff] [blame]240<a name="vmkit">VMKit</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]241</h3>
Chris Lattner3d6a80a2011-04-07 03:08:22 +0000[diff] [blame]242
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000[diff] [blame]243<div>
Chris Lattner3d6a80a2011-04-07 03:08:22 +0000[diff] [blame]244<p>The <a href="http://vmkit.llvm.org/">VMKit project</a> is an implementation
245 of a Java Virtual Machine (Java VM or JVM) that uses LLVM for static and
Chad Rosiere6291d02011-05-27 22:50:46 +0000[diff] [blame]246 just-in-time compilation. As of LLVM 3.0, VMKit now supports generational
Chris Lattner3d6a80a2011-04-07 03:08:22 +0000[diff] [blame]247 garbage collectors. The garbage collectors are provided by the MMTk framework,
248 and VMKit can be configured to use one of the numerous implemented collectors
249 of MMTk.
250</p>
251</div>
252
253
Daniel Dunbar97b01a82010-10-04 17:39:47 +0000[diff] [blame]254<!--=========================================================================-->
Chris Lattner7a8e6c52011-04-05 18:38:45 +0000[diff] [blame]255<!--
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]256<h3>
Daniel Dunbar97b01a82010-10-04 17:39:47 +0000[diff] [blame]257<a name="klee">KLEE: A Symbolic Execution Virtual Machine</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]258</h3>
Daniel Dunbar97b01a82010-10-04 17:39:47 +0000[diff] [blame]259
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000[diff] [blame]260<div>
Daniel Dunbar97b01a82010-10-04 17:39:47 +0000[diff] [blame]261<p>
262<a href="http://klee.llvm.org/">KLEE</a> is a symbolic execution framework for
263programs in LLVM bitcode form. KLEE tries to symbolically evaluate "all" paths
264through the application and records state transitions that lead to fault
265states. This allows it to construct testcases that lead to faults and can even
266be used to verify some algorithms.
267</p>
268
Chris Lattnerbe2e1b52011-03-10 07:43:44 +0000[diff] [blame]269<p>UPDATE!</p>
Chris Lattner7a8e6c52011-04-05 18:38:45 +0000[diff] [blame]270</div>-->
Daniel Dunbar97b01a82010-10-04 17:39:47 +0000[diff] [blame]271
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000[diff] [blame]272</div>
Daniel Dunbar97b01a82010-10-04 17:39:47 +0000[diff] [blame]273
Chris Lattnerab68e9e2009-02-26 22:33:38 +0000[diff] [blame]274<!-- *********************************************************************** -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]275<h2>
Chad Rosiere6291d02011-05-27 22:50:46 +0000[diff] [blame]276 <a name="externalproj">External Open Source Projects Using LLVM 3.0</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]277</h2>
Chris Lattnerab68e9e2009-02-26 22:33:38 +0000[diff] [blame]278<!-- *********************************************************************** -->
279
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000[diff] [blame]280<div>
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]281
282<p>An exciting aspect of LLVM is that it is used as an enabling technology for
283 a lot of other language and tools projects. This section lists some of the
Chad Rosiere6291d02011-05-27 22:50:46 +0000[diff] [blame]284 projects that have already been updated to work with LLVM 3.0.</p>
Chris Lattner75547712010-10-03 23:49:06 +0000[diff] [blame]285
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000[diff] [blame]286<!--=========================================================================-->
Bill Wendling7be6bc52011-10-26 00:17:54 +0000[diff] [blame]287<h3>AddressSanitizer</h3>
288
289<div>
290
291<p><a href="http://code.google.com/p/address-sanitizer/">AddressSanitizer</a>
292 uses compiler instrumentation and a specialized malloc library to find C/C++
293 bugs such as use-after-free and out-of-bound accesses to heap, stack, and
294 globals. The key feature of the tool is speed: the average slowdown
295 introduced by AddressSanitizer is less than 2x.</p>
296
297</div>
298
299<!--=========================================================================-->
Bill Wendling29817ea2011-10-26 00:14:36 +0000[diff] [blame]300<h3>ClamAV</h3>
301
302<div>
Bill Wendlingf2a78332011-10-25 01:01:42 +0000[diff] [blame]303
Bill Wendling29817ea2011-10-26 00:14:36 +0000[diff] [blame]304<p><a href="http://www.clamav.net">Clam AntiVirus</a> is an open source (GPL)
305 anti-virus toolkit for UNIX, designed especially for e-mail scanning on mail
306 gateways.</p>
307
308<p>Since version 0.96 it
309 has <a href="http://vrt-sourcefire.blogspot.com/2010/09/introduction-to-clamavs-low-level.html">bytecode
310 signatures</a> that allow writing detections for complex malware.</p>
311
312<p>It uses LLVM's JIT to speed up the execution of bytecode on X86, X86-64,
313 PPC32/64, falling back to its own interpreter otherwise. The git version was
314 updated to work with LLVM 3.0.</p>
315
316</div>
317
318<!--=========================================================================-->
Bill Wendlingf2a78332011-10-25 01:01:42 +0000[diff] [blame]319<!-- FIXME: Comment out
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]320<h3>Crack Programming Language</h3>
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000[diff] [blame]321
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000[diff] [blame]322<div>
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000[diff] [blame]323<p>
324<a href="http://code.google.com/p/crack-language/">Crack</a> aims to provide the
325ease of development of a scripting language with the performance of a compiled
326language. The language derives concepts from C++, Java and Python, incorporating
327object-oriented programming, operator overloading and strong typing.</p>
328</div>
Bill Wendlingf2a78332011-10-25 01:01:42 +0000[diff] [blame]329-->
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000[diff] [blame]330
331<!--=========================================================================-->
Bill Wendlingf9778192011-10-26 00:09:55 +0000[diff] [blame]332<h3>Glasgow Haskell Compiler (GHC)</h3>
333
334<div>
335
336<p>GHC is an open source, state-of-the-art programming suite for Haskell, a
337 standard lazy functional programming language. It includes an optimizing
338 static compiler generating good code for a variety of platforms, together
339 with an interactive system for convenient, quick development.</p>
340
341<p>GHC 7.0 and onwards include an LLVM code generator, supporting LLVM 2.8 and
342 later. Since LLVM 2.9, GHC now includes experimental support for the ARM
343 platform with LLVM 3.0.</p>
344
345</div>
346
347<!--=========================================================================-->
Bill Wendlingf62333d2011-10-25 20:35:31 +0000[diff] [blame]348<h3>gwXscript</h3>
349
350<div>
351
352<p><a href="http://botwars.tk/gwscript/">gwXscript</a> is an object oriented,
Bill Wendling7c38de22011-10-26 04:24:15 +0000[diff] [blame]353 aspect oriented programming language which can create both executables (ELF,
Bill Wendlingf62333d2011-10-25 20:35:31 +0000[diff] [blame]354 EXE) and shared libraries (DLL, SO, DYNLIB). The compiler is implemented in
355 its own language and translates scripts into LLVM-IR which can be optimized
356 and translated into native code by the LLVM framework. Source code in
357 gwScript contains definitions that expand the namespaces. So you can build
358 your project and simply 'plug out' features by removing a file. The remaining
359 project does not leave scars since you directly separate concerns by the
360 'template' feature of gwX. It is also possible to add new features to a
361 project by just adding files and without editing the original project. This
362 language is used for example to create games or content management systems
363 that should be extendable.</p>
364
365<p>gwXscript is strongly typed and offers comfort with its native types string,
366 hash and array. You can easily write new libraries in gwXscript or native
367 code. gwXscript is type safe and users should not be able to crash your
368 program or execute malicious code except code that is eating CPU time.</p>
369
370</div>
371
372<!--=========================================================================-->
Bill Wendlingd4821b82011-10-26 00:16:17 +0000[diff] [blame]373<h3>Mono</h3>
374
375<div>
376
377<p>An open source, cross-platform implementation of C# and the CLR that is
378 binary compatible with Microsoft.NET. Has an optional, dynamically-loaded
379 LLVM code generation backend in Mini, the JIT compiler.</p>
380
381<p>Note that we use a Git mirror of LLVM with some patches. See:
382 https://github.com/mono/llvm</p>
383
384</div>
385
386<!--=========================================================================-->
Bill Wendlingba226272011-10-25 20:37:45 +0000[diff] [blame]387<h3>Portable OpenCL (pocl)</h3>
388
389<div>
390
391<p>Portable OpenCL is an open source implementation of the OpenCL standard which
392 can be easily adapted for new targets. One of the goals of the project is
393 improving performance portability of OpenCL programs, avoiding the need for
394 target-dependent manual optimizations. A "native" target is included, which
395 allows running OpenCL kernels on the host (CPU).</p>
396
397</div>
398
399<!--=========================================================================-->
Bill Wendling0bad98c2011-10-25 20:39:06 +0000[diff] [blame]400<h3>Pure</h3>
401
402<div>
403<p><a href="http://pure-lang.googlecode.com/">Pure</a> is an
404 algebraic/functional programming language based on term rewriting. Programs
405 are collections of equations which are used to evaluate expressions in a
406 symbolic fashion. The interpreter uses LLVM as a backend to JIT-compile Pure
407 programs to fast native code. Pure offers dynamic typing, eager and lazy
408 evaluation, lexical closures, a hygienic macro system (also based on term
409 rewriting), built-in list and matrix support (including list and matrix
410 comprehensions) and an easy-to-use interface to C and other programming
411 languages (including the ability to load LLVM bitcode modules, and inline C,
412 C++, Fortran and Faust code in Pure programs if the corresponding LLVM-enabled
413 compilers are installed).</p>
414
415<p>Pure version 0.48 has been tested and is known to work with LLVM 3.0
416 (and continues to work with older LLVM releases &gt;= 2.5).</p>
417
418</div>
419
420<!--=========================================================================-->
Bill Wendling537d85b2011-10-26 00:12:04 +0000[diff] [blame]421<h3>Renderscript</h3>
422
423<div>
424
425<p><a href="http://developer.android.com/guide/topics/renderscript/index.html">Renderscript</a>
426 is Android's advanced 3D graphics rendering and compute API. It provides a
427 portable C99-based language with extensions to facilitate common use cases
428 for enhancing graphics and thread level parallelism. The Renderscript
429 compiler frontend is based on Clang/LLVM. It emits a portable bitcode format
430 for the actual compiled script code, as well as reflects a Java interface for
431 developers to control the execution of the compiled bitcode. Executable
432 machine code is then generated from this bitcode by an LLVM backend on the
433 device. Renderscript is thus able to provide a mechanism by which Android
434 developers can improve performance of their applications while retaining
435 portability.</p>
436
437</div>
438
439<!--=========================================================================-->
Bill Wendling7d5b6212011-10-25 20:40:26 +0000[diff] [blame]440<h3>SAFECode</h3>
441
442<div>
443
444<p><a href="http://safecode.cs.illinois.edu">SAFECode</a> is a memory safe C/C++
445 compiler built using LLVM. It takes standard, unannotated C/C++ code,
446 analyzes the code to ensure that memory accesses and array indexing
447 operations are safe, and instruments the code with run-time checks when
448 safety cannot be proven statically. SAFECode can be used as a debugging aid
449 (like Valgrind) to find and repair memory safety bugs. It can also be used
450 to protect code from security attacks at run-time.</p>
451
452</div>
453
454<!--=========================================================================-->
Bill Wendling02b77b72011-10-26 07:38:19 +0000[diff] [blame]455<h3>The Stupid D Compiler (SDC)</h3>
456
457<div>
458
459<p><a href="https://github.com/bhelyer/SDC">The Stupid D Compiler</a> is a
460 project seeking to write a self-hosting compiler for the D programming
461 language without using the frontend of the reference compiler (DMD).</p>
462
463</div>
464
465<!--=========================================================================-->
Bill Wendling2d7b4af2011-10-25 20:24:32 +0000[diff] [blame]466<h3>TTA-based Co-design Environment (TCE)</h3>
467
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000[diff] [blame]468<div>
Bill Wendling2d7b4af2011-10-25 20:24:32 +0000[diff] [blame]469
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000[diff] [blame]470<p>TCE is a toolset for designing application-specific processors (ASP) based on
Bill Wendling2d7b4af2011-10-25 20:24:32 +0000[diff] [blame]471 the Transport triggered architecture (TTA). The toolset provides a complete
472 co-design flow from C/C++ programs down to synthesizable VHDL and parallel
473 program binaries. Processor customization points include the register files,
474 function units, supported operations, and the interconnection network.</p>
475
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000[diff] [blame]476<p>TCE uses Clang and LLVM for C/C++ language support, target independent
Bill Wendling2d7b4af2011-10-25 20:24:32 +0000[diff] [blame]477 optimizations and also for parts of code generation. It generates new
478 LLVM-based code generators <i>on the fly</i> for the designed TTA processors
479 and loads them in to the compiler backend as runtime libraries to avoid
480 per-target recompilation of larger parts of the compiler chain.</p>
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000[diff] [blame]481</div>
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000[diff] [blame]482
483
484<!--=========================================================================-->
Bill Wendling628c2662011-10-25 20:27:37 +0000[diff] [blame]485<h3>Tart Programming Language</h3>
486
487<div>
488
489<p><a href="http://code.google.com/p/tart/">Tart</a> is a general-purpose,
490 strongly typed programming language designed for application
491 developers. Strongly inspired by Python and C#, Tart focuses on practical
492 solutions for the professional software developer, while avoiding the clutter
493 and boilerplate of legacy languages like Java and C++. Although Tart is still
494 in development, the current implementation supports many features expected of
495 a modern programming language, such as garbage collection, powerful
496 bidirectional type inference, a greatly simplified syntax for template
497 metaprogramming, closures and function literals, reflection, operator
498 overloading, explicit mutability and immutability, and much more. Tart is
499 flexible enough to accommodate a broad range of programming styles and
500 philosophies, while maintaining a strong commitment to simplicity, minimalism
501 and elegance in design.</p>
502
503</div>
504
505<!--=========================================================================-->
Bill Wendling644ce532011-10-26 09:25:01 +0000[diff] [blame]506<h3>ThreadSanitizer</h3>
507
508<div>
509
510<p><a href="http://code.google.com/p/data-race-test/">ThreadSanitizer</a> is a
511 data race detector for (mostly) C and C++ code, available for Linux, Mac OS
512 and Windows. On different systems, we use binary instrumentation frameworks
513 (Valgrind, Pin and DynamoRio) as frontends that generate the program events
514 for the race detection algorithm. On Linux, there's an option of using
515 LLVM-based compile-time instrumentation.</p>
516
517</div>
518
519<!--=========================================================================-->
Bill Wendling8a924c62011-10-26 07:42:45 +0000[diff] [blame]520<h3>The ZooLib C++ Cross-Platform Application Framework</h3>
521
522<div>
523
524<p><a href="http://www.zoolib.org/">ZooLib</a> is Open Source under the MIT
525 License. It provides GUI, filesystem access, TCP networking, thread-safe
526 memory management, threading and locking for Mac OS X, Classic Mac OS,
527 Microsoft Windows, POSIX operating systems with X11, BeOS, Haiku, Apple's iOS
528 and Research in Motion's BlackBerry.</p>
529
530<p>My current work is to use CLang's static analyzer to improve ZooLib's code
531 quality. I also plan to set up LLVM compiles of the demo programs and test
532 programs using CLang and LLVM on all the platforms that CLang, LLVM and
533 ZooLib all support.</p>
534
535</div>
536
537<!--=========================================================================-->
Bill Wendlingf2a78332011-10-25 01:01:42 +0000[diff] [blame]538<!--
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]539<h3>PinaVM</h3>
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000[diff] [blame]540
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000[diff] [blame]541<div>
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000[diff] [blame]542<p><a href="http://gitorious.org/pinavm/pages/Home">PinaVM</a> is an open
543source, <a href="http://www.systemc.org/">SystemC</a> front-end. Unlike many
544other front-ends, PinaVM actually executes the elaboration of the
545program analyzed using LLVM's JIT infrastructure. It later enriches the
546bitcode with SystemC-specific information.</p>
547</div>
Bill Wendlingf2a78332011-10-25 01:01:42 +0000[diff] [blame]548-->
549
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000[diff] [blame]550
551<!--=========================================================================-->
Bill Wendlingf2a78332011-10-25 01:01:42 +0000[diff] [blame]552<!--
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]553<h3 id="icedtea">IcedTea Java Virtual Machine Implementation</h3>
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000[diff] [blame]554
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000[diff] [blame]555<div>
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000[diff] [blame]556<p>
557<a href="http://icedtea.classpath.org/wiki/Main_Page">IcedTea</a> provides a
558harness to build OpenJDK using only free software build tools and to provide
559replacements for the not-yet free parts of OpenJDK. One of the extensions that
560IcedTea provides is a new JIT compiler named <a
561href="http://icedtea.classpath.org/wiki/ZeroSharkFaq">Shark</a> which uses LLVM
562to provide native code generation without introducing processor-dependent
563code.
564</p>
565
566<p> OpenJDK 7 b112, IcedTea6 1.9 and IcedTea7 1.13 and later have been tested
Chad Rosiere6291d02011-05-27 22:50:46 +0000[diff] [blame]567and are known to work with LLVM 3.0 (and continue to work with older LLVM
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000[diff] [blame]568releases &gt;= 2.6 as well).</p>
569</div>
Bill Wendlingf2a78332011-10-25 01:01:42 +0000[diff] [blame]570-->
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000[diff] [blame]571
572<!--=========================================================================-->
Bill Wendlingf2a78332011-10-25 01:01:42 +0000[diff] [blame]573<!--
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]574<h3>Polly - Polyhedral optimizations for LLVM</h3>
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000[diff] [blame]575
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000[diff] [blame]576<div>
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000[diff] [blame]577<p>Polly is a project that aims to provide advanced memory access optimizations
578to better take advantage of SIMD units, cache hierarchies, multiple cores or
579even vector accelerators for LLVM. Built around an abstract mathematical
580description based on Z-polyhedra, it provides the infrastructure to develop
581advanced optimizations in LLVM and to connect complex external optimizers. In
582its first year of existence Polly already provides an exact value-based
583dependency analysis as well as basic SIMD and OpenMP code generation support.
584Furthermore, Polly can use PoCC(Pluto) an advanced optimizer for data-locality
585and parallelism.</p>
586</div>
Bill Wendlingf2a78332011-10-25 01:01:42 +0000[diff] [blame]587-->
Chris Lattner75547712010-10-03 23:49:06 +0000[diff] [blame]588
Chris Lattner0fa5da92011-04-06 16:14:25 +0000[diff] [blame]589<!--=========================================================================-->
Bill Wendlingf2a78332011-10-25 01:01:42 +0000[diff] [blame]590<!--
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]591<h3>Rubinius</h3>
Chris Lattner0fa5da92011-04-06 16:14:25 +0000[diff] [blame]592
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000[diff] [blame]593<div>
Chris Lattner0fa5da92011-04-06 16:14:25 +0000[diff] [blame]594 <p><a href="http://github.com/evanphx/rubinius">Rubinius</a> is an environment
595 for running Ruby code which strives to write as much of the implementation in
596 Ruby as possible. Combined with a bytecode interpreting VM, it uses LLVM to
597 optimize and compile ruby code down to machine code. Techniques such as type
598 feedback, method inlining, and deoptimization are all used to remove dynamism
599 from ruby execution and increase performance.</p>
600</div>
Bill Wendlingf2a78332011-10-25 01:01:42 +0000[diff] [blame]601-->
Chris Lattner0fa5da92011-04-06 16:14:25 +0000[diff] [blame]602
Chris Lattnera844a3e2011-04-07 03:09:21 +0000[diff] [blame]603<!--=========================================================================-->
Bill Wendlingf2a78332011-10-25 01:01:42 +0000[diff] [blame]604<!--
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]605<h3>
Chris Lattnera844a3e2011-04-07 03:09:21 +0000[diff] [blame]606<a name="FAUST">FAUST Real-Time Audio Signal Processing Language</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]607</h3>
Chris Lattnere0518442010-10-01 06:34:49 +0000[diff] [blame]608
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000[diff] [blame]609<div>
Chris Lattnera844a3e2011-04-07 03:09:21 +0000[diff] [blame]610<p>
611<a href="http://faust.grame.fr">FAUST</a> is a compiled language for real-time
612audio signal processing. The name FAUST stands for Functional AUdio STream. Its
613programming model combines two approaches: functional programming and block
614diagram composition. In addition with the C, C++, JAVA output formats, the
Chad Rosiere6291d02011-05-27 22:50:46 +0000[diff] [blame]615Faust compiler can now generate LLVM bitcode, and works with LLVM 2.7-3.0.</p>
Chris Lattnera844a3e2011-04-07 03:09:21 +0000[diff] [blame]616
617</div>
Bill Wendlingf2a78332011-10-25 01:01:42 +0000[diff] [blame]618-->
Chris Lattnera844a3e2011-04-07 03:09:21 +0000[diff] [blame]619
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000[diff] [blame]620</div>
621
Chris Lattner8348b472008-06-08 21:58:17 +0000[diff] [blame]622<!-- *********************************************************************** -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]623<h2>
Chad Rosiere6291d02011-05-27 22:50:46 +0000[diff] [blame]624 <a name="whatsnew">What's New in LLVM 3.0?</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]625</h2>
Chris Lattner8348b472008-06-08 21:58:17 +0000[diff] [blame]626<!-- *********************************************************************** -->
627
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000[diff] [blame]628<div>
Chris Lattnerf8e0b4e2008-06-08 22:59:35 +0000[diff] [blame]629
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]630<p>This release includes a huge number of bug fixes, performance tweaks and
Chris Lattnerf6662f92008-10-13 17:57:36 +0000[diff] [blame]631minor improvements. Some of the major improvements and new features are listed
632in this section.
Chris Lattnerf8e0b4e2008-06-08 22:59:35 +0000[diff] [blame]633</p>
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]634
Chris Lattner914ce462010-04-22 06:28:20 +0000[diff] [blame]635<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]636<h3>
Chris Lattner252b83d2008-02-06 18:00:06 +0000[diff] [blame]637<a name="majorfeatures">Major New Features</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]638</h3>
Chris Lattner252b83d2008-02-06 18:00:06 +0000[diff] [blame]639
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000[diff] [blame]640<div>
Chris Lattner252b83d2008-02-06 18:00:06 +0000[diff] [blame]641
Chad Rosiere6291d02011-05-27 22:50:46 +0000[diff] [blame]642<p>LLVM 3.0 includes several major new capabilities:</p>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000[diff] [blame]643
644<ul>
Chris Lattner1efe27e2011-04-06 00:45:11 +0000[diff] [blame]645
Chad Rosiere6291d02011-05-27 22:50:46 +0000[diff] [blame]646<!--
647<li></li>
648-->
Chris Lattner7a8e6c52011-04-05 18:38:45 +0000[diff] [blame]649
Chris Lattner8170c102008-02-10 08:18:42 +0000[diff] [blame]650</ul>
Chris Lattner0a6f6d52011-04-05 07:19:28 +0000[diff] [blame]651
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000[diff] [blame]652</div>
653
Chris Lattner84977642007-09-21 03:54:09 +0000[diff] [blame]654<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]655<h3>
Chris Lattner917cc712009-03-02 02:37:32 +0000[diff] [blame]656<a name="coreimprovements">LLVM IR and Core Improvements</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]657</h3>
Chris Lattnerf304ffc2008-02-10 08:17:19 +0000[diff] [blame]658
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000[diff] [blame]659<div>
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]660<p>LLVM IR has several new features for better support of new targets and that
661expose new optimization opportunities:</p>
Chris Lattnerf304ffc2008-02-10 08:17:19 +0000[diff] [blame]662
Chris Lattner791f77b2008-06-05 06:25:56 +0000[diff] [blame]663<ul>
Chad Rosiere6291d02011-05-27 22:50:46 +0000[diff] [blame]664<!--
665<li></li>
666-->
Chris Lattnerf304ffc2008-02-10 08:17:19 +0000[diff] [blame]667</ul>
Mikhail Glushenkovea65d7d2008-10-13 02:08:34 +0000[diff] [blame]668
Chris Lattnerf304ffc2008-02-10 08:17:19 +0000[diff] [blame]669</div>
670
671<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]672<h3>
Chris Lattneracce85d2008-02-10 07:46:44 +0000[diff] [blame]673<a name="optimizer">Optimizer Improvements</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]674</h3>
Chris Lattneracce85d2008-02-10 07:46:44 +0000[diff] [blame]675
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000[diff] [blame]676<div>
Chris Lattneracce85d2008-02-10 07:46:44 +0000[diff] [blame]677
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]678<p>In addition to a large array of minor performance tweaks and bug fixes, this
Chris Lattnerf3013872008-10-13 21:50:36 +0000[diff] [blame]679release includes a few major enhancements and additions to the optimizers:</p>
Chris Lattneracce85d2008-02-10 07:46:44 +0000[diff] [blame]680
681<ul>
Chad Rosiere6291d02011-05-27 22:50:46 +0000[diff] [blame]682<!--
683<li></li>
684-->
Chris Lattnerc5ac61d2011-04-06 05:50:04 +0000[diff] [blame]685</li>
Chris Lattner1efe27e2011-04-06 00:45:11 +0000[diff] [blame]686
Chris Lattner11b66112010-10-04 02:42:39 +0000[diff] [blame]687</ul>
688
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]689</div>
Chris Lattner917cc712009-03-02 02:37:32 +0000[diff] [blame]690
Chris Lattner0b832202008-06-08 02:45:07 +0000[diff] [blame]691<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]692<h3>
Chris Lattner4ba2b652010-09-30 16:31:33 +0000[diff] [blame]693<a name="mc">MC Level Improvements</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]694</h3>
Chris Lattner4ba2b652010-09-30 16:31:33 +0000[diff] [blame]695
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000[diff] [blame]696<div>
Chris Lattner4ba2b652010-09-30 16:31:33 +0000[diff] [blame]697<p>
Chris Lattner7d9b6b42010-10-02 21:59:30 +0000[diff] [blame]698The LLVM Machine Code (aka MC) subsystem was created to solve a number
Chris Lattner4ba2b652010-09-30 16:31:33 +0000[diff] [blame]699of problems in the realm of assembly, disassembly, object file format handling,
700and a number of other related areas that CPU instruction-set level tools work
Chris Lattner7d9b6b42010-10-02 21:59:30 +0000[diff] [blame]701in.</p>
702
Chris Lattner7d9b6b42010-10-02 21:59:30 +0000[diff] [blame]703<ul>
Chad Rosiere6291d02011-05-27 22:50:46 +0000[diff] [blame]704<!--
705<li></li>
706-->
Chris Lattner7d9b6b42010-10-02 21:59:30 +0000[diff] [blame]707</ul>
708
709<p>For more information, please see the <a
Chris Lattner4ba2b652010-09-30 16:31:33 +0000[diff] [blame]710href="http://blog.llvm.org/2010/04/intro-to-llvm-mc-project.html">Intro to the
711LLVM MC Project Blog Post</a>.
712</p>
713
NAKAMURA Takumi45c435a2011-04-05 08:24:22 +0000[diff] [blame]714</div>
Chris Lattner4ba2b652010-09-30 16:31:33 +0000[diff] [blame]715
Chris Lattner4ba2b652010-09-30 16:31:33 +0000[diff] [blame]716<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]717<h3>
Chris Lattner511433e2009-03-02 03:24:11 +0000[diff] [blame]718<a name="codegen">Target Independent Code Generator Improvements</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]719</h3>
Chris Lattner0b832202008-06-08 02:45:07 +0000[diff] [blame]720
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000[diff] [blame]721<div>
Chris Lattner0b832202008-06-08 02:45:07 +0000[diff] [blame]722
Mikhail Glushenkovf795ef02009-03-01 18:09:47 +0000[diff] [blame]723<p>We have put a significant amount of work into the code generator
724infrastructure, which allows us to implement more aggressive algorithms and make
725it run faster:</p>
Chris Lattner0b832202008-06-08 02:45:07 +0000[diff] [blame]726
727<ul>
Chad Rosiere6291d02011-05-27 22:50:46 +0000[diff] [blame]728<!--
729<li></li>
730-->
Chris Lattner84977642007-09-21 03:54:09 +0000[diff] [blame]731</ul>
Chris Lattner84977642007-09-21 03:54:09 +0000[diff] [blame]732</div>
733
Chris Lattner917cc712009-03-02 02:37:32 +0000[diff] [blame]734<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]735<h3>
Chris Lattner917cc712009-03-02 02:37:32 +0000[diff] [blame]736<a name="x86">X86-32 and X86-64 Target Improvements</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]737</h3>
Chris Lattner917cc712009-03-02 02:37:32 +0000[diff] [blame]738
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000[diff] [blame]739<div>
Chris Lattner7714c912010-10-04 04:39:25 +0000[diff] [blame]740<p>New features and major changes in the X86 target include:
Chris Lattner917cc712009-03-02 02:37:32 +0000[diff] [blame]741</p>
742
743<ul>
Chad Rosierf94c9c12011-05-27 20:13:10 +0000[diff] [blame]744<li>The CRC32 intrinsics have been renamed. The intrinsics were previously
745 @llvm.x86.sse42.crc32.[8|16|32] and @llvm.x86.sse42.crc64.[8|64]. They have
746 been renamed to @llvm.x86.sse42.crc32.32.[8|16|32] and
747 @llvm.x86.sse42.crc32.64.[8|64].</li>
748
Chris Lattner917cc712009-03-02 02:37:32 +0000[diff] [blame]749</ul>
750
Chris Lattner917cc712009-03-02 02:37:32 +0000[diff] [blame]751</div>
Chris Lattner84977642007-09-21 03:54:09 +0000[diff] [blame]752
753<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]754<h3>
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]755<a name="ARM">ARM Target Improvements</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]756</h3>
Chris Lattnerc441fb82009-03-01 02:30:21 +0000[diff] [blame]757
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000[diff] [blame]758<div>
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]759<p>New features of the ARM target include:
760</p>
Chris Lattnerc441fb82009-03-01 02:30:21 +0000[diff] [blame]761
762<ul>
Chad Rosiere6291d02011-05-27 22:50:46 +0000[diff] [blame]763<!--
764<li></li>
765-->
Bob Wilsone8472772010-09-13 17:39:35 +0000[diff] [blame]766</ul>
Chris Lattner61358ab2009-10-13 17:48:04 +0000[diff] [blame]767</div>
Chris Lattner1efe27e2011-04-06 00:45:11 +0000[diff] [blame]768
769<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]770<h3>
Chris Lattner1efe27e2011-04-06 00:45:11 +0000[diff] [blame]771<a name="OtherTS">Other Target Specific Improvements</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]772</h3>
Chris Lattnerc441fb82009-03-01 02:30:21 +0000[diff] [blame]773
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000[diff] [blame]774<div>
Chris Lattner1efe27e2011-04-06 00:45:11 +0000[diff] [blame]775<ul>
Chad Rosiere6291d02011-05-27 22:50:46 +0000[diff] [blame]776<!--
777<li></li>
778-->
Chris Lattner1efe27e2011-04-06 00:45:11 +0000[diff] [blame]779</ul>
780</div>
Chris Lattner77d29b12008-06-05 08:02:49 +0000[diff] [blame]781
782<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]783<h3>
Chris Lattnerf6662f92008-10-13 17:57:36 +0000[diff] [blame]784<a name="changes">Major Changes and Removed Features</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]785</h3>
Chris Lattnerf6662f92008-10-13 17:57:36 +0000[diff] [blame]786
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000[diff] [blame]787<div>
Chris Lattnerf6662f92008-10-13 17:57:36 +0000[diff] [blame]788
Bill Wendling2626dba2011-08-03 22:18:20 +0000[diff] [blame]789<p>If you're already an LLVM user or developer with out-of-tree changes based on
790 LLVM 2.9, this section lists some "gotchas" that you may run into upgrading
791 from the previous release.</p>
Chris Lattnerf6662f92008-10-13 17:57:36 +0000[diff] [blame]792
793<ul>
Eric Christopher90d6ec52011-09-28 19:47:28 +0000[diff] [blame]794 <li>The <code>LLVMC</code> front end code was removed while separating
795 out language independence.</li>
Jay Foadf42e9b22011-08-04 10:43:43 +0000[diff] [blame]796 <li>The <code>LowerSetJmp</code> pass wasn't used effectively by any
797 target and has been removed.</li>
Rafael Espindolaf940a1a2011-08-30 23:03:45 +0000[diff] [blame]798 <li>The old <code>TailDup</code> pass was not used in the standard pipeline
799 and was unable to update ssa form, so it has been removed.
Eli Friedmanf03bb262011-08-12 22:50:01 +0000[diff] [blame]800 <li>The syntax of volatile loads and stores in IR has been changed to
801 "<code>load volatile</code>"/"<code>store volatile</code>". The old
802 syntax ("<code>volatile load</code>"/"<code>volatile store</code>")
803 is still accepted, but is now considered deprecated.</li>
Eli Friedman526e1bb2011-10-26 00:55:23 +0000[diff] [blame]804 <li>The old atomic intrinscs (<code>llvm.memory.barrier</code> and
805 <code>llvm.atomic.*</code>) are now gone. Please use the new atomic
806 instructions, described in the <a href="Atomics.html">atomics guide</a>.
Devang Patelb34dd132008-10-14 20:03:43 +0000[diff] [blame]807</ul>
Chris Lattnerf6662f92008-10-13 17:57:36 +0000[diff] [blame]808
NAKAMURA Takumi2026de22011-08-22 23:22:05 +0000[diff] [blame]809<h4>Windows (32-bit)</h4>
810<div>
811<ul>
812 <li>On Win32(MinGW32 and MSVC), Windows 2000 will not be supported.
813 Windows XP or higher is required.</li>
814</ul>
815</div>
816
Chris Lattnerf6662f92008-10-13 17:57:36 +0000[diff] [blame]817</div>
818
Daniel Dunbarf0233c62010-10-04 20:11:41 +0000[diff] [blame]819<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]820<h3>
Chris Lattner1efe27e2011-04-06 00:45:11 +0000[diff] [blame]821<a name="api_changes">Internal API Changes</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]822</h3>
Daniel Dunbarf0233c62010-10-04 20:11:41 +0000[diff] [blame]823
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000[diff] [blame]824<div>
Daniel Dunbarf0233c62010-10-04 20:11:41 +0000[diff] [blame]825
Chris Lattner1efe27e2011-04-06 00:45:11 +0000[diff] [blame]826<p>In addition, many APIs have changed in this release. Some of the major
Bill Wendling16005252011-08-02 06:20:17 +0000[diff] [blame]827 LLVM API changes are:</p>
Daniel Dunbarf0233c62010-10-04 20:11:41 +0000[diff] [blame]828
829<ul>
Chris Lattnerd1324302011-07-18 04:56:02 +0000[diff] [blame]830<li>The biggest and most pervasive change is that llvm::Type's are no longer
831 returned or accepted as 'const' values. Instead, just pass around non-const
832 Type's.</li>
833
Jay Foad558d3762011-07-14 09:19:05 +0000[diff] [blame]834<li><code>PHINode::reserveOperandSpace</code> has been removed. Instead, you
835 must specify how many operands to reserve space for when you create the
836 PHINode, by passing an extra argument into <code>PHINode::Create</code>.</li>
837
838<li>PHINodes no longer store their incoming BasicBlocks as operands. Instead,
839 the list of incoming BasicBlocks is stored separately, and can be accessed
840 with new functions <code>PHINode::block_begin</code>
841 and <code>PHINode::block_end</code>.</li>
842
843<li>Various functions now take an <code>ArrayRef</code> instead of either a pair
844 of pointers (or iterators) to the beginning and end of a range, or a pointer
845 and a length. Others now return an <code>ArrayRef</code> instead of a
846 reference to a <code>SmallVector</code> or <code>std::vector</code>. These
847 include:
848<ul>
849<!-- Please keep this list sorted. -->
Jay Foada3efbb12011-07-15 08:37:34 +0000[diff] [blame]850<li><code>CallInst::Create</code></li>
Jay Foad558d3762011-07-14 09:19:05 +0000[diff] [blame]851<li><code>ComputeLinearIndex</code> (in <code>llvm/CodeGen/Analysis.h</code>)</li>
852<li><code>ConstantArray::get</code></li>
853<li><code>ConstantExpr::getExtractElement</code></li>
Jay Foaddab3d292011-07-21 14:31:17 +0000[diff] [blame]854<li><code>ConstantExpr::getGetElementPtr</code></li>
855<li><code>ConstantExpr::getInBoundsGetElementPtr</code></li>
Jay Foad558d3762011-07-14 09:19:05 +0000[diff] [blame]856<li><code>ConstantExpr::getIndices</code></li>
857<li><code>ConstantExpr::getInsertElement</code></li>
858<li><code>ConstantExpr::getWithOperands</code></li>
Jay Foad1d2f5692011-07-19 13:32:40 +0000[diff] [blame]859<li><code>ConstantFoldCall</code> (in <code>llvm/Analysis/ConstantFolding.h</code>)</li>
860<li><code>ConstantFoldInstOperands</code> (in <code>llvm/Analysis/ConstantFolding.h</code>)</li>
Jay Foad558d3762011-07-14 09:19:05 +0000[diff] [blame]861<li><code>ConstantVector::get</code></li>
862<li><code>DIBuilder::createComplexVariable</code></li>
863<li><code>DIBuilder::getOrCreateArray</code></li>
864<li><code>ExtractValueInst::Create</code></li>
865<li><code>ExtractValueInst::getIndexedType</code></li>
866<li><code>ExtractValueInst::getIndices</code></li>
867<li><code>FindInsertedValue</code> (in <code>llvm/Analysis/ValueTracking.h</code>)</li>
Jay Foadca12a212011-07-19 14:42:50 +0000[diff] [blame]868<li><code>gep_type_begin</code> (in <code>llvm/Support/GetElementPtrTypeIterator.h</code>)</li>
869<li><code>gep_type_end</code> (in <code>llvm/Support/GetElementPtrTypeIterator.h</code>)</li>
Jay Foada9203102011-07-25 09:48:08 +0000[diff] [blame]870<li><code>GetElementPtrInst::Create</code></li>
871<li><code>GetElementPtrInst::CreateInBounds</code></li>
872<li><code>GetElementPtrInst::getIndexedType</code></li>
Jay Foadb60e8512011-07-21 14:42:51 +0000[diff] [blame]873<li><code>InsertValueInst::Create</code></li>
874<li><code>InsertValueInst::getIndices</code></li>
875<li><code>InvokeInst::Create</code></li>
Jay Foada3efbb12011-07-15 08:37:34 +0000[diff] [blame]876<li><code>IRBuilder::CreateCall</code></li>
Jay Foad558d3762011-07-14 09:19:05 +0000[diff] [blame]877<li><code>IRBuilder::CreateExtractValue</code></li>
Jay Foad0a2a60a2011-07-22 08:16:57 +0000[diff] [blame]878<li><code>IRBuilder::CreateGEP</code></li>
879<li><code>IRBuilder::CreateInBoundsGEP</code></li>
Jay Foad558d3762011-07-14 09:19:05 +0000[diff] [blame]880<li><code>IRBuilder::CreateInsertValue</code></li>
Jay Foada3efbb12011-07-15 08:37:34 +0000[diff] [blame]881<li><code>IRBuilder::CreateInvoke</code></li>
Jay Foad558d3762011-07-14 09:19:05 +0000[diff] [blame]882<li><code>MDNode::get</code></li>
883<li><code>MDNode::getIfExists</code></li>
884<li><code>MDNode::getTemporary</code></li>
885<li><code>MDNode::getWhenValsUnresolved</code></li>
Jay Foadb9b54eb2011-07-19 15:07:52 +0000[diff] [blame]886<li><code>SimplifyGEPInst</code> (in <code>llvm/Analysis/InstructionSimplify.h</code>)</li>
Jay Foad8fbbb392011-07-19 14:01:37 +0000[diff] [blame]887<li><code>TargetData::getIndexedOffset</code></li>
Jay Foad558d3762011-07-14 09:19:05 +0000[diff] [blame]888</ul></li>
889
890<li>All forms of <code>StringMap::getOrCreateValue</code> have been remove
891 except for the one which takes a <code>StringRef</code>.</li>
892
Bill Wendling16005252011-08-02 06:20:17 +0000[diff] [blame]893<li>The <code>LLVMBuildUnwind</code> function from the C API was removed. The
894 LLVM <code>unwind</code> instruction has been deprecated for a long time and
Bill Wendling086da7e2011-08-02 06:39:13 +0000[diff] [blame]895 isn't used by the current front-ends. So this was removed during the
Bill Wendling16005252011-08-02 06:20:17 +0000[diff] [blame]896 exception handling rewrite.</li>
897
Bill Wendling2626dba2011-08-03 22:18:20 +0000[diff] [blame]898<li>The <code>LLVMAddLowerSetJmpPass</code> function from the C API was removed
899 because the <code>LowerSetJmp</code> pass was removed.</li>
900
Devang Patel6326a422011-08-15 23:00:00 +0000[diff] [blame]901<li>The <code>DIBuilder</code> interface used by front ends to encode debugging
902 information in the LLVM IR now expects clients to use <code>DIBuilder::finalize()</code>
903 at the end of translation unit to complete debugging information encoding.</li>
904
Torok Edwinf16e2d42011-09-30 13:07:52 +0000[diff] [blame]905<li>The way the type system works has been rewritten: <code>PATypeHolder</code>
906and <code>OpaqueType</code> are gone, and all APIs deal with <code>Type*</code>
907instead of <code>const Type*</code>.
908If you need to create recursive structures, then create a named structure,
909and use <code>setBody()</code> when all its elements are built.
910Type merging and refining is gone too: named structures are not
911merged with other structures, even if their layout is identical.
912(of course anonymous structures are still uniqued by layout).
913</li>
914
915<li>TargetSelect.h moved to Support/ from Target/</li>
916
917<li>UpgradeIntrinsicCall no longer upgrades pre-2.9 intrinsic calls
918(for example <code>llvm.memset.i32</code>).</li>
919
920<li>It is mandatory to initialize all out-of-tree passes too and their dependencies now with
921<code>INITIALIZE_PASS{BEGIN,END,}</code> and <code>INITIALIZE_{PASS,AG}_DEPENDENCY</code>.</li>
922
Eli Friedmanb4141422011-10-13 22:14:57 +0000[diff] [blame]923<li>The interface for MemDepResult in MemoryDependenceAnalysis has been enhanced
924 with new return types Unknown and NonFuncLocal, in addition to the existing
925 types Clobber, Def, and NonLocal.</li>
926
Daniel Dunbarf0233c62010-10-04 20:11:41 +0000[diff] [blame]927</ul>
928</div>
Chris Lattnerf6662f92008-10-13 17:57:36 +0000[diff] [blame]929
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000[diff] [blame]930</div>
931
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]932<!-- *********************************************************************** -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]933<h2>
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]934 <a name="knownproblems">Known Problems</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]935</h2>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]936<!-- *********************************************************************** -->
937
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000[diff] [blame]938<div>
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]939
Mikhail Glushenkovf795ef02009-03-01 18:09:47 +0000[diff] [blame]940<p>This section contains significant known problems with the LLVM system,
Chris Lattnere18b32e2008-11-10 05:40:34 +0000[diff] [blame]941listed by component. If you run into a problem, please check the <a
Chris Lattnerc463b272005-10-29 07:07:09 +0000[diff] [blame]942href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
Chris Lattner5eccca42003-12-12 21:22:16 +0000[diff] [blame]943there isn't already one.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]944
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000[diff] [blame]945<!-- ======================================================================= -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]946<h3>
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000[diff] [blame]947 <a name="experimental">Experimental features included with this release</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]948</h3>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]949
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000[diff] [blame]950<div>
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000[diff] [blame]951
Misha Brukman6df9e2c2004-05-12 21:46:05 +0000[diff] [blame]952<p>The following components of this LLVM release are either untested, known to
953be broken or unreliable, or are in early development. These components should
954not be relied on, and bugs should not be filed against them, but they may be
955useful to some people. In particular, if you would like to work on one of these
Chris Lattner2b659ef2008-02-12 06:29:45 +0000[diff] [blame]956components, please contact us on the <a
957href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p>
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000[diff] [blame]958
959<ul>
Dan Gohman3e6157d2011-10-25 00:05:42 +0000[diff] [blame]960<li>The Alpha, CellSPU, MicroBlaze, MSP430, MIPS, PTX,
Chris Lattnerbb117712010-10-04 01:29:06 +0000[diff] [blame]961 and XCore backends are experimental.</li>
Chris Lattner7d9b6b42010-10-02 21:59:30 +0000[diff] [blame]962<li><tt>llc</tt> "<tt>-filetype=obj</tt>" is experimental on all targets
Chris Lattner49123fd2011-04-06 06:29:50 +0000[diff] [blame]963 other than darwin and ELF X86 systems.</li>
Chris Lattnerbe2e1b52011-03-10 07:43:44 +0000[diff] [blame]964
Chris Lattnerf5ee1702004-03-14 02:03:02 +0000[diff] [blame]965</ul>
966
967</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]968
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]969<!-- ======================================================================= -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]970<h3>
Chris Lattner26299222006-11-18 07:51:14 +0000[diff] [blame]971 <a name="x86-be">Known problems with the X86 back-end</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]972</h3>
John Criswellc0c186d2005-11-08 21:11:33 +0000[diff] [blame]973
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000[diff] [blame]974<div>
John Criswellc0c186d2005-11-08 21:11:33 +0000[diff] [blame]975
976<ul>
Anton Korobeynikova6094be2008-06-08 10:24:13 +0000[diff] [blame]977 <li>The X86 backend does not yet support
978 all <a href="http://llvm.org/PR879">inline assembly that uses the X86
979 floating point stack</a>. It supports the 'f' and 't' constraints, but not
980 'u'.</li>
Dan Gohman8207ba92008-06-08 23:05:11 +0000[diff] [blame]981 <li>The X86-64 backend does not yet support the LLVM IR instruction
Chris Lattner914ce462010-04-22 06:28:20 +0000[diff] [blame]982 <tt>va_arg</tt>. Currently, front-ends support variadic
Dan Gohman8207ba92008-06-08 23:05:11 +0000[diff] [blame]983 argument constructs on X86-64 by lowering them manually.</li>
NAKAMURA Takumi45c435a2011-04-05 08:24:22 +0000[diff] [blame]984 <li>Windows x64 (aka Win64) code generator has a few issues.
985 <ul>
986 <li>llvm-gcc cannot build the mingw-w64 runtime currently
987 due to lack of support for the 'u' inline assembly
988 constraint and for X87 floating point inline assembly.</li>
989 <li>On mingw-w64, you will see unresolved symbol <tt>__chkstk</tt>
990 due to <a href="http://llvm.org/bugs/show_bug.cgi?id=8919">Bug 8919</a>.
991 It is fixed in <a href="http://lists.cs.uiuc.edu/pipermail/llvm-commits/Week-of-Mon-20110321/118499.html">r128206</a>.</li>
992 <li>Miss-aligned MOVDQA might crash your program. It is due to
993 <a href="http://llvm.org/bugs/show_bug.cgi?id=9483">Bug 9483</a>,
994 lack of handling aligned internal globals.</li>
995 </ul>
996 </li>
997
Chris Lattner26299222006-11-18 07:51:14 +0000[diff] [blame]998</ul>
999
1000</div>
1001
1002<!-- ======================================================================= -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]1003<h3>
Chris Lattner26299222006-11-18 07:51:14 +0000[diff] [blame]1004 <a name="ppc-be">Known problems with the PowerPC back-end</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]1005</h3>
Chris Lattner26299222006-11-18 07:51:14 +0000[diff] [blame]1006
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000[diff] [blame]1007<div>
Chris Lattner26299222006-11-18 07:51:14 +0000[diff] [blame]1008
1009<ul>
Nicolas Geoffraye4285dc2007-05-15 09:21:28 +0000[diff] [blame]1010<li>The Linux PPC32/ABI support needs testing for the interpreter and static
Chris Lattner57a460e2007-05-23 04:39:32 +0000[diff] [blame]1011compilation, and lacks support for debug information.</li>
Chris Lattner26299222006-11-18 07:51:14 +0000[diff] [blame]1012</ul>
1013
1014</div>
1015
1016<!-- ======================================================================= -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]1017<h3>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000[diff] [blame]1018 <a name="arm-be">Known problems with the ARM back-end</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]1019</h3>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000[diff] [blame]1020
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000[diff] [blame]1021<div>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000[diff] [blame]1022
1023<ul>
Chris Lattner57a460e2007-05-23 04:39:32 +0000[diff] [blame]1024<li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
Duncan Sandsc90d68b2007-09-26 15:59:54 +0000[diff] [blame]1025processors, thumb programs can crash or produce wrong
Chris Lattner57a460e2007-05-23 04:39:32 +0000[diff] [blame]1026results (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
John Criswell524a5dd2009-03-02 15:28:15 +0000[diff] [blame]1027<li>Compilation for ARM Linux OABI (old ABI) is supported but not fully tested.
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000[diff] [blame]1028</li>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000[diff] [blame]1029</ul>
1030
1031</div>
1032
1033<!-- ======================================================================= -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]1034<h3>
Chris Lattner26299222006-11-18 07:51:14 +0000[diff] [blame]1035 <a name="sparc-be">Known problems with the SPARC back-end</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]1036</h3>
Chris Lattner26299222006-11-18 07:51:14 +0000[diff] [blame]1037
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000[diff] [blame]1038<div>
Chris Lattner26299222006-11-18 07:51:14 +0000[diff] [blame]1039
1040<ul>
John Criswell524a5dd2009-03-02 15:28:15 +0000[diff] [blame]1041<li>The SPARC backend only supports the 32-bit SPARC ABI (-m32); it does not
Chris Lattner26299222006-11-18 07:51:14 +0000[diff] [blame]1042 support the 64-bit SPARC ABI (-m64).</li>
1043</ul>
1044
1045</div>
1046
1047<!-- ======================================================================= -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]1048<h3>
Bruno Cardoso Lopesb7e1a4f2008-10-25 14:56:26 +0000[diff] [blame]1049 <a name="mips-be">Known problems with the MIPS back-end</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]1050</h3>
Bruno Cardoso Lopesb7e1a4f2008-10-25 14:56:26 +0000[diff] [blame]1051
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000[diff] [blame]1052<div>
Bruno Cardoso Lopesb7e1a4f2008-10-25 14:56:26 +0000[diff] [blame]1053
1054<ul>
Bruno Cardoso Lopesb7e1a4f2008-10-25 14:56:26 +0000[diff] [blame]1055<li>64-bit MIPS targets are not supported yet.</li>
1056</ul>
1057
1058</div>
1059
1060<!-- ======================================================================= -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]1061<h3>
Chris Lattner26299222006-11-18 07:51:14 +0000[diff] [blame]1062 <a name="alpha-be">Known problems with the Alpha back-end</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]1063</h3>
Chris Lattner26299222006-11-18 07:51:14 +0000[diff] [blame]1064
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000[diff] [blame]1065<div>
Chris Lattner26299222006-11-18 07:51:14 +0000[diff] [blame]1066
1067<ul>
1068
1069<li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
1070appropriate nops inserted to ensure restartability.</li>
1071
John Criswellc0c186d2005-11-08 21:11:33 +0000[diff] [blame]1072</ul>
1073</div>
1074
Chris Lattner26299222006-11-18 07:51:14 +0000[diff] [blame]1075<!-- ======================================================================= -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]1076<h3>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000[diff] [blame]1077 <a name="c-be">Known problems with the C back-end</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]1078</h3>
Chris Lattner26299222006-11-18 07:51:14 +0000[diff] [blame]1079
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000[diff] [blame]1080<div>
Chris Lattner26299222006-11-18 07:51:14 +0000[diff] [blame]1081
Chris Lattner3016ee92010-09-29 05:34:42 +0000[diff] [blame]1082<p>The C backend has numerous problems and is not being actively maintained.
1083Depending on it for anything serious is not advised.</p>
1084
Chris Lattner26299222006-11-18 07:51:14 +0000[diff] [blame]1085<ul>
Chris Lattner5733b272008-06-05 06:35:40 +0000[diff] [blame]1086<li><a href="http://llvm.org/PR802">The C backend has only basic support for
1087 inline assembly code</a>.</li>
Chris Lattner725a0d82007-09-26 06:01:35 +0000[diff] [blame]1088<li><a href="http://llvm.org/PR1658">The C backend violates the ABI of common
1089 C++ programs</a>, preventing intermixing between C++ compiled by the CBE and
Gabor Greif4906abe2009-03-02 12:02:51 +0000[diff] [blame]1090 C++ code compiled with <tt>llc</tt> or native compilers.</li>
Duncan Sandsf74c0cc2008-02-10 13:40:55 +0000[diff] [blame]1091<li>The C backend does not support all exception handling constructs.</li>
Duncan Sands50723a92009-02-25 11:51:54 +0000[diff] [blame]1092<li>The C backend does not support arbitrary precision integers.</li>
Chris Lattner26299222006-11-18 07:51:14 +0000[diff] [blame]1093</ul>
1094
1095</div>
John Criswellc0c186d2005-11-08 21:11:33 +0000[diff] [blame]1096
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]1097
1098<!-- ======================================================================= -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]1099<h3>
Chris Lattner3016ee92010-09-29 05:34:42 +0000[diff] [blame]1100 <a name="llvm-gcc">Known problems with the llvm-gcc front-end</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]1101</h3>
Chris Lattner47588f92003-10-02 05:07:23 +0000[diff] [blame]1102
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000[diff] [blame]1103<div>
Chris Lattnerc5d658a2006-03-03 00:34:26 +0000[diff] [blame]1104
Chad Rosiere6291d02011-05-27 22:50:46 +0000[diff] [blame]1105<p><b>LLVM 3.0 will be the last release of llvm-gcc.</b></p>
Chris Lattner49123fd2011-04-06 06:29:50 +0000[diff] [blame]1106
Chris Lattner3016ee92010-09-29 05:34:42 +0000[diff] [blame]1107<p>llvm-gcc is generally very stable for the C family of languages. The only
1108 major language feature of GCC not supported by llvm-gcc is the
1109 <tt>__builtin_apply</tt> family of builtins. However, some extensions
1110 are only supported on some targets. For example, trampolines are only
1111 supported on some targets (these are used when you take the address of a
1112 nested function).</p>
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]1113
Chris Lattner3016ee92010-09-29 05:34:42 +0000[diff] [blame]1114<p>Fortran support generally works, but there are still several unresolved bugs
1115 in <a href="http://llvm.org/bugs/">Bugzilla</a>. Please see the
1116 tools/gfortran component for details. Note that llvm-gcc is missing major
1117 Fortran performance work in the frontend and library that went into GCC after
1118 4.2. If you are interested in Fortran, we recommend that you consider using
1119 <a href="#dragonegg">dragonegg</a> instead.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]1120
Duncan Sands3af96332010-10-04 10:06:56 +0000[diff] [blame]1121<p>The llvm-gcc 4.2 Ada compiler has basic functionality, but is no longer being
1122actively maintained. If you are interested in Ada, we recommend that you
1123consider using <a href="#dragonegg">dragonegg</a> instead.</p>
Chris Lattner2b659ef2008-02-12 06:29:45 +0000[diff] [blame]1124</div>
1125
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000[diff] [blame]1126</div>
1127
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]1128<!-- *********************************************************************** -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]1129<h2>
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]1130 <a name="additionalinfo">Additional Information</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000[diff] [blame]1131</h2>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]1132<!-- *********************************************************************** -->
1133
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000[diff] [blame]1134<div>
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]1135
Chris Lattner416db102005-05-16 17:13:10 +0000[diff] [blame]1136<p>A wide variety of additional information is available on the <a
NAKAMURA Takumib9a33632011-04-09 02:13:37 +0000[diff] [blame]1137href="http://llvm.org/">LLVM web page</a>, in particular in the <a
Chris Lattnerb4b0ce72007-05-18 00:44:29 +0000[diff] [blame]1138href="http://llvm.org/docs/">documentation</a> section. The web page also
Reid Spencer669ed452007-07-09 08:04:31 +0000[diff] [blame]1139contains versions of the API documentation which is up-to-date with the
1140Subversion version of the source code.
Misha Brukman109d9e82005-03-30 19:14:24 +0000[diff] [blame]1141You can access versions of these documents specific to this release by going
1142into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]1143
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]1144<p>If you have any questions or comments about LLVM, please feel free to contact
Chris Lattnerc463b272005-10-29 07:07:09 +0000[diff] [blame]1145us via the <a href="http://llvm.org/docs/#maillist"> mailing
Chris Lattner5eccca42003-12-12 21:22:16 +0000[diff] [blame]1146lists</a>.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]1147
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]1148</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]1149
1150<!-- *********************************************************************** -->
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]1151
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]1152<hr>
Misha Brukman2061e892003-11-22 01:23:39 +0000[diff] [blame]1153<address>
Misha Brukman38847d52003-12-21 22:53:21 +0000[diff] [blame]1154 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman44408702008-12-11 17:34:48 +0000[diff] [blame]1155 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
Misha Brukman2061e892003-11-22 01:23:39 +0000[diff] [blame]1156 <a href="http://validator.w3.org/check/referer"><img
Misha Brukman44408702008-12-11 17:34:48 +0000[diff] [blame]1157 src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
Misha Brukman2061e892003-11-22 01:23:39 +0000[diff] [blame]1158
Chris Lattnerb4b0ce72007-05-18 00:44:29 +0000[diff] [blame]1159 <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]1160 Last modified: $Date$
Misha Brukman2061e892003-11-22 01:23:39 +0000[diff] [blame]1161</address>
Chris Lattner79c3fe12003-10-02 04:57:28 +0000[diff] [blame]1162
Misha Brukman500bc302003-11-22 00:38:41 +0000[diff] [blame]1163</body>
1164</html>