Skip to content

Commit

Permalink
Disallow null as a named metadata operand.
Browse files Browse the repository at this point in the history
Make MDNode::destroy private.
Fix the one thing that used MDNode::destroy, outside of MDNode itself.

One should never delete or destroy an MDNode explicitly. MDNodes
implicitly go away when there are no references to them (implementation
details aside).


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@109028 91177308-0d34-0410-b5e6-96231b3b80d8
  • Loading branch information
Dan Gohman committed Jul 21, 2010
1 parent ec237ff commit 872814a
Show file tree
Hide file tree
Showing 11 changed files with 20 additions and 40 deletions.
8 changes: 5 additions & 3 deletions docs/LangRef.html
Original file line number Diff line number Diff line change
Expand Up @@ -949,15 +949,17 @@ <h5>Syntax:</h5>
<div class="doc_text">

<p>Named metadata is a collection of metadata. <a href="#metadata">Metadata
nodes</a> (but not metadata strings) and null are the only valid operands for
nodes</a> (but not metadata strings) are the only valid operands for
a named metadata.</p>

<h5>Syntax:</h5>
<pre class="doc_code">
; An unnamed metadata node, which is referenced by the named metadata.
; Some unnamed metadata nodes, which are referenced by the named metadata.
!0 = metadata !{metadata !"zero"}
!1 = metadata !{metadata !"one"}
!2 = metadata !{metadata !"two"}
; A named metadata.
!name = !{null, !1}
!name = !{!0, !1, !2}
</pre>

</div>
Expand Down
3 changes: 1 addition & 2 deletions include/llvm/Analysis/DebugInfo.h
Original file line number Diff line number Diff line change
Expand Up @@ -304,8 +304,7 @@ namespace llvm {
void dump() const;

/// replaceAllUsesWith - Replace all uses of debug info referenced by
/// this descriptor. After this completes, the current debug info value
/// is erased.
/// this descriptor.
void replaceAllUsesWith(DIDescriptor &D);
};

