367f6cb6ba216e69b805f139f20445b8a2bc17fe
[oota-llvm.git] / docs / ReleaseNotes.html
1 <!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="_static/llvm.css" type="text/css">
7   <title>LLVM 3.1 Release Notes</title>
8 </head>
9 <body>
10
11 <h1>LLVM 3.1 Release Notes</h1>
12
13 <div>
14 <img style="float:right" src="http://llvm.org/img/DragonSmall.png"
15      width="136" height="136" alt="LLVM Dragon Logo">
16 </div>
17
18 <ol>
19   <li><a href="#intro">Introduction</a></li>
20   <li><a href="#subproj">Sub-project Status Update</a></li>
21   <li><a href="#externalproj">External Projects Using LLVM 3.1</a></li>
22   <li><a href="#whatsnew">What's New in LLVM?</a></li>
23   <li><a href="GettingStarted.html">Installation Instructions</a></li>
24   <li><a href="#knownproblems">Known Problems</a></li>
25   <li><a href="#additionalinfo">Additional Information</a></li>
26 </ol>
27
28 <div class="doc_author">
29   <p>Written by the <a href="http://llvm.org/">LLVM Team</a></p>
30 </div>
31
32 <h1 style="color:red">These are in-progress notes for the upcoming LLVM 3.1
33 release.<br>
34 You may prefer the
35 <a href="http://llvm.org/releases/3.0/docs/ReleaseNotes.html">LLVM 3.0
36 Release Notes</a>.</h1>
37
38 <!-- *********************************************************************** -->
39 <h2>
40   <a name="intro">Introduction</a>
41 </h2>
42 <!-- *********************************************************************** -->
43
44 <div>
45
46 <p>This document contains the release notes for the LLVM Compiler
47    Infrastructure, release 3.1.  Here we describe the status of LLVM, including
48    major improvements from the previous release, improvements in various
49    subprojects of LLVM, and some of the current users of the code.
50    All LLVM releases may be downloaded from
51    the <a href="http://llvm.org/releases/">LLVM releases web site</a>.</p>
52
53 <p>For more information about LLVM, including information about the latest
54    release, please check out the <a href="http://llvm.org/">main LLVM web
55    site</a>.  If you have questions or comments,
56    the <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM
57    Developer's Mailing List</a> is a good place to send them.</p>
58
59 <p>Note that if you are reading this file from a Subversion checkout or the main
60    LLVM web page, this document applies to the <i>next</i> release, not the
61    current one.  To see the release notes for a specific release, please see the
62    <a href="http://llvm.org/releases/">releases page</a>.</p>
63
64 </div>
65
66
67 <!-- *********************************************************************** -->
68 <h2>
69   <a name="subproj">Sub-project Status Update</a>
70 </h2>
71 <!-- *********************************************************************** -->
72
73 <div>
74
75 <p>The LLVM 3.1 distribution currently consists of code from the core LLVM
76    repository (which roughly includes the LLVM optimizers, code generators and
77    supporting tools), and the Clang repository.  In
78    addition to this code, the LLVM Project includes other sub-projects that are
79    in development.  Here we include updates on these subprojects.</p>
80
81 <!--=========================================================================-->
82 <h3>
83 <a name="clang">Clang: C/C++/Objective-C Frontend Toolkit</a>
84 </h3>
85
86 <div>
87
88 <p><a href="http://clang.llvm.org/">Clang</a> is an LLVM front end for the C,
89    C++, and Objective-C languages. Clang aims to provide a better user
90    experience through expressive diagnostics, a high level of conformance to
91    language standards, fast compilation, and low memory use. Like LLVM, Clang
92    provides a modular, library-based architecture that makes it suitable for
93    creating or integrating with other development tools. Clang is considered a
94    production-quality compiler for C, Objective-C, C++ and Objective-C++ on x86
95    (32- and 64-bit), and for Darwin/ARM targets.</p>
96
97 <p>In the LLVM 3.1 time-frame, the Clang team has made many improvements.
98    Highlights include:</p>
99 <ul>
100   <li>Greatly expanded <a href="http://clang.llvm.org/cxx_status.html">C++11
101       support</a> including lambdas, initializer lists, constexpr, user-defined
102       literals, and atomics.</li>
103   <li>A new <a href="http://clang.llvm.org/docs/Tooling.html">tooling</a>
104       library to ease building of clang-based standalone tools.</li>
105   <li>Extended support for
106       <a href="http://clang.llvm.org/docs/ObjectiveCLiterals.html">literals in
107       Objective C</a>.</li>
108 </ul>
109
110   <p>For more details about the changes to Clang since the 3.0 release, see the
111 <a href="http://clang.llvm.org/docs/ReleaseNotes.html">Clang release notes</a>
112 </p>
113
114
115 <p>If Clang rejects your code but another compiler accepts it, please take a
116    look at the <a href="http://clang.llvm.org/compatibility.html">language
117    compatibility</a> guide to make sure this is not intentional or a known
118    issue.</p>
119
120 </div>
121
122 <!--=========================================================================-->
123 <h3>
124 <a name="dragonegg">DragonEgg: GCC front-ends, LLVM back-end</a>
125 </h3>
126
127 <div>
128 <p><a href="http://dragonegg.llvm.org/">DragonEgg</a> is a
129    <a href="http://gcc.gnu.org/wiki/plugins">gcc plugin</a> that replaces GCC's
130    optimizers and code generators with LLVM's. It works with gcc-4.5 and gcc-4.6
131    (and partially with gcc-4.7), can target the x86-32/x86-64 and ARM processor
132    families, and has been successfully used on the Darwin, FreeBSD, KFreeBSD,
133    Linux and OpenBSD platforms.  It fully supports Ada, C, C++ and Fortran.  It
134    has partial support for Go, Java, Obj-C and Obj-C++.</p>
135
136 <p>The 3.1 release has the following notable changes:</p>
137
138   <ul>
139
140   <li>Partial support for gcc-4.7. Ada support is poor, but other languages work
141       fairly well.</li>
142
143   <li>Support for ARM processors. Some essential gcc headers that are needed to
144       build DragonEgg for ARM are not installed by gcc. To work around this,
145       copy the missing headers from the gcc source tree.</li>
146
147   <li>Better optimization for Fortran by exploiting the fact that Fortran scalar
148       arguments have 'restrict' semantics.</li>
149
150   <li>Better optimization for all languages by passing information about type
151       aliasing and type ranges to the LLVM optimizers.</li>
152
153   <li>A regression test-suite was added.</li>
154
155 </ul>
156
157 </div>
158
159 <!--=========================================================================-->
160 <h3>
161 <a name="compiler-rt">compiler-rt: Compiler Runtime Library</a>
162 </h3>
163
164 <div>
165
166 <p>The new LLVM <a href="http://compiler-rt.llvm.org/">compiler-rt project</a>
167    is a simple library that provides an implementation of the low-level
168    target-specific hooks required by code generation and other runtime
169    components.  For example, when compiling for a 32-bit target, converting a
170    double to a 64-bit unsigned integer is compiled into a runtime call to the
171    "__fixunsdfdi" function. The compiler-rt library provides highly optimized
172    implementations of this and other low-level routines (some are 3x faster than
173    the equivalent libgcc routines).</p>
174
175 <p>....</p>
176
177 </div>
178
179 <!--=========================================================================-->
180 <h3>
181 <a name="lldb">LLDB: Low Level Debugger</a>
182 </h3>
183
184 <div>
185
186 <p><a href="http://lldb.llvm.org">LLDB</a> is a ground-up implementation of a
187    command line debugger, as well as a debugger API that can be used from other
188    applications.  LLDB makes use of the Clang parser to provide high-fidelity
189    expression parsing (particularly for C++) and uses the LLVM JIT for target
190    support.</p>
191
192 <p>...</p>
193
194 </div>
195
196 <!--=========================================================================-->
197 <h3>
198 <a name="libc++">libc++: C++ Standard Library</a>
199 </h3>
200
201 <div>
202
203 <p>Like compiler_rt, libc++ is now <a href="DeveloperPolicy.html#license">dual
204    licensed</a> under the MIT and UIUC license, allowing it to be used more
205    permissively.</p>
206
207 <p>...</p>
208
209 </div>
210
211 <!--=========================================================================-->
212 <h3>
213 <a name="vmkit">VMKit</a>
214 </h3>
215
216 <div>
217
218   <p>The <a href="http://vmkit.llvm.org/">VMKit project</a> is an
219   implementation of a Java Virtual Machine (Java VM or JVM) that uses LLVM for
220   static and just-in-time compilation.
221
222   <p>In the LLVM 3.1 time-frame, VMKit has had significant improvements on both
223   runtime and startup performance:</p>
224
225   <ul>
226   <li>...</li>
227   </ul>
228
229 </div>
230
231
232 <!--=========================================================================-->
233 <h3>
234 <a name="Polly">Polly: Polyhedral Optimizer</a>
235 </h3>
236
237 <div>
238
239   <p><a href="http://polly.llvm.org/">Polly</a> is an <em>experimental</em>
240   optimizer for data locality and parallelism. It currently provides high-level
241   loop optimizations and automatic parallelisation (using the OpenMP run time).
242   Work in the area of automatic SIMD and accelerator code generation was
243   started.
244
245   <p>Within the LLVM 3.1 time-frame there were the following highlights:</p>
246
247   <ul>
248   <li>Polly became an official LLVM project</li>
249   <li>Polly can be loaded directly into clang (Enabled by '-O3 -mllvm -polly'
250   )</li>
251   <li>An automatic scheduling optimizer (derived from <a
252   href="http://pluto-compiler.sourceforge.net/">Pluto</a>) was integrated. It
253   performs loop transformations to optimize for data-locality and parallelism.
254   The transformations include, but are not limited to interchange, fusion,
255   fission, skewing and tiling.
256   </li>
257   </ul>
258
259 </div>
260
261 </div>
262
263 <!-- *********************************************************************** -->
264 <h2>
265   <a name="externalproj">External Open Source Projects Using LLVM 3.1</a>
266 </h2>
267 <!-- *********************************************************************** -->
268
269 <div>
270
271 <p>An exciting aspect of LLVM is that it is used as an enabling technology for
272    a lot of other language and tools projects.  This section lists some of the
273    projects that have already been updated to work with LLVM 3.1.</p>
274
275 <h3>FAUST</h3>
276
277 <div>
278
279 <p><a href="http://faust.grame.fr/">FAUST</a> is a compiled language for
280    real-time audio signal processing. The name FAUST stands for Functional
281    AUdio STream. Its programming model combines two approaches: functional
282    programming and block diagram composition. In addition with the C, C++, Java,
283    JavaScript output formats, the Faust compiler can generate LLVM bitcode, and
284    works with LLVM 2.7-3.1.</p>
285
286 </div>
287
288 <h3>Glasgow Haskell Compiler (GHC)</h3>
289
290 <div>
291
292 <p><a href="http://www.haskell.org/ghc/">GHC</a> is an open source compiler and
293    programming suite for Haskell, a lazy functional programming language. It
294    includes an optimizing static compiler generating good code for a variety of
295    platforms, together with an interactive system for convenient, quick
296    development.</p>
297
298 <p>GHC 7.0 and onwards include an LLVM code generator, supporting LLVM 2.8 and
299    later.</p>
300
301 </div>
302
303 <h3>Julia</h3>
304
305 <div>
306
307 <p><a href="https://github.com/JuliaLang/julia">Julia</a> is a high-level,
308    high-performance dynamic language for technical computing. It provides a
309    sophisticated compiler, distributed parallel execution, numerical accuracy,
310    and an extensive mathematical function library. The compiler uses type
311    inference to generate fast code without any type declarations, and uses
312    LLVM's optimization passes and JIT compiler. The
313    <a href="http://julialang.org/"> Julia Language</a> is designed
314    around multiple dispatch, giving programs a large degree of flexibility. It
315    is ready for use on many kinds of problems.</p>
316
317 </div>
318
319 <h3>LLVM D Compiler</h3>
320
321 <div>
322
323 <p><a href="https://github.com/ldc-developers/ldc">LLVM D Compiler</a> (LDC) is
324    a compiler for the D programming Language. It is based on the DMD frontend
325    and uses LLVM as backend.</p>
326
327 </div>
328
329 <h3>Open Shading Language</h3>
330
331 <div>
332
333 <p><a href="https://github.com/imageworks/OpenShadingLanguage/">Open Shading
334    Language (OSL)</a> is a small but rich language for programmable shading in
335    advanced global illumination renderers and other applications, ideal for
336    describing materials, lights, displacement, and pattern generation. It uses
337    LLVM to JIT complex shader networks to x86 code at runtime.</p>
338
339 <p>OSL was developed by Sony Pictures Imageworks for use in its in-house
340    renderer used for feature film animation and visual effects, and is
341    distributed as open source software with the "New BSD" license.</p>
342
343 </div>
344
345 <h3>Portable OpenCL (pocl)</h3>
346
347 <div>
348
349 <p>In addition to producing an easily portable open source OpenCL
350    implementation, another major goal of <a href="http://pocl.sourceforge.net/">
351    pocl</a> is improving performance portability of OpenCL programs with
352    compiler optimizations, reducing the need for target-dependent manual
353    optimizations. An important part of pocl is a set of LLVM passes used to
354    statically parallelize multiple work-items with the kernel compiler, even in
355    the presence of work-group barriers. This enables static parallelization of
356    the fine-grained static concurrency in the work groups in multiple ways
357    (SIMD, VLIW, superscalar,...).</p>
358
359 </div>
360
361 <h3>Pure</h3>
362
363 <div>
364
365 <p><a href="http://pure-lang.googlecode.com/">Pure</a> is an
366    algebraic/functional programming language based on term rewriting. Programs
367    are collections of equations which are used to evaluate expressions in a
368    symbolic fashion. The interpreter uses LLVM as a backend to JIT-compile Pure
369    programs to fast native code. Pure offers dynamic typing, eager and lazy
370    evaluation, lexical closures, a hygienic macro system (also based on term
371    rewriting), built-in list and matrix support (including list and matrix
372    comprehensions) and an easy-to-use interface to C and other programming
373    languages (including the ability to load LLVM bitcode modules, and inline C,
374    C++, Fortran and Faust code in Pure programs if the corresponding
375    LLVM-enabled compilers are installed).</p>
376
377 <p>Pure version 0.54 has been tested and is known to work with LLVM 3.1 (and
378    continues to work with older LLVM releases >= 2.5).</p>
379
380 </div>
381
382 <h3>TTA-based Co-design Environment (TCE)</h3>
383
384 <div>
385
386 <p><a href="http://tce.cs.tut.fi/">TCE</a> is a toolset for designing
387    application-specific processors (ASP) based on the Transport triggered
388    architecture (TTA). The toolset provides a complete co-design flow from C/C++
389    programs down to synthesizable VHDL/Verilog and parallel program binaries.
390    Processor customization points include the register files, function units,
391    supported operations, and the interconnection network.</p>
392
393 <p>TCE uses Clang and LLVM for C/C++ language support, target independent
394    optimizations and also for parts of code generation. It generates new
395    LLVM-based code generators "on the fly" for the designed TTA processors and
396    loads them in to the compiler backend as runtime libraries to avoid
397    per-target recompilation of larger parts of the compiler chain.</p>
398
399 </div>
400
401 </div>
402
403 <!-- *********************************************************************** -->
404 <h2>
405   <a name="whatsnew">What's New in LLVM 3.1?</a>
406 </h2>
407 <!-- *********************************************************************** -->
408
409 <div>
410
411 <p>This release includes a huge number of bug fixes, performance tweaks and
412    minor improvements.  Some of the major improvements and new features are
413    listed in this section.</p>
414
415 <!--=========================================================================-->
416 <h3>
417 <a name="majorfeatures">Major New Features</a>
418 </h3>
419
420 <div>
421
422   <!-- Features that need text if they're finished for 3.1:
423    ARM EHABI
424    combiner-aa?
425    strong phi elim
426    loop dependence analysis
427    CorrelatedValuePropagation
428    lib/Transforms/IPO/MergeFunctions.cpp => consider for 3.1.
429    Integrated assembler on by default for arm/thumb?
430
431    -->
432
433   <!-- Near dead:
434    Analysis/RegionInfo.h + Dom Frontiers
435    SparseBitVector: used in LiveVar.
436    llvm/lib/Archive - replace with lib object?
437    -->
438
439 <p>LLVM 3.1 includes several major changes and big features:</p>
440
441 <ul>
442   <li><a href="../tools/clang/docs/AddressSanitizer.html">AddressSanitizer</a>,
443       a fast memory error detector.</li>
444   <li><a href="CodeGenerator.html#machineinstrbundle">MachineInstr Bundles</a>,
445       Support to model instruction bundling / packing.</li>
446   <li><a href="#armintegratedassembler">ARM Integrated Assembler</a>,
447       A full featured assembler and direct-to-object support for ARM.</li>
448   <li><a href="#blockplacement">Basic Block Placement</a>
449       Probability driven basic block placement.</li>
450   <li>....</li>
451 </ul>
452
453 </div>
454
455
456 <!--=========================================================================-->
457 <h3>
458 <a name="coreimprovements">LLVM IR and Core Improvements</a>
459 </h3>
460
461 <div>
462
463 <p>LLVM IR has several new features for better support of new targets and that
464    expose new optimization opportunities:</p>
465
466   <ul>
467     <li>A new type representing 16 bit <i>half</i> floating point values has
468         been added.</li>
469     <li>IR now supports vectors of pointers, including vector GEPs.</li>
470     <li>Module flags have been introduced. They convey information about the
471         module as a whole to LLVM subsystems. This is currently used to encode
472         Objective C ABI information.</li>
473     <li>Loads can now have range metadata attached to them to describe the
474         possible values being loaded.</li>
475     <li>The <tt>llvm.ctlz</tt> and <tt>llvm.cttz</tt> intrinsics now have an
476       additional argument which indicates whether the behavior of the intrinsic
477       is undefined on a zero input. This can be used to generate more efficient
478       code on platforms that only have instructions which don't return the type
479       size when counting bits in 0.</li>
480     <li>....</li>
481   </ul>
482 </div>
483
484 <!--=========================================================================-->
485 <h3>
486 <a name="optimizer">Optimizer Improvements</a>
487 </h3>
488
489 <div>
490
491 <p>In addition to many minor performance tweaks and bug fixes, this
492    release includes a few major enhancements and additions to the
493    optimizers:</p>
494
495 <ul>
496   <li>The loop unroll pass now is able to unroll loops with run-time trip counts.
497       This feature is turned off by default, and is enabled with the
498       <code>-unroll-runtime</code> flag.</li>
499   <li>A new basic-block autovectorization pass is available. Pass
500       <code>-vectorize</code> to run this pass along with some associated
501       post-vectorization cleanup passes. For more information, see the EuroLLVM
502       2012 slides: <a href="http://llvm.org/devmtg/2012-04-12/Slides/Hal_Finkel.pdf">
503       Autovectorization with LLVM</a>.</li>
504   <li>Inline cost heuristics have been completely overhauled and now closely
505       model constant propagation through call sites, disregard trivially dead
506       code costs, and can model C++ STL iterator patterns.</li>
507   <li>....</li>
508 </ul>
509
510 </div>
511
512 <!--=========================================================================-->
513 <h3>
514 <a name="mc">MC Level Improvements</a>
515 </h3>
516
517 <div>
518
519 <p>The LLVM Machine Code (aka MC) subsystem was created to solve a number of
520    problems in the realm of assembly, disassembly, object file format handling,
521    and a number of other related areas that CPU instruction-set level tools work
522    in. For more information, please see
523   the <a href="http://blog.llvm.org/2010/04/intro-to-llvm-mc-project.html">Intro
524     to the LLVM MC Project Blog Post</a>.</p>
525
526 <ul>
527   <li>The integrated assembler can optionally emit debug information when
528       assembling a </tt>.s</tt> file. It can be enabled by passing the
529       <tt>-g</tt> option to <tt>llvm-mc</tt>.</li>
530   <li>....</li>
531 </ul>
532
533 </div>
534
535 <!--=========================================================================-->
536 <h3>
537 <a name="codegen">Target Independent Code Generator Improvements</a>
538 </h3>
539
540 <div>
541
542 <p>We have changed the way that the Type Legalizer legalizes vectors. The type
543    legalizer now attempts to promote integer elements.  This enabled the
544    implementation of vector-select.  Additionally, we see a performance boost on
545    workloads which use vectors of chars and shorts, since they are now promoted
546    to 32-bit types, which are better supported by the SIMD instruction set.
547    Floating point types are still widened as before.</p>
548
549
550 <p>We have put a significant amount of work into the code generator
551    infrastructure, which allows us to implement more aggressive algorithms and
552    make it run faster:</p>
553
554 <ul>
555   <li>TableGen can now synthesize register classes that are only needed to
556       represent combinations of constraints from instructions and sub-registers.
557       The synthetic register classes inherit most of their properties form their
558       closest user-defined super-class.</li>
559   <li><code>MachineRegisterInfo</code> now allows the reserved registers to be
560       frozen when register allocation starts.  Target hooks should use the
561       <code>MRI-&gt;canReserveReg(FramePtr)</code> method to avoid accidentally
562       disabling frame pointer elimination during register allocation.</li>
563   <li>A new kind of <code>MachineOperand</code> provides a compact
564       representation of large clobber lists on call instructions.  The register
565       mask operand references a bit mask of preserved registers. Everything else
566       is clobbered.</li>
567   <li>The DWARF debug info writer gained support for emitting data for the
568       <a href="SourceLevelDebugging.html#acceltable">name accelerator tables
569       DWARF extension</a>. It is used by LLDB to speed up name lookup.</li>
570 </ul>
571
572 <p> We added new TableGen infrastructure to support bundling for
573     Very Long Instruction Word (VLIW) architectures. TableGen can now
574     automatically generate a deterministic finite automaton from a VLIW
575     target's schedule description which can be queried to determine
576     legal groupings of instructions in a bundle.</p>
577
578 <p> We have added a new target independent VLIW packetizer based on the
579     DFA infrastructure to group machine instructions into bundles.</p>
580
581 </div>
582
583 <h4>
584 <a name="blockplacement">Basic Block Placement</a>
585 </h4>
586 <div>
587 <p>A probability based block placement and code layout algorithm was added to
588 LLVM's code generator. This layout pass supports probabilities derived from
589 static heuristics as well as source code annotations such as
590 <code>__builtin_expect</code>.</p>
591 </div>
592
593 <!--=========================================================================-->
594 <h3>
595 <a name="x86">X86-32 and X86-64 Target Improvements</a>
596 </h3>
597
598 <div>
599
600 <p>New features and major changes in the X86 target include:</p>
601
602 <ul>
603   <li>Greatly improved support for AVX2.</li>
604   <li>Lots of bug fixes and improvements for AVX1.</li>
605   <li>Support for the FMA4 and XOP instruction set extensions.</li>
606   <li>Call instructions use the new register mask operands for faster compile
607   times and better support for different calling conventions.  The old WINCALL
608   instructions are no longer needed.</li>
609   <li>DW2 Exception Handling is enabled on Cygwin and MinGW.</li>
610   <li>Support for implicit TLS model used with MSVC runtime.</li>
611 </ul>
612
613 </div>
614
615 <!--=========================================================================-->
616 <h3>
617 <a name="ARM">ARM Target Improvements</a>
618 </h3>
619
620 <div>
621
622 <p>New features of the ARM target include:</p>
623
624 <ul>
625   <li>The constant island pass now supports basic block and constant pool entry
626   alignments greater than 4 bytes.</li>
627   <li>On Darwin, the ARM target now has a full-featured integrated assembler.
628   </li>
629 </ul>
630
631 <h4>
632 <a name="armintegratedassembler">ARM Integrated Assembler</a>
633 </h4>
634 <div>
635 <p>The ARM target now includes a full featured macro assembler, including
636 direct-to-object module support for clang. The assembler is currently enabled
637 by default for Darwin only pending testing and any additional necessary
638 platform specific support for Linux.</p>
639
640 <p>Full support is included for Thumb1, Thumb2 and ARM modes, along with
641 subtarget and CPU specific extensions for VFP2, VFP3 and NEON.</p>
642
643 <p>The assembler is Unified Syntax only (see ARM Architecural Reference Manual
644 for details). While there is some, and growing, support for pre-unfied (divided)
645 syntax, there are still significant gaps in that support.</p>
646 </div>
647
648 </div>
649 <!--=========================================================================-->
650 <h3>
651 <a name="MIPS">MIPS Target Improvements</a>
652 </h3>
653
654 <div>
655
656 <p>This release has seen major new work on just about every aspect of the MIPS
657   backend.  Some of the major new features include:</p>
658
659 <ul>
660   <li>....</li>
661 </ul>
662 </div>
663
664 <!--=========================================================================-->
665 <h3>
666 <a name="PTX">PTX Target Improvements</a>
667 </h3>
668
669 <div>
670
671 <p>An outstanding conditional inversion bug was fixed in this release.</p>
672
673 <p><b>NOTE</b>: LLVM 3.1 marks the last release of the PTX back-end, in its
674   current form. The back-end is currently being replaced by the NVPTX
675   back-end, currently in SVN ToT.</p>
676
677 </div>
678
679 <!--=========================================================================-->
680 <h3>
681 <a name="OtherTS">Other Target Specific Improvements</a>
682 </h3>
683
684 <div>
685
686 <p>Support for Qualcomm's Hexagon VLIW processor has been added.</p>
687
688 <ul>
689   <li>....</li>
690
691
692 </ul>
693
694 </div>
695
696 <!--=========================================================================-->
697 <h3>
698 <a name="changes">Major Changes and Removed Features</a>
699 </h3>
700
701 <div>
702
703 <p>If you're already an LLVM user or developer with out-of-tree changes based on
704    LLVM 3.1, this section lists some "gotchas" that you may run into upgrading
705    from the previous release.</p>
706
707 <ul>
708   <li>LLVM's build system now requires a python 2 interpreter to be present at
709       build time. A perl interpreter is no longer required.</li>
710   <li>The C backend has been removed.  It had numerous problems, to the point of
711       not being able to compile any nontrivial program.</li>
712   <li>The Alpha, Blackfin and SystemZ targets have been removed due to lack of
713       maintenance.</li>
714   <li>LLVM 3.1 removes support for reading LLVM 2.9 bitcode files. Going
715       forward, we aim for all future versions of LLVM to read bitcode files and
716       <tt>.ll</tt> files produced by LLVM 3.0 and later.</li>
717   <li>The <tt>unwind</tt> instruction is now gone. With the introduction of the
718       new exception handling system in LLVM 3.0, the <tt>unwind</tt> instruction
719       became obsolete.</li>
720   <li>LLVM 3.0 and earlier automatically added the returns_twice fo functions
721       like setjmp based on the name. This functionality was removed in 3.1.
722       This affects Clang users, if -ffreestanding is used.</li>
723   <li>....</li>
724 </ul>
725
726 </div>
727
728 <!--=========================================================================-->
729 <h3>
730 <a name="api_changes">Internal API Changes</a>
731 </h3>
732
733 <div>
734
735 <p>In addition, many APIs have changed in this release.  Some of the major
736    LLVM API changes are:</p>
737
738 <ul>
739   <li>Target specific options have been moved from global variables to members
740       on the new <code>TargetOptions</code> class, which is local to each
741       <code>TargetMachine</code>. As a consequence, the associated flags will
742       no longer be accepted by <tt>clang -mllvm</tt>. This includes:
743 <ul>
744 <li><code>llvm::PrintMachineCode</code></li>
745 <li><code>llvm::NoFramePointerElim</code></li>
746 <li><code>llvm::NoFramePointerElimNonLeaf</code></li>
747 <li><code>llvm::DisableFramePointerElim(const MachineFunction &)</code></li>
748 <li><code>llvm::LessPreciseFPMADOption</code></li>
749 <li><code>llvm::LessPrecideFPMAD()</code></li>
750 <li><code>llvm::NoExcessFPPrecision</code></li>
751 <li><code>llvm::UnsafeFPMath</code></li>
752 <li><code>llvm::NoInfsFPMath</code></li>
753 <li><code>llvm::NoNaNsFPMath</code></li>
754 <li><code>llvm::HonorSignDependentRoundingFPMathOption</code></li>
755 <li><code>llvm::HonorSignDependentRoundingFPMath()</code></li>
756 <li><code>llvm::UseSoftFloat</code></li>
757 <li><code>llvm::FloatABIType</code></li>
758 <li><code>llvm::NoZerosInBSS</code></li>
759 <li><code>llvm::JITExceptionHandling</code></li>
760 <li><code>llvm::JITEmitDebugInfo</code></li>
761 <li><code>llvm::JITEmitDebugInfoToDisk</code></li>
762 <li><code>llvm::GuaranteedTailCallOpt</code></li>
763 <li><code>llvm::StackAlignmentOverride</code></li>
764 <li><code>llvm::RealignStack</code></li>
765 <li><code>llvm::DisableJumpTables</code></li>
766 <li><code>llvm::EnableFastISel</code></li>
767 <li><code>llvm::getTrapFunctionName()</code></li>
768 <li><code>llvm::EnableSegmentedStacks</code></li>
769 </ul></li>
770   <li>The MDBuilder class has been added to simplify the creation of
771       metadata.</li>
772   <li>....</li>
773 </ul>
774
775 </div>
776
777 <!--=========================================================================-->
778 <h3>
779 <a name="tools_changes">Tools Changes</a>
780 </h3>
781
782 <div>
783
784 <p>In addition, some tools have changed in this release. Some of the changes
785    are:</p>
786
787
788 <ul>
789   <li><tt>llvm-stress</tt> is a command line tool for generating random
790       <tt>.ll</tt> files to fuzz different LLVM components. </li>
791   <li>The <tt>llvm-ld</tt> tool has been removed.  The clang driver provides a
792       more reliable solution for turning a set of bitcode files into a binary.
793       To merge bitcode files <tt>llvm-link</tt> can be used instead.</li>
794   <li>....</li>
795 </ul>
796
797 </div>
798
799
800 <!--=========================================================================-->
801 <h3>
802 <a name="python">Python Bindings</a>
803 </h3>
804
805 <div>
806
807 <p>Officially supported Python bindings have been added! Feature support is far
808 from complete. The current bindings support interfaces to:</p>
809 <ul>
810   <li>Object File Interface</li>
811   <li>Disassembler</li>
812 </ul>
813
814 <p>Using the Object File Interface, it is possible to inspect binary object files.
815 Think of it as a Python version of readelf or llvm-objdump.</p>
816
817 <p>Support for additional features is currently being developed by community
818 contributors. If you are interested in shaping the direction of the Python
819 bindings, please express your intent on IRC or the developers list.</p>
820
821 </div>
822
823 </div>
824
825 <!-- *********************************************************************** -->
826 <h2>
827   <a name="knownproblems">Known Problems</a>
828 </h2>
829 <!-- *********************************************************************** -->
830
831 <div>
832
833 <p>LLVM is generally a production quality compiler, and is used by a broad range
834    of applications and shipping in many products.  That said, not every
835    subsystem is as mature as the aggregate, particularly the more obscure
836    targets.  If you run into a problem, please check the <a
837    href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
838    there isn't already one or ask on the <a
839     href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev
840     list</a>.</p>
841
842   <p>Known problem areas include:</p>
843
844 <ul>
845   <li>The CellSPU, MSP430, PTX and XCore backends are experimental.</li>
846
847   <li>The integrated assembler, disassembler, and JIT is not supported by
848       several targets.  If an integrated assembler is not supported, then a
849       system assembler is required.  For more details, see the <a
850       href="CodeGenerator.html#targetfeatures">Target Features Matrix</a>.
851   </li>
852 </ul>
853
854 </div>
855
856 <!-- *********************************************************************** -->
857 <h2>
858   <a name="additionalinfo">Additional Information</a>
859 </h2>
860 <!-- *********************************************************************** -->
861
862 <div>
863
864 <p>A wide variety of additional information is available on
865    the <a href="http://llvm.org/">LLVM web page</a>, in particular in
866    the <a href="http://llvm.org/docs/">documentation</a> section.  The web page
867    also contains versions of the API documentation which is up-to-date with the
868    Subversion version of the source code.  You can access versions of these
869    documents specific to this release by going into the "<tt>llvm/doc/</tt>"
870    directory in the LLVM tree.</p>
871
872 <p>If you have any questions or comments about LLVM, please feel free to contact
873    us via the <a href="http://llvm.org/docs/#maillist"> mailing lists</a>.</p>
874
875 </div>
876
877 <!-- *********************************************************************** -->
878
879 <hr>
880 <address>
881   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
882   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
883   <a href="http://validator.w3.org/check/referer"><img
884   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
885
886   <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
887   Last modified: $Date$
888 </address>
889
890 </body>
891 </html>