Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / llvm / 624dc1d4abf26a3ccd474f85a39058a99a9053ca / . / docs / WritingAnLLVMPass.html
blob: 331617937755f26c4cf39af62ebc52234e0d4eb2 [file] [log] [blame]
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
3<html>
4<head>
Reid Spencer7fa6d522005-01-11 05:16:23 +0000[diff] [blame]5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]6 <title>Writing an LLVM Pass</title>
7 <link rel="stylesheet" href="llvm.css" type="text/css">
8</head>
9<body>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]10
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]11<h1>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]12 Writing an LLVM Pass
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]13</h1>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]14
15<ol>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]16 <li><a href="#introduction">Introduction - What is a pass?</a></li>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]17 <li><a href="#quickstart">Quick Start - Writing hello world</a>
18 <ul>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]19 <li><a href="#makefile">Setting up the build environment</a></li>
20 <li><a href="#basiccode">Basic code required</a></li>
Chris Lattnerc8603c22006-08-27 23:18:52 +0000[diff] [blame]21 <li><a href="#running">Running a pass with <tt>opt</tt></a></li>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]22 </ul></li>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]23 <li><a href="#passtype">Pass classes and requirements</a>
24 <ul>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]25 <li><a href="#ImmutablePass">The <tt>ImmutablePass</tt> class</a></li>
Chris Lattnerf6278922004-09-20 04:36:29 +0000[diff] [blame]26 <li><a href="#ModulePass">The <tt>ModulePass</tt> class</a>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]27 <ul>
Chris Lattnerf6278922004-09-20 04:36:29 +0000[diff] [blame]28 <li><a href="#runOnModule">The <tt>runOnModule</tt> method</a></li>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]29 </ul></li>
Chris Lattner8fdb2462004-09-18 06:39:35 +0000[diff] [blame]30 <li><a href="#CallGraphSCCPass">The <tt>CallGraphSCCPass</tt> class</a>
31 <ul>
Devang Patelc20048d2007-01-23 22:56:28 +0000[diff] [blame]32 <li><a href="#doInitialization_scc">The <tt>doInitialization(CallGraph
Chris Lattner8fdb2462004-09-18 06:39:35 +0000[diff] [blame]33 &amp;)</tt> method</a></li>
34 <li><a href="#runOnSCC">The <tt>runOnSCC</tt> method</a></li>
Devang Patelc20048d2007-01-23 22:56:28 +0000[diff] [blame]35 <li><a href="#doFinalization_scc">The <tt>doFinalization(CallGraph
Chris Lattner8fdb2462004-09-18 06:39:35 +0000[diff] [blame]36 &amp;)</tt> method</a></li>
37 </ul></li>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]38 <li><a href="#FunctionPass">The <tt>FunctionPass</tt> class</a>
39 <ul>
Chris Lattnerd0713f92002-09-12 17:06:43 +0000[diff] [blame]40 <li><a href="#doInitialization_mod">The <tt>doInitialization(Module
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]41 &amp;)</tt> method</a></li>
42 <li><a href="#runOnFunction">The <tt>runOnFunction</tt> method</a></li>
Chris Lattnerd0713f92002-09-12 17:06:43 +0000[diff] [blame]43 <li><a href="#doFinalization_mod">The <tt>doFinalization(Module
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]44 &amp;)</tt> method</a></li>
45 </ul></li>
Devang Patel2e8f27d2007-03-19 22:21:25 +0000[diff] [blame]46 <li><a href="#LoopPass">The <tt>LoopPass</tt> class</a>
47 <ul>
48 <li><a href="#doInitialization_loop">The <tt>doInitialization(Loop *,
49 LPPassManager &amp;)</tt> method</a></li>
50 <li><a href="#runOnLoop">The <tt>runOnLoop</tt> method</a></li>
51 <li><a href="#doFinalization_loop">The <tt>doFinalization()
52 </tt> method</a></li>
53 </ul></li>
Tobias Grosser65513602010-10-20 01:54:44 +0000[diff] [blame]54 <li><a href="#RegionPass">The <tt>RegionPass</tt> class</a>
55 <ul>
56 <li><a href="#doInitialization_region">The <tt>doInitialization(Region *,
57 RGPassManager &amp;)</tt> method</a></li>
58 <li><a href="#runOnRegion">The <tt>runOnRegion</tt> method</a></li>
59 <li><a href="#doFinalization_region">The <tt>doFinalization()
60 </tt> method</a></li>
61 </ul></li>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]62 <li><a href="#BasicBlockPass">The <tt>BasicBlockPass</tt> class</a>
63 <ul>
Chris Lattnerd0713f92002-09-12 17:06:43 +0000[diff] [blame]64 <li><a href="#doInitialization_fn">The <tt>doInitialization(Function
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]65 &amp;)</tt> method</a></li>
66 <li><a href="#runOnBasicBlock">The <tt>runOnBasicBlock</tt>
67 method</a></li>
Chris Lattnerd0713f92002-09-12 17:06:43 +0000[diff] [blame]68 <li><a href="#doFinalization_fn">The <tt>doFinalization(Function
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]69 &amp;)</tt> method</a></li>
70 </ul></li>
Brian Gaekecab8b6f2003-07-17 18:53:20 +0000[diff] [blame]71 <li><a href="#MachineFunctionPass">The <tt>MachineFunctionPass</tt>
72 class</a>
Brian Gaeke6a33f362003-07-22 20:53:20 +0000[diff] [blame]73 <ul>
74 <li><a href="#runOnMachineFunction">The
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]75 <tt>runOnMachineFunction(MachineFunction &amp;)</tt> method</a></li>
76 </ul></li>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]77 </ul>
78 <li><a href="#registration">Pass Registration</a>
79 <ul>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]80 <li><a href="#print">The <tt>print</tt> method</a></li>
81 </ul></li>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]82 <li><a href="#interaction">Specifying interactions between passes</a>
83 <ul>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]84 <li><a href="#getAnalysisUsage">The <tt>getAnalysisUsage</tt>
85 method</a></li>
Chris Lattner89256272004-03-17 21:09:55 +0000[diff] [blame]86 <li><a href="#AU::addRequired">The <tt>AnalysisUsage::addRequired&lt;&gt;</tt> and <tt>AnalysisUsage::addRequiredTransitive&lt;&gt;</tt> methods</a></li>
87 <li><a href="#AU::addPreserved">The <tt>AnalysisUsage::addPreserved&lt;&gt;</tt> method</a></li>
88 <li><a href="#AU::examples">Example implementations of <tt>getAnalysisUsage</tt></a></li>
Duncan Sands1465d612009-01-28 13:14:17 +0000[diff] [blame]89 <li><a href="#getAnalysis">The <tt>getAnalysis&lt;&gt;</tt> and
90<tt>getAnalysisIfAvailable&lt;&gt;</tt> methods</a></li>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]91 </ul></li>
Chris Lattner79910702002-08-22 19:21:04 +0000[diff] [blame]92 <li><a href="#analysisgroup">Implementing Analysis Groups</a>
93 <ul>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]94 <li><a href="#agconcepts">Analysis Group Concepts</a></li>
95 <li><a href="#registerag">Using <tt>RegisterAnalysisGroup</tt></a></li>
96 </ul></li>
Tanya Lattnerd5383652004-11-19 01:25:14 +0000[diff] [blame]97 <li><a href="#passStatistics">Pass Statistics</a>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]98 <li><a href="#passmanager">What PassManager does</a>
99 <ul>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]100 <li><a href="#releaseMemory">The <tt>releaseMemory</tt> method</a></li>
101 </ul></li>
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]102 <li><a href="#registering">Registering dynamically loaded passes</a>
103 <ul>
104 <li><a href="#registering_existing">Using existing registries</a></li>
105 <li><a href="#registering_new">Creating new registries</a></li>
106 </ul></li>
Chris Lattner480e2ef2002-09-06 02:02:58 +0000[diff] [blame]107 <li><a href="#debughints">Using GDB with dynamically loaded passes</a>
108 <ul>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]109 <li><a href="#breakpoint">Setting a breakpoint in your pass</a></li>
110 <li><a href="#debugmisc">Miscellaneous Problems</a></li>
111 </ul></li>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]112 <li><a href="#future">Future extensions planned</a>
113 <ul>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]114 <li><a href="#SMP">Multithreaded LLVM</a></li>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]115 </ul></li>
116</ol>
Chris Lattner38c633d2002-08-08 20:23:41 +0000[diff] [blame]117
Chris Lattner7911ce22004-05-23 21:07:27 +0000[diff] [blame]118<div class="doc_author">
Chris Lattner8f652eb2006-08-11 16:37:02 +0000[diff] [blame]119 <p>Written by <a href="mailto:sabre@nondot.org">Chris Lattner</a> and
Jim Laskeyc760a922007-03-14 19:32:21 +0000[diff] [blame]120 <a href="mailto:jlaskey@mac.com">Jim Laskey</a></p>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]121</div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]122
123<!-- *********************************************************************** -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]124<h2>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]125 <a name="introduction">Introduction - What is a pass?</a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]126</h2>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]127<!-- *********************************************************************** -->
128
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]129<div class="doc_text">
130
131<p>The LLVM Pass Framework is an important part of the LLVM system, because LLVM
Chris Lattner8fdb2462004-09-18 06:39:35 +0000[diff] [blame]132passes are where most of the interesting parts of the compiler exist. Passes
133perform the transformations and optimizations that make up the compiler, they
134build the analysis results that are used by these transformations, and they are,
135above all, a structuring technique for compiler code.</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]136
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]137<p>All LLVM passes are subclasses of the <tt><a
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]138href="http://llvm.org/doxygen/classllvm_1_1Pass.html">Pass</a></tt>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]139class, which implement functionality by overriding virtual methods inherited
Chris Lattnerf6278922004-09-20 04:36:29 +0000[diff] [blame]140from <tt>Pass</tt>. Depending on how your pass works, you should inherit from
141the <tt><a href="#ModulePass">ModulePass</a></tt>, <tt><a
142href="#CallGraphSCCPass">CallGraphSCCPass</a></tt>, <tt><a
143href="#FunctionPass">FunctionPass</a></tt>, or <tt><a
Devang Patel2e8f27d2007-03-19 22:21:25 +0000[diff] [blame]144href="#LoopPass">LoopPass</a></tt>, or <tt><a
Tobias Grosser65513602010-10-20 01:54:44 +0000[diff] [blame]145href="#RegionPass">RegionPass</a></tt>, or <tt><a
Chris Lattner8fdb2462004-09-18 06:39:35 +0000[diff] [blame]146href="#BasicBlockPass">BasicBlockPass</a></tt> classes, which gives the system
147more information about what your pass does, and how it can be combined with
148other passes. One of the main features of the LLVM Pass Framework is that it
149schedules passes to run in an efficient way based on the constraints that your
150pass meets (which are indicated by which class they derive from).</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]151
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]152<p>We start by showing you how to construct a pass, everything from setting up
153the code, to compiling, loading, and executing it. After the basics are down,
154more advanced features are discussed.</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]155
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]156</div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]157
158<!-- *********************************************************************** -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]159<h2>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]160 <a name="quickstart">Quick Start - Writing hello world</a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]161</h2>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]162<!-- *********************************************************************** -->
163
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]164<div class="doc_text">
165
166<p>Here we describe how to write the "hello world" of passes. The "Hello" pass
167is designed to simply print out the name of non-external functions that exist in
Chris Lattner8fdb2462004-09-18 06:39:35 +0000[diff] [blame]168the program being compiled. It does not modify the program at all, it just
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]169inspects it. The source code and files for this pass are available in the LLVM
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]170source tree in the <tt>lib/Transforms/Hello</tt> directory.</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]171
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]172</div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]173
174<!-- ======================================================================= -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]175<h3>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]176 <a name="makefile">Setting up the build environment</a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]177</h3>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]178
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]179<div class="doc_text">
180
Duncan Sandsdc97c0b2011-01-01 17:28:49 +0000[diff] [blame]181 <p>First, configure and build LLVM. This needs to be done directly inside the
182 LLVM source tree rather than in a separate objects directory.
183 Next, you need to create a new directory somewhere in the LLVM source
Reid Spencer1bc19342004-12-11 05:12:57 +0000[diff] [blame]184 base. For this example, we'll assume that you made
Duncan Sandsdc97c0b2011-01-01 17:28:49 +0000[diff] [blame]185 <tt>lib/Transforms/Hello</tt>. Finally, you must set up a build script
Reid Spencer1bc19342004-12-11 05:12:57 +0000[diff] [blame]186 (Makefile) that will compile the source code for the new pass. To do this,
187 copy the following into <tt>Makefile</tt>:</p>
NAKAMURA Takumi4d6deb02011-04-09 09:51:57 +0000[diff] [blame]188 <hr>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]189
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]190<div class="doc_code"><pre>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]191# Makefile for hello pass
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]192
Torok Edwin87469292009-10-12 13:37:29 +0000[diff] [blame]193# Path to top level of LLVM hierarchy
Chris Lattner7ce83e52002-08-14 20:07:01 +0000[diff] [blame]194LEVEL = ../../..
Chris Lattner17a4c3e2002-08-14 20:06:13 +0000[diff] [blame]195
196# Name of the library to build
Reid Spencer7fa6d522005-01-11 05:16:23 +0000[diff] [blame]197LIBRARYNAME = Hello
Chris Lattner17a4c3e2002-08-14 20:06:13 +0000[diff] [blame]198
Reid Spencer7fa6d522005-01-11 05:16:23 +0000[diff] [blame]199# Make the shared library become a loadable module so the tools can
200# dlopen/dlsym on the resulting library.
Robert Bocchino3cf817d2006-01-06 22:49:23 +0000[diff] [blame]201LOADABLE_MODULE = 1
Reid Spencer7fa6d522005-01-11 05:16:23 +0000[diff] [blame]202
Chris Lattner17a4c3e2002-08-14 20:06:13 +0000[diff] [blame]203# Include the makefile implementation stuff
204include $(LEVEL)/Makefile.common
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]205</pre></div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]206
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]207<p>This makefile specifies that all of the <tt>.cpp</tt> files in the current
Duncan Sands779ff7f2011-01-01 17:21:58 +0000[diff] [blame]208directory are to be compiled and linked together into a shared object
209<tt>$(LEVEL)/Debug+Asserts/lib/Hello.so</tt> that can be dynamically loaded by
Chris Lattnerc8603c22006-08-27 23:18:52 +0000[diff] [blame]210the <tt>opt</tt> or <tt>bugpoint</tt> tools via their <tt>-load</tt> options.
Reid Spencer7fa6d522005-01-11 05:16:23 +0000[diff] [blame]211If your operating system uses a suffix other than .so (such as windows or
212Mac OS/X), the appropriate extension will be used.</p>
John Criswellf9c78652004-01-26 21:26:54 +0000[diff] [blame]213
Oscar Fuentes23ba1e42011-04-12 19:40:35 +0000[diff] [blame]214<p>If you are used CMake to build LLVM, see
215<a href="CMake.html#passdev">Developing an LLVM pass with CMake</a>.</p>
216
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]217<p>Now that we have the build scripts set up, we just need to write the code for
218the pass itself.</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]219
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]220</div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]221
222<!-- ======================================================================= -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]223<h3>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]224 <a name="basiccode">Basic code required</a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]225</h3>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]226
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]227<div class="doc_text">
228
229<p>Now that we have a way to compile our new pass, we just have to write it.
230Start out with:</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]231
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]232<div class="doc_code"><pre>
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]233<b>#include</b> "<a href="http://llvm.org/doxygen/Pass_8h-source.html">llvm/Pass.h</a>"
234<b>#include</b> "<a href="http://llvm.org/doxygen/Function_8h-source.html">llvm/Function.h</a>"
Chris Lattner0ce6f932009-09-08 05:14:44 +0000[diff] [blame]235<b>#include</b> "<a href="http://llvm.org/doxygen/raw__ostream_8h.html">llvm/Support/raw_ostream.h</a>"
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]236</pre></div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]237
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]238<p>Which are needed because we are writing a <tt><a
Chris Lattner0ce6f932009-09-08 05:14:44 +0000[diff] [blame]239href="http://llvm.org/doxygen/classllvm_1_1Pass.html">Pass</a></tt>,
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]240we are operating on <tt><a
Chris Lattner0ce6f932009-09-08 05:14:44 +0000[diff] [blame]241href="http://llvm.org/doxygen/classllvm_1_1Function.html">Function</a></tt>'s,
242and we will be doing some printing.</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]243
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]244<p>Next we have:</p>
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]245<div class="doc_code"><pre>
Jonathan Manton65acb302004-06-30 18:10:30 +0000[diff] [blame]246<b>using namespace llvm;</b>
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]247</pre></div>
Jonathan Manton65acb302004-06-30 18:10:30 +0000[diff] [blame]248<p>... which is required because the functions from the include files
249live in the llvm namespace.
250</p>
251
252<p>Next we have:</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]253
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]254<div class="doc_code"><pre>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]255<b>namespace</b> {
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]256</pre></div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]257
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]258<p>... which starts out an anonymous namespace. Anonymous namespaces are to C++
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]259what the "<tt>static</tt>" keyword is to C (at global scope). It makes the
260things declared inside of the anonymous namespace only visible to the current
261file. If you're not familiar with them, consult a decent C++ book for more
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]262information.</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]263
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]264<p>Next, we declare our pass itself:</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]265
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]266<div class="doc_code"><pre>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]267 <b>struct</b> Hello : <b>public</b> <a href="#FunctionPass">FunctionPass</a> {
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]268</pre></div><p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]269
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]270<p>This declares a "<tt>Hello</tt>" class that is a subclass of <tt><a
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]271href="http://llvm.org/doxygen/classllvm_1_1FunctionPass.html">FunctionPass</a></tt>.
Chris Lattnerd6ea9262002-09-09 03:48:46 +0000[diff] [blame]272The different builtin pass subclasses are described in detail <a
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]273href="#passtype">later</a>, but for now, know that <a
274href="#FunctionPass"><tt>FunctionPass</tt></a>'s operate a function at a
275time.</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]276
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]277<div class="doc_code"><pre>
Devang Patel19974732007-05-03 01:11:54 +0000[diff] [blame]278 static char ID;
Duncan Sands5e09eef2011-01-01 17:37:07 +0000[diff] [blame]279 Hello() : FunctionPass(ID) {}
Devang Patele50fb9a2007-05-01 20:55:38 +0000[diff] [blame]280</pre></div><p>
281
282<p> This declares pass identifier used by LLVM to identify pass. This allows LLVM to
283avoid using expensive C++ runtime information.</p>
284
285<div class="doc_code"><pre>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]286 <b>virtual bool</b> <a href="#runOnFunction">runOnFunction</a>(Function &amp;F) {
Chris Lattner0ce6f932009-09-08 05:14:44 +0000[diff] [blame]287 errs() &lt;&lt; "<i>Hello: </i>" &lt;&lt; F.getName() &lt;&lt; "\n";
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]288 <b>return false</b>;
289 }
290 }; <i>// end of struct Hello</i>
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]291</pre></div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]292
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]293<p>We declare a "<a href="#runOnFunction"><tt>runOnFunction</tt></a>" method,
294which overloads an abstract virtual method inherited from <a
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]295href="#FunctionPass"><tt>FunctionPass</tt></a>. This is where we are supposed
296to do our thing, so we just print out our message with the name of each
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]297function.</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]298
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]299<div class="doc_code"><pre>
Devang Patel19974732007-05-03 01:11:54 +0000[diff] [blame]300 char Hello::ID = 0;
Devang Patele50fb9a2007-05-01 20:55:38 +0000[diff] [blame]301</pre></div>
302
303<p> We initialize pass ID here. LLVM uses ID's address to identify pass so
304initialization value is not important.</p>
305
306<div class="doc_code"><pre>
NAKAMURA Takumi4d6deb02011-04-09 09:51:57 +0000[diff] [blame]307 static RegisterPass&lt;Hello&gt; X("<i>hello</i>", "<i>Hello World Pass</i>",
Devang Patelc7582092008-03-19 21:56:59 +0000[diff] [blame]308 false /* Only looks at CFG */,
309 false /* Analysis Pass */);
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]310} <i>// end of anonymous namespace</i>
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]311</pre></div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]312
Chris Lattnerc8603c22006-08-27 23:18:52 +0000[diff] [blame]313<p>Lastly, we <a href="#registration">register our class</a> <tt>Hello</tt>,
314giving it a command line
Devang Patelc7582092008-03-19 21:56:59 +0000[diff] [blame]315argument "<tt>hello</tt>", and a name "<tt>Hello World Pass</tt>".
Owen Anderson20813e02010-07-21 22:58:07 +0000[diff] [blame]316Last two arguments describe its behavior.
Devang Patelc7582092008-03-19 21:56:59 +0000[diff] [blame]317If a pass walks CFG without modifying it then third argument is set to true.
318If a pass is an analysis pass, for example dominator tree pass, then true
319is supplied as fourth argument. </p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]320
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]321<p>As a whole, the <tt>.cpp</tt> file looks like:</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]322
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]323<div class="doc_code"><pre>
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]324<b>#include</b> "<a href="http://llvm.org/doxygen/Pass_8h-source.html">llvm/Pass.h</a>"
325<b>#include</b> "<a href="http://llvm.org/doxygen/Function_8h-source.html">llvm/Function.h</a>"
Chris Lattner0ce6f932009-09-08 05:14:44 +0000[diff] [blame]326<b>#include</b> "<a href="http://llvm.org/doxygen/raw__ostream_8h.html">llvm/Support/raw_ostream.h</a>"
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]327
Jonathan Manton65acb302004-06-30 18:10:30 +0000[diff] [blame]328<b>using namespace llvm;</b>
329
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]330<b>namespace</b> {
331 <b>struct Hello</b> : <b>public</b> <a href="#FunctionPass">FunctionPass</a> {
Devang Patele50fb9a2007-05-01 20:55:38 +0000[diff] [blame]332
Devang Patel19974732007-05-03 01:11:54 +0000[diff] [blame]333 static char ID;
Duncan Sands5e09eef2011-01-01 17:37:07 +0000[diff] [blame]334 Hello() : FunctionPass(ID) {}
Devang Patele50fb9a2007-05-01 20:55:38 +0000[diff] [blame]335
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]336 <b>virtual bool</b> <a href="#runOnFunction">runOnFunction</a>(Function &amp;F) {
Chris Lattner0ce6f932009-09-08 05:14:44 +0000[diff] [blame]337 errs() &lt;&lt; "<i>Hello: </i>" &lt;&lt; F.getName() &lt;&lt; "\n";
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]338 <b>return false</b>;
339 }
340 };
341
Devang Patel26e5a302007-07-25 21:05:39 +0000[diff] [blame]342 char Hello::ID = 0;
NAKAMURA Takumi4d6deb02011-04-09 09:51:57 +0000[diff] [blame]343 static RegisterPass&lt;Hello&gt; X("hello", "Hello World Pass", false, false);
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]344}
Owen Anderson20813e02010-07-21 22:58:07 +0000[diff] [blame]345
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]346</pre></div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]347
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]348<p>Now that it's all together, compile the file with a simple "<tt>gmake</tt>"
Duncan Sands779ff7f2011-01-01 17:21:58 +0000[diff] [blame]349command in the local directory and you should get a new file
350"<tt>Debug+Asserts/lib/Hello.so</tt>" under the top level directory of the LLVM
351source tree (not in the local directory). Note that everything in this file is
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]352contained in an anonymous namespace: this reflects the fact that passes are self
353contained units that do not need external interfaces (although they can have
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]354them) to be useful.</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]355
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]356</div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]357
358<!-- ======================================================================= -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]359<h3>
Chris Lattnerc8603c22006-08-27 23:18:52 +0000[diff] [blame]360 <a name="running">Running a pass with <tt>opt</tt></a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]361</h3>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]362
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]363<div class="doc_text">
364
John Criswellf9c78652004-01-26 21:26:54 +0000[diff] [blame]365<p>Now that you have a brand new shiny shared object file, we can use the
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]366<tt>opt</tt> command to run an LLVM program through your pass. Because you
Duncan Sands5e09eef2011-01-01 17:37:07 +0000[diff] [blame]367registered your pass with <tt>RegisterPass</tt>, you will be able to
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]368use the <tt>opt</tt> tool to access it, once loaded.</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]369
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]370<p>To test it, follow the example at the end of the <a
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]371href="GettingStarted.html">Getting Started Guide</a> to compile "Hello World" to
Gabor Greif04367bf2007-07-06 22:07:22 +0000[diff] [blame]372LLVM. We can now run the bitcode file (<tt>hello.bc</tt>) for the program
373through our transformation like this (or course, any bitcode file will
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]374work):</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]375
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]376<div class="doc_code"><pre>
Duncan Sands67f8a7b2010-07-08 08:27:18 +0000[diff] [blame]377$ opt -load ../../../Debug+Asserts/lib/Hello.so -hello &lt; hello.bc &gt; /dev/null
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]378Hello: __main
379Hello: puts
380Hello: main
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]381</pre></div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]382
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]383<p>The '<tt>-load</tt>' option specifies that '<tt>opt</tt>' should load your
384pass as a shared object, which makes '<tt>-hello</tt>' a valid command line
385argument (which is one reason you need to <a href="#registration">register your
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]386pass</a>). Because the hello pass does not modify the program in any
387interesting way, we just throw away the result of <tt>opt</tt> (sending it to
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]388<tt>/dev/null</tt>).</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]389
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]390<p>To see what happened to the other string you registered, try running
Duncan Sands7e7ae5a2010-02-18 14:08:13 +0000[diff] [blame]391<tt>opt</tt> with the <tt>-help</tt> option:</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]392
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]393<div class="doc_code"><pre>
Duncan Sands67f8a7b2010-07-08 08:27:18 +0000[diff] [blame]394$ opt -load ../../../Debug+Asserts/lib/Hello.so -help
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]395OVERVIEW: llvm .bc -&gt; .bc modular optimizer
396
Gabor Greif04367bf2007-07-06 22:07:22 +0000[diff] [blame]397USAGE: opt [options] &lt;input bitcode&gt;
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]398
399OPTIONS:
400 Optimizations available:
401...
402 -funcresolve - Resolve Functions
403 -gcse - Global Common Subexpression Elimination
404 -globaldce - Dead Global Elimination
405 <b>-hello - Hello World Pass</b>
Chris Lattner065a6162003-09-10 05:29:43 +0000[diff] [blame]406 -indvars - Canonicalize Induction Variables
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]407 -inline - Function Integration/Inlining
408 -instcombine - Combine redundant instructions
409...
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]410</pre></div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]411
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]412<p>The pass name get added as the information string for your pass, giving some
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]413documentation to users of <tt>opt</tt>. Now that you have a working pass, you
414would go ahead and make it do the cool transformations you want. Once you get
415it all working and tested, it may become useful to find out how fast your pass
416is. The <a href="#passManager"><tt>PassManager</tt></a> provides a nice command
417line option (<tt>--time-passes</tt>) that allows you to get information about
418the execution time of your pass along with the other passes you queue up. For
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]419example:</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]420
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]421<div class="doc_code"><pre>
Duncan Sands67f8a7b2010-07-08 08:27:18 +0000[diff] [blame]422$ opt -load ../../../Debug+Asserts/lib/Hello.so -hello -time-passes &lt; hello.bc &gt; /dev/null
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]423Hello: __main
424Hello: puts
425Hello: main
426===============================================================================
427 ... Pass execution timing report ...
428===============================================================================
429 Total Execution Time: 0.02 seconds (0.0479059 wall clock)
430
431 ---User Time--- --System Time-- --User+System-- ---Wall Time--- --- Pass Name ---
Gabor Greif04367bf2007-07-06 22:07:22 +0000[diff] [blame]432 0.0100 (100.0%) 0.0000 ( 0.0%) 0.0100 ( 50.0%) 0.0402 ( 84.0%) Bitcode Writer
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]433 0.0000 ( 0.0%) 0.0100 (100.0%) 0.0100 ( 50.0%) 0.0031 ( 6.4%) Dominator Set Construction
434 0.0000 ( 0.0%) 0.0000 ( 0.0%) 0.0000 ( 0.0%) 0.0013 ( 2.7%) Module Verifier
435 <b> 0.0000 ( 0.0%) 0.0000 ( 0.0%) 0.0000 ( 0.0%) 0.0033 ( 6.9%) Hello World Pass</b>
436 0.0100 (100.0%) 0.0100 (100.0%) 0.0200 (100.0%) 0.0479 (100.0%) TOTAL
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]437</pre></div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]438
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]439<p>As you can see, our implementation above is pretty fast :). The additional
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]440passes listed are automatically inserted by the '<tt>opt</tt>' tool to verify
441that the LLVM emitted by your pass is still valid and well formed LLVM, which
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]442hasn't been broken somehow.</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]443
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]444<p>Now that you have seen the basics of the mechanics behind passes, we can talk
445about some more details of how they work and how to use them.</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]446
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]447</div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]448
449<!-- *********************************************************************** -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]450<h2>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]451 <a name="passtype">Pass classes and requirements</a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]452</h2>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]453<!-- *********************************************************************** -->
454
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]455<div class="doc_text">
456
457<p>One of the first things that you should do when designing a new pass is to
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]458decide what class you should subclass for your pass. The <a
459href="#basiccode">Hello World</a> example uses the <tt><a
460href="#FunctionPass">FunctionPass</a></tt> class for its implementation, but we
461did not discuss why or when this should occur. Here we talk about the classes
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]462available, from the most general to the most specific.</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]463
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]464<p>When choosing a superclass for your Pass, you should choose the <b>most
Chris Lattner79910702002-08-22 19:21:04 +0000[diff] [blame]465specific</b> class possible, while still being able to meet the requirements
Misha Brukman5560c9d2003-08-18 14:43:39 +0000[diff] [blame]466listed. This gives the LLVM Pass Infrastructure information necessary to
Benjamin Kramer8040cd32009-10-12 14:46:08 +0000[diff] [blame]467optimize how passes are run, so that the resultant compiler isn't unnecessarily
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]468slow.</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]469
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]470</div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]471
Chris Lattnerf004f9a2002-09-25 22:31:38 +0000[diff] [blame]472<!-- ======================================================================= -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]473<h3>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]474 <a name="ImmutablePass">The <tt>ImmutablePass</tt> class</a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]475</h3>
Chris Lattnerf004f9a2002-09-25 22:31:38 +0000[diff] [blame]476
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]477<div class="doc_text">
478
479<p>The most plain and boring type of pass is the "<tt><a
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]480href="http://llvm.org/doxygen/classllvm_1_1ImmutablePass.html">ImmutablePass</a></tt>"
Chris Lattnerf004f9a2002-09-25 22:31:38 +0000[diff] [blame]481class. This pass type is used for passes that do not have to be run, do not
482change state, and never need to be updated. This is not a normal type of
483transformation or analysis, but can provide information about the current
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]484compiler configuration.</p>
Chris Lattnerf004f9a2002-09-25 22:31:38 +0000[diff] [blame]485
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]486<p>Although this pass class is very infrequently used, it is important for
Chris Lattnerf004f9a2002-09-25 22:31:38 +0000[diff] [blame]487providing information about the current target machine being compiled for, and
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]488other static information that can affect the various transformations.</p>
Chris Lattnerf004f9a2002-09-25 22:31:38 +0000[diff] [blame]489
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]490<p><tt>ImmutablePass</tt>es never invalidate other transformations, are never
491invalidated, and are never "run".</p>
Chris Lattnerf004f9a2002-09-25 22:31:38 +0000[diff] [blame]492
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]493</div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]494
495<!-- ======================================================================= -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]496<h3>
Chris Lattnerf6278922004-09-20 04:36:29 +0000[diff] [blame]497 <a name="ModulePass">The <tt>ModulePass</tt> class</a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]498</h3>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]499
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]500<div class="doc_text">
501
502<p>The "<tt><a
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]503href="http://llvm.org/doxygen/classllvm_1_1ModulePass.html">ModulePass</a></tt>"
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]504class is the most general of all superclasses that you can use. Deriving from
Chris Lattnerf6278922004-09-20 04:36:29 +0000[diff] [blame]505<tt>ModulePass</tt> indicates that your pass uses the entire program as a unit,
Benjamin Kramer8040cd32009-10-12 14:46:08 +0000[diff] [blame]506referring to function bodies in no predictable order, or adding and removing
Chris Lattnerf6278922004-09-20 04:36:29 +0000[diff] [blame]507functions. Because nothing is known about the behavior of <tt>ModulePass</tt>
Daniel Dunbarb71725b2009-07-01 23:38:44 +0000[diff] [blame]508subclasses, no optimization can be done for their execution.</p>
509
510<p>A module pass can use function level passes (e.g. dominators) using
511the getAnalysis interface
512<tt>getAnalysis&lt;DominatorTree&gt;(llvm::Function *)</tt> to provide the
513function to retrieve analysis result for, if the function pass does not require
Devang Patel468857f2009-08-10 16:37:29 +0000[diff] [blame]514any module or immutable passes. Note that this can only be done for functions for which the
Daniel Dunbarb71725b2009-07-01 23:38:44 +0000[diff] [blame]515analysis ran, e.g. in the case of dominators you should only ask for the
516DominatorTree for function definitions, not declarations.</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]517
Chris Lattnerf6278922004-09-20 04:36:29 +0000[diff] [blame]518<p>To write a correct <tt>ModulePass</tt> subclass, derive from
519<tt>ModulePass</tt> and overload the <tt>runOnModule</tt> method with the
520following signature:</p>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]521
522</div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]523
524<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]525<h4>
Chris Lattnerf6278922004-09-20 04:36:29 +0000[diff] [blame]526 <a name="runOnModule">The <tt>runOnModule</tt> method</a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]527</h4>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]528
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]529<div class="doc_text">
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]530
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]531<div class="doc_code"><pre>
Chris Lattnerf6278922004-09-20 04:36:29 +0000[diff] [blame]532 <b>virtual bool</b> runOnModule(Module &amp;M) = 0;
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]533</pre></div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]534
John Criswell2382ff72005-07-15 19:25:12 +0000[diff] [blame]535<p>The <tt>runOnModule</tt> method performs the interesting work of the pass.
536It should return true if the module was modified by the transformation and
537false otherwise.</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]538
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]539</div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]540
541<!-- ======================================================================= -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]542<h3>
Chris Lattner8fdb2462004-09-18 06:39:35 +0000[diff] [blame]543 <a name="CallGraphSCCPass">The <tt>CallGraphSCCPass</tt> class</a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]544</h3>
Chris Lattner8fdb2462004-09-18 06:39:35 +0000[diff] [blame]545
546<div class="doc_text">
547
548<p>The "<tt><a
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]549href="http://llvm.org/doxygen/classllvm_1_1CallGraphSCCPass.html">CallGraphSCCPass</a></tt>"
Chris Lattner8fdb2462004-09-18 06:39:35 +0000[diff] [blame]550is used by passes that need to traverse the program bottom-up on the call graph
551(callees before callers). Deriving from CallGraphSCCPass provides some
552mechanics for building and traversing the CallGraph, but also allows the system
553to optimize execution of CallGraphSCCPass's. If your pass meets the
554requirements outlined below, and doesn't meet the requirements of a <tt><a
555href="#FunctionPass">FunctionPass</a></tt> or <tt><a
556href="#BasicBlockPass">BasicBlockPass</a></tt>, you should derive from
557<tt>CallGraphSCCPass</tt>.</p>
558
559<p><b>TODO</b>: explain briefly what SCC, Tarjan's algo, and B-U mean.</p>
560
561<p>To be explicit, <tt>CallGraphSCCPass</tt> subclasses are:</p>
562
563<ol>
564
Nick Lewycky99597062011-01-03 06:16:07 +0000[diff] [blame]565<li>... <em>not allowed</em> to inspect or modify any <tt>Function</tt>s other
566than those in the current SCC and the direct callers and direct callees of the
567SCC.</li>
Chris Lattner8fdb2462004-09-18 06:39:35 +0000[diff] [blame]568
569<li>... <em>required</em> to preserve the current CallGraph object, updating it
570to reflect any changes made to the program.</li>
571
572<li>... <em>not allowed</em> to add or remove SCC's from the current Module,
573though they may change the contents of an SCC.</li>
574
575<li>... <em>allowed</em> to add or remove global variables from the current
576Module.</li>
577
578<li>... <em>allowed</em> to maintain state across invocations of
579 <a href="#runOnSCC"><tt>runOnSCC</tt></a> (including global data).</li>
580</ol>
581
582<p>Implementing a <tt>CallGraphSCCPass</tt> is slightly tricky in some cases
583because it has to handle SCCs with more than one node in it. All of the virtual
584methods described below should return true if they modified the program, or
585false if they didn't.</p>
586
587</div>
588
589<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]590<h4>
591 <a name="doInitialization_scc">
592 The <tt>doInitialization(CallGraph &amp;)</tt> method
593 </a>
594</h4>
Chris Lattner8fdb2462004-09-18 06:39:35 +0000[diff] [blame]595
596<div class="doc_text">
597
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]598<div class="doc_code"><pre>
Devang Patelc20048d2007-01-23 22:56:28 +0000[diff] [blame]599 <b>virtual bool</b> doInitialization(CallGraph &amp;CG);
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]600</pre></div>
Chris Lattner8fdb2462004-09-18 06:39:35 +0000[diff] [blame]601
602<p>The <tt>doIninitialize</tt> method is allowed to do most of the things that
603<tt>CallGraphSCCPass</tt>'s are not allowed to do. They can add and remove
604functions, get pointers to functions, etc. The <tt>doInitialization</tt> method
605is designed to do simple initialization type of stuff that does not depend on
606the SCCs being processed. The <tt>doInitialization</tt> method call is not
607scheduled to overlap with any other pass executions (thus it should be very
608fast).</p>
609
610</div>
611
612<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]613<h4>
Chris Lattner8fdb2462004-09-18 06:39:35 +0000[diff] [blame]614 <a name="runOnSCC">The <tt>runOnSCC</tt> method</a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]615</h4>
Chris Lattner8fdb2462004-09-18 06:39:35 +0000[diff] [blame]616
617<div class="doc_text">
618
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]619<div class="doc_code"><pre>
Chris Lattner6f25d9f2010-04-16 23:07:44 +0000[diff] [blame]620 <b>virtual bool</b> runOnSCC(CallGraphSCC &amp;SCC) = 0;
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]621</pre></div>
Chris Lattner8fdb2462004-09-18 06:39:35 +0000[diff] [blame]622
623<p>The <tt>runOnSCC</tt> method performs the interesting work of the pass, and
624should return true if the module was modified by the transformation, false
625otherwise.</p>
626
627</div>
628
629<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]630<h4>
631 <a name="doFinalization_scc">
632 The <tt>doFinalization(CallGraph &amp;)</tt> method
633 </a>
634</h4>
Chris Lattner8fdb2462004-09-18 06:39:35 +0000[diff] [blame]635
636<div class="doc_text">
637
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]638<div class="doc_code"><pre>
Devang Patelc20048d2007-01-23 22:56:28 +0000[diff] [blame]639 <b>virtual bool</b> doFinalization(CallGraph &amp;CG);
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]640</pre></div>
Chris Lattner8fdb2462004-09-18 06:39:35 +0000[diff] [blame]641
642<p>The <tt>doFinalization</tt> method is an infrequently used method that is
643called when the pass framework has finished calling <a
644href="#runOnFunction"><tt>runOnFunction</tt></a> for every function in the
645program being compiled.</p>
646
647</div>
648
649<!-- ======================================================================= -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]650<h3>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]651 <a name="FunctionPass">The <tt>FunctionPass</tt> class</a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]652</h3>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]653
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]654<div class="doc_text">
655
Chris Lattnerf6278922004-09-20 04:36:29 +0000[diff] [blame]656<p>In contrast to <tt>ModulePass</tt> subclasses, <tt><a
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]657href="http://llvm.org/doxygen/classllvm_1_1Pass.html">FunctionPass</a></tt>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]658subclasses do have a predictable, local behavior that can be expected by the
659system. All <tt>FunctionPass</tt> execute on each function in the program
Misha Brukmanef6a6a62003-08-21 22:14:26 +0000[diff] [blame]660independent of all of the other functions in the program.
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]661<tt>FunctionPass</tt>'s do not require that they are executed in a particular
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]662order, and <tt>FunctionPass</tt>'s do not modify external functions.</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]663
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]664<p>To be explicit, <tt>FunctionPass</tt> subclasses are not allowed to:</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]665
666<ol>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]667<li>Modify a Function other than the one currently being processed.</li>
668<li>Add or remove Function's from the current Module.</li>
669<li>Add or remove global variables from the current Module.</li>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]670<li>Maintain state across invocations of
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]671 <a href="#runOnFunction"><tt>runOnFunction</tt></a> (including global data)</li>
672</ol>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]673
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]674<p>Implementing a <tt>FunctionPass</tt> is usually straightforward (See the <a
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]675href="#basiccode">Hello World</a> pass for example). <tt>FunctionPass</tt>'s
676may overload three virtual methods to do their work. All of these methods
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]677should return true if they modified the program, or false if they didn't.</p>
678
679</div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]680
681<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]682<h4>
683 <a name="doInitialization_mod">
684 The <tt>doInitialization(Module &amp;)</tt> method
685 </a>
686</h4>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]687
688<div class="doc_text">
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]689
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]690<div class="doc_code"><pre>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]691 <b>virtual bool</b> doInitialization(Module &amp;M);
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]692</pre></div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]693
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]694<p>The <tt>doIninitialize</tt> method is allowed to do most of the things that
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]695<tt>FunctionPass</tt>'s are not allowed to do. They can add and remove
Chris Lattnerd0713f92002-09-12 17:06:43 +0000[diff] [blame]696functions, get pointers to functions, etc. The <tt>doInitialization</tt> method
697is designed to do simple initialization type of stuff that does not depend on
698the functions being processed. The <tt>doInitialization</tt> method call is not
699scheduled to overlap with any other pass executions (thus it should be very
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]700fast).</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]701
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]702<p>A good example of how this method should be used is the <a
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]703href="http://llvm.org/doxygen/LowerAllocations_8cpp-source.html">LowerAllocations</a>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]704pass. This pass converts <tt>malloc</tt> and <tt>free</tt> instructions into
Misha Brukmanef6a6a62003-08-21 22:14:26 +0000[diff] [blame]705platform dependent <tt>malloc()</tt> and <tt>free()</tt> function calls. It
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]706uses the <tt>doInitialization</tt> method to get a reference to the malloc and
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]707free functions that it needs, adding prototypes to the module if necessary.</p>
708
709</div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]710
711<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]712<h4>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]713 <a name="runOnFunction">The <tt>runOnFunction</tt> method</a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]714</h4>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]715
716<div class="doc_text">
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]717
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]718<div class="doc_code"><pre>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]719 <b>virtual bool</b> runOnFunction(Function &amp;F) = 0;
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]720</pre></div><p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]721
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]722<p>The <tt>runOnFunction</tt> method must be implemented by your subclass to do
723the transformation or analysis work of your pass. As usual, a true value should
724be returned if the function is modified.</p>
725
726</div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]727
728<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]729<h4>
730 <a name="doFinalization_mod">
731 The <tt>doFinalization(Module &amp;)</tt> method
732 </a>
733</h4>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]734
735<div class="doc_text">
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]736
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]737<div class="doc_code"><pre>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]738 <b>virtual bool</b> doFinalization(Module &amp;M);
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]739</pre></div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]740
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]741<p>The <tt>doFinalization</tt> method is an infrequently used method that is
742called when the pass framework has finished calling <a
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]743href="#runOnFunction"><tt>runOnFunction</tt></a> for every function in the
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]744program being compiled.</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]745
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]746</div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]747
748<!-- ======================================================================= -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]749<h3>
Devang Patel2e8f27d2007-03-19 22:21:25 +0000[diff] [blame]750 <a name="LoopPass">The <tt>LoopPass</tt> class </a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]751</h3>
Devang Patel2e8f27d2007-03-19 22:21:25 +0000[diff] [blame]752
753<div class="doc_text">
754
755<p> All <tt>LoopPass</tt> execute on each loop in the function independent of
756all of the other loops in the function. <tt>LoopPass</tt> processes loops in
757loop nest order such that outer most loop is processed last. </p>
758
759<p> <tt>LoopPass</tt> subclasses are allowed to update loop nest using
760<tt>LPPassManager</tt> interface. Implementing a loop pass is usually
Jay Foad71001c92011-04-07 12:41:09 +0000[diff] [blame]761straightforward. <tt>LoopPass</tt>'s may overload three virtual methods to
Devang Patel2e8f27d2007-03-19 22:21:25 +0000[diff] [blame]762do their work. All these methods should return true if they modified the
763program, or false if they didn't. </p>
764</div>
765
766<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]767<h4>
768 <a name="doInitialization_loop">
769 The <tt>doInitialization(Loop *,LPPassManager &amp;)</tt> method
770 </a>
771</h4>
Devang Patel2e8f27d2007-03-19 22:21:25 +0000[diff] [blame]772
773<div class="doc_text">
774
775<div class="doc_code"><pre>
776 <b>virtual bool</b> doInitialization(Loop *, LPPassManager &amp;LPM);
777</pre></div>
778
Chris Lattnerb5c87f62007-05-18 05:36:14 +0000[diff] [blame]779<p>The <tt>doInitialization</tt> method is designed to do simple initialization
Devang Patel2e8f27d2007-03-19 22:21:25 +0000[diff] [blame]780type of stuff that does not depend on the functions being processed. The
781<tt>doInitialization</tt> method call is not scheduled to overlap with any
782other pass executions (thus it should be very fast). LPPassManager
783interface should be used to access Function or Module level analysis
784information.</p>
785
786</div>
787
788
789<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]790<h4>
Devang Patel2e8f27d2007-03-19 22:21:25 +0000[diff] [blame]791 <a name="runOnLoop">The <tt>runOnLoop</tt> method</a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]792</h4>
Devang Patel2e8f27d2007-03-19 22:21:25 +0000[diff] [blame]793
794<div class="doc_text">
795
796<div class="doc_code"><pre>
797 <b>virtual bool</b> runOnLoop(Loop *, LPPassManager &amp;LPM) = 0;
798</pre></div><p>
799
800<p>The <tt>runOnLoop</tt> method must be implemented by your subclass to do
801the transformation or analysis work of your pass. As usual, a true value should
802be returned if the function is modified. <tt>LPPassManager</tt> interface
803should be used to update loop nest.</p>
804
805</div>
806
807<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]808<h4>
Devang Patel2e8f27d2007-03-19 22:21:25 +0000[diff] [blame]809 <a name="doFinalization_loop">The <tt>doFinalization()</tt> method</a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]810</h4>
Devang Patel2e8f27d2007-03-19 22:21:25 +0000[diff] [blame]811
812<div class="doc_text">
813
814<div class="doc_code"><pre>
815 <b>virtual bool</b> doFinalization();
816</pre></div>
817
818<p>The <tt>doFinalization</tt> method is an infrequently used method that is
819called when the pass framework has finished calling <a
820href="#runOnLoop"><tt>runOnLoop</tt></a> for every loop in the
821program being compiled. </p>
822
823</div>
824
Tobias Grosser65513602010-10-20 01:54:44 +0000[diff] [blame]825<!-- ======================================================================= -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]826<h3>
Tobias Grosser65513602010-10-20 01:54:44 +0000[diff] [blame]827 <a name="RegionPass">The <tt>RegionPass</tt> class </a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]828</h3>
Tobias Grosser65513602010-10-20 01:54:44 +0000[diff] [blame]829
830<div class="doc_text">
831
832<p> <tt>RegionPass</tt> is similar to <a href="#LoopPass"><tt>LoopPass</tt></a>,
833but executes on each single entry single exit region in the function.
834<tt>RegionPass</tt> processes regions in nested order such that the outer most
835region is processed last. </p>
836
837<p> <tt>RegionPass</tt> subclasses are allowed to update the region tree by using
838the <tt>RGPassManager</tt> interface. You may overload three virtual methods of
Jay Foad71001c92011-04-07 12:41:09 +0000[diff] [blame]839<tt>RegionPass</tt> to implement your own region pass. All these
Tobias Grosser65513602010-10-20 01:54:44 +0000[diff] [blame]840methods should return true if they modified the program, or false if they didn not.
841</p>
842</div>
843
844<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]845<h4>
846 <a name="doInitialization_region">
847 The <tt>doInitialization(Region *, RGPassManager &amp;)</tt> method
848 </a>
849</h4>
Tobias Grosser65513602010-10-20 01:54:44 +0000[diff] [blame]850
851<div class="doc_text">
852
853<div class="doc_code"><pre>
854 <b>virtual bool</b> doInitialization(Region *, RGPassManager &amp;RGM);
855</pre></div>
856
857<p>The <tt>doInitialization</tt> method is designed to do simple initialization
858type of stuff that does not depend on the functions being processed. The
859<tt>doInitialization</tt> method call is not scheduled to overlap with any
860other pass executions (thus it should be very fast). RPPassManager
861interface should be used to access Function or Module level analysis
862information.</p>
863
864</div>
865
866
867<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]868<h4>
Tobias Grosser65513602010-10-20 01:54:44 +0000[diff] [blame]869 <a name="runOnRegion">The <tt>runOnRegion</tt> method</a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]870</h4>
Tobias Grosser65513602010-10-20 01:54:44 +0000[diff] [blame]871
872<div class="doc_text">
873
874<div class="doc_code"><pre>
875 <b>virtual bool</b> runOnRegion(Region *, RGPassManager &amp;RGM) = 0;
876</pre></div><p>
877
878<p>The <tt>runOnRegion</tt> method must be implemented by your subclass to do
879the transformation or analysis work of your pass. As usual, a true value should
880be returned if the region is modified. <tt>RGPassManager</tt> interface
881should be used to update region tree.</p>
882
883</div>
884
885<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]886<h4>
Tobias Grosser65513602010-10-20 01:54:44 +0000[diff] [blame]887 <a name="doFinalization_region">The <tt>doFinalization()</tt> method</a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]888</h4>
Tobias Grosser65513602010-10-20 01:54:44 +0000[diff] [blame]889
890<div class="doc_text">
891
892<div class="doc_code"><pre>
893 <b>virtual bool</b> doFinalization();
894</pre></div>
895
896<p>The <tt>doFinalization</tt> method is an infrequently used method that is
897called when the pass framework has finished calling <a
898href="#runOnRegion"><tt>runOnRegion</tt></a> for every region in the
899program being compiled. </p>
900
901</div>
902
Devang Patel2e8f27d2007-03-19 22:21:25 +0000[diff] [blame]903
904
905<!-- ======================================================================= -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]906<h3>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]907 <a name="BasicBlockPass">The <tt>BasicBlockPass</tt> class</a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]908</h3>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]909
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]910<div class="doc_text">
911
912<p><tt>BasicBlockPass</tt>'s are just like <a
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]913href="#FunctionPass"><tt>FunctionPass</tt></a>'s, except that they must limit
914their scope of inspection and modification to a single basic block at a time.
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]915As such, they are <b>not</b> allowed to do any of the following:</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]916
917<ol>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]918<li>Modify or inspect any basic blocks outside of the current one</li>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]919<li>Maintain state across invocations of
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]920 <a href="#runOnBasicBlock"><tt>runOnBasicBlock</tt></a></li>
Reid Spencer1bc19342004-12-11 05:12:57 +0000[diff] [blame]921<li>Modify the control flow graph (by altering terminator instructions)</li>
922<li>Any of the things forbidden for
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]923 <a href="#FunctionPass"><tt>FunctionPass</tt></a>es.</li>
924</ol>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]925
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]926<p><tt>BasicBlockPass</tt>es are useful for traditional local and "peephole"
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]927optimizations. They may override the same <a
Chris Lattnerd0713f92002-09-12 17:06:43 +0000[diff] [blame]928href="#doInitialization_mod"><tt>doInitialization(Module &amp;)</tt></a> and <a
929href="#doFinalization_mod"><tt>doFinalization(Module &amp;)</tt></a> methods that <a
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]930href="#FunctionPass"><tt>FunctionPass</tt></a>'s have, but also have the following virtual methods that may also be implemented:</p>
931
932</div>
Chris Lattnerd0713f92002-09-12 17:06:43 +0000[diff] [blame]933
934<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]935<h4>
936 <a name="doInitialization_fn">
937 The <tt>doInitialization(Function &amp;)</tt> method
938 </a>
939</h4>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]940
941<div class="doc_text">
Chris Lattnerd0713f92002-09-12 17:06:43 +0000[diff] [blame]942
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]943<div class="doc_code"><pre>
Chris Lattnerd0713f92002-09-12 17:06:43 +0000[diff] [blame]944 <b>virtual bool</b> doInitialization(Function &amp;F);
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]945</pre></div>
Chris Lattnerd0713f92002-09-12 17:06:43 +0000[diff] [blame]946
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]947<p>The <tt>doIninitialize</tt> method is allowed to do most of the things that
Chris Lattnerd0713f92002-09-12 17:06:43 +0000[diff] [blame]948<tt>BasicBlockPass</tt>'s are not allowed to do, but that
949<tt>FunctionPass</tt>'s can. The <tt>doInitialization</tt> method is designed
Reid Spencer1bc19342004-12-11 05:12:57 +0000[diff] [blame]950to do simple initialization that does not depend on the
Chris Lattnerd0713f92002-09-12 17:06:43 +0000[diff] [blame]951BasicBlocks being processed. The <tt>doInitialization</tt> method call is not
952scheduled to overlap with any other pass executions (thus it should be very
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]953fast).</p>
Chris Lattnerd0713f92002-09-12 17:06:43 +0000[diff] [blame]954
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]955</div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]956
957<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]958<h4>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]959 <a name="runOnBasicBlock">The <tt>runOnBasicBlock</tt> method</a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]960</h4>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]961
962<div class="doc_text">
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]963
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]964<div class="doc_code"><pre>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]965 <b>virtual bool</b> runOnBasicBlock(BasicBlock &amp;BB) = 0;
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]966</pre></div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]967
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]968<p>Override this function to do the work of the <tt>BasicBlockPass</tt>. This
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]969function is not allowed to inspect or modify basic blocks other than the
970parameter, and are not allowed to modify the CFG. A true value must be returned
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]971if the basic block is modified.</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]972
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]973</div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]974
Chris Lattnerd0713f92002-09-12 17:06:43 +0000[diff] [blame]975<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]976<h4>
977 <a name="doFinalization_fn">
978 The <tt>doFinalization(Function &amp;)</tt> method
979 </a>
980</h4>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]981
982<div class="doc_text">
Chris Lattnerd0713f92002-09-12 17:06:43 +0000[diff] [blame]983
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]984<div class="doc_code"><pre>
Chris Lattnerd0713f92002-09-12 17:06:43 +0000[diff] [blame]985 <b>virtual bool</b> doFinalization(Function &amp;F);
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]986</pre></div>
Chris Lattnerd0713f92002-09-12 17:06:43 +0000[diff] [blame]987
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]988<p>The <tt>doFinalization</tt> method is an infrequently used method that is
989called when the pass framework has finished calling <a
Chris Lattnerd0713f92002-09-12 17:06:43 +0000[diff] [blame]990href="#runOnBasicBlock"><tt>runOnBasicBlock</tt></a> for every BasicBlock in the
991program being compiled. This can be used to perform per-function
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]992finalization.</p>
Chris Lattnerd0713f92002-09-12 17:06:43 +0000[diff] [blame]993
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]994</div>
Chris Lattnerd0713f92002-09-12 17:06:43 +0000[diff] [blame]995
Brian Gaekecab8b6f2003-07-17 18:53:20 +0000[diff] [blame]996<!-- ======================================================================= -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]997<h3>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]998 <a name="MachineFunctionPass">The <tt>MachineFunctionPass</tt> class</a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]999</h3>
Brian Gaekecab8b6f2003-07-17 18:53:20 +0000[diff] [blame]1000
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1001<div class="doc_text">
1002
Chris Lattner89256272004-03-17 21:09:55 +0000[diff] [blame]1003<p>A <tt>MachineFunctionPass</tt> is a part of the LLVM code generator that
1004executes on the machine-dependent representation of each LLVM function in the
Dan Gohman9f116aa2010-03-10 01:29:39 +0000[diff] [blame]1005program.</p>
1006
1007<p>Code generator passes are registered and initialized specially by
1008<tt>TargetMachine::addPassesToEmitFile</tt> and similar routines, so they
1009cannot generally be run from the <tt>opt</tt> or <tt>bugpoint</tt>
1010commands.</p>
1011
1012<p>A <tt>MachineFunctionPass</tt> is also a <tt>FunctionPass</tt>, so all
Brian Gaekecab8b6f2003-07-17 18:53:20 +0000[diff] [blame]1013the restrictions that apply to a <tt>FunctionPass</tt> also apply to it.
Chris Lattner89256272004-03-17 21:09:55 +0000[diff] [blame]1014<tt>MachineFunctionPass</tt>es also have additional restrictions. In particular,
1015<tt>MachineFunctionPass</tt>es are not allowed to do any of the following:</p>
Brian Gaekecab8b6f2003-07-17 18:53:20 +0000[diff] [blame]1016
1017<ol>
Dan Gohman9f116aa2010-03-10 01:29:39 +0000[diff] [blame]1018<li>Modify or create any LLVM IR Instructions, BasicBlocks, Arguments,
1019 Functions, GlobalVariables, GlobalAliases, or Modules.</li>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1020<li>Modify a MachineFunction other than the one currently being processed.</li>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1021<li>Maintain state across invocations of <a
1022href="#runOnMachineFunction"><tt>runOnMachineFunction</tt></a> (including global
1023data)</li>
1024</ol>
Brian Gaekecab8b6f2003-07-17 18:53:20 +0000[diff] [blame]1025
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1026</div>
Chris Lattnerd0713f92002-09-12 17:06:43 +0000[diff] [blame]1027
Brian Gaeke6a33f362003-07-22 20:53:20 +0000[diff] [blame]1028<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1029<h4>
1030 <a name="runOnMachineFunction">
1031 The <tt>runOnMachineFunction(MachineFunction &amp;MF)</tt> method
1032 </a>
1033</h4>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1034
1035<div class="doc_text">
Brian Gaeke6a33f362003-07-22 20:53:20 +0000[diff] [blame]1036
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]1037<div class="doc_code"><pre>
Brian Gaeke6a33f362003-07-22 20:53:20 +0000[diff] [blame]1038 <b>virtual bool</b> runOnMachineFunction(MachineFunction &amp;MF) = 0;
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]1039</pre></div>
Brian Gaeke6a33f362003-07-22 20:53:20 +0000[diff] [blame]1040
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1041<p><tt>runOnMachineFunction</tt> can be considered the main entry point of a
1042<tt>MachineFunctionPass</tt>; that is, you should override this method to do the
1043work of your <tt>MachineFunctionPass</tt>.</p>
Brian Gaeke6a33f362003-07-22 20:53:20 +0000[diff] [blame]1044
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1045<p>The <tt>runOnMachineFunction</tt> method is called on every
Brian Gaeke6a33f362003-07-22 20:53:20 +0000[diff] [blame]1046<tt>MachineFunction</tt> in a <tt>Module</tt>, so that the
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1047<tt>MachineFunctionPass</tt> may perform optimizations on the machine-dependent
1048representation of the function. If you want to get at the LLVM <tt>Function</tt>
1049for the <tt>MachineFunction</tt> you're working on, use
1050<tt>MachineFunction</tt>'s <tt>getFunction()</tt> accessor method -- but
1051remember, you may not modify the LLVM <tt>Function</tt> or its contents from a
1052<tt>MachineFunctionPass</tt>.</p>
1053
1054</div>
Brian Gaeke6a33f362003-07-22 20:53:20 +0000[diff] [blame]1055
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1056<!-- *********************************************************************** -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1057<h2>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1058 <a name="registration">Pass registration</a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1059</h2>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1060<!-- *********************************************************************** -->
1061
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1062<div class="doc_text">
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1063
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1064<p>In the <a href="#basiccode">Hello World</a> example pass we illustrated how
1065pass registration works, and discussed some of the reasons that it is used and
1066what it does. Here we discuss how and why passes are registered.</p>
1067
Duncan Sands5e09eef2011-01-01 17:37:07 +0000[diff] [blame]1068<p>As we saw above, passes are registered with the <b><tt>RegisterPass</tt></b>
1069template. The template parameter is the name of the pass that is to be used on
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1070the command line to specify that the pass should be added to a program (for
Duncan Sands5e09eef2011-01-01 17:37:07 +0000[diff] [blame]1071example, with <tt>opt</tt> or <tt>bugpoint</tt>). The first argument is the
Duncan Sands7e7ae5a2010-02-18 14:08:13 +0000[diff] [blame]1072name of the pass, which is to be used for the <tt>-help</tt> output of
Chris Lattnerc8603c22006-08-27 23:18:52 +0000[diff] [blame]1073programs, as
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1074well as for debug output generated by the <tt>--debug-pass</tt> option.</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1075
Chris Lattnerc8603c22006-08-27 23:18:52 +0000[diff] [blame]1076<p>If you want your pass to be easily dumpable, you should
1077implement the virtual <tt>print</tt> method:</p>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1078
1079</div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1080
1081<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1082<h4>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1083 <a name="print">The <tt>print</tt> method</a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1084</h4>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1085
1086<div class="doc_text">
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1087
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]1088<div class="doc_code"><pre>
Torok Edwin52790e52008-10-28 17:29:23 +0000[diff] [blame]1089 <b>virtual void</b> print(std::ostream &amp;O, <b>const</b> Module *M) <b>const</b>;
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]1090</pre></div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1091
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1092<p>The <tt>print</tt> method must be implemented by "analyses" in order to print
1093a human readable version of the analysis results. This is useful for debugging
1094an analysis itself, as well as for other people to figure out how an analysis
Chris Lattnerc8603c22006-08-27 23:18:52 +0000[diff] [blame]1095works. Use the <tt>opt -analyze</tt> argument to invoke this method.</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1096
Bill Wendling832171c2006-12-07 20:04:42 +0000[diff] [blame]1097<p>The <tt>llvm::OStream</tt> parameter specifies the stream to write the results on,
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1098and the <tt>Module</tt> parameter gives a pointer to the top level module of the
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1099program that has been analyzed. Note however that this pointer may be null in
1100certain circumstances (such as calling the <tt>Pass::dump()</tt> from a
1101debugger), so it should only be used to enhance debug output, it should not be
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1102depended on.</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1103
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1104</div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1105
1106<!-- *********************************************************************** -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1107<h2>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1108 <a name="interaction">Specifying interactions between passes</a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1109</h2>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1110<!-- *********************************************************************** -->
1111
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1112<div class="doc_text">
1113
John Criswell8528e782007-12-03 19:34:25 +0000[diff] [blame]1114<p>One of the main responsibilities of the <tt>PassManager</tt> is to make sure
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1115that passes interact with each other correctly. Because <tt>PassManager</tt>
1116tries to <a href="#passmanager">optimize the execution of passes</a> it must
1117know how the passes interact with each other and what dependencies exist between
1118the various passes. To track this, each pass can declare the set of passes that
1119are required to be executed before the current pass, and the passes which are
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1120invalidated by the current pass.</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1121
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1122<p>Typically this functionality is used to require that analysis results are
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1123computed before your pass is run. Running arbitrary transformation passes can
1124invalidate the computed analysis results, which is what the invalidation set
1125specifies. If a pass does not implement the <tt><a
1126href="#getAnalysisUsage">getAnalysisUsage</a></tt> method, it defaults to not
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1127having any prerequisite passes, and invalidating <b>all</b> other passes.</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1128
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1129</div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1130
1131<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1132<h4>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1133 <a name="getAnalysisUsage">The <tt>getAnalysisUsage</tt> method</a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1134</h4>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1135
1136<div class="doc_text">
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1137
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]1138<div class="doc_code"><pre>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1139 <b>virtual void</b> getAnalysisUsage(AnalysisUsage &amp;Info) <b>const</b>;
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]1140</pre></div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1141
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1142<p>By implementing the <tt>getAnalysisUsage</tt> method, the required and
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1143invalidated sets may be specified for your transformation. The implementation
1144should fill in the <tt><a
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]1145href="http://llvm.org/doxygen/classllvm_1_1AnalysisUsage.html">AnalysisUsage</a></tt>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1146object with information about which passes are required and not invalidated. To
Chris Lattner89256272004-03-17 21:09:55 +0000[diff] [blame]1147do this, a pass may call any of the following methods on the AnalysisUsage
1148object:</p>
1149</div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1150
Chris Lattner89256272004-03-17 21:09:55 +0000[diff] [blame]1151<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1152<h4>
1153 <a name="AU::addRequired">
1154 The <tt>AnalysisUsage::addRequired&lt;&gt;</tt>
1155 and <tt>AnalysisUsage::addRequiredTransitive&lt;&gt;</tt> methods
1156 </a>
1157</h4>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1158
Chris Lattner89256272004-03-17 21:09:55 +0000[diff] [blame]1159<div class="doc_text">
1160<p>
Reid Spencer1bc19342004-12-11 05:12:57 +0000[diff] [blame]1161If your pass requires a previous pass to be executed (an analysis for example),
Chris Lattner89256272004-03-17 21:09:55 +0000[diff] [blame]1162it can use one of these methods to arrange for it to be run before your pass.
1163LLVM has many different types of analyses and passes that can be required,
Reid Spencer1bc19342004-12-11 05:12:57 +0000[diff] [blame]1164spanning the range from <tt>DominatorSet</tt> to <tt>BreakCriticalEdges</tt>.
1165Requiring <tt>BreakCriticalEdges</tt>, for example, guarantees that there will
Chris Lattner89256272004-03-17 21:09:55 +0000[diff] [blame]1166be no critical edges in the CFG when your pass has been run.
1167</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1168
Chris Lattner89256272004-03-17 21:09:55 +0000[diff] [blame]1169<p>
1170Some analyses chain to other analyses to do their job. For example, an <a
1171href="AliasAnalysis.html">AliasAnalysis</a> implementation is required to <a
1172href="AliasAnalysis.html#chaining">chain</a> to other alias analysis passes. In
1173cases where analyses chain, the <tt>addRequiredTransitive</tt> method should be
1174used instead of the <tt>addRequired</tt> method. This informs the PassManager
1175that the transitively required pass should be alive as long as the requiring
1176pass is.
1177</p>
1178</div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1179
Chris Lattner89256272004-03-17 21:09:55 +0000[diff] [blame]1180<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1181<h4>
1182 <a name="AU::addPreserved">
1183 The <tt>AnalysisUsage::addPreserved&lt;&gt;</tt> method
1184 </a>
1185</h4>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1186
Chris Lattner89256272004-03-17 21:09:55 +0000[diff] [blame]1187<div class="doc_text">
1188<p>
1189One of the jobs of the PassManager is to optimize how and when analyses are run.
1190In particular, it attempts to avoid recomputing data unless it needs to. For
1191this reason, passes are allowed to declare that they preserve (i.e., they don't
1192invalidate) an existing analysis if it's available. For example, a simple
Reid Spencer1bc19342004-12-11 05:12:57 +0000[diff] [blame]1193constant folding pass would not modify the CFG, so it can't possibly affect the
Chris Lattner89256272004-03-17 21:09:55 +0000[diff] [blame]1194results of dominator analysis. By default, all passes are assumed to invalidate
1195all others.
1196</p>
1197
1198<p>
1199The <tt>AnalysisUsage</tt> class provides several methods which are useful in
1200certain circumstances that are related to <tt>addPreserved</tt>. In particular,
1201the <tt>setPreservesAll</tt> method can be called to indicate that the pass does
1202not modify the LLVM program at all (which is true for analyses), and the
1203<tt>setPreservesCFG</tt> method can be used by transformations that change
1204instructions in the program but do not modify the CFG or terminator instructions
1205(note that this property is implicitly set for <a
1206href="#BasicBlockPass">BasicBlockPass</a>'s).
1207</p>
1208
1209<p>
1210<tt>addPreserved</tt> is particularly useful for transformations like
1211<tt>BreakCriticalEdges</tt>. This pass knows how to update a small set of loop
1212and dominator related analyses if they exist, so it can preserve them, despite
1213the fact that it hacks on the CFG.
1214</p>
1215</div>
1216
1217<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1218<h4>
1219 <a name="AU::examples">
1220 Example implementations of <tt>getAnalysisUsage</tt>
1221 </a>
1222</h4>
Chris Lattner89256272004-03-17 21:09:55 +0000[diff] [blame]1223
1224<div class="doc_text">
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1225
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]1226<div class="doc_code"><pre>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1227 <i>// This example modifies the program, but does not modify the CFG</i>
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]1228 <b>void</b> <a href="http://llvm.org/doxygen/structLICM.html">LICM</a>::getAnalysisUsage(AnalysisUsage &amp;AU) <b>const</b> {
Chris Lattner8291e042002-10-21 19:57:59 +0000[diff] [blame]1229 AU.setPreservesCFG();
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]1230 AU.addRequired&lt;<a href="http://llvm.org/doxygen/classllvm_1_1LoopInfo.html">LoopInfo</a>&gt;();
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1231 }
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]1232</pre></div>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1233
1234</div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1235
1236<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1237<h4>
1238 <a name="getAnalysis">
1239 The <tt>getAnalysis&lt;&gt;</tt> and
1240 <tt>getAnalysisIfAvailable&lt;&gt;</tt> methods
1241 </a>
1242</h4>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1243
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1244<div class="doc_text">
1245
Chris Lattner89256272004-03-17 21:09:55 +0000[diff] [blame]1246<p>The <tt>Pass::getAnalysis&lt;&gt;</tt> method is automatically inherited by
1247your class, providing you with access to the passes that you declared that you
1248required with the <a href="#getAnalysisUsage"><tt>getAnalysisUsage</tt></a>
1249method. It takes a single template argument that specifies which pass class you
1250want, and returns a reference to that pass. For example:</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1251
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]1252<div class="doc_code"><pre>
Chris Lattnera5776302004-03-17 21:33:32 +0000[diff] [blame]1253 bool LICM::runOnFunction(Function &amp;F) {
Chris Lattner89256272004-03-17 21:09:55 +0000[diff] [blame]1254 LoopInfo &amp;LI = getAnalysis&lt;LoopInfo&gt;();
1255 ...
1256 }
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]1257</pre></div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1258
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1259<p>This method call returns a reference to the pass desired. You may get a
1260runtime assertion failure if you attempt to get an analysis that you did not
1261declare as required in your <a
1262href="#getAnalysisUsage"><tt>getAnalysisUsage</tt></a> implementation. This
1263method can be called by your <tt>run*</tt> method implementation, or by any
Devang Patel3c1ca0b2007-04-16 21:28:14 +0000[diff] [blame]1264other local method invoked by your <tt>run*</tt> method.
1265
1266A module level pass can use function level analysis info using this interface.
1267For example:</p>
1268
1269<div class="doc_code"><pre>
1270 bool ModuleLevelPass::runOnModule(Module &amp;M) {
1271 ...
Devang Patelf23de112007-04-17 00:17:11 +0000[diff] [blame]1272 DominatorTree &amp;DT = getAnalysis&lt;DominatorTree&gt;(Func);
Devang Patel3c1ca0b2007-04-16 21:28:14 +0000[diff] [blame]1273 ...
1274 }
1275</pre></div>
1276
Chris Lattnerb5c87f62007-05-18 05:36:14 +0000[diff] [blame]1277<p>In above example, runOnFunction for DominatorTree is called by pass manager
Devang Patel3c1ca0b2007-04-16 21:28:14 +0000[diff] [blame]1278before returning a reference to the desired pass.</p>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1279
Chris Lattner89256272004-03-17 21:09:55 +0000[diff] [blame]1280<p>
1281If your pass is capable of updating analyses if they exist (e.g.,
1282<tt>BreakCriticalEdges</tt>, as described above), you can use the
Duncan Sands1465d612009-01-28 13:14:17 +0000[diff] [blame]1283<tt>getAnalysisIfAvailable</tt> method, which returns a pointer to the analysis
1284if it is active. For example:</p>
Chris Lattner89256272004-03-17 21:09:55 +0000[diff] [blame]1285
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]1286<div class="doc_code"><pre>
Chris Lattner89256272004-03-17 21:09:55 +0000[diff] [blame]1287 ...
Duncan Sands1465d612009-01-28 13:14:17 +0000[diff] [blame]1288 if (DominatorSet *DS = getAnalysisIfAvailable&lt;DominatorSet&gt;()) {
Chris Lattner89256272004-03-17 21:09:55 +0000[diff] [blame]1289 <i>// A DominatorSet is active. This code will update it.</i>
1290 }
1291 ...
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]1292</pre></div>
Chris Lattner89256272004-03-17 21:09:55 +0000[diff] [blame]1293
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1294</div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1295
Chris Lattner79910702002-08-22 19:21:04 +0000[diff] [blame]1296<!-- *********************************************************************** -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1297<h2>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1298 <a name="analysisgroup">Implementing Analysis Groups</a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1299</h2>
Chris Lattner79910702002-08-22 19:21:04 +0000[diff] [blame]1300<!-- *********************************************************************** -->
1301
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1302<div class="doc_text">
1303
Chris Lattnerb7632282007-11-16 05:32:05 +0000[diff] [blame]1304<p>Now that we understand the basics of how passes are defined, how they are
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1305used, and how they are required from other passes, it's time to get a little bit
Chris Lattner79910702002-08-22 19:21:04 +0000[diff] [blame]1306fancier. All of the pass relationships that we have seen so far are very
1307simple: one pass depends on one other specific pass to be run before it can run.
1308For many applications, this is great, for others, more flexibility is
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1309required.</p>
Chris Lattner79910702002-08-22 19:21:04 +0000[diff] [blame]1310
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1311<p>In particular, some analyses are defined such that there is a single simple
Chris Lattner79910702002-08-22 19:21:04 +0000[diff] [blame]1312interface to the analysis results, but multiple ways of calculating them.
1313Consider alias analysis for example. The most trivial alias analysis returns
1314"may alias" for any alias query. The most sophisticated analysis a
1315flow-sensitive, context-sensitive interprocedural analysis that can take a
1316significant amount of time to execute (and obviously, there is a lot of room
1317between these two extremes for other implementations). To cleanly support
1318situations like this, the LLVM Pass Infrastructure supports the notion of
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1319Analysis Groups.</p>
1320
1321</div>
Chris Lattner79910702002-08-22 19:21:04 +0000[diff] [blame]1322
1323<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1324<h4>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1325 <a name="agconcepts">Analysis Group Concepts</a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1326</h4>
Chris Lattner79910702002-08-22 19:21:04 +0000[diff] [blame]1327
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1328<div class="doc_text">
1329
1330<p>An Analysis Group is a single simple interface that may be implemented by
Chris Lattner79910702002-08-22 19:21:04 +0000[diff] [blame]1331multiple different passes. Analysis Groups can be given human readable names
1332just like passes, but unlike passes, they need not derive from the <tt>Pass</tt>
1333class. An analysis group may have one or more implementations, one of which is
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1334the "default" implementation.</p>
Chris Lattner79910702002-08-22 19:21:04 +0000[diff] [blame]1335
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1336<p>Analysis groups are used by client passes just like other passes are: the
Chris Lattner79910702002-08-22 19:21:04 +0000[diff] [blame]1337<tt>AnalysisUsage::addRequired()</tt> and <tt>Pass::getAnalysis()</tt> methods.
1338In order to resolve this requirement, the <a href="#passmanager">PassManager</a>
1339scans the available passes to see if any implementations of the analysis group
1340are available. If none is available, the default implementation is created for
1341the pass to use. All standard rules for <A href="#interaction">interaction
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1342between passes</a> still apply.</p>
Chris Lattner79910702002-08-22 19:21:04 +0000[diff] [blame]1343
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1344<p>Although <a href="#registration">Pass Registration</a> is optional for normal
Chris Lattner79910702002-08-22 19:21:04 +0000[diff] [blame]1345passes, all analysis group implementations must be registered, and must use the
Owen Andersond8cc7be2010-07-21 23:07:00 +0000[diff] [blame]1346<A href="#registerag"><tt>INITIALIZE_AG_PASS</tt></a> template to join the
Chris Lattner79910702002-08-22 19:21:04 +0000[diff] [blame]1347implementation pool. Also, a default implementation of the interface
1348<b>must</b> be registered with <A
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1349href="#registerag"><tt>RegisterAnalysisGroup</tt></a>.</p>
Chris Lattner79910702002-08-22 19:21:04 +0000[diff] [blame]1350
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1351<p>As a concrete example of an Analysis Group in action, consider the <a
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]1352href="http://llvm.org/doxygen/classllvm_1_1AliasAnalysis.html">AliasAnalysis</a>
Chris Lattner79910702002-08-22 19:21:04 +0000[diff] [blame]1353analysis group. The default implementation of the alias analysis interface (the
1354<tt><a
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]1355href="http://llvm.org/doxygen/structBasicAliasAnalysis.html">basicaa</a></tt>
Chris Lattner79910702002-08-22 19:21:04 +0000[diff] [blame]1356pass) just does a few simple checks that don't require significant analysis to
1357compute (such as: two different globals can never alias each other, etc).
1358Passes that use the <tt><a
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]1359href="http://llvm.org/doxygen/classllvm_1_1AliasAnalysis.html">AliasAnalysis</a></tt>
Chris Lattner79910702002-08-22 19:21:04 +0000[diff] [blame]1360interface (for example the <tt><a
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]1361href="http://llvm.org/doxygen/structGCSE.html">gcse</a></tt> pass), do
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1362not care which implementation of alias analysis is actually provided, they just
1363use the designated interface.</p>
Chris Lattner79910702002-08-22 19:21:04 +0000[diff] [blame]1364
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1365<p>From the user's perspective, commands work just like normal. Issuing the
Chris Lattner79910702002-08-22 19:21:04 +0000[diff] [blame]1366command '<tt>opt -gcse ...</tt>' will cause the <tt>basicaa</tt> class to be
1367instantiated and added to the pass sequence. Issuing the command '<tt>opt
1368-somefancyaa -gcse ...</tt>' will cause the <tt>gcse</tt> pass to use the
1369<tt>somefancyaa</tt> alias analysis (which doesn't actually exist, it's just a
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1370hypothetical example) instead.</p>
Chris Lattner79910702002-08-22 19:21:04 +0000[diff] [blame]1371
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1372</div>
Chris Lattner79910702002-08-22 19:21:04 +0000[diff] [blame]1373
1374<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1375<h4>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1376 <a name="registerag">Using <tt>RegisterAnalysisGroup</tt></a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1377</h4>
Chris Lattner79910702002-08-22 19:21:04 +0000[diff] [blame]1378
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1379<div class="doc_text">
1380
1381<p>The <tt>RegisterAnalysisGroup</tt> template is used to register the analysis
Owen Andersond8cc7be2010-07-21 23:07:00 +0000[diff] [blame]1382group itself, while the <tt>INITIALIZE_AG_PASS</tt> is used to add pass
1383implementations to the analysis group. First,
1384an analysis group should be registered, with a human readable name
1385provided for it.
Chris Lattner79910702002-08-22 19:21:04 +0000[diff] [blame]1386Unlike registration of passes, there is no command line argument to be specified
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1387for the Analysis Group Interface itself, because it is "abstract":</p>
Chris Lattner79910702002-08-22 19:21:04 +0000[diff] [blame]1388
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]1389<div class="doc_code"><pre>
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]1390 <b>static</b> RegisterAnalysisGroup&lt;<a href="http://llvm.org/doxygen/classllvm_1_1AliasAnalysis.html">AliasAnalysis</a>&gt; A("<i>Alias Analysis</i>");
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]1391</pre></div>
Chris Lattner79910702002-08-22 19:21:04 +0000[diff] [blame]1392
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1393<p>Once the analysis is registered, passes can declare that they are valid
1394implementations of the interface by using the following code:</p>
Chris Lattner79910702002-08-22 19:21:04 +0000[diff] [blame]1395
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]1396<div class="doc_code"><pre>
Chris Lattner79910702002-08-22 19:21:04 +0000[diff] [blame]1397<b>namespace</b> {
Chris Lattner79910702002-08-22 19:21:04 +0000[diff] [blame]1398 //<i> Declare that we implement the AliasAnalysis interface</i>
Owen Andersond8cc7be2010-07-21 23:07:00 +0000[diff] [blame]1399 INITIALIZE_AG_PASS(FancyAA, <a href="http://llvm.org/doxygen/classllvm_1_1AliasAnalysis.html">AliasAnalysis</a>, "<i>somefancyaa</i>",
1400 "<i>A more complex alias analysis implementation</i>",
1401 false, // <i>Is CFG Only?</i>
1402 true, // <i>Is Analysis?</i>
1403 false, // <i>Is default Analysis Group implementation?</i>
1404 );
Chris Lattner79910702002-08-22 19:21:04 +0000[diff] [blame]1405}
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]1406</pre></div>
Chris Lattner79910702002-08-22 19:21:04 +0000[diff] [blame]1407
Owen Andersond8cc7be2010-07-21 23:07:00 +0000[diff] [blame]1408<p>This just shows a class <tt>FancyAA</tt> that
1409uses the <tt>INITIALIZE_AG_PASS</tt> macro both to register and
1410to "join" the <tt><a href="http://llvm.org/doxygen/classllvm_1_1AliasAnalysis.html">AliasAnalysis</a></tt>
Chris Lattner79910702002-08-22 19:21:04 +0000[diff] [blame]1411analysis group. Every implementation of an analysis group should join using
Owen Andersond8cc7be2010-07-21 23:07:00 +0000[diff] [blame]1412this macro.</p>
Chris Lattner79910702002-08-22 19:21:04 +0000[diff] [blame]1413
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]1414<div class="doc_code"><pre>
Chris Lattner79910702002-08-22 19:21:04 +0000[diff] [blame]1415<b>namespace</b> {
Chris Lattner79910702002-08-22 19:21:04 +0000[diff] [blame]1416 //<i> Declare that we implement the AliasAnalysis interface</i>
Owen Andersond8cc7be2010-07-21 23:07:00 +0000[diff] [blame]1417 INITIALIZE_AG_PASS(BasicAA, <a href="http://llvm.org/doxygen/classllvm_1_1AliasAnalysis.html">AliasAnalysis</a>, "<i>basicaa</i>",
1418 "<i>Basic Alias Analysis (default AA impl)</i>",
1419 false, // <i>Is CFG Only?</i>
1420 true, // <i>Is Analysis?</i>
1421 true, // <i>Is default Analysis Group implementation?</i>
1422 );
Chris Lattner79910702002-08-22 19:21:04 +0000[diff] [blame]1423}
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]1424</pre></div>
Chris Lattner79910702002-08-22 19:21:04 +0000[diff] [blame]1425
Owen Andersond8cc7be2010-07-21 23:07:00 +0000[diff] [blame]1426<p>Here we show how the default implementation is specified (using the final
1427argument to the <tt>INITIALIZE_AG_PASS</tt> template). There must be exactly
Chris Lattner79910702002-08-22 19:21:04 +0000[diff] [blame]1428one default implementation available at all times for an Analysis Group to be
Devang Patel2397f8d2007-06-20 18:51:14 +0000[diff] [blame]1429used. Only default implementation can derive from <tt>ImmutablePass</tt>.
1430Here we declare that the
1431 <tt><a href="http://llvm.org/doxygen/structBasicAliasAnalysis.html">BasicAliasAnalysis</a></tt>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1432pass is the default implementation for the interface.</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1433
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1434</div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1435
1436<!-- *********************************************************************** -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1437<h2>
Tanya Lattnerd5383652004-11-19 01:25:14 +0000[diff] [blame]1438 <a name="passStatistics">Pass Statistics</a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1439</h2>
Tanya Lattnerd5383652004-11-19 01:25:14 +0000[diff] [blame]1440<!-- *********************************************************************** -->
1441
1442<div class="doc_text">
Tanya Lattner05f8d5f2004-11-19 01:26:37 +0000[diff] [blame]1443<p>The <a
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]1444href="http://llvm.org/doxygen/Statistic_8h-source.html"><tt>Statistic</tt></a>
John Criswell0b1010e2005-11-28 23:25:41 +0000[diff] [blame]1445class is designed to be an easy way to expose various success
Tanya Lattnerd5383652004-11-19 01:25:14 +0000[diff] [blame]1446metrics from passes. These statistics are printed at the end of a
1447run, when the -stats command line option is enabled on the command
Tanya Lattner05f8d5f2004-11-19 01:26:37 +0000[diff] [blame]1448line. See the <a href="http://llvm.org/docs/ProgrammersManual.html#Statistic">Statistics section</a> in the Programmer's Manual for details.
Tanya Lattnerd5383652004-11-19 01:25:14 +0000[diff] [blame]1449
1450</div>
1451
1452
1453<!-- *********************************************************************** -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1454<h2>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1455 <a name="passmanager">What PassManager does</a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1456</h2>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1457<!-- *********************************************************************** -->
1458
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1459<div class="doc_text">
1460
1461<p>The <a
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]1462href="http://llvm.org/doxygen/PassManager_8h-source.html"><tt>PassManager</tt></a>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1463<a
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]1464href="http://llvm.org/doxygen/classllvm_1_1PassManager.html">class</a>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1465takes a list of passes, ensures their <a href="#interaction">prerequisites</a>
1466are set up correctly, and then schedules passes to run efficiently. All of the
1467LLVM tools that run passes use the <tt>PassManager</tt> for execution of these
1468passes.</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1469
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1470<p>The <tt>PassManager</tt> does two main things to try to reduce the execution
1471time of a series of passes:</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1472
1473<ol>
1474<li><b>Share analysis results</b> - The PassManager attempts to avoid
1475recomputing analysis results as much as possible. This means keeping track of
1476which analyses are available already, which analyses get invalidated, and which
1477analyses are needed to be run for a pass. An important part of work is that the
1478<tt>PassManager</tt> tracks the exact lifetime of all analysis results, allowing
1479it to <a href="#releaseMemory">free memory</a> allocated to holding analysis
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1480results as soon as they are no longer needed.</li>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1481
1482<li><b>Pipeline the execution of passes on the program</b> - The
1483<tt>PassManager</tt> attempts to get better cache and memory usage behavior out
1484of a series of passes by pipelining the passes together. This means that, given
Duncan Sandsab4c3662011-02-15 09:23:02 +0000[diff] [blame]1485a series of consecutive <a href="#FunctionPass"><tt>FunctionPass</tt></a>'s, it
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1486will execute all of the <a href="#FunctionPass"><tt>FunctionPass</tt></a>'s on
1487the first function, then all of the <a
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1488href="#FunctionPass"><tt>FunctionPass</tt></a>es on the second function,
1489etc... until the entire program has been run through the passes.
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1490
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1491<p>This improves the cache behavior of the compiler, because it is only touching
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1492the LLVM program representation for a single function at a time, instead of
1493traversing the entire program. It reduces the memory consumption of compiler,
1494because, for example, only one <a
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]1495href="http://llvm.org/doxygen/classllvm_1_1DominatorSet.html"><tt>DominatorSet</tt></a>
John Criswell9795bb82007-12-10 20:26:29 +0000[diff] [blame]1496needs to be calculated at a time. This also makes it possible to implement
1497some <a
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1498href="#SMP">interesting enhancements</a> in the future.</p></li>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1499
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1500</ol>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1501
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1502<p>The effectiveness of the <tt>PassManager</tt> is influenced directly by how
1503much information it has about the behaviors of the passes it is scheduling. For
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1504example, the "preserved" set is intentionally conservative in the face of an
1505unimplemented <a href="#getAnalysisUsage"><tt>getAnalysisUsage</tt></a> method.
1506Not implementing when it should be implemented will have the effect of not
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1507allowing any analysis results to live across the execution of your pass.</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1508
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1509<p>The <tt>PassManager</tt> class exposes a <tt>--debug-pass</tt> command line
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1510options that is useful for debugging pass execution, seeing how things work, and
1511diagnosing when you should be preserving more analyses than you currently are
1512(To get information about all of the variants of the <tt>--debug-pass</tt>
Duncan Sands7e7ae5a2010-02-18 14:08:13 +0000[diff] [blame]1513option, just type '<tt>opt -help-hidden</tt>').</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1514
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1515<p>By using the <tt>--debug-pass=Structure</tt> option, for example, we can see
1516how our <a href="#basiccode">Hello World</a> pass interacts with other passes.
1517Lets try it out with the <tt>gcse</tt> and <tt>licm</tt> passes:</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1518
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]1519<div class="doc_code"><pre>
Duncan Sands67f8a7b2010-07-08 08:27:18 +0000[diff] [blame]1520$ opt -load ../../../Debug+Asserts/lib/Hello.so -gcse -licm --debug-pass=Structure &lt; hello.bc &gt; /dev/null
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1521Module Pass Manager
1522 Function Pass Manager
1523 Dominator Set Construction
1524 Immediate Dominators Construction
1525 Global Common Subexpression Elimination
1526-- Immediate Dominators Construction
1527-- Global Common Subexpression Elimination
1528 Natural Loop Construction
1529 Loop Invariant Code Motion
1530-- Natural Loop Construction
1531-- Loop Invariant Code Motion
1532 Module Verifier
1533-- Dominator Set Construction
1534-- Module Verifier
Gabor Greif04367bf2007-07-06 22:07:22 +0000[diff] [blame]1535 Bitcode Writer
1536--Bitcode Writer
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]1537</pre></div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1538
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1539<p>This output shows us when passes are constructed and when the analysis
1540results are known to be dead (prefixed with '<tt>--</tt>'). Here we see that
1541GCSE uses dominator and immediate dominator information to do its job. The LICM
1542pass uses natural loop information, which uses dominator sets, but not immediate
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1543dominators. Because immediate dominators are no longer useful after the GCSE
1544pass, it is immediately destroyed. The dominator sets are then reused to
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1545compute natural loop information, which is then used by the LICM pass.</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1546
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1547<p>After the LICM pass, the module verifier runs (which is automatically added
1548by the '<tt>opt</tt>' tool), which uses the dominator set to check that the
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1549resultant LLVM code is well formed. After it finishes, the dominator set
1550information is destroyed, after being computed once, and shared by three
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1551passes.</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1552
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1553<p>Lets see how this changes when we run the <a href="#basiccode">Hello
1554World</a> pass in between the two passes:</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1555
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]1556<div class="doc_code"><pre>
Duncan Sands67f8a7b2010-07-08 08:27:18 +0000[diff] [blame]1557$ opt -load ../../../Debug+Asserts/lib/Hello.so -gcse -hello -licm --debug-pass=Structure &lt; hello.bc &gt; /dev/null
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1558Module Pass Manager
1559 Function Pass Manager
1560 Dominator Set Construction
1561 Immediate Dominators Construction
1562 Global Common Subexpression Elimination
1563<b>-- Dominator Set Construction</b>
1564-- Immediate Dominators Construction
1565-- Global Common Subexpression Elimination
1566<b> Hello World Pass
1567-- Hello World Pass
1568 Dominator Set Construction</b>
1569 Natural Loop Construction
1570 Loop Invariant Code Motion
1571-- Natural Loop Construction
1572-- Loop Invariant Code Motion
1573 Module Verifier
1574-- Dominator Set Construction
1575-- Module Verifier
Gabor Greif04367bf2007-07-06 22:07:22 +0000[diff] [blame]1576 Bitcode Writer
1577--Bitcode Writer
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1578Hello: __main
1579Hello: puts
1580Hello: main
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]1581</pre></div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1582
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1583<p>Here we see that the <a href="#basiccode">Hello World</a> pass has killed the
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1584Dominator Set pass, even though it doesn't modify the code at all! To fix this,
1585we need to add the following <a
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1586href="#getAnalysisUsage"><tt>getAnalysisUsage</tt></a> method to our pass:</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1587
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]1588<div class="doc_code"><pre>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1589 <i>// We don't modify the program, so we preserve all analyses</i>
1590 <b>virtual void</b> getAnalysisUsage(AnalysisUsage &amp;AU) <b>const</b> {
1591 AU.setPreservesAll();
1592 }
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]1593</pre></div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1594
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1595<p>Now when we run our pass, we get this output:</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1596
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]1597<div class="doc_code"><pre>
Duncan Sands67f8a7b2010-07-08 08:27:18 +0000[diff] [blame]1598$ opt -load ../../../Debug+Asserts/lib/Hello.so -gcse -hello -licm --debug-pass=Structure &lt; hello.bc &gt; /dev/null
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1599Pass Arguments: -gcse -hello -licm
1600Module Pass Manager
1601 Function Pass Manager
1602 Dominator Set Construction
1603 Immediate Dominators Construction
1604 Global Common Subexpression Elimination
1605-- Immediate Dominators Construction
1606-- Global Common Subexpression Elimination
1607 Hello World Pass
1608-- Hello World Pass
1609 Natural Loop Construction
1610 Loop Invariant Code Motion
1611-- Loop Invariant Code Motion
1612-- Natural Loop Construction
1613 Module Verifier
1614-- Dominator Set Construction
1615-- Module Verifier
Gabor Greif04367bf2007-07-06 22:07:22 +0000[diff] [blame]1616 Bitcode Writer
1617--Bitcode Writer
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1618Hello: __main
1619Hello: puts
1620Hello: main
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]1621</pre></div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1622
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1623<p>Which shows that we don't accidentally invalidate dominator information
1624anymore, and therefore do not have to compute it twice.</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1625
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1626</div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1627
1628<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1629<h4>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1630 <a name="releaseMemory">The <tt>releaseMemory</tt> method</a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1631</h4>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1632
1633<div class="doc_text">
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1634
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]1635<div class="doc_code"><pre>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1636 <b>virtual void</b> releaseMemory();
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]1637</pre></div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1638
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1639<p>The <tt>PassManager</tt> automatically determines when to compute analysis
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1640results, and how long to keep them around for. Because the lifetime of the pass
1641object itself is effectively the entire duration of the compilation process, we
1642need some way to free analysis results when they are no longer useful. The
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1643<tt>releaseMemory</tt> virtual method is the way to do this.</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1644
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1645<p>If you are writing an analysis or any other pass that retains a significant
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1646amount of state (for use by another pass which "requires" your pass and uses the
1647<a href="#getAnalysis">getAnalysis</a> method) you should implement
Dan Gohmand87c9e32009-06-15 18:22:49 +0000[diff] [blame]1648<tt>releaseMemory</tt> to, well, release the memory allocated to maintain this
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1649internal state. This method is called after the <tt>run*</tt> method for the
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1650class, before the next call of <tt>run*</tt> in your pass.</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1651
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1652</div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1653
1654<!-- *********************************************************************** -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1655<h2>
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]1656 <a name="registering">Registering dynamically loaded passes</a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1657</h2>
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]1658<!-- *********************************************************************** -->
1659
1660<div class="doc_text">
1661
1662<p><i>Size matters</i> when constructing production quality tools using llvm,
1663both for the purposes of distribution, and for regulating the resident code size
1664when running on the target system. Therefore, it becomes desirable to
1665selectively use some passes, while omitting others and maintain the flexibility
1666to change configurations later on. You want to be able to do all this, and,
1667provide feedback to the user. This is where pass registration comes into
1668play.</p>
1669
1670<p>The fundamental mechanisms for pass registration are the
1671<tt>MachinePassRegistry</tt> class and subclasses of
1672<tt>MachinePassRegistryNode</tt>.</p>
1673
1674<p>An instance of <tt>MachinePassRegistry</tt> is used to maintain a list of
1675<tt>MachinePassRegistryNode</tt> objects. This instance maintains the list and
1676communicates additions and deletions to the command line interface.</p>
1677
1678<p>An instance of <tt>MachinePassRegistryNode</tt> subclass is used to maintain
1679information provided about a particular pass. This information includes the
1680command line name, the command help string and the address of the function used
1681to create an instance of the pass. A global static constructor of one of these
1682instances <i>registers</i> with a corresponding <tt>MachinePassRegistry</tt>,
1683the static destructor <i>unregisters</i>. Thus a pass that is statically linked
1684in the tool will be registered at start up. A dynamically loaded pass will
1685register on load and unregister at unload.</p>
1686
1687</div>
1688
1689<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1690<h3>
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]1691 <a name="registering_existing">Using existing registries</a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1692</h3>
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]1693
1694<div class="doc_text">
1695
1696<p>There are predefined registries to track instruction scheduling
1697(<tt>RegisterScheduler</tt>) and register allocation (<tt>RegisterRegAlloc</tt>)
1698machine passes. Here we will describe how to <i>register</i> a register
1699allocator machine pass.</p>
1700
1701<p>Implement your register allocator machine pass. In your register allocator
1702.cpp file add the following include;</p>
1703
1704<div class="doc_code"><pre>
Chris Lattner8f652eb2006-08-11 16:37:02 +0000[diff] [blame]1705 #include "llvm/CodeGen/RegAllocRegistry.h"
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]1706</pre></div>
1707
1708<p>Also in your register allocator .cpp file, define a creator function in the
1709form; </p>
1710
1711<div class="doc_code"><pre>
1712 FunctionPass *createMyRegisterAllocator() {
1713 return new MyRegisterAllocator();
1714 }
1715</pre></div>
1716
1717<p>Note that the signature of this function should match the type of
1718<tt>RegisterRegAlloc::FunctionPassCtor</tt>. In the same file add the
1719"installing" declaration, in the form;</p>
1720
1721<div class="doc_code"><pre>
1722 static RegisterRegAlloc myRegAlloc("myregalloc",
1723 " my register allocator help string",
1724 createMyRegisterAllocator);
1725</pre></div>
1726
1727<p>Note the two spaces prior to the help string produces a tidy result on the
Duncan Sands7e7ae5a2010-02-18 14:08:13 +0000[diff] [blame]1728-help query.</p>
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]1729
1730<div class="doc_code"><pre>
Duncan Sands7e7ae5a2010-02-18 14:08:13 +0000[diff] [blame]1731$ llc -help
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]1732 ...
Duncan Sands18619b22010-02-18 14:37:52 +0000[diff] [blame]1733 -regalloc - Register allocator to use (default=linearscan)
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]1734 =linearscan - linear scan register allocator
1735 =local - local register allocator
1736 =simple - simple register allocator
1737 =myregalloc - my register allocator help string
1738 ...
1739</pre></div>
1740
1741<p>And that's it. The user is now free to use <tt>-regalloc=myregalloc</tt> as
1742an option. Registering instruction schedulers is similar except use the
Chris Lattner8f652eb2006-08-11 16:37:02 +0000[diff] [blame]1743<tt>RegisterScheduler</tt> class. Note that the
1744<tt>RegisterScheduler::FunctionPassCtor</tt> is significantly different from
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]1745<tt>RegisterRegAlloc::FunctionPassCtor</tt>.</p>
1746
1747<p>To force the load/linking of your register allocator into the llc/lli tools,
1748add your creator function's global declaration to "Passes.h" and add a "pseudo"
1749call line to <tt>llvm/Codegen/LinkAllCodegenComponents.h</tt>.</p>
1750
1751</div>
1752
1753
1754<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1755<h3>
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]1756 <a name="registering_new">Creating new registries</a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1757</h3>
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]1758
1759<div class="doc_text">
1760
1761<p>The easiest way to get started is to clone one of the existing registries; we
1762recommend <tt>llvm/CodeGen/RegAllocRegistry.h</tt>. The key things to modify
1763are the class name and the <tt>FunctionPassCtor</tt> type.</p>
1764
1765<p>Then you need to declare the registry. Example: if your pass registry is
1766<tt>RegisterMyPasses</tt> then define;</p>
1767
1768<div class="doc_code"><pre>
1769MachinePassRegistry RegisterMyPasses::Registry;
1770</pre></div>
1771
1772<p>And finally, declare the command line option for your passes. Example:</p>
1773
1774<div class="doc_code"><pre>
1775 cl::opt&lt;RegisterMyPasses::FunctionPassCtor, false,
Dan Gohman364a39f2008-10-14 17:00:38 +0000[diff] [blame]1776 RegisterPassParser&lt;RegisterMyPasses&gt; &gt;
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]1777 MyPassOpt("mypass",
1778 cl::init(&amp;createDefaultMyPass),
1779 cl::desc("my pass option help"));
1780</pre></div>
1781
1782<p>Here the command option is "mypass", with createDefaultMyPass as the default
1783creator.</p>
1784
1785</div>
1786
1787<!-- *********************************************************************** -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1788<h2>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1789 <a name="debughints">Using GDB with dynamically loaded passes</a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1790</h2>
Chris Lattner480e2ef2002-09-06 02:02:58 +0000[diff] [blame]1791<!-- *********************************************************************** -->
1792
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1793<div class="doc_text">
1794
1795<p>Unfortunately, using GDB with dynamically loaded passes is not as easy as it
Chris Lattner480e2ef2002-09-06 02:02:58 +0000[diff] [blame]1796should be. First of all, you can't set a breakpoint in a shared object that has
1797not been loaded yet, and second of all there are problems with inlined functions
1798in shared objects. Here are some suggestions to debugging your pass with
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1799GDB.</p>
Chris Lattner480e2ef2002-09-06 02:02:58 +0000[diff] [blame]1800
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1801<p>For sake of discussion, I'm going to assume that you are debugging a
Chris Lattner480e2ef2002-09-06 02:02:58 +0000[diff] [blame]1802transformation invoked by <tt>opt</tt>, although nothing described here depends
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1803on that.</p>
1804
1805</div>
Chris Lattner480e2ef2002-09-06 02:02:58 +0000[diff] [blame]1806
1807<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1808<h4>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1809 <a name="breakpoint">Setting a breakpoint in your pass</a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1810</h4>
Chris Lattner480e2ef2002-09-06 02:02:58 +0000[diff] [blame]1811
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1812<div class="doc_text">
1813
1814<p>First thing you do is start <tt>gdb</tt> on the <tt>opt</tt> process:</p>
Chris Lattner480e2ef2002-09-06 02:02:58 +0000[diff] [blame]1815
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]1816<div class="doc_code"><pre>
Chris Lattner480e2ef2002-09-06 02:02:58 +0000[diff] [blame]1817$ <b>gdb opt</b>
1818GNU gdb 5.0
1819Copyright 2000 Free Software Foundation, Inc.
1820GDB is free software, covered by the GNU General Public License, and you are
1821welcome to change it and/or distribute copies of it under certain conditions.
1822Type "show copying" to see the conditions.
1823There is absolutely no warranty for GDB. Type "show warranty" for details.
1824This GDB was configured as "sparc-sun-solaris2.6"...
1825(gdb)
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]1826</pre></div>
Chris Lattner480e2ef2002-09-06 02:02:58 +0000[diff] [blame]1827
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1828<p>Note that <tt>opt</tt> has a lot of debugging information in it, so it takes
Chris Lattner480e2ef2002-09-06 02:02:58 +0000[diff] [blame]1829time to load. Be patient. Since we cannot set a breakpoint in our pass yet
1830(the shared object isn't loaded until runtime), we must execute the process, and
1831have it stop before it invokes our pass, but after it has loaded the shared
1832object. The most foolproof way of doing this is to set a breakpoint in
1833<tt>PassManager::run</tt> and then run the process with the arguments you
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1834want:</p>
Chris Lattner480e2ef2002-09-06 02:02:58 +0000[diff] [blame]1835
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]1836<div class="doc_code"><pre>
Reid Spencer22a9e5b2006-09-28 16:53:47 +0000[diff] [blame]1837(gdb) <b>break llvm::PassManager::run</b>
Chris Lattner480e2ef2002-09-06 02:02:58 +0000[diff] [blame]1838Breakpoint 1 at 0x2413bc: file Pass.cpp, line 70.
Duncan Sands67f8a7b2010-07-08 08:27:18 +0000[diff] [blame]1839(gdb) <b>run test.bc -load $(LLVMTOP)/llvm/Debug+Asserts/lib/[libname].so -[passoption]</b>
1840Starting program: opt test.bc -load $(LLVMTOP)/llvm/Debug+Asserts/lib/[libname].so -[passoption]
Chris Lattner480e2ef2002-09-06 02:02:58 +0000[diff] [blame]1841Breakpoint 1, PassManager::run (this=0xffbef174, M=@0x70b298) at Pass.cpp:70
184270 bool PassManager::run(Module &amp;M) { return PM-&gt;run(M); }
1843(gdb)
Jim Laskey5fa8fff2006-08-04 18:10:12 +0000[diff] [blame]1844</pre></div>
Chris Lattner480e2ef2002-09-06 02:02:58 +0000[diff] [blame]1845
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1846<p>Once the <tt>opt</tt> stops in the <tt>PassManager::run</tt> method you are
1847now free to set breakpoints in your pass so that you can trace through execution
1848or do other standard debugging stuff.</p>
Chris Lattner480e2ef2002-09-06 02:02:58 +0000[diff] [blame]1849
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1850</div>
Chris Lattner480e2ef2002-09-06 02:02:58 +0000[diff] [blame]1851
1852<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1853<h4>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1854 <a name="debugmisc">Miscellaneous Problems</a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1855</h4>
Chris Lattner480e2ef2002-09-06 02:02:58 +0000[diff] [blame]1856
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1857<div class="doc_text">
1858
1859<p>Once you have the basics down, there are a couple of problems that GDB has,
1860some with solutions, some without.</p>
Chris Lattner480e2ef2002-09-06 02:02:58 +0000[diff] [blame]1861
1862<ul>
1863<li>Inline functions have bogus stack information. In general, GDB does a
1864pretty good job getting stack traces and stepping through inline functions.
1865When a pass is dynamically loaded however, it somehow completely loses this
1866capability. The only solution I know of is to de-inline a function (move it
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1867from the body of a class to a .cpp file).</li>
Chris Lattner480e2ef2002-09-06 02:02:58 +0000[diff] [blame]1868
1869<li>Restarting the program breaks breakpoints. After following the information
1870above, you have succeeded in getting some breakpoints planted in your pass. Nex
1871thing you know, you restart the program (i.e., you type '<tt>run</tt>' again),
1872and you start getting errors about breakpoints being unsettable. The only way I
1873have found to "fix" this problem is to <tt>delete</tt> the breakpoints that are
1874already set in your pass, run the program, and re-set the breakpoints once
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1875execution stops in <tt>PassManager::run</tt>.</li>
Chris Lattner480e2ef2002-09-06 02:02:58 +0000[diff] [blame]1876
1877</ul>
1878
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1879<p>Hopefully these tips will help with common case debugging situations. If
1880you'd like to contribute some tips of your own, just contact <a
1881href="mailto:sabre@nondot.org">Chris</a>.</p>
Chris Lattner480e2ef2002-09-06 02:02:58 +0000[diff] [blame]1882
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1883</div>
Chris Lattner480e2ef2002-09-06 02:02:58 +0000[diff] [blame]1884
1885<!-- *********************************************************************** -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1886<h2>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1887 <a name="future">Future extensions planned</a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1888</h2>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1889<!-- *********************************************************************** -->
1890
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1891<div class="doc_text">
1892
1893<p>Although the LLVM Pass Infrastructure is very capable as it stands, and does
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1894some nifty stuff, there are things we'd like to add in the future. Here is
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1895where we are going:</p>
1896
1897</div>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1898
1899<!-- _______________________________________________________________________ -->
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1900<h4>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1901 <a name="SMP">Multithreaded LLVM</a>
NAKAMURA Takumi05d02652011-04-18 23:59:50 +0000[diff] [blame]1902</h4>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1903
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1904<div class="doc_text">
1905
1906<p>Multiple CPU machines are becoming more common and compilation can never be
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1907fast enough: obviously we should allow for a multithreaded compiler. Because of
1908the semantics defined for passes above (specifically they cannot maintain state
1909across invocations of their <tt>run*</tt> methods), a nice clean way to
1910implement a multithreaded compiler would be for the <tt>PassManager</tt> class
Misha Brukmanbc0e9982003-07-14 17:20:40 +0000[diff] [blame]1911to create multiple instances of each pass object, and allow the separate
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1912instances to be hacking on different parts of the program at the same time.</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1913
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1914<p>This implementation would prevent each of the passes from having to implement
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1915multithreaded constructs, requiring only the LLVM core to have locking in a few
1916places (for global resources). Although this is a simple extension, we simply
1917haven't had time (or multiprocessor machines, thus a reason) to implement this.
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1918Despite that, we have kept the LLVM passes SMP ready, and you should too.</p>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1919
Chris Lattnerb5c87f62007-05-18 05:36:14 +0000[diff] [blame]1920</div>
1921
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1922<!-- *********************************************************************** -->
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1923<hr>
1924<address>
1925 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman44408702008-12-11 17:34:48 +0000[diff] [blame]1926 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1927 <a href="http://validator.w3.org/check/referer"><img
Misha Brukmanf00ddb02008-12-11 18:23:24 +0000[diff] [blame]1928 src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
Chris Lattnerc6bb8242002-08-08 20:11:18 +0000[diff] [blame]1929
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1930 <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
NAKAMURA Takumib9a33632011-04-09 02:13:37 +0000[diff] [blame]1931 <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br>
Misha Brukmanc5402402004-01-15 18:34:11 +0000[diff] [blame]1932 Last modified: $Date$
1933</address>
1934
1935</body>
1936</html>