SEGArgumentNode.h

/*
 * SEGArgumentNode.h
 *
 * Qingkai
 *
 * This node is to model arguments of a function.
 */
 
#ifndef IR_SEG_SEGARGUMENTNODE_H
#define IR_SEG_SEGARGUMENTNODE_H
 
#include <llvm/IR/BasicBlock.h>
 
#include "CBAccessPath.h"
#include "IR/SEG/SymbolicExprGraph.h"
using namespace llvm;
 
class SEGArgumentNode : public SEGOperandNode {
protected:
  SEGArgumentNode(SEGObjectKind NTy, Type *Ty, SymbolicExprGraph *SEG,
                  BasicBlock *BB, bool fromDisk)
      : SEGOperandNode(NTy, Ty, SEG, BB, fromDisk) {}
 
  SEGArgumentNode(SEGObjectKind NTy, Value *Val, Type *Ty,
                  SymbolicExprGraph *SEG, BasicBlock *BB, bool fromDisk)
      : SEGOperandNode(NTy, Val, Ty, SEG, BB, fromDisk) {}
 
  ~SEGArgumentNode() {}
 
  friend class SymbolicExprGraph;
 
public:
  virtual int64_t getIndex() const = 0;
 
public:
  static bool classof(const SEGObject *N) {
    return N->getKind() >= SEGOBJK_ArgumentBegin &&
           N->getKind() <= SEGOBJK_ArgumentEnd;
  }
};
 
class SEGCommonArgumentNode : public SEGArgumentNode {
private:
  // The index is set by SEG
  int64_t Index = -1;
 
  SEGCommonArgumentNode(Type *Ty, SymbolicExprGraph *SEG, BasicBlock *BB,
                        bool fromDisk)
      : SEGArgumentNode(SEGOBJK_CommonArgument, Ty, SEG, BB, fromDisk) {
    if (fromDisk) {
      return;
    }
    std::string Desc(std::string("carg_") + this->getDescription());
    this->setDescription(Desc);
  }
 
  SEGCommonArgumentNode(Value *Val, Type *Ty, SymbolicExprGraph *SEG,
                        BasicBlock *BB, bool fromDisk)
      : SEGArgumentNode(SEGOBJK_CommonArgument, Val, Ty, SEG, BB, fromDisk) {
    if (fromDisk) {
      return;
    }
    std::string Desc(std::string("carg_") + this->getDescription());
    this->setDescription(Desc);
  }
 
  friend class SymbolicExprGraph;
  friend class SEGSerializer;
  friend class SEGHash;
 
public:
  virtual ~SEGCommonArgumentNode() {}
 
  virtual int64_t getIndex() const {
    assert(Index != (int64_t)-1 && "Index of a common argument is not set!");
    return Index;
  }
 
  virtual std::string getAuxiliaryDebugStr() const {
    return "the index of this common argument is " + std::to_string(Index);
  }
 
public:
  static bool classof(const SEGObject *N) {
    return N->getKind() == SEGOBJK_CommonArgument;
  }
};
 
class SEGVarArgumentNode : public SEGArgumentNode {
private:
  SEGVarArgumentNode(Type *Ty, SymbolicExprGraph *SEG, BasicBlock *BB,
                     bool fromDisk)
      : SEGArgumentNode(SEGOBJK_VarArgument, Ty, SEG, BB, fromDisk) {
    std::string Desc(std::string("varg_") + this->getDescription());
    this->setDescription(Desc);
  }
 
  SEGVarArgumentNode(Value *Val, Type *Ty, SymbolicExprGraph *SEG,
                     BasicBlock *BB, bool fromDisk)
      : SEGArgumentNode(SEGOBJK_VarArgument, Val, Ty, SEG, BB, fromDisk) {
    std::string Desc(std::string("varg_") + this->getDescription());
    this->setDescription(Desc);
  }
 
  friend class SymbolicExprGraph;
 
public:
  ~SEGVarArgumentNode() {}
 
  virtual int64_t getIndex() const {
    assert(false);
    return -1;
  }
 
public:
  static bool classof(const SEGObject *N) {
    return N->getKind() == SEGOBJK_VarArgument;
  }
};
 
class SEGPseudoArgumentNode : public SEGArgumentNode {
private:
  int64_t Index = -1;
 
  CBAccessPath AP;
 
  SEGPseudoArgumentNode(Type *Ty, SymbolicExprGraph *SEG, BasicBlock *BB,
                        bool fromDisk)
      : SEGArgumentNode(SEGOBJK_PseudoArgument, Ty, SEG, BB, fromDisk) {
    std::string Desc(std::string("parg_") + this->getDescription());
    this->setDescription(Desc);
  }
 
  SEGPseudoArgumentNode(Value *Val, Type *Ty, SymbolicExprGraph *SEG,
                        BasicBlock *BB, bool fromDisk)
      : SEGArgumentNode(SEGOBJK_PseudoArgument, Val, Ty, SEG, BB, fromDisk) {
    std::string Desc(std::string("parg_") + this->getDescription());
    this->setDescription(Desc);
  }
 
  friend class SymbolicExprGraph;
  friend class SEGSerializer;
  friend class SEGHash;
 
public:
  ~SEGPseudoArgumentNode() {}
 
  virtual int64_t getIndex() const {
    assert(Index != (int64_t)-1 && "Index of a pseudo argument is not set!");
    return Index;
  }
 
public:
  static bool classof(const SEGObject *N) {
    return N->getKind() == SEGOBJK_PseudoArgument;
  }
 
  CBAccessPath &getAccessPath() { return AP; }
 
  const CBAccessPath &getAccessPath() const { return AP; }
};
 
#endif