21 #include "llvm/ADT/STLExtras.h"
22 #include "llvm/Support/Casting.h"
49 registerAnchorKind<CFGEdge>();
59 for (
Value argument : region.front().getArguments())
63 return initializeRecursively(top);
67 AbstractSparseForwardDataFlowAnalysis::initializeRecursively(
Operation *op) {
70 if (failed(visitOperation(op)))
74 for (
Block &block : region) {
76 ->blockContentSubscribe(
this);
79 if (failed(initializeRecursively(&op)))
90 return visitOperation(point->
getPrevOp());
96 AbstractSparseForwardDataFlowAnalysis::visitOperation(
Operation *op) {
111 resultLattices.push_back(resultLattice);
115 if (
auto branch = dyn_cast<RegionBranchOpInterface>(op)) {
128 operandLattices.push_back(operandLattice);
131 if (
auto call = dyn_cast<CallOpInterface>(op))
138 void AbstractSparseForwardDataFlowAnalysis::visitBlock(
Block *block) {
152 argLattices.push_back(argLattice);
159 auto callable = dyn_cast<CallableOpInterface>(block->
getParentOp());
160 if (callable && callable.getCallableRegion() == block->
getParent())
164 if (
auto branch = dyn_cast<RegionBranchOpInterface>(block->
getParentOp())) {
178 Block *predecessor = *it;
182 auto *edgeExecutable =
183 getOrCreate<Executable>(getLatticeAnchor<CFGEdge>(predecessor, block));
184 edgeExecutable->blockContentSubscribe(
this);
185 if (!edgeExecutable->isLive())
192 branch.getSuccessorOperands(it.getSuccessorIndex());
194 if (
Value operand = operands[idx]) {
210 CallOpInterface call,
216 dyn_cast_if_present<CallableOpInterface>(call.resolveCallable());
218 (callable && !callable.getCallableRegion())) {
225 const auto *predecessors = getOrCreateFor<PredecessorState>(
229 if (!predecessors->allPredecessorsKnown()) {
233 for (
Operation *predecessor : predecessors->getKnownPredecessors())
234 for (
auto &&[operand, resLattice] :
235 llvm::zip(predecessor->getOperands(), resultLattices))
242 CallableOpInterface callable,
244 Block *entryBlock = &callable.getCallableRegion()->
front();
245 const auto *callsites = getOrCreateFor<PredecessorState>(
249 if (!callsites->allPredecessorsKnown() ||
253 for (
Operation *callsite : callsites->getKnownPredecessors()) {
254 auto call = cast<CallOpInterface>(callsite);
255 for (
auto it : llvm::zip(call.getArgOperands(), argLattices))
256 join(std::get<1>(it),
262 void AbstractSparseForwardDataFlowAnalysis::visitRegionSuccessors(
265 const auto *predecessors = getOrCreateFor<PredecessorState>(point, point);
266 assert(predecessors->allPredecessorsKnown() &&
267 "unexpected unresolved region successors");
269 for (
Operation *op : predecessors->getKnownPredecessors()) {
271 std::optional<OperandRange> operands;
275 operands = branch.getEntrySuccessorOperands(successor);
277 }
else if (
auto regionTerminator =
278 dyn_cast<RegionBranchTerminatorOpInterface>(op)) {
279 operands = regionTerminator.getSuccessorOperands(successor);
287 ValueRange inputs = predecessors->getSuccessorInputs(op);
288 assert(inputs.size() == operands->size() &&
289 "expected the same number of successor inputs as operands");
291 unsigned firstIndex = 0;
292 if (inputs.size() != lattices.size()) {
295 firstIndex = cast<OpResult>(inputs.front()).getResultNumber();
299 branch->getResults().slice(firstIndex, inputs.size())),
300 lattices, firstIndex);
303 firstIndex = cast<BlockArgument>(inputs.front()).getArgNumber();
308 firstIndex, inputs.size())),
309 lattices, firstIndex);
313 for (
auto it : llvm::zip(*operands, lattices.drop_front(firstIndex)))
344 registerAnchorKind<CFGEdge>();
349 return initializeRecursively(top);
353 AbstractSparseBackwardDataFlowAnalysis::initializeRecursively(
Operation *op) {
354 if (failed(visitOperation(op)))
358 for (
Block &block : region) {
360 ->blockContentSubscribe(
this);
364 for (
auto it = block.
rbegin(); it != block.
rend(); it++)
365 if (failed(initializeRecursively(&*it)))
380 return visitOperation(point->
getPrevOp());
386 resultLattices.reserve(values.size());
387 for (
Value result : values) {
389 resultLattices.push_back(resultLattice);
391 return resultLattices;
395 AbstractSparseBackwardDataFlowAnalysis::getLatticeElementsFor(
398 resultLattices.reserve(values.size());
399 for (
Value result : values) {
401 getLatticeElementFor(point, result);
402 resultLattices.push_back(resultLattice);
404 return resultLattices;
412 AbstractSparseBackwardDataFlowAnalysis::visitOperation(
Operation *op) {
425 if (
auto branch = dyn_cast<RegionBranchOpInterface>(op)) {
426 visitRegionSuccessors(branch, operandLattices);
430 if (
auto branch = dyn_cast<BranchOpInterface>(op)) {
441 if (!forwarded.empty()) {
445 unaccounted.reset(operand.getOperandNumber());
446 if (std::optional<BlockArgument> blockArg =
448 successorOperands, operand.getOperandNumber(), block)) {
457 for (
int index : unaccounted.set_bits()) {
466 if (
auto call = dyn_cast<CallOpInterface>(op)) {
467 Operation *callableOp = call.resolveCallableInTable(&symbolTable);
468 if (
auto callable = dyn_cast_or_null<CallableOpInterface>(callableOp)) {
479 Region *region = callable.getCallableRegion();
480 if (!region || region->
empty() ||
489 for (
auto [blockArg, argOpOperand] :
493 unaccounted.reset(argOpOperand.getOperandNumber());
498 for (
int index : unaccounted.set_bits()) {
516 if (
auto terminator = dyn_cast<RegionBranchTerminatorOpInterface>(op)) {
517 if (
auto branch = dyn_cast<RegionBranchOpInterface>(op->
getParentOp())) {
518 visitRegionSuccessorsFromTerminator(terminator, branch);
526 if (
auto callable = dyn_cast<CallableOpInterface>(op->
getParentOp()))
534 Operation *op, CallableOpInterface callable,
542 for (
auto [op, result] : llvm::zip(operandLattices, callResultLattices))
554 void AbstractSparseBackwardDataFlowAnalysis::visitRegionSuccessors(
555 RegionBranchOpInterface branch,
560 branch.getEntrySuccessorRegions(operands, successors);
567 OperandRange operands = branch.getEntrySuccessorOperands(successor);
569 ValueRange inputs = successor.getSuccessorInputs();
570 for (
auto [operand, input] : llvm::zip(opoperands, inputs)) {
573 unaccounted.reset(operand.getOperandNumber());
578 for (
int index : unaccounted.set_bits()) {
583 void AbstractSparseBackwardDataFlowAnalysis::
584 visitRegionSuccessorsFromTerminator(
585 RegionBranchTerminatorOpInterface terminator,
586 RegionBranchOpInterface branch) {
587 assert(isa<RegionBranchTerminatorOpInterface>(terminator) &&
588 "expected a `RegionBranchTerminatorOpInterface` op");
589 assert(terminator->getParentOp() == branch.getOperation() &&
590 "expected `branch` to be the parent op of `terminator`");
595 terminator.getSuccessorRegions(operandAttributes, successors);
598 BitVector unaccounted(terminator->getNumOperands(),
true);
601 ValueRange inputs = successor.getSuccessorInputs();
602 OperandRange operands = terminator.getSuccessorOperands(successor);
604 for (
auto [opOperand, input] : llvm::zip(opOperands, inputs)) {
607 unaccounted.reset(
const_cast<OpOperand &
>(opOperand).getOperandNumber());
612 for (
int index : unaccounted.set_bits()) {
618 AbstractSparseBackwardDataFlowAnalysis::getLatticeElementFor(
static MutableArrayRef< OpOperand > operandsToOpOperands(OperandRange &operands)
virtual void onUpdate(DataFlowSolver *solver) const
This function is called by the solver when the analysis state is updated to enqueue more work items.
LatticeAnchor anchor
The lattice anchor to which the state belongs.
This class represents an argument of a Block.
Block represents an ordered list of Operations.
unsigned getNumArguments()
Region * getParent() const
Provide a 'getParent' method for ilist_node_with_parent methods.
pred_iterator pred_begin()
Operation * getTerminator()
Get the terminator operation of this block.
BlockArgListType getArguments()
bool isEntryBlock()
Return if this block is the entry block in the parent region.
Operation * getParentOp()
Returns the closest surrounding operation that contains this block.
reverse_iterator rbegin()
Base class for all data-flow analyses.
void addDependency(AnalysisState *state, ProgramPoint *point)
Create a dependency between the given analysis state and lattice anchor on this analysis.
void propagateIfChanged(AnalysisState *state, ChangeResult changed)
Propagate an update to a state if it changed.
ProgramPoint * getProgramPointAfter(Operation *op)
ProgramPoint * getProgramPointBefore(Operation *op)
Get a uniqued program point instance.
const DataFlowConfig & getSolverConfig() const
Return the configuration of the solver used for this analysis.
The general data-flow analysis solver.
void enqueue(WorkItem item)
Push a work item onto the worklist.
ProgramPoint * getProgramPointAfter(Operation *op)
This class represents an operand of an operation.
This class implements the operand iterators for the Operation class.
unsigned getBeginOperandIndex() const
Return the operand index of the first element of this range.
Operation is the basic unit of execution within MLIR.
bool hasTrait()
Returns true if the operation was registered with a particular trait, e.g.
OpOperand & getOpOperand(unsigned idx)
unsigned getNumOperands()
Operation * getParentOp()
Returns the closest surrounding operation that contains this operation or nullptr if this is a top-le...
Block * getBlock()
Returns the operation block that contains this operation.
MutableArrayRef< Region > getRegions()
Returns the regions held by this operation.
MutableArrayRef< OpOperand > getOpOperands()
operand_range getOperands()
Returns an iterator on the underlying Value's.
SuccessorRange getSuccessors()
result_range getResults()
unsigned getNumResults()
Return the number of results held by this operation.
Implement a predecessor iterator for blocks.
This class represents a point being branched from in the methods of the RegionBranchOpInterface.
static constexpr RegionBranchPoint parent()
Returns an instance of RegionBranchPoint representing the parent operation.
This class represents a successor of a region.
This class contains a list of basic blocks and a link to the parent operation it is attached to.
BlockArgListType getArguments()
This class models how operands are forwarded to block arguments in control flow.
OperandRange getForwardedOperands() const
Get the range of operands that are simply forwarded to the successor.
This class represents a collection of SymbolTables.
This class provides an abstraction over the different types of ranges over Values.
This class represents an instance of an SSA value in the MLIR system, representing a computable value...
virtual void setToExitState(AbstractSparseLattice *lattice)=0
Set the given lattice element(s) at control flow exit point(s) and propagate the update if it chaned.
SmallVector< AbstractSparseLattice * > getLatticeElements(ValueRange values)
Get the lattice elements for a range of values.
AbstractSparseBackwardDataFlowAnalysis(DataFlowSolver &solver, SymbolTableCollection &symbolTable)
virtual void visitBranchOperand(OpOperand &operand)=0
virtual void visitCallOperand(OpOperand &operand)=0
LogicalResult visit(ProgramPoint *point) override
Visit a program point.
void meet(AbstractSparseLattice *lhs, const AbstractSparseLattice &rhs)
Join the lattice element and propagate and update if it changed.
virtual LogicalResult visitCallableOperation(Operation *op, CallableOpInterface callable, ArrayRef< AbstractSparseLattice * > operandLattices)
Visits a callable operation.
virtual void visitExternalCallImpl(CallOpInterface call, ArrayRef< AbstractSparseLattice * > operandLattices, ArrayRef< const AbstractSparseLattice * > resultLattices)=0
The transfer function for calls to external functions.
virtual AbstractSparseLattice * getLatticeElement(Value value)=0
Get the lattice element for a value.
LogicalResult initialize(Operation *top) override
Initialize the analysis by visiting the operation and everything nested under it.
void setAllToExitStates(ArrayRef< AbstractSparseLattice * > lattices)
Set the given lattice element(s) at control flow exit point(s) and propagate the update if it chaned.
virtual LogicalResult visitOperationImpl(Operation *op, ArrayRef< AbstractSparseLattice * > operandLattices, ArrayRef< const AbstractSparseLattice * > resultLattices)=0
The operation transfer function.
LogicalResult visit(ProgramPoint *point) override
Visit a program point.
LogicalResult initialize(Operation *top) override
Initialize the analysis by visiting every owner of an SSA value: all operations and blocks.
virtual AbstractSparseLattice * getLatticeElement(Value value)=0
Get the lattice element of a value.
virtual void visitExternalCallImpl(CallOpInterface call, ArrayRef< const AbstractSparseLattice * > argumentLattices, ArrayRef< AbstractSparseLattice * > resultLattices)=0
The transfer function for calls to external functions.
AbstractSparseForwardDataFlowAnalysis(DataFlowSolver &solver)
void setAllToEntryStates(ArrayRef< AbstractSparseLattice * > lattices)
virtual void setToEntryState(AbstractSparseLattice *lattice)=0
Set the given lattice element(s) at control flow entry point(s).
const AbstractSparseLattice * getLatticeElementFor(ProgramPoint *point, Value value)
Get a read-only lattice element for a value and add it as a dependency to a program point.
virtual void visitNonControlFlowArgumentsImpl(Operation *op, const RegionSuccessor &successor, ArrayRef< AbstractSparseLattice * > argLattices, unsigned firstIndex)=0
Given an operation with region control-flow, the lattices of the operands, and a region successor,...
virtual LogicalResult visitCallOperation(CallOpInterface call, ArrayRef< const AbstractSparseLattice * > operandLattices, ArrayRef< AbstractSparseLattice * > resultLattices)
Visits a call operation.
virtual void visitCallableOperation(CallableOpInterface callable, ArrayRef< AbstractSparseLattice * > argLattices)
Visits a callable operation.
virtual LogicalResult visitOperationImpl(Operation *op, ArrayRef< const AbstractSparseLattice * > operandLattices, ArrayRef< AbstractSparseLattice * > resultLattices)=0
The operation transfer function.
void join(AbstractSparseLattice *lhs, const AbstractSparseLattice &rhs)
Join the lattice element and propagate and update if it changed.
This class represents an abstract lattice.
void onUpdate(DataFlowSolver *solver) const override
When the lattice gets updated, propagate an update to users of the value using its use-def chain to s...
virtual ChangeResult join(const AbstractSparseLattice &rhs)
Join the information contained in 'rhs' into this lattice.
virtual ChangeResult meet(const AbstractSparseLattice &rhs)
Meet (intersect) the information in this lattice with 'rhs'.
void useDefSubscribe(DataFlowAnalysis *analysis)
Subscribe an analysis to updates of the lattice.
This analysis state represents a set of live control-flow "predecessors" of a program point (either a...
bool allPredecessorsKnown() const
Returns true if all predecessors are known.
ArrayRef< Operation * > getKnownPredecessors() const
Get the known predecessors.
std::optional< BlockArgument > getBranchSuccessorArgument(const SuccessorOperands &operands, unsigned operandIndex, Block *successor)
Return the BlockArgument corresponding to operand operandIndex in some successor if operandIndex is w...
constexpr void enumerate(std::tuple< Tys... > &tuple, CallbackT &&callback)
Include the generated interface declarations.
This trait indicates that a terminator operation is "return-like".
Program point represents a specific location in the execution of a program.
bool isBlockStart() const
Operation * getPrevOp() const
Get the previous operation of this program point.
Block * getBlock() const
Get the block contains this program point.