#include "mlir/Conversion/FuncToLLVM/ConvertFuncToLLVMPass.h"
#include "mlir/Analysis/DataLayoutAnalysis.h"
#include "mlir/Conversion/ArithToLLVM/ArithToLLVM.h"
#include "mlir/Conversion/ControlFlowToLLVM/ControlFlowToLLVM.h"
#include "mlir/Conversion/ConvertToLLVM/ToLLVMInterface.h"
#include "mlir/Conversion/FuncToLLVM/ConvertFuncToLLVM.h"
#include "mlir/Conversion/LLVMCommon/ConversionTarget.h"
#include "mlir/Conversion/LLVMCommon/LowerFunctionDiscardablesToLLVM.h"
#include "mlir/Conversion/LLVMCommon/Pattern.h"
#include "mlir/Dialect/Func/IR/FuncOps.h"
#include "mlir/Dialect/LLVMIR/FunctionCallUtils.h"
#include "mlir/Dialect/LLVMIR/LLVMDialect.h"
#include "mlir/Dialect/LLVMIR/LLVMTypes.h"
#include "mlir/IR/Attributes.h"
#include "mlir/IR/Builders.h"
#include "mlir/IR/BuiltinAttributes.h"
#include "mlir/IR/BuiltinOps.h"
#include "mlir/IR/PatternMatch.h"
#include "mlir/IR/SymbolTable.h"
#include "mlir/IR/TypeUtilities.h"
#include "mlir/Transforms/DialectConversion.h"
#include "mlir/Transforms/Passes.h"
#include "llvm/ADT/SmallVector.h"
#include "llvm/IR/Type.h"
#include "llvm/Support/DebugLog.h"
#include "llvm/Support/FormatVariadic.h"
#include <optional>
#include "mlir/Conversion/Passes.h.inc"

Classes
class	mlir::impl::ConvertFuncToLLVMPassBase< DerivedT >
class	mlir::impl::SetLLVMModuleDataLayoutPassBase< DerivedT >

Namespaces
namespace	mlir
	Include the generated interface declarations.
namespace	mlir::impl
	Attribute collections provide a dictionary-like interface.

Macros
#define	GEN_PASS_DEF_CONVERTFUNCTOLLVMPASS
#define	GEN_PASS_DEF_SETLLVMMODULEDATALAYOUTPASS
#define	PASS_NAME "convert-func-to-llvm"
#define	DEBUG_TYPE PASS_NAME

Functions
std::unique_ptr<::mlir::Pass >	mlir::impl::createConvertFuncToLLVMPass ()
std::unique_ptr<::mlir::Pass >	mlir::impl::createConvertFuncToLLVMPass (ConvertFuncToLLVMPassOptions options)
std::unique_ptr<::mlir::Pass >	mlir::createConvertFuncToLLVMPass ()
std::unique_ptr<::mlir::Pass >	mlir::createConvertFuncToLLVMPass (ConvertFuncToLLVMPassOptions options)
std::unique_ptr<::mlir::Pass >	mlir::impl::createSetLLVMModuleDataLayoutPass ()
std::unique_ptr<::mlir::Pass >	mlir::impl::createSetLLVMModuleDataLayoutPass (SetLLVMModuleDataLayoutPassOptions options)
std::unique_ptr<::mlir::Pass >	mlir::createSetLLVMModuleDataLayoutPass ()
std::unique_ptr<::mlir::Pass >	mlir::createSetLLVMModuleDataLayoutPass (SetLLVMModuleDataLayoutPassOptions options)
static bool	shouldUseBarePtrCallConv (Operation op, const LLVMTypeConverter typeConverter)
	Return true if the op should use bare pointer calling convention.
static bool	isDiscardableAttr (StringRef name)
static void	filterFuncAttributes (FunctionOpInterface func, SmallVectorImpl< NamedAttribute > &result)
	Only retain those attributes that are not constructed by LLVMFuncOp::build.
static void	propagateArgResAttrs (OpBuilder &builder, bool resultStructType, FunctionOpInterface funcOp, LLVM::LLVMFuncOp wrapperFuncOp)
	Propagate argument/results attributes.
