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><a href="#armintegratedassembler">ARM Integrated Assembler</a>,
 271       A full featured assembler and direct-to-object support for ARM.</li>
 272   <li>....</li>
 273 </ul>
 274
 275 </div>
 276
 277
 278 <!--=========================================================================-->
 279 <h3>
 280 <a name="coreimprovements">LLVM IR and Core Improvements</a>
 281 </h3>
 282
 283 <div>
 284
 285 <p>LLVM IR has several new features for better support of new targets and that
 286    expose new optimization opportunities:</p>
 287
 288   <ul>
 289     <li>IR support for half float</li>
 290     <li>IR support for vectors of pointers, including vector GEPs.</li>
 291     <li>Module flags have been introduced. They convey information about the
 292         module as a whole to LLVM subsystems.</li>
 293     <li>Loads can now have range metadata attached to them to describe the
 294         possible values being loaded.</li>
 295     <li>....</li>
 296   </ul>
 297 </div>
 298
 299 <!--=========================================================================-->
 300 <h3>
 301 <a name="optimizer">Optimizer Improvements</a>
 302 </h3>
 303
 304 <div>
 305
 306 <p>In addition to many minor performance tweaks and bug fixes, this
 307    release includes a few major enhancements and additions to the
 308    optimizers:</p>
 309
 310 <ul>
 311   <li>The loop unroll pass now is able to unroll loops with run-time trip counts.
 312       This feature is turned off by default, and is enabled with the
 313       <code>-unroll-runtime</code> flag.</li>
 314   <li>A new basic-block autovectorization pass is available. Pass
 315       <code>-vectorize</code> to run this pass along with some associated
 316       post-vectorization cleanup passes.</li>
 317   <li>....</li>
 318 </ul>
 319
 320 </div>
 321
 322 <!--=========================================================================-->
 323 <h3>
 324 <a name="mc">MC Level Improvements</a>
 325 </h3>
 326
 327 <div>
 328
 329 <p>The LLVM Machine Code (aka MC) subsystem was created to solve a number of
 330    problems in the realm of assembly, disassembly, object file format handling,
 331    and a number of other related areas that CPU instruction-set level tools work
 332    in. For more information, please see
 333   the <a href="http://blog.llvm.org/2010/04/intro-to-llvm-mc-project.html">Intro
 334     to the LLVM MC Project Blog Post</a>.</p>
 335
 336 <ul>
 337   <li>....</li>
 338 </ul>
 339
 340 </div>
 341
 342 <!--=========================================================================-->
 343 <h3>
 344 <a name="codegen">Target Independent Code Generator Improvements</a>
 345 </h3>
 346
 347 <div>
 348
 349 <p>We have changed the way that the Type Legalizer legalizes vectors. The type
 350    legalizer now attempts to promote integer elements.  This enabled the
 351    implementation of vector-select.  Additionally, we see a performance boost on
 352    workloads which use vectors of chars and shorts, since they are now promoted
 353    to 32-bit types, which are better supported by the SIMD instruction set.
 354    Floating point types are still widened as before.</p>
 355
 356
 357 <p>We have put a significant amount of work into the code generator
 358    infrastructure, which allows us to implement more aggressive algorithms and
 359    make it run faster:</p>
 360
 361 <ul>
 362   <li>TableGen can now synthesize register classes that are only needed to
 363       represent combinations of constraints from instructions and sub-registers.
 364       The synthetic register classes inherit most of their properties form their
 365       closest user-defined super-class.</li>
 366   <li><code>MachineRegisterInfo</code> now allows the reserved registers to be
 367       frozen when register allocation starts.  Target hooks should use the
 368       <code>MRI-&gt;canReserveReg(FramePtr)</code> method to avoid accidentally
 369       disabling frame pointer elimination during register allocation.</li>
 370   <li>A new kind of <code>MachineOperand</code> provides a compact
 371       representation of large clobber lists on call instructions.  The register
 372       mask operand references a bit mask of preserved registers. Everything else
 373       is clobbered.</li>
 374 </ul>
 375
 376 <p> We added new TableGen infrastructure to support bundling for
 377     Very Long Instruction Word (VLIW) architectures. TableGen can now
 378     automatically generate a deterministic finite automaton from a VLIW
 379     target's schedule description which can be queried to determine
 380     legal groupings of instructions in a bundle.</p>
 381
 382 <p> We have added a new target independent VLIW packetizer based on the
 383     DFA infrastructure to group machine instructions into bundles.</p>
 384
 385 </div>
 386
 387 <!--=========================================================================-->
 388 <h3>
 389 <a name="x86">X86-32 and X86-64 Target Improvements</a>
 390 </h3>
 391
 392 <div>
 393
 394 <p>New features and major changes in the X86 target include:</p>
 395
 396 <ul>
 397   <li>Bug fixes and improved support for AVX1</li>
 398   <li>Support for AVX2 (still incomplete at this point)</li>
 399   <li>Call instructions use the new register mask operands for faster compile
 400   times and better support for different calling conventions.  The old WINCALL
 401   instructions are no longer needed.</li>
 402   <li>DW2 Exception Handling is enabled on Cygwin and MinGW.</li>
 403 </ul>
 404
 405 </div>
 406
 407 <!--=========================================================================-->
 408 <h3>
 409 <a name="ARM">ARM Target Improvements</a>
 410 </h3>
 411
 412 <div>
 413
 414 <p>New features of the ARM target include:</p>
 415
 416 <ul>
 417   <li>The constant island pass now supports basic block and constant pool entry
 418   alignments greater than 4 bytes.</li>
 419   <li>On Darwin, the ARM target now has a full-featured integrated assembler.
 420   </li>
 421 </ul>
 422
 423 <h4>
 424 <a name="armintegratedassembler">ARM Integrated Assembler</a>
 425 </h4>
 426 <div>
 427 <p>The ARM target now includes a full featured macro assembler, including
 428 direct-to-object module support for clang. The assembler is currently enabled
 429 by default for Darwin only pending testing and any additional necessary
 430 platform specific support for Linux.</p>
 431
 432 <p>Full support is included for Thumb1, Thumb2 and ARM modes, along with
 433 subtarget and CPU specific extensions for VFP2, VFP3 and NEON.</p>
 434
 435 <p>The assembler is Unified Syntax only (see ARM Architecural Reference Manual
 436 for details). While there is some, and growing, support for pre-unfied (divided)
 437 syntax, there are still significant gaps in that support.</p>
 438 </div>
 439
 440 </div>
 441 <!--=========================================================================-->
 442 <h3>
 443 <a name="MIPS">MIPS Target Improvements</a>
 444 </h3>
 445
 446 <div>
 447
 448 <p>This release has seen major new work on just about every aspect of the MIPS
 449   backend.  Some of the major new features include:</p>
 450
 451 <ul>
 452   <li>....</li>
 453 </ul>
 454 </div>
 455
 456 <!--=========================================================================-->
 457 <h3>
 458 <a name="OtherTS">Other Target Specific Improvements</a>
 459 </h3>
 460
 461 <div>
 462
 463 <p>Support for Qualcomm's Hexagon VLIW processor has been added.</p>
 464
 465 <ul>
 466   <li>....</li>
 467
 468
 469 </ul>
 470
 471 </div>
 472
 473 <!--=========================================================================-->
 474 <h3>
 475 <a name="changes">Major Changes and Removed Features</a>
 476 </h3>
 477
 478 <div>
 479
 480 <p>If you're already an LLVM user or developer with out-of-tree changes based on
 481    LLVM 3.1, this section lists some "gotchas" that you may run into upgrading
 482    from the previous release.</p>
 483
 484 <ul>
 485   <li>LLVM 3.1 removes support for reading LLVM 2.9 bitcode files. Going
 486       forward, we aim for all future versions of LLVM to read bitcode files and
 487       <tt>.ll</tt> files produced by LLVM 3.0 and later.</li>
 488   <li>The <tt>unwind</tt> instruction is now gone. With the introduction of the
 489       new exception handling system in LLVM 3.0, the <tt>unwind</tt> instruction
 490       became obsolete.</li>
 491   <li>....</li>
 492 </ul>
 493
 494 </div>
 495
 496 <!--=========================================================================-->
 497 <h3>
 498 <a name="api_changes">Internal API Changes</a>
 499 </h3>
 500
 501 <div>
 502
 503 <p>In addition, many APIs have changed in this release.  Some of the major
 504    LLVM API changes are:</p>
 505
 506 <ul>
 507   <li>Target specific options have been moved from global variables to members
 508       on the new <code>TargetOptions</code> class, which is local to each
 509       <code>TargetMachine</code>. As a consequence, the associated flags will
 510       no longer be accepted by <tt>clang -mllvm</tt>. This includes:
 511 <ul>
 512 <li><code>llvm::PrintMachineCode</code></li>
 513 <li><code>llvm::NoFramePointerElim</code></li>
 514 <li><code>llvm::NoFramePointerElimNonLeaf</code></li>
 515 <li><code>llvm::DisableFramePointerElim(const MachineFunction &)</code></li>
 516 <li><code>llvm::LessPreciseFPMADOption</code></li>
 517 <li><code>llvm::LessPrecideFPMAD()</code></li>
 518 <li><code>llvm::NoExcessFPPrecision</code></li>
 519 <li><code>llvm::UnsafeFPMath</code></li>
 520 <li><code>llvm::NoInfsFPMath</code></li>
 521 <li><code>llvm::NoNaNsFPMath</code></li>
 522 <li><code>llvm::HonorSignDependentRoundingFPMathOption</code></li>
 523 <li><code>llvm::HonorSignDependentRoundingFPMath()</code></li>
 524 <li><code>llvm::UseSoftFloat</code></li>
 525 <li><code>llvm::FloatABIType</code></li>
 526 <li><code>llvm::NoZerosInBSS</code></li>
 527 <li><code>llvm::JITExceptionHandling</code></li>
 528 <li><code>llvm::JITEmitDebugInfo</code></li>
 529 <li><code>llvm::JITEmitDebugInfoToDisk</code></li>
 530 <li><code>llvm::GuaranteedTailCallOpt</code></li>
 531 <li><code>llvm::StackAlignmentOverride</code></li>
 532 <li><code>llvm::RealignStack</code></li>
 533 <li><code>llvm::DisableJumpTables</code></li>
 534 <li><code>llvm::EnableFastISel</code></li>
 535 <li><code>llvm::getTrapFunctionName()</code></li>
 536 <li><code>llvm::EnableSegmentedStacks</code></li>
 537 </ul></li>
 538   <li>The MDBuilder class has been added to simplify the creation of
 539       metadata.</li>
 540   <li>....</li>
 541 </ul>
 542
 543 </div>
 544
 545 <!--=========================================================================-->
 546 <h3>
 547 <a name="tools_changes">Tools Changes</a>
 548 </h3>
 549
 550 <div>
 551
 552 <p>In addition, some tools have changed in this release. Some of the changes
 553    are:</p>
 554
 555
 556 <ul>
 557   <li>llvm-stress is a command line tool for generating random .ll files to fuzz
 558       different LLVM components. </li>
 559   <li>....</li>
 560 </ul>
 561
 562 <ul>
 563   <li>....</li>
 564 </ul>
 565
 566 </div>
 567
 568 </div>
 569
 570 <!-- *********************************************************************** -->
 571 <h2>
 572   <a name="knownproblems">Known Problems</a>
 573 </h2>
 574 <!-- *********************************************************************** -->
 575
 576 <div>
 577
 578 <p>LLVM is generally a production quality compiler, and is used by a broad range
 579    of applications and shipping in many products.  That said, not every
 580    subsystem is as mature as the aggregate, particularly the more obscure
 581    targets.  If you run into a problem, please check the <a
 582    href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
 583    there isn't already one or ask on the <a
 584     href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev
 585     list</a>.</p>
 586
 587   <p>Known problem areas include:</p>
 588
 589 <ul>
 590   <li>The Alpha, Blackfin, CellSPU, MSP430, PTX, SystemZ and
 591       XCore backends are experimental, and the Alpha, Blackfin and SystemZ
 592       targets have already been removed from mainline.</li>
 593
 594   <li>The integrated assembler, disassembler, and JIT is not supported by
 595       several targets.  If an integrated assembler is not supported, then a
 596       system assembler is required.  For more details, see the <a
 597       href="CodeGenerator.html#targetfeatures">Target Features Matrix</a>.
 598   </li>
 599
 600   <li>The C backend has numerous problems and is not being actively maintained.
 601     Depending on it for anything serious is not advised.</li>
 602 </ul>
 603
 604 </div>
 605
 606 <!-- *********************************************************************** -->
 607 <h2>
 608   <a name="additionalinfo">Additional Information</a>
 609 </h2>
 610 <!-- *********************************************************************** -->
 611
 612 <div>
 613
 614 <p>A wide variety of additional information is available on
 615    the <a href="http://llvm.org/">LLVM web page</a>, in particular in
 616    the <a href="http://llvm.org/docs/">documentation</a> section.  The web page
 617    also contains versions of the API documentation which is up-to-date with the
 618    Subversion version of the source code.  You can access versions of these
 619    documents specific to this release by going into the "<tt>llvm/doc/</tt>"
 620    directory in the LLVM tree.</p>
 621
 622 <p>If you have any questions or comments about LLVM, please feel free to contact
 623    us via the <a href="http://llvm.org/docs/#maillist"> mailing lists</a>.</p>
 624
 625 </div>
 626
 627 <!-- *********************************************************************** -->
 628
 629 <hr>
 630 <address>
 631   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
 632   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
 633   <a href="http://validator.w3.org/check/referer"><img
 634   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
 635
 636   <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
 637   Last modified: $Date$
 638 </address>
 639
 640 </body>
 641 </html>