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, Use *Ops, unsigned NumOps,
  33                  Instruction *InsertBefore = 0);
  34   TerminatorInst(const Type *Ty, Instruction::TermOps iType,
  35                   Use *Ops, unsigned NumOps,
  36                  const std::string &Name = "", Instruction *InsertBefore = 0)
  37     : Instruction(Ty, iType, Ops, NumOps, Name, InsertBefore) {}
  38
  39   TerminatorInst(Instruction::TermOps iType, Use *Ops, unsigned NumOps,
  40                  BasicBlock *InsertAtEnd);
  41   TerminatorInst(const Type *Ty, Instruction::TermOps iType,
  42                   Use *Ops, unsigned NumOps,
  43                  const std::string &Name, BasicBlock *InsertAtEnd)
  44     : Instruction(Ty, iType, Ops, NumOps, Name, InsertAtEnd) {}
  45
  46   // Out of line virtual method, so the vtable, etc has a home.
  47   ~TerminatorInst();
  48
  49   /// Virtual methods - Terminators should overload these and provide inline
  50   /// overrides of non-V methods.
  51   virtual BasicBlock *getSuccessorV(unsigned idx) const = 0;
  52   virtual unsigned getNumSuccessorsV() const = 0;
  53   virtual void setSuccessorV(unsigned idx, BasicBlock *B) = 0;
  54 public:
  55
  56   virtual Instruction *clone() const = 0;
  57
  58   /// getNumSuccessors - Return the number of successors that this terminator
  59   /// has.
  60   unsigned getNumSuccessors() const {
  61     return getNumSuccessorsV();
  62   }
  63
  64   /// getSuccessor - Return the specified successor.
  65   ///
  66   BasicBlock *getSuccessor(unsigned idx) const {
  67     return getSuccessorV(idx);
  68   }
  69
  70   /// setSuccessor - Update the specified successor to point at the provided
  71   /// block.
  72   void setSuccessor(unsigned idx, BasicBlock *B) {
  73     setSuccessorV(idx, B);
  74   }
  75
  76   // Methods for support type inquiry through isa, cast, and dyn_cast:
  77   static inline bool classof(const TerminatorInst *) { return true; }
  78   static inline bool classof(const Instruction *I) {
  79     return I->getOpcode() >= TermOpsBegin && I->getOpcode() < TermOpsEnd;
  80   }
  81   static inline bool classof(const Value *V) {
  82     return isa<Instruction>(V) && classof(cast<Instruction>(V));
  83   }
  84 };
  85
  86 //===----------------------------------------------------------------------===//
  87 //                          UnaryInstruction Class
  88 //===----------------------------------------------------------------------===//
  89
  90 class UnaryInstruction : public Instruction {
  91   Use Op;
  92 protected:
  93   UnaryInstruction(const Type *Ty, unsigned iType, Value *V,
  94                    const std::string &Name = "", Instruction *IB = 0)
  95     : Instruction(Ty, iType, &Op, 1, Name, IB), Op(V, this) {
  96   }
  97   UnaryInstruction(const Type *Ty, unsigned iType, Value *V,
  98                    const std::string &Name, BasicBlock *IAE)
  99     : Instruction(Ty, iType, &Op, 1, Name, IAE), Op(V, this) {
 100   }
 101 public:
 102   // Out of line virtual method, so the vtable, etc has a home.
 103   ~UnaryInstruction();
 104
 105   // Transparently provide more efficient getOperand methods.
 106   Value *getOperand(unsigned i) const {
 107     assert(i == 0 && "getOperand() out of range!");
 108     return Op;
 109   }
 110   void setOperand(unsigned i, Value *Val) {
 111     assert(i == 0 && "setOperand() out of range!");
 112     Op = Val;
 113   }
 114   unsigned getNumOperands() const { return 1; }
 115 };
 116
 117 //===----------------------------------------------------------------------===//
 118 //                           BinaryOperator Class
 119 //===----------------------------------------------------------------------===//
 120
 121 class BinaryOperator : public Instruction {
 122   Use Ops[2];
 123 protected:
 124   void init(BinaryOps iType);
 125   BinaryOperator(BinaryOps iType, Value *S1, Value *S2, const Type *Ty,
 126                  const std::string &Name, Instruction *InsertBefore)
 127     : Instruction(Ty, iType, Ops, 2, Name, InsertBefore) {
 128       Ops[0].init(S1, this);
 129       Ops[1].init(S2, this);
 130     init(iType);
 131   }
 132   BinaryOperator(BinaryOps iType, Value *S1, Value *S2, const Type *Ty,
 133                  const std::string &Name, BasicBlock *InsertAtEnd)
 134     : Instruction(Ty, iType, Ops, 2, Name, InsertAtEnd) {
 135     Ops[0].init(S1, this);
 136     Ops[1].init(S2, this);
 137     init(iType);
 138   }
 139
 140 public:
 141
 142   /// Transparently provide more efficient getOperand methods.
 143   Value *getOperand(unsigned i) const {
 144     assert(i < 2 && "getOperand() out of range!");
 145     return Ops[i];
 146   }
 147   void setOperand(unsigned i, Value *Val) {
 148     assert(i < 2 && "setOperand() out of range!");
 149     Ops[i] = Val;
 150   }
 151   unsigned getNumOperands() const { return 2; }
 152
 153   /// create() - Construct a binary instruction, given the opcode and the two
 154   /// operands.  Optionally (if InstBefore is specified) insert the instruction
 155   /// into a BasicBlock right before the specified instruction.  The specified
 156   /// Instruction is allowed to be a dereferenced end iterator.
 157   ///
 158   static BinaryOperator *create(BinaryOps Op, Value *S1, Value *S2,
 159                                 const std::string &Name = "",
 160                                 Instruction *InsertBefore = 0);
 161
 162   /// create() - Construct a binary instruction, given the opcode and the two
 163   /// operands.  Also automatically insert this instruction to the end of the
 164   /// BasicBlock specified.
 165   ///
 166   static BinaryOperator *create(BinaryOps Op, Value *S1, Value *S2,
 167                                 const std::string &Name,
 168                                 BasicBlock *InsertAtEnd);
 169
 170   /// create* - These methods just forward to create, and are useful when you
 171   /// statically know what type of instruction you're going to create.  These
 172   /// helpers just save some typing.
 173 #define HANDLE_BINARY_INST(N, OPC, CLASS) \
 174   static BinaryOperator *create##OPC(Value *V1, Value *V2, \
 175                                      const std::string &Name = "") {\
 176     return create(Instruction::OPC, V1, V2, Name);\
 177   }
 178 #include "llvm/Instruction.def"
 179 #define HANDLE_BINARY_INST(N, OPC, CLASS) \
 180   static BinaryOperator *create##OPC(Value *V1, Value *V2, \
 181                                      const std::string &Name, BasicBlock *BB) {\
 182     return create(Instruction::OPC, V1, V2, Name, BB);\
 183   }
 184 #include "llvm/Instruction.def"
 185 #define HANDLE_BINARY_INST(N, OPC, CLASS) \
 186   static BinaryOperator *create##OPC(Value *V1, Value *V2, \
 187                                      const std::string &Name, Instruction *I) {\
 188     return create(Instruction::OPC, V1, V2, Name, I);\
 189   }
 190 #include "llvm/Instruction.def"
 191
 192
 193   /// Helper functions to construct and inspect unary operations (NEG and NOT)
 194   /// via binary operators SUB and XOR:
 195   ///
 196   /// createNeg, createNot - Create the NEG and NOT
 197   ///     instructions out of SUB and XOR instructions.
 198   ///
 199   static BinaryOperator *createNeg(Value *Op, const std::string &Name = "",
 200                                    Instruction *InsertBefore = 0);
 201   static BinaryOperator *createNeg(Value *Op, const std::string &Name,
 202                                    BasicBlock *InsertAtEnd);
 203   static BinaryOperator *createNot(Value *Op, const std::string &Name = "",
 204                                    Instruction *InsertBefore = 0);
 205   static BinaryOperator *createNot(Value *Op, const std::string &Name,
 206                                    BasicBlock *InsertAtEnd);
 207
 208   /// isNeg, isNot - Check if the given Value is a NEG or NOT instruction.
 209   ///
 210   static bool isNeg(const Value *V);
 211   static bool isNot(const Value *V);
 212
 213   /// getNegArgument, getNotArgument - Helper functions to extract the
 214   ///     unary argument of a NEG or NOT operation implemented via Sub or Xor.
 215   ///
 216   static const Value *getNegArgument(const Value *BinOp);
 217   static       Value *getNegArgument(      Value *BinOp);
 218   static const Value *getNotArgument(const Value *BinOp);
 219   static       Value *getNotArgument(      Value *BinOp);
 220
 221   BinaryOps getOpcode() const {
 222     return static_cast<BinaryOps>(Instruction::getOpcode());
 223   }
 224
 225   virtual BinaryOperator *clone() const;
 226
 227   /// swapOperands - Exchange the two operands to this instruction.
 228   /// This instruction is safe to use on any binary instruction and
 229   /// does not modify the semantics of the instruction.  If the
 230   /// instruction is order dependent (SetLT f.e.) the opcode is
 231   /// changed.  If the instruction cannot be reversed (ie, it's a Div),
 232   /// then return true.
 233   ///
 234   bool swapOperands();
 235
 236   // Methods for support type inquiry through isa, cast, and dyn_cast:
 237   static inline bool classof(const BinaryOperator *) { return true; }
 238   static inline bool classof(const Instruction *I) {
 239     return I->getOpcode() >= BinaryOpsBegin && I->getOpcode() < BinaryOpsEnd;
 240   }
 241   static inline bool classof(const Value *V) {
 242     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 243   }
 244 };
 245
 246 //===----------------------------------------------------------------------===//
 247 //                               CastInst Class
 248 //===----------------------------------------------------------------------===//
 249
 250 /// CastInst - This is the base class for all instructions that perform data
 251 /// casts. It is simply provided so that instruction category testing
 252 /// can be performed with code like:
 253 ///
 254 /// if (isa<CastInst>(Instr)) { ... }
 255 /// @brief Base class of casting instructions.
 256 class CastInst : public UnaryInstruction {
 257   /// @brief Copy constructor
 258   CastInst(const CastInst &CI)
 259     : UnaryInstruction(CI.getType(), CI.getOpcode(), CI.getOperand(0)) {
 260   }
 261   /// @brief Do not allow default construction
 262   CastInst();
 263 protected:
 264   /// @brief Constructor with insert-before-instruction semantics for subclasses
 265   CastInst(const Type *Ty, unsigned iType, Value *S,
 266       const std::string &Name = "", Instruction *InsertBefore = 0)
 267     : UnaryInstruction(Ty, iType, S, Name, InsertBefore) {
 268   }
 269   /// @brief Constructor with insert-at-end-of-block semantics for subclasses
 270   CastInst(const Type *Ty, unsigned iType, Value *S,
 271       const std::string &Name, BasicBlock *InsertAtEnd)
 272     : UnaryInstruction(Ty, iType, S, Name, InsertAtEnd) {
 273   }
 274 public:
 275   /// Provides a way to construct any of the CastInst subclasses using an
 276   /// opcode instead of the subclass's constructor. The opcode must be in the
 277   /// CastOps category (Instruction::isCast(opcode) returns true). This
 278   /// constructor has insert-before-instruction semantics to automatically
 279   /// insert the new CastInst before InsertBefore (if it is non-null).
 280   /// @brief Construct any of the CastInst subclasses
 281   static CastInst *create(
 282     Instruction::CastOps,    ///< The opcode of the cast instruction
 283     Value *S,                ///< The value to be casted (operand 0)
 284     const Type *Ty,          ///< The type to which cast should be made
 285     const std::string &Name = "", ///< Name for the instruction
 286     Instruction *InsertBefore = 0 ///< Place to insert the instruction
 287   );
 288   /// Provides a way to construct any of the CastInst subclasses using an
 289   /// opcode instead of the subclass's constructor. The opcode must be in the
 290   /// CastOps category. This constructor has insert-at-end-of-block semantics
 291   /// to automatically insert the new CastInst at the end of InsertAtEnd (if
 292   /// its non-null).
 293   /// @brief Construct any of the CastInst subclasses
 294   static CastInst *create(
 295     Instruction::CastOps,    ///< The opcode for the cast instruction
 296     Value *S,                ///< The value to be casted (operand 0)
 297     const Type *Ty,          ///< The type to which operand is casted
 298     const std::string &Name, ///< The name for the instruction
 299     BasicBlock *InsertAtEnd  ///< The block to insert the instruction into
 300   );
 301
 302   /// @brief Create a ZExt or BitCast cast instruction
 303   static CastInst *createZExtOrBitCast(
 304     Value *S,                ///< The value to be casted (operand 0)
 305     const Type *Ty,          ///< The type to which cast should be made
 306     const std::string &Name = "", ///< Name for the instruction
 307     Instruction *InsertBefore = 0 ///< Place to insert the instruction
 308   );
 309
 310   /// @brief Create a ZExt or BitCast cast instruction
 311   static CastInst *createZExtOrBitCast(
 312     Value *S,                ///< The value to be casted (operand 0)
 313     const Type *Ty,          ///< The type to which operand is casted
 314     const std::string &Name, ///< The name for the instruction
 315     BasicBlock *InsertAtEnd  ///< The block to insert the instruction into
 316   );
 317
 318   /// @brief Create a SExt or BitCast cast instruction
 319   static CastInst *createSExtOrBitCast(
 320     Value *S,                ///< The value to be casted (operand 0)
 321     const Type *Ty,          ///< The type to which cast should be made
 322     const std::string &Name = "", ///< Name for the instruction
 323     Instruction *InsertBefore = 0 ///< Place to insert the instruction
 324   );
 325
 326   /// @brief Create a BitCast or a PtrToInt cast instruction
 327   static CastInst *createPointerCast(
 328     Value *S,                ///< The pointer value to be casted (operand 0)
 329     const Type *Ty,          ///< The type to which operand is casted
 330     const std::string &Name, ///< The name for the instruction
 331     BasicBlock *InsertAtEnd  ///< The block to insert the instruction into
 332   );
 333
 334   /// @brief Create a BitCast or a PtrToInt cast instruction
 335   static CastInst *createPointerCast(
 336     Value *S,                ///< The pointer value to be casted (operand 0)
 337     const Type *Ty,          ///< The type to which cast should be made
 338     const std::string &Name = "", ///< Name for the instruction
 339     Instruction *InsertBefore = 0 ///< Place to insert the instruction
 340   );
 341
 342   /// @brief Create a ZExt, BitCast, or Trunc for int -> int casts.
 343   static CastInst *createIntegerCast(
 344     Value *S,                ///< The pointer value to be casted (operand 0)
 345     const Type *Ty,          ///< The type to which cast should be made
 346     bool isSigned,           ///< Whether to regard S as signed or not
 347     const std::string &Name = "", ///< Name for the instruction
 348     Instruction *InsertBefore = 0 ///< Place to insert the instruction
 349   );
 350
 351   /// @brief Create a ZExt, BitCast, or Trunc for int -> int casts.
 352   static CastInst *createIntegerCast(
 353     Value *S,                ///< The integer value to be casted (operand 0)
 354     const Type *Ty,          ///< The integer type to which operand is casted
 355     bool isSigned,           ///< Whether to regard S as signed or not
 356     const std::string &Name, ///< The name for the instruction
 357     BasicBlock *InsertAtEnd  ///< The block to insert the instruction into
 358   );
 359
 360   /// @brief Create an FPExt, BitCast, or FPTrunc for fp -> fp casts
 361   static CastInst *createFPCast(
 362     Value *S,                ///< The floating point value to be casted
 363     const Type *Ty,          ///< The floating point type to cast to
 364     const std::string &Name = "", ///< Name for the instruction
 365     Instruction *InsertBefore = 0 ///< Place to insert the instruction
 366   );
 367
 368   /// @brief Create an FPExt, BitCast, or FPTrunc for fp -> fp casts
 369   static CastInst *createFPCast(
 370     Value *S,                ///< The floating point value to be casted
 371     const Type *Ty,          ///< The floating point type to cast to
 372     const std::string &Name, ///< The name for the instruction
 373     BasicBlock *InsertAtEnd  ///< The block to insert the instruction into
 374   );
 375
 376   /// @brief Create a SExt or BitCast cast instruction
 377   static CastInst *createSExtOrBitCast(
 378     Value *S,                ///< The value to be casted (operand 0)
 379     const Type *Ty,          ///< The type to which operand is casted
 380     const std::string &Name, ///< The name for the instruction
 381     BasicBlock *InsertAtEnd  ///< The block to insert the instruction into
 382   );
 383
 384   /// @brief Create a Trunc or BitCast cast instruction
 385   static CastInst *createTruncOrBitCast(
 386     Value *S,                ///< The value to be casted (operand 0)
 387     const Type *Ty,          ///< The type to which cast should be made
 388     const std::string &Name = "", ///< Name for the instruction
 389     Instruction *InsertBefore = 0 ///< Place to insert the instruction
 390   );
 391
 392   /// @brief Create a Trunc or BitCast cast instruction
 393   static CastInst *createTruncOrBitCast(
 394     Value *S,                ///< The value to be casted (operand 0)
 395     const Type *Ty,          ///< The type to which operand is casted
 396     const std::string &Name, ///< The name for the instruction
 397     BasicBlock *InsertAtEnd  ///< The block to insert the instruction into
 398   );
 399
 400   /// Returns the opcode necessary to cast Val into Ty using usual casting
 401   /// rules.
 402   static Instruction::CastOps getCastOpcode(
 403     const Value *Val, ///< The value to cast
 404     bool SrcIsSigned, ///< Whether to treat the source as signed
 405     const Type *Ty,   ///< The Type to which the value should be casted
 406     bool DstIsSigned  ///< Whether to treate the dest. as signed
 407   );
 408
 409   /// Joins the create method (with insert-before-instruction semantics) above
 410   /// with the getCastOpcode method. getOpcode(S,Ty) is called first to
 411   /// obtain the opcode for casting S to type Ty. Then the get(...) method is
 412   /// called to create the CastInst and insert it. The instruction is
 413   /// inserted before InsertBefore (if it is non-null). The cast created is
 414   /// inferred, because only the types involved are used in determining which
 415   /// cast opcode to use. For specific casts, use one of the create methods.
 416   /// @brief Inline helper method to join create with getCastOpcode.
 417   inline static CastInst *createInferredCast(
 418     Value *S,                     ///< The value to be casted (operand 0)
 419     bool SrcIsSigned,             ///< Whether to treat the source as signed
 420     const Type *Ty,               ///< Type to which operand should be casted
 421     bool DstIsSigned,             ///< Whether to treate the dest. as signed
 422     const std::string &Name = "", ///< Name for the instruction
 423     Instruction *InsertBefore = 0 ///< Place to insert the CastInst
 424   ) {
 425     return create(getCastOpcode(S, SrcIsSigned, Ty, DstIsSigned),
 426                   S, Ty, Name, InsertBefore);
 427   }
 428   static CastInst *createInferredCast(
 429     Value *S,                     ///< The value to be casted (operand 0)
 430     const Type *Ty,               ///< Type to which operand should be casted
 431     const std::string &Name = "", ///< Name for the instruction
 432     Instruction *InsertBefore = 0 ///< Place to insert the CastInst
 433   );
 434
 435   /// Joins the get method (with insert-at-end-of-block semantics) method
 436   /// above with the getCastOpcode method. getOpcode(S,Ty) is called first to
 437   /// obtain the usual casting opcode for casting S to type Ty. Then the
 438   /// get(...) method is called to create the CastInst and insert it. The
 439   /// instruction is inserted at the end of InsertAtEnd (if it is non-null).
 440   /// The created cast is inferred, because only the types involved are used
 441   /// in determining which cast opcode to use. For specific casts, use one of
 442   /// the create methods.
 443   /// @brief Inline helper method to join create with getCastOpcode.
 444   inline static CastInst *createInferredCast(
 445     Value *S,                     ///< The value to be casted (operand 0)
 446     bool SrcIsSigned,             ///< Whether to treat the source as signed
 447     const Type *Ty,               ///< Type to which operand should be casted
 448     bool DstIsSigned,             ///< Whether to treate the dest. as signed
 449     const std::string &Name,      ///< Name for the instruction
 450     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
 451   ) {
 452     return create(getCastOpcode(S, SrcIsSigned, Ty, DstIsSigned),
 453                   S, Ty, Name, InsertAtEnd);
 454   }
 455
 456   static CastInst *createInferredCast(
 457     Value *S,                     ///< The value to be casted (operand 0)
 458     const Type *Ty,               ///< Type to which operand should be casted
 459     const std::string &Name,      ///< Name for the instruction
 460     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
 461   );
 462
 463   /// There are several places where we need to know if a cast instruction
 464   /// only deals with integer source and destination types. To simplify that
 465   /// logic, this method is provided.
 466   /// @returns true iff the cast has only integral typed operand and dest type.
 467   /// @brief Determine if this is an integer-only cast.
 468   bool isIntegerCast() const;
 469
 470   /// A lossless cast is one that does not alter the basic value. It implies
 471   /// a no-op cast but is more stringent, preventing things like int->float,
 472   /// long->double, int->ptr, or packed->anything.
 473   /// @returns true iff the cast is lossless.
 474   /// @brief Determine if this is a lossless cast.
 475   bool isLosslessCast() const;
 476
 477   /// A no-op cast is one that can be effected without changing any bits.
 478   /// It implies that the source and destination types are the same size. The
 479   /// IntPtrTy argument is used to make accurate determinations for casts
 480   /// involving Integer and Pointer types. They are no-op casts if the integer
 481   /// is the same size as the pointer. However, pointer size varies with
 482   /// platform. Generally, the result of TargetData::getIntPtrType() should be
 483   /// passed in. If that's not available, use Type::ULongTy, which will make
 484   /// the isNoopCast call conservative.
 485   /// @brief Determine if this cast is a no-op cast.
 486   bool isNoopCast(
 487     const Type *IntPtrTy ///< Integer type corresponding to pointer
 488   ) const;
 489
 490   /// Determine how a pair of casts can be eliminated, if they can be at all.
 491   /// This is a helper function for both CastInst and ConstantExpr.
 492   /// @returns 0 if the CastInst pair can't be eliminated
 493   /// @returns Instruction::CastOps value for a cast that can replace
 494   /// the pair, casting SrcTy to DstTy.
 495   /// @brief Determine if a cast pair is eliminable
 496   static unsigned isEliminableCastPair(
 497     Instruction::CastOps firstOpcode,  ///< Opcode of first cast
 498     Instruction::CastOps secondOpcode, ///< Opcode of second cast
 499     const Type *SrcTy, ///< SrcTy of 1st cast
 500     const Type *MidTy, ///< DstTy of 1st cast & SrcTy of 2nd cast
 501     const Type *DstTy, ///< DstTy of 2nd cast
 502     const Type *IntPtrTy ///< Integer type corresponding to Ptr types
 503   );
 504
 505   /// @brief Return the opcode of this CastInst
 506   Instruction::CastOps getOpcode() const {
 507     return Instruction::CastOps(Instruction::getOpcode());
 508   }
 509
 510   /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
 511   static inline bool classof(const CastInst *) { return true; }
 512   static inline bool classof(const Instruction *I) {
 513     return I->getOpcode() >= CastOpsBegin && I->getOpcode() < CastOpsEnd;
 514   }
 515   static inline bool classof(const Value *V) {
 516     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 517   }
 518 };
 519
 520 //===----------------------------------------------------------------------===//
 521 //                               CmpInst Class
 522 //===----------------------------------------------------------------------===//
 523
 524 /// This class is the base class for the comparison instructions.
 525 /// @brief Abstract base class of comparison instructions.
 526 class CmpInst: public Instruction {
 527   CmpInst(); // do not implement
 528 protected:
 529   CmpInst(Instruction::OtherOps op, unsigned short pred, Value *LHS, Value *RHS,
 530           const std::string &Name = "", Instruction *InsertBefore = 0);
 531
 532   CmpInst(Instruction::OtherOps op, unsigned short pred, Value *LHS, Value *RHS,
 533           const std::string &Name, BasicBlock *InsertAtEnd);
 534
 535   Use Ops[2]; // CmpInst instructions always have 2 operands, optimize
 536
 537 public:
 538   /// Construct a compare instruction, given the opcode, the predicate and
 539   /// the two operands.  Optionally (if InstBefore is specified) insert the
 540   /// instruction into a BasicBlock right before the specified instruction.
 541   /// The specified Instruction is allowed to be a dereferenced end iterator.
 542   /// @brief Create a CmpInst
 543   static CmpInst *create(OtherOps Op, unsigned short predicate, Value *S1,
 544                          Value *S2, const std::string &Name = "",
 545                          Instruction *InsertBefore = 0);
 546
 547   /// Construct a compare instruction, given the opcode, the predicate and the
 548   /// two operands.  Also automatically insert this instruction to the end of
 549   /// the BasicBlock specified.
 550   /// @brief Create a CmpInst
 551   static CmpInst *create(OtherOps Op, unsigned short predicate, Value *S1,
 552                          Value *S2, const std::string &Name,
 553                          BasicBlock *InsertAtEnd);
 554
 555   /// @brief Implement superclass method.
 556   virtual CmpInst *clone() const;
 557
 558   /// @brief Get the opcode casted to the right type
 559   OtherOps getOpcode() const {
 560     return static_cast<OtherOps>(Instruction::getOpcode());
 561   }
 562
 563   /// The predicate for CmpInst is defined by the subclasses but stored in
 564   /// the SubclassData field (see Value.h).  We allow it to be fetched here
 565   /// as the predicate but there is no enum type for it, just the raw unsigned
 566   /// short. This facilitates comparison of CmpInst instances without delving
 567   /// into the subclasses since predicate values are distinct between the
 568   /// CmpInst subclasses.
 569   /// @brief Return the predicate for this instruction.
 570   unsigned short getPredicate() const {
 571     return SubclassData;
 572   }
 573
 574   /// @brief Provide more efficient getOperand methods.
 575   Value *getOperand(unsigned i) const {
 576     assert(i < 2 && "getOperand() out of range!");
 577     return Ops[i];
 578   }
 579   void setOperand(unsigned i, Value *Val) {
 580     assert(i < 2 && "setOperand() out of range!");
 581     Ops[i] = Val;
 582   }
 583
 584   /// @brief CmpInst instructions always have 2 operands.
 585   unsigned getNumOperands() const { return 2; }
 586
 587   /// This is just a convenience that dispatches to the subclasses.
 588   /// @brief Swap the operands.
 589   void swapOperands();
 590
 591   /// This is just a convenience that dispatches to the subclasses.
 592   /// @brief Determine if this CmpInst is commutative.
 593   bool isCommutative();
 594
 595   /// This is just a convenience that dispatches to the subclasses.
 596   /// @brief Determine if this is an equals/not equals predicate.
 597   bool isEquality();
 598
 599   /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
 600   static inline bool classof(const CmpInst *) { return true; }
 601   static inline bool classof(const Instruction *I) {
 602     return I->getOpcode() == Instruction::ICmp ||
 603            I->getOpcode() == Instruction::FCmp;
 604   }
 605   static inline bool classof(const Value *V) {
 606     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 607   }
 608 };
 609
 610 } // End llvm namespace
 611
 612 #endif