include/llvm/InstrTypes.h

   1 //===-- llvm/InstrTypes.h - Important Instruction subclasses -----*- C++ -*--=//
   2 //
   3 // This file defines various meta classes of instructions that exist in the VM
   4 // representation.  Specific concrete subclasses of these may be found in the
   5 // i*.h files...
   6 //
   7 //===----------------------------------------------------------------------===//
   8
   9 #ifndef LLVM_INSTRUCTION_TYPES_H
  10 #define LLVM_INSTRUCTION_TYPES_H
  11
  12 #include "llvm/Instruction.h"
  13
  14 //===----------------------------------------------------------------------===//
  15 //                            TerminatorInst Class
  16 //===----------------------------------------------------------------------===//
  17
  18 // TerminatorInst - Subclasses of this class are all able to terminate a basic
  19 // block.  Thus, these are all the flow control type of operations.
  20 //
  21 class TerminatorInst : public Instruction {
  22 protected:
  23   TerminatorInst(Instruction::TermOps iType);
  24   TerminatorInst(const Type *Ty, Instruction::TermOps iType,
  25                  const std::string &Name = "");
  26 public:
  27
  28   // Terminators must implement the methods required by Instruction...
  29   virtual Instruction *clone() const = 0;
  30
  31   // Additionally, they must provide a method to get at the successors of this
  32   // terminator instruction.  'idx' may not be >= the number of successors
  33   // returned by getNumSuccessors()!
  34   //
  35   virtual const BasicBlock *getSuccessor(unsigned idx) const = 0;
  36   virtual unsigned getNumSuccessors() const = 0;
  37
  38   // Set a successor at a given index
  39   virtual void setSuccessor(unsigned idx, BasicBlock *B) = 0;
  40
  41   inline BasicBlock *getSuccessor(unsigned idx) {
  42     return (BasicBlock*)((const TerminatorInst *)this)->getSuccessor(idx);
  43   }
  44
  45   // Methods for support type inquiry through isa, cast, and dyn_cast:
  46   static inline bool classof(const TerminatorInst *) { return true; }
  47   static inline bool classof(const Instruction *I) {
  48     return I->getOpcode() >= FirstTermOp && I->getOpcode() < NumTermOps;
  49   }
  50   static inline bool classof(const Value *V) {
  51     return isa<Instruction>(V) && classof(cast<Instruction>(V));
  52   }
  53 };
  54
  55
  56 //===----------------------------------------------------------------------===//
  57 //                           BinaryOperator Class
  58 //===----------------------------------------------------------------------===//
  59
  60 class BinaryOperator : public Instruction {
  61 protected:
  62   BinaryOperator(BinaryOps iType, Value *S1, Value *S2,
  63                  const std::string &Name = "")
  64     : Instruction(S1->getType(), iType, Name) {
  65     Operands.reserve(2);
  66     Operands.push_back(Use(S1, this));
  67     Operands.push_back(Use(S2, this));
  68     assert(Operands[0] && Operands[1] &&
  69            Operands[0]->getType() == Operands[1]->getType());
  70   }
  71
  72 public:
  73
  74   // create() - Construct a binary instruction, given the opcode
  75   // and the two operands.
  76   //
  77   static BinaryOperator *create(BinaryOps Op, Value *S1, Value *S2,
  78                                 const std::string &Name = "");
  79
  80   // createNeg, createNot - Helper constructors that create the "neg" and "not"
  81   // instructions out of "sub" and "xor" instructions.
  82   //
  83   static BinaryOperator *createNeg(Value *Op, const std::string &Name = "");
  84   static BinaryOperator *createNot(Value *Op, const std::string &Name = "");
  85
  86   BinaryOps getOpcode() const {
  87     return (BinaryOps)Instruction::getOpcode();
  88   }
  89
  90   virtual Instruction *clone() const {
  91     return create(getOpcode(), Operands[0], Operands[1]);
  92   }
  93
  94   // swapOperands - Exchange the two operands to this instruction.
  95   // This instruction is safe to use on any binary instruction and
  96   // does not modify the semantics of the instruction.  If the
  97   // instruction is order dependant (SetLT f.e.) the opcode is
  98   // changed.  If the instruction cannot be reversed (ie, it's a Div),
  99   // then return true.
 100   //
 101   bool swapOperands();
 102
 103   // Methods for support type inquiry through isa, cast, and dyn_cast:
 104   static inline bool classof(const BinaryOperator *) { return true; }
 105   static inline bool classof(const Instruction *I) {
 106     return I->getOpcode() >= FirstBinaryOp && I->getOpcode() < NumBinaryOps;
 107   }
 108   static inline bool classof(const Value *V) {
 109     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 110   }
 111 };
 112
 113 #endif