mlir::WalkResult Class Reference

A utility result that is used to signal how to proceed with an ongoing walk: More...

#include "mlir/IR/Visitors.h"

Public Member Functions
	WalkResult (ResultEnum result=Advance)
	WalkResult (LogicalResult result)
	Allow LogicalResult to interrupt the walk on failure. More...
	WalkResult (Diagnostic &&)
	Allow diagnostics to interrupt the walk. More...
	WalkResult (InFlightDiagnostic &&)
bool	operator== (const WalkResult &rhs) const
bool	operator!= (const WalkResult &rhs) const
bool	wasInterrupted () const
	Returns true if the walk was interrupted. More...
bool	wasSkipped () const
	Returns true if the walk was skipped. More...

Static Public Member Functions
static WalkResult	interrupt ()
static WalkResult	advance ()
static WalkResult	skip ()

Detailed Description

A utility result that is used to signal how to proceed with an ongoing walk:

• Interrupt: the walk will be interrupted and no more operations, regions or blocks will be visited.
• Advance: the walk will continue.
• Skip: the walk of the current operation, region or block and their nested elements that haven't been visited already will be skipped and will continue with the next operation, region or block.

Definition at line 33 of file Visitors.h.

Constructor & Destructor Documentation

WalkResult() [1/4]

mlir::WalkResult::WalkResult ( ResultEnum  result = Advance )

inline

Definition at line 37 of file Visitors.h.

WalkResult() [2/4]

mlir::WalkResult::WalkResult ( LogicalResult  result )

inline

Allow LogicalResult to interrupt the walk on failure.

Definition at line 40 of file Visitors.h.

WalkResult() [3/4]

mlir::WalkResult::WalkResult ( Diagnostic &&  )

inline

Allow diagnostics to interrupt the walk.

Definition at line 44 of file Visitors.h.

WalkResult() [4/4]

mlir::WalkResult::WalkResult ( InFlightDiagnostic &&  )

inline

Definition at line 45 of file Visitors.h.

Member Function Documentation

advance()

static WalkResult mlir::WalkResult::advance ( )

inlinestatic

Definition at line 51 of file Visitors.h.

Referenced by mlir::detail::AttrTypeReplacerBase< Concrete >::addReplacement(), mlir::AttrTypeWalker::addWalk(), areInnerBoundsInvariant(), canBeHoisted(), checkTransformationPreconditions(), collectLocationsFromLoc(), constructIsCancellable(), mlir::OperationConverter::convertOperations(), mlir::xegpu::doSCFStructuralTypeConversionWithTensorType(), emit(), mlir::smt::exportSMTLIB(), mlir::LocationAttr::findInstanceOf(), findPayloadRoot(), mlir::transform::gpu::findTopLevelForallOp(), mlir::transform::detail::findTransformEntryPoint(), findVariableDecl(), mlir::bufferization::OneShotAnalysisState::gatherUndefinedTensorUses(), getBackwardSliceImpl(), getEffectsAfter(), getEffectsBefore(), getFuncOpsOrderedByCalls(), getLastDependentOpInRange(), getLocationFromLoc(), mlir::affine::getLoopNestStats(), getMemoryFootprintBytes(), getSingleOpOfType(), getSymbolUsesImpl(), handleLoopAnnotations(), haveNoReadsAfterWriteExceptSameIndex(), hoistAffineIfOp(), mlir::linalg::hoistRedundantVectorBroadcasts(), mlir::linalg::hoistRedundantVectorTransfers(), mlir::bufferization::insertTensorCopies(), interruptIfValidLocation(), mlir::affine::isLoopMemoryParallel(), isNormalizedMemRefDynamicDim(), isOpReady(), mlir::irdl::loadDialects(), loadOperation(), mlir::transform::gpu::mapNestedForallToThreadsImpl(), AllocaScopeInliner::matchAndRewrite(), GpuAsyncRegionPass::ThreadTokenCallback::operator()(), printFunctionBody(), replaceAllSymbolUsesImpl(), replaceElementImpl(), rewriteAffineOpAfterPeeling(), mlir::LLVM::ModuleTranslation::stackWalk(), symbolKnownUseEmptyImpl(), unwrap(), updateReturnOps(), verifyBlockTags(), verifyQuantifierRegions(), mlir::detail::verifySymbolTable(), mlir::Block::walk(), mlir::Region::walk(), mlir::detail::walk(), walkReferenceCountedValues(), walkSymbolTable(), and walkSymbolUses().

