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