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