diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/CommandGuide/llvmc.pod | 7 | ||||
| -rw-r--r-- | docs/CompilerDriver.html | 9 | ||||
| -rw-r--r-- | docs/ReleaseNotes-2.6.html | 777 | ||||
| -rw-r--r-- | docs/SourceLevelDebugging.html | 55 | ||||
| -rw-r--r-- | docs/TestingGuide.html | 57 |
5 files changed, 817 insertions, 88 deletions
diff --git a/docs/CommandGuide/llvmc.pod b/docs/CommandGuide/llvmc.pod index 18ffb9f..97445ed 100644 --- a/docs/CommandGuide/llvmc.pod +++ b/docs/CommandGuide/llvmc.pod @@ -65,8 +65,11 @@ name. Hidden option, useful for debugging LLVMC plugins. =item B<--save-temps> -Write temporary files to the current directory and do not delete them -on exit. Hidden option, useful for debugging. +Write temporary files to the current directory and do not delete them on +exit. This option can also take an argument: the I<--save-temps=obj> switch will +write files into the directory specified with the I<-o> option. The +I<--save-temps=cwd> and I<--save-temps> switches are both synonyms for the +default behaviour. =item B<--help> diff --git a/docs/CompilerDriver.html b/docs/CompilerDriver.html index 5b42148..e79ec5c 100644 --- a/docs/CompilerDriver.html +++ b/docs/CompilerDriver.html @@ -109,6 +109,11 @@ until the next -x option.</li> <li><tt class="docutils literal"><span class="pre">-load</span> <span class="pre">PLUGIN_NAME</span></tt> - Load the specified plugin DLL. Example: <tt class="docutils literal"><span class="pre">-load</span> <span class="pre">$LLVM_DIR/Release/lib/LLVMCSimple.so</span></tt>.</li> <li><tt class="docutils literal"><span class="pre">-v</span></tt> - Enable verbose mode, i.e. print out all executed commands.</li> +<li><tt class="docutils literal"><span class="pre">--save-temps</span></tt> - Write temporary files to the current directory and do not +delete them on exit. This option can also take an argument: the +<tt class="docutils literal"><span class="pre">--save-temps=obj</span></tt> switch will write files into the directory specified with +the <tt class="docutils literal"><span class="pre">-o</span></tt> option. The <tt class="docutils literal"><span class="pre">--save-temps=cwd</span></tt> and <tt class="docutils literal"><span class="pre">--save-temps</span></tt> switches are +both synonyms for the default behaviour.</li> <li><tt class="docutils literal"><span class="pre">--check-graph</span></tt> - Check the compilation for common errors like mismatched output/input language names, multiple default edges and cycles. Because of plugins, these checks can't be performed at compile-time. Exit with code zero @@ -122,8 +127,6 @@ directory with the compilation graph description in Graphviz format (identical to the file used by the <tt class="docutils literal"><span class="pre">--view-graph</span></tt> option). The <tt class="docutils literal"><span class="pre">-o</span></tt> option can be used to set the output file name. Hidden option, useful for debugging LLVMC plugins.</li> -<li><tt class="docutils literal"><span class="pre">--save-temps</span></tt> - Write temporary files to the current directory -and do not delete them on exit. Hidden option, useful for debugging.</li> <li><tt class="docutils literal"><span class="pre">--help</span></tt>, <tt class="docutils literal"><span class="pre">--help-hidden</span></tt>, <tt class="docutils literal"><span class="pre">--version</span></tt> - These options have their standard meaning.</li> </ul> @@ -642,7 +645,7 @@ errors as its status code.</p> <a href="mailto:foldr@codedgers.com">Mikhail Glushenkov</a><br /> <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br /> -Last modified: $Date: 2009-06-17 02:56:48 +0000 (Wed, 17 Jun 2009) $ +Last modified: $Date: 2009-06-25 20:21:10 +0200 (Thu, 25 Jun 2009) $ </address></div> </div> </div> diff --git a/docs/ReleaseNotes-2.6.html b/docs/ReleaseNotes-2.6.html new file mode 100644 index 0000000..ddf3db4 --- /dev/null +++ b/docs/ReleaseNotes-2.6.html @@ -0,0 +1,777 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" + "http://www.w3.org/TR/html4/strict.dtd"> +<html> +<head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <link rel="stylesheet" href="llvm.css" type="text/css"> + <title>LLVM 2.6 Release Notes</title> +</head> +<body> + +<div class="doc_title">LLVM 2.6 Release Notes</div> + +<ol> + <li><a href="#intro">Introduction</a></li> + <li><a href="#subproj">Sub-project Status Update</a></li> + <li><a href="#externalproj">External Projects Using LLVM 2.6</a></li> + <li><a href="#whatsnew">What's New in LLVM 2.6?</a></li> + <li><a href="GettingStarted.html">Installation Instructions</a></li> + <li><a href="#portability">Portability and Supported Platforms</a></li> + <li><a href="#knownproblems">Known Problems</a></li> + <li><a href="#additionalinfo">Additional Information</a></li> +</ol> + +<div class="doc_author"> + <p>Written by the <a href="http://llvm.org">LLVM Team</a></p> +</div> + +<!-- *********************************************************************** --> +<div class="doc_section"> + <a name="intro">Introduction</a> +</div> +<!-- *********************************************************************** --> + +<div class="doc_text"> + +<p>This document contains the release notes for the LLVM Compiler +Infrastructure, release 2.6. Here we describe the status of LLVM, including +major improvements from the previous release and significant known problems. +All LLVM releases may be downloaded from the <a +href="http://llvm.org/releases/">LLVM releases web site</a>.</p> + +<p>For more information about LLVM, including information about the latest +release, please check out the <a href="http://llvm.org/">main LLVM +web site</a>. If you have questions or comments, the <a +href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM Developer's Mailing +List</a> is a good place to send them.</p> + +<p>Note that if you are reading this file from a Subversion checkout or the +main LLVM web page, this document applies to the <i>next</i> release, not the +current one. To see the release notes for a specific release, please see the +<a href="http://llvm.org/releases/">releases page</a>.</p> + +</div> + +<!-- Unfinished features in 2.5: + Machine LICM + Machine Sinking + target-specific intrinsics + gold lto plugin + pre-alloc splitter, strong phi elim + <tt>llc -enable-value-prop</tt>, propagation of value info + (sign/zero ext info) from one MBB to another + debug info for optimized code + interpreter + libffi + postalloc scheduler: anti dependence breaking, hazard recognizer? + +initial support for debug line numbers when optimization enabled, not useful in + 2.5 but will be for 2.6. + + --> + + <!-- for announcement email: + --> + +<!-- *********************************************************************** --> +<div class="doc_section"> + <a name="subproj">Sub-project Status Update</a> +</div> +<!-- *********************************************************************** --> + +<div class="doc_text"> +<p> +The LLVM 2.6 distribution currently consists of code from the core LLVM +repository —which roughly includes the LLVM optimizers, code generators +and supporting tools — and the llvm-gcc repository. In addition to this +code, the LLVM Project includes other sub-projects that are in development. The +two which are the most actively developed are the <a href="#clang">Clang +Project</a> and the <a href="#vmkit">VMKit Project</a>. +</p> + +</div> + + +<!--=========================================================================--> +<div class="doc_subsection"> +<a name="clang">Clang: C/C++/Objective-C Frontend Toolkit</a> +</div> + +<div class="doc_text"> + +<p>The <a href="http://clang.llvm.org/">Clang project</a> is an effort to build +a set of new 'LLVM native' front-end technologies for the LLVM optimizer and +code generator. While Clang is not included in the LLVM 2.6 release, it is +continuing to make major strides forward in all areas. Its C and Objective-C +parsing and code generation support is now very solid. For example, it is +capable of successfully building many real-world applications for X86-32 +and X86-64, +including the <a href="http://wiki.freebsd.org/BuildingFreeBSDWithClang">FreeBSD +kernel</a> and <a href="http://gcc.gnu.org/gcc-4.2/">gcc 4.2</a>. C++ is also +making <a href="http://clang.llvm.org/cxx_status.html">incredible progress</a>, +and work on templates has recently started. If you are +interested in fast compiles and good diagnostics, we encourage you to try it out +by <a href="http://clang.llvm.org/get_started.html">building from mainline</a> +and reporting any issues you hit to the <a +href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-dev">Clang front-end mailing +list</a>.</p> + +<p>In the LLVM 2.6 time-frame, the Clang team has made many improvements:</p> + +<ul> +<li>Something wonderful!</li> +<li>Many many bugs are fixed and many features have been added.</li> +</ul> +</div> + +<!--=========================================================================--> +<div class="doc_subsection"> +<a name="clangsa">Clang Static Analyzer</a> +</div> + +<div class="doc_text"> + +<p>Previously announced in the 2.4 LLVM release, the Clang project also +includes an early stage static source code analysis tool for <a +href="http://clang.llvm.org/StaticAnalysis.html">automatically finding bugs</a> +in C and Objective-C programs. The tool performs a growing set of checks to find +bugs that occur on a specific path within a program.</p> + +<p>In the LLVM 2.6 time-frame there have been many significant improvements to +XYZ.</p> + +<p>The set of checks performed by the static analyzer continues to expand, and +future plans for the tool include full source-level inter-procedural analysis +and deeper checks such as buffer overrun detection. There are many opportunities +to extend and enhance the static analyzer, and anyone interested in working on +this project is encouraged to get involved!</p> + +</div> + +<!--=========================================================================--> +<div class="doc_subsection"> +<a name="vmkit">VMKit: JVM/CLI Virtual Machine Implementation</a> +</div> + +<div class="doc_text"> +<p> +The <a href="http://vmkit.llvm.org/">VMKit project</a> is an implementation of +a JVM and a CLI Virtual Machines (Microsoft .NET is an +implementation of the CLI) using the Just-In-Time compiler of LLVM.</p> + +<p>Following LLVM 2.6, VMKit has its XYZ release that you can find on its +<a href="http://vmkit.llvm.org/releases/">webpage</a>. The release includes +bug fixes, cleanup and new features. The major changes are:</p> + +<ul> + +<li>Something wonderful!</li> + +</ul> +</div> + +<!-- *********************************************************************** --> +<div class="doc_section"> + <a name="externalproj">External Projects Using LLVM 2.6</a> +</div> +<!-- *********************************************************************** --> + +<!--=========================================================================--> +<div class="doc_subsection"> +<a name="pure">Pure</a> +</div> + +<div class="doc_text"> +<p> +<a href="http://pure-lang.googlecode.com/">Pure</a> +is an algebraic/functional programming language based on term rewriting. +Programs are collections of equations which are used to evaluate expressions in +a symbolic fashion. Pure offers dynamic typing, eager and lazy evaluation, +lexical closures, a hygienic macro system (also based on term rewriting), +built-in list and matrix support (including list and matrix comprehensions) and +an easy-to-use C interface. The interpreter uses LLVM as a backend to + JIT-compile Pure programs to fast native code.</p> + +<p>In addition to the usual algebraic data structures, Pure also has +MATLAB-style matrices in order to support numeric computations and signal +processing in an efficient way. Pure is mainly aimed at mathematical +applications right now, but it has been designed as a general purpose language. +The dynamic interpreter environment and the C interface make it possible to use +it as a kind of functional scripting language for many application areas. +</p> +</div> + + +<!--=========================================================================--> +<div class="doc_subsection"> +<a name="ldc">LLVM D Compiler</a> +</div> + +<div class="doc_text"> +<p> +<a href="http://www.dsource.org/projects/ldc">LDC</a> is an implementation of +the D Programming Language using the LLVM optimizer and code generator. +The LDC project works great with the LLVM 2.6 release. General improvements in +this +cycle have included new inline asm constraint handling, better debug info +support, general bugfixes, and better x86-64 support. This has allowed +some major improvements in LDC, getting us much closer to being as +fully featured as the original DMD compiler from DigitalMars. +</p> +</div> + +<!--=========================================================================--> +<div class="doc_subsection"> +<a name="RoadsendPHP">Roadsend PHP</a> +</div> + +<div class="doc_text"> +<p><a href="http://code.roadsend.com/rphp">Roadsend PHP</a> (rphp) is an open +source implementation of the PHP programming +language that uses LLVM for its optimizer, JIT, and static compiler. This is a +reimplementation of an earlier project that is now based on LLVM.</p> +</div> + +<!--=========================================================================--> +<div class="doc_subsection"> +<a name="Unladen Swallow">Unladen Swallow</a> +</div> + +<div class="doc_text"> +<p><a href="http://code.google.com/p/unladen-swallow/">Unladen Swallow</a> is a +branch of <a href="http://python.org/">Python</a> intended to be fully +compatible and significantly faster. It uses LLVM's optimization passes and JIT +compiler.</p> +</div> + +<!--=========================================================================--> +<div class="doc_subsection"> +<a name="Rubinius">Rubinius</a> +</div> + +<div class="doc_text"> +<p><a href="http://github.com/evanphx/rubinius">Rubinius</a> is a new virtual +machine for Ruby. It leverages LLVM to dynamically compile Ruby code down to +machine code using LLVM's JIT.</p> +</div> + + +<!-- *********************************************************************** --> +<div class="doc_section"> + <a name="whatsnew">What's New in LLVM 2.6?</a> +</div> +<!-- *********************************************************************** --> + +<div class="doc_text"> + +<p>This release includes a huge number of bug fixes, performance tweaks, and +minor improvements. Some of the major improvements and new features are listed +in this section. +</p> +</div> + +<!--=========================================================================--> +<div class="doc_subsection"> +<a name="majorfeatures">Major New Features</a> +</div> + +<div class="doc_text"> + +<p>LLVM 2.6 includes several major new capabilities:</p> + +<ul> +<li>Something wonderful!</li> +</ul> + +</div> + + +<!--=========================================================================--> +<div class="doc_subsection"> +<a name="llvm-gcc">llvm-gcc 4.2 Improvements</a> +</div> + +<div class="doc_text"> + +<p>LLVM fully supports the llvm-gcc 4.2 front-end, which marries the GCC +front-ends and driver with the LLVM optimizer and code generator. It currently +includes support for the C, C++, Objective-C, Ada, and Fortran front-ends.</p> + +<ul> +<li>Something wonderful!</li> +</ul> + +</div> + + +<!--=========================================================================--> +<div class="doc_subsection"> +<a name="coreimprovements">LLVM IR and Core Improvements</a> +</div> + +<div class="doc_text"> +<p>LLVM IR has several new features that are used by our existing front-ends and +can be useful if you are writing a front-end for LLVM:</p> + +<ul> +<li>Something wonderful!</li> +</ul> + +</div> + +<!--=========================================================================--> +<div class="doc_subsection"> +<a name="optimizer">Optimizer Improvements</a> +</div> + +<div class="doc_text"> + +<p>In addition to a large array of bug fixes and minor performance tweaks, this +release includes a few major enhancements and additions to the optimizers:</p> + +<ul> + +<li>Something wonderful!</li> + +</ul> + +</div> + +<!--=========================================================================--> +<div class="doc_subsection"> +<a name="codegen">Target Independent Code Generator Improvements</a> +</div> + +<div class="doc_text"> + +<p>We have put a significant amount of work into the code generator +infrastructure, which allows us to implement more aggressive algorithms and make +it run faster:</p> + +<ul> + +<li>Something wonderful!</li> +</ul> +</div> + +<!--=========================================================================--> +<div class="doc_subsection"> +<a name="x86">X86-32 and X86-64 Target Improvements</a> +</div> + +<div class="doc_text"> +<p>New features of the X86 target include: +</p> + +<ul> + +<li>Something wonderful!</li> +</ul> + +</div> + +<!--=========================================================================--> +<div class="doc_subsection"> +<a name="pic16">PIC16 Target Improvements</a> +</div> + +<div class="doc_text"> +<p>New features of the PIC16 target include: +</p> + +<ul> +<li>Something wonderful!</li> +</ul> + +<p>Things not yet supported:</p> + +<ul> +<li>Floating point.</li> +<li>Passing/returning aggregate types to and from functions.</li> +<li>Variable arguments.</li> +<li>Indirect function calls.</li> +<li>Interrupts/programs.</li> +<li>Debug info.</li> +</ul> + +</div> + + +<!--=========================================================================--> +<div class="doc_subsection"> +<a name="llvmc">Improvements in LLVMC</a> +</div> + +<div class="doc_text"> +<p>New features include:</p> + +<ul> +<li>Something wonderful!</li> +</ul> + +</div> + + +<!--=========================================================================--> +<div class="doc_subsection"> +<a name="changes">Major Changes and Removed Features</a> +</div> + +<div class="doc_text"> + +<p>If you're already an LLVM user or developer with out-of-tree changes based +on LLVM 2.4, this section lists some "gotchas" that you may run into upgrading +from the previous release.</p> + +<ul> + +<li>Something horrible!</li> + +</ul> + + +<p>In addition, many APIs have changed in this release. Some of the major LLVM +API changes are:</p> + +<ul> +<li>The <tt>getABITypeSize</tt> methods are now called <tt>getAllocSize</tt>.</li> +</ul> + +</div> + + + +<!-- *********************************************************************** --> +<div class="doc_section"> + <a name="portability">Portability and Supported Platforms</a> +</div> +<!-- *********************************************************************** --> + +<div class="doc_text"> + +<p>LLVM is known to work on the following platforms:</p> + +<ul> +<li>Intel and AMD machines (IA32, X86-64, AMD64, EMT-64) running Red Hat +Linux, Fedora Core and FreeBSD (and probably other unix-like systems).</li> +<li>PowerPC and X86-based Mac OS X systems, running 10.3 and above in 32-bit +and 64-bit modes.</li> +<li>Intel and AMD machines running on Win32 using MinGW libraries (native).</li> +<li>Intel and AMD machines running on Win32 with the Cygwin libraries (limited + support is available for native builds with Visual C++).</li> +<li>Sun UltraSPARC workstations running Solaris 10.</li> +<li>Alpha-based machines running Debian GNU/Linux.</li> +<li>Itanium-based (IA64) machines running Linux and HP-UX.</li> +</ul> + +<p>The core LLVM infrastructure uses GNU autoconf to adapt itself +to the machine and operating system on which it is built. However, minor +porting may be required to get LLVM to work on new platforms. We welcome your +portability patches and reports of successful builds or error messages.</p> + +</div> + +<!-- *********************************************************************** --> +<div class="doc_section"> + <a name="knownproblems">Known Problems</a> +</div> +<!-- *********************************************************************** --> + +<div class="doc_text"> + +<p>This section contains significant known problems with the LLVM system, +listed by component. If you run into a problem, please check the <a +href="http://llvm.org/bugs/">LLVM bug database</a> and submit a bug if +there isn't already one.</p> + +</div> + +<!-- ======================================================================= --> +<div class="doc_subsection"> + <a name="experimental">Experimental features included with this release</a> +</div> + +<div class="doc_text"> + +<p>The following components of this LLVM release are either untested, known to +be broken or unreliable, or are in early development. These components should +not be relied on, and bugs should not be filed against them, but they may be +useful to some people. In particular, if you would like to work on one of these +components, please contact us on the <a +href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p> + +<ul> +<li>The MSIL, IA64, Alpha, SPU, MIPS, and PIC16 backends are experimental.</li> +<li>The <tt>llc</tt> "<tt>-filetype=asm</tt>" (the default) is the only + supported value for this option.</li> +</ul> + +</div> + +<!-- ======================================================================= --> +<div class="doc_subsection"> + <a name="x86-be">Known problems with the X86 back-end</a> +</div> + +<div class="doc_text"> + +<ul> + <li>The X86 backend does not yet support + all <a href="http://llvm.org/PR879">inline assembly that uses the X86 + floating point stack</a>. It supports the 'f' and 't' constraints, but not + 'u'.</li> + <li>The X86 backend generates inefficient floating point code when configured + to generate code for systems that don't have SSE2.</li> + <li>Win64 code generation wasn't widely tested. Everything should work, but we + expect small issues to happen. Also, llvm-gcc cannot build the mingw64 + runtime currently due + to <a href="http://llvm.org/PR2255">several</a> + <a href="http://llvm.org/PR2257">bugs</a> and due to lack of support for + the + 'u' inline assembly constraint and for X87 floating point inline assembly.</li> + <li>The X86-64 backend does not yet support the LLVM IR instruction + <tt>va_arg</tt>. Currently, the llvm-gcc and front-ends support variadic + argument constructs on X86-64 by lowering them manually.</li> +</ul> + +</div> + +<!-- ======================================================================= --> +<div class="doc_subsection"> + <a name="ppc-be">Known problems with the PowerPC back-end</a> +</div> + +<div class="doc_text"> + +<ul> +<li>The Linux PPC32/ABI support needs testing for the interpreter and static +compilation, and lacks support for debug information.</li> +</ul> + +</div> + +<!-- ======================================================================= --> +<div class="doc_subsection"> + <a name="arm-be">Known problems with the ARM back-end</a> +</div> + +<div class="doc_text"> + +<ul> +<li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6 +processors, thumb programs can crash or produce wrong +results (<a href="http://llvm.org/PR1388">PR1388</a>).</li> +<li>Compilation for ARM Linux OABI (old ABI) is supported but not fully tested. +</li> +<li>There is a bug in QEMU-ARM (<= 0.9.0) which causes it to incorrectly + execute +programs compiled with LLVM. Please use more recent versions of QEMU.</li> +</ul> + +</div> + +<!-- ======================================================================= --> +<div class="doc_subsection"> + <a name="sparc-be">Known problems with the SPARC back-end</a> +</div> + +<div class="doc_text"> + +<ul> +<li>The SPARC backend only supports the 32-bit SPARC ABI (-m32); it does not + support the 64-bit SPARC ABI (-m64).</li> +</ul> + +</div> + +<!-- ======================================================================= --> +<div class="doc_subsection"> + <a name="mips-be">Known problems with the MIPS back-end</a> +</div> + +<div class="doc_text"> + +<ul> +<li>The O32 ABI is not fully supported.</li> +<li>64-bit MIPS targets are not supported yet.</li> +</ul> + +</div> + +<!-- ======================================================================= --> +<div class="doc_subsection"> + <a name="alpha-be">Known problems with the Alpha back-end</a> +</div> + +<div class="doc_text"> + +<ul> + +<li>On 21164s, some rare FP arithmetic sequences which may trap do not have the +appropriate nops inserted to ensure restartability.</li> + +</ul> +</div> + +<!-- ======================================================================= --> +<div class="doc_subsection"> + <a name="ia64-be">Known problems with the IA64 back-end</a> +</div> + +<div class="doc_text"> + +<ul> +<li>The Itanium backend is highly experimental and has a number of known + issues. We are looking for a maintainer for the Itanium backend. If you + are interested, please contact the LLVMdev mailing list.</li> +</ul> + +</div> + +<!-- ======================================================================= --> +<div class="doc_subsection"> + <a name="c-be">Known problems with the C back-end</a> +</div> + +<div class="doc_text"> + +<ul> +<li><a href="http://llvm.org/PR802">The C backend has only basic support for + inline assembly code</a>.</li> +<li><a href="http://llvm.org/PR1658">The C backend violates the ABI of common + C++ programs</a>, preventing intermixing between C++ compiled by the CBE and + C++ code compiled with <tt>llc</tt> or native compilers.</li> +<li>The C backend does not support all exception handling constructs.</li> +<li>The C backend does not support arbitrary precision integers.</li> +</ul> + +</div> + + +<!-- ======================================================================= --> +<div class="doc_subsection"> + <a name="c-fe">Known problems with the llvm-gcc C front-end</a> +</div> + +<div class="doc_text"> + +<p>llvm-gcc does not currently support <a href="http://llvm.org/PR869">Link-Time +Optimization</a> on most platforms "out-of-the-box". Please inquire on the +LLVMdev mailing list if you are interested.</p> + +<p>The only major language feature of GCC not supported by llvm-gcc is + the <tt>__builtin_apply</tt> family of builtins. However, some extensions + are only supported on some targets. For example, trampolines are only + supported on some targets (these are used when you take the address of a + nested function).</p> + +<p>If you run into GCC extensions which are not supported, please let us know. +</p> + +</div> + +<!-- ======================================================================= --> +<div class="doc_subsection"> + <a name="c++-fe">Known problems with the llvm-gcc C++ front-end</a> +</div> + +<div class="doc_text"> + +<p>The C++ front-end is considered to be fully +tested and works for a number of non-trivial programs, including LLVM +itself, Qt, Mozilla, etc.</p> + +<ul> +<li>Exception handling works well on the X86 and PowerPC targets. Currently + only Linux and Darwin targets are supported (both 32 and 64 bit).</li> +</ul> + +</div> + +<!-- ======================================================================= --> +<div class="doc_subsection"> + <a name="fortran-fe">Known problems with the llvm-gcc Fortran front-end</a> +</div> + +<div class="doc_text"> +<ul> +<li>Fortran support generally works, but there are still several unresolved bugs + in Bugzilla. Please see the tools/gfortran component for details.</li> +</ul> +</div> + +<!-- ======================================================================= --> +<div class="doc_subsection"> + <a name="ada-fe">Known problems with the llvm-gcc Ada front-end</a> +</div> + +<div class="doc_text"> +The llvm-gcc 4.2 Ada compiler works fairly well; however, this is not a mature +technology, and problems should be expected. +<ul> +<li>The Ada front-end currently only builds on X86-32. This is mainly due +to lack of trampoline support (pointers to nested functions) on other platforms. +However, it <a href="http://llvm.org/PR2006">also fails to build on X86-64</a> +which does support trampolines.</li> +<li>The Ada front-end <a href="http://llvm.org/PR2007">fails to bootstrap</a>. +This is due to lack of LLVM support for <tt>setjmp</tt>/<tt>longjmp</tt> style +exception handling, which is used internally by the compiler. +Workaround: configure with --disable-bootstrap.</li> +<li>The c380004, <a href="http://llvm.org/PR2010">c393010</a> +and <a href="http://llvm.org/PR2421">cxg2021</a> ACATS tests fail +(c380004 also fails with gcc-4.2 mainline). +If the compiler is built with checks disabled then <a href="http://llvm.org/PR2010">c393010</a> +causes the compiler to go into an infinite loop, using up all system memory.</li> +<li>Some GCC specific Ada tests continue to crash the compiler.</li> +<li>The -E binder option (exception backtraces) +<a href="http://llvm.org/PR1982">does not work</a> and will result in programs +crashing if an exception is raised. Workaround: do not use -E.</li> +<li>Only discrete types <a href="http://llvm.org/PR1981">are allowed to start +or finish at a non-byte offset</a> in a record. Workaround: do not pack records +or use representation clauses that result in a field of a non-discrete type +starting or finishing in the middle of a byte.</li> +<li>The <tt>lli</tt> interpreter <a href="http://llvm.org/PR2009">considers +'main' as generated by the Ada binder to be invalid</a>. +Workaround: hand edit the file to use pointers for <tt>argv</tt> and +<tt>envp</tt> rather than integers.</li> +<li>The <tt>-fstack-check</tt> option <a href="http://llvm.org/PR2008">is +ignored</a>.</li> +</ul> +</div> + +<!-- *********************************************************************** --> +<div class="doc_section"> + <a name="additionalinfo">Additional Information</a> +</div> +<!-- *********************************************************************** --> + +<div class="doc_text"> + +<p>A wide variety of additional information is available on the <a +href="http://llvm.org">LLVM web page</a>, in particular in the <a +href="http://llvm.org/docs/">documentation</a> section. The web page also +contains versions of the API documentation which is up-to-date with the +Subversion version of the source code. +You can access versions of these documents specific to this release by going +into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p> + +<p>If you have any questions or comments about LLVM, please feel free to contact +us via the <a href="http://llvm.org/docs/#maillist"> mailing +lists</a>.</p> + +</div> + +<!-- *********************************************************************** --> + +<hr> +<address> + <a href="http://jigsaw.w3.org/css-validator/check/referer"><img + src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a> + <a href="http://validator.w3.org/check/referer"><img + src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a> + + <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br> + Last modified: $Date: 2009-06-24 23:26:42 +0200 (Wed, 24 Jun 2009) $ +</address> + +</body> +</html> diff --git a/docs/SourceLevelDebugging.html b/docs/SourceLevelDebugging.html index 17851b7..e940e93 100644 --- a/docs/SourceLevelDebugging.html +++ b/docs/SourceLevelDebugging.html @@ -24,7 +24,6 @@ <ol> <li><a href="#debug_info_descriptors">Debug information descriptors</a> <ul> - <li><a href="#format_anchors">Anchor descriptors</a></li> <li><a href="#format_compile_units">Compile unit descriptors</a></li> <li><a href="#format_global_variables">Global variable descriptors</a></li> <li><a href="#format_subprograms">Subprogram descriptors</a></li> @@ -336,58 +335,6 @@ height="369"> <!-- ======================================================================= --> <div class="doc_subsubsection"> - <a name="format_anchors">Anchor descriptors</a> -</div> - -<div class="doc_text"> - -<div class="doc_code"> -<pre> -%<a href="#format_anchors">llvm.dbg.anchor.type</a> = type { - i32, ;; Tag = 0 + <a href="#LLVMDebugVersion">LLVMDebugVersion</a> - i32 ;; Tag of descriptors grouped by the anchor -} -</pre> -</div> - -<p>One important aspect of the LLVM debug representation is that it allows the - LLVM debugger to efficiently index all of the global objects without having - to scan the program. To do this, all of the global objects use "anchor" - descriptors with designated names. All of the global objects of a particular - type (e.g., compile units) contain a pointer to the anchor. This pointer - allows a debugger to use def-use chains to find all global objects of that - type.</p> - -<p>The following names are recognized as anchors by LLVM:</p> - -<div class="doc_code"> -<pre> -%<a href="#format_compile_units">llvm.dbg.compile_units</a> = linkonce constant %<a href="#format_anchors">llvm.dbg.anchor.type</a> { - i32 0, - i32 17 -} ;; DW_TAG_compile_unit -%<a href="#format_global_variables">llvm.dbg.global_variables</a> = linkonce constant %<a href="#format_anchors">llvm.dbg.anchor.type</a> { - i32 0, - i32 52 -} ;; DW_TAG_variable -%<a href="#format_subprograms">llvm.dbg.subprograms</a> = linkonce constant %<a href="#format_anchors">llvm.dbg.anchor.type</a> { - i32 0, - i32 46 -} ;; DW_TAG_subprogram -</pre> -</div> - -<p>Using anchors in this way (where the compile unit descriptor points to the - anchors, as opposed to having a list of compile unit descriptors) allows for - the standard dead global elimination and merging passes to automatically - remove unused debugging information. If the globals were kept track of - through lists, there would always be an object pointing to the descriptors, - thus would never be deleted.</p> - -</div> - -<!-- ======================================================================= --> -<div class="doc_subsubsection"> <a name="format_compile_units">Compile unit descriptors</a> </div> @@ -1919,7 +1866,7 @@ enum Trees { <a href="mailto:sabre@nondot.org">Chris Lattner</a><br> <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br> - Last modified: $Date: 2009-05-29 19:08:57 +0200 (Fri, 29 May 2009) $ + Last modified: $Date: 2009-06-26 03:49:18 +0200 (Fri, 26 Jun 2009) $ </address> </body> diff --git a/docs/TestingGuide.html b/docs/TestingGuide.html index 617ebfc..32b16ca 100644 --- a/docs/TestingGuide.html +++ b/docs/TestingGuide.html @@ -78,27 +78,8 @@ required to build LLVM, plus the following:</p> <dd>Expect is required by DejaGNU.</dd> <dt><a href="http://www.tcl.tk/software/tcltk/">tcl</a></dt> <dd>Tcl is required by DejaGNU. </dd> - -<ul> -<li><tt>./configure --with-f2c=$DIR</tt><br> -This will specify a new <tt>$DIR</tt> for the above-described search -process. This will only work if the binary, header, and library are in their -respective subdirectories of <tt>$DIR</tt>.</li> - -<li><tt>./configure --with-f2c-bin=/binary/path --with-f2c-inc=/include/path ---with-f2c-lib=/lib/path</tt><br> -This allows you to specify the F2C components separately. Note: if you choose -this route, you MUST specify all three components, and you need to only specify -<em>directories</em> where the files are located; do NOT include the -filenames themselves on the <tt>configure</tt> line.</li> -</ul></dd> </dl> -<p>Darwin (Mac OS X) developers can simplify the installation of Expect and tcl -by using fink. <tt>fink install expect</tt> will install both. Alternatively, -Darwinports users can use <tt>sudo port install expect</tt> to install Expect -and tcl.</p> - </div> <!--=========================================================================--> @@ -122,14 +103,17 @@ tests" and are in the <tt>llvm</tt> module in subversion under the <div class="doc_text"> -<p>Code fragments are small pieces of code that test a specific feature of LLVM -or trigger a specific bug in LLVM. They are usually written in LLVM assembly -language, but can be written in other languages if the test targets a particular -language front end. These tests are driven by the DejaGNU testing framework, -which is hidden behind a few simple makefiles.</p> +<p>Code fragments are small pieces of code that test a specific +feature of LLVM or trigger a specific bug in LLVM. They are usually +written in LLVM assembly language, but can be written in other +languages if the test targets a particular language front end (and the +appropriate <tt>--with-llvmgcc</tt> options were used +at <tt>configure</tt> time of the <tt>llvm</tt> module). These tests +are driven by the DejaGNU testing framework, which is hidden behind a +few simple makefiles.</p> -<p>These code fragments are not complete programs. The code generated from them is -never executed to determine correct behavior.</p> +<p>These code fragments are not complete programs. The code generated +from them is never executed to determine correct behavior.</p> <p>These code fragment tests are located in the <tt>llvm/test</tt> directory.</p> @@ -251,10 +235,18 @@ programs), first checkout and setup the <tt>test-suite</tt> module:</p> % cd .. % ./configure --with-llvmgccdir=$LLVM_GCC_DIR </pre> -<p>where <tt>$LLVM_GCC_DIR</tt> is the directory where you <em>installed</em> -llvm-gcc, not it's src or obj dir.</p> </div> +<p>where <tt>$LLVM_GCC_DIR</tt> is the directory where +you <em>installed</em> llvm-gcc, not it's src or obj +dir. The <tt>--with-llvmgccdir</tt> option assumes that +the <tt>llvm-gcc-4.2</tt> module was configured with +<tt>--program-prefix=llvm-</tt>, and therefore that the C and C++ +compiler drivers are called <tt>llvm-gcc</tt> and <tt>llvm-g++</tt> +respectively. If this is not the case, +use <tt>--with-llvmgcc</tt>/<tt>--with-llvmgxx</tt> to specify each +executable's location.</p> + <p>Then, run the entire test suite by running make in the <tt>test-suite</tt> directory:</p> @@ -448,6 +440,11 @@ that subdirectory.</p> </pre> </div> +<p>If your system includes GNU <tt>grep</tt>, make sure +that <tt>GREP_OPTIONS</tt> is not set in your environment. Otherwise, +you may get invalid results (both false positives and false +negatives).</p> + </div> <!-- _______________________________________________________________________ --> @@ -746,6 +743,8 @@ test suite creates temporary files during execution.</p> have the suite checked out and configured, you don't need to do it again (unless the test code or configure script changes).</p> +</div> + <!-- _______________________________________________________________________ --> <div class="doc_subsection"> <a name="testsuiteexternal">Configuring External Tests</a></div> @@ -975,7 +974,7 @@ know. Thanks!</p> John T. Criswell, Reid Spencer, and Tanya Lattner<br> <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br> - Last modified: $Date: 2009-05-21 22:23:59 +0200 (Thu, 21 May 2009) $ + Last modified: $Date: 2009-06-26 07:44:53 +0200 (Fri, 26 Jun 2009) $ </address> </body> </html> |
