MLIR  19.0.0git
Public Member Functions | List of all members
mlir::OneToNConversionPattern Class Referenceabstract

Base class for patterns with 1:N type conversions. More...

#include "mlir/Transforms/OneToNTypeConversion.h"

+ Inheritance diagram for mlir::OneToNConversionPattern:

Public Member Functions

virtual LogicalResult matchAndRewrite (Operation *op, OneToNPatternRewriter &rewriter, const OneToNTypeMapping &operandMapping, const OneToNTypeMapping &resultMapping, ValueRange convertedOperands) const =0
 This function has to be implemented by derived classes and is called from the usual overloads. More...
 
LogicalResult matchAndRewrite (Operation *op, PatternRewriter &rewriter) const final
 Attempt to match against code rooted at the specified operation, which is the same operation code as getRootKind(). More...
 
template<typename... Args>
 RewritePatternWithConverter (TypeConverter &typeConverter, Args &&...args)
 Construct a conversion pattern with the given converter, and forward the remaining arguments to RewritePattern. More...
 
- Public Member Functions inherited from mlir::RewritePatternWithConverter
template<typename... Args>
 RewritePatternWithConverter (TypeConverter &typeConverter, Args &&...args)
 Construct a conversion pattern with the given converter, and forward the remaining arguments to RewritePattern. More...
 
TypeConvertergetTypeConverter () const
 Return the type converter held by this pattern, or nullptr if the pattern does not require type conversion. More...
 
template<typename ConverterTy >
std::enable_if_t< std::is_base_of< TypeConverter, ConverterTy >::value, ConverterTy * > getTypeConverter () const
 
- Public Member Functions inherited from mlir::RewritePattern
virtual ~RewritePattern ()=default
 
virtual void rewrite (Operation *op, PatternRewriter &rewriter) const
 Rewrite the IR rooted at the specified operation with the result of this pattern, generating any new operations with the specified builder. More...
 
virtual LogicalResult match (Operation *op) const
 Attempt to match against code rooted at the specified operation, which is the same operation code as getRootKind(). More...
 
- Public Member Functions inherited from mlir::Pattern
ArrayRef< OperationNamegetGeneratedOps () const
 Return a list of operations that may be generated when rewriting an operation instance with this pattern. More...
 
std::optional< OperationNamegetRootKind () const
 Return the root node that this pattern matches. More...
 
std::optional< TypeIDgetRootInterfaceID () const
 Return the interface ID used to match the root operation of this pattern. More...
 
std::optional< TypeIDgetRootTraitID () const
 Return the trait ID used to match the root operation of this pattern. More...
 
PatternBenefit getBenefit () const
 Return the benefit (the inverse of "cost") of matching this pattern. More...
 
bool hasBoundedRewriteRecursion () const
 Returns true if this pattern is known to result in recursive application, i.e. More...
 
MLIRContextgetContext () const
 Return the MLIRContext used to create this pattern. More...
 
StringRef getDebugName () const
 Return a readable name for this pattern. More...
 
void setDebugName (StringRef name)
 Set the human readable debug name used for this pattern. More...
 
ArrayRef< StringRef > getDebugLabels () const
 Return the set of debug labels attached to this pattern. More...
 
void addDebugLabels (ArrayRef< StringRef > labels)
 Add the provided debug labels to this pattern. More...
 
void addDebugLabels (StringRef label)
 

Additional Inherited Members

- Static Public Member Functions inherited from mlir::RewritePattern
template<typename T , typename... Args>
static std::unique_ptr< T > create (Args &&...args)
 This method provides a convenient interface for creating and initializing derived rewrite patterns of the given type T. More...
 
- Protected Member Functions inherited from mlir::RewritePattern
 Pattern (StringRef rootName, PatternBenefit benefit, MLIRContext *context, ArrayRef< StringRef > generatedNames={})
 Inherit the base constructors from Pattern. More...
 
 Pattern (MatchAnyOpTypeTag tag, PatternBenefit benefit, MLIRContext *context, ArrayRef< StringRef > generatedNames={})
 Inherit the base constructors from Pattern. More...
 
 Pattern (MatchInterfaceOpTypeTag tag, TypeID interfaceID, PatternBenefit benefit, MLIRContext *context, ArrayRef< StringRef > generatedNames={})
 Inherit the base constructors from Pattern. More...
 
 Pattern (MatchTraitOpTypeTag tag, TypeID traitID, PatternBenefit benefit, MLIRContext *context, ArrayRef< StringRef > generatedNames={})
 Inherit the base constructors from Pattern. More...
 
