[flang-commits] [flang] [mlir] [mlir][debuginfo] Add support for subprogram annotations (PR #110946)
Walter Erquinigo via flang-commits
flang-commits at lists.llvm.org
Thu Oct 3 20:38:40 PDT 2024
https://github.com/walter-erquinigo updated https://github.com/llvm/llvm-project/pull/110946
>From 259da6ba5f9bf924dea391cf34d3a4d370d21894 Mon Sep 17 00:00:00 2001
From: walter erquinigo <walter at modular.com>
Date: Wed, 2 Oct 2024 22:32:09 -0400
Subject: [PATCH] [mlir][debuginfo] Add support for subroutine annotations
LLVM already supports `DW_TAG_LLVM_annotation` entries for subroutines, but this hasn't been surfaced to the LLVM dialect.
I'm doing the minimal amount of work to support string-based annotations, which is useful for attaching metadata to
functions, which is useful for debuggers to offer features beyond basic DWARF.
As LLVM already supports this, this patch is not controversial.
---
.../lib/Optimizer/Transforms/AddDebugInfo.cpp | 7 +++---
mlir/include/mlir-c/Dialect/LLVM.h | 7 +++++-
.../mlir/Dialect/LLVMIR/LLVMAttrDefs.td | 22 ++++++++++++++++---
mlir/lib/CAPI/Dialect/LLVM.cpp | 18 ++++++++++++++-
mlir/lib/Dialect/LLVMIR/IR/LLVMAttrs.cpp | 17 +++++++-------
.../Transforms/DIScopeForLLVMFuncOp.cpp | 2 +-
mlir/lib/Target/LLVMIR/DebugImporter.cpp | 6 ++++-
mlir/lib/Target/LLVMIR/DebugTranslation.cpp | 10 ++++++++-
mlir/test/CAPI/llvm.c | 9 +++++++-
mlir/test/Dialect/LLVMIR/debuginfo.mlir | 5 +++--
10 files changed, 81 insertions(+), 22 deletions(-)
diff --git a/flang/lib/Optimizer/Transforms/AddDebugInfo.cpp b/flang/lib/Optimizer/Transforms/AddDebugInfo.cpp
index a921d91d16fe48..30a14f4bfcbfae 100644
--- a/flang/lib/Optimizer/Transforms/AddDebugInfo.cpp
+++ b/flang/lib/Optimizer/Transforms/AddDebugInfo.cpp
@@ -330,7 +330,8 @@ void AddDebugInfoPass::handleFuncOp(mlir::func::FuncOp funcOp,
if (debugLevel == mlir::LLVM::DIEmissionKind::LineTablesOnly) {
auto spAttr = mlir::LLVM::DISubprogramAttr::get(
context, id, compilationUnit, Scope, funcName, fullName, funcFileAttr,
- line, line, subprogramFlags, subTypeAttr, /*retainedNodes=*/{});
+ line, line, subprogramFlags, subTypeAttr, /*retainedNodes=*/{},
+ /*annotations=*/{});
funcOp->setLoc(builder.getFusedLoc({l}, spAttr));
return;
}
@@ -354,7 +355,7 @@ void AddDebugInfoPass::handleFuncOp(mlir::func::FuncOp funcOp,
auto spAttr = mlir::LLVM::DISubprogramAttr::get(
context, recId, /*isRecSelf=*/true, id, compilationUnit, Scope, funcName,
fullName, funcFileAttr, line, line, subprogramFlags, subTypeAttr,
- /*retainedNodes=*/{});
+ /*retainedNodes=*/{}, /*annotations=*/{});
// There is no direct information in the IR for any 'use' statement in the
// function. We have to extract that information from the DeclareOp. We do
@@ -387,7 +388,7 @@ void AddDebugInfoPass::handleFuncOp(mlir::func::FuncOp funcOp,
spAttr = mlir::LLVM::DISubprogramAttr::get(
context, recId, /*isRecSelf=*/false, id2, compilationUnit, Scope,
funcName, fullName, funcFileAttr, line, line, subprogramFlags,
- subTypeAttr, entities);
+ subTypeAttr, entities, /*annotations=*/{});
funcOp->setLoc(builder.getFusedLoc({l}, spAttr));
funcOp.walk([&](fir::cg::XDeclareOp declOp) {
diff --git a/mlir/include/mlir-c/Dialect/LLVM.h b/mlir/include/mlir-c/Dialect/LLVM.h
index d6062bed5c0c0f..e083b33fe40c26 100644
--- a/mlir/include/mlir-c/Dialect/LLVM.h
+++ b/mlir/include/mlir-c/Dialect/LLVM.h
@@ -325,7 +325,12 @@ MLIR_CAPI_EXPORTED MlirAttribute mlirLLVMDISubprogramAttrGet(
MlirAttribute compileUnit, MlirAttribute scope, MlirAttribute name,
MlirAttribute linkageName, MlirAttribute file, unsigned int line,
unsigned int scopeLine, uint64_t subprogramFlags, MlirAttribute type,
- intptr_t nRetainedNodes, MlirAttribute const *retainedNodes);
+ intptr_t nRetainedNodes, MlirAttribute const *retainedNodes,
+ intptr_t nAnnotations, MlirAttribute const *annotations);
+
+/// Creates a LLVM DIStringAnnotation attribute.
+MLIR_CAPI_EXPORTED MlirAttribute mlirLLVMDIStringAnnotationAttrGet(
+ MlirContext ctx, MlirAttribute name, MlirAttribute value);
/// Gets the scope from this DISubprogramAttr.
MLIR_CAPI_EXPORTED MlirAttribute
diff --git a/mlir/include/mlir/Dialect/LLVMIR/LLVMAttrDefs.td b/mlir/include/mlir/Dialect/LLVMIR/LLVMAttrDefs.td
index 2da45eba77655b..dc711232aa9be8 100644
--- a/mlir/include/mlir/Dialect/LLVMIR/LLVMAttrDefs.td
+++ b/mlir/include/mlir/Dialect/LLVMIR/LLVMAttrDefs.td
@@ -586,7 +586,8 @@ def LLVM_DISubprogramAttr : LLVM_Attr<"DISubprogram", "di_subprogram",
OptionalParameter<"unsigned">:$scopeLine,
OptionalParameter<"DISubprogramFlags">:$subprogramFlags,
OptionalParameter<"DISubroutineTypeAttr">:$type,
- OptionalArrayRefParameter<"DINodeAttr">:$retainedNodes
+ OptionalArrayRefParameter<"DINodeAttr">:$retainedNodes,
+ OptionalArrayRefParameter<"DINodeAttr">:$annotations
);
let builders = [
AttrBuilder<(ins
@@ -594,11 +595,11 @@ def LLVM_DISubprogramAttr : LLVM_Attr<"DISubprogram", "di_subprogram",
"DIScopeAttr":$scope, "StringAttr":$name, "StringAttr":$linkageName,
"DIFileAttr":$file, "unsigned":$line, "unsigned":$scopeLine,
"DISubprogramFlags":$subprogramFlags, "DISubroutineTypeAttr":$type,
- "ArrayRef<DINodeAttr>":$retainedNodes
+ "ArrayRef<DINodeAttr>":$retainedNodes, "ArrayRef<DINodeAttr>":$annotations
), [{
return $_get($_ctxt, /*recId=*/nullptr, /*isRecSelf=*/false, id, compileUnit,
scope, name, linkageName, file, line, scopeLine,
- subprogramFlags, type, retainedNodes);
+ subprogramFlags, type, retainedNodes, annotations);
}]>
];
let assemblyFormat = "`<` struct(params) `>`";
@@ -670,6 +671,21 @@ def LLVM_DIImportedEntityAttr : LLVM_Attr<"DIImportedEntity", "di_imported_entit
let assemblyFormat = "`<` struct(params) `>`";
}
+//===----------------------------------------------------------------------===//
+// DIStringAnnotationAttr
+//===----------------------------------------------------------------------===//
+
+def LLVM_DIStringAnnotationAttr : LLVM_Attr<"DIStringAnnotation",
+ "di_string_annotation",
+ /*traits=*/[], "DINodeAttr"> {
+ let parameters = (ins
+ "StringAttr":$name,
+ "StringAttr":$value
+ );
+
+ let assemblyFormat = "`<` struct(params) `>`";
+}
+
//===----------------------------------------------------------------------===//
// DISubrangeAttr
//===----------------------------------------------------------------------===//
diff --git a/mlir/lib/CAPI/Dialect/LLVM.cpp b/mlir/lib/CAPI/Dialect/LLVM.cpp
index 03b536d7aad98f..62f83716c8f3a4 100644
--- a/mlir/lib/CAPI/Dialect/LLVM.cpp
+++ b/mlir/lib/CAPI/Dialect/LLVM.cpp
@@ -303,9 +303,14 @@ MlirAttribute mlirLLVMDISubprogramAttrGet(
MlirAttribute compileUnit, MlirAttribute scope, MlirAttribute name,
MlirAttribute linkageName, MlirAttribute file, unsigned int line,
unsigned int scopeLine, uint64_t subprogramFlags, MlirAttribute type,
- intptr_t nRetainedNodes, MlirAttribute const *retainedNodes) {
+ intptr_t nRetainedNodes, MlirAttribute const *retainedNodes,
+ intptr_t nAnnotations, MlirAttribute const *annotations) {
SmallVector<Attribute> nodesStorage;
nodesStorage.reserve(nRetainedNodes);
+
+ SmallVector<Attribute> annotationsStorage;
+ annotationsStorage.reserve(nAnnotations);
+
return wrap(DISubprogramAttr::get(
unwrap(ctx), cast<DistinctAttr>(unwrap(recId)), isRecSelf,
cast<DistinctAttr>(unwrap(id)),
@@ -316,6 +321,9 @@ MlirAttribute mlirLLVMDISubprogramAttrGet(
cast<DISubroutineTypeAttr>(unwrap(type)),
llvm::map_to_vector(
unwrapList(nRetainedNodes, retainedNodes, nodesStorage),
+ [](Attribute a) { return cast<DINodeAttr>(a); }),
+ llvm::map_to_vector(
+ unwrapList(nAnnotations, annotations, annotationsStorage),
[](Attribute a) { return cast<DINodeAttr>(a); })));
}
@@ -375,3 +383,11 @@ MlirAttribute mlirLLVMDIImportedEntityAttrGet(
llvm::map_to_vector(unwrapList(nElements, elements, elementsStorage),
[](Attribute a) { return cast<DINodeAttr>(a); })));
}
+
+MlirAttribute mlirLLVMDIStringAnnotationAttrGet(MlirContext ctx,
+ MlirAttribute name,
+ MlirAttribute value) {
+ return wrap(DIStringAnnotationAttr::get(unwrap(ctx),
+ cast<StringAttr>(unwrap(name)),
+ cast<StringAttr>(unwrap(value))));
+}
diff --git a/mlir/lib/Dialect/LLVMIR/IR/LLVMAttrs.cpp b/mlir/lib/Dialect/LLVMIR/IR/LLVMAttrs.cpp
index bd2164e640e7b8..a4304ef6668e5e 100644
--- a/mlir/lib/Dialect/LLVMIR/IR/LLVMAttrs.cpp
+++ b/mlir/lib/Dialect/LLVMIR/IR/LLVMAttrs.cpp
@@ -60,9 +60,9 @@ bool DINodeAttr::classof(Attribute attr) {
DIDerivedTypeAttr, DIFileAttr, DIGlobalVariableAttr,
DIImportedEntityAttr, DILabelAttr, DILexicalBlockAttr,
DILexicalBlockFileAttr, DILocalVariableAttr, DIModuleAttr,
- DINamespaceAttr, DINullTypeAttr, DIStringTypeAttr,
- DISubprogramAttr, DISubrangeAttr, DISubroutineTypeAttr>(
- attr);
+ DINamespaceAttr, DINullTypeAttr, DIStringAnnotationAttr,
+ DIStringTypeAttr, DISubprogramAttr, DISubrangeAttr,
+ DISubroutineTypeAttr>(attr);
}
//===----------------------------------------------------------------------===//
@@ -221,15 +221,16 @@ DICompositeTypeAttr::getRecSelf(DistinctAttr recId) {
//===----------------------------------------------------------------------===//
DIRecursiveTypeAttrInterface DISubprogramAttr::withRecId(DistinctAttr recId) {
- return DISubprogramAttr::get(
- getContext(), recId, getIsRecSelf(), getId(), getCompileUnit(),
- getScope(), getName(), getLinkageName(), getFile(), getLine(),
- getScopeLine(), getSubprogramFlags(), getType(), getRetainedNodes());
+ return DISubprogramAttr::get(getContext(), recId, getIsRecSelf(), getId(),
+ getCompileUnit(), getScope(), getName(),
+ getLinkageName(), getFile(), getLine(),
+ getScopeLine(), getSubprogramFlags(), getType(),
+ getRetainedNodes(), getAnnotations());
}
DIRecursiveTypeAttrInterface DISubprogramAttr::getRecSelf(DistinctAttr recId) {
return DISubprogramAttr::get(recId.getContext(), recId, /*isRecSelf=*/true,
- {}, {}, {}, {}, {}, 0, 0, {}, {}, {}, {});
+ {}, {}, {}, {}, {}, 0, 0, {}, {}, {}, {}, {});
}
//===----------------------------------------------------------------------===//
diff --git a/mlir/lib/Dialect/LLVMIR/Transforms/DIScopeForLLVMFuncOp.cpp b/mlir/lib/Dialect/LLVMIR/Transforms/DIScopeForLLVMFuncOp.cpp
index 2cfaffa7c8efce..59a4f8e9023582 100644
--- a/mlir/lib/Dialect/LLVMIR/Transforms/DIScopeForLLVMFuncOp.cpp
+++ b/mlir/lib/Dialect/LLVMIR/Transforms/DIScopeForLLVMFuncOp.cpp
@@ -78,7 +78,7 @@ static void addScopeToFunction(LLVM::LLVMFuncOp llvmFunc,
auto subprogramAttr = LLVM::DISubprogramAttr::get(
context, id, compileUnitAttr, fileAttr, funcName, funcName, fileAttr,
/*line=*/line, /*scopeline=*/col, subprogramFlags, subroutineTypeAttr,
- /*retainedNodes=*/{});
+ /*retainedNodes=*/{}, /*annotations=*/{});
llvmFunc->setLoc(FusedLoc::get(context, {loc}, subprogramAttr));
}
diff --git a/mlir/lib/Target/LLVMIR/DebugImporter.cpp b/mlir/lib/Target/LLVMIR/DebugImporter.cpp
index 8c6f32f6bb0cd0..7e25fe8299751b 100644
--- a/mlir/lib/Target/LLVMIR/DebugImporter.cpp
+++ b/mlir/lib/Target/LLVMIR/DebugImporter.cpp
@@ -245,12 +245,16 @@ DISubprogramAttr DebugImporter::translateImpl(llvm::DISubprogram *node) {
if (llvm::is_contained(retainedNodes, nullptr))
retainedNodes.clear();
+ SmallVector<DINodeAttr> annotations;
+ for (llvm::DINode *annotation : node->getAnnotations())
+ retainedNodes.push_back(translate(annotation));
+
return DISubprogramAttr::get(context, id, translate(node->getUnit()), scope,
getStringAttrOrNull(node->getRawName()),
getStringAttrOrNull(node->getRawLinkageName()),
translate(node->getFile()), node->getLine(),
node->getScopeLine(), *subprogramFlags, type,
- retainedNodes);
+ retainedNodes, annotations);
}
DISubrangeAttr DebugImporter::translateImpl(llvm::DISubrange *node) {
diff --git a/mlir/lib/Target/LLVMIR/DebugTranslation.cpp b/mlir/lib/Target/LLVMIR/DebugTranslation.cpp
index 8ca3beca6b66f7..709f1bb3dd0bcd 100644
--- a/mlir/lib/Target/LLVMIR/DebugTranslation.cpp
+++ b/mlir/lib/Target/LLVMIR/DebugTranslation.cpp
@@ -102,6 +102,13 @@ DebugTranslation::getMDTupleOrNull(ArrayRef<DINodeAttr> elements) {
return nullptr;
SmallVector<llvm::Metadata *> llvmElements = llvm::to_vector(
llvm::map_range(elements, [&](DINodeAttr attr) -> llvm::Metadata * {
+ if (DIStringAnnotationAttr annAttr =
+ dyn_cast<DIStringAnnotationAttr>(attr)) {
+ llvm::Metadata *ops[2] = {
+ llvm::MDString::get(llvmCtx, annAttr.getName()),
+ llvm::MDString::get(llvmCtx, annAttr.getValue())};
+ return llvm::MDNode::get(llvmCtx, ops);
+ }
return translate(attr);
}));
return llvm::MDNode::get(llvmCtx, llvmElements);
@@ -332,7 +339,8 @@ llvm::DISubprogram *DebugTranslation::translateImpl(DISubprogramAttr attr) {
/*ThisAdjustment=*/0, llvm::DINode::FlagZero,
static_cast<llvm::DISubprogram::DISPFlags>(attr.getSubprogramFlags()),
compileUnit, /*TemplateParams=*/nullptr, /*Declaration=*/nullptr,
- getMDTupleOrNull(attr.getRetainedNodes()));
+ getMDTupleOrNull(attr.getRetainedNodes()), nullptr,
+ getMDTupleOrNull(attr.getAnnotations()));
if (attr.getId())
distinctAttrToNode.try_emplace(attr.getId(), node);
return node;
diff --git a/mlir/test/CAPI/llvm.c b/mlir/test/CAPI/llvm.c
index 36277122801de4..d915c35105088a 100644
--- a/mlir/test/CAPI/llvm.c
+++ b/mlir/test/CAPI/llvm.c
@@ -324,9 +324,16 @@ static void testDebugInfoAttributes(MlirContext ctx) {
mlirAttributeDump(di_imported_entity);
// CHECK: #llvm.di_imported_entity<{{.*}}>
+ MlirAttribute di_annotation = mlirLLVMDIStringAnnotationAttrGet(
+ ctx, mlirStringAttrGet(ctx, mlirStringRefCreateFromCString("foo")),
+ mlirStringAttrGet(ctx, mlirStringRefCreateFromCString("bar")));
+
+ mlirAttributeDump(di_annotation);
+ // CHECK: #llvm.di_string_annotation<{{.*}}>
+
MlirAttribute di_subprogram = mlirLLVMDISubprogramAttrGet(
ctx, recId0, false, id, compile_unit, compile_unit, foo, bar, file, 1, 2,
- 0, subroutine_type, 1, &di_imported_entity);
+ 0, subroutine_type, 1, &di_imported_entity, 1, &di_annotation);
// CHECK: #llvm.di_subprogram<{{.*}}>
mlirAttributeDump(di_subprogram);
diff --git a/mlir/test/Dialect/LLVMIR/debuginfo.mlir b/mlir/test/Dialect/LLVMIR/debuginfo.mlir
index 6d9b7799c3917f..38085d07d26b68 100644
--- a/mlir/test/Dialect/LLVMIR/debuginfo.mlir
+++ b/mlir/test/Dialect/LLVMIR/debuginfo.mlir
@@ -116,10 +116,11 @@
apinotes = "/", line = 42, isDecl = true
>
-// CHECK-DAG: #[[SP2:.*]] = #llvm.di_subprogram<compileUnit = #[[CU]], scope = #[[MODULE]], name = "value", file = #[[FILE]], subprogramFlags = Definition, type = #[[SPTYPE2]]>
+// CHECK-DAG: #[[SP2:.*]] = #llvm.di_subprogram<compileUnit = #[[CU]], scope = #[[MODULE]], name = "value", file = #[[FILE]], subprogramFlags = Definition, type = #[[SPTYPE2]], annotations = #llvm.di_string_annotation<name = "foo", value = "bar">
#sp2 = #llvm.di_subprogram<
compileUnit = #cu, scope = #module, name = "value",
- file = #file, subprogramFlags = "Definition", type = #spType2
+ file = #file, subprogramFlags = "Definition", type = #spType2,
+ annotations = #llvm.di_string_annotation<name = "foo", value = "bar">
>
// CHECK-DAG: #[[BLOCK0:.*]] = #llvm.di_lexical_block<scope = #[[SP0]], line = 1, column = 2>
More information about the flang-commits
mailing list