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.</p>
  64
  65 </div>
  66
  67
  68 <!--
  69 Almost dead code.
  70   include/llvm/Analysis/LiveValues.h => Dan
  71   lib/Transforms/IPO/MergeFunctions.cpp => consider for 2.8.
  72   llvm/Analysis/PointerTracking.h => Edwin wants this, consider for 2.8.
  73   ABCD, SCCVN, GEPSplitterPass
  74   MSIL backend?
  75 -->
  76
  77
  78 <!-- Features that need text if they're finished for 2.7:
  79   gcc plugin.
  80   strong phi elim
  81   variable debug info for optimized code
  82   postalloc scheduler: anti dependence breaking, hazard recognizer?
  83   metadata
  84   loop dependence analysis
  85   ELF Writer?  How stable?
  86   <li>PostRA scheduler improvements, ARM adoption (David Goodwin).</li>
  87   2.7 supports the GDB 7.0 jit interfaces for debug info.
  88   2.7 eliminates ADT/iterator.h
  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 <!-- *********************************************************************** -->
 102 <div class="doc_section">
 103   <a name="subproj">Sub-project Status Update</a>
 104 </div>
 105 <!-- *********************************************************************** -->
 106
 107 <div class="doc_text">
 108 <p>
 109 The LLVM 2.7 distribution currently consists of code from the core LLVM
 110 repository (which roughly includes the LLVM optimizers, code generators
 111 and supporting tools), the Clang repository and the llvm-gcc repository.  In
 112 addition to this code, the LLVM Project includes other sub-projects that are in
 113 development.  Here we include updates on these subprojects.
 114 </p>
 115
 116 </div>
 117
 118
 119 <!--=========================================================================-->
 120 <div class="doc_subsection">
 121 <a name="clang">Clang: C/C++/Objective-C Frontend Toolkit</a>
 122 </div>
 123
 124 <div class="doc_text">
 125
 126 <p>The <a href="http://clang.llvm.org/">Clang project</a> is ...</p>
 127
 128 <p>In the LLVM 2.7 time-frame, the Clang team has made many improvements:</p>
 129
 130 <ul>
 131 <li>...</li>
 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 Need update.
 314 <!--
 315 <a href="http://pure-lang.googlecode.com/">Pure</a>
 316 is an algebraic/functional programming language based on term rewriting.
 317 Programs are collections of equations which are used to evaluate expressions in
 318 a symbolic fashion. Pure offers dynamic typing, eager and lazy evaluation,
 319 lexical closures, a hygienic macro system (also based on term rewriting),
 320 built-in list and matrix support (including list and matrix comprehensions) and
 321 an easy-to-use C interface. The interpreter uses LLVM as a backend to
 322  JIT-compile Pure programs to fast native code.</p>
 323
 324 <p>Pure versions ??? and later have been tested and are known to work with
 325 LLVM 2.7 (and continue to work with older LLVM releases >= 2.3 as well).
 326 --></p>
 327 </div>
 328
 329
 330 <!--=========================================================================-->
 331 <div class="doc_subsection">
 332 <a name="ldc">LLVM D Compiler</a>
 333 </div>
 334
 335 <div class="doc_text">
 336 <p>
 337 Need update.
 338 <!--
 339 <a href="http://www.dsource.org/projects/ldc">LDC</a> is an implementation of
 340 the D Programming Language using the LLVM optimizer and code generator.
 341 The LDC project works great with the LLVM 2.6 release.  General improvements in
 342 this
 343 cycle have included new inline asm constraint handling, better debug info
 344 support, general bug fixes and better x86-64 support.  This has allowed
 345 some major improvements in LDC, getting it much closer to being as
 346 fully featured as the original DMD compiler from DigitalMars.-->
 347 </p>
 348 </div>
 349
 350 <!--=========================================================================-->
 351 <div class="doc_subsection">
 352 <a name="RoadsendPHP">Roadsend PHP</a>
 353 </div>
 354
 355 <div class="doc_text">
 356 <p>
 357 Need update.
 358 <!--
 359 <a href="http://code.roadsend.com/rphp">Roadsend PHP</a> (rphp) is an open
 360 source implementation of the PHP programming
 361 language that uses LLVM for its optimizer, JIT and static compiler. This is a
 362 reimplementation of an earlier project that is now based on LLVM.
 363 --> </p>
 364 </div>
 365
 366 <!--=========================================================================-->
 367 <div class="doc_subsection">
 368 <a name="UnladenSwallow">Unladen Swallow</a>
 369 </div>
 370
 371 <div class="doc_text">
 372 <p>
 373 Need update.
 374 <!--
 375 <a href="http://code.google.com/p/unladen-swallow/">Unladen Swallow</a> is a
 376 branch of <a href="http://python.org/">Python</a> intended to be fully
 377 compatible and significantly faster.  It uses LLVM's optimization passes and JIT
 378 compiler.-->
 379 </p>
 380 </div>
 381
 382 <!--=========================================================================-->
 383 <div class="doc_subsection">
 384 <a name="llvm-lua">llvm-lua</a>
 385 </div>
 386
 387 <div class="doc_text">
 388 <p>
 389 Need update.
 390 <!--
 391 <a href="http://code.google.com/p/llvm-lua/">LLVM-Lua</a> uses LLVM to add JIT
 392 and static compiling support to the Lua VM.  Lua bytecode is analyzed to
 393 remove type checks, then LLVM is used to compile the bytecode down to machine
 394 code.-->
 395 </p>
 396 </div>
 397
 398 <!--=========================================================================-->
 399 <div class="doc_subsection">
 400 <a name="icedtea">IcedTea Java Virtual Machine Implementation</a>
 401 </div>
 402
 403 <div class="doc_text">
 404 <p>
 405 Need update.
 406 <!--
 407 <a href="http://icedtea.classpath.org/wiki/Main_Page">IcedTea</a> provides a
 408 harness to build OpenJDK using only free software build tools and to provide
 409 replacements for the not-yet free parts of OpenJDK.  One of the extensions that
 410 IcedTea provides is a new JIT compiler named <a
 411 href="http://icedtea.classpath.org/wiki/ZeroSharkFaq">Shark</a> which uses LLVM
 412 to provide native code generation without introducing processor-dependent
 413 code.-->
 414 </p>
 415 </div>
 416
 417
 418
 419 <!-- *********************************************************************** -->
 420 <div class="doc_section">
 421   <a name="whatsnew">What's New in LLVM 2.7?</a>
 422 </div>
 423 <!-- *********************************************************************** -->
 424
 425 <div class="doc_text">
 426
 427 <p>This release includes a huge number of bug fixes, performance tweaks and
 428 minor improvements.  Some of the major improvements and new features are listed
 429 in this section.
 430 </p>
 431
 432 </div>
 433
 434 <!--=========================================================================-->
 435 <div class="doc_subsection">
 436 <a name="majorfeatures">Major New Features</a>
 437 </div>
 438
 439 <div class="doc_text">
 440
 441 <p>LLVM 2.7 includes several major new capabilities:</p>
 442
 443 <ul>
 444 <li>...</li>
 445 </ul>
 446
 447 Extensible metadata solid.
 448
 449 Debug info improvements: using metadata instead of llvm.dbg global variables.
 450 This brings several enhancements including improved compile times.
 451
 452 New instruction selector.
 453 GHC Haskell ABI/ calling conv support.
 454 Pre-Alpha support for unions in IR.
 455 New InlineHint and StackAlignment function attributes
 456 Code generator MC'ized except for debug info and EH.
 457 New SCEV AA pass: -scev-aa
 458 Inliner reuses arrays allocas when inlining multiple callers to reduce stack usage.
 459 MC encoding and disassembler apis.
 460 Optimal Edge Profiling?
 461 Instcombine is now a library, has its own IRBuilder to simplify itself.
 462 New llvm/Support/Regex.h API.  FileCheck now does regex's
 463
 464
 465
 466
 467 AndersAA got removed (from 2.7 or mainline?)
 468 LLVM command line tools now overwrite their output, before they would only do this with -f.
 469 DOUT removed, use DEBUG(errs() instead.
 470 Much stuff converted to use raw_ostream instead of std::ostream.
 471 TargetAsmInfo renamed to MCAsmInfo
 472 llvm/ADT/iterator.h gone.
 473
 474 </div>
 475
 476 <!--=========================================================================-->
 477 <div class="doc_subsection">
 478 <a name="coreimprovements">LLVM IR and Core Improvements</a>
 479 </div>
 480
 481 <div class="doc_text">
 482 <p>LLVM IR has several new features for better support of new targets and that
 483 expose new optimization opportunities:</p>
 484
 485 <ul>
 486 <li>...</li>
 487 </ul>
 488
 489 </div>
 490
 491 <!--=========================================================================-->
 492 <div class="doc_subsection">
 493 <a name="optimizer">Optimizer Improvements</a>
 494 </div>
 495
 496 <div class="doc_text">
 497
 498 <p>In addition to a large array of minor performance tweaks and bug fixes, this
 499 release includes a few major enhancements and additions to the optimizers:</p>
 500
 501 <ul>
 502
 503 <li>...</li>
 504
 505 </ul>
 506
 507 <p>Also, -anders-aa was removed</p>
 508
 509 </div>
 510
 511
 512 <!--=========================================================================-->
 513 <div class="doc_subsection">
 514 <a name="executionengine">Interpreter and JIT Improvements</a>
 515 </div>
 516
 517 <div class="doc_text">
 518
 519 <ul>
 520 <li>The JIT now <a
 521 href="http://llvm.org/viewvc/llvm-project?view=rev&revision=85295">defaults
 522 to compiling eagerly</a> to avoid a race condition in the lazy JIT.
 523 Clients that still want the lazy JIT can switch it on by calling
 524 <tt>ExecutionEngine::DisableLazyCompilation(false)</tt>.</li>
 525 <li>It is now possible to create more than one JIT instance in the same process.
 526 These JITs can generate machine code in parallel,
 527 although <a href="http://llvm.org/docs/ProgrammersManual.html#jitthreading">you
 528 still have to obey the other threading restrictions</a>.</li>
 529 </ul>
 530
 531 </div>
 532
 533 <!--=========================================================================-->
 534 <div class="doc_subsection">
 535 <a name="codegen">Target Independent Code Generator Improvements</a>
 536 </div>
 537
 538 <div class="doc_text">
 539
 540 <p>We have put a significant amount of work into the code generator
 541 infrastructure, which allows us to implement more aggressive algorithms and make
 542 it run faster:</p>
 543
 544 <ul>
 545
 546 <li>...</li>
 547 </ul>
 548 </div>
 549
 550 <!--=========================================================================-->
 551 <div class="doc_subsection">
 552 <a name="x86">X86-32 and X86-64 Target Improvements</a>
 553 </div>
 554
 555 <div class="doc_text">
 556 <p>New features of the X86 target include:
 557 </p>
 558
 559 <ul>
 560
 561 <li>...</li>
 562
 563 </ul>
 564
 565 </div>
 566
 567 <!--=========================================================================-->
 568 <div class="doc_subsection">
 569 <a name="pic16">PIC16 Target Improvements</a>
 570 </div>
 571
 572 <div class="doc_text">
 573 <p>New features of the PIC16 target include:
 574 </p>
 575
 576 <ul>
 577 <li>...</li>
 578 </ul>
 579
 580 <p>Things not yet supported:</p>
 581
 582 <ul>
 583 <li>Variable arguments.</li>
 584 <li>Interrupts/programs.</li>
 585 </ul>
 586
 587 </div>
 588
 589 <!--=========================================================================-->
 590 <div class="doc_subsection">
 591 <a name="ARM">ARM Target Improvements</a>
 592 </div>
 593
 594 <div class="doc_text">
 595 <p>New features of the ARM target include:
 596 </p>
 597
 598 <ul>
 599
 600 <li>...</li>
 601 </ul>
 602
 603
 604 </div>
 605
 606 <!--=========================================================================-->
 607 <div class="doc_subsection">
 608 <a name="OtherTarget">Other Target Specific Improvements</a>
 609 </div>
 610
 611 <div class="doc_text">
 612 <p>New features of other targets include:
 613 </p>
 614
 615 <ul>
 616 <li>...</li>
 617 </ul>
 618
 619 </div>
 620
 621 <!--=========================================================================-->
 622 <div class="doc_subsection">
 623 <a name="newapis">New Useful APIs</a>
 624 </div>
 625
 626 <div class="doc_text">
 627
 628 <p>This release includes a number of new APIs that are used internally, which
 629    may also be useful for external clients.
 630 </p>
 631
 632 <ul>
 633 <li>...</li>
 634 </ul>
 635
 636
 637 </div>
 638
 639 <!--=========================================================================-->
 640 <div class="doc_subsection">
 641 <a name="otherimprovements">Other Improvements and New Features</a>
 642 </div>
 643
 644 <div class="doc_text">
 645 <p>Other miscellaneous features include:</p>
 646
 647 <ul>
 648 <li>...</li>
 649 </ul>
 650
 651 </div>
 652
 653
 654 <!--=========================================================================-->
 655 <div class="doc_subsection">
 656 <a name="changes">Major Changes and Removed Features</a>
 657 </div>
 658
 659 <div class="doc_text">
 660
 661 <p>If you're already an LLVM user or developer with out-of-tree changes based
 662 on LLVM 2.6, this section lists some "gotchas" that you may run into upgrading
 663 from the previous release.</p>
 664
 665 <ul>
 666 <li>The LLVM interpreter now defaults to <em>not</em> using <tt>libffi</tt> even
 667 if you have it installed.  This makes it more likely that an LLVM built on one
 668 system will work when copied to a similar system.  To use <tt>libffi</tt>,
 669 configure with <tt>--enable-libffi</tt>.
 670 </li>
 671 </ul>
 672
 673
 674 <p>In addition, many APIs have changed in this release.  Some of the major LLVM
 675 API changes are:</p>
 676
 677 <ul>
 678 <li><tt>ModuleProvider</tt> has been <a
 679 href="http://llvm.org/viewvc/llvm-project?view=rev&revision=94686">removed</a>
 680 and its methods moved to <tt>Module</tt> and <tt>GlobalValue</tt>.
 681 Most clients can remove uses of <tt>ExistingModuleProvider</tt>,
 682 replace <tt>getBitcodeModuleProvider</tt> with
 683 <tt>getLazyBitcodeModule</tt>, and pass their <tt>Module</tt> to
 684 functions that used to accept <tt>ModuleProvider</tt>.  Clients who
 685 wrote their own <tt>ModuleProvider</tt>s will need to derive from
 686 <tt>GVMaterializer</tt> instead and use
 687 <tt>Module::setMaterializer</tt> to attach it to a
 688 <tt>Module</tt>.</li>
 689
 690 <li><tt>GhostLinkage</tt> has given up the ghost.
 691 <tt>GlobalValue</tt>s that have not yet been read from their backing
 692 storage have the same linkage they will have after being read in.
 693 Clients must replace calls to
 694 <tt>GlobalValue::hasNotBeenReadFromBitcode</tt> with
 695 <tt>GlobalValue::isMaterializable</tt>.</li>
 696
 697 <li>FIXME: Debug info has been totally redone. Add pointers to new APIs. Substantial caveats about compatibility of .ll and .bc files.</li>
 698
 699 <li>The <tt>llvm/Support/DataTypes.h</tt> header has moved
 700 to <tt>llvm/System/DataTypes.h</tt>.</li>
 701
 702 <li>The <tt>isInteger</tt>, <tt>isIntOrIntVector</tt>, <tt>isFloatingPoint</tt>,
 703 <tt>isFPOrFPVector</tt> and <tt>isFPOrFPVector</tt> methods have been renamed
 704 <tt>isIntegerTy</tt>, <tt>isIntOrIntVectorTy</tt>, <tt>isFloatingPointTy</tt>,
 705 <tt>isFPOrFPVectorTy</tt> and <tt>isFPOrFPVectorTy</tt> respectively.</li>
 706 </ul>
 707
 708 </div>
 709
 710
 711
 712 <!-- *********************************************************************** -->
 713 <div class="doc_section">
 714   <a name="portability">Portability and Supported Platforms</a>
 715 </div>
 716 <!-- *********************************************************************** -->
 717
 718 <div class="doc_text">
 719
 720 <p>LLVM is known to work on the following platforms:</p>
 721
 722 <ul>
 723 <li>Intel and AMD machines (IA32, X86-64, AMD64, EMT-64) running Red Hat
 724     Linux, Fedora Core, FreeBSD and AuroraUX (and probably other unix-like
 725     systems).</li>
 726 <li>PowerPC and X86-based Mac OS X systems, running 10.3 and above in 32-bit
 727     and 64-bit modes.</li>
 728 <li>Intel and AMD machines running on Win32 using MinGW libraries (native).</li>
 729 <li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
 730     support is available for native builds with Visual C++).</li>
 731 <li>Sun x86 and AMD64 machines running Solaris 10, OpenSolaris 0906.</li>
 732 <li>Alpha-based machines running Debian GNU/Linux.</li>
 733 </ul>
 734
 735 <p>The core LLVM infrastructure uses GNU autoconf to adapt itself
 736 to the machine and operating system on which it is built.  However, minor
 737 porting may be required to get LLVM to work on new platforms.  We welcome your
 738 portability patches and reports of successful builds or error messages.</p>
 739
 740 </div>
 741
 742 <!-- *********************************************************************** -->
 743 <div class="doc_section">
 744   <a name="knownproblems">Known Problems</a>
 745 </div>
 746 <!-- *********************************************************************** -->
 747
 748 <div class="doc_text">
 749
 750 <p>This section contains significant known problems with the LLVM system,
 751 listed by component.  If you run into a problem, please check the <a
 752 href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
 753 there isn't already one.</p>
 754
 755 <ul>
 756 <li>The llvm-gcc bootstrap will fail with some versions of binutils (e.g. 2.15)
 757     with a message of "<tt><a href="http://llvm.org/PR5004">Error: can not do 8
 758     byte pc-relative relocation</a></tt>" when building C++ code.  We intend to
 759     fix this on mainline, but a workaround is to upgrade to binutils 2.17 or
 760     later.</li>
 761
 762 <li>LLVM will not correctly compile on Solaris and/or OpenSolaris
 763 using the stock GCC 3.x.x series 'out the box',
 764 See: <a href="GettingStarted.html#brokengcc">Broken versions of GCC and other tools</a>.
 765 However, A <a href="http://pkg.auroraux.org/GCC">Modern GCC Build</a>
 766 for x86/x86-64 has been made available from the third party AuroraUX Project
 767 that has been meticulously tested for bootstrapping LLVM &amp; Clang.</li>
 768 </ul>
 769
 770 </div>
 771
 772 <!-- ======================================================================= -->
 773 <div class="doc_subsection">
 774   <a name="experimental">Experimental features included with this release</a>
 775 </div>
 776
 777 <div class="doc_text">
 778
 779 <p>The following components of this LLVM release are either untested, known to
 780 be broken or unreliable, or are in early development.  These components should
 781 not be relied on, and bugs should not be filed against them, but they may be
 782 useful to some people.  In particular, if you would like to work on one of these
 783 components, please contact us on the <a
 784 href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p>
 785
 786 <ul>
 787 <li>The MSIL, Alpha, SPU, MIPS, PIC16, Blackfin, MSP430 and SystemZ backends are
 788     experimental.</li>
 789 <li>The <tt>llc</tt> "<tt>-filetype=asm</tt>" (the default) is the only
 790     supported value for this option.  The MachO writer is experimental, and
 791     works much better in mainline SVN.</li>
 792 </ul>
 793
 794 </div>
 795
 796 <!-- ======================================================================= -->
 797 <div class="doc_subsection">
 798   <a name="x86-be">Known problems with the X86 back-end</a>
 799 </div>
 800
 801 <div class="doc_text">
 802
 803 <ul>
 804   <li>The X86 backend does not yet support
 805     all <a href="http://llvm.org/PR879">inline assembly that uses the X86
 806     floating point stack</a>.  It supports the 'f' and 't' constraints, but not
 807     'u'.</li>
 808   <li>The X86 backend generates inefficient floating point code when configured
 809     to generate code for systems that don't have SSE2.</li>
 810   <li>Win64 code generation wasn't widely tested. Everything should work, but we
 811     expect small issues to happen. Also, llvm-gcc cannot build the mingw64
 812     runtime currently due
 813     to <a href="http://llvm.org/PR2255">several</a>
 814     <a href="http://llvm.org/PR2257">bugs</a> and due to lack of support for
 815     the
 816     'u' inline assembly constraint and for X87 floating point inline assembly.</li>
 817   <li>The X86-64 backend does not yet support the LLVM IR instruction
 818       <tt>va_arg</tt>. Currently, the llvm-gcc and front-ends support variadic
 819       argument constructs on X86-64 by lowering them manually.</li>
 820 </ul>
 821
 822 </div>
 823
 824 <!-- ======================================================================= -->
 825 <div class="doc_subsection">
 826   <a name="ppc-be">Known problems with the PowerPC back-end</a>
 827 </div>
 828
 829 <div class="doc_text">
 830
 831 <ul>
 832 <li>The Linux PPC32/ABI support needs testing for the interpreter and static
 833 compilation, and lacks support for debug information.</li>
 834 </ul>
 835
 836 </div>
 837
 838 <!-- ======================================================================= -->
 839 <div class="doc_subsection">
 840   <a name="arm-be">Known problems with the ARM back-end</a>
 841 </div>
 842
 843 <div class="doc_text">
 844
 845 <ul>
 846 <li>Support for the Advanced SIMD (Neon) instruction set is still incomplete
 847 and not well tested.  Some features may not work at all, and the code quality
 848 may be poor in some cases.</li>
 849 <li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
 850 processors, thumb programs can crash or produce wrong
 851 results (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
 852 <li>Compilation for ARM Linux OABI (old ABI) is supported but not fully tested.
 853 </li>
 854 </ul>
 855
 856 </div>
 857
 858 <!-- ======================================================================= -->
 859 <div class="doc_subsection">
 860   <a name="sparc-be">Known problems with the SPARC back-end</a>
 861 </div>
 862
 863 <div class="doc_text">
 864
 865 <ul>
 866 <li>The SPARC backend only supports the 32-bit SPARC ABI (-m32); it does not
 867     support the 64-bit SPARC ABI (-m64).</li>
 868 </ul>
 869
 870 </div>
 871
 872 <!-- ======================================================================= -->
 873 <div class="doc_subsection">
 874   <a name="mips-be">Known problems with the MIPS back-end</a>
 875 </div>
 876
 877 <div class="doc_text">
 878
 879 <ul>
 880 <li>64-bit MIPS targets are not supported yet.</li>
 881 </ul>
 882
 883 </div>
 884
 885 <!-- ======================================================================= -->
 886 <div class="doc_subsection">
 887   <a name="alpha-be">Known problems with the Alpha back-end</a>
 888 </div>
 889
 890 <div class="doc_text">
 891
 892 <ul>
 893
 894 <li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
 895 appropriate nops inserted to ensure restartability.</li>
 896
 897 </ul>
 898 </div>
 899
 900 <!-- ======================================================================= -->
 901 <div class="doc_subsection">
 902   <a name="c-be">Known problems with the C back-end</a>
 903 </div>
 904
 905 <div class="doc_text">
 906
 907 <ul>
 908 <li><a href="http://llvm.org/PR802">The C backend has only basic support for
 909     inline assembly code</a>.</li>
 910 <li><a href="http://llvm.org/PR1658">The C backend violates the ABI of common
 911     C++ programs</a>, preventing intermixing between C++ compiled by the CBE and
 912     C++ code compiled with <tt>llc</tt> or native compilers.</li>
 913 <li>The C backend does not support all exception handling constructs.</li>
 914 <li>The C backend does not support arbitrary precision integers.</li>
 915 </ul>
 916
 917 </div>
 918
 919
 920 <!-- ======================================================================= -->
 921 <div class="doc_subsection">
 922   <a name="c-fe">Known problems with the llvm-gcc C and C++ front-end</a>
 923 </div>
 924
 925 <div class="doc_text">
 926
 927 <p>The only major language feature of GCC not supported by llvm-gcc is
 928     the <tt>__builtin_apply</tt> family of builtins.   However, some extensions
 929     are only supported on some targets.  For example, trampolines are only
 930     supported on some targets (these are used when you take the address of a
 931     nested function).</p>
 932
 933 <p>If you run into GCC extensions which are not supported, please let us know.
 934 </p>
 935
 936 </div>
 937
 938 <!-- ======================================================================= -->
 939 <div class="doc_subsection">
 940   <a name="fortran-fe">Known problems with the llvm-gcc Fortran front-end</a>
 941 </div>
 942
 943 <div class="doc_text">
 944 <ul>
 945 <li>Fortran support generally works, but there are still several unresolved bugs
 946     in <a href="http://llvm.org/bugs/">Bugzilla</a>.  Please see the
 947     tools/gfortran component for details.</li>
 948 </ul>
 949 </div>
 950
 951 <!-- ======================================================================= -->
 952 <div class="doc_subsection">
 953   <a name="ada-fe">Known problems with the llvm-gcc Ada front-end</a>
 954 </div>
 955
 956 <div class="doc_text">
 957 The llvm-gcc 4.2 Ada compiler works fairly well; however, this is not a mature
 958 technology, and problems should be expected.
 959 <ul>
 960 <li>The Ada front-end currently only builds on X86-32.  This is mainly due
 961 to lack of trampoline support (pointers to nested functions) on other platforms.
 962 However, it <a href="http://llvm.org/PR2006">also fails to build on X86-64</a>
 963 which does support trampolines.</li>
 964 <li>The Ada front-end <a href="http://llvm.org/PR2007">fails to bootstrap</a>.
 965 This is due to lack of LLVM support for <tt>setjmp</tt>/<tt>longjmp</tt> style
 966 exception handling, which is used internally by the compiler.
 967 Workaround: configure with <tt>--disable-bootstrap</tt>.</li>
 968 <li>The c380004, <a href="http://llvm.org/PR2010">c393010</a>
 969 and <a href="http://llvm.org/PR2421">cxg2021</a> ACATS tests fail
 970 (c380004 also fails with gcc-4.2 mainline).
 971 If the compiler is built with checks disabled then <a href="http://llvm.org/PR2010">c393010</a>
 972 causes the compiler to go into an infinite loop, using up all system memory.</li>
 973 <li>Some GCC specific Ada tests continue to crash the compiler.</li>
 974 <li>The <tt>-E</tt> binder option (exception backtraces)
 975 <a href="http://llvm.org/PR1982">does not work</a> and will result in programs
 976 crashing if an exception is raised.  Workaround: do not use <tt>-E</tt>.</li>
 977 <li>Only discrete types <a href="http://llvm.org/PR1981">are allowed to start
 978 or finish at a non-byte offset</a> in a record.  Workaround: do not pack records
 979 or use representation clauses that result in a field of a non-discrete type
 980 starting or finishing in the middle of a byte.</li>
 981 <li>The <tt>lli</tt> interpreter <a href="http://llvm.org/PR2009">considers
 982 'main' as generated by the Ada binder to be invalid</a>.
 983 Workaround: hand edit the file to use pointers for <tt>argv</tt> and
 984 <tt>envp</tt> rather than integers.</li>
 985 <li>The <tt>-fstack-check</tt> option <a href="http://llvm.org/PR2008">is
 986 ignored</a>.</li>
 987 </ul>
 988 </div>
 989
 990 <!-- ======================================================================= -->
 991 <div class="doc_subsection">
 992         <a name="ocaml-bindings">Known problems with the O'Caml bindings</a>
 993 </div>
 994
 995 <div class="doc_text">
 996
 997 <p>The <tt>Llvm.Linkage</tt> module is broken, and has incorrect values. Only
 998 <tt>Llvm.Linkage.External</tt>, <tt>Llvm.Linkage.Available_externally</tt>, and
 999 <tt>Llvm.Linkage.Link_once</tt> will be correct. If you need any of the other linkage
1000 modes, you'll have to write an external C library in order to expose the
1001 functionality. This has been fixed in the trunk.</p>
1002 </div>
1003
1004 <!-- *********************************************************************** -->
1005 <div class="doc_section">
1006   <a name="additionalinfo">Additional Information</a>
1007 </div>
1008 <!-- *********************************************************************** -->
1009
1010 <div class="doc_text">
1011
1012 <p>A wide variety of additional information is available on the <a
1013 href="http://llvm.org">LLVM web page</a>, in particular in the <a
1014 href="http://llvm.org/docs/">documentation</a> section.  The web page also
1015 contains versions of the API documentation which is up-to-date with the
1016 Subversion version of the source code.
1017 You can access versions of these documents specific to this release by going
1018 into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
1019
1020 <p>If you have any questions or comments about LLVM, please feel free to contact
1021 us via the <a href="http://llvm.org/docs/#maillist"> mailing
1022 lists</a>.</p>
1023
1024 </div>
1025
1026 <!-- *********************************************************************** -->
1027
1028 <hr>
1029 <address>
1030   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
1031   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
1032   <a href="http://validator.w3.org/check/referer"><img
1033   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
1034
1035   <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
1036   Last modified: $Date$
1037 </address>
1038
1039 </body>
1040 </html>