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 SExt or BitCast cast instruction
 343   static CastInst *createSExtOrBitCast(
 344     Value *S,                ///< The value to be casted (operand 0)
 345     const Type *Ty,          ///< The type to which operand is casted
 346     const std::string &Name, ///< The name for the instruction
 347     BasicBlock *InsertAtEnd  ///< The block to insert the instruction into
 348   );
 349
 350   /// @brief Create a Trunc or BitCast cast instruction
 351   static CastInst *createTruncOrBitCast(
 352     Value *S,                ///< The value to be casted (operand 0)
 353     const Type *Ty,          ///< The type to which cast should be made
 354     const std::string &Name = "", ///< Name for the instruction
 355     Instruction *InsertBefore = 0 ///< Place to insert the instruction
 356   );
 357
 358   /// @brief Create a Trunc or BitCast cast instruction
 359   static CastInst *createTruncOrBitCast(
 360     Value *S,                ///< The value to be casted (operand 0)
 361     const Type *Ty,          ///< The type to which operand is casted
 362     const std::string &Name, ///< The name for the instruction
 363     BasicBlock *InsertAtEnd  ///< The block to insert the instruction into
 364   );
 365
 366   /// Returns the opcode necessary to cast Val into Ty using usual casting
 367   /// rules.
 368   static Instruction::CastOps getCastOpcode(
 369     const Value *Val, ///< The value to cast
 370     bool SrcIsSigned, ///< Whether to treat the source as signed
 371     const Type *Ty,   ///< The Type to which the value should be casted
 372     bool DstIsSigned  ///< Whether to treate the dest. as signed
 373   );
 374
 375   /// Joins the create method (with insert-before-instruction semantics) above
 376   /// with the getCastOpcode method. getOpcode(S,Ty) is called first to
 377   /// obtain the opcode for casting S to type Ty. Then the get(...) method is
 378   /// called to create the CastInst and insert it. The instruction is
 379   /// inserted before InsertBefore (if it is non-null). The cast created is
 380   /// inferred, because only the types involved are used in determining which
 381   /// cast opcode to use. For specific casts, use one of the create methods.
 382   /// @brief Inline helper method to join create with getCastOpcode.
 383   inline static CastInst *createInferredCast(
 384     Value *S,                     ///< The value to be casted (operand 0)
 385     bool SrcIsSigned,             ///< Whether to treat the source as signed
 386     const Type *Ty,               ///< Type to which operand should be casted
 387     bool DstIsSigned,             ///< Whether to treate the dest. as signed
 388     const std::string &Name = "", ///< Name for the instruction
 389     Instruction *InsertBefore = 0 ///< Place to insert the CastInst
 390   ) {
 391     return create(getCastOpcode(S, SrcIsSigned, Ty, DstIsSigned),
 392                   S, Ty, Name, InsertBefore);
 393   }
 394   static CastInst *createInferredCast(
 395     Value *S,                     ///< The value to be casted (operand 0)
 396     const Type *Ty,               ///< Type to which operand should be casted
 397     const std::string &Name = "", ///< Name for the instruction
 398     Instruction *InsertBefore = 0 ///< Place to insert the CastInst
 399   );
 400
 401   /// Joins the get method (with insert-at-end-of-block semantics) method
 402   /// above with the getCastOpcode method. getOpcode(S,Ty) is called first to
 403   /// obtain the usual casting opcode for casting S to type Ty. Then the
 404   /// get(...) method is called to create the CastInst and insert it. The
 405   /// instruction is inserted at the end of InsertAtEnd (if it is non-null).
 406   /// The created cast is inferred, because only the types involved are used
 407   /// in determining which cast opcode to use. For specific casts, use one of
 408   /// the create methods.
 409   /// @brief Inline helper method to join create with getCastOpcode.
 410   inline static CastInst *createInferredCast(
 411     Value *S,                     ///< The value to be casted (operand 0)
 412     bool SrcIsSigned,             ///< Whether to treat the source as signed
 413     const Type *Ty,               ///< Type to which operand should be casted
 414     bool DstIsSigned,             ///< Whether to treate the dest. as signed
 415     const std::string &Name,      ///< Name for the instruction
 416     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
 417   ) {
 418     return create(getCastOpcode(S, SrcIsSigned, Ty, DstIsSigned),
 419                   S, Ty, Name, InsertAtEnd);
 420   }
 421
 422   static CastInst *createInferredCast(
 423     Value *S,                     ///< The value to be casted (operand 0)
 424     const Type *Ty,               ///< Type to which operand should be casted
 425     const std::string &Name,      ///< Name for the instruction
 426     BasicBlock *InsertAtEnd       ///< The block to insert the instruction into
 427   );
 428
 429   /// There are several places where we need to know if a cast instruction
 430   /// only deals with integer source and destination types. To simplify that
 431   /// logic, this method is provided.
 432   /// @returns true iff the cast has only integral typed operand and dest type.
 433   /// @brief Determine if this is an integer-only cast.
 434   bool isIntegerCast() const;
 435
 436   /// A lossless cast is one that does not alter the basic value. It implies
 437   /// a no-op cast but is more stringent, preventing things like int->float,
 438   /// long->double, int->ptr, or packed->anything.
 439   /// @returns true iff the cast is lossless.
 440   /// @brief Determine if this is a lossless cast.
 441   bool isLosslessCast() const;
 442
 443   /// A no-op cast is one that can be effected without changing any bits.
 444   /// It implies that the source and destination types are the same size. The
 445   /// IntPtrTy argument is used to make accurate determinations for casts
 446   /// involving Integer and Pointer types. They are no-op casts if the integer
 447   /// is the same size as the pointer. However, pointer size varies with
 448   /// platform. Generally, the result of TargetData::getIntPtrType() should be
 449   /// passed in. If that's not available, use Type::ULongTy, which will make
 450   /// the isNoopCast call conservative.
 451   /// @brief Determine if this cast is a no-op cast.
 452   bool isNoopCast(
 453     const Type *IntPtrTy ///< Integer type corresponding to pointer
 454   ) const;
 455
 456   /// Determine how a pair of casts can be eliminated, if they can be at all.
 457   /// This is a helper function for both CastInst and ConstantExpr.
 458   /// @returns 0 if the CastInst pair can't be eliminated
 459   /// @returns Instruction::CastOps value for a cast that can replace
 460   /// the pair, casting SrcTy to DstTy.
 461   /// @brief Determine if a cast pair is eliminable
 462   static unsigned isEliminableCastPair(
 463     Instruction::CastOps firstOpcode,  ///< Opcode of first cast
 464     Instruction::CastOps secondOpcode, ///< Opcode of second cast
 465     const Type *SrcTy, ///< SrcTy of 1st cast
 466     const Type *MidTy, ///< DstTy of 1st cast & SrcTy of 2nd cast
 467     const Type *DstTy, ///< DstTy of 2nd cast
 468     const Type *IntPtrTy ///< Integer type corresponding to Ptr types
 469   );
 470
 471   /// @brief Return the opcode of this CastInst
 472   Instruction::CastOps getOpcode() const {
 473     return Instruction::CastOps(Instruction::getOpcode());
 474   }
 475
 476   /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
 477   static inline bool classof(const CastInst *) { return true; }
 478   static inline bool classof(const Instruction *I) {
 479     return I->getOpcode() >= CastOpsBegin && I->getOpcode() < CastOpsEnd;
 480   }
 481   static inline bool classof(const Value *V) {
 482     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 483   }
 484 };
 485
 486 //===----------------------------------------------------------------------===//
 487 //                               CmpInst Class
 488 //===----------------------------------------------------------------------===//
 489
 490 /// This class is the base class for the comparison instructions.
 491 /// @brief Abstract base class of comparison instructions.
 492 class CmpInst: public Instruction {
 493   CmpInst(); // do not implement
 494 protected:
 495   CmpInst(Instruction::OtherOps op, unsigned short pred, Value *LHS, Value *RHS,
 496           const std::string &Name = "", Instruction *InsertBefore = 0);
 497
 498   CmpInst(Instruction::OtherOps op, unsigned short pred, Value *LHS, Value *RHS,
 499           const std::string &Name, BasicBlock *InsertAtEnd);
 500
 501   Use Ops[2]; // CmpInst instructions always have 2 operands, optimize
 502
 503 public:
 504   /// Construct a compare instruction, given the opcode, the predicate and
 505   /// the two operands.  Optionally (if InstBefore is specified) insert the
 506   /// instruction into a BasicBlock right before the specified instruction.
 507   /// The specified Instruction is allowed to be a dereferenced end iterator.
 508   /// @brief Create a CmpInst
 509   static CmpInst *create(OtherOps Op, unsigned short predicate, Value *S1,
 510                          Value *S2, const std::string &Name = "",
 511                          Instruction *InsertBefore = 0);
 512
 513   /// Construct a compare instruction, given the opcode, the predicate and the
 514   /// two operands.  Also automatically insert this instruction to the end of
 515   /// the BasicBlock specified.
 516   /// @brief Create a CmpInst
 517   static CmpInst *create(OtherOps Op, unsigned short predicate, Value *S1,
 518                          Value *S2, const std::string &Name,
 519                          BasicBlock *InsertAtEnd);
 520
 521   /// @brief Implement superclass method.
 522   virtual CmpInst *clone() const;
 523
 524   /// @brief Get the opcode casted to the right type
 525   OtherOps getOpcode() const {
 526     return static_cast<OtherOps>(Instruction::getOpcode());
 527   }
 528
 529   /// The predicate for CmpInst is defined by the subclasses but stored in
 530   /// the SubclassData field (see Value.h).  We allow it to be fetched here
 531   /// as the predicate but there is no enum type for it, just the raw unsigned
 532   /// short. This facilitates comparison of CmpInst instances without delving
 533   /// into the subclasses since predicate values are distinct between the
 534   /// CmpInst subclasses.
 535   /// @brief Return the predicate for this instruction.
 536   unsigned short getPredicate() const {
 537     return SubclassData;
 538   }
 539
 540   /// @brief Provide more efficient getOperand methods.
 541   Value *getOperand(unsigned i) const {
 542     assert(i < 2 && "getOperand() out of range!");
 543     return Ops[i];
 544   }
 545   void setOperand(unsigned i, Value *Val) {
 546     assert(i < 2 && "setOperand() out of range!");
 547     Ops[i] = Val;
 548   }
 549
 550   /// @brief CmpInst instructions always have 2 operands.
 551   unsigned getNumOperands() const { return 2; }
 552
 553   /// This is just a convenience that dispatches to the subclasses.
 554   /// @brief Swap the operands.
 555   void swapOperands();
 556
 557   /// This is just a convenience that dispatches to the subclasses.
 558   /// @brief Determine if this CmpInst is commutative.
 559   bool isCommutative();
 560
 561   /// This is just a convenience that dispatches to the subclasses.
 562   /// @brief Determine if this is an equals/not equals predicate.
 563   bool isEquality();
 564
 565   /// @brief Methods for support type inquiry through isa, cast, and dyn_cast:
 566   static inline bool classof(const CmpInst *) { return true; }
 567   static inline bool classof(const Instruction *I) {
 568     return I->getOpcode() == Instruction::ICmp ||
 569            I->getOpcode() == Instruction::FCmp;
 570   }
 571   static inline bool classof(const Value *V) {
 572     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 573   }
 574 };
 575
 576 } // End llvm namespace
 577
 578 #endif