blob: 025f91a8f8df9845da98a1bc0a93ecb3af1d6bd2 [file] [log] [blame]
Misha Brukman80731b92003-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 Spencere4190fa2004-11-18 18:38:58 +00005 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
Misha Brukman80731b92003-11-22 00:38:41 +00006 <link rel="stylesheet" href="llvm.css" type="text/css">
Chad Rosier06da55e2011-05-27 22:50:46 +00007 <title>LLVM 3.0 Release Notes</title>
Misha Brukman80731b92003-11-22 00:38:41 +00008</head>
9<body>
Chris Lattner3d482502003-10-02 04:57:28 +000010
Chad Rosier06da55e2011-05-27 22:50:46 +000011<h1>LLVM 3.0 Release Notes</h1>
Mikhail Glushenkov024f7cf2008-10-13 02:08:34 +000012
Chris Lattnerc871bac2010-03-17 04:02:39 +000013<img align=right src="http://llvm.org/img/DragonSmall.png"
Gabor Greif27b166352010-04-22 10:21:43 +000014 width="136" height="136" alt="LLVM Dragon Logo">
Chris Lattnerc871bac2010-03-17 04:02:39 +000015
Chris Lattner3d482502003-10-02 04:57:28 +000016<ol>
Misha Brukman80731b92003-11-22 00:38:41 +000017 <li><a href="#intro">Introduction</a></li>
Chris Lattnerf5cd9862008-10-13 18:01:01 +000018 <li><a href="#subproj">Sub-project Status Update</a></li>
Chad Rosier06da55e2011-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 Lattner77a51732004-04-30 22:17:12 +000021 <li><a href="GettingStarted.html">Installation Instructions</a></li>
Dan Gohmanad888912008-10-14 16:23:02 +000022 <li><a href="#knownproblems">Known Problems</a></li>
Misha Brukman80731b92003-11-22 00:38:41 +000023 <li><a href="#additionalinfo">Additional Information</a></li>
Chris Lattner3d482502003-10-02 04:57:28 +000024</ol>
25
Chris Lattner020e1fc2004-05-23 21:07:27 +000026<div class="doc_author">
NAKAMURA Takumica46f5a2011-04-09 02:13:37 +000027 <p>Written by the <a href="http://llvm.org/">LLVM Team</a></p>
Misha Brukman80731b92003-11-22 00:38:41 +000028</div>
Chris Lattner3d482502003-10-02 04:57:28 +000029
Chris Lattner17c170a2011-04-06 06:29:50 +000030<!--
Chad Rosier06da55e2011-05-27 22:50:46 +000031<h1 style="color:red">These are in-progress notes for the upcoming LLVM 3.0
Jeffrey Yasskin0830b972010-01-28 01:14:43 +000032release.<br>
33You may prefer the
Chad Rosier06da55e2011-05-27 22:50:46 +000034<a href="http://llvm.org/releases/2.9/docs/ReleaseNotes.html">LLVM 2.9
Dan Gohman62af9d22010-05-03 23:51:05 +000035Release Notes</a>.</h1>
Chris Lattner17c170a2011-04-06 06:29:50 +000036 -->
Jeffrey Yasskin0830b972010-01-28 01:14:43 +000037
Chris Lattner3d482502003-10-02 04:57:28 +000038<!-- *********************************************************************** -->
NAKAMURA Takumi64835132011-04-18 01:17:51 +000039<h2>
Misha Brukman80731b92003-11-22 00:38:41 +000040 <a name="intro">Introduction</a>
NAKAMURA Takumi64835132011-04-18 01:17:51 +000041</h2>
Chris Lattner3d482502003-10-02 04:57:28 +000042<!-- *********************************************************************** -->
43
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +000044<div>
Misha Brukman80731b92003-11-22 00:38:41 +000045
Chris Lattner1e4d5bc2008-10-13 17:57:36 +000046<p>This document contains the release notes for the LLVM Compiler
Chad Rosier06da55e2011-05-27 22:50:46 +000047Infrastructure, release 3.0. Here we describe the status of LLVM, including
Chris Lattner1e4d5bc2008-10-13 17:57:36 +000048major improvements from the previous release and significant known problems.
Mikhail Glushenkov25422542009-03-01 18:09:47 +000049All LLVM releases may be downloaded from the <a
Chris Lattner1e4d5bc2008-10-13 17:57:36 +000050href="http://llvm.org/releases/">LLVM releases web site</a>.</p>
Chris Lattner62495762003-10-02 16:38:05 +000051
Chris Lattnerb5bb5972004-12-07 08:04:13 +000052<p>For more information about LLVM, including information about the latest
Chris Lattnera69595e2005-10-29 07:07:09 +000053release, please check out the <a href="http://llvm.org/">main LLVM
Chris Lattnere7525b52003-10-07 21:38:31 +000054web site</a>. If you have questions or comments, the <a
Chris Lattner0b1c9a52010-03-17 04:41:49 +000055href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM Developer's
56Mailing List</a> is a good place to send them.</p>
Chris Lattner3d482502003-10-02 04:57:28 +000057
Mikhail Glushenkov024f7cf2008-10-13 02:08:34 +000058<p>Note that if you are reading this file from a Subversion checkout or the
Chris Lattner0a1fd102007-09-21 03:54:09 +000059main LLVM web page, this document applies to the <i>next</i> release, not the
Gabor Greif355f81c2008-10-14 11:00:32 +000060current one. To see the release notes for a specific release, please see the
Chris Lattner0a1fd102007-09-21 03:54:09 +000061<a href="http://llvm.org/releases/">releases page</a>.</p>
Misha Brukman80731b92003-11-22 00:38:41 +000062
63</div>
Chris Lattneraa61f412009-10-13 17:48:04 +000064
Chris Lattnerce6b0472011-04-05 23:22:33 +000065<!-- Features that need text if they're finished for 3.1:
66 ARM EHABI
Chris Lattnera67df2d2010-04-22 06:28:20 +000067 combiner-aa?
Chris Lattneraa61f412009-10-13 17:48:04 +000068 strong phi elim
Chris Lattneraa61f412009-10-13 17:48:04 +000069 loop dependence analysis
Chris Lattner342f9572010-09-29 05:30:03 +000070 CorrelatedValuePropagation
Chris Lattnerce6b0472011-04-05 23:22:33 +000071 lib/Transforms/IPO/MergeFunctions.cpp => consider for 3.1.
Chris Lattner2b8a52e2008-02-10 07:46:44 +000072 -->
Chris Lattner342f9572010-09-29 05:30:03 +000073
Chris Lattnerf5cd9862008-10-13 18:01:01 +000074<!-- *********************************************************************** -->
NAKAMURA Takumi64835132011-04-18 01:17:51 +000075<h2>
Chris Lattnerf5cd9862008-10-13 18:01:01 +000076 <a name="subproj">Sub-project Status Update</a>
NAKAMURA Takumi64835132011-04-18 01:17:51 +000077</h2>
Chris Lattnerf5cd9862008-10-13 18:01:01 +000078<!-- *********************************************************************** -->
Chris Lattner625a3d82008-06-08 21:34:41 +000079
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +000080<div>
Chris Lattnerc75fd522008-06-08 21:58:17 +000081<p>
Chad Rosier06da55e2011-05-27 22:50:46 +000082The LLVM 3.0 distribution currently consists of code from the core LLVM
Chris Lattneraa61f412009-10-13 17:48:04 +000083repository (which roughly includes the LLVM optimizers, code generators
84and supporting tools), the Clang repository and the llvm-gcc repository. In
85addition to this code, the LLVM Project includes other sub-projects that are in
86development. Here we include updates on these subprojects.
Bill Wendlingf170d2e2009-03-02 04:28:57 +000087</p>
Chris Lattnerf5cd9862008-10-13 18:01:01 +000088
Chris Lattnerc75fd522008-06-08 21:58:17 +000089<!--=========================================================================-->
NAKAMURA Takumi64835132011-04-18 01:17:51 +000090<h3>
Chris Lattner44c09cd2008-10-13 18:11:54 +000091<a name="clang">Clang: C/C++/Objective-C Frontend Toolkit</a>
NAKAMURA Takumi64835132011-04-18 01:17:51 +000092</h3>
Chris Lattnerc75fd522008-06-08 21:58:17 +000093
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +000094<div>
Chris Lattnerc75fd522008-06-08 21:58:17 +000095
Chris Lattner5de7f6e2010-04-26 17:42:18 +000096<p><a href="http://clang.llvm.org/">Clang</a> is an LLVM front end for the C,
97C++, and Objective-C languages. Clang aims to provide a better user experience
98through expressive diagnostics, a high level of conformance to language
99standards, fast compilation, and low memory use. Like LLVM, Clang provides a
100modular, library-based architecture that makes it suitable for creating or
101integrating with other development tools. Clang is considered a
Chris Lattner342f9572010-09-29 05:30:03 +0000102production-quality compiler for C, Objective-C, C++ and Objective-C++ on x86
Chris Lattnerc3a2c982011-04-06 00:45:11 +0000103(32- and 64-bit), and for darwin/arm targets.</p>
Chris Lattneraa61f412009-10-13 17:48:04 +0000104
Chad Rosier06da55e2011-05-27 22:50:46 +0000105<p>In the LLVM 3.0 time-frame, the Clang team has made many improvements:</p>
Chris Lattnerfd97b882011-04-05 07:19:28 +0000106
Duncan Sandsce5d9ae2011-04-06 08:07:40 +0000107<p>If Clang rejects your code but another compiler accepts it, please take a
Chris Lattnerfd97b882011-04-05 07:19:28 +0000108look at the <a href="http://clang.llvm.org/compatibility.html">language
Duncan Sandsce5d9ae2011-04-06 08:07:40 +0000109compatibility</a> guide to make sure this is not intentional or a known issue.
Chris Lattnerfd97b882011-04-05 07:19:28 +0000110</p>
Bill Wendlingef362462008-10-27 09:27:33 +0000111
Chris Lattner44c09cd2008-10-13 18:11:54 +0000112</div>
113
114<!--=========================================================================-->
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000115<h3>
Duncan Sands1cd78982011-04-04 11:09:08 +0000116<a name="dragonegg">DragonEgg: GCC front-ends, LLVM back-end</a>
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000117</h3>
Chris Lattneraa61f412009-10-13 17:48:04 +0000118
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +0000119<div>
Chris Lattneraa61f412009-10-13 17:48:04 +0000120<p>
Duncan Sands1cd78982011-04-04 11:09:08 +0000121<a href="http://dragonegg.llvm.org/">DragonEgg</a> is a
122<a href="http://gcc.gnu.org/wiki/plugins">gcc plugin</a> that replaces GCC's
123optimizers and code generators with LLVM's.
124Currently it requires a patched version of gcc-4.5.
125The plugin can target the x86-32 and x86-64 processor families and has been
126used successfully on the Darwin, FreeBSD and Linux platforms.
127The Ada, C, C++ and Fortran languages work well.
128The plugin is capable of compiling plenty of Obj-C, Obj-C++ and Java but it is
129not known whether the compiled code actually works or not!
Duncan Sands92452b92010-04-02 09:23:15 +0000130</p>
131
132<p>
Chad Rosier06da55e2011-05-27 22:50:46 +0000133The 3.0 release has the following notable changes:
Duncan Sands7f9a0dc2010-09-30 17:37:34 +0000134<ul>
Chad Rosier06da55e2011-05-27 22:50:46 +0000135<!--
136<li></li>
137-->
Duncan Sands7f9a0dc2010-09-30 17:37:34 +0000138</ul>
Chris Lattneraa61f412009-10-13 17:48:04 +0000139
140</div>
141
Chris Lattner120804a2010-10-03 23:49:06 +0000142<!--=========================================================================-->
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000143<h3>
Chris Lattner120804a2010-10-03 23:49:06 +0000144<a name="compiler-rt">compiler-rt: Compiler Runtime Library</a>
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000145</h3>
Chris Lattner120804a2010-10-03 23:49:06 +0000146
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +0000147<div>
Chris Lattner120804a2010-10-03 23:49:06 +0000148<p>
149The new LLVM <a href="http://compiler-rt.llvm.org/">compiler-rt project</a>
150is a simple library that provides an implementation of the low-level
151target-specific hooks required by code generation and other runtime components.
152For example, when compiling for a 32-bit target, converting a double to a 64-bit
153unsigned integer is compiled into a runtime call to the "__fixunsdfdi"
154function. The compiler-rt library provides highly optimized implementations of
155this and other low-level routines (some are 3x faster than the equivalent
156libgcc routines).</p>
157
Chad Rosier06da55e2011-05-27 22:50:46 +0000158<p>In the LLVM 3.0 timeframe,</p>
Chris Lattner120804a2010-10-03 23:49:06 +0000159
160</div>
Chris Lattneraa61f412009-10-13 17:48:04 +0000161
162<!--=========================================================================-->
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000163<h3>
Chris Lattner342f9572010-09-29 05:30:03 +0000164<a name="lldb">LLDB: Low Level Debugger</a>
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000165</h3>
Chris Lattner342f9572010-09-29 05:30:03 +0000166
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +0000167<div>
Chris Lattner342f9572010-09-29 05:30:03 +0000168<p>
Chris Lattner120804a2010-10-03 23:49:06 +0000169<a href="http://lldb.llvm.org/">LLDB</a> is a brand new member of the LLVM
170umbrella of projects. LLDB is a next generation, high-performance debugger. It
171is built as a set of reusable components which highly leverage existing
172libraries in the larger LLVM Project, such as the Clang expression parser, the
173LLVM disassembler and the LLVM JIT.</p>
Chris Lattner342f9572010-09-29 05:30:03 +0000174
175<p>
Chad Rosier06da55e2011-05-27 22:50:46 +0000176LLDB is has advanced by leaps and bounds in the 3.0 timeframe. It is
Chris Lattner9d5b3712011-04-06 00:56:12 +0000177dramatically more stable and useful, and includes both a new <a
178href="http://lldb.llvm.org/tutorial.html">tutorial</a> and a <a
179href="http://lldb.llvm.org/lldb-gdb.html">side-by-side comparison with
180GDB</a>.</p>
Chris Lattner342f9572010-09-29 05:30:03 +0000181
182</div>
183
184<!--=========================================================================-->
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000185<h3>
Chris Lattner342f9572010-09-29 05:30:03 +0000186<a name="libc++">libc++: C++ Standard Library</a>
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000187</h3>
Chris Lattner342f9572010-09-29 05:30:03 +0000188
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +0000189<div>
Chris Lattner342f9572010-09-29 05:30:03 +0000190<p>
Tobias Grosser436bc5f2010-10-06 21:07:30 +0000191<a href="http://libcxx.llvm.org/">libc++</a> is another new member of the LLVM
Chris Lattner120804a2010-10-03 23:49:06 +0000192family. It is an implementation of the C++ standard library, written from the
193ground up to specifically target the forthcoming C++'0X standard and focus on
194delivering great performance.</p>
Chris Lattner342f9572010-09-29 05:30:03 +0000195
196<p>
Chad Rosier06da55e2011-05-27 22:50:46 +0000197In the LLVM 3.0 timeframe,</p>
Chris Lattnerfd97b882011-04-05 07:19:28 +0000198
Chris Lattner14a33332011-04-06 00:59:18 +0000199<p>
200Like compiler_rt, libc++ is now <a href="DeveloperPolicy.html#license">dual
201 licensed</a> under the MIT and UIUC license, allowing it to be used more
202 permissively.
Chris Lattner342f9572010-09-29 05:30:03 +0000203</p>
204
205</div>
206
Chris Lattneraa61f412009-10-13 17:48:04 +0000207
Chris Lattnercaefe932011-04-07 03:08:22 +0000208<!--=========================================================================-->
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000209<h3>
Chris Lattnercaefe932011-04-07 03:08:22 +0000210<a name="LLBrowse">LLBrowse: IR Browser</a>
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000211</h3>
Daniel Dunbar8fbd8aa2010-10-04 17:39:47 +0000212
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +0000213<div>
Chris Lattnercaefe932011-04-07 03:08:22 +0000214<p>
215<a href="http://llvm.org/svn/llvm-project/llbrowse/trunk/doc/LLBrowse.html">
216 LLBrowse</a> is an interactive viewer for LLVM modules. It can load any LLVM
217 module and displays its contents as an expandable tree view, facilitating an
218 easy way to inspect types, functions, global variables, or metadata nodes. It
219 is fully cross-platform, being based on the popular wxWidgets GUI toolkit.
220</p>
221</div>
222
223<!--=========================================================================-->
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000224<h3>
Chris Lattnercaefe932011-04-07 03:08:22 +0000225<a name="vmkit">VMKit</a>
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000226</h3>
Chris Lattnercaefe932011-04-07 03:08:22 +0000227
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +0000228<div>
Chris Lattnercaefe932011-04-07 03:08:22 +0000229<p>The <a href="http://vmkit.llvm.org/">VMKit project</a> is an implementation
230 of a Java Virtual Machine (Java VM or JVM) that uses LLVM for static and
Chad Rosier06da55e2011-05-27 22:50:46 +0000231 just-in-time compilation. As of LLVM 3.0, VMKit now supports generational
Chris Lattnercaefe932011-04-07 03:08:22 +0000232 garbage collectors. The garbage collectors are provided by the MMTk framework,
233 and VMKit can be configured to use one of the numerous implemented collectors
234 of MMTk.
235</p>
236</div>
237
238
Daniel Dunbar8fbd8aa2010-10-04 17:39:47 +0000239<!--=========================================================================-->
Chris Lattner9ee0b012011-04-05 18:38:45 +0000240<!--
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000241<h3>
Daniel Dunbar8fbd8aa2010-10-04 17:39:47 +0000242<a name="klee">KLEE: A Symbolic Execution Virtual Machine</a>
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000243</h3>
Daniel Dunbar8fbd8aa2010-10-04 17:39:47 +0000244
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +0000245<div>
Daniel Dunbar8fbd8aa2010-10-04 17:39:47 +0000246<p>
247<a href="http://klee.llvm.org/">KLEE</a> is a symbolic execution framework for
248programs in LLVM bitcode form. KLEE tries to symbolically evaluate "all" paths
249through the application and records state transitions that lead to fault
250states. This allows it to construct testcases that lead to faults and can even
251be used to verify some algorithms.
252</p>
253
Chris Lattner0d364302011-03-10 07:43:44 +0000254<p>UPDATE!</p>
Chris Lattner9ee0b012011-04-05 18:38:45 +0000255</div>-->
Daniel Dunbar8fbd8aa2010-10-04 17:39:47 +0000256
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +0000257</div>
Daniel Dunbar8fbd8aa2010-10-04 17:39:47 +0000258
Chris Lattner53e06f92009-02-26 22:33:38 +0000259<!-- *********************************************************************** -->
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000260<h2>
Chad Rosier06da55e2011-05-27 22:50:46 +0000261 <a name="externalproj">External Open Source Projects Using LLVM 3.0</a>
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000262</h2>
Chris Lattner53e06f92009-02-26 22:33:38 +0000263<!-- *********************************************************************** -->
264
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +0000265<div>
Chris Lattneraa61f412009-10-13 17:48:04 +0000266
267<p>An exciting aspect of LLVM is that it is used as an enabling technology for
268 a lot of other language and tools projects. This section lists some of the
Chad Rosier06da55e2011-05-27 22:50:46 +0000269 projects that have already been updated to work with LLVM 3.0.</p>
Chris Lattner120804a2010-10-03 23:49:06 +0000270
Chris Lattnerae6a89a2011-04-06 01:13:49 +0000271<!--=========================================================================-->
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000272<h3>Crack Programming Language</h3>
Chris Lattnerae6a89a2011-04-06 01:13:49 +0000273
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +0000274<div>
Chris Lattnerae6a89a2011-04-06 01:13:49 +0000275<p>
276<a href="http://code.google.com/p/crack-language/">Crack</a> aims to provide the
277ease of development of a scripting language with the performance of a compiled
278language. The language derives concepts from C++, Java and Python, incorporating
279object-oriented programming, operator overloading and strong typing.</p>
280</div>
281
282
283<!--=========================================================================-->
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000284<h3>TTA-based Codesign Environment (TCE)</h3>
Chris Lattnerae6a89a2011-04-06 01:13:49 +0000285
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +0000286<div>
Chris Lattnerae6a89a2011-04-06 01:13:49 +0000287<p>TCE is a toolset for designing application-specific processors (ASP) based on
288the Transport triggered architecture (TTA). The toolset provides a complete
289co-design flow from C/C++ programs down to synthesizable VHDL and parallel
290program binaries. Processor customization points include the register files,
291function units, supported operations, and the interconnection network.</p>
292
293<p>TCE uses Clang and LLVM for C/C++ language support, target independent
294optimizations and also for parts of code generation. It generates new LLVM-based
295code generators "on the fly" for the designed TTA processors and loads them in
296to the compiler backend as runtime libraries to avoid per-target recompilation
297of larger parts of the compiler chain.</p>
298</div>
299
300
301
302<!--=========================================================================-->
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000303<h3>PinaVM</h3>
Chris Lattnerae6a89a2011-04-06 01:13:49 +0000304
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +0000305<div>
Chris Lattnerae6a89a2011-04-06 01:13:49 +0000306<p><a href="http://gitorious.org/pinavm/pages/Home">PinaVM</a> is an open
307source, <a href="http://www.systemc.org/">SystemC</a> front-end. Unlike many
308other front-ends, PinaVM actually executes the elaboration of the
309program analyzed using LLVM's JIT infrastructure. It later enriches the
310bitcode with SystemC-specific information.</p>
311</div>
312
313<!--=========================================================================-->
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000314<h3>Pure</h3>
Chris Lattnerae6a89a2011-04-06 01:13:49 +0000315
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +0000316<div>
Chris Lattnerae6a89a2011-04-06 01:13:49 +0000317<p><a href="http://pure-lang.googlecode.com/">Pure</a> is an
318 algebraic/functional
319 programming language based on term rewriting. Programs are collections
320 of equations which are used to evaluate expressions in a symbolic
321 fashion. The interpreter uses LLVM as a backend to JIT-compile Pure
322 programs to fast native code. Pure offers dynamic typing, eager and lazy
323 evaluation, lexical closures, a hygienic macro system (also based on
324 term rewriting), built-in list and matrix support (including list and
325 matrix comprehensions) and an easy-to-use interface to C and other
326 programming languages (including the ability to load LLVM bitcode
327 modules, and inline C, C++, Fortran and Faust code in Pure programs if
328 the corresponding LLVM-enabled compilers are installed).</p>
329
Chad Rosier06da55e2011-05-27 22:50:46 +0000330<p>Pure version 0.47 has been tested and is known to work with LLVM 3.0
Chris Lattnerae6a89a2011-04-06 01:13:49 +0000331 (and continues to work with older LLVM releases &gt;= 2.5).</p>
332</div>
333
334<!--=========================================================================-->
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000335<h3 id="icedtea">IcedTea Java Virtual Machine Implementation</h3>
Chris Lattnerae6a89a2011-04-06 01:13:49 +0000336
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +0000337<div>
Chris Lattnerae6a89a2011-04-06 01:13:49 +0000338<p>
339<a href="http://icedtea.classpath.org/wiki/Main_Page">IcedTea</a> provides a
340harness to build OpenJDK using only free software build tools and to provide
341replacements for the not-yet free parts of OpenJDK. One of the extensions that
342IcedTea provides is a new JIT compiler named <a
343href="http://icedtea.classpath.org/wiki/ZeroSharkFaq">Shark</a> which uses LLVM
344to provide native code generation without introducing processor-dependent
345code.
346</p>
347
348<p> OpenJDK 7 b112, IcedTea6 1.9 and IcedTea7 1.13 and later have been tested
Chad Rosier06da55e2011-05-27 22:50:46 +0000349and are known to work with LLVM 3.0 (and continue to work with older LLVM
Chris Lattnerae6a89a2011-04-06 01:13:49 +0000350releases &gt;= 2.6 as well).</p>
351</div>
352
353<!--=========================================================================-->
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000354<h3>Glasgow Haskell Compiler (GHC)</h3>
Chris Lattnerae6a89a2011-04-06 01:13:49 +0000355
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +0000356<div>
Chris Lattnerae6a89a2011-04-06 01:13:49 +0000357<p>GHC is an open source, state-of-the-art programming suite for Haskell,
358a standard lazy functional programming language. It includes an
359optimizing static compiler generating good code for a variety of
360platforms, together with an interactive system for convenient, quick
361development.</p>
362
363<p>In addition to the existing C and native code generators, GHC 7.0 now
364supports an LLVM code generator. GHC supports LLVM 2.7 and later.</p>
365</div>
366
367<!--=========================================================================-->
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000368<h3>Polly - Polyhedral optimizations for LLVM</h3>
Chris Lattnerae6a89a2011-04-06 01:13:49 +0000369
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +0000370<div>
Chris Lattnerae6a89a2011-04-06 01:13:49 +0000371<p>Polly is a project that aims to provide advanced memory access optimizations
372to better take advantage of SIMD units, cache hierarchies, multiple cores or
373even vector accelerators for LLVM. Built around an abstract mathematical
374description based on Z-polyhedra, it provides the infrastructure to develop
375advanced optimizations in LLVM and to connect complex external optimizers. In
376its first year of existence Polly already provides an exact value-based
377dependency analysis as well as basic SIMD and OpenMP code generation support.
378Furthermore, Polly can use PoCC(Pluto) an advanced optimizer for data-locality
379and parallelism.</p>
380</div>
Chris Lattner120804a2010-10-03 23:49:06 +0000381
Chris Lattner958d2992011-04-06 16:14:25 +0000382<!--=========================================================================-->
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000383<h3>Rubinius</h3>
Chris Lattner958d2992011-04-06 16:14:25 +0000384
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +0000385<div>
Chris Lattner958d2992011-04-06 16:14:25 +0000386 <p><a href="http://github.com/evanphx/rubinius">Rubinius</a> is an environment
387 for running Ruby code which strives to write as much of the implementation in
388 Ruby as possible. Combined with a bytecode interpreting VM, it uses LLVM to
389 optimize and compile ruby code down to machine code. Techniques such as type
390 feedback, method inlining, and deoptimization are all used to remove dynamism
391 from ruby execution and increase performance.</p>
392</div>
393
394
Chris Lattner5ddaab12011-04-07 03:09:21 +0000395<!--=========================================================================-->
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000396<h3>
Chris Lattner5ddaab12011-04-07 03:09:21 +0000397<a name="FAUST">FAUST Real-Time Audio Signal Processing Language</a>
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000398</h3>
Chris Lattnerca7c8962010-10-01 06:34:49 +0000399
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +0000400<div>
Chris Lattner5ddaab12011-04-07 03:09:21 +0000401<p>
402<a href="http://faust.grame.fr">FAUST</a> is a compiled language for real-time
403audio signal processing. The name FAUST stands for Functional AUdio STream. Its
404programming model combines two approaches: functional programming and block
405diagram composition. In addition with the C, C++, JAVA output formats, the
Chad Rosier06da55e2011-05-27 22:50:46 +0000406Faust compiler can now generate LLVM bitcode, and works with LLVM 2.7-3.0.</p>
Chris Lattner5ddaab12011-04-07 03:09:21 +0000407
408</div>
409
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +0000410</div>
411
Chris Lattnerc75fd522008-06-08 21:58:17 +0000412<!-- *********************************************************************** -->
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000413<h2>
Chad Rosier06da55e2011-05-27 22:50:46 +0000414 <a name="whatsnew">What's New in LLVM 3.0?</a>
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000415</h2>
Chris Lattnerc75fd522008-06-08 21:58:17 +0000416<!-- *********************************************************************** -->
417
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +0000418<div>
Chris Lattnerb7bc2aa2008-06-08 22:59:35 +0000419
Chris Lattneraa61f412009-10-13 17:48:04 +0000420<p>This release includes a huge number of bug fixes, performance tweaks and
Chris Lattner1e4d5bc2008-10-13 17:57:36 +0000421minor improvements. Some of the major improvements and new features are listed
422in this section.
Chris Lattnerb7bc2aa2008-06-08 22:59:35 +0000423</p>
Chris Lattneraa61f412009-10-13 17:48:04 +0000424
Chris Lattnera67df2d2010-04-22 06:28:20 +0000425<!--=========================================================================-->
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000426<h3>
Chris Lattnercdc44ed2008-02-06 18:00:06 +0000427<a name="majorfeatures">Major New Features</a>
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000428</h3>
Chris Lattnercdc44ed2008-02-06 18:00:06 +0000429
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +0000430<div>
Chris Lattnercdc44ed2008-02-06 18:00:06 +0000431
Chad Rosier06da55e2011-05-27 22:50:46 +0000432<p>LLVM 3.0 includes several major new capabilities:</p>
Chris Lattner97beb512007-05-14 06:56:09 +0000433
434<ul>
Chris Lattnerc3a2c982011-04-06 00:45:11 +0000435
Chad Rosier06da55e2011-05-27 22:50:46 +0000436<!--
437<li></li>
438-->
Chris Lattner9ee0b012011-04-05 18:38:45 +0000439
Chris Lattner458e79f2008-02-10 08:18:42 +0000440</ul>
Chris Lattnerfd97b882011-04-05 07:19:28 +0000441
Chris Lattner97beb512007-05-14 06:56:09 +0000442</div>
443
Chris Lattner0a1fd102007-09-21 03:54:09 +0000444<!--=========================================================================-->
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000445<h3>
Chris Lattnerd1094e02009-03-02 02:37:32 +0000446<a name="coreimprovements">LLVM IR and Core Improvements</a>
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000447</h3>
Chris Lattnerdd6acc02008-02-10 08:17:19 +0000448
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +0000449<div>
Chris Lattneraa61f412009-10-13 17:48:04 +0000450<p>LLVM IR has several new features for better support of new targets and that
451expose new optimization opportunities:</p>
Chris Lattnerdd6acc02008-02-10 08:17:19 +0000452
Chris Lattnerb7112222008-06-05 06:25:56 +0000453<ul>
Chad Rosier06da55e2011-05-27 22:50:46 +0000454<!--
455<li></li>
456-->
Chris Lattnerdd6acc02008-02-10 08:17:19 +0000457</ul>
Mikhail Glushenkov024f7cf2008-10-13 02:08:34 +0000458
Chris Lattnerdd6acc02008-02-10 08:17:19 +0000459</div>
460
461<!--=========================================================================-->
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000462<h3>
Chris Lattner2b8a52e2008-02-10 07:46:44 +0000463<a name="optimizer">Optimizer Improvements</a>
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000464</h3>
Chris Lattner2b8a52e2008-02-10 07:46:44 +0000465
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +0000466<div>
Chris Lattner2b8a52e2008-02-10 07:46:44 +0000467
Chris Lattneraa61f412009-10-13 17:48:04 +0000468<p>In addition to a large array of minor performance tweaks and bug fixes, this
Chris Lattner25879d72008-10-13 21:50:36 +0000469release includes a few major enhancements and additions to the optimizers:</p>
Chris Lattner2b8a52e2008-02-10 07:46:44 +0000470
471<ul>
Chad Rosier06da55e2011-05-27 22:50:46 +0000472<!--
473<li></li>
474-->
Chris Lattner23e16b592011-04-06 05:50:04 +0000475</li>
Chris Lattnerc3a2c982011-04-06 00:45:11 +0000476
Chris Lattnerfcc65a72010-10-04 02:42:39 +0000477</ul>
478
Chris Lattneraa61f412009-10-13 17:48:04 +0000479</div>
Chris Lattnerd1094e02009-03-02 02:37:32 +0000480
Chris Lattner7795ea92008-06-08 02:45:07 +0000481<!--=========================================================================-->
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000482<h3>
Chris Lattnerf25bc192010-09-30 16:31:33 +0000483<a name="mc">MC Level Improvements</a>
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000484</h3>
Chris Lattnerf25bc192010-09-30 16:31:33 +0000485
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +0000486<div>
Chris Lattnerf25bc192010-09-30 16:31:33 +0000487<p>
Chris Lattnerbf1cf672010-10-02 21:59:30 +0000488The LLVM Machine Code (aka MC) subsystem was created to solve a number
Chris Lattnerf25bc192010-09-30 16:31:33 +0000489of problems in the realm of assembly, disassembly, object file format handling,
490and a number of other related areas that CPU instruction-set level tools work
Chris Lattnerbf1cf672010-10-02 21:59:30 +0000491in.</p>
492
Chris Lattnerbf1cf672010-10-02 21:59:30 +0000493<ul>
Chad Rosier06da55e2011-05-27 22:50:46 +0000494<!--
495<li></li>
496-->
Chris Lattnerbf1cf672010-10-02 21:59:30 +0000497</ul>
498
499<p>For more information, please see the <a
Chris Lattnerf25bc192010-09-30 16:31:33 +0000500href="http://blog.llvm.org/2010/04/intro-to-llvm-mc-project.html">Intro to the
501LLVM MC Project Blog Post</a>.
502</p>
503
NAKAMURA Takumi8d89b8e2011-04-05 08:24:22 +0000504</div>
Chris Lattnerf25bc192010-09-30 16:31:33 +0000505
Chris Lattnerf25bc192010-09-30 16:31:33 +0000506<!--=========================================================================-->
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000507<h3>
Chris Lattnerd434bfb2009-03-02 03:24:11 +0000508<a name="codegen">Target Independent Code Generator Improvements</a>
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000509</h3>
Chris Lattner7795ea92008-06-08 02:45:07 +0000510
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +0000511<div>
Chris Lattner7795ea92008-06-08 02:45:07 +0000512
Mikhail Glushenkov25422542009-03-01 18:09:47 +0000513<p>We have put a significant amount of work into the code generator
514infrastructure, which allows us to implement more aggressive algorithms and make
515it run faster:</p>
Chris Lattner7795ea92008-06-08 02:45:07 +0000516
517<ul>
Chad Rosier06da55e2011-05-27 22:50:46 +0000518<!--
519<li></li>
520-->
Chris Lattner0a1fd102007-09-21 03:54:09 +0000521</ul>
Chris Lattner0a1fd102007-09-21 03:54:09 +0000522</div>
523
Chris Lattnerd1094e02009-03-02 02:37:32 +0000524<!--=========================================================================-->
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000525<h3>
Chris Lattnerd1094e02009-03-02 02:37:32 +0000526<a name="x86">X86-32 and X86-64 Target Improvements</a>
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000527</h3>
Chris Lattnerd1094e02009-03-02 02:37:32 +0000528
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +0000529<div>
Chris Lattnerd3f45c82010-10-04 04:39:25 +0000530<p>New features and major changes in the X86 target include:
Chris Lattnerd1094e02009-03-02 02:37:32 +0000531</p>
532
533<ul>
Chad Rosierd1db4f82011-05-27 20:13:10 +0000534<li>The CRC32 intrinsics have been renamed. The intrinsics were previously
535 @llvm.x86.sse42.crc32.[8|16|32] and @llvm.x86.sse42.crc64.[8|64]. They have
536 been renamed to @llvm.x86.sse42.crc32.32.[8|16|32] and
537 @llvm.x86.sse42.crc32.64.[8|64].</li>
538
Chris Lattnerd1094e02009-03-02 02:37:32 +0000539</ul>
540
Chris Lattnerd1094e02009-03-02 02:37:32 +0000541</div>
Chris Lattner0a1fd102007-09-21 03:54:09 +0000542
543<!--=========================================================================-->
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000544<h3>
Chris Lattneraa61f412009-10-13 17:48:04 +0000545<a name="ARM">ARM Target Improvements</a>
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000546</h3>
Chris Lattnerc92d7692009-03-01 02:30:21 +0000547
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +0000548<div>
Chris Lattneraa61f412009-10-13 17:48:04 +0000549<p>New features of the ARM target include:
550</p>
Chris Lattnerc92d7692009-03-01 02:30:21 +0000551
552<ul>
Chad Rosier06da55e2011-05-27 22:50:46 +0000553<!--
554<li></li>
555-->
Bob Wilsone44f2982010-09-13 17:39:35 +0000556</ul>
Chris Lattneraa61f412009-10-13 17:48:04 +0000557</div>
Chris Lattnerc3a2c982011-04-06 00:45:11 +0000558
559<!--=========================================================================-->
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000560<h3>
Chris Lattnerc3a2c982011-04-06 00:45:11 +0000561<a name="OtherTS">Other Target Specific Improvements</a>
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000562</h3>
Chris Lattnerc92d7692009-03-01 02:30:21 +0000563
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +0000564<div>
Chris Lattnerc3a2c982011-04-06 00:45:11 +0000565<ul>
Chad Rosier06da55e2011-05-27 22:50:46 +0000566<!--
567<li></li>
568-->
Chris Lattnerc3a2c982011-04-06 00:45:11 +0000569</ul>
570</div>
Chris Lattner6cb64032008-06-05 08:02:49 +0000571
572<!--=========================================================================-->
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000573<h3>
Chris Lattner1e4d5bc2008-10-13 17:57:36 +0000574<a name="changes">Major Changes and Removed Features</a>
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000575</h3>
Chris Lattner1e4d5bc2008-10-13 17:57:36 +0000576
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +0000577<div>
Chris Lattner1e4d5bc2008-10-13 17:57:36 +0000578
Chris Lattner934e2d42008-10-13 22:06:31 +0000579<p>If you're already an LLVM user or developer with out-of-tree changes based
Chad Rosier06da55e2011-05-27 22:50:46 +0000580on LLVM 2.9, this section lists some "gotchas" that you may run into upgrading
Chris Lattner934e2d42008-10-13 22:06:31 +0000581from the previous release.</p>
Chris Lattner1e4d5bc2008-10-13 17:57:36 +0000582
583<ul>
Chad Rosier06da55e2011-05-27 22:50:46 +0000584<!--
585<li></li>
586-->
Devang Pateldbf83832008-10-14 20:03:43 +0000587</ul>
Chris Lattner1e4d5bc2008-10-13 17:57:36 +0000588
Chris Lattner1e4d5bc2008-10-13 17:57:36 +0000589</div>
590
Daniel Dunbarf70898a2010-10-04 20:11:41 +0000591<!--=========================================================================-->
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000592<h3>
Chris Lattnerc3a2c982011-04-06 00:45:11 +0000593<a name="api_changes">Internal API Changes</a>
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000594</h3>
Daniel Dunbarf70898a2010-10-04 20:11:41 +0000595
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +0000596<div>
Daniel Dunbarf70898a2010-10-04 20:11:41 +0000597
Chris Lattnerc3a2c982011-04-06 00:45:11 +0000598<p>In addition, many APIs have changed in this release. Some of the major
Bill Wendling46ffaa92011-08-02 06:20:17 +0000599 LLVM API changes are:</p>
Daniel Dunbarf70898a2010-10-04 20:11:41 +0000600
601<ul>
Chris Lattner14b3b4d2011-07-18 04:56:02 +0000602<li>The biggest and most pervasive change is that llvm::Type's are no longer
603 returned or accepted as 'const' values. Instead, just pass around non-const
604 Type's.</li>
605
Jay Foade03f15a2011-07-14 09:19:05 +0000606<li><code>PHINode::reserveOperandSpace</code> has been removed. Instead, you
607 must specify how many operands to reserve space for when you create the
608 PHINode, by passing an extra argument into <code>PHINode::Create</code>.</li>
609
610<li>PHINodes no longer store their incoming BasicBlocks as operands. Instead,
611 the list of incoming BasicBlocks is stored separately, and can be accessed
612 with new functions <code>PHINode::block_begin</code>
613 and <code>PHINode::block_end</code>.</li>
614
615<li>Various functions now take an <code>ArrayRef</code> instead of either a pair
616 of pointers (or iterators) to the beginning and end of a range, or a pointer
617 and a length. Others now return an <code>ArrayRef</code> instead of a
618 reference to a <code>SmallVector</code> or <code>std::vector</code>. These
619 include:
620<ul>
621<!-- Please keep this list sorted. -->
Jay Foad5bd375a2011-07-15 08:37:34 +0000622<li><code>CallInst::Create</code></li>
Jay Foade03f15a2011-07-14 09:19:05 +0000623<li><code>ComputeLinearIndex</code> (in <code>llvm/CodeGen/Analysis.h</code>)</li>
624<li><code>ConstantArray::get</code></li>
625<li><code>ConstantExpr::getExtractElement</code></li>
Jay Foaded8db7d2011-07-21 14:31:17 +0000626<li><code>ConstantExpr::getGetElementPtr</code></li>
627<li><code>ConstantExpr::getInBoundsGetElementPtr</code></li>
Jay Foade03f15a2011-07-14 09:19:05 +0000628<li><code>ConstantExpr::getIndices</code></li>
629<li><code>ConstantExpr::getInsertElement</code></li>
630<li><code>ConstantExpr::getWithOperands</code></li>
Jay Foadf4b14a22011-07-19 13:32:40 +0000631<li><code>ConstantFoldCall</code> (in <code>llvm/Analysis/ConstantFolding.h</code>)</li>
632<li><code>ConstantFoldInstOperands</code> (in <code>llvm/Analysis/ConstantFolding.h</code>)</li>
Jay Foade03f15a2011-07-14 09:19:05 +0000633<li><code>ConstantVector::get</code></li>
634<li><code>DIBuilder::createComplexVariable</code></li>
635<li><code>DIBuilder::getOrCreateArray</code></li>
636<li><code>ExtractValueInst::Create</code></li>
637<li><code>ExtractValueInst::getIndexedType</code></li>
638<li><code>ExtractValueInst::getIndices</code></li>
639<li><code>FindInsertedValue</code> (in <code>llvm/Analysis/ValueTracking.h</code>)</li>
Jay Foad528beda2011-07-19 14:42:50 +0000640<li><code>gep_type_begin</code> (in <code>llvm/Support/GetElementPtrTypeIterator.h</code>)</li>
641<li><code>gep_type_end</code> (in <code>llvm/Support/GetElementPtrTypeIterator.h</code>)</li>
Jay Foadd1b78492011-07-25 09:48:08 +0000642<li><code>GetElementPtrInst::Create</code></li>
643<li><code>GetElementPtrInst::CreateInBounds</code></li>
644<li><code>GetElementPtrInst::getIndexedType</code></li>
Jay Foad857a48a2011-07-21 14:42:51 +0000645<li><code>InsertValueInst::Create</code></li>
646<li><code>InsertValueInst::getIndices</code></li>
647<li><code>InvokeInst::Create</code></li>
Jay Foad5bd375a2011-07-15 08:37:34 +0000648<li><code>IRBuilder::CreateCall</code></li>
Jay Foade03f15a2011-07-14 09:19:05 +0000649<li><code>IRBuilder::CreateExtractValue</code></li>
Jay Foad040dd822011-07-22 08:16:57 +0000650<li><code>IRBuilder::CreateGEP</code></li>
651<li><code>IRBuilder::CreateInBoundsGEP</code></li>
Jay Foade03f15a2011-07-14 09:19:05 +0000652<li><code>IRBuilder::CreateInsertValue</code></li>
Jay Foad5bd375a2011-07-15 08:37:34 +0000653<li><code>IRBuilder::CreateInvoke</code></li>
Jay Foade03f15a2011-07-14 09:19:05 +0000654<li><code>MDNode::get</code></li>
655<li><code>MDNode::getIfExists</code></li>
656<li><code>MDNode::getTemporary</code></li>
657<li><code>MDNode::getWhenValsUnresolved</code></li>
Jay Foadb992a632011-07-19 15:07:52 +0000658<li><code>SimplifyGEPInst</code> (in <code>llvm/Analysis/InstructionSimplify.h</code>)</li>
Jay Foadbf904772011-07-19 14:01:37 +0000659<li><code>TargetData::getIndexedOffset</code></li>
Jay Foade03f15a2011-07-14 09:19:05 +0000660</ul></li>
661
662<li>All forms of <code>StringMap::getOrCreateValue</code> have been remove
663 except for the one which takes a <code>StringRef</code>.</li>
664
Bill Wendling46ffaa92011-08-02 06:20:17 +0000665<li>The <code>LLVMBuildUnwind</code> function from the C API was removed. The
666 LLVM <code>unwind</code> instruction has been deprecated for a long time and
667 isn't used by the current front-ends. So this was removed along with the
668 exception handling rewrite.</li>
669
Daniel Dunbarf70898a2010-10-04 20:11:41 +0000670</ul>
671</div>
Chris Lattner1e4d5bc2008-10-13 17:57:36 +0000672
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +0000673</div>
674
Chris Lattner3d482502003-10-02 04:57:28 +0000675<!-- *********************************************************************** -->
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000676<h2>
Misha Brukman80731b92003-11-22 00:38:41 +0000677 <a name="knownproblems">Known Problems</a>
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000678</h2>
Chris Lattner3d482502003-10-02 04:57:28 +0000679<!-- *********************************************************************** -->
680
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +0000681<div>
Misha Brukman80731b92003-11-22 00:38:41 +0000682
Mikhail Glushenkov25422542009-03-01 18:09:47 +0000683<p>This section contains significant known problems with the LLVM system,
Chris Lattner2a092392008-11-10 05:40:34 +0000684listed by component. If you run into a problem, please check the <a
Chris Lattnera69595e2005-10-29 07:07:09 +0000685href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
Chris Lattnerb84f3322003-12-12 21:22:16 +0000686there isn't already one.</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000687
Chris Lattnerb911de42004-03-14 02:03:02 +0000688<!-- ======================================================================= -->
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000689<h3>
Chris Lattnerb911de42004-03-14 02:03:02 +0000690 <a name="experimental">Experimental features included with this release</a>
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000691</h3>
Chris Lattner3d482502003-10-02 04:57:28 +0000692
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +0000693<div>
Chris Lattnerb911de42004-03-14 02:03:02 +0000694
Misha Brukmanfa50a222004-05-12 21:46:05 +0000695<p>The following components of this LLVM release are either untested, known to
696be broken or unreliable, or are in early development. These components should
697not be relied on, and bugs should not be filed against them, but they may be
698useful to some people. In particular, if you would like to work on one of these
Chris Lattnere38ac152008-02-12 06:29:45 +0000699components, please contact us on the <a
700href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p>
Chris Lattnerb911de42004-03-14 02:03:02 +0000701
702<ul>
Chris Lattner0d364302011-03-10 07:43:44 +0000703<li>The Alpha, Blackfin, CellSPU, MicroBlaze, MSP430, MIPS, PTX, SystemZ
Chris Lattnera7f45cf2010-10-04 01:29:06 +0000704 and XCore backends are experimental.</li>
Chris Lattnerbf1cf672010-10-02 21:59:30 +0000705<li><tt>llc</tt> "<tt>-filetype=obj</tt>" is experimental on all targets
Chris Lattner17c170a2011-04-06 06:29:50 +0000706 other than darwin and ELF X86 systems.</li>
Chris Lattner0d364302011-03-10 07:43:44 +0000707
Chris Lattnerb911de42004-03-14 02:03:02 +0000708</ul>
709
710</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000711
Misha Brukman80731b92003-11-22 00:38:41 +0000712<!-- ======================================================================= -->
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000713<h3>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000714 <a name="x86-be">Known problems with the X86 back-end</a>
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000715</h3>
John Criswell3bdbd302005-11-08 21:11:33 +0000716
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +0000717<div>
John Criswell3bdbd302005-11-08 21:11:33 +0000718
719<ul>
Anton Korobeynikov486c7d32008-06-08 10:24:13 +0000720 <li>The X86 backend does not yet support
721 all <a href="http://llvm.org/PR879">inline assembly that uses the X86
722 floating point stack</a>. It supports the 'f' and 't' constraints, but not
723 'u'.</li>
Dan Gohman721b3722008-06-08 23:05:11 +0000724 <li>The X86-64 backend does not yet support the LLVM IR instruction
Chris Lattnera67df2d2010-04-22 06:28:20 +0000725 <tt>va_arg</tt>. Currently, front-ends support variadic
Dan Gohman721b3722008-06-08 23:05:11 +0000726 argument constructs on X86-64 by lowering them manually.</li>
NAKAMURA Takumi8d89b8e2011-04-05 08:24:22 +0000727 <li>Windows x64 (aka Win64) code generator has a few issues.
728 <ul>
729 <li>llvm-gcc cannot build the mingw-w64 runtime currently
730 due to lack of support for the 'u' inline assembly
731 constraint and for X87 floating point inline assembly.</li>
732 <li>On mingw-w64, you will see unresolved symbol <tt>__chkstk</tt>
733 due to <a href="http://llvm.org/bugs/show_bug.cgi?id=8919">Bug 8919</a>.
734 It is fixed in <a href="http://lists.cs.uiuc.edu/pipermail/llvm-commits/Week-of-Mon-20110321/118499.html">r128206</a>.</li>
735 <li>Miss-aligned MOVDQA might crash your program. It is due to
736 <a href="http://llvm.org/bugs/show_bug.cgi?id=9483">Bug 9483</a>,
737 lack of handling aligned internal globals.</li>
738 </ul>
739 </li>
740
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000741</ul>
742
743</div>
744
745<!-- ======================================================================= -->
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000746<h3>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000747 <a name="ppc-be">Known problems with the PowerPC back-end</a>
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000748</h3>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000749
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +0000750<div>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000751
752<ul>
Nicolas Geoffray77d99502007-05-15 09:21:28 +0000753<li>The Linux PPC32/ABI support needs testing for the interpreter and static
Chris Lattnerbee7b322007-05-23 04:39:32 +0000754compilation, and lacks support for debug information.</li>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000755</ul>
756
757</div>
758
759<!-- ======================================================================= -->
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000760<h3>
Chris Lattner97beb512007-05-14 06:56:09 +0000761 <a name="arm-be">Known problems with the ARM back-end</a>
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000762</h3>
Chris Lattner97beb512007-05-14 06:56:09 +0000763
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +0000764<div>
Chris Lattner97beb512007-05-14 06:56:09 +0000765
766<ul>
Chris Lattnerbee7b322007-05-23 04:39:32 +0000767<li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
Duncan Sands47fc0a22007-09-26 15:59:54 +0000768processors, thumb programs can crash or produce wrong
Chris Lattnerbee7b322007-05-23 04:39:32 +0000769results (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
John Criswellea03c9d2009-03-02 15:28:15 +0000770<li>Compilation for ARM Linux OABI (old ABI) is supported but not fully tested.
Chris Lattner97beb512007-05-14 06:56:09 +0000771</li>
Chris Lattner97beb512007-05-14 06:56:09 +0000772</ul>
773
774</div>
775
776<!-- ======================================================================= -->
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000777<h3>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000778 <a name="sparc-be">Known problems with the SPARC back-end</a>
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000779</h3>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000780
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +0000781<div>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000782
783<ul>
John Criswellea03c9d2009-03-02 15:28:15 +0000784<li>The SPARC backend only supports the 32-bit SPARC ABI (-m32); it does not
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000785 support the 64-bit SPARC ABI (-m64).</li>
786</ul>
787
788</div>
789
790<!-- ======================================================================= -->
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000791<h3>
Bruno Cardoso Lopes24eb3de2008-10-25 14:56:26 +0000792 <a name="mips-be">Known problems with the MIPS back-end</a>
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000793</h3>
Bruno Cardoso Lopes24eb3de2008-10-25 14:56:26 +0000794
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +0000795<div>
Bruno Cardoso Lopes24eb3de2008-10-25 14:56:26 +0000796
797<ul>
Bruno Cardoso Lopes24eb3de2008-10-25 14:56:26 +0000798<li>64-bit MIPS targets are not supported yet.</li>
799</ul>
800
801</div>
802
803<!-- ======================================================================= -->
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000804<h3>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000805 <a name="alpha-be">Known problems with the Alpha back-end</a>
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000806</h3>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000807
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +0000808<div>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000809
810<ul>
811
812<li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
813appropriate nops inserted to ensure restartability.</li>
814
John Criswell3bdbd302005-11-08 21:11:33 +0000815</ul>
816</div>
817
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000818<!-- ======================================================================= -->
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000819<h3>
Chris Lattner97beb512007-05-14 06:56:09 +0000820 <a name="c-be">Known problems with the C back-end</a>
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000821</h3>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000822
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +0000823<div>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000824
Chris Lattner086d2692010-09-29 05:34:42 +0000825<p>The C backend has numerous problems and is not being actively maintained.
826Depending on it for anything serious is not advised.</p>
827
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000828<ul>
Chris Lattnera1a4c9a2008-06-05 06:35:40 +0000829<li><a href="http://llvm.org/PR802">The C backend has only basic support for
830 inline assembly code</a>.</li>
Chris Lattner8e061162007-09-26 06:01:35 +0000831<li><a href="http://llvm.org/PR1658">The C backend violates the ABI of common
832 C++ programs</a>, preventing intermixing between C++ compiled by the CBE and
Gabor Greif75b2f762009-03-02 12:02:51 +0000833 C++ code compiled with <tt>llc</tt> or native compilers.</li>
Duncan Sandse09506a2008-02-10 13:40:55 +0000834<li>The C backend does not support all exception handling constructs.</li>
Duncan Sands3aa36732009-02-25 11:51:54 +0000835<li>The C backend does not support arbitrary precision integers.</li>
Chris Lattnerb81f10e2006-11-18 07:51:14 +0000836</ul>
837
838</div>
John Criswell3bdbd302005-11-08 21:11:33 +0000839
Misha Brukman80731b92003-11-22 00:38:41 +0000840
841<!-- ======================================================================= -->
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000842<h3>
Chris Lattner086d2692010-09-29 05:34:42 +0000843 <a name="llvm-gcc">Known problems with the llvm-gcc front-end</a>
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000844</h3>
Chris Lattner178f3db2003-10-02 05:07:23 +0000845
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +0000846<div>
Chris Lattner72a269f2006-03-03 00:34:26 +0000847
Chad Rosier06da55e2011-05-27 22:50:46 +0000848<p><b>LLVM 3.0 will be the last release of llvm-gcc.</b></p>
Chris Lattner17c170a2011-04-06 06:29:50 +0000849
Chris Lattner086d2692010-09-29 05:34:42 +0000850<p>llvm-gcc is generally very stable for the C family of languages. The only
851 major language feature of GCC not supported by llvm-gcc is the
852 <tt>__builtin_apply</tt> family of builtins. However, some extensions
853 are only supported on some targets. For example, trampolines are only
854 supported on some targets (these are used when you take the address of a
855 nested function).</p>
Misha Brukman80731b92003-11-22 00:38:41 +0000856
Chris Lattner086d2692010-09-29 05:34:42 +0000857<p>Fortran support generally works, but there are still several unresolved bugs
858 in <a href="http://llvm.org/bugs/">Bugzilla</a>. Please see the
859 tools/gfortran component for details. Note that llvm-gcc is missing major
860 Fortran performance work in the frontend and library that went into GCC after
861 4.2. If you are interested in Fortran, we recommend that you consider using
862 <a href="#dragonegg">dragonegg</a> instead.</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000863
Duncan Sandsd63e1c82010-10-04 10:06:56 +0000864<p>The llvm-gcc 4.2 Ada compiler has basic functionality, but is no longer being
865actively maintained. If you are interested in Ada, we recommend that you
866consider using <a href="#dragonegg">dragonegg</a> instead.</p>
Chris Lattnere38ac152008-02-12 06:29:45 +0000867</div>
868
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +0000869</div>
870
Chris Lattner3d482502003-10-02 04:57:28 +0000871<!-- *********************************************************************** -->
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000872<h2>
Misha Brukman80731b92003-11-22 00:38:41 +0000873 <a name="additionalinfo">Additional Information</a>
NAKAMURA Takumi64835132011-04-18 01:17:51 +0000874</h2>
Chris Lattner3d482502003-10-02 04:57:28 +0000875<!-- *********************************************************************** -->
876
NAKAMURA Takumi3ad28282011-04-21 01:52:00 +0000877<div>
Misha Brukman80731b92003-11-22 00:38:41 +0000878
Chris Lattnercb5596d2005-05-16 17:13:10 +0000879<p>A wide variety of additional information is available on the <a
NAKAMURA Takumica46f5a2011-04-09 02:13:37 +0000880href="http://llvm.org/">LLVM web page</a>, in particular in the <a
Chris Lattnere0c1df42007-05-18 00:44:29 +0000881href="http://llvm.org/docs/">documentation</a> section. The web page also
Reid Spencerc7f87f22007-07-09 08:04:31 +0000882contains versions of the API documentation which is up-to-date with the
883Subversion version of the source code.
Misha Brukman96158092005-03-30 19:14:24 +0000884You can access versions of these documents specific to this release by going
885into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000886
Misha Brukman80731b92003-11-22 00:38:41 +0000887<p>If you have any questions or comments about LLVM, please feel free to contact
Chris Lattnera69595e2005-10-29 07:07:09 +0000888us via the <a href="http://llvm.org/docs/#maillist"> mailing
Chris Lattnerb84f3322003-12-12 21:22:16 +0000889lists</a>.</p>
Chris Lattner3d482502003-10-02 04:57:28 +0000890
Misha Brukman80731b92003-11-22 00:38:41 +0000891</div>
Chris Lattner3d482502003-10-02 04:57:28 +0000892
893<!-- *********************************************************************** -->
Chris Lattner3d482502003-10-02 04:57:28 +0000894
Misha Brukman80731b92003-11-22 00:38:41 +0000895<hr>
Misha Brukman68aab3b2003-11-22 01:23:39 +0000896<address>
Misha Brukman8834af92003-12-21 22:53:21 +0000897 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman86242e12008-12-11 17:34:48 +0000898 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
Misha Brukman68aab3b2003-11-22 01:23:39 +0000899 <a href="http://validator.w3.org/check/referer"><img
Misha Brukman86242e12008-12-11 17:34:48 +0000900 src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
Misha Brukman68aab3b2003-11-22 01:23:39 +0000901
Chris Lattnere0c1df42007-05-18 00:44:29 +0000902 <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
Misha Brukman80731b92003-11-22 00:38:41 +0000903 Last modified: $Date$
Misha Brukman68aab3b2003-11-22 01:23:39 +0000904</address>
Chris Lattner3d482502003-10-02 04:57:28 +0000905
Misha Brukman80731b92003-11-22 00:38:41 +0000906</body>
907</html>