blob: d0c8c2122cdfbe369538aad586cd8031b24ced97 [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 Lattner28d02742009-10-09 05:01:15 +0000112<p>The <a href="http://clang.llvm.org/">Clang project</a> is an effort to build
113a set of new 'LLVM native' front-end technologies for the C family of languages.
114LLVM 2.6 is the first release to officially include Clang, and it provides a
115production quality C and Objective-C compiler. If you are interested in fast
116compiles and good diagnostics, we encourage you to try it out.</p>
117
118<p>In addition to supporting these languages, C++ support is also <a
119href="http://clang.llvm.org/cxx_status.html">well under way</a>, and mainline
120Clang is able to parse the libstdc++ 4.2 headers and even codegen simple apps.
121If you are interested in Clang C++ support or any other Clang feature, we
122strongly encourage you to get involved on the <a
Duncan Sandse2e4a892009-06-24 08:38:48 +0000123href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-dev">Clang front-end mailing
124list</a>.</p>
125
126<p>In the LLVM 2.6 time-frame, the Clang team has made many improvements:</p>
127
128<ul>
Chris Lattner28d02742009-10-09 05:01:15 +0000129<li>C and Objective-C support are now considered production quality.</li>
Chris Lattnerc32a5322009-09-30 06:27:22 +0000130<li>AuroraUX / FreeBSD &amp; OpenBSD Toolchain support.</li>
Chris Lattner28d02742009-10-09 05:01:15 +0000131<li>Most of Objective-C 2.0 is now supported with the GNU runtime.</li>
Duncan Sandse2e4a892009-06-24 08:38:48 +0000132<li>Many many bugs are fixed and many features have been added.</li>
133</ul>
134</div>
135
136<!--=========================================================================-->
137<div class="doc_subsection">
138<a name="clangsa">Clang Static Analyzer</a>
139</div>
140
141<div class="doc_text">
142
Chris Lattner80ed2552009-10-08 07:01:46 +0000143<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 +0000144includes an early stage static source code analysis tool for <a
145href="http://clang.llvm.org/StaticAnalysis.html">automatically finding bugs</a>
146in C and Objective-C programs. The tool performs a growing set of checks to find
147bugs that occur on a specific path within a program.</p>
148
149<p>In the LLVM 2.6 time-frame there have been many significant improvements to
150XYZ.</p>
151
152<p>The set of checks performed by the static analyzer continues to expand, and
153future plans for the tool include full source-level inter-procedural analysis
154and deeper checks such as buffer overrun detection. There are many opportunities
155to extend and enhance the static analyzer, and anyone interested in working on
156this project is encouraged to get involved!</p>
157
158</div>
159
160<!--=========================================================================-->
161<div class="doc_subsection">
162<a name="vmkit">VMKit: JVM/CLI Virtual Machine Implementation</a>
163</div>
164
165<div class="doc_text">
166<p>
Chris Lattner80ed2552009-10-08 07:01:46 +0000167<b>UPDATE!</b>
Duncan Sandse2e4a892009-06-24 08:38:48 +0000168The <a href="http://vmkit.llvm.org/">VMKit project</a> is an implementation of
169a JVM and a CLI Virtual Machines (Microsoft .NET is an
170implementation of the CLI) using the Just-In-Time compiler of LLVM.</p>
171
172<p>Following LLVM 2.6, VMKit has its XYZ release that you can find on its
173<a href="http://vmkit.llvm.org/releases/">webpage</a>. The release includes
174bug fixes, cleanup and new features. The major changes are:</p>
175
176<ul>
177
178<li>Something wonderful!</li>
179
180</ul>
181</div>
182
Chris Lattner80ed2552009-10-08 07:01:46 +0000183<!--=========================================================================-->
184<div class="doc_subsection">
185<a name="mc">llvm-mc: Machine Code Toolkit</a>
186</div>
187
188<div class="doc_text">
189<p>
190<b>UPDATE!</b>
191blah
192
193 MC:
194 MCSection, MCAsmInfo
195 MCInstPrinter did it make it in?
196 MCInst (X86 using it so far)
197 Rewrite of X86 GV selection logic: TargetOperand flags on ExternalSymbol, GV, etc operands.
198 Can parse and re-print out an darwin-x86 .s file.
199 TargetLoweringObjectFile, MCSectionKind
200 Verrrry early start of a macho writer.
201</p>
202
203</div>
204
205
Duncan Sandse2e4a892009-06-24 08:38:48 +0000206<!-- *********************************************************************** -->
207<div class="doc_section">
208 <a name="externalproj">External Projects Using LLVM 2.6</a>
209</div>
210<!-- *********************************************************************** -->
211
Chris Lattner80ed2552009-10-08 07:01:46 +0000212<!--=========================================================================-->
213<div class="doc_subsection">
214<a name="Rubinius">Rubinius</a>
215</div>
216
217<div class="doc_text">
218<p><a href="http://github.com/evanphx/rubinius">Rubinius</a> is an environment
219for running Ruby code which strives to write as much of the core class
220implementation in Ruby as possible. Combined with a bytecode interpreting VM, it
221uses LLVM to optimize and compile ruby code down to machine code. Techniques
222such as type feedback, method inlining, and uncommon traps are all used to
223remove dynamism from ruby execution and increase performance.</p>
Chris Lattnerd4a537b2009-10-08 16:01:33 +0000224
225<p>Since LLVM 2.5, Rubinius has made several major leaps forward, implementing
226a counter based JIT, type feedback, and speculative method inlining.
227</p>
228
Chris Lattner80ed2552009-10-08 07:01:46 +0000229</div>
Chris Lattnerc32a5322009-09-30 06:27:22 +0000230
231<!--=========================================================================-->
232<div class="doc_subsection">
233<a name="macruby">MacRuby</a>
234</div>
235
236<div class="doc_text">
237
238<p>
239<a href="http://macruby.org">MacRuby</a> is an implementation of Ruby on top of
240core Mac OS X technologies, such as the Objective-C common runtime and garbage
241collector, and the CoreFoundation framework. It is principally developed by
242Apple and aims at enabling the creation of full-fledged Mac OS X applications.
243</p>
244
245<p>
246MacRuby uses LLVM for optimization passes, JIT and AOT compilation of Ruby
247expressions. It also uses zero-cost DWARF exceptions to implement Ruby exception
248handling.</p>
249
250</div>
251
252
Duncan Sandse2e4a892009-06-24 08:38:48 +0000253<!--=========================================================================-->
254<div class="doc_subsection">
255<a name="pure">Pure</a>
256</div>
257
258<div class="doc_text">
259<p>
260<a href="http://pure-lang.googlecode.com/">Pure</a>
261is an algebraic/functional programming language based on term rewriting.
262Programs are collections of equations which are used to evaluate expressions in
263a symbolic fashion. Pure offers dynamic typing, eager and lazy evaluation,
264lexical closures, a hygienic macro system (also based on term rewriting),
265built-in list and matrix support (including list and matrix comprehensions) and
266an easy-to-use C interface. The interpreter uses LLVM as a backend to
267 JIT-compile Pure programs to fast native code.</p>
268
Chris Lattnerd4a537b2009-10-08 16:01:33 +0000269<p>Pure versions 0.31 and later have been tested and are known to work with
270LLVM 2.6 (and continue to work with older LLVM releases >= 2.3 as well).
Duncan Sandse2e4a892009-06-24 08:38:48 +0000271</p>
272</div>
273
274
275<!--=========================================================================-->
276<div class="doc_subsection">
277<a name="ldc">LLVM D Compiler</a>
278</div>
279
280<div class="doc_text">
281<p>
Chris Lattner80ed2552009-10-08 07:01:46 +0000282<b>UPDATE!</b>
Duncan Sandse2e4a892009-06-24 08:38:48 +0000283<a href="http://www.dsource.org/projects/ldc">LDC</a> is an implementation of
284the D Programming Language using the LLVM optimizer and code generator.
285The LDC project works great with the LLVM 2.6 release. General improvements in
286this
287cycle have included new inline asm constraint handling, better debug info
288support, general bugfixes, and better x86-64 support. This has allowed
289some major improvements in LDC, getting us much closer to being as
290fully featured as the original DMD compiler from DigitalMars.
291</p>
292</div>
293
294<!--=========================================================================-->
295<div class="doc_subsection">
296<a name="RoadsendPHP">Roadsend PHP</a>
297</div>
298
299<div class="doc_text">
Chris Lattner80ed2552009-10-08 07:01:46 +0000300<p>
Chris Lattner80ed2552009-10-08 07:01:46 +0000301<a href="http://code.roadsend.com/rphp">Roadsend PHP</a> (rphp) is an open
Duncan Sandse2e4a892009-06-24 08:38:48 +0000302source implementation of the PHP programming
303language that uses LLVM for its optimizer, JIT, and static compiler. This is a
304reimplementation of an earlier project that is now based on LLVM.</p>
305</div>
306
Jeffrey Yasskinba2aa782009-06-24 21:09:13 +0000307<!--=========================================================================-->
308<div class="doc_subsection">
309<a name="Unladen Swallow">Unladen Swallow</a>
310</div>
311
312<div class="doc_text">
Chris Lattner80ed2552009-10-08 07:01:46 +0000313<p>
314<b>UPDATE!</b>
315<a href="http://code.google.com/p/unladen-swallow/">Unladen Swallow</a> is a
Jeffrey Yasskinba2aa782009-06-24 21:09:13 +0000316branch of <a href="http://python.org/">Python</a> intended to be fully
317compatible and significantly faster. It uses LLVM's optimization passes and JIT
318compiler.</p>
319</div>
320
Jeffrey Yasskin5e98cb72009-06-24 21:26:42 +0000321
Duncan Sandse2e4a892009-06-24 08:38:48 +0000322
323<!-- *********************************************************************** -->
324<div class="doc_section">
325 <a name="whatsnew">What's New in LLVM 2.6?</a>
326</div>
327<!-- *********************************************************************** -->
328
329<div class="doc_text">
330
331<p>This release includes a huge number of bug fixes, performance tweaks, and
332minor improvements. Some of the major improvements and new features are listed
333in this section.
334</p>
Chris Lattner7b0a6812009-10-08 06:27:53 +0000335
Duncan Sandse2e4a892009-06-24 08:38:48 +0000336</div>
337
338<!--=========================================================================-->
339<div class="doc_subsection">
340<a name="majorfeatures">Major New Features</a>
341</div>
342
343<div class="doc_text">
344
345<p>LLVM 2.6 includes several major new capabilities:</p>
346
347<ul>
Chris Lattner7b0a6812009-10-08 06:27:53 +0000348<li>Support for debug line numbers when optimization enabled</li>
349<li>gold lto plugin</li>
350<li>New MSP430 and SystemZ backends.</li>
351<li>New BlackFin backend.</li>
352<li>LLVMContext, llvm_start_multithreaded: ProgrammersManual.html#threading</li>
Chris Lattner7b0a6812009-10-08 06:27:53 +0000353<li>klee web page at klee.llvm.org</li>
354<li>FileCheck</li>
355<li>New compiler-rt project.</li>
Edward O'Callaghan50310f92009-08-22 02:17:22 +0000356<li>LLVM 2.6 includes a brand new experimental LLVM bindings to the Ada2005 programming language.</li>
Duncan Sandse2e4a892009-06-24 08:38:48 +0000357</ul>
358
359</div>
360
Duncan Sandse2e4a892009-06-24 08:38:48 +0000361<!--=========================================================================-->
362<div class="doc_subsection">
363<a name="coreimprovements">LLVM IR and Core Improvements</a>
364</div>
365
366<div class="doc_text">
367<p>LLVM IR has several new features that are used by our existing front-ends and
368can be useful if you are writing a front-end for LLVM:</p>
369
370<ul>
Chris Lattner7b0a6812009-10-08 06:27:53 +0000371<li>Getelementpr instruction now allows any integer type for array/pointer indexes.</li>
372<li>Inbounds for GEP</li>
373<li>NSW/NUW/exact div</li>
374<li>LSR promotes int induction variables to 64-bit on 64-bit targets, major perf boost for numerical code.</li>
375<li>LSR now analyzes pointer expressions (e.g. getelementptrs), not just integers.</li>
376<li>new linkage types linkonce_odr, weak_odr, linker_private, and available_externally.</li>
377<li>New fadd, fsub, fmul instructions and classes. </li>
378<li>Target intrinsics can now return multiple results.</li>
Duncan Sandse2e4a892009-06-24 08:38:48 +0000379</ul>
380
381</div>
382
383<!--=========================================================================-->
384<div class="doc_subsection">
385<a name="optimizer">Optimizer Improvements</a>
386</div>
387
388<div class="doc_text">
389
390<p>In addition to a large array of bug fixes and minor performance tweaks, this
391release includes a few major enhancements and additions to the optimizers:</p>
392
393<ul>
394
Chris Lattner7b0a6812009-10-08 06:27:53 +0000395<li>SRoA improvements for vector unions, memset, arbitrary weird bitfield accesses etc. It now produces "strange" sized integers.</li>
396<li>Inliner reuse stack space when inlining arrays?</li>
397<li>Enabled GVN Load PRE.</li>
398<li>New Static Single Information (SSI) construction pass (not used by anything yet, experimental).</li>
399</li>
Duncan Sandse2e4a892009-06-24 08:38:48 +0000400
401</ul>
402
403</div>
404
405<!--=========================================================================-->
406<div class="doc_subsection">
407<a name="codegen">Target Independent Code Generator Improvements</a>
408</div>
409
410<div class="doc_text">
411
412<p>We have put a significant amount of work into the code generator
413infrastructure, which allows us to implement more aggressive algorithms and make
414it run faster:</p>
415
416<ul>
417
Chris Lattner7b0a6812009-10-08 06:27:53 +0000418<li> -asm-verbose now prints location info (with -g) and loop nest info.</li>
419<li>Tblgen now supports multiclass inheritance and a number of new string and
420 list operations like !(subst), !(foreach), !car, !cdr, !null, !if, !cast.
421 These make the .td files more expressive and allow more aggressive factoring
422 of duplication across instruction patterns.</li>
423<li>New MachineVerifier pass.</li>
424<li>Machine LICM, hoists things like constant pool loads, loads from readonly stubs, vector constant synthesization code, etc.</li>
425<li>Machine Sinking</li>
426<li>target-specific intrinsics (r63765)</li>
427<li>Regalloc improvements for commuting, various spiller peephole optimizations, cross-class coalescing.</li>
428<li><tt>llc -enable-value-prop</tt>, propagation of value info (sign/zero ext info) from one MBB to another</li>
429<li>Regalloc hints for allocation stuff: Evan r73381/r73671. Finished/enabled?</li>
430<li>Stack slot coloring for register spills (denser stack frames)</li>
431<li>SelectionDAGS: New BuildVectorSDNode (r65296), and ISD::VECTOR_SHUFFLE (r69952 / PR2957)</li>
Chris Lattner80ed2552009-10-08 07:01:46 +0000432<li>Experimental support for shrink wrapping support in PEI.</li>
Duncan Sandse2e4a892009-06-24 08:38:48 +0000433</ul>
434</div>
435
436<!--=========================================================================-->
437<div class="doc_subsection">
438<a name="x86">X86-32 and X86-64 Target Improvements</a>
439</div>
440
441<div class="doc_text">
442<p>New features of the X86 target include:
443</p>
444
445<ul>
446
Chris Lattner7b0a6812009-10-08 06:27:53 +0000447<li>Preliminary support for addrspace 256 -> GS, 257 -> FS, known problems: CodeGenerator.html#x86_memory</li>
448<li>Support for softfloat modes, typically used by OS kernels.</li>
449
450<li>X86-64: better modeling of implicit zero extensions, eliminates a lot of redundant zexts</li>
451<li>X86-64 TLS support for local exec and initial exec.</li>
452<li>Better modeling of H registerts as subregs.</li>
453<li>Vector icmp/fcmp now work with SSE codegen.</li>
454<li>SSE 4.2 support.</li>
455<li>all global variable reference logic is now in ClassifyGlobalReference.</li>
456</li>
Duncan Sandse2e4a892009-06-24 08:38:48 +0000457</ul>
458
459</div>
460
461<!--=========================================================================-->
462<div class="doc_subsection">
463<a name="pic16">PIC16 Target Improvements</a>
464</div>
465
466<div class="doc_text">
467<p>New features of the PIC16 target include:
468</p>
469
470<ul>
Chris Lattner7b0a6812009-10-08 06:27:53 +0000471<li>Support for floating-point, indirect function calls, and
472 passing/returning aggregate types to functions.
473<li>The code generator is able to generate debug info into output COFF files.
474<li>Support for placing an object into a specific section or at a specific
475 address in memory.</li>
Duncan Sandse2e4a892009-06-24 08:38:48 +0000476</ul>
477
478<p>Things not yet supported:</p>
479
480<ul>
Duncan Sandse2e4a892009-06-24 08:38:48 +0000481<li>Variable arguments.</li>
Duncan Sandse2e4a892009-06-24 08:38:48 +0000482<li>Interrupts/programs.</li>
Duncan Sandse2e4a892009-06-24 08:38:48 +0000483</ul>
484
485</div>
486
Bob Wilson755cbe02009-08-12 21:19:49 +0000487<!--=========================================================================-->
488<div class="doc_subsection">
489<a name="ARM">ARM Target Improvements</a>
490</div>
491
492<div class="doc_text">
493<p>New features of the ARM target include:
494</p>
495
496<ul>
497
498<li>Preliminary support for processors, such as the Cortex-A8 and Cortex-A9,
Sandeep Patel64e39612009-08-20 15:01:16 +0000499that implement version v7-A of the ARM architecture. The ARM backend now
500supports both the Thumb2 and Advanced SIMD (Neon) instruction sets. The
501AAPCS-VFP "hard float" calling conventions are also supported with the
502<tt>-float-abi=hard</tt> flag. These features are still somewhat experimental
503and subject to change. The Neon intrinsics, in particular, may change in future
504releases of LLVM.
Bob Wilson755cbe02009-08-12 21:19:49 +0000505</li>
Chris Lattner7b0a6812009-10-08 06:27:53 +0000506
507 ARM AAPCS-VFP hard float ABI is supported.
508 ARM calling convention code is now tblgen generated instead of manual.
509 ARM: NEON support. neonfp for doing single precision fp with neon instead of VFP.
510
Bob Wilson755cbe02009-08-12 21:19:49 +0000511</ul>
512
513</div>
514
Duncan Sandse2e4a892009-06-24 08:38:48 +0000515<!--=========================================================================-->
516<div class="doc_subsection">
Chris Lattner7b0a6812009-10-08 06:27:53 +0000517<a name="OtherTarget">Other Target Specific Improvements</a>
Duncan Sandse2e4a892009-06-24 08:38:48 +0000518</div>
519
520<div class="doc_text">
Chris Lattner7b0a6812009-10-08 06:27:53 +0000521<p>New features of other targets include:
522</p>
Duncan Sandse2e4a892009-06-24 08:38:48 +0000523
524<ul>
Chris Lattner7b0a6812009-10-08 06:27:53 +0000525<li>Add support for the PowerPC 64-bit SVR4 ABI.</li>
526<li>Mips now supports O32 Calling Convention.</li>
527</ul>
528
529</div>
530
531<!--=========================================================================-->
532<div class="doc_subsection">
533<a name="newapis">New Useful APIs</a>
534</div>
535
536<div class="doc_text">
537
538<ul>
539<li>New EngineBuilder class for creating JITs: r76276</li>
540 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.
541 StringRef class, Twine class.
542 New WeakVH and AssertingVH and CallbackVH classes.
543 New llvm/ADT/Triple class.
544 llvm_report_error() error handling API (llvm/Support/ErrorHandling.h)
545 New llvm/System/Atomic.h, llvm/System/RWMutex.h for portable atomic ops, rw locks.
546 New SourceMgr, SMLoc classes for simple parsers with caret diagnostics and #include support, (used by
547 tablegen, llvm-mc, the .ll parser, FileCheck, etc)
548
549<ul>
550
551
552</div>
553
554<!--=========================================================================-->
555<div class="doc_subsection">
556<a name="otherimprovements">Other Improvements and New Features</a>
557</div>
558
559<div class="doc_text">
560<p>Other miscellaneous features include:</p>
561
562<ul>
563<li>interpreter + libffi</li>
564<li> JIT now supports generating more than 16M of code.</li>
565<li>Users can now <a
566href="http://llvm.org/doxygen/classllvm_1_1ExecutionEngine.html#fcd2b4b92ca38812ca31640b0da14927">register</a>
567a <a href="http://llvm.org/doxygen/classllvm_1_1JITEventListener.html">JITEventListener</a>
568to receive callbacks when the JIT emits or frees machine code. The
569OProfile support uses this mechanism.</li>
570 JIT support for oprofile (r75279), configure with --with-oprofile. Now we get line # and function info for JIT'd functions.
571
Chris Lattner80ed2552009-10-08 07:01:46 +0000572<li>Profile info improvements by Andreas Neustifter.</li>
573<li>Many extensions to the C APIs.</li>
574
575<li>LLVMC:
576
577* Dynamic plugins now work on Windows.
578* New option property: init. Makes possible to provide default values for
579 options defined in plugins (interface to cl::init).
580* New example: Skeleton, shows how to create a standalone LLVMC-based driver.
581* New example: mcc16, a driver for the PIC16 toolchain.</li>
582
Duncan Sandse2e4a892009-06-24 08:38:48 +0000583</ul>
584
585</div>
586
587
588<!--=========================================================================-->
589<div class="doc_subsection">
590<a name="changes">Major Changes and Removed Features</a>
591</div>
592
593<div class="doc_text">
594
595<p>If you're already an LLVM user or developer with out-of-tree changes based
Owen Andersone27be3a2009-07-02 16:48:38 +0000596on LLVM 2.5, this section lists some "gotchas" that you may run into upgrading
Duncan Sandse2e4a892009-06-24 08:38:48 +0000597from the previous release.</p>
598
599<ul>
600
Chris Lattner7b0a6812009-10-08 06:27:53 +0000601<li>The Itanium (IA64) backend has been removed. It was not supported and
602 bitrotted.</li>
603<li>The BigBlock register allocator has been removed, it also bitrotted.</li>
604<li>The C Backend (-march=c) is no longer considered part of the LLVM release
605criteria. We still want it to work, but no one is maintaining it and it lacks
606support for arbitrary precision integers and other important IR features.</li>
Duncan Sandse2e4a892009-06-24 08:38:48 +0000607</ul>
608
Chris Lattner80ed2552009-10-08 07:01:46 +0000609 LLVM build now builds all libraries as .a files instead of some
610 libraries as relinked .o files. This requires some APIs like
611 InitializeAllTargets.h. TargetRegistry!
612
613
614
Duncan Sandse2e4a892009-06-24 08:38:48 +0000615
616<p>In addition, many APIs have changed in this release. Some of the major LLVM
617API changes are:</p>
618
Chris Lattner7b0a6812009-10-08 06:27:53 +0000619
620 API Cleanup:
621 no use of hash_set/hash_map, no more llvm::OStream
622 Use raw_ostream for everything, killed off llvm/Streams.h and DOUT
623
Duncan Sandse2e4a892009-06-24 08:38:48 +0000624<ul>
Owen Andersone27be3a2009-07-02 16:48:38 +0000625<li>LLVM's global uniquing tables for <tt>Type</tt>s and <tt>Constant</tt>s have
626 been privatized into members of an <tt>LLVMContext</tt>. A number of APIs
627 now take an <tt>LLVMContext</tt> as a parameter. To smooth the transition
628 for clients that will only ever use a single context, the new
629 <tt>getGlobalContext()</tt> API can be used to access a default global
630 context which can be passed in any and all cases where a context is
631 required.
Duncan Sandse2e4a892009-06-24 08:38:48 +0000632<li>The <tt>getABITypeSize</tt> methods are now called <tt>getAllocSize</tt>.</li>
Dan Gohmanf667e7e2009-07-07 20:05:15 +0000633<li>The <tt>Add</tt>, <tt>Sub</tt>, and <tt>Mul</tt> operators are no longer
634 overloaded for floating-point types. Floating-point addition, subtraction,
635 and multiplication are now represented with new operators <tt>FAdd</tt>,
636 <tt>FSub</tt>, and <tt>FMul</tt>. In the <tt>IRBuilder</tt> API,
637 <tt>CreateAdd</tt>, <tt>CreateSub</tt>, <tt>CreateMul</tt>, and
638 <tt>CreateNeg</tt> should only be used for integer arithmetic now;
639 <tt>CreateFAdd</tt>, <tt>CreateFSub</tt>, <tt>CreateFMul</tt>, and
640 <tt>CreateFNeg</tt> should now be used for floating-point arithmetic.</li>
Daniel Dunbar02e73132009-07-12 20:41:27 +0000641<li>The DynamicLibrary class can no longer be constructed, its functionality has
642 moved to static member functions.</li>
Dan Gohmane4d54d72009-07-15 19:59:19 +0000643<li><tt>raw_fd_ostream</tt>'s constructor for opening a given filename now
644 takes an extra <tt>Force</tt> argument. If <tt>Force</tt> is set to
645 <tt>false</tt>, an error will be reported if a file with the given name
646 already exists. If <tt>Force</tt> is set to <tt>true</tt>, the file will
647 be silently truncated (which is the behavior before this flag was
648 added).</li>
Torok Edwinf6fa8ae2009-07-21 20:27:10 +0000649<li><tt>SCEVHandle</tt> no longer exists, because reference counting is no
650longer done for <tt>SCEV*</tt> objects, instead <tt>const SCEV*</tt> should be
651used.</li>
Daniel Dunbar8b5ee822009-07-25 05:26:53 +0000652
Daniel Dunbar6e0d1cb2009-07-25 04:41:11 +0000653<li>Many APIs, notably <tt>llvm::Value</tt>, now use the <tt>StringRef</tt>
654and <tt>Twine</tt> classes instead of passing <tt>const char*</tt>
655or <tt>std::string</tt>, as described in
656the <a href="ProgrammersManual.html#string_apis">Programmer's Manual</a>. Most
Daniel Dunbar8b5ee822009-07-25 05:26:53 +0000657clients 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:
658 <ul>
659 <li><tt>getNameStr()</tt> is still available, and matches the old
660 behavior. Replacing <tt>getName()</tt> calls with this is an safe option,
661 although more efficient alternatives are now possible.</li>
662
663 <li>If you were just relying on <tt>getName()</tt> being able to be sent to
664 a <tt>std::ostream</tt>, consider migrating
665 to <tt>llvm::raw_ostream</tt>.</li>
666
667 <li>If you were using <tt>getName().c_str()</tt> to get a <tt>const
668 char*</tt> pointer to the name, you can use <tt>getName().data()</tt>.
669 Note that this string (as before), may not be the entire name if the
670 name containts embedded null characters.</li>
671
672 <li>If you were using operator plus on the result of <tt>getName()</tt> and
673 treating the result as an <tt>std::string</tt>, you can either
674 uses <tt>Twine::str</tt> to get the result as an <tt>std::string</tt>, or
675 could move to a <tt>Twine</tt> based design.</li>
Daniel Dunbar03d76512009-07-25 23:55:21 +0000676
677 <li><tt>isName()</tt> should be replaced with comparison
Benjamin Kramere15192b2009-08-05 15:42:44 +0000678 against <tt>getName()</tt> (this is now efficient).
Daniel Dunbar8b5ee822009-07-25 05:26:53 +0000679 </ul>
680</li>
681
Daniel Dunbara5881e32009-07-26 02:12:58 +0000682<li>The registration interfaces for backend Targets has changed (what was
Daniel Dunbard6b06b12009-07-26 05:41:39 +0000683previously TargetMachineRegistry). For backend authors, see the <a href="WritingAnLLVMBackend.html#TargetRegistration">Writing An LLVM Backend</a> guide. For clients, the notable API changes are:
684 <ul>
685 <li><tt>TargetMachineRegistry</tt> has been renamed
686 to <tt>TargetRegistry</tt>.</li>
687
688 <li>Clients should move to using the <tt>TargetRegistry::lookupTarget()</tt>
689 function to find targets.</li>
690 </ul>
691</li>
Daniel Dunbar8b5ee822009-07-25 05:26:53 +0000692
Torok Edwinf6fa8ae2009-07-21 20:27:10 +0000693<li>llvm-dis now fails if output file exists, instead of dumping to stdout.
Daniel Dunbar6e0d1cb2009-07-25 04:41:11 +0000694FIXME: describe any other tool changes due to the raw_fd_ostream change. FIXME:
695This is not an API change, maybe there should be a tool changes section?</li>
Torok Edwinf6fa8ae2009-07-21 20:27:10 +0000696<li>temporarely due to Context API change passes should call doInitialization()
697method of the pass they inherit from, otherwise Context is NULL.
698FIXME: remove this entry when this is no longer needed.<li>
Duncan Sandse2e4a892009-06-24 08:38:48 +0000699</ul>
700
701</div>
702
703
704
705<!-- *********************************************************************** -->
706<div class="doc_section">
707 <a name="portability">Portability and Supported Platforms</a>
708</div>
709<!-- *********************************************************************** -->
710
711<div class="doc_text">
712
713<p>LLVM is known to work on the following platforms:</p>
714
715<ul>
716<li>Intel and AMD machines (IA32, X86-64, AMD64, EMT-64) running Red Hat
Chris Lattner3e7b5ca2009-07-21 22:47:03 +0000717Linux, Fedora Core, FreeBSD and AuroraUX (and probably other unix-like systems).</li>
Duncan Sandse2e4a892009-06-24 08:38:48 +0000718<li>PowerPC and X86-based Mac OS X systems, running 10.3 and above in 32-bit
719and 64-bit modes.</li>
720<li>Intel and AMD machines running on Win32 using MinGW libraries (native).</li>
721<li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
722 support is available for native builds with Visual C++).</li>
723<li>Sun UltraSPARC workstations running Solaris 10.</li>
724<li>Alpha-based machines running Debian GNU/Linux.</li>
Duncan Sandse2e4a892009-06-24 08:38:48 +0000725</ul>
726
727<p>The core LLVM infrastructure uses GNU autoconf to adapt itself
728to the machine and operating system on which it is built. However, minor
729porting may be required to get LLVM to work on new platforms. We welcome your
730portability patches and reports of successful builds or error messages.</p>
731
732</div>
733
734<!-- *********************************************************************** -->
735<div class="doc_section">
736 <a name="knownproblems">Known Problems</a>
737</div>
738<!-- *********************************************************************** -->
739
740<div class="doc_text">
741
742<p>This section contains significant known problems with the LLVM system,
743listed by component. If you run into a problem, please check the <a
744href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
745there isn't already one.</p>
746
Chris Lattner3e7b5ca2009-07-21 22:47:03 +0000747<ul>
Chris Lattneraedb59a2009-07-21 23:17:26 +0000748<li>LLVM will not correctly compile on Solaris and/or OpenSolaris
Chris Lattner3e7b5ca2009-07-21 22:47:03 +0000749using the stock GCC 3.x.x series 'out the box',
750See: <a href="#brokengcc">Broken versions of GCC and other tools</a>.
751However, A <a href="http://pkg.auroraux.org/GCC">Modern GCC Build</a>
752for x86/x64 has been made available from the third party AuroraUX Project
Chris Lattner7b0a6812009-10-08 06:27:53 +0000753that has been meticulously tested for bootstrapping LLVM &amp; Clang.</li>
Chris Lattner3e7b5ca2009-07-21 22:47:03 +0000754</ul>
755
Duncan Sandse2e4a892009-06-24 08:38:48 +0000756</div>
757
758<!-- ======================================================================= -->
759<div class="doc_subsection">
760 <a name="experimental">Experimental features included with this release</a>
761</div>
762
763<div class="doc_text">
764
765<p>The following components of this LLVM release are either untested, known to
766be broken or unreliable, or are in early development. These components should
767not be relied on, and bugs should not be filed against them, but they may be
768useful to some people. In particular, if you would like to work on one of these
769components, please contact us on the <a
770href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p>
771
772<ul>
Dan Gohmand2cb3d22009-07-24 00:30:09 +0000773<li>The MSIL, Alpha, SPU, MIPS, and PIC16 backends are experimental.</li>
Duncan Sandse2e4a892009-06-24 08:38:48 +0000774<li>The <tt>llc</tt> "<tt>-filetype=asm</tt>" (the default) is the only
775 supported value for this option.</li>
776</ul>
777
778</div>
779
780<!-- ======================================================================= -->
781<div class="doc_subsection">
782 <a name="x86-be">Known problems with the X86 back-end</a>
783</div>
784
785<div class="doc_text">
786
787<ul>
788 <li>The X86 backend does not yet support
789 all <a href="http://llvm.org/PR879">inline assembly that uses the X86
790 floating point stack</a>. It supports the 'f' and 't' constraints, but not
791 'u'.</li>
792 <li>The X86 backend generates inefficient floating point code when configured
793 to generate code for systems that don't have SSE2.</li>
794 <li>Win64 code generation wasn't widely tested. Everything should work, but we
795 expect small issues to happen. Also, llvm-gcc cannot build the mingw64
796 runtime currently due
797 to <a href="http://llvm.org/PR2255">several</a>
798 <a href="http://llvm.org/PR2257">bugs</a> and due to lack of support for
799 the
800 'u' inline assembly constraint and for X87 floating point inline assembly.</li>
801 <li>The X86-64 backend does not yet support the LLVM IR instruction
802 <tt>va_arg</tt>. Currently, the llvm-gcc and front-ends support variadic
803 argument constructs on X86-64 by lowering them manually.</li>
804</ul>
805
806</div>
807
808<!-- ======================================================================= -->
809<div class="doc_subsection">
810 <a name="ppc-be">Known problems with the PowerPC back-end</a>
811</div>
812
813<div class="doc_text">
814
815<ul>
816<li>The Linux PPC32/ABI support needs testing for the interpreter and static
817compilation, and lacks support for debug information.</li>
818</ul>
819
820</div>
821
822<!-- ======================================================================= -->
823<div class="doc_subsection">
824 <a name="arm-be">Known problems with the ARM back-end</a>
825</div>
826
827<div class="doc_text">
828
829<ul>
Bob Wilson755cbe02009-08-12 21:19:49 +0000830<li>Support for the Advanced SIMD (Neon) instruction set is still incomplete
831and not well tested. Some features may not work at all, and the code quality
832may be poor in some cases.</li>
Duncan Sandse2e4a892009-06-24 08:38:48 +0000833<li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
834processors, thumb programs can crash or produce wrong
835results (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
836<li>Compilation for ARM Linux OABI (old ABI) is supported but not fully tested.
837</li>
Duncan Sandse2e4a892009-06-24 08:38:48 +0000838</ul>
839
840</div>
841
842<!-- ======================================================================= -->
843<div class="doc_subsection">
844 <a name="sparc-be">Known problems with the SPARC back-end</a>
845</div>
846
847<div class="doc_text">
848
849<ul>
850<li>The SPARC backend only supports the 32-bit SPARC ABI (-m32); it does not
851 support the 64-bit SPARC ABI (-m64).</li>
852</ul>
853
854</div>
855
856<!-- ======================================================================= -->
857<div class="doc_subsection">
858 <a name="mips-be">Known problems with the MIPS back-end</a>
859</div>
860
861<div class="doc_text">
862
863<ul>
864<li>The O32 ABI is not fully supported.</li>
865<li>64-bit MIPS targets are not supported yet.</li>
866</ul>
867
868</div>
869
870<!-- ======================================================================= -->
871<div class="doc_subsection">
872 <a name="alpha-be">Known problems with the Alpha back-end</a>
873</div>
874
875<div class="doc_text">
876
877<ul>
878
879<li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
880appropriate nops inserted to ensure restartability.</li>
881
882</ul>
883</div>
884
885<!-- ======================================================================= -->
886<div class="doc_subsection">
Duncan Sandse2e4a892009-06-24 08:38:48 +0000887 <a name="c-be">Known problems with the C back-end</a>
888</div>
889
890<div class="doc_text">
891
892<ul>
893<li><a href="http://llvm.org/PR802">The C backend has only basic support for
894 inline assembly code</a>.</li>
895<li><a href="http://llvm.org/PR1658">The C backend violates the ABI of common
896 C++ programs</a>, preventing intermixing between C++ compiled by the CBE and
897 C++ code compiled with <tt>llc</tt> or native compilers.</li>
898<li>The C backend does not support all exception handling constructs.</li>
899<li>The C backend does not support arbitrary precision integers.</li>
900</ul>
901
902</div>
903
904
905<!-- ======================================================================= -->
906<div class="doc_subsection">
907 <a name="c-fe">Known problems with the llvm-gcc C front-end</a>
908</div>
909
910<div class="doc_text">
911
912<p>llvm-gcc does not currently support <a href="http://llvm.org/PR869">Link-Time
913Optimization</a> on most platforms "out-of-the-box". Please inquire on the
914LLVMdev mailing list if you are interested.</p>
915
916<p>The only major language feature of GCC not supported by llvm-gcc is
917 the <tt>__builtin_apply</tt> family of builtins. However, some extensions
918 are only supported on some targets. For example, trampolines are only
919 supported on some targets (these are used when you take the address of a
920 nested function).</p>
921
922<p>If you run into GCC extensions which are not supported, please let us know.
923</p>
924
925</div>
926
927<!-- ======================================================================= -->
928<div class="doc_subsection">
929 <a name="c++-fe">Known problems with the llvm-gcc C++ front-end</a>
930</div>
931
932<div class="doc_text">
933
934<p>The C++ front-end is considered to be fully
935tested and works for a number of non-trivial programs, including LLVM
936itself, Qt, Mozilla, etc.</p>
937
938<ul>
939<li>Exception handling works well on the X86 and PowerPC targets. Currently
940 only Linux and Darwin targets are supported (both 32 and 64 bit).</li>
941</ul>
942
943</div>
944
945<!-- ======================================================================= -->
946<div class="doc_subsection">
947 <a name="fortran-fe">Known problems with the llvm-gcc Fortran front-end</a>
948</div>
949
950<div class="doc_text">
951<ul>
952<li>Fortran support generally works, but there are still several unresolved bugs
953 in Bugzilla. Please see the tools/gfortran component for details.</li>
954</ul>
955</div>
956
957<!-- ======================================================================= -->
958<div class="doc_subsection">
959 <a name="ada-fe">Known problems with the llvm-gcc Ada front-end</a>
960</div>
961
962<div class="doc_text">
963The llvm-gcc 4.2 Ada compiler works fairly well; however, this is not a mature
964technology, and problems should be expected.
965<ul>
966<li>The Ada front-end currently only builds on X86-32. This is mainly due
967to lack of trampoline support (pointers to nested functions) on other platforms.
968However, it <a href="http://llvm.org/PR2006">also fails to build on X86-64</a>
969which does support trampolines.</li>
970<li>The Ada front-end <a href="http://llvm.org/PR2007">fails to bootstrap</a>.
971This is due to lack of LLVM support for <tt>setjmp</tt>/<tt>longjmp</tt> style
972exception handling, which is used internally by the compiler.
973Workaround: configure with --disable-bootstrap.</li>
974<li>The c380004, <a href="http://llvm.org/PR2010">c393010</a>
975and <a href="http://llvm.org/PR2421">cxg2021</a> ACATS tests fail
976(c380004 also fails with gcc-4.2 mainline).
977If the compiler is built with checks disabled then <a href="http://llvm.org/PR2010">c393010</a>
978causes the compiler to go into an infinite loop, using up all system memory.</li>
979<li>Some GCC specific Ada tests continue to crash the compiler.</li>
980<li>The -E binder option (exception backtraces)
981<a href="http://llvm.org/PR1982">does not work</a> and will result in programs
982crashing if an exception is raised. Workaround: do not use -E.</li>
983<li>Only discrete types <a href="http://llvm.org/PR1981">are allowed to start
984or finish at a non-byte offset</a> in a record. Workaround: do not pack records
985or use representation clauses that result in a field of a non-discrete type
986starting or finishing in the middle of a byte.</li>
987<li>The <tt>lli</tt> interpreter <a href="http://llvm.org/PR2009">considers
988'main' as generated by the Ada binder to be invalid</a>.
989Workaround: hand edit the file to use pointers for <tt>argv</tt> and
990<tt>envp</tt> rather than integers.</li>
991<li>The <tt>-fstack-check</tt> option <a href="http://llvm.org/PR2008">is
992ignored</a>.</li>
993</ul>
994</div>
995
Erick Tryzelaar17167be2009-09-28 04:42:55 +0000996<!-- ======================================================================= -->
997<div class="doc_subsection">
998 <a name="ocaml-bindingse">Known problems with the O'Caml bindings</a>
999</div>
1000
1001<div class="doc_text">
1002
1003<p>The Llvm.Linkage module is broken, and has incorrect values. Only
1004Llvm.Linkage.External, Llvm.Linkage.Available_externally, and
1005Llvm.Linkage.Link_once will be correct. If you need any of the other linkage
1006modes, you'll have to write an external C library in order to expose the
1007functionality. This has been fixed in the trunk.</p>
1008</div>
1009
Duncan Sandse2e4a892009-06-24 08:38:48 +00001010<!-- *********************************************************************** -->
1011<div class="doc_section">
1012 <a name="additionalinfo">Additional Information</a>
1013</div>
1014<!-- *********************************************************************** -->
1015
1016<div class="doc_text">
1017
1018<p>A wide variety of additional information is available on the <a
1019href="http://llvm.org">LLVM web page</a>, in particular in the <a
1020href="http://llvm.org/docs/">documentation</a> section. The web page also
1021contains versions of the API documentation which is up-to-date with the
1022Subversion version of the source code.
1023You can access versions of these documents specific to this release by going
1024into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
1025
1026<p>If you have any questions or comments about LLVM, please feel free to contact
1027us via the <a href="http://llvm.org/docs/#maillist"> mailing
1028lists</a>.</p>
1029
1030</div>
1031
1032<!-- *********************************************************************** -->
1033
1034<hr>
1035<address>
1036 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
1037 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
1038 <a href="http://validator.w3.org/check/referer"><img
1039 src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
1040
1041 <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
1042 Last modified: $Date$
1043</address>
1044
1045</body>
1046</html>