minor

Author: fabianbs96

examples/how-to/04-run-ifds-analysis/otf-reporter.cpp

@@ -7,6 +7,11 @@
 
 namespace {
 /// A listener that gets notified, whenever the taint analysis detects a leak
+///
+/// Checkout the analysis-printers that are already provided by PhASAR:
+/// - "phasar/Utils/OnTheFlyReporter.h"
+/// - "phasar/PhasarLLVM/Utils/LLVMAnalysisPrinter.h"
+/// - "phasar/PhasarLLVM/Utils/SourceMgrPrinter.h"
 class LeakReporter
     : public psr::AnalysisPrinterBase<psr::LLVMIFDSAnalysisDomainDefault> {
 

include/phasar/DataFlow/IfdsIde/IDETabulationProblem.h

@@ -20,6 +20,7 @@
 #include "phasar/DataFlow/IfdsIde/Solver/GenericSolverResults.h"
 #include "phasar/Utils/DefaultAnalysisPrinterSelector.h"
 #include "phasar/Utils/JoinLattice.h"
+#include "phasar/Utils/Macros.h"
 #include "phasar/Utils/MaybeUniquePtr.h"
 #include "phasar/Utils/NullAnalysisPrinter.h"
 #include "phasar/Utils/SemiRing.h"
@@ -186,17 +187,17 @@ class IDETabulationProblem : public FlowFunctions<AnalysisDomainTy, Container>,
         std::move(FactToGenerate), getZeroValue());
   }
 
