6502/llvm-6502
1
0
Fork 0
mirror of https://github.com/c64scene-ar/llvm-6502.git synced 2025-01-11 10:31:40 +00:00
Code Issues Projects Releases Wiki Activity

Add documentation for runOnMachineFunction()

Browse Source 
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@7237 91177308-0d34-0410-b5e6-96231b3b80d8
This commit is contained in:
Brian Gaeke 2003-07-22 20:53:20 +00:00
parent f02dbf0f22
commit 6a33f36645
1 changed files with 27 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
docs/WritingAnLLVMPass.html
View File

@ -42,6 +42,10 @@
</ul>
<li><a href="#MachineFunctionPass">The <tt>MachineFunctionPass</tt>
class</a>
<ul>
<li><a href="#runOnMachineFunction">The
<tt>runOnMachineFunction(MachineFunction &amp;)</tt> method</a>
</ul>
</ul>
<li><a href="#registration">Pass Registration</a>
<ul>
@ -597,6 +601,28 @@ the following:
</ol><p>
<!-- _______________________________________________________________________ -->
</ul><h4><a name="runOnMachineFunction"><hr size=0>The
<tt>runOnMachineFunction(MachineFunction &amp;MF)</tt> method</h4><ul>
<pre>
<b>virtual bool</b> runOnMachineFunction(MachineFunction &amp;MF) = 0;
</pre></p>
<tt>runOnMachineFunction</tt> can be considered the main entry point
of a <tt>MachineFunctionPass</tt>; that is, you should override this
method to do the work of your <tt>MachineFunctionPass</tt>. <p>
The <tt>runOnMachineFunction</tt> method is called on every
<tt>MachineFunction</tt> in a <tt>Module</tt>, so that the
<tt>MachineFunctionPass</tt> may perform optimizations on the
machine-dependent representation of the function. If you want to get
at the LLVM <tt>Function</tt> for the <tt>MachineFunction</tt> you're
working on, use <tt>MachineFunction</tt>'s <tt>getFunction()</tt>
accessor method -- but remember, you may not modify the LLVM
<tt>Function</tt> or its contents from a
<tt>MachineFunctionPass</tt>. <p>
<!-- *********************************************************************** -->
</ul><table width="100%" bgcolor="#330077" border=0 cellpadding=4 cellspacing=0>
<tr><td align=center><font color="#EEEEFF" size=+2 face="Georgia,Palatino"><b>
@ -1250,6 +1276,6 @@ href="#Pass"><tt>Pass</tt></a>, only the other way around.<p>
<address><a href="mailto:sabre@nondot.org">Chris Lattner</a></address>
<!-- Created: Tue Aug 6 15:00:33 CDT 2002 -->
<!-- hhmts start -->
Last modified: Mon Jul 14 12:12:53 CDT 2003
Last modified: Tue Jul 22 15:52:30 CDT 2003
<!-- hhmts end -->
</font></body></html>