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.5 Release Notes</title>
   8 </head>
   9 <body>
  10
  11 <div class="doc_title">LLVM 2.5 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.5</a></li>
  17   <li><a href="#whatsnew">What's New in LLVM 2.5?</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.5.  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 <!-- Unfinished features in 2.5:
  56   Machine LICM
  57   Machine Sinking
  58   target-specific intrinsics
  59   gold lto plugin
  60   pre-alloc splitter, strong phi elim
  61   <tt>llc -enable-value-prop</tt>, propagation of value info
  62        (sign/zero ext info) from one MBB to another
  63   debug info for optimized code
  64   interpreter + libffi
  65   postalloc scheduler: anti dependence breaking, hazard recognizer?
  66
  67 initial support for debug line numbers when optimization enabled, not useful in
  68   2.5 but will be for 2.6.
  69
  70  -->
  71
  72  <!-- for announcement email:
  73    -->
  74
  75 <!-- *********************************************************************** -->
  76 <div class="doc_section">
  77   <a name="subproj">Sub-project Status Update</a>
  78 </div>
  79 <!-- *********************************************************************** -->
  80
  81 <div class="doc_text">
  82 <p>
  83 The LLVM 2.5 distribution currently consists of code from the core LLVM
  84 repository &mdash;which roughly includes the LLVM optimizers, code generators
  85 and supporting tools &mdash; and the llvm-gcc repository.  In addition to this
  86 code, the LLVM Project includes other sub-projects that are in development.  The
  87 two which are the most actively developed are the <a href="#clang">Clang
  88 Project</a> and the <a href="#vmkit">VMKit Project</a>.
  89 </p>
  90
  91 </div>
  92
  93
  94 <!--=========================================================================-->
  95 <div class="doc_subsection">
  96 <a name="clang">Clang: C/C++/Objective-C Frontend Toolkit</a>
  97 </div>
  98
  99 <div class="doc_text">
 100
 101 <p>The <a href="http://clang.llvm.org/">Clang project</a> is an effort to build
 102 a set of new 'LLVM native' front-end technologies for the LLVM optimizer and
 103 code generator.  While Clang is not included in the LLVM 2.5 release, it is
 104 continuing to make major strides forward in all areas.  Its C and Objective-C
 105 parsing and code generation support is now very solid.  For example, it is
 106 capable of successfully building many real-world applications for X86-32
 107 and X86-64,
 108 including the <a href="http://wiki.freebsd.org/BuildingFreeBSDWithClang">FreeBSD
 109 kernel</a> and <a href="http://gcc.gnu.org/gcc-4.2/">gcc 4.2</a>.  C++ is also
 110 making <a href="http://clang.llvm.org/cxx_status.html">incredible progress</a>,
 111 and work on templates has recently started.  If you are
 112 interested in fast compiles and good diagnostics, we encourage you to try it out
 113 by <a href="http://clang.llvm.org/get_started.html">building from mainline</a>
 114 and reporting any issues you hit to the <a
 115 href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-dev">Clang front-end mailing
 116 list</a>.</p>
 117
 118 <p>In the LLVM 2.5 time-frame, the Clang team has made many improvements:</p>
 119
 120 <ul>
 121 <li>Clang now has a new driver, which is focused on providing a GCC-compatible
 122     interface.</li>
 123 <li>The X86-64 ABI is now supported, including support for the Apple
 124     64-bit Objective-C runtime and zero cost exception handling.</li>
 125 <li>Precompiled header support is now implemented.</li>
 126 <li>Objective-C support is significantly improved beyond LLVM 2.4, supporting
 127     many features, such as Objective-C Garbage Collection.</li>
 128 <li>Variable length arrays are now fully supported.</li>
 129 <li>C99 designated initializers are now fully supported.</li>
 130 <li>Clang now includes all major compiler headers, including a
 131     redesigned <i>tgmath.h</i> and several more intrinsic headers.</li>
 132 <li>Many many bugs are fixed and many features have been added.</li>
 133 </ul>
 134 </div>
 135
 136 <!--=========================================================================-->
 137 <div class="doc_subsection">
 138 <a name="clangsa">Clang Static Analyzer</a>
 139 </div>
 140
 141 <div class="doc_text">
 142
 143 <p>Previously announced in the last LLVM release, the Clang project also
 144 includes an early stage static source code analysis tool for <a
 145 href="http://clang.llvm.org/StaticAnalysis.html">automatically finding bugs</a>
 146 in C and Objective-C programs. The tool performs a growing set of checks to find
 147 bugs that occur on a specific path within a program.</p>
 148
 149 <p>In the LLVM 2.5 time-frame there have been many significant improvements to
 150 the analyzer's core path simulation engine and machinery for generating
 151 path-based bug reports to end-users. Particularly noteworthy improvements
 152 include experimental support for full field-sensitivity and reasoning about heap
 153 objects as well as an improved value-constraints subengine that does a much
 154 better job of reasoning about inequality relationships (e.g., <tt>x &gt; 2</tt>)
 155 between variables and constants.
 156
 157 <p>The set of checks performed by the static analyzer continues to expand, and
 158 future plans for the tool include full source-level inter-procedural analysis
 159 and deeper checks such as buffer overrun detection. There are many opportunities
 160 to extend and enhance the static analyzer, and anyone interested in working on
 161 this project is encouraged to get involved!</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 Machines (Microsoft .NET is an
 174 implementation of the CLI) using the Just-In-Time compiler of LLVM.</p>
 175
 176 <p>Following LLVM 2.5, VMKit has its second release that you can find on its
 177 <a href="http://vmkit.llvm.org/releases/">webpage</a>. The release includes
 178 bug fixes, cleanup and new features. The major changes are:</p>
 179
 180 <ul>
 181
 182 <li>Ahead of Time compiler: compiles .class files to llvm .bc. VMKit uses this
 183 functionality to native compile the standard classes (e.g. java.lang.String).
 184 Users can compile AoT .class files into dynamic libraries and run them with the
 185 help of VMKit.</li>
 186
 187 <li>New exception model: the dwarf exception model is very slow for
 188 exception-intensive applications, so the JVM has had a new implementation of
 189 exceptions which check at each function call if an exception happened. There is
 190 a low performance penalty on applications without exceptions, but it is a big
 191 gain for exception-intensive applications. For example the jack benchmark in
 192 Spec JVM98 is 6x faster (performance gain of 83%).</li>
 193
 194 <li>User-level management of thread stacks, so that thread local data access
 195 at runtime is fast and portable. </li>
 196
 197 <li>Implementation of biased locking for faster object synchronizations at
 198 runtime.</li>
 199
 200 <li>New support for OSX/X64, Linux/X64 (with the Boehm GC) and Linux/ppc32.</li>
 201
 202 </ul>
 203 </div>
 204
 205 <!-- *********************************************************************** -->
 206 <div class="doc_section">
 207   <a name="externalproj">External Projects Using LLVM 2.5</a>
 208 </div>
 209 <!-- *********************************************************************** -->
 210
 211 <!--=========================================================================-->
 212 <div class="doc_subsection">
 213 <a name="pure">Pure</a>
 214 </div>
 215
 216 <div class="doc_text">
 217 <p>
 218 <a href="http://pure-lang.googlecode.com/">Pure</a>
 219 is an algebraic/functional programming language based on term rewriting.
 220 Programs are collections of equations which are used to evaluate expressions in
 221 a symbolic fashion. Pure offers dynamic typing, eager and lazy evaluation,
 222 lexical closures, a hygienic macro system (also based on term rewriting),
 223 built-in list and matrix support (including list and matrix comprehensions) and
 224 an easy-to-use C interface. The interpreter uses LLVM as a backend to
 225  JIT-compile Pure programs to fast native code.</p>
 226
 227 <p>In addition to the usual algebraic data structures, Pure also has
 228 MATLAB-style matrices in order to support numeric computations and signal
 229 processing in an efficient way. Pure is mainly aimed at mathematical
 230 applications right now, but it has been designed as a general purpose language.
 231 The dynamic interpreter environment and the C interface make it possible to use
 232 it as a kind of functional scripting language for many application areas.
 233 </p>
 234 </div>
 235
 236
 237 <!--=========================================================================-->
 238 <div class="doc_subsection">
 239 <a name="ldc">LLVM D Compiler</a>
 240 </div>
 241
 242 <div class="doc_text">
 243 <p>
 244 <a href="http://www.dsource.org/projects/ldc">LDC</a> is an implementation of
 245 the D Programming Language using the LLVM optimizer and code generator.
 246 The LDC project works great with the LLVM 2.5 release.  General improvements in
 247 this
 248 cycle have included new inline asm constraint handling, better debug info
 249 support, general bugfixes, and better x86-64 support.  This has allowed
 250 some major improvements in LDC, getting us much closer to being as
 251 fully featured as the original DMD compiler from DigitalMars.
 252 </p>
 253 </div>
 254
 255 <!--=========================================================================-->
 256 <div class="doc_subsection">
 257 <a name="RoadsendPHP">Roadsend PHP</a>
 258 </div>
 259
 260 <div class="doc_text">
 261 <p><a href="http://code.roadsend.com/rphp">Roadsend PHP</a> (rphp) is an open
 262 source implementation of the PHP programming
 263 language that uses LLVM for its optimizer, JIT, and static compiler. This is a
 264 reimplementation of an earlier project that is now based on LLVM.</p>
 265 </div>
 266
 267
 268 <!-- *********************************************************************** -->
 269 <div class="doc_section">
 270   <a name="whatsnew">What's New in LLVM 2.5?</a>
 271 </div>
 272 <!-- *********************************************************************** -->
 273
 274 <div class="doc_text">
 275
 276 <p>This release includes a huge number of bug fixes, performance tweaks, and
 277 minor improvements.  Some of the major improvements and new features are listed
 278 in this section.
 279 </p>
 280 </div>
 281
 282 <!--=========================================================================-->
 283 <div class="doc_subsection">
 284 <a name="majorfeatures">Major New Features</a>
 285 </div>
 286
 287 <div class="doc_text">
 288
 289 <p>LLVM 2.5 includes several major new capabilities:</p>
 290
 291 <ul>
 292 <li>LLVM 2.5 includes a brand new <a
 293 href="http://en.wikipedia.org/wiki/XCore">XCore</a> backend.</li>
 294
 295 <li>llvm-gcc now generally supports the GFortran front-end, and the precompiled
 296 release binaries now support Fortran, even on Mac OS/X.</li>
 297
 298 <li>CMake is now used by the <a href="GettingStartedVS.html">LLVM build process
 299 on Windows</a>.  It automatically generates Visual Studio project files (and
 300 more) from a set of simple text files.  This makes it much easier to
 301 maintain.  In time, we'd like to standardize on CMake for everything.</li>
 302
 303 <li>LLVM 2.5 now uses (and includes) Google Test for unit testing.</li>
 304
 305 <li>The LLVM native code generator now supports arbitrary precision integers.
 306 Types like <tt>i33</tt> have long been valid in the LLVM IR, but were previously
 307 only supported by the interpreter.  Note that the C backend still does not
 308 support these.</li>
 309
 310 <li>LLVM 2.5 no longer uses 'bison,' so it is easier to build on Windows.</li>
 311 </ul>
 312
 313 </div>
 314
 315
 316 <!--=========================================================================-->
 317 <div class="doc_subsection">
 318 <a name="llvm-gcc">llvm-gcc 4.2 Improvements</a>
 319 </div>
 320
 321 <div class="doc_text">
 322
 323 <p>LLVM fully supports the llvm-gcc 4.2 front-end, which marries the GCC
 324 front-ends and driver with the LLVM optimizer and code generator.  It currently
 325 includes support for the C, C++, Objective-C, Ada, and Fortran front-ends.</p>
 326
 327 <ul>
 328 <li>In this release, the GCC inliner is completely disabled.  Previously the GCC
 329 inliner was used to handle always-inline functions and other cases.  This caused
 330 problems with code size growth, and it is completely disabled in this
 331 release.</li>
 332
 333 <li>llvm-gcc (and LLVM in general) now support code generation for stack
 334 canaries, which is an effective form of <a
 335 href="http://en.wikipedia.org/wiki/Stack-smashing_protection">buffer overflow
 336 protection</a>.  llvm-gcc supports this with the <tt>-fstack-protector</tt>
 337 command line option (just like GCC).  In LLVM IR, you can request code
 338 generation for stack canaries with function attributes.
 339 </li>
 340 </ul>
 341
 342 </div>
 343
 344
 345 <!--=========================================================================-->
 346 <div class="doc_subsection">
 347 <a name="coreimprovements">LLVM IR and Core Improvements</a>
 348 </div>
 349
 350 <div class="doc_text">
 351 <p>LLVM IR has several new features that are used by our existing front-ends and
 352 can be useful if you are writing a front-end for LLVM:</p>
 353
 354 <ul>
 355 <li>The <a href="LangRef.html#i_shufflevector">shufflevector</a> instruction
 356 has been generalized to allow different shuffle mask width than its input
 357 vectors.  This allows you to use shufflevector to combine two
 358 "&lt;4 x float&gt;" vectors into a "&lt;8 x float&gt;" for example.</li>
 359
 360 <li>LLVM IR now supports new intrinsics for computing and acting on <a
 361 href="LangRef.html#int_overflow">overflow of integer operations</a>. This allows
 362 efficient code generation for languages that must trap or throw an exception on
 363 overflow.  While these intrinsics work on all targets, they only generate
 364 efficient code on X86 so far.</li>
 365
 366 <li>LLVM IR now supports a new <a href="LangRef.html#linkage">private
 367 linkage</a> type to produce labels that are stripped by the assembler before it
 368 produces a .o file (thus they are invisible to the linker).</li>
 369
 370 <li>LLVM IR supports two new attributes for better alias analysis.  The <a
 371 href="LangRef.html#paramattrs">noalias</a> attribute can now be used on the
 372 return value of a function to indicate that it returns new memory (e.g.
 373 'malloc', 'calloc', etc).
 374 The new <a href="LangRef.html#paramattrs">nocapture</a> attribute can be used
 375 on pointer arguments to indicate that the function does not return the pointer,
 376 store it in an object that outlives the call, or let the value of the pointer
 377 escape from the function in any other way.
 378 Note that it is the pointer itself that must not escape, not the value it
 379 points to: loading a value out of the pointer is perfectly fine.
 380 Many standard library functions (e.g. 'strlen', 'memcpy') have this property.
 381 <!-- The simplifylibcalls pass applies these attributes to standard libc functions. -->
 382 </li>
 383
 384 <li>The parser for ".ll" files in lib/AsmParser is now completely rewritten as a
 385 recursive descent parser.  This parser produces better error messages (including
 386 caret diagnostics), is less fragile (less likely to crash on strange things),
 387 does not leak memory, is more efficient, and eliminates LLVM's last use of the
 388 'bison' tool.</li>
 389
 390 <li>Debug information representation and manipulation internals have been
 391     consolidated to use a new set of classes in
 392     <tt>llvm/Analysis/DebugInfo.h</tt>.  These routines are more
 393     efficient, robust, and extensible and replace the older mechanisms.
 394     llvm-gcc, clang, and the code generator now use them to create and process
 395     debug information.</li>
 396
 397 </ul>
 398
 399 </div>
 400
 401 <!--=========================================================================-->
 402 <div class="doc_subsection">
 403 <a name="optimizer">Optimizer Improvements</a>
 404 </div>
 405
 406 <div class="doc_text">
 407
 408 <p>In addition to a large array of bug fixes and minor performance tweaks, this
 409 release includes a few major enhancements and additions to the optimizers:</p>
 410
 411 <ul>
 412
 413 <li>The loop optimizer now improves floating point induction variables in
 414 several ways, including adding shadow induction variables to avoid
 415 "integer &lt;-&gt; floating point" conversions in loops when safe.</li>
 416
 417 <li>The "-mem2reg" pass is now much faster on code with large basic blocks.</li>
 418
 419 <li>The "-jump-threading" pass is more powerful: it is iterative
 420   and handles threading based on values with fully and partially redundant
 421   loads.</li>
 422
 423 <li>The "-memdep" memory dependence analysis pass (used by GVN and memcpyopt) is
 424     both faster and more aggressive.</li>
 425
 426 <li>The "-scalarrepl" scalar replacement of aggregates pass is more aggressive
 427     about promoting unions to registers.</li>
 428
 429 </ul>
 430
 431 </div>
 432
 433 <!--=========================================================================-->
 434 <div class="doc_subsection">
 435 <a name="codegen">Target Independent Code Generator Improvements</a>
 436 </div>
 437
 438 <div class="doc_text">
 439
 440 <p>We have put a significant amount of work into the code generator
 441 infrastructure, which allows us to implement more aggressive algorithms and make
 442 it run faster:</p>
 443
 444 <ul>
 445 <li>The <a href="WritingAnLLVMBackend.html">Writing an LLVM Compiler
 446 Backend</a> document has been greatly expanded and is substantially more
 447 complete.</li>
 448
 449 <li>The SelectionDAG type legalization logic has been completely rewritten, is
 450 now more powerful (it supports arbitrary precision integer types for example),
 451 and is more correct in several corner cases.  The type legalizer converts
 452 operations on types that are not natively supported by the target machine into
 453 equivalent code sequences that only use natively supported types.  The old type
 454 legalizer is still available (for now) and will be used if
 455 <tt>-disable-legalize-types</tt> is passed to the code generator.
 456 </li>
 457
 458 <li>The code generator now supports widening illegal vectors to larger legal
 459 ones (for example, converting operations on &lt;3 x float&gt; to work on
 460 &lt;4 x float&gt;) which is very important for common graphics
 461 applications.</li>
 462
 463 <li>The assembly printers for each target are now split out into their own
 464 libraries that are separate from the main code generation logic.  This reduces
 465 the code size of JIT compilers by not requiring them to be linked in.</li>
 466
 467 <li>The 'fast' instruction selection path (used at -O0 and for fast JIT
 468     compilers) now supports accelerating codegen for code that uses exception
 469     handling constructs.</li>
 470
 471 <li>The optional PBQP register allocator now supports register coalescing.</li>
 472 </ul>
 473 </div>
 474
 475 <!--=========================================================================-->
 476 <div class="doc_subsection">
 477 <a name="x86">X86-32 and X86-64 Target Improvements</a>
 478 </div>
 479
 480 <div class="doc_text">
 481 <p>New features of the X86 target include:
 482 </p>
 483
 484 <ul>
 485 <li>The <tt><a href="LangRef.html#int_returnaddress">llvm.returnaddress</a></tt>
 486 intrinsic (which is used to implement <tt>__builtin_return_address</tt>) now
 487 supports non-zero stack depths on X86.</li>
 488
 489 <li>The X86 backend now supports code generation of vector shift operations
 490 using SSE instructions.</li>
 491
 492 <li>X86-64 code generation now takes advantage of red zone, unless the
 493 <tt>-mno-red-zone</tt> option is specified.</li>
 494
 495 <li>The X86 backend now supports using address space #256 in LLVM IR as a way of
 496 performing memory references off the GS segment register.  This allows a
 497 front-end to take advantage of very low-level programming techniques when
 498 targeting X86 CPUs. See <tt>test/CodeGen/X86/movgs.ll</tt> for a simple
 499 example.</li>
 500
 501 <li>The X86 backend now supports a <tt>-disable-mmx</tt> command line option to
 502   prevent use of MMX even on chips that support it.  This is important for cases
 503   where code does not contain the proper <tt>llvm.x86.mmx.emms</tt>
 504   intrinsics.</li>
 505
 506 <li>The X86 JIT now detects the new Intel <a
 507    href="http://en.wikipedia.org/wiki/Intel_Core_i7">Core i7</a> and <a
 508    href="http://en.wikipedia.org/wiki/Intel_Atom">Atom</a> chips and
 509     auto-configures itself appropriately for the features of these chips.</li>
 510
 511 <li>The JIT now supports exception handling constructs on Linux/X86-64 and
 512     Darwin/x86-64.</li>
 513
 514 <li>The JIT supports Thread Local Storage (TLS) on Linux/X86-32 but not yet on
 515     X86-64.</li>
 516 </ul>
 517
 518 </div>
 519
 520 <!--=========================================================================-->
 521 <div class="doc_subsection">
 522 <a name="pic16">PIC16 Target Improvements</a>
 523 </div>
 524
 525 <div class="doc_text">
 526 <p>New features of the PIC16 target include:
 527 </p>
 528
 529 <ul>
 530 <li>Both direct and indirect load/stores work now.</li>
 531 <li>Logical, bitwise and conditional operations now work for integer data
 532 types.</li>
 533 <li>Function calls involving basic types work now.</li>
 534 <li>Support for integer arrays.</li>
 535 <li>The compiler can now emit libcalls for operations not supported by m/c
 536 instructions.</li>
 537 <li>Support for both data and ROM address spaces.</li>
 538 </ul>
 539
 540 <p>Things not yet supported:</p>
 541
 542 <ul>
 543 <li>Floating point.</li>
 544 <li>Passing/returning aggregate types to and from functions.</li>
 545 <li>Variable arguments.</li>
 546 <li>Indirect function calls.</li>
 547 <li>Interrupts/programs.</li>
 548 <li>Debug info.</li>
 549 </ul>
 550
 551 </div>
 552
 553
 554 <!--=========================================================================-->
 555 <div class="doc_subsection">
 556 <a name="llvmc">Improvements in LLVMC</a>
 557 </div>
 558
 559 <div class="doc_text">
 560 <p>New features include:</p>
 561
 562 <ul>
 563 <li>Beginning with LLVM 2.5, <tt>llvmc2</tt> is known as
 564  just <tt>llvmc</tt>. The old <tt>llvmc</tt> driver was removed.</li>
 565
 566 <li>The Clang plugin was substantially improved and is now enabled
 567  by default. The command <tt>llvmc --clang</tt> can be now used as a
 568  synonym to <tt>ccc</tt>.</li>
 569
 570 <li>There is now a <tt>--check-graph</tt> option, which is supposed to catch
 571  common errors like multiple default edges, mismatched output/input language
 572  names and cycles. In general, these checks can't be done at compile-time
 573  because of the need to support plugins.</li>
 574
 575 <li>Plugins are now more flexible and can refer to compilation graph nodes and
 576  options defined in other plugins. To manage dependencies, a priority-sorting
 577  mechanism was introduced. This change affects the TableGen file syntax. See the
 578  documentation for details.</li>
 579
 580 <li>Hooks can now be provided with arguments. The syntax is "<tt>$CALL(MyHook,
 581  'Arg1', 'Arg2', 'Arg3')</tt>".</li>
 582
 583 <li>A new option type: multi-valued option, for options that take more than one
 584  argument (for example, "<tt>-foo a b c</tt>").</li>
 585
 586 <li>New option properties: '<tt>one_or_more</tt>', '<tt>zero_or_more</tt>',
 587 '<tt>hidden</tt>' and '<tt>really_hidden</tt>'.</li>
 588
 589 <li>The '<tt>case</tt>' expression gained an '<tt>error</tt>' action and
 590  an '<tt>empty</tt>' test (equivalent to "<tt>(not (not_empty ...))</tt>").</li>
 591
 592 <li>Documentation now looks more consistent to the rest of the LLVM
 593  docs. There is also a man page now.</li>
 594
 595 </ul>
 596
 597 </div>
 598
 599
 600 <!--=========================================================================-->
 601 <div class="doc_subsection">
 602 <a name="changes">Major Changes and Removed Features</a>
 603 </div>
 604
 605 <div class="doc_text">
 606
 607 <p>If you're already an LLVM user or developer with out-of-tree changes based
 608 on LLVM 2.4, this section lists some "gotchas" that you may run into upgrading
 609 from the previous release.</p>
 610
 611 <ul>
 612
 613 <li>llvm-gcc defaults to <tt>-fno-math-errno</tt> on all X86 targets.</li>
 614
 615 </ul>
 616
 617
 618 <p>In addition, many APIs have changed in this release.  Some of the major LLVM
 619 API changes are:</p>
 620
 621 <ul>
 622 <li>Some deprecated interfaces to create <tt>Instruction</tt> subclasses, that
 623     were spelled with lower case "create," have been removed.</li>
 624 </ul>
 625
 626 </div>
 627
 628
 629
 630 <!-- *********************************************************************** -->
 631 <div class="doc_section">
 632   <a name="portability">Portability and Supported Platforms</a>
 633 </div>
 634 <!-- *********************************************************************** -->
 635
 636 <div class="doc_text">
 637
 638 <p>LLVM is known to work on the following platforms:</p>
 639
 640 <ul>
 641 <li>Intel and AMD machines (IA32, X86-64, AMD64, EMT-64) running Red Hat
 642 Linux, Fedora Core and FreeBSD (and probably other unix-like systems).</li>
 643 <li>PowerPC and X86-based Mac OS X systems, running 10.3 and above in 32-bit
 644 and 64-bit modes.</li>
 645 <li>Intel and AMD machines running on Win32 using MinGW libraries (native).</li>
 646 <li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
 647     support is available for native builds with Visual C++).</li>
 648 <li>Sun UltraSPARC workstations running Solaris 10.</li>
 649 <li>Alpha-based machines running Debian GNU/Linux.</li>
 650 <li>Itanium-based (IA64) machines running Linux and HP-UX.</li>
 651 </ul>
 652
 653 <p>The core LLVM infrastructure uses GNU autoconf to adapt itself
 654 to the machine and operating system on which it is built.  However, minor
 655 porting may be required to get LLVM to work on new platforms.  We welcome your
 656 portability patches and reports of successful builds or error messages.</p>
 657
 658 </div>
 659
 660 <!-- *********************************************************************** -->
 661 <div class="doc_section">
 662   <a name="knownproblems">Known Problems</a>
 663 </div>
 664 <!-- *********************************************************************** -->
 665
 666 <div class="doc_text">
 667
 668 <p>This section contains significant known problems with the LLVM system,
 669 listed by component.  If you run into a problem, please check the <a
 670 href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
 671 there isn't already one.</p>
 672
 673 </div>
 674
 675 <!-- ======================================================================= -->
 676 <div class="doc_subsection">
 677   <a name="experimental">Experimental features included with this release</a>
 678 </div>
 679
 680 <div class="doc_text">
 681
 682 <p>The following components of this LLVM release are either untested, known to
 683 be broken or unreliable, or are in early development.  These components should
 684 not be relied on, and bugs should not be filed against them, but they may be
 685 useful to some people.  In particular, if you would like to work on one of these
 686 components, please contact us on the <a
 687 href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p>
 688
 689 <ul>
 690 <li>The MSIL, IA64, Alpha, SPU, MIPS, and PIC16 backends are experimental.</li>
 691 <li>The <tt>llc</tt> "<tt>-filetype=asm</tt>" (the default) is the only
 692     supported value for this option.</li>
 693 </ul>
 694
 695 </div>
 696
 697 <!-- ======================================================================= -->
 698 <div class="doc_subsection">
 699   <a name="x86-be">Known problems with the X86 back-end</a>
 700 </div>
 701
 702 <div class="doc_text">
 703
 704 <ul>
 705   <li>The X86 backend does not yet support
 706     all <a href="http://llvm.org/PR879">inline assembly that uses the X86
 707     floating point stack</a>.  It supports the 'f' and 't' constraints, but not
 708     'u'.</li>
 709   <li>The X86 backend generates inefficient floating point code when configured
 710     to generate code for systems that don't have SSE2.</li>
 711   <li>Win64 code generation wasn't widely tested. Everything should work, but we
 712     expect small issues to happen. Also, llvm-gcc cannot build the mingw64
 713     runtime currently due
 714     to <a href="http://llvm.org/PR2255">several</a>
 715     <a href="http://llvm.org/PR2257">bugs</a> and due to lack of support for
 716     the
 717     'u' inline assembly constraint and for X87 floating point inline assembly.</li>
 718   <li>The X86-64 backend does not yet support the LLVM IR instruction
 719       <tt>va_arg</tt>. Currently, the llvm-gcc and front-ends support variadic
 720       argument constructs on X86-64 by lowering them manually.</li>
 721 </ul>
 722
 723 </div>
 724
 725 <!-- ======================================================================= -->
 726 <div class="doc_subsection">
 727   <a name="ppc-be">Known problems with the PowerPC back-end</a>
 728 </div>
 729
 730 <div class="doc_text">
 731
 732 <ul>
 733 <li>The Linux PPC32/ABI support needs testing for the interpreter and static
 734 compilation, and lacks support for debug information.</li>
 735 </ul>
 736
 737 </div>
 738
 739 <!-- ======================================================================= -->
 740 <div class="doc_subsection">
 741   <a name="arm-be">Known problems with the ARM back-end</a>
 742 </div>
 743
 744 <div class="doc_text">
 745
 746 <ul>
 747 <li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
 748 processors, thumb programs can crash or produce wrong
 749 results (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
 750 <li>Compilation for ARM Linux OABI (old ABI) is supported but not fully tested.
 751 </li>
 752 <li>There is a bug in QEMU-ARM (&lt;= 0.9.0) which causes it to incorrectly
 753  execute
 754 programs compiled with LLVM.  Please use more recent versions of QEMU.</li>
 755 </ul>
 756
 757 </div>
 758
 759 <!-- ======================================================================= -->
 760 <div class="doc_subsection">
 761   <a name="sparc-be">Known problems with the SPARC back-end</a>
 762 </div>
 763
 764 <div class="doc_text">
 765
 766 <ul>
 767 <li>The SPARC backend only supports the 32-bit SPARC ABI (-m32); it does not
 768     support the 64-bit SPARC ABI (-m64).</li>
 769 </ul>
 770
 771 </div>
 772
 773 <!-- ======================================================================= -->
 774 <div class="doc_subsection">
 775   <a name="mips-be">Known problems with the MIPS back-end</a>
 776 </div>
 777
 778 <div class="doc_text">
 779
 780 <ul>
 781 <li>The O32 ABI is not fully supported.</li>
 782 <li>64-bit MIPS targets are not supported yet.</li>
 783 </ul>
 784
 785 </div>
 786
 787 <!-- ======================================================================= -->
 788 <div class="doc_subsection">
 789   <a name="alpha-be">Known problems with the Alpha back-end</a>
 790 </div>
 791
 792 <div class="doc_text">
 793
 794 <ul>
 795
 796 <li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
 797 appropriate nops inserted to ensure restartability.</li>
 798
 799 </ul>
 800 </div>
 801
 802 <!-- ======================================================================= -->
 803 <div class="doc_subsection">
 804   <a name="ia64-be">Known problems with the IA64 back-end</a>
 805 </div>
 806
 807 <div class="doc_text">
 808
 809 <ul>
 810 <li>The Itanium backend is highly experimental and has a number of known
 811     issues.  We are looking for a maintainer for the Itanium backend.  If you
 812     are interested, please contact the LLVMdev mailing list.</li>
 813 </ul>
 814
 815 </div>
 816
 817 <!-- ======================================================================= -->
 818 <div class="doc_subsection">
 819   <a name="c-be">Known problems with the C back-end</a>
 820 </div>
 821
 822 <div class="doc_text">
 823
 824 <ul>
 825 <li><a href="http://llvm.org/PR802">The C backend has only basic support for
 826     inline assembly code</a>.</li>
 827 <li><a href="http://llvm.org/PR1658">The C backend violates the ABI of common
 828     C++ programs</a>, preventing intermixing between C++ compiled by the CBE and
 829     C++ code compiled with <tt>llc</tt> or native compilers.</li>
 830 <li>The C backend does not support all exception handling constructs.</li>
 831 <li>The C backend does not support arbitrary precision integers.</li>
 832 </ul>
 833
 834 </div>
 835
 836
 837 <!-- ======================================================================= -->
 838 <div class="doc_subsection">
 839   <a name="c-fe">Known problems with the llvm-gcc C front-end</a>
 840 </div>
 841
 842 <div class="doc_text">
 843
 844 <p>llvm-gcc does not currently support <a href="http://llvm.org/PR869">Link-Time
 845 Optimization</a> on most platforms "out-of-the-box".  Please inquire on the
 846 LLVMdev mailing list if you are interested.</p>
 847
 848 <p>The only major language feature of GCC not supported by llvm-gcc is
 849     the <tt>__builtin_apply</tt> family of builtins.   However, some extensions
 850     are only supported on some targets.  For example, trampolines are only
 851     supported on some targets (these are used when you take the address of a
 852     nested function).</p>
 853
 854 <p>If you run into GCC extensions which are not supported, please let us know.
 855 </p>
 856
 857 </div>
 858
 859 <!-- ======================================================================= -->
 860 <div class="doc_subsection">
 861   <a name="c++-fe">Known problems with the llvm-gcc C++ front-end</a>
 862 </div>
 863
 864 <div class="doc_text">
 865
 866 <p>The C++ front-end is considered to be fully
 867 tested and works for a number of non-trivial programs, including LLVM
 868 itself, Qt, Mozilla, etc.</p>
 869
 870 <ul>
 871 <li>Exception handling works well on the X86 and PowerPC targets. Currently
 872   only Linux and Darwin targets are supported (both 32 and 64 bit).</li>
 873 </ul>
 874
 875 </div>
 876
 877 <!-- ======================================================================= -->
 878 <div class="doc_subsection">
 879   <a name="fortran-fe">Known problems with the llvm-gcc Fortran front-end</a>
 880 </div>
 881
 882 <div class="doc_text">
 883 <ul>
 884 <li>Fortran support generally works, but there are still several unresolved bugs
 885     in Bugzilla.  Please see the tools/gfortran component for details.</li>
 886 </ul>
 887 </div>
 888
 889 <!-- ======================================================================= -->
 890 <div class="doc_subsection">
 891   <a name="ada-fe">Known problems with the llvm-gcc Ada front-end</a>
 892 </div>
 893
 894 <div class="doc_text">
 895 The llvm-gcc 4.2 Ada compiler works fairly well; however, this is not a mature
 896 technology, and problems should be expected.
 897 <ul>
 898 <li>The Ada front-end currently only builds on X86-32.  This is mainly due
 899 to lack of trampoline support (pointers to nested functions) on other platforms.
 900 However, it <a href="http://llvm.org/PR2006">also fails to build on X86-64</a>
 901 which does support trampolines.</li>
 902 <li>The Ada front-end <a href="http://llvm.org/PR2007">fails to bootstrap</a>.
 903 This is due to lack of LLVM support for <tt>setjmp</tt>/<tt>longjmp</tt> style
 904 exception handling, which is used internally by the compiler.
 905 Workaround: configure with --disable-bootstrap.</li>
 906 <li>The c380004, <a href="http://llvm.org/PR2010">c393010</a>
 907 and <a href="http://llvm.org/PR2421">cxg2021</a> ACATS tests fail
 908 (c380004 also fails with gcc-4.2 mainline).
 909 If the compiler is built with checks disabled then <a href="http://llvm.org/PR2010">c393010</a>
 910 causes the compiler to go into an infinite loop, using up all system memory.</li>
 911 <li>Some GCC specific Ada tests continue to crash the compiler.</li>
 912 <li>The -E binder option (exception backtraces)
 913 <a href="http://llvm.org/PR1982">does not work</a> and will result in programs
 914 crashing if an exception is raised.  Workaround: do not use -E.</li>
 915 <li>Only discrete types <a href="http://llvm.org/PR1981">are allowed to start
 916 or finish at a non-byte offset</a> in a record.  Workaround: do not pack records
 917 or use representation clauses that result in a field of a non-discrete type
 918 starting or finishing in the middle of a byte.</li>
 919 <li>The <tt>lli</tt> interpreter <a href="http://llvm.org/PR2009">considers
 920 'main' as generated by the Ada binder to be invalid</a>.
 921 Workaround: hand edit the file to use pointers for <tt>argv</tt> and
 922 <tt>envp</tt> rather than integers.</li>
 923 <li>The <tt>-fstack-check</tt> option <a href="http://llvm.org/PR2008">is
 924 ignored</a>.</li>
 925 </ul>
 926 </div>
 927
 928 <!-- *********************************************************************** -->
 929 <div class="doc_section">
 930   <a name="additionalinfo">Additional Information</a>
 931 </div>
 932 <!-- *********************************************************************** -->
 933
 934 <div class="doc_text">
 935
 936 <p>A wide variety of additional information is available on the <a
 937 href="http://llvm.org">LLVM web page</a>, in particular in the <a
 938 href="http://llvm.org/docs/">documentation</a> section.  The web page also
 939 contains versions of the API documentation which is up-to-date with the
 940 Subversion version of the source code.
 941 You can access versions of these documents specific to this release by going
 942 into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
 943
 944 <p>If you have any questions or comments about LLVM, please feel free to contact
 945 us via the <a href="http://llvm.org/docs/#maillist"> mailing
 946 lists</a>.</p>
 947
 948 </div>
 949
 950 <!-- *********************************************************************** -->
 951
 952 <hr>
 953 <address>
 954   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
 955   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
 956   <a href="http://validator.w3.org/check/referer"><img
 957   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
 958
 959   <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
 960   Last modified: $Date$
 961 </address>
 962
 963 </body>
 964 </html>