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 #include <list>
  14 #include <vector>
  15
  16 class Method;
  17 class SymTabValue;
  18
  19 //===----------------------------------------------------------------------===//
  20 //                            TerminatorInst Class
  21 //===----------------------------------------------------------------------===//
  22
  23 // TerminatorInst - Subclasses of this class are all able to terminate a basic
  24 // block.  Thus, these are all the flow control type of operations.
  25 //
  26 class TerminatorInst : public Instruction {
  27 public:
  28   TerminatorInst(unsigned iType);
  29   inline ~TerminatorInst() {}
  30
  31   // Terminators must implement the methods required by Instruction...
  32   virtual Instruction *clone() const = 0;
  33   virtual const char *getOpcodeName() const = 0;
  34
  35   // Additionally, they must provide a method to get at the successors of this
  36   // terminator instruction.  If 'idx' is out of range, a null pointer shall be
  37   // returned.
  38   //
  39   virtual const BasicBlock *getSuccessor(unsigned idx) const = 0;
  40   virtual unsigned getNumSuccessors() const = 0;
  41
  42   inline BasicBlock *getSuccessor(unsigned idx) {
  43     return (BasicBlock*)((const TerminatorInst *)this)->getSuccessor(idx);
  44   }
  45 };
  46
  47
  48 //===----------------------------------------------------------------------===//
  49 //                            UnaryOperator Class
  50 //===----------------------------------------------------------------------===//
  51
  52 class UnaryOperator : public Instruction {
  53 public:
  54
  55   // create() - Construct a unary instruction, given the opcode
  56   // and its operand.
  57   //
  58   static UnaryOperator *create(unsigned Op, Value *Source);
  59
  60   UnaryOperator(Value *S, unsigned iType, const string &Name = "")
  61       : Instruction(S->getType(), iType, Name) {
  62     Operands.reserve(1);
  63     Operands.push_back(Use(S, this));
  64   }
  65
  66   virtual Instruction *clone() const {
  67     return create(getOpcode(), Operands[0]);
  68   }
  69
  70   virtual const char *getOpcodeName() const = 0;
  71 };
  72
  73
  74
  75 //===----------------------------------------------------------------------===//
  76 //                           BinaryOperator Class
  77 //===----------------------------------------------------------------------===//
  78
  79 class BinaryOperator : public Instruction {
  80 public:
  81
  82   // create() - Construct a binary instruction, given the opcode
  83   // and the two operands.
  84   //
  85   static BinaryOperator *create(unsigned Op, Value *S1, Value *S2,
  86                                 const string &Name = "");
  87
  88   BinaryOperator(unsigned iType, Value *S1, Value *S2,
  89                  const string &Name = "")
  90     : Instruction(S1->getType(), iType, Name) {
  91     Operands.reserve(2);
  92     Operands.push_back(Use(S1, this));
  93     Operands.push_back(Use(S2, this));
  94     assert(Operands[0] && Operands[1] &&
  95            Operands[0]->getType() == Operands[1]->getType());
  96   }
  97
  98   virtual Instruction *clone() const {
  99     return create(getOpcode(), Operands[0], Operands[1]);
 100   }
 101
 102   virtual const char *getOpcodeName() const = 0;
 103 };
 104
 105 #endif