14 #ifndef MLIR_TARGET_LLVMIR_MODULETRANSLATION_H
15 #define MLIR_TARGET_LLVMIR_MODULETRANSLATION_H
27 #include "llvm/ADT/SetVector.h"
28 #include "llvm/Frontend/OpenMP/OMPIRBuilder.h"
29 #include "llvm/IR/FPEnv.h"
35 class OpenMPIRBuilder;
47 class DebugTranslation;
48 class LoopAnnotationTranslation;
52 class AliasScopeDomainAttr;
55 class ComdatSelectorOp;
63 friend std::unique_ptr<llvm::Module>
70 auto result = functionMapping.try_emplace(name, func);
72 assert(result.second &&
73 "attempting to map a function that is already mapped");
78 return functionMapping.lookup(name);
87 llvm::Value *&
llvm = valueMapping[value];
88 assert(
llvm ==
nullptr &&
89 "attempting to map a value that is already mapped");
95 return valueMapping.lookup(value);
103 auto result = blockMapping.try_emplace(
mlir,
llvm);
105 assert(result.second &&
"attempting to map a block that is already mapped");
110 return blockMapping.lookup(block);
115 llvm::CanonicalLoopInfo *result = loopMapping.lookup(
mlir);
116 assert(result &&
"attempt to get non-existing loop");
136 assert(
llvm &&
"argument must be non-null");
137 llvm::CanonicalLoopInfo *&cur = loopMapping[
mlir];
138 assert(cur ==
nullptr &&
"attempting to map a loop that is already mapped");
151 auto result = branchMapping.try_emplace(
mlir,
llvm);
153 assert(result.second &&
154 "attempting to map a branch that is already mapped");
160 return branchMapping.lookup(op);
166 auto result = callMapping.try_emplace(
mlir,
llvm);
168 assert(result.second &&
"attempting to map a call that is already mapped");
174 return callMapping.lookup(op);
180 auto result = unresolvedBlockAddressMapping.try_emplace(op, cst);
182 assert(result.second &&
183 "attempting to map a blockaddress operation that is already mapped");
188 auto result = blockAddressToLLVMMapping.try_emplace(attr, block);
190 assert(result.second &&
191 "attempting to map a blockaddress attribute that is already mapped");
196 return blockAddressToLLVMMapping.lookup(attr);
215 llvm::Instruction *inst);
219 llvm::Instruction *inst);
222 void setTBAAMetadata(AliasAnalysisOpInterface op, llvm::Instruction *inst);
227 llvm::Instruction *inst);
254 return globalsMapping.lookup(op);
260 return aliasesMapping.lookup(op);
266 return ifuncMapping.lookup(op);
283 llvm::DIGlobalVariableExpression *
293 llvm::fp::ExceptionBehavior
304 llvm::IRBuilderBase &builder) {
305 return convertBlockImpl(bb, ignoreArguments, builder,
312 DictionaryAttr paramAttrs);
323 template <
typename T,
typename... Args>
325 stack.
stackPush<T>(std::forward<Args>(args)...);
333 template <
typename T>
339 template <
typename T>
346 std::unique_ptr<llvm::Module> llvmModule);
350 LogicalResult convertOperation(
Operation &op, llvm::IRBuilderBase &builder,
351 bool recordInsertions =
false);
352 LogicalResult convertFunctionSignatures();
353 LogicalResult convertFunctions();
354 LogicalResult convertIFuncs();
355 LogicalResult convertComdats();
357 LogicalResult convertUnresolvedBlockAddress();
364 LogicalResult convertGlobalsAndAliases();
365 LogicalResult convertOneFunction(LLVMFuncOp func);
366 LogicalResult convertBlockImpl(
Block &bb,
bool ignoreArguments,
367 llvm::IRBuilderBase &builder,
368 bool recordInsertions);
372 llvm::MDNode *getTBAANode(TBAATagAttr tbaaAttr)
const;
376 LogicalResult createTBAAMetadata();
379 LogicalResult createIdentMetadata();
382 LogicalResult createCommandlineMetadata();
385 LogicalResult createDependentLibrariesMetadata();
394 FailureOr<llvm::AttrBuilder>
399 std::unique_ptr<llvm::Module> llvmModule;
401 std::unique_ptr<detail::DebugTranslation> debugTranslation;
404 std::unique_ptr<detail::LoopAnnotationTranslation> loopAnnotationTranslation;
407 std::unique_ptr<llvm::OpenMPIRBuilder> ompBuilder;
428 llvm::StringMap<llvm::Function *> functionMapping;
494 const ModuleTranslation &moduleTranslation);
500 ArrayRef<llvm::Type *> tys = {});
506 llvm::IRBuilderBase &builder, ModuleTranslation &moduleTranslation,
508 ArrayRef<unsigned> overloadedResults, ArrayRef<unsigned> overloadedOperands,
509 ArrayRef<unsigned> immArgPositions,
510 ArrayRef<StringLiteral> immArgAttrNames);
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.
Implementation class for module translation.
void mapUnresolvedBlockAddress(BlockAddressOp op, llvm::Value *cst)
Maps a blockaddress operation to its corresponding placeholder LLVM value.
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.
FailureOr< llvm::AttrBuilder > convertParameterAttrs(mlir::Location loc, DictionaryAttr paramAttrs)
Translates parameter attributes of a call and adds them to the returned AttrBuilder.
WalkResult stackWalk(llvm::function_ref< WalkResult(T &)> callback)
Calls callback for every ModuleTranslation stack frame of type T starting from the top of the stack.
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.
void mapOmpLoop(Value mlir, llvm::CanonicalLoopInfo *llvm)
Map an MLIR OpenMP dialect CanonicalLoopInfo to its lowered LLVM-IR OpenMPIRBuilder CanonicalLoopInfo...
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.
void setDereferenceableMetadata(DereferenceableOpInterface op, llvm::Instruction *inst)
Sets LLVM dereferenceable metadata for operations that have dereferenceable attributes.
void setBranchWeightsMetadata(WeightedBranchOpInterface op)
Sets LLVM profiling metadata for operations that have branch weights.
SymbolTableCollection & symbolTable()
void invalidateOmpLoop(omp::NewCliOp mlir)
Mark an OpenMP loop as having been consumed.
llvm::Type * convertType(Type type)
Converts the type from MLIR LLVM dialect to LLVM.
llvm::GlobalValue * lookupAlias(Operation *op)
Finds an LLVM IR global value that corresponds to the given MLIR operation defining a global alias va...
void invalidateOmpLoop(Value mlir)
Mark an OpenMP loop as having been consumed.
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.
void mapOmpLoop(omp::NewCliOp mlir, llvm::CanonicalLoopInfo *llvm)
Map an MLIR OpenMP dialect CanonicalLoopInfo to its lowered LLVM-IR OpenMPIRBuilder CanonicalLoopInfo...
llvm::GlobalValue * lookupIFunc(Operation *op)
Finds an LLVM IR global value that corresponds to the given MLIR operation defining an IFunc.
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.
void setDisjointFlag(Operation *op, llvm::Value *value)
Sets the disjoint flag attribute for the exported instruction value given the original operation op.
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::BasicBlock * lookupBlockAddress(BlockAddressAttr attr) const
Finds the LLVM basic block that corresponds to the given BlockAddressAttr.
llvm::CanonicalLoopInfo * lookupOMPLoop(omp::NewCliOp mlir) const
Find the LLVM-IR loop that represents an MLIR loop.
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.
llvm::CanonicalLoopInfo * lookupOMPLoop(Value mlir) const
Find the LLVM-IR loop that represents an MLIR loop.
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 mapBlockAddress(BlockAddressAttr attr, llvm::BasicBlock *block)
Maps a BlockAddressAttr to its corresponding LLVM basic block.
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.
WalkResult stackWalk(llvm::function_ref< WalkResult(T &)> callback)
Calls callback for every StateStack frame of type T starting from the top of the stack.
void stackPop()
Pops the last element from the StateStack.
void stackPush(Args &&...args)
Creates a stack frame of type T on StateStack.
This class represents a collection of SymbolTables.
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:
The OpAsmOpInterface, see OpAsmInterface.td for more details.
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.
RAII object calling stackPush/stackPop on construction/destruction.