Options for BufferizableOpInterface-based bufferization. More...
#include "mlir/Dialect/Bufferization/IR/BufferizableOpInterface.h"
Inheritance diagram for mlir::bufferization::BufferizationOptions:Public Types | |
| using | AllocationFn = std::function< FailureOr< Value >(OpBuilder &, Location, MemRefType, ValueRange, unsigned int)> |
| Allocator function: Generate a memref allocation with the given type, dynamic extents and alignment. More... | |
| using | MemCpyFn = std::function< LogicalResult(OpBuilder &, Location, Value, Value)> |
| Memcpy function: Generate a memcpy between two buffers. More... | |
| using | AnalysisStateInitFn = std::function< void(AnalysisState &)> |
| Initializer function for analysis state. More... | |
| using | FunctionArgTypeConverterFn = std::function< BufferLikeType(TensorLikeType, Attribute memorySpace, func::FuncOp, const BufferizationOptions &)> |
| Tensor-like -> Buffer-like type conversion. More... | |
| using | UnknownTypeConverterFn = std::function< BaseMemRefType(TensorType, Attribute memorySpace, const BufferizationOptions &)> |
| Tensor -> MemRef type conversion. More... | |
| using | DefaultMemorySpaceFn = std::function< std::optional< Attribute >(TensorType t)> |
Public Member Functions | |
| BufferizationOptions () | |
| BufferizableOpInterface | dynCastBufferizableOp (Operation *op) const |
| Try to cast the given op to BufferizableOpInterface if the op is allow listed. More... | |
| BufferizableOpInterface | dynCastBufferizableOp (Value value) const |
| Try to cast the given value to BufferizableOpInterface if the op is allow listed. More... | |
| bool | isOpAllowed (Operation *op) const |
Return true if the given op should be bufferized. More... | |
| FailureOr< Value > | createAlloc (OpBuilder &b, Location loc, MemRefType type, ValueRange dynShape) const |
| Create a memref allocation with the given type and dynamic extents. More... | |
| LogicalResult | createMemCpy (OpBuilder &b, Location loc, Value from, Value to) const |
| Creates a memcpy between two given buffers. More... | |
| void | setFunctionBoundaryTypeConversion (LayoutMapOption layoutMapOption) |
| This function controls buffer types on function signatures. More... | |
Public Attributes | |
| OpFilter | opFilter |
| A filter that specifies which ops should be bufferized and which ops should be ignored. More... | |
| std::optional< AllocationFn > | allocationFn |
| Helper functions for allocation and memory copying. More... | |
| std::optional< MemCpyFn > | memCpyFn |
| bool | allowUnknownOps = false |
| Specifies whether not bufferizable ops are allowed in the input. More... | |
| bool | bufferizeFunctionBoundaries = false |
| Specifies whether function boundaries (ops in the func dialect) should be bufferized or not. More... | |
| bool | checkParallelRegions = true |
| FunctionArgTypeConverterFn | functionArgTypeConverterFn = nullptr |
| Type conversion from tensors to buffers. More... | |
| bool | inferFunctionResultLayout = true |
| If true, function result types are inferred from the body of the function. More... | |
| UnknownTypeConverterFn | unknownTypeConverterFn = nullptr |
| Type conversion from tensors to memrefs. More... | |
| DefaultMemorySpaceFn | defaultMemorySpaceFn |
| bool | copyBeforeWrite = false |
If set to true, the analysis is skipped. More... | |
| bool | testAnalysisOnly = false |
If set to true, does not modify the IR apart from adding attributes (for checking the results of the analysis) and post analysis steps. More... | |
| bool | printConflicts = false |
If set to true, the IR is annotated with details about RaW conflicts. More... | |
| unsigned int | bufferAlignment = 64 |
| Buffer alignment for new memory allocations. More... | |
| SmallVector< AnalysisStateInitFn > | stateInitializers |
| Initializer functions for analysis state. More... | |
Detailed Description
Options for BufferizableOpInterface-based bufferization.
Definition at line 253 of file BufferizableOpInterface.h.
Member Typedef Documentation
◆ AllocationFn
| using mlir::bufferization::BufferizationOptions::AllocationFn = std::function<FailureOr<Value>( OpBuilder &, Location, MemRefType, ValueRange, unsigned int)> |
Allocator function: Generate a memref allocation with the given type, dynamic extents and alignment.
Definition at line 256 of file BufferizableOpInterface.h.
◆ AnalysisStateInitFn
| using mlir::bufferization::BufferizationOptions::AnalysisStateInitFn = std::function<void(AnalysisState &)> |
Initializer function for analysis state.
Definition at line 262 of file BufferizableOpInterface.h.
◆ DefaultMemorySpaceFn
| using mlir::bufferization::BufferizationOptions::DefaultMemorySpaceFn = std::function<std::optional<Attribute>(TensorType t)> |
Definition at line 273 of file BufferizableOpInterface.h.
◆ FunctionArgTypeConverterFn
| using mlir::bufferization::BufferizationOptions::FunctionArgTypeConverterFn = std::function<BufferLikeType(TensorLikeType, Attribute memorySpace, func::FuncOp, const BufferizationOptions &)> |
Tensor-like -> Buffer-like type conversion.
Parameters: tensor-like type, memory space, func op, bufferization options
Definition at line 265 of file BufferizableOpInterface.h.
◆ MemCpyFn
| using mlir::bufferization::BufferizationOptions::MemCpyFn = std::function<LogicalResult(OpBuilder &, Location, Value, Value)> |
Memcpy function: Generate a memcpy between two buffers.
Definition at line 259 of file BufferizableOpInterface.h.
◆ UnknownTypeConverterFn
| using mlir::bufferization::BufferizationOptions::UnknownTypeConverterFn = std::function<BaseMemRefType( TensorType, Attribute memorySpace, const BufferizationOptions &)> |
Tensor -> MemRef type conversion.
Parameters: tensor type, memory space, bufferization options
Definition at line 270 of file BufferizableOpInterface.h.
Constructor & Destructor Documentation
◆ BufferizationOptions()
| BufferizationOptions::BufferizationOptions | ( | ) |
Definition at line 367 of file BufferizableOpInterface.cpp.
Member Function Documentation
◆ createAlloc()
| FailureOr< Value > BufferizationOptions::createAlloc | ( | OpBuilder & | b, |
| Location | loc, | ||
| MemRefType | type, | ||
| ValueRange | dynShape | ||
| ) | const |
Create a memref allocation with the given type and dynamic extents.
Definition at line 788 of file BufferizableOpInterface.cpp.
References allocationFn, bufferAlignment, and mlir::Builder::getI64IntegerAttr().
◆ createMemCpy()
| LogicalResult BufferizationOptions::createMemCpy | ( | OpBuilder & | b, |
| Location | loc, | ||
| Value | from, | ||
| Value | to | ||
| ) | const |
Creates a memcpy between two given buffers.
Create a memory copy between two memref buffers.
Definition at line 803 of file BufferizableOpInterface.cpp.
References memCpyFn.
◆ dynCastBufferizableOp() [1/2]
| BufferizableOpInterface BufferizationOptions::dynCastBufferizableOp | ( | Operation * | op | ) | const |
Try to cast the given op to BufferizableOpInterface if the op is allow listed.
Definition at line 382 of file BufferizableOpInterface.cpp.
References isOpAllowed().
Referenced by mlir::bufferization::AnalysisState::bufferizesToMemoryWrite(), dynCastBufferizableOp(), mlir::bufferization::AnalysisState::findValueInReverseUseDefChain(), mlir::bufferization::OneShotAnalysisState::gatherUndefinedTensorUses(), and mlir::bufferization::insertTensorCopies().
◆ dynCastBufferizableOp() [2/2]
| BufferizableOpInterface BufferizationOptions::dynCastBufferizableOp | ( | Value | value | ) | const |
Try to cast the given value to BufferizableOpInterface if the op is allow listed.
Definition at line 392 of file BufferizableOpInterface.cpp.
References dynCastBufferizableOp(), and mlir::bufferization::getOwnerOfValue().
◆ isOpAllowed()
| bool BufferizationOptions::isOpAllowed | ( | Operation * | op | ) | const |
Return true if the given op should be bufferized.
Definition at line 371 of file BufferizableOpInterface.cpp.
References bufferizeFunctionBoundaries, mlir::Operation::getDialect(), mlir::bufferization::OpFilter::isOpAllowed(), and opFilter.
Referenced by dynCastBufferizableOp(), and mlir::bufferization::OneShotAnalysisState::OneShotAnalysisState().
◆ setFunctionBoundaryTypeConversion()
| void BufferizationOptions::setFunctionBoundaryTypeConversion | ( | LayoutMapOption | layoutMapOption | ) |
This function controls buffer types on function signatures.
Sets functionArgTypeConverterFn and inferFunctionResultLayout accordingly.
- InferLayoutMap: All function parameter types have a fully dynamic layout map, but function result types are inferred from the body of the function.
- FullyDynamicLayoutMap: All function parameter types and result types have a fully dynamic layout map. This option is most efficient because any layout map can be casted to a fully dynamic one.
- IdentityLayoutMap: All function parameter types and result types have a static identity layout (i.e., no layout map). This option may introduce additional buffer allocs and copies because layout maps cannot be casted away.
Note: Inferred layout maps may not be desireable when interacting with external functions, because the generated function signatures will be less predictable.
Definition at line 396 of file BufferizableOpInterface.cpp.
References functionArgTypeConverterFn, mlir::bufferization::getMemRefTypeWithFullyDynamicLayout(), mlir::bufferization::getMemRefTypeWithStaticIdentityLayout(), inferFunctionResultLayout, and options.
Member Data Documentation
◆ allocationFn
| std::optional<AllocationFn> mlir::bufferization::BufferizationOptions::allocationFn |
Helper functions for allocation and memory copying.
Definition at line 294 of file BufferizableOpInterface.h.
Referenced by createAlloc().
◆ allowUnknownOps
| bool mlir::bufferization::BufferizationOptions::allowUnknownOps = false |
Specifies whether not bufferizable ops are allowed in the input.
If so, bufferization.to_buffer and bufferization.to_tensor ops are inserted at the boundaries.
Definition at line 308 of file BufferizableOpInterface.h.
◆ bufferAlignment
| unsigned int mlir::bufferization::BufferizationOptions::bufferAlignment = 64 |
Buffer alignment for new memory allocations.
Definition at line 380 of file BufferizableOpInterface.h.
Referenced by createAlloc().
◆ bufferizeFunctionBoundaries
| bool mlir::bufferization::BufferizationOptions::bufferizeFunctionBoundaries = false |
Specifies whether function boundaries (ops in the func dialect) should be bufferized or not.
Definition at line 312 of file BufferizableOpInterface.h.
Referenced by isOpAllowed().
◆ checkParallelRegions
| bool mlir::bufferization::BufferizationOptions::checkParallelRegions = true |
Definition at line 317 of file BufferizableOpInterface.h.
◆ copyBeforeWrite
| bool mlir::bufferization::BufferizationOptions::copyBeforeWrite = false |
If set to true, the analysis is skipped.
A buffer is copied before every write. This flag cannot be used together with testAnalysisOnly = true.
Definition at line 369 of file BufferizableOpInterface.h.
◆ defaultMemorySpaceFn
| DefaultMemorySpaceFn mlir::bufferization::BufferizationOptions::defaultMemorySpaceFn |
Definition at line 364 of file BufferizableOpInterface.h.
◆ functionArgTypeConverterFn
| FunctionArgTypeConverterFn mlir::bufferization::BufferizationOptions::functionArgTypeConverterFn = nullptr |
Type conversion from tensors to buffers.
This type conversion is used to determine bufferized function argument and result types.
By default, if tensor is a (builtin) tensor type, it is converted to a memref type with a fully dynamic layout map; if tensor is a (generic) tensor-like type, it is converted using TensorLikeType::getBufferType().
If bufferizeFunctionBoundaries is not set, this function isn't used.
Definition at line 346 of file BufferizableOpInterface.h.
Referenced by setFunctionBoundaryTypeConversion().
◆ inferFunctionResultLayout
| bool mlir::bufferization::BufferizationOptions::inferFunctionResultLayout = true |
If true, function result types are inferred from the body of the function.
Otherwise, function result type is determined by functionArgTypeConverterFn.
If bufferizeFunctionBoundaries is not set, this flag has no effect.
Definition at line 353 of file BufferizableOpInterface.h.
Referenced by setFunctionBoundaryTypeConversion().
◆ memCpyFn
| std::optional<MemCpyFn> mlir::bufferization::BufferizationOptions::memCpyFn |
Definition at line 295 of file BufferizableOpInterface.h.
Referenced by createMemCpy().
◆ opFilter
| OpFilter mlir::bufferization::BufferizationOptions::opFilter |
A filter that specifies which ops should be bufferized and which ops should be ignored.
Definition at line 288 of file BufferizableOpInterface.h.
Referenced by isOpAllowed(), and mlir::sparse_tensor::SparsificationAndBufferizationPass::runDenseBufferization().
◆ printConflicts
| bool mlir::bufferization::BufferizationOptions::printConflicts = false |
If set to true, the IR is annotated with details about RaW conflicts.
For debugging only. Should be used together with testAnalysisOnly.
Definition at line 377 of file BufferizableOpInterface.h.
◆ stateInitializers
| SmallVector<AnalysisStateInitFn> mlir::bufferization::BufferizationOptions::stateInitializers |
Initializer functions for analysis state.
These can be used to initialize dialect-specific analysis state.
Definition at line 384 of file BufferizableOpInterface.h.
Referenced by mlir::bufferization::AnalysisState::AnalysisState().
◆ testAnalysisOnly
| bool mlir::bufferization::BufferizationOptions::testAnalysisOnly = false |
If set to true, does not modify the IR apart from adding attributes (for checking the results of the analysis) and post analysis steps.
Definition at line 373 of file BufferizableOpInterface.h.
Referenced by mlir::sparse_tensor::SparsificationAndBufferizationPass::runOnOperation().
◆ unknownTypeConverterFn
| UnknownTypeConverterFn mlir::bufferization::BufferizationOptions::unknownTypeConverterFn = nullptr |
Type conversion from tensors to memrefs.
This type conversion is used if no memref type could be inferred during bufferization. By default, returns a memref type with a fully dynamic layout map.
Definition at line 358 of file BufferizableOpInterface.h.
The documentation for this struct was generated from the following files:
- include/mlir/Dialect/Bufferization/IR/BufferizableOpInterface.h
- lib/Dialect/Bufferization/IR/BufferizableOpInterface.cpp
