added the possibility to export general statistics objects as json. added commandline argument to store the exported json in a file

Author: janniclas

include/phasar/DB/ProjectIRDB.h

@@ -22,6 +22,7 @@
 #include "llvm/Passes/PassBuilder.h"
 
 #include "phasar/Utils/EnumFlags.h"
+#include "nlohmann/json.hpp"
 
 namespace llvm {
 class Value;
@@ -61,6 +62,7 @@ class ProjectIRDB {
   // Maps an id to its corresponding instruction
   std::map<std::size_t, llvm::Instruction *> IDInstructionMapping;
   size_t NumberCallsites;
+  nlohmann::json StatsJson;
 
   void buildIDModuleMapping(llvm::Module *M);
 
@@ -182,6 +184,8 @@ class ProjectIRDB {
 
   [[nodiscard]] static std::size_t getInstructionID(const llvm::Instruction *I);
 
+  void printAsJson(llvm::raw_ostream &OS = llvm::outs()) const;
+
   void print() const;
 
   void emitPreprocessedIR(llvm::raw_ostream &OS = llvm::outs(),

include/phasar/PhasarLLVM/Passes/GeneralStatisticsAnalysis.h

@@ -20,6 +20,7 @@
 #include <set>
 
 #include "llvm/IR/PassManager.h"
+#include "nlohmann/json.hpp"
 
 namespace llvm {
 class Type;
@@ -115,6 +116,8 @@ class GeneralStatistics {
    */
   [[nodiscard]] std::set<const llvm::Instruction *>
   getRetResInstructions() const;
+  [[nodiscard]] nlohmann::json getAsJson() const;
+
 };
 
 /**

lib/Controller/AnalysisController.cpp

@@ -272,6 +272,16 @@ void AnalysisController::emitRequestedHelperAnalysisResults() {
       ICF.printAsJson();
     }
   }
+
+  if (EmitterOptions & AnalysisControllerEmitterOptions::EmitStatisticAsJson) {
+    if (!ResultDirectory.empty()) {
+      if (auto OFS = openFileStream("/psr-IrStatistic.json")) {
+        IRDB.printAsJson(*OFS);
+      }
+    } else {
+      IRDB.printAsJson();
+    }
+  }
 }
 
 std::unique_ptr<llvm::raw_fd_ostream>

lib/DB/ProjectIRDB.cpp

@@ -126,6 +126,7 @@ void ProjectIRDB::preprocessModule(llvm::Module *M) {
   MPM.run(*M, MAM);
   // retrieve data from the GeneralStatisticsAnalysis registered earlier
   auto GSPResult = MAM.getResult<GeneralStatisticsAnalysis>(*M);
+  StatsJson = GSPResult.getAsJson();
   NumberCallsites = GSPResult.getFunctioncalls();
   auto Allocas = GSPResult.getAllocaInstructions();
   AllocaInstructions.insert(Allocas.begin(), Allocas.end());
@@ -267,6 +268,10 @@ void ProjectIRDB::print() const {
   }
 }
 
+void ProjectIRDB::printAsJson(llvm::raw_ostream &OS) const {
+  OS << StatsJson.dump();
+}
+
 void ProjectIRDB::emitPreprocessedIR(llvm::raw_ostream &OS,
                                      bool ShortenIR) const {
   for (const auto &[File, Module] : Modules) {

lib/PhasarLLVM/Passes/GeneralStatisticsAnalysis.cpp

@@ -216,4 +216,14 @@ GeneralStatistics::getRetResInstructions() const {
   return RetResInstructions;
 }
 
+  nlohmann::json GeneralStatistics::getAsJson() const {
+    nlohmann::json J;
+    J["Instructions"] = getInstructions();
+    J["Functions"] = Functions;
+    J["Alloca Instructions"] = AllocaInstructions.size();
+    J["Call Sites"] = CallSites;
+    J["Global Variables"] = Globals;
+    return J;
+  }
+
 } // namespace psr