8cb60bb30ca193ef1d3beec8d2d03b11c297a2b3
[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>gwXscript</h3>
302
303 <div>
304
305 <p><a href="http://botwars.tk/gwscript/">gwXscript</a> is an object oriented,
306    aspect orientied programing language which can create both, executables (ELF,
307    EXE) and shared libraries (DLL, SO, DYNLIB). The compiler is implemented in
308    its own language and translates scripts into LLVM-IR which can be optimized
309    and translated into native code by the LLVM framework. Source code in
310    gwScript contains definitions that expand the namespaces. So you can build
311    your project and simply 'plug out' features by removing a file. The remaining
312    project does not leave scars since you directly separate concerns by the
313    'template' feature of gwX. It is also possible to add new features to a
314    project by just adding files and without editing the original project. This
315    language is used for example to create games or content management systems
316    that should be extendable.</p>
317
318 <p>gwXscript is strongly typed and offers comfort with its native types string,
319    hash and array. You can easily write new libraries in gwXscript or native
320    code. gwXscript is type safe and users should not be able to crash your
321    program or execute malicious code except code that is eating CPU time.</p>
322
323 </div>
324
325 <!--=========================================================================-->
326 <h3>Portable OpenCL (pocl)</h3>
327
328 <div>
329
330 <p>Portable OpenCL is an open source implementation of the OpenCL standard which
331    can be easily adapted for new targets. One of the goals of the project is
332    improving performance portability of OpenCL programs, avoiding the need for
333    target-dependent manual optimizations. A "native" target is included, which
334    allows running OpenCL kernels on the host (CPU).</p>
335
336 </div>
337
338 <!--=========================================================================-->
339 <h3>Pure</h3>
340   
341 <div>
342 <p><a href="http://pure-lang.googlecode.com/">Pure</a> is an
343   algebraic/functional programming language based on term rewriting. Programs
344   are collections of equations which are used to evaluate expressions in a
345   symbolic fashion. The interpreter uses LLVM as a backend to JIT-compile Pure
346   programs to fast native code. Pure offers dynamic typing, eager and lazy
347   evaluation, lexical closures, a hygienic macro system (also based on term
348   rewriting), built-in list and matrix support (including list and matrix
349   comprehensions) and an easy-to-use interface to C and other programming
350   languages (including the ability to load LLVM bitcode modules, and inline C,
351   C++, Fortran and Faust code in Pure programs if the corresponding LLVM-enabled
352   compilers are installed).</p>
353   
354 <p>Pure version 0.48 has been tested and is known to work with LLVM 3.0
355   (and continues to work with older LLVM releases &gt;= 2.5).</p>
356
357 </div>
358
359 <!--=========================================================================-->
360 <h3>TTA-based Co-design Environment (TCE)</h3>
361
362 <div>
363
364 <p>TCE is a toolset for designing application-specific processors (ASP) based on
365    the Transport triggered architecture (TTA). The toolset provides a complete
366    co-design flow from C/C++ programs down to synthesizable VHDL and parallel
367    program binaries. Processor customization points include the register files,
368    function units, supported operations, and the interconnection network.</p>
369
370 <p>TCE uses Clang and LLVM for C/C++ language support, target independent
371    optimizations and also for parts of code generation. It generates new
372    LLVM-based code generators <i>on the fly</i> for the designed TTA processors
373    and loads them in to the compiler backend as runtime libraries to avoid
374    per-target recompilation of larger parts of the compiler chain.</p>
375 </div>
376
377   
378 <!--=========================================================================-->
379 <h3>Tart Programming Language</h3>
380
381 <div>
382
383 <p><a href="http://code.google.com/p/tart/">Tart</a> is a general-purpose,
384    strongly typed programming language designed for application
385    developers. Strongly inspired by Python and C#, Tart focuses on practical
386    solutions for the professional software developer, while avoiding the clutter
387    and boilerplate of legacy languages like Java and C++. Although Tart is still
388    in development, the current implementation supports many features expected of
389    a modern programming language, such as garbage collection, powerful
390    bidirectional type inference, a greatly simplified syntax for template
391    metaprogramming, closures and function literals, reflection, operator
392    overloading, explicit mutability and immutability, and much more. Tart is
393    flexible enough to accommodate a broad range of programming styles and
394    philosophies, while maintaining a strong commitment to simplicity, minimalism
395    and elegance in design.</p>
396
397 </div>
398
399 <!--=========================================================================-->
400 <!--
401 <h3>PinaVM</h3>
402   
403 <div>
404 <p><a href="http://gitorious.org/pinavm/pages/Home">PinaVM</a> is an open
405 source, <a href="http://www.systemc.org/">SystemC</a> front-end. Unlike many
406 other front-ends, PinaVM actually executes the elaboration of the
407 program analyzed using LLVM's JIT infrastructure. It later enriches the
408 bitcode with SystemC-specific information.</p>
409 </div>
410 -->
411
412
413 <!--=========================================================================-->
414 <!--
415 <h3 id="icedtea">IcedTea Java Virtual Machine Implementation</h3>
416
417 <div>
418 <p>
419 <a href="http://icedtea.classpath.org/wiki/Main_Page">IcedTea</a> provides a
420 harness to build OpenJDK using only free software build tools and to provide
421 replacements for the not-yet free parts of OpenJDK.  One of the extensions that
422 IcedTea provides is a new JIT compiler named <a
423 href="http://icedtea.classpath.org/wiki/ZeroSharkFaq">Shark</a> which uses LLVM
424 to provide native code generation without introducing processor-dependent
425 code.
426 </p>
427
428 <p> OpenJDK 7 b112, IcedTea6 1.9 and IcedTea7 1.13 and later have been tested
429 and are known to work with LLVM 3.0 (and continue to work with older LLVM
430 releases &gt;= 2.6 as well).</p>
431 </div>
432 -->
433
434 <!--=========================================================================-->
435 <!--
436 <h3>Glasgow Haskell Compiler (GHC)</h3>
437   
438 <div>
439 <p>GHC is an open source, state-of-the-art programming suite for Haskell,
440 a standard lazy functional programming language. It includes an
441 optimizing static compiler generating good code for a variety of
442 platforms, together with an interactive system for convenient, quick
443 development.</p>
444
445 <p>In addition to the existing C and native code generators, GHC 7.0 now
446 supports an LLVM code generator. GHC supports LLVM 2.7 and later.</p>
447 </div>
448 -->
449
450 <!--=========================================================================-->
451 <!--
452 <h3>Polly - Polyhedral optimizations for LLVM</h3>
453   
454 <div>
455 <p>Polly is a project that aims to provide advanced memory access optimizations
456 to better take advantage of SIMD units, cache hierarchies, multiple cores or
457 even vector accelerators for LLVM. Built around an abstract mathematical
458 description based on Z-polyhedra, it provides the infrastructure to develop
459 advanced optimizations in LLVM and to connect complex external optimizers. In
460 its first year of existence Polly already provides an exact value-based
461 dependency analysis as well as basic SIMD and OpenMP code generation support.
462 Furthermore, Polly can use PoCC(Pluto) an advanced optimizer for data-locality
463 and parallelism.</p>
464 </div>
465 -->
466
467 <!--=========================================================================-->
468 <!--
469 <h3>Rubinius</h3>
470
471 <div>
472   <p><a href="http://github.com/evanphx/rubinius">Rubinius</a> is an environment
473   for running Ruby code which strives to write as much of the implementation in
474   Ruby as possible. Combined with a bytecode interpreting VM, it uses LLVM to
475   optimize and compile ruby code down to machine code. Techniques such as type
476   feedback, method inlining, and deoptimization are all used to remove dynamism
477   from ruby execution and increase performance.</p>
478 </div>
479 -->
480
481 <!--=========================================================================-->
482 <!--
483 <h3>
484 <a name="FAUST">FAUST Real-Time Audio Signal Processing Language</a>
485 </h3>
486
487 <div>
488 <p>
489 <a href="http://faust.grame.fr">FAUST</a> is a compiled language for real-time
490 audio signal processing. The name FAUST stands for Functional AUdio STream. Its
491 programming model combines two approaches: functional programming and block
492 diagram composition. In addition with the C, C++, JAVA output formats, the
493 Faust compiler can now generate LLVM bitcode, and works with LLVM 2.7-3.0.</p>
494
495 </div>
496 -->
497   
498 </div>
499
500 <!-- *********************************************************************** -->
501 <h2>
502   <a name="whatsnew">What's New in LLVM 3.0?</a>
503 </h2>
504 <!-- *********************************************************************** -->
505
506 <div>
507
508 <p>This release includes a huge number of bug fixes, performance tweaks and
509 minor improvements.  Some of the major improvements and new features are listed
510 in this section.
511 </p>
512
513 <!--=========================================================================-->
514 <h3>
515 <a name="majorfeatures">Major New Features</a>
516 </h3>
517
518 <div>
519
520 <p>LLVM 3.0 includes several major new capabilities:</p>
521
522 <ul>
523
524 <!--
525 <li></li>
526 -->
527   
528 </ul>
529   
530 </div>
531
532 <!--=========================================================================-->
533 <h3>
534 <a name="coreimprovements">LLVM IR and Core Improvements</a>
535 </h3>
536
537 <div>
538 <p>LLVM IR has several new features for better support of new targets and that
539 expose new optimization opportunities:</p>
540
541 <ul>
542 <!--
543 <li></li>
544 -->
545 </ul>
546
547 </div>
548
549 <!--=========================================================================-->
550 <h3>
551 <a name="optimizer">Optimizer Improvements</a>
552 </h3>
553
554 <div>
555
556 <p>In addition to a large array of minor performance tweaks and bug fixes, this
557 release includes a few major enhancements and additions to the optimizers:</p>
558
559 <ul>
560 <!--
561 <li></li>
562 -->
563 </li>
564   
565 </ul>
566
567 </div>
568
569 <!--=========================================================================-->
570 <h3>
571 <a name="mc">MC Level Improvements</a>
572 </h3>
573
574 <div>
575 <p>
576 The LLVM Machine Code (aka MC) subsystem was created to solve a number
577 of problems in the realm of assembly, disassembly, object file format handling,
578 and a number of other related areas that CPU instruction-set level tools work
579 in.</p>
580
581 <ul>
582 <!--
583 <li></li>
584 -->
585 </ul>
586
587 <p>For more information, please see the <a
588 href="http://blog.llvm.org/2010/04/intro-to-llvm-mc-project.html">Intro to the
589 LLVM MC Project Blog Post</a>.
590 </p>
591
592 </div>
593
594 <!--=========================================================================-->
595 <h3>
596 <a name="codegen">Target Independent Code Generator Improvements</a>
597 </h3>
598
599 <div>
600
601 <p>We have put a significant amount of work into the code generator
602 infrastructure, which allows us to implement more aggressive algorithms and make
603 it run faster:</p>
604
605 <ul>
606 <!--
607 <li></li>
608 -->
609 </ul>
610 </div>
611
612 <!--=========================================================================-->
613 <h3>
614 <a name="x86">X86-32 and X86-64 Target Improvements</a>
615 </h3>
616
617 <div>
618 <p>New features and major changes in the X86 target include:
619 </p>
620
621 <ul>
622 <li>The CRC32 intrinsics have been renamed.  The intrinsics were previously
623   @llvm.x86.sse42.crc32.[8|16|32] and @llvm.x86.sse42.crc64.[8|64].  They have
624   been renamed to @llvm.x86.sse42.crc32.32.[8|16|32] and 
625   @llvm.x86.sse42.crc32.64.[8|64].</li>
626
627 </ul>
628
629 </div>
630
631 <!--=========================================================================-->
632 <h3>
633 <a name="ARM">ARM Target Improvements</a>
634 </h3>
635
636 <div>
637 <p>New features of the ARM target include:
638 </p>
639
640 <ul>
641 <!--
642 <li></li>
643 -->
644 </ul>
645 </div>
646   
647 <!--=========================================================================-->
648 <h3>
649 <a name="OtherTS">Other Target Specific Improvements</a>
650 </h3>
651
652 <div>
653 <ul>
654 <!--
655 <li></li>
656 -->
657 </ul>
658 </div>
659
660 <!--=========================================================================-->
661 <h3>
662 <a name="changes">Major Changes and Removed Features</a>
663 </h3>
664
665 <div>
666
667 <p>If you're already an LLVM user or developer with out-of-tree changes based on
668    LLVM 2.9, this section lists some "gotchas" that you may run into upgrading
669    from the previous release.</p>
670
671 <ul>
672   <li>The <code>LLVMC</code> front end code was removed while separating
673       out language independence.</li>
674   <li>The <code>LowerSetJmp</code> pass wasn't used effectively by any
675       target and has been removed.</li>
676   <li>The old <code>TailDup</code> pass was not used in the standard pipeline
677       and was unable to update ssa form, so it has been removed.
678   <li>The syntax of volatile loads and stores in IR has been changed to
679       "<code>load volatile</code>"/"<code>store volatile</code>".  The old
680       syntax ("<code>volatile load</code>"/"<code>volatile store</code>")
681       is still accepted, but is now considered deprecated.</li>
682 </ul>
683
684 <h4>Windows (32-bit)</h4>
685 <div>
686 <ul>
687   <li>On Win32(MinGW32 and MSVC), Windows 2000 will not be supported.
688       Windows XP or higher is required.</li>
689 </ul>
690 </div>
691
692 </div>
693
694 <!--=========================================================================-->
695 <h3>
696 <a name="api_changes">Internal API Changes</a>
697 </h3>
698
699 <div>
700
701 <p>In addition, many APIs have changed in this release.  Some of the major
702    LLVM API changes are:</p>
703
704 <ul>
705 <li>The biggest and most pervasive change is that llvm::Type's are no longer
706     returned or accepted as 'const' values.  Instead, just pass around non-const
707     Type's.</li>
708   
709 <li><code>PHINode::reserveOperandSpace</code> has been removed. Instead, you
710   must specify how many operands to reserve space for when you create the
711   PHINode, by passing an extra argument into <code>PHINode::Create</code>.</li>
712
713 <li>PHINodes no longer store their incoming BasicBlocks as operands. Instead,
714   the list of incoming BasicBlocks is stored separately, and can be accessed
715   with new functions <code>PHINode::block_begin</code>
716   and <code>PHINode::block_end</code>.</li>
717
718 <li>Various functions now take an <code>ArrayRef</code> instead of either a pair
719   of pointers (or iterators) to the beginning and end of a range, or a pointer
720   and a length. Others now return an <code>ArrayRef</code> instead of a
721   reference to a <code>SmallVector</code> or <code>std::vector</code>. These
722   include:
723 <ul>
724 <!-- Please keep this list sorted. -->
725 <li><code>CallInst::Create</code></li>
726 <li><code>ComputeLinearIndex</code> (in <code>llvm/CodeGen/Analysis.h</code>)</li>
727 <li><code>ConstantArray::get</code></li>
728 <li><code>ConstantExpr::getExtractElement</code></li>
729 <li><code>ConstantExpr::getGetElementPtr</code></li>
730 <li><code>ConstantExpr::getInBoundsGetElementPtr</code></li>
731 <li><code>ConstantExpr::getIndices</code></li>
732 <li><code>ConstantExpr::getInsertElement</code></li>
733 <li><code>ConstantExpr::getWithOperands</code></li>
734 <li><code>ConstantFoldCall</code> (in <code>llvm/Analysis/ConstantFolding.h</code>)</li>
735 <li><code>ConstantFoldInstOperands</code> (in <code>llvm/Analysis/ConstantFolding.h</code>)</li>
736 <li><code>ConstantVector::get</code></li>
737 <li><code>DIBuilder::createComplexVariable</code></li>
738 <li><code>DIBuilder::getOrCreateArray</code></li>
739 <li><code>ExtractValueInst::Create</code></li>
740 <li><code>ExtractValueInst::getIndexedType</code></li>
741 <li><code>ExtractValueInst::getIndices</code></li>
742 <li><code>FindInsertedValue</code> (in <code>llvm/Analysis/ValueTracking.h</code>)</li>
743 <li><code>gep_type_begin</code> (in <code>llvm/Support/GetElementPtrTypeIterator.h</code>)</li>
744 <li><code>gep_type_end</code> (in <code>llvm/Support/GetElementPtrTypeIterator.h</code>)</li>
745 <li><code>GetElementPtrInst::Create</code></li>
746 <li><code>GetElementPtrInst::CreateInBounds</code></li>
747 <li><code>GetElementPtrInst::getIndexedType</code></li>
748 <li><code>InsertValueInst::Create</code></li>
749 <li><code>InsertValueInst::getIndices</code></li>
750 <li><code>InvokeInst::Create</code></li>
751 <li><code>IRBuilder::CreateCall</code></li>
752 <li><code>IRBuilder::CreateExtractValue</code></li>
753 <li><code>IRBuilder::CreateGEP</code></li>
754 <li><code>IRBuilder::CreateInBoundsGEP</code></li>
755 <li><code>IRBuilder::CreateInsertValue</code></li>
756 <li><code>IRBuilder::CreateInvoke</code></li>
757 <li><code>MDNode::get</code></li>
758 <li><code>MDNode::getIfExists</code></li>
759 <li><code>MDNode::getTemporary</code></li>
760 <li><code>MDNode::getWhenValsUnresolved</code></li>
761 <li><code>SimplifyGEPInst</code> (in <code>llvm/Analysis/InstructionSimplify.h</code>)</li>
762 <li><code>TargetData::getIndexedOffset</code></li>
763 </ul></li>
764
765 <li>All forms of <code>StringMap::getOrCreateValue</code> have been remove
766   except for the one which takes a <code>StringRef</code>.</li>
767
768 <li>The <code>LLVMBuildUnwind</code> function from the C API was removed. The
769     LLVM <code>unwind</code> instruction has been deprecated for a long time and
770     isn't used by the current front-ends. So this was removed during the
771     exception handling rewrite.</li>
772
773 <li>The <code>LLVMAddLowerSetJmpPass</code> function from the C API was removed
774     because the <code>LowerSetJmp</code> pass was removed.</li>
775
776 <li>The <code>DIBuilder</code> interface used by front ends to encode debugging 
777     information in the LLVM IR now expects clients to use <code>DIBuilder::finalize()</code>
778     at the end of translation unit to complete debugging information encoding.</li>
779
780 <li>The way the type system works has been rewritten: <code>PATypeHolder</code>
781 and <code>OpaqueType</code> are gone, and all APIs deal with <code>Type*</code>
782 instead of <code>const Type*</code>.
783 If you need to create recursive structures, then create a named structure,
784 and use <code>setBody()</code> when all its elements are built.
785 Type merging and refining is gone too: named structures are not
786 merged with other structures, even if their layout is identical.
787 (of course anonymous structures are still uniqued by layout).
788 </li>
789
790 <li>TargetSelect.h moved to Support/ from Target/</li>
791
792 <li>UpgradeIntrinsicCall no longer upgrades pre-2.9 intrinsic calls
793 (for example <code>llvm.memset.i32</code>).</li>
794
795 <li>It is mandatory to initialize all out-of-tree passes too and their dependencies now with
796 <code>INITIALIZE_PASS{BEGIN,END,}</code> and <code>INITIALIZE_{PASS,AG}_DEPENDENCY</code>.</li>
797
798 <li>The interface for MemDepResult in MemoryDependenceAnalysis has been enhanced
799     with new return types Unknown and NonFuncLocal, in addition to the existing
800     types Clobber, Def, and NonLocal.</li>
801
802 </ul>
803 </div>
804
805 </div>
806
807 <!-- *********************************************************************** -->
808 <h2>
809   <a name="knownproblems">Known Problems</a>
810 </h2>
811 <!-- *********************************************************************** -->
812
813 <div>
814
815 <p>This section contains significant known problems with the LLVM system,
816 listed by component.  If you run into a problem, please check the <a
817 href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
818 there isn't already one.</p>
819
820 <!-- ======================================================================= -->
821 <h3>
822   <a name="experimental">Experimental features included with this release</a>
823 </h3>
824
825 <div>
826
827 <p>The following components of this LLVM release are either untested, known to
828 be broken or unreliable, or are in early development.  These components should
829 not be relied on, and bugs should not be filed against them, but they may be
830 useful to some people.  In particular, if you would like to work on one of these
831 components, please contact us on the <a
832 href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p>
833
834 <ul>
835 <li>The Alpha, CellSPU, MicroBlaze, MSP430, MIPS, PTX,
836     and XCore backends are experimental.</li>
837 <li><tt>llc</tt> "<tt>-filetype=obj</tt>" is experimental on all targets
838     other than darwin and ELF X86 systems.</li>
839     
840 </ul>
841
842 </div>
843
844 <!-- ======================================================================= -->
845 <h3>
846   <a name="x86-be">Known problems with the X86 back-end</a>
847 </h3>
848
849 <div>
850
851 <ul>
852   <li>The X86 backend does not yet support
853     all <a href="http://llvm.org/PR879">inline assembly that uses the X86
854     floating point stack</a>.  It supports the 'f' and 't' constraints, but not
855     'u'.</li>
856   <li>The X86-64 backend does not yet support the LLVM IR instruction
857       <tt>va_arg</tt>. Currently, front-ends support variadic
858       argument constructs on X86-64 by lowering them manually.</li>
859   <li>Windows x64 (aka Win64) code generator has a few issues.
860     <ul>
861       <li>llvm-gcc cannot build the mingw-w64 runtime currently
862        due to lack of support for the 'u' inline assembly
863        constraint and for X87 floating point inline assembly.</li>
864       <li>On mingw-w64, you will see unresolved symbol <tt>__chkstk</tt>
865        due to <a href="http://llvm.org/bugs/show_bug.cgi?id=8919">Bug 8919</a>.
866        It is fixed in <a href="http://lists.cs.uiuc.edu/pipermail/llvm-commits/Week-of-Mon-20110321/118499.html">r128206</a>.</li>
867       <li>Miss-aligned MOVDQA might crash your program. It is due to
868        <a href="http://llvm.org/bugs/show_bug.cgi?id=9483">Bug 9483</a>,
869        lack of handling aligned internal globals.</li>
870       </ul>
871   </li>
872
873 </ul>
874
875 </div>
876
877 <!-- ======================================================================= -->
878 <h3>
879   <a name="ppc-be">Known problems with the PowerPC back-end</a>
880 </h3>
881
882 <div>
883
884 <ul>
885 <li>The Linux PPC32/ABI support needs testing for the interpreter and static
886 compilation, and lacks support for debug information.</li>
887 </ul>
888
889 </div>
890
891 <!-- ======================================================================= -->
892 <h3>
893   <a name="arm-be">Known problems with the ARM back-end</a>
894 </h3>
895
896 <div>
897
898 <ul>
899 <li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
900 processors, thumb programs can crash or produce wrong
901 results (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
902 <li>Compilation for ARM Linux OABI (old ABI) is supported but not fully tested.
903 </li>
904 </ul>
905
906 </div>
907
908 <!-- ======================================================================= -->
909 <h3>
910   <a name="sparc-be">Known problems with the SPARC back-end</a>
911 </h3>
912
913 <div>
914
915 <ul>
916 <li>The SPARC backend only supports the 32-bit SPARC ABI (-m32); it does not
917     support the 64-bit SPARC ABI (-m64).</li>
918 </ul>
919
920 </div>
921
922 <!-- ======================================================================= -->
923 <h3>
924   <a name="mips-be">Known problems with the MIPS back-end</a>
925 </h3>
926
927 <div>
928
929 <ul>
930 <li>64-bit MIPS targets are not supported yet.</li>
931 </ul>
932
933 </div>
934
935 <!-- ======================================================================= -->
936 <h3>
937   <a name="alpha-be">Known problems with the Alpha back-end</a>
938 </h3>
939
940 <div>
941
942 <ul>
943
944 <li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
945 appropriate nops inserted to ensure restartability.</li>
946
947 </ul>
948 </div>
949
950 <!-- ======================================================================= -->
951 <h3>
952   <a name="c-be">Known problems with the C back-end</a>
953 </h3>
954
955 <div>
956
957 <p>The C backend has numerous problems and is not being actively maintained.
958 Depending on it for anything serious is not advised.</p>
959
960 <ul>
961 <li><a href="http://llvm.org/PR802">The C backend has only basic support for
962     inline assembly code</a>.</li>
963 <li><a href="http://llvm.org/PR1658">The C backend violates the ABI of common
964     C++ programs</a>, preventing intermixing between C++ compiled by the CBE and
965     C++ code compiled with <tt>llc</tt> or native compilers.</li>
966 <li>The C backend does not support all exception handling constructs.</li>
967 <li>The C backend does not support arbitrary precision integers.</li>
968 </ul>
969
970 </div>
971
972
973 <!-- ======================================================================= -->
974 <h3>
975   <a name="llvm-gcc">Known problems with the llvm-gcc front-end</a>
976 </h3>
977
978 <div>
979
980 <p><b>LLVM 3.0 will be the last release of llvm-gcc.</b></p>
981
982 <p>llvm-gcc is generally very stable for the C family of languages.  The only
983    major language feature of GCC not supported by llvm-gcc is the
984    <tt>__builtin_apply</tt> family of builtins.   However, some extensions
985    are only supported on some targets.  For example, trampolines are only
986    supported on some targets (these are used when you take the address of a
987    nested function).</p>
988
989 <p>Fortran support generally works, but there are still several unresolved bugs
990    in <a href="http://llvm.org/bugs/">Bugzilla</a>.  Please see the
991    tools/gfortran component for details.  Note that llvm-gcc is missing major
992    Fortran performance work in the frontend and library that went into GCC after
993    4.2.  If you are interested in Fortran, we recommend that you consider using
994    <a href="#dragonegg">dragonegg</a> instead.</p>
995
996 <p>The llvm-gcc 4.2 Ada compiler has basic functionality, but is no longer being
997 actively maintained.  If you are interested in Ada, we recommend that you
998 consider using <a href="#dragonegg">dragonegg</a> instead.</p>
999 </div>
1000
1001 </div>
1002
1003 <!-- *********************************************************************** -->
1004 <h2>
1005   <a name="additionalinfo">Additional Information</a>
1006 </h2>
1007 <!-- *********************************************************************** -->
1008
1009 <div>
1010
1011 <p>A wide variety of additional information is available on the <a
1012 href="http://llvm.org/">LLVM web page</a>, in particular in the <a
1013 href="http://llvm.org/docs/">documentation</a> section.  The web page also
1014 contains versions of the API documentation which is up-to-date with the
1015 Subversion version of the source code.
1016 You can access versions of these documents specific to this release by going
1017 into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
1018
1019 <p>If you have any questions or comments about LLVM, please feel free to contact
1020 us via the <a href="http://llvm.org/docs/#maillist"> mailing
1021 lists</a>.</p>
1022
1023 </div>
1024
1025 <!-- *********************************************************************** -->
1026
1027 <hr>
1028 <address>
1029   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
1030   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
1031   <a href="http://validator.w3.org/check/referer"><img
1032   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
1033
1034   <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
1035   Last modified: $Date$
1036 </address>
1037
1038 </body>
1039 </html>