[llvm] 5d3a884 - [IRGen] Change annotation metadata to support inserting tuple of strings into annotation metadata array.
Zain Jaffal via llvm-commits
llvm-commits at lists.llvm.org
Tue May 9 07:51:41 PDT 2023
Author: Zain Jaffal
Date: 2023-05-09T17:51:28+03:00
New Revision: 5d3a8842295e8ff9c8c1c98e2acf5fff76b3a2f8
URL: https://github.com/llvm/llvm-project/commit/5d3a8842295e8ff9c8c1c98e2acf5fff76b3a2f8
DIFF: https://github.com/llvm/llvm-project/commit/5d3a8842295e8ff9c8c1c98e2acf5fff76b3a2f8.diff
LOG: [IRGen] Change annotation metadata to support inserting tuple of strings into annotation metadata array.
Annotation metadata supports adding singular annotation strings to annotation block. This patch adds the ability to insert a tuple of strings into the metadata array.
The idea here is that each tuple of strings represents a piece of information that can be all related. It makes it easier to parse through related metadata information given it will be contained in one tuple.
For example in remarks any pass that implements annotation remarks can have different type of remarks and pass additional information for each.
The original behaviour of annotation remarks is preserved here and we can mix tuple annotations and single annotations for the same instruction.
Reviewed By: paquette
Differential Revision: https://reviews.llvm.org/D148328
Added:
Modified:
llvm/docs/LangRef.rst
llvm/include/llvm/IR/Instruction.h
llvm/include/llvm/IR/Metadata.h
llvm/lib/CodeGen/BasicBlockSections.cpp
llvm/lib/CodeGen/MachineFunction.cpp
llvm/lib/IR/Metadata.cpp
llvm/lib/IR/Verifier.cpp
llvm/lib/Transforms/Instrumentation/PGOInstrumentation.cpp
llvm/lib/Transforms/Scalar/AnnotationRemarks.cpp
llvm/lib/Transforms/Utils/MemoryOpRemark.cpp
llvm/test/Verifier/annotation-metadata.ll
Removed:
################################################################################
diff --git a/llvm/docs/LangRef.rst b/llvm/docs/LangRef.rst
index e79f23bb33e16..36ebda869ce65 100644
--- a/llvm/docs/LangRef.rst
+++ b/llvm/docs/LangRef.rst
@@ -7423,10 +7423,10 @@ functions was called.
'``annotation``' Metadata
^^^^^^^^^^^^^^^^^^^^^^^^^
-The ``annotation`` metadata can be used to attach a tuple of annotation strings
-to any instruction. This metadata does not impact the semantics of the program
-and may only be used to provide additional insight about the program and
-transformations to users.
+The ``annotation`` metadata can be used to attach a tuple of annotation strings
+or a tuple of a tuple of annotation strings to any instruction. This metadata does
+not impact the semantics of the program and may only be used to provide additional
+insight about the program and transformations to users.
Example:
@@ -7435,6 +7435,13 @@ Example:
%a.addr = alloca ptr, align 8, !annotation !0
!0 = !{!"auto-init"}
+Embedding tuple of strings example:
+
+.. code-block:: test
+ %a.ptr = getelementptr ptr, ptr %base, i64 0. !annotation !0
+ !0 = !{!1}
+ !1 = !{!"gep offset", !"0"}
+
'``func_sanitize``' Metadata
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
diff --git a/llvm/include/llvm/IR/Instruction.h b/llvm/include/llvm/IR/Instruction.h
index 3a3278260cf59..2128fe278e9bc 100644
--- a/llvm/include/llvm/IR/Instruction.h
+++ b/llvm/include/llvm/IR/Instruction.h
@@ -339,7 +339,11 @@ class Instruction : public User,
/// If this instruction already has !annotation metadata, append \p Annotation
/// to the existing node.
void addAnnotationMetadata(StringRef Annotation);
-
+ /// Adds an !annotation metadata node with an array of \p Annotations
+ /// as a tuple to this instruction. If this instruction already has
+ /// !annotation metadata, append the tuple to
+ /// the existing node.
+ void addAnnotationMetadata(SmallVector<StringRef> Annotations);
/// Returns the AA metadata for this instruction.
AAMDNodes getAAMetadata() const;
diff --git a/llvm/include/llvm/IR/Metadata.h b/llvm/include/llvm/IR/Metadata.h
index 1a584f2ba599b..9659dbe4f281e 100644
--- a/llvm/include/llvm/IR/Metadata.h
+++ b/llvm/include/llvm/IR/Metadata.h
@@ -789,6 +789,13 @@ class MDOperand {
Op.MD = nullptr;
return *this;
}
+
+ // Check if MDOperand is of type MDString and equals `Str`.
+ bool equalsStr(StringRef Str) const {
+ return isa<MDString>(this->get()) &&
+ cast<MDString>(this->get())->getString() == Str;
+ }
+
~MDOperand() { untrack(); }
Metadata *get() const { return MD; }
diff --git a/llvm/lib/CodeGen/BasicBlockSections.cpp b/llvm/lib/CodeGen/BasicBlockSections.cpp
index 0325dc0ef4963..5cbd53fe8b593 100644
--- a/llvm/lib/CodeGen/BasicBlockSections.cpp
+++ b/llvm/lib/CodeGen/BasicBlockSections.cpp
@@ -300,7 +300,7 @@ static bool hasInstrProfHashMismatch(MachineFunction &MF) {
if (Existing) {
MDTuple *Tuple = cast<MDTuple>(Existing);
for (const auto &N : Tuple->operands())
- if (cast<MDString>(N.get())->getString() == MetadataName)
+ if (N.equalsStr(MetadataName))
return true;
}
diff --git a/llvm/lib/CodeGen/MachineFunction.cpp b/llvm/lib/CodeGen/MachineFunction.cpp
index 4a908493e58ae..b33bb45e60136 100644
--- a/llvm/lib/CodeGen/MachineFunction.cpp
+++ b/llvm/lib/CodeGen/MachineFunction.cpp
@@ -119,7 +119,7 @@ void setUnsafeStackSize(const Function &F, MachineFrameInfo &FrameInfo) {
auto *MetadataName = "unsafe-stack-size";
if (auto &N = Existing->getOperand(0)) {
- if (cast<MDString>(N.get())->getString() == MetadataName) {
+ if (N.equalsStr(MetadataName)) {
if (auto &Op = Existing->getOperand(1)) {
auto Val = mdconst::extract<ConstantInt>(Op)->getZExtValue();
FrameInfo.setUnsafeStackSize(Val);
diff --git a/llvm/lib/IR/Metadata.cpp b/llvm/lib/IR/Metadata.cpp
index 6ffeec1f21d33..13fb2b650f89e 100644
--- a/llvm/lib/IR/Metadata.cpp
+++ b/llvm/lib/IR/Metadata.cpp
@@ -1539,23 +1539,52 @@ void Instruction::setMetadata(unsigned KindID, MDNode *Node) {
Value::setMetadata(KindID, Node);
}
+void Instruction::addAnnotationMetadata(SmallVector<StringRef> Annotations) {
+ SmallSetVector<StringRef, 2> AnnotationsSet(Annotations.begin(),
+ Annotations.end());
+ MDBuilder MDB(getContext());
+
+ auto *Existing = getMetadata(LLVMContext::MD_annotation);
+ SmallVector<Metadata *, 4> Names;
+ if (Existing) {
+ auto *Tuple = cast<MDTuple>(Existing);
+ for (auto &N : Tuple->operands()) {
+ if (isa<MDString>(N.get()))
+ continue;
+ auto *MDAnnotationTuple = cast<MDTuple>(N);
+ if (any_of(MDAnnotationTuple->operands(), [&AnnotationsSet](auto &Op) {
+ return AnnotationsSet.contains(cast<MDString>(Op)->getString());
+ }))
+ return;
+ Names.push_back(N);
+ }
+ }
+
+ SmallVector<Metadata *> MDAnnotationStrings;
+ for (StringRef Annotation : Annotations)
+ MDAnnotationStrings.push_back(MDB.createString(Annotation));
+ MDNode *InfoTuple = MDTuple::get(getContext(), MDAnnotationStrings);
+ Names.push_back(InfoTuple);
+ MDNode *MD = MDTuple::get(getContext(), Names);
+ setMetadata(LLVMContext::MD_annotation, MD);
+}
+
void Instruction::addAnnotationMetadata(StringRef Name) {
MDBuilder MDB(getContext());
auto *Existing = getMetadata(LLVMContext::MD_annotation);
SmallVector<Metadata *, 4> Names;
- bool AppendName = true;
if (Existing) {
auto *Tuple = cast<MDTuple>(Existing);
for (auto &N : Tuple->operands()) {
- if (cast<MDString>(N.get())->getString() == Name)
- AppendName = false;
+ if (isa<MDString>(N.get()) &&
+ cast<MDString>(N.get())->getString() == Name)
+ return;
Names.push_back(N.get());
}
}
- if (AppendName)
- Names.push_back(MDB.createString(Name));
+ Names.push_back(MDB.createString(Name));
MDNode *MD = MDTuple::get(getContext(), Names);
setMetadata(LLVMContext::MD_annotation, MD);
}
diff --git a/llvm/lib/IR/Verifier.cpp b/llvm/lib/IR/Verifier.cpp
index 74edba71c5981..e67283e3fb577 100644
--- a/llvm/lib/IR/Verifier.cpp
+++ b/llvm/lib/IR/Verifier.cpp
@@ -4678,8 +4678,15 @@ void Verifier::visitAnnotationMetadata(MDNode *Annotation) {
Check(isa<MDTuple>(Annotation), "annotation must be a tuple");
Check(Annotation->getNumOperands() >= 1,
"annotation must have at least one operand");
- for (const MDOperand &Op : Annotation->operands())
- Check(isa<MDString>(Op.get()), "operands must be strings");
+ for (const MDOperand &Op : Annotation->operands()) {
+ bool TupleOfStrings =
+ isa<MDTuple>(Op.get()) &&
+ all_of(cast<MDTuple>(Op)->operands(), [](auto &Annotation) {
+ return isa<MDString>(Annotation.get());
+ });
+ Check(isa<MDString>(Op.get()) || TupleOfStrings,
+ "operands must be a string or a tuple of strings");
+ }
}
void Verifier::visitAliasScopeMetadata(const MDNode *MD) {
diff --git a/llvm/lib/Transforms/Instrumentation/PGOInstrumentation.cpp b/llvm/lib/Transforms/Instrumentation/PGOInstrumentation.cpp
index 2aea2a66cbb02..9953896e8cf0e 100644
--- a/llvm/lib/Transforms/Instrumentation/PGOInstrumentation.cpp
+++ b/llvm/lib/Transforms/Instrumentation/PGOInstrumentation.cpp
@@ -1291,7 +1291,7 @@ static void annotateFunctionWithHashMismatch(Function &F, LLVMContext &ctx) {
if (Existing) {
MDTuple *Tuple = cast<MDTuple>(Existing);
for (const auto &N : Tuple->operands()) {
- if (cast<MDString>(N.get())->getString() == MetadataName)
+ if (N.equalsStr(MetadataName))
return;
Names.push_back(N.get());
}
diff --git a/llvm/lib/Transforms/Scalar/AnnotationRemarks.cpp b/llvm/lib/Transforms/Scalar/AnnotationRemarks.cpp
index 770e0d548a152..b182f46cc5150 100644
--- a/llvm/lib/Transforms/Scalar/AnnotationRemarks.cpp
+++ b/llvm/lib/Transforms/Scalar/AnnotationRemarks.cpp
@@ -57,7 +57,12 @@ static void runImpl(Function &F, const TargetLibraryInfo &TLI) {
for (const MDOperand &Op :
I.getMetadata(LLVMContext::MD_annotation)->operands()) {
- auto Iter = Mapping.insert({cast<MDString>(Op.get())->getString(), 0});
+ StringRef AnnotationStr =
+ isa<MDString>(Op.get())
+ ? cast<MDString>(Op.get())->getString()
+ : cast<MDString>(cast<MDTuple>(Op.get())->getOperand(0).get())
+ ->getString();
+ auto Iter = Mapping.insert({AnnotationStr, 0});
Iter.first->second++;
}
}
diff --git a/llvm/lib/Transforms/Utils/MemoryOpRemark.cpp b/llvm/lib/Transforms/Utils/MemoryOpRemark.cpp
index aa57ad8472ae0..a1992d2d63bf4 100644
--- a/llvm/lib/Transforms/Utils/MemoryOpRemark.cpp
+++ b/llvm/lib/Transforms/Utils/MemoryOpRemark.cpp
@@ -387,7 +387,8 @@ bool AutoInitRemark::canHandle(const Instruction *I) {
return false;
return any_of(I->getMetadata(LLVMContext::MD_annotation)->operands(),
[](const MDOperand &Op) {
- return cast<MDString>(Op.get())->getString() == "auto-init";
+ return isa<MDString>(Op.get()) &&
+ cast<MDString>(Op.get())->getString() == "auto-init";
});
}
diff --git a/llvm/test/Verifier/annotation-metadata.ll b/llvm/test/Verifier/annotation-metadata.ll
index 41b3947099c11..77a2584aa4694 100644
--- a/llvm/test/Verifier/annotation-metadata.ll
+++ b/llvm/test/Verifier/annotation-metadata.ll
@@ -5,7 +5,7 @@ entry:
; CHECK: annotation must have at least one operand
%a.addr = alloca ptr, align 8, !annotation !0
-; CHECK-NEXT: operands must be strings
+; CHECK-NEXT: operands must be a string or a tuple of strings
ret void, !annotation !1
}
More information about the llvm-commits
mailing list