Skip to content

[MLIR] Adopt LDBG() debug macro in bufferization (NFC) #154614

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
joker-eph merged 1 commit into from
Aug 20, 2025
+39 −58
Merged

[MLIR] Adopt LDBG() debug macro in bufferization (NFC) #154614

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 6 additions & 9 deletions mlir/lib/Dialect/Bufferization/Transforms/Bufferize.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
#include "mlir/Interfaces/ControlFlowInterfaces.h"
#include "mlir/Interfaces/SideEffectInterfaces.h"
#include "mlir/Pass/PassManager.h"
#include "llvm/Support/DebugLog.h"
#include <optional>

namespace mlir {
Expand Down Expand Up @@ -328,20 +329,16 @@ LogicalResult bufferization::bufferizeOp(Operation *op,
"blocks");

// Bufferize the op.
LLVM_DEBUG(llvm::dbgs()
<< "//===-------------------------------------------===//\n"
<< "IR after bufferizing: " << nextOp->getName() << "\n");
LDBG(3) << "//===-------------------------------------------===//\n"
<< "IR after bufferizing: " << nextOp->getName();
rewriter.setInsertionPoint(nextOp);
if (failed(
bufferizableOp.bufferize(rewriter, options, bufferizationState))) {
LLVM_DEBUG(llvm::dbgs()
<< "failed to bufferize\n"
<< "//===-------------------------------------------===//\n");
LDBG(2) << "failed to bufferize\n"
<< "//===-------------------------------------------===//";
return nextOp->emitError("failed to bufferize op");
}
LLVM_DEBUG(llvm::dbgs()
<< *op
<< "\n//===-------------------------------------------===//\n");
LDBG(3) << *op << "\n//===-------------------------------------------===//";
}

// Return early if the top-level op is entirely gone.
Expand Down
82 changes: 33 additions & 49 deletions mlir/lib/Dialect/Bufferization/Transforms/OneShotAnalysis.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@
#include "mlir/Interfaces/SubsetOpInterface.h"
#include "llvm/ADT/DenseSet.h"
#include "llvm/ADT/SetVector.h"
#include "llvm/Support/DebugLog.h"

MLIR_DEFINE_EXPLICIT_TYPE_ID(mlir::bufferization::OneShotAnalysisState)

