include/llvm/Analysis/LiveVar/FunctionLiveVarInfo.h

   1 /* Title:   FunctionLiveVarInfo.h             -*- C++ -*-
   2    Author:  Ruchira Sasanka
   3    Date:    Jun 30, 01
   4    Purpose:
   5
   6    This is the interface for live variable info of a function that is required
   7    by any other part of the compiler
   8
   9    It must be called like:
  10
  11        FunctionLiveVarInfo FLVI(Function *);  // initializes data structures
  12        FLVI.analyze();                     // do the actural live variable anal
  13
  14  After the analysis, getInSetOfBB or getOutSetofBB can be called to get
  15  live var info of a BB.
  16
  17  The live var set before an instruction can be obtained in 2 ways:
  18
  19  1. Use the method getLiveVarSetAfterInst(Instruction *) to get the LV Info
  20     just after an instruction. (also exists getLiveVarSetBeforeInst(..))
  21
  22     This function caluclates the LV info for a BB only once and caches that
  23     info. If the cache does not contain the LV info of the instruction, it
  24     calculates the LV info for the whole BB and caches them.
  25
  26     Getting liveVar info this way uses more memory since, LV info should be
  27     cached. However, if you need LV info of nearly all the instructions of a
  28     BB, this is the best and simplest interfrace.
  29
  30
  31  2. Use the OutSet and applyTranferFuncForInst(const Instruction *const Inst)
  32     declared in LiveVarSet and  traverse the instructions of a basic block in
  33     reverse (using const_reverse_iterator in the BB class).
  34
  35     This is the most memory efficient method if you need LV info for
  36     only several instructions in a BasicBlock. An example is given below:
  37
  38
  39     LiveVarSet LVSet;  // this will be the set used to traverse through each BB
  40
  41     // Initialize LVSet so that it is the same as OutSet of the BB
  42     LVSet.setUnion( LVI->getOutSetOfBB( *BBI ) );
  43
  44     BasicBlock::InstListType::const_reverse_iterator
  45       InstIterator = InstListInBB.rbegin(); // get the rev iter for inst in BB
  46
  47       // iterate over all the instructions in BB in reverse
  48     for( ; InstIterator != InstListInBB.rend(); InstIterator++) {
  49
  50       //...... all  code here which uses LVSet ........
  51
  52       LVSet.applyTranferFuncForInst(*InstIterator);
  53
  54       // Now LVSet contains live vars ABOVE the current instrution
  55     }
  56
  57     See buildInterferenceGraph() for the above example.
  58 */
  59
  60
  61 #ifndef METH_LIVE_VAR_INFO_H
  62 #define METH_LIVE_VAR_INFO_H
  63
  64 #include "llvm/Pass.h"
  65 #include "llvm/Analysis/LiveVar/ValueSet.h"
  66
  67 class BBLiveVar;
  68 class MachineInstr;
  69
  70 class FunctionLiveVarInfo : public FunctionPass {
  71   // Machine Instr to LiveVarSet Map for providing LVset BEFORE each inst
  72   std::map<const MachineInstr *, const ValueSet *> MInst2LVSetBI;
  73
  74   // Machine Instr to LiveVarSet Map for providing LVset AFTER each inst
  75   std::map<const MachineInstr *, const ValueSet *> MInst2LVSetAI;
  76
  77   // Stored Function that the data is computed with respect to
  78   const Function *M;
  79
  80   // --------- private methods -----------------------------------------
  81
  82   // constructs BBLiveVars and init Def and In sets
  83   void constructBBs(const Function *F);
  84
  85   // do one backward pass over the CFG
  86   bool doSingleBackwardPass(const Function *F, unsigned int iter);
  87
  88   // calculates live var sets for instructions in a BB
  89   void calcLiveVarSetsForBB(const BasicBlock *BB);
  90
  91 public:
  92   static AnalysisID ID;    // We are an analysis, we must have an ID
  93
  94   FunctionLiveVarInfo(AnalysisID id = ID) { assert(id == ID); }
  95
  96   virtual const char *getPassName() const { return "Live Variable Analysis"; }
  97
  98   // --------- Implement the FunctionPass interface ----------------------
  99
 100   // runOnFunction - Perform analysis, update internal data structures.
 101   virtual bool runOnFunction(Function *F);
 102
 103   // releaseMemory - After LiveVariable analysis has been used, forget!
 104   virtual void releaseMemory();
 105
 106   // getAnalysisUsage - Provide self!
 107   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 108     AU.setPreservesAll();
 109     AU.addProvided(ID);
 110   }
 111
 112   // --------- Functions to access analysis results -------------------
 113
 114   // gets OutSet of a BB
 115   const ValueSet &getOutSetOfBB(const BasicBlock *BB) const;
 116
 117   // gets InSet of a BB
 118   const ValueSet &getInSetOfBB(const BasicBlock *BB) const;
 119
 120   // gets the Live var set BEFORE an instruction
 121   const ValueSet &getLiveVarSetBeforeMInst(const MachineInstr *MI,
 122                                            const BasicBlock *BB);
 123
 124   // gets the Live var set AFTER an instruction
 125   const ValueSet &getLiveVarSetAfterMInst(const MachineInstr *MI,
 126                                           const BasicBlock *BB);
 127 };
 128
 129 #endif