static void	wrapForExternalCallers (OpBuilder &rewriter, Location loc, const LLVMTypeConverter &typeConverter, FunctionOpInterface funcOp, LLVM::LLVMFuncOp newFuncOp)
	Creates an auxiliary function with pointer-to-memref-descriptor-struct arguments instead of unpacked arguments.
static void	wrapExternalFunction (OpBuilder &builder, Location loc, const LLVMTypeConverter &typeConverter, FunctionOpInterface funcOp, LLVM::LLVMFuncOp newFuncOp)
	Creates an auxiliary function with pointer-to-memref-descriptor-struct arguments instead of unpacked arguments.
static void	restoreByValRefArgumentType (ConversionPatternRewriter &rewriter, const LLVMTypeConverter &typeConverter, ArrayRef< std::optional< NamedAttribute > > byValRefNonPtrAttrs, LLVM::LLVMFuncOp funcOp)
	Inserts llvm.load ops in the function body to restore the expected pointee value from llvm.byval/llvm.byref function arguments that were converted to LLVM pointer types.
static FailureOr< LLVM::LLVMFunctionType >	convertFuncSignature (FunctionOpInterface funcOp, const LLVMTypeConverter &converter, bool useBarePtrCallConv, TypeConverter::SignatureConversion &result, SmallVectorImpl< std::optional< NamedAttribute > > &byValRefNonPtrAttrs)
static LLVM::LLVMFuncOp	createLLVMFuncOp (FunctionOpInterface funcOp, ConversionPatternRewriter &rewriter, LLVM::LLVMFunctionType llvmType, LoweredLLVMFuncAttrs &loweredAttrs, SymbolTableCollection *symbolTables)
static SmallVector< NamedAttribute >	convertArgumentAttributes (DictionaryAttr attrsDict, ConversionPatternRewriter &rewriter, const LLVMTypeConverter &converter)
static void	propagateFunctionArgResAttrs (FunctionOpInterface funcOp, ConversionPatternRewriter &rewriter, const LLVMTypeConverter &converter, TypeConverter::SignatureConversion &sig, LLVM::LLVMFunctionType llvmType, LLVM::LLVMFuncOp newFuncOp)
static void	wrapWithCInterface (FunctionOpInterface funcOp, ConversionPatternRewriter &rewriter, const LLVMTypeConverter &converter, LLVM::LLVMFuncOp newFuncOp)

Variables
static constexpr StringRef	varargsAttrName = "func.varargs"
static constexpr StringRef	linkageAttrName = "llvm.linkage"
static constexpr StringRef	barePtrAttrName = "llvm.bareptr"

Macro Definition Documentation

◆ DEBUG_TYPE

#define DEBUG_TYPE PASS_NAME

Definition at line 52 of file FuncToLLVM.cpp.

◆ GEN_PASS_DEF_CONVERTFUNCTOLLVMPASS

#define GEN_PASS_DEF_CONVERTFUNCTOLLVMPASS

Definition at line 44 of file FuncToLLVM.cpp.

◆ GEN_PASS_DEF_SETLLVMMODULEDATALAYOUTPASS

#define GEN_PASS_DEF_SETLLVMMODULEDATALAYOUTPASS

Definition at line 45 of file FuncToLLVM.cpp.

◆ PASS_NAME

#define PASS_NAME "convert-func-to-llvm"

Definition at line 51 of file FuncToLLVM.cpp.

Function Documentation

◆ convertArgumentAttributes()

SmallVector< NamedAttribute > convertArgumentAttributes	(	DictionaryAttr	attrsDict,
		ConversionPatternRewriter &	rewriter,
		const LLVMTypeConverter &	converter )

static

Definition at line 352 of file FuncToLLVM.cpp.

Referenced by propagateFunctionArgResAttrs().

◆ convertFuncSignature()

FailureOr< LLVM::LLVMFunctionType > convertFuncSignature	(	FunctionOpInterface	funcOp,
		const LLVMTypeConverter &	converter,
		bool	useBarePtrCallConv,
		TypeConverter::SignatureConversion &	result,
		SmallVectorImpl< std::optional< NamedAttribute > > &	byValRefNonPtrAttrs )

static

Definition at line 297 of file FuncToLLVM.cpp.