Expand Down Expand Up @@ -616,13 +617,10 @@ hasReadAfterWriteInterference(const DenseSet<OpOperand *> &usesRead,
if (getParallelRegion(def.getParentRegion(), options) !=
getParallelRegion(uConflictingWrite->getOwner()->getParentRegion(),
options)) {
LLVM_DEBUG(
llvm::dbgs()
<< "\n- bufferizes out-of-place due to parallel region:\n");
LLVM_DEBUG(llvm::dbgs()
<< " unConflictingWrite = operand "
<< uConflictingWrite->getOperandNumber() << " of "
<< *uConflictingWrite->getOwner() << "\n");
LDBG() << "\n- bufferizes out-of-place due to parallel region:\n"
<< " unConflictingWrite = operand "
<< uConflictingWrite->getOperandNumber() << " of "
<< *uConflictingWrite->getOwner();
return true;
}
}
Expand All @@ -631,9 +629,9 @@ hasReadAfterWriteInterference(const DenseSet<OpOperand *> &usesRead,

for (OpOperand *uRead : usesRead) {
Operation *readingOp = uRead->getOwner();
LLVM_DEBUG(llvm::dbgs() << "\n- check conflict:\n");
LLVM_DEBUG(llvm::dbgs() << " uRead = operand " << uRead->getOperandNumber()
<< " of " << *readingOp << "\n");
LDBG() << "\n- check conflict:\n"
<< " uRead = operand " << uRead->getOperandNumber() << " of "
<< *readingOp;

// Find the definition of uRead by following the SSA use-def chain.
// E.g.:
Expand All @@ -648,23 +646,22 @@ hasReadAfterWriteInterference(const DenseSet<OpOperand *> &usesRead,
const SetVector<Value> &definitions = state.findDefinitionsCached(uRead);
if (definitions.empty()) {
// Fast path: No conflict if there are no definitions.
LLVM_DEBUG(llvm::dbgs()
<< " no conflict: read value has no definitions\n");
LDBG() << " no conflict: read value has no definitions";
continue;
}

// Look for conflicting memory writes. Potential conflicts are writes to an
// alias that have been decided to bufferize inplace.
for (OpOperand *uConflictingWrite : usesWrite) {
LLVM_DEBUG(llvm::dbgs() << " unConflictingWrite = operand "
<< uConflictingWrite->getOperandNumber() << " of "
<< *uConflictingWrite->getOwner() << "\n");
LDBG() << " unConflictingWrite = operand "
<< uConflictingWrite->getOperandNumber() << " of "
<< *uConflictingWrite->getOwner();

// Check if op dominance can be used to rule out read-after-write
// conflicts.
bool useDominance =
canUseOpDominance(uRead, uConflictingWrite, definitions, state);
LLVM_DEBUG(llvm::dbgs() << "\n- useDominance = " << useDominance << "\n");
LDBG() << "\n- useDominance = " << useDominance;

// Throughout this loop, check for multiple requirements that have to be
// met for uConflictingWrite to be an actual conflict.
Expand All @@ -680,8 +677,7 @@ hasReadAfterWriteInterference(const DenseSet<OpOperand *> &usesRead,
// inside a loop), there may be no meaningful `happensBefore`
// relationship.
if (happensBefore(readingOp, conflictingWritingOp, domInfo)) {
LLVM_DEBUG(llvm::dbgs()
<< " no conflict: read happens before write\n");
LDBG() << " no conflict: read happens before write";
continue;
}

Expand All @@ -693,8 +689,7 @@ hasReadAfterWriteInterference(const DenseSet<OpOperand *> &usesRead,
// Note: If the op is executed multiple times (e.g., because it is
// inside a loop), it may be conflicting with itself.
if (uConflictingWrite == uRead) {
LLVM_DEBUG(llvm::dbgs()
<< " no conflict: read and write are same use\n");
LDBG() << " no conflict: read and write are same use";
continue;
}

Expand All @@ -705,8 +700,8 @@ hasReadAfterWriteInterference(const DenseSet<OpOperand *> &usesRead,
// multiple times.
if (state.insideMutuallyExclusiveRegions(readingOp,
conflictingWritingOp)) {
LLVM_DEBUG(llvm::dbgs() << " no conflict: read and write are in "
"mutually exclusive regions\n");
LDBG() << " no conflict: read and write are in "
"mutually exclusive regions";
continue;
}

Expand All @@ -721,9 +716,7 @@ hasReadAfterWriteInterference(const DenseSet<OpOperand *> &usesRead,
state, uRead, uConflictingWrite->get()) ||
hasEquivalentValueInReverseUseDefChain(
state, uConflictingWrite, uRead->get())) {
LLVM_DEBUG(
llvm::dbgs()
<< " no conflict: op bufferizes to element-wise access\n");
LDBG() << " no conflict: op bufferizes to element-wise access";
continue;
}
}
Expand All @@ -733,15 +726,14 @@ hasReadAfterWriteInterference(const DenseSet<OpOperand *> &usesRead,

// No conflict if the operands are non-conflicting subsets.
if (areNonConflictingSubsets(uRead, uConflictingWrite, state)) {
LLVM_DEBUG(llvm::dbgs() << " no conflict: non-conflicting subsets\n");
LDBG() << " no conflict: non-conflicting subsets";
continue;
}

// No conflict if the op interface says so.
if (auto bufferizableOp = options.dynCastBufferizableOp(readingOp)) {
if (bufferizableOp.isNotConflicting(uRead, uConflictingWrite, state)) {
LLVM_DEBUG(llvm::dbgs()
<< " no conflict: op interace of reading op says 'no'\n");
LDBG() << " no conflict: op interace of reading op says 'no'";
continue;
}
}
Expand All @@ -751,39 +743,34 @@ hasReadAfterWriteInterference(const DenseSet<OpOperand *> &usesRead,
options.dynCastBufferizableOp(conflictingWritingOp)) {
if (bufferizableOp.isNotConflicting(uRead, uConflictingWrite,
state)) {
LLVM_DEBUG(
llvm::dbgs()
<< " no conflict: op interace of writing op says 'no'\n");
LDBG() << " no conflict: op interace of writing op says 'no'";
continue;
}
}
}

// Check all possible definitions.
for (Value definition : definitions) {
LLVM_DEBUG(llvm::dbgs() << " * definition = " << definition << "\n");
LDBG() << " * definition = " << definition;

// No conflict if the conflicting write happens before the definition.
if (Operation *defOp = definition.getDefiningOp()) {
if (happensBefore(conflictingWritingOp, defOp, domInfo)) {
// conflictingWritingOp happens before defOp. No conflict.
LLVM_DEBUG(llvm::dbgs()
<< " no conflict: write happens before definition\n");
LDBG() << " no conflict: write happens before definition";
continue;
}
// No conflict if conflictingWritingOp is contained in defOp.
if (defOp->isProperAncestor(conflictingWritingOp)) {
LLVM_DEBUG(
llvm::dbgs()
<< " no conflict: write is contained in definition\n");
LDBG() << " no conflict: write is contained in definition";
continue;
}
} else {
auto bbArg = cast<BlockArgument>(definition);
Block *block = bbArg.getOwner();
if (!block->findAncestorOpInBlock(*conflictingWritingOp)) {
LLVM_DEBUG(llvm::dbgs() << " no conflict: definition is bbArg "
"and write happens outside of block\n");
LDBG() << " no conflict: definition is bbArg "
"and write happens outside of block";
// conflictingWritingOp happens outside of the block. No
// conflict.
continue;
Expand All @@ -795,16 +782,15 @@ hasReadAfterWriteInterference(const DenseSet<OpOperand *> &usesRead,
AliasingValueList aliases = state.getAliasingValues(*uConflictingWrite);
if (aliases.getNumAliases() == 1 &&
aliases.getAliases()[0].value == definition) {
LLVM_DEBUG(llvm::dbgs()
<< " no conflict: definition and write are same\n");
LDBG() << " no conflict: definition and write are same";
continue;
}

// All requirements are met. Conflict found!

if (options.printConflicts)
annotateConflict(uRead, uConflictingWrite, definition);
LLVM_DEBUG(llvm::dbgs() << " => RaW CONFLICT FOUND\n");
LDBG() << " => RaW CONFLICT FOUND";
return true;
}
}
Expand Down Expand Up @@ -958,7 +944,7 @@ wouldCreateWriteToNonWritableBuffer(OpOperand &operand,
for (AliasingValue alias : state.getAliasingValues(operand))
state.applyOnAliases(alias.value, checkReadOnly);
if (foundReadOnly) {
LLVM_DEBUG(llvm::dbgs() << "=> NOT WRITABLE\n");
LDBG() << "=> NOT WRITABLE";
return true;
}

Expand Down Expand Up @@ -987,10 +973,9 @@ void OneShotAnalysisState::resetCache() {
static LogicalResult
bufferizableInPlaceAnalysisImpl(OpOperand &operand, OneShotAnalysisState &state,
const DominanceInfo &domInfo) {
LLVM_DEBUG(
llvm::dbgs() << "//===-------------------------------------------===//\n"
<< "Analyzing operand #" << operand.getOperandNumber()
<< " of " << *operand.getOwner() << "\n");
LDBG() << "//===-------------------------------------------===//\n"
<< "Analyzing operand #" << operand.getOperandNumber() << " of "
<< *operand.getOwner();

bool foundInterference =
wouldCreateWriteToNonWritableBuffer(operand, state) ||
Expand All @@ -1001,8 +986,7 @@ bufferizableInPlaceAnalysisImpl(OpOperand &operand, OneShotAnalysisState &state,
else
state.bufferizeInPlace(operand);

LLVM_DEBUG(llvm::dbgs()
<< "//===-------------------------------------------===//\n");
LDBG() << "//===-------------------------------------------===//";
return success();
}

Expand Down