docs/ReleaseNotes.html

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