MLIR  19.0.0git
Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
mlir::Block Class Reference

Block represents an ordered list of Operations. More...

#include "mlir/IR/Block.h"

+ Inheritance diagram for mlir::Block:

Public Types

using BlockArgListType = MutableArrayRef< BlockArgument >
 
using args_iterator = BlockArgListType::iterator
 
using reverse_args_iterator = BlockArgListType::reverse_iterator
 
using OpListType = llvm::iplist< Operation >
 This is the list of operations in the block. More...
 
using iterator = OpListType::iterator
 
using reverse_iterator = OpListType::reverse_iterator
 
template<typename OpT >
using op_iterator = detail::op_iterator< OpT, iterator >
 This class provides iteration over the held operations of a block for a specific operation type. More...
 
using pred_iterator = PredecessorIterator
 
using succ_iterator = SuccessorRange::iterator
 
- Public Types inherited from mlir::IRObjectWithUseList< BlockOperand >
using use_iterator = ValueUseIterator< BlockOperand >
 
using use_range = iterator_range< use_iterator >
 
using user_iterator = ValueUserIterator< use_iterator, BlockOperand >
 
using user_range = iterator_range< user_iterator >
 

Public Member Functions

 Block ()=default
 
 ~Block ()
 
void clear ()
 
RegiongetParent () const
 Provide a 'getParent' method for ilist_node_with_parent methods. More...
 
OperationgetParentOp ()
 Returns the closest surrounding operation that contains this block. More...
 
bool isEntryBlock ()
 Return if this block is the entry block in the parent region. More...
 
void insertBefore (Block *block)
 Insert this block (which must not already be in a region) right before the specified block. More...
 
void insertAfter (Block *block)
 Insert this block (which must not already be in a region) right after the specified block. More...
 
void moveBefore (Block *block)
 Unlink this block from its current region and insert it right before the specific block. More...
 
void moveBefore (Region *region, llvm::iplist< Block >::iterator iterator)
 Unlink this block from its current region and insert it right before the block that the given iterator points to in the region region. More...
 
void erase ()
 Unlink this Block from its parent region and delete it. More...
 
BlockArgListType getArguments ()
 
ValueTypeRange< BlockArgListTypegetArgumentTypes ()
 Return a range containing the types of the arguments for this block. More...
 
args_iterator args_begin ()
 
args_iterator args_end ()
 
reverse_args_iterator args_rbegin ()
 
reverse_args_iterator args_rend ()
 
bool args_empty ()
 
BlockArgument addArgument (Type type, Location loc)
 Add one value to the argument list. More...
 
BlockArgument insertArgument (args_iterator it, Type type, Location loc)
 Insert one value to the position in the argument list indicated by the given iterator. More...
 
iterator_range< args_iteratoraddArguments (TypeRange types, ArrayRef< Location > locs)
 Add one argument to the argument list for each type specified in the list. More...
 
BlockArgument insertArgument (unsigned index, Type type, Location loc)
 Add one value to the argument list at the specified position. More...
 
void eraseArgument (unsigned index)
 Erase the argument at 'index' and remove it from the argument list. More...
 
void eraseArguments (unsigned start, unsigned num)
 Erases 'num' arguments from the index 'start'. More...
 
void eraseArguments (const BitVector &eraseIndices)
 Erases the arguments that have their corresponding bit set in eraseIndices and removes them from the argument list. More...
 
void eraseArguments (function_ref< bool(BlockArgument)> shouldEraseFn)
 Erases arguments using the given predicate. More...
 
unsigned getNumArguments ()
 
BlockArgument getArgument (unsigned i)
 
OpListTypegetOperations ()
 
iterator begin ()
 
iterator end ()
 
reverse_iterator rbegin ()
 
reverse_iterator rend ()
 
bool empty ()
 
void push_back (Operation *op)
 
void push_front (Operation *op)
 
Operationback ()
 
Operationfront ()
 
