blob: 03217ad9781dc6f3bdbf90367370b06686d9e0da [file] [log] [blame]
Misha Brukman500bc302003-11-22 00:38:41 +00001<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
3<html>
4<head>
Reid Spencer6454ed32004-11-18 18:38:58 +00005 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
Misha Brukman500bc302003-11-22 00:38:41 +00006 <link rel="stylesheet" href="llvm.css" type="text/css">
Chad Rosiere6291d02011-05-27 22:50:46 +00007 <title>LLVM 3.0 Release Notes</title>
Misha Brukman500bc302003-11-22 00:38:41 +00008</head>
9<body>
Chris Lattner79c3fe12003-10-02 04:57:28 +000010
Chad Rosiere6291d02011-05-27 22:50:46 +000011<h1>LLVM 3.0 Release Notes</h1>
Mikhail Glushenkovea65d7d2008-10-13 02:08:34 +000012
Chris Lattner0e464a92010-03-17 04:02:39 +000013<img align=right src="http://llvm.org/img/DragonSmall.png"
Gabor Greifee2187a2010-04-22 10:21:43 +000014 width="136" height="136" alt="LLVM Dragon Logo">
Chris Lattner0e464a92010-03-17 04:02:39 +000015
Chris Lattner79c3fe12003-10-02 04:57:28 +000016<ol>
Misha Brukman500bc302003-11-22 00:38:41 +000017 <li><a href="#intro">Introduction</a></li>
Chris Lattner96a445e2008-10-13 18:01:01 +000018 <li><a href="#subproj">Sub-project Status Update</a></li>
Chad Rosiere6291d02011-05-27 22:50:46 +000019 <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 +000021 <li><a href="GettingStarted.html">Installation Instructions</a></li>
Dan Gohman44aa9212008-10-14 16:23:02 +000022 <li><a href="#knownproblems">Known Problems</a></li>
Misha Brukman500bc302003-11-22 00:38:41 +000023 <li><a href="#additionalinfo">Additional Information</a></li>
Chris Lattner79c3fe12003-10-02 04:57:28 +000024</ol>
25
Chris Lattner7911ce22004-05-23 21:07:27 +000026<div class="doc_author">
NAKAMURA Takumib9a33632011-04-09 02:13:37 +000027 <p>Written by the <a href="http://llvm.org/">LLVM Team</a></p>
Misha Brukman500bc302003-11-22 00:38:41 +000028</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +000029
Chris Lattner49123fd2011-04-06 06:29:50 +000030<!--
Chad Rosiere6291d02011-05-27 22:50:46 +000031<h1 style="color:red">These are in-progress notes for the upcoming LLVM 3.0
Jeffrey Yasskinbec48772010-01-28 01:14:43 +000032release.<br>
33You may prefer the
Chad Rosiere6291d02011-05-27 22:50:46 +000034<a href="http://llvm.org/releases/2.9/docs/ReleaseNotes.html">LLVM 2.9
Dan Gohmanb44f6c62010-05-03 23:51:05 +000035Release Notes</a>.</h1>
Chris Lattner49123fd2011-04-06 06:29:50 +000036 -->
Jeffrey Yasskinbec48772010-01-28 01:14:43 +000037
Chris Lattner79c3fe12003-10-02 04:57:28 +000038<!-- *********************************************************************** -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +000039<h2>
Misha Brukman500bc302003-11-22 00:38:41 +000040 <a name="intro">Introduction</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +000041</h2>
Chris Lattner79c3fe12003-10-02 04:57:28 +000042<!-- *********************************************************************** -->
43
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +000044<div>
Misha Brukman500bc302003-11-22 00:38:41 +000045
Chris Lattnerf6662f92008-10-13 17:57:36 +000046<p>This document contains the release notes for the LLVM Compiler
Chad Rosiere6291d02011-05-27 22:50:46 +000047Infrastructure, release 3.0. Here we describe the status of LLVM, including
Chris Lattnerf6662f92008-10-13 17:57:36 +000048major improvements from the previous release and significant known problems.
Mikhail Glushenkovf795ef02009-03-01 18:09:47 +000049All LLVM releases may be downloaded from the <a
Chris Lattnerf6662f92008-10-13 17:57:36 +000050href="http://llvm.org/releases/">LLVM releases web site</a>.</p>
Chris Lattner19092612003-10-02 16:38:05 +000051
Chris Lattner7506b1d2004-12-07 08:04:13 +000052<p>For more information about LLVM, including information about the latest
Chris Lattnerc463b272005-10-29 07:07:09 +000053release, please check out the <a href="http://llvm.org/">main LLVM
Chris Lattner47ad72c2003-10-07 21:38:31 +000054web site</a>. If you have questions or comments, the <a
Chris Lattnerc66bfef2010-03-17 04:41:49 +000055href="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 +000057
Mikhail Glushenkovea65d7d2008-10-13 02:08:34 +000058<p>Note that if you are reading this file from a Subversion checkout or the
Chris Lattner84977642007-09-21 03:54:09 +000059main LLVM web page, this document applies to the <i>next</i> release, not the
Gabor Greiffa933f82008-10-14 11:00:32 +000060current one. To see the release notes for a specific release, please see the
Chris Lattner84977642007-09-21 03:54:09 +000061<a href="http://llvm.org/releases/">releases page</a>.</p>
Misha Brukman500bc302003-11-22 00:38:41 +000062
63</div>
Chris Lattner61358ab2009-10-13 17:48:04 +000064
Chris Lattnere4dc1962011-04-05 23:22:33 +000065<!-- Features that need text if they're finished for 3.1:
66 ARM EHABI
Chris Lattner914ce462010-04-22 06:28:20 +000067 combiner-aa?
Chris Lattner61358ab2009-10-13 17:48:04 +000068 strong phi elim
Chris Lattner61358ab2009-10-13 17:48:04 +000069 loop dependence analysis
Chris Lattnere07043c2010-09-29 05:30:03 +000070 CorrelatedValuePropagation
Chris Lattnere4dc1962011-04-05 23:22:33 +000071 lib/Transforms/IPO/MergeFunctions.cpp => consider for 3.1.
Chris Lattneracce85d2008-02-10 07:46:44 +000072 -->
Chris Lattnere07043c2010-09-29 05:30:03 +000073
Chris Lattner96a445e2008-10-13 18:01:01 +000074<!-- *********************************************************************** -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +000075<h2>
Chris Lattner96a445e2008-10-13 18:01:01 +000076 <a name="subproj">Sub-project Status Update</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +000077</h2>
Chris Lattner96a445e2008-10-13 18:01:01 +000078<!-- *********************************************************************** -->
Chris Lattnerea34f642008-06-08 21:34:41 +000079
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +000080<div>
Chris Lattner8348b472008-06-08 21:58:17 +000081<p>
Chad Rosiere6291d02011-05-27 22:50:46 +000082The LLVM 3.0 distribution currently consists of code from the core LLVM
Chris Lattner61358ab2009-10-13 17:48:04 +000083repository (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 +000087</p>
Chris Lattner96a445e2008-10-13 18:01:01 +000088
Chris Lattner8348b472008-06-08 21:58:17 +000089<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +000090<h3>
Chris Lattnerfb97b2d2008-10-13 18:11:54 +000091<a name="clang">Clang: C/C++/Objective-C Frontend Toolkit</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +000092</h3>
Chris Lattner8348b472008-06-08 21:58:17 +000093
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +000094<div>
Chris Lattner8348b472008-06-08 21:58:17 +000095
Chris Lattner095539f2010-04-26 17:42:18 +000096<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 +0000102production-quality compiler for C, Objective-C, C++ and Objective-C++ on x86
Chris Lattner1efe27e2011-04-06 00:45:11 +0000103(32- and 64-bit), and for darwin/arm targets.</p>
Chris Lattner61358ab2009-10-13 17:48:04 +0000104
Chad Rosiere6291d02011-05-27 22:50:46 +0000105<p>In the LLVM 3.0 time-frame, the Clang team has made many improvements:</p>
Douglas Gregorba087df2011-10-15 00:48:01 +0000106
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 +0000121
Duncan Sandsf3ba7af2011-04-06 08:07:40 +0000122<p>If Clang rejects your code but another compiler accepts it, please take a
Chris Lattner0a6f6d52011-04-05 07:19:28 +0000123look at the <a href="http://clang.llvm.org/compatibility.html">language
Duncan Sandsf3ba7af2011-04-06 08:07:40 +0000124compatibility</a> guide to make sure this is not intentional or a known issue.
Chris Lattner0a6f6d52011-04-05 07:19:28 +0000125</p>
Bill Wendling741748a2008-10-27 09:27:33 +0000126
Chris Lattnerfb97b2d2008-10-13 18:11:54 +0000127</div>
128
129<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000130<h3>
Duncan Sands528a5102011-04-04 11:09:08 +0000131<a name="dragonegg">DragonEgg: GCC front-ends, LLVM back-end</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000132</h3>
Chris Lattner61358ab2009-10-13 17:48:04 +0000133
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000134<div>
Chris Lattner61358ab2009-10-13 17:48:04 +0000135<p>
Duncan Sands528a5102011-04-04 11:09:08 +0000136<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 +0000145</p>
146
147<p>
Chad Rosiere6291d02011-05-27 22:50:46 +0000148The 3.0 release has the following notable changes:
Duncan Sands4b1da2b2010-09-30 17:37:34 +0000149<ul>
Chad Rosiere6291d02011-05-27 22:50:46 +0000150<!--
151<li></li>
152-->
Duncan Sands4b1da2b2010-09-30 17:37:34 +0000153</ul>
Chris Lattner61358ab2009-10-13 17:48:04 +0000154
155</div>
156
Chris Lattner75547712010-10-03 23:49:06 +0000157<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000158<h3>
Chris Lattner75547712010-10-03 23:49:06 +0000159<a name="compiler-rt">compiler-rt: Compiler Runtime Library</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000160</h3>
Chris Lattner75547712010-10-03 23:49:06 +0000161
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000162<div>
Chris Lattner75547712010-10-03 23:49:06 +0000163<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 +0000173<p>In the LLVM 3.0 timeframe,</p>
Chris Lattner75547712010-10-03 23:49:06 +0000174
175</div>
Chris Lattner61358ab2009-10-13 17:48:04 +0000176
177<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000178<h3>
Chris Lattnere07043c2010-09-29 05:30:03 +0000179<a name="lldb">LLDB: Low Level Debugger</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000180</h3>
Chris Lattnere07043c2010-09-29 05:30:03 +0000181
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000182<div>
Chris Lattnere07043c2010-09-29 05:30:03 +0000183<p>
Chris Lattner75547712010-10-03 23:49:06 +0000184<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 +0000189
190<p>
Chad Rosiere6291d02011-05-27 22:50:46 +0000191LLDB is has advanced by leaps and bounds in the 3.0 timeframe. It is
Chris Lattnerdf448a32011-04-06 00:56:12 +0000192dramatically 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 +0000196
197</div>
198
199<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000200<h3>
Chris Lattnere07043c2010-09-29 05:30:03 +0000201<a name="libc++">libc++: C++ Standard Library</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000202</h3>
Chris Lattnere07043c2010-09-29 05:30:03 +0000203
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000204<div>
Chris Lattnere07043c2010-09-29 05:30:03 +0000205<p>
Tobias Grossercdce44b2010-10-06 21:07:30 +0000206<a href="http://libcxx.llvm.org/">libc++</a> is another new member of the LLVM
Chris Lattner75547712010-10-03 23:49:06 +0000207family. 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 +0000210
211<p>
Chad Rosiere6291d02011-05-27 22:50:46 +0000212In the LLVM 3.0 timeframe,</p>
Chris Lattner0a6f6d52011-04-05 07:19:28 +0000213
Chris Lattner2009c492011-04-06 00:59:18 +0000214<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 +0000218</p>
219
220</div>
221
Chris Lattner61358ab2009-10-13 17:48:04 +0000222
Chris Lattner3d6a80a2011-04-07 03:08:22 +0000223<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000224<h3>
Chris Lattner3d6a80a2011-04-07 03:08:22 +0000225<a name="LLBrowse">LLBrowse: IR Browser</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000226</h3>
Daniel Dunbar97b01a82010-10-04 17:39:47 +0000227
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000228<div>
Chris Lattner3d6a80a2011-04-07 03:08:22 +0000229<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 +0000239<h3>
Chris Lattner3d6a80a2011-04-07 03:08:22 +0000240<a name="vmkit">VMKit</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000241</h3>
Chris Lattner3d6a80a2011-04-07 03:08:22 +0000242
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000243<div>
Chris Lattner3d6a80a2011-04-07 03:08:22 +0000244<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 +0000246 just-in-time compilation. As of LLVM 3.0, VMKit now supports generational
Chris Lattner3d6a80a2011-04-07 03:08:22 +0000247 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 +0000254<!--=========================================================================-->
Chris Lattner7a8e6c52011-04-05 18:38:45 +0000255<!--
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000256<h3>
Daniel Dunbar97b01a82010-10-04 17:39:47 +0000257<a name="klee">KLEE: A Symbolic Execution Virtual Machine</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000258</h3>
Daniel Dunbar97b01a82010-10-04 17:39:47 +0000259
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000260<div>
Daniel Dunbar97b01a82010-10-04 17:39:47 +0000261<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 +0000269<p>UPDATE!</p>
Chris Lattner7a8e6c52011-04-05 18:38:45 +0000270</div>-->
Daniel Dunbar97b01a82010-10-04 17:39:47 +0000271
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000272</div>
Daniel Dunbar97b01a82010-10-04 17:39:47 +0000273
Chris Lattnerab68e9e2009-02-26 22:33:38 +0000274<!-- *********************************************************************** -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000275<h2>
Chad Rosiere6291d02011-05-27 22:50:46 +0000276 <a name="externalproj">External Open Source Projects Using LLVM 3.0</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000277</h2>
Chris Lattnerab68e9e2009-02-26 22:33:38 +0000278<!-- *********************************************************************** -->
279
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000280<div>
Chris Lattner61358ab2009-10-13 17:48:04 +0000281
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 +0000284 projects that have already been updated to work with LLVM 3.0.</p>
Chris Lattner75547712010-10-03 23:49:06 +0000285
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000286<!--=========================================================================-->
Bill Wendling7be6bc52011-10-26 00:17:54 +0000287<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 +0000300<h3>ClamAV</h3>
301
302<div>
Bill Wendlingf2a78332011-10-25 01:01:42 +0000303
Bill Wendling29817ea2011-10-26 00:14:36 +0000304<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 Wendling65d1f412011-10-26 18:23:06 +0000319<h3>clReflect</h3>
320
321<div>
322
323<p><a href="https://bitbucket.org/dwilliamson/clreflect">clReflect</a> is a C++
324 parser that uses clang/LLVM to derive a light-weight reflection database
325 suitable for use in game development. It comes with a very simple runtime
326 library for loading and querying the database, requiring no external
327 dependencies (including CRT), and an additional utility library for object
328 management and serialisation.</p>
329
330</div>
331
332<!--=========================================================================-->
Bill Wendlingf2a78332011-10-25 01:01:42 +0000333<!-- FIXME: Comment out
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000334<h3>Crack Programming Language</h3>
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000335
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000336<div>
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000337<p>
338<a href="http://code.google.com/p/crack-language/">Crack</a> aims to provide the
339ease of development of a scripting language with the performance of a compiled
340language. The language derives concepts from C++, Java and Python, incorporating
341object-oriented programming, operator overloading and strong typing.</p>
342</div>
Bill Wendlingf2a78332011-10-25 01:01:42 +0000343-->
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000344
345<!--=========================================================================-->
Bill Wendlingf9778192011-10-26 00:09:55 +0000346<h3>Glasgow Haskell Compiler (GHC)</h3>
347
348<div>
349
350<p>GHC is an open source, state-of-the-art programming suite for Haskell, a
351 standard lazy functional programming language. It includes an optimizing
352 static compiler generating good code for a variety of platforms, together
353 with an interactive system for convenient, quick development.</p>
354
355<p>GHC 7.0 and onwards include an LLVM code generator, supporting LLVM 2.8 and
356 later. Since LLVM 2.9, GHC now includes experimental support for the ARM
357 platform with LLVM 3.0.</p>
358
359</div>
360
361<!--=========================================================================-->
Bill Wendlingf62333d2011-10-25 20:35:31 +0000362<h3>gwXscript</h3>
363
364<div>
365
366<p><a href="http://botwars.tk/gwscript/">gwXscript</a> is an object oriented,
Bill Wendling7c38de22011-10-26 04:24:15 +0000367 aspect oriented programming language which can create both executables (ELF,
Bill Wendlingf62333d2011-10-25 20:35:31 +0000368 EXE) and shared libraries (DLL, SO, DYNLIB). The compiler is implemented in
369 its own language and translates scripts into LLVM-IR which can be optimized
370 and translated into native code by the LLVM framework. Source code in
371 gwScript contains definitions that expand the namespaces. So you can build
372 your project and simply 'plug out' features by removing a file. The remaining
373 project does not leave scars since you directly separate concerns by the
374 'template' feature of gwX. It is also possible to add new features to a
375 project by just adding files and without editing the original project. This
376 language is used for example to create games or content management systems
377 that should be extendable.</p>
378
379<p>gwXscript is strongly typed and offers comfort with its native types string,
380 hash and array. You can easily write new libraries in gwXscript or native
381 code. gwXscript is type safe and users should not be able to crash your
382 program or execute malicious code except code that is eating CPU time.</p>
383
384</div>
385
386<!--=========================================================================-->
Bill Wendling57fd8762011-10-26 18:20:54 +0000387<h3>LanguageKit and Pragmatic Smalltalk</h3>
388
389<div>
390
391<p><a href="http://etoileos.com/etoile/features/languagekit/">LanguageKit</a> is
392 a framework for implementing dynamic languages sharing an object model with
393 Objective-C. It provides static and JIT compilation using LLVM along with
394 its own interpreter. Pragmatic Smalltalk is a dialect of Smalltalk, built on
395 top of LanguageKit, that interfaces directly with Objective-C, sharing the
396 same object representation and message sending behaviour. These projects are
397 developed as part of the &Eacute;toi&eacute; desktop environment.</p>
398
399</div>
400
401<!--=========================================================================-->
Bill Wendlingd4821b82011-10-26 00:16:17 +0000402<h3>Mono</h3>
403
404<div>
405
406<p>An open source, cross-platform implementation of C# and the CLR that is
407 binary compatible with Microsoft.NET. Has an optional, dynamically-loaded
408 LLVM code generation backend in Mini, the JIT compiler.</p>
409
410<p>Note that we use a Git mirror of LLVM with some patches. See:
411 https://github.com/mono/llvm</p>
412
413</div>
414
415<!--=========================================================================-->
Bill Wendlingba226272011-10-25 20:37:45 +0000416<h3>Portable OpenCL (pocl)</h3>
417
418<div>
419
420<p>Portable OpenCL is an open source implementation of the OpenCL standard which
421 can be easily adapted for new targets. One of the goals of the project is
422 improving performance portability of OpenCL programs, avoiding the need for
423 target-dependent manual optimizations. A "native" target is included, which
424 allows running OpenCL kernels on the host (CPU).</p>
425
426</div>
427
428<!--=========================================================================-->
Bill Wendling0bad98c2011-10-25 20:39:06 +0000429<h3>Pure</h3>
430
431<div>
432<p><a href="http://pure-lang.googlecode.com/">Pure</a> is an
433 algebraic/functional programming language based on term rewriting. Programs
434 are collections of equations which are used to evaluate expressions in a
435 symbolic fashion. The interpreter uses LLVM as a backend to JIT-compile Pure
436 programs to fast native code. Pure offers dynamic typing, eager and lazy
437 evaluation, lexical closures, a hygienic macro system (also based on term
438 rewriting), built-in list and matrix support (including list and matrix
439 comprehensions) and an easy-to-use interface to C and other programming
440 languages (including the ability to load LLVM bitcode modules, and inline C,
441 C++, Fortran and Faust code in Pure programs if the corresponding LLVM-enabled
442 compilers are installed).</p>
443
444<p>Pure version 0.48 has been tested and is known to work with LLVM 3.0
445 (and continues to work with older LLVM releases &gt;= 2.5).</p>
446
447</div>
448
449<!--=========================================================================-->
Bill Wendling537d85b2011-10-26 00:12:04 +0000450<h3>Renderscript</h3>
451
452<div>
453
454<p><a href="http://developer.android.com/guide/topics/renderscript/index.html">Renderscript</a>
455 is Android's advanced 3D graphics rendering and compute API. It provides a
456 portable C99-based language with extensions to facilitate common use cases
457 for enhancing graphics and thread level parallelism. The Renderscript
458 compiler frontend is based on Clang/LLVM. It emits a portable bitcode format
459 for the actual compiled script code, as well as reflects a Java interface for
460 developers to control the execution of the compiled bitcode. Executable
461 machine code is then generated from this bitcode by an LLVM backend on the
462 device. Renderscript is thus able to provide a mechanism by which Android
463 developers can improve performance of their applications while retaining
464 portability.</p>
465
466</div>
467
468<!--=========================================================================-->
Bill Wendling7d5b6212011-10-25 20:40:26 +0000469<h3>SAFECode</h3>
470
471<div>
472
473<p><a href="http://safecode.cs.illinois.edu">SAFECode</a> is a memory safe C/C++
474 compiler built using LLVM. It takes standard, unannotated C/C++ code,
475 analyzes the code to ensure that memory accesses and array indexing
476 operations are safe, and instruments the code with run-time checks when
477 safety cannot be proven statically. SAFECode can be used as a debugging aid
478 (like Valgrind) to find and repair memory safety bugs. It can also be used
479 to protect code from security attacks at run-time.</p>
480
481</div>
482
483<!--=========================================================================-->
Bill Wendling02b77b72011-10-26 07:38:19 +0000484<h3>The Stupid D Compiler (SDC)</h3>
485
486<div>
487
488<p><a href="https://github.com/bhelyer/SDC">The Stupid D Compiler</a> is a
489 project seeking to write a self-hosting compiler for the D programming
490 language without using the frontend of the reference compiler (DMD).</p>
491
492</div>
493
494<!--=========================================================================-->
Bill Wendling2d7b4af2011-10-25 20:24:32 +0000495<h3>TTA-based Co-design Environment (TCE)</h3>
496
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000497<div>
Bill Wendling2d7b4af2011-10-25 20:24:32 +0000498
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000499<p>TCE is a toolset for designing application-specific processors (ASP) based on
Bill Wendling2d7b4af2011-10-25 20:24:32 +0000500 the Transport triggered architecture (TTA). The toolset provides a complete
501 co-design flow from C/C++ programs down to synthesizable VHDL and parallel
502 program binaries. Processor customization points include the register files,
503 function units, supported operations, and the interconnection network.</p>
504
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000505<p>TCE uses Clang and LLVM for C/C++ language support, target independent
Bill Wendling2d7b4af2011-10-25 20:24:32 +0000506 optimizations and also for parts of code generation. It generates new
507 LLVM-based code generators <i>on the fly</i> for the designed TTA processors
508 and loads them in to the compiler backend as runtime libraries to avoid
509 per-target recompilation of larger parts of the compiler chain.</p>
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000510</div>
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000511
512
513<!--=========================================================================-->
Bill Wendling628c2662011-10-25 20:27:37 +0000514<h3>Tart Programming Language</h3>
515
516<div>
517
518<p><a href="http://code.google.com/p/tart/">Tart</a> is a general-purpose,
519 strongly typed programming language designed for application
520 developers. Strongly inspired by Python and C#, Tart focuses on practical
521 solutions for the professional software developer, while avoiding the clutter
522 and boilerplate of legacy languages like Java and C++. Although Tart is still
523 in development, the current implementation supports many features expected of
524 a modern programming language, such as garbage collection, powerful
525 bidirectional type inference, a greatly simplified syntax for template
526 metaprogramming, closures and function literals, reflection, operator
527 overloading, explicit mutability and immutability, and much more. Tart is
528 flexible enough to accommodate a broad range of programming styles and
529 philosophies, while maintaining a strong commitment to simplicity, minimalism
530 and elegance in design.</p>
531
532</div>
533
534<!--=========================================================================-->
Bill Wendling644ce532011-10-26 09:25:01 +0000535<h3>ThreadSanitizer</h3>
536
537<div>
538
539<p><a href="http://code.google.com/p/data-race-test/">ThreadSanitizer</a> is a
540 data race detector for (mostly) C and C++ code, available for Linux, Mac OS
541 and Windows. On different systems, we use binary instrumentation frameworks
542 (Valgrind, Pin and DynamoRio) as frontends that generate the program events
543 for the race detection algorithm. On Linux, there's an option of using
544 LLVM-based compile-time instrumentation.</p>
545
546</div>
547
548<!--=========================================================================-->
Bill Wendling8a924c62011-10-26 07:42:45 +0000549<h3>The ZooLib C++ Cross-Platform Application Framework</h3>
550
551<div>
552
553<p><a href="http://www.zoolib.org/">ZooLib</a> is Open Source under the MIT
554 License. It provides GUI, filesystem access, TCP networking, thread-safe
555 memory management, threading and locking for Mac OS X, Classic Mac OS,
556 Microsoft Windows, POSIX operating systems with X11, BeOS, Haiku, Apple's iOS
557 and Research in Motion's BlackBerry.</p>
558
559<p>My current work is to use CLang's static analyzer to improve ZooLib's code
560 quality. I also plan to set up LLVM compiles of the demo programs and test
561 programs using CLang and LLVM on all the platforms that CLang, LLVM and
562 ZooLib all support.</p>
563
564</div>
565
566<!--=========================================================================-->
Bill Wendlingf2a78332011-10-25 01:01:42 +0000567<!--
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000568<h3>PinaVM</h3>
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000569
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000570<div>
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000571<p><a href="http://gitorious.org/pinavm/pages/Home">PinaVM</a> is an open
572source, <a href="http://www.systemc.org/">SystemC</a> front-end. Unlike many
573other front-ends, PinaVM actually executes the elaboration of the
574program analyzed using LLVM's JIT infrastructure. It later enriches the
575bitcode with SystemC-specific information.</p>
576</div>
Bill Wendlingf2a78332011-10-25 01:01:42 +0000577-->
578
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000579
580<!--=========================================================================-->
Bill Wendlingf2a78332011-10-25 01:01:42 +0000581<!--
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000582<h3 id="icedtea">IcedTea Java Virtual Machine Implementation</h3>
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000583
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000584<div>
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000585<p>
586<a href="http://icedtea.classpath.org/wiki/Main_Page">IcedTea</a> provides a
587harness to build OpenJDK using only free software build tools and to provide
588replacements for the not-yet free parts of OpenJDK. One of the extensions that
589IcedTea provides is a new JIT compiler named <a
590href="http://icedtea.classpath.org/wiki/ZeroSharkFaq">Shark</a> which uses LLVM
591to provide native code generation without introducing processor-dependent
592code.
593</p>
594
595<p> OpenJDK 7 b112, IcedTea6 1.9 and IcedTea7 1.13 and later have been tested
Chad Rosiere6291d02011-05-27 22:50:46 +0000596and are known to work with LLVM 3.0 (and continue to work with older LLVM
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000597releases &gt;= 2.6 as well).</p>
598</div>
Bill Wendlingf2a78332011-10-25 01:01:42 +0000599-->
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000600
601<!--=========================================================================-->
Bill Wendlingf2a78332011-10-25 01:01:42 +0000602<!--
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000603<h3>Polly - Polyhedral optimizations for LLVM</h3>
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000604
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000605<div>
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000606<p>Polly is a project that aims to provide advanced memory access optimizations
607to better take advantage of SIMD units, cache hierarchies, multiple cores or
608even vector accelerators for LLVM. Built around an abstract mathematical
609description based on Z-polyhedra, it provides the infrastructure to develop
610advanced optimizations in LLVM and to connect complex external optimizers. In
611its first year of existence Polly already provides an exact value-based
612dependency analysis as well as basic SIMD and OpenMP code generation support.
613Furthermore, Polly can use PoCC(Pluto) an advanced optimizer for data-locality
614and parallelism.</p>
615</div>
Bill Wendlingf2a78332011-10-25 01:01:42 +0000616-->
Chris Lattner75547712010-10-03 23:49:06 +0000617
Chris Lattner0fa5da92011-04-06 16:14:25 +0000618<!--=========================================================================-->
Bill Wendlingf2a78332011-10-25 01:01:42 +0000619<!--
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000620<h3>Rubinius</h3>
Chris Lattner0fa5da92011-04-06 16:14:25 +0000621
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000622<div>
Chris Lattner0fa5da92011-04-06 16:14:25 +0000623 <p><a href="http://github.com/evanphx/rubinius">Rubinius</a> is an environment
624 for running Ruby code which strives to write as much of the implementation in
625 Ruby as possible. Combined with a bytecode interpreting VM, it uses LLVM to
626 optimize and compile ruby code down to machine code. Techniques such as type
627 feedback, method inlining, and deoptimization are all used to remove dynamism
628 from ruby execution and increase performance.</p>
629</div>
Bill Wendlingf2a78332011-10-25 01:01:42 +0000630-->
Chris Lattner0fa5da92011-04-06 16:14:25 +0000631
Chris Lattnera844a3e2011-04-07 03:09:21 +0000632<!--=========================================================================-->
Bill Wendlingf2a78332011-10-25 01:01:42 +0000633<!--
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000634<h3>
Chris Lattnera844a3e2011-04-07 03:09:21 +0000635<a name="FAUST">FAUST Real-Time Audio Signal Processing Language</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000636</h3>
Chris Lattnere0518442010-10-01 06:34:49 +0000637
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000638<div>
Chris Lattnera844a3e2011-04-07 03:09:21 +0000639<p>
640<a href="http://faust.grame.fr">FAUST</a> is a compiled language for real-time
641audio signal processing. The name FAUST stands for Functional AUdio STream. Its
642programming model combines two approaches: functional programming and block
643diagram composition. In addition with the C, C++, JAVA output formats, the
Chad Rosiere6291d02011-05-27 22:50:46 +0000644Faust compiler can now generate LLVM bitcode, and works with LLVM 2.7-3.0.</p>
Chris Lattnera844a3e2011-04-07 03:09:21 +0000645
646</div>
Bill Wendlingf2a78332011-10-25 01:01:42 +0000647-->
Chris Lattnera844a3e2011-04-07 03:09:21 +0000648
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000649</div>
650
Chris Lattner8348b472008-06-08 21:58:17 +0000651<!-- *********************************************************************** -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000652<h2>
Chad Rosiere6291d02011-05-27 22:50:46 +0000653 <a name="whatsnew">What's New in LLVM 3.0?</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000654</h2>
Chris Lattner8348b472008-06-08 21:58:17 +0000655<!-- *********************************************************************** -->
656
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000657<div>
Chris Lattnerf8e0b4e2008-06-08 22:59:35 +0000658
Chris Lattner61358ab2009-10-13 17:48:04 +0000659<p>This release includes a huge number of bug fixes, performance tweaks and
Chris Lattnerf6662f92008-10-13 17:57:36 +0000660minor improvements. Some of the major improvements and new features are listed
661in this section.
Chris Lattnerf8e0b4e2008-06-08 22:59:35 +0000662</p>
Chris Lattner61358ab2009-10-13 17:48:04 +0000663
Chris Lattner914ce462010-04-22 06:28:20 +0000664<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000665<h3>
Chris Lattner252b83d2008-02-06 18:00:06 +0000666<a name="majorfeatures">Major New Features</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000667</h3>
Chris Lattner252b83d2008-02-06 18:00:06 +0000668
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000669<div>
Chris Lattner252b83d2008-02-06 18:00:06 +0000670
Chad Rosiere6291d02011-05-27 22:50:46 +0000671<p>LLVM 3.0 includes several major new capabilities:</p>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000672
673<ul>
Chris Lattner1efe27e2011-04-06 00:45:11 +0000674
Chad Rosiere6291d02011-05-27 22:50:46 +0000675<!--
676<li></li>
677-->
Chris Lattner7a8e6c52011-04-05 18:38:45 +0000678
Chris Lattner8170c102008-02-10 08:18:42 +0000679</ul>
Chris Lattner0a6f6d52011-04-05 07:19:28 +0000680
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000681</div>
682
Chris Lattner84977642007-09-21 03:54:09 +0000683<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000684<h3>
Chris Lattner917cc712009-03-02 02:37:32 +0000685<a name="coreimprovements">LLVM IR and Core Improvements</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000686</h3>
Chris Lattnerf304ffc2008-02-10 08:17:19 +0000687
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000688<div>
Chris Lattner61358ab2009-10-13 17:48:04 +0000689<p>LLVM IR has several new features for better support of new targets and that
690expose new optimization opportunities:</p>
Chris Lattnerf304ffc2008-02-10 08:17:19 +0000691
Bill Wendlingbc5f6dd2011-10-26 18:33:01 +0000692<p>One of the biggest changes is that 3.0 has a new exception handling
693 system. The old system used LLVM intrinsics to convey the exception handling
694 information to the code generator. It worked in most cases, but not
695 all. Inlining was especially difficult to get right. Also, the intrinsics
696 could be moved away from the <code>invoke</code> instruction, making it hard
697 to recover that information.</p>
698
699<p>The new EH system makes exception handling a first-class member of the IR. It
700 adds two new instructions:</p>
701
Chris Lattner791f77b2008-06-05 06:25:56 +0000702<ul>
Bill Wendlingbc5f6dd2011-10-26 18:33:01 +0000703 <li><a href="LangRef.html#i_landingpad"><code>landingpad</code></a> &mdash;
704 this instruction defines a landing pad basic block. It contains all of the
705 information that's needed by the code generator. It's also required to be
706 the first non-PHI instruction in the landing pad. In addition, a landing
707 pad may be jumped to only by the unwind edge of an <code>invoke</code>
708 instruction.</li>
709
710 <li><a href="LangRef.html#i_resume"><code>resume</code></a> &mdash; this
711 instruction causes the current exception to resume traveling up the
712 stack. It replaces the <code>@llvm.eh.resume</code> intrinsic.</li>
Chris Lattnerf304ffc2008-02-10 08:17:19 +0000713</ul>
Mikhail Glushenkovea65d7d2008-10-13 02:08:34 +0000714
Bill Wendlingbc5f6dd2011-10-26 18:33:01 +0000715<p>Converting from the old EH API to the new EH API is rather simple, because a
716 lot of complexity has been removed. The two intrinsics,
717 <code>@llvm.eh.exception</code> and <code>@llvm.eh.selector</code> have been
718 superceded by the <code>landingpad</code> instruction. Instead of generating
719 a call to <code>@llvm.eh.exception</code> and <code>@llvm.eh.selector</code>:
720
721<div class="doc_code">
722<pre>
723Function *ExcIntr = Intrinsic::getDeclaration(TheModule,
724 Intrinsic::eh_exception);
725Function *SlctrIntr = Intrinsic::getDeclaration(TheModule,
726 Intrinsic::eh_selector);
727
728// The exception pointer.
729Value *ExnPtr = Builder.CreateCall(ExcIntr, "exc_ptr");
730
731std::vector&lt;Value*&gt; Args;
732Args.push_back(ExnPtr);
733Args.push_back(Builder.CreateBitCast(Personality,
734 Type::getInt8PtrTy(Context)));
735
736<i>// Add selector clauses to Args.</i>
737
738// The selector call.
739Builder.CreateCall(SlctrIntr, Args, "exc_sel");
740</pre>
741</div>
742
743<p>You should instead generate a <code>landingpad</code> instruction, that
744 returns an exception object and selector value:</p>
745
746<div class="doc_code">
747<pre>
748LandingPadInst *LPadInst =
749 Builder.CreateLandingPad(StructType::get(Int8PtrTy, Int32Ty, NULL),
750 Personality, 0);
751
752Value *LPadExn = Builder.CreateExtractValue(LPadInst, 0);
753Builder.CreateStore(LPadExn, getExceptionSlot());
754
755Value *LPadSel = Builder.CreateExtractValue(LPadInst, 1);
756Builder.CreateStore(LPadSel, getEHSelectorSlot());
757</pre>
758</div>
759
760<p>It's now trivial to add the individual clauses to the <code>landingpad</code>
761 instruction.</p>
762
763<div class="doc_code">
764<pre>
765<i><b>// Adding a catch clause</b></i>
766Constant *TypeInfo = getTypeInfo();
767LPadInst-&gt;addClause(TypeInfo);
768
769<i><b>// Adding a C++ catch-all</b></i>
770LPadInst-&gt;addClause(Constant::getNullValue(Builder.getInt8PtrTy()));
771
772<i><b>// Adding a cleanup</b></i>
773LPadInst-&gt;setCleanup(true);
774
775<i><b>// Adding a filter clause</b></i>
776std::vector&lt;Constant*&gt; TypeInfos;
777Constant *TypeInfo = getFilterTypeInfo();
778TypeInfos.push_back(Builder.CreateBitCast(TypeInfo, Builder.getInt8PtrTy()));
779
780ArrayType *FilterTy = ArrayType::get(Int8PtrTy, TypeInfos.size());
781LPadInst-&gt;addClause(ConstantArray::get(FilterTy, TypeInfos));
782</pre>
783</div>
784
785<p>Converting from using the <code>@llvm.eh.resume</code> intrinsic to
786 the <code>resume</code> instruction is trivial. It takes the exception
787 pointer and exception selector values returned by
788 the <code>landingpad</code> instruction:</p>
789
790<div class="doc_code">
791<pre>
792Type *UnwindDataTy = StructType::get(Builder.getInt8PtrTy(),
793 Builder.getInt32Ty(), NULL);
794Value *UnwindData = UndefValue::get(UnwindDataTy);
795Value *ExcPtr = Builder.CreateLoad(getExceptionObjSlot());
796Value *ExcSel = Builder.CreateLoad(getExceptionSelSlot());
797UnwindData = Builder.CreateInsertValue(UnwindData, ExcPtr, 0, "exc_ptr");
798UnwindData = Builder.CreateInsertValue(UnwindData, ExcSel, 1, "exc_sel");
799Builder.CreateResume(UnwindData);
800</pre>
801</div>
802
Chris Lattnerf304ffc2008-02-10 08:17:19 +0000803</div>
804
805<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000806<h3>
Chris Lattneracce85d2008-02-10 07:46:44 +0000807<a name="optimizer">Optimizer Improvements</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000808</h3>
Chris Lattneracce85d2008-02-10 07:46:44 +0000809
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000810<div>
Chris Lattneracce85d2008-02-10 07:46:44 +0000811
Chris Lattner61358ab2009-10-13 17:48:04 +0000812<p>In addition to a large array of minor performance tweaks and bug fixes, this
Chris Lattnerf3013872008-10-13 21:50:36 +0000813release includes a few major enhancements and additions to the optimizers:</p>
Chris Lattneracce85d2008-02-10 07:46:44 +0000814
815<ul>
Chad Rosiere6291d02011-05-27 22:50:46 +0000816<!--
817<li></li>
818-->
Chris Lattnerc5ac61d2011-04-06 05:50:04 +0000819</li>
Chris Lattner1efe27e2011-04-06 00:45:11 +0000820
Chris Lattner11b66112010-10-04 02:42:39 +0000821</ul>
822
Chris Lattner61358ab2009-10-13 17:48:04 +0000823</div>
Chris Lattner917cc712009-03-02 02:37:32 +0000824
Chris Lattner0b832202008-06-08 02:45:07 +0000825<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000826<h3>
Chris Lattner4ba2b652010-09-30 16:31:33 +0000827<a name="mc">MC Level Improvements</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000828</h3>
Chris Lattner4ba2b652010-09-30 16:31:33 +0000829
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000830<div>
Chris Lattner4ba2b652010-09-30 16:31:33 +0000831<p>
Chris Lattner7d9b6b42010-10-02 21:59:30 +0000832The LLVM Machine Code (aka MC) subsystem was created to solve a number
Chris Lattner4ba2b652010-09-30 16:31:33 +0000833of problems in the realm of assembly, disassembly, object file format handling,
834and a number of other related areas that CPU instruction-set level tools work
Chris Lattner7d9b6b42010-10-02 21:59:30 +0000835in.</p>
836
Chris Lattner7d9b6b42010-10-02 21:59:30 +0000837<ul>
Chad Rosiere6291d02011-05-27 22:50:46 +0000838<!--
839<li></li>
840-->
Chris Lattner7d9b6b42010-10-02 21:59:30 +0000841</ul>
842
843<p>For more information, please see the <a
Chris Lattner4ba2b652010-09-30 16:31:33 +0000844href="http://blog.llvm.org/2010/04/intro-to-llvm-mc-project.html">Intro to the
845LLVM MC Project Blog Post</a>.
846</p>
847
NAKAMURA Takumi45c435a2011-04-05 08:24:22 +0000848</div>
Chris Lattner4ba2b652010-09-30 16:31:33 +0000849
Chris Lattner4ba2b652010-09-30 16:31:33 +0000850<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000851<h3>
Chris Lattner511433e2009-03-02 03:24:11 +0000852<a name="codegen">Target Independent Code Generator Improvements</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000853</h3>
Chris Lattner0b832202008-06-08 02:45:07 +0000854
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000855<div>
Chris Lattner0b832202008-06-08 02:45:07 +0000856
Mikhail Glushenkovf795ef02009-03-01 18:09:47 +0000857<p>We have put a significant amount of work into the code generator
858infrastructure, which allows us to implement more aggressive algorithms and make
859it run faster:</p>
Chris Lattner0b832202008-06-08 02:45:07 +0000860
861<ul>
Chad Rosiere6291d02011-05-27 22:50:46 +0000862<!--
863<li></li>
864-->
Chris Lattner84977642007-09-21 03:54:09 +0000865</ul>
Chris Lattner84977642007-09-21 03:54:09 +0000866</div>
867
Chris Lattner917cc712009-03-02 02:37:32 +0000868<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000869<h3>
Chris Lattner917cc712009-03-02 02:37:32 +0000870<a name="x86">X86-32 and X86-64 Target Improvements</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000871</h3>
Chris Lattner917cc712009-03-02 02:37:32 +0000872
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000873<div>
Chris Lattner7714c912010-10-04 04:39:25 +0000874<p>New features and major changes in the X86 target include:
Chris Lattner917cc712009-03-02 02:37:32 +0000875</p>
876
877<ul>
Chad Rosierf94c9c12011-05-27 20:13:10 +0000878<li>The CRC32 intrinsics have been renamed. The intrinsics were previously
879 @llvm.x86.sse42.crc32.[8|16|32] and @llvm.x86.sse42.crc64.[8|64]. They have
880 been renamed to @llvm.x86.sse42.crc32.32.[8|16|32] and
881 @llvm.x86.sse42.crc32.64.[8|64].</li>
882
Chris Lattner917cc712009-03-02 02:37:32 +0000883</ul>
884
Chris Lattner917cc712009-03-02 02:37:32 +0000885</div>
Chris Lattner84977642007-09-21 03:54:09 +0000886
887<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000888<h3>
Chris Lattner61358ab2009-10-13 17:48:04 +0000889<a name="ARM">ARM Target Improvements</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000890</h3>
Chris Lattnerc441fb82009-03-01 02:30:21 +0000891
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000892<div>
Chris Lattner61358ab2009-10-13 17:48:04 +0000893<p>New features of the ARM target include:
894</p>
Chris Lattnerc441fb82009-03-01 02:30:21 +0000895
896<ul>
Chad Rosiere6291d02011-05-27 22:50:46 +0000897<!--
898<li></li>
899-->
Bob Wilsone8472772010-09-13 17:39:35 +0000900</ul>
Chris Lattner61358ab2009-10-13 17:48:04 +0000901</div>
Chris Lattner1efe27e2011-04-06 00:45:11 +0000902
903<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000904<h3>
Chris Lattner1efe27e2011-04-06 00:45:11 +0000905<a name="OtherTS">Other Target Specific Improvements</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000906</h3>
Chris Lattnerc441fb82009-03-01 02:30:21 +0000907
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000908<div>
Chris Lattner1efe27e2011-04-06 00:45:11 +0000909<ul>
Chad Rosiere6291d02011-05-27 22:50:46 +0000910<!--
911<li></li>
912-->
Chris Lattner1efe27e2011-04-06 00:45:11 +0000913</ul>
914</div>
Chris Lattner77d29b12008-06-05 08:02:49 +0000915
916<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000917<h3>
Chris Lattnerf6662f92008-10-13 17:57:36 +0000918<a name="changes">Major Changes and Removed Features</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000919</h3>
Chris Lattnerf6662f92008-10-13 17:57:36 +0000920
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000921<div>
Chris Lattnerf6662f92008-10-13 17:57:36 +0000922
Bill Wendling2626dba2011-08-03 22:18:20 +0000923<p>If you're already an LLVM user or developer with out-of-tree changes based on
924 LLVM 2.9, this section lists some "gotchas" that you may run into upgrading
925 from the previous release.</p>
Chris Lattnerf6662f92008-10-13 17:57:36 +0000926
927<ul>
Eric Christopher90d6ec52011-09-28 19:47:28 +0000928 <li>The <code>LLVMC</code> front end code was removed while separating
929 out language independence.</li>
Jay Foadf42e9b22011-08-04 10:43:43 +0000930 <li>The <code>LowerSetJmp</code> pass wasn't used effectively by any
931 target and has been removed.</li>
Rafael Espindolaf940a1a2011-08-30 23:03:45 +0000932 <li>The old <code>TailDup</code> pass was not used in the standard pipeline
933 and was unable to update ssa form, so it has been removed.
Eli Friedmanf03bb262011-08-12 22:50:01 +0000934 <li>The syntax of volatile loads and stores in IR has been changed to
935 "<code>load volatile</code>"/"<code>store volatile</code>". The old
936 syntax ("<code>volatile load</code>"/"<code>volatile store</code>")
937 is still accepted, but is now considered deprecated.</li>
Eli Friedman526e1bb2011-10-26 00:55:23 +0000938 <li>The old atomic intrinscs (<code>llvm.memory.barrier</code> and
939 <code>llvm.atomic.*</code>) are now gone. Please use the new atomic
940 instructions, described in the <a href="Atomics.html">atomics guide</a>.
Devang Patelb34dd132008-10-14 20:03:43 +0000941</ul>
Chris Lattnerf6662f92008-10-13 17:57:36 +0000942
NAKAMURA Takumi2026de22011-08-22 23:22:05 +0000943<h4>Windows (32-bit)</h4>
944<div>
945<ul>
946 <li>On Win32(MinGW32 and MSVC), Windows 2000 will not be supported.
947 Windows XP or higher is required.</li>
948</ul>
949</div>
950
Chris Lattnerf6662f92008-10-13 17:57:36 +0000951</div>
952
Daniel Dunbarf0233c62010-10-04 20:11:41 +0000953<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000954<h3>
Chris Lattner1efe27e2011-04-06 00:45:11 +0000955<a name="api_changes">Internal API Changes</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000956</h3>
Daniel Dunbarf0233c62010-10-04 20:11:41 +0000957
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000958<div>
Daniel Dunbarf0233c62010-10-04 20:11:41 +0000959
Chris Lattner1efe27e2011-04-06 00:45:11 +0000960<p>In addition, many APIs have changed in this release. Some of the major
Bill Wendling16005252011-08-02 06:20:17 +0000961 LLVM API changes are:</p>
Daniel Dunbarf0233c62010-10-04 20:11:41 +0000962
963<ul>
Chris Lattnerd1324302011-07-18 04:56:02 +0000964<li>The biggest and most pervasive change is that llvm::Type's are no longer
965 returned or accepted as 'const' values. Instead, just pass around non-const
966 Type's.</li>
967
Jay Foad558d3762011-07-14 09:19:05 +0000968<li><code>PHINode::reserveOperandSpace</code> has been removed. Instead, you
969 must specify how many operands to reserve space for when you create the
970 PHINode, by passing an extra argument into <code>PHINode::Create</code>.</li>
971
972<li>PHINodes no longer store their incoming BasicBlocks as operands. Instead,
973 the list of incoming BasicBlocks is stored separately, and can be accessed
974 with new functions <code>PHINode::block_begin</code>
975 and <code>PHINode::block_end</code>.</li>
976
977<li>Various functions now take an <code>ArrayRef</code> instead of either a pair
978 of pointers (or iterators) to the beginning and end of a range, or a pointer
979 and a length. Others now return an <code>ArrayRef</code> instead of a
980 reference to a <code>SmallVector</code> or <code>std::vector</code>. These
981 include:
982<ul>
983<!-- Please keep this list sorted. -->
Jay Foada3efbb12011-07-15 08:37:34 +0000984<li><code>CallInst::Create</code></li>
Jay Foad558d3762011-07-14 09:19:05 +0000985<li><code>ComputeLinearIndex</code> (in <code>llvm/CodeGen/Analysis.h</code>)</li>
986<li><code>ConstantArray::get</code></li>
987<li><code>ConstantExpr::getExtractElement</code></li>
Jay Foaddab3d292011-07-21 14:31:17 +0000988<li><code>ConstantExpr::getGetElementPtr</code></li>
989<li><code>ConstantExpr::getInBoundsGetElementPtr</code></li>
Jay Foad558d3762011-07-14 09:19:05 +0000990<li><code>ConstantExpr::getIndices</code></li>
991<li><code>ConstantExpr::getInsertElement</code></li>
992<li><code>ConstantExpr::getWithOperands</code></li>
Jay Foad1d2f5692011-07-19 13:32:40 +0000993<li><code>ConstantFoldCall</code> (in <code>llvm/Analysis/ConstantFolding.h</code>)</li>
994<li><code>ConstantFoldInstOperands</code> (in <code>llvm/Analysis/ConstantFolding.h</code>)</li>
Jay Foad558d3762011-07-14 09:19:05 +0000995<li><code>ConstantVector::get</code></li>
996<li><code>DIBuilder::createComplexVariable</code></li>
997<li><code>DIBuilder::getOrCreateArray</code></li>
998<li><code>ExtractValueInst::Create</code></li>
999<li><code>ExtractValueInst::getIndexedType</code></li>
1000<li><code>ExtractValueInst::getIndices</code></li>
1001<li><code>FindInsertedValue</code> (in <code>llvm/Analysis/ValueTracking.h</code>)</li>
Jay Foadca12a212011-07-19 14:42:50 +00001002<li><code>gep_type_begin</code> (in <code>llvm/Support/GetElementPtrTypeIterator.h</code>)</li>
1003<li><code>gep_type_end</code> (in <code>llvm/Support/GetElementPtrTypeIterator.h</code>)</li>
Jay Foada9203102011-07-25 09:48:08 +00001004<li><code>GetElementPtrInst::Create</code></li>
1005<li><code>GetElementPtrInst::CreateInBounds</code></li>
1006<li><code>GetElementPtrInst::getIndexedType</code></li>
Jay Foadb60e8512011-07-21 14:42:51 +00001007<li><code>InsertValueInst::Create</code></li>
1008<li><code>InsertValueInst::getIndices</code></li>
1009<li><code>InvokeInst::Create</code></li>
Jay Foada3efbb12011-07-15 08:37:34 +00001010<li><code>IRBuilder::CreateCall</code></li>
Jay Foad558d3762011-07-14 09:19:05 +00001011<li><code>IRBuilder::CreateExtractValue</code></li>
Jay Foad0a2a60a2011-07-22 08:16:57 +00001012<li><code>IRBuilder::CreateGEP</code></li>
1013<li><code>IRBuilder::CreateInBoundsGEP</code></li>
Jay Foad558d3762011-07-14 09:19:05 +00001014<li><code>IRBuilder::CreateInsertValue</code></li>
Jay Foada3efbb12011-07-15 08:37:34 +00001015<li><code>IRBuilder::CreateInvoke</code></li>
Jay Foad558d3762011-07-14 09:19:05 +00001016<li><code>MDNode::get</code></li>
1017<li><code>MDNode::getIfExists</code></li>
1018<li><code>MDNode::getTemporary</code></li>
1019<li><code>MDNode::getWhenValsUnresolved</code></li>
Jay Foadb9b54eb2011-07-19 15:07:52 +00001020<li><code>SimplifyGEPInst</code> (in <code>llvm/Analysis/InstructionSimplify.h</code>)</li>
Jay Foad8fbbb392011-07-19 14:01:37 +00001021<li><code>TargetData::getIndexedOffset</code></li>
Jay Foad558d3762011-07-14 09:19:05 +00001022</ul></li>
1023
1024<li>All forms of <code>StringMap::getOrCreateValue</code> have been remove
1025 except for the one which takes a <code>StringRef</code>.</li>
1026
Bill Wendling16005252011-08-02 06:20:17 +00001027<li>The <code>LLVMBuildUnwind</code> function from the C API was removed. The
1028 LLVM <code>unwind</code> instruction has been deprecated for a long time and
Bill Wendling086da7e2011-08-02 06:39:13 +00001029 isn't used by the current front-ends. So this was removed during the
Bill Wendling16005252011-08-02 06:20:17 +00001030 exception handling rewrite.</li>
1031
Bill Wendling2626dba2011-08-03 22:18:20 +00001032<li>The <code>LLVMAddLowerSetJmpPass</code> function from the C API was removed
1033 because the <code>LowerSetJmp</code> pass was removed.</li>
1034
Devang Patel6326a422011-08-15 23:00:00 +00001035<li>The <code>DIBuilder</code> interface used by front ends to encode debugging
1036 information in the LLVM IR now expects clients to use <code>DIBuilder::finalize()</code>
1037 at the end of translation unit to complete debugging information encoding.</li>
1038
Torok Edwinf16e2d42011-09-30 13:07:52 +00001039<li>The way the type system works has been rewritten: <code>PATypeHolder</code>
1040and <code>OpaqueType</code> are gone, and all APIs deal with <code>Type*</code>
1041instead of <code>const Type*</code>.
1042If you need to create recursive structures, then create a named structure,
1043and use <code>setBody()</code> when all its elements are built.
1044Type merging and refining is gone too: named structures are not
1045merged with other structures, even if their layout is identical.
1046(of course anonymous structures are still uniqued by layout).
1047</li>
1048
1049<li>TargetSelect.h moved to Support/ from Target/</li>
1050
1051<li>UpgradeIntrinsicCall no longer upgrades pre-2.9 intrinsic calls
1052(for example <code>llvm.memset.i32</code>).</li>
1053
1054<li>It is mandatory to initialize all out-of-tree passes too and their dependencies now with
1055<code>INITIALIZE_PASS{BEGIN,END,}</code> and <code>INITIALIZE_{PASS,AG}_DEPENDENCY</code>.</li>
1056
Eli Friedmanb4141422011-10-13 22:14:57 +00001057<li>The interface for MemDepResult in MemoryDependenceAnalysis has been enhanced
1058 with new return types Unknown and NonFuncLocal, in addition to the existing
1059 types Clobber, Def, and NonLocal.</li>
1060
Daniel Dunbarf0233c62010-10-04 20:11:41 +00001061</ul>
1062</div>
Chris Lattnerf6662f92008-10-13 17:57:36 +00001063
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +00001064</div>
1065
Chris Lattner79c3fe12003-10-02 04:57:28 +00001066<!-- *********************************************************************** -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001067<h2>
Misha Brukman500bc302003-11-22 00:38:41 +00001068 <a name="knownproblems">Known Problems</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001069</h2>
Chris Lattner79c3fe12003-10-02 04:57:28 +00001070<!-- *********************************************************************** -->
1071
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +00001072<div>
Misha Brukman500bc302003-11-22 00:38:41 +00001073
Mikhail Glushenkovf795ef02009-03-01 18:09:47 +00001074<p>This section contains significant known problems with the LLVM system,
Chris Lattnere18b32e2008-11-10 05:40:34 +00001075listed by component. If you run into a problem, please check the <a
Chris Lattnerc463b272005-10-29 07:07:09 +00001076href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
Chris Lattner5eccca42003-12-12 21:22:16 +00001077there isn't already one.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +00001078
Chris Lattnerf5ee1702004-03-14 02:03:02 +00001079<!-- ======================================================================= -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001080<h3>
Chris Lattnerf5ee1702004-03-14 02:03:02 +00001081 <a name="experimental">Experimental features included with this release</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001082</h3>
Chris Lattner79c3fe12003-10-02 04:57:28 +00001083
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +00001084<div>
Chris Lattnerf5ee1702004-03-14 02:03:02 +00001085
Misha Brukman6df9e2c2004-05-12 21:46:05 +00001086<p>The following components of this LLVM release are either untested, known to
1087be broken or unreliable, or are in early development. These components should
1088not be relied on, and bugs should not be filed against them, but they may be
1089useful to some people. In particular, if you would like to work on one of these
Chris Lattner2b659ef2008-02-12 06:29:45 +00001090components, please contact us on the <a
1091href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p>
Chris Lattnerf5ee1702004-03-14 02:03:02 +00001092
1093<ul>
Dan Gohman3e6157d2011-10-25 00:05:42 +00001094<li>The Alpha, CellSPU, MicroBlaze, MSP430, MIPS, PTX,
Chris Lattnerbb117712010-10-04 01:29:06 +00001095 and XCore backends are experimental.</li>
Chris Lattner7d9b6b42010-10-02 21:59:30 +00001096<li><tt>llc</tt> "<tt>-filetype=obj</tt>" is experimental on all targets
Chris Lattner49123fd2011-04-06 06:29:50 +00001097 other than darwin and ELF X86 systems.</li>
Chris Lattnerbe2e1b52011-03-10 07:43:44 +00001098
Chris Lattnerf5ee1702004-03-14 02:03:02 +00001099</ul>
1100
1101</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +00001102
Misha Brukman500bc302003-11-22 00:38:41 +00001103<!-- ======================================================================= -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001104<h3>
Chris Lattner26299222006-11-18 07:51:14 +00001105 <a name="x86-be">Known problems with the X86 back-end</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001106</h3>
John Criswellc0c186d2005-11-08 21:11:33 +00001107
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +00001108<div>
John Criswellc0c186d2005-11-08 21:11:33 +00001109
1110<ul>
Anton Korobeynikova6094be2008-06-08 10:24:13 +00001111 <li>The X86 backend does not yet support
1112 all <a href="http://llvm.org/PR879">inline assembly that uses the X86
1113 floating point stack</a>. It supports the 'f' and 't' constraints, but not
1114 'u'.</li>
Dan Gohman8207ba92008-06-08 23:05:11 +00001115 <li>The X86-64 backend does not yet support the LLVM IR instruction
Chris Lattner914ce462010-04-22 06:28:20 +00001116 <tt>va_arg</tt>. Currently, front-ends support variadic
Dan Gohman8207ba92008-06-08 23:05:11 +00001117 argument constructs on X86-64 by lowering them manually.</li>
NAKAMURA Takumi45c435a2011-04-05 08:24:22 +00001118 <li>Windows x64 (aka Win64) code generator has a few issues.
1119 <ul>
1120 <li>llvm-gcc cannot build the mingw-w64 runtime currently
1121 due to lack of support for the 'u' inline assembly
1122 constraint and for X87 floating point inline assembly.</li>
1123 <li>On mingw-w64, you will see unresolved symbol <tt>__chkstk</tt>
1124 due to <a href="http://llvm.org/bugs/show_bug.cgi?id=8919">Bug 8919</a>.
1125 It is fixed in <a href="http://lists.cs.uiuc.edu/pipermail/llvm-commits/Week-of-Mon-20110321/118499.html">r128206</a>.</li>
1126 <li>Miss-aligned MOVDQA might crash your program. It is due to
1127 <a href="http://llvm.org/bugs/show_bug.cgi?id=9483">Bug 9483</a>,
1128 lack of handling aligned internal globals.</li>
1129 </ul>
1130 </li>
1131
Chris Lattner26299222006-11-18 07:51:14 +00001132</ul>
1133
1134</div>
1135
1136<!-- ======================================================================= -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001137<h3>
Chris Lattner26299222006-11-18 07:51:14 +00001138 <a name="ppc-be">Known problems with the PowerPC back-end</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001139</h3>
Chris Lattner26299222006-11-18 07:51:14 +00001140
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +00001141<div>
Chris Lattner26299222006-11-18 07:51:14 +00001142
1143<ul>
Nicolas Geoffraye4285dc2007-05-15 09:21:28 +00001144<li>The Linux PPC32/ABI support needs testing for the interpreter and static
Chris Lattner57a460e2007-05-23 04:39:32 +00001145compilation, and lacks support for debug information.</li>
Chris Lattner26299222006-11-18 07:51:14 +00001146</ul>
1147
1148</div>
1149
1150<!-- ======================================================================= -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001151<h3>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +00001152 <a name="arm-be">Known problems with the ARM back-end</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001153</h3>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +00001154
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +00001155<div>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +00001156
1157<ul>
Chris Lattner57a460e2007-05-23 04:39:32 +00001158<li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
Duncan Sandsc90d68b2007-09-26 15:59:54 +00001159processors, thumb programs can crash or produce wrong
Chris Lattner57a460e2007-05-23 04:39:32 +00001160results (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
John Criswell524a5dd2009-03-02 15:28:15 +00001161<li>Compilation for ARM Linux OABI (old ABI) is supported but not fully tested.
Chris Lattnerf3e5bc62007-05-14 06:56:09 +00001162</li>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +00001163</ul>
1164
1165</div>
1166
1167<!-- ======================================================================= -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001168<h3>
Chris Lattner26299222006-11-18 07:51:14 +00001169 <a name="sparc-be">Known problems with the SPARC back-end</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001170</h3>
Chris Lattner26299222006-11-18 07:51:14 +00001171
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +00001172<div>
Chris Lattner26299222006-11-18 07:51:14 +00001173
1174<ul>
John Criswell524a5dd2009-03-02 15:28:15 +00001175<li>The SPARC backend only supports the 32-bit SPARC ABI (-m32); it does not
Chris Lattner26299222006-11-18 07:51:14 +00001176 support the 64-bit SPARC ABI (-m64).</li>
1177</ul>
1178
1179</div>
1180
1181<!-- ======================================================================= -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001182<h3>
Bruno Cardoso Lopesb7e1a4f2008-10-25 14:56:26 +00001183 <a name="mips-be">Known problems with the MIPS back-end</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001184</h3>
Bruno Cardoso Lopesb7e1a4f2008-10-25 14:56:26 +00001185
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +00001186<div>
Bruno Cardoso Lopesb7e1a4f2008-10-25 14:56:26 +00001187
1188<ul>
Bruno Cardoso Lopesb7e1a4f2008-10-25 14:56:26 +00001189<li>64-bit MIPS targets are not supported yet.</li>
1190</ul>
1191
1192</div>
1193
1194<!-- ======================================================================= -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001195<h3>
Chris Lattner26299222006-11-18 07:51:14 +00001196 <a name="alpha-be">Known problems with the Alpha back-end</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001197</h3>
Chris Lattner26299222006-11-18 07:51:14 +00001198
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +00001199<div>
Chris Lattner26299222006-11-18 07:51:14 +00001200
1201<ul>
1202
1203<li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
1204appropriate nops inserted to ensure restartability.</li>
1205
John Criswellc0c186d2005-11-08 21:11:33 +00001206</ul>
1207</div>
1208
Chris Lattner26299222006-11-18 07:51:14 +00001209<!-- ======================================================================= -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001210<h3>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +00001211 <a name="c-be">Known problems with the C back-end</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001212</h3>
Chris Lattner26299222006-11-18 07:51:14 +00001213
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +00001214<div>
Chris Lattner26299222006-11-18 07:51:14 +00001215
Chris Lattner3016ee92010-09-29 05:34:42 +00001216<p>The C backend has numerous problems and is not being actively maintained.
1217Depending on it for anything serious is not advised.</p>
1218
Chris Lattner26299222006-11-18 07:51:14 +00001219<ul>
Chris Lattner5733b272008-06-05 06:35:40 +00001220<li><a href="http://llvm.org/PR802">The C backend has only basic support for
1221 inline assembly code</a>.</li>
Chris Lattner725a0d82007-09-26 06:01:35 +00001222<li><a href="http://llvm.org/PR1658">The C backend violates the ABI of common
1223 C++ programs</a>, preventing intermixing between C++ compiled by the CBE and
Gabor Greif4906abe2009-03-02 12:02:51 +00001224 C++ code compiled with <tt>llc</tt> or native compilers.</li>
Duncan Sandsf74c0cc2008-02-10 13:40:55 +00001225<li>The C backend does not support all exception handling constructs.</li>
Duncan Sands50723a92009-02-25 11:51:54 +00001226<li>The C backend does not support arbitrary precision integers.</li>
Chris Lattner26299222006-11-18 07:51:14 +00001227</ul>
1228
1229</div>
John Criswellc0c186d2005-11-08 21:11:33 +00001230
Misha Brukman500bc302003-11-22 00:38:41 +00001231
1232<!-- ======================================================================= -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001233<h3>
Chris Lattner3016ee92010-09-29 05:34:42 +00001234 <a name="llvm-gcc">Known problems with the llvm-gcc front-end</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001235</h3>
Chris Lattner47588f92003-10-02 05:07:23 +00001236
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +00001237<div>
Chris Lattnerc5d658a2006-03-03 00:34:26 +00001238
Chad Rosiere6291d02011-05-27 22:50:46 +00001239<p><b>LLVM 3.0 will be the last release of llvm-gcc.</b></p>
Chris Lattner49123fd2011-04-06 06:29:50 +00001240
Chris Lattner3016ee92010-09-29 05:34:42 +00001241<p>llvm-gcc is generally very stable for the C family of languages. The only
1242 major language feature of GCC not supported by llvm-gcc is the
1243 <tt>__builtin_apply</tt> family of builtins. However, some extensions
1244 are only supported on some targets. For example, trampolines are only
1245 supported on some targets (these are used when you take the address of a
1246 nested function).</p>
Misha Brukman500bc302003-11-22 00:38:41 +00001247
Chris Lattner3016ee92010-09-29 05:34:42 +00001248<p>Fortran support generally works, but there are still several unresolved bugs
1249 in <a href="http://llvm.org/bugs/">Bugzilla</a>. Please see the
1250 tools/gfortran component for details. Note that llvm-gcc is missing major
1251 Fortran performance work in the frontend and library that went into GCC after
1252 4.2. If you are interested in Fortran, we recommend that you consider using
1253 <a href="#dragonegg">dragonegg</a> instead.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +00001254
Duncan Sands3af96332010-10-04 10:06:56 +00001255<p>The llvm-gcc 4.2 Ada compiler has basic functionality, but is no longer being
1256actively maintained. If you are interested in Ada, we recommend that you
1257consider using <a href="#dragonegg">dragonegg</a> instead.</p>
Chris Lattner2b659ef2008-02-12 06:29:45 +00001258</div>
1259
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +00001260</div>
1261
Chris Lattner79c3fe12003-10-02 04:57:28 +00001262<!-- *********************************************************************** -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001263<h2>
Misha Brukman500bc302003-11-22 00:38:41 +00001264 <a name="additionalinfo">Additional Information</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001265</h2>
Chris Lattner79c3fe12003-10-02 04:57:28 +00001266<!-- *********************************************************************** -->
1267
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +00001268<div>
Misha Brukman500bc302003-11-22 00:38:41 +00001269
Chris Lattner416db102005-05-16 17:13:10 +00001270<p>A wide variety of additional information is available on the <a
NAKAMURA Takumib9a33632011-04-09 02:13:37 +00001271href="http://llvm.org/">LLVM web page</a>, in particular in the <a
Chris Lattnerb4b0ce72007-05-18 00:44:29 +00001272href="http://llvm.org/docs/">documentation</a> section. The web page also
Reid Spencer669ed452007-07-09 08:04:31 +00001273contains versions of the API documentation which is up-to-date with the
1274Subversion version of the source code.
Misha Brukman109d9e82005-03-30 19:14:24 +00001275You can access versions of these documents specific to this release by going
1276into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +00001277
Misha Brukman500bc302003-11-22 00:38:41 +00001278<p>If you have any questions or comments about LLVM, please feel free to contact
Chris Lattnerc463b272005-10-29 07:07:09 +00001279us via the <a href="http://llvm.org/docs/#maillist"> mailing
Chris Lattner5eccca42003-12-12 21:22:16 +00001280lists</a>.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +00001281
Misha Brukman500bc302003-11-22 00:38:41 +00001282</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +00001283
1284<!-- *********************************************************************** -->
Chris Lattner79c3fe12003-10-02 04:57:28 +00001285
Misha Brukman500bc302003-11-22 00:38:41 +00001286<hr>
Misha Brukman2061e892003-11-22 01:23:39 +00001287<address>
Misha Brukman38847d52003-12-21 22:53:21 +00001288 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman44408702008-12-11 17:34:48 +00001289 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
Misha Brukman2061e892003-11-22 01:23:39 +00001290 <a href="http://validator.w3.org/check/referer"><img
Misha Brukman44408702008-12-11 17:34:48 +00001291 src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
Misha Brukman2061e892003-11-22 01:23:39 +00001292
Chris Lattnerb4b0ce72007-05-18 00:44:29 +00001293 <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
Misha Brukman500bc302003-11-22 00:38:41 +00001294 Last modified: $Date$
Misha Brukman2061e892003-11-22 01:23:39 +00001295</address>
Chris Lattner79c3fe12003-10-02 04:57:28 +00001296
Misha Brukman500bc302003-11-22 00:38:41 +00001297</body>
1298</html>