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