OperationfindAncestorOpInBlock (Operation &op)
 Returns 'op' if 'op' lies in this block, or otherwise finds the ancestor operation of 'op' that lies in this block. More...
 
void dropAllReferences ()
 This drops all operand uses from operations within this block, which is an essential step in breaking cyclic dependences between references when they are to be deleted. More...
 
void dropAllDefinedValueUses ()
 This drops all uses of values defined in this block or in the blocks of nested regions wherever the uses are located. More...
 
bool isOpOrderValid ()
 Returns true if the ordering of the child operations is valid, false otherwise. More...
 
void invalidateOpOrder ()
 Invalidates the current ordering of operations. More...
 
bool verifyOpOrder ()
 Verifies the current ordering of child operations matches the validOpOrder flag. More...
 
void recomputeOpOrder ()
 Recomputes the ordering of child operations within the block. More...
 
template<typename OpT >
iterator_range< op_iterator< OpT > > getOps ()
 Return an iterator range over the operations within this block that are of 'OpT'. More...
 
template<typename OpT >
op_iterator< OpT > op_begin ()
 
template<typename OpT >
op_iterator< OpT > op_end ()
 
iterator_range< iteratorwithout_terminator ()
 Return an iterator range over the operation within this block excluding the terminator operation at the end. More...
 
OperationgetTerminator ()
 Get the terminator operation of this block. More...
 
bool mightHaveTerminator ()
 Check whether this block might have a terminator. More...
 
pred_iterator pred_begin ()
 
pred_iterator pred_end ()
 
iterator_range< pred_iteratorgetPredecessors ()
 
bool hasNoPredecessors ()
 Return true if this block has no predecessors. More...
 
bool hasNoSuccessors ()
 Returns true if this blocks has no successors. More...
 
BlockgetSinglePredecessor ()
 If this block has exactly one predecessor, return it. More...
 
BlockgetUniquePredecessor ()
 If this block has a unique predecessor, i.e., all incoming edges originate from one block, return it. More...
 
unsigned getNumSuccessors ()
 
BlockgetSuccessor (unsigned i)
 
succ_iterator succ_begin ()
 
succ_iterator succ_end ()
 
SuccessorRange getSuccessors ()
 
template<WalkOrder Order = WalkOrder::PostOrder, typename Iterator = ForwardIterator, typename FnT , typename ArgT = detail::first_argument<FnT>, typename RetT = detail::walkResultType<FnT>>
RetT walk (FnT &&callback)
 Walk all nested operations, blocks (including this block) or regions, depending on the type of callback. More...
 
template<WalkOrder Order = WalkOrder::PostOrder, typename Iterator = ForwardIterator, typename FnT , typename RetT = detail::walkResultType<FnT>>
RetT walk (Block::iterator begin, Block::iterator end, FnT &&callback)
 Walk all nested operations, blocks (excluding this block) or regions, depending on the type of callback, in the specified [begin, end) range of this block. More...
 
BlocksplitBlock (iterator splitBefore)
 Split the block into two blocks before the specified operation or iterator. More...
 
BlocksplitBlock (Operation *splitBeforeOp)
 
void print (raw_ostream &os)
 
void print (raw_ostream &os, AsmState &state)
 
void dump ()
 
void printAsOperand (raw_ostream &os, bool printType=true)
 Print out the name of the block without printing its body. More...
 
void printAsOperand (raw_ostream &os, AsmState &state)
 
- Public Member Functions inherited from mlir::IRObjectWithUseList< BlockOperand >
 ~IRObjectWithUseList ()
 
void dropAllUses ()
 Drop all uses of this object from their respective owners. More...
 
void replaceAllUsesWith (ValueT &&newValue)
 Replace all uses of 'this' value with the new value, updating anything in the IR that uses 'this' to use the other value instead. More...
 
void shuffleUseList (ArrayRef< unsigned > indices)
 Shuffle the use-list chain according to the provided indices vector, which need to represent a valid shuffle. More...
 
use_iterator use_begin () const
 
use_iterator use_end () const
 
