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