blob: 73cbcf81b69f1e8b9e45b1b2528b6439326da362 [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<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000340<h3>Crack Programming Language</h3>
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000341
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000342<div>
Bill Wendling55d6e672011-11-03 20:10:01 +0000343
344<p><a href="http://code.google.com/p/crack-language/">Crack</a> aims to provide
345 the ease of development of a scripting language with the performance of a
346 compiled language. The language derives concepts from C++, Java and Python,
347 incorporating object-oriented programming, operator overloading and strong
348 typing.</p>
349
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000350</div>
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 Wendling03250532011-11-01 04:08:23 +0000421<h3>LuaAV</h3>
422
423<div>
424
425<p><a href="http://lua-av.mat.ucsb.edu/blog/">LuaAV</a> is a real-time
426 audiovisual scripting environment based around the Lua language and a
427 collection of libraries for sound, graphics, and other media protocols. LuaAV
428 uses LLVM and Clang to JIT compile efficient user-defined audio synthesis
429 routines specified in a declarative syntax.</p>
430
431</div>
432
433<!--=========================================================================-->
Bill Wendlingd4821b82011-10-26 00:16:17 +0000434<h3>Mono</h3>
435
436<div>
437
438<p>An open source, cross-platform implementation of C# and the CLR that is
439 binary compatible with Microsoft.NET. Has an optional, dynamically-loaded
440 LLVM code generation backend in Mini, the JIT compiler.</p>
441
442<p>Note that we use a Git mirror of LLVM with some patches. See:
443 https://github.com/mono/llvm</p>
444
445</div>
446
447<!--=========================================================================-->
Bill Wendlingba226272011-10-25 20:37:45 +0000448<h3>Portable OpenCL (pocl)</h3>
449
450<div>
451
452<p>Portable OpenCL is an open source implementation of the OpenCL standard which
453 can be easily adapted for new targets. One of the goals of the project is
454 improving performance portability of OpenCL programs, avoiding the need for
455 target-dependent manual optimizations. A "native" target is included, which
456 allows running OpenCL kernels on the host (CPU).</p>
457
458</div>
459
460<!--=========================================================================-->
Bill Wendling0bad98c2011-10-25 20:39:06 +0000461<h3>Pure</h3>
462
463<div>
464<p><a href="http://pure-lang.googlecode.com/">Pure</a> is an
465 algebraic/functional programming language based on term rewriting. Programs
466 are collections of equations which are used to evaluate expressions in a
467 symbolic fashion. The interpreter uses LLVM as a backend to JIT-compile Pure
468 programs to fast native code. Pure offers dynamic typing, eager and lazy
469 evaluation, lexical closures, a hygienic macro system (also based on term
470 rewriting), built-in list and matrix support (including list and matrix
471 comprehensions) and an easy-to-use interface to C and other programming
472 languages (including the ability to load LLVM bitcode modules, and inline C,
473 C++, Fortran and Faust code in Pure programs if the corresponding LLVM-enabled
474 compilers are installed).</p>
475
476<p>Pure version 0.48 has been tested and is known to work with LLVM 3.0
477 (and continues to work with older LLVM releases &gt;= 2.5).</p>
478
479</div>
480
481<!--=========================================================================-->
Bill Wendling537d85b2011-10-26 00:12:04 +0000482<h3>Renderscript</h3>
483
484<div>
485
486<p><a href="http://developer.android.com/guide/topics/renderscript/index.html">Renderscript</a>
487 is Android's advanced 3D graphics rendering and compute API. It provides a
488 portable C99-based language with extensions to facilitate common use cases
489 for enhancing graphics and thread level parallelism. The Renderscript
490 compiler frontend is based on Clang/LLVM. It emits a portable bitcode format
491 for the actual compiled script code, as well as reflects a Java interface for
492 developers to control the execution of the compiled bitcode. Executable
493 machine code is then generated from this bitcode by an LLVM backend on the
494 device. Renderscript is thus able to provide a mechanism by which Android
495 developers can improve performance of their applications while retaining
496 portability.</p>
497
498</div>
499
500<!--=========================================================================-->
Bill Wendling7d5b6212011-10-25 20:40:26 +0000501<h3>SAFECode</h3>
502
503<div>
504
505<p><a href="http://safecode.cs.illinois.edu">SAFECode</a> is a memory safe C/C++
506 compiler built using LLVM. It takes standard, unannotated C/C++ code,
507 analyzes the code to ensure that memory accesses and array indexing
508 operations are safe, and instruments the code with run-time checks when
509 safety cannot be proven statically. SAFECode can be used as a debugging aid
510 (like Valgrind) to find and repair memory safety bugs. It can also be used
511 to protect code from security attacks at run-time.</p>
512
513</div>
514
515<!--=========================================================================-->
Bill Wendling02b77b72011-10-26 07:38:19 +0000516<h3>The Stupid D Compiler (SDC)</h3>
517
518<div>
519
520<p><a href="https://github.com/bhelyer/SDC">The Stupid D Compiler</a> is a
521 project seeking to write a self-hosting compiler for the D programming
522 language without using the frontend of the reference compiler (DMD).</p>
523
524</div>
525
526<!--=========================================================================-->
Bill Wendling2d7b4af2011-10-25 20:24:32 +0000527<h3>TTA-based Co-design Environment (TCE)</h3>
528
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000529<div>
Bill Wendling2d7b4af2011-10-25 20:24:32 +0000530
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000531<p>TCE is a toolset for designing application-specific processors (ASP) based on
Bill Wendling2d7b4af2011-10-25 20:24:32 +0000532 the Transport triggered architecture (TTA). The toolset provides a complete
533 co-design flow from C/C++ programs down to synthesizable VHDL and parallel
534 program binaries. Processor customization points include the register files,
535 function units, supported operations, and the interconnection network.</p>
Bill Wendling7b7fa742011-10-26 18:46:16 +0000536
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000537<p>TCE uses Clang and LLVM for C/C++ language support, target independent
Bill Wendling2d7b4af2011-10-25 20:24:32 +0000538 optimizations and also for parts of code generation. It generates new
Bill Wendling7b7fa742011-10-26 18:46:16 +0000539 LLVM-based code generators "on the fly" for the designed TTA processors and
540 loads them in to the compiler backend as runtime libraries to avoid
Bill Wendling2d7b4af2011-10-25 20:24:32 +0000541 per-target recompilation of larger parts of the compiler chain.</p>
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000542
Bill Wendling7b7fa742011-10-26 18:46:16 +0000543</div>
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000544
545<!--=========================================================================-->
Bill Wendling628c2662011-10-25 20:27:37 +0000546<h3>Tart Programming Language</h3>
547
548<div>
549
550<p><a href="http://code.google.com/p/tart/">Tart</a> is a general-purpose,
551 strongly typed programming language designed for application
552 developers. Strongly inspired by Python and C#, Tart focuses on practical
553 solutions for the professional software developer, while avoiding the clutter
554 and boilerplate of legacy languages like Java and C++. Although Tart is still
555 in development, the current implementation supports many features expected of
556 a modern programming language, such as garbage collection, powerful
557 bidirectional type inference, a greatly simplified syntax for template
558 metaprogramming, closures and function literals, reflection, operator
559 overloading, explicit mutability and immutability, and much more. Tart is
560 flexible enough to accommodate a broad range of programming styles and
561 philosophies, while maintaining a strong commitment to simplicity, minimalism
562 and elegance in design.</p>
563
564</div>
565
566<!--=========================================================================-->
Bill Wendling644ce532011-10-26 09:25:01 +0000567<h3>ThreadSanitizer</h3>
568
569<div>
570
571<p><a href="http://code.google.com/p/data-race-test/">ThreadSanitizer</a> is a
572 data race detector for (mostly) C and C++ code, available for Linux, Mac OS
573 and Windows. On different systems, we use binary instrumentation frameworks
Bill Wendlingae8538e2011-10-29 01:11:15 +0000574 (Valgrind and Pin) as frontends that generate the program events for the race
575 detection algorithm. On Linux, there's an option of using LLVM-based
576 compile-time instrumentation.</p>
Bill Wendling644ce532011-10-26 09:25:01 +0000577
578</div>
579
580<!--=========================================================================-->
Bill Wendling8a924c62011-10-26 07:42:45 +0000581<h3>The ZooLib C++ Cross-Platform Application Framework</h3>
582
583<div>
584
585<p><a href="http://www.zoolib.org/">ZooLib</a> is Open Source under the MIT
586 License. It provides GUI, filesystem access, TCP networking, thread-safe
587 memory management, threading and locking for Mac OS X, Classic Mac OS,
588 Microsoft Windows, POSIX operating systems with X11, BeOS, Haiku, Apple's iOS
589 and Research in Motion's BlackBerry.</p>
590
591<p>My current work is to use CLang's static analyzer to improve ZooLib's code
592 quality. I also plan to set up LLVM compiles of the demo programs and test
593 programs using CLang and LLVM on all the platforms that CLang, LLVM and
594 ZooLib all support.</p>
595
596</div>
597
598<!--=========================================================================-->
Bill Wendlingf2a78332011-10-25 01:01:42 +0000599<!--
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000600<h3>PinaVM</h3>
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000601
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000602<div>
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000603<p><a href="http://gitorious.org/pinavm/pages/Home">PinaVM</a> is an open
604source, <a href="http://www.systemc.org/">SystemC</a> front-end. Unlike many
605other front-ends, PinaVM actually executes the elaboration of the
606program analyzed using LLVM's JIT infrastructure. It later enriches the
607bitcode with SystemC-specific information.</p>
608</div>
Bill Wendlingf2a78332011-10-25 01:01:42 +0000609-->
610
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000611
612<!--=========================================================================-->
Bill Wendlingf2a78332011-10-25 01:01:42 +0000613<!--
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000614<h3 id="icedtea">IcedTea Java Virtual Machine Implementation</h3>
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000615
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000616<div>
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000617<p>
618<a href="http://icedtea.classpath.org/wiki/Main_Page">IcedTea</a> provides a
619harness to build OpenJDK using only free software build tools and to provide
620replacements for the not-yet free parts of OpenJDK. One of the extensions that
621IcedTea provides is a new JIT compiler named <a
622href="http://icedtea.classpath.org/wiki/ZeroSharkFaq">Shark</a> which uses LLVM
623to provide native code generation without introducing processor-dependent
624code.
625</p>
626
627<p> OpenJDK 7 b112, IcedTea6 1.9 and IcedTea7 1.13 and later have been tested
Chad Rosiere6291d02011-05-27 22:50:46 +0000628and are known to work with LLVM 3.0 (and continue to work with older LLVM
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000629releases &gt;= 2.6 as well).</p>
630</div>
Bill Wendlingf2a78332011-10-25 01:01:42 +0000631-->
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000632
633<!--=========================================================================-->
Bill Wendlingf2a78332011-10-25 01:01:42 +0000634<!--
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000635<h3>Polly - Polyhedral optimizations for LLVM</h3>
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000636
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000637<div>
Chris Lattner3bfe57e2011-04-06 01:13:49 +0000638<p>Polly is a project that aims to provide advanced memory access optimizations
639to better take advantage of SIMD units, cache hierarchies, multiple cores or
640even vector accelerators for LLVM. Built around an abstract mathematical
641description based on Z-polyhedra, it provides the infrastructure to develop
642advanced optimizations in LLVM and to connect complex external optimizers. In
643its first year of existence Polly already provides an exact value-based
644dependency analysis as well as basic SIMD and OpenMP code generation support.
645Furthermore, Polly can use PoCC(Pluto) an advanced optimizer for data-locality
646and parallelism.</p>
647</div>
Bill Wendlingf2a78332011-10-25 01:01:42 +0000648-->
Chris Lattner75547712010-10-03 23:49:06 +0000649
Chris Lattner0fa5da92011-04-06 16:14:25 +0000650<!--=========================================================================-->
Bill Wendlingf2a78332011-10-25 01:01:42 +0000651<!--
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000652<h3>Rubinius</h3>
Chris Lattner0fa5da92011-04-06 16:14:25 +0000653
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000654<div>
Chris Lattner0fa5da92011-04-06 16:14:25 +0000655 <p><a href="http://github.com/evanphx/rubinius">Rubinius</a> is an environment
656 for running Ruby code which strives to write as much of the implementation in
657 Ruby as possible. Combined with a bytecode interpreting VM, it uses LLVM to
658 optimize and compile ruby code down to machine code. Techniques such as type
659 feedback, method inlining, and deoptimization are all used to remove dynamism
660 from ruby execution and increase performance.</p>
661</div>
Bill Wendlingf2a78332011-10-25 01:01:42 +0000662-->
Chris Lattner0fa5da92011-04-06 16:14:25 +0000663
Chris Lattnera844a3e2011-04-07 03:09:21 +0000664<!--=========================================================================-->
Bill Wendlingf2a78332011-10-25 01:01:42 +0000665<!--
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000666<h3>
Chris Lattnera844a3e2011-04-07 03:09:21 +0000667<a name="FAUST">FAUST Real-Time Audio Signal Processing Language</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000668</h3>
Chris Lattnere0518442010-10-01 06:34:49 +0000669
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000670<div>
Chris Lattnera844a3e2011-04-07 03:09:21 +0000671<p>
672<a href="http://faust.grame.fr">FAUST</a> is a compiled language for real-time
673audio signal processing. The name FAUST stands for Functional AUdio STream. Its
674programming model combines two approaches: functional programming and block
675diagram composition. In addition with the C, C++, JAVA output formats, the
Chad Rosiere6291d02011-05-27 22:50:46 +0000676Faust compiler can now generate LLVM bitcode, and works with LLVM 2.7-3.0.</p>
Chris Lattnera844a3e2011-04-07 03:09:21 +0000677
678</div>
Bill Wendlingf2a78332011-10-25 01:01:42 +0000679-->
Chris Lattnera844a3e2011-04-07 03:09:21 +0000680
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000681</div>
682
Chris Lattner8348b472008-06-08 21:58:17 +0000683<!-- *********************************************************************** -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000684<h2>
Chad Rosiere6291d02011-05-27 22:50:46 +0000685 <a name="whatsnew">What's New in LLVM 3.0?</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000686</h2>
Chris Lattner8348b472008-06-08 21:58:17 +0000687<!-- *********************************************************************** -->
688
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000689<div>
Chris Lattnerf8e0b4e2008-06-08 22:59:35 +0000690
Chris Lattner61358ab2009-10-13 17:48:04 +0000691<p>This release includes a huge number of bug fixes, performance tweaks and
Bill Wendling7b7fa742011-10-26 18:46:16 +0000692 minor improvements. Some of the major improvements and new features are
693 listed in this section.</p>
Chris Lattner61358ab2009-10-13 17:48:04 +0000694
Chris Lattner914ce462010-04-22 06:28:20 +0000695<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000696<h3>
Chris Lattner252b83d2008-02-06 18:00:06 +0000697<a name="majorfeatures">Major New Features</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000698</h3>
Chris Lattner252b83d2008-02-06 18:00:06 +0000699
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000700<div>
Chris Lattner252b83d2008-02-06 18:00:06 +0000701
Chad Rosiere6291d02011-05-27 22:50:46 +0000702<p>LLVM 3.0 includes several major new capabilities:</p>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000703
704<ul>
Chris Lattner1efe27e2011-04-06 00:45:11 +0000705
Chad Rosiere6291d02011-05-27 22:50:46 +0000706<!--
707<li></li>
708-->
Chris Lattner7a8e6c52011-04-05 18:38:45 +0000709
Chris Lattner8170c102008-02-10 08:18:42 +0000710</ul>
Chris Lattner0a6f6d52011-04-05 07:19:28 +0000711
Chris Lattnerf3e5bc62007-05-14 06:56:09 +0000712</div>
713
Chris Lattner84977642007-09-21 03:54:09 +0000714<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000715<h3>
Chris Lattner917cc712009-03-02 02:37:32 +0000716<a name="coreimprovements">LLVM IR and Core Improvements</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000717</h3>
Chris Lattnerf304ffc2008-02-10 08:17:19 +0000718
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000719<div>
Bill Wendling7b7fa742011-10-26 18:46:16 +0000720
Chris Lattner61358ab2009-10-13 17:48:04 +0000721<p>LLVM IR has several new features for better support of new targets and that
Bill Wendling7b7fa742011-10-26 18:46:16 +0000722 expose new optimization opportunities:</p>
Chris Lattnerf304ffc2008-02-10 08:17:19 +0000723
Bill Wendlingbc5f6dd2011-10-26 18:33:01 +0000724<p>One of the biggest changes is that 3.0 has a new exception handling
725 system. The old system used LLVM intrinsics to convey the exception handling
726 information to the code generator. It worked in most cases, but not
727 all. Inlining was especially difficult to get right. Also, the intrinsics
728 could be moved away from the <code>invoke</code> instruction, making it hard
729 to recover that information.</p>
730
731<p>The new EH system makes exception handling a first-class member of the IR. It
732 adds two new instructions:</p>
733
Chris Lattner791f77b2008-06-05 06:25:56 +0000734<ul>
Bill Wendlingbc5f6dd2011-10-26 18:33:01 +0000735 <li><a href="LangRef.html#i_landingpad"><code>landingpad</code></a> &mdash;
736 this instruction defines a landing pad basic block. It contains all of the
737 information that's needed by the code generator. It's also required to be
738 the first non-PHI instruction in the landing pad. In addition, a landing
739 pad may be jumped to only by the unwind edge of an <code>invoke</code>
740 instruction.</li>
741
742 <li><a href="LangRef.html#i_resume"><code>resume</code></a> &mdash; this
743 instruction causes the current exception to resume traveling up the
744 stack. It replaces the <code>@llvm.eh.resume</code> intrinsic.</li>
Chris Lattnerf304ffc2008-02-10 08:17:19 +0000745</ul>
Mikhail Glushenkovea65d7d2008-10-13 02:08:34 +0000746
Bill Wendlingbc5f6dd2011-10-26 18:33:01 +0000747<p>Converting from the old EH API to the new EH API is rather simple, because a
748 lot of complexity has been removed. The two intrinsics,
749 <code>@llvm.eh.exception</code> and <code>@llvm.eh.selector</code> have been
750 superceded by the <code>landingpad</code> instruction. Instead of generating
751 a call to <code>@llvm.eh.exception</code> and <code>@llvm.eh.selector</code>:
752
753<div class="doc_code">
754<pre>
755Function *ExcIntr = Intrinsic::getDeclaration(TheModule,
756 Intrinsic::eh_exception);
757Function *SlctrIntr = Intrinsic::getDeclaration(TheModule,
758 Intrinsic::eh_selector);
759
760// The exception pointer.
761Value *ExnPtr = Builder.CreateCall(ExcIntr, "exc_ptr");
762
763std::vector&lt;Value*&gt; Args;
764Args.push_back(ExnPtr);
765Args.push_back(Builder.CreateBitCast(Personality,
766 Type::getInt8PtrTy(Context)));
767
768<i>// Add selector clauses to Args.</i>
769
770// The selector call.
771Builder.CreateCall(SlctrIntr, Args, "exc_sel");
772</pre>
773</div>
774
775<p>You should instead generate a <code>landingpad</code> instruction, that
776 returns an exception object and selector value:</p>
777
778<div class="doc_code">
779<pre>
780LandingPadInst *LPadInst =
781 Builder.CreateLandingPad(StructType::get(Int8PtrTy, Int32Ty, NULL),
782 Personality, 0);
783
784Value *LPadExn = Builder.CreateExtractValue(LPadInst, 0);
785Builder.CreateStore(LPadExn, getExceptionSlot());
786
787Value *LPadSel = Builder.CreateExtractValue(LPadInst, 1);
788Builder.CreateStore(LPadSel, getEHSelectorSlot());
789</pre>
790</div>
791
792<p>It's now trivial to add the individual clauses to the <code>landingpad</code>
793 instruction.</p>
794
795<div class="doc_code">
796<pre>
797<i><b>// Adding a catch clause</b></i>
798Constant *TypeInfo = getTypeInfo();
799LPadInst-&gt;addClause(TypeInfo);
800
801<i><b>// Adding a C++ catch-all</b></i>
802LPadInst-&gt;addClause(Constant::getNullValue(Builder.getInt8PtrTy()));
803
804<i><b>// Adding a cleanup</b></i>
805LPadInst-&gt;setCleanup(true);
806
807<i><b>// Adding a filter clause</b></i>
808std::vector&lt;Constant*&gt; TypeInfos;
809Constant *TypeInfo = getFilterTypeInfo();
810TypeInfos.push_back(Builder.CreateBitCast(TypeInfo, Builder.getInt8PtrTy()));
811
812ArrayType *FilterTy = ArrayType::get(Int8PtrTy, TypeInfos.size());
813LPadInst-&gt;addClause(ConstantArray::get(FilterTy, TypeInfos));
814</pre>
815</div>
816
817<p>Converting from using the <code>@llvm.eh.resume</code> intrinsic to
818 the <code>resume</code> instruction is trivial. It takes the exception
819 pointer and exception selector values returned by
820 the <code>landingpad</code> instruction:</p>
821
822<div class="doc_code">
823<pre>
824Type *UnwindDataTy = StructType::get(Builder.getInt8PtrTy(),
825 Builder.getInt32Ty(), NULL);
826Value *UnwindData = UndefValue::get(UnwindDataTy);
827Value *ExcPtr = Builder.CreateLoad(getExceptionObjSlot());
828Value *ExcSel = Builder.CreateLoad(getExceptionSelSlot());
829UnwindData = Builder.CreateInsertValue(UnwindData, ExcPtr, 0, "exc_ptr");
830UnwindData = Builder.CreateInsertValue(UnwindData, ExcSel, 1, "exc_sel");
831Builder.CreateResume(UnwindData);
832</pre>
833</div>
834
Chris Lattnerf304ffc2008-02-10 08:17:19 +0000835</div>
836
837<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000838<h3>
Chris Lattneracce85d2008-02-10 07:46:44 +0000839<a name="optimizer">Optimizer Improvements</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000840</h3>
Chris Lattneracce85d2008-02-10 07:46:44 +0000841
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000842<div>
Chris Lattneracce85d2008-02-10 07:46:44 +0000843
Chris Lattner61358ab2009-10-13 17:48:04 +0000844<p>In addition to a large array of minor performance tweaks and bug fixes, this
Bill Wendling7b7fa742011-10-26 18:46:16 +0000845 release includes a few major enhancements and additions to the
846 optimizers:</p>
Chris Lattneracce85d2008-02-10 07:46:44 +0000847
848<ul>
Chad Rosiere6291d02011-05-27 22:50:46 +0000849<!--
850<li></li>
851-->
Chris Lattnerc5ac61d2011-04-06 05:50:04 +0000852</li>
Chris Lattner1efe27e2011-04-06 00:45:11 +0000853
Chris Lattner11b66112010-10-04 02:42:39 +0000854</ul>
855
Chris Lattner61358ab2009-10-13 17:48:04 +0000856</div>
Chris Lattner917cc712009-03-02 02:37:32 +0000857
Chris Lattner0b832202008-06-08 02:45:07 +0000858<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000859<h3>
Chris Lattner4ba2b652010-09-30 16:31:33 +0000860<a name="mc">MC Level Improvements</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000861</h3>
Chris Lattner4ba2b652010-09-30 16:31:33 +0000862
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000863<div>
Bill Wendling7b7fa742011-10-26 18:46:16 +0000864
865<p>The LLVM Machine Code (aka MC) subsystem was created to solve a number of
866 problems in the realm of assembly, disassembly, object file format handling,
867 and a number of other related areas that CPU instruction-set level tools work
868 in.</p>
Chris Lattner7d9b6b42010-10-02 21:59:30 +0000869
Chris Lattner7d9b6b42010-10-02 21:59:30 +0000870<ul>
Chad Rosiere6291d02011-05-27 22:50:46 +0000871<!--
872<li></li>
873-->
Chris Lattner7d9b6b42010-10-02 21:59:30 +0000874</ul>
875
Bill Wendling7b7fa742011-10-26 18:46:16 +0000876<p>For more information, please see
877 the <a href="http://blog.llvm.org/2010/04/intro-to-llvm-mc-project.html">Intro
878 to the LLVM MC Project Blog Post</a>.</p>
Chris Lattner4ba2b652010-09-30 16:31:33 +0000879
NAKAMURA Takumi45c435a2011-04-05 08:24:22 +0000880</div>
Chris Lattner4ba2b652010-09-30 16:31:33 +0000881
Chris Lattner4ba2b652010-09-30 16:31:33 +0000882<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000883<h3>
Chris Lattner511433e2009-03-02 03:24:11 +0000884<a name="codegen">Target Independent Code Generator Improvements</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000885</h3>
Chris Lattner0b832202008-06-08 02:45:07 +0000886
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000887<div>
Chris Lattner0b832202008-06-08 02:45:07 +0000888
Mikhail Glushenkovf795ef02009-03-01 18:09:47 +0000889<p>We have put a significant amount of work into the code generator
Bill Wendling7b7fa742011-10-26 18:46:16 +0000890 infrastructure, which allows us to implement more aggressive algorithms and
891 make it run faster:</p>
Chris Lattner0b832202008-06-08 02:45:07 +0000892
893<ul>
Chad Rosiere6291d02011-05-27 22:50:46 +0000894<!--
895<li></li>
896-->
Chris Lattner84977642007-09-21 03:54:09 +0000897</ul>
Chris Lattner84977642007-09-21 03:54:09 +0000898</div>
899
Chris Lattner917cc712009-03-02 02:37:32 +0000900<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000901<h3>
Chris Lattner917cc712009-03-02 02:37:32 +0000902<a name="x86">X86-32 and X86-64 Target Improvements</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000903</h3>
Chris Lattner917cc712009-03-02 02:37:32 +0000904
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000905<div>
Bill Wendling7b7fa742011-10-26 18:46:16 +0000906
907<p>New features and major changes in the X86 target include:</p>
Chris Lattner917cc712009-03-02 02:37:32 +0000908
909<ul>
Bill Wendling7b7fa742011-10-26 18:46:16 +0000910
911 <li>The CRC32 intrinsics have been renamed. The intrinsics were previously
912 <code>@llvm.x86.sse42.crc32.[8|16|32]</code>
913 and <code>@llvm.x86.sse42.crc64.[8|64]</code>. They have been renamed to
914 <code>@llvm.x86.sse42.crc32.32.[8|16|32]</code> and
915 <code>@llvm.x86.sse42.crc32.64.[8|64]</code>.</li>
Chad Rosierf94c9c12011-05-27 20:13:10 +0000916
Chris Lattner917cc712009-03-02 02:37:32 +0000917</ul>
918
Chris Lattner917cc712009-03-02 02:37:32 +0000919</div>
Chris Lattner84977642007-09-21 03:54:09 +0000920
921<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000922<h3>
Chris Lattner61358ab2009-10-13 17:48:04 +0000923<a name="ARM">ARM Target Improvements</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000924</h3>
Chris Lattnerc441fb82009-03-01 02:30:21 +0000925
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000926<div>
Bill Wendling7b7fa742011-10-26 18:46:16 +0000927
928<p>New features of the ARM target include:</p>
Chris Lattnerc441fb82009-03-01 02:30:21 +0000929
930<ul>
Chad Rosiere6291d02011-05-27 22:50:46 +0000931<!--
932<li></li>
933-->
Bob Wilsone8472772010-09-13 17:39:35 +0000934</ul>
Chris Lattner61358ab2009-10-13 17:48:04 +0000935</div>
Chris Lattner1efe27e2011-04-06 00:45:11 +0000936
937<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000938<h3>
Chris Lattner1efe27e2011-04-06 00:45:11 +0000939<a name="OtherTS">Other Target Specific Improvements</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000940</h3>
Chris Lattnerc441fb82009-03-01 02:30:21 +0000941
Roman Divacky223764c2011-10-30 07:49:04 +0000942<p>PPC32/ELF va_arg was implemented.</p>
943<p>PPC32 initial support for .o file writing was implemented.</p>
944
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000945<div>
Bill Wendling7b7fa742011-10-26 18:46:16 +0000946
Chris Lattner1efe27e2011-04-06 00:45:11 +0000947<ul>
Chad Rosiere6291d02011-05-27 22:50:46 +0000948<!--
949<li></li>
950-->
Chris Lattner1efe27e2011-04-06 00:45:11 +0000951</ul>
Bill Wendling7b7fa742011-10-26 18:46:16 +0000952
Chris Lattner1efe27e2011-04-06 00:45:11 +0000953</div>
Chris Lattner77d29b12008-06-05 08:02:49 +0000954
955<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000956<h3>
Chris Lattnerf6662f92008-10-13 17:57:36 +0000957<a name="changes">Major Changes and Removed Features</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000958</h3>
Chris Lattnerf6662f92008-10-13 17:57:36 +0000959
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000960<div>
Chris Lattnerf6662f92008-10-13 17:57:36 +0000961
Bill Wendling2626dba2011-08-03 22:18:20 +0000962<p>If you're already an LLVM user or developer with out-of-tree changes based on
963 LLVM 2.9, this section lists some "gotchas" that you may run into upgrading
964 from the previous release.</p>
Chris Lattnerf6662f92008-10-13 17:57:36 +0000965
966<ul>
Eric Christopher90d6ec52011-09-28 19:47:28 +0000967 <li>The <code>LLVMC</code> front end code was removed while separating
968 out language independence.</li>
Jay Foadf42e9b22011-08-04 10:43:43 +0000969 <li>The <code>LowerSetJmp</code> pass wasn't used effectively by any
970 target and has been removed.</li>
Rafael Espindolaf940a1a2011-08-30 23:03:45 +0000971 <li>The old <code>TailDup</code> pass was not used in the standard pipeline
972 and was unable to update ssa form, so it has been removed.
Eli Friedmanf03bb262011-08-12 22:50:01 +0000973 <li>The syntax of volatile loads and stores in IR has been changed to
974 "<code>load volatile</code>"/"<code>store volatile</code>". The old
975 syntax ("<code>volatile load</code>"/"<code>volatile store</code>")
976 is still accepted, but is now considered deprecated.</li>
Eli Friedman526e1bb2011-10-26 00:55:23 +0000977 <li>The old atomic intrinscs (<code>llvm.memory.barrier</code> and
978 <code>llvm.atomic.*</code>) are now gone. Please use the new atomic
979 instructions, described in the <a href="Atomics.html">atomics guide</a>.
Devang Patelb34dd132008-10-14 20:03:43 +0000980</ul>
Chris Lattnerf6662f92008-10-13 17:57:36 +0000981
NAKAMURA Takumi2026de22011-08-22 23:22:05 +0000982<h4>Windows (32-bit)</h4>
983<div>
Bill Wendling7b7fa742011-10-26 18:46:16 +0000984
NAKAMURA Takumi2026de22011-08-22 23:22:05 +0000985<ul>
986 <li>On Win32(MinGW32 and MSVC), Windows 2000 will not be supported.
987 Windows XP or higher is required.</li>
988</ul>
Bill Wendling7b7fa742011-10-26 18:46:16 +0000989
NAKAMURA Takumi2026de22011-08-22 23:22:05 +0000990</div>
991
Chris Lattnerf6662f92008-10-13 17:57:36 +0000992</div>
993
Daniel Dunbarf0233c62010-10-04 20:11:41 +0000994<!--=========================================================================-->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000995<h3>
Chris Lattner1efe27e2011-04-06 00:45:11 +0000996<a name="api_changes">Internal API Changes</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +0000997</h3>
Daniel Dunbarf0233c62010-10-04 20:11:41 +0000998
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +0000999<div>
Daniel Dunbarf0233c62010-10-04 20:11:41 +00001000
Chris Lattner1efe27e2011-04-06 00:45:11 +00001001<p>In addition, many APIs have changed in this release. Some of the major
Bill Wendling16005252011-08-02 06:20:17 +00001002 LLVM API changes are:</p>
Daniel Dunbarf0233c62010-10-04 20:11:41 +00001003
1004<ul>
Bill Wendling7b7fa742011-10-26 18:46:16 +00001005 <li>The biggest and most pervasive change is that llvm::Type's are no longer
1006 returned or accepted as 'const' values. Instead, just pass around
1007 non-const Type's.</li>
Chris Lattnerd1324302011-07-18 04:56:02 +00001008
Bill Wendling7b7fa742011-10-26 18:46:16 +00001009 <li><code>PHINode::reserveOperandSpace</code> has been removed. Instead, you
1010 must specify how many operands to reserve space for when you create the
1011 PHINode, by passing an extra argument
1012 into <code>PHINode::Create</code>.</li>
Jay Foad558d3762011-07-14 09:19:05 +00001013
Bill Wendling7b7fa742011-10-26 18:46:16 +00001014 <li>PHINodes no longer store their incoming BasicBlocks as operands. Instead,
1015 the list of incoming BasicBlocks is stored separately, and can be accessed
1016 with new functions <code>PHINode::block_begin</code>
1017 and <code>PHINode::block_end</code>.</li>
Jay Foad558d3762011-07-14 09:19:05 +00001018
Bill Wendling7b7fa742011-10-26 18:46:16 +00001019 <li>Various functions now take an <code>ArrayRef</code> instead of either a
1020 pair of pointers (or iterators) to the beginning and end of a range, or a
1021 pointer and a length. Others now return an <code>ArrayRef</code> instead
1022 of a reference to a <code>SmallVector</code>
1023 or <code>std::vector</code>. These include:
Jay Foad558d3762011-07-14 09:19:05 +00001024<ul>
1025<!-- Please keep this list sorted. -->
Jay Foada3efbb12011-07-15 08:37:34 +00001026<li><code>CallInst::Create</code></li>
Jay Foad558d3762011-07-14 09:19:05 +00001027<li><code>ComputeLinearIndex</code> (in <code>llvm/CodeGen/Analysis.h</code>)</li>
1028<li><code>ConstantArray::get</code></li>
1029<li><code>ConstantExpr::getExtractElement</code></li>
Jay Foaddab3d292011-07-21 14:31:17 +00001030<li><code>ConstantExpr::getGetElementPtr</code></li>
1031<li><code>ConstantExpr::getInBoundsGetElementPtr</code></li>
Jay Foad558d3762011-07-14 09:19:05 +00001032<li><code>ConstantExpr::getIndices</code></li>
1033<li><code>ConstantExpr::getInsertElement</code></li>
1034<li><code>ConstantExpr::getWithOperands</code></li>
Jay Foad1d2f5692011-07-19 13:32:40 +00001035<li><code>ConstantFoldCall</code> (in <code>llvm/Analysis/ConstantFolding.h</code>)</li>
1036<li><code>ConstantFoldInstOperands</code> (in <code>llvm/Analysis/ConstantFolding.h</code>)</li>
Jay Foad558d3762011-07-14 09:19:05 +00001037<li><code>ConstantVector::get</code></li>
1038<li><code>DIBuilder::createComplexVariable</code></li>
1039<li><code>DIBuilder::getOrCreateArray</code></li>
1040<li><code>ExtractValueInst::Create</code></li>
1041<li><code>ExtractValueInst::getIndexedType</code></li>
1042<li><code>ExtractValueInst::getIndices</code></li>
1043<li><code>FindInsertedValue</code> (in <code>llvm/Analysis/ValueTracking.h</code>)</li>
Jay Foadca12a212011-07-19 14:42:50 +00001044<li><code>gep_type_begin</code> (in <code>llvm/Support/GetElementPtrTypeIterator.h</code>)</li>
1045<li><code>gep_type_end</code> (in <code>llvm/Support/GetElementPtrTypeIterator.h</code>)</li>
Jay Foada9203102011-07-25 09:48:08 +00001046<li><code>GetElementPtrInst::Create</code></li>
1047<li><code>GetElementPtrInst::CreateInBounds</code></li>
1048<li><code>GetElementPtrInst::getIndexedType</code></li>
Jay Foadb60e8512011-07-21 14:42:51 +00001049<li><code>InsertValueInst::Create</code></li>
1050<li><code>InsertValueInst::getIndices</code></li>
1051<li><code>InvokeInst::Create</code></li>
Jay Foada3efbb12011-07-15 08:37:34 +00001052<li><code>IRBuilder::CreateCall</code></li>
Jay Foad558d3762011-07-14 09:19:05 +00001053<li><code>IRBuilder::CreateExtractValue</code></li>
Jay Foad0a2a60a2011-07-22 08:16:57 +00001054<li><code>IRBuilder::CreateGEP</code></li>
1055<li><code>IRBuilder::CreateInBoundsGEP</code></li>
Jay Foad558d3762011-07-14 09:19:05 +00001056<li><code>IRBuilder::CreateInsertValue</code></li>
Jay Foada3efbb12011-07-15 08:37:34 +00001057<li><code>IRBuilder::CreateInvoke</code></li>
Jay Foad558d3762011-07-14 09:19:05 +00001058<li><code>MDNode::get</code></li>
1059<li><code>MDNode::getIfExists</code></li>
1060<li><code>MDNode::getTemporary</code></li>
1061<li><code>MDNode::getWhenValsUnresolved</code></li>
Jay Foadb9b54eb2011-07-19 15:07:52 +00001062<li><code>SimplifyGEPInst</code> (in <code>llvm/Analysis/InstructionSimplify.h</code>)</li>
Jay Foad8fbbb392011-07-19 14:01:37 +00001063<li><code>TargetData::getIndexedOffset</code></li>
Jay Foad558d3762011-07-14 09:19:05 +00001064</ul></li>
1065
Bill Wendling7b7fa742011-10-26 18:46:16 +00001066 <li>All forms of <code>StringMap::getOrCreateValue</code> have been remove
1067 except for the one which takes a <code>StringRef</code>.</li>
Jay Foad558d3762011-07-14 09:19:05 +00001068
Bill Wendling7b7fa742011-10-26 18:46:16 +00001069 <li>The <code>LLVMBuildUnwind</code> function from the C API was removed. The
1070 LLVM <code>unwind</code> instruction has been deprecated for a long time
1071 and isn't used by the current front-ends. So this was removed during the
1072 exception handling rewrite.</li>
Bill Wendling16005252011-08-02 06:20:17 +00001073
Bill Wendling7b7fa742011-10-26 18:46:16 +00001074 <li>The <code>LLVMAddLowerSetJmpPass</code> function from the C API was
1075 removed because the <code>LowerSetJmp</code> pass was removed.</li>
Bill Wendling2626dba2011-08-03 22:18:20 +00001076
Bill Wendling7b7fa742011-10-26 18:46:16 +00001077 <li>The <code>DIBuilder</code> interface used by front ends to encode
1078 debugging information in the LLVM IR now expects clients to
1079 use <code>DIBuilder::finalize()</code> at the end of translation unit to
1080 complete debugging information encoding.</li>
Devang Patel6326a422011-08-15 23:00:00 +00001081
Bill Wendling7b7fa742011-10-26 18:46:16 +00001082 <li>The way the type system works has been
1083 rewritten: <code>PATypeHolder</code> and <code>OpaqueType</code> are gone,
1084 and all APIs deal with <code>Type*</code> instead of <code>const
1085 Type*</code>. If you need to create recursive structures, then create a
1086 named structure, and use <code>setBody()</code> when all its elements are
1087 built. Type merging and refining is gone too: named structures are not
1088 merged with other structures, even if their layout is identical. (of
1089 course anonymous structures are still uniqued by layout).</li>
Torok Edwinf16e2d42011-09-30 13:07:52 +00001090
Bill Wendling7b7fa742011-10-26 18:46:16 +00001091 <li>TargetSelect.h moved to Support/ from Target/</li>
Torok Edwinf16e2d42011-09-30 13:07:52 +00001092
Bill Wendling7b7fa742011-10-26 18:46:16 +00001093 <li>UpgradeIntrinsicCall no longer upgrades pre-2.9 intrinsic calls (for
1094 example <code>llvm.memset.i32</code>).</li>
Torok Edwinf16e2d42011-09-30 13:07:52 +00001095
Bill Wendling7b7fa742011-10-26 18:46:16 +00001096 <li>It is mandatory to initialize all out-of-tree passes too and their dependencies now with
1097 <code>INITIALIZE_PASS{BEGIN,END,}</code>
1098 and <code>INITIALIZE_{PASS,AG}_DEPENDENCY</code>.</li>
Torok Edwinf16e2d42011-09-30 13:07:52 +00001099
Bill Wendling7b7fa742011-10-26 18:46:16 +00001100 <li>The interface for MemDepResult in MemoryDependenceAnalysis has been
1101 enhanced with new return types Unknown and NonFuncLocal, in addition to
1102 the existing types Clobber, Def, and NonLocal.</li>
Daniel Dunbarf0233c62010-10-04 20:11:41 +00001103</ul>
Bill Wendling7b7fa742011-10-26 18:46:16 +00001104
Daniel Dunbarf0233c62010-10-04 20:11:41 +00001105</div>
Chris Lattnerf6662f92008-10-13 17:57:36 +00001106
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +00001107</div>
1108
Chris Lattner79c3fe12003-10-02 04:57:28 +00001109<!-- *********************************************************************** -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001110<h2>
Misha Brukman500bc302003-11-22 00:38:41 +00001111 <a name="knownproblems">Known Problems</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001112</h2>
Chris Lattner79c3fe12003-10-02 04:57:28 +00001113<!-- *********************************************************************** -->
1114
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +00001115<div>
Misha Brukman500bc302003-11-22 00:38:41 +00001116
Bill Wendling7b7fa742011-10-26 18:46:16 +00001117<p>This section contains significant known problems with the LLVM system, listed
1118 by component. If you run into a problem, please check
1119 the <a href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
1120 there isn't already one.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +00001121
Chris Lattnerf5ee1702004-03-14 02:03:02 +00001122<!-- ======================================================================= -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001123<h3>
Chris Lattnerf5ee1702004-03-14 02:03:02 +00001124 <a name="experimental">Experimental features included with this release</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001125</h3>
Chris Lattner79c3fe12003-10-02 04:57:28 +00001126
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +00001127<div>
Chris Lattnerf5ee1702004-03-14 02:03:02 +00001128
Misha Brukman6df9e2c2004-05-12 21:46:05 +00001129<p>The following components of this LLVM release are either untested, known to
Bill Wendling7b7fa742011-10-26 18:46:16 +00001130 be broken or unreliable, or are in early development. These components
1131 should not be relied on, and bugs should not be filed against them, but they
1132 may be useful to some people. In particular, if you would like to work on
1133 one of these components, please contact us on
1134 the <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev
1135 list</a>.</p>
Chris Lattnerf5ee1702004-03-14 02:03:02 +00001136
1137<ul>
Bill Wendling7b7fa742011-10-26 18:46:16 +00001138 <li>The Alpha, Blackfin, CellSPU, MicroBlaze, MSP430, MIPS, PTX, SystemZ and
1139 XCore backends are experimental.</li>
1140
1141 <li><tt>llc</tt> "<tt>-filetype=obj</tt>" is experimental on all targets other
1142 than darwin and ELF X86 systems.</li>
Chris Lattnerf5ee1702004-03-14 02:03:02 +00001143</ul>
1144
1145</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +00001146
Misha Brukman500bc302003-11-22 00:38:41 +00001147<!-- ======================================================================= -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001148<h3>
Chris Lattner26299222006-11-18 07:51:14 +00001149 <a name="x86-be">Known problems with the X86 back-end</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001150</h3>
John Criswellc0c186d2005-11-08 21:11:33 +00001151
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +00001152<div>
John Criswellc0c186d2005-11-08 21:11:33 +00001153
1154<ul>
Anton Korobeynikova6094be2008-06-08 10:24:13 +00001155 <li>The X86 backend does not yet support
Bill Wendling7b7fa742011-10-26 18:46:16 +00001156 all <a href="http://llvm.org/PR879">inline assembly that uses the X86
1157 floating point stack</a>. It supports the 'f' and 't' constraints, but
1158 not 'u'.</li>
1159
Dan Gohman8207ba92008-06-08 23:05:11 +00001160 <li>The X86-64 backend does not yet support the LLVM IR instruction
Bill Wendling7b7fa742011-10-26 18:46:16 +00001161 <tt>va_arg</tt>. Currently, front-ends support variadic argument
1162 constructs on X86-64 by lowering them manually.</li>
1163
NAKAMURA Takumi45c435a2011-04-05 08:24:22 +00001164 <li>Windows x64 (aka Win64) code generator has a few issues.
1165 <ul>
Bill Wendling7b7fa742011-10-26 18:46:16 +00001166 <li>llvm-gcc cannot build the mingw-w64 runtime currently due to lack of
1167 support for the 'u' inline assembly constraint and for X87 floating
1168 point inline assembly.</li>
1169
1170 <li>On mingw-w64, you will see unresolved symbol <tt>__chkstk</tt> due
1171 to <a href="http://llvm.org/bugs/show_bug.cgi?id=8919">Bug 8919</a>.
1172 It is fixed
1173 in <a href="http://lists.cs.uiuc.edu/pipermail/llvm-commits/Week-of-Mon-20110321/118499.html">r128206</a>.</li>
1174
NAKAMURA Takumi45c435a2011-04-05 08:24:22 +00001175 <li>Miss-aligned MOVDQA might crash your program. It is due to
Bill Wendling7b7fa742011-10-26 18:46:16 +00001176 <a href="http://llvm.org/bugs/show_bug.cgi?id=9483">Bug 9483</a>, lack
1177 of handling aligned internal globals.</li>
NAKAMURA Takumi45c435a2011-04-05 08:24:22 +00001178 </ul>
1179 </li>
1180
Chris Lattner26299222006-11-18 07:51:14 +00001181</ul>
1182
1183</div>
1184
1185<!-- ======================================================================= -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001186<h3>
Chris Lattner26299222006-11-18 07:51:14 +00001187 <a name="ppc-be">Known problems with the PowerPC back-end</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001188</h3>
Chris Lattner26299222006-11-18 07:51:14 +00001189
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +00001190<div>
Chris Lattner26299222006-11-18 07:51:14 +00001191
1192<ul>
Roman Divacky223764c2011-10-30 07:49:04 +00001193 <li>The PPC32/ELF support lacks PIC support.</li>
Chris Lattner26299222006-11-18 07:51:14 +00001194</ul>
1195
1196</div>
1197
1198<!-- ======================================================================= -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001199<h3>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +00001200 <a name="arm-be">Known problems with the ARM back-end</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001201</h3>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +00001202
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +00001203<div>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +00001204
1205<ul>
Bill Wendling7b7fa742011-10-26 18:46:16 +00001206 <li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
1207 processors, thumb programs can crash or produce wrong results
1208 (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
1209
1210 <li>Compilation for ARM Linux OABI (old ABI) is supported but not fully
1211 tested.</li>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +00001212</ul>
1213
1214</div>
1215
1216<!-- ======================================================================= -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001217<h3>
Chris Lattner26299222006-11-18 07:51:14 +00001218 <a name="sparc-be">Known problems with the SPARC back-end</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001219</h3>
Chris Lattner26299222006-11-18 07:51:14 +00001220
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +00001221<div>
Chris Lattner26299222006-11-18 07:51:14 +00001222
1223<ul>
Bill Wendling7b7fa742011-10-26 18:46:16 +00001224 <li>The SPARC backend only supports the 32-bit SPARC ABI (-m32); it does not
1225 support the 64-bit SPARC ABI (-m64).</li>
Chris Lattner26299222006-11-18 07:51:14 +00001226</ul>
1227
1228</div>
1229
1230<!-- ======================================================================= -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001231<h3>
Bruno Cardoso Lopesb7e1a4f2008-10-25 14:56:26 +00001232 <a name="mips-be">Known problems with the MIPS back-end</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001233</h3>
Bruno Cardoso Lopesb7e1a4f2008-10-25 14:56:26 +00001234
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +00001235<div>
Bruno Cardoso Lopesb7e1a4f2008-10-25 14:56:26 +00001236
1237<ul>
Bill Wendling7b7fa742011-10-26 18:46:16 +00001238 <li>64-bit MIPS targets are not supported yet.</li>
Bruno Cardoso Lopesb7e1a4f2008-10-25 14:56:26 +00001239</ul>
1240
1241</div>
1242
1243<!-- ======================================================================= -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001244<h3>
Chris Lattner26299222006-11-18 07:51:14 +00001245 <a name="alpha-be">Known problems with the Alpha back-end</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001246</h3>
Chris Lattner26299222006-11-18 07:51:14 +00001247
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +00001248<div>
Chris Lattner26299222006-11-18 07:51:14 +00001249
1250<ul>
Bill Wendling7b7fa742011-10-26 18:46:16 +00001251 <li>On 21164s, some rare FP arithmetic sequences which may trap do not have
1252 the appropriate nops inserted to ensure restartability.</li>
John Criswellc0c186d2005-11-08 21:11:33 +00001253</ul>
Bill Wendling7b7fa742011-10-26 18:46:16 +00001254
John Criswellc0c186d2005-11-08 21:11:33 +00001255</div>
1256
Chris Lattner26299222006-11-18 07:51:14 +00001257<!-- ======================================================================= -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001258<h3>
Chris Lattnerf3e5bc62007-05-14 06:56:09 +00001259 <a name="c-be">Known problems with the C back-end</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001260</h3>
Chris Lattner26299222006-11-18 07:51:14 +00001261
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +00001262<div>
Chris Lattner26299222006-11-18 07:51:14 +00001263
Chris Lattner3016ee92010-09-29 05:34:42 +00001264<p>The C backend has numerous problems and is not being actively maintained.
Bill Wendling7b7fa742011-10-26 18:46:16 +00001265 Depending on it for anything serious is not advised.</p>
Chris Lattner3016ee92010-09-29 05:34:42 +00001266
Chris Lattner26299222006-11-18 07:51:14 +00001267<ul>
Bill Wendling7b7fa742011-10-26 18:46:16 +00001268 <li><a href="http://llvm.org/PR802">The C backend has only basic support for
1269 inline assembly code</a>.</li>
1270
1271 <li><a href="http://llvm.org/PR1658">The C backend violates the ABI of common
1272 C++ programs</a>, preventing intermixing between C++ compiled by the CBE
1273 and C++ code compiled with <tt>llc</tt> or native compilers.</li>
1274
1275 <li>The C backend does not support all exception handling constructs.</li>
1276
1277 <li>The C backend does not support arbitrary precision integers.</li>
Chris Lattner26299222006-11-18 07:51:14 +00001278</ul>
1279
1280</div>
John Criswellc0c186d2005-11-08 21:11:33 +00001281
Misha Brukman500bc302003-11-22 00:38:41 +00001282
1283<!-- ======================================================================= -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001284<h3>
Chris Lattner3016ee92010-09-29 05:34:42 +00001285 <a name="llvm-gcc">Known problems with the llvm-gcc front-end</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001286</h3>
Chris Lattner47588f92003-10-02 05:07:23 +00001287
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +00001288<div>
Chris Lattnerc5d658a2006-03-03 00:34:26 +00001289
Bill Wendling7b7fa742011-10-26 18:46:16 +00001290<p><b>LLVM 2.9 was the last release of llvm-gcc.</b></p>
Chris Lattner49123fd2011-04-06 06:29:50 +00001291
Chris Lattner3016ee92010-09-29 05:34:42 +00001292<p>llvm-gcc is generally very stable for the C family of languages. The only
1293 major language feature of GCC not supported by llvm-gcc is the
1294 <tt>__builtin_apply</tt> family of builtins. However, some extensions
1295 are only supported on some targets. For example, trampolines are only
1296 supported on some targets (these are used when you take the address of a
1297 nested function).</p>
Misha Brukman500bc302003-11-22 00:38:41 +00001298
Chris Lattner3016ee92010-09-29 05:34:42 +00001299<p>Fortran support generally works, but there are still several unresolved bugs
1300 in <a href="http://llvm.org/bugs/">Bugzilla</a>. Please see the
1301 tools/gfortran component for details. Note that llvm-gcc is missing major
1302 Fortran performance work in the frontend and library that went into GCC after
1303 4.2. If you are interested in Fortran, we recommend that you consider using
1304 <a href="#dragonegg">dragonegg</a> instead.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +00001305
Duncan Sands3af96332010-10-04 10:06:56 +00001306<p>The llvm-gcc 4.2 Ada compiler has basic functionality, but is no longer being
Bill Wendling7b7fa742011-10-26 18:46:16 +00001307 actively maintained. If you are interested in Ada, we recommend that you
1308 consider using <a href="#dragonegg">dragonegg</a> instead.</p>
1309
Chris Lattner2b659ef2008-02-12 06:29:45 +00001310</div>
1311
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +00001312</div>
1313
Chris Lattner79c3fe12003-10-02 04:57:28 +00001314<!-- *********************************************************************** -->
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001315<h2>
Misha Brukman500bc302003-11-22 00:38:41 +00001316 <a name="additionalinfo">Additional Information</a>
NAKAMURA Takumi06c6d9a2011-04-18 01:17:51 +00001317</h2>
Chris Lattner79c3fe12003-10-02 04:57:28 +00001318<!-- *********************************************************************** -->
1319
NAKAMURA Takumi074eeaa2011-04-21 01:52:00 +00001320<div>
Misha Brukman500bc302003-11-22 00:38:41 +00001321
Bill Wendling7b7fa742011-10-26 18:46:16 +00001322<p>A wide variety of additional information is available on
1323 the <a href="http://llvm.org/">LLVM web page</a>, in particular in
1324 the <a href="http://llvm.org/docs/">documentation</a> section. The web page
1325 also contains versions of the API documentation which is up-to-date with the
1326 Subversion version of the source code. You can access versions of these
1327 documents specific to this release by going into the "<tt>llvm/doc/</tt>"
1328 directory in the LLVM tree.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +00001329
Misha Brukman500bc302003-11-22 00:38:41 +00001330<p>If you have any questions or comments about LLVM, please feel free to contact
Bill Wendling7b7fa742011-10-26 18:46:16 +00001331 us via the <a href="http://llvm.org/docs/#maillist"> mailing lists</a>.</p>
Chris Lattner79c3fe12003-10-02 04:57:28 +00001332
Misha Brukman500bc302003-11-22 00:38:41 +00001333</div>
Chris Lattner79c3fe12003-10-02 04:57:28 +00001334
1335<!-- *********************************************************************** -->
Chris Lattner79c3fe12003-10-02 04:57:28 +00001336
Misha Brukman500bc302003-11-22 00:38:41 +00001337<hr>
Misha Brukman2061e892003-11-22 01:23:39 +00001338<address>
Misha Brukman38847d52003-12-21 22:53:21 +00001339 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman44408702008-12-11 17:34:48 +00001340 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
Misha Brukman2061e892003-11-22 01:23:39 +00001341 <a href="http://validator.w3.org/check/referer"><img
Misha Brukman44408702008-12-11 17:34:48 +00001342 src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
Misha Brukman2061e892003-11-22 01:23:39 +00001343
Chris Lattnerb4b0ce72007-05-18 00:44:29 +00001344 <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
Misha Brukman500bc302003-11-22 00:38:41 +00001345 Last modified: $Date$
Misha Brukman2061e892003-11-22 01:23:39 +00001346</address>
Chris Lattner79c3fe12003-10-02 04:57:28 +00001347
Misha Brukman500bc302003-11-22 00:38:41 +00001348</body>
1349</html>