use_range getUses () const
 Returns a range of all uses, which is useful for iterating over all uses. More...
 
bool hasOneUse () const
 Returns true if this value has exactly one use. More...
 
bool use_empty () const
 Returns true if this value has no uses. More...
 
user_iterator user_begin () const
 
user_iterator user_end () const
 
user_range getUsers () const
 Returns a range of all users. More...
 

Static Public Member Functions

static OpListType Block::* getSublistAccess (Operation *)
 Returns pointer to member of operation list. More...
 

Friends

struct llvm::ilist_traits< Block >
 

Additional Inherited Members

- Protected Member Functions inherited from mlir::IRObjectWithUseList< BlockOperand >
 IRObjectWithUseList ()=default
 
BlockOperandgetFirstUse () const
 Return the first operand that is using this value, for use by custom use/def iterators. More...
 

Detailed Description

Block represents an ordered list of Operations.

Definition at line 30 of file Block.h.

Member Typedef Documentation

◆ args_iterator

using mlir::Block::args_iterator = BlockArgListType::iterator

Definition at line 90 of file Block.h.

◆ BlockArgListType

Definition at line 83 of file Block.h.

◆ iterator

using mlir::Block::iterator = OpListType::iterator

Definition at line 138 of file Block.h.

◆ op_iterator

template<typename OpT >
using mlir::Block::op_iterator = detail::op_iterator<OpT, iterator>

This class provides iteration over the held operations of a block for a specific operation type.

Definition at line 186 of file Block.h.

◆ OpListType

using mlir::Block::OpListType = llvm::iplist<Operation>

This is the list of operations in the block.

Definition at line 134 of file Block.h.

◆ pred_iterator

Definition at line 230 of file Block.h.

◆ reverse_args_iterator

using mlir::Block::reverse_args_iterator = BlockArgListType::reverse_iterator

Definition at line 91 of file Block.h.

◆ reverse_iterator

using mlir::Block::reverse_iterator = OpListType::reverse_iterator

Definition at line 139 of file Block.h.

◆ succ_iterator

using mlir::Block::succ_iterator = SuccessorRange::iterator

Definition at line 262 of file Block.h.

Constructor & Destructor Documentation

◆ Block()

mlir::Block::Block ( )
explicitdefault

Referenced by splitBlock().

◆ ~Block()

Block::~Block ( )

Definition at line 19 of file Block.cpp.

References clear(), and verifyOpOrder().

Member Function Documentation

◆ addArgument()

BlockArgument Block::addArgument ( Type  type,
Location  loc 
)

◆ addArguments()

auto Block::addArguments ( TypeRange  types,
ArrayRef< Location locs 
)

Add one argument to the argument list for each type specified in the list.

locs is required to have the same number of elements as types.

Definition at line 159 of file Block.cpp.

Referenced by mlir::Region::addArguments(), mlir::OpBuilder::createBlock(), and mlir::ControlFlowToSCFTransformation::createStructuredDoWhileLoopOp().

◆ args_begin()

args_iterator mlir::Block::args_begin ( )
inline

Definition at line 92 of file Block.h.

References getArguments().

◆ args_empty()

bool mlir::Block::args_empty ( )
inline

Definition at line 97 of file Block.h.

Referenced by collapseBranch().

◆ args_end()

args_iterator mlir::Block::args_end ( )
inline

Definition at line 93 of file Block.h.

References getArguments().

◆ args_rbegin()

reverse_args_iterator mlir::Block::args_rbegin ( )
inline

Definition at line 94 of file Block.h.

References getArguments().

◆ args_rend()

reverse_args_iterator mlir::Block::args_rend ( )
inline

Definition at line 95 of file Block.h.

References getArguments().

◆ back()

Operation& mlir::Block::back ( )
inline

◆ begin()

iterator mlir::Block::begin ( )
inline

◆ clear()

void mlir::Block::clear ( )
inline

Definition at line 36 of file Block.h.

References dropAllReferences(), and empty().

