added more detailed output flags

Author: pdschubert

include/phasar/Controller/AnalysisConfigurations.def

@@ -15,7 +15,8 @@ ANALYSIS_CONFIGURATIONS("IFDSUninitializedVariables", "ifds-uninit", IFDSUniniti
 ANALYSIS_CONFIGURATIONS("IFDSConstAnalysis", "ifds-const", IFDSConstAnalysis)
 ANALYSIS_CONFIGURATIONS("IFDSTaintAnalysis", "ifds-taint", IFDSTaintAnalysis)
 ANALYSIS_CONFIGURATIONS("IDETaintAnalysis", "ide-taint", IDETaintAnalysis)
-ANALYSIS_CONFIGURATIONS("IDETypeStateAnalysis", "ide-ts", IDETypeStateAnalysis)
+ANALYSIS_CONFIGURATIONS("IDECSTDIOTypeStateAnalysis", "ide-stdio-ts", IDECSTDIOTypeStateAnalysis)
+ANALYSIS_CONFIGURATIONS("IDEOpenSSLTypeStateAnalysis", "ide-openssl-ts", IDEOpenSSLTypeStateAnalysis)
 ANALYSIS_CONFIGURATIONS("IFDSTypeAnalysis", "ifds-ts", IFDSTypeAnalysis)
 ANALYSIS_CONFIGURATIONS("IFDSSolverTest", "ifds-solvertest", IFDSSolverTest)
 ANALYSIS_CONFIGURATIONS("IFDSLinearConstantAnalysis", "ifds-lca", IFDSLinearConstantAnalysis)

include/phasar/Controller/AnalysisController.h

@@ -15,6 +15,8 @@
 #include <string>
 #include <vector>
 
+#include <boost/filesystem.hpp>
+
 #include <phasar/DB/ProjectIRDB.h>
 #include <phasar/PhasarLLVM/AnalysisStrategy/Strategies.h>
 #include <phasar/PhasarLLVM/ControlFlow/LLVMBasedICFG.h>
@@ -52,6 +54,9 @@ class AnalysisController {
   [[maybe_unused]] AnalysisStrategy Strategy;
   AnalysisControllerEmitterOptions EmitterOptions =
       AnalysisControllerEmitterOptions::None;
+  std::string ProjectID;
+  std::string OutDirectory;
+  boost::filesystem::path ResultDirectory;
 
   void executeDemandDriven();
 
@@ -63,16 +68,33 @@ class AnalysisController {
 
   void executeWholeProgram();
 
-  template <typename T> void emitRequestedResults(T &WPA) {
+  void emitRequestedHelperAnalysisResults();
+
+  template <typename T> void emitRequestedDataFlowResults(T &WPA) {
     if (EmitterOptions & AnalysisControllerEmitterOptions::EmitTextReport) {
-      WPA.emitTextReport();
+      if (!ResultDirectory.empty()) {
+        std::ofstream OFS(ResultDirectory.string() + "/psr-report.txt");
+        WPA.emitTextReport(OFS);
+      } else {
+        WPA.emitTextReport();
+      }
     }
     if (EmitterOptions &
         AnalysisControllerEmitterOptions::EmitGraphicalReport) {
-      WPA.emitGraphicalReport();
+      if (!ResultDirectory.empty()) {
+        std::ofstream OFS(ResultDirectory.string() + "/psr-report.html");
+        WPA.emitGraphicalReport(OFS);
+      } else {
+        WPA.emitGraphicalReport();
+      }
     }
     if (EmitterOptions & AnalysisControllerEmitterOptions::EmitRawResults) {
-      WPA.dumpResults();
+      if (!ResultDirectory.empty()) {
+        std::ofstream OFS(ResultDirectory.string() + "/psr-raw-results.txt");
+        WPA.dumpResults(OFS);
+      } else {
+        WPA.dumpResults();
+      }
     }
   }
 
@@ -83,7 +105,9 @@ class AnalysisController {
                      PointerAnalysisType PTATy, CallGraphAnalysisType CGTy,
                      std::set<std::string> EntryPoints,
                      AnalysisStrategy Strategy,
-                     AnalysisControllerEmitterOptions EmitterOptions);
+                     AnalysisControllerEmitterOptions EmitterOptions,
+                     std::string ProjectID = "default-phasar-project",
+                     std::string OutDirectory = "");
 
   ~AnalysisController() = default;
 

include/phasar/PhasarLLVM/DataFlowSolver/IfdsIde/EdgeFunctions/AllBottom.h

@@ -23,7 +23,6 @@
 #include <string>
 
 #include <phasar/PhasarLLVM/DataFlowSolver/IfdsIde/EdgeFunction.h>
-#include <phasar/Utils/Macros.h>
 
 namespace psr {
 

include/phasar/PhasarLLVM/DataFlowSolver/IfdsIde/Problems/TypeStateDescriptions/OpenSSLEVPKeyDerivationTypeStateDescription.h

@@ -61,24 +61,38 @@ class OpenSSLEVPKeyDerivationTypeStateDescription
 
   static const std::map<std::string, std::set<int>>
       OpenSSLEVPKeyDerivationFuncs;
+
   // delta matrix to implement the state machine's delta function
   static const OpenSSLEVPKeyDerivationState delta[6][7];
+
   OpenSSLEVPKeyDerivationToken funcNameToToken(const std::string &F) const;
 
 public:
   bool isFactoryFunction(const std::string &F) const override;
+
   bool isConsumingFunction(const std::string &F) const override;
+
   bool isAPIFunction(const std::string &F) const override;
+
   TypeStateDescription::State
   getNextState(std::string Tok, TypeStateDescription::State S) const override;
+
   std::string getTypeNameOfInterest() const override;
+
   std::set<int> getConsumerParamIdx(const std::string &F) const override;
+
   std::set<int> getFactoryParamIdx(const std::string &F) const override;
+
   std::string stateToString(TypeStateDescription::State S) const override;
+
   TypeStateDescription::State bottom() const override;
+
   TypeStateDescription::State top() const override;
+
   TypeStateDescription::State uninit() const override;
+
   TypeStateDescription::State start() const override;
+
   TypeStateDescription::State error() const override;
 };
 

include/phasar/PhasarLLVM/Utils/DOTGraph.h

@@ -19,10 +19,11 @@
 
 #include <iosfwd>
 #include <map>
-#include <phasar/Utils/Macros.h>
 #include <set>
 #include <string>
 
+#include <phasar/Utils/Utilities.h>
+
 namespace psr {
 
 class DOTConfig {

include/phasar/PhasarLLVM/Utils/DataFlowAnalysisType.def

@@ -15,8 +15,8 @@ DATA_FLOW_ANALYSIS_TYPES("IFDSUninitializedVariables", "ifds-uninit", IFDSUninit
 DATA_FLOW_ANALYSIS_TYPES("IFDSConstAnalysis", "ifds-const", IFDSConstAnalysis)
 DATA_FLOW_ANALYSIS_TYPES("IFDSTaintAnalysis", "ifds-taint", IFDSTaintAnalysis)
 DATA_FLOW_ANALYSIS_TYPES("IDETaintAnalysis", "ide-taint", IDETaintAnalysis)
-DATA_FLOW_ANALYSIS_TYPES("IDETypeStateAnalysis", "ide-ts", IDETypeStateAnalysis)
-DATA_FLOW_ANALYSIS_TYPES("IFDSTypeAnalysis", "ifds-ts", IFDSTypeAnalysis)
+DATA_FLOW_ANALYSIS_TYPES("IFDSTypeAnalysis", "ifds-type", IFDSTypeAnalysis)
+DATA_FLOW_ANALYSIS_TYPES("IDEOpenSSLTypeStateAnalysis", "ide-openssl-ts", IDEOpenSSLTypeStateAnalysis)
 DATA_FLOW_ANALYSIS_TYPES("IFDSSolverTest", "ifds-solvertest", IFDSSolverTest)
 DATA_FLOW_ANALYSIS_TYPES("IFDSLinearConstantAnalysis", "ifds-lca", IFDSLinearConstantAnalysis)
 DATA_FLOW_ANALYSIS_TYPES("IFDSFieldSensTaintAnalysis", "ifds-fstaint", IFDSFieldSensTaintAnalysis)

include/phasar/PhasarLLVM/Utils/IOFormat.def

@@ -0,0 +1,18 @@
+/******************************************************************************
+ * Copyright (c) 2020 Philipp Schubert.
+ * All rights reserved. This program and the accompanying materials are made
+ * available under the terms of LICENSE.txt.
+ *
+ * Contributors:
+ *     Philipp Schubert and others
+ *****************************************************************************/
+
+#ifndef IO_FORMAT_TYPES
+#define IO_FORMAT_TYPES(NAME, CMDFLAG, TYPE)
+#endif
+
+IO_FORMAT_TYPES("JSON", "json", JSON)
+IO_FORMAT_TYPES("SARIF", "sarif", SARIF)
+IO_FORMAT_TYPES("None", "none", None)
+
+#undef IO_FORMAT_TYPES

include/phasar/PhasarLLVM/Utils/IOFormat.h

@@ -0,0 +1,31 @@
+/******************************************************************************
+ * Copyright (c) 2020 Philipp Schubert.
+ * All rights reserved. This program and the accompanying materials are made
+ * available under the terms of LICENSE.txt.
+ *
+ * Contributors:
+ *     Philipp Schubert and others
+ *****************************************************************************/
+
+#ifndef PHASAR_PHASARLLVM_UTILS_IOFORMAT_H_
+#define PHASAR_PHASARLLVM_UTILS_IOFORMAT_H_
+
+#include <iosfwd>
+#include <string>
+
+namespace psr {
+
+enum class IOFormat {
+#define IO_FORMAT_TYPES(NAME, CMDFLAG, TYPE) TYPE,
+#include <phasar/PhasarLLVM/Utils/IOFormat.def>
+};
+
+std::string to_string(const IOFormat &D);
+
+IOFormat to_IOFormat(const std::string &S);
+
+std::ostream &operator<<(std::ostream &os, const IOFormat &D);
+
+} // namespace psr
+
+#endif

include/phasar/Utils/LLVMShorthands.h

@@ -17,10 +17,11 @@
 #ifndef PHASAR_UTILS_LLVMSHORTHANDS_H_
 #define PHASAR_UTILS_LLVMSHORTHANDS_H_
 
-#include <phasar/Utils/Macros.h>
 #include <string>
 #include <vector>
 
+#include <phasar/Utils/Utilities.h>
+
 namespace llvm {
 class Value;
 class FunctionType;

include/phasar/Utils/Macros.h include/phasar/Utils/Utilities.hinclude/phasar/Utils/Macros.h renamed to include/phasar/Utils/Utilities.h

@@ -7,40 +7,21 @@
  *     Philipp Schubert and others
  *****************************************************************************/
 
-#ifndef PHASAR_UTILS_MACROS_H_
-#define PHASAR_UTILS_MACROS_H_
+#ifndef PHASAR_UTILS_UTILITIES_H_
+#define PHASAR_UTILS_UTILITIES_H_
 
 #include <iosfwd>
 #include <set>
 #include <string>
 #include <vector>
-// Should include <iostream> due to the Macros using std::cerr
 
 namespace llvm {
 class Type;
 } // namespace llvm
 
 namespace psr {
 
-#define MYDEBUG
-
-#define HEREANDNOW                                                             \
-  std::cerr << "file: " << __FILE__ << " line: " << __LINE__                   \
-            << " function: " << __func__ << std::endl;
-
-#define DIE_HARD exit(-1);
-
-#define UNRECOVERABLE_CXX_ERROR_COND(BOOL, STRING)                             \
-  if (!BOOL) {                                                                 \
-    HEREANDNOW;                                                                \
-    std::cerr << STRING << std::endl;                                          \
-    exit(-1);                                                                  \
-  }
-
-#define UNRECOVERABLE_CXX_ERROR_UNCOND(STRING)                                 \
-  HEREANDNOW;                                                                  \
-  std::cerr << STRING << std::endl;                                            \
-  exit(-1);
+std::string createTimeStamp();
 
 std::string cxx_demangle(const std::string &mangled_name);