[mlir] Template helper for analyses with dependencies

[Hardcode84]

FIx copypaste in license header

[rriddle]

mlir/include/mlir/Pass/AnalysisUtilities.h

28

Why not just add a variadic areAllPreserved method to PreservedAnalyses? With that, this additional class doesn't hold as much weight IMO.

[Hardcode84]

mlir/include/mlir/Pass/AnalysisUtilities.h

28

Yeah, probably you are right

mlir/include/mlir/Pass/AnalysisUtilities.h

+//===- AnalysisUtilities.h - Analysis Management Utilities ------*- C++ -*-===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef MLIR_PASS_ANALYSISUTILITIES_H
+#define MLIR_PASS_ANALYSISUTILITIES_H
+
+#include "mlir/Pass/AnalysisManager.h"
+
+namespace mlir {
+
+/// Helper class for analyses with dependencies. Auto-generates convenient
+/// constructor (Op, Dependencies...) and isInvalidated check based on template
+/// dependencies list.
+template <typename Analysis, typename... Dependencies>
+class AnalysisWrapper : public Analysis {
+public:
+  template <typename Op>
+  AnalysisWrapper(Op op, AnalysisManager &am)
+      : Analysis(op, am.getAnalysis<Dependencies>()...) {}
+
+  static bool isInvalidated(const AnalysisManager::PreservedAnalyses &pa) {
+    using SelfType = AnalysisWrapper<Analysis, Dependencies...>;
+    for (bool preserved :
+         {pa.isPreserved<SelfType>(), pa.isPreserved<Dependencies>()...})
+      if (!preserved)
+        return true;
+
+    return false;
+  }
+};
+} // end namespace mlir
+
+#endif // MLIR_PASS_ANALYSISUTILITIES_H

mlir/unittests/Pass/AnalysisManagerTest.cpp

 //===- AnalysisManagerTest.cpp - AnalysisManager unit tests ---------------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 
 #include "mlir/Pass/AnalysisManager.h"
 #include "mlir/IR/Builders.h"
 #include "mlir/IR/BuiltinOps.h"
+#include "mlir/Pass/AnalysisUtilities.h"
 #include "mlir/Pass/Pass.h"
 #include "mlir/Pass/PassManager.h"
 #include "gtest/gtest.h"
 
 using namespace mlir;
 using namespace mlir::detail;
 
 namespace {
TEST(AnalysisManagerTest, DependentAnalysis2Ctors) {
   ModuleAnalysisManager mam(*module, /*passInstrumentor=*/nullptr);
   AnalysisManager am = mam;
 
   auto &an = am.getAnalysis<AnalysisWith2Ctors>();
   EXPECT_FALSE(an.ctor1called);
   EXPECT_TRUE(an.ctor2called);
 }
 
+struct Analysis0Deps {
+  Analysis0Deps(Operation *) {}
+};
+
+using WrappedAnalysis0Deps = AnalysisWrapper<Analysis0Deps>;
+
+TEST(AnalysisManagerTest, AnalysisWrapper0Deps) {
+  MLIRContext context;
+
+  // Create a module.
+  OwningModuleRef module(ModuleOp::create(UnknownLoc::get(&context)));
+  ModuleAnalysisManager mam(*module, /*passInstrumentor=*/nullptr);
+  AnalysisManager am = mam;
+
+  am.getAnalysis<WrappedAnalysis0Deps>();
+  EXPECT_TRUE(am.getCachedAnalysis<WrappedAnalysis0Deps>().hasValue());
+
+  detail::PreservedAnalyses pa;
+  am.invalidate(pa);
+
+  EXPECT_FALSE(am.getCachedAnalysis<WrappedAnalysis0Deps>().hasValue());
+}
+
+struct Analysis2Deps {
+  Analysis2Deps(Operation *, MyAnalysis &, OtherAnalysis &) {}
+};
+
+using WrappedAnalysis2Deps =
+    AnalysisWrapper<Analysis2Deps, MyAnalysis, OtherAnalysis>;
+
+TEST(AnalysisManagerTest, AnalysisWrapper2Deps) {
+  MLIRContext context;
+
+  // Create a module.
+  OwningModuleRef module(ModuleOp::create(UnknownLoc::get(&context)));
+  ModuleAnalysisManager mam(*module, /*passInstrumentor=*/nullptr);
+  AnalysisManager am = mam;
+
+  am.getAnalysis<WrappedAnalysis2Deps>();
+  EXPECT_TRUE(am.getCachedAnalysis<WrappedAnalysis2Deps>().hasValue());
+  EXPECT_TRUE(am.getCachedAnalysis<MyAnalysis>().hasValue());
+  EXPECT_TRUE(am.getCachedAnalysis<OtherAnalysis>().hasValue());
+
+  detail::PreservedAnalyses pa;
+  pa.preserve<WrappedAnalysis2Deps>();
+  am.invalidate(pa);
+
+  EXPECT_FALSE(am.getCachedAnalysis<WrappedAnalysis2Deps>().hasValue());
+}
+
 } // end namespace