Referenced by ~Block().

◆ dropAllDefinedValueUses()

void Block::dropAllDefinedValueUses ( )

This drops all uses of values defined in this block or in the blocks of nested regions wherever the uses are located.

Definition at line 93 of file Block.cpp.

References getArguments().

Referenced by mlir::Operation::dropAllDefinedValueUses(), and mlir::detail::ConversionPatternRewriterImpl::SingleEraseRewriter::eraseBlock().

◆ dropAllReferences()

void Block::dropAllReferences ( )

This drops all operand uses from operations within this block, which is an essential step in breaking cyclic dependences between references when they are to be deleted.

Definition at line 88 of file Block.cpp.

References mlir::Operation::dropAllReferences().

Referenced by clear(), and mlir::Region::dropAllReferences().

◆ dump()

void Block::dump ( )

Definition at line 3980 of file AsmPrinter.cpp.

References print().

◆ empty()

bool mlir::Block::empty ( )
inline

◆ end()

iterator mlir::Block::end ( )
inline

◆ erase()

void Block::erase ( )

Unlink this Block from its parent region and delete it.

Unlink this Block from its parent Region and delete it.

Definition at line 65 of file Block.cpp.

References mlir::Region::getBlocks(), and getParent().

Referenced by outlineKernelFuncImpl(), transformCyclesToSCFLoops(), and transformToStructuredCFBranches().

◆ eraseArgument()

void Block::eraseArgument ( unsigned  index)

Erase the argument at 'index' and remove it from the argument list.

Definition at line 192 of file Block.cpp.

Referenced by dropRedundantArguments(), mlir::Region::eraseArgument(), and pruneRedundantArguments().

◆ eraseArguments() [1/3]

void Block::eraseArguments ( const BitVector &  eraseIndices)

Erases the arguments that have their corresponding bit set in eraseIndices and removes them from the argument list.

Definition at line 209 of file Block.cpp.

References eraseArguments(), and mlir::BlockArgument::getArgNumber().

◆ eraseArguments() [2/3]

void Block::eraseArguments ( function_ref< bool(BlockArgument)>  shouldEraseFn)

Erases arguments using the given predicate.

If the predicate returns true, that argument is erased.

Definition at line 214 of file Block.cpp.

◆ eraseArguments() [3/3]

void Block::eraseArguments ( unsigned  start,
unsigned  num 
)

Erases 'num' arguments from the index 'start'.

Definition at line 200 of file Block.cpp.

Referenced by eraseArguments(), inlineIfCase(), and transformToStructuredCFBranches().

◆ findAncestorOpInBlock()

Operation * Block::findAncestorOpInBlock ( Operation op)

Returns 'op' if 'op' lies in this block, or otherwise finds the ancestor operation of 'op' that lies in this block.

Returns nullptr if the latter fails. TODO: This is very specific functionality that should live somewhere else, probably in Dominance.cpp.

Returns nullptr if the latter fails.

Definition at line 73 of file Block.cpp.

Referenced by mlir::bufferization::BufferPlacementAllocs::getStartOperation(), happensBefore(), neededValuesDominateInsertionPoint(), and srcAppearsBeforeDstInAncestralBlock().

◆ front()

Operation& mlir::Block::front ( )
inline

◆ getArgument()

BlockArgument mlir::Block::getArgument ( unsigned  i)
inline

◆ getArguments()

BlockArgListType mlir::Block::getArguments ( )
inline

Definition at line 85 of file Block.h.

