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