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.4 Release Notes</title>
   8 </head>
   9 <body>
  10
  11 <div class="doc_title">LLVM 2.4 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="#whatsnew">What's New in LLVM?</a></li>
  17   <li><a href="GettingStarted.html">Installation Instructions</a></li>
  18   <li><a href="#portability">Portability and Supported Platforms</a></li>
  19   <li><a href="#knownproblems">Known Problems</a></li>
  20   <li><a href="#additionalinfo">Additional Information</a></li>
  21 </ol>
  22
  23 <div class="doc_author">
  24   <p>Written by the <a href="http://llvm.org">LLVM Team</a></p>
  25 </div>
  26
  27 <!-- *********************************************************************** -->
  28 <div class="doc_section">
  29   <a name="intro">Introduction</a>
  30 </div>
  31 <!-- *********************************************************************** -->
  32
  33 <div class="doc_text">
  34
  35 <p>This document contains the release notes for the LLVM Compiler
  36 Infrastructure, release 2.4.  Here we describe the status of LLVM, including
  37 major improvements from the previous release and significant known problems.
  38 All LLVM releases may be downloaded from the <a
  39 href="http://llvm.org/releases/">LLVM releases web site</a>.</p>
  40
  41 <p>For more information about LLVM, including information about the latest
  42 release, please check out the <a href="http://llvm.org/">main LLVM
  43 web site</a>.  If you have questions or comments, the <a
  44 href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM Developer's Mailing
  45 List</a> is a good place to send them.</p>
  46
  47 <p>Note that if you are reading this file from a Subversion checkout or the
  48 main LLVM web page, this document applies to the <i>next</i> release, not the
  49 current one.  To see the release notes for a specific release, please see the
  50 <a href="http://llvm.org/releases/">releases page</a>.</p>
  51
  52 </div>
  53
  54 <!-- Unfinished features in 2.4:
  55   Machine LICM
  56   Machine Sinking
  57   LegalizeDAGTypes
  58   llc -enable-value-prop, propagation of value info (sign/zero ext info) from
  59        one MBB to another
  60  -->
  61
  62  <!-- for announcement email:
  63     mention dev mtg
  64     Xcode 3.1 and 3.1.1.
  65   -->
  66
  67 <!-- *********************************************************************** -->
  68 <div class="doc_section">
  69   <a name="subproj">Sub-project Status Update</a>
  70 </div>
  71 <!-- *********************************************************************** -->
  72
  73 <div class="doc_text">
  74 <p>
  75 The LLVM 2.4 distribution currently consists of code from the core LLVM
  76 repository (which roughly includes the LLVM optimizers, code generators and
  77 supporting tools) and the llvm-gcc repository.  In addition to this code, the
  78 LLVM Project includes other sub-projects that are in development.  The two which
  79 are the most actively developed are the <a href="#clang">Clang Project</a> and
  80 the <a href="#vmkit">VMKit Project</a>.
  81 </p>
  82
  83 </div>
  84
  85
  86 <!--=========================================================================-->
  87 <div class="doc_subsection">
  88 <a name="clang">Clang: C/C++/Objective-C Frontend Toolkit</a>
  89 </div>
  90
  91 <div class="doc_text">
  92
  93 <p>The <a href="http://clang.llvm.org/">Clang project</a> is an effort to build
  94 a set of new 'LLVM native' front-end technologies for the LLVM optimizer
  95 and code generator.  Clang is continuing to make major strides forward in all
  96 areas.  Its C and Objective-C parsing support is very solid, and the code
  97 generation support is far enough along to build many C applications.  While not
  98 yet production quality, it is progressing very nicely.  In addition, C++
  99 front-end work has started to make significant progress.</p>
 100
 101 Clang, in conjunction with the <tt>ccc</tt> driver, is now usable as a
 102 replacement for gcc for building some small- to medium-sized  C applications.
 103 Additionally, Clang now has code generation support for Objective-C on Mac OS X
 104 platform. Major highlights include:
 105 <ul>
 106         <li> Clang/ccc pass almost all of the LLVM test suite on Mac OS X and Linux
 107 on the 32-bit x86 architecture. This includes significant C
 108 applications such as <a href="http://www.sqlite.org">sqlite3</a>,
 109 <a href="http://www.lua.org">lua</a>, and
 110 <a href="http://www.clamav.net">Clam AntiVirus</a>.
 111
 112         <li> Clang can build the majority of Objective-C examples shipped with the
 113 Mac OS X Developer Tools.
 114 </ul>
 115
 116 Clang code generation still needs considerable testing and development, however.
 117 Some areas under active development include:
 118 <ul>
 119         <li> Improved support for C and Objective-C features, for example
 120         variable-length arrays, va_arg, exception handling (Obj-C), and garbage
 121         collection (Obj-C).
 122         <li> ABI compatibility, especially for platforms other than 32-bit x86.
 123 </ul>
 124
 125 </div>
 126
 127 <!--=========================================================================-->
 128 <div class="doc_subsection">
 129 <a name="clangsa">Clang Static Analyzer</a>
 130 </div>
 131
 132 <div class="doc_text">
 133
 134 <p>The Clang project also includes an early stage static source code analysis
 135 tool for <a href="http://clang.llvm.org/StaticAnalysis.html">automatically
 136 finding bugs</a> in C and Objective-C programs. The tool performs a growing set
 137 of checks to find bugs that occur on a specific path within a program.  Examples
 138 of bugs the tool finds include logic errors such as null dereferences,
 139 violations of various API rules, dead code, and potential memory leaks in
 140 Objective-C programs. Since its inception, public feedback on the tool has been
 141 extremely positive, and conservative estimates put the number of real bugs it
 142 has found in industrial-quality software on the order of thousands.</p>
 143
 144 <p>The tool also provides a simple web GUI to inspect potential bugs found by
 145 the tool.  While still early in development, the GUI illustrates some of the key
 146 features of Clang: accurate source location information, which is used by the
 147 GUI to highlight specific code expressions that relate to a bug (including those
 148 that span multiple lines) and built-in knowledge of macros, which is used to
 149 perform inline expansion of macros within the GUI itself.</p>
 150
 151 <p>The set of checks performed by the static analyzer is gradually expanding,
 152 and
 153 future plans for the tool include full source-level inter-procedural analysis
 154 and deeper checks such as buffer overrun detection. There are many opportunities
 155 to extend and enhance the static analyzer, and anyone interested in working on
 156 this project is encouraged to get involved!</p>
 157
 158 </div>
 159
 160 <!--=========================================================================-->
 161 <div class="doc_subsection">
 162 <a name="vmkit">VMKit: JVM/CLI Virtual Machine Implementation</a>
 163 </div>
 164
 165 <div class="doc_text">
 166 <p>
 167 The <a href="http://vmkit.llvm.org/">VMKit project</a> is an implementation of
 168 a JVM and a CLI Virtual Machines (Microsoft .NET is an
 169 implementation of the CLI) using the Just-In-Time compiler of LLVM.</p>
 170
 171 <p>Following LLVM 2.4, VMKit has its first release 0.24 that you can find on
 172 the <a href="http://llvm.org/releases/">release page</a>. The release includes
 173 bug fixes, cleanup and new features. The major changes include:</p>
 174
 175 <ul>
 176
 177 <li> Support for generics in the .Net virtual machine. This was implemented
 178 by Tilmann Scheller during his Google Summer of Code project.
 179 <li> Initial support for the Mono class libraries.
 180 <li> Support for MacOSX/x86, following LLVM's support for exceptions in
 181 JIT on MacOSX/x86.
 182 <li> A new vmkit driver: a program to run java or .net applications. The
 183 driver supports llvm command line arguments including the new "-fast" option.
 184 <li> A new memory allocation scheme in the JVM that makes unloading a
 185 class loader very fast.
 186 <li> VMKit now follows the LLVM Makefile machinery.
 187
 188 </ul>
 189 </div>
 190
 191
 192 <!-- *********************************************************************** -->
 193 <div class="doc_section">
 194   <a name="whatsnew">What's New in LLVM?</a>
 195 </div>
 196 <!-- *********************************************************************** -->
 197
 198 <div class="doc_text">
 199
 200 <p>This release includes a huge number of bug fixes, performance tweaks and
 201 minor improvements.  Some of the major improvements and new features are listed
 202 in this section.
 203 </p>
 204 </div>
 205
 206 <!--=========================================================================-->
 207 <div class="doc_subsection">
 208 <a name="majorfeatures">Major New Features</a>
 209 </div>
 210
 211 <div class="doc_text">
 212
 213 <p>LLVM 2.4 includes several major new capabilities:</p>
 214
 215 <ul>
 216 <li><p>The most visible end-user change in LLVM 2.4 is that it includes many
 217 optimizations and changes to make -O0 compile times much faster.  You should see
 218 improvements on the order of 30% (or more) faster than LLVM 2.3.  There are many
 219 pieces to this change, described in more detail below.  The speedups and new
 220 components can also be used for JIT compilers that want fast compilation as
 221 well.</p></li>
 222
 223 <li><p>The biggest change to the LLVM IR is that Multiple Return Values (which
 224 were introduced in LLVM 2.3) have been generalized to full support for "First
 225 Class Aggregate" values in LLVM 2.4.  This means that LLVM IR supports using
 226 structs and arrays as values in a function.  This capability is mostly useful
 227 for front-end authors, who prefer to treat things like complex numbers, simple
 228 tuples, dope vectors, etc as Value*'s instead of as a tuple of Value*'s or as
 229 memory values.  Bitcode files from LLVM 2.3 will automatically migrate to the
 230 general representation.</p></li>
 231
 232 <li><p>LLVM 2.4 also includes an initial port for the PIC16 microprocessor. This
 233 is the LLVM target that only has support for 8 bit registers, and a number of
 234 other crazy constraints.  While the port is still in early development stages,
 235 it shows some interesting things you can do with LLVM.</p></li>
 236
 237 </ul>
 238
 239 </div>
 240
 241
 242 <!--=========================================================================-->
 243 <div class="doc_subsection">
 244 <a name="llvm-gcc">llvm-gcc 4.2 Improvements</a>
 245 </div>
 246
 247 <div class="doc_text">
 248
 249 <p>LLVM fully supports the llvm-gcc 4.2 front-end, which marries the GCC
 250 front-ends and driver with the LLVM optimizer and code generator.  It currently
 251 includes support for the C, C++, Objective-C, Ada, and Fortran front-ends.</p>
 252
 253 <ul>
 254 <li>LLVM 2.4 supports the full set of atomic <tt>__sync_*</tt> builtins.  LLVM
 255 2.3 only supported those used by OpenMP, but 2.4 supports them all.  While
 256 llvm-gcc supports all of these builtins, note that not all targets do.  X86
 257 support them all in both 32-bit and 64-bit mode and PowerPC supports them all
 258 except for the 64-bit operations when in 32-bit mode.</li>
 259
 260 <li>llvm-gcc now supports an <tt>-flimited-precision</tt> option, which tells
 261 the compiler that it is ok to use low-precision approximations of certain libm
 262 functions (like tan, log, etc).  This allows you to get high performance if you
 263 only need (say) 14-bits of precision.</li>
 264
 265 <li>llvm-gcc now supports a C language extension known as "<a
 266 href="http://lists.cs.uiuc.edu/pipermail/cfe-dev/2008-August/002670.html">Blocks
 267 </a>".  This feature is similar to nested functions and closures, but does not
 268 require stack trampolines (with most ABIs) and supports returning closures
 269 from functions that define them.  Note that actually <em>using</em> Blocks
 270 requires a small runtime that is not included with llvm-gcc.</li>
 271
 272 <li>llvm-gcc now supports a new <tt>-flto</tt> option.  On systems that support
 273 transparent Link Time Optimization (currently Darwin systems with Xcode 3.1 and
 274 later) this allows the use of LTO with other optimization levels like -Os.
 275 Previously, LTO could only be used with -O4, which implied optimizations in
 276 -O3 that can increase code size.</li>
 277 </ul>
 278
 279 </div>
 280
 281
 282 <!--=========================================================================-->
 283 <div class="doc_subsection">
 284 <a name="coreimprovements">LLVM Core Improvements</a>
 285 </div>
 286
 287 <div class="doc_text">
 288 <p>New features include:
 289 </p>
 290
 291 <ul>
 292 <li>A major change to the <tt>Use</tt> class landed, which shrank it by 25%.  Since
 293 this is a pervasive part of the LLVM, it ended up reducing the memory use of
 294 LLVM IR in general by 15% for most programs.</li>
 295
 296 <li>Values with no names are now pretty printed by <tt>llvm-dis</tt> more
 297 nicely.  They now print as "<tt>%3 = add i32 %A, 4</tt>" instead of
 298 "<tt>add i32 %A, 4   ; &lt;i32&gt;:3</tt>", which makes it much easier to read.
 299 </li>
 300
 301 <li>LLVM 2.4 includes some changes for better vector support.  First, the shift
 302 operations (<tt>shl</tt>, <tt>ashr</tt>, <tt>lshr</tt>) now all support vectors
 303 and do an element-by-element shift (shifts of the whole vector can be
 304 accomplished by bitcasting the vector to &lt;1 x i128&gt; for example).  Second,
 305 there is initial support in development for vector comparisons with the
 306 <a href="LangRef.html#i_fcmp">fcmp</a>/<a href="LangRef.html#i_icmp">icmp</a>
 307 instructions.  These instructions compare two vectors and return a vector of
 308 i1's for each result.  Note that there is very little codegen support available
 309 for any of these IR features though.</li>
 310
 311 <li>A new <tt>DebugInfoBuilder</tt> class is available, which makes it much
 312 easier for front-ends to create debug info descriptors, similar to the way that
 313 <tt>IRBuilder</tt> makes it easier to create LLVM IR.</li>
 314
 315 <li>The <tt>IRBuilder</tt> class is now parameterized by a class responsible
 316 for constant folding.  The default <tt>ConstantFolder</tt> class does target independent
 317 constant folding.  The <tt>NoFolder</tt> class does no constant folding at all, which is
 318 useful when learning how LLVM works.  The <tt>TargetFolder</tt> class folds the most,
 319 doing target dependent constant folding.</li>
 320
 321 <li>LLVM now supports "function attributes", which allows us to separate return
 322 value attributes from function attributes.  LLVM now supports attributes on a
 323 function itself, a return value, and its parameters.  New supported function
 324 attributes include noinline/alwaysinline and the "opt-size" flag which says the
 325 function should be optimized for code size.</li>
 326
 327 <li>LLVM IR now directly represents "common" linkage, instead of
 328     representing it as a form of weak linkage.</li>
 329
 330 </ul>
 331
 332 </div>
 333
 334 <!--=========================================================================-->
 335 <div class="doc_subsection">
 336 <a name="optimizer">Optimizer Improvements</a>
 337 </div>
 338
 339 <div class="doc_text">
 340
 341 <p>In addition to a huge array of bug fixes and minor performance tweaks, this
 342 release includes a few major enhancements and additions to the optimizers:</p>
 343
 344 <ul>
 345
 346 <li>The Global Value Numbering (GVN) pass now does local Partial Redundancy
 347 Elimination (PRE) to eliminate some partially redundant expressions in cases
 348 where doing so won't grow code size.</li>
 349
 350 <li>LLVM 2.4 includes a new loop deletion pass (which removes output-free
 351 provably-finite loops) and a rewritten Aggressive Dead Code Elimination (ADCE)
 352 pass that no longer uses control dependence information.  These changes speed up
 353 the optimizer and also prevent it from deleting output-free infinite
 354 loops.</li>
 355
 356 <li>The new AddReadAttrs pass works out which functions are read-only or
 357 read-none (these correspond to 'pure' and 'const' in GCC) and marks them
 358 with the appropriate attribute.</li>
 359
 360 <li>LLVM 2.4 now includes a new SparsePropagation framework, which makes it
 361 trivial to build lattice-based dataflow solvers that operate over LLVM IR. Using
 362 this interface means that you just define objects to represent your lattice
 363 values and the transfer functions that operate on them.  It handles the
 364 mechanics of worklist processing, liveness tracking, handling PHI nodes,
 365 etc.</li>
 366
 367 <li>The Loop Strength Reduction and induction variable optimization passes have
 368 several improvements to avoid inserting MAX expressions, to optimize simple
 369 floating point induction variables and to analyze trip counts of more
 370 loops.</li>
 371
 372 <li>Various helper functions (ComputeMaskedBits, ComputeNumSignBits, etc) were
 373 pulled out of the Instruction Combining pass and put into a new
 374 <tt>ValueTracking.h</tt> header, where they can be reused by other passes.</li>
 375
 376 <li>The tail duplication pass has been removed from the standard optimizer
 377 sequence used by llvm-gcc.  This pass still exists, but the benefits it once
 378 provided are now achieved by other passes.</li>
 379
 380 </ul>
 381
 382 </div>
 383
 384 <!--=========================================================================-->
 385 <div class="doc_subsection">
 386 <a name="codegen">Code Generator Improvements</a>
 387 </div>
 388
 389 <div class="doc_text">
 390
 391 <p>We have put a significant amount of work into the code generator infrastructure,
 392 which allows us to implement more aggressive algorithms and make it run
 393 faster:</p>
 394
 395 <ul>
 396 <li>The target-independent code generator supports (and the X86 backend
 397     currently implements) a new interface for "fast" instruction selection. This
 398     interface is optimized to produce code as quickly as possible, sacrificing
 399     code quality to do it.  This is used by default at -O0 or when using
 400     "llc -fast" on X86.  It is straight-forward to add support for
 401     other targets if faster -O0 compilation is desired.</li>
 402
 403 <li>In addition to the new 'fast' instruction selection path, many existing
 404     pieces of the code generator have been optimized in significant ways.
 405     SelectionDAG's are now pool allocated and use better algorithms in many
 406     places, the ".s" file printers now use <tt>raw_ostream</tt> to emit text much faster,
 407     etc.  The end result of these improvements is that the compiler also takes
 408     substantially less time to generate code that is just as good (and often
 409     better) than before.</li>
 410
 411 <li>Each target has been split to separate the ".s" file printing logic from the
 412     rest of the target.  This enables JIT compilers that don't link in the
 413     (somewhat large) code and data tables used for printing a ".s" file.</li>
 414
 415 <li>The code generator now includes a "stack slot coloring" pass, which packs
 416     together individual spilled values into common stack slots.  This reduces
 417     the size of stack frames with many spills, which tends to increase L1 cache
 418     effectiveness.</li>
 419
 420 <li>Various pieces of the register allocator (e.g. the coalescer and two-address
 421     operation elimination pass) now know how to rematerialize trivial operations
 422     to avoid copies and include several other optimizations.</li>
 423
 424 <li>The <a href="CodeGenerator.html#selectiondag_process">graphs</a> produced by
 425     the <tt>llc -view-*-dags</tt> options are now significantly prettier and
 426     easier to read.</li>
 427
 428 <li>LLVM 2.4 includes a new register allocator based on Partitioned Boolean
 429     Quadratic Programming (PBQP).  This register allocator is still in
 430     development, but is very simple and clean.</li>
 431
 432 </ul>
 433
 434 </div>
 435
 436
 437 <!--=========================================================================-->
 438 <div class="doc_subsection">
 439 <a name="targetspecific">Target Specific Improvements</a>
 440 </div>
 441
 442 <div class="doc_text">
 443 <p>New target-specific features include:
 444 </p>
 445
 446 <ul>
 447 <li>Exception handling is supported by default on Linux/x86-64.</li>
 448 <li>Position Independent Code (PIC) is now supported on Linux/x86-64.</li>
 449 <li>@llvm.frameaddress now supports getting the frame address of stack frames
 450     &gt; 0 on x86/x86-64.</li>
 451 <li>MIPS floating point support? [BRUNO]</li>
 452 <li>The PowerPC backend now supports trampolines.</li>
 453 </ul>
 454
 455 </div>
 456
 457
 458 <!--=========================================================================-->
 459 <div class="doc_subsection">
 460 <a name="otherimprovements">Other Improvements</a>
 461 </div>
 462
 463 <div class="doc_text">
 464 <p>New features include:
 465 </p>
 466
 467 <ul>
 468 <li><tt>llvmc2</tt> (the generic compiler driver) gained plugin
 469     support. It is now easier to experiment with <tt>llvmc2</tt> and
 470     build your own tools based on it.</li>
 471
 472 <li>LLVM 2.4 includes a number of new generic algorithms and data structures,
 473     include a scoped hash table, 'immutable' data structures, a simple
 474     free-list manager, and a <tt>raw_ostream</tt> class.
 475     The <tt>raw_ostream</tt> class and
 476     <tt>format</tt> allow for efficient file output, and various pieces of LLVM
 477     have switched over to use it.   The eventual goal is to eliminate
 478     std::ostream in favor of it.</li>
 479
 480 </ul>
 481
 482 </div>
 483
 484 <!--=========================================================================-->
 485 <div class="doc_subsection">
 486 <a name="changes">Major Changes and Removed Features</a>
 487 </div>
 488
 489 <div class="doc_text">
 490
 491 <p>If you're already an LLVM user or developer with out-of-tree changes based
 492 on LLVM 2.3, this section lists some "gotchas" that you may run into upgrading
 493 from the previous release.</p>
 494
 495 <ul>
 496
 497 <li>The LLVM IR generated by llvm-gcc no longer names all instructions.  This
 498     makes it run faster, but may be more confusing to some people.  If you
 499     prefer to have names, the '<tt>opt -instnamer</tt>' pass will add names to
 500     all instructions.</li>
 501
 502 <li>The LoadVN and GCSE passes have been removed from the tree.  They are
 503     obsolete and have been replaced with the GVN and MemoryDependence passes.
 504     </li>
 505 </ul>
 506
 507
 508 <p>In addition, many APIs have changed in this release.  Some of the major LLVM
 509 API changes are:</p>
 510
 511 <ul>
 512
 513 <li>Now, function attributes and return value attributes are managed
 514 separately. Interface exported by <tt>ParameterAttributes.h</tt> header is now
 515 experted by <tt>Attributes.h</tt> header. The new attributes interface changes are:
 516 <ul>
 517 <li><tt>getParamAttrs</tt> method is now replaced by
 518 <tt>getParamAttributes</tt>, <tt>getRetAttributes</tt> and
 519 <tt>getFnAttributes</tt> methods.</li>
 520 <li> Return value attributes are stored at index 0. Function attributes are
 521 stored at index ~0U. Parameter attributes are stored at index that matches
 522 parameter number.</li>
 523 <li> <tt>ParamAttr</tt> namespace is now renamed as <tt>Attribute</tt>.</li>
 524 <li> The name of the class that manages reference count of opaque
 525 attributes is changed from <tt>PAListPtr</tt> to <tt>AttrListPtr</tt>.</li>
 526 <li> <tt>ParamAttrsWithIndex</tt> is now renamed as <tt>AttributeWithIndex</tt>.
 527 </li>
 528 </ul>
 529 </li>
 530
 531 <li>The <tt>DbgStopPointInst</tt> methods <tt>getDirectory</tt> and
 532 <tt>getFileName</tt> now return <tt>Value*</tt> instead of strings. These can be
 533 converted to strings using <tt>llvm::GetConstantStringInfo</tt> defined via
 534 "<tt>llvm/Analysis/ValueTracking.h</tt>".</li>
 535
 536 <li>The APIs to create various instructions have changed from lower case
 537    "create" methods to upper case "Create" methods (e.g.
 538    <tt>BinaryOperator::create</tt>).  LLVM 2.4 includes both cases, but the
 539    lower case ones are removed in mainline, please migrate.</li>
 540
 541 <li>Various header files like "<tt>llvm/ADT/iterator</tt>" were given a ".h" suffix.
 542     Change your code to #include "<tt>llvm/ADT/iterator.h</tt>" instead.</li>
 543
 544 <li>In the code generator, many <tt>MachineOperand</tt> predicates were renamed to be
 545     shorter (e.g. <tt>isFrameIndex()</tt> -&gt; <tt>isFI()</tt>),
 546     <tt>SDOperand</tt> was renamed to <tt>SDValue</tt> (and the "<tt>Val</tt>"
 547     member was changed to be the <tt>getNode()</tt> accessor), and the
 548     <tt>MVT::ValueType</tt> enum has been replaced with an "<tt>MVT</tt>"
 549     struct. The <tt>getSignExtended</tt> and <tt>getValue</tt> methods in the
 550     ConstantSDNode class were renamed to <tt>getSExtValue</tt> and
 551     <tt>getZExtValue</tt> respectively, to be more consistent with
 552     the <tt>ConstantInt</tt> class.</li>
 553 </ul>
 554
 555 </div>
 556
 557
 558
 559 <!-- *********************************************************************** -->
 560 <div class="doc_section">
 561   <a name="portability">Portability and Supported Platforms</a>
 562 </div>
 563 <!-- *********************************************************************** -->
 564
 565 <div class="doc_text">
 566
 567 <p>LLVM is known to work on the following platforms:</p>
 568
 569 <ul>
 570 <li>Intel and AMD machines (IA32) running Red Hat Linux, Fedora Core and FreeBSD
 571       (and probably other unix-like systems).</li>
 572 <li>PowerPC and X86-based Mac OS X systems, running 10.3 and above in 32-bit and
 573     64-bit modes.</li>
 574 <li>Intel and AMD machines running on Win32 using MinGW libraries (native).</li>
 575 <li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
 576     support is available for native builds with Visual C++).</li>
 577 <li>Sun UltraSPARC workstations running Solaris 10.</li>
 578 <li>Alpha-based machines running Debian GNU/Linux.</li>
 579 <li>Itanium-based (IA64) machines running Linux and HP-UX.</li>
 580 </ul>
 581
 582 <p>The core LLVM infrastructure uses GNU autoconf to adapt itself
 583 to the machine and operating system on which it is built.  However, minor
 584 porting may be required to get LLVM to work on new platforms.  We welcome your
 585 portability patches and reports of successful builds or error messages.</p>
 586
 587 </div>
 588
 589 <!-- *********************************************************************** -->
 590 <div class="doc_section">
 591   <a name="knownproblems">Known Problems</a>
 592 </div>
 593 <!-- *********************************************************************** -->
 594
 595 <div class="doc_text">
 596
 597 <p>This section contains all known problems with the LLVM system, listed by
 598 component.  As new problems are discovered, they will be added to these
 599 sections.  If you run into a problem, please check the <a
 600 href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
 601 there isn't already one.</p>
 602
 603 </div>
 604
 605 <!-- ======================================================================= -->
 606 <div class="doc_subsection">
 607   <a name="experimental">Experimental features included with this release</a>
 608 </div>
 609
 610 <div class="doc_text">
 611
 612 <p>The following components of this LLVM release are either untested, known to
 613 be broken or unreliable, or are in early development.  These components should
 614 not be relied on, and bugs should not be filed against them, but they may be
 615 useful to some people.  In particular, if you would like to work on one of these
 616 components, please contact us on the <a
 617 href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p>
 618
 619 <ul>
 620 <li>The MSIL, IA64, Alpha, SPU, MIPS, and PIC16 backends are experimental.</li>
 621 <li>The llc "<tt>-filetype=asm</tt>" (the default) is the only supported
 622     value for this option.</li>
 623 </ul>
 624
 625 </div>
 626
 627 <!-- ======================================================================= -->
 628 <div class="doc_subsection">
 629   <a name="x86-be">Known problems with the X86 back-end</a>
 630 </div>
 631
 632 <div class="doc_text">
 633
 634 <ul>
 635   <li>The X86 backend does not yet support
 636     all <a href="http://llvm.org/PR879">inline assembly that uses the X86
 637     floating point stack</a>.  It supports the 'f' and 't' constraints, but not
 638     'u'.</li>
 639   <li>The X86 backend generates inefficient floating point code when configured
 640     to generate code for systems that don't have SSE2.</li>
 641   <li>Win64 code generation wasn't widely tested. Everything should work, but we
 642     expect small issues to happen. Also, llvm-gcc cannot build mingw64 runtime
 643     currently due
 644     to <a href="http://llvm.org/PR2255">several</a>
 645     <a href="http://llvm.org/PR2257">bugs</a> due to lack of support for the
 646     'u' inline assembly constraint and X87 floating point inline assembly.</li>
 647   <li>The X86-64 backend does not yet support the LLVM IR instruction
 648       <tt>va_arg</tt>. Currently, the llvm-gcc front-end supports variadic
 649       argument constructs on X86-64 by lowering them manually.</li>
 650 </ul>
 651
 652 </div>
 653
 654 <!-- ======================================================================= -->
 655 <div class="doc_subsection">
 656   <a name="ppc-be">Known problems with the PowerPC back-end</a>
 657 </div>
 658
 659 <div class="doc_text">
 660
 661 <ul>
 662 <li>The Linux PPC32/ABI support needs testing for the interpreter and static
 663 compilation, and lacks support for debug information.</li>
 664 </ul>
 665
 666 </div>
 667
 668 <!-- ======================================================================= -->
 669 <div class="doc_subsection">
 670   <a name="arm-be">Known problems with the ARM back-end</a>
 671 </div>
 672
 673 <div class="doc_text">
 674
 675 <ul>
 676 <li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
 677 processors, thumb programs can crash or produce wrong
 678 results (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
 679 <li>Compilation for ARM Linux OABI (old ABI) is supported, but not fully tested.
 680 </li>
 681 <li>There is a bug in QEMU-ARM (&lt;= 0.9.0) which causes it to incorrectly
 682  execute
 683 programs compiled with LLVM.  Please use more recent versions of QEMU.</li>
 684 </ul>
 685
 686 </div>
 687
 688 <!-- ======================================================================= -->
 689 <div class="doc_subsection">
 690   <a name="sparc-be">Known problems with the SPARC back-end</a>
 691 </div>
 692
 693 <div class="doc_text">
 694
 695 <ul>
 696 <li>The SPARC backend only supports the 32-bit SPARC ABI (-m32), it does not
 697     support the 64-bit SPARC ABI (-m64).</li>
 698 </ul>
 699
 700 </div>
 701
 702 <!-- ======================================================================= -->
 703 <div class="doc_subsection">
 704   <a name="alpha-be">Known problems with the Alpha back-end</a>
 705 </div>
 706
 707 <div class="doc_text">
 708
 709 <ul>
 710
 711 <li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
 712 appropriate nops inserted to ensure restartability.</li>
 713
 714 </ul>
 715 </div>
 716
 717 <!-- ======================================================================= -->
 718 <div class="doc_subsection">
 719   <a name="ia64-be">Known problems with the IA64 back-end</a>
 720 </div>
 721
 722 <div class="doc_text">
 723
 724 <ul>
 725 <li>The Itanium backend is highly experimental, and has a number of known
 726     issues.  We are looking for a maintainer for the Itanium backend.  If you
 727     are interested, please contact the LLVMdev mailing list.</li>
 728 </ul>
 729
 730 </div>
 731
 732 <!-- ======================================================================= -->
 733 <div class="doc_subsection">
 734   <a name="c-be">Known problems with the C back-end</a>
 735 </div>
 736
 737 <div class="doc_text">
 738
 739 <ul>
 740 <li><a href="http://llvm.org/PR802">The C backend has only basic support for
 741     inline assembly code</a>.</li>
 742 <li><a href="http://llvm.org/PR1658">The C backend violates the ABI of common
 743     C++ programs</a>, preventing intermixing between C++ compiled by the CBE and
 744     C++ code compiled with llc or native compilers.</li>
 745 <li>The C backend does not support all exception handling constructs.</li>
 746 </ul>
 747
 748 </div>
 749
 750
 751 <!-- ======================================================================= -->
 752 <div class="doc_subsection">
 753   <a name="c-fe">Known problems with the llvm-gcc C front-end</a>
 754 </div>
 755
 756 <div class="doc_text">
 757
 758 <p>llvm-gcc does not currently support <a href="http://llvm.org/PR869">Link-Time
 759 Optimization</a> on most platforms "out-of-the-box".  Please inquire on the
 760 LLVMdev mailing list if you are interested.</p>
 761
 762 <p>The only major language feature of GCC not supported by llvm-gcc is
 763     the <tt>__builtin_apply</tt> family of builtins.   However, some extensions
 764     are only supported on some targets.  For example, trampolines are only
 765     supported on some targets (these are used when you take the address of a
 766     nested function).</p>
 767
 768 <p>If you run into GCC extensions which are not supported, please let us know.
 769 </p>
 770
 771 </div>
 772
 773 <!-- ======================================================================= -->
 774 <div class="doc_subsection">
 775   <a name="c++-fe">Known problems with the llvm-gcc C++ front-end</a>
 776 </div>
 777
 778 <div class="doc_text">
 779
 780 <p>The C++ front-end is considered to be fully
 781 tested and works for a number of non-trivial programs, including LLVM
 782 itself, Qt, Mozilla, etc.</p>
 783
 784 <ul>
 785 <li>Exception handling works well on the X86 and PowerPC targets. Currently
 786   only linux and darwin targets are supported (both 32 and 64 bit).</li>
 787 </ul>
 788
 789 </div>
 790
 791
 792 <!-- ======================================================================= -->
 793 <div class="doc_subsection">
 794   <a name="ada-fe">Known problems with the llvm-gcc Ada front-end</a>
 795 </div>
 796
 797 <div class="doc_text">
 798 The llvm-gcc 4.2 Ada compiler works fairly well, however this is not a mature
 799 technology and problems should be expected.
 800 <ul>
 801 <li>The Ada front-end currently only builds on X86-32.  This is mainly due
 802 to lack of trampoline support (pointers to nested functions) on other platforms,
 803 however it <a href="http://llvm.org/PR2006">also fails to build on X86-64</a>
 804 which does support trampolines.</li>
 805 <li>The Ada front-end <a href="http://llvm.org/PR2007">fails to bootstrap</a>.
 806 Workaround: configure with --disable-bootstrap.</li>
 807 <li>The c380004, <a href="http://llvm.org/PR2010">c393010</a>
 808 and <a href="http://llvm.org/PR2421">cxg2021</a> ACATS tests fail
 809 (c380004 also fails with gcc-4.2 mainline).</li>
 810 <li>Some gcc specific Ada tests continue to crash the compiler.</li>
 811 <li>The -E binder option (exception backtraces)
 812 <a href="http://llvm.org/PR1982">does not work</a> and will result in programs
 813 crashing if an exception is raised.  Workaround: do not use -E.</li>
 814 <li>Only discrete types <a href="http://llvm.org/PR1981">are allowed to start
 815 or finish at a non-byte offset</a> in a record.  Workaround: do not pack records
 816 or use representation clauses that result in a field of a non-discrete type
 817 starting or finishing in the middle of a byte.</li>
 818 <li>The <tt>lli</tt> interpreter <a href="http://llvm.org/PR2009">considers
 819 'main' as generated by the Ada binder to be invalid</a>.
 820 Workaround: hand edit the file to use pointers for <tt>argv</tt> and
 821 <tt>envp</tt> rather than integers.</li>
 822 <li>The <tt>-fstack-check</tt> option <a href="http://llvm.org/PR2008">is
 823 ignored</a>.</li>
 824 </ul>
 825 </div>
 826
 827 <!-- *********************************************************************** -->
 828 <div class="doc_section">
 829   <a name="additionalinfo">Additional Information</a>
 830 </div>
 831 <!-- *********************************************************************** -->
 832
 833 <div class="doc_text">
 834
 835 <p>A wide variety of additional information is available on the <a
 836 href="http://llvm.org">LLVM web page</a>, in particular in the <a
 837 href="http://llvm.org/docs/">documentation</a> section.  The web page also
 838 contains versions of the API documentation which is up-to-date with the
 839 Subversion version of the source code.
 840 You can access versions of these documents specific to this release by going
 841 into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
 842
 843 <p>If you have any questions or comments about LLVM, please feel free to contact
 844 us via the <a href="http://llvm.org/docs/#maillist"> mailing
 845 lists</a>.</p>
 846
 847 </div>
 848
 849 <!-- *********************************************************************** -->
 850
 851 <hr>
 852 <address>
 853   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
 854   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
 855   <a href="http://validator.w3.org/check/referer"><img
 856   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
 857
 858   <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
 859   Last modified: $Date$
 860 </address>
 861
 862 </body>
 863 </html>