LLVM  9.0.0svn
Value.cpp
Go to the documentation of this file.
1 //===-- Value.cpp - Implement the Value class -----------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file implements the Value, ValueHandle, and User classes.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #include "llvm/IR/Value.h"
14 #include "LLVMContextImpl.h"
15 #include "llvm/ADT/DenseMap.h"
16 #include "llvm/ADT/SmallString.h"
17 #include "llvm/ADT/SetVector.h"
18 #include "llvm/IR/Constant.h"
19 #include "llvm/IR/Constants.h"
20 #include "llvm/IR/DataLayout.h"
21 #include "llvm/IR/DerivedTypes.h"
22 #include "llvm/IR/DerivedUser.h"
24 #include "llvm/IR/InstrTypes.h"
25 #include "llvm/IR/Instructions.h"
26 #include "llvm/IR/IntrinsicInst.h"
27 #include "llvm/IR/Module.h"
28 #include "llvm/IR/Operator.h"
29 #include "llvm/IR/Statepoint.h"
30 #include "llvm/IR/ValueHandle.h"
32 #include "llvm/Support/Debug.h"
36 #include <algorithm>
37 
38 using namespace llvm;
39 
41  "non-global-value-max-name-size", cl::Hidden, cl::init(1024),
42  cl::desc("Maximum size for the name of non-global values."));
43 
44 //===----------------------------------------------------------------------===//
45 // Value Class
46 //===----------------------------------------------------------------------===//
47 static inline Type *checkType(Type *Ty) {
48  assert(Ty && "Value defined with a null type: Error!");
49  return Ty;
50 }
51 
52 Value::Value(Type *ty, unsigned scid)
53  : VTy(checkType(ty)), UseList(nullptr), SubclassID(scid),
54  HasValueHandle(0), SubclassOptionalData(0), SubclassData(0),
55  NumUserOperands(0), IsUsedByMD(false), HasName(false) {
56  static_assert(ConstantFirstVal == 0, "!(SubclassID < ConstantFirstVal)");
57  // FIXME: Why isn't this in the subclass gunk??
58  // Note, we cannot call isa<CallInst> before the CallInst has been
59  // constructed.
60  if (SubclassID == Instruction::Call || SubclassID == Instruction::Invoke ||
61  SubclassID == Instruction::CallBr)
62  assert((VTy->isFirstClassType() || VTy->isVoidTy() || VTy->isStructTy()) &&
63  "invalid CallInst type!");
64  else if (SubclassID != BasicBlockVal &&
65  (/*SubclassID < ConstantFirstVal ||*/ SubclassID > ConstantLastVal))
66  assert((VTy->isFirstClassType() || VTy->isVoidTy()) &&
67  "Cannot create non-first-class values except for constants!");
68  static_assert(sizeof(Value) == 2 * sizeof(void *) + 2 * sizeof(unsigned),
69  "Value too big");
70 }
71 
73  // Notify all ValueHandles (if present) that this value is going away.
74  if (HasValueHandle)
76  if (isUsedByMetadata())
78 
79 #ifndef NDEBUG // Only in -g mode...
80  // Check to make sure that there are no uses of this value that are still
81  // around when the value is destroyed. If there are, then we have a dangling
82  // reference and something is wrong. This code is here to print out where
83  // the value is still being referenced.
84  //
85  if (!use_empty()) {
86  dbgs() << "While deleting: " << *VTy << " %" << getName() << "\n";
87  for (auto *U : users())
88  dbgs() << "Use still stuck around after Def is destroyed:" << *U << "\n";
89  }
90 #endif
91  assert(use_empty() && "Uses remain when a value is destroyed!");
92 
93  // If this value is named, destroy the name. This should not be in a symtab
94  // at this point.
95  destroyValueName();
96 }
97 
99  switch (getValueID()) {
100 #define HANDLE_VALUE(Name) \
101  case Value::Name##Val: \
102  delete static_cast<Name *>(this); \
103  break;
104 #define HANDLE_MEMORY_VALUE(Name) \
105  case Value::Name##Val: \
106  static_cast<DerivedUser *>(this)->DeleteValue( \
107  static_cast<DerivedUser *>(this)); \
108  break;
109 #define HANDLE_INSTRUCTION(Name) /* nothing */
110 #include "llvm/IR/Value.def"
111 
112 #define HANDLE_INST(N, OPC, CLASS) \
113  case Value::InstructionVal + Instruction::OPC: \
114  delete static_cast<CLASS *>(this); \
115  break;
116 #define HANDLE_USER_INST(N, OPC, CLASS)
117 #include "llvm/IR/Instruction.def"
118 
119  default:
120  llvm_unreachable("attempting to delete unknown value kind");
121  }
122 }
123 
124 void Value::destroyValueName() {
126  if (Name)
127  Name->Destroy();
128  setValueName(nullptr);
129 }
130 
131 bool Value::hasNUses(unsigned N) const {
132  return hasNItems(use_begin(), use_end(), N);
133 }
134 
135 bool Value::hasNUsesOrMore(unsigned N) const {
136  return hasNItemsOrMore(use_begin(), use_end(), N);
137 }
138 
139 bool Value::isUsedInBasicBlock(const BasicBlock *BB) const {
140  // This can be computed either by scanning the instructions in BB, or by
141  // scanning the use list of this Value. Both lists can be very long, but
142  // usually one is quite short.
143  //
144  // Scan both lists simultaneously until one is exhausted. This limits the
145  // search to the shorter list.
146  BasicBlock::const_iterator BI = BB->begin(), BE = BB->end();
147  const_user_iterator UI = user_begin(), UE = user_end();
148  for (; BI != BE && UI != UE; ++BI, ++UI) {
149  // Scan basic block: Check if this Value is used by the instruction at BI.
150  if (is_contained(BI->operands(), this))
151  return true;
152  // Scan use list: Check if the use at UI is in BB.
153  const auto *User = dyn_cast<Instruction>(*UI);
154  if (User && User->getParent() == BB)
155  return true;
156  }
157  return false;
158 }
159 
160 unsigned Value::getNumUses() const {
161  return (unsigned)std::distance(use_begin(), use_end());
162 }
163 
164 static bool getSymTab(Value *V, ValueSymbolTable *&ST) {
165  ST = nullptr;
166  if (Instruction *I = dyn_cast<Instruction>(V)) {
167  if (BasicBlock *P = I->getParent())
168  if (Function *PP = P->getParent())
169  ST = PP->getValueSymbolTable();
170  } else if (BasicBlock *BB = dyn_cast<BasicBlock>(V)) {
171  if (Function *P = BB->getParent())
172  ST = P->getValueSymbolTable();
173  } else if (GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
174  if (Module *P = GV->getParent())
175  ST = &P->getValueSymbolTable();
176  } else if (Argument *A = dyn_cast<Argument>(V)) {
177  if (Function *P = A->getParent())
178  ST = P->getValueSymbolTable();
179  } else {
180  assert(isa<Constant>(V) && "Unknown value type!");
181  return true; // no name is setable for this.
182  }
183  return false;
184 }
185 
187  if (!HasName) return nullptr;
188 
189  LLVMContext &Ctx = getContext();
190  auto I = Ctx.pImpl->ValueNames.find(this);
191  assert(I != Ctx.pImpl->ValueNames.end() &&
192  "No name entry found!");
193 
194  return I->second;
195 }
196 
198  LLVMContext &Ctx = getContext();
199 
200  assert(HasName == Ctx.pImpl->ValueNames.count(this) &&
201  "HasName bit out of sync!");
202 
203  if (!VN) {
204  if (HasName)
205  Ctx.pImpl->ValueNames.erase(this);
206  HasName = false;
207  return;
208  }
209 
210  HasName = true;
211  Ctx.pImpl->ValueNames[this] = VN;
212 }
213 
215  // Make sure the empty string is still a C string. For historical reasons,
216  // some clients want to call .data() on the result and expect it to be null
217  // terminated.
218  if (!hasName())
219  return StringRef("", 0);
220  return getValueName()->getKey();
221 }
222 
223 void Value::setNameImpl(const Twine &NewName) {
224  // Fast-path: LLVMContext can be set to strip out non-GlobalValue names
225  if (getContext().shouldDiscardValueNames() && !isa<GlobalValue>(this))
226  return;
227 
228  // Fast path for common IRBuilder case of setName("") when there is no name.
229  if (NewName.isTriviallyEmpty() && !hasName())
230  return;
231 
232  SmallString<256> NameData;
233  StringRef NameRef = NewName.toStringRef(NameData);
234  assert(NameRef.find_first_of(0) == StringRef::npos &&
235  "Null bytes are not allowed in names");
236 
237  // Name isn't changing?
238  if (getName() == NameRef)
239  return;
240 
241  // Cap the size of non-GlobalValue names.
242  if (NameRef.size() > NonGlobalValueMaxNameSize && !isa<GlobalValue>(this))
243  NameRef =
244  NameRef.substr(0, std::max(1u, (unsigned)NonGlobalValueMaxNameSize));
245 
246  assert(!getType()->isVoidTy() && "Cannot assign a name to void values!");
247 
248  // Get the symbol table to update for this object.
250  if (getSymTab(this, ST))
251  return; // Cannot set a name on this value (e.g. constant).
252 
253  if (!ST) { // No symbol table to update? Just do the change.
254  if (NameRef.empty()) {
255  // Free the name for this value.
256  destroyValueName();
257  return;
258  }
259 
260  // NOTE: Could optimize for the case the name is shrinking to not deallocate
261  // then reallocated.
262  destroyValueName();
263 
264  // Create the new name.
266  getValueName()->setValue(this);
267  return;
268  }
269 
270  // NOTE: Could optimize for the case the name is shrinking to not deallocate
271  // then reallocated.
272  if (hasName()) {
273  // Remove old name.
274  ST->removeValueName(getValueName());
275  destroyValueName();
276 
277  if (NameRef.empty())
278  return;
279  }
280 
281  // Name is changing to something new.
282  setValueName(ST->createValueName(NameRef, this));
283 }
284 
285 void Value::setName(const Twine &NewName) {
286  setNameImpl(NewName);
287  if (Function *F = dyn_cast<Function>(this))
288  F->recalculateIntrinsicID();
289 }
290 
292  ValueSymbolTable *ST = nullptr;
293  // If this value has a name, drop it.
294  if (hasName()) {
295  // Get the symtab this is in.
296  if (getSymTab(this, ST)) {
297  // We can't set a name on this value, but we need to clear V's name if
298  // it has one.
299  if (V->hasName()) V->setName("");
300  return; // Cannot set a name on this value (e.g. constant).
301  }
302 
303  // Remove old name.
304  if (ST)
305  ST->removeValueName(getValueName());
306  destroyValueName();
307  }
308 
309  // Now we know that this has no name.
310 
311  // If V has no name either, we're done.
312  if (!V->hasName()) return;
313 
314  // Get this's symtab if we didn't before.
315  if (!ST) {
316  if (getSymTab(this, ST)) {
317  // Clear V's name.
318  V->setName("");
319  return; // Cannot set a name on this value (e.g. constant).
320  }
321  }
322 
323  // Get V's ST, this should always succed, because V has a name.
324  ValueSymbolTable *VST;
325  bool Failure = getSymTab(V, VST);
326  assert(!Failure && "V has a name, so it should have a ST!"); (void)Failure;
327 
328  // If these values are both in the same symtab, we can do this very fast.
329  // This works even if both values have no symtab yet.
330  if (ST == VST) {
331  // Take the name!
333  V->setValueName(nullptr);
334  getValueName()->setValue(this);
335  return;
336  }
337 
338  // Otherwise, things are slightly more complex. Remove V's name from VST and
339  // then reinsert it into ST.
340 
341  if (VST)
342  VST->removeValueName(V->getValueName());
344  V->setValueName(nullptr);
345  getValueName()->setValue(this);
346 
347  if (ST)
348  ST->reinsertValue(this);
349 }
350 
352 #ifndef NDEBUG
353  const GlobalValue *GV = dyn_cast<GlobalValue>(this);
354  if (!GV)
355  return;
356  const Module *M = GV->getParent();
357  if (!M)
358  return;
359  assert(M->isMaterialized());
360 #endif
361 }
362 
363 #ifndef NDEBUG
365  Constant *C) {
366  if (!Cache.insert(Expr).second)
367  return false;
368 
369  for (auto &O : Expr->operands()) {
370  if (O == C)
371  return true;
372  auto *CE = dyn_cast<ConstantExpr>(O);
373  if (!CE)
374  continue;
375  if (contains(Cache, CE, C))
376  return true;
377  }
378  return false;
379 }
380 
381 static bool contains(Value *Expr, Value *V) {
382  if (Expr == V)
383  return true;
384 
385  auto *C = dyn_cast<Constant>(V);
386  if (!C)
387  return false;
388 
389  auto *CE = dyn_cast<ConstantExpr>(Expr);
390  if (!CE)
391  return false;
392 
394  return contains(Cache, CE, C);
395 }
396 #endif // NDEBUG
397 
398 void Value::doRAUW(Value *New, ReplaceMetadataUses ReplaceMetaUses) {
399  assert(New && "Value::replaceAllUsesWith(<null>) is invalid!");
400  assert(!contains(New, this) &&
401  "this->replaceAllUsesWith(expr(this)) is NOT valid!");
402  assert(New->getType() == getType() &&
403  "replaceAllUses of value with new value of different type!");
404 
405  // Notify all ValueHandles (if present) that this value is going away.
406  if (HasValueHandle)
408  if (ReplaceMetaUses == ReplaceMetadataUses::Yes && isUsedByMetadata())
409  ValueAsMetadata::handleRAUW(this, New);
410 
411  while (!materialized_use_empty()) {
412  Use &U = *UseList;
413  // Must handle Constants specially, we cannot call replaceUsesOfWith on a
414  // constant because they are uniqued.
415  if (auto *C = dyn_cast<Constant>(U.getUser())) {
416  if (!isa<GlobalValue>(C)) {
417  C->handleOperandChange(this, New);
418  continue;
419  }
420  }
421 
422  U.set(New);
423  }
424 
425  if (BasicBlock *BB = dyn_cast<BasicBlock>(this))
426  BB->replaceSuccessorsPhiUsesWith(cast<BasicBlock>(New));
427 }
428 
430  doRAUW(New, ReplaceMetadataUses::Yes);
431 }
432 
434  doRAUW(New, ReplaceMetadataUses::No);
435 }
436 
437 // Like replaceAllUsesWith except it does not handle constants or basic blocks.
438 // This routine leaves uses within BB.
440  assert(New && "Value::replaceUsesOutsideBlock(<null>, BB) is invalid!");
441  assert(!contains(New, this) &&
442  "this->replaceUsesOutsideBlock(expr(this), BB) is NOT valid!");
443  assert(New->getType() == getType() &&
444  "replaceUses of value with new value of different type!");
445  assert(BB && "Basic block that may contain a use of 'New' must be defined\n");
446 
447  use_iterator UI = use_begin(), E = use_end();
448  for (; UI != E;) {
449  Use &U = *UI;
450  ++UI;
451  auto *Usr = dyn_cast<Instruction>(U.getUser());
452  if (Usr && Usr->getParent() == BB)
453  continue;
454  U.set(New);
455  }
456 }
457 
458 namespace {
459 // Various metrics for how much to strip off of pointers.
461  PSK_ZeroIndices,
462  PSK_ZeroIndicesAndAliases,
463  PSK_ZeroIndicesAndAliasesAndInvariantGroups,
464  PSK_InBoundsConstantIndices,
465  PSK_InBounds
466 };
467 
468 template <PointerStripKind StripKind>
469 static const Value *stripPointerCastsAndOffsets(const Value *V) {
470  if (!V->getType()->isPointerTy())
471  return V;
472 
473  // Even though we don't look through PHI nodes, we could be called on an
474  // instruction in an unreachable block, which may be on a cycle.
476 
477  Visited.insert(V);
478  do {
479  if (auto *GEP = dyn_cast<GEPOperator>(V)) {
480  switch (StripKind) {
481  case PSK_ZeroIndicesAndAliases:
482  case PSK_ZeroIndicesAndAliasesAndInvariantGroups:
483  case PSK_ZeroIndices:
484  if (!GEP->hasAllZeroIndices())
485  return V;
486  break;
487  case PSK_InBoundsConstantIndices:
488  if (!GEP->hasAllConstantIndices())
489  return V;
491  case PSK_InBounds:
492  if (!GEP->isInBounds())
493  return V;
494  break;
495  }
496  V = GEP->getPointerOperand();
497  } else if (Operator::getOpcode(V) == Instruction::BitCast ||
498  Operator::getOpcode(V) == Instruction::AddrSpaceCast) {
499  V = cast<Operator>(V)->getOperand(0);
500  } else if (auto *GA = dyn_cast<GlobalAlias>(V)) {
501  if (StripKind == PSK_ZeroIndices || GA->isInterposable())
502  return V;
503  V = GA->getAliasee();
504  } else {
505  if (const auto *Call = dyn_cast<CallBase>(V)) {
506  if (const Value *RV = Call->getReturnedArgOperand()) {
507  V = RV;
508  continue;
509  }
510  // The result of launder.invariant.group must alias it's argument,
511  // but it can't be marked with returned attribute, that's why it needs
512  // special case.
513  if (StripKind == PSK_ZeroIndicesAndAliasesAndInvariantGroups &&
514  (Call->getIntrinsicID() == Intrinsic::launder_invariant_group ||
515  Call->getIntrinsicID() == Intrinsic::strip_invariant_group)) {
516  V = Call->getArgOperand(0);
517  continue;
518  }
519  }
520  return V;
521  }
522  assert(V->getType()->isPointerTy() && "Unexpected operand type!");
523  } while (Visited.insert(V).second);
524 
525  return V;
526 }
527 } // end anonymous namespace
528 
530  return stripPointerCastsAndOffsets<PSK_ZeroIndicesAndAliases>(this);
531 }
532 
534  return stripPointerCastsAndOffsets<PSK_ZeroIndices>(this);
535 }
536 
538  return stripPointerCastsAndOffsets<PSK_InBoundsConstantIndices>(this);
539 }
540 
542  return stripPointerCastsAndOffsets<PSK_ZeroIndicesAndAliasesAndInvariantGroups>(
543  this);
544 }
545 
546 const Value *
548  APInt &Offset) const {
549  if (!getType()->isPointerTy())
550  return this;
551 
552  assert(Offset.getBitWidth() == DL.getIndexSizeInBits(cast<PointerType>(
553  getType())->getAddressSpace()) &&
554  "The offset bit width does not match the DL specification.");
555 
556  // Even though we don't look through PHI nodes, we could be called on an
557  // instruction in an unreachable block, which may be on a cycle.
559  Visited.insert(this);
560  const Value *V = this;
561  do {
562  if (auto *GEP = dyn_cast<GEPOperator>(V)) {
563  if (!GEP->isInBounds())
564  return V;
565  APInt GEPOffset(Offset);
566  if (!GEP->accumulateConstantOffset(DL, GEPOffset))
567  return V;
568  Offset = GEPOffset;
569  V = GEP->getPointerOperand();
570  } else if (Operator::getOpcode(V) == Instruction::BitCast) {
571  V = cast<Operator>(V)->getOperand(0);
572  } else if (auto *GA = dyn_cast<GlobalAlias>(V)) {
573  V = GA->getAliasee();
574  } else {
575  if (const auto *Call = dyn_cast<CallBase>(V))
576  if (const Value *RV = Call->getReturnedArgOperand()) {
577  V = RV;
578  continue;
579  }
580 
581  return V;
582  }
583  assert(V->getType()->isPointerTy() && "Unexpected operand type!");
584  } while (Visited.insert(V).second);
585 
586  return V;
587 }
588 
590  return stripPointerCastsAndOffsets<PSK_InBounds>(this);
591 }
592 
594  bool &CanBeNull) const {
595  assert(getType()->isPointerTy() && "must be pointer");
596 
597  uint64_t DerefBytes = 0;
598  CanBeNull = false;
599  if (const Argument *A = dyn_cast<Argument>(this)) {
600  DerefBytes = A->getDereferenceableBytes();
601  if (DerefBytes == 0 && (A->hasByValAttr() || A->hasStructRetAttr())) {
602  Type *PT = cast<PointerType>(A->getType())->getElementType();
603  if (PT->isSized())
604  DerefBytes = DL.getTypeStoreSize(PT);
605  }
606  if (DerefBytes == 0) {
607  DerefBytes = A->getDereferenceableOrNullBytes();
608  CanBeNull = true;
609  }
610  } else if (const auto *Call = dyn_cast<CallBase>(this)) {
611  DerefBytes = Call->getDereferenceableBytes(AttributeList::ReturnIndex);
612  if (DerefBytes == 0) {
613  DerefBytes =
614  Call->getDereferenceableOrNullBytes(AttributeList::ReturnIndex);
615  CanBeNull = true;
616  }
617  } else if (const LoadInst *LI = dyn_cast<LoadInst>(this)) {
618  if (MDNode *MD = LI->getMetadata(LLVMContext::MD_dereferenceable)) {
619  ConstantInt *CI = mdconst::extract<ConstantInt>(MD->getOperand(0));
620  DerefBytes = CI->getLimitedValue();
621  }
622  if (DerefBytes == 0) {
623  if (MDNode *MD =
624  LI->getMetadata(LLVMContext::MD_dereferenceable_or_null)) {
625  ConstantInt *CI = mdconst::extract<ConstantInt>(MD->getOperand(0));
626  DerefBytes = CI->getLimitedValue();
627  }
628  CanBeNull = true;
629  }
630  } else if (auto *AI = dyn_cast<AllocaInst>(this)) {
631  if (!AI->isArrayAllocation()) {
632  DerefBytes = DL.getTypeStoreSize(AI->getAllocatedType());
633  CanBeNull = false;
634  }
635  } else if (auto *GV = dyn_cast<GlobalVariable>(this)) {
636  if (GV->getValueType()->isSized() && !GV->hasExternalWeakLinkage()) {
637  // TODO: Don't outright reject hasExternalWeakLinkage but set the
638  // CanBeNull flag.
639  DerefBytes = DL.getTypeStoreSize(GV->getValueType());
640  CanBeNull = false;
641  }
642  }
643  return DerefBytes;
644 }
645 
646 unsigned Value::getPointerAlignment(const DataLayout &DL) const {
647  assert(getType()->isPointerTy() && "must be pointer");
648 
649  unsigned Align = 0;
650  if (auto *GO = dyn_cast<GlobalObject>(this)) {
651  if (isa<Function>(GO)) {
652  switch (DL.getFunctionPtrAlignType()) {
654  return DL.getFunctionPtrAlign();
656  return std::max(DL.getFunctionPtrAlign(), GO->getAlignment());
657  }
658  }
659  Align = GO->getAlignment();
660  if (Align == 0) {
661  if (auto *GVar = dyn_cast<GlobalVariable>(GO)) {
662  Type *ObjectType = GVar->getValueType();
663  if (ObjectType->isSized()) {
664  // If the object is defined in the current Module, we'll be giving
665  // it the preferred alignment. Otherwise, we have to assume that it
666  // may only have the minimum ABI alignment.
667  if (GVar->isStrongDefinitionForLinker())
668  Align = DL.getPreferredAlignment(GVar);
669  else
670  Align = DL.getABITypeAlignment(ObjectType);
671  }
672  }
673  }
674  } else if (const Argument *A = dyn_cast<Argument>(this)) {
675  Align = A->getParamAlignment();
676 
677  if (!Align && A->hasStructRetAttr()) {
678  // An sret parameter has at least the ABI alignment of the return type.
679  Type *EltTy = cast<PointerType>(A->getType())->getElementType();
680  if (EltTy->isSized())
681  Align = DL.getABITypeAlignment(EltTy);
682  }
683  } else if (const AllocaInst *AI = dyn_cast<AllocaInst>(this)) {
684  Align = AI->getAlignment();
685  if (Align == 0) {
686  Type *AllocatedType = AI->getAllocatedType();
687  if (AllocatedType->isSized())
688  Align = DL.getPrefTypeAlignment(AllocatedType);
689  }
690  } else if (const auto *Call = dyn_cast<CallBase>(this))
691  Align = Call->getAttributes().getRetAlignment();
692  else if (const LoadInst *LI = dyn_cast<LoadInst>(this))
693  if (MDNode *MD = LI->getMetadata(LLVMContext::MD_align)) {
694  ConstantInt *CI = mdconst::extract<ConstantInt>(MD->getOperand(0));
695  Align = CI->getLimitedValue();
696  }
697 
698  return Align;
699 }
700 
702  const BasicBlock *PredBB) const {
703  auto *PN = dyn_cast<PHINode>(this);
704  if (PN && PN->getParent() == CurBB)
705  return PN->getIncomingValueForBlock(PredBB);
706  return this;
707 }
708 
709 LLVMContext &Value::getContext() const { return VTy->getContext(); }
710 
712  if (!UseList || !UseList->Next)
713  // No need to reverse 0 or 1 uses.
714  return;
715 
716  Use *Head = UseList;
717  Use *Current = UseList->Next;
718  Head->Next = nullptr;
719  while (Current) {
720  Use *Next = Current->Next;
721  Current->Next = Head;
722  Head->setPrev(&Current->Next);
723  Head = Current;
724  Current = Next;
725  }
726  UseList = Head;
727  Head->setPrev(&UseList);
728 }
729 
730 bool Value::isSwiftError() const {
731  auto *Arg = dyn_cast<Argument>(this);
732  if (Arg)
733  return Arg->hasSwiftErrorAttr();
734  auto *Alloca = dyn_cast<AllocaInst>(this);
735  if (!Alloca)
736  return false;
737  return Alloca->isSwiftError();
738 }
739 
740 //===----------------------------------------------------------------------===//
741 // ValueHandleBase Class
742 //===----------------------------------------------------------------------===//
743 
744 void ValueHandleBase::AddToExistingUseList(ValueHandleBase **List) {
745  assert(List && "Handle list is null?");
746 
747  // Splice ourselves into the list.
748  Next = *List;
749  *List = this;
750  setPrevPtr(List);
751  if (Next) {
752  Next->setPrevPtr(&Next);
753  assert(getValPtr() == Next->getValPtr() && "Added to wrong list?");
754  }
755 }
756 
757 void ValueHandleBase::AddToExistingUseListAfter(ValueHandleBase *List) {
758  assert(List && "Must insert after existing node");
759 
760  Next = List->Next;
761  setPrevPtr(&List->Next);
762  List->Next = this;
763  if (Next)
764  Next->setPrevPtr(&Next);
765 }
766 
767 void ValueHandleBase::AddToUseList() {
768  assert(getValPtr() && "Null pointer doesn't have a use list!");
769 
770  LLVMContextImpl *pImpl = getValPtr()->getContext().pImpl;
771 
772  if (getValPtr()->HasValueHandle) {
773  // If this value already has a ValueHandle, then it must be in the
774  // ValueHandles map already.
775  ValueHandleBase *&Entry = pImpl->ValueHandles[getValPtr()];
776  assert(Entry && "Value doesn't have any handles?");
777  AddToExistingUseList(&Entry);
778  return;
779  }
780 
781  // Ok, it doesn't have any handles yet, so we must insert it into the
782  // DenseMap. However, doing this insertion could cause the DenseMap to
783  // reallocate itself, which would invalidate all of the PrevP pointers that
784  // point into the old table. Handle this by checking for reallocation and
785  // updating the stale pointers only if needed.
787  const void *OldBucketPtr = Handles.getPointerIntoBucketsArray();
788 
789  ValueHandleBase *&Entry = Handles[getValPtr()];
790  assert(!Entry && "Value really did already have handles?");
791  AddToExistingUseList(&Entry);
792  getValPtr()->HasValueHandle = true;
793 
794  // If reallocation didn't happen or if this was the first insertion, don't
795  // walk the table.
796  if (Handles.isPointerIntoBucketsArray(OldBucketPtr) ||
797  Handles.size() == 1) {
798  return;
799  }
800 
801  // Okay, reallocation did happen. Fix the Prev Pointers.
803  E = Handles.end(); I != E; ++I) {
804  assert(I->second && I->first == I->second->getValPtr() &&
805  "List invariant broken!");
806  I->second->setPrevPtr(&I->second);
807  }
808 }
809 
811  assert(getValPtr() && getValPtr()->HasValueHandle &&
812  "Pointer doesn't have a use list!");
813 
814  // Unlink this from its use list.
815  ValueHandleBase **PrevPtr = getPrevPtr();
816  assert(*PrevPtr == this && "List invariant broken");
817 
818  *PrevPtr = Next;
819  if (Next) {
820  assert(Next->getPrevPtr() == &Next && "List invariant broken");
821  Next->setPrevPtr(PrevPtr);
822  return;
823  }
824 
825  // If the Next pointer was null, then it is possible that this was the last
826  // ValueHandle watching VP. If so, delete its entry from the ValueHandles
827  // map.
828  LLVMContextImpl *pImpl = getValPtr()->getContext().pImpl;
830  if (Handles.isPointerIntoBucketsArray(PrevPtr)) {
831  Handles.erase(getValPtr());
832  getValPtr()->HasValueHandle = false;
833  }
834 }
835 
837  assert(V->HasValueHandle && "Should only be called if ValueHandles present");
838 
839  // Get the linked list base, which is guaranteed to exist since the
840  // HasValueHandle flag is set.
841  LLVMContextImpl *pImpl = V->getContext().pImpl;
842  ValueHandleBase *Entry = pImpl->ValueHandles[V];
843  assert(Entry && "Value bit set but no entries exist");
844 
845  // We use a local ValueHandleBase as an iterator so that ValueHandles can add
846  // and remove themselves from the list without breaking our iteration. This
847  // is not really an AssertingVH; we just have to give ValueHandleBase a kind.
848  // Note that we deliberately do not the support the case when dropping a value
849  // handle results in a new value handle being permanently added to the list
850  // (as might occur in theory for CallbackVH's): the new value handle will not
851  // be processed and the checking code will mete out righteous punishment if
852  // the handle is still present once we have finished processing all the other
853  // value handles (it is fine to momentarily add then remove a value handle).
854  for (ValueHandleBase Iterator(Assert, *Entry); Entry; Entry = Iterator.Next) {
855  Iterator.RemoveFromUseList();
856  Iterator.AddToExistingUseListAfter(Entry);
857  assert(Entry->Next == &Iterator && "Loop invariant broken.");
858 
859  switch (Entry->getKind()) {
860  case Assert:
861  break;
862  case Weak:
863  case WeakTracking:
864  // WeakTracking and Weak just go to null, which unlinks them
865  // from the list.
866  Entry->operator=(nullptr);
867  break;
868  case Callback:
869  // Forward to the subclass's implementation.
870  static_cast<CallbackVH*>(Entry)->deleted();
871  break;
872  }
873  }
874 
875  // All callbacks, weak references, and assertingVHs should be dropped by now.
876  if (V->HasValueHandle) {
877 #ifndef NDEBUG // Only in +Asserts mode...
878  dbgs() << "While deleting: " << *V->getType() << " %" << V->getName()
879  << "\n";
880  if (pImpl->ValueHandles[V]->getKind() == Assert)
881  llvm_unreachable("An asserting value handle still pointed to this"
882  " value!");
883 
884 #endif
885  llvm_unreachable("All references to V were not removed?");
886  }
887 }
888 
890  assert(Old->HasValueHandle &&"Should only be called if ValueHandles present");
891  assert(Old != New && "Changing value into itself!");
892  assert(Old->getType() == New->getType() &&
893  "replaceAllUses of value with new value of different type!");
894 
895  // Get the linked list base, which is guaranteed to exist since the
896  // HasValueHandle flag is set.
897  LLVMContextImpl *pImpl = Old->getContext().pImpl;
898  ValueHandleBase *Entry = pImpl->ValueHandles[Old];
899 
900  assert(Entry && "Value bit set but no entries exist");
901 
902  // We use a local ValueHandleBase as an iterator so that
903  // ValueHandles can add and remove themselves from the list without
904  // breaking our iteration. This is not really an AssertingVH; we
905  // just have to give ValueHandleBase some kind.
906  for (ValueHandleBase Iterator(Assert, *Entry); Entry; Entry = Iterator.Next) {
907  Iterator.RemoveFromUseList();
908  Iterator.AddToExistingUseListAfter(Entry);
909  assert(Entry->Next == &Iterator && "Loop invariant broken.");
910 
911  switch (Entry->getKind()) {
912  case Assert:
913  case Weak:
914  // Asserting and Weak handles do not follow RAUW implicitly.
915  break;
916  case WeakTracking:
917  // Weak goes to the new value, which will unlink it from Old's list.
918  Entry->operator=(New);
919  break;
920  case Callback:
921  // Forward to the subclass's implementation.
922  static_cast<CallbackVH*>(Entry)->allUsesReplacedWith(New);
923  break;
924  }
925  }
926 
927 #ifndef NDEBUG
928  // If any new weak value handles were added while processing the
929  // list, then complain about it now.
930  if (Old->HasValueHandle)
931  for (Entry = pImpl->ValueHandles[Old]; Entry; Entry = Entry->Next)
932  switch (Entry->getKind()) {
933  case WeakTracking:
934  dbgs() << "After RAUW from " << *Old->getType() << " %"
935  << Old->getName() << " to " << *New->getType() << " %"
936  << New->getName() << "\n";
938  "A weak tracking value handle still pointed to the old value!\n");
939  default:
940  break;
941  }
942 #endif
943 }
944 
945 // Pin the vtable to this file.
946 void CallbackVH::anchor() {}
This is the common base class of value handles.
Definition: ValueHandle.h:29
uint64_t CallInst * C
use_iterator use_end()
Definition: Value.h:346
A parsed version of the target data layout string in and methods for querying it. ...
Definition: DataLayout.h:110
constexpr char Align[]
Key for Kernel::Arg::Metadata::mAlign.
This class provides a symbol table of name/value pairs.
static void ValueIsDeleted(Value *V)
Definition: Value.cpp:836
unsigned getIndexSizeInBits(unsigned AS) const
Size in bits of index used for address calculation in getelementptr.
Definition: DataLayout.h:398
GCNRegPressure max(const GCNRegPressure &P1, const GCNRegPressure &P2)
This class represents an incoming formal argument to a Function.
Definition: Argument.h:29
unsigned getValueID() const
Return an ID for the concrete type of this object.
Definition: Value.h:463
const Value * stripInBoundsOffsets() const
Strip off pointer casts and inbounds GEPs.
Definition: Value.cpp:589
This class represents lattice values for constants.
Definition: AllocatorList.h:23
StringMapEntry - This is used to represent one value that is inserted into a StringMap.
Definition: StringMap.h:125
A Module instance is used to store all the information related to an LLVM module. ...
Definition: Module.h:65
bool isSized(SmallPtrSetImpl< Type *> *Visited=nullptr) const
Return true if it makes sense to take the size of this type.
Definition: Type.h:264
amdgpu Simplify well known AMD library false FunctionCallee Value const Twine & Name
void setValue(const ValueTy &V)
Definition: StringMap.h:143
bool isTriviallyEmpty() const
Check if this twine is trivially empty; a false return value does not necessarily mean the twine is e...
Definition: Twine.h:400
StringRef toStringRef(SmallVectorImpl< char > &Out) const
This returns the twine as a single StringRef if it can be represented as such.
Definition: Twine.h:455
The function pointer alignment is a multiple of the function alignment.
bool isSwiftError() const
Return true if this alloca is used as a swifterror argument to a call.
Definition: Instructions.h:135
LLVMContext & getContext() const
All values hold a context through their type.
Definition: Value.cpp:709
void deleteValue()
Delete a pointer to a generic Value.
Definition: Value.cpp:98
Metadata node.
Definition: Metadata.h:863
F(f)
const void * getPointerIntoBucketsArray() const
getPointerIntoBucketsArray() - Return an opaque pointer into the buckets array.
Definition: DenseMap.h:351
An instruction for reading from memory.
Definition: Instructions.h:167
Hexagon Common GEP
#define Assert(C,...)
Definition: Lint.cpp:196
const Value * DoPHITranslation(const BasicBlock *CurBB, const BasicBlock *PredBB) const
Translate PHI node to its predecessor from the given basic block.
Definition: Value.cpp:701
unsigned getBitWidth() const
Return the number of bits in the APInt.
Definition: APInt.h:1508
unsigned getPointerAlignment(const DataLayout &DL) const
Returns an alignment of the pointer value.
Definition: Value.cpp:646
LLVMContext & getContext() const
Return the LLVMContext in which this type was uniqued.
Definition: Type.h:129
A templated base class for SmallPtrSet which provides the typesafe interface that is common across al...
Definition: SmallPtrSet.h:343
iterator begin()
Instruction iterator methods.
Definition: BasicBlock.h:268
FunctionPtrAlignType getFunctionPtrAlignType() const
Return the type of function pointer alignment.
Definition: DataLayout.h:278
static Type * checkType(Type *Ty)
Definition: Value.cpp:47
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition: Twine.h:80
A Use represents the edge between a Value definition and its users.
Definition: Use.h:55
void setName(const Twine &Name)
Change the name of the value.
Definition: Value.cpp:285
void assertModuleIsMaterializedImpl() const
Definition: Value.cpp:351
LLVM_NODISCARD StringRef substr(size_t Start, size_t N=npos) const
Return a reference to the substring from [Start, Start + N).
Definition: StringRef.h:578
DenseMap< const Value *, ValueName * > ValueNames
LLVM_NODISCARD bool empty() const
empty - Check if the string is empty.
Definition: StringRef.h:126
static StringMapEntry * Create(StringRef Key, AllocatorTy &Allocator, InitTy &&... InitVals)
Create a StringMapEntry for the specified key construct the value using InitiVals.
Definition: StringMap.h:155
void Destroy(AllocatorTy &Allocator)
Destroy - Destroy this StringMapEntry, releasing memory back to the specified allocator.
Definition: StringMap.h:200
User * getUser() const LLVM_READONLY
Returns the User that contains this Use.
Definition: Use.cpp:40
A constant value that is initialized with an expression using other constant values.
Definition: Constants.h:888
static void handleRAUW(Value *From, Value *To)
Definition: Metadata.cpp:391
Type * getType() const
All values are typed, get the type of this value.
Definition: Value.h:244
bool isFirstClassType() const
Return true if the type is "first class", meaning it is a valid type for a Value. ...
Definition: Type.h:243
bool isSwiftError() const
Return true if this value is a swifterror value.
Definition: Value.cpp:730
LLVM_NODISCARD size_t size() const
size - Get the string size.
Definition: StringRef.h:130
void replaceAllUsesWith(Value *V)
Change all uses of this to point to a new Value.
Definition: Value.cpp:429
static void ValueIsRAUWd(Value *Old, Value *New)
Definition: Value.cpp:889
void takeName(Value *V)
Transfer the name from V to this value.
Definition: Value.cpp:291
use_iterator_impl< Use > use_iterator
Definition: Value.h:331
bool isVoidTy() const
Return true if this is &#39;void&#39;.
Definition: Type.h:140
#define P(N)
unsigned getFunctionPtrAlign() const
Returns the alignment of function pointers, which may or may not be related to the alignment of funct...
Definition: DataLayout.h:274
initializer< Ty > init(const Ty &Val)
Definition: CommandLine.h:427
bool erase(const KeyT &Val)
Definition: DenseMap.h:298
void RemoveFromUseList()
Remove this ValueHandle from its current use list.
Definition: Value.cpp:810
bool hasNUsesOrMore(unsigned N) const
Return true if this value has N users or more.
Definition: Value.cpp:135
bool hasNUses(unsigned N) const
Return true if this Value has exactly N users.
Definition: Value.cpp:131
void set(Value *Val)
Definition: Value.h:670
bool hasName() const
Definition: Value.h:250
LLVM Basic Block Representation.
Definition: BasicBlock.h:57
The instances of the Type class are immutable: once they are created, they are never changed...
Definition: Type.h:45
This is an important class for using LLVM in a threaded context.
Definition: LLVMContext.h:64
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
This is an important base class in LLVM.
Definition: Constant.h:41
void replaceNonMetadataUsesWith(Value *V)
Change non-metadata uses of this to point to a new Value.
Definition: Value.cpp:433
Value * getIncomingValueForBlock(const BasicBlock *BB) const
This file contains the declarations for the subclasses of Constant, which represent the different fla...
bool isPointerTy() const
True if this is an instance of PointerType.
Definition: Type.h:223
StringRef getKey() const
Definition: StringMap.h:136
std::pair< iterator, bool > insert(PtrType Ptr)
Inserts Ptr if and only if there is no element in the container equal to Ptr.
Definition: SmallPtrSet.h:370
unsigned getPrefTypeAlignment(Type *Ty) const
Returns the preferred stack/global alignment for the specified type.
Definition: DataLayout.cpp:759
bool isUsedInBasicBlock(const BasicBlock *BB) const
Check if this value is used in the specified basic block.
Definition: Value.cpp:139
ValueHandlesTy ValueHandles
amdgpu Simplify well known AMD library false FunctionCallee Value * Arg
op_range operands()
Definition: User.h:237
unsigned size() const
Definition: DenseMap.h:125
bool hasNItemsOrMore(IterTy &&Begin, IterTy &&End, unsigned N, typename std::enable_if< !std::is_same< typename std::iterator_traits< typename std::remove_reference< decltype(Begin)>::type >::iterator_category, std::random_access_iterator_tag >::value, void >::type *=nullptr)
Return true if the sequence [Begin, End) has N or more items.
Definition: STLExtras.h:1610
const Value * stripPointerCasts() const
Strip off pointer casts, all-zero GEPs, and aliases.
Definition: Value.cpp:529
Value(Type *Ty, unsigned scid)
Definition: Value.cpp:52
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
LLVMContextImpl *const pImpl
Definition: LLVMContext.h:66
Iterator for intrusive lists based on ilist_node.
static cl::opt< unsigned > NonGlobalValueMaxNameSize("non-global-value-max-name-size", cl::Hidden, cl::init(1024), cl::desc("Maximum size for the name of non-global values."))
SmallPtrSet - This class implements a set which is optimized for holding SmallSize or less elements...
Definition: SmallPtrSet.h:417
uint64_t getLimitedValue(uint64_t Limit=~0ULL) const
getLimitedValue - If the value is smaller than the specified limit, return it, otherwise return the l...
Definition: Constants.h:250
This is the shared class of boolean and integer constants.
Definition: Constants.h:83
bool materialized_use_empty() const
Definition: Value.h:327
iterator end()
Definition: BasicBlock.h:270
Module.h This file contains the declarations for the Module class.
ValueName * getValueName() const
Definition: Value.cpp:186
unsigned getABITypeAlignment(Type *Ty) const
Returns the minimum ABI-required alignment for the specified type.
Definition: DataLayout.cpp:749
uint64_t getPointerDereferenceableBytes(const DataLayout &DL, bool &CanBeNull) const
Returns the number of bytes known to be dereferenceable for the pointer value.
Definition: Value.cpp:593
PointerStripKind
Definition: Value.cpp:460
bool isPointerIntoBucketsArray(const void *Ptr) const
isPointerIntoBucketsArray - Return true if the specified pointer points somewhere into the DenseMap&#39;s...
Definition: DenseMap.h:344
const Value * stripPointerCastsAndInvariantGroups() const
Strip off pointer casts, all-zero GEPs, aliases and invariant group info.
Definition: Value.cpp:541
bool isUsedByMetadata() const
Return true if there is metadata referencing this value.
Definition: Value.h:488
raw_ostream & dbgs()
dbgs() - This returns a reference to a raw_ostream for debugging messages.
Definition: Debug.cpp:132
unsigned getPreferredAlignment(const GlobalVariable *GV) const
Returns the preferred alignment of the specified global.
Definition: DataLayout.cpp:837
const Value * stripAndAccumulateInBoundsConstantOffsets(const DataLayout &DL, APInt &Offset) const
Accumulate offsets from stripInBoundsConstantOffsets().
Definition: Value.cpp:547
Class for arbitrary precision integers.
Definition: APInt.h:69
iterator_range< user_iterator > users()
Definition: Value.h:399
user_iterator_impl< const User > const_user_iterator
Definition: Value.h:369
void reverseUseList()
Reverse the use-list.
Definition: Value.cpp:711
use_iterator use_begin()
Definition: Value.h:338
bool isMaterialized() const
Definition: Module.h:508
unsigned getNumUses() const
This method computes the number of uses of this Value.
Definition: Value.cpp:160
unsigned HasName
Definition: Value.h:118
static const size_t npos
Definition: StringRef.h:50
iterator begin()
Definition: DenseMap.h:99
const Value * stripPointerCastsNoFollowAliases() const
Strip off pointer casts and all-zero GEPs.
Definition: Value.cpp:533
StringRef getName() const
Return a constant reference to the value&#39;s name.
Definition: Value.cpp:214
const NodeList & List
Definition: RDFGraph.cpp:201
LLVM_NODISCARD size_t find_first_of(char C, size_t From=0) const
Find the first character in the string that is C, or npos if not found.
Definition: StringRef.h:380
#define I(x, y, z)
Definition: MD5.cpp:58
#define N
static bool getSymTab(Value *V, ValueSymbolTable *&ST)
Definition: Value.cpp:164
iterator end()
Definition: DenseMap.h:108
LLVM_NODISCARD std::enable_if<!is_simple_type< Y >::value, typename cast_retty< X, const Y >::ret_type >::type dyn_cast(const Y &Val)
Definition: Casting.h:332
~Value()
Value&#39;s destructor should be virtual by design, but that would require that Value and all of its subc...
Definition: Value.cpp:72
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
user_iterator user_begin()
Definition: Value.h:375
static void handleDeletion(Value *V)
Definition: Metadata.cpp:372
Module * getParent()
Get the module that this global value is contained inside of...
Definition: GlobalValue.h:565
LLVM Value Representation.
Definition: Value.h:72
uint64_t getTypeStoreSize(Type *Ty) const
Returns the maximum number of bytes that may be overwritten by storing the specified type...
Definition: DataLayout.h:444
unsigned getOpcode() const
Return the opcode for this Instruction or ConstantExpr.
Definition: Operator.h:40
bool hasNItems(IterTy &&Begin, IterTy &&End, unsigned N, typename std::enable_if< !std::is_same< typename std::iterator_traits< typename std::remove_reference< decltype(Begin)>::type >::iterator_category, std::random_access_iterator_tag >::value, void >::type *=nullptr)
Return true if the sequence [Begin, End) has exactly N items.
Definition: STLExtras.h:1593
#define LLVM_FALLTHROUGH
LLVM_FALLTHROUGH - Mark fallthrough cases in switch statements.
Definition: Compiler.h:250
void setValueName(ValueName *VN)
Definition: Value.cpp:197
Value handle with callbacks on RAUW and destruction.
Definition: ValueHandle.h:379
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:48
void replaceUsesOutsideBlock(Value *V, BasicBlock *BB)
replaceUsesOutsideBlock - Go through the uses list for this definition and make each use point to "V"...
Definition: Value.cpp:439
const Value * stripInBoundsConstantOffsets() const
Strip off pointer casts and all-constant inbounds GEPs.
Definition: Value.cpp:537
static bool contains(SmallPtrSetImpl< ConstantExpr *> &Cache, ConstantExpr *Expr, Constant *C)
Definition: Value.cpp:364
The function pointer alignment is independent of the function alignment.
bool use_empty() const
Definition: Value.h:322
bool isStructTy() const
True if this is an instance of StructType.
Definition: Type.h:217
an instruction to allocate memory on the stack
Definition: Instructions.h:59
bool is_contained(R &&Range, const E &Element)
Wrapper function around std::find to detect if an element exists in a container.
Definition: STLExtras.h:1244
user_iterator user_end()
Definition: Value.h:383