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