diff options
Diffstat (limited to 'docs')
90 files changed, 6232 insertions, 6182 deletions
diff --git a/docs/AliasAnalysis.html b/docs/AliasAnalysis.html index 20b7e96460f3..b93cff07bc4d 100644 --- a/docs/AliasAnalysis.html +++ b/docs/AliasAnalysis.html @@ -7,9 +7,9 @@ </head> <body> -<div class="doc_title"> +<h1> LLVM Alias Analysis Infrastructure -</div> +</h1> <ol> <li><a href="#introduction">Introduction</a></li> @@ -59,12 +59,12 @@ </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="introduction">Introduction</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Alias Analysis (aka Pointer Analysis) is a class of techniques which attempt to determine whether or not two pointers ever can point to the same object in @@ -96,12 +96,12 @@ know</a>.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="overview"><tt>AliasAnalysis</tt> Class Overview</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>The <a href="http://llvm.org/doxygen/classllvm_1_1AliasAnalysis.html"><tt>AliasAnalysis</tt></a> @@ -122,14 +122,12 @@ multiple values, values which are not <a href="LangRef.html#constants">constants</a> are all defined within the same function.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="pointers">Representation of Pointers</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Most importantly, the <tt>AliasAnalysis</tt> class provides several methods which are used to query whether or not two memory objects alias, whether @@ -181,11 +179,11 @@ that the accesses alias.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="alias">The <tt>alias</tt> method</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The <tt>alias</tt> method is the primary interface used to determine whether or not two memory objects alias each other. It takes two memory objects as input and returns MustAlias, PartialAlias, MayAlias, or NoAlias as @@ -194,14 +192,13 @@ appropriate.</p> <p>Like all <tt>AliasAnalysis</tt> interfaces, the <tt>alias</tt> method requires that either the two pointer values be defined within the same function, or at least one of the values is a <a href="LangRef.html#constants">constant</a>.</p> -</div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="MustMayNo">Must, May, and No Alias Responses</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>The NoAlias response may be used when there is never an immediate dependence between any memory reference <i>based</i> on one pointer and any memory reference <i>based</i> the other. The most obvious example is when the two @@ -227,12 +224,14 @@ implies that the pointers compare equal.</p> </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="ModRefInfo">The <tt>getModRefInfo</tt> methods</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The <tt>getModRefInfo</tt> methods return information about whether the execution of an instruction can read or modify a memory location. Mod/Ref @@ -250,25 +249,23 @@ memory written to by CS2. Note that this relation is not commutative.</p> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="OtherItfs">Other useful <tt>AliasAnalysis</tt> methods</a> -</div> +</h3> -<div class="doc_text"> +<div> <p> Several other tidbits of information are often collected by various alias analysis implementations and can be put to good use by various clients. </p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> The <tt>pointsToConstantMemory</tt> method -</div> +</h4> -<div class="doc_text"> +<div> <p>The <tt>pointsToConstantMemory</tt> method returns true if and only if the analysis can prove that the pointer only points to unchanging memory locations @@ -279,12 +276,12 @@ memory location to be modified.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="simplemodref">The <tt>doesNotAccessMemory</tt> and <tt>onlyReadsMemory</tt> methods</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>These methods are used to provide very simple mod/ref information for function calls. The <tt>doesNotAccessMemory</tt> method returns true for a @@ -307,13 +304,17 @@ functions that satisfy the <tt>doesNotAccessMemory</tt> method also satisfies </div> +</div> + +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="writingnew">Writing a new <tt>AliasAnalysis</tt> Implementation</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Writing a new alias analysis implementation for LLVM is quite straight-forward. There are already several implementations that you can use @@ -321,14 +322,12 @@ for examples, and the following information should help fill in any details. For a examples, take a look at the <a href="#impls">various alias analysis implementations</a> included with LLVM.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="passsubclasses">Different Pass styles</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The first step to determining what type of <a href="WritingAnLLVMPass.html">LLVM pass</a> you need to use for your Alias @@ -352,11 +351,11 @@ solve:</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="requiredcalls">Required initialization calls</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Your subclass of <tt>AliasAnalysis</tt> is required to invoke two methods on the <tt>AliasAnalysis</tt> base class: <tt>getAnalysisUsage</tt> and @@ -393,11 +392,11 @@ bool run(Module &M) { </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="interfaces">Interfaces which may be specified</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>All of the <a href="/doxygen/classllvm_1_1AliasAnalysis.html"><tt>AliasAnalysis</tt></a> @@ -412,11 +411,11 @@ implementing, you just override the interfaces you can improve.</p> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="chaining"><tt>AliasAnalysis</tt> chaining behavior</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>With only two special exceptions (the <tt><a href="#basic-aa">basicaa</a></tt> and <a href="#no-aa"><tt>no-aa</tt></a> @@ -451,11 +450,11 @@ updated.</p> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="updating">Updating analysis results for transformations</a> -</div> +</h3> -<div class="doc_text"> +<div> <p> Alias analysis information is initially computed for a static snapshot of the program, but clients will use this information to make transformations to the @@ -471,12 +470,11 @@ their internal data structures are kept up-to-date as the program changes (for example, when an instruction is deleted), and clients of alias analysis must be sure to call these interfaces appropriately. </p> -</div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection">The <tt>deleteValue</tt> method</div> +<h4>The <tt>deleteValue</tt> method</h4> -<div class="doc_text"> +<div> The <tt>deleteValue</tt> method is called by transformations when they remove an instruction or any other value from the program (including values that do not use pointers). Typically alias analyses keep data structures that have entries @@ -485,9 +483,9 @@ any entries for the specified value, if they exist. </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection">The <tt>copyValue</tt> method</div> +<h4>The <tt>copyValue</tt> method</h4> -<div class="doc_text"> +<div> The <tt>copyValue</tt> method is used when a new value is introduced into the program. There is no way to introduce a value into the program that did not exist before (this doesn't make sense for a safe compiler transformation), so @@ -496,9 +494,9 @@ new value has exactly the same properties as the value being copied. </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection">The <tt>replaceWithNewValue</tt> method</div> +<h4>The <tt>replaceWithNewValue</tt> method</h4> -<div class="doc_text"> +<div> This method is a simple helper method that is provided to make clients easier to use. It is implemented by copying the old analysis information to the new value, then deleting the old value. This method cannot be overridden by alias @@ -506,9 +504,9 @@ analysis implementations. </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection">The <tt>addEscapingUse</tt> method</div> +<h4>The <tt>addEscapingUse</tt> method</h4> -<div class="doc_text"> +<div> <p>The <tt>addEscapingUse</tt> method is used when the uses of a pointer value have changed in ways that may invalidate precomputed analysis information. Implementations may either use this callback to provide conservative responses @@ -527,12 +525,14 @@ uses below:</p> </ul> </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="implefficiency">Efficiency Issues</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>From the LLVM perspective, the only thing you need to do to provide an efficient alias analysis is to make sure that alias analysis <b>queries</b> are @@ -544,11 +544,11 @@ method as possible (within reason).</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="limitations">Limitations</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The AliasAnalysis infrastructure has several limitations which make writing a new <tt>AliasAnalysis</tt> implementation difficult.</p> @@ -567,7 +567,7 @@ which are intended to allow a pass to keep an AliasAnalysis consistent, however there's no way for a pass to declare in its <tt>getAnalysisUsage</tt> that it does so. Some passes attempt to use <tt>AU.addPreserved<AliasAnalysis></tt>, however this doesn't -actually have any effect.</tt> +actually have any effect.</p> <p><tt>AliasAnalysisCounter</tt> (<tt>-count-aa</tt>) and <tt>AliasDebugger</tt> (<tt>-debug-aa</tt>) are implemented as <tt>ModulePass</tt> classes, so if your @@ -616,25 +616,25 @@ from itself.</p> </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="using">Using alias analysis results</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>There are several different ways to use alias analysis results. In order of preference, these are...</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="memdep">Using the <tt>MemoryDependenceAnalysis</tt> Pass</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The <tt>memdep</tt> pass uses alias analysis to provide high-level dependence information about memory-using instructions. This will tell you which store @@ -645,11 +645,11 @@ efficient, and is used by Dead Store Elimination, GVN, and memcpy optimizations. </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="ast">Using the <tt>AliasSetTracker</tt> class</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Many transformations need information about alias <b>sets</b> that are active in some scope, rather than information about pairwise aliasing. The <tt><a @@ -678,14 +678,12 @@ sunk to outside of the loop, promoting the memory location to a register for the duration of the loop nest. Both of these transformations only apply if the pointer argument is loop-invariant.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> The AliasSetTracker implementation -</div> +</h4> -<div class="doc_text"> +<div> <p>The AliasSetTracker class is implemented to be as efficient as possible. It uses the union-find algorithm to efficiently merge AliasSets when a pointer is @@ -706,12 +704,14 @@ are.</p> </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="direct">Using the <tt>AliasAnalysis</tt> interface directly</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>If neither of these utility class are what your pass needs, you should use the interfaces exposed by the <tt>AliasAnalysis</tt> class directly. Try to use @@ -721,13 +721,15 @@ best precision and efficiency.</p> </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="exist">Existing alias analysis implementations and clients</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>If you're going to be working with the LLVM alias analysis infrastructure, you should know what clients and implementations of alias analysis are @@ -735,28 +737,24 @@ available. In particular, if you are implementing an alias analysis, you should be aware of the <a href="#aliasanalysis-debug">the clients</a> that are useful for monitoring and evaluating different implementations.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="impls">Available <tt>AliasAnalysis</tt> implementations</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>This section lists the various implementations of the <tt>AliasAnalysis</tt> interface. With the exception of the <a href="#no-aa"><tt>-no-aa</tt></a> and <a href="#basic-aa"><tt>-basicaa</tt></a> implementations, all of these <a href="#chaining">chain</a> to other alias analysis implementations.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="no-aa">The <tt>-no-aa</tt> pass</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>The <tt>-no-aa</tt> pass is just like what it sounds: an alias analysis that never returns any useful information. This pass can be useful if you think that @@ -766,11 +764,11 @@ problem.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="basic-aa">The <tt>-basicaa</tt> pass</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>The <tt>-basicaa</tt> pass is an aggressive local analysis that "knows" many important facts:</p> @@ -794,11 +792,11 @@ many important facts:</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="globalsmodref">The <tt>-globalsmodref-aa</tt> pass</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>This pass implements a simple context-sensitive mod/ref and alias analysis for internal global variables that don't "have their address taken". If a @@ -818,11 +816,11 @@ non-address taken globals), but is very quick analysis.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="steens-aa">The <tt>-steens-aa</tt> pass</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>The <tt>-steens-aa</tt> pass implements a variation on the well-known "Steensgaard's algorithm" for interprocedural alias analysis. Steensgaard's @@ -841,11 +839,11 @@ module, it is not part of the LLVM core.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="ds-aa">The <tt>-ds-aa</tt> pass</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>The <tt>-ds-aa</tt> pass implements the full Data Structure Analysis algorithm. Data Structure Analysis is a modular unification-based, @@ -864,11 +862,11 @@ module, it is not part of the LLVM core.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="scev-aa">The <tt>-scev-aa</tt> pass</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>The <tt>-scev-aa</tt> pass implements AliasAnalysis queries by translating them into ScalarEvolution queries. This gives it a @@ -877,22 +875,23 @@ and loop induction variables than other alias analyses have.</p> </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="aliasanalysis-xforms">Alias analysis driven transformations</a> -</div> +</h3> -<div class="doc_text"> +<div> LLVM includes several alias-analysis driven transformations which can be used with any of the implementations above. -</div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="adce">The <tt>-adce</tt> pass</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>The <tt>-adce</tt> pass, which implements Aggressive Dead Code Elimination uses the <tt>AliasAnalysis</tt> interface to delete calls to functions that do @@ -902,11 +901,11 @@ not have side-effects and are not used.</p> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="licm">The <tt>-licm</tt> pass</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>The <tt>-licm</tt> pass implements various Loop Invariant Code Motion related transformations. It uses the <tt>AliasAnalysis</tt> interface for several @@ -927,11 +926,11 @@ no may aliases to the loaded/stored memory location.</li> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="argpromotion">The <tt>-argpromotion</tt> pass</a> -</div> +</h4> -<div class="doc_text"> +<div> <p> The <tt>-argpromotion</tt> pass promotes by-reference arguments to be passed in by-value instead. In particular, if pointer arguments are only loaded from it @@ -942,38 +941,38 @@ pointer.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="gvn">The <tt>-gvn</tt>, <tt>-memcpyopt</tt>, and <tt>-dse</tt> passes</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>These passes use AliasAnalysis information to reason about loads and stores. </p> </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="aliasanalysis-debug">Clients for debugging and evaluation of implementations</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>These passes are useful for evaluating the various alias analysis implementations. You can use them with commands like '<tt>opt -ds-aa -aa-eval foo.bc -disable-output -stats</tt>'.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="print-alias-sets">The <tt>-print-alias-sets</tt> pass</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>The <tt>-print-alias-sets</tt> pass is exposed as part of the <tt>opt</tt> tool to print out the Alias Sets formed by the <a @@ -990,11 +989,11 @@ the <tt>AliasSetTracker</tt> class. To use it, use something like:</p> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="count-aa">The <tt>-count-aa</tt> pass</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>The <tt>-count-aa</tt> pass is useful to see how many queries a particular pass is making and what responses are returned by the alias analysis. As an @@ -1014,11 +1013,11 @@ when debugging a transformation or an alias analysis implementation.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="aa-eval">The <tt>-aa-eval</tt> pass</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>The <tt>-aa-eval</tt> pass simply iterates through all pairs of pointers in a function and asks an alias analysis whether or not the pointers alias. This @@ -1028,13 +1027,17 @@ algorithm will have a lower number of may aliases).</p> </div> +</div> + +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="memdep">Memory Dependence Analysis</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>If you're just looking to be a client of alias analysis information, consider using the Memory Dependence Analysis interface instead. MemDep is a lazy, @@ -1056,8 +1059,8 @@ analysis directly.</p> src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a> <a href="mailto:sabre@nondot.org">Chris Lattner</a><br> - <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br> - Last modified: $Date: 2011-01-03 22:38:41 +0100 (Mon, 03 Jan 2011) $ + <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br> + Last modified: $Date: 2011-04-21 03:52:00 +0200 (Thu, 21 Apr 2011) $ </address> </body> diff --git a/docs/BitCodeFormat.html b/docs/BitCodeFormat.html index 8d3d382da7a9..9a042a0dbaa8 100644 --- a/docs/BitCodeFormat.html +++ b/docs/BitCodeFormat.html @@ -7,7 +7,7 @@ <link rel="stylesheet" href="llvm.css" type="text/css"> </head> <body> -<div class="doc_title"> LLVM Bitcode File Format </div> +<h1> LLVM Bitcode File Format</h1> <ol> <li><a href="#abstract">Abstract</a></li> <li><a href="#overview">Overview</a></li> @@ -47,10 +47,10 @@ </div> <!-- *********************************************************************** --> -<div class="doc_section"> <a name="abstract">Abstract</a></div> +<h2><a name="abstract">Abstract</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>This document describes the LLVM bitstream file format and the encoding of the LLVM IR into it.</p> @@ -58,10 +58,10 @@ the LLVM IR into it.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"> <a name="overview">Overview</a></div> +<h2><a name="overview">Overview</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> What is commonly known as the LLVM bitcode file format (also, sometimes @@ -88,10 +88,10 @@ wrapper format, then describes the record structure used by LLVM IR files. </div> <!-- *********************************************************************** --> -<div class="doc_section"> <a name="bitstream">Bitstream Format</a></div> +<h2><a name="bitstream">Bitstream Format</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> The bitstream format is literally a stream of bits, with a very simple @@ -114,13 +114,12 @@ href="CommandGuide/html/llvm-bcanalyzer.html">llvm-bcanalyzer</a> tool can be used to dump and inspect arbitrary bitstreams, which is very useful for understanding the encoding.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"><a name="magic">Magic Numbers</a> -</div> +<h3> + <a name="magic">Magic Numbers</a> +</h3> -<div class="doc_text"> +<div> <p>The first two bytes of a bitcode file are 'BC' (0x42, 0x43). The second two bytes are an application-specific magic number. Generic @@ -130,10 +129,11 @@ bitcode, while application-specific programs will want to look at all four.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="primitives">Primitives</a> -</div> +<h3> + <a name="primitives">Primitives</a> +</h3> -<div class="doc_text"> +<div> <p> A bitstream literally consists of a stream of bits, which are read in order @@ -144,13 +144,12 @@ Width Integers</a> or as <a href="#variablewidth">Variable Width Integers</a>. </p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> <a name="fixedwidth">Fixed Width Integers</a> -</div> +<h4> + <a name="fixedwidth">Fixed Width Integers</a> +</h4> -<div class="doc_text"> +<div> <p>Fixed-width integer values have their low bits emitted directly to the file. For example, a 3-bit integer value encodes 1 as 001. Fixed width integers @@ -161,10 +160,11 @@ Integers</a>. </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> <a name="variablewidth">Variable Width -Integers</a></div> +<h4> + <a name="variablewidth">Variable Width Integers</a> +</h4> -<div class="doc_text"> +<div> <p>Variable-width integer (VBR) values encode values of arbitrary size, optimizing for the case where the values are small. Given a 4-bit VBR field, @@ -182,9 +182,9 @@ value of 24 (011 << 3) with no continuation. The sum (3+24) yields the value </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> <a name="char6">6-bit characters</a></div> +<h4><a name="char6">6-bit characters</a></h4> -<div class="doc_text"> +<div> <p>6-bit characters encode common characters into a fixed 6-bit field. They represent the following characters with the following 6-bit values:</p> @@ -206,9 +206,9 @@ characters not in the set.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> <a name="wordalign">Word Alignment</a></div> +<h4><a name="wordalign">Word Alignment</a></h4> -<div class="doc_text"> +<div> <p>Occasionally, it is useful to emit zero bits until the bitstream is a multiple of 32 bits. This ensures that the bit position in the stream can be @@ -216,12 +216,14 @@ represented as a multiple of 32-bit words.</p> </div> +</div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="abbrevid">Abbreviation IDs</a> -</div> +<h3> + <a name="abbrevid">Abbreviation IDs</a> +</h3> -<div class="doc_text"> +<div> <p> A bitstream is a sequential series of <a href="#blocks">Blocks</a> and @@ -253,10 +255,11 @@ an <a href="#abbrev_records">abbreviated record encoding</a>.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="blocks">Blocks</a> -</div> +<h3> + <a name="blocks">Blocks</a> +</h3> -<div class="doc_text"> +<div> <p> Blocks in a bitstream denote nested regions of the stream, and are identified by @@ -297,13 +300,10 @@ its own set of abbreviations, and its own abbrev id width. When a sub-block is popped, the saved values are restored. </p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> <a name="ENTER_SUBBLOCK">ENTER_SUBBLOCK -Encoding</a></div> +<h4><a name="ENTER_SUBBLOCK">ENTER_SUBBLOCK Encoding</a></h4> -<div class="doc_text"> +<div> <p><tt>[ENTER_SUBBLOCK, blockid<sub>vbr8</sub>, newabbrevlen<sub>vbr4</sub>, <align32bits>, blocklen<sub>32</sub>]</tt></p> @@ -322,10 +322,9 @@ reader to skip over the entire block in one jump. </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> <a name="END_BLOCK">END_BLOCK -Encoding</a></div> +<h4><a name="END_BLOCK">END_BLOCK Encoding</a></h4> -<div class="doc_text"> +<div> <p><tt>[END_BLOCK, <align32bits>]</tt></p> @@ -337,13 +336,14 @@ an even multiple of 32-bits. </div> - +</div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="datarecord">Data Records</a> -</div> +<h3> + <a name="datarecord">Data Records</a> +</h3> -<div class="doc_text"> +<div> <p> Data records consist of a record code and a number of (up to) 64-bit integer values. The interpretation of the code and values is @@ -355,13 +355,10 @@ which encodes the target triple of a module. The code is ASCII codes for the characters in the string. </p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> <a name="UNABBREV_RECORD">UNABBREV_RECORD -Encoding</a></div> +<h4><a name="UNABBREV_RECORD">UNABBREV_RECORD Encoding</a></h4> -<div class="doc_text"> +<div> <p><tt>[UNABBREV_RECORD, code<sub>vbr6</sub>, numops<sub>vbr6</sub>, op0<sub>vbr6</sub>, op1<sub>vbr6</sub>, ...]</tt></p> @@ -385,10 +382,9 @@ bits. This is not an efficient encoding, but it is fully general. </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> <a name="abbrev_records">Abbreviated Record -Encoding</a></div> +<h4><a name="abbrev_records">Abbreviated Record Encoding</a></h4> -<div class="doc_text"> +<div> <p><tt>[<abbrevid>, fields...]</tt></p> @@ -409,11 +405,14 @@ operand value).</p> </div> -<!-- ======================================================================= --> -<div class="doc_subsection"><a name="abbreviations">Abbreviations</a> </div> -<div class="doc_text"> +<!-- ======================================================================= --> +<h3> + <a name="abbreviations">Abbreviations</a> +</h3> + +<div> <p> Abbreviations are an important form of compression for bitstreams. The idea is to specify a dense encoding for a class of records once, then use that encoding @@ -431,13 +430,11 @@ As a concrete example, LLVM IR files usually emit an abbreviation for binary operators. If a specific LLVM module contained no or few binary operators, the abbreviation does not need to be emitted. </p> -</div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"><a name="DEFINE_ABBREV">DEFINE_ABBREV - Encoding</a></div> +<h4><a name="DEFINE_ABBREV">DEFINE_ABBREV Encoding</a></h4> -<div class="doc_text"> +<div> <p><tt>[DEFINE_ABBREV, numabbrevops<sub>vbr5</sub>, abbrevop0, abbrevop1, ...]</tt></p> @@ -552,11 +549,14 @@ used for any other string value. </div> -<!-- ======================================================================= --> -<div class="doc_subsection"><a name="stdblocks">Standard Blocks</a> </div> -<div class="doc_text"> +<!-- ======================================================================= --> +<h3> + <a name="stdblocks">Standard Blocks</a> +</h3> + +<div> <p> In addition to the basic block structure and record encodings, the bitstream @@ -565,13 +565,10 @@ stream is to be decoded or other metadata. In the future, new standard blocks may be added. Block IDs 0-7 are reserved for standard blocks. </p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"><a name="BLOCKINFO">#0 - BLOCKINFO -Block</a></div> +<h4><a name="BLOCKINFO">#0 - BLOCKINFO Block</a></h4> -<div class="doc_text"> +<div> <p> The <tt>BLOCKINFO</tt> block allows the description of metadata for other @@ -620,11 +617,15 @@ from the corresponding blocks. It is not safe to skip them. </div> +</div> + +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> <a name="wrapper">Bitcode Wrapper Format</a></div> +<h2><a name="wrapper">Bitcode Wrapper Format</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> Bitcode files for LLVM IR may optionally be wrapped in a simple wrapper @@ -652,10 +653,10 @@ value that can be used to encode the CPU of the target. </div> <!-- *********************************************************************** --> -<div class="doc_section"> <a name="llvmir">LLVM IR Encoding</a></div> +<h2><a name="llvmir">LLVM IR Encoding</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> LLVM IR is encoded into a bitstream by defining blocks and records. It uses @@ -666,16 +667,17 @@ that the writer uses, as these are fully self-described in the file, and the reader is not allowed to build in any knowledge of this. </p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"><a name="basics">Basics</a> -</div> +<h3> + <a name="basics">Basics</a> +</h3> + +<div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"><a name="ir_magic">LLVM IR Magic Number</a></div> +<h4><a name="ir_magic">LLVM IR Magic Number</a></h4> -<div class="doc_text"> +<div> <p> The magic number for LLVM IR files is: @@ -695,9 +697,9 @@ When combined with the bitcode magic number and viewed as bytes, this is </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"><a name="ir_signed_vbr">Signed VBRs</a></div> +<h4><a name="ir_signed_vbr">Signed VBRs</a></h4> -<div class="doc_text"> +<div> <p> <a href="#variablewidth">Variable Width Integer</a> encoding is an efficient way to @@ -728,9 +730,9 @@ within <tt>CONSTANTS_BLOCK</tt> blocks. <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"><a name="ir_blocks">LLVM IR Blocks</a></div> +<h4><a name="ir_blocks">LLVM IR Blocks</a></h4> -<div class="doc_text"> +<div> <p> LLVM IR is defined with the following blocks: @@ -758,11 +760,14 @@ LLVM IR is defined with the following blocks: </div> -<!-- ======================================================================= --> -<div class="doc_subsection"><a name="MODULE_BLOCK">MODULE_BLOCK Contents</a> </div> -<div class="doc_text"> +<!-- ======================================================================= --> +<h3> + <a name="MODULE_BLOCK">MODULE_BLOCK Contents</a> +</h3> + +<div> <p>The <tt>MODULE_BLOCK</tt> block (id 8) is the top-level block for LLVM bitcode files, and each bitcode file must contain exactly one. In @@ -782,13 +787,10 @@ following sub-blocks: <li><a href="#METADATA_BLOCK"><tt>METADATA_BLOCK</tt></a></li> </ul> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"><a name="MODULE_CODE_VERSION">MODULE_CODE_VERSION Record</a> -</div> +<h4><a name="MODULE_CODE_VERSION">MODULE_CODE_VERSION Record</a></h4> -<div class="doc_text"> +<div> <p><tt>[VERSION, version#]</tt></p> @@ -798,10 +800,9 @@ time.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"><a name="MODULE_CODE_TRIPLE">MODULE_CODE_TRIPLE Record</a> -</div> +<h4><a name="MODULE_CODE_TRIPLE">MODULE_CODE_TRIPLE Record</a></h4> -<div class="doc_text"> +<div> <p><tt>[TRIPLE, ...string...]</tt></p> <p>The <tt>TRIPLE</tt> record (code 2) contains a variable number of @@ -810,10 +811,9 @@ specification string.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"><a name="MODULE_CODE_DATALAYOUT">MODULE_CODE_DATALAYOUT Record</a> -</div> +<h4><a name="MODULE_CODE_DATALAYOUT">MODULE_CODE_DATALAYOUT Record</a></h4> -<div class="doc_text"> +<div> <p><tt>[DATALAYOUT, ...string...]</tt></p> <p>The <tt>DATALAYOUT</tt> record (code 3) contains a variable number of @@ -822,10 +822,9 @@ specification string.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"><a name="MODULE_CODE_ASM">MODULE_CODE_ASM Record</a> -</div> +<h4><a name="MODULE_CODE_ASM">MODULE_CODE_ASM Record</a></h4> -<div class="doc_text"> +<div> <p><tt>[ASM, ...string...]</tt></p> <p>The <tt>ASM</tt> record (code 4) contains a variable number of @@ -834,10 +833,9 @@ individual assembly blocks separated by newline (ASCII 10) characters.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"><a name="MODULE_CODE_SECTIONNAME">MODULE_CODE_SECTIONNAME Record</a> -</div> +<h4><a name="MODULE_CODE_SECTIONNAME">MODULE_CODE_SECTIONNAME Record</a></h4> -<div class="doc_text"> +<div> <p><tt>[SECTIONNAME, ...string...]</tt></p> <p>The <tt>SECTIONNAME</tt> record (code 5) contains a variable number @@ -850,10 +848,9 @@ referenced by the 1-based index in the <i>section</i> fields of </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"><a name="MODULE_CODE_DEPLIB">MODULE_CODE_DEPLIB Record</a> -</div> +<h4><a name="MODULE_CODE_DEPLIB">MODULE_CODE_DEPLIB Record</a></h4> -<div class="doc_text"> +<div> <p><tt>[DEPLIB, ...string...]</tt></p> <p>The <tt>DEPLIB</tt> record (code 6) contains a variable number of @@ -864,10 +861,9 @@ library name referenced.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"><a name="MODULE_CODE_GLOBALVAR">MODULE_CODE_GLOBALVAR Record</a> -</div> +<h4><a name="MODULE_CODE_GLOBALVAR">MODULE_CODE_GLOBALVAR Record</a></h4> -<div class="doc_text"> +<div> <p><tt>[GLOBALVAR, pointer type, isconst, initid, linkage, alignment, section, visibility, threadlocal]</tt></p> <p>The <tt>GLOBALVAR</tt> record (code 7) marks the declaration or @@ -923,16 +919,15 @@ encoding of the visibility of this variable: is <tt>thread_local</tt></li> <li><i>unnamed_addr</i>: If present and non-zero, indicates that the variable -has <tt>unnamed_addr<tt></li> +has <tt>unnamed_addr</tt></li> </ul> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"><a name="MODULE_CODE_FUNCTION">MODULE_CODE_FUNCTION Record</a> -</div> +<h4><a name="MODULE_CODE_FUNCTION">MODULE_CODE_FUNCTION Record</a></h4> -<div class="doc_text"> +<div> <p><tt>[FUNCTION, type, callingconv, isproto, linkage, paramattr, alignment, section, visibility, gc]</tt></p> @@ -980,16 +975,15 @@ index in the table of <a href="#MODULE_CODE_GCNAME">MODULE_CODE_GCNAME</a> entries.</li> <li><i>unnamed_addr</i>: If present and non-zero, indicates that the function -has <tt>unnamed_addr<tt></li> +has <tt>unnamed_addr</tt></li> </ul> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"><a name="MODULE_CODE_ALIAS">MODULE_CODE_ALIAS Record</a> -</div> +<h4><a name="MODULE_CODE_ALIAS">MODULE_CODE_ALIAS Record</a></h4> -<div class="doc_text"> +<div> <p><tt>[ALIAS, alias type, aliasee val#, linkage, visibility]</tt></p> @@ -1011,10 +1005,9 @@ for this alias</li> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"><a name="MODULE_CODE_PURGEVALS">MODULE_CODE_PURGEVALS Record</a> -</div> +<h4><a name="MODULE_CODE_PURGEVALS">MODULE_CODE_PURGEVALS Record</a></h4> -<div class="doc_text"> +<div> <p><tt>[PURGEVALS, numvals]</tt></p> <p>The <tt>PURGEVALS</tt> record (code 10) resets the module-level @@ -1025,10 +1018,9 @@ new value indices will start from the given <i>numvals</i> value.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"><a name="MODULE_CODE_GCNAME">MODULE_CODE_GCNAME Record</a> -</div> +<h4><a name="MODULE_CODE_GCNAME">MODULE_CODE_GCNAME Record</a></h4> -<div class="doc_text"> +<div> <p><tt>[GCNAME, ...string...]</tt></p> <p>The <tt>GCNAME</tt> record (code 11) contains a variable number of @@ -1039,11 +1031,14 @@ the module. These records can be referenced by 1-based index in the <i>gc</i> fields of <tt>FUNCTION</tt> records.</p> </div> -<!-- ======================================================================= --> -<div class="doc_subsection"><a name="PARAMATTR_BLOCK">PARAMATTR_BLOCK Contents</a> </div> -<div class="doc_text"> +<!-- ======================================================================= --> +<h3> + <a name="PARAMATTR_BLOCK">PARAMATTR_BLOCK Contents</a> +</h3> + +<div> <p>The <tt>PARAMATTR_BLOCK</tt> block (id 9) contains a table of entries describing the attributes of function parameters. These @@ -1057,14 +1052,10 @@ href="#FUNC_CODE_INST_CALL"><tt>INST_CALL</tt></a> records.</p> that each is unique (i.e., no two indicies represent equivalent attribute lists). </p> -</div> - - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"><a name="PARAMATTR_CODE_ENTRY">PARAMATTR_CODE_ENTRY Record</a> -</div> +<h4><a name="PARAMATTR_CODE_ENTRY">PARAMATTR_CODE_ENTRY Record</a></h4> -<div class="doc_text"> +<div> <p><tt>[ENTRY, paramidx0, attr0, paramidx1, attr1...]</tt></p> @@ -1105,11 +1096,14 @@ the logarithm base 2 of the requested alignment, plus 1</li> </ul> </div> -<!-- ======================================================================= --> -<div class="doc_subsection"><a name="TYPE_BLOCK">TYPE_BLOCK Contents</a> </div> -<div class="doc_text"> +<!-- ======================================================================= --> +<h3> + <a name="TYPE_BLOCK">TYPE_BLOCK Contents</a> +</h3> + +<div> <p>The <tt>TYPE_BLOCK</tt> block (id 10) contains records which constitute a table of type operator entries used to represent types @@ -1124,13 +1118,10 @@ type operator records. each entry is unique (i.e., no two indicies represent structurally equivalent types). </p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"><a name="TYPE_CODE_NUMENTRY">TYPE_CODE_NUMENTRY Record</a> -</div> +<h4><a name="TYPE_CODE_NUMENTRY">TYPE_CODE_NUMENTRY Record</a></h4> -<div class="doc_text"> +<div> <p><tt>[NUMENTRY, numentries]</tt></p> @@ -1142,10 +1133,9 @@ in the block. </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"><a name="TYPE_CODE_VOID">TYPE_CODE_VOID Record</a> -</div> +<h4><a name="TYPE_CODE_VOID">TYPE_CODE_VOID Record</a></h4> -<div class="doc_text"> +<div> <p><tt>[VOID]</tt></p> @@ -1155,10 +1145,9 @@ type table. </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"><a name="TYPE_CODE_FLOAT">TYPE_CODE_FLOAT Record</a> -</div> +<h4><a name="TYPE_CODE_FLOAT">TYPE_CODE_FLOAT Record</a></h4> -<div class="doc_text"> +<div> <p><tt>[FLOAT]</tt></p> @@ -1168,10 +1157,9 @@ floating point) type to the type table. </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"><a name="TYPE_CODE_DOUBLE">TYPE_CODE_DOUBLE Record</a> -</div> +<h4><a name="TYPE_CODE_DOUBLE">TYPE_CODE_DOUBLE Record</a></h4> -<div class="doc_text"> +<div> <p><tt>[DOUBLE]</tt></p> @@ -1181,10 +1169,9 @@ floating point) type to the type table. </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"><a name="TYPE_CODE_LABEL">TYPE_CODE_LABEL Record</a> -</div> +<h4><a name="TYPE_CODE_LABEL">TYPE_CODE_LABEL Record</a></h4> -<div class="doc_text"> +<div> <p><tt>[LABEL]</tt></p> @@ -1194,10 +1181,9 @@ the type table. </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"><a name="TYPE_CODE_OPAQUE">TYPE_CODE_OPAQUE Record</a> -</div> +<h4><a name="TYPE_CODE_OPAQUE">TYPE_CODE_OPAQUE Record</a></h4> -<div class="doc_text"> +<div> <p><tt>[OPAQUE]</tt></p> @@ -1208,10 +1194,9 @@ unified. </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"><a name="TYPE_CODE_INTEGER">TYPE_CODE_INTEGER Record</a> -</div> +<h4><a name="TYPE_CODE_INTEGER">TYPE_CODE_INTEGER Record</a></h4> -<div class="doc_text"> +<div> <p><tt>[INTEGER, width]</tt></p> @@ -1222,10 +1207,9 @@ integer type. </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"><a name="TYPE_CODE_POINTER">TYPE_CODE_POINTER Record</a> -</div> +<h4><a name="TYPE_CODE_POINTER">TYPE_CODE_POINTER Record</a></h4> -<div class="doc_text"> +<div> <p><tt>[POINTER, pointee type, address space]</tt></p> @@ -1243,10 +1227,9 @@ default address space is zero. </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"><a name="TYPE_CODE_FUNCTION">TYPE_CODE_FUNCTION Record</a> -</div> +<h4><a name="TYPE_CODE_FUNCTION">TYPE_CODE_FUNCTION Record</a></h4> -<div class="doc_text"> +<div> <p><tt>[FUNCTION, vararg, ignored, retty, ...paramty... ]</tt></p> @@ -1268,10 +1251,9 @@ parameter types of the function</li> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"><a name="TYPE_CODE_STRUCT">TYPE_CODE_STRUCT Record</a> -</div> +<h4><a name="TYPE_CODE_STRUCT">TYPE_CODE_STRUCT Record</a></h4> -<div class="doc_text"> +<div> <p><tt>[STRUCT, ispacked, ...eltty...]</tt></p> @@ -1287,10 +1269,9 @@ types of the structure</li> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"><a name="TYPE_CODE_ARRAY">TYPE_CODE_ARRAY Record</a> -</div> +<h4><a name="TYPE_CODE_ARRAY">TYPE_CODE_ARRAY Record</a></h4> -<div class="doc_text"> +<div> <p><tt>[ARRAY, numelts, eltty]</tt></p> @@ -1305,10 +1286,9 @@ table. The operand fields are</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"><a name="TYPE_CODE_VECTOR">TYPE_CODE_VECTOR Record</a> -</div> +<h4><a name="TYPE_CODE_VECTOR">TYPE_CODE_VECTOR Record</a></h4> -<div class="doc_text"> +<div> <p><tt>[VECTOR, numelts, eltty]</tt></p> @@ -1323,10 +1303,9 @@ table. The operand fields are</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"><a name="TYPE_CODE_X86_FP80">TYPE_CODE_X86_FP80 Record</a> -</div> +<h4><a name="TYPE_CODE_X86_FP80">TYPE_CODE_X86_FP80 Record</a></h4> -<div class="doc_text"> +<div> <p><tt>[X86_FP80]</tt></p> @@ -1336,10 +1315,9 @@ floating point) type to the type table. </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"><a name="TYPE_CODE_FP128">TYPE_CODE_FP128 Record</a> -</div> +<h4><a name="TYPE_CODE_FP128">TYPE_CODE_FP128 Record</a></h4> -<div class="doc_text"> +<div> <p><tt>[FP128]</tt></p> @@ -1349,10 +1327,9 @@ floating point) type to the type table. </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"><a name="TYPE_CODE_PPC_FP128">TYPE_CODE_PPC_FP128 Record</a> -</div> +<h4><a name="TYPE_CODE_PPC_FP128">TYPE_CODE_PPC_FP128 Record</a></h4> -<div class="doc_text"> +<div> <p><tt>[PPC_FP128]</tt></p> @@ -1362,10 +1339,9 @@ floating point) type to the type table. </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"><a name="TYPE_CODE_METADATA">TYPE_CODE_METADATA Record</a> -</div> +<h4><a name="TYPE_CODE_METADATA">TYPE_CODE_METADATA Record</a></h4> -<div class="doc_text"> +<div> <p><tt>[METADATA]</tt></p> @@ -1374,11 +1350,14 @@ type to the type table. </p> </div> -<!-- ======================================================================= --> -<div class="doc_subsection"><a name="CONSTANTS_BLOCK">CONSTANTS_BLOCK Contents</a> </div> -<div class="doc_text"> +<!-- ======================================================================= --> +<h3> + <a name="CONSTANTS_BLOCK">CONSTANTS_BLOCK Contents</a> +</h3> + +<div> <p>The <tt>CONSTANTS_BLOCK</tt> block (id 11) ... </p> @@ -1387,10 +1366,11 @@ type to the type table. <!-- ======================================================================= --> -<div class="doc_subsection"><a name="FUNCTION_BLOCK">FUNCTION_BLOCK Contents</a> -</div> +<h3> + <a name="FUNCTION_BLOCK">FUNCTION_BLOCK Contents</a> +</h3> -<div class="doc_text"> +<div> <p>The <tt>FUNCTION_BLOCK</tt> block (id 12) ... </p> @@ -1409,23 +1389,21 @@ type to the type table. <!-- ======================================================================= --> -<div class="doc_subsection"><a name="TYPE_SYMTAB_BLOCK">TYPE_SYMTAB_BLOCK Contents</a> -</div> +<h3> + <a name="TYPE_SYMTAB_BLOCK">TYPE_SYMTAB_BLOCK Contents</a> +</h3> -<div class="doc_text"> +<div> <p>The <tt>TYPE_SYMTAB_BLOCK</tt> block (id 13) contains entries which map between module-level named types and their corresponding type indices. </p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"><a name="TST_CODE_ENTRY">TST_CODE_ENTRY Record</a> -</div> +<h4><a name="TST_CODE_ENTRY">TST_CODE_ENTRY Record</a></h4> -<div class="doc_text"> +<div> <p><tt>[ENTRY, typeid, ...string...]</tt></p> @@ -1436,12 +1414,14 @@ name. Each entry corresponds to a single named type. </p> </div> +</div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="VALUE_SYMTAB_BLOCK">VALUE_SYMTAB_BLOCK Contents</a> -</div> +<h3> + <a name="VALUE_SYMTAB_BLOCK">VALUE_SYMTAB_BLOCK Contents</a> +</h3> -<div class="doc_text"> +<div> <p>The <tt>VALUE_SYMTAB_BLOCK</tt> block (id 14) ... </p> @@ -1450,10 +1430,11 @@ name. Each entry corresponds to a single named type. <!-- ======================================================================= --> -<div class="doc_subsection"><a name="METADATA_BLOCK">METADATA_BLOCK Contents</a> -</div> +<h3> + <a name="METADATA_BLOCK">METADATA_BLOCK Contents</a> +</h3> -<div class="doc_text"> +<div> <p>The <tt>METADATA_BLOCK</tt> block (id 15) ... </p> @@ -1462,16 +1443,18 @@ name. Each entry corresponds to a single named type. <!-- ======================================================================= --> -<div class="doc_subsection"><a name="METADATA_ATTACHMENT">METADATA_ATTACHMENT Contents</a> -</div> +<h3> + <a name="METADATA_ATTACHMENT">METADATA_ATTACHMENT Contents</a> +</h3> -<div class="doc_text"> +<div> <p>The <tt>METADATA_ATTACHMENT</tt> block (id 16) ... </p> </div> +</div> <!-- *********************************************************************** --> <hr> @@ -1480,8 +1463,8 @@ name. Each entry corresponds to a single named type. <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="mailto:sabre@nondot.org">Chris Lattner</a><br> -<a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br> -Last modified: $Date: 2011-01-08 17:42:36 +0100 (Sat, 08 Jan 2011) $ +<a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br> +Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> </html> diff --git a/docs/Bugpoint.html b/docs/Bugpoint.html index cbd71aab91a7..05c867bcb08c 100644 --- a/docs/Bugpoint.html +++ b/docs/Bugpoint.html @@ -6,9 +6,9 @@ <link rel="stylesheet" href="llvm.css" type="text/css"> </head> -<div class="doc_title"> +<h1> LLVM bugpoint tool: design and usage -</div> +</h1> <ul> <li><a href="#desc">Description</a></li> @@ -27,12 +27,12 @@ </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="desc">Description</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p><tt>bugpoint</tt> narrows down the source of problems in LLVM tools and passes. It can be used to debug three types of failures: optimizer crashes, @@ -50,12 +50,12 @@ href="HowToSubmitABug.html">How To Submit a Bug Report document</a>.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="design">Design Philosophy</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p><tt>bugpoint</tt> is designed to be a useful tool without requiring any hooks into the LLVM infrastructure at all. It works with any and all LLVM @@ -68,14 +68,12 @@ is still worth it. Note that <tt>bugpoint</tt> is generally very quick unless debugging a miscompilation where each test of the program (which requires executing it) takes a long time.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="autoselect">Automatic Debugger Selection</a> -</div> +</h3> -<div class="doc_text"> +<div> <p><tt>bugpoint</tt> reads each <tt>.bc</tt> or <tt>.ll</tt> file specified on the command line and links them together into a single module, called the test @@ -104,11 +102,11 @@ Otherwise, there is no problem <tt>bugpoint</tt> can debug.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="crashdebug">Crash debugger</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>If an optimizer or code generator crashes, <tt>bugpoint</tt> will try as hard as it can to reduce the list of passes (for optimizer crashes) and the size of @@ -129,11 +127,11 @@ reproduce the failure with <tt>opt</tt> or <tt>llc</tt>.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="codegendebug">Code generator debugger</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The code generator debugger attempts to narrow down the amount of code that is being miscompiled by the selected code generator. To do this, it takes the @@ -150,11 +148,11 @@ good code.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="miscompilationdebug">Miscompilation debugger</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The miscompilation debugger works similarly to the code generator debugger. It works by splitting the test program into two pieces, running the @@ -166,13 +164,15 @@ assumes that the selected code generator is working properly.</p> </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="advice">Advice for using bugpoint</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <tt>bugpoint</tt> can be a remarkably useful tool, but it sometimes works in non-obvious ways. Here are some hints and tips:<p> @@ -242,8 +242,8 @@ non-obvious ways. Here are some hints and tips:<p> src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a> <a href="mailto:sabre@nondot.org">Chris Lattner</a><br> - <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br> - Last modified: $Date: 2010-05-07 02:28:04 +0200 (Fri, 07 May 2010) $ + <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br> + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> diff --git a/docs/CFEBuildInstrs.html b/docs/CFEBuildInstrs.html index ed2f295b7aff..ab10844a8e0e 100644 --- a/docs/CFEBuildInstrs.html +++ b/docs/CFEBuildInstrs.html @@ -21,7 +21,7 @@ This page has moved <a href="GCCFEBuildInstrs.html">here</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> + <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br> Last modified: $Date: 2008-02-13 17:46:10 +0100 (Wed, 13 Feb 2008) $ </address> diff --git a/docs/CMake.html b/docs/CMake.html index e303d132b590..0d8cf62e33c4 100644 --- a/docs/CMake.html +++ b/docs/CMake.html @@ -6,9 +6,9 @@ <link rel="stylesheet" href="llvm.css" type="text/css"> </head> -<div class="doc_title"> +<h1> Building LLVM with CMake -</div> +</h1> <ul> <li><a href="#intro">Introduction</a></li> @@ -22,6 +22,9 @@ <li><a href="#testing">Executing the test suite</a> <li><a href="#cross">Cross compiling</a> <li><a href="#embedding">Embedding LLVM in your project</a> + <ul> + <li><a href="#passdev">Developing LLVM pass out of source</a></li> + </ul></li> <li><a href="#specifics">Compiler/Platform specific topics</a> <ul> <li><a href="#msvc">Microsoft Visual C++</a></li> @@ -33,12 +36,12 @@ </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="intro">Introduction</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p><a href="http://www.cmake.org/">CMake</a> is a cross-platform build-generator tool. CMake does not build the project, it generates @@ -56,12 +59,12 @@ </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="quickstart">Quick start</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> We use here the command-line, non-interactive CMake interface </p> @@ -109,12 +112,12 @@ </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="usage">Basic CMake usage</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>This section explains basic aspects of CMake, mostly for explaining those options which you may need on your day-to-day @@ -157,12 +160,12 @@ </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="options">Options and variables</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Variables customize how the build will be generated. Options are boolean variables, with possible values ON/OFF. Options and @@ -191,14 +194,12 @@ <p><tt>cmake -DVARIABLE:TYPE=value path/to/llvm/source</tt></p> </div> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="freccmake">Frequently-used CMake variables</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Here are listed some of the CMake variables that are used often, along with a brief explanation and LLVM-specific notes. For full @@ -237,11 +238,11 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="llvmvars">LLVM-specific variables</a> -</div> +</h3> -<div class="doc_text"> +<div> <dl> <dt><b>LLVM_TARGETS_TO_BUILD</b>:STRING</dt> @@ -342,7 +343,7 @@ <dt><b>LLVM_LIT_TOOLS_DIR</b>:STRING</dt> <dd>The path to GnuWin32 tools for tests. Valid on Windows host. Defaults to "", then Lit seeks tools according to %PATH%. - Lit can find tools(eg. grep, sort, &c) on LLVM_LIT_TOOLS_DIR at first, + Lit can find tools(eg. grep, sort, &c) on LLVM_LIT_TOOLS_DIR at first, without specifying GnuWin32 to %PATH%.</dd> <dt><b>LLVM_ENABLE_FFI</b>:BOOL</dt> @@ -354,13 +355,15 @@ </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="testing">Executing the test suite</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Testing is performed when the <i>check</i> target is built. For instance, if you are using makefiles, execute this command while on @@ -375,12 +378,12 @@ </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="cross">Cross compiling</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>See <a href="http://www.vtk.org/Wiki/CMake_Cross_Compiling">this wiki page</a> for generic instructions on how to cross-compile @@ -396,12 +399,12 @@ </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="embedding">Embedding LLVM in your project</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>The most difficult part of adding LLVM to the build of a project is to determine the set of LLVM libraries corresponding to the set @@ -418,7 +421,7 @@ endif() <b># We incorporate the CMake features provided by LLVM:</b> set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${LLVM_ROOT}/share/llvm/cmake") - include(LLVM) + include(LLVMConfig) <b># Now set the header and library paths:</b> include_directories( ${LLVM_ROOT}/include ) link_directories( ${LLVM_ROOT}/lib ) @@ -436,20 +439,111 @@ headers on the LLVM source directory (if we are building out-of-source.)</p> -</div> + <p>Alternativaly, you can utilize CMake's <i>find_package</i> + functionality. Here is an equivalent variant of snippet shown above:</p> + + <div class="doc_code"> + <pre> + find_package(LLVM) + + if( NOT LLVM_FOUND ) + message(FATAL_ERROR "LLVM package can't be found. Set CMAKE_PREFIX_PATH variable to LLVM's installation prefix.") + endif() + + include_directories( ${LLVM_INCLUDE_DIRS} ) + link_directories( ${LLVM_LIBRARY_DIRS} ) + + llvm_map_components_to_libraries(REQ_LLVM_LIBRARIES jit native) + + target_link_libraries(mycompiler ${REQ_LLVM_LIBRARIES}) + </pre> + </div> + +<!-- ======================================================================= --> +<h3> + <a name="passdev">Developing LLVM pass out of source</a> +</h3> + +<div> + <p>It is possible to develop LLVM passes against installed LLVM. + An example of project layout provided below:</p> + + <div class="doc_code"> + <pre> + <project dir>/ + | + CMakeLists.txt + <pass name>/ + | + CMakeLists.txt + Pass.cpp + ... + </pre> + </div> + + <p>Contents of <project dir>/CMakeLists.txt:</p> + + <div class="doc_code"> + <pre> + find_package(LLVM) + + <b># Define add_llvm_* macro's.</b> + include(AddLLVM) + + add_definitions(${LLVM_DEFINITIONS}) + include_directories(${LLVM_INCLUDE_DIRS}) + link_directories(${LLVM_LIBRARY_DIRS}) + + add_subdirectory(<pass name>) + </pre> + </div> + + <p>Contents of <project dir>/<pass name>/CMakeLists.txt:</p> + + <div class="doc_code"> + <pre> + add_llvm_loadable_module(LLVMPassname + Pass.cpp + ) + </pre> + </div> + + <p>When you are done developing your pass, you may wish to integrate it + into LLVM source tree. You can achieve it in two easy steps:<br> + 1. Copying <pass name> folder into <LLVM root>/lib/Transform directory.<br> + 2. Adding "add_subdirectory(<pass name>)" line into <LLVM root>/lib/Transform/CMakeLists.txt</p> +</div> <!-- *********************************************************************** --> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="specifics">Compiler/Platform specific topics</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Notes for specific compilers and/or platforms.</p> +<h3> + <a name="msvc">Microsoft Visual C++</a> +</h3> + +<div> + +<dl> + <dt><b>LLVM_COMPILER_JOBS</b>:STRING</dt> + <dd>Specifies the maximum number of parallell compiler jobs to use + per project when building with msbuild or Visual Studio. Only supported for + Visual Studio 2008 and Visual Studio 2010 CMake generators. 0 means use all + processors. Default is 0.</dd> +</dl> + +</div> + </div> <!-- *********************************************************************** --> @@ -462,7 +556,7 @@ src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a> <a href="mailto:ofv@wanadoo.es">Oscar Fuentes</a><br> - <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br> + <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br> Last modified: $Date: 2010-08-09 03:59:36 +0100 (Mon, 9 Aug 2010) $ </address> diff --git a/docs/CodeGenerator.html b/docs/CodeGenerator.html index 925156ff0787..d082acc57dc1 100644 --- a/docs/CodeGenerator.html +++ b/docs/CodeGenerator.html @@ -19,9 +19,9 @@ </head> <body> -<div class="doc_title"> +<h1> The LLVM Target-Independent Code Generator -</div> +</h1> <ol> <li><a href="#introduction">Introduction</a> @@ -127,12 +127,12 @@ </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="introduction">Introduction</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>The LLVM target-independent code generator is a framework that provides a suite of reusable components for translating the LLVM internal representation @@ -188,14 +188,12 @@ depend on the target-description and machine code representation classes, ensuring that it is portable.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="required">Required components in the code generator</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The two pieces of the LLVM code generator are the high-level interface to the code generator and the set of reusable components that can be used to build @@ -223,11 +221,11 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="high-level-design">The high-level design of the code generator</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The LLVM target-independent code generator is designed to support efficient and quality code generation for standard register-based microprocessors. @@ -297,11 +295,11 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="tablegen">Using TableGen for target description</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The target description classes require a detailed description of the target architecture. These target descriptions often have a large amount of common @@ -324,13 +322,15 @@ </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="targetdesc">Target description classes</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>The LLVM target description classes (located in the <tt>include/llvm/Target</tt> directory) provide an abstract description of @@ -346,14 +346,12 @@ <tt><a href="#targetmachine">TargetMachine</a></tt> class provides accessors that should be implemented by the target.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="targetmachine">The <tt>TargetMachine</tt> class</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The <tt>TargetMachine</tt> class provides virtual methods that are used to access the target-specific implementations of the various target description @@ -369,11 +367,11 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="targetdata">The <tt>TargetData</tt> class</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The <tt>TargetData</tt> class is the only required target description class, and it is the only class that is not extensible (you cannot derived a new @@ -385,11 +383,11 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="targetlowering">The <tt>TargetLowering</tt> class</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The <tt>TargetLowering</tt> class is used by SelectionDAG based instruction selectors primarily to describe how LLVM code should be lowered to @@ -411,11 +409,11 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="targetregisterinfo">The <tt>TargetRegisterInfo</tt> class</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The <tt>TargetRegisterInfo</tt> class is used to describe the register file of the target and any interactions between the registers.</p> @@ -445,11 +443,11 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="targetinstrinfo">The <tt>TargetInstrInfo</tt> class</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The <tt>TargetInstrInfo</tt> class is used to describe the machine instructions supported by the target. It is essentially an array of @@ -463,11 +461,11 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="targetframeinfo">The <tt>TargetFrameInfo</tt> class</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The <tt>TargetFrameInfo</tt> class is used to provide information about the stack frame layout of the target. It holds the direction of stack growth, the @@ -479,11 +477,11 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="targetsubtarget">The <tt>TargetSubtarget</tt> class</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The <tt>TargetSubtarget</tt> class is used to provide information about the specific chip set being targeted. A sub-target informs code generation of @@ -495,11 +493,11 @@ <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="targetjitinfo">The <tt>TargetJITInfo</tt> class</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The <tt>TargetJITInfo</tt> class exposes an abstract interface used by the Just-In-Time code generator to perform target-specific activities, such as @@ -509,13 +507,15 @@ </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="codegendesc">Machine code description classes</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>At the high-level, LLVM code is translated to a machine specific representation formed out of @@ -528,14 +528,12 @@ SSA representation for machine code, as well as a register allocated, non-SSA form.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="machineinstr">The <tt>MachineInstr</tt> class</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Target machine instructions are represented as instances of the <tt>MachineInstr</tt> class. This class is an extremely abstract way of @@ -576,14 +574,12 @@ <p>Also if the first operand is a def, it is easier to <a href="#buildmi">create instructions</a> whose only def is the first operand.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="buildmi">Using the <tt>MachineInstrBuilder.h</tt> functions</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>Machine instructions are created by using the <tt>BuildMI</tt> functions, located in the <tt>include/llvm/CodeGen/MachineInstrBuilder.h</tt> file. The @@ -630,11 +626,11 @@ MI.addReg(Reg, RegState::Define); </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="fixedregs">Fixed (preassigned) registers</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>One important issue that the code generator needs to be aware of is the presence of fixed registers. In particular, there are often places in the @@ -702,11 +698,11 @@ ret </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="ssa">Machine code in SSA form</a> -</div> +</h4> -<div class="doc_text"> +<div> <p><tt>MachineInstr</tt>'s are initially selected in SSA-form, and are maintained in SSA-form until register allocation happens. For the most part, @@ -719,12 +715,14 @@ ret </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="machinebasicblock">The <tt>MachineBasicBlock</tt> class</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The <tt>MachineBasicBlock</tt> class contains a list of machine instructions (<tt><a href="#machineinstr">MachineInstr</a></tt> instances). It roughly @@ -737,11 +735,11 @@ ret </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="machinefunction">The <tt>MachineFunction</tt> class</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The <tt>MachineFunction</tt> class contains a list of machine basic blocks (<tt><a href="#machinebasicblock">MachineBasicBlock</a></tt> instances). It @@ -754,14 +752,15 @@ ret </div> +</div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="mc">The "MC" Layer</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> The MC Layer is used to represent and process code at the raw machine code @@ -770,7 +769,7 @@ level, devoid of "high level" information like "constant pools", "jump tables", like label names, machine instructions, and sections in the object file. The code in this layer is used for a number of important purposes: the tail end of the code generator uses it to write a .s or .o file, and it is also used by the -llvm-mc tool to implement standalone machine codeassemblers and disassemblers. +llvm-mc tool to implement standalone machine code assemblers and disassemblers. </p> <p> @@ -779,15 +778,12 @@ of important subsystems that interact at this layer, they are described later in this manual. </p> -</div> - - <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="mcstreamer">The <tt>MCStreamer</tt> API</a> -</div> +</h3> -<div class="doc_text"> +<div> <p> MCStreamer is best thought of as an assembler API. It is an abstract API which @@ -817,11 +813,11 @@ MCObjectStreamer implements a full assembler. </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="mccontext">The <tt>MCContext</tt> class</a> -</div> +</h3> -<div class="doc_text"> +<div> <p> The MCContext class is the owner of a variety of uniqued data structures at the @@ -832,11 +828,11 @@ interact with to create symbols and sections. This class can not be subclassed. </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="mcsymbol">The <tt>MCSymbol</tt> class</a> -</div> +</h3> -<div class="doc_text"> +<div> <p> The MCSymbol class represents a symbol (aka label) in the assembly file. There @@ -864,11 +860,11 @@ like this to the .s file:<p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="mcsection">The <tt>MCSection</tt> class</a> -</div> +</h3> -<div class="doc_text"> +<div> <p> The MCSection class represents an object-file specific section. It is subclassed @@ -882,11 +878,11 @@ directive in a .s file). </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="mcinst">The <tt>MCInst</tt> class</a> -</div> +</h3> -<div class="doc_text"> +<div> <p> The MCInst class is a target-independent representation of an instruction. It @@ -904,27 +900,26 @@ printer, and the type generated by the assembly parser and disassembler. </div> +</div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="codegenalgs">Target-independent code generation algorithms</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>This section documents the phases described in the <a href="#high-level-design">high-level design of the code generator</a>. It explains how they work and some of the rationale behind their design.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="instselect">Instruction Selection</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Instruction Selection is the process of translating LLVM code presented to the code generator into target-specific machine instructions. There are @@ -936,14 +931,12 @@ printer, and the type generated by the assembly parser and disassembler. selector to be generated from these <tt>.td</tt> files, though currently there are still things that require custom C++ code.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="selectiondag_intro">Introduction to SelectionDAGs</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>The SelectionDAG provides an abstraction for code representation in a way that is amenable to instruction selection using automatic techniques @@ -1001,11 +994,11 @@ printer, and the type generated by the assembly parser and disassembler. </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="selectiondag_process">SelectionDAG Instruction Selection Process</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>SelectionDAG-based instruction selection consists of the following steps:</p> @@ -1082,11 +1075,11 @@ printer, and the type generated by the assembly parser and disassembler. </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="selectiondag_build">Initial SelectionDAG Construction</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>The initial SelectionDAG is naïvely peephole expanded from the LLVM input by the <tt>SelectionDAGLowering</tt> class in the @@ -1102,11 +1095,11 @@ printer, and the type generated by the assembly parser and disassembler. </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="selectiondag_legalize_types">SelectionDAG LegalizeTypes Phase</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>The Legalize phase is in charge of converting a DAG to only use the types that are natively supported by the target.</p> @@ -1135,11 +1128,11 @@ printer, and the type generated by the assembly parser and disassembler. </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="selectiondag_legalize">SelectionDAG Legalize Phase</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>The Legalize phase is in charge of converting a DAG to only use the operations that are natively supported by the target.</p> @@ -1167,12 +1160,13 @@ printer, and the type generated by the assembly parser and disassembler. </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> - <a name="selectiondag_optimize">SelectionDAG Optimization Phase: the DAG - Combiner</a> -</div> +<h4> + <a name="selectiondag_optimize"> + SelectionDAG Optimization Phase: the DAG Combiner + </a> +</h4> -<div class="doc_text"> +<div> <p>The SelectionDAG optimization phase is run multiple times for code generation, immediately after the DAG is built and once after each @@ -1202,11 +1196,11 @@ printer, and the type generated by the assembly parser and disassembler. </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="selectiondag_select">SelectionDAG Select Phase</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>The Select phase is the bulk of the target-specific code for instruction selection. This phase takes a legal SelectionDAG as input, pattern matches @@ -1363,11 +1357,11 @@ def : Pat<(i32 imm:$imm), </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="selectiondag_sched">SelectionDAG Scheduling and Formation Phase</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>The scheduling phase takes the DAG of target instructions from the selection phase and assigns an order. The scheduler can pick an order depending on @@ -1384,11 +1378,11 @@ def : Pat<(i32 imm:$imm), </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="selectiondag_future">Future directions for the SelectionDAG</a> -</div> +</h4> -<div class="doc_text"> +<div> <ol> <li>Optional function-at-a-time selection.</li> @@ -1398,18 +1392,20 @@ def : Pat<(i32 imm:$imm), </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="ssamco">SSA-based Machine Code Optimizations</a> -</div> -<div class="doc_text"><p>To Be Written</p></div> +</h3> +<div><p>To Be Written</p></div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="liveintervals">Live Intervals</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Live Intervals are the ranges (intervals) where a variable is <i>live</i>. They are used by some <a href="#regalloc">register allocator</a> passes to @@ -1417,14 +1413,12 @@ def : Pat<(i32 imm:$imm), register are live at the same point in the program (i.e., they conflict). When this situation occurs, one virtual register must be <i>spilled</i>.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="livevariable_analysis">Live Variable Analysis</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>The first step in determining the live intervals of variables is to calculate the set of registers that are immediately dead after the instruction (i.e., @@ -1466,11 +1460,11 @@ def : Pat<(i32 imm:$imm), </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="liveintervals_analysis">Live Intervals Analysis</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>We now have the information available to perform the live intervals analysis and build the live intervals themselves. We start off by numbering the basic @@ -1485,12 +1479,14 @@ def : Pat<(i32 imm:$imm), </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="regalloc">Register Allocation</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The <i>Register Allocation problem</i> consists in mapping a program <i>P<sub>v</sub></i>, that can use an unbounded number of virtual registers, @@ -1500,15 +1496,13 @@ def : Pat<(i32 imm:$imm), accommodate all the virtual registers, some of them will have to be mapped into memory. These virtuals are called <i>spilled virtuals</i>.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="regAlloc_represent">How registers are represented in LLVM</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>In LLVM, physical registers are denoted by integer numbers that normally range from 1 to 1023. To see how this numbering is defined for a particular @@ -1617,11 +1611,11 @@ bool RegMapping_Fer::compatible_class(MachineFunction &mf, <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="regAlloc_howTo">Mapping virtual registers to physical registers</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>There are two ways to map virtual registers to physical registers (or to memory slots). The first way, that we will call <i>direct mapping</i>, is @@ -1667,11 +1661,11 @@ bool RegMapping_Fer::compatible_class(MachineFunction &mf, </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="regAlloc_twoAddr">Handling two address instructions</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>With very rare exceptions (e.g., function calls), the LLVM machine code instructions are three address instructions. That is, each instruction is @@ -1703,11 +1697,11 @@ bool RegMapping_Fer::compatible_class(MachineFunction &mf, </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="regAlloc_ssaDecon">The SSA deconstruction phase</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>An important transformation that happens during register allocation is called the <i>SSA Deconstruction Phase</i>. The SSA form simplifies many analyses @@ -1727,11 +1721,11 @@ bool RegMapping_Fer::compatible_class(MachineFunction &mf, </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="regAlloc_fold">Instruction folding</a> -</div> +</h4> -<div class="doc_text"> +<div> <p><i>Instruction folding</i> is an optimization performed during register allocation that removes unnecessary copy instructions. For instance, a @@ -1764,11 +1758,11 @@ bool RegMapping_Fer::compatible_class(MachineFunction &mf, <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="regAlloc_builtIn">Built in register allocators</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>The LLVM infrastructure provides the application developer with three different register allocators:</p> @@ -1805,23 +1799,25 @@ $ llc -regalloc=pbqp file.bc -o pbqp.s; </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="proepicode">Prolog/Epilog Code Insertion</a> -</div> -<div class="doc_text"><p>To Be Written</p></div> +</h3> +<div><p>To Be Written</p></div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="latemco">Late Machine Code Optimizations</a> -</div> -<div class="doc_text"><p>To Be Written</p></div> +</h3> +<div><p>To Be Written</p></div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="codeemit">Code Emission</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The code emission step of code generation is responsible for lowering from the code generator abstractions (like <a @@ -1880,14 +1876,15 @@ to implement an assembler for your target.</p> </div> +</div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="nativeassembler">Implementing a Native Assembler</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Though you're probably reading this because you want to write or maintain a compiler backend, LLVM also fully supports building a native assemblers too. @@ -1896,20 +1893,18 @@ We've tried hard to automate the generation of the assembler from the .td files part of the manual and repetitive data entry can be factored and shared with the compiler.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection" id="na_instparsing">Instruction Parsing</div> +<h3 id="na_instparsing">Instruction Parsing</h3> -<div class="doc_text"><p>To Be Written</p></div> +<div><p>To Be Written</p></div> <!-- ======================================================================= --> -<div class="doc_subsection" id="na_instaliases"> +<h3 id="na_instaliases"> Instruction Alias Processing -</div> +</h3> -<div class="doc_text"> +<div> <p>Once the instruction is parsed, it enters the MatchInstructionImpl function. The MatchInstructionImpl function performs alias processing and then does actual matching.</p> @@ -1922,12 +1917,10 @@ complex/powerful). Generally you want to use the first alias mechanism that meets the needs of your instruction, because it will allow a more concise description.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection">Mnemonic Aliases</div> +<h4>Mnemonic Aliases</h4> -<div class="doc_text"> +<div> <p>The first phase of alias processing is simple instruction mnemonic remapping for classes of instructions which are allowed with two different @@ -1965,9 +1958,9 @@ on the current instruction set.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection">Instruction Aliases</div> +<h4>Instruction Aliases</h4> -<div class="doc_text"> +<div> <p>The most general phase of alias processing occurs while matching is happening: it provides new forms for the matcher to match along with a specific @@ -2028,36 +2021,33 @@ subtarget specific.</p> </div> - +</div> <!-- ======================================================================= --> -<div class="doc_subsection" id="na_matching">Instruction Matching</div> - -<div class="doc_text"><p>To Be Written</p></div> - +<h3 id="na_matching">Instruction Matching</h3> +<div><p>To Be Written</p></div> +</div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="targetimpls">Target-specific Implementation Notes</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>This section of the document explains features or design decisions that are specific to the code generator for a particular target. First we start with a table that summarizes what features are supported by each target.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="targetfeatures">Target Feature Matrix</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Note that this table does not include the C backend or Cpp backends, since they do not use the target independent code generator infrastructure. It also @@ -2228,12 +2218,10 @@ is the key:</p> </table> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection" id="feat_reliable">Is Generally Reliable</div> +<h4 id="feat_reliable">Is Generally Reliable</h4> -<div class="doc_text"> +<div> <p>This box indicates whether the target is considered to be production quality. This indicates that the target has been used as a static compiler to compile large amounts of code by a variety of different people and is in @@ -2241,9 +2229,9 @@ continuous use.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection" id="feat_asmparser">Assembly Parser</div> +<h4 id="feat_asmparser">Assembly Parser</h4> -<div class="doc_text"> +<div> <p>This box indicates whether the target supports parsing target specific .s files by implementing the MCAsmParser interface. This is required for llvm-mc to be able to act as a native assembler and is required for inline assembly @@ -2253,18 +2241,18 @@ support in the native .o file writer.</p> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection" id="feat_disassembler">Disassembler</div> +<h4 id="feat_disassembler">Disassembler</h4> -<div class="doc_text"> +<div> <p>This box indicates whether the target supports the MCDisassembler API for disassembling machine opcode bytes into MCInst's.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection" id="feat_inlineasm">Inline Asm</div> +<h4 id="feat_inlineasm">Inline Asm</h4> -<div class="doc_text"> +<div> <p>This box indicates whether the target supports most popular inline assembly constraints and modifiers.</p> @@ -2274,9 +2262,9 @@ constraints relating to the X86 floating point stack.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection" id="feat_jit">JIT Support</div> +<h4 id="feat_jit">JIT Support</h4> -<div class="doc_text"> +<div> <p>This box indicates whether the target supports the JIT compiler through the ExecutionEngine interface.</p> @@ -2286,9 +2274,9 @@ in ARM codegen mode, but lacks NEON and full Thumb support.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection" id="feat_objectwrite">.o File Writing</div> +<h4 id="feat_objectwrite">.o File Writing</h4> -<div class="doc_text"> +<div> <p>This box indicates whether the target supports writing .o files (e.g. MachO, ELF, and/or COFF) files directly from the target. Note that the target also @@ -2302,9 +2290,9 @@ file to a .o file (as is the case for many C compilers).</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection" id="feat_tailcall">Tail Calls</div> +<h4 id="feat_tailcall">Tail Calls</h4> -<div class="doc_text"> +<div> <p>This box indicates whether the target supports guaranteed tail calls. These are calls marked "<a href="LangRef.html#i_call">tail</a>" and use the fastcc @@ -2313,15 +2301,14 @@ more more details</a>.</p> </div> - - +</div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="tailcallopt">Tail call optimization</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Tail call optimization, callee reusing the stack of the caller, is currently supported on x86/x86-64 and PowerPC. It is performed if:</p> @@ -2383,11 +2370,11 @@ define fastcc i32 @tailcaller(i32 %in1, i32 %in2) { </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="sibcallopt">Sibling call optimization</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Sibling call optimization is a restricted form of tail call optimization. Unlike tail call optimization described in the previous section, it can be @@ -2427,24 +2414,22 @@ entry: </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="x86">The X86 backend</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The X86 code generator lives in the <tt>lib/Target/X86</tt> directory. This code generator is capable of targeting a variety of x86-32 and x86-64 processors, and includes support for ISA extensions such as MMX and SSE.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="x86_tt">X86 Target Triples supported</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>The following are the known target triples that are supported by the X86 backend. This is not an exhaustive list, and it would be useful to add those @@ -2469,12 +2454,12 @@ entry: </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="x86_cc">X86 Calling Conventions supported</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>The following target-specific calling conventions are known to backend:</p> @@ -2489,11 +2474,11 @@ entry: </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="x86_memory">Representing X86 addressing modes in MachineInstrs</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>The x86 has a very flexible way of accessing memory. It is capable of forming memory addresses of the following expression directly in integer @@ -2526,13 +2511,13 @@ OperandTy: VirtReg, | VirtReg, UnsImm, VirtReg, SignExtImm PhysReg </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="x86_memory">X86 address spaces supported</a> -</div> +</h4> -<div class="doc_text"> +<div> -<p>x86 has an experimental feature which provides +<p>x86 has a feature which provides the ability to perform loads and stores to different address spaces via the x86 segment registers. A segment override prefix byte on an instruction causes the instruction's memory access to go to the specified @@ -2571,11 +2556,11 @@ OperandTy: VirtReg, | VirtReg, UnsImm, VirtReg, SignExtImm PhysReg </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="x86_names">Instruction naming</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>An instruction name consists of the base name, a default operand size, and a a character per operand with an optional special size. For example:</p> @@ -2591,25 +2576,25 @@ MOVSX32rm16 -> movsx, 32-bit register, 16-bit memory </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="ppc">The PowerPC backend</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The PowerPC code generator lives in the lib/Target/PowerPC directory. The code generation is retargetable to several variations or <i>subtargets</i> of the PowerPC ISA; including ppc32, ppc64 and altivec.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="ppc_abi">LLVM PowerPC ABI</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>LLVM follows the AIX PowerPC ABI, with two deviations. LLVM uses a PC relative (PIC) or static addressing for accessing global values, so no TOC @@ -2625,11 +2610,11 @@ MOVSX32rm16 -> movsx, 32-bit register, 16-bit memory </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="ppc_frame">Frame Layout</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>The size of a PowerPC frame is usually fixed for the duration of a function's invocation. Since the frame is fixed size, all references @@ -2772,11 +2757,11 @@ MOVSX32rm16 -> movsx, 32-bit register, 16-bit memory </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="ppc_prolog">Prolog/Epilog</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>The llvm prolog and epilog are the same as described in the PowerPC ABI, with the following exceptions. Callee saved registers are spilled after the frame @@ -2789,16 +2774,19 @@ MOVSX32rm16 -> movsx, 32-bit register, 16-bit memory </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="ppc_dynamic">Dynamic Allocation</a> -</div> +</h4> -<div class="doc_text"> +<div> <p><i>TODO - More to come.</i></p> </div> +</div> + +</div> <!-- *********************************************************************** --> <hr> @@ -2809,8 +2797,8 @@ MOVSX32rm16 -> movsx, 32-bit register, 16-bit memory src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a> <a href="mailto:sabre@nondot.org">Chris Lattner</a><br> - <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br> - Last modified: $Date: 2011-01-09 00:10:59 +0100 (Sun, 09 Jan 2011) $ + <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br> + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> diff --git a/docs/CodingStandards.html b/docs/CodingStandards.html index 4a9ab7d857a8..139bbdb24902 100644 --- a/docs/CodingStandards.html +++ b/docs/CodingStandards.html @@ -7,9 +7,9 @@ </head> <body> -<div class="doc_title"> +<h1> LLVM Coding Standards -</div> +</h1> <ol> <li><a href="#introduction">Introduction</a></li> @@ -83,12 +83,12 @@ <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="introduction">Introduction</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>This document attempts to describe a few coding standards that are being used in the LLVM source tree. Although no coding standards should be regarded as @@ -117,22 +117,26 @@ href="mailto:sabre@nondot.org">Chris</a>.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="mechanicalissues">Mechanical Source Issues</a> -</div> +</h2> <!-- *********************************************************************** --> +<div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="sourceformating">Source Code Formatting</a> -</div> +</h3> + +<div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="scf_commenting">Commenting</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>Comments are one critical part of readability and maintainability. Everyone knows they should comment, so should you. When writing comments, write them as @@ -141,7 +145,9 @@ etc. Although we all should probably comment our code more than we do, there are a few very critical places that documentation is very useful:</p> -<b>File Headers</b> +<h5>File Headers</h5> + +<div> <p>Every source file should have a header on it that describes the basic purpose of the file. If a file does not have a header, it should not be @@ -184,7 +190,9 @@ Here it's only two lines. If an algorithm is being implemented or something tricky is going on, a reference to the paper where it is published should be included, as well as any notes or "gotchas" in the code to watch out for.</p> -<b>Class overviews</b> +</div> + +<h5>Class overviews</h5> <p>Classes are one fundamental part of a good object oriented design. As such, a class definition should have a comment block that explains what the class is @@ -193,7 +201,9 @@ could figure it out, it's probably safe to leave it out. Naming classes something sane goes a long ways towards avoiding writing documentation.</p> -<b>Method information</b> +<h5>Method information</h5> + +<div> <p>Methods defined in a class (as well as any global functions) should also be documented properly. A quick note about what it does and a description of the @@ -207,12 +217,14 @@ happens: does the method return null? Abort? Format your hard disk?</p> </div> +</div> + <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="scf_commentformat">Comment Formatting</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>In general, prefer C++ style (<tt>//</tt>) comments. They take less space, require less typing, don't have nesting problems, etc. There are a few cases @@ -233,11 +245,11 @@ These nest properly and are better behaved in general than C style comments.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="scf_includes"><tt>#include</tt> Style</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>Immediately after the <a href="#scf_commenting">header file comment</a> (and include guards if working on a header file), the <a @@ -273,11 +285,11 @@ implements are defined.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="scf_codewidth">Source Code Width</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>Write your code to fit within 80 columns of text. This helps those of us who like to print out code and look at your code in an xterm without resizing @@ -298,11 +310,11 @@ for debate.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="scf_spacestabs">Use Spaces Instead of Tabs</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>In all cases, prefer spaces to tabs in source files. People have different preferred indentation levels, and different styles of indentation that they @@ -319,11 +331,11 @@ makes for incredible diffs that are absolutely worthless.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="scf_indentation">Indent Code Consistently</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>Okay, in your first year of programming you were told that indentation is important. If you didn't believe and internalize this then, now is the time. @@ -331,19 +343,21 @@ Just do it.</p> </div> +</div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="compilerissues">Compiler Issues</a> -</div> +</h3> +<div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="ci_warningerrors">Treat Compiler Warnings Like Errors</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>If your code has compiler warnings in it, something is wrong — you aren't casting values correctly, your have "questionable" constructs in your @@ -393,11 +407,11 @@ be fixed by massaging the code appropriately.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="ci_portable_code">Write Portable Code</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>In almost all cases, it is possible and within reason to write completely portable code. If there are cases where it isn't possible to write portable @@ -412,10 +426,10 @@ libSystem.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="ci_rtti_exceptions">Do not use RTTI or Exceptions</a> -</div> -<div class="doc_text"> +</h4> +<div> <p>In an effort to reduce code and executable size, LLVM does not use RTTI (e.g. <tt>dynamic_cast<></tt>) or exceptions. These two language features @@ -433,10 +447,10 @@ than <tt>dynamic_cast<></tt>.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="ci_class_struct">Use of <tt>class</tt> and <tt>struct</tt> Keywords</a> -</div> -<div class="doc_text"> +</h4> +<div> <p>In C++, the <tt>class</tt> and <tt>struct</tt> keywords can be used almost interchangeably. The only difference is when they are used to declare a class: @@ -454,26 +468,32 @@ which case <tt>struct</tt> is allowed.</p> </div> +</div> + +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="styleissues">Style Issues</a> -</div> +</h2> <!-- *********************************************************************** --> +<div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="macro">The High-Level Issues</a> -</div> +</h3> <!-- ======================================================================= --> +<div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="hl_module">A Public Header File <b>is</b> a Module</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>C++ doesn't do too well in the modularity department. There is no real encapsulation or data hiding (unless you use expensive protocol classes), but it @@ -499,11 +519,11 @@ translation unit.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="hl_dontinclude"><tt>#include</tt> as Little as Possible</a> -</div> +</h4> -<div class="doc_text"> +<div> <p><tt>#include</tt> hurts compile time performance. Don't do it unless you have to, especially in header files.</p> @@ -528,11 +548,11 @@ dependencies that you'll find out about later.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="hl_privateheaders">Keep "Internal" Headers Private</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>Many modules have a complex implementation that causes them to use more than one implementation (<tt>.cpp</tt>) file. It is often tempting to put the @@ -549,11 +569,11 @@ class itself. Just make them private (or protected) and all is well.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="hl_earlyexit">Use Early Exits and <tt>continue</tt> to Simplify Code</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>When reading code, keep in mind how much state and how many previous decisions have to be remembered by the reader to understand a block of code. @@ -658,11 +678,11 @@ can be a big understandability win.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="hl_else_after_return">Don't use <tt>else</tt> after a <tt>return</tt></a> -</div> +</h4> -<div class="doc_text"> +<div> <p>For similar reasons above (reduction of indentation and easier reading), please do not use '<tt>else</tt>' or '<tt>else if</tt>' after something that @@ -741,11 +761,11 @@ track of when reading the code.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="hl_predicateloops">Turn Predicate Loops into Predicate Functions</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>It is very common to write small loops that just compute a boolean value. There are a number of ways that people commonly write these, but an example of @@ -802,20 +822,24 @@ locality.</p> </div> +</div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="micro">The Low-Level Issues</a> -</div> +</h3> <!-- ======================================================================= --> +<div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> - <a name="ll_naming">Name Types, Functions, Variables, and Enumerators Properly</a> -</div> +<h4> + <a name="ll_naming"> + Name Types, Functions, Variables, and Enumerators Properly + </a> +</h4> -<div class="doc_text"> +<div> <p>Poorly-chosen names can mislead the reader and cause bugs. We cannot stress enough how important it is to use <em>descriptive</em> names. Pick names that @@ -894,11 +918,11 @@ Vehicle MakeVehicle(VehicleType Type) { <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="ll_assert">Assert Liberally</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>Use the "<tt>assert</tt>" macro to its fullest. Check all of your preconditions and assumptions, you never know when a bug (not necessarily even @@ -997,11 +1021,11 @@ assert(NewToSet && "The value shouldn't be in the set yet"); </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="ll_ns_std">Do Not Use '<tt>using namespace std</tt>'</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>In LLVM, we prefer to explicitly prefix all identifiers from the standard namespace with an "<tt>std::</tt>" prefix, rather than rely on @@ -1035,12 +1059,13 @@ use any others.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> - <a name="ll_virtual_anch">Provide a Virtual Method Anchor for Classes - in Headers</a> -</div> +<h4> + <a name="ll_virtual_anch"> + Provide a Virtual Method Anchor for Classes in Headers + </a> +</h4> -<div class="doc_text"> +<div> <p>If a class is defined in a header file and has a v-table (either it has virtual methods or it derives from classes with virtual methods), it must @@ -1052,11 +1077,11 @@ increasing link times.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="ll_end">Don't evaluate <tt>end()</tt> every time through a loop</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>Because C++ doesn't have a standard "<tt>foreach</tt>" loop (though it can be emulated with macros and may be coming in C++'0x) we end up writing a lot of @@ -1114,11 +1139,11 @@ prefer it.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="ll_iostream"><tt>#include <iostream></tt> is Forbidden</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>The use of <tt>#include <iostream></tt> in library files is hereby <b><em>forbidden</em></b>. The primary reason for doing this is to @@ -1149,11 +1174,11 @@ the <tt>llvm::MemoryBuffer</tt> API for reading files.</b></p> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="ll_raw_ostream">Use <tt>raw_ostream</tt></a> -</div> +</h4> -<div class="doc_text"> +<div> <p>LLVM includes a lightweight, simple, and efficient stream implementation in <tt>llvm/Support/raw_ostream.h</tt>, which provides all of the common @@ -1169,11 +1194,11 @@ declarations and constant references to <tt>raw_ostream</tt> instances.</p> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="ll_avoidendl">Avoid <tt>std::endl</tt></a> -</div> +</h4> -<div class="doc_text"> +<div> <p>The <tt>std::endl</tt> modifier, when used with <tt>iostreams</tt> outputs a newline to the output stream specified. In addition to doing this, however, it @@ -1191,22 +1216,25 @@ it's better to use a literal <tt>'\n'</tt>.</p> </div> +</div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="nano">Microscopic Details</a> -</div> +</h3> <!-- ======================================================================= --> +<div> + <p>This section describes preferred low-level formatting guidelines along with reasoning on why we prefer them.</p> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="micro_spaceparen">Spaces Before Parentheses</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>We prefer to put a space before an open parenthesis only in control flow statements, but not in normal function call expressions and function-like @@ -1260,11 +1288,11 @@ this misinterpretation.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="micro_preincrement">Prefer Preincrement</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>Hard fast rule: Preincrement (<tt>++X</tt>) may be no slower than postincrement (<tt>X++</tt>) and could very well be a lot faster than it. Use @@ -1280,11 +1308,11 @@ get in the habit of always using preincrement, and you won't have a problem.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="micro_namespaceindent">Namespace Indentation</a> -</div> +</h4> -<div class="doc_text"> +<div> <p> In general, we strive to reduce indentation wherever possible. This is useful @@ -1368,11 +1396,11 @@ the contents of the namespace.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="micro_anonns">Anonymous Namespaces</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>After talking about namespaces in general, you may be wondering about anonymous namespaces in particular. @@ -1452,15 +1480,17 @@ namespace just because it was declared there. </div> +</div> +</div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="seealso">See Also</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>A lot of these comments and recommendations have been culled for other sources. Two particularly important books for our work are:</p> @@ -1491,8 +1521,8 @@ something.</p> src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a> <a href="mailto:sabre@nondot.org">Chris Lattner</a><br> - <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br> - Last modified: $Date: 2011-02-20 03:03:04 +0100 (Sun, 20 Feb 2011) $ + <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br> + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> diff --git a/docs/CommandGuide/FileCheck.pod b/docs/CommandGuide/FileCheck.pod index 3ccaa63e176b..dbd626c7cb7f 100644 --- a/docs/CommandGuide/FileCheck.pod +++ b/docs/CommandGuide/FileCheck.pod @@ -240,6 +240,6 @@ define two separate CHECK lines that match on the same line. =head1 AUTHORS -Maintained by The LLVM Team (L<http://llvm.org>). +Maintained by The LLVM Team (L<http://llvm.org/>). =cut diff --git a/docs/CommandGuide/bugpoint.pod b/docs/CommandGuide/bugpoint.pod index 1870a0d84b60..31db62fe2d6b 100644 --- a/docs/CommandGuide/bugpoint.pod +++ b/docs/CommandGuide/bugpoint.pod @@ -21,7 +21,7 @@ distribution. =head1 OPTIONS -=over +=over =item B<--additional-so> F<library> @@ -87,7 +87,7 @@ mis-management. =item B<-find-bugs> Continually randomize the specified passes and run them on the test program -until a bug is found or the user kills B<bugpoint>. +until a bug is found or the user kills B<bugpoint>. =item B<-help> @@ -147,6 +147,21 @@ This option defines the command to use with the B<--run-custom> and B<--safe-custom> options to execute the bitcode testcase. This can be useful for cross-compilation. +=item B<--compile-command> I<command> + +This option defines the command to use with the B<--compile-custom> +option to compile the bitcode testcase. This can be useful for +testing compiler output without running any link or execute stages. To +generate a reduced unit test, you may add CHECK directives to the +testcase and pass the name of an executable compile-command script in this form: + + #!/bin/sh + llc "$@" + not FileCheck [bugpoint input file].ll < bugpoint-test-program.s + +This script will "fail" as long as FileCheck passes. So the result +will be the minimum bitcode that passes FileCheck. + =item B<--safe-path> I<path> This option defines the path to the command to execute with the @@ -166,6 +181,6 @@ L<opt|opt> =head1 AUTHOR -Maintained by the LLVM Team (L<http://llvm.org>). +Maintained by the LLVM Team (L<http://llvm.org/>). =cut diff --git a/docs/CommandGuide/index.html b/docs/CommandGuide/index.html index 3c1a9f9ed4f0..cb5438f58baa 100644 --- a/docs/CommandGuide/index.html +++ b/docs/CommandGuide/index.html @@ -3,15 +3,15 @@ <html> <head> <title>LLVM Command Guide</title> - <link rel="stylesheet" href="/docs/llvm.css" type="text/css"> + <link rel="stylesheet" href="../llvm.css" type="text/css"> </head> <body> -<div class="doc_title"> +<h1> LLVM Command Guide -</div> +</h1> -<div class="doc_text"> +<div> <p>These documents are HTML versions of the <a href="man/man1/">man pages</a> for all of the LLVM tools. These pages describe how to use the LLVM commands @@ -23,12 +23,12 @@ options) arguments to the tool you are interested in.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="basic">Basic Commands</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <ul> @@ -80,12 +80,12 @@ options) arguments to the tool you are interested in.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="frontend">C and C++ Front-end Commands</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <ul> <li><a href="/cmds/llvmgcc.html"><b>llvm-gcc</b></a> - @@ -99,13 +99,13 @@ options) arguments to the tool you are interested in.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="debug">Debugging Tools</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <ul> @@ -123,12 +123,12 @@ options) arguments to the tool you are interested in.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="internal">Internal Tools</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <ul> <li><a href="/cmds/FileCheck.html"><b>FileCheck</b></a> - @@ -150,8 +150,8 @@ options) arguments to the tool you are interested in.</p> <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: 2010-09-08 01:10:21 +0200 (Wed, 08 Sep 2010) $ + <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br> + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> diff --git a/docs/CommandGuide/lit.pod b/docs/CommandGuide/lit.pod index 989a5d7acb51..faf4811dd18c 100644 --- a/docs/CommandGuide/lit.pod +++ b/docs/CommandGuide/lit.pod @@ -349,6 +349,6 @@ L<valgrind(1)> =head1 AUTHOR -Written by Daniel Dunbar and maintained by the LLVM Team (L<http://llvm.org>). +Written by Daniel Dunbar and maintained by the LLVM Team (L<http://llvm.org/>). =cut diff --git a/docs/CommandGuide/llc.pod b/docs/CommandGuide/llc.pod index eb26ec00fd76..50b45c8d5a2a 100644 --- a/docs/CommandGuide/llc.pod +++ b/docs/CommandGuide/llc.pod @@ -196,6 +196,6 @@ L<lli|lli> =head1 AUTHORS -Maintained by the LLVM Team (L<http://llvm.org>). +Maintained by the LLVM Team (L<http://llvm.org/>). =cut diff --git a/docs/CommandGuide/lli.pod b/docs/CommandGuide/lli.pod index 52a2721e7d70..a313a31718c4 100644 --- a/docs/CommandGuide/lli.pod +++ b/docs/CommandGuide/lli.pod @@ -214,6 +214,6 @@ L<llc|llc> =head1 AUTHOR -Maintained by the LLVM Team (L<http://llvm.org>). +Maintained by the LLVM Team (L<http://llvm.org/>). =cut diff --git a/docs/CommandGuide/llvm-ar.pod b/docs/CommandGuide/llvm-ar.pod index 63ba43f6f6f8..a8f01b0319a0 100644 --- a/docs/CommandGuide/llvm-ar.pod +++ b/docs/CommandGuide/llvm-ar.pod @@ -401,6 +401,6 @@ L<llvm-ranlib|llvm-ranlib>, ar(1) =head1 AUTHORS -Maintained by the LLVM Team (L<http://llvm.org>). +Maintained by the LLVM Team (L<http://llvm.org/>). =cut diff --git a/docs/CommandGuide/llvm-as.pod b/docs/CommandGuide/llvm-as.pod index 185c009698f3..cc8188708a53 100644 --- a/docs/CommandGuide/llvm-as.pod +++ b/docs/CommandGuide/llvm-as.pod @@ -72,6 +72,6 @@ L<llvm-dis|llvm-dis>, L<gccas|gccas> =head1 AUTHORS -Maintained by the LLVM Team (L<http://llvm.org>). +Maintained by the LLVM Team (L<http://llvm.org/>). =cut diff --git a/docs/CommandGuide/llvm-bcanalyzer.pod b/docs/CommandGuide/llvm-bcanalyzer.pod index b0bc0cddba82..9c5021b639f1 100644 --- a/docs/CommandGuide/llvm-bcanalyzer.pod +++ b/docs/CommandGuide/llvm-bcanalyzer.pod @@ -268,7 +268,7 @@ The number of bytes consumed by instructions in the function. =item B<Average Instruction Size> -The average number of bytes consumed by the instructions in the funtion. This +The average number of bytes consumed by the instructions in the function. This value is computed by dividing Instruction Size by Instructions. =item B<Bytes Per Instruction> @@ -310,6 +310,6 @@ L<llvm-dis|llvm-dis>, L<http://llvm.org/docs/BitCodeFormat.html> =head1 AUTHORS -Maintained by the LLVM Team (L<http://llvm.org>). +Maintained by the LLVM Team (L<http://llvm.org/>). =cut diff --git a/docs/CommandGuide/llvm-config.pod b/docs/CommandGuide/llvm-config.pod index 4e38dae3df63..7d68564a6d75 100644 --- a/docs/CommandGuide/llvm-config.pod +++ b/docs/CommandGuide/llvm-config.pod @@ -126,6 +126,6 @@ occurs, it will exit with a non-zero value. =head1 AUTHORS -Maintained by the LLVM Team (L<http://llvm.org>). +Maintained by the LLVM Team (L<http://llvm.org/>). =cut diff --git a/docs/CommandGuide/llvm-diff.pod b/docs/CommandGuide/llvm-diff.pod index c8cfdb3be94d..ffe0b4896fdd 100644 --- a/docs/CommandGuide/llvm-diff.pod +++ b/docs/CommandGuide/llvm-diff.pod @@ -48,6 +48,6 @@ massive detected differences in blocks. =head1 AUTHORS -Maintained by the LLVM Team (L<http://llvm.org>). +Maintained by the LLVM Team (L<http://llvm.org/>). =cut diff --git a/docs/CommandGuide/llvm-dis.pod b/docs/CommandGuide/llvm-dis.pod index 5b2f4ef4e924..9f4026c27fe7 100644 --- a/docs/CommandGuide/llvm-dis.pod +++ b/docs/CommandGuide/llvm-dis.pod @@ -55,6 +55,6 @@ L<llvm-as|llvm-as> =head1 AUTHORS -Maintained by the LLVM Team (L<http://llvm.org>). +Maintained by the LLVM Team (L<http://llvm.org/>). =cut diff --git a/docs/CommandGuide/llvm-extract.pod b/docs/CommandGuide/llvm-extract.pod index d4baab73991a..797e79d128d4 100644 --- a/docs/CommandGuide/llvm-extract.pod +++ b/docs/CommandGuide/llvm-extract.pod @@ -68,6 +68,6 @@ L<bugpoint|bugpoint> =head1 AUTHORS -Maintained by the LLVM Team (L<http://llvm.org>). +Maintained by the LLVM Team (L<http://llvm.org/>). =cut diff --git a/docs/CommandGuide/llvm-ld.pod b/docs/CommandGuide/llvm-ld.pod index 536ab0fa43d5..efa9ebd06c53 100644 --- a/docs/CommandGuide/llvm-ld.pod +++ b/docs/CommandGuide/llvm-ld.pod @@ -229,6 +229,6 @@ L<llvm-link|llvm-link> =head1 AUTHORS -Maintained by the LLVM Team (L<http://llvm.org>). +Maintained by the LLVM Team (L<http://llvm.org/>). =cut diff --git a/docs/CommandGuide/llvm-link.pod b/docs/CommandGuide/llvm-link.pod index 8d06cc9d9d9f..1e466a56f4ec 100644 --- a/docs/CommandGuide/llvm-link.pod +++ b/docs/CommandGuide/llvm-link.pod @@ -74,6 +74,6 @@ L<gccld|gccld> =head1 AUTHORS -Maintained by the LLVM Team (L<http://llvm.org>). +Maintained by the LLVM Team (L<http://llvm.org/>). =cut diff --git a/docs/CommandGuide/llvm-nm.pod b/docs/CommandGuide/llvm-nm.pod index a580d3f5ca70..a6dc4901dd61 100644 --- a/docs/CommandGuide/llvm-nm.pod +++ b/docs/CommandGuide/llvm-nm.pod @@ -117,6 +117,6 @@ L<llvm-dis|llvm-dis>, ar(1), nm(1) =head1 AUTHOR -Maintained by the LLVM Team (L<http://llvm.org>). +Maintained by the LLVM Team (L<http://llvm.org/>). =cut diff --git a/docs/CommandGuide/llvm-prof.pod b/docs/CommandGuide/llvm-prof.pod index 9541b05dcafc..4b2e09d70470 100644 --- a/docs/CommandGuide/llvm-prof.pod +++ b/docs/CommandGuide/llvm-prof.pod @@ -52,6 +52,6 @@ information. Otherwise, it exits with zero. =head1 AUTHOR -B<llvm-prof> is maintained by the LLVM Team (L<http://llvm.org>). +B<llvm-prof> is maintained by the LLVM Team (L<http://llvm.org/>). =cut diff --git a/docs/CommandGuide/llvm-ranlib.pod b/docs/CommandGuide/llvm-ranlib.pod index 53cd34bbb5c4..431bc551048a 100644 --- a/docs/CommandGuide/llvm-ranlib.pod +++ b/docs/CommandGuide/llvm-ranlib.pod @@ -47,6 +47,6 @@ L<llvm-ar|llvm-ar>, ranlib(1) =head1 AUTHORS -Maintained by the LLVM Team (L<http://llvm.org>). +Maintained by the LLVM Team (L<http://llvm.org/>). =cut diff --git a/docs/CommandGuide/llvmc.pod b/docs/CommandGuide/llvmc.pod index d237ca4c14fa..95a9e5ef3611 100644 --- a/docs/CommandGuide/llvmc.pod +++ b/docs/CommandGuide/llvmc.pod @@ -185,6 +185,6 @@ L<llvm-dis|llvm-dis>, L<llc|llc>, L<llvm-link|llvm-link> =head1 AUTHORS -Maintained by the LLVM Team (L<http://llvm.org>). +Maintained by the LLVM Team (L<http://llvm.org/>). =cut diff --git a/docs/CommandGuide/llvmgcc.pod b/docs/CommandGuide/llvmgcc.pod index 9892ca71861e..30af0a06e06f 100644 --- a/docs/CommandGuide/llvmgcc.pod +++ b/docs/CommandGuide/llvmgcc.pod @@ -70,7 +70,7 @@ L<llvm-g++|llvmgxx> =head1 AUTHORS -Maintained by the LLVM Team (L<http://llvm.org>). +Maintained by the LLVM Team (L<http://llvm.org/>). =cut diff --git a/docs/CommandGuide/llvmgxx.pod b/docs/CommandGuide/llvmgxx.pod index 64b670ebe069..1ea3d4967006 100644 --- a/docs/CommandGuide/llvmgxx.pod +++ b/docs/CommandGuide/llvmgxx.pod @@ -79,7 +79,7 @@ L<llvm-gcc|llvmgcc> =head1 AUTHORS -Maintained by the LLVM Team (L<http://llvm.org>). +Maintained by the LLVM Team (L<http://llvm.org/>). =cut diff --git a/docs/CommandGuide/opt.pod b/docs/CommandGuide/opt.pod index d1d1db5ef67e..f5f496817eb8 100644 --- a/docs/CommandGuide/opt.pod +++ b/docs/CommandGuide/opt.pod @@ -138,6 +138,6 @@ occurs, it will exit with a non-zero value. =head1 AUTHORS -Maintained by the LLVM Team (L<http://llvm.org>). +Maintained by the LLVM Team (L<http://llvm.org/>). =cut diff --git a/docs/CommandGuide/tblgen.pod b/docs/CommandGuide/tblgen.pod index d127492a91bb..fe1be5ecfa3c 100644 --- a/docs/CommandGuide/tblgen.pod +++ b/docs/CommandGuide/tblgen.pod @@ -110,6 +110,6 @@ occurs, it will exit with a non-zero value. =head1 AUTHORS -Maintained by The LLVM Team (L<http://llvm.org>). +Maintained by The LLVM Team (L<http://llvm.org/>). =cut diff --git a/docs/CommandLine.html b/docs/CommandLine.html index 2e5b3a2c4dcb..7535ca498400 100644 --- a/docs/CommandLine.html +++ b/docs/CommandLine.html @@ -8,9 +8,9 @@ </head> <body> -<div class="doc_title"> +<h1> CommandLine 2.0 Library Manual -</div> +</h1> <ol> <li><a href="#introduction">Introduction</a></li> @@ -100,12 +100,12 @@ </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="introduction">Introduction</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>This document describes the CommandLine argument processing library. It will show you how to use it, and what it can do. The CommandLine library uses a @@ -184,12 +184,12 @@ href="mailto:sabre@nondot.org">Chris Lattner</a>.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="quickstart">Quick Start Guide</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>This section of the manual runs through a simple CommandLine'ification of a basic compiler tool. This is intended to show you how to jump into using the @@ -231,11 +231,11 @@ represented like this:</p> <a href="#cl::opt">cl::opt</a><string> OutputFilename("<i>o</i>", <a href="#cl::desc">cl::desc</a>("<i>Specify output filename</i>"), <a href="#cl::value_desc">cl::value_desc</a>("<i>filename</i>")); </pre></div> -<p>This declares a global variable "<tt>OutputFilename</tt>" that is used to -capture the result of the "<tt>o</tt>" argument (first parameter). We specify -that this is a simple scalar option by using the "<tt><a -href="#cl::opt">cl::opt</a></tt>" template (as opposed to the <a -href="#list">"<tt>cl::list</tt> template</a>), and tell the CommandLine library +<p>This declares a global variable "<tt>OutputFilename</tt>" that is used to +capture the result of the "<tt>o</tt>" argument (first parameter). We specify +that this is a simple scalar option by using the "<tt><a +href="#cl::opt">cl::opt</a></tt>" template (as opposed to the <a +href="#list">"<tt>cl::list</tt> template</a>), and tell the CommandLine library that the data type that we are parsing is a string.</p> <p>The second and third parameters (which are optional) are used to specify what @@ -321,14 +321,12 @@ OPTIONS: <p>... indicating that an input filename is expected.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="bool">Boolean Arguments</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>In addition to input and output filenames, we would like the compiler example to support three boolean flags: "<tt>-f</tt>" to force writing binary output to @@ -406,11 +404,11 @@ and <a href="#list">lists</a> of options.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="alias">Argument Aliases</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>So far, the example works well, except for the fact that we need to check the quiet condition like this now:</p> @@ -456,12 +454,12 @@ uses.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="onealternative">Selecting an alternative from a set of possibilities</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>So far we have seen how the CommandLine library handles builtin types like <tt>std::string</tt>, <tt>bool</tt> and <tt>int</tt>, but how does it handle @@ -567,11 +565,11 @@ which is when you would use it.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="namedalternatives">Named Alternatives</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Another useful argument form is a named alternative style. We shall use this style in our compiler to specify different debug levels that can be used. @@ -629,11 +627,11 @@ that you can choose the form most appropriate for your application.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="list">Parsing a list of options</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Now that we have the standard run-of-the-mill argument types out of the way, lets get a little wild and crazy. Lets say that we want our optimizer to accept @@ -699,11 +697,11 @@ checking we have to do.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="bits">Collecting options as a set of flags</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Instead of collecting sets of options in a list, it is also possible to gather information for enum values in a <b>bit vector</b>. The representation used by @@ -758,11 +756,11 @@ href="#list"> <tt>cl::list</tt></a> option.</p> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="description">Adding freeform text to help output</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>As our program grows and becomes more mature, we may decide to put summary information about what it does into the help output. The help output is styled @@ -800,28 +798,27 @@ OPTIONS: </div> +</div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="referenceguide">Reference Guide</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Now that you know the basics of how to use the CommandLine library, this section will give you the detailed information you need to tune how command line options work, as well as information on more "advanced" command line option processing capabilities.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="positional">Positional Arguments</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Positional arguments are those arguments that are not named, and are not specified with a hyphen. Positional arguments should be used when an option is @@ -854,15 +851,12 @@ that command line options will be ordered according to how they are listed in a are defined in multiple .cpp files. The fix for this problem is simply to define all of your positional arguments in one .cpp file.</p> -</div> - - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="--">Specifying positional options with hyphens</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>Sometimes you may want to specify a value to your positional argument that starts with a hyphen (for example, searching for '<tt>-foo</tt>' in a file). At @@ -895,10 +889,10 @@ can use it like this:</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="getPosition">Determining absolute position with getPosition()</a> -</div> -<div class="doc_text"> +</h4> +<div> <p>Sometimes an option can affect or modify the meaning of another option. For example, consider <tt>gcc</tt>'s <tt>-x LANG</tt> option. This tells <tt>gcc</tt> to ignore the suffix of subsequent positional arguments and force @@ -954,11 +948,11 @@ can use it like this:</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="cl::ConsumeAfter">The <tt>cl::ConsumeAfter</tt> modifier</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>The <tt>cl::ConsumeAfter</tt> <a href="#formatting">formatting option</a> is used to construct programs that use "interpreter style" option processing. With @@ -1006,12 +1000,14 @@ href="#cl::list">cl::list</a> option.</p> </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="storage">Internal vs External Storage</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>By default, all command line options automatically hold the value that they parse from the command line. This is very convenient in the common case, @@ -1076,11 +1072,11 @@ that <tt>DebugFlag</tt> is automatically set.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="attributes">Option Attributes</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>This section describes the basic attributes that you can specify on options.</p> @@ -1166,11 +1162,11 @@ obviously).</li> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="modifiers">Option Modifiers</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Option modifiers are the flags and expressions that you pass into the constructors for <tt><a href="#cl::opt">cl::opt</a></tt> and <tt><a @@ -1196,14 +1192,12 @@ category. The CommandLine library specifies defaults for all of these settings that are the most useful in practice and the most common, which mean that you usually shouldn't have to worry about these.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="hiding">Hiding an option from <tt>-help</tt> output</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>The <tt>cl::NotHidden</tt>, <tt>cl::Hidden</tt>, and <tt>cl::ReallyHidden</tt> modifiers are used to control whether or not an option @@ -1230,12 +1224,12 @@ indicates that the option should not appear in any help output.</li> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="numoccurrences">Controlling the number of occurrences required and allowed</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>This group of options is used to control how many time an option is allowed (or required) to be specified on the command line of your program. Specifying a @@ -1279,11 +1273,11 @@ retained.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="valrequired">Controlling whether or not a value must be specified</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>This group of options is used to control whether or not the option allows a value to be present. In the case of the CommandLine library, a value is either @@ -1328,11 +1322,11 @@ when <a href="#extensionguide">extending the library</a>.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="formatting">Controlling other formatting options</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>The formatting option group is used to specify that the command line option has special abilities and is otherwise different from other command line @@ -1409,11 +1403,11 @@ strategy basically looks like this:</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="misc">Miscellaneous option modifiers</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>The miscellaneous option modifiers are the only flags where you can specify more than one flag from the set: they are not mutually exclusive. These flags @@ -1453,11 +1447,11 @@ only makes sense with a <a href="#cl::list">cl::list</a> option.</li> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="response">Response files</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>Some systems, such as certain variants of Microsoft Windows and some older Unices have a relatively low limit on command-line @@ -1474,13 +1468,14 @@ and </div> +</div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="toplevel">Top-Level Classes and Functions</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Despite all of the built-in flexibility, the CommandLine option library really only consists of one function (<a @@ -1490,15 +1485,13 @@ href="#cl::list"><tt>cl::list</tt></a>, and <a href="#cl::alias"><tt>cl::alias</tt></a>. This section describes these three classes in detail.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="cl::ParseCommandLineOptions">The <tt>cl::ParseCommandLineOptions</tt> function</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>The <tt>cl::ParseCommandLineOptions</tt> function is designed to be called directly from <tt>main</tt>, and is used to fill in the values of all of the @@ -1514,12 +1507,12 @@ which holds <a href="#description">additional extra text</a> to emit when the </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="cl::ParseEnvironmentOptions">The <tt>cl::ParseEnvironmentOptions</tt> function</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>The <tt>cl::ParseEnvironmentOptions</tt> function has mostly the same effects as <a @@ -1551,12 +1544,12 @@ input.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="cl::SetVersionPrinter">The <tt>cl::SetVersionPrinter</tt> function</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>The <tt>cl::SetVersionPrinter</tt> function is designed to be called directly from <tt>main</tt> and <i>before</i> @@ -1572,11 +1565,11 @@ called when the <tt>--version</tt> option is given by the user.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="cl::opt">The <tt>cl::opt</tt> class</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>The <tt>cl::opt</tt> class is the class used to represent scalar command line options, and is the one used most of the time. It is a templated class which @@ -1607,11 +1600,11 @@ href="#customparser">custom parser</a>.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="cl::list">The <tt>cl::list</tt> class</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>The <tt>cl::list</tt> class is the class used to represent a list of command line options. It too is a templated class which can take up to three @@ -1634,11 +1627,11 @@ be used.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="cl::bits">The <tt>cl::bits</tt> class</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>The <tt>cl::bits</tt> class is the class used to represent a list of command line options in the form of a bit vector. It is also a templated class which @@ -1659,11 +1652,11 @@ must be of <b>type</b> <tt>unsigned</tt> if external storage is used.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="cl::alias">The <tt>cl::alias</tt> class</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>The <tt>cl::alias</tt> class is a nontemplated class that is used to form aliases for other arguments.</p> @@ -1682,11 +1675,11 @@ the conversion from string to data.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="cl::extrahelp">The <tt>cl::extrahelp</tt> class</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>The <tt>cl::extrahelp</tt> class is a nontemplated class that allows extra help text to be printed out for the <tt>-help</tt> option.</p> @@ -1709,12 +1702,14 @@ single <tt>cl::extrahelp</tt> instance.</p> </pre></div> </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="builtinparsers">Builtin parsers</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Parsers control how the string value taken from the command line is translated into a typed value, suitable for use in a C++ program. By default, @@ -1773,27 +1768,27 @@ exponential notation (ex: <tt>1.7e15</tt>) and properly supports locales. </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="extensionguide">Extension Guide</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Although the CommandLine library has a lot of functionality built into it already (as discussed previously), one of its true strengths lie in its extensibility. This section discusses how the CommandLine library works under the covers and illustrates how to do some simple, common, extensions.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="customparser">Writing a custom parser</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>One of the simplest and most common extensions is the use of a custom parser. As <a href="#builtinparsers">discussed previously</a>, parsers are the portion @@ -1932,11 +1927,11 @@ tutorial.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="explotingexternal">Exploiting external storage</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Several of the LLVM libraries define static <tt>cl::opt</tt> instances that will automatically be included in any program that links with that library. This is a feature. However, sometimes it is necessary to know the value of the @@ -1951,16 +1946,18 @@ tutorial.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="dynamicopts">Dynamically adding command line options</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>TODO: fill in this section</p> </div> +</div> + <!-- *********************************************************************** --> <hr> @@ -1971,8 +1968,8 @@ tutorial.</p> src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a> <a href="mailto:sabre@nondot.org">Chris Lattner</a><br> - <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br> - Last modified: $Date: 2010-05-07 02:28:04 +0200 (Fri, 07 May 2010) $ + <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br> + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> diff --git a/docs/CompilerDriver.html b/docs/CompilerDriver.html index c63e1747fa69..03db3a09bde7 100644 --- a/docs/CompilerDriver.html +++ b/docs/CompilerDriver.html @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<meta name="generator" content="Docutils 0.5: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.6: http://docutils.sourceforge.net/" /> <title>Customizing LLVMC: Reference Manual</title> <link rel="stylesheet" href="llvm.css" type="text/css" /> </head> @@ -17,28 +17,23 @@ The ReST source lives in the directory 'tools/llvmc/doc'. --> <div class="contents topic" id="contents"> <p class="topic-title first">Contents</p> <ul class="simple"> -<li><a class="reference internal" href="#introduction" id="id8">Introduction</a></li> -<li><a class="reference internal" href="#compiling-with-llvmc" id="id9">Compiling with LLVMC</a></li> -<li><a class="reference internal" href="#predefined-options" id="id10">Predefined options</a></li> -<li><a class="reference internal" href="#compiling-llvmc-plugins" id="id11">Compiling LLVMC plugins</a></li> -<li><a class="reference internal" href="#compiling-standalone-llvmc-based-drivers" id="id12">Compiling standalone LLVMC-based drivers</a></li> -<li><a class="reference internal" href="#customizing-llvmc-the-compilation-graph" id="id13">Customizing LLVMC: the compilation graph</a></li> -<li><a class="reference internal" href="#describing-options" id="id14">Describing options</a><ul> -<li><a class="reference internal" href="#external-options" id="id15">External options</a></li> +<li><a class="reference internal" href="#introduction" id="id7">Introduction</a></li> +<li><a class="reference internal" href="#compiling-with-llvmc" id="id8">Compiling with <tt class="docutils literal">llvmc</tt></a></li> +<li><a class="reference internal" href="#predefined-options" id="id9">Predefined options</a></li> +<li><a class="reference internal" href="#compiling-llvmc-based-drivers" id="id10">Compiling LLVMC-based drivers</a></li> +<li><a class="reference internal" href="#customizing-llvmc-the-compilation-graph" id="id11">Customizing LLVMC: the compilation graph</a></li> +<li><a class="reference internal" href="#describing-options" id="id12">Describing options</a></li> +<li><a class="reference internal" href="#conditional-evaluation" id="id13">Conditional evaluation</a></li> +<li><a class="reference internal" href="#writing-a-tool-description" id="id14">Writing a tool description</a><ul> +<li><a class="reference internal" href="#id4" id="id15">Actions</a></li> </ul> </li> -<li><a class="reference internal" href="#conditional-evaluation" id="id16">Conditional evaluation</a></li> -<li><a class="reference internal" href="#writing-a-tool-description" id="id17">Writing a tool description</a><ul> -<li><a class="reference internal" href="#id5" id="id18">Actions</a></li> -</ul> -</li> -<li><a class="reference internal" href="#language-map" id="id19">Language map</a></li> -<li><a class="reference internal" href="#option-preprocessor" id="id20">Option preprocessor</a></li> -<li><a class="reference internal" href="#more-advanced-topics" id="id21">More advanced topics</a><ul> -<li><a class="reference internal" href="#hooks-and-environment-variables" id="id22">Hooks and environment variables</a></li> -<li><a class="reference internal" href="#how-plugins-are-loaded" id="id23">How plugins are loaded</a></li> -<li><a class="reference internal" href="#debugging" id="id24">Debugging</a></li> -<li><a class="reference internal" href="#conditioning-on-the-executable-name" id="id25">Conditioning on the executable name</a></li> +<li><a class="reference internal" href="#language-map" id="id16">Language map</a></li> +<li><a class="reference internal" href="#option-preprocessor" id="id17">Option preprocessor</a></li> +<li><a class="reference internal" href="#more-advanced-topics" id="id18">More advanced topics</a><ul> +<li><a class="reference internal" href="#hooks-and-environment-variables" id="id19">Hooks and environment variables</a></li> +<li><a class="reference internal" href="#debugging" id="id20">Debugging</a></li> +<li><a class="reference internal" href="#conditioning-on-the-executable-name" id="id21">Conditioning on the executable name</a></li> </ul> </li> </ul> @@ -46,25 +41,24 @@ The ReST source lives in the directory 'tools/llvmc/doc'. --> <div class="doc_author"> <p>Written by <a href="mailto:foldr@codedgers.com">Mikhail Glushenkov</a></p> </div><div class="section" id="introduction"> -<h1><a class="toc-backref" href="#id8">Introduction</a></h1> +<h1><a class="toc-backref" href="#id7">Introduction</a></h1> <p>LLVMC is a generic compiler driver, designed to be customizable and -extensible. It plays the same role for LLVM as the <tt class="docutils literal"><span class="pre">gcc</span></tt> program -does for GCC - LLVMC's job is essentially to transform a set of input -files into a set of targets depending on configuration rules and user -options. What makes LLVMC different is that these transformation rules -are completely customizable - in fact, LLVMC knows nothing about the -specifics of transformation (even the command-line options are mostly -not hard-coded) and regards the transformation structure as an -abstract graph. The structure of this graph is completely determined -by plugins, which can be either statically or dynamically linked. This -makes it possible to easily adapt LLVMC for other purposes - for -example, as a build tool for game resources.</p> +extensible. It plays the same role for LLVM as the <tt class="docutils literal">gcc</tt> program does for +GCC - LLVMC's job is essentially to transform a set of input files into a set of +targets depending on configuration rules and user options. What makes LLVMC +different is that these transformation rules are completely customizable - in +fact, LLVMC knows nothing about the specifics of transformation (even the +command-line options are mostly not hard-coded) and regards the transformation +structure as an abstract graph. The structure of this graph is described in +high-level TableGen code, from which an efficient C++ representation is +automatically derived. This makes it possible to adapt LLVMC for other +purposes - for example, as a build tool for game resources.</p> <p>Because LLVMC employs <a class="reference external" href="http://llvm.org/docs/TableGenFundamentals.html">TableGen</a> as its configuration language, you need to be familiar with it to customize LLVMC.</p> </div> <div class="section" id="compiling-with-llvmc"> -<h1><a class="toc-backref" href="#id9">Compiling with LLVMC</a></h1> -<p>LLVMC tries hard to be as compatible with <tt class="docutils literal"><span class="pre">gcc</span></tt> as possible, +<h1><a class="toc-backref" href="#id8">Compiling with <tt class="docutils literal">llvmc</tt></a></h1> +<p>LLVMC tries hard to be as compatible with <tt class="docutils literal">gcc</tt> as possible, although there are some small differences. Most of the time, however, you shouldn't be able to notice them:</p> <pre class="literal-block"> @@ -74,11 +68,11 @@ $ ./a.out hello </pre> <p>One nice feature of LLVMC is that one doesn't have to distinguish between -different compilers for different languages (think <tt class="docutils literal"><span class="pre">g++</span></tt> vs. <tt class="docutils literal"><span class="pre">gcc</span></tt>) - the +different compilers for different languages (think <tt class="docutils literal">g++</tt> vs. <tt class="docutils literal">gcc</tt>) - the right toolchain is chosen automatically based on input language names (which are, in turn, determined from file extensions). If you want to force files ending with ".c" to compile as C++, use the <tt class="docutils literal"><span class="pre">-x</span></tt> option, just like you would -do it with <tt class="docutils literal"><span class="pre">gcc</span></tt>:</p> +do it with <tt class="docutils literal">gcc</tt>:</p> <pre class="literal-block"> $ # hello.c is really a C++ file $ llvmc -x c++ hello.c @@ -97,138 +91,100 @@ $ ./a.out hello </pre> <p>By default, LLVMC uses <tt class="docutils literal"><span class="pre">llvm-gcc</span></tt> to compile the source code. It is also -possible to choose the <tt class="docutils literal"><span class="pre">clang</span></tt> compiler with the <tt class="docutils literal"><span class="pre">-clang</span></tt> option.</p> +possible to choose the <tt class="docutils literal">clang</tt> compiler with the <tt class="docutils literal"><span class="pre">-clang</span></tt> option.</p> </div> <div class="section" id="predefined-options"> -<h1><a class="toc-backref" href="#id10">Predefined options</a></h1> -<p>LLVMC has some built-in options that can't be overridden in the -configuration libraries:</p> +<h1><a class="toc-backref" href="#id9">Predefined options</a></h1> +<p>LLVMC has some built-in options that can't be overridden in the TableGen code:</p> <ul class="simple"> -<li><tt class="docutils literal"><span class="pre">-o</span> <span class="pre">FILE</span></tt> - Output file name.</li> -<li><tt class="docutils literal"><span class="pre">-x</span> <span class="pre">LANGUAGE</span></tt> - Specify the language of the following input files +<li><tt class="docutils literal"><span class="pre">-o</span> FILE</tt> - Output file name.</li> +<li><tt class="docutils literal"><span class="pre">-x</span> LANGUAGE</tt> - Specify the language of the following input files 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">--temp-dir</span> <span class="pre">DIRECTORY</span></tt> - Store temporary files in the given directory. This +<li><tt class="docutils literal"><span class="pre">--temp-dir</span> DIRECTORY</tt> - Store temporary files in the given directory. This directory is deleted on exit unless <tt class="docutils literal"><span class="pre">--save-temps</span></tt> is specified. If <tt class="docutils literal"><span class="pre">--save-temps=obj</span></tt> is also specified, <tt class="docutils literal"><span class="pre">--temp-dir</span></tt> is given the precedence.</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 -if no errors were found, and return the number of found errors -otherwise. Hidden option, useful for debugging LLVMC plugins.</li> +output/input language names, multiple default edges and cycles. Exit with code +zero if no errors were found, and return the number of found errors +otherwise. Hidden option, useful for debugging.</li> <li><tt class="docutils literal"><span class="pre">--view-graph</span></tt> - Show a graphical representation of the compilation graph -and exit. Requires that you have <tt class="docutils literal"><span class="pre">dot</span></tt> and <tt class="docutils literal"><span class="pre">gv</span></tt> programs installed. Hidden -option, useful for debugging LLVMC plugins.</li> +and exit. Requires that you have <tt class="docutils literal">dot</tt> and <tt class="docutils literal">gv</tt> programs installed. Hidden +option, useful for debugging.</li> <li><tt class="docutils literal"><span class="pre">--write-graph</span></tt> - Write a <tt class="docutils literal"><span class="pre">compilation-graph.dot</span></tt> file in the current 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">-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 +used to set the output file name. 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> </div> -<div class="section" id="compiling-llvmc-plugins"> -<h1><a class="toc-backref" href="#id11">Compiling LLVMC plugins</a></h1> -<p>It's easiest to start working on your own LLVMC plugin by copying the -skeleton project which lives under <tt class="docutils literal"><span class="pre">$LLVMC_DIR/plugins/Simple</span></tt>:</p> +<div class="section" id="compiling-llvmc-based-drivers"> +<h1><a class="toc-backref" href="#id10">Compiling LLVMC-based drivers</a></h1> +<p>It's easiest to start working on your own LLVMC driver by copying the skeleton +project which lives under <tt class="docutils literal">$LLVMC_DIR/examples/Skeleton</tt>:</p> <pre class="literal-block"> -$ cd $LLVMC_DIR/plugins -$ cp -r Simple MyPlugin -$ cd MyPlugin +$ cd $LLVMC_DIR/examples +$ cp -r Skeleton MyDriver +$ cd MyDriver $ ls -Makefile PluginMain.cpp Simple.td -</pre> -<p>As you can see, our basic plugin consists of only two files (not -counting the build script). <tt class="docutils literal"><span class="pre">Simple.td</span></tt> contains TableGen -description of the compilation graph; its format is documented in the -following sections. <tt class="docutils literal"><span class="pre">PluginMain.cpp</span></tt> is just a helper file used to -compile the auto-generated C++ code produced from TableGen source. It -can also contain hook definitions (see <a class="reference internal" href="#hooks">below</a>).</p> -<p>The first thing that you should do is to change the <tt class="docutils literal"><span class="pre">LLVMC_PLUGIN</span></tt> -variable in the <tt class="docutils literal"><span class="pre">Makefile</span></tt> to avoid conflicts (since this variable -is used to name the resulting library):</p> -<pre class="literal-block"> -LLVMC_PLUGIN=MyPlugin +AutoGenerated.td Hooks.cpp Main.cpp Makefile </pre> -<p>It is also a good idea to rename <tt class="docutils literal"><span class="pre">Simple.td</span></tt> to something less -generic:</p> +<p>As you can see, our basic driver consists of only three files (not counting the +build script). <tt class="docutils literal">AutoGenerated.td</tt> contains TableGen description of the +compilation graph; its format is documented in the following +sections. <tt class="docutils literal">Hooks.cpp</tt> is an empty file that should be used for hook +definitions (see <a class="reference internal" href="#hooks">below</a>). <tt class="docutils literal">Main.cpp</tt> is just a helper used to compile the +auto-generated C++ code produced from TableGen source.</p> +<p>The first thing that you should do is to change the <tt class="docutils literal">LLVMC_BASED_DRIVER</tt> +variable in the <tt class="docutils literal">Makefile</tt>:</p> <pre class="literal-block"> -$ mv Simple.td MyPlugin.td +LLVMC_BASED_DRIVER=MyDriver </pre> -<p>To build your plugin as a dynamic library, just <tt class="docutils literal"><span class="pre">cd</span></tt> to its source -directory and run <tt class="docutils literal"><span class="pre">make</span></tt>. The resulting file will be called -<tt class="docutils literal"><span class="pre">plugin_llvmc_$(LLVMC_PLUGIN).$(DLL_EXTENSION)</span></tt> (in our case, -<tt class="docutils literal"><span class="pre">plugin_llvmc_MyPlugin.so</span></tt>). This library can be then loaded in with the -<tt class="docutils literal"><span class="pre">-load</span></tt> option. Example:</p> -<pre class="literal-block"> -$ cd $LLVMC_DIR/plugins/Simple -$ make -$ llvmc -load $LLVM_DIR/Release/lib/plugin_llvmc_Simple.so -</pre> -</div> -<div class="section" id="compiling-standalone-llvmc-based-drivers"> -<h1><a class="toc-backref" href="#id12">Compiling standalone LLVMC-based drivers</a></h1> -<p>By default, the <tt class="docutils literal"><span class="pre">llvmc</span></tt> executable consists of a driver core plus several -statically linked plugins (<tt class="docutils literal"><span class="pre">Base</span></tt> and <tt class="docutils literal"><span class="pre">Clang</span></tt> at the moment). You can -produce a standalone LLVMC-based driver executable by linking the core with your -own plugins. The recommended way to do this is by starting with the provided -<tt class="docutils literal"><span class="pre">Skeleton</span></tt> example (<tt class="docutils literal"><span class="pre">$LLVMC_DIR/example/Skeleton</span></tt>):</p> +<p>It can also be a good idea to put your TableGen code into a file with a less +generic name:</p> <pre class="literal-block"> -$ cd $LLVMC_DIR/example/ -$ cp -r Skeleton mydriver -$ cd mydriver -$ vim Makefile +$ touch MyDriver.td +$ vim AutoGenerated.td [...] -$ make +include "MyDriver.td" </pre> +<p>If you have more than one TableGen source file, they all should be included from +<tt class="docutils literal">AutoGenerated.td</tt>, since this file is used by the build system to generate +C++ code.</p> +<p>To build your driver, just <tt class="docutils literal">cd</tt> to its source directory and run <tt class="docutils literal">make</tt>. The +resulting executable will be put into <tt class="docutils literal"><span class="pre">$LLVM_OBJ_DIR/$(BuildMode)/bin</span></tt>.</p> <p>If you're compiling LLVM with different source and object directories, then you -must perform the following additional steps before running <tt class="docutils literal"><span class="pre">make</span></tt>:</p> +must perform the following additional steps before running <tt class="docutils literal">make</tt>:</p> <pre class="literal-block"> # LLVMC_SRC_DIR = $LLVM_SRC_DIR/tools/llvmc/ # LLVMC_OBJ_DIR = $LLVM_OBJ_DIR/tools/llvmc/ -$ cp $LLVMC_SRC_DIR/example/mydriver/Makefile \ - $LLVMC_OBJ_DIR/example/mydriver/ -$ cd $LLVMC_OBJ_DIR/example/mydriver +$ mkdir $LLVMC_OBJ_DIR/examples/MyDriver/ +$ cp $LLVMC_SRC_DIR/examples/MyDriver/Makefile \ + $LLVMC_OBJ_DIR/examples/MyDriver/ +$ cd $LLVMC_OBJ_DIR/examples/MyDriver $ make </pre> -<p>Another way to do the same thing is by using the following command:</p> -<pre class="literal-block"> -$ cd $LLVMC_DIR -$ make LLVMC_BUILTIN_PLUGINS=MyPlugin LLVMC_BASED_DRIVER_NAME=mydriver -</pre> -<p>This works with both srcdir == objdir and srcdir != objdir, but assumes that the -plugin source directory was placed under <tt class="docutils literal"><span class="pre">$LLVMC_DIR/plugins</span></tt>.</p> -<p>Sometimes, you will want a 'bare-bones' version of LLVMC that has no -built-in plugins. It can be compiled with the following command:</p> -<pre class="literal-block"> -$ cd $LLVMC_DIR -$ make LLVMC_BUILTIN_PLUGINS="" -</pre> </div> <div class="section" id="customizing-llvmc-the-compilation-graph"> -<h1><a class="toc-backref" href="#id13">Customizing LLVMC: the compilation graph</a></h1> -<p>Each TableGen configuration file should include the common -definitions:</p> +<h1><a class="toc-backref" href="#id11">Customizing LLVMC: the compilation graph</a></h1> +<p>Each TableGen configuration file should include the common definitions:</p> <pre class="literal-block"> include "llvm/CompilerDriver/Common.td" </pre> -<p>Internally, LLVMC stores information about possible source -transformations in form of a graph. Nodes in this graph represent -tools, and edges between two nodes represent a transformation path. A -special "root" node is used to mark entry points for the -transformations. LLVMC also assigns a weight to each edge (more on -this later) to choose between several alternative edges.</p> -<p>The definition of the compilation graph (see file -<tt class="docutils literal"><span class="pre">plugins/Base/Base.td</span></tt> for an example) is just a list of edges:</p> +<p>Internally, LLVMC stores information about possible source transformations in +form of a graph. Nodes in this graph represent tools, and edges between two +nodes represent a transformation path. A special "root" node is used to mark +entry points for the transformations. LLVMC also assigns a weight to each edge +(more on this later) to choose between several alternative edges.</p> +<p>The definition of the compilation graph (see file <tt class="docutils literal">llvmc/src/Base.td</tt> for an +example) is just a list of edges:</p> <pre class="literal-block"> def CompilationGraph : CompilationGraph<[ Edge<"root", "llvm_gcc_c">, @@ -253,39 +209,33 @@ def CompilationGraph : CompilationGraph<[ ]>; </pre> -<p>As you can see, the edges can be either default or optional, where -optional edges are differentiated by an additional <tt class="docutils literal"><span class="pre">case</span></tt> expression -used to calculate the weight of this edge. Notice also that we refer -to tools via their names (as strings). This makes it possible to add -edges to an existing compilation graph in plugins without having to -know about all tool definitions used in the graph.</p> -<p>The default edges are assigned a weight of 1, and optional edges get a -weight of 0 + 2*N where N is the number of tests that evaluated to -true in the <tt class="docutils literal"><span class="pre">case</span></tt> expression. It is also possible to provide an -integer parameter to <tt class="docutils literal"><span class="pre">inc_weight</span></tt> and <tt class="docutils literal"><span class="pre">dec_weight</span></tt> - in this case, -the weight is increased (or decreased) by the provided value instead -of the default 2. It is also possible to change the default weight of -an optional edge by using the <tt class="docutils literal"><span class="pre">default</span></tt> clause of the <tt class="docutils literal"><span class="pre">case</span></tt> +<p>As you can see, the edges can be either default or optional, where optional +edges are differentiated by an additional <tt class="docutils literal">case</tt> expression used to calculate +the weight of this edge. Notice also that we refer to tools via their names (as +strings). This makes it possible to add edges to an existing compilation graph +without having to know about all tool definitions used in the graph.</p> +<p>The default edges are assigned a weight of 1, and optional edges get a weight of +0 + 2*N where N is the number of tests that evaluated to true in the <tt class="docutils literal">case</tt> +expression. It is also possible to provide an integer parameter to +<tt class="docutils literal">inc_weight</tt> and <tt class="docutils literal">dec_weight</tt> - in this case, the weight is increased (or +decreased) by the provided value instead of the default 2. Default weight of an +optional edge can be changed by using the <tt class="docutils literal">default</tt> clause of the <tt class="docutils literal">case</tt> construct.</p> -<p>When passing an input file through the graph, LLVMC picks the edge -with the maximum weight. To avoid ambiguity, there should be only one -default edge between two nodes (with the exception of the root node, -which gets a special treatment - there you are allowed to specify one -default edge <em>per language</em>).</p> -<p>When multiple plugins are loaded, their compilation graphs are merged -together. Since multiple edges that have the same end nodes are not -allowed (i.e. the graph is not a multigraph), an edge defined in -several plugins will be replaced by the definition from the plugin -that was loaded last. Plugin load order can be controlled by using the -plugin priority feature described above.</p> -<p>To get a visual representation of the compilation graph (useful for -debugging), run <tt class="docutils literal"><span class="pre">llvmc</span> <span class="pre">--view-graph</span></tt>. You will need <tt class="docutils literal"><span class="pre">dot</span></tt> and -<tt class="docutils literal"><span class="pre">gsview</span></tt> installed for this to work properly.</p> +<p>When passing an input file through the graph, LLVMC picks the edge with the +maximum weight. To avoid ambiguity, there should be only one default edge +between two nodes (with the exception of the root node, which gets a special +treatment - there you are allowed to specify one default edge <em>per language</em>).</p> +<p>When multiple compilation graphs are defined, they are merged together. Multiple +edges with the same end nodes are not allowed (i.e. the graph is not a +multigraph), and will lead to a compile-time error.</p> +<p>To get a visual representation of the compilation graph (useful for debugging), +run <tt class="docutils literal">llvmc <span class="pre">--view-graph</span></tt>. You will need <tt class="docutils literal">dot</tt> and <tt class="docutils literal">gsview</tt> installed for +this to work properly.</p> </div> <div class="section" id="describing-options"> -<h1><a class="toc-backref" href="#id14">Describing options</a></h1> -<p>Command-line options that the plugin supports are defined by using an -<tt class="docutils literal"><span class="pre">OptionList</span></tt>:</p> +<h1><a class="toc-backref" href="#id12">Describing options</a></h1> +<p>Command-line options supported by the driver are defined by using an +<tt class="docutils literal">OptionList</tt>:</p> <pre class="literal-block"> def Options : OptionList<[ (switch_option "E", (help "Help string")), @@ -293,101 +243,95 @@ def Options : OptionList<[ ... ]>; </pre> -<p>As you can see, the option list is just a list of DAGs, where each DAG -is an option description consisting of the option name and some -properties. A plugin can define more than one option list (they are -all merged together in the end), which can be handy if one wants to -separate option groups syntactically.</p> +<p>As you can see, the option list is just a list of DAGs, where each DAG is an +option description consisting of the option name and some properties. More than +one option list can be defined (they are all merged together in the end), which +can be handy if one wants to separate option groups syntactically.</p> <ul> <li><p class="first">Possible option types:</p> <blockquote> <ul class="simple"> -<li><tt class="docutils literal"><span class="pre">switch_option</span></tt> - a simple boolean switch without arguments, for example -<tt class="docutils literal"><span class="pre">-O2</span></tt> or <tt class="docutils literal"><span class="pre">-time</span></tt>. At most one occurrence is allowed.</li> -<li><tt class="docutils literal"><span class="pre">parameter_option</span></tt> - option that takes one argument, for example +<li><tt class="docutils literal">switch_option</tt> - a simple boolean switch without arguments, for example +<tt class="docutils literal"><span class="pre">-O2</span></tt> or <tt class="docutils literal"><span class="pre">-time</span></tt>. At most one occurrence is allowed by default.</li> +<li><tt class="docutils literal">parameter_option</tt> - option that takes one argument, for example <tt class="docutils literal"><span class="pre">-std=c99</span></tt>. It is also allowed to use spaces instead of the equality -sign: <tt class="docutils literal"><span class="pre">-std</span> <span class="pre">c99</span></tt>. At most one occurrence is allowed.</li> -<li><tt class="docutils literal"><span class="pre">parameter_list_option</span></tt> - same as the above, but more than one option -occurence is allowed.</li> -<li><tt class="docutils literal"><span class="pre">prefix_option</span></tt> - same as the parameter_option, but the option name and +sign: <tt class="docutils literal"><span class="pre">-std</span> c99</tt>. At most one occurrence is allowed.</li> +<li><tt class="docutils literal">parameter_list_option</tt> - same as the above, but more than one option +occurrence is allowed.</li> +<li><tt class="docutils literal">prefix_option</tt> - same as the parameter_option, but the option name and argument do not have to be separated. Example: <tt class="docutils literal"><span class="pre">-ofile</span></tt>. This can be also -specified as <tt class="docutils literal"><span class="pre">-o</span> <span class="pre">file</span></tt>; however, <tt class="docutils literal"><span class="pre">-o=file</span></tt> will be parsed incorrectly -(<tt class="docutils literal"><span class="pre">=file</span></tt> will be interpreted as option value). At most one occurrence is +specified as <tt class="docutils literal"><span class="pre">-o</span> file</tt>; however, <tt class="docutils literal"><span class="pre">-o=file</span></tt> will be parsed incorrectly +(<tt class="docutils literal">=file</tt> will be interpreted as option value). At most one occurrence is allowed.</li> -<li><tt class="docutils literal"><span class="pre">prefix_list_option</span></tt> - same as the above, but more than one occurence of +<li><tt class="docutils literal">prefix_list_option</tt> - same as the above, but more than one occurrence of the option is allowed; example: <tt class="docutils literal"><span class="pre">-lm</span> <span class="pre">-lpthread</span></tt>.</li> -<li><tt class="docutils literal"><span class="pre">alias_option</span></tt> - a special option type for creating aliases. Unlike other +<li><tt class="docutils literal">alias_option</tt> - a special option type for creating aliases. Unlike other option types, aliases are not allowed to have any properties besides the -aliased option name. Usage example: <tt class="docutils literal"><span class="pre">(alias_option</span> <span class="pre">"preprocess",</span> <span class="pre">"E")</span></tt></li> +aliased option name. +Usage example: <tt class="docutils literal">(alias_option "preprocess", "E")</tt></li> +<li><tt class="docutils literal">switch_list_option</tt> - like <tt class="docutils literal">switch_option</tt> with the <tt class="docutils literal">zero_or_more</tt> +property, but remembers how many times the switch was turned on. Useful +mostly for forwarding. Example: when <tt class="docutils literal"><span class="pre">-foo</span></tt> is a switch option (with the +<tt class="docutils literal">zero_or_more</tt> property), the command <tt class="docutils literal">driver <span class="pre">-foo</span> <span class="pre">-foo</span></tt> is forwarded +as <tt class="docutils literal"><span class="pre">some-tool</span> <span class="pre">-foo</span></tt>, but when <tt class="docutils literal"><span class="pre">-foo</span></tt> is a switch list, the same command +is forwarded as <tt class="docutils literal"><span class="pre">some-tool</span> <span class="pre">-foo</span> <span class="pre">-foo</span></tt>.</li> </ul> </blockquote> </li> <li><p class="first">Possible option properties:</p> <blockquote> <ul class="simple"> -<li><tt class="docutils literal"><span class="pre">help</span></tt> - help string associated with this option. Used for <tt class="docutils literal"><span class="pre">-help</span></tt> +<li><tt class="docutils literal">help</tt> - help string associated with this option. Used for <tt class="docutils literal"><span class="pre">--help</span></tt> output.</li> -<li><tt class="docutils literal"><span class="pre">required</span></tt> - this option must be specified exactly once (or, in case of -the list options without the <tt class="docutils literal"><span class="pre">multi_val</span></tt> property, at least -once). Incompatible with <tt class="docutils literal"><span class="pre">zero_or_one</span></tt> and <tt class="docutils literal"><span class="pre">one_or_more</span></tt>.</li> -<li><tt class="docutils literal"><span class="pre">one_or_more</span></tt> - the option must be specified at least one time. Useful -only for list options in conjunction with <tt class="docutils literal"><span class="pre">multi_val</span></tt>; for ordinary lists -it is synonymous with <tt class="docutils literal"><span class="pre">required</span></tt>. Incompatible with <tt class="docutils literal"><span class="pre">required</span></tt> and -<tt class="docutils literal"><span class="pre">zero_or_one</span></tt>.</li> -<li><tt class="docutils literal"><span class="pre">optional</span></tt> - the option can be specified zero or one times. Useful only -for list options in conjunction with <tt class="docutils literal"><span class="pre">multi_val</span></tt>. Incompatible with -<tt class="docutils literal"><span class="pre">required</span></tt> and <tt class="docutils literal"><span class="pre">one_or_more</span></tt>.</li> -<li><tt class="docutils literal"><span class="pre">hidden</span></tt> - the description of this option will not appear in -the <tt class="docutils literal"><span class="pre">-help</span></tt> output (but will appear in the <tt class="docutils literal"><span class="pre">-help-hidden</span></tt> +<li><tt class="docutils literal">required</tt> - this option must be specified exactly once (or, in case of +the list options without the <tt class="docutils literal">multi_val</tt> property, at least +once). Incompatible with <tt class="docutils literal">optional</tt> and <tt class="docutils literal">one_or_more</tt>.</li> +<li><tt class="docutils literal">optional</tt> - the option can be specified either zero times or exactly +once. The default for switch options. Useful only for list options in +conjunction with <tt class="docutils literal">multi_val</tt>. Incompatible with <tt class="docutils literal">required</tt>, +<tt class="docutils literal">zero_or_more</tt> and <tt class="docutils literal">one_or_more</tt>.</li> +<li><tt class="docutils literal">one_or_more</tt> - the option must be specified at least once. Can be useful +to allow switch options be both obligatory and be specified multiple +times. For list options is useful only in conjunction with <tt class="docutils literal">multi_val</tt>; +for ordinary it is synonymous with <tt class="docutils literal">required</tt>. Incompatible with +<tt class="docutils literal">required</tt>, <tt class="docutils literal">optional</tt> and <tt class="docutils literal">zero_or_more</tt>.</li> +<li><tt class="docutils literal">zero_or_more</tt> - the option can be specified zero or more times. Useful +to allow a single switch option to be specified more than +once. Incompatible with <tt class="docutils literal">required</tt>, <tt class="docutils literal">optional</tt> and <tt class="docutils literal">one_or_more</tt>.</li> +<li><tt class="docutils literal">hidden</tt> - the description of this option will not appear in +the <tt class="docutils literal"><span class="pre">--help</span></tt> output (but will appear in the <tt class="docutils literal"><span class="pre">--help-hidden</span></tt> output).</li> -<li><tt class="docutils literal"><span class="pre">really_hidden</span></tt> - the option will not be mentioned in any help +<li><tt class="docutils literal">really_hidden</tt> - the option will not be mentioned in any help output.</li> -<li><tt class="docutils literal"><span class="pre">comma_separated</span></tt> - Indicates that any commas specified for an option's +<li><tt class="docutils literal">comma_separated</tt> - Indicates that any commas specified for an option's value should be used to split the value up into multiple values for the option. This property is valid only for list options. In conjunction with -<tt class="docutils literal"><span class="pre">forward_value</span></tt> can be used to implement option forwarding in style of +<tt class="docutils literal">forward_value</tt> can be used to implement option forwarding in style of gcc's <tt class="docutils literal"><span class="pre">-Wa,</span></tt>.</li> -<li><tt class="docutils literal"><span class="pre">multi_val</span> <span class="pre">n</span></tt> - this option takes <em>n</em> arguments (can be useful in some -special cases). Usage example: <tt class="docutils literal"><span class="pre">(parameter_list_option</span> <span class="pre">"foo",</span> <span class="pre">(multi_val</span> -<span class="pre">3))</span></tt>; the command-line syntax is '-foo a b c'. Only list options can have -this attribute; you can, however, use the <tt class="docutils literal"><span class="pre">one_or_more</span></tt>, <tt class="docutils literal"><span class="pre">optional</span></tt> -and <tt class="docutils literal"><span class="pre">required</span></tt> properties.</li> -<li><tt class="docutils literal"><span class="pre">init</span></tt> - this option has a default value, either a string (if it is a +<li><tt class="docutils literal">multi_val n</tt> - this option takes <em>n</em> arguments (can be useful in some +special cases). Usage example: <tt class="docutils literal">(parameter_list_option "foo", (multi_val +3))</tt>; the command-line syntax is '-foo a b c'. Only list options can have +this attribute; you can, however, use the <tt class="docutils literal">one_or_more</tt>, <tt class="docutils literal">optional</tt> +and <tt class="docutils literal">required</tt> properties.</li> +<li><tt class="docutils literal">init</tt> - this option has a default value, either a string (if it is a parameter), or a boolean (if it is a switch; as in C++, boolean constants -are called <tt class="docutils literal"><span class="pre">true</span></tt> and <tt class="docutils literal"><span class="pre">false</span></tt>). List options can't have <tt class="docutils literal"><span class="pre">init</span></tt> +are called <tt class="docutils literal">true</tt> and <tt class="docutils literal">false</tt>). List options can't have <tt class="docutils literal">init</tt> attribute. -Usage examples: <tt class="docutils literal"><span class="pre">(switch_option</span> <span class="pre">"foo",</span> <span class="pre">(init</span> <span class="pre">true))</span></tt>; <tt class="docutils literal"><span class="pre">(prefix_option</span> -<span class="pre">"bar",</span> <span class="pre">(init</span> <span class="pre">"baz"))</span></tt>.</li> -<li><tt class="docutils literal"><span class="pre">extern</span></tt> - this option is defined in some other plugin, see <a class="reference internal" href="#extern">below</a>.</li> +Usage examples: <tt class="docutils literal">(switch_option "foo", (init true))</tt>; <tt class="docutils literal">(prefix_option +"bar", (init <span class="pre">"baz"))</span></tt>.</li> </ul> </blockquote> </li> </ul> -<div class="section" id="external-options"> -<span id="extern"></span><h2><a class="toc-backref" href="#id15">External options</a></h2> -<p>Sometimes, when linking several plugins together, one plugin needs to -access options defined in some other plugin. Because of the way -options are implemented, such options must be marked as -<tt class="docutils literal"><span class="pre">extern</span></tt>. This is what the <tt class="docutils literal"><span class="pre">extern</span></tt> option property is -for. Example:</p> -<pre class="literal-block"> -... -(switch_option "E", (extern)) -... -</pre> -<p>If an external option has additional attributes besides 'extern', they are -ignored. See also the section on plugin <a class="reference internal" href="#priorities">priorities</a>.</p> -</div> </div> <div class="section" id="conditional-evaluation"> -<span id="case"></span><h1><a class="toc-backref" href="#id16">Conditional evaluation</a></h1> -<p>The 'case' construct is the main means by which programmability is -achieved in LLVMC. It can be used to calculate edge weights, program -actions and modify the shell commands to be executed. The 'case' -expression is designed after the similarly-named construct in -functional languages and takes the form <tt class="docutils literal"><span class="pre">(case</span> <span class="pre">(test_1),</span> <span class="pre">statement_1,</span> -<span class="pre">(test_2),</span> <span class="pre">statement_2,</span> <span class="pre">...</span> <span class="pre">(test_N),</span> <span class="pre">statement_N)</span></tt>. The statements -are evaluated only if the corresponding tests evaluate to true.</p> +<span id="case"></span><h1><a class="toc-backref" href="#id13">Conditional evaluation</a></h1> +<p>The 'case' construct is the main means by which programmability is achieved in +LLVMC. It can be used to calculate edge weights, program actions and modify the +shell commands to be executed. The 'case' expression is designed after the +similarly-named construct in functional languages and takes the form <tt class="docutils literal">(case +(test_1), statement_1, (test_2), statement_2, ... (test_N), statement_N)</tt>. The +statements are evaluated only if the corresponding tests evaluate to true.</p> <p>Examples:</p> <pre class="literal-block"> // Edge weight calculation @@ -410,129 +354,139 @@ are evaluated only if the corresponding tests evaluate to true.</p> (switch_on "B"), "cmdline2", (default), "cmdline3") </pre> -<p>Note the slight difference in 'case' expression handling in contexts -of edge weights and command line specification - in the second example -the value of the <tt class="docutils literal"><span class="pre">"B"</span></tt> switch is never checked when switch <tt class="docutils literal"><span class="pre">"A"</span></tt> is -enabled, and the whole expression always evaluates to <tt class="docutils literal"><span class="pre">"cmdline1"</span></tt> in -that case.</p> +<p>Note the slight difference in 'case' expression handling in contexts of edge +weights and command line specification - in the second example the value of the +<tt class="docutils literal">"B"</tt> switch is never checked when switch <tt class="docutils literal">"A"</tt> is enabled, and the whole +expression always evaluates to <tt class="docutils literal">"cmdline1"</tt> in that case.</p> <p>Case expressions can also be nested, i.e. the following is legal:</p> <pre class="literal-block"> (case (switch_on "E"), (case (switch_on "o"), ..., (default), ...) (default), ...) </pre> -<p>You should, however, try to avoid doing that because it hurts -readability. It is usually better to split tool descriptions and/or -use TableGen inheritance instead.</p> +<p>You should, however, try to avoid doing that because it hurts readability. It is +usually better to split tool descriptions and/or use TableGen inheritance +instead.</p> <ul class="simple"> <li>Possible tests are:<ul> -<li><tt class="docutils literal"><span class="pre">switch_on</span></tt> - Returns true if a given command-line switch is provided by -the user. Can be given a list as argument, in that case <tt class="docutils literal"><span class="pre">(switch_on</span> <span class="pre">["foo",</span> -<span class="pre">"bar",</span> <span class="pre">"baz"])</span></tt> is equivalent to <tt class="docutils literal"><span class="pre">(and</span> <span class="pre">(switch_on</span> <span class="pre">"foo"),</span> <span class="pre">(switch_on</span> -<span class="pre">"bar"),</span> <span class="pre">(switch_on</span> <span class="pre">"baz"))</span></tt>. -Example: <tt class="docutils literal"><span class="pre">(switch_on</span> <span class="pre">"opt")</span></tt>.</li> -<li><tt class="docutils literal"><span class="pre">any_switch_on</span></tt> - Given a list of switch options, returns true if any of +<li><tt class="docutils literal">switch_on</tt> - Returns true if a given command-line switch is provided by +the user. Can be given multiple arguments, in that case <tt class="docutils literal">(switch_on "foo", +"bar", "baz")</tt> is equivalent to <tt class="docutils literal">(and (switch_on <span class="pre">"foo"),</span> (switch_on +<span class="pre">"bar"),</span> (switch_on <span class="pre">"baz"))</span></tt>. +Example: <tt class="docutils literal">(switch_on "opt")</tt>.</li> +<li><tt class="docutils literal">any_switch_on</tt> - Given a number of switch options, returns true if any of the switches is turned on. -Example: <tt class="docutils literal"><span class="pre">(any_switch_on</span> <span class="pre">["foo",</span> <span class="pre">"bar",</span> <span class="pre">"baz"])</span></tt> is equivalent to <tt class="docutils literal"><span class="pre">(or</span> -<span class="pre">(switch_on</span> <span class="pre">"foo"),</span> <span class="pre">(switch_on</span> <span class="pre">"bar"),</span> <span class="pre">(switch_on</span> <span class="pre">"baz"))</span></tt>.</li> -<li><tt class="docutils literal"><span class="pre">parameter_equals</span></tt> - Returns true if a command-line parameter equals -a given value. -Example: <tt class="docutils literal"><span class="pre">(parameter_equals</span> <span class="pre">"W",</span> <span class="pre">"all")</span></tt>.</li> -<li><tt class="docutils literal"><span class="pre">element_in_list</span></tt> - Returns true if a command-line parameter -list contains a given value. -Example: <tt class="docutils literal"><span class="pre">(element_in_list</span> <span class="pre">"l",</span> <span class="pre">"pthread")</span></tt>.</li> -<li><tt class="docutils literal"><span class="pre">input_languages_contain</span></tt> - Returns true if a given language +Example: <tt class="docutils literal">(any_switch_on "foo", "bar", "baz")</tt> is equivalent to <tt class="docutils literal">(or +(switch_on <span class="pre">"foo"),</span> (switch_on <span class="pre">"bar"),</span> (switch_on <span class="pre">"baz"))</span></tt>.</li> +<li><tt class="docutils literal">parameter_equals</tt> - Returns true if a command-line parameter (first +argument) equals a given value (second argument). +Example: <tt class="docutils literal">(parameter_equals "W", "all")</tt>.</li> +<li><tt class="docutils literal">element_in_list</tt> - Returns true if a command-line parameter list (first +argument) contains a given value (second argument). +Example: <tt class="docutils literal">(element_in_list "l", "pthread")</tt>.</li> +<li><tt class="docutils literal">input_languages_contain</tt> - Returns true if a given language belongs to the current input language set. -Example: <tt class="docutils literal"><span class="pre">(input_languages_contain</span> <span class="pre">"c++")</span></tt>.</li> -<li><tt class="docutils literal"><span class="pre">in_language</span></tt> - Evaluates to true if the input file language is equal to -the argument. At the moment works only with <tt class="docutils literal"><span class="pre">cmd_line</span></tt> and <tt class="docutils literal"><span class="pre">actions</span></tt> (on +Example: <tt class="docutils literal">(input_languages_contain <span class="pre">"c++")</span></tt>.</li> +<li><tt class="docutils literal">in_language</tt> - Evaluates to true if the input file language is equal to +the argument. At the moment works only with <tt class="docutils literal">command</tt> and <tt class="docutils literal">actions</tt> (on non-join nodes). -Example: <tt class="docutils literal"><span class="pre">(in_language</span> <span class="pre">"c++")</span></tt>.</li> -<li><tt class="docutils literal"><span class="pre">not_empty</span></tt> - Returns true if a given option (which should be either a -parameter or a parameter list) is set by the user. Like <tt class="docutils literal"><span class="pre">switch_on</span></tt>, can -be also given a list as argument. -Example: <tt class="docutils literal"><span class="pre">(not_empty</span> <span class="pre">"o")</span></tt>.</li> -<li><tt class="docutils literal"><span class="pre">any_not_empty</span></tt> - Returns true if <tt class="docutils literal"><span class="pre">not_empty</span></tt> returns true for any of -the options in the list. -Example: <tt class="docutils literal"><span class="pre">(any_not_empty</span> <span class="pre">["foo",</span> <span class="pre">"bar",</span> <span class="pre">"baz"])</span></tt> is equivalent to <tt class="docutils literal"><span class="pre">(or</span> -<span class="pre">(not_empty</span> <span class="pre">"foo"),</span> <span class="pre">(not_empty</span> <span class="pre">"bar"),</span> <span class="pre">(not_empty</span> <span class="pre">"baz"))</span></tt>.</li> -<li><tt class="docutils literal"><span class="pre">empty</span></tt> - The opposite of <tt class="docutils literal"><span class="pre">not_empty</span></tt>. Equivalent to <tt class="docutils literal"><span class="pre">(not</span> <span class="pre">(not_empty</span> -<span class="pre">X))</span></tt>. Provided for convenience. Can be given a list as argument.</li> -<li><tt class="docutils literal"><span class="pre">any_not_empty</span></tt> - Returns true if <tt class="docutils literal"><span class="pre">not_empty</span></tt> returns true for any of -the options in the list. -Example: <tt class="docutils literal"><span class="pre">(any_empty</span> <span class="pre">["foo",</span> <span class="pre">"bar",</span> <span class="pre">"baz"])</span></tt> is equivalent to <tt class="docutils literal"><span class="pre">(not</span> <span class="pre">(and</span> -<span class="pre">(not_empty</span> <span class="pre">"foo"),</span> <span class="pre">(not_empty</span> <span class="pre">"bar"),</span> <span class="pre">(not_empty</span> <span class="pre">"baz")))</span></tt>.</li> -<li><tt class="docutils literal"><span class="pre">single_input_file</span></tt> - Returns true if there was only one input file +Example: <tt class="docutils literal">(in_language <span class="pre">"c++")</span></tt>.</li> +<li><tt class="docutils literal">not_empty</tt> - Returns true if a given option (which should be either a +parameter or a parameter list) is set by the user. Like <tt class="docutils literal">switch_on</tt>, can +be also given multiple arguments. +Examples: <tt class="docutils literal">(not_empty "o")</tt>, <tt class="docutils literal">(not_empty "o", "l")</tt>.</li> +<li><tt class="docutils literal">any_not_empty</tt> - Returns true if <tt class="docutils literal">not_empty</tt> returns true for any of +the provided options. +Example: <tt class="docutils literal">(any_not_empty "foo", "bar", "baz")</tt> is equivalent to <tt class="docutils literal">(or +(not_empty <span class="pre">"foo"),</span> (not_empty <span class="pre">"bar"),</span> (not_empty <span class="pre">"baz"))</span></tt>.</li> +<li><tt class="docutils literal">empty</tt> - The opposite of <tt class="docutils literal">not_empty</tt>. Equivalent to <tt class="docutils literal">(not (not_empty +X))</tt>. Can be given multiple arguments.</li> +<li><tt class="docutils literal">any_not_empty</tt> - Returns true if <tt class="docutils literal">not_empty</tt> returns true for any of +the provided options. +Example: <tt class="docutils literal">(any_empty "foo", "bar", "baz")</tt> is equivalent to <tt class="docutils literal">(or +(not_empty <span class="pre">"foo"),</span> (not_empty <span class="pre">"bar"),</span> (not_empty <span class="pre">"baz"))</span></tt>.</li> +<li><tt class="docutils literal">single_input_file</tt> - Returns true if there was only one input file provided on the command-line. Used without arguments: -<tt class="docutils literal"><span class="pre">(single_input_file)</span></tt>.</li> -<li><tt class="docutils literal"><span class="pre">multiple_input_files</span></tt> - Equivalent to <tt class="docutils literal"><span class="pre">(not</span> <span class="pre">(single_input_file))</span></tt> (the +<tt class="docutils literal">(single_input_file)</tt>.</li> +<li><tt class="docutils literal">multiple_input_files</tt> - Equivalent to <tt class="docutils literal">(not (single_input_file))</tt> (the case of zero input files is considered an error).</li> -<li><tt class="docutils literal"><span class="pre">default</span></tt> - Always evaluates to true. Should always be the last -test in the <tt class="docutils literal"><span class="pre">case</span></tt> expression.</li> -<li><tt class="docutils literal"><span class="pre">and</span></tt> - A standard binary logical combinator that returns true iff all of -its arguments return true. Used like this: <tt class="docutils literal"><span class="pre">(and</span> <span class="pre">(test1),</span> <span class="pre">(test2),</span> -<span class="pre">...</span> <span class="pre">(testN))</span></tt>. Nesting of <tt class="docutils literal"><span class="pre">and</span></tt> and <tt class="docutils literal"><span class="pre">or</span></tt> is allowed, but not +<li><tt class="docutils literal">default</tt> - Always evaluates to true. Should always be the last +test in the <tt class="docutils literal">case</tt> expression.</li> +<li><tt class="docutils literal">and</tt> - A standard logical combinator that returns true iff all of +its arguments return true. Used like this: <tt class="docutils literal">(and (test1), (test2), +... (testN))</tt>. Nesting of <tt class="docutils literal">and</tt> and <tt class="docutils literal">or</tt> is allowed, but not encouraged.</li> -<li><tt class="docutils literal"><span class="pre">or</span></tt> - A binary logical combinator that returns true iff any of its -arguments returns true. Example: <tt class="docutils literal"><span class="pre">(or</span> <span class="pre">(test1),</span> <span class="pre">(test2),</span> <span class="pre">...</span> <span class="pre">(testN))</span></tt>.</li> -<li><tt class="docutils literal"><span class="pre">not</span></tt> - Standard unary logical combinator that negates its -argument. Example: <tt class="docutils literal"><span class="pre">(not</span> <span class="pre">(or</span> <span class="pre">(test1),</span> <span class="pre">(test2),</span> <span class="pre">...</span> <span class="pre">(testN)))</span></tt>.</li> +<li><tt class="docutils literal">or</tt> - A logical combinator that returns true iff any of its arguments +return true. +Example: <tt class="docutils literal">(or (test1), (test2), ... (testN))</tt>.</li> +<li><tt class="docutils literal">not</tt> - Standard unary logical combinator that negates its +argument. +Example: <tt class="docutils literal">(not (or (test1), (test2), ... <span class="pre">(testN)))</span></tt>.</li> </ul> </li> </ul> </div> <div class="section" id="writing-a-tool-description"> -<h1><a class="toc-backref" href="#id17">Writing a tool description</a></h1> -<p>As was said earlier, nodes in the compilation graph represent tools, -which are described separately. A tool definition looks like this -(taken from the <tt class="docutils literal"><span class="pre">include/llvm/CompilerDriver/Tools.td</span></tt> file):</p> +<h1><a class="toc-backref" href="#id14">Writing a tool description</a></h1> +<p>As was said earlier, nodes in the compilation graph represent tools, which are +described separately. A tool definition looks like this (taken from the +<tt class="docutils literal">llvmc/src/Base.td</tt> file):</p> <pre class="literal-block"> def llvm_gcc_cpp : Tool<[ (in_language "c++"), (out_language "llvm-assembler"), (output_suffix "bc"), - (cmd_line "llvm-g++ -c $INFILE -o $OUTFILE -emit-llvm"), + (command "llvm-g++ -c -emit-llvm"), (sink) ]>; </pre> -<p>This defines a new tool called <tt class="docutils literal"><span class="pre">llvm_gcc_cpp</span></tt>, which is an alias for -<tt class="docutils literal"><span class="pre">llvm-g++</span></tt>. As you can see, a tool definition is just a list of -properties; most of them should be self-explanatory. The <tt class="docutils literal"><span class="pre">sink</span></tt> -property means that this tool should be passed all command-line -options that aren't mentioned in the option list.</p> +<p>This defines a new tool called <tt class="docutils literal">llvm_gcc_cpp</tt>, which is an alias for +<tt class="docutils literal"><span class="pre">llvm-g++</span></tt>. As you can see, a tool definition is just a list of properties; +most of them should be self-explanatory. The <tt class="docutils literal">sink</tt> property means that this +tool should be passed all command-line options that aren't mentioned in the +option list.</p> <p>The complete list of all currently implemented tool properties follows.</p> <ul class="simple"> <li>Possible tool properties:<ul> -<li><tt class="docutils literal"><span class="pre">in_language</span></tt> - input language name. Can be either a string or a -list, in case the tool supports multiple input languages.</li> -<li><tt class="docutils literal"><span class="pre">out_language</span></tt> - output language name. Multiple output languages are not -allowed.</li> -<li><tt class="docutils literal"><span class="pre">output_suffix</span></tt> - output file suffix. Can also be changed -dynamically, see documentation on actions.</li> -<li><tt class="docutils literal"><span class="pre">cmd_line</span></tt> - the actual command used to run the tool. You can -use <tt class="docutils literal"><span class="pre">$INFILE</span></tt> and <tt class="docutils literal"><span class="pre">$OUTFILE</span></tt> variables, output redirection -with <tt class="docutils literal"><span class="pre">></span></tt>, hook invocations (<tt class="docutils literal"><span class="pre">$CALL</span></tt>), environment variables -(via <tt class="docutils literal"><span class="pre">$ENV</span></tt>) and the <tt class="docutils literal"><span class="pre">case</span></tt> construct.</li> -<li><tt class="docutils literal"><span class="pre">join</span></tt> - this tool is a "join node" in the graph, i.e. it gets a -list of input files and joins them together. Used for linkers.</li> -<li><tt class="docutils literal"><span class="pre">sink</span></tt> - all command-line options that are not handled by other -tools are passed to this tool.</li> -<li><tt class="docutils literal"><span class="pre">actions</span></tt> - A single big <tt class="docutils literal"><span class="pre">case</span></tt> expression that specifies how -this tool reacts on command-line options (described in more detail -<a class="reference internal" href="#actions">below</a>).</li> +<li><tt class="docutils literal">in_language</tt> - input language name. Can be given multiple arguments, in +case the tool supports multiple input languages. Used for typechecking and +mapping file extensions to tools.</li> +<li><tt class="docutils literal">out_language</tt> - output language name. Multiple output languages are +allowed. Used for typechecking the compilation graph.</li> +<li><tt class="docutils literal">output_suffix</tt> - output file suffix. Can also be changed dynamically, see +documentation on <a class="reference internal" href="#actions">actions</a>.</li> </ul> </li> </ul> -<div class="section" id="id5"> -<span id="actions"></span><h2><a class="toc-backref" href="#id18">Actions</a></h2> -<p>A tool often needs to react to command-line options, and this is -precisely what the <tt class="docutils literal"><span class="pre">actions</span></tt> property is for. The next example -illustrates this feature:</p> +<blockquote> +<ul class="simple"> +<li><tt class="docutils literal">command</tt> - the actual command used to run the tool. You can use output +redirection with <tt class="docutils literal">></tt>, hook invocations (<tt class="docutils literal">$CALL</tt>), environment variables +(via <tt class="docutils literal">$ENV</tt>) and the <tt class="docutils literal">case</tt> construct.</li> +<li><tt class="docutils literal">join</tt> - this tool is a "join node" in the graph, i.e. it gets a list of +input files and joins them together. Used for linkers.</li> +<li><tt class="docutils literal">sink</tt> - all command-line options that are not handled by other tools are +passed to this tool.</li> +<li><tt class="docutils literal">actions</tt> - A single big <tt class="docutils literal">case</tt> expression that specifies how this tool +reacts on command-line options (described in more detail <a class="reference internal" href="#actions">below</a>).</li> +</ul> +</blockquote> +<blockquote> +<ul class="simple"> +<li><tt class="docutils literal">out_file_option</tt>, <tt class="docutils literal">in_file_option</tt> - Options appended to the +<tt class="docutils literal">command</tt> string to designate output and input files. Default values are +<tt class="docutils literal"><span class="pre">"-o"</span></tt> and <tt class="docutils literal">""</tt>, respectively.</li> +</ul> +</blockquote> +<div class="section" id="id4"> +<span id="actions"></span><h2><a class="toc-backref" href="#id15">Actions</a></h2> +<p>A tool often needs to react to command-line options, and this is precisely what +the <tt class="docutils literal">actions</tt> property is for. The next example illustrates this feature:</p> <pre class="literal-block"> def llvm_gcc_linker : Tool<[ (in_language "object-code"), (out_language "executable"), (output_suffix "out"), - (cmd_line "llvm-gcc $INFILE -o $OUTFILE"), + (command "llvm-gcc"), (join), (actions (case (not_empty "L"), (forward "L"), (not_empty "l"), (forward "l"), @@ -540,47 +494,46 @@ def llvm_gcc_linker : Tool<[ [(append_cmd "-dummy1"), (append_cmd "-dummy2")]) ]>; </pre> -<p>The <tt class="docutils literal"><span class="pre">actions</span></tt> tool property is implemented on top of the omnipresent -<tt class="docutils literal"><span class="pre">case</span></tt> expression. It associates one or more different <em>actions</em> -with given conditions - in the example, the actions are <tt class="docutils literal"><span class="pre">forward</span></tt>, -which forwards a given option unchanged, and <tt class="docutils literal"><span class="pre">append_cmd</span></tt>, which -appends a given string to the tool execution command. Multiple actions -can be associated with a single condition by using a list of actions -(used in the example to append some dummy options). The same <tt class="docutils literal"><span class="pre">case</span></tt> -construct can also be used in the <tt class="docutils literal"><span class="pre">cmd_line</span></tt> property to modify the -tool command line.</p> -<p>The "join" property used in the example means that this tool behaves -like a linker.</p> +<p>The <tt class="docutils literal">actions</tt> tool property is implemented on top of the omnipresent <tt class="docutils literal">case</tt> +expression. It associates one or more different <em>actions</em> with given +conditions - in the example, the actions are <tt class="docutils literal">forward</tt>, which forwards a given +option unchanged, and <tt class="docutils literal">append_cmd</tt>, which appends a given string to the tool +execution command. Multiple actions can be associated with a single condition by +using a list of actions (used in the example to append some dummy options). The +same <tt class="docutils literal">case</tt> construct can also be used in the <tt class="docutils literal">cmd_line</tt> property to modify +the tool command line.</p> +<p>The "join" property used in the example means that this tool behaves like a +linker.</p> <p>The list of all possible actions follows.</p> <ul> <li><p class="first">Possible actions:</p> <blockquote> <ul class="simple"> -<li><tt class="docutils literal"><span class="pre">append_cmd</span></tt> - Append a string to the tool invocation command. -Example: <tt class="docutils literal"><span class="pre">(case</span> <span class="pre">(switch_on</span> <span class="pre">"pthread"),</span> <span class="pre">(append_cmd</span> <span class="pre">"-lpthread"))</span></tt>.</li> -<li><tt class="docutils literal"><span class="pre">error</span></tt> - Exit with error. -Example: <tt class="docutils literal"><span class="pre">(error</span> <span class="pre">"Mixing</span> <span class="pre">-c</span> <span class="pre">and</span> <span class="pre">-S</span> <span class="pre">is</span> <span class="pre">not</span> <span class="pre">allowed!")</span></tt>.</li> -<li><tt class="docutils literal"><span class="pre">warning</span></tt> - Print a warning. -Example: <tt class="docutils literal"><span class="pre">(warning</span> <span class="pre">"Specifying</span> <span class="pre">both</span> <span class="pre">-O1</span> <span class="pre">and</span> <span class="pre">-O2</span> <span class="pre">is</span> <span class="pre">meaningless!")</span></tt>.</li> -<li><tt class="docutils literal"><span class="pre">forward</span></tt> - Forward the option unchanged. -Example: <tt class="docutils literal"><span class="pre">(forward</span> <span class="pre">"Wall")</span></tt>.</li> -<li><tt class="docutils literal"><span class="pre">forward_as</span></tt> - Change the option's name, but forward the argument +<li><tt class="docutils literal">append_cmd</tt> - Append a string to the tool invocation command. +Example: <tt class="docutils literal">(case (switch_on <span class="pre">"pthread"),</span> (append_cmd <span class="pre">"-lpthread"))</span></tt>.</li> +<li><tt class="docutils literal">error</tt> - Exit with error. +Example: <tt class="docutils literal">(error "Mixing <span class="pre">-c</span> and <span class="pre">-S</span> is not <span class="pre">allowed!")</span></tt>.</li> +<li><tt class="docutils literal">warning</tt> - Print a warning. +Example: <tt class="docutils literal">(warning "Specifying both <span class="pre">-O1</span> and <span class="pre">-O2</span> is <span class="pre">meaningless!")</span></tt>.</li> +<li><tt class="docutils literal">forward</tt> - Forward the option unchanged. +Example: <tt class="docutils literal">(forward "Wall")</tt>.</li> +<li><tt class="docutils literal">forward_as</tt> - Change the option's name, but forward the argument unchanged. -Example: <tt class="docutils literal"><span class="pre">(forward_as</span> <span class="pre">"O0",</span> <span class="pre">"--disable-optimization")</span></tt>.</li> -<li><tt class="docutils literal"><span class="pre">forward_value</span></tt> - Forward only option's value. Cannot be used with switch +Example: <tt class="docutils literal">(forward_as "O0", <span class="pre">"--disable-optimization")</span></tt>.</li> +<li><tt class="docutils literal">forward_value</tt> - Forward only option's value. Cannot be used with switch options (since they don't have values), but works fine with lists. -Example: <tt class="docutils literal"><span class="pre">(forward_value</span> <span class="pre">"Wa,")</span></tt>.</li> -<li><tt class="docutils literal"><span class="pre">forward_transformed_value</span></tt> - As above, but applies a hook to the +Example: <tt class="docutils literal">(forward_value <span class="pre">"Wa,")</span></tt>.</li> +<li><tt class="docutils literal">forward_transformed_value</tt> - As above, but applies a hook to the option's value before forwarding (see <a class="reference internal" href="#hooks">below</a>). When -<tt class="docutils literal"><span class="pre">forward_transformed_value</span></tt> is applied to a list +<tt class="docutils literal">forward_transformed_value</tt> is applied to a list option, the hook must have signature -<tt class="docutils literal"><span class="pre">std::string</span> <span class="pre">hooks::HookName</span> <span class="pre">(const</span> <span class="pre">std::vector<std::string>&)</span></tt>. -Example: <tt class="docutils literal"><span class="pre">(forward_transformed_value</span> <span class="pre">"m",</span> <span class="pre">"ConvertToMAttr")</span></tt>.</li> -<li><tt class="docutils literal"><span class="pre">output_suffix</span></tt> - Modify the output suffix of this tool. -Example: <tt class="docutils literal"><span class="pre">(output_suffix</span> <span class="pre">"i")</span></tt>.</li> -<li><tt class="docutils literal"><span class="pre">stop_compilation</span></tt> - Stop compilation after this tool processes its +<tt class="docutils literal"><span class="pre">std::string</span> <span class="pre">hooks::HookName</span> (const <span class="pre">std::vector<std::string>&)</span></tt>. +Example: <tt class="docutils literal">(forward_transformed_value "m", "ConvertToMAttr")</tt>.</li> +<li><tt class="docutils literal">output_suffix</tt> - Modify the output suffix of this tool. +Example: <tt class="docutils literal">(output_suffix "i")</tt>.</li> +<li><tt class="docutils literal">stop_compilation</tt> - Stop compilation after this tool processes its input. Used without arguments. -Example: <tt class="docutils literal"><span class="pre">(stop_compilation)</span></tt>.</li> +Example: <tt class="docutils literal">(stop_compilation)</tt>.</li> </ul> </blockquote> </li> @@ -588,11 +541,11 @@ Example: <tt class="docutils literal"><span class="pre">(stop_compilation)</span </div> </div> <div class="section" id="language-map"> -<h1><a class="toc-backref" href="#id19">Language map</a></h1> -<p>If you are adding support for a new language to LLVMC, you'll need to -modify the language map, which defines mappings from file extensions -to language names. It is used to choose the proper toolchain(s) for a -given input file set. Language map definition looks like this:</p> +<h1><a class="toc-backref" href="#id16">Language map</a></h1> +<p>If you are adding support for a new language to LLVMC, you'll need to modify the +language map, which defines mappings from file extensions to language names. It +is used to choose the proper toolchain(s) for a given input file set. Language +map definition looks like this:</p> <pre class="literal-block"> def LanguageMap : LanguageMap< [LangToSuffixes<"c++", ["cc", "cp", "cxx", "cpp", "CPP", "c++", "C"]>, @@ -606,73 +559,69 @@ $ llvmc hello.cpp llvmc: Unknown suffix: cpp </pre> <p>The language map entries are needed only for the tools that are linked from the -root node. Since a tool can't have multiple output languages, for inner nodes of -the graph the input and output languages should match. This is enforced at -compile-time.</p> +root node. A tool can have multiple output languages.</p> </div> <div class="section" id="option-preprocessor"> -<h1><a class="toc-backref" href="#id20">Option preprocessor</a></h1> +<h1><a class="toc-backref" href="#id17">Option preprocessor</a></h1> <p>It is sometimes useful to run error-checking code before processing the compilation graph. For example, if optimization options "-O1" and "-O2" are implemented as switches, we might want to output a warning if the user invokes the driver with both of these options enabled.</p> -<p>The <tt class="docutils literal"><span class="pre">OptionPreprocessor</span></tt> feature is reserved specially for these -occasions. Example (adapted from the built-in Base plugin):</p> +<p>The <tt class="docutils literal">OptionPreprocessor</tt> feature is reserved specially for these +occasions. Example (adapted from <tt class="docutils literal">llvm/src/Base.td.in</tt>):</p> <pre class="literal-block"> def Preprocess : OptionPreprocessor< -(case (not (any_switch_on ["O0", "O1", "O2", "O3"])), +(case (not (any_switch_on "O0", "O1", "O2", "O3")), (set_option "O2"), - (and (switch_on "O3"), (any_switch_on ["O0", "O1", "O2"])), - (unset_option ["O0", "O1", "O2"]), - (and (switch_on "O2"), (any_switch_on ["O0", "O1"])), - (unset_option ["O0", "O1"]), + (and (switch_on "O3"), (any_switch_on "O0", "O1", "O2")), + (unset_option "O0", "O1", "O2"), + (and (switch_on "O2"), (any_switch_on "O0", "O1")), + (unset_option "O0", "O1"), (and (switch_on "O1"), (switch_on "O0")), (unset_option "O0")) >; </pre> -<p>Here, <tt class="docutils literal"><span class="pre">OptionPreprocessor</span></tt> is used to unset all spurious <tt class="docutils literal"><span class="pre">-O</span></tt> options so +<p>Here, <tt class="docutils literal">OptionPreprocessor</tt> is used to unset all spurious <tt class="docutils literal"><span class="pre">-O</span></tt> options so that they are not forwarded to the compiler. If no optimization options are specified, <tt class="docutils literal"><span class="pre">-O2</span></tt> is enabled.</p> -<p><tt class="docutils literal"><span class="pre">OptionPreprocessor</span></tt> is basically a single big <tt class="docutils literal"><span class="pre">case</span></tt> expression, which is -evaluated only once right after the plugin is loaded. The only allowed actions -in <tt class="docutils literal"><span class="pre">OptionPreprocessor</span></tt> are <tt class="docutils literal"><span class="pre">error</span></tt>, <tt class="docutils literal"><span class="pre">warning</span></tt>, and two special actions: -<tt class="docutils literal"><span class="pre">unset_option</span></tt> and <tt class="docutils literal"><span class="pre">set_option</span></tt>. As their names suggest, they can be used to -set or unset a given option. To set an option with <tt class="docutils literal"><span class="pre">set_option</span></tt>, use the -two-argument form: <tt class="docutils literal"><span class="pre">(set_option</span> <span class="pre">"parameter",</span> <span class="pre">VALUE)</span></tt>. Here, <tt class="docutils literal"><span class="pre">VALUE</span></tt> can be +<p><tt class="docutils literal">OptionPreprocessor</tt> is basically a single big <tt class="docutils literal">case</tt> expression, which is +evaluated only once right after the driver is started. The only allowed actions +in <tt class="docutils literal">OptionPreprocessor</tt> are <tt class="docutils literal">error</tt>, <tt class="docutils literal">warning</tt>, and two special actions: +<tt class="docutils literal">unset_option</tt> and <tt class="docutils literal">set_option</tt>. As their names suggest, they can be used to +set or unset a given option. To set an option with <tt class="docutils literal">set_option</tt>, use the +two-argument form: <tt class="docutils literal">(set_option "parameter", VALUE)</tt>. Here, <tt class="docutils literal">VALUE</tt> can be either a string, a string list, or a boolean constant.</p> -<p>For convenience, <tt class="docutils literal"><span class="pre">set_option</span></tt> and <tt class="docutils literal"><span class="pre">unset_option</span></tt> also work on lists. That -is, instead of <tt class="docutils literal"><span class="pre">[(unset_option</span> <span class="pre">"A"),</span> <span class="pre">(unset_option</span> <span class="pre">"B")]</span></tt> you can use -<tt class="docutils literal"><span class="pre">(unset_option</span> <span class="pre">["A",</span> <span class="pre">"B"])</span></tt>. Obviously, <tt class="docutils literal"><span class="pre">(set_option</span> <span class="pre">["A",</span> <span class="pre">"B"])</span></tt> is valid -only if both <tt class="docutils literal"><span class="pre">A</span></tt> and <tt class="docutils literal"><span class="pre">B</span></tt> are switches.</p> +<p>For convenience, <tt class="docutils literal">set_option</tt> and <tt class="docutils literal">unset_option</tt> also work with multiple +arguments. That is, instead of <tt class="docutils literal">[(unset_option <span class="pre">"A"),</span> (unset_option <span class="pre">"B")]</span></tt> you +can use <tt class="docutils literal">(unset_option "A", "B")</tt>. Obviously, <tt class="docutils literal">(set_option "A", "B")</tt> is +only valid if both <tt class="docutils literal">A</tt> and <tt class="docutils literal">B</tt> are switches.</p> </div> <div class="section" id="more-advanced-topics"> -<h1><a class="toc-backref" href="#id21">More advanced topics</a></h1> +<h1><a class="toc-backref" href="#id18">More advanced topics</a></h1> <div class="section" id="hooks-and-environment-variables"> -<span id="hooks"></span><h2><a class="toc-backref" href="#id22">Hooks and environment variables</a></h2> -<p>Normally, LLVMC executes programs from the system <tt class="docutils literal"><span class="pre">PATH</span></tt>. Sometimes, -this is not sufficient: for example, we may want to specify tool paths -or names in the configuration file. This can be easily achieved via -the hooks mechanism. To write your own hooks, just add their -definitions to the <tt class="docutils literal"><span class="pre">PluginMain.cpp</span></tt> or drop a <tt class="docutils literal"><span class="pre">.cpp</span></tt> file into the -your plugin directory. Hooks should live in the <tt class="docutils literal"><span class="pre">hooks</span></tt> namespace -and have the signature <tt class="docutils literal"><span class="pre">std::string</span> <span class="pre">hooks::MyHookName</span> <span class="pre">([const</span> <span class="pre">char*</span> -<span class="pre">Arg0</span> <span class="pre">[</span> <span class="pre">const</span> <span class="pre">char*</span> <span class="pre">Arg2</span> <span class="pre">[,</span> <span class="pre">...]]])</span></tt>. They can be used from the -<tt class="docutils literal"><span class="pre">cmd_line</span></tt> tool property:</p> +<span id="hooks"></span><h2><a class="toc-backref" href="#id19">Hooks and environment variables</a></h2> +<p>Normally, LLVMC searches for programs in the system <tt class="docutils literal">PATH</tt>. Sometimes, this is +not sufficient: for example, we may want to specify tool paths or names in the +configuration file. This can be achieved via the hooks mechanism. To write your +own hooks, add their definitions to the <tt class="docutils literal">Hooks.cpp</tt> or drop a <tt class="docutils literal">.cpp</tt> file +into your driver directory. Hooks should live in the <tt class="docutils literal">hooks</tt> namespace and +have the signature <tt class="docutils literal"><span class="pre">std::string</span> <span class="pre">hooks::MyHookName</span> ([const char* Arg0 [ const +char* Arg2 [, <span class="pre">...]]])</span></tt>. They can be used from the <tt class="docutils literal">command</tt> tool property:</p> <pre class="literal-block"> -(cmd_line "$CALL(MyHook)/path/to/file -o $CALL(AnotherHook)") +(command "$CALL(MyHook)/path/to/file -o $CALL(AnotherHook)") </pre> <p>To pass arguments to hooks, use the following syntax:</p> <pre class="literal-block"> -(cmd_line "$CALL(MyHook, 'Arg1', 'Arg2', 'Arg # 3')/path/to/file -o1 -o2") +(command "$CALL(MyHook, 'Arg1', 'Arg2', 'Arg # 3')/path/to/file -o1 -o2") </pre> <p>It is also possible to use environment variables in the same manner:</p> <pre class="literal-block"> -(cmd_line "$ENV(VAR1)/path/to/file -o $ENV(VAR2)") +(command "$ENV(VAR1)/path/to/file -o $ENV(VAR2)") </pre> <p>To change the command line string based on user-provided options use -the <tt class="docutils literal"><span class="pre">case</span></tt> expression (documented <a class="reference internal" href="#case">above</a>):</p> +the <tt class="docutils literal">case</tt> expression (documented <a class="reference internal" href="#case">above</a>):</p> <pre class="literal-block"> -(cmd_line +(command (case (switch_on "E"), "llvm-g++ -E -x c $INFILE -o $OUTFILE", @@ -680,41 +629,23 @@ the <tt class="docutils literal"><span class="pre">case</span></tt> expression ( "llvm-g++ -c -x c $INFILE -o $OUTFILE -emit-llvm")) </pre> </div> -<div class="section" id="how-plugins-are-loaded"> -<span id="priorities"></span><h2><a class="toc-backref" href="#id23">How plugins are loaded</a></h2> -<p>It is possible for LLVMC plugins to depend on each other. For example, -one can create edges between nodes defined in some other plugin. To -make this work, however, that plugin should be loaded first. To -achieve this, the concept of plugin priority was introduced. By -default, every plugin has priority zero; to specify the priority -explicitly, put the following line in your plugin's TableGen file:</p> -<pre class="literal-block"> -def Priority : PluginPriority<$PRIORITY_VALUE>; -# Where PRIORITY_VALUE is some integer > 0 -</pre> -<p>Plugins are loaded in order of their (increasing) priority, starting -with 0. Therefore, the plugin with the highest priority value will be -loaded last.</p> -</div> <div class="section" id="debugging"> -<h2><a class="toc-backref" href="#id24">Debugging</a></h2> -<p>When writing LLVMC plugins, it can be useful to get a visual view of -the resulting compilation graph. This can be achieved via the command -line option <tt class="docutils literal"><span class="pre">--view-graph</span></tt>. This command assumes that <a class="reference external" href="http://www.graphviz.org/">Graphviz</a> and -<a class="reference external" href="http://pages.cs.wisc.edu/~ghost/">Ghostview</a> are installed. There is also a <tt class="docutils literal"><span class="pre">--write-graph</span></tt> option that -creates a Graphviz source file (<tt class="docutils literal"><span class="pre">compilation-graph.dot</span></tt>) in the -current directory.</p> -<p>Another useful <tt class="docutils literal"><span class="pre">llvmc</span></tt> option is <tt class="docutils literal"><span class="pre">--check-graph</span></tt>. It checks the -compilation graph for common errors like mismatched output/input -language names, multiple default edges and cycles. These checks can't -be performed at compile-time because the plugins can load code -dynamically. When invoked with <tt class="docutils literal"><span class="pre">--check-graph</span></tt>, <tt class="docutils literal"><span class="pre">llvmc</span></tt> doesn't -perform any compilation tasks and returns the number of encountered -errors as its status code.</p> +<h2><a class="toc-backref" href="#id20">Debugging</a></h2> +<p>When writing LLVMC-based drivers, it can be useful to get a visual view of the +resulting compilation graph. This can be achieved via the command line option +<tt class="docutils literal"><span class="pre">--view-graph</span></tt> (which assumes that <a class="reference external" href="http://www.graphviz.org/">Graphviz</a> and <a class="reference external" href="http://pages.cs.wisc.edu/~ghost/">Ghostview</a> are +installed). There is also a <tt class="docutils literal"><span class="pre">--write-graph</span></tt> option that creates a Graphviz +source file (<tt class="docutils literal"><span class="pre">compilation-graph.dot</span></tt>) in the current directory.</p> +<p>Another useful <tt class="docutils literal">llvmc</tt> option is <tt class="docutils literal"><span class="pre">--check-graph</span></tt>. It checks the compilation +graph for common errors like mismatched output/input language names, multiple +default edges and cycles. When invoked with <tt class="docutils literal"><span class="pre">--check-graph</span></tt>, <tt class="docutils literal">llvmc</tt> doesn't +perform any compilation tasks and returns the number of encountered errors as +its status code. In the future, these checks will be performed at compile-time +and this option will disappear.</p> </div> <div class="section" id="conditioning-on-the-executable-name"> -<h2><a class="toc-backref" href="#id25">Conditioning on the executable name</a></h2> -<p>For now, the executable name (the value passed to the driver in <tt class="docutils literal"><span class="pre">argv[0]</span></tt>) is +<h2><a class="toc-backref" href="#id21">Conditioning on the executable name</a></h2> +<p>For now, the executable name (the value passed to the driver in <tt class="docutils literal">argv[0]</tt>) is accessible only in the C++ code (i.e. hooks). Use the following code:</p> <pre class="literal-block"> namespace llvmc { @@ -734,8 +665,8 @@ if (strcmp(ProgramName, "mydriver") == 0) { </pre> <p>In general, you're encouraged not to make the behaviour dependent on the executable file name, and use command-line switches instead. See for example how -the <tt class="docutils literal"><span class="pre">Base</span></tt> plugin behaves when it needs to choose the correct linker options -(think <tt class="docutils literal"><span class="pre">g++</span></tt> vs. <tt class="docutils literal"><span class="pre">gcc</span></tt>).</p> +the <tt class="docutils literal">llvmc</tt> program behaves when it needs to choose the correct linker options +(think <tt class="docutils literal">g++</tt> vs. <tt class="docutils literal">gcc</tt>).</p> <hr /> <address> <a href="http://jigsaw.w3.org/css-validator/check/referer"> @@ -748,7 +679,7 @@ the <tt class="docutils literal"><span class="pre">Base</span></tt> plugin behav <a href="mailto:foldr@codedgers.com">Mikhail Glushenkov</a><br /> <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br /> -Last modified: $Date: 2010-05-07 02:28:04 +0200 (Fri, 07 May 2010) $ +Last modified: $Date: 2011-04-24 16:17:37 +0200 (Sun, 24 Apr 2011) $ </address></div> </div> </div> diff --git a/docs/CompilerDriverTutorial.html b/docs/CompilerDriverTutorial.html index 317b1d127127..4ed373aa160a 100644 --- a/docs/CompilerDriverTutorial.html +++ b/docs/CompilerDriverTutorial.html @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<meta name="generator" content="Docutils 0.5: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.6: http://docutils.sourceforge.net/" /> <title>Tutorial - Using LLVMC</title> <link rel="stylesheet" href="llvm.css" type="text/css" /> </head> @@ -18,7 +18,7 @@ The ReST source lives in the directory 'tools/llvmc/doc'. --> <p class="topic-title first">Contents</p> <ul class="simple"> <li><a class="reference internal" href="#introduction" id="id1">Introduction</a></li> -<li><a class="reference internal" href="#compiling-with-llvmc" id="id2">Compiling with LLVMC</a></li> +<li><a class="reference internal" href="#using-the-llvmc-program" id="id2">Using the <tt class="docutils literal">llvmc</tt> program</a></li> <li><a class="reference internal" href="#using-llvmc-to-generate-toolchain-drivers" id="id3">Using LLVMC to generate toolchain drivers</a></li> </ul> </div> @@ -26,51 +26,47 @@ The ReST source lives in the directory 'tools/llvmc/doc'. --> <p>Written by <a href="mailto:foldr@codedgers.com">Mikhail Glushenkov</a></p> </div><div class="section" id="introduction"> <h1><a class="toc-backref" href="#id1">Introduction</a></h1> -<p>LLVMC is a generic compiler driver, which plays the same role for LLVM -as the <tt class="docutils literal"><span class="pre">gcc</span></tt> program does for GCC - the difference being that LLVMC -is designed to be more adaptable and easier to customize. Most of -LLVMC functionality is implemented via plugins, which can be loaded -dynamically or compiled in. This tutorial describes the basic usage -and configuration of LLVMC.</p> +<p>LLVMC is a generic compiler driver, which plays the same role for LLVM as the +<tt class="docutils literal">gcc</tt> program does for GCC - the difference being that LLVMC is designed to be +more adaptable and easier to customize. Most of LLVMC functionality is +implemented via high-level TableGen code, from which a corresponding C++ source +file is automatically generated. This tutorial describes the basic usage and +configuration of LLVMC.</p> </div> -<div class="section" id="compiling-with-llvmc"> -<h1><a class="toc-backref" href="#id2">Compiling with LLVMC</a></h1> -<p>In general, LLVMC tries to be command-line compatible with <tt class="docutils literal"><span class="pre">gcc</span></tt> as -much as possible, so most of the familiar options work:</p> +<div class="section" id="using-the-llvmc-program"> +<h1><a class="toc-backref" href="#id2">Using the <tt class="docutils literal">llvmc</tt> program</a></h1> +<p>In general, <tt class="docutils literal">llvmc</tt> tries to be command-line compatible with <tt class="docutils literal">gcc</tt> as much +as possible, so most of the familiar options work:</p> <pre class="literal-block"> $ llvmc -O3 -Wall hello.cpp $ ./a.out hello </pre> -<p>This will invoke <tt class="docutils literal"><span class="pre">llvm-g++</span></tt> under the hood (you can see which -commands are executed by using the <tt class="docutils literal"><span class="pre">-v</span></tt> option). For further help on -command-line LLVMC usage, refer to the <tt class="docutils literal"><span class="pre">llvmc</span> <span class="pre">--help</span></tt> output.</p> +<p>This will invoke <tt class="docutils literal"><span class="pre">llvm-g++</span></tt> under the hood (you can see which commands are +executed by using the <tt class="docutils literal"><span class="pre">-v</span></tt> option). For further help on command-line LLVMC +usage, refer to the <tt class="docutils literal">llvmc <span class="pre">--help</span></tt> output.</p> </div> <div class="section" id="using-llvmc-to-generate-toolchain-drivers"> <h1><a class="toc-backref" href="#id3">Using LLVMC to generate toolchain drivers</a></h1> -<p>LLVMC plugins are written mostly using <a class="reference external" href="http://llvm.org/docs/TableGenFundamentals.html">TableGen</a>, so you need to -be familiar with it to get anything done.</p> -<p>Start by compiling <tt class="docutils literal"><span class="pre">example/Simple</span></tt>, which is a primitive wrapper for -<tt class="docutils literal"><span class="pre">gcc</span></tt>:</p> +<p>LLVMC-based drivers are written mostly using <a class="reference external" href="http://llvm.org/docs/TableGenFundamentals.html">TableGen</a>, so you need to be +familiar with it to get anything done.</p> +<p>Start by compiling <tt class="docutils literal">example/Simple</tt>, which is a primitive wrapper for +<tt class="docutils literal">gcc</tt>:</p> <pre class="literal-block"> -$ cd $LLVM_DIR/tools/llvmc -$ cp -r example/Simple plugins/Simple - - # NB: A less verbose way to compile standalone LLVMC-based drivers is - # described in the reference manual. - -$ make LLVMC_BASED_DRIVER_NAME=mygcc LLVMC_BUILTIN_PLUGINS=Simple +$ cd $LLVM_OBJ_DIR/tools/examples/Simple +$ make $ cat > hello.c -[...] -$ mygcc hello.c +#include <stdio.h> +int main() { printf("Hello\n"); } +$ $LLVM_BIN_DIR/Simple -v hello.c +gcc hello.c -o hello.out $ ./hello.out Hello </pre> -<p>Here we link our plugin with the LLVMC core statically to form an executable -file called <tt class="docutils literal"><span class="pre">mygcc</span></tt>. It is also possible to build our plugin as a dynamic -library to be loaded by the <tt class="docutils literal"><span class="pre">llvmc</span></tt> executable (or any other LLVMC-based -standalone driver); this is described in the reference manual.</p> -<p>Contents of the file <tt class="docutils literal"><span class="pre">Simple.td</span></tt> look like this:</p> +<p>We have thus produced a simple driver called, appropriately, <tt class="docutils literal">Simple</tt>, from +the input TableGen file <tt class="docutils literal">Simple.td</tt>. The <tt class="docutils literal">llvmc</tt> program itself is generated +using a similar process (see <tt class="docutils literal">llvmc/src</tt>). Contents of the file <tt class="docutils literal">Simple.td</tt> +look like this:</p> <pre class="literal-block"> // Include common definitions include "llvm/CompilerDriver/Common.td" @@ -80,33 +76,36 @@ def gcc : Tool< [(in_language "c"), (out_language "executable"), (output_suffix "out"), - (cmd_line "gcc $INFILE -o $OUTFILE"), - (sink) + (command "gcc"), + (sink), + + // -o is what is used by default, out_file_option here is included for + // instructive purposes. + (out_file_option "-o") ]>; // Language map -def LanguageMap : LanguageMap<[LangToSuffixes<"c", ["c"]>]>; +def LanguageMap : LanguageMap<[(lang_to_suffixes "c", "c")]>; // Compilation graph -def CompilationGraph : CompilationGraph<[Edge<"root", "gcc">]>; +def CompilationGraph : CompilationGraph<[(edge "root", "gcc")]>; </pre> -<p>As you can see, this file consists of three parts: tool descriptions, -language map, and the compilation graph definition.</p> -<p>At the heart of LLVMC is the idea of a compilation graph: vertices in -this graph are tools, and edges represent a transformation path -between two tools (for example, assembly source produced by the -compiler can be transformed into executable code by an assembler). The -compilation graph is basically a list of edges; a special node named -<tt class="docutils literal"><span class="pre">root</span></tt> is used to mark graph entry points.</p> -<p>Tool descriptions are represented as property lists: most properties -in the example above should be self-explanatory; the <tt class="docutils literal"><span class="pre">sink</span></tt> property -means that all options lacking an explicit description should be -forwarded to this tool.</p> -<p>The <tt class="docutils literal"><span class="pre">LanguageMap</span></tt> associates a language name with a list of suffixes -and is used for deciding which toolchain corresponds to a given input -file.</p> -<p>To learn more about LLVMC customization, refer to the reference -manual and plugin source code in the <tt class="docutils literal"><span class="pre">plugins</span></tt> directory.</p> +<p>As you can see, this file consists of three parts: tool descriptions, language +map, and the compilation graph definition.</p> +<p>At the heart of LLVMC is the idea of a compilation graph: vertices in this graph +are tools, and edges represent a transformation path between two tools (for +example, assembly source produced by the compiler can be transformed into +executable code by an assembler). The compilation graph is basically a list of +edges; a special node named <tt class="docutils literal">root</tt> is used to mark graph entry points.</p> +<p>Tool descriptions are represented as property lists: most properties in the +example above should be self-explanatory; the <tt class="docutils literal">sink</tt> property means that all +options lacking an explicit description should be forwarded to this tool.</p> +<p>The <tt class="docutils literal">LanguageMap</tt> associates a language name with a list of suffixes and is +used for deciding which toolchain corresponds to a given input file.</p> +<p>To learn more about writing your own drivers with LLVMC, refer to the reference +manual and examples in the <tt class="docutils literal">examples</tt> directory. Of a particular interest is +the <tt class="docutils literal">Skeleton</tt> example, which can serve as a template for your LLVMC-based +drivers.</p> <hr /> <address> <a href="http://jigsaw.w3.org/css-validator/check/referer"> diff --git a/docs/CompilerWriterInfo.html b/docs/CompilerWriterInfo.html index 6cd9d7df509d..ed326b30eb6d 100644 --- a/docs/CompilerWriterInfo.html +++ b/docs/CompilerWriterInfo.html @@ -9,9 +9,9 @@ <body> -<div class="doc_title"> +<h1> Architecture/platform information for compiler writers -</div> +</h1> <div class="doc_warning"> <p>Note: This document is a work-in-progress. Additions and clarifications @@ -43,13 +43,15 @@ </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="hw">Hardware</a></div> +<h2><a name="hw">Hardware</a></h2> <!-- *********************************************************************** --> +<div> + <!-- ======================================================================= --> -<div class="doc_subsection"><a name="alpha">Alpha</a></div> +<h3><a name="alpha">Alpha</a></h3> -<div class="doc_text"> +<div> <ul> <li><a href="http://ftp.digital.com/pub/Digital/info/semiconductor/literature/dsc-library.html">Alpha manuals</a> @@ -58,9 +60,9 @@ href="http://ftp.digital.com/pub/Digital/info/semiconductor/literature/dsc-libra </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="arm">ARM</a></div> +<h3><a name="arm">ARM</a></h3> -<div class="doc_text"> +<div> <ul> <li><a href="http://www.arm.com/documentation/">ARM documentation</a> (<a href="http://www.arm.com/documentation/ARMProcessor_Cores/">Processor @@ -70,9 +72,9 @@ Cores</a>)</li> </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="ia64">Itanium (ia64)</a></div> +<h3><a name="ia64">Itanium (ia64)</a></h3> -<div class="doc_text"> +<div> <ul> <li><a href="http://developer.intel.com/design/itanium2/documentation.htm">Itanium documentation</a> @@ -81,9 +83,9 @@ href="http://developer.intel.com/design/itanium2/documentation.htm">Itanium docu </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="mips">MIPS</a></div> +<h3><a name="mips">MIPS</a></h3> -<div class="doc_text"> +<div> <ul> <li><a href="http://mips.com/content/Documentation/MIPSDocumentation/ProcessorArchitecture/doclibrary">MIPS @@ -92,12 +94,14 @@ Processor Architecture</a></li> </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="ppc">PowerPC</a></div> +<h3><a name="ppc">PowerPC</a></h3> + +<div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection">IBM - Official manuals and docs</div> +<h4>IBM - Official manuals and docs</h4> -<div class="doc_text"> +<div> <ul> <li><a @@ -129,9 +133,9 @@ PowerPC architecture</a></li> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection">Other documents, collections, notes</div> +<h4>Other documents, collections, notes</h4> -<div class="doc_text"> +<div> <ul> <li><a href="http://penguinppc.org/dev/#library">PowerPC ABI documents</a></li> @@ -143,10 +147,12 @@ branch stubs for powerpc64-linux (from binutils)</a></li> </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"><a name="sparc">SPARC</a></div> +<h3><a name="sparc">SPARC</a></h3> -<div class="doc_text"> +<div> <ul> <li><a href="http://www.sparc.org/resource.htm">SPARC resources</a></li> @@ -156,12 +162,14 @@ branch stubs for powerpc64-linux (from binutils)</a></li> </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="x86">X86</a></div> +<h3><a name="x86">X86</a></h3> + +<div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection">AMD - Official manuals and docs</div> +<h4>AMD - Official manuals and docs</h4> -<div class="doc_text"> +<div> <ul> <li><a href="http://www.amd.com/us-en/Processors/TechnicalResources/0,,30_182_739,00.html">AMD processor manuals</a></li> @@ -170,9 +178,9 @@ href="http://www.amd.com/us-en/Processors/TechnicalResources/0,,30_182_739,00.ht </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection">Intel - Official manuals and docs</div> +<h4>Intel - Official manuals and docs</h4> -<div class="doc_text"> +<div> <ul> <li><a href="http://developer.intel.com/design/pentium4/manuals/index_new.htm">IA-32 @@ -184,19 +192,21 @@ Itanium documentation</a></li> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection">Other x86-specific information</div> +<h4>Other x86-specific information</h4> -<div class="doc_text"> +<div> <ul> <li><a href="http://www.agner.org/assem/calling_conventions.pdf">Calling conventions for different C++ compilers and operating systems</a></li> </ul> </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"><a name="other">Other relevant lists</a></div> +<h3><a name="other">Other relevant lists</a></h3> -<div class="doc_text"> +<div> <ul> <li><a href="http://gcc.gnu.org/readings.html">GCC reading list</a></li> @@ -204,14 +214,18 @@ conventions for different C++ compilers and operating systems</a></li> </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"><a name="abi">ABI</a></div> +<h2><a name="abi">ABI</a></h2> <!-- *********************************************************************** --> +<div> + <!-- ======================================================================= --> -<div class="doc_subsection"><a name="linux">Linux</a></div> +<h3><a name="linux">Linux</a></h3> -<div class="doc_text"> +<div> <ol> <li><a href="http://www.linuxbase.org/spec/ELF/ppc64/">PowerPC 64-bit ELF ABI Supplement</a></li> @@ -219,9 +233,9 @@ Supplement</a></li> </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="osx">OS X</a></div> +<h3><a name="osx">OS X</a></h3> -<div class="doc_text"> +<div> <ol> <li><a href="http://developer.apple.com/documentation/Darwin/RuntimeArchitecture-date.html">Mach-O @@ -232,8 +246,10 @@ ABI</a></li> </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"><a name="misc">Miscellaneous resources</a></div> +<h2><a name="misc">Miscellaneous resources</a></h2> <!-- *********************************************************************** --> <ul> @@ -255,8 +271,8 @@ processors.</li> src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a> <a href="http://misha.brukman.net">Misha Brukman</a><br> - <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br> - Last modified: $Date: 2010-05-07 02:28:04 +0200 (Fri, 07 May 2010) $ + <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br> + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> diff --git a/docs/DebuggingJITedCode.html b/docs/DebuggingJITedCode.html index a9193f2f9590..fa15633fddbf 100644 --- a/docs/DebuggingJITedCode.html +++ b/docs/DebuggingJITedCode.html @@ -7,7 +7,7 @@ </head> <body> -<div class="doc_title">Debugging JITed Code With GDB</div> +<h1>Debugging JITed Code With GDB</h1> <ol> <li><a href="#example">Example usage</a></li> <li><a href="#background">Background</a></li> @@ -15,9 +15,9 @@ <div class="doc_author">Written by Reid Kleckner</div> <!--=========================================================================--> -<div class="doc_section"><a name="example">Example usage</a></div> +<h2><a name="example">Example usage</a></h2> <!--=========================================================================--> -<div class="doc_text"> +<div> <p>In order to debug code JITed by LLVM, you need GDB 7.0 or newer, which is available on most modern distributions of Linux. The version of GDB that Apple @@ -96,9 +96,9 @@ function names. </div> <!--=========================================================================--> -<div class="doc_section"><a name="background">Background</a></div> +<h2><a name="background">Background</a></h2> <!--=========================================================================--> -<div class="doc_text"> +<div> <p>Without special runtime support, debugging dynamically generated code with GDB (as well as most debuggers) can be quite painful. Debuggers generally read @@ -145,8 +145,8 @@ coordinate with GDB to get better debug information. <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="mailto:reid.kleckner@gmail.com">Reid Kleckner</a><br> - <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br> - Last modified: $Date: 2010-07-07 22:16:45 +0200 (Wed, 07 Jul 2010) $ + <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br> + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> </html> diff --git a/docs/DeveloperPolicy.html b/docs/DeveloperPolicy.html index ef99ebc9d412..c12165750668 100644 --- a/docs/DeveloperPolicy.html +++ b/docs/DeveloperPolicy.html @@ -8,7 +8,7 @@ </head> <body> -<div class="doc_title">LLVM Developer Policy</div> +<h1>LLVM Developer Policy</h1> <ol> <li><a href="#introduction">Introduction</a></li> <li><a href="#policies">Developer Policies</a> @@ -34,9 +34,9 @@ <div class="doc_author">Written by the LLVM Oversight Team</div> <!--=========================================================================--> -<div class="doc_section"><a name="introduction">Introduction</a></div> +<h2><a name="introduction">Introduction</a></h2> <!--=========================================================================--> -<div class="doc_text"> +<div> <p>This document contains the LLVM Developer Policy which defines the project's policy towards developers and their contributions. The intent of this policy is to eliminate miscommunication, rework, and confusion that might arise from @@ -63,20 +63,19 @@ </div> <!--=========================================================================--> -<div class="doc_section"><a name="policies">Developer Policies</a></div> +<h2><a name="policies">Developer Policies</a></h2> <!--=========================================================================--> -<div class="doc_text"> +<div> <p>This section contains policies that pertain to frequent LLVM developers. We always welcome <a href="#patches">one-off patches</a> from people who do not routinely contribute to LLVM, but we expect more from frequent contributors to keep the system as efficient as possible for everyone. Frequent LLVM contributors are expected to meet the following requirements in order for LLVM to maintain a high standard of quality.<p> -</div> <!-- _______________________________________________________________________ --> -<div class="doc_subsection"> <a name="informed">Stay Informed</a> </div> -<div class="doc_text"> +<h3><a name="informed">Stay Informed</a></h3> +<div> <p>Developers should stay informed by reading at least the "dev" mailing list for the projects you are interested in, such as <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">llvmdev</a> for @@ -102,9 +101,9 @@ </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsection"> <a name="patches">Making a Patch</a></div> +<h3><a name="patches">Making a Patch</a></h3> -<div class="doc_text"> +<div> <p>When making a patch for review, the goal is to make it as easy for the reviewer to read it as possible. As such, we recommend that you:</p> @@ -142,8 +141,8 @@ </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsection"> <a name="reviews">Code Reviews</a></div> -<div class="doc_text"> +<h3><a name="reviews">Code Reviews</a></h3> +<div> <p>LLVM has a code review policy. Code review is one way to increase the quality of software. We generally follow these policies:</p> @@ -174,8 +173,8 @@ </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsection"> <a name="owners">Code Owners</a></div> -<div class="doc_text"> +<h3><a name="owners">Code Owners</a></h3> +<div> <p>The LLVM Project relies on two features of its process to maintain rapid development in addition to the high quality of its source base: the @@ -225,8 +224,8 @@ </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsection"> <a name="testcases">Test Cases</a></div> -<div class="doc_text"> +<h3><a name="testcases">Test Cases</a></h3> +<div> <p>Developers are required to create test cases for any bugs fixed and any new features added. Some tips for getting your testcase approved:</p> @@ -258,8 +257,8 @@ </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsection"> <a name="quality">Quality</a></div> -<div class="doc_text"> +<h3><a name="quality">Quality</a></h3> +<div> <p>The minimum quality standards that any change must satisfy before being committed to the main development branch are:</p> @@ -318,9 +317,8 @@ </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsection"> - <a name="commitaccess">Obtaining Commit Access</a></div> -<div class="doc_text"> +<h3><a name="commitaccess">Obtaining Commit Access</a></h3> +<div> <p>We grant commit access to contributors with a track record of submitting high quality patches. If you would like commit access, please send an email to @@ -381,8 +379,8 @@ </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsection"> <a name="newwork">Making a Major Change</a></div> -<div class="doc_text"> +<h3><a name="newwork">Making a Major Change</a></h3> +<div> <p>When a developer begins a major new project with the aim of contributing it back to LLVM, s/he should inform the community with an email to the <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">llvmdev</a> @@ -410,9 +408,8 @@ </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsection"> <a name="incremental">Incremental Development</a> -</div> -<div class="doc_text"> +<h3><a name="incremental">Incremental Development</a></h3> +<div> <p>In the LLVM project, we do all significant changes as a series of incremental patches. We have a strong dislike for huge changes or long-term development branches. Long-term development branches have a number of drawbacks:</p> @@ -472,9 +469,8 @@ </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsection"><a name="attribution">Attribution of -Changes</a></div> -<div class="doc_text"> +<h3><a name="attribution">Attribution of Changes</a></h3> +<div> <p>We believe in correct attribution of contributions to their contributors. However, we do not want the source code to be littered with random attributions "this code written by J. Random Hacker" (this is noisy and @@ -486,13 +482,15 @@ Changes</a></div> <p>Overall, please do not add contributor names to the source code.</p> </div> +</div> + <!--=========================================================================--> -<div class="doc_section"> +<h2> <a name="clp">Copyright, License, and Patents</a> -</div> +</h2> <!--=========================================================================--> -<div class="doc_text"> +<div> <p>This section addresses the issues of copyright, license and patents for the LLVM project. Currently, the University of Illinois is the LLVM copyright holder and the terms of its license to LLVM users and developers is the @@ -504,11 +502,10 @@ Changes</a></div> legal matters but does not provide legal advice. We are not lawyers, please seek legal counsel from an attorney.</p> </div> -</div> <!-- _______________________________________________________________________ --> -<div class="doc_subsection"><a name="copyright">Copyright</a></div> -<div class="doc_text"> +<h3><a name="copyright">Copyright</a></h3> +<div> <p>The LLVM project does not require copyright assignments, which means that the copyright for the code in the project is held by its respective contributors @@ -530,8 +527,8 @@ Changes</a></div> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsection"><a name="license">License</a></div> -<div class="doc_text"> +<h3><a name="license">License</a></h3> +<div> <p>We intend to keep LLVM perpetually open source and to use a liberal open source license. All of the code in LLVM is available under the <a href="http://www.opensource.org/licenses/UoI-NCSA.php">University of @@ -585,8 +582,8 @@ Changes</a></div> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsection"><a name="patents">Patents</a></div> -<div class="doc_text"> +<h3><a name="patents">Patents</a></h3> +<div> <p>To the best of our knowledge, LLVM does not infringe on any patents (we have actually removed code from LLVM in the past that was found to infringe). Having code in LLVM that infringes on patents would violate an important goal @@ -602,6 +599,8 @@ Changes</a></div> details.</p> </div> +</div> + <!-- *********************************************************************** --> <hr> <address> @@ -611,8 +610,8 @@ Changes</a></div> src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a> Written by the <a href="mailto:llvm-oversight@cs.uiuc.edu">LLVM Oversight Group</a><br> - <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br> - Last modified: $Date: 2010-11-16 22:32:53 +0100 (Tue, 16 Nov 2010) $ + <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br> + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> </html> diff --git a/docs/ExceptionHandling.html b/docs/ExceptionHandling.html index 009dbb5abd53..16820f3b045b 100644 --- a/docs/ExceptionHandling.html +++ b/docs/ExceptionHandling.html @@ -11,7 +11,7 @@ <body> -<div class="doc_title">Exception Handling in LLVM</div> +<h1>Exception Handling in LLVM</h1> <table class="layout" style="width:100%"> <tr class="layout"> @@ -58,10 +58,10 @@ <!-- *********************************************************************** --> -<div class="doc_section"><a name="introduction">Introduction</a></div> +<h2><a name="introduction">Introduction</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>This document is the central repository for all information pertaining to exception handling in LLVM. It describes the format that LLVM exception @@ -70,14 +70,12 @@ provides specific examples of what exception handling information is used for in C/C++.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="itanium">Itanium ABI Zero-cost Exception Handling</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Exception handling for most programming languages is designed to recover from conditions that rarely occur during general use of an application. To that @@ -106,11 +104,11 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="sjlj">Setjmp/Longjmp Exception Handling</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Setjmp/Longjmp (SJLJ) based exception handling uses LLVM intrinsics <a href="#llvm_eh_sjlj_setjmp"><tt>llvm.eh.sjlj.setjmp</tt></a> and @@ -138,11 +136,11 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="overview">Overview</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>When an exception is thrown in LLVM code, the runtime does its best to find a handler suited to processing the circumstance.</p> @@ -185,12 +183,14 @@ </div> +</div> + <!-- ======================================================================= --> -<div class="doc_section"> +<h2> <a name="codegen">LLVM Code Generation</a> -</div> +</h2> -<div class="doc_text"> +<div> <p>At the time of this writing, only C++ exception handling support is available in LLVM. So the remainder of this document will be somewhat C++-centric.</p> @@ -200,14 +200,12 @@ we will describe the implementation of LLVM exception handling in terms of C++ examples.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="throw">Throw</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Languages that support exception handling typically provide a <tt>throw</tt> operation to initiate the exception process. Internally, a throw operation @@ -225,11 +223,11 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="try_catch">Try/Catch</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>A call within the scope of a <i>try</i> statement can potentially raise an exception. In those circumstances, the LLVM C++ front-end replaces the call @@ -313,11 +311,11 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="cleanups">Cleanups</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>To handle destructors and cleanups in <tt>try</tt> code, control may not run directly from a landing pad to the first catch. Control may actually flow @@ -332,11 +330,11 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="throw_filters">Throw Filters</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>C++ allows the specification of which exception types can be thrown from a function. To represent this a top level landing pad may exist to filter out @@ -359,11 +357,11 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="restrictions">Restrictions</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The semantics of the invoke instruction require that any exception that unwinds through an invoke call should result in a branch to the invoke's @@ -384,25 +382,25 @@ </div> +</div> + <!-- ======================================================================= --> -<div class="doc_section"> +<h2> <a name="format_common_intrinsics">Exception Handling Intrinsics</a> -</div> +</h2> -<div class="doc_text"> +<div> <p>LLVM uses several intrinsic functions (name prefixed with "llvm.eh") to provide exception handling information at various points in generated code.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsubsection"> +<h4> <a name="llvm_eh_exception">llvm.eh.exception</a> -</div> +</h4> -<div class="doc_text"> +<div> <pre> i8* %<a href="#llvm_eh_exception">llvm.eh.exception</a>() @@ -413,11 +411,11 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"> +<h4> <a name="llvm_eh_selector">llvm.eh.selector</a> -</div> +</h4> -<div class="doc_text"> +<div> <pre> i32 %<a href="#llvm_eh_selector">llvm.eh.selector</a>(i8*, i8*, ...) @@ -445,11 +443,11 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"> +<h4> <a name="llvm_eh_typeid_for">llvm.eh.typeid.for</a> -</div> +</h4> -<div class="doc_text"> +<div> <pre> i32 %<a href="#llvm_eh_typeid_for">llvm.eh.typeid.for</a>(i8*) @@ -463,11 +461,11 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"> +<h4> <a name="llvm_eh_sjlj_setjmp">llvm.eh.sjlj.setjmp</a> -</div> +</h4> -<div class="doc_text"> +<div> <pre> i32 %<a href="#llvm_eh_sjlj_setjmp">llvm.eh.sjlj.setjmp</a>(i8*) @@ -492,11 +490,11 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"> +<h4> <a name="llvm_eh_sjlj_longjmp">llvm.eh.sjlj.longjmp</a> -</div> +</h4> -<div class="doc_text"> +<div> <pre> void %<a href="#llvm_eh_sjlj_longjmp">llvm.eh.sjlj.setjmp</a>(i8*) @@ -507,16 +505,16 @@ style exception handling. The single parameter is a pointer to a buffer populated by <a href="#llvm_eh_sjlj_setjmp"> <tt>llvm.eh.sjlj.setjmp</tt></a>. The frame pointer and stack pointer - are restored from the buffer, then control is transfered to the + are restored from the buffer, then control is transferred to the destination address.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"> +<h4> <a name="llvm_eh_sjlj_lsda">llvm.eh.sjlj.lsda</a> -</div> +</h4> -<div class="doc_text"> +<div> <pre> i8* %<a href="#llvm_eh_sjlj_lsda">llvm.eh.sjlj.lsda</a>() @@ -531,11 +529,11 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"> +<h4> <a name="llvm_eh_sjlj_callsite">llvm.eh.sjlj.callsite</a> -</div> +</h4> -<div class="doc_text"> +<div> <pre> void %<a href="#llvm_eh_sjlj_callsite">llvm.eh.sjlj.callsite</a>(i32) @@ -549,11 +547,11 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"> +<h4> <a name="llvm_eh_sjlj_dispatchsetup">llvm.eh.sjlj.dispatchsetup</a> -</div> +</h4> -<div class="doc_text"> +<div> <pre> void %<a href="#llvm_eh_sjlj_dispatchsetup">llvm.eh.sjlj.dispatchsetup</a>(i32) @@ -565,24 +563,24 @@ </div> +</div> + <!-- ======================================================================= --> -<div class="doc_section"> +<h2> <a name="asm">Asm Table Formats</a> -</div> +</h2> -<div class="doc_text"> +<div> <p>There are two tables that are used by the exception handling runtime to determine which actions should take place when an exception is thrown.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="unwind_tables">Exception Handling Frame</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>An exception handling frame <tt>eh_frame</tt> is very similar to the unwind frame used by dwarf debug info. The frame contains all the information @@ -596,11 +594,11 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="exception_tables">Exception Tables</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>An exception table contains information about what actions to take when an exception is thrown in a particular part of a function's code. There is one @@ -611,12 +609,14 @@ </div> +</div> + <!-- ======================================================================= --> -<div class="doc_section"> +<h2> <a name="todo">ToDo</a> -</div> +</h2> -<div class="doc_text"> +<div> <ol> @@ -636,8 +636,8 @@ src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a> <a href="mailto:sabre@nondot.org">Chris Lattner</a><br> - <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br> - Last modified: $Date: 2010-12-10 00:05:48 +0100 (Fri, 10 Dec 2010) $ + <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br> + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> diff --git a/docs/ExtendingLLVM.html b/docs/ExtendingLLVM.html index 22375608457e..03cfa7e841ea 100644 --- a/docs/ExtendingLLVM.html +++ b/docs/ExtendingLLVM.html @@ -8,9 +8,9 @@ <body> -<div class="doc_title"> +<h1> Extending LLVM: Adding instructions, intrinsics, types, etc. -</div> +</h1> <ol> <li><a href="#introduction">Introduction and Warning</a></li> @@ -31,12 +31,12 @@ </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="introduction">Introduction and Warning</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>During the course of using LLVM, you may wish to customize it for your research project or for experimentation. At this point, you may realize that @@ -68,12 +68,12 @@ effort by doing so.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="intrinsic">Adding a new intrinsic function</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Adding a new intrinsic function to LLVM is much easier than adding a new instruction. Almost all extensions to LLVM should start as an intrinsic @@ -130,12 +130,12 @@ support for it. Generally you must do the following steps:</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="sdnode">Adding a new SelectionDAG node</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>As with intrinsics, adding a new SelectionDAG node to LLVM is much easier than adding a new instruction. New nodes are often added to help represent @@ -220,12 +220,12 @@ complicated behavior in a single node (rotate).</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="instruction">Adding a new instruction</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p><span class="doc_warning">WARNING: adding instructions changes the bitcode format, and it will take some effort to maintain compatibility with @@ -277,25 +277,23 @@ to understand this new instruction.</p> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="type">Adding a new type</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p><span class="doc_warning">WARNING: adding new types changes the bitcode format, and will break compatibility with currently-existing LLVM installations.</span> Only add new types if it is absolutely necessary.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="fund_type">Adding a fundamental type</a> -</div> +</h3> -<div class="doc_text"> +<div> <ol> @@ -317,11 +315,11 @@ installations.</span> Only add new types if it is absolutely necessary.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="derived_type">Adding a derived type</a> -</div> +</h3> -<div class="doc_text"> +<div> <ol> <li><tt>llvm/include/llvm/Type.h</tt>: @@ -373,6 +371,8 @@ void calcTypeName(const Type *Ty, </div> +</div> + <!-- *********************************************************************** --> <hr> @@ -382,9 +382,9 @@ void calcTypeName(const Type *Ty, <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">The LLVM Compiler Infrastructure</a> + <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a> <br> - Last modified: $Date: 2010-05-07 02:28:04 +0200 (Fri, 07 May 2010) $ + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> diff --git a/docs/FAQ.html b/docs/FAQ.html index 9415a902756b..20ba1d5d2912 100644 --- a/docs/FAQ.html +++ b/docs/FAQ.html @@ -12,9 +12,9 @@ </head> <body> -<div class="doc_title"> +<h1> LLVM: Frequently Asked Questions -</div> +</h1> <ol> <li><a href="#license">License</a> @@ -133,14 +133,14 @@ </ol> <div class="doc_author"> - <p>Written by <a href="http://llvm.org">The LLVM Team</a></p> + <p>Written by <a href="http://llvm.org/">The LLVM Team</a></p> </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="license">License</a> -</div> +</h2> <!-- *********************************************************************** --> <div class="question"> @@ -189,9 +189,9 @@ </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="source">Source Code</a> -</div> +</h2> <!-- *********************************************************************** --> <div class="question"> @@ -227,9 +227,9 @@ LLVM have been ported to a plethora of platforms.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="build">Build Problems</a> -</div> +</h2> <!-- *********************************************************************** --> <div class="question"> @@ -449,7 +449,9 @@ Stop. </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="felangs">Source Languages</a></div> +<h2> + <a name="felangs">Source Languages</a> +</h2> <div class="question"> <p><a name="langs">What source languages are supported?</a></p> @@ -555,9 +557,9 @@ Stop. </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="cfe">Using the GCC Front End</a> -</div> +</h2> <div class="question"> <p>When I compile software that uses a configure script, the configure script @@ -712,9 +714,9 @@ Stop. </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="cfe_code">Questions about code generated by the GCC front-end</a> -</div> +</h2> <div class="question"> <p><a name="iosinit">What is this <tt>llvm.global_ctors</tt> and @@ -930,8 +932,8 @@ F.i: <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: 2010-05-28 19:07:41 +0200 (Fri, 28 May 2010) $ + <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br> + Last modified: $Date: 2011-04-19 01:59:50 +0200 (Tue, 19 Apr 2011) $ </address> </body> diff --git a/docs/GCCFEBuildInstrs.html b/docs/GCCFEBuildInstrs.html index 0b2827c9d5c1..f502481b89ea 100644 --- a/docs/GCCFEBuildInstrs.html +++ b/docs/GCCFEBuildInstrs.html @@ -8,9 +8,9 @@ </head> <body> -<div class="doc_title"> +<h1> Building the LLVM GCC Front-End -</div> +</h1> <ol> <li><a href="#instructions">Building llvm-gcc from Source</a></li> @@ -24,10 +24,10 @@ </div> <!-- *********************************************************************** --> -<h1><a name="instructions">Building llvm-gcc from Source</a></h1> +<h2><a name="instructions">Building llvm-gcc from Source</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>This section describes how to acquire and build llvm-gcc 4.2, which is based on the GCC 4.2.1 front-end. Supported languages are Ada, C, C++, Fortran, @@ -67,10 +67,10 @@ svn co http://llvm.org/svn/llvm-project/llvm-gcc-4.2/trunk <i>dst-directory</i> </div> <!-- *********************************************************************** --> -<h1><a name="ada">Building the Ada front-end</a></h1> +<h2><a name="ada">Building the Ada front-end</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Building with support for Ada amounts to following the directions in the top-level <tt>README.LLVM</tt> file, adding ",ada" to EXTRALANGS, for example: <tt>EXTRALANGS=,ada</tt></p> @@ -100,7 +100,7 @@ top-level <tt>README.LLVM</tt> file, adding ",ada" to EXTRALANGS, for example: <li><p>Because the Ada front-end is experimental, it is wise to build the compiler with checking enabled. This causes it to run much slower, but helps catch mistakes in the compiler (please report any problems using - <a href="http://llvm.org/bugs">LLVM bugzilla</a>).</p></li> + <a href="http://llvm.org/bugs/">LLVM bugzilla</a>).</p></li> <li><p>The Ada front-end <a href="http://llvm.org/PR2007">fails to bootstrap</a>, due to lack of LLVM support for <tt>setjmp</tt>/<tt>longjmp</tt> style exception handling (used @@ -233,10 +233,10 @@ make install </div> <!-- *********************************************************************** --> -<h1><a name="fortran">Building the Fortran front-end</a></h1> +<h2><a name="fortran">Building the Fortran front-end</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>To build with support for Fortran, follow the directions in the top-level <tt>README.LLVM</tt> file, adding ",fortran" to EXTRALANGS, for example:</p> @@ -247,10 +247,10 @@ EXTRALANGS=,fortran </div> <!-- *********************************************************************** --> -<h1><a name="license">License Information</a></h1> +<h2><a name="license">License Information</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> The LLVM GCC frontend is licensed to you under the GNU General Public License and the GNU Lesser General Public License. Please see the files COPYING and @@ -271,8 +271,8 @@ More information is <a href="FAQ.html#license">available in the FAQ</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: 2010-08-31 21:40:21 +0200 (Tue, 31 Aug 2010) $ + <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br> + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> diff --git a/docs/GarbageCollection.html b/docs/GarbageCollection.html index fde070ce6b45..13a3714e8233 100644 --- a/docs/GarbageCollection.html +++ b/docs/GarbageCollection.html @@ -13,9 +13,9 @@ </head> <body> -<div class="doc_title"> +<h1> Accurate Garbage Collection with LLVM -</div> +</h1> <ol> <li><a href="#introduction">Introduction</a> @@ -79,12 +79,12 @@ </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="introduction">Introduction</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Garbage collection is a widely used technique that frees the programmer from having to know the lifetimes of heap objects, making software easier to produce @@ -124,14 +124,12 @@ techniques dominates any low-level losses.</p> <p>This document describes the mechanisms and interfaces provided by LLVM to support accurate garbage collection.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="feature">Goals and non-goals</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>LLVM's intermediate representation provides <a href="#intrinsics">garbage collection intrinsics</a> that offer support for a broad class of @@ -151,14 +149,14 @@ collector models. For instance, the intrinsics permit:</p> support a broad class of garbage collected languages including Scheme, ML, Java, C#, Perl, Python, Lua, Ruby, other scripting languages, and more.</p> -<p>However, LLVM does not itself provide a garbage collector—this should +<p>However, LLVM does not itself provide a garbage collector—this should be part of your language's runtime library. LLVM provides a framework for compile time <a href="#plugin">code generation plugins</a>. The role of these plugins is to generate code and data structures which conforms to the <em>binary interface</em> specified by the <em>runtime library</em>. This is similar to the relationship between LLVM and DWARF debugging info, for example. The difference primarily lies in the lack of an established standard in the domain -of garbage collection—thus the plugins.</p> +of garbage collection—thus the plugins.</p> <p>The aspects of the binary interface with which LLVM's GC support is concerned are:</p> @@ -198,13 +196,15 @@ compiler matures.</p> </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="quickstart">Getting started</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Using a GC with LLVM implies many things, for example:</p> @@ -246,14 +246,12 @@ compiler matures.</p> includes a highly portable, built-in ShadowStack code generator. It is compiled into <tt>llc</tt> and works even with the interpreter and C backends.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="quickstart-compiler">In your compiler</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>To turn the shadow stack on for your functions, first call:</p> @@ -276,11 +274,11 @@ switching to a more advanced GC.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="quickstart-runtime">In your runtime</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The shadow stack doesn't imply a memory allocation algorithm. A semispace collector or building atop <tt>malloc</tt> are great places to start, and can @@ -343,11 +341,11 @@ void visitGCRoots(void (*Visitor)(void **Root, const void *Meta)) { }</pre></div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="shadow-stack">About the shadow stack</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Unlike many GC algorithms which rely on a cooperative code generator to compile stack maps, this algorithm carefully maintains a linked list of stack @@ -372,13 +370,15 @@ in order to improve performance.</p> </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="core">IR features</a><a name="intrinsics"></a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>This section describes the garbage collection facilities provided by the <a href="LangRef.html">LLVM intermediate representation</a>. The exact behavior @@ -390,18 +390,16 @@ intended to be a complete interface to any garbage collector. A program will need to interface with the GC library using the facilities provided by that program.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="gcattr">Specifying GC code generation: <tt>gc "..."</tt></a> -</div> +</h3> <div class="doc_code"><tt> define <i>ty</i> @<i>name</i>(...) <span style="text-decoration: underline">gc "<i>name</i>"</span> { ... </tt></div> -<div class="doc_text"> +<div> <p>The <tt>gc</tt> function attribute is used to specify the desired GC style to the compiler. Its programmatic equivalent is the <tt>setGC</tt> method of @@ -418,15 +416,15 @@ programs that use different garbage collection algorithms (or none at all).</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="gcroot">Identifying GC roots on the stack: <tt>llvm.gcroot</tt></a> -</div> +</h3> <div class="doc_code"><tt> void @llvm.gcroot(i8** %ptrloc, i8* %metadata) </tt></div> -<div class="doc_text"> +<div> <p>The <tt>llvm.gcroot</tt> intrinsic is used to inform LLVM that a stack variable references an object on the heap and is to be tracked for garbage @@ -494,11 +492,11 @@ CodeBlock: </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="barriers">Reading and writing references in the heap</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Some collectors need to be informed when the mutator (the program that needs garbage collection) either reads a pointer from or writes a pointer to a field @@ -534,18 +532,16 @@ require the corresponding barrier. Such a GC plugin will replace the intrinsic calls with the corresponding <tt>load</tt> or <tt>store</tt> instruction if they are used.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsubsection"> +<h4> <a name="gcwrite">Write barrier: <tt>llvm.gcwrite</tt></a> -</div> +</h4> <div class="doc_code"><tt> void @llvm.gcwrite(i8* %value, i8* %object, i8** %derived) </tt></div> -<div class="doc_text"> +<div> <p>For write barriers, LLVM provides the <tt>llvm.gcwrite</tt> intrinsic function. It has exactly the same semantics as a non-volatile <tt>store</tt> to @@ -559,15 +555,15 @@ implement reference counting.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"> +<h4> <a name="gcread">Read barrier: <tt>llvm.gcread</tt></a> -</div> +</h4> <div class="doc_code"><tt> i8* @llvm.gcread(i8* %object, i8** %derived)<br> </tt></div> -<div class="doc_text"> +<div> <p>For read barriers, LLVM provides the <tt>llvm.gcread</tt> intrinsic function. It has exactly the same semantics as a non-volatile <tt>load</tt> from the @@ -580,13 +576,17 @@ writes.</p> </div> +</div> + +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="plugin">Implementing a collector plugin</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>User code specifies which GC code generation to use with the <tt>gc</tt> function attribute or, equivalently, with the <tt>setGC</tt> method of @@ -666,14 +666,12 @@ $ llvm-as < sample.ll | llc -load=MyGC.so</pre></blockquote> <p>It is also possible to statically link the collector plugin into tools, such as a language-specific compiler front-end.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="collector-algos">Overview of available features</a> -</div> +</h3> -<div class="doc_text"> +<div> <p><tt>GCStrategy</tt> provides a range of features through which a plugin may do useful work. Some of these are callbacks, some are algorithms that can @@ -958,11 +956,11 @@ interest.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="stack-map">Computing stack maps</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>LLVM automatically computes a stack map. One of the most important features of a <tt>GCStrategy</tt> is to compile this information into the executable in @@ -1014,11 +1012,11 @@ for collector plugins which implement reference counting or a shadow stack.</p> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="init-roots">Initializing roots to null: <tt>InitRoots</tt></a> -</div> +</h3> -<div class="doc_text"> +<div> <blockquote><pre >MyGC::MyGC() { @@ -1039,12 +1037,12 @@ this feature should be used by all GC plugins. It is enabled by default.</p> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="custom">Custom lowering of intrinsics: <tt>CustomRoots</tt>, <tt>CustomReadBarriers</tt>, and <tt>CustomWriteBarriers</tt></a> -</div> +</h3> -<div class="doc_text"> +<div> <p>For GCs which use barriers or unusual treatment of stack roots, these flags allow the collector to perform arbitrary transformations of the LLVM @@ -1129,11 +1127,11 @@ bool MyGC::performCustomLowering(Function &F) { <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="safe-points">Generating safe points: <tt>NeededSafePoints</tt></a> -</div> +</h3> -<div class="doc_text"> +<div> <p>LLVM can compute four kinds of safe points:</p> @@ -1193,11 +1191,11 @@ safe point (because only the topmost function has been patched).</p> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="assembly">Emitting assembly code: <tt>GCMetadataPrinter</tt></a> -</div> +</h3> -<div class="doc_text"> +<div> <p>LLVM allows a plugin to print arbitrary assembly code before and after the rest of a module's assembly code. At the end of the module, the GC can compile @@ -1341,14 +1339,15 @@ void MyGCPrinter::finishAssembly(std::ostream &OS, AsmPrinter &AP, </div> +</div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="references">References</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p><a name="appel89">[Appel89]</a> Runtime Tags Aren't Necessary. Andrew W. Appel. Lisp and Symbolic Computation 19(7):703-705, July 1989.</p> @@ -1379,8 +1378,8 @@ Fergus Henderson. International Symposium on Memory Management 2002.</p> src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a> <a href="mailto:sabre@nondot.org">Chris Lattner</a><br> - <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br> - Last modified: $Date: 2010-05-11 22:16:09 +0200 (Tue, 11 May 2010) $ + <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br> + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> diff --git a/docs/GetElementPtr.html b/docs/GetElementPtr.html index 5410137861ff..4c347a6aaf12 100644 --- a/docs/GetElementPtr.html +++ b/docs/GetElementPtr.html @@ -11,9 +11,9 @@ </head> <body> -<div class="doc_title"> +<h1> The Often Misunderstood GEP Instruction -</div> +</h1> <ol> <li><a href="#intro">Introduction</a></li> @@ -58,10 +58,10 @@ <!-- *********************************************************************** --> -<div class="doc_section"><a name="intro"><b>Introduction</b></a></div> +<h2><a name="intro">Introduction</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>This document seeks to dispel the mystery and confusion surrounding LLVM's <a href="LangRef.html#i_getelementptr">GetElementPtr</a> (GEP) instruction. Questions about the wily GEP instruction are @@ -72,21 +72,20 @@ </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="addresses"><b>Address Computation</b></a></div> +<h2><a name="addresses">Address Computation</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>When people are first confronted with the GEP instruction, they tend to relate it to known concepts from other programming paradigms, most notably C array indexing and field selection. GEP closely resembles C array indexing and field selection, however it's is a little different and this leads to the following questions.</p> -</div> <!-- *********************************************************************** --> -<div class="doc_subsection"> - <a name="firstptr"><b>What is the first index of the GEP instruction?</b></a> -</div> -<div class="doc_text"> +<h3> + <a name="firstptr">What is the first index of the GEP instruction?</a> +</h3> +<div> <p>Quick answer: The index stepping through the first operand.</p> <p>The confusion with the first index usually arises from thinking about the GetElementPtr instruction as if it was a C index operator. They aren't the @@ -205,11 +204,11 @@ idx3 = (char*) &MyVar + 8 </div> <!-- *********************************************************************** --> -<div class="doc_subsection"> - <a name="extra_index"><b>Why is the extra 0 index required?</b></a> -</div> +<h3> + <a name="extra_index">Why is the extra 0 index required?</a> +</h3> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Quick answer: there are no superfluous indices.</p> <p>This question arises most often when the GEP instruction is applied to a global variable which is always a pointer type. For example, consider @@ -247,10 +246,10 @@ idx3 = (char*) &MyVar + 8 </div> <!-- *********************************************************************** --> -<div class="doc_subsection"> - <a name="deref"><b>What is dereferenced by GEP?</b></a> -</div> -<div class="doc_text"> +<h3> + <a name="deref">What is dereferenced by GEP?</a> +</h3> +<div> <p>Quick answer: nothing.</p> <p>The GetElementPtr instruction dereferences nothing. That is, it doesn't access memory in any way. That's what the Load and Store instructions are for. @@ -302,10 +301,10 @@ idx3 = (char*) &MyVar + 8 </div> <!-- *********************************************************************** --> -<div class="doc_subsection"> - <a name="lead0"><b>Why don't GEP x,0,0,1 and GEP x,1 alias?</b></a> -</div> -<div class="doc_text"> +<h3> + <a name="lead0">Why don't GEP x,0,0,1 and GEP x,1 alias?</a> +</h3> +<div> <p>Quick Answer: They compute different address locations.</p> <p>If you look at the first indices in these GEP instructions you find that they are different (0 and 1), therefore the address @@ -331,10 +330,10 @@ idx3 = (char*) &MyVar + 8 </div> <!-- *********************************************************************** --> -<div class="doc_subsection"> - <a name="trail0"><b>Why do GEP x,1,0,0 and GEP x,1 alias?</b></a> -</div> -<div class="doc_text"> +<h3> + <a name="trail0">Why do GEP x,1,0,0 and GEP x,1 alias?</a> +</h3> +<div> <p>Quick Answer: They compute the same address location.</p> <p>These two GEP instructions will compute the same address because indexing through the 0th element does not change the address. However, it does change @@ -355,10 +354,10 @@ idx3 = (char*) &MyVar + 8 <!-- *********************************************************************** --> -<div class="doc_subsection"> - <a name="vectors"><b>Can GEP index into vector elements?</b></a> -</div> -<div class="doc_text"> +<h3> + <a name="vectors">Can GEP index into vector elements?</a> +</h3> +<div> <p>This hasn't always been forcefully disallowed, though it's not recommended. It leads to awkward special cases in the optimizers, and fundamental inconsistency in the IR. In the future, it will probably be outright @@ -368,10 +367,10 @@ idx3 = (char*) &MyVar + 8 <!-- *********************************************************************** --> -<div class="doc_subsection"> - <a name="addrspace"><b>What effect do address spaces have on GEPs?</b></a> -</div> -<div class="doc_text"> +<h3> + <a name="addrspace">What effect do address spaces have on GEPs?</a> +</h3> +<div> <p>None, except that the address space qualifier on the first operand pointer type always matches the address space qualifier on the result type.</p> @@ -379,11 +378,12 @@ idx3 = (char*) &MyVar + 8 <!-- *********************************************************************** --> -<div class="doc_subsection"> - <a name="int"><b>How is GEP different from ptrtoint, arithmetic, - and inttoptr?</b></a> -</div> -<div class="doc_text"> +<h3> + <a name="int"> + How is GEP different from ptrtoint, arithmetic, and inttoptr? + </a> +</h3> +<div> <p>It's very similar; there are only subtle differences.</p> <p>With ptrtoint, you have to pick an integer type. One approach is to pick i64; @@ -409,11 +409,13 @@ idx3 = (char*) &MyVar + 8 <!-- *********************************************************************** --> -<div class="doc_subsection"> - <a name="be"><b>I'm writing a backend for a target which needs custom - lowering for GEP. How do I do this?</b></a> -</div> -<div class="doc_text"> +<h3> + <a name="be"> + I'm writing a backend for a target which needs custom lowering for GEP. + How do I do this? + </a> +</h3> +<div> <p>You don't. The integer computation implied by a GEP is target-independent. Typically what you'll need to do is make your backend pattern-match expressions trees involving ADD, MUL, etc., which are what GEP is lowered @@ -431,10 +433,10 @@ idx3 = (char*) &MyVar + 8 <!-- *********************************************************************** --> -<div class="doc_subsection"> - <a name="vla"><b>How does VLA addressing work with GEPs?</b></a> -</div> -<div class="doc_text"> +<h3> + <a name="vla">How does VLA addressing work with GEPs?</a> +</h3> +<div> <p>GEPs don't natively support VLAs. LLVM's type system is entirely static, and GEP address computations are guided by an LLVM type.</p> @@ -450,16 +452,18 @@ idx3 = (char*) &MyVar + 8 VLA and non-VLA indexing in the same manner.</p> </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"><a name="rules"><b>Rules</b></a></div> +<h2><a name="rules">Rules</a></h2> <!-- *********************************************************************** --> - +<div> <!-- *********************************************************************** --> -<div class="doc_subsection"> - <a name="bounds"><b>What happens if an array index is out of bounds?</b></a> -</div> -<div class="doc_text"> +<h3> + <a name="bounds">What happens if an array index is out of bounds?</a> +</h3> +<div> <p>There are two senses in which an array index can be out of bounds.</p> <p>First, there's the array type which comes from the (static) type of @@ -498,20 +502,20 @@ idx3 = (char*) &MyVar + 8 </div> <!-- *********************************************************************** --> -<div class="doc_subsection"> - <a name="negative"><b>Can array indices be negative?</b></a> -</div> -<div class="doc_text"> +<h3> + <a name="negative">Can array indices be negative?</a> +</h3> +<div> <p>Yes. This is basically a special case of array indices being out of bounds.</p> </div> <!-- *********************************************************************** --> -<div class="doc_subsection"> - <a name="compare"><b>Can I compare two values computed with GEPs?</b></a> -</div> -<div class="doc_text"> +<h3> + <a name="compare">Can I compare two values computed with GEPs?</a> +</h3> +<div> <p>Yes. If both addresses are within the same allocated object, or one-past-the-end, you'll get the comparison result you expect. If either is outside of it, integer arithmetic wrapping may occur, so the @@ -520,11 +524,13 @@ idx3 = (char*) &MyVar + 8 </div> <!-- *********************************************************************** --> -<div class="doc_subsection"> - <a name="types"><b>Can I do GEP with a different pointer type than the type of - the underlying object?</b></a> -</div> -<div class="doc_text"> +<h3> + <a name="types"> + Can I do GEP with a different pointer type than the type of + the underlying object? + </a> +</h3> +<div> <p>Yes. There are no restrictions on bitcasting a pointer value to an arbitrary pointer type. The types in a GEP serve only to define the parameters for the underlying integer computation. They need not correspond with the actual @@ -538,11 +544,12 @@ idx3 = (char*) &MyVar + 8 </div> <!-- *********************************************************************** --> -<div class="doc_subsection"> - <a name="null"><b>Can I cast an object's address to integer and add it - to null?</b></a> -</div> -<div class="doc_text"> +<h3> + <a name="null"> + Can I cast an object's address to integer and add it to null? + </a> +</h3> +<div> <p>You can compute an address that way, but if you use GEP to do the add, you can't use that pointer to actually access the object, unless the object is managed outside of LLVM.</p> @@ -562,11 +569,13 @@ idx3 = (char*) &MyVar + 8 </div> <!-- *********************************************************************** --> -<div class="doc_subsection"> - <a name="ptrdiff"><b>Can I compute the distance between two objects, and add - that value to one address to compute the other address?</b></a> -</div> -<div class="doc_text"> +<h3> + <a name="ptrdiff"> + Can I compute the distance between two objects, and add + that value to one address to compute the other address? + </a> +</h3> +<div> <p>As with arithmetic on null, You can use GEP to compute an address that way, but you can't use that pointer to actually access the object if you do, unless the object is managed outside of LLVM.</p> @@ -577,10 +586,10 @@ idx3 = (char*) &MyVar + 8 </div> <!-- *********************************************************************** --> -<div class="doc_subsection"> - <a name="tbaa"><b>Can I do type-based alias analysis on LLVM IR?</b></a> -</div> -<div class="doc_text"> +<h3> + <a name="tbaa">Can I do type-based alias analysis on LLVM IR?</a> +</h3> +<div> <p>You can't do type-based alias analysis using LLVM's built-in type system, because LLVM has no restrictions on mixing types in addressing, loads or stores.</p> @@ -594,10 +603,10 @@ idx3 = (char*) &MyVar + 8 <!-- *********************************************************************** --> -<div class="doc_subsection"> - <a name="overflow"><b>What happens if a GEP computation overflows?</b></a> -</div> -<div class="doc_text"> +<h3> + <a name="overflow">What happens if a GEP computation overflows?</a> +</h3> +<div> <p>If the GEP lacks the <tt>inbounds</tt> keyword, the value is the result from evaluating the implied two's complement integer computation. However, since there's no guarantee of where an object will be allocated in the @@ -624,11 +633,12 @@ idx3 = (char*) &MyVar + 8 <!-- *********************************************************************** --> -<div class="doc_subsection"> - <a name="check"><b>How can I tell if my front-end is following the - rules?</b></a> -</div> -<div class="doc_text"> +<h3> + <a name="check"> + How can I tell if my front-end is following the rules? + </a> +</h3> +<div> <p>There is currently no checker for the getelementptr rules. Currently, the only way to do this is to manually check each place in your front-end where GetElementPtr operators are created.</p> @@ -641,16 +651,18 @@ idx3 = (char*) &MyVar + 8 </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"><a name="rationale"><b>Rationale</b></a></div> +<h2><a name="rationale">Rationale</a></h2> <!-- *********************************************************************** --> - +<div> <!-- *********************************************************************** --> -<div class="doc_subsection"> - <a name="goals"><b>Why is GEP designed this way?</b></a> -</div> -<div class="doc_text"> +<h3> + <a name="goals">Why is GEP designed this way?</a> +</h3> +<div> <p>The design of GEP has the following goals, in rough unofficial order of priority:</p> <ul> @@ -669,10 +681,10 @@ idx3 = (char*) &MyVar + 8 </div> <!-- *********************************************************************** --> -<div class="doc_subsection"> - <a name="i32"><b>Why do struct member indices always use i32?</b></a> -</div> -<div class="doc_text"> +<h3> + <a name="i32">Why do struct member indices always use i32?</a> +</h3> +<div> <p>The specific type i32 is probably just a historical artifact, however it's wide enough for all practical purposes, so there's been no need to change it. It doesn't necessarily imply i32 address arithmetic; it's just an identifier @@ -684,10 +696,10 @@ idx3 = (char*) &MyVar + 8 <!-- *********************************************************************** --> -<div class="doc_subsection"> - <a name="uglygep"><b>What's an uglygep?</b></a> -</div> -<div class="doc_text"> +<h3> + <a name="uglygep">What's an uglygep?</a> +</h3> +<div> <p>Some LLVM optimizers operate on GEPs by internally lowering them into more primitive integer expressions, which allows them to be combined with other integer expressions and/or split into multiple separate @@ -704,11 +716,13 @@ idx3 = (char*) &MyVar + 8 </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"><a name="summary"><b>Summary</b></a></div> +<h2><a name="summary">Summary</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>In summary, here's some things to always remember about the GetElementPtr instruction:</p> <ol> @@ -732,8 +746,8 @@ idx3 = (char*) &MyVar + 8 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">The LLVM Compiler Infrastructure</a><br/> - Last modified: $Date: 2011-02-11 22:50:52 +0100 (Fri, 11 Feb 2011) $ + <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br/> + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> </html> diff --git a/docs/GettingStarted.html b/docs/GettingStarted.html index dfb976a29f1e..cc5c59e78f66 100644 --- a/docs/GettingStarted.html +++ b/docs/GettingStarted.html @@ -8,9 +8,9 @@ </head> <body> -<div class="doc_title"> +<h1> Getting Started with the LLVM System -</div> +</h1> <ul> <li><a href="#overview">Overview</a> @@ -62,7 +62,7 @@ <p>Written by: <a href="mailto:criswell@uiuc.edu">John Criswell</a>, <a href="mailto:sabre@nondot.org">Chris Lattner</a>, - <a href="http://misha.brukman.net">Misha Brukman</a>, + <a href="http://misha.brukman.net/">Misha Brukman</a>, <a href="http://www.cs.uiuc.edu/~vadve">Vikram Adve</a>, and <a href="mailto:gshi1@uiuc.edu">Guochun Shi</a>. </p> @@ -70,12 +70,12 @@ <!-- *********************************************************************** --> -<div class="doc_section"> - <a name="overview"><b>Overview</b></a> -</div> +<h2> + <a name="overview">Overview</a> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Welcome to LLVM! In order to get started, you first need to know some basic information.</p> @@ -102,12 +102,12 @@ and performance. </div> <!-- *********************************************************************** --> -<div class="doc_section"> - <a name="quickstart"><b>Getting Started Quickly (A Summary)</b></a> -</div> +<h2> + <a name="quickstart">Getting Started Quickly (A Summary)</a> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Here's the short story for getting up and running quickly with LLVM:</p> @@ -116,13 +116,13 @@ and performance. <li>Read the documentation.</li> <li>Remember that you were warned twice about reading the documentation.</li> <li>Install the llvm-gcc-4.2 front end if you intend to compile C or C++ - (see <a href="#installcf">Install the GCC Front End</a> for details):</li> + (see <a href="#installcf">Install the GCC Front End</a> for details): <ol> <li><tt>cd <i>where-you-want-the-C-front-end-to-live</i></tt></li> <li><tt>gunzip --stdout llvm-gcc-4.2-<i>version</i>-<i>platform</i>.tar.gz | tar -xvf -</tt></li> <li><tt><i>install-binutils-binary-from-MinGW</i></tt> (Windows only)</li> <li>Note: If the binary extension is "<tt>.bz</tt>" use <tt>bunzip2</tt> instead of <tt>gunzip</tt>.</li> - <li>Note: On Windows, use <a href="http://www.7-zip.org">7-Zip</a> or a similar archiving tool.</li> + <li>Note: On Windows, use <a href="http://www.7-zip.org/">7-Zip</a> or a similar archiving tool.</li> <li>Add <tt>llvm-gcc</tt>'s "<tt>bin</tt>" directory to your <tt>PATH</tt> environment variable.</li> </ol></li> @@ -191,25 +191,23 @@ Layout</a> to learn about the layout of the source code tree.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"> - <a name="requirements"><b>Requirements</b></a> -</div> +<h2> + <a name="requirements">Requirements</a> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Before you begin to use the LLVM system, review the requirements given below. This may save you some trouble by knowing ahead of time what hardware and software you will need.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"> - <a name="hardware"><b>Hardware</b></a> -</div> +<h3> + <a name="hardware">Hardware</a> +</h3> -<div class="doc_text"> +<div> <p>LLVM is known to work on the following platforms:</p> @@ -268,7 +266,8 @@ software you will need.</p> <tr> <td>MinGW/Win32</td> <td>x86<sup><a href="#pf_1">1</a>,<a href="#pf_6">6</a>, - <a href="#pf_8">8</a>, <a href="#pf_10">10</a></sup></td> + <a href="#pf_8">8</a>, <a href="#pf_10">10</a>, + <a href="#pf_11">11</a></sup></td> <td>GCC 3.4.X, binutils 2.20</td> </tr> </table> @@ -311,6 +310,11 @@ software you will need.</p> <td>Itanium (IA-64)</td> <td>HP aCC</td> </tr> +<tr> + <td>Windows x64</td> + <td>x86-64</td> + <td>mingw-w64's GCC-4.5.x<sup><a href="#pf_12">12</a></sup></td> +</tr> </table> <p><b>Notes:</b></p> @@ -337,9 +341,10 @@ up</a></li> before any Windows-based versions such as Strawberry Perl and ActivePerl, as these have Windows-specifics that will cause the build to fail.</a></li> -<li><a name="pf_11">In general, LLVM modules requiring dynamic linking can - not be built on Windows. However, you can build LLVM tools using - <i>"make tools-only"</i>.</li> +<li><a name="pf_11">To use LLVM modules on Win32-based system, + you may configure LLVM with <i>"--enable-shared"</i>.</a></li> +<li><a name="pf_12">To compile SPU backend, you need to add + <tt>"LDFLAGS=-Wl,--stack,16777216"</tt> to configure.</a></li> </ol> </div> @@ -363,8 +368,10 @@ href="GCCFEBuildInstrs.html">try to compile it</a> on your platform.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="software"><b>Software</b></a></div> -<div class="doc_text"> +<h3> + <a name="software">Software</a> +</h3> +<div> <p>Compiling LLVM requires that you have several software packages installed. The table below lists those required packages. The Package column is the usual name for the software package that LLVM depends on. The Version @@ -380,13 +387,13 @@ href="GCCFEBuildInstrs.html">try to compile it</a> on your platform.</p> </tr> <tr> - <td><a href="http://gcc.gnu.org">GCC</a></td> + <td><a href="http://gcc.gnu.org/">GCC</a></td> <td>3.4.2</td> <td>C/C++ compiler<sup><a href="#sf1">1</a></sup></td> </tr> <tr> - <td><a href="http://www.gnu.org/software/texinfo">TeXinfo</a></td> + <td><a href="http://www.gnu.org/software/texinfo/">TeXinfo</a></td> <td>4.5</td> <td>For building the CFE</td> </tr> @@ -397,6 +404,11 @@ href="GCCFEBuildInstrs.html">try to compile it</a> on your platform.</p> <td>Subversion access to LLVM<sup><a href="#sf2">2</a></sup></td> </tr> + <!-- FIXME: + Do we support dg? + Are DejaGnu and expect obsolete? + Shall we mention Python? --> + <tr> <td><a href="http://savannah.gnu.org/projects/dejagnu">DejaGnu</a></td> <td>1.4.2</td> @@ -428,13 +440,13 @@ href="GCCFEBuildInstrs.html">try to compile it</a> on your platform.</p> </tr> <tr> - <td><a href="http://www.gnu.org/software/autoconf">GNU Autoconf</a></td> + <td><a href="http://www.gnu.org/software/autoconf/">GNU Autoconf</a></td> <td>2.60</td> <td>Configuration script builder<sup><a href="#sf4">4</a></sup></td> </tr> <tr> - <td><a href="http://www.gnu.org/software/automake">GNU Automake</a></td> + <td><a href="http://www.gnu.org/software/automake/">GNU Automake</a></td> <td>1.9.6</td> <td>aclocal macro generator<sup><a href="#sf4">4</a></sup></td> </tr> @@ -496,11 +508,11 @@ href="GCCFEBuildInstrs.html">try to compile it</a> on your platform.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="brokengcc">Broken versions of GCC and other tools</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>LLVM is very demanding of the host C++ compiler, and as such tends to expose bugs in the compiler. In particular, several versions of GCC crash when trying @@ -593,15 +605,15 @@ upgrading to a newer version of Gold.</p> </div> - +</div> <!-- *********************************************************************** --> -<div class="doc_section"> - <a name="starting"><b>Getting Started with LLVM</b></a> -</div> +<h2> + <a name="starting">Getting Started with LLVM</a> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>The remainder of this guide is meant to get you up and running with LLVM and to give you some basic information about the LLVM environment.</p> @@ -611,14 +623,13 @@ href="#layout">general layout</a> of the the LLVM source tree, a <a href="#tutorial">simple example</a> using the LLVM tool chain, and <a href="#links">links</a> to find more information about LLVM or to get help via e-mail.</p> -</div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="terminology">Terminology and Notation</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Throughout this manual, the following names are used to denote paths specific to the local system and working environment. <i>These are not @@ -651,11 +662,11 @@ All these paths are absolute:</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="environment">Setting Up Your Environment</a> -</div> +</h3> -<div class="doc_text"> +<div> <p> In order to compile and use LLVM, you may need to set some environment @@ -674,11 +685,11 @@ variables. </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="unpack">Unpacking the LLVM Archives</a> -</div> +</h3> -<div class="doc_text"> +<div> <p> If you have the LLVM distribution, you will need to unpack it before you @@ -708,11 +719,11 @@ compressed with the gzip program. </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="checkout">Checkout LLVM from Subversion</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>If you have access to our Subversion repository, you can get a fresh copy of the entire source code. All you need to do is check it out from Subversion as @@ -736,6 +747,7 @@ revision), you can checkout it from the '<tt>tags</tt>' directory (instead of subdirectories of the '<tt>tags</tt>' directory:</p> <ul> +<li>Release 2.9: <b>RELEASE_29/final</b></li> <li>Release 2.8: <b>RELEASE_28</b></li> <li>Release 2.7: <b>RELEASE_27</b></li> <li>Release 2.6: <b>RELEASE_26</b></li> @@ -778,30 +790,30 @@ instructions</a> to successfully get and build the LLVM GCC front-end.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="git_mirror">GIT mirror</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>GIT mirrors are available for a number of LLVM subprojects. These mirrors sync automatically with each Subversion commit and contain all necessary git-svn marks (so, you can recreate git-svn metadata locally). Note that right now mirrors reflect only <tt>trunk</tt> for each project. You can do the - read-only GIT clone of LLVM via: + read-only GIT clone of LLVM via:</p> + <pre> % git clone http://llvm.org/git/llvm.git </pre> -</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="installcf">Install the GCC Front End</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Before configuring and compiling the LLVM suite (or if you want to use just the LLVM GCC front end) you can optionally extract the front end from the binary distribution. @@ -810,7 +822,7 @@ you can optionally <a href="GCCFEBuildInstrs.html">build llvm-gcc yourself</a> a main LLVM repository.</p> <p>To install the GCC front end, do the following (on Windows, use an archival tool -like <a href="http://www.7-zip.org">7-zip</a> that understands gzipped tars):</p> +like <a href="http://www.7-zip.org/">7-zip</a> that understands gzipped tars):</p> <ol> <li><tt>cd <i>where-you-want-the-front-end-to-live</i></tt></li> @@ -867,11 +879,11 @@ please let us know how you would like to see things improved by dropping us a no </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="config">Local LLVM Configuration</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Once checked out from the Subversion repository, the LLVM suite source code must be @@ -989,11 +1001,11 @@ script to configure the build system:</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="compile">Compiling the LLVM Suite Source Code</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Once you have configured LLVM, you can build it. There are three types of builds:</p> @@ -1123,11 +1135,11 @@ that directory that is out of date.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="cross-compile">Cross-Compiling LLVM</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>It is possible to cross-compile LLVM itself. That is, you can create LLVM executables and libraries to be hosted on a platform different from the platform where they are build (a Canadian Cross build). To configure a @@ -1141,11 +1153,11 @@ that directory that is out of date.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="objfiles">The Location of LLVM Object Files</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The LLVM build system is capable of sharing a single LLVM source tree among several LLVM builds. Hence, it is possible to build LLVM for several different @@ -1201,11 +1213,11 @@ named after the build type:</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="optionalconfig">Optional Configuration Items</a> -</div> +</h3> -<div class="doc_text"> +<div> <p> If you're running on a Linux system that supports the "<a @@ -1225,7 +1237,7 @@ $ ./hello.bc <p> This allows you to execute LLVM bitcode files directly. On Debian, you -can also use this command instead of the 'echo' command above:</p> +can also use this command instead of the 'echo' command above: </p> <div class="doc_code"> @@ -1236,31 +1248,37 @@ $ sudo update-binfmts --install llvm /path/to/lli --magic 'BC' </div> -<!-- *********************************************************************** --> -<div class="doc_section"> - <a name="layout"><b>Program Layout</b></a> </div> + +<!-- *********************************************************************** --> +<h2> + <a name="layout">Program Layout</a> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>One useful source of information about the LLVM source base is the LLVM <a -href="http://www.doxygen.org">doxygen</a> documentation available at <tt><a +href="http://www.doxygen.org/">doxygen</a> documentation available at <tt><a href="http://llvm.org/doxygen/">http://llvm.org/doxygen/</a></tt>. The following is a brief introduction to code layout:</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"><a name="examples"><tt>llvm/examples</tt></a></div> -<div class="doc_text"> +<h3> + <a name="examples"><tt>llvm/examples</tt></a> +</h3> + +<div> <p>This directory contains some simple examples of how to use the LLVM IR and JIT.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="include"><tt>llvm/include</tt></a></div> -<div class="doc_text"> +<h3> + <a name="include"><tt>llvm/include</tt></a> +</h3> + +<div> <p>This directory contains public header files exported from the LLVM library. The three main subdirectories of this directory are:</p> @@ -1287,8 +1305,11 @@ library. The three main subdirectories of this directory are:</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="lib"><tt>llvm/lib</tt></a></div> -<div class="doc_text"> +<h3> + <a name="lib"><tt>llvm/lib</tt></a> +</h3> + +<div> <p>This directory contains most of the source files of the LLVM system. In LLVM, almost all code exists in libraries, making it very easy to share code among the @@ -1327,6 +1348,10 @@ different <a href="#tools">tools</a>.</p> <dd> This directory contains the major parts of the code generator: Instruction Selector, Instruction Scheduling, and Register Allocation.</dd> + <dt><tt><b>llvm/lib/MC/</b></tt></dt> + <dd>(FIXME: T.B.D.)</dd> + + <!--FIXME: obsoleted --> <dt><tt><b>llvm/lib/Debugger/</b></tt></dt> <dd> This directory contains the source level debugger library that makes it possible to instrument LLVM programs so that a debugger could identify @@ -1340,6 +1365,7 @@ different <a href="#tools">tools</a>.</p> <dd> This directory contains the source code that corresponds to the header files located in <tt>llvm/include/Support/</tt>.</dd> + <!--FIXME: obsoleted --> <dt><tt><b>llvm/lib/System/</b></tt></dt> <dd>This directory contains the operating system abstraction layer that shields LLVM from platform-specific coding.</dd> @@ -1348,8 +1374,11 @@ different <a href="#tools">tools</a>.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="projects"><tt>llvm/projects</tt></a></div> -<div class="doc_text"> +<h3> + <a name="projects"><tt>llvm/projects</tt></a> +</h3> + +<div> <p>This directory contains projects that are not strictly part of LLVM but are shipped with LLVM. This is also the directory where you should create your own LLVM-based projects. See <tt>llvm/projects/sample</tt> for an example of how @@ -1357,8 +1386,11 @@ different <a href="#tools">tools</a>.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="runtime"><tt>llvm/runtime</tt></a></div> -<div class="doc_text"> +<h3> + <a name="runtime"><tt>llvm/runtime</tt></a> +</h3> + +<div> <p>This directory contains libraries which are compiled into LLVM bitcode and used when linking programs with the GCC front end. Most of these libraries are @@ -1371,16 +1403,22 @@ end to compile.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="test"><tt>llvm/test</tt></a></div> -<div class="doc_text"> +<h3> + <a name="test"><tt>llvm/test</tt></a> +</h3> + +<div> <p>This directory contains feature and regression tests and other basic sanity checks on the LLVM infrastructure. These are intended to run quickly and cover a lot of territory without being exhaustive.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="test-suite"><tt>test-suite</tt></a></div> -<div class="doc_text"> +<h3> + <a name="test-suite"><tt>test-suite</tt></a> +</h3> + +<div> <p>This is not a directory in the normal llvm module; it is a separate Subversion module that must be checked out (usually to <tt>projects/test-suite</tt>). @@ -1395,8 +1433,11 @@ end to compile.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="tools"><tt>llvm/tools</tt></a></div> -<div class="doc_text"> +<h3> + <a name="tools"><tt>llvm/tools</tt></a> +</h3> + +<div> <p>The <b>tools</b> directory contains the executables built out of the libraries above, which form the main part of the user interface. You can @@ -1480,8 +1521,11 @@ information is in the <a href="CommandGuide/index.html">Command Guide</a>.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="utils"><tt>llvm/utils</tt></a></div> -<div class="doc_text"> +<h3> + <a name="utils"><tt>llvm/utils</tt></a> +</h3> + +<div> <p>This directory contains utilities for working with LLVM source code, and some of the utilities are actually required as part of the build process because they @@ -1542,13 +1586,15 @@ are code generators for parts of LLVM infrastructure.</p> </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="tutorial">An Example Using the LLVM Tool Chain</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>This section gives an example of using LLVM. llvm-gcc3 is now obsolete, so we only include instructions for llvm-gcc4. </p> @@ -1559,12 +1605,13 @@ create bitcode by default: <i>gcc4</i> produces native code. As the example belo the '--emit-llvm' flag is needed to produce LLVM bitcode output. For <i>makefiles</i> and <i>configure</i> scripts, the CFLAGS variable needs '--emit-llvm' to produce bitcode output.</p> -</div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="tutorial4">Example with llvm-gcc4</a></div> +<h3> + <a name="tutorial4">Example with llvm-gcc4</a> +</h3> -<div class="doc_text"> +<div> <ol> <li><p>First, create a simple C file, name it 'hello.c':</p> @@ -1645,14 +1692,15 @@ int main() { </div> +</div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="problems">Common Problems</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>If you are having problems building or using LLVM, or if you have any other general questions about LLVM, please consult the <a href="FAQ.html">Frequently @@ -1661,12 +1709,12 @@ Asked Questions</a> page.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="links">Links</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>This document is just an <b>introduction</b> on how to use LLVM to do some simple things... there are many more interesting and complicated things @@ -1694,8 +1742,8 @@ out:</p> <a href="mailto:sabre@nondot.org">Chris Lattner</a><br> <a href="http://llvm.x10sys.com/rspencer/">Reid Spencer</a><br> - <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br> - Last modified: $Date: 2011-02-01 21:08:28 +0100 (Tue, 01 Feb 2011) $ + <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br> + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> </html> diff --git a/docs/GettingStartedVS.html b/docs/GettingStartedVS.html index 7c0bf007ec3a..6a604333c8f1 100644 --- a/docs/GettingStartedVS.html +++ b/docs/GettingStartedVS.html @@ -8,9 +8,9 @@ </head> <body> -<div class="doc_title"> +<h1> Getting Started with the LLVM System using Microsoft Visual Studio -</div> +</h1> <ul> <li><a href="#overview">Overview</a> @@ -26,19 +26,17 @@ </ul> <div class="doc_author"> - <p>Written by: - <a href="mailto:jeffc@jolt-lang.org">Jeff Cohen</a> - </p> + <p>Written by: <a href="http://llvm.org/">The LLVM Team</a></p> </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="overview"><b>Overview</b></a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Welcome to LLVM on Windows! This document only covers LLVM on Windows using Visual Studio, not mingw or cygwin. In order to get started, you first need to @@ -72,25 +70,23 @@ </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="requirements"><b>Requirements</b></a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Before you begin to use the LLVM system, review the requirements given below. This may save you some trouble by knowing ahead of time what hardware and software you will need.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="hardware"><b>Hardware</b></a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Any system that can adequately run Visual Studio .NET 2005 SP1 is fine. The LLVM source tree and object files, libraries and executables will consume @@ -99,8 +95,8 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="software"><b>Software</b></a></div> -<div class="doc_text"> +<h3><a name="software"><b>Software</b></a></h3> +<div> <p>You will need Visual Studio .NET 2005 SP1 or higher. The VS2005 SP1 beta and the normal VS2005 still have bugs that are not completely @@ -120,13 +116,15 @@ </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="quickstart"><b>Getting Started</b></a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Here's the short story for getting up and running quickly with LLVM:</p> @@ -196,7 +194,9 @@ <ul> <li>If %PATH% does not contain GnuWin32, you may specify LLVM_LIT_TOOLS_DIR on CMake for the path to GnuWin32.</li> - <li>You can run LLVM tests to build the project "check".</li> + <li>You can run LLVM tests by merely building the project + "check". The test results will be shown in the VS output + window.</li> </ul> </li> @@ -215,25 +215,26 @@ <p>Note that quite a few of these test will fail.</p> </li> - <li>A specific test or test directory can be run with:</li> + <li>A specific test or test directory can be run with: <div class="doc_code"> <pre> % llvm-lit test/path/to/test </pre> </div> - + </li> + </ul> </ol> </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="tutorial">An Example Using the LLVM Tool Chain</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <ol> <li><p>First, create a simple C file, name it 'hello.c':</p> @@ -318,12 +319,12 @@ int main() { </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="problems">Common Problems</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>If you are having problems building or using LLVM, or if you have any other general questions about LLVM, please consult the <a href="FAQ.html">Frequently @@ -332,12 +333,12 @@ Asked Questions</a> page.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="links">Links</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>This document is just an <b>introduction</b> to how to use LLVM to do some simple things... there are many more interesting and complicated things @@ -361,9 +362,8 @@ out:</p> <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="mailto:jeffc@jolt-lang.org">Jeff Cohen</a><br> - <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br> - Last modified: $Date: 2011-02-20 16:34:12 +0100 (Sun, 20 Feb 2011) $ + <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br> + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> </html> diff --git a/docs/GoldPlugin.html b/docs/GoldPlugin.html index 68c5cf192802..e25c45751929 100644 --- a/docs/GoldPlugin.html +++ b/docs/GoldPlugin.html @@ -7,7 +7,7 @@ </head> <body> -<div class="doc_title">LLVM gold plugin</div> +<h1>LLVM gold plugin</h1> <ol> <li><a href="#introduction">Introduction</a></li> <li><a href="#build">How to build it</a></li> @@ -21,9 +21,9 @@ <div class="doc_author">Written by Nick Lewycky</div> <!--=========================================================================--> -<div class="doc_section"><a name="introduction">Introduction</a></div> +<h2><a name="introduction">Introduction</a></h2> <!--=========================================================================--> -<div class="doc_text"> +<div> <p>Building with link time optimization requires cooperation from the system linker. LTO support on Linux systems requires that you use the <a href="http://sourceware.org/binutils">gold linker</a> which supports @@ -33,14 +33,14 @@ project.</p> <p>The LLVM gold plugin implements the <a href="http://gcc.gnu.org/wiki/whopr/driver">gold plugin interface</a> on top of -<a href="http://llvm.org/docs/LinkTimeOptimization.html#lto">libLTO</a>. +<a href="LinkTimeOptimization.html#lto">libLTO</a>. The same plugin can also be used by other tools such as <tt>ar</tt> and <tt>nm</tt>. </div> <!--=========================================================================--> -<div class="doc_section"><a name="build">How to build it</a></div> +<h2><a name="build">How to build it</a></h2> <!--=========================================================================--> -<div class="doc_text"> +<div> <p>You need to have gold with plugin support and build the LLVMgold plugin. Check whether you have gold running <tt>/usr/bin/ld -v</tt>. It will report “GNU gold” or else “GNU ld” if not. If you have @@ -72,9 +72,9 @@ placed. </ul> </div> <!--=========================================================================--> -<div class="doc_section"><a name="usage">Usage</a></div> +<h2><a name="usage">Usage</a></h2> <!--=========================================================================--> -<div class="doc_text"> +<div> <p>The linker takes a <tt>-plugin</tt> option that points to the path of the plugin <tt>.so</tt> file. To find out what link command <tt>gcc</tt> would run in a given situation, run <tt>gcc -v <em>[...]</em></tt> and look @@ -95,14 +95,13 @@ placed. own gold, be sure to install the <tt>ar</tt> and <tt>nm-new</tt> you built to <tt>/usr/bin</tt>. <p> -</div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="example1">Example of link time optimization</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The following example shows a worked example of the gold plugin mixing LLVM bitcode and native code. <pre class="doc_code"> @@ -145,14 +144,20 @@ $ llvm-gcc -use-gold-plugin a.a b.o -o main # <-- link with LLVMgold plugin </pre> <p>Gold informs the plugin that foo3 is never referenced outside the IR, leading LLVM to delete that function. However, unlike in the - <a href="http://llvm.org/docs/LinkTimeOptimization.html#example1">libLTO + <a href="LinkTimeOptimization.html#example1">libLTO example</a> gold does not currently eliminate foo4.</p> </div> +</div> + <!--=========================================================================--> -<div class="doc_section"><a name="lto_autotools">Quickstart for using LTO with autotooled projects</a></div> +<h2> + <a name="lto_autotools"> + Quickstart for using LTO with autotooled projects + </a> +</h2> <!--=========================================================================--> -<div class="doc_text"> +<div> <p>Once your system <tt>ld</tt>, <tt>ar</tt> and <tt>nm</tt> all support LLVM bitcode, everything is in place for an easy to use LTO build of autotooled projects:</p> @@ -189,9 +194,9 @@ export CFLAGS="-O4" </div> <!--=========================================================================--> -<div class="doc_section"><a name="licensing">Licensing</a></div> +<h2><a name="licensing">Licensing</a></h2> <!--=========================================================================--> -<div class="doc_text"> +<div> <p>Gold is licensed under the GPLv3. LLVMgold uses the interface file <tt>plugin-api.h</tt> from gold which means that the resulting LLVMgold.so binary is also GPLv3. This can still be used to link non-GPLv3 programs just @@ -206,7 +211,7 @@ as much as gold could without the plugin.</p> <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="mailto:nicholas@metrix.on.ca">Nick Lewycky</a><br> - <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br> + <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br> Last modified: $Date: 2010-04-16 23:58:21 -0800 (Fri, 16 Apr 2010) $ </address> </body> diff --git a/docs/HistoricalNotes/2000-11-18-EarlyDesignIdeasResp.txt b/docs/HistoricalNotes/2000-11-18-EarlyDesignIdeasResp.txt index 1c725f5aa715..81ca53919d42 100644 --- a/docs/HistoricalNotes/2000-11-18-EarlyDesignIdeasResp.txt +++ b/docs/HistoricalNotes/2000-11-18-EarlyDesignIdeasResp.txt @@ -60,11 +60,11 @@ Understood. :) Yup, I think that this makes a lot of sense. I am still intrigued, however, by the prospect of a minimally allocated VM representation... I -think that it could have definate advantages for certain applications +think that it could have definite advantages for certain applications (think very small machines, like PDAs). I don't, however, think that our initial implementations should focus on this. :) -Here are some other auxilliary goals that I think we should consider: +Here are some other auxiliary goals that I think we should consider: 1. Primary goal: Support a high performance dynamic compilation system. This means that we have an "ideal" division of labor between diff --git a/docs/HistoricalNotes/2000-12-06-MeetingSummary.txt b/docs/HistoricalNotes/2000-12-06-MeetingSummary.txt index b66e18556f5e..01b644b3517f 100644 --- a/docs/HistoricalNotes/2000-12-06-MeetingSummary.txt +++ b/docs/HistoricalNotes/2000-12-06-MeetingSummary.txt @@ -40,7 +40,7 @@ IDEAS TO CONSIDER packaged with the bytecodes themselves. As a conceptual implementation idea, we could include an immediate dominator number for each basic block in the LLVM bytecode program. Basic blocks could be numbered according - to the order of occurance in the bytecode representation. + to the order of occurrence in the bytecode representation. 2. Including loop header and body information. This would facilitate detection of intervals and natural loops. diff --git a/docs/HistoricalNotes/2001-02-06-TypeNotationDebateResp4.txt b/docs/HistoricalNotes/2001-02-06-TypeNotationDebateResp4.txt index 7b9032742a27..839732444f93 100644 --- a/docs/HistoricalNotes/2001-02-06-TypeNotationDebateResp4.txt +++ b/docs/HistoricalNotes/2001-02-06-TypeNotationDebateResp4.txt @@ -39,7 +39,7 @@ declaration and calling syntax. Very true. If you're implementing an object oriented language, however, remember that you have to do all the pointer to member function stuff -yourself.... so everytime you invoke a virtual method one is involved +yourself.... so every time you invoke a virtual method one is involved (instead of having C++ hide it for you behind "syntactic sugar"). > And the old array syntax: diff --git a/docs/HistoricalNotes/2001-02-09-AdveCommentsResponse.txt b/docs/HistoricalNotes/2001-02-09-AdveCommentsResponse.txt index 5c87330fb7ea..da5026366539 100644 --- a/docs/HistoricalNotes/2001-02-09-AdveCommentsResponse.txt +++ b/docs/HistoricalNotes/2001-02-09-AdveCommentsResponse.txt @@ -18,7 +18,7 @@ suggested, as specified below: Very true. We should discuss this more, but my reasoning is more of a consistency argument. There are VERY few instructions that can have all -of the types eliminated, and doing so when available unnecesarily makes +of the types eliminated, and doing so when available unnecessarily makes the language more difficult to handle. Especially when you see 'int %this' and 'bool %that' all over the place, I think it would be disorienting to see: @@ -44,7 +44,7 @@ branches). No. This was something I was debating for a while, and didn't really feel strongly about either way. It is common to switch on other types in HLL's -(for example signed int's are particually common), but in this case, all +(for example signed int's are particularly common), but in this case, all that will be added is an additional 'cast' instruction. I removed that from the spec. @@ -160,7 +160,7 @@ that can be trivally translated into a conditional move... > I agree that we need a static data space. Otherwise, emulating global > data gets unnecessarily complex. -Definately. Also a later item though. :) +Definitely. Also a later item though. :) > We once talked about adding a symbolic thread-id field to each > .. diff --git a/docs/HistoricalNotes/2001-06-01-GCCOptimizations2.txt b/docs/HistoricalNotes/2001-06-01-GCCOptimizations2.txt index 6c9e0971a04d..e61042fd657a 100644 --- a/docs/HistoricalNotes/2001-06-01-GCCOptimizations2.txt +++ b/docs/HistoricalNotes/2001-06-01-GCCOptimizations2.txt @@ -42,7 +42,7 @@ Does using GCC's backend buy us anything? > optimization (step 16 in your list). Do you have a breakdown of that? Not really. The irritating part of GCC is that it mixes it all up and -doesn't have a clean seperation of concerns. A lot of the "back end +doesn't have a clean separation of concerns. A lot of the "back end optimization" happens right along with other data optimizations (ie, CSE of machine specific things). diff --git a/docs/HistoricalNotes/2002-05-12-InstListChange.txt b/docs/HistoricalNotes/2002-05-12-InstListChange.txt index 004edb068d73..638682b49fda 100644 --- a/docs/HistoricalNotes/2002-05-12-InstListChange.txt +++ b/docs/HistoricalNotes/2002-05-12-InstListChange.txt @@ -17,7 +17,7 @@ iterator to an instruction, which, given just an Instruction*, requires a linear search of the basic block the instruction is contained in... just to insert an instruction before another instruction, or to delete an instruction! This complicates algorithms that should be very simple (like -simple constant propogation), because they aren't actually sparse anymore, +simple constant propagation), because they aren't actually sparse anymore, they have to traverse basic blocks to remove constant propogated instructions. diff --git a/docs/HowToReleaseLLVM.html b/docs/HowToReleaseLLVM.html index 7663321fdb82..f52f326eef62 100644 --- a/docs/HowToReleaseLLVM.html +++ b/docs/HowToReleaseLLVM.html @@ -7,7 +7,7 @@ </head> <body> -<div class="doc_title">How To Release LLVM To The Public</div> +<h1>How To Release LLVM To The Public</h1> <ol> <li><a href="#introduction">Introduction</a></li> <li><a href="#criteria">Qualification Criteria</a></li> @@ -17,495 +17,597 @@ <div class="doc_author"> <p>Written by <a href="mailto:tonic@nondot.org">Tanya Lattner</a>, <a href="mailto:rspencer@x10sys.com">Reid Spencer</a>, - <a href="mailto:criswell@cs.uiuc.edu">John Criswell</a> + <a href="mailto:criswell@cs.uiuc.edu">John Criswell</a>, & + <a href="mailto:wendling@apple.com">Bill Wendling</a> </p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="introduction">Introduction</a></div> +<h2><a name="introduction">Introduction</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> - <p> - This document collects information about successfully releasing LLVM - (including subprojects llvm-gcc and Clang) to the public. - It is the release manager's responsibility to ensure that a high quality - build of LLVM is released. - </p> +<div> + +<p>This document contains information about successfully releasing LLVM — + including subprojects: e.g., <tt>llvm-gcc</tt> and <tt>clang</tt> — to + the public. It is the Release Manager's responsibility to ensure that a high + quality build of LLVM is released.</p> + </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="process">Release Timeline</a></div> +<h2><a name="process">Release Timeline</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> - <p>LLVM is released on a time based schedule (currently every 6 months). We - do not have dot releases because of the nature of LLVM incremental - development philosophy. The release schedule is roughly as follows: - </p> -<ol> -<li>Set code freeze and branch creation date for 6 months after last code freeze -date. Announce release schedule to the LLVM community and update the website.</li> -<li>Create release branch and begin release process. </li> -<li>Send out pre-release for first round of testing. Testing will last 7-10 days. -During the first round of testing, regressions should be found and fixed. Patches -are merged from mainline to the release branch.</li> -<li>Generate and send out second pre-release. Bugs found during this time will -not be fixed unless absolutely critical. Bugs introduce by patches merged in -will be fixed and if so, a 3rd round of testing is needed.</li> -<li>The release notes should be updated during the first and second round of -pre-release testing.</li> -<li>Finally, release!</li> -</ol> -</div> +<div> + +<p>LLVM is released on a time based schedule — roughly every 6 months. We + do not normally have dot releases because of the nature of LLVM's incremental + development philosophy. That said, the only thing preventing dot releases for + critical bug fixes from happening is a lack of resources — testers, + machines, time, etc. And, because of the high quality we desire for LLVM + releases, we cannot allow for a truncated form of release qualification.</p> + +<p>The release process is roughly as follows:</p> + +<ul> + <li><p>Set code freeze and branch creation date for 6 months after last code + freeze date. Announce release schedule to the LLVM community and update + the website.</p></li> + + <li><p>Create release branch and begin release process.</p></li> + + <li><p>Send out release candidate sources for first round of testing. Testing + lasts 7-10 days. During the first round of testing, any regressions found + should be fixed. Patches are merged from mainline into the release + branch. Also, all features need to be completed during this time. Any + features not completed at the end of the first round of testing will be + removed or disabled for the release.</p></li> + <li><p>Generate and send out the second release candidate sources. Only + <em>critial</em> bugs found during this testing phase will be fixed. Any + bugs introduced by merged patches will be fixed. If so a third round of + testing is needed.</p></li> + + <li><p>The release notes are updated.</p></li> + + <li><p>Finally, release!</p></li> +</ul> + +</div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="process">Release Process</a></div> +<h2><a name="process">Release Process</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> + +<ol> + <li><a href="#release-admin">Release Administrative Tasks</a> <ol> - <li><a href="#release-admin">Release Administrative Tasks</a></li> - <ol> <li><a href="#branch">Create Release Branch</a></li> <li><a href="#verchanges">Update Version Numbers</a></li> - </ol> - <li><a href="#release-build">Building the Release</a></li> - <ol> + </ol> + </li> + <li><a href="#release-build">Building the Release</a> + <ol> <li><a href="#dist">Build the LLVM Source Distributions</a></li> <li><a href="#build">Build LLVM</a></li> <li><a href="#llvmgccbin">Build the LLVM-GCC Binary Distribution</a></li> <li><a href="#clangbin">Build the Clang Binary Distribution</a></li> <li><a href="#target-build">Target Specific Build Details</a></li> - </ol> - - <li><a href="#release-qualify">Release Qualification Criteria</a></li> - <ol> + </ol> + </li> + <li><a href="#release-qualify">Release Qualification Criteria</a> + <ol> <li><a href="#llvm-qualify">Qualify LLVM</a></li> <li><a href="#llvmgcc-qualify">Qualify LLVM-GCC</a></li> <li><a href="#clang-qualify">Qualify Clang</a></li> <li><a href="#targets">Specific Target Qualification Details</a></li> - </ol> - - <li><a href="#commTest">Community Testing</a></li> - <li><a href="#release-patch">Release Patch Rules</a></li> - - - <li><a href="#release-final">Release final tasks</a></li> - <ol> + </ol> + </li> + + <li><a href="#commTest">Community Testing</a></li> + <li><a href="#release-patch">Release Patch Rules</a></li> + <li><a href="#release-final">Release final tasks</a> + <ol> <li><a href="#updocs">Update Documentation</a></li> - <li><a href="#tag">Tag the LLVM Release Branch</a></li> + <li><a href="#tag">Tag the LLVM Final Release</a></li> <li><a href="#updemo">Update the LLVM Demo Page</a></li> <li><a href="#webupdates">Update the LLVM Website</a></li> <li><a href="#announce">Announce the Release</a></li> - </ol> - </ol> -</div> + </li> +</ol> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="release-admin"> -Release Administrative Tasks</a></div> - -<div class="doc_text"> -This section describes a few administrative tasks that need to be done for the -release process to begin. Specifically, it involves creating the release branch, - resetting version numbers, and creating the release tarballs for the release - team to begin testing. -</div> +<h3><a name="release-admin">Release Administrative Tasks</a></h3> + +<div> + +<p>This section describes a few administrative tasks that need to be done for + the release process to begin. Specifically, it involves:</p> + +<ul> + <li>Creating the release branch,</li> + <li>Setting version numbers, and</li> + <li>Tagging release candidates for the release team to begin testing</li> +</ul> <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="branch">Create Release Branch</a></div> -<div class="doc_text"> -<p>Branch the Subversion HEAD using the following procedure:</p> - <ol> - <li> - <p>Verify that the current Subversion HEAD is in decent shape by examining - nightly tester or buildbot results.</p></li> - <li> - <p>Request all developers to refrain from committing. Offenders get commit - rights taken away (temporarily).</p></li> - <li> - <p> Create the release branch for <tt>llvm</tt>, <tt>llvm-gcc4.2</tt>, - <tt>clang</tt>, and the <tt>test-suite</tt>. The branch name will be - <tt>release_XX</tt>,where <tt>XX</tt> is the major and minor release numbers. - <tt>Clang</tt> will have a different release number than <tt>llvm</tt>/ - <tt>llvm-gcc4</tt> since its first release was years later - (still deciding if this will be true or not). These branches - can be created without checking out anything from subversion. - </p> +<h4><a name="branch">Create Release Branch</a></h4> + +<div> + +<p>Branch the Subversion trunk using the following procedure:</p> + +<ol> + <li><p>Remind developers that the release branching is imminent and to refrain + from committing patches that might break the build. E.g., new features, + large patches for works in progress, an overhaul of the type system, an + exciting new TableGen feature, etc.</p></li> + + <li><p>Verify that the current Subversion trunk is in decent shape by + examining nightly tester and buildbot results.</p></li> + + <li><p>Create the release branch for <tt>llvm</tt>, <tt>llvm-gcc-4.2</tt>, + <tt>clang</tt>, and the <tt>test-suite</tt> from the last known good + revision. The branch's name is <tt>release_XY</tt>, where <tt>X</tt> is + the major and <tt>Y</tt> the minor release numbers. The branches should be + created using the following commands:</p> - <div class="doc_code"> +<div class="doc_code"> <pre> -svn copy https://llvm.org/svn/llvm-project/llvm/trunk \ - https://llvm.org/svn/llvm-project/llvm/branches/release_<i>XX</i> -svn copy https://llvm.org/svn/llvm-project/llvm-gcc-4.2/trunk \ - https://llvm.org/svn/llvm-project/llvm-gcc-4.2/branches/release_<i>XX</i> -svn copy https://llvm.org/svn/llvm-project/test-suite/trunk \ - https://llvm.org/svn/llvm-project/test-suite/branches/release_<i>XX</i> -svn copy https://llvm.org/svn/llvm-project/cfe/trunk \ - https://llvm.org/svn/llvm-project/cfe/branches/release_<i>XX</i> +$ svn copy https://llvm.org/svn/llvm-project/llvm/trunk \ + https://llvm.org/svn/llvm-project/llvm/branches/release_<i>XY</i> + +$ svn copy https://llvm.org/svn/llvm-project/llvm-gcc-4.2/trunk \ + https://llvm.org/svn/llvm-project/llvm-gcc-4.2/branches/release_<i>XY</i> + +$ svn copy https://llvm.org/svn/llvm-project/test-suite/trunk \ + https://llvm.org/svn/llvm-project/test-suite/branches/release_<i>XY</i> + +$ svn copy https://llvm.org/svn/llvm-project/cfe/trunk \ + https://llvm.org/svn/llvm-project/cfe/branches/release_<i>XY</i> </pre> - </div> +</div></li> - <li> - <p>Advise developers they can work on Subversion HEAD again.</p></li> - - <li> - <p>The Release Manager should switch to the release branch (as all changes - to the release will now be done in the branch). The easiest way to do this - is to grab another working copy using the following commands:</p> + <li><p>Advise developers that they may now check their patches into the + Subversion tree again.</p></li> + + <li><p>The Release Manager should switch to the release branch, because all + changes to the release will now be done in the branch. The easiest way to + do this is to grab a working copy using the following commands:</p> <div class="doc_code"> <pre> -svn co https://llvm.org/svn/llvm-project/llvm/branches/release_<i>XX</i> -svn co https://llvm.org/svn/llvm-project/llvm-gcc-4.2/branches/release_<i>XX</i> -svn co https://llvm.org/svn/llvm-project/test-suite/branches/release_<i>XX</i> -svn co https://llvm.org/svn/llvm-project/cfe/branches/release_<i>XX</i> +$ svn co https://llvm.org/svn/llvm-project/llvm/branches/release_<i>XY</i> llvm-<i>X.Y</i> + +$ svn co https://llvm.org/svn/llvm-project/llvm-gcc-4.2/branches/release_<i>XY</i> llvm-gcc-4.2-<i>X.Y</i> + +$ svn co https://llvm.org/svn/llvm-project/test-suite/branches/release_<i>XY</i> test-suite-<i>X.Y</i> + +$ svn co https://llvm.org/svn/llvm-project/cfe/branches/release_<i>XY</i> clang-<i>X.Y</i> </pre> </div></li> +</ol> - </ol> </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="verchanges">Update LLVM Version</a></div> -<div class="doc_text"> - <p> - After creating the LLVM release branch, update the release branches' - autoconf/configure.ac version from X.Xsvn to just X.X. Update it on mainline - as well to be the next version (X.X+1svn). Regenerated the configure script - for both. This must be done for both <tt>llvm</tt> and the - <tt>test-suite</tt>. - </p> - <p>FIXME: Add a note about <tt>clang</tt>.</p> - <p>In addition, the version number of all the Bugzilla components must be - updated for the next release. - </p> +<h4><a name="verchanges">Update LLVM Version</a></h4> + +<div> + +<p>After creating the LLVM release branch, update the release branches' + <tt>autoconf</tt> and <tt>configure.ac</tt> versions from '<tt>X.Ysvn</tt>' + to '<tt>X.Y</tt>'. Update it on mainline as well to be the next version + ('<tt>X.Y+1svn</tt>'). Regenerate the configure scripts for both + <tt>llvm</tt> and the <tt>test-suite</tt>.</p> + +<p>In addition, the version numbers of all the Bugzilla components must be + updated for the next release.</p> + </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="dist">Build the LLVM Source Distributions</a></div> -<div class="doc_text"> - <p> - Create source distributions for <tt>LLVM</tt>, <tt>LLVM-GCC</tt>, - <tt>clang</tt>, and the llvm <tt>test-suite</tt> by exporting the source from - Subversion and archiving it. This can be done with the following commands: - </p> +<h4><a name="dist">Build the LLVM Release Candidates</a></h4> + +<div> + +<p>Create release candidates for <tt>llvm</tt>, <tt>llvm-gcc</tt>, + <tt>clang</tt>, and the LLVM <tt>test-suite</tt> by tagging the branch with + the respective release candidate number. For instance, to create <b>Release + Candidate 1</b> you would issue the following commands:</p> <div class="doc_code"> <pre> -svn export https://llvm.org/svn/llvm-project/llvm/branches/release_<i>XX</i> llvm-X.X -svn export https://llvm.org/svn/llvm-project/llvm-gcc-4.2/branches/release_<i>XX</i> llvm-gcc4.2-X.X.source -svn export https://llvm.org/svn/llvm-project/test-suite/branches/release_<i>XX</i> llvm-test-X.X -svn export https://llvm.org/svn/llvm-project/cfe/branches/release_<i>XX</i> clang-X.X -tar -czvf - llvm-X.X | gzip > llvm-X.X.tar.gz -tar -czvf - llvm-test-X.X | gzip > llvm-test-X.X.tar.gz -tar -czvf - llvm-gcc4.2-X.X.source | gzip > llvm-gcc-4.2-X.X.source.tar.gz -tar -czvf - clang-X.X | gzip > clang-X.X.tar.gz +$ svn mkdir https://llvm.org/svn/llvm-project/llvm/tags/RELEASE_<i>XY</i> +$ svn copy https://llvm.org/svn/llvm-project/llvm/branches/release_<i>XY</i> \ + https://llvm.org/svn/llvm-project/llvm/tags/RELEASE_<i>XY</i>/rc1 + +$ svn mkdir https://llvm.org/svn/llvm-project/llvm-gcc-4.2/tags/RELEASE_<i>XY</i> +$ svn copy https://llvm.org/svn/llvm-project/llvm-gcc-4.2/branches/release_<i>XY</i> \ + https://llvm.org/svn/llvm-project/llvm-gcc-4.2/tags/RELEASE_<i>XY</i>/rc1 + +$ svn mkdir https://llvm.org/svn/llvm-project/test-suite/tags/RELEASE_<i>XY</i> +$ svn copy https://llvm.org/svn/llvm-project/test-suite/branches/release_<i>XY</i> \ + https://llvm.org/svn/llvm-project/test-suite/tags/RELEASE_<i>XY</i>/rc1 + +$ svn mkdir https://llvm.org/svn/llvm-project/cfe/tags/RELEASE_<i>XY</i> +$ svn copy https://llvm.org/svn/llvm-project/cfe/branches/release_<i>XY</i> \ + https://llvm.org/svn/llvm-project/cfe/tags/RELEASE_<i>XY</i>/rc1 </pre> </div> + +<p>Similarly, <b>Release Candidate 2</b> would be named <tt>RC2</tt> and so + on. This keeps a permanent copy of the release candidate around for people to + export and build as they wish. The final released sources will be tagged in + the <tt>RELEASE_<i>XY</i></tt> directory as <tt>Final</tt> + (c.f. <a href="#tag">Tag the LLVM Final Release</a>).</p> + +<p>The Release Manager may supply pre-packaged source tarballs for users. This + can be done with the following commands:</p> + +<div class="doc_code"> +<pre> +$ svn export https://llvm.org/svn/llvm-project/llvm/tags/RELEASE_<i>XY</i>/rc1 llvm-<i>X.Y</i>rc1 +$ svn export https://llvm.org/svn/llvm-project/llvm-gcc-4.2/tags/RELEASE_<i>XY</i>/rc1 llvm-gcc4.2-<i>X.Y</i>rc1 +$ svn export https://llvm.org/svn/llvm-project/test-suite/tags/RELEASE_<i>XY</i>/rc1 llvm-test-<i>X.Y</i>rc1 +$ svn export https://llvm.org/svn/llvm-project/cfe/tags/RELEASE_<i>XY</i>/rc1 clang-<i>X.Y</i>rc1 + +$ tar -cvf - llvm-<i>X.Y</i>rc1 | gzip > llvm-<i>X.Y</i>rc1.src.tar.gz +$ tar -cvf - llvm-test-<i>X.Y</i>rc1 | gzip > llvm-test-<i>X.Y</i>rc1.src.tar.gz +$ tar -cvf - llvm-gcc4.2-<i>X.Y</i>rc1 | gzip > llvm-gcc-4.2-<i>X.Y</i>rc1.src.tar.gz +$ tar -cvf - clang-<i>X.Y</i>rc1 | gzip > clang-<i>X.Y</i>rc1.src.tar.gz +</pre> +</div> + +</div> + </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="release-build"> -Building the Release</a></div> +<h3><a name="release-build">Building the Release</a></h3> -<div class="doc_text"> -The build of <tt>llvm</tt>, <tt>llvm-gcc</tt>, and <tt>clang</tt> must be free -of errors and warnings in both debug, release+asserts, and release builds. -If all builds are clean, then the release passes build qualification. +<div> -<ol> -<li>debug: ENABLE_OPTIMIZED=0</li> -<li>release+asserts: ENABLE_OPTIMIZED=1</li> -<li>release: ENABLE_OPTIMIZED=1 DISABLE_ASSERTIONS=1</li> -</ol> -</div> +<p>The builds of <tt>llvm</tt>, <tt>llvm-gcc</tt>, and <tt>clang</tt> + <em>must</em> be free of errors and warnings in Debug, Release+Asserts, and + Release builds. If all builds are clean, then the release passes Build + Qualification.</p> + +<p>The <tt>make</tt> options for building the different modes:</p> + +<table> + <tr><th>Mode</th><th>Options</th></tr> + <tr align="left"><td>Debug</td><td><tt>ENABLE_OPTIMIZED=0</tt></td></tr> + <tr align="left"><td>Release+Asserts</td><td><tt>ENABLE_OPTIMIZED=1</tt></td></tr> + <tr align="left"><td>Release</td><td><tt>ENABLE_OPTIMIZED=1 DISABLE_ASSERTIONS=1</tt></td></tr> +</table> <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="build">Build LLVM</a></div> -<div class="doc_text"> - <p> - Build both debug, release+asserts (optimized), and release versions of - LLVM on all supported platforms. Direction to build llvm are - <a href="http://llvm.org/docs/GettingStarted.html#quickstart">here</a>. - </p> +<h4><a name="build">Build LLVM</a></h4> + +<div> + +<p>Build <tt>Debug</tt>, <tt>Release+Asserts</tt>, and <tt>Release</tt> versions + of <tt>llvm</tt> on all supported platforms. Directions to build + <tt>llvm</tt> are + <a href="GettingStarted.html#quickstart">here</a>.</p> + </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="llvmgccbin">Build the LLVM GCC Binary Distribution</a></div> -<div class="doc_text"> - <p> - Creating the LLVM GCC binary distribution (release/optimized) requires - performing the following steps for each supported platform: - </p> +<h4><a name="llvmgccbin">Build the LLVM GCC Binary Distribution</a></h4> + +<div> + +<p>Creating the <tt>llvm-gcc</tt> binary distribution (Release/Optimized) + requires performing the following steps for each supported platform:</p> + +<ol> + <li><p>Build the <tt>llvm-gcc</tt> front-end by following the directions in + the <tt>README.LLVM</tt> file. The front-end must be compiled with C, C++, + Objective-C (Mac only), Objective-C++ (Mac only), and Fortran + support.</p></li> + + <li><p>Boostrapping must be enabled.</p></li> + + <li><p>Be sure to build with <tt>LLVM_VERSION_INFO=X.Y</tt>, where <tt>X</tt> + is the major and <tt>Y</tt> is the minor release numbers.</p></li> + + <li><p>Copy the installation directory to a directory named for the specific + target. For example on Red Hat Enterprise Linux, the directory would be + named <tt>llvm-gcc4.2-2.6-x86-linux-RHEL4</tt>. Archive and compress the + new directory.</p></li> +</ol> - <ol> - <li> - Build the LLVM GCC front-end by following the directions in the README.LLVM - file. The frontend must be compiled with c, c++, objc (mac only), - objc++ (mac only) and fortran support. </li> - <li>Please boostrap as well.</li> - <li>Be sure to build with LLVM_VERSION_INFO=X.X, where X is the major and - minor release numbers. - </li> - - <li> - Copy the installation directory to a directory named for the specific target. - For example on Red Hat Enterprise Linux, the directory would be named - <tt>llvm-gcc4.2-2.6-x86-linux-RHEL4</tt>. Archive and compress the new directory. - </li> - </ol> </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="clangbin">Build Clang -Binary Distribution</a></div> -<div class="doc_text"> - <p> - Creating the Clang binary distribution (debug/release/release) requires - performing the following steps for each supported platform: - </p> +<h4><a name="clangbin">Build Clang Binary Distribution</a></h4> - <ol> - <li> - Build clang according to the directions - <a href="http://clang.llvm.org/get_started.html">here</a>. - </li> - - <li>Build both a debug and release version of clang, but the binary - will be a release build.</lI> - - <li> - Package clang (details to follow). - </li> - </ol> -</div> +<div> + +<p>Creating the <tt>clang</tt> binary distribution + (Debug/Release+Asserts/Release) requires performing the following steps for + each supported platform:</p> + +<ol> + <li>Build clang according to the directions + <a href="http://clang.llvm.org/get_started.html">here</a>.</li> + + <li>Build both a debug and release version of clang. The binary will be the + release build.</lI> + + <li>Package <tt>clang</tt> (details to follow).</li> +</ol> +</div> <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="target-build">Target Specific Build -Details</a></div> -<div class="doc_text"> - <p> - The table below specifies which compilers are used for each arch/os combination - when qualifying the build of <tt>llvm</tt>, <tt>llvm-gcc</tt>, <tt>clang. - </tt></p> - - <p> - <table> +<h4><a name="target-build">Target Specific Build Details</a></h4> + +<div> + +<p>The table below specifies which compilers are used for each Arch/OS + combination when qualifying the build of <tt>llvm</tt>, <tt>llvm-gcc</tt>, + and <tt>clang</tt>.</p> + +<table> <tr><th>Architecture</th><th>OS</th><th>compiler</th></tr> <tr><td>x86-32</td><td>Mac OS 10.5</td><td>gcc 4.0.1</td></tr> <tr><td>x86-32</td><td>Linux</td><td>gcc 4.2.X, gcc 4.3.X</td></tr> <tr><td>x86-32</td><td>FreeBSD</td><td>gcc 4.2.X</td></tr> - <tr><td>x86-32</td><td>mingw</td><td>gcc 3.4.5</td></tr> + <tr><td>x86-32</td><td>mingw</td><td>gcc 3.4.5</td></tr> <tr><td>x86-64</td><td>Mac OS 10.5</td><td>gcc 4.0.1</td></tr> <tr><td>x86-64</td><td>Linux</td><td>gcc 4.2.X, gcc 4.3.X</td></tr> <tr><td>x86-64</td><td>FreeBSD</td><td>gcc 4.2.X</td></tr> - - </table> - </p> +</table> </div> +</div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="release-qualify"> -Building the Release</a></div> - -<div class="doc_text"> - A release is qualified when it has no regressions from the previous - release (or baseline). Regressions are related to correctness only and not - performance at this time. <b>Regressions are new failures in the set of tests that - are used to qualify each product and only include things on the list. - Ultimately, there is no end to the number of possible bugs in a release. We - need a very concrete and definitive release criteria that ensures we have - monotonically improving quality on some metric. The metric we use is - described below. This doesn't mean that we don't care about other things, - but this are things that must be satisfied before a release can go out</b> -</div> +<h3><a name="release-qualify">Building the Release</a></h3> +<div> + +<p>A release is qualified when it has no regressions from the previous release + (or baseline). Regressions are related to correctness first and performance + second. (We may tolerate some minor performance regressions if they are + deemed necessary for the general quality of the compiler.)</p> + +<p><b>Regressions are new failures in the set of tests that are used to qualify + each product and only include things on the list. Every release will have + some bugs in it. It is the reality of developing a complex piece of + software. We need a very concrete and definitive release criteria that + ensures we have monotonically improving quality on some metric. The metric we + use is described below. This doesn't mean that we don't care about other + criteria, but these are the criteria which we found to be most important and + which must be satisfied before a release can go out</b></p> <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="llvm-qualify">Qualify LLVM</a></div> -<div class="doc_text"> - <p> - LLVM is qualified when it has a clean dejagnu test run without a frontend and - it has no regressions when using either <tt>llvm-gcc</tt> or <tt>clang</tt> - with the <tt>test-suite</tt> from the previous release. -</p> +<h4><a name="llvm-qualify">Qualify LLVM</a></h4> + +<div> + +<p>LLVM is qualified when it has a clean test run without a front-end. And it + has no regressions when using either <tt>llvm-gcc</tt> or <tt>clang</tt> with + the <tt>test-suite</tt> from the previous release.</p> + </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="llvmgcc-qualify">Qualify LLVM-GCC</a></div> -<div class="doc_text"> - <p> - <tt>LLVM-GCC</tt> is qualified when front-end specific tests in the - <tt>llvm</tt> dejagnu test suite all pass and there are no regressions in - the <tt>test-suite</tt>.</p> - <p>We do not use the gcc dejagnu test suite as release criteria.</p> +<h4><a name="llvmgcc-qualify">Qualify LLVM-GCC</a></h4> + +<div> + +<p><tt>LLVM-GCC</tt> is qualified when front-end specific tests in the + <tt>llvm</tt> regression test suite all pass and there are no regressions in + the <tt>test-suite</tt>.</p> + +<p>We do not use the GCC DejaGNU test suite as release criteria.</p> + </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="clang-qualify">Qualify Clang</a></div> -<div class="doc_text"> - <tt>Clang</tt> is qualified when front-end specific tests in the - <tt>llvm</tt> dejagnu test suite all pass, clang's own test suite passes - cleanly, and there are no regressions in the <tt>test-suite</tt>.</p> +<h4><a name="clang-qualify">Qualify Clang</a></h4> + +<div> + +<p><tt>Clang</tt> is qualified when front-end specific tests in the + <tt>llvm</tt> dejagnu test suite all pass, clang's own test suite passes + cleanly, and there are no regressions in the <tt>test-suite</tt>.</p> + </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="targets">Specific Target -Qualification Details</a></div> -<div class="doc_text"> - <p><table> - <tr><th>Architecture</th><th>OS</th><th>llvm-gcc baseline</th><th>clang baseline - </th><th>tests</th></tr> +<h4><a name="targets">Specific Target Qualification Details</a></h4> + +<div> + +<table> + <tr><th>Architecture</th><th>OS</th><th>llvm-gcc baseline</th><th>clang baseline</th><th>tests</th></tr> <tr><td>x86-32</td><td>Linux</td><td>last release</td><td>last release</td><td>llvm dejagnu, clang tests, test-suite (including spec)</td></tr> <tr><td>x86-32</td><td>FreeBSD</td><td>none</td><td>last release</td><td>llvm dejagnu, clang tests, test-suite</td></tr> <tr><td>x86-32</td><td>mingw</td><td>last release</td><td>none</td><td>QT</td></tr> <tr><td>x86-64</td><td>Mac OS 10.X</td><td>last release</td><td>last release</td><td>llvm dejagnu, clang tests, test-suite (including spec)</td></tr> <tr><td>x86-64</td><td>Linux</td><td>last release</td><td>last release</td><td>llvm dejagnu, clang tests, test-suite (including spec)</td></tr> <tr><td>x86-64</td><td>FreeBSD</td><td>none</td><td>last release</td><td>llvm dejagnu, clang tests, test-suite</td></tr> - </table></p> +</table> + +</div> + </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="commTest">Community Testing</a></div> -<div class="doc_text"> - <p> - Once all testing has been completed and appropriate bugs filed, the pre-release - tar balls may be put on the website and the LLVM community is notified. Ask that - all LLVM developers test the release in 2 ways:</p> - <ol> - <li>Download llvm-X.X, llvm-test-X.X, and the appropriate llvm-gcc4 - and/or clang binary. Build LLVM. - Run "make check" and the full llvm-test suite (make TEST=nightly report).</li> - <li>Download llvm-X.X, llvm-test-X.X, and the llvm-gcc4 and/or clang source. - Compile everything. Run "make check" and the full llvm-test suite (make TEST=nightly - report).</li> - </ol> - <p>Ask LLVM developers to submit the report and make check results to the list. - Attempt to verify that there are no regressions from the previous release. - The results are not used to qualify a release, but to spot other potential - problems. For unsupported targets, verify that make check at least is - clean.</p> +<h3><a name="commTest">Community Testing</a></h3> +<div> + +<p>Once all testing has been completed and appropriate bugs filed, the release + candidate tarballs are put on the website and the LLVM community is + notified. Ask that all LLVM developers test the release in 2 ways:</p> + +<ol> + <li>Download <tt>llvm-<i>X.Y</i></tt>, <tt>llvm-test-<i>X.Y</i></tt>, and the + appropriate <tt>llvm-gcc</tt> and/or <tt>clang</tt> binary. Build + LLVM. Run <tt>make check</tt> and the full LLVM test suite (<tt>make + TEST=nightly report</tt>).</li> + + <li>Download <tt>llvm-<i>X.Y</i></tt>, <tt>llvm-test-<i>X.Y</i></tt>, and the + <tt>llvm-gcc</tt> and/or <tt>clang</tt> source. Compile everything. Run + <tt>make check</tt> and the full LLVM test suite (<tt>make TEST=nightly + report</tt>).</li> +</ol> + +<p>Ask LLVM developers to submit the test suite report and <tt>make check</tt> + results to the list. Verify that there are no regressions from the previous + release. The results are not used to qualify a release, but to spot other + potential problems. For unsupported targets, verify that <tt>make check</tt> + is at least clean.</p> - <p>During the first round of testing time, - all regressions must be fixed before the second pre-release is created.</p> +<p>During the first round of testing, all regressions must be fixed before the + second release candidate is tagged.</p> - <p>If this is the second round of testing, this is only to ensure the bug - fixes previously merged in have not created new major problems. This is not - the time to solve additional and unrelated bugs. If no patches are merged in, - the release is determined to be ready and the release manager may move onto - the next step. - </p> +<p>If this is the second round of testing, the testing is only to ensure that + bug fixes previously merged in have not created new major problems. <i>This + is not the time to solve additional and unrelated bugs!</i> If no patches are + merged in, the release is determined to be ready and the release manager may + move onto the next stage.</p> + </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="release-patch">Release Patch Rules -</a></div> -<div class="doc_text"> - <p> - Below are the rules regarding patching the release branch.</p> - <p> - <li>Patches applied to the release branch are only applied by the release - manager.</li> - <li>During the first round of testing, patches that fix regressions or that - are small and relatively risk free (verified by the appropriate code owner) - are applied to the branch. Code owners are asked to be very conservative in - approving patches for the branch and we reserve the right to reject any patch - that does not fix a regression as previously defined.</li> - <li>During the remaining rounds of testing, only patches that fix regressions - may be applied.</li> - - </p> -</div> +<h3><a name="release-patch">Release Patch Rules</a></h3> +<div> + +<p>Below are the rules regarding patching the release branch:</p> + +<ol> + <li><p>Patches applied to the release branch may only be applied by the + release manager.</p></li> + + <li><p>During the first round of testing, patches that fix regressions or that + are small and relatively risk free (verified by the appropriate code + owner) are applied to the branch. Code owners are asked to be very + conservative in approving patches for the branch. We reserve the right to + reject any patch that does not fix a regression as previously + defined.</p></li> + + <li><p>During the remaining rounds of testing, only patches that fix critical + regressions may be applied.</p></li> +</ol> -<!-- ======================================================================= --> -<div class="doc_subsection"><a name="release-final">Release Final Tasks -</a></div> -<div class="doc_text"> - <p> - The final stages of the release process involving tagging the release branch, - updating documentation that refers to the release, and updating the demo - page.</p> - <p>FIXME: Add a note if anything needs to be done to the clang website. - Eventually the websites will be merged hopefully.</p> </div> +<!-- ======================================================================= --> +<h3><a name="release-final">Release Final Tasks</a></h3> + +<div> + +<p>The final stages of the release process involves tagging the "final" release + branch, updating documentation that refers to the release, and updating the + demo page.</p> <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="updocs">Update Documentation</a></div> -<div class="doc_text"> - <p> - Review the documentation and ensure that it is up to date. The Release Notes - must be updated to reflect bug fixes, new known issues, and changes in the - list of supported platforms. The Getting Started Guide should be updated to - reflect the new release version number tag avaiable from Subversion and - changes in basic system requirements. Merge both changes from mainline into - the release branch. - </p> +<h4><a name="updocs">Update Documentation</a></h4> + +<div> + +<p>Review the documentation and ensure that it is up to date. The "Release + Notes" must be updated to reflect new features, bug fixes, new known issues, + and changes in the list of supported platforms. The "Getting Started Guide" + should be updated to reflect the new release version number tag avaiable from + Subversion and changes in basic system requirements. Merge both changes from + mainline into the release branch.</p> + </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="tag">Tag the Release Branch</a></div> -<div class="doc_text"> - <p>Tag the release branch using the following procedure:</p> +<h4><a name="tag">Tag the LLVM Final Release</a></h4> + +<div> + +<p>Tag the final release sources using the following procedure:</p> + <div class="doc_code"> <pre> -svn copy https://llvm.org/svn/llvm-project/llvm/branches/release_XX \ - https://llvm.org/svn/llvm-project/llvm/tags/RELEASE_<i>XX</i> -svn copy https://llvm.org/svn/llvm-project/llvm-gcc-4.2/branches/release_XX \ - https://llvm.org/svn/llvm-project/llvm-gcc-4.2/tags/RELEASE_<i>XX</i> -svn copy https://llvm.org/svn/llvm-project/test-suite/branches/release_XX \ - https://llvm.org/svn/llvm-project/test-suite/tags/RELEASE_<i>XX</i> +$ svn copy https://llvm.org/svn/llvm-project/llvm/branches/release_XY \ + https://llvm.org/svn/llvm-project/llvm/tags/RELEASE_<i>XY</i>/Final + +$ svn copy https://llvm.org/svn/llvm-project/llvm-gcc-4.2/branches/release_XY \ + https://llvm.org/svn/llvm-project/llvm-gcc-4.2/tags/RELEASE_<i>XY</i>/Final + +$ svn copy https://llvm.org/svn/llvm-project/test-suite/branches/release_XY \ + https://llvm.org/svn/llvm-project/test-suite/tags/RELEASE_<i>XY</i>/Final + +$ svn copy https://llvm.org/svn/llvm-project/cfe/branches/release_XY \ + https://llvm.org/svn/llvm-project/cfe/tags/RELEASE_<i>XY</i>/Final </pre> </div> + </div> +</div> + +<!-- ======================================================================= --> +<h3><a name="updemo">Update the LLVM Demo Page</a></h3> +<div> + +<p>The LLVM demo page must be updated to use the new release. This consists of + using the new <tt>llvm-gcc</tt> binary and building LLVM.</p> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="updemo">Update the LLVM Demo Page</a></div> -<div class="doc_text"> - <p> - The LLVM demo page must be updated to use the new release. This consists of - using the llvm-gcc binary and building LLVM. Update the website demo page - configuration to use the new release.</p> +<h4><a name="webupdates">Update the LLVM Website</a></h4> + +<div> + +<p>The website must be updated before the release announcement is sent out. Here + is what to do:</p> + +<ol> + <li>Check out the <tt>www</tt> module from Subversion.</li> + + <li>Create a new subdirectory <tt>X.Y</tt> in the releases directory.</li> + + <li>Commit the <tt>llvm</tt>, <tt>test-suite</tt>, <tt>llvm-gcc</tt> source, + <tt>clang source</tt>, <tt>clang binaries</tt>, and <tt>llvm-gcc</tt> + binaries in this new directory.</li> + + <li>Copy and commit the <tt>llvm/docs</tt> and <tt>LICENSE.txt</tt> files + into this new directory. The docs should be built with + <tt>BUILD_FOR_WEBSITE=1</tt>.</li> + + <li>Commit the <tt>index.html</tt> to the <tt>release/X.Y</tt> directory to + redirect (use from previous release.</li> + + <li>Update the <tt>releases/download.html</tt> file with the new release.</li> + + <li>Update the <tt>releases/index.html</tt> with the new release and link to + release documentation.</li> + + <li>Finally, update the main page (<tt>index.html</tt> and sidebar) to point + to the new release and release announcement. Make sure this all gets + committed back into Subversion.</li> +</ol> + </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="webupdates">Update the LLVM Website</a></div> -<div class="doc_text"> - <p> - The website must be updated before the release announcement is sent out. Here is - what to do:</p> - <ol> - <li> Check out the <tt>website</tt> module from CVS. </li> - <li> Create a new subdirectory X.X in the releases directory. </li> - <li> Commit the <tt>llvm</tt>, <tt>test-suite</tt>, <tt>llvm-gcc</tt> source, - <tt>clang source</tt>, <tt>clang binaries</tt>, - and <tt>llvm-gcc</tt> binaries in this new directory. </li> - <li> Copy and commit the <tt>llvm/docs</tt> and <tt>LICENSE.txt</tt> - files into this new directory. The docs should be built with BUILD_FOR_WEBSITE=1.</li> - <li> Commit the index.html to the release/X.X directory to redirect (use from previous - release. </li> - <li> Update the <tt>releases/download.html</tt> file with the new release. </li> - <li>Update the <tt>releases/index.html</tt> with the new release and link to - release documentation.</li> - <li> Finally, update the main page (<tt>index.html</tt> and sidebar) to - point to the new release and release announcement. Make sure this all gets - committed back into Subversion.</li> - </ol> +<h4><a name="announce">Announce the Release</a></h4> + +<div> + +<p>Have Chris send out the release announcement when everything is finished.</p> + +</div> + </div> -<!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="announce">Announce the Release</a></div> -<div class="doc_text"> - <p>Have Chris send out the release announcement when everything is finished.</p> </div> <!-- *********************************************************************** --> @@ -515,9 +617,9 @@ svn copy https://llvm.org/svn/llvm-project/test-suite/branches/release_XX \ 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.cs.uiuc.edu">The LLVM Compiler Infrastructure</a> + <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a> <br> - Last modified: $Date: 2010-07-07 09:48:00 +0200 (Wed, 07 Jul 2010) $ + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> </html> diff --git a/docs/HowToSubmitABug.html b/docs/HowToSubmitABug.html index 64c6141ec7b1..54f548cefd90 100644 --- a/docs/HowToSubmitABug.html +++ b/docs/HowToSubmitABug.html @@ -7,9 +7,9 @@ </head> <body> -<div class="doc_title"> +<h1> How to submit an LLVM bug report -</div> +</h1> <table class="layout" style="width: 90%" > <tr class="layout"> @@ -37,12 +37,12 @@ </table> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="introduction">Introduction - Got bugs?</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>If you're working with LLVM and run into a bug, we definitely want to know about it. This document describes what you can do to increase the odds of @@ -76,12 +76,12 @@ information:</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="crashers">Crashing Bugs</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>More often than not, bugs in the compiler cause it to crash—often due to an assertion failure of some sort. The most important @@ -109,14 +109,12 @@ with the following extra command line options:</p> </ul> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="front-end">Front-end bugs</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>If the problem is in the front-end, you should re-run the same <tt>llvm-gcc</tt> command that resulted in the crash, but add the @@ -137,11 +135,11 @@ has instructions on the best way to use delta.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="ct_optimizer">Compile-time optimization bugs</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>If you find that a bug crashes in the optimizer, compile your test-case to a <tt>.bc</tt> file by passing "<tt><b>-emit-llvm -O0 -c -o foo.bc</b></tt>". @@ -171,11 +169,11 @@ that bugpoint emits. If something goes wrong with bugpoint, please submit the </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="ct_codegen">Code generator bugs</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>If you find a bug that crashes llvm-gcc in the code generator, compile your source file to a .bc file by passing "<tt><b>-emit-llvm -c -o foo.bc</b></tt>" @@ -207,13 +205,15 @@ that bugpoint emits. If something goes wrong with bugpoint, please submit the </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="miscompilations">Miscompilations</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>If llvm-gcc successfully produces an executable, but that executable doesn't run right, this is either a bug in the code or a bug in the @@ -241,12 +241,12 @@ error.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="codegen">Incorrect code generation</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Similarly to debugging incorrect compilation by mis-behaving passes, you can debug incorrect code generation by either LLC or the JIT, using @@ -338,9 +338,9 @@ the following:</p> src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a> <a href="mailto:sabre@nondot.org">Chris Lattner</a><br> - <a href="http://llvm.org">The LLVM Compiler Infrastructure</a> + <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a> <br> - Last modified: $Date: 2010-05-07 02:28:04 +0200 (Fri, 07 May 2010) $ + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> diff --git a/docs/LangRef.html b/docs/LangRef.html index 580ae7964b5a..0e37e8231c82 100644 --- a/docs/LangRef.html +++ b/docs/LangRef.html @@ -12,7 +12,7 @@ <body> -<div class="doc_title"> LLVM Language Reference Manual </div> +<h1>LLVM Language Reference Manual</h1> <ol> <li><a href="#abstract">Abstract</a></li> <li><a href="#introduction">Introduction</a></li> @@ -321,10 +321,10 @@ </div> <!-- *********************************************************************** --> -<div class="doc_section"> <a name="abstract">Abstract </a></div> +<h2><a name="abstract">Abstract</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>This document is a reference manual for the LLVM assembly language. LLVM is a Static Single Assignment (SSA) based representation that provides type @@ -335,10 +335,10 @@ </div> <!-- *********************************************************************** --> -<div class="doc_section"> <a name="introduction">Introduction</a> </div> +<h2><a name="introduction">Introduction</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>The LLVM code representation is designed to be used in three different forms: as an in-memory compiler IR, as an on-disk bitcode representation (suitable @@ -359,12 +359,12 @@ variable is never accessed outside of the current function, allowing it to be promoted to a simple SSA value instead of a memory location.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> <a name="wellformed">Well-Formedness</a> </div> +<h4> + <a name="wellformed">Well-Formedness</a> +</h4> -<div class="doc_text"> +<div> <p>It is important to note that this document describes 'well formed' LLVM assembly language. There is a difference between what the parser accepts and @@ -384,13 +384,15 @@ </div> +</div> + <!-- Describe the typesetting conventions here. --> <!-- *********************************************************************** --> -<div class="doc_section"> <a name="identifiers">Identifiers</a> </div> +<h2><a name="identifiers">Identifiers</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>LLVM identifiers come in two basic types: global and local. Global identifiers (functions, global variables) begin with the <tt>'@'</tt> @@ -475,14 +477,15 @@ </div> <!-- *********************************************************************** --> -<div class="doc_section"> <a name="highlevel">High Level Structure</a> </div> +<h2><a name="highlevel">High Level Structure</a></h2> <!-- *********************************************************************** --> - +<div> <!-- ======================================================================= --> -<div class="doc_subsection"> <a name="modulestructure">Module Structure</a> -</div> +<h3> + <a name="modulestructure">Module Structure</a> +</h3> -<div class="doc_text"> +<div> <p>LLVM programs are composed of "Module"s, each of which is a translation unit of the input programs. Each module consists of functions, global variables, @@ -528,11 +531,11 @@ define i32 @main() { <i>; i32()* </i> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="linkage">Linkage Types</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>All Global Variables and Functions have one of the following types of linkage:</p> @@ -677,11 +680,11 @@ define i32 @main() { <i>; i32()* </i> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="callingconv">Calling Conventions</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>LLVM <a href="#functionstructure">functions</a>, <a href="#i_call">calls</a> and <a href="#i_invoke">invokes</a> can all have an optional calling @@ -750,11 +753,11 @@ define i32 @main() { <i>; i32()* </i> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="visibility">Visibility Styles</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>All Global Variables and Functions have one of the following visibility styles:</p> @@ -784,11 +787,11 @@ define i32 @main() { <i>; i32()* </i> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="namedtypes">Named Types</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>LLVM IR allows you to specify name aliases for certain types. This can make it easier to read the IR and make the IR more condensed (particularly when @@ -815,11 +818,11 @@ define i32 @main() { <i>; i32()* </i> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="globalvars">Global Variables</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Global variables define regions of memory allocated at compilation time instead of run-time. Global variables may optionally be initialized, may @@ -883,11 +886,11 @@ define i32 @main() { <i>; i32()* </i> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="functionstructure">Functions</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>LLVM function definitions consist of the "<tt>define</tt>" keyword, an optional <a href="#linkage">linkage type</a>, an optional @@ -946,11 +949,11 @@ define [<a href="#linkage">linkage</a>] [<a href="#visibility">visibility</a>] </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="aliasstructure">Aliases</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Aliases act as "second name" for the aliasee value (which can be either function, global variable, another alias or bitcast of global value). Aliases @@ -965,11 +968,11 @@ define [<a href="#linkage">linkage</a>] [<a href="#visibility">visibility</a>] </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="namedmetadatastructure">Named Metadata</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Named metadata is a collection of metadata. <a href="#metadata">Metadata nodes</a> (but not metadata strings) are the only valid operands for @@ -988,9 +991,11 @@ define [<a href="#linkage">linkage</a>] [<a href="#visibility">visibility</a>] </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="paramattrs">Parameter Attributes</a></div> +<h3> + <a name="paramattrs">Parameter Attributes</a> +</h3> -<div class="doc_text"> +<div> <p>The return type and each parameter of a function type may have a set of <i>parameter attributes</i> associated with them. Parameter attributes are @@ -1017,13 +1022,15 @@ declare signext i8 @returns_signed_char() <dl> <dt><tt><b>zeroext</b></tt></dt> <dd>This indicates to the code generator that the parameter or return value - should be zero-extended to a 32-bit value by the caller (for a parameter) - or the callee (for a return value).</dd> + should be zero-extended to the extent required by the target's ABI (which + is usually 32-bits, but is 8-bits for a i1 on x86-64) by the caller (for a + parameter) or the callee (for a return value).</dd> <dt><tt><b>signext</b></tt></dt> <dd>This indicates to the code generator that the parameter or return value - should be sign-extended to a 32-bit value by the caller (for a parameter) - or the callee (for a return value).</dd> + should be sign-extended to the extent required by the target's ABI (which + is usually 32-bits) by the caller (for a parameter) or the callee (for a + return value).</dd> <dt><tt><b>inreg</b></tt></dt> <dd>This indicates that this parameter or return value should be treated in a @@ -1095,11 +1102,11 @@ declare signext i8 @returns_signed_char() </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="gc">Garbage Collector Names</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Each function may specify a garbage collector name, which is simply a string:</p> @@ -1115,11 +1122,11 @@ define void @f() gc "name" { ... } </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="fnattrs">Function Attributes</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Function attributes are set to communicate additional information about a function. Function attributes are considered to be part of the function, not @@ -1238,11 +1245,11 @@ define void @f() optsize { ... } </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="moduleasm">Module-Level Inline Assembly</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Modules may contain "module-level inline asm" blocks, which corresponds to the GCC "file scope inline asm" blocks. These blocks are internally @@ -1264,11 +1271,11 @@ module asm "more can go here" </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="datalayout">Data Layout</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>A module may specify a target specific data layout string that specifies how data is to be laid out in memory. The syntax for the data layout is @@ -1376,11 +1383,11 @@ target datalayout = "<i>layout specification</i>" </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="pointeraliasing">Pointer Aliasing Rules</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Any memory access must be done through a pointer value associated with an address range of the memory access, otherwise the behavior @@ -1440,11 +1447,11 @@ to implement type-based alias analysis.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="volatile">Volatile Memory Accesses</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Certain memory accesses, such as <a href="#i_load"><tt>load</tt></a>s, <a href="#i_store"><tt>store</tt></a>s, and <a @@ -1457,11 +1464,13 @@ synchronization behavior.</p> </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> <a name="typesystem">Type System</a> </div> +<h2><a name="typesystem">Type System</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>The LLVM type system is one of the most important features of the intermediate representation. Being typed enables a number of optimizations @@ -1471,13 +1480,12 @@ synchronization behavior.</p> and transformations that are not feasible to perform on normal three address code representations.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"> <a name="t_classifications">Type -Classifications</a> </div> +<h3> + <a name="t_classifications">Type Classifications</a> +</h3> -<div class="doc_text"> +<div> <p>The types fall into a few useful classifications:</p> @@ -1534,19 +1542,21 @@ Classifications</a> </div> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> <a name="t_primitive">Primitive Types</a> </div> +<h3> + <a name="t_primitive">Primitive Types</a> +</h3> -<div class="doc_text"> +<div> <p>The primitive types are the fundamental building blocks of the LLVM system.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> <a name="t_integer">Integer Type</a> </div> +<h4> + <a name="t_integer">Integer Type</a> +</h4> -<div class="doc_text"> +<div> <h5>Overview:</h5> <p>The integer type is a very simple type that simply specifies an arbitrary @@ -1580,9 +1590,11 @@ Classifications</a> </div> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> <a name="t_floating">Floating Point Types</a> </div> +<h4> + <a name="t_floating">Floating Point Types</a> +</h4> -<div class="doc_text"> +<div> <table> <tbody> @@ -1598,9 +1610,11 @@ Classifications</a> </div> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> <a name="t_x86mmx">X86mmx Type</a> </div> +<h4> + <a name="t_x86mmx">X86mmx Type</a> +</h4> -<div class="doc_text"> +<div> <h5>Overview:</h5> <p>The x86mmx type represents a value held in an MMX register on an x86 machine. The operations allowed on it are quite limited: parameters and return values, load and store, and bitcast. User-specified MMX instructions are represented as intrinsic or asm calls with arguments and/or results of this type. There are no arrays, vectors or constants of this type.</p> @@ -1613,9 +1627,11 @@ Classifications</a> </div> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> <a name="t_void">Void Type</a> </div> +<h4> + <a name="t_void">Void Type</a> +</h4> -<div class="doc_text"> +<div> <h5>Overview:</h5> <p>The void type does not represent any value and has no size.</p> @@ -1628,9 +1644,11 @@ Classifications</a> </div> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> <a name="t_label">Label Type</a> </div> +<h4> + <a name="t_label">Label Type</a> +</h4> -<div class="doc_text"> +<div> <h5>Overview:</h5> <p>The label type represents code labels.</p> @@ -1643,9 +1661,11 @@ Classifications</a> </div> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> <a name="t_metadata">Metadata Type</a> </div> +<h4> + <a name="t_metadata">Metadata Type</a> +</h4> -<div class="doc_text"> +<div> <h5>Overview:</h5> <p>The metadata type represents embedded metadata. No derived types may be @@ -1659,11 +1679,14 @@ Classifications</a> </div> </div> +</div> <!-- ======================================================================= --> -<div class="doc_subsection"> <a name="t_derived">Derived Types</a> </div> +<h3> + <a name="t_derived">Derived Types</a> +</h3> -<div class="doc_text"> +<div> <p>The real power in LLVM comes from the derived types in the system. This is what allows a programmer to represent arrays, functions, pointers, and other @@ -1673,12 +1696,12 @@ Classifications</a> </div> of another array.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> <a name="t_aggregate">Aggregate Types</a> </div> +<h4> + <a name="t_aggregate">Aggregate Types</a> +</h4> -<div class="doc_text"> +<div> <p>Aggregate Types are a subset of derived types that can contain multiple member types. <a href="#t_array">Arrays</a>, @@ -1688,9 +1711,11 @@ Classifications</a> </div> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> <a name="t_array">Array Type</a> </div> +<h4> + <a name="t_array">Array Type</a> +</h4> -<div class="doc_text"> +<div> <h5>Overview:</h5> <p>The array type is a very simple derived type that arranges elements @@ -1746,9 +1771,11 @@ Classifications</a> </div> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> <a name="t_function">Function Type</a> </div> +<h4> + <a name="t_function">Function Type</a> +</h4> -<div class="doc_text"> +<div> <h5>Overview:</h5> <p>The function type can be thought of as a function signature. It consists of @@ -1799,9 +1826,11 @@ Classifications</a> </div> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> <a name="t_struct">Structure Type</a> </div> +<h4> + <a name="t_struct">Structure Type</a> +</h4> -<div class="doc_text"> +<div> <h5>Overview:</h5> <p>The structure type is used to represent a collection of data members together @@ -1837,10 +1866,11 @@ Classifications</a> </div> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> <a name="t_pstruct">Packed Structure Type</a> -</div> +<h4> + <a name="t_pstruct">Packed Structure Type</a> +</h4> -<div class="doc_text"> +<div> <h5>Overview:</h5> <p>The packed structure type is used to represent a collection of data members @@ -1875,9 +1905,11 @@ Classifications</a> </div> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> <a name="t_pointer">Pointer Type</a> </div> +<h4> + <a name="t_pointer">Pointer Type</a> +</h4> -<div class="doc_text"> +<div> <h5>Overview:</h5> <p>The pointer type is used to specify memory locations. @@ -1919,9 +1951,11 @@ Classifications</a> </div> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> <a name="t_vector">Vector Type</a> </div> +<h4> + <a name="t_vector">Vector Type</a> +</h4> -<div class="doc_text"> +<div> <h5>Overview:</h5> <p>A vector type is a simple derived type that represents a vector of elements. @@ -1958,8 +1992,11 @@ Classifications</a> </div> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> <a name="t_opaque">Opaque Type</a> </div> -<div class="doc_text"> +<h4> + <a name="t_opaque">Opaque Type</a> +</h4> + +<div> <h5>Overview:</h5> <p>Opaque types are used to represent unknown types in the system. This @@ -1982,12 +2019,14 @@ Classifications</a> </div> </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="t_uprefs">Type Up-references</a> -</div> +</h3> -<div class="doc_text"> +<div> <h5>Overview:</h5> <p>An "up reference" allows you to refer to a lexically enclosing type without @@ -2030,21 +2069,23 @@ Classifications</a> </div> </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> <a name="constants">Constants</a> </div> +<h2><a name="constants">Constants</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>LLVM has several different basic types of constants. This section describes them all and their syntax.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"><a name="simpleconstants">Simple Constants</a></div> +<h3> + <a name="simpleconstants">Simple Constants</a> +</h3> -<div class="doc_text"> +<div> <dl> <dt><b>Boolean constants</b></dt> @@ -2097,12 +2138,12 @@ Classifications</a> </div> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="aggregateconstants"></a> <!-- old anchor --> <a name="complexconstants">Complex Constants</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Complex constants are a (potentially recursive) combination of simple constants and smaller complex constants.</p> @@ -2152,11 +2193,11 @@ Classifications</a> </div> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="globalconstants">Global Variable and Function Addresses</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The addresses of <a href="#globalvars">global variables</a> and <a href="#functionstructure">functions</a> are always implicitly valid @@ -2174,8 +2215,11 @@ Classifications</a> </div> </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="undefvalues">Undefined Values</a></div> -<div class="doc_text"> +<h3> + <a name="undefvalues">Undefined Values</a> +</h3> + +<div> <p>The string '<tt>undef</tt>' can be used anywhere a constant is expected, and indicates that the user of the value may receive an unspecified bit-pattern. @@ -2314,8 +2358,11 @@ b: unreachable </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="trapvalues">Trap Values</a></div> -<div class="doc_text"> +<h3> + <a name="trapvalues">Trap Values</a> +</h3> + +<div> <p>Trap values are similar to <a href="#undefvalues">undef values</a>, however instead of representing an unspecified bit pattern, they represent the @@ -2367,7 +2414,12 @@ b: unreachable <a href="#terminators">terminator instruction</a> if the terminator instruction has multiple successors and the instruction is always executed when control transfers to one of the successors, and - may not be executed when control is transfered to another.</li> + may not be executed when control is transferred to another.</li> + +<li>Additionally, an instruction also <i>control-depends</i> on a terminator + instruction if the set of instructions it otherwise depends on would be + different if the terminator had transferred control to a different + successor.</li> <li>Dependence is transitive.</li> @@ -2411,17 +2463,34 @@ end: ; control-dependent on %cmp, so this ; always results in a trap value. - volatile store i32 0, i32* @g ; %end is control-equivalent to %entry - ; so this is defined (ignoring earlier + volatile store i32 0, i32* @g ; This would depend on the store in %true + ; if %cmp is true, or the store in %entry + ; otherwise, so this is undefined behavior. + + %br i1 %cmp, %second_true, %second_end + ; The same branch again, but this time the + ; true block doesn't have side effects. + +second_true: + ; No side effects! + br label %end + +second_end: + volatile store i32 0, i32* @g ; This time, the instruction always depends + ; on the store in %end. Also, it is + ; control-equivalent to %end, so this is + ; well- defined (again, ignoring earlier ; undefined behavior in this example). </pre> </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="blockaddress">Addresses of Basic - Blocks</a></div> -<div class="doc_text"> +<h3> + <a name="blockaddress">Addresses of Basic Blocks</a> +</h3> + +<div> <p><b><tt>blockaddress(@function, %block)</tt></b></p> @@ -2446,10 +2515,11 @@ end: <!-- ======================================================================= --> -<div class="doc_subsection"><a name="constantexprs">Constant Expressions</a> -</div> +<h3> + <a name="constantexprs">Constant Expressions</a> +</h3> -<div class="doc_text"> +<div> <p>Constant expressions are used to allow expressions involving other constants to be used as constants. Constant expressions may be of @@ -2575,16 +2645,18 @@ end: </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> <a name="othervalues">Other Values</a> </div> +<h2><a name="othervalues">Other Values</a></h2> <!-- *********************************************************************** --> - +<div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="inlineasm">Inline Assembler Expressions</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>LLVM supports inline assembler expressions (as opposed to <a href="#moduleasm"> Module-Level Inline Assembly</a>) through the use of @@ -2633,13 +2705,12 @@ call void asm alignstack "eieio", ""() documented here. Constraints on what can be done (e.g. duplication, moving, etc need to be documented). This is probably best done by reference to another document that covers inline asm from a holistic perspective.</p> -</div> -<div class="doc_subsubsection"> +<h4> <a name="inlineasm_md">Inline Asm Metadata</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>The call instructions that wrap inline asm nodes may have a "!srcloc" MDNode attached to it that contains a list of constant integers. If present, the @@ -2660,12 +2731,14 @@ call void asm sideeffect "something bad", ""()<b>, !srcloc !42</b> </div> -<!-- ======================================================================= --> -<div class="doc_subsection"><a name="metadata">Metadata Nodes and Metadata - Strings</a> </div> -<div class="doc_text"> +<!-- ======================================================================= --> +<h3> + <a name="metadata">Metadata Nodes and Metadata Strings</a> +</h3> + +<div> <p>LLVM IR allows metadata to be attached to instructions in the program that can convey extra information about the code to the optimizers and code @@ -2690,25 +2763,31 @@ call void asm sideeffect "something bad", ""()<b>, !srcloc !42</b> <p>Metadata can be used as function arguments. Here <tt>llvm.dbg.value</tt> function is using two metadata arguments.</p> - <pre class="doc_code"> - call void @llvm.dbg.value(metadata !24, i64 0, metadata !25) - </pre> +<div class="doc_code"> +<pre> +call void @llvm.dbg.value(metadata !24, i64 0, metadata !25) +</pre> +</div> <p>Metadata can be attached with an instruction. Here metadata <tt>!21</tt> is attached with <tt>add</tt> instruction using <tt>!dbg</tt> identifier.</p> - <pre class="doc_code"> - %indvar.next = add i64 %indvar, 1, !dbg !21 - </pre> +<div class="doc_code"> +<pre> +%indvar.next = add i64 %indvar, 1, !dbg !21 +</pre> +</div> + </div> +</div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="intrinsic_globals">Intrinsic Global Variables</a> -</div> +</h2> <!-- *********************************************************************** --> - +<div> <p>LLVM has a number of "magic" global variables that contain data that affect code generation or other IR semantics. These are documented here. All globals of this sort should have a section specified as "<tt>llvm.metadata</tt>". This @@ -2716,11 +2795,11 @@ section and all globals that start with "<tt>llvm.</tt>" are reserved for use by LLVM.</p> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="intg_used">The '<tt>llvm.used</tt>' Global Variable</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The <tt>@llvm.used</tt> global is an array with i8* element type which has <a href="#linkage_appending">appending linkage</a>. This array contains a list of @@ -2751,11 +2830,13 @@ object file to prevent the assembler and linker from molesting the symbol.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> -<a name="intg_compiler_used">The '<tt>llvm.compiler.used</tt>' Global Variable</a> -</div> +<h3> + <a name="intg_compiler_used"> + The '<tt>llvm.compiler.used</tt>' Global Variable + </a> +</h3> -<div class="doc_text"> +<div> <p>The <tt>@llvm.compiler.used</tt> directive is the same as the <tt>@llvm.used</tt> directive, except that it only prevents the compiler from @@ -2769,11 +2850,11 @@ should not be exposed to source languages.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="intg_global_ctors">The '<tt>llvm.global_ctors</tt>' Global Variable</a> -</div> +</h3> -<div class="doc_text"> +<div> <pre> %0 = type { i32, void ()* } @llvm.global_ctors = appending global [1 x %0] [%0 { i32 65535, void ()* @ctor }] @@ -2784,11 +2865,11 @@ should not be exposed to source languages.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="intg_global_dtors">The '<tt>llvm.global_dtors</tt>' Global Variable</a> -</div> +</h3> -<div class="doc_text"> +<div> <pre> %0 = type { i32, void ()* } @llvm.global_dtors = appending global [1 x %0] [%0 { i32 65535, void ()* @dtor }] @@ -2799,12 +2880,13 @@ should not be exposed to source languages.</p> </div> +</div> <!-- *********************************************************************** --> -<div class="doc_section"> <a name="instref">Instruction Reference</a> </div> +<h2><a name="instref">Instruction Reference</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>The LLVM instruction set consists of several different classifications of instructions: <a href="#terminators">terminator @@ -2813,13 +2895,12 @@ should not be exposed to source languages.</p> <a href="#memoryops">memory instructions</a>, and <a href="#otherops">other instructions</a>.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"> <a name="terminators">Terminator -Instructions</a> </div> +<h3> + <a name="terminators">Terminator Instructions</a> +</h3> -<div class="doc_text"> +<div> <p>As mentioned <a href="#functionstructure">previously</a>, every basic block in a program ends with a "Terminator" instruction, which indicates which @@ -2837,13 +2918,12 @@ Instructions</a> </div> '<a href="#i_unwind"><tt>unwind</tt></a>' instruction, and the '<a href="#i_unreachable"><tt>unreachable</tt></a>' instruction.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> <a name="i_ret">'<tt>ret</tt>' -Instruction</a> </div> +<h4> + <a name="i_ret">'<tt>ret</tt>' Instruction</a> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -2889,9 +2969,11 @@ Instruction</a> </div> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> <a name="i_br">'<tt>br</tt>' Instruction</a> </div> +<h4> + <a name="i_br">'<tt>br</tt>' Instruction</a> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -2930,11 +3012,11 @@ IfUnequal: </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="i_switch">'<tt>switch</tt>' Instruction</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -2985,11 +3067,11 @@ IfUnequal: <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="i_indirectbr">'<tt>indirectbr</tt>' Instruction</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -3033,11 +3115,11 @@ IfUnequal: <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="i_invoke">'<tt>invoke</tt>' Instruction</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -3123,10 +3205,11 @@ that the invoke/unwind semantics are likely to change in future versions.</p> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> <a name="i_unwind">'<tt>unwind</tt>' -Instruction</a> </div> +<h4> + <a name="i_unwind">'<tt>unwind</tt>' Instruction</a> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -3154,10 +3237,11 @@ that the invoke/unwind semantics are likely to change in future versions.</p> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> <a name="i_unreachable">'<tt>unreachable</tt>' -Instruction</a> </div> +<h4> + <a name="i_unreachable">'<tt>unreachable</tt>' Instruction</a> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -3175,10 +3259,14 @@ Instruction</a> </div> </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> <a name="binaryops">Binary Operations</a> </div> +<h3> + <a name="binaryops">Binary Operations</a> +</h3> -<div class="doc_text"> +<div> <p>Binary operators are used to do most of the computation in a program. They require two operands of the same type, execute an operation on them, and @@ -3188,14 +3276,12 @@ Instruction</a> </div> <p>There are several different binary operators:</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="i_add">'<tt>add</tt>' Instruction</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -3236,11 +3322,11 @@ Instruction</a> </div> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="i_fadd">'<tt>fadd</tt>' Instruction</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -3266,11 +3352,11 @@ Instruction</a> </div> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="i_sub">'<tt>sub</tt>' Instruction</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -3318,11 +3404,11 @@ Instruction</a> </div> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="i_fsub">'<tt>fsub</tt>' Instruction</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -3354,11 +3440,11 @@ Instruction</a> </div> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="i_mul">'<tt>mul</tt>' Instruction</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -3404,11 +3490,11 @@ Instruction</a> </div> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="i_fmul">'<tt>fmul</tt>' Instruction</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -3434,10 +3520,11 @@ Instruction</a> </div> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> <a name="i_udiv">'<tt>udiv</tt>' Instruction -</a></div> +<h4> + <a name="i_udiv">'<tt>udiv</tt>' Instruction</a> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -3474,10 +3561,11 @@ Instruction</a> </div> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> <a name="i_sdiv">'<tt>sdiv</tt>' Instruction -</a> </div> +<h4> + <a name="i_sdiv">'<tt>sdiv</tt>' Instruction</a> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -3516,10 +3604,11 @@ Instruction</a> </div> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> <a name="i_fdiv">'<tt>fdiv</tt>' -Instruction</a> </div> +<h4> + <a name="i_fdiv">'<tt>fdiv</tt>' Instruction</a> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -3545,10 +3634,11 @@ Instruction</a> </div> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> <a name="i_urem">'<tt>urem</tt>' Instruction</a> -</div> +<h4> + <a name="i_urem">'<tt>urem</tt>' Instruction</a> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -3582,11 +3672,11 @@ Instruction</a> </div> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="i_srem">'<tt>srem</tt>' Instruction</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -3606,9 +3696,10 @@ Instruction</a> </div> <h5>Semantics:</h5> <p>This instruction returns the <i>remainder</i> of a division (where the result - has the same sign as the dividend, <tt>op1</tt>), not the <i>modulo</i> - operator (where the result has the same sign as the divisor, <tt>op2</tt>) of - a value. For more information about the difference, + is either zero or has the same sign as the dividend, <tt>op1</tt>), not the + <i>modulo</i> operator (where the result is either zero or has the same sign + as the divisor, <tt>op2</tt>) of a value. + For more information about the difference, see <a href="http://mathforum.org/dr.math/problems/anne.4.28.99.html">The Math Forum</a>. For a table of how this is implemented in various languages, please see <a href="http://en.wikipedia.org/wiki/Modulo_operation"> @@ -3632,10 +3723,11 @@ Instruction</a> </div> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> - <a name="i_frem">'<tt>frem</tt>' Instruction</a> </div> +<h4> + <a name="i_frem">'<tt>frem</tt>' Instruction</a> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -3662,11 +3754,14 @@ Instruction</a> </div> </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> <a name="bitwiseops">Bitwise Binary -Operations</a> </div> +<h3> + <a name="bitwiseops">Bitwise Binary Operations</a> +</h3> -<div class="doc_text"> +<div> <p>Bitwise binary operators are used to do various forms of bit-twiddling in a program. They are generally very efficient instructions and can commonly be @@ -3674,13 +3769,12 @@ Operations</a> </div> same type, execute an operation on them, and produce a single value. The resulting value is the same type as its operands.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> <a name="i_shl">'<tt>shl</tt>' -Instruction</a> </div> +<h4> + <a name="i_shl">'<tt>shl</tt>' Instruction</a> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -3727,10 +3821,11 @@ Instruction</a> </div> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> <a name="i_lshr">'<tt>lshr</tt>' -Instruction</a> </div> +<h4> + <a name="i_lshr">'<tt>lshr</tt>' Instruction</a> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -3773,9 +3868,11 @@ Instruction</a> </div> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> <a name="i_ashr">'<tt>ashr</tt>' -Instruction</a> </div> -<div class="doc_text"> +<h4> + <a name="i_ashr">'<tt>ashr</tt>' Instruction</a> +</h4> + +<div> <h5>Syntax:</h5> <pre> @@ -3818,10 +3915,11 @@ Instruction</a> </div> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> <a name="i_and">'<tt>and</tt>' -Instruction</a> </div> +<h4> + <a name="i_and">'<tt>and</tt>' Instruction</a> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -3878,9 +3976,11 @@ Instruction</a> </div> </pre> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> <a name="i_or">'<tt>or</tt>' Instruction</a> </div> +<h4> + <a name="i_or">'<tt>or</tt>' Instruction</a> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -3939,10 +4039,11 @@ Instruction</a> </div> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> <a name="i_xor">'<tt>xor</tt>' -Instruction</a> </div> +<h4> + <a name="i_xor">'<tt>xor</tt>' Instruction</a> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -4002,12 +4103,14 @@ Instruction</a> </div> </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="vectorops">Vector Operations</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>LLVM supports several instructions to represent vector operations in a target-independent manner. These instructions cover the element-access and @@ -4016,14 +4119,12 @@ Instruction</a> </div> will want to use target-specific intrinsics to take full advantage of a specific target.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="i_extractelement">'<tt>extractelement</tt>' Instruction</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -4055,11 +4156,11 @@ Instruction</a> </div> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="i_insertelement">'<tt>insertelement</tt>' Instruction</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -4091,11 +4192,11 @@ Instruction</a> </div> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="i_shufflevector">'<tt>shufflevector</tt>' Instruction</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -4138,24 +4239,24 @@ Instruction</a> </div> </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="aggregateops">Aggregate Operations</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>LLVM supports several instructions for working with <a href="#t_aggregate">aggregate</a> values.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="i_extractvalue">'<tt>extractvalue</tt>' Instruction</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -4193,11 +4294,11 @@ Instruction</a> </div> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="i_insertvalue">'<tt>insertvalue</tt>' Instruction</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -4231,27 +4332,26 @@ Instruction</a> </div> </div> +</div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="memoryops">Memory Access and Addressing Operations</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>A key design point of an SSA-based representation is how it represents memory. In LLVM, no memory locations are in SSA form, which makes things very simple. This section describes how to read, write, and allocate memory in LLVM.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="i_alloca">'<tt>alloca</tt>' Instruction</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -4298,10 +4398,11 @@ Instruction</a> </div> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> <a name="i_load">'<tt>load</tt>' -Instruction</a> </div> +<h4> + <a name="i_load">'<tt>load</tt>' Instruction</a> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -4356,10 +4457,11 @@ Instruction</a> </div> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> <a name="i_store">'<tt>store</tt>' -Instruction</a> </div> +<h4> + <a name="i_store">'<tt>store</tt>' Instruction</a> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -4417,11 +4519,11 @@ Instruction</a> </div> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="i_getelementptr">'<tt>getelementptr</tt>' Instruction</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -4547,23 +4649,25 @@ entry: </div> -<!-- ======================================================================= --> -<div class="doc_subsection"> <a name="convertops">Conversion Operations</a> </div> -<div class="doc_text"> +<!-- ======================================================================= --> +<h3> + <a name="convertops">Conversion Operations</a> +</h3> + +<div> <p>The instructions in this category are the conversion instructions (casting) which all take a single operand and a type. They perform various bit conversions on the operand.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="i_trunc">'<tt>trunc .. to</tt>' Instruction</a> -</div> -<div class="doc_text"> +</h4> + +<div> <h5>Syntax:</h5> <pre> @@ -4599,10 +4703,11 @@ entry: </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="i_zext">'<tt>zext .. to</tt>' Instruction</a> -</div> -<div class="doc_text"> +</h4> + +<div> <h5>Syntax:</h5> <pre> @@ -4638,10 +4743,11 @@ entry: </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="i_sext">'<tt>sext .. to</tt>' Instruction</a> -</div> -<div class="doc_text"> +</h4> + +<div> <h5>Syntax:</h5> <pre> @@ -4676,11 +4782,11 @@ entry: </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="i_fptrunc">'<tt>fptrunc .. to</tt>' Instruction</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -4714,10 +4820,11 @@ entry: </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="i_fpext">'<tt>fpext .. to</tt>' Instruction</a> -</div> -<div class="doc_text"> +</h4> + +<div> <h5>Syntax:</h5> <pre> @@ -4743,17 +4850,18 @@ entry: <h5>Example:</h5> <pre> - %X = fpext float 3.1415 to double <i>; yields double:3.1415</i> - %Y = fpext float 1.0 to float <i>; yields float:1.0 (no-op)</i> + %X = fpext float 3.125 to double <i>; yields double:3.125000e+00</i> + %Y = fpext double %X to fp128 <i>; yields fp128:0xL00000000000000004000900000000000</i> </pre> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="i_fptoui">'<tt>fptoui .. to</tt>' Instruction</a> -</div> -<div class="doc_text"> +</h4> + +<div> <h5>Syntax:</h5> <pre> @@ -4787,10 +4895,11 @@ entry: </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="i_fptosi">'<tt>fptosi .. to</tt>' Instruction</a> -</div> -<div class="doc_text"> +</h4> + +<div> <h5>Syntax:</h5> <pre> @@ -4825,10 +4934,11 @@ entry: </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="i_uitofp">'<tt>uitofp .. to</tt>' Instruction</a> -</div> -<div class="doc_text"> +</h4> + +<div> <h5>Syntax:</h5> <pre> @@ -4861,10 +4971,11 @@ entry: </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="i_sitofp">'<tt>sitofp .. to</tt>' Instruction</a> -</div> -<div class="doc_text"> +</h4> + +<div> <h5>Syntax:</h5> <pre> @@ -4896,10 +5007,11 @@ entry: </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="i_ptrtoint">'<tt>ptrtoint .. to</tt>' Instruction</a> -</div> -<div class="doc_text"> +</h4> + +<div> <h5>Syntax:</h5> <pre> @@ -4933,10 +5045,11 @@ entry: </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="i_inttoptr">'<tt>inttoptr .. to</tt>' Instruction</a> -</div> -<div class="doc_text"> +</h4> + +<div> <h5>Syntax:</h5> <pre> @@ -4970,10 +5083,11 @@ entry: </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="i_bitcast">'<tt>bitcast .. to</tt>' Instruction</a> -</div> -<div class="doc_text"> +</h4> + +<div> <h5>Syntax:</h5> <pre> @@ -5012,21 +5126,24 @@ entry: </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> <a name="otherops">Other Operations</a> </div> +<h3> + <a name="otherops">Other Operations</a> +</h3> -<div class="doc_text"> +<div> <p>The instructions in this category are the "miscellaneous" instructions, which defy better classification.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"><a name="i_icmp">'<tt>icmp</tt>' Instruction</a> -</div> +<h4> + <a name="i_icmp">'<tt>icmp</tt>' Instruction</a> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -5125,10 +5242,11 @@ entry: </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"><a name="i_fcmp">'<tt>fcmp</tt>' Instruction</a> -</div> +<h4> + <a name="i_fcmp">'<tt>fcmp</tt>' Instruction</a> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -5245,11 +5363,11 @@ entry: </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="i_phi">'<tt>phi</tt>' Instruction</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -5293,11 +5411,11 @@ Loop: ; Infinite loop that counts from 0 on up... </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="i_select">'<tt>select</tt>' Instruction</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -5336,11 +5454,11 @@ Loop: ; Infinite loop that counts from 0 on up... </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="i_call">'<tt>call</tt>' Instruction</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -5445,11 +5563,11 @@ freestanding environments and non-C-based languages.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="i_va_arg">'<tt>va_arg</tt>' Instruction</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -5490,11 +5608,15 @@ freestanding environments and non-C-based languages.</p> </div> +</div> + +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> <a name="intrinsics">Intrinsic Functions</a> </div> +<h2><a name="intrinsics">Intrinsic Functions</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>LLVM supports the notion of an "intrinsic function". These functions have well known names and semantics and are required to follow certain @@ -5537,14 +5659,12 @@ freestanding environments and non-C-based languages.</p> <p>To learn how to add an intrinsic function, please see the <a href="ExtendingLLVM.html">Extending LLVM Guide</a>.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="int_varargs">Variable Argument Handling Intrinsics</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Variable argument support is defined in LLVM with the <a href="#i_va_arg"><tt>va_arg</tt></a> instruction and these three @@ -5586,15 +5706,13 @@ declare void @llvm.va_copy(i8*, i8*) declare void @llvm.va_end(i8*) </pre> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="int_va_start">'<tt>llvm.va_start</tt>' Intrinsic</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -5620,11 +5738,11 @@ declare void @llvm.va_end(i8*) </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="int_va_end">'<tt>llvm.va_end</tt>' Intrinsic</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -5651,11 +5769,11 @@ declare void @llvm.va_end(i8*) </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="int_va_copy">'<tt>llvm.va_copy</tt>' Intrinsic</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -5681,12 +5799,14 @@ declare void @llvm.va_end(i8*) </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="int_gc">Accurate Garbage Collection Intrinsics</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>LLVM support for <a href="GarbageCollection.html">Accurate Garbage Collection</a> (GC) requires the implementation and generation of these @@ -5701,14 +5821,12 @@ LLVM</a>.</p> <p>The garbage collection intrinsics only operate on objects in the generic address space (address space zero).</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="int_gcroot">'<tt>llvm.gcroot</tt>' Intrinsic</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -5735,11 +5853,11 @@ LLVM</a>.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="int_gcread">'<tt>llvm.gcread</tt>' Intrinsic</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -5767,11 +5885,11 @@ LLVM</a>.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="int_gcwrite">'<tt>llvm.gcwrite</tt>' Intrinsic</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -5798,24 +5916,24 @@ LLVM</a>.</p> </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="int_codegen">Code Generator Intrinsics</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>These intrinsics are provided by LLVM to expose special features that may only be implemented with code generator support.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="int_returnaddress">'<tt>llvm.returnaddress</tt>' Intrinsic</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -5846,11 +5964,11 @@ LLVM</a>.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="int_frameaddress">'<tt>llvm.frameaddress</tt>' Intrinsic</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -5880,11 +5998,11 @@ LLVM</a>.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="int_stacksave">'<tt>llvm.stacksave</tt>' Intrinsic</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -5910,11 +6028,11 @@ LLVM</a>.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="int_stackrestore">'<tt>llvm.stackrestore</tt>' Intrinsic</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -5935,11 +6053,11 @@ LLVM</a>.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="int_prefetch">'<tt>llvm.prefetch</tt>' Intrinsic</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -5968,11 +6086,11 @@ LLVM</a>.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="int_pcmarker">'<tt>llvm.pcmarker</tt>' Intrinsic</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -5999,11 +6117,11 @@ LLVM</a>.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="int_readcyclecounter">'<tt>llvm.readcyclecounter</tt>' Intrinsic</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -6025,26 +6143,26 @@ LLVM</a>.</p> </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="int_libc">Standard C Library Intrinsics</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>LLVM provides intrinsics for a few important standard C library functions. These intrinsics allow source-language front-ends to pass information about the alignment of the pointer arguments to the code generator, providing opportunity for more efficient code generation.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="int_memcpy">'<tt>llvm.memcpy</tt>' Intrinsic</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <p>This is an overloaded intrinsic. You can use <tt>llvm.memcpy</tt> on any @@ -6094,11 +6212,11 @@ LLVM</a>.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="int_memmove">'<tt>llvm.memmove</tt>' Intrinsic</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <p>This is an overloaded intrinsic. You can use llvm.memmove on any integer bit @@ -6150,11 +6268,11 @@ LLVM</a>.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="int_memset">'<tt>llvm.memset.*</tt>' Intrinsics</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <p>This is an overloaded intrinsic. You can use llvm.memset on any integer bit @@ -6200,11 +6318,11 @@ LLVM</a>.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="int_sqrt">'<tt>llvm.sqrt.*</tt>' Intrinsic</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <p>This is an overloaded intrinsic. You can use <tt>llvm.sqrt</tt> on any @@ -6238,11 +6356,11 @@ LLVM</a>.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="int_powi">'<tt>llvm.powi.*</tt>' Intrinsic</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <p>This is an overloaded intrinsic. You can use <tt>llvm.powi</tt> on any @@ -6274,11 +6392,11 @@ LLVM</a>.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="int_sin">'<tt>llvm.sin.*</tt>' Intrinsic</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <p>This is an overloaded intrinsic. You can use <tt>llvm.sin</tt> on any @@ -6308,11 +6426,11 @@ LLVM</a>.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="int_cos">'<tt>llvm.cos.*</tt>' Intrinsic</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <p>This is an overloaded intrinsic. You can use <tt>llvm.cos</tt> on any @@ -6342,11 +6460,11 @@ LLVM</a>.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="int_pow">'<tt>llvm.pow.*</tt>' Intrinsic</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <p>This is an overloaded intrinsic. You can use <tt>llvm.pow</tt> on any @@ -6376,24 +6494,24 @@ LLVM</a>.</p> </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="int_manip">Bit Manipulation Intrinsics</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>LLVM provides intrinsics for a few important bit manipulation operations. These allow efficient code generation for some algorithms.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="int_bswap">'<tt>llvm.bswap.*</tt>' Intrinsics</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <p>This is an overloaded intrinsic function. You can use bswap on any integer @@ -6424,11 +6542,11 @@ LLVM</a>.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="int_ctpop">'<tt>llvm.ctpop.*</tt>' Intrinsic</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <p>This is an overloaded intrinsic. You can use llvm.ctpop on any integer bit @@ -6456,11 +6574,11 @@ LLVM</a>.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="int_ctlz">'<tt>llvm.ctlz.*</tt>' Intrinsic</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <p>This is an overloaded intrinsic. You can use <tt>llvm.ctlz</tt> on any @@ -6490,11 +6608,11 @@ LLVM</a>.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="int_cttz">'<tt>llvm.cttz.*</tt>' Intrinsic</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <p>This is an overloaded intrinsic. You can use <tt>llvm.cttz</tt> on any @@ -6523,23 +6641,25 @@ LLVM</a>.</p> </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="int_overflow">Arithmetic with Overflow Intrinsics</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>LLVM provides intrinsics for some arithmetic with overflow operations.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> - <a name="int_sadd_overflow">'<tt>llvm.sadd.with.overflow.*</tt>' Intrinsics</a> -</div> +<h4> + <a name="int_sadd_overflow"> + '<tt>llvm.sadd.with.overflow.*</tt>' Intrinsics + </a> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <p>This is an overloaded intrinsic. You can use <tt>llvm.sadd.with.overflow</tt> @@ -6581,11 +6701,13 @@ LLVM</a>.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> - <a name="int_uadd_overflow">'<tt>llvm.uadd.with.overflow.*</tt>' Intrinsics</a> -</div> +<h4> + <a name="int_uadd_overflow"> + '<tt>llvm.uadd.with.overflow.*</tt>' Intrinsics + </a> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <p>This is an overloaded intrinsic. You can use <tt>llvm.uadd.with.overflow</tt> @@ -6626,11 +6748,13 @@ LLVM</a>.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> - <a name="int_ssub_overflow">'<tt>llvm.ssub.with.overflow.*</tt>' Intrinsics</a> -</div> +<h4> + <a name="int_ssub_overflow"> + '<tt>llvm.ssub.with.overflow.*</tt>' Intrinsics + </a> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <p>This is an overloaded intrinsic. You can use <tt>llvm.ssub.with.overflow</tt> @@ -6672,11 +6796,13 @@ LLVM</a>.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> - <a name="int_usub_overflow">'<tt>llvm.usub.with.overflow.*</tt>' Intrinsics</a> -</div> +<h4> + <a name="int_usub_overflow"> + '<tt>llvm.usub.with.overflow.*</tt>' Intrinsics + </a> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <p>This is an overloaded intrinsic. You can use <tt>llvm.usub.with.overflow</tt> @@ -6718,11 +6844,13 @@ LLVM</a>.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> - <a name="int_smul_overflow">'<tt>llvm.smul.with.overflow.*</tt>' Intrinsics</a> -</div> +<h4> + <a name="int_smul_overflow"> + '<tt>llvm.smul.with.overflow.*</tt>' Intrinsics + </a> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <p>This is an overloaded intrinsic. You can use <tt>llvm.smul.with.overflow</tt> @@ -6765,11 +6893,13 @@ LLVM</a>.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> - <a name="int_umul_overflow">'<tt>llvm.umul.with.overflow.*</tt>' Intrinsics</a> -</div> +<h4> + <a name="int_umul_overflow"> + '<tt>llvm.umul.with.overflow.*</tt>' Intrinsics + </a> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <p>This is an overloaded intrinsic. You can use <tt>llvm.umul.with.overflow</tt> @@ -6810,12 +6940,14 @@ LLVM</a>.</p> </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="int_fp16">Half Precision Floating Point Intrinsics</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Half precision floating point is a storage-only format. This means that it is a dense encoding (in memory) but does not support computation in the @@ -6829,14 +6961,15 @@ LLVM</a>.</p> float if needed, then converted to i16 with <a href="#int_convert_to_fp16"><tt>llvm.convert.to.fp16</tt></a>, then storing as an i16 value.</p> -</div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> - <a name="int_convert_to_fp16">'<tt>llvm.convert.to.fp16</tt>' Intrinsic</a> -</div> +<h4> + <a name="int_convert_to_fp16"> + '<tt>llvm.convert.to.fp16</tt>' Intrinsic + </a> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -6867,11 +7000,13 @@ LLVM</a>.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> - <a name="int_convert_from_fp16">'<tt>llvm.convert.from.fp16</tt>' Intrinsic</a> -</div> +<h4> + <a name="int_convert_from_fp16"> + '<tt>llvm.convert.from.fp16</tt>' Intrinsic + </a> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -6901,12 +7036,14 @@ LLVM</a>.</p> </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="int_debugger">Debugger Intrinsics</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The LLVM debugger intrinsics (which all start with <tt>llvm.dbg.</tt> prefix), are described in @@ -6916,11 +7053,11 @@ LLVM</a>.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="int_eh">Exception Handling Intrinsics</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The LLVM exception handling intrinsics (which all start with <tt>llvm.eh.</tt> prefix), are described in @@ -6930,11 +7067,11 @@ LLVM</a>.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="int_trampoline">Trampoline Intrinsic</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>This intrinsic makes it possible to excise one parameter, marked with the <a href="#nest"><tt>nest</tt></a> attribute, from a function. @@ -6960,14 +7097,14 @@ LLVM</a>.</p> <p>The call <tt>%val = call i32 %fp(i32 %x, i32 %y)</tt> is then equivalent to <tt>%val = call i32 %f(i8* %nval, i32 %x, i32 %y)</tt>.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> - <a name="int_it">'<tt>llvm.init.trampoline</tt>' Intrinsic</a> -</div> +<h4> + <a name="int_it"> + '<tt>llvm.init.trampoline</tt>' Intrinsic + </a> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -7004,12 +7141,14 @@ LLVM</a>.</p> </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="int_atomics">Atomic Operations and Synchronization Intrinsics</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>These intrinsic functions expand the "universal IR" of LLVM to represent hardware constructs for atomic operations and memory synchronization. This @@ -7029,13 +7168,12 @@ LLVM</a>.</p> No one model or paradigm should be selected above others unless the hardware itself ubiquitously does so.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="int_memory_barrier">'<tt>llvm.memory.barrier</tt>' Intrinsic</a> -</div> -<div class="doc_text"> +</h4> + +<div> <h5>Syntax:</h5> <pre> declare void @llvm.memory.barrier(i1 <ll>, i1 <ls>, i1 <sl>, i1 <ss>, i1 <device>) @@ -7103,11 +7241,11 @@ LLVM</a>.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="int_atomic_cmp_swap">'<tt>llvm.atomic.cmp.swap.*</tt>' Intrinsic</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <p>This is an overloaded intrinsic. You can use <tt>llvm.atomic.cmp.swap</tt> on @@ -7163,10 +7301,11 @@ LLVM</a>.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="int_atomic_swap">'<tt>llvm.atomic.swap.*</tt>' Intrinsic</a> -</div> -<div class="doc_text"> +</h4> + +<div> <h5>Syntax:</h5> <p>This is an overloaded intrinsic. You can use <tt>llvm.atomic.swap</tt> on any @@ -7219,12 +7358,11 @@ LLVM</a>.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="int_atomic_load_add">'<tt>llvm.atomic.load.add.*</tt>' Intrinsic</a> +</h4> -</div> - -<div class="doc_text"> +<div> <h5>Syntax:</h5> <p>This is an overloaded intrinsic. You can use <tt>llvm.atomic.load.add</tt> on @@ -7269,12 +7407,11 @@ LLVM</a>.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="int_atomic_load_sub">'<tt>llvm.atomic.load.sub.*</tt>' Intrinsic</a> +</h4> -</div> - -<div class="doc_text"> +<div> <h5>Syntax:</h5> <p>This is an overloaded intrinsic. You can use <tt>llvm.atomic.load.sub</tt> on @@ -7321,14 +7458,25 @@ LLVM</a>.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> - <a name="int_atomic_load_and">'<tt>llvm.atomic.load.and.*</tt>' Intrinsic</a><br> - <a name="int_atomic_load_nand">'<tt>llvm.atomic.load.nand.*</tt>' Intrinsic</a><br> - <a name="int_atomic_load_or">'<tt>llvm.atomic.load.or.*</tt>' Intrinsic</a><br> - <a name="int_atomic_load_xor">'<tt>llvm.atomic.load.xor.*</tt>' Intrinsic</a><br> -</div> - -<div class="doc_text"> +<h4> + <a name="int_atomic_load_and"> + '<tt>llvm.atomic.load.and.*</tt>' Intrinsic + </a> + <br> + <a name="int_atomic_load_nand"> + '<tt>llvm.atomic.load.nand.*</tt>' Intrinsic + </a> + <br> + <a name="int_atomic_load_or"> + '<tt>llvm.atomic.load.or.*</tt>' Intrinsic + </a> + <br> + <a name="int_atomic_load_xor"> + '<tt>llvm.atomic.load.xor.*</tt>' Intrinsic + </a> +</h4> + +<div> <h5>Syntax:</h5> <p>These are overloaded intrinsics. You can @@ -7401,14 +7549,25 @@ LLVM</a>.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> - <a name="int_atomic_load_max">'<tt>llvm.atomic.load.max.*</tt>' Intrinsic</a><br> - <a name="int_atomic_load_min">'<tt>llvm.atomic.load.min.*</tt>' Intrinsic</a><br> - <a name="int_atomic_load_umax">'<tt>llvm.atomic.load.umax.*</tt>' Intrinsic</a><br> - <a name="int_atomic_load_umin">'<tt>llvm.atomic.load.umin.*</tt>' Intrinsic</a><br> -</div> - -<div class="doc_text"> +<h4> + <a name="int_atomic_load_max"> + '<tt>llvm.atomic.load.max.*</tt>' Intrinsic + </a> + <br> + <a name="int_atomic_load_min"> + '<tt>llvm.atomic.load.min.*</tt>' Intrinsic + </a> + <br> + <a name="int_atomic_load_umax"> + '<tt>llvm.atomic.load.umax.*</tt>' Intrinsic + </a> + <br> + <a name="int_atomic_load_umin"> + '<tt>llvm.atomic.load.umin.*</tt>' Intrinsic + </a> +</h4> + +<div> <h5>Syntax:</h5> <p>These are overloaded intrinsics. You can use <tt>llvm.atomic.load_max</tt>, @@ -7479,25 +7638,24 @@ LLVM</a>.</p> </div> +</div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="int_memorymarkers">Memory Use Markers</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>This class of intrinsics exists to information about the lifetime of memory objects and ranges where variables are immutable.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="int_lifetime_start">'<tt>llvm.lifetime.start</tt>' Intrinsic</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -7523,11 +7681,11 @@ LLVM</a>.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="int_lifetime_end">'<tt>llvm.lifetime.end</tt>' Intrinsic</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -7552,11 +7710,11 @@ LLVM</a>.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="int_invariant_start">'<tt>llvm.invariant.start</tt>' Intrinsic</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -7580,11 +7738,11 @@ LLVM</a>.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="int_invariant_end">'<tt>llvm.invariant.end</tt>' Intrinsic</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -7606,24 +7764,24 @@ LLVM</a>.</p> </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="int_general">General Intrinsics</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>This class of intrinsics is designed to be generic and has no specific purpose.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="int_var_annotation">'<tt>llvm.var.annotation</tt>' Intrinsic</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -7647,11 +7805,11 @@ LLVM</a>.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="int_annotation">'<tt>llvm.annotation.*</tt>' Intrinsic</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <p>This is an overloaded intrinsic. You can use '<tt>llvm.annotation</tt>' on @@ -7683,11 +7841,11 @@ LLVM</a>.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="int_trap">'<tt>llvm.trap</tt>' Intrinsic</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -7708,11 +7866,11 @@ LLVM</a>.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="int_stackprotector">'<tt>llvm.stackprotector</tt>' Intrinsic</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -7742,11 +7900,11 @@ LLVM</a>.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="int_objectsize">'<tt>llvm.objectsize</tt>' Intrinsic</a> -</div> +</h4> -<div class="doc_text"> +<div> <h5>Syntax:</h5> <pre> @@ -7776,6 +7934,10 @@ LLVM</a>.</p> </div> +</div> + +</div> + <!-- *********************************************************************** --> <hr> <address> @@ -7785,8 +7947,8 @@ LLVM</a>.</p> src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a> <a href="mailto:sabre@nondot.org">Chris Lattner</a><br> - <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br> - Last modified: $Date: 2011-02-24 22:01:34 +0100 (Thu, 24 Feb 2011) $ + <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br> + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> diff --git a/docs/Lexicon.html b/docs/Lexicon.html index 09fae3996605..449e26eb922e 100644 --- a/docs/Lexicon.html +++ b/docs/Lexicon.html @@ -9,12 +9,12 @@ content="A glossary of terms used with the LLVM project."> </head> <body> -<div class="doc_title">The LLVM Lexicon</div> +<h1>The LLVM Lexicon</h1> <p class="doc_warning">NOTE: This document is a work in progress!</p> <!-- *********************************************************************** --> -<div class="doc_section">Table Of Contents</div> +<h2>Table Of Contents</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <table> <tr><th colspan="8"><b>- <a href="#A">A</a> -</b></th></tr> <tr> @@ -83,19 +83,20 @@ </div> <!-- *********************************************************************** --> -<div class="doc_section">Definitions</div> +<h2>Definitions</h2> <!-- *********************************************************************** --> +<div> <!-- _______________________________________________________________________ --> -<div class="doc_subsection"><a name="A">- A -</a></div> -<div class="doc_text"> +<h3><a name="A">- A -</a></h3> +<div> <dl> <dt><a name="ADCE"><b>ADCE</b></a></dt> <dd>Aggressive Dead Code Elimination</dd> </dl> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsection"><a name="B">- B -</a></div> -<div class="doc_text"> +<h3><a name="B">- B -</a></h3> +<div> <dl> <dt><a name="BURS"><b>BURS</b></a></dt> <dd>Bottom Up Rewriting System—A method of instruction selection for @@ -104,8 +105,8 @@ href="http://www.program-transformation.org/Transform/BURG">BURG</a> tool.</dd> </dl> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsection"><a name="C">- C -</a></div> -<div class="doc_text"> +<h3><a name="C">- C -</a></h3> +<div> <dl> <dt><a name="CSE"><b>CSE</b></a></dt> <dd>Common Subexpression Elimination. An optimization that removes common @@ -116,8 +117,8 @@ href="http://www.program-transformation.org/Transform/BURG">BURG</a> tool.</dd> </dl> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsection"><a name="D">- D -</a></div> -<div class="doc_text"> +<h3><a name="D">- D -</a></h3> +<div> <dl> <dt><a name="DAG"><b>DAG</b></a></dt> <dd>Directed Acyclic Graph</dd> @@ -136,8 +137,8 @@ href="http://www.program-transformation.org/Transform/BURG">BURG</a> tool.</dd> </dl> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsection"><a name="G">- G -</a></div> -<div class="doc_text"> +<h3><a name="G">- G -</a></h3> +<div> <dl> <dt><a name="GC"><b>GC</b></a></dt> <dd>Garbage Collection. The practice of using reachability analysis instead @@ -145,8 +146,8 @@ href="http://www.program-transformation.org/Transform/BURG">BURG</a> tool.</dd> </dl> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsection"><a name="H">- H -</a></div> -<div class="doc_text"> +<h3><a name="H">- H -</a></h3> +<div> <dl> <dt><a name="Heap"><b>Heap</b></a></dt> <dd>In garbage collection, the region of memory which is managed using @@ -154,8 +155,8 @@ href="http://www.program-transformation.org/Transform/BURG">BURG</a> tool.</dd> </dl> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsection"><a name="I">- I -</a></div> -<div class="doc_text"> +<h3><a name="I">- I -</a></h3> +<div> <dl> <dt><a name="IPA"><b>IPA</b></a></dt> <dd>Inter-Procedural Analysis. Refers to any variety of code analysis that @@ -169,8 +170,8 @@ href="http://www.program-transformation.org/Transform/BURG">BURG</a> tool.</dd> </dl> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsection"><a name="L">- L -</a></div> -<div class="doc_text"> +<h3><a name="L">- L -</a></h3> +<div> <dl> <dt><a name="LCSSA"><b>LCSSA</b></a></dt> <dd>Loop-Closed Static Single Assignment Form</dd> @@ -183,16 +184,16 @@ href="http://www.program-transformation.org/Transform/BURG">BURG</a> tool.</dd> </dl> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsection"><a name="M">- M -</a></div> -<div class="doc_text"> +<h3><a name="M">- M -</a></h3> +<div> <dl> <dt><a name="MC"><b>MC</b></a></dt> <dd>Machine Code</dd> </dl> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsection"><a name="O">- O -</a></div> -<div class="doc_text"> +<h3><a name="O">- O -</a></h3> +<div> <dl> <dt><a name="Object_Pointer"><b>Object Pointer</b></a></dt> <dd>A pointer to an object such that the garbage collector is able to trace @@ -202,8 +203,8 @@ href="http://www.program-transformation.org/Transform/BURG">BURG</a> tool.</dd> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsection"><a name="P">- P -</a></div> -<div class="doc_text"> +<h3><a name="P">- P -</a></h3> +<div> <dl> <dt><a name="PRE"><b>PRE</b></a></dt> <dd>Partial Redundancy Elimination</dd> @@ -211,8 +212,8 @@ href="http://www.program-transformation.org/Transform/BURG">BURG</a> tool.</dd> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsection"><a name="R">- R -</a></div> -<div class="doc_text"> +<h3><a name="R">- R -</a></h3> +<div> <dl> <dt><a name="RAUW"><b>RAUW</b></a></dt> <dd>An abbreviation for Replace All Uses With. The functions User::replaceUsesOfWith(), @@ -234,8 +235,8 @@ href="http://www.program-transformation.org/Transform/BURG">BURG</a> tool.</dd> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsection"><a name="S">- S -</a></div> -<div class="doc_text"> +<h3><a name="S">- S -</a></h3> +<div> <dl> <dt><a name="Safe_Point"><b>Safe Point</b></a></dt> <dd>In garbage collection, it is necessary to identify <a href="#Root">stack @@ -261,6 +262,8 @@ href="http://www.program-transformation.org/Transform/BURG">BURG</a> tool.</dd> function.</dd> </dl> </div> + +</div> <!-- *********************************************************************** --> <hr> <address> <a href="http://jigsaw.w3.org/css-validator/check/referer"><img @@ -268,8 +271,8 @@ href="http://www.program-transformation.org/Transform/BURG">BURG</a> tool.</dd> 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/">The LLVM Team</a><br> -<a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br> -Last modified: $Date: 2010-05-07 02:28:04 +0200 (Fri, 07 May 2010) $ +<a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br> +Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> <!-- vim: sw=2 --> diff --git a/docs/LinkTimeOptimization.html b/docs/LinkTimeOptimization.html index 30334744d7f9..289da236270a 100644 --- a/docs/LinkTimeOptimization.html +++ b/docs/LinkTimeOptimization.html @@ -6,9 +6,9 @@ <link rel="stylesheet" href="llvm.css" type="text/css"> </head> -<div class="doc_title"> +<h1> LLVM Link Time Optimization: Design and Implementation -</div> +</h1> <ul> <li><a href="#desc">Description</a></li> @@ -36,12 +36,12 @@ </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="desc">Description</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> LLVM features powerful intermodular optimizations which can be used at link time. Link Time Optimization (LTO) is another name for intermodular optimization @@ -50,12 +50,12 @@ and design between the LTO optimizer and the linker.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="design">Design Philosophy</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> The LLVM Link Time Optimizer provides complete transparency, while doing intermodular optimization, in the compiler tool chain. Its main goal is to let @@ -69,14 +69,13 @@ the linker and LLVM optimizer helps to do optimizations that are not possible in other models. The linker input allows the optimizer to avoid relying on conservative escape analysis. </p> -</div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="example1">Example of link time optimization</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The following example illustrates the advantages of LTO's integrated approach and clean interface. This example requires a system linker which supports LTO through the interface described in this document. Here, @@ -145,11 +144,11 @@ $ llvm-gcc a.o main.o -o main # <-- standard link command without any modific </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="alternative_approaches">Alternative Approaches</a> -</div> +</h3> -<div class="doc_text"> +<div> <dl> <dt><b>Compiler driver invokes link time optimizer separately.</b></dt> <dd>In this model the link time optimizer is not able to take advantage of @@ -175,12 +174,14 @@ $ llvm-gcc a.o main.o -o main # <-- standard link command without any modific </dl> </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="multiphase">Multi-phase communication between libLTO and linker</a> -</div> +</h2> -<div class="doc_text"> +<div> <p>The linker collects information about symbol defininitions and uses in various link objects which is more accurate than any information collected by other tools during typical build cycles. The linker collects this @@ -192,14 +193,13 @@ $ llvm-gcc a.o main.o -o main # <-- standard link command without any modific Our goal is to take advantage of tight integration between the linker and the optimizer by sharing this information during various linking phases. </p> -</div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="phase1">Phase 1 : Read LLVM Bitcode Files</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The linker first reads all object files in natural order and collects symbol information. This includes native object files as well as LLVM bitcode files. To minimize the cost to the linker in the case that all .o files @@ -219,11 +219,11 @@ $ llvm-gcc a.o main.o -o main # <-- standard link command without any modific </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="phase2">Phase 2 : Symbol Resolution</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>In this stage, the linker resolves symbols using global symbol table. It may report undefined symbol errors, read archive members, replace weak symbols, etc. The linker is able to do this seamlessly even though it @@ -233,10 +233,10 @@ $ llvm-gcc a.o main.o -o main # <-- standard link command without any modific </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="phase3">Phase 3 : Optimize Bitcode Files</a> -</div> -<div class="doc_text"> +</h3> +<div> <p>After symbol resolution, the linker tells the LTO shared object which symbols are needed by native object files. In the example above, the linker reports that only <tt>foo1()</tt> is used by native object files using @@ -248,11 +248,11 @@ $ llvm-gcc a.o main.o -o main # <-- standard link command without any modific </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="phase4">Phase 4 : Symbol Resolution after optimization</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>In this phase, the linker reads optimized a native object file and updates the internal global symbol table to reflect any changes. The linker also collects information about any changes in use of external symbols by @@ -264,12 +264,14 @@ $ llvm-gcc a.o main.o -o main # <-- standard link command without any modific bitcode files.</p> </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="lto">libLTO</a> -</div> +</h2> -<div class="doc_text"> +<div> <p><tt>libLTO</tt> is a shared object that is part of the LLVM tools, and is intended for use by a linker. <tt>libLTO</tt> provides an abstract C interface to use the LLVM interprocedural optimizer without exposing details @@ -278,14 +280,13 @@ $ llvm-gcc a.o main.o -o main # <-- standard link command without any modific be possible for a completely different compilation technology to provide a different libLTO that works with their object files and the standard linker tool.</p> -</div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="lto_module_t">lto_module_t</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>A non-native object file is handled via an <tt>lto_module_t</tt>. The following functions allow the linker to check if a file (on disk @@ -325,11 +326,11 @@ lto_module_get_symbol_attribute(lto_module_t, unsigned int) </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="lto_code_gen_t">lto_code_gen_t</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Once the linker has loaded each non-native object files into an <tt>lto_module_t</tt>, it can request libLTO to process them all and @@ -371,6 +372,8 @@ of the native object files.</p> </div> +</div> + <!-- *********************************************************************** --> <hr> @@ -381,8 +384,8 @@ of the native object files.</p> src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a> Devang Patel and Nick Kledzik<br> - <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br> - Last modified: $Date: 2010-09-29 22:09:55 +0200 (Wed, 29 Sep 2010) $ + <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br> + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> diff --git a/docs/MakefileGuide.html b/docs/MakefileGuide.html index 6ceb09db3274..1e7c346952f0 100644 --- a/docs/MakefileGuide.html +++ b/docs/MakefileGuide.html @@ -7,7 +7,7 @@ </head> <body> -<div class="doc_title">LLVM Makefile Guide</div> +<h1>LLVM Makefile Guide</h1> <ol> <li><a href="#introduction">Introduction</a></li> @@ -77,10 +77,10 @@ </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="introduction">Introduction </a></div> +<h2><a name="introduction">Introduction</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>This document provides <em>usage</em> information about the LLVM makefile system. While loosely patterned after the BSD makefile system, LLVM has taken a departure from BSD in order to implement additional features needed by LLVM. @@ -99,20 +99,19 @@ </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="general">General Concepts</a></div> +<h2><a name="general">General Concepts</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>The LLVM Makefile System is the component of LLVM that is responsible for building the software, testing it, generating distributions, checking those distributions, installing and uninstalling, etc. It consists of a several files throughout the source tree. These files and other general concepts are described in this section.</p> -</div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="projects">Projects</a></div> -<div class="doc_text"> +<h3><a name="projects">Projects</a></h3> +<div> <p>The LLVM Makefile System is quite generous. It not only builds its own software, but it can build yours too. Built into the system is knowledge of the <tt>llvm/projects</tt> directory. Any directory under <tt>projects</tt> @@ -129,8 +128,8 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="varvalues">Variable Values</a></div> -<div class="doc_text"> +<h3><a name="varvalues">Variable Values</a></h3> +<div> <p>To use the makefile system, you simply create a file named <tt>Makefile</tt> in your directory and declare values for certain variables. The variables and values that you select determine what the makefile system @@ -139,16 +138,15 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="including">Including Makefiles</a></div> -<div class="doc_text"> +<h3><a name="including">Including Makefiles</a></h3> +<div> <p>Setting variables alone is not enough. You must include into your Makefile additional files that provide the rules of the LLVM Makefile system. The various files involved are described in the sections that follow.</p> -</div> <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="Makefile">Makefile</a></div> -<div class="doc_text"> +<h4><a name="Makefile">Makefile</a></h4> +<div> <p>Each directory to participate in the build needs to have a file named <tt>Makefile</tt>. This is the file first read by <tt>make</tt>. It has three sections:</p> @@ -163,9 +161,8 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="Makefile.common">Makefile.common</a> -</div> -<div class="doc_text"> +<h4><a name="Makefile.common">Makefile.common</a></h4> +<div> <p>Every project must have a <tt>Makefile.common</tt> file at its top source directory. This file serves three purposes:</p> <ol> @@ -182,9 +179,8 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="Makefile.config">Makefile.config</a> -</div> -<div class="doc_text"> +<h4><a name="Makefile.config">Makefile.config</a></h4> +<div> <p>Every project must have a <tt>Makefile.config</tt> at the top of its <em>build</em> directory. This file is <b>generated</b> by the <tt>configure</tt> script from the pattern provided by the @@ -196,8 +192,8 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="Makefile.rules">Makefile.rules</a></div> -<div class="doc_text"> +<h4><a name="Makefile.rules">Makefile.rules</a></h4> +<div> <p>This file, located at <tt>$(LLVM_SRC_ROOT)/Makefile.rules</tt> is the heart of the LLVM Makefile System. It provides all the logic, dependencies, and rules for building the targets supported by the system. What it does largely @@ -205,9 +201,11 @@ have been set <em>before</em> <tt>Makefile.rules</tt> is included. </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"><a name="Comments">Comments</a></div> -<div class="doc_text"> +<h3><a name="Comments">Comments</a></h3> +<div> <p>User Makefiles need not have comments in them unless the construction is unusual or it does not strictly follow the rules and patterns of the LLVM makefile system. Makefile comments are invoked with the pound (#) character. @@ -215,19 +213,20 @@ by <tt>make</tt>.</p> </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"><a name="tutorial">Tutorial</a></div> +<h2><a name="tutorial">Tutorial</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>This section provides some examples of the different kinds of modules you can build with the LLVM makefile system. In general, each directory you provide will build a single object although that object may be composed of additionally compiled components.</p> -</div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="libraries">Libraries</a></div> -<div class="doc_text"> +<h3><a name="libraries">Libraries</a></h3> +<div> <p>Only a few variable definitions are needed to build a regular library. Normally, the makefile system will build all the software into a single <tt>libname.o</tt> (pre-linked) object. This means the library is not @@ -256,11 +255,10 @@ <tt>-load</tt> option. See the <a href="WritingAnLLVMPass.html#makefile">WritingAnLLVMPass.html</a> document for an example of why you might want to do this. -</div> <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="BCModules">Bitcode Modules</a></div> -<div class="doc_text"> +<h4><a name="BCModules">Bitcode Modules</a></h4> +<div> <p>In some situations, it is desirable to build a single bitcode module from a variety of sources, instead of an archive, shared library, or bitcode library. Bitcode modules can be specified in addition to any of the other @@ -280,10 +278,10 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"> +<h4> <a name="LoadableModules">Loadable Modules</a> -</div> -<div class="doc_text"> +</h4> +<div> <p>In some situations, you need to create a loadable module. Loadable modules can be loaded into programs like <tt>opt</tt> or <tt>llc</tt> to specify additional passes to run or targets to support. Loadable modules are also @@ -311,9 +309,11 @@ library which is part of <tt>lib/System</tt> implementation.</p> </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"><a name="tools">Tools</a></div> -<div class="doc_text"> +<h3><a name="tools">Tools</a></h3> +<div> <p>For building executable programs (tools), you must provide the name of the tool and the names of the libraries you wish to link with the tool. For example:</p> @@ -344,11 +344,10 @@ syntax is used. Note that in order to use the <tt>.a</tt> suffix, the library in question must have been built with the <tt>ARCHIVE_LIBRARY</tt> option set. </p> -</div> <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="JIT">JIT Tools</a></div> -<div class="doc_text"> +<h4><a name="JIT">JIT Tools</a></h4> +<div> <p>Many tools will want to use the JIT features of LLVM. To do this, you simply specify that you want an execution 'engine', and the makefiles will automatically link in the appropriate JIT for the host or an interpreter @@ -367,11 +366,15 @@ </tt></pre> </div> +</div> + +</div> + <!-- *********************************************************************** --> -<div class="doc_section"><a name="targets">Targets Supported</a></div> +<h2><a name="targets">Targets Supported</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>This section describes each of the targets that can be built using the LLVM Makefile system. Any target can be invoked from any directory but not all are applicable to a given directory (e.g. "check", "dist" and "install" will @@ -426,11 +429,10 @@ <td>Remove built objects from installation directory. </td></tr> </table> -</div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="all">all (default)</a></div> -<div class="doc_text"> +<h3><a name="all">all (default)</a></h3> +<div> <p>When you invoke <tt>make</tt> with no arguments, you are implicitly instructing it to seek the "all" target (goal). This target is used for building the software recursively and will do different things in different @@ -440,15 +442,15 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="all-local">all-local</a></div> -<div class="doc_text"> +<h3><a name="all-local">all-local</a></h3> +<div> <p>This target is the same as <a href="#all">all</a> but it operates only on the current directory instead of recursively.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="check">check</a></div> -<div class="doc_text"> +<h3><a name="check">check</a></h3> +<div> <p>This target can be invoked from anywhere within a project's directories but always invokes the <a href="#check-local"><tt>check-local</tt></a> target in the project's <tt>test</tt> directory, if it exists and has a @@ -464,8 +466,8 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="check-local">check-local</a></div> -<div class="doc_text"> +<h3><a name="check-local">check-local</a></h3> +<div> <p>This target should be implemented by the <tt>Makefile</tt> in the project's <tt>test</tt> directory. It is invoked by the <tt>check</tt> target elsewhere. Each project is free to define the actions of <tt>check-local</tt> as @@ -475,8 +477,8 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="clean">clean</a></div> -<div class="doc_text"> +<h3><a name="clean">clean</a></h3> +<div> <p>This target cleans the build directory, recursively removing all things that the Makefile builds. The cleaning rules have been made guarded so they shouldn't go awry (via <tt>rm -f $(UNSET_VARIABLE)/*</tt> which will attempt @@ -484,15 +486,15 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="clean-local">clean-local</a></div> -<div class="doc_text"> +<h3><a name="clean-local">clean-local</a></h3> +<div> <p>This target does the same thing as <tt>clean</tt> but only for the current (local) directory.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="dist">dist</a></div> -<div class="doc_text"> +<h3><a name="dist">dist</a></h3> +<div> <p>This target builds a distribution tarball. It first builds the entire project using the <tt>all</tt> target and then tars up the necessary files and compresses it. The generated tarball is sufficient for a casual source @@ -500,8 +502,8 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="dist-check">dist-check</a></div> -<div class="doc_text"> +<h3><a name="dist-check">dist-check</a></h3> +<div> <p>This target does the same thing as the <tt>dist</tt> target but also checks the distribution tarball. The check is made by unpacking the tarball to a new directory, configuring it, building it, installing it, and then verifying that @@ -512,16 +514,16 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="dist-clean">dist-clean</a></div> -<div class="doc_text"> +<h3><a name="dist-clean">dist-clean</a></h3> +<div> <p>This is a special form of the <tt>clean</tt> clean target. It performs a normal <tt>clean</tt> but also removes things pertaining to building the distribution.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="install">install</a></div> -<div class="doc_text"> +<h3><a name="install">install</a></h3> +<div> <p>This target finalizes shared objects and executables and copies all libraries, headers, executables and documentation to the directory given with the <tt>--prefix</tt> option to <tt>configure</tt>. When completed, @@ -538,8 +540,8 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="preconditions">preconditions</a></div> -<div class="doc_text"> +<h3><a name="preconditions">preconditions</a></h3> +<div> <p>This utility target checks to see if the <tt>Makefile</tt> in the object directory is older than the <tt>Makefile</tt> in the source directory and copies it if so. It also reruns the <tt>configure</tt> script if that needs to @@ -549,15 +551,15 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="printvars">printvars</a></div> -<div class="doc_text"> +<h3><a name="printvars">printvars</a></h3> +<div> <p>This utility target just causes the LLVM makefiles to print out some of the makefile variables so that you can double check how things are set. </p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="reconfigure">reconfigure</a></div> -<div class="doc_text"> +<h3><a name="reconfigure">reconfigure</a></h3> +<div> <p>This utility target will force a reconfigure of LLVM or your project. It simply runs <tt>$(PROJ_OBJ_ROOT)/config.status --recheck</tt> to rerun the configuration tests and rebuild the configured files. This isn't generally @@ -566,8 +568,8 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="spotless">spotless</a></div> -<div class="doc_text"> +<h3><a name="spotless">spotless</a></h3> +<div> <p>This utility target, only available when <tt>$(PROJ_OBJ_ROOT)</tt> is not the same as <tt>$(PROJ_SRC_ROOT)</tt>, will completely clean the <tt>$(PROJ_OBJ_ROOT)</tt> directory by removing its content entirely and @@ -578,8 +580,8 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="tags">tags</a></div> -<div class="doc_text"> +<h3><a name="tags">tags</a></h3> +<div> <p>This target will generate a <tt>TAGS</tt> file in the top-level source directory. It is meant for use with emacs, XEmacs, or ViM. The TAGS file provides an index of symbol definitions so that the editor can jump you to the @@ -587,18 +589,20 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="uninstall">uninstall</a></div> -<div class="doc_text"> +<h3><a name="uninstall">uninstall</a></h3> +<div> <p>This target is the opposite of the <tt>install</tt> target. It removes the header, library and executable files from the installation directories. Note that the directories themselves are not removed because it is not guaranteed that LLVM is the only thing installing there (e.g. --prefix=/usr).</p> </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"><a name="variables">Variables</a></div> +<h2><a name="variables">Variables</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Variables are used to tell the LLVM Makefile System what to do and to obtain information from it. Variables are also used internally by the LLVM Makefile System. Variable names that contain only the upper case alphabetic @@ -606,11 +610,10 @@ variables are internal to the LLVM Makefile System and should not be relied upon nor modified. The sections below describe how to use the LLVM Makefile variables.</p> -</div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="setvars">Control Variables</a></div> -<div class="doc_text"> +<h3><a name="setvars">Control Variables</a></h3> +<div> <p>Variables listed in the table below should be set <em>before</em> the inclusion of <a href="#Makefile.common"><tt>$(LEVEL)/Makefile.common</tt></a>. These variables provide input to the LLVM make system that tell it what to do @@ -762,8 +765,8 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="overvars">Override Variables</a></div> -<div class="doc_text"> +<h3><a name="overvars">Override Variables</a></h3> +<div> <p>Override variables can be used to override the default values provided by the LLVM makefile system. These variables can be set in several ways:</p> @@ -868,8 +871,8 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="getvars">Readable Variables</a></div> -<div class="doc_text"> +<h3><a name="getvars">Readable Variables</a></h3> +<div> <p>Variables listed in the table below can be used by the user's Makefile but should not be changed. Changing the value will generally cause the build to go wrong, so don't do it.</p> @@ -939,8 +942,8 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="intvars">Internal Variables</a></div> -<div class="doc_text"> +<h3><a name="intvars">Internal Variables</a></h3> +<div> <p>Variables listed below are used by the LLVM Makefile System and considered internal. You should not use these variables under any circumstances.</p> @@ -1018,6 +1021,8 @@ </tt></p> </div> +</div> + <!-- *********************************************************************** --> <hr> <address> @@ -1027,8 +1032,8 @@ src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a> <a href="mailto:rspencer@x10sys.com">Reid Spencer</a><br> - <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br> - Last modified: $Date: 2010-10-22 14:54:34 +0200 (Fri, 22 Oct 2010) $ + <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br> + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> </html> diff --git a/docs/Packaging.html b/docs/Packaging.html index 7aa4a1c2e16b..b9329726991f 100644 --- a/docs/Packaging.html +++ b/docs/Packaging.html @@ -7,7 +7,7 @@ </head> <body> -<div class="doc_title">Advice on Packaging LLVM</div> +<h1>Advice on Packaging LLVM</h1> <ol> <li><a href="#overview">Overview</a></li> <li><a href="#compilation">Compile Flags</a></li> @@ -17,9 +17,9 @@ </ol> <!--=========================================================================--> -<div class="doc_section"><a name="overview">Overview</a></div> +<h2><a name="overview">Overview</a></h2> <!--=========================================================================--> -<div class="doc_text"> +<div> <p>LLVM sets certain default configure options to make sure our developers don't break things for constrained platforms. These settings are not optimal for most @@ -34,9 +34,9 @@ developed against each. </div> <!--=========================================================================--> -<div class="doc_section"><a name="compilation">Compile Flags</a></div> +<h2><a name="compilation">Compile Flags</a></h2> <!--=========================================================================--> -<div class="doc_text"> +<div> <p>LLVM runs much more quickly when it's optimized and assertions are removed. However, such a build is currently incompatible with users who build without @@ -65,9 +65,9 @@ versions of LLVM in parallel. The following configure flags are relevant: </div> <!--=========================================================================--> -<div class="doc_section"><a name="cxx-features">C++ Features</a></div> +<h2><a name="cxx-features">C++ Features</a></h2> <!--=========================================================================--> -<div class="doc_text"> +<div> <dl> <dt>RTTI</dt><dd>LLVM disables RTTI by default. Add <tt>REQUIRES_RTTI=1</tt> @@ -78,9 +78,9 @@ versions of LLVM in parallel. The following configure flags are relevant: </div> <!--=========================================================================--> -<div class="doc_section"><a name="shared-library">Shared Library</a></div> +<h2><a name="shared-library">Shared Library</a></h2> <!--=========================================================================--> -<div class="doc_text"> +<div> <p>Configure with <tt>--enable-shared</tt> to build <tt>libLLVM-<var>major</var>.<var>minor</var>.(so|dylib)</tt> and link the tools @@ -89,9 +89,9 @@ against it. This saves lots of binary size at the cost of some startup time. </div> <!--=========================================================================--> -<div class="doc_section"><a name="deps">Dependencies</a></div> +<h2><a name="deps">Dependencies</a></h2> <!--=========================================================================--> -<div class="doc_text"> +<div> <dl> <dt><tt>--enable-libffi</tt></dt><dd>Depend on <a @@ -111,8 +111,8 @@ line numbers.</dd> 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">The LLVM Compiler Infrastructure</a><br> - Last modified: $Date: 2010-05-07 02:28:04 +0200 (Fri, 07 May 2010) $ + <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br> + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> </html> diff --git a/docs/Passes.html b/docs/Passes.html index fb2aff585bdb..ca9602c6e076 100644 --- a/docs/Passes.html +++ b/docs/Passes.html @@ -40,7 +40,7 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! --> -<div class="doc_title">LLVM's Analysis and Transform Passes</div> +<h1>LLVM's Analysis and Transform Passes</h1> <ol> <li><a href="#intro">Introduction</a></li> @@ -55,8 +55,8 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-- ======================================================================= --> -<div class="doc_section"> <a name="intro">Introduction</a> </div> -<div class="doc_text"> +<h2><a name="intro">Introduction</a></h2> +<div> <p>This document serves as a high level summary of the optimization features that LLVM provides. Optimizations are implemented as Passes that traverse some portion of a program to either collect information or transform the program. @@ -69,15 +69,13 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! bitcode are neither analysis nor transform passes. <p>The table below provides a quick summary of each pass and links to the more complete pass description later in the document.</p> -</div> -<div class="doc_text" > + <table> <tr><th colspan="2"><b>ANALYSIS PASSES</b></th></tr> <tr><th>Option</th><th>Name</th></tr> <tr><td><a href="#aa-eval">-aa-eval</a></td><td>Exhaustive Alias Analysis Precision Evaluator</td></tr> -<tr><td><a href="#basicaa">-basicaa</a></td><td>Basic Alias Analysis (default AA impl)</td></tr> +<tr><td><a href="#basicaa">-basicaa</a></td><td>Basic Alias Analysis (stateless AA impl)</td></tr> <tr><td><a href="#basiccg">-basiccg</a></td><td>Basic CallGraph Construction</td></tr> -<tr><td><a href="#codegenprepare">-codegenprepare</a></td><td>Optimize for code generation</td></tr> <tr><td><a href="#count-aa">-count-aa</a></td><td>Count Alias Analysis Query Responses</td></tr> <tr><td><a href="#debug-aa">-debug-aa</a></td><td>AA use debugger</td></tr> <tr><td><a href="#domfrontier">-domfrontier</a></td><td>Dominance Frontier Construction</td></tr> @@ -85,27 +83,23 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! <tr><td><a href="#dot-callgraph">-dot-callgraph</a></td><td>Print Call Graph to 'dot' file</td></tr> <tr><td><a href="#dot-cfg">-dot-cfg</a></td><td>Print CFG of function to 'dot' file</td></tr> <tr><td><a href="#dot-cfg-only">-dot-cfg-only</a></td><td>Print CFG of function to 'dot' file (with no function bodies)</td></tr> -<tr><td><a href="#dot-dom">-dot-dom</a></td><td>Print dominator tree of function to 'dot' file</td></tr> -<tr><td><a href="#dot-dom-only">-dot-dom-only</a></td><td>Print dominator tree of function to 'dot' file (with no function bodies)</td></tr> -<tr><td><a href="#dot-postdom">-dot-postdom</a></td><td>Print post dominator tree of function to 'dot' file</td></tr> -<tr><td><a href="#dot-postdom-only">-dot-postdom-only</a></td><td>Print post dominator tree of function to 'dot' file (with no function bodies)</td></tr> +<tr><td><a href="#dot-dom">-dot-dom</a></td><td>Print dominance tree of function to 'dot' file</td></tr> +<tr><td><a href="#dot-dom-only">-dot-dom-only</a></td><td>Print dominance tree of function to 'dot' file (with no function bodies)</td></tr> +<tr><td><a href="#dot-postdom">-dot-postdom</a></td><td>Print postdominance tree of function to 'dot' file</td></tr> +<tr><td><a href="#dot-postdom-only">-dot-postdom-only</a></td><td>Print postdominance tree of function to 'dot' file (with no function bodies)</td></tr> <tr><td><a href="#globalsmodref-aa">-globalsmodref-aa</a></td><td>Simple mod/ref analysis for globals</td></tr> <tr><td><a href="#instcount">-instcount</a></td><td>Counts the various types of Instructions</td></tr> -<tr><td><a href="#interprocedural-aa-eval">-interprocedural-aa-eval</a></td><td>Exhaustive Interprocedural Alias Analysis Precision Evaluator</td></tr> -<tr><td><a href="#interprocedural-basic-aa">-interprocedural-basic-aa</a></td><td>Interprocedural Basic Alias Analysis</td></tr> <tr><td><a href="#intervals">-intervals</a></td><td>Interval Partition Construction</td></tr> <tr><td><a href="#iv-users">-iv-users</a></td><td>Induction Variable Users</td></tr> <tr><td><a href="#lazy-value-info">-lazy-value-info</a></td><td>Lazy Value Information Analysis</td></tr> <tr><td><a href="#lda">-lda</a></td><td>Loop Dependence Analysis</td></tr> <tr><td><a href="#libcall-aa">-libcall-aa</a></td><td>LibCall Alias Analysis</td></tr> -<tr><td><a href="#lint">-lint</a></td><td>Check for common errors in LLVM IR</td></tr> -<tr><td><a href="#live-values">-live-values</a></td><td>Value Liveness Analysis</td></tr> +<tr><td><a href="#lint">-lint</a></td><td>Statically lint-checks LLVM IR</td></tr> <tr><td><a href="#loops">-loops</a></td><td>Natural Loop Information</td></tr> <tr><td><a href="#memdep">-memdep</a></td><td>Memory Dependence Analysis</td></tr> -<tr><td><a href="#module-debuginfo">-module-debuginfo</a></td><td>Prints module debug info metadata</td></tr> +<tr><td><a href="#module-debuginfo">-module-debuginfo</a></td><td>Decodes module-level debug info</td></tr> <tr><td><a href="#no-aa">-no-aa</a></td><td>No Alias Analysis (always returns 'may' alias)</td></tr> <tr><td><a href="#no-profile">-no-profile</a></td><td>No Profile Information</td></tr> -<tr><td><a href="#pointertracking">-pointertracking</a></td><td>Track pointer bounds</td></tr> <tr><td><a href="#postdomfrontier">-postdomfrontier</a></td><td>Post-Dominance Frontier Construction</td></tr> <tr><td><a href="#postdomtree">-postdomtree</a></td><td>Post-Dominator Tree Construction</td></tr> <tr><td><a href="#print-alias-sets">-print-alias-sets</a></td><td>Alias Set Printer</td></tr> @@ -120,8 +114,8 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! <tr><td><a href="#print-used-types">-print-used-types</a></td><td>Find Used Types</td></tr> <tr><td><a href="#profile-estimator">-profile-estimator</a></td><td>Estimate profiling information</td></tr> <tr><td><a href="#profile-loader">-profile-loader</a></td><td>Load profile information from llvmprof.out</td></tr> -<tr><td><a href="#regions">-regions</a></td><td>Detect single entry single exit regions in a function</td></tr> <tr><td><a href="#profile-verifier">-profile-verifier</a></td><td>Verify profiling information</td></tr> +<tr><td><a href="#regions">-regions</a></td><td>Detect single entry single exit regions</td></tr> <tr><td><a href="#scalar-evolution">-scalar-evolution</a></td><td>Scalar Evolution Analysis</td></tr> <tr><td><a href="#scev-aa">-scev-aa</a></td><td>ScalarEvolution-based Alias Analysis</td></tr> <tr><td><a href="#targetdata">-targetdata</a></td><td>Target Data Layout</td></tr> @@ -129,13 +123,12 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! <tr><th colspan="2"><b>TRANSFORM PASSES</b></th></tr> <tr><th>Option</th><th>Name</th></tr> -<tr><td><a href="#abcd">-abcd</a></td><td>Remove redundant conditional branches</td></tr> <tr><td><a href="#adce">-adce</a></td><td>Aggressive Dead Code Elimination</td></tr> <tr><td><a href="#always-inline">-always-inline</a></td><td>Inliner for always_inline functions</td></tr> <tr><td><a href="#argpromotion">-argpromotion</a></td><td>Promote 'by reference' arguments to scalars</td></tr> <tr><td><a href="#block-placement">-block-placement</a></td><td>Profile Guided Basic Block Placement</td></tr> <tr><td><a href="#break-crit-edges">-break-crit-edges</a></td><td>Break critical edges in CFG</td></tr> -<tr><td><a href="#codegenprepare">-codegenprepare</a></td><td>Prepare a function for code generation </td></tr> +<tr><td><a href="#codegenprepare">-codegenprepare</a></td><td>Optimize for code generation</td></tr> <tr><td><a href="#constmerge">-constmerge</a></td><td>Merge Duplicate Global Constants</td></tr> <tr><td><a href="#constprop">-constprop</a></td><td>Simple constant propagation</td></tr> <tr><td><a href="#dce">-dce</a></td><td>Dead Code Elimination</td></tr> @@ -155,46 +148,40 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! <tr><td><a href="#internalize">-internalize</a></td><td>Internalize Global Symbols</td></tr> <tr><td><a href="#ipconstprop">-ipconstprop</a></td><td>Interprocedural constant propagation</td></tr> <tr><td><a href="#ipsccp">-ipsccp</a></td><td>Interprocedural Sparse Conditional Constant Propagation</td></tr> -<tr><td><a href="#jump-threading">-jump-threading</a></td><td>Thread control through conditional blocks </td></tr> +<tr><td><a href="#jump-threading">-jump-threading</a></td><td>Jump Threading</td></tr> <tr><td><a href="#lcssa">-lcssa</a></td><td>Loop-Closed SSA Form Pass</td></tr> <tr><td><a href="#licm">-licm</a></td><td>Loop Invariant Code Motion</td></tr> -<tr><td><a href="#loop-deletion">-loop-deletion</a></td><td>Dead Loop Deletion Pass </td></tr> +<tr><td><a href="#loop-deletion">-loop-deletion</a></td><td>Delete dead loops</td></tr> <tr><td><a href="#loop-extract">-loop-extract</a></td><td>Extract loops into new functions</td></tr> <tr><td><a href="#loop-extract-single">-loop-extract-single</a></td><td>Extract at most one loop into a new function</td></tr> -<tr><td><a href="#loop-index-split">-loop-index-split</a></td><td>Index Split Loops</td></tr> <tr><td><a href="#loop-reduce">-loop-reduce</a></td><td>Loop Strength Reduction</td></tr> <tr><td><a href="#loop-rotate">-loop-rotate</a></td><td>Rotate Loops</td></tr> +<tr><td><a href="#loop-simplify">-loop-simplify</a></td><td>Canonicalize natural loops</td></tr> <tr><td><a href="#loop-unroll">-loop-unroll</a></td><td>Unroll loops</td></tr> <tr><td><a href="#loop-unswitch">-loop-unswitch</a></td><td>Unswitch loops</td></tr> -<tr><td><a href="#loop-simplify">-loop-simplify</a></td><td>Canonicalize natural loops</td></tr> -<tr><td><a href="#loweratomic">-loweratomic</a></td><td>Lower atomic intrinsics</td></tr> +<tr><td><a href="#loweratomic">-loweratomic</a></td><td>Lower atomic intrinsics to non-atomic form</td></tr> <tr><td><a href="#lowerinvoke">-lowerinvoke</a></td><td>Lower invoke and unwind, for unwindless code generators</td></tr> <tr><td><a href="#lowersetjmp">-lowersetjmp</a></td><td>Lower Set Jump</td></tr> <tr><td><a href="#lowerswitch">-lowerswitch</a></td><td>Lower SwitchInst's to branches</td></tr> <tr><td><a href="#mem2reg">-mem2reg</a></td><td>Promote Memory to Register</td></tr> -<tr><td><a href="#memcpyopt">-memcpyopt</a></td><td>Optimize use of memcpy and friends</td></tr> +<tr><td><a href="#memcpyopt">-memcpyopt</a></td><td>MemCpy Optimization</td></tr> <tr><td><a href="#mergefunc">-mergefunc</a></td><td>Merge Functions</td></tr> <tr><td><a href="#mergereturn">-mergereturn</a></td><td>Unify function exit nodes</td></tr> <tr><td><a href="#partial-inliner">-partial-inliner</a></td><td>Partial Inliner</td></tr> -<tr><td><a href="#partialspecialization">-partialspecialization</a></td><td>Partial Specialization</td></tr> <tr><td><a href="#prune-eh">-prune-eh</a></td><td>Remove unused exception handling info</td></tr> <tr><td><a href="#reassociate">-reassociate</a></td><td>Reassociate expressions</td></tr> <tr><td><a href="#reg2mem">-reg2mem</a></td><td>Demote all values to stack slots</td></tr> -<tr><td><a href="#scalarrepl">-scalarrepl</a></td><td>Scalar Replacement of Aggregates</td></tr> +<tr><td><a href="#scalarrepl">-scalarrepl</a></td><td>Scalar Replacement of Aggregates (DT)</td></tr> <tr><td><a href="#sccp">-sccp</a></td><td>Sparse Conditional Constant Propagation</td></tr> -<tr><td><a href="#sink">-sink</a></td><td>Code Sinking</td></tr> <tr><td><a href="#simplify-libcalls">-simplify-libcalls</a></td><td>Simplify well-known library calls</td></tr> -<tr><td><a href="#simplify-libcalls-halfpowr">-simplify-libcalls-halfpowr</a></td><td>Simplify half_powr library calls</td></tr> <tr><td><a href="#simplifycfg">-simplifycfg</a></td><td>Simplify the CFG</td></tr> -<tr><td><a href="#split-geps">-split-geps</a></td><td>Split complex GEPs into simple GEPs</td></tr> -<tr><td><a href="#ssi">-ssi</a></td><td>Static Single Information Construction</td></tr> -<tr><td><a href="#ssi-everything">-ssi-everything</a></td><td>Static Single Information Construction (everything, intended for debugging)</td></tr> +<tr><td><a href="#sink">-sink</a></td><td>Code sinking</td></tr> +<tr><td><a href="#sretpromotion">-sretpromotion</a></td><td>Promote sret arguments to multiple ret values</td></tr> <tr><td><a href="#strip">-strip</a></td><td>Strip all symbols from a module</td></tr> <tr><td><a href="#strip-dead-debug-info">-strip-dead-debug-info</a></td><td>Strip debug info for unused symbols</td></tr> -<tr><td><a href="#strip-dead-prototypes">-strip-dead-prototypes</a></td><td>Remove unused function declarations</td></tr> +<tr><td><a href="#strip-dead-prototypes">-strip-dead-prototypes</a></td><td>Strip Unused Function Prototypes</td></tr> <tr><td><a href="#strip-debug-declare">-strip-debug-declare</a></td><td>Strip all llvm.dbg.declare intrinsics</td></tr> <tr><td><a href="#strip-nondebug">-strip-nondebug</a></td><td>Strip all symbols, except dbg symbols, from a module</td></tr> -<tr><td><a href="#sretpromotion">-sretpromotion</a></td><td>Promote sret arguments</td></tr> <tr><td><a href="#tailcallelim">-tailcallelim</a></td><td>Tail Call Elimination</td></tr> <tr><td><a href="#tailduplicate">-tailduplicate</a></td><td>Tail Duplication</td></tr> @@ -208,24 +195,24 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! <tr><td><a href="#verify">-verify</a></td><td>Module Verifier</td></tr> <tr><td><a href="#view-cfg">-view-cfg</a></td><td>View CFG of function</td></tr> <tr><td><a href="#view-cfg-only">-view-cfg-only</a></td><td>View CFG of function (with no function bodies)</td></tr> -<tr><td><a href="#view-dom">-view-dom</a></td><td>View dominator tree of function</td></tr> -<tr><td><a href="#view-dom-only">-view-dom-only</a></td><td>View dominator tree of function (with no function bodies)</td></tr> -<tr><td><a href="#view-postdom">-view-postdom</a></td><td>View post dominator tree of function</td></tr> -<tr><td><a href="#view-postdom-only">-view-postdom-only</a></td><td>View post dominator tree of function (with no function bodies)</td></tr> +<tr><td><a href="#view-dom">-view-dom</a></td><td>View dominance tree of function</td></tr> +<tr><td><a href="#view-dom-only">-view-dom-only</a></td><td>View dominance tree of function (with no function bodies)</td></tr> +<tr><td><a href="#view-postdom">-view-postdom</a></td><td>View postdominance tree of function</td></tr> +<tr><td><a href="#view-postdom-only">-view-postdom-only</a></td><td>View postdominance tree of function (with no function bodies)</td></tr> </table> + </div> <!-- ======================================================================= --> -<div class="doc_section"> <a name="example">Analysis Passes</a></div> -<div class="doc_text"> +<h2><a name="analyses">Analysis Passes</a></h2> +<div> <p>This section describes the LLVM Analysis Passes.</p> -</div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="aa-eval">-aa-eval: Exhaustive Alias Analysis Precision Evaluator</a> -</div> -<div class="doc_text"> +</h3> +<div> <p>This is a simple N^2 alias analysis accuracy evaluator. Basically, for each function in the program, it simply queries to see how the alias analysis implementation answers alias queries between each pair of @@ -236,10 +223,10 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> - <a name="basicaa">-basicaa: Basic Alias Analysis (default AA impl)</a> -</div> -<div class="doc_text"> +<h3> + <a name="basicaa">-basicaa: Basic Alias Analysis (stateless AA impl)</a> +</h3> +<div> <p> This is the default implementation of the Alias Analysis interface that simply implements a few identities (two different globals cannot alias, @@ -248,30 +235,18 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="basiccg">-basiccg: Basic CallGraph Construction</a> -</div> -<div class="doc_text"> +</h3> +<div> <p>Yet to be written.</p> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> - <a name="codegenprepare">-codegenprepare: Optimize for code generation</a> -</div> -<div class="doc_text"> - <p> - This pass munges the code in the input function to better prepare it for - SelectionDAG-based code generation. This works around limitations in it's - basic-block-at-a-time approach. It should eventually be removed. - </p> -</div> - -<!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="count-aa">-count-aa: Count Alias Analysis Query Responses</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> A pass which can be used to count how many alias queries are being made and how the alias analysis implementation being used responds. @@ -279,10 +254,10 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="debug-aa">-debug-aa: AA use debugger</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> This simple pass checks alias analysis users to ensure that if they create a new value, they do not query AA without informing it of the value. @@ -296,10 +271,10 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="domfrontier">-domfrontier: Dominance Frontier Construction</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> This pass is a simple dominator construction algorithm for finding forward dominator frontiers. @@ -307,10 +282,10 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="domtree">-domtree: Dominator Tree Construction</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> This pass is a simple dominator construction algorithm for finding forward dominators. @@ -318,10 +293,10 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="dot-callgraph">-dot-callgraph: Print Call Graph to 'dot' file</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> This pass, only available in <code>opt</code>, prints the call graph into a <code>.dot</code> graph. This graph can then be processed with the "dot" tool @@ -330,10 +305,10 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="dot-cfg">-dot-cfg: Print CFG of function to 'dot' file</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> This pass, only available in <code>opt</code>, prints the control flow graph into a <code>.dot</code> graph. This graph can then be processed with the @@ -342,10 +317,10 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="dot-cfg-only">-dot-cfg-only: Print CFG of function to 'dot' file (with no function bodies)</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> This pass, only available in <code>opt</code>, prints the control flow graph into a <code>.dot</code> graph, omitting the function bodies. This graph can @@ -355,10 +330,10 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> - <a name="dot-dom">-dot-dom: Print dominator tree of function to 'dot' file</a> -</div> -<div class="doc_text"> +<h3> + <a name="dot-dom">-dot-dom: Print dominance tree of function to 'dot' file</a> +</h3> +<div> <p> This pass, only available in <code>opt</code>, prints the dominator tree into a <code>.dot</code> graph. This graph can then be processed with the @@ -367,11 +342,10 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> - <a name="dot-dom-only">-dot-dom-only: Print dominator tree of function to 'dot' file (with no - function bodies)</a> -</div> -<div class="doc_text"> +<h3> + <a name="dot-dom-only">-dot-dom-only: Print dominance tree of function to 'dot' file (with no function bodies)</a> +</h3> +<div> <p> This pass, only available in <code>opt</code>, prints the dominator tree into a <code>.dot</code> graph, omitting the function bodies. This graph can @@ -381,10 +355,10 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> - <a name="dot-postdom">-dot-postdom: Print post dominator tree of function to 'dot' file</a> -</div> -<div class="doc_text"> +<h3> + <a name="dot-postdom">-dot-postdom: Print postdominance tree of function to 'dot' file</a> +</h3> +<div> <p> This pass, only available in <code>opt</code>, prints the post dominator tree into a <code>.dot</code> graph. This graph can then be processed with the @@ -393,11 +367,10 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> - <a name="dot-postdom-only">-dot-postdom-only: Print post dominator tree of function to 'dot' file - (with no function bodies)</a> -</div> -<div class="doc_text"> +<h3> + <a name="dot-postdom-only">-dot-postdom-only: Print postdominance tree of function to 'dot' file (with no function bodies)</a> +</h3> +<div> <p> This pass, only available in <code>opt</code>, prints the post dominator tree into a <code>.dot</code> graph, omitting the function bodies. This graph can @@ -407,10 +380,10 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="globalsmodref-aa">-globalsmodref-aa: Simple mod/ref analysis for globals</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> This simple pass provides alias and mod/ref information for global values that do not have their address taken, and keeps track of whether functions @@ -420,43 +393,20 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="instcount">-instcount: Counts the various types of Instructions</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> This pass collects the count of all instructions and reports them </p> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> - <a name="interprocedural-aa-eval">-interprocedural-aa-eval: Exhaustive Interprocedural Alias Analysis Precision Evaluator</a> -</div> -<div class="doc_text"> - <p>This pass implements a simple N^2 alias analysis accuracy evaluator. - Basically, for each function in the program, it simply queries to see how the - alias analysis implementation answers alias queries between each pair of - pointers in the function. - </p> -</div> - -<!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> - <a name="interprocedural-basic-aa">-interprocedural-basic-aa: Interprocedural Basic Alias Analysis</a> -</div> -<div class="doc_text"> - <p>This pass defines the default implementation of the Alias Analysis interface - that simply implements a few identities (two different globals cannot alias, - etc), but otherwise does no analysis. - </p> -</div> - -<!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="intervals">-intervals: Interval Partition Construction</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> This analysis calculates and represents the interval partition of a function, or a preexisting interval partition. @@ -469,44 +419,44 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="iv-users">-iv-users: Induction Variable Users</a> -</div> -<div class="doc_text"> +</h3> +<div> <p>Bookkeeping for "interesting" users of expressions computed from induction variables.</p> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="lazy-value-info">-lazy-value-info: Lazy Value Information Analysis</a> -</div> -<div class="doc_text"> +</h3> +<div> <p>Interface for lazy computation of value constraint information.</p> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="lda">-lda: Loop Dependence Analysis</a> -</div> -<div class="doc_text"> +</h3> +<div> <p>Loop dependence analysis framework, which is used to detect dependences in memory accesses in loops.</p> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="libcall-aa">-libcall-aa: LibCall Alias Analysis</a> -</div> -<div class="doc_text"> +</h3> +<div> <p>LibCall Alias Analysis.</p> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> - <a name="lint">-lint: Check for common errors in LLVM IR</a> -</div> -<div class="doc_text"> +<h3> + <a name="lint">-lint: Statically lint-checks LLVM IR</a> +</h3> +<div> <p>This pass statically checks for common and easily-identified constructs which produce undefined or likely unintended behavior in LLVM IR.</p> @@ -534,18 +484,10 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> - <a name="live-values">-live-values: Values Liveness Analysis</a> -</div> -<div class="doc_text"> - <p>LLVM IR Value liveness analysis pass.</p> -</div> - -<!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> - <a name="loops">-loops: Natural Loop Construction</a> -</div> -<div class="doc_text"> +<h3> + <a name="loops">-loops: Natural Loop Information</a> +</h3> +<div> <p> This analysis is used to identify natural loops and determine the loop depth of various nodes of the CFG. Note that the loops identified may actually be @@ -555,10 +497,10 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="memdep">-memdep: Memory Dependence Analysis</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> An analysis that determines, for a given memory operation, what preceding memory operations it depends on. It builds on alias analysis information, and @@ -568,10 +510,10 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> - <a name="module-debuginfo">-module-debuginfo: Prints module debug info metadata</a> -</div> -<div class="doc_text"> +<h3> + <a name="module-debuginfo">-module-debuginfo: Decodes module-level debug info</a> +</h3> +<div> <p>This pass decodes the debug info metadata in a module and prints in a (sufficiently-prepared-) human-readable form. @@ -581,10 +523,10 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="no-aa">-no-aa: No Alias Analysis (always returns 'may' alias)</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> Always returns "I don't know" for alias queries. NoAA is unlike other alias analysis implementations, in that it does not chain to a previous analysis. As @@ -593,10 +535,10 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="no-profile">-no-profile: No Profile Information</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> The default "no profile" implementation of the abstract <code>ProfileInfo</code> interface. @@ -604,19 +546,10 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> - <a name="pointertracking">-pointertracking: Track pointer bounds.</a> -</div> -<div class="doc_text"> - <p>Tracking of pointer bounds. - </p> -</div> - -<!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="postdomfrontier">-postdomfrontier: Post-Dominance Frontier Construction</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> This pass is a simple post-dominator construction algorithm for finding post-dominator frontiers. @@ -624,10 +557,10 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="postdomtree">-postdomtree: Post-Dominator Tree Construction</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> This pass is a simple post-dominator construction algorithm for finding post-dominators. @@ -635,18 +568,18 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="print-alias-sets">-print-alias-sets: Alias Set Printer</a> -</div> -<div class="doc_text"> +</h3> +<div> <p>Yet to be written.</p> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="print-callgraph">-print-callgraph: Print a call graph</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> This pass, only available in <code>opt</code>, prints the call graph to standard error in a human-readable form. @@ -654,10 +587,10 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="print-callgraph-sccs">-print-callgraph-sccs: Print SCCs of the Call Graph</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> This pass, only available in <code>opt</code>, prints the SCCs of the call graph to standard error in a human-readable form. @@ -665,10 +598,10 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="print-cfg-sccs">-print-cfg-sccs: Print SCCs of each function CFG</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> This pass, only available in <code>opt</code>, prints the SCCs of each function CFG to standard error in a human-readable form. @@ -676,10 +609,10 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="print-dbginfo">-print-dbginfo: Print debug info in human readable form</a> -</div> -<div class="doc_text"> +</h3> +<div> <p>Pass that prints instructions, and associated debug info:</p> <ul> @@ -690,18 +623,18 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="print-dom-info">-print-dom-info: Dominator Info Printer</a> -</div> -<div class="doc_text"> +</h3> +<div> <p>Dominator Info Printer.</p> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="print-externalfnconstants">-print-externalfnconstants: Print external fn callsites passed constants</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> This pass, only available in <code>opt</code>, prints out call sites to external functions that are called with constant arguments. This can be @@ -711,10 +644,10 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="print-function">-print-function: Print function to stderr</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> The <code>PrintFunctionPass</code> class is designed to be pipelined with other <code>FunctionPass</code>es, and prints out the functions of the module @@ -723,20 +656,20 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="print-module">-print-module: Print module to stderr</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> This pass simply prints out the entire module when it is executed. </p> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="print-used-types">-print-used-types: Find Used Types</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> This pass is used to seek out all of the types in use by the program. Note that this analysis explicitly does not include types only used by the symbol @@ -744,20 +677,20 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="profile-estimator">-profile-estimator: Estimate profiling information</a> -</div> -<div class="doc_text"> +</h3> +<div> <p>Profiling information that estimates the profiling information in a very crude and unimaginative way. </p> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="profile-loader">-profile-loader: Load profile information from llvmprof.out</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> A concrete implementation of profiling information that loads the information from a profile dump file. @@ -765,16 +698,16 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="profile-verifier">-profile-verifier: Verify profiling information</a> -</div> -<div class="doc_text"> +</h3> +<div> <p>Pass that checks profiling information for plausibility.</p> </div> -<div class="doc_subsection"> - <a name="regions">-regions: Detect single entry single exit regions in a function</a> -</div> -<div class="doc_text"> +<h3> + <a name="regions">-regions: Detect single entry single exit regions</a> +</h3> +<div> <p> The <code>RegionInfo</code> pass detects single entry single exit regions in a function, where a region is defined as any subgraph that is connected to the @@ -784,10 +717,10 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="scalar-evolution">-scalar-evolution: Scalar Evolution Analysis</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> The <code>ScalarEvolution</code> analysis can be used to analyze and catagorize scalar expressions in loops. It specializes in recognizing general @@ -803,10 +736,10 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> - <a name="scev-aa">-scev-aa: </a> -</div> -<div class="doc_text"> +<h3> + <a name="scev-aa">-scev-aa: ScalarEvolution-based Alias Analysis</a> +</h3> +<div> <p>Simple alias analysis implemented in terms of ScalarEvolution queries. This differs from traditional loop dependence analysis in that it tests @@ -819,62 +752,26 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> - <a name="strip-dead-debug-info">-strip-dead-debug-info: Strip debug info for unused symbols</a> -</div> -<div class="doc_text"> - <p> - performs code stripping. this transformation can delete: - </p> - - <ol> - <li>names for virtual registers</li> - <li>symbols for internal globals and functions</li> - <li>debug information</li> - </ol> - - <p> - note that this transformation makes code much less readable, so it should - only be used in situations where the <tt>strip</tt> utility would be used, - such as reducing code size or making it harder to reverse engineer code. - </p> -</div> - -<!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="targetdata">-targetdata: Target Data Layout</a> -</div> -<div class="doc_text"> +</h3> +<div> <p>Provides other passes access to information on how the size and alignment required by the the target ABI for various data types.</p> </div> -<!-- ======================================================================= --> -<div class="doc_section"> <a name="transform">Transform Passes</a></div> -<div class="doc_text"> - <p>This section describes the LLVM Transform Passes.</p> </div> -<!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> - <a name="abcd">-abcd: Remove redundant conditional branches</a> -</div> -<div class="doc_text"> - <p>ABCD removes conditional branch instructions that can be proved redundant. - With the SSI representation, each variable has a constraint. By analyzing these - constraints we can prove that a branch is redundant. When a branch is proved - redundant it means that one direction will always be taken; thus, we can change - this branch into an unconditional jump.</p> - <p>It is advisable to run <a href="#simplifycfg">SimplifyCFG</a> and - <a href="#adce">Aggressive Dead Code Elimination</a> after ABCD - to clean up the code.</p> -</div> +<!-- ======================================================================= --> +<h2><a name="transforms">Transform Passes</a></h2> +<div> + <p>This section describes the LLVM Transform Passes.</p> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="adce">-adce: Aggressive Dead Code Elimination</a> -</div> -<div class="doc_text"> +</h3> +<div> <p>ADCE aggressively tries to eliminate code. This pass is similar to <a href="#dce">DCE</a> but it assumes that values are dead until proven otherwise. This is similar to <a href="#sccp">SCCP</a>, except applied to @@ -882,19 +779,19 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="always-inline">-always-inline: Inliner for always_inline functions</a> -</div> -<div class="doc_text"> +</h3> +<div> <p>A custom inliner that handles only functions that are marked as "always inline".</p> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="argpromotion">-argpromotion: Promote 'by reference' arguments to scalars</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> This pass promotes "by reference" arguments to be "by value" arguments. In practice, this means looking for internal functions that have pointer @@ -922,10 +819,10 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="block-placement">-block-placement: Profile Guided Basic Block Placement</a> -</div> -<div class="doc_text"> +</h3> +<div> <p>This pass is a very simple profile guided basic block placement algorithm. The idea is to put frequently executed blocks together at the start of the function and hopefully increase the number of fall-through conditional @@ -934,10 +831,10 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="break-crit-edges">-break-crit-edges: Break critical edges in CFG</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> Break all of the critical edges in the CFG by inserting a dummy basic block. It may be "required" by passes that cannot deal with critical edges. This @@ -947,20 +844,20 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> - <a name="codegenprepare">-codegenprepare: Prepare a function for code generation</a> -</div> -<div class="doc_text"> +<h3> + <a name="codegenprepare">-codegenprepare: Optimize for code generation</a> +</h3> +<div> This pass munges the code in the input function to better prepare it for SelectionDAG-based code generation. This works around limitations in it's basic-block-at-a-time approach. It should eventually be removed. </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="constmerge">-constmerge: Merge Duplicate Global Constants</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> Merges duplicate global constants together into a single constant that is shared. This is useful because some passes (ie TraceValues) insert a lot of @@ -970,10 +867,10 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="constprop">-constprop: Simple constant propagation</a> -</div> -<div class="doc_text"> +</h3> +<div> <p>This file implements constant propagation and merging. It looks for instructions involving only constant operands and replaces them with a constant value instead of an instruction. For example:</p> @@ -986,10 +883,10 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="dce">-dce: Dead Code Elimination</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> Dead code elimination is similar to <a href="#die">dead instruction elimination</a>, but it rechecks instructions that were used by removed @@ -998,10 +895,10 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="deadargelim">-deadargelim: Dead Argument Elimination</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> This pass deletes dead arguments from internal functions. Dead argument elimination removes arguments which are directly dead, as well as arguments @@ -1016,10 +913,10 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="deadtypeelim">-deadtypeelim: Dead Type Elimination</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> This pass is used to cleanup the output of GCC. It eliminate names for types that are unused in the entire translation unit, using the <a @@ -1028,10 +925,10 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="die">-die: Dead Instruction Elimination</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> Dead instruction elimination performs a single pass over the function, removing instructions that are obviously dead. @@ -1039,10 +936,10 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="dse">-dse: Dead Store Elimination</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> A trivial dead store elimination that only considers basic-block local redundant stores. @@ -1050,10 +947,10 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="functionattrs">-functionattrs: Deduce function attributes</a> -</div> -<div class="doc_text"> +</h3> +<div> <p>A simple interprocedural pass which walks the call-graph, looking for functions which do not access or only read non-local memory, and marking them readnone/readonly. In addition, it marks function arguments (of pointer type) @@ -1065,10 +962,10 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="globaldce">-globaldce: Dead Global Elimination</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> This transform is designed to eliminate unreachable internal globals from the program. It uses an aggressive algorithm, searching out globals that are @@ -1079,10 +976,10 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="globalopt">-globalopt: Global Variable Optimizer</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> This pass transforms simple global variables that never have their address taken. If obviously true, it marks read/write globals as constant, deletes @@ -1091,10 +988,10 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="gvn">-gvn: Global Value Numbering</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> This pass performs global value numbering to eliminate fully and partially redundant instructions. It also performs redundant load elimination. @@ -1102,10 +999,10 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="indvars">-indvars: Canonicalize Induction Variables</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> This transformation analyzes and transforms the induction variables (and computations derived from them) into simpler forms suitable for subsequent @@ -1153,20 +1050,20 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="inline">-inline: Function Integration/Inlining</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> Bottom-up inlining of functions into callees. </p> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="insert-edge-profiling">-insert-edge-profiling: Insert instrumentation for edge profiling</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> This pass instruments the specified program with counters for edge profiling. Edge profiling can give a reasonable approximation of the hot paths through a @@ -1181,10 +1078,10 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="insert-optimal-edge-profiling">-insert-optimal-edge-profiling: Insert optimal instrumentation for edge profiling</a> -</div> -<div class="doc_text"> +</h3> +<div> <p>This pass instruments the specified program with counters for edge profiling. Edge profiling can give a reasonable approximation of the hot paths through a program, and is used for a wide variety of program transformations. @@ -1192,10 +1089,10 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="instcombine">-instcombine: Combine redundant instructions</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> Combine instructions to form fewer, simple instructions. This pass does not modify the CFG This pass is where algebraic @@ -1246,10 +1143,10 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="internalize">-internalize: Internalize Global Symbols</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> This pass loops over all of the functions in the input module, looking for a main function. If a main function is found, all other functions and all @@ -1258,10 +1155,10 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="ipconstprop">-ipconstprop: Interprocedural constant propagation</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> This pass implements an <em>extremely</em> simple interprocedural constant propagation pass. It could certainly be improved in many different ways, @@ -1272,10 +1169,10 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="ipsccp">-ipsccp: Interprocedural Sparse Conditional Constant Propagation</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> An interprocedural variant of <a href="#sccp">Sparse Conditional Constant Propagation</a>. @@ -1283,10 +1180,10 @@ perl -e '$/ = undef; for (split(/\n/, <>)) { s:^ *///? ?::; print " <p>\n" if ! </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> - <a name="jump-threading">-jump-threading: Thread control through conditional blocks</a> -</div> -<div class="doc_text"> +<h3> + <a name="jump-threading">-jump-threading: Jump Threading</a> +</h3> +<div> <p> Jump threading tries to find distinct threads of control flow running through a basic block. This pass looks at blocks that have multiple predecessors and @@ -1312,10 +1209,10 @@ if (X < 3) {</pre> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="lcssa">-lcssa: Loop-Closed SSA Form Pass</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> This pass transforms loops by placing phi nodes at the end of the loops for all values that are live across the loop boundary. For example, it turns @@ -1341,10 +1238,10 @@ if (X < 3) {</pre> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="licm">-licm: Loop Invariant Code Motion</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> This pass performs loop invariant code motion, attempting to remove as much code from the body of a loop as possible. It does this by either hoisting @@ -1376,11 +1273,12 @@ if (X < 3) {</pre> variable.</li> </ul> </div> + <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> - <a name="loop-deletion">-loop-deletion: Dead Loop Deletion Pass</a> -</div> -<div class="doc_text"> +<h3> + <a name="loop-deletion">-loop-deletion: Delete dead loops</a> +</h3> +<div> <p> This file implements the Dead Loop Deletion Pass. This pass is responsible for eliminating loops with non-infinite computable trip counts that have no @@ -1390,10 +1288,10 @@ if (X < 3) {</pre> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="loop-extract">-loop-extract: Extract loops into new functions</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> A pass wrapper around the <code>ExtractLoop()</code> scalar transformation to extract each top-level loop into its own new function. If the loop is the @@ -1403,10 +1301,10 @@ if (X < 3) {</pre> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="loop-extract-single">-loop-extract-single: Extract at most one loop into a new function</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> Similar to <a href="#loop-extract">Extract loops into new functions</a>, this pass extracts one natural loop from the program into a function if it @@ -1415,21 +1313,10 @@ if (X < 3) {</pre> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> - <a name="loop-index-split">-loop-index-split: Index Split Loops</a> -</div> -<div class="doc_text"> - <p> - This pass divides loop's iteration range by spliting loop such that each - individual loop is executed efficiently. - </p> -</div> - -<!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="loop-reduce">-loop-reduce: Loop Strength Reduction</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> This pass performs a strength reduction on array references inside loops that have as one or more of their components the loop induction variable. This is @@ -1440,60 +1327,18 @@ if (X < 3) {</pre> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="loop-rotate">-loop-rotate: Rotate Loops</a> -</div> -<div class="doc_text"> +</h3> +<div> <p>A simple loop rotation transformation.</p> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> - <a name="loop-unroll">-loop-unroll: Unroll loops</a> -</div> -<div class="doc_text"> - <p> - This pass implements a simple loop unroller. It works best when loops have - been canonicalized by the <a href="#indvars"><tt>-indvars</tt></a> pass, - allowing it to determine the trip counts of loops easily. - </p> -</div> - -<!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> - <a name="loop-unswitch">-loop-unswitch: Unswitch loops</a> -</div> -<div class="doc_text"> - <p> - This pass transforms loops that contain branches on loop-invariant conditions - to have multiple loops. For example, it turns the left into the right code: - </p> - - <pre ->for (...) if (lic) - A for (...) - if (lic) A; B; C - B else - C for (...) - A; C</pre> - - <p> - This can increase the size of the code exponentially (doubling it every time - a loop is unswitched) so we only unswitch if the resultant code will be - smaller than a threshold. - </p> - - <p> - This pass expects LICM to be run before it to hoist invariant conditions out - of the loop, to make the unswitching opportunity obvious. - </p> -</div> - -<!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="loop-simplify">-loop-simplify: Canonicalize natural loops</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> This pass performs several transformations to transform natural loops into a simpler form, which makes subsequent analyses and transformations simpler and @@ -1531,26 +1376,52 @@ if (X < 3) {</pre> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> - <a name="lowerallocs">-lowerallocs: Lower allocations from instructions to calls</a> -</div> -<div class="doc_text"> +<h3> + <a name="loop-unroll">-loop-unroll: Unroll loops</a> +</h3> +<div> <p> - Turn <tt>malloc</tt> and <tt>free</tt> instructions into <tt>@malloc</tt> and - <tt>@free</tt> calls. + This pass implements a simple loop unroller. It works best when loops have + been canonicalized by the <a href="#indvars"><tt>-indvars</tt></a> pass, + allowing it to determine the trip counts of loops easily. </p> +</div> +<!-------------------------------------------------------------------------- --> +<h3> + <a name="loop-unswitch">-loop-unswitch: Unswitch loops</a> +</h3> +<div> + <p> + This pass transforms loops that contain branches on loop-invariant conditions + to have multiple loops. For example, it turns the left into the right code: + </p> + + <pre +>for (...) if (lic) + A for (...) + if (lic) A; B; C + B else + C for (...) + A; C</pre> + <p> - This is a target-dependent tranformation because it depends on the size of - data types and alignment constraints. + This can increase the size of the code exponentially (doubling it every time + a loop is unswitched) so we only unswitch if the resultant code will be + smaller than a threshold. + </p> + + <p> + This pass expects LICM to be run before it to hoist invariant conditions out + of the loop, to make the unswitching opportunity obvious. </p> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> - <a name="loweratomic">-loweratomic: Lower atomic intrinsics</a> -</div> -<div class="doc_text"> +<h3> + <a name="loweratomic">-loweratomic: Lower atomic intrinsics to non-atomic form</a> +</h3> +<div> <p> This pass lowers atomic intrinsics to non-atomic form for use in a known non-preemptible environment. @@ -1565,10 +1436,10 @@ if (X < 3) {</pre> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="lowerinvoke">-lowerinvoke: Lower invoke and unwind, for unwindless code generators</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> This transformation is designed for use by code generators which do not yet support stack unwinding. This pass supports two models of exception handling @@ -1606,10 +1477,10 @@ if (X < 3) {</pre> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="lowersetjmp">-lowersetjmp: Lower Set Jump</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> Lowers <tt>setjmp</tt> and <tt>longjmp</tt> to use the LLVM invoke and unwind instructions as necessary. @@ -1635,10 +1506,10 @@ if (X < 3) {</pre> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="lowerswitch">-lowerswitch: Lower SwitchInst's to branches</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> Rewrites <tt>switch</tt> instructions with a sequence of branches, which allows targets to get away with not implementing the switch instruction until @@ -1647,10 +1518,10 @@ if (X < 3) {</pre> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="mem2reg">-mem2reg: Promote Memory to Register</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> This file promotes memory references to be register references. It promotes <tt>alloca</tt> instructions which only have <tt>load</tt>s and @@ -1663,10 +1534,10 @@ if (X < 3) {</pre> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> - <a name="memcpyopt">-memcpyopt: Optimize use of memcpy and friend</a> -</div> -<div class="doc_text"> +<h3> + <a name="memcpyopt">-memcpyopt: MemCpy Optimization</a> +</h3> +<div> <p> This pass performs various transformations related to eliminating memcpy calls, or transforming sets of stores into memset's. @@ -1674,10 +1545,10 @@ if (X < 3) {</pre> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="mergefunc">-mergefunc: Merge Functions</a> -</div> -<div class="doc_text"> +</h3> +<div> <p>This pass looks for equivalent functions that are mergable and folds them. A hash is computed from the function, based on its type and number of @@ -1695,10 +1566,10 @@ if (X < 3) {</pre> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="mergereturn">-mergereturn: Unify function exit nodes</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> Ensure that functions have at most one <tt>ret</tt> instruction in them. Additionally, it keeps track of which node is the new exit node of the CFG. @@ -1706,36 +1577,20 @@ if (X < 3) {</pre> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="partial-inliner">-partial-inliner: Partial Inliner</a> -</div> -<div class="doc_text"> +</h3> +<div> <p>This pass performs partial inlining, typically by inlining an if statement that surrounds the body of the function. </p> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> - <a name="partialspecialization">-partialspecialization: Partial Specialization</a> -</div> -<div class="doc_text"> - <p>This pass finds function arguments that are often a common constant and - specializes a version of the called function for that constant. - - This pass simply does the cloning for functions it specializes. It depends - on <a href="#ipsccp">IPSCCP</a> and <a href="#deadargelim">DAE</a> to clean up the results. - - The initial heuristic favors constant arguments that are used in control - flow. - </p> -</div> - -<!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="prune-eh">-prune-eh: Remove unused exception handling info</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> This file implements a simple interprocedural pass which walks the call-graph, turning <tt>invoke</tt> instructions into <tt>call</tt> instructions if and @@ -1745,10 +1600,10 @@ if (X < 3) {</pre> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="reassociate">-reassociate: Reassociate expressions</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> This pass reassociates commutative expressions in an order that is designed to promote better constant propagation, GCSE, LICM, PRE, etc. @@ -1768,10 +1623,10 @@ if (X < 3) {</pre> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="reg2mem">-reg2mem: Demote all values to stack slots</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> This file demotes all registers to memory references. It is intented to be the inverse of <a href="#mem2reg"><tt>-mem2reg</tt></a>. By converting to @@ -1785,10 +1640,10 @@ if (X < 3) {</pre> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> - <a name="scalarrepl">-scalarrepl: Scalar Replacement of Aggregates</a> -</div> -<div class="doc_text"> +<h3> + <a name="scalarrepl">-scalarrepl: Scalar Replacement of Aggregates (DT)</a> +</h3> +<div> <p> The well-known scalar replacement of aggregates transformation. This transform breaks up <tt>alloca</tt> instructions of aggregate type (structure @@ -1807,10 +1662,10 @@ if (X < 3) {</pre> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="sccp">-sccp: Sparse Conditional Constant Propagation</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> Sparse conditional constant propagation and merging, which can be summarized as: @@ -1830,20 +1685,10 @@ if (X < 3) {</pre> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> - <a name="sink">-sink: Code Sinking</a> -</div> -<div class="doc_text"> - <p>This pass moves instructions into successor blocks, when possible, so that - they aren't executed on paths where their results aren't needed. - </p> -</div> - -<!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="simplify-libcalls">-simplify-libcalls: Simplify well-known library calls</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> Applies a variety of small optimizations for calls to specific well-known function calls (e.g. runtime library functions). For example, a call @@ -1853,20 +1698,10 @@ if (X < 3) {</pre> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> - <a name="simplify-libcalls-halfpowr">-simplify-libcalls-halfpowr: Simplify half_powr library calls</a> -</div> -<div class="doc_text"> - <p>Simple pass that applies an experimental transformation on calls - to specific functions. - </p> -</div> - -<!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="simplifycfg">-simplifycfg: Simplify the CFG</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> Performs dead code elimination and basic block merging. Specifically: </p> @@ -1882,47 +1717,43 @@ if (X < 3) {</pre> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> - <a name="split-geps">-split-geps: Split complex GEPs into simple GEPs</a> -</div> -<div class="doc_text"> - <p>This function breaks GEPs with more than 2 non-zero operands into smaller - GEPs each with no more than 2 non-zero operands. This exposes redundancy - between GEPs with common initial operand sequences. +<h3> + <a name="sink">-sink: Code sinking</a> +</h3> +<div> + <p>This pass moves instructions into successor blocks, when possible, so that + they aren't executed on paths where their results aren't needed. </p> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> - <a name="ssi">-ssi: Static Single Information Construction</a> -</div> -<div class="doc_text"> - <p>This pass converts a list of variables to the Static Single Information - form. - - We are building an on-demand representation, that is, we do not convert - every single variable in the target function to SSI form. Rather, we receive - a list of target variables that must be converted. We also do not - completely convert a target variable to the SSI format. Instead, we only - change the variable in the points where new information can be attached - to its live range, that is, at branch points. +<h3> + <a name="sretpromotion">-sretpromotion: Promote sret arguments to multiple ret values</a> +</h3> +<div> + <p> + This pass finds functions that return a struct (using a pointer to the struct + as the first argument of the function, marked with the '<tt>sret</tt>' attribute) and + replaces them with a new function that simply returns each of the elements of + that struct (using multiple return values). </p> -</div> -<!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> - <a name="ssi-everything">-ssi-everything: Static Single Information Construction (everything, intended for debugging)</a> -</div> -<div class="doc_text"> - <p>A pass that runs <a href="#ssi">SSI</a> on every non-void variable, intended for debugging. + <p> + This pass works under a number of conditions: </p> + + <ul> + <li>The returned struct must not contain other structs</li> + <li>The returned struct must only be used to load values from</li> + <li>The placeholder struct passed in is the result of an <tt>alloca</tt></li> + </ul> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="strip">-strip: Strip all symbols from a module</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> performs code stripping. this transformation can delete: </p> @@ -1941,10 +1772,32 @@ if (X < 3) {</pre> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> - <a name="strip-dead-prototypes">-strip-dead-prototypes: Remove unused function declarations</a> +<h3> + <a name="strip-dead-debug-info">-strip-dead-debug-info: Strip debug info for unused symbols</a> +</h3> +<div> + <p> + performs code stripping. this transformation can delete: + </p> + + <ol> + <li>names for virtual registers</li> + <li>symbols for internal globals and functions</li> + <li>debug information</li> + </ol> + + <p> + note that this transformation makes code much less readable, so it should + only be used in situations where the <tt>strip</tt> utility would be used, + such as reducing code size or making it harder to reverse engineer code. + </p> </div> -<div class="doc_text"> + +<!-------------------------------------------------------------------------- --> +<h3> + <a name="strip-dead-prototypes">-strip-dead-prototypes: Strip Unused Function Prototypes</a> +</h3> +<div> <p> This pass loops over all of the functions in the input module, looking for dead declarations and removes them. Dead declarations are declarations of @@ -1954,10 +1807,10 @@ if (X < 3) {</pre> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="strip-debug-declare">-strip-debug-declare: Strip all llvm.dbg.declare intrinsics</a> -</div> -<div class="doc_text"> +</h3> +<div> <p>This pass implements code stripping. Specifically, it can delete:</p> <ul> <li>names for virtual registers</li> @@ -1972,10 +1825,10 @@ if (X < 3) {</pre> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="strip-nondebug">-strip-nondebug: Strip all symbols, except dbg symbols, from a module</a> -</div> -<div class="doc_text"> +</h3> +<div> <p>This pass implements code stripping. Specifically, it can delete:</p> <ul> <li>names for virtual registers</li> @@ -1990,33 +1843,10 @@ if (X < 3) {</pre> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> - <a name="sretpromotion">-sretpromotion: Promote sret arguments</a> -</div> -<div class="doc_text"> - <p> - This pass finds functions that return a struct (using a pointer to the struct - as the first argument of the function, marked with the '<tt>sret</tt>' attribute) and - replaces them with a new function that simply returns each of the elements of - that struct (using multiple return values). - </p> - - <p> - This pass works under a number of conditions: - </p> - - <ul> - <li>The returned struct must not contain other structs</li> - <li>The returned struct must only be used to load values from</li> - <li>The placeholder struct passed in is the result of an <tt>alloca</tt></li> - </ul> -</div> - -<!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="tailcallelim">-tailcallelim: Tail Call Elimination</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> This file transforms calls of the current function (self recursion) followed by a return instruction with a branch to the entry of the function, creating @@ -2045,10 +1875,10 @@ if (X < 3) {</pre> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="tailduplicate">-tailduplicate: Tail Duplication</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> This pass performs a limited form of tail duplication, intended to simplify CFGs by removing some unconditional branches. This pass is necessary to @@ -2058,17 +1888,18 @@ if (X < 3) {</pre> </p> </div> +</div> + <!-- ======================================================================= --> -<div class="doc_section"> <a name="transform">Utility Passes</a></div> -<div class="doc_text"> +<h2><a name="utilities">Utility Passes</a></h2> +<div> <p>This section describes the LLVM Utility Passes.</p> -</div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="deadarghaX0r">-deadarghaX0r: Dead Argument Hacking (BUGPOINT USE ONLY; DO NOT USE)</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> Same as dead argument elimination, but deletes arguments to functions which are external. This is only for use by <a @@ -2076,20 +1907,20 @@ if (X < 3) {</pre> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="extract-blocks">-extract-blocks: Extract Basic Blocks From Module (for bugpoint use)</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> This pass is used by bugpoint to extract all blocks from the module into their own functions.</p> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="instnamer">-instnamer: Assign names to anonymous instructions</a> -</div> -<div class="doc_text"> +</h3> +<div> <p>This is a little utility pass that gives instructions names, this is mostly useful when diffing the effect of an optimization because deleting an unnamed instruction can change all other instruction numbering, making the @@ -2098,10 +1929,10 @@ if (X < 3) {</pre> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="preverify">-preverify: Preliminary module verification</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> Ensures that the module is in the form required by the <a href="#verifier">Module Verifier</a> pass. @@ -2114,10 +1945,10 @@ if (X < 3) {</pre> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="verify">-verify: Module Verifier</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> Verifies an LLVM IR code. This is useful to run after an optimization which is undergoing testing. Note that <tt>llvm-as</tt> verifies its input before @@ -2165,20 +1996,20 @@ if (X < 3) {</pre> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="view-cfg">-view-cfg: View CFG of function</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> Displays the control flow graph using the GraphViz tool. </p> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> +<h3> <a name="view-cfg-only">-view-cfg-only: View CFG of function (with no function bodies)</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> Displays the control flow graph using the GraphViz tool, but omitting function bodies. @@ -2186,22 +2017,20 @@ if (X < 3) {</pre> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> - <a name="view-dom">-view-dom: View dominator tree of function</a> -</div> -<div class="doc_text"> +<h3> + <a name="view-dom">-view-dom: View dominance tree of function</a> +</h3> +<div> <p> Displays the dominator tree using the GraphViz tool. </p> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> - <a name="view-dom-only">-view-dom-only: View dominator tree of function (with no function - bodies) - </a> -</div> -<div class="doc_text"> +<h3> + <a name="view-dom-only">-view-dom-only: View dominance tree of function (with no function bodies)</a> +</h3> +<div> <p> Displays the dominator tree using the GraphViz tool, but omitting function bodies. @@ -2209,28 +2038,28 @@ if (X < 3) {</pre> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> - <a name="view-postdom">-view-postdom: View post dominator tree of function</a> -</div> -<div class="doc_text"> +<h3> + <a name="view-postdom">-view-postdom: View postdominance tree of function</a> +</h3> +<div> <p> Displays the post dominator tree using the GraphViz tool. </p> </div> <!-------------------------------------------------------------------------- --> -<div class="doc_subsection"> - <a name="view-postdom-only">-view-postdom-only: View post dominator tree of function (with no - function bodies) - </a> -</div> -<div class="doc_text"> +<h3> + <a name="view-postdom-only">-view-postdom-only: View postdominance tree of function (with no function bodies)</a> +</h3> +<div> <p> Displays the post dominator tree using the GraphViz tool, but omitting function bodies. </p> </div> +</div> + <!-- *********************************************************************** --> <hr> @@ -2241,8 +2070,8 @@ if (X < 3) {</pre> src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a> <a href="mailto:rspencer@x10sys.com">Reid Spencer</a><br> - <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br> - Last modified: $Date: 2011-02-13 21:57:25 +0100 (Sun, 13 Feb 2011) $ + <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br> + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> diff --git a/docs/ProgrammersManual.html b/docs/ProgrammersManual.html index 0351dd03b7d0..6af922b4071c 100644 --- a/docs/ProgrammersManual.html +++ b/docs/ProgrammersManual.html @@ -8,9 +8,9 @@ </head> <body> -<div class="doc_title"> +<h1> LLVM Programmer's Manual -</div> +</h1> <ol> <li><a href="#introduction">Introduction</a></li> @@ -56,6 +56,7 @@ option</a></li> <ul> <li><a href="#ds_sequential">Sequential Containers (std::vector, std::list, etc)</a> <ul> + <li><a href="#dss_arrayref">llvm/ADT/ArrayRef.h</a></li> <li><a href="#dss_fixedarrays">Fixed Size Arrays</a></li> <li><a href="#dss_heaparrays">Heap Allocated Arrays</a></li> <li><a href="#dss_smallvector">"llvm/ADT/SmallVector.h"</a></li> @@ -86,6 +87,7 @@ option</a></li> <li><a href="#dss_valuemap">"llvm/ADT/ValueMap.h"</a></li> <li><a href="#dss_intervalmap">"llvm/ADT/IntervalMap.h"</a></li> <li><a href="#dss_map"><map></a></li> + <li><a href="#dss_inteqclasses">"llvm/ADT/IntEqClasses.h"</a></li> <li><a href="#dss_othermap">Other Map-Like Container Options</a></li> </ul></li> <li><a href="#ds_string">String-like containers</a> @@ -208,12 +210,12 @@ with another <tt>Value</tt></a> </li> </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="introduction">Introduction </a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>This document is meant to highlight some of the important classes and interfaces available in the LLVM source-base. This manual is not @@ -240,24 +242,22 @@ href="/doxygen/InstVisitor_8h-source.html">InstVisitor</a></tt> template.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="general">General Information</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>This section contains general information that is useful if you are working in the LLVM source-base, but that isn't specific to any particular API.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="stl">The C++ Standard Template Library</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>LLVM makes heavy use of the C++ Standard Template Library (STL), perhaps much more than you are used to, or have seen before. Because of @@ -303,11 +303,11 @@ to write maintainable code more than where to put your curly braces.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="stl">Other useful references</a> -</div> +</h3> -<div class="doc_text"> +<div> <ol> <li><a href="http://www.fortran-2000.com/ArnaudRecipes/sharedlib.html">Using @@ -316,26 +316,26 @@ static and shared libraries across platforms</a></li> </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="apis">Important and useful LLVM APIs</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Here we highlight some LLVM APIs that are generally useful and good to know about when writing transformations.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="isa">The <tt>isa<></tt>, <tt>cast<></tt> and <tt>dyn_cast<></tt> templates</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The LLVM source-base makes extensive use of a custom form of RTTI. These templates have many similarities to the C++ <tt>dynamic_cast<></tt> @@ -440,12 +440,12 @@ are lots of examples in the LLVM source base.</p> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="string_apis">Passing strings (the <tt>StringRef</tt> and <tt>Twine</tt> classes)</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Although LLVM generally does not do much string manipulation, we do have several important APIs which take strings. Two important examples are the @@ -459,14 +459,12 @@ clients to perform a heap allocation which is usually unnecessary. Instead, many LLVM APIs use a <tt>StringRef</tt> or a <tt>const Twine&</tt> for passing strings efficiently.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="StringRef">The <tt>StringRef</tt> class</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>The <tt>StringRef</tt> data type represents a reference to a constant string (a character array and a length) and supports the common operations available @@ -502,11 +500,11 @@ small and pervasive enough in LLVM that it should always be passed by value.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="Twine">The <tt>Twine</tt> class</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>The <tt>Twine</tt> class is an efficient way for APIs to accept concatenated strings. For example, a common LLVM paradigm is to name one instruction based on @@ -537,13 +535,14 @@ accept concatenated strings.</p> </div> +</div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="DEBUG">The <tt>DEBUG()</tt> macro and <tt>-debug</tt> option</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Often when working on your pass you will put a bunch of debugging printouts and other code into your pass. After you get it working, you want to remove @@ -589,15 +588,13 @@ enable or disable it directly in gdb. Just use "<tt>set DebugFlag=0</tt>" or program hasn't been started yet, you can always just run it with <tt>-debug</tt>.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="DEBUG_TYPE">Fine grained debug info with <tt>DEBUG_TYPE</tt> and the <tt>-debug-only</tt> option</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>Sometimes you may find yourself in a situation where enabling <tt>-debug</tt> just turns on <b>too much</b> information (such as when working on the code @@ -665,13 +662,15 @@ DEBUG_WITH_TYPE("", errs() << "No debug type (2)\n"); </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="Statistic">The <tt>Statistic</tt> class & <tt>-stats</tt> option</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The "<tt><a href="/doxygen/Statistic_8h-source.html">llvm/ADT/Statistic.h</a></tt>" file @@ -766,11 +765,11 @@ maintainable and useful.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="ViewGraph">Viewing graphs while debugging code</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Several of the important data structures in LLVM are graphs: for example CFGs made out of LLVM <a href="#BasicBlock">BasicBlock</a>s, CFGs made out of @@ -814,13 +813,15 @@ attributes, then you can <tt>call DAG.clearGraphAttrs()</tt>. </p> </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="datastructure">Picking the Right Data Structure for a Task</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>LLVM has a plethora of data structures in the <tt>llvm/ADT/</tt> directory, and we commonly use STL data structures. This section describes the trade-offs @@ -876,35 +877,47 @@ elements (but could contain many), for example, it's much better to use . Doing so avoids (relatively) expensive malloc/free calls, which dwarf the cost of adding the elements to the container. </p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="ds_sequential">Sequential Containers (std::vector, std::list, etc)</a> -</div> +</h3> -<div class="doc_text"> +<div> There are a variety of sequential containers available for you, based on your needs. Pick the first in this section that will do what you want. + +<!-- _______________________________________________________________________ --> +<h4> + <a name="dss_arrayref">llvm/ADT/ArrayRef.h</a> +</h4> + +<div> +<p>The llvm::ArrayRef class is the preferred class to use in an interface that + accepts a sequential list of elements in memory and just reads from them. By + taking an ArrayRef, the API can be passed a fixed size array, an std::vector, + an llvm::SmallVector and anything else that is contiguous in memory. +</p> </div> + + <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="dss_fixedarrays">Fixed Size Arrays</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>Fixed size arrays are very simple and very fast. They are good if you know exactly how many elements you have, or you have a (low) upper bound on how many you have.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="dss_heaparrays">Heap Allocated Arrays</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>Heap allocated arrays (new[] + delete[]) are also simple. They are good if the number of elements is variable, if you know how many elements you will need before the array is allocated, and if the array is usually large (if not, @@ -916,11 +929,11 @@ construct those elements actually used).</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="dss_smallvector">"llvm/ADT/SmallVector.h"</a> -</div> +</h4> -<div class="doc_text"> +<div> <p><tt>SmallVector<Type, N></tt> is a simple class that looks and smells just like <tt>vector<Type></tt>: it supports efficient iteration, lays out elements in memory order (so you can @@ -945,11 +958,11 @@ SmallVectors are most useful when on the stack.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="dss_vector"><vector></a> -</div> +</h4> -<div class="doc_text"> +<div> <p> std::vector is well loved and respected. It is useful when SmallVector isn't: when the size of the vector is often large (thus the small optimization will @@ -987,11 +1000,11 @@ the loop.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="dss_deque"><deque></a> -</div> +</h4> -<div class="doc_text"> +<div> <p>std::deque is, in some senses, a generalized version of std::vector. Like std::vector, it provides constant time random access and other similar properties, but it also provides efficient access to the front of the list. It @@ -1003,11 +1016,11 @@ something cheaper.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="dss_list"><list></a> -</div> +</h4> -<div class="doc_text"> +<div> <p>std::list is an extremely inefficient class that is rarely useful. It performs a heap allocation for every element inserted into it, thus having an extremely high constant factor, particularly for small data types. std::list @@ -1021,11 +1034,11 @@ not invalidate iterator or pointers to other elements in the list.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="dss_ilist">llvm/ADT/ilist.h</a> -</div> +</h4> -<div class="doc_text"> +<div> <p><tt>ilist<T></tt> implements an 'intrusive' doubly-linked list. It is intrusive, because it requires the element to store and provide access to the prev/next pointers for the list.</p> @@ -1051,22 +1064,22 @@ Related classes of interest are explained in the following subsections: </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="dss_ilist_traits">ilist_traits</a> -</div> +</h4> -<div class="doc_text"> +<div> <p><tt>ilist_traits<T></tt> is <tt>ilist<T></tt>'s customization mechanism. <tt>iplist<T></tt> (and consequently <tt>ilist<T></tt>) publicly derive from this traits class.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="dss_iplist">iplist</a> -</div> +</h4> -<div class="doc_text"> +<div> <p><tt>iplist<T></tt> is <tt>ilist<T></tt>'s base and as such supports a slightly narrower interface. Notably, inserters from <tt>T&</tt> are absent.</p> @@ -1076,11 +1089,11 @@ used for a wide variety of customizations.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="dss_ilist_node">llvm/ADT/ilist_node.h</a> -</div> +</h4> -<div class="doc_text"> +<div> <p><tt>ilist_node<T></tt> implements a the forward and backward links that are expected by the <tt>ilist<T></tt> (and analogous containers) in the default manner.</p> @@ -1091,11 +1104,11 @@ in the default manner.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="dss_ilist_sentinel">Sentinels</a> -</div> +</h4> -<div class="doc_text"> +<div> <p><tt>ilist</tt>s have another specialty that must be considered. To be a good citizen in the C++ ecosystem, it needs to support the standard container operations, such as <tt>begin</tt> and <tt>end</tt> iterators, etc. Also, the @@ -1129,11 +1142,11 @@ field in the ghostly sentinel which can be legally accessed.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="dss_other">Other Sequential Container options</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>Other STL containers are available, such as std::string.</p> <p>There are also various STL adapter classes such as std::queue, @@ -1142,27 +1155,25 @@ underlying container but don't affect the cost of the container itself.</p> </div> +</div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="ds_set">Set-Like Containers (std::set, SmallSet, SetVector, etc)</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Set-like containers are useful when you need to canonicalize multiple values into a single representation. There are several different choices for how to do this, providing various trade-offs.</p> -</div> - - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="dss_sortedvectorset">A sorted 'vector'</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>If you intend to insert a lot of elements, then do a lot of queries, a great approach is to use a vector (or other sequential container) with @@ -1180,11 +1191,11 @@ efficiently queried with a standard binary or radix search.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="dss_smallset">"llvm/ADT/SmallSet.h"</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>If you have a set-like data structure that is usually small and whose elements are reasonably small, a <tt>SmallSet<Type, N></tt> is a good choice. This set @@ -1203,11 +1214,11 @@ and erasing, but does not support iteration.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="dss_smallptrset">"llvm/ADT/SmallPtrSet.h"</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>SmallPtrSet has all the advantages of <tt>SmallSet</tt> (and a <tt>SmallSet</tt> of pointers is transparently implemented with a <tt>SmallPtrSet</tt>), but also supports iterators. If @@ -1223,11 +1234,11 @@ visited in sorted order.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="dss_denseset">"llvm/ADT/DenseSet.h"</a> -</div> +</h4> -<div class="doc_text"> +<div> <p> DenseSet is a simple quadratically probed hash table. It excels at supporting @@ -1242,11 +1253,11 @@ href="#dss_densemap">DenseMap</a> has. </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="dss_FoldingSet">"llvm/ADT/FoldingSet.h"</a> -</div> +</h4> -<div class="doc_text"> +<div> <p> FoldingSet is an aggregate class that is really good at uniquing @@ -1279,11 +1290,11 @@ elements. </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="dss_set"><set></a> -</div> +</h4> -<div class="doc_text"> +<div> <p><tt>std::set</tt> is a reasonable all-around set class, which is decent at many things but great at nothing. std::set allocates memory for each element @@ -1304,11 +1315,11 @@ std::set is almost never a good choice.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="dss_setvector">"llvm/ADT/SetVector.h"</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>LLVM's SetVector<Type> is an adapter class that combines your choice of a set-like container along with a <a href="#ds_sequential">Sequential Container</a>. The important property @@ -1344,11 +1355,11 @@ heap traffic.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="dss_uniquevector">"llvm/ADT/UniqueVector.h"</a> -</div> +</h4> -<div class="doc_text"> +<div> <p> UniqueVector is similar to <a href="#dss_setvector">SetVector</a>, but it @@ -1364,11 +1375,11 @@ factors, and produces a lot of malloc traffic. It should be avoided.</p> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="dss_otherset">Other Set-Like Container Options</a> -</div> +</h4> -<div class="doc_text"> +<div> <p> The STL provides several other options, such as std::multiset and the various @@ -1384,22 +1395,23 @@ better.</p> </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="ds_map">Map-Like Containers (std::map, DenseMap, etc)</a> -</div> +</h3> -<div class="doc_text"> +<div> Map-like containers are useful when you want to associate data to a key. As usual, there are a lot of different ways to do this. :) -</div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="dss_sortedvectormap">A sorted 'vector'</a> -</div> +</h4> -<div class="doc_text"> +<div> <p> If your usage pattern follows a strict insert-then-query approach, you can @@ -1412,11 +1424,11 @@ vectors for sets. </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="dss_stringmap">"llvm/ADT/StringMap.h"</a> -</div> +</h4> -<div class="doc_text"> +<div> <p> Strings are commonly used as keys in maps, and they are difficult to support @@ -1446,11 +1458,11 @@ copies a string if a value is inserted into the table.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="dss_indexedmap">"llvm/ADT/IndexedMap.h"</a> -</div> +</h4> -<div class="doc_text"> +<div> <p> IndexedMap is a specialized container for mapping small dense integers (or values that can be mapped to small dense integers) to some other type. It is @@ -1466,11 +1478,11 @@ virtual register ID).</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="dss_densemap">"llvm/ADT/DenseMap.h"</a> -</div> +</h4> -<div class="doc_text"> +<div> <p> DenseMap is a simple quadratically probed hash table. It excels at supporting @@ -1492,11 +1504,11 @@ inserted into the map) that it needs internally.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="dss_valuemap">"llvm/ADT/ValueMap.h"</a> -</div> +</h4> -<div class="doc_text"> +<div> <p> ValueMap is a wrapper around a <a href="#dss_densemap">DenseMap</a> mapping @@ -1509,11 +1521,11 @@ a <code>Config</code> parameter to the ValueMap template.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="dss_intervalmap">"llvm/ADT/IntervalMap.h"</a> -</div> +</h4> -<div class="doc_text"> +<div> <p> IntervalMap is a compact map for small keys and values. It maps key intervals instead of single keys, and it will automatically coalesce adjacent @@ -1526,11 +1538,11 @@ as STL iterators. The heavyweight iterators allow a smaller data structure.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="dss_map"><map></a> -</div> +</h4> -<div class="doc_text"> +<div> <p> std::map has similar characteristics to <a href="#dss_set">std::set</a>: it uses @@ -1546,11 +1558,31 @@ another element takes place).</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> - <a name="dss_othermap">Other Map-Like Container Options</a> +<h4> + <a name="dss_inteqclasses">"llvm/ADT/IntEqClasses.h"</a> +</h4> + +<div> + +<p>IntEqClasses provides a compact representation of equivalence classes of +small integers. Initially, each integer in the range 0..n-1 has its own +equivalence class. Classes can be joined by passing two class representatives to +the join(a, b) method. Two integers are in the same class when findLeader() +returns the same representative.</p> + +<p>Once all equivalence classes are formed, the map can be compressed so each +integer 0..n-1 maps to an equivalence class number in the range 0..m-1, where m +is the total number of equivalence classes. The map must be uncompressed before +it can be edited again.</p> + </div> -<div class="doc_text"> +<!-- _______________________________________________________________________ --> +<h4> + <a name="dss_othermap">Other Map-Like Container Options</a> +</h4> + +<div> <p> The STL provides several other options, such as std::multimap and the various @@ -1564,12 +1596,14 @@ always better.</p> </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="ds_string">String-like containers</a> -</div> +</h3> -<div class="doc_text"> +<div> <p> TODO: const char* vs stringref vs smallstring vs std::string. Describe twine, @@ -1579,11 +1613,11 @@ xref to #string_apis. </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="ds_bit">Bit storage containers (BitVector, SparseBitVector)</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Unlike the other containers, there are only two bit storage containers, and choosing when to use each is relatively straightforward.</p> @@ -1593,14 +1627,13 @@ implementation in many common compilers (e.g. commonly available versions of GCC) is extremely inefficient and 2) the C++ standards committee is likely to deprecate this container and/or change it significantly somehow. In any case, please don't use it.</p> -</div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="dss_bitvector">BitVector</a> -</div> +</h4> -<div class="doc_text"> +<div> <p> The BitVector container provides a dynamic size set of bits for manipulation. It supports individual bit setting/testing, as well as set operations. The set operations take time O(size of bitvector), but operations are performed one word @@ -1611,11 +1644,11 @@ the number of set bits to be high (IE a dense set). </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="dss_smallbitvector">SmallBitVector</a> -</div> +</h4> -<div class="doc_text"> +<div> <p> The SmallBitVector container provides the same interface as BitVector, but it is optimized for the case where only a small number of bits, less than 25 or so, are needed. It also transparently supports larger bit counts, but @@ -1630,11 +1663,11 @@ and its operator[] does not provide an assignable lvalue. </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="dss_sparsebitvector">SparseBitVector</a> -</div> +</h4> -<div class="doc_text"> +<div> <p> The SparseBitVector container is much like BitVector, with one major difference: Only the bits that are set, are stored. This makes the SparseBitVector much more space efficient than BitVector when the set is sparse, @@ -1644,13 +1677,17 @@ universe). The downside to the SparseBitVector is that setting and testing of r </p> </div> +</div> + +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="common">Helpful Hints for Common Operations</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>This section describes how to perform some very simple transformations of LLVM code. This is meant to give examples of common idioms used, showing the @@ -1659,15 +1696,13 @@ you should also read about the main classes that you will be working with. The <a href="#coreclasses">Core LLVM Class Hierarchy Reference</a> contains details and descriptions of the main classes that you should know about.</p> -</div> - <!-- NOTE: this section should be heavy on example code --> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="inspection">Basic Inspection and Traversal Routines</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The LLVM compiler infrastructure have many different data structures that may be traversed. Following the example of the C++ standard template library, the @@ -1684,16 +1719,14 @@ on them, and it is easier to remember how to iterate. First we show a few common examples of the data structures that need to be traversed. Other data structures are traversed in very similar ways.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="iterate_function">Iterating over the </a><a href="#BasicBlock"><tt>BasicBlock</tt></a>s in a <a href="#Function"><tt>Function</tt></a> -</div> +</h4> -<div class="doc_text"> +<div> <p>It's quite common to have a <tt>Function</tt> instance that you'd like to transform in some way; in particular, you'd like to manipulate its @@ -1722,13 +1755,13 @@ exactly equivalent to <tt>(*i).size()</tt> just like you'd expect.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="iterate_basicblock">Iterating over the </a><a href="#Instruction"><tt>Instruction</tt></a>s in a <a href="#BasicBlock"><tt>BasicBlock</tt></a> -</div> +</h4> -<div class="doc_text"> +<div> <p>Just like when dealing with <tt>BasicBlock</tt>s in <tt>Function</tt>s, it's easy to iterate over the individual instructions that make up @@ -1753,13 +1786,13 @@ basic block itself: <tt>errs() << *blk << "\n";</tt>.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="iterate_institer">Iterating over the </a><a href="#Instruction"><tt>Instruction</tt></a>s in a <a href="#Function"><tt>Function</tt></a> -</div> +</h4> -<div class="doc_text"> +<div> <p>If you're finding that you commonly iterate over a <tt>Function</tt>'s <tt>BasicBlock</tt>s and then that <tt>BasicBlock</tt>'s <tt>Instruction</tt>s, @@ -1799,12 +1832,12 @@ for (inst_iterator I = inst_begin(F), E = inst_end(F); I != E; ++I) </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="iterate_convert">Turning an iterator into a class pointer (and vice-versa)</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>Sometimes, it'll be useful to grab a reference (or pointer) to a class instance when all you've got at hand is an iterator. Well, extracting @@ -1876,12 +1909,12 @@ and <tt>operator*</tt> changed to return a pointer instead of a reference.</p> </div> <!--_______________________________________________________________________--> -<div class="doc_subsubsection"> +<h4> <a name="iterate_complex">Finding call sites: a slightly more complex example</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>Say that you're writing a FunctionPass and would like to count all the locations in the entire module (that is, across every <tt>Function</tt>) where a @@ -1938,11 +1971,11 @@ class OurFunctionPass : public FunctionPass { </div> <!--_______________________________________________________________________--> -<div class="doc_subsubsection"> +<h4> <a name="calls_and_invokes">Treating calls and invokes the same way</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>You may have noticed that the previous example was a bit oversimplified in that it did not deal with call sites generated by 'invoke' instructions. In @@ -1965,11 +1998,11 @@ If you look at its definition, it has only a single pointer member.</p> </div> <!--_______________________________________________________________________--> -<div class="doc_subsubsection"> +<h4> <a name="iterate_chains">Iterating over def-use & use-def chains</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>Frequently, we might have an instance of the <a href="/doxygen/classllvm_1_1Value.html">Value Class</a> and we want to @@ -2026,12 +2059,12 @@ calling <tt>use/op_begin()</tt> on <tt>const Value*</tt>s or </div> <!--_______________________________________________________________________--> -<div class="doc_subsubsection"> +<h4> <a name="iterate_preds">Iterating over predecessors & successors of blocks</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>Iterating over the predecessors and successors of a block is quite easy with the routines defined in <tt>"llvm/Support/CFG.h"</tt>. Just use code like @@ -2054,13 +2087,14 @@ succ_iterator/succ_begin/succ_end.</p> </div> +</div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="simplechanges">Making simple changes</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>There are some primitive transformation operations present in the LLVM infrastructure that are worth knowing about. When performing @@ -2068,15 +2102,13 @@ transformations, it's fairly common to manipulate the contents of basic blocks. This section describes some of the common methods for doing so and gives example code.</p> -</div> - <!--_______________________________________________________________________--> -<div class="doc_subsubsection"> +<h4> <a name="schanges_creating">Creating and inserting new <tt>Instruction</tt>s</a> -</div> +</h4> -<div class="doc_text"> +<div> <p><i>Instantiating Instructions</i></p> @@ -2212,18 +2244,15 @@ Instruction* newInst = new Instruction(..., pi); </div> <!--_______________________________________________________________________--> -<div class="doc_subsubsection"> +<h4> <a name="schanges_deleting">Deleting <tt>Instruction</tt>s</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>Deleting an instruction from an existing sequence of instructions that form a -<a href="#BasicBlock"><tt>BasicBlock</tt></a> is very straight-forward. First, -you must have a pointer to the instruction that you wish to delete. Second, you -need to obtain the pointer to that instruction's basic block. You use the -pointer to the basic block to get its list of instructions and then use the -erase function to remove your instruction. For example:</p> +<a href="#BasicBlock"><tt>BasicBlock</tt></a> is very straight-forward: just +call the instruction's eraseFromParent() method. For example:</p> <div class="doc_code"> <pre> @@ -2232,15 +2261,19 @@ I->eraseFromParent(); </pre> </div> +<p>This unlinks the instruction from its containing basic block and deletes +it. If you'd just like to unlink the instruction from its containing basic +block but not delete it, you can use the <tt>removeFromParent()</tt> method.</p> + </div> <!--_______________________________________________________________________--> -<div class="doc_subsubsection"> +<h4> <a name="schanges_replacing">Replacing an <tt>Instruction</tt> with another <tt>Value</tt></a> -</div> +</h4> -<div class="doc_text"> +<div> <p><i>Replacing individual instructions</i></p> @@ -2248,7 +2281,7 @@ I->eraseFromParent(); permits use of two very useful replace functions: <tt>ReplaceInstWithValue</tt> and <tt>ReplaceInstWithInst</tt>.</p> -<h4><a name="schanges_deleting">Deleting <tt>Instruction</tt>s</a></h4> +<h5><a name="schanges_deleting">Deleting <tt>Instruction</tt>s</a></h5> <ul> <li><tt>ReplaceInstWithValue</tt> @@ -2301,11 +2334,11 @@ ReplaceInstWithValue, ReplaceInstWithInst --> </div> <!--_______________________________________________________________________--> -<div class="doc_subsubsection"> +<h4> <a name="schanges_deletingGV">Deleting <tt>GlobalVariable</tt>s</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>Deleting a global variable from a module is just as easy as deleting an Instruction. First, you must have a pointer to the global variable that you wish @@ -2322,12 +2355,14 @@ GV->eraseFromParent(); </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="create_types">How to Create Types</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>In generating IR, you may need some complex types. If you know these types statically, you can use <tt>TypeBuilder<...>::get()</tt>, defined @@ -2362,13 +2397,15 @@ comment</a> for more details.</p> </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="threading">Threads and LLVM</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> This section describes the interaction of the LLVM APIs with multithreading, both on the part of client applications, and in the JIT, in the hosted @@ -2391,14 +2428,13 @@ compiler, consider compiling LLVM and LLVM-GCC in single-threaded mode, and using the resultant compiler to build a copy of LLVM with multithreading support. </p> -</div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="startmultithreaded">Entering and Exiting Multithreaded Mode</a> -</div> +</h3> -<div class="doc_text"> +<div> <p> In order to properly protect its internal data structures while avoiding @@ -2431,11 +2467,11 @@ result in concurrent LLVM API calls. </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="shutdown">Ending Execution with <tt>llvm_shutdown()</tt></a> -</div> +</h3> -<div class="doc_text"> +<div> <p> When you are done using the LLVM APIs, you should call <tt>llvm_shutdown()</tt> to deallocate memory used for internal structures. This will also invoke @@ -2451,11 +2487,11 @@ destructor. </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="managedstatic">Lazy Initialization with <tt>ManagedStatic</tt></a> -</div> +</h3> -<div class="doc_text"> +<div> <p> <tt>ManagedStatic</tt> is a utility class in LLVM used to implement static initialization of static resources, such as the global type tables. Before the @@ -2480,11 +2516,11 @@ and only if you know what you're doing! </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="llvmcontext">Achieving Isolation with <tt>LLVMContext</tt></a> -</div> +</h3> -<div class="doc_text"> +<div> <p> <tt>LLVMContext</tt> is an opaque class in the LLVM API which clients can use to operate multiple, isolated instances of LLVM concurrently within the same @@ -2524,11 +2560,11 @@ isolation is not a concern. </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="jitthreading">Threads and the JIT</a> -</div> +</h3> -<div class="doc_text"> +<div> <p> LLVM's "eager" JIT compiler is safe to use in threaded programs. Multiple threads can call <tt>ExecutionEngine::getPointerToFunction()</tt> or @@ -2551,26 +2587,27 @@ access, but we suggest using only the eager JIT in threaded programs. </p> </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="advanced">Advanced Topics</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> This section describes some of the advanced or obscure API's that most clients do not need to be aware of. These API's tend manage the inner workings of the LLVM system, and only need to be accessed in unusual circumstances. </p> -</div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="TypeResolve">LLVM Type Resolution</a> -</div> +</h3> -<div class="doc_text"> +<div> <p> The LLVM type system has a very simple goal: allow clients to compare types for @@ -2599,14 +2636,12 @@ Third, a concrete type is a type that is not an abstract type (e.g. "<tt>{ i32, float }</tt>"). </p> -</div> - <!-- ______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="BuildRecType">Basic Recursive Type Construction</a> -</div> +</h4> -<div class="doc_text"> +<div> <p> Because the most common question is "how do I build a recursive type with LLVM", @@ -2658,11 +2693,11 @@ href="#PATypeHolder">PATypeHolder class</a>. </div> <!-- ______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="refineAbstractTypeTo">The <tt>refineAbstractTypeTo</tt> method</a> -</div> +</h4> -<div class="doc_text"> +<div> <p> The <tt>refineAbstractTypeTo</tt> method starts the type unification process. While this method is actually a member of the DerivedType class, it is most @@ -2688,11 +2723,11 @@ complex datastructures. </div> <!-- ______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="PATypeHolder">The PATypeHolder Class</a> -</div> +</h4> -<div class="doc_text"> +<div> <p> PATypeHolder is a form of a "smart pointer" for Type objects. When VMCore happily goes about nuking types that become isomorphic to existing types, it @@ -2710,11 +2745,11 @@ Type is maintained by PATypeHolder objects. </div> <!-- ______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="AbstractTypeUser">The AbstractTypeUser Class</a> -</div> +</h4> -<div class="doc_text"> +<div> <p> Some data structures need more to perform more complex updates when types get @@ -2728,14 +2763,15 @@ objects) can never be refined. </p> </div> +</div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="SymbolTable">The <tt>ValueSymbolTable</tt> and <tt>TypeSymbolTable</tt> classes</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The <tt><a href="http://llvm.org/doxygen/classllvm_1_1ValueSymbolTable.html"> ValueSymbolTable</a></tt> class provides a symbol table that the <a href="#Function"><tt>Function</tt></a> and <a href="#Module"> @@ -2766,11 +2802,11 @@ insert entries into the symbol table.</p> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="UserLayout">The <tt>User</tt> and owned <tt>Use</tt> classes' memory layout</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The <tt><a href="http://llvm.org/doxygen/classllvm_1_1User.html"> User</a></tt> class provides a basis for expressing the ownership of <tt>User</tt> towards other <tt><a href="http://llvm.org/doxygen/classllvm_1_1Value.html"> @@ -2779,18 +2815,19 @@ Use</a></tt> helper class is employed to do the bookkeeping and to facilitate <i addition and removal.</p> <!-- ______________________________________________________________________ --> -<div class="doc_subsubsection"> - <a name="Use2User">Interaction and relationship between <tt>User</tt> and <tt>Use</tt> objects</a> -</div> +<h4> + <a name="Use2User"> + Interaction and relationship between <tt>User</tt> and <tt>Use</tt> objects + </a> +</h4> -<div class="doc_text"> +<div> <p> A subclass of <tt>User</tt> can choose between incorporating its <tt>Use</tt> objects or refer to them out-of-line by means of a pointer. A mixed variant (some <tt>Use</tt>s inline others hung off) is impractical and breaks the invariant that the <tt>Use</tt> objects belonging to the same <tt>User</tt> form a contiguous array. </p> -</div> <p> We have 2 different layouts in the <tt>User</tt> (sub)classes: @@ -2839,17 +2876,18 @@ enforce the following memory layouts:</p> <i>(In the above figures '<tt>P</tt>' stands for the <tt>Use**</tt> that is stored in each <tt>Use</tt> object in the member <tt>Use::Prev</tt>)</i> +</div> + <!-- ______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="Waymarking">The waymarking algorithm</a> -</div> +</h4> -<div class="doc_text"> +<div> <p> Since the <tt>Use</tt> objects are deprived of the direct (back)pointer to their <tt>User</tt> objects, there must be a fast and exact method to recover it. This is accomplished by the following scheme:</p> -</div> A bit-encoding in the 2 LSBits (least significant bits) of the <tt>Use::Prev</tt> allows to find the start of the <tt>User</tt> object: @@ -2880,15 +2918,16 @@ Only the significant number of bits need to be stored between the stops, so that the <i>worst case is 20 memory accesses</i> when there are 1000 <tt>Use</tt> objects associated with a <tt>User</tt>.</p> +</div> + <!-- ______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="ReferenceImpl">Reference implementation</a> -</div> +</h4> -<div class="doc_text"> +<div> <p> The following literate Haskell fragment demonstrates the concept:</p> -</div> <div class="doc_code"> <pre> @@ -2970,10 +3009,14 @@ And here is the result of <deepCheck identityProp>:</p> OK, passed 500 tests. </pre> +</div> + <!-- ______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="Tagging">Tagging considerations</a> -</div> +</h4> + +<div> <p> To maintain the invariant that the 2 LSBits of each <tt>Use**</tt> in <tt>Use</tt> @@ -2989,13 +3032,17 @@ the LSBit set. (Portability is relying on the fact that all known compilers plac </div> - <!-- *********************************************************************** --> -<div class="doc_section"> - <a name="coreclasses">The Core LLVM Class Hierarchy Reference </a> </div> + +</div> + +<!-- *********************************************************************** --> +<h2> + <a name="coreclasses">The Core LLVM Class Hierarchy Reference </a> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p><tt>#include "<a href="/doxygen/Type_8h-source.html">llvm/Type.h</a>"</tt> <br>doxygen info: <a href="/doxygen/classllvm_1_1Type.html">Type Class</a></p> @@ -3004,14 +3051,12 @@ being inspected or transformed. The core LLVM classes are defined in header files in the <tt>include/llvm/</tt> directory, and implemented in the <tt>lib/VMCore</tt> directory.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="Type">The <tt>Type</tt> class and Derived Types</a> -</div> +</h3> -<div class="doc_text"> +<div> <p><tt>Type</tt> is a superclass of all type classes. Every <tt>Value</tt> has a <tt>Type</tt>. <tt>Type</tt> cannot be instantiated directly but only @@ -3026,14 +3071,13 @@ the <tt>lib/VMCore</tt> directory.</p> be performed with address equality of the Type Instance. That is, given two <tt>Type*</tt> values, the types are identical if the pointers are identical. </p> -</div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="m_Type">Important Public Methods</a> -</div> +</h4> -<div class="doc_text"> +<div> <ul> <li><tt>bool isIntegerTy() const</tt>: Returns true for any integer type.</li> @@ -3051,10 +3095,10 @@ the <tt>lib/VMCore</tt> directory.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="derivedtypes">Important Derived Types</a> -</div> -<div class="doc_text"> +</h4> +<div> <dl> <dt><tt>IntegerType</tt></dt> <dd>Subclass of DerivedType that represents integer types of any bit width. @@ -3116,14 +3160,14 @@ the <tt>lib/VMCore</tt> directory.</p> </dl> </div> - +</div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="Module">The <tt>Module</tt> class</a> -</div> +</h3> -<div class="doc_text"> +<div> <p><tt>#include "<a href="/doxygen/Module_8h-source.html">llvm/Module.h</a>"</tt><br> doxygen info: @@ -3138,14 +3182,12 @@ href="#GlobalVariable"><tt>GlobalVariable</tt></a>s, and a <a href="#SymbolTable"><tt>SymbolTable</tt></a>. Additionally, it contains a few helpful member functions that try to make common operations easy.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="m_Module">Important Public Members of the <tt>Module</tt> class</a> -</div> +</h4> -<div class="doc_text"> +<div> <ul> <li><tt>Module::Module(std::string name = "")</tt></li> @@ -3244,13 +3286,14 @@ provide a name for it (probably based on the name of the translation unit).</p> </div> +</div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="Value">The <tt>Value</tt> class</a> -</div> +</h3> -<div class="doc_text"> +<div> <p><tt>#include "<a href="/doxygen/Value_8h-source.html">llvm/Value.h</a>"</tt> <br> @@ -3301,14 +3344,12 @@ the class that represents this value. Although this may take some getting used to, it simplifies the representation and makes it easier to manipulate.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="m_Value">Important Public Members of the <tt>Value</tt> class</a> -</div> +</h4> -<div class="doc_text"> +<div> <ul> <li><tt>Value::use_iterator</tt> - Typedef for iterator over the @@ -3355,12 +3396,14 @@ Inst->replaceAllUsesWith(ConstVal); </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="User">The <tt>User</tt> class</a> -</div> +</h3> -<div class="doc_text"> +<div> <p> <tt>#include "<a href="/doxygen/User_8h-source.html">llvm/User.h</a>"</tt><br> @@ -3379,14 +3422,12 @@ Single Assignment (SSA) form, there can only be one definition referred to, allowing this direct connection. This connection provides the use-def information in LLVM.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="m_User">Important Public Members of the <tt>User</tt> class</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>The <tt>User</tt> class exposes the operand list in two ways: through an index access interface and through an iterator based interface.</p> @@ -3409,12 +3450,14 @@ the operands of a <tt>User</tt>.</p></li> </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="Instruction">The <tt>Instruction</tt> class</a> -</div> +</h3> -<div class="doc_text"> +<div> <p><tt>#include "</tt><tt><a href="/doxygen/Instruction_8h-source.html">llvm/Instruction.h</a>"</tt><br> @@ -3445,14 +3488,13 @@ href="#CmpInst">CmpInst</a></tt>). Unfortunately, the use of macros in this file confuses doxygen, so these enum values don't show up correctly in the <a href="/doxygen/classllvm_1_1Instruction.html">doxygen output</a>.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> - <a name="s_Instruction">Important Subclasses of the <tt>Instruction</tt> - class</a> -</div> -<div class="doc_text"> +<h4> + <a name="s_Instruction"> + Important Subclasses of the <tt>Instruction</tt> class + </a> +</h4> +<div> <ul> <li><tt><a name="BinaryOperator">BinaryOperator</a></tt> <p>This subclasses represents all two operand instructions whose operands @@ -3471,12 +3513,13 @@ this file confuses doxygen, so these enum values don't show up correctly in the </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> - <a name="m_Instruction">Important Public Members of the <tt>Instruction</tt> - class</a> -</div> +<h4> + <a name="m_Instruction"> + Important Public Members of the <tt>Instruction</tt> class + </a> +</h4> -<div class="doc_text"> +<div> <ul> <li><tt><a href="#BasicBlock">BasicBlock</a> *getParent()</tt> @@ -3496,12 +3539,14 @@ and it has no name</p></li> </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="Constant">The <tt>Constant</tt> class and subclasses</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Constant represents a base class for different types of constants. It is subclassed by ConstantInt, ConstantArray, etc. for representing @@ -3509,11 +3554,9 @@ the various types of Constants. <a href="#GlobalValue">GlobalValue</a> is also a subclass, which represents the address of a global variable or function. </p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection">Important Subclasses of Constant </div> -<div class="doc_text"> +<h4>Important Subclasses of Constant</h4> +<div> <ul> <li>ConstantInt : This subclass of Constant represents an integer constant of any width. @@ -3561,13 +3604,14 @@ a subclass, which represents the address of a global variable or function. </ul> </div> +</div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="GlobalValue">The <tt>GlobalValue</tt> class</a> -</div> +</h3> -<div class="doc_text"> +<div> <p><tt>#include "<a href="/doxygen/GlobalValue_8h-source.html">llvm/GlobalValue.h</a>"</tt><br> @@ -3607,15 +3651,14 @@ dereference the pointer with <tt>GetElementPtrInst</tt> first, then its elements can be accessed. This is explained in the <a href="LangRef.html#globalvars">LLVM Language Reference Manual</a>.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> - <a name="m_GlobalValue">Important Public Members of the <tt>GlobalValue</tt> - class</a> -</div> +<h4> + <a name="m_GlobalValue"> + Important Public Members of the <tt>GlobalValue</tt> class + </a> +</h4> -<div class="doc_text"> +<div> <ul> <li><tt>bool hasInternalLinkage() const</tt><br> @@ -3631,12 +3674,14 @@ GlobalValue is currently embedded into.</p></li> </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="Function">The <tt>Function</tt> class</a> -</div> +</h3> -<div class="doc_text"> +<div> <p><tt>#include "<a href="/doxygen/Function_8h-source.html">llvm/Function.h</a>"</tt><br> doxygen @@ -3683,15 +3728,15 @@ href="#Argument"><tt>Argument</tt></a>s in the function body.</p> <p>Note that <tt>Function</tt> is a <a href="#GlobalValue">GlobalValue</a> and therefore also a <a href="#Constant">Constant</a>. The value of the function is its address (after linking) which is guaranteed to be constant.</p> -</div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> - <a name="m_Function">Important Public Members of the <tt>Function</tt> - class</a> -</div> +<h4> + <a name="m_Function"> + Important Public Members of the <tt>Function</tt> class + </a> +</h4> -<div class="doc_text"> +<div> <ul> <li><tt>Function(const </tt><tt><a href="#FunctionType">FunctionType</a> @@ -3769,12 +3814,14 @@ iterator<br> </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="GlobalVariable">The <tt>GlobalVariable</tt> class</a> -</div> +</h3> -<div class="doc_text"> +<div> <p><tt>#include "<a href="/doxygen/GlobalVariable_8h-source.html">llvm/GlobalVariable.h</a>"</tt> @@ -3796,15 +3843,15 @@ variables may have an initial value (which must be a <a href="#Constant"><tt>Constant</tt></a>), and if they have an initializer, they may be marked as "constant" themselves (indicating that their contents never change at runtime).</p> -</div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> - <a name="m_GlobalVariable">Important Public Members of the - <tt>GlobalVariable</tt> class</a> -</div> +<h4> + <a name="m_GlobalVariable"> + Important Public Members of the <tt>GlobalVariable</tt> class + </a> +</h4> -<div class="doc_text"> +<div> <ul> <li><tt>GlobalVariable(const </tt><tt><a href="#Type">Type</a> *Ty, bool @@ -3842,13 +3889,14 @@ never change at runtime).</p> </div> +</div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="BasicBlock">The <tt>BasicBlock</tt> class</a> -</div> +</h3> -<div class="doc_text"> +<div> <p><tt>#include "<a href="/doxygen/BasicBlock_8h-source.html">llvm/BasicBlock.h</a>"</tt><br> @@ -3873,15 +3921,14 @@ href="#Value"><tt>Value</tt></a>s, because they are referenced by instructions like branches and can go in the switch tables. <tt>BasicBlock</tt>s have type <tt>label</tt>.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> - <a name="m_BasicBlock">Important Public Members of the <tt>BasicBlock</tt> - class</a> -</div> +<h4> + <a name="m_BasicBlock"> + Important Public Members of the <tt>BasicBlock</tt> class + </a> +</h4> -<div class="doc_text"> +<div> <ul> <li><tt>BasicBlock(const std::string &Name = "", </tt><tt><a @@ -3933,13 +3980,14 @@ returned.</p></li> </div> +</div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="Argument">The <tt>Argument</tt> class</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>This subclass of Value defines the interface for incoming formal arguments to a function. A Function maintains a list of its formal @@ -3947,6 +3995,8 @@ arguments. An argument has a pointer to the parent Function.</p> </div> +</div> + <!-- *********************************************************************** --> <hr> <address> @@ -3957,8 +4007,8 @@ arguments. An argument has a pointer to the parent Function.</p> <a href="mailto:dhurjati@cs.uiuc.edu">Dinakar Dhurjati</a> and <a href="mailto:sabre@nondot.org">Chris Lattner</a><br> - <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br> - Last modified: $Date: 2011-02-17 03:19:22 +0100 (Thu, 17 Feb 2011) $ + <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br> + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> diff --git a/docs/Projects.html b/docs/Projects.html index 76da086657c1..3c6d4ad78ba4 100644 --- a/docs/Projects.html +++ b/docs/Projects.html @@ -7,7 +7,7 @@ </head> <body> -<div class="doc_title">Creating an LLVM Project</div> +<h1>Creating an LLVM Project</h1> <ol> <li><a href="#overview">Overview</a></li> @@ -30,10 +30,10 @@ </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="overview">Overview</a></div> +<h2><a name="overview">Overview</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>The LLVM build system is designed to facilitate the building of third party projects that use LLVM header files, libraries, and tools. In order to use @@ -73,12 +73,12 @@ provide enough information on how to write your own Makefiles.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="create">Create a Project from the Sample Project</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Follow these simple steps to start your project:</p> @@ -145,12 +145,12 @@ project should build.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="source">Source Tree Layout</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>In order to use the LLVM build system, you will want to organize your source code so that it can benefit from the build system's features. @@ -230,26 +230,24 @@ your <b>tools</b> directory.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="makefiles">Writing LLVM Style Makefiles</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>The LLVM build system provides a convenient way to build libraries and executables. Most of your project Makefiles will only need to define a few variables. Below is a list of the variables one can set and what they can do:</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="reqVars">Required Variables</a> -</div> +</h3> -<div class="doc_text"> +<div> <dl> <dt>LEVEL @@ -263,11 +261,11 @@ do:</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="varsBuildDir">Variables for Building Subdirectories</a> -</div> +</h3> -<div class="doc_text"> +<div> <dl> <dt>DIRS @@ -294,11 +292,11 @@ do:</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="varsBuildLib">Variables for Building Libraries</a> -</div> +</h3> -<div class="doc_text"> +<div> <dl> <dt>LIBRARYNAME @@ -325,11 +323,11 @@ do:</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="varsBuildProg">Variables for Building Programs</a> -</div> +</h3> -<div class="doc_text"> +<div> <dl> <dt>TOOLNAME @@ -368,11 +366,11 @@ do:</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="miscVars">Miscellaneous Variables</a> -</div> +</h3> -<div class="doc_text"> +<div> <dl> <dt>ExtraSource @@ -398,13 +396,15 @@ do:</p> </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="objcode">Placement of Object Code</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>The final location of built libraries and executables will depend upon whether you do a Debug, Release, or Profile build.</p> @@ -427,12 +427,12 @@ whether you do a Debug, Release, or Profile build.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="help">Further Help</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>If you have any questions or need any help creating an LLVM project, the LLVM team would be more than happy to help. You can always post your @@ -451,9 +451,9 @@ Mailing List</a>.</p> src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a> <a href="mailto:criswell@uiuc.edu">John Criswell</a><br> - <a href="http://llvm.org">The LLVM Compiler Infrastructure</a> + <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a> <br> - Last modified: $Date: 2010-05-07 02:28:04 +0200 (Fri, 07 May 2010) $ + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> diff --git a/docs/ReleaseNotes.html b/docs/ReleaseNotes.html index 84298376a732..71bf16ea9167 100644 --- a/docs/ReleaseNotes.html +++ b/docs/ReleaseNotes.html @@ -3,13 +3,12 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> - <meta encoding="utf8"> <link rel="stylesheet" href="llvm.css" type="text/css"> - <title>LLVM 2.8 Release Notes</title> + <title>LLVM 2.9 Release Notes</title> </head> <body> -<div class="doc_title">LLVM 2.8 Release Notes</div> +<h1>LLVM 2.9 Release Notes</h1> <img align=right src="http://llvm.org/img/DragonSmall.png" width="136" height="136" alt="LLVM Dragon Logo"> @@ -17,35 +16,35 @@ <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.8</a></li> - <li><a href="#whatsnew">What's New in LLVM 2.8?</a></li> + <li><a href="#externalproj">External Projects Using LLVM 2.9</a></li> + <li><a href="#whatsnew">What's New in LLVM 2.9?</a></li> <li><a href="GettingStarted.html">Installation Instructions</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> + <p>Written by the <a href="http://llvm.org/">LLVM Team</a></p> </div> <!-- -<h1 style="color:red">These are in-progress notes for the upcoming LLVM 2.8 +<h1 style="color:red">These are in-progress notes for the upcoming LLVM 2.9 release.<br> You may prefer the -<a href="http://llvm.org/releases/2.7/docs/ReleaseNotes.html">LLVM 2.7 +<a href="http://llvm.org/releases/2.8/docs/ReleaseNotes.html">LLVM 2.8 Release Notes</a>.</h1> ---> + --> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="intro">Introduction</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>This document contains the release notes for the LLVM Compiler -Infrastructure, release 2.8. Here we describe the status of LLVM, including +Infrastructure, release 2.9. 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> @@ -62,51 +61,37 @@ 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> - - -<!-- -Almost dead code. - include/llvm/Analysis/LiveValues.h => Dan - lib/Transforms/IPO/MergeFunctions.cpp => consider for 2.8. - GEPSplitterPass ---> - -<!-- Features that need text if they're finished for 2.9: +<!-- Features that need text if they're finished for 3.1: + ARM EHABI combiner-aa? strong phi elim loop dependence analysis - TBAA CorrelatedValuePropagation + lib/Transforms/IPO/MergeFunctions.cpp => consider for 3.1. --> - <!-- Announcement, lldb, libc++ --> - - <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="subproj">Sub-project Status Update</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> -The LLVM 2.8 distribution currently consists of code from the core LLVM +The LLVM 2.9 distribution currently consists of code from the core LLVM repository (which roughly includes the LLVM optimizers, code generators and supporting tools), the Clang repository and the llvm-gcc repository. In addition to this code, the LLVM Project includes other sub-projects that are in development. Here we include updates on these subprojects. </p> -</div> - - <!--=========================================================================--> -<div class="doc_subsection"> +<h3> <a name="clang">Clang: C/C++/Objective-C Frontend Toolkit</a> -</div> +</h3> -<div class="doc_text"> +<div> <p><a href="http://clang.llvm.org/">Clang</a> is an LLVM front end for the C, C++, and Objective-C languages. Clang aims to provide a better user experience @@ -115,112 +100,61 @@ standards, fast compilation, and low memory use. Like LLVM, Clang provides a modular, library-based architecture that makes it suitable for creating or integrating with other development tools. Clang is considered a production-quality compiler for C, Objective-C, C++ and Objective-C++ on x86 -(32- and 64-bit), and for darwin-arm targets.</p> - -<p>In the LLVM 2.8 time-frame, the Clang team has made many improvements:</p> - - <ul> - <li>Clang C++ is now feature-complete with respect to the ISO C++ 1998 and 2003 standards.</li> - <li>Added support for Objective-C++.</li> - <li>Clang now uses LLVM-MC to directly generate object code and to parse inline assembly (on Darwin).</li> - <li>Introduced many new warnings, including <code>-Wmissing-field-initializers</code>, <code>-Wshadow</code>, <code>-Wno-protocol</code>, <code>-Wtautological-compare</code>, <code>-Wstrict-selector-match</code>, <code>-Wcast-align</code>, <code>-Wunused</code> improvements, and greatly improved format-string checking.</li> - <li>Introduced the "libclang" library, a C interface to Clang intended to support IDE clients.</li> - <li>Added support for <code>#pragma GCC visibility</code>, <code>#pragma align</code>, and others.</li> - <li>Added support for SSE, AVX, ARM NEON, and AltiVec.</li> - <li>Improved support for many Microsoft extensions.</li> - <li>Implemented support for blocks in C++.</li> - <li>Implemented precompiled headers for C++.</li> - <li>Improved abstract syntax trees to retain more accurate source information.</li> - <li>Added driver support for handling LLVM IR and bitcode files directly.</li> - <li>Major improvements to compiler correctness for exception handling.</li> - <li>Improved generated code quality in some areas: - <ul> - <li>Good code generation for X86-32 and X86-64 ABI handling.</li> - <li>Improved code generation for bit-fields, although important work remains.</li> - </ul> - </li> - </ul> -</div> - -<!--=========================================================================--> -<div class="doc_subsection"> -<a name="clangsa">Clang Static Analyzer</a> -</div> - -<div class="doc_text"> - -<p>The <a href="http://clang-analyzer.llvm.org/">Clang Static Analyzer</a> - project is an effort to use static source code analysis techniques to - automatically find bugs in C and Objective-C programs (and hopefully <a - href="http://clang-analyzer.llvm.org/dev_cxx.html">C++ in the - future</a>!). The tool is very good at finding bugs that occur on specific - paths through code, such as on error conditions.</p> - -<p>The LLVM 2.8 release fixes a number of bugs and slightly improves precision - over 2.7, but there are no major new features in the release. +(32- and 64-bit), and for darwin/arm targets.</p> + +<p>In the LLVM 2.9 time-frame, the Clang team has made many improvements in C, +C++ and Objective-C support. C++ support is now generally rock solid, has +been exercised on a broad variety of code, and has several new <a +href="http://clang.llvm.org/cxx_status.html#cxx0x">C++'0x features</a> +implemented (such as rvalue references and variadic templates). LLVM 2.9 has +also brought in a large range of bug fixes and minor features (e.g. __label__ +support), and is much more compatible with the Linux Kernel.</p> + +<p>If Clang rejects your code but another compiler accepts it, please take a +look at the <a href="http://clang.llvm.org/compatibility.html">language +compatibility</a> guide to make sure this is not intentional or a known issue. </p> </div> <!--=========================================================================--> -<div class="doc_subsection"> -<a name="dragonegg">DragonEgg: llvm-gcc ported to gcc-4.5</a> -</div> - -<div class="doc_text"> -<p> -<a href="http://dragonegg.llvm.org/">DragonEgg</a> is a port of llvm-gcc to -gcc-4.5. Unlike llvm-gcc, dragonegg in theory does not require any gcc-4.5 -modifications whatsoever (currently one small patch is needed) thanks to the -new <a href="http://gcc.gnu.org/wiki/plugins">gcc plugin architecture</a>. -DragonEgg is a gcc plugin that makes gcc-4.5 use the LLVM optimizers and code -generators instead of gcc's, just like with llvm-gcc. -</p> +<h3> +<a name="dragonegg">DragonEgg: GCC front-ends, LLVM back-end</a> +</h3> +<div> <p> -DragonEgg is still a work in progress, but it is able to compile a lot of code, -for example all of gcc, LLVM and clang. Currently Ada, C, C++ and Fortran work -well, while all other languages either don't work at all or only work poorly. -For the moment only the x86-32 and x86-64 targets are supported, and only on -linux and darwin (darwin may need additional gcc patches). +<a href="http://dragonegg.llvm.org/">DragonEgg</a> is a +<a href="http://gcc.gnu.org/wiki/plugins">gcc plugin</a> that replaces GCC's +optimizers and code generators with LLVM's. +Currently it requires a patched version of gcc-4.5. +The plugin can target the x86-32 and x86-64 processor families and has been +used successfully on the Darwin, FreeBSD and Linux platforms. +The Ada, C, C++ and Fortran languages work well. +The plugin is capable of compiling plenty of Obj-C, Obj-C++ and Java but it is +not known whether the compiled code actually works or not! </p> <p> -The 2.8 release has the following notable changes: +The 2.9 release has the following notable changes: <ul> -<li>The plugin loads faster due to exporting fewer symbols.</li> -<li>Additional vector operations such as addps256 are now supported.</li> -<li>Ada global variables with no initial value are no longer zero initialized, -resulting in better optimization.</li> -<li>The '-fplugin-arg-dragonegg-enable-gcc-optzns' flag now runs all gcc -optimizers, rather than just a handful.</li> -<li>Fortran programs using common variables now link correctly.</li> -<li>GNU OMP constructs no longer crash the compiler.</li> +<li>The plugin is much more stable when compiling Fortran.</li> +<li>Inline assembly where an asm output is tied to an input of a different size +is now supported in many more cases.</li> +<li>Basic support for the __float128 type was added. It is now possible to +generate LLVM IR from programs using __float128 but code generation does not +work yet.</li> +<li>Compiling Java programs no longer systematically crashes the plugin.</li> </ul> </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 Java Virtual Machine (Java VM or JVM) that uses LLVM for static and -just-in-time compilation. As of LLVM 2.8, VMKit now supports copying garbage -collectors, and can be configured to use MMTk's copy mark-sweep garbage -collector. In LLVM 2.8, the VMKit .NET VM is no longer being maintained. -</p> -</div> - -<!--=========================================================================--> -<div class="doc_subsection"> +<h3> <a name="compiler-rt">compiler-rt: Compiler Runtime Library</a> -</div> +</h3> -<div class="doc_text"> +<div> <p> The new LLVM <a href="http://compiler-rt.llvm.org/">compiler-rt project</a> is a simple library that provides an implementation of the low-level @@ -231,21 +165,22 @@ function. The compiler-rt library provides highly optimized implementations of this and other low-level routines (some are 3x faster than the equivalent libgcc routines).</p> -<p> -All of the code in the compiler-rt project is available under the standard LLVM -License, a "BSD-style" license. New in LLVM 2.8, compiler_rt now supports -soft floating point (for targets that don't have a real floating point unit), -and includes an extensive testsuite for the "blocks" language feature and the -blocks runtime included in compiler_rt.</p> +<p>In the LLVM 2.9 timeframe, compiler_rt has had several minor changes for + better ARM support, and a fairly major license change. All of the code in the + compiler-rt project is now <a href="DeveloperPolicy.html#license">dual + licensed</a> under MIT and UIUC license, which allows you to use compiler-rt + in applications without the binary copyright reproduction clause. If you + prefer the LLVM/UIUC license, you are free to continue using it under that + license as well.</p> </div> <!--=========================================================================--> -<div class="doc_subsection"> +<h3> <a name="lldb">LLDB: Low Level Debugger</a> -</div> +</h3> -<div class="doc_text"> +<div> <p> <a href="http://lldb.llvm.org/">LLDB</a> is a brand new member of the LLVM umbrella of projects. LLDB is a next generation, high-performance debugger. It @@ -254,20 +189,20 @@ libraries in the larger LLVM Project, such as the Clang expression parser, the LLVM disassembler and the LLVM JIT.</p> <p> -LLDB is in early development and not included as part of the LLVM 2.8 release, -but is mature enough to support basic debugging scenarios on Mac OS X in C, -Objective-C and C++. We'd really like help extending and expanding LLDB to -support new platforms, new languages, new architectures, and new features. -</p> +LLDB is has advanced by leaps and bounds in the 2.9 timeframe. It is +dramatically more stable and useful, and includes both a new <a +href="http://lldb.llvm.org/tutorial.html">tutorial</a> and a <a +href="http://lldb.llvm.org/lldb-gdb.html">side-by-side comparison with +GDB</a>.</p> </div> <!--=========================================================================--> -<div class="doc_subsection"> +<h3> <a name="libc++">libc++: C++ Standard Library</a> -</div> +</h3> -<div class="doc_text"> +<div> <p> <a href="http://libcxx.llvm.org/">libc++</a> is another new member of the LLVM family. It is an implementation of the C++ standard library, written from the @@ -275,21 +210,56 @@ ground up to specifically target the forthcoming C++'0X standard and focus on delivering great performance.</p> <p> -As of the LLVM 2.8 release, libc++ is virtually feature complete, but would -benefit from more testing and better integration with Clang++. It is also -looking forward to the C++ committee finalizing the C++'0x standard. +In the LLVM 2.9 timeframe, libc++ has had numerous bugs fixed, and is now being +co-developed with Clang's C++'0x mode.</p> + +<p> +Like compiler_rt, libc++ is now <a href="DeveloperPolicy.html#license">dual + licensed</a> under the MIT and UIUC license, allowing it to be used more + permissively. </p> </div> +<!--=========================================================================--> +<h3> +<a name="LLBrowse">LLBrowse: IR Browser</a> +</h3> + +<div> +<p> +<a href="http://llvm.org/svn/llvm-project/llbrowse/trunk/doc/LLBrowse.html"> + LLBrowse</a> is an interactive viewer for LLVM modules. It can load any LLVM + module and displays its contents as an expandable tree view, facilitating an + easy way to inspect types, functions, global variables, or metadata nodes. It + is fully cross-platform, being based on the popular wxWidgets GUI toolkit. +</p> +</div> <!--=========================================================================--> -<div class="doc_subsection"> -<a name="klee">KLEE: A Symbolic Execution Virtual Machine</a> +<h3> +<a name="vmkit">VMKit</a> +</h3> + +<div> +<p>The <a href="http://vmkit.llvm.org/">VMKit project</a> is an implementation + of a Java Virtual Machine (Java VM or JVM) that uses LLVM for static and + just-in-time compilation. As of LLVM 2.9, VMKit now supports generational + garbage collectors. The garbage collectors are provided by the MMTk framework, + and VMKit can be configured to use one of the numerous implemented collectors + of MMTk. +</p> </div> + + +<!--=========================================================================--> +<!-- +<h3> +<a name="klee">KLEE: A Symbolic Execution Virtual Machine</a> +</h3> -<div class="doc_text"> +<div> <p> <a href="http://klee.llvm.org/">KLEE</a> is a symbolic execution framework for programs in LLVM bitcode form. KLEE tries to symbolically evaluate "all" paths @@ -298,437 +268,347 @@ states. This allows it to construct testcases that lead to faults and can even be used to verify some algorithms. </p> -<p>Although KLEE does not have any major new features as of 2.8, we have made -various minor improvements, particular to ease development:</p> -<ul> - <li>Added support for LLVM 2.8. KLEE currently maintains compatibility with - LLVM 2.6, 2.7, and 2.8.</li> - <li>Added a buildbot for 2.6, 2.7, and trunk. A 2.8 buildbot will be coming - soon following release.</li> - <li>Fixed many C++ code issues to allow building with Clang++. Mostly - complete, except for the version of MiniSAT which is inside the KLEE STP - version.</li> - <li>Improved support for building with separate source and build - directories.</li> - <li>Added support for "long double" on x86.</li> - <li>Initial work on KLEE support for using 'lit' test runner instead of - DejaGNU.</li> - <li>Added <tt>configure</tt> support for using an external version of - STP.</li> -</ul> +<p>UPDATE!</p> +</div>--> </div> - <!-- *********************************************************************** --> -<div class="doc_section"> - <a name="externalproj">External Open Source Projects Using LLVM 2.8</a> -</div> +<h2> + <a name="externalproj">External Open Source Projects Using LLVM 2.9</a> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>An exciting aspect of LLVM is that it is used as an enabling technology for a lot of other language and tools projects. This section lists some of the - projects that have already been updated to work with LLVM 2.8.</p> -</div> + projects that have already been updated to work with LLVM 2.9.</p> <!--=========================================================================--> -<div class="doc_subsection"> -<a name="tce">TTA-based Codesign Environment (TCE)</a> -</div> +<h3>Crack Programming Language</h3> -<div class="doc_text"> +<div> <p> -<a href="http://tce.cs.tut.fi/">TCE</a> is a toolset for designing -application-specific processors (ASP) based on the Transport triggered -architecture (TTA). The toolset provides a complete co-design flow from C/C++ -programs down to synthesizable VHDL and parallel program binaries. Processor -customization points include the register files, function units, supported -operations, and the interconnection network.</p> - -<p>TCE uses llvm-gcc/Clang and LLVM for C/C++ language support, target -independent optimizations and also for parts of code generation. It generates -new LLVM-based code generators "on the fly" for the designed TTA processors and -loads them in to the compiler backend as runtime libraries to avoid per-target -recompilation of larger parts of the compiler chain.</p> - +<a href="http://code.google.com/p/crack-language/">Crack</a> aims to provide the +ease of development of a scripting language with the performance of a compiled +language. The language derives concepts from C++, Java and Python, incorporating +object-oriented programming, operator overloading and strong typing.</p> </div> - + + <!--=========================================================================--> -<div class="doc_subsection"> -<a name="Horizon">Horizon Bytecode Compiler</a> +<h3>TTA-based Codesign Environment (TCE)</h3> + +<div> +<p>TCE is a toolset for designing application-specific processors (ASP) based on +the Transport triggered architecture (TTA). The toolset provides a complete +co-design flow from C/C++ programs down to synthesizable VHDL and parallel +program binaries. Processor customization points include the register files, +function units, supported operations, and the interconnection network.</p> + +<p>TCE uses Clang and LLVM for C/C++ language support, target independent +optimizations and also for parts of code generation. It generates new LLVM-based +code generators "on the fly" for the designed TTA processors and loads them in +to the compiler backend as runtime libraries to avoid per-target recompilation +of larger parts of the compiler chain.</p> </div> -<div class="doc_text"> -<p> -<a href="http://www.quokforge.org/projects/horizon">Horizon</a> is a bytecode -language and compiler written on top of LLVM, intended for producing -single-address-space managed code operating systems that -run faster than the equivalent multiple-address-space C systems. -More in-depth blurb is available on the <a -href="http://www.quokforge.org/projects/horizon/wiki/Wiki">wiki</a>.</p> - -</div> + <!--=========================================================================--> -<div class="doc_subsection"> -<a name="clamav">Clam AntiVirus</a> +<h3>PinaVM</h3> + +<div> +<p><a href="http://gitorious.org/pinavm/pages/Home">PinaVM</a> is an open +source, <a href="http://www.systemc.org/">SystemC</a> front-end. Unlike many +other front-ends, PinaVM actually executes the elaboration of the +program analyzed using LLVM's JIT infrastructure. It later enriches the +bitcode with SystemC-specific information.</p> </div> -<div class="doc_text"> -<p> -<a href="http://www.clamav.net">Clam AntiVirus</a> is an open source (GPL) -anti-virus toolkit for UNIX, designed especially for e-mail scanning on mail -gateways. Since version 0.96 it has <a -href="http://vrt-sourcefire.blogspot.com/2010/09/introduction-to-clamavs-low-level.html">bytecode -signatures</a> that allow writing detections for complex malware. It -uses LLVM's JIT to speed up the execution of bytecode on -X86, X86-64, PPC32/64, falling back to its own interpreter otherwise. -The git version was updated to work with LLVM 2.8. -</p> - -<p>The <a -href="http://git.clamav.net/gitweb?p=clamav-bytecode-compiler.git;a=blob_plain;f=docs/user/clambc-user.pdf"> -ClamAV bytecode compiler</a> uses Clang and LLVM to compile a C-like -language, insert runtime checks, and generate ClamAV bytecode.</p> - +<!--=========================================================================--> +<h3>Pure</h3> + +<div> +<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. The interpreter uses LLVM as a backend to JIT-compile Pure + programs to fast native code. 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 interface to C and other + programming languages (including the ability to load LLVM bitcode + modules, and inline C, C++, Fortran and Faust code in Pure programs if + the corresponding LLVM-enabled compilers are installed).</p> + +<p>Pure version 0.47 has been tested and is known to work with LLVM 2.9 + (and continues to work with older LLVM releases >= 2.5).</p> </div> <!--=========================================================================--> -<div class="doc_subsection"> -<a name="pure">Pure</a> -</div> +<h3 id="icedtea">IcedTea Java Virtual Machine Implementation</h3> -<div class="doc_text"> +<div> <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>Pure versions 0.44 and later have been tested and are known to work with -LLVM 2.8 (and continue to work with older LLVM releases >= 2.5).</p> +<a href="http://icedtea.classpath.org/wiki/Main_Page">IcedTea</a> provides a +harness to build OpenJDK using only free software build tools and to provide +replacements for the not-yet free parts of OpenJDK. One of the extensions that +IcedTea provides is a new JIT compiler named <a +href="http://icedtea.classpath.org/wiki/ZeroSharkFaq">Shark</a> which uses LLVM +to provide native code generation without introducing processor-dependent +code. +</p> +<p> OpenJDK 7 b112, IcedTea6 1.9 and IcedTea7 1.13 and later have been tested +and are known to work with LLVM 2.9 (and continue to work with older LLVM +releases >= 2.6 as well).</p> </div> <!--=========================================================================--> -<div class="doc_subsection"> -<a name="GHC">Glasgow Haskell Compiler (GHC)</a> -</div> - -<div class="doc_text"> -<p> -<a href="http://www.haskell.org/ghc/">GHC</a> is an open source, -state-of-the-art programming suite for -Haskell, a standard lazy functional programming language. It includes -an optimizing static compiler generating good code for a variety of +<h3>Glasgow Haskell Compiler (GHC)</h3> + +<div> +<p>GHC is an open source, state-of-the-art programming suite for Haskell, +a standard lazy functional programming language. It includes an +optimizing static compiler generating good code for a variety of platforms, together with an interactive system for convenient, quick development.</p> <p>In addition to the existing C and native code generators, GHC 7.0 now -supports an <a -href="http://hackage.haskell.org/trac/ghc/wiki/Commentary/Compiler/Backends/LLVM">LLVM -code generator</a>. GHC supports LLVM 2.7 and later.</p> - +supports an LLVM code generator. GHC supports LLVM 2.7 and later.</p> </div> <!--=========================================================================--> -<div class="doc_subsection"> -<a name="Clay">Clay Programming Language</a> -</div> - -<div class="doc_text"> -<p> -<a href="http://tachyon.in/clay/">Clay</a> is a new systems programming -language that is specifically designed for generic programming. It makes -generic programming very concise thanks to whole program type propagation. It -uses LLVM as its backend.</p> - +<h3>Polly - Polyhedral optimizations for LLVM</h3> + +<div> +<p>Polly is a project that aims to provide advanced memory access optimizations +to better take advantage of SIMD units, cache hierarchies, multiple cores or +even vector accelerators for LLVM. Built around an abstract mathematical +description based on Z-polyhedra, it provides the infrastructure to develop +advanced optimizations in LLVM and to connect complex external optimizers. In +its first year of existence Polly already provides an exact value-based +dependency analysis as well as basic SIMD and OpenMP code generation support. +Furthermore, Polly can use PoCC(Pluto) an advanced optimizer for data-locality +and parallelism.</p> </div> <!--=========================================================================--> -<div class="doc_subsection"> -<a name="llvm-py">llvm-py Python Bindings for LLVM</a> -</div> - -<div class="doc_text"> -<p> -<a href="http://www.mdevan.org/llvm-py/">llvm-py</a> has been updated to work -with LLVM 2.8. llvm-py provides Python bindings for LLVM, allowing you to write a -compiler backend or a VM in Python.</p> +<h3>Rubinius</h3> +<div> + <p><a href="http://github.com/evanphx/rubinius">Rubinius</a> is an environment + for running Ruby code which strives to write as much of the implementation in + Ruby as possible. Combined with a bytecode interpreting VM, it uses LLVM to + optimize and compile ruby code down to machine code. Techniques such as type + feedback, method inlining, and deoptimization are all used to remove dynamism + from ruby execution and increase performance.</p> </div> <!--=========================================================================--> -<div class="doc_subsection"> +<h3> <a name="FAUST">FAUST Real-Time Audio Signal Processing Language</a> -</div> +</h3> -<div class="doc_text"> +<div> <p> <a href="http://faust.grame.fr">FAUST</a> is a compiled language for real-time audio signal processing. The name FAUST stands for Functional AUdio STream. Its programming model combines two approaches: functional programming and block diagram composition. In addition with the C, C++, JAVA output formats, the -Faust compiler can now generate LLVM bitcode, and works with LLVM 2.7 and -2.8.</p> - -</div> +Faust compiler can now generate LLVM bitcode, and works with LLVM 2.7-2.9.</p> -<!--=========================================================================--> -<div class="doc_subsection"> -<a name="jade">Jade Just-in-time Adaptive Decoder Engine</a> </div> - -<div class="doc_text"> -<p><a -href="http://sourceforge.net/apps/trac/orcc/wiki/JadeDocumentation">Jade</a> -(Just-in-time Adaptive Decoder Engine) is a generic video decoder engine using -LLVM for just-in-time compilation of video decoder configurations. Those -configurations are designed by MPEG Reconfigurable Video Coding (RVC) committee. -MPEG RVC standard is built on a stream-based dataflow representation of -decoders. It is composed of a standard library of coding tools written in -RVC-CAL language and a dataflow configuration — block diagram — -of a decoder.</p> - -<p>Jade project is hosted as part of the <a href="http://orcc.sf.net">Open -RVC-CAL Compiler</a> and requires it to translate the RVC-CAL standard library -of video coding tools into an LLVM assembly code.</p> - -</div> - -<!--=========================================================================--> -<div class="doc_subsection"> -<a name="neko_llvm_jit">LLVM JIT for Neko VM</a> -</div> - -<div class="doc_text"> -<p><a href="http://github.com/vava/neko_llvm_jit">Neko LLVM JIT</a> -replaces the standard Neko JIT with an LLVM-based implementation. While not -fully complete, it is already providing a 1.5x speedup on 64-bit systems. -Neko LLVM JIT requires LLVM 2.8 or later.</p> - -</div> - -<!--=========================================================================--> -<div class="doc_subsection"> -<a name="crack">Crack Scripting Language</a> -</div> - -<div class="doc_text"> -<p> -<a href="http://code.google.com/p/crack-language/">Crack</a> aims to provide -the ease of development of a scripting language with the performance of a -compiled language. The language derives concepts from C++, Java and Python, -incorporating object-oriented programming, operator overloading and strong -typing. Crack 0.2 works with LLVM 2.7, and the forthcoming Crack 0.2.1 release -builds on LLVM 2.8.</p> - -</div> - -<!--=========================================================================--> -<div class="doc_subsection"> -<a name="DresdenTM">Dresden TM Compiler (DTMC)</a> -</div> - -<div class="doc_text"> -<p> -<a href="http://tm.inf.tu-dresden.de">DTMC</a> provides support for -Transactional Memory, which is an easy-to-use and efficient way to synchronize -accesses to shared memory. Transactions can contain normal C/C++ code (e.g., -<code>__transaction { list.remove(x); x.refCount--; }</code>) and will be executed -virtually atomically and isolated from other transactions.</p> - -</div> - -<!--=========================================================================--> -<div class="doc_subsection"> -<a name="Kai">Kai Programming Language</a> -</div> - -<div class="doc_text"> -<p> -<a href="http://www.oriontransfer.co.nz/research/kai">Kai</a> (Japanese 会 for -meeting/gathering) is an experimental interpreter that provides a highly -extensible runtime environment and explicit control over the compilation -process. Programs are defined using nested symbolic expressions, which are all -parsed into first-class values with minimal intrinsic semantics. Kai can -generate optimised code at run-time (using LLVM) in order to exploit the nature -of the underlying hardware and to integrate with external software libraries. -It is a unique exploration into world of dynamic code compilation, and the -interaction between high level and low level semantics.</p> - -</div> - -<!--=========================================================================--> -<div class="doc_subsection"> -<a name="OSL">OSL: Open Shading Language</a> -</div> - -<div class="doc_text"> -<p> -<a href="http://code.google.com/p/openshadinglanguage/">OSL</a> is a shading -language designed for use in physically based renderers and in particular -production rendering. By using LLVM instead of the interpreter, it was able to -meet its performance goals (>= C-code) while retaining the benefits of -runtime specialization and a portable high-level language. -</p> - + </div> - - <!-- *********************************************************************** --> -<div class="doc_section"> - <a name="whatsnew">What's New in LLVM 2.8?</a> -</div> +<h2> + <a name="whatsnew">What's New in LLVM 2.9?</a> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <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"> +<h3> <a name="majorfeatures">Major New Features</a> -</div> +</h3> -<div class="doc_text"> +<div> -<p>LLVM 2.8 includes several major new capabilities:</p> +<p>LLVM 2.9 includes several major new capabilities:</p> <ul> -<li>As mentioned above, <a href="#libc++">libc++</a> and <a - href="#lldb">LLDB</a> are major new additions to the LLVM collective.</li> -<li>LLVM 2.8 now has pretty decent support for debugging optimized code. You - should be able to reliably get debug info for function arguments, assuming - that the value is actually available where you have stopped.</li> -<li>A new 'llvm-diff' tool is available that does a semantic diff of .ll - files.</li> -<li>The <a href="#mc">MC subproject</a> has made major progress in this release. - Direct .o file writing support for darwin/x86[-64] is now reliable and - support for other targets and object file formats are in progress.</li> -</ul> + +<li>Type Based Alias Analysis (TBAA) is now implemented and turned on by default + in Clang. This allows substantially better load/store optimization in some + cases. TBAA can be disabled by passing -fno-strict-aliasing. +</li> + +<li>This release has seen a continued focus on quality of debug information. + LLVM now generates much higher fidelity debug information, particularly when + debugging optimized code.</li> + +<li>Inline assembly now supports multiple alternative constraints.</li> +<li>A new backend for the NVIDIA PTX virtual ISA (used to target its GPUs) is + under rapid development. It is not generally useful in 2.9, but is making + rapid progress.</li> + +</ul> + </div> <!--=========================================================================--> -<div class="doc_subsection"> +<h3> <a name="coreimprovements">LLVM IR and Core Improvements</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>LLVM IR has several new features for better support of new targets and that expose new optimization opportunities:</p> <ul> -<li>The <a href="LangRef.html#int_libc">memcpy, memmove, and memset</a> - intrinsics now take address space qualified pointers and a bit to indicate - whether the transfer is "<a href="LangRef.html#volatile">volatile</a>" or not. -</li> -<li>Per-instruction debug info metadata is much faster and uses less memory by - using the new DebugLoc class.</li> -<li>LLVM IR now has a more formalized concept of "<a - href="LangRef.html#trapvalues">trap values</a>", which allow the optimizer - to optimize more aggressively in the presence of undefined behavior, while - still producing predictable results.</li> -<li>LLVM IR now supports two new <a href="LangRef.html#linkage">linkage - types</a> (linker_private_weak and linker_private_weak_def_auto) which map - onto some obscure MachO concepts.</li> +<li>The <a href="LangRef.html#bitwiseops">udiv, ashr, lshr, and shl</a> + instructions now have support exact and nuw/nsw bits to indicate that they + don't overflow or shift out bits. This is useful for optimization of <a + href="http://llvm.org/PR8862">pointer differences</a> and other cases.</li> + +<li>LLVM IR now supports the <a href="LangRef.html#globalvars">unnamed_addr</a> + attribute to indicate that constant global variables with identical + initializers can be merged. This fixed <a href="http://llvm.org/PR8927">an + issue</a> where LLVM would incorrectly merge two globals which were supposed + to have distinct addresses.</li> + +<li>The new <a href="LangRef.html#fnattrs">hotpatch attribute</a> has been added + to allow runtime patching of functions.</li> </ul> </div> <!--=========================================================================--> -<div class="doc_subsection"> +<h3> <a name="optimizer">Optimizer Improvements</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>In addition to a large array of minor performance tweaks and bug fixes, this release includes a few major enhancements and additions to the optimizers:</p> <ul> -<li>As mentioned above, the optimizer now has support for updating debug - information as it goes. A key aspect of this is the new <a - href="SourceLevelDebugging.html#format_common_value">llvm.dbg.value</a> - intrinsic. This intrinsic represents debug info for variables that are - promoted to SSA values (typically by mem2reg or the -scalarrepl passes).</li> - -<li>The JumpThreading pass is now much more aggressive about implied value - relations, allowing it to thread conditions like "a == 4" when a is known to - be 13 in one of the predecessors of a block. It does this in conjunction - with the new LazyValueInfo analysis pass.</li> -<li>The new RegionInfo analysis pass identifies single-entry single-exit regions - in the CFG. You can play with it with the "opt -regions -analyze" or - "opt -view-regions" commands.</li> -<li>The loop optimizer has significantly improved strength reduction and analysis - capabilities. Notably it is able to build on the trap value and signed - integer overflow information to optimize <= and >= loops.</li> -<li>The CallGraphSCCPassManager now has some basic support for iterating within - an SCC when a optimizer devirtualizes a function call. This allows inlining - through indirect call sites that are devirtualized by store-load forwarding - and other optimizations.</li> -<li>The new <A href="Passes.html#loweratomic">-loweratomic</a> pass is available - to lower atomic instructions into their non-atomic form. This can be useful - to optimize generic code that expects to run in a single-threaded - environment.</li> -</ul> +<li>Link Time Optimization (LTO) has been improved to use MC for parsing inline + assembly and now can build large programs like Firefox 4 on both Mac OS X and + Linux.</li> + +<li>The new -loop-idiom pass recognizes memset/memcpy loops (and memset_pattern + on darwin), turning them into library calls, which are typically better + optimized than inline code. If you are building a libc and notice that your + memcpy and memset functions are compiled into infinite recursion, please build + with -ffreestanding or -fno-builtin to disable this pass.</li> + +<li>A new -early-cse pass does a fast pass over functions to fold constants, + simplify expressions, perform simple dead store elimination, and perform + common subexpression elimination. It does a good job at catching some of the + trivial redundancies that exist in unoptimized code, making later passes more + effective.</li> + +<li>A new -loop-instsimplify pass is used to clean up loop bodies in the loop + optimizer.</li> + +<li>The new TargetLibraryInfo interface allows mid-level optimizations to know + whether the current target's runtime library has certain functions. For + example, the optimizer can now transform integer-only printf calls to call + iprintf, allowing reduced code size for embedded C libraries (e.g. newlib). +</li> + +<li>LLVM has a new <a href="WritingAnLLVMPass.html#RegionPass">RegionPass</a> + infrastructure for region-based optimizations.</li> + +<li>Several optimizer passes have been substantially sped up: + GVN is much faster on functions with deep dominator trees and lots of basic + blocks. The dominator tree and dominance frontier passes are much faster to + compute, and preserved by more passes (so they are computed less often). The + -scalar-repl pass is also much faster and doesn't use DominanceFrontier. +</li> -<!-- -<p>In addition to these features that are done in 2.8, there is preliminary - support in the release for Type Based Alias Analysis - Preliminary work on TBAA but not usable in 2.8. - New CorrelatedValuePropagation pass, not on by default in 2.8 yet. ---> +<li>The Dead Store Elimination pass is more aggressive optimizing stores of + different types: e.g. a large store following a small one to the same address. + The MemCpyOptimizer pass handles several new forms of memcpy elimination.</li> + +<li>LLVM now optimizes various idioms for overflow detection into check of the + flag register on various CPUs. For example, we now compile: + + <pre> + unsigned long t = a+b; + if (t < a) ... + </pre> + into: + <pre> + addq %rdi, %rbx + jno LBB0_2 + </pre> +</li> + +</ul> </div> <!--=========================================================================--> -<div class="doc_subsection"> +<h3> <a name="mc">MC Level Improvements</a> -</div> +</h3> -<div class="doc_text"> +<div> <p> The LLVM Machine Code (aka MC) subsystem was created to solve a number of problems in the realm of assembly, disassembly, object file format handling, and a number of other related areas that CPU instruction-set level tools work in.</p> -<p>The MC subproject has made great leaps in LLVM 2.8. For example, support for - directly writing .o files from LLC (and clang) now works reliably for - darwin/x86[-64] (including inline assembly support) and the integrated - assembler is turned on by default in Clang for these targets. This provides - improved compile times among other things.</p> - <ul> -<li>The entire compiler has converted over to using the MCStreamer assembler API - instead of writing out a .s file textually.</li> -<li>The "assembler parser" is far more mature than in 2.7, supporting a full - complement of directives, now supports assembler macros, etc.</li> -<li>The "assembler backend" has been completed, including support for relaxation - relocation processing and all the other things that an assembler does.</li> -<li>The MachO file format support is now fully functional and works.</li> -<li>The MC disassembler now fully supports ARM and Thumb. ARM assembler support - is still in early development though.</li> -<li>The X86 MC assembler now supports the X86 AES and AVX instruction set.</li> -<li>Work on ELF and COFF object files and ARM target support is well underway, - but isn't useful yet in LLVM 2.8. Please contact the llvmdev mailing list - if you're interested in this.</li> +<li>ELF MC support has matured enough for the integrated assembler to be turned + on by default in Clang on X86-32 and X86-64 ELF systems.</li> + +<li>MC supports and CodeGen uses the <tt>.file</tt> and <tt>.loc</tt> directives + for producing line number debug info. This produces more compact line + tables and easier to read .s files.</li> + +<li>MC supports the <tt>.cfi_*</tt> directives for producing DWARF + frame information, but it is still not used by CodeGen by default.</li> + + +<li>The MC assembler now generates much better diagnostics for common errors, + is much faster at matching instructions, is much more bug-compatible with + the GAS assembler, and is now generally useful for a broad range of X86 + assembly.</li> + +<li>We now have some basic <a href="CodeGenerator.html#mc">internals + documentation</a> for MC.</li> + +<li>.td files can now specify assembler aliases directly with the <a + href="CodeGenerator.html#na_instparsing">MnemonicAlias and InstAlias</a> + tblgen classes.</li> + +<li>LLVM now has an experimental format-independent object file manipulation + library (lib/Object). It supports both PE/COFF and ELF. The llvm-nm tool has + been extended to work with native object files, and the new llvm-objdump tool + supports disassembly of object files (but no relocations are displayed yet). +</li> + +<li>Win32 PE-COFF support in the MC assembler has made a lot of progress in the + 2.9 timeframe, but is still not generally useful.</li> + </ul> <p>For more information, please see the <a @@ -736,375 +616,222 @@ href="http://blog.llvm.org/2010/04/intro-to-llvm-mc-project.html">Intro to the LLVM MC Project Blog Post</a>. </p> -</div> - +</div> <!--=========================================================================--> -<div class="doc_subsection"> +<h3> <a name="codegen">Target Independent Code Generator Improvements</a> -</div> +</h3> -<div class="doc_text"> +<div> <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>The clang/gcc -momit-leaf-frame-pointer argument is now supported.</li> -<li>The clang/gcc -ffunction-sections and -fdata-sections arguments are now - supported on ELF targets (like GCC).</li> -<li>The MachineCSE pass is now tuned and on by default. It eliminates common - subexpressions that are exposed when lowering to machine instructions.</li> -<li>The "local" register allocator was replaced by a new "fast" register - allocator. This new allocator (which is often used at -O0) is substantially - faster and produces better code than the old local register allocator.</li> -<li>A new LLC "-regalloc=default" option is available, which automatically - chooses a register allocator based on the -O optimization level.</li> -<li>The common code generator code was modified to promote illegal argument and - return value vectors to wider ones when possible instead of scalarizing - them. For example, <3 x float> will now pass in one SSE register - instead of 3 on X86. This generates substantially better code since the - rest of the code generator was already expecting this.</li> -<li>The code generator uses a new "COPY" machine instruction. This speeds up - the code generator and eliminates the need for targets to implement the - isMoveInstr hook. Also, the copyRegToReg hook was renamed to copyPhysReg - and simplified.</li> -<li>The code generator now has a "LocalStackSlotPass", which optimizes stack - slot access for targets (like ARM) that have limited stack displacement - addressing.</li> -<li>A new "PeepholeOptimizer" is available, which eliminates sign and zero - extends, and optimizes away compare instructions when the condition result - is available from a previous instruction.</li> -<li>Atomic operations now get legalized into simpler atomic operations if not - natively supported, easing the implementation burden on targets.</li> -<li>We have added two new bottom-up pre-allocation register pressure aware schedulers: -<ol> -<li>The hybrid scheduler schedules aggressively to minimize schedule length when registers are available and avoid overscheduling in high pressure situations.</li> -<li>The instruction-level-parallelism scheduler schedules for maximum ILP when registers are available and avoid overscheduling in high pressure situations.</li> -</ol></li> -<li>The tblgen type inference algorithm was rewritten to be more consistent and - diagnose more target bugs. If you have an out-of-tree backend, you may - find that it finds bugs in your target description. This support also - allows limited support for writing patterns for instructions that return - multiple results (e.g. a virtual register and a flag result). The - 'parallel' modifier in tblgen was removed, you should use the new support - for multiple results instead.</li> -<li>A new (experimental) "-rendermf" pass is available which renders a - MachineFunction into HTML, showing live ranges and other useful - details.</li> -<li>The new SubRegIndex tablegen class allows subregisters to be indexed - symbolically instead of numerically. If your target uses subregisters you - will need to adapt to use SubRegIndex when you upgrade to 2.8.</li> -<!-- SplitKit --> - -<li>The -fast-isel instruction selection path (used at -O0 on X86) was rewritten - to work bottom-up on basic blocks instead of top down. This makes it - slightly faster (because the MachineDCE pass is not needed any longer) and - allows it to generate better code in some cases.</li> +<li>The pre-register-allocation (preRA) instruction scheduler models register + pressure much more accurately in some cases. This allows the adoption of more + aggressive scheduling heuristics without causing spills to be generated. +</li> + +<li>LiveDebugVariables is a new pass that keeps track of debugging information + for user variables that are promoted to registers in optimized builds.</li> + +<li>The scheduler now models operand latency and pipeline forwarding.</li> +<li>A major register allocator infrastructure rewrite is underway. It is not on + by default for 2.9 and you are not advised to use it, but it has made + substantial progress in the 2.9 timeframe: + <ul> + <li>A new -regalloc=basic "basic" register allocator can be used as a simple + fallback when debugging. It uses the new infrastructure.</li> + <li>New infrastructure is in place for live range splitting. "SplitKit" can + break a live interval into smaller pieces while preserving SSA form, and + SpillPlacement can help find the best split points. This is a work in + progress so the API is changing quickly.</li> + <li>The inline spiller has learned to clean up after live range splitting. It + can hoist spills out of loops, and it can eliminate redundant spills.</li> + <li>Rematerialization works with live range splitting.</li> + <li>The new "greedy" register allocator using live range splitting. This will + be the default register allocator in the next LLVM release, but it is not + turned on by default in 2.9.</li> + </ul> +</li> </ul> </div> <!--=========================================================================--> -<div class="doc_subsection"> +<h3> <a name="x86">X86-32 and X86-64 Target Improvements</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>New features and major changes in the X86 target include: </p> <ul> -<li>The X86 backend now supports holding X87 floating point stack values - in registers across basic blocks, dramatically improving performance of code - that uses long double, and when targeting CPUs that don't support SSE.</li> - -<li>The X86 backend now uses a SSEDomainFix pass to optimize SSE operations. On - Nehalem ("Core i7") and newer CPUs there is a 2 cycle latency penalty on - using a register in a different domain than where it was defined. This pass - optimizes away these stalls.</li> - -<li>The X86 backend now promotes 16-bit integer operations to 32-bits when - possible. This avoids 0x66 prefixes, which are slow on some - microarchitectures and bloat the code on all of them.</li> - -<li>The X86 backend now supports the Microsoft "thiscall" calling convention, - and a <a href="LangRef.html#callingconv">calling convention</a> to support - <a href="#GHC">ghc</a>.</li> - -<li>The X86 backend supports a new "llvm.x86.int" intrinsic, which maps onto - the X86 "int $42" and "int3" instructions.</li> - -<li>At the IR level, the <2 x float> datatype is now promoted and passed - around as a <4 x float> instead of being passed and returned as an MMX - vector. If you have a frontend that uses this, please pass and return a - <2 x i32> instead (using bitcasts).</li> - -<li>When printing .s files in verbose assembly mode (the default for clang -S), - the X86 backend now decodes X86 shuffle instructions and prints human - readable comments after the most inscrutable of them, e.g.: - -<pre> - insertps $113, %xmm3, %xmm0 <i># xmm0 = zero,xmm0[1,2],xmm3[1]</i> - unpcklps %xmm1, %xmm0 <i># xmm0 = xmm0[0],xmm1[0],xmm0[1],xmm1[1]</i> - pshufd $1, %xmm1, %xmm1 <i># xmm1 = xmm1[1,0,0,0]</i> -</pre> +<li>LLVM 2.9 includes a complete reimplementation of the MMX instruction set. + The reimplementation uses a new LLVM IR <a + href="LangRef.html#t_x86mmx">x86_mmx</a> type to ensure that MMX operations + are <em>only</em> generated from source that uses MMX builtin operations. With + this, random types like <2 x i32> are not turned into MMX operations + (which can be catastrophic without proper "emms" insertion). Because the X86 + code generator always generates reliable code, the -disable-mmx flag is now + removed. +</li> + +<li>X86 support for FS/GS relative loads and stores using <a + href="CodeGenerator.html#x86_memory">address space 256/257</a> works reliably + now.</li> + +<li>LLVM 2.9 generates much better code in several cases by using adc/sbb to + avoid generation of conditional move instructions for conditional increment + and other idioms.</li> + +<li>The X86 backend has adopted a new preRA scheduling mode, "list-ilp", to + shorten the height of instruction schedules without inducing register spills. </li> - + +<li>The MC assembler supports 3dNow! and 3DNowA instructions.</li> + +<li>Several bugs have been fixed for Windows x64 code generator.</li> </ul> </div> <!--=========================================================================--> -<div class="doc_subsection"> +<h3> <a name="ARM">ARM Target Improvements</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>New features of the ARM target include: </p> <ul> -<li>The ARM backend now optimizes tail calls into jumps.</li> -<li>Scheduling is improved through the new list-hybrid scheduler as well - as through better modeling of structural hazards.</li> -<li><a href="LangRef.html#int_fp16">Half float</a> instructions are now - supported.</li> -<li>NEON support has been improved to model instructions which operate onto - multiple consecutive registers more aggressively. This avoids lots of - extraneous register copies.</li> -<li>The ARM backend now uses a new "ARMGlobalMerge" pass, which merges several - global variables into one, saving extra address computation (all the global - variables can be accessed via same base address) and potentially reducing - register pressure.</li> - -<li>The ARM backend has received many minor improvements and tweaks which lead - to substantially better performance in a wide range of different scenarios. -</li> +<li>The ARM backend now has a fast instruction selector, which dramatically + improves -O0 compile times.</li> +<li>The ARM backend has new tuning for Cortex-A8 and Cortex-A9 CPUs.</li> +<li>The __builtin_prefetch builtin (and llvm.prefetch intrinsic) is compiled + into prefetch instructions instead of being discarded.</li> -<li>The ARM NEON intrinsics have been substantially reworked to reduce - redundancy and improve code generation. Some of the major changes are: - <ol> - <li> - All of the NEON load and store intrinsics (llvm.arm.neon.vld* and - llvm.arm.neon.vst*) take an extra parameter to specify the alignment in bytes - of the memory being accessed. - </li> - <li> - The llvm.arm.neon.vaba intrinsic (vector absolute difference and - accumulate) has been removed. This operation is now represented using - the llvm.arm.neon.vabd intrinsic (vector absolute difference) followed by a - vector add. - </li> - <li> - The llvm.arm.neon.vabdl and llvm.arm.neon.vabal intrinsics (lengthening - vector absolute difference with and without accumulation) have been removed. - They are represented using the llvm.arm.neon.vabd intrinsic (vector absolute - difference) followed by a vector zero-extend operation, and for vabal, - a vector add. - </li> - <li> - The llvm.arm.neon.vmovn intrinsic has been removed. Calls of this intrinsic - are now replaced by vector truncate operations. - </li> - <li> - The llvm.arm.neon.vmovls and llvm.arm.neon.vmovlu intrinsics have been - removed. They are now represented as vector sign-extend (vmovls) and - zero-extend (vmovlu) operations. - </li> - <li> - The llvm.arm.neon.vaddl*, llvm.arm.neon.vaddw*, llvm.arm.neon.vsubl*, and - llvm.arm.neon.vsubw* intrinsics (lengthening vector add and subtract) have - been removed. They are replaced by vector add and vector subtract operations - where one (vaddw, vsubw) or both (vaddl, vsubl) of the operands are either - sign-extended or zero-extended. - </li> - <li> - The llvm.arm.neon.vmulls, llvm.arm.neon.vmullu, llvm.arm.neon.vmlal*, and - llvm.arm.neon.vmlsl* intrinsics (lengthening vector multiply with and without - accumulation and subtraction) have been removed. These operations are now - represented as vector multiplications where the operands are either - sign-extended or zero-extended, followed by a vector add for vmlal or a - vector subtract for vmlsl. Note that the polynomial vector multiply - intrinsic, llvm.arm.neon.vmullp, remains unchanged. - </li> - </ol> -</li> +<li> The ARM backend preRA scheduler now models machine resources at cycle + granularity. This allows the scheduler to both accurately model + instruction latency and avoid overcommitting functional units.</li> +<li>Countless ARM microoptimizations have landed in LLVM 2.9.</li> </ul> </div> + +<!--=========================================================================--> +<h3> +<a name="OtherTS">Other Target Specific Improvements</a> +</h3> + +<div> +<ul> +<li>MicroBlaze: major updates for aggressive delay slot filler, MC-based + assembly printing, assembly instruction parsing, ELF .o file emission, and MC + instruction disassembler have landed.</li> +<li>SPARC: Many improvements, including using the Y registers for + multiplications and addition of a simple delay slot filler.</li> + +<li>PowerPC: The backend has been largely MC'ized and is ready to support + directly writing out mach-o object files. No one seems interested in finishing + this final step though.</li> + +<li>Mips: Improved o32 ABI support, including better varags handling. +More instructions supported in codegen: madd, msub, rotr, rotrv and clo. +It also now supports lowering block addresses.</li> + +</ul> +</div> <!--=========================================================================--> -<div class="doc_subsection"> +<h3> <a name="changes">Major Changes and Removed Features</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>If you're already an LLVM user or developer with out-of-tree changes based -on LLVM 2.7, this section lists some "gotchas" that you may run into upgrading +on LLVM 2.8, this section lists some "gotchas" that you may run into upgrading from the previous release.</p> <ul> -<li>The build configuration machinery changed the output directory names. It - wasn't clear to many people that a "Release-Asserts" build was a release build - without asserts. To make this more clear, "Release" does not include - assertions and "Release+Asserts" does (likewise, "Debug" and - "Debug+Asserts").</li> -<li>The MSIL Backend was removed, it was unsupported and broken.</li> -<li>The ABCD, SSI, and SCCVN passes were removed. These were not fully - functional and their behavior has been or will be subsumed by the - LazyValueInfo pass.</li> -<li>The LLVM IR 'Union' feature was removed. While this is a desirable feature - for LLVM IR to support, the existing implementation was half baked and - barely useful. We'd really like anyone interested to resurrect the work and - finish it for a future release.</li> -<li>If you're used to reading .ll files, you'll probably notice that .ll file - dumps don't produce #uses comments anymore. To get them, run a .bc file - through "llvm-dis --show-annotations".</li> -<li>Target triples are now stored in a normalized form, and all inputs from - humans are expected to be normalized by Triple::normalize before being - stored in a module triple or passed to another library.</li> -</ul> +<li><b>This is the last release to support the llvm-gcc frontend.</b></li> +<li>LLVM has a new <a href="CodingStandards.html#ll_naming">naming + convention standard</a>, though the codebase hasn't fully adopted it yet.</li> + +<li>The new DIBuilder class provides a simpler interface for front ends to + encode debug info in LLVM IR, and has replaced DIFactory.</li> +<li>LLVM IR and other tools always work on normalized target triples (which have + been run through <tt>Triple::normalize</tt>).</li> -<p>In addition, many APIs have changed in this release. Some of the major LLVM -API changes are:</p> -<ul> -<li>LLVM 2.8 changes the internal order of operands in <a - href="http://llvm.org/doxygen/classllvm_1_1InvokeInst.html"><tt>InvokeInst</tt></a> - and <a href="http://llvm.org/doxygen/classllvm_1_1CallInst.html"><tt>CallInst</tt></a>. - To be portable across releases, please use the <tt>CallSite</tt> class and the - high-level accessors, such as <tt>getCalledValue</tt> and - <tt>setUnwindDest</tt>. -</li> -<li> - You can no longer pass use_iterators directly to cast<> (and similar), - because these routines tend to perform costly dereference operations more - than once. You have to dereference the iterators yourself and pass them in. -</li> -<li> - llvm.memcpy.*, llvm.memset.*, llvm.memmove.* intrinsics take an extra - parameter now ("i1 isVolatile"), totaling 5 parameters, and the pointer - operands are now address-space qualified. - If you were creating these intrinsic calls and prototypes yourself (as opposed - to using Intrinsic::getDeclaration), you can use - UpgradeIntrinsicFunction/UpgradeIntrinsicCall to be portable across releases. -</li> -<li> - SetCurrentDebugLocation takes a DebugLoc now instead of a MDNode. - Change your code to use - SetCurrentDebugLocation(DebugLoc::getFromDILocation(...)). -</li> -<li> - The <tt>RegisterPass</tt> and <tt>RegisterAnalysisGroup</tt> templates are - considered deprecated, but continue to function in LLVM 2.8. Clients are - strongly advised to use the upcoming <tt>INITIALIZE_PASS()</tt> and - <tt>INITIALIZE_AG_PASS()</tt> macros instead. -</li> -<li> - The constructor for the Triple class no longer tries to understand odd triple - specifications. Frontends should ensure that they only pass valid triples to - LLVM. The Triple::normalize utility method has been added to help front-ends - deal with funky triples. -</li> -<li> - The signature of the <tt>GCMetadataPrinter::finishAssembly</tt> virtual - function changed: the <tt>raw_ostream</tt> and <tt>MCAsmInfo</tt> arguments - were dropped. GC plugins which compute stack maps must be updated to avoid - having the old definition overload the new signature. -</li> -<li> - The signature of <tt>MemoryBuffer::getMemBuffer</tt> changed. Unfortunately - calls intended for the old version still compile, but will not work correctly, - leading to a confusing error about an invalid header in the bitcode. -</li> - -<li> - Some APIs were renamed: - <ul> - <li>llvm_report_error -> report_fatal_error</li> - <li>llvm_install_error_handler -> install_fatal_error_handler</li> - <li>llvm::DwarfExceptionHandling -> llvm::JITExceptionHandling</li> - <li>VISIBILITY_HIDDEN -> LLVM_LIBRARY_VISIBILITY</li> - </ul> -</li> +<li>The target triple x86_64--mingw64 is obsoleted. Use x86_64--mingw32 + instead.</li> -<li> - Some public headers were renamed: - <ul> - <li><tt>llvm/Assembly/AsmAnnotationWriter.h</tt> was renamed - to <tt>llvm/Assembly/AssemblyAnnotationWriter.h</tt> - </li> - </ul> +<li>The PointerTracking pass has been removed from mainline, and moved to The + ClamAV project (its only client).</li> + +<li>The LoopIndexSplit, LiveValues, SimplifyHalfPowrLibCalls, GEPSplitter, and + PartialSpecialization passes were removed. They were unmaintained, + buggy, or deemed to be a bad idea.</li> </ul> </div> <!--=========================================================================--> -<div class="doc_subsection"> -<a name="devtree_changes">Development Infrastructure Changes</a> -</div> +<h3> +<a name="api_changes">Internal API Changes</a> +</h3> -<div class="doc_text"> +<div> -<p>This section lists changes to the LLVM development infrastructure. This -mostly impacts users who actively work on LLVM or follow development on -mainline, but may also impact users who leverage the LLVM build infrastructure -or are interested in LLVM qualification.</p> +<p>In addition, many APIs have changed in this release. Some of the major + LLVM API changes are:</p> <ul> - <li>The default for <tt>make check</tt> is now to use - the <a href="http://llvm.org/cmds/lit.html">lit</a> testing tool, which is - part of LLVM itself. You can use <tt>lit</tt> directly as well, or use - the <tt>llvm-lit</tt> tool which is created as part of a Makefile or CMake - build (and knows how to find the appropriate tools). See the <tt>lit</tt> - documentation and the <a href="http://blog.llvm.org/2009/12/lit-it.html">blog - post</a>, and <a href="http://llvm.org/bugs/show_bug.cgi?id=5217">PR5217</a> - for more information.</li> - - <li>The LLVM <tt>test-suite</tt> infrastructure has a new "simple" test format - (<tt>make TEST=simple</tt>). The new format is intended to require only a - compiler and not a full set of LLVM tools. This makes it useful for testing - released compilers, for running the test suite with other compilers (for - performance comparisons), and makes sure that we are testing the compiler as - users would see it. The new format is also designed to work using reference - outputs instead of comparison to a baseline compiler, which makes it run much - faster and makes it less system dependent.</li> - - <li>Significant progress has been made on a new interface to running the - LLVM <tt>test-suite</tt> (aka the LLVM "nightly tests") using - the <a href="http://llvm.org/docs/lnt">LNT</a> infrastructure. The LNT - interface to the <tt>test-suite</tt> brings significantly improved reporting - capabilities for monitoring the correctness and generated code quality - produced by LLVM over time.</li> +<li>include/llvm/System merged into include/llvm/Support.</li> +<li>The <a href="http://llvm.org/PR5207">llvm::APInt API</a> was significantly + cleaned up.</li> + +<li>In the code generator, MVT::Flag was renamed to MVT::Glue to more accurately + describe its behavior.</li> + +<li>The system_error header from C++0x was added, and is now pervasively used to + capture and handle i/o and other errors in LLVM.</li> + +<li>The old sys::Path API has been deprecated in favor of the new PathV2 API, + which is more efficient and flexible.</li> </ul> </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="knownproblems">Known Problems</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <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"> +<h3> <a name="experimental">Experimental features included with this release</a> -</div> +</h3> -<div class="doc_text"> +<div> <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 @@ -1114,43 +841,54 @@ components, please contact us on the <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVMdev list</a>.</p> <ul> -<li>The Alpha, Blackfin, CellSPU, MicroBlaze, MSP430, MIPS, SystemZ +<li>The Alpha, Blackfin, CellSPU, MicroBlaze, MSP430, MIPS, PTX, SystemZ and XCore backends are experimental.</li> <li><tt>llc</tt> "<tt>-filetype=obj</tt>" is experimental on all targets - other than darwin-i386 and darwin-x86_64.</li> + other than darwin and ELF X86 systems.</li> + </ul> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="x86-be">Known problems with the X86 back-end</a> -</div> +</h3> -<div class="doc_text"> +<div> <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>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 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, front-ends support variadic argument constructs on X86-64 by lowering them manually.</li> + <li>Windows x64 (aka Win64) code generator has a few issues. + <ul> + <li>llvm-gcc cannot build the mingw-w64 runtime currently + due to lack of support for the 'u' inline assembly + constraint and for X87 floating point inline assembly.</li> + <li>On mingw-w64, you will see unresolved symbol <tt>__chkstk</tt> + due to <a href="http://llvm.org/bugs/show_bug.cgi?id=8919">Bug 8919</a>. + It is fixed in <a href="http://lists.cs.uiuc.edu/pipermail/llvm-commits/Week-of-Mon-20110321/118499.html">r128206</a>.</li> + <li>Miss-aligned MOVDQA might crash your program. It is due to + <a href="http://llvm.org/bugs/show_bug.cgi?id=9483">Bug 9483</a>, + lack of handling aligned internal globals.</li> + </ul> + </li> + </ul> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="ppc-be">Known problems with the PowerPC back-end</a> -</div> +</h3> -<div class="doc_text"> +<div> <ul> <li>The Linux PPC32/ABI support needs testing for the interpreter and static @@ -1160,11 +898,11 @@ compilation, and lacks support for debug information.</li> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="arm-be">Known problems with the ARM back-end</a> -</div> +</h3> -<div class="doc_text"> +<div> <ul> <li>Thumb mode works only on ARMv6 or higher processors. On sub-ARMv6 @@ -1177,11 +915,11 @@ results (<a href="http://llvm.org/PR1388">PR1388</a>).</li> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="sparc-be">Known problems with the SPARC back-end</a> -</div> +</h3> -<div class="doc_text"> +<div> <ul> <li>The SPARC backend only supports the 32-bit SPARC ABI (-m32); it does not @@ -1191,11 +929,11 @@ results (<a href="http://llvm.org/PR1388">PR1388</a>).</li> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="mips-be">Known problems with the MIPS back-end</a> -</div> +</h3> -<div class="doc_text"> +<div> <ul> <li>64-bit MIPS targets are not supported yet.</li> @@ -1204,11 +942,11 @@ results (<a href="http://llvm.org/PR1388">PR1388</a>).</li> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="alpha-be">Known problems with the Alpha back-end</a> -</div> +</h3> -<div class="doc_text"> +<div> <ul> @@ -1219,11 +957,11 @@ appropriate nops inserted to ensure restartability.</li> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="c-be">Known problems with the C back-end</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The C backend has numerous problems and is not being actively maintained. Depending on it for anything serious is not advised.</p> @@ -1242,11 +980,13 @@ Depending on it for anything serious is not advised.</p> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="llvm-gcc">Known problems with the llvm-gcc front-end</a> -</div> +</h3> -<div class="doc_text"> +<div> + +<p><b>LLVM 2.9 will be the last release of llvm-gcc.</b></p> <p>llvm-gcc is generally very stable for the C family of languages. The only major language feature of GCC not supported by llvm-gcc is the @@ -1267,16 +1007,18 @@ actively maintained. If you are interested in Ada, we recommend that you consider using <a href="#dragonegg">dragonegg</a> instead.</p> </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="additionalinfo">Additional Information</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <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/">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. @@ -1299,7 +1041,7 @@ lists</a>.</p> 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: 2010-10-26 14:43:36 +0200 (Tue, 26 Oct 2010) $ + Last modified: $Date: 2011-04-21 03:52:00 +0200 (Thu, 21 Apr 2011) $ </address> </body> diff --git a/docs/SourceLevelDebugging.html b/docs/SourceLevelDebugging.html index 186ea4abe732..4cfb52ee3a60 100644 --- a/docs/SourceLevelDebugging.html +++ b/docs/SourceLevelDebugging.html @@ -8,7 +8,7 @@ </head> <body> -<div class="doc_title">Source Level Debugging with LLVM</div> +<h1>Source Level Debugging with LLVM</h1> <table class="layout" style="width:100%"> <tr class="layout"> @@ -68,10 +68,10 @@ height="369"> <!-- *********************************************************************** --> -<div class="doc_section"><a name="introduction">Introduction</a></div> +<h2><a name="introduction">Introduction</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>This document is the central repository for all information pertaining to debug information in LLVM. It describes the <a href="#format">actual format @@ -80,14 +80,12 @@ height="369"> Further, this document provides specific examples of what debug information for C/C++ looks like.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="phil">Philosophy behind LLVM debugging information</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The idea of the LLVM debugging information is to capture how the important pieces of the source-language's Abstract Syntax Tree map onto LLVM code. @@ -133,11 +131,11 @@ height="369"> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="consumers">Debug information consumers</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The role of debug information is to provide meta information normally stripped away during the compilation process. This meta information provides @@ -157,11 +155,11 @@ height="369"> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="debugopt">Debugging optimized code</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>An extremely high priority of LLVM debugging information is to make it interact well with optimizations and analysis. In particular, the LLVM debug @@ -226,13 +224,15 @@ height="369"> </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="format">Debugging information format</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>LLVM debugging information has been carefully designed to make it possible for the optimizer to optimize the program and debugging information without @@ -265,14 +265,12 @@ height="369"> common to any source-language. The <a href="#ccxx_frontend">next section</a> describes the data layout conventions used by the C and C++ front-ends.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="debug_info_descriptors">Debug information descriptors</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>In consideration of the complexity and volume of debug information, LLVM provides a specification for well formed debug descriptors. </p> @@ -312,14 +310,12 @@ height="369"> <p>The details of the various descriptors follow.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsubsection"> +<h4> <a name="format_compile_units">Compile unit descriptors</a> -</div> +</h4> -<div class="doc_text"> +<div> <div class="doc_code"> <pre> @@ -351,11 +347,11 @@ height="369"> </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"> +<h4> <a name="format_files">File descriptors</a> -</div> +</h4> -<div class="doc_text"> +<div> <div class="doc_code"> <pre> @@ -380,11 +376,11 @@ height="369"> </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"> +<h4> <a name="format_global_variables">Global variable descriptors</a> -</div> +</h4> -<div class="doc_text"> +<div> <div class="doc_code"> <pre> @@ -407,16 +403,17 @@ height="369"> </div> <p>These descriptors provide debug information about globals variables. The -provide details such as name, type and where the variable is defined.</p> +provide details such as name, type and where the variable is defined. All +global variables are collected by named metadata <tt>!llvm.dbg.gv</tt>.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"> +<h4> <a name="format_subprograms">Subprogram descriptors</a> -</div> +</h4> -<div class="doc_text"> +<div> <div class="doc_code"> <pre> @@ -432,30 +429,35 @@ provide details such as name, type and where the variable is defined.</p> i32, ;; Line number where defined metadata, ;; Reference to type descriptor i1, ;; True if the global is local to compile unit (static) - i1 ;; True if the global is defined in the compile unit (not extern) - i32 ;; Virtuality, e.g. dwarf::DW_VIRTUALITY__virtual - i32 ;; Index into a virtual function + i1, ;; True if the global is defined in the compile unit (not extern) + i32, ;; Virtuality, e.g. dwarf::DW_VIRTUALITY__virtual + i32, ;; Index into a virtual function metadata, ;; indicates which base type contains the vtable pointer for the ;; derived class - i1 ;; isArtificial - i1 ;; isOptimized - Function *;; Pointer to LLVM function + i1, ;; isArtificial + i1, ;; isOptimized + Function *,;; Pointer to LLVM function + metadata, ;; Lists function template parameters + metadata ;; Function declaration descriptor } </pre> </div> <p>These descriptors provide debug information about functions, methods and subprograms. They provide details such as name, return types and the source - location where the subprogram is defined.</p> + location where the subprogram is defined. + All subprogram descriptors are collected by a named metadata + <tt>!llvm.dbg.sp</tt>. +</p> </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"> +<h4> <a name="format_blocks">Block descriptors</a> -</div> +</h4> -<div class="doc_text"> +<div> <div class="doc_code"> <pre> @@ -463,7 +465,9 @@ provide details such as name, type and where the variable is defined.</p> i32, ;; Tag = 11 + <a href="#LLVMDebugVersion">LLVMDebugVersion</a> (DW_TAG_lexical_block) metadata,;; Reference to context descriptor i32, ;; Line number - i32 ;; Column number + i32, ;; Column number + metadata,;; Reference to source file + i32 ;; Unique ID to identify blocks from a template function } </pre> </div> @@ -475,11 +479,11 @@ provide details such as name, type and where the variable is defined.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"> +<h4> <a name="format_basic_type">Basic type descriptors</a> -</div> +</h4> -<div class="doc_text"> +<div> <div class="doc_code"> <pre> @@ -527,11 +531,11 @@ DW_ATE_unsigned_char = 8 </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"> +<h4> <a name="format_derived_type">Derived type descriptors</a> -</div> +</h4> -<div class="doc_text"> +<div> <div class="doc_code"> <pre> @@ -544,7 +548,12 @@ DW_ATE_unsigned_char = 8 i64, ;; Size in bits i64, ;; Alignment in bits i64, ;; Offset in bits - metadata ;; Reference to type derived from + metadata, ;; Reference to type derived from + metadata, ;; (optional) Name of the Objective C property assoicated with + ;; Objective-C an ivar + metadata, ;; (optional) Name of the Objective C property getter selector. + metadata, ;; (optional) Name of the Objective C property setter selector. + i32 ;; (optional) Objective C property attributes. } </pre> </div> @@ -594,11 +603,11 @@ DW_TAG_restrict_type = 55 </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"> +<h4> <a name="format_composite_type">Composite type descriptors</a> -</div> +</h4> -<div class="doc_text"> +<div> <div class="doc_code"> <pre> @@ -644,7 +653,8 @@ DW_TAG_inheritance = 28 <p>The members of enumeration types (tag = <tt>DW_TAG_enumeration_type</tt>) are <a href="#format_enumeration">enumerator descriptors</a>, each representing - the definition of enumeration value for the set.</p> + the definition of enumeration value for the set. All enumeration type + descriptors are collected by named metadata <tt>!llvm.dbg.enum</tt>.</p> <p>The members of structure (tag = <tt>DW_TAG_structure_type</tt>) or union (tag = <tt>DW_TAG_union_type</tt>) types are any one of @@ -680,11 +690,11 @@ DW_TAG_inheritance = 28 </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"> +<h4> <a name="format_subrange">Subrange descriptors</a> -</div> +</h4> -<div class="doc_text"> +<div> <div class="doc_code"> <pre> @@ -700,16 +710,17 @@ DW_TAG_inheritance = 28 <a href="#format_composite_type">composite type</a>. The low value defines the lower bounds typically zero for C/C++. The high value is the upper bounds. Values are 64 bit. High - low + 1 is the size of the array. If low - == high the array will be unbounded.</p> + > high the array bounds are not included in generated debugging information. +</p> </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"> +<h4> <a name="format_enumeration">Enumerator descriptors</a> -</div> +</h4> -<div class="doc_text"> +<div> <div class="doc_code"> <pre> @@ -729,11 +740,11 @@ DW_TAG_inheritance = 28 </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"> +<h4> <a name="format_variables">Local variables</a> -</div> +</h4> -<div class="doc_text"> +<div> <div class="doc_code"> <pre> @@ -742,7 +753,8 @@ DW_TAG_inheritance = 28 metadata, ;; Context metadata, ;; Name metadata, ;; Reference to file where defined - i32, ;; Line number where defined + i32, ;; 24 bit - Line number where defined + ;; 8 bit - Argument number. 1 indicates 1st argument. metadata ;; Type descriptor } </pre> @@ -771,39 +783,39 @@ DW_TAG_return_variable = 258 </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="format_common_intrinsics">Debugger intrinsic functions</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>LLVM uses several intrinsic functions (name prefixed with "llvm.dbg") to provide debug information at various points in generated code.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsubsection"> +<h4> <a name="format_common_declare">llvm.dbg.declare</a> -</div> +</h4> -<div class="doc_text"> +<div> <pre> void %<a href="#format_common_declare">llvm.dbg.declare</a>(metadata, metadata) </pre> <p>This intrinsic provides information about a local element (ex. variable.) The - first argument is metadata holding alloca for the variable.</tt>. The + first argument is metadata holding alloca for the variable. The second argument is metadata containing description of the variable. </p> </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"> +<h4> <a name="format_common_value">llvm.dbg.value</a> -</div> +</h4> -<div class="doc_text"> +<div> <pre> void %<a href="#format_common_value">llvm.dbg.value</a>(metadata, i64, metadata) </pre> @@ -815,12 +827,14 @@ DW_TAG_return_variable = 258 user source variable. </p> </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="format_common_lifetime">Object lifetimes and scoping</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>In many languages, the local variables in functions can have their lifetimes or scopes limited to a subset of a function. In the C family of languages, for example, variables are only live (readable and writable) within the @@ -978,13 +992,15 @@ call void @llvm.dbg.declare(metadata, metadata !12), !dbg !14 </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="ccxx_frontend">C/C++ front-end specific debug information</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>The C and C++ front-ends represent information about the program in a format that is effectively identical @@ -1005,14 +1021,12 @@ call void @llvm.dbg.declare(metadata, metadata !12), !dbg !14 <p>The following sections provide examples of various C/C++ constructs and the debug information that would best describe those constructs.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="ccxx_compile_units">C/C++ source file information</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Given the source files <tt>MySource.cpp</tt> and <tt>MyHeader.h</tt> located in the directory <tt>/Users/mine/sources</tt>, the following code:</p> @@ -1086,11 +1100,11 @@ using <tt>Instruction::getMetadata()</tt> and </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="ccxx_global_variable">C/C++ global variable information</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Given an integer global variable declared as follows:</p> @@ -1156,11 +1170,11 @@ int MyGlobal = 100; </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="ccxx_subprogram">C/C++ function information</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Given a function declared as follows:</p> @@ -1192,7 +1206,14 @@ int main(int argc, char *argv[]) { i32 1, ;; Line number metadata !4, ;; Type i1 false, ;; Is local - i1 true ;; Is definition + i1 true, ;; Is definition + i32 0, ;; Virtuality attribute, e.g. pure virtual function + i32 0, ;; Index into virtual table for C++ methods + i32 0, ;; Type that holds virtual table. + i32 0, ;; Flags + i1 false, ;; True if this function is optimized + Function *, ;; Pointer to llvm::Function + null ;; Function template parameters } ;; ;; Define the subprogram itself. @@ -1206,22 +1227,20 @@ define i32 @main(i32 %argc, i8** %argv) { </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="ccxx_basic_types">C/C++ basic types</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The following are the basic type descriptors for C/C++ core types:</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsubsection"> +<h4> <a name="ccxx_basic_type_bool">bool</a> -</div> +</h4> -<div class="doc_text"> +<div> <div class="doc_code"> <pre> @@ -1243,11 +1262,11 @@ define i32 @main(i32 %argc, i8** %argv) { </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"> +<h4> <a name="ccxx_basic_char">char</a> -</div> +</h4> -<div class="doc_text"> +<div> <div class="doc_code"> <pre> @@ -1269,11 +1288,11 @@ define i32 @main(i32 %argc, i8** %argv) { </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"> +<h4> <a name="ccxx_basic_unsigned_char">unsigned char</a> -</div> +</h4> -<div class="doc_text"> +<div> <div class="doc_code"> <pre> @@ -1295,11 +1314,11 @@ define i32 @main(i32 %argc, i8** %argv) { </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"> +<h4> <a name="ccxx_basic_short">short</a> -</div> +</h4> -<div class="doc_text"> +<div> <div class="doc_code"> <pre> @@ -1321,11 +1340,11 @@ define i32 @main(i32 %argc, i8** %argv) { </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"> +<h4> <a name="ccxx_basic_unsigned_short">unsigned short</a> -</div> +</h4> -<div class="doc_text"> +<div> <div class="doc_code"> <pre> @@ -1347,11 +1366,11 @@ define i32 @main(i32 %argc, i8** %argv) { </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"> +<h4> <a name="ccxx_basic_int">int</a> -</div> +</h4> -<div class="doc_text"> +<div> <div class="doc_code"> <pre> @@ -1372,11 +1391,11 @@ define i32 @main(i32 %argc, i8** %argv) { </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"> +<h4> <a name="ccxx_basic_unsigned_int">unsigned int</a> -</div> +</h4> -<div class="doc_text"> +<div> <div class="doc_code"> <pre> @@ -1398,11 +1417,11 @@ define i32 @main(i32 %argc, i8** %argv) { </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"> +<h4> <a name="ccxx_basic_long_long">long long</a> -</div> +</h4> -<div class="doc_text"> +<div> <div class="doc_code"> <pre> @@ -1424,11 +1443,11 @@ define i32 @main(i32 %argc, i8** %argv) { </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"> +<h4> <a name="ccxx_basic_unsigned_long_long">unsigned long long</a> -</div> +</h4> -<div class="doc_text"> +<div> <div class="doc_code"> <pre> @@ -1450,11 +1469,11 @@ define i32 @main(i32 %argc, i8** %argv) { </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"> +<h4> <a name="ccxx_basic_float">float</a> -</div> +</h4> -<div class="doc_text"> +<div> <div class="doc_code"> <pre> @@ -1476,11 +1495,11 @@ define i32 @main(i32 %argc, i8** %argv) { </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"> +<h4> <a name="ccxx_basic_double">double</a> -</div> +</h4> -<div class="doc_text"> +<div> <div class="doc_code"> <pre> @@ -1501,12 +1520,14 @@ define i32 @main(i32 %argc, i8** %argv) { </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="ccxx_derived_types">C/C++ derived types</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Given the following as an example of C/C++ derived type:</p> @@ -1587,11 +1608,11 @@ typedef const int *IntPtr; </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="ccxx_composite_types">C/C++ struct/union types</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Given the following as an example of C/C++ struct type:</p> @@ -1700,11 +1721,11 @@ struct Color { </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="ccxx_enumeration_types">C/C++ enumeration types</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Given the following as an example of C/C++ enumeration type:</p> @@ -1765,6 +1786,8 @@ enum Trees { </div> +</div> + <!-- *********************************************************************** --> <hr> @@ -1775,8 +1798,8 @@ enum Trees { src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a> <a href="mailto:sabre@nondot.org">Chris Lattner</a><br> - <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br> - Last modified: $Date: 2011-02-03 01:22:17 +0100 (Thu, 03 Feb 2011) $ + <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br> + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> diff --git a/docs/SystemLibrary.html b/docs/SystemLibrary.html index b81b1a80d25d..57dc2391d535 100644 --- a/docs/SystemLibrary.html +++ b/docs/SystemLibrary.html @@ -7,7 +7,7 @@ </head> <body> -<div class="doc_title">System Library</div> +<h1>System Library</h1> <ul> <li><a href="#abstract">Abstract</a></li> <li><a href="#requirements">Keeping LLVM Portable</a> @@ -36,8 +36,8 @@ <!-- *********************************************************************** --> -<div class="doc_section"><a name="abstract">Abstract</a></div> -<div class="doc_text"> +<h2><a name="abstract">Abstract</a></h2> +<div> <p>This document provides some details on LLVM's System Library, located in the source at <tt>lib/System</tt> and <tt>include/llvm/System</tt>. The library's purpose is to shield LLVM from the differences between operating @@ -63,21 +63,19 @@ </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="requirements">Keeping LLVM Portable</a> -</div> -<div class="doc_text"> +</h2> +<div> <p>In order to keep LLVM portable, LLVM developers should adhere to a set of portability rules associated with the System Library. Adherence to these rules should help the System Library achieve its goal of shielding LLVM from the variations in operating system interfaces and doing so efficiently. The following sections define the rules needed to fulfill this objective.</p> -</div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="headers">Don't Include System Headers</a> -</div> -<div class="doc_text"> +<h3><a name="headers">Don't Include System Headers</a></h3> +<div> <p>Except in <tt>lib/System</tt>, no LLVM source code should directly <tt>#include</tt> a system header. Care has been taken to remove all such <tt>#includes</tt> from LLVM while <tt>lib/System</tt> was being @@ -91,9 +89,8 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="expose">Don't Expose System Headers</a> -</div> -<div class="doc_text"> +<h3><a name="expose">Don't Expose System Headers</a></h3> +<div> <p>The System Library must shield LLVM from <em>all</em> system headers. To obtain system level functionality, LLVM source must <tt>#include "llvm/System/Thing.h"</tt> and nothing else. This means that @@ -103,8 +100,8 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="c_headers">Use Standard C Headers</a></div> -<div class="doc_text"> +<h3><a name="c_headers">Use Standard C Headers</a></h3> +<div> <p>The <em>standard</em> C headers (the ones beginning with "c") are allowed to be exposed through the <tt>lib/System</tt> interface. These headers and the things they declare are considered to be platform agnostic. LLVM source @@ -113,9 +110,8 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="cpp_headers">Use Standard C++ Headers</a> -</div> -<div class="doc_text"> +<h3><a name="cpp_headers">Use Standard C++ Headers</a></h3> +<div> <p>The <em>standard</em> C++ headers from the standard C++ library and standard template library may be exposed through the <tt>lib/System</tt> interface. These headers and the things they declare are considered to be @@ -124,8 +120,8 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="highlev">High Level Interface</a></div> -<div class="doc_text"> +<h3><a name="highlev">High Level Interface</a></h3> +<div> <p>The entry points specified in the interface of lib/System must be aimed at completing some reasonably high level task needed by LLVM. We do not want to simply wrap each operating system call. It would be preferable to wrap several @@ -143,8 +139,8 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="nounused">No Unused Functionality</a></div> -<div class="doc_text"> +<h3><a name="nounused">No Unused Functionality</a></h3> +<div> <p>There must be no functionality specified in the interface of lib/System that isn't actually used by LLVM. We're not writing a general purpose operating system wrapper here, just enough to satisfy LLVM's needs. And, LLVM @@ -153,9 +149,8 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="nodupl">No Duplicate Implementations</a> -</div> -<div class="doc_text"> +<h3><a name="nodupl">No Duplicate Implementations</a></h3> +<div> <p>The implementation of a function for a given platform must be written exactly once. This implies that it must be possible to apply a function's implementation to multiple operating systems if those operating systems can @@ -165,8 +160,8 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="virtuals">No Virtual Methods</a></div> -<div class="doc_text"> +<h3><a name="virtuals">No Virtual Methods</a></h3> +<div> <p>The System Library interfaces can be called quite frequently by LLVM. In order to make those calls as efficient as possible, we discourage the use of virtual methods. There is no need to use inheritance for implementation @@ -175,8 +170,8 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="nofunc">No Exposed Functions</a></div> -<div class="doc_text"> +<h3><a name="nofunc">No Exposed Functions</a></h3> +<div> <p>Any functions defined by system libraries (i.e. not defined by lib/System) must not be exposed through the lib/System interface, even if the header file for that function is not exposed. This prevents inadvertent use of system @@ -191,8 +186,8 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="nodata">No Exposed Data</a></div> -<div class="doc_text"> +<h3><a name="nodata">No Exposed Data</a></h3> +<div> <p>Any data defined by system libraries (i.e. not defined by lib/System) must not be exposed through the lib/System interface, even if the header file for that function is not exposed. As with functions, this prevents inadvertent use @@ -200,8 +195,8 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="softerrors">Minimize Soft Errors</a></div> -<div class="doc_text"> +<h3><a name="softerrors">Minimize Soft Errors</a></h3> +<div> <p>Operating system interfaces will generally provide error results for every little thing that could go wrong. In almost all cases, you can divide these error results into two groups: normal/good/soft and abnormal/bad/hard. That @@ -239,9 +234,8 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="throw_spec">No throw Specifications</a> -</div> -<div class="doc_text"> +<h3><a name="throw_spec">No throw Specifications</a></h3> +<div> <p>None of the lib/System interface functions may be declared with C++ <tt>throw()</tt> specifications on them. This requirement makes sure that the compiler does not insert additional exception handling code into the interface @@ -252,8 +246,8 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="organization">Code Organization</a></div> -<div class="doc_text"> +<h3><a name="organization">Code Organization</a></h3> +<div> <p>Implementations of the System Library interface are separated by their general class of operating system. Currently only Unix and Win32 classes are defined but more could be added for other operating system classifications. @@ -281,8 +275,8 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="semantics">Consistent Semantics</a></div> -<div class="doc_text"> +<h3><a name="semantics">Consistent Semantics</a></h3> +<div> <p>The implementation of a lib/System interface can vary drastically between platforms. That's okay as long as the end result of the interface function is the same. For example, a function to create a directory is pretty straight @@ -296,12 +290,14 @@ </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="bug">Bug 351</a></div> -<div class="doc_text"> +<h3><a name="bug">Bug 351</a></h3> +<div> <p>See <a href="http://llvm.org/PR351">bug 351</a> for further details on the progress of this work</p> </div> +</div> + <!-- *********************************************************************** --> <hr> @@ -312,8 +308,8 @@ src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a> <a href="mailto:rspencer@x10sys.com">Reid Spencer</a><br> - <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br> - Last modified: $Date: 2010-05-07 02:28:04 +0200 (Fri, 07 May 2010) $ + <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br> + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> </html> diff --git a/docs/TableGenFundamentals.html b/docs/TableGenFundamentals.html index d118332c9939..37ca04621a34 100644 --- a/docs/TableGenFundamentals.html +++ b/docs/TableGenFundamentals.html @@ -7,9 +7,9 @@ </head> <body> -<div class="doc_title">TableGen Fundamentals</div> +<h1>TableGen Fundamentals</h1> -<div class="doc_text"> +<div> <ul> <li><a href="#introduction">Introduction</a> <ol> @@ -50,10 +50,10 @@ </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="introduction">Introduction</a></div> +<h2><a name="introduction">Introduction</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>TableGen's purpose is to help a human develop and maintain records of domain-specific information. Because there may be a large number of these @@ -72,12 +72,10 @@ find an emacs "TableGen mode" and a vim language file in the <tt>llvm/utils/emacs</tt> and <tt>llvm/utils/vim</tt> directories of your LLVM distribution, respectively.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"><a name="concepts">Basic concepts</a></div> +<h3><a name="concepts">Basic concepts</a></h3> -<div class="doc_text"> +<div> <p>TableGen files consist of two key parts: 'classes' and 'definitions', both of which are considered 'records'.</p> @@ -112,9 +110,9 @@ multiclass, as if they were declared in the current multiclass.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="example">An example record</a></div> +<h3><a name="example">An example record</a></h3> -<div class="doc_text"> +<div> <p>With no other arguments, TableGen parses the specified file and prints out all of the classes, then all of the definitions. This is a good way to see what @@ -212,9 +210,9 @@ abstractions they prefer to use when describing their information.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="running">Running TableGen</a></div> +<h3><a name="running">Running TableGen</a></h3> -<div class="doc_text"> +<div> <p>TableGen runs just like any other LLVM tool. The first (optional) argument specifies the file to read. If a filename is not specified, <tt>tblgen</tt> @@ -256,27 +254,28 @@ what you need and formats it in the appropriate way.</p> </div> +</div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="syntax">TableGen syntax</a></div> +<h2><a name="syntax">TableGen syntax</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>TableGen doesn't care about the meaning of data (that is up to the backend to define), but it does care about syntax, and it enforces a simple type system. This section describes the syntax and the constructs allowed in a TableGen file. </p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"><a name="primitives">TableGen primitives</a></div> +<h3><a name="primitives">TableGen primitives</a></h3> + +<div> <!-- --------------------------------------------------------------------------> -<div class="doc_subsubsection"><a name="comments">TableGen comments</a></div> +<h4><a name="comments">TableGen comments</a></h4> -<div class="doc_text"> +<div> <p>TableGen supports BCPL style "<tt>//</tt>" comments, which run to the end of the line, and it also supports <b>nestable</b> "<tt>/* */</tt>" comments.</p> @@ -284,11 +283,11 @@ the line, and it also supports <b>nestable</b> "<tt>/* */</tt>" comments.</p> </div> <!-- --------------------------------------------------------------------------> -<div class="doc_subsubsection"> +<h4> <a name="types">The TableGen type system</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>TableGen files are strongly typed, in a simple (but complete) type-system. These types are used to perform automatic conversions, check for errors, and to @@ -344,11 +343,11 @@ needed.</p> </div> <!-- --------------------------------------------------------------------------> -<div class="doc_subsubsection"> +<h4> <a name="values">TableGen values and expressions</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>TableGen allows for a pretty reasonable number of different expression forms when building up values. These forms allow the TableGen file to be written in a @@ -433,12 +432,14 @@ to a "<tt>bits<4></tt>" value, for example.</p> </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="classesdefs">Classes and definitions</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>As mentioned in the <a href="#concepts">intro</a>, classes and definitions (collectively known as 'records') in TableGen are the main high-level unit of @@ -473,14 +474,12 @@ between a group of records and isolating it in a single place. Also, classes permit the specification of default values for their subclasses, allowing the subclasses to override them as they wish.</p> -</div> - <!----------------------------------------------------------------------------> -<div class="doc_subsubsection"> +<h4> <a name="valuedef">Value definitions</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>Value definitions define named entries in records. A value must be defined before it can be referred to as the operand for another value definition or @@ -492,11 +491,11 @@ equal sign. Value definitions require terminating semicolons.</p> </div> <!-- --------------------------------------------------------------------------> -<div class="doc_subsubsection"> +<h4> <a name="recordlet">'let' expressions</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>A record-level let expression is used to change the value of a value definition in a record. This is primarily useful when a superclass defines a @@ -519,11 +518,11 @@ because the <tt>D</tt> class overrode its value.</p> </div> <!-- --------------------------------------------------------------------------> -<div class="doc_subsubsection"> +<h4> <a name="templateargs">Class template arguments</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>TableGen permits the definition of parameterized classes as well as normal concrete classes. Parameterized TableGen classes specify a list of variable @@ -610,11 +609,11 @@ X86 backend.</p> </div> <!-- --------------------------------------------------------------------------> -<div class="doc_subsubsection"> +<h4> <a name="multiclass">Multiclass definitions and instances</a> -</div> +</h4> -<div class="doc_text"> +<div> <p> While classes with template arguments are a good way to factor commonality @@ -772,17 +771,21 @@ before them. </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="filescope">File scope entities</a> -</div> +</h3> + +<div> <!-- --------------------------------------------------------------------------> -<div class="doc_subsubsection"> +<h4> <a name="include">File inclusion</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>TableGen supports the '<tt>include</tt>' token, which textually substitutes the specified file in place of the include directive. The filename should be specified as a double quoted string immediately after the '<tt>include</tt>' @@ -797,11 +800,11 @@ keyword. Example:</p> </div> <!-- --------------------------------------------------------------------------> -<div class="doc_subsubsection"> +<h4> <a name="globallet">'let' expressions</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>"Let" expressions at file scope are similar to <a href="#recordlet">"let" expressions within a record</a>, except they can specify a value binding for @@ -864,11 +867,15 @@ several levels of multiclass instanciations. This also avoids the need of using </pre> </div> +</div> + +</div> + <!-- *********************************************************************** --> -<div class="doc_section"><a name="codegen">Code Generator backend info</a></div> +<h2><a name="codegen">Code Generator backend info</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Expressions used by code generator to describe instructions and isel patterns:</p> @@ -882,10 +889,10 @@ patterns:</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="backends">TableGen backends</a></div> +<h2><a name="backends">TableGen backends</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>TODO: How they work, how to write one. This section should not contain details about any particular backend, except maybe -print-enums as an example. @@ -903,8 +910,8 @@ This should highlight the APIs in <tt>TableGen/Record.h</tt>.</p> src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a> <a href="mailto:sabre@nondot.org">Chris Lattner</a><br> - <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br> - Last modified: $Date: 2011-01-07 18:05:37 +0100 (Fri, 07 Jan 2011) $ + <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br> + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> diff --git a/docs/TestingGuide.html b/docs/TestingGuide.html index 964bdc31247d..4fc4c70011ab 100644 --- a/docs/TestingGuide.html +++ b/docs/TestingGuide.html @@ -7,9 +7,9 @@ </head> <body> -<div class="doc_title"> +<h1> LLVM Testing Infrastructure Guide -</div> +</h1> <ol> <li><a href="#overview">Overview</a></li> @@ -52,10 +52,10 @@ </div> <!--=========================================================================--> -<div class="doc_section"><a name="overview">Overview</a></div> +<h2><a name="overview">Overview</a></h2> <!--=========================================================================--> -<div class="doc_text"> +<div> <p>This document is the reference manual for the LLVM testing infrastructure. It documents the structure of the LLVM testing infrastructure, the tools needed to @@ -64,10 +64,10 @@ use it, and how to add and run tests.</p> </div> <!--=========================================================================--> -<div class="doc_section"><a name="requirements">Requirements</a></div> +<h2><a name="requirements">Requirements</a></h2> <!--=========================================================================--> -<div class="doc_text"> +<div> <p>In order to use the LLVM testing infrastructure, you will need all of the software required to build LLVM, as well @@ -76,10 +76,10 @@ as <a href="http://python.org">Python</a> 2.4 or later.</p> </div> <!--=========================================================================--> -<div class="doc_section"><a name="org">LLVM testing infrastructure organization</a></div> +<h2><a name="org">LLVM testing infrastructure organization</a></h2> <!--=========================================================================--> -<div class="doc_text"> +<div> <p>The LLVM testing infrastructure contains two major categories of tests: regression tests and whole programs. The regression tests are contained inside @@ -89,13 +89,11 @@ referred to as the "LLVM test suite" and are in the <tt>test-suite</tt> module in subversion. </p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsection"><a name="regressiontests">Regression tests</a></div> +<h3><a name="regressiontests">Regression tests</a></h3> <!-- _______________________________________________________________________ --> -<div class="doc_text"> +<div> <p>The regression tests 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 @@ -119,10 +117,10 @@ application or benchmark.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsection"><a name="testsuite">Test suite</a></div> +<h3><a name="testsuite">Test suite</a></h3> <!-- _______________________________________________________________________ --> -<div class="doc_text"> +<div> <p>The test suite contains whole programs, which are pieces of code which can be compiled and linked into a stand-alone program that can be @@ -144,11 +142,10 @@ generates code.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsection"><a name="debuginfotests">Debugging Information -tests</a></div> +<h3><a name="debuginfotests">Debugging Information tests</a></h3> <!-- _______________________________________________________________________ --> -<div class="doc_text"> +<div> <p>The test suite contains tests to check quality of debugging information. The test are written in C based languages or in LLVM assembly language. </p> @@ -160,11 +157,13 @@ test suite for more information . This test suite is located in the </div> +</div> + <!--=========================================================================--> -<div class="doc_section"><a name="quick">Quick start</a></div> +<h2><a name="quick">Quick start</a></h2> <!--=========================================================================--> -<div class="doc_text"> +<div> <p>The tests are located in two separate Subversion modules. The regressions tests are in the main "llvm" module under the directory @@ -179,7 +178,8 @@ the <tt>test-suite</tt> directory will be automatically configured. Alternatively, you can configure the <tt>test-suite</tt> module manually.</p> <!-- _______________________________________________________________________ --> -<div class="doc_subsection"><a name="quickregressiontests">Regression tests</a></div> +<h3><a name="quickregressiontests">Regression tests</a></h3> +<div> <!-- _______________________________________________________________________ --> <p>To run all of the LLVM regression tests, use master Makefile in the <tt>llvm/test</tt> directory:</p> @@ -198,7 +198,7 @@ Alternatively, you can configure the <tt>test-suite</tt> module manually.</p> </pre> </div> -<p>If you have <a href="http://clang.llvm.org">Clang</a> checked out and built, +<p>If you have <a href="http://clang.llvm.org/">Clang</a> checked out and built, you can run the LLVM and Clang tests simultaneously using:</p> <p>or</p> @@ -239,10 +239,14 @@ script which is built as part of LLVM. For example, to run the <p>For more information on using the 'lit' tool, see 'llvm-lit --help' or the 'lit' man page.</p> +</div> + <!-- _______________________________________________________________________ --> -<div class="doc_subsection"><a name="quicktestsuite">Test suite</a></div> +<h3><a name="quicktestsuite">Test suite</a></h3> <!-- _______________________________________________________________________ --> +<div> + <p>To run the comprehensive test suite (tests that compile and execute whole programs), first checkout and setup the <tt>test-suite</tt> module:</p> @@ -292,9 +296,10 @@ that subdirectory.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsection"><a name="quickdebuginfotests">Debugging Information -tests</a></div> +<h3><a name="quickdebuginfotests">Debugging Information tests</a></h3> +<div> <!-- _______________________________________________________________________ --> +<div> <p> To run debugging information tests simply checkout the tests inside clang/test directory. </p> @@ -310,10 +315,14 @@ clang/test directory. </p> </div> +</div> + +</div> + <!--=========================================================================--> -<div class="doc_section"><a name="rtstructure">Regression test structure</a></div> +<h2><a name="rtstructure">Regression test structure</a></h2> <!--=========================================================================--> -<div class="doc_text"> +<div> <p>The LLVM regression tests are driven by 'lit' and are located in the <tt>llvm/test</tt> directory. @@ -335,12 +344,10 @@ clang/test directory. </p> <li><tt>Verifier</tt>: tests the IR verifier.</li> </ul> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsection"><a name="rtcustom">Writing new regression tests</a></div> +<h3><a name="rtcustom">Writing new regression tests</a></h3> <!-- _______________________________________________________________________ --> -<div class="doc_text"> +<div> <p>The regression test structure is very simple, but does require some information to be set. This information is gathered via <tt>configure</tt> and is written to a file, <tt>lit.site.cfg</tt> @@ -492,10 +499,10 @@ negatives).</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsection"><a name="FileCheck">The FileCheck utility</a></div> +<h3><a name="FileCheck">The FileCheck utility</a></h3> <!-- _______________________________________________________________________ --> -<div class="doc_text"> +<div> <p>A powerful feature of the RUN: lines is that it allows any arbitrary commands to be executed as part of the test harness. While standard (portable) unix @@ -561,13 +568,12 @@ is a "subl" in between those labels. If it existed somewhere else in the file, that would not count: "grep subl" matches if subl exists anywhere in the file.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"><a -name="FileCheck-check-prefix">The FileCheck -check-prefix option</a></div> +<h4> + <a name="FileCheck-check-prefix">The FileCheck -check-prefix option</a> +</h4> -<div class="doc_text"> +<div> <p>The FileCheck -check-prefix option allows multiple test configurations to be driven from one .ll file. This is useful in many circumstances, for example, @@ -598,10 +604,11 @@ both 32-bit and 64-bit code generation.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"><a -name="FileCheck-CHECK-NEXT">The "CHECK-NEXT:" directive</a></div> +<h4> + <a name="FileCheck-CHECK-NEXT">The "CHECK-NEXT:" directive</a> +</h4> -<div class="doc_text"> +<div> <p>Sometimes you want to match lines and would like to verify that matches happen on exactly consecutive lines with no other lines in between them. In @@ -638,10 +645,11 @@ directive in a file.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"><a -name="FileCheck-CHECK-NOT">The "CHECK-NOT:" directive</a></div> +<h4> + <a name="FileCheck-CHECK-NOT">The "CHECK-NOT:" directive</a> +</h4> -<div class="doc_text"> +<div> <p>The CHECK-NOT: directive is used to verify that a string doesn't occur between two matches (or the first match and the beginning of the file). For @@ -668,10 +676,11 @@ define i8 @coerce_offset0(i32 %V, i32* %P) { </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"><a -name="FileCheck-Matching">FileCheck Pattern Matching Syntax</a></div> +<h4> + <a name="FileCheck-Matching">FileCheck Pattern Matching Syntax</a> +</h4> -<div class="doc_text"> +<div> <p>The CHECK: and CHECK-NOT: directives both take a pattern to match. For most uses of FileCheck, fixed string matching is perfectly sufficient. For some @@ -700,10 +709,11 @@ braces explicitly from the input, you can use something ugly like </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"><a -name="FileCheck-Variables">FileCheck Variables</a></div> +<h4> + <a name="FileCheck-Variables">FileCheck Variables</a> +</h4> -<div class="doc_text"> +<div> <p>It is often useful to match a pattern and then verify that it occurs again later in the file. For codegen tests, this can be useful to allow any register, @@ -738,11 +748,12 @@ define two separate CHECK lines that match on the same line. </div> +</div> + <!-- _______________________________________________________________________ --> -<div class="doc_subsection"><a name="rtvars">Variables and -substitutions</a></div> +<h3><a name="rtvars">Variables and substitutions</a></h3> <!-- _______________________________________________________________________ --> -<div class="doc_text"> +<div> <p>With a RUN line there are a number of substitutions that are permitted. In general, any Tcl variable that is available in the <tt>substitute</tt> function (in <tt>test/lib/llvm.exp</tt>) can be substituted into a RUN line. @@ -835,9 +846,9 @@ substitutions</a></div> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsection"><a name="rtfeatures">Other Features</a></div> +<h3><a name="rtfeatures">Other Features</a></h3> <!-- _______________________________________________________________________ --> -<div class="doc_text"> +<div> <p>To make RUN line writing easier, there are several shell scripts located in the <tt>llvm/test/Scripts</tt> directory. This directory is in the PATH when running tests, so you can just call these scripts using their name. For @@ -892,12 +903,13 @@ substitutions</a></div> </div> +</div> + <!--=========================================================================--> -<div class="doc_section"><a name="testsuitestructure">Test suite -Structure</a></div> +<h2><a name="testsuitestructure">Test suite Structure</a></h2> <!--=========================================================================--> -<div class="doc_text"> +<div> <p>The <tt>test-suite</tt> module contains a number of programs that can be compiled with LLVM and executed. These programs are compiled using the native compiler @@ -962,10 +974,10 @@ will help you separate benign warnings from actual test failures.</p> </div> <!--=========================================================================--> -<div class="doc_section"><a name="testsuiterun">Running the test suite</a></div> +<h2><a name="testsuiterun">Running the test suite</a></h2> <!--=========================================================================--> -<div class="doc_text"> +<div> <p>First, all tests are executed within the LLVM object directory tree. They <i>are not</i> executed inside of the LLVM source tree. This is because the @@ -1020,14 +1032,13 @@ 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> +<h3> + <a name="testsuiteexternal">Configuring External Tests</a> +</h3> <!-- _______________________________________________________________________ --> -<div class="doc_text"> +<div> <p>In order to run the External tests in the <tt>test-suite</tt> module, you must specify <i>--with-externals</i>. This must be done during the <em>re-configuration</em> step (see above), @@ -1055,10 +1066,11 @@ the test code or configure script changes).</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsection"> -<a name="testsuitetests">Running different tests</a></div> +<h3> + <a name="testsuitetests">Running different tests</a> +</h3> <!-- _______________________________________________________________________ --> -<div class="doc_text"> +<div> <p>In addition to the regular "whole program" tests, the <tt>test-suite</tt> module also provides a mechanism for compiling the programs in different ways. If the variable TEST is defined on the <tt>gmake</tt> command line, the test system will @@ -1078,10 +1090,11 @@ LLVM.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsection"> -<a name="testsuiteoutput">Generating test output</a></div> +<h3> + <a name="testsuiteoutput">Generating test output</a> +</h3> <!-- _______________________________________________________________________ --> -<div class="doc_text"> +<div> <p>There are a number of ways to run the tests and generate output. The most simple one is simply running <tt>gmake</tt> with no arguments. This will compile and run all programs in the tree using a number of different methods @@ -1109,11 +1122,12 @@ LLVM.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsection"> -<a name="testsuitecustom">Writing custom tests for the test suite</a></div> +<h3> + <a name="testsuitecustom">Writing custom tests for the test suite</a> +</h3> <!-- _______________________________________________________________________ --> -<div class="doc_text"> +<div> <p>Assuming you can run the test suite, (e.g. "<tt>gmake TEST=nightly report</tt>" should work), it is really easy to run optimizations or code generator @@ -1179,6 +1193,8 @@ example reports that can do fancy stuff.</p> </div> +</div> + <!-- *********************************************************************** --> <hr> @@ -1189,8 +1205,8 @@ example reports that can do fancy stuff.</p> src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a> John T. Criswell, Daniel Dunbar, Reid Spencer, and Tanya Lattner<br> - <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br> - Last modified: $Date: 2011-02-15 10:23:02 +0100 (Tue, 15 Feb 2011) $ + <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br> + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> </html> diff --git a/docs/UsingLibraries.html b/docs/UsingLibraries.html index ea28dbec0cc4..2c1c69a69a5f 100644 --- a/docs/UsingLibraries.html +++ b/docs/UsingLibraries.html @@ -5,7 +5,7 @@ <link rel="stylesheet" href="llvm.css" type="text/css"> </head> <body> -<div class="doc_title">Using The LLVM Libraries</div> +<h1>Using The LLVM Libraries</h1> <ol> <li><a href="#abstract">Abstract</a></li> <li><a href="#introduction">Introduction</a></li> @@ -26,12 +26,12 @@ <p class="doc_warning">Warning: This document is out of date, for more information please see <a href="CommandGuide/html/llvm-config.html">llvm-config</a> or, - if you use CMake, <a href=CMake.html#embedding>the CMake LLVM + if you use CMake, <a href="CMake.html#embedding">the CMake LLVM guide</a>.</p> <!-- ======================================================================= --> -<div class="doc_section"><a name="abstract">Abstract</a></div> -<div class="doc_text"> +<h2><a name="abstract">Abstract</a></h2> +<div> <p>Amongst other things, LLVM is a toolkit for building compilers, linkers, runtime executives, virtual machines, and other program execution related tools. In addition to the LLVM tool set, the functionality of LLVM is @@ -45,8 +45,8 @@ </div> <!-- ======================================================================= --> -<div class="doc_section"> <a name="introduction">Introduction</a></div> -<div class="doc_text"> +<h2><a name="introduction">Introduction</a></h2> +<div> <p>If you're writing a compiler, virtual machine, or any other utility based on LLVM, you'll need to figure out which of the many libraries files you will need to link with to be successful. An understanding of the contents of these @@ -74,8 +74,8 @@ correct for your tool can sometimes be challenging. </div> <!-- ======================================================================= --> -<div class="doc_section"><a name="descriptions"></a>Library Descriptions</div> -<div class="doc_text"> +<h2><a name="descriptions">Library Descriptions</a></h2> +<div> <p>The table below categorizes each library <table style="text-align:left"> <tr><th>Library</th><th>Forms</th><th>Description</th></tr> @@ -152,8 +152,8 @@ </div> <!-- ======================================================================= --> -<div class="doc_section"><a name="dependencies"></a>Using llvm-config</div> -<div class="doc_text"> +<h2><a name="dependencies">Using llvm-config</a></h2> +<div> <p>The <tt>llvm-config</tt> tool is a perl script that produces on its output various kinds of information. For example, the source or object directories used to build LLVM can be accessed by passing options to <tt>llvm-config</tt>. @@ -187,16 +187,16 @@ <!-- === This should be updated whenever new libraries are added, ===--> <!-- === removed, or changed ===--> <!-- =======NOTE: =========================================================--> - <h2>Dependency Relationships Of Libraries</h2> + <h3>Dependency Relationships Of Libraries</h3> <p>This graph shows the dependency of archive libraries on other archive libraries or objects. Where a library has both archive and object forms, only the archive form is shown.</p> - <img src="img/libdeps.gif" alt="Library Dependencies"/> - <h2>Dependency Relationships Of Object Files</h2> + <img src="img/libdeps.gif" alt="Library Dependencies"> + <h3>Dependency Relationships Of Object Files</h3> <p>This graph shows the dependency of object files on archive libraries or other objects. Where a library has both object and archive forms, only the dependency to the archive form is shown.</p> - <img src="img/objdeps.gif" alt="Object File Dependencies"/> + <img src="img/objdeps.gif" alt="Object File Dependencies"> <p>The following list shows the dependency relationships between libraries in textual form. The information is the same as shown on the graphs but arranged alphabetically.</p> @@ -280,8 +280,8 @@ <li>libLLVMSystem.a</li> <li>libLLVMbzip2.a</li> </ul></dd> - <dt><b>libLLVMSystem.a</b></dt><dd><ul> - </ul></dd> + <dt><b>libLLVMSystem.a</b></dt><dd> + </dd> <dt><b>libLLVMTarget.a</b></dt><dd><ul> <li>libLLVMCore.a</li> <li>libLLVMSupport.a</li> @@ -295,8 +295,8 @@ <li>libLLVMTarget.a</li> <li>libLLVMipa.a</li> </ul></dd> - <dt><b>libLLVMbzip2.a</b></dt><dd><ul> - </ul></dd> + <dt><b>libLLVMbzip2.a</b></dt><dd> + </dd> <dt><b>libLLVMipa.a</b></dt><dd><ul> <li>libLLVMAnalysis.a</li> <li>libLLVMCore.a</li> @@ -401,42 +401,46 @@ </div> <!-- ======================================================================= --> -<div class="doc_section"><a name="rot">Linkage Rules Of Thumb</a></div> -<div class="doc_text"> +<h2><a name="rot">Linkage Rules Of Thumb</a></h2> +<div> <p>This section contains various "rules of thumb" about what files you should link into your programs.</p> -</div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="always">Always Link LLVMCore, LLVMSupport, - and LLVMSystem</a></div> -<div class="doc_text"> +<h3> + <a name="always">Always Link LLVMCore, LLVMSupport, and LLVMSystem</a> +</h3> +<div> <p>No matter what you do with LLVM, the last three entries in the value of your LLVMLIBS make variable should always be: <tt>LLVMCore LLVMSupport.a LLVMSystem.a</tt>. There are no <tt>LLVM</tt> programs that don't depend on these three.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"><a name="onlyone">Never link both archive and - re-linked library</a></div> -<div class="doc_text"> +<h3> + <a name="onlyone">Never link both archive and re-linked library</a> +</h3> +<div> <p>There is never any point to linking both the re-linked (<tt>.o</tt>) and the archive (<tt>.a</tt>) versions of a library. Since the re-linked version includes the entire library, the archive version will not resolve any symbols. You could even end up with link error if you place the archive version before the re-linked version on the linker's command line.</p> </div> + +</div> + <!-- ======================================================================= --> <hr> <div class="doc_footer"> <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> + 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="mailto:rspencer@x10sys.com">Reid Spencer</a> </address> -<a href="http://llvm.org">The LLVM Compiler Infrastructure</a> -<br>Last modified: $Date: 2010-09-17 02:30:52 +0200 (Fri, 17 Sep 2010) $ </div> +<a href="http://llvm.org/">The LLVM Compiler Infrastructure</a> +<br>Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </div> </body> </html> <!-- vim: sw=2 ts=2 ai diff --git a/docs/WritingAnLLVMBackend.html b/docs/WritingAnLLVMBackend.html index 193a1d4d68c9..c4892cbd8924 100644 --- a/docs/WritingAnLLVMBackend.html +++ b/docs/WritingAnLLVMBackend.html @@ -9,9 +9,9 @@ <body> -<div class="doc_title"> +<h1> Writing an LLVM Compiler Backend -</div> +</h1> <ol> <li><a href="#intro">Introduction</a> @@ -61,12 +61,12 @@ </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="intro">Introduction</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> This document describes techniques for writing compiler backends that convert @@ -91,13 +91,11 @@ characteristics, such as a RISC instruction set and straightforward calling conventions. </p> -</div> - -<div class="doc_subsection"> +<h3> <a name="Audience">Audience</a> -</div> +</h3> -<div class="doc_text"> +<div> <p> The audience for this document is anyone who needs to write an LLVM backend to @@ -106,21 +104,21 @@ generate code for a specific hardware or software target. </div> -<div class="doc_subsection"> +<h3> <a name="Prerequisite">Prerequisite Reading</a> -</div> +</h3> -<div class="doc_text"> +<div> <p> These essential documents must be read before reading this document: </p> <ul> -<li><i><a href="http://www.llvm.org/docs/LangRef.html">LLVM Language Reference +<li><i><a href="LangRef.html">LLVM Language Reference Manual</a></i> — a reference manual for the LLVM assembly language.</li> -<li><i><a href="http://www.llvm.org/docs/CodeGenerator.html">The LLVM +<li><i><a href="CodeGenerator.html">The LLVM Target-Independent Code Generator</a></i> — a guide to the components (classes and code generation algorithms) for translating the LLVM internal representation into machine code for a specified target. Pay particular @@ -129,14 +127,14 @@ These essential documents must be read before reading this document: Allocation, Prolog/Epilog Code Insertion, Late Machine Code Optimizations, and Code Emission.</li> -<li><i><a href="http://www.llvm.org/docs/TableGenFundamentals.html">TableGen +<li><i><a href="TableGenFundamentals.html">TableGen Fundamentals</a></i> —a document that describes the TableGen (<tt>tblgen</tt>) application that manages domain-specific information to support LLVM code generation. TableGen processes input from a target description file (<tt>.td</tt> suffix) and generates C++ code that can be used for code generation.</li> -<li><i><a href="http://www.llvm.org/docs/WritingAnLLVMPass.html">Writing an LLVM +<li><i><a href="WritingAnLLVMPass.html">Writing an LLVM Pass</a></i> — The assembly printer is a <tt>FunctionPass</tt>, as are several SelectionDAG processing steps.</li> </ul> @@ -155,11 +153,11 @@ machine dependent features. </div> -<div class="doc_subsection"> +<h3> <a name="Basic">Basic Steps</a> -</div> +</h3> -<div class="doc_text"> +<div> <p> To write a compiler backend for LLVM that converts the LLVM IR to code for a @@ -220,17 +218,17 @@ that the class will need and which components will need to be subclassed. </div> -<div class="doc_subsection"> +<h3> <a name="Preliminaries">Preliminaries</a> -</div> +</h3> -<div class="doc_text"> +<div> <p> To actually create your compiler backend, you need to create and modify a few files. The absolute minimum is discussed here. But to actually use the LLVM target-independent code generator, you must perform the steps described in -the <a href="http://www.llvm.org/docs/CodeGenerator.html">LLVM +the <a href="CodeGenerator.html">LLVM Target-Independent Code Generator</a> document. </p> @@ -281,13 +279,15 @@ regenerate configure by running <tt>./autoconf/AutoRegen.sh</tt>. </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="TargetMachine">Target Machine</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> <tt>LLVMTargetMachine</tt> is designed as a base class for targets implemented @@ -360,11 +360,6 @@ public: </pre> </div> -</div> - - -<div class="doc_text"> - <ul> <li><tt>getInstrInfo()</tt></li> <li><tt>getRegisterInfo()</tt></li> @@ -398,10 +393,6 @@ SparcTargetMachine::SparcTargetMachine(const Module &M, const std::string &a </pre> </div> -</div> - -<div class="doc_text"> - <p>Hyphens separate portions of the <tt>TargetDescription</tt> string.</p> <ul> @@ -424,12 +415,12 @@ SparcTargetMachine::SparcTargetMachine(const Module &M, const std::string &a </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="TargetRegistration">Target Registration</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> You must also register your target with the <tt>TargetRegistry</tt>, which is @@ -480,12 +471,12 @@ For more information, see </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="RegisterSet">Register Set and Register Classes</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> You should describe a concrete target-specific class that represents the @@ -514,14 +505,12 @@ input files and placed in <tt>XXXGenRegisterInfo.h.inc</tt> and implementation of <tt>XXXRegisterInfo</tt> requires hand-coding. </p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="RegisterDef">Defining a Register</a> -</div> +</h3> -<div class="doc_text"> +<div> <p> The <tt>XXXRegisterInfo.td</tt> file typically starts with register definitions @@ -700,11 +689,11 @@ fields of a register's TargetRegisterDesc. </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="RegisterClassDef">Defining a Register Class</a> -</div> +</h3> -<div class="doc_text"> +<div> <p> The <tt>RegisterClass</tt> class (specified in <tt>Target.td</tt>) is used to @@ -894,12 +883,12 @@ namespace SP { // Register class instances </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="implementRegister">Implement a subclass of</a> - <a href="http://www.llvm.org/docs/CodeGenerator.html#targetregisterinfo">TargetRegisterInfo</a> -</div> + <a href="CodeGenerator.html#targetregisterinfo">TargetRegisterInfo</a> +</h3> -<div class="doc_text"> +<div> <p> The final step is to hand code portions of <tt>XXXRegisterInfo</tt>, which @@ -933,13 +922,15 @@ implementation in <tt>SparcRegisterInfo.cpp</tt>: </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="InstructionSet">Instruction Set</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> During the early stages of code generation, the LLVM IR code is converted to a @@ -1103,7 +1094,7 @@ The fifth parameter is a string that is used by the assembly printer and can be left as an empty string until the assembly printer interface is implemented. The sixth and final parameter is the pattern used to match the instruction during the SelectionDAG Select Phase described in -(<a href="http://www.llvm.org/docs/CodeGenerator.html">The LLVM +(<a href="CodeGenerator.html">The LLVM Target-Independent Code Generator</a>). This parameter is detailed in the next section, <a href="#InstructionSelector">Instruction Selector</a>. </p> @@ -1188,14 +1179,12 @@ correspond to the values in <tt>SparcInstrInfo.td</tt>. I.e., <tt>SPCC::ICC_NE = 9</tt>, <tt>SPCC::FCC_U = 23</tt> and so on.) </p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="operandMapping">Instruction Operand Mapping</a> -</div> +</h3> -<div class="doc_text"> +<div> <p> The code generator backend maps instruction operands to fields in the @@ -1283,12 +1272,12 @@ the <tt>rd</tt>, <tt>rs1</tt>, and <tt>rs2</tt> fields respectively. </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="implementInstr">Implement a subclass of </a> - <a href="http://www.llvm.org/docs/CodeGenerator.html#targetinstrinfo">TargetInstrInfo</a> -</div> + <a href="CodeGenerator.html#targetinstrinfo">TargetInstrInfo</a> +</h3> -<div class="doc_text"> +<div> <p> The final step is to hand code portions of <tt>XXXInstrInfo</tt>, which @@ -1327,10 +1316,10 @@ implementation in <tt>SparcInstrInfo.cpp</tt>: </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="branchFolding">Branch Folding and If Conversion</a> -</div> -<div class="doc_text"> +</h3> +<div> <p> Performance can be improved by combining instructions or by eliminating @@ -1485,13 +1474,15 @@ branch. </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="InstructionSelector">Instruction Selector</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> LLVM uses a <tt>SelectionDAG</tt> to represent LLVM IR instructions, and nodes @@ -1533,7 +1524,7 @@ selection pass into the queue of passes to run. The LLVM static compiler (<tt>llc</tt>) is an excellent tool for visualizing the contents of DAGs. To display the <tt>SelectionDAG</tt> before or after specific processing phases, use the command line options for <tt>llc</tt>, described -at <a href="http://llvm.org/docs/CodeGenerator.html#selectiondag_process"> +at <a href="CodeGenerator.html#selectiondag_process"> SelectionDAG Instruction Selection Process</a>. </p> @@ -1642,14 +1633,12 @@ SDNode *Select_ISD_STORE(const SDValue &N) { </pre> </div> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="LegalizePhase">The SelectionDAG Legalize Phase</a> -</div> +</h3> -<div class="doc_text"> +<div> <p> The Legalize phase converts a DAG to use types and operations that are natively @@ -1716,14 +1705,12 @@ a <tt>LegalAction</tt> type enum value: <tt>Promote</tt>, <tt>Expand</tt>, contains examples of all four <tt>LegalAction</tt> values. </p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="promote">Promote</a> -</div> +</h4> -<div class="doc_text"> +<div> <p> For an operation without native support for a given type, the specified type may @@ -1742,11 +1729,11 @@ setLoadExtAction(ISD::SEXTLOAD, MVT::i1, Promote); </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="expand">Expand</a> -</div> +</h4> -<div class="doc_text"> +<div> <p> For a type without native support, a value may need to be broken down further, @@ -1767,11 +1754,11 @@ setOperationAction(ISD::FCOS, MVT::f32, Expand); </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="custom">Custom</a> -</div> +</h4> -<div class="doc_text"> +<div> <p> For some operations, simple type promotion or operation expansion may be @@ -1833,11 +1820,11 @@ static SDValue LowerFP_TO_SINT(SDValue Op, SelectionDAG &DAG) { </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="legal">Legal</a> -</div> +</h4> -<div class="doc_text"> +<div> <p> The <tt>Legal</tt> LegalizeAction enum value simply indicates that an @@ -1865,12 +1852,14 @@ if (TM.getSubtarget<SparcSubtarget>().isV9()) </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="callingConventions">Calling Conventions</a> -</div> +</h3> -<div class="doc_text"> +<div> <p> To support target-specific calling conventions, <tt>XXXGenCallingConv.td</tt> @@ -2015,13 +2004,15 @@ def RetCC_X86_32 : CallingConv<[ </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="assemblyPrinter">Assembly Printer</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> During the code emission stage, the code generator may utilize an LLVM pass to @@ -2171,12 +2162,12 @@ output. </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="subtargetSupport">Subtarget Support</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> Subtarget support is used to inform the code generation process of instruction @@ -2289,12 +2280,12 @@ XXXSubtarget::XXXSubtarget(const Module &M, const std::string &FS) { </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="jitSupport">JIT Support</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> The implementation of a target machine optionally includes a Just-In-Time (JIT) @@ -2333,14 +2324,12 @@ Both <tt>XXXJITInfo.cpp</tt> and <tt>XXXCodeEmitter.cpp</tt> must include the that write data (in bytes, words, strings, etc.) to the output stream. </p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="mce">Machine Code Emitter</a> -</div> +</h3> -<div class="doc_text"> +<div> <p> In <tt>XXXCodeEmitter.cpp</tt>, a target-specific of the <tt>Emitter</tt> class @@ -2478,11 +2467,11 @@ enum RelocationType { </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="targetJITInfo">Target JIT Info</a> -</div> +</h3> -<div class="doc_text"> +<div> <p> <tt>XXXJITInfo.cpp</tt> implements the JIT interfaces for target-specific @@ -2537,6 +2526,8 @@ with assembler. </div> +</div> + <!-- *********************************************************************** --> <hr> @@ -2547,9 +2538,9 @@ with assembler. src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a> <a href="http://www.woo.com">Mason Woo</a> and <a href="http://misha.brukman.net">Misha Brukman</a><br> - <a href="http://llvm.org">The LLVM Compiler Infrastructure</a> + <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a> <br> - Last modified: $Date: 2010-11-23 04:31:01 +0100 (Tue, 23 Nov 2010) $ + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> diff --git a/docs/WritingAnLLVMPass.html b/docs/WritingAnLLVMPass.html index 80258e428352..75426e051d35 100644 --- a/docs/WritingAnLLVMPass.html +++ b/docs/WritingAnLLVMPass.html @@ -8,9 +8,9 @@ </head> <body> -<div class="doc_title"> +<h1> Writing an LLVM Pass -</div> +</h1> <ol> <li><a href="#introduction">Introduction - What is a pass?</a></li> @@ -121,12 +121,12 @@ </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="introduction">Introduction - What is a pass?</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>The LLVM Pass Framework is an important part of the LLVM system, because LLVM passes are where most of the interesting parts of the compiler exist. Passes @@ -156,12 +156,12 @@ more advanced features are discussed.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="quickstart">Quick Start - Writing hello world</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Here we describe how to write the "hello world" of passes. The "Hello" pass is designed to simply print out the name of non-external functions that exist in @@ -169,14 +169,12 @@ the program being compiled. It does not modify the program at all, it just inspects it. The source code and files for this pass are available in the LLVM source tree in the <tt>lib/Transforms/Hello</tt> directory.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="makefile">Setting up the build environment</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>First, configure and build LLVM. This needs to be done directly inside the LLVM source tree rather than in a separate objects directory. @@ -185,7 +183,7 @@ source tree in the <tt>lib/Transforms/Hello</tt> directory.</p> <tt>lib/Transforms/Hello</tt>. Finally, you must set up a build script (Makefile) that will compile the source code for the new pass. To do this, copy the following into <tt>Makefile</tt>:</p> - <hr/> + <hr> <div class="doc_code"><pre> # Makefile for hello pass @@ -211,17 +209,20 @@ the <tt>opt</tt> or <tt>bugpoint</tt> tools via their <tt>-load</tt> options. If your operating system uses a suffix other than .so (such as windows or Mac OS/X), the appropriate extension will be used.</p> +<p>If you are used CMake to build LLVM, see +<a href="CMake.html#passdev">Developing an LLVM pass with CMake</a>.</p> + <p>Now that we have the build scripts set up, we just need to write the code for the pass itself.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="basiccode">Basic code required</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Now that we have a way to compile our new pass, we just have to write it. Start out with:</p> @@ -301,7 +302,7 @@ function.</p> initialization value is not important.</p> <div class="doc_code"><pre> - static RegisterPass<Hello> X("<i>hello</i>", "<i>Hello World Pass</i>", + static RegisterPass<Hello> X("<i>hello</i>", "<i>Hello World Pass</i>", false /* Only looks at CFG */, false /* Analysis Pass */); } <i>// end of anonymous namespace</i> @@ -337,7 +338,7 @@ is supplied as fourth argument. </p> }; char Hello::ID = 0; - static RegisterPass<Hello> X("hello", "Hello World Pass", false, false); + static RegisterPass<Hello> X("hello", "Hello World Pass", false, false); } </pre></div> @@ -353,11 +354,11 @@ them) to be useful.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="running">Running a pass with <tt>opt</tt></a> -</div> +</h3> -<div class="doc_text"> +<div> <p>Now that you have a brand new shiny shared object file, we can use the <tt>opt</tt> command to run an LLVM program through your pass. Because you @@ -443,13 +444,15 @@ about some more details of how they work and how to use them.</p> </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="passtype">Pass classes and requirements</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>One of the first things that you should do when designing a new pass is to decide what class you should subclass for your pass. The <a @@ -464,14 +467,12 @@ listed. This gives the LLVM Pass Infrastructure information necessary to optimize how passes are run, so that the resultant compiler isn't unnecessarily slow.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="ImmutablePass">The <tt>ImmutablePass</tt> class</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The most plain and boring type of pass is the "<tt><a href="http://llvm.org/doxygen/classllvm_1_1ImmutablePass.html">ImmutablePass</a></tt>" @@ -490,11 +491,11 @@ invalidated, and are never "run".</p> </div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="ModulePass">The <tt>ModulePass</tt> class</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The "<tt><a href="http://llvm.org/doxygen/classllvm_1_1ModulePass.html">ModulePass</a></tt>" @@ -516,14 +517,12 @@ DominatorTree for function definitions, not declarations.</p> <tt>ModulePass</tt> and overload the <tt>runOnModule</tt> method with the following signature:</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="runOnModule">The <tt>runOnModule</tt> method</a> -</div> +</h4> -<div class="doc_text"> +<div> <div class="doc_code"><pre> <b>virtual bool</b> runOnModule(Module &M) = 0; @@ -535,12 +534,14 @@ false otherwise.</p> </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="CallGraphSCCPass">The <tt>CallGraphSCCPass</tt> class</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The "<tt><a href="http://llvm.org/doxygen/classllvm_1_1CallGraphSCCPass.html">CallGraphSCCPass</a></tt>" @@ -581,15 +582,14 @@ because it has to handle SCCs with more than one node in it. All of the virtual methods described below should return true if they modified the program, or false if they didn't.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> - <a name="doInitialization_scc">The <tt>doInitialization(CallGraph &)</tt> - method</a> -</div> +<h4> + <a name="doInitialization_scc"> + The <tt>doInitialization(CallGraph &)</tt> method + </a> +</h4> -<div class="doc_text"> +<div> <div class="doc_code"><pre> <b>virtual bool</b> doInitialization(CallGraph &CG); @@ -606,11 +606,11 @@ fast).</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="runOnSCC">The <tt>runOnSCC</tt> method</a> -</div> +</h4> -<div class="doc_text"> +<div> <div class="doc_code"><pre> <b>virtual bool</b> runOnSCC(CallGraphSCC &SCC) = 0; @@ -623,12 +623,13 @@ otherwise.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> - <a name="doFinalization_scc">The <tt>doFinalization(CallGraph - &)</tt> method</a> -</div> +<h4> + <a name="doFinalization_scc"> + The <tt>doFinalization(CallGraph &)</tt> method + </a> +</h4> -<div class="doc_text"> +<div> <div class="doc_code"><pre> <b>virtual bool</b> doFinalization(CallGraph &CG); @@ -641,12 +642,14 @@ program being compiled.</p> </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="FunctionPass">The <tt>FunctionPass</tt> class</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>In contrast to <tt>ModulePass</tt> subclasses, <tt><a href="http://llvm.org/doxygen/classllvm_1_1Pass.html">FunctionPass</a></tt> @@ -671,15 +674,14 @@ href="#basiccode">Hello World</a> pass for example). <tt>FunctionPass</tt>'s may overload three virtual methods to do their work. All of these methods should return true if they modified the program, or false if they didn't.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> - <a name="doInitialization_mod">The <tt>doInitialization(Module &)</tt> - method</a> -</div> +<h4> + <a name="doInitialization_mod"> + The <tt>doInitialization(Module &)</tt> method + </a> +</h4> -<div class="doc_text"> +<div> <div class="doc_code"><pre> <b>virtual bool</b> doInitialization(Module &M); @@ -703,11 +705,11 @@ free functions that it needs, adding prototypes to the module if necessary.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="runOnFunction">The <tt>runOnFunction</tt> method</a> -</div> +</h4> -<div class="doc_text"> +<div> <div class="doc_code"><pre> <b>virtual bool</b> runOnFunction(Function &F) = 0; @@ -720,12 +722,13 @@ be returned if the function is modified.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> - <a name="doFinalization_mod">The <tt>doFinalization(Module - &)</tt> method</a> -</div> +<h4> + <a name="doFinalization_mod"> + The <tt>doFinalization(Module &)</tt> method + </a> +</h4> -<div class="doc_text"> +<div> <div class="doc_code"><pre> <b>virtual bool</b> doFinalization(Module &M); @@ -738,12 +741,14 @@ program being compiled.</p> </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="LoopPass">The <tt>LoopPass</tt> class </a> -</div> +</h3> -<div class="doc_text"> +<div> <p> All <tt>LoopPass</tt> execute on each loop in the function independent of all of the other loops in the function. <tt>LoopPass</tt> processes loops in @@ -751,19 +756,18 @@ loop nest order such that outer most loop is processed last. </p> <p> <tt>LoopPass</tt> subclasses are allowed to update loop nest using <tt>LPPassManager</tt> interface. Implementing a loop pass is usually -straightforward. <tt>Looppass</tt>'s may overload three virtual methods to +straightforward. <tt>LoopPass</tt>'s may overload three virtual methods to do their work. All these methods should return true if they modified the program, or false if they didn't. </p> -</div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> - <a name="doInitialization_loop">The <tt>doInitialization(Loop *, - LPPassManager &)</tt> - method</a> -</div> +<h4> + <a name="doInitialization_loop"> + The <tt>doInitialization(Loop *,LPPassManager &)</tt> method + </a> +</h4> -<div class="doc_text"> +<div> <div class="doc_code"><pre> <b>virtual bool</b> doInitialization(Loop *, LPPassManager &LPM); @@ -780,11 +784,11 @@ information.</p> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="runOnLoop">The <tt>runOnLoop</tt> method</a> -</div> +</h4> -<div class="doc_text"> +<div> <div class="doc_code"><pre> <b>virtual bool</b> runOnLoop(Loop *, LPPassManager &LPM) = 0; @@ -798,11 +802,11 @@ should be used to update loop nest.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="doFinalization_loop">The <tt>doFinalization()</tt> method</a> -</div> +</h4> -<div class="doc_text"> +<div> <div class="doc_code"><pre> <b>virtual bool</b> doFinalization(); @@ -815,12 +819,14 @@ program being compiled. </p> </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="RegionPass">The <tt>RegionPass</tt> class </a> -</div> +</h3> -<div class="doc_text"> +<div> <p> <tt>RegionPass</tt> is similar to <a href="#LoopPass"><tt>LoopPass</tt></a>, but executes on each single entry single exit region in the function. @@ -829,19 +835,18 @@ region is processed last. </p> <p> <tt>RegionPass</tt> subclasses are allowed to update the region tree by using the <tt>RGPassManager</tt> interface. You may overload three virtual methods of -<tt>RegionPass</tt> to implementing your own region pass is usually. All these +<tt>RegionPass</tt> to implement your own region pass. All these methods should return true if they modified the program, or false if they didn not. </p> -</div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> - <a name="doInitialization_region">The <tt>doInitialization(Region *, - RGPassManager &)</tt> - method</a> -</div> +<h4> + <a name="doInitialization_region"> + The <tt>doInitialization(Region *, RGPassManager &)</tt> method + </a> +</h4> -<div class="doc_text"> +<div> <div class="doc_code"><pre> <b>virtual bool</b> doInitialization(Region *, RGPassManager &RGM); @@ -858,11 +863,11 @@ information.</p> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="runOnRegion">The <tt>runOnRegion</tt> method</a> -</div> +</h4> -<div class="doc_text"> +<div> <div class="doc_code"><pre> <b>virtual bool</b> runOnRegion(Region *, RGPassManager &RGM) = 0; @@ -876,11 +881,11 @@ should be used to update region tree.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="doFinalization_region">The <tt>doFinalization()</tt> method</a> -</div> +</h4> -<div class="doc_text"> +<div> <div class="doc_code"><pre> <b>virtual bool</b> doFinalization(); @@ -893,14 +898,14 @@ program being compiled. </p> </div> - +</div> <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="BasicBlockPass">The <tt>BasicBlockPass</tt> class</a> -</div> +</h3> -<div class="doc_text"> +<div> <p><tt>BasicBlockPass</tt>'s are just like <a href="#FunctionPass"><tt>FunctionPass</tt></a>'s, except that they must limit @@ -922,15 +927,14 @@ href="#doInitialization_mod"><tt>doInitialization(Module &)</tt></a> and <a href="#doFinalization_mod"><tt>doFinalization(Module &)</tt></a> methods that <a href="#FunctionPass"><tt>FunctionPass</tt></a>'s have, but also have the following virtual methods that may also be implemented:</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> - <a name="doInitialization_fn">The <tt>doInitialization(Function - &)</tt> method</a> -</div> +<h4> + <a name="doInitialization_fn"> + The <tt>doInitialization(Function &)</tt> method + </a> +</h4> -<div class="doc_text"> +<div> <div class="doc_code"><pre> <b>virtual bool</b> doInitialization(Function &F); @@ -947,11 +951,11 @@ fast).</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="runOnBasicBlock">The <tt>runOnBasicBlock</tt> method</a> -</div> +</h4> -<div class="doc_text"> +<div> <div class="doc_code"><pre> <b>virtual bool</b> runOnBasicBlock(BasicBlock &BB) = 0; @@ -965,12 +969,13 @@ if the basic block is modified.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> - <a name="doFinalization_fn">The <tt>doFinalization(Function &)</tt> - method</a> -</div> +<h4> + <a name="doFinalization_fn"> + The <tt>doFinalization(Function &)</tt> method + </a> +</h4> -<div class="doc_text"> +<div> <div class="doc_code"><pre> <b>virtual bool</b> doFinalization(Function &F); @@ -984,12 +989,14 @@ finalization.</p> </div> +</div> + <!-- ======================================================================= --> -<div class="doc_subsection"> +<h3> <a name="MachineFunctionPass">The <tt>MachineFunctionPass</tt> class</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>A <tt>MachineFunctionPass</tt> is a part of the LLVM code generator that executes on the machine-dependent representation of each LLVM function in the @@ -1014,15 +1021,14 @@ href="#runOnMachineFunction"><tt>runOnMachineFunction</tt></a> (including global data)</li> </ol> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> - <a name="runOnMachineFunction">The <tt>runOnMachineFunction(MachineFunction - &MF)</tt> method</a> -</div> +<h4> + <a name="runOnMachineFunction"> + The <tt>runOnMachineFunction(MachineFunction &MF)</tt> method + </a> +</h4> -<div class="doc_text"> +<div> <div class="doc_code"><pre> <b>virtual bool</b> runOnMachineFunction(MachineFunction &MF) = 0; @@ -1043,13 +1049,17 @@ remember, you may not modify the LLVM <tt>Function</tt> or its contents from a </div> +</div> + +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="registration">Pass registration</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>In the <a href="#basiccode">Hello World</a> example pass we illustrated how pass registration works, and discussed some of the reasons that it is used and @@ -1066,14 +1076,12 @@ well as for debug output generated by the <tt>--debug-pass</tt> option.</p> <p>If you want your pass to be easily dumpable, you should implement the virtual <tt>print</tt> method:</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="print">The <tt>print</tt> method</a> -</div> +</h4> -<div class="doc_text"> +<div> <div class="doc_code"><pre> <b>virtual void</b> print(std::ostream &O, <b>const</b> Module *M) <b>const</b>; @@ -1093,13 +1101,15 @@ depended on.</p> </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="interaction">Specifying interactions between passes</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>One of the main responsibilities of the <tt>PassManager</tt> is to make sure that passes interact with each other correctly. Because <tt>PassManager</tt> @@ -1116,14 +1126,12 @@ specifies. If a pass does not implement the <tt><a href="#getAnalysisUsage">getAnalysisUsage</a></tt> method, it defaults to not having any prerequisite passes, and invalidating <b>all</b> other passes.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="getAnalysisUsage">The <tt>getAnalysisUsage</tt> method</a> -</div> +</h4> -<div class="doc_text"> +<div> <div class="doc_code"><pre> <b>virtual void</b> getAnalysisUsage(AnalysisUsage &Info) <b>const</b>; @@ -1139,11 +1147,14 @@ object:</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> - <a name="AU::addRequired">The <tt>AnalysisUsage::addRequired<></tt> and <tt>AnalysisUsage::addRequiredTransitive<></tt> methods</a> -</div> - -<div class="doc_text"> +<h4> + <a name="AU::addRequired"> + The <tt>AnalysisUsage::addRequired<></tt> + and <tt>AnalysisUsage::addRequiredTransitive<></tt> methods + </a> +</h4> + +<div> <p> If your pass requires a previous pass to be executed (an analysis for example), it can use one of these methods to arrange for it to be run before your pass. @@ -1165,11 +1176,13 @@ pass is. </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> - <a name="AU::addPreserved">The <tt>AnalysisUsage::addPreserved<></tt> method</a> -</div> +<h4> + <a name="AU::addPreserved"> + The <tt>AnalysisUsage::addPreserved<></tt> method + </a> +</h4> -<div class="doc_text"> +<div> <p> One of the jobs of the PassManager is to optimize how and when analyses are run. In particular, it attempts to avoid recomputing data unless it needs to. For @@ -1200,22 +1213,13 @@ the fact that it hacks on the CFG. </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> - <a name="AU::examples">Example implementations of <tt>getAnalysisUsage</tt></a> -</div> - -<div class="doc_text"> - -<div class="doc_code"><pre> - <i>// This is an example implementation from an analysis, which does not modify - // the program at all, yet has a prerequisite.</i> - <b>void</b> <a href="http://llvm.org/doxygen/classllvm_1_1PostDominanceFrontier.html">PostDominanceFrontier</a>::getAnalysisUsage(AnalysisUsage &AU) <b>const</b> { - AU.setPreservesAll(); - AU.addRequired<<a href="http://llvm.org/doxygen/classllvm_1_1PostDominatorTree.html">PostDominatorTree</a>>(); - } -</pre></div> +<h4> + <a name="AU::examples"> + Example implementations of <tt>getAnalysisUsage</tt> + </a> +</h4> -<p>and:</p> +<div> <div class="doc_code"><pre> <i>// This example modifies the program, but does not modify the CFG</i> @@ -1228,12 +1232,14 @@ the fact that it hacks on the CFG. </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> - <a name="getAnalysis">The <tt>getAnalysis<></tt> and -<tt>getAnalysisIfAvailable<></tt> methods</a> -</div> +<h4> + <a name="getAnalysis"> + The <tt>getAnalysis<></tt> and + <tt>getAnalysisIfAvailable<></tt> methods + </a> +</h4> -<div class="doc_text"> +<div> <p>The <tt>Pass::getAnalysis<></tt> method is automatically inherited by your class, providing you with access to the passes that you declared that you @@ -1285,13 +1291,15 @@ if it is active. For example:</p> </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="analysisgroup">Implementing Analysis Groups</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Now that we understand the basics of how passes are defined, how they are used, and how they are required from other passes, it's time to get a little bit @@ -1310,14 +1318,12 @@ between these two extremes for other implementations). To cleanly support situations like this, the LLVM Pass Infrastructure supports the notion of Analysis Groups.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="agconcepts">Analysis Group Concepts</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>An Analysis Group is a single simple interface that may be implemented by multiple different passes. Analysis Groups can be given human readable names @@ -1364,11 +1370,11 @@ hypothetical example) instead.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="registerag">Using <tt>RegisterAnalysisGroup</tt></a> -</div> +</h4> -<div class="doc_text"> +<div> <p>The <tt>RegisterAnalysisGroup</tt> template is used to register the analysis group itself, while the <tt>INITIALIZE_AG_PASS</tt> is used to add pass @@ -1425,13 +1431,15 @@ pass is the default implementation for the interface.</p> </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="passStatistics">Pass Statistics</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>The <a href="http://llvm.org/doxygen/Statistic_8h-source.html"><tt>Statistic</tt></a> class is designed to be an easy way to expose various success @@ -1443,12 +1451,12 @@ line. See the <a href="http://llvm.org/docs/ProgrammersManual.html#Statistic">St <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="passmanager">What PassManager does</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>The <a href="http://llvm.org/doxygen/PassManager_8h-source.html"><tt>PassManager</tt></a> @@ -1615,14 +1623,12 @@ Hello: main <p>Which shows that we don't accidentally invalidate dominator information anymore, and therefore do not have to compute it twice.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="releaseMemory">The <tt>releaseMemory</tt> method</a> -</div> +</h4> -<div class="doc_text"> +<div> <div class="doc_code"><pre> <b>virtual void</b> releaseMemory(); @@ -1643,13 +1649,15 @@ class, before the next call of <tt>run*</tt> in your pass.</p> </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="registering">Registering dynamically loaded passes</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p><i>Size matters</i> when constructing production quality tools using llvm, both for the purposes of distribution, and for regulating the resident code size @@ -1676,14 +1684,12 @@ the static destructor <i>unregisters</i>. Thus a pass that is statically linked in the tool will be registered at start up. A dynamically loaded pass will register on load and unregister at unload.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsection"> +<h3> <a name="registering_existing">Using existing registries</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>There are predefined registries to track instruction scheduling (<tt>RegisterScheduler</tt>) and register allocation (<tt>RegisterRegAlloc</tt>) @@ -1744,11 +1750,11 @@ call line to <tt>llvm/Codegen/LinkAllCodegenComponents.h</tt>.</p> <!-- _______________________________________________________________________ --> -<div class="doc_subsection"> +<h3> <a name="registering_new">Creating new registries</a> -</div> +</h3> -<div class="doc_text"> +<div> <p>The easiest way to get started is to clone one of the existing registries; we recommend <tt>llvm/CodeGen/RegAllocRegistry.h</tt>. The key things to modify @@ -1776,13 +1782,15 @@ creator.</p> </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="debughints">Using GDB with dynamically loaded passes</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Unfortunately, using GDB with dynamically loaded passes is not as easy as it should be. First of all, you can't set a breakpoint in a shared object that has @@ -1794,14 +1802,12 @@ GDB.</p> transformation invoked by <tt>opt</tt>, although nothing described here depends on that.</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="breakpoint">Setting a breakpoint in your pass</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>First thing you do is start <tt>gdb</tt> on the <tt>opt</tt> process:</p> @@ -1842,11 +1848,11 @@ or do other standard debugging stuff.</p> </div> <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="debugmisc">Miscellaneous Problems</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>Once you have the basics down, there are a couple of problems that GDB has, some with solutions, some without.</p> @@ -1874,26 +1880,26 @@ href="mailto:sabre@nondot.org">Chris</a>.</p> </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"> +<h2> <a name="future">Future extensions planned</a> -</div> +</h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Although the LLVM Pass Infrastructure is very capable as it stands, and does some nifty stuff, there are things we'd like to add in the future. Here is where we are going:</p> -</div> - <!-- _______________________________________________________________________ --> -<div class="doc_subsubsection"> +<h4> <a name="SMP">Multithreaded LLVM</a> -</div> +</h4> -<div class="doc_text"> +<div> <p>Multiple CPU machines are becoming more common and compilation can never be fast enough: obviously we should allow for a multithreaded compiler. Because of @@ -1911,6 +1917,8 @@ Despite that, we have kept the LLVM passes SMP ready, and you should too.</p> </div> +</div> + <!-- *********************************************************************** --> <hr> <address> @@ -1920,8 +1928,8 @@ Despite that, we have kept the LLVM passes SMP ready, and you should too.</p> src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a> <a href="mailto:sabre@nondot.org">Chris Lattner</a><br> - <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br> - Last modified: $Date: 2011-02-15 10:23:02 +0100 (Tue, 15 Feb 2011) $ + <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br> + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> diff --git a/docs/doxygen.css b/docs/doxygen.css index 83b049b5f1b7..80c6cad558c0 100644 --- a/docs/doxygen.css +++ b/docs/doxygen.css @@ -370,9 +370,39 @@ H2 { H3 { font-size: 100%; } + +H2, H3 { + border-bottom: 2px solid; + margin-top: 2em; +} + A.qindex {} A.qindexRef {} A.el { text-decoration: none; font-weight: bold } A.elRef { font-weight: bold } A.code { text-decoration: none; font-weight: normal; color: #4444ee } A.codeRef { font-weight: normal; color: #4444ee } + +div.memitem { + border: 1px solid #999999; + margin-top: 1.0em; + margin-bottom: 1.0em; + -webkit-border-radius: 0.5em; + -webkit-box-shadow: 3px 3px 6px #777777; + -moz-border-radius: 0.5em; + -moz-box-shadow: black 3px 3px 3px; +} + +div.memproto { + background-color: #E3E4E5; + padding: 0.25em 0.5em; + -webkit-border-top-left-radius: 0.5em; + -webkit-border-top-right-radius: 0.5em; + -moz-border-radius-topleft: 0.5em; + -moz-border-radius-topright: 0.5em; +} + +div.memdoc { + padding-left: 1em; + padding-right: 1em; +} diff --git a/docs/doxygen.footer b/docs/doxygen.footer index d75fff5e4ccc..15585b8da733 100644 --- a/docs/doxygen.footer +++ b/docs/doxygen.footer @@ -1,6 +1,6 @@ <hr> <p class="footer"> -Generated on $datetime for <a href="http://llvm.org">$projectname</a> by +Generated on $datetime for <a href="http://llvm.org/">$projectname</a> by <a href="http://www.doxygen.org"><img src="doxygen.png" alt="Doxygen" align="middle" border="0"/>$doxygenversion</a><br> Copyright © 2003-2009 University of Illinois at Urbana-Champaign. diff --git a/docs/index.html b/docs/index.html index 74c39f619ea6..a25148a62d6f 100644 --- a/docs/index.html +++ b/docs/index.html @@ -7,13 +7,12 @@ </head> <body> -<div class="doc_title">Documentation for the LLVM System at SVN head</div> +<h1>Documentation for the LLVM System at SVN head</h1> <p class="doc_warning">If you are using a released version of LLVM, see <a href="http://llvm.org/releases/">the download page</a> to find your documentation.</p> -<div class="doc_text"> <table class="layout" width="95%"><tr class="layout"><td class="left"> <ul> <li><a href="#llvmdesign">LLVM Design</a></li> @@ -32,14 +31,13 @@ your documentation.</p> </p> </form> </td></tr></table> -</div> <div class="doc_author"> - <p>Written by <a href="http://llvm.org">The LLVM Team</a></p> + <p>Written by <a href="http://llvm.org/">The LLVM Team</a></p> </div> <!--=======================================================================--> -<div class="doc_section"><a name="llvmdesign">LLVM Design & Overview</a></div> +<h2><a name="llvmdesign">LLVM Design & Overview</a></h2> <!--=======================================================================--> <ul> @@ -57,7 +55,7 @@ frequent questions about LLVM's most frequently misunderstood instruction.</li> </ul> <!--=======================================================================--> -<div class="doc_section"><a name="userguide">LLVM User Guides</a></div> +<h2><a name="userguide">LLVM User Guides</a></h2> <!--=======================================================================--> <ul> @@ -75,7 +73,7 @@ LLVM for a custom language, and the facilities LLVM offers in tutorial form.</li <li><a href="DeveloperPolicy.html">Developer Policy</a> - The LLVM project's policy towards developers and their contributions.</li> -<li><a href="/docs/CommandGuide/index.html">LLVM Command Guide</a> - A reference +<li><a href="CommandGuide/index.html">LLVM Command Guide</a> - A reference manual for the LLVM command line utilities ("man" pages for LLVM tools).<br> Current tools: <a href="/cmds/llvm-ar.html">llvm-ar</a>, @@ -131,7 +129,7 @@ href="irc://irc.oftc.net/llvm">join #llvm on irc.oftc.net</a> directly.</li> <!--=======================================================================--> -<div class="doc_section"><a name="llvmprog">General LLVM Programming Documentation</a></div> +<h2><a name="llvmprog">General LLVM Programming Documentation</a></h2> <!--=======================================================================--> <ul> @@ -179,7 +177,7 @@ href="http://llvm.org/doxygen/inherits.html">classes</a>) </ul> <!--=======================================================================--> -<div class="doc_section"><a name="subsystems">LLVM Subsystem Documentation</a></div> +<h2><a name="subsystems">LLVM Subsystem Documentation</a></h2> <!--=======================================================================--> <ul> @@ -246,7 +244,7 @@ JITed code with GDB.</li> <!--=======================================================================--> -<div class="doc_section"><a name="maillist">LLVM Mailing Lists</a></div> +<h2><a name="maillist">LLVM Mailing Lists</a></h2> <!--=======================================================================--> <ul> @@ -286,8 +284,8 @@ times each day, making it a high volume list.</li> <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: 2010-05-07 02:28:04 +0200 (Fri, 07 May 2010) $ + <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br> + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body></html> diff --git a/docs/llvm.css b/docs/llvm.css index f572b5e57141..1222cf12bcb1 100644 --- a/docs/llvm.css +++ b/docs/llvm.css @@ -23,7 +23,7 @@ th { border: 2px solid gray; font-weight: bold; font-size: 105%; * Documentation */ /* Common for title and header */ -.doc_title, .doc_section, .doc_subsection, h1, h2 { +.doc_title, .doc_section, .doc_subsection, h1, h2, h3 { color: black; background: url("img/lines.gif"); font-family: "Georgia,Palatino,Times,Roman,SanSerif"; font-weight: bold; border-width: 1px; @@ -35,17 +35,17 @@ th { border: 2px solid gray; font-weight: bold; font-size: 105%; padding-bottom: 2px } -h1, .doc_section { text-align: center; font-size: 22pt; - margin: 20pt 0pt 5pt 0pt; } +h1, .doc_title, .title { text-align: left; font-size: 25pt } -.doc_title, .title { text-align: left; font-size: 25pt } +h2, .doc_section { text-align: center; font-size: 22pt; + margin: 20pt 0pt 5pt 0pt; } -h2, .doc_subsection { width: 75%; +h3, .doc_subsection { width: 75%; text-align: left; font-size: 12pt; padding: 4pt 4pt 4pt 4pt; margin: 1.5em 0.5em 0.5em 0.5em } -h3, .doc_subsubsection { margin: 2.0em 0.5em 0.5em 0.5em; +h4, .doc_subsubsection { margin: 2.0em 0.5em 0.5em 0.5em; font-weight: bold; font-style: oblique; border-bottom: 1px solid #999999; font-size: 12pt; width: 75%; } @@ -70,6 +70,10 @@ h3, .doc_subsubsection { margin: 2.0em 0.5em 0.5em 0.5em; display: table; } +h2+div, h2+p {text-align: left; padding-left: 20pt; padding-right: 10pt;} +h3+div, h3+p {text-align: left; padding-left: 20pt; padding-right: 10pt;} +h4+div, h4+p {text-align: left; padding-left: 20pt; padding-right: 10pt;} + /* It is preferrable to use <pre class="doc_code"> everywhere instead of the * <div class="doc_code"><pre>...</ptr></div> construct. * diff --git a/docs/tutorial/LangImpl1.html b/docs/tutorial/LangImpl1.html index c256af488b7f..22a2b127b466 100644 --- a/docs/tutorial/LangImpl1.html +++ b/docs/tutorial/LangImpl1.html @@ -11,7 +11,7 @@ <body> -<div class="doc_title">Kaleidoscope: Tutorial Introduction and the Lexer</div> +<h1>Kaleidoscope: Tutorial Introduction and the Lexer</h1> <ul> <li><a href="index.html">Up to Tutorial Index</a></li> @@ -30,10 +30,10 @@ </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="intro">Tutorial Introduction</a></div> +<h2><a name="intro">Tutorial Introduction</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Welcome to the "Implementing a language with LLVM" tutorial. This tutorial runs through the implementation of a simple language, showing how fun and @@ -123,10 +123,10 @@ languages!</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="language">The Basic Language</a></div> +<h2><a name="language">The Basic Language</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>This tutorial will be illustrated with a toy language that we'll call "<a href="http://en.wikipedia.org/wiki/Kaleidoscope">Kaleidoscope</a>" (derived @@ -181,10 +181,10 @@ a Mandelbrot Set</a> at various levels of magnification.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="lexer">The Lexer</a></div> +<h2><a name="lexer">The Lexer</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>When it comes to implementing a language, the first thing needed is the ability to process a text file and recognize what it says. The traditional @@ -341,8 +341,8 @@ so that you can use the lexer and parser together. src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a> <a href="mailto:sabre@nondot.org">Chris Lattner</a><br> - <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br> - Last modified: $Date: 2010-05-07 02:28:04 +0200 (Fri, 07 May 2010) $ + <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br> + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> </html> diff --git a/docs/tutorial/LangImpl2.html b/docs/tutorial/LangImpl2.html index f39ed6ccffef..c6a9bb1ec1c3 100644 --- a/docs/tutorial/LangImpl2.html +++ b/docs/tutorial/LangImpl2.html @@ -11,7 +11,7 @@ <body> -<div class="doc_title">Kaleidoscope: Implementing a Parser and AST</div> +<h1>Kaleidoscope: Implementing a Parser and AST</h1> <ul> <li><a href="index.html">Up to Tutorial Index</a></li> @@ -36,10 +36,10 @@ </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="intro">Chapter 2 Introduction</a></div> +<h2><a name="intro">Chapter 2 Introduction</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Welcome to Chapter 2 of the "<a href="index.html">Implementing a language with LLVM</a>" tutorial. This chapter shows you how to use the lexer, built in @@ -61,10 +61,10 @@ Tree.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="ast">The Abstract Syntax Tree (AST)</a></div> +<h2><a name="ast">The Abstract Syntax Tree (AST)</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>The AST for a program captures its behavior in such a way that it is easy for later stages of the compiler (e.g. code generation) to interpret. We basically @@ -178,10 +178,10 @@ bodies in Kaleidoscope.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="parserbasics">Parser Basics</a></div> +<h2><a name="parserbasics">Parser Basics</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Now that we have an AST to build, we need to define the parser code to build it. The idea here is that we want to parse something like "x+y" (which is @@ -239,11 +239,10 @@ piece of our grammar: numeric literals.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="parserprimexprs">Basic Expression - Parsing</a></div> +<h2><a name="parserprimexprs">Basic Expression Parsing</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>We start with numeric literals, because they are the simplest to process. For each production in our grammar, we'll define a function which parses that @@ -394,11 +393,10 @@ They are a bit more complex.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="parserbinops">Binary Expression - Parsing</a></div> +<h2><a name="parserbinops">Binary Expression Parsing</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Binary expressions are significantly harder to parse because they are often ambiguous. For example, when given the string "x+y*z", the parser can choose @@ -617,10 +615,10 @@ handle function definitions, etc.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="parsertop">Parsing the Rest</a></div> +<h2><a name="parsertop">Parsing the Rest</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> The next thing missing is handling of function prototypes. In Kaleidoscope, @@ -714,10 +712,10 @@ actually <em>execute</em> this code we've built!</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="driver">The Driver</a></div> +<h2><a name="driver">The Driver</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>The driver for this simply invokes all of the parsing pieces with a top-level dispatch loop. There isn't much interesting here, so I'll just include the @@ -753,10 +751,10 @@ type "4+5;", and the parser will know you are done.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="conclusions">Conclusions</a></div> +<h2><a name="conclusions">Conclusions</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>With just under 400 lines of commented code (240 lines of non-comment, non-blank code), we fully defined our minimal language, including a lexer, @@ -790,10 +788,10 @@ Representation (IR) from the AST.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="code">Full Code Listing</a></div> +<h2><a name="code">Full Code Listing</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> Here is the complete code listing for this and the previous chapter. @@ -1226,8 +1224,8 @@ int main() { src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a> <a href="mailto:sabre@nondot.org">Chris Lattner</a><br> - <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br> - Last modified: $Date: 2010-05-07 02:28:04 +0200 (Fri, 07 May 2010) $ + <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br> + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> </html> diff --git a/docs/tutorial/LangImpl3.html b/docs/tutorial/LangImpl3.html index a320ff7e9064..47406ca36e41 100644 --- a/docs/tutorial/LangImpl3.html +++ b/docs/tutorial/LangImpl3.html @@ -11,7 +11,7 @@ <body> -<div class="doc_title">Kaleidoscope: Code generation to LLVM IR</div> +<h1>Kaleidoscope: Code generation to LLVM IR</h1> <ul> <li><a href="index.html">Up to Tutorial Index</a></li> @@ -34,10 +34,10 @@ Support</li> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="intro">Chapter 3 Introduction</a></div> +<h2><a name="intro">Chapter 3 Introduction</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Welcome to Chapter 3 of the "<a href="index.html">Implementing a language with LLVM</a>" tutorial. This chapter shows you how to transform the <a @@ -57,10 +57,10 @@ releases page</a>.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="basics">Code Generation Setup</a></div> +<h2><a name="basics">Code Generation Setup</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> In order to generate LLVM IR, we want some simple setup to get started. First @@ -147,10 +147,10 @@ has already been done, and we'll just use it to emit code. </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="exprs">Expression Code Generation</a></div> +<h2><a name="exprs">Expression Code Generation</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Generating LLVM code for expression nodes is very straightforward: less than 45 lines of commented code for all four of our expression nodes. First @@ -293,10 +293,10 @@ basic framework.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="funcs">Function Code Generation</a></div> +<h2><a name="funcs">Function Code Generation</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Code generation for prototypes and functions must handle a number of details, which make their code less beautiful than expression code @@ -515,11 +515,10 @@ def bar() foo(1, 2); # error, unknown function "foo" </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="driver">Driver Changes and -Closing Thoughts</a></div> +<h2><a name="driver">Driver Changes and Closing Thoughts</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> For now, code generation to LLVM doesn't really get us much, except that we can @@ -657,10 +656,10 @@ support</a> to this so we can actually start running code!</p> <!-- *********************************************************************** --> -<div class="doc_section"><a name="code">Full Code Listing</a></div> +<h2><a name="code">Full Code Listing</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> Here is the complete code listing for our running example, enhanced with the @@ -1262,8 +1261,8 @@ int main() { src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a> <a href="mailto:sabre@nondot.org">Chris Lattner</a><br> - <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br> - Last modified: $Date: 2011-02-15 01:24:32 +0100 (Tue, 15 Feb 2011) $ + <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br> + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> </html> diff --git a/docs/tutorial/LangImpl4.html b/docs/tutorial/LangImpl4.html index a2511d959e7b..5b8990e441e4 100644 --- a/docs/tutorial/LangImpl4.html +++ b/docs/tutorial/LangImpl4.html @@ -11,7 +11,7 @@ <body> -<div class="doc_title">Kaleidoscope: Adding JIT and Optimizer Support</div> +<h1>Kaleidoscope: Adding JIT and Optimizer Support</h1> <ul> <li><a href="index.html">Up to Tutorial Index</a></li> @@ -33,10 +33,10 @@ Flow</li> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="intro">Chapter 4 Introduction</a></div> +<h2><a name="intro">Chapter 4 Introduction</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Welcome to Chapter 4 of the "<a href="index.html">Implementing a language with LLVM</a>" tutorial. Chapters 1-3 described the implementation of a simple @@ -48,11 +48,10 @@ for the Kaleidoscope language.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="trivialconstfold">Trivial Constant -Folding</a></div> +<h2><a name="trivialconstfold">Trivial Constant Folding</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> Our demonstration for Chapter 3 is elegant and easy to extend. Unfortunately, @@ -134,11 +133,10 @@ range of optimizations that you can use, in the form of "passes".</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="optimizerpasses">LLVM Optimization - Passes</a></div> +<h2><a name="optimizerpasses">LLVM Optimization Passes</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>LLVM provides many optimization passes, which do many different sorts of things and have different tradeoffs. Unlike other systems, LLVM doesn't hold @@ -266,10 +264,10 @@ executing it!</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="jit">Adding a JIT Compiler</a></div> +<h2><a name="jit">Adding a JIT Compiler</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Code that is available in LLVM IR can have a wide variety of tools applied to it. For example, you can run optimizations on it (as we did above), @@ -474,10 +472,10 @@ tackling some interesting LLVM IR issues along the way.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="code">Full Code Listing</a></div> +<h2><a name="code">Full Code Listing</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> Here is the complete code listing for our running example, enhanced with the @@ -1078,7 +1076,7 @@ int main() { // Create the JIT. This takes ownership of the module. std::string ErrStr; - TheExecutionEngine = EngineBuilder(TheModule).setErrorStr(&ErrStr).create(); +TheExecutionEngine = EngineBuilder(TheModule).setErrorStr(&ErrStr).create(); if (!TheExecutionEngine) { fprintf(stderr, "Could not create ExecutionEngine: %s\n", ErrStr.c_str()); exit(1); @@ -1130,8 +1128,8 @@ int main() { src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a> <a href="mailto:sabre@nondot.org">Chris Lattner</a><br> - <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br> - Last modified: $Date: 2010-11-16 18:28:22 +0100 (Tue, 16 Nov 2010) $ + <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br> + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> </html> diff --git a/docs/tutorial/LangImpl5.html b/docs/tutorial/LangImpl5.html index d2c3bd03dc4e..4fc23a149429 100644 --- a/docs/tutorial/LangImpl5.html +++ b/docs/tutorial/LangImpl5.html @@ -11,7 +11,7 @@ <body> -<div class="doc_title">Kaleidoscope: Extending the Language: Control Flow</div> +<h1>Kaleidoscope: Extending the Language: Control Flow</h1> <ul> <li><a href="index.html">Up to Tutorial Index</a></li> @@ -48,10 +48,10 @@ User-defined Operators</li> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="intro">Chapter 5 Introduction</a></div> +<h2><a name="intro">Chapter 5 Introduction</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Welcome to Chapter 5 of the "<a href="index.html">Implementing a language with LLVM</a>" tutorial. Parts 1-4 described the implementation of the simple @@ -65,14 +65,14 @@ have an if/then/else expression plus a simple 'for' loop.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="ifthen">If/Then/Else</a></div> +<h2><a name="ifthen">If/Then/Else</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> Extending Kaleidoscope to support if/then/else is quite straightforward. It -basically requires adding lexer support for this "new" concept to the lexer, +basically requires adding support for this "new" concept to the lexer, parser, AST, and LLVM code emitter. This example is nice, because it shows how easy it is to "grow" a language over time, incrementally extending it as new ideas are discovered.</p> @@ -108,15 +108,12 @@ Since Kaleidoscope allows side-effects, this behavior is important to nail down. <p>Now that we know what we "want", lets break this down into its constituent pieces.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="iflexer">Lexer Extensions for -If/Then/Else</a></div> +<h4><a name="iflexer">Lexer Extensions for If/Then/Else</a></h4> <!-- ======================================================================= --> -<div class="doc_text"> +<div> <p>The lexer extensions are straightforward. First we add new enum values for the relevant tokens:</p> @@ -146,11 +143,10 @@ stuff:</p> </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="ifast">AST Extensions for - If/Then/Else</a></div> +<h4><a name="ifast">AST Extensions for If/Then/Else</a></h4> <!-- ======================================================================= --> -<div class="doc_text"> +<div> <p>To represent the new expression we add a new AST node for it:</p> @@ -172,11 +168,10 @@ public: </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="ifparser">Parser Extensions for -If/Then/Else</a></div> +<h4><a name="ifparser">Parser Extensions for If/Then/Else</a></h4> <!-- ======================================================================= --> -<div class="doc_text"> +<div> <p>Now that we have the relevant tokens coming from the lexer and we have the AST node to build, our parsing logic is relatively straightforward. First we @@ -231,10 +226,10 @@ static ExprAST *ParsePrimary() { </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="ifir">LLVM IR for If/Then/Else</a></div> +<h4><a name="ifir">LLVM IR for If/Then/Else</a></h4> <!-- ======================================================================= --> -<div class="doc_text"> +<div> <p>Now that we have it parsing and building the AST, the final piece is adding LLVM code generation support. This is the most interesting part of the @@ -347,11 +342,10 @@ directly.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="ifcodegen">Code Generation for -If/Then/Else</a></div> +<h4><a name="ifcodegen">Code Generation for If/Then/Else</a></h4> <!-- ======================================================================= --> -<div class="doc_text"> +<div> <p>In order to generate code for this, we implement the <tt>Codegen</tt> method for <tt>IfExprAST</tt>:</p> @@ -472,7 +466,7 @@ are emitted, we can finish up with the merge code:</p> // Emit merge block. TheFunction->getBasicBlockList().push_back(MergeBB); Builder.SetInsertPoint(MergeBB); - PHINode *PN = Builder.CreatePHI(Type::getDoubleTy(getGlobalContext()), + PHINode *PN = Builder.CreatePHI(Type::getDoubleTy(getGlobalContext()), 2, "iftmp"); PN->addIncoming(ThenV, ThenBB); @@ -500,11 +494,13 @@ another useful expression that is familiar from non-functional languages...</p> </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"><a name="for">'for' Loop Expression</a></div> +<h2><a name="for">'for' Loop Expression</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Now that we know how to add basic control flow constructs to the language, we have the tools to add more powerful things. Lets add something more @@ -533,14 +529,11 @@ variables, it will get more useful.</p> <p>As before, lets talk about the changes that we need to Kaleidoscope to support this.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="forlexer">Lexer Extensions for -the 'for' Loop</a></div> +<h4><a name="forlexer">Lexer Extensions for the 'for' Loop</a></h4> <!-- ======================================================================= --> -<div class="doc_text"> +<div> <p>The lexer extensions are the same sort of thing as for if/then/else:</p> @@ -566,11 +559,10 @@ the 'for' Loop</a></div> </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="forast">AST Extensions for -the 'for' Loop</a></div> +<h4><a name="forast">AST Extensions for the 'for' Loop</a></h4> <!-- ======================================================================= --> -<div class="doc_text"> +<div> <p>The AST node is just as simple. It basically boils down to capturing the variable name and the constituent expressions in the node.</p> @@ -593,11 +585,10 @@ public: </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="forparser">Parser Extensions for -the 'for' Loop</a></div> +<h4><a name="forparser">Parser Extensions for the 'for' Loop</a></h4> <!-- ======================================================================= --> -<div class="doc_text"> +<div> <p>The parser code is also fairly standard. The only interesting thing here is handling of the optional step value. The parser code handles it by checking to @@ -653,11 +644,10 @@ static ExprAST *ParseForExpr() { </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="forir">LLVM IR for -the 'for' Loop</a></div> +<h4><a name="forir">LLVM IR for the 'for' Loop</a></h4> <!-- ======================================================================= --> -<div class="doc_text"> +<div> <p>Now we get to the good part: the LLVM IR we want to generate for this thing. With the simple example above, we get this LLVM IR (note that this dump is @@ -699,11 +689,10 @@ expressions, and some basic blocks. Lets see how this fits together.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="forcodegen">Code Generation for -the 'for' Loop</a></div> +<h4><a name="forcodegen">Code Generation for the 'for' Loop</a></h4> <!-- ======================================================================= --> -<div class="doc_text"> +<div> <p>The first part of Codegen is very simple: we just output the start expression for the loop value:</p> @@ -746,7 +735,7 @@ create an unconditional branch for the fall-through between the two blocks.</p> Builder.SetInsertPoint(LoopBB); // Start the PHI node with an entry for Start. - PHINode *Variable = Builder.CreatePHI(Type::getDoubleTy(getGlobalContext()), VarName.c_str()); + PHINode *Variable = Builder.CreatePHI(Type::getDoubleTy(getGlobalContext()), 2, VarName.c_str()); Variable->addIncoming(StartVal, PreheaderBB); </pre> </div> @@ -876,11 +865,13 @@ language.</p> </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"><a name="code">Full Code Listing</a></div> +<h2><a name="code">Full Code Listing</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> Here is the complete code listing for our running example, enhanced with the @@ -1452,7 +1443,7 @@ Value *IfExprAST::Codegen() { // Emit merge block. TheFunction->getBasicBlockList().push_back(MergeBB); Builder.SetInsertPoint(MergeBB); - PHINode *PN = Builder.CreatePHI(Type::getDoubleTy(getGlobalContext()), + PHINode *PN = Builder.CreatePHI(Type::getDoubleTy(getGlobalContext()), 2, "iftmp"); PN->addIncoming(ThenV, ThenBB); @@ -1494,7 +1485,7 @@ Value *ForExprAST::Codegen() { Builder.SetInsertPoint(LoopBB); // Start the PHI node with an entry for Start. - PHINode *Variable = Builder.CreatePHI(Type::getDoubleTy(getGlobalContext()), VarName.c_str()); + PHINode *Variable = Builder.CreatePHI(Type::getDoubleTy(getGlobalContext()), 2, VarName.c_str()); Variable->addIncoming(StartVal, PreheaderBB); // Within the loop, the variable is defined equal to the PHI node. If it @@ -1721,7 +1712,7 @@ int main() { // Create the JIT. This takes ownership of the module. std::string ErrStr; - TheExecutionEngine = EngineBuilder(TheModule).setErrorStr(&ErrStr).create(); + TheExecutionEngine = EngineBuilder(TheModule).setErrorStr(&ErrStr).create(); if (!TheExecutionEngine) { fprintf(stderr, "Could not create ExecutionEngine: %s\n", ErrStr.c_str()); exit(1); @@ -1773,8 +1764,8 @@ int main() { src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a> <a href="mailto:sabre@nondot.org">Chris Lattner</a><br> - <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br> - Last modified: $Date: 2010-11-16 18:28:22 +0100 (Tue, 16 Nov 2010) $ + <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br> + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> </html> diff --git a/docs/tutorial/LangImpl6.html b/docs/tutorial/LangImpl6.html index 7ddf3a099cbc..31d7ff4cd215 100644 --- a/docs/tutorial/LangImpl6.html +++ b/docs/tutorial/LangImpl6.html @@ -11,7 +11,7 @@ <body> -<div class="doc_title">Kaleidoscope: Extending the Language: User-defined Operators</div> +<h1>Kaleidoscope: Extending the Language: User-defined Operators</h1> <ul> <li><a href="index.html">Up to Tutorial Index</a></li> @@ -34,10 +34,10 @@ Variables / SSA Construction</li> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="intro">Chapter 6 Introduction</a></div> +<h2><a name="intro">Chapter 6 Introduction</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Welcome to Chapter 6 of the "<a href="index.html">Implementing a language with LLVM</a>" tutorial. At this point in our tutorial, we now have a fully @@ -60,10 +60,10 @@ an example of what you can build with Kaleidoscope and its feature set.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="idea">User-defined Operators: the Idea</a></div> +<h2><a name="idea">User-defined Operators: the Idea</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> The "operator overloading" that we will add to Kaleidoscope is more general than @@ -125,10 +125,10 @@ operators.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="binary">User-defined Binary Operators</a></div> +<h2><a name="binary">User-defined Binary Operators</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Adding support for user-defined binary operators is pretty simple with our current framework. We'll first add support for the unary/binary keywords:</p> @@ -342,10 +342,10 @@ see what it takes.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="unary">User-defined Unary Operators</a></div> +<h2><a name="unary">User-defined Unary Operators</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Since we don't currently support unary operators in the Kaleidoscope language, we'll need to add everything to support them. Above, we added simple @@ -491,10 +491,10 @@ is simpler primarily because it doesn't need to handle any predefined operators. </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="example">Kicking the Tires</a></div> +<h2><a name="example">Kicking the Tires</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>It is somewhat hard to believe, but with a few simple extensions we've covered in the last chapters, we have grown a real-ish language. With this, we @@ -796,10 +796,10 @@ add variable mutation without building SSA in your front-end.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="code">Full Code Listing</a></div> +<h2><a name="code">Full Code Listing</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> Here is the complete code listing for our running example, enhanced with the @@ -1475,7 +1475,7 @@ Value *IfExprAST::Codegen() { // Emit merge block. TheFunction->getBasicBlockList().push_back(MergeBB); Builder.SetInsertPoint(MergeBB); - PHINode *PN = Builder.CreatePHI(Type::getDoubleTy(getGlobalContext()), + PHINode *PN = Builder.CreatePHI(Type::getDoubleTy(getGlobalContext()), 2, "iftmp"); PN->addIncoming(ThenV, ThenBB); @@ -1517,7 +1517,7 @@ Value *ForExprAST::Codegen() { Builder.SetInsertPoint(LoopBB); // Start the PHI node with an entry for Start. - PHINode *Variable = Builder.CreatePHI(Type::getDoubleTy(getGlobalContext()), VarName.c_str()); + PHINode *Variable = Builder.CreatePHI(Type::getDoubleTy(getGlobalContext()), 2, VarName.c_str()); Variable->addIncoming(StartVal, PreheaderBB); // Within the loop, the variable is defined equal to the PHI node. If it @@ -1758,7 +1758,7 @@ int main() { // Create the JIT. This takes ownership of the module. std::string ErrStr; - TheExecutionEngine = EngineBuilder(TheModule).setErrorStr(&ErrStr).create(); + TheExecutionEngine = EngineBuilder(TheModule).setErrorStr(&ErrStr).create(); if (!TheExecutionEngine) { fprintf(stderr, "Could not create ExecutionEngine: %s\n", ErrStr.c_str()); exit(1); @@ -1810,8 +1810,8 @@ int main() { src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a> <a href="mailto:sabre@nondot.org">Chris Lattner</a><br> - <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br> - Last modified: $Date: 2010-11-16 18:28:22 +0100 (Tue, 16 Nov 2010) $ + <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br> + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> </html> diff --git a/docs/tutorial/LangImpl7.html b/docs/tutorial/LangImpl7.html index 3b36129d6716..a4a21f1aed22 100644 --- a/docs/tutorial/LangImpl7.html +++ b/docs/tutorial/LangImpl7.html @@ -12,7 +12,7 @@ <body> -<div class="doc_title">Kaleidoscope: Extending the Language: Mutable Variables</div> +<h1>Kaleidoscope: Extending the Language: Mutable Variables</h1> <ul> <li><a href="index.html">Up to Tutorial Index</a></li> @@ -38,10 +38,10 @@ </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="intro">Chapter 7 Introduction</a></div> +<h2><a name="intro">Chapter 7 Introduction</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Welcome to Chapter 7 of the "<a href="index.html">Implementing a language with LLVM</a>" tutorial. In chapters 1 through 6, we've built a very @@ -66,10 +66,10 @@ support for this, though the way it works is a bit unexpected for some.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="why">Why is this a hard problem?</a></div> +<h2><a name="why">Why is this a hard problem?</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> To understand why mutable variables cause complexities in SSA construction, @@ -140,10 +140,10 @@ logic.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="memory">Memory in LLVM</a></div> +<h2><a name="memory">Memory in LLVM</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>The 'trick' here is that while LLVM does require all register values to be in SSA form, it does not require (or permit) memory objects to be in SSA form. @@ -321,11 +321,10 @@ variables now! </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="kalvars">Mutable Variables in -Kaleidoscope</a></div> +<h2><a name="kalvars">Mutable Variables in Kaleidoscope</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Now that we know the sort of problem we want to tackle, lets see what this looks like in the context of our little Kaleidoscope language. We're going to @@ -378,11 +377,10 @@ Kaleidoscope to support new variable definitions. </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="adjustments">Adjusting Existing Variables for -Mutation</a></div> +<h2><a name="adjustments">Adjusting Existing Variables for Mutation</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> The symbol table in Kaleidoscope is managed at code generation time by the @@ -648,10 +646,10 @@ we'll add the assignment operator.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="assignment">New Assignment Operator</a></div> +<h2><a name="assignment">New Assignment Operator</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>With our current framework, adding a new assignment operator is really simple. We will parse it just like any other binary operator, but handle it @@ -745,11 +743,10 @@ add this next! </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="localvars">User-defined Local -Variables</a></div> +<h2><a name="localvars">User-defined Local Variables</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Adding var/in is just like any other other extensions we made to Kaleidoscope: we extend the lexer, the parser, the AST and the code generator. @@ -979,10 +976,10 @@ anywhere in sight.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="code">Full Code Listing</a></div> +<h2><a name="code">Full Code Listing</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> Here is the complete code listing for our running example, enhanced with mutable @@ -1755,7 +1752,7 @@ Value *IfExprAST::Codegen() { // Emit merge block. TheFunction->getBasicBlockList().push_back(MergeBB); Builder.SetInsertPoint(MergeBB); - PHINode *PN = Builder.CreatePHI(Type::getDoubleTy(getGlobalContext()), + PHINode *PN = Builder.CreatePHI(Type::getDoubleTy(getGlobalContext()), 2, "iftmp"); PN->addIncoming(ThenV, ThenBB); @@ -2160,8 +2157,8 @@ int main() { src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a> <a href="mailto:sabre@nondot.org">Chris Lattner</a><br> - <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br> - Last modified: $Date: 2010-11-16 18:28:22 +0100 (Tue, 16 Nov 2010) $ + <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br> + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> </html> diff --git a/docs/tutorial/LangImpl8.html b/docs/tutorial/LangImpl8.html index fe42a22e0304..cc55d401a4c7 100644 --- a/docs/tutorial/LangImpl8.html +++ b/docs/tutorial/LangImpl8.html @@ -11,8 +11,7 @@ <body> -<div class="doc_title">Kaleidoscope: Conclusion and other useful LLVM - tidbits</div> +<h1>Kaleidoscope: Conclusion and other useful LLVM tidbits</h1> <ul> <li><a href="index.html">Up to Tutorial Index</a></li> @@ -43,10 +42,10 @@ </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="conclusion">Tutorial Conclusion</a></div> +<h2><a name="conclusion">Tutorial Conclusion</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Welcome to the the final chapter of the "<a href="index.html">Implementing a language with LLVM</a>" tutorial. In the course of this tutorial, we have grown @@ -154,23 +153,19 @@ are very useful if you want to take advantage of LLVM's capabilities.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="llvmirproperties">Properties of the LLVM -IR</a></div> +<h2><a name="llvmirproperties">Properties of the LLVM IR</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>We have a couple common questions about code in the LLVM IR form - lets just get these out of the way right now, shall we?</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="targetindep">Target -Independence</a></div> +<h4><a name="targetindep">Target Independence</a></h4> <!-- ======================================================================= --> -<div class="doc_text"> +<div> <p>Kaleidoscope is an example of a "portable language": any program written in Kaleidoscope will work the same way on any target that it runs on. Many other @@ -221,10 +216,10 @@ in-kernel language.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="safety">Safety Guarantees</a></div> +<h4><a name="safety">Safety Guarantees</a></h4> <!-- ======================================================================= --> -<div class="doc_text"> +<div> <p>Many of the languages above are also "safe" languages: it is impossible for a program written in Java to corrupt its address space and crash the process @@ -243,11 +238,10 @@ list</a> if you are interested in more details.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="langspecific">Language-Specific -Optimizations</a></div> +<h4><a name="langspecific">Language-Specific Optimizations</a></h4> <!-- ======================================================================= --> -<div class="doc_text"> +<div> <p>One thing about LLVM that turns off many people is that it does not solve all the world's problems in one system (sorry 'world hunger', someone else will have @@ -297,24 +291,23 @@ language-specific AST. </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"><a name="tipsandtricks">Tips and Tricks</a></div> +<h2><a name="tipsandtricks">Tips and Tricks</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>There is a variety of useful tips and tricks that you come to know after working on/with LLVM that aren't obvious at first glance. Instead of letting everyone rediscover them, this section talks about some of these issues.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="offsetofsizeof">Implementing portable -offsetof/sizeof</a></div> +<h4><a name="offsetofsizeof">Implementing portable offsetof/sizeof</a></h4> <!-- ======================================================================= --> -<div class="doc_text"> +<div> <p>One interesting thing that comes up, if you are trying to keep the code generated by your compiler "target independent", is that you often need to know @@ -331,11 +324,10 @@ in a portable way.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="gcstack">Garbage Collected -Stack Frames</a></div> +<h4><a name="gcstack">Garbage Collected Stack Frames</a></h4> <!-- ======================================================================= --> -<div class="doc_text"> +<div> <p>Some languages want to explicitly manage their stack frames, often so that they are garbage collected or to allow easy implementation of closures. There @@ -349,6 +341,8 @@ Passing Style</a> and the use of tail calls (which LLVM also supports).</p> </div> +</div> + <!-- *********************************************************************** --> <hr> <address> @@ -358,8 +352,8 @@ Passing Style</a> and the use of tail calls (which LLVM also supports).</p> src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a> <a href="mailto:sabre@nondot.org">Chris Lattner</a><br> - <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br> - Last modified: $Date: 2010-05-07 02:28:04 +0200 (Fri, 07 May 2010) $ + <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br> + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> </html> diff --git a/docs/tutorial/OCamlLangImpl1.html b/docs/tutorial/OCamlLangImpl1.html index 44106132fbe8..7cae68c988ab 100644 --- a/docs/tutorial/OCamlLangImpl1.html +++ b/docs/tutorial/OCamlLangImpl1.html @@ -12,7 +12,7 @@ <body> -<div class="doc_title">Kaleidoscope: Tutorial Introduction and the Lexer</div> +<h1>Kaleidoscope: Tutorial Introduction and the Lexer</h1> <ul> <li><a href="index.html">Up to Tutorial Index</a></li> @@ -35,10 +35,10 @@ AST</li> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="intro">Tutorial Introduction</a></div> +<h2><a name="intro">Tutorial Introduction</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Welcome to the "Implementing a language with LLVM" tutorial. This tutorial runs through the implementation of a simple language, showing how fun and @@ -130,10 +130,10 @@ languages!</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="language">The Basic Language</a></div> +<h2><a name="language">The Basic Language</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>This tutorial will be illustrated with a toy language that we'll call "<a href="http://en.wikipedia.org/wiki/Kaleidoscope">Kaleidoscope</a>" (derived @@ -188,10 +188,10 @@ a Mandelbrot Set</a> at various levels of magnification.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="lexer">The Lexer</a></div> +<h2><a name="lexer">The Lexer</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>When it comes to implementing a language, the first thing needed is the ability to process a text file and recognize what it says. The traditional @@ -358,8 +358,8 @@ include a driver so that you can use the lexer and parser together. <a href="mailto:sabre@nondot.org">Chris Lattner</a><br> <a href="mailto:idadesub@users.sourceforge.net">Erick Tryzelaar</a><br> - <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br> - Last modified: $Date: 2010-05-07 02:28:04 +0200 (Fri, 07 May 2010) $ + <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br> + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> </html> diff --git a/docs/tutorial/OCamlLangImpl2.html b/docs/tutorial/OCamlLangImpl2.html index 41d0956e4620..e1bb87122506 100644 --- a/docs/tutorial/OCamlLangImpl2.html +++ b/docs/tutorial/OCamlLangImpl2.html @@ -12,7 +12,7 @@ <body> -<div class="doc_title">Kaleidoscope: Implementing a Parser and AST</div> +<h1>Kaleidoscope: Implementing a Parser and AST</h1> <ul> <li><a href="index.html">Up to Tutorial Index</a></li> @@ -40,10 +40,10 @@ </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="intro">Chapter 2 Introduction</a></div> +<h2><a name="intro">Chapter 2 Introduction</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Welcome to Chapter 2 of the "<a href="index.html">Implementing a language with LLVM in Objective Caml</a>" tutorial. This chapter shows you how to use @@ -65,10 +65,10 @@ Tree.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="ast">The Abstract Syntax Tree (AST)</a></div> +<h2><a name="ast">The Abstract Syntax Tree (AST)</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>The AST for a program captures its behavior in such a way that it is easy for later stages of the compiler (e.g. code generation) to interpret. We basically @@ -146,10 +146,10 @@ bodies in Kaleidoscope.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="parserbasics">Parser Basics</a></div> +<h2><a name="parserbasics">Parser Basics</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Now that we have an AST to build, we need to define the parser code to build it. The idea here is that we want to parse something like "x+y" (which is @@ -181,11 +181,10 @@ piece of our grammar: numeric literals.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="parserprimexprs">Basic Expression - Parsing</a></div> +<h2><a name="parserprimexprs">Basic Expression Parsing</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>We start with numeric literals, because they are the simplest to process. For each production in our grammar, we'll define a function which parses that @@ -303,11 +302,10 @@ They are a bit more complex.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="parserbinops">Binary Expression - Parsing</a></div> +<h2><a name="parserbinops">Binary Expression Parsing</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Binary expressions are significantly harder to parse because they are often ambiguous. For example, when given the string "x+y*z", the parser can choose @@ -517,10 +515,10 @@ handle function definitions, etc.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="parsertop">Parsing the Rest</a></div> +<h2><a name="parsertop">Parsing the Rest</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> The next thing missing is handling of function prototypes. In Kaleidoscope, @@ -596,10 +594,10 @@ actually <em>execute</em> this code we've built!</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="driver">The Driver</a></div> +<h2><a name="driver">The Driver</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>The driver for this simply invokes all of the parsing pieces with a top-level dispatch loop. There isn't much interesting here, so I'll just include the @@ -652,10 +650,10 @@ type "4+5;", and the parser will know you are done.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="conclusions">Conclusions</a></div> +<h2><a name="conclusions">Conclusions</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>With just under 300 lines of commented code (240 lines of non-comment, non-blank code), we fully defined our minimal language, including a lexer, @@ -689,10 +687,10 @@ Representation (IR) from the AST.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="code">Full Code Listing</a></div> +<h2><a name="code">Full Code Listing</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> Here is the complete code listing for this and the previous chapter. @@ -1038,8 +1036,8 @@ main () <a href="mailto:sabre@nondot.org">Chris Lattner</a> <a href="mailto:erickt@users.sourceforge.net">Erick Tryzelaar</a><br> - <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br> - Last modified: $Date: 2010-05-07 02:28:04 +0200 (Fri, 07 May 2010) $ + <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br> + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> </html> diff --git a/docs/tutorial/OCamlLangImpl3.html b/docs/tutorial/OCamlLangImpl3.html index c7c53709a060..e52bb6c9008d 100644 --- a/docs/tutorial/OCamlLangImpl3.html +++ b/docs/tutorial/OCamlLangImpl3.html @@ -12,7 +12,7 @@ <body> -<div class="doc_title">Kaleidoscope: Code generation to LLVM IR</div> +<h1>Kaleidoscope: Code generation to LLVM IR</h1> <ul> <li><a href="index.html">Up to Tutorial Index</a></li> @@ -38,10 +38,10 @@ Support</li> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="intro">Chapter 3 Introduction</a></div> +<h2><a name="intro">Chapter 3 Introduction</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Welcome to Chapter 3 of the "<a href="index.html">Implementing a language with LLVM</a>" tutorial. This chapter shows you how to transform the <a @@ -57,10 +57,10 @@ LLVM SVN to work. LLVM 2.2 and before will not work with it.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="basics">Code Generation Setup</a></div> +<h2><a name="basics">Code Generation Setup</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> In order to generate LLVM IR, we want some simple setup to get started. First @@ -128,10 +128,10 @@ that this has already been done, and we'll just use it to emit code.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="exprs">Expression Code Generation</a></div> +<h2><a name="exprs">Expression Code Generation</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Generating LLVM code for expression nodes is very straightforward: less than 30 lines of commented code for all four of our expression nodes. First @@ -263,10 +263,10 @@ basic framework.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="funcs">Function Code Generation</a></div> +<h2><a name="funcs">Function Code Generation</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Code generation for prototypes and functions must handle a number of details, which make their code less beautiful than expression code @@ -466,11 +466,10 @@ def bar() foo(1, 2); # error, unknown function "foo" </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="driver">Driver Changes and -Closing Thoughts</a></div> +<h2><a name="driver">Driver Changes and Closing Thoughts</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> For now, code generation to LLVM doesn't really get us much, except that we can @@ -607,10 +606,10 @@ support</a> to this so we can actually start running code!</p> <!-- *********************************************************************** --> -<div class="doc_section"><a name="code">Full Code Listing</a></div> +<h2><a name="code">Full Code Listing</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> Here is the complete code listing for our running example, enhanced with the @@ -1086,8 +1085,8 @@ main () <a href="mailto:sabre@nondot.org">Chris Lattner</a><br> <a href="mailto:idadesub@users.sourceforge.net">Erick Tryzelaar</a><br> - <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br> - Last modified: $Date: 2010-05-28 19:07:41 +0200 (Fri, 28 May 2010) $ + <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br> + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> </html> diff --git a/docs/tutorial/OCamlLangImpl4.html b/docs/tutorial/OCamlLangImpl4.html index a86184c94520..db164d5e6a1a 100644 --- a/docs/tutorial/OCamlLangImpl4.html +++ b/docs/tutorial/OCamlLangImpl4.html @@ -12,7 +12,7 @@ <body> -<div class="doc_title">Kaleidoscope: Adding JIT and Optimizer Support</div> +<h1>Kaleidoscope: Adding JIT and Optimizer Support</h1> <ul> <li><a href="index.html">Up to Tutorial Index</a></li> @@ -37,10 +37,10 @@ Flow</li> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="intro">Chapter 4 Introduction</a></div> +<h2><a name="intro">Chapter 4 Introduction</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Welcome to Chapter 4 of the "<a href="index.html">Implementing a language with LLVM</a>" tutorial. Chapters 1-3 described the implementation of a simple @@ -52,11 +52,10 @@ for the Kaleidoscope language.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="trivialconstfold">Trivial Constant -Folding</a></div> +<h2><a name="trivialconstfold">Trivial Constant Folding</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p><b>Note:</b> the default <tt>IRBuilder</tt> now always includes the constant folding optimisations below.<p> @@ -148,11 +147,10 @@ range of optimizations that you can use, in the form of "passes".</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="optimizerpasses">LLVM Optimization - Passes</a></div> +<h2><a name="optimizerpasses">LLVM Optimization Passes</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>LLVM provides many optimization passes, which do many different sorts of things and have different tradeoffs. Unlike other systems, LLVM doesn't hold @@ -283,10 +281,10 @@ executing it!</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="jit">Adding a JIT Compiler</a></div> +<h2><a name="jit">Adding a JIT Compiler</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Code that is available in LLVM IR can have a wide variety of tools applied to it. For example, you can run optimizations on it (as we did above), @@ -486,10 +484,10 @@ constructs</a>, tackling some interesting LLVM IR issues along the way.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="code">Full Code Listing</a></div> +<h2><a name="code">Full Code Listing</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> Here is the complete code listing for our running example, enhanced with the @@ -1022,8 +1020,8 @@ extern double putchard(double X) { <a href="mailto:sabre@nondot.org">Chris Lattner</a><br> <a href="mailto:idadesub@users.sourceforge.net">Erick Tryzelaar</a><br> - <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br> - Last modified: $Date: 2010-05-28 19:07:41 +0200 (Fri, 28 May 2010) $ + <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br> + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> </html> diff --git a/docs/tutorial/OCamlLangImpl5.html b/docs/tutorial/OCamlLangImpl5.html index 3173803cfa6b..ca796916ef14 100644 --- a/docs/tutorial/OCamlLangImpl5.html +++ b/docs/tutorial/OCamlLangImpl5.html @@ -12,7 +12,7 @@ <body> -<div class="doc_title">Kaleidoscope: Extending the Language: Control Flow</div> +<h1>Kaleidoscope: Extending the Language: Control Flow</h1> <ul> <li><a href="index.html">Up to Tutorial Index</a></li> @@ -52,10 +52,10 @@ User-defined Operators</li> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="intro">Chapter 5 Introduction</a></div> +<h2><a name="intro">Chapter 5 Introduction</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Welcome to Chapter 5 of the "<a href="index.html">Implementing a language with LLVM</a>" tutorial. Parts 1-4 described the implementation of the simple @@ -69,10 +69,10 @@ have an if/then/else expression plus a simple 'for' loop.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="ifthen">If/Then/Else</a></div> +<h2><a name="ifthen">If/Then/Else</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> Extending Kaleidoscope to support if/then/else is quite straightforward. It @@ -112,15 +112,12 @@ Since Kaleidoscope allows side-effects, this behavior is important to nail down. <p>Now that we know what we "want", lets break this down into its constituent pieces.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="iflexer">Lexer Extensions for -If/Then/Else</a></div> +<h4><a name="iflexer">Lexer Extensions for If/Then/Else</a></h4> <!-- ======================================================================= --> -<div class="doc_text"> +<div> <p>The lexer extensions are straightforward. First we add new variants for the relevant tokens:</p> @@ -153,11 +150,10 @@ stuff:</p> </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="ifast">AST Extensions for - If/Then/Else</a></div> +<h4><a name="ifast">AST Extensions for If/Then/Else</a></h4> <!-- ======================================================================= --> -<div class="doc_text"> +<div> <p>To represent the new expression we add a new AST variant for it:</p> @@ -175,11 +171,10 @@ type expr = </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="ifparser">Parser Extensions for -If/Then/Else</a></div> +<h4><a name="ifparser">Parser Extensions for If/Then/Else</a></h4> <!-- ======================================================================= --> -<div class="doc_text"> +<div> <p>Now that we have the relevant tokens coming from the lexer and we have the AST node to build, our parsing logic is relatively straightforward. First we @@ -214,10 +209,10 @@ let rec parse_primary = parser </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="ifir">LLVM IR for If/Then/Else</a></div> +<h4><a name="ifir">LLVM IR for If/Then/Else</a></h4> <!-- ======================================================================= --> -<div class="doc_text"> +<div> <p>Now that we have it parsing and building the AST, the final piece is adding LLVM code generation support. This is the most interesting part of the @@ -331,11 +326,10 @@ directly.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="ifcodegen">Code Generation for -If/Then/Else</a></div> +<h4><a name="ifcodegen">Code Generation for If/Then/Else</a></h4> <!-- ======================================================================= --> -<div class="doc_text"> +<div> <p>In order to generate code for this, we implement the <tt>Codegen</tt> method for <tt>IfExprAST</tt>:</p> @@ -492,11 +486,13 @@ another useful expression that is familiar from non-functional languages...</p> </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"><a name="for">'for' Loop Expression</a></div> +<h2><a name="for">'for' Loop Expression</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Now that we know how to add basic control flow constructs to the language, we have the tools to add more powerful things. Lets add something more @@ -525,14 +521,11 @@ variables, it will get more useful.</p> <p>As before, lets talk about the changes that we need to Kaleidoscope to support this.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="forlexer">Lexer Extensions for -the 'for' Loop</a></div> +<h4><a name="forlexer">Lexer Extensions for the 'for' Loop</a></h4> <!-- ======================================================================= --> -<div class="doc_text"> +<div> <p>The lexer extensions are the same sort of thing as for if/then/else:</p> @@ -559,11 +552,10 @@ the 'for' Loop</a></div> </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="forast">AST Extensions for -the 'for' Loop</a></div> +<h4><a name="forast">AST Extensions for the 'for' Loop</a></h4> <!-- ======================================================================= --> -<div class="doc_text"> +<div> <p>The AST variant is just as simple. It basically boils down to capturing the variable name and the constituent expressions in the node.</p> @@ -580,11 +572,10 @@ type expr = </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="forparser">Parser Extensions for -the 'for' Loop</a></div> +<h4><a name="forparser">Parser Extensions for the 'for' Loop</a></h4> <!-- ======================================================================= --> -<div class="doc_text"> +<div> <p>The parser code is also fairly standard. The only interesting thing here is handling of the optional step value. The parser code handles it by checking to @@ -628,11 +619,10 @@ let rec parse_primary = parser </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="forir">LLVM IR for -the 'for' Loop</a></div> +<h4><a name="forir">LLVM IR for the 'for' Loop</a></h4> <!-- ======================================================================= --> -<div class="doc_text"> +<div> <p>Now we get to the good part: the LLVM IR we want to generate for this thing. With the simple example above, we get this LLVM IR (note that this dump is @@ -674,11 +664,10 @@ expressions, and some basic blocks. Lets see how this fits together.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="forcodegen">Code Generation for -the 'for' Loop</a></div> +<h4><a name="forcodegen">Code Generation for the 'for' Loop</a></h4> <!-- ======================================================================= --> -<div class="doc_text"> +<div> <p>The first part of Codegen is very simple: we just output the start expression for the loop value:</p> @@ -851,11 +840,13 @@ to our poor innocent language.</p> </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"><a name="code">Full Code Listing</a></div> +<h2><a name="code">Full Code Listing</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> Here is the complete code listing for our running example, enhanced with the @@ -1562,8 +1553,8 @@ operators</a> <a href="mailto:sabre@nondot.org">Chris Lattner</a><br> <a href="mailto:idadesub@users.sourceforge.net">Erick Tryzelaar</a><br> - <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br> - Last modified: $Date: 2010-05-28 19:07:41 +0200 (Fri, 28 May 2010) $ + <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br> + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> </html> diff --git a/docs/tutorial/OCamlLangImpl6.html b/docs/tutorial/OCamlLangImpl6.html index 1d4f8c7509f8..bde429b5afcf 100644 --- a/docs/tutorial/OCamlLangImpl6.html +++ b/docs/tutorial/OCamlLangImpl6.html @@ -12,7 +12,7 @@ <body> -<div class="doc_title">Kaleidoscope: Extending the Language: User-defined Operators</div> +<h1>Kaleidoscope: Extending the Language: User-defined Operators</h1> <ul> <li><a href="index.html">Up to Tutorial Index</a></li> @@ -38,10 +38,10 @@ Variables / SSA Construction</li> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="intro">Chapter 6 Introduction</a></div> +<h2><a name="intro">Chapter 6 Introduction</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Welcome to Chapter 6 of the "<a href="index.html">Implementing a language with LLVM</a>" tutorial. At this point in our tutorial, we now have a fully @@ -64,10 +64,10 @@ an example of what you can build with Kaleidoscope and its feature set.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="idea">User-defined Operators: the Idea</a></div> +<h2><a name="idea">User-defined Operators: the Idea</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> The "operator overloading" that we will add to Kaleidoscope is more general than @@ -129,10 +129,10 @@ operators.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="binary">User-defined Binary Operators</a></div> +<h2><a name="binary">User-defined Binary Operators</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Adding support for user-defined binary operators is pretty simple with our current framework. We'll first add support for the unary/binary keywords:</p> @@ -320,10 +320,10 @@ see what it takes.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="unary">User-defined Unary Operators</a></div> +<h2><a name="unary">User-defined Unary Operators</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Since we don't currently support unary operators in the Kaleidoscope language, we'll need to add everything to support them. Above, we added simple @@ -472,10 +472,10 @@ is simpler primarily because it doesn't need to handle any predefined operators. </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="example">Kicking the Tires</a></div> +<h2><a name="example">Kicking the Tires</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>It is somewhat hard to believe, but with a few simple extensions we've covered in the last chapters, we have grown a real-ish language. With this, we @@ -778,10 +778,10 @@ add variable mutation without building SSA in your front-end.</p> <!-- *********************************************************************** --> -<div class="doc_section"><a name="code">Full Code Listing</a></div> +<h2><a name="code">Full Code Listing</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> Here is the complete code listing for our running example, enhanced with the @@ -1567,8 +1567,8 @@ SSA construction</a> <a href="mailto:sabre@nondot.org">Chris Lattner</a><br> <a href="mailto:idadesub@users.sourceforge.net">Erick Tryzelaar</a><br> - <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br> - Last modified: $Date: 2010-06-21 22:31:30 +0200 (Mon, 21 Jun 2010) $ + <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br> + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> </html> diff --git a/docs/tutorial/OCamlLangImpl7.html b/docs/tutorial/OCamlLangImpl7.html index a9fcd704cf8b..a48e679cecef 100644 --- a/docs/tutorial/OCamlLangImpl7.html +++ b/docs/tutorial/OCamlLangImpl7.html @@ -13,7 +13,7 @@ <body> -<div class="doc_title">Kaleidoscope: Extending the Language: Mutable Variables</div> +<h1>Kaleidoscope: Extending the Language: Mutable Variables</h1> <ul> <li><a href="index.html">Up to Tutorial Index</a></li> @@ -42,10 +42,10 @@ </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="intro">Chapter 7 Introduction</a></div> +<h2><a name="intro">Chapter 7 Introduction</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Welcome to Chapter 7 of the "<a href="index.html">Implementing a language with LLVM</a>" tutorial. In chapters 1 through 6, we've built a very @@ -70,10 +70,10 @@ support for this, though the way it works is a bit unexpected for some.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="why">Why is this a hard problem?</a></div> +<h2><a name="why">Why is this a hard problem?</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> To understand why mutable variables cause complexities in SSA construction, @@ -144,10 +144,10 @@ logic.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="memory">Memory in LLVM</a></div> +<h2><a name="memory">Memory in LLVM</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>The 'trick' here is that while LLVM does require all register values to be in SSA form, it does not require (or permit) memory objects to be in SSA form. @@ -325,11 +325,10 @@ variables now! </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="kalvars">Mutable Variables in -Kaleidoscope</a></div> +<h2><a name="kalvars">Mutable Variables in Kaleidoscope</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Now that we know the sort of problem we want to tackle, lets see what this looks like in the context of our little Kaleidoscope language. We're going to @@ -382,11 +381,10 @@ Kaleidoscope to support new variable definitions. </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="adjustments">Adjusting Existing Variables for -Mutation</a></div> +<h2><a name="adjustments">Adjusting Existing Variables for Mutation</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> The symbol table in Kaleidoscope is managed at code generation time by the @@ -672,10 +670,10 @@ we'll add the assignment operator.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="assignment">New Assignment Operator</a></div> +<h2><a name="assignment">New Assignment Operator</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>With our current framework, adding a new assignment operator is really simple. We will parse it just like any other binary operator, but handle it @@ -773,11 +771,10 @@ add this next! </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="localvars">User-defined Local -Variables</a></div> +<h2><a name="localvars">User-defined Local Variables</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Adding var/in is just like any other other extensions we made to Kaleidoscope: we extend the lexer, the parser, the AST and the code generator. @@ -956,10 +953,10 @@ anywhere in sight.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="code">Full Code Listing</a></div> +<h2><a name="code">Full Code Listing</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p> Here is the complete code listing for our running example, enhanced with mutable @@ -1887,7 +1884,7 @@ extern double printd(double X) { </dd> </dl> -<a href="LangImpl8.html">Next: Conclusion and other useful LLVM tidbits</a> +<a href="OCamlLangImpl8.html">Next: Conclusion and other useful LLVM tidbits</a> </div> <!-- *********************************************************************** --> @@ -1899,9 +1896,9 @@ extern double printd(double X) { src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a> <a href="mailto:sabre@nondot.org">Chris Lattner</a><br> - <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br> + <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br> <a href="mailto:idadesub@users.sourceforge.net">Erick Tryzelaar</a><br> - Last modified: $Date: 2011-01-01 04:27:43 +0100 (Sat, 01 Jan 2011) $ + Last modified: $Date: 2011-04-23 02:30:22 +0200 (Sat, 23 Apr 2011) $ </address> </body> </html> diff --git a/docs/tutorial/OCamlLangImpl8.html b/docs/tutorial/OCamlLangImpl8.html index 64a62002c4cc..eed8c03d21ca 100644 --- a/docs/tutorial/OCamlLangImpl8.html +++ b/docs/tutorial/OCamlLangImpl8.html @@ -11,8 +11,7 @@ <body> -<div class="doc_title">Kaleidoscope: Conclusion and other useful LLVM - tidbits</div> +<h1>Kaleidoscope: Conclusion and other useful LLVM tidbits</h1> <ul> <li><a href="index.html">Up to Tutorial Index</a></li> @@ -43,10 +42,10 @@ </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="conclusion">Tutorial Conclusion</a></div> +<h2><a name="conclusion">Tutorial Conclusion</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Welcome to the the final chapter of the "<a href="index.html">Implementing a language with LLVM</a>" tutorial. In the course of this tutorial, we have grown @@ -154,23 +153,19 @@ are very useful if you want to take advantage of LLVM's capabilities.</p> </div> <!-- *********************************************************************** --> -<div class="doc_section"><a name="llvmirproperties">Properties of the LLVM -IR</a></div> +<h2><a name="llvmirproperties">Properties of the LLVM IR</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>We have a couple common questions about code in the LLVM IR form - lets just get these out of the way right now, shall we?</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="targetindep">Target -Independence</a></div> +<h4><a name="targetindep">Target Independence</a></h4> <!-- ======================================================================= --> -<div class="doc_text"> +<div> <p>Kaleidoscope is an example of a "portable language": any program written in Kaleidoscope will work the same way on any target that it runs on. Many other @@ -221,10 +216,10 @@ in-kernel language.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="safety">Safety Guarantees</a></div> +<h4><a name="safety">Safety Guarantees</a></h4> <!-- ======================================================================= --> -<div class="doc_text"> +<div> <p>Many of the languages above are also "safe" languages: it is impossible for a program written in Java to corrupt its address space and crash the process @@ -243,11 +238,10 @@ list</a> if you are interested in more details.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="langspecific">Language-Specific -Optimizations</a></div> +<h4><a name="langspecific">Language-Specific Optimizations</a></h4> <!-- ======================================================================= --> -<div class="doc_text"> +<div> <p>One thing about LLVM that turns off many people is that it does not solve all the world's problems in one system (sorry 'world hunger', someone else will have @@ -297,24 +291,23 @@ language-specific AST. </div> +</div> + <!-- *********************************************************************** --> -<div class="doc_section"><a name="tipsandtricks">Tips and Tricks</a></div> +<h2><a name="tipsandtricks">Tips and Tricks</a></h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>There is a variety of useful tips and tricks that you come to know after working on/with LLVM that aren't obvious at first glance. Instead of letting everyone rediscover them, this section talks about some of these issues.</p> -</div> - <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="offsetofsizeof">Implementing portable -offsetof/sizeof</a></div> +<h4><a name="offsetofsizeof">Implementing portable offsetof/sizeof</a></h4> <!-- ======================================================================= --> -<div class="doc_text"> +<div> <p>One interesting thing that comes up, if you are trying to keep the code generated by your compiler "target independent", is that you often need to know @@ -331,11 +324,10 @@ in a portable way.</p> </div> <!-- ======================================================================= --> -<div class="doc_subsubsection"><a name="gcstack">Garbage Collected -Stack Frames</a></div> +<h4><a name="gcstack">Garbage Collected Stack Frames</a></h4> <!-- ======================================================================= --> -<div class="doc_text"> +<div> <p>Some languages want to explicitly manage their stack frames, often so that they are garbage collected or to allow easy implementation of closures. There @@ -349,6 +341,8 @@ Passing Style</a> and the use of tail calls (which LLVM also supports).</p> </div> +</div> + <!-- *********************************************************************** --> <hr> <address> @@ -358,7 +352,7 @@ Passing Style</a> and the use of tail calls (which LLVM also supports).</p> src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a> <a href="mailto:sabre@nondot.org">Chris Lattner</a><br> - <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br> + <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br> Last modified: $Date$ </address> </body> diff --git a/docs/tutorial/index.html b/docs/tutorial/index.html index 11dd5e2d732a..0a8cae2c2c9b 100644 --- a/docs/tutorial/index.html +++ b/docs/tutorial/index.html @@ -12,7 +12,7 @@ <body> -<div class="doc_title"> LLVM Tutorial: Table of Contents </div> +<h1>LLVM Tutorial: Table of Contents</h1> <ol> <li>Kaleidoscope: Implementing a Language with LLVM |