Fix grammar.
[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="llvm.css" type="text/css">
7   <title>LLVM 3.0 Release Notes</title>
8 </head>
9 <body>
10
11 <h1>LLVM 3.0 Release Notes</h1>
12
13 <img align=right src="http://llvm.org/img/DragonSmall.png"
14     width="136" height="136" alt="LLVM Dragon Logo">
15
16 <ol>
17   <li><a href="#intro">Introduction</a></li>
18   <li><a href="#subproj">Sub-project Status Update</a></li>
19   <li><a href="#externalproj">External Projects Using LLVM 3.0</a></li>
20   <li><a href="#whatsnew">What's New in LLVM 3.0?</a></li>
21   <li><a href="GettingStarted.html">Installation Instructions</a></li>
22   <li><a href="#knownproblems">Known Problems</a></li>
23   <li><a href="#additionalinfo">Additional Information</a></li>
24 </ol>
25
26 <div class="doc_author">
27   <p>Written by the <a href="http://llvm.org/">LLVM Team</a></p>
28 </div>
29
30 <!--
31 <h1 style="color:red">These are in-progress notes for the upcoming LLVM 3.0
32 release.<br>
33 You may prefer the
34 <a href="http://llvm.org/releases/2.9/docs/ReleaseNotes.html">LLVM 2.9
35 Release Notes</a>.</h1>
36  -->
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.0.  Here we describe the status of LLVM, including
48 major improvements from the previous release and significant known problems.
49 All LLVM releases may be downloaded from the <a
50 href="http://llvm.org/releases/">LLVM releases web site</a>.</p>
51
52 <p>For more information about LLVM, including information about the latest
53 release, please check out the <a href="http://llvm.org/">main LLVM
54 web site</a>.  If you have questions or comments, the <a
55 href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM Developer's
56 Mailing List</a> is a good place to send them.</p>
57
58 <p>Note that if you are reading this file from a Subversion checkout or the
59 main LLVM web page, this document applies to the <i>next</i> release, not the
60 current one.  To see the release notes for a specific release, please see the
61 <a href="http://llvm.org/releases/">releases page</a>.</p>
62
63 </div>
64    
65 <!-- Features that need text if they're finished for 3.1:
66   ARM EHABI
67   combiner-aa?
68   strong phi elim
69   loop dependence analysis
70   CorrelatedValuePropagation
71   lib/Transforms/IPO/MergeFunctions.cpp => consider for 3.1.
72  -->
73  
74 <!-- *********************************************************************** -->
75 <h2>
76   <a name="subproj">Sub-project Status Update</a>
77 </h2>
78 <!-- *********************************************************************** -->
79
80 <div>
81 <p>
82 The LLVM 3.0 distribution currently consists of code from the core LLVM
83 repository (which roughly includes the LLVM optimizers, code generators
84 and supporting tools), the Clang repository and the llvm-gcc repository.  In
85 addition to this code, the LLVM Project includes other sub-projects that are in
86 development.  Here we include updates on these subprojects.
87 </p>
88
89 <!--=========================================================================-->
90 <h3>
91 <a name="clang">Clang: C/C++/Objective-C Frontend Toolkit</a>
92 </h3>
93
94 <div>
95
96 <p><a href="http://clang.llvm.org/">Clang</a> is an LLVM front end for the C,
97 C++, and Objective-C languages. Clang aims to provide a better user experience
98 through expressive diagnostics, a high level of conformance to language
99 standards, fast compilation, and low memory use. Like LLVM, Clang provides a
100 modular, library-based architecture that makes it suitable for creating or
101 integrating with other development tools. Clang is considered a
102 production-quality compiler for C, Objective-C, C++ and Objective-C++ on x86
103 (32- and 64-bit), and for darwin/arm targets.</p>
104
105 <p>In the LLVM 3.0 time-frame, the Clang team has made many improvements:</p>
106
107 <ul>
108   <li>Greatly improved support for building C++ applications, with greater stability and better diagnostics.</li>
109   
110   <li><a href="http://clang.llvm.org/cxx_status.html">Improved support</a> for the <a href="http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=50372 ">C++ 2011</a> standard, including implementations of non-static data member initializers, alias templates, delegating constructors, the range-based for loop, and implicitly-generated move constructors and move assignment operators, among others.</li>
111
112   <li>Implemented support for some features of the upcoming C1x standard, including static assertions and generic selections.</li>
113   
114   <li>Better detection of include and linking paths for system headers and libraries, especially for Linux distributions.</li>
115
116   <li>Implemented support for <a href="http://clang.llvm.org/docs/AutomaticReferenceCounting.html">Automatic Reference Counting</a> for Objective-C.</li>
117
118   <li>Implemented a number of optimizations in <tt>libclang</tt>, the Clang C interface, to improve the performance of code completion and the mapping from source locations to abstract syntax tree nodes.</li>
119 </ul>
120
121   
122 <p>If Clang rejects your code but another compiler accepts it, please take a
123 look at the <a href="http://clang.llvm.org/compatibility.html">language
124 compatibility</a> guide to make sure this is not intentional or a known issue.
125 </p>
126
127 </div>
128
129 <!--=========================================================================-->
130 <h3>
131 <a name="dragonegg">DragonEgg: GCC front-ends, LLVM back-end</a>
132 </h3>
133
134 <div>
135 <p>
136 <a href="http://dragonegg.llvm.org/">DragonEgg</a> is a
137 <a href="http://gcc.gnu.org/wiki/plugins">gcc plugin</a> that replaces GCC's
138 optimizers and code generators with LLVM's.
139 Currently it requires a patched version of gcc-4.5.
140 The plugin can target the x86-32 and x86-64 processor families and has been
141 used successfully on the Darwin, FreeBSD and Linux platforms.
142 The Ada, C, C++ and Fortran languages work well.
143 The plugin is capable of compiling plenty of Obj-C, Obj-C++ and Java but it is
144 not known whether the compiled code actually works or not!
145 </p>
146
147 <p>
148 The 3.0 release has the following notable changes:
149 <ul>
150 <!--
151 <li></li>
152 -->
153 </ul>
154
155 </div>
156
157 <!--=========================================================================-->
158 <h3>
159 <a name="compiler-rt">compiler-rt: Compiler Runtime Library</a>
160 </h3>
161
162 <div>
163 <p>
164 The new LLVM <a href="http://compiler-rt.llvm.org/">compiler-rt project</a>
165 is a simple library that provides an implementation of the low-level
166 target-specific hooks required by code generation and other runtime components.
167 For example, when compiling for a 32-bit target, converting a double to a 64-bit
168 unsigned integer is compiled into a runtime call to the "__fixunsdfdi"
169 function. The compiler-rt library provides highly optimized implementations of
170 this and other low-level routines (some are 3x faster than the equivalent
171 libgcc routines).</p>
172
173 <p>In the LLVM 3.0 timeframe,</p>
174
175 </div>
176
177 <!--=========================================================================-->
178 <h3>
179 <a name="lldb">LLDB: Low Level Debugger</a>
180 </h3>
181
182 <div>
183 <p>
184 <a href="http://lldb.llvm.org/">LLDB</a> is a brand new member of the LLVM
185 umbrella of projects. LLDB is a next generation, high-performance debugger. It
186 is built as a set of reusable components which highly leverage existing
187 libraries in the larger LLVM Project, such as the Clang expression parser, the
188 LLVM disassembler and the LLVM JIT.</p>
189
190 <p>
191 LLDB is has advanced by leaps and bounds in the 3.0 timeframe.  It is
192 dramatically more stable and useful, and includes both a new <a 
193 href="http://lldb.llvm.org/tutorial.html">tutorial</a> and a <a
194 href="http://lldb.llvm.org/lldb-gdb.html">side-by-side comparison with 
195 GDB</a>.</p>
196
197 </div>
198
199 <!--=========================================================================-->
200 <h3>
201 <a name="libc++">libc++: C++ Standard Library</a>
202 </h3>
203
204 <div>
205 <p>
206 <a href="http://libcxx.llvm.org/">libc++</a> is another new member of the LLVM
207 family.  It is an implementation of the C++ standard library, written from the
208 ground up to specifically target the forthcoming C++'0X standard and focus on
209 delivering great performance.</p>
210
211 <p>
212 In the LLVM 3.0 timeframe,</p>
213   
214 <p>
215 Like compiler_rt, libc++ is now <a href="DeveloperPolicy.html#license">dual
216   licensed</a> under the MIT and UIUC license, allowing it to be used more
217   permissively.
218 </p>
219
220 </div>
221
222
223 <!--=========================================================================-->
224 <h3>
225 <a name="LLBrowse">LLBrowse: IR Browser</a>
226 </h3>
227
228 <div>
229 <p>
230 <a href="http://llvm.org/svn/llvm-project/llbrowse/trunk/doc/LLBrowse.html">
231   LLBrowse</a> is an interactive viewer for LLVM modules. It can load any LLVM
232   module and displays its contents as an expandable tree view, facilitating an
233   easy way to inspect types, functions, global variables, or metadata nodes. It
234   is fully cross-platform, being based on the popular wxWidgets GUI toolkit.
235 </p>
236 </div>
237
238 <!--=========================================================================-->
239 <h3>
240 <a name="vmkit">VMKit</a>
241 </h3>
242
243 <div>
244 <p>The <a href="http://vmkit.llvm.org/">VMKit project</a> is an implementation
245   of a Java Virtual Machine (Java VM or JVM) that uses LLVM for static and
246   just-in-time compilation. As of LLVM 3.0, VMKit now supports generational
247   garbage collectors. The garbage collectors are provided by the MMTk framework,
248   and VMKit can be configured to use one of the numerous implemented collectors
249   of MMTk.
250 </p>
251 </div>
252   
253   
254 <!--=========================================================================-->
255 <!--
256 <h3>
257 <a name="klee">KLEE: A Symbolic Execution Virtual Machine</a>
258 </h3>
259
260 <div>
261 <p>
262 <a href="http://klee.llvm.org/">KLEE</a> is a symbolic execution framework for
263 programs in LLVM bitcode form. KLEE tries to symbolically evaluate "all" paths
264 through the application and records state transitions that lead to fault
265 states. This allows it to construct testcases that lead to faults and can even
266 be used to verify some algorithms.
267 </p>
268
269 <p>UPDATE!</p>
270 </div>-->
271
272 </div>
273
274 <!-- *********************************************************************** -->
275 <h2>
276   <a name="externalproj">External Open Source Projects Using LLVM 3.0</a>
277 </h2>
278 <!-- *********************************************************************** -->
279
280 <div>
281
282 <p>An exciting aspect of LLVM is that it is used as an enabling technology for
283    a lot of other language and tools projects.  This section lists some of the
284    projects that have already been updated to work with LLVM 3.0.</p>
285
286 <!--=========================================================================-->
287 <h3>AddressSanitizer</h3>
288   
289 <div>
290
291 <p><a href="http://code.google.com/p/address-sanitizer/">AddressSanitizer</a>
292    uses compiler instrumentation and a specialized malloc library to find C/C++
293    bugs such as use-after-free and out-of-bound accesses to heap, stack, and
294    globals. The key feature of the tool is speed: the average slowdown
295    introduced by AddressSanitizer is less than 2x.</p>
296
297 </div>
298
299 <!--=========================================================================-->
300 <h3>ClamAV</h3>
301   
302 <div>
303
304 <p><a href="http://www.clamav.net">Clam AntiVirus</a> is an open source (GPL)
305    anti-virus toolkit for UNIX, designed especially for e-mail scanning on mail
306    gateways.</p>
307
308 <p>Since version 0.96 it
309    has <a href="http://vrt-sourcefire.blogspot.com/2010/09/introduction-to-clamavs-low-level.html">bytecode
310    signatures</a> that allow writing detections for complex malware.</p>
311
312 <p>It uses LLVM's JIT to speed up the execution of bytecode on X86, X86-64,
313    PPC32/64, falling back to its own interpreter otherwise.  The git version was
314    updated to work with LLVM 3.0.</p>
315
316 </div>
317
318 <!--=========================================================================-->
319 <!-- FIXME: Comment out
320 <h3>Crack Programming Language</h3>
321
322 <div>
323 <p>
324 <a href="http://code.google.com/p/crack-language/">Crack</a> aims to provide the
325 ease of development of a scripting language with the performance of a compiled
326 language. The language derives concepts from C++, Java and Python, incorporating
327 object-oriented programming, operator overloading and strong typing.</p>
328 </div>
329 -->  
330   
331 <!--=========================================================================-->
332 <h3>Glasgow Haskell Compiler (GHC)</h3>
333   
334 <div>
335
336 <p>GHC is an open source, state-of-the-art programming suite for Haskell, a
337    standard lazy functional programming language. It includes an optimizing
338    static compiler generating good code for a variety of platforms, together
339    with an interactive system for convenient, quick development.</p>
340
341 <p>GHC 7.0 and onwards include an LLVM code generator, supporting LLVM 2.8 and
342    later. Since LLVM 2.9, GHC now includes experimental support for the ARM
343    platform with LLVM 3.0.</p>
344
345 </div>
346
347 <!--=========================================================================-->
348 <h3>gwXscript</h3>
349
350 <div>
351
352 <p><a href="http://botwars.tk/gwscript/">gwXscript</a> is an object oriented,
353    aspect oriented programming language which can create both executables (ELF,
354    EXE) and shared libraries (DLL, SO, DYNLIB). The compiler is implemented in
355    its own language and translates scripts into LLVM-IR which can be optimized
356    and translated into native code by the LLVM framework. Source code in
357    gwScript contains definitions that expand the namespaces. So you can build
358    your project and simply 'plug out' features by removing a file. The remaining
359    project does not leave scars since you directly separate concerns by the
360    'template' feature of gwX. It is also possible to add new features to a
361    project by just adding files and without editing the original project. This
362    language is used for example to create games or content management systems
363    that should be extendable.</p>
364
365 <p>gwXscript is strongly typed and offers comfort with its native types string,
366    hash and array. You can easily write new libraries in gwXscript or native
367    code. gwXscript is type safe and users should not be able to crash your
368    program or execute malicious code except code that is eating CPU time.</p>
369
370 </div>
371
372 <!--=========================================================================-->
373 <h3>Mono</h3>
374
375 <div>
376
377 <p>An open source, cross-platform implementation of C# and the CLR that is
378    binary compatible with Microsoft.NET. Has an optional, dynamically-loaded
379    LLVM code generation backend in Mini, the JIT compiler.</p>
380
381 <p>Note that we use a Git mirror of LLVM with some patches. See:
382    https://github.com/mono/llvm</p>
383
384 </div>
385
386 <!--=========================================================================-->
387 <h3>Portable OpenCL (pocl)</h3>
388
389 <div>
390
391 <p>Portable OpenCL is an open source implementation of the OpenCL standard which
392    can be easily adapted for new targets. One of the goals of the project is
393    improving performance portability of OpenCL programs, avoiding the need for
394    target-dependent manual optimizations. A "native" target is included, which
395    allows running OpenCL kernels on the host (CPU).</p>
396
397 </div>
398
399 <!--=========================================================================-->
400 <h3>Pure</h3>
401   
402 <div>
403 <p><a href="http://pure-lang.googlecode.com/">Pure</a> is an
404   algebraic/functional programming language based on term rewriting. Programs
405   are collections of equations which are used to evaluate expressions in a
406   symbolic fashion. The interpreter uses LLVM as a backend to JIT-compile Pure
407   programs to fast native code. Pure offers dynamic typing, eager and lazy
408   evaluation, lexical closures, a hygienic macro system (also based on term
409   rewriting), built-in list and matrix support (including list and matrix
410   comprehensions) and an easy-to-use interface to C and other programming
411   languages (including the ability to load LLVM bitcode modules, and inline C,
412   C++, Fortran and Faust code in Pure programs if the corresponding LLVM-enabled
413   compilers are installed).</p>
414   
415 <p>Pure version 0.48 has been tested and is known to work with LLVM 3.0
416   (and continues to work with older LLVM releases &gt;= 2.5).</p>
417
418 </div>
419
420 <!--=========================================================================-->
421 <h3>Renderscript</h3>
422
423 <div>
424
425 <p><a href="http://developer.android.com/guide/topics/renderscript/index.html">Renderscript</a>
426    is Android's advanced 3D graphics rendering and compute API. It provides a
427    portable C99-based language with extensions to facilitate common use cases
428    for enhancing graphics and thread level parallelism. The Renderscript
429    compiler frontend is based on Clang/LLVM. It emits a portable bitcode format
430    for the actual compiled script code, as well as reflects a Java interface for
431    developers to control the execution of the compiled bitcode. Executable
432    machine code is then generated from this bitcode by an LLVM backend on the
433    device. Renderscript is thus able to provide a mechanism by which Android
434    developers can improve performance of their applications while retaining
435    portability.</p>
436
437 </div>
438
439 <!--=========================================================================-->
440 <h3>SAFECode</h3>
441
442 <div>
443
444 <p><a href="http://safecode.cs.illinois.edu">SAFECode</a> is a memory safe C/C++
445    compiler built using LLVM.  It takes standard, unannotated C/C++ code,
446    analyzes the code to ensure that memory accesses and array indexing
447    operations are safe, and instruments the code with run-time checks when
448    safety cannot be proven statically.  SAFECode can be used as a debugging aid
449    (like Valgrind) to find and repair memory safety bugs.  It can also be used
450    to protect code from security attacks at run-time.</p>
451
452 </div>
453
454 <!--=========================================================================-->
455 <h3>TTA-based Co-design Environment (TCE)</h3>
456
457 <div>
458
459 <p>TCE is a toolset for designing application-specific processors (ASP) based on
460    the Transport triggered architecture (TTA). The toolset provides a complete
461    co-design flow from C/C++ programs down to synthesizable VHDL and parallel
462    program binaries. Processor customization points include the register files,
463    function units, supported operations, and the interconnection network.</p>
464
465 <p>TCE uses Clang and LLVM for C/C++ language support, target independent
466    optimizations and also for parts of code generation. It generates new
467    LLVM-based code generators <i>on the fly</i> for the designed TTA processors
468    and loads them in to the compiler backend as runtime libraries to avoid
469    per-target recompilation of larger parts of the compiler chain.</p>
470 </div>
471
472   
473 <!--=========================================================================-->
474 <h3>Tart Programming Language</h3>
475
476 <div>
477
478 <p><a href="http://code.google.com/p/tart/">Tart</a> is a general-purpose,
479    strongly typed programming language designed for application
480    developers. Strongly inspired by Python and C#, Tart focuses on practical
481    solutions for the professional software developer, while avoiding the clutter
482    and boilerplate of legacy languages like Java and C++. Although Tart is still
483    in development, the current implementation supports many features expected of
484    a modern programming language, such as garbage collection, powerful
485    bidirectional type inference, a greatly simplified syntax for template
486    metaprogramming, closures and function literals, reflection, operator
487    overloading, explicit mutability and immutability, and much more. Tart is
488    flexible enough to accommodate a broad range of programming styles and
489    philosophies, while maintaining a strong commitment to simplicity, minimalism
490    and elegance in design.</p>
491
492 </div>
493
494 <!--=========================================================================-->
495 <!--
496 <h3>PinaVM</h3>
497   
498 <div>
499 <p><a href="http://gitorious.org/pinavm/pages/Home">PinaVM</a> is an open
500 source, <a href="http://www.systemc.org/">SystemC</a> front-end. Unlike many
501 other front-ends, PinaVM actually executes the elaboration of the
502 program analyzed using LLVM's JIT infrastructure. It later enriches the
503 bitcode with SystemC-specific information.</p>
504 </div>
505 -->
506
507
508 <!--=========================================================================-->
509 <!--
510 <h3 id="icedtea">IcedTea Java Virtual Machine Implementation</h3>
511
512 <div>
513 <p>
514 <a href="http://icedtea.classpath.org/wiki/Main_Page">IcedTea</a> provides a
515 harness to build OpenJDK using only free software build tools and to provide
516 replacements for the not-yet free parts of OpenJDK.  One of the extensions that
517 IcedTea provides is a new JIT compiler named <a
518 href="http://icedtea.classpath.org/wiki/ZeroSharkFaq">Shark</a> which uses LLVM
519 to provide native code generation without introducing processor-dependent
520 code.
521 </p>
522
523 <p> OpenJDK 7 b112, IcedTea6 1.9 and IcedTea7 1.13 and later have been tested
524 and are known to work with LLVM 3.0 (and continue to work with older LLVM
525 releases &gt;= 2.6 as well).</p>
526 </div>
527 -->
528
529 <!--=========================================================================-->
530 <!--
531 <h3>Polly - Polyhedral optimizations for LLVM</h3>
532   
533 <div>
534 <p>Polly is a project that aims to provide advanced memory access optimizations
535 to better take advantage of SIMD units, cache hierarchies, multiple cores or
536 even vector accelerators for LLVM. Built around an abstract mathematical
537 description based on Z-polyhedra, it provides the infrastructure to develop
538 advanced optimizations in LLVM and to connect complex external optimizers. In
539 its first year of existence Polly already provides an exact value-based
540 dependency analysis as well as basic SIMD and OpenMP code generation support.
541 Furthermore, Polly can use PoCC(Pluto) an advanced optimizer for data-locality
542 and parallelism.</p>
543 </div>
544 -->
545
546 <!--=========================================================================-->
547 <!--
548 <h3>Rubinius</h3>
549
550 <div>
551   <p><a href="http://github.com/evanphx/rubinius">Rubinius</a> is an environment
552   for running Ruby code which strives to write as much of the implementation in
553   Ruby as possible. Combined with a bytecode interpreting VM, it uses LLVM to
554   optimize and compile ruby code down to machine code. Techniques such as type
555   feedback, method inlining, and deoptimization are all used to remove dynamism
556   from ruby execution and increase performance.</p>
557 </div>
558 -->
559
560 <!--=========================================================================-->
561 <!--
562 <h3>
563 <a name="FAUST">FAUST Real-Time Audio Signal Processing Language</a>
564 </h3>
565
566 <div>
567 <p>
568 <a href="http://faust.grame.fr">FAUST</a> is a compiled language for real-time
569 audio signal processing. The name FAUST stands for Functional AUdio STream. Its
570 programming model combines two approaches: functional programming and block
571 diagram composition. In addition with the C, C++, JAVA output formats, the
572 Faust compiler can now generate LLVM bitcode, and works with LLVM 2.7-3.0.</p>
573
574 </div>
575 -->
576   
577 </div>
578
579 <!-- *********************************************************************** -->
580 <h2>
581   <a name="whatsnew">What's New in LLVM 3.0?</a>
582 </h2>
583 <!-- *********************************************************************** -->
584
585 <div>
586
587 <p>This release includes a huge number of bug fixes, performance tweaks and
588 minor improvements.  Some of the major improvements and new features are listed
589 in this section.
590 </p>
591
592 <!--=========================================================================-->
593 <h3>
594 <a name="majorfeatures">Major New Features</a>
595 </h3>
596
597 <div>
598
599 <p>LLVM 3.0 includes several major new capabilities:</p>
600
601 <ul>
602
603 <!--
604 <li></li>
605 -->
606   
607 </ul>
608   
609 </div>
610
611 <!--=========================================================================-->
612 <h3>
613 <a name="coreimprovements">LLVM IR and Core Improvements</a>
614 </h3>
615
616 <div>
617 <p>LLVM IR has several new features for better support of new targets and that
618 expose new optimization opportunities:</p>
619
620 <ul>
621 <!--
622 <li></li>
623 -->
624 </ul>
625
626 </div>
627
628 <!--=========================================================================-->
629 <h3>
630 <a name="optimizer">Optimizer Improvements</a>
631 </h3>
632
633 <div>
634
635 <p>In addition to a large array of minor performance tweaks and bug fixes, this
636 release includes a few major enhancements and additions to the optimizers:</p>
637
638 <ul>
639 <!--
640 <li></li>
641 -->
642 </li>
643   
644 </ul>
645
646 </div>
647
648 <!--=========================================================================-->
649 <h3>
650 <a name="mc">MC Level Improvements</a>
651 </h3>
652
653 <div>
654 <p>
655 The LLVM Machine Code (aka MC) subsystem was created to solve a number
656 of problems in the realm of assembly, disassembly, object file format handling,
657 and a number of other related areas that CPU instruction-set level tools work
658 in.</p>
659
660 <ul>
661 <!--
662 <li></li>
663 -->
664 </ul>
665
666 <p>For more information, please see the <a
667 href="http://blog.llvm.org/2010/04/intro-to-llvm-mc-project.html">Intro to the
668 LLVM MC Project Blog Post</a>.
669 </p>
670
671 </div>
672
673 <!--=========================================================================-->
674 <h3>
675 <a name="codegen">Target Independent Code Generator Improvements</a>
676 </h3>
677
678 <div>
679
680 <p>We have put a significant amount of work into the code generator
681 infrastructure, which allows us to implement more aggressive algorithms and make
682 it run faster:</p>
683
684 <ul>
685 <!--
686 <li></li>
687 -->
688 </ul>
689 </div>
690
691 <!--=========================================================================-->
692 <h3>
693 <a name="x86">X86-32 and X86-64 Target Improvements</a>
694 </h3>
695
696 <div>
697 <p>New features and major changes in the X86 target include:
698 </p>
699
700 <ul>
701 <li>The CRC32 intrinsics have been renamed.  The intrinsics were previously
702   @llvm.x86.sse42.crc32.[8|16|32] and @llvm.x86.sse42.crc64.[8|64].  They have
703   been renamed to @llvm.x86.sse42.crc32.32.[8|16|32] and 
704   @llvm.x86.sse42.crc32.64.[8|64].</li>
705
706 </ul>
707
708 </div>
709
710 <!--=========================================================================-->
711 <h3>
712 <a name="ARM">ARM Target Improvements</a>
713 </h3>
714
715 <div>
716 <p>New features of the ARM target include:
717 </p>
718
719 <ul>
720 <!--
721 <li></li>
722 -->
723 </ul>
724 </div>
725   
726 <!--=========================================================================-->
727 <h3>
728 <a name="OtherTS">Other Target Specific Improvements</a>
729 </h3>
730
731 <div>
732 <ul>
733 <!--
734 <li></li>
735 -->
736 </ul>
737 </div>
738
739 <!--=========================================================================-->
740 <h3>
741 <a name="changes">Major Changes and Removed Features</a>
742 </h3>
743
744 <div>
745
746 <p>If you're already an LLVM user or developer with out-of-tree changes based on
747    LLVM 2.9, this section lists some "gotchas" that you may run into upgrading
748    from the previous release.</p>
749
750 <ul>
751   <li>The <code>LLVMC</code> front end code was removed while separating
752       out language independence.</li>
753   <li>The <code>LowerSetJmp</code> pass wasn't used effectively by any
754       target and has been removed.</li>
755   <li>The old <code>TailDup</code> pass was not used in the standard pipeline
756       and was unable to update ssa form, so it has been removed.
757   <li>The syntax of volatile loads and stores in IR has been changed to
758       "<code>load volatile</code>"/"<code>store volatile</code>".  The old
759       syntax ("<code>volatile load</code>"/"<code>volatile store</code>")
760       is still accepted, but is now considered deprecated.</li>
761   <li>The old atomic intrinscs (<code>llvm.memory.barrier</code> and
762       <code>llvm.atomic.*</code>) are now gone.  Please use the new atomic
763       instructions, described in the <a href="Atomics.html">atomics guide</a>.
764 </ul>
765
766 <h4>Windows (32-bit)</h4>
767 <div>
768 <ul>
769   <li>On Win32(MinGW32 and MSVC), Windows 2000 will not be supported.
770       Windows XP or higher is required.</li>
771 </ul>
772 </div>
773
774 </div>
775
776 <!--=========================================================================-->
777 <h3>
778 <a name="api_changes">Internal API Changes</a>
779 </h3>
780
781 <div>
782
783 <p>In addition, many APIs have changed in this release.  Some of the major
784    LLVM API changes are:</p>
785
786 <ul>
787 <li>The biggest and most pervasive change is that llvm::Type's are no longer
788     returned or accepted as 'const' values.  Instead, just pass around non-const
789     Type's.</li>
790   
791 <li><code>PHINode::reserveOperandSpace</code> has been removed. Instead, you
792   must specify how many operands to reserve space for when you create the
793   PHINode, by passing an extra argument into <code>PHINode::Create</code>.</li>
794
795 <li>PHINodes no longer store their incoming BasicBlocks as operands. Instead,
796   the list of incoming BasicBlocks is stored separately, and can be accessed
797   with new functions <code>PHINode::block_begin</code>
798   and <code>PHINode::block_end</code>.</li>
799
800 <li>Various functions now take an <code>ArrayRef</code> instead of either a pair
801   of pointers (or iterators) to the beginning and end of a range, or a pointer
802   and a length. Others now return an <code>ArrayRef</code> instead of a
803   reference to a <code>SmallVector</code> or <code>std::vector</code>. These
804   include:
805 <ul>
806 <!-- Please keep this list sorted. -->
807 <li><code>CallInst::Create</code></li>
808 <li><code>ComputeLinearIndex</code> (in <code>llvm/CodeGen/Analysis.h</code>)</li>
809 <li><code>ConstantArray::get</code></li>
810 <li><code>ConstantExpr::getExtractElement</code></li>
811 <li><code>ConstantExpr::getGetElementPtr</code></li>
812 <li><code>ConstantExpr::getInBoundsGetElementPtr</code></li>
813 <li><code>ConstantExpr::getIndices</code></li>
814 <li><code>ConstantExpr::getInsertElement</code></li>
815 <li><code>ConstantExpr::getWithOperands</code></li>
816 <li><code>ConstantFoldCall</code> (in <code>llvm/Analysis/ConstantFolding.h</code>)</li>
817 <li><code>ConstantFoldInstOperands</code> (in <code>llvm/Analysis/ConstantFolding.h</code>)</li>
818 <li><code>ConstantVector::get</code></li>
819 <li><code>DIBuilder::createComplexVariable</code></li>
820 <li><code>DIBuilder::getOrCreateArray</code></li>
821 <li><code>ExtractValueInst::Create</code></li>
822 <li><code>ExtractValueInst::getIndexedType</code></li>
823 <li><code>ExtractValueInst::getIndices</code></li>
824 <li><code>FindInsertedValue</code> (in <code>llvm/Analysis/ValueTracking.h</code>)</li>
825 <li><code>gep_type_begin</code> (in <code>llvm/Support/GetElementPtrTypeIterator.h</code>)</li>
826 <li><code>gep_type_end</code> (in <code>llvm/Support/GetElementPtrTypeIterator.h</code>)</li>
827 <li><code>GetElementPtrInst::Create</code></li>
828 <li><code>GetElementPtrInst::CreateInBounds</code></li>
829 <li><code>GetElementPtrInst::getIndexedType</code></li>
830 <li><code>InsertValueInst::Create</code></li>
831 <li><code>InsertValueInst::getIndices</code></li>
832 <li><code>InvokeInst::Create</code></li>
833 <li><code>IRBuilder::CreateCall</code></li>
834 <li><code>IRBuilder::CreateExtractValue</code></li>
835 <li><code>IRBuilder::CreateGEP</code></li>
836 <li><code>IRBuilder::CreateInBoundsGEP</code></li>
837 <li><code>IRBuilder::CreateInsertValue</code></li>
838 <li><code>IRBuilder::CreateInvoke</code></li>
839 <li><code>MDNode::get</code></li>
840 <li><code>MDNode::getIfExists</code></li>
841 <li><code>MDNode::getTemporary</code></li>
842 <li><code>MDNode::getWhenValsUnresolved</code></li>
843 <li><code>SimplifyGEPInst</code> (in <code>llvm/Analysis/InstructionSimplify.h</code>)</li>
844 <li><code>TargetData::getIndexedOffset</code></li>
845 </ul></li>
846
847 <li>All forms of <code>StringMap::getOrCreateValue</code> have been remove
848   except for the one which takes a <code>StringRef</code>.</li>
849
850 <li>The <code>LLVMBuildUnwind</code> function from the C API was removed. The
851     LLVM <code>unwind</code> instruction has been deprecated for a long time and
852     isn't used by the current front-ends. So this was removed during the
853     exception handling rewrite.</li>
854
855 <li>The <code>LLVMAddLowerSetJmpPass</code> function from the C API was removed
856     because the <code>LowerSetJmp</code> pass was removed.</li>
857
858 <li>The <code>DIBuilder</code> interface used by front ends to encode debugging 
859     information in the LLVM IR now expects clients to use <code>DIBuilder::finalize()</code>
860     at the end of translation unit to complete debugging information encoding.</li>
861
862 <li>The way the type system works has been rewritten: <code>PATypeHolder</code>
863 and <code>OpaqueType</code> are gone, and all APIs deal with <code>Type*</code>
864 instead of <code>const Type*</code>.
865 If you need to create recursive structures, then create a named structure,
866 and use <code>setBody()</code> when all its elements are built.
867 Type merging and refining is gone too: named structures are not
868 merged with other structures, even if their layout is identical.
869 (of course anonymous structures are still uniqued by layout).
870 </li>
871
872 <li>TargetSelect.h moved to Support/ from Target/</li>
873
874 <li>UpgradeIntrinsicCall no longer upgrades pre-2.9 intrinsic calls
875 (for example <code>llvm.memset.i32</code>).</li>
876
877 <li>It is mandatory to initialize all out-of-tree passes too and their dependencies now with
878 <code>INITIALIZE_PASS{BEGIN,END,}</code> and <code>INITIALIZE_{PASS,AG}_DEPENDENCY</code>.</li>
879
880 <li>The interface for MemDepResult in MemoryDependenceAnalysis has been enhanced
881     with new return types Unknown and NonFuncLocal, in addition to the existing
882     types Clobber, Def, and NonLocal.</li>
883
884 </ul>
885 </div>
886
887 </div>
888
889 <!-- *********************************************************************** -->
890 <h2>
891   <a name="knownproblems">Known Problems</a>
892 </h2>
893 <!-- *********************************************************************** -->
894
895 <div>
896
897 <p>This section contains significant known problems with the LLVM system,
898 listed by component.  If you run into a problem, please check the <a
899 href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
900 there isn't already one.</p>
901
902 <!-- ======================================================================= -->
903 <h3>
904   <a name="experimental">Experimental features included with this release</a>
905 </h3>
906
907 <div>
908
909 <p>The following components of this LLVM release are either untested, known to
910 be broken or unreliable, or are in early development.  These components should
911 not be relied on, and bugs should not be filed against them, but they may be
912 useful to some people.  In particular, if you would like to work on one of these
913 components, please contact us on the <a
914 href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p>
915
916 <ul>
917 <li>The Alpha, CellSPU, MicroBlaze, MSP430, MIPS, PTX,
918     and XCore backends are experimental.</li>
919 <li><tt>llc</tt> "<tt>-filetype=obj</tt>" is experimental on all targets
920     other than darwin and ELF X86 systems.</li>
921     
922 </ul>
923
924 </div>
925
926 <!-- ======================================================================= -->
927 <h3>
928   <a name="x86-be">Known problems with the X86 back-end</a>
929 </h3>
930
931 <div>
932
933 <ul>
934   <li>The X86 backend does not yet support
935     all <a href="http://llvm.org/PR879">inline assembly that uses the X86
936     floating point stack</a>.  It supports the 'f' and 't' constraints, but not
937     'u'.</li>
938   <li>The X86-64 backend does not yet support the LLVM IR instruction
939       <tt>va_arg</tt>. Currently, front-ends support variadic
940       argument constructs on X86-64 by lowering them manually.</li>
941   <li>Windows x64 (aka Win64) code generator has a few issues.
942     <ul>
943       <li>llvm-gcc cannot build the mingw-w64 runtime currently
944        due to lack of support for the 'u' inline assembly
945        constraint and for X87 floating point inline assembly.</li>
946       <li>On mingw-w64, you will see unresolved symbol <tt>__chkstk</tt>
947        due to <a href="http://llvm.org/bugs/show_bug.cgi?id=8919">Bug 8919</a>.
948        It is fixed in <a href="http://lists.cs.uiuc.edu/pipermail/llvm-commits/Week-of-Mon-20110321/118499.html">r128206</a>.</li>
949       <li>Miss-aligned MOVDQA might crash your program. It is due to
950        <a href="http://llvm.org/bugs/show_bug.cgi?id=9483">Bug 9483</a>,
951        lack of handling aligned internal globals.</li>
952       </ul>
953   </li>
954
955 </ul>
956
957 </div>
958
959 <!-- ======================================================================= -->
960 <h3>
961   <a name="ppc-be">Known problems with the PowerPC back-end</a>
962 </h3>
963
964 <div>
965
966 <ul>
967 <li>The Linux PPC32/ABI support needs testing for the interpreter and static
968 compilation, and lacks support for debug information.</li>
969 </ul>
970
971 </div>
972
973 <!-- ======================================================================= -->
974 <h3>
975   <a name="arm-be">Known problems with the ARM back-end</a>
976 </h3>
977
978 <div>
979
980 <ul>
981 <li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
982 processors, thumb programs can crash or produce wrong
983 results (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
984 <li>Compilation for ARM Linux OABI (old ABI) is supported but not fully tested.
985 </li>
986 </ul>
987
988 </div>
989
990 <!-- ======================================================================= -->
991 <h3>
992   <a name="sparc-be">Known problems with the SPARC back-end</a>
993 </h3>
994
995 <div>
996
997 <ul>
998 <li>The SPARC backend only supports the 32-bit SPARC ABI (-m32); it does not
999     support the 64-bit SPARC ABI (-m64).</li>
1000 </ul>
1001
1002 </div>
1003
1004 <!-- ======================================================================= -->
1005 <h3>
1006   <a name="mips-be">Known problems with the MIPS back-end</a>
1007 </h3>
1008
1009 <div>
1010
1011 <ul>
1012 <li>64-bit MIPS targets are not supported yet.</li>
1013 </ul>
1014
1015 </div>
1016
1017 <!-- ======================================================================= -->
1018 <h3>
1019   <a name="alpha-be">Known problems with the Alpha back-end</a>
1020 </h3>
1021
1022 <div>
1023
1024 <ul>
1025
1026 <li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
1027 appropriate nops inserted to ensure restartability.</li>
1028
1029 </ul>
1030 </div>
1031
1032 <!-- ======================================================================= -->
1033 <h3>
1034   <a name="c-be">Known problems with the C back-end</a>
1035 </h3>
1036
1037 <div>
1038
1039 <p>The C backend has numerous problems and is not being actively maintained.
1040 Depending on it for anything serious is not advised.</p>
1041
1042 <ul>
1043 <li><a href="http://llvm.org/PR802">The C backend has only basic support for
1044     inline assembly code</a>.</li>
1045 <li><a href="http://llvm.org/PR1658">The C backend violates the ABI of common
1046     C++ programs</a>, preventing intermixing between C++ compiled by the CBE and
1047     C++ code compiled with <tt>llc</tt> or native compilers.</li>
1048 <li>The C backend does not support all exception handling constructs.</li>
1049 <li>The C backend does not support arbitrary precision integers.</li>
1050 </ul>
1051
1052 </div>
1053
1054
1055 <!-- ======================================================================= -->
1056 <h3>
1057   <a name="llvm-gcc">Known problems with the llvm-gcc front-end</a>
1058 </h3>
1059
1060 <div>
1061
1062 <p><b>LLVM 3.0 will be the last release of llvm-gcc.</b></p>
1063
1064 <p>llvm-gcc is generally very stable for the C family of languages.  The only
1065    major language feature of GCC not supported by llvm-gcc is the
1066    <tt>__builtin_apply</tt> family of builtins.   However, some extensions
1067    are only supported on some targets.  For example, trampolines are only
1068    supported on some targets (these are used when you take the address of a
1069    nested function).</p>
1070
1071 <p>Fortran support generally works, but there are still several unresolved bugs
1072    in <a href="http://llvm.org/bugs/">Bugzilla</a>.  Please see the
1073    tools/gfortran component for details.  Note that llvm-gcc is missing major
1074    Fortran performance work in the frontend and library that went into GCC after
1075    4.2.  If you are interested in Fortran, we recommend that you consider using
1076    <a href="#dragonegg">dragonegg</a> instead.</p>
1077
1078 <p>The llvm-gcc 4.2 Ada compiler has basic functionality, but is no longer being
1079 actively maintained.  If you are interested in Ada, we recommend that you
1080 consider using <a href="#dragonegg">dragonegg</a> instead.</p>
1081 </div>
1082
1083 </div>
1084
1085 <!-- *********************************************************************** -->
1086 <h2>
1087   <a name="additionalinfo">Additional Information</a>
1088 </h2>
1089 <!-- *********************************************************************** -->
1090
1091 <div>
1092
1093 <p>A wide variety of additional information is available on the <a
1094 href="http://llvm.org/">LLVM web page</a>, in particular in the <a
1095 href="http://llvm.org/docs/">documentation</a> section.  The web page also
1096 contains versions of the API documentation which is up-to-date with the
1097 Subversion version of the source code.
1098 You can access versions of these documents specific to this release by going
1099 into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
1100
1101 <p>If you have any questions or comments about LLVM, please feel free to contact
1102 us via the <a href="http://llvm.org/docs/#maillist"> mailing
1103 lists</a>.</p>
1104
1105 </div>
1106
1107 <!-- *********************************************************************** -->
1108
1109 <hr>
1110 <address>
1111   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
1112   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
1113   <a href="http://validator.w3.org/check/referer"><img
1114   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
1115
1116   <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
1117   Last modified: $Date$
1118 </address>
1119
1120 </body>
1121 </html>