14 #ifndef MLIR_TARGET_LLVMIR_MODULETRANSLATION_H
15 #define MLIR_TARGET_LLVMIR_MODULETRANSLATION_H
25 #include "llvm/ADT/SetVector.h"
26 #include "llvm/Frontend/OpenMP/OMPIRBuilder.h"
43 class DebugTranslation;
44 class LoopAnnotationTranslation;
48 class AliasScopeDomainAttr;
51 class ComdatSelectorOp;
59 friend std::unique_ptr<llvm::Module>
66 auto result = functionMapping.try_emplace(name, func);
68 assert(result.second &&
69 "attempting to map a function that is already mapped");
74 return functionMapping.lookup(name);
83 llvm::Value *&
llvm = valueMapping[value];
84 assert(
llvm ==
nullptr &&
85 "attempting to map a value that is already mapped");
91 return valueMapping.lookup(value);
99 auto result = blockMapping.try_emplace(
mlir,
llvm);
101 assert(result.second &&
"attempting to map a block that is already mapped");
106 return blockMapping.lookup(block);
112 auto result = branchMapping.try_emplace(
mlir,
llvm);
114 assert(result.second &&
115 "attempting to map a branch that is already mapped");
121 return branchMapping.lookup(op);
127 auto result = callMapping.try_emplace(
mlir,
llvm);
129 assert(result.second &&
"attempting to map a call that is already mapped");
135 return callMapping.lookup(op);
154 llvm::Instruction *inst);
158 llvm::Instruction *inst);
161 void setTBAAMetadata(AliasAnalysisOpInterface op, llvm::Instruction *inst);
182 return globalsMapping.lookup(op);
199 llvm::DIGlobalVariableExpression *
209 llvm::fp::ExceptionBehavior
220 llvm::IRBuilderBase &builder) {
221 return convertBlockImpl(bb, ignoreArguments, builder,
240 virtual void anchor();
250 template <
typename Derived>
261 template <
typename T,
typename... Args>
264 std::is_base_of<StackFrame, T>::value,
265 "can only push instances of StackFrame on ModuleTranslation stack");
266 stack.push_back(std::make_unique<T>(std::forward<Args>(args)...));
274 template <
typename T>
277 static_assert(std::is_base_of<StackFrame, T>::value,
278 "expected T derived from StackFrame");
281 for (
const std::unique_ptr<StackFrame> &frame : llvm::reverse(stack)) {
282 if (T *ptr = dyn_cast_or_null<T>(frame.get())) {
292 template <
typename T>
294 template <
typename... Args>
296 : moduleTranslation(m) {
297 moduleTranslation.
stackPush<T>(std::forward<Args>(args)...);
309 std::unique_ptr<llvm::Module> llvmModule);
313 LogicalResult convertOperation(
Operation &op, llvm::IRBuilderBase &builder,
314 bool recordInsertions =
false);
315 LogicalResult convertFunctionSignatures();
316 LogicalResult convertFunctions();
317 LogicalResult convertComdats();
318 LogicalResult convertGlobals();
319 LogicalResult convertOneFunction(LLVMFuncOp func);
320 LogicalResult convertBlockImpl(
Block &bb,
bool ignoreArguments,
321 llvm::IRBuilderBase &builder,
322 bool recordInsertions);
326 llvm::MDNode *getTBAANode(TBAATagAttr tbaaAttr)
const;
330 LogicalResult createTBAAMetadata();
339 FailureOr<llvm::AttrBuilder>
340 convertParameterAttrs(LLVMFuncOp func,
int argIdx, DictionaryAttr paramAttrs);
344 std::unique_ptr<llvm::Module> llvmModule;
346 std::unique_ptr<detail::DebugTranslation> debugTranslation;
349 std::unique_ptr<detail::LoopAnnotationTranslation> loopAnnotationTranslation;
352 std::unique_ptr<llvm::OpenMPIRBuilder> ompBuilder;
365 llvm::StringMap<llvm::Function *> functionMapping;
416 const ModuleTranslation &moduleTranslation);
422 ArrayRef<llvm::Type *> tys = {});
428 llvm::IRBuilderBase &builder, ModuleTranslation &moduleTranslation,
430 ArrayRef<unsigned> overloadedResults, ArrayRef<unsigned> overloadedOperands,
431 ArrayRef<unsigned> immArgPositions,
432 ArrayRef<StringLiteral> immArgAttrNames);
440 template <
typename T>
443 doit(const ::mlir::LLVM::ModuleTranslation::StackFrame &frame) {
444 return frame.getTypeID() == ::mlir::TypeID::get<T>();
Attributes are known-constant values of operations.
Block represents an ordered list of Operations.
Interface collection for translation to LLVM IR, dispatches to a concrete interface implementation ba...
This class represents the base attribute for all debug info attributes.
Concrete CRTP base class for ModuleTranslation stack frames.
Common CRTP base class for ModuleTranslation stack frames.
virtual ~StackFrame()=default
StackFrame(TypeID typeID)
Implementation class for module translation.
llvm::fp::ExceptionBehavior translateFPExceptionBehavior(LLVM::FPExceptionBehavior exceptionBehavior)
Translates the given LLVM FP exception behavior metadata.
llvm::Value * lookupValue(Value value) const
Finds an LLVM IR value corresponding to the given MLIR value.
void mapCall(Operation *mlir, llvm::CallInst *llvm)
Stores a mapping between an MLIR call operation and a corresponding LLVM call instruction.
llvm::DIGlobalVariableExpression * translateGlobalVariableExpression(LLVM::DIGlobalVariableExpressionAttr attr)
Translates the given LLVM global variable expression metadata.
llvm::Value *& mapValue(Value value)
Provides write-once access to store the LLVM IR value corresponding to the given MLIR value.
void stackPush(Args &&...args)
Creates a stack frame of type T on ModuleTranslation stack.
llvm::NamedMDNode * getOrInsertNamedModuleMetadata(StringRef name)
Gets the named metadata in the LLVM IR module being constructed, creating it if it does not exist.
LogicalResult convertBlock(Block &bb, bool ignoreArguments, llvm::IRBuilderBase &builder)
Translates the contents of the given block to LLVM IR using this translator.
void mapBranch(Operation *mlir, llvm::Instruction *llvm)
Stores the mapping between an MLIR operation with successors and a corresponding LLVM IR instruction.
llvm::Instruction * lookupBranch(Operation *op) const
Finds an LLVM IR instruction that corresponds to the given MLIR operation with successors.
SmallVector< llvm::Value * > lookupValues(ValueRange values)
Looks up remapped a list of remapped values.
void mapFunction(StringRef name, llvm::Function *func)
Stores the mapping between a function name and its LLVM IR representation.
llvm::DILocation * translateLoc(Location loc, llvm::DILocalScope *scope)
Translates the given location.
llvm::BasicBlock * lookupBlock(Block *block) const
Finds an LLVM IR basic block that corresponds to the given MLIR block.
SymbolTableCollection & symbolTable()
void setBranchWeightsMetadata(BranchWeightOpInterface op)
Sets LLVM profiling metadata for operations that have branch weights.
llvm::Type * convertType(Type type)
Converts the type from MLIR LLVM dialect to LLVM.
llvm::RoundingMode translateRoundingMode(LLVM::RoundingMode rounding)
Translates the given LLVM rounding mode metadata.
void setTBAAMetadata(AliasAnalysisOpInterface op, llvm::Instruction *inst)
Sets LLVM TBAA metadata for memory operations that have TBAA attributes.
llvm::DIExpression * translateExpression(LLVM::DIExpressionAttr attr)
Translates the given LLVM DWARF expression metadata.
llvm::OpenMPIRBuilder * getOpenMPBuilder()
Returns the OpenMP IR builder associated with the LLVM IR module being constructed.
llvm::CallInst * lookupCall(Operation *op) const
Finds an LLVM call instruction that corresponds to the given MLIR call operation.
llvm::Metadata * translateDebugInfo(LLVM::DINodeAttr attr)
Translates the given LLVM debug info metadata.
llvm::LLVMContext & getLLVMContext() const
Returns the LLVM context in which the IR is being constructed.
llvm::GlobalValue * lookupGlobal(Operation *op)
Finds an LLVM IR global value that corresponds to the given MLIR operation defining a global value.
llvm::Module * getLLVMModule()
Returns the LLVM module in which the IR is being constructed.
llvm::Function * lookupFunction(StringRef name) const
Finds an LLVM IR function by its name.
llvm::MDNode * getOrCreateAliasScopes(ArrayRef< AliasScopeAttr > aliasScopeAttrs)
Returns the LLVM metadata corresponding to an array of mlir LLVM dialect alias scope attributes.
void mapBlock(Block *mlir, llvm::BasicBlock *llvm)
Stores the mapping between an MLIR block and LLVM IR basic block.
llvm::MDNode * getOrCreateAliasScope(AliasScopeAttr aliasScopeAttr)
Returns the LLVM metadata corresponding to a mlir LLVM dialect alias scope attribute.
WalkResult stackWalk(llvm::function_ref< WalkResult(const T &)> callback) const
Calls callback for every ModuleTranslation stack frame of type T starting from the top of the stack.
void stackPop()
Pops the last element from the ModuleTranslation stack.
void forgetMapping(Region ®ion)
Removes the mapping for blocks contained in the region and values defined in these blocks.
void setAliasScopeMetadata(AliasAnalysisOpInterface op, llvm::Instruction *inst)
void setAccessGroupsMetadata(AccessGroupOpInterface op, llvm::Instruction *inst)
MLIRContext & getContext()
Returns the MLIR context of the module being translated.
void mapValue(Value mlir, llvm::Value *llvm)
Stores the mapping between an MLIR value and its LLVM IR counterpart.
void setLoopMetadata(Operation *op, llvm::Instruction *inst)
Sets LLVM loop metadata for branch operations that have a loop annotation attribute.
Utility class to translate MLIR LLVM dialect types to LLVM IR.
This class defines the main interface for locations in MLIR and acts as a non-nullable wrapper around...
MLIRContext is the top-level object for a collection of MLIR operations.
Operation is the basic unit of execution within MLIR.
MLIRContext * getContext()
Return the context this operation is associated with.
This class contains a list of basic blocks and a link to the parent operation it is attached to.
This class represents a collection of SymbolTables.
This class provides an efficient unique identifier for a specific C++ type.
Instances of the Type class are uniqued, have an immutable identifier and an optional mutable compone...
This class provides an abstraction over the different types of ranges over Values.
This class represents an instance of an SSA value in the MLIR system, representing a computable value...
A utility result that is used to signal how to proceed with an ongoing walk:
static WalkResult advance()
bool wasInterrupted() const
Returns true if the walk was interrupted.
Include the generated interface declarations.
void connectPHINodes(Region ®ion, const ModuleTranslation &state)
For all blocks in the region that were converted to LLVM IR using the given ModuleTranslation,...
llvm::CallInst * createIntrinsicCall(llvm::IRBuilderBase &builder, llvm::Intrinsic::ID intrinsic, ArrayRef< llvm::Value * > args={}, ArrayRef< llvm::Type * > tys={})
Creates a call to an LLVM IR intrinsic function with the given arguments.
llvm::Constant * getLLVMConstant(llvm::Type *llvmType, Attribute attr, Location loc, const ModuleTranslation &moduleTranslation)
Create an LLVM IR constant of llvmType from the MLIR attribute attr.
Include the generated interface declarations.
std::unique_ptr< llvm::Module > translateModuleToLLVMIR(Operation *module, llvm::LLVMContext &llvmContext, llvm::StringRef name="LLVMDialectModule", bool disableVerification=false)
Translates a given LLVM dialect module into an LLVM IR module living in the given context.
auto get(MLIRContext *context, Ts &&...params)
Helper method that injects context only if needed, this helps unify some of the attribute constructio...
static bool doit(const ::mlir::LLVM::ModuleTranslation::StackFrame &frame)
RAII object calling stackPush/stackPop on construction/destruction.
SaveStack(ModuleTranslation &m, Args &&...args)