some writing.
[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, improvements in various
49    subprojects of LLVM, and some of the current users of the code.
50    All LLVM releases may be downloaded from
51    the <a href="http://llvm.org/releases/">LLVM releases web site</a>.</p>
52
53 <p>For more information about LLVM, including information about the latest
54    release, please check out the <a href="http://llvm.org/">main LLVM web
55    site</a>.  If you have questions or comments,
56    the <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM
57    Developer's Mailing List</a> is a good place to send them.</p>
58
59 <p>Note that if you are reading this file from a Subversion checkout or the main
60    LLVM web page, this document applies to the <i>next</i> release, not the
61    current one.  To see the release notes for a specific release, please see the
62    <a href="http://llvm.org/releases/">releases page</a>.</p>
63
64 </div>
65    
66  
67 <!-- *********************************************************************** -->
68 <h2>
69   <a name="subproj">Sub-project Status Update</a>
70 </h2>
71 <!-- *********************************************************************** -->
72
73 <div>
74
75 <p>The LLVM 3.0 distribution currently consists of code from the core LLVM
76    repository (which roughly includes the LLVM optimizers, code generators and
77    supporting tools), and the Clang repository.  In
78    addition to this code, the LLVM Project includes other sub-projects that are
79    in development.  Here we include updates on these subprojects.</p>
80
81 <!--=========================================================================-->
82 <h3>
83 <a name="clang">Clang: C/C++/Objective-C Frontend Toolkit</a>
84 </h3>
85
86 <div>
87
88 <p><a href="http://clang.llvm.org/">Clang</a> is an LLVM front end for the C,
89    C++, and Objective-C languages. Clang aims to provide a better user
90    experience through expressive diagnostics, a high level of conformance to
91    language standards, fast compilation, and low memory use. Like LLVM, Clang
92    provides a modular, library-based architecture that makes it suitable for
93    creating or integrating with other development tools. Clang is considered a
94    production-quality compiler for C, Objective-C, C++ and Objective-C++ on x86
95    (32- and 64-bit), and for Darwin/ARM targets.</p>
96
97 <p>In the LLVM 3.0 time-frame, the Clang team has made many improvements:</p>
98
99 <ul>
100   <li>Greatly improved support for building C++ applications, with greater
101       stability and better diagnostics.</li>
102   
103   <li><a href="http://clang.llvm.org/cxx_status.html">Improved support</a> for
104       the <a href="http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=50372">C++
105       2011</a> standard (aka "C++'0x"), including implementations of non-static data member
106       initializers, alias templates, delegating constructors, range-based
107       for loops, and implicitly-generated move constructors and move assignment
108       operators, among others.</li>
109
110   <li>Implemented support for some features of the upcoming C1x standard,
111       including static assertions and generic selections.</li>
112   
113   <li>Better detection of include and linking paths for system headers and
114       libraries, especially for Linux distributions.</li>
115
116   <li>Several improvements to Objective-C support, including:
117
118     <ul>
119       <li><a href="http://clang.llvm.org/docs/AutomaticReferenceCounting.html">
120           Automatic Reference Counting</a> (ARC) and an improved memory model
121           cleanly separating object and C memory.</li>
122
123       <li>A migration tool for moving manual retain/release code to ARC</li>
124
125       <li>Better support for data hiding, allowing instance variables to be
126           declared in implementation contexts or class extensions</li>
127       <li>Weak linking support for Objective-C classes</li>
128       <li>Improved static type checking by inferring the return type of methods
129       such as +alloc and -init.</li>
130     </ul>
131
132     Some new Objective-C features require either the Mac OS X 10.7 / iOS 5
133     Objective-C runtime, or version 1.6 or later of the GNUstep Objective-C
134     runtime version.</li>
135
136   <li>Implemented a number of optimizations in <tt>libclang</tt>, the Clang C
137       interface, to improve the performance of code completion and the mapping
138       from source locations to abstract syntax tree nodes.</li>
139 </ul>
140
141   
142 <p>If Clang rejects your code but another compiler accepts it, please take a
143    look at the <a href="http://clang.llvm.org/compatibility.html">language
144    compatibility</a> guide to make sure this is not intentional or a known
145    issue.</p>
146
147 </div>
148
149 <!--=========================================================================-->
150 <h3>
151 <a name="dragonegg">DragonEgg: GCC front-ends, LLVM back-end</a>
152 </h3>
153
154 <div>
155 <p><a href="http://dragonegg.llvm.org/">DragonEgg</a> is a
156    <a href="http://gcc.gnu.org/wiki/plugins">gcc plugin</a> that replaces GCC's
157    optimizers and code generators with LLVM's. It works with gcc-4.5 or gcc-4.6,
158    targets the x86-32 and x86-64 processor families, and has been successfully
159    used on the Darwin, FreeBSD, KFreeBSD, Linux and OpenBSD platforms.  It fully
160    supports Ada, C, C++ and Fortran.  It has partial support for Go, Java, Obj-C
161    and Obj-C++.</p>
162
163 <p>The 3.0 release has the following notable changes:</p>
164
165   <ul>
166   <li>GCC version 4.6 is now fully supported.</li>
167
168   <li>Patching and building GCC is no longer required: the plugin should work
169       with your system GCC (version 4.5 or 4.6; on Debian/Ubuntu systems the
170       gcc-4.5-plugin-dev or gcc-4.6-plugin-dev package is also needed).</li>
171
172   <li>The <tt>-fplugin-arg-dragonegg-enable-gcc-optzns</tt> option, which runs
173       GCC's optimizers as well as LLVM's, now works much better.  This is the
174       option to use if you want ultimate performance! It is still experimental
175       though: it may cause the plugin to crash.</li>
176
177   <li>The type and constant conversion logic has been almost entirely rewritten,
178       fixing a multitude of obscure bugs.</li>
179
180 </ul>
181
182 </div>
183
184 <!--=========================================================================-->
185 <h3>
186 <a name="compiler-rt">compiler-rt: Compiler Runtime Library</a>
187 </h3>
188
189 <div>
190
191 <p>The new LLVM <a href="http://compiler-rt.llvm.org/">compiler-rt project</a>
192    is a simple library that provides an implementation of the low-level
193    target-specific hooks required by code generation and other runtime
194    components.  For example, when compiling for a 32-bit target, converting a
195    double to a 64-bit unsigned integer is compiled into a runtime call to the
196    "__fixunsdfdi" function. The compiler-rt library provides highly optimized
197    implementations of this and other low-level routines (some are 3x faster than
198    the equivalent libgcc routines).</p>
199
200 <p>In the LLVM 3.0 timeframe, the target specific ARM code has converted to
201    "unified" assembly syntax, and several new functions have been added to the
202    library.</p>
203
204 </div>
205
206 <!--=========================================================================-->
207 <h3>
208 <a name="lldb">LLDB: Low Level Debugger</a>
209 </h3>
210
211 <div>
212   
213 <p>LLDB is a ground-up implementation of a command line debugger, as well as a
214    debugger API that can be used from other applications.  LLDB makes use of the
215    Clang parser to provide high-fidelity expression parsing (particularly for
216    C++) and uses the LLVM JIT for target support.</p>
217
218 <p>LLDB has advanced by leaps and bounds in the 3.0 timeframe.  It is
219    dramatically more stable and useful, and includes both a
220    new <a href="http://lldb.llvm.org/tutorial.html">tutorial</a> and
221    a <a href="http://lldb.llvm.org/lldb-gdb.html">side-by-side comparison with
222    GDB</a>.</p>
223
224 </div>
225
226 <!--=========================================================================-->
227 <h3>
228 <a name="libc++">libc++: C++ Standard Library</a>
229 </h3>
230
231 <div>
232
233 <p>Like compiler_rt, libc++ is now <a href="DeveloperPolicy.html#license">dual
234    licensed</a> under the MIT and UIUC license, allowing it to be used more
235    permissively.</p>
236
237 <p>Libc++ has been ported to FreeBSD and imported into the base system.  It is
238    planned to be the default STL implementation for FreeBSD 10.</p>
239
240 </div>
241
242 <!--=========================================================================-->
243 <h3>
244 <a name="vmkit">VMKit</a>
245 </h3>
246
247 <div>
248
249   <p>The <a href="http://vmkit.llvm.org/">VMKit project</a> is an
250   implementation of a Java Virtual Machine (Java VM or JVM) that uses LLVM for
251   static and just-in-time compilation.
252
253   <p>In the LLVM 3.0 time-frame, VMKit has had significant improvements on both
254   runtime and startup performance:</p>
255
256   <ul>
257   <li>Precompilation: by compiling ahead of time a small subset of Java's core
258   library, the startup performance have been highly optimized to the point that
259   running a 'Hello World' program takes less than 30 milliseconds.</li>
260
261   <li>Customization: by customizing virtual methods for individual classes,
262   the VM can statically determine the target of a virtual call, and decide to
263   inline it.</li>
264
265   <li>Inlining: the VM does more inlining than it did before, by allowing more
266   bytecode instructions to be inlined, and thanks to customization. It also
267   inlines GC barriers, and object allocations.</li>
268
269   <li>New exception model: the generated code for a method that does not do
270   any try/catch is not penalized anymore by the eventuality of calling a
271   method that throws an exception. Instead, the method that throws the
272   exception jumps directly to the method that could catch it.</li>
273   </ul>
274
275 </div>
276   
277
278 <!--=========================================================================-->
279 <h3>
280 <a name="LLBrowse">LLBrowse: IR Browser</a>
281 </h3>
282
283 <div>
284
285 <p><a href="http://llvm.org/svn/llvm-project/llbrowse/trunk/doc/LLBrowse.html">
286    LLBrowse</a> is an interactive viewer for LLVM modules. It can load any LLVM
287    module and displays its contents as an expandable tree view, facilitating an
288    easy way to inspect types, functions, global variables, or metadata nodes. It
289    is fully cross-platform, being based on the popular wxWidgets GUI
290    toolkit.</p>
291
292 </div>
293
294
295 <!--=========================================================================-->
296 <!--
297 <h3>
298 <a name="klee">KLEE: A Symbolic Execution Virtual Machine</a>
299 </h3>
300
301 <div>
302 <p>
303 <a href="http://klee.llvm.org/">KLEE</a> is a symbolic execution framework for
304 programs in LLVM bitcode form. KLEE tries to symbolically evaluate "all" paths
305 through the application and records state transitions that lead to fault
306 states. This allows it to construct testcases that lead to faults and can even
307 be used to verify some algorithms.
308 </p>
309
310 <p>UPDATE!</p>
311 </div>-->
312
313 </div>
314
315 <!-- *********************************************************************** -->
316 <h2>
317   <a name="externalproj">External Open Source Projects Using LLVM 3.0</a>
318 </h2>
319 <!-- *********************************************************************** -->
320
321 <div>
322
323 <p>An exciting aspect of LLVM is that it is used as an enabling technology for
324    a lot of other language and tools projects.  This section lists some of the
325    projects that have already been updated to work with LLVM 3.0.</p>
326
327 <!--=========================================================================-->
328 <h3>AddressSanitizer</h3>
329   
330 <div>
331
332 <p><a href="http://code.google.com/p/address-sanitizer/">AddressSanitizer</a>
333    uses compiler instrumentation and a specialized malloc library to find C/C++
334    bugs such as use-after-free and out-of-bound accesses to heap, stack, and
335    globals. The key feature of the tool is speed: the average slowdown
336    introduced by AddressSanitizer is less than 2x.</p>
337
338 </div>
339
340 <!--=========================================================================-->
341 <h3>ClamAV</h3>
342   
343 <div>
344
345 <p><a href="http://www.clamav.net">Clam AntiVirus</a> is an open source (GPL)
346    anti-virus toolkit for UNIX, designed especially for e-mail scanning on mail
347    gateways.</p>
348
349 <p>Since version 0.96 it
350    has <a href="http://vrt-sourcefire.blogspot.com/2010/09/introduction-to-clamavs-low-level.html">bytecode
351    signatures</a> that allow writing detections for complex malware.
352    It uses LLVM's JIT to speed up the execution of bytecode on X86, X86-64,
353    PPC32/64, falling back to its own interpreter otherwise.  The git version was
354    updated to work with LLVM 3.0.</p>
355
356 </div>
357
358 <!--=========================================================================-->
359 <h3>clang_complete for VIM</h3>
360
361 <div>
362
363 <p><a href="https://github.com/Rip-Rip/clang_complete">clang_complete</a> is a
364    VIM plugin, that provides accurate C/C++ autocompletion using the clang front
365    end. The development version of clang complete, can directly use libclang
366    which can maintain a cache to speed up auto completion.</p>
367
368 </div>
369
370 <!--=========================================================================-->
371 <h3>clReflect</h3>
372
373 <div>
374
375 <p><a href="https://bitbucket.org/dwilliamson/clreflect">clReflect</a> is a C++
376    parser that uses clang/LLVM to derive a light-weight reflection database
377    suitable for use in game development. It comes with a very simple runtime
378    library for loading and querying the database, requiring no external
379    dependencies (including CRT), and an additional utility library for object
380    management and serialisation.</p>
381
382 </div>
383
384 <!--=========================================================================-->
385 <h3>Cling C++ Interpreter</h3>
386
387 <div>
388
389 <p><a href="http://cern.ch/cling">Cling</a> is an interactive compiler interface
390   (aka C++ interpreter). It supports C++ and C, and uses LLVM's JIT and the
391   Clang parser. It has a prompt interface, runs source files, calls into shared
392    libraries, prints the value of expressions, even does runtime lookup of
393    identifiers (dynamic scopes). And it just behaves like one would expect from
394    an interpreter.</p>
395
396 </div>
397
398 <!--=========================================================================-->
399 <h3>Crack Programming Language</h3>
400
401 <div>
402
403 <p><a href="http://code.google.com/p/crack-language/">Crack</a> aims to provide
404    the ease of development of a scripting language with the performance of a
405    compiled language. The language derives concepts from C++, Java and Python,
406    incorporating object-oriented programming, operator overloading and strong
407    typing.</p>
408
409 </div>
410   
411 <!--=========================================================================-->
412 <h3>Eero</h3>
413   
414 <div>
415
416 <p><a href="http://eerolanguage.org/">Eero</a> is a fully
417    header-and-binary-compatible dialect of Objective-C 2.0, implemented with a
418    patched version of the Clang/LLVM compiler. It features a streamlined syntax,
419    Python-like indentation, and new operators, for improved readability and
420    reduced code clutter. It also has new features such as limited forms of
421    operator overloading and namespaces, and strict (type-and-operator-safe)
422    enumerations. It is inspired by languages such as Smalltalk, Python, and
423    Ruby.</p>
424
425 </div>
426
427 <!--=========================================================================-->
428 <h3>FAUST Real-Time Audio Signal Processing Language</h3>
429   
430 <div>
431
432 <p><a href="http://faust.grame.fr/">FAUST</a> is a compiled language for
433   real-time audio signal processing. The name FAUST stands for Functional
434   AUdio STream. Its programming model combines two approaches: functional
435   programming and block diagram composition. In addition with the C, C++, Java
436   output formats, the Faust compiler can now generate LLVM bitcode, and works
437   with LLVM 2.7-3.0.
438   </p>
439
440 </div>
441
442 <!--=========================================================================-->
443 <h3>Glasgow Haskell Compiler (GHC)</h3>
444   
445 <div>
446
447 <p>GHC is an open source, state-of-the-art programming suite for Haskell, a
448    standard lazy functional programming language. It includes an optimizing
449    static compiler generating good code for a variety of platforms, together
450    with an interactive system for convenient, quick development.</p>
451
452 <p>GHC 7.0 and onwards include an LLVM code generator, supporting LLVM 2.8 and
453    later. Since LLVM 2.9, GHC now includes experimental support for the ARM
454    platform with LLVM 3.0.</p>
455
456 </div>
457
458 <!--=========================================================================-->
459 <h3>gwXscript</h3>
460
461 <div>
462
463 <p><a href="http://botwars.tk/gwscript/">gwXscript</a> is an object oriented,
464    aspect oriented programming language which can create both executables (ELF,
465    EXE) and shared libraries (DLL, SO, DYNLIB). The compiler is implemented in
466    its own language and translates scripts into LLVM-IR which can be optimized
467    and translated into native code by the LLVM framework. Source code in
468    gwScript contains definitions that expand the namespaces. So you can build
469    your project and simply 'plug out' features by removing a file. The remaining
470    project does not leave scars since you directly separate concerns by the
471    'template' feature of gwX. It is also possible to add new features to a
472    project by just adding files and without editing the original project. This
473    language is used for example to create games or content management systems
474    that should be extendable.</p>
475
476 <p>gwXscript is strongly typed and offers comfort with its native types string,
477    hash and array. You can easily write new libraries in gwXscript or native
478    code. gwXscript is type safe and users should not be able to crash your
479    program or execute malicious code except code that is eating CPU time.</p>
480
481 </div>
482
483 <!--=========================================================================-->
484 <h3>include-what-you-use</h3>
485
486 <div>
487
488 <p><a href="http://code.google.com/p/include-what-you-use">include-what-you-use</a>
489    is a tool to ensure that a file directly <code>#include</code>s
490    all <code>.h</code> files that provide a symbol that the file uses. It also
491    removes superfluous <code>#include</code>s from source files.</p>
492
493 </div>
494
495 <!--=========================================================================-->
496 <h3>ispc: The Intel SPMD Program Compiler</h3>
497
498 <div>
499
500 <p><a href="http://ispc.github.com">ispc</a> is a compiler for "single program,
501    multiple data" (SPMD) programs. It compiles a C-based SPMD programming
502    language to run on the SIMD units of CPUs; it often delivers 5-6x speedups on
503    a single core of a CPU with an 8-wide SIMD unit compared to serial code,
504    while still providing a clean and easy-to-understand programming model.  For
505    an introduction to the language and its performance,
506    see <a href="http://ispc.github.com/example.html">the walkthrough</a> of a short
507    example program.  ispc is licensed under the BSD license.</p>
508
509 </div>
510   
511 <!--=========================================================================-->
512 <h3>The Julia Programming Language</h3>
513
514 <div>
515
516 <p><a href="http://github.com/JuliaLang/julia">Julia</a> is a high-level,
517   high-performance dynamic language for technical
518   computing. It provides a sophisticated compiler, distributed parallel
519   execution, numerical accuracy, and an extensive mathematical function
520   library. The compiler uses type inference to generate fast code
521   without any type declarations, and uses LLVM's optimization passes and
522   JIT compiler. The language is designed around multiple dispatch,
523   giving programs a large degree of flexibility. It is ready for use on many
524   kinds of problems.</p>
525 </div>
526
527 <!--=========================================================================-->
528 <h3>LanguageKit and Pragmatic Smalltalk</h3>
529
530 <div>
531
532 <p><a href="http://etoileos.com/etoile/features/languagekit/">LanguageKit</a> is
533    a framework for implementing dynamic languages sharing an object model with
534    Objective-C. It provides static and JIT compilation using LLVM along with
535    its own interpreter. Pragmatic Smalltalk is a dialect of Smalltalk, built on
536    top of LanguageKit, that interfaces directly with Objective-C, sharing the
537    same object representation and message sending behaviour. These projects are
538    developed as part of the &Eacute;toil&eacute; desktop environment.</p>
539
540 </div>
541
542 <!--=========================================================================-->
543 <h3>LuaAV</h3>
544
545 <div>
546
547 <p><a href="http://lua-av.mat.ucsb.edu/blog/">LuaAV</a> is a real-time
548    audiovisual scripting environment based around the Lua language and a
549    collection of libraries for sound, graphics, and other media protocols. LuaAV
550    uses LLVM and Clang to JIT compile efficient user-defined audio synthesis
551    routines specified in a declarative syntax.</p>
552
553 </div>
554
555 <!--=========================================================================-->
556 <h3>Mono</h3>
557
558 <div>
559
560 <p>An open source, cross-platform implementation of C# and the CLR that is
561    binary compatible with Microsoft.NET. Has an optional, dynamically-loaded
562    LLVM code generation backend in Mini, the JIT compiler.</p>
563
564 <p>Note that we use a Git mirror of LLVM <a
565     href="https://github.com/mono/llvm">with some patches</a>.</p>
566
567 </div>
568
569 <!--=========================================================================-->
570 <h3>Polly</h3>
571
572 <div>
573
574 <p><a href="http://polly.grosser.es">Polly</a> is an advanced data-locality
575    optimizer and automatic parallelizer. It uses an advanced, mathematical
576    model to calculate detailed data dependency information which it uses to
577    optimize the loop structure of a program. Polly can speed up sequential code
578    by improving memory locality and consequently the cache use. Furthermore,
579    Polly is able to expose different kind of parallelism which it exploits by
580    introducing (basic) OpenMP and SIMD code. A mid-term goal of Polly is to
581    automatically create optimized GPU code.</p>
582
583 </div>
584
585 <!--=========================================================================-->
586 <h3>Portable OpenCL (pocl)</h3>
587
588 <div>
589
590 <p>Portable OpenCL is an open source implementation of the OpenCL standard which
591    can be easily adapted for new targets. One of the goals of the project is
592    improving performance portability of OpenCL programs, avoiding the need for
593    target-dependent manual optimizations. A "native" target is included, which
594    allows running OpenCL kernels on the host (CPU).</p>
595
596 </div>
597
598 <!--=========================================================================-->
599 <h3>Pure</h3>
600   
601 <div>
602 <p><a href="http://pure-lang.googlecode.com/">Pure</a> is an
603   algebraic/functional programming language based on term rewriting. Programs
604   are collections of equations which are used to evaluate expressions in a
605   symbolic fashion. The interpreter uses LLVM as a backend to JIT-compile Pure
606   programs to fast native code. Pure offers dynamic typing, eager and lazy
607   evaluation, lexical closures, a hygienic macro system (also based on term
608   rewriting), built-in list and matrix support (including list and matrix
609   comprehensions) and an easy-to-use interface to C and other programming
610   languages (including the ability to load LLVM bitcode modules, and inline C,
611   C++, Fortran and Faust code in Pure programs if the corresponding LLVM-enabled
612   compilers are installed).</p>
613   
614 <p>Pure version 0.48 has been tested and is known to work with LLVM 3.0
615   (and continues to work with older LLVM releases &gt;= 2.5).</p>
616
617 </div>
618
619 <!--=========================================================================-->
620 <h3>Renderscript</h3>
621
622 <div>
623
624 <p><a href="http://developer.android.com/guide/topics/renderscript/index.html">Renderscript</a>
625    is Android's advanced 3D graphics rendering and compute API. It provides a
626    portable C99-based language with extensions to facilitate common use cases
627    for enhancing graphics and thread level parallelism. The Renderscript
628    compiler frontend is based on Clang/LLVM. It emits a portable bitcode format
629    for the actual compiled script code, as well as reflects a Java interface for
630    developers to control the execution of the compiled bitcode. Executable
631    machine code is then generated from this bitcode by an LLVM backend on the
632    device. Renderscript is thus able to provide a mechanism by which Android
633    developers can improve performance of their applications while retaining
634    portability.</p>
635
636 </div>
637
638 <!--=========================================================================-->
639 <h3>SAFECode</h3>
640
641 <div>
642
643 <p><a href="http://safecode.cs.illinois.edu">SAFECode</a> is a memory safe C/C++
644    compiler built using LLVM.  It takes standard, unannotated C/C++ code,
645    analyzes the code to ensure that memory accesses and array indexing
646    operations are safe, and instruments the code with run-time checks when
647    safety cannot be proven statically.  SAFECode can be used as a debugging aid
648    (like Valgrind) to find and repair memory safety bugs.  It can also be used
649    to protect code from security attacks at run-time.</p>
650
651 </div>
652
653 <!--=========================================================================-->
654 <h3>The Stupid D Compiler (SDC)</h3>
655
656 <div>
657
658 <p><a href="https://github.com/bhelyer/SDC">The Stupid D Compiler</a> is a
659    project seeking to write a self-hosting compiler for the D programming
660    language without using the frontend of the reference compiler (DMD).</p>
661
662 </div>
663
664 <!--=========================================================================-->
665 <h3>TTA-based Co-design Environment (TCE)</h3>
666
667 <div>
668
669 <p>TCE is a toolset for designing application-specific processors (ASP) based on
670    the Transport triggered architecture (TTA). The toolset provides a complete
671    co-design flow from C/C++ programs down to synthesizable VHDL and parallel
672    program binaries. Processor customization points include the register files,
673    function units, supported operations, and the interconnection network.</p>
674   
675 <p>TCE uses Clang and LLVM for C/C++ language support, target independent
676    optimizations and also for parts of code generation. It generates new
677    LLVM-based code generators "on the fly" for the designed TTA processors and
678    loads them in to the compiler backend as runtime libraries to avoid
679    per-target recompilation of larger parts of the compiler chain.</p>
680
681 </div>
682   
683 <!--=========================================================================-->
684 <h3>Tart Programming Language</h3>
685
686 <div>
687
688 <p><a href="http://code.google.com/p/tart/">Tart</a> is a general-purpose,
689    strongly typed programming language designed for application
690    developers. Strongly inspired by Python and C#, Tart focuses on practical
691    solutions for the professional software developer, while avoiding the clutter
692    and boilerplate of legacy languages like Java and C++. Although Tart is still
693    in development, the current implementation supports many features expected of
694    a modern programming language, such as garbage collection, powerful
695    bidirectional type inference, a greatly simplified syntax for template
696    metaprogramming, closures and function literals, reflection, operator
697    overloading, explicit mutability and immutability, and much more. Tart is
698    flexible enough to accommodate a broad range of programming styles and
699    philosophies, while maintaining a strong commitment to simplicity, minimalism
700    and elegance in design.</p>
701
702 </div>
703
704 <!--=========================================================================-->
705 <h3>ThreadSanitizer</h3>
706
707 <div>
708
709 <p><a href="http://code.google.com/p/data-race-test/">ThreadSanitizer</a> is a
710    data race detector for (mostly) C and C++ code, available for Linux, Mac OS
711    and Windows. On different systems, we use binary instrumentation frameworks
712    (Valgrind and Pin) as frontends that generate the program events for the race
713    detection algorithm. On Linux, there's an option of using LLVM-based
714    compile-time instrumentation.</p>
715
716 </div>
717
718 </div>
719
720 <!-- *********************************************************************** -->
721 <h2>
722   <a name="whatsnew">What's New in LLVM 3.0?</a>
723 </h2>
724 <!-- *********************************************************************** -->
725
726 <div>
727
728 <p>This release includes a huge number of bug fixes, performance tweaks and
729    minor improvements.  Some of the major improvements and new features are
730    listed in this section.</p>
731
732 <!--=========================================================================-->
733 <h3>
734 <a name="majorfeatures">Major New Features</a>
735 </h3>
736
737 <div>
738
739   <!-- Features that need text if they're finished for 3.1:
740    ARM EHABI
741    combiner-aa?
742    strong phi elim
743    loop dependence analysis
744    CorrelatedValuePropagation
745    lib/Transforms/IPO/MergeFunctions.cpp => consider for 3.1.
746    Integrated assembler on by default for arm/thumb?
747
748    -->
749
750   <!-- Near dead:
751    Analysis/RegionInfo.h + Dom Frontiers
752    SparseBitVector: used in LiveVar.
753    llvm/lib/Archive - replace with lib object?
754    -->
755
756 <p>LLVM 3.0 includes several major changes and big features:</p>
757
758 <ul>
759 <li>llvm-gcc is no longer supported, and not included in the release.  We 
760     recommend switching to <a
761        href="http://clang.llvm.org/">Clang</a> or <a 
762        href="http://dragonegg.llvm.org/">DragonEgg</a>.</li>
763
764 <li>The linear scan register allocator has been replaced with a new "greedy"
765     register allocator, enabling live range splitting and many other
766     optimizations that lead to better code quality.  Please see its <a
767     href="http://blog.llvm.org/2011/09/greedy-register-allocation-in-llvm-30.html">blog post</a> or its talk at the <a 
768       href="http://llvm.org/devmtg/2011-11/">Developer Meeting</a>
769     for more information.</li>
770 <li>LLVM IR now includes full support for <a href="Atomics.html">atomics
771     memory operations</a> intended to support the C++'11 and C'1x memory models.
772     This includes <a href="LangRef.html#memoryops">atomic load and store,
773     compare and exchange, and read/modify/write instructions</a> as well as a
774     full set of <a href="LangRef.html#ordering">memory ordering constraints</a>.
775     Please see the <a href="Atomics.html">Atomics Guide</a> for more
776     information.
777 </li>
778 <li>The LLVM IR exception handling representation has been redesigned and
779     reimplemented, making it more elegant, fixing a huge number of bugs, and
780     enabling inlining and other optimizations.  Please see its blog post (XXX
781     not yet) and the <a href="ExceptionHandling.html">Exception Handling
782     documentation</a> for more information.</li>
783 <li>The LLVM IR Type system has been redesigned and reimplemented, making it
784     faster and solving some long-standing problems.
785     Please see its <a 
786     href="http://blog.llvm.org/2011/11/llvm-30-type-system-rewrite.html">blog
787     post</a> for more information.</li>
788   
789 <li>The MIPS backend has made major leaps in this release, going from an
790     experimental target to being virtually production quality and supporting a
791     wide variety of MIPS subtargets.  See the <a href="#MIPS">MIPS section</a>
792     below for more information.</li>
793   
794 <li>The optimizer and code generator now supports gprof and gcov-style coverage
795     and profiling information, and includes a new llvm-cov tool (but also works
796     with gcov).  Clang exposes coverage and profiling through GCC-compatible
797     command line options.</li>
798 </ul>
799
800 </div>
801
802   
803 <!--=========================================================================-->
804 <h3>
805 <a name="coreimprovements">LLVM IR and Core Improvements</a>
806 </h3>
807
808 <div>
809
810 <p>LLVM IR has several new features for better support of new targets and that
811    expose new optimization opportunities:</p>
812
813   <ul>
814   <li><a href="Atomics.html">Atomic memory accesses and memory ordering</a> are
815       now directly expressible in the IR.</li>
816   <li>A new <a href="LangRef.html#int_fma">llvm.fma intrinsic</a> directly
817     represents floating point multiply accumulate operations without an
818     intermediate rounding stage.</li>
819   <li>A new llvm.expect intrinsic (XXX not documented in langref) allows a
820      frontend to express expected control flow (and the __builtin_expect builtin
821     from GNU C).</li>
822   <li>The <a href="LangRef.html#int_prefetch">llvm.prefetch intrinsic</a> now
823     takes a 4th argument that specifies whether the prefetch happens from the
824     icache or dcache.</li>
825   <li>The new <a href="LangRef.html#uwtable">uwtable function attribute</a>
826     allows a frontend to control emission of unwind tables.</li>
827   <li>The new <a href="LangRef.html#fnattrs">nonlazybind function
828     attribute</a> allow optimization of Global Offset Table (GOT) accesses.</li>
829   <li>The new <a href="LangRef.html#returns_twice">returns_twice attribute</a>
830     allows better modeling of functions like setjmp.</li>
831   <li>The <a href="LangRef.html#datalayout">target datalayout</a> string can now
832     encode the natural alignment of the target's stack for better optimization.
833     </li>
834   </ul>
835 </div>
836
837 <!--=========================================================================-->
838 <h3>
839 <a name="optimizer">Optimizer Improvements</a>
840 </h3>
841
842 <div>
843
844 <p>In addition to many minor performance tweaks and bug fixes, this
845    release includes a few major enhancements and additions to the
846    optimizers:</p>
847
848 <ul>
849 <li>The pass manager now has an extension API that allows front-ends and plugins
850     to insert their own optimizations in the well-known places in the standard
851     pass optimization pipeline.</li>
852
853 <li>Information about <a href="BranchWeightMetadata.html">branch probability</a>
854     and basic block frequency is now available within LLVM, based on a
855     combination of static branch prediction heuristics and
856     <code>__builtin_expect</code> calls.  That information is currently used for
857     register spill placement and if-conversion, with additional optimizations
858     planned for future releases.  The same framework is intended for eventual
859     use with profile-guided optimization.</li>
860   
861 <li>The "-indvars" induction variable simplification pass only modifies
862     induction variables when profitable. Sign and zero extension
863     elimination, linear function test replacement, loop unrolling, and
864     other simplifications that require induction variable analysis have
865     been generalized so they no longer require loops to be rewritten into 
866     canonical form prior to optimization. This new design
867     preserves more IR level information, avoids undoing earlier loop
868     optimizations (particularly hand-optimized loops), and no longer
869     requires the code generator to reconstruct loops into an optimal form -
870     an intractable problem.</li>
871
872 <li>LLVM now includes a pass to optimize retain/release calls for the
873   <a href="http://clang.llvm.org/docs/AutomaticReferenceCounting.html">Automatic
874     Reference Counting</a> (ARC) Objective-C language feature (in
875     lib/Transforms/ObjCARC).  It is a decent example of implementing a
876     source-language-specific optimization in LLVM.</li>
877
878 </ul>
879
880 </div>
881
882 <!--=========================================================================-->
883 <h3>
884 <a name="mc">MC Level Improvements</a>
885 </h3>
886
887 <div>
888
889 <p>The LLVM Machine Code (aka MC) subsystem was created to solve a number of
890    problems in the realm of assembly, disassembly, object file format handling,
891    and a number of other related areas that CPU instruction-set level tools work
892    in.</p>
893
894 <ul>
895   <li>The ELF object streamers are much more full featured.</li>
896   <li>Target dependent relocation handling has been refactored into the Targets.</li>
897   <li>Early stage MC-JIT infrastructure has been implemented.</li>
898 </ul>
899
900 <p>The MC-JIT is a major new feature for MC, and will eventually grow to replace
901 the current JIT implementation. It emits object files direct to memory and
902 uses a runtime dynamic linker to resolve references and drive lazy compilation.
903 The MC-JIT enables much greater code reuse between the JIT and the static
904 compiler and provides better integration with the platform ABI as a result.</p>
905
906 <p>For more information, please see
907    the <a href="http://blog.llvm.org/2010/04/intro-to-llvm-mc-project.html">Intro
908    to the LLVM MC Project Blog Post</a>.</p>
909
910   
911   InstAliases now automatically used in the asmprinter where they are shorter.
912
913   Table generated MC expansion logic for pseudo instructions that expand to multiple MC instructions through the PseudoInstExpansion class. (JimG)
914   
915   #line directives in integrated assembler
916
917   llvm-rtdyld: JimG
918   llvm-objdump / dwarf parser library / llvm-dwarfdump (d0k)
919   object file parsing stuff and llvm-size (mspencer)
920
921 </div>
922
923 <!--=========================================================================-->
924 <h3>
925 <a name="codegen">Target Independent Code Generator Improvements</a>
926 </h3>
927
928 <div>
929
930 <p>We have put a significant amount of work into the code generator
931    infrastructure, which allows us to implement more aggressive algorithms and
932    make it run faster:</p>
933
934 <ul>
935   
936   better performance for indirect gotos through new tail dup pass.
937
938   Codegen now supports vector "select" operations on vector comparisons, turning
939   them into various optimized code sequences (e.g. using the SSE4/AVX "blend"
940   instructions).
941
942   EH and debug information produced with CFI directives, yielding smaller executables: http://blog.mozilla.com/respindola/2011/05/12/cfi-directives/
943
944   Domain fixing pass is now target independent (ExecutionDepsFix pass). (Jakob)
945
946 <!--
947 <li></li>
948 -->
949 </ul>
950 </div>
951
952 <!--=========================================================================-->
953 <h3>
954 <a name="x86">X86-32 and X86-64 Target Improvements</a>
955 </h3>
956
957 <div>
958
959 <p>New features and major changes in the X86 target include:</p>
960
961 <ul>
962   <li>The X86 backend, assembler and disassembler now completely support AVX.
963       To enable it pass <code>-mavx</code> to the compiler.</li>
964
965   <li>The X86 backend now supports
966     all <a href="http://llvm.org/PR879">inline assembly that uses the X86
967       floating point stack</a>.</li>
968   
969   <li>The CRC32 intrinsics have been renamed.  The intrinsics were previously
970       <code>@llvm.x86.sse42.crc32.[8|16|32]</code>
971       and <code>@llvm.x86.sse42.crc64.[8|64]</code>. They have been renamed to
972       <code>@llvm.x86.sse42.crc32.32.[8|16|32]</code> and
973       <code>@llvm.x86.sse42.crc32.64.[8|64]</code>.</li>
974
975   X86: inline assembler supports .code32 and .code64.
976   AVX support, assembler, compiler and disassembler.
977   X86 backend support for NaCl (David Meyer / Nick L)
978   SSE domain fixing code enabled for AVX (Bruno/Jakob).  
979   X86 backend synthesizes horizontal add/sub instructions from generic code.
980   X86: Tons of encoding improvements and new instructions (e.g. Atom, Ivy Bridge,
981   and BMI instructions)
982   added to assembler and disassembler (Craig Topper)
983   X86-64 generates smaller and faster code at -O0 (fast isel improvements)
984
985 </ul>
986
987 </div>
988
989 <!--=========================================================================-->
990 <h3>
991 <a name="ARM">ARM Target Improvements</a>
992 </h3>
993
994 <div>
995
996 <p>New features of the ARM target include:</p>
997
998 <ul>
999   <li>Reworked Set Jump Long Jump EH Lowering,</li>
1000   <li>improved support for Cortex-M series processors, and</li>
1001   <li>beta quality integrated assembler support.</li>
1002   
1003   Better code generation for Cortex-A9
1004   ARM inline asm constraints implemented.
1005   Old arm disassembler replaced with a new one based on autogenerated encoding information from ARM .td files.
1006   Better performance for Neon code in clang due to SRoA improvements.
1007
1008 </ul>
1009 </div>
1010
1011   
1012 <!--=========================================================================-->
1013 <h3>
1014 <a name="MIPS">MIPS Target Improvements</a>
1015 </h3>
1016
1017 <div>
1018
1019 <p>New features and major changes in the MIPS target include:</p>
1020
1021 <ul>
1022   <li>Most MIPS32r1 and r2 instructions are now supported.</li>
1023   <li>LE/BE MIPS32r1/r2 has been tested extensively.</li>
1024   <li>O32 ABI has been fully tested.</li>
1025   <li>MIPS backend has migrated to using the MC infrastructure for assembly printing. Initial support for direct object code emission has been implemented too.</li>
1026   <li>Delay slot filler has been updated. Now it tries to fill delay slots with useful instructions instead of always filling them with NOPs.</li> 
1027   <li>Support for old-style JIT is complete.</li>
1028   <li>Support for old architectures (MIPS1 and MIPS2) has been removed.</li>
1029   <li>Initial support for MIPS64 has been added.</li>
1030 </ul>
1031 </div>
1032
1033 <!--=========================================================================-->
1034 <h3>
1035   <a name="PTX">PTX Target Improvements</a>
1036 </h3>
1037
1038 <div>
1039   
1040   <p>
1041   The PTX back-end is still experimental, but is fairly usable for compute kernels
1042   in LLVM 3.0.  Most scalar arithmetic is implemented, as well as intrinsics to
1043   access the special PTX registers and sync instructions.  The major missing
1044   pieces are texture/sampler support and some vector operations.</p>
1045   
1046   <p>That said, the backend is already being used for domain-specific languages
1047   and works well with the <a href="http://www.pcc.me.uk/~peter/libclc/">libclc
1048     library</a> to supply OpenCL built-ins.  With it, you can use Clang to compile
1049   OpenCL code into PTX and execute it by loading the resulting PTX as a binary
1050   blob using the nVidia OpenCL library.  It has been tested with several OpenCL
1051   programs, including some from the nVidia GPU Computing SDK, and the performance
1052   is on par with the nVidia compiler.</p>
1053   
1054 </div>
1055
1056 <!--=========================================================================-->
1057 <h3>
1058 <a name="OtherTS">Other Target Specific Improvements</a>
1059 </h3>
1060
1061 <div>
1062
1063   <p>PPC32/ELF va_arg was implemented.</p>
1064   <p>PPC32 initial support for .o file writing was implemented.</p>
1065   <p>MicroBlaze scheduling itineraries were added that model the
1066      3-stage and the 5-stage pipeline architectures. The 3-stage
1067      pipeline model can be selected with <code>-mcpu=mblaze3</code> 
1068      and the 5-stage pipeline model can be selected with 
1069      <code>-mcpu=mblaze5</code>.</p>
1070   
1071 <ul>
1072 <!--
1073 <li></li>
1074 -->
1075 </ul>
1076
1077 </div>
1078
1079 <!--=========================================================================-->
1080 <h3>
1081 <a name="changes">Major Changes and Removed Features</a>
1082 </h3>
1083
1084 <div>
1085
1086 <p>If you're already an LLVM user or developer with out-of-tree changes based on
1087    LLVM 2.9, this section lists some "gotchas" that you may run into upgrading
1088    from the previous release.</p>
1089
1090 <ul>
1091   <li>LLVM's configure script doesn't depend on llvm-gcc anymore, clean layering.</p>
1092   LLVM 3.0 removes support for reading LLVM 2.8 and earlier files.  Aim to maintain compatibility all the way back to 3.0 "forever".
1093   Frontend tests removed from llvm/test/Frontend* 
1094   Tablegen has been split into a library, clang tblgen pieces now live in clang.
1095   The llvm version is now named llvm-tblgen instead of tblgen.
1096     PostOrder Dominator frontiers were removed.
1097     LowerSetJmp pass removed, unused.
1098
1099
1100   <li>The <code>LLVMC</code> meta compiler driver was removed.</li>
1101   <li>The <code>LowerSetJmp</code> pass wasn't used effectively by any
1102       target and has been removed.</li>
1103   <li>The old <code>TailDup</code> pass was not used in the standard pipeline
1104       and was unable to update ssa form, so it has been removed.
1105   <li>The syntax of volatile loads and stores in IR has been changed to
1106       "<code>load volatile</code>"/"<code>store volatile</code>".  The old
1107       syntax ("<code>volatile load</code>"/"<code>volatile store</code>")
1108       is still accepted, but is now considered deprecated.</li>
1109   <li>The old atomic intrinsics (<code>llvm.memory.barrier</code> and
1110       <code>llvm.atomic.*</code>) are now gone.  Please use the new atomic
1111       instructions, described in the <a href="Atomics.html">atomics guide</a>.
1112 </ul>
1113
1114 <h4>Windows (32-bit)</h4>
1115 <div>
1116
1117 <ul>
1118   <li>On Win32(MinGW32 and MSVC), Windows 2000 will not be supported.
1119       Windows XP or higher is required.</li>
1120 </ul>
1121
1122 </div>
1123
1124 </div>
1125
1126 <!--=========================================================================-->
1127 <h3>
1128 <a name="api_changes">Internal API Changes</a>
1129 </h3>
1130
1131 <div>
1132
1133 <p>In addition, many APIs have changed in this release.  Some of the major
1134    LLVM API changes are:</p>
1135
1136 <ul>
1137   <li>The biggest and most pervasive change is that llvm::Types are no longer
1138       returned or accepted as 'const' values.  Instead, just pass around
1139       non-const Types.</li>
1140   
1141   <li><code>PHINode::reserveOperandSpace</code> has been removed. Instead, you
1142       must specify how many operands to reserve space for when you create the
1143       PHINode, by passing an extra argument
1144       into <code>PHINode::Create</code>.</li>
1145
1146   <li>PHINodes no longer store their incoming BasicBlocks as operands. Instead,
1147       the list of incoming BasicBlocks is stored separately, and can be accessed
1148       with new functions <code>PHINode::block_begin</code>
1149       and <code>PHINode::block_end</code>.</li>
1150
1151   <li>Various functions now take an <code>ArrayRef</code> instead of either a
1152       pair of pointers (or iterators) to the beginning and end of a range, or a
1153       pointer and a length. Others now return an <code>ArrayRef</code> instead
1154       of a reference to a <code>SmallVector</code>
1155       or <code>std::vector</code>. These include:
1156 <ul>
1157 <!-- Please keep this list sorted. -->
1158 <li><code>CallInst::Create</code></li>
1159 <li><code>ComputeLinearIndex</code> (in <code>llvm/CodeGen/Analysis.h</code>)</li>
1160 <li><code>ConstantArray::get</code></li>
1161 <li><code>ConstantExpr::getExtractElement</code></li>
1162 <li><code>ConstantExpr::getGetElementPtr</code></li>
1163 <li><code>ConstantExpr::getInBoundsGetElementPtr</code></li>
1164 <li><code>ConstantExpr::getIndices</code></li>
1165 <li><code>ConstantExpr::getInsertElement</code></li>
1166 <li><code>ConstantExpr::getWithOperands</code></li>
1167 <li><code>ConstantFoldCall</code> (in <code>llvm/Analysis/ConstantFolding.h</code>)</li>
1168 <li><code>ConstantFoldInstOperands</code> (in <code>llvm/Analysis/ConstantFolding.h</code>)</li>
1169 <li><code>ConstantVector::get</code></li>
1170 <li><code>DIBuilder::createComplexVariable</code></li>
1171 <li><code>DIBuilder::getOrCreateArray</code></li>
1172 <li><code>ExtractValueInst::Create</code></li>
1173 <li><code>ExtractValueInst::getIndexedType</code></li>
1174 <li><code>ExtractValueInst::getIndices</code></li>
1175 <li><code>FindInsertedValue</code> (in <code>llvm/Analysis/ValueTracking.h</code>)</li>
1176 <li><code>gep_type_begin</code> (in <code>llvm/Support/GetElementPtrTypeIterator.h</code>)</li>
1177 <li><code>gep_type_end</code> (in <code>llvm/Support/GetElementPtrTypeIterator.h</code>)</li>
1178 <li><code>GetElementPtrInst::Create</code></li>
1179 <li><code>GetElementPtrInst::CreateInBounds</code></li>
1180 <li><code>GetElementPtrInst::getIndexedType</code></li>
1181 <li><code>InsertValueInst::Create</code></li>
1182 <li><code>InsertValueInst::getIndices</code></li>
1183 <li><code>InvokeInst::Create</code></li>
1184 <li><code>IRBuilder::CreateCall</code></li>
1185 <li><code>IRBuilder::CreateExtractValue</code></li>
1186 <li><code>IRBuilder::CreateGEP</code></li>
1187 <li><code>IRBuilder::CreateInBoundsGEP</code></li>
1188 <li><code>IRBuilder::CreateInsertValue</code></li>
1189 <li><code>IRBuilder::CreateInvoke</code></li>
1190 <li><code>MDNode::get</code></li>
1191 <li><code>MDNode::getIfExists</code></li>
1192 <li><code>MDNode::getTemporary</code></li>
1193 <li><code>MDNode::getWhenValsUnresolved</code></li>
1194 <li><code>SimplifyGEPInst</code> (in <code>llvm/Analysis/InstructionSimplify.h</code>)</li>
1195 <li><code>TargetData::getIndexedOffset</code></li>
1196 </ul></li>
1197
1198   <li>All forms of <code>StringMap::getOrCreateValue</code> have been remove
1199       except for the one which takes a <code>StringRef</code>.</li>
1200
1201   <li>The <code>LLVMBuildUnwind</code> function from the C API was removed. The
1202       LLVM <code>unwind</code> instruction has been deprecated for a long time
1203       and isn't used by the current front-ends. So this was removed during the
1204       exception handling rewrite.</li>
1205
1206   <li>The <code>LLVMAddLowerSetJmpPass</code> function from the C API was
1207       removed because the <code>LowerSetJmp</code> pass was removed.</li>
1208
1209   <li>The <code>DIBuilder</code> interface used by front ends to encode
1210       debugging information in the LLVM IR now expects clients to
1211       use <code>DIBuilder::finalize()</code> at the end of translation unit to
1212       complete debugging information encoding.</li>
1213
1214   <li>The way the type system works has been
1215       rewritten: <code>PATypeHolder</code> and <code>OpaqueType</code> are gone,
1216       and all APIs deal with <code>Type*</code> instead of <code>const
1217       Type*</code>.  If you need to create recursive structures, then create a
1218       named structure, and use <code>setBody()</code> when all its elements are
1219       built.  Type merging and refining is gone too: named structures are not
1220       merged with other structures, even if their layout is identical.  (of
1221       course anonymous structures are still uniqued by layout).</li>
1222
1223   <li>TargetSelect.h moved to Support/ from Target/</li>
1224
1225   <li>UpgradeIntrinsicCall no longer upgrades pre-2.9 intrinsic calls (for
1226       example <code>llvm.memset.i32</code>).</li>
1227
1228   <li>It is mandatory to initialize all out-of-tree passes too and their dependencies now with
1229       <code>INITIALIZE_PASS{BEGIN,END,}</code>
1230       and <code>INITIALIZE_{PASS,AG}_DEPENDENCY</code>.</li>
1231
1232   <li>The interface for MemDepResult in MemoryDependenceAnalysis has been
1233       enhanced with new return types Unknown and NonFuncLocal, in addition to
1234       the existing types Clobber, Def, and NonLocal.</li>
1235 </ul>
1236
1237 </div>
1238
1239 </div>
1240
1241 <!-- *********************************************************************** -->
1242 <h2>
1243   <a name="knownproblems">Known Problems</a>
1244 </h2>
1245 <!-- *********************************************************************** -->
1246
1247 <div>
1248
1249 <p>LLVM is generally a production quality compiler, and is used by a broad range
1250    of applications and shipping in many products.  That said, not every
1251    subsystem is as mature as the aggregate, particularly the more obscure
1252    targets.  If you run into a problem, please check the <a
1253    href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
1254    there isn't already one or ask on the <a
1255     href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev
1256     list</a>.</p>
1257   
1258   <p>Known problem areas include:</p>
1259   
1260 <ul>
1261   <li>The Alpha, Blackfin, CellSPU, MSP430, PTX, SystemZ and
1262       XCore backends are experimental, and the Alpha, Blackfin and SystemZ
1263       targets have already been removed from mainline.</li>
1264
1265   <li>The integrated assembler, disassembler, and JIT is not supported by
1266       several targets.  If an integrated assembler is not supported, then a
1267       system assembler is required.  For more details, see the <a
1268       href="CodeGenerator.html#targetfeatures">Target Features Matrix</a>.
1269   </li>
1270   
1271   <li>The C backend has numerous problems and is not being actively maintained.
1272     Depending on it for anything serious is not advised.</li>
1273 </ul>
1274
1275 </div>
1276
1277 </div>
1278
1279 <!-- *********************************************************************** -->
1280 <h2>
1281   <a name="additionalinfo">Additional Information</a>
1282 </h2>
1283 <!-- *********************************************************************** -->
1284
1285 <div>
1286
1287 <p>A wide variety of additional information is available on
1288    the <a href="http://llvm.org/">LLVM web page</a>, in particular in
1289    the <a href="http://llvm.org/docs/">documentation</a> section.  The web page
1290    also contains versions of the API documentation which is up-to-date with the
1291    Subversion version of the source code.  You can access versions of these
1292    documents specific to this release by going into the "<tt>llvm/doc/</tt>"
1293    directory in the LLVM tree.</p>
1294
1295 <p>If you have any questions or comments about LLVM, please feel free to contact
1296    us via the <a href="http://llvm.org/docs/#maillist"> mailing lists</a>.</p>
1297
1298 </div>
1299
1300 <!--=========================================================================-->
1301
1302 <!-- EH details: to be moved to a blog post:
1303  
1304
1305   
1306   
1307 <p>One of the biggest changes is that 3.0 has a new exception handling
1308    system. The old system used LLVM intrinsics to convey the exception handling
1309    information to the code generator. It worked in most cases, but not
1310    all. Inlining was especially difficult to get right. Also, the intrinsics
1311    could be moved away from the <code>invoke</code> instruction, making it hard
1312    to recover that information.</p>
1313
1314 <p>The new EH system makes exception handling a first-class member of the IR. It
1315    adds two new instructions:</p>
1316
1317 <ul>
1318   <li><a href="LangRef.html#i_landingpad"><code>landingpad</code></a> &mdash;
1319       this instruction defines a landing pad basic block. It contains all of the
1320       information that's needed by the code generator. It's also required to be
1321       the first non-PHI instruction in the landing pad. In addition, a landing
1322       pad may be jumped to only by the unwind edge of an <code>invoke</code>
1323       instruction.</li>
1324
1325   <li><a href="LangRef.html#i_resume"><code>resume</code></a> &mdash; this
1326       instruction causes the current exception to resume traveling up the
1327       stack. It replaces the <code>@llvm.eh.resume</code> intrinsic.</li>
1328 </ul>
1329
1330 <p>Converting from the old EH API to the new EH API is rather simple, because a
1331    lot of complexity has been removed. The two intrinsics,
1332    <code>@llvm.eh.exception</code> and <code>@llvm.eh.selector</code> have been
1333    superseded by the <code>landingpad</code> instruction. Instead of generating
1334    a call to <code>@llvm.eh.exception</code> and <code>@llvm.eh.selector</code>:
1335
1336 <div class="doc_code">
1337 <pre>
1338 Function *ExcIntr = Intrinsic::getDeclaration(TheModule,
1339                                               Intrinsic::eh_exception);
1340 Function *SlctrIntr = Intrinsic::getDeclaration(TheModule,
1341                                                 Intrinsic::eh_selector);
1342
1343 // The exception pointer.
1344 Value *ExnPtr = Builder.CreateCall(ExcIntr, "exc_ptr");
1345
1346 std::vector&lt;Value*&gt; Args;
1347 Args.push_back(ExnPtr);
1348 Args.push_back(Builder.CreateBitCast(Personality,
1349                                      Type::getInt8PtrTy(Context)));
1350
1351 <i>// Add selector clauses to Args.</i>
1352
1353 // The selector call.
1354 Builder.CreateCall(SlctrIntr, Args, "exc_sel");
1355 </pre>
1356 </div>
1357
1358 <p>You should instead generate a <code>landingpad</code> instruction, that
1359    returns an exception object and selector value:</p>
1360
1361 <div class="doc_code">
1362 <pre>
1363 LandingPadInst *LPadInst =
1364   Builder.CreateLandingPad(StructType::get(Int8PtrTy, Int32Ty, NULL),
1365                            Personality, 0);
1366
1367 Value *LPadExn = Builder.CreateExtractValue(LPadInst, 0);
1368 Builder.CreateStore(LPadExn, getExceptionSlot());
1369
1370 Value *LPadSel = Builder.CreateExtractValue(LPadInst, 1);
1371 Builder.CreateStore(LPadSel, getEHSelectorSlot());
1372 </pre>
1373 </div>
1374
1375 <p>It's now trivial to add the individual clauses to the <code>landingpad</code>
1376    instruction.</p>
1377
1378 <div class="doc_code">
1379 <pre>
1380 <i><b>// Adding a catch clause</b></i>
1381 Constant *TypeInfo = getTypeInfo();
1382 LPadInst-&gt;addClause(TypeInfo);
1383
1384 <i><b>// Adding a C++ catch-all</b></i>
1385 LPadInst-&gt;addClause(Constant::getNullValue(Builder.getInt8PtrTy()));
1386
1387 <i><b>// Adding a cleanup</b></i>
1388 LPadInst-&gt;setCleanup(true);
1389
1390 <i><b>// Adding a filter clause</b></i>
1391 std::vector&lt;Constant*&gt; TypeInfos;
1392 Constant *TypeInfo = getFilterTypeInfo();
1393 TypeInfos.push_back(Builder.CreateBitCast(TypeInfo, Builder.getInt8PtrTy()));
1394
1395 ArrayType *FilterTy = ArrayType::get(Int8PtrTy, TypeInfos.size());
1396 LPadInst-&gt;addClause(ConstantArray::get(FilterTy, TypeInfos));
1397 </pre>
1398 </div>
1399
1400 <p>Converting from using the <code>@llvm.eh.resume</code> intrinsic to
1401    the <code>resume</code> instruction is trivial. It takes the exception
1402    pointer and exception selector values returned by
1403    the <code>landingpad</code> instruction:</p>
1404
1405 <div class="doc_code">
1406 <pre>
1407 Type *UnwindDataTy = StructType::get(Builder.getInt8PtrTy(),
1408                                      Builder.getInt32Ty(), NULL);
1409 Value *UnwindData = UndefValue::get(UnwindDataTy);
1410 Value *ExcPtr = Builder.CreateLoad(getExceptionObjSlot());
1411 Value *ExcSel = Builder.CreateLoad(getExceptionSelSlot());
1412 UnwindData = Builder.CreateInsertValue(UnwindData, ExcPtr, 0, "exc_ptr");
1413 UnwindData = Builder.CreateInsertValue(UnwindData, ExcSel, 1, "exc_sel");
1414 Builder.CreateResume(UnwindData);
1415 </pre>
1416 </div>
1417
1418
1419  
1420  
1421  -->
1422
1423   
1424 <!-- *********************************************************************** -->
1425
1426 <hr>
1427 <address>
1428   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
1429   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
1430   <a href="http://validator.w3.org/check/referer"><img
1431   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
1432
1433   <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
1434   Last modified: $Date$
1435 </address>
1436
1437 </body>
1438 </html>