6da578cec1
This PR introduces DIGlobalVariableAttr and DIGlobalVariableExpressionAttr so that ModuleTranslation can emit the required metadata needed for debug information about global variable. The translator implementation for debug metadata needed to be refactored in order to allow translation of nodes based on MDNode (DIGlobalVariableExpressionAttr and DIExpression) in addition to DINode-based nodes. A DIGlobalVariableExpressionAttr can now be passed to the GlobalOp operation directly and ModuleTranslation will create the respective DIGlobalVariable and DIGlobalVariableExpression nodes. The compile unit that DIGlobalVariable is expected to be configured with will be updated with the created DIGlobalVariableExpression.
101 lines
3.8 KiB
C++
101 lines
3.8 KiB
C++
//===- DebugImporter.h - LLVM to MLIR Debug conversion -------*- C++ -*----===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This file implements the translation between LLVMIR debug information and
|
|
// the corresponding MLIR representation.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef MLIR_LIB_TARGET_LLVMIR_DEBUGIMPORTER_H_
|
|
#define MLIR_LIB_TARGET_LLVMIR_DEBUGIMPORTER_H_
|
|
|
|
#include "mlir/Dialect/LLVMIR/LLVMDialect.h"
|
|
#include "mlir/IR/BuiltinOps.h"
|
|
#include "mlir/IR/MLIRContext.h"
|
|
#include "llvm/IR/DebugInfoMetadata.h"
|
|
|
|
namespace mlir {
|
|
class Operation;
|
|
|
|
namespace LLVM {
|
|
class LLVMFuncOp;
|
|
|
|
namespace detail {
|
|
|
|
class DebugImporter {
|
|
public:
|
|
DebugImporter(ModuleOp mlirModule)
|
|
: context(mlirModule.getContext()), mlirModule(mlirModule) {}
|
|
|
|
/// Translates the given LLVM debug location to an MLIR location.
|
|
Location translateLoc(llvm::DILocation *loc);
|
|
|
|
/// Translates the LLVM DWARF expression metadata to MLIR.
|
|
DIExpressionAttr translateExpression(llvm::DIExpression *node);
|
|
|
|
/// Translates the LLVM DWARF global variable expression metadata to MLIR.
|
|
DIGlobalVariableExpressionAttr
|
|
translateGlobalVariableExpression(llvm::DIGlobalVariableExpression *node);
|
|
|
|
/// Translates the debug information for the given function into a Location.
|
|
/// Returns UnknownLoc if `func` has no debug information attached to it.
|
|
Location translateFuncLocation(llvm::Function *func);
|
|
|
|
/// Translates the given LLVM debug metadata to MLIR.
|
|
DINodeAttr translate(llvm::DINode *node);
|
|
|
|
/// Infers the metadata type and translates it to MLIR.
|
|
template <typename DINodeT>
|
|
auto translate(DINodeT *node) {
|
|
// Infer the MLIR type from the LLVM metadata type.
|
|
using MLIRTypeT = decltype(translateImpl(node));
|
|
return cast_or_null<MLIRTypeT>(
|
|
translate(static_cast<llvm::DINode *>(node)));
|
|
}
|
|
|
|
private:
|
|
/// Translates the given LLVM debug metadata to the corresponding attribute.
|
|
DIBasicTypeAttr translateImpl(llvm::DIBasicType *node);
|
|
DICompileUnitAttr translateImpl(llvm::DICompileUnit *node);
|
|
DICompositeTypeAttr translateImpl(llvm::DICompositeType *node);
|
|
DIDerivedTypeAttr translateImpl(llvm::DIDerivedType *node);
|
|
DIFileAttr translateImpl(llvm::DIFile *node);
|
|
DILabelAttr translateImpl(llvm::DILabel *node);
|
|
DILexicalBlockAttr translateImpl(llvm::DILexicalBlock *node);
|
|
DILexicalBlockFileAttr translateImpl(llvm::DILexicalBlockFile *node);
|
|
DIGlobalVariableAttr translateImpl(llvm::DIGlobalVariable *node);
|
|
DILocalVariableAttr translateImpl(llvm::DILocalVariable *node);
|
|
DIModuleAttr translateImpl(llvm::DIModule *node);
|
|
DINamespaceAttr translateImpl(llvm::DINamespace *node);
|
|
DIScopeAttr translateImpl(llvm::DIScope *node);
|
|
DISubprogramAttr translateImpl(llvm::DISubprogram *node);
|
|
DISubrangeAttr translateImpl(llvm::DISubrange *node);
|
|
DISubroutineTypeAttr translateImpl(llvm::DISubroutineType *node);
|
|
DITypeAttr translateImpl(llvm::DIType *node);
|
|
|
|
/// Constructs a StringAttr from the MDString if it is non-null. Returns a
|
|
/// null attribute otherwise.
|
|
StringAttr getStringAttrOrNull(llvm::MDString *stringNode);
|
|
|
|
/// A mapping between LLVM debug metadata and the corresponding attribute.
|
|
DenseMap<llvm::DINode *, DINodeAttr> nodeToAttr;
|
|
|
|
/// A stack that stores the metadata nodes that are being traversed. The stack
|
|
/// is used to detect cyclic dependencies during the metadata translation.
|
|
SetVector<llvm::DINode *> translationStack;
|
|
|
|
MLIRContext *context;
|
|
ModuleOp mlirModule;
|
|
};
|
|
|
|
} // namespace detail
|
|
} // namespace LLVM
|
|
} // namespace mlir
|
|
|
|
#endif // MLIR_LIB_TARGET_LLVMIR_DEBUGIMPORTER_H_
|