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