8a4a76d94881488706e3216a391ed71958fcb577
[oota-llvm.git] / docs / ReleaseNotes.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2                       "http://www.w3.org/TR/html4/strict.dtd">
3 <html>
4 <head>
5   <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
6   <link rel="stylesheet" href="llvm.css" type="text/css">
7   <title>LLVM 3.0 Release Notes</title>
8 </head>
9 <body>
10
11 <h1>LLVM 3.0 Release Notes</h1>
12
13 <img align=right src="http://llvm.org/img/DragonSmall.png"
14     width="136" height="136" alt="LLVM Dragon Logo">
15
16 <ol>
17   <li><a href="#intro">Introduction</a></li>
18   <li><a href="#subproj">Sub-project Status Update</a></li>
19   <li><a href="#externalproj">External Projects Using LLVM 3.0</a></li>
20   <li><a href="#whatsnew">What's New in LLVM 3.0?</a></li>
21   <li><a href="GettingStarted.html">Installation Instructions</a></li>
22   <li><a href="#knownproblems">Known Problems</a></li>
23   <li><a href="#additionalinfo">Additional Information</a></li>
24 </ol>
25
26 <div class="doc_author">
27   <p>Written by the <a href="http://llvm.org/">LLVM Team</a></p>
28 </div>
29
30 <!--
31 <h1 style="color:red">These are in-progress notes for the upcoming LLVM 3.0
32 release.<br>
33 You may prefer the
34 <a href="http://llvm.org/releases/2.9/docs/ReleaseNotes.html">LLVM 2.9
35 Release Notes</a>.</h1>
36  -->
37
38 <!-- *********************************************************************** -->
39 <h2>
40   <a name="intro">Introduction</a>
41 </h2>
42 <!-- *********************************************************************** -->
43
44 <div>
45
46 <p>This document contains the release notes for the LLVM Compiler
47 Infrastructure, release 3.0.  Here we describe the status of LLVM, including
48 major improvements from the previous release and significant known problems.
49 All LLVM releases may be downloaded from the <a
50 href="http://llvm.org/releases/">LLVM releases web site</a>.</p>
51
52 <p>For more information about LLVM, including information about the latest
53 release, please check out the <a href="http://llvm.org/">main LLVM
54 web site</a>.  If you have questions or comments, the <a
55 href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM Developer's
56 Mailing List</a> is a good place to send them.</p>
57
58 <p>Note that if you are reading this file from a Subversion checkout or the
59 main LLVM web page, this document applies to the <i>next</i> release, not the
60 current one.  To see the release notes for a specific release, please see the
61 <a href="http://llvm.org/releases/">releases page</a>.</p>
62
63 </div>
64    
65 <!-- Features that need text if they're finished for 3.1:
66   ARM EHABI
67   combiner-aa?
68   strong phi elim
69   loop dependence analysis
70   CorrelatedValuePropagation
71   lib/Transforms/IPO/MergeFunctions.cpp => consider for 3.1.
72  -->
73  
74 <!-- *********************************************************************** -->
75 <h2>
76   <a name="subproj">Sub-project Status Update</a>
77 </h2>
78 <!-- *********************************************************************** -->
79
80 <div>
81 <p>
82 The LLVM 3.0 distribution currently consists of code from the core LLVM
83 repository (which roughly includes the LLVM optimizers, code generators
84 and supporting tools), the Clang repository and the llvm-gcc repository.  In
85 addition to this code, the LLVM Project includes other sub-projects that are in
86 development.  Here we include updates on these subprojects.
87 </p>
88
89 <!--=========================================================================-->
90 <h3>
91 <a name="clang">Clang: C/C++/Objective-C Frontend Toolkit</a>
92 </h3>
93
94 <div>
95
96 <p><a href="http://clang.llvm.org/">Clang</a> is an LLVM front end for the C,
97 C++, and Objective-C languages. Clang aims to provide a better user experience
98 through expressive diagnostics, a high level of conformance to language
99 standards, fast compilation, and low memory use. Like LLVM, Clang provides a
100 modular, library-based architecture that makes it suitable for creating or
101 integrating with other development tools. Clang is considered a
102 production-quality compiler for C, Objective-C, C++ and Objective-C++ on x86
103 (32- and 64-bit), and for darwin/arm targets.</p>
104
105 <p>In the LLVM 3.0 time-frame, the Clang team has made many improvements:</p>
106
107 <ul>
108   <li>Greatly improved support for building C++ applications, with greater stability and better diagnostics.</li>
109   
110   <li><a href="http://clang.llvm.org/cxx_status.html">Improved support</a> for the <a href="http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=50372 ">C++ 2011</a> standard, including implementations of non-static data member initializers, alias templates, delegating constructors, the range-based for loop, and implicitly-generated move constructors and move assignment operators, among others.</li>
111
112   <li>Implemented support for some features of the upcoming C1x standard, including static assertions and generic selections.</li>
113   
114   <li>Better detection of include and linking paths for system headers and libraries, especially for Linux distributions.</li>
115
116   <li>Implemented support for <a href="http://clang.llvm.org/docs/AutomaticReferenceCounting.html">Automatic Reference Counting</a> for Objective-C.</li>
117
118   <li>Implemented a number of optimizations in <tt>libclang</tt>, the Clang C interface, to improve the performance of code completion and the mapping from source locations to abstract syntax tree nodes.</li>
119 </ul>
120
121   
122 <p>If Clang rejects your code but another compiler accepts it, please take a
123 look at the <a href="http://clang.llvm.org/compatibility.html">language
124 compatibility</a> guide to make sure this is not intentional or a known issue.
125 </p>
126
127 </div>
128
129 <!--=========================================================================-->
130 <h3>
131 <a name="dragonegg">DragonEgg: GCC front-ends, LLVM back-end</a>
132 </h3>
133
134 <div>
135 <p>
136 <a href="http://dragonegg.llvm.org/">DragonEgg</a> is a
137 <a href="http://gcc.gnu.org/wiki/plugins">gcc plugin</a> that replaces GCC's
138 optimizers and code generators with LLVM's.
139 Currently it requires a patched version of gcc-4.5.
140 The plugin can target the x86-32 and x86-64 processor families and has been
141 used successfully on the Darwin, FreeBSD and Linux platforms.
142 The Ada, C, C++ and Fortran languages work well.
143 The plugin is capable of compiling plenty of Obj-C, Obj-C++ and Java but it is
144 not known whether the compiled code actually works or not!
145 </p>
146
147 <p>
148 The 3.0 release has the following notable changes:
149 <ul>
150 <!--
151 <li></li>
152 -->
153 </ul>
154
155 </div>
156
157 <!--=========================================================================-->
158 <h3>
159 <a name="compiler-rt">compiler-rt: Compiler Runtime Library</a>
160 </h3>
161
162 <div>
163 <p>
164 The new LLVM <a href="http://compiler-rt.llvm.org/">compiler-rt project</a>
165 is a simple library that provides an implementation of the low-level
166 target-specific hooks required by code generation and other runtime components.
167 For example, when compiling for a 32-bit target, converting a double to a 64-bit
168 unsigned integer is compiled into a runtime call to the "__fixunsdfdi"
169 function. The compiler-rt library provides highly optimized implementations of
170 this and other low-level routines (some are 3x faster than the equivalent
171 libgcc routines).</p>
172
173 <p>In the LLVM 3.0 timeframe,</p>
174
175 </div>
176
177 <!--=========================================================================-->
178 <h3>
179 <a name="lldb">LLDB: Low Level Debugger</a>
180 </h3>
181
182 <div>
183 <p>
184 <a href="http://lldb.llvm.org/">LLDB</a> is a brand new member of the LLVM
185 umbrella of projects. LLDB is a next generation, high-performance debugger. It
186 is built as a set of reusable components which highly leverage existing
187 libraries in the larger LLVM Project, such as the Clang expression parser, the
188 LLVM disassembler and the LLVM JIT.</p>
189
190 <p>
191 LLDB is has advanced by leaps and bounds in the 3.0 timeframe.  It is
192 dramatically more stable and useful, and includes both a new <a 
193 href="http://lldb.llvm.org/tutorial.html">tutorial</a> and a <a
194 href="http://lldb.llvm.org/lldb-gdb.html">side-by-side comparison with 
195 GDB</a>.</p>
196
197 </div>
198
199 <!--=========================================================================-->
200 <h3>
201 <a name="libc++">libc++: C++ Standard Library</a>
202 </h3>
203
204 <div>
205 <p>
206 <a href="http://libcxx.llvm.org/">libc++</a> is another new member of the LLVM
207 family.  It is an implementation of the C++ standard library, written from the
208 ground up to specifically target the forthcoming C++'0X standard and focus on
209 delivering great performance.</p>
210
211 <p>
212 In the LLVM 3.0 timeframe,</p>
213   
214 <p>
215 Like compiler_rt, libc++ is now <a href="DeveloperPolicy.html#license">dual
216   licensed</a> under the MIT and UIUC license, allowing it to be used more
217   permissively.
218 </p>
219
220 </div>
221
222
223 <!--=========================================================================-->
224 <h3>
225 <a name="LLBrowse">LLBrowse: IR Browser</a>
226 </h3>
227
228 <div>
229 <p>
230 <a href="http://llvm.org/svn/llvm-project/llbrowse/trunk/doc/LLBrowse.html">
231   LLBrowse</a> is an interactive viewer for LLVM modules. It can load any LLVM
232   module and displays its contents as an expandable tree view, facilitating an
233   easy way to inspect types, functions, global variables, or metadata nodes. It
234   is fully cross-platform, being based on the popular wxWidgets GUI toolkit.
235 </p>
236 </div>
237
238 <!--=========================================================================-->
239 <h3>
240 <a name="vmkit">VMKit</a>
241 </h3>
242
243 <div>
244 <p>The <a href="http://vmkit.llvm.org/">VMKit project</a> is an implementation
245   of a Java Virtual Machine (Java VM or JVM) that uses LLVM for static and
246   just-in-time compilation. As of LLVM 3.0, VMKit now supports generational
247   garbage collectors. The garbage collectors are provided by the MMTk framework,
248   and VMKit can be configured to use one of the numerous implemented collectors
249   of MMTk.
250 </p>
251 </div>
252   
253   
254 <!--=========================================================================-->
255 <!--
256 <h3>
257 <a name="klee">KLEE: A Symbolic Execution Virtual Machine</a>
258 </h3>
259
260 <div>
261 <p>
262 <a href="http://klee.llvm.org/">KLEE</a> is a symbolic execution framework for
263 programs in LLVM bitcode form. KLEE tries to symbolically evaluate "all" paths
264 through the application and records state transitions that lead to fault
265 states. This allows it to construct testcases that lead to faults and can even
266 be used to verify some algorithms.
267 </p>
268
269 <p>UPDATE!</p>
270 </div>-->
271
272 </div>
273
274 <!-- *********************************************************************** -->
275 <h2>
276   <a name="externalproj">External Open Source Projects Using LLVM 3.0</a>
277 </h2>
278 <!-- *********************************************************************** -->
279
280 <div>
281
282 <p>An exciting aspect of LLVM is that it is used as an enabling technology for
283    a lot of other language and tools projects.  This section lists some of the
284    projects that have already been updated to work with LLVM 3.0.</p>
285
286 <!--=========================================================================-->
287
288 <!-- FIXME: Comment out
289 <h3>Crack Programming Language</h3>
290
291 <div>
292 <p>
293 <a href="http://code.google.com/p/crack-language/">Crack</a> aims to provide the
294 ease of development of a scripting language with the performance of a compiled
295 language. The language derives concepts from C++, Java and Python, incorporating
296 object-oriented programming, operator overloading and strong typing.</p>
297 </div>
298 -->  
299   
300 <!--=========================================================================-->
301 <h3>Glasgow Haskell Compiler (GHC)</h3>
302   
303 <div>
304
305 <p>GHC is an open source, state-of-the-art programming suite for Haskell, a
306    standard lazy functional programming language. It includes an optimizing
307    static compiler generating good code for a variety of platforms, together
308    with an interactive system for convenient, quick development.</p>
309
310 <p>GHC 7.0 and onwards include an LLVM code generator, supporting LLVM 2.8 and
311    later. Since LLVM 2.9, GHC now includes experimental support for the ARM
312    platform with LLVM 3.0.</p>
313
314 </div>
315
316 <!--=========================================================================-->
317 <h3>gwXscript</h3>
318
319 <div>
320
321 <p><a href="http://botwars.tk/gwscript/">gwXscript</a> is an object oriented,
322    aspect orientied programing language which can create both, executables (ELF,
323    EXE) and shared libraries (DLL, SO, DYNLIB). The compiler is implemented in
324    its own language and translates scripts into LLVM-IR which can be optimized
325    and translated into native code by the LLVM framework. Source code in
326    gwScript contains definitions that expand the namespaces. So you can build
327    your project and simply 'plug out' features by removing a file. The remaining
328    project does not leave scars since you directly separate concerns by the
329    'template' feature of gwX. It is also possible to add new features to a
330    project by just adding files and without editing the original project. This
331    language is used for example to create games or content management systems
332    that should be extendable.</p>
333
334 <p>gwXscript is strongly typed and offers comfort with its native types string,
335    hash and array. You can easily write new libraries in gwXscript or native
336    code. gwXscript is type safe and users should not be able to crash your
337    program or execute malicious code except code that is eating CPU time.</p>
338
339 </div>
340
341 <!--=========================================================================-->
342 <h3>Portable OpenCL (pocl)</h3>
343
344 <div>
345
346 <p>Portable OpenCL is an open source implementation of the OpenCL standard which
347    can be easily adapted for new targets. One of the goals of the project is
348    improving performance portability of OpenCL programs, avoiding the need for
349    target-dependent manual optimizations. A "native" target is included, which
350    allows running OpenCL kernels on the host (CPU).</p>
351
352 </div>
353
354 <!--=========================================================================-->
355 <h3>Pure</h3>
356   
357 <div>
358 <p><a href="http://pure-lang.googlecode.com/">Pure</a> is an
359   algebraic/functional programming language based on term rewriting. Programs
360   are collections of equations which are used to evaluate expressions in a
361   symbolic fashion. The interpreter uses LLVM as a backend to JIT-compile Pure
362   programs to fast native code. Pure offers dynamic typing, eager and lazy
363   evaluation, lexical closures, a hygienic macro system (also based on term
364   rewriting), built-in list and matrix support (including list and matrix
365   comprehensions) and an easy-to-use interface to C and other programming
366   languages (including the ability to load LLVM bitcode modules, and inline C,
367   C++, Fortran and Faust code in Pure programs if the corresponding LLVM-enabled
368   compilers are installed).</p>
369   
370 <p>Pure version 0.48 has been tested and is known to work with LLVM 3.0
371   (and continues to work with older LLVM releases &gt;= 2.5).</p>
372
373 </div>
374
375 <!--=========================================================================-->
376 <h3>SAFECode</h3>
377
378 <div>
379
380 <p><a href="http://safecode.cs.illinois.edu">SAFECode</a> is a memory safe C/C++
381    compiler built using LLVM.  It takes standard, unannotated C/C++ code,
382    analyzes the code to ensure that memory accesses and array indexing
383    operations are safe, and instruments the code with run-time checks when
384    safety cannot be proven statically.  SAFECode can be used as a debugging aid
385    (like Valgrind) to find and repair memory safety bugs.  It can also be used
386    to protect code from security attacks at run-time.</p>
387
388 </div>
389
390 <!--=========================================================================-->
391 <h3>TTA-based Co-design Environment (TCE)</h3>
392
393 <div>
394
395 <p>TCE is a toolset for designing application-specific processors (ASP) based on
396    the Transport triggered architecture (TTA). The toolset provides a complete
397    co-design flow from C/C++ programs down to synthesizable VHDL and parallel
398    program binaries. Processor customization points include the register files,
399    function units, supported operations, and the interconnection network.</p>
400
401 <p>TCE uses Clang and LLVM for C/C++ language support, target independent
402    optimizations and also for parts of code generation. It generates new
403    LLVM-based code generators <i>on the fly</i> for the designed TTA processors
404    and loads them in to the compiler backend as runtime libraries to avoid
405    per-target recompilation of larger parts of the compiler chain.</p>
406 </div>
407
408   
409 <!--=========================================================================-->
410 <h3>Tart Programming Language</h3>
411
412 <div>
413
414 <p><a href="http://code.google.com/p/tart/">Tart</a> is a general-purpose,
415    strongly typed programming language designed for application
416    developers. Strongly inspired by Python and C#, Tart focuses on practical
417    solutions for the professional software developer, while avoiding the clutter
418    and boilerplate of legacy languages like Java and C++. Although Tart is still
419    in development, the current implementation supports many features expected of
420    a modern programming language, such as garbage collection, powerful
421    bidirectional type inference, a greatly simplified syntax for template
422    metaprogramming, closures and function literals, reflection, operator
423    overloading, explicit mutability and immutability, and much more. Tart is
424    flexible enough to accommodate a broad range of programming styles and
425    philosophies, while maintaining a strong commitment to simplicity, minimalism
426    and elegance in design.</p>
427
428 </div>
429
430 <!--=========================================================================-->
431 <!--
432 <h3>PinaVM</h3>
433   
434 <div>
435 <p><a href="http://gitorious.org/pinavm/pages/Home">PinaVM</a> is an open
436 source, <a href="http://www.systemc.org/">SystemC</a> front-end. Unlike many
437 other front-ends, PinaVM actually executes the elaboration of the
438 program analyzed using LLVM's JIT infrastructure. It later enriches the
439 bitcode with SystemC-specific information.</p>
440 </div>
441 -->
442
443
444 <!--=========================================================================-->
445 <!--
446 <h3 id="icedtea">IcedTea Java Virtual Machine Implementation</h3>
447
448 <div>
449 <p>
450 <a href="http://icedtea.classpath.org/wiki/Main_Page">IcedTea</a> provides a
451 harness to build OpenJDK using only free software build tools and to provide
452 replacements for the not-yet free parts of OpenJDK.  One of the extensions that
453 IcedTea provides is a new JIT compiler named <a
454 href="http://icedtea.classpath.org/wiki/ZeroSharkFaq">Shark</a> which uses LLVM
455 to provide native code generation without introducing processor-dependent
456 code.
457 </p>
458
459 <p> OpenJDK 7 b112, IcedTea6 1.9 and IcedTea7 1.13 and later have been tested
460 and are known to work with LLVM 3.0 (and continue to work with older LLVM
461 releases &gt;= 2.6 as well).</p>
462 </div>
463 -->
464
465 <!--=========================================================================-->
466 <!--
467 <h3>Polly - Polyhedral optimizations for LLVM</h3>
468   
469 <div>
470 <p>Polly is a project that aims to provide advanced memory access optimizations
471 to better take advantage of SIMD units, cache hierarchies, multiple cores or
472 even vector accelerators for LLVM. Built around an abstract mathematical
473 description based on Z-polyhedra, it provides the infrastructure to develop
474 advanced optimizations in LLVM and to connect complex external optimizers. In
475 its first year of existence Polly already provides an exact value-based
476 dependency analysis as well as basic SIMD and OpenMP code generation support.
477 Furthermore, Polly can use PoCC(Pluto) an advanced optimizer for data-locality
478 and parallelism.</p>
479 </div>
480 -->
481
482 <!--=========================================================================-->
483 <!--
484 <h3>Rubinius</h3>
485
486 <div>
487   <p><a href="http://github.com/evanphx/rubinius">Rubinius</a> is an environment
488   for running Ruby code which strives to write as much of the implementation in
489   Ruby as possible. Combined with a bytecode interpreting VM, it uses LLVM to
490   optimize and compile ruby code down to machine code. Techniques such as type
491   feedback, method inlining, and deoptimization are all used to remove dynamism
492   from ruby execution and increase performance.</p>
493 </div>
494 -->
495
496 <!--=========================================================================-->
497 <!--
498 <h3>
499 <a name="FAUST">FAUST Real-Time Audio Signal Processing Language</a>
500 </h3>
501
502 <div>
503 <p>
504 <a href="http://faust.grame.fr">FAUST</a> is a compiled language for real-time
505 audio signal processing. The name FAUST stands for Functional AUdio STream. Its
506 programming model combines two approaches: functional programming and block
507 diagram composition. In addition with the C, C++, JAVA output formats, the
508 Faust compiler can now generate LLVM bitcode, and works with LLVM 2.7-3.0.</p>
509
510 </div>
511 -->
512   
513 </div>
514
515 <!-- *********************************************************************** -->
516 <h2>
517   <a name="whatsnew">What's New in LLVM 3.0?</a>
518 </h2>
519 <!-- *********************************************************************** -->
520
521 <div>
522
523 <p>This release includes a huge number of bug fixes, performance tweaks and
524 minor improvements.  Some of the major improvements and new features are listed
525 in this section.
526 </p>
527
528 <!--=========================================================================-->
529 <h3>
530 <a name="majorfeatures">Major New Features</a>
531 </h3>
532
533 <div>
534
535 <p>LLVM 3.0 includes several major new capabilities:</p>
536
537 <ul>
538
539 <!--
540 <li></li>
541 -->
542   
543 </ul>
544   
545 </div>
546
547 <!--=========================================================================-->
548 <h3>
549 <a name="coreimprovements">LLVM IR and Core Improvements</a>
550 </h3>
551
552 <div>
553 <p>LLVM IR has several new features for better support of new targets and that
554 expose new optimization opportunities:</p>
555
556 <ul>
557 <!--
558 <li></li>
559 -->
560 </ul>
561
562 </div>
563
564 <!--=========================================================================-->
565 <h3>
566 <a name="optimizer">Optimizer Improvements</a>
567 </h3>
568
569 <div>
570
571 <p>In addition to a large array of minor performance tweaks and bug fixes, this
572 release includes a few major enhancements and additions to the optimizers:</p>
573
574 <ul>
575 <!--
576 <li></li>
577 -->
578 </li>
579   
580 </ul>
581
582 </div>
583
584 <!--=========================================================================-->
585 <h3>
586 <a name="mc">MC Level Improvements</a>
587 </h3>
588
589 <div>
590 <p>
591 The LLVM Machine Code (aka MC) subsystem was created to solve a number
592 of problems in the realm of assembly, disassembly, object file format handling,
593 and a number of other related areas that CPU instruction-set level tools work
594 in.</p>
595
596 <ul>
597 <!--
598 <li></li>
599 -->
600 </ul>
601
602 <p>For more information, please see the <a
603 href="http://blog.llvm.org/2010/04/intro-to-llvm-mc-project.html">Intro to the
604 LLVM MC Project Blog Post</a>.
605 </p>
606
607 </div>
608
609 <!--=========================================================================-->
610 <h3>
611 <a name="codegen">Target Independent Code Generator Improvements</a>
612 </h3>
613
614 <div>
615
616 <p>We have put a significant amount of work into the code generator
617 infrastructure, which allows us to implement more aggressive algorithms and make
618 it run faster:</p>
619
620 <ul>
621 <!--
622 <li></li>
623 -->
624 </ul>
625 </div>
626
627 <!--=========================================================================-->
628 <h3>
629 <a name="x86">X86-32 and X86-64 Target Improvements</a>
630 </h3>
631
632 <div>
633 <p>New features and major changes in the X86 target include:
634 </p>
635
636 <ul>
637 <li>The CRC32 intrinsics have been renamed.  The intrinsics were previously
638   @llvm.x86.sse42.crc32.[8|16|32] and @llvm.x86.sse42.crc64.[8|64].  They have
639   been renamed to @llvm.x86.sse42.crc32.32.[8|16|32] and 
640   @llvm.x86.sse42.crc32.64.[8|64].</li>
641
642 </ul>
643
644 </div>
645
646 <!--=========================================================================-->
647 <h3>
648 <a name="ARM">ARM Target Improvements</a>
649 </h3>
650
651 <div>
652 <p>New features of the ARM target include:
653 </p>
654
655 <ul>
656 <!--
657 <li></li>
658 -->
659 </ul>
660 </div>
661   
662 <!--=========================================================================-->
663 <h3>
664 <a name="OtherTS">Other Target Specific Improvements</a>
665 </h3>
666
667 <div>
668 <ul>
669 <!--
670 <li></li>
671 -->
672 </ul>
673 </div>
674
675 <!--=========================================================================-->
676 <h3>
677 <a name="changes">Major Changes and Removed Features</a>
678 </h3>
679
680 <div>
681
682 <p>If you're already an LLVM user or developer with out-of-tree changes based on
683    LLVM 2.9, this section lists some "gotchas" that you may run into upgrading
684    from the previous release.</p>
685
686 <ul>
687   <li>The <code>LLVMC</code> front end code was removed while separating
688       out language independence.</li>
689   <li>The <code>LowerSetJmp</code> pass wasn't used effectively by any
690       target and has been removed.</li>
691   <li>The old <code>TailDup</code> pass was not used in the standard pipeline
692       and was unable to update ssa form, so it has been removed.
693   <li>The syntax of volatile loads and stores in IR has been changed to
694       "<code>load volatile</code>"/"<code>store volatile</code>".  The old
695       syntax ("<code>volatile load</code>"/"<code>volatile store</code>")
696       is still accepted, but is now considered deprecated.</li>
697 </ul>
698
699 <h4>Windows (32-bit)</h4>
700 <div>
701 <ul>
702   <li>On Win32(MinGW32 and MSVC), Windows 2000 will not be supported.
703       Windows XP or higher is required.</li>
704 </ul>
705 </div>
706
707 </div>
708
709 <!--=========================================================================-->
710 <h3>
711 <a name="api_changes">Internal API Changes</a>
712 </h3>
713
714 <div>
715
716 <p>In addition, many APIs have changed in this release.  Some of the major
717    LLVM API changes are:</p>
718
719 <ul>
720 <li>The biggest and most pervasive change is that llvm::Type's are no longer
721     returned or accepted as 'const' values.  Instead, just pass around non-const
722     Type's.</li>
723   
724 <li><code>PHINode::reserveOperandSpace</code> has been removed. Instead, you
725   must specify how many operands to reserve space for when you create the
726   PHINode, by passing an extra argument into <code>PHINode::Create</code>.</li>
727
728 <li>PHINodes no longer store their incoming BasicBlocks as operands. Instead,
729   the list of incoming BasicBlocks is stored separately, and can be accessed
730   with new functions <code>PHINode::block_begin</code>
731   and <code>PHINode::block_end</code>.</li>
732
733 <li>Various functions now take an <code>ArrayRef</code> instead of either a pair
734   of pointers (or iterators) to the beginning and end of a range, or a pointer
735   and a length. Others now return an <code>ArrayRef</code> instead of a
736   reference to a <code>SmallVector</code> or <code>std::vector</code>. These
737   include:
738 <ul>
739 <!-- Please keep this list sorted. -->
740 <li><code>CallInst::Create</code></li>
741 <li><code>ComputeLinearIndex</code> (in <code>llvm/CodeGen/Analysis.h</code>)</li>
742 <li><code>ConstantArray::get</code></li>
743 <li><code>ConstantExpr::getExtractElement</code></li>
744 <li><code>ConstantExpr::getGetElementPtr</code></li>
745 <li><code>ConstantExpr::getInBoundsGetElementPtr</code></li>
746 <li><code>ConstantExpr::getIndices</code></li>
747 <li><code>ConstantExpr::getInsertElement</code></li>
748 <li><code>ConstantExpr::getWithOperands</code></li>
749 <li><code>ConstantFoldCall</code> (in <code>llvm/Analysis/ConstantFolding.h</code>)</li>
750 <li><code>ConstantFoldInstOperands</code> (in <code>llvm/Analysis/ConstantFolding.h</code>)</li>
751 <li><code>ConstantVector::get</code></li>
752 <li><code>DIBuilder::createComplexVariable</code></li>
753 <li><code>DIBuilder::getOrCreateArray</code></li>
754 <li><code>ExtractValueInst::Create</code></li>
755 <li><code>ExtractValueInst::getIndexedType</code></li>
756 <li><code>ExtractValueInst::getIndices</code></li>
757 <li><code>FindInsertedValue</code> (in <code>llvm/Analysis/ValueTracking.h</code>)</li>
758 <li><code>gep_type_begin</code> (in <code>llvm/Support/GetElementPtrTypeIterator.h</code>)</li>
759 <li><code>gep_type_end</code> (in <code>llvm/Support/GetElementPtrTypeIterator.h</code>)</li>
760 <li><code>GetElementPtrInst::Create</code></li>
761 <li><code>GetElementPtrInst::CreateInBounds</code></li>
762 <li><code>GetElementPtrInst::getIndexedType</code></li>
763 <li><code>InsertValueInst::Create</code></li>
764 <li><code>InsertValueInst::getIndices</code></li>
765 <li><code>InvokeInst::Create</code></li>
766 <li><code>IRBuilder::CreateCall</code></li>
767 <li><code>IRBuilder::CreateExtractValue</code></li>
768 <li><code>IRBuilder::CreateGEP</code></li>
769 <li><code>IRBuilder::CreateInBoundsGEP</code></li>
770 <li><code>IRBuilder::CreateInsertValue</code></li>
771 <li><code>IRBuilder::CreateInvoke</code></li>
772 <li><code>MDNode::get</code></li>
773 <li><code>MDNode::getIfExists</code></li>
774 <li><code>MDNode::getTemporary</code></li>
775 <li><code>MDNode::getWhenValsUnresolved</code></li>
776 <li><code>SimplifyGEPInst</code> (in <code>llvm/Analysis/InstructionSimplify.h</code>)</li>
777 <li><code>TargetData::getIndexedOffset</code></li>
778 </ul></li>
779
780 <li>All forms of <code>StringMap::getOrCreateValue</code> have been remove
781   except for the one which takes a <code>StringRef</code>.</li>
782
783 <li>The <code>LLVMBuildUnwind</code> function from the C API was removed. The
784     LLVM <code>unwind</code> instruction has been deprecated for a long time and
785     isn't used by the current front-ends. So this was removed during the
786     exception handling rewrite.</li>
787
788 <li>The <code>LLVMAddLowerSetJmpPass</code> function from the C API was removed
789     because the <code>LowerSetJmp</code> pass was removed.</li>
790
791 <li>The <code>DIBuilder</code> interface used by front ends to encode debugging 
792     information in the LLVM IR now expects clients to use <code>DIBuilder::finalize()</code>
793     at the end of translation unit to complete debugging information encoding.</li>
794
795 <li>The way the type system works has been rewritten: <code>PATypeHolder</code>
796 and <code>OpaqueType</code> are gone, and all APIs deal with <code>Type*</code>
797 instead of <code>const Type*</code>.
798 If you need to create recursive structures, then create a named structure,
799 and use <code>setBody()</code> when all its elements are built.
800 Type merging and refining is gone too: named structures are not
801 merged with other structures, even if their layout is identical.
802 (of course anonymous structures are still uniqued by layout).
803 </li>
804
805 <li>TargetSelect.h moved to Support/ from Target/</li>
806
807 <li>UpgradeIntrinsicCall no longer upgrades pre-2.9 intrinsic calls
808 (for example <code>llvm.memset.i32</code>).</li>
809
810 <li>It is mandatory to initialize all out-of-tree passes too and their dependencies now with
811 <code>INITIALIZE_PASS{BEGIN,END,}</code> and <code>INITIALIZE_{PASS,AG}_DEPENDENCY</code>.</li>
812
813 <li>The interface for MemDepResult in MemoryDependenceAnalysis has been enhanced
814     with new return types Unknown and NonFuncLocal, in addition to the existing
815     types Clobber, Def, and NonLocal.</li>
816
817 </ul>
818 </div>
819
820 </div>
821
822 <!-- *********************************************************************** -->
823 <h2>
824   <a name="knownproblems">Known Problems</a>
825 </h2>
826 <!-- *********************************************************************** -->
827
828 <div>
829
830 <p>This section contains significant known problems with the LLVM system,
831 listed by component.  If you run into a problem, please check the <a
832 href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
833 there isn't already one.</p>
834
835 <!-- ======================================================================= -->
836 <h3>
837   <a name="experimental">Experimental features included with this release</a>
838 </h3>
839
840 <div>
841
842 <p>The following components of this LLVM release are either untested, known to
843 be broken or unreliable, or are in early development.  These components should
844 not be relied on, and bugs should not be filed against them, but they may be
845 useful to some people.  In particular, if you would like to work on one of these
846 components, please contact us on the <a
847 href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p>
848
849 <ul>
850 <li>The Alpha, CellSPU, MicroBlaze, MSP430, MIPS, PTX,
851     and XCore backends are experimental.</li>
852 <li><tt>llc</tt> "<tt>-filetype=obj</tt>" is experimental on all targets
853     other than darwin and ELF X86 systems.</li>
854     
855 </ul>
856
857 </div>
858
859 <!-- ======================================================================= -->
860 <h3>
861   <a name="x86-be">Known problems with the X86 back-end</a>
862 </h3>
863
864 <div>
865
866 <ul>
867   <li>The X86 backend does not yet support
868     all <a href="http://llvm.org/PR879">inline assembly that uses the X86
869     floating point stack</a>.  It supports the 'f' and 't' constraints, but not
870     'u'.</li>
871   <li>The X86-64 backend does not yet support the LLVM IR instruction
872       <tt>va_arg</tt>. Currently, front-ends support variadic
873       argument constructs on X86-64 by lowering them manually.</li>
874   <li>Windows x64 (aka Win64) code generator has a few issues.
875     <ul>
876       <li>llvm-gcc cannot build the mingw-w64 runtime currently
877        due to lack of support for the 'u' inline assembly
878        constraint and for X87 floating point inline assembly.</li>
879       <li>On mingw-w64, you will see unresolved symbol <tt>__chkstk</tt>
880        due to <a href="http://llvm.org/bugs/show_bug.cgi?id=8919">Bug 8919</a>.
881        It is fixed in <a href="http://lists.cs.uiuc.edu/pipermail/llvm-commits/Week-of-Mon-20110321/118499.html">r128206</a>.</li>
882       <li>Miss-aligned MOVDQA might crash your program. It is due to
883        <a href="http://llvm.org/bugs/show_bug.cgi?id=9483">Bug 9483</a>,
884        lack of handling aligned internal globals.</li>
885       </ul>
886   </li>
887
888 </ul>
889
890 </div>
891
892 <!-- ======================================================================= -->
893 <h3>
894   <a name="ppc-be">Known problems with the PowerPC back-end</a>
895 </h3>
896
897 <div>
898
899 <ul>
900 <li>The Linux PPC32/ABI support needs testing for the interpreter and static
901 compilation, and lacks support for debug information.</li>
902 </ul>
903
904 </div>
905
906 <!-- ======================================================================= -->
907 <h3>
908   <a name="arm-be">Known problems with the ARM back-end</a>
909 </h3>
910
911 <div>
912
913 <ul>
914 <li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
915 processors, thumb programs can crash or produce wrong
916 results (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
917 <li>Compilation for ARM Linux OABI (old ABI) is supported but not fully tested.
918 </li>
919 </ul>
920
921 </div>
922
923 <!-- ======================================================================= -->
924 <h3>
925   <a name="sparc-be">Known problems with the SPARC back-end</a>
926 </h3>
927
928 <div>
929
930 <ul>
931 <li>The SPARC backend only supports the 32-bit SPARC ABI (-m32); it does not
932     support the 64-bit SPARC ABI (-m64).</li>
933 </ul>
934
935 </div>
936
937 <!-- ======================================================================= -->
938 <h3>
939   <a name="mips-be">Known problems with the MIPS back-end</a>
940 </h3>
941
942 <div>
943
944 <ul>
945 <li>64-bit MIPS targets are not supported yet.</li>
946 </ul>
947
948 </div>
949
950 <!-- ======================================================================= -->
951 <h3>
952   <a name="alpha-be">Known problems with the Alpha back-end</a>
953 </h3>
954
955 <div>
956
957 <ul>
958
959 <li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
960 appropriate nops inserted to ensure restartability.</li>
961
962 </ul>
963 </div>
964
965 <!-- ======================================================================= -->
966 <h3>
967   <a name="c-be">Known problems with the C back-end</a>
968 </h3>
969
970 <div>
971
972 <p>The C backend has numerous problems and is not being actively maintained.
973 Depending on it for anything serious is not advised.</p>
974
975 <ul>
976 <li><a href="http://llvm.org/PR802">The C backend has only basic support for
977     inline assembly code</a>.</li>
978 <li><a href="http://llvm.org/PR1658">The C backend violates the ABI of common
979     C++ programs</a>, preventing intermixing between C++ compiled by the CBE and
980     C++ code compiled with <tt>llc</tt> or native compilers.</li>
981 <li>The C backend does not support all exception handling constructs.</li>
982 <li>The C backend does not support arbitrary precision integers.</li>
983 </ul>
984
985 </div>
986
987
988 <!-- ======================================================================= -->
989 <h3>
990   <a name="llvm-gcc">Known problems with the llvm-gcc front-end</a>
991 </h3>
992
993 <div>
994
995 <p><b>LLVM 3.0 will be the last release of llvm-gcc.</b></p>
996
997 <p>llvm-gcc is generally very stable for the C family of languages.  The only
998    major language feature of GCC not supported by llvm-gcc is the
999    <tt>__builtin_apply</tt> family of builtins.   However, some extensions
1000    are only supported on some targets.  For example, trampolines are only
1001    supported on some targets (these are used when you take the address of a
1002    nested function).</p>
1003
1004 <p>Fortran support generally works, but there are still several unresolved bugs
1005    in <a href="http://llvm.org/bugs/">Bugzilla</a>.  Please see the
1006    tools/gfortran component for details.  Note that llvm-gcc is missing major
1007    Fortran performance work in the frontend and library that went into GCC after
1008    4.2.  If you are interested in Fortran, we recommend that you consider using
1009    <a href="#dragonegg">dragonegg</a> instead.</p>
1010
1011 <p>The llvm-gcc 4.2 Ada compiler has basic functionality, but is no longer being
1012 actively maintained.  If you are interested in Ada, we recommend that you
1013 consider using <a href="#dragonegg">dragonegg</a> instead.</p>
1014 </div>
1015
1016 </div>
1017
1018 <!-- *********************************************************************** -->
1019 <h2>
1020   <a name="additionalinfo">Additional Information</a>
1021 </h2>
1022 <!-- *********************************************************************** -->
1023
1024 <div>
1025
1026 <p>A wide variety of additional information is available on the <a
1027 href="http://llvm.org/">LLVM web page</a>, in particular in the <a
1028 href="http://llvm.org/docs/">documentation</a> section.  The web page also
1029 contains versions of the API documentation which is up-to-date with the
1030 Subversion version of the source code.
1031 You can access versions of these documents specific to this release by going
1032 into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
1033
1034 <p>If you have any questions or comments about LLVM, please feel free to contact
1035 us via the <a href="http://llvm.org/docs/#maillist"> mailing
1036 lists</a>.</p>
1037
1038 </div>
1039
1040 <!-- *********************************************************************** -->
1041
1042 <hr>
1043 <address>
1044   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
1045   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
1046   <a href="http://validator.w3.org/check/referer"><img
1047   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
1048
1049   <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
1050   Last modified: $Date$
1051 </address>
1052
1053 </body>
1054 </html>