include/llvm/IR/Operator.h

   1 //===-- llvm/Operator.h - Operator utility subclass -------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines various classes for working with Instructions and
  11 // ConstantExprs.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_IR_OPERATOR_H
  16 #define LLVM_IR_OPERATOR_H
  17
  18 #include "llvm/IR/Constants.h"
  19 #include "llvm/IR/DataLayout.h"
  20 #include "llvm/IR/DerivedTypes.h"
  21 #include "llvm/IR/GetElementPtrTypeIterator.h"
  22 #include "llvm/IR/Instruction.h"
  23 #include "llvm/IR/Type.h"
  24
  25 namespace llvm {
  26
  27 class GetElementPtrInst;
  28 class BinaryOperator;
  29 class ConstantExpr;
  30
  31 /// Operator - This is a utility class that provides an abstraction for the
  32 /// common functionality between Instructions and ConstantExprs.
  33 ///
  34 class Operator : public User {
  35 private:
  36   // The Operator class is intended to be used as a utility, and is never itself
  37   // instantiated.
  38   void *operator new(size_t, unsigned) LLVM_DELETED_FUNCTION;
  39   void *operator new(size_t s) LLVM_DELETED_FUNCTION;
  40   Operator() LLVM_DELETED_FUNCTION;
  41
  42 protected:
  43   // NOTE: Cannot use LLVM_DELETED_FUNCTION because it's not legal to delete
  44   // an overridden method that's not deleted in the base class. Cannot leave
  45   // this unimplemented because that leads to an ODR-violation.
  46   ~Operator();
  47
  48 public:
  49   /// getOpcode - Return the opcode for this Instruction or ConstantExpr.
  50   ///
  51   unsigned getOpcode() const {
  52     if (const Instruction *I = dyn_cast<Instruction>(this))
  53       return I->getOpcode();
  54     return cast<ConstantExpr>(this)->getOpcode();
  55   }
  56
  57   /// getOpcode - If V is an Instruction or ConstantExpr, return its
  58   /// opcode. Otherwise return UserOp1.
  59   ///
  60   static unsigned getOpcode(const Value *V) {
  61     if (const Instruction *I = dyn_cast<Instruction>(V))
  62       return I->getOpcode();
  63     if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
  64       return CE->getOpcode();
  65     return Instruction::UserOp1;
  66   }
  67
  68   static inline bool classof(const Instruction *) { return true; }
  69   static inline bool classof(const ConstantExpr *) { return true; }
  70   static inline bool classof(const Value *V) {
  71     return isa<Instruction>(V) || isa<ConstantExpr>(V);
  72   }
  73 };
  74
  75 /// OverflowingBinaryOperator - Utility class for integer arithmetic operators
  76 /// which may exhibit overflow - Add, Sub, and Mul. It does not include SDiv,
  77 /// despite that operator having the potential for overflow.
  78 ///
  79 class OverflowingBinaryOperator : public Operator {
  80 public:
  81   enum {
  82     NoUnsignedWrap = (1 << 0),
  83     NoSignedWrap   = (1 << 1)
  84   };
  85
  86 private:
  87   friend class BinaryOperator;
  88   friend class ConstantExpr;
  89   void setHasNoUnsignedWrap(bool B) {
  90     SubclassOptionalData =
  91       (SubclassOptionalData & ~NoUnsignedWrap) | (B * NoUnsignedWrap);
  92   }
  93   void setHasNoSignedWrap(bool B) {
  94     SubclassOptionalData =
  95       (SubclassOptionalData & ~NoSignedWrap) | (B * NoSignedWrap);
  96   }
  97
  98 public:
  99   /// hasNoUnsignedWrap - Test whether this operation is known to never
 100   /// undergo unsigned overflow, aka the nuw property.
 101   bool hasNoUnsignedWrap() const {
 102     return SubclassOptionalData & NoUnsignedWrap;
 103   }
 104
 105   /// hasNoSignedWrap - Test whether this operation is known to never
 106   /// undergo signed overflow, aka the nsw property.
 107   bool hasNoSignedWrap() const {
 108     return (SubclassOptionalData & NoSignedWrap) != 0;
 109   }
 110
 111   static inline bool classof(const Instruction *I) {
 112     return I->getOpcode() == Instruction::Add ||
 113            I->getOpcode() == Instruction::Sub ||
 114            I->getOpcode() == Instruction::Mul ||
 115            I->getOpcode() == Instruction::Shl;
 116   }
 117   static inline bool classof(const ConstantExpr *CE) {
 118     return CE->getOpcode() == Instruction::Add ||
 119            CE->getOpcode() == Instruction::Sub ||
 120            CE->getOpcode() == Instruction::Mul ||
 121            CE->getOpcode() == Instruction::Shl;
 122   }
 123   static inline bool classof(const Value *V) {
 124     return (isa<Instruction>(V) && classof(cast<Instruction>(V))) ||
 125            (isa<ConstantExpr>(V) && classof(cast<ConstantExpr>(V)));
 126   }
 127 };
 128
 129 /// PossiblyExactOperator - A udiv or sdiv instruction, which can be marked as
 130 /// "exact", indicating that no bits are destroyed.
 131 class PossiblyExactOperator : public Operator {
 132 public:
 133   enum {
 134     IsExact = (1 << 0)
 135   };
 136
 137 private:
 138   friend class BinaryOperator;
 139   friend class ConstantExpr;
 140   void setIsExact(bool B) {
 141     SubclassOptionalData = (SubclassOptionalData & ~IsExact) | (B * IsExact);
 142   }
 143
 144 public:
 145   /// isExact - Test whether this division is known to be exact, with
 146   /// zero remainder.
 147   bool isExact() const {
 148     return SubclassOptionalData & IsExact;
 149   }
 150
 151   static bool isPossiblyExactOpcode(unsigned OpC) {
 152     return OpC == Instruction::SDiv ||
 153            OpC == Instruction::UDiv ||
 154            OpC == Instruction::AShr ||
 155            OpC == Instruction::LShr;
 156   }
 157   static inline bool classof(const ConstantExpr *CE) {
 158     return isPossiblyExactOpcode(CE->getOpcode());
 159   }
 160   static inline bool classof(const Instruction *I) {
 161     return isPossiblyExactOpcode(I->getOpcode());
 162   }
 163   static inline bool classof(const Value *V) {
 164     return (isa<Instruction>(V) && classof(cast<Instruction>(V))) ||
 165            (isa<ConstantExpr>(V) && classof(cast<ConstantExpr>(V)));
 166   }
 167 };
 168
 169 /// Convenience struct for specifying and reasoning about fast-math flags.
 170 class FastMathFlags {
 171 private:
 172   friend class FPMathOperator;
 173   unsigned Flags;
 174   FastMathFlags(unsigned F) : Flags(F) { }
 175
 176 public:
 177   enum {
 178     UnsafeAlgebra   = (1 << 0),
 179     NoNaNs          = (1 << 1),
 180     NoInfs          = (1 << 2),
 181     NoSignedZeros   = (1 << 3),
 182     AllowReciprocal = (1 << 4)
 183   };
 184
 185   FastMathFlags() : Flags(0)
 186   { }
 187
 188   /// Whether any flag is set
 189   bool any() { return Flags != 0; }
 190
 191   /// Set all the flags to false
 192   void clear() { Flags = 0; }
 193
 194   /// Flag queries
 195   bool noNaNs()          { return 0 != (Flags & NoNaNs); }
 196   bool noInfs()          { return 0 != (Flags & NoInfs); }
 197   bool noSignedZeros()   { return 0 != (Flags & NoSignedZeros); }
 198   bool allowReciprocal() { return 0 != (Flags & AllowReciprocal); }
 199   bool unsafeAlgebra()   { return 0 != (Flags & UnsafeAlgebra); }
 200
 201   /// Flag setters
 202   void setNoNaNs()          { Flags |= NoNaNs; }
 203   void setNoInfs()          { Flags |= NoInfs; }
 204   void setNoSignedZeros()   { Flags |= NoSignedZeros; }
 205   void setAllowReciprocal() { Flags |= AllowReciprocal; }
 206   void setUnsafeAlgebra() {
 207     Flags |= UnsafeAlgebra;
 208     setNoNaNs();
 209     setNoInfs();
 210     setNoSignedZeros();
 211     setAllowReciprocal();
 212   }
 213
 214   void operator&=(const FastMathFlags &OtherFlags) {
 215     Flags &= OtherFlags.Flags;
 216   }
 217 };
 218
 219
 220 /// FPMathOperator - Utility class for floating point operations which can have
 221 /// information about relaxed accuracy requirements attached to them.
 222 class FPMathOperator : public Operator {
 223 private:
 224   friend class Instruction;
 225
 226   void setHasUnsafeAlgebra(bool B) {
 227     SubclassOptionalData =
 228       (SubclassOptionalData & ~FastMathFlags::UnsafeAlgebra) |
 229       (B * FastMathFlags::UnsafeAlgebra);
 230
 231     // Unsafe algebra implies all the others
 232     if (B) {
 233       setHasNoNaNs(true);
 234       setHasNoInfs(true);
 235       setHasNoSignedZeros(true);
 236       setHasAllowReciprocal(true);
 237     }
 238   }
 239   void setHasNoNaNs(bool B) {
 240     SubclassOptionalData =
 241       (SubclassOptionalData & ~FastMathFlags::NoNaNs) |
 242       (B * FastMathFlags::NoNaNs);
 243   }
 244   void setHasNoInfs(bool B) {
 245     SubclassOptionalData =
 246       (SubclassOptionalData & ~FastMathFlags::NoInfs) |
 247       (B * FastMathFlags::NoInfs);
 248   }
 249   void setHasNoSignedZeros(bool B) {
 250     SubclassOptionalData =
 251       (SubclassOptionalData & ~FastMathFlags::NoSignedZeros) |
 252       (B * FastMathFlags::NoSignedZeros);
 253   }
 254   void setHasAllowReciprocal(bool B) {
 255     SubclassOptionalData =
 256       (SubclassOptionalData & ~FastMathFlags::AllowReciprocal) |
 257       (B * FastMathFlags::AllowReciprocal);
 258   }
 259
 260   /// Convenience function for setting multiple fast-math flags.
 261   /// FMF is a mask of the bits to set.
 262   void setFastMathFlags(FastMathFlags FMF) {
 263     SubclassOptionalData |= FMF.Flags;
 264   }
 265
 266   /// Convenience function for copying all fast-math flags.
 267   /// All values in FMF are transferred to this operator.
 268   void copyFastMathFlags(FastMathFlags FMF) {
 269     SubclassOptionalData = FMF.Flags;
 270   }
 271
 272 public:
 273   /// Test whether this operation is permitted to be
 274   /// algebraically transformed, aka the 'A' fast-math property.
 275   bool hasUnsafeAlgebra() const {
 276     return (SubclassOptionalData & FastMathFlags::UnsafeAlgebra) != 0;
 277   }
 278
 279   /// Test whether this operation's arguments and results are to be
 280   /// treated as non-NaN, aka the 'N' fast-math property.
 281   bool hasNoNaNs() const {
 282     return (SubclassOptionalData & FastMathFlags::NoNaNs) != 0;
 283   }
 284
 285   /// Test whether this operation's arguments and results are to be
 286   /// treated as NoN-Inf, aka the 'I' fast-math property.
 287   bool hasNoInfs() const {
 288     return (SubclassOptionalData & FastMathFlags::NoInfs) != 0;
 289   }
 290
 291   /// Test whether this operation can treat the sign of zero
 292   /// as insignificant, aka the 'S' fast-math property.
 293   bool hasNoSignedZeros() const {
 294     return (SubclassOptionalData & FastMathFlags::NoSignedZeros) != 0;
 295   }
 296
 297   /// Test whether this operation is permitted to use
 298   /// reciprocal instead of division, aka the 'R' fast-math property.
 299   bool hasAllowReciprocal() const {
 300     return (SubclassOptionalData & FastMathFlags::AllowReciprocal) != 0;
 301   }
 302
 303   /// Convenience function for getting all the fast-math flags
 304   FastMathFlags getFastMathFlags() const {
 305     return FastMathFlags(SubclassOptionalData);
 306   }
 307
 308   /// \brief Get the maximum error permitted by this operation in ULPs.  An
 309   /// accuracy of 0.0 means that the operation should be performed with the
 310   /// default precision.
 311   float getFPAccuracy() const;
 312
 313   static inline bool classof(const Instruction *I) {
 314     return I->getType()->isFPOrFPVectorTy();
 315   }
 316   static inline bool classof(const Value *V) {
 317     return isa<Instruction>(V) && classof(cast<Instruction>(V));
 318   }
 319 };
 320
 321
 322 /// ConcreteOperator - A helper template for defining operators for individual
 323 /// opcodes.
 324 template<typename SuperClass, unsigned Opc>
 325 class ConcreteOperator : public SuperClass {
 326 public:
 327   static inline bool classof(const Instruction *I) {
 328     return I->getOpcode() == Opc;
 329   }
 330   static inline bool classof(const ConstantExpr *CE) {
 331     return CE->getOpcode() == Opc;
 332   }
 333   static inline bool classof(const Value *V) {
 334     return (isa<Instruction>(V) && classof(cast<Instruction>(V))) ||
 335            (isa<ConstantExpr>(V) && classof(cast<ConstantExpr>(V)));
 336   }
 337 };
 338
 339 class AddOperator
 340   : public ConcreteOperator<OverflowingBinaryOperator, Instruction::Add> {
 341 };
 342 class SubOperator
 343   : public ConcreteOperator<OverflowingBinaryOperator, Instruction::Sub> {
 344 };
 345 class MulOperator
 346   : public ConcreteOperator<OverflowingBinaryOperator, Instruction::Mul> {
 347 };
 348 class ShlOperator
 349   : public ConcreteOperator<OverflowingBinaryOperator, Instruction::Shl> {
 350 };
 351
 352
 353 class SDivOperator
 354   : public ConcreteOperator<PossiblyExactOperator, Instruction::SDiv> {
 355 };
 356 class UDivOperator
 357   : public ConcreteOperator<PossiblyExactOperator, Instruction::UDiv> {
 358 };
 359 class AShrOperator
 360   : public ConcreteOperator<PossiblyExactOperator, Instruction::AShr> {
 361 };
 362 class LShrOperator
 363   : public ConcreteOperator<PossiblyExactOperator, Instruction::LShr> {
 364 };
 365
 366
 367
 368 class GEPOperator
 369   : public ConcreteOperator<Operator, Instruction::GetElementPtr> {
 370   enum {
 371     IsInBounds = (1 << 0)
 372   };
 373
 374   friend class GetElementPtrInst;
 375   friend class ConstantExpr;
 376   void setIsInBounds(bool B) {
 377     SubclassOptionalData =
 378       (SubclassOptionalData & ~IsInBounds) | (B * IsInBounds);
 379   }
 380
 381 public:
 382   /// isInBounds - Test whether this is an inbounds GEP, as defined
 383   /// by LangRef.html.
 384   bool isInBounds() const {
 385     return SubclassOptionalData & IsInBounds;
 386   }
 387
 388   inline op_iterator       idx_begin()       { return op_begin()+1; }
 389   inline const_op_iterator idx_begin() const { return op_begin()+1; }
 390   inline op_iterator       idx_end()         { return op_end(); }
 391   inline const_op_iterator idx_end()   const { return op_end(); }
 392
 393   Value *getPointerOperand() {
 394     return getOperand(0);
 395   }
 396   const Value *getPointerOperand() const {
 397     return getOperand(0);
 398   }
 399   static unsigned getPointerOperandIndex() {
 400     return 0U;                      // get index for modifying correct operand
 401   }
 402
 403   /// getPointerOperandType - Method to return the pointer operand as a
 404   /// PointerType.
 405   Type *getPointerOperandType() const {
 406     return getPointerOperand()->getType();
 407   }
 408
 409   /// getPointerAddressSpace - Method to return the address space of the
 410   /// pointer operand.
 411   unsigned getPointerAddressSpace() const {
 412     return getPointerOperandType()->getPointerAddressSpace();
 413   }
 414
 415   unsigned getNumIndices() const {  // Note: always non-negative
 416     return getNumOperands() - 1;
 417   }
 418
 419   bool hasIndices() const {
 420     return getNumOperands() > 1;
 421   }
 422
 423   /// hasAllZeroIndices - Return true if all of the indices of this GEP are
 424   /// zeros.  If so, the result pointer and the first operand have the same
 425   /// value, just potentially different types.
 426   bool hasAllZeroIndices() const {
 427     for (const_op_iterator I = idx_begin(), E = idx_end(); I != E; ++I) {
 428       if (ConstantInt *C = dyn_cast<ConstantInt>(I))
 429         if (C->isZero())
 430           continue;
 431       return false;
 432     }
 433     return true;
 434   }
 435
 436   /// hasAllConstantIndices - Return true if all of the indices of this GEP are
 437   /// constant integers.  If so, the result pointer and the first operand have
 438   /// a constant offset between them.
 439   bool hasAllConstantIndices() const {
 440     for (const_op_iterator I = idx_begin(), E = idx_end(); I != E; ++I) {
 441       if (!isa<ConstantInt>(I))
 442         return false;
 443     }
 444     return true;
 445   }
 446
 447   /// \brief Accumulate the constant address offset of this GEP if possible.
 448   ///
 449   /// This routine accepts an APInt into which it will accumulate the constant
 450   /// offset of this GEP if the GEP is in fact constant. If the GEP is not
 451   /// all-constant, it returns false and the value of the offset APInt is
 452   /// undefined (it is *not* preserved!). The APInt passed into this routine
 453   /// must be at exactly as wide as the IntPtr type for the address space of the
 454   /// base GEP pointer.
 455   bool accumulateConstantOffset(const DataLayout &DL, APInt &Offset) const {
 456     assert(Offset.getBitWidth() ==
 457            DL.getPointerSizeInBits(getPointerAddressSpace()) &&
 458            "The offset must have exactly as many bits as our pointer.");
 459
 460     for (gep_type_iterator GTI = gep_type_begin(this), GTE = gep_type_end(this);
 461          GTI != GTE; ++GTI) {
 462       ConstantInt *OpC = dyn_cast<ConstantInt>(GTI.getOperand());
 463       if (!OpC)
 464         return false;
 465       if (OpC->isZero())
 466         continue;
 467
 468       // Handle a struct index, which adds its field offset to the pointer.
 469       if (StructType *STy = dyn_cast<StructType>(*GTI)) {
 470         unsigned ElementIdx = OpC->getZExtValue();
 471         const StructLayout *SL = DL.getStructLayout(STy);
 472         Offset += APInt(Offset.getBitWidth(),
 473                         SL->getElementOffset(ElementIdx));
 474         continue;
 475       }
 476
 477       // For array or vector indices, scale the index by the size of the type.
 478       APInt Index = OpC->getValue().sextOrTrunc(Offset.getBitWidth());
 479       Offset += Index * APInt(Offset.getBitWidth(),
 480                               DL.getTypeAllocSize(GTI.getIndexedType()));
 481     }
 482     return true;
 483   }
 484
 485 };
 486
 487 class PtrToIntOperator
 488     : public ConcreteOperator<Operator, Instruction::PtrToInt> {
 489   friend class PtrToInt;
 490   friend class ConstantExpr;
 491
 492 public:
 493   Value *getPointerOperand() {
 494     return getOperand(0);
 495   }
 496   const Value *getPointerOperand() const {
 497     return getOperand(0);
 498   }
 499   static unsigned getPointerOperandIndex() {
 500     return 0U;                      // get index for modifying correct operand
 501   }
 502
 503   /// getPointerOperandType - Method to return the pointer operand as a
 504   /// PointerType.
 505   Type *getPointerOperandType() const {
 506     return getPointerOperand()->getType();
 507   }
 508
 509   /// getPointerAddressSpace - Method to return the address space of the
 510   /// pointer operand.
 511   unsigned getPointerAddressSpace() const {
 512     return cast<PointerType>(getPointerOperandType())->getAddressSpace();
 513   }
 514 };
 515
 516
 517 } // End llvm namespace
 518
 519 #endif