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_subsection">
 461 <a name="safecode">SAFECode Compiler</a>
 462 </div>
 463
 464 <div class="doc_text">
 465 <p>
 466 <a href="http://safecode.cs.illinois.edu">SAFECode</a> is a memory safe C
 467 compiler built using LLVM.  It takes standard, unannotated C code, analyzes the
 468 code to ensure that memory accesses and array indexing operations are safe, and
 469 instruments the code with run-time checks when safety cannot be proven
 470 statically.
 471 </p>
 472 </div>
 473
 474
 475 <!-- *********************************************************************** -->
 476 <div class="doc_section">
 477   <a name="whatsnew">What's New in LLVM 2.7?</a>
 478 </div>
 479 <!-- *********************************************************************** -->
 480
 481 <div class="doc_text">
 482
 483 <p>This release includes a huge number of bug fixes, performance tweaks and
 484 minor improvements.  Some of the major improvements and new features are listed
 485 in this section.
 486 </p>
 487
 488 </div>
 489
 490 <!--=========================================================================-->
 491 <div class="doc_subsection">
 492 <a name="majorfeatures">Major New Features</a>
 493 </div>
 494
 495 <div class="doc_text">
 496
 497 <p>LLVM 2.7 includes several major new capabilities:</p>
 498
 499 <ul>
 500 <li>...</li>
 501 </ul>
 502
 503 Extensible metadata solid.
 504
 505 Debug info improvements: using metadata instead of llvm.dbg global variables.
 506 This brings several enhancements including improved compile times.
 507
 508 New instruction selector.
 509 GHC Haskell ABI/ calling conv support.
 510 Pre-Alpha support for unions in IR.
 511 New InlineHint and StackAlignment function attributes
 512 Code generator MC'ized except for debug info and EH.
 513 New SCEV AA pass: -scev-aa
 514 Inliner reuses arrays allocas when inlining multiple callers to reduce stack usage.
 515 MC encoding and disassembler apis.
 516 Optimal Edge Profiling?
 517 Instcombine is now a library, has its own IRBuilder to simplify itself.
 518 New llvm/Support/Regex.h API.  FileCheck now does regex's
 519 Many subtle pointer invalidation bugs in Callgraph have been fixed and it now uses asserting value handles.
 520 MC Disassembler (with blog post), MCInstPrinter.  Many X86 backend and AsmPrinter simplifications
 521 Various tools like llc and opt now read either .ll or .bc files as input.
 522 Malloc and free instructions got removed, along with LowerAllocations pass.
 523 compiler-rt support for ARM.
 524 completely llvm-gcc NEON support.
 525 Can transcode from GAS to intel syntax with "llvm-mc foo.s -output-asm-variant=1"
 526 JIT debug information with GDB 7.0
 527 New CodeGen Level CSE
 528 CMake can now run tests, what other improvements?
 529 ARM/Thumb using reg scavenging for stack object address materialization (PEI).
 530 New SSAUpdater and MachineSSAUpdater classes for unstructured ssa updating,
 531   changed jump threading, GVN, etc to use it which simplified them and speed
 532   them up.
 533 Combiner-AA improvements, why not on by default?
 534 Pre-regalloc tail duplication
 535 x86 sibcall optimization
 536 New LSR with full strength reduction mode
 537 The most awesome sext / zext optimization pass. ?
 538
 539 The ARM backend now has good support for ARMv4 backend (tested on StrongARM
 540   hardware), previously only supported ARMv4T and newer.
 541
 542
 543
 544 Defaults to RTTI off, packagers should build with make REQUIRE_RTTI=1.
 545 CondProp pass removed (functionality merged into jump threading).
 546 AndersAA got removed (from 2.7 or mainline?)
 547 PredSimplify, LoopVR, GVNPRE got removed.
 548 LLVM command line tools now overwrite their output, before they would only do this with -f.
 549 DOUT removed, use DEBUG(errs() instead.
 550 Much stuff converted to use raw_ostream instead of std::ostream.
 551 TargetAsmInfo renamed to MCAsmInfo
 552 llvm/ADT/iterator.h gone.
 553
 554
 555 </div>
 556
 557 <!--=========================================================================-->
 558 <div class="doc_subsection">
 559 <a name="coreimprovements">LLVM IR and Core Improvements</a>
 560 </div>
 561
 562 <div class="doc_text">
 563 <p>LLVM IR has several new features for better support of new targets and that
 564 expose new optimization opportunities:</p>
 565
 566 <ul>
 567 <li>...</li>
 568 </ul>
 569
 570 </div>
 571
 572 <!--=========================================================================-->
 573 <div class="doc_subsection">
 574 <a name="optimizer">Optimizer Improvements</a>
 575 </div>
 576
 577 <div class="doc_text">
 578
 579 <p>In addition to a large array of minor performance tweaks and bug fixes, this
 580 release includes a few major enhancements and additions to the optimizers:</p>
 581
 582 <ul>
 583
 584 <li>...</li>
 585
 586 </ul>
 587
 588 <p>Also, -anders-aa was removed</p>
 589
 590 </div>
 591
 592
 593 <!--=========================================================================-->
 594 <div class="doc_subsection">
 595 <a name="executionengine">Interpreter and JIT Improvements</a>
 596 </div>
 597
 598 <div class="doc_text">
 599
 600 <ul>
 601 <li>The JIT now <a
 602 href="http://llvm.org/viewvc/llvm-project?view=rev&revision=85295">defaults
 603 to compiling eagerly</a> to avoid a race condition in the lazy JIT.
 604 Clients that still want the lazy JIT can switch it on by calling
 605 <tt>ExecutionEngine::DisableLazyCompilation(false)</tt>.</li>
 606 <li>It is now possible to create more than one JIT instance in the same process.
 607 These JITs can generate machine code in parallel,
 608 although <a href="http://llvm.org/docs/ProgrammersManual.html#jitthreading">you
 609 still have to obey the other threading restrictions</a>.</li>
 610 </ul>
 611
 612 </div>
 613
 614 <!--=========================================================================-->
 615 <div class="doc_subsection">
 616 <a name="codegen">Target Independent Code Generator Improvements</a>
 617 </div>
 618
 619 <div class="doc_text">
 620
 621 <p>We have put a significant amount of work into the code generator
 622 infrastructure, which allows us to implement more aggressive algorithms and make
 623 it run faster:</p>
 624
 625 <ul>
 626
 627 <li>...</li>
 628 </ul>
 629 </div>
 630
 631 <!--=========================================================================-->
 632 <div class="doc_subsection">
 633 <a name="x86">X86-32 and X86-64 Target Improvements</a>
 634 </div>
 635
 636 <div class="doc_text">
 637 <p>New features of the X86 target include:
 638 </p>
 639
 640 <ul>
 641
 642 <li>...</li>
 643
 644 </ul>
 645
 646 </div>
 647
 648 <!--=========================================================================-->
 649 <div class="doc_subsection">
 650 <a name="pic16">PIC16 Target Improvements</a>
 651 </div>
 652
 653 <div class="doc_text">
 654 <p>New features of the PIC16 target include:
 655 </p>
 656
 657 <ul>
 658 <li>...</li>
 659 </ul>
 660
 661 <p>Things not yet supported:</p>
 662
 663 <ul>
 664 <li>Variable arguments.</li>
 665 <li>Interrupts/programs.</li>
 666 </ul>
 667
 668 </div>
 669
 670 <!--=========================================================================-->
 671 <div class="doc_subsection">
 672 <a name="ARM">ARM Target Improvements</a>
 673 </div>
 674
 675 <div class="doc_text">
 676 <p>New features of the ARM target include:
 677 </p>
 678
 679 <ul>
 680
 681 <li>...</li>
 682 </ul>
 683
 684
 685 </div>
 686
 687 <!--=========================================================================-->
 688 <div class="doc_subsection">
 689 <a name="OtherTarget">Other Target Specific Improvements</a>
 690 </div>
 691
 692 <div class="doc_text">
 693 <p>New features of other targets include:
 694 </p>
 695
 696 <ul>
 697 <li>...</li>
 698 </ul>
 699
 700 </div>
 701
 702 <!--=========================================================================-->
 703 <div class="doc_subsection">
 704 <a name="newapis">New Useful APIs</a>
 705 </div>
 706
 707 <div class="doc_text">
 708
 709 <p>This release includes a number of new APIs that are used internally, which
 710    may also be useful for external clients.
 711 </p>
 712
 713 <ul>
 714 <li>...</li>
 715 </ul>
 716
 717
 718 </div>
 719
 720 <!--=========================================================================-->
 721 <div class="doc_subsection">
 722 <a name="otherimprovements">Other Improvements and New Features</a>
 723 </div>
 724
 725 <div class="doc_text">
 726 <p>Other miscellaneous features include:</p>
 727
 728 <ul>
 729 <li>...</li>
 730 </ul>
 731
 732 </div>
 733
 734
 735 <!--=========================================================================-->
 736 <div class="doc_subsection">
 737 <a name="changes">Major Changes and Removed Features</a>
 738 </div>
 739
 740 <div class="doc_text">
 741
 742 <p>If you're already an LLVM user or developer with out-of-tree changes based
 743 on LLVM 2.6, this section lists some "gotchas" that you may run into upgrading
 744 from the previous release.</p>
 745
 746 <ul>
 747 <li>The LLVM interpreter now defaults to <em>not</em> using <tt>libffi</tt> even
 748 if you have it installed.  This makes it more likely that an LLVM built on one
 749 system will work when copied to a similar system.  To use <tt>libffi</tt>,
 750 configure with <tt>--enable-libffi</tt>.
 751 </li>
 752 </ul>
 753
 754
 755 <p>In addition, many APIs have changed in this release.  Some of the major LLVM
 756 API changes are:</p>
 757
 758 <ul>
 759 <li><tt>ModuleProvider</tt> has been <a
 760 href="http://llvm.org/viewvc/llvm-project?view=rev&revision=94686">removed</a>
 761 and its methods moved to <tt>Module</tt> and <tt>GlobalValue</tt>.
 762 Most clients can remove uses of <tt>ExistingModuleProvider</tt>,
 763 replace <tt>getBitcodeModuleProvider</tt> with
 764 <tt>getLazyBitcodeModule</tt>, and pass their <tt>Module</tt> to
 765 functions that used to accept <tt>ModuleProvider</tt>.  Clients who
 766 wrote their own <tt>ModuleProvider</tt>s will need to derive from
 767 <tt>GVMaterializer</tt> instead and use
 768 <tt>Module::setMaterializer</tt> to attach it to a
 769 <tt>Module</tt>.</li>
 770
 771 <li><tt>GhostLinkage</tt> has given up the ghost.
 772 <tt>GlobalValue</tt>s that have not yet been read from their backing
 773 storage have the same linkage they will have after being read in.
 774 Clients must replace calls to
 775 <tt>GlobalValue::hasNotBeenReadFromBitcode</tt> with
 776 <tt>GlobalValue::isMaterializable</tt>.</li>
 777
 778 <li>FIXME: Debug info has been totally redone. Add pointers to new APIs. Substantial caveats about compatibility of .ll and .bc files.</li>
 779
 780 <li>The <tt>llvm/Support/DataTypes.h</tt> header has moved
 781 to <tt>llvm/System/DataTypes.h</tt>.</li>
 782
 783 <li>The <tt>isInteger</tt>, <tt>isIntOrIntVector</tt>, <tt>isFloatingPoint</tt>,
 784 <tt>isFPOrFPVector</tt> and <tt>isFPOrFPVector</tt> methods have been renamed
 785 <tt>isIntegerTy</tt>, <tt>isIntOrIntVectorTy</tt>, <tt>isFloatingPointTy</tt>,
 786 <tt>isFPOrFPVectorTy</tt> and <tt>isFPOrFPVectorTy</tt> respectively.</li>
 787 </ul>
 788
 789 </div>
 790
 791
 792
 793 <!-- *********************************************************************** -->
 794 <div class="doc_section">
 795   <a name="portability">Portability and Supported Platforms</a>
 796 </div>
 797 <!-- *********************************************************************** -->
 798
 799 <div class="doc_text">
 800
 801 <p>LLVM is known to work on the following platforms:</p>
 802
 803 <ul>
 804 <li>Intel and AMD machines (IA32, X86-64, AMD64, EMT-64) running Red Hat
 805     Linux, Fedora Core, FreeBSD and AuroraUX (and probably other unix-like
 806     systems).</li>
 807 <li>PowerPC and X86-based Mac OS X systems, running 10.3 and above in 32-bit
 808     and 64-bit modes.</li>
 809 <li>Intel and AMD machines running on Win32 using MinGW libraries (native).</li>
 810 <li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
 811     support is available for native builds with Visual C++).</li>
 812 <li>Sun x86 and AMD64 machines running Solaris 10, OpenSolaris 0906.</li>
 813 <li>Alpha-based machines running Debian GNU/Linux.</li>
 814 </ul>
 815
 816 <p>The core LLVM infrastructure uses GNU autoconf to adapt itself
 817 to the machine and operating system on which it is built.  However, minor
 818 porting may be required to get LLVM to work on new platforms.  We welcome your
 819 portability patches and reports of successful builds or error messages.</p>
 820
 821 </div>
 822
 823 <!-- *********************************************************************** -->
 824 <div class="doc_section">
 825   <a name="knownproblems">Known Problems</a>
 826 </div>
 827 <!-- *********************************************************************** -->
 828
 829 <div class="doc_text">
 830
 831 <p>This section contains significant known problems with the LLVM system,
 832 listed by component.  If you run into a problem, please check the <a
 833 href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
 834 there isn't already one.</p>
 835
 836 <ul>
 837 <li>LLVM will not correctly compile on Solaris and/or OpenSolaris
 838 using the stock GCC 3.x.x series 'out the box',
 839 See: <a href="GettingStarted.html#brokengcc">Broken versions of GCC and other tools</a>.
 840 However, A <a href="http://pkg.auroraux.org/GCC">Modern GCC Build</a>
 841 for x86/x86-64 has been made available from the third party AuroraUX Project
 842 that has been meticulously tested for bootstrapping LLVM &amp; Clang.</li>
 843 </ul>
 844
 845 </div>
 846
 847 <!-- ======================================================================= -->
 848 <div class="doc_subsection">
 849   <a name="experimental">Experimental features included with this release</a>
 850 </div>
 851
 852 <div class="doc_text">
 853
 854 <p>The following components of this LLVM release are either untested, known to
 855 be broken or unreliable, or are in early development.  These components should
 856 not be relied on, and bugs should not be filed against them, but they may be
 857 useful to some people.  In particular, if you would like to work on one of these
 858 components, please contact us on the <a
 859 href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p>
 860
 861 <ul>
 862 <li>The MSIL, Alpha, SPU, MIPS, PIC16, Blackfin, MSP430, SystemZ and MicroBlaze
 863     backends are experimental.</li>
 864 <li>The <tt>llc</tt> "<tt>-filetype=asm</tt>" (the default) is the only
 865     supported value for this option.  The MachO writer is experimental, and
 866     works much better in mainline SVN.</li>
 867 </ul>
 868
 869 </div>
 870
 871 <!-- ======================================================================= -->
 872 <div class="doc_subsection">
 873   <a name="x86-be">Known problems with the X86 back-end</a>
 874 </div>
 875
 876 <div class="doc_text">
 877
 878 <ul>
 879   <li>The X86 backend does not yet support
 880     all <a href="http://llvm.org/PR879">inline assembly that uses the X86
 881     floating point stack</a>.  It supports the 'f' and 't' constraints, but not
 882     'u'.</li>
 883   <li>The X86 backend generates inefficient floating point code when configured
 884     to generate code for systems that don't have SSE2.</li>
 885   <li>Win64 code generation wasn't widely tested. Everything should work, but we
 886     expect small issues to happen. Also, llvm-gcc cannot build the mingw64
 887     runtime currently due
 888     to <a href="http://llvm.org/PR2255">several</a>
 889     <a href="http://llvm.org/PR2257">bugs</a> and due to lack of support for
 890     the
 891     'u' inline assembly constraint and for X87 floating point inline assembly.</li>
 892   <li>The X86-64 backend does not yet support the LLVM IR instruction
 893       <tt>va_arg</tt>. Currently, the llvm-gcc and front-ends support variadic
 894       argument constructs on X86-64 by lowering them manually.</li>
 895 </ul>
 896
 897 </div>
 898
 899 <!-- ======================================================================= -->
 900 <div class="doc_subsection">
 901   <a name="ppc-be">Known problems with the PowerPC back-end</a>
 902 </div>
 903
 904 <div class="doc_text">
 905
 906 <ul>
 907 <li>The Linux PPC32/ABI support needs testing for the interpreter and static
 908 compilation, and lacks support for debug information.</li>
 909 </ul>
 910
 911 </div>
 912
 913 <!-- ======================================================================= -->
 914 <div class="doc_subsection">
 915   <a name="arm-be">Known problems with the ARM back-end</a>
 916 </div>
 917
 918 <div class="doc_text">
 919
 920 <ul>
 921 <li>Support for the Advanced SIMD (Neon) instruction set is still incomplete
 922 and not well tested.  Some features may not work at all, and the code quality
 923 may be poor in some cases.</li>
 924 <li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
 925 processors, thumb programs can crash or produce wrong
 926 results (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
 927 <li>Compilation for ARM Linux OABI (old ABI) is supported but not fully tested.
 928 </li>
 929 </ul>
 930
 931 </div>
 932
 933 <!-- ======================================================================= -->
 934 <div class="doc_subsection">
 935   <a name="sparc-be">Known problems with the SPARC back-end</a>
 936 </div>
 937
 938 <div class="doc_text">
 939
 940 <ul>
 941 <li>The SPARC backend only supports the 32-bit SPARC ABI (-m32); it does not
 942     support the 64-bit SPARC ABI (-m64).</li>
 943 </ul>
 944
 945 </div>
 946
 947 <!-- ======================================================================= -->
 948 <div class="doc_subsection">
 949   <a name="mips-be">Known problems with the MIPS back-end</a>
 950 </div>
 951
 952 <div class="doc_text">
 953
 954 <ul>
 955 <li>64-bit MIPS targets are not supported yet.</li>
 956 </ul>
 957
 958 </div>
 959
 960 <!-- ======================================================================= -->
 961 <div class="doc_subsection">
 962   <a name="alpha-be">Known problems with the Alpha back-end</a>
 963 </div>
 964
 965 <div class="doc_text">
 966
 967 <ul>
 968
 969 <li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
 970 appropriate nops inserted to ensure restartability.</li>
 971
 972 </ul>
 973 </div>
 974
 975 <!-- ======================================================================= -->
 976 <div class="doc_subsection">
 977   <a name="c-be">Known problems with the C back-end</a>
 978 </div>
 979
 980 <div class="doc_text">
 981
 982 <ul>
 983 <li><a href="http://llvm.org/PR802">The C backend has only basic support for
 984     inline assembly code</a>.</li>
 985 <li><a href="http://llvm.org/PR1658">The C backend violates the ABI of common
 986     C++ programs</a>, preventing intermixing between C++ compiled by the CBE and
 987     C++ code compiled with <tt>llc</tt> or native compilers.</li>
 988 <li>The C backend does not support all exception handling constructs.</li>
 989 <li>The C backend does not support arbitrary precision integers.</li>
 990 </ul>
 991
 992 </div>
 993
 994
 995 <!-- ======================================================================= -->
 996 <div class="doc_subsection">
 997   <a name="c-fe">Known problems with the llvm-gcc C and C++ front-end</a>
 998 </div>
 999
1000 <div class="doc_text">
1001
1002 <p>The only major language feature of GCC not supported by llvm-gcc is
1003     the <tt>__builtin_apply</tt> family of builtins.   However, some extensions
1004     are only supported on some targets.  For example, trampolines are only
1005     supported on some targets (these are used when you take the address of a
1006     nested function).</p>
1007
1008 <p>If you run into GCC extensions which are not supported, please let us know.
1009 </p>
1010
1011 </div>
1012
1013 <!-- ======================================================================= -->
1014 <div class="doc_subsection">
1015   <a name="fortran-fe">Known problems with the llvm-gcc Fortran front-end</a>
1016 </div>
1017
1018 <div class="doc_text">
1019 <ul>
1020 <li>Fortran support generally works, but there are still several unresolved bugs
1021     in <a href="http://llvm.org/bugs/">Bugzilla</a>.  Please see the
1022     tools/gfortran component for details.</li>
1023 </ul>
1024 </div>
1025
1026 <!-- ======================================================================= -->
1027 <div class="doc_subsection">
1028   <a name="ada-fe">Known problems with the llvm-gcc Ada front-end</a>
1029 </div>
1030
1031 <div class="doc_text">
1032 The llvm-gcc 4.2 Ada compiler works fairly well; however, this is not a mature
1033 technology, and problems should be expected.
1034 <ul>
1035 <li>The Ada front-end currently only builds on X86-32.  This is mainly due
1036 to lack of trampoline support (pointers to nested functions) on other platforms.
1037 However, it <a href="http://llvm.org/PR2006">also fails to build on X86-64</a>
1038 which does support trampolines.</li>
1039 <li>The Ada front-end <a href="http://llvm.org/PR2007">fails to bootstrap</a>.
1040 This is due to lack of LLVM support for <tt>setjmp</tt>/<tt>longjmp</tt> style
1041 exception handling, which is used internally by the compiler.
1042 Workaround: configure with <tt>--disable-bootstrap</tt>.</li>
1043 <li>The c380004, <a href="http://llvm.org/PR2010">c393010</a>
1044 and <a href="http://llvm.org/PR2421">cxg2021</a> ACATS tests fail
1045 (c380004 also fails with gcc-4.2 mainline).
1046 If the compiler is built with checks disabled then <a href="http://llvm.org/PR2010">c393010</a>
1047 causes the compiler to go into an infinite loop, using up all system memory.</li>
1048 <li>Some GCC specific Ada tests continue to crash the compiler.</li>
1049 <li>The <tt>-E</tt> binder option (exception backtraces)
1050 <a href="http://llvm.org/PR1982">does not work</a> and will result in programs
1051 crashing if an exception is raised.  Workaround: do not use <tt>-E</tt>.</li>
1052 <li>Only discrete types <a href="http://llvm.org/PR1981">are allowed to start
1053 or finish at a non-byte offset</a> in a record.  Workaround: do not pack records
1054 or use representation clauses that result in a field of a non-discrete type
1055 starting or finishing in the middle of a byte.</li>
1056 <li>The <tt>lli</tt> interpreter <a href="http://llvm.org/PR2009">considers
1057 'main' as generated by the Ada binder to be invalid</a>.
1058 Workaround: hand edit the file to use pointers for <tt>argv</tt> and
1059 <tt>envp</tt> rather than integers.</li>
1060 <li>The <tt>-fstack-check</tt> option <a href="http://llvm.org/PR2008">is
1061 ignored</a>.</li>
1062 </ul>
1063 </div>
1064
1065 <!-- *********************************************************************** -->
1066 <div class="doc_section">
1067   <a name="additionalinfo">Additional Information</a>
1068 </div>
1069 <!-- *********************************************************************** -->
1070
1071 <div class="doc_text">
1072
1073 <p>A wide variety of additional information is available on the <a
1074 href="http://llvm.org">LLVM web page</a>, in particular in the <a
1075 href="http://llvm.org/docs/">documentation</a> section.  The web page also
1076 contains versions of the API documentation which is up-to-date with the
1077 Subversion version of the source code.
1078 You can access versions of these documents specific to this release by going
1079 into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
1080
1081 <p>If you have any questions or comments about LLVM, please feel free to contact
1082 us via the <a href="http://llvm.org/docs/#maillist"> mailing
1083 lists</a>.</p>
1084
1085 </div>
1086
1087 <!-- *********************************************************************** -->
1088
1089 <hr>
1090 <address>
1091   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
1092   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
1093   <a href="http://validator.w3.org/check/referer"><img
1094   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
1095
1096   <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
1097   Last modified: $Date$
1098 </address>
1099
1100 </body>
1101 </html>