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.3 Release Notes</title>
   8 </head>
   9 <body>
  10
  11 <div class="doc_title">LLVM 2.3 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 <!-- Done through Week-of-Mon-20080324.txt -->
  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.3.  Here we describe the status of LLVM, including
  38 major improvements from the previous release and any known problems.  All LLVM
  39 releases may be downloaded from the <a href="http://llvm.org/releases/">LLVM
  40 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 releases, please see the
  51 <a href="http://llvm.org/releases/">releases page</a>.</p>
  52
  53 </div>
  54
  55 <!-- *********************************************************************** -->
  56 <div class="doc_section">
  57   <a name="whatsnew">What's New?</a>
  58 </div>
  59 <!-- *********************************************************************** -->
  60
  61 <div class="doc_text">
  62
  63 <p>This is the fourteenth public release of the LLVM Compiler Infrastructure.
  64 It includes a large number of features and refinements from LLVM 2.2.</p>
  65
  66 </div>
  67
  68 <!-- Unfinished features in 2.3:
  69   Machine LICM
  70   Machine Sinking
  71   LegalizeDAGTypes
  72  -->
  73
  74 <!--=========================================================================-->
  75 <div class="doc_subsection">
  76 <a name="changes">Major Changes in LLVM 2.3</a>
  77 </div>
  78
  79 <div class="doc_text">
  80
  81 <p>LLVM 2.2 was the last LLVM release to support llvm-gcc 4.0 and llvm-upgrade.
  82 llvm-gcc 4.0 has been replaced with llvm-gcc 4.2.  llvm-upgrade was useful for
  83 upgrading LLVM 1.9 files to LLVM 2.x syntax, but you can always use a previous
  84 LLVM release to do this.  One nice impact of this is that the LLVM regressionn
  85 test suite no longer depends on llvm-upgrade, which makes it run faster.</p>
  86
  87 <p>LLVM 2.3 renames the LLVMBuilder and LLVMFoldingBuilder classes to
  88    IRBuilder.</p>
  89
  90 </div>
  91
  92 <!--=========================================================================-->
  93 <div class="doc_subsection">
  94 <a name="majorfeatures">Major New Features</a>
  95 </div>
  96
  97 <div class="doc_text">
  98
  99 <p>LLVM 2.3 includes several major new capabilities:</p>
 100
 101 <ul>
 102 <li>Multiple Return Value Support</li>
 103
 104
 105 <li><p>LLVM 2.3 includes a complete reimplementation of the "llvmc" tool.  It is
 106 designed to overcome several problems of the original llvmc and to provide a
 107 superset of the features as the 'gcc' driver.</p>
 108
 109 <p>The main features of llvmc2 is:</p>
 110
 111 <ul>
 112 <li>Extended handling of command line options and smart rules for
 113 dispatching them to different tools.</li>
 114 <li>Flexible (and extensible) rules for defining different tools.</li>
 115 <li>The different intermediate steps performed by tools are represented
 116 as edged in the abstract graph.</li>
 117 </l>The 'language' for driver behaviour definition is tablegen and thus
 118 it's relatively easy to add new features.</li>
 119 <li>The definition of driver is transformed into set of C++ classes, thus
 120 no runtime interpretation is needed.</li>
 121 </ul>
 122
 123 </li>
 124
 125 <li>Reimplemented <a href="LinkTimeOptimization.html">LTO interface</a> in
 126  C.</li>
 127
 128
 129 <li>kaleidoscope tutorial in ocaml.</li>
 130
 131 </ul>
 132
 133 </div>
 134
 135
 136 <!--=========================================================================-->
 137 <div class="doc_subsection">
 138 <a name="frontends">llvm-gcc 4.2 Improvements and Clang</a>
 139 </div>
 140
 141 <div class="doc_text">
 142
 143 <p>LLVM 2.3 fully supports llvm-gcc 4.2 front-end.</p>
 144
 145 <p>llvm-gcc 4.2 includes numerous fixes to better support the Objective-C
 146 front-end.  Objective-C now works very well on Mac OS/X.</p>
 147
 148 <p>llvm-gcc 4.2 includes many other fixes which improve conformance with the
 149 relevant parts of the GCC testsuite.</p>
 150
 151 <p>The <a href="http://clang.llvm.org/">clang project</a> is an effort to build
 152 a set of new 'llvm native' front-end technologies for the LLVM optimizer
 153 and code generator.  Currently, its C and Objective-C support is maturing
 154 nicely, and it has advanced source-to-source analysis and transformation
 155 capabilities.  If you are interested in building source-level tools for C and
 156 Objective-C (and eventually C++), you should take a look.  However, note that
 157 clang is not an official part of the LLVM 2.3 release.  If you are interested in
 158 this project, please see its <a href="http://clang.llvm.org/">web site</a>.</p>
 159
 160 </div>
 161
 162
 163 <!--=========================================================================-->
 164 <div class="doc_subsection">
 165 <a name="coreimprovements">LLVM Core Improvements</a>
 166 </div>
 167
 168 <div class="doc_text">
 169 <p>New features include:
 170 </p>
 171
 172
 173 Common linkage?
 174
 175 Atomic operation support, Alpha, X86, X86-64, PowerPC. "__sync_synchronize"
 176
 177 <ul>
 178 <li>The C and Ocaml bindings have received additional improvements. The
 179 bindings now cover pass managers, several transformation passes, iteration
 180 over the LLVM IR, target data, and parameter attribute lists.</li>
 181 </ul>
 182
 183 </div>
 184
 185 <!--=========================================================================-->
 186 <div class="doc_subsection">
 187 <a name="codegen">Code Generator Improvements</a>
 188 </div>
 189
 190 <div class="doc_text">
 191
 192 <p>We put a significant amount of work into the code generator infrastructure,
 193 which allows us to implement more aggressive algorithms and make it run
 194 faster:</p>
 195
 196 <ul>
 197 <li>MemOperand in the code generator: describe me!.</li>
 198 <li>i128 support and APInt through most of codegen.</li>
 199 <li>Several compile time speedups for code with large basic blocks.</li>
 200 </ul>
 201
 202 </div>
 203
 204 <!--=========================================================================-->
 205 <div class="doc_subsection">
 206 <a name="optimizer">Optimizer Improvements</a>
 207 </div>
 208
 209 <div class="doc_text">
 210
 211 <p>In addition to a huge array of bug fixes and minor performance tweaks, the
 212 LLVM 2.3 optimizers support a few major enhancements:</p>
 213
 214 <ul>
 215
 216 <li>Loop index set splitting on by default: describe me.</li>
 217 <li>LLVM includes a new memcpy optimization pass which optimizes out dead
 218 memcpy calls, unneeded copies of aggregates, and handles the return slot
 219 optimization.  The LLVM optimizer now notices long sequences of consequtive
 220 stores and merges them into memcpy's where profitable.</li>
 221 </ul>
 222
 223 </div>
 224
 225
 226 <!--=========================================================================-->
 227 <div class="doc_subsection">
 228 <a name="x86specific">X86/X86-64 Specific Improvements</a>
 229 </div>
 230
 231 <div class="doc_text">
 232 <p>New target-specific features include:
 233 </p>
 234
 235 <ul>
 236 <li>llvm-gcc's X86-64 ABI conformance is far improved, particularly in the
 237     area of passing and returning structures by value.  llvm-gcc Compiled code
 238     now interoperates very well on X86-64 systems with other compilers.</li>
 239
 240 <li>The LLVM X86 backend now supports the support SSE 4.1 instruction set, and
 241     the llvm-gcc 4.2 front-end supports the SSE 4.1 compiler builtins.</li>
 242
 243 <li>The X86 backend now does a number of optimizations that aim to avoid
 244     converting numbers back and forth from SSE registers to the X87 floating
 245     point stack.</li>
 246
 247 <li>The X86 backend supports stack realignment, which is particularly useful for
 248     vector code on OS's without 16-byte aligned stacks.</li>
 249
 250 <li>The X86 backend now supports the "sseregparm" options in GCC, which allow
 251     functions to be tagged as passing floating point values in SSE
 252     registers.</li>
 253
 254 <li>Trampolines (taking the address of a nested function) now work on
 255     Linux/x86-64.</li>
 256
 257 <li><tt>__builtin_prefetch</tt> is now compiled into the appropriate prefetch
 258     instructions instead of being ignored.</li>
 259
 260 </ul>
 261
 262 </div>
 263
 264 <!--=========================================================================-->
 265 <div class="doc_subsection">
 266 <a name="targetspecific">Other Target Specific Improvements</a>
 267 </div>
 268
 269 <div class="doc_text">
 270 <p>New target-specific features include:
 271 </p>
 272
 273 <ul>
 274 <li>The LLVM C backend now supports vectors code.</li>
 275
 276
 277 </ul>
 278
 279 </div>
 280
 281
 282
 283 <!--=========================================================================-->
 284 <div class="doc_subsection">
 285 <a name="otherimprovements">Other Improvements</a>
 286 </div>
 287
 288 <div class="doc_text">
 289 <p>New features include:
 290 </p>
 291
 292 <ul>
 293 <li>LLVM now builds with GCC 4.3.</li>
 294 <li>llvm2cpp tool was moved into llc, use llc -march=cpp</li>
 295 </ul>
 296
 297 </div>
 298
 299 <!-- *********************************************************************** -->
 300 <div class="doc_section">
 301   <a name="portability">Portability and Supported Platforms</a>
 302 </div>
 303 <!-- *********************************************************************** -->
 304
 305 <div class="doc_text">
 306
 307 <p>LLVM is known to work on the following platforms:</p>
 308
 309 <ul>
 310 <li>Intel and AMD machines running Red Hat Linux, Fedora Core and FreeBSD
 311       (and probably other unix-like systems).</li>
 312 <li>PowerPC and X86-based Mac OS X systems, running 10.3 and above in 32-bit and
 313     64-bit modes.</li>
 314 <li>Intel and AMD machines running on Win32 using MinGW libraries (native).</li>
 315 <li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited
 316     support is available for native builds with Visual C++).</li>
 317 <li>Sun UltraSPARC workstations running Solaris 8.</li>
 318 <li>Alpha-based machines running Debian GNU/Linux.</li>
 319 <li>Itanium-based machines running Linux and HP-UX.</li>
 320 </ul>
 321
 322 <p>The core LLVM infrastructure uses GNU autoconf to adapt itself
 323 to the machine and operating system on which it is built.  However, minor
 324 porting may be required to get LLVM to work on new platforms.  We welcome your
 325 portability patches and reports of successful builds or error messages.</p>
 326
 327 </div>
 328
 329 <!-- *********************************************************************** -->
 330 <div class="doc_section">
 331   <a name="knownproblems">Known Problems</a>
 332 </div>
 333 <!-- *********************************************************************** -->
 334
 335 <div class="doc_text">
 336
 337 <p>This section contains all known problems with the LLVM system, listed by
 338 component.  As new problems are discovered, they will be added to these
 339 sections.  If you run into a problem, please check the <a
 340 href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if
 341 there isn't already one.</p>
 342
 343 </div>
 344
 345 <!-- ======================================================================= -->
 346 <div class="doc_subsection">
 347   <a name="experimental">Experimental features included with this release</a>
 348 </div>
 349
 350 <div class="doc_text">
 351
 352 <p>The following components of this LLVM release are either untested, known to
 353 be broken or unreliable, or are in early development.  These components should
 354 not be relied on, and bugs should not be filed against them, but they may be
 355 useful to some people.  In particular, if you would like to work on one of these
 356 components, please contact us on the <a
 357 href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p>
 358
 359 <ul>
 360 <li>The MSIL, IA64, Alpha, SPU, and MIPS backends are experimental.</li>
 361 <li>The LLC "<tt>-filetype=asm</tt>" (the default) is the only supported
 362     value for this option.</li>
 363 </ul>
 364
 365 </div>
 366
 367 <!-- ======================================================================= -->
 368 <div class="doc_subsection">
 369   <a name="x86-be">Known problems with the X86 back-end</a>
 370 </div>
 371
 372 <div class="doc_text">
 373
 374 <ul>
 375 <li>The X86 backend does not yet support all <a
 376     href="http://llvm.org/PR879">inline assembly that uses the X86 floating
 377     point stack</a>.  It supports the 'f' and 't' constraints, but not 'u'.</li>
 378 <li>The X86 backend generates inefficient floating point code when configured to
 379     generate code for systems that don't have SSE2.</li>
 380 </ul>
 381
 382 </div>
 383
 384 <!-- ======================================================================= -->
 385 <div class="doc_subsection">
 386   <a name="ppc-be">Known problems with the PowerPC back-end</a>
 387 </div>
 388
 389 <div class="doc_text">
 390
 391 <ul>
 392 <li>The Linux PPC32/ABI support needs testing for the interpreter and static
 393 compilation, and lacks support for debug information.</li>
 394 </ul>
 395
 396 </div>
 397
 398 <!-- ======================================================================= -->
 399 <div class="doc_subsection">
 400   <a name="arm-be">Known problems with the ARM back-end</a>
 401 </div>
 402
 403 <div class="doc_text">
 404
 405 <ul>
 406 <li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6
 407 processors, thumb programs can crash or produce wrong
 408 results (<a href="http://llvm.org/PR1388">PR1388</a>).</li>
 409 <li>Compilation for ARM Linux OABI (old ABI) is supported, but not fully tested.
 410 </li>
 411 <li>There is a bug in QEMU-ARM (&lt;= 0.9.0) which causes it to incorrectly execute
 412 programs compiled with LLVM.  Please use more recent versions of QEMU.</li>
 413 </ul>
 414
 415 </div>
 416
 417 <!-- ======================================================================= -->
 418 <div class="doc_subsection">
 419   <a name="sparc-be">Known problems with the SPARC back-end</a>
 420 </div>
 421
 422 <div class="doc_text">
 423
 424 <ul>
 425 <li>The SPARC backend only supports the 32-bit SPARC ABI (-m32), it does not
 426     support the 64-bit SPARC ABI (-m64).</li>
 427 </ul>
 428
 429 </div>
 430
 431 <!-- ======================================================================= -->
 432 <div class="doc_subsection">
 433   <a name="alpha-be">Known problems with the Alpha back-end</a>
 434 </div>
 435
 436 <div class="doc_text">
 437
 438 <ul>
 439
 440 <li>On 21164s, some rare FP arithmetic sequences which may trap do not have the
 441 appropriate nops inserted to ensure restartability.</li>
 442
 443 </ul>
 444 </div>
 445
 446 <!-- ======================================================================= -->
 447 <div class="doc_subsection">
 448   <a name="ia64-be">Known problems with the IA64 back-end</a>
 449 </div>
 450
 451 <div class="doc_text">
 452
 453 <ul>
 454
 455 <li>C++ programs are likely to fail on IA64, as calls to <tt>setjmp</tt> are
 456 made where the argument is not 16-byte aligned, as required on IA64. (Strictly
 457 speaking this is not a bug in the IA64 back-end; it will also be encountered
 458 when building C++ programs using the C back-end.)</li>
 459
 460 <li>The C++ front-end does not use <a href="http://llvm.org/PR406">IA64
 461 ABI compliant layout of v-tables</a>.  In particular, it just stores function
 462 pointers instead of function descriptors in the vtable.  This bug prevents
 463 mixing C++ code compiled with LLVM with C++ objects compiled by other C++
 464 compilers.</li>
 465
 466 <li>There are a few ABI violations which will lead to problems when mixing LLVM
 467 output with code built with other compilers, particularly for floating-point
 468 programs.</li>
 469
 470 <li>Defining vararg functions is not supported (but calling them is ok).</li>
 471
 472 <li>The Itanium backend has bitrotted somewhat.</li>
 473 </ul>
 474
 475 </div>
 476
 477 <!-- ======================================================================= -->
 478 <div class="doc_subsection">
 479   <a name="c-be">Known problems with the C back-end</a>
 480 </div>
 481
 482 <div class="doc_text">
 483
 484 <ul>
 485 <li><a href="http://llvm.org/PR802">The C backend has only basic support for
 486     inline assembly code</a>.</li>
 487 <li><a href="http://llvm.org/PR1658">The C backend violates the ABI of common
 488     C++ programs</a>, preventing intermixing between C++ compiled by the CBE and
 489     C++ code compiled with LLC or native compilers.</li>
 490 <li>The C backend does not support all exception handling constructs.</li>
 491 </ul>
 492
 493 </div>
 494
 495
 496 <!-- ======================================================================= -->
 497 <div class="doc_subsection">
 498   <a name="c-fe">Known problems with the llvm-gcc C front-end</a>
 499 </div>
 500
 501 <!-- _______________________________________________________________________ -->
 502 <div class="doc_subsubsection">Bugs</div>
 503
 504 <div class="doc_text">
 505
 506 <p>llvm-gcc does not currently support <a href="http://llvm.org/PR869">Link-Time
 507 Optimization</a> on most platforms "out-of-the-box".  Please inquire on the
 508 llvmdev mailing list if you are interested.</p>
 509
 510 <p>The only major language feature of GCC not supported by llvm-gcc is
 511     the <tt>__builtin_apply</tt> family of builtins.   However, some extensions
 512     are only supported on some targets.  For example, trampolines are only
 513     supported on some targets, which are used when you take the address of a
 514     nested function.</p>
 515
 516 <p>If you run into GCC extensions which are not supported, please let us know.
 517 </p>
 518
 519 </div>
 520
 521 <!-- ======================================================================= -->
 522 <div class="doc_subsection">
 523   <a name="c++-fe">Known problems with the llvm-gcc C++ front-end</a>
 524 </div>
 525
 526 <div class="doc_text">
 527
 528 <p>The C++ front-end is considered to be fully
 529 tested and works for a number of non-trivial programs, including LLVM
 530 itself, Qt, Mozilla, etc.</p>
 531
 532 <ul>
 533 <li>Exception handling works well on the X86 and PowerPC targets, including
 534 x86-64 darwin.  This works when linking to a libstdc++ compiled by GCC.  It is
 535 supported on x86-64 linux, but that is disabled by default in this release.</li>
 536 </ul>
 537
 538 </div>
 539
 540
 541 <!-- ======================================================================= -->
 542 <div class="doc_subsection">
 543   <a name="ada-fe">Known problems with the llvm-gcc Ada front-end</a>
 544 </div>
 545
 546 <div class="doc_text">
 547 The llvm-gcc 4.2 Ada compiler works fairly well, however this is not a mature
 548 technology and problems should be expected.
 549 <ul>
 550 <li>The Ada front-end currently only builds on x86-32.  This is mainly due
 551 to lack of trampoline support (pointers to nested functions) on other platforms,
 552 however it <a href="http://llvm.org/PR2006">also fails to build on x86-64</a>
 553 which does support trampolines.</li>
 554 <li>The Ada front-end <a href="http://llvm.org/PR2007">fails to bootstrap</a>.
 555 Workaround: configure with --disable-bootstrap.</li>
 556 <li>The c380004 and <a href="http://llvm.org/PR2010">c393010</a> ACATS tests
 557 fail (c380004 also fails with gcc-4.2 mainline).</li>
 558 <li>Many gcc specific Ada tests continue to crash the compiler.</li>
 559 <li>The -E binder option (exception backtraces)
 560 <a href="http://llvm.org/PR1982">does not work</a> and will result in programs
 561 crashing if an exception is raised.  Workaround: do not use -E.</li>
 562 <li>Only discrete types <a href="http://llvm.org/PR1981">are allowed to start
 563 or finish at a non-byte offset</a> in a record.  Workaround: do not pack records
 564 or use representation clauses that result in a field of a non-discrete type
 565 starting or finishing in the middle of a byte.</li>
 566 <li>The lli interpreter <a href="http://llvm.org/PR2009">considers 'main'
 567 as generated by the Ada binder to be invalid</a>.
 568 Workaround: hand edit the file to use pointers for argv and envp rather than
 569 integers.</li>
 570 <li>The -fstack-check option <a href="http://llvm.org/PR2008">is ignored</a>.</li>
 571 </ul>
 572 </div>
 573
 574 <!-- ======================================================================= -->
 575 <div class="doc_subsection">
 576   <a name="fortran-fe">Known problems with the llvm-gcc Fortran front-end</a>
 577 </div>
 578
 579 <div class="doc_text">
 580
 581 <ul>
 582 <li>The llvm-gcc 4.2 gfortran front-end supports a broad range of Fortran code, but does
 583 <a href="http://llvm.org/PR1971">not support EQUIVALENCE yet</a>.</li>
 584 </ul>
 585 </div>
 586
 587
 588
 589 <!-- *********************************************************************** -->
 590 <div class="doc_section">
 591   <a name="additionalinfo">Additional Information</a>
 592 </div>
 593 <!-- *********************************************************************** -->
 594
 595 <div class="doc_text">
 596
 597 <p>A wide variety of additional information is available on the <a
 598 href="http://llvm.org">LLVM web page</a>, in particular in the <a
 599 href="http://llvm.org/docs/">documentation</a> section.  The web page also
 600 contains versions of the API documentation which is up-to-date with the
 601 Subversion version of the source code.
 602 You can access versions of these documents specific to this release by going
 603 into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
 604
 605 <p>If you have any questions or comments about LLVM, please feel free to contact
 606 us via the <a href="http://llvm.org/docs/#maillist"> mailing
 607 lists</a>.</p>
 608
 609 </div>
 610
 611 <!-- *********************************************************************** -->
 612
 613 <hr>
 614 <address>
 615   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
 616   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
 617   <a href="http://validator.w3.org/check/referer"><img
 618   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
 619
 620   <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
 621   Last modified: $Date$
 622 </address>
 623
 624 </body>
 625 </html>