Add a blurb about MachineInstr bundling support.
[oota-llvm.git] / docs / ReleaseNotes.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2                       "http://www.w3.org/TR/html4/strict.dtd">
3 <html>
4 <head>
5   <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
6   <link rel="stylesheet" href="llvm.css" type="text/css">
7   <title>LLVM 3.1 Release Notes</title>
8 </head>
9 <body>
10
11 <h1>LLVM 3.1 Release Notes</h1>
12
13 <div>
14 <img style="float:right" src="http://llvm.org/img/DragonSmall.png"
15      width="136" height="136" alt="LLVM Dragon Logo">
16 </div>
17
18 <ol>
19   <li><a href="#intro">Introduction</a></li>
20   <li><a href="#subproj">Sub-project Status Update</a></li>
21   <li><a href="#externalproj">External Projects Using LLVM 3.1</a></li>
22   <li><a href="#whatsnew">What's New in LLVM?</a></li>
23   <li><a href="GettingStarted.html">Installation Instructions</a></li>
24   <li><a href="#knownproblems">Known Problems</a></li>
25   <li><a href="#additionalinfo">Additional Information</a></li>
26 </ol>
27
28 <div class="doc_author">
29   <p>Written by the <a href="http://llvm.org/">LLVM Team</a></p>
30 </div>
31
32 <h1 style="color:red">These are in-progress notes for the upcoming LLVM 3.1
33 release.<br>
34 You may prefer the
35 <a href="http://llvm.org/releases/3.0/docs/ReleaseNotes.html">LLVM 3.0
36 Release Notes</a>.</h1>
37
38 <!-- *********************************************************************** -->
39 <h2>
40   <a name="intro">Introduction</a>
41 </h2>
42 <!-- *********************************************************************** -->
43
44 <div>
45
46 <p>This document contains the release notes for the LLVM Compiler
47    Infrastructure, release 3.1.  Here we describe the status of LLVM, including
48    major improvements from the previous release, improvements in various
49    subprojects of LLVM, and some of the current users of the code.
50    All LLVM releases may be downloaded from
51    the <a 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 web
55    site</a>.  If you have questions or comments,
56    the <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM
57    Developer's 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 main
60    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 <h2>
69   <a name="subproj">Sub-project Status Update</a>
70 </h2>
71 <!-- *********************************************************************** -->
72
73 <div>
74
75 <p>The LLVM 3.1 distribution currently consists of code from the core LLVM
76    repository (which roughly includes the LLVM optimizers, code generators and
77    supporting tools), and the Clang repository.  In
78    addition to this code, the LLVM Project includes other sub-projects that are
79    in development.  Here we include updates on these subprojects.</p>
80
81 <!--=========================================================================-->
82 <h3>
83 <a name="clang">Clang: C/C++/Objective-C Frontend Toolkit</a>
84 </h3>
85
86 <div>
87
88 <p><a href="http://clang.llvm.org/">Clang</a> is an LLVM front end for the C,
89    C++, and Objective-C languages. Clang aims to provide a better user
90    experience through expressive diagnostics, a high level of conformance to
91    language standards, fast compilation, and low memory use. Like LLVM, Clang
92    provides a modular, library-based architecture that makes it suitable for
93    creating or integrating with other development tools. Clang is considered a
94    production-quality compiler for C, Objective-C, C++ and Objective-C++ on x86
95    (32- and 64-bit), and for Darwin/ARM targets.</p>
96
97 <p>In the LLVM 3.1 time-frame, the Clang team has made many improvements:</p>
98 <ul>
99   <li>...</li>
100 </ul>
101
102   <p>For more details about the changes to Clang since the 2.9 release, see the
103 <a href="http://clang.llvm.org/docs/ReleaseNotes.html">Clang release notes</a>
104 </p>
105
106
107 <p>If Clang rejects your code but another compiler accepts it, please take a
108    look at the <a href="http://clang.llvm.org/compatibility.html">language
109    compatibility</a> guide to make sure this is not intentional or a known
110    issue.</p>
111
112 </div>
113
114 <!--=========================================================================-->
115 <h3>
116 <a name="dragonegg">DragonEgg: GCC front-ends, LLVM back-end</a>
117 </h3>
118
119 <div>
120 <p><a href="http://dragonegg.llvm.org/">DragonEgg</a> is a
121    <a href="http://gcc.gnu.org/wiki/plugins">gcc plugin</a> that replaces GCC's
122    optimizers and code generators with LLVM's. It works with gcc-4.5 or gcc-4.6,
123    targets the x86-32 and x86-64 processor families, and has been successfully
124    used on the Darwin, FreeBSD, KFreeBSD, Linux and OpenBSD platforms.  It fully
125    supports Ada, C, C++ and Fortran.  It has partial support for Go, Java, Obj-C
126    and Obj-C++.</p>
127
128 <p>The 3.1 release has the following notable changes:</p>
129
130   <ul>
131
132   <li>...</li>
133
134 </ul>
135
136 </div>
137
138 <!--=========================================================================-->
139 <h3>
140 <a name="compiler-rt">compiler-rt: Compiler Runtime Library</a>
141 </h3>
142
143 <div>
144
145 <p>The new LLVM <a href="http://compiler-rt.llvm.org/">compiler-rt project</a>
146    is a simple library that provides an implementation of the low-level
147    target-specific hooks required by code generation and other runtime
148    components.  For example, when compiling for a 32-bit target, converting a
149    double to a 64-bit unsigned integer is compiled into a runtime call to the
150    "__fixunsdfdi" function. The compiler-rt library provides highly optimized
151    implementations of this and other low-level routines (some are 3x faster than
152    the equivalent libgcc routines).</p>
153
154 <p>....</p>
155
156 </div>
157
158 <!--=========================================================================-->
159 <h3>
160 <a name="lldb">LLDB: Low Level Debugger</a>
161 </h3>
162
163 <div>
164
165 <p>LLDB is a ground-up implementation of a command line debugger, as well as a
166    debugger API that can be used from other applications.  LLDB makes use of the
167    Clang parser to provide high-fidelity expression parsing (particularly for
168    C++) and uses the LLVM JIT for target support.</p>
169
170 <p>...</p>
171
172 </div>
173
174 <!--=========================================================================-->
175 <h3>
176 <a name="libc++">libc++: C++ Standard Library</a>
177 </h3>
178
179 <div>
180
181 <p>Like compiler_rt, libc++ is now <a href="DeveloperPolicy.html#license">dual
182    licensed</a> under the MIT and UIUC license, allowing it to be used more
183    permissively.</p>
184
185 <p>...</p>
186
187 </div>
188
189 <!--=========================================================================-->
190 <h3>
191 <a name="vmkit">VMKit</a>
192 </h3>
193
194 <div>
195
196   <p>The <a href="http://vmkit.llvm.org/">VMKit project</a> is an
197   implementation of a Java Virtual Machine (Java VM or JVM) that uses LLVM for
198   static and just-in-time compilation.
199
200   <p>In the LLVM 3.1 time-frame, VMKit has had significant improvements on both
201   runtime and startup performance:</p>
202
203   <ul>
204   <li>...</li>
205   </ul>
206
207 </div>
208
209 </div>
210
211 <!-- *********************************************************************** -->
212 <h2>
213   <a name="externalproj">External Open Source Projects Using LLVM 3.1</a>
214 </h2>
215 <!-- *********************************************************************** -->
216
217 <div>
218
219 <p>An exciting aspect of LLVM is that it is used as an enabling technology for
220    a lot of other language and tools projects.  This section lists some of the
221    projects that have already been updated to work with LLVM 3.1.</p>
222
223   ... to be filled in right before the release ...
224
225 </div>
226
227 <!-- *********************************************************************** -->
228 <h2>
229   <a name="whatsnew">What's New in LLVM 3.1?</a>
230 </h2>
231 <!-- *********************************************************************** -->
232
233 <div>
234
235 <p>This release includes a huge number of bug fixes, performance tweaks and
236    minor improvements.  Some of the major improvements and new features are
237    listed in this section.</p>
238
239 <!--=========================================================================-->
240 <h3>
241 <a name="majorfeatures">Major New Features</a>
242 </h3>
243
244 <div>
245
246   <!-- Features that need text if they're finished for 3.1:
247    ARM EHABI
248    combiner-aa?
249    strong phi elim
250    loop dependence analysis
251    CorrelatedValuePropagation
252    lib/Transforms/IPO/MergeFunctions.cpp => consider for 3.1.
253    Integrated assembler on by default for arm/thumb?
254
255    -->
256
257   <!-- Near dead:
258    Analysis/RegionInfo.h + Dom Frontiers
259    SparseBitVector: used in LiveVar.
260    llvm/lib/Archive - replace with lib object?
261    -->
262
263 <p>LLVM 3.1 includes several major changes and big features:</p>
264
265 <ul>
266   <li><a href="../tools/clang/docs/AddressSanitizer.html">AddressSanitizer</a>,
267       a fast memory error detector.</li>
268   <li><a href="CodeGenerator.html#machineinstrbundle">MachineInstr Bundles</a>,
269       Support to model instruction bundling / packing.</li>
270   <li>....</li>
271 </ul>
272
273 </div>
274
275
276 <!--=========================================================================-->
277 <h3>
278 <a name="coreimprovements">LLVM IR and Core Improvements</a>
279 </h3>
280
281 <div>
282
283 <p>LLVM IR has several new features for better support of new targets and that
284    expose new optimization opportunities:</p>
285
286   <ul>
287     <li>....</li>
288   </ul>
289 </div>
290
291 <!--=========================================================================-->
292 <h3>
293 <a name="optimizer">Optimizer Improvements</a>
294 </h3>
295
296 <div>
297
298 <p>In addition to many minor performance tweaks and bug fixes, this
299    release includes a few major enhancements and additions to the
300    optimizers:</p>
301
302 <ul>
303   <li>....</li>
304 </ul>
305
306 </div>
307
308 <!--=========================================================================-->
309 <h3>
310 <a name="mc">MC Level Improvements</a>
311 </h3>
312
313 <div>
314
315 <p>The LLVM Machine Code (aka MC) subsystem was created to solve a number of
316    problems in the realm of assembly, disassembly, object file format handling,
317    and a number of other related areas that CPU instruction-set level tools work
318    in. For more information, please see
319   the <a href="http://blog.llvm.org/2010/04/intro-to-llvm-mc-project.html">Intro
320     to the LLVM MC Project Blog Post</a>.</p>
321
322 <ul>
323   <li>....</li>
324 </ul>
325
326 </div>
327
328 <!--=========================================================================-->
329 <h3>
330 <a name="codegen">Target Independent Code Generator Improvements</a>
331 </h3>
332
333 <div>
334
335 <p>We have put a significant amount of work into the code generator
336    infrastructure, which allows us to implement more aggressive algorithms and
337    make it run faster:</p>
338
339 <ul>
340   <li>....</li>
341 </ul>
342 </div>
343
344 <!--=========================================================================-->
345 <h3>
346 <a name="x86">X86-32 and X86-64 Target Improvements</a>
347 </h3>
348
349 <div>
350
351 <p>New features and major changes in the X86 target include:</p>
352
353 <ul>
354   <li>....</li>
355 </ul>
356
357 </div>
358
359 <!--=========================================================================-->
360 <h3>
361 <a name="ARM">ARM Target Improvements</a>
362 </h3>
363
364 <div>
365
366 <p>New features of the ARM target include:</p>
367
368 <ul>
369   <li>....</li>
370 </ul>
371 </div>
372
373
374 <!--=========================================================================-->
375 <h3>
376 <a name="MIPS">MIPS Target Improvements</a>
377 </h3>
378
379 <div>
380
381 <p>This release has seen major new work on just about every aspect of the MIPS
382   backend.  Some of the major new features include:</p>
383
384 <ul>
385   <li>....</li>
386 </ul>
387 </div>
388
389 <!--=========================================================================-->
390 <h3>
391 <a name="OtherTS">Other Target Specific Improvements</a>
392 </h3>
393
394 <div>
395
396 <ul>
397   <li>....</li>
398
399
400 </ul>
401
402 </div>
403
404 <!--=========================================================================-->
405 <h3>
406 <a name="changes">Major Changes and Removed Features</a>
407 </h3>
408
409 <div>
410
411 <p>If you're already an LLVM user or developer with out-of-tree changes based on
412    LLVM 3.1, this section lists some "gotchas" that you may run into upgrading
413    from the previous release.</p>
414
415 <ul>
416 <li>LLVM 3.1 removes support for reading LLVM 2.9 bitcode files.  Going forward,
417     we aim for all future versions of LLVM to read bitcode files and .ll files
418     produced by LLVM 3.0 and later.</li>
419   <li>....</li>
420 </ul>
421
422 </div>
423
424 <!--=========================================================================-->
425 <h3>
426 <a name="api_changes">Internal API Changes</a>
427 </h3>
428
429 <div>
430
431 <p>In addition, many APIs have changed in this release.  Some of the major
432    LLVM API changes are:</p>
433
434 <ul>
435   <li>....</li>
436 </ul>
437
438 </div>
439
440 </div>
441
442 <!-- *********************************************************************** -->
443 <h2>
444   <a name="knownproblems">Known Problems</a>
445 </h2>
446 <!-- *********************************************************************** -->
447
448 <div>
449
450 <p>LLVM is generally a production quality compiler, and is used by a broad range
451    of applications and shipping in many products.  That said, not every
452    subsystem is as mature as the aggregate, particularly the more obscure
453    targets.  If you run into a problem, please check the <a
454    href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
455    there isn't already one or ask on the <a
456     href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev
457     list</a>.</p>
458
459   <p>Known problem areas include:</p>
460
461 <ul>
462   <li>The Alpha, Blackfin, CellSPU, MSP430, PTX, SystemZ and
463       XCore backends are experimental, and the Alpha, Blackfin and SystemZ
464       targets have already been removed from mainline.</li>
465
466   <li>The integrated assembler, disassembler, and JIT is not supported by
467       several targets.  If an integrated assembler is not supported, then a
468       system assembler is required.  For more details, see the <a
469       href="CodeGenerator.html#targetfeatures">Target Features Matrix</a>.
470   </li>
471
472   <li>The C backend has numerous problems and is not being actively maintained.
473     Depending on it for anything serious is not advised.</li>
474 </ul>
475
476 </div>
477
478 <!-- *********************************************************************** -->
479 <h2>
480   <a name="additionalinfo">Additional Information</a>
481 </h2>
482 <!-- *********************************************************************** -->
483
484 <div>
485
486 <p>A wide variety of additional information is available on
487    the <a href="http://llvm.org/">LLVM web page</a>, in particular in
488    the <a href="http://llvm.org/docs/">documentation</a> section.  The web page
489    also contains versions of the API documentation which is up-to-date with the
490    Subversion version of the source code.  You can access versions of these
491    documents specific to this release by going into the "<tt>llvm/doc/</tt>"
492    directory in the LLVM tree.</p>
493
494 <p>If you have any questions or comments about LLVM, please feel free to contact
495    us via the <a href="http://llvm.org/docs/#maillist"> mailing lists</a>.</p>
496
497 </div>
498
499 <!-- *********************************************************************** -->
500
501 <hr>
502 <address>
503   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
504   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
505   <a href="http://validator.w3.org/check/referer"><img
506   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
507
508   <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
509   Last modified: $Date$
510 </address>
511
512 </body>
513 </html>