Referenced by addBlockArgumentsFromOther(), addBodyWithPayloadOp(), mlir::OneToNPatternRewriter::applySignatureConversion(), mlir::detail::ConversionPatternRewriterImpl::applySignatureConversion(), args_begin(), args_end(), args_rbegin(), args_rend(), mlir::bufferization::bufferizeBlockSignature(), buildGenericRegion(), mlir::Region::cloneInto(), cloneToCollapsedOp< GenericOp >(), collapseBranch(), createAsyncDispatchFunction(), createBinarySearchFunc(), createHeapSortFunc(), createPartitionFunc(), createQuickSortFunc(), createShiftDownFunc(), createSingleExitBranchRegion(), createSingleExitingLatch(), createSortStableFunc(), mlir::ControlFlowToSCFTransformation::createStructuredDoWhileLoopOp(), dropAllDefinedValueUses(), dropRedundantArguments(), ensureDistinctSuccessors(), findPayloadOp(), fuseIfLegal(), mlir::sparse_tensor::FuncCallOrInlineGenerator< SubClass >::genCallOrInline(), generateFusedElementwiseOpRegion(), mlir::Region::getArguments(), mlir::RewriterBase::inlineBlockBefore(), inlineIfCase(), inlinePayload(), inlineWhileCase(), mlir::OperationEquivalence::isRegionEquivalentTo(), mlir::makeRegionIsolatedFromAbove(), matchSelectReduction(), matchSimpleReduction(), mlir::outlineSingleBlockRegion(), printOperation(), pruneRedundantArguments(), mlir::mesh::shardedBlockArgumentTypes(), mlir::mesh::spmdizeBlock(), mlir::scf::tileAndFuseConsumerOfSlice(), transformCyclesToSCFLoops(), transformToReduceLoop(), and transformToStructuredCFBranches().

◆ getArgumentTypes()

auto Block::getArgumentTypes ( )

◆ getNumArguments()

unsigned mlir::Block::getNumArguments ( )
inline

◆ getNumSuccessors()

unsigned Block::getNumSuccessors ( )

◆ getOperations()

OpListType& mlir::Block::getOperations ( )
inline

◆ getOps()

template<typename OpT >
iterator_range<op_iterator<OpT> > mlir::Block::getOps ( )
inline

Return an iterator range over the operations within this block that are of 'OpT'.

Definition at line 191 of file Block.h.

References begin(), and end().

Referenced by generateCollapsedIndexingRegion(), generateFusedElementwiseOpRegion(), handleInlinedAllocas(), and updateExpandedGenericOpRegion().

◆ getParent()

Region * Block::getParent ( ) const

Provide a 'getParent' method for ilist_node_with_parent methods.

We mark it as a const function because ilist_node_with_parent specifically requires a 'getParent() const' method. Once ilist_node removes this constraint, we should drop the const to fit the rest of the MLIR const model.

Definition at line 26 of file Block.cpp.

Referenced by llvm::ilist_traits<::mlir::Block >::addNodeToList(), mlir::detail::ConversionPatternRewriterImpl::applySignatureConversion(), mlir::sparse_tensor::Merger::buildExp(), mlir::OpBuilder::cloneRegionBefore(), collectUnderlyingAddressValues(), mlir::FunctionCallBuilder::create(), mlir::OpBuilder::createBlock(), createElementFPowIFunc(), createElementIPowIFunc(), ensureDistinctSuccessors(), erase(), mlir::Region::findAncestorBlockInRegion(), mlir::detail::DominanceInfoBase< IsPostDom >::findNearestCommonDominator(), generateCopy(), getBlockNumber(), mlir::bufferization::AnalysisState::getEnclosingRepetitiveRegion(), getInsertionRegion(), mlir::dataflow::CFGEdge::getLoc(), mlir::detail::DominanceInfoBase< IsPostDom >::getNode(), getParentOp(), mlir::Operation::getParentRegion(), mlir::detail::DominanceInfoBase< IsPostDom >::hasSSADominance(), mlir::ReductionNode::initialize(), mlir::RewriterBase::inlineRegionBefore(), insertAfter(), insertBefore(), isEntryBlock(), mlir::detail::DominanceInfoBase< IsPostDom >::isReachableFromEntry(), mayBeValidWithoutTerminator(), mlirBlockDetach(), moveBefore(), mlir::RewriterBase::moveBlockBefore(), printBlock(), mlir::detail::DominanceInfoBase< IsPostDom >::properlyDominates(), mlir::PostDominanceInfo::properlyPostDominates(), llvm::ilist_traits<::mlir::Block >::removeNodeFromList(), mlir::RewriterBase::splitBlock(), splitBlock(), mlir::mesh::spmdizeBlock(), mlir::SuccessorRange::SuccessorRange(), mlir::transformCFGToSCF(), transformCyclesToSCFLoops(), transformToReduceLoop(), transformToStructuredCFBranches(), and tryGetBlocksInSameRegion().

