I plan to release a version of dragonegg based on llvm-2.7 shortly
[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 2.7 Release Notes</title>
8 </head>
9 <body>
10
11 <div class="doc_title">LLVM 2.7 Release Notes</div>
12
13 <img align=right src="http://llvm.org/img/DragonSmall.png"
14     width="136" height="136">
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 2.7</a></li>
20   <li><a href="#whatsnew">What's New in LLVM 2.7?</a></li>
21   <li><a href="GettingStarted.html">Installation Instructions</a></li>
22   <li><a href="#portability">Portability and Supported Platforms</a></li>
23   <li><a href="#knownproblems">Known Problems</a></li>
24   <li><a href="#additionalinfo">Additional Information</a></li>
25 </ol>
26
27 <div class="doc_author">
28   <p>Written by the <a href="http://llvm.org">LLVM Team</a></p>
29 </div>
30
31 <!--
32 <h1 style="color:red">These are in-progress notes for the upcoming LLVM 2.7
33 release.<br>
34 You may prefer the
35 <a href="http://llvm.org/releases/2.6/docs/ReleaseNotes.html">LLVM 2.6
36 Release Notes</a>.</h1>-->
37
38 <!-- *********************************************************************** -->
39 <div class="doc_section">
40   <a name="intro">Introduction</a>
41 </div>
42 <!-- *********************************************************************** -->
43
44 <div class="doc_text">
45
46 <p>This document contains the release notes for the LLVM Compiler
47 Infrastructure, release 2.7.  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
64 <p>FIXME: llvm.org moved to new server, mention new logo, Ted and Doug new code
65    owners, web page in llvm-www repos.</p>
66
67 </div>
68  
69
70 <!--
71 Almost dead code.
72   include/llvm/Analysis/LiveValues.h => Dan
73   lib/Transforms/IPO/MergeFunctions.cpp => consider for 2.8.
74   llvm/Analysis/PointerTracking.h => Edwin wants this, consider for 2.8.
75   ABCD, GEPSplitterPass
76   MSIL backend?
77   lib/Transforms/Utils/SSI.cpp  -> ABCD depends on it.
78 -->
79  
80    
81 <!-- Features that need text if they're finished for 2.7:
82   gcc plugin.
83   strong phi elim
84   variable debug info for optimized code
85   postalloc scheduler: anti dependence breaking, hazard recognizer?
86   metadata
87   loop dependence analysis
88   ELF Writer?  How stable?
89   <li>PostRA scheduler improvements, ARM adoption (David Goodwin).</li>
90  -->
91
92  <!-- for announcement email:
93  Logo web page.
94  llvm devmtg
95  compiler_rt
96  KLEE web page at klee.llvm.org
97  Many new papers added to /pubs/
98  Mention gcc plugin.
99    -->
100
101 <!-- *********************************************************************** -->
102 <div class="doc_section">
103   <a name="subproj">Sub-project Status Update</a>
104 </div>
105 <!-- *********************************************************************** -->
106
107 <div class="doc_text">
108 <p>
109 The LLVM 2.7 distribution currently consists of code from the core LLVM
110 repository (which roughly includes the LLVM optimizers, code generators
111 and supporting tools), the Clang repository and the llvm-gcc repository.  In
112 addition to this code, the LLVM Project includes other sub-projects that are in
113 development.  Here we include updates on these subprojects.
114 </p>
115
116 </div>
117
118
119 <!--=========================================================================-->
120 <div class="doc_subsection">
121 <a name="clang">Clang: C/C++/Objective-C Frontend Toolkit</a>
122 </div>
123
124 <div class="doc_text">
125
126 <p>The <a href="http://clang.llvm.org/">Clang project</a> is ...</p>
127
128 <p>In the LLVM 2.7 time-frame, the Clang team has made many improvements:</p>
129
130 <ul>
131 <li>FIXME: C++! Include a link to cxx_compatibility.html</li>
132
133 <li>FIXME: Static Analyzer improvements?</li>
134
135 <li>CIndex API and Python bindings: Clang now includes a C API as part of the
136 CIndex library. Although we make make some changes to the API in the future, it
137 is intended to be stable and has been designed for use by external projects. See
138 the Clang
139 doxygen <a href="http://clang.llvm.org/doxygen/group__CINDEX.html">CIndex</a>
140 documentation for more details. The CIndex API also includings an preliminary
141 set of Python bindings.</li>
142
143 <li>ARM Support: Clang now has ABI support for both the Darwin and Linux ARM
144 ABIs. Coupled with many improvements to the LLVM ARM backend, Clang is now
145 suitable for use as a a beta quality ARM compiler.</li>
146 </ul>
147 </div>
148
149 <!--=========================================================================-->
150 <div class="doc_subsection">
151 <a name="clangsa">Clang Static Analyzer</a>
152 </div>
153
154 <div class="doc_text">
155
156 <p>Previously announced in the 2.4, 2.5, and 2.6 LLVM releases, the Clang project also
157 includes an early stage static source code analysis tool for <a
158 href="http://clang.llvm.org/StaticAnalysis.html">automatically finding bugs</a>
159 in C and Objective-C programs. The tool performs checks to find
160 bugs that occur on a specific path within a program.</p>
161
162 <p>In the LLVM 2.7 time-frame, the analyzer core has sprouted legs and...</p>
163
164 </div>
165
166 <!--=========================================================================-->
167 <div class="doc_subsection">
168 <a name="vmkit">VMKit: JVM/CLI Virtual Machine Implementation</a>
169 </div>
170
171 <div class="doc_text">
172 <p>
173 The <a href="http://vmkit.llvm.org/">VMKit project</a> is an implementation of
174 a JVM and a CLI Virtual Machine (Microsoft .NET is an
175 implementation of the CLI) using LLVM for static and just-in-time
176 compilation.</p>
177
178 <p>
179 With the release of LLVM 2.7, VMKit has shifted to a great framework for writing
180 virtual machines. VMKit now offers precise and efficient garbage collection with
181 multi-threading support, thanks to the MMTk memory management toolkit, as well
182 as just in time and ahead of time compilation with LLVM.  The major changes in
183 VMKit 0.27 are:</p>
184
185 <ul>
186
187 <li>Garbage collection: VMKit now uses the MMTk toolkit for garbage collectors.
188   The first collector to be ported is the MarkSweep collector, which is precise,
189   and drastically improves the performance of VMKit.</li>
190 <li>Line number information in the JVM: by using the debug metadata of LLVM, the
191  JVM now supports precise line number information, useful when printing a stack
192  trace.</li>
193 <li>Interface calls in the JVM: we implemented a variant of the Interface Method
194   Table technique for interface calls in the JVM.
195 </li>
196
197 </ul>
198 </div>
199
200
201 <!--=========================================================================-->
202 <div class="doc_subsection">
203 <a name="compiler-rt">compiler-rt: Compiler Runtime Library</a>
204 </div>
205
206 <div class="doc_text">
207 <p>
208 The new LLVM <a href="http://compiler-rt.llvm.org/">compiler-rt project</a>
209 is a simple library that provides an implementation of the low-level
210 target-specific hooks required by code generation and other runtime components.
211 For example, when compiling for a 32-bit target, converting a double to a 64-bit
212 unsigned integer is compiled into a runtime call to the "__fixunsdfdi"
213 function. The compiler-rt library provides highly optimized implementations of
214 this and other low-level routines (some are 3x faster than the equivalent
215 libgcc routines).</p>
216
217 <p>
218 All of the code in the compiler-rt project is available under the standard LLVM
219 License, a "BSD-style" license.</p>
220
221 </div>
222
223 <!--=========================================================================-->
224 <div class="doc_subsection">
225 <a name="dragonegg">DragonEgg: llvm-gcc ported to gcc-4.5</a>
226 </div>
227
228 <div class="doc_text">
229 <p>
230 <a href="http://dragonegg.llvm.org/">DragonEgg</a> is a port of llvm-gcc to
231 gcc-4.5.  Unlike llvm-gcc, which makes many intrusive changes to the underlying
232 gcc-4.2 code, dragonegg in theory does not require any gcc-4.5 modifications
233 whatsoever (currently one small patch is needed).  This is thanks to the new
234 <a href="http://gcc.gnu.org/wiki/plugins">gcc plugin architecture</a>, which
235 makes it possible to modify the behaviour of gcc at runtime by loading a plugin,
236 which is nothing more than a dynamic library which conforms to the gcc plugin
237 interface.  DragonEgg is a gcc plugin that causes the LLVM optimizers to be run
238 instead of the gcc optimizers, and the LLVM code generators instead of the gcc
239 code generators, just like llvm-gcc.  To use it, you add
240 "-fplugin=path/dragonegg.so" to the gcc-4.5 command line, and gcc-4.5 magically
241 becomes llvm-gcc-4.5!
242 </p>
243
244 <p>
245 DragonEgg is still a work in progress.  Currently C works very well, while C++,
246 Ada and Fortran work fairly well.  All other languages either don't work at all,
247 or only work poorly.  For the moment only the x86-32 and x86-64 targets are
248 supported, and only on linux and darwin (darwin needs an additional gcc patch).
249 </p>
250
251 <p>
252 The first dragonegg release will occur shortly after llvm-2.7 is released.
253 </p>
254
255 </div>
256
257
258 <!--=========================================================================-->
259 <div class="doc_subsection">
260 <a name="mc">llvm-mc: Machine Code Toolkit</a>
261 </div>
262
263 <div class="doc_text">
264 <p>
265 The LLVM Machine Code (MC) Toolkit project is ...
266 </p>
267
268 </div>  
269
270
271 <!-- *********************************************************************** -->
272 <div class="doc_section">
273   <a name="externalproj">External Open Source Projects Using LLVM 2.7</a>
274 </div>
275 <!-- *********************************************************************** -->
276
277 <div class="doc_text">
278
279 <p>An exciting aspect of LLVM is that it is used as an enabling technology for
280    a lot of other language and tools projects.  This section lists some of the
281    projects that have already been updated to work with LLVM 2.7.</p>
282 </div>
283
284
285 <!--=========================================================================-->
286 <div class="doc_subsection">
287 <a name="Rubinius">Rubinius</a>
288 </div>
289
290 <div class="doc_text">
291 Need update.
292 <!--
293 <p><a href="http://github.com/evanphx/rubinius">Rubinius</a> is an environment
294 for running Ruby code which strives to write as much of the core class
295 implementation in Ruby as possible. Combined with a bytecode interpreting VM, it
296 uses LLVM to optimize and compile ruby code down to machine code. Techniques
297 such as type feedback, method inlining, and uncommon traps are all used to
298 remove dynamism from ruby execution and increase performance.</p>
299
300 <p>Since LLVM 2.5, Rubinius has made several major leaps forward, implementing
301 a counter based JIT, type feedback and speculative method inlining.
302 -->
303 </p>
304
305 </div>
306
307 <!--=========================================================================-->
308 <div class="doc_subsection">
309 <a name="macruby">MacRuby</a>
310 </div>
311
312 <div class="doc_text">
313
314 <p>
315 Need update.
316 <!--
317 <a href="http://macruby.org">MacRuby</a> is an implementation of Ruby on top of
318 core Mac OS X technologies, such as the Objective-C common runtime and garbage
319 collector and the CoreFoundation framework. It is principally developed by
320 Apple and aims at enabling the creation of full-fledged Mac OS X applications.
321 </p>
322
323 <p>
324 MacRuby uses LLVM for optimization passes, JIT and AOT compilation of Ruby
325 expressions. It also uses zero-cost DWARF exceptions to implement Ruby exception
326 handling.--> </p>
327
328 </div>
329
330
331 <!--=========================================================================-->
332 <div class="doc_subsection">
333 <a name="pure">Pure</a>
334 </div>
335
336 <div class="doc_text">
337 <p>
338 <a href="http://pure-lang.googlecode.com/">Pure</a>
339 is an algebraic/functional programming language based on term rewriting.
340 Programs are collections of equations which are used to evaluate expressions in
341 a symbolic fashion. Pure offers dynamic typing, eager and lazy evaluation,
342 lexical closures, a hygienic macro system (also based on term rewriting),
343 built-in list and matrix support (including list and matrix comprehensions) and
344 an easy-to-use C interface. The interpreter uses LLVM as a backend to
345  JIT-compile Pure programs to fast native code.</p>
346
347 <p>Pure versions 0.43 and later have been tested and are known to work with
348 LLVM 2.7 (and continue to work with older LLVM releases >= 2.5).</p>
349
350 </div>
351
352
353 <!--=========================================================================-->
354 <div class="doc_subsection">
355 <a name="ldc">LLVM D Compiler</a>
356 </div>
357
358 <div class="doc_text">
359 <p>
360 Need update.
361 <!--
362 <a href="http://www.dsource.org/projects/ldc">LDC</a> is an implementation of
363 the D Programming Language using the LLVM optimizer and code generator.
364 The LDC project works great with the LLVM 2.6 release.  General improvements in
365 this
366 cycle have included new inline asm constraint handling, better debug info
367 support, general bug fixes and better x86-64 support.  This has allowed
368 some major improvements in LDC, getting it much closer to being as
369 fully featured as the original DMD compiler from DigitalMars.-->
370 </p>
371 </div>
372
373 <!--=========================================================================-->
374 <div class="doc_subsection">
375 <a name="RoadsendPHP">Roadsend PHP</a>
376 </div>
377
378 <div class="doc_text">
379 <p>
380 <a href="http://code.roadsend.com/rphp">Roadsend PHP</a> (rphp) is an open
381 source implementation of the PHP programming 
382 language that uses LLVM for its optimizer, JIT and static compiler. This is a 
383 reimplementation of an earlier project that is now based on LLVM.
384 </p>
385 </div>
386
387 <!--=========================================================================-->
388 <div class="doc_subsection">
389 <a name="UnladenSwallow">Unladen Swallow</a>
390 </div>
391
392 <div class="doc_text">
393 <p>
394 <a href="http://code.google.com/p/unladen-swallow/">Unladen Swallow</a> is a
395 branch of <a href="http://python.org/">Python</a> intended to be fully
396 compatible and significantly faster.  It uses LLVM's optimization passes and JIT
397 compiler.
398 </p>
399 </div>
400
401 <!--=========================================================================-->
402 <div class="doc_subsection">
403 <a name="llvm-lua">llvm-lua</a>
404 </div>
405
406 <div class="doc_text">
407 <p>
408 Need update.
409 <!--
410 <a href="http://code.google.com/p/llvm-lua/">LLVM-Lua</a> uses LLVM to add JIT
411 and static compiling support to the Lua VM.  Lua bytecode is analyzed to
412 remove type checks, then LLVM is used to compile the bytecode down to machine
413 code.-->
414 </p>
415 </div>
416
417 <!--=========================================================================-->
418 <div class="doc_subsection">
419 <a name="icedtea">IcedTea Java Virtual Machine Implementation</a>
420 </div>
421
422 <div class="doc_text">
423 <p>
424 Need update.
425 <!--
426 <a href="http://icedtea.classpath.org/wiki/Main_Page">IcedTea</a> provides a
427 harness to build OpenJDK using only free software build tools and to provide
428 replacements for the not-yet free parts of OpenJDK.  One of the extensions that
429 IcedTea provides is a new JIT compiler named <a
430 href="http://icedtea.classpath.org/wiki/ZeroSharkFaq">Shark</a> which uses LLVM
431 to provide native code generation without introducing processor-dependent
432 code.-->
433 </p>
434 </div>
435
436
437 <!--=========================================================================-->
438 <div class="doc_subsection">
439 <a name="tce">TTA-based Codesign Environment (TCE)</a>
440 </div>
441
442 <div class="doc_text">
443 <p>
444 <a href="http://tce.cs.tut.fi/">TCE</a> is a toolset for designing
445 application-specific processors (ASP) based on the Transport triggered
446 architecture (TTA). The toolset provides a complete co-design flow from C/C++
447 programs down to synthesizable VHDL and parallel program binaries. Processor
448 customization points include the register files, function units, supported
449 operations, and the interconnection network.</p>
450
451 <p>TCE uses llvm-gcc/Clang and LLVM for C/C++ language support, target
452 independent optimizations and also for parts of code generation. It generates
453 new LLVM-based code generators "on the fly" for the designed TTA processors and
454 loads them in to the compiler backend as runtime libraries to avoid per-target
455 recompilation of larger parts of the compiler chain.</p>
456
457 </div>
458
459 <!--=========================================================================-->
460 <div class="doc_subsection">
461 <a name="safecode">SAFECode Compiler</a>
462 </div>
463
464 <div class="doc_text">
465 <p>
466 <a href="http://safecode.cs.illinois.edu">SAFECode</a> is a memory safe C
467 compiler built using LLVM.  It takes standard, unannotated C code, analyzes the
468 code to ensure that memory accesses and array indexing operations are safe, and
469 instruments the code with run-time checks when safety cannot be proven
470 statically.
471 </p>
472 </div>
473
474
475 <!-- *********************************************************************** -->
476 <div class="doc_section">
477   <a name="whatsnew">What's New in LLVM 2.7?</a>
478 </div>
479 <!-- *********************************************************************** -->
480
481 <div class="doc_text">
482
483 <p>This release includes a huge number of bug fixes, performance tweaks and
484 minor improvements.  Some of the major improvements and new features are listed
485 in this section.
486 </p>
487
488 </div>
489
490 <!--=========================================================================-->
491 <div class="doc_subsection">
492 <a name="majorfeatures">Major New Features</a>
493 </div>
494
495 <div class="doc_text">
496
497 <p>LLVM 2.7 includes several major new capabilities:</p>
498
499 <ul>
500 <li>...</li>
501 </ul>
502
503 Extensible metadata solid.
504
505 Debug info improvements: using metadata instead of llvm.dbg global variables.
506 This brings several enhancements including improved compile times.
507
508 New instruction selector.
509 GHC Haskell ABI/ calling conv support.
510 Pre-Alpha support for unions in IR.
511 New InlineHint and StackAlignment function attributes
512 Code generator MC'ized except for debug info and EH.
513 New SCEV AA pass: -scev-aa
514 Inliner reuses arrays allocas when inlining multiple callers to reduce stack usage.
515 MC encoding and disassembler apis.
516 Optimal Edge Profiling?
517 Instcombine is now a library, has its own IRBuilder to simplify itself.
518 New llvm/Support/Regex.h API.  FileCheck now does regex's
519 Many subtle pointer invalidation bugs in Callgraph have been fixed and it now uses asserting value handles.
520 MC Disassembler (with blog post), MCInstPrinter.  Many X86 backend and AsmPrinter simplifications
521 Various tools like llc and opt now read either .ll or .bc files as input.
522 Malloc and free instructions got removed, along with LowerAllocations pass.
523 compiler-rt support for ARM.
524 completely llvm-gcc NEON support.
525 Can transcode from GAS to intel syntax with "llvm-mc foo.s -output-asm-variant=1"
526 JIT debug information with GDB 7.0
527 New CodeGen Level CSE
528 CMake can now run tests, what other improvements?
529 ARM/Thumb using reg scavenging for stack object address materialization (PEI).
530 New SSAUpdater and MachineSSAUpdater classes for unstructured ssa updating,
531   changed jump threading, GVN, etc to use it which simplified them and speed
532   them up.
533 Combiner-AA improvements, why not on by default?
534 Pre-regalloc tail duplication
535 x86 sibcall / tailcall optimization in CCC mode.
536 New LSR with "full strength reduction" mode.  Description?
537 Codegen level OptimizeExtsPass pass, takes advantage of x86 subregs. 
538 Better code size analysis in loop unswitch, inliner code split out to a new 
539   CodeMetrics class for reuse.
540 The ARM backend now has good support for ARMv4 backend (tested on StrongARM
541   hardware), previously only supported ARMv4T and newer.
542 Half-float support in APFloat
543 Indirect branch + address of label (blog post), particularly useful for interpreters.
544 Many changes to the pass ordering for improved optimization effectiveness.
545 BasicAA improved to be less dependent on "type safe" pointers, it can now look
546   through bitcasts more aggressively.
547 GVN PHI Translation improvements. blog post: http://blog.llvm.org/2009/12/advanced-topics-in-redundant-load.html
548 llvm.objectsize.
549 MachineSSAUpdater.h
550 PostRA scheduler for X86?
551 llvm.dbg.value, not being used by default though, more in 2.8.  Many improvements to debug info
552 Support for the GCC option -fno-schedule-insns
553 non-temporal load/store
554 libllvm2.7.so??  configure with --enable-shared 
555 dbgs() and -debug-buffer-size=N
556 New MicroBlaze backend. http://en.wikipedia.org/wiki/MicroBlaze
557 XMM subreg modeling for extraction of the low element.
558
559
560 Opt now works conservatively if no target data is set (is this fully working?)
561 Target data now has notion of 'native' integer data types which optimizations can use.
562 ARM backend generates instructions in unified assembly syntax.
563 New Analysis/InstructionSimplify.h interface for simplifying instructions that don't exist.
564 Jump threading is now much more aggressive at simplifying correlated
565    conditionals and threading blocks with otherwise complex logic. CondProp pass
566    removed (functionality merged into jump threading).
567 X86 and XCore supports returning arbitrary return values, returning too many values is
568    supported by returning through a hidden pointer.
569 verbose-asm now produces information about spill slots and loop nests
570
571
572 Defaults to RTTI off (smaller code size!), packagers should build with make REQUIRE_RTTI=1.
573 AndersAA got removed
574 PredSimplify, LoopVR, GVNPRE, RSProfiling (random sampling profiling) got removed.
575 LLVM command line tools now overwrite their output, before they would only do this with -f.
576 DOUT removed, use DEBUG(errs() instead.
577 Much stuff converted to use raw_ostream instead of std::ostream.
578 TargetAsmInfo renamed to MCAsmInfo
579 llvm/ADT/iterator.h gone.
580
581
582 </div>
583
584 <!--=========================================================================-->
585 <div class="doc_subsection">
586 <a name="coreimprovements">LLVM IR and Core Improvements</a>
587 </div>
588
589 <div class="doc_text">
590 <p>LLVM IR has several new features for better support of new targets and that
591 expose new optimization opportunities:</p>
592
593 <ul>
594 <li>...</li>
595 </ul>
596
597 </div>
598
599 <!--=========================================================================-->
600 <div class="doc_subsection">
601 <a name="optimizer">Optimizer Improvements</a>
602 </div>
603
604 <div class="doc_text">
605
606 <p>In addition to a large array of minor performance tweaks and bug fixes, this
607 release includes a few major enhancements and additions to the optimizers:</p>
608
609 <ul>
610
611 <li>...</li>
612
613 </ul>
614
615 <p>Also, -anders-aa was removed</p>
616
617 </div>
618
619
620 <!--=========================================================================-->
621 <div class="doc_subsection">
622 <a name="executionengine">Interpreter and JIT Improvements</a>
623 </div>
624
625 <div class="doc_text">
626
627 <ul>
628 <li>The JIT now <a
629 href="http://llvm.org/viewvc/llvm-project?view=rev&revision=85295">defaults
630 to compiling eagerly</a> to avoid a race condition in the lazy JIT.
631 Clients that still want the lazy JIT can switch it on by calling
632 <tt>ExecutionEngine::DisableLazyCompilation(false)</tt>.</li>
633 <li>It is now possible to create more than one JIT instance in the same process.
634 These JITs can generate machine code in parallel,
635 although <a href="http://llvm.org/docs/ProgrammersManual.html#jitthreading">you
636 still have to obey the other threading restrictions</a>.</li>
637 </ul>
638
639 </div>
640
641 <!--=========================================================================-->
642 <div class="doc_subsection">
643 <a name="codegen">Target Independent Code Generator Improvements</a>
644 </div>
645
646 <div class="doc_text">
647
648 <p>We have put a significant amount of work into the code generator
649 infrastructure, which allows us to implement more aggressive algorithms and make
650 it run faster:</p>
651
652 <ul>
653
654 <li>...</li>
655 </ul>
656 </div>
657
658 <!--=========================================================================-->
659 <div class="doc_subsection">
660 <a name="x86">X86-32 and X86-64 Target Improvements</a>
661 </div>
662
663 <div class="doc_text">
664 <p>New features of the X86 target include:
665 </p>
666
667 <ul>
668
669 <li>...</li>
670
671 </ul>
672
673 </div>
674
675 <!--=========================================================================-->
676 <div class="doc_subsection">
677 <a name="pic16">PIC16 Target Improvements</a>
678 </div>
679
680 <div class="doc_text">
681 <p>New features of the PIC16 target include:
682 </p>
683
684 <ul>
685 <li>...</li>
686 </ul>
687
688 <p>Things not yet supported:</p>
689
690 <ul>
691 <li>Variable arguments.</li>
692 <li>Interrupts/programs.</li>
693 </ul>
694
695 </div>
696
697 <!--=========================================================================-->
698 <div class="doc_subsection">
699 <a name="ARM">ARM Target Improvements</a>
700 </div>
701
702 <div class="doc_text">
703 <p>New features of the ARM target include:
704 </p>
705
706 <ul>
707
708 <li>...</li>
709 </ul>
710
711
712 </div>
713
714 <!--=========================================================================-->
715 <div class="doc_subsection">
716 <a name="OtherTarget">Other Target Specific Improvements</a>
717 </div>
718
719 <div class="doc_text">
720 <p>New features of other targets include:
721 </p>
722
723 <ul>
724 <li>...</li>
725 </ul>
726
727 </div>
728
729 <!--=========================================================================-->
730 <div class="doc_subsection">
731 <a name="newapis">New Useful APIs</a>
732 </div>
733
734 <div class="doc_text">
735
736 <p>This release includes a number of new APIs that are used internally, which
737    may also be useful for external clients.
738 </p>
739
740 <ul>
741 <li>...</li>
742 </ul>
743
744
745 </div>
746
747 <!--=========================================================================-->
748 <div class="doc_subsection">
749 <a name="otherimprovements">Other Improvements and New Features</a>
750 </div>
751
752 <div class="doc_text">
753 <p>Other miscellaneous features include:</p>
754
755 <ul>
756 <li>...</li>
757 </ul>
758
759 </div>
760
761
762 <!--=========================================================================-->
763 <div class="doc_subsection">
764 <a name="changes">Major Changes and Removed Features</a>
765 </div>
766
767 <div class="doc_text">
768
769 <p>If you're already an LLVM user or developer with out-of-tree changes based
770 on LLVM 2.6, this section lists some "gotchas" that you may run into upgrading
771 from the previous release.</p>
772
773 <ul>
774 <li>The LLVM interpreter now defaults to <em>not</em> using <tt>libffi</tt> even
775 if you have it installed.  This makes it more likely that an LLVM built on one
776 system will work when copied to a similar system.  To use <tt>libffi</tt>,
777 configure with <tt>--enable-libffi</tt>.
778 </li>
779 </ul>
780
781
782 <p>In addition, many APIs have changed in this release.  Some of the major LLVM
783 API changes are:</p>
784
785 <ul>
786 <li><tt>ModuleProvider</tt> has been <a
787 href="http://llvm.org/viewvc/llvm-project?view=rev&revision=94686">removed</a>
788 and its methods moved to <tt>Module</tt> and <tt>GlobalValue</tt>.
789 Most clients can remove uses of <tt>ExistingModuleProvider</tt>,
790 replace <tt>getBitcodeModuleProvider</tt> with
791 <tt>getLazyBitcodeModule</tt>, and pass their <tt>Module</tt> to
792 functions that used to accept <tt>ModuleProvider</tt>.  Clients who
793 wrote their own <tt>ModuleProvider</tt>s will need to derive from
794 <tt>GVMaterializer</tt> instead and use
795 <tt>Module::setMaterializer</tt> to attach it to a
796 <tt>Module</tt>.</li>
797
798 <li><tt>GhostLinkage</tt> has given up the ghost.
799 <tt>GlobalValue</tt>s that have not yet been read from their backing
800 storage have the same linkage they will have after being read in.
801 Clients must replace calls to
802 <tt>GlobalValue::hasNotBeenReadFromBitcode</tt> with
803 <tt>GlobalValue::isMaterializable</tt>.</li>
804
805 <li>FIXME: Debug info has been totally redone. Add pointers to new APIs. Substantial caveats about compatibility of .ll and .bc files.</li>
806
807 <li>The <tt>llvm/Support/DataTypes.h</tt> header has moved
808 to <tt>llvm/System/DataTypes.h</tt>.</li>
809
810 <li>The <tt>isInteger</tt>, <tt>isIntOrIntVector</tt>, <tt>isFloatingPoint</tt>,
811 <tt>isFPOrFPVector</tt> and <tt>isFPOrFPVector</tt> methods have been renamed
812 <tt>isIntegerTy</tt>, <tt>isIntOrIntVectorTy</tt>, <tt>isFloatingPointTy</tt>, 
813 <tt>isFPOrFPVectorTy</tt> and <tt>isFPOrFPVectorTy</tt> respectively.</li>
814 </ul>
815
816 </div>
817
818
819
820 <!-- *********************************************************************** -->
821 <div class="doc_section">
822   <a name="portability">Portability and Supported Platforms</a>
823 </div>
824 <!-- *********************************************************************** -->
825
826 <div class="doc_text">
827
828 <p>LLVM is known to work on the following platforms:</p>
829
830 <ul>
831 <li>Intel and AMD machines (IA32, X86-64, AMD64, EMT-64) running Red Hat
832     Linux, Fedora Core, FreeBSD and AuroraUX (and probably other unix-like
833     systems).</li>
834 <li>PowerPC and X86-based Mac OS X systems, running 10.3 and above in 32-bit
835     and 64-bit modes.</li>
836 <li>Intel and AMD machines running on Win32 using MinGW libraries (native).</li>
837 <li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
838     support is available for native builds with Visual C++).</li>
839 <li>Sun x86 and AMD64 machines running Solaris 10, OpenSolaris 0906.</li>
840 <li>Alpha-based machines running Debian GNU/Linux.</li>
841 </ul>
842
843 <p>The core LLVM infrastructure uses GNU autoconf to adapt itself
844 to the machine and operating system on which it is built.  However, minor
845 porting may be required to get LLVM to work on new platforms.  We welcome your
846 portability patches and reports of successful builds or error messages.</p>
847
848 </div>
849
850 <!-- *********************************************************************** -->
851 <div class="doc_section">
852   <a name="knownproblems">Known Problems</a>
853 </div>
854 <!-- *********************************************************************** -->
855
856 <div class="doc_text">
857
858 <p>This section contains significant known problems with the LLVM system,
859 listed by component.  If you run into a problem, please check the <a
860 href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
861 there isn't already one.</p>
862
863 <ul>    
864 <li>LLVM will not correctly compile on Solaris and/or OpenSolaris
865 using the stock GCC 3.x.x series 'out the box',
866 See: <a href="GettingStarted.html#brokengcc">Broken versions of GCC and other tools</a>.
867 However, A <a href="http://pkg.auroraux.org/GCC">Modern GCC Build</a>
868 for x86/x86-64 has been made available from the third party AuroraUX Project
869 that has been meticulously tested for bootstrapping LLVM &amp; Clang.</li>
870 </ul>
871
872 </div>
873
874 <!-- ======================================================================= -->
875 <div class="doc_subsection">
876   <a name="experimental">Experimental features included with this release</a>
877 </div>
878
879 <div class="doc_text">
880
881 <p>The following components of this LLVM release are either untested, known to
882 be broken or unreliable, or are in early development.  These components should
883 not be relied on, and bugs should not be filed against them, but they may be
884 useful to some people.  In particular, if you would like to work on one of these
885 components, please contact us on the <a
886 href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p>
887
888 <ul>
889 <li>The MSIL, Alpha, SPU, MIPS, PIC16, Blackfin, MSP430, SystemZ and MicroBlaze
890     backends are experimental.</li>
891 <li>The <tt>llc</tt> "<tt>-filetype=asm</tt>" (the default) is the only
892     supported value for this option.  The MachO writer is experimental, and
893     works much better in mainline SVN.</li>
894 </ul>
895
896 </div>
897
898 <!-- ======================================================================= -->
899 <div class="doc_subsection">
900   <a name="x86-be">Known problems with the X86 back-end</a>
901 </div>
902
903 <div class="doc_text">
904
905 <ul>
906   <li>The X86 backend does not yet support
907     all <a href="http://llvm.org/PR879">inline assembly that uses the X86
908     floating point stack</a>.  It supports the 'f' and 't' constraints, but not
909     'u'.</li>
910   <li>The X86 backend generates inefficient floating point code when configured
911     to generate code for systems that don't have SSE2.</li>
912   <li>Win64 code generation wasn't widely tested. Everything should work, but we
913     expect small issues to happen. Also, llvm-gcc cannot build the mingw64
914     runtime currently due
915     to <a href="http://llvm.org/PR2255">several</a>
916     <a href="http://llvm.org/PR2257">bugs</a> and due to lack of support for
917     the
918     'u' inline assembly constraint and for X87 floating point inline assembly.</li>
919   <li>The X86-64 backend does not yet support the LLVM IR instruction
920       <tt>va_arg</tt>. Currently, the llvm-gcc and front-ends support variadic
921       argument constructs on X86-64 by lowering them manually.</li>
922 </ul>
923
924 </div>
925
926 <!-- ======================================================================= -->
927 <div class="doc_subsection">
928   <a name="ppc-be">Known problems with the PowerPC back-end</a>
929 </div>
930
931 <div class="doc_text">
932
933 <ul>
934 <li>The Linux PPC32/ABI support needs testing for the interpreter and static
935 compilation, and lacks support for debug information.</li>
936 </ul>
937
938 </div>
939
940 <!-- ======================================================================= -->
941 <div class="doc_subsection">
942   <a name="arm-be">Known problems with the ARM back-end</a>
943 </div>
944
945 <div class="doc_text">
946
947 <ul>
948 <li>Support for the Advanced SIMD (Neon) instruction set is still incomplete
949 and not well tested.  Some features may not work at all, and the code quality
950 may be poor in some cases.</li>
951 <li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
952 processors, thumb programs can crash or produce wrong
953 results (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
954 <li>Compilation for ARM Linux OABI (old ABI) is supported but not fully tested.
955 </li>
956 </ul>
957
958 </div>
959
960 <!-- ======================================================================= -->
961 <div class="doc_subsection">
962   <a name="sparc-be">Known problems with the SPARC back-end</a>
963 </div>
964
965 <div class="doc_text">
966
967 <ul>
968 <li>The SPARC backend only supports the 32-bit SPARC ABI (-m32); it does not
969     support the 64-bit SPARC ABI (-m64).</li>
970 </ul>
971
972 </div>
973
974 <!-- ======================================================================= -->
975 <div class="doc_subsection">
976   <a name="mips-be">Known problems with the MIPS back-end</a>
977 </div>
978
979 <div class="doc_text">
980
981 <ul>
982 <li>64-bit MIPS targets are not supported yet.</li>
983 </ul>
984
985 </div>
986
987 <!-- ======================================================================= -->
988 <div class="doc_subsection">
989   <a name="alpha-be">Known problems with the Alpha back-end</a>
990 </div>
991
992 <div class="doc_text">
993
994 <ul>
995
996 <li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
997 appropriate nops inserted to ensure restartability.</li>
998
999 </ul>
1000 </div>
1001
1002 <!-- ======================================================================= -->
1003 <div class="doc_subsection">
1004   <a name="c-be">Known problems with the C back-end</a>
1005 </div>
1006
1007 <div class="doc_text">
1008
1009 <ul>
1010 <li><a href="http://llvm.org/PR802">The C backend has only basic support for
1011     inline assembly code</a>.</li>
1012 <li><a href="http://llvm.org/PR1658">The C backend violates the ABI of common
1013     C++ programs</a>, preventing intermixing between C++ compiled by the CBE and
1014     C++ code compiled with <tt>llc</tt> or native compilers.</li>
1015 <li>The C backend does not support all exception handling constructs.</li>
1016 <li>The C backend does not support arbitrary precision integers.</li>
1017 </ul>
1018
1019 </div>
1020
1021
1022 <!-- ======================================================================= -->
1023 <div class="doc_subsection">
1024   <a name="c-fe">Known problems with the llvm-gcc C and C++ front-end</a>
1025 </div>
1026
1027 <div class="doc_text">
1028
1029 <p>The only major language feature of GCC not supported by llvm-gcc is
1030     the <tt>__builtin_apply</tt> family of builtins.   However, some extensions
1031     are only supported on some targets.  For example, trampolines are only
1032     supported on some targets (these are used when you take the address of a
1033     nested function).</p>
1034
1035 <p>If you run into GCC extensions which are not supported, please let us know.
1036 </p>
1037
1038 </div>
1039
1040 <!-- ======================================================================= -->
1041 <div class="doc_subsection">
1042   <a name="fortran-fe">Known problems with the llvm-gcc Fortran front-end</a>
1043 </div>
1044
1045 <div class="doc_text">
1046 <ul>
1047 <li>Fortran support generally works, but there are still several unresolved bugs
1048     in <a href="http://llvm.org/bugs/">Bugzilla</a>.  Please see the
1049     tools/gfortran component for details.</li>
1050 </ul>
1051 </div>
1052
1053 <!-- ======================================================================= -->
1054 <div class="doc_subsection">
1055   <a name="ada-fe">Known problems with the llvm-gcc Ada front-end</a>
1056 </div>
1057
1058 <div class="doc_text">
1059 The llvm-gcc 4.2 Ada compiler works fairly well; however, this is not a mature
1060 technology, and problems should be expected.
1061 <ul>
1062 <li>The Ada front-end currently only builds on X86-32.  This is mainly due
1063 to lack of trampoline support (pointers to nested functions) on other platforms.
1064 However, it <a href="http://llvm.org/PR2006">also fails to build on X86-64</a>
1065 which does support trampolines.</li>
1066 <li>The Ada front-end <a href="http://llvm.org/PR2007">fails to bootstrap</a>.
1067 This is due to lack of LLVM support for <tt>setjmp</tt>/<tt>longjmp</tt> style
1068 exception handling, which is used internally by the compiler.
1069 Workaround: configure with <tt>--disable-bootstrap</tt>.</li>
1070 <li>The c380004, <a href="http://llvm.org/PR2010">c393010</a>
1071 and <a href="http://llvm.org/PR2421">cxg2021</a> ACATS tests fail
1072 (c380004 also fails with gcc-4.2 mainline).
1073 If the compiler is built with checks disabled then <a href="http://llvm.org/PR2010">c393010</a>
1074 causes the compiler to go into an infinite loop, using up all system memory.</li>
1075 <li>Some GCC specific Ada tests continue to crash the compiler.</li>
1076 <li>The <tt>-E</tt> binder option (exception backtraces)
1077 <a href="http://llvm.org/PR1982">does not work</a> and will result in programs
1078 crashing if an exception is raised.  Workaround: do not use <tt>-E</tt>.</li>
1079 <li>Only discrete types <a href="http://llvm.org/PR1981">are allowed to start
1080 or finish at a non-byte offset</a> in a record.  Workaround: do not pack records
1081 or use representation clauses that result in a field of a non-discrete type
1082 starting or finishing in the middle of a byte.</li>
1083 <li>The <tt>lli</tt> interpreter <a href="http://llvm.org/PR2009">considers
1084 'main' as generated by the Ada binder to be invalid</a>.
1085 Workaround: hand edit the file to use pointers for <tt>argv</tt> and
1086 <tt>envp</tt> rather than integers.</li>
1087 <li>The <tt>-fstack-check</tt> option <a href="http://llvm.org/PR2008">is
1088 ignored</a>.</li>
1089 </ul>
1090 </div>
1091
1092 <!-- *********************************************************************** -->
1093 <div class="doc_section">
1094   <a name="additionalinfo">Additional Information</a>
1095 </div>
1096 <!-- *********************************************************************** -->
1097
1098 <div class="doc_text">
1099
1100 <p>A wide variety of additional information is available on the <a
1101 href="http://llvm.org">LLVM web page</a>, in particular in the <a
1102 href="http://llvm.org/docs/">documentation</a> section.  The web page also
1103 contains versions of the API documentation which is up-to-date with the
1104 Subversion version of the source code.
1105 You can access versions of these documents specific to this release by going
1106 into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
1107
1108 <p>If you have any questions or comments about LLVM, please feel free to contact
1109 us via the <a href="http://llvm.org/docs/#maillist"> mailing
1110 lists</a>.</p>
1111
1112 </div>
1113
1114 <!-- *********************************************************************** -->
1115
1116 <hr>
1117 <address>
1118   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
1119   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
1120   <a href="http://validator.w3.org/check/referer"><img
1121   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
1122
1123   <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
1124   Last modified: $Date$
1125 </address>
1126
1127 </body>
1128 </html>