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