Refactor FunctionPropertiesAnalysis

[tarinduj]

Summary

this separates analyze logic from FunctionPropertiesAnalysis

[mtrofin]

llvm/include/llvm/Analysis/ML/FunctionPropertiesAnalysis.h

44

I think (D82270) we were saying we would have a static factory method in FunctionPropertiesInfo, instead of a member. We'd then (maybe later CL) try to treat a FunctionPropertiesInfo instance as immutable.

[tarinduj]

added a static factory method getFunctionPropertiesInfo.

[mtrofin]

lgtm

[tarinduj]

[rebased] can someone upstream this? I do not have commit access.

llvm/include/llvm/Analysis/ML/FunctionPropertiesAnalysis.h

+//===- FunctionPropertiesAnalysis.h - Function Properties Analysis ----------*- 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
+//
+//===----------------------------------------------------------------------===//
+//
+// This file defines the FunctionPropertiesInfo and FunctionPropertiesAnalysis 
+// classes used to extract function properties. 
+//
+//===----------------------------------------------------------------------===//
+
 #ifndef LLVM_FUNCTIONPROPERTIESANALYSIS_H_
 #define LLVM_FUNCTIONPROPERTIESANALYSIS_H_
 

 namespace llvm {
 class Function;
 
-class FunctionPropertiesAnalysis
-    : public AnalysisInfoMixin<FunctionPropertiesAnalysis> {
-public:
-  static AnalysisKey Key;
-  struct Result {
+class FunctionPropertiesInfo{
+  public:
     /// Number of basic blocks
     int64_t BasicBlockCount = 0;
 

     /// Number of direct calls made from this function to other functions
     /// defined in this module.
     int64_t DirectCallsToDefinedFunctions = 0;
-  };
-  Result run(const Function &F, FunctionAnalysisManager &FAM);
+
+    void analyze(const Function &F);
+};
+
+//Analysis pass
+class FunctionPropertiesAnalysis 
+    : public AnalysisInfoMixin<FunctionPropertiesAnalysis> {
+
+  public:
+    static AnalysisKey Key;
+
+    using Result = FunctionPropertiesInfo;
+
+    Result run(Function &F, FunctionAnalysisManager &FAM);
 };
 
 } // namespace llvm
-#endif // LLVM_FUNCTIONPROPERTIESANALYSIS_H_
+#endif // LLVM_FUNCTIONPROPERTIESANALYSIS_H_ 
 No newline at end of file

llvm/lib/Analysis/ML/FunctionPropertiesAnalysis.cpp

+//===- FunctionPropertiesAnalysis.cpp - Function Properties Analysis ------===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+//
+// This file defines the FunctionPropertiesInfo and FunctionPropertiesAnalysis 
+// classes used to extract function properties. 
+//
+//===----------------------------------------------------------------------===//
+
 #include "llvm/Analysis/ML/FunctionPropertiesAnalysis.h"
 #include "llvm/IR/Instructions.h"
+#include "llvm/Passes/PassBuilder.h"
+#include "llvm/Passes/PassPlugin.h"
+#include "llvm/Support/raw_ostream.h"
 
 using namespace llvm;
 
-AnalysisKey FunctionPropertiesAnalysis::Key;
+void FunctionPropertiesInfo::analyze(const Function &F) {
+
+  Uses = ((!F.hasLocalLinkage()) ? 1 : 0) + F.getNumUses();
 
-FunctionPropertiesAnalysis::Result
-FunctionPropertiesAnalysis::run(const Function &F, FunctionAnalysisManager &FAM) {
-  Result Ret;
-  Ret.Uses = ((!F.hasLocalLinkage()) ? 1 : 0) + F.getNumUses();
   for (const auto &BB : F) {
-    ++Ret.BasicBlockCount;
+    ++BasicBlockCount;
+
     if (const auto *BI = dyn_cast<BranchInst>(BB.getTerminator())) {
       if (BI->isConditional())
-        Ret.BlocksReachedFromConditionalInstruction += BI->getNumSuccessors();
-    } else if (const auto *SI = dyn_cast<SwitchInst>(BB.getTerminator()))
-      Ret.BlocksReachedFromConditionalInstruction +=
+        BlocksReachedFromConditionalInstruction += BI->getNumSuccessors();
+    } else if (const auto *SI = dyn_cast<SwitchInst>(BB.getTerminator())) {
+      BlocksReachedFromConditionalInstruction +=
           (SI->getNumCases() + (nullptr != SI->getDefaultDest()));
-    for (const auto &I : BB)
+    }
+
+    for (const auto &I : BB) {
       if (auto *CS = dyn_cast<CallBase>(&I)) {
         const auto *Callee = CS->getCalledFunction();
         if (Callee && !Callee->isIntrinsic() && !Callee->isDeclaration())
-          ++Ret.DirectCallsToDefinedFunctions;
+          ++DirectCallsToDefinedFunctions;
       }
     }
-  return Ret;
-}
+  }
+}
+
+AnalysisKey FunctionPropertiesAnalysis::Key;
+
+FunctionPropertiesInfo FunctionPropertiesAnalysis::run(Function &F, FunctionAnalysisManager &FAM) {
+  FunctionPropertiesInfo FPI;
+  FPI.analyze(F);
+  return FPI;
+}

llvm/unittests/Analysis/ML/FunctionPropertiesAnalysisTest.cpp

-//===- FunctionPropertiesAnalysisTest.cpp - function properties unit tests --------===//
+//===- FunctionPropertiesAnalysisTest.cpp - Function Properties 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.