interrupt()

static WalkResult mlir::WalkResult::interrupt ( )

inlinestatic

Definition at line 50 of file Visitors.h.

Referenced by areInnerBoundsInvariant(), canBeHoisted(), checkTransformationPreconditions(), constructIsCancellable(), convertOmpLoopNest(), mlir::smt::exportSMTLIB(), findAllocaInsertPoint(), findCurrentLoopInfo(), mlir::LocationAttr::findInstanceOf(), findPayloadRoot(), mlir::transform::gpu::findTopLevelForallOp(), mlir::transform::detail::findTransformEntryPoint(), findVariableDecl(), getEffectsAfter(), getEffectsBefore(), getLastDependentOpInRange(), getLocationFromLoc(), mlir::affine::getLoopNestStats(), getSingleOpOfType(), hasNestedParallelOp(), haveNoReadsAfterWriteExceptSameIndex(), hoistAffineIfOp(), mlir::linalg::hoistRedundantVectorBroadcasts(), mlir::linalg::hoistRedundantVectorTransfers(), mlir::bufferization::insertTensorCopies(), interruptIfValidLocation(), isInnermostAffineForOp(), mlir::affine::isLoopMemoryParallel(), isNormalizedMemRefDynamicDim(), isOpReady(), mlir::irdl::loadDialects(), loadOperation(), mlir::transform::gpu::mapNestedForallToThreadsImpl(), AllocaScopeInliner::matchAndRewrite(), GpuAsyncRegionPass::ThreadTokenCallback::operator()(), unwrap(), verifyQuantifierRegions(), mlir::Block::walk(), mlir::Region::walk(), mlir::detail::walk(), mlir::AffineExprVisitor< SubClass, RetTy >::walkPostOrder(), walkReferenceCountedValues(), walkSymbolRefs(), and walkSymbolUses().

operator!=()

bool mlir::WalkResult::operator!= ( const WalkResult &  rhs ) const

inline

Definition at line 48 of file Visitors.h.

operator==()

bool mlir::WalkResult::operator== ( const WalkResult &  rhs ) const

inline

Definition at line 47 of file Visitors.h.

skip()

static WalkResult mlir::WalkResult::skip ( )

inlinestatic

Definition at line 52 of file Visitors.h.

Referenced by mlir::OperationConverter::convertOperations(), mlir::xegpu::doSCFStructuralTypeConversionWithTensorType(), mlir::bufferization::OneShotAnalysisState::gatherUndefinedTensorUses(), getFuncOpsOrderedByCalls(), mlir::bufferization::insertTensorCopies(), mlir::transform::gpu::mapNestedForallToThreadsImpl(), AllocaScopeInliner::matchAndRewrite(), printFunctionBody(), remapInlinedLocations(), replaceAllSymbolUsesImpl(), mlir::LLVM::ModuleTranslation::stackWalk(), unwrap(), mlir::LocationAttr::walk(), and walkSymbolRefs().

wasInterrupted()

bool mlir::WalkResult::wasInterrupted ( ) const

inline

Returns true if the walk was interrupted.

Definition at line 55 of file Visitors.h.

Referenced by checkTransformationPreconditions(), findAllocaInsertPoint(), findPayloadRoot(), getFuncOpsOrderedByCalls(), mlir::bufferization::insertTensorCopies(), isOpReady(), mlir::irdl::loadDialects(), mlir::transform::gpu::mapNestedForallToThreadsImpl(), printFunctionBody(), replaceElementImpl(), mlir::LLVM::ModuleTranslation::stackWalk(), verifyBlockTags(), mlir::detail::walk(), and walkReferenceCountedValues().

wasSkipped()

bool mlir::WalkResult::wasSkipped ( ) const

inline

Returns true if the walk was skipped.

Definition at line 58 of file Visitors.h.

Referenced by replaceElementImpl(), and mlir::detail::walk().

---

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

• include/mlir/IR/Visitors.h