9b1c5788ca7db8922e252f1a9d3b8885a79e1b71
[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   <meta encoding="utf8">
7   <link rel="stylesheet" href="llvm.css" type="text/css">
8   <title>LLVM 2.8 Release Notes</title>
9 </head>
10 <body>
11
12 <div class="doc_title">LLVM 2.8 Release Notes</div>
13
14 <img align=right src="http://llvm.org/img/DragonSmall.png"
15     width="136" height="136" alt="LLVM Dragon Logo">
16
17 <ol>
18   <li><a href="#intro">Introduction</a></li>
19   <li><a href="#subproj">Sub-project Status Update</a></li>
20   <li><a href="#externalproj">External Projects Using LLVM 2.8</a></li>
21   <li><a href="#whatsnew">What's New in LLVM 2.8?</a></li>
22   <li><a href="GettingStarted.html">Installation Instructions</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.7/docs/ReleaseNotes.html">LLVM 2.7
36 Release Notes</a>.</h1>
37 -->
38
39 <!-- *********************************************************************** -->
40 <div class="doc_section">
41   <a name="intro">Introduction</a>
42 </div>
43 <!-- *********************************************************************** -->
44
45 <div class="doc_text">
46
47 <p>This document contains the release notes for the LLVM Compiler
48 Infrastructure, release 2.8.  Here we describe the status of LLVM, including
49 major improvements from the previous release and significant known problems.
50 All LLVM releases may be downloaded from the <a
51 href="http://llvm.org/releases/">LLVM releases web site</a>.</p>
52
53 <p>For more information about LLVM, including information about the latest
54 release, please check out the <a href="http://llvm.org/">main LLVM
55 web site</a>.  If you have questions or comments, the <a
56 href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM Developer's
57 Mailing List</a> is a good place to send them.</p>
58
59 <p>Note that if you are reading this file from a Subversion checkout or the
60 main LLVM web page, this document applies to the <i>next</i> release, not the
61 current one.  To see the release notes for a specific release, please see the
62 <a href="http://llvm.org/releases/">releases page</a>.</p>
63
64 </div>
65  
66
67 <!--
68 Almost dead code.
69   include/llvm/Analysis/LiveValues.h => Dan
70   lib/Transforms/IPO/MergeFunctions.cpp => consider for 2.8.
71   GEPSplitterPass
72 -->
73  
74    
75 <!-- Features that need text if they're finished for 2.9:
76   combiner-aa?
77   strong phi elim
78   loop dependence analysis
79   TBAA
80   CorrelatedValuePropagation
81  -->
82  
83  <!-- Announcement, lldb, libc++ -->
84  
85
86 <!-- *********************************************************************** -->
87 <div class="doc_section">
88   <a name="subproj">Sub-project Status Update</a>
89 </div>
90 <!-- *********************************************************************** -->
91
92 <div class="doc_text">
93 <p>
94 The LLVM 2.8 distribution currently consists of code from the core LLVM
95 repository (which roughly includes the LLVM optimizers, code generators
96 and supporting tools), the Clang repository and the llvm-gcc repository.  In
97 addition to this code, the LLVM Project includes other sub-projects that are in
98 development.  Here we include updates on these subprojects.
99 </p>
100
101 </div>
102
103
104 <!--=========================================================================-->
105 <div class="doc_subsection">
106 <a name="clang">Clang: C/C++/Objective-C Frontend Toolkit</a>
107 </div>
108
109 <div class="doc_text">
110
111 <p><a href="http://clang.llvm.org/">Clang</a> is an LLVM front end for the C,
112 C++, and Objective-C languages. Clang aims to provide a better user experience
113 through expressive diagnostics, a high level of conformance to language
114 standards, fast compilation, and low memory use. Like LLVM, Clang provides a
115 modular, library-based architecture that makes it suitable for creating or
116 integrating with other development tools. Clang is considered a
117 production-quality compiler for C, Objective-C, C++ and Objective-C++ on x86
118 (32- and 64-bit), and for darwin-arm targets.</p>
119
120 <p>In the LLVM 2.8 time-frame, the Clang team has made many improvements:</p>
121
122 <ul>
123 <li>Surely these guys have done something</li>
124 <li>X86-64 abi improvements? Did they make it in?</li>
125 </ul>
126 </div>
127
128 <!--=========================================================================-->
129 <div class="doc_subsection">
130 <a name="clangsa">Clang Static Analyzer</a>
131 </div>
132
133 <div class="doc_text">
134
135 <p>The <a href="http://clang-analyzer.llvm.org/">Clang Static Analyzer</a>
136    project is an effort to use static source code analysis techniques to
137    automatically find bugs in C and Objective-C programs (and hopefully <a
138    href="http://clang-analyzer.llvm.org/dev_cxx.html">C++ in the
139    future</a>!).  The tool is very good at finding bugs that occur on specific
140    paths through code, such as on error conditions.</p>
141
142 <p>The LLVM 2.8 release fixes a number of bugs and slightly improves precision
143    over 2.7, but there are no major new features in the release. 
144 </p>
145
146 </div>
147
148 <!--=========================================================================-->
149 <div class="doc_subsection">
150 <a name="dragonegg">DragonEgg: llvm-gcc ported to gcc-4.5</a>
151 </div>
152
153 <div class="doc_text">
154 <p>
155 <a href="http://dragonegg.llvm.org/">DragonEgg</a> is a port of llvm-gcc to
156 gcc-4.5.  Unlike llvm-gcc, dragonegg in theory does not require any gcc-4.5
157 modifications whatsoever (currently one small patch is needed) thanks to the
158 new <a href="http://gcc.gnu.org/wiki/plugins">gcc plugin architecture</a>.
159 DragonEgg is a gcc plugin that makes gcc-4.5 use the LLVM optimizers and code
160 generators instead of gcc's, just like with llvm-gcc.
161 </p>
162
163 <p>
164 DragonEgg is still a work in progress, but it is able to compile a lot of code,
165 for example all of gcc, LLVM and clang.  Currently Ada, C, C++ and Fortran work
166 well, while all other languages either don't work at all or only work poorly.
167 For the moment only the x86-32 and x86-64 targets are supported, and only on
168 linux and darwin (darwin may need additional gcc patches).
169 </p>
170
171 <p>
172 The 2.8 release has the following notable changes:
173 <ul>
174 <li>The plugin loads faster due to exporting fewer symbols.</li>
175 <li>Additional vector operations such as addps256 are now supported.</li>
176 <li>Ada global variables with no initial value are no longer zero initialized,
177 resulting in better optimization.</li>
178 <li>The '-fplugin-arg-dragonegg-enable-gcc-optzns' flag now runs all gcc
179 optimizers, rather than just a handful.</li>
180 <li>Fortran programs using common variables now link correctly.</li>
181 <li>GNU OMP constructs no longer crash the compiler.</li>
182 </ul>
183 </p>
184
185 </div>
186
187 <!--=========================================================================-->
188 <div class="doc_subsection">
189 <a name="vmkit">VMKit: JVM/CLI Virtual Machine Implementation</a>
190 </div>
191
192 <div class="doc_text">
193 <p>
194 The <a href="http://vmkit.llvm.org/">VMKit project</a> is an implementation of
195 a Java Virtual Machine (Java VM or JVM) that uses LLVM for static and
196 just-in-time compilation.  As of LLVM 2.8, VMKit now supports copying garbage
197 collectors, and can be configured to use MMTk's copy mark-sweep garbage
198 collector.  In LLVM 2.8, the VMKit .NET VM is no longer being maintained.
199 </p>
200 </div>
201
202 <!--=========================================================================-->
203 <div class="doc_subsection">
204 <a name="compiler-rt">compiler-rt: Compiler Runtime Library</a>
205 </div>
206
207 <div class="doc_text">
208 <p>
209 The new LLVM <a href="http://compiler-rt.llvm.org/">compiler-rt project</a>
210 is a simple library that provides an implementation of the low-level
211 target-specific hooks required by code generation and other runtime components.
212 For example, when compiling for a 32-bit target, converting a double to a 64-bit
213 unsigned integer is compiled into a runtime call to the "__fixunsdfdi"
214 function. The compiler-rt library provides highly optimized implementations of
215 this and other low-level routines (some are 3x faster than the equivalent
216 libgcc routines).</p>
217
218 <p>
219 All of the code in the compiler-rt project is available under the standard LLVM
220 License, a "BSD-style" license.  New in LLVM 2.8, compiler_rt now supports 
221 soft floating point (for targets that don't have a real floating point unit),
222 and includes an extensive testsuite for the "blocks" language feature and the
223 blocks runtime included in compiler_rt.</p>
224
225 </div>
226
227 <!--=========================================================================-->
228 <div class="doc_subsection">
229 <a name="lldb">LLDB: Low Level Debugger</a>
230 </div>
231
232 <div class="doc_text">
233 <p>
234 <a href="http://lldb.llvm.org/">LLDB</a> is a brand new member of the LLVM
235 umbrella of projects. LLDB is a next generation, high-performance debugger. It
236 is built as a set of reusable components which highly leverage existing
237 libraries in the larger LLVM Project, such as the Clang expression parser, the
238 LLVM disassembler and the LLVM JIT.</p>
239
240 <p>
241 LLDB is in early development and not included as part of the LLVM 2.8 release,
242 but is mature enough to support basic debugging scenarios on Mac OS X in C,
243 Objective-C and C++.  We'd really like help extending and expanding LLDB to 
244 support new platforms, new languages, new architectures, and new features.
245 </p>
246
247 </div>
248
249 <!--=========================================================================-->
250 <div class="doc_subsection">
251 <a name="libc++">libc++: C++ Standard Library</a>
252 </div>
253
254 <div class="doc_text">
255 <p>
256 <a href="http://libc++.llvm.org/">libc++</a> is another new member of the LLVM
257 family.  It is an implementation of the C++ standard library, written from the
258 ground up to specifically target the forthcoming C++'0X standard and focus on
259 delivering great performance.</p>
260
261 <p>
262 As of the LLVM 2.8 release, libc++ is virtually feature complete, but would
263 benefit from more testing and better integration with Clang++.  It is also
264 looking forward to the C++ committee finalizing the C++'0x standard.
265 </p>
266
267 </div>
268
269
270 <!-- *********************************************************************** -->
271 <div class="doc_section">
272   <a name="externalproj">External Open Source Projects Using LLVM 2.8</a>
273 </div>
274 <!-- *********************************************************************** -->
275
276 <div class="doc_text">
277
278 <p>An exciting aspect of LLVM is that it is used as an enabling technology for
279    a lot of other language and tools projects.  This section lists some of the
280    projects that have already been updated to work with LLVM 2.8.</p>
281 </div>
282
283 <!--=========================================================================-->
284 <div class="doc_subsection">
285 <a name="tce">TTA-based Codesign Environment (TCE)</a>
286 </div>
287
288 <div class="doc_text">
289 <p>
290 <a href="http://tce.cs.tut.fi/">TCE</a> is a toolset for designing
291 application-specific processors (ASP) based on the Transport triggered
292 architecture (TTA). The toolset provides a complete co-design flow from C/C++
293 programs down to synthesizable VHDL and parallel program binaries. Processor
294 customization points include the register files, function units, supported
295 operations, and the interconnection network.</p>
296
297 <p>TCE uses llvm-gcc/Clang and LLVM for C/C++ language support, target
298 independent optimizations and also for parts of code generation. It generates
299 new LLVM-based code generators "on the fly" for the designed TTA processors and
300 loads them in to the compiler backend as runtime libraries to avoid per-target
301 recompilation of larger parts of the compiler chain.</p>
302
303 </div>
304
305 <!--=========================================================================-->
306 <div class="doc_subsection">
307 <a name="Horizon">Horizon Bytecode Compiler</a>
308 </div>
309
310 <div class="doc_text">
311 <p>
312 <a href="http://www.quokforge.org/projects/horizon">Horizon</a> is a bytecode
313 language and compiler written on top of LLVM, intended for producing
314 single-address-space managed code operating systems that
315 run faster than the equivalent multiple-address-space C systems.
316 More in-depth blurb is available on <a 
317 href="http://www.quokforge.org/projects/horizon/wiki/Wiki">the wiki</a>.</p>
318
319 </div>
320
321 <!--=========================================================================-->
322 <div class="doc_subsection">
323 <a name="clamav">Clam AntiVirus</a>
324 </div>
325
326 <div class="doc_text">
327 <p>
328 <a href=http://www.clamav.net>Clam AntiVirus</a> is an open source (GPL)
329 anti-virus toolkit for UNIX, designed especially for e-mail scanning on mail
330 gateways.  Since version 0.96 it has <a
331 href="http://vrt-sourcefire.blogspot.com/2010/09/introduction-to-clamavs-low-level.html">bytecode
332 signatures</a> that allow writing detections for complex malware. It
333 uses LLVM's JIT to speed up the execution of bytecode on
334 X86,X86-64,PPC32/64, falling back to its own interpreter otherwise.
335 The git version was updated to work with LLVM 2.8
336 </p>
337
338 <p>The <a
339 href="http://git.clamav.net/gitweb?p=clamav-bytecode-compiler.git;a=blob_plain;f=docs/user/clambc-user.pdf">
340 ClamAV bytecode compiler</a> uses Clang and LLVM to compile a C-like
341 language, insert runtime checks, and generate ClamAV bytecode.</p>
342
343 </div>
344
345 <!--=========================================================================-->
346 <div class="doc_subsection">
347 <a name="pure">Pure</a>
348 </div>
349
350 <div class="doc_text">
351 <p>
352 <a href="http://pure-lang.googlecode.com/">Pure</a>
353 is an algebraic/functional
354 programming language based on term rewriting. Programs are collections
355 of equations which are used to evaluate expressions in a symbolic
356 fashion. Pure offers dynamic typing, eager and lazy evaluation, lexical
357 closures, a hygienic macro system (also based on term rewriting),
358 built-in list and matrix support (including list and matrix
359 comprehensions) and an easy-to-use C interface. The interpreter uses
360 LLVM as a backend to JIT-compile Pure programs to fast native code.</p>
361
362 <p>Pure versions 0.44 and later have been tested and are known to work with
363 LLVM 2.8 (and continue to work with older LLVM releases >= 2.5).</p>
364
365 </div>
366
367 <!--=========================================================================-->
368 <div class="doc_subsection">
369 <a name="GHC">Glasgow Haskell Compiler (GHC)</a>
370 </div>
371
372 <div class="doc_text">
373 <p>
374 <a href="http://www.haskell.org/ghc/">GHC</a> is an open source,
375 state-of-the-art programming suite for
376 Haskell, a standard lazy functional programming language. It includes
377 an optimizing static compiler generating good code for a variety of
378 platforms, together with an interactive system for convenient, quick
379 development.</p>
380
381 <p>In addition to the existing C and native code generators, GHC 7.0 now
382 supports an <a
383 href="http://hackage.haskell.org/trac/ghc/wiki/Commentary/Compiler/Backends/LLVM">LLVM
384 code generator</a>. GHC supports LLVM 2.7 and later.</p>
385
386 </div>
387
388 <!--=========================================================================-->
389 <div class="doc_subsection">
390 <a name="Clay">Clay Programming Language</a>
391 </div>
392
393 <div class="doc_text">
394 <p>
395 <a href="http://tachyon.in/clay/">Clay</a> is a new systems programming
396 language that is specifically designed for generic programming. It makes
397 generic programming very concise thanks to whole program type propagation. It
398 uses LLVM as its backend.</p>
399
400 </div>
401
402 <!--=========================================================================-->
403 <div class="doc_subsection">
404 <a name="llvm-py">llvm-py Python Bindings for LLVM</a>
405 </div>
406
407 <div class="doc_text">
408 <p>
409 <a href="http://www.mdevan.org/llvm-py/">llvm-py</a> has been updated to work
410 with LLVM 2.8.  llvm-py provides Python bindings for LLVM, allowing you to write a
411 compiler backend or a VM in Python.</p>
412
413 </div>
414
415
416 <!--=========================================================================-->
417 <div class="doc_subsection">
418 <a name="FAUST">FAUST Real-Time Audio Signal Processing Language</a>
419 </div>
420
421 <div class="doc_text">
422 <p>
423 <a href="http://faust.grame.fr">FAUST</a> is a compiled language for real-time
424 audio signal processing. The name FAUST stands for Functional AUdio STream. Its
425 programming model combines two approaches: functional programming and block
426 diagram composition. In addition with the C, C++, JAVA output formats, the
427 Faust compiler can now generate LLVM bitcode, and works with LLVM 2.7 and
428 2.8.</p>
429
430 </div>
431
432 <!--=========================================================================-->
433 <div class="doc_subsection">
434 <a name="jade">Jade Just-in-time Adaptive Decoder Engine</a>
435 </div>
436
437 <div class="doc_text">
438 <p><a 
439 href="http://sourceforge.net/apps/trac/orcc/wiki/JadeDocumentation">Jade</a>
440 (Just-in-time Adaptive Decoder Engine) is a generic video decoder engine using
441 LLVM for just-in-time compilation of video decoder configurations. Those
442 configurations are designed by MPEG Reconfigurable Video Coding (RVC) committee.
443 MPEG RVC standard is built on a stream-based dataflow representation of
444 decoders. It is composed of a standard library of coding tools written in
445 RVC-CAL language and a dataflow configuration &emdash; block diagram &emdash;
446 of a decoder.</p>
447
448 <p>Jade project is hosted as part of the <a href="http://orcc.sf.net">Open 
449 RVC-CAL Compiler</a> and requires it to translate the RVC-CAL standard library
450 of video coding tools into an LLVM assembly code.</p>
451
452 </div>
453
454 <!--=========================================================================-->
455 <div class="doc_subsection">
456 <a name="neko_llvm_jit">LLVM JIT for Neko VM</a>
457 </div>
458
459 <div class="doc_text">
460 <p><a href="http://github.com/vava/neko_llvm_jit">Neko LLVM JIT</a>
461 replaces the standard Neko JIT with an LLVM-based implementation.  While not
462 fully complete, it is already providing a 1.5x speedup on 64-bit systems.
463 Neko LLVM JIT requires LLVM 2.8 or later.</p>
464
465 </div>
466
467 <!--=========================================================================-->
468 <div class="doc_subsection">
469 <a name="crack">Crack Scripting Language</a>
470 </div>
471
472 <div class="doc_text">
473 <p>
474 <a href="http://code.google.com/p/crack-language/">Crack</a> aims to provide
475 the ease of development of a scripting language with the performance of a
476 compiled language. The language derives concepts from C++, Java and Python,
477 incorporating object-oriented programming, operator overloading and strong
478 typing.  Crack 0.2 works with LLVM 2.7, and the forthcoming Crack 0.2.1 release
479 builds on LLVM 2.8.</p>
480
481 </div>
482
483 <!--=========================================================================-->
484 <div class="doc_subsection">
485 <a name="DresdenTM">Dresden TM Compiler (DTMC)</a>
486 </div>
487
488 <div class="doc_text">
489 <p>
490 <a href="http://tm.inf.tu-dresden.de">DTMC</a> provides support for 
491 Transactional Memory, which is an easy-to-use and efficient way to synchronize 
492 accesses to shared memory. Transactions can contain normal C/C++ code (e.g., 
493 __transaction { list.remove(x); x.refCount--; }) and will be executed 
494 virtually atomically and isolated from other transactions.</p>
495
496 </div>
497
498 <!--=========================================================================-->
499 <div class="doc_subsection">
500 <a name="Kai">Kai Interpreter</a>
501 </div>
502
503 <div class="doc_text">
504 <p>
505 <a href="http://www.oriontransfer.co.nz/research/kai">Kai</a> (Japanese ä¼š for
506 meeting/gathering) is an experimental interpreter that provides a highly
507 extensible runtime environment and explicit control over the compilation
508 process. Programs are defined using nested symbolic expressions, which are all
509 parsed into first-class values with minimal intrinsic semantics. Kai can
510 generate optimised code at run-time (using LLVM) in order to exploit the nature
511 of the underlying hardware and to integrate with external software libraries.
512 It is a unique exploration into world of dynamic code compilation, and the
513 interaction between high level and low level semantics.</p>
514
515 </div>
516
517 <!--=========================================================================-->
518 <div class="doc_subsection">
519 <a name="OSL">OSL: Open Shading Language</a>
520 </div>
521
522 <div class="doc_text">
523 <p>
524 <a href="http://code.google.com/p/openshadinglanguage/">OSL</a> is a shading
525 language designed for use in physically based renderers and in particular
526 production rendering. By using LLVM instead of the interpreter, it was able to
527 meet its performance goals (&gt;= C-code) while retaining the benefits of
528 runtime specialization and a portable high-level language.
529 </p>
530
531 </div>
532
533
534
535 <!-- *********************************************************************** -->
536 <div class="doc_section">
537   <a name="whatsnew">What's New in LLVM 2.8?</a>
538 </div>
539 <!-- *********************************************************************** -->
540
541 <div class="doc_text">
542
543 <p>This release includes a huge number of bug fixes, performance tweaks and
544 minor improvements.  Some of the major improvements and new features are listed
545 in this section.
546 </p>
547
548 </div>
549
550 <!--=========================================================================-->
551 <div class="doc_subsection">
552 <a name="orgchanges">LLVM Community Changes</a>
553 </div>
554
555 <div class="doc_text">
556
557 <p>In addition to changes to the code, between LLVM 2.7 and 2.8, a number of
558 organization changes have happened:
559 </p>
560
561 <ul>
562 <li>libc++ and lldb are new</li>
563 <li>Debugging optimized code support.</li>
564 </ul>
565 </div>
566
567 <!--=========================================================================-->
568 <div class="doc_subsection">
569 <a name="majorfeatures">Major New Features</a>
570 </div>
571
572 <div class="doc_text">
573
574 <p>LLVM 2.8 includes several major new capabilities:</p>
575
576 <ul>
577 <li>llvm-diff</li>
578 <li>Direct .o file writing support for darwin/x86[64].</li>
579 </ul>
580
581 </div>
582
583 <!--=========================================================================-->
584 <div class="doc_subsection">
585 <a name="coreimprovements">LLVM IR and Core Improvements</a>
586 </div>
587
588 <div class="doc_text">
589 <p>LLVM IR has several new features for better support of new targets and that
590 expose new optimization opportunities:</p>
591
592 <ul>
593
594   memcpy, memmove, and memset now take address space qualified pointers + volatile.
595   per-instruction debug info metadata is much faster and uses less space (new DebugLoc class).
596   New "trap values" concept: http://llvm.org/docs/LangRef.html#trapvalues
597   New linker_private_weak and linker_private_weak_def_auto linkage types
598   Triples are now stored in normalized form.  Triple::normalize.
599
600 </ul>
601
602 </div>
603
604 <!--=========================================================================-->
605 <div class="doc_subsection">
606 <a name="optimizer">Optimizer Improvements</a>
607 </div>
608
609 <div class="doc_text">
610
611 <p>In addition to a large array of minor performance tweaks and bug fixes, this
612 release includes a few major enhancements and additions to the optimizers:</p>
613
614 <ul>
615
616 <li></li>
617   Preliminary work on TBAA but not usable in 2.8.
618   New CorrelatedValuePropagation pass, not on by default in 2.8 yet.
619   JumpThreading much more aggressive about implied value relations.
620   New RegionInfo pass  "opt -regions analyze" or "opt -view-regions".
621   Improved trip count analysis for <= and >= loops, and uses sign overflow info.
622   llvm.dbg.value: variable debug info for optimized code
623   Now iterate function passes when a cgsccpassmanager detects a devirtualization
624   Atomic lowering patch: -loweratomic (see Passes.html#loweratomic)
625
626 </ul>
627
628 </div>
629
630
631 <!--=========================================================================-->
632 <div class="doc_subsection">
633 <a name="executionengine">Interpreter and JIT Improvements</a>
634 </div>
635
636 <div class="doc_text">
637
638 <ul>
639 <li></li>
640
641 </ul>
642
643 </div>
644
645 <!--=========================================================================-->
646 <div class="doc_subsection">
647 <a name="mc">MC Level Improvements</a>
648 </div>
649
650 <div class="doc_text">
651 <p>
652 The LLVM Machine Code (aka MC) subsystem was created to solve a number
653 of problems in the realm of assembly, disassembly, object file format handling,
654 and a number of other related areas that CPU instruction-set level tools work
655 in.</p>
656
657 <p>The MC subproject has made great leaps in LLVM 2.8.  For example, support for
658    directly writing .o files from LLC (and clang) now works reliably for
659    darwin/x86[-64] (including inline assembly support) and the integrated
660    assembler is turned on by default in Clang for these targets.  This provides
661    improved compile times among other things.</p>
662
663 <ul>
664 <li>The entire compiler has converted over to using the MCStreamer assembler API
665     instead of writing out a .s file textually.</li>
666 <li>The "assembler parser" is far more mature than in 2.7, supporting a full
667     complement of directives, now supports assembler macros, etc.</li>
668 <li>The "assembler backend" has been completed, including support for relaxation
669     relocation processing and all the other things that an assembler does.</li>
670 <li>The MachO file format support is now fully functional and works.</li>
671 <li>The MC disassembler now fully supports ARM and Thumb.  ARM assembler support
672     is still in early development though.</li>
673 <li>The X86 MC assembler now supports the X86 AES and AVX instruction set.</li>
674 <li>Work on ELF and COFF support is well underway, but isn't useful yet in LLVM
675     2.8.  Please contact the llvmdev mailing list if you're interested in
676     this.</li>
677 </ul>
678
679 <p>For more information, please see the <a
680 href="http://blog.llvm.org/2010/04/intro-to-llvm-mc-project.html">Intro to the
681 LLVM MC Project Blog Post</a>.
682 </p>
683
684 </div>  
685
686
687
688 <!--=========================================================================-->
689 <div class="doc_subsection">
690 <a name="codegen">Target Independent Code Generator Improvements</a>
691 </div>
692
693 <div class="doc_text">
694
695 <p>We have put a significant amount of work into the code generator
696 infrastructure, which allows us to implement more aggressive algorithms and make
697 it run faster:</p>
698
699 <ul>
700 <li></li>
701
702   MachineCSE tuned and on by default.
703
704   Rewrote tblgen's type inference for backends to be more consistent and
705      diagnose more target bugs.  This also allows limited support for writing
706      patterns for instructions that return multiple results, e.g. a virtual
707      register and a flag result.  Stuff that used 'parallel' before should use
708      this.
709
710   New -regalloc=fast,  =local got removed
711   New -regalloc=default option that chooses a register allocator based on the -O optimization level.
712   New SubRegIndex tblgen class for targets -> jakob
713
714   Bottom up fast isel.  Simple Load reuse.  No more machinedce.
715   IR ABI: <3 x float> is passed as <4 x float> instead of 3 floats.
716
717   New COPY instruction. copyRegToReg -> copyPhysReg, isMoveInstr is gone.
718   RenderMachineFunction: -rendermf
719   SplitKit?
720   Evan: Teach bottom up pre-ra scheduler to track register pressure. Work in progress.
721   Evan: Add an ILP scheduler.  On x86_64, this is a win for all tests in CFP2000. It also sped up 256.bzip2 by 16%.
722
723   New OptimizeExts+OptimizeCmps -> PeepholeOptimizer pass
724   New LocalStackSlotAllocation.cpp pass (jimg)
725   Atomics now get legalized when not natively supported (jim g)
726
727   -ffunction-sections and -fdata-sections are supported on ELF targets.
728   -momit-leaf-frame-pointer now supported.
729
730 </ul>
731 </div>
732
733 <!--=========================================================================-->
734 <div class="doc_subsection">
735 <a name="x86">X86-32 and X86-64 Target Improvements</a>
736 </div>
737
738 <div class="doc_text">
739 <p>New features of the X86 target include:
740 </p>
741
742 <ul>
743 <li>The X86 backend now supports holding X87 floating point stack values
744     in registers across basic blocks, dramatically improving performance of code
745     that uses long double, and when targetting CPUs that don't support SSE.</li>
746
747   New SSEDomainFix pass: 
748     On Nehalem and newer CPUs there is a 2 cycle latency penalty on using a
749     register in a different domain than where it was defined. Some instructions
750     have equvivalents for different domains, like por/orps/orpd.  The
751     SSEDomainFix pass tries to minimize the number of domain crossings by
752     changing between equvivalent opcodes where possible.
753
754   X86 backend attempts to promote 16-bit integer operations to 32-bits to avoid
755      0x66 prefixes, which are slow on some microarchitectures and bloat the code
756      on others.
757
758   New support for X86 "thiscall" calling convention (x86_thiscallcc in IR) for windows.
759
760   New llvm.x86.int intrinsic (for int $42 and int3)
761
762   Verbose assembly decodes X86 shuffle instructions, e.g.:
763         insertps        $113, %xmm3, %xmm0     ## xmm0 = zero,xmm0[1,2],xmm3[1]
764         unpcklps        %xmm1, %xmm0    ## xmm0 = xmm0[0],xmm1[0],xmm0[1],xmm1[1]
765         pshufd  $1, %xmm1, %xmm1        ## xmm1 = xmm1[1,0,0,0]
766         
767   X86 ABI:  <2 x float> in IR no longer maps onto MMX, it turns into <4 x float>
768
769   new GHC calling convention
770
771 </ul>
772
773 </div>
774
775 <!--=========================================================================-->
776 <div class="doc_subsection">
777 <a name="ARM">ARM Target Improvements</a>
778 </div>
779
780 <div class="doc_text">
781 <p>New features of the ARM target include:
782 </p>
783
784 <ul>
785
786   NEON: Better performance for QQQQ (4-consecutive Q register) instructions.  New reg sequence abstraction?
787   ARM: Better scheduling (list-hybrid, hybrid?)
788   ARM: Tail call support.
789   ARM: General performance work and tuning.
790
791   ARM: Half float support through intrinsics LangRef.html#int_fp16
792 <li>ARMGlobalMerge: <!-- Anton --> </li>
793
794 <li>The ARM NEON intrinsics have been substantially reworked to reduce
795     redundancy and improve code generation.  Some of the major changes are:
796   <ol>
797   <li>
798     All of the NEON load and store intrinsics (llvm.arm.neon.vld* and
799     llvm.arm.neon.vst*) take an extra parameter to specify the alignment in bytes
800     of the memory being accessed.
801   </li>
802   <li>
803     The llvm.arm.neon.vaba intrinsic (vector absolute difference and
804     accumulate) has been removed.  This operation is now represented using
805     the llvm.arm.neon.vabd intrinsic (vector absolute difference) followed by a
806     vector add.
807   </li>
808   <li>
809     The llvm.arm.neon.vabdl and llvm.arm.neon.vabal intrinsics (lengthening
810     vector absolute difference with and without accumlation) have been removed.
811     They are represented using the llvm.arm.neon.vabd intrinsic (vector absolute
812     difference) followed by a vector zero-extend operation, and for vabal,
813     a vector add.
814   </li>
815   <li>
816     The llvm.arm.neon.vmovn intrinsic has been removed.  Calls of this intrinsic
817     are now replaced by vector truncate operations.
818   </li>
819   <li>
820     The llvm.arm.neon.vmovls and llvm.arm.neon.vmovlu intrinsics have been
821     removed.  They are now represented as vector sign-extend (vmovls) and
822     zero-extend (vmovlu) operations.
823   </li>
824   <li>
825     The llvm.arm.neon.vaddl*, llvm.arm.neon.vaddw*, llvm.arm.neon.vsubl*, and
826     llvm.arm.neon.vsubw* intrinsics (lengthening vector add and subtract) have
827     been removed.  They are replaced by vector add and vector subtract operations
828     where one (vaddw, vsubw) or both (vaddl, vsubl) of the operands are either
829     sign-extended or zero-extended.
830   </li>
831   <li>
832     The llvm.arm.neon.vmulls, llvm.arm.neon.vmullu, llvm.arm.neon.vmlal*, and
833     llvm.arm.neon.vmlsl* intrinsics (lengthening vector multiply with and without
834     accumulation and subtraction) have been removed.  These operations are now
835     represented as vector multiplications where the operands are either
836     sign-extended or zero-extended, followed by a vector add for vmlal or a
837     vector subtract for vmlsl.  Note that the polynomial vector multiply
838     intrinsic, llvm.arm.neon.vmullp, remains unchanged.
839   </li>
840   </ol>
841 </li>
842 </ul>
843 </div>
844
845 <!--=========================================================================-->
846 <div class="doc_subsection">
847 <a name="newapis">New Useful APIs</a>
848 </div>
849
850 <div class="doc_text">
851
852 <p>This release includes a number of new APIs that are used internally, which
853    may also be useful for external clients.
854 </p>
855
856 <ul>
857 <li></li>
858 </ul>
859
860
861 </div>
862
863 <!--=========================================================================-->
864 <div class="doc_subsection">
865 <a name="otherimprovements">Other Improvements and New Features</a>
866 </div>
867
868 <div class="doc_text">
869 <p>Other miscellaneous features include:</p>
870
871 <ul>
872 <li></li>
873 </ul>
874
875 </div>
876
877
878 <!--=========================================================================-->
879 <div class="doc_subsection">
880 <a name="changes">Major Changes and Removed Features</a>
881 </div>
882
883 <div class="doc_text">
884
885 <p>If you're already an LLVM user or developer with out-of-tree changes based
886 on LLVM 2.7, this section lists some "gotchas" that you may run into upgrading
887 from the previous release.</p>
888
889 <ul>
890 <li>The build configuration machinery changed the output directory names.  It
891     wasn't clear to many people that "Release-Asserts" build was a release build
892     without asserts.  To make this more clear, "Release" does not include
893     assertions and "Release+Asserts" does (likewise, "Debug" and
894     "Debug+Asserts").</li>
895 <li>The MSIL Backend was removed, it was unsupported and broken.</li>
896 <li>The ABCD, SSI, and SCCVN passes were removed.  These were not fully
897     functional and their behavior has been or will be subsumed by the
898     LazyValueInfo  pass.</li>
899 <li>The LLVM IR 'Union' feature was removed.  While this is a desirable feature
900     for LLVM IR to support, the existing implementation was half baked and
901     barely useful.  We'd really like anyone interested to resurrect the work and
902     finish it for a future release.</li>
903 <li>If you're used to reading .ll files, you'll probably notice that .ll file
904     dumps don't produce #uses comments anymore.  To get them, run a .bc file
905     through "llvm-dis --show-annotations".</li>
906 </ul>
907
908
909
910 <p>In addition, many APIs have changed in this release.  Some of the major LLVM
911 API changes are:</p>
912 <ul>
913 <li>LLVM 2.8 changes the internal order of operands in <a
914   href="http://llvm.org/doxygen/classllvm_1_1InvokeInst.html"><tt>InvokeInst</tt></a>
915   and <a href="http://llvm.org/doxygen/classllvm_1_1CallInst.html"><tt>CallInst</tt></a>.
916   To be portable across releases, please use the <tt>CallSite</tt> class and the
917   high-level accessors, such as <tt>getCalledValue</tt> and
918   <tt>setUnwindDest</tt>.
919 </li>
920 <li>
921   You can no longer pass use_iterators directly to cast&lt;&gt; (and similar),
922   because these routines tend to perform costly dereference operations more
923   than once. You have to dereference the iterators yourself and pass them in.
924 </li>
925 <li>
926   llvm.memcpy.*, llvm.memset.*, llvm.memmove.* intrinsics take an extra
927   parameter now ("i1 isVolatile"), totaling 5 parameters, and the pointer
928   operands are now address-space qualified.
929   If you were creating these intrinsic calls and prototypes yourself (as opposed
930   to using Intrinsic::getDeclaration), you can use
931   UpgradeIntrinsicFunction/UpgradeIntrinsicCall to be portable accross releases.
932 </li>
933 <li>
934   SetCurrentDebugLocation takes a DebugLoc now instead of a MDNode.
935   Change your code to use
936   SetCurrentDebugLocation(DebugLoc::getFromDILocation(...)).
937 </li>
938 <li>
939   The <tt>RegisterPass</tt> and <tt>RegisterAnalysisGroup</tt> templates are
940   considered deprecated, but continue to function in LLVM 2.8.  Clients are  
941   strongly advised to use the upcoming <tt>INITIALIZE_PASS()</tt> and
942   <tt>INITIALIZE_AG_PASS()</tt> macros instead.
943 </li>
944 <li>
945   The constructor for the Triple class no longer tries to understand odd triple
946   specifications.  Frontends should ensure that they only pass valid triples to
947   LLVM.  The Triple::normalize utility method has been added to help front-ends
948   deal with funky triples.
949 </li>
950   
951 <li>
952   Some APIs got renamed:
953   <ul>
954   <li>llvm_report_error -&gt; report_fatal_error</li>
955   <li>llvm_install_error_handler -&gt; install_fatal_error_handler</li>
956   <li>llvm::DwarfExceptionHandling -&gt; llvm::JITExceptionHandling</li>
957   <li>VISIBILITY_HIDDEN -&gt; LLVM_LIBRARY_VISIBILITY</li>
958   </ul>
959 </li>
960
961 </ul>
962
963 </div>
964
965
966 <!-- *********************************************************************** -->
967 <div class="doc_section">
968   <a name="knownproblems">Known Problems</a>
969 </div>
970 <!-- *********************************************************************** -->
971
972 <div class="doc_text">
973
974 <p>This section contains significant known problems with the LLVM system,
975 listed by component.  If you run into a problem, please check the <a
976 href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
977 there isn't already one.</p>
978
979 </div>
980
981 <!-- ======================================================================= -->
982 <div class="doc_subsection">
983   <a name="experimental">Experimental features included with this release</a>
984 </div>
985
986 <div class="doc_text">
987
988 <p>The following components of this LLVM release are either untested, known to
989 be broken or unreliable, or are in early development.  These components should
990 not be relied on, and bugs should not be filed against them, but they may be
991 useful to some people.  In particular, if you would like to work on one of these
992 components, please contact us on the <a
993 href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p>
994
995 <ul>
996 <li>The Alpha, Blackfin, CellSPU, MicroBlaze, MSP430, MIPS, PIC16, SystemZ
997     and XCore backends are experimental.</li>
998 <li><tt>llc</tt> "<tt>-filetype=obj</tt>" is experimental on all targets
999     other than darwin-i386 and darwin-x86_64.</li>
1000 </ul>
1001
1002 </div>
1003
1004 <!-- ======================================================================= -->
1005 <div class="doc_subsection">
1006   <a name="x86-be">Known problems with the X86 back-end</a>
1007 </div>
1008
1009 <div class="doc_text">
1010
1011 <ul>
1012   <li>The X86 backend does not yet support
1013     all <a href="http://llvm.org/PR879">inline assembly that uses the X86
1014     floating point stack</a>.  It supports the 'f' and 't' constraints, but not
1015     'u'.</li>
1016   <li>Win64 code generation wasn't widely tested. Everything should work, but we
1017     expect small issues to happen. Also, llvm-gcc cannot build the mingw64
1018     runtime currently due to lack of support for the 'u' inline assembly
1019     constraint and for X87 floating point inline assembly.</li>
1020   <li>The X86-64 backend does not yet support the LLVM IR instruction
1021       <tt>va_arg</tt>. Currently, front-ends support variadic
1022       argument constructs on X86-64 by lowering them manually.</li>
1023 </ul>
1024
1025 </div>
1026
1027 <!-- ======================================================================= -->
1028 <div class="doc_subsection">
1029   <a name="ppc-be">Known problems with the PowerPC back-end</a>
1030 </div>
1031
1032 <div class="doc_text">
1033
1034 <ul>
1035 <li>The Linux PPC32/ABI support needs testing for the interpreter and static
1036 compilation, and lacks support for debug information.</li>
1037 </ul>
1038
1039 </div>
1040
1041 <!-- ======================================================================= -->
1042 <div class="doc_subsection">
1043   <a name="arm-be">Known problems with the ARM back-end</a>
1044 </div>
1045
1046 <div class="doc_text">
1047
1048 <ul>
1049 <li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
1050 processors, thumb programs can crash or produce wrong
1051 results (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
1052 <li>Compilation for ARM Linux OABI (old ABI) is supported but not fully tested.
1053 </li>
1054 </ul>
1055
1056 </div>
1057
1058 <!-- ======================================================================= -->
1059 <div class="doc_subsection">
1060   <a name="sparc-be">Known problems with the SPARC back-end</a>
1061 </div>
1062
1063 <div class="doc_text">
1064
1065 <ul>
1066 <li>The SPARC backend only supports the 32-bit SPARC ABI (-m32); it does not
1067     support the 64-bit SPARC ABI (-m64).</li>
1068 </ul>
1069
1070 </div>
1071
1072 <!-- ======================================================================= -->
1073 <div class="doc_subsection">
1074   <a name="mips-be">Known problems with the MIPS back-end</a>
1075 </div>
1076
1077 <div class="doc_text">
1078
1079 <ul>
1080 <li>64-bit MIPS targets are not supported yet.</li>
1081 </ul>
1082
1083 </div>
1084
1085 <!-- ======================================================================= -->
1086 <div class="doc_subsection">
1087   <a name="alpha-be">Known problems with the Alpha back-end</a>
1088 </div>
1089
1090 <div class="doc_text">
1091
1092 <ul>
1093
1094 <li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
1095 appropriate nops inserted to ensure restartability.</li>
1096
1097 </ul>
1098 </div>
1099
1100 <!-- ======================================================================= -->
1101 <div class="doc_subsection">
1102   <a name="c-be">Known problems with the C back-end</a>
1103 </div>
1104
1105 <div class="doc_text">
1106
1107 <p>The C backend has numerous problems and is not being actively maintained.
1108 Depending on it for anything serious is not advised.</p>
1109
1110 <ul>
1111 <li><a href="http://llvm.org/PR802">The C backend has only basic support for
1112     inline assembly code</a>.</li>
1113 <li><a href="http://llvm.org/PR1658">The C backend violates the ABI of common
1114     C++ programs</a>, preventing intermixing between C++ compiled by the CBE and
1115     C++ code compiled with <tt>llc</tt> or native compilers.</li>
1116 <li>The C backend does not support all exception handling constructs.</li>
1117 <li>The C backend does not support arbitrary precision integers.</li>
1118 </ul>
1119
1120 </div>
1121
1122
1123 <!-- ======================================================================= -->
1124 <div class="doc_subsection">
1125   <a name="llvm-gcc">Known problems with the llvm-gcc front-end</a>
1126 </div>
1127
1128 <div class="doc_text">
1129
1130 <p>llvm-gcc is generally very stable for the C family of languages.  The only
1131    major language feature of GCC not supported by llvm-gcc is the
1132    <tt>__builtin_apply</tt> family of builtins.   However, some extensions
1133    are only supported on some targets.  For example, trampolines are only
1134    supported on some targets (these are used when you take the address of a
1135    nested function).</p>
1136
1137 <p>Fortran support generally works, but there are still several unresolved bugs
1138    in <a href="http://llvm.org/bugs/">Bugzilla</a>.  Please see the
1139    tools/gfortran component for details.  Note that llvm-gcc is missing major
1140    Fortran performance work in the frontend and library that went into GCC after
1141    4.2.  If you are interested in Fortran, we recommend that you consider using
1142    <a href="#dragonegg">dragonegg</a> instead.</p>
1143
1144 <p>The llvm-gcc 4.2 Ada compiler has basic functionality. However, this is not a
1145 mature technology, and problems should be expected.  For example:</p>
1146 <ul>
1147 <li>The Ada front-end currently only builds on X86-32.  This is mainly due
1148 to lack of trampoline support (pointers to nested functions) on other platforms.
1149 However, it <a href="http://llvm.org/PR2006">also fails to build on X86-64</a>
1150 which does support trampolines.</li>
1151 <li>The Ada front-end <a href="http://llvm.org/PR2007">fails to bootstrap</a>.
1152 This is due to lack of LLVM support for <tt>setjmp</tt>/<tt>longjmp</tt> style
1153 exception handling, which is used internally by the compiler.
1154 Workaround: configure with <tt>--disable-bootstrap</tt>.</li>
1155 <li>The c380004, <a href="http://llvm.org/PR2010">c393010</a>
1156 and <a href="http://llvm.org/PR2421">cxg2021</a> ACATS tests fail
1157 (c380004 also fails with gcc-4.2 mainline).
1158 If the compiler is built with checks disabled then <a href="http://llvm.org/PR2010">c393010</a>
1159 causes the compiler to go into an infinite loop, using up all system memory.</li>
1160 <li>Some GCC specific Ada tests continue to crash the compiler.</li>
1161 <li>The <tt>-E</tt> binder option (exception backtraces)
1162 <a href="http://llvm.org/PR1982">does not work</a> and will result in programs
1163 crashing if an exception is raised.  Workaround: do not use <tt>-E</tt>.</li>
1164 <li>Only discrete types <a href="http://llvm.org/PR1981">are allowed to start
1165 or finish at a non-byte offset</a> in a record.  Workaround: do not pack records
1166 or use representation clauses that result in a field of a non-discrete type
1167 starting or finishing in the middle of a byte.</li>
1168 <li>The <tt>lli</tt> interpreter <a href="http://llvm.org/PR2009">considers
1169 'main' as generated by the Ada binder to be invalid</a>.
1170 Workaround: hand edit the file to use pointers for <tt>argv</tt> and
1171 <tt>envp</tt> rather than integers.</li>
1172 <li>The <tt>-fstack-check</tt> option <a href="http://llvm.org/PR2008">is
1173 ignored</a>.</li>
1174 </ul>
1175 </div>
1176
1177 <!-- *********************************************************************** -->
1178 <div class="doc_section">
1179   <a name="additionalinfo">Additional Information</a>
1180 </div>
1181 <!-- *********************************************************************** -->
1182
1183 <div class="doc_text">
1184
1185 <p>A wide variety of additional information is available on the <a
1186 href="http://llvm.org">LLVM web page</a>, in particular in the <a
1187 href="http://llvm.org/docs/">documentation</a> section.  The web page also
1188 contains versions of the API documentation which is up-to-date with the
1189 Subversion version of the source code.
1190 You can access versions of these documents specific to this release by going
1191 into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
1192
1193 <p>If you have any questions or comments about LLVM, please feel free to contact
1194 us via the <a href="http://llvm.org/docs/#maillist"> mailing
1195 lists</a>.</p>
1196
1197 </div>
1198
1199 <!-- *********************************************************************** -->
1200
1201 <hr>
1202 <address>
1203   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
1204   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
1205   <a href="http://validator.w3.org/check/referer"><img
1206   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
1207
1208   <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
1209   Last modified: $Date$
1210 </address>
1211
1212 </body>
1213 </html>