Chris Lattner | 2f7c963 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 1 | //===-- Value.cpp - Implement the Value class -----------------------------===// |
Misha Brukman | b1c9317 | 2005-04-21 23:48:37 +0000 | [diff] [blame] | 2 | // |
John Criswell | 482202a | 2003-10-20 19:43:21 +0000 | [diff] [blame] | 3 | // The LLVM Compiler Infrastructure |
| 4 | // |
Chris Lattner | f3ebc3f | 2007-12-29 20:36:04 +0000 | [diff] [blame] | 5 | // This file is distributed under the University of Illinois Open Source |
| 6 | // License. See LICENSE.TXT for details. |
Misha Brukman | b1c9317 | 2005-04-21 23:48:37 +0000 | [diff] [blame] | 7 | // |
John Criswell | 482202a | 2003-10-20 19:43:21 +0000 | [diff] [blame] | 8 | //===----------------------------------------------------------------------===// |
Chris Lattner | 2f7c963 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 9 | // |
Chris Lattner | 90234f3 | 2009-03-31 22:11:05 +0000 | [diff] [blame] | 10 | // This file implements the Value, ValueHandle, and User classes. |
Chris Lattner | 2f7c963 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 11 | // |
| 12 | //===----------------------------------------------------------------------===// |
| 13 | |
Chandler Carruth | 9fb823b | 2013-01-02 11:36:10 +0000 | [diff] [blame] | 14 | #include "llvm/IR/Value.h" |
Owen Anderson | e8f2185 | 2009-08-18 18:28:58 +0000 | [diff] [blame] | 15 | #include "LLVMContextImpl.h" |
Chandler Carruth | ed0881b | 2012-12-03 16:50:05 +0000 | [diff] [blame] | 16 | #include "llvm/ADT/DenseMap.h" |
| 17 | #include "llvm/ADT/SmallString.h" |
Hal Finkel | b0407ba | 2014-07-18 15:51:28 +0000 | [diff] [blame] | 18 | #include "llvm/IR/CallSite.h" |
Chandler Carruth | 9fb823b | 2013-01-02 11:36:10 +0000 | [diff] [blame] | 19 | #include "llvm/IR/Constant.h" |
| 20 | #include "llvm/IR/Constants.h" |
Hal Finkel | 2e42c34 | 2014-07-10 05:27:53 +0000 | [diff] [blame] | 21 | #include "llvm/IR/DataLayout.h" |
Chandler Carruth | 9fb823b | 2013-01-02 11:36:10 +0000 | [diff] [blame] | 22 | #include "llvm/IR/DerivedTypes.h" |
Chandler Carruth | 03eb0de | 2014-03-04 10:40:04 +0000 | [diff] [blame] | 23 | #include "llvm/IR/GetElementPtrTypeIterator.h" |
Chandler Carruth | 9fb823b | 2013-01-02 11:36:10 +0000 | [diff] [blame] | 24 | #include "llvm/IR/InstrTypes.h" |
| 25 | #include "llvm/IR/Instructions.h" |
Ramkumar Ramachandra | a7343d6 | 2015-02-09 21:08:03 +0000 | [diff] [blame] | 26 | #include "llvm/IR/IntrinsicInst.h" |
Chandler Carruth | 9fb823b | 2013-01-02 11:36:10 +0000 | [diff] [blame] | 27 | #include "llvm/IR/Module.h" |
| 28 | #include "llvm/IR/Operator.h" |
Ramkumar Ramachandra | a7343d6 | 2015-02-09 21:08:03 +0000 | [diff] [blame] | 29 | #include "llvm/IR/Statepoint.h" |
Chandler Carruth | 4220e9c | 2014-03-04 11:17:44 +0000 | [diff] [blame] | 30 | #include "llvm/IR/ValueHandle.h" |
Chandler Carruth | 9fb823b | 2013-01-02 11:36:10 +0000 | [diff] [blame] | 31 | #include "llvm/IR/ValueSymbolTable.h" |
Bill Wendling | 6a462f1 | 2006-11-17 08:03:48 +0000 | [diff] [blame] | 32 | #include "llvm/Support/Debug.h" |
Torok Edwin | 6dd2730 | 2009-07-08 18:01:40 +0000 | [diff] [blame] | 33 | #include "llvm/Support/ErrorHandling.h" |
Chris Lattner | 90234f3 | 2009-03-31 22:11:05 +0000 | [diff] [blame] | 34 | #include "llvm/Support/ManagedStatic.h" |
Benjamin Kramer | 799003b | 2015-03-23 19:32:43 +0000 | [diff] [blame] | 35 | #include "llvm/Support/raw_ostream.h" |
Chris Lattner | 2f7c963 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 36 | #include <algorithm> |
Chris Lattner | 189d19f | 2003-11-21 20:23:48 +0000 | [diff] [blame] | 37 | using namespace llvm; |
Brian Gaeke | 960707c | 2003-11-11 22:41:34 +0000 | [diff] [blame] | 38 | |
Chris Lattner | 2f7c963 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 39 | //===----------------------------------------------------------------------===// |
| 40 | // Value Class |
| 41 | //===----------------------------------------------------------------------===// |
Chris Lattner | 229907c | 2011-07-18 04:54:35 +0000 | [diff] [blame] | 42 | static inline Type *checkType(Type *Ty) { |
Chris Lattner | 25450e3 | 2001-12-13 00:41:27 +0000 | [diff] [blame] | 43 | assert(Ty && "Value defined with a null type: Error!"); |
Reid Kleckner | 16bf89e | 2014-06-09 23:32:20 +0000 | [diff] [blame] | 44 | return Ty; |
Chris Lattner | 25450e3 | 2001-12-13 00:41:27 +0000 | [diff] [blame] | 45 | } |
| 46 | |
Chris Lattner | 229907c | 2011-07-18 04:54:35 +0000 | [diff] [blame] | 47 | Value::Value(Type *ty, unsigned scid) |
Owen Anderson | 7349ab9 | 2015-06-01 22:24:01 +0000 | [diff] [blame] | 48 | : VTy(checkType(ty)), UseList(nullptr), SubclassID(scid), |
| 49 | HasValueHandle(0), SubclassOptionalData(0), SubclassData(0), |
Pete Cooper | b4eede2 | 2015-06-12 17:48:10 +0000 | [diff] [blame] | 50 | NumUserOperands(0), IsUsedByMD(false), HasName(false) { |
Chris Lattner | b1ed91f | 2011-07-09 17:41:24 +0000 | [diff] [blame] | 51 | // FIXME: Why isn't this in the subclass gunk?? |
Richard Smith | 4a8e454 | 2012-12-20 04:11:02 +0000 | [diff] [blame] | 52 | // Note, we cannot call isa<CallInst> before the CallInst has been |
| 53 | // constructed. |
| 54 | if (SubclassID == Instruction::Call || SubclassID == Instruction::Invoke) |
Chris Lattner | b1ed91f | 2011-07-09 17:41:24 +0000 | [diff] [blame] | 55 | assert((VTy->isFirstClassType() || VTy->isVoidTy() || VTy->isStructTy()) && |
| 56 | "invalid CallInst type!"); |
Richard Smith | 4a8e454 | 2012-12-20 04:11:02 +0000 | [diff] [blame] | 57 | else if (SubclassID != BasicBlockVal && |
| 58 | (SubclassID < ConstantFirstVal || SubclassID > ConstantLastVal)) |
Chris Lattner | b1ed91f | 2011-07-09 17:41:24 +0000 | [diff] [blame] | 59 | assert((VTy->isFirstClassType() || VTy->isVoidTy()) && |
Chris Lattner | bea7247 | 2004-07-06 17:44:17 +0000 | [diff] [blame] | 60 | "Cannot create non-first-class values except for constants!"); |
Chris Lattner | 2f7c963 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 61 | } |
| 62 | |
Gordon Henriksen | 14a5569 | 2007-12-10 02:14:30 +0000 | [diff] [blame] | 63 | Value::~Value() { |
Chris Lattner | 90234f3 | 2009-03-31 22:11:05 +0000 | [diff] [blame] | 64 | // Notify all ValueHandles (if present) that this value is going away. |
| 65 | if (HasValueHandle) |
| 66 | ValueHandleBase::ValueIsDeleted(this); |
Duncan P. N. Exon Smith | 5bf8fef | 2014-12-09 18:38:53 +0000 | [diff] [blame] | 67 | if (isUsedByMetadata()) |
| 68 | ValueAsMetadata::handleDeletion(this); |
Daniel Dunbar | 6058b51 | 2009-09-20 04:03:34 +0000 | [diff] [blame] | 69 | |
Chris Lattner | 2f7c963 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 70 | #ifndef NDEBUG // Only in -g mode... |
Chris Lattner | 874ddad | 2001-06-11 15:04:40 +0000 | [diff] [blame] | 71 | // Check to make sure that there are no uses of this value that are still |
| 72 | // around when the value is destroyed. If there are, then we have a dangling |
Andrew Kaylor | b93fb82 | 2015-03-10 23:55:38 +0000 | [diff] [blame] | 73 | // reference and something is wrong. This code is here to print out where |
| 74 | // the value is still being referenced. |
Chris Lattner | 874ddad | 2001-06-11 15:04:40 +0000 | [diff] [blame] | 75 | // |
Gordon Henriksen | 14a5569 | 2007-12-10 02:14:30 +0000 | [diff] [blame] | 76 | if (!use_empty()) { |
Benjamin Kramer | 1f97a5a | 2011-11-15 16:27:03 +0000 | [diff] [blame] | 77 | dbgs() << "While deleting: " << *VTy << " %" << getName() << "\n"; |
Andrew Kaylor | b93fb82 | 2015-03-10 23:55:38 +0000 | [diff] [blame] | 78 | for (auto *U : users()) |
| 79 | dbgs() << "Use still stuck around after Def is destroyed:" << *U << "\n"; |
Chris Lattner | 2f7c963 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 80 | } |
| 81 | #endif |
Gordon Henriksen | 14a5569 | 2007-12-10 02:14:30 +0000 | [diff] [blame] | 82 | assert(use_empty() && "Uses remain when a value is destroyed!"); |
Chris Lattner | 694285c | 2009-08-04 23:07:12 +0000 | [diff] [blame] | 83 | |
| 84 | // If this value is named, destroy the name. This should not be in a symtab |
| 85 | // at this point. |
Duncan P. N. Exon Smith | 5bf8fef | 2014-12-09 18:38:53 +0000 | [diff] [blame] | 86 | destroyValueName(); |
Chris Lattner | 2f7c963 | 2001-06-06 20:29:01 +0000 | [diff] [blame] | 87 | } |
| 88 | |
Duncan P. N. Exon Smith | 5bf8fef | 2014-12-09 18:38:53 +0000 | [diff] [blame] | 89 | void Value::destroyValueName() { |
| 90 | ValueName *Name = getValueName(); |
| 91 | if (Name) |
| 92 | Name->Destroy(); |
| 93 | setValueName(nullptr); |
| 94 | } |
| 95 | |
Chris Lattner | 4947e67 | 2005-02-01 01:24:21 +0000 | [diff] [blame] | 96 | bool Value::hasNUses(unsigned N) const { |
Gabor Greif | c78d720 | 2010-03-25 23:06:16 +0000 | [diff] [blame] | 97 | const_use_iterator UI = use_begin(), E = use_end(); |
Chris Lattner | 4947e67 | 2005-02-01 01:24:21 +0000 | [diff] [blame] | 98 | |
| 99 | for (; N; --N, ++UI) |
| 100 | if (UI == E) return false; // Too few. |
| 101 | return UI == E; |
| 102 | } |
| 103 | |
Chris Lattner | d36552f | 2005-02-23 16:51:11 +0000 | [diff] [blame] | 104 | bool Value::hasNUsesOrMore(unsigned N) const { |
Gabor Greif | c78d720 | 2010-03-25 23:06:16 +0000 | [diff] [blame] | 105 | const_use_iterator UI = use_begin(), E = use_end(); |
Chris Lattner | d36552f | 2005-02-23 16:51:11 +0000 | [diff] [blame] | 106 | |
| 107 | for (; N; --N, ++UI) |
| 108 | if (UI == E) return false; // Too few. |
| 109 | |
| 110 | return true; |
| 111 | } |
| 112 | |
Bill Wendling | 0c37421 | 2008-09-25 22:42:01 +0000 | [diff] [blame] | 113 | bool Value::isUsedInBasicBlock(const BasicBlock *BB) const { |
Jakob Stoklund Olesen | 0925b24 | 2013-05-14 23:45:56 +0000 | [diff] [blame] | 114 | // This can be computed either by scanning the instructions in BB, or by |
| 115 | // scanning the use list of this Value. Both lists can be very long, but |
| 116 | // usually one is quite short. |
| 117 | // |
| 118 | // Scan both lists simultaneously until one is exhausted. This limits the |
| 119 | // search to the shorter list. |
| 120 | BasicBlock::const_iterator BI = BB->begin(), BE = BB->end(); |
Chandler Carruth | cdf4788 | 2014-03-09 03:16:01 +0000 | [diff] [blame] | 121 | const_user_iterator UI = user_begin(), UE = user_end(); |
Jakob Stoklund Olesen | 0925b24 | 2013-05-14 23:45:56 +0000 | [diff] [blame] | 122 | for (; BI != BE && UI != UE; ++BI, ++UI) { |
| 123 | // Scan basic block: Check if this Value is used by the instruction at BI. |
| 124 | if (std::find(BI->op_begin(), BI->op_end(), this) != BI->op_end()) |
Benjamin Kramer | 1323103 | 2011-12-05 17:23:27 +0000 | [diff] [blame] | 125 | return true; |
Jakob Stoklund Olesen | 0925b24 | 2013-05-14 23:45:56 +0000 | [diff] [blame] | 126 | // Scan use list: Check if the use at UI is in BB. |
| 127 | const Instruction *User = dyn_cast<Instruction>(*UI); |
Evan Cheng | 89553cc | 2008-06-12 21:15:59 +0000 | [diff] [blame] | 128 | if (User && User->getParent() == BB) |
| 129 | return true; |
| 130 | } |
| 131 | return false; |
| 132 | } |
| 133 | |
Chris Lattner | 4947e67 | 2005-02-01 01:24:21 +0000 | [diff] [blame] | 134 | unsigned Value::getNumUses() const { |
| 135 | return (unsigned)std::distance(use_begin(), use_end()); |
| 136 | } |
| 137 | |
Chris Lattner | b625082 | 2007-02-11 00:37:27 +0000 | [diff] [blame] | 138 | static bool getSymTab(Value *V, ValueSymbolTable *&ST) { |
Craig Topper | c620761 | 2014-04-09 06:08:46 +0000 | [diff] [blame] | 139 | ST = nullptr; |
Chris Lattner | b625082 | 2007-02-11 00:37:27 +0000 | [diff] [blame] | 140 | if (Instruction *I = dyn_cast<Instruction>(V)) { |
| 141 | if (BasicBlock *P = I->getParent()) |
| 142 | if (Function *PP = P->getParent()) |
| 143 | ST = &PP->getValueSymbolTable(); |
| 144 | } else if (BasicBlock *BB = dyn_cast<BasicBlock>(V)) { |
Daniel Dunbar | 6058b51 | 2009-09-20 04:03:34 +0000 | [diff] [blame] | 145 | if (Function *P = BB->getParent()) |
Chris Lattner | b625082 | 2007-02-11 00:37:27 +0000 | [diff] [blame] | 146 | ST = &P->getValueSymbolTable(); |
| 147 | } else if (GlobalValue *GV = dyn_cast<GlobalValue>(V)) { |
Daniel Dunbar | 6058b51 | 2009-09-20 04:03:34 +0000 | [diff] [blame] | 148 | if (Module *P = GV->getParent()) |
Chris Lattner | b625082 | 2007-02-11 00:37:27 +0000 | [diff] [blame] | 149 | ST = &P->getValueSymbolTable(); |
| 150 | } else if (Argument *A = dyn_cast<Argument>(V)) { |
Daniel Dunbar | 6058b51 | 2009-09-20 04:03:34 +0000 | [diff] [blame] | 151 | if (Function *P = A->getParent()) |
Chris Lattner | b625082 | 2007-02-11 00:37:27 +0000 | [diff] [blame] | 152 | ST = &P->getValueSymbolTable(); |
Duncan P. N. Exon Smith | 5bf8fef | 2014-12-09 18:38:53 +0000 | [diff] [blame] | 153 | } else { |
Chris Lattner | b625082 | 2007-02-11 00:37:27 +0000 | [diff] [blame] | 154 | assert(isa<Constant>(V) && "Unknown value type!"); |
| 155 | return true; // no name is setable for this. |
| 156 | } |
| 157 | return false; |
| 158 | } |
Chris Lattner | 2c6abea | 2002-10-09 23:12:59 +0000 | [diff] [blame] | 159 | |
Owen Anderson | 7349ab9 | 2015-06-01 22:24:01 +0000 | [diff] [blame] | 160 | ValueName *Value::getValueName() const { |
| 161 | if (!HasName) return nullptr; |
| 162 | |
| 163 | LLVMContext &Ctx = getContext(); |
| 164 | auto I = Ctx.pImpl->ValueNames.find(this); |
| 165 | assert(I != Ctx.pImpl->ValueNames.end() && |
| 166 | "No name entry found!"); |
| 167 | |
| 168 | return I->second; |
| 169 | } |
| 170 | |
| 171 | void Value::setValueName(ValueName *VN) { |
| 172 | LLVMContext &Ctx = getContext(); |
| 173 | |
| 174 | assert(HasName == Ctx.pImpl->ValueNames.count(this) && |
| 175 | "HasName bit out of sync!"); |
| 176 | |
| 177 | if (!VN) { |
| 178 | if (HasName) |
| 179 | Ctx.pImpl->ValueNames.erase(this); |
| 180 | HasName = false; |
| 181 | return; |
| 182 | } |
| 183 | |
| 184 | HasName = true; |
| 185 | Ctx.pImpl->ValueNames[this] = VN; |
| 186 | } |
| 187 | |
Daniel Dunbar | 3228594 | 2009-07-26 00:51:56 +0000 | [diff] [blame] | 188 | StringRef Value::getName() const { |
Daniel Dunbar | 7cc8f7e | 2009-07-26 09:22:02 +0000 | [diff] [blame] | 189 | // Make sure the empty string is still a C string. For historical reasons, |
| 190 | // some clients want to call .data() on the result and expect it to be null |
| 191 | // terminated. |
Owen Anderson | 7349ab9 | 2015-06-01 22:24:01 +0000 | [diff] [blame] | 192 | if (!hasName()) |
Duncan P. N. Exon Smith | 5bf8fef | 2014-12-09 18:38:53 +0000 | [diff] [blame] | 193 | return StringRef("", 0); |
| 194 | return getValueName()->getKey(); |
Chris Lattner | 5109a88 | 2007-08-10 15:34:35 +0000 | [diff] [blame] | 195 | } |
| 196 | |
Pete Cooper | a7c0c18 | 2015-05-19 00:24:26 +0000 | [diff] [blame] | 197 | void Value::setNameImpl(const Twine &NewName) { |
Daniel Dunbar | cb13b48 | 2009-08-19 23:37:23 +0000 | [diff] [blame] | 198 | // Fast path for common IRBuilder case of setName("") when there is no name. |
| 199 | if (NewName.isTriviallyEmpty() && !hasName()) |
| 200 | return; |
| 201 | |
Daniel Dunbar | acf0b25 | 2009-08-19 05:08:06 +0000 | [diff] [blame] | 202 | SmallString<256> NameData; |
Benjamin Kramer | 2e06b93 | 2010-01-13 12:45:23 +0000 | [diff] [blame] | 203 | StringRef NameRef = NewName.toStringRef(NameData); |
Rafael Espindola | 09d689f | 2013-11-19 21:12:39 +0000 | [diff] [blame] | 204 | assert(NameRef.find_first_of(0) == StringRef::npos && |
| 205 | "Null bytes are not allowed in names"); |
Daniel Dunbar | d786b51 | 2009-07-26 00:34:27 +0000 | [diff] [blame] | 206 | |
Daniel Dunbar | a32c999 | 2009-07-26 00:42:33 +0000 | [diff] [blame] | 207 | // Name isn't changing? |
Benjamin Kramer | 2e06b93 | 2010-01-13 12:45:23 +0000 | [diff] [blame] | 208 | if (getName() == NameRef) |
Daniel Dunbar | a32c999 | 2009-07-26 00:42:33 +0000 | [diff] [blame] | 209 | return; |
| 210 | |
Benjamin Kramer | ccce8ba | 2010-01-05 13:12:22 +0000 | [diff] [blame] | 211 | assert(!getType()->isVoidTy() && "Cannot assign a name to void values!"); |
Daniel Dunbar | 6058b51 | 2009-09-20 04:03:34 +0000 | [diff] [blame] | 212 | |
Chris Lattner | ffb3778 | 2005-03-06 02:14:28 +0000 | [diff] [blame] | 213 | // Get the symbol table to update for this object. |
Chris Lattner | b625082 | 2007-02-11 00:37:27 +0000 | [diff] [blame] | 214 | ValueSymbolTable *ST; |
| 215 | if (getSymTab(this, ST)) |
| 216 | return; // Cannot set a name on this value (e.g. constant). |
Chris Lattner | cdb9bfc | 2005-03-05 19:51:50 +0000 | [diff] [blame] | 217 | |
Chris Lattner | 32ab643 | 2007-02-12 05:18:08 +0000 | [diff] [blame] | 218 | if (!ST) { // No symbol table to update? Just do the change. |
Benjamin Kramer | 2e06b93 | 2010-01-13 12:45:23 +0000 | [diff] [blame] | 219 | if (NameRef.empty()) { |
Chris Lattner | 32ab643 | 2007-02-12 05:18:08 +0000 | [diff] [blame] | 220 | // Free the name for this value. |
Duncan P. N. Exon Smith | 5bf8fef | 2014-12-09 18:38:53 +0000 | [diff] [blame] | 221 | destroyValueName(); |
Chris Lattner | 1a5de58 | 2007-02-12 18:52:59 +0000 | [diff] [blame] | 222 | return; |
Chris Lattner | ffb3778 | 2005-03-06 02:14:28 +0000 | [diff] [blame] | 223 | } |
Daniel Dunbar | 6058b51 | 2009-09-20 04:03:34 +0000 | [diff] [blame] | 224 | |
Chris Lattner | 1a5de58 | 2007-02-12 18:52:59 +0000 | [diff] [blame] | 225 | // NOTE: Could optimize for the case the name is shrinking to not deallocate |
| 226 | // then reallocated. |
Duncan P. N. Exon Smith | 5bf8fef | 2014-12-09 18:38:53 +0000 | [diff] [blame] | 227 | destroyValueName(); |
Daniel Dunbar | 6058b51 | 2009-09-20 04:03:34 +0000 | [diff] [blame] | 228 | |
Chris Lattner | 1a5de58 | 2007-02-12 18:52:59 +0000 | [diff] [blame] | 229 | // Create the new name. |
Duncan P. N. Exon Smith | 5bf8fef | 2014-12-09 18:38:53 +0000 | [diff] [blame] | 230 | setValueName(ValueName::Create(NameRef)); |
| 231 | getValueName()->setValue(this); |
Chris Lattner | 32ab643 | 2007-02-12 05:18:08 +0000 | [diff] [blame] | 232 | return; |
Chris Lattner | ffb3778 | 2005-03-06 02:14:28 +0000 | [diff] [blame] | 233 | } |
Daniel Dunbar | 6058b51 | 2009-09-20 04:03:34 +0000 | [diff] [blame] | 234 | |
Chris Lattner | 32ab643 | 2007-02-12 05:18:08 +0000 | [diff] [blame] | 235 | // NOTE: Could optimize for the case the name is shrinking to not deallocate |
| 236 | // then reallocated. |
| 237 | if (hasName()) { |
Chris Lattner | 32ab643 | 2007-02-12 05:18:08 +0000 | [diff] [blame] | 238 | // Remove old name. |
Duncan P. N. Exon Smith | 5bf8fef | 2014-12-09 18:38:53 +0000 | [diff] [blame] | 239 | ST->removeValueName(getValueName()); |
| 240 | destroyValueName(); |
Chris Lattner | 32ab643 | 2007-02-12 05:18:08 +0000 | [diff] [blame] | 241 | |
Benjamin Kramer | 2e06b93 | 2010-01-13 12:45:23 +0000 | [diff] [blame] | 242 | if (NameRef.empty()) |
Chris Lattner | 1a5de58 | 2007-02-12 18:52:59 +0000 | [diff] [blame] | 243 | return; |
Chris Lattner | 32ab643 | 2007-02-12 05:18:08 +0000 | [diff] [blame] | 244 | } |
| 245 | |
| 246 | // Name is changing to something new. |
Duncan P. N. Exon Smith | 5bf8fef | 2014-12-09 18:38:53 +0000 | [diff] [blame] | 247 | setValueName(ST->createValueName(NameRef, this)); |
Chris Lattner | cdb9bfc | 2005-03-05 19:51:50 +0000 | [diff] [blame] | 248 | } |
| 249 | |
Pete Cooper | a7c0c18 | 2015-05-19 00:24:26 +0000 | [diff] [blame] | 250 | void Value::setName(const Twine &NewName) { |
| 251 | setNameImpl(NewName); |
| 252 | if (Function *F = dyn_cast<Function>(this)) |
| 253 | F->recalculateIntrinsicID(); |
| 254 | } |
| 255 | |
Chris Lattner | b625082 | 2007-02-11 00:37:27 +0000 | [diff] [blame] | 256 | void Value::takeName(Value *V) { |
Craig Topper | c620761 | 2014-04-09 06:08:46 +0000 | [diff] [blame] | 257 | ValueSymbolTable *ST = nullptr; |
Chris Lattner | cf835ff | 2007-02-15 20:01:43 +0000 | [diff] [blame] | 258 | // If this value has a name, drop it. |
| 259 | if (hasName()) { |
| 260 | // Get the symtab this is in. |
| 261 | if (getSymTab(this, ST)) { |
| 262 | // We can't set a name on this value, but we need to clear V's name if |
| 263 | // it has one. |
Daniel Dunbar | d786b51 | 2009-07-26 00:34:27 +0000 | [diff] [blame] | 264 | if (V->hasName()) V->setName(""); |
Chris Lattner | cf835ff | 2007-02-15 20:01:43 +0000 | [diff] [blame] | 265 | return; // Cannot set a name on this value (e.g. constant). |
| 266 | } |
Daniel Dunbar | 6058b51 | 2009-09-20 04:03:34 +0000 | [diff] [blame] | 267 | |
Chris Lattner | cf835ff | 2007-02-15 20:01:43 +0000 | [diff] [blame] | 268 | // Remove old name. |
| 269 | if (ST) |
Duncan P. N. Exon Smith | 5bf8fef | 2014-12-09 18:38:53 +0000 | [diff] [blame] | 270 | ST->removeValueName(getValueName()); |
| 271 | destroyValueName(); |
Daniel Dunbar | 6058b51 | 2009-09-20 04:03:34 +0000 | [diff] [blame] | 272 | } |
| 273 | |
Chris Lattner | cf835ff | 2007-02-15 20:01:43 +0000 | [diff] [blame] | 274 | // Now we know that this has no name. |
Daniel Dunbar | 6058b51 | 2009-09-20 04:03:34 +0000 | [diff] [blame] | 275 | |
Chris Lattner | cf835ff | 2007-02-15 20:01:43 +0000 | [diff] [blame] | 276 | // If V has no name either, we're done. |
| 277 | if (!V->hasName()) return; |
Daniel Dunbar | 6058b51 | 2009-09-20 04:03:34 +0000 | [diff] [blame] | 278 | |
Chris Lattner | cf835ff | 2007-02-15 20:01:43 +0000 | [diff] [blame] | 279 | // Get this's symtab if we didn't before. |
| 280 | if (!ST) { |
| 281 | if (getSymTab(this, ST)) { |
| 282 | // Clear V's name. |
Daniel Dunbar | d786b51 | 2009-07-26 00:34:27 +0000 | [diff] [blame] | 283 | V->setName(""); |
Chris Lattner | cf835ff | 2007-02-15 20:01:43 +0000 | [diff] [blame] | 284 | return; // Cannot set a name on this value (e.g. constant). |
| 285 | } |
| 286 | } |
Daniel Dunbar | 6058b51 | 2009-09-20 04:03:34 +0000 | [diff] [blame] | 287 | |
Chris Lattner | cf835ff | 2007-02-15 20:01:43 +0000 | [diff] [blame] | 288 | // Get V's ST, this should always succed, because V has a name. |
| 289 | ValueSymbolTable *VST; |
| 290 | bool Failure = getSymTab(V, VST); |
Jeffrey Yasskin | 9b43f33 | 2010-12-23 00:58:24 +0000 | [diff] [blame] | 291 | assert(!Failure && "V has a name, so it should have a ST!"); (void)Failure; |
Daniel Dunbar | 6058b51 | 2009-09-20 04:03:34 +0000 | [diff] [blame] | 292 | |
Chris Lattner | cf835ff | 2007-02-15 20:01:43 +0000 | [diff] [blame] | 293 | // If these values are both in the same symtab, we can do this very fast. |
| 294 | // This works even if both values have no symtab yet. |
| 295 | if (ST == VST) { |
| 296 | // Take the name! |
Duncan P. N. Exon Smith | 5bf8fef | 2014-12-09 18:38:53 +0000 | [diff] [blame] | 297 | setValueName(V->getValueName()); |
| 298 | V->setValueName(nullptr); |
| 299 | getValueName()->setValue(this); |
Chris Lattner | cba18e3 | 2007-02-11 01:04:09 +0000 | [diff] [blame] | 300 | return; |
| 301 | } |
Daniel Dunbar | 6058b51 | 2009-09-20 04:03:34 +0000 | [diff] [blame] | 302 | |
Chris Lattner | cf835ff | 2007-02-15 20:01:43 +0000 | [diff] [blame] | 303 | // Otherwise, things are slightly more complex. Remove V's name from VST and |
| 304 | // then reinsert it into ST. |
Daniel Dunbar | 6058b51 | 2009-09-20 04:03:34 +0000 | [diff] [blame] | 305 | |
Chris Lattner | cf835ff | 2007-02-15 20:01:43 +0000 | [diff] [blame] | 306 | if (VST) |
Duncan P. N. Exon Smith | 5bf8fef | 2014-12-09 18:38:53 +0000 | [diff] [blame] | 307 | VST->removeValueName(V->getValueName()); |
| 308 | setValueName(V->getValueName()); |
| 309 | V->setValueName(nullptr); |
| 310 | getValueName()->setValue(this); |
Daniel Dunbar | 6058b51 | 2009-09-20 04:03:34 +0000 | [diff] [blame] | 311 | |
Chris Lattner | cf835ff | 2007-02-15 20:01:43 +0000 | [diff] [blame] | 312 | if (ST) |
| 313 | ST->reinsertValue(this); |
Chris Lattner | b625082 | 2007-02-11 00:37:27 +0000 | [diff] [blame] | 314 | } |
| 315 | |
Rafael Espindola | 7e2b756 | 2014-05-13 01:23:21 +0000 | [diff] [blame] | 316 | #ifndef NDEBUG |
Craig Topper | 71b7b68 | 2014-08-21 05:55:13 +0000 | [diff] [blame] | 317 | static bool contains(SmallPtrSetImpl<ConstantExpr *> &Cache, ConstantExpr *Expr, |
Rafael Espindola | 7e2b756 | 2014-05-13 01:23:21 +0000 | [diff] [blame] | 318 | Constant *C) { |
David Blaikie | 70573dc | 2014-11-19 07:49:26 +0000 | [diff] [blame] | 319 | if (!Cache.insert(Expr).second) |
Rafael Espindola | 7e2b756 | 2014-05-13 01:23:21 +0000 | [diff] [blame] | 320 | return false; |
| 321 | |
| 322 | for (auto &O : Expr->operands()) { |
| 323 | if (O == C) |
| 324 | return true; |
| 325 | auto *CE = dyn_cast<ConstantExpr>(O); |
| 326 | if (!CE) |
| 327 | continue; |
| 328 | if (contains(Cache, CE, C)) |
| 329 | return true; |
| 330 | } |
| 331 | return false; |
| 332 | } |
| 333 | |
| 334 | static bool contains(Value *Expr, Value *V) { |
| 335 | if (Expr == V) |
| 336 | return true; |
| 337 | |
| 338 | auto *C = dyn_cast<Constant>(V); |
| 339 | if (!C) |
| 340 | return false; |
| 341 | |
| 342 | auto *CE = dyn_cast<ConstantExpr>(Expr); |
| 343 | if (!CE) |
| 344 | return false; |
| 345 | |
| 346 | SmallPtrSet<ConstantExpr *, 4> Cache; |
| 347 | return contains(Cache, CE, C); |
| 348 | } |
| 349 | #endif |
Chris Lattner | b625082 | 2007-02-11 00:37:27 +0000 | [diff] [blame] | 350 | |
Chris Lattner | af1783f | 2011-07-15 06:18:52 +0000 | [diff] [blame] | 351 | void Value::replaceAllUsesWith(Value *New) { |
| 352 | assert(New && "Value::replaceAllUsesWith(<null>) is invalid!"); |
Rafael Espindola | 7e2b756 | 2014-05-13 01:23:21 +0000 | [diff] [blame] | 353 | assert(!contains(New, this) && |
| 354 | "this->replaceAllUsesWith(expr(this)) is NOT valid!"); |
Chris Lattner | af1783f | 2011-07-15 06:18:52 +0000 | [diff] [blame] | 355 | assert(New->getType() == getType() && |
| 356 | "replaceAllUses of value with new value of different type!"); |
| 357 | |
Chris Lattner | 90234f3 | 2009-03-31 22:11:05 +0000 | [diff] [blame] | 358 | // Notify all ValueHandles (if present) that this value is going away. |
| 359 | if (HasValueHandle) |
| 360 | ValueHandleBase::ValueIsRAUWd(this, New); |
Duncan P. N. Exon Smith | 5bf8fef | 2014-12-09 18:38:53 +0000 | [diff] [blame] | 361 | if (isUsedByMetadata()) |
| 362 | ValueAsMetadata::handleRAUW(this, New); |
Michael Ilseman | 516d703 | 2013-03-01 18:48:54 +0000 | [diff] [blame] | 363 | |
Chris Lattner | 4947e67 | 2005-02-01 01:24:21 +0000 | [diff] [blame] | 364 | while (!use_empty()) { |
Gabor Greif | 715b9d2 | 2008-09-19 15:13:20 +0000 | [diff] [blame] | 365 | Use &U = *UseList; |
Chris Lattner | 9f15812 | 2003-08-29 05:09:37 +0000 | [diff] [blame] | 366 | // Must handle Constants specially, we cannot call replaceUsesOfWith on a |
Chris Lattner | 8e5b2c2 | 2007-08-21 00:21:07 +0000 | [diff] [blame] | 367 | // constant because they are uniqued. |
Rafael Espindola | 6b23863 | 2014-05-16 19:35:39 +0000 | [diff] [blame] | 368 | if (auto *C = dyn_cast<Constant>(U.getUser())) { |
Chris Lattner | 8e5b2c2 | 2007-08-21 00:21:07 +0000 | [diff] [blame] | 369 | if (!isa<GlobalValue>(C)) { |
Pete Cooper | 5815b1f | 2015-06-24 18:55:24 +0000 | [diff] [blame] | 370 | C->handleOperandChange(this, New, &U); |
Chris Lattner | 8e5b2c2 | 2007-08-21 00:21:07 +0000 | [diff] [blame] | 371 | continue; |
| 372 | } |
Chris Lattner | 9f15812 | 2003-08-29 05:09:37 +0000 | [diff] [blame] | 373 | } |
Michael Ilseman | 516d703 | 2013-03-01 18:48:54 +0000 | [diff] [blame] | 374 | |
Chris Lattner | 8e5b2c2 | 2007-08-21 00:21:07 +0000 | [diff] [blame] | 375 | U.set(New); |
Chris Lattner | 9f15812 | 2003-08-29 05:09:37 +0000 | [diff] [blame] | 376 | } |
Michael Ilseman | 516d703 | 2013-03-01 18:48:54 +0000 | [diff] [blame] | 377 | |
Jay Foad | 61ea0e4 | 2011-06-23 09:09:15 +0000 | [diff] [blame] | 378 | if (BasicBlock *BB = dyn_cast<BasicBlock>(this)) |
| 379 | BB->replaceSuccessorsPhiUsesWith(cast<BasicBlock>(New)); |
Chris Lattner | 9f15812 | 2003-08-29 05:09:37 +0000 | [diff] [blame] | 380 | } |
| 381 | |
Gerolf Hoflehner | ec6217c | 2014-11-21 23:36:44 +0000 | [diff] [blame] | 382 | // Like replaceAllUsesWith except it does not handle constants or basic blocks. |
| 383 | // This routine leaves uses within BB. |
| 384 | void Value::replaceUsesOutsideBlock(Value *New, BasicBlock *BB) { |
| 385 | assert(New && "Value::replaceUsesOutsideBlock(<null>, BB) is invalid!"); |
| 386 | assert(!contains(New, this) && |
| 387 | "this->replaceUsesOutsideBlock(expr(this), BB) is NOT valid!"); |
| 388 | assert(New->getType() == getType() && |
| 389 | "replaceUses of value with new value of different type!"); |
| 390 | assert(BB && "Basic block that may contain a use of 'New' must be defined\n"); |
| 391 | |
| 392 | use_iterator UI = use_begin(), E = use_end(); |
| 393 | for (; UI != E;) { |
| 394 | Use &U = *UI; |
| 395 | ++UI; |
| 396 | auto *Usr = dyn_cast<Instruction>(U.getUser()); |
| 397 | if (Usr && Usr->getParent() == BB) |
| 398 | continue; |
| 399 | U.set(New); |
| 400 | } |
| 401 | return; |
| 402 | } |
| 403 | |
Chandler Carruth | 97f6f03 | 2012-03-10 08:39:09 +0000 | [diff] [blame] | 404 | namespace { |
| 405 | // Various metrics for how much to strip off of pointers. |
| 406 | enum PointerStripKind { |
| 407 | PSK_ZeroIndices, |
Rafael Espindola | c229a4f | 2013-05-06 01:48:55 +0000 | [diff] [blame] | 408 | PSK_ZeroIndicesAndAliases, |
Chandler Carruth | 4d1d34f | 2012-03-14 23:19:53 +0000 | [diff] [blame] | 409 | PSK_InBoundsConstantIndices, |
| 410 | PSK_InBounds |
Chandler Carruth | 97f6f03 | 2012-03-10 08:39:09 +0000 | [diff] [blame] | 411 | }; |
| 412 | |
| 413 | template <PointerStripKind StripKind> |
| 414 | static Value *stripPointerCastsAndOffsets(Value *V) { |
| 415 | if (!V->getType()->isPointerTy()) |
| 416 | return V; |
Dan Gohman | 7c34ece | 2010-06-28 21:16:52 +0000 | [diff] [blame] | 417 | |
| 418 | // Even though we don't look through PHI nodes, we could be called on an |
| 419 | // instruction in an unreachable block, which may be on a cycle. |
| 420 | SmallPtrSet<Value *, 4> Visited; |
| 421 | |
Dan Gohman | 7c34ece | 2010-06-28 21:16:52 +0000 | [diff] [blame] | 422 | Visited.insert(V); |
Duncan Sands | e59fa78 | 2008-12-29 21:06:19 +0000 | [diff] [blame] | 423 | do { |
Dan Gohman | e1019db | 2009-07-17 23:55:56 +0000 | [diff] [blame] | 424 | if (GEPOperator *GEP = dyn_cast<GEPOperator>(V)) { |
Chandler Carruth | 97f6f03 | 2012-03-10 08:39:09 +0000 | [diff] [blame] | 425 | switch (StripKind) { |
Rafael Espindola | c229a4f | 2013-05-06 01:48:55 +0000 | [diff] [blame] | 426 | case PSK_ZeroIndicesAndAliases: |
Chandler Carruth | 97f6f03 | 2012-03-10 08:39:09 +0000 | [diff] [blame] | 427 | case PSK_ZeroIndices: |
| 428 | if (!GEP->hasAllZeroIndices()) |
| 429 | return V; |
| 430 | break; |
Chandler Carruth | 4d1d34f | 2012-03-14 23:19:53 +0000 | [diff] [blame] | 431 | case PSK_InBoundsConstantIndices: |
Chandler Carruth | 97f6f03 | 2012-03-10 08:39:09 +0000 | [diff] [blame] | 432 | if (!GEP->hasAllConstantIndices()) |
| 433 | return V; |
Chandler Carruth | 4d1d34f | 2012-03-14 23:19:53 +0000 | [diff] [blame] | 434 | // fallthrough |
Chandler Carruth | 97f6f03 | 2012-03-10 08:39:09 +0000 | [diff] [blame] | 435 | case PSK_InBounds: |
| 436 | if (!GEP->isInBounds()) |
| 437 | return V; |
| 438 | break; |
Chandler Carruth | 97f6f03 | 2012-03-10 08:39:09 +0000 | [diff] [blame] | 439 | } |
Dan Gohman | e1019db | 2009-07-17 23:55:56 +0000 | [diff] [blame] | 440 | V = GEP->getPointerOperand(); |
Matt Arsenault | b03bd4d | 2013-11-15 01:34:59 +0000 | [diff] [blame] | 441 | } else if (Operator::getOpcode(V) == Instruction::BitCast || |
| 442 | Operator::getOpcode(V) == Instruction::AddrSpaceCast) { |
Dan Gohman | e1019db | 2009-07-17 23:55:56 +0000 | [diff] [blame] | 443 | V = cast<Operator>(V)->getOperand(0); |
Dan Gohman | 4ce5ade | 2009-08-27 17:55:13 +0000 | [diff] [blame] | 444 | } else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V)) { |
Rafael Espindola | c229a4f | 2013-05-06 01:48:55 +0000 | [diff] [blame] | 445 | if (StripKind == PSK_ZeroIndices || GA->mayBeOverridden()) |
Dan Gohman | 4ce5ade | 2009-08-27 17:55:13 +0000 | [diff] [blame] | 446 | return V; |
| 447 | V = GA->getAliasee(); |
Duncan Sands | e59fa78 | 2008-12-29 21:06:19 +0000 | [diff] [blame] | 448 | } else { |
| 449 | return V; |
Anton Korobeynikov | fc2edad | 2008-05-07 22:54:15 +0000 | [diff] [blame] | 450 | } |
Duncan Sands | 19d0b47 | 2010-02-16 11:11:14 +0000 | [diff] [blame] | 451 | assert(V->getType()->isPointerTy() && "Unexpected operand type!"); |
David Blaikie | 70573dc | 2014-11-19 07:49:26 +0000 | [diff] [blame] | 452 | } while (Visited.insert(V).second); |
Dan Gohman | 7c34ece | 2010-06-28 21:16:52 +0000 | [diff] [blame] | 453 | |
| 454 | return V; |
Anton Korobeynikov | fc2edad | 2008-05-07 22:54:15 +0000 | [diff] [blame] | 455 | } |
Chandler Carruth | 97f6f03 | 2012-03-10 08:39:09 +0000 | [diff] [blame] | 456 | } // namespace |
| 457 | |
| 458 | Value *Value::stripPointerCasts() { |
Rafael Espindola | c229a4f | 2013-05-06 01:48:55 +0000 | [diff] [blame] | 459 | return stripPointerCastsAndOffsets<PSK_ZeroIndicesAndAliases>(this); |
| 460 | } |
| 461 | |
| 462 | Value *Value::stripPointerCastsNoFollowAliases() { |
Chandler Carruth | 97f6f03 | 2012-03-10 08:39:09 +0000 | [diff] [blame] | 463 | return stripPointerCastsAndOffsets<PSK_ZeroIndices>(this); |
| 464 | } |
| 465 | |
Chandler Carruth | 4d1d34f | 2012-03-14 23:19:53 +0000 | [diff] [blame] | 466 | Value *Value::stripInBoundsConstantOffsets() { |
| 467 | return stripPointerCastsAndOffsets<PSK_InBoundsConstantIndices>(this); |
Chandler Carruth | 97f6f03 | 2012-03-10 08:39:09 +0000 | [diff] [blame] | 468 | } |
| 469 | |
Chandler Carruth | 989e630 | 2013-08-22 11:25:11 +0000 | [diff] [blame] | 470 | Value *Value::stripAndAccumulateInBoundsConstantOffsets(const DataLayout &DL, |
| 471 | APInt &Offset) { |
| 472 | if (!getType()->isPointerTy()) |
| 473 | return this; |
| 474 | |
| 475 | assert(Offset.getBitWidth() == DL.getPointerSizeInBits(cast<PointerType>( |
| 476 | getType())->getAddressSpace()) && |
| 477 | "The offset must have exactly as many bits as our pointer."); |
| 478 | |
| 479 | // Even though we don't look through PHI nodes, we could be called on an |
| 480 | // instruction in an unreachable block, which may be on a cycle. |
| 481 | SmallPtrSet<Value *, 4> Visited; |
| 482 | Visited.insert(this); |
| 483 | Value *V = this; |
| 484 | do { |
| 485 | if (GEPOperator *GEP = dyn_cast<GEPOperator>(V)) { |
| 486 | if (!GEP->isInBounds()) |
| 487 | return V; |
Chandler Carruth | ba689b3 | 2013-08-25 10:46:39 +0000 | [diff] [blame] | 488 | APInt GEPOffset(Offset); |
| 489 | if (!GEP->accumulateConstantOffset(DL, GEPOffset)) |
Chandler Carruth | 989e630 | 2013-08-22 11:25:11 +0000 | [diff] [blame] | 490 | return V; |
Chandler Carruth | ba689b3 | 2013-08-25 10:46:39 +0000 | [diff] [blame] | 491 | Offset = GEPOffset; |
Chandler Carruth | 989e630 | 2013-08-22 11:25:11 +0000 | [diff] [blame] | 492 | V = GEP->getPointerOperand(); |
Philip Reames | d63df510 | 2015-09-23 19:48:43 +0000 | [diff] [blame] | 493 | } else if (Operator::getOpcode(V) == Instruction::BitCast) { |
Chandler Carruth | 989e630 | 2013-08-22 11:25:11 +0000 | [diff] [blame] | 494 | V = cast<Operator>(V)->getOperand(0); |
| 495 | } else if (GlobalAlias *GA = dyn_cast<GlobalAlias>(V)) { |
| 496 | V = GA->getAliasee(); |
| 497 | } else { |
| 498 | return V; |
| 499 | } |
| 500 | assert(V->getType()->isPointerTy() && "Unexpected operand type!"); |
David Blaikie | 70573dc | 2014-11-19 07:49:26 +0000 | [diff] [blame] | 501 | } while (Visited.insert(V).second); |
Chandler Carruth | 989e630 | 2013-08-22 11:25:11 +0000 | [diff] [blame] | 502 | |
| 503 | return V; |
| 504 | } |
| 505 | |
Chandler Carruth | 97f6f03 | 2012-03-10 08:39:09 +0000 | [diff] [blame] | 506 | Value *Value::stripInBoundsOffsets() { |
| 507 | return stripPointerCastsAndOffsets<PSK_InBounds>(this); |
| 508 | } |
Anton Korobeynikov | fc2edad | 2008-05-07 22:54:15 +0000 | [diff] [blame] | 509 | |
Daniel Dunbar | 6058b51 | 2009-09-20 04:03:34 +0000 | [diff] [blame] | 510 | Value *Value::DoPHITranslation(const BasicBlock *CurBB, |
Chris Lattner | 9c1b502 | 2008-12-02 07:16:45 +0000 | [diff] [blame] | 511 | const BasicBlock *PredBB) { |
| 512 | PHINode *PN = dyn_cast<PHINode>(this); |
| 513 | if (PN && PN->getParent() == CurBB) |
| 514 | return PN->getIncomingValueForBlock(PredBB); |
| 515 | return this; |
| 516 | } |
| 517 | |
Owen Anderson | 47db941 | 2009-07-22 00:24:57 +0000 | [diff] [blame] | 518 | LLVMContext &Value::getContext() const { return VTy->getContext(); } |
| 519 | |
Duncan P. N. Exon Smith | 3441ffe | 2014-08-01 23:28:49 +0000 | [diff] [blame] | 520 | void Value::reverseUseList() { |
| 521 | if (!UseList || !UseList->Next) |
| 522 | // No need to reverse 0 or 1 uses. |
| 523 | return; |
| 524 | |
| 525 | Use *Head = UseList; |
| 526 | Use *Current = UseList->Next; |
| 527 | Head->Next = nullptr; |
| 528 | while (Current) { |
| 529 | Use *Next = Current->Next; |
| 530 | Current->Next = Head; |
| 531 | Head->setPrev(&Current->Next); |
| 532 | Head = Current; |
| 533 | Current = Next; |
| 534 | } |
| 535 | UseList = Head; |
| 536 | Head->setPrev(&UseList); |
| 537 | } |
| 538 | |
Chris Lattner | 90234f3 | 2009-03-31 22:11:05 +0000 | [diff] [blame] | 539 | //===----------------------------------------------------------------------===// |
| 540 | // ValueHandleBase Class |
| 541 | //===----------------------------------------------------------------------===// |
| 542 | |
Chris Lattner | 90234f3 | 2009-03-31 22:11:05 +0000 | [diff] [blame] | 543 | void ValueHandleBase::AddToExistingUseList(ValueHandleBase **List) { |
| 544 | assert(List && "Handle list is null?"); |
Daniel Dunbar | 6058b51 | 2009-09-20 04:03:34 +0000 | [diff] [blame] | 545 | |
Chris Lattner | 90234f3 | 2009-03-31 22:11:05 +0000 | [diff] [blame] | 546 | // Splice ourselves into the list. |
| 547 | Next = *List; |
| 548 | *List = this; |
| 549 | setPrevPtr(List); |
| 550 | if (Next) { |
| 551 | Next->setPrevPtr(&Next); |
Chandler Carruth | f4ea3d3 | 2015-01-09 00:48:47 +0000 | [diff] [blame] | 552 | assert(V == Next->V && "Added to wrong list?"); |
Chris Lattner | 90234f3 | 2009-03-31 22:11:05 +0000 | [diff] [blame] | 553 | } |
| 554 | } |
| 555 | |
Jeffrey Yasskin | 406ac81 | 2009-10-12 17:43:32 +0000 | [diff] [blame] | 556 | void ValueHandleBase::AddToExistingUseListAfter(ValueHandleBase *List) { |
| 557 | assert(List && "Must insert after existing node"); |
| 558 | |
| 559 | Next = List->Next; |
| 560 | setPrevPtr(&List->Next); |
| 561 | List->Next = this; |
| 562 | if (Next) |
| 563 | Next->setPrevPtr(&Next); |
| 564 | } |
| 565 | |
Chris Lattner | 90234f3 | 2009-03-31 22:11:05 +0000 | [diff] [blame] | 566 | void ValueHandleBase::AddToUseList() { |
Chandler Carruth | f4ea3d3 | 2015-01-09 00:48:47 +0000 | [diff] [blame] | 567 | assert(V && "Null pointer doesn't have a use list!"); |
Daniel Dunbar | 6058b51 | 2009-09-20 04:03:34 +0000 | [diff] [blame] | 568 | |
Chandler Carruth | f4ea3d3 | 2015-01-09 00:48:47 +0000 | [diff] [blame] | 569 | LLVMContextImpl *pImpl = V->getContext().pImpl; |
Daniel Dunbar | 6058b51 | 2009-09-20 04:03:34 +0000 | [diff] [blame] | 570 | |
Chandler Carruth | f4ea3d3 | 2015-01-09 00:48:47 +0000 | [diff] [blame] | 571 | if (V->HasValueHandle) { |
Chris Lattner | 90234f3 | 2009-03-31 22:11:05 +0000 | [diff] [blame] | 572 | // If this value already has a ValueHandle, then it must be in the |
| 573 | // ValueHandles map already. |
Chandler Carruth | f4ea3d3 | 2015-01-09 00:48:47 +0000 | [diff] [blame] | 574 | ValueHandleBase *&Entry = pImpl->ValueHandles[V]; |
Craig Topper | 2617dcc | 2014-04-15 06:32:26 +0000 | [diff] [blame] | 575 | assert(Entry && "Value doesn't have any handles?"); |
Owen Anderson | 4b660a8 | 2009-06-17 17:36:57 +0000 | [diff] [blame] | 576 | AddToExistingUseList(&Entry); |
Owen Anderson | 4b660a8 | 2009-06-17 17:36:57 +0000 | [diff] [blame] | 577 | return; |
Chris Lattner | 90234f3 | 2009-03-31 22:11:05 +0000 | [diff] [blame] | 578 | } |
Daniel Dunbar | 6058b51 | 2009-09-20 04:03:34 +0000 | [diff] [blame] | 579 | |
Chris Lattner | 90234f3 | 2009-03-31 22:11:05 +0000 | [diff] [blame] | 580 | // Ok, it doesn't have any handles yet, so we must insert it into the |
| 581 | // DenseMap. However, doing this insertion could cause the DenseMap to |
| 582 | // reallocate itself, which would invalidate all of the PrevP pointers that |
| 583 | // point into the old table. Handle this by checking for reallocation and |
| 584 | // updating the stale pointers only if needed. |
Owen Anderson | e8f2185 | 2009-08-18 18:28:58 +0000 | [diff] [blame] | 585 | DenseMap<Value*, ValueHandleBase*> &Handles = pImpl->ValueHandles; |
Chris Lattner | 90234f3 | 2009-03-31 22:11:05 +0000 | [diff] [blame] | 586 | const void *OldBucketPtr = Handles.getPointerIntoBucketsArray(); |
Daniel Dunbar | 6058b51 | 2009-09-20 04:03:34 +0000 | [diff] [blame] | 587 | |
Chandler Carruth | f4ea3d3 | 2015-01-09 00:48:47 +0000 | [diff] [blame] | 588 | ValueHandleBase *&Entry = Handles[V]; |
Craig Topper | 2617dcc | 2014-04-15 06:32:26 +0000 | [diff] [blame] | 589 | assert(!Entry && "Value really did already have handles?"); |
Chris Lattner | 90234f3 | 2009-03-31 22:11:05 +0000 | [diff] [blame] | 590 | AddToExistingUseList(&Entry); |
Chandler Carruth | f4ea3d3 | 2015-01-09 00:48:47 +0000 | [diff] [blame] | 591 | V->HasValueHandle = true; |
Daniel Dunbar | 6058b51 | 2009-09-20 04:03:34 +0000 | [diff] [blame] | 592 | |
Chris Lattner | 90234f3 | 2009-03-31 22:11:05 +0000 | [diff] [blame] | 593 | // If reallocation didn't happen or if this was the first insertion, don't |
| 594 | // walk the table. |
Daniel Dunbar | 6058b51 | 2009-09-20 04:03:34 +0000 | [diff] [blame] | 595 | if (Handles.isPointerIntoBucketsArray(OldBucketPtr) || |
Owen Anderson | 4b660a8 | 2009-06-17 17:36:57 +0000 | [diff] [blame] | 596 | Handles.size() == 1) { |
Chris Lattner | 90234f3 | 2009-03-31 22:11:05 +0000 | [diff] [blame] | 597 | return; |
Owen Anderson | 4b660a8 | 2009-06-17 17:36:57 +0000 | [diff] [blame] | 598 | } |
Daniel Dunbar | 6058b51 | 2009-09-20 04:03:34 +0000 | [diff] [blame] | 599 | |
Chris Lattner | 90234f3 | 2009-03-31 22:11:05 +0000 | [diff] [blame] | 600 | // Okay, reallocation did happen. Fix the Prev Pointers. |
Owen Anderson | e8f2185 | 2009-08-18 18:28:58 +0000 | [diff] [blame] | 601 | for (DenseMap<Value*, ValueHandleBase*>::iterator I = Handles.begin(), |
| 602 | E = Handles.end(); I != E; ++I) { |
Chandler Carruth | f4ea3d3 | 2015-01-09 00:48:47 +0000 | [diff] [blame] | 603 | assert(I->second && I->first == I->second->V && |
Bill Wendling | 9b2503a | 2012-04-08 10:16:43 +0000 | [diff] [blame] | 604 | "List invariant broken!"); |
Chris Lattner | 90234f3 | 2009-03-31 22:11:05 +0000 | [diff] [blame] | 605 | I->second->setPrevPtr(&I->second); |
| 606 | } |
| 607 | } |
| 608 | |
Chris Lattner | 90234f3 | 2009-03-31 22:11:05 +0000 | [diff] [blame] | 609 | void ValueHandleBase::RemoveFromUseList() { |
Chandler Carruth | f4ea3d3 | 2015-01-09 00:48:47 +0000 | [diff] [blame] | 610 | assert(V && V->HasValueHandle && |
Bill Wendling | 9b2503a | 2012-04-08 10:16:43 +0000 | [diff] [blame] | 611 | "Pointer doesn't have a use list!"); |
Chris Lattner | 90234f3 | 2009-03-31 22:11:05 +0000 | [diff] [blame] | 612 | |
| 613 | // Unlink this from its use list. |
| 614 | ValueHandleBase **PrevPtr = getPrevPtr(); |
| 615 | assert(*PrevPtr == this && "List invariant broken"); |
Daniel Dunbar | 6058b51 | 2009-09-20 04:03:34 +0000 | [diff] [blame] | 616 | |
Chris Lattner | 90234f3 | 2009-03-31 22:11:05 +0000 | [diff] [blame] | 617 | *PrevPtr = Next; |
| 618 | if (Next) { |
| 619 | assert(Next->getPrevPtr() == &Next && "List invariant broken"); |
| 620 | Next->setPrevPtr(PrevPtr); |
| 621 | return; |
| 622 | } |
Daniel Dunbar | 6058b51 | 2009-09-20 04:03:34 +0000 | [diff] [blame] | 623 | |
Chris Lattner | 90234f3 | 2009-03-31 22:11:05 +0000 | [diff] [blame] | 624 | // If the Next pointer was null, then it is possible that this was the last |
| 625 | // ValueHandle watching VP. If so, delete its entry from the ValueHandles |
| 626 | // map. |
Chandler Carruth | f4ea3d3 | 2015-01-09 00:48:47 +0000 | [diff] [blame] | 627 | LLVMContextImpl *pImpl = V->getContext().pImpl; |
Owen Anderson | e8f2185 | 2009-08-18 18:28:58 +0000 | [diff] [blame] | 628 | DenseMap<Value*, ValueHandleBase*> &Handles = pImpl->ValueHandles; |
Chris Lattner | 90234f3 | 2009-03-31 22:11:05 +0000 | [diff] [blame] | 629 | if (Handles.isPointerIntoBucketsArray(PrevPtr)) { |
Chandler Carruth | f4ea3d3 | 2015-01-09 00:48:47 +0000 | [diff] [blame] | 630 | Handles.erase(V); |
| 631 | V->HasValueHandle = false; |
Chris Lattner | 90234f3 | 2009-03-31 22:11:05 +0000 | [diff] [blame] | 632 | } |
| 633 | } |
| 634 | |
| 635 | |
| 636 | void ValueHandleBase::ValueIsDeleted(Value *V) { |
| 637 | assert(V->HasValueHandle && "Should only be called if ValueHandles present"); |
| 638 | |
| 639 | // Get the linked list base, which is guaranteed to exist since the |
| 640 | // HasValueHandle flag is set. |
Owen Anderson | e8f2185 | 2009-08-18 18:28:58 +0000 | [diff] [blame] | 641 | LLVMContextImpl *pImpl = V->getContext().pImpl; |
| 642 | ValueHandleBase *Entry = pImpl->ValueHandles[V]; |
Chris Lattner | 90234f3 | 2009-03-31 22:11:05 +0000 | [diff] [blame] | 643 | assert(Entry && "Value bit set but no entries exist"); |
Daniel Dunbar | 6058b51 | 2009-09-20 04:03:34 +0000 | [diff] [blame] | 644 | |
Duncan Sands | 3bc93c2 | 2010-07-24 12:09:22 +0000 | [diff] [blame] | 645 | // We use a local ValueHandleBase as an iterator so that ValueHandles can add |
| 646 | // and remove themselves from the list without breaking our iteration. This |
| 647 | // is not really an AssertingVH; we just have to give ValueHandleBase a kind. |
| 648 | // Note that we deliberately do not the support the case when dropping a value |
| 649 | // handle results in a new value handle being permanently added to the list |
| 650 | // (as might occur in theory for CallbackVH's): the new value handle will not |
Duncan Sands | fd5c832 | 2010-07-27 06:53:14 +0000 | [diff] [blame] | 651 | // be processed and the checking code will mete out righteous punishment if |
Duncan Sands | 3bc93c2 | 2010-07-24 12:09:22 +0000 | [diff] [blame] | 652 | // the handle is still present once we have finished processing all the other |
| 653 | // value handles (it is fine to momentarily add then remove a value handle). |
Jeffrey Yasskin | 406ac81 | 2009-10-12 17:43:32 +0000 | [diff] [blame] | 654 | for (ValueHandleBase Iterator(Assert, *Entry); Entry; Entry = Iterator.Next) { |
| 655 | Iterator.RemoveFromUseList(); |
| 656 | Iterator.AddToExistingUseListAfter(Entry); |
| 657 | assert(Entry->Next == &Iterator && "Loop invariant broken."); |
Daniel Dunbar | 6058b51 | 2009-09-20 04:03:34 +0000 | [diff] [blame] | 658 | |
Jeffrey Yasskin | 406ac81 | 2009-10-12 17:43:32 +0000 | [diff] [blame] | 659 | switch (Entry->getKind()) { |
Chris Lattner | 90234f3 | 2009-03-31 22:11:05 +0000 | [diff] [blame] | 660 | case Assert: |
Jeffrey Yasskin | 406ac81 | 2009-10-12 17:43:32 +0000 | [diff] [blame] | 661 | break; |
Daniel Dunbar | 70d4fb0 | 2009-09-22 02:02:33 +0000 | [diff] [blame] | 662 | case Tracking: |
| 663 | // Mark that this value has been deleted by setting it to an invalid Value |
| 664 | // pointer. |
Jeffrey Yasskin | 406ac81 | 2009-10-12 17:43:32 +0000 | [diff] [blame] | 665 | Entry->operator=(DenseMapInfo<Value *>::getTombstoneKey()); |
Daniel Dunbar | 70d4fb0 | 2009-09-22 02:02:33 +0000 | [diff] [blame] | 666 | break; |
Chris Lattner | 90234f3 | 2009-03-31 22:11:05 +0000 | [diff] [blame] | 667 | case Weak: |
| 668 | // Weak just goes to null, which will unlink it from the list. |
Craig Topper | c620761 | 2014-04-09 06:08:46 +0000 | [diff] [blame] | 669 | Entry->operator=(nullptr); |
Chris Lattner | 90234f3 | 2009-03-31 22:11:05 +0000 | [diff] [blame] | 670 | break; |
| 671 | case Callback: |
Dan Gohman | 745ad44 | 2009-05-02 21:10:48 +0000 | [diff] [blame] | 672 | // Forward to the subclass's implementation. |
Jeffrey Yasskin | 406ac81 | 2009-10-12 17:43:32 +0000 | [diff] [blame] | 673 | static_cast<CallbackVH*>(Entry)->deleted(); |
Dan Gohman | 745ad44 | 2009-05-02 21:10:48 +0000 | [diff] [blame] | 674 | break; |
Chris Lattner | 90234f3 | 2009-03-31 22:11:05 +0000 | [diff] [blame] | 675 | } |
| 676 | } |
Daniel Dunbar | 6058b51 | 2009-09-20 04:03:34 +0000 | [diff] [blame] | 677 | |
Jeffrey Yasskin | 406ac81 | 2009-10-12 17:43:32 +0000 | [diff] [blame] | 678 | // All callbacks, weak references, and assertingVHs should be dropped by now. |
| 679 | if (V->HasValueHandle) { |
| 680 | #ifndef NDEBUG // Only in +Asserts mode... |
Benjamin Kramer | 1f97a5a | 2011-11-15 16:27:03 +0000 | [diff] [blame] | 681 | dbgs() << "While deleting: " << *V->getType() << " %" << V->getName() |
Jeffrey Yasskin | 406ac81 | 2009-10-12 17:43:32 +0000 | [diff] [blame] | 682 | << "\n"; |
| 683 | if (pImpl->ValueHandles[V]->getKind() == Assert) |
| 684 | llvm_unreachable("An asserting value handle still pointed to this" |
| 685 | " value!"); |
| 686 | |
| 687 | #endif |
| 688 | llvm_unreachable("All references to V were not removed?"); |
| 689 | } |
Chris Lattner | 90234f3 | 2009-03-31 22:11:05 +0000 | [diff] [blame] | 690 | } |
| 691 | |
| 692 | |
| 693 | void ValueHandleBase::ValueIsRAUWd(Value *Old, Value *New) { |
| 694 | assert(Old->HasValueHandle &&"Should only be called if ValueHandles present"); |
| 695 | assert(Old != New && "Changing value into itself!"); |
Frederic Riss | c1892e2 | 2014-10-23 04:08:42 +0000 | [diff] [blame] | 696 | assert(Old->getType() == New->getType() && |
| 697 | "replaceAllUses of value with new value of different type!"); |
Daniel Dunbar | 6058b51 | 2009-09-20 04:03:34 +0000 | [diff] [blame] | 698 | |
Chris Lattner | 90234f3 | 2009-03-31 22:11:05 +0000 | [diff] [blame] | 699 | // Get the linked list base, which is guaranteed to exist since the |
| 700 | // HasValueHandle flag is set. |
Owen Anderson | e8f2185 | 2009-08-18 18:28:58 +0000 | [diff] [blame] | 701 | LLVMContextImpl *pImpl = Old->getContext().pImpl; |
| 702 | ValueHandleBase *Entry = pImpl->ValueHandles[Old]; |
| 703 | |
Chris Lattner | 90234f3 | 2009-03-31 22:11:05 +0000 | [diff] [blame] | 704 | assert(Entry && "Value bit set but no entries exist"); |
Daniel Dunbar | 6058b51 | 2009-09-20 04:03:34 +0000 | [diff] [blame] | 705 | |
Jeffrey Yasskin | 406ac81 | 2009-10-12 17:43:32 +0000 | [diff] [blame] | 706 | // We use a local ValueHandleBase as an iterator so that |
| 707 | // ValueHandles can add and remove themselves from the list without |
| 708 | // breaking our iteration. This is not really an AssertingVH; we |
| 709 | // just have to give ValueHandleBase some kind. |
| 710 | for (ValueHandleBase Iterator(Assert, *Entry); Entry; Entry = Iterator.Next) { |
| 711 | Iterator.RemoveFromUseList(); |
| 712 | Iterator.AddToExistingUseListAfter(Entry); |
| 713 | assert(Entry->Next == &Iterator && "Loop invariant broken."); |
Daniel Dunbar | 6058b51 | 2009-09-20 04:03:34 +0000 | [diff] [blame] | 714 | |
Jeffrey Yasskin | 406ac81 | 2009-10-12 17:43:32 +0000 | [diff] [blame] | 715 | switch (Entry->getKind()) { |
Chris Lattner | 90234f3 | 2009-03-31 22:11:05 +0000 | [diff] [blame] | 716 | case Assert: |
| 717 | // Asserting handle does not follow RAUW implicitly. |
| 718 | break; |
Daniel Dunbar | 70d4fb0 | 2009-09-22 02:02:33 +0000 | [diff] [blame] | 719 | case Tracking: |
| 720 | // Tracking goes to new value like a WeakVH. Note that this may make it |
| 721 | // something incompatible with its templated type. We don't want to have a |
| 722 | // virtual (or inline) interface to handle this though, so instead we make |
Daniel Dunbar | 86707c9 | 2009-09-22 10:30:34 +0000 | [diff] [blame] | 723 | // the TrackingVH accessors guarantee that a client never sees this value. |
Daniel Dunbar | 70d4fb0 | 2009-09-22 02:02:33 +0000 | [diff] [blame] | 724 | |
| 725 | // FALLTHROUGH |
Chris Lattner | 90234f3 | 2009-03-31 22:11:05 +0000 | [diff] [blame] | 726 | case Weak: |
| 727 | // Weak goes to the new value, which will unlink it from Old's list. |
Jeffrey Yasskin | 406ac81 | 2009-10-12 17:43:32 +0000 | [diff] [blame] | 728 | Entry->operator=(New); |
Chris Lattner | 90234f3 | 2009-03-31 22:11:05 +0000 | [diff] [blame] | 729 | break; |
| 730 | case Callback: |
Dan Gohman | 745ad44 | 2009-05-02 21:10:48 +0000 | [diff] [blame] | 731 | // Forward to the subclass's implementation. |
Jeffrey Yasskin | 406ac81 | 2009-10-12 17:43:32 +0000 | [diff] [blame] | 732 | static_cast<CallbackVH*>(Entry)->allUsesReplacedWith(New); |
Dan Gohman | 745ad44 | 2009-05-02 21:10:48 +0000 | [diff] [blame] | 733 | break; |
Chris Lattner | 90234f3 | 2009-03-31 22:11:05 +0000 | [diff] [blame] | 734 | } |
| 735 | } |
Duncan Sands | fd5c832 | 2010-07-27 06:53:14 +0000 | [diff] [blame] | 736 | |
| 737 | #ifndef NDEBUG |
| 738 | // If any new tracking or weak value handles were added while processing the |
| 739 | // list, then complain about it now. |
| 740 | if (Old->HasValueHandle) |
| 741 | for (Entry = pImpl->ValueHandles[Old]; Entry; Entry = Entry->Next) |
| 742 | switch (Entry->getKind()) { |
| 743 | case Tracking: |
| 744 | case Weak: |
| 745 | dbgs() << "After RAUW from " << *Old->getType() << " %" |
Benjamin Kramer | 1f97a5a | 2011-11-15 16:27:03 +0000 | [diff] [blame] | 746 | << Old->getName() << " to " << *New->getType() << " %" |
| 747 | << New->getName() << "\n"; |
Duncan Sands | fd5c832 | 2010-07-27 06:53:14 +0000 | [diff] [blame] | 748 | llvm_unreachable("A tracking or weak value handle still pointed to the" |
| 749 | " old value!\n"); |
| 750 | default: |
| 751 | break; |
| 752 | } |
| 753 | #endif |
Chris Lattner | 90234f3 | 2009-03-31 22:11:05 +0000 | [diff] [blame] | 754 | } |
| 755 | |
Juergen Ributzka | d12ccbd | 2013-11-19 00:57:56 +0000 | [diff] [blame] | 756 | // Pin the vtable to this file. |
| 757 | void CallbackVH::anchor() {} |