X-Git-Url: http://plrg.eecs.uci.edu/git/?a=blobdiff_plain;f=docs%2FWritingAnLLVMPass.rst;h=1d5a52f21b3fa6029f532dbad25295a0c0aaacf3;hb=4b8dfba3a128cb20c75fc7709d8c61a6af6e92a6;hp=1114fa0f21173bfc7e2f0a40778703374c7b15a3;hpb=e5a532dae346f5f34d8ae8fa3f8f0ff3c747243e;p=oota-llvm.git diff --git a/docs/WritingAnLLVMPass.rst b/docs/WritingAnLLVMPass.rst index 1114fa0f211..1d5a52f21b3 100644 --- a/docs/WritingAnLLVMPass.rst +++ b/docs/WritingAnLLVMPass.rst @@ -131,7 +131,7 @@ Next, we declare our pass itself: struct Hello : public FunctionPass { -This declares a "``Hello``" class that is a subclass of `FunctionPass +This declares a "``Hello``" class that is a subclass of :ref:`FunctionPass `. The different builtin pass subclasses are described in detail :ref:`later `, but for now, know that ``FunctionPass`` operates on a function at a time. @@ -146,7 +146,7 @@ to avoid using expensive C++ runtime information. .. code-block:: c++ - virtual bool runOnFunction(Function &F) { + bool runOnFunction(Function &F) override { errs() << "Hello: "; errs().write_escaped(F.getName()) << "\n"; return false; @@ -194,7 +194,7 @@ As a whole, the ``.cpp`` file looks like: static char ID; Hello() : FunctionPass(ID) {} - virtual bool runOnFunction(Function &F) { + bool runOnFunction(Function &F) override { errs() << "Hello: "; errs().write_escaped(F.getName()) << '\n'; return false; @@ -259,7 +259,6 @@ To see what happened to the other string you registered, try running -hello - Hello World Pass -indvars - Induction Variable Simplification -inline - Function Integration/Inlining - -insert-edge-profiling - Insert instrumentation for edge profiling ... The pass name gets added as the information string for your pass, giving some @@ -435,9 +434,8 @@ The ``doFinalization(CallGraph &)`` method virtual bool doFinalization(CallGraph &CG); The ``doFinalization`` method is an infrequently used method that is called -when the pass framework has finished calling :ref:`runOnFunction -` for every function in the program being -compiled. +when the pass framework has finished calling :ref:`runOnSCC +` for every SCC in the program being compiled. .. _writing-an-llvm-pass-FunctionPass: @@ -457,7 +455,7 @@ To be explicit, ``FunctionPass`` subclasses are not allowed to: #. Inspect or modify a ``Function`` other than the one currently being processed. #. Add or remove ``Function``\ s from the current ``Module``. #. Add or remove global variables from the current ``Module``. -#. Maintain state across invocations of:ref:`runOnFunction +#. Maintain state across invocations of :ref:`runOnFunction ` (including global data). Implementing a ``FunctionPass`` is usually straightforward (See the :ref:`Hello @@ -855,7 +853,7 @@ Example implementations of ``getAnalysisUsage`` // This example modifies the program, but does not modify the CFG void LICM::getAnalysisUsage(AnalysisUsage &AU) const { AU.setPreservesCFG(); - AU.addRequired(); + AU.addRequired(); } .. _writing-an-llvm-pass-getAnalysis: @@ -872,7 +870,7 @@ you want, and returns a reference to that pass. For example: .. code-block:: c++ bool LICM::runOnFunction(Function &F) { - LoopInfo &LI = getAnalysis(); + LoopInfo &LI = getAnalysis().getLoopInfo(); //... } @@ -1164,7 +1162,7 @@ all! To fix this, we need to add the following :ref:`getAnalysisUsage .. code-block:: c++ // We don't modify the program, so we preserve all analyses - virtual void getAnalysisUsage(AnalysisUsage &AU) const { + void getAnalysisUsage(AnalysisUsage &AU) const override { AU.setPreservesAll(); }