[MLIR][mlir-opt] move action debugger hook flag #134842
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Currently if a developer uses the flag `--mlir-enable-debugger-hook` the debugger hook is not actually enabled. It seems the DebugConfig and the MainMLIROptConfig are not connected. To fix this we can move the `enableDebuggerHook` CL Option to the DebugConfigCLOptions struct so that it can get registered and enabled along with the other debugger flags. AFAICS there are no other uses of the flag so this should be safe. This also adds a small LIT test to check that the hook is enabled by checking the std::cerr output for the log message.
|
@llvm/pr-subscribers-mlir Author: Christopher McGirr (chrsmcgrr) ChangesCurrently if a developer uses the flag To fix this we can move the This also adds a small LIT test to check that the hook is enabled by checking the std::cerr output for the log message. Full diff: https://github.com/llvm/llvm-project/pull/134842.diff 4 Files Affected:
diff --git a/mlir/include/mlir/Tools/mlir-opt/MlirOptMain.h b/mlir/include/mlir/Tools/mlir-opt/MlirOptMain.h
index 09bd86b9581df..af379797fe865 100644
--- a/mlir/include/mlir/Tools/mlir-opt/MlirOptMain.h
+++ b/mlir/include/mlir/Tools/mlir-opt/MlirOptMain.h
@@ -238,9 +238,6 @@ class MlirOptMainConfig {
/// Elide resources when generating bytecode.
bool elideResourceDataFromBytecodeFlag = false;
- /// Enable the Debugger action hook: Debugger can intercept MLIR Actions.
- bool enableDebuggerActionHookFlag = false;
-
/// IRDL file to register before processing the input.
std::string irdlFileFlag = "";
diff --git a/mlir/lib/Debug/CLOptionsSetup.cpp b/mlir/lib/Debug/CLOptionsSetup.cpp
index 340055adf5aab..cb0b0e5c375e0 100644
--- a/mlir/lib/Debug/CLOptionsSetup.cpp
+++ b/mlir/lib/Debug/CLOptionsSetup.cpp
@@ -64,6 +64,11 @@ struct DebugConfigCLOptions : public DebugConfig {
auto [file, line, col] = *locBreakpoint;
locBreakpointManager.addBreakpoint(file, line, col);
}));
+
+ static cl::opt<bool, /*ExternalStorage=*/true> enableDebuggerHook(
+ "mlir-enable-debugger-hook",
+ cl::desc("Enable Debugger hook for debugging MLIR Actions"),
+ cl::location(enableDebuggerActionHookFlag), cl::init(false));
}
tracing::FileLineColLocBreakpointManager locBreakpointManager;
};
diff --git a/mlir/lib/Tools/mlir-opt/MlirOptMain.cpp b/mlir/lib/Tools/mlir-opt/MlirOptMain.cpp
index 9bbf91de18305..2924a1205f574 100644
--- a/mlir/lib/Tools/mlir-opt/MlirOptMain.cpp
+++ b/mlir/lib/Tools/mlir-opt/MlirOptMain.cpp
@@ -126,11 +126,6 @@ struct MlirOptMainConfigCLOptions : public MlirOptMainConfig {
"mlir-disable-diagnostic-notes", cl::desc("Disable diagnostic notes."),
cl::location(disableDiagnosticNotesFlag), cl::init(false));
- static cl::opt<bool, /*ExternalStorage=*/true> enableDebuggerHook(
- "mlir-enable-debugger-hook",
- cl::desc("Enable Debugger hook for debugging MLIR Actions"),
- cl::location(enableDebuggerActionHookFlag), cl::init(false));
-
static cl::opt<bool, /*ExternalStorage=*/true> explicitModule(
"no-implicit-module",
cl::desc("Disable implicit addition of a top-level module op during "
diff --git a/mlir/test/mlir-opt/debuggerhook.mlir b/mlir/test/mlir-opt/debuggerhook.mlir
new file mode 100644
index 0000000000000..54f1bf98d66df
--- /dev/null
+++ b/mlir/test/mlir-opt/debuggerhook.mlir
@@ -0,0 +1,9 @@
+// Checks that the debugger hook is enabled when called with the CLI option.
+// RUN: mlir-opt %s --mlir-enable-debugger-hook --pass-pipeline="builtin.module(func.func(canonicalize))" --mlir-disable-threading 2>&1 | FileCheck %s
+
+func.func @foo() {
+ return
+}
+
+// CHECK: ExecutionContext registered on the context
+// CHECK-SAME: (with Debugger hook)
|
|
@llvm/pr-subscribers-mlir-core Author: Christopher McGirr (chrsmcgrr) ChangesCurrently if a developer uses the flag To fix this we can move the This also adds a small LIT test to check that the hook is enabled by checking the std::cerr output for the log message. Full diff: https://github.com/llvm/llvm-project/pull/134842.diff 4 Files Affected:
diff --git a/mlir/include/mlir/Tools/mlir-opt/MlirOptMain.h b/mlir/include/mlir/Tools/mlir-opt/MlirOptMain.h
index 09bd86b9581df..af379797fe865 100644
--- a/mlir/include/mlir/Tools/mlir-opt/MlirOptMain.h
+++ b/mlir/include/mlir/Tools/mlir-opt/MlirOptMain.h
@@ -238,9 +238,6 @@ class MlirOptMainConfig {
/// Elide resources when generating bytecode.
bool elideResourceDataFromBytecodeFlag = false;
- /// Enable the Debugger action hook: Debugger can intercept MLIR Actions.
- bool enableDebuggerActionHookFlag = false;
-
/// IRDL file to register before processing the input.
std::string irdlFileFlag = "";
diff --git a/mlir/lib/Debug/CLOptionsSetup.cpp b/mlir/lib/Debug/CLOptionsSetup.cpp
index 340055adf5aab..cb0b0e5c375e0 100644
--- a/mlir/lib/Debug/CLOptionsSetup.cpp
+++ b/mlir/lib/Debug/CLOptionsSetup.cpp
@@ -64,6 +64,11 @@ struct DebugConfigCLOptions : public DebugConfig {
auto [file, line, col] = *locBreakpoint;
locBreakpointManager.addBreakpoint(file, line, col);
}));
+
+ static cl::opt<bool, /*ExternalStorage=*/true> enableDebuggerHook(
+ "mlir-enable-debugger-hook",
+ cl::desc("Enable Debugger hook for debugging MLIR Actions"),
+ cl::location(enableDebuggerActionHookFlag), cl::init(false));
}
tracing::FileLineColLocBreakpointManager locBreakpointManager;
};
diff --git a/mlir/lib/Tools/mlir-opt/MlirOptMain.cpp b/mlir/lib/Tools/mlir-opt/MlirOptMain.cpp
index 9bbf91de18305..2924a1205f574 100644
--- a/mlir/lib/Tools/mlir-opt/MlirOptMain.cpp
+++ b/mlir/lib/Tools/mlir-opt/MlirOptMain.cpp
@@ -126,11 +126,6 @@ struct MlirOptMainConfigCLOptions : public MlirOptMainConfig {
"mlir-disable-diagnostic-notes", cl::desc("Disable diagnostic notes."),
cl::location(disableDiagnosticNotesFlag), cl::init(false));
- static cl::opt<bool, /*ExternalStorage=*/true> enableDebuggerHook(
- "mlir-enable-debugger-hook",
- cl::desc("Enable Debugger hook for debugging MLIR Actions"),
- cl::location(enableDebuggerActionHookFlag), cl::init(false));
-
static cl::opt<bool, /*ExternalStorage=*/true> explicitModule(
"no-implicit-module",
cl::desc("Disable implicit addition of a top-level module op during "
diff --git a/mlir/test/mlir-opt/debuggerhook.mlir b/mlir/test/mlir-opt/debuggerhook.mlir
new file mode 100644
index 0000000000000..54f1bf98d66df
--- /dev/null
+++ b/mlir/test/mlir-opt/debuggerhook.mlir
@@ -0,0 +1,9 @@
+// Checks that the debugger hook is enabled when called with the CLI option.
+// RUN: mlir-opt %s --mlir-enable-debugger-hook --pass-pipeline="builtin.module(func.func(canonicalize))" --mlir-disable-threading 2>&1 | FileCheck %s
+
+func.func @foo() {
+ return
+}
+
+// CHECK: ExecutionContext registered on the context
+// CHECK-SAME: (with Debugger hook)
|
joker-eph
approved these changes
Apr 8, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently if a developer uses the flag
--mlir-enable-debugger-hookthe debugger hook is not actually enabled. It seems the DebugConfig and the MainMLIROptConfig are not connected.To fix this we can move the
enableDebuggerHookCL Option to the DebugConfigCLOptions struct so that it can get registered and enabled along with the other debugger flags. AFAICS there are no other uses of the flag so this should be safe.This also adds a small LIT test to check that the hook is enabled by checking the std::cerr output for the log message.