include/llvm/InstrTypes.h

   1 //===-- llvm/InstrTypes.h - Important Instruction subclasses ----*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines various meta classes of instructions that exist in the VM
  11 // representation.  Specific concrete subclasses of these may be found in the
  12 // i*.h files...
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #ifndef LLVM_INSTRUCTION_TYPES_H
  17 #define LLVM_INSTRUCTION_TYPES_H
  18
  19 #include "llvm/Instruction.h"
  20
  21 namespace llvm {
  22
  23 //===----------------------------------------------------------------------===//
  24 //                            TerminatorInst Class
  25 //===----------------------------------------------------------------------===//
  26
  27 /// TerminatorInst - Subclasses of this class are all able to terminate a basic
  28 /// block.  Thus, these are all the flow control type of operations.
  29 ///
  30 class TerminatorInst : public Instruction {
  31 protected:
  32   TerminatorInst(Instruction::TermOps iType, Instruction *InsertBefore = 0);
  33   TerminatorInst(const Type *Ty, Instruction::TermOps iType,
  34                  const std::string &Name = "", Instruction *InsertBefore = 0)
  35     : Instruction(Ty, iType, Name, InsertBefore) {}
  36
  37   TerminatorInst(Instruction::TermOps iType, BasicBlock *InsertAtEnd);
  38   TerminatorInst(const Type *Ty, Instruction::TermOps iType,
  39                  const std::string &Name, BasicBlock *InsertAtEnd)
  40     : Instruction(Ty, iType, Name, InsertAtEnd) {}
  41
  42 public:
  43
  44   /// Terminators must implement the methods required by Instruction...
  45   virtual Instruction *clone() const = 0;
  46
  47   /// Additionally, they must provide a method to get at the successors of this
  48   /// terminator instruction.  'idx' may not be >= the number of successors
  49   /// returned by getNumSuccessors()!
  50   ///
  51   virtual const BasicBlock *getSuccessor(unsigned idx) const = 0;
  52   virtual unsigned getNumSuccessors() const = 0;
  53
  54   /// Set a successor at a given index
  55   virtual void setSuccessor(unsigned idx, BasicBlock *B) = 0;
  56
  57   inline BasicBlock *getSuccessor(unsigned idx) {
  58     const TerminatorInst *TI = this;
  59     return const_cast<BasicBlock*>(TI->getSuccessor(idx));
  60   }
  61
  62   // Methods for support type inquiry through isa, cast, and dyn_cast:
  63   static inline bool classof(const TerminatorInst *) { return true; }
  64   static inline bool classof(const Instruction *I) {
  65     return I->getOpcode() >= TermOpsBegin && I->getOpcode() < TermOpsEnd;
  66   }
  67   static inline bool classof(const Value *V) {
  68     return isa<Instruction>(V) && classof(cast<Instruction>(V));
  69   }
  70 };
  71
  72
  73 //===----------------------------------------------------------------------===//
  74 //                           BinaryOperator Class
  75 //===----------------------------------------------------------------------===//
  76
  77 class BinaryOperator : public Instruction {
  78 protected:
  79   void init(BinaryOps iType, Value *S1, Value *S2);
  80   BinaryOperator(BinaryOps iType, Value *S1, Value *S2, const Type *Ty,
  81                  const std::string &Name, Instruction *InsertBefore)
  82     : Instruction(Ty, iType, Name, InsertBefore) {
  83     init(iType, S1, S2);
  84   }
  85   BinaryOperator(BinaryOps iType, Value *S1, Value *S2, const Type *Ty,
  86                  const std::string &Name, BasicBlock *InsertAtEnd)
  87     : Instruction(Ty, iType, Name, InsertAtEnd) {
  88     init(iType, S1, S2);
  89   }
  90
  91 public:
  92
  93   /// create() - Construct a binary instruction, given the opcode and the two
  94   /// operands.  Optionally (if InstBefore is specified) insert the instruction
  95   /// into a BasicBlock right before the specified instruction.  The specified
  96   /// Instruction is allowed to be a dereferenced end iterator.
  97   ///
  98   static BinaryOperator *create(BinaryOps Op, Value *S1, Value *S2,
  99                                 const std::string &Name = "",
 100                                 Instruction *InsertBefore = 0);
 101
 102   /// create() - Construct a binary instruction, given the opcode and the two
 103   /// operands.  Also automatically insert this instruction to the end of the
 104   /// BasicBlock specified.
 105   ///
 106   static BinaryOperator *create(BinaryOps Op, Value *S1, Value *S2,
 107                                 const std::string &Name,
 108                                 BasicBlock *InsertAtEnd);
 109
 110   /// create* - These methods just forward to create, and are useful when you
 111   /// statically know what type of instruction you're going to create.  These
 112   /// helpers just save some typing.
 113 #define HANDLE_BINARY_INST(N, OPC, CLASS) \
 114   static BinaryOperator *create##OPC(Value *V1, Value *V2, \
 115                                      const std::string &Name = "") {\
 116     return create(Instruction::OPC, V1, V2, Name);\
 117   }
 118 #include "llvm/Instruction.def"
 119 #define HANDLE_BINARY_INST(N, OPC, CLASS) \
 120   static BinaryOperator *create##OPC(Value *V1, Value *V2, \
 121                                      const std::string &Name, BasicBlock *BB) {\
 122     return create(Instruction::OPC, V1, V2, Name, BB);\
 123   }
 124 #include "llvm/Instruction.def"
 125 #define HANDLE_BINARY_INST(N, OPC, CLASS) \
 126   static BinaryOperator *create##OPC(Value *V1, Value *V2, \
 127                                      const std::string &Name, Instruction *I) {\
 128     return create(Instruction::OPC, V1, V2, Name, I);\
 129   }
 130 #include "llvm/Instruction.def"
 131
 132
 133   /// Helper functions to construct and inspect unary operations (NEG and NOT)
 134   /// via binary operators SUB and XOR:
 135   ///
 136   /// createNeg, createNot - Create the NEG and NOT
 137   ///     instructions out of SUB and XOR instructions.
 138   ///
 139   static BinaryOperator *createNeg(Value *Op, const std::string &Name = "",
 140                                    Instruction *InsertBefore = 0);
 141   static BinaryOperator *createNeg(Value *Op, const std::string &Name,
 142                                    BasicBlock *InsertAtEnd);
 143   static BinaryOperator *createNot(Value *Op, const std::string &Name = "",
 144                                    Instruction *InsertBefore = 0);
 145   static BinaryOperator *createNot(Value *Op, const std::string &Name,
 146                                    BasicBlock *InsertAtEnd);
 147
 148   /// isNeg, isNot - Check if the given Value is a NEG or NOT instruction.
 149   ///
 150   static bool            isNeg(const Value *V);
 151   static bool            isNot(const Value *V);
 152
 153   /// getNegArgument, getNotArgument - Helper functions to extract the
 154   ///     unary argument of a NEG or NOT operation implemented via Sub or Xor.
 155   ///
 156   static const Value*    getNegArgument(const BinaryOperator* Bop);
 157   static       Value*    getNegArgument(      BinaryOperator* Bop);
 158   static const Value*    getNotArgument(const BinaryOperator* Bop);
 159   static       Value*    getNotArgument(      BinaryOperator* Bop);
 160
 161   BinaryOps getOpcode() const {
 162     return static_cast<BinaryOps>(Instruction::getOpcode());
 163   }
 164
 165   virtual BinaryOperator *clone() const;
 166
 167   /// swapOperands - Exchange the two operands to this instruction.
 168   /// This instruction is safe to use on any binary instruction and
 169   /// does not modify the semantics of the instruction.  If the
 170   /// instruction is order dependent (SetLT f.e.) the opcode is
 171   /// changed.  If the instruction cannot be reversed (ie, it's a Div),
 172   /// then return true.
 173   ///
 174   bool swapOperands();
 175
 176   // Methods for support type inquiry through isa, cast, and dyn_cast:
 177   static inline bool classof(const BinaryOperator *) { return true; }
 178   static inline bool classof(const Instruction *I) {
 179     return I->getOpcode() >= BinaryOpsBegin && I->getOpcode() < BinaryOpsEnd;
 180   }
 181   static inline bool classof(const Value *V) {
 182     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 183   }
 184 };
 185
 186 } // End llvm namespace
 187
 188 #endif