-  template <typename L = l_t>
-  std::enable_if_t<!std::is_same_v<std::decay_t<L>, psr::BinaryDomain>>
-  onResult(n_t Instr, d_t DfFact, l_t LatticeElement,
-           DataFlowAnalysisType AnalysisType) {
-    Printer->onResult(Instr, std::move(DfFact), std::move(LatticeElement),
+  template <typename D = d_t, typename L = l_t>
+  void onResult(n_t Instr, D &&DfFact, L &&LatticeElement,
+                DataFlowAnalysisType AnalysisType) {
+    Printer->onResult(Instr, PSR_FWD(DfFact), PSR_FWD(LatticeElement),
                       AnalysisType);
   }
-  template <typename L = l_t>
-  std::enable_if_t<std::is_same_v<std::decay_t<L>, psr::BinaryDomain>>
-  onResult(n_t Instr, d_t DfFact, DataFlowAnalysisType AnalysisType) {
-    Printer->onResult(Instr, std::move(DfFact), AnalysisType);
+
+  template <typename D = d_t, typename L = l_t>
+  std::enable_if_t<std::is_same_v<L, psr::BinaryDomain>>
+  onResult(n_t Instr, D &&DfFact, DataFlowAnalysisType AnalysisType) {
+    Printer->onResult(Instr, PSR_FWD(DfFact), AnalysisType);
   }
 
   /// Seeds that just start with ZeroValue and bottomElement() at the starting

include/phasar/PhasarLLVM/Utils/LLVMAnalysisPrinter.h

@@ -24,21 +24,20 @@ class DefaultLLVMAnalysisPrinter
   DefaultLLVMAnalysisPrinter() noexcept = default;
 
 private:
-  template <typename D = d_t>
   static std::optional<DebugLocation> getDbgLoc(n_t Instr,
                                                 ByConstRef<d_t> DfFact) {
     auto Ret = getDebugLocation(Instr);
-    if constexpr (std::is_convertible_v<ByConstRef<D>, const llvm::Value *>) {
+    if constexpr (std::is_convertible_v<ByConstRef<d_t>, const llvm::Value *>) {
       if (!Ret) {
         Ret = getDebugLocation(static_cast<const llvm::Value *>(DfFact));
       }
     }
     return Ret;
   }
-  template <typename D = d_t>
+
   void printVariables(llvm::raw_ostream &OS,
                       llvm::ArrayRef<Warning<AnalysisDomainTy>> Results) {
-    if constexpr (std::is_convertible_v<const D &, const llvm::Value *>) {
+    if constexpr (std::is_convertible_v<const d_t &, const llvm::Value *>) {
       bool HasVariable = false;
       for (const auto &Warn : Results) {
         if (auto VarName = getVarNameFromIR(Warn.Fact); !VarName.empty()) {
@@ -102,6 +101,8 @@ class DefaultLLVMAnalysisPrinter
       }
       OS << '\n';
     }
+
+    DbgResultsEntries.clear();
     NonDbgResultsEntries.clear();
   }
 

include/phasar/Utils/AnalysisPrinterBase.h

@@ -3,6 +3,7 @@
 
 #include "phasar/Domain/BinaryDomain.h"
 #include "phasar/PhasarLLVM/Utils/DataFlowAnalysisType.h"
+#include "phasar/Utils/Macros.h"
 
 #include "llvm/Support/raw_ostream.h"
 
@@ -18,17 +19,16 @@ template <typename AnalysisDomainTy> class AnalysisPrinterBase {
   using l_t = typename AnalysisDomainTy::l_t;
 
 public:
-  template <typename L = l_t, typename = std::enable_if_t<!std::is_same_v<
-                                  std::decay_t<L>, psr::BinaryDomain>>>
-  void onResult(n_t Instr, d_t DfFact, l_t LatticeElement,
+  template <typename D = d_t, typename L = l_t>
+  void onResult(n_t Instr, D &&DfFact, L &&LatticeElement,
                 DataFlowAnalysisType AnalysisType) {
-    doOnResult(Instr, DfFact, LatticeElement, AnalysisType);
+    doOnResult(Instr, PSR_FWD(DfFact), PSR_FWD(LatticeElement), AnalysisType);
   }
 
-  template <typename L = l_t, typename = std::enable_if_t<std::is_same_v<
-                                  std::decay_t<L>, psr::BinaryDomain>>>
-  void onResult(n_t Instr, d_t DfFact, DataFlowAnalysisType AnalysisType) {
-    doOnResult(Instr, DfFact, psr::BinaryDomain::BOTTOM, AnalysisType);
+  template <typename D = d_t, typename L = l_t>
+  std::enable_if_t<std::is_same_v<L, psr::BinaryDomain>>
+  onResult(n_t Instr, D &&DfFact, DataFlowAnalysisType AnalysisType) {
+    doOnResult(Instr, PSR_FWD(DfFact), psr::BinaryDomain::BOTTOM, AnalysisType);
   }
 
   void onInitialize() { doOnInitialize(); }
@@ -38,6 +38,7 @@ template <typename AnalysisDomainTy> class AnalysisPrinterBase {
 
   AnalysisPrinterBase() = default;
   virtual ~AnalysisPrinterBase() = default;
+
   AnalysisPrinterBase(const AnalysisPrinterBase &) = delete;
   AnalysisPrinterBase &operator=(const AnalysisPrinterBase &) = delete;
 

include/phasar/Utils/DefaultAnalysisPrinter.h

@@ -3,6 +3,7 @@
 
 #include "phasar/Domain/BinaryDomain.h"
 #include "phasar/Utils/AnalysisPrinterBase.h"
+#include "phasar/Utils/ByRef.h"
 #include "phasar/Utils/Printer.h"
 
 #include "llvm/Support/raw_ostream.h"
@@ -22,9 +23,10 @@ template <typename AnalysisDomainTy> struct Warning {
   l_t LatticeElement;
   DataFlowAnalysisType AnalysisType;
 
-  // Constructor
-  Warning(n_t Inst, d_t DfFact, l_t Lattice,
-          DataFlowAnalysisType DfAnalysisType)
+  // Constructor -- With C++20, we can get rid of it; then the below
+  // emplace_back works on aggregates too
+  constexpr Warning(n_t Inst, ByMoveRef<d_t> DfFact, ByMoveRef<l_t> Lattice,
+                    DataFlowAnalysisType DfAnalysisType) noexcept
       : Instr(std::move(Inst)), Fact(std::move(DfFact)),
         LatticeElement(std::move(Lattice)), AnalysisType(DfAnalysisType) {}
 };

include/phasar/Utils/OnTheFlyAnalysisPrinter.h

@@ -11,6 +11,7 @@
 #include "llvm/Support/raw_ostream.h"
 
 #include <cassert>
+
 namespace psr {
 
 /// This class implements the AnalysisPrinterBase that prints the analysis