14#ifndef MLIR_TARGET_LLVMIR_MODULEIMPORT_H
15#define MLIR_TARGET_LLVMIR_MODULEIMPORT_H
22#include "llvm/IR/Module.h"
27class DbgVariableIntrinsic;
50 ModuleImport(ModuleOp mlirModule, std::unique_ptr<llvm::Module> llvmModule,
51 bool emitExpensiveWarnings,
bool importEmptyDICompositeTypes,
52 bool preferUnregisteredIntrinsics,
bool importStructsAsLiterals);
59 return iface.initializeImport(llvmModule->getContext());
97 assert(
mlir ==
nullptr &&
98 "attempting to map a value that is already mapped");
118 assert(inst->getType()->isVoidTy() &&
119 "attempting to map an operation that returns a result");
120 assert(
mlir ==
nullptr &&
121 "attempting to map an operation that is already mapped");
130 return value.getDefiningOp();
131 return noResultOpMapping.lookup(inst);
138 assert(
result.second &&
"attempting to map a block that is already mapped");
143 return blockMapping.lookup(block);
184 FailureOr<SmallVector<AliasScopeAttr>>
192 return typeTranslator.translateType(type);
254 return tbaaMapping.lookup(node);
260 FailureOr<SmallVector<AccessGroupAttr>>
272 FailureOr<DereferenceableAttr>
278 FailureOr<SmallVector<AliasScopeAttr>>
297 bool requiresOpBundles,
307 ArgAndResultAttrsOpInterface attrsOp,
313 return preferUnregisteredIntrinsics;
318 void clearRegionState() {
319 valueMapping.clear();
320 noResultOpMapping.clear();
321 blockMapping.clear();
322 debugIntrinsics.clear();
325 void setConstantInsertionPointToStart(
Block *block) {
326 constantInsertionBlock = block;
327 constantInsertionOp =
nullptr;
332 LogicalResult convertGlobal(llvm::GlobalVariable *globalVar);
334 LogicalResult convertGlobalCtorsAndDtors(llvm::GlobalVariable *globalVar);
337 LogicalResult convertAlias(llvm::GlobalAlias *alias);
339 LogicalResult convertIFunc(llvm::GlobalIFunc *ifunc);
341 FlatSymbolRefAttr getPersonalityAsAttr(llvm::Function *func);
343 LogicalResult processBasicBlock(llvm::BasicBlock *bb, Block *block);
346 LogicalResult processDebugIntrinsics();
349 LogicalResult processDebugRecords();
351 LogicalResult processDebugIntrinsic(llvm::DbgVariableIntrinsic *dbgIntr,
352 DominanceInfo &domInfo);
354 LogicalResult processDebugRecord(llvm::DbgVariableRecord &dbgRecord,
355 DominanceInfo &domInfo);
360 std::tuple<DILocalVariableAttr, DIExpressionAttr, Value>
361 processDebugOpArgumentsAndInsertionPt(
364 llvm::Value *address,
366 llvm::DIExpression *expression, DominanceInfo &domInfo);
369 ArrayAttr convertAsmInlineOperandAttrs(
const llvm::CallBase &llvmCall);
372 LogicalResult convertIntrinsic(llvm::CallInst *inst);
375 LogicalResult convertInstruction(llvm::Instruction *inst);
380 void setNonDebugMetadataAttrs(llvm::Instruction *inst, Operation *op);
384 LogicalResult processInstruction(llvm::Instruction *inst);
389 LogicalResult convertBranchArgs(llvm::Instruction *branch,
391 SmallVectorImpl<Value> &blockArguments);
397 FailureOr<SmallVector<Value>>
398 convertCallOperands(llvm::CallBase *callInst,
bool allowInlineAsm =
false);
405 FailureOr<LLVMFunctionType> convertFunctionType(llvm::CallBase *callInst,
406 bool &isIncompatibleCall);
408 FlatSymbolRefAttr convertCalleeName(llvm::CallBase *callInst);
414 DictionaryAttr convertArgOrResultAttrSet(llvm::AttributeSet llvmAttrSet);
416 LogicalResult convertCallAttributes(llvm::CallInst *inst, CallOp op);
418 LogicalResult convertInvokeAttributes(llvm::InvokeInst *inst, InvokeOp op);
422 Type getBuiltinTypeForAttr(Type type);
426 Attribute getConstantAsAttr(llvm::Constant *constant);
434 FailureOr<Value> convertConstant(llvm::Constant *constant);
440 FailureOr<Value> convertConstantExpr(llvm::Constant *constant);
444 ComdatOp getGlobalComdatOp();
450 LogicalResult processTBAAMetadata(
const llvm::MDNode *node);
455 LogicalResult processAccessGroupMetadata(
const llvm::MDNode *node);
460 LogicalResult processAliasScopeMetadata(
const llvm::MDNode *node);
464 void processComdat(
const llvm::Comdat *comdat);
468 getOrCreateNamelessSymbolName(llvm::GlobalVariable *globalVar);
472 OpBuilder::InsertionGuard setGlobalInsertionPoint();
477 Block *constantInsertionBlock =
nullptr;
479 Operation *constantInsertionOp =
nullptr;
481 Operation *globalInsertionOp =
nullptr;
483 ComdatOp globalComdatOp =
nullptr;
485 MLIRContext *context;
489 std::unique_ptr<llvm::Module> llvmModule;
493 unsigned namelessGlobalId = 0;
497 LLVMImportInterface iface;
509 SetVector<llvm::Instruction *> debugIntrinsics;
512 SetVector<llvm::DbgVariableRecord *> dbgRecords;
521 DenseMap<const llvm::Comdat *, SymbolRefAttr> comdatMapping;
523 LLVM::TypeFromLLVMIRTranslator typeTranslator;
525 std::unique_ptr<detail::DebugImporter> debugImporter;
527 std::unique_ptr<detail::LoopAnnotationImporter> loopAnnotationImporter;
532 bool emitExpensiveWarnings;
536 bool preferUnregisteredIntrinsics;
Attributes are known-constant values of operations.
Block represents an ordered list of Operations.
LogicalResult convertIFuncs()
Converts all ifuncs of the LLVM module to MLIR variables.
LogicalResult convertIntrinsicArguments(ArrayRef< llvm::Value * > values, ArrayRef< llvm::OperandBundleUse > opBundles, bool requiresOpBundles, ArrayRef< unsigned > immArgPositions, ArrayRef< StringLiteral > immArgAttrNames, SmallVectorImpl< Value > &valuesOut, SmallVectorImpl< NamedAttribute > &attrsOut)
Converts the LLVM values for an intrinsic to mixed MLIR values and attributes for LLVM_IntrOpBase.
Location translateLoc(llvm::DILocation *loc)
Translates the debug location.
LogicalResult convertComdats()
Converts all comdat selectors of the LLVM module to MLIR comdat operations.
LogicalResult convertAliases()
Converts all aliases of the LLVM module to MLIR variables.
LogicalResult convertFunctions()
Converts all functions of the LLVM module to MLIR functions.
FailureOr< SmallVector< Value > > convertValues(ArrayRef< llvm::Value * > values)
Converts a range of LLVM values to a range of MLIR values using the convertValue method,...
Attribute lookupTBAAAttr(const llvm::MDNode *node) const
Returns the MLIR attribute mapped to the given LLVM TBAA metadata node.
bool useUnregisteredIntrinsicsOnly() const
Whether the importer should try to convert all intrinsics to llvm.call_intrinsic instead of dialect s...
LogicalResult convertLinkerOptionsMetadata()
Converts !llvm.linker.options metadata to the llvm.linker.options LLVM dialect operation.
Block * lookupBlock(llvm::BasicBlock *block) const
Returns the MLIR block mapped to the given LLVM block.
void mapBlock(llvm::BasicBlock *llvm, Block *mlir)
Stores the mapping between an LLVM block and its MLIR counterpart.
DILocalVariableAttr matchLocalVariableAttr(llvm::PointerUnion< llvm::Value *, llvm::DILocalVariable * > valOrVariable)
Converts valOrVariable to a local variable attribute.
void processFunctionAttributes(llvm::Function *func, LLVMFuncOp funcOp)
Converts function attributes of LLVM Function func into LLVM dialect attributes of LLVMFuncOp funcOp.
LogicalResult convertMetadata()
Converts all LLVM metadata nodes that translate to attributes such as alias analysis or access group ...
FailureOr< Value > convertValue(llvm::Value *value)
Converts an LLVM value to an MLIR value, or returns failure if the conversion fails.
LogicalResult initializeImportInterface()
Calls the LLVMImportInterface initialization that queries the registered dialect interfaces for the s...
void addDebugIntrinsic(llvm::CallInst *intrinsic)
Adds a debug intrinsics to the list of intrinsics that should be converted after the function convers...
LogicalResult convertIdentMetadata()
Converts !llvm.ident metadata to the llvm.ident LLVM ModuleOp attribute.
FailureOr< Value > convertMetadataValue(llvm::Value *value)
Converts an LLVM metadata value to an MLIR value, or returns failure if the conversion fails.
FailureOr< SmallVector< AliasScopeAttr > > lookupAliasScopeAttrs(const llvm::MDNode *node) const
Returns the alias scope attributes that map to the alias scope nodes starting from the metadata node.
void setDisjointFlag(llvm::Instruction *inst, Operation *op) const
Sets the disjoint flag attribute for the imported operation op given the original instruction inst.
void mapNoResultOp(llvm::Instruction *llvm, Operation *mlir)
Stores a mapping between an LLVM instruction and the imported MLIR operation if the operation returns...
void convertModuleLevelAsm()
Converts the module level asm of the LLVM module to an MLIR module level asm specification.
Value & mapValue(llvm::Value *value)
Provides write-once access to store the MLIR value corresponding to the given LLVM value.
void setExactFlag(llvm::Instruction *inst, Operation *op) const
Sets the exact flag attribute for the imported operation op given the original instruction inst.
Type convertType(llvm::Type *type)
Converts the type from LLVM to MLIR LLVM dialect.
ModuleImport(ModuleOp mlirModule, std::unique_ptr< llvm::Module > llvmModule, bool emitExpensiveWarnings, bool importEmptyDICompositeTypes, bool preferUnregisteredIntrinsics, bool importStructsAsLiterals)
DILabelAttr matchLabelAttr(llvm::Value *value)
Converts value to a label attribute. Asserts if the matching fails.
FloatAttr matchFloatAttr(llvm::Value *value)
Converts value to a float attribute. Asserts if the matching fails.
LoopAnnotationAttr translateLoopAnnotationAttr(const llvm::MDNode *node, Location loc) const
Returns the loop annotation attribute that corresponds to the given LLVM loop metadata node.
void setFastmathFlagsAttr(llvm::Instruction *inst, Operation *op) const
Sets the fastmath flags attribute for the imported operation op given the original instruction inst.
FailureOr< SmallVector< AliasScopeAttr > > matchAliasScopeAttrs(llvm::Value *value)
Converts value to an array of alias scopes or returns failure if the conversion fails.
Value lookupValue(llvm::Value *value)
Returns the MLIR value mapped to the given LLVM value.
Operation * lookupOperation(llvm::Instruction *inst)
Returns the MLIR operation mapped to the given LLVM instruction.
LogicalResult processFunction(llvm::Function *func)
Imports func into the current module.
LogicalResult convertDependentLibrariesMetadata()
Converts !llvm.dependent-libraries metadata to llvm.dependent_libraries LLVM ModuleOp attribute.
Operation *& mapNoResultOp(llvm::Instruction *inst)
Provides write-once access to store the MLIR operation corresponding to the given LLVM instruction if...
RoundingModeAttr matchRoundingModeAttr(llvm::Value *value)
Converts value to a rounding mode attribute.
void convertTargetTriple()
Converts target triple of the LLVM module to an MLIR target triple specification.
void addDebugRecord(llvm::DbgVariableRecord *dbgRecord)
Adds a debug record to the list of debug records that need to be imported after the function conversi...
void convertArgAndResultAttrs(llvm::CallBase *call, ArgAndResultAttrsOpInterface attrsOp, ArrayRef< unsigned > immArgPositions={})
Converts the argument and result attributes attached to call and adds them to attrsOp.
LogicalResult convertModuleFlagsMetadata()
Converts !llvm.module.flags metadata.
void mapValue(llvm::Value *llvm, Value mlir)
Stores the mapping between an LLVM value and its MLIR counterpart.
FailureOr< SmallVector< AccessGroupAttr > > lookupAccessGroupAttrs(const llvm::MDNode *node) const
Returns the access group attributes that map to the access group nodes starting from the access group...
LogicalResult convertGlobals()
Converts all global variables of the LLVM module to MLIR global variables.
void setIntegerOverflowFlags(llvm::Instruction *inst, Operation *op) const
Sets the integer overflow flags (nsw/nuw) attribute for the imported operation op given the original ...
LogicalResult convertCommandlineMetadata()
Converts !llvm.commandline metadata to the llvm.commandline LLVM ModuleOp attribute.
FPExceptionBehaviorAttr matchFPExceptionBehaviorAttr(llvm::Value *value)
Converts value to a FP exception behavior attribute.
void setNonNegFlag(llvm::Instruction *inst, Operation *op) const
Sets the nneg flag attribute for the imported operation op given the original instruction inst.
FailureOr< DereferenceableAttr > translateDereferenceableAttr(const llvm::MDNode *node, unsigned kindID)
Returns the dereferenceable attribute that corresponds to the given LLVM dereferenceable or dereferen...
LogicalResult convertDataLayout()
Converts the data layout of the LLVM module to an MLIR data layout specification.
IntegerAttr matchIntegerAttr(llvm::Value *value)
Converts value to an integer attribute. Asserts if the matching fails.
Helper class that translates an LLVM data layout string to an MLIR data layout specification.
A helper class that converts llvm.loop metadata nodes into corresponding LoopAnnotationAttrs and llvm...
This class defines the main interface for locations in MLIR and acts as a non-nullable wrapper around...
Operation is the basic unit of execution within MLIR.
Instances of the Type class are uniqued, have an immutable identifier and an optional mutable compone...
This class represents an instance of an SSA value in the MLIR system, representing a computable value...
The OpAsmOpInterface, see OpAsmInterface.td for more details.
Include the generated interface declarations.
llvm::SetVector< T, Vector, Set, N > SetVector
llvm::DenseMap< KeyT, ValueT, KeyInfoT, BucketT > DenseMap