- Protected Member Functions inherited from mlir::Pattern
 Pattern (StringRef rootName, PatternBenefit benefit, MLIRContext *context, ArrayRef< StringRef > generatedNames={})
 Construct a pattern with a certain benefit that matches the operation with the given root name. More...
 
 Pattern (MatchAnyOpTypeTag tag, PatternBenefit benefit, MLIRContext *context, ArrayRef< StringRef > generatedNames={})
 Construct a pattern that may match any operation type. More...
 
 Pattern (MatchInterfaceOpTypeTag tag, TypeID interfaceID, PatternBenefit benefit, MLIRContext *context, ArrayRef< StringRef > generatedNames={})
 Construct a pattern that may match any operation that implements the interface defined by the provided interfaceID. More...
 
 Pattern (MatchTraitOpTypeTag tag, TypeID traitID, PatternBenefit benefit, MLIRContext *context, ArrayRef< StringRef > generatedNames={})
 Construct a pattern that may match any operation that implements the trait defined by the provided traitID. More...
 
void setHasBoundedRewriteRecursion (bool hasBoundedRecursionArg=true)
 Set the flag detailing if this pattern has bounded rewrite recursion or not. More...
 
- Protected Attributes inherited from mlir::RewritePatternWithConverter
TypeConverter *const typeConverter
 A type converter for use by this pattern. More...
 

Detailed Description

Base class for patterns with 1:N type conversions.

Derived classes have to overwrite the matchAndRewrite overlaod that provides additional information for 1:N type conversions.

Definition at line 184 of file OneToNTypeConversion.h.

Member Function Documentation

◆ matchAndRewrite() [1/2]

virtual LogicalResult mlir::OneToNConversionPattern::matchAndRewrite ( Operation op,
OneToNPatternRewriter rewriter,
const OneToNTypeMapping operandMapping,
const OneToNTypeMapping resultMapping,
ValueRange  convertedOperands 
) const
pure virtual

This function has to be implemented by derived classes and is called from the usual overloads.

Like in "normal" DialectConversion, the function is provided with the converted operands (which thus have target types). Since 1:N conversions are supported, there is usually no 1:1 relationship between the original and the converted operands. Instead, the provided operandMapping can be used to access the converted operands that correspond to a particular original operand. Similarly, resultMapping is provided to help with assembling the result values, which may have 1:N correspondences as well. In that case, the original op should be replaced with the overload of replaceOp that takes the provided resultMapping in order to deal with the mapping of converted result values to their usages in the original types correctly.

Implemented in mlir::OneToNOpConversionPattern< SourceOp >, mlir::OneToNOpConversionPattern< WhileOp >, mlir::OneToNOpConversionPattern< ConditionOp >, mlir::OneToNOpConversionPattern< ForOp >, mlir::OneToNOpConversionPattern< YieldOp >, and mlir::OneToNOpConversionPattern< IfOp >.

◆ matchAndRewrite() [2/2]

LogicalResult OneToNConversionPattern::matchAndRewrite ( Operation op,
PatternRewriter rewriter 
) const
finalvirtual

Attempt to match against code rooted at the specified operation, which is the same operation code as getRootKind().

If successful, this function will automatically perform the rewrite.

Reimplemented from mlir::RewritePattern.

Definition at line 269 of file OneToNTypeConversion.cpp.

◆ RewritePatternWithConverter()

template<typename... Args>
mlir::RewritePatternWithConverter::RewritePatternWithConverter ( typename...  Args)
inline

Construct a conversion pattern with the given converter, and forward the remaining arguments to RewritePattern.

Definition at line 129 of file OneToNTypeConversion.h.


The documentation for this class was generated from the following files: