20413485e285cbb48d72694355d287d4272e3bb7
[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 <h3>clReflect</h3>
320
321 <div>
322
323 <p><a href="https://bitbucket.org/dwilliamson/clreflect">clReflect</a> is a C++
324    parser that uses clang/LLVM to derive a light-weight reflection database
325    suitable for use in game development. It comes with a very simple runtime
326    library for loading and querying the database, requiring no external
327    dependencies (including CRT), and an additional utility library for object
328    management and serialisation.</p>
329
330 </div>
331
332 <!--=========================================================================-->
333 <!-- FIXME: Comment out
334 <h3>Crack Programming Language</h3>
335
336 <div>
337 <p>
338 <a href="http://code.google.com/p/crack-language/">Crack</a> aims to provide the
339 ease of development of a scripting language with the performance of a compiled
340 language. The language derives concepts from C++, Java and Python, incorporating
341 object-oriented programming, operator overloading and strong typing.</p>
342 </div>
343 -->  
344   
345 <!--=========================================================================-->
346 <h3>Glasgow Haskell Compiler (GHC)</h3>
347   
348 <div>
349
350 <p>GHC is an open source, state-of-the-art programming suite for Haskell, a
351    standard lazy functional programming language. It includes an optimizing
352    static compiler generating good code for a variety of platforms, together
353    with an interactive system for convenient, quick development.</p>
354
355 <p>GHC 7.0 and onwards include an LLVM code generator, supporting LLVM 2.8 and
356    later. Since LLVM 2.9, GHC now includes experimental support for the ARM
357    platform with LLVM 3.0.</p>
358
359 </div>
360
361 <!--=========================================================================-->
362 <h3>gwXscript</h3>
363
364 <div>
365
366 <p><a href="http://botwars.tk/gwscript/">gwXscript</a> is an object oriented,
367    aspect oriented programming language which can create both executables (ELF,
368    EXE) and shared libraries (DLL, SO, DYNLIB). The compiler is implemented in
369    its own language and translates scripts into LLVM-IR which can be optimized
370    and translated into native code by the LLVM framework. Source code in
371    gwScript contains definitions that expand the namespaces. So you can build
372    your project and simply 'plug out' features by removing a file. The remaining
373    project does not leave scars since you directly separate concerns by the
374    'template' feature of gwX. It is also possible to add new features to a
375    project by just adding files and without editing the original project. This
376    language is used for example to create games or content management systems
377    that should be extendable.</p>
378
379 <p>gwXscript is strongly typed and offers comfort with its native types string,
380    hash and array. You can easily write new libraries in gwXscript or native
381    code. gwXscript is type safe and users should not be able to crash your
382    program or execute malicious code except code that is eating CPU time.</p>
383
384 </div>
385
386 <!--=========================================================================-->
387 <h3>LanguageKit and Pragmatic Smalltalk</h3>
388
389 <div>
390
391 <p><a href="http://etoileos.com/etoile/features/languagekit/">LanguageKit</a> is
392    a framework for implementing dynamic languages sharing an object model with
393    Objective-C. It provides static and JIT compilation using LLVM along with
394    its own interpreter. Pragmatic Smalltalk is a dialect of Smalltalk, built on
395    top of LanguageKit, that interfaces directly with Objective-C, sharing the
396    same object representation and message sending behaviour. These projects are
397    developed as part of the &Eacute;toi&eacute; desktop environment.</p>
398
399 </div>
400
401 <!--=========================================================================-->
402 <h3>Mono</h3>
403
404 <div>
405
406 <p>An open source, cross-platform implementation of C# and the CLR that is
407    binary compatible with Microsoft.NET. Has an optional, dynamically-loaded
408    LLVM code generation backend in Mini, the JIT compiler.</p>
409
410 <p>Note that we use a Git mirror of LLVM with some patches. See:
411    https://github.com/mono/llvm</p>
412
413 </div>
414
415 <!--=========================================================================-->
416 <h3>Portable OpenCL (pocl)</h3>
417
418 <div>
419
420 <p>Portable OpenCL is an open source implementation of the OpenCL standard which
421    can be easily adapted for new targets. One of the goals of the project is
422    improving performance portability of OpenCL programs, avoiding the need for
423    target-dependent manual optimizations. A "native" target is included, which
424    allows running OpenCL kernels on the host (CPU).</p>
425
426 </div>
427
428 <!--=========================================================================-->
429 <h3>Pure</h3>
430   
431 <div>
432 <p><a href="http://pure-lang.googlecode.com/">Pure</a> is an
433   algebraic/functional programming language based on term rewriting. Programs
434   are collections of equations which are used to evaluate expressions in a
435   symbolic fashion. The interpreter uses LLVM as a backend to JIT-compile Pure
436   programs to fast native code. Pure offers dynamic typing, eager and lazy
437   evaluation, lexical closures, a hygienic macro system (also based on term
438   rewriting), built-in list and matrix support (including list and matrix
439   comprehensions) and an easy-to-use interface to C and other programming
440   languages (including the ability to load LLVM bitcode modules, and inline C,
441   C++, Fortran and Faust code in Pure programs if the corresponding LLVM-enabled
442   compilers are installed).</p>
443   
444 <p>Pure version 0.48 has been tested and is known to work with LLVM 3.0
445   (and continues to work with older LLVM releases &gt;= 2.5).</p>
446
447 </div>
448
449 <!--=========================================================================-->
450 <h3>Renderscript</h3>
451
452 <div>
453
454 <p><a href="http://developer.android.com/guide/topics/renderscript/index.html">Renderscript</a>
455    is Android's advanced 3D graphics rendering and compute API. It provides a
456    portable C99-based language with extensions to facilitate common use cases
457    for enhancing graphics and thread level parallelism. The Renderscript
458    compiler frontend is based on Clang/LLVM. It emits a portable bitcode format
459    for the actual compiled script code, as well as reflects a Java interface for
460    developers to control the execution of the compiled bitcode. Executable
461    machine code is then generated from this bitcode by an LLVM backend on the
462    device. Renderscript is thus able to provide a mechanism by which Android
463    developers can improve performance of their applications while retaining
464    portability.</p>
465
466 </div>
467
468 <!--=========================================================================-->
469 <h3>SAFECode</h3>
470
471 <div>
472
473 <p><a href="http://safecode.cs.illinois.edu">SAFECode</a> is a memory safe C/C++
474    compiler built using LLVM.  It takes standard, unannotated C/C++ code,
475    analyzes the code to ensure that memory accesses and array indexing
476    operations are safe, and instruments the code with run-time checks when
477    safety cannot be proven statically.  SAFECode can be used as a debugging aid
478    (like Valgrind) to find and repair memory safety bugs.  It can also be used
479    to protect code from security attacks at run-time.</p>
480
481 </div>
482
483 <!--=========================================================================-->
484 <h3>The Stupid D Compiler (SDC)</h3>
485
486 <div>
487
488 <p><a href="https://github.com/bhelyer/SDC">The Stupid D Compiler</a> is a
489    project seeking to write a self-hosting compiler for the D programming
490    language without using the frontend of the reference compiler (DMD).</p>
491
492 </div>
493
494 <!--=========================================================================-->
495 <h3>TTA-based Co-design Environment (TCE)</h3>
496
497 <div>
498
499 <p>TCE is a toolset for designing application-specific processors (ASP) based on
500    the Transport triggered architecture (TTA). The toolset provides a complete
501    co-design flow from C/C++ programs down to synthesizable VHDL and parallel
502    program binaries. Processor customization points include the register files,
503    function units, supported operations, and the interconnection network.</p>
504
505 <p>TCE uses Clang and LLVM for C/C++ language support, target independent
506    optimizations and also for parts of code generation. It generates new
507    LLVM-based code generators <i>on the fly</i> for the designed TTA processors
508    and loads them in to the compiler backend as runtime libraries to avoid
509    per-target recompilation of larger parts of the compiler chain.</p>
510 </div>
511
512   
513 <!--=========================================================================-->
514 <h3>Tart Programming Language</h3>
515
516 <div>
517
518 <p><a href="http://code.google.com/p/tart/">Tart</a> is a general-purpose,
519    strongly typed programming language designed for application
520    developers. Strongly inspired by Python and C#, Tart focuses on practical
521    solutions for the professional software developer, while avoiding the clutter
522    and boilerplate of legacy languages like Java and C++. Although Tart is still
523    in development, the current implementation supports many features expected of
524    a modern programming language, such as garbage collection, powerful
525    bidirectional type inference, a greatly simplified syntax for template
526    metaprogramming, closures and function literals, reflection, operator
527    overloading, explicit mutability and immutability, and much more. Tart is
528    flexible enough to accommodate a broad range of programming styles and
529    philosophies, while maintaining a strong commitment to simplicity, minimalism
530    and elegance in design.</p>
531
532 </div>
533
534 <!--=========================================================================-->
535 <h3>ThreadSanitizer</h3>
536
537 <div>
538
539 <p><a href="http://code.google.com/p/data-race-test/">ThreadSanitizer</a> is a
540    data race detector for (mostly) C and C++ code, available for Linux, Mac OS
541    and Windows. On different systems, we use binary instrumentation frameworks
542    (Valgrind, Pin and DynamoRio) as frontends that generate the program events
543    for the race detection algorithm. On Linux, there's an option of using
544    LLVM-based compile-time instrumentation.</p>
545
546 </div>
547
548 <!--=========================================================================-->
549 <h3>The ZooLib C++ Cross-Platform Application Framework</h3>
550
551 <div>
552
553 <p><a href="http://www.zoolib.org/">ZooLib</a> is Open Source under the MIT
554    License. It provides GUI, filesystem access, TCP networking, thread-safe
555    memory management, threading and locking for Mac OS X, Classic Mac OS,
556    Microsoft Windows, POSIX operating systems with X11, BeOS, Haiku, Apple's iOS
557    and Research in Motion's BlackBerry.</p>
558
559 <p>My current work is to use CLang's static analyzer to improve ZooLib's code
560    quality.  I also plan to set up LLVM compiles of the demo programs and test
561    programs using CLang and LLVM on all the platforms that CLang, LLVM and
562    ZooLib all support.</p>
563
564 </div>
565
566 <!--=========================================================================-->
567 <!--
568 <h3>PinaVM</h3>
569   
570 <div>
571 <p><a href="http://gitorious.org/pinavm/pages/Home">PinaVM</a> is an open
572 source, <a href="http://www.systemc.org/">SystemC</a> front-end. Unlike many
573 other front-ends, PinaVM actually executes the elaboration of the
574 program analyzed using LLVM's JIT infrastructure. It later enriches the
575 bitcode with SystemC-specific information.</p>
576 </div>
577 -->
578
579
580 <!--=========================================================================-->
581 <!--
582 <h3 id="icedtea">IcedTea Java Virtual Machine Implementation</h3>
583
584 <div>
585 <p>
586 <a href="http://icedtea.classpath.org/wiki/Main_Page">IcedTea</a> provides a
587 harness to build OpenJDK using only free software build tools and to provide
588 replacements for the not-yet free parts of OpenJDK.  One of the extensions that
589 IcedTea provides is a new JIT compiler named <a
590 href="http://icedtea.classpath.org/wiki/ZeroSharkFaq">Shark</a> which uses LLVM
591 to provide native code generation without introducing processor-dependent
592 code.
593 </p>
594
595 <p> OpenJDK 7 b112, IcedTea6 1.9 and IcedTea7 1.13 and later have been tested
596 and are known to work with LLVM 3.0 (and continue to work with older LLVM
597 releases &gt;= 2.6 as well).</p>
598 </div>
599 -->
600
601 <!--=========================================================================-->
602 <!--
603 <h3>Polly - Polyhedral optimizations for LLVM</h3>
604   
605 <div>
606 <p>Polly is a project that aims to provide advanced memory access optimizations
607 to better take advantage of SIMD units, cache hierarchies, multiple cores or
608 even vector accelerators for LLVM. Built around an abstract mathematical
609 description based on Z-polyhedra, it provides the infrastructure to develop
610 advanced optimizations in LLVM and to connect complex external optimizers. In
611 its first year of existence Polly already provides an exact value-based
612 dependency analysis as well as basic SIMD and OpenMP code generation support.
613 Furthermore, Polly can use PoCC(Pluto) an advanced optimizer for data-locality
614 and parallelism.</p>
615 </div>
616 -->
617
618 <!--=========================================================================-->
619 <!--
620 <h3>Rubinius</h3>
621
622 <div>
623   <p><a href="http://github.com/evanphx/rubinius">Rubinius</a> is an environment
624   for running Ruby code which strives to write as much of the implementation in
625   Ruby as possible. Combined with a bytecode interpreting VM, it uses LLVM to
626   optimize and compile ruby code down to machine code. Techniques such as type
627   feedback, method inlining, and deoptimization are all used to remove dynamism
628   from ruby execution and increase performance.</p>
629 </div>
630 -->
631
632 <!--=========================================================================-->
633 <!--
634 <h3>
635 <a name="FAUST">FAUST Real-Time Audio Signal Processing Language</a>
636 </h3>
637
638 <div>
639 <p>
640 <a href="http://faust.grame.fr">FAUST</a> is a compiled language for real-time
641 audio signal processing. The name FAUST stands for Functional AUdio STream. Its
642 programming model combines two approaches: functional programming and block
643 diagram composition. In addition with the C, C++, JAVA output formats, the
644 Faust compiler can now generate LLVM bitcode, and works with LLVM 2.7-3.0.</p>
645
646 </div>
647 -->
648   
649 </div>
650
651 <!-- *********************************************************************** -->
652 <h2>
653   <a name="whatsnew">What's New in LLVM 3.0?</a>
654 </h2>
655 <!-- *********************************************************************** -->
656
657 <div>
658
659 <p>This release includes a huge number of bug fixes, performance tweaks and
660 minor improvements.  Some of the major improvements and new features are listed
661 in this section.
662 </p>
663
664 <!--=========================================================================-->
665 <h3>
666 <a name="majorfeatures">Major New Features</a>
667 </h3>
668
669 <div>
670
671 <p>LLVM 3.0 includes several major new capabilities:</p>
672
673 <ul>
674
675 <!--
676 <li></li>
677 -->
678   
679 </ul>
680   
681 </div>
682
683 <!--=========================================================================-->
684 <h3>
685 <a name="coreimprovements">LLVM IR and Core Improvements</a>
686 </h3>
687
688 <div>
689 <p>LLVM IR has several new features for better support of new targets and that
690 expose new optimization opportunities:</p>
691
692 <ul>
693 <!--
694 <li></li>
695 -->
696 </ul>
697
698 </div>
699
700 <!--=========================================================================-->
701 <h3>
702 <a name="optimizer">Optimizer Improvements</a>
703 </h3>
704
705 <div>
706
707 <p>In addition to a large array of minor performance tweaks and bug fixes, this
708 release includes a few major enhancements and additions to the optimizers:</p>
709
710 <ul>
711 <!--
712 <li></li>
713 -->
714 </li>
715   
716 </ul>
717
718 </div>
719
720 <!--=========================================================================-->
721 <h3>
722 <a name="mc">MC Level Improvements</a>
723 </h3>
724
725 <div>
726 <p>
727 The LLVM Machine Code (aka MC) subsystem was created to solve a number
728 of problems in the realm of assembly, disassembly, object file format handling,
729 and a number of other related areas that CPU instruction-set level tools work
730 in.</p>
731
732 <ul>
733 <!--
734 <li></li>
735 -->
736 </ul>
737
738 <p>For more information, please see the <a
739 href="http://blog.llvm.org/2010/04/intro-to-llvm-mc-project.html">Intro to the
740 LLVM MC Project Blog Post</a>.
741 </p>
742
743 </div>
744
745 <!--=========================================================================-->
746 <h3>
747 <a name="codegen">Target Independent Code Generator Improvements</a>
748 </h3>
749
750 <div>
751
752 <p>We have put a significant amount of work into the code generator
753 infrastructure, which allows us to implement more aggressive algorithms and make
754 it run faster:</p>
755
756 <ul>
757 <!--
758 <li></li>
759 -->
760 </ul>
761 </div>
762
763 <!--=========================================================================-->
764 <h3>
765 <a name="x86">X86-32 and X86-64 Target Improvements</a>
766 </h3>
767
768 <div>
769 <p>New features and major changes in the X86 target include:
770 </p>
771
772 <ul>
773 <li>The CRC32 intrinsics have been renamed.  The intrinsics were previously
774   @llvm.x86.sse42.crc32.[8|16|32] and @llvm.x86.sse42.crc64.[8|64].  They have
775   been renamed to @llvm.x86.sse42.crc32.32.[8|16|32] and 
776   @llvm.x86.sse42.crc32.64.[8|64].</li>
777
778 </ul>
779
780 </div>
781
782 <!--=========================================================================-->
783 <h3>
784 <a name="ARM">ARM Target Improvements</a>
785 </h3>
786
787 <div>
788 <p>New features of the ARM target include:
789 </p>
790
791 <ul>
792 <!--
793 <li></li>
794 -->
795 </ul>
796 </div>
797   
798 <!--=========================================================================-->
799 <h3>
800 <a name="OtherTS">Other Target Specific Improvements</a>
801 </h3>
802
803 <div>
804 <ul>
805 <!--
806 <li></li>
807 -->
808 </ul>
809 </div>
810
811 <!--=========================================================================-->
812 <h3>
813 <a name="changes">Major Changes and Removed Features</a>
814 </h3>
815
816 <div>
817
818 <p>If you're already an LLVM user or developer with out-of-tree changes based on
819    LLVM 2.9, this section lists some "gotchas" that you may run into upgrading
820    from the previous release.</p>
821
822 <ul>
823   <li>The <code>LLVMC</code> front end code was removed while separating
824       out language independence.</li>
825   <li>The <code>LowerSetJmp</code> pass wasn't used effectively by any
826       target and has been removed.</li>
827   <li>The old <code>TailDup</code> pass was not used in the standard pipeline
828       and was unable to update ssa form, so it has been removed.
829   <li>The syntax of volatile loads and stores in IR has been changed to
830       "<code>load volatile</code>"/"<code>store volatile</code>".  The old
831       syntax ("<code>volatile load</code>"/"<code>volatile store</code>")
832       is still accepted, but is now considered deprecated.</li>
833   <li>The old atomic intrinscs (<code>llvm.memory.barrier</code> and
834       <code>llvm.atomic.*</code>) are now gone.  Please use the new atomic
835       instructions, described in the <a href="Atomics.html">atomics guide</a>.
836 </ul>
837
838 <h4>Windows (32-bit)</h4>
839 <div>
840 <ul>
841   <li>On Win32(MinGW32 and MSVC), Windows 2000 will not be supported.
842       Windows XP or higher is required.</li>
843 </ul>
844 </div>
845
846 </div>
847
848 <!--=========================================================================-->
849 <h3>
850 <a name="api_changes">Internal API Changes</a>
851 </h3>
852
853 <div>
854
855 <p>In addition, many APIs have changed in this release.  Some of the major
856    LLVM API changes are:</p>
857
858 <ul>
859 <li>The biggest and most pervasive change is that llvm::Type's are no longer
860     returned or accepted as 'const' values.  Instead, just pass around non-const
861     Type's.</li>
862   
863 <li><code>PHINode::reserveOperandSpace</code> has been removed. Instead, you
864   must specify how many operands to reserve space for when you create the
865   PHINode, by passing an extra argument into <code>PHINode::Create</code>.</li>
866
867 <li>PHINodes no longer store their incoming BasicBlocks as operands. Instead,
868   the list of incoming BasicBlocks is stored separately, and can be accessed
869   with new functions <code>PHINode::block_begin</code>
870   and <code>PHINode::block_end</code>.</li>
871
872 <li>Various functions now take an <code>ArrayRef</code> instead of either a pair
873   of pointers (or iterators) to the beginning and end of a range, or a pointer
874   and a length. Others now return an <code>ArrayRef</code> instead of a
875   reference to a <code>SmallVector</code> or <code>std::vector</code>. These
876   include:
877 <ul>
878 <!-- Please keep this list sorted. -->
879 <li><code>CallInst::Create</code></li>
880 <li><code>ComputeLinearIndex</code> (in <code>llvm/CodeGen/Analysis.h</code>)</li>
881 <li><code>ConstantArray::get</code></li>
882 <li><code>ConstantExpr::getExtractElement</code></li>
883 <li><code>ConstantExpr::getGetElementPtr</code></li>
884 <li><code>ConstantExpr::getInBoundsGetElementPtr</code></li>
885 <li><code>ConstantExpr::getIndices</code></li>
886 <li><code>ConstantExpr::getInsertElement</code></li>
887 <li><code>ConstantExpr::getWithOperands</code></li>
888 <li><code>ConstantFoldCall</code> (in <code>llvm/Analysis/ConstantFolding.h</code>)</li>
889 <li><code>ConstantFoldInstOperands</code> (in <code>llvm/Analysis/ConstantFolding.h</code>)</li>
890 <li><code>ConstantVector::get</code></li>
891 <li><code>DIBuilder::createComplexVariable</code></li>
892 <li><code>DIBuilder::getOrCreateArray</code></li>
893 <li><code>ExtractValueInst::Create</code></li>
894 <li><code>ExtractValueInst::getIndexedType</code></li>
895 <li><code>ExtractValueInst::getIndices</code></li>
896 <li><code>FindInsertedValue</code> (in <code>llvm/Analysis/ValueTracking.h</code>)</li>
897 <li><code>gep_type_begin</code> (in <code>llvm/Support/GetElementPtrTypeIterator.h</code>)</li>
898 <li><code>gep_type_end</code> (in <code>llvm/Support/GetElementPtrTypeIterator.h</code>)</li>
899 <li><code>GetElementPtrInst::Create</code></li>
900 <li><code>GetElementPtrInst::CreateInBounds</code></li>
901 <li><code>GetElementPtrInst::getIndexedType</code></li>
902 <li><code>InsertValueInst::Create</code></li>
903 <li><code>InsertValueInst::getIndices</code></li>
904 <li><code>InvokeInst::Create</code></li>
905 <li><code>IRBuilder::CreateCall</code></li>
906 <li><code>IRBuilder::CreateExtractValue</code></li>
907 <li><code>IRBuilder::CreateGEP</code></li>
908 <li><code>IRBuilder::CreateInBoundsGEP</code></li>
909 <li><code>IRBuilder::CreateInsertValue</code></li>
910 <li><code>IRBuilder::CreateInvoke</code></li>
911 <li><code>MDNode::get</code></li>
912 <li><code>MDNode::getIfExists</code></li>
913 <li><code>MDNode::getTemporary</code></li>
914 <li><code>MDNode::getWhenValsUnresolved</code></li>
915 <li><code>SimplifyGEPInst</code> (in <code>llvm/Analysis/InstructionSimplify.h</code>)</li>
916 <li><code>TargetData::getIndexedOffset</code></li>
917 </ul></li>
918
919 <li>All forms of <code>StringMap::getOrCreateValue</code> have been remove
920   except for the one which takes a <code>StringRef</code>.</li>
921
922 <li>The <code>LLVMBuildUnwind</code> function from the C API was removed. The
923     LLVM <code>unwind</code> instruction has been deprecated for a long time and
924     isn't used by the current front-ends. So this was removed during the
925     exception handling rewrite.</li>
926
927 <li>The <code>LLVMAddLowerSetJmpPass</code> function from the C API was removed
928     because the <code>LowerSetJmp</code> pass was removed.</li>
929
930 <li>The <code>DIBuilder</code> interface used by front ends to encode debugging 
931     information in the LLVM IR now expects clients to use <code>DIBuilder::finalize()</code>
932     at the end of translation unit to complete debugging information encoding.</li>
933
934 <li>The way the type system works has been rewritten: <code>PATypeHolder</code>
935 and <code>OpaqueType</code> are gone, and all APIs deal with <code>Type*</code>
936 instead of <code>const Type*</code>.
937 If you need to create recursive structures, then create a named structure,
938 and use <code>setBody()</code> when all its elements are built.
939 Type merging and refining is gone too: named structures are not
940 merged with other structures, even if their layout is identical.
941 (of course anonymous structures are still uniqued by layout).
942 </li>
943
944 <li>TargetSelect.h moved to Support/ from Target/</li>
945
946 <li>UpgradeIntrinsicCall no longer upgrades pre-2.9 intrinsic calls
947 (for example <code>llvm.memset.i32</code>).</li>
948
949 <li>It is mandatory to initialize all out-of-tree passes too and their dependencies now with
950 <code>INITIALIZE_PASS{BEGIN,END,}</code> and <code>INITIALIZE_{PASS,AG}_DEPENDENCY</code>.</li>
951
952 <li>The interface for MemDepResult in MemoryDependenceAnalysis has been enhanced
953     with new return types Unknown and NonFuncLocal, in addition to the existing
954     types Clobber, Def, and NonLocal.</li>
955
956 </ul>
957 </div>
958
959 </div>
960
961 <!-- *********************************************************************** -->
962 <h2>
963   <a name="knownproblems">Known Problems</a>
964 </h2>
965 <!-- *********************************************************************** -->
966
967 <div>
968
969 <p>This section contains significant known problems with the LLVM system,
970 listed by component.  If you run into a problem, please check the <a
971 href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
972 there isn't already one.</p>
973
974 <!-- ======================================================================= -->
975 <h3>
976   <a name="experimental">Experimental features included with this release</a>
977 </h3>
978
979 <div>
980
981 <p>The following components of this LLVM release are either untested, known to
982 be broken or unreliable, or are in early development.  These components should
983 not be relied on, and bugs should not be filed against them, but they may be
984 useful to some people.  In particular, if you would like to work on one of these
985 components, please contact us on the <a
986 href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p>
987
988 <ul>
989 <li>The Alpha, CellSPU, MicroBlaze, MSP430, MIPS, PTX,
990     and XCore backends are experimental.</li>
991 <li><tt>llc</tt> "<tt>-filetype=obj</tt>" is experimental on all targets
992     other than darwin and ELF X86 systems.</li>
993     
994 </ul>
995
996 </div>
997
998 <!-- ======================================================================= -->
999 <h3>
1000   <a name="x86-be">Known problems with the X86 back-end</a>
1001 </h3>
1002
1003 <div>
1004
1005 <ul>
1006   <li>The X86 backend does not yet support
1007     all <a href="http://llvm.org/PR879">inline assembly that uses the X86
1008     floating point stack</a>.  It supports the 'f' and 't' constraints, but not
1009     'u'.</li>
1010   <li>The X86-64 backend does not yet support the LLVM IR instruction
1011       <tt>va_arg</tt>. Currently, front-ends support variadic
1012       argument constructs on X86-64 by lowering them manually.</li>
1013   <li>Windows x64 (aka Win64) code generator has a few issues.
1014     <ul>
1015       <li>llvm-gcc cannot build the mingw-w64 runtime currently
1016        due to lack of support for the 'u' inline assembly
1017        constraint and for X87 floating point inline assembly.</li>
1018       <li>On mingw-w64, you will see unresolved symbol <tt>__chkstk</tt>
1019        due to <a href="http://llvm.org/bugs/show_bug.cgi?id=8919">Bug 8919</a>.
1020        It is fixed in <a href="http://lists.cs.uiuc.edu/pipermail/llvm-commits/Week-of-Mon-20110321/118499.html">r128206</a>.</li>
1021       <li>Miss-aligned MOVDQA might crash your program. It is due to
1022        <a href="http://llvm.org/bugs/show_bug.cgi?id=9483">Bug 9483</a>,
1023        lack of handling aligned internal globals.</li>
1024       </ul>
1025   </li>
1026
1027 </ul>
1028
1029 </div>
1030
1031 <!-- ======================================================================= -->
1032 <h3>
1033   <a name="ppc-be">Known problems with the PowerPC back-end</a>
1034 </h3>
1035
1036 <div>
1037
1038 <ul>
1039 <li>The Linux PPC32/ABI support needs testing for the interpreter and static
1040 compilation, and lacks support for debug information.</li>
1041 </ul>
1042
1043 </div>
1044
1045 <!-- ======================================================================= -->
1046 <h3>
1047   <a name="arm-be">Known problems with the ARM back-end</a>
1048 </h3>
1049
1050 <div>
1051
1052 <ul>
1053 <li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
1054 processors, thumb programs can crash or produce wrong
1055 results (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
1056 <li>Compilation for ARM Linux OABI (old ABI) is supported but not fully tested.
1057 </li>
1058 </ul>
1059
1060 </div>
1061
1062 <!-- ======================================================================= -->
1063 <h3>
1064   <a name="sparc-be">Known problems with the SPARC back-end</a>
1065 </h3>
1066
1067 <div>
1068
1069 <ul>
1070 <li>The SPARC backend only supports the 32-bit SPARC ABI (-m32); it does not
1071     support the 64-bit SPARC ABI (-m64).</li>
1072 </ul>
1073
1074 </div>
1075
1076 <!-- ======================================================================= -->
1077 <h3>
1078   <a name="mips-be">Known problems with the MIPS back-end</a>
1079 </h3>
1080
1081 <div>
1082
1083 <ul>
1084 <li>64-bit MIPS targets are not supported yet.</li>
1085 </ul>
1086
1087 </div>
1088
1089 <!-- ======================================================================= -->
1090 <h3>
1091   <a name="alpha-be">Known problems with the Alpha back-end</a>
1092 </h3>
1093
1094 <div>
1095
1096 <ul>
1097
1098 <li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
1099 appropriate nops inserted to ensure restartability.</li>
1100
1101 </ul>
1102 </div>
1103
1104 <!-- ======================================================================= -->
1105 <h3>
1106   <a name="c-be">Known problems with the C back-end</a>
1107 </h3>
1108
1109 <div>
1110
1111 <p>The C backend has numerous problems and is not being actively maintained.
1112 Depending on it for anything serious is not advised.</p>
1113
1114 <ul>
1115 <li><a href="http://llvm.org/PR802">The C backend has only basic support for
1116     inline assembly code</a>.</li>
1117 <li><a href="http://llvm.org/PR1658">The C backend violates the ABI of common
1118     C++ programs</a>, preventing intermixing between C++ compiled by the CBE and
1119     C++ code compiled with <tt>llc</tt> or native compilers.</li>
1120 <li>The C backend does not support all exception handling constructs.</li>
1121 <li>The C backend does not support arbitrary precision integers.</li>
1122 </ul>
1123
1124 </div>
1125
1126
1127 <!-- ======================================================================= -->
1128 <h3>
1129   <a name="llvm-gcc">Known problems with the llvm-gcc front-end</a>
1130 </h3>
1131
1132 <div>
1133
1134 <p><b>LLVM 3.0 will be the last release of llvm-gcc.</b></p>
1135
1136 <p>llvm-gcc is generally very stable for the C family of languages.  The only
1137    major language feature of GCC not supported by llvm-gcc is the
1138    <tt>__builtin_apply</tt> family of builtins.   However, some extensions
1139    are only supported on some targets.  For example, trampolines are only
1140    supported on some targets (these are used when you take the address of a
1141    nested function).</p>
1142
1143 <p>Fortran support generally works, but there are still several unresolved bugs
1144    in <a href="http://llvm.org/bugs/">Bugzilla</a>.  Please see the
1145    tools/gfortran component for details.  Note that llvm-gcc is missing major
1146    Fortran performance work in the frontend and library that went into GCC after
1147    4.2.  If you are interested in Fortran, we recommend that you consider using
1148    <a href="#dragonegg">dragonegg</a> instead.</p>
1149
1150 <p>The llvm-gcc 4.2 Ada compiler has basic functionality, but is no longer being
1151 actively maintained.  If you are interested in Ada, we recommend that you
1152 consider using <a href="#dragonegg">dragonegg</a> instead.</p>
1153 </div>
1154
1155 </div>
1156
1157 <!-- *********************************************************************** -->
1158 <h2>
1159   <a name="additionalinfo">Additional Information</a>
1160 </h2>
1161 <!-- *********************************************************************** -->
1162
1163 <div>
1164
1165 <p>A wide variety of additional information is available on the <a
1166 href="http://llvm.org/">LLVM web page</a>, in particular in the <a
1167 href="http://llvm.org/docs/">documentation</a> section.  The web page also
1168 contains versions of the API documentation which is up-to-date with the
1169 Subversion version of the source code.
1170 You can access versions of these documents specific to this release by going
1171 into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
1172
1173 <p>If you have any questions or comments about LLVM, please feel free to contact
1174 us via the <a href="http://llvm.org/docs/#maillist"> mailing
1175 lists</a>.</p>
1176
1177 </div>
1178
1179 <!-- *********************************************************************** -->
1180
1181 <hr>
1182 <address>
1183   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
1184   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
1185   <a href="http://validator.w3.org/check/referer"><img
1186   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
1187
1188   <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
1189   Last modified: $Date$
1190 </address>
1191
1192 </body>
1193 </html>