blob: 94b9254e85237b111eeed2f5d8e466fecfd8414a [file] [log] [blame]
Duncan Sandse2e4a892009-06-24 08:38:48 +00001<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
3<html>
4<head>
5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
6 <link rel="stylesheet" href="llvm.css" type="text/css">
7 <title>LLVM 2.6 Release Notes</title>
8</head>
9<body>
10
11<div class="doc_title">LLVM 2.6 Release Notes</div>
12
13<ol>
14 <li><a href="#intro">Introduction</a></li>
15 <li><a href="#subproj">Sub-project Status Update</a></li>
16 <li><a href="#externalproj">External Projects Using LLVM 2.6</a></li>
17 <li><a href="#whatsnew">What's New in LLVM 2.6?</a></li>
18 <li><a href="GettingStarted.html">Installation Instructions</a></li>
19 <li><a href="#portability">Portability and Supported Platforms</a></li>
20 <li><a href="#knownproblems">Known Problems</a></li>
21 <li><a href="#additionalinfo">Additional Information</a></li>
22</ol>
23
24<div class="doc_author">
25 <p>Written by the <a href="http://llvm.org">LLVM Team</a></p>
26</div>
27
28<!-- *********************************************************************** -->
29<div class="doc_section">
30 <a name="intro">Introduction</a>
31</div>
32<!-- *********************************************************************** -->
33
34<div class="doc_text">
35
36<p>This document contains the release notes for the LLVM Compiler
37Infrastructure, release 2.6. Here we describe the status of LLVM, including
38major improvements from the previous release and significant known problems.
39All LLVM releases may be downloaded from the <a
40href="http://llvm.org/releases/">LLVM releases web site</a>.</p>
41
42<p>For more information about LLVM, including information about the latest
43release, please check out the <a href="http://llvm.org/">main LLVM
44web site</a>. If you have questions or comments, the <a
45href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM Developer's Mailing
46List</a> is a good place to send them.</p>
47
48<p>Note that if you are reading this file from a Subversion checkout or the
49main LLVM web page, this document applies to the <i>next</i> release, not the
50current one. To see the release notes for a specific release, please see the
51<a href="http://llvm.org/releases/">releases page</a>.</p>
52
53</div>
Chris Lattner80ed2552009-10-08 07:01:46 +000054
Chris Lattnerc758fec2009-10-05 02:12:39 +000055
Chris Lattner7b0a6812009-10-08 06:27:53 +000056<!--
57Almost dead code.
Chris Lattner80ed2552009-10-08 07:01:46 +000058 include/llvm/Analysis/LiveValues.h => Dan
59 lib/Transforms/IPO/MergeFunctions.cpp => consider for 2.8.
60 llvm/Analysis/PointerTracking.h => Edwin wants this, consider for 2.8.
Chris Lattner7b0a6812009-10-08 06:27:53 +000061-->
Chris Lattnerc758fec2009-10-05 02:12:39 +000062
Chris Lattnerc758fec2009-10-05 02:12:39 +000063
64<!-- Unfinished features in 2.6:
Chris Lattner80ed2552009-10-08 07:01:46 +000065 gcc plugin.
Chris Lattnerc758fec2009-10-05 02:12:39 +000066 strong phi elim
67 variable debug info for optimized code
Duncan Sandse2e4a892009-06-24 08:38:48 +000068 postalloc scheduler: anti dependence breaking, hazard recognizer?
Chris Lattnerc758fec2009-10-05 02:12:39 +000069 metadata
70 loop dependence analysis
Chris Lattner80ed2552009-10-08 07:01:46 +000071 ELF Writer? How stable?
72 <li>PostRA scheduler improvements, ARM adoption (David Goodwin).</li>
73
Duncan Sandse2e4a892009-06-24 08:38:48 +000074 -->
75
76 <!-- for announcement email:
Chris Lattnerc758fec2009-10-05 02:12:39 +000077 Logo web page.
78 llvm devmtg
79 compiler_rt
Chris Lattner7b0a6812009-10-08 06:27:53 +000080 klee web page at klee.llvm.org
81 Many new papers added to /pubs/
82 Mention gcc plugin.
83
Duncan Sandse2e4a892009-06-24 08:38:48 +000084 -->
85
86<!-- *********************************************************************** -->
87<div class="doc_section">
88 <a name="subproj">Sub-project Status Update</a>
89</div>
90<!-- *********************************************************************** -->
91
92<div class="doc_text">
93<p>
94The LLVM 2.6 distribution currently consists of code from the core LLVM
95repository &mdash;which roughly includes the LLVM optimizers, code generators
96and supporting tools &mdash; and the llvm-gcc repository. In addition to this
97code, the LLVM Project includes other sub-projects that are in development. The
98two which are the most actively developed are the <a href="#clang">Clang
99Project</a> and the <a href="#vmkit">VMKit Project</a>.
100</p>
101
102</div>
103
104
105<!--=========================================================================-->
106<div class="doc_subsection">
107<a name="clang">Clang: C/C++/Objective-C Frontend Toolkit</a>
108</div>
109
110<div class="doc_text">
111
Chris Lattner80ed2552009-10-08 07:01:46 +0000112<p><b>UPDATE!</b> The <a href="http://clang.llvm.org/">Clang project</a> is an effort to build
Duncan Sandse2e4a892009-06-24 08:38:48 +0000113a set of new 'LLVM native' front-end technologies for the LLVM optimizer and
114code generator. While Clang is not included in the LLVM 2.6 release, it is
115continuing to make major strides forward in all areas. Its C and Objective-C
116parsing and code generation support is now very solid. For example, it is
117capable of successfully building many real-world applications for X86-32
118and X86-64,
119including the <a href="http://wiki.freebsd.org/BuildingFreeBSDWithClang">FreeBSD
120kernel</a> and <a href="http://gcc.gnu.org/gcc-4.2/">gcc 4.2</a>. C++ is also
121making <a href="http://clang.llvm.org/cxx_status.html">incredible progress</a>,
122and work on templates has recently started. If you are
123interested in fast compiles and good diagnostics, we encourage you to try it out
124by <a href="http://clang.llvm.org/get_started.html">building from mainline</a>
125and reporting any issues you hit to the <a
126href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-dev">Clang front-end mailing
127list</a>.</p>
128
129<p>In the LLVM 2.6 time-frame, the Clang team has made many improvements:</p>
130
131<ul>
132<li>Something wonderful!</li>
Chris Lattnerc32a5322009-09-30 06:27:22 +0000133<li>AuroraUX / FreeBSD &amp; OpenBSD Toolchain support.</li>
Duncan Sandse2e4a892009-06-24 08:38:48 +0000134<li>Many many bugs are fixed and many features have been added.</li>
135</ul>
136</div>
137
138<!--=========================================================================-->
139<div class="doc_subsection">
140<a name="clangsa">Clang Static Analyzer</a>
141</div>
142
143<div class="doc_text">
144
Chris Lattner80ed2552009-10-08 07:01:46 +0000145<p><b>UPDATE!</b> Previously announced in the 2.4 and 2.5 LLVM releases, the Clang project also
Duncan Sandse2e4a892009-06-24 08:38:48 +0000146includes an early stage static source code analysis tool for <a
147href="http://clang.llvm.org/StaticAnalysis.html">automatically finding bugs</a>
148in C and Objective-C programs. The tool performs a growing set of checks to find
149bugs that occur on a specific path within a program.</p>
150
151<p>In the LLVM 2.6 time-frame there have been many significant improvements to
152XYZ.</p>
153
154<p>The set of checks performed by the static analyzer continues to expand, and
155future plans for the tool include full source-level inter-procedural analysis
156and deeper checks such as buffer overrun detection. There are many opportunities
157to extend and enhance the static analyzer, and anyone interested in working on
158this project is encouraged to get involved!</p>
159
160</div>
161
162<!--=========================================================================-->
163<div class="doc_subsection">
164<a name="vmkit">VMKit: JVM/CLI Virtual Machine Implementation</a>
165</div>
166
167<div class="doc_text">
168<p>
Chris Lattner80ed2552009-10-08 07:01:46 +0000169<b>UPDATE!</b>
Duncan Sandse2e4a892009-06-24 08:38:48 +0000170The <a href="http://vmkit.llvm.org/">VMKit project</a> is an implementation of
171a JVM and a CLI Virtual Machines (Microsoft .NET is an
172implementation of the CLI) using the Just-In-Time compiler of LLVM.</p>
173
174<p>Following LLVM 2.6, VMKit has its XYZ release that you can find on its
175<a href="http://vmkit.llvm.org/releases/">webpage</a>. The release includes
176bug fixes, cleanup and new features. The major changes are:</p>
177
178<ul>
179
180<li>Something wonderful!</li>
181
182</ul>
183</div>
184
Chris Lattner80ed2552009-10-08 07:01:46 +0000185<!--=========================================================================-->
186<div class="doc_subsection">
187<a name="mc">llvm-mc: Machine Code Toolkit</a>
188</div>
189
190<div class="doc_text">
191<p>
192<b>UPDATE!</b>
193blah
194
195 MC:
196 MCSection, MCAsmInfo
197 MCInstPrinter did it make it in?
198 MCInst (X86 using it so far)
199 Rewrite of X86 GV selection logic: TargetOperand flags on ExternalSymbol, GV, etc operands.
200 Can parse and re-print out an darwin-x86 .s file.
201 TargetLoweringObjectFile, MCSectionKind
202 Verrrry early start of a macho writer.
203</p>
204
205</div>
206
207
Duncan Sandse2e4a892009-06-24 08:38:48 +0000208<!-- *********************************************************************** -->
209<div class="doc_section">
210 <a name="externalproj">External Projects Using LLVM 2.6</a>
211</div>
212<!-- *********************************************************************** -->
213
Chris Lattner80ed2552009-10-08 07:01:46 +0000214<!--=========================================================================-->
215<div class="doc_subsection">
216<a name="Rubinius">Rubinius</a>
217</div>
218
219<div class="doc_text">
220<p><a href="http://github.com/evanphx/rubinius">Rubinius</a> is an environment
221for running Ruby code which strives to write as much of the core class
222implementation in Ruby as possible. Combined with a bytecode interpreting VM, it
223uses LLVM to optimize and compile ruby code down to machine code. Techniques
224such as type feedback, method inlining, and uncommon traps are all used to
225remove dynamism from ruby execution and increase performance.</p>
Chris Lattnerd4a537b2009-10-08 16:01:33 +0000226
227<p>Since LLVM 2.5, Rubinius has made several major leaps forward, implementing
228a counter based JIT, type feedback, and speculative method inlining.
229</p>
230
Chris Lattner80ed2552009-10-08 07:01:46 +0000231</div>
Chris Lattnerc32a5322009-09-30 06:27:22 +0000232
233<!--=========================================================================-->
234<div class="doc_subsection">
235<a name="macruby">MacRuby</a>
236</div>
237
238<div class="doc_text">
239
240<p>
241<a href="http://macruby.org">MacRuby</a> is an implementation of Ruby on top of
242core Mac OS X technologies, such as the Objective-C common runtime and garbage
243collector, and the CoreFoundation framework. It is principally developed by
244Apple and aims at enabling the creation of full-fledged Mac OS X applications.
245</p>
246
247<p>
248MacRuby uses LLVM for optimization passes, JIT and AOT compilation of Ruby
249expressions. It also uses zero-cost DWARF exceptions to implement Ruby exception
250handling.</p>
251
252</div>
253
254
Duncan Sandse2e4a892009-06-24 08:38:48 +0000255<!--=========================================================================-->
256<div class="doc_subsection">
257<a name="pure">Pure</a>
258</div>
259
260<div class="doc_text">
261<p>
262<a href="http://pure-lang.googlecode.com/">Pure</a>
263is an algebraic/functional programming language based on term rewriting.
264Programs are collections of equations which are used to evaluate expressions in
265a symbolic fashion. Pure offers dynamic typing, eager and lazy evaluation,
266lexical closures, a hygienic macro system (also based on term rewriting),
267built-in list and matrix support (including list and matrix comprehensions) and
268an easy-to-use C interface. The interpreter uses LLVM as a backend to
269 JIT-compile Pure programs to fast native code.</p>
270
Chris Lattnerd4a537b2009-10-08 16:01:33 +0000271<p>Pure versions 0.31 and later have been tested and are known to work with
272LLVM 2.6 (and continue to work with older LLVM releases >= 2.3 as well).
Duncan Sandse2e4a892009-06-24 08:38:48 +0000273</p>
274</div>
275
276
277<!--=========================================================================-->
278<div class="doc_subsection">
279<a name="ldc">LLVM D Compiler</a>
280</div>
281
282<div class="doc_text">
283<p>
Chris Lattner80ed2552009-10-08 07:01:46 +0000284<b>UPDATE!</b>
Duncan Sandse2e4a892009-06-24 08:38:48 +0000285<a href="http://www.dsource.org/projects/ldc">LDC</a> is an implementation of
286the D Programming Language using the LLVM optimizer and code generator.
287The LDC project works great with the LLVM 2.6 release. General improvements in
288this
289cycle have included new inline asm constraint handling, better debug info
290support, general bugfixes, and better x86-64 support. This has allowed
291some major improvements in LDC, getting us much closer to being as
292fully featured as the original DMD compiler from DigitalMars.
293</p>
294</div>
295
296<!--=========================================================================-->
297<div class="doc_subsection">
298<a name="RoadsendPHP">Roadsend PHP</a>
299</div>
300
301<div class="doc_text">
Chris Lattner80ed2552009-10-08 07:01:46 +0000302<p>
Chris Lattner80ed2552009-10-08 07:01:46 +0000303<a href="http://code.roadsend.com/rphp">Roadsend PHP</a> (rphp) is an open
Duncan Sandse2e4a892009-06-24 08:38:48 +0000304source implementation of the PHP programming
305language that uses LLVM for its optimizer, JIT, and static compiler. This is a
306reimplementation of an earlier project that is now based on LLVM.</p>
307</div>
308
Jeffrey Yasskinba2aa782009-06-24 21:09:13 +0000309<!--=========================================================================-->
310<div class="doc_subsection">
311<a name="Unladen Swallow">Unladen Swallow</a>
312</div>
313
314<div class="doc_text">
Chris Lattner80ed2552009-10-08 07:01:46 +0000315<p>
316<b>UPDATE!</b>
317<a href="http://code.google.com/p/unladen-swallow/">Unladen Swallow</a> is a
Jeffrey Yasskinba2aa782009-06-24 21:09:13 +0000318branch of <a href="http://python.org/">Python</a> intended to be fully
319compatible and significantly faster. It uses LLVM's optimization passes and JIT
320compiler.</p>
321</div>
322
Jeffrey Yasskin5e98cb72009-06-24 21:26:42 +0000323
Duncan Sandse2e4a892009-06-24 08:38:48 +0000324
325<!-- *********************************************************************** -->
326<div class="doc_section">
327 <a name="whatsnew">What's New in LLVM 2.6?</a>
328</div>
329<!-- *********************************************************************** -->
330
331<div class="doc_text">
332
333<p>This release includes a huge number of bug fixes, performance tweaks, and
334minor improvements. Some of the major improvements and new features are listed
335in this section.
336</p>
Chris Lattner7b0a6812009-10-08 06:27:53 +0000337
Duncan Sandse2e4a892009-06-24 08:38:48 +0000338</div>
339
340<!--=========================================================================-->
341<div class="doc_subsection">
342<a name="majorfeatures">Major New Features</a>
343</div>
344
345<div class="doc_text">
346
347<p>LLVM 2.6 includes several major new capabilities:</p>
348
349<ul>
Chris Lattner7b0a6812009-10-08 06:27:53 +0000350<li>Support for debug line numbers when optimization enabled</li>
351<li>gold lto plugin</li>
352<li>New MSP430 and SystemZ backends.</li>
353<li>New BlackFin backend.</li>
354<li>LLVMContext, llvm_start_multithreaded: ProgrammersManual.html#threading</li>
Chris Lattner7b0a6812009-10-08 06:27:53 +0000355<li>klee web page at klee.llvm.org</li>
356<li>FileCheck</li>
357<li>New compiler-rt project.</li>
Edward O'Callaghan50310f92009-08-22 02:17:22 +0000358<li>LLVM 2.6 includes a brand new experimental LLVM bindings to the Ada2005 programming language.</li>
Duncan Sandse2e4a892009-06-24 08:38:48 +0000359</ul>
360
361</div>
362
Duncan Sandse2e4a892009-06-24 08:38:48 +0000363<!--=========================================================================-->
364<div class="doc_subsection">
365<a name="coreimprovements">LLVM IR and Core Improvements</a>
366</div>
367
368<div class="doc_text">
369<p>LLVM IR has several new features that are used by our existing front-ends and
370can be useful if you are writing a front-end for LLVM:</p>
371
372<ul>
Chris Lattner7b0a6812009-10-08 06:27:53 +0000373<li>Getelementpr instruction now allows any integer type for array/pointer indexes.</li>
374<li>Inbounds for GEP</li>
375<li>NSW/NUW/exact div</li>
376<li>LSR promotes int induction variables to 64-bit on 64-bit targets, major perf boost for numerical code.</li>
377<li>LSR now analyzes pointer expressions (e.g. getelementptrs), not just integers.</li>
378<li>new linkage types linkonce_odr, weak_odr, linker_private, and available_externally.</li>
379<li>New fadd, fsub, fmul instructions and classes. </li>
380<li>Target intrinsics can now return multiple results.</li>
Duncan Sandse2e4a892009-06-24 08:38:48 +0000381</ul>
382
383</div>
384
385<!--=========================================================================-->
386<div class="doc_subsection">
387<a name="optimizer">Optimizer Improvements</a>
388</div>
389
390<div class="doc_text">
391
392<p>In addition to a large array of bug fixes and minor performance tweaks, this
393release includes a few major enhancements and additions to the optimizers:</p>
394
395<ul>
396
Chris Lattner7b0a6812009-10-08 06:27:53 +0000397<li>SRoA improvements for vector unions, memset, arbitrary weird bitfield accesses etc. It now produces "strange" sized integers.</li>
398<li>Inliner reuse stack space when inlining arrays?</li>
399<li>Enabled GVN Load PRE.</li>
400<li>New Static Single Information (SSI) construction pass (not used by anything yet, experimental).</li>
401</li>
Duncan Sandse2e4a892009-06-24 08:38:48 +0000402
403</ul>
404
405</div>
406
407<!--=========================================================================-->
408<div class="doc_subsection">
409<a name="codegen">Target Independent Code Generator Improvements</a>
410</div>
411
412<div class="doc_text">
413
414<p>We have put a significant amount of work into the code generator
415infrastructure, which allows us to implement more aggressive algorithms and make
416it run faster:</p>
417
418<ul>
419
Chris Lattner7b0a6812009-10-08 06:27:53 +0000420<li> -asm-verbose now prints location info (with -g) and loop nest info.</li>
421<li>Tblgen now supports multiclass inheritance and a number of new string and
422 list operations like !(subst), !(foreach), !car, !cdr, !null, !if, !cast.
423 These make the .td files more expressive and allow more aggressive factoring
424 of duplication across instruction patterns.</li>
425<li>New MachineVerifier pass.</li>
426<li>Machine LICM, hoists things like constant pool loads, loads from readonly stubs, vector constant synthesization code, etc.</li>
427<li>Machine Sinking</li>
428<li>target-specific intrinsics (r63765)</li>
429<li>Regalloc improvements for commuting, various spiller peephole optimizations, cross-class coalescing.</li>
430<li><tt>llc -enable-value-prop</tt>, propagation of value info (sign/zero ext info) from one MBB to another</li>
431<li>Regalloc hints for allocation stuff: Evan r73381/r73671. Finished/enabled?</li>
432<li>Stack slot coloring for register spills (denser stack frames)</li>
433<li>SelectionDAGS: New BuildVectorSDNode (r65296), and ISD::VECTOR_SHUFFLE (r69952 / PR2957)</li>
Chris Lattner80ed2552009-10-08 07:01:46 +0000434<li>Experimental support for shrink wrapping support in PEI.</li>
Duncan Sandse2e4a892009-06-24 08:38:48 +0000435</ul>
436</div>
437
438<!--=========================================================================-->
439<div class="doc_subsection">
440<a name="x86">X86-32 and X86-64 Target Improvements</a>
441</div>
442
443<div class="doc_text">
444<p>New features of the X86 target include:
445</p>
446
447<ul>
448
Chris Lattner7b0a6812009-10-08 06:27:53 +0000449<li>Preliminary support for addrspace 256 -> GS, 257 -> FS, known problems: CodeGenerator.html#x86_memory</li>
450<li>Support for softfloat modes, typically used by OS kernels.</li>
451
452<li>X86-64: better modeling of implicit zero extensions, eliminates a lot of redundant zexts</li>
453<li>X86-64 TLS support for local exec and initial exec.</li>
454<li>Better modeling of H registerts as subregs.</li>
455<li>Vector icmp/fcmp now work with SSE codegen.</li>
456<li>SSE 4.2 support.</li>
457<li>all global variable reference logic is now in ClassifyGlobalReference.</li>
458</li>
Duncan Sandse2e4a892009-06-24 08:38:48 +0000459</ul>
460
461</div>
462
463<!--=========================================================================-->
464<div class="doc_subsection">
465<a name="pic16">PIC16 Target Improvements</a>
466</div>
467
468<div class="doc_text">
469<p>New features of the PIC16 target include:
470</p>
471
472<ul>
Chris Lattner7b0a6812009-10-08 06:27:53 +0000473<li>Support for floating-point, indirect function calls, and
474 passing/returning aggregate types to functions.
475<li>The code generator is able to generate debug info into output COFF files.
476<li>Support for placing an object into a specific section or at a specific
477 address in memory.</li>
Duncan Sandse2e4a892009-06-24 08:38:48 +0000478</ul>
479
480<p>Things not yet supported:</p>
481
482<ul>
Duncan Sandse2e4a892009-06-24 08:38:48 +0000483<li>Variable arguments.</li>
Duncan Sandse2e4a892009-06-24 08:38:48 +0000484<li>Interrupts/programs.</li>
Duncan Sandse2e4a892009-06-24 08:38:48 +0000485</ul>
486
487</div>
488
Bob Wilson755cbe02009-08-12 21:19:49 +0000489<!--=========================================================================-->
490<div class="doc_subsection">
491<a name="ARM">ARM Target Improvements</a>
492</div>
493
494<div class="doc_text">
495<p>New features of the ARM target include:
496</p>
497
498<ul>
499
500<li>Preliminary support for processors, such as the Cortex-A8 and Cortex-A9,
Sandeep Patel64e39612009-08-20 15:01:16 +0000501that implement version v7-A of the ARM architecture. The ARM backend now
502supports both the Thumb2 and Advanced SIMD (Neon) instruction sets. The
503AAPCS-VFP "hard float" calling conventions are also supported with the
504<tt>-float-abi=hard</tt> flag. These features are still somewhat experimental
505and subject to change. The Neon intrinsics, in particular, may change in future
506releases of LLVM.
Bob Wilson755cbe02009-08-12 21:19:49 +0000507</li>
Chris Lattner7b0a6812009-10-08 06:27:53 +0000508
509 ARM AAPCS-VFP hard float ABI is supported.
510 ARM calling convention code is now tblgen generated instead of manual.
511 ARM: NEON support. neonfp for doing single precision fp with neon instead of VFP.
512
Bob Wilson755cbe02009-08-12 21:19:49 +0000513</ul>
514
515</div>
516
Duncan Sandse2e4a892009-06-24 08:38:48 +0000517<!--=========================================================================-->
518<div class="doc_subsection">
Chris Lattner7b0a6812009-10-08 06:27:53 +0000519<a name="OtherTarget">Other Target Specific Improvements</a>
Duncan Sandse2e4a892009-06-24 08:38:48 +0000520</div>
521
522<div class="doc_text">
Chris Lattner7b0a6812009-10-08 06:27:53 +0000523<p>New features of other targets include:
524</p>
Duncan Sandse2e4a892009-06-24 08:38:48 +0000525
526<ul>
Chris Lattner7b0a6812009-10-08 06:27:53 +0000527<li>Add support for the PowerPC 64-bit SVR4 ABI.</li>
528<li>Mips now supports O32 Calling Convention.</li>
529</ul>
530
531</div>
532
533<!--=========================================================================-->
534<div class="doc_subsection">
535<a name="newapis">New Useful APIs</a>
536</div>
537
538<div class="doc_text">
539
540<ul>
541<li>New EngineBuilder class for creating JITs: r76276</li>
542 New PrettyStackTrace, crashes of llvm tools should give some indication of what the compiler was doing at the time of the crash (e.g. running a pass), and print out command line arguments.
543 StringRef class, Twine class.
544 New WeakVH and AssertingVH and CallbackVH classes.
545 New llvm/ADT/Triple class.
546 llvm_report_error() error handling API (llvm/Support/ErrorHandling.h)
547 New llvm/System/Atomic.h, llvm/System/RWMutex.h for portable atomic ops, rw locks.
548 New SourceMgr, SMLoc classes for simple parsers with caret diagnostics and #include support, (used by
549 tablegen, llvm-mc, the .ll parser, FileCheck, etc)
550
551<ul>
552
553
554</div>
555
556<!--=========================================================================-->
557<div class="doc_subsection">
558<a name="otherimprovements">Other Improvements and New Features</a>
559</div>
560
561<div class="doc_text">
562<p>Other miscellaneous features include:</p>
563
564<ul>
565<li>interpreter + libffi</li>
566<li> JIT now supports generating more than 16M of code.</li>
567<li>Users can now <a
568href="http://llvm.org/doxygen/classllvm_1_1ExecutionEngine.html#fcd2b4b92ca38812ca31640b0da14927">register</a>
569a <a href="http://llvm.org/doxygen/classllvm_1_1JITEventListener.html">JITEventListener</a>
570to receive callbacks when the JIT emits or frees machine code. The
571OProfile support uses this mechanism.</li>
572 JIT support for oprofile (r75279), configure with --with-oprofile. Now we get line # and function info for JIT'd functions.
573
Chris Lattner80ed2552009-10-08 07:01:46 +0000574<li>Profile info improvements by Andreas Neustifter.</li>
575<li>Many extensions to the C APIs.</li>
576
577<li>LLVMC:
578
579* Dynamic plugins now work on Windows.
580* New option property: init. Makes possible to provide default values for
581 options defined in plugins (interface to cl::init).
582* New example: Skeleton, shows how to create a standalone LLVMC-based driver.
583* New example: mcc16, a driver for the PIC16 toolchain.</li>
584
Duncan Sandse2e4a892009-06-24 08:38:48 +0000585</ul>
586
587</div>
588
589
590<!--=========================================================================-->
591<div class="doc_subsection">
592<a name="changes">Major Changes and Removed Features</a>
593</div>
594
595<div class="doc_text">
596
597<p>If you're already an LLVM user or developer with out-of-tree changes based
Owen Andersone27be3a2009-07-02 16:48:38 +0000598on LLVM 2.5, this section lists some "gotchas" that you may run into upgrading
Duncan Sandse2e4a892009-06-24 08:38:48 +0000599from the previous release.</p>
600
601<ul>
602
Chris Lattner7b0a6812009-10-08 06:27:53 +0000603<li>The Itanium (IA64) backend has been removed. It was not supported and
604 bitrotted.</li>
605<li>The BigBlock register allocator has been removed, it also bitrotted.</li>
606<li>The C Backend (-march=c) is no longer considered part of the LLVM release
607criteria. We still want it to work, but no one is maintaining it and it lacks
608support for arbitrary precision integers and other important IR features.</li>
Duncan Sandse2e4a892009-06-24 08:38:48 +0000609</ul>
610
Chris Lattner80ed2552009-10-08 07:01:46 +0000611 LLVM build now builds all libraries as .a files instead of some
612 libraries as relinked .o files. This requires some APIs like
613 InitializeAllTargets.h. TargetRegistry!
614
615
616
Duncan Sandse2e4a892009-06-24 08:38:48 +0000617
618<p>In addition, many APIs have changed in this release. Some of the major LLVM
619API changes are:</p>
620
Chris Lattner7b0a6812009-10-08 06:27:53 +0000621
622 API Cleanup:
623 no use of hash_set/hash_map, no more llvm::OStream
624 Use raw_ostream for everything, killed off llvm/Streams.h and DOUT
625
Duncan Sandse2e4a892009-06-24 08:38:48 +0000626<ul>
Owen Andersone27be3a2009-07-02 16:48:38 +0000627<li>LLVM's global uniquing tables for <tt>Type</tt>s and <tt>Constant</tt>s have
628 been privatized into members of an <tt>LLVMContext</tt>. A number of APIs
629 now take an <tt>LLVMContext</tt> as a parameter. To smooth the transition
630 for clients that will only ever use a single context, the new
631 <tt>getGlobalContext()</tt> API can be used to access a default global
632 context which can be passed in any and all cases where a context is
633 required.
Duncan Sandse2e4a892009-06-24 08:38:48 +0000634<li>The <tt>getABITypeSize</tt> methods are now called <tt>getAllocSize</tt>.</li>
Dan Gohmanf667e7e2009-07-07 20:05:15 +0000635<li>The <tt>Add</tt>, <tt>Sub</tt>, and <tt>Mul</tt> operators are no longer
636 overloaded for floating-point types. Floating-point addition, subtraction,
637 and multiplication are now represented with new operators <tt>FAdd</tt>,
638 <tt>FSub</tt>, and <tt>FMul</tt>. In the <tt>IRBuilder</tt> API,
639 <tt>CreateAdd</tt>, <tt>CreateSub</tt>, <tt>CreateMul</tt>, and
640 <tt>CreateNeg</tt> should only be used for integer arithmetic now;
641 <tt>CreateFAdd</tt>, <tt>CreateFSub</tt>, <tt>CreateFMul</tt>, and
642 <tt>CreateFNeg</tt> should now be used for floating-point arithmetic.</li>
Daniel Dunbar02e73132009-07-12 20:41:27 +0000643<li>The DynamicLibrary class can no longer be constructed, its functionality has
644 moved to static member functions.</li>
Dan Gohmane4d54d72009-07-15 19:59:19 +0000645<li><tt>raw_fd_ostream</tt>'s constructor for opening a given filename now
646 takes an extra <tt>Force</tt> argument. If <tt>Force</tt> is set to
647 <tt>false</tt>, an error will be reported if a file with the given name
648 already exists. If <tt>Force</tt> is set to <tt>true</tt>, the file will
649 be silently truncated (which is the behavior before this flag was
650 added).</li>
Torok Edwinf6fa8ae2009-07-21 20:27:10 +0000651<li><tt>SCEVHandle</tt> no longer exists, because reference counting is no
652longer done for <tt>SCEV*</tt> objects, instead <tt>const SCEV*</tt> should be
653used.</li>
Daniel Dunbar8b5ee822009-07-25 05:26:53 +0000654
Daniel Dunbar6e0d1cb2009-07-25 04:41:11 +0000655<li>Many APIs, notably <tt>llvm::Value</tt>, now use the <tt>StringRef</tt>
656and <tt>Twine</tt> classes instead of passing <tt>const char*</tt>
657or <tt>std::string</tt>, as described in
658the <a href="ProgrammersManual.html#string_apis">Programmer's Manual</a>. Most
Daniel Dunbar8b5ee822009-07-25 05:26:53 +0000659clients should be unaffected by this transition, unless they are used to <tt>Value::getName()</tt> returning a string. Here are some tips on updating to 2.6:
660 <ul>
661 <li><tt>getNameStr()</tt> is still available, and matches the old
662 behavior. Replacing <tt>getName()</tt> calls with this is an safe option,
663 although more efficient alternatives are now possible.</li>
664
665 <li>If you were just relying on <tt>getName()</tt> being able to be sent to
666 a <tt>std::ostream</tt>, consider migrating
667 to <tt>llvm::raw_ostream</tt>.</li>
668
669 <li>If you were using <tt>getName().c_str()</tt> to get a <tt>const
670 char*</tt> pointer to the name, you can use <tt>getName().data()</tt>.
671 Note that this string (as before), may not be the entire name if the
672 name containts embedded null characters.</li>
673
674 <li>If you were using operator plus on the result of <tt>getName()</tt> and
675 treating the result as an <tt>std::string</tt>, you can either
676 uses <tt>Twine::str</tt> to get the result as an <tt>std::string</tt>, or
677 could move to a <tt>Twine</tt> based design.</li>
Daniel Dunbar03d76512009-07-25 23:55:21 +0000678
679 <li><tt>isName()</tt> should be replaced with comparison
Benjamin Kramere15192b2009-08-05 15:42:44 +0000680 against <tt>getName()</tt> (this is now efficient).
Daniel Dunbar8b5ee822009-07-25 05:26:53 +0000681 </ul>
682</li>
683
Daniel Dunbara5881e32009-07-26 02:12:58 +0000684<li>The registration interfaces for backend Targets has changed (what was
Daniel Dunbard6b06b12009-07-26 05:41:39 +0000685previously TargetMachineRegistry). For backend authors, see the <a href="WritingAnLLVMBackend.html#TargetRegistration">Writing An LLVM Backend</a> guide. For clients, the notable API changes are:
686 <ul>
687 <li><tt>TargetMachineRegistry</tt> has been renamed
688 to <tt>TargetRegistry</tt>.</li>
689
690 <li>Clients should move to using the <tt>TargetRegistry::lookupTarget()</tt>
691 function to find targets.</li>
692 </ul>
693</li>
Daniel Dunbar8b5ee822009-07-25 05:26:53 +0000694
Torok Edwinf6fa8ae2009-07-21 20:27:10 +0000695<li>llvm-dis now fails if output file exists, instead of dumping to stdout.
Daniel Dunbar6e0d1cb2009-07-25 04:41:11 +0000696FIXME: describe any other tool changes due to the raw_fd_ostream change. FIXME:
697This is not an API change, maybe there should be a tool changes section?</li>
Torok Edwinf6fa8ae2009-07-21 20:27:10 +0000698<li>temporarely due to Context API change passes should call doInitialization()
699method of the pass they inherit from, otherwise Context is NULL.
700FIXME: remove this entry when this is no longer needed.<li>
Duncan Sandse2e4a892009-06-24 08:38:48 +0000701</ul>
702
703</div>
704
705
706
707<!-- *********************************************************************** -->
708<div class="doc_section">
709 <a name="portability">Portability and Supported Platforms</a>
710</div>
711<!-- *********************************************************************** -->
712
713<div class="doc_text">
714
715<p>LLVM is known to work on the following platforms:</p>
716
717<ul>
718<li>Intel and AMD machines (IA32, X86-64, AMD64, EMT-64) running Red Hat
Chris Lattner3e7b5ca2009-07-21 22:47:03 +0000719Linux, Fedora Core, FreeBSD and AuroraUX (and probably other unix-like systems).</li>
Duncan Sandse2e4a892009-06-24 08:38:48 +0000720<li>PowerPC and X86-based Mac OS X systems, running 10.3 and above in 32-bit
721and 64-bit modes.</li>
722<li>Intel and AMD machines running on Win32 using MinGW libraries (native).</li>
723<li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
724 support is available for native builds with Visual C++).</li>
725<li>Sun UltraSPARC workstations running Solaris 10.</li>
726<li>Alpha-based machines running Debian GNU/Linux.</li>
Duncan Sandse2e4a892009-06-24 08:38:48 +0000727</ul>
728
729<p>The core LLVM infrastructure uses GNU autoconf to adapt itself
730to the machine and operating system on which it is built. However, minor
731porting may be required to get LLVM to work on new platforms. We welcome your
732portability patches and reports of successful builds or error messages.</p>
733
734</div>
735
736<!-- *********************************************************************** -->
737<div class="doc_section">
738 <a name="knownproblems">Known Problems</a>
739</div>
740<!-- *********************************************************************** -->
741
742<div class="doc_text">
743
744<p>This section contains significant known problems with the LLVM system,
745listed by component. If you run into a problem, please check the <a
746href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
747there isn't already one.</p>
748
Chris Lattner3e7b5ca2009-07-21 22:47:03 +0000749<ul>
Chris Lattneraedb59a2009-07-21 23:17:26 +0000750<li>LLVM will not correctly compile on Solaris and/or OpenSolaris
Chris Lattner3e7b5ca2009-07-21 22:47:03 +0000751using the stock GCC 3.x.x series 'out the box',
752See: <a href="#brokengcc">Broken versions of GCC and other tools</a>.
753However, A <a href="http://pkg.auroraux.org/GCC">Modern GCC Build</a>
754for x86/x64 has been made available from the third party AuroraUX Project
Chris Lattner7b0a6812009-10-08 06:27:53 +0000755that has been meticulously tested for bootstrapping LLVM &amp; Clang.</li>
Chris Lattner3e7b5ca2009-07-21 22:47:03 +0000756</ul>
757
Duncan Sandse2e4a892009-06-24 08:38:48 +0000758</div>
759
760<!-- ======================================================================= -->
761<div class="doc_subsection">
762 <a name="experimental">Experimental features included with this release</a>
763</div>
764
765<div class="doc_text">
766
767<p>The following components of this LLVM release are either untested, known to
768be broken or unreliable, or are in early development. These components should
769not be relied on, and bugs should not be filed against them, but they may be
770useful to some people. In particular, if you would like to work on one of these
771components, please contact us on the <a
772href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p>
773
774<ul>
Dan Gohmand2cb3d22009-07-24 00:30:09 +0000775<li>The MSIL, Alpha, SPU, MIPS, and PIC16 backends are experimental.</li>
Duncan Sandse2e4a892009-06-24 08:38:48 +0000776<li>The <tt>llc</tt> "<tt>-filetype=asm</tt>" (the default) is the only
777 supported value for this option.</li>
778</ul>
779
780</div>
781
782<!-- ======================================================================= -->
783<div class="doc_subsection">
784 <a name="x86-be">Known problems with the X86 back-end</a>
785</div>
786
787<div class="doc_text">
788
789<ul>
790 <li>The X86 backend does not yet support
791 all <a href="http://llvm.org/PR879">inline assembly that uses the X86
792 floating point stack</a>. It supports the 'f' and 't' constraints, but not
793 'u'.</li>
794 <li>The X86 backend generates inefficient floating point code when configured
795 to generate code for systems that don't have SSE2.</li>
796 <li>Win64 code generation wasn't widely tested. Everything should work, but we
797 expect small issues to happen. Also, llvm-gcc cannot build the mingw64
798 runtime currently due
799 to <a href="http://llvm.org/PR2255">several</a>
800 <a href="http://llvm.org/PR2257">bugs</a> and due to lack of support for
801 the
802 'u' inline assembly constraint and for X87 floating point inline assembly.</li>
803 <li>The X86-64 backend does not yet support the LLVM IR instruction
804 <tt>va_arg</tt>. Currently, the llvm-gcc and front-ends support variadic
805 argument constructs on X86-64 by lowering them manually.</li>
806</ul>
807
808</div>
809
810<!-- ======================================================================= -->
811<div class="doc_subsection">
812 <a name="ppc-be">Known problems with the PowerPC back-end</a>
813</div>
814
815<div class="doc_text">
816
817<ul>
818<li>The Linux PPC32/ABI support needs testing for the interpreter and static
819compilation, and lacks support for debug information.</li>
820</ul>
821
822</div>
823
824<!-- ======================================================================= -->
825<div class="doc_subsection">
826 <a name="arm-be">Known problems with the ARM back-end</a>
827</div>
828
829<div class="doc_text">
830
831<ul>
Bob Wilson755cbe02009-08-12 21:19:49 +0000832<li>Support for the Advanced SIMD (Neon) instruction set is still incomplete
833and not well tested. Some features may not work at all, and the code quality
834may be poor in some cases.</li>
Duncan Sandse2e4a892009-06-24 08:38:48 +0000835<li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
836processors, thumb programs can crash or produce wrong
837results (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
838<li>Compilation for ARM Linux OABI (old ABI) is supported but not fully tested.
839</li>
Duncan Sandse2e4a892009-06-24 08:38:48 +0000840</ul>
841
842</div>
843
844<!-- ======================================================================= -->
845<div class="doc_subsection">
846 <a name="sparc-be">Known problems with the SPARC back-end</a>
847</div>
848
849<div class="doc_text">
850
851<ul>
852<li>The SPARC backend only supports the 32-bit SPARC ABI (-m32); it does not
853 support the 64-bit SPARC ABI (-m64).</li>
854</ul>
855
856</div>
857
858<!-- ======================================================================= -->
859<div class="doc_subsection">
860 <a name="mips-be">Known problems with the MIPS back-end</a>
861</div>
862
863<div class="doc_text">
864
865<ul>
866<li>The O32 ABI is not fully supported.</li>
867<li>64-bit MIPS targets are not supported yet.</li>
868</ul>
869
870</div>
871
872<!-- ======================================================================= -->
873<div class="doc_subsection">
874 <a name="alpha-be">Known problems with the Alpha back-end</a>
875</div>
876
877<div class="doc_text">
878
879<ul>
880
881<li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
882appropriate nops inserted to ensure restartability.</li>
883
884</ul>
885</div>
886
887<!-- ======================================================================= -->
888<div class="doc_subsection">
Duncan Sandse2e4a892009-06-24 08:38:48 +0000889 <a name="c-be">Known problems with the C back-end</a>
890</div>
891
892<div class="doc_text">
893
894<ul>
895<li><a href="http://llvm.org/PR802">The C backend has only basic support for
896 inline assembly code</a>.</li>
897<li><a href="http://llvm.org/PR1658">The C backend violates the ABI of common
898 C++ programs</a>, preventing intermixing between C++ compiled by the CBE and
899 C++ code compiled with <tt>llc</tt> or native compilers.</li>
900<li>The C backend does not support all exception handling constructs.</li>
901<li>The C backend does not support arbitrary precision integers.</li>
902</ul>
903
904</div>
905
906
907<!-- ======================================================================= -->
908<div class="doc_subsection">
909 <a name="c-fe">Known problems with the llvm-gcc C front-end</a>
910</div>
911
912<div class="doc_text">
913
914<p>llvm-gcc does not currently support <a href="http://llvm.org/PR869">Link-Time
915Optimization</a> on most platforms "out-of-the-box". Please inquire on the
916LLVMdev mailing list if you are interested.</p>
917
918<p>The only major language feature of GCC not supported by llvm-gcc is
919 the <tt>__builtin_apply</tt> family of builtins. However, some extensions
920 are only supported on some targets. For example, trampolines are only
921 supported on some targets (these are used when you take the address of a
922 nested function).</p>
923
924<p>If you run into GCC extensions which are not supported, please let us know.
925</p>
926
927</div>
928
929<!-- ======================================================================= -->
930<div class="doc_subsection">
931 <a name="c++-fe">Known problems with the llvm-gcc C++ front-end</a>
932</div>
933
934<div class="doc_text">
935
936<p>The C++ front-end is considered to be fully
937tested and works for a number of non-trivial programs, including LLVM
938itself, Qt, Mozilla, etc.</p>
939
940<ul>
941<li>Exception handling works well on the X86 and PowerPC targets. Currently
942 only Linux and Darwin targets are supported (both 32 and 64 bit).</li>
943</ul>
944
945</div>
946
947<!-- ======================================================================= -->
948<div class="doc_subsection">
949 <a name="fortran-fe">Known problems with the llvm-gcc Fortran front-end</a>
950</div>
951
952<div class="doc_text">
953<ul>
954<li>Fortran support generally works, but there are still several unresolved bugs
955 in Bugzilla. Please see the tools/gfortran component for details.</li>
956</ul>
957</div>
958
959<!-- ======================================================================= -->
960<div class="doc_subsection">
961 <a name="ada-fe">Known problems with the llvm-gcc Ada front-end</a>
962</div>
963
964<div class="doc_text">
965The llvm-gcc 4.2 Ada compiler works fairly well; however, this is not a mature
966technology, and problems should be expected.
967<ul>
968<li>The Ada front-end currently only builds on X86-32. This is mainly due
969to lack of trampoline support (pointers to nested functions) on other platforms.
970However, it <a href="http://llvm.org/PR2006">also fails to build on X86-64</a>
971which does support trampolines.</li>
972<li>The Ada front-end <a href="http://llvm.org/PR2007">fails to bootstrap</a>.
973This is due to lack of LLVM support for <tt>setjmp</tt>/<tt>longjmp</tt> style
974exception handling, which is used internally by the compiler.
975Workaround: configure with --disable-bootstrap.</li>
976<li>The c380004, <a href="http://llvm.org/PR2010">c393010</a>
977and <a href="http://llvm.org/PR2421">cxg2021</a> ACATS tests fail
978(c380004 also fails with gcc-4.2 mainline).
979If the compiler is built with checks disabled then <a href="http://llvm.org/PR2010">c393010</a>
980causes the compiler to go into an infinite loop, using up all system memory.</li>
981<li>Some GCC specific Ada tests continue to crash the compiler.</li>
982<li>The -E binder option (exception backtraces)
983<a href="http://llvm.org/PR1982">does not work</a> and will result in programs
984crashing if an exception is raised. Workaround: do not use -E.</li>
985<li>Only discrete types <a href="http://llvm.org/PR1981">are allowed to start
986or finish at a non-byte offset</a> in a record. Workaround: do not pack records
987or use representation clauses that result in a field of a non-discrete type
988starting or finishing in the middle of a byte.</li>
989<li>The <tt>lli</tt> interpreter <a href="http://llvm.org/PR2009">considers
990'main' as generated by the Ada binder to be invalid</a>.
991Workaround: hand edit the file to use pointers for <tt>argv</tt> and
992<tt>envp</tt> rather than integers.</li>
993<li>The <tt>-fstack-check</tt> option <a href="http://llvm.org/PR2008">is
994ignored</a>.</li>
995</ul>
996</div>
997
Erick Tryzelaar17167be2009-09-28 04:42:55 +0000998<!-- ======================================================================= -->
999<div class="doc_subsection">
1000 <a name="ocaml-bindingse">Known problems with the O'Caml bindings</a>
1001</div>
1002
1003<div class="doc_text">
1004
1005<p>The Llvm.Linkage module is broken, and has incorrect values. Only
1006Llvm.Linkage.External, Llvm.Linkage.Available_externally, and
1007Llvm.Linkage.Link_once will be correct. If you need any of the other linkage
1008modes, you'll have to write an external C library in order to expose the
1009functionality. This has been fixed in the trunk.</p>
1010</div>
1011
Duncan Sandse2e4a892009-06-24 08:38:48 +00001012<!-- *********************************************************************** -->
1013<div class="doc_section">
1014 <a name="additionalinfo">Additional Information</a>
1015</div>
1016<!-- *********************************************************************** -->
1017
1018<div class="doc_text">
1019
1020<p>A wide variety of additional information is available on the <a
1021href="http://llvm.org">LLVM web page</a>, in particular in the <a
1022href="http://llvm.org/docs/">documentation</a> section. The web page also
1023contains versions of the API documentation which is up-to-date with the
1024Subversion version of the source code.
1025You can access versions of these documents specific to this release by going
1026into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
1027
1028<p>If you have any questions or comments about LLVM, please feel free to contact
1029us via the <a href="http://llvm.org/docs/#maillist"> mailing
1030lists</a>.</p>
1031
1032</div>
1033
1034<!-- *********************************************************************** -->
1035
1036<hr>
1037<address>
1038 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
1039 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
1040 <a href="http://validator.w3.org/check/referer"><img
1041 src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
1042
1043 <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
1044 Last modified: $Date$
1045</address>
1046
1047</body>
1048</html>