Add explicit error reporting to transform passes (#1976)

Currently pass failures are silent (only written to `llvm::dbgs`) in these passes Adding explicit error reporting will at least make it clear what pass has failed. Revert change to clang format script since it breaks when there are multiple files, see: https://github.com/openxla/stablehlo/actions/runs/7743835139 --------- Co-authored-by: mlevesquedion <[email protected]>
openxla · Feb 1, 2024 · 39c4a00 · 39c4a00
1 parent f5eadaa
commit 39c4a00
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 4 deletions.
diff --git a/build_tools/github_actions/lint_clang_format.sh b/build_tools/github_actions/lint_clang_format.sh
@@ -45,7 +45,7 @@ fi
 echo "Running clang-format [mode=$FORMAT_MODE]..."
 echo "  Files: $CHANGED_FILES"
 if [[ $FORMAT_MODE == 'fix' ]]; then
-  clang-format --style=google -i "$CHANGED_FILES"
+  clang-format --style=google -i $CHANGED_FILES
 else
-  clang-format --style=google --dry-run --Werror "$CHANGED_FILES"
+  clang-format --style=google --dry-run --Werror $CHANGED_FILES
 fi
diff --git a/stablehlo/transforms/StablehloCanonicalizeDynamism.cpp b/stablehlo/transforms/StablehloCanonicalizeDynamism.cpp
@@ -308,8 +308,11 @@ struct StablehloCanonicalizeDynamismPass
 
     RewritePatternSet patterns(&getContext());
     populateStablehloCanonicalizeDynamismPatterns(&patterns, &getContext());
-    if (failed(applyPatternsAndFoldGreedily(getOperation(), std::move(patterns),
-                                            config))) {
+    auto func = getOperation();
+    if (failed(
+            applyPatternsAndFoldGreedily(func, std::move(patterns), config))) {
+      func.emitError("Failed to converge StablehloCanonicalizeDynamism in ")
+          << config.maxIterations << " iterations";
       return signalPassFailure();
     }
   }

diff --git a/stablehlo/transforms/StablehloRefineShapes.cpp b/stablehlo/transforms/StablehloRefineShapes.cpp
@@ -1082,9 +1082,12 @@ struct StablehloRefineShapesPass
     config.strictMode = GreedyRewriteStrictness::AnyOp;
 
     RewritePatternSet patterns(&getContext());
+
     populateStablehloRefineShapesPatterns(&patterns, &getContext());
     if (failed(
             applyPatternsAndFoldGreedily(func, std::move(patterns), config))) {
+      func.emitError("Failed to converge StablehloRefineShapes in ")
+          << config.maxIterations << " iterations";
       return signalPassFailure();
     }
   }