docs/ReleaseNotes-2.6.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.6 Release Notes</title>
   8 </head>
   9 <body>
  10
  11 <div class="doc_title">LLVM 2.6 Release Notes</div>
  12
  13 <ol>
  14   <li><a href="#intro">Introduction</a></li>
  15   <li><a href="#subproj">Sub-project Status Update</a></li>
  16   <li><a href="#externalproj">External Projects Using LLVM 2.6</a></li>
  17   <li><a href="#whatsnew">What's New in LLVM 2.6?</a></li>
  18   <li><a href="GettingStarted.html">Installation Instructions</a></li>
  19   <li><a href="#portability">Portability and Supported Platforms</a></li>
  20   <li><a href="#knownproblems">Known Problems</a></li>
  21   <li><a href="#additionalinfo">Additional Information</a></li>
  22 </ol>
  23
  24 <div class="doc_author">
  25   <p>Written by the <a href="http://llvm.org">LLVM Team</a></p>
  26 </div>
  27
  28 <!-- *********************************************************************** -->
  29 <div class="doc_section">
  30   <a name="intro">Introduction</a>
  31 </div>
  32 <!-- *********************************************************************** -->
  33
  34 <div class="doc_text">
  35
  36 <p>This document contains the release notes for the LLVM Compiler
  37 Infrastructure, release 2.6.  Here we describe the status of LLVM, including
  38 major improvements from the previous release and significant known problems.
  39 All LLVM releases may be downloaded from the <a
  40 href="http://llvm.org/releases/">LLVM releases web site</a>.</p>
  41
  42 <p>For more information about LLVM, including information about the latest
  43 release, please check out the <a href="http://llvm.org/">main LLVM
  44 web site</a>.  If you have questions or comments, the <a
  45 href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM Developer's Mailing
  46 List</a> is a good place to send them.</p>
  47
  48 <p>Note that if you are reading this file from a Subversion checkout or the
  49 main LLVM web page, this document applies to the <i>next</i> release, not the
  50 current one.  To see the release notes for a specific release, please see the
  51 <a href="http://llvm.org/releases/">releases page</a>.</p>
  52
  53 </div>
  54
  55
  56 <!--
  57 Almost dead code.
  58   include/llvm/Analysis/LiveValues.h => Dan
  59   lib/Transforms/IPO/MergeFunctions.cpp => consider for 2.8.
  60   llvm/Analysis/PointerTracking.h => Edwin wants this, consider for 2.8.
  61 -->
  62
  63
  64 <!-- Unfinished features in 2.6:
  65   gcc plugin.
  66   strong phi elim
  67   variable debug info for optimized code
  68   postalloc scheduler: anti dependence breaking, hazard recognizer?
  69   metadata
  70   loop dependence analysis
  71   ELF Writer?  How stable?
  72   <li>PostRA scheduler improvements, ARM adoption (David Goodwin).</li>
  73   2.7 supports the GDB 7.0 jit interfaces for debug info.
  74   2.7 eliminates ADT/iterator.h
  75  -->
  76
  77  <!-- for announcement email:
  78  Logo web page.
  79  llvm devmtg
  80  compiler_rt
  81  KLEE web page at klee.llvm.org
  82  Many new papers added to /pubs/
  83    Mention gcc plugin.
  84
  85    -->
  86
  87 <!-- *********************************************************************** -->
  88 <div class="doc_section">
  89   <a name="subproj">Sub-project Status Update</a>
  90 </div>
  91 <!-- *********************************************************************** -->
  92
  93 <div class="doc_text">
  94 <p>
  95 The LLVM 2.6 distribution currently consists of code from the core LLVM
  96 repository (which roughly includes the LLVM optimizers, code generators
  97 and supporting tools), the Clang repository and the llvm-gcc repository.  In
  98 addition to this code, the LLVM Project includes other sub-projects that are in
  99 development.  Here we include updates on these subprojects.
 100 </p>
 101
 102 </div>
 103
 104
 105 <!--=========================================================================-->
 106 <div class="doc_subsection">
 107 <a name="clang">Clang: C/C++/Objective-C Frontend Toolkit</a>
 108 </div>
 109
 110 <div class="doc_text">
 111
 112 <p>The <a href="http://clang.llvm.org/">Clang project</a> is an effort to build
 113 a set of new 'LLVM native' front-end technologies for the C family of languages.
 114 LLVM 2.6 is the first release to officially include Clang, and it provides a
 115 production quality C and Objective-C compiler.  If you are interested in <a
 116 href="http://clang.llvm.org/performance.html">fast compiles</a> and
 117 <a href="http://clang.llvm.org/diagnostics.html">good diagnostics</a>, we
 118 encourage you to try it out.  Clang currently compiles typical Objective-C code
 119 3x faster than GCC and compiles C code about 30% faster than GCC at -O0 -g
 120 (which is when the most pressure is on the frontend).</p>
 121
 122 <p>In addition to supporting these languages, C++ support is also <a
 123 href="http://clang.llvm.org/cxx_status.html">well under way</a>, and mainline
 124 Clang is able to parse the libstdc++ 4.2 headers and even codegen simple apps.
 125 If you are interested in Clang C++ support or any other Clang feature, we
 126 strongly encourage you to get involved on the <a
 127 href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-dev">Clang front-end mailing
 128 list</a>.</p>
 129
 130 <p>In the LLVM 2.6 time-frame, the Clang team has made many improvements:</p>
 131
 132 <ul>
 133 <li>C and Objective-C support are now considered production quality.</li>
 134 <li>AuroraUX, FreeBSD and OpenBSD are now supported.</li>
 135 <li>Most of Objective-C 2.0 is now supported with the GNU runtime.</li>
 136 <li>Many many bugs are fixed and lots of features have been added.</li>
 137 </ul>
 138 </div>
 139
 140 <!--=========================================================================-->
 141 <div class="doc_subsection">
 142 <a name="clangsa">Clang Static Analyzer</a>
 143 </div>
 144
 145 <div class="doc_text">
 146
 147 <p>Previously announced in the 2.4 and 2.5 LLVM releases, the Clang project also
 148 includes an early stage static source code analysis tool for <a
 149 href="http://clang.llvm.org/StaticAnalysis.html">automatically finding bugs</a>
 150 in C and Objective-C programs. The tool performs checks to find
 151 bugs that occur on a specific path within a program.</p>
 152
 153 <p>In the LLVM 2.6 time-frame, the analyzer core has undergone several important
 154 improvements and cleanups and now includes a new <em>Checker</em> interface that
 155 is intended to eventually serve as a basis for domain-specific checks. Further,
 156 in addition to generating HTML files for reporting analysis results, the
 157 analyzer can now also emit bug reports in a structured XML format that is
 158 intended to be easily readable by other programs.</p>
 159
 160 <p>The set of checks performed by the static analyzer continues to expand, and
 161 future plans for the tool include full source-level inter-procedural analysis
 162 and deeper checks such as buffer overrun detection. There are many opportunities
 163 to extend and enhance the static analyzer, and anyone interested in working on
 164 this project is encouraged to get involved!</p>
 165
 166 </div>
 167
 168 <!--=========================================================================-->
 169 <div class="doc_subsection">
 170 <a name="vmkit">VMKit: JVM/CLI Virtual Machine Implementation</a>
 171 </div>
 172
 173 <div class="doc_text">
 174 <p>
 175 The <a href="http://vmkit.llvm.org/">VMKit project</a> is an implementation of
 176 a JVM and a CLI Virtual Machine (Microsoft .NET is an
 177 implementation of the CLI) using LLVM for static and just-in-time
 178 compilation.</p>
 179
 180 <p>
 181 VMKit version 0.26 builds with LLVM 2.6 and you can find it on its
 182 <a href="http://vmkit.llvm.org/releases/">web page</a>. The release includes
 183 bug fixes, cleanup and new features. The major changes are:</p>
 184
 185 <ul>
 186
 187 <li>A new llcj tool to generate shared libraries or executables of Java
 188     files.</li>
 189 <li>Cooperative garbage collection. </li>
 190 <li>Fast subtype checking (paper from Click et al [JGI'02]). </li>
 191 <li>Implementation of a two-word header for Java objects instead of the original
 192     three-word header. </li>
 193 <li>Better Java specification-compliance: division by zero checks, stack
 194     overflow checks, finalization and references support. </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="klee">KLEE: Symbolic Execution and Automatic Test Case Generator</a>
 225 </div>
 226
 227 <div class="doc_text">
 228 <p>
 229 The new LLVM <a href="http://klee.llvm.org/">KLEE project</a> is a symbolic
 230 execution framework for programs in LLVM bitcode form.  KLEE tries to
 231 symbolically evaluate "all" paths through the application and records state
 232 transitions that lead to fault states.  This allows it to construct testcases
 233 that lead to faults and can even be used to verify algorithms.  For more
 234 details, please see the <a
 235 href="http://llvm.org/pubs/2008-12-OSDI-KLEE.html">OSDI 2008 paper</a> about
 236 KLEE.</p>
 237
 238 </div>
 239
 240 <!--=========================================================================-->
 241 <div class="doc_subsection">
 242 <a name="dragonegg">DragonEgg: GCC-4.5 as an LLVM frontend</a>
 243 </div>
 244
 245 <div class="doc_text">
 246 <p>
 247 The goal of <a href="http://dragonegg.llvm.org/">DragonEgg</a> is to make
 248 gcc-4.5 act like llvm-gcc without requiring any gcc modifications whatsoever.
 249 <a href="http://dragonegg.llvm.org/">DragonEgg</a> is a shared library (llvm.so)
 250 that is loaded by gcc at runtime.  It uses the new gcc plugin architecture to
 251 disable the GCC optimizers and code generators, and schedule the LLVM optimizers
 252 and code generators (or direct output of LLVM IR) instead.  Currently only Linux
 253 and Darwin are supported, and only on x86-32 and x86-64.  It should be easy to
 254 add additional unix-like architectures and other processor families.  In theory
 255 it should be possible to use <a href="http://dragonegg.llvm.org/">DragonEgg</a>
 256 with any language supported by gcc, however only C and Fortran work well for the
 257 moment.  Ada and C++ work to some extent, while Java, Obj-C and Obj-C++ are so
 258 far entirely untested.  Since gcc-4.5 has not yet been released, neither has
 259 <a href="http://dragonegg.llvm.org/">DragonEgg</a>.  To build
 260 <a href="http://dragonegg.llvm.org/">DragonEgg</a> you will need to check out the
 261 development versions of <a href="http://gcc.gnu.org/svn.html/"> gcc</a>,
 262 <a href="http://llvm.org/docs/GettingStarted.html#checkout">llvm</a> and
 263 <a href="http://dragonegg.llvm.org/">DragonEgg</a> from their respective
 264 subversion repositories, and follow the instructions in the
 265 <a href="http://dragonegg.llvm.org/">DragonEgg</a> README.
 266 </p>
 267
 268 </div>
 269
 270
 271 <!--=========================================================================-->
 272 <div class="doc_subsection">
 273 <a name="mc">llvm-mc: Machine Code Toolkit</a>
 274 </div>
 275
 276 <div class="doc_text">
 277 <p>
 278 The LLVM Machine Code (MC) Toolkit project is a (very early) effort to build
 279 better tools for dealing with machine code, object file formats, etc.  The idea
 280 is to be able to generate most of the target specific details of assemblers and
 281 disassemblers from existing LLVM target .td files (with suitable enhancements),
 282 and to build infrastructure for reading and writing common object file formats.
 283 One of the first deliverables is to build a full assembler and integrate it into
 284 the compiler, which is predicted to substantially reduce compile time in some
 285 scenarios.
 286 </p>
 287
 288 <p>In the LLVM 2.6 timeframe, the MC framework has grown to the point where it
 289 can reliably parse and pretty print (with some encoding information) a
 290 darwin/x86 .s file successfully, and has the very early phases of a Mach-O
 291 assembler in progress.  Beyond the MC framework itself, major refactoring of the
 292 LLVM code generator has started.  The idea is to make the code generator reason
 293 about the code it is producing in a much more semantic way, rather than a
 294 textual way.  For example, the code generator now uses MCSection objects to
 295 represent section assignments, instead of text strings that print to .section
 296 directives.</p>
 297
 298 <p>MC is an early and ongoing project that will hopefully continue to lead to
 299 many improvements in the code generator and build infrastructure useful for many
 300 other situations.
 301 </p>
 302
 303 </div>
 304
 305
 306 <!-- *********************************************************************** -->
 307 <div class="doc_section">
 308   <a name="externalproj">External Projects Using LLVM 2.6</a>
 309 </div>
 310 <!-- *********************************************************************** -->
 311
 312 <div class="doc_text">
 313
 314 <p>An exciting aspect of LLVM is that it is used as an enabling technology for
 315    a lot of other language and tools projects.  This section lists some of the
 316    projects that have already been updated to work with LLVM 2.6.</p>
 317 </div>
 318
 319
 320 <!--=========================================================================-->
 321 <div class="doc_subsection">
 322 <a name="Rubinius">Rubinius</a>
 323 </div>
 324
 325 <div class="doc_text">
 326 <p><a href="http://github.com/evanphx/rubinius">Rubinius</a> is an environment
 327 for running Ruby code which strives to write as much of the core class
 328 implementation in Ruby as possible. Combined with a bytecode interpreting VM, it
 329 uses LLVM to optimize and compile ruby code down to machine code. Techniques
 330 such as type feedback, method inlining, and uncommon traps are all used to
 331 remove dynamism from ruby execution and increase performance.</p>
 332
 333 <p>Since LLVM 2.5, Rubinius has made several major leaps forward, implementing
 334 a counter based JIT, type feedback and speculative method inlining.
 335 </p>
 336
 337 </div>
 338
 339 <!--=========================================================================-->
 340 <div class="doc_subsection">
 341 <a name="macruby">MacRuby</a>
 342 </div>
 343
 344 <div class="doc_text">
 345
 346 <p>
 347 <a href="http://macruby.org">MacRuby</a> is an implementation of Ruby on top of
 348 core Mac OS X technologies, such as the Objective-C common runtime and garbage
 349 collector and the CoreFoundation framework. It is principally developed by
 350 Apple and aims at enabling the creation of full-fledged Mac OS X applications.
 351 </p>
 352
 353 <p>
 354 MacRuby uses LLVM for optimization passes, JIT and AOT compilation of Ruby
 355 expressions. It also uses zero-cost DWARF exceptions to implement Ruby exception
 356 handling.</p>
 357
 358 </div>
 359
 360
 361 <!--=========================================================================-->
 362 <div class="doc_subsection">
 363 <a name="pure">Pure</a>
 364 </div>
 365
 366 <div class="doc_text">
 367 <p>
 368 <a href="http://pure-lang.googlecode.com/">Pure</a>
 369 is an algebraic/functional programming language based on term rewriting.
 370 Programs are collections of equations which are used to evaluate expressions in
 371 a symbolic fashion. Pure offers dynamic typing, eager and lazy evaluation,
 372 lexical closures, a hygienic macro system (also based on term rewriting),
 373 built-in list and matrix support (including list and matrix comprehensions) and
 374 an easy-to-use C interface. The interpreter uses LLVM as a backend to
 375  JIT-compile Pure programs to fast native code.</p>
 376
 377 <p>Pure versions 0.31 and later have been tested and are known to work with
 378 LLVM 2.6 (and continue to work with older LLVM releases >= 2.3 as well).
 379 </p>
 380 </div>
 381
 382
 383 <!--=========================================================================-->
 384 <div class="doc_subsection">
 385 <a name="ldc">LLVM D Compiler</a>
 386 </div>
 387
 388 <div class="doc_text">
 389 <p>
 390 <a href="http://www.dsource.org/projects/ldc">LDC</a> is an implementation of
 391 the D Programming Language using the LLVM optimizer and code generator.
 392 The LDC project works great with the LLVM 2.6 release.  General improvements in
 393 this
 394 cycle have included new inline asm constraint handling, better debug info
 395 support, general bug fixes and better x86-64 support.  This has allowed
 396 some major improvements in LDC, getting it much closer to being as
 397 fully featured as the original DMD compiler from DigitalMars.
 398 </p>
 399 </div>
 400
 401 <!--=========================================================================-->
 402 <div class="doc_subsection">
 403 <a name="RoadsendPHP">Roadsend PHP</a>
 404 </div>
 405
 406 <div class="doc_text">
 407 <p>
 408 <a href="http://code.roadsend.com/rphp">Roadsend PHP</a> (rphp) is an open
 409 source implementation of the PHP programming
 410 language that uses LLVM for its optimizer, JIT and static compiler. This is a
 411 reimplementation of an earlier project that is now based on LLVM.</p>
 412 </div>
 413
 414 <!--=========================================================================-->
 415 <div class="doc_subsection">
 416 <a name="UnladenSwallow">Unladen Swallow</a>
 417 </div>
 418
 419 <div class="doc_text">
 420 <p>
 421 <a href="http://code.google.com/p/unladen-swallow/">Unladen Swallow</a> is a
 422 branch of <a href="http://python.org/">Python</a> intended to be fully
 423 compatible and significantly faster.  It uses LLVM's optimization passes and JIT
 424 compiler.</p>
 425 </div>
 426
 427 <!--=========================================================================-->
 428 <div class="doc_subsection">
 429 <a name="llvm-lua">llvm-lua</a>
 430 </div>
 431
 432 <div class="doc_text">
 433 <p>
 434 <a href="http://code.google.com/p/llvm-lua/">LLVM-Lua</a> uses LLVM to add JIT
 435 and static compiling support to the Lua VM.  Lua bytecode is analyzed to
 436 remove type checks, then LLVM is used to compile the bytecode down to machine
 437 code.</p>
 438 </div>
 439
 440
 441
 442 <!-- *********************************************************************** -->
 443 <div class="doc_section">
 444   <a name="whatsnew">What's New in LLVM 2.6?</a>
 445 </div>
 446 <!-- *********************************************************************** -->
 447
 448 <div class="doc_text">
 449
 450 <p>This release includes a huge number of bug fixes, performance tweaks and
 451 minor improvements.  Some of the major improvements and new features are listed
 452 in this section.
 453 </p>
 454
 455 </div>
 456
 457 <!--=========================================================================-->
 458 <div class="doc_subsection">
 459 <a name="majorfeatures">Major New Features</a>
 460 </div>
 461
 462 <div class="doc_text">
 463
 464 <p>LLVM 2.6 includes several major new capabilities:</p>
 465
 466 <ul>
 467 <li>New <a href="#compiler-rt">compiler-rt</a>, <A href="#klee">KLEE</a>
 468     and <a href="#mc">machine code toolkit</a> sub-projects.</li>
 469 <li>Debug information now includes line numbers when optimizations are enabled.
 470     This allows statistical sampling tools like OProfile and Shark to map
 471     samples back to source lines.</li>
 472 <li>LLVM now includes new experimental backends to support the MSP430, SystemZ
 473     and BlackFin architectures.</li>
 474 <li>LLVM supports a new <a href="GoldPlugin.html">Gold Linker Plugin</a> which
 475     enables support for <a href="LinkTimeOptimization.html">transparent
 476     link-time optimization</a> on ELF targets when used with the Gold binutils
 477     linker.</li>
 478 <li>LLVM now supports doing optimization and code generation on multiple
 479     threads.  Please see the <a href="ProgrammersManual.html#threading">LLVM
 480     Programmer's Manual</a> for more information.</li>
 481 <li>LLVM now has experimental support for <a
 482     href="http://nondot.org/~sabre/LLVMNotes/EmbeddedMetadata.txt">embedded
 483     metadata</a> in LLVM IR, though the implementation is not guaranteed to be
 484     final and the .bc file format may change in future releases.  Debug info
 485     does not yet use this format in LLVM 2.6.</li>
 486 </ul>
 487
 488 </div>
 489
 490 <!--=========================================================================-->
 491 <div class="doc_subsection">
 492 <a name="coreimprovements">LLVM IR and Core Improvements</a>
 493 </div>
 494
 495 <div class="doc_text">
 496 <p>LLVM IR has several new features for better support of new targets and that
 497 expose new optimization opportunities:</p>
 498
 499 <ul>
 500 <li>The <a href="LangRef.html#i_add">add</a>, <a
 501     href="LangRef.html#i_sub">sub</a> and <a href="LangRef.html#i_mul">mul</a>
 502     instructions have been split into integer and floating point versions (like
 503     divide and remainder), introducing new <a
 504     href="LangRef.html#i_fadd">fadd</a>, <a href="LangRef.html#i_fsub">fsub</a>,
 505     and <a href="LangRef.html#i_fmul">fmul</a> instructions.</li>
 506 <li>The <a href="LangRef.html#i_add">add</a>, <a
 507     href="LangRef.html#i_sub">sub</a> and <a href="LangRef.html#i_mul">mul</a>
 508     instructions now support optional "nsw" and "nuw" bits which indicate that
 509     the operation is guaranteed to not overflow (in the signed or
 510     unsigned case, respectively).  This gives the optimizer more information and
 511     can be used for things like C signed integer values, which are undefined on
 512     overflow.</li>
 513 <li>The <a href="LangRef.html#i_sdiv">sdiv</a> instruction now supports an
 514     optional "exact" flag which indicates that the result of the division is
 515     guaranteed to have a remainder of zero.  This is useful for optimizing pointer
 516     subtraction in C.</li>
 517 <li>The <a href="LangRef.html#i_getelementptr">getelementptr</a> instruction now
 518     supports arbitrary integer index values for array/pointer indices.  This
 519     allows for better code generation on 16-bit pointer targets like PIC16.</li>
 520 <li>The <a href="LangRef.html#i_getelementptr">getelementptr</a> instruction now
 521     supports an "inbounds" optimization hint that tells the optimizer that the
 522     pointer is guaranteed to be within its allocated object.</li>
 523 <li>LLVM now support a series of new linkage types for global values which allow
 524     for better optimization and new capabilities:
 525     <ul>
 526     <li><a href="LangRef.html#linkage_linkonce">linkonce_odr</a> and
 527         <a href="LangRef.html#linkage_weak">weak_odr</a> have the same linkage
 528         semantics as the non-"odr" linkage types.  The difference is that these
 529         linkage types indicate that all definitions of the specified function
 530         are guaranteed to have the same semantics.  This allows inlining
 531         templates functions in C++ but not inlining weak functions in C,
 532         which previously both got the same linkage type.</li>
 533     <li><a href="LangRef.html#linkage_available_externally">available_externally
 534         </a> is a new linkage type that gives the optimizer visibility into the
 535         definition of a function (allowing inlining and side effect analysis)
 536         but that does not cause code to be generated.  This allows better
 537         optimization of "GNU inline" functions, extern templates, etc.</li>
 538     <li><a href="LangRef.html#linkage_linker_private">linker_private</a> is a
 539         new linkage type (which is only useful on Mac OS X) that is used for
 540         some metadata generation and other obscure things.</li>
 541     </ul></li>
 542 <li>Finally, target-specific intrinsics can now return multiple values, which
 543     is useful for modeling target operations with multiple results.</li>
 544 </ul>
 545
 546 </div>
 547
 548 <!--=========================================================================-->
 549 <div class="doc_subsection">
 550 <a name="optimizer">Optimizer Improvements</a>
 551 </div>
 552
 553 <div class="doc_text">
 554
 555 <p>In addition to a large array of minor performance tweaks and bug fixes, this
 556 release includes a few major enhancements and additions to the optimizers:</p>
 557
 558 <ul>
 559
 560 <li>The <a href="Passes.html#scalarrepl">Scalar Replacement of Aggregates</a>
 561     pass has many improvements that allow it to better promote vector unions,
 562     variables which are memset, and much more strange code that can happen to
 563     do bitfield accesses to register operations.  An interesting change is that
 564     it now produces "unusual" integer sizes (like i1704) in some cases and lets
 565     other optimizers clean things up.</li>
 566 <li>The <a href="Passes.html#loop-reduce">Loop Strength Reduction</a> pass now
 567     promotes small integer induction variables to 64-bit on 64-bit targets,
 568     which provides a major performance boost for much numerical code.  It also
 569     promotes shorts to int on 32-bit hosts, etc.  LSR now also analyzes pointer
 570     expressions (e.g. getelementptrs), as well as integers.</li>
 571 <li>The <a href="Passes.html#gvn">GVN</a> pass now eliminates partial
 572     redundancies of loads in simple cases.</li>
 573 <li>The <a href="Passes.html#inline">Inliner</a> now reuses stack space when
 574     inlining similar arrays from multiple callees into one caller.</li>
 575 <li>LLVM includes a new experimental Static Single Information (SSI)
 576     construction pass.</li>
 577 </li>
 578
 579 </ul>
 580
 581 </div>
 582
 583
 584 <!--=========================================================================-->
 585 <div class="doc_subsection">
 586 <a name="executionengine">Interpreter and JIT Improvements</a>
 587 </div>
 588
 589 <div class="doc_text">
 590
 591 <ul>
 592 <li>LLVM has a new "EngineBuilder" class which makes it more obvious how to
 593     set up and configure an ExecutionEngine (a JIT or interpreter).</li>
 594 <li>The JIT now supports generating more than 16M of code.</li>
 595 <li>When configured with <tt>--with-oprofile</tt>, the JIT can now inform
 596      OProfile about JIT'd code, allowing OProfile to get line number and function
 597      name information for JIT'd functions.</li>
 598 <li>When "libffi" is available, the LLVM interpreter now uses it, which supports
 599     calling almost arbitrary external (natively compiled) functions.</li>
 600 <li>Clients of the JIT can now register a 'JITEventListener' object to receive
 601     callbacks when the JIT emits or frees machine code. The OProfile support
 602     uses this mechanism.</li>
 603 </ul>
 604
 605 </div>
 606
 607 <!--=========================================================================-->
 608 <div class="doc_subsection">
 609 <a name="codegen">Target Independent Code Generator Improvements</a>
 610 </div>
 611
 612 <div class="doc_text">
 613
 614 <p>We have put a significant amount of work into the code generator
 615 infrastructure, which allows us to implement more aggressive algorithms and make
 616 it run faster:</p>
 617
 618 <ul>
 619
 620 <li>The <tt>llc -asm-verbose</tt> option (exposed from llvm-gcc as <tt>-dA</tt>
 621     and clang as <tt>-fverbose-asm</tt> or <tt>-dA</tt>) now adds a lot of
 622     useful information in comments to
 623     the generated .s file.  This information includes location information (if
 624     built with <tt>-g</tt>) and loop nest information.</li>
 625 <li>The code generator now supports a new MachineVerifier pass which is useful
 626     for finding bugs in targets and codegen passes.</li>
 627 <li>The Machine LICM is now enabled by default.  It hoists instructions out of
 628     loops (such as constant pool loads, loads from read-only stubs, vector
 629     constant synthesization code, etc.) and is currently configured to only do
 630     so when the hoisted operation can be rematerialized.</li>
 631 <li>The Machine Sinking pass is now enabled by default.  This pass moves
 632     side-effect free operations down the CFG so that they are executed on fewer
 633     paths through a function.</li>
 634 <li>The code generator now performs "stack slot coloring" of register spills,
 635     which allows spill slots to be reused.  This leads to smaller stack frames
 636     in cases where there are lots of register spills.</li>
 637 <li>The register allocator has many improvements to take better advantage of
 638     commutable operations, various spiller peephole optimizations, and can now
 639     coalesce cross-register-class copies.</li>
 640 <li>Tblgen now supports multiclass inheritance and a number of new string and
 641     list operations like !(subst), !(foreach), !car, !cdr, !null, !if, !cast.
 642     These make the .td files more expressive and allow more aggressive factoring
 643     of duplication across instruction patterns.</li>
 644 <li>Target-specific intrinsics can now be added without having to hack VMCore to
 645     add them.  This makes it easier to maintain out-of-tree targets.</li>
 646 <li>The instruction selector is better at propagating information about values
 647     (such as whether they are sign/zero extended etc.) across basic block
 648     boundaries.</li>
 649 <li>The SelectionDAG datastructure has new nodes for representing buildvector
 650     and <a href="http://llvm.org/PR2957">vector shuffle</a> operations.  This
 651     makes operations and pattern matching more efficient and easier to get
 652     right.</li>
 653 <li>The Prolog/Epilog Insertion Pass now has experimental support for performing
 654     the "shrink wrapping" optimization, which moves spills and reloads around in
 655     the CFG to avoid doing saves on paths that don't need them.</li>
 656 <li>LLVM includes new experimental support for writing ELF .o files directly
 657     from the compiler.  It works well for many simple C testcases, but doesn't
 658     support exception handling, debug info, inline assembly, etc.</li>
 659 <li>Targets can now specify register allocation hints through
 660     MachineRegisterInfo::setRegAllocationHint. A regalloc hint consists of hint
 661     type and physical register number. A hint type of zero specifies a register
 662     allocation preference. Other hint type values are target specific which are
 663     resolved by TargetRegisterInfo::ResolveRegAllocHint. An example is the ARM
 664     target which uses register hints to request that the register allocator
 665     provide an even / odd register pair to two virtual registers.</li>
 666 </ul>
 667 </div>
 668
 669 <!--=========================================================================-->
 670 <div class="doc_subsection">
 671 <a name="x86">X86-32 and X86-64 Target Improvements</a>
 672 </div>
 673
 674 <div class="doc_text">
 675 <p>New features of the X86 target include:
 676 </p>
 677
 678 <ul>
 679
 680 <li>SSE 4.2 builtins are now supported.</li>
 681 <li>GCC-compatible soft float modes are now supported, which are typically used
 682     by OS kernels.</li>
 683 <li>X86-64 now models implicit zero extensions better, which allows the code
 684     generator to remove a lot of redundant zexts.  It also models the 8-bit "H"
 685     registers as subregs, which allows them to be used in some tricky
 686     situations.</li>
 687 <li>X86-64 now supports the "local exec" and "initial exec" thread local storage
 688     model.</li>
 689 <li>The vector forms of the <a href="LangRef.html#i_icmp">icmp</a> and <a
 690     href="LangRef.html#i_fcmp">fcmp</a> instructions now select to efficient
 691     SSE operations.</li>
 692 <li>Support for the win64 calling conventions have improved.  The primary
 693     missing feature is support for varargs function definitions.  It seems to
 694     work well for many win64 JIT purposes.</li>
 695 <li>The X86 backend has preliminary support for <a
 696     href="CodeGenerator.html#x86_memory">mapping address spaces to segment
 697     register references</a>.  This allows you to write GS or FS relative memory
 698     accesses directly in LLVM IR for cases where you know exactly what you're
 699     doing (such as in an OS kernel).  There are some known problems with this
 700     support, but it works in simple cases.</li>
 701 <li>The X86 code generator has been refactored to move all global variable
 702     reference logic to one place
 703     (<tt>X86Subtarget::ClassifyGlobalReference</tt>) which
 704     makes it easier to reason about.</li>
 705 </li>
 706 </ul>
 707
 708 </div>
 709
 710 <!--=========================================================================-->
 711 <div class="doc_subsection">
 712 <a name="pic16">PIC16 Target Improvements</a>
 713 </div>
 714
 715 <div class="doc_text">
 716 <p>New features of the PIC16 target include:
 717 </p>
 718
 719 <ul>
 720 <li>Support for floating-point, indirect function calls, and
 721     passing/returning aggregate types to functions.
 722 <li>The code generator is able to generate debug info into output COFF files.
 723 <li>Support for placing an object into a specific section or at a specific
 724     address in memory.</li>
 725 </ul>
 726
 727 <p>Things not yet supported:</p>
 728
 729 <ul>
 730 <li>Variable arguments.</li>
 731 <li>Interrupts/programs.</li>
 732 </ul>
 733
 734 </div>
 735
 736 <!--=========================================================================-->
 737 <div class="doc_subsection">
 738 <a name="ARM">ARM Target Improvements</a>
 739 </div>
 740
 741 <div class="doc_text">
 742 <p>New features of the ARM target include:
 743 </p>
 744
 745 <ul>
 746
 747 <li>Preliminary support for processors, such as the Cortex-A8 and Cortex-A9,
 748 that implement version v7-A of the ARM architecture.  The ARM backend now
 749 supports both the Thumb2 and Advanced SIMD (Neon) instruction sets.</li>
 750
 751 <li>The AAPCS-VFP "hard float" calling conventions are also supported with the
 752 <tt>-float-abi=hard</tt> flag.</li>
 753
 754 <li>The ARM calling convention code is now tblgen generated instead of resorting
 755     to C++ code.</li>
 756 </li>
 757
 758
 759 <p>These features are still somewhat experimental
 760 and subject to change. The Neon intrinsics, in particular, may change in future
 761 releases of LLVM.  ARMv7 support has progressed a lot on top of tree since 2.6
 762 branched.</p>
 763
 764 </ul>
 765
 766 </div>
 767
 768 <!--=========================================================================-->
 769 <div class="doc_subsection">
 770 <a name="OtherTarget">Other Target Specific Improvements</a>
 771 </div>
 772
 773 <div class="doc_text">
 774 <p>New features of other targets include:
 775 </p>
 776
 777 <ul>
 778 <li>Mips now supports O32 Calling Convention.</li>
 779 <li>Many improvements to the 32-bit PowerPC SVR4 ABI (used on powerpc-linux)
 780     support, lots of bugs fixed.</li>
 781 <li>Added support for the 64-bit PowerPC SVR4 ABI (used on powerpc64-linux).
 782     Needs more testing.</li>
 783 </ul>
 784
 785 </div>
 786
 787 <!--=========================================================================-->
 788 <div class="doc_subsection">
 789 <a name="newapis">New Useful APIs</a>
 790 </div>
 791
 792 <div class="doc_text">
 793
 794 <p>This release includes a number of new APIs that are used internally, which
 795    may also be useful for external clients.
 796 </p>
 797
 798 <ul>
 799 <li>New <a href="http://llvm.org/doxygen/PrettyStackTrace_8h-source.html">
 800     PrettyStackTrace classes</a> allows crashes of llvm tools (and applications
 801     that integrate them) to provide more detailed indication of what the
 802     compiler was doing at the time of the crash (e.g. running a pass).
 803     At the top level for each LLVM tool, it includes the command line arguments.
 804     </li>
 805 <li>New <a href="http://llvm.org/doxygen/StringRef_8h-source.html">StringRef</a>
 806     and <a href="http://llvm.org/doxygen/Twine_8h-source.html">Twine</a> classes
 807     make operations on character ranges and
 808     string concatenation to be more efficient.  StringRef is just a <tt>const
 809     char*</tt> with a length, Twine is a light-weight rope.</li>
 810 <li>LLVM has new WeakVH, AssertingVH and CallbackVH classes, which make it
 811     easier to write LLVM IR transformations.  WeakVH is automatically drops to
 812     null when the referenced Value is deleted, and is updated across a
 813     replaceAllUsesWith operation.  AssertingVH aborts the program if the
 814     referenced value is destroyed while it is being referenced.  CallbackVH is
 815     a customizable class for handling value references.  See <a
 816     href="http://llvm.org/doxygen/ValueHandle_8h-source.html">ValueHandle.h</a>
 817     for more information.</li>
 818 <li>The new '<a href="http://llvm.org/doxygen/Triple_8h-source.html">Triple
 819     </a>' class centralizes a lot of logic that reasons about target
 820     triples.</li>
 821 <li>The new '<a href="http://llvm.org/doxygen/ErrorHandling_8h-source.html">
 822     llvm_report_error()</a>' set of APIs allows tools to embed the LLVM
 823     optimizer and backend and recover from previously unrecoverable errors.</li>
 824 <li>LLVM has new abstractions for <a
 825     href="http://llvm.org/doxygen/Atomic_8h-source.html">atomic operations</a>
 826     and <a href="http://llvm.org/doxygen/RWMutex_8h-source.html">reader/writer
 827     locks</a>.</li>
 828 <li>LLVM has new <a href="http://llvm.org/doxygen/SourceMgr_8h-source.html">
 829     SourceMgr and SMLoc classes</a> which implement caret diagnostics and basic
 830     include stack processing for simple parsers. It is used by tablegen,
 831     llvm-mc, the .ll parser and FileCheck.</li>
 832 </ul>
 833
 834
 835 </div>
 836
 837 <!--=========================================================================-->
 838 <div class="doc_subsection">
 839 <a name="otherimprovements">Other Improvements and New Features</a>
 840 </div>
 841
 842 <div class="doc_text">
 843 <p>Other miscellaneous features include:</p>
 844
 845 <ul>
 846 <li>LLVM now includes a new internal '<a
 847     href="http://llvm.org/cmds/FileCheck.html">FileCheck</a>' tool which allows
 848     writing much more accurate regression tests that run faster.  Please see the
 849     <a href="TestingGuide.html#FileCheck">FileCheck section of the Testing
 850     Guide</a> for more information.</li>
 851 <li>LLVM profile information support has been significantly improved to produce
 852 correct use counts, and has support for edge profiling with reduced runtime
 853 overhead.  Combined, the generated profile information is both more correct and
 854 imposes about half as much overhead (2.6. from 12% to 6% overhead on SPEC
 855 CPU2000).</li>
 856 <li>The C bindings (in the llvm/include/llvm-c directory) include many newly
 857     supported APIs.</li>
 858 <li>LLVM 2.6 includes a brand new experimental LLVM bindings to the Ada2005
 859     programming language.</li>
 860
 861 <li>The LLVMC driver has several new features:
 862   <ul>
 863   <li>Dynamic plugins now work on Windows.</li>
 864   <li>New option property: init. Makes possible to provide default values for
 865       options defined in plugins (interface to cl::init).</li>
 866   <li>New example: Skeleton, shows how to create a standalone LLVMC-based
 867       driver.</li>
 868   <li>New example: mcc16, a driver for the PIC16 toolchain.</li>
 869   </ul>
 870 </li>
 871
 872 </ul>
 873
 874 </div>
 875
 876
 877 <!--=========================================================================-->
 878 <div class="doc_subsection">
 879 <a name="changes">Major Changes and Removed Features</a>
 880 </div>
 881
 882 <div class="doc_text">
 883
 884 <p>If you're already an LLVM user or developer with out-of-tree changes based
 885 on LLVM 2.5, this section lists some "gotchas" that you may run into upgrading
 886 from the previous release.</p>
 887
 888 <ul>
 889 <li>The Itanium (IA64) backend has been removed.  It was not actively supported
 890     and had bitrotted.</li>
 891 <li>The BigBlock register allocator has been removed, it had also bitrotted.</li>
 892 <li>The C Backend (-march=c) is no longer considered part of the LLVM release
 893 criteria.  We still want it to work, but no one is maintaining it and it lacks
 894 support for arbitrary precision integers and other important IR features.</li>
 895
 896 <li>All LLVM tools now default to overwriting their output file, behaving more
 897     like standard unix tools.  Previously, this only happened with the '-f'
 898     option.</li>
 899 <li>LLVM build now builds all libraries as .a files instead of some
 900   libraries as relinked .o files.  This requires some APIs like
 901   InitializeAllTargets.h.
 902   </li>
 903 </ul>
 904
 905
 906 <p>In addition, many APIs have changed in this release.  Some of the major LLVM
 907 API changes are:</p>
 908
 909 <ul>
 910 <li>All uses of hash_set and hash_map have been removed from the LLVM tree and
 911     the wrapper headers have been removed.</li>
 912 <li>The llvm/Streams.h and DOUT member of Debug.h have been removed.  The
 913     llvm::Ostream class has been completely removed and replaced with uses of
 914     raw_ostream.</li>
 915 <li>LLVM's global uniquing tables for <tt>Type</tt>s and <tt>Constant</tt>s have
 916     been privatized into members of an <tt>LLVMContext</tt>.  A number of APIs
 917     now take an <tt>LLVMContext</tt> as a parameter.  To smooth the transition
 918     for clients that will only ever use a single context, the new
 919     <tt>getGlobalContext()</tt> API can be used to access a default global
 920     context which can be passed in any and all cases where a context is
 921     required.
 922 <li>The <tt>getABITypeSize</tt> methods are now called <tt>getAllocSize</tt>.</li>
 923 <li>The <tt>Add</tt>, <tt>Sub</tt> and <tt>Mul</tt> operators are no longer
 924     overloaded for floating-point types. Floating-point addition, subtraction
 925     and multiplication are now represented with new operators <tt>FAdd</tt>,
 926     <tt>FSub</tt> and <tt>FMul</tt>. In the <tt>IRBuilder</tt> API,
 927     <tt>CreateAdd</tt>, <tt>CreateSub</tt>, <tt>CreateMul</tt> and
 928     <tt>CreateNeg</tt> should only be used for integer arithmetic now;
 929     <tt>CreateFAdd</tt>, <tt>CreateFSub</tt>, <tt>CreateFMul</tt> and
 930     <tt>CreateFNeg</tt> should now be used for floating-point arithmetic.</li>
 931 <li>The DynamicLibrary class can no longer be constructed, its functionality has
 932     moved to static member functions.</li>
 933 <li><tt>raw_fd_ostream</tt>'s constructor for opening a given filename now
 934     takes an extra <tt>Force</tt> argument. If <tt>Force</tt> is set to
 935     <tt>false</tt>, an error will be reported if a file with the given name
 936     already exists. If <tt>Force</tt> is set to <tt>true</tt>, the file will
 937     be silently truncated (which is the behavior before this flag was
 938     added).</li>
 939 <li><tt>SCEVHandle</tt> no longer exists, because reference counting is no
 940 longer done for <tt>SCEV*</tt> objects, instead <tt>const SCEV*</tt> should be
 941 used.</li>
 942
 943 <li>Many APIs, notably <tt>llvm::Value</tt>, now use the <tt>StringRef</tt>
 944 and <tt>Twine</tt> classes instead of passing <tt>const char*</tt>
 945 or <tt>std::string</tt>, as described in
 946 the <a href="ProgrammersManual.html#string_apis">Programmer's Manual</a>. Most
 947 clients should be unaffected by this transition, unless they are used to
 948 <tt>Value::getName()</tt> returning a string. Here are some tips on updating to
 949 2.6:
 950   <ul>
 951     <li><tt>getNameStr()</tt> is still available, and matches the old
 952       behavior. Replacing <tt>getName()</tt> calls with this is an safe option,
 953       although more efficient alternatives are now possible.</li>
 954
 955     <li>If you were just relying on <tt>getName()</tt> being able to be sent to
 956       a <tt>std::ostream</tt>, consider migrating
 957       to <tt>llvm::raw_ostream</tt>.</li>
 958
 959     <li>If you were using <tt>getName().c_str()</tt> to get a <tt>const
 960         char*</tt> pointer to the name, you can use <tt>getName().data()</tt>.
 961         Note that this string (as before), may not be the entire name if the
 962         name contains embedded null characters.</li>
 963
 964     <li>If you were using operator plus on the result of <tt>getName()</tt> and
 965       treating the result as an <tt>std::string</tt>, you can either
 966       use <tt>Twine::str</tt> to get the result as an <tt>std::string</tt>, or
 967       could move to a <tt>Twine</tt> based design.</li>
 968
 969     <li><tt>isName()</tt> should be replaced with comparison
 970       against <tt>getName()</tt> (this is now efficient).
 971   </ul>
 972 </li>
 973
 974 <li>The registration interfaces for backend Targets has changed (what was
 975 previously TargetMachineRegistry). For backend authors, see the <a
 976 href="WritingAnLLVMBackend.html#TargetRegistration">Writing An LLVM Backend</a>
 977 guide. For clients, the notable API changes are:
 978   <ul>
 979     <li><tt>TargetMachineRegistry</tt> has been renamed
 980       to <tt>TargetRegistry</tt>.</li>
 981
 982     <li>Clients should move to using the <tt>TargetRegistry::lookupTarget()</tt>
 983       function to find targets.</li>
 984   </ul>
 985 </li>
 986 </ul>
 987
 988 </div>
 989
 990
 991
 992 <!-- *********************************************************************** -->
 993 <div class="doc_section">
 994   <a name="portability">Portability and Supported Platforms</a>
 995 </div>
 996 <!-- *********************************************************************** -->
 997
 998 <div class="doc_text">
 999
1000 <p>LLVM is known to work on the following platforms:</p>
1001
1002 <ul>
1003 <li>Intel and AMD machines (IA32, X86-64, AMD64, EMT-64) running Red Hat
1004     Linux, Fedora Core, FreeBSD and AuroraUX (and probably other unix-like
1005     systems).</li>
1006 <li>PowerPC and X86-based Mac OS X systems, running 10.3 and above in 32-bit
1007     and 64-bit modes.</li>
1008 <li>Intel and AMD machines running on Win32 using MinGW libraries (native).</li>
1009 <li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
1010     support is available for native builds with Visual C++).</li>
1011 <li>Sun UltraSPARC workstations running Solaris 10.</li>
1012 <li>Alpha-based machines running Debian GNU/Linux.</li>
1013 </ul>
1014
1015 <p>The core LLVM infrastructure uses GNU autoconf to adapt itself
1016 to the machine and operating system on which it is built.  However, minor
1017 porting may be required to get LLVM to work on new platforms.  We welcome your
1018 portability patches and reports of successful builds or error messages.</p>
1019
1020 </div>
1021
1022 <!-- *********************************************************************** -->
1023 <div class="doc_section">
1024   <a name="knownproblems">Known Problems</a>
1025 </div>
1026 <!-- *********************************************************************** -->
1027
1028 <div class="doc_text">
1029
1030 <p>This section contains significant known problems with the LLVM system,
1031 listed by component.  If you run into a problem, please check the <a
1032 href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
1033 there isn't already one.</p>
1034
1035 <ul>
1036 <li>The llvm-gcc bootstrap will fail with some versions of binutils (e.g. 2.15)
1037     with a message of "<tt><a href="http://llvm.org/PR5004">Error: can not do 8
1038     byte pc-relative relocation</a></tt>" when building C++ code.  We intend to
1039     fix this on mainline, but a workaround for 2.6 is to upgrade to binutils
1040     2.17 or later.</li>
1041
1042 <li>LLVM will not correctly compile on Solaris and/or OpenSolaris
1043 using the stock GCC 3.x.x series 'out the box',
1044 See: <a href="#brokengcc">Broken versions of GCC and other tools</a>.
1045 However, A <a href="http://pkg.auroraux.org/GCC">Modern GCC Build</a>
1046 for x86/x86-64 has been made available from the third party AuroraUX Project
1047 that has been meticulously tested for bootstrapping LLVM &amp; Clang.</li>
1048 </ul>
1049
1050 </div>
1051
1052 <!-- ======================================================================= -->
1053 <div class="doc_subsection">
1054   <a name="experimental">Experimental features included with this release</a>
1055 </div>
1056
1057 <div class="doc_text">
1058
1059 <p>The following components of this LLVM release are either untested, known to
1060 be broken or unreliable, or are in early development.  These components should
1061 not be relied on, and bugs should not be filed against them, but they may be
1062 useful to some people.  In particular, if you would like to work on one of these
1063 components, please contact us on the <a
1064 href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p>
1065
1066 <ul>
1067 <li>The MSIL, Alpha, SPU, MIPS, PIC16, Blackfin, MSP430 and SystemZ backends are
1068     experimental.</li>
1069 <li>The <tt>llc</tt> "<tt>-filetype=asm</tt>" (the default) is the only
1070     supported value for this option.  The ELF writer is experimental.</li>
1071 <li>The implementation of Andersen's Alias Analysis has many known bugs.</li>
1072 </ul>
1073
1074 </div>
1075
1076 <!-- ======================================================================= -->
1077 <div class="doc_subsection">
1078   <a name="x86-be">Known problems with the X86 back-end</a>
1079 </div>
1080
1081 <div class="doc_text">
1082
1083 <ul>
1084   <li>The X86 backend does not yet support
1085     all <a href="http://llvm.org/PR879">inline assembly that uses the X86
1086     floating point stack</a>.  It supports the 'f' and 't' constraints, but not
1087     'u'.</li>
1088   <li>The X86 backend generates inefficient floating point code when configured
1089     to generate code for systems that don't have SSE2.</li>
1090   <li>Win64 code generation wasn't widely tested. Everything should work, but we
1091     expect small issues to happen. Also, llvm-gcc cannot build the mingw64
1092     runtime currently due
1093     to <a href="http://llvm.org/PR2255">several</a>
1094     <a href="http://llvm.org/PR2257">bugs</a> and due to lack of support for
1095     the
1096     'u' inline assembly constraint and for X87 floating point inline assembly.</li>
1097   <li>The X86-64 backend does not yet support the LLVM IR instruction
1098       <tt>va_arg</tt>. Currently, the llvm-gcc and front-ends support variadic
1099       argument constructs on X86-64 by lowering them manually.</li>
1100 </ul>
1101
1102 </div>
1103
1104 <!-- ======================================================================= -->
1105 <div class="doc_subsection">
1106   <a name="ppc-be">Known problems with the PowerPC back-end</a>
1107 </div>
1108
1109 <div class="doc_text">
1110
1111 <ul>
1112 <li>The Linux PPC32/ABI support needs testing for the interpreter and static
1113 compilation, and lacks support for debug information.</li>
1114 </ul>
1115
1116 </div>
1117
1118 <!-- ======================================================================= -->
1119 <div class="doc_subsection">
1120   <a name="arm-be">Known problems with the ARM back-end</a>
1121 </div>
1122
1123 <div class="doc_text">
1124
1125 <ul>
1126 <li>Support for the Advanced SIMD (Neon) instruction set is still incomplete
1127 and not well tested.  Some features may not work at all, and the code quality
1128 may be poor in some cases.</li>
1129 <li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
1130 processors, thumb programs can crash or produce wrong
1131 results (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
1132 <li>Compilation for ARM Linux OABI (old ABI) is supported but not fully tested.
1133 </li>
1134 </ul>
1135
1136 </div>
1137
1138 <!-- ======================================================================= -->
1139 <div class="doc_subsection">
1140   <a name="sparc-be">Known problems with the SPARC back-end</a>
1141 </div>
1142
1143 <div class="doc_text">
1144
1145 <ul>
1146 <li>The SPARC backend only supports the 32-bit SPARC ABI (-m32); it does not
1147     support the 64-bit SPARC ABI (-m64).</li>
1148 </ul>
1149
1150 </div>
1151
1152 <!-- ======================================================================= -->
1153 <div class="doc_subsection">
1154   <a name="mips-be">Known problems with the MIPS back-end</a>
1155 </div>
1156
1157 <div class="doc_text">
1158
1159 <ul>
1160 <li>64-bit MIPS targets are not supported yet.</li>
1161 </ul>
1162
1163 </div>
1164
1165 <!-- ======================================================================= -->
1166 <div class="doc_subsection">
1167   <a name="alpha-be">Known problems with the Alpha back-end</a>
1168 </div>
1169
1170 <div class="doc_text">
1171
1172 <ul>
1173
1174 <li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
1175 appropriate nops inserted to ensure restartability.</li>
1176
1177 </ul>
1178 </div>
1179
1180 <!-- ======================================================================= -->
1181 <div class="doc_subsection">
1182   <a name="c-be">Known problems with the C back-end</a>
1183 </div>
1184
1185 <div class="doc_text">
1186
1187 <ul>
1188 <li><a href="http://llvm.org/PR802">The C backend has only basic support for
1189     inline assembly code</a>.</li>
1190 <li><a href="http://llvm.org/PR1658">The C backend violates the ABI of common
1191     C++ programs</a>, preventing intermixing between C++ compiled by the CBE and
1192     C++ code compiled with <tt>llc</tt> or native compilers.</li>
1193 <li>The C backend does not support all exception handling constructs.</li>
1194 <li>The C backend does not support arbitrary precision integers.</li>
1195 </ul>
1196
1197 </div>
1198
1199
1200 <!-- ======================================================================= -->
1201 <div class="doc_subsection">
1202   <a name="c-fe">Known problems with the llvm-gcc C front-end</a>
1203 </div>
1204
1205 <div class="doc_text">
1206
1207 <p>The only major language feature of GCC not supported by llvm-gcc is
1208     the <tt>__builtin_apply</tt> family of builtins.   However, some extensions
1209     are only supported on some targets.  For example, trampolines are only
1210     supported on some targets (these are used when you take the address of a
1211     nested function).</p>
1212
1213 <p>If you run into GCC extensions which are not supported, please let us know.
1214 </p>
1215
1216 </div>
1217
1218 <!-- ======================================================================= -->
1219 <div class="doc_subsection">
1220   <a name="c++-fe">Known problems with the llvm-gcc C++ front-end</a>
1221 </div>
1222
1223 <div class="doc_text">
1224
1225 <p>The C++ front-end is considered to be fully
1226 tested and works for a number of non-trivial programs, including LLVM
1227 itself, Qt, Mozilla, etc.</p>
1228
1229 <ul>
1230 <li>Exception handling works well on the X86 and PowerPC targets. Currently
1231   only Linux and Darwin targets are supported (both 32 and 64 bit).</li>
1232 </ul>
1233
1234 </div>
1235
1236 <!-- ======================================================================= -->
1237 <div class="doc_subsection">
1238   <a name="fortran-fe">Known problems with the llvm-gcc Fortran front-end</a>
1239 </div>
1240
1241 <div class="doc_text">
1242 <ul>
1243 <li>Fortran support generally works, but there are still several unresolved bugs
1244     in <a href="http://llvm.org/bugs/">Bugzilla</a>.  Please see the
1245     tools/gfortran component for details.</li>
1246 </ul>
1247 </div>
1248
1249 <!-- ======================================================================= -->
1250 <div class="doc_subsection">
1251   <a name="ada-fe">Known problems with the llvm-gcc Ada front-end</a>
1252 </div>
1253
1254 <div class="doc_text">
1255 The llvm-gcc 4.2 Ada compiler works fairly well; however, this is not a mature
1256 technology, and problems should be expected.
1257 <ul>
1258 <li>The Ada front-end currently only builds on X86-32.  This is mainly due
1259 to lack of trampoline support (pointers to nested functions) on other platforms.
1260 However, it <a href="http://llvm.org/PR2006">also fails to build on X86-64</a>
1261 which does support trampolines.</li>
1262 <li>The Ada front-end <a href="http://llvm.org/PR2007">fails to bootstrap</a>.
1263 This is due to lack of LLVM support for <tt>setjmp</tt>/<tt>longjmp</tt> style
1264 exception handling, which is used internally by the compiler.
1265 Workaround: configure with <tt>--disable-bootstrap</tt>.</li>
1266 <li>The c380004, <a href="http://llvm.org/PR2010">c393010</a>
1267 and <a href="http://llvm.org/PR2421">cxg2021</a> ACATS tests fail
1268 (c380004 also fails with gcc-4.2 mainline).
1269 If the compiler is built with checks disabled then <a href="http://llvm.org/PR2010">c393010</a>
1270 causes the compiler to go into an infinite loop, using up all system memory.</li>
1271 <li>Some GCC specific Ada tests continue to crash the compiler.</li>
1272 <li>The -E binder option (exception backtraces)
1273 <a href="http://llvm.org/PR1982">does not work</a> and will result in programs
1274 crashing if an exception is raised.  Workaround: do not use -E.</li>
1275 <li>Only discrete types <a href="http://llvm.org/PR1981">are allowed to start
1276 or finish at a non-byte offset</a> in a record.  Workaround: do not pack records
1277 or use representation clauses that result in a field of a non-discrete type
1278 starting or finishing in the middle of a byte.</li>
1279 <li>The <tt>lli</tt> interpreter <a href="http://llvm.org/PR2009">considers
1280 'main' as generated by the Ada binder to be invalid</a>.
1281 Workaround: hand edit the file to use pointers for <tt>argv</tt> and
1282 <tt>envp</tt> rather than integers.</li>
1283 <li>The <tt>-fstack-check</tt> option <a href="http://llvm.org/PR2008">is
1284 ignored</a>.</li>
1285 </ul>
1286 </div>
1287
1288 <!-- ======================================================================= -->
1289 <div class="doc_subsection">
1290         <a name="ocaml-bindingse">Known problems with the O'Caml bindings</a>
1291 </div>
1292
1293 <div class="doc_text">
1294
1295 <p>The Llvm.Linkage module is broken, and has incorrect values. Only
1296 Llvm.Linkage.External, Llvm.Linkage.Available_externally, and
1297 Llvm.Linkage.Link_once will be correct. If you need any of the other linkage
1298 modes, you'll have to write an external C library in order to expose the
1299 functionality. This has been fixed in the trunk.</p>
1300 </div>
1301
1302 <!-- *********************************************************************** -->
1303 <div class="doc_section">
1304   <a name="additionalinfo">Additional Information</a>
1305 </div>
1306 <!-- *********************************************************************** -->
1307
1308 <div class="doc_text">
1309
1310 <p>A wide variety of additional information is available on the <a
1311 href="http://llvm.org">LLVM web page</a>, in particular in the <a
1312 href="http://llvm.org/docs/">documentation</a> section.  The web page also
1313 contains versions of the API documentation which is up-to-date with the
1314 Subversion version of the source code.
1315 You can access versions of these documents specific to this release by going
1316 into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
1317
1318 <p>If you have any questions or comments about LLVM, please feel free to contact
1319 us via the <a href="http://llvm.org/docs/#maillist"> mailing
1320 lists</a>.</p>
1321
1322 </div>
1323
1324 <!-- *********************************************************************** -->
1325
1326 <hr>
1327 <address>
1328   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
1329   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
1330   <a href="http://validator.w3.org/check/referer"><img
1331   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
1332
1333   <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
1334   Last modified: $Date$
1335 </address>
1336
1337 </body>
1338 </html>