References mlir::LLVMTypeConverter::convertFunctionSignature(), result, and varargsAttrName.

Referenced by mlir::convertFuncOpToLLVMFuncOp().

◆ createLLVMFuncOp()

LLVM::LLVMFuncOp createLLVMFuncOp	(	FunctionOpInterface	funcOp,
		ConversionPatternRewriter &	rewriter,
		LLVM::LLVMFunctionType	llvmType,
		LoweredLLVMFuncAttrs &	loweredAttrs,
		SymbolTableCollection *	symbolTables )

static

Definition at line 311 of file FuncToLLVM.cpp.

References mlir::LoweredLLVMFuncAttrs::discardableAttrs, mlir::Operation::getParentWithTrait(), mlir::SymbolTableCollection::getSymbolTable(), mlir::SymbolTable::insert(), mlir::LoweredLLVMFuncAttrs::properties, and mlir::SymbolTable::remove().

Referenced by mlir::convertFuncOpToLLVMFuncOp().

◆ filterFuncAttributes()

void filterFuncAttributes	(	FunctionOpInterface	func,
		SmallVectorImpl< NamedAttribute > &	result )

static

Only retain those attributes that are not constructed by LLVMFuncOp::build.

Definition at line 72 of file FuncToLLVM.cpp.

References isDiscardableAttr(), and result.

Referenced by wrapExternalFunction(), and wrapForExternalCallers().

◆ isDiscardableAttr()

bool isDiscardableAttr ( StringRef name )

static

Definition at line 65 of file FuncToLLVM.cpp.

References linkageAttrName, and varargsAttrName.

Referenced by filterFuncAttributes().

◆ propagateArgResAttrs()

void propagateArgResAttrs	(	OpBuilder &	builder,
		bool	resultStructType,
		FunctionOpInterface	funcOp,
		LLVM::LLVMFuncOp	wrapperFuncOp )

static

Propagate argument/results attributes.

Definition at line 82 of file FuncToLLVM.cpp.

References mlir::Builder::getDictionaryAttr().

Referenced by wrapExternalFunction(), and wrapForExternalCallers().

◆ propagateFunctionArgResAttrs()

void propagateFunctionArgResAttrs	(	FunctionOpInterface	funcOp,
		ConversionPatternRewriter &	rewriter,
		const LLVMTypeConverter &	converter,
		TypeConverter::SignatureConversion &	sig,
		LLVM::LLVMFunctionType	llvmType,
		LLVM::LLVMFuncOp	newFuncOp )

static

Definition at line 384 of file FuncToLLVM.cpp.

References ArrayAttr(), and convertArgumentAttributes().

Referenced by mlir::convertFuncOpToLLVMFuncOp().

◆ restoreByValRefArgumentType()

void restoreByValRefArgumentType	(	ConversionPatternRewriter &	rewriter,
		const LLVMTypeConverter &	typeConverter,
		ArrayRef< std::optional< NamedAttribute > >	byValRefNonPtrAttrs,
		LLVM::LLVMFuncOp	funcOp )

static

Inserts llvm.load ops in the function body to restore the expected pointee value from llvm.byval/llvm.byref function arguments that were converted to LLVM pointer types.

Definition at line 268 of file FuncToLLVM.cpp.

Referenced by mlir::convertFuncOpToLLVMFuncOp().

◆ shouldUseBarePtrCallConv()

bool shouldUseBarePtrCallConv	(	Operation *	op,
		const LLVMTypeConverter *	typeConverter )

static

Return true if the op should use bare pointer calling convention.

Definition at line 59 of file FuncToLLVM.cpp.

References barePtrAttrName, mlir::LLVMTypeConverter::getOptions(), mlir::Operation::hasAttr(), and mlir::LowerToLLVMOptions::useBarePtrCallConv.

Referenced by mlir::convertFuncOpToLLVMFuncOp().

◆ wrapExternalFunction()

void wrapExternalFunction	(	OpBuilder &	builder,
		Location	loc,
		const LLVMTypeConverter &	typeConverter,
		FunctionOpInterface	funcOp,
		LLVM::LLVMFuncOp	newFuncOp )

static

Creates an auxiliary function with pointer-to-memref-descriptor-struct arguments instead of unpacked arguments.

