blob: c2d6283fabe08e55f8cc7fc48140cd5eaac5fb9b [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
Bill Wendling7b7fa742011-10-26 18:46:16 +000047 Infrastructure, release 3.0. Here we describe the status of LLVM, including
48 major improvements from the previous release and significant known problems.
49 All LLVM releases may be downloaded from
50 the <a href="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
Bill Wendling7b7fa742011-10-26 18:46:16 +000053 release, please check out the <a href="http://llvm.org/">main LLVM web
54 site</a>. If you have questions or comments,
55 the <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM
56 Developer's Mailing List</a> is a good place to send them.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +000057
Bill Wendling7b7fa742011-10-26 18:46:16 +000058<p>Note that if you are reading this file from a Subversion checkout or the main
59 LLVM web page, this document applies to the <i>next</i> release, not the
60 current one. To see the release notes for a specific release, please see the
61 <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>
Bill Wendling7b7fa742011-10-26 18:46:16 +000081
82<p>The LLVM 3.0 distribution currently consists of code from the core LLVM
83 repository (which roughly includes the LLVM optimizers, code generators and
84 supporting tools), the Clang repository and the llvm-gcc repository. In
85 addition to this code, the LLVM Project includes other sub-projects that are
86 in development. Here we include updates on these subprojects.</p>
Chris Lattner96a445e2008-10-13 18:01:01 +000087
Chris Lattner8348b472008-06-08 21:58:17 +000088<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +000089<h3>
Chris Lattnerfb97b2d2008-10-13 18:11:54 +000090<a name="clang">Clang: C/C++/Objective-C Frontend Toolkit</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +000091</h3>
Chris Lattner8348b472008-06-08 21:58:17 +000092
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +000093<div>
Chris Lattner8348b472008-06-08 21:58:17 +000094
Chris Lattner095539f2010-04-26 17:42:18 +000095<p><a href="http://clang.llvm.org/">Clang</a> is an LLVM front end for the C,
Bill Wendling7b7fa742011-10-26 18:46:16 +000096 C++, and Objective-C languages. Clang aims to provide a better user
97 experience through expressive diagnostics, a high level of conformance to
98 language standards, fast compilation, and low memory use. Like LLVM, Clang
99 provides a modular, library-based architecture that makes it suitable for
100 creating or integrating with other development tools. Clang is considered a
101 production-quality compiler for C, Objective-C, C++ and Objective-C++ on x86
102 (32- and 64-bit), and for darwin/arm targets.</p>
Chris Lattner61358ab2009-10-13 17:48:04 +0000103
Chad Rosiere6291d02011-05-27 22:50:46 +0000104<p>In the LLVM 3.0 time-frame, the Clang team has made many improvements:</p>
Douglas Gregorba087df2011-10-15 00:48:01 +0000105
106<ul>
Bill Wendling7b7fa742011-10-26 18:46:16 +0000107 <li>Greatly improved support for building C++ applications, with greater
108 stability and better diagnostics.</li>
Douglas Gregorba087df2011-10-15 00:48:01 +0000109
Bill Wendling7b7fa742011-10-26 18:46:16 +0000110 <li><a href="http://clang.llvm.org/cxx_status.html">Improved support</a> for
111 the <a href="http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=50372">C++
112 2011</a> standard, including implementations of non-static data member
113 initializers, alias templates, delegating constructors, the range-based
114 for loop, and implicitly-generated move constructors and move assignment
115 operators, among others.</li>
Douglas Gregorba087df2011-10-15 00:48:01 +0000116
Bill Wendling7b7fa742011-10-26 18:46:16 +0000117 <li>Implemented support for some features of the upcoming C1x standard,
118 including static assertions and generic selections.</li>
Douglas Gregorba087df2011-10-15 00:48:01 +0000119
Bill Wendling7b7fa742011-10-26 18:46:16 +0000120 <li>Better detection of include and linking paths for system headers and
121 libraries, especially for Linux distributions.</li>
Douglas Gregorba087df2011-10-15 00:48:01 +0000122
Bill Wendling7b7fa742011-10-26 18:46:16 +0000123 <li>Implemented support
124 for <a href="http://clang.llvm.org/docs/AutomaticReferenceCounting.html">Automatic
125 Reference Counting</a> for Objective-C.</li>
Douglas Gregorba087df2011-10-15 00:48:01 +0000126
Bill Wendling7b7fa742011-10-26 18:46:16 +0000127 <li>Implemented a number of optimizations in <tt>libclang</tt>, the Clang C
128 interface, to improve the performance of code completion and the mapping
129 from source locations to abstract syntax tree nodes.</li>
Douglas Gregorba087df2011-10-15 00:48:01 +0000130</ul>
131
Chris Lattner0a6f6d52011-04-05 07:19:28 +0000132
Duncan Sandsf3ba7af2011-04-06 08:07:40 +0000133<p>If Clang rejects your code but another compiler accepts it, please take a
Bill Wendling7b7fa742011-10-26 18:46:16 +0000134 look at the <a href="http://clang.llvm.org/compatibility.html">language
135 compatibility</a> guide to make sure this is not intentional or a known
136 issue.</p>
Bill Wendling741748a2008-10-27 09:27:33 +0000137
Chris Lattnerfb97b2d2008-10-13 18:11:54 +0000138</div>
139
140<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000141<h3>
Duncan Sands528a5102011-04-04 11:09:08 +0000142<a name="dragonegg">DragonEgg: GCC front-ends, LLVM back-end</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000143</h3>
Chris Lattner61358ab2009-10-13 17:48:04 +0000144
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000145<div>
Bill Wendling7b7fa742011-10-26 18:46:16 +0000146<p><a href="http://dragonegg.llvm.org/">DragonEgg</a> is a
147 <a href="http://gcc.gnu.org/wiki/plugins">gcc plugin</a> that replaces GCC's
148 optimizers and code generators with LLVM's. Currently it requires a patched
149 version of gcc-4.5. The plugin can target the x86-32 and x86-64 processor
150 families and has been used successfully on the Darwin, FreeBSD and Linux
151 platforms. The Ada, C, C++ and Fortran languages work well. The plugin is
152 capable of compiling plenty of Obj-C, Obj-C++ and Java but it is not known
153 whether the compiled code actually works or not!</p>
Duncan Sands749fd832010-04-02 09:23:15 +0000154
Bill Wendling7b7fa742011-10-26 18:46:16 +0000155<p>The 3.0 release has the following notable changes:</p>
156
Duncan Sands4b1da2b2010-09-30 17:37:34 +0000157<ul>
Chad Rosiere6291d02011-05-27 22:50:46 +0000158<!--
159<li></li>
160-->
Duncan Sands4b1da2b2010-09-30 17:37:34 +0000161</ul>
Chris Lattner61358ab2009-10-13 17:48:04 +0000162
163</div>
164
Chris Lattner75547712010-10-03 23:49:06 +0000165<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000166<h3>
Chris Lattner75547712010-10-03 23:49:06 +0000167<a name="compiler-rt">compiler-rt: Compiler Runtime Library</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000168</h3>
Chris Lattner75547712010-10-03 23:49:06 +0000169
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000170<div>
Bill Wendling7b7fa742011-10-26 18:46:16 +0000171
172<p>The new LLVM <a href="http://compiler-rt.llvm.org/">compiler-rt project</a>
173 is a simple library that provides an implementation of the low-level
174 target-specific hooks required by code generation and other runtime
175 components. For example, when compiling for a 32-bit target, converting a
176 double to a 64-bit unsigned integer is compiled into a runtime call to the
177 "__fixunsdfdi" function. The compiler-rt library provides highly optimized
178 implementations of this and other low-level routines (some are 3x faster than
179 the equivalent libgcc routines).</p>
Chris Lattner75547712010-10-03 23:49:06 +0000180
Chad Rosiere6291d02011-05-27 22:50:46 +0000181<p>In the LLVM 3.0 timeframe,</p>
Chris Lattner75547712010-10-03 23:49:06 +0000182
183</div>
Chris Lattner61358ab2009-10-13 17:48:04 +0000184
185<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000186<h3>
Chris Lattnere07043c2010-09-29 05:30:03 +0000187<a name="lldb">LLDB: Low Level Debugger</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000188</h3>
Chris Lattnere07043c2010-09-29 05:30:03 +0000189
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000190<div>
Chris Lattnere07043c2010-09-29 05:30:03 +0000191
Bill Wendling7b7fa742011-10-26 18:46:16 +0000192<p>LLDB has advanced by leaps and bounds in the 3.0 timeframe. It is
193 dramatically more stable and useful, and includes both a
194 new <a href="http://lldb.llvm.org/tutorial.html">tutorial</a> and
195 a <a href="http://lldb.llvm.org/lldb-gdb.html">side-by-side comparison with
196 GDB</a>.</p>
Chris Lattnere07043c2010-09-29 05:30:03 +0000197
198</div>
199
200<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000201<h3>
Chris Lattnere07043c2010-09-29 05:30:03 +0000202<a name="libc++">libc++: C++ Standard Library</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000203</h3>
Chris Lattnere07043c2010-09-29 05:30:03 +0000204
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000205<div>
Chris Lattnere07043c2010-09-29 05:30:03 +0000206
Bill Wendling7b7fa742011-10-26 18:46:16 +0000207<p>Like compiler_rt, libc++ is now <a href="DeveloperPolicy.html#license">dual
208 licensed</a> under the MIT and UIUC license, allowing it to be used more
209 permissively.</p>
Chris Lattnere07043c2010-09-29 05:30:03 +0000210
211</div>
212
Chris Lattner61358ab2009-10-13 17:48:04 +0000213
Chris Lattner3d6a80a2011-04-07 03:08:22 +0000214<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000215<h3>
Chris Lattner3d6a80a2011-04-07 03:08:22 +0000216<a name="LLBrowse">LLBrowse: IR Browser</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000217</h3>
Daniel Dunbar97b01a82010-10-04 17:39:47 +0000218
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000219<div>
Bill Wendling7b7fa742011-10-26 18:46:16 +0000220
221<p><a href="http://llvm.org/svn/llvm-project/llbrowse/trunk/doc/LLBrowse.html">
222 LLBrowse</a> is an interactive viewer for LLVM modules. It can load any LLVM
223 module and displays its contents as an expandable tree view, facilitating an
224 easy way to inspect types, functions, global variables, or metadata nodes. It
225 is fully cross-platform, being based on the popular wxWidgets GUI
226 toolkit.</p>
227
Chris Lattner3d6a80a2011-04-07 03:08:22 +0000228</div>
229
230<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000231<h3>
Chris Lattner3d6a80a2011-04-07 03:08:22 +0000232<a name="vmkit">VMKit</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000233</h3>
Chris Lattner3d6a80a2011-04-07 03:08:22 +0000234
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000235<div>
Bill Wendling7b7fa742011-10-26 18:46:16 +0000236
Chris Lattner3d6a80a2011-04-07 03:08:22 +0000237<p>The <a href="http://vmkit.llvm.org/">VMKit project</a> is an implementation
Bill Wendling7b7fa742011-10-26 18:46:16 +0000238 of a Java Virtual Machine (Java VM or JVM) that uses LLVM for static and
239 just-in-time compilation. As of LLVM 3.0, VMKit now supports generational
240 garbage collectors. The garbage collectors are provided by the MMTk
241 framework, and VMKit can be configured to use one of the numerous implemented
242 collectors of MMTk.</p>
243
Chris Lattner3d6a80a2011-04-07 03:08:22 +0000244</div>
245
246
Daniel Dunbar97b01a82010-10-04 17:39:47 +0000247<!--=========================================================================-->
Chris Lattner7a8e6c52011-04-05 18:38:45 +0000248<!--
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000249<h3>
Daniel Dunbar97b01a82010-10-04 17:39:47 +0000250<a name="klee">KLEE: A Symbolic Execution Virtual Machine</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000251</h3>
Daniel Dunbar97b01a82010-10-04 17:39:47 +0000252
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000253<div>
Daniel Dunbar97b01a82010-10-04 17:39:47 +0000254<p>
255<a href="http://klee.llvm.org/">KLEE</a> is a symbolic execution framework for
256programs in LLVM bitcode form. KLEE tries to symbolically evaluate "all" paths
257through the application and records state transitions that lead to fault
258states. This allows it to construct testcases that lead to faults and can even
259be used to verify some algorithms.
260</p>
261
Chris Lattnerbe2e1b52011-03-10 07:43:44 +0000262<p>UPDATE!</p>
Chris Lattner7a8e6c52011-04-05 18:38:45 +0000263</div>-->
Daniel Dunbar97b01a82010-10-04 17:39:47 +0000264
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000265</div>
Daniel Dunbar97b01a82010-10-04 17:39:47 +0000266
Chris Lattnerab68e9e2009-02-26 22:33:38 +0000267<!-- *********************************************************************** -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000268<h2>
Chad Rosiere6291d02011-05-27 22:50:46 +0000269 <a name="externalproj">External Open Source Projects Using LLVM 3.0</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000270</h2>
Chris Lattnerab68e9e2009-02-26 22:33:38 +0000271<!-- *********************************************************************** -->
272
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000273<div>
Chris Lattner61358ab2009-10-13 17:48:04 +0000274
275<p>An exciting aspect of LLVM is that it is used as an enabling technology for
276 a lot of other language and tools projects. This section lists some of the
Chad Rosiere6291d02011-05-27 22:50:46 +0000277 projects that have already been updated to work with LLVM 3.0.</p>
Chris Lattner75547712010-10-03 23:49:06 +0000278
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000279<!--=========================================================================-->
Bill Wendling7be6bc52011-10-26 00:17:54 +0000280<h3>AddressSanitizer</h3>
281
282<div>
283
284<p><a href="http://code.google.com/p/address-sanitizer/">AddressSanitizer</a>
285 uses compiler instrumentation and a specialized malloc library to find C/C++
286 bugs such as use-after-free and out-of-bound accesses to heap, stack, and
287 globals. The key feature of the tool is speed: the average slowdown
288 introduced by AddressSanitizer is less than 2x.</p>
289
290</div>
291
292<!--=========================================================================-->
Bill Wendling29817ea2011-10-26 00:14:36 +0000293<h3>ClamAV</h3>
294
295<div>
Bill Wendlingf2a78332011-10-25 01:01:42 +0000296
Bill Wendling29817ea2011-10-26 00:14:36 +0000297<p><a href="http://www.clamav.net">Clam AntiVirus</a> is an open source (GPL)
298 anti-virus toolkit for UNIX, designed especially for e-mail scanning on mail
299 gateways.</p>
300
301<p>Since version 0.96 it
302 has <a href="http://vrt-sourcefire.blogspot.com/2010/09/introduction-to-clamavs-low-level.html">bytecode
303 signatures</a> that allow writing detections for complex malware.</p>
304
305<p>It uses LLVM's JIT to speed up the execution of bytecode on X86, X86-64,
306 PPC32/64, falling back to its own interpreter otherwise. The git version was
307 updated to work with LLVM 3.0.</p>
308
309</div>
310
311<!--=========================================================================-->
Bill Wendling65d1f412011-10-26 18:23:06 +0000312<h3>clReflect</h3>
313
314<div>
315
316<p><a href="https://bitbucket.org/dwilliamson/clreflect">clReflect</a> is a C++
317 parser that uses clang/LLVM to derive a light-weight reflection database
318 suitable for use in game development. It comes with a very simple runtime
319 library for loading and querying the database, requiring no external
320 dependencies (including CRT), and an additional utility library for object
321 management and serialisation.</p>
322
323</div>
324
325<!--=========================================================================-->
Bill Wendling63507d12011-10-29 01:10:01 +0000326<h3>Cling C++ Interpreter</h3>
327
328<div>
329
330<p><a href="http://cern.ch/cling">Cling</a> is an interactive compiler interface
331 (aka C++ interpreter). It uses LLVM's JIT and clang; it currently supports
332 C++ and C. It has a prompt interface, runs source files, calls into shared
333 libraries, prints the value of expressions, even does runtime lookup of
334 identifiers (dynamic scopes). And it just behaves like one would expect from
335 an interpreter.</p>
336
337</div>
338
339<!--=========================================================================-->
Bill Wendlingf2a78332011-10-25 01:01:42 +0000340<!-- FIXME: Comment out
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000341<h3>Crack Programming Language</h3>
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000342
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000343<div>
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000344<p>
345<a href="http://code.google.com/p/crack-language/">Crack</a> aims to provide the
346ease of development of a scripting language with the performance of a compiled
347language. The language derives concepts from C++, Java and Python, incorporating
348object-oriented programming, operator overloading and strong typing.</p>
349</div>
Bill Wendlingf2a78332011-10-25 01:01:42 +0000350-->
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000351
352<!--=========================================================================-->
Bill Wendlingf9778192011-10-26 00:09:55 +0000353<h3>Glasgow Haskell Compiler (GHC)</h3>
354
355<div>
356
357<p>GHC is an open source, state-of-the-art programming suite for Haskell, a
358 standard lazy functional programming language. It includes an optimizing
359 static compiler generating good code for a variety of platforms, together
360 with an interactive system for convenient, quick development.</p>
361
362<p>GHC 7.0 and onwards include an LLVM code generator, supporting LLVM 2.8 and
363 later. Since LLVM 2.9, GHC now includes experimental support for the ARM
364 platform with LLVM 3.0.</p>
365
366</div>
367
368<!--=========================================================================-->
Bill Wendlingf62333d2011-10-25 20:35:31 +0000369<h3>gwXscript</h3>
370
371<div>
372
373<p><a href="http://botwars.tk/gwscript/">gwXscript</a> is an object oriented,
Bill Wendling7c38de22011-10-26 04:24:15 +0000374 aspect oriented programming language which can create both executables (ELF,
Bill Wendlingf62333d2011-10-25 20:35:31 +0000375 EXE) and shared libraries (DLL, SO, DYNLIB). The compiler is implemented in
376 its own language and translates scripts into LLVM-IR which can be optimized
377 and translated into native code by the LLVM framework. Source code in
378 gwScript contains definitions that expand the namespaces. So you can build
379 your project and simply 'plug out' features by removing a file. The remaining
380 project does not leave scars since you directly separate concerns by the
381 'template' feature of gwX. It is also possible to add new features to a
382 project by just adding files and without editing the original project. This
383 language is used for example to create games or content management systems
384 that should be extendable.</p>
385
386<p>gwXscript is strongly typed and offers comfort with its native types string,
387 hash and array. You can easily write new libraries in gwXscript or native
388 code. gwXscript is type safe and users should not be able to crash your
389 program or execute malicious code except code that is eating CPU time.</p>
390
391</div>
392
393<!--=========================================================================-->
Bill Wendling50cacc82011-10-26 22:55:18 +0000394<h3>include-what-you-use</h3>
395
396<div>
397
398<p><a href="http://code.google.com/p/include-what-you-use">include-what-you-use</a>
399 is a tool to ensure that a file directly <code>#include</code>s
400 all <code>.h</code> files that provide a symbol that the file uses. It also
401 removes superfluous <code>#include</code>s from source files.</p>
402
403</div>
404
405<!--=========================================================================-->
Bill Wendling57fd8762011-10-26 18:20:54 +0000406<h3>LanguageKit and Pragmatic Smalltalk</h3>
407
408<div>
409
410<p><a href="http://etoileos.com/etoile/features/languagekit/">LanguageKit</a> is
411 a framework for implementing dynamic languages sharing an object model with
412 Objective-C. It provides static and JIT compilation using LLVM along with
413 its own interpreter. Pragmatic Smalltalk is a dialect of Smalltalk, built on
414 top of LanguageKit, that interfaces directly with Objective-C, sharing the
415 same object representation and message sending behaviour. These projects are
416 developed as part of the &Eacute;toi&eacute; desktop environment.</p>
417
418</div>
419
420<!--=========================================================================-->
Bill Wendlingd4821b82011-10-26 00:16:17 +0000421<h3>Mono</h3>
422
423<div>
424
425<p>An open source, cross-platform implementation of C# and the CLR that is
426 binary compatible with Microsoft.NET. Has an optional, dynamically-loaded
427 LLVM code generation backend in Mini, the JIT compiler.</p>
428
429<p>Note that we use a Git mirror of LLVM with some patches. See:
430 https://github.com/mono/llvm</p>
431
432</div>
433
434<!--=========================================================================-->
Bill Wendlingba226272011-10-25 20:37:45 +0000435<h3>Portable OpenCL (pocl)</h3>
436
437<div>
438
439<p>Portable OpenCL is an open source implementation of the OpenCL standard which
440 can be easily adapted for new targets. One of the goals of the project is
441 improving performance portability of OpenCL programs, avoiding the need for
442 target-dependent manual optimizations. A "native" target is included, which
443 allows running OpenCL kernels on the host (CPU).</p>
444
445</div>
446
447<!--=========================================================================-->
Bill Wendling0bad98c2011-10-25 20:39:06 +0000448<h3>Pure</h3>
449
450<div>
451<p><a href="http://pure-lang.googlecode.com/">Pure</a> is an
452 algebraic/functional programming language based on term rewriting. Programs
453 are collections of equations which are used to evaluate expressions in a
454 symbolic fashion. The interpreter uses LLVM as a backend to JIT-compile Pure
455 programs to fast native code. Pure offers dynamic typing, eager and lazy
456 evaluation, lexical closures, a hygienic macro system (also based on term
457 rewriting), built-in list and matrix support (including list and matrix
458 comprehensions) and an easy-to-use interface to C and other programming
459 languages (including the ability to load LLVM bitcode modules, and inline C,
460 C++, Fortran and Faust code in Pure programs if the corresponding LLVM-enabled
461 compilers are installed).</p>
462
463<p>Pure version 0.48 has been tested and is known to work with LLVM 3.0
464 (and continues to work with older LLVM releases &gt;= 2.5).</p>
465
466</div>
467
468<!--=========================================================================-->
Bill Wendling537d85b2011-10-26 00:12:04 +0000469<h3>Renderscript</h3>
470
471<div>
472
473<p><a href="http://developer.android.com/guide/topics/renderscript/index.html">Renderscript</a>
474 is Android's advanced 3D graphics rendering and compute API. It provides a
475 portable C99-based language with extensions to facilitate common use cases
476 for enhancing graphics and thread level parallelism. The Renderscript
477 compiler frontend is based on Clang/LLVM. It emits a portable bitcode format
478 for the actual compiled script code, as well as reflects a Java interface for
479 developers to control the execution of the compiled bitcode. Executable
480 machine code is then generated from this bitcode by an LLVM backend on the
481 device. Renderscript is thus able to provide a mechanism by which Android
482 developers can improve performance of their applications while retaining
483 portability.</p>
484
485</div>
486
487<!--=========================================================================-->
Bill Wendling7d5b6212011-10-25 20:40:26 +0000488<h3>SAFECode</h3>
489
490<div>
491
492<p><a href="http://safecode.cs.illinois.edu">SAFECode</a> is a memory safe C/C++
493 compiler built using LLVM. It takes standard, unannotated C/C++ code,
494 analyzes the code to ensure that memory accesses and array indexing
495 operations are safe, and instruments the code with run-time checks when
496 safety cannot be proven statically. SAFECode can be used as a debugging aid
497 (like Valgrind) to find and repair memory safety bugs. It can also be used
498 to protect code from security attacks at run-time.</p>
499
500</div>
501
502<!--=========================================================================-->
Bill Wendling02b77b72011-10-26 07:38:19 +0000503<h3>The Stupid D Compiler (SDC)</h3>
504
505<div>
506
507<p><a href="https://github.com/bhelyer/SDC">The Stupid D Compiler</a> is a
508 project seeking to write a self-hosting compiler for the D programming
509 language without using the frontend of the reference compiler (DMD).</p>
510
511</div>
512
513<!--=========================================================================-->
Bill Wendling2d7b4af2011-10-25 20:24:32 +0000514<h3>TTA-based Co-design Environment (TCE)</h3>
515
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000516<div>
Bill Wendling2d7b4af2011-10-25 20:24:32 +0000517
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000518<p>TCE is a toolset for designing application-specific processors (ASP) based on
Bill Wendling2d7b4af2011-10-25 20:24:32 +0000519 the Transport triggered architecture (TTA). The toolset provides a complete
520 co-design flow from C/C++ programs down to synthesizable VHDL and parallel
521 program binaries. Processor customization points include the register files,
522 function units, supported operations, and the interconnection network.</p>
Bill Wendling7b7fa742011-10-26 18:46:16 +0000523
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000524<p>TCE uses Clang and LLVM for C/C++ language support, target independent
Bill Wendling2d7b4af2011-10-25 20:24:32 +0000525 optimizations and also for parts of code generation. It generates new
Bill Wendling7b7fa742011-10-26 18:46:16 +0000526 LLVM-based code generators "on the fly" for the designed TTA processors and
527 loads them in to the compiler backend as runtime libraries to avoid
Bill Wendling2d7b4af2011-10-25 20:24:32 +0000528 per-target recompilation of larger parts of the compiler chain.</p>
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000529
Bill Wendling7b7fa742011-10-26 18:46:16 +0000530</div>
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000531
532<!--=========================================================================-->
Bill Wendling628c2662011-10-25 20:27:37 +0000533<h3>Tart Programming Language</h3>
534
535<div>
536
537<p><a href="http://code.google.com/p/tart/">Tart</a> is a general-purpose,
538 strongly typed programming language designed for application
539 developers. Strongly inspired by Python and C#, Tart focuses on practical
540 solutions for the professional software developer, while avoiding the clutter
541 and boilerplate of legacy languages like Java and C++. Although Tart is still
542 in development, the current implementation supports many features expected of
543 a modern programming language, such as garbage collection, powerful
544 bidirectional type inference, a greatly simplified syntax for template
545 metaprogramming, closures and function literals, reflection, operator
546 overloading, explicit mutability and immutability, and much more. Tart is
547 flexible enough to accommodate a broad range of programming styles and
548 philosophies, while maintaining a strong commitment to simplicity, minimalism
549 and elegance in design.</p>
550
551</div>
552
553<!--=========================================================================-->
Bill Wendling644ce532011-10-26 09:25:01 +0000554<h3>ThreadSanitizer</h3>
555
556<div>
557
558<p><a href="http://code.google.com/p/data-race-test/">ThreadSanitizer</a> is a
559 data race detector for (mostly) C and C++ code, available for Linux, Mac OS
560 and Windows. On different systems, we use binary instrumentation frameworks
Bill Wendlingae8538e2011-10-29 01:11:15 +0000561 (Valgrind and Pin) as frontends that generate the program events for the race
562 detection algorithm. On Linux, there's an option of using LLVM-based
563 compile-time instrumentation.</p>
Bill Wendling644ce532011-10-26 09:25:01 +0000564
565</div>
566
567<!--=========================================================================-->
Bill Wendling8a924c62011-10-26 07:42:45 +0000568<h3>The ZooLib C++ Cross-Platform Application Framework</h3>
569
570<div>
571
572<p><a href="http://www.zoolib.org/">ZooLib</a> is Open Source under the MIT
573 License. It provides GUI, filesystem access, TCP networking, thread-safe
574 memory management, threading and locking for Mac OS X, Classic Mac OS,
575 Microsoft Windows, POSIX operating systems with X11, BeOS, Haiku, Apple's iOS
576 and Research in Motion's BlackBerry.</p>
577
578<p>My current work is to use CLang's static analyzer to improve ZooLib's code
579 quality. I also plan to set up LLVM compiles of the demo programs and test
580 programs using CLang and LLVM on all the platforms that CLang, LLVM and
581 ZooLib all support.</p>
582
583</div>
584
585<!--=========================================================================-->
Bill Wendlingf2a78332011-10-25 01:01:42 +0000586<!--
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000587<h3>PinaVM</h3>
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000588
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000589<div>
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000590<p><a href="http://gitorious.org/pinavm/pages/Home">PinaVM</a> is an open
591source, <a href="http://www.systemc.org/">SystemC</a> front-end. Unlike many
592other front-ends, PinaVM actually executes the elaboration of the
593program analyzed using LLVM's JIT infrastructure. It later enriches the
594bitcode with SystemC-specific information.</p>
595</div>
Bill Wendlingf2a78332011-10-25 01:01:42 +0000596-->
597
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000598
599<!--=========================================================================-->
Bill Wendlingf2a78332011-10-25 01:01:42 +0000600<!--
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000601<h3 id="icedtea">IcedTea Java Virtual Machine Implementation</h3>
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000602
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000603<div>
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000604<p>
605<a href="http://icedtea.classpath.org/wiki/Main_Page">IcedTea</a> provides a
606harness to build OpenJDK using only free software build tools and to provide
607replacements for the not-yet free parts of OpenJDK. One of the extensions that
608IcedTea provides is a new JIT compiler named <a
609href="http://icedtea.classpath.org/wiki/ZeroSharkFaq">Shark</a> which uses LLVM
610to provide native code generation without introducing processor-dependent
611code.
612</p>
613
614<p> OpenJDK 7 b112, IcedTea6 1.9 and IcedTea7 1.13 and later have been tested
Chad Rosiere6291d02011-05-27 22:50:46 +0000615and are known to work with LLVM 3.0 (and continue to work with older LLVM
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000616releases &gt;= 2.6 as well).</p>
617</div>
Bill Wendlingf2a78332011-10-25 01:01:42 +0000618-->
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000619
620<!--=========================================================================-->
Bill Wendlingf2a78332011-10-25 01:01:42 +0000621<!--
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000622<h3>Polly - Polyhedral optimizations for LLVM</h3>
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000623
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000624<div>
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000625<p>Polly is a project that aims to provide advanced memory access optimizations
626to better take advantage of SIMD units, cache hierarchies, multiple cores or
627even vector accelerators for LLVM. Built around an abstract mathematical
628description based on Z-polyhedra, it provides the infrastructure to develop
629advanced optimizations in LLVM and to connect complex external optimizers. In
630its first year of existence Polly already provides an exact value-based
631dependency analysis as well as basic SIMD and OpenMP code generation support.
632Furthermore, Polly can use PoCC(Pluto) an advanced optimizer for data-locality
633and parallelism.</p>
634</div>
Bill Wendlingf2a78332011-10-25 01:01:42 +0000635-->
Chris Lattner75547712010-10-03 23:49:06 +0000636
Chris Lattner0fa5da92011-04-06 16:14:25 +0000637<!--=========================================================================-->
Bill Wendlingf2a78332011-10-25 01:01:42 +0000638<!--
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000639<h3>Rubinius</h3>
Chris Lattner0fa5da92011-04-06 16:14:25 +0000640
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000641<div>
Chris Lattner0fa5da92011-04-06 16:14:25 +0000642 <p><a href="http://github.com/evanphx/rubinius">Rubinius</a> is an environment
643 for running Ruby code which strives to write as much of the implementation in
644 Ruby as possible. Combined with a bytecode interpreting VM, it uses LLVM to
645 optimize and compile ruby code down to machine code. Techniques such as type
646 feedback, method inlining, and deoptimization are all used to remove dynamism
647 from ruby execution and increase performance.</p>
648</div>
Bill Wendlingf2a78332011-10-25 01:01:42 +0000649-->
Chris Lattner0fa5da92011-04-06 16:14:25 +0000650
Chris Lattnera844a3e2011-04-07 03:09:21 +0000651<!--=========================================================================-->
Bill Wendlingf2a78332011-10-25 01:01:42 +0000652<!--
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000653<h3>
Chris Lattnera844a3e2011-04-07 03:09:21 +0000654<a name="FAUST">FAUST Real-Time Audio Signal Processing Language</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000655</h3>
Chris Lattnere0518442010-10-01 06:34:49 +0000656
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000657<div>
Chris Lattnera844a3e2011-04-07 03:09:21 +0000658<p>
659<a href="http://faust.grame.fr">FAUST</a> is a compiled language for real-time
660audio signal processing. The name FAUST stands for Functional AUdio STream. Its
661programming model combines two approaches: functional programming and block
662diagram composition. In addition with the C, C++, JAVA output formats, the
Chad Rosiere6291d02011-05-27 22:50:46 +0000663Faust compiler can now generate LLVM bitcode, and works with LLVM 2.7-3.0.</p>
Chris Lattnera844a3e2011-04-07 03:09:21 +0000664
665</div>
Bill Wendlingf2a78332011-10-25 01:01:42 +0000666-->
Chris Lattnera844a3e2011-04-07 03:09:21 +0000667
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000668</div>
669
Chris Lattner8348b472008-06-08 21:58:17 +0000670<!-- *********************************************************************** -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000671<h2>
Chad Rosiere6291d02011-05-27 22:50:46 +0000672 <a name="whatsnew">What's New in LLVM 3.0?</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000673</h2>
Chris Lattner8348b472008-06-08 21:58:17 +0000674<!-- *********************************************************************** -->
675
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000676<div>
Chris Lattnerf8e0b4e2008-06-08 22:59:35 +0000677
Chris Lattner61358ab2009-10-13 17:48:04 +0000678<p>This release includes a huge number of bug fixes, performance tweaks and
Bill Wendling7b7fa742011-10-26 18:46:16 +0000679 minor improvements. Some of the major improvements and new features are
680 listed in this section.</p>
Chris Lattner61358ab2009-10-13 17:48:04 +0000681
Chris Lattner914ce462010-04-22 06:28:20 +0000682<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000683<h3>
Chris Lattner252b83d2008-02-06 18:00:06 +0000684<a name="majorfeatures">Major New Features</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000685</h3>
Chris Lattner252b83d2008-02-06 18:00:06 +0000686
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000687<div>
Chris Lattner252b83d2008-02-06 18:00:06 +0000688
Chad Rosiere6291d02011-05-27 22:50:46 +0000689<p>LLVM 3.0 includes several major new capabilities:</p>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000690
691<ul>
Chris Lattner1efe27e2011-04-06 00:45:11 +0000692
Chad Rosiere6291d02011-05-27 22:50:46 +0000693<!--
694<li></li>
695-->
Chris Lattner7a8e6c52011-04-05 18:38:45 +0000696
Chris Lattner8170c102008-02-10 08:18:42 +0000697</ul>
Chris Lattner0a6f6d52011-04-05 07:19:28 +0000698
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000699</div>
700
Chris Lattner84977642007-09-21 03:54:09 +0000701<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000702<h3>
Chris Lattner917cc712009-03-02 02:37:32 +0000703<a name="coreimprovements">LLVM IR and Core Improvements</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000704</h3>
Chris Lattnerf304ffc2008-02-10 08:17:19 +0000705
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000706<div>
Bill Wendling7b7fa742011-10-26 18:46:16 +0000707
Chris Lattner61358ab2009-10-13 17:48:04 +0000708<p>LLVM IR has several new features for better support of new targets and that
Bill Wendling7b7fa742011-10-26 18:46:16 +0000709 expose new optimization opportunities:</p>
Chris Lattnerf304ffc2008-02-10 08:17:19 +0000710
Bill Wendlingbc5f6dd2011-10-26 18:33:01 +0000711<p>One of the biggest changes is that 3.0 has a new exception handling
712 system. The old system used LLVM intrinsics to convey the exception handling
713 information to the code generator. It worked in most cases, but not
714 all. Inlining was especially difficult to get right. Also, the intrinsics
715 could be moved away from the <code>invoke</code> instruction, making it hard
716 to recover that information.</p>
717
718<p>The new EH system makes exception handling a first-class member of the IR. It
719 adds two new instructions:</p>
720
Chris Lattner791f77b2008-06-05 06:25:56 +0000721<ul>
Bill Wendlingbc5f6dd2011-10-26 18:33:01 +0000722 <li><a href="LangRef.html#i_landingpad"><code>landingpad</code></a> &mdash;
723 this instruction defines a landing pad basic block. It contains all of the
724 information that's needed by the code generator. It's also required to be
725 the first non-PHI instruction in the landing pad. In addition, a landing
726 pad may be jumped to only by the unwind edge of an <code>invoke</code>
727 instruction.</li>
728
729 <li><a href="LangRef.html#i_resume"><code>resume</code></a> &mdash; this
730 instruction causes the current exception to resume traveling up the
731 stack. It replaces the <code>@llvm.eh.resume</code> intrinsic.</li>
Chris Lattnerf304ffc2008-02-10 08:17:19 +0000732</ul>
Mikhail Glushenkovea65d7d2008-10-13 02:08:34 +0000733
Bill Wendlingbc5f6dd2011-10-26 18:33:01 +0000734<p>Converting from the old EH API to the new EH API is rather simple, because a
735 lot of complexity has been removed. The two intrinsics,
736 <code>@llvm.eh.exception</code> and <code>@llvm.eh.selector</code> have been
737 superceded by the <code>landingpad</code> instruction. Instead of generating
738 a call to <code>@llvm.eh.exception</code> and <code>@llvm.eh.selector</code>:
739
740<div class="doc_code">
741<pre>
742Function *ExcIntr = Intrinsic::getDeclaration(TheModule,
743 Intrinsic::eh_exception);
744Function *SlctrIntr = Intrinsic::getDeclaration(TheModule,
745 Intrinsic::eh_selector);
746
747// The exception pointer.
748Value *ExnPtr = Builder.CreateCall(ExcIntr, "exc_ptr");
749
750std::vector&lt;Value*&gt; Args;
751Args.push_back(ExnPtr);
752Args.push_back(Builder.CreateBitCast(Personality,
753 Type::getInt8PtrTy(Context)));
754
755<i>// Add selector clauses to Args.</i>
756
757// The selector call.
758Builder.CreateCall(SlctrIntr, Args, "exc_sel");
759</pre>
760</div>
761
762<p>You should instead generate a <code>landingpad</code> instruction, that
763 returns an exception object and selector value:</p>
764
765<div class="doc_code">
766<pre>
767LandingPadInst *LPadInst =
768 Builder.CreateLandingPad(StructType::get(Int8PtrTy, Int32Ty, NULL),
769 Personality, 0);
770
771Value *LPadExn = Builder.CreateExtractValue(LPadInst, 0);
772Builder.CreateStore(LPadExn, getExceptionSlot());
773
774Value *LPadSel = Builder.CreateExtractValue(LPadInst, 1);
775Builder.CreateStore(LPadSel, getEHSelectorSlot());
776</pre>
777</div>
778
779<p>It's now trivial to add the individual clauses to the <code>landingpad</code>
780 instruction.</p>
781
782<div class="doc_code">
783<pre>
784<i><b>// Adding a catch clause</b></i>
785Constant *TypeInfo = getTypeInfo();
786LPadInst-&gt;addClause(TypeInfo);
787
788<i><b>// Adding a C++ catch-all</b></i>
789LPadInst-&gt;addClause(Constant::getNullValue(Builder.getInt8PtrTy()));
790
791<i><b>// Adding a cleanup</b></i>
792LPadInst-&gt;setCleanup(true);
793
794<i><b>// Adding a filter clause</b></i>
795std::vector&lt;Constant*&gt; TypeInfos;
796Constant *TypeInfo = getFilterTypeInfo();
797TypeInfos.push_back(Builder.CreateBitCast(TypeInfo, Builder.getInt8PtrTy()));
798
799ArrayType *FilterTy = ArrayType::get(Int8PtrTy, TypeInfos.size());
800LPadInst-&gt;addClause(ConstantArray::get(FilterTy, TypeInfos));
801</pre>
802</div>
803
804<p>Converting from using the <code>@llvm.eh.resume</code> intrinsic to
805 the <code>resume</code> instruction is trivial. It takes the exception
806 pointer and exception selector values returned by
807 the <code>landingpad</code> instruction:</p>
808
809<div class="doc_code">
810<pre>
811Type *UnwindDataTy = StructType::get(Builder.getInt8PtrTy(),
812 Builder.getInt32Ty(), NULL);
813Value *UnwindData = UndefValue::get(UnwindDataTy);
814Value *ExcPtr = Builder.CreateLoad(getExceptionObjSlot());
815Value *ExcSel = Builder.CreateLoad(getExceptionSelSlot());
816UnwindData = Builder.CreateInsertValue(UnwindData, ExcPtr, 0, "exc_ptr");
817UnwindData = Builder.CreateInsertValue(UnwindData, ExcSel, 1, "exc_sel");
818Builder.CreateResume(UnwindData);
819</pre>
820</div>
821
Chris Lattnerf304ffc2008-02-10 08:17:19 +0000822</div>
823
824<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000825<h3>
Chris Lattneracce85d2008-02-10 07:46:44 +0000826<a name="optimizer">Optimizer Improvements</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000827</h3>
Chris Lattneracce85d2008-02-10 07:46:44 +0000828
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000829<div>
Chris Lattneracce85d2008-02-10 07:46:44 +0000830
Chris Lattner61358ab2009-10-13 17:48:04 +0000831<p>In addition to a large array of minor performance tweaks and bug fixes, this
Bill Wendling7b7fa742011-10-26 18:46:16 +0000832 release includes a few major enhancements and additions to the
833 optimizers:</p>
Chris Lattneracce85d2008-02-10 07:46:44 +0000834
835<ul>
Chad Rosiere6291d02011-05-27 22:50:46 +0000836<!--
837<li></li>
838-->
Chris Lattnerc5ac61d2011-04-06 05:50:04 +0000839</li>
Chris Lattner1efe27e2011-04-06 00:45:11 +0000840
Chris Lattner11b66112010-10-04 02:42:39 +0000841</ul>
842
Chris Lattner61358ab2009-10-13 17:48:04 +0000843</div>
Chris Lattner917cc712009-03-02 02:37:32 +0000844
Chris Lattner0b832202008-06-08 02:45:07 +0000845<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000846<h3>
Chris Lattner4ba2b652010-09-30 16:31:33 +0000847<a name="mc">MC Level Improvements</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000848</h3>
Chris Lattner4ba2b652010-09-30 16:31:33 +0000849
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000850<div>
Bill Wendling7b7fa742011-10-26 18:46:16 +0000851
852<p>The LLVM Machine Code (aka MC) subsystem was created to solve a number of
853 problems in the realm of assembly, disassembly, object file format handling,
854 and a number of other related areas that CPU instruction-set level tools work
855 in.</p>
Chris Lattner7d9b6b42010-10-02 21:59:30 +0000856
Chris Lattner7d9b6b42010-10-02 21:59:30 +0000857<ul>
Chad Rosiere6291d02011-05-27 22:50:46 +0000858<!--
859<li></li>
860-->
Chris Lattner7d9b6b42010-10-02 21:59:30 +0000861</ul>
862
Bill Wendling7b7fa742011-10-26 18:46:16 +0000863<p>For more information, please see
864 the <a href="http://blog.llvm.org/2010/04/intro-to-llvm-mc-project.html">Intro
865 to the LLVM MC Project Blog Post</a>.</p>
Chris Lattner4ba2b652010-09-30 16:31:33 +0000866
NAKAMURA Takumi45c435a2011-04-05 08:24:22 +0000867</div>
Chris Lattner4ba2b652010-09-30 16:31:33 +0000868
Chris Lattner4ba2b652010-09-30 16:31:33 +0000869<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000870<h3>
Chris Lattner511433e2009-03-02 03:24:11 +0000871<a name="codegen">Target Independent Code Generator Improvements</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000872</h3>
Chris Lattner0b832202008-06-08 02:45:07 +0000873
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000874<div>
Chris Lattner0b832202008-06-08 02:45:07 +0000875
Mikhail Glushenkovf795ef02009-03-01 18:09:47 +0000876<p>We have put a significant amount of work into the code generator
Bill Wendling7b7fa742011-10-26 18:46:16 +0000877 infrastructure, which allows us to implement more aggressive algorithms and
878 make it run faster:</p>
Chris Lattner0b832202008-06-08 02:45:07 +0000879
880<ul>
Chad Rosiere6291d02011-05-27 22:50:46 +0000881<!--
882<li></li>
883-->
Chris Lattner84977642007-09-21 03:54:09 +0000884</ul>
Chris Lattner84977642007-09-21 03:54:09 +0000885</div>
886
Chris Lattner917cc712009-03-02 02:37:32 +0000887<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000888<h3>
Chris Lattner917cc712009-03-02 02:37:32 +0000889<a name="x86">X86-32 and X86-64 Target Improvements</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000890</h3>
Chris Lattner917cc712009-03-02 02:37:32 +0000891
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000892<div>
Bill Wendling7b7fa742011-10-26 18:46:16 +0000893
894<p>New features and major changes in the X86 target include:</p>
Chris Lattner917cc712009-03-02 02:37:32 +0000895
896<ul>
Bill Wendling7b7fa742011-10-26 18:46:16 +0000897
898 <li>The CRC32 intrinsics have been renamed. The intrinsics were previously
899 <code>@llvm.x86.sse42.crc32.[8|16|32]</code>
900 and <code>@llvm.x86.sse42.crc64.[8|64]</code>. They have been renamed to
901 <code>@llvm.x86.sse42.crc32.32.[8|16|32]</code> and
902 <code>@llvm.x86.sse42.crc32.64.[8|64]</code>.</li>
Chad Rosierf94c9c12011-05-27 20:13:10 +0000903
Chris Lattner917cc712009-03-02 02:37:32 +0000904</ul>
905
Chris Lattner917cc712009-03-02 02:37:32 +0000906</div>
Chris Lattner84977642007-09-21 03:54:09 +0000907
908<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000909<h3>
Chris Lattner61358ab2009-10-13 17:48:04 +0000910<a name="ARM">ARM Target Improvements</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000911</h3>
Chris Lattnerc441fb82009-03-01 02:30:21 +0000912
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000913<div>
Bill Wendling7b7fa742011-10-26 18:46:16 +0000914
915<p>New features of the ARM target include:</p>
Chris Lattnerc441fb82009-03-01 02:30:21 +0000916
917<ul>
Chad Rosiere6291d02011-05-27 22:50:46 +0000918<!--
919<li></li>
920-->
Bob Wilsone8472772010-09-13 17:39:35 +0000921</ul>
Chris Lattner61358ab2009-10-13 17:48:04 +0000922</div>
Chris Lattner1efe27e2011-04-06 00:45:11 +0000923
924<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000925<h3>
Chris Lattner1efe27e2011-04-06 00:45:11 +0000926<a name="OtherTS">Other Target Specific Improvements</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000927</h3>
Chris Lattnerc441fb82009-03-01 02:30:21 +0000928
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000929<div>
Bill Wendling7b7fa742011-10-26 18:46:16 +0000930
Chris Lattner1efe27e2011-04-06 00:45:11 +0000931<ul>
Chad Rosiere6291d02011-05-27 22:50:46 +0000932<!--
933<li></li>
934-->
Chris Lattner1efe27e2011-04-06 00:45:11 +0000935</ul>
Bill Wendling7b7fa742011-10-26 18:46:16 +0000936
Chris Lattner1efe27e2011-04-06 00:45:11 +0000937</div>
Chris Lattner77d29b12008-06-05 08:02:49 +0000938
939<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000940<h3>
Chris Lattnerf6662f92008-10-13 17:57:36 +0000941<a name="changes">Major Changes and Removed Features</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000942</h3>
Chris Lattnerf6662f92008-10-13 17:57:36 +0000943
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000944<div>
Chris Lattnerf6662f92008-10-13 17:57:36 +0000945
Bill Wendling2626dba2011-08-03 22:18:20 +0000946<p>If you're already an LLVM user or developer with out-of-tree changes based on
947 LLVM 2.9, this section lists some "gotchas" that you may run into upgrading
948 from the previous release.</p>
Chris Lattnerf6662f92008-10-13 17:57:36 +0000949
950<ul>
Eric Christopher90d6ec52011-09-28 19:47:28 +0000951 <li>The <code>LLVMC</code> front end code was removed while separating
952 out language independence.</li>
Jay Foadf42e9b22011-08-04 10:43:43 +0000953 <li>The <code>LowerSetJmp</code> pass wasn't used effectively by any
954 target and has been removed.</li>
Rafael Espindolaf940a1a2011-08-30 23:03:45 +0000955 <li>The old <code>TailDup</code> pass was not used in the standard pipeline
956 and was unable to update ssa form, so it has been removed.
Eli Friedmanf03bb262011-08-12 22:50:01 +0000957 <li>The syntax of volatile loads and stores in IR has been changed to
958 "<code>load volatile</code>"/"<code>store volatile</code>". The old
959 syntax ("<code>volatile load</code>"/"<code>volatile store</code>")
960 is still accepted, but is now considered deprecated.</li>
Eli Friedman526e1bb2011-10-26 00:55:23 +0000961 <li>The old atomic intrinscs (<code>llvm.memory.barrier</code> and
962 <code>llvm.atomic.*</code>) are now gone. Please use the new atomic
963 instructions, described in the <a href="Atomics.html">atomics guide</a>.
Devang Patelb34dd132008-10-14 20:03:43 +0000964</ul>
Chris Lattnerf6662f92008-10-13 17:57:36 +0000965
NAKAMURA Takumi2026de22011-08-22 23:22:05 +0000966<h4>Windows (32-bit)</h4>
967<div>
Bill Wendling7b7fa742011-10-26 18:46:16 +0000968
NAKAMURA Takumi2026de22011-08-22 23:22:05 +0000969<ul>
970 <li>On Win32(MinGW32 and MSVC), Windows 2000 will not be supported.
971 Windows XP or higher is required.</li>
972</ul>
Bill Wendling7b7fa742011-10-26 18:46:16 +0000973
NAKAMURA Takumi2026de22011-08-22 23:22:05 +0000974</div>
975
Chris Lattnerf6662f92008-10-13 17:57:36 +0000976</div>
977
Daniel Dunbarf0233c62010-10-04 20:11:41 +0000978<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000979<h3>
Chris Lattner1efe27e2011-04-06 00:45:11 +0000980<a name="api_changes">Internal API Changes</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000981</h3>
Daniel Dunbarf0233c62010-10-04 20:11:41 +0000982
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000983<div>
Daniel Dunbarf0233c62010-10-04 20:11:41 +0000984
Chris Lattner1efe27e2011-04-06 00:45:11 +0000985<p>In addition, many APIs have changed in this release. Some of the major
Bill Wendling16005252011-08-02 06:20:17 +0000986 LLVM API changes are:</p>
Daniel Dunbarf0233c62010-10-04 20:11:41 +0000987
988<ul>
Bill Wendling7b7fa742011-10-26 18:46:16 +0000989 <li>The biggest and most pervasive change is that llvm::Type's are no longer
990 returned or accepted as 'const' values. Instead, just pass around
991 non-const Type's.</li>
Chris Lattnerd1324302011-07-18 04:56:02 +0000992
Bill Wendling7b7fa742011-10-26 18:46:16 +0000993 <li><code>PHINode::reserveOperandSpace</code> has been removed. Instead, you
994 must specify how many operands to reserve space for when you create the
995 PHINode, by passing an extra argument
996 into <code>PHINode::Create</code>.</li>
Jay Foad558d3762011-07-14 09:19:05 +0000997
Bill Wendling7b7fa742011-10-26 18:46:16 +0000998 <li>PHINodes no longer store their incoming BasicBlocks as operands. Instead,
999 the list of incoming BasicBlocks is stored separately, and can be accessed
1000 with new functions <code>PHINode::block_begin</code>
1001 and <code>PHINode::block_end</code>.</li>
Jay Foad558d3762011-07-14 09:19:05 +00001002
Bill Wendling7b7fa742011-10-26 18:46:16 +00001003 <li>Various functions now take an <code>ArrayRef</code> instead of either a
1004 pair of pointers (or iterators) to the beginning and end of a range, or a
1005 pointer and a length. Others now return an <code>ArrayRef</code> instead
1006 of a reference to a <code>SmallVector</code>
1007 or <code>std::vector</code>. These include:
Jay Foad558d3762011-07-14 09:19:05 +00001008<ul>
1009<!-- Please keep this list sorted. -->
Jay Foada3efbb12011-07-15 08:37:34 +00001010<li><code>CallInst::Create</code></li>
Jay Foad558d3762011-07-14 09:19:05 +00001011<li><code>ComputeLinearIndex</code> (in <code>llvm/CodeGen/Analysis.h</code>)</li>
1012<li><code>ConstantArray::get</code></li>
1013<li><code>ConstantExpr::getExtractElement</code></li>
Jay Foaddab3d292011-07-21 14:31:17 +00001014<li><code>ConstantExpr::getGetElementPtr</code></li>
1015<li><code>ConstantExpr::getInBoundsGetElementPtr</code></li>
Jay Foad558d3762011-07-14 09:19:05 +00001016<li><code>ConstantExpr::getIndices</code></li>
1017<li><code>ConstantExpr::getInsertElement</code></li>
1018<li><code>ConstantExpr::getWithOperands</code></li>
Jay Foad1d2f5692011-07-19 13:32:40 +00001019<li><code>ConstantFoldCall</code> (in <code>llvm/Analysis/ConstantFolding.h</code>)</li>
1020<li><code>ConstantFoldInstOperands</code> (in <code>llvm/Analysis/ConstantFolding.h</code>)</li>
Jay Foad558d3762011-07-14 09:19:05 +00001021<li><code>ConstantVector::get</code></li>
1022<li><code>DIBuilder::createComplexVariable</code></li>
1023<li><code>DIBuilder::getOrCreateArray</code></li>
1024<li><code>ExtractValueInst::Create</code></li>
1025<li><code>ExtractValueInst::getIndexedType</code></li>
1026<li><code>ExtractValueInst::getIndices</code></li>
1027<li><code>FindInsertedValue</code> (in <code>llvm/Analysis/ValueTracking.h</code>)</li>
Jay Foadca12a212011-07-19 14:42:50 +00001028<li><code>gep_type_begin</code> (in <code>llvm/Support/GetElementPtrTypeIterator.h</code>)</li>
1029<li><code>gep_type_end</code> (in <code>llvm/Support/GetElementPtrTypeIterator.h</code>)</li>
Jay Foada9203102011-07-25 09:48:08 +00001030<li><code>GetElementPtrInst::Create</code></li>
1031<li><code>GetElementPtrInst::CreateInBounds</code></li>
1032<li><code>GetElementPtrInst::getIndexedType</code></li>
Jay Foadb60e8512011-07-21 14:42:51 +00001033<li><code>InsertValueInst::Create</code></li>
1034<li><code>InsertValueInst::getIndices</code></li>
1035<li><code>InvokeInst::Create</code></li>
Jay Foada3efbb12011-07-15 08:37:34 +00001036<li><code>IRBuilder::CreateCall</code></li>
Jay Foad558d3762011-07-14 09:19:05 +00001037<li><code>IRBuilder::CreateExtractValue</code></li>
Jay Foad0a2a60a2011-07-22 08:16:57 +00001038<li><code>IRBuilder::CreateGEP</code></li>
1039<li><code>IRBuilder::CreateInBoundsGEP</code></li>
Jay Foad558d3762011-07-14 09:19:05 +00001040<li><code>IRBuilder::CreateInsertValue</code></li>
Jay Foada3efbb12011-07-15 08:37:34 +00001041<li><code>IRBuilder::CreateInvoke</code></li>
Jay Foad558d3762011-07-14 09:19:05 +00001042<li><code>MDNode::get</code></li>
1043<li><code>MDNode::getIfExists</code></li>
1044<li><code>MDNode::getTemporary</code></li>
1045<li><code>MDNode::getWhenValsUnresolved</code></li>
Jay Foadb9b54eb2011-07-19 15:07:52 +00001046<li><code>SimplifyGEPInst</code> (in <code>llvm/Analysis/InstructionSimplify.h</code>)</li>
Jay Foad8fbbb392011-07-19 14:01:37 +00001047<li><code>TargetData::getIndexedOffset</code></li>
Jay Foad558d3762011-07-14 09:19:05 +00001048</ul></li>
1049
Bill Wendling7b7fa742011-10-26 18:46:16 +00001050 <li>All forms of <code>StringMap::getOrCreateValue</code> have been remove
1051 except for the one which takes a <code>StringRef</code>.</li>
Jay Foad558d3762011-07-14 09:19:05 +00001052
Bill Wendling7b7fa742011-10-26 18:46:16 +00001053 <li>The <code>LLVMBuildUnwind</code> function from the C API was removed. The
1054 LLVM <code>unwind</code> instruction has been deprecated for a long time
1055 and isn't used by the current front-ends. So this was removed during the
1056 exception handling rewrite.</li>
Bill Wendling16005252011-08-02 06:20:17 +00001057
Bill Wendling7b7fa742011-10-26 18:46:16 +00001058 <li>The <code>LLVMAddLowerSetJmpPass</code> function from the C API was
1059 removed because the <code>LowerSetJmp</code> pass was removed.</li>
Bill Wendling2626dba2011-08-03 22:18:20 +00001060
Bill Wendling7b7fa742011-10-26 18:46:16 +00001061 <li>The <code>DIBuilder</code> interface used by front ends to encode
1062 debugging information in the LLVM IR now expects clients to
1063 use <code>DIBuilder::finalize()</code> at the end of translation unit to
1064 complete debugging information encoding.</li>
Devang Patel6326a422011-08-15 23:00:00 +00001065
Bill Wendling7b7fa742011-10-26 18:46:16 +00001066 <li>The way the type system works has been
1067 rewritten: <code>PATypeHolder</code> and <code>OpaqueType</code> are gone,
1068 and all APIs deal with <code>Type*</code> instead of <code>const
1069 Type*</code>. If you need to create recursive structures, then create a
1070 named structure, and use <code>setBody()</code> when all its elements are
1071 built. Type merging and refining is gone too: named structures are not
1072 merged with other structures, even if their layout is identical. (of
1073 course anonymous structures are still uniqued by layout).</li>
Torok Edwinf16e2d42011-09-30 13:07:52 +00001074
Bill Wendling7b7fa742011-10-26 18:46:16 +00001075 <li>TargetSelect.h moved to Support/ from Target/</li>
Torok Edwinf16e2d42011-09-30 13:07:52 +00001076
Bill Wendling7b7fa742011-10-26 18:46:16 +00001077 <li>UpgradeIntrinsicCall no longer upgrades pre-2.9 intrinsic calls (for
1078 example <code>llvm.memset.i32</code>).</li>
Torok Edwinf16e2d42011-09-30 13:07:52 +00001079
Bill Wendling7b7fa742011-10-26 18:46:16 +00001080 <li>It is mandatory to initialize all out-of-tree passes too and their dependencies now with
1081 <code>INITIALIZE_PASS{BEGIN,END,}</code>
1082 and <code>INITIALIZE_{PASS,AG}_DEPENDENCY</code>.</li>
Torok Edwinf16e2d42011-09-30 13:07:52 +00001083
Bill Wendling7b7fa742011-10-26 18:46:16 +00001084 <li>The interface for MemDepResult in MemoryDependenceAnalysis has been
1085 enhanced with new return types Unknown and NonFuncLocal, in addition to
1086 the existing types Clobber, Def, and NonLocal.</li>
Daniel Dunbarf0233c62010-10-04 20:11:41 +00001087</ul>
Bill Wendling7b7fa742011-10-26 18:46:16 +00001088
Daniel Dunbarf0233c62010-10-04 20:11:41 +00001089</div>
Chris Lattnerf6662f92008-10-13 17:57:36 +00001090
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +00001091</div>
1092
Chris Lattner79c3fe12003-10-02 04:57:28 +00001093<!-- *********************************************************************** -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001094<h2>
Misha Brukman500bc302003-11-22 00:38:41 +00001095 <a name="knownproblems">Known Problems</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001096</h2>
Chris Lattner79c3fe12003-10-02 04:57:28 +00001097<!-- *********************************************************************** -->
1098
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +00001099<div>
Misha Brukman500bc302003-11-22 00:38:41 +00001100
Bill Wendling7b7fa742011-10-26 18:46:16 +00001101<p>This section contains significant known problems with the LLVM system, listed
1102 by component. If you run into a problem, please check
1103 the <a href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
1104 there isn't already one.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +00001105
Chris Lattnerf5ee1702004-03-14 02:03:02 +00001106<!-- ======================================================================= -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001107<h3>
Chris Lattnerf5ee1702004-03-14 02:03:02 +00001108 <a name="experimental">Experimental features included with this release</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001109</h3>
Chris Lattner79c3fe12003-10-02 04:57:28 +00001110
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +00001111<div>
Chris Lattnerf5ee1702004-03-14 02:03:02 +00001112
Misha Brukman6df9e2c2004-05-12 21:46:05 +00001113<p>The following components of this LLVM release are either untested, known to
Bill Wendling7b7fa742011-10-26 18:46:16 +00001114 be broken or unreliable, or are in early development. These components
1115 should not be relied on, and bugs should not be filed against them, but they
1116 may be useful to some people. In particular, if you would like to work on
1117 one of these components, please contact us on
1118 the <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev
1119 list</a>.</p>
Chris Lattnerf5ee1702004-03-14 02:03:02 +00001120
1121<ul>
Bill Wendling7b7fa742011-10-26 18:46:16 +00001122 <li>The Alpha, Blackfin, CellSPU, MicroBlaze, MSP430, MIPS, PTX, SystemZ and
1123 XCore backends are experimental.</li>
1124
1125 <li><tt>llc</tt> "<tt>-filetype=obj</tt>" is experimental on all targets other
1126 than darwin and ELF X86 systems.</li>
Chris Lattnerf5ee1702004-03-14 02:03:02 +00001127</ul>
1128
1129</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +00001130
Misha Brukman500bc302003-11-22 00:38:41 +00001131<!-- ======================================================================= -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001132<h3>
Chris Lattner26299222006-11-18 07:51:14 +00001133 <a name="x86-be">Known problems with the X86 back-end</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001134</h3>
John Criswellc0c186d2005-11-08 21:11:33 +00001135
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +00001136<div>
John Criswellc0c186d2005-11-08 21:11:33 +00001137
1138<ul>
Anton Korobeynikova6094be2008-06-08 10:24:13 +00001139 <li>The X86 backend does not yet support
Bill Wendling7b7fa742011-10-26 18:46:16 +00001140 all <a href="http://llvm.org/PR879">inline assembly that uses the X86
1141 floating point stack</a>. It supports the 'f' and 't' constraints, but
1142 not 'u'.</li>
1143
Dan Gohman8207ba92008-06-08 23:05:11 +00001144 <li>The X86-64 backend does not yet support the LLVM IR instruction
Bill Wendling7b7fa742011-10-26 18:46:16 +00001145 <tt>va_arg</tt>. Currently, front-ends support variadic argument
1146 constructs on X86-64 by lowering them manually.</li>
1147
NAKAMURA Takumi45c435a2011-04-05 08:24:22 +00001148 <li>Windows x64 (aka Win64) code generator has a few issues.
1149 <ul>
Bill Wendling7b7fa742011-10-26 18:46:16 +00001150 <li>llvm-gcc cannot build the mingw-w64 runtime currently due to lack of
1151 support for the 'u' inline assembly constraint and for X87 floating
1152 point inline assembly.</li>
1153
1154 <li>On mingw-w64, you will see unresolved symbol <tt>__chkstk</tt> due
1155 to <a href="http://llvm.org/bugs/show_bug.cgi?id=8919">Bug 8919</a>.
1156 It is fixed
1157 in <a href="http://lists.cs.uiuc.edu/pipermail/llvm-commits/Week-of-Mon-20110321/118499.html">r128206</a>.</li>
1158
NAKAMURA Takumi45c435a2011-04-05 08:24:22 +00001159 <li>Miss-aligned MOVDQA might crash your program. It is due to
Bill Wendling7b7fa742011-10-26 18:46:16 +00001160 <a href="http://llvm.org/bugs/show_bug.cgi?id=9483">Bug 9483</a>, lack
1161 of handling aligned internal globals.</li>
NAKAMURA Takumi45c435a2011-04-05 08:24:22 +00001162 </ul>
1163 </li>
1164
Chris Lattner26299222006-11-18 07:51:14 +00001165</ul>
1166
1167</div>
1168
1169<!-- ======================================================================= -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001170<h3>
Chris Lattner26299222006-11-18 07:51:14 +00001171 <a name="ppc-be">Known problems with the PowerPC back-end</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001172</h3>
Chris Lattner26299222006-11-18 07:51:14 +00001173
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +00001174<div>
Chris Lattner26299222006-11-18 07:51:14 +00001175
1176<ul>
Bill Wendling7b7fa742011-10-26 18:46:16 +00001177 <li>The Linux PPC32/ABI support needs testing for the interpreter and static
1178 compilation, and lacks support for debug information.</li>
Chris Lattner26299222006-11-18 07:51:14 +00001179</ul>
1180
1181</div>
1182
1183<!-- ======================================================================= -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001184<h3>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +00001185 <a name="arm-be">Known problems with the ARM back-end</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001186</h3>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +00001187
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +00001188<div>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +00001189
1190<ul>
Bill Wendling7b7fa742011-10-26 18:46:16 +00001191 <li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
1192 processors, thumb programs can crash or produce wrong results
1193 (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
1194
1195 <li>Compilation for ARM Linux OABI (old ABI) is supported but not fully
1196 tested.</li>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +00001197</ul>
1198
1199</div>
1200
1201<!-- ======================================================================= -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001202<h3>
Chris Lattner26299222006-11-18 07:51:14 +00001203 <a name="sparc-be">Known problems with the SPARC back-end</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001204</h3>
Chris Lattner26299222006-11-18 07:51:14 +00001205
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +00001206<div>
Chris Lattner26299222006-11-18 07:51:14 +00001207
1208<ul>
Bill Wendling7b7fa742011-10-26 18:46:16 +00001209 <li>The SPARC backend only supports the 32-bit SPARC ABI (-m32); it does not
1210 support the 64-bit SPARC ABI (-m64).</li>
Chris Lattner26299222006-11-18 07:51:14 +00001211</ul>
1212
1213</div>
1214
1215<!-- ======================================================================= -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001216<h3>
Bruno Cardoso Lopesb7e1a4f2008-10-25 14:56:26 +00001217 <a name="mips-be">Known problems with the MIPS back-end</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001218</h3>
Bruno Cardoso Lopesb7e1a4f2008-10-25 14:56:26 +00001219
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +00001220<div>
Bruno Cardoso Lopesb7e1a4f2008-10-25 14:56:26 +00001221
1222<ul>
Bill Wendling7b7fa742011-10-26 18:46:16 +00001223 <li>64-bit MIPS targets are not supported yet.</li>
Bruno Cardoso Lopesb7e1a4f2008-10-25 14:56:26 +00001224</ul>
1225
1226</div>
1227
1228<!-- ======================================================================= -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001229<h3>
Chris Lattner26299222006-11-18 07:51:14 +00001230 <a name="alpha-be">Known problems with the Alpha back-end</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001231</h3>
Chris Lattner26299222006-11-18 07:51:14 +00001232
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +00001233<div>
Chris Lattner26299222006-11-18 07:51:14 +00001234
1235<ul>
Bill Wendling7b7fa742011-10-26 18:46:16 +00001236 <li>On 21164s, some rare FP arithmetic sequences which may trap do not have
1237 the appropriate nops inserted to ensure restartability.</li>
John Criswellc0c186d2005-11-08 21:11:33 +00001238</ul>
Bill Wendling7b7fa742011-10-26 18:46:16 +00001239
John Criswellc0c186d2005-11-08 21:11:33 +00001240</div>
1241
Chris Lattner26299222006-11-18 07:51:14 +00001242<!-- ======================================================================= -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001243<h3>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +00001244 <a name="c-be">Known problems with the C back-end</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001245</h3>
Chris Lattner26299222006-11-18 07:51:14 +00001246
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +00001247<div>
Chris Lattner26299222006-11-18 07:51:14 +00001248
Chris Lattner3016ee92010-09-29 05:34:42 +00001249<p>The C backend has numerous problems and is not being actively maintained.
Bill Wendling7b7fa742011-10-26 18:46:16 +00001250 Depending on it for anything serious is not advised.</p>
Chris Lattner3016ee92010-09-29 05:34:42 +00001251
Chris Lattner26299222006-11-18 07:51:14 +00001252<ul>
Bill Wendling7b7fa742011-10-26 18:46:16 +00001253 <li><a href="http://llvm.org/PR802">The C backend has only basic support for
1254 inline assembly code</a>.</li>
1255
1256 <li><a href="http://llvm.org/PR1658">The C backend violates the ABI of common
1257 C++ programs</a>, preventing intermixing between C++ compiled by the CBE
1258 and C++ code compiled with <tt>llc</tt> or native compilers.</li>
1259
1260 <li>The C backend does not support all exception handling constructs.</li>
1261
1262 <li>The C backend does not support arbitrary precision integers.</li>
Chris Lattner26299222006-11-18 07:51:14 +00001263</ul>
1264
1265</div>
John Criswellc0c186d2005-11-08 21:11:33 +00001266
Misha Brukman500bc302003-11-22 00:38:41 +00001267
1268<!-- ======================================================================= -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001269<h3>
Chris Lattner3016ee92010-09-29 05:34:42 +00001270 <a name="llvm-gcc">Known problems with the llvm-gcc front-end</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001271</h3>
Chris Lattner47588f92003-10-02 05:07:23 +00001272
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +00001273<div>
Chris Lattnerc5d658a2006-03-03 00:34:26 +00001274
Bill Wendling7b7fa742011-10-26 18:46:16 +00001275<p><b>LLVM 2.9 was the last release of llvm-gcc.</b></p>
Chris Lattner49123fd2011-04-06 06:29:50 +00001276
Chris Lattner3016ee92010-09-29 05:34:42 +00001277<p>llvm-gcc is generally very stable for the C family of languages. The only
1278 major language feature of GCC not supported by llvm-gcc is the
1279 <tt>__builtin_apply</tt> family of builtins. However, some extensions
1280 are only supported on some targets. For example, trampolines are only
1281 supported on some targets (these are used when you take the address of a
1282 nested function).</p>
Misha Brukman500bc302003-11-22 00:38:41 +00001283
Chris Lattner3016ee92010-09-29 05:34:42 +00001284<p>Fortran support generally works, but there are still several unresolved bugs
1285 in <a href="http://llvm.org/bugs/">Bugzilla</a>. Please see the
1286 tools/gfortran component for details. Note that llvm-gcc is missing major
1287 Fortran performance work in the frontend and library that went into GCC after
1288 4.2. If you are interested in Fortran, we recommend that you consider using
1289 <a href="#dragonegg">dragonegg</a> instead.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +00001290
Duncan Sands3af96332010-10-04 10:06:56 +00001291<p>The llvm-gcc 4.2 Ada compiler has basic functionality, but is no longer being
Bill Wendling7b7fa742011-10-26 18:46:16 +00001292 actively maintained. If you are interested in Ada, we recommend that you
1293 consider using <a href="#dragonegg">dragonegg</a> instead.</p>
1294
Chris Lattner2b659ef2008-02-12 06:29:45 +00001295</div>
1296
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +00001297</div>
1298
Chris Lattner79c3fe12003-10-02 04:57:28 +00001299<!-- *********************************************************************** -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001300<h2>
Misha Brukman500bc302003-11-22 00:38:41 +00001301 <a name="additionalinfo">Additional Information</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001302</h2>
Chris Lattner79c3fe12003-10-02 04:57:28 +00001303<!-- *********************************************************************** -->
1304
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +00001305<div>
Misha Brukman500bc302003-11-22 00:38:41 +00001306
Bill Wendling7b7fa742011-10-26 18:46:16 +00001307<p>A wide variety of additional information is available on
1308 the <a href="http://llvm.org/">LLVM web page</a>, in particular in
1309 the <a href="http://llvm.org/docs/">documentation</a> section. The web page
1310 also contains versions of the API documentation which is up-to-date with the
1311 Subversion version of the source code. You can access versions of these
1312 documents specific to this release by going into the "<tt>llvm/doc/</tt>"
1313 directory in the LLVM tree.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +00001314
Misha Brukman500bc302003-11-22 00:38:41 +00001315<p>If you have any questions or comments about LLVM, please feel free to contact
Bill Wendling7b7fa742011-10-26 18:46:16 +00001316 us via the <a href="http://llvm.org/docs/#maillist"> mailing lists</a>.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +00001317
Misha Brukman500bc302003-11-22 00:38:41 +00001318</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +00001319
1320<!-- *********************************************************************** -->
Chris Lattner79c3fe12003-10-02 04:57:28 +00001321
Misha Brukman500bc302003-11-22 00:38:41 +00001322<hr>
Misha Brukman2061e892003-11-22 01:23:39 +00001323<address>
Misha Brukman38847d52003-12-21 22:53:21 +00001324 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman44408702008-12-11 17:34:48 +00001325 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
Misha Brukman2061e892003-11-22 01:23:39 +00001326 <a href="http://validator.w3.org/check/referer"><img
Misha Brukman44408702008-12-11 17:34:48 +00001327 src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
Misha Brukman2061e892003-11-22 01:23:39 +00001328
Chris Lattnerb4b0ce72007-05-18 00:44:29 +00001329 <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
Misha Brukman500bc302003-11-22 00:38:41 +00001330 Last modified: $Date$
Misha Brukman2061e892003-11-22 01:23:39 +00001331</address>
Chris Lattner79c3fe12003-10-02 04:57:28 +00001332
Misha Brukman500bc302003-11-22 00:38:41 +00001333</body>
1334</html>