Print ProgramPoint instead of pointer for better logging

[pchen7e2]

There're places where a pointer instead of ProgramPoint object is passed to stream print <<:

https://github.com/pchen7e2/llvm-project/blob/4256d8229602eb08598761f211d54e719007b468/mlir/lib/Analysis/DataFlowFramework.cpp#L132-L133

and they'll be printed as pointer value. This PR converts them to object before passing to stream printers.

I have a random local IR and I call opt tool on it with -debug-only=dataflow.

Before:

Invoking 'mlir::dataflow::DeadCodeAnalysis' on: 0x51936d8
Invoking 'mlir::triton::(anonymous namespace)::AxisInfoAnalysis' on: 0x51936d8
Creating dependency between mlir::dataflow::PredecessorState of <before operation>:scf.yield %arg3 : i32
and mlir::dataflow::PredecessorState on 0x51936d8

After:

Invoking 'mlir::dataflow::DeadCodeAnalysis' on: <before operation>:scf.yield %arg3 : i32
Invoking 'mlir::triton::(anonymous namespace)::AxisInfoAnalysis' on: <before operation>:scf.yield %arg3 : i32
Creating dependency between mlir::dataflow::PredecessorState of <before operation>:scf.yield %arg3 : i32
and mlir::dataflow::PredecessorState on <before operation>:scf.yield %arg3 : i32

It's now calling point->print instead of printing the pointer address value.

[llvmbot]

@llvm/pr-subscribers-mlir

Author: Peng Chen (pchen7e2)

Changes

There're places where a pointer instead of ProgramPoint object is passed to stream print <<:

https://github.com/pchen7e2/llvm-project/blob/4256d8229602eb08598761f211d54e719007b468/mlir/lib/Analysis/DataFlowFramework.cpp#L132-L133

so one override at L150 might not be sufficient to print it nicely.

I have a random local IR and I call opt tool on it with -debug-only=dataflow.

Before:

Invoking 'mlir::dataflow::DeadCodeAnalysis' on: 0x51936d8
Invoking 'mlir::triton::(anonymous namespace)::AxisInfoAnalysis' on: 0x51936d8
Creating dependency between mlir::dataflow::PredecessorState of <before operation>:scf.yield %arg3 : i32
and mlir::dataflow::PredecessorState on 0x51936d8

After:

Invoking 'mlir::dataflow::DeadCodeAnalysis' on: <before operation>:scf.yield %arg3 : i32
Invoking 'mlir::triton::(anonymous namespace)::AxisInfoAnalysis' on: <before operation>:scf.yield %arg3 : i32
Creating dependency between mlir::dataflow::PredecessorState of <before operation>:scf.yield %arg3 : i32
and mlir::dataflow::PredecessorState on <before operation>:scf.yield %arg3 : i32

It's now calling point->print instead of printing the pointer address value.

---

Full diff: https://github.com/llvm/llvm-project/pull/154839.diff

1 Files Affected:

• (modified) mlir/include/mlir/Analysis/DataFlowFramework.h (+5)

diff --git a/mlir/include/mlir/Analysis/DataFlowFramework.h b/mlir/include/mlir/Analysis/DataFlowFramework.h
index caf978a51fd8e..88edfa624fa90 100644
--- a/mlir/include/mlir/Analysis/DataFlowFramework.h
+++ b/mlir/include/mlir/Analysis/DataFlowFramework.h
@@ -152,6 +152,11 @@ inline raw_ostream &operator<<(raw_ostream &os, const ProgramPoint &point) {
   return os;
 }
 
+inline raw_ostream &operator<<(raw_ostream &os, const ProgramPoint *point) {
+  point->print(os);
+  return os;
+}
+
 //===----------------------------------------------------------------------===//
 // GenericLatticeAnchor
 //===----------------------------------------------------------------------===//