c4b7185c8964a955a6acef72e26fc03c85e17361
[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" 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 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.8
33 release.<br>
34 You may prefer the
35 <a href="http://llvm.org/releases/2.6/docs/ReleaseNotes.html">LLVM 2.7
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 </div>
64  
65
66 <!--
67 Almost dead code.
68   include/llvm/Analysis/LiveValues.h => Dan
69   lib/Transforms/IPO/MergeFunctions.cpp => consider for 2.8.
70   llvm/Analysis/PointerTracking.h => Edwin wants this, consider for 2.8.
71   ABCD, GEPSplitterPass
72   MSIL backend?
73   lib/Transforms/Utils/SSI.cpp  -> ABCD depends on it.
74 -->
75  
76    
77 <!-- Features that need text if they're finished for 2.7:
78   combiner-aa?
79   strong phi elim
80   llvm.dbg.value: variable debug info for optimized code
81   loop dependence analysis
82  -->
83
84  <!-- for announcement email:
85  Logo web page.
86  llvm devmtg
87  compiler_rt
88  KLEE web page at klee.llvm.org
89  Many new papers added to /pubs/
90  Mention gcc plugin.
91    -->
92
93 <!-- *********************************************************************** -->
94 <div class="doc_section">
95   <a name="subproj">Sub-project Status Update</a>
96 </div>
97 <!-- *********************************************************************** -->
98
99 <div class="doc_text">
100 <p>
101 The LLVM 2.7 distribution currently consists of code from the core LLVM
102 repository (which roughly includes the LLVM optimizers, code generators
103 and supporting tools), the Clang repository and the llvm-gcc repository.  In
104 addition to this code, the LLVM Project includes other sub-projects that are in
105 development.  Here we include updates on these subprojects.
106 </p>
107
108 </div>
109
110
111 <!--=========================================================================-->
112 <div class="doc_subsection">
113 <a name="clang">Clang: C/C++/Objective-C Frontend Toolkit</a>
114 </div>
115
116 <div class="doc_text">
117
118 <p>The <a href="http://clang.llvm.org/">Clang project</a> is ...</p>
119
120 <p>In the LLVM 2.7 time-frame, the Clang team has made many improvements:</p>
121
122 <ul>
123 <li>FIXME: C++! Include a link to cxx_compatibility.html</li>
124
125 <li>CIndex API and Python bindings: Clang now includes a C API as part of the
126 CIndex library. Although we make make some changes to the API in the future, it
127 is intended to be stable and has been designed for use by external projects. See
128 the Clang
129 doxygen <a href="http://clang.llvm.org/doxygen/group__CINDEX.html">CIndex</a>
130 documentation for more details. The CIndex API also includings an preliminary
131 set of Python bindings.</li>
132
133 <li>ARM Support: Clang now has ABI support for both the Darwin and Linux ARM
134 ABIs. Coupled with many improvements to the LLVM ARM backend, Clang is now
135 suitable for use as a a beta quality ARM compiler.</li>
136 </ul>
137 </div>
138
139 <!--=========================================================================-->
140 <div class="doc_subsection">
141 <a name="clangsa">Clang Static Analyzer</a>
142 </div>
143
144 <div class="doc_text">
145
146 <p>The <a href="http://clang-analyzer.llvm.org/">Clang Static Analyzer</a>
147    project is an effort to use static source code analysis techniques to
148    automatically find bugs in C and Objective-C programs (and hopefully <a
149    href="http://clang-analyzer.llvm.org/dev_cxx.html">C++ in the
150    future</a>!).  The tool is very good at finding bugs that occur on specific
151    paths through code, such as on error conditions.</p>
152
153 <p>In the LLVM 2.7 time-frame, the analyzer core has made several major and 
154    minor improvements, including better support for tracking the fields of
155    structures, initial support (not enabled by default yet) for doing
156    interprocedural (cross-function) analysis, and new checks have been added.
157 </p>
158
159 </div>
160
161 <!--=========================================================================-->
162 <div class="doc_subsection">
163 <a name="vmkit">VMKit: JVM/CLI Virtual Machine Implementation</a>
164 </div>
165
166 <div class="doc_text">
167 <p>
168 The <a href="http://vmkit.llvm.org/">VMKit project</a> is an implementation of
169 a JVM and a CLI Virtual Machine (Microsoft .NET is an
170 implementation of the CLI) using LLVM for static and just-in-time
171 compilation.</p>
172
173 <p>
174 With the release of LLVM 2.7, VMKit has shifted to a great framework for writing
175 virtual machines. VMKit now offers precise and efficient garbage collection with
176 multi-threading support, thanks to the MMTk memory management toolkit, as well
177 as just in time and ahead of time compilation with LLVM.  The major changes in
178 VMKit 0.27 are:</p>
179
180 <ul>
181
182 <li>Garbage collection: VMKit now uses the MMTk toolkit for garbage collectors.
183   The first collector to be ported is the MarkSweep collector, which is precise,
184   and drastically improves the performance of VMKit.</li>
185 <li>Line number information in the JVM: by using the debug metadata of LLVM, the
186  JVM now supports precise line number information, useful when printing a stack
187  trace.</li>
188 <li>Interface calls in the JVM: we implemented a variant of the Interface Method
189   Table technique for interface calls in the JVM.
190 </li>
191
192 </ul>
193 </div>
194
195
196 <!--=========================================================================-->
197 <div class="doc_subsection">
198 <a name="compiler-rt">compiler-rt: Compiler Runtime Library</a>
199 </div>
200
201 <div class="doc_text">
202 <p>
203 The new LLVM <a href="http://compiler-rt.llvm.org/">compiler-rt project</a>
204 is a simple library that provides an implementation of the low-level
205 target-specific hooks required by code generation and other runtime components.
206 For example, when compiling for a 32-bit target, converting a double to a 64-bit
207 unsigned integer is compiled into a runtime call to the "__fixunsdfdi"
208 function. The compiler-rt library provides highly optimized implementations of
209 this and other low-level routines (some are 3x faster than the equivalent
210 libgcc routines).</p>
211
212 <p>
213 All of the code in the compiler-rt project is available under the standard LLVM
214 License, a "BSD-style" license.  New in LLVM 2.7: compiler_rt now
215 supports ARM targets.</p>
216
217 </div>
218
219 <!--=========================================================================-->
220 <div class="doc_subsection">
221 <a name="dragonegg">DragonEgg: llvm-gcc ported to gcc-4.5</a>
222 </div>
223
224 <div class="doc_text">
225 <p>
226 <a href="http://dragonegg.llvm.org/">DragonEgg</a> is a port of llvm-gcc to
227 gcc-4.5.  Unlike llvm-gcc, which makes many intrusive changes to the underlying
228 gcc-4.2 code, dragonegg in theory does not require any gcc-4.5 modifications
229 whatsoever (currently one small patch is needed).  This is thanks to the new
230 <a href="http://gcc.gnu.org/wiki/plugins">gcc plugin architecture</a>, which
231 makes it possible to modify the behaviour of gcc at runtime by loading a plugin,
232 which is nothing more than a dynamic library which conforms to the gcc plugin
233 interface.  DragonEgg is a gcc plugin that causes the LLVM optimizers to be run
234 instead of the gcc optimizers, and the LLVM code generators instead of the gcc
235 code generators, just like llvm-gcc.  To use it, you add
236 "-fplugin=path/dragonegg.so" to the gcc-4.5 command line, and gcc-4.5 magically
237 becomes llvm-gcc-4.5!
238 </p>
239
240 <p>
241 DragonEgg is still a work in progress.  Currently C works very well, while C++,
242 Ada and Fortran work fairly well.  All other languages either don't work at all,
243 or only work poorly.  For the moment only the x86-32 and x86-64 targets are
244 supported, and only on linux and darwin (darwin needs an additional gcc patch).
245 </p>
246
247 <p>
248 DragonEgg is a new project which is seeing its first release with llvm-2.7.
249 </p>
250
251 </div>
252
253
254 <!--=========================================================================-->
255 <div class="doc_subsection">
256 <a name="mc">llvm-mc: Machine Code Toolkit</a>
257 </div>
258
259 <div class="doc_text">
260 <p>
261 The LLVM Machine Code (aka MC) sub-project of LLVM was created to solve a number
262 of problems in the realm of assembly, disassembly, object file format handling,
263 and a number of other related areas that CPU instruction-set level tools work
264 in. It is a sub-project of LLVM which provides it with a number of advantages
265 over other compilers that do not have tightly integrated assembly-level tools.
266 For a gentle introduction, please see the <a
267 href="http://blog.llvm.org/2010/04/intro-to-llvm-mc-project.html">Intro to the
268 LLVM MC Project Blog Post</a>.
269 </p>
270
271 <p>2.7 includes major parts of the work required by the new MC Project.  A few
272    targets have been refactored to support it, and work is underway to support a
273    native assembler in LLVM.  This work is not complete in LLVM 2.7, but you has
274    made substantially more progress on LLVM mainline.</p>
275
276 <p>One minor example of what MC can do is to transcode an AT&amp;T syntax
277    X86 .s file into intel syntax.  You can do this with something like:</p>
278 <pre>
279   llvm-mc foo.s -output-asm-variant=1 -o foo-intel.s
280 </pre>
281
282 </div>  
283
284
285 <!-- *********************************************************************** -->
286 <div class="doc_section">
287   <a name="externalproj">External Open Source Projects Using LLVM 2.7</a>
288 </div>
289 <!-- *********************************************************************** -->
290
291 <div class="doc_text">
292
293 <p>An exciting aspect of LLVM is that it is used as an enabling technology for
294    a lot of other language and tools projects.  This section lists some of the
295    projects that have already been updated to work with LLVM 2.7.</p>
296 </div>
297
298 <!--=========================================================================-->
299 <div class="doc_subsection">
300 <a name="pure">Pure</a>
301 </div>
302
303 <div class="doc_text">
304 <p>
305 <a href="http://pure-lang.googlecode.com/">Pure</a>
306 is an algebraic/functional programming language based on term rewriting.
307 Programs are collections of equations which are used to evaluate expressions in
308 a symbolic fashion. Pure offers dynamic typing, eager and lazy evaluation,
309 lexical closures, a hygienic macro system (also based on term rewriting),
310 built-in list and matrix support (including list and matrix comprehensions) and
311 an easy-to-use C interface. The interpreter uses LLVM as a backend to
312  JIT-compile Pure programs to fast native code.</p>
313
314 <p>Pure versions 0.43 and later have been tested and are known to work with
315 LLVM 2.7 (and continue to work with older LLVM releases >= 2.5).</p>
316
317 </div>
318
319 <!--=========================================================================-->
320 <div class="doc_subsection">
321 <a name="RoadsendPHP">Roadsend PHP</a>
322 </div>
323
324 <div class="doc_text">
325 <p>
326 <a href="http://code.roadsend.com/rphp">Roadsend PHP</a> (rphp) is an open
327 source implementation of the PHP programming 
328 language that uses LLVM for its optimizer, JIT and static compiler. This is a 
329 reimplementation of an earlier project that is now based on LLVM.
330 </p>
331 </div>
332
333 <!--=========================================================================-->
334 <div class="doc_subsection">
335 <a name="UnladenSwallow">Unladen Swallow</a>
336 </div>
337
338 <div class="doc_text">
339 <p>
340 <a href="http://code.google.com/p/unladen-swallow/">Unladen Swallow</a> is a
341 branch of <a href="http://python.org/">Python</a> intended to be fully
342 compatible and significantly faster.  It uses LLVM's optimization passes and JIT
343 compiler.
344 </p>
345 </div>
346
347 <!--=========================================================================-->
348 <div class="doc_subsection">
349 <a name="tce">TTA-based Codesign Environment (TCE)</a>
350 </div>
351
352 <div class="doc_text">
353 <p>
354 <a href="http://tce.cs.tut.fi/">TCE</a> is a toolset for designing
355 application-specific processors (ASP) based on the Transport triggered
356 architecture (TTA). The toolset provides a complete co-design flow from C/C++
357 programs down to synthesizable VHDL and parallel program binaries. Processor
358 customization points include the register files, function units, supported
359 operations, and the interconnection network.</p>
360
361 <p>TCE uses llvm-gcc/Clang and LLVM for C/C++ language support, target
362 independent optimizations and also for parts of code generation. It generates
363 new LLVM-based code generators "on the fly" for the designed TTA processors and
364 loads them in to the compiler backend as runtime libraries to avoid per-target
365 recompilation of larger parts of the compiler chain.</p>
366
367 </div>
368
369 <!--=========================================================================-->
370 <div class="doc_subsection">
371 <a name="safecode">SAFECode Compiler</a>
372 </div>
373
374 <div class="doc_text">
375 <p>
376 <a href="http://safecode.cs.illinois.edu">SAFECode</a> is a memory safe C
377 compiler built using LLVM.  It takes standard, unannotated C code, analyzes the
378 code to ensure that memory accesses and array indexing operations are safe, and
379 instruments the code with run-time checks when safety cannot be proven
380 statically.
381 </p>
382 </div>
383
384
385 <!-- *********************************************************************** -->
386 <div class="doc_section">
387   <a name="whatsnew">What's New in LLVM 2.7?</a>
388 </div>
389 <!-- *********************************************************************** -->
390
391 <div class="doc_text">
392
393 <p>This release includes a huge number of bug fixes, performance tweaks and
394 minor improvements.  Some of the major improvements and new features are listed
395 in this section.
396 </p>
397
398 </div>
399
400 <!--=========================================================================-->
401 <div class="doc_subsection">
402 <a name="orgchanges">LLVM Community Changes</a>
403 </div>
404
405 <div class="doc_text">
406
407 <p>In addition to changes to the code, between LLVM 2.6 and 2.7, a number of
408 organization changes have happened:
409 </p>
410
411 <ul>
412 <li>LLVM has a new <a href="http://llvm.org/Logo.html">official logo</a>!</li>
413
414 <li>Ted Kremenek and Doug Gregor have stepped forward as <a
415  href="http://llvm.org/docs/DeveloperPolicy.html#owners">Code Owners</a> of the
416  Clang static analyzer and the Clang frontend, respectively.</li>
417
418 <li>LLVM now has an <a href="http://blog.llvm.org">official Blog</a> at
419     <a href="http://blog.llvm.org">http://blog.llvm.org</a>. This is a great way
420     to learn about new LLVM-related features as they are implemented.  Several
421     features in this release are already explained on the blog.</li>
422
423 <li>The LLVM web pages are now checked into the SVN server, in the "www",
424     "www-pubs" and "www-releases" SVN modules.  Previously they were hidden in a
425     largely inaccessible old CVS server.</li>
426
427 <li><a href="http://llvm.org">llvm.org</a> is now hosted on a new (and much
428     faster) server.  It is still graciously hosted at the University of Illinois
429     of Urbana Champaign.</li>
430 </ul>
431 </div>
432
433 <!--=========================================================================-->
434 <div class="doc_subsection">
435 <a name="majorfeatures">Major New Features</a>
436 </div>
437
438 <div class="doc_text">
439
440 <p>LLVM 2.7 includes several major new capabilities:</p>
441
442 <ul>
443 <li>2.7 includes initial support for the <a
444   href="http://en.wikipedia.org/wiki/MicroBlaze">MicroBlaze</a> target.
445   MicroBlaze is a soft processor core designed for Xilinx FPGAs.</li>
446
447 <li>2.7 includes a new LLVM IR "extensible metadata" feature.  This feature
448  supports many different use cases, including allowing front-end authors to
449  encode source level information into LLVM IR, which is consumed by later
450  language-specific passes.  This is a great way to do high-level optimizations
451  like devirtualization, type-based alias analysis, etc.  See the <a 
452  href="http://blog.llvm.org/2010/04/extensible-metadata-in-llvm-ir.html">
453  Extensible Metadata Blog Post</a> for more information.</li>
454  
455 <li>2.7 encodes <a href="SourceLevelDebugging.html">debug information</a>
456 in a completely new way, built on extensible metadata.  The new implementation
457 is much more memory efficient and paves the way for improvements to optimized
458 code debugging experience.</li>
459
460 <li>2.7 now directly supports taking the address of a label and doing an
461     indirect branch through a pointer.  This is particularly useful for
462     interpreter loops, and is used to implement the GCC "address of label"
463     extension.  For more information, see the <a 
464 href="http://blog.llvm.org/2010/01/address-of-label-and-indirect-branches.html">
465 Address of Label and Indirect Branches in LLVM IR Blog Post</a>.
466
467 <li>2.7 is the first release to start supporting APIs for assembling and
468     disassembling target machine code.  These APIs are useful for a variety of
469     low level clients, and are surfaced in the new "enhanced disassembly" API.
470     For more information see the <a 
471     href="http://blog.llvm.org/2010/01/x86-disassembler.html">The X86
472     Disassembler Blog Post</a> for more information.</li>
473
474 <li>2.7 includes major parts of the work required by the new MC Project, 
475     see the <a href="#mc">MC update above</a> for more information.</li>
476
477 </ul>
478
479 </div>
480
481 <!--=========================================================================-->
482 <div class="doc_subsection">
483 <a name="coreimprovements">LLVM IR and Core Improvements</a>
484 </div>
485
486 <div class="doc_text">
487 <p>LLVM IR has several new features for better support of new targets and that
488 expose new optimization opportunities:</p>
489
490 <ul>
491 <li>LLVM IR now supports a 16-bit "half float" data type through <a
492    href="LangRef.html#int_fp16">two new intrinsics</a> and APFloat support.</li>
493 <li>LLVM IR supports two new <a href="LangRef.html#fnattrs">function
494     attributes</a>: inlinehint and alignstack(n).  The former is a hint to the
495     optimizer that a function was declared 'inline' and thus the inliner should
496     weight it higher when considering inlining it.  The later
497     indicates to the code generator that the function diverges from the platform
498     ABI on stack alignment.</li>
499 <li>The new <a href="LangRef.html#int_objectsize">llvm.objectsize</a> intrinsic
500     allows the optimizer to infer the sizes of memory objects in some cases.
501     This intrinsic is used to implement the GCC <tt>__builtin_object_size</tt>
502     extension.</li>
503 <li>LLVM IR now supports marking load and store instructions with <a
504     href="LangRef.html#i_load">"non-temporal" hints</a> (building on the new
505     metadata feature).  This hint encourages the code
506     generator to generate non-temporal accesses when possible, which are useful
507     for code that is carefully managing cache behavior.  Currently, only the
508     X86 backend provides target support for this feature.</li>
509
510 <li>LLVM 2.7 has pre-alpha support for <a
511   href="LangRef.html#t_union">unions in LLVM IR</a>.
512   Unfortunately, this support is not really usable in 2.7, so if you're
513  interested in pushing it forward, please help contribute to LLVM mainline.</li>
514
515 </ul>
516
517 </div>
518
519 <!--=========================================================================-->
520 <div class="doc_subsection">
521 <a name="optimizer">Optimizer Improvements</a>
522 </div>
523
524 <div class="doc_text">
525
526 <p>In addition to a large array of minor performance tweaks and bug fixes, this
527 release includes a few major enhancements and additions to the optimizers:</p>
528
529 <ul>
530
531 <li>The inliner reuses now merges arrays stack objects in different callees when
532     inlining multiple call sites into one function.  This reduces the stack size
533     of the resultant function.</li>
534 <li>The -basicaa alias analysis pass (which is the default) has been improved to
535     be less dependent on "type safe" pointers.  It can now look through bitcasts
536     and other constructs more aggressively, allowing better load/store
537     optimization.</li>
538 <li>The load elimination optimization in the GVN Pass [<a
539 href="http://blog.llvm.org/2009/12/introduction-to-load-elimination-in-gvn.html">intro
540  blog post</a>] has been substantially improved to be more aggressive about
541  partial redundancy elimination and do more aggressive phi translation.  Please
542  see the <a
543  href="http://blog.llvm.org/2009/12/advanced-topics-in-redundant-load.html">
544  Advanced Topics in Redundant Load Elimination with a Focus on PHI Translation
545  Blog Post</a> for more details.</li>
546 <li>The module <a href="LangRef.html#datalayout">target data string</a> now
547     includes a notion of what the 'native' integer data types a for the target,
548     which allows various optimizations to use.  This helps mid-level
549     optimizations avoid promoting complex sequences of operations to data types
550     that are not natively supported (e.g. converting i32 operations to i64 on
551     a 32-bit chip).</li>
552 <li>The mid-level optimizer is now conservative when operating on a module with
553     no target data.  Previously, it would default to SparcV9 settings, which is
554     not what most people expected.</li>
555 <li>Jump threading is now much more aggressive at simplifying correlated
556    conditionals and threading blocks with otherwise complex logic. It has
557    subsumed the old "Conditional Propagation" pass, and -condprop has been
558    removed from LLVM 2.7.</li>
559 <li>The -instcombine pass has been refactored from being one huge file to being
560     a library of its own.  Internally, it uses a customized IRBuilder to clean
561     it up and simplify it.</li>
562
563 <li>The optimal edge profiling pass is reliable and much more complete than in
564     2.6.  It can be used with the llvm-prof tool but isn't wired up to the
565     llvm-gcc and clang command line options yet.</li>
566
567 <li>A new experimental alias analysis implementation, -scev-aa, has been added.
568     It uses LLVM's Scalar Evolution implementation to do symbolic analysis of
569     pointer offset expressions to disambiguate pointers.  It can catch a few
570     cases that basicaa cannot, particularly in complex loop nests.</li>
571
572 <li>The default pass ordering has been tweaked for improved optimization
573     effectiveness.</li>
574
575 </ul>
576
577 </div>
578
579
580 <!--=========================================================================-->
581 <div class="doc_subsection">
582 <a name="executionengine">Interpreter and JIT Improvements</a>
583 </div>
584
585 <div class="doc_text">
586
587 <ul>
588 <li>The JIT now supports generating debug information, which is compatible with
589 the new GDB 7.0 (and later) interfaces for registering debug info for
590 dynamically generated code.</li>
591
592 <li>The JIT now <a href="http://llvm.org/PR5184">defaults
593 to compiling eagerly</a> to avoid a race condition in the lazy JIT.
594 Clients that still want the lazy JIT can switch it on by calling
595 <tt>ExecutionEngine::DisableLazyCompilation(false)</tt>.</li>
596
597 <li>It is now possible to create more than one JIT instance in the same process.
598 These JITs can generate machine code in parallel,
599 although <a href="http://llvm.org/docs/ProgrammersManual.html#jitthreading">you
600 still have to obey the other threading restrictions</a>.</li>
601
602 </ul>
603
604 </div>
605
606 <!--=========================================================================-->
607 <div class="doc_subsection">
608 <a name="codegen">Target Independent Code Generator Improvements</a>
609 </div>
610
611 <div class="doc_text">
612
613 <p>We have put a significant amount of work into the code generator
614 infrastructure, which allows us to implement more aggressive algorithms and make
615 it run faster:</p>
616
617 <ul>
618 <li>The 'llc -asm-verbose' option (which is now the default) has been enhanced
619     to emit many useful comments to .s files indicating information about spill
620     slots and loop nest structure.  This should make it much easier to read and
621     understand assembly files.  This is wired up in llvm-gcc and clang to
622     the <tt>-fverbose-asm</tt> option.</li>
623
624 <li>New LSR with "full strength reduction" mode.  FIXME: Description?</li>
625
626 <li>A new codegen level Common Subexpression Elimination pass (MachineCSE)
627     is available and enabled by default.  It catches redundancies exposed by
628     lowering.</li>
629 <li>A new pre-register-allocation tail duplication pass is available and enabled
630     by default, it can substantially improve branch prediction quality in some
631     cases.</li>
632 <li>A new sign and zero extension optimization pass (OptimizeExtsPass) 
633     is available and enabled by default.  This pass can takes advantage
634     architecture features like x86-64 implicit zero extension behavior and
635     sub-registers.</li>
636 <li>The code generator now supports a mode where it attempts to preserve the
637     order of instructions in the input code.  This is important for source that
638     is hand scheduled and extremely sensitive to scheduling.  It is compatible
639     with the GCC <tt>-fno-schedule-insns</tt> option.</li>
640 <li>The target-independent code generator now supports generating code with
641     arbitrary numbers of result values.  Returning more values than was
642     previously supported is handled by returning through a hidden pointer.  In
643     2.7, only the X86 and XCore targets have adopted support for this
644     though.</li>
645 <li>The code generator now supports generating code that follows the
646     <a href="LangRef.html#callingconv">Glasgow Haskell Compiler Calling
647     Convention</a> and ABI.</li>
648 <li>The "<a href="CodeGenerator.html#selectiondag_select">DAG instruction
649     selection</a>" phase of the code generator has been largely rewritten for
650     2.7.  Previously, tblgen spit out tons of C++ code which was compiled and
651     linked into the target to do the pattern matching, now it emits a much
652     smaller table which is read by the target-independent code.  The primary
653     advantages of this approach is that the size and compile time of various
654     targets is much improved.  The X86 code generator shrunk by 1.5MB of code,
655     for example.</li>
656 <li>Almost the entire code generator has switched to emitting code through the
657     MC interfaces instead of printing textually to the .s file.  This led to a
658     number of cleanups and speedups.  In 2.7, debug an exception handling
659     information does not go through MC yet.</li>
660 </ul>
661 </div>
662
663 <!--=========================================================================-->
664 <div class="doc_subsection">
665 <a name="x86">X86-32 and X86-64 Target Improvements</a>
666 </div>
667
668 <div class="doc_text">
669 <p>New features of the X86 target include:
670 </p>
671
672 <ul>
673 <li>The X86 backend now optimizes tails calls much more aggressively for
674     functions that use the standard C calling convention.</li>
675 <li>The X86 backend now models scalar SSE registers as subregs of the SSE vector
676     registers, making the code generator more aggressive in cases where scalars
677     and vector types are mixed.</li>
678
679 <li>PostRA scheduler for X86? FIXME: is this on by default in 2.7?</li>
680
681 </ul>
682
683 </div>
684
685 <!--=========================================================================-->
686 <div class="doc_subsection">
687 <a name="ARM">ARM Target Improvements</a>
688 </div>
689
690 <div class="doc_text">
691 <p>New features of the ARM target include:
692 </p>
693
694 <ul>
695
696 <li>The ARM backend now generates instructions in unified assembly syntax.</li>
697
698 <li>llvm-gcc now has complete support for the ARM v7 NEON instruction set.  This
699    support differs slightly from the GCC implementation.  Please see the
700    <a
701 href="http://blog.llvm.org/2010/04/arm-advanced-simd-neon-intrinsics-and.html">
702   ARM Advanced SIMD (NEON) Intrinsics and Types in LLVM Blog Post</a> for
703   helpful information if migrating code from GCC to LLVM-GCC.</li>
704   
705 <li>The ARM and Thumb code generators now using register scavenging for stack
706     object address materialization.(FIXME: WHAT BENEFIT DOES THIS PROVIDE?)</li>
707     
708 <li>The ARM backend now has good support for ARMv4 targets, and has been tested
709     on StrongARM hardware.  Previously, LLVM only supported ARMv4T and
710     newer chips.</li>
711 </ul>
712
713
714 </div>
715
716 <!--=========================================================================-->
717 <div class="doc_subsection">
718 <a name="newapis">New Useful APIs</a>
719 </div>
720
721 <div class="doc_text">
722
723 <p>This release includes a number of new APIs that are used internally, which
724    may also be useful for external clients.
725 </p>
726
727 <ul>
728 <li>The optimizer uses the new CodeMetrics class to measure the size of code.
729     Various passes that use thing (like the inliner, loop unswitcher, etc) all
730     use this to make more accurate estimates of the code size impact of various
731     optimizations.</li>
732 <li>A new <a href="http://llvm.org/doxygen/InstructionSimplify_8h-source.html">
733     llvm/Analysis/InstructionSimplify.h</a> interface available for doing
734     symbolic simplification of instructions (e.g. <tt>a+0</tt> -&gt; <tt>a</tt>)
735     without requiring the instruction to exist.  This centralizes a lot of
736     ad-hoc symbolic manipulation code scattered in various passes.</li>
737 <li>The optimizer now uses a new <a
738     href="http://llvm.org/doxygen/SSAUpdater_8h-source.html">SSAUpdater</a>
739     class which efficiently supports
740     doing unstructured SSA update operations.  This centralized a bunch of code
741     scattered through various passes (e.g. jump threading, lcssa, loop rotate,
742     etc) for doing this sort of thing.  The code generator has an similar
743     <a href="http://llvm.org/doxygen/MachineSSAUpdater_8h-source.html">
744     MachineSSAUpdater</a> class.</li>
745 <li>The <a href="http://llvm.org/doxygen/Regex_8h-source.html">
746     llvm/Support/Regex.h</a> header exposes a platform independent regular
747     expression API.  Building on this, the <a
748     href="TestingGuide.html#FileCheck">FileCheck</a> utility now supports
749     regular exressions.</li>
750 <li>raw_ostream now supports a circular "debug stream" accessed with "dbgs()".
751     By default, this stream works the same way as "errs()", but if you pass
752     <tt>-debug-buffer-size=1000</tt> to opt, the debug stream is capped to a
753     fixed sized circular buffer and the output is printed at the end of the
754     program's execution.  This is helpful if you have a long lived compiler
755     process and you're interested in seeing snapshots in time.</li>
756 </ul>
757
758
759 </div>
760
761 <!--=========================================================================-->
762 <div class="doc_subsection">
763 <a name="otherimprovements">Other Improvements and New Features</a>
764 </div>
765
766 <div class="doc_text">
767 <p>Other miscellaneous features include:</p>
768
769 <ul>
770 <li>You can now build LLVM as a big dynamic library (e.g. "libllvm2.7.so"). To
771     get this, configure LLVM with the --enable-shared option.</li>
772
773 <li>LLVM command line tools now overwrite their output by default, before they
774     would only do this with -f. This makes them more convenient to use, and
775     behave more like standard unix tools.</li>
776
777 <li>The opt and llc tools now autodetect whether their input is a .ll or .bc
778     file, and automatically do the right thing.  This means you don't need to
779     explicitly use the llvm-as tool for most things.</li>
780 </ul>
781
782 </div>
783
784
785 <!--=========================================================================-->
786 <div class="doc_subsection">
787 <a name="changes">Major Changes and Removed Features</a>
788 </div>
789
790 <div class="doc_text">
791
792 <p>If you're already an LLVM user or developer with out-of-tree changes based
793 on LLVM 2.6, this section lists some "gotchas" that you may run into upgrading
794 from the previous release.</p>
795
796 <ul>
797
798 <li>
799 The Andersen's alias analysis ("anders-aa") pass, the Predicate Simplifier
800 ("predsimplify") pass, the LoopVR pass, the GVNPRE pass, and the random sampling
801 profiling ("rsprofiling") passes have all been removed.  They were not being
802 actively maintained and had substantial problems.  If you are interested in
803 these components, you are welcome to ressurect them from SVN, fix the
804 correctness problems, and resubmit them to mainline.</li>
805
806 <li>LLVM now defaults to building most libraries with RTTI turned off, providing
807 a code size reduction.  Packagers who are interested in building LLVM to support
808 plugins that require RTTI information should build with "make REQUIRE_RTTI=1"
809 and should read the new <a href="Packaging.html">Advice on Packaging LLVM</a>
810 document.</li>
811
812 <li>The LLVM interpreter now defaults to <em>not</em> using <tt>libffi</tt> even
813 if you have it installed.  This makes it more likely that an LLVM built on one
814 system will work when copied to a similar system.  To use <tt>libffi</tt>,
815 configure with <tt>--enable-libffi</tt>.</li>
816
817 <li>Debug information uses a completely different representation, an LLVM 2.6
818 .bc file should work with LLVM 2.7, but debug info won't come forward.</li>
819
820 <li>The LLVM 2.6 (and earlier) "malloc" and "free" instructions got removed,
821     along with LowerAllocations pass.  Now you should just use a call to the
822     malloc and free functions in libc.  These calls are optimized as well as
823     the old instructions were.</li>
824 </ul>
825
826 <p>In addition, many APIs have changed in this release.  Some of the major LLVM
827 API changes are:</p>
828
829 <ul>
830 <li>Just about everything has been converted to use raw_ostream instead of
831     std::ostream.</li>
832 <li>llvm/ADT/iterator.h has been removed, just use &lt;iterator&gt;
833  instead.</li>
834 <li>The Streams.h file and "DOUT" got removed, use "DEBUG(errs() &lt;&lt; ...);"
835    instead.</li>
836 <li><tt>ModuleProvider</tt> has been <a
837 href="http://llvm.org/viewvc/llvm-project?view=rev&amp;revision=94686">removed</a>
838 and its methods moved to <tt>Module</tt> and <tt>GlobalValue</tt>.
839 Most clients can remove uses of <tt>ExistingModuleProvider</tt>,
840 replace <tt>getBitcodeModuleProvider</tt> with
841 <tt>getLazyBitcodeModule</tt>, and pass their <tt>Module</tt> to
842 functions that used to accept <tt>ModuleProvider</tt>.  Clients who
843 wrote their own <tt>ModuleProvider</tt>s will need to derive from
844 <tt>GVMaterializer</tt> instead and use
845 <tt>Module::setMaterializer</tt> to attach it to a
846 <tt>Module</tt>.</li>
847
848 <li><tt>GhostLinkage</tt> has given up the ghost.
849 <tt>GlobalValue</tt>s that have not yet been read from their backing
850 storage have the same linkage they will have after being read in.
851 Clients must replace calls to
852 <tt>GlobalValue::hasNotBeenReadFromBitcode</tt> with
853 <tt>GlobalValue::isMaterializable</tt>.</li>
854
855 <li>The <tt>llvm/Support/DataTypes.h</tt> header has moved
856 to <tt>llvm/System/DataTypes.h</tt>.</li>
857
858 <li>The <tt>isInteger</tt>, <tt>isIntOrIntVector</tt>, <tt>isFloatingPoint</tt>,
859 <tt>isFPOrFPVector</tt> and <tt>isFPOrFPVector</tt> methods have been renamed
860 <tt>isIntegerTy</tt>, <tt>isIntOrIntVectorTy</tt>, <tt>isFloatingPointTy</tt>, 
861 <tt>isFPOrFPVectorTy</tt> and <tt>isFPOrFPVectorTy</tt> respectively.</li>
862 </ul>
863
864 </div>
865
866
867
868 <!-- *********************************************************************** -->
869 <div class="doc_section">
870   <a name="portability">Portability and Supported Platforms</a>
871 </div>
872 <!-- *********************************************************************** -->
873
874 <div class="doc_text">
875
876 <p>LLVM is known to work on the following platforms:</p>
877
878 <ul>
879 <li>Intel and AMD machines (IA32, X86-64, AMD64, EMT-64) running Red Hat
880     Linux, Fedora Core, FreeBSD and AuroraUX (and probably other unix-like
881     systems).</li>
882 <li>PowerPC and X86-based Mac OS X systems, running 10.4 and above in 32-bit
883     and 64-bit modes.</li>
884 <li>Intel and AMD machines running on Win32 using MinGW libraries (native).</li>
885 <li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
886     support is available for native builds with Visual C++).</li>
887 <li>Sun x86 and AMD64 machines running Solaris 10, OpenSolaris 0906.</li>
888 <li>Alpha-based machines running Debian GNU/Linux.</li>
889 </ul>
890
891 <p>The core LLVM infrastructure uses GNU autoconf to adapt itself
892 to the machine and operating system on which it is built.  However, minor
893 porting may be required to get LLVM to work on new platforms.  We welcome your
894 portability patches and reports of successful builds or error messages.</p>
895
896 </div>
897
898 <!-- *********************************************************************** -->
899 <div class="doc_section">
900   <a name="knownproblems">Known Problems</a>
901 </div>
902 <!-- *********************************************************************** -->
903
904 <div class="doc_text">
905
906 <p>This section contains significant known problems with the LLVM system,
907 listed by component.  If you run into a problem, please check the <a
908 href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
909 there isn't already one.</p>
910
911 <ul>    
912 <li>LLVM will not correctly compile on Solaris and/or OpenSolaris
913 using the stock GCC 3.x.x series 'out the box',
914 See: <a href="GettingStarted.html#brokengcc">Broken versions of GCC and other tools</a>.
915 However, A <a href="http://pkg.auroraux.org/GCC">Modern GCC Build</a>
916 for x86/x86-64 has been made available from the third party AuroraUX Project
917 that has been meticulously tested for bootstrapping LLVM &amp; Clang.</li>
918 </ul>
919
920 </div>
921
922 <!-- ======================================================================= -->
923 <div class="doc_subsection">
924   <a name="experimental">Experimental features included with this release</a>
925 </div>
926
927 <div class="doc_text">
928
929 <p>The following components of this LLVM release are either untested, known to
930 be broken or unreliable, or are in early development.  These components should
931 not be relied on, and bugs should not be filed against them, but they may be
932 useful to some people.  In particular, if you would like to work on one of these
933 components, please contact us on the <a
934 href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p>
935
936 <ul>
937 <li>The MSIL, Alpha, SPU, MIPS, PIC16, Blackfin, MSP430, SystemZ and MicroBlaze
938     backends are experimental.</li>
939 <li><tt>llc</tt> "<tt>-filetype=asm</tt>" (the default) is the only
940     supported value for this option.  The MachO writer is experimental, and
941     works much better in mainline SVN.</li>
942 </ul>
943
944 </div>
945
946 <!-- ======================================================================= -->
947 <div class="doc_subsection">
948   <a name="x86-be">Known problems with the X86 back-end</a>
949 </div>
950
951 <div class="doc_text">
952
953 <ul>
954   <li>The X86 backend does not yet support
955     all <a href="http://llvm.org/PR879">inline assembly that uses the X86
956     floating point stack</a>.  It supports the 'f' and 't' constraints, but not
957     'u'.</li>
958   <li>The X86 backend generates inefficient floating point code when configured
959     to generate code for systems that don't have SSE2.</li>
960   <li>Win64 code generation wasn't widely tested. Everything should work, but we
961     expect small issues to happen. Also, llvm-gcc cannot build the mingw64
962     runtime currently due to lack of support for the 'u' inline assembly
963     constraint and for X87 floating point inline assembly.</li>
964   <li>The X86-64 backend does not yet support the LLVM IR instruction
965       <tt>va_arg</tt>. Currently, front-ends support variadic
966       argument constructs on X86-64 by lowering them manually.</li>
967 </ul>
968
969 </div>
970
971 <!-- ======================================================================= -->
972 <div class="doc_subsection">
973   <a name="ppc-be">Known problems with the PowerPC back-end</a>
974 </div>
975
976 <div class="doc_text">
977
978 <ul>
979 <li>The Linux PPC32/ABI support needs testing for the interpreter and static
980 compilation, and lacks support for debug information.</li>
981 </ul>
982
983 </div>
984
985 <!-- ======================================================================= -->
986 <div class="doc_subsection">
987   <a name="arm-be">Known problems with the ARM back-end</a>
988 </div>
989
990 <div class="doc_text">
991
992 <ul>
993 <li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
994 processors, thumb programs can crash or produce wrong
995 results (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
996 <li>Compilation for ARM Linux OABI (old ABI) is supported but not fully tested.
997 </li>
998 </ul>
999
1000 </div>
1001
1002 <!-- ======================================================================= -->
1003 <div class="doc_subsection">
1004   <a name="sparc-be">Known problems with the SPARC back-end</a>
1005 </div>
1006
1007 <div class="doc_text">
1008
1009 <ul>
1010 <li>The SPARC backend only supports the 32-bit SPARC ABI (-m32); it does not
1011     support the 64-bit SPARC ABI (-m64).</li>
1012 </ul>
1013
1014 </div>
1015
1016 <!-- ======================================================================= -->
1017 <div class="doc_subsection">
1018   <a name="mips-be">Known problems with the MIPS back-end</a>
1019 </div>
1020
1021 <div class="doc_text">
1022
1023 <ul>
1024 <li>64-bit MIPS targets are not supported yet.</li>
1025 </ul>
1026
1027 </div>
1028
1029 <!-- ======================================================================= -->
1030 <div class="doc_subsection">
1031   <a name="alpha-be">Known problems with the Alpha back-end</a>
1032 </div>
1033
1034 <div class="doc_text">
1035
1036 <ul>
1037
1038 <li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
1039 appropriate nops inserted to ensure restartability.</li>
1040
1041 </ul>
1042 </div>
1043
1044 <!-- ======================================================================= -->
1045 <div class="doc_subsection">
1046   <a name="c-be">Known problems with the C back-end</a>
1047 </div>
1048
1049 <div class="doc_text">
1050
1051 <ul>
1052 <li><a href="http://llvm.org/PR802">The C backend has only basic support for
1053     inline assembly code</a>.</li>
1054 <li><a href="http://llvm.org/PR1658">The C backend violates the ABI of common
1055     C++ programs</a>, preventing intermixing between C++ compiled by the CBE and
1056     C++ code compiled with <tt>llc</tt> or native compilers.</li>
1057 <li>The C backend does not support all exception handling constructs.</li>
1058 <li>The C backend does not support arbitrary precision integers.</li>
1059 </ul>
1060
1061 </div>
1062
1063
1064 <!-- ======================================================================= -->
1065 <div class="doc_subsection">
1066   <a name="c-fe">Known problems with the llvm-gcc C and C++ front-end</a>
1067 </div>
1068
1069 <div class="doc_text">
1070
1071 <p>The only major language feature of GCC not supported by llvm-gcc is
1072     the <tt>__builtin_apply</tt> family of builtins.   However, some extensions
1073     are only supported on some targets.  For example, trampolines are only
1074     supported on some targets (these are used when you take the address of a
1075     nested function).</p>
1076
1077 </div>
1078
1079 <!-- ======================================================================= -->
1080 <div class="doc_subsection">
1081   <a name="fortran-fe">Known problems with the llvm-gcc Fortran front-end</a>
1082 </div>
1083
1084 <div class="doc_text">
1085 <ul>
1086 <li>Fortran support generally works, but there are still several unresolved bugs
1087     in <a href="http://llvm.org/bugs/">Bugzilla</a>.  Please see the
1088     tools/gfortran component for details.</li>
1089 </ul>
1090 </div>
1091
1092 <!-- ======================================================================= -->
1093 <div class="doc_subsection">
1094   <a name="ada-fe">Known problems with the llvm-gcc Ada front-end</a>
1095 </div>
1096
1097 <div class="doc_text">
1098 The llvm-gcc 4.2 Ada compiler works fairly well; however, this is not a mature
1099 technology, and problems should be expected.
1100 <ul>
1101 <li>The Ada front-end currently only builds on X86-32.  This is mainly due
1102 to lack of trampoline support (pointers to nested functions) on other platforms.
1103 However, it <a href="http://llvm.org/PR2006">also fails to build on X86-64</a>
1104 which does support trampolines.</li>
1105 <li>The Ada front-end <a href="http://llvm.org/PR2007">fails to bootstrap</a>.
1106 This is due to lack of LLVM support for <tt>setjmp</tt>/<tt>longjmp</tt> style
1107 exception handling, which is used internally by the compiler.
1108 Workaround: configure with <tt>--disable-bootstrap</tt>.</li>
1109 <li>The c380004, <a href="http://llvm.org/PR2010">c393010</a>
1110 and <a href="http://llvm.org/PR2421">cxg2021</a> ACATS tests fail
1111 (c380004 also fails with gcc-4.2 mainline).
1112 If the compiler is built with checks disabled then <a href="http://llvm.org/PR2010">c393010</a>
1113 causes the compiler to go into an infinite loop, using up all system memory.</li>
1114 <li>Some GCC specific Ada tests continue to crash the compiler.</li>
1115 <li>The <tt>-E</tt> binder option (exception backtraces)
1116 <a href="http://llvm.org/PR1982">does not work</a> and will result in programs
1117 crashing if an exception is raised.  Workaround: do not use <tt>-E</tt>.</li>
1118 <li>Only discrete types <a href="http://llvm.org/PR1981">are allowed to start
1119 or finish at a non-byte offset</a> in a record.  Workaround: do not pack records
1120 or use representation clauses that result in a field of a non-discrete type
1121 starting or finishing in the middle of a byte.</li>
1122 <li>The <tt>lli</tt> interpreter <a href="http://llvm.org/PR2009">considers
1123 'main' as generated by the Ada binder to be invalid</a>.
1124 Workaround: hand edit the file to use pointers for <tt>argv</tt> and
1125 <tt>envp</tt> rather than integers.</li>
1126 <li>The <tt>-fstack-check</tt> option <a href="http://llvm.org/PR2008">is
1127 ignored</a>.</li>
1128 </ul>
1129 </div>
1130
1131 <!-- *********************************************************************** -->
1132 <div class="doc_section">
1133   <a name="additionalinfo">Additional Information</a>
1134 </div>
1135 <!-- *********************************************************************** -->
1136
1137 <div class="doc_text">
1138
1139 <p>A wide variety of additional information is available on the <a
1140 href="http://llvm.org">LLVM web page</a>, in particular in the <a
1141 href="http://llvm.org/docs/">documentation</a> section.  The web page also
1142 contains versions of the API documentation which is up-to-date with the
1143 Subversion version of the source code.
1144 You can access versions of these documents specific to this release by going
1145 into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
1146
1147 <p>If you have any questions or comments about LLVM, please feel free to contact
1148 us via the <a href="http://llvm.org/docs/#maillist"> mailing
1149 lists</a>.</p>
1150
1151 </div>
1152
1153 <!-- *********************************************************************** -->
1154
1155 <hr>
1156 <address>
1157   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
1158   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
1159   <a href="http://validator.w3.org/check/referer"><img
1160   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
1161
1162   <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
1163   Last modified: $Date$
1164 </address>
1165
1166 </body>
1167 </html>