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 <ol>
  14   <li><a href="#intro">Introduction</a></li>
  15   <li><a href="#subproj">Sub-project Status Update</a></li>
  16   <li><a href="#externalproj">External Projects Using LLVM 2.7</a></li>
  17   <li><a href="#whatsnew">What's New in LLVM 2.7?</a></li>
  18   <li><a href="GettingStarted.html">Installation Instructions</a></li>
  19   <li><a href="#portability">Portability and Supported Platforms</a></li>
  20   <li><a href="#knownproblems">Known Problems</a></li>
  21   <li><a href="#additionalinfo">Additional Information</a></li>
  22 </ol>
  23
  24 <div class="doc_author">
  25   <p>Written by the <a href="http://llvm.org">LLVM Team</a></p>
  26 </div>
  27
  28 <h1 style="color:red">These are in-progress notes for the upcoming LLVM 2.7
  29 release.<br>
  30 You may prefer the
  31 <a href="http://llvm.org/releases/2.6/docs/ReleaseNotes.html">LLVM 2.6
  32 Release Notes</a>.</h1>
  33
  34 <!-- *********************************************************************** -->
  35 <div class="doc_section">
  36   <a name="intro">Introduction</a>
  37 </div>
  38 <!-- *********************************************************************** -->
  39
  40 <div class="doc_text">
  41
  42 <p>This document contains the release notes for the LLVM Compiler
  43 Infrastructure, release 2.7.  Here we describe the status of LLVM, including
  44 major improvements from the previous release and significant known problems.
  45 All LLVM releases may be downloaded from the <a
  46 href="http://llvm.org/releases/">LLVM releases web site</a>.</p>
  47
  48 <p>For more information about LLVM, including information about the latest
  49 release, please check out the <a href="http://llvm.org/">main LLVM
  50 web site</a>.  If you have questions or comments, the <a
  51 href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM Developer's Mailing
  52 List</a> is a good place to send them.</p>
  53
  54 <p>Note that if you are reading this file from a Subversion checkout or the
  55 main LLVM web page, this document applies to the <i>next</i> release, not the
  56 current one.  To see the release notes for a specific release, please see the
  57 <a href="http://llvm.org/releases/">releases page</a>.</p>
  58
  59 </div>
  60
  61
  62 <!--
  63 Almost dead code.
  64   include/llvm/Analysis/LiveValues.h => Dan
  65   lib/Transforms/IPO/MergeFunctions.cpp => consider for 2.8.
  66   llvm/Analysis/PointerTracking.h => Edwin wants this, consider for 2.8.
  67   ABCD, SCCVN, GEPSplitterPass
  68   MSIL backend?
  69 -->
  70
  71
  72 <!-- Features that need text if they're finished for 2.7:
  73   gcc plugin.
  74   strong phi elim
  75   variable debug info for optimized code
  76   postalloc scheduler: anti dependence breaking, hazard recognizer?
  77   metadata
  78   loop dependence analysis
  79   ELF Writer?  How stable?
  80   <li>PostRA scheduler improvements, ARM adoption (David Goodwin).</li>
  81   2.7 supports the GDB 7.0 jit interfaces for debug info.
  82   2.7 eliminates ADT/iterator.h
  83  -->
  84
  85  <!-- for announcement email:
  86  Logo web page.
  87  llvm devmtg
  88  compiler_rt
  89  KLEE web page at klee.llvm.org
  90  Many new papers added to /pubs/
  91    Mention gcc plugin.
  92
  93    -->
  94
  95 <!-- *********************************************************************** -->
  96 <div class="doc_section">
  97   <a name="subproj">Sub-project Status Update</a>
  98 </div>
  99 <!-- *********************************************************************** -->
 100
 101 <div class="doc_text">
 102 <p>
 103 The LLVM 2.7 distribution currently consists of code from the core LLVM
 104 repository (which roughly includes the LLVM optimizers, code generators
 105 and supporting tools), the Clang repository and the llvm-gcc repository.  In
 106 addition to this code, the LLVM Project includes other sub-projects that are in
 107 development.  Here we include updates on these subprojects.
 108 </p>
 109
 110 </div>
 111
 112
 113 <!--=========================================================================-->
 114 <div class="doc_subsection">
 115 <a name="clang">Clang: C/C++/Objective-C Frontend Toolkit</a>
 116 </div>
 117
 118 <div class="doc_text">
 119
 120 <p>The <a href="http://clang.llvm.org/">Clang project</a> is ...</p>
 121
 122 <p>In the LLVM 2.7 time-frame, the Clang team has made many improvements:</p>
 123
 124 <ul>
 125 <li>...</li>
 126 </ul>
 127 </div>
 128
 129 <!--=========================================================================-->
 130 <div class="doc_subsection">
 131 <a name="clangsa">Clang Static Analyzer</a>
 132 </div>
 133
 134 <div class="doc_text">
 135
 136 <p>Previously announced in the 2.4, 2.5, and 2.6 LLVM releases, the Clang project also
 137 includes an early stage static source code analysis tool for <a
 138 href="http://clang.llvm.org/StaticAnalysis.html">automatically finding bugs</a>
 139 in C and Objective-C programs. The tool performs checks to find
 140 bugs that occur on a specific path within a program.</p>
 141
 142 <p>In the LLVM 2.7 time-frame, the analyzer core has ...</p>
 143
 144 </div>
 145
 146 <!--=========================================================================-->
 147 <div class="doc_subsection">
 148 <a name="vmkit">VMKit: JVM/CLI Virtual Machine Implementation</a>
 149 </div>
 150
 151 <div class="doc_text">
 152 <p>
 153 The <a href="http://vmkit.llvm.org/">VMKit project</a> is an implementation of
 154 a JVM and a CLI Virtual Machine (Microsoft .NET is an
 155 implementation of the CLI) using LLVM for static and just-in-time
 156 compilation.</p>
 157
 158 <p>
 159 VMKit version ?? builds with LLVM 2.7 and you can find it on its
 160 <a href="http://vmkit.llvm.org/releases/">web page</a>. The release includes
 161 bug fixes, cleanup and new features. The major changes are:</p>
 162
 163 <ul>
 164
 165 <li>...</li>
 166
 167 </ul>
 168 </div>
 169
 170
 171 <!--=========================================================================-->
 172 <div class="doc_subsection">
 173 <a name="compiler-rt">compiler-rt: Compiler Runtime Library</a>
 174 </div>
 175
 176 <div class="doc_text">
 177 <p>
 178 The new LLVM <a href="http://compiler-rt.llvm.org/">compiler-rt project</a>
 179 is a simple library that provides an implementation of the low-level
 180 target-specific hooks required by code generation and other runtime components.
 181 For example, when compiling for a 32-bit target, converting a double to a 64-bit
 182 unsigned integer is compiled into a runtime call to the "__fixunsdfdi"
 183 function. The compiler-rt library provides highly optimized implementations of
 184 this and other low-level routines (some are 3x faster than the equivalent
 185 libgcc routines).</p>
 186
 187 <p>
 188 All of the code in the compiler-rt project is available under the standard LLVM
 189 License, a "BSD-style" license.</p>
 190
 191 </div>
 192
 193 <!--=========================================================================-->
 194 <div class="doc_subsection">
 195 <a name="klee">KLEE: Symbolic Execution and Automatic Test Case Generator</a>
 196 </div>
 197
 198 <div class="doc_text">
 199 <p>
 200 The new LLVM <a href="http://klee.llvm.org/">KLEE project</a> is a symbolic
 201 execution framework for programs in LLVM bitcode form.  KLEE tries to
 202 symbolically evaluate "all" paths through the application and records state
 203 transitions that lead to fault states.  This allows it to construct testcases
 204 that lead to faults and can even be used to verify algorithms.  For more
 205 details, please see the <a
 206 href="http://llvm.org/pubs/2008-12-OSDI-KLEE.html">OSDI 2008 paper</a> about
 207 KLEE.</p>
 208
 209 </div>
 210
 211 <!--=========================================================================-->
 212 <div class="doc_subsection">
 213 <a name="dragonegg">DragonEgg: GCC-4.5 as an LLVM frontend</a>
 214 </div>
 215
 216 <div class="doc_text">
 217 <p>
 218 The goal of <a href="http://dragonegg.llvm.org/">DragonEgg</a> is to make
 219 gcc-4.5 act like llvm-gcc without requiring any gcc modifications whatsoever.
 220 <a href="http://dragonegg.llvm.org/">DragonEgg</a> is a shared library (dragonegg.so)
 221 that is loaded by gcc at runtime.  It ...
 222 </p>
 223
 224 </div>
 225
 226
 227 <!--=========================================================================-->
 228 <div class="doc_subsection">
 229 <a name="mc">llvm-mc: Machine Code Toolkit</a>
 230 </div>
 231
 232 <div class="doc_text">
 233 <p>
 234 The LLVM Machine Code (MC) Toolkit project is ...
 235 </p>
 236
 237 </div>
 238
 239
 240 <!-- *********************************************************************** -->
 241 <div class="doc_section">
 242   <a name="externalproj">External Open Source Projects Using LLVM 2.7</a>
 243 </div>
 244 <!-- *********************************************************************** -->
 245
 246 <div class="doc_text">
 247
 248 <p>An exciting aspect of LLVM is that it is used as an enabling technology for
 249    a lot of other language and tools projects.  This section lists some of the
 250    projects that have already been updated to work with LLVM 2.7.</p>
 251 </div>
 252
 253
 254 <!--=========================================================================-->
 255 <div class="doc_subsection">
 256 <a name="Rubinius">Rubinius</a>
 257 </div>
 258
 259 <div class="doc_text">
 260 <p><a href="http://github.com/evanphx/rubinius">Rubinius</a> is an environment
 261 for running Ruby code which strives to write as much of the core class
 262 implementation in Ruby as possible. Combined with a bytecode interpreting VM, it
 263 uses LLVM to optimize and compile ruby code down to machine code. Techniques
 264 such as type feedback, method inlining, and uncommon traps are all used to
 265 remove dynamism from ruby execution and increase performance.</p>
 266
 267 <p>Since LLVM 2.5, Rubinius has made several major leaps forward, implementing
 268 a counter based JIT, type feedback and speculative method inlining.
 269 </p>
 270
 271 </div>
 272
 273 <!--=========================================================================-->
 274 <div class="doc_subsection">
 275 <a name="macruby">MacRuby</a>
 276 </div>
 277
 278 <div class="doc_text">
 279
 280 <p>
 281 <a href="http://macruby.org">MacRuby</a> is an implementation of Ruby on top of
 282 core Mac OS X technologies, such as the Objective-C common runtime and garbage
 283 collector and the CoreFoundation framework. It is principally developed by
 284 Apple and aims at enabling the creation of full-fledged Mac OS X applications.
 285 </p>
 286
 287 <p>
 288 MacRuby uses LLVM for optimization passes, JIT and AOT compilation of Ruby
 289 expressions. It also uses zero-cost DWARF exceptions to implement Ruby exception
 290 handling.</p>
 291
 292 </div>
 293
 294
 295 <!--=========================================================================-->
 296 <div class="doc_subsection">
 297 <a name="pure">Pure</a>
 298 </div>
 299
 300 <div class="doc_text">
 301 <p>
 302 <a href="http://pure-lang.googlecode.com/">Pure</a>
 303 is an algebraic/functional programming language based on term rewriting.
 304 Programs are collections of equations which are used to evaluate expressions in
 305 a symbolic fashion. Pure offers dynamic typing, eager and lazy evaluation,
 306 lexical closures, a hygienic macro system (also based on term rewriting),
 307 built-in list and matrix support (including list and matrix comprehensions) and
 308 an easy-to-use C interface. The interpreter uses LLVM as a backend to
 309  JIT-compile Pure programs to fast native code.</p>
 310
 311 <p>Pure versions ??? and later have been tested and are known to work with
 312 LLVM 2.7 (and continue to work with older LLVM releases >= 2.3 as well).
 313 </p>
 314 </div>
 315
 316
 317 <!--=========================================================================-->
 318 <div class="doc_subsection">
 319 <a name="ldc">LLVM D Compiler</a>
 320 </div>
 321
 322 <div class="doc_text">
 323 <p>
 324 <a href="http://www.dsource.org/projects/ldc">LDC</a> is an implementation of
 325 the D Programming Language using the LLVM optimizer and code generator.
 326 The LDC project works great with the LLVM 2.6 release.  General improvements in
 327 this
 328 cycle have included new inline asm constraint handling, better debug info
 329 support, general bug fixes and better x86-64 support.  This has allowed
 330 some major improvements in LDC, getting it much closer to being as
 331 fully featured as the original DMD compiler from DigitalMars.
 332 </p>
 333 </div>
 334
 335 <!--=========================================================================-->
 336 <div class="doc_subsection">
 337 <a name="RoadsendPHP">Roadsend PHP</a>
 338 </div>
 339
 340 <div class="doc_text">
 341 <p>
 342 <a href="http://code.roadsend.com/rphp">Roadsend PHP</a> (rphp) is an open
 343 source implementation of the PHP programming
 344 language that uses LLVM for its optimizer, JIT and static compiler. This is a
 345 reimplementation of an earlier project that is now based on LLVM.</p>
 346 </div>
 347
 348 <!--=========================================================================-->
 349 <div class="doc_subsection">
 350 <a name="UnladenSwallow">Unladen Swallow</a>
 351 </div>
 352
 353 <div class="doc_text">
 354 <p>
 355 <a href="http://code.google.com/p/unladen-swallow/">Unladen Swallow</a> is a
 356 branch of <a href="http://python.org/">Python</a> intended to be fully
 357 compatible and significantly faster.  It uses LLVM's optimization passes and JIT
 358 compiler.</p>
 359 </div>
 360
 361 <!--=========================================================================-->
 362 <div class="doc_subsection">
 363 <a name="llvm-lua">llvm-lua</a>
 364 </div>
 365
 366 <div class="doc_text">
 367 <p>
 368 <a href="http://code.google.com/p/llvm-lua/">LLVM-Lua</a> uses LLVM to add JIT
 369 and static compiling support to the Lua VM.  Lua bytecode is analyzed to
 370 remove type checks, then LLVM is used to compile the bytecode down to machine
 371 code.</p>
 372 </div>
 373
 374 <!--=========================================================================-->
 375 <div class="doc_subsection">
 376 <a name="icedtea">IcedTea Java Virtual Machine Implementation</a>
 377 </div>
 378
 379 <div class="doc_text">
 380 <p>
 381 <a href="http://icedtea.classpath.org/wiki/Main_Page">IcedTea</a> provides a
 382 harness to build OpenJDK using only free software build tools and to provide
 383 replacements for the not-yet free parts of OpenJDK.  One of the extensions that
 384 IcedTea provides is a new JIT compiler named <a
 385 href="http://icedtea.classpath.org/wiki/ZeroSharkFaq">Shark</a> which uses LLVM
 386 to provide native code generation without introducing processor-dependent
 387 code.
 388 </p>
 389 </div>
 390
 391
 392
 393 <!-- *********************************************************************** -->
 394 <div class="doc_section">
 395   <a name="whatsnew">What's New in LLVM 2.7?</a>
 396 </div>
 397 <!-- *********************************************************************** -->
 398
 399 <div class="doc_text">
 400
 401 <p>This release includes a huge number of bug fixes, performance tweaks and
 402 minor improvements.  Some of the major improvements and new features are listed
 403 in this section.
 404 </p>
 405
 406 </div>
 407
 408 <!--=========================================================================-->
 409 <div class="doc_subsection">
 410 <a name="majorfeatures">Major New Features</a>
 411 </div>
 412
 413 <div class="doc_text">
 414
 415 <p>LLVM 2.7 includes several major new capabilities:</p>
 416
 417 <ul>
 418 <li>...</li>
 419 </ul>
 420
 421 </div>
 422
 423 <!--=========================================================================-->
 424 <div class="doc_subsection">
 425 <a name="coreimprovements">LLVM IR and Core Improvements</a>
 426 </div>
 427
 428 <div class="doc_text">
 429 <p>LLVM IR has several new features for better support of new targets and that
 430 expose new optimization opportunities:</p>
 431
 432 <ul>
 433 <li>...</li>
 434 </ul>
 435
 436 </div>
 437
 438 <!--=========================================================================-->
 439 <div class="doc_subsection">
 440 <a name="optimizer">Optimizer Improvements</a>
 441 </div>
 442
 443 <div class="doc_text">
 444
 445 <p>In addition to a large array of minor performance tweaks and bug fixes, this
 446 release includes a few major enhancements and additions to the optimizers:</p>
 447
 448 <ul>
 449
 450 <li>...</li>
 451
 452 </ul>
 453
 454 </div>
 455
 456
 457 <!--=========================================================================-->
 458 <div class="doc_subsection">
 459 <a name="executionengine">Interpreter and JIT Improvements</a>
 460 </div>
 461
 462 <div class="doc_text">
 463
 464 <ul>
 465 <li>The JIT now <a
 466 href="http://llvm.org/viewvc/llvm-project?view=rev&revision=85295">defaults
 467 to compiling eagerly</a> to avoid a race condition in the lazy JIT.
 468 Clients that still want the lazy JIT can switch it on by calling
 469 <tt>ExecutionEngine::DisableLazyCompilation(false)</tt>.</li>
 470 </ul>
 471
 472 </div>
 473
 474 <!--=========================================================================-->
 475 <div class="doc_subsection">
 476 <a name="codegen">Target Independent Code Generator Improvements</a>
 477 </div>
 478
 479 <div class="doc_text">
 480
 481 <p>We have put a significant amount of work into the code generator
 482 infrastructure, which allows us to implement more aggressive algorithms and make
 483 it run faster:</p>
 484
 485 <ul>
 486
 487 <li>...</li>
 488 </ul>
 489 </div>
 490
 491 <!--=========================================================================-->
 492 <div class="doc_subsection">
 493 <a name="x86">X86-32 and X86-64 Target Improvements</a>
 494 </div>
 495
 496 <div class="doc_text">
 497 <p>New features of the X86 target include:
 498 </p>
 499
 500 <ul>
 501
 502 <li>...</li>
 503
 504 </ul>
 505
 506 </div>
 507
 508 <!--=========================================================================-->
 509 <div class="doc_subsection">
 510 <a name="pic16">PIC16 Target Improvements</a>
 511 </div>
 512
 513 <div class="doc_text">
 514 <p>New features of the PIC16 target include:
 515 </p>
 516
 517 <ul>
 518 <li>...</li>
 519 </ul>
 520
 521 <p>Things not yet supported:</p>
 522
 523 <ul>
 524 <li>Variable arguments.</li>
 525 <li>Interrupts/programs.</li>
 526 </ul>
 527
 528 </div>
 529
 530 <!--=========================================================================-->
 531 <div class="doc_subsection">
 532 <a name="ARM">ARM Target Improvements</a>
 533 </div>
 534
 535 <div class="doc_text">
 536 <p>New features of the ARM target include:
 537 </p>
 538
 539 <ul>
 540
 541 <li>...</li>
 542 </ul>
 543
 544
 545 </div>
 546
 547 <!--=========================================================================-->
 548 <div class="doc_subsection">
 549 <a name="OtherTarget">Other Target Specific Improvements</a>
 550 </div>
 551
 552 <div class="doc_text">
 553 <p>New features of other targets include:
 554 </p>
 555
 556 <ul>
 557 <li>...</li>
 558 </ul>
 559
 560 </div>
 561
 562 <!--=========================================================================-->
 563 <div class="doc_subsection">
 564 <a name="newapis">New Useful APIs</a>
 565 </div>
 566
 567 <div class="doc_text">
 568
 569 <p>This release includes a number of new APIs that are used internally, which
 570    may also be useful for external clients.
 571 </p>
 572
 573 <ul>
 574 <li>...</li>
 575 </ul>
 576
 577
 578 </div>
 579
 580 <!--=========================================================================-->
 581 <div class="doc_subsection">
 582 <a name="otherimprovements">Other Improvements and New Features</a>
 583 </div>
 584
 585 <div class="doc_text">
 586 <p>Other miscellaneous features include:</p>
 587
 588 <ul>
 589 <li>...</li>
 590 </ul>
 591
 592 </div>
 593
 594
 595 <!--=========================================================================-->
 596 <div class="doc_subsection">
 597 <a name="changes">Major Changes and Removed Features</a>
 598 </div>
 599
 600 <div class="doc_text">
 601
 602 <p>If you're already an LLVM user or developer with out-of-tree changes based
 603 on LLVM 2.6, this section lists some "gotchas" that you may run into upgrading
 604 from the previous release.</p>
 605
 606 <ul>
 607 <li>The LLVM interpreter now defaults to <em>not</em> using <tt>libffi</tt> even
 608 if you have it installed.  This makes it more likely that an LLVM built on one
 609 system will work when copied to a similar system.  To use <tt>libffi</tt>,
 610 configure with <tt>--enable-libffi</tt>.
 611 </li>
 612 </ul>
 613
 614
 615 <p>In addition, many APIs have changed in this release.  Some of the major LLVM
 616 API changes are:</p>
 617
 618 <ul>
 619 <li><tt>ModuleProvider</tt> has been <a
 620 href="http://llvm.org/viewvc/llvm-project?view=rev&revision=94686">removed</a>
 621 and its methods moved to <tt>Module</tt> and <tt>GlobalValue</tt>.
 622 Most clients can remove uses of <tt>ExistingModuleProvider</tt>,
 623 replace <tt>getBitcodeModuleProvider</tt> with
 624 <tt>getLazyBitcodeModule</tt>, and pass their <tt>Module</tt> to
 625 functions that used to accept <tt>ModuleProvider</tt>.  Clients who
 626 wrote their own <tt>ModuleProvider</tt>s will need to derive from
 627 <tt>GVMaterializer</tt> instead and use
 628 <tt>Module::setMaterializer</tt> to attach it to a
 629 <tt>Module</tt>.</li>
 630
 631 <li><tt>GhostLinkage</tt> has given up the ghost.
 632 <tt>GlobalValue</tt>s that have not yet been read from their backing
 633 storage have the same linkage they will have after being read in.
 634 Clients must replace calls to
 635 <tt>GlobalValue::hasNotBeenReadFromBitcode</tt> with
 636 <tt>GlobalValue::isMaterializable</tt>.</li>
 637
 638 <li>FIXME: Debug info has been totally redone. Add pointers to new APIs. Substantial caveats about compatibility of .ll and .bc files.</li>
 639
 640 </ul>
 641
 642 </div>
 643
 644
 645
 646 <!-- *********************************************************************** -->
 647 <div class="doc_section">
 648   <a name="portability">Portability and Supported Platforms</a>
 649 </div>
 650 <!-- *********************************************************************** -->
 651
 652 <div class="doc_text">
 653
 654 <p>LLVM is known to work on the following platforms:</p>
 655
 656 <ul>
 657 <li>Intel and AMD machines (IA32, X86-64, AMD64, EMT-64) running Red Hat
 658     Linux, Fedora Core, FreeBSD and AuroraUX (and probably other unix-like
 659     systems).</li>
 660 <li>PowerPC and X86-based Mac OS X systems, running 10.3 and above in 32-bit
 661     and 64-bit modes.</li>
 662 <li>Intel and AMD machines running on Win32 using MinGW libraries (native).</li>
 663 <li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
 664     support is available for native builds with Visual C++).</li>
 665 <li>Sun x86 and AMD64 machines running Solaris 10, OpenSolaris 0906.</li>
 666 <li>Alpha-based machines running Debian GNU/Linux.</li>
 667 </ul>
 668
 669 <p>The core LLVM infrastructure uses GNU autoconf to adapt itself
 670 to the machine and operating system on which it is built.  However, minor
 671 porting may be required to get LLVM to work on new platforms.  We welcome your
 672 portability patches and reports of successful builds or error messages.</p>
 673
 674 </div>
 675
 676 <!-- *********************************************************************** -->
 677 <div class="doc_section">
 678   <a name="knownproblems">Known Problems</a>
 679 </div>
 680 <!-- *********************************************************************** -->
 681
 682 <div class="doc_text">
 683
 684 <p>This section contains significant known problems with the LLVM system,
 685 listed by component.  If you run into a problem, please check the <a
 686 href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
 687 there isn't already one.</p>
 688
 689 <ul>
 690 <li>The llvm-gcc bootstrap will fail with some versions of binutils (e.g. 2.15)
 691     with a message of "<tt><a href="http://llvm.org/PR5004">Error: can not do 8
 692     byte pc-relative relocation</a></tt>" when building C++ code.  We intend to
 693     fix this on mainline, but a workaround is to upgrade to binutils 2.17 or
 694     later.</li>
 695
 696 <li>LLVM will not correctly compile on Solaris and/or OpenSolaris
 697 using the stock GCC 3.x.x series 'out the box',
 698 See: <a href="GettingStarted.html#brokengcc">Broken versions of GCC and other tools</a>.
 699 However, A <a href="http://pkg.auroraux.org/GCC">Modern GCC Build</a>
 700 for x86/x86-64 has been made available from the third party AuroraUX Project
 701 that has been meticulously tested for bootstrapping LLVM &amp; Clang.</li>
 702 </ul>
 703
 704 </div>
 705
 706 <!-- ======================================================================= -->
 707 <div class="doc_subsection">
 708   <a name="experimental">Experimental features included with this release</a>
 709 </div>
 710
 711 <div class="doc_text">
 712
 713 <p>The following components of this LLVM release are either untested, known to
 714 be broken or unreliable, or are in early development.  These components should
 715 not be relied on, and bugs should not be filed against them, but they may be
 716 useful to some people.  In particular, if you would like to work on one of these
 717 components, please contact us on the <a
 718 href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p>
 719
 720 <ul>
 721 <li>The MSIL, Alpha, SPU, MIPS, PIC16, Blackfin, MSP430 and SystemZ backends are
 722     experimental.</li>
 723 <li>The <tt>llc</tt> "<tt>-filetype=asm</tt>" (the default) is the only
 724     supported value for this option.  The ELF writer is experimental.</li>
 725 <li>The implementation of Andersen's Alias Analysis has many known bugs.</li>
 726 </ul>
 727
 728 </div>
 729
 730 <!-- ======================================================================= -->
 731 <div class="doc_subsection">
 732   <a name="x86-be">Known problems with the X86 back-end</a>
 733 </div>
 734
 735 <div class="doc_text">
 736
 737 <ul>
 738   <li>The X86 backend does not yet support
 739     all <a href="http://llvm.org/PR879">inline assembly that uses the X86
 740     floating point stack</a>.  It supports the 'f' and 't' constraints, but not
 741     'u'.</li>
 742   <li>The X86 backend generates inefficient floating point code when configured
 743     to generate code for systems that don't have SSE2.</li>
 744   <li>Win64 code generation wasn't widely tested. Everything should work, but we
 745     expect small issues to happen. Also, llvm-gcc cannot build the mingw64
 746     runtime currently due
 747     to <a href="http://llvm.org/PR2255">several</a>
 748     <a href="http://llvm.org/PR2257">bugs</a> and due to lack of support for
 749     the
 750     'u' inline assembly constraint and for X87 floating point inline assembly.</li>
 751   <li>The X86-64 backend does not yet support the LLVM IR instruction
 752       <tt>va_arg</tt>. Currently, the llvm-gcc and front-ends support variadic
 753       argument constructs on X86-64 by lowering them manually.</li>
 754 </ul>
 755
 756 </div>
 757
 758 <!-- ======================================================================= -->
 759 <div class="doc_subsection">
 760   <a name="ppc-be">Known problems with the PowerPC back-end</a>
 761 </div>
 762
 763 <div class="doc_text">
 764
 765 <ul>
 766 <li>The Linux PPC32/ABI support needs testing for the interpreter and static
 767 compilation, and lacks support for debug information.</li>
 768 </ul>
 769
 770 </div>
 771
 772 <!-- ======================================================================= -->
 773 <div class="doc_subsection">
 774   <a name="arm-be">Known problems with the ARM back-end</a>
 775 </div>
 776
 777 <div class="doc_text">
 778
 779 <ul>
 780 <li>Support for the Advanced SIMD (Neon) instruction set is still incomplete
 781 and not well tested.  Some features may not work at all, and the code quality
 782 may be poor in some cases.</li>
 783 <li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
 784 processors, thumb programs can crash or produce wrong
 785 results (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
 786 <li>Compilation for ARM Linux OABI (old ABI) is supported but not fully tested.
 787 </li>
 788 </ul>
 789
 790 </div>
 791
 792 <!-- ======================================================================= -->
 793 <div class="doc_subsection">
 794   <a name="sparc-be">Known problems with the SPARC back-end</a>
 795 </div>
 796
 797 <div class="doc_text">
 798
 799 <ul>
 800 <li>The SPARC backend only supports the 32-bit SPARC ABI (-m32); it does not
 801     support the 64-bit SPARC ABI (-m64).</li>
 802 </ul>
 803
 804 </div>
 805
 806 <!-- ======================================================================= -->
 807 <div class="doc_subsection">
 808   <a name="mips-be">Known problems with the MIPS back-end</a>
 809 </div>
 810
 811 <div class="doc_text">
 812
 813 <ul>
 814 <li>64-bit MIPS targets are not supported yet.</li>
 815 </ul>
 816
 817 </div>
 818
 819 <!-- ======================================================================= -->
 820 <div class="doc_subsection">
 821   <a name="alpha-be">Known problems with the Alpha back-end</a>
 822 </div>
 823
 824 <div class="doc_text">
 825
 826 <ul>
 827
 828 <li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
 829 appropriate nops inserted to ensure restartability.</li>
 830
 831 </ul>
 832 </div>
 833
 834 <!-- ======================================================================= -->
 835 <div class="doc_subsection">
 836   <a name="c-be">Known problems with the C back-end</a>
 837 </div>
 838
 839 <div class="doc_text">
 840
 841 <ul>
 842 <li><a href="http://llvm.org/PR802">The C backend has only basic support for
 843     inline assembly code</a>.</li>
 844 <li><a href="http://llvm.org/PR1658">The C backend violates the ABI of common
 845     C++ programs</a>, preventing intermixing between C++ compiled by the CBE and
 846     C++ code compiled with <tt>llc</tt> or native compilers.</li>
 847 <li>The C backend does not support all exception handling constructs.</li>
 848 <li>The C backend does not support arbitrary precision integers.</li>
 849 </ul>
 850
 851 </div>
 852
 853
 854 <!-- ======================================================================= -->
 855 <div class="doc_subsection">
 856   <a name="c-fe">Known problems with the llvm-gcc C front-end</a>
 857 </div>
 858
 859 <div class="doc_text">
 860
 861 <p>The only major language feature of GCC not supported by llvm-gcc is
 862     the <tt>__builtin_apply</tt> family of builtins.   However, some extensions
 863     are only supported on some targets.  For example, trampolines are only
 864     supported on some targets (these are used when you take the address of a
 865     nested function).</p>
 866
 867 <p>If you run into GCC extensions which are not supported, please let us know.
 868 </p>
 869
 870 </div>
 871
 872 <!-- ======================================================================= -->
 873 <div class="doc_subsection">
 874   <a name="c++-fe">Known problems with the llvm-gcc C++ front-end</a>
 875 </div>
 876
 877 <div class="doc_text">
 878
 879 <p>The C++ front-end is considered to be fully
 880 tested and works for a number of non-trivial programs, including LLVM
 881 itself, Qt, Mozilla, etc.</p>
 882
 883 <ul>
 884 <li>Exception handling works well on the X86 and PowerPC targets. Currently
 885   only Linux and Darwin targets are supported (both 32 and 64 bit).</li>
 886 </ul>
 887
 888 </div>
 889
 890 <!-- ======================================================================= -->
 891 <div class="doc_subsection">
 892   <a name="fortran-fe">Known problems with the llvm-gcc Fortran front-end</a>
 893 </div>
 894
 895 <div class="doc_text">
 896 <ul>
 897 <li>Fortran support generally works, but there are still several unresolved bugs
 898     in <a href="http://llvm.org/bugs/">Bugzilla</a>.  Please see the
 899     tools/gfortran component for details.</li>
 900 </ul>
 901 </div>
 902
 903 <!-- ======================================================================= -->
 904 <div class="doc_subsection">
 905   <a name="ada-fe">Known problems with the llvm-gcc Ada front-end</a>
 906 </div>
 907
 908 <div class="doc_text">
 909 The llvm-gcc 4.2 Ada compiler works fairly well; however, this is not a mature
 910 technology, and problems should be expected.
 911 <ul>
 912 <li>The Ada front-end currently only builds on X86-32.  This is mainly due
 913 to lack of trampoline support (pointers to nested functions) on other platforms.
 914 However, it <a href="http://llvm.org/PR2006">also fails to build on X86-64</a>
 915 which does support trampolines.</li>
 916 <li>The Ada front-end <a href="http://llvm.org/PR2007">fails to bootstrap</a>.
 917 This is due to lack of LLVM support for <tt>setjmp</tt>/<tt>longjmp</tt> style
 918 exception handling, which is used internally by the compiler.
 919 Workaround: configure with <tt>--disable-bootstrap</tt>.</li>
 920 <li>The c380004, <a href="http://llvm.org/PR2010">c393010</a>
 921 and <a href="http://llvm.org/PR2421">cxg2021</a> ACATS tests fail
 922 (c380004 also fails with gcc-4.2 mainline).
 923 If the compiler is built with checks disabled then <a href="http://llvm.org/PR2010">c393010</a>
 924 causes the compiler to go into an infinite loop, using up all system memory.</li>
 925 <li>Some GCC specific Ada tests continue to crash the compiler.</li>
 926 <li>The <tt>-E</tt> binder option (exception backtraces)
 927 <a href="http://llvm.org/PR1982">does not work</a> and will result in programs
 928 crashing if an exception is raised.  Workaround: do not use <tt>-E</tt>.</li>
 929 <li>Only discrete types <a href="http://llvm.org/PR1981">are allowed to start
 930 or finish at a non-byte offset</a> in a record.  Workaround: do not pack records
 931 or use representation clauses that result in a field of a non-discrete type
 932 starting or finishing in the middle of a byte.</li>
 933 <li>The <tt>lli</tt> interpreter <a href="http://llvm.org/PR2009">considers
 934 'main' as generated by the Ada binder to be invalid</a>.
 935 Workaround: hand edit the file to use pointers for <tt>argv</tt> and
 936 <tt>envp</tt> rather than integers.</li>
 937 <li>The <tt>-fstack-check</tt> option <a href="http://llvm.org/PR2008">is
 938 ignored</a>.</li>
 939 </ul>
 940 </div>
 941
 942 <!-- ======================================================================= -->
 943 <div class="doc_subsection">
 944         <a name="ocaml-bindings">Known problems with the O'Caml bindings</a>
 945 </div>
 946
 947 <div class="doc_text">
 948
 949 <p>The <tt>Llvm.Linkage</tt> module is broken, and has incorrect values. Only
 950 <tt>Llvm.Linkage.External</tt>, <tt>Llvm.Linkage.Available_externally</tt>, and
 951 <tt>Llvm.Linkage.Link_once</tt> will be correct. If you need any of the other linkage
 952 modes, you'll have to write an external C library in order to expose the
 953 functionality. This has been fixed in the trunk.</p>
 954 </div>
 955
 956 <!-- *********************************************************************** -->
 957 <div class="doc_section">
 958   <a name="additionalinfo">Additional Information</a>
 959 </div>
 960 <!-- *********************************************************************** -->
 961
 962 <div class="doc_text">
 963
 964 <p>A wide variety of additional information is available on the <a
 965 href="http://llvm.org">LLVM web page</a>, in particular in the <a
 966 href="http://llvm.org/docs/">documentation</a> section.  The web page also
 967 contains versions of the API documentation which is up-to-date with the
 968 Subversion version of the source code.
 969 You can access versions of these documents specific to this release by going
 970 into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
 971
 972 <p>If you have any questions or comments about LLVM, please feel free to contact
 973 us via the <a href="http://llvm.org/docs/#maillist"> mailing
 974 lists</a>.</p>
 975
 976 </div>
 977
 978 <!-- *********************************************************************** -->
 979
 980 <hr>
 981 <address>
 982   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
 983   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
 984   <a href="http://validator.w3.org/check/referer"><img
 985   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
 986
 987   <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
 988   Last modified: $Date$
 989 </address>
 990
 991 </body>
 992 </html>