1
//===-- Metadata.cpp - Implement Metadata classes -------------------------===//
3
// The LLVM Compiler Infrastructure
5
// This file is distributed under the University of Illinois Open Source
6
// License. See LICENSE.TXT for details.
8
//===----------------------------------------------------------------------===//
10
// This file implements the Metadata classes.
12
//===----------------------------------------------------------------------===//
14
#include "llvm/Metadata.h"
15
#include "LLVMContextImpl.h"
16
#include "llvm/LLVMContext.h"
17
#include "llvm/Module.h"
18
#include "llvm/Instruction.h"
19
#include "llvm/ADT/DenseMap.h"
20
#include "llvm/ADT/StringMap.h"
21
#include "llvm/ADT/SmallString.h"
22
#include "SymbolTableListTraitsImpl.h"
23
#include "llvm/Support/ValueHandle.h"
26
//===----------------------------------------------------------------------===//
27
// MDString implementation.
30
MDString::MDString(LLVMContext &C, StringRef S)
31
: Value(Type::getMetadataTy(C), Value::MDStringVal), Str(S) {}
33
MDString *MDString::get(LLVMContext &Context, StringRef Str) {
34
LLVMContextImpl *pImpl = Context.pImpl;
35
StringMapEntry<MDString *> &Entry =
36
pImpl->MDStringCache.GetOrCreateValue(Str);
37
MDString *&S = Entry.getValue();
38
if (!S) S = new MDString(Context, Entry.getKey());
42
MDString *MDString::get(LLVMContext &Context, const char *Str) {
43
LLVMContextImpl *pImpl = Context.pImpl;
44
StringMapEntry<MDString *> &Entry =
45
pImpl->MDStringCache.GetOrCreateValue(Str ? StringRef(Str) : StringRef());
46
MDString *&S = Entry.getValue();
47
if (!S) S = new MDString(Context, Entry.getKey());
51
//===----------------------------------------------------------------------===//
52
// MDNodeOperand implementation.
55
// Use CallbackVH to hold MDNode operands.
57
class MDNodeOperand : public CallbackVH {
60
MDNodeOperand(Value *V, MDNode *P) : CallbackVH(V), Parent(P) {}
67
virtual void deleted();
68
virtual void allUsesReplacedWith(Value *NV);
70
} // end namespace llvm.
73
void MDNodeOperand::deleted() {
74
Parent->replaceOperand(this, 0);
77
void MDNodeOperand::allUsesReplacedWith(Value *NV) {
78
Parent->replaceOperand(this, NV);
83
//===----------------------------------------------------------------------===//
84
// MDNode implementation.
87
/// getOperandPtr - Helper function to get the MDNodeOperand's coallocated on
88
/// the end of the MDNode.
89
static MDNodeOperand *getOperandPtr(MDNode *N, unsigned Op) {
90
assert(Op < N->getNumOperands() && "Invalid operand number");
91
return reinterpret_cast<MDNodeOperand*>(N+1)+Op;
94
MDNode::MDNode(LLVMContext &C, Value *const *Vals, unsigned NumVals,
96
: Value(Type::getMetadataTy(C), Value::MDNodeVal) {
97
NumOperands = NumVals;
100
setValueSubclassData(getSubclassDataFromValue() | FunctionLocalBit);
102
// Initialize the operand list, which is co-allocated on the end of the node.
103
for (MDNodeOperand *Op = getOperandPtr(this, 0), *E = Op+NumOperands;
104
Op != E; ++Op, ++Vals)
105
new (Op) MDNodeOperand(*Vals, this);
109
/// ~MDNode - Destroy MDNode.
111
assert((getSubclassDataFromValue() & DestroyFlag) != 0 &&
112
"Not being destroyed through destroy()?");
113
if (!isNotUniqued()) {
114
LLVMContextImpl *pImpl = getType()->getContext().pImpl;
115
pImpl->MDNodeSet.RemoveNode(this);
118
// Destroy the operands.
119
for (MDNodeOperand *Op = getOperandPtr(this, 0), *E = Op+NumOperands;
121
Op->~MDNodeOperand();
124
static const Function *getFunctionForValue(Value *V) {
125
assert(!isa<MDNode>(V) && "does not iterate over metadata operands");
127
if (Instruction *I = dyn_cast<Instruction>(V))
128
return I->getParent()->getParent();
129
if (BasicBlock *BB = dyn_cast<BasicBlock>(V))
130
return BB->getParent();
131
if (Argument *A = dyn_cast<Argument>(V))
132
return A->getParent();
137
static const Function *assertLocalFunction(const MDNode *N) {
138
if (!N->isFunctionLocal()) return 0;
140
const Function *F = 0, *NewF = 0;
141
for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
142
if (Value *V = N->getOperand(i)) {
143
if (MDNode *MD = dyn_cast<MDNode>(V))
144
NewF = assertLocalFunction(MD);
146
NewF = getFunctionForValue(V);
151
assert((NewF == 0 || F == NewF) &&"inconsistent function-local metadata");
157
// getFunction - If this metadata is function-local and recursively has a
158
// function-local operand, return the first such operand's parent function.
159
// Otherwise, return null. getFunction() should not be used for performance-
160
// critical code because it recursively visits all the MDNode's operands.
161
const Function *MDNode::getFunction() const {
163
return assertLocalFunction(this);
165
if (!isFunctionLocal()) return NULL;
167
for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
168
if (Value *V = getOperand(i)) {
169
if (MDNode *MD = dyn_cast<MDNode>(V)) {
170
if (const Function *F = MD->getFunction())
173
return getFunctionForValue(V);
180
// destroy - Delete this node. Only when there are no uses.
181
void MDNode::destroy() {
182
setValueSubclassData(getSubclassDataFromValue() | DestroyFlag);
183
// Placement delete, the free the memory.
188
MDNode *MDNode::getMDNode(LLVMContext &Context, Value *const *Vals,
189
unsigned NumVals, FunctionLocalness FL,
191
LLVMContextImpl *pImpl = Context.pImpl;
193
for (unsigned i = 0; i != NumVals; ++i)
194
ID.AddPointer(Vals[i]);
199
if ((N = pImpl->MDNodeSet.FindNodeOrInsertPos(ID, InsertPoint)))
205
bool isFunctionLocal = false;
208
for (unsigned i = 0; i != NumVals; ++i) {
211
if (isa<Instruction>(V) || isa<Argument>(V) || isa<BasicBlock>(V) ||
212
(isa<MDNode>(V) && cast<MDNode>(V)->isFunctionLocal())) {
213
isFunctionLocal = true;
219
isFunctionLocal = false;
222
isFunctionLocal = true;
226
// Coallocate space for the node and Operands together, then placement new.
227
void *Ptr = malloc(sizeof(MDNode)+NumVals*sizeof(MDNodeOperand));
228
N = new (Ptr) MDNode(Context, Vals, NumVals, isFunctionLocal);
230
// InsertPoint will have been set by the FindNodeOrInsertPos call.
231
pImpl->MDNodeSet.InsertNode(N, InsertPoint);
236
MDNode *MDNode::get(LLVMContext &Context, Value*const* Vals, unsigned NumVals) {
237
return getMDNode(Context, Vals, NumVals, FL_Unknown);
240
MDNode *MDNode::getWhenValsUnresolved(LLVMContext &Context, Value *const *Vals,
241
unsigned NumVals, bool isFunctionLocal) {
242
return getMDNode(Context, Vals, NumVals, isFunctionLocal ? FL_Yes : FL_No);
245
MDNode *MDNode::getIfExists(LLVMContext &Context, Value *const *Vals,
247
return getMDNode(Context, Vals, NumVals, FL_Unknown, false);
250
/// getOperand - Return specified operand.
251
Value *MDNode::getOperand(unsigned i) const {
252
return *getOperandPtr(const_cast<MDNode*>(this), i);
255
void MDNode::Profile(FoldingSetNodeID &ID) const {
256
for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
257
ID.AddPointer(getOperand(i));
260
// replaceAllOperandsWithNull - This is used while destroying llvm context to
261
// gracefully delete all nodes. This method replaces all operands with null.
262
void MDNode::replaceAllOperandsWithNull() {
263
for (MDNodeOperand *Op = getOperandPtr(this, 0), *E = Op+NumOperands;
265
replaceOperand(Op, 0);
268
// Replace value from this node's operand list.
269
void MDNode::replaceOperand(MDNodeOperand *Op, Value *To) {
275
// Update the operand.
278
// If this node is already not being uniqued (because one of the operands
279
// already went to null), then there is nothing else to do here.
280
if (isNotUniqued()) return;
282
LLVMContextImpl *pImpl = getType()->getContext().pImpl;
284
// Remove "this" from the context map. FoldingSet doesn't have to reprofile
285
// this node to remove it, so we don't care what state the operands are in.
286
pImpl->MDNodeSet.RemoveNode(this);
288
// If we are dropping an argument to null, we choose to not unique the MDNode
289
// anymore. This commonly occurs during destruction, and uniquing these
290
// brings little reuse.
296
// Now that the node is out of the folding set, get ready to reinsert it.
297
// First, check to see if another node with the same operands already exists
298
// in the set. If it doesn't exist, this returns the position to insert it.
302
MDNode *N = pImpl->MDNodeSet.FindNodeOrInsertPos(ID, InsertPoint);
305
N->replaceAllUsesWith(this);
307
N = pImpl->MDNodeSet.FindNodeOrInsertPos(ID, InsertPoint);
308
assert(N == 0 && "shouldn't be in the map now!"); (void)N;
311
// InsertPoint will have been set by the FindNodeOrInsertPos call.
312
pImpl->MDNodeSet.InsertNode(this, InsertPoint);
315
//===----------------------------------------------------------------------===//
316
// NamedMDNode implementation.
320
// SymbolTableListTraits specialization for MDSymbolTable.
321
void ilist_traits<NamedMDNode>
322
::addNodeToList(NamedMDNode *N) {
323
assert(N->getParent() == 0 && "Value already in a container!!");
324
Module *Owner = getListOwner();
326
MDSymbolTable &ST = Owner->getMDSymbolTable();
327
ST.insert(N->getName(), N);
330
void ilist_traits<NamedMDNode>::removeNodeFromList(NamedMDNode *N) {
332
Module *Owner = getListOwner();
333
MDSymbolTable &ST = Owner->getMDSymbolTable();
334
ST.remove(N->getName());
338
static SmallVector<WeakVH, 4> &getNMDOps(void *Operands) {
339
return *(SmallVector<WeakVH, 4>*)Operands;
342
NamedMDNode::NamedMDNode(LLVMContext &C, const Twine &N,
344
unsigned NumMDs, Module *ParentModule)
345
: Value(Type::getMetadataTy(C), Value::NamedMDNodeVal), Parent(0) {
347
Operands = new SmallVector<WeakVH, 4>();
349
SmallVector<WeakVH, 4> &Node = getNMDOps(Operands);
350
for (unsigned i = 0; i != NumMDs; ++i)
351
Node.push_back(WeakVH(MDs[i]));
354
ParentModule->getNamedMDList().push_back(this);
357
NamedMDNode *NamedMDNode::Create(const NamedMDNode *NMD, Module *M) {
358
assert(NMD && "Invalid source NamedMDNode!");
359
SmallVector<MDNode *, 4> Elems;
360
Elems.reserve(NMD->getNumOperands());
362
for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
363
Elems.push_back(NMD->getOperand(i));
364
return new NamedMDNode(NMD->getContext(), NMD->getName().data(),
365
Elems.data(), Elems.size(), M);
368
NamedMDNode::~NamedMDNode() {
370
delete &getNMDOps(Operands);
373
/// getNumOperands - Return number of NamedMDNode operands.
374
unsigned NamedMDNode::getNumOperands() const {
375
return (unsigned)getNMDOps(Operands).size();
378
/// getOperand - Return specified operand.
379
MDNode *NamedMDNode::getOperand(unsigned i) const {
380
assert(i < getNumOperands() && "Invalid Operand number!");
381
return dyn_cast_or_null<MDNode>(getNMDOps(Operands)[i]);
384
/// addOperand - Add metadata Operand.
385
void NamedMDNode::addOperand(MDNode *M) {
386
getNMDOps(Operands).push_back(WeakVH(M));
389
/// eraseFromParent - Drop all references and remove the node from parent
391
void NamedMDNode::eraseFromParent() {
392
getParent()->getNamedMDList().erase(this);
395
/// dropAllReferences - Remove all uses and clear node vector.
396
void NamedMDNode::dropAllReferences() {
397
getNMDOps(Operands).clear();
400
/// setName - Set the name of this named metadata.
401
void NamedMDNode::setName(const Twine &NewName) {
402
assert (!NewName.isTriviallyEmpty() && "Invalid named metadata name!");
404
SmallString<256> NameData;
405
StringRef NameRef = NewName.toStringRef(NameData);
407
// Name isn't changing?
408
if (getName() == NameRef)
411
Name = NameRef.str();
413
Parent->getMDSymbolTable().insert(NameRef, this);
416
/// getName - Return a constant reference to this named metadata's name.
417
StringRef NamedMDNode::getName() const {
418
return StringRef(Name);
421
//===----------------------------------------------------------------------===//
422
// LLVMContext MDKind naming implementation.
426
/// isValidName - Return true if Name is a valid custom metadata handler name.
427
static bool isValidName(StringRef MDName) {
431
if (!isalpha(MDName[0]))
434
for (StringRef::iterator I = MDName.begin() + 1, E = MDName.end(); I != E;
436
if (!isalnum(*I) && *I != '_' && *I != '-' && *I != '.')
443
/// getMDKindID - Return a unique non-zero ID for the specified metadata kind.
444
unsigned LLVMContext::getMDKindID(StringRef Name) const {
445
assert(isValidName(Name) && "Invalid MDNode name");
447
unsigned &Entry = pImpl->CustomMDKindNames[Name];
449
// If this is new, assign it its ID.
450
if (Entry == 0) Entry = pImpl->CustomMDKindNames.size();
454
/// getHandlerNames - Populate client supplied smallvector using custome
455
/// metadata name and ID.
456
void LLVMContext::getMDKindNames(SmallVectorImpl<StringRef> &Names) const {
457
Names.resize(pImpl->CustomMDKindNames.size()+1);
459
for (StringMap<unsigned>::const_iterator I = pImpl->CustomMDKindNames.begin(),
460
E = pImpl->CustomMDKindNames.end(); I != E; ++I)
461
// MD Handlers are numbered from 1.
462
Names[I->second] = I->first();
465
//===----------------------------------------------------------------------===//
466
// Instruction Metadata method implementations.
469
void Instruction::setMetadata(const char *Kind, MDNode *Node) {
470
if (Node == 0 && !hasMetadata()) return;
471
setMetadata(getContext().getMDKindID(Kind), Node);
474
MDNode *Instruction::getMetadataImpl(const char *Kind) const {
475
return getMetadataImpl(getContext().getMDKindID(Kind));
478
/// setMetadata - Set the metadata of of the specified kind to the specified
479
/// node. This updates/replaces metadata if already present, or removes it if
481
void Instruction::setMetadata(unsigned KindID, MDNode *Node) {
482
if (Node == 0 && !hasMetadata()) return;
484
// Handle the case when we're adding/updating metadata on an instruction.
486
LLVMContextImpl::MDMapTy &Info = getContext().pImpl->MetadataStore[this];
487
assert(!Info.empty() == hasMetadata() && "HasMetadata bit is wonked");
489
setHasMetadata(true);
491
// Handle replacement of an existing value.
492
for (unsigned i = 0, e = Info.size(); i != e; ++i)
493
if (Info[i].first == KindID) {
494
Info[i].second = Node;
499
// No replacement, just add it to the list.
500
Info.push_back(std::make_pair(KindID, Node));
504
// Otherwise, we're removing metadata from an instruction.
505
assert(hasMetadata() && getContext().pImpl->MetadataStore.count(this) &&
506
"HasMetadata bit out of date!");
507
LLVMContextImpl::MDMapTy &Info = getContext().pImpl->MetadataStore[this];
509
// Common case is removing the only entry.
510
if (Info.size() == 1 && Info[0].first == KindID) {
511
getContext().pImpl->MetadataStore.erase(this);
512
setHasMetadata(false);
516
// Handle replacement of an existing value.
517
for (unsigned i = 0, e = Info.size(); i != e; ++i)
518
if (Info[i].first == KindID) {
519
Info[i] = Info.back();
521
assert(!Info.empty() && "Removing last entry should be handled above");
524
// Otherwise, removing an entry that doesn't exist on the instruction.
527
MDNode *Instruction::getMetadataImpl(unsigned KindID) const {
528
LLVMContextImpl::MDMapTy &Info = getContext().pImpl->MetadataStore[this];
529
assert(hasMetadata() && !Info.empty() && "Shouldn't have called this");
531
for (LLVMContextImpl::MDMapTy::iterator I = Info.begin(), E = Info.end();
533
if (I->first == KindID)
538
void Instruction::getAllMetadataImpl(SmallVectorImpl<std::pair<unsigned,
539
MDNode*> > &Result)const {
540
assert(hasMetadata() && getContext().pImpl->MetadataStore.count(this) &&
541
"Shouldn't have called this");
542
const LLVMContextImpl::MDMapTy &Info =
543
getContext().pImpl->MetadataStore.find(this)->second;
544
assert(!Info.empty() && "Shouldn't have called this");
547
Result.append(Info.begin(), Info.end());
549
// Sort the resulting array so it is stable.
550
if (Result.size() > 1)
551
array_pod_sort(Result.begin(), Result.end());
554
/// removeAllMetadata - Remove all metadata from this instruction.
555
void Instruction::removeAllMetadata() {
556
assert(hasMetadata() && "Caller should check");
557
getContext().pImpl->MetadataStore.erase(this);
558
setHasMetadata(false);