diff options
-rw-r--r-- | docs/WritingAnLLVMPass.html | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/WritingAnLLVMPass.html b/docs/WritingAnLLVMPass.html index c80fd848c5..414ed1226c 100644 --- a/docs/WritingAnLLVMPass.html +++ b/docs/WritingAnLLVMPass.html @@ -40,6 +40,8 @@ <li><a href="#doFinalization_fn">The <tt>doFinalization(Function &)</tt> method</a> </ul> + <li><a href="#MachineFunctionPass">The <tt>MachineFunctionPass</tt> + class</a> </ul> <li><a href="#registration">Pass Registration</a> <ul> @@ -569,6 +571,31 @@ program being compiled. This can be used to perform per-function finalization.<p> +<!-- ======================================================================= --> +</ul><table width="100%" bgcolor="#441188" border=0 cellpadding=4 cellspacing=0> +<tr><td> </td><td width="100%"> +<font color="#EEEEFF" face="Georgia,Palatino"><b> +<a name="MachineFunctionPass">The <tt>MachineFunctionPass</tt> class +</b></font></td></tr></table><ul> + +A <tt>MachineFunctionPass</tt> executes on the machine-dependent +representation of each LLVM function in the program, +independent of all of the other functions in the program. +A <tt>MachineFunctionPass</tt> is also a <tt>FunctionPass</tt>, so all +the restrictions that apply to a <tt>FunctionPass</tt> also apply to it. +<tt>MachineFunctionPass</tt>es also have additional restrictions. In +particular, <tt>MachineFunctionPass</tt>es are not allowed to do any of +the following: + +<ol> +<li>Modify any LLVM Instructions, BasicBlocks or Functions. +<li>Modify a MachineFunction other than the one currently being processed. +<li>Add or remove MachineFunctions from the current Module. +<li>Add or remove global variables from the current Module. +<li>Maintain state across invocations of + <a href="#runOnMachineFunction"><tt>runOnMachineFunction</tt></a> (including global data) +</ol><p> + <!-- *********************************************************************** --> </ul><table width="100%" bgcolor="#330077" border=0 cellpadding=4 cellspacing=0> |