lib/IR/Instruction.cpp

   1 //===-- Instruction.cpp - Implement the Instruction class -----------------===//
   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 implements the Instruction class for the IR library.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/IR/Instruction.h"
  15 #include "llvm/IR/CallSite.h"
  16 #include "llvm/IR/Constants.h"
  17 #include "llvm/IR/Instructions.h"
  18 #include "llvm/IR/LeakDetector.h"
  19 #include "llvm/IR/Module.h"
  20 #include "llvm/IR/Operator.h"
  21 #include "llvm/IR/Type.h"
  22 using namespace llvm;
  23
  24 Instruction::Instruction(Type *ty, unsigned it, Use *Ops, unsigned NumOps,
  25                          Instruction *InsertBefore)
  26   : User(ty, Value::InstructionVal + it, Ops, NumOps), Parent(nullptr) {
  27   // Make sure that we get added to a basicblock
  28   LeakDetector::addGarbageObject(this);
  29
  30   // If requested, insert this instruction into a basic block...
  31   if (InsertBefore) {
  32     assert(InsertBefore->getParent() &&
  33            "Instruction to insert before is not in a basic block!");
  34     InsertBefore->getParent()->getInstList().insert(InsertBefore, this);
  35   }
  36 }
  37
  38 const DataLayout *Instruction::getDataLayout() const {
  39   return getParent()->getDataLayout();
  40 }
  41
  42 Instruction::Instruction(Type *ty, unsigned it, Use *Ops, unsigned NumOps,
  43                          BasicBlock *InsertAtEnd)
  44   : User(ty, Value::InstructionVal + it, Ops, NumOps), Parent(nullptr) {
  45   // Make sure that we get added to a basicblock
  46   LeakDetector::addGarbageObject(this);
  47
  48   // append this instruction into the basic block
  49   assert(InsertAtEnd && "Basic block to append to may not be NULL!");
  50   InsertAtEnd->getInstList().push_back(this);
  51 }
  52
  53
  54 // Out of line virtual method, so the vtable, etc has a home.
  55 Instruction::~Instruction() {
  56   assert(!Parent && "Instruction still linked in the program!");
  57   if (hasMetadataHashEntry())
  58     clearMetadataHashEntries();
  59 }
  60
  61
  62 void Instruction::setParent(BasicBlock *P) {
  63   if (getParent()) {
  64     if (!P) LeakDetector::addGarbageObject(this);
  65   } else {
  66     if (P) LeakDetector::removeGarbageObject(this);
  67   }
  68
  69   Parent = P;
  70 }
  71
  72 void Instruction::removeFromParent() {
  73   getParent()->getInstList().remove(this);
  74 }
  75
  76 void Instruction::eraseFromParent() {
  77   getParent()->getInstList().erase(this);
  78 }
  79
  80 /// insertBefore - Insert an unlinked instructions into a basic block
  81 /// immediately before the specified instruction.
  82 void Instruction::insertBefore(Instruction *InsertPos) {
  83   InsertPos->getParent()->getInstList().insert(InsertPos, this);
  84 }
  85
  86 /// insertAfter - Insert an unlinked instructions into a basic block
  87 /// immediately after the specified instruction.
  88 void Instruction::insertAfter(Instruction *InsertPos) {
  89   InsertPos->getParent()->getInstList().insertAfter(InsertPos, this);
  90 }
  91
  92 /// moveBefore - Unlink this instruction from its current basic block and
  93 /// insert it into the basic block that MovePos lives in, right before
  94 /// MovePos.
  95 void Instruction::moveBefore(Instruction *MovePos) {
  96   MovePos->getParent()->getInstList().splice(MovePos,getParent()->getInstList(),
  97                                              this);
  98 }
  99
 100 /// Set or clear the unsafe-algebra flag on this instruction, which must be an
 101 /// operator which supports this flag. See LangRef.html for the meaning of this
 102 /// flag.
 103 void Instruction::setHasUnsafeAlgebra(bool B) {
 104   assert(isa<FPMathOperator>(this) && "setting fast-math flag on invalid op");
 105   cast<FPMathOperator>(this)->setHasUnsafeAlgebra(B);
 106 }
 107
 108 /// Set or clear the NoNaNs flag on this instruction, which must be an operator
 109 /// which supports this flag. See LangRef.html for the meaning of this flag.
 110 void Instruction::setHasNoNaNs(bool B) {
 111   assert(isa<FPMathOperator>(this) && "setting fast-math flag on invalid op");
 112   cast<FPMathOperator>(this)->setHasNoNaNs(B);
 113 }
 114
 115 /// Set or clear the no-infs flag on this instruction, which must be an operator
 116 /// which supports this flag. See LangRef.html for the meaning of this flag.
 117 void Instruction::setHasNoInfs(bool B) {
 118   assert(isa<FPMathOperator>(this) && "setting fast-math flag on invalid op");
 119   cast<FPMathOperator>(this)->setHasNoInfs(B);
 120 }
 121
 122 /// Set or clear the no-signed-zeros flag on this instruction, which must be an
 123 /// operator which supports this flag. See LangRef.html for the meaning of this
 124 /// flag.
 125 void Instruction::setHasNoSignedZeros(bool B) {
 126   assert(isa<FPMathOperator>(this) && "setting fast-math flag on invalid op");
 127   cast<FPMathOperator>(this)->setHasNoSignedZeros(B);
 128 }
 129
 130 /// Set or clear the allow-reciprocal flag on this instruction, which must be an
 131 /// operator which supports this flag. See LangRef.html for the meaning of this
 132 /// flag.
 133 void Instruction::setHasAllowReciprocal(bool B) {
 134   assert(isa<FPMathOperator>(this) && "setting fast-math flag on invalid op");
 135   cast<FPMathOperator>(this)->setHasAllowReciprocal(B);
 136 }
 137
 138 /// Convenience function for setting all the fast-math flags on this
 139 /// instruction, which must be an operator which supports these flags. See
 140 /// LangRef.html for the meaning of these flats.
 141 void Instruction::setFastMathFlags(FastMathFlags FMF) {
 142   assert(isa<FPMathOperator>(this) && "setting fast-math flag on invalid op");
 143   cast<FPMathOperator>(this)->setFastMathFlags(FMF);
 144 }
 145
 146 void Instruction::copyFastMathFlags(FastMathFlags FMF) {
 147   assert(isa<FPMathOperator>(this) && "copying fast-math flag on invalid op");
 148   cast<FPMathOperator>(this)->copyFastMathFlags(FMF);
 149 }
 150
 151 /// Determine whether the unsafe-algebra flag is set.
 152 bool Instruction::hasUnsafeAlgebra() const {
 153   assert(isa<FPMathOperator>(this) && "getting fast-math flag on invalid op");
 154   return cast<FPMathOperator>(this)->hasUnsafeAlgebra();
 155 }
 156
 157 /// Determine whether the no-NaNs flag is set.
 158 bool Instruction::hasNoNaNs() const {
 159   assert(isa<FPMathOperator>(this) && "getting fast-math flag on invalid op");
 160   return cast<FPMathOperator>(this)->hasNoNaNs();
 161 }
 162
 163 /// Determine whether the no-infs flag is set.
 164 bool Instruction::hasNoInfs() const {
 165   assert(isa<FPMathOperator>(this) && "getting fast-math flag on invalid op");
 166   return cast<FPMathOperator>(this)->hasNoInfs();
 167 }
 168
 169 /// Determine whether the no-signed-zeros flag is set.
 170 bool Instruction::hasNoSignedZeros() const {
 171   assert(isa<FPMathOperator>(this) && "getting fast-math flag on invalid op");
 172   return cast<FPMathOperator>(this)->hasNoSignedZeros();
 173 }
 174
 175 /// Determine whether the allow-reciprocal flag is set.
 176 bool Instruction::hasAllowReciprocal() const {
 177   assert(isa<FPMathOperator>(this) && "getting fast-math flag on invalid op");
 178   return cast<FPMathOperator>(this)->hasAllowReciprocal();
 179 }
 180
 181 /// Convenience function for getting all the fast-math flags, which must be an
 182 /// operator which supports these flags. See LangRef.html for the meaning of
 183 /// these flags.
 184 FastMathFlags Instruction::getFastMathFlags() const {
 185   assert(isa<FPMathOperator>(this) && "getting fast-math flag on invalid op");
 186   return cast<FPMathOperator>(this)->getFastMathFlags();
 187 }
 188
 189 /// Copy I's fast-math flags
 190 void Instruction::copyFastMathFlags(const Instruction *I) {
 191   copyFastMathFlags(I->getFastMathFlags());
 192 }
 193
 194
 195 const char *Instruction::getOpcodeName(unsigned OpCode) {
 196   switch (OpCode) {
 197   // Terminators
 198   case Ret:    return "ret";
 199   case Br:     return "br";
 200   case Switch: return "switch";
 201   case IndirectBr: return "indirectbr";
 202   case Invoke: return "invoke";
 203   case Resume: return "resume";
 204   case Unreachable: return "unreachable";
 205
 206   // Standard binary operators...
 207   case Add: return "add";
 208   case FAdd: return "fadd";
 209   case Sub: return "sub";
 210   case FSub: return "fsub";
 211   case Mul: return "mul";
 212   case FMul: return "fmul";
 213   case UDiv: return "udiv";
 214   case SDiv: return "sdiv";
 215   case FDiv: return "fdiv";
 216   case URem: return "urem";
 217   case SRem: return "srem";
 218   case FRem: return "frem";
 219
 220   // Logical operators...
 221   case And: return "and";
 222   case Or : return "or";
 223   case Xor: return "xor";
 224
 225   // Memory instructions...
 226   case Alloca:        return "alloca";
 227   case Load:          return "load";
 228   case Store:         return "store";
 229   case AtomicCmpXchg: return "cmpxchg";
 230   case AtomicRMW:     return "atomicrmw";
 231   case Fence:         return "fence";
 232   case GetElementPtr: return "getelementptr";
 233
 234   // Convert instructions...
 235   case Trunc:         return "trunc";
 236   case ZExt:          return "zext";
 237   case SExt:          return "sext";
 238   case FPTrunc:       return "fptrunc";
 239   case FPExt:         return "fpext";
 240   case FPToUI:        return "fptoui";
 241   case FPToSI:        return "fptosi";
 242   case UIToFP:        return "uitofp";
 243   case SIToFP:        return "sitofp";
 244   case IntToPtr:      return "inttoptr";
 245   case PtrToInt:      return "ptrtoint";
 246   case BitCast:       return "bitcast";
 247   case AddrSpaceCast: return "addrspacecast";
 248
 249   // Other instructions...
 250   case ICmp:           return "icmp";
 251   case FCmp:           return "fcmp";
 252   case PHI:            return "phi";
 253   case Select:         return "select";
 254   case Call:           return "call";
 255   case Shl:            return "shl";
 256   case LShr:           return "lshr";
 257   case AShr:           return "ashr";
 258   case VAArg:          return "va_arg";
 259   case ExtractElement: return "extractelement";
 260   case InsertElement:  return "insertelement";
 261   case ShuffleVector:  return "shufflevector";
 262   case ExtractValue:   return "extractvalue";
 263   case InsertValue:    return "insertvalue";
 264   case LandingPad:     return "landingpad";
 265
 266   default: return "<Invalid operator> ";
 267   }
 268 }
 269
 270 /// Return true if both instructions have the same special state
 271 /// This must be kept in sync with lib/Transforms/IPO/MergeFunctions.cpp.
 272 static bool haveSameSpecialState(const Instruction *I1, const Instruction *I2,
 273                                  bool IgnoreAlignment = false) {
 274   assert(I1->getOpcode() == I2->getOpcode() &&
 275          "Can not compare special state of different instructions");
 276
 277   if (const LoadInst *LI = dyn_cast<LoadInst>(I1))
 278     return LI->isVolatile() == cast<LoadInst>(I2)->isVolatile() &&
 279            (LI->getAlignment() == cast<LoadInst>(I2)->getAlignment() ||
 280             IgnoreAlignment) &&
 281            LI->getOrdering() == cast<LoadInst>(I2)->getOrdering() &&
 282            LI->getSynchScope() == cast<LoadInst>(I2)->getSynchScope();
 283   if (const StoreInst *SI = dyn_cast<StoreInst>(I1))
 284     return SI->isVolatile() == cast<StoreInst>(I2)->isVolatile() &&
 285            (SI->getAlignment() == cast<StoreInst>(I2)->getAlignment() ||
 286             IgnoreAlignment) &&
 287            SI->getOrdering() == cast<StoreInst>(I2)->getOrdering() &&
 288            SI->getSynchScope() == cast<StoreInst>(I2)->getSynchScope();
 289   if (const CmpInst *CI = dyn_cast<CmpInst>(I1))
 290     return CI->getPredicate() == cast<CmpInst>(I2)->getPredicate();
 291   if (const CallInst *CI = dyn_cast<CallInst>(I1))
 292     return CI->isTailCall() == cast<CallInst>(I2)->isTailCall() &&
 293            CI->getCallingConv() == cast<CallInst>(I2)->getCallingConv() &&
 294            CI->getAttributes() == cast<CallInst>(I2)->getAttributes();
 295   if (const InvokeInst *CI = dyn_cast<InvokeInst>(I1))
 296     return CI->getCallingConv() == cast<InvokeInst>(I2)->getCallingConv() &&
 297            CI->getAttributes() ==
 298              cast<InvokeInst>(I2)->getAttributes();
 299   if (const InsertValueInst *IVI = dyn_cast<InsertValueInst>(I1))
 300     return IVI->getIndices() == cast<InsertValueInst>(I2)->getIndices();
 301   if (const ExtractValueInst *EVI = dyn_cast<ExtractValueInst>(I1))
 302     return EVI->getIndices() == cast<ExtractValueInst>(I2)->getIndices();
 303   if (const FenceInst *FI = dyn_cast<FenceInst>(I1))
 304     return FI->getOrdering() == cast<FenceInst>(I2)->getOrdering() &&
 305            FI->getSynchScope() == cast<FenceInst>(I2)->getSynchScope();
 306   if (const AtomicCmpXchgInst *CXI = dyn_cast<AtomicCmpXchgInst>(I1))
 307     return CXI->isVolatile() == cast<AtomicCmpXchgInst>(I2)->isVolatile() &&
 308            CXI->isWeak() == cast<AtomicCmpXchgInst>(I2)->isWeak() &&
 309            CXI->getSuccessOrdering() ==
 310                cast<AtomicCmpXchgInst>(I2)->getSuccessOrdering() &&
 311            CXI->getFailureOrdering() ==
 312                cast<AtomicCmpXchgInst>(I2)->getFailureOrdering() &&
 313            CXI->getSynchScope() == cast<AtomicCmpXchgInst>(I2)->getSynchScope();
 314   if (const AtomicRMWInst *RMWI = dyn_cast<AtomicRMWInst>(I1))
 315     return RMWI->getOperation() == cast<AtomicRMWInst>(I2)->getOperation() &&
 316            RMWI->isVolatile() == cast<AtomicRMWInst>(I2)->isVolatile() &&
 317            RMWI->getOrdering() == cast<AtomicRMWInst>(I2)->getOrdering() &&
 318            RMWI->getSynchScope() == cast<AtomicRMWInst>(I2)->getSynchScope();
 319
 320   return true;
 321 }
 322
 323 /// isIdenticalTo - Return true if the specified instruction is exactly
 324 /// identical to the current one.  This means that all operands match and any
 325 /// extra information (e.g. load is volatile) agree.
 326 bool Instruction::isIdenticalTo(const Instruction *I) const {
 327   return isIdenticalToWhenDefined(I) &&
 328          SubclassOptionalData == I->SubclassOptionalData;
 329 }
 330
 331 /// isIdenticalToWhenDefined - This is like isIdenticalTo, except that it
 332 /// ignores the SubclassOptionalData flags, which specify conditions
 333 /// under which the instruction's result is undefined.
 334 bool Instruction::isIdenticalToWhenDefined(const Instruction *I) const {
 335   if (getOpcode() != I->getOpcode() ||
 336       getNumOperands() != I->getNumOperands() ||
 337       getType() != I->getType())
 338     return false;
 339
 340   // If both instructions have no operands, they are identical.
 341   if (getNumOperands() == 0 && I->getNumOperands() == 0)
 342     return haveSameSpecialState(this, I);
 343
 344   // We have two instructions of identical opcode and #operands.  Check to see
 345   // if all operands are the same.
 346   if (!std::equal(op_begin(), op_end(), I->op_begin()))
 347     return false;
 348
 349   if (const PHINode *thisPHI = dyn_cast<PHINode>(this)) {
 350     const PHINode *otherPHI = cast<PHINode>(I);
 351     return std::equal(thisPHI->block_begin(), thisPHI->block_end(),
 352                       otherPHI->block_begin());
 353   }
 354
 355   return haveSameSpecialState(this, I);
 356 }
 357
 358 // isSameOperationAs
 359 // This should be kept in sync with isEquivalentOperation in
 360 // lib/Transforms/IPO/MergeFunctions.cpp.
 361 bool Instruction::isSameOperationAs(const Instruction *I,
 362                                     unsigned flags) const {
 363   bool IgnoreAlignment = flags & CompareIgnoringAlignment;
 364   bool UseScalarTypes  = flags & CompareUsingScalarTypes;
 365
 366   if (getOpcode() != I->getOpcode() ||
 367       getNumOperands() != I->getNumOperands() ||
 368       (UseScalarTypes ?
 369        getType()->getScalarType() != I->getType()->getScalarType() :
 370        getType() != I->getType()))
 371     return false;
 372
 373   // We have two instructions of identical opcode and #operands.  Check to see
 374   // if all operands are the same type
 375   for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
 376     if (UseScalarTypes ?
 377         getOperand(i)->getType()->getScalarType() !=
 378           I->getOperand(i)->getType()->getScalarType() :
 379         getOperand(i)->getType() != I->getOperand(i)->getType())
 380       return false;
 381
 382   return haveSameSpecialState(this, I, IgnoreAlignment);
 383 }
 384
 385 /// isUsedOutsideOfBlock - Return true if there are any uses of I outside of the
 386 /// specified block.  Note that PHI nodes are considered to evaluate their
 387 /// operands in the corresponding predecessor block.
 388 bool Instruction::isUsedOutsideOfBlock(const BasicBlock *BB) const {
 389   for (const Use &U : uses()) {
 390     // PHI nodes uses values in the corresponding predecessor block.  For other
 391     // instructions, just check to see whether the parent of the use matches up.
 392     const Instruction *I = cast<Instruction>(U.getUser());
 393     const PHINode *PN = dyn_cast<PHINode>(I);
 394     if (!PN) {
 395       if (I->getParent() != BB)
 396         return true;
 397       continue;
 398     }
 399
 400     if (PN->getIncomingBlock(U) != BB)
 401       return true;
 402   }
 403   return false;
 404 }
 405
 406 /// mayReadFromMemory - Return true if this instruction may read memory.
 407 ///
 408 bool Instruction::mayReadFromMemory() const {
 409   switch (getOpcode()) {
 410   default: return false;
 411   case Instruction::VAArg:
 412   case Instruction::Load:
 413   case Instruction::Fence: // FIXME: refine definition of mayReadFromMemory
 414   case Instruction::AtomicCmpXchg:
 415   case Instruction::AtomicRMW:
 416     return true;
 417   case Instruction::Call:
 418     return !cast<CallInst>(this)->doesNotAccessMemory();
 419   case Instruction::Invoke:
 420     return !cast<InvokeInst>(this)->doesNotAccessMemory();
 421   case Instruction::Store:
 422     return !cast<StoreInst>(this)->isUnordered();
 423   }
 424 }
 425
 426 /// mayWriteToMemory - Return true if this instruction may modify memory.
 427 ///
 428 bool Instruction::mayWriteToMemory() const {
 429   switch (getOpcode()) {
 430   default: return false;
 431   case Instruction::Fence: // FIXME: refine definition of mayWriteToMemory
 432   case Instruction::Store:
 433   case Instruction::VAArg:
 434   case Instruction::AtomicCmpXchg:
 435   case Instruction::AtomicRMW:
 436     return true;
 437   case Instruction::Call:
 438     return !cast<CallInst>(this)->onlyReadsMemory();
 439   case Instruction::Invoke:
 440     return !cast<InvokeInst>(this)->onlyReadsMemory();
 441   case Instruction::Load:
 442     return !cast<LoadInst>(this)->isUnordered();
 443   }
 444 }
 445
 446 bool Instruction::isAtomic() const {
 447   switch (getOpcode()) {
 448   default:
 449     return false;
 450   case Instruction::AtomicCmpXchg:
 451   case Instruction::AtomicRMW:
 452   case Instruction::Fence:
 453     return true;
 454   case Instruction::Load:
 455     return cast<LoadInst>(this)->getOrdering() != NotAtomic;
 456   case Instruction::Store:
 457     return cast<StoreInst>(this)->getOrdering() != NotAtomic;
 458   }
 459 }
 460
 461 bool Instruction::mayThrow() const {
 462   if (const CallInst *CI = dyn_cast<CallInst>(this))
 463     return !CI->doesNotThrow();
 464   return isa<ResumeInst>(this);
 465 }
 466
 467 bool Instruction::mayReturn() const {
 468   if (const CallInst *CI = dyn_cast<CallInst>(this))
 469     return !CI->doesNotReturn();
 470   return true;
 471 }
 472
 473 /// isAssociative - Return true if the instruction is associative:
 474 ///
 475 ///   Associative operators satisfy:  x op (y op z) === (x op y) op z
 476 ///
 477 /// In LLVM, the Add, Mul, And, Or, and Xor operators are associative.
 478 ///
 479 bool Instruction::isAssociative(unsigned Opcode) {
 480   return Opcode == And || Opcode == Or || Opcode == Xor ||
 481          Opcode == Add || Opcode == Mul;
 482 }
 483
 484 bool Instruction::isAssociative() const {
 485   unsigned Opcode = getOpcode();
 486   if (isAssociative(Opcode))
 487     return true;
 488
 489   switch (Opcode) {
 490   case FMul:
 491   case FAdd:
 492     return cast<FPMathOperator>(this)->hasUnsafeAlgebra();
 493   default:
 494     return false;
 495   }
 496 }
 497
 498 /// isCommutative - Return true if the instruction is commutative:
 499 ///
 500 ///   Commutative operators satisfy: (x op y) === (y op x)
 501 ///
 502 /// In LLVM, these are the associative operators, plus SetEQ and SetNE, when
 503 /// applied to any type.
 504 ///
 505 bool Instruction::isCommutative(unsigned op) {
 506   switch (op) {
 507   case Add:
 508   case FAdd:
 509   case Mul:
 510   case FMul:
 511   case And:
 512   case Or:
 513   case Xor:
 514     return true;
 515   default:
 516     return false;
 517   }
 518 }
 519
 520 /// isIdempotent - Return true if the instruction is idempotent:
 521 ///
 522 ///   Idempotent operators satisfy:  x op x === x
 523 ///
 524 /// In LLVM, the And and Or operators are idempotent.
 525 ///
 526 bool Instruction::isIdempotent(unsigned Opcode) {
 527   return Opcode == And || Opcode == Or;
 528 }
 529
 530 /// isNilpotent - Return true if the instruction is nilpotent:
 531 ///
 532 ///   Nilpotent operators satisfy:  x op x === Id,
 533 ///
 534 ///   where Id is the identity for the operator, i.e. a constant such that
 535 ///     x op Id === x and Id op x === x for all x.
 536 ///
 537 /// In LLVM, the Xor operator is nilpotent.
 538 ///
 539 bool Instruction::isNilpotent(unsigned Opcode) {
 540   return Opcode == Xor;
 541 }
 542
 543 Instruction *Instruction::clone() const {
 544   Instruction *New = clone_impl();
 545   New->SubclassOptionalData = SubclassOptionalData;
 546   if (!hasMetadata())
 547     return New;
 548
 549   // Otherwise, enumerate and copy over metadata from the old instruction to the
 550   // new one.
 551   SmallVector<std::pair<unsigned, MDNode*>, 4> TheMDs;
 552   getAllMetadataOtherThanDebugLoc(TheMDs);
 553   for (const auto &MD : TheMDs)
 554     New->setMetadata(MD.first, MD.second);
 555
 556   New->setDebugLoc(getDebugLoc());
 557   return New;
 558 }