◆ getParentOp()

Operation * Block::getParentOp ( )

◆ getPredecessors()

iterator_range<pred_iterator> mlir::Block::getPredecessors ( )
inline

Definition at line 235 of file Block.h.

References pred_begin(), and pred_end().

Referenced by insertArgument(), and transformToReduceLoop().

◆ getSinglePredecessor()

Block * Block::getSinglePredecessor ( )

If this block has exactly one predecessor, return it.

Otherwise, return null.

Note that if a block has duplicate predecessors from a single block (e.g. if you have a conditional branch with the same block as the true/false destinations) is not considered to be a single predecessor.

Otherwise, return null.

Note that multiple edges from a single block (e.g. if you have a cond branch with the same block as the true/false destinations) is not considered to be a single predecessor.

Definition at line 269 of file Block.cpp.

References pred_begin(), and pred_end().

Referenced by transformToReduceLoop().

◆ getSublistAccess()

static OpListType Block::* mlir::Block::getSublistAccess ( Operation )
inlinestatic

Returns pointer to member of operation list.

Definition at line 375 of file Block.h.

◆ getSuccessor()

Block * Block::getSuccessor ( unsigned  i)

◆ getSuccessors()

SuccessorRange mlir::Block::getSuccessors ( )
inline

◆ getTerminator()

Operation * Block::getTerminator ( )

◆ getUniquePredecessor()

Block * Block::getUniquePredecessor ( )

If this block has a unique predecessor, i.e., all incoming edges originate from one block, return it.

Otherwise, return null.

Definition at line 280 of file Block.cpp.

References pred_begin(), and pred_end().

◆ hasNoPredecessors()

bool mlir::Block::hasNoPredecessors ( )
inline

Return true if this block has no predecessors.

Definition at line 240 of file Block.h.

References pred_begin(), and pred_end().

Referenced by checkTransformationPreconditions(), and mlir::RewriterBase::inlineBlockBefore().

◆ hasNoSuccessors()

bool mlir::Block::hasNoSuccessors ( )
inline

Returns true if this blocks has no successors.

Definition at line 243 of file Block.h.

References succ_begin(), and succ_end().

Referenced by mlir::RewriterBase::inlineBlockBefore().

◆ insertAfter()

void Block::insertAfter ( Block block)

Insert this block (which must not already be in a region) right after the specified block.

Definition at line 45 of file Block.cpp.

References mlir::Region::getBlocks(), and getParent().

Referenced by createSingleExitingLatch().

◆ insertArgument() [1/2]

BlockArgument Block::insertArgument ( args_iterator  it,
Type  type,
Location  loc 
)

Insert one value to the position in the argument list indicated by the given iterator.

Insert one value to the given position of the argument list.

The existing arguments are shifted. The block is expected not to have predecessors.

Definition at line 186 of file Block.cpp.

References empty(), and getPredecessors().

Referenced by mlir::Region::insertArgument().

◆ insertArgument() [2/2]

BlockArgument Block::insertArgument ( unsigned  index,
Type  type,
Location  loc 
)

Add one value to the argument list at the specified position.

Definition at line 171 of file Block.cpp.

◆ insertBefore()

void Block::insertBefore ( Block block)

Insert this block (which must not already be in a region) right before the specified block.

Definition at line 39 of file Block.cpp.

References mlir::Region::getBlocks(), and getParent().

Referenced by transformCyclesToSCFLoops().

◆ invalidateOpOrder()

