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.0 Release Notes</title>
   8 </head>
   9 <body>
  10
  11 <div class="doc_title">LLVM 2.0 Release Notes</div>
  12
  13 <ol>
  14   <li><a href="#intro">Introduction</a></li>
  15   <li><a href="#whatsnew">What's New?</a></li>
  16   <li><a href="GettingStarted.html">Installation Instructions</a></li>
  17   <li><a href="#portability">Portability and Supported Platforms</a></li>
  18   <li><a href="#knownproblems">Known Problems</a>
  19   <li><a href="#additionalinfo">Additional Information</a></li>
  20 </ol>
  21
  22 <div class="doc_author">
  23   <p>Written by the <a href="http://llvm.org">LLVM Team</a><p>
  24 </div>
  25
  26 <!-- *********************************************************************** -->
  27 <div class="doc_section">
  28   <a name="intro">Introduction</a>
  29 </div>
  30 <!-- *********************************************************************** -->
  31
  32 <div class="doc_text">
  33
  34 <p>This document contains the release notes for the LLVM compiler
  35 infrastructure, release 2.0.  Here we describe the status of LLVM, including any
  36 known problems and major improvements from the previous release.  All LLVM
  37 releases may be downloaded from the <a href="http://llvm.org/releases/">LLVM
  38 releases web site</a>.
  39
  40 <p>For more information about LLVM, including information about the latest
  41 release, please check out the <a href="http://llvm.org/">main LLVM
  42 web site</a>.  If you have questions or comments, the <a
  43 href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM developer's mailing
  44 list</a> is a good place to send them.</p>
  45
  46 <p>Note that if you are reading this file from CVS or the main LLVM web page,
  47 this document applies to the <i>next</i> release, not the current one.  To see
  48 the release notes for the current or previous releases, see the <a
  49 href="http://llvm.org/releases/">releases page</a>.</p>
  50
  51 </div>
  52
  53 <!-- *********************************************************************** -->
  54 <div class="doc_section">
  55   <a name="whatsnew">What's New?</a>
  56 </div>
  57 <!-- *********************************************************************** -->
  58
  59 <div class="doc_text">
  60
  61 <p>This is the eleventh public release of the LLVM Compiler Infrastructure.
  62 Being the first major release since 1.0, this release is different in several
  63 ways from our previous releases:</p>
  64
  65 <ol>
  66 <li>We took this as an opportunity to
  67 break backwards compatibility with the LLVM 1.x bytecode and .ll file format.
  68 If you have LLVM 1.9 .ll files that you would like to upgrade to LLVM 2.x, we
  69 recommend the use of the stand alone <a href="#llvm-upgrade">llvm-upgrade</a>
  70 tool (which is included with 2.0).  We intend to keep compatibility with .ll
  71 and .bc formats within the 2.x release series, like we did within the 1.x
  72 series.</li>
  73 <li>There are several significant change to the LLVM IR and internal APIs, such
  74     as a major overhaul of the type system, the completely new bitcode file
  75     format, etc (described below).</li>
  76 <li>We designed the release around a 6 month release cycle instead of the usual
  77     3-month cycle.  This gave us extra time to develop and test some of the
  78     more invasive features in this release.</li>
  79 <li>LLVM 2.0 no longer supports the llvm-gcc3 front-end.  Users are required to
  80     upgrade to llvm-gcc4.  llvm-gcc4 includes many features over
  81     llvm-gcc3, is faster, and is <a href="CFEBuildInstrs.html">much easier to
  82     build from source</a>.</li>
  83 </ol>
  84
  85 <p>Note that while this is a major version bump, this release has been
  86    extensively tested on a wide range of software.  It is easy to say that this
  87    is our best release yet, in terms of both features and correctness.  This is
  88    the first LLVM release to correctly compile and optimize major software like
  89    LLVM itself, Mozilla/Seamonkey, Qt 4.3rc1, kOffice, etc out of the box on
  90    linux/x86.
  91    </p>
  92
  93 </div>
  94
  95 <!--=========================================================================-->
  96 <div class="doc_subsection">
  97 <a name="newfeatures">New Features in LLVM 2.0</a>
  98 </div>
  99
 100 <!--_________________________________________________________________________-->
 101 <div class="doc_subsubsection"><a name="majorchanges">Major Changes</a></div>
 102 <div class="doc_text">
 103
 104 <p>Changes to the LLVM IR itself:</p>
 105
 106 <ul>
 107
 108 <li>Integer types are now completely signless. This means that we
 109     have types like i8/i16/i32 instead of ubyte/sbyte/short/ushort/int
 110     etc. LLVM operations that depend on sign have been split up into
 111     separate instructions (<a href="http://llvm.org/PR950">PR950</a>).  This
 112     eliminates cast instructions that just change the sign of the operands (e.g.
 113     int -> uint), which reduces the size of the IR and makes optimizers
 114     simpler to write.</li>
 115
 116 <li>Integer types with arbitrary bitwidths (e.g. i13, i36, i42, i1057, etc) are
 117     now supported in the LLVM IR and optimizations (<a
 118     href="http://llvm.org/PR1043">PR1043</a>).  However, neither llvm-gcc
 119     (<a href="http://llvm.org/PR1284">PR1284</a>) nor the native code generators
 120     (<a href="http://llvm.org/PR1270">PR1270</a>) support non-standard width
 121     integers yet.</li>
 122
 123 <li>'Type planes' have been removed (<a href="http://llvm.org/PR411">PR411</a>).
 124     It is no longer possible to have two values with the same name in the
 125     same symbol table.  This simplifies LLVM internals, allowing significant
 126     speedups.</li>
 127
 128 <li>Global variables and functions in .ll files are now prefixed with
 129     @ instead of % (<a href="http://llvm.org/PR645">PR645</a>).</li>
 130
 131 <li>The LLVM 1.x "bytecode" format has been replaced with a
 132     completely new binary representation, named 'bitcode'. The <a
 133     href="BitCodeFormat.html">Bitcode Format</a> brings a
 134     number of advantages to the LLVM over the old bytecode format: it is denser
 135     (files are smaller), more extensible, requires less memory to read,
 136     is easier to keep backwards compatible (so LLVM 2.5 will read 2.0 .bc
 137     files), and has many other nice features.</li>
 138
 139 <li>Load and store instructions now track the alignment of their pointer
 140     (<a href="http://www.llvm.org/PR400">PR400</a>).  This allows the IR to
 141     express loads that are not sufficiently aligned (e.g. due to '<tt>#pragma
 142     packed</tt>') or to capture extra alignment information.</li>
 143 </ul>
 144
 145 <p>Major new features:</p>
 146
 147 <ul>
 148
 149 <li>A number of ELF features are now supported by LLVM, including 'visibility',
 150     extern weak linkage, Thread Local Storage (TLS) with the <tt>__thread</tt>
 151     keyword, and symbol aliases.
 152     Among other things, this means that many of the special options needed to
 153     configure llvm-gcc on linux are no longer needed, and special hacks to build
 154     large C++ libraries like Qt are not needed.</li>
 155
 156 <li>LLVM now has a new MSIL backend. llc -march=msil will now turn LLVM
 157     into MSIL (".net") bytecode.  This is still fairly early development
 158     with a number of limitations.</li>
 159
 160 </ul>
 161
 162 </div>
 163
 164
 165 <!--_________________________________________________________________________-->
 166 <div class="doc_subsubsection"><a name="llvmgccfeatures">llvm-gcc
 167 Improvements</a></div>
 168 <div class="doc_text">
 169 <p>New features include:
 170 </p>
 171
 172 <ul>
 173 <li>Precompiled Headers (PCH) are now supported.</li>
 174
 175 <li>"<tt>#pragma packed</tt>" is now supported, as are the various features
 176     described above (visibility, extern weak linkage, __thread, aliases,
 177     etc).</li>
 178
 179 <li>Tracking function parameter/result attributes is now possible.</li>
 180
 181 <li>Many internal enhancements have been added, such as improvements to
 182     NON_LVALUE_EXPR, arrays with non-zero base, structs with variable sized
 183     fields, VIEW_CONVERT_EXPR, CEIL_DIV_EXPR, nested functions, and many other
 184     things.  This is primarily to supports non-C GCC front-ends, like Ada.</li>
 185
 186 <li>It is simpler to configure llvm-gcc for linux.</li>
 187
 188 </ul>
 189
 190 </div>
 191
 192 <!--_________________________________________________________________________-->
 193 <div class="doc_subsubsection"><a name="optimizer">Optimizer
 194 Improvements</a></div>
 195
 196 <div class="doc_text">
 197 <p>New features include:
 198 </p>
 199
 200 <ul>
 201 <li>The <a href="WritingAnLLVMPass.html">pass manager</a> has been entirely
 202     rewritten, making it significantly smaller, simpler, and more extensible.
 203     Support has been added to run FunctionPasses interlaced with
 204     CallGraphSCCPasses, and we now support loop transformations explicitly with
 205     LoopPass.</li>
 206
 207 <li>The <tt>-scalarrepl</tt> pass can now promote unions containing FP values
 208     into a register, it can also handle unions of vectors of the same
 209     size.</li>
 210
 211 <li>LLVM 2.0 includes a new loop rotation pass, which converts "for loops" into
 212     "do/while loops", where the condition is at the bottom of the loop.</li>
 213
 214 <li>The Loop Strength Reduction pass has been improved, and support added
 215     for sinking expressions across blocks to reduce register pressure.</li>
 216
 217 <li>ModulePasses may now use the result of FunctionPasses.</li>
 218
 219 <li>The [Post]DominatorSet classes have been removed from LLVM and clients
 220     switched to use the far-more-efficient ETForest class instead.</li>
 221
 222 <li>The ImmediateDominator class has also been removed, and clients have been
 223     switched to use DominatorTree instead.</li>
 224
 225 <li>The predicate simplifier pass has been improved, making it able to do
 226     simple value range propagation and eliminate more conditionals.</li>
 227
 228 </ul>
 229
 230 </div>
 231
 232 <!--_________________________________________________________________________-->
 233 <div class="doc_subsubsection"><a name="codegen">Code
 234 Generator Enhancements</a></div>
 235
 236 <div class="doc_text">
 237 <p>
 238 New features include:
 239 </p>
 240
 241 <ul>
 242
 243 <li>Support was added for software floating point, which allows LLVM to target
 244     chips that don't have hardware FPUs (e.g. ARM thumb mode).</li>
 245
 246 <li>A new register scavenger has been implemented, which is useful for
 247     finding free registers after register allocation.  This is useful when
 248     rewriting frame references on RISC targets, for example.</li>
 249
 250 <li>Heuristics have been added to avoid coalescing vregs with very large live
 251     ranges to physregs.  This was bad because it effectively pinned the physical
 252     register for the entire lifetime of the virtual register (<a
 253     href="http://llvm.org/PR711">PR711</a>).</li>
 254
 255 <li>Support now exists for very simple (but still very useful)
 256     rematerialization the register allocator, enough to move
 257     instructions like "load immediate" and constant pool loads.</li>
 258
 259 <li>Switch statement lowering is significantly better, improving codegen for
 260     sparse switches that have dense subregions, and implemented support
 261     for the shift/and trick.</li>
 262
 263 <li>Added support for tracking physreg sub-registers and super-registers
 264     in the code generator, as well as extensive register
 265     allocator changes to track them.</li>
 266
 267 <li>There is initial support for virtreg sub-registers
 268     (<a href="http://llvm.org/PR1350">PR1350</a>).</li>
 269
 270 </ul>
 271
 272 <p>
 273 Other improvements include:
 274 </p>
 275
 276 <ul>
 277
 278 <li>Inline assembly support is much more solid that before.
 279     The two primary features still missing are support for 80-bit floating point
 280     stack registers on X86 (<a href="http://llvm.org/PR879">PR879</a>), and
 281     support for inline asm in the C backend (<a
 282     href="http://llvm.org/PR802">PR802</a>).</li>
 283
 284 <li>DWARF debug information generation has been improved.  LLVM now passes
 285     most of the GDB testsuite on MacOS and debug info is more dense.</li>
 286
 287 <li>Codegen support for Zero-cost DWARF exception handling has been added (<a
 288     href="http://llvm.org/PR592">PR592</a>).  It is mostly
 289     complete and just in need of continued bug fixes and optimizations at
 290     this point.  However, support in llvm-g++ is disabled with an
 291     #ifdef for the 2.0 release  (<a
 292     href="http://llvm.org/PR870">PR870</a>).</li>
 293
 294 <li>The code generator now has more accurate and general hooks for
 295     describing addressing modes ("isLegalAddressingMode") to
 296     optimizations like loop strength reduction and code sinking.</li>
 297
 298 <li>Progress has been made on a direct Mach-o .o file writer. Many small
 299     apps work, but it is still not quite complete.</li>
 300
 301 </ul>
 302
 303 <p>In addition, the LLVM target description format has itself been extended in
 304  several ways:</p>
 305
 306 <ul>
 307 <li>Extended TargetData to support better target parameterization in
 308     the .ll/.bc files, eliminating the 'pointersize/endianness' attributes
 309     in the files (<a href="http://llvm.org/PR761">PR761</a>).</li>
 310
 311 <li>TargetData was generalized for finer grained alignment handling,
 312     handling of vector alignment, and handling of preferred alignment</li>
 313
 314 <li>LLVM now supports describing target calling conventions
 315     explicitly in .td files, reducing the amount of C++ code that needs
 316     to be written for a port.</li>
 317
 318 </ul>
 319
 320 </div>
 321
 322 <!--_________________________________________________________________________-->
 323 <div class="doc_subsubsection"><a name="specifictargets">Target-Specific
 324 Improvements</a></div>
 325
 326 <div class="doc_text">
 327
 328 <p>X86-specific Code Generator Enhancements:
 329 </p>
 330
 331 <ul>
 332 <li>The MMX instruction set is now supported through intrinsics.</li>
 333 <li>The scheduler was improved to better reduce register pressure on
 334     X86 and other targets that are register pressure sensitive.</li>
 335 <li>Linux/x86-64 support is much better.</li>
 336 <li>PIC support for linux/x86 has been added.</li>
 337 <li>The X86 backend now supports the GCC regparm attribute.</li>
 338 <li>LLVM now supports inline asm with multiple constraint letters per operand
 339     (like "ri") which is common in X86 inline asms.</li>
 340 </ul>
 341
 342 <p>ARM-specific Code Generator Enhancements:</p>
 343
 344 <ul>
 345 <li>The ARM code generator is now stable and fully supported.</li>
 346
 347 <li>There are major new features, including support for ARM
 348     v4-v6 chips, vfp support, soft float point support, pre/postinc support,
 349     load/store multiple generation, constant pool entry motion (to support
 350     large functions), and inline asm support, weak linkage support, static
 351     ctor/dtor support and many bug fixes.</li>
 352 <li>Added support for Thumb code generation (<tt>llc -march=thumb</tt>).</li>
 353
 354 <li>The ARM backend now supports the ARM AAPCS/EABI ABI and PIC codegen on
 355     arm/linux.</li>
 356
 357 <li>Several bugs were fixed for DWARF debug info generation on arm/linux.</li>
 358 </ul>
 359
 360 <p>PowerPC-specific Code Generator Enhancements:</p>
 361
 362 <ul>
 363 <li>The PowerPC 64 JIT now supports addressing code loaded above the 2G
 364      boundary.</li>
 365
 366 <li>Improved support for the Linux/ppc ABI and the linux/ppc JIT is fully
 367     functional now.  llvm-gcc and static compilation are not fully supported
 368     yet though.</li>
 369
 370 <li>Many PowerPC 64 bug fixes.</li>
 371
 372 </ul>
 373
 374 </div>
 375
 376
 377 <!--_________________________________________________________________________-->
 378 <div class="doc_subsubsection"><a name="other">Other Improvements</a></div>
 379 <div class="doc_text">
 380
 381 <p>This release includes many other improvements, including
 382 performance work, specifically designed to tune datastructure
 383 usage. This makes several critical components faster.</p>
 384
 385 <p>More specific changes include:</p>
 386
 387 <ul>
 388 <li>LLVM no longer relies on static destructors to shut itself down.  Instead,
 389     it lazily initializes itself and shuts down when llvm_shutdown() is
 390     explicitly called.</li>
 391
 392 <li>LLVM now has significantly fewer static constructors, reducing startup time.
 393     </li>
 394
 395 <li>Several classes have been refactored to reduce the amount of code that
 396     gets linked into apps that use the JIT.</li>
 397
 398 <li>Construction of intrinsic function declarations has been simplified.</li>
 399
 400 <li>The llvm-upgrade tool now exists. This migrates LLVM 1.9 .ll files to
 401     LLVM 2.0 syntax.</li>
 402
 403 <li>The gccas/gccld tools have been removed.</li>
 404
 405 <li>Support has been added to llvm-test for running on low-memory
 406     or slow machines (make SMALL_PROBLEM_SIZE=1).</li>
 407
 408 <li>llvm-test is now more portable and should build with MS Visual Studio.</li>
 409
 410 </ul>
 411 </div>
 412
 413 <!--_________________________________________________________________________-->
 414 <div class="doc_subsubsection"><a name="apichanges">API Changes</a></div>
 415 <div class="doc_text">
 416
 417 <p>LLVM 2.0 contains a revamp of the type system and several other significant
 418 internal changes.  If you are programming to the C++ API, be aware of the
 419 following major changes:</p>
 420
 421 <ul>
 422 <li>Pass registration is slightly different in LLVM 2.0 (you now need an
 423    intptr_t in your constructor), as explained in the <a
 424    href="WritingAnLLVMPass.html#basiccode">Writing an LLVM Pass</a>
 425    document.</li>
 426
 427 <li><tt>ConstantBool</tt>, <tt>ConstantIntegral</tt> and <tt>ConstantInt</tt>
 428     classes have been merged together, we now just have
 429     <tt>ConstantInt</tt>.</li>
 430
 431 <li><tt>Type::IntTy</tt>, <tt>Type::UIntTy</tt>, <tt>Type::SByteTy</tt>, ... are
 432     replaced by <tt>Type::Int8Ty</tt>, <tt>Type::Int16Ty</tt>, etc.  LLVM types
 433     have always corresponded to fixed size types
 434     (e.g. long was always 64-bits), but the type system no longer includes
 435     information about the sign of the type.</li>
 436
 437 <li>Several classes (<tt>CallInst</tt>, <tt>GetElementPtrInst</tt>,
 438     <tt>ConstantArray</tt>, etc), that once took <tt>std::vector</tt> as
 439      arguments now take ranges instead.   For example, you can create a
 440     <tt>GetElementPtrInst</tt> with code like:
 441
 442     <pre>
 443       Value *Ops[] = { Op1, Op2, Op3 };
 444       GEP = new GetElementPtrInst(BasePtr, Ops, 3);
 445     </pre>
 446
 447     This avoids creation of a temporary vector (and a call to malloc/free).  If
 448     you have an std::vector, use code like this:
 449     <pre>
 450       std::vector&lt;Value*&gt; Ops = ...;
 451       GEP = new GetElementPtrInst(BasePtr, &amp;Ops[0], Ops.size());
 452     </pre>
 453
 454     </li>
 455
 456 <li>CastInst is now abstract and its functionality is split into several parts,
 457     one for each of the <a href="LangRef.html#convertops">new cast
 458     instructions</a>.</li>
 459
 460 <li><tt>Instruction::getNext()/getPrev()</tt> are now private (along with
 461     <tt>BasicBlock::getNext</tt>, etc), for efficiency reasons (they are now no
 462     longer just simple pointers).  Please use BasicBlock::iterator, etc instead.
 463 </li>
 464
 465 <li><tt>Module::getNamedFunction()</tt> is now called
 466     <tt>Module::getFunction()</tt>.</li>
 467
 468 <li><tt>SymbolTable.h</tt> has been split into <tt>ValueSymbolTable.h</tt> and
 469 <tt>TypeSymbolTable.h</tt>.</li>
 470 </ul>
 471 </div>
 472
 473
 474 <!-- *********************************************************************** -->
 475 <div class="doc_section">
 476   <a name="portability">Portability and Supported Platforms</a>
 477 </div>
 478 <!-- *********************************************************************** -->
 479
 480 <div class="doc_text">
 481
 482 <p>LLVM is known to work on the following platforms:</p>
 483
 484 <ul>
 485   <li>Intel and AMD machines running Red Hat Linux, Fedora Core and FreeBSD
 486       (and probably other unix-like systems).</li>
 487 <li>Intel and AMD machines running on Win32 using MinGW libraries (native)</li>
 488 <li>Sun UltraSPARC workstations running Solaris 8.</li>
 489 <li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
 490     support is available for native builds with Visual C++).</li>
 491 <li>PowerPC and X86-based Mac OS X systems, running 10.2 and above in 32-bit and
 492     64-bit modes.</li>
 493 <li>Alpha-based machines running Debian GNU/Linux.</li>
 494 <li>Itanium-based machines running Linux and HP-UX.</li>
 495 </ul>
 496
 497 <p>The core LLVM infrastructure uses
 498 <a href="http://www.gnu.org/software/autoconf/">GNU autoconf</a> to adapt itself
 499 to the machine and operating system on which it is built.  However, minor
 500 porting may be required to get LLVM to work on new platforms.  We welcome your
 501 portability patches and reports of successful builds or error messages.</p>
 502
 503 </div>
 504
 505 <!-- *********************************************************************** -->
 506 <div class="doc_section">
 507   <a name="knownproblems">Known Problems</a>
 508 </div>
 509 <!-- *********************************************************************** -->
 510
 511 <div class="doc_text">
 512
 513 <p>This section contains all known problems with the LLVM system, listed by
 514 component.  As new problems are discovered, they will be added to these
 515 sections.  If you run into a problem, please check the <a
 516 href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
 517 there isn't already one.</p>
 518
 519 </div>
 520
 521 <!-- ======================================================================= -->
 522 <div class="doc_subsection">
 523   <a name="experimental">Experimental features included with this release</a>
 524 </div>
 525
 526 <div class="doc_text">
 527
 528 <p>The following components of this LLVM release are either untested, known to
 529 be broken or unreliable, or are in early development.  These components should
 530 not be relied on, and bugs should not be filed against them, but they may be
 531 useful to some people.  In particular, if you would like to work on one of these
 532 components, please contact us on the <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p>
 533
 534 <ul>
 535 <li>The <tt>-cee</tt> pass is known to be buggy, and may be removed in in a
 536     future release.</li>
 537 <li>C++ EH support</li>
 538 <li>The IA64 code generator is experimental.</li>
 539 <li>The Alpha JIT is experimental.</li>
 540 <li>"<tt>-filetype=asm</tt>" (the default) is the only supported value for the
 541     <tt>-filetype</tt> llc option.</li>
 542 </ul>
 543
 544 </div>
 545
 546 <!-- ======================================================================= -->
 547 <div class="doc_subsection">
 548   <a name="x86-be">Known problems with the X86 back-end</a>
 549 </div>
 550
 551 <div class="doc_text">
 552
 553 <ul>
 554 <li>The X86 backend does not yet support <a href="http://llvm.org/PR879">inline
 555     assembly that uses the X86 floating point stack</a>.</li>
 556 </ul>
 557
 558 </div>
 559
 560 <!-- ======================================================================= -->
 561 <div class="doc_subsection">
 562   <a name="ppc-be">Known problems with the PowerPC back-end</a>
 563 </div>
 564
 565 <div class="doc_text">
 566
 567 <ul>
 568 <li><a href="http://llvm.org/PR642">PowerPC backend does not correctly
 569 implement ordered FP comparisons</a>.</li>
 570 <li>The Linux PPC32/ABI support needs testing for the interpreter and static
 571 compilation, and lacks Dwarf debugging informations.
 572 </ul>
 573
 574 </div>
 575
 576 <!-- ======================================================================= -->
 577 <div class="doc_subsection">
 578   <a name="arm-be">Known problems with the ARM back-end</a>
 579 </div>
 580
 581 <div class="doc_text">
 582
 583 <ul>
 584 <li>The Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
 585 processors, any thumb program compiled with LLVM crashes or produces wrong
 586 results. (<a href="http://llvm.org/PR1388">PR1388</a>)</li>
 587 <li>Compilation for ARM Linux OABI (old ABI) is supported, but not fully tested.
 588 </li>
 589 <li>QEMU-ARM (<= 0.9.0) wrongly executes programs compiled with LLVM. A non-affected QEMU version must be used or this
 590 <a href="http://cvs.savannah.nongnu.org/viewcvs/qemu/target-arm/translate.c?root=qemu&amp;r1=1.46&amp;r2=1.47&amp;makepatch=1&amp;diff_format=h">
 591 patch</a> must be applied on QEMU.</li>
 592 </ul>
 593
 594 </div>
 595
 596 <!-- ======================================================================= -->
 597 <div class="doc_subsection">
 598   <a name="sparc-be">Known problems with the SPARC back-end</a>
 599 </div>
 600
 601 <div class="doc_text">
 602
 603 <ul>
 604 <li>The SPARC backend only supports the 32-bit SPARC ABI (-m32), it does not
 605     support the 64-bit SPARC ABI (-m64).</li>
 606 </ul>
 607
 608 </div>
 609
 610 <!-- ======================================================================= -->
 611 <div class="doc_subsection">
 612   <a name="alpha-be">Known problems with the Alpha back-end</a>
 613 </div>
 614
 615 <div class="doc_text">
 616
 617 <ul>
 618
 619 <li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
 620 appropriate nops inserted to ensure restartability.</li>
 621
 622 </ul>
 623 </div>
 624
 625 <!-- ======================================================================= -->
 626 <div class="doc_subsection">
 627   <a name="ia64-be">Known problems with the IA64 back-end</a>
 628 </div>
 629
 630 <div class="doc_text">
 631
 632 <ul>
 633
 634 <li>C++ programs are likely to fail on IA64, as calls to <tt>setjmp</tt> are
 635 made where the argument is not 16-byte aligned, as required on IA64. (Strictly
 636 speaking this is not a bug in the IA64 back-end; it will also be encountered
 637 when building C++ programs using the C back-end.)</li>
 638
 639 <li>The C++ front-end does not use <a href="http://llvm.org/PR406">IA64
 640 ABI compliant layout of v-tables</a>.  In particular, it just stores function
 641 pointers instead of function descriptors in the vtable.  This bug prevents
 642 mixing C++ code compiled with LLVM with C++ objects compiled by other C++
 643 compilers.</li>
 644
 645 <li>There are a few ABI violations which will lead to problems when mixing LLVM
 646 output with code built with other compilers, particularly for floating-point
 647 programs.</li>
 648
 649 <li>Defining vararg functions is not supported (but calling them is ok).</li>
 650
 651 <li>The Itanium backend has bitrotted somewhat.</li>
 652 </ul>
 653
 654 </div>
 655
 656 <!-- ======================================================================= -->
 657 <div class="doc_subsection">
 658   <a name="c-be">Known problems with the C back-end</a>
 659 </div>
 660
 661 <div class="doc_text">
 662
 663 <ul>
 664 <li><a href="http://llvm.org/PR802">The C backend does not support inline
 665     assembly code</a>.</li>
 666 </ul>
 667
 668 </div>
 669
 670
 671 <!-- ======================================================================= -->
 672 <div class="doc_subsection">
 673   <a name="c-fe">Known problems with the C front-end</a>
 674 </div>
 675
 676 <!-- _______________________________________________________________________ -->
 677 <div class="doc_subsubsection">Bugs</div>
 678
 679 <div class="doc_text">
 680
 681 <p>llvm-gcc4 does not currently support <a href="http://llvm.org/PR869">Link-Time
 682 Optimization</a> on most platforms "out-of-the-box".  Please inquire on the
 683 llvmdev mailing list if you are interested.</p>
 684
 685 </div>
 686
 687 <!-- _______________________________________________________________________ -->
 688 <div class="doc_subsubsection">
 689   Notes
 690 </div>
 691
 692 <div class="doc_text">
 693 <ul>
 694
 695 <li><p>"long double" is silently transformed by the front-end into "double".  There
 696 is no support for floating point data types of any size other than 32 and 64
 697 bits.</p></li>
 698
 699 <li><p>llvm-gcc does <b>not</b> support <tt>__builtin_apply</tt> yet.
 700   See <a href="http://gcc.gnu.org/onlinedocs/gcc/Constructing-Calls.html#Constructing%20Calls">Constructing Calls</a>: Dispatching a call to another function.</p>
 701 </li>
 702
 703 <li><p>llvm-gcc <b>partially</b> supports tthese GCC extensions:</p>
 704   <ol>
 705   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Nested-Functions.html#Nested%20Functions">Nested Functions</a>: As in Algol and Pascal, lexical scoping of functions.<br>
 706       Nested functions are supported, but llvm-gcc does not support non-local
 707       gotos or taking the address of a nested function.</li>
 708
 709   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Attributes.html#Function%20Attributes">Function Attributes</a>:
 710
 711       Declaring that functions have no side effects or that they can never
 712       return.<br>
 713
 714       <b>Supported:</b> <tt>alias</tt>, <tt>always_inline</tt>, <tt>cdecl</tt>,
 715       <tt>constructor</tt>, <tt>destructor</tt>,
 716       <tt>deprecated</tt>, <tt>fastcall</tt>, <tt>format</tt>,
 717       <tt>format_arg</tt>, <tt>non_null</tt>, <tt>noreturn</tt>, <tt>regparm</tt>
 718       <tt>section</tt>, <tt>stdcall</tt>, <tt>unused</tt>, <tt>used</tt>,
 719       <tt>visibility</tt>, <tt>warn_unused_result</tt>, <tt>weak</tt><br>
 720
 721       <b>Ignored:</b> <tt>noinline</tt>, <tt>pure</tt>, <tt>const</tt>, <tt>nothrow</tt>,
 722       <tt>malloc</tt>, <tt>no_instrument_function</tt></li>
 723   </ol>
 724 </li>
 725
 726 <li><p>llvm-gcc supports the vast majority of GCC extensions, including:</p>
 727
 728   <ol>
 729   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Pragmas.html#Pragmas">Pragmas</a>: Pragmas accepted by GCC.</li>
 730   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Local-Labels.html#Local%20Labels">Local Labels</a>: Labels local to a block.</li>
 731   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Other-Builtins.html#Other%20Builtins">Other Builtins</a>:
 732       Other built-in functions.</li>
 733   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Attributes.html#Variable%20Attributes">Variable Attributes</a>:
 734       Specifying attributes of variables.</li>
 735   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Type-Attributes.html#Type%20Attributes">Type Attributes</a>:   Specifying attributes of types.</li>
 736   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Thread_002dLocal.html">Thread-Local</a>: Per-thread variables.</li>
 737   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variable-Length.html#Variable%20Length">Variable Length</a>:
 738       Arrays whose length is computed at run time.</li>
 739   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Labels-as-Values.html#Labels%20as%20Values">Labels as Values</a>: Getting pointers to labels and computed gotos.</li>
 740   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Statement-Exprs.html#Statement%20Exprs">Statement Exprs</a>:   Putting statements and declarations inside expressions.</li>
 741   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Typeof.html#Typeof">Typeof</a>: <code>typeof</code>: referring to the type of an expression.</li>
 742   <li><a href="http://gcc.gnu.org/onlinedocs/gcc-3.4.0/gcc/Lvalues.html#Lvalues">Lvalues</a>: Using <code>?:</code>, "<code>,</code>" and casts in lvalues.</li>
 743   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Conditionals.html#Conditionals">Conditionals</a>: Omitting the middle operand of a <code>?:</code> expression.</li>
 744   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Long-Long.html#Long%20Long">Long Long</a>: Double-word integers.</li>
 745   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Complex.html#Complex">Complex</a>:   Data types for complex numbers.</li>
 746   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Hex-Floats.html#Hex%20Floats">Hex Floats</a>:Hexadecimal floating-point constants.</li>
 747   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Zero-Length.html#Zero%20Length">Zero Length</a>: Zero-length arrays.</li>
 748   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Empty-Structures.html#Empty%20Structures">Empty Structures</a>: Structures with no members.</li>
 749   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Variadic-Macros.html#Variadic%20Macros">Variadic Macros</a>: Macros with a variable number of arguments.</li>
 750   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Escaped-Newlines.html#Escaped%20Newlines">Escaped Newlines</a>:  Slightly looser rules for escaped newlines.</li>
 751   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Extended-Asm.html#Extended%20Asm">Extended Asm</a>: Assembler instructions with C expressions as operands.</li>
 752   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Constraints.html#Constraints">Constraints</a>: Constraints for asm operands.</li>
 753   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Asm-Labels.html#Asm%20Labels">Asm Labels</a>: Specifying the assembler name to use for a C symbol.</li>
 754   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Explicit-Reg-Vars.html#Explicit%20Reg%20Vars">Explicit Reg Vars</a>: Defining variables residing in specified registers.</li>
 755   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Vector-Extensions.html#Vector%20Extensions">Vector Extensions</a>: Using vector instructions through built-in functions.</li>
 756   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Target-Builtins.html#Target%20Builtins">Target Builtins</a>:   Built-in functions specific to particular targets.</li>
 757   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Subscripting.html#Subscripting">Subscripting</a>: Any array can be subscripted, even if not an lvalue.</li>
 758   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Pointer-Arith.html#Pointer%20Arith">Pointer Arith</a>: Arithmetic on <code>void</code>-pointers and function pointers.</li>
 759   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Initializers.html#Initializers">Initializers</a>: Non-constant initializers.</li>
 760   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Compound-Literals.html#Compound%20Literals">Compound Literals</a>: Compound literals give structures, unions,
 761 or arrays as values.</li>
 762   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Designated-Inits.html#Designated%20Inits">Designated Inits</a>: Labeling elements of initializers.</li>
 763   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Cast-to-Union.html#Cast%20to%20Union">Cast to Union</a>: Casting to union type from any member of the union.</li>
 764   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Case-Ranges.html#Case%20Ranges">Case Ranges</a>: `case 1 ... 9' and such.</li>
 765   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Mixed-Declarations.html#Mixed%20Declarations">Mixed Declarations</a>: Mixing declarations and code.</li>
 766   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Prototypes.html#Function%20Prototypes">Function Prototypes</a>: Prototype declarations and old-style definitions.</li>
 767   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/C_002b_002b-Comments.html#C_002b_002b-Comments">C++ Comments</a>: C++ comments are recognized.</li>
 768   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Dollar-Signs.html#Dollar%20Signs">Dollar Signs</a>: Dollar sign is allowed in identifiers.</li>
 769   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Character-Escapes.html#Character%20Escapes">Character Escapes</a>: <code>\e</code> stands for the character &lt;ESC&gt;.</li>
 770   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Alignment.html#Alignment">Alignment</a>: Inquiring about the alignment of a type or variable.</li>
 771   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Inline.html#Inline">Inline</a>: Defining inline functions (as fast as macros).</li>
 772   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Alternate-Keywords.html#Alternate%20Keywords">Alternate Keywords</a>:<code>__const__</code>, <code>__asm__</code>, etc., for header files.</li>
 773   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Incomplete-Enums.html#Incomplete%20Enums">Incomplete Enums</a>:  <code>enum foo;</code>, with details to follow.</li>
 774   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Function-Names.html#Function%20Names">Function Names</a>: Printable strings which are the name of the current function.</li>
 775   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Return-Address.html#Return%20Address">Return Address</a>: Getting the return or frame address of a function.</li>
 776   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Unnamed-Fields.html#Unnamed%20Fields">Unnamed Fields</a>: Unnamed struct/union fields within structs/unions.</li>
 777   <li><a href="http://gcc.gnu.org/onlinedocs/gcc/Attribute-Syntax.html#Attribute%20Syntax">Attribute Syntax</a>: Formal syntax for attributes.</li>
 778   </ol></li>
 779
 780 </ul>
 781
 782 <p>If you run into GCC extensions which have not been included in any of these
 783 lists, please let us know (also including whether or not they work).</p>
 784
 785 </div>
 786
 787 <!-- ======================================================================= -->
 788 <div class="doc_subsection">
 789   <a name="c++-fe">Known problems with the C++ front-end</a>
 790 </div>
 791
 792 <div class="doc_text">
 793
 794 <p>The C++ front-end is considered to be fully
 795 tested and works for a number of non-trivial programs, including LLVM
 796 itself, Qt, Mozilla, etc.</p>
 797
 798 <ul>
 799 <li>llvm-gcc4 only has partial support for <a href="http://llvm.org/PR870">C++
 800 Exception Handling</a>, and it is not enabled by default.</li>
 801
 802 <!-- NO EH Support!
 803
 804 <li>Destructors for local objects are not always run when a <tt>longjmp</tt> is
 805     performed. In particular, destructors for objects in the <tt>longjmp</tt>ing
 806     function and in the <tt>setjmp</tt> receiver function may not be run.
 807     Objects in intervening stack frames will be destroyed, however (which is
 808     better than most compilers).</li>
 809
 810 <li>The LLVM C++ front-end follows the <a
 811     href="http://www.codesourcery.com/cxx-abi">Itanium C++ ABI</a>.
 812     This document, which is not Itanium specific, specifies a standard for name
 813     mangling, class layout, v-table layout, RTTI formats, and other C++
 814     representation issues.  Because we use this API, code generated by the LLVM
 815     compilers should be binary compatible with machine code generated by other
 816     Itanium ABI C++ compilers (such as G++, the Intel and HP compilers, etc).
 817     <i>However</i>, the exception handling mechanism used by llvm-gcc3 is very
 818     different from the model used in the Itanium ABI, so <b>exceptions will not
 819     interact correctly</b>. </li>
 820 -->
 821 </ul>
 822
 823 </div>
 824
 825
 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 CVS
 839 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>