Expand Down
6 changes: 3 additions & 3 deletions include/llvm/Metadata.h
Original file line number Diff line number Diff line change
Expand Up @@ -149,9 +149,6 @@ class MDNode : public Value, public FoldingSetNode {
// critical code because it recursively visits all the MDNode's operands.
const Function *getFunction() const;

// destroy - Delete this node. Only when there are no uses.
void destroy();

/// Profile - calculate a unique identifier for this MDNode to collapse
/// duplicates
void Profile(FoldingSetNodeID &ID) const;
Expand All @@ -162,6 +159,9 @@ class MDNode : public Value, public FoldingSetNode {
return V->getValueID() == MDNodeVal;
}
private:
// destroy - Delete this node. Only when there are no uses.
void destroy();

bool isNotUniqued() const {
return (getSubclassDataFromValue() & NotUniquedBit) != 0;
}
Expand Down
6 changes: 2 additions & 4 deletions lib/Analysis/DebugInfo.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -233,8 +233,7 @@ unsigned DIArray::getNumElements() const {
}

/// replaceAllUsesWith - Replace all uses of debug info referenced by
/// this descriptor. After this completes, the current debug info value
/// is erased.
/// this descriptor.
void DIDerivedType::replaceAllUsesWith(DIDescriptor &D) {
if (!DbgNode)
return;
Expand All @@ -249,7 +248,6 @@ void DIDerivedType::replaceAllUsesWith(DIDescriptor &D) {
const MDNode *DN = D;
const Value *V = cast_or_null<Value>(DN);
Node->replaceAllUsesWith(const_cast<Value*>(V));
Node->destroy();
}
}

Expand Down Expand Up @@ -1385,7 +1383,7 @@ static Value *findDbgGlobalDeclare(GlobalVariable *V) {
return 0;

for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
DIDescriptor DIG(cast_or_null<MDNode>(NMD->getOperand(i)));
DIDescriptor DIG(cast<MDNode>(NMD->getOperand(i)));
if (!DIG.isGlobalVariable())
continue;
if (DIGlobalVariable(DIG).getGlobal() == V)
Expand Down
6 changes: 0 additions & 6 deletions lib/AsmParser/LLParser.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -546,12 +546,6 @@ bool LLParser::ParseNamedMetadata() {
SmallVector<MDNode *, 8> Elts;
if (Lex.getKind() != lltok::rbrace)
do {
// Null is a special case since it is typeless.
if (EatIfPresent(lltok::kw_null)) {
Elts.push_back(0);
continue;
}

if (ParseToken(lltok::exclaim, "Expected '!' here"))
return true;

Expand Down
4 changes: 0 additions & 4 deletions lib/Bitcode/Reader/BitcodeReader.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -803,10 +803,6 @@ bool BitcodeReader::ParseMetadata() {
unsigned Size = Record.size();
SmallVector<MDNode *, 8> Elts;
for (unsigned i = 0; i != Size; ++i) {
if (Record[i] == ~0U) {
Elts.push_back(NULL);
continue;
}
MDNode *MD = dyn_cast<MDNode>(MDValueList.getValueFwdRef(Record[i]));
if (MD == 0)
return Error("Malformed metadata record");
Expand Down
8 changes: 2 additions & 6 deletions lib/Bitcode/Writer/BitcodeWriter.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -558,12 +558,8 @@ static void WriteModuleMetadata(const ValueEnumerator &VE,
Record.clear();

// Write named metadata operands.
for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
if (NMD->getOperand(i))
Record.push_back(VE.getValueID(NMD->getOperand(i)));
else
Record.push_back(~0U);
}
for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
Record.push_back(VE.getValueID(NMD->getOperand(i)));
Stream.EmitRecord(bitc::METADATA_NAMED_NODE, Record, 0);
Record.clear();
}
Expand Down
4 changes: 2 additions & 2 deletions lib/CodeGen/AsmPrinter/DwarfDebug.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -2319,7 +2319,7 @@ DwarfDebug::collectVariableInfo(const MachineFunction *MF,
M->getNamedMetadata(Twine("llvm.dbg.lv.",
getRealLinkageName(F->getName())))) {
for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
DIVariable DV(cast_or_null<MDNode>(NMD->getOperand(i)));
DIVariable DV(cast<MDNode>(NMD->getOperand(i)));
if (!DV || !Processed.insert(DV))
continue;
DbgScope *Scope = DbgScopeMap.lookup(DV.getContext());
Expand Down Expand Up @@ -2783,7 +2783,7 @@ void DwarfDebug::endFunction(const MachineFunction *MF) {
M->getNamedMetadata(Twine("llvm.dbg.lv.",
getRealLinkageName(FName)))) {
for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
DIVariable DV(cast_or_null<MDNode>(NMD->getOperand(i)));
DIVariable DV(cast<MDNode>(NMD->getOperand(i)));
if (!DV || !ProcessedVars.insert(DV))
continue;
DbgScope *Scope = AbstractScopes.lookup(DV.getContext());
Expand Down
11 changes: 3 additions & 8 deletions lib/VMCore/AsmWriter.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -638,10 +638,8 @@ void SlotTracker::processModule() {
I = TheModule->named_metadata_begin(),
E = TheModule->named_metadata_end(); I != E; ++I) {
const NamedMDNode *NMD = I;
for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
if (MDNode *MD = NMD->getOperand(i))
CreateMetadataSlot(MD);
}
for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i)
CreateMetadataSlot(NMD->getOperand(i));
}

// Add all the unnamed functions to the table.
Expand Down Expand Up @@ -1424,10 +1422,7 @@ void AssemblyWriter::printNamedMDNode(const NamedMDNode *NMD) {
Out << "!" << NMD->getName() << " = !{";
for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
if (i) Out << ", ";
if (MDNode *MD = NMD->getOperand(i))
Out << '!' << Machine.getMetadataSlot(MD);
else
Out << "null";
Out << '!' << Machine.getMetadataSlot(NMD->getOperand(i));
}
Out << "}\n";
}
Expand Down
2 changes: 1 addition & 1 deletion lib/VMCore/Metadata.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -389,7 +389,7 @@ unsigned NamedMDNode::getNumOperands() const {
/// getOperand - Return specified operand.
MDNode *NamedMDNode::getOperand(unsigned i) const {
assert(i < getNumOperands() && "Invalid Operand number!");
return dyn_cast_or_null<MDNode>(&*getNMDOps(Operands)[i]);
return dyn_cast<MDNode>(&*getNMDOps(Operands)[i]);
}

/// addOperand - Add metadata Operand.
Expand Down
2 changes: 1 addition & 1 deletion test/Feature/NamedMDNode.ll
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
;; Simple NamedMDNode
!0 = metadata !{i32 42}
!1 = metadata !{metadata !"foo"}
!llvm.stuff = !{!0, !1, null}
!llvm.stuff = !{!0, !1}

!samename = !{!0, !1}
declare void @samename()

0 comments on commit 872814a

Please sign in to comment.