14#ifndef MLIR_TARGET_LLVMIR_MODULEIMPORT_H
15#define MLIR_TARGET_LLVMIR_MODULEIMPORT_H
22#include "llvm/ADT/SmallPtrSet.h"
23#include "llvm/IR/Module.h"
28class DbgVariableIntrinsic;
51 ModuleImport(ModuleOp mlirModule, std::unique_ptr<llvm::Module> llvmModule,
52 bool emitExpensiveWarnings,
bool importEmptyDICompositeTypes,
53 bool preferUnregisteredIntrinsics,
bool importStructsAsLiterals);
60 return iface.initializeImport(llvmModule->getContext());
98 assert(
mlir ==
nullptr &&
99 "attempting to map a value that is already mapped");
119 assert(inst->getType()->isVoidTy() &&
120 "attempting to map an operation that returns a result");
121 assert(
mlir ==
nullptr &&
122 "attempting to map an operation that is already mapped");
131 return value.getDefiningOp();
132 return noResultOpMapping.lookup(inst);
139 assert(
result.second &&
"attempting to map a block that is already mapped");
144 return blockMapping.lookup(block);
185 FailureOr<SmallVector<AliasScopeAttr>>
193 return typeTranslator.translateType(type);
255 return tbaaMapping.lookup(node);
261 FailureOr<SmallVector<AccessGroupAttr>>
273 FailureOr<DereferenceableAttr>
279 FailureOr<SmallVector<AliasScopeAttr>>
298 bool requiresOpBundles,
308 ArgAndResultAttrsOpInterface attrsOp,
314 return preferUnregisteredIntrinsics;
319 void clearRegionState() {
320 valueMapping.clear();
321 noResultOpMapping.clear();
322 blockMapping.clear();
323 debugIntrinsics.clear();
326 void setConstantInsertionPointToStart(
Block *block) {
327 constantInsertionBlock = block;
328 constantInsertionOp =
nullptr;
333 LogicalResult convertGlobal(llvm::GlobalVariable *globalVar);
335 LogicalResult convertGlobalCtorsAndDtors(llvm::GlobalVariable *globalVar);
338 LogicalResult convertAlias(llvm::GlobalAlias *alias);
340 LogicalResult convertIFunc(llvm::GlobalIFunc *ifunc);
342 FlatSymbolRefAttr getPersonalityAsAttr(llvm::Function *func);
344 LogicalResult processBasicBlock(llvm::BasicBlock *bb,
Block *block);
347 LogicalResult processDebugIntrinsics();
350 LogicalResult processDebugRecords();
352 LogicalResult processDebugIntrinsic(llvm::DbgVariableIntrinsic *dbgIntr,
353 DominanceInfo &domInfo);
355 LogicalResult processDebugRecord(llvm::DbgVariableRecord &dbgRecord,
356 DominanceInfo &domInfo);
361 std::tuple<DILocalVariableAttr, DIExpressionAttr, Value>
362 processDebugOpArgumentsAndInsertionPt(
365 llvm::Value *address,
367 llvm::DIExpression *expression, DominanceInfo &domInfo);
370 ArrayAttr convertAsmInlineOperandAttrs(
const llvm::CallBase &llvmCall);
373 LogicalResult convertIntrinsic(llvm::CallInst *inst);
376 LogicalResult convertInstruction(llvm::Instruction *inst);
381 void setNonDebugMetadataAttrs(llvm::Instruction *inst, Operation *op);
384 FlatSymbolRefAttr getMetadataGlobalValueSymbolRef(llvm::GlobalValue *global);
386 FlatSymbolRefAttr getMetadataOperandSymbolRef(
const llvm::Metadata *md);
389 Attribute convertMetadataToAttr(
const llvm::Metadata *md);
392 Attribute convertMetadataToAttrImpl(
398 LogicalResult processInstruction(llvm::Instruction *inst);
403 LogicalResult convertBranchArgs(llvm::Instruction *branch,
405 SmallVectorImpl<Value> &blockArguments);
411 FailureOr<SmallVector<Value>>
412 convertCallOperands(llvm::CallBase *callInst,
bool allowInlineAsm =
false);
419 FailureOr<LLVMFunctionType> convertFunctionType(llvm::CallBase *callInst,
420 bool &isIncompatibleCall);
422 FlatSymbolRefAttr convertCalleeName(llvm::CallBase *callInst);
428 DictionaryAttr convertArgOrResultAttrSet(llvm::AttributeSet llvmAttrSet);
430 LogicalResult convertCallAttributes(llvm::CallInst *inst, CallOp op);
432 LogicalResult convertInvokeAttributes(llvm::InvokeInst *inst, InvokeOp op);
436 Type getBuiltinTypeForAttr(Type type);
440 Attribute getConstantAsAttr(llvm::Constant *constant);
448 FailureOr<Value> convertConstant(llvm::Constant *constant);
454 FailureOr<Value> convertConstantExpr(llvm::Constant *constant);
458 ComdatOp getGlobalComdatOp();
464 LogicalResult processTBAAMetadata(
const llvm::MDNode *node);
469 LogicalResult processAccessGroupMetadata(
const llvm::MDNode *node);
474 LogicalResult processAliasScopeMetadata(
const llvm::MDNode *node);
478 void processComdat(
const llvm::Comdat *comdat);
482 getOrCreateNamelessSymbolName(llvm::GlobalVariable *globalVar);
486 OpBuilder::InsertionGuard setGlobalInsertionPoint();
491 Block *constantInsertionBlock =
nullptr;
493 Operation *constantInsertionOp =
nullptr;
495 Operation *globalInsertionOp =
nullptr;
497 ComdatOp globalComdatOp =
nullptr;
499 MLIRContext *context;
503 std::unique_ptr<llvm::Module> llvmModule;
507 unsigned namelessGlobalId = 0;
511 LLVMImportInterface iface;
523 SetVector<llvm::Instruction *> debugIntrinsics;
526 SetVector<llvm::DbgVariableRecord *> dbgRecords;
535 DenseMap<const llvm::Comdat *, SymbolRefAttr> comdatMapping;
537 LLVM::TypeFromLLVMIRTranslator typeTranslator;
539 std::unique_ptr<detail::DebugImporter> debugImporter;
541 std::unique_ptr<detail::LoopAnnotationImporter> loopAnnotationImporter;
546 bool emitExpensiveWarnings;
550 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