SEGCallSiteOutputNode.h

/*
 * SEGCallSiteOutputNode.h
 *
 * Qingkai
 *
 * This node is to model the output of a call site.
 */
 
#ifndef IR_SEG_SEGCALLSITEOUTPUTNODE_H
#define IR_SEG_SEGCALLSITEOUTPUTNODE_H
 
#include <llvm/IR/BasicBlock.h>
 
#include "CBAccessPath.h"
#include "IR/SEG/SymbolicExprGraph.h"
#include "Persistence/PersistenceBasis.h"
 
using namespace llvm;
 
class SEGCallSiteOutputNode : public SEGOperandNode {
public:
  SEGCallSiteOutputNode(PersistedSEGCallSiteOutputNode *Node,
                        SymbolicExprGraph *SEG);
 
  virtual void assembleSEGObject(std::map<int, SEGObject *> &FuncSEGObjMap);
 
protected:
  SEGCallSite *SEGCS;
 
  SEGCallSiteOutputNode(SEGObjectKind, SEGCallSite *CS, Type *Ty,
                        SymbolicExprGraph *SEG, BasicBlock *BB);
 
  SEGCallSiteOutputNode(SEGObjectKind, SEGCallSite *CS, Value *Val, Type *Ty,
                        SymbolicExprGraph *SEG, BasicBlock *BB);
 
  friend class SymbolicExprGraph;
 
public:
  ~SEGCallSiteOutputNode() {}
 
  virtual Instruction *getLLVMDbgInstruction() const override;
 
  const SEGCallSite *getCallSite() const { return SEGCS; }
 
  virtual size_t getIndex() const = 0;
 
  virtual std::string getSrcFile() const;
 
  virtual std::int32_t getSrcLine() const;
 
public:
  static bool classof(const SEGObject *N) {
    return N->getKind() >= SEGOBJK_CallSiteOutputBegin &&
           N->getKind() <= SEGOBJK_CallSiteOutputEnd;
  }
};
 
class SEGCallSiteCommonOutputNode : public SEGCallSiteOutputNode {
public:
  SEGCallSiteCommonOutputNode(PersistedSEGCallSiteCommonOutputNode *Node,
                              SymbolicExprGraph *SEG);
 
  virtual void assembleSEGObject(std::map<int, SEGObject *> &FuncSEGObjMap) {
    SEGCallSiteOutputNode::assembleSEGObject(FuncSEGObjMap);
  }
 
private:
  SEGCallSiteCommonOutputNode(SEGCallSite *CS, Type *Ty, SymbolicExprGraph *SEG,
                              BasicBlock *BB);
 
  SEGCallSiteCommonOutputNode(SEGCallSite *CS, Value *Val, Type *Ty,
                              SymbolicExprGraph *SEG, BasicBlock *BB);
 
  friend class SymbolicExprGraph;
 
public:
  ~SEGCallSiteCommonOutputNode() {}
 
  virtual PersistedSEGObject *createPersistedObject() const;
 
  virtual size_t getIndex() const {
    assert(false);
    return 0;
  }
 
public:
  static bool classof(const SEGObject *N) {
    return N->getKind() == SEGOBJK_CallSiteCommonOutput;
  }
};
 
class SEGCallSitePseudoOutputNode : public SEGCallSiteOutputNode {
public:
  SEGCallSitePseudoOutputNode(PersistedSEGCallSitePseudoOutputNode *Node,
                              SymbolicExprGraph *SEG);
 
  virtual void assembleSEGObject(std::map<int, SEGObject *> &FuncSEGObjMap) {
    SEGCallSiteOutputNode::assembleSEGObject(FuncSEGObjMap);
  }
 
private:
  SEGCallSitePseudoOutputNode(SEGCallSite *CS, Function *Callee, Type *Ty,
                              SymbolicExprGraph *SEG, BasicBlock *BB);
 
  SEGCallSitePseudoOutputNode(SEGCallSite *CS, Function *Callee, Value *Val,
                              Type *Ty, SymbolicExprGraph *SEG, BasicBlock *BB);
 
  // If it is a pseudo call site return node, it has an index
  // It is set by the SEGCallSite
  size_t Index = -1;
 
  CBAccessPath AP;
 
  Function *Callee = nullptr;
 
  WrappedFunction *WrappedCallee = nullptr;
 
  friend class SymbolicExprGraph;
  friend class SEGCallSite;
 
public:
  ~SEGCallSitePseudoOutputNode() {}
 
  virtual PersistedSEGObject *createPersistedObject() const;
 
  virtual size_t getIndex() const { return Index; }
 
  const CBAccessPath &getAccessPath() const { return AP; }
 
  CBAccessPath &getAccessPath() { return AP; }
 
  Function *getCallee() const { return Callee; }
 
  WrappedFunction *getWrappedCallee() const { return WrappedCallee; }
 
public:
  static bool classof(const SEGObject *N) {
    return N->getKind() == SEGOBJK_CallSitePseudoOutput;
  }
};
 
#endif