Creates a body for the (external) newFuncOp that allocates a memref descriptor on stack, packs the individual arguments into this descriptor and passes a pointer to it into the auxiliary function. If the result of the function cannot be directly returned, we write it to a special first argument that provides a pointer to a corresponding struct. This auxiliary external function is now compatible with functions defined in C using pointers to C structs corresponding to a memref descriptor.

Definition at line 173 of file FuncToLLVM.cpp.

References mlir::LLVMTypeConverter::convertFunctionTypeCWrapper(), filterFuncAttributes(), mlir::Builder::getContext(), mlir::Builder::getIndexType(), mlir::Builder::getIntegerAttr(), mlir::MemRefDescriptor::getNumUnpackedValues(), mlir::UnrankedMemRefDescriptor::getNumUnpackedValues(), mlir::Value::getType(), mlir::MemRefDescriptor::pack(), mlir::UnrankedMemRefDescriptor::pack(), propagateArgResAttrs(), result, and mlir::OpBuilder::setInsertionPointToStart().

Referenced by wrapWithCInterface().

◆ wrapForExternalCallers()

void wrapForExternalCallers	(	OpBuilder &	rewriter,
		Location	loc,
		const LLVMTypeConverter &	typeConverter,
		FunctionOpInterface	funcOp,
		LLVM::LLVMFuncOp	newFuncOp )

static

Creates an auxiliary function with pointer-to-memref-descriptor-struct arguments instead of unpacked arguments.

This function can be called from C by passing a pointer to a C struct corresponding to a memref descriptor. Similarly, returned memrefs are passed via pointers to a C struct that is passed as additional argument. Internally, the auxiliary function unpacks the descriptor into individual components and forwards them to newFuncOp and forwards the results to the extra arguments.

Definition at line 113 of file FuncToLLVM.cpp.

References mlir::LLVMTypeConverter::convertFunctionTypeCWrapper(), filterFuncAttributes(), propagateArgResAttrs(), mlir::OpBuilder::setInsertionPointToStart(), mlir::MemRefDescriptor::unpack(), and mlir::UnrankedMemRefDescriptor::unpack().

Referenced by wrapWithCInterface().

◆ wrapWithCInterface()

void wrapWithCInterface	(	FunctionOpInterface	funcOp,
		ConversionPatternRewriter &	rewriter,
		const LLVMTypeConverter &	converter,
		LLVM::LLVMFuncOp	newFuncOp )

static

Definition at line 425 of file FuncToLLVM.cpp.

References wrapExternalFunction(), and wrapForExternalCallers().

Referenced by mlir::convertFuncOpToLLVMFuncOp().

Variable Documentation

◆ barePtrAttrName

StringRef barePtrAttrName = "llvm.bareptr"

staticconstexpr

Definition at line 56 of file FuncToLLVM.cpp.

Referenced by shouldUseBarePtrCallConv().

◆ linkageAttrName

StringRef linkageAttrName = "llvm.linkage"

staticconstexpr

Definition at line 55 of file FuncToLLVM.cpp.

Referenced by isDiscardableAttr().

◆ varargsAttrName

StringRef varargsAttrName = "func.varargs"

staticconstexpr

Definition at line 54 of file FuncToLLVM.cpp.

Referenced by convertFuncSignature(), and isDiscardableAttr().

Classes

Namespaces

Macros

Functions

Variables

Macro Definition Documentation

◆ DEBUG_TYPE

◆ GEN_PASS_DEF_CONVERTFUNCTOLLVMPASS

◆ GEN_PASS_DEF_SETLLVMMODULEDATALAYOUTPASS

◆ PASS_NAME

Function Documentation

◆ convertArgumentAttributes()

◆ convertFuncSignature()

◆ createLLVMFuncOp()

◆ filterFuncAttributes()

◆ isDiscardableAttr()

◆ propagateArgResAttrs()

◆ propagateFunctionArgResAttrs()

◆ restoreByValRefArgumentType()

◆ shouldUseBarePtrCallConv()

◆ wrapExternalFunction()

◆ wrapForExternalCallers()

◆ wrapWithCInterface()

Variable Documentation

◆ barePtrAttrName

◆ linkageAttrName

◆ varargsAttrName