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