include/llvm/Analysis/DataStructure/DSSupport.h

   1 //===- DSSupport.h - Support for datastructure graphs -----------*- C++ -*-===//
   2 //
   3 // Support for graph nodes, call sites, and types.
   4 //
   5 //===----------------------------------------------------------------------===//
   6
   7 #ifndef LLVM_ANALYSIS_DSSUPPORT_H
   8 #define LLVM_ANALYSIS_DSSUPPORT_H
   9
  10 #include <vector>
  11 #include <functional>
  12 #include <string>
  13 #include <assert.h>
  14 #include "Support/HashExtras.h"
  15 #include "Support/hash_set"
  16
  17 class Function;
  18 class CallInst;
  19 class Value;
  20 class GlobalValue;
  21 class Type;
  22
  23 class DSNode;                  // Each node in the graph
  24 class DSGraph;                 // A graph for a function
  25
  26 namespace DS { // FIXME: After the paper, this should get cleaned up
  27   enum { PointerShift = 3,     // 64bit ptrs = 3, 32 bit ptrs = 2
  28          PointerSize = 1 << PointerShift
  29   };
  30
  31   // isPointerType - Return true if this first class type is big enough to hold
  32   // a pointer.
  33   //
  34   bool isPointerType(const Type *Ty);
  35 };
  36
  37 //===----------------------------------------------------------------------===//
  38 /// DSNodeHandle - Implement a "handle" to a data structure node that takes care
  39 /// of all of the add/un'refing of the node to prevent the backpointers in the
  40 /// graph from getting out of date.  This class represents a "pointer" in the
  41 /// graph, whose destination is an indexed offset into a node.
  42 ///
  43 /// Note: some functions that are marked as inline in DSNodeHandle are actually
  44 /// defined in DSNode.h because they need knowledge of DSNode operation. Putting
  45 /// them in a CPP file wouldn't help making them inlined and keeping DSNode and
  46 /// DSNodeHandle (and friends) in one file complicates things.
  47 ///
  48 class DSNodeHandle {
  49   mutable DSNode *N;
  50   mutable unsigned Offset;
  51   void operator==(const DSNode *N);  // DISALLOW, use to promote N to nodehandle
  52 public:
  53   // Allow construction, destruction, and assignment...
  54   DSNodeHandle(DSNode *n = 0, unsigned offs = 0) : N(0), Offset(offs) {
  55     setNode(n);
  56   }
  57   DSNodeHandle(const DSNodeHandle &H) : N(0), Offset(0) {
  58     setNode(H.getNode());
  59     Offset = H.Offset;      // Must read offset AFTER the getNode()
  60   }
  61   ~DSNodeHandle() { setNode((DSNode*)0); }
  62   DSNodeHandle &operator=(const DSNodeHandle &H) {
  63     Offset = 0; setNode(H.getNode()); Offset = H.Offset;
  64     return *this;
  65   }
  66
  67   bool operator<(const DSNodeHandle &H) const {  // Allow sorting
  68     return getNode() < H.getNode() || (N == H.N && Offset < H.Offset);
  69   }
  70   bool operator>(const DSNodeHandle &H) const { return H < *this; }
  71   bool operator==(const DSNodeHandle &H) const { // Allow comparison
  72     return getNode() == H.getNode() && Offset == H.Offset;
  73   }
  74   bool operator!=(const DSNodeHandle &H) const { return !operator==(H); }
  75
  76   inline void swap(DSNodeHandle &NH) {
  77     std::swap(Offset, NH.Offset);
  78     std::swap(N, NH.N);
  79   }
  80
  81   /// isNull - Check to see if getNode() == 0, without going through the trouble
  82   /// of checking to see if we are forwarding...
  83   bool isNull() const { return N == 0; }
  84
  85   // Allow explicit conversion to DSNode...
  86   inline DSNode *getNode() const;  // Defined inline in DSNode.h
  87   unsigned getOffset() const { return Offset; }
  88
  89   inline void setNode(DSNode *N);  // Defined inline in DSNode.h
  90   void setOffset(unsigned O) {
  91     //assert((!N || Offset < N->Size || (N->Size == 0 && Offset == 0) ||
  92     //       !N->ForwardNH.isNull()) && "Node handle offset out of range!");
  93     //assert((!N || O < N->Size || (N->Size == 0 && O == 0) ||
  94     //       !N->ForwardNH.isNull()) && "Node handle offset out of range!");
  95     Offset = O;
  96   }
  97
  98   void addEdgeTo(unsigned LinkNo, const DSNodeHandle &N);
  99   void addEdgeTo(const DSNodeHandle &N) { addEdgeTo(0, N); }
 100
 101   /// mergeWith - Merge the logical node pointed to by 'this' with the node
 102   /// pointed to by 'N'.
 103   ///
 104   void mergeWith(const DSNodeHandle &N);
 105
 106   // hasLink - Return true if there is a link at the specified offset...
 107   inline bool hasLink(unsigned Num) const;
 108
 109   /// getLink - Treat this current node pointer as a pointer to a structure of
 110   /// some sort.  This method will return the pointer a mem[this+Num]
 111   ///
 112   inline const DSNodeHandle &getLink(unsigned Num) const;
 113   inline DSNodeHandle &getLink(unsigned Num);
 114
 115   inline void setLink(unsigned Num, const DSNodeHandle &NH);
 116 private:
 117   DSNode *HandleForwarding() const;
 118 };
 119
 120 namespace std {
 121   inline void swap(DSNodeHandle &NH1, DSNodeHandle &NH2) { NH1.swap(NH2); }
 122 }
 123
 124 //===----------------------------------------------------------------------===//
 125 /// DSCallSite - Representation of a call site via its call instruction,
 126 /// the DSNode handle for the callee function (or function pointer), and
 127 /// the DSNode handles for the function arguments.
 128 ///
 129 class DSCallSite {
 130   CallInst    *Inst;                 // Actual call site
 131   Function    *CalleeF;              // The function called (direct call)
 132   DSNodeHandle CalleeN;              // The function node called (indirect call)
 133   DSNodeHandle RetVal;               // Returned value
 134   std::vector<DSNodeHandle> CallArgs;// The pointer arguments
 135
 136   static void InitNH(DSNodeHandle &NH, const DSNodeHandle &Src,
 137                      const hash_map<const DSNode*, DSNode*> &NodeMap) {
 138     if (DSNode *N = Src.getNode()) {
 139       hash_map<const DSNode*, DSNode*>::const_iterator I = NodeMap.find(N);
 140       assert(I != NodeMap.end() && "Not not in mapping!");
 141
 142       NH.setOffset(Src.getOffset());
 143       NH.setNode(I->second);
 144     }
 145   }
 146
 147   static void InitNH(DSNodeHandle &NH, const DSNodeHandle &Src,
 148                      const hash_map<const DSNode*, DSNodeHandle> &NodeMap) {
 149     if (DSNode *N = Src.getNode()) {
 150       hash_map<const DSNode*, DSNodeHandle>::const_iterator I = NodeMap.find(N);
 151       assert(I != NodeMap.end() && "Not not in mapping!");
 152
 153       NH.setOffset(Src.getOffset()+I->second.getOffset());
 154       NH.setNode(I->second.getNode());
 155     }
 156   }
 157
 158   DSCallSite();                         // DO NOT IMPLEMENT
 159 public:
 160   /// Constructor.  Note - This ctor destroys the argument vector passed in.  On
 161   /// exit, the argument vector is empty.
 162   ///
 163   DSCallSite(CallInst &inst, const DSNodeHandle &rv, DSNode *Callee,
 164              std::vector<DSNodeHandle> &Args)
 165     : Inst(&inst), CalleeF(0), CalleeN(Callee), RetVal(rv) {
 166     assert(Callee && "Null callee node specified for call site!");
 167     Args.swap(CallArgs);
 168   }
 169   DSCallSite(CallInst &inst, const DSNodeHandle &rv, Function *Callee,
 170              std::vector<DSNodeHandle> &Args)
 171     : Inst(&inst), CalleeF(Callee), RetVal(rv) {
 172     assert(Callee && "Null callee function specified for call site!");
 173     Args.swap(CallArgs);
 174   }
 175
 176   DSCallSite(const DSCallSite &DSCS)   // Simple copy ctor
 177     : Inst(DSCS.Inst), CalleeF(DSCS.CalleeF), CalleeN(DSCS.CalleeN),
 178       RetVal(DSCS.RetVal), CallArgs(DSCS.CallArgs) {}
 179
 180   /// Mapping copy constructor - This constructor takes a preexisting call site
 181   /// to copy plus a map that specifies how the links should be transformed.
 182   /// This is useful when moving a call site from one graph to another.
 183   ///
 184   template<typename MapTy>
 185   DSCallSite(const DSCallSite &FromCall, const MapTy &NodeMap) {
 186     Inst = FromCall.Inst;
 187     InitNH(RetVal, FromCall.RetVal, NodeMap);
 188     InitNH(CalleeN, FromCall.CalleeN, NodeMap);
 189     CalleeF = FromCall.CalleeF;
 190
 191     CallArgs.resize(FromCall.CallArgs.size());
 192     for (unsigned i = 0, e = FromCall.CallArgs.size(); i != e; ++i)
 193       InitNH(CallArgs[i], FromCall.CallArgs[i], NodeMap);
 194   }
 195
 196   /// isDirectCall - Return true if this call site is a direct call of the
 197   /// function specified by getCalleeFunc.  If not, it is an indirect call to
 198   /// the node specified by getCalleeNode.
 199   ///
 200   bool isDirectCall() const { return CalleeF != 0; }
 201   bool isIndirectCall() const { return !isDirectCall(); }
 202
 203
 204   // Accessor functions...
 205   Function           &getCaller()     const;
 206   CallInst           &getCallInst()   const { return *Inst; }
 207         DSNodeHandle &getRetVal()           { return RetVal; }
 208   const DSNodeHandle &getRetVal()     const { return RetVal; }
 209
 210   DSNode *getCalleeNode() const {
 211     assert(!CalleeF && CalleeN.getNode()); return CalleeN.getNode();
 212   }
 213   Function *getCalleeFunc() const {
 214     assert(!CalleeN.getNode() && CalleeF); return CalleeF;
 215   }
 216
 217   unsigned            getNumPtrArgs() const { return CallArgs.size(); }
 218
 219   DSNodeHandle &getPtrArg(unsigned i) {
 220     assert(i < CallArgs.size() && "Argument to getPtrArgNode is out of range!");
 221     return CallArgs[i];
 222   }
 223   const DSNodeHandle &getPtrArg(unsigned i) const {
 224     assert(i < CallArgs.size() && "Argument to getPtrArgNode is out of range!");
 225     return CallArgs[i];
 226   }
 227
 228   void swap(DSCallSite &CS) {
 229     if (this != &CS) {
 230       std::swap(Inst, CS.Inst);
 231       std::swap(RetVal, CS.RetVal);
 232       std::swap(CalleeN, CS.CalleeN);
 233       std::swap(CalleeF, CS.CalleeF);
 234       std::swap(CallArgs, CS.CallArgs);
 235     }
 236   }
 237
 238   // MergeWith - Merge the return value and parameters of the these two call
 239   // sites.
 240   void mergeWith(DSCallSite &CS) {
 241     getRetVal().mergeWith(CS.getRetVal());
 242     unsigned MinArgs = getNumPtrArgs();
 243     if (CS.getNumPtrArgs() < MinArgs) MinArgs = CS.getNumPtrArgs();
 244
 245     for (unsigned a = 0; a != MinArgs; ++a)
 246       getPtrArg(a).mergeWith(CS.getPtrArg(a));
 247   }
 248
 249   /// markReachableNodes - This method recursively traverses the specified
 250   /// DSNodes, marking any nodes which are reachable.  All reachable nodes it
 251   /// adds to the set, which allows it to only traverse visited nodes once.
 252   ///
 253   void markReachableNodes(hash_set<DSNode*> &Nodes);
 254
 255   bool operator<(const DSCallSite &CS) const {
 256     if (isDirectCall()) {      // This must sort by callee first!
 257       if (CS.isIndirectCall()) return true;
 258       if (CalleeF < CS.CalleeF) return true;
 259       if (CalleeF > CS.CalleeF) return false;
 260     } else {
 261       if (CS.isDirectCall()) return false;
 262       if (CalleeN < CS.CalleeN) return true;
 263       if (CalleeN > CS.CalleeN) return false;
 264     }
 265     if (RetVal < CS.RetVal) return true;
 266     if (RetVal > CS.RetVal) return false;
 267     return CallArgs < CS.CallArgs;
 268   }
 269
 270   bool operator==(const DSCallSite &CS) const {
 271     return RetVal == CS.RetVal && CalleeN == CS.CalleeN &&
 272            CalleeF == CS.CalleeF && CallArgs == CS.CallArgs;
 273   }
 274 };
 275
 276 namespace std {
 277   inline void swap(DSCallSite &CS1, DSCallSite &CS2) { CS1.swap(CS2); }
 278 }
 279 #endif