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