void Block::invalidateOpOrder ( )

Invalidates the current ordering of operations.

Definition at line 106 of file Block.cpp.

References verifyOpOrder().

Referenced by llvm::ilist_traits<::mlir::Operation >::transferNodesFromList().

◆ isEntryBlock()

bool Block::isEntryBlock ( )

Return if this block is the entry block in the parent region.

Definition at line 35 of file Block.cpp.

References mlir::Region::front(), and getParent().

Referenced by mlir::LocalAliasAnalysis::aliasImpl(), checkTransformationPreconditions(), collectUnderlyingAddressValues(), getPhiIncomingBlock(), and isFnEntryBlock().

◆ isOpOrderValid()

bool Block::isOpOrderValid ( )

Returns true if the ordering of the child operations is valid, false otherwise.

Definition at line 103 of file Block.cpp.

Referenced by mlir::Operation::isBeforeInBlock(), and verifyOpOrder().

◆ mightHaveTerminator()

bool Block::mightHaveTerminator ( )

Check whether this block might have a terminator.

Definition at line 249 of file Block.cpp.

References back(), empty(), and mlir::Operation::mightHaveTrait().

Referenced by getTerminator().

◆ moveBefore() [1/2]

void Block::moveBefore ( Block block)

Unlink this block from its current region and insert it right before the specific block.

Definition at line 53 of file Block.cpp.

References getParent().

Referenced by mlir::RewriterBase::moveBlockBefore().

◆ moveBefore() [2/2]

void Block::moveBefore ( Region region,
llvm::iplist< Block >::iterator  iterator 
)

Unlink this block from its current region and insert it right before the block that the given iterator points to in the region region.

Definition at line 60 of file Block.cpp.

References mlir::Region::getBlocks(), and getParent().

◆ op_begin()

template<typename OpT >
op_iterator<OpT> mlir::Block::op_begin ( )
inline

Definition at line 197 of file Block.h.

References begin(), and end().

◆ op_end()

template<typename OpT >
op_iterator<OpT> mlir::Block::op_end ( )
inline

Definition at line 201 of file Block.h.

References end().

◆ pred_begin()

pred_iterator mlir::Block::pred_begin ( )
inline

◆ pred_end()

pred_iterator mlir::Block::pred_end ( )
inline

◆ print() [1/2]

void Block::print ( raw_ostream &  os)

◆ print() [2/2]

void Block::print ( raw_ostream &  os,
AsmState state 
)

Definition at line 3976 of file AsmPrinter.cpp.

◆ printAsOperand() [1/2]

void Block::printAsOperand ( raw_ostream &  os,
AsmState state 
)

Definition at line 3992 of file AsmPrinter.cpp.

◆ printAsOperand() [2/2]

void Block::printAsOperand ( raw_ostream &  os,
bool  printType = true 
)

Print out the name of the block without printing its body.

NOTE: The printType argument is ignored. We keep it for compatibility with LLVM dominator machinery that expects it to exist.

Definition at line 3983 of file AsmPrinter.cpp.

◆ push_back()

void mlir::Block::push_back ( Operation op)
inline

Definition at line 147 of file Block.h.

Referenced by ensureDistinctSuccessors().

◆ push_front()

void mlir::Block::push_front ( Operation op)
inline

Definition at line 148 of file Block.h.

◆ rbegin()

reverse_iterator mlir::Block::rbegin ( )
inline

Definition at line 143 of file Block.h.

◆ recomputeOpOrder()

void Block::recomputeOpOrder ( )

Recomputes the ordering of child operations within the block.

Definition at line 135 of file Block.cpp.

Referenced by mlir::Operation::isBeforeInBlock().

◆ rend()

reverse_iterator mlir::Block::rend ( )
inline

Definition at line 144 of file Block.h.

◆ splitBlock() [1/2]

Block * Block::splitBlock ( iterator  splitBefore)

Split the block into two blocks before the specified operation or iterator.

Note that all operations BEFORE the specified iterator stay as part of the original basic block, and the rest of the operations in the original block are moved to the new block, including the old terminator. The original block is left without a terminator.

The newly formed Block is returned, and the specified iterator is invalidated.

Definition at line 307 of file Block.cpp.

References Block(), end(), mlir::Region::getBlocks(), getOperations(), and getParent().

Referenced by setupCoroMachinery(), mlir::RewriterBase::splitBlock(), and splitBlock().

◆ splitBlock() [2/2]

Block* mlir::Block::splitBlock ( Operation splitBeforeOp)
inline

Definition at line 370 of file Block.h.

References splitBlock().

◆ succ_begin()

succ_iterator mlir::Block::succ_begin ( )
inline

Definition at line 263 of file Block.h.

References getSuccessors().

Referenced by llvm::GraphTraits< mlir::Block * >::child_begin(), and hasNoSuccessors().

◆ succ_end()

succ_iterator mlir::Block::succ_end ( )
inline

Definition at line 264 of file Block.h.

References getSuccessors().

Referenced by llvm::GraphTraits< mlir::Block * >::child_end(), and hasNoSuccessors().

◆ verifyOpOrder()

bool Block::verifyOpOrder ( )

Verifies the current ordering of child operations matches the validOpOrder flag.

Verifies the current ordering of child operations.

Returns false if the order is valid, true otherwise.

Definition at line 114 of file Block.cpp.

References isOpOrderValid().

Referenced by invalidateOpOrder(), and ~Block().

◆ walk() [1/2]

template<WalkOrder Order = WalkOrder::PostOrder, typename Iterator = ForwardIterator, typename FnT , typename RetT = detail::walkResultType<FnT>>
RetT mlir::Block::walk ( Block::iterator  begin,
Block::iterator  end,
FnT &&  callback 
)
inline

Walk all nested operations, blocks (excluding this block) or regions, depending on the type of callback, in the specified [begin, end) range of this block.

The order in which operations, blocks or regions at the same nesting level are visited (e.g., lexicographical or reverse lexicographical order) is determined by Iterator. The walk order for enclosing operations, blocks or regions with respect to their nested ones is specified by Order (post-order by default).

A callback on a operation or block is allowed to erase that operation or block if either:

  • the walk is in post-order, or
  • the walk is in pre-order and the walk is skipped after the erasure.

See Operation::walk for more details.

Definition at line 342 of file Block.h.

◆ walk() [2/2]

template<WalkOrder Order = WalkOrder::PostOrder, typename Iterator = ForwardIterator, typename FnT , typename ArgT = detail::first_argument<FnT>, typename RetT = detail::walkResultType<FnT>>
RetT mlir::Block::walk ( FnT &&  callback)
inline

Walk all nested operations, blocks (including this block) or regions, depending on the type of callback.

The order in which operations, blocks or regions at the same nesting level are visited (e.g., lexicographical or reverse lexicographical order) is determined by Iterator. The walk order for enclosing operations, blocks or regions with respect to their nested ones is specified by Order (post-order by default).

A callback on a operation or block is allowed to erase that operation or block if either:

  • the walk is in post-order, or
  • the walk is in pre-order and the walk is skipped after the erasure.

See Operation::walk for more details.

Definition at line 290 of file Block.h.

References mlir::WalkResult::advance(), begin(), end(), mlir::WalkResult::interrupt(), mlir::PostOrder, and mlir::PreOrder.

Referenced by mlir::affine::affineDataCopyGenerate(), getMemoryFootprintBytes(), and getSingleOpOfType().

◆ without_terminator()

iterator_range<iterator> mlir::Block::without_terminator ( )
inline

Return an iterator range over the operation within this block excluding the terminator operation at the end.

Definition at line 207 of file Block.h.

References begin(), and end().

Referenced by mlir::sortTopologically().

Friends And Related Function Documentation

◆ llvm::ilist_traits< Block >

friend struct llvm::ilist_traits< Block >
friend

Definition at line 401 of file Block.h.


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