Gitiles
Code Review Sign In
gerrit-public.fairphone.software / toolchain / llvm-project / 3e149a2c90ffd0ae386459401eb610b615b5498d / . / llvm / docs / WritingAnLLVMPass.html
blob: b26932752eb2065f15d9042391ec1db2b6baedbb [file] [log] [blame]
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
3<html>
4<head>
Reid Spencer4a1ab182005-01-11 05:16:23 +0000[diff] [blame]5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]6 <title>Writing an LLVM Pass</title>
7 <link rel="stylesheet" href="llvm.css" type="text/css">
8</head>
9<body>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]10
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]11<div class="doc_title">
12 Writing an LLVM Pass
13</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]14
15<ol>
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]16 <li><a href="#introduction">Introduction - What is a pass?</a></li>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]17 <li><a href="#quickstart">Quick Start - Writing hello world</a>
18 <ul>
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]19 <li><a href="#makefile">Setting up the build environment</a></li>
20 <li><a href="#basiccode">Basic code required</a></li>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]21 <li><a href="#running">Running a pass with <tt>opt</tt>
Chris Lattner9e4be6f2004-09-18 06:39:35 +0000[diff] [blame]22 or <tt>analyze</tt></a></li>
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]23 </ul></li>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]24 <li><a href="#passtype">Pass classes and requirements</a>
25 <ul>
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]26 <li><a href="#ImmutablePass">The <tt>ImmutablePass</tt> class</a></li>
Chris Lattner3c11c042004-09-20 04:36:29 +0000[diff] [blame]27 <li><a href="#ModulePass">The <tt>ModulePass</tt> class</a>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]28 <ul>
Chris Lattner3c11c042004-09-20 04:36:29 +0000[diff] [blame]29 <li><a href="#runOnModule">The <tt>runOnModule</tt> method</a></li>
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]30 </ul></li>
Chris Lattner9e4be6f2004-09-18 06:39:35 +0000[diff] [blame]31 <li><a href="#CallGraphSCCPass">The <tt>CallGraphSCCPass</tt> class</a>
32 <ul>
33 <li><a href="#doInitialization_scc">The <tt>doInitialization(Module
34 &amp;)</tt> method</a></li>
35 <li><a href="#runOnSCC">The <tt>runOnSCC</tt> method</a></li>
36 <li><a href="#doFinalization_scc">The <tt>doFinalization(Module
37 &amp;)</tt> method</a></li>
38 </ul></li>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]39 <li><a href="#FunctionPass">The <tt>FunctionPass</tt> class</a>
40 <ul>
Chris Lattner5e08e70f2002-09-12 17:06:43 +0000[diff] [blame]41 <li><a href="#doInitialization_mod">The <tt>doInitialization(Module
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]42 &amp;)</tt> method</a></li>
43 <li><a href="#runOnFunction">The <tt>runOnFunction</tt> method</a></li>
Chris Lattner5e08e70f2002-09-12 17:06:43 +0000[diff] [blame]44 <li><a href="#doFinalization_mod">The <tt>doFinalization(Module
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]45 &amp;)</tt> method</a></li>
46 </ul></li>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]47 <li><a href="#BasicBlockPass">The <tt>BasicBlockPass</tt> class</a>
48 <ul>
Chris Lattner5e08e70f2002-09-12 17:06:43 +0000[diff] [blame]49 <li><a href="#doInitialization_fn">The <tt>doInitialization(Function
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]50 &amp;)</tt> method</a></li>
51 <li><a href="#runOnBasicBlock">The <tt>runOnBasicBlock</tt>
52 method</a></li>
Chris Lattner5e08e70f2002-09-12 17:06:43 +0000[diff] [blame]53 <li><a href="#doFinalization_fn">The <tt>doFinalization(Function
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]54 &amp;)</tt> method</a></li>
55 </ul></li>
Brian Gaeke110f07b2003-07-17 18:53:20 +0000[diff] [blame]56 <li><a href="#MachineFunctionPass">The <tt>MachineFunctionPass</tt>
57 class</a>
Brian Gaeke673ef4d2003-07-22 20:53:20 +0000[diff] [blame]58 <ul>
59 <li><a href="#runOnMachineFunction">The
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]60 <tt>runOnMachineFunction(MachineFunction &amp;)</tt> method</a></li>
61 </ul></li>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]62 </ul>
63 <li><a href="#registration">Pass Registration</a>
64 <ul>
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]65 <li><a href="#print">The <tt>print</tt> method</a></li>
66 </ul></li>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]67 <li><a href="#interaction">Specifying interactions between passes</a>
68 <ul>
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]69 <li><a href="#getAnalysisUsage">The <tt>getAnalysisUsage</tt>
70 method</a></li>
Chris Lattner8e871652004-03-17 21:09:55 +0000[diff] [blame]71 <li><a href="#AU::addRequired">The <tt>AnalysisUsage::addRequired&lt;&gt;</tt> and <tt>AnalysisUsage::addRequiredTransitive&lt;&gt;</tt> methods</a></li>
72 <li><a href="#AU::addPreserved">The <tt>AnalysisUsage::addPreserved&lt;&gt;</tt> method</a></li>
73 <li><a href="#AU::examples">Example implementations of <tt>getAnalysisUsage</tt></a></li>
74 <li><a href="#getAnalysis">The <tt>getAnalysis&lt;&gt;</tt> and <tt>getAnalysisToUpdate&lt;&gt;</tt> methods</a></li>
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]75 </ul></li>
Chris Lattner8d8a9282002-08-22 19:21:04 +0000[diff] [blame]76 <li><a href="#analysisgroup">Implementing Analysis Groups</a>
77 <ul>
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]78 <li><a href="#agconcepts">Analysis Group Concepts</a></li>
79 <li><a href="#registerag">Using <tt>RegisterAnalysisGroup</tt></a></li>
80 </ul></li>
Tanya Lattnerfb966ba2004-11-19 01:25:14 +0000[diff] [blame]81 <li><a href="#passStatistics">Pass Statistics</a>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]82 <li><a href="#passmanager">What PassManager does</a>
83 <ul>
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]84 <li><a href="#releaseMemory">The <tt>releaseMemory</tt> method</a></li>
85 </ul></li>
Chris Lattner8a97c8a2002-09-06 02:02:58 +0000[diff] [blame]86 <li><a href="#debughints">Using GDB with dynamically loaded passes</a>
87 <ul>
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]88 <li><a href="#breakpoint">Setting a breakpoint in your pass</a></li>
89 <li><a href="#debugmisc">Miscellaneous Problems</a></li>
90 </ul></li>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]91 <li><a href="#future">Future extensions planned</a>
92 <ul>
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]93 <li><a href="#SMP">Multithreaded LLVM</a></li>
Chris Lattner3c11c042004-09-20 04:36:29 +0000[diff] [blame]94 <li><a href="#PassFunctionPass"><tt>ModulePass</tt>es requiring
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]95 <tt>FunctionPass</tt>es</a></li>
96 </ul></li>
97</ol>
Chris Lattner56d9e222002-08-08 20:23:41 +0000[diff] [blame]98
Chris Lattner020e1fc2004-05-23 21:07:27 +0000[diff] [blame]99<div class="doc_author">
100 <p>Written by <a href="mailto:sabre@nondot.org">Chris Lattner</a></p>
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]101</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]102
103<!-- *********************************************************************** -->
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]104<div class="doc_section">
105 <a name="introduction">Introduction - What is a pass?</a>
106</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]107<!-- *********************************************************************** -->
108
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]109<div class="doc_text">
110
111<p>The LLVM Pass Framework is an important part of the LLVM system, because LLVM
Chris Lattner9e4be6f2004-09-18 06:39:35 +0000[diff] [blame]112passes are where most of the interesting parts of the compiler exist. Passes
113perform the transformations and optimizations that make up the compiler, they
114build the analysis results that are used by these transformations, and they are,
115above all, a structuring technique for compiler code.</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]116
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]117<p>All LLVM passes are subclasses of the <tt><a
118href="http://llvm.cs.uiuc.edu/doxygen/classllvm_1_1Pass.html">Pass</a></tt>
119class, which implement functionality by overriding virtual methods inherited
Chris Lattner3c11c042004-09-20 04:36:29 +0000[diff] [blame]120from <tt>Pass</tt>. Depending on how your pass works, you should inherit from
121the <tt><a href="#ModulePass">ModulePass</a></tt>, <tt><a
122href="#CallGraphSCCPass">CallGraphSCCPass</a></tt>, <tt><a
123href="#FunctionPass">FunctionPass</a></tt>, or <tt><a
Chris Lattner9e4be6f2004-09-18 06:39:35 +0000[diff] [blame]124href="#BasicBlockPass">BasicBlockPass</a></tt> classes, which gives the system
125more information about what your pass does, and how it can be combined with
126other passes. One of the main features of the LLVM Pass Framework is that it
127schedules passes to run in an efficient way based on the constraints that your
128pass meets (which are indicated by which class they derive from).</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]129
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]130<p>We start by showing you how to construct a pass, everything from setting up
131the code, to compiling, loading, and executing it. After the basics are down,
132more advanced features are discussed.</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]133
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]134</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]135
136<!-- *********************************************************************** -->
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]137<div class="doc_section">
138 <a name="quickstart">Quick Start - Writing hello world</a>
139</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]140<!-- *********************************************************************** -->
141
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]142<div class="doc_text">
143
144<p>Here we describe how to write the "hello world" of passes. The "Hello" pass
145is designed to simply print out the name of non-external functions that exist in
Chris Lattner9e4be6f2004-09-18 06:39:35 +0000[diff] [blame]146the program being compiled. It does not modify the program at all, it just
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]147inspects it. The source code and files for this pass are available in the LLVM
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]148source tree in the <tt>lib/Transforms/Hello</tt> directory.</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]149
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]150</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]151
152<!-- ======================================================================= -->
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]153<div class="doc_subsection">
154 <a name="makefile">Setting up the build environment</a>
155</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]156
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]157<div class="doc_text">
158
Reid Spencera1799682004-12-11 05:12:57 +0000[diff] [blame]159 <p>First, you need to create a new directory somewhere in the LLVM source
160 base. For this example, we'll assume that you made
161 <tt>lib/Transforms/Hello</tt>. Next, you must set up a build script
162 (Makefile) that will compile the source code for the new pass. To do this,
163 copy the following into <tt>Makefile</tt>:</p>
164 <hr/>
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]165
166<pre>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]167# Makefile for hello pass
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]168
Chris Lattnereb4ba3c2002-08-14 20:06:13 +0000[diff] [blame]169# Path to top level of LLVM heirarchy
Chris Lattner0c5e2932002-08-14 20:07:01 +0000[diff] [blame]170LEVEL = ../../..
Chris Lattnereb4ba3c2002-08-14 20:06:13 +0000[diff] [blame]171
172# Name of the library to build
Reid Spencer4a1ab182005-01-11 05:16:23 +0000[diff] [blame]173LIBRARYNAME = Hello
Chris Lattnereb4ba3c2002-08-14 20:06:13 +0000[diff] [blame]174
Reid Spencer4a1ab182005-01-11 05:16:23 +0000[diff] [blame]175# Build a dynamically linkable shared object
Chris Lattnereb4ba3c2002-08-14 20:06:13 +0000[diff] [blame]176SHARED_LIBRARY = 1
177
Reid Spencer4a1ab182005-01-11 05:16:23 +0000[diff] [blame]178# Make the shared library become a loadable module so the tools can
179# dlopen/dlsym on the resulting library.
180LOADABLE_MODULE
181
Chris Lattnereb4ba3c2002-08-14 20:06:13 +0000[diff] [blame]182# Include the makefile implementation stuff
183include $(LEVEL)/Makefile.common
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]184</pre>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]185
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]186<p>This makefile specifies that all of the <tt>.cpp</tt> files in the current
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]187directory are to be compiled and linked together into a
Reid Spencer4a1ab182005-01-11 05:16:23 +0000[diff] [blame]188<tt>Debug/lib/Hello.so</tt> shared object that can be dynamically loaded by
189the <tt>opt</tt> or <tt>analyze</tt> tools via their <tt>-load</tt> options.
190If your operating system uses a suffix other than .so (such as windows or
191Mac OS/X), the appropriate extension will be used.</p>
John Criswell2edea842004-01-26 21:26:54 +0000[diff] [blame]192
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]193<p>Now that we have the build scripts set up, we just need to write the code for
194the pass itself.</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]195
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]196</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]197
198<!-- ======================================================================= -->
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]199<div class="doc_subsection">
200 <a name="basiccode">Basic code required</a>
201</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]202
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]203<div class="doc_text">
204
205<p>Now that we have a way to compile our new pass, we just have to write it.
206Start out with:</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]207
208<pre>
209<b>#include</b> "<a href="http://llvm.cs.uiuc.edu/doxygen/Pass_8h-source.html">llvm/Pass.h</a>"
210<b>#include</b> "<a href="http://llvm.cs.uiuc.edu/doxygen/Function_8h-source.html">llvm/Function.h</a>"
211</pre>
212
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]213<p>Which are needed because we are writing a <tt><a
214href="http://llvm.cs.uiuc.edu/doxygen/classllvm_1_1Pass.html">Pass</a></tt>, and
215we are operating on <tt><a
216href="http://llvm.cs.uiuc.edu/doxygen/classllvm_1_1Function.html">Function</a></tt>'s.</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]217
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]218<p>Next we have:</p>
Jonathan Mantonaff4a6a2004-06-30 18:10:30 +0000[diff] [blame]219<pre>
220<b>using namespace llvm;</b>
221</pre>
222<p>... which is required because the functions from the include files
223live in the llvm namespace.
224</p>
225
226<p>Next we have:</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]227
228<pre>
229<b>namespace</b> {
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]230</pre>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]231
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]232<p>... which starts out an anonymous namespace. Anonymous namespaces are to C++
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]233what the "<tt>static</tt>" keyword is to C (at global scope). It makes the
234things declared inside of the anonymous namespace only visible to the current
235file. If you're not familiar with them, consult a decent C++ book for more
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]236information.</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]237
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]238<p>Next, we declare our pass itself:</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]239
240<pre>
241 <b>struct</b> Hello : <b>public</b> <a href="#FunctionPass">FunctionPass</a> {
242</pre><p>
243
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]244<p>This declares a "<tt>Hello</tt>" class that is a subclass of <tt><a
Chris Lattnerb7848972005-04-21 04:53:58 +0000[diff] [blame]245href="http://llvm.cs.uiuc.edu/doxygen/classllvm_1_1FunctionPass.html">FunctionPass</a></tt>.
Chris Lattnera818d922002-09-09 03:48:46 +0000[diff] [blame]246The different builtin pass subclasses are described in detail <a
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]247href="#passtype">later</a>, but for now, know that <a
248href="#FunctionPass"><tt>FunctionPass</tt></a>'s operate a function at a
249time.</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]250
251<pre>
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]252 <b>virtual bool</b> <a href="#runOnFunction">runOnFunction</a>(Function &amp;F) {
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]253 std::cerr &lt;&lt; "<i>Hello: </i>" &lt;&lt; F.getName() &lt;&lt; "\n";
254 <b>return false</b>;
255 }
256 }; <i>// end of struct Hello</i>
257</pre>
258
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]259<p>We declare a "<a href="#runOnFunction"><tt>runOnFunction</tt></a>" method,
260which overloads an abstract virtual method inherited from <a
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]261href="#FunctionPass"><tt>FunctionPass</tt></a>. This is where we are supposed
262to do our thing, so we just print out our message with the name of each
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]263function.</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]264
265<pre>
266 RegisterOpt&lt;Hello&gt; X("<i>hello</i>", "<i>Hello World Pass</i>");
267} <i>// end of anonymous namespace</i>
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]268</pre>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]269
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]270<p>Lastly, we register our class <tt>Hello</tt>, giving it a command line
271argument "<tt>hello</tt>", and a name "<tt>Hello World Pass</tt>". There are
272several different ways of <a href="#registration">registering your pass</a>,
273depending on what it is to be used for. For "optimizations" we use the
274<tt>RegisterOpt</tt> template.</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]275
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]276<p>As a whole, the <tt>.cpp</tt> file looks like:</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]277
278<pre>
279<b>#include</b> "<a href="http://llvm.cs.uiuc.edu/doxygen/Pass_8h-source.html">llvm/Pass.h</a>"
280<b>#include</b> "<a href="http://llvm.cs.uiuc.edu/doxygen/Function_8h-source.html">llvm/Function.h</a>"
281
Jonathan Mantonaff4a6a2004-06-30 18:10:30 +0000[diff] [blame]282<b>using namespace llvm;</b>
283
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]284<b>namespace</b> {
285 <b>struct Hello</b> : <b>public</b> <a href="#FunctionPass">FunctionPass</a> {
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]286 <b>virtual bool</b> <a href="#runOnFunction">runOnFunction</a>(Function &amp;F) {
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]287 std::cerr &lt;&lt; "<i>Hello: </i>" &lt;&lt; F.getName() &lt;&lt; "\n";
288 <b>return false</b>;
289 }
290 };
291
292 RegisterOpt&lt;Hello&gt; X("<i>hello</i>", "<i>Hello World Pass</i>");
293}
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]294</pre>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]295
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]296<p>Now that it's all together, compile the file with a simple "<tt>gmake</tt>"
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]297command in the local directory and you should get a new
Reid Spencer4a1ab182005-01-11 05:16:23 +0000[diff] [blame]298"<tt>Debug/lib/Hello.so</tt> file. Note that everything in this file is
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]299contained in an anonymous namespace: this reflects the fact that passes are self
300contained units that do not need external interfaces (although they can have
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]301them) to be useful.</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]302
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]303</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]304
305<!-- ======================================================================= -->
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]306<div class="doc_subsection">
307 <a name="running">Running a pass with <tt>opt</tt> or <tt>analyze</tt></a>
308</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]309
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]310<div class="doc_text">
311
John Criswell2edea842004-01-26 21:26:54 +0000[diff] [blame]312<p>Now that you have a brand new shiny shared object file, we can use the
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]313<tt>opt</tt> command to run an LLVM program through your pass. Because you
314registered your pass with the <tt>RegisterOpt</tt> template, you will be able to
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]315use the <tt>opt</tt> tool to access it, once loaded.</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]316
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]317<p>To test it, follow the example at the end of the <a
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]318href="GettingStarted.html">Getting Started Guide</a> to compile "Hello World" to
319LLVM. We can now run the bytecode file (<tt>hello.bc</tt>) for the program
320through our transformation like this (or course, any bytecode file will
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]321work):</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]322
323<pre>
Reid Spencer4a1ab182005-01-11 05:16:23 +0000[diff] [blame]324$ opt -load ../../../Debug/lib/Hello.so -hello &lt; hello.bc &gt; /dev/null
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]325Hello: __main
326Hello: puts
327Hello: main
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]328</pre>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]329
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]330<p>The '<tt>-load</tt>' option specifies that '<tt>opt</tt>' should load your
331pass as a shared object, which makes '<tt>-hello</tt>' a valid command line
332argument (which is one reason you need to <a href="#registration">register your
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]333pass</a>). Because the hello pass does not modify the program in any
334interesting way, we just throw away the result of <tt>opt</tt> (sending it to
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]335<tt>/dev/null</tt>).</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]336
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]337<p>To see what happened to the other string you registered, try running
338<tt>opt</tt> with the <tt>--help</tt> option:</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]339
340<pre>
Reid Spencer4a1ab182005-01-11 05:16:23 +0000[diff] [blame]341$ opt -load ../../../Debug/lib/Hello.so --help
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]342OVERVIEW: llvm .bc -&gt; .bc modular optimizer
343
344USAGE: opt [options] &lt;input bytecode&gt;
345
346OPTIONS:
347 Optimizations available:
348...
349 -funcresolve - Resolve Functions
350 -gcse - Global Common Subexpression Elimination
351 -globaldce - Dead Global Elimination
352 <b>-hello - Hello World Pass</b>
Chris Lattner216c7b82003-09-10 05:29:43 +0000[diff] [blame]353 -indvars - Canonicalize Induction Variables
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]354 -inline - Function Integration/Inlining
355 -instcombine - Combine redundant instructions
356...
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]357</pre>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]358
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]359<p>The pass name get added as the information string for your pass, giving some
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]360documentation to users of <tt>opt</tt>. Now that you have a working pass, you
361would go ahead and make it do the cool transformations you want. Once you get
362it all working and tested, it may become useful to find out how fast your pass
363is. The <a href="#passManager"><tt>PassManager</tt></a> provides a nice command
364line option (<tt>--time-passes</tt>) that allows you to get information about
365the execution time of your pass along with the other passes you queue up. For
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]366example:</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]367
368<pre>
Reid Spencer4a1ab182005-01-11 05:16:23 +0000[diff] [blame]369$ opt -load ../../../Debug/lib/Hello.so -hello -time-passes &lt; hello.bc &gt; /dev/null
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]370Hello: __main
371Hello: puts
372Hello: main
373===============================================================================
374 ... Pass execution timing report ...
375===============================================================================
376 Total Execution Time: 0.02 seconds (0.0479059 wall clock)
377
378 ---User Time--- --System Time-- --User+System-- ---Wall Time--- --- Pass Name ---
379 0.0100 (100.0%) 0.0000 ( 0.0%) 0.0100 ( 50.0%) 0.0402 ( 84.0%) Bytecode Writer
380 0.0000 ( 0.0%) 0.0100 (100.0%) 0.0100 ( 50.0%) 0.0031 ( 6.4%) Dominator Set Construction
381 0.0000 ( 0.0%) 0.0000 ( 0.0%) 0.0000 ( 0.0%) 0.0013 ( 2.7%) Module Verifier
382 <b> 0.0000 ( 0.0%) 0.0000 ( 0.0%) 0.0000 ( 0.0%) 0.0033 ( 6.9%) Hello World Pass</b>
383 0.0100 (100.0%) 0.0100 (100.0%) 0.0200 (100.0%) 0.0479 (100.0%) TOTAL
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]384</pre>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]385
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]386<p>As you can see, our implementation above is pretty fast :). The additional
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]387passes listed are automatically inserted by the '<tt>opt</tt>' tool to verify
388that the LLVM emitted by your pass is still valid and well formed LLVM, which
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]389hasn't been broken somehow.</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]390
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]391<p>Now that you have seen the basics of the mechanics behind passes, we can talk
392about some more details of how they work and how to use them.</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]393
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]394</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]395
396<!-- *********************************************************************** -->
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]397<div class="doc_section">
398 <a name="passtype">Pass classes and requirements</a>
399</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]400<!-- *********************************************************************** -->
401
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]402<div class="doc_text">
403
404<p>One of the first things that you should do when designing a new pass is to
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]405decide what class you should subclass for your pass. The <a
406href="#basiccode">Hello World</a> example uses the <tt><a
407href="#FunctionPass">FunctionPass</a></tt> class for its implementation, but we
408did not discuss why or when this should occur. Here we talk about the classes
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]409available, from the most general to the most specific.</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]410
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]411<p>When choosing a superclass for your Pass, you should choose the <b>most
Chris Lattner8d8a9282002-08-22 19:21:04 +0000[diff] [blame]412specific</b> class possible, while still being able to meet the requirements
Misha Brukman7eb05a12003-08-18 14:43:39 +0000[diff] [blame]413listed. This gives the LLVM Pass Infrastructure information necessary to
Chris Lattner8d8a9282002-08-22 19:21:04 +0000[diff] [blame]414optimize how passes are run, so that the resultant compiler isn't unneccesarily
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]415slow.</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]416
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]417</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]418
Chris Lattner9720dda2002-09-25 22:31:38 +0000[diff] [blame]419<!-- ======================================================================= -->
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]420<div class="doc_subsection">
421 <a name="ImmutablePass">The <tt>ImmutablePass</tt> class</a>
422</div>
Chris Lattner9720dda2002-09-25 22:31:38 +0000[diff] [blame]423
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]424<div class="doc_text">
425
426<p>The most plain and boring type of pass is the "<tt><a
Chris Lattnerb7848972005-04-21 04:53:58 +0000[diff] [blame]427href="http://llvm.cs.uiuc.edu/doxygen/classllvm_1_1ImmutablePass.html">ImmutablePass</a></tt>"
Chris Lattner9720dda2002-09-25 22:31:38 +0000[diff] [blame]428class. This pass type is used for passes that do not have to be run, do not
429change state, and never need to be updated. This is not a normal type of
430transformation or analysis, but can provide information about the current
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]431compiler configuration.</p>
Chris Lattner9720dda2002-09-25 22:31:38 +0000[diff] [blame]432
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]433<p>Although this pass class is very infrequently used, it is important for
Chris Lattner9720dda2002-09-25 22:31:38 +0000[diff] [blame]434providing information about the current target machine being compiled for, and
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]435other static information that can affect the various transformations.</p>
Chris Lattner9720dda2002-09-25 22:31:38 +0000[diff] [blame]436
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]437<p><tt>ImmutablePass</tt>es never invalidate other transformations, are never
438invalidated, and are never "run".</p>
Chris Lattner9720dda2002-09-25 22:31:38 +0000[diff] [blame]439
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]440</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]441
442<!-- ======================================================================= -->
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]443<div class="doc_subsection">
Chris Lattner3c11c042004-09-20 04:36:29 +0000[diff] [blame]444 <a name="ModulePass">The <tt>ModulePass</tt> class</a>
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]445</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]446
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]447<div class="doc_text">
448
449<p>The "<tt><a
Chris Lattner3c11c042004-09-20 04:36:29 +0000[diff] [blame]450href="http://llvm.cs.uiuc.edu/doxygen/classllvm_1_1ModulePass.html">ModulePass</a></tt>"
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]451class is the most general of all superclasses that you can use. Deriving from
Chris Lattner3c11c042004-09-20 04:36:29 +0000[diff] [blame]452<tt>ModulePass</tt> indicates that your pass uses the entire program as a unit,
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]453refering to function bodies in no predictable order, or adding and removing
Chris Lattner3c11c042004-09-20 04:36:29 +0000[diff] [blame]454functions. Because nothing is known about the behavior of <tt>ModulePass</tt>
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]455subclasses, no optimization can be done for their execution.</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]456
Chris Lattner3c11c042004-09-20 04:36:29 +0000[diff] [blame]457<p>To write a correct <tt>ModulePass</tt> subclass, derive from
458<tt>ModulePass</tt> and overload the <tt>runOnModule</tt> method with the
459following signature:</p>
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]460
461</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]462
463<!-- _______________________________________________________________________ -->
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]464<div class="doc_subsubsection">
Chris Lattner3c11c042004-09-20 04:36:29 +0000[diff] [blame]465 <a name="runOnModule">The <tt>runOnModule</tt> method</a>
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]466</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]467
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]468<div class="doc_text">
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]469
470<pre>
Chris Lattner3c11c042004-09-20 04:36:29 +0000[diff] [blame]471 <b>virtual bool</b> runOnModule(Module &amp;M) = 0;
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]472</pre>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]473
John Criswella3f51102005-07-15 19:25:12 +0000[diff] [blame]474<p>The <tt>runOnModule</tt> method performs the interesting work of the pass.
475It should return true if the module was modified by the transformation and
476false otherwise.</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]477
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]478</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]479
480<!-- ======================================================================= -->
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]481<div class="doc_subsection">
Chris Lattner9e4be6f2004-09-18 06:39:35 +0000[diff] [blame]482 <a name="CallGraphSCCPass">The <tt>CallGraphSCCPass</tt> class</a>
483</div>
484
485<div class="doc_text">
486
487<p>The "<tt><a
Chris Lattnerb7848972005-04-21 04:53:58 +0000[diff] [blame]488href="http://llvm.cs.uiuc.edu/doxygen/classllvm_1_1CallGraphSCCPass.html">CallGraphSCCPass</a></tt>"
Chris Lattner9e4be6f2004-09-18 06:39:35 +0000[diff] [blame]489is used by passes that need to traverse the program bottom-up on the call graph
490(callees before callers). Deriving from CallGraphSCCPass provides some
491mechanics for building and traversing the CallGraph, but also allows the system
492to optimize execution of CallGraphSCCPass's. If your pass meets the
493requirements outlined below, and doesn't meet the requirements of a <tt><a
494href="#FunctionPass">FunctionPass</a></tt> or <tt><a
495href="#BasicBlockPass">BasicBlockPass</a></tt>, you should derive from
496<tt>CallGraphSCCPass</tt>.</p>
497
498<p><b>TODO</b>: explain briefly what SCC, Tarjan's algo, and B-U mean.</p>
499
500<p>To be explicit, <tt>CallGraphSCCPass</tt> subclasses are:</p>
501
502<ol>
503
504<li>... <em>not allowed</em> to modify any <tt>Function</tt>s that are not in
505the current SCC.</li>
506
507<li>... <em>allowed</em> to inspect any Function's other than those in the
508current SCC and the direct callees of the SCC.</li>
509
510<li>... <em>required</em> to preserve the current CallGraph object, updating it
511to reflect any changes made to the program.</li>
512
513<li>... <em>not allowed</em> to add or remove SCC's from the current Module,
514though they may change the contents of an SCC.</li>
515
516<li>... <em>allowed</em> to add or remove global variables from the current
517Module.</li>
518
519<li>... <em>allowed</em> to maintain state across invocations of
520 <a href="#runOnSCC"><tt>runOnSCC</tt></a> (including global data).</li>
521</ol>
522
523<p>Implementing a <tt>CallGraphSCCPass</tt> is slightly tricky in some cases
524because it has to handle SCCs with more than one node in it. All of the virtual
525methods described below should return true if they modified the program, or
526false if they didn't.</p>
527
528</div>
529
530<!-- _______________________________________________________________________ -->
531<div class="doc_subsubsection">
532 <a name="doInitialization_scc">The <tt>doInitialization(Module &amp;)</tt>
533 method</a>
534</div>
535
536<div class="doc_text">
537
538<pre>
539 <b>virtual bool</b> doInitialization(Module &amp;M);
540</pre>
541
542<p>The <tt>doIninitialize</tt> method is allowed to do most of the things that
543<tt>CallGraphSCCPass</tt>'s are not allowed to do. They can add and remove
544functions, get pointers to functions, etc. The <tt>doInitialization</tt> method
545is designed to do simple initialization type of stuff that does not depend on
546the SCCs being processed. The <tt>doInitialization</tt> method call is not
547scheduled to overlap with any other pass executions (thus it should be very
548fast).</p>
549
550</div>
551
552<!-- _______________________________________________________________________ -->
553<div class="doc_subsubsection">
554 <a name="runOnSCC">The <tt>runOnSCC</tt> method</a>
555</div>
556
557<div class="doc_text">
558
559<pre>
560 <b>virtual bool</b> runOnSCC(const std::vector&lt;CallGraphNode *&gt; &amp;SCCM) = 0;
561</pre>
562
563<p>The <tt>runOnSCC</tt> method performs the interesting work of the pass, and
564should return true if the module was modified by the transformation, false
565otherwise.</p>
566
567</div>
568
569<!-- _______________________________________________________________________ -->
570<div class="doc_subsubsection">
571 <a name="doFinalization_scc">The <tt>doFinalization(Module
572 &amp;)</tt> method</a>
573</div>
574
575<div class="doc_text">
576
577<pre>
578 <b>virtual bool</b> doFinalization(Module &amp;M);
579</pre>
580
581<p>The <tt>doFinalization</tt> method is an infrequently used method that is
582called when the pass framework has finished calling <a
583href="#runOnFunction"><tt>runOnFunction</tt></a> for every function in the
584program being compiled.</p>
585
586</div>
587
588<!-- ======================================================================= -->
589<div class="doc_subsection">
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]590 <a name="FunctionPass">The <tt>FunctionPass</tt> class</a>
591</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]592
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]593<div class="doc_text">
594
Chris Lattner3c11c042004-09-20 04:36:29 +0000[diff] [blame]595<p>In contrast to <tt>ModulePass</tt> subclasses, <tt><a
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]596href="http://llvm.cs.uiuc.edu/doxygen/classllvm_1_1Pass.html">FunctionPass</a></tt>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]597subclasses do have a predictable, local behavior that can be expected by the
598system. All <tt>FunctionPass</tt> execute on each function in the program
Misha Brukmanbe372b92003-08-21 22:14:26 +0000[diff] [blame]599independent of all of the other functions in the program.
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]600<tt>FunctionPass</tt>'s do not require that they are executed in a particular
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]601order, and <tt>FunctionPass</tt>'s do not modify external functions.</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]602
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]603<p>To be explicit, <tt>FunctionPass</tt> subclasses are not allowed to:</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]604
605<ol>
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]606<li>Modify a Function other than the one currently being processed.</li>
607<li>Add or remove Function's from the current Module.</li>
608<li>Add or remove global variables from the current Module.</li>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]609<li>Maintain state across invocations of
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]610 <a href="#runOnFunction"><tt>runOnFunction</tt></a> (including global data)</li>
611</ol>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]612
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]613<p>Implementing a <tt>FunctionPass</tt> is usually straightforward (See the <a
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]614href="#basiccode">Hello World</a> pass for example). <tt>FunctionPass</tt>'s
615may overload three virtual methods to do their work. All of these methods
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]616should return true if they modified the program, or false if they didn't.</p>
617
618</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]619
620<!-- _______________________________________________________________________ -->
Chris Lattner8e871652004-03-17 21:09:55 +0000[diff] [blame]621<div class="doc_subsubsection">
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]622 <a name="doInitialization_mod">The <tt>doInitialization(Module &amp;)</tt>
623 method</a>
624</div>
625
626<div class="doc_text">
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]627
628<pre>
629 <b>virtual bool</b> doInitialization(Module &amp;M);
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]630</pre>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]631
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]632<p>The <tt>doIninitialize</tt> method is allowed to do most of the things that
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]633<tt>FunctionPass</tt>'s are not allowed to do. They can add and remove
Chris Lattner5e08e70f2002-09-12 17:06:43 +0000[diff] [blame]634functions, get pointers to functions, etc. The <tt>doInitialization</tt> method
635is designed to do simple initialization type of stuff that does not depend on
636the functions being processed. The <tt>doInitialization</tt> method call is not
637scheduled to overlap with any other pass executions (thus it should be very
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]638fast).</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]639
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]640<p>A good example of how this method should be used is the <a
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]641href="http://llvm.cs.uiuc.edu/doxygen/LowerAllocations_8cpp-source.html">LowerAllocations</a>
642pass. This pass converts <tt>malloc</tt> and <tt>free</tt> instructions into
Misha Brukmanbe372b92003-08-21 22:14:26 +0000[diff] [blame]643platform dependent <tt>malloc()</tt> and <tt>free()</tt> function calls. It
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]644uses the <tt>doInitialization</tt> method to get a reference to the malloc and
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]645free functions that it needs, adding prototypes to the module if necessary.</p>
646
647</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]648
649<!-- _______________________________________________________________________ -->
Chris Lattner8e871652004-03-17 21:09:55 +0000[diff] [blame]650<div class="doc_subsubsection">
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]651 <a name="runOnFunction">The <tt>runOnFunction</tt> method</a>
652</div>
653
654<div class="doc_text">
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]655
656<pre>
657 <b>virtual bool</b> runOnFunction(Function &amp;F) = 0;
658</pre><p>
659
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]660<p>The <tt>runOnFunction</tt> method must be implemented by your subclass to do
661the transformation or analysis work of your pass. As usual, a true value should
662be returned if the function is modified.</p>
663
664</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]665
666<!-- _______________________________________________________________________ -->
Chris Lattner8e871652004-03-17 21:09:55 +0000[diff] [blame]667<div class="doc_subsubsection">
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]668 <a name="doFinalization_mod">The <tt>doFinalization(Module
669 &amp;)</tt> method</a>
670</div>
671
672<div class="doc_text">
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]673
674<pre>
675 <b>virtual bool</b> doFinalization(Module &amp;M);
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]676</pre>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]677
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]678<p>The <tt>doFinalization</tt> method is an infrequently used method that is
679called when the pass framework has finished calling <a
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]680href="#runOnFunction"><tt>runOnFunction</tt></a> for every function in the
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]681program being compiled.</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]682
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]683</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]684
685<!-- ======================================================================= -->
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]686<div class="doc_subsection">
687 <a name="BasicBlockPass">The <tt>BasicBlockPass</tt> class</a>
688</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]689
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]690<div class="doc_text">
691
692<p><tt>BasicBlockPass</tt>'s are just like <a
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]693href="#FunctionPass"><tt>FunctionPass</tt></a>'s, except that they must limit
694their scope of inspection and modification to a single basic block at a time.
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]695As such, they are <b>not</b> allowed to do any of the following:</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]696
697<ol>
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]698<li>Modify or inspect any basic blocks outside of the current one</li>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]699<li>Maintain state across invocations of
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]700 <a href="#runOnBasicBlock"><tt>runOnBasicBlock</tt></a></li>
Reid Spencera1799682004-12-11 05:12:57 +0000[diff] [blame]701<li>Modify the control flow graph (by altering terminator instructions)</li>
702<li>Any of the things forbidden for
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]703 <a href="#FunctionPass"><tt>FunctionPass</tt></a>es.</li>
704</ol>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]705
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]706<p><tt>BasicBlockPass</tt>es are useful for traditional local and "peephole"
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]707optimizations. They may override the same <a
Chris Lattner5e08e70f2002-09-12 17:06:43 +0000[diff] [blame]708href="#doInitialization_mod"><tt>doInitialization(Module &amp;)</tt></a> and <a
709href="#doFinalization_mod"><tt>doFinalization(Module &amp;)</tt></a> methods that <a
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]710href="#FunctionPass"><tt>FunctionPass</tt></a>'s have, but also have the following virtual methods that may also be implemented:</p>
711
712</div>
Chris Lattner5e08e70f2002-09-12 17:06:43 +0000[diff] [blame]713
714<!-- _______________________________________________________________________ -->
Chris Lattner8e871652004-03-17 21:09:55 +0000[diff] [blame]715<div class="doc_subsubsection">
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]716 <a name="doInitialization_fn">The <tt>doInitialization(Function
717 &amp;)</tt> method</a>
718</div>
719
720<div class="doc_text">
Chris Lattner5e08e70f2002-09-12 17:06:43 +0000[diff] [blame]721
722<pre>
723 <b>virtual bool</b> doInitialization(Function &amp;F);
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]724</pre>
Chris Lattner5e08e70f2002-09-12 17:06:43 +0000[diff] [blame]725
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]726<p>The <tt>doIninitialize</tt> method is allowed to do most of the things that
Chris Lattner5e08e70f2002-09-12 17:06:43 +0000[diff] [blame]727<tt>BasicBlockPass</tt>'s are not allowed to do, but that
728<tt>FunctionPass</tt>'s can. The <tt>doInitialization</tt> method is designed
Reid Spencera1799682004-12-11 05:12:57 +0000[diff] [blame]729to do simple initialization that does not depend on the
Chris Lattner5e08e70f2002-09-12 17:06:43 +0000[diff] [blame]730BasicBlocks being processed. The <tt>doInitialization</tt> method call is not
731scheduled to overlap with any other pass executions (thus it should be very
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]732fast).</p>
Chris Lattner5e08e70f2002-09-12 17:06:43 +0000[diff] [blame]733
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]734</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]735
736<!-- _______________________________________________________________________ -->
Chris Lattner8e871652004-03-17 21:09:55 +0000[diff] [blame]737<div class="doc_subsubsection">
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]738 <a name="runOnBasicBlock">The <tt>runOnBasicBlock</tt> method</a>
739</div>
740
741<div class="doc_text">
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]742
743<pre>
744 <b>virtual bool</b> runOnBasicBlock(BasicBlock &amp;BB) = 0;
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]745</pre>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]746
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]747<p>Override this function to do the work of the <tt>BasicBlockPass</tt>. This
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]748function is not allowed to inspect or modify basic blocks other than the
749parameter, and are not allowed to modify the CFG. A true value must be returned
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]750if the basic block is modified.</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]751
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]752</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]753
Chris Lattner5e08e70f2002-09-12 17:06:43 +0000[diff] [blame]754<!-- _______________________________________________________________________ -->
Chris Lattner8e871652004-03-17 21:09:55 +0000[diff] [blame]755<div class="doc_subsubsection">
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]756 <a name="doFinalization_fn">The <tt>doFinalization(Function &amp;)</tt>
757 method</a>
758</div>
759
760<div class="doc_text">
Chris Lattner5e08e70f2002-09-12 17:06:43 +0000[diff] [blame]761
762<pre>
763 <b>virtual bool</b> doFinalization(Function &amp;F);
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]764</pre>
Chris Lattner5e08e70f2002-09-12 17:06:43 +0000[diff] [blame]765
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]766<p>The <tt>doFinalization</tt> method is an infrequently used method that is
767called when the pass framework has finished calling <a
Chris Lattner5e08e70f2002-09-12 17:06:43 +0000[diff] [blame]768href="#runOnBasicBlock"><tt>runOnBasicBlock</tt></a> for every BasicBlock in the
769program being compiled. This can be used to perform per-function
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]770finalization.</p>
Chris Lattner5e08e70f2002-09-12 17:06:43 +0000[diff] [blame]771
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]772</div>
Chris Lattner5e08e70f2002-09-12 17:06:43 +0000[diff] [blame]773
Brian Gaeke110f07b2003-07-17 18:53:20 +0000[diff] [blame]774<!-- ======================================================================= -->
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]775<div class="doc_subsection">
776 <a name="MachineFunctionPass">The <tt>MachineFunctionPass</tt> class</a>
777</div>
Brian Gaeke110f07b2003-07-17 18:53:20 +0000[diff] [blame]778
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]779<div class="doc_text">
780
Chris Lattner8e871652004-03-17 21:09:55 +0000[diff] [blame]781<p>A <tt>MachineFunctionPass</tt> is a part of the LLVM code generator that
782executes on the machine-dependent representation of each LLVM function in the
783program. A <tt>MachineFunctionPass</tt> is also a <tt>FunctionPass</tt>, so all
Brian Gaeke110f07b2003-07-17 18:53:20 +0000[diff] [blame]784the restrictions that apply to a <tt>FunctionPass</tt> also apply to it.
Chris Lattner8e871652004-03-17 21:09:55 +0000[diff] [blame]785<tt>MachineFunctionPass</tt>es also have additional restrictions. In particular,
786<tt>MachineFunctionPass</tt>es are not allowed to do any of the following:</p>
Brian Gaeke110f07b2003-07-17 18:53:20 +0000[diff] [blame]787
788<ol>
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]789<li>Modify any LLVM Instructions, BasicBlocks or Functions.</li>
790<li>Modify a MachineFunction other than the one currently being processed.</li>
791<li>Add or remove MachineFunctions from the current Module.</li>
792<li>Add or remove global variables from the current Module.</li>
793<li>Maintain state across invocations of <a
794href="#runOnMachineFunction"><tt>runOnMachineFunction</tt></a> (including global
795data)</li>
796</ol>
Brian Gaeke110f07b2003-07-17 18:53:20 +0000[diff] [blame]797
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]798</div>
Chris Lattner5e08e70f2002-09-12 17:06:43 +0000[diff] [blame]799
Brian Gaeke673ef4d2003-07-22 20:53:20 +0000[diff] [blame]800<!-- _______________________________________________________________________ -->
Chris Lattner8e871652004-03-17 21:09:55 +0000[diff] [blame]801<div class="doc_subsubsection">
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]802 <a name="runOnMachineFunction">The <tt>runOnMachineFunction(MachineFunction
803 &amp;MF)</tt> method</a>
804</div>
805
806<div class="doc_text">
Brian Gaeke673ef4d2003-07-22 20:53:20 +0000[diff] [blame]807
808<pre>
809 <b>virtual bool</b> runOnMachineFunction(MachineFunction &amp;MF) = 0;
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]810</pre>
Brian Gaeke673ef4d2003-07-22 20:53:20 +0000[diff] [blame]811
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]812<p><tt>runOnMachineFunction</tt> can be considered the main entry point of a
813<tt>MachineFunctionPass</tt>; that is, you should override this method to do the
814work of your <tt>MachineFunctionPass</tt>.</p>
Brian Gaeke673ef4d2003-07-22 20:53:20 +0000[diff] [blame]815
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]816<p>The <tt>runOnMachineFunction</tt> method is called on every
Brian Gaeke673ef4d2003-07-22 20:53:20 +0000[diff] [blame]817<tt>MachineFunction</tt> in a <tt>Module</tt>, so that the
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]818<tt>MachineFunctionPass</tt> may perform optimizations on the machine-dependent
819representation of the function. If you want to get at the LLVM <tt>Function</tt>
820for the <tt>MachineFunction</tt> you're working on, use
821<tt>MachineFunction</tt>'s <tt>getFunction()</tt> accessor method -- but
822remember, you may not modify the LLVM <tt>Function</tt> or its contents from a
823<tt>MachineFunctionPass</tt>.</p>
824
825</div>
Brian Gaeke673ef4d2003-07-22 20:53:20 +0000[diff] [blame]826
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]827<!-- *********************************************************************** -->
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]828<div class="doc_section">
829 <a name="registration">Pass registration</a>
830</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]831<!-- *********************************************************************** -->
832
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]833<div class="doc_text">
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]834
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]835<p>In the <a href="#basiccode">Hello World</a> example pass we illustrated how
836pass registration works, and discussed some of the reasons that it is used and
837what it does. Here we discuss how and why passes are registered.</p>
838
839<p>Passes can be registered in several different ways. Depending on the general
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]840classification of the pass, you should use one of the following templates to
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]841register the pass:</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]842
843<ul>
844<li><b><tt>RegisterOpt</tt></b> - This template should be used when you are
845registering a pass that logically should be available for use in the
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]846'<tt>opt</tt>' utility.</li>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]847
848<li><b><tt>RegisterAnalysis</tt></b> - This template should be used when you are
849registering a pass that logically should be available for use in the
Chris Lattner8e871652004-03-17 21:09:55 +0000[diff] [blame]850'<tt>analyze</tt>' utility.</li>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]851
852<li><b><tt>RegisterPass</tt></b> - This is the generic form of the
853<tt>Register*</tt> templates that should be used if you want your pass listed by
854multiple or no utilities. This template takes an extra third argument that
855specifies which tools it should be listed in. See the <a
856href="http://llvm.cs.uiuc.edu/doxygen/PassSupport_8h-source.html">PassSupport.h</a>
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]857file for more information.</li>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]858
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]859</ul>
860
861<p>Regardless of how you register your pass, you must specify at least two
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]862parameters. The first parameter is the name of the pass that is to be used on
863the command line to specify that the pass should be added to a program (for
864example <tt>opt</tt> or <tt>analyze</tt>). The second argument is the name of
865the pass, which is to be used for the <tt>--help</tt> output of programs, as
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]866well as for debug output generated by the <tt>--debug-pass</tt> option.</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]867
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]868<p>If a pass is registered to be used by the <tt>analyze</tt> utility, you
869should implement the virtual <tt>print</tt> method:</p>
870
871</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]872
873<!-- _______________________________________________________________________ -->
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]874<div class="doc_subsubsection">
875 <a name="print">The <tt>print</tt> method</a>
876</div>
877
878<div class="doc_text">
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]879
880<pre>
881 <b>virtual void</b> print(std::ostream &amp;O, <b>const</b> Module *M) <b>const</b>;
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]882</pre>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]883
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]884<p>The <tt>print</tt> method must be implemented by "analyses" in order to print
885a human readable version of the analysis results. This is useful for debugging
886an analysis itself, as well as for other people to figure out how an analysis
887works. The <tt>analyze</tt> tool uses this method to generate its output.</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]888
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]889<p>The <tt>ostream</tt> parameter specifies the stream to write the results on,
890and the <tt>Module</tt> parameter gives a pointer to the top level module of the
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]891program that has been analyzed. Note however that this pointer may be null in
892certain circumstances (such as calling the <tt>Pass::dump()</tt> from a
893debugger), so it should only be used to enhance debug output, it should not be
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]894depended on.</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]895
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]896</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]897
898<!-- *********************************************************************** -->
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]899<div class="doc_section">
900 <a name="interaction">Specifying interactions between passes</a>
901</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]902<!-- *********************************************************************** -->
903
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]904<div class="doc_text">
905
906<p>One of the main responsibilities of the <tt>PassManager</tt> is the make sure
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]907that passes interact with each other correctly. Because <tt>PassManager</tt>
908tries to <a href="#passmanager">optimize the execution of passes</a> it must
909know how the passes interact with each other and what dependencies exist between
910the various passes. To track this, each pass can declare the set of passes that
911are required to be executed before the current pass, and the passes which are
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]912invalidated by the current pass.</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]913
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]914<p>Typically this functionality is used to require that analysis results are
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]915computed before your pass is run. Running arbitrary transformation passes can
916invalidate the computed analysis results, which is what the invalidation set
917specifies. If a pass does not implement the <tt><a
918href="#getAnalysisUsage">getAnalysisUsage</a></tt> method, it defaults to not
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]919having any prerequisite passes, and invalidating <b>all</b> other passes.</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]920
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]921</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]922
923<!-- _______________________________________________________________________ -->
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]924<div class="doc_subsubsection">
925 <a name="getAnalysisUsage">The <tt>getAnalysisUsage</tt> method</a>
926</div>
927
928<div class="doc_text">
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]929
930<pre>
931 <b>virtual void</b> getAnalysisUsage(AnalysisUsage &amp;Info) <b>const</b>;
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]932</pre>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]933
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]934<p>By implementing the <tt>getAnalysisUsage</tt> method, the required and
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]935invalidated sets may be specified for your transformation. The implementation
936should fill in the <tt><a
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]937href="http://llvm.cs.uiuc.edu/doxygen/classllvm_1_1AnalysisUsage.html">AnalysisUsage</a></tt>
938object with information about which passes are required and not invalidated. To
Chris Lattner8e871652004-03-17 21:09:55 +0000[diff] [blame]939do this, a pass may call any of the following methods on the AnalysisUsage
940object:</p>
941</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]942
Chris Lattner8e871652004-03-17 21:09:55 +0000[diff] [blame]943<!-- _______________________________________________________________________ -->
944<div class="doc_subsubsection">
945 <a name="AU::addRequired">The <tt>AnalysisUsage::addRequired&lt;&gt;</tt> and <tt>AnalysisUsage::addRequiredTransitive&lt;&gt;</tt> methods</a>
946</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]947
Chris Lattner8e871652004-03-17 21:09:55 +0000[diff] [blame]948<div class="doc_text">
949<p>
Reid Spencera1799682004-12-11 05:12:57 +0000[diff] [blame]950If your pass requires a previous pass to be executed (an analysis for example),
Chris Lattner8e871652004-03-17 21:09:55 +0000[diff] [blame]951it can use one of these methods to arrange for it to be run before your pass.
952LLVM has many different types of analyses and passes that can be required,
Reid Spencera1799682004-12-11 05:12:57 +0000[diff] [blame]953spanning the range from <tt>DominatorSet</tt> to <tt>BreakCriticalEdges</tt>.
954Requiring <tt>BreakCriticalEdges</tt>, for example, guarantees that there will
Chris Lattner8e871652004-03-17 21:09:55 +0000[diff] [blame]955be no critical edges in the CFG when your pass has been run.
956</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]957
Chris Lattner8e871652004-03-17 21:09:55 +0000[diff] [blame]958<p>
959Some analyses chain to other analyses to do their job. For example, an <a
960href="AliasAnalysis.html">AliasAnalysis</a> implementation is required to <a
961href="AliasAnalysis.html#chaining">chain</a> to other alias analysis passes. In
962cases where analyses chain, the <tt>addRequiredTransitive</tt> method should be
963used instead of the <tt>addRequired</tt> method. This informs the PassManager
964that the transitively required pass should be alive as long as the requiring
965pass is.
966</p>
967</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]968
Chris Lattner8e871652004-03-17 21:09:55 +0000[diff] [blame]969<!-- _______________________________________________________________________ -->
970<div class="doc_subsubsection">
971 <a name="AU::addPreserved">The <tt>AnalysisUsage::addPreserved&lt;&gt;</tt> method</a>
972</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]973
Chris Lattner8e871652004-03-17 21:09:55 +0000[diff] [blame]974<div class="doc_text">
975<p>
976One of the jobs of the PassManager is to optimize how and when analyses are run.
977In particular, it attempts to avoid recomputing data unless it needs to. For
978this reason, passes are allowed to declare that they preserve (i.e., they don't
979invalidate) an existing analysis if it's available. For example, a simple
Reid Spencera1799682004-12-11 05:12:57 +0000[diff] [blame]980constant folding pass would not modify the CFG, so it can't possibly affect the
Chris Lattner8e871652004-03-17 21:09:55 +0000[diff] [blame]981results of dominator analysis. By default, all passes are assumed to invalidate
982all others.
983</p>
984
985<p>
986The <tt>AnalysisUsage</tt> class provides several methods which are useful in
987certain circumstances that are related to <tt>addPreserved</tt>. In particular,
988the <tt>setPreservesAll</tt> method can be called to indicate that the pass does
989not modify the LLVM program at all (which is true for analyses), and the
990<tt>setPreservesCFG</tt> method can be used by transformations that change
991instructions in the program but do not modify the CFG or terminator instructions
992(note that this property is implicitly set for <a
993href="#BasicBlockPass">BasicBlockPass</a>'s).
994</p>
995
996<p>
997<tt>addPreserved</tt> is particularly useful for transformations like
998<tt>BreakCriticalEdges</tt>. This pass knows how to update a small set of loop
999and dominator related analyses if they exist, so it can preserve them, despite
1000the fact that it hacks on the CFG.
1001</p>
1002</div>
1003
1004<!-- _______________________________________________________________________ -->
1005<div class="doc_subsubsection">
1006 <a name="AU::examples">Example implementations of <tt>getAnalysisUsage</tt></a>
1007</div>
1008
1009<div class="doc_text">
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1010
1011<pre>
1012 <i>// This is an example implementation from an analysis, which does not modify
1013 // the program at all, yet has a prerequisite.</i>
Chris Lattnerb7848972005-04-21 04:53:58 +0000[diff] [blame]1014 <b>void</b> <a href="http://llvm.cs.uiuc.edu/doxygen/classllvm_1_1PostDominanceFrontier.html">PostDominanceFrontier</a>::getAnalysisUsage(AnalysisUsage &amp;AU) <b>const</b> {
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1015 AU.setPreservesAll();
Chris Lattnerb7848972005-04-21 04:53:58 +0000[diff] [blame]1016 AU.addRequired&lt;<a href="http://llvm.cs.uiuc.edu/doxygen/classllvm_1_1PostDominatorTree.html">PostDominatorTree</a>&gt;();
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1017 }
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1018</pre>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1019
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1020<p>and:</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1021
1022<pre>
1023 <i>// This example modifies the program, but does not modify the CFG</i>
1024 <b>void</b> <a href="http://llvm.cs.uiuc.edu/doxygen/structLICM.html">LICM</a>::getAnalysisUsage(AnalysisUsage &amp;AU) <b>const</b> {
Chris Lattnera8c82c22002-10-21 19:57:59 +0000[diff] [blame]1025 AU.setPreservesCFG();
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1026 AU.addRequired&lt;<a href="http://llvm.cs.uiuc.edu/doxygen/classllvm_1_1LoopInfo.html">LoopInfo</a>&gt;();
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1027 }
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1028</pre>
1029
1030</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1031
1032<!-- _______________________________________________________________________ -->
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1033<div class="doc_subsubsection">
Chris Lattner8e871652004-03-17 21:09:55 +0000[diff] [blame]1034 <a name="getAnalysis">The <tt>getAnalysis&lt;&gt;</tt> and <tt>getAnalysisToUpdate&lt;&gt;</tt> methods</a>
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1035</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1036
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1037<div class="doc_text">
1038
Chris Lattner8e871652004-03-17 21:09:55 +0000[diff] [blame]1039<p>The <tt>Pass::getAnalysis&lt;&gt;</tt> method is automatically inherited by
1040your class, providing you with access to the passes that you declared that you
1041required with the <a href="#getAnalysisUsage"><tt>getAnalysisUsage</tt></a>
1042method. It takes a single template argument that specifies which pass class you
1043want, and returns a reference to that pass. For example:</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1044
1045<pre>
Chris Lattnerbaf3f622004-03-17 21:33:32 +0000[diff] [blame]1046 bool LICM::runOnFunction(Function &amp;F) {
Chris Lattner8e871652004-03-17 21:09:55 +0000[diff] [blame]1047 LoopInfo &amp;LI = getAnalysis&lt;LoopInfo&gt;();
1048 ...
1049 }
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1050</pre>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1051
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1052<p>This method call returns a reference to the pass desired. You may get a
1053runtime assertion failure if you attempt to get an analysis that you did not
1054declare as required in your <a
1055href="#getAnalysisUsage"><tt>getAnalysisUsage</tt></a> implementation. This
1056method can be called by your <tt>run*</tt> method implementation, or by any
1057other local method invoked by your <tt>run*</tt> method.</p>
1058
Chris Lattner8e871652004-03-17 21:09:55 +0000[diff] [blame]1059<p>
1060If your pass is capable of updating analyses if they exist (e.g.,
1061<tt>BreakCriticalEdges</tt>, as described above), you can use the
1062<tt>getAnalysisToUpdate</tt> method, which returns a pointer to the analysis if
1063it is active. For example:</p>
1064
1065<pre>
1066 ...
1067 if (DominatorSet *DS = getAnalysisToUpdate&lt;DominatorSet&gt;()) {
1068 <i>// A DominatorSet is active. This code will update it.</i>
1069 }
1070 ...
1071</pre>
1072
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1073</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1074
Chris Lattner8d8a9282002-08-22 19:21:04 +0000[diff] [blame]1075<!-- *********************************************************************** -->
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1076<div class="doc_section">
1077 <a name="analysisgroup">Implementing Analysis Groups</a>
1078</div>
Chris Lattner8d8a9282002-08-22 19:21:04 +0000[diff] [blame]1079<!-- *********************************************************************** -->
1080
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1081<div class="doc_text">
1082
1083<p>Now that we understand the basics of how passes are defined, how the are
1084used, and how they are required from other passes, it's time to get a little bit
Chris Lattner8d8a9282002-08-22 19:21:04 +0000[diff] [blame]1085fancier. All of the pass relationships that we have seen so far are very
1086simple: one pass depends on one other specific pass to be run before it can run.
1087For many applications, this is great, for others, more flexibility is
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1088required.</p>
Chris Lattner8d8a9282002-08-22 19:21:04 +0000[diff] [blame]1089
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1090<p>In particular, some analyses are defined such that there is a single simple
Chris Lattner8d8a9282002-08-22 19:21:04 +0000[diff] [blame]1091interface to the analysis results, but multiple ways of calculating them.
1092Consider alias analysis for example. The most trivial alias analysis returns
1093"may alias" for any alias query. The most sophisticated analysis a
1094flow-sensitive, context-sensitive interprocedural analysis that can take a
1095significant amount of time to execute (and obviously, there is a lot of room
1096between these two extremes for other implementations). To cleanly support
1097situations like this, the LLVM Pass Infrastructure supports the notion of
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1098Analysis Groups.</p>
1099
1100</div>
Chris Lattner8d8a9282002-08-22 19:21:04 +0000[diff] [blame]1101
1102<!-- _______________________________________________________________________ -->
Chris Lattner8e871652004-03-17 21:09:55 +0000[diff] [blame]1103<div class="doc_subsubsection">
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1104 <a name="agconcepts">Analysis Group Concepts</a>
1105</div>
Chris Lattner8d8a9282002-08-22 19:21:04 +0000[diff] [blame]1106
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1107<div class="doc_text">
1108
1109<p>An Analysis Group is a single simple interface that may be implemented by
Chris Lattner8d8a9282002-08-22 19:21:04 +0000[diff] [blame]1110multiple different passes. Analysis Groups can be given human readable names
1111just like passes, but unlike passes, they need not derive from the <tt>Pass</tt>
1112class. An analysis group may have one or more implementations, one of which is
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1113the "default" implementation.</p>
Chris Lattner8d8a9282002-08-22 19:21:04 +0000[diff] [blame]1114
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1115<p>Analysis groups are used by client passes just like other passes are: the
Chris Lattner8d8a9282002-08-22 19:21:04 +0000[diff] [blame]1116<tt>AnalysisUsage::addRequired()</tt> and <tt>Pass::getAnalysis()</tt> methods.
1117In order to resolve this requirement, the <a href="#passmanager">PassManager</a>
1118scans the available passes to see if any implementations of the analysis group
1119are available. If none is available, the default implementation is created for
1120the pass to use. All standard rules for <A href="#interaction">interaction
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1121between passes</a> still apply.</p>
Chris Lattner8d8a9282002-08-22 19:21:04 +0000[diff] [blame]1122
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1123<p>Although <a href="#registration">Pass Registration</a> is optional for normal
Chris Lattner8d8a9282002-08-22 19:21:04 +0000[diff] [blame]1124passes, all analysis group implementations must be registered, and must use the
1125<A href="#registerag"><tt>RegisterAnalysisGroup</tt></a> template to join the
1126implementation pool. Also, a default implementation of the interface
1127<b>must</b> be registered with <A
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1128href="#registerag"><tt>RegisterAnalysisGroup</tt></a>.</p>
Chris Lattner8d8a9282002-08-22 19:21:04 +0000[diff] [blame]1129
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1130<p>As a concrete example of an Analysis Group in action, consider the <a
1131href="http://llvm.cs.uiuc.edu/doxygen/classllvm_1_1AliasAnalysis.html">AliasAnalysis</a>
Chris Lattner8d8a9282002-08-22 19:21:04 +0000[diff] [blame]1132analysis group. The default implementation of the alias analysis interface (the
1133<tt><a
1134href="http://llvm.cs.uiuc.edu/doxygen/structBasicAliasAnalysis.html">basicaa</a></tt>
1135pass) just does a few simple checks that don't require significant analysis to
1136compute (such as: two different globals can never alias each other, etc).
1137Passes that use the <tt><a
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1138href="http://llvm.cs.uiuc.edu/doxygen/classllvm_1_1AliasAnalysis.html">AliasAnalysis</a></tt>
Chris Lattner8d8a9282002-08-22 19:21:04 +0000[diff] [blame]1139interface (for example the <tt><a
Misha Brukmand72c7f92004-06-03 23:39:36 +0000[diff] [blame]1140href="http://llvm.cs.uiuc.edu/doxygen/structGCSE.html">gcse</a></tt> pass), do
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1141not care which implementation of alias analysis is actually provided, they just
1142use the designated interface.</p>
Chris Lattner8d8a9282002-08-22 19:21:04 +0000[diff] [blame]1143
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1144<p>From the user's perspective, commands work just like normal. Issuing the
Chris Lattner8d8a9282002-08-22 19:21:04 +0000[diff] [blame]1145command '<tt>opt -gcse ...</tt>' will cause the <tt>basicaa</tt> class to be
1146instantiated and added to the pass sequence. Issuing the command '<tt>opt
1147-somefancyaa -gcse ...</tt>' will cause the <tt>gcse</tt> pass to use the
1148<tt>somefancyaa</tt> alias analysis (which doesn't actually exist, it's just a
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1149hypothetical example) instead.</p>
Chris Lattner8d8a9282002-08-22 19:21:04 +0000[diff] [blame]1150
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1151</div>
Chris Lattner8d8a9282002-08-22 19:21:04 +0000[diff] [blame]1152
1153<!-- _______________________________________________________________________ -->
Chris Lattner8e871652004-03-17 21:09:55 +0000[diff] [blame]1154<div class="doc_subsubsection">
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1155 <a name="registerag">Using <tt>RegisterAnalysisGroup</tt></a>
1156</div>
Chris Lattner8d8a9282002-08-22 19:21:04 +0000[diff] [blame]1157
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1158<div class="doc_text">
1159
1160<p>The <tt>RegisterAnalysisGroup</tt> template is used to register the analysis
Chris Lattner8d8a9282002-08-22 19:21:04 +0000[diff] [blame]1161group itself as well as add pass implementations to the analysis group. First,
1162an analysis should be registered, with a human readable name provided for it.
1163Unlike registration of passes, there is no command line argument to be specified
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1164for the Analysis Group Interface itself, because it is "abstract":</p>
Chris Lattner8d8a9282002-08-22 19:21:04 +0000[diff] [blame]1165
1166<pre>
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1167 <b>static</b> RegisterAnalysisGroup&lt;<a href="http://llvm.cs.uiuc.edu/doxygen/classllvm_1_1AliasAnalysis.html">AliasAnalysis</a>&gt; A("<i>Alias Analysis</i>");
1168</pre>
Chris Lattner8d8a9282002-08-22 19:21:04 +0000[diff] [blame]1169
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1170<p>Once the analysis is registered, passes can declare that they are valid
1171implementations of the interface by using the following code:</p>
Chris Lattner8d8a9282002-08-22 19:21:04 +0000[diff] [blame]1172
1173<pre>
1174<b>namespace</b> {
1175 //<i> Analysis Group implementations <b>must</b> be registered normally...</i>
1176 RegisterOpt&lt;FancyAA&gt;
1177 B("<i>somefancyaa</i>", "<i>A more complex alias analysis implementation</i>");
1178
1179 //<i> Declare that we implement the AliasAnalysis interface</i>
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1180 RegisterAnalysisGroup&lt;<a href="http://llvm.cs.uiuc.edu/doxygen/classllvm_1_1AliasAnalysis.html">AliasAnalysis</a>, FancyAA&gt; C;
Chris Lattner8d8a9282002-08-22 19:21:04 +0000[diff] [blame]1181}
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1182</pre>
Chris Lattner8d8a9282002-08-22 19:21:04 +0000[diff] [blame]1183
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1184<p>This just shows a class <tt>FancyAA</tt> that is registered normally, then
1185uses the <tt>RegisterAnalysisGroup</tt> template to "join" the <tt><a
1186href="http://llvm.cs.uiuc.edu/doxygen/classllvm_1_1AliasAnalysis.html">AliasAnalysis</a></tt>
Chris Lattner8d8a9282002-08-22 19:21:04 +0000[diff] [blame]1187analysis group. Every implementation of an analysis group should join using
1188this template. A single pass may join multiple different analysis groups with
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1189no problem.</p>
Chris Lattner8d8a9282002-08-22 19:21:04 +0000[diff] [blame]1190
1191<pre>
1192<b>namespace</b> {
1193 //<i> Analysis Group implementations <b>must</b> be registered normally...</i>
1194 RegisterOpt&lt;<a href="http://llvm.cs.uiuc.edu/doxygen/structBasicAliasAnalysis.html">BasicAliasAnalysis</a>&gt;
1195 D("<i>basicaa</i>", "<i>Basic Alias Analysis (default AA impl)</i>");
1196
1197 //<i> Declare that we implement the AliasAnalysis interface</i>
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1198 RegisterAnalysisGroup&lt;<a href="http://llvm.cs.uiuc.edu/doxygen/classllvm_1_1AliasAnalysis.html">AliasAnalysis</a>, <a href="http://llvm.cs.uiuc.edu/doxygen/structBasicAliasAnalysis.html">BasicAliasAnalysis</a>, <b>true</b>&gt; E;
Chris Lattner8d8a9282002-08-22 19:21:04 +0000[diff] [blame]1199}
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1200</pre>
Chris Lattner8d8a9282002-08-22 19:21:04 +0000[diff] [blame]1201
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1202<p>Here we show how the default implementation is specified (using the extra
Chris Lattner8d8a9282002-08-22 19:21:04 +0000[diff] [blame]1203argument to the <tt>RegisterAnalysisGroup</tt> template). There must be exactly
1204one default implementation available at all times for an Analysis Group to be
1205used. Here we declare that the <tt><a
1206href="http://llvm.cs.uiuc.edu/doxygen/structBasicAliasAnalysis.html">BasicAliasAnalysis</a></tt>
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1207pass is the default implementation for the interface.</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1208
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1209</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1210
1211<!-- *********************************************************************** -->
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1212<div class="doc_section">
Tanya Lattnerfb966ba2004-11-19 01:25:14 +0000[diff] [blame]1213 <a name="passStatistics">Pass Statistics</a>
1214</div>
1215<!-- *********************************************************************** -->
1216
1217<div class="doc_text">
Tanya Lattner0b40ee62004-11-19 01:26:37 +0000[diff] [blame]1218<p>The <a
Tanya Lattner9d2df712004-12-08 18:13:51 +0000[diff] [blame]1219href="http://llvm.cs.uiuc.edu/doxygen/Statistic_8h-source.html"><tt>Statistic</tt></a>
John Criswell3e149a22005-11-28 23:25:41 +0000[diff] [blame^]1220class is designed to be an easy way to expose various success
Tanya Lattnerfb966ba2004-11-19 01:25:14 +0000[diff] [blame]1221metrics from passes. These statistics are printed at the end of a
1222run, when the -stats command line option is enabled on the command
Tanya Lattner0b40ee62004-11-19 01:26:37 +0000[diff] [blame]1223line. See the <a href="http://llvm.org/docs/ProgrammersManual.html#Statistic">Statistics section</a> in the Programmer's Manual for details.
Tanya Lattnerfb966ba2004-11-19 01:25:14 +0000[diff] [blame]1224
1225</div>
1226
1227
1228<!-- *********************************************************************** -->
1229<div class="doc_section">
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1230 <a name="passmanager">What PassManager does</a>
1231</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1232<!-- *********************************************************************** -->
1233
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1234<div class="doc_text">
1235
1236<p>The <a
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1237href="http://llvm.cs.uiuc.edu/doxygen/PassManager_8h-source.html"><tt>PassManager</tt></a>
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1238<a
1239href="http://llvm.cs.uiuc.edu/doxygen/classllvm_1_1PassManager.html">class</a>
1240takes a list of passes, ensures their <a href="#interaction">prerequisites</a>
1241are set up correctly, and then schedules passes to run efficiently. All of the
1242LLVM tools that run passes use the <tt>PassManager</tt> for execution of these
1243passes.</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1244
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1245<p>The <tt>PassManager</tt> does two main things to try to reduce the execution
1246time of a series of passes:</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1247
1248<ol>
1249<li><b>Share analysis results</b> - The PassManager attempts to avoid
1250recomputing analysis results as much as possible. This means keeping track of
1251which analyses are available already, which analyses get invalidated, and which
1252analyses are needed to be run for a pass. An important part of work is that the
1253<tt>PassManager</tt> tracks the exact lifetime of all analysis results, allowing
1254it to <a href="#releaseMemory">free memory</a> allocated to holding analysis
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1255results as soon as they are no longer needed.</li>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1256
1257<li><b>Pipeline the execution of passes on the program</b> - The
1258<tt>PassManager</tt> attempts to get better cache and memory usage behavior out
1259of a series of passes by pipelining the passes together. This means that, given
1260a series of consequtive <a href="#FunctionPass"><tt>FunctionPass</tt></a>'s, it
1261will execute all of the <a href="#FunctionPass"><tt>FunctionPass</tt></a>'s on
1262the first function, then all of the <a
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1263href="#FunctionPass"><tt>FunctionPass</tt></a>es on the second function,
1264etc... until the entire program has been run through the passes.
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1265
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1266<p>This improves the cache behavior of the compiler, because it is only touching
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1267the LLVM program representation for a single function at a time, instead of
1268traversing the entire program. It reduces the memory consumption of compiler,
1269because, for example, only one <a
Chris Lattnerb7848972005-04-21 04:53:58 +0000[diff] [blame]1270href="http://llvm.cs.uiuc.edu/doxygen/classllvm_1_1DominatorSet.html"><tt>DominatorSet</tt></a>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1271needs to be calculated at a time. This also makes it possible some <a
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1272href="#SMP">interesting enhancements</a> in the future.</p></li>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1273
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1274</ol>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1275
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1276<p>The effectiveness of the <tt>PassManager</tt> is influenced directly by how
1277much information it has about the behaviors of the passes it is scheduling. For
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1278example, the "preserved" set is intentionally conservative in the face of an
1279unimplemented <a href="#getAnalysisUsage"><tt>getAnalysisUsage</tt></a> method.
1280Not implementing when it should be implemented will have the effect of not
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1281allowing any analysis results to live across the execution of your pass.</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1282
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1283<p>The <tt>PassManager</tt> class exposes a <tt>--debug-pass</tt> command line
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1284options that is useful for debugging pass execution, seeing how things work, and
1285diagnosing when you should be preserving more analyses than you currently are
1286(To get information about all of the variants of the <tt>--debug-pass</tt>
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1287option, just type '<tt>opt --help-hidden</tt>').</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1288
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1289<p>By using the <tt>--debug-pass=Structure</tt> option, for example, we can see
1290how our <a href="#basiccode">Hello World</a> pass interacts with other passes.
1291Lets try it out with the <tt>gcse</tt> and <tt>licm</tt> passes:</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1292
1293<pre>
Reid Spencer4a1ab182005-01-11 05:16:23 +0000[diff] [blame]1294$ opt -load ../../../Debug/lib/Hello.so -gcse -licm --debug-pass=Structure &lt; hello.bc &gt; /dev/null
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1295Module Pass Manager
1296 Function Pass Manager
1297 Dominator Set Construction
1298 Immediate Dominators Construction
1299 Global Common Subexpression Elimination
1300-- Immediate Dominators Construction
1301-- Global Common Subexpression Elimination
1302 Natural Loop Construction
1303 Loop Invariant Code Motion
1304-- Natural Loop Construction
1305-- Loop Invariant Code Motion
1306 Module Verifier
1307-- Dominator Set Construction
1308-- Module Verifier
1309 Bytecode Writer
1310--Bytecode Writer
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1311</pre>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1312
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1313<p>This output shows us when passes are constructed and when the analysis
1314results are known to be dead (prefixed with '<tt>--</tt>'). Here we see that
1315GCSE uses dominator and immediate dominator information to do its job. The LICM
1316pass uses natural loop information, which uses dominator sets, but not immediate
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1317dominators. Because immediate dominators are no longer useful after the GCSE
1318pass, it is immediately destroyed. The dominator sets are then reused to
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1319compute natural loop information, which is then used by the LICM pass.</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1320
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1321<p>After the LICM pass, the module verifier runs (which is automatically added
1322by the '<tt>opt</tt>' tool), which uses the dominator set to check that the
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1323resultant LLVM code is well formed. After it finishes, the dominator set
1324information is destroyed, after being computed once, and shared by three
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1325passes.</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1326
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1327<p>Lets see how this changes when we run the <a href="#basiccode">Hello
1328World</a> pass in between the two passes:</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1329
1330<pre>
Reid Spencer4a1ab182005-01-11 05:16:23 +0000[diff] [blame]1331$ opt -load ../../../Debug/lib/Hello.so -gcse -hello -licm --debug-pass=Structure &lt; hello.bc &gt; /dev/null
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1332Module Pass Manager
1333 Function Pass Manager
1334 Dominator Set Construction
1335 Immediate Dominators Construction
1336 Global Common Subexpression Elimination
1337<b>-- Dominator Set Construction</b>
1338-- Immediate Dominators Construction
1339-- Global Common Subexpression Elimination
1340<b> Hello World Pass
1341-- Hello World Pass
1342 Dominator Set Construction</b>
1343 Natural Loop Construction
1344 Loop Invariant Code Motion
1345-- Natural Loop Construction
1346-- Loop Invariant Code Motion
1347 Module Verifier
1348-- Dominator Set Construction
1349-- Module Verifier
1350 Bytecode Writer
1351--Bytecode Writer
1352Hello: __main
1353Hello: puts
1354Hello: main
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1355</pre>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1356
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1357<p>Here we see that the <a href="#basiccode">Hello World</a> pass has killed the
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1358Dominator Set pass, even though it doesn't modify the code at all! To fix this,
1359we need to add the following <a
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1360href="#getAnalysisUsage"><tt>getAnalysisUsage</tt></a> method to our pass:</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1361
1362<pre>
1363 <i>// We don't modify the program, so we preserve all analyses</i>
1364 <b>virtual void</b> getAnalysisUsage(AnalysisUsage &amp;AU) <b>const</b> {
1365 AU.setPreservesAll();
1366 }
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1367</pre>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1368
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1369<p>Now when we run our pass, we get this output:</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1370
1371<pre>
Reid Spencer4a1ab182005-01-11 05:16:23 +0000[diff] [blame]1372$ opt -load ../../../Debug/lib/Hello.so -gcse -hello -licm --debug-pass=Structure &lt; hello.bc &gt; /dev/null
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1373Pass Arguments: -gcse -hello -licm
1374Module Pass Manager
1375 Function Pass Manager
1376 Dominator Set Construction
1377 Immediate Dominators Construction
1378 Global Common Subexpression Elimination
1379-- Immediate Dominators Construction
1380-- Global Common Subexpression Elimination
1381 Hello World Pass
1382-- Hello World Pass
1383 Natural Loop Construction
1384 Loop Invariant Code Motion
1385-- Loop Invariant Code Motion
1386-- Natural Loop Construction
1387 Module Verifier
1388-- Dominator Set Construction
1389-- Module Verifier
1390 Bytecode Writer
1391--Bytecode Writer
1392Hello: __main
1393Hello: puts
1394Hello: main
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1395</pre>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1396
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1397<p>Which shows that we don't accidentally invalidate dominator information
1398anymore, and therefore do not have to compute it twice.</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1399
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1400</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1401
1402<!-- _______________________________________________________________________ -->
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1403<div class="doc_subsubsection">
1404 <a name="releaseMemory">The <tt>releaseMemory</tt> method</a>
1405</div>
1406
1407<div class="doc_text">
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1408
1409<pre>
1410 <b>virtual void</b> releaseMemory();
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1411</pre>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1412
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1413<p>The <tt>PassManager</tt> automatically determines when to compute analysis
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1414results, and how long to keep them around for. Because the lifetime of the pass
1415object itself is effectively the entire duration of the compilation process, we
1416need some way to free analysis results when they are no longer useful. The
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1417<tt>releaseMemory</tt> virtual method is the way to do this.</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1418
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1419<p>If you are writing an analysis or any other pass that retains a significant
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1420amount of state (for use by another pass which "requires" your pass and uses the
1421<a href="#getAnalysis">getAnalysis</a> method) you should implement
1422<tt>releaseMEmory</tt> to, well, release the memory allocated to maintain this
1423internal state. This method is called after the <tt>run*</tt> method for the
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1424class, before the next call of <tt>run*</tt> in your pass.</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1425
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1426</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1427
1428<!-- *********************************************************************** -->
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1429<div class="doc_section">
1430 <a name="debughints">Using GDB with dynamically loaded passes</a>
1431</div>
Chris Lattner8a97c8a2002-09-06 02:02:58 +0000[diff] [blame]1432<!-- *********************************************************************** -->
1433
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1434<div class="doc_text">
1435
1436<p>Unfortunately, using GDB with dynamically loaded passes is not as easy as it
Chris Lattner8a97c8a2002-09-06 02:02:58 +0000[diff] [blame]1437should be. First of all, you can't set a breakpoint in a shared object that has
1438not been loaded yet, and second of all there are problems with inlined functions
1439in shared objects. Here are some suggestions to debugging your pass with
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1440GDB.</p>
Chris Lattner8a97c8a2002-09-06 02:02:58 +0000[diff] [blame]1441
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1442<p>For sake of discussion, I'm going to assume that you are debugging a
Chris Lattner8a97c8a2002-09-06 02:02:58 +0000[diff] [blame]1443transformation invoked by <tt>opt</tt>, although nothing described here depends
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1444on that.</p>
1445
1446</div>
Chris Lattner8a97c8a2002-09-06 02:02:58 +0000[diff] [blame]1447
1448<!-- _______________________________________________________________________ -->
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1449<div class="doc_subsubsection">
1450 <a name="breakpoint">Setting a breakpoint in your pass</a>
1451</div>
Chris Lattner8a97c8a2002-09-06 02:02:58 +0000[diff] [blame]1452
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1453<div class="doc_text">
1454
1455<p>First thing you do is start <tt>gdb</tt> on the <tt>opt</tt> process:</p>
Chris Lattner8a97c8a2002-09-06 02:02:58 +0000[diff] [blame]1456
1457<pre>
1458$ <b>gdb opt</b>
1459GNU gdb 5.0
1460Copyright 2000 Free Software Foundation, Inc.
1461GDB is free software, covered by the GNU General Public License, and you are
1462welcome to change it and/or distribute copies of it under certain conditions.
1463Type "show copying" to see the conditions.
1464There is absolutely no warranty for GDB. Type "show warranty" for details.
1465This GDB was configured as "sparc-sun-solaris2.6"...
1466(gdb)
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1467</pre>
Chris Lattner8a97c8a2002-09-06 02:02:58 +0000[diff] [blame]1468
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1469<p>Note that <tt>opt</tt> has a lot of debugging information in it, so it takes
Chris Lattner8a97c8a2002-09-06 02:02:58 +0000[diff] [blame]1470time to load. Be patient. Since we cannot set a breakpoint in our pass yet
1471(the shared object isn't loaded until runtime), we must execute the process, and
1472have it stop before it invokes our pass, but after it has loaded the shared
1473object. The most foolproof way of doing this is to set a breakpoint in
1474<tt>PassManager::run</tt> and then run the process with the arguments you
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1475want:</p>
Chris Lattner8a97c8a2002-09-06 02:02:58 +0000[diff] [blame]1476
1477<pre>
1478(gdb) <b>break PassManager::run</b>
1479Breakpoint 1 at 0x2413bc: file Pass.cpp, line 70.
Chris Lattner07275182005-04-21 04:52:37 +0000[diff] [blame]1480(gdb) <b>run test.bc -load $(LLVMTOP)/llvm/Debug/lib/[libname].so -[passoption]</b>
1481Starting program: opt test.bc -load $(LLVMTOP)/llvm/Debug/lib/[libname].so -[passoption]
Chris Lattner8a97c8a2002-09-06 02:02:58 +0000[diff] [blame]1482Breakpoint 1, PassManager::run (this=0xffbef174, M=@0x70b298) at Pass.cpp:70
148370 bool PassManager::run(Module &amp;M) { return PM-&gt;run(M); }
1484(gdb)
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1485</pre>
Chris Lattner8a97c8a2002-09-06 02:02:58 +0000[diff] [blame]1486
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1487<p>Once the <tt>opt</tt> stops in the <tt>PassManager::run</tt> method you are
1488now free to set breakpoints in your pass so that you can trace through execution
1489or do other standard debugging stuff.</p>
Chris Lattner8a97c8a2002-09-06 02:02:58 +0000[diff] [blame]1490
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1491</div>
Chris Lattner8a97c8a2002-09-06 02:02:58 +0000[diff] [blame]1492
1493<!-- _______________________________________________________________________ -->
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1494<div class="doc_subsubsection">
1495 <a name="debugmisc">Miscellaneous Problems</a>
1496</div>
Chris Lattner8a97c8a2002-09-06 02:02:58 +0000[diff] [blame]1497
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1498<div class="doc_text">
1499
1500<p>Once you have the basics down, there are a couple of problems that GDB has,
1501some with solutions, some without.</p>
Chris Lattner8a97c8a2002-09-06 02:02:58 +0000[diff] [blame]1502
1503<ul>
1504<li>Inline functions have bogus stack information. In general, GDB does a
1505pretty good job getting stack traces and stepping through inline functions.
1506When a pass is dynamically loaded however, it somehow completely loses this
1507capability. The only solution I know of is to de-inline a function (move it
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1508from the body of a class to a .cpp file).</li>
Chris Lattner8a97c8a2002-09-06 02:02:58 +0000[diff] [blame]1509
1510<li>Restarting the program breaks breakpoints. After following the information
1511above, you have succeeded in getting some breakpoints planted in your pass. Nex
1512thing you know, you restart the program (i.e., you type '<tt>run</tt>' again),
1513and you start getting errors about breakpoints being unsettable. The only way I
1514have found to "fix" this problem is to <tt>delete</tt> the breakpoints that are
1515already set in your pass, run the program, and re-set the breakpoints once
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1516execution stops in <tt>PassManager::run</tt>.</li>
Chris Lattner8a97c8a2002-09-06 02:02:58 +0000[diff] [blame]1517
1518</ul>
1519
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1520<p>Hopefully these tips will help with common case debugging situations. If
1521you'd like to contribute some tips of your own, just contact <a
1522href="mailto:sabre@nondot.org">Chris</a>.</p>
Chris Lattner8a97c8a2002-09-06 02:02:58 +0000[diff] [blame]1523
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1524</div>
Chris Lattner8a97c8a2002-09-06 02:02:58 +0000[diff] [blame]1525
1526<!-- *********************************************************************** -->
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1527<div class="doc_section">
1528 <a name="future">Future extensions planned</a>
1529</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1530<!-- *********************************************************************** -->
1531
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1532<div class="doc_text">
1533
1534<p>Although the LLVM Pass Infrastructure is very capable as it stands, and does
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1535some nifty stuff, there are things we'd like to add in the future. Here is
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1536where we are going:</p>
1537
1538</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1539
1540<!-- _______________________________________________________________________ -->
Chris Lattner8e871652004-03-17 21:09:55 +0000[diff] [blame]1541<div class="doc_subsubsection">
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1542 <a name="SMP">Multithreaded LLVM</a>
1543</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1544
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1545<div class="doc_text">
1546
1547<p>Multiple CPU machines are becoming more common and compilation can never be
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1548fast enough: obviously we should allow for a multithreaded compiler. Because of
1549the semantics defined for passes above (specifically they cannot maintain state
1550across invocations of their <tt>run*</tt> methods), a nice clean way to
1551implement a multithreaded compiler would be for the <tt>PassManager</tt> class
Misha Brukman7fdaab42003-07-14 17:20:40 +0000[diff] [blame]1552to create multiple instances of each pass object, and allow the separate
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1553instances to be hacking on different parts of the program at the same time.</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1554
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1555<p>This implementation would prevent each of the passes from having to implement
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1556multithreaded constructs, requiring only the LLVM core to have locking in a few
1557places (for global resources). Although this is a simple extension, we simply
1558haven't had time (or multiprocessor machines, thus a reason) to implement this.
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1559Despite that, we have kept the LLVM passes SMP ready, and you should too.</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1560
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1561</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1562
1563<!-- _______________________________________________________________________ -->
Chris Lattner8e871652004-03-17 21:09:55 +0000[diff] [blame]1564<div class="doc_subsubsection">
Chris Lattner3c11c042004-09-20 04:36:29 +0000[diff] [blame]1565<a name="PassFunctionPass"><tt>ModulePass</tt>es requiring <tt>FunctionPass</tt>es</a>
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1566</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1567
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1568<div class="doc_text">
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1569
Chris Lattner3c11c042004-09-20 04:36:29 +0000[diff] [blame]1570<p>Currently it is illegal for a <a href="#ModulePass"><tt>ModulePass</tt></a>
1571to require a <a href="#FunctionPass"><tt>FunctionPass</tt></a>. This is because
1572there is only one instance of the <a
1573href="#FunctionPass"><tt>FunctionPass</tt></a> object ever created, thus nowhere
1574to store information for all of the functions in the program at the same time.
1575Although this has come up a couple of times before, this has always been worked
1576around by factoring one big complicated pass into a global and an
1577interprocedural part, both of which are distinct. In the future, it would be
1578nice to have this though.</p>
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1579
1580<p>Note that it is no problem for a <a
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1581href="#FunctionPass"><tt>FunctionPass</tt></a> to require the results of a <a
Chris Lattner3c11c042004-09-20 04:36:29 +0000[diff] [blame]1582href="#ModulePass"><tt>ModulePass</tt></a>, only the other way around.</p>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1583
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1584</div>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1585
1586<!-- *********************************************************************** -->
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1587<hr>
1588<address>
1589 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
1590 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
1591 <a href="http://validator.w3.org/check/referer"><img
1592 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
Chris Lattner34ceebe2002-08-08 20:11:18 +0000[diff] [blame]1593
Misha Brukmanf5edf1e2004-01-15 18:34:11 +0000[diff] [blame]1594 <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
1595 <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br>
1596 Last modified: $Date$
1597</address>
1598
1599</body>
1600</html>