Implementing On-The-Fly Reporting

.clang-tidy

@@ -4,6 +4,7 @@ Checks: '-*,
          misc-*,
            -misc-non-private-member-variables-in-classes,
            -misc-no-recursion,
+           -misc-use-anonymous-namespace,
          readability-*,
            -readability-function-cognitive-complexity,
            -readability-else-after*,

.github/CODEOWNERS

@@ -26,3 +26,9 @@ Dockerfile @janniclas
 /.docker/ @janniclas
 
 /include/phasar/Utils/Logger.h @MMory
+/include/phasar/Utils/AnalysisPrinterBase.h @sritejakv
+/include/phasar/Utils/DefaultAnalysisPrinter.h @sritejakv
+/include/phasar/Utils/NullAnalysisPrinter.h @sritejakv
+/include/phasar/Utils/OnTheFlyAnalysisPrinter.h @sritejakv
+/include/phasar/PhasarLLVM/Utils/SourceMgrPrinter.h @sritejakv
+/lib/PhasarLLVM/Utils/SourceMgrPrinter.cpp @sritejakv

include/phasar/DataFlow/IfdsIde/IDETabulationProblem.h

@@ -19,8 +19,8 @@
 #include "phasar/DataFlow/IfdsIde/IFDSIDESolverConfig.h"
 #include "phasar/DataFlow/IfdsIde/InitialSeeds.h"
 #include "phasar/DataFlow/IfdsIde/SolverResults.h"
-#include "phasar/PhasarLLVM/Utils/NullAnalysisPrinter.h"
 #include "phasar/Utils/JoinLattice.h"
+#include "phasar/Utils/NullAnalysisPrinter.h"
 #include "phasar/Utils/Printer.h"
 #include "phasar/Utils/Soundness.h"
 

include/phasar/PhasarLLVM/DataFlow/IfdsIde/Problems/IDETypeStateAnalysis.h

@@ -19,6 +19,7 @@
 #include "phasar/PhasarLLVM/DataFlow/IfdsIde/LLVMZeroValue.h"
 #include "phasar/PhasarLLVM/Domain/LLVMAnalysisDomain.h"
 #include "phasar/PhasarLLVM/Pointer/LLVMAliasInfo.h"
+#include "phasar/PhasarLLVM/Utils/DataFlowAnalysisType.h"
 #include "phasar/Utils/ByRef.h"
 #include "phasar/Utils/JoinLattice.h"
 #include "phasar/Utils/Logger.h"
@@ -529,10 +530,9 @@ class IDETypeStateAnalysis
               if (const auto *Alloca =
                       llvm::dyn_cast<llvm::AllocaInst>(Res.first)) {
                 if (Res.second == TSD->error()) {
-                  Warning<IDETypeStateAnalysisDomain<TypeStateDescriptionTy>>
-                      Warn(&I, Res.first, TSD->error());
                   // ERROR STATE DETECTED
-                  this->Printer->onResult(Warn);
+                  this->Printer->onResult(&I, Res.first, TSD->error(),
+                                          TSD->analysisType());
                 }
               }
             }
@@ -541,10 +541,9 @@ class IDETypeStateAnalysis
               if (const auto *Alloca =
                       llvm::dyn_cast<llvm::AllocaInst>(Res.first)) {
                 if (Res.second == TSD->error()) {
-                  Warning<IDETypeStateAnalysisDomain<TypeStateDescriptionTy>>
-                      Warn(&I, Res.first, TSD->error());
                   // ERROR STATE DETECTED
-                  this->Printer->onResult(Warn);
+                  this->Printer->onResult(&I, Res.first, TSD->error(),
+                                          TSD->analysisType());
                 }
               }
             }
@@ -553,7 +552,7 @@ class IDETypeStateAnalysis
       }
     }
 
-    this->Printer->onFinalize(OS);
+    this->Printer->onFinalize();
   }
 
 private:

include/phasar/PhasarLLVM/DataFlow/IfdsIde/Problems/TypeStateDescriptions/CSTDFILEIOTypeStateDescription.h

@@ -72,6 +72,7 @@ class CSTDFILEIOTypeStateDescription
   [[nodiscard]] TypeStateDescription::State uninit() const override;
   [[nodiscard]] TypeStateDescription::State start() const override;
   [[nodiscard]] TypeStateDescription::State error() const override;
+  [[nodiscard]] DataFlowAnalysisType analysisType() const override;
 };
 
 extern template class IDETypeStateAnalysis<CSTDFILEIOTypeStateDescription>;

include/phasar/PhasarLLVM/DataFlow/IfdsIde/Problems/TypeStateDescriptions/OpenSSLEVPKDFCTXDescription.h

@@ -102,6 +102,7 @@ class OpenSSLEVPKDFCTXDescription
   [[nodiscard]] State uninit() const override;
   [[nodiscard]] State start() const override;
   [[nodiscard]] State error() const override;
+  [[nodiscard]] DataFlowAnalysisType analysisType() const override;
   /*
     /// Checks all callSites, where a EVP_KDF object needs to be in a
     /// certain state, such that the state transition for EVP_KDF_CTX is valid.

include/phasar/PhasarLLVM/DataFlow/IfdsIde/Problems/TypeStateDescriptions/OpenSSLEVPKDFDescription.h

@@ -85,6 +85,8 @@ class OpenSSLEVPKDFDescription
   [[nodiscard]] TypeStateDescription::State start() const override;
 
   [[nodiscard]] TypeStateDescription::State error() const override;
+
+  [[nodiscard]] DataFlowAnalysisType analysisType() const override;
 };
 
 } // namespace psr

include/phasar/PhasarLLVM/DataFlow/IfdsIde/Problems/TypeStateDescriptions/OpenSSLSecureHeapDescription.h

@@ -72,6 +72,7 @@ class OpenSSLSecureHeapDescription
   [[nodiscard]] TypeStateDescription::State uninit() const override;
   [[nodiscard]] TypeStateDescription::State start() const override;
   [[nodiscard]] TypeStateDescription::State error() const override;
+  [[nodiscard]] DataFlowAnalysisType analysisType() const override;
 };
 
 } // namespace psr

include/phasar/PhasarLLVM/DataFlow/IfdsIde/Problems/TypeStateDescriptions/OpenSSLSecureMemoryDescription.h

@@ -41,6 +41,7 @@ class OpenSSLSecureMemoryDescription
   [[nodiscard]] TypeStateDescription::State uninit() const override;
   [[nodiscard]] TypeStateDescription::State start() const override;
   [[nodiscard]] TypeStateDescription::State error() const override;
+  [[nodiscard]] DataFlowAnalysisType analysisType() const override;
 };
 
 } // namespace psr

include/phasar/PhasarLLVM/DataFlow/IfdsIde/Problems/TypeStateDescriptions/TypeStateDescription.h

@@ -10,6 +10,8 @@
 #ifndef PHASAR_PHASARLLVM_DATAFLOW_IFDSIDE_PROBLEMS_TYPESTATEDESCRIPTIONS_TYPESTATEDESCRIPTION_H
 #define PHASAR_PHASARLLVM_DATAFLOW_IFDSIDE_PROBLEMS_TYPESTATEDESCRIPTIONS_TYPESTATEDESCRIPTION_H
 
+#include "phasar/PhasarLLVM/Utils/DataFlowAnalysisType.h"
+
 #include "llvm/IR/InstrTypes.h"
 
 #include <set>
@@ -28,6 +30,7 @@ struct TypeStateDescriptionBase {
   getConsumerParamIdx(llvm::StringRef F) const = 0;
   [[nodiscard]] virtual std::set<int>
   getFactoryParamIdx(llvm::StringRef F) const = 0;
+  [[nodiscard]] virtual DataFlowAnalysisType analysisType() const = 0;
 };
 
 /**

include/phasar/PhasarLLVM/Utils/LLVMIRToSrc.h

@@ -19,6 +19,7 @@
 
 #include "nlohmann/json.hpp"
 
+#include <optional>
 #include <string>
 
 // Forward declaration of types for which we only use its pointer or ref type
@@ -39,6 +40,7 @@ namespace psr {
 [[nodiscard]] std::string getFunctionNameFromIR(const llvm::Value *V);
 
 [[nodiscard]] std::string getFilePathFromIR(const llvm::Value *V);
+[[nodiscard]] std::string getFilePathFromIR(const llvm::DIFile *DIF);
 
 [[nodiscard]] std::string getDirectoryFromIR(const llvm::Value *V);
 
@@ -85,6 +87,15 @@ void to_json(nlohmann::json &J, const SourceCodeInfo &Info);
 
 [[nodiscard]] SourceCodeInfo getSrcCodeInfoFromIR(const llvm::Value *V);
 
+struct DebugLocation {
+  unsigned Line{};
+  unsigned Column{};
+  const llvm::DIFile *File{};
+};
+
+[[nodiscard]] std::optional<DebugLocation>
+getDebugLocation(const llvm::Value *V);
+
 } // namespace psr
 
 #endif

include/phasar/PhasarLLVM/Utils/LLVMSourceManager.h

@@ -0,0 +1,36 @@
+#ifndef PHASAR_PHASARLLVM_UTILS_LLVMSOURCEMANAGER_H
+#define PHASAR_PHASARLLVM_UTILS_LLVMSOURCEMANAGER_H
+
+#include "llvm/ADT/DenseMap.h"
+#include "llvm/ADT/Twine.h"
+#include "llvm/Support/SourceMgr.h"
+
+#include <optional>
+
+namespace llvm {
+class Value;
+class DIFile;
+} // namespace llvm
+
+namespace psr {
+struct ManagedDebugLocation {
+  unsigned Line{};
+  unsigned Column{};
+  unsigned File{};
+};
+
+class LLVMSourceManager {
+public:
+  [[nodiscard]] std::optional<ManagedDebugLocation>
+  getDebugLocation(const llvm::Value *V);
+
+  void print(llvm::raw_ostream &OS, ManagedDebugLocation Loc,
+             llvm::SourceMgr::DiagKind DiagKind, const llvm::Twine &Message);
+
+private:
+  llvm::DenseMap<const llvm::DIFile *, unsigned> FileIdMap{};
+  llvm::SourceMgr SrcMgr{};
+};
+} // namespace psr
+
+#endif // PHASAR_PHASARLLVM_UTILS_LLVMSOURCEMANAGER_H

include/phasar/PhasarLLVM/Utils/SourceMgrPrinter.h

@@ -0,0 +1,71 @@
+#ifndef PHASAR_PHASARLLVM_UTILS_SOURCEMGRPRINTER_H
+#define PHASAR_PHASARLLVM_UTILS_SOURCEMGRPRINTER_H
+
+#include "phasar/PhasarLLVM/Utils/DataFlowAnalysisType.h"
+#include "phasar/PhasarLLVM/Utils/LLVMIRToSrc.h"
+#include "phasar/PhasarLLVM/Utils/LLVMSourceManager.h"
+#include "phasar/Utils/AnalysisPrinterBase.h"
+#include "phasar/Utils/MaybeUniquePtr.h"
+
+#include "llvm/ADT/FunctionExtras.h"
+#include "llvm/Support/raw_ostream.h"
+
+#include <type_traits>
+
+namespace psr {
+
+namespace detail {
+class SourceMgrPrinterBase {
+public:
+  explicit SourceMgrPrinterBase(
+      llvm::unique_function<std::string(DataFlowAnalysisType)> &&PrintMessage,
+      llvm::raw_ostream &OS = llvm::errs(),
+      llvm::SourceMgr::DiagKind WKind = llvm::SourceMgr::DK_Warning);
+
+  explicit SourceMgrPrinterBase(
+      llvm::unique_function<std::string(DataFlowAnalysisType)> &&PrintMessage,
+      const llvm::Twine &OutFileName,
+      llvm::SourceMgr::DiagKind WKind = llvm::SourceMgr::DK_Warning);
+
+protected:
+  LLVMSourceManager SrcMgr;
+
+  llvm::unique_function<std::string(DataFlowAnalysisType)> GetPrintMessage;
+  MaybeUniquePtr<llvm::raw_ostream> OS = &llvm::errs();
+  llvm::SourceMgr::DiagKind WarningKind;
+};
+} // namespace detail
+
+template <typename AnalysisDomainTy>
+class SourceMgrPrinter : public AnalysisPrinterBase<AnalysisDomainTy>,
+                         private detail::SourceMgrPrinterBase {
+  using n_t = typename AnalysisDomainTy::n_t;
+  using d_t = typename AnalysisDomainTy::d_t;
+  using l_t = typename AnalysisDomainTy::l_t;
+
+public:
+  explicit SourceMgrPrinter(
+      llvm::unique_function<std::string(DataFlowAnalysisType)> &&PrintMessage,
+      llvm::raw_ostream &OS = llvm::errs(),
+      llvm::SourceMgr::DiagKind WKind = llvm::SourceMgr::DK_Warning)
+      : detail::SourceMgrPrinterBase(std::move(PrintMessage), OS, WKind) {}
+
+private:
+  void doOnResult(n_t Inst, d_t Fact, l_t /*Value*/,
+                  DataFlowAnalysisType AnalysisType) override {
+    auto SrcLoc = SrcMgr.getDebugLocation(Inst);
+    if constexpr (std::is_convertible_v<d_t, const llvm::Value *>) {
+      if (!SrcLoc) {
+        SrcLoc =
+            SrcMgr.getDebugLocation(static_cast<const llvm::Value *>(Fact));
+      }
+    }
+
+    if (SrcLoc) {
+      SrcMgr.print(*OS, *SrcLoc, WarningKind, GetPrintMessage(AnalysisType));
+    }
+  }
+};
+
+} // namespace psr
+#endif