Rework Folder Structure

.github/CODEOWNERS

@@ -14,11 +14,11 @@
 
 /img @pdschubert
 
-/include/phasar/PhasarLLVM/DataFlowSolver/IfdsIde/Problems/IDEInstInteractionAnalysis.h @pdschubert @vulder
-/include/phasar/PhasarLLVM/DataFlowSolver/IfdsIde/Problems/ExtendedTaintAnalysis/ @fabianbs96
-/include/phasar/PhasarLLVM/DataFlowSolver/IfdsIde/Problems/IDEExtendedTaintAnalysis.h @fabianbs96
-/lib/PhasarLLVM/DataFlowSolver/IfdsIde/Problems/IDEExtendedTaintAnalysis.cpp @fabianbs96
-/lib/PhasarLLVM/DataFlowSolver/IfdsIde/Problems/ExtendedTaintAnalysis/ @fabianbs96
+/include/phasar/PhasarLLVM/DataFlow/IfdsIde/Problems/IDEInstInteractionAnalysis.h @pdschubert @vulder
+/include/phasar/PhasarLLVM/DataFlow/IfdsIde/Problems/ExtendedTaintAnalysis/ @fabianbs96
+/include/phasar/PhasarLLVM/DataFlow/IfdsIde/Problems/IDEExtendedTaintAnalysis.h @fabianbs96
+/lib/PhasarLLVM/DataFlow/IfdsIde/Problems/IDEExtendedTaintAnalysis.cpp @fabianbs96
+/lib/PhasarLLVM/DataFlow/IfdsIde/Problems/ExtendedTaintAnalysis/ @fabianbs96
 
 /include/phasar/PhasarLLVM/AnalysisStrategy/ @pdschubert
 

CMakeLists.txt

@@ -309,7 +309,7 @@ endif()
 
 set(INCLUDE_INSTALL_DIR include/ CACHE PATH "Install dir of headers")
 
-# Install targets of phasar-llvm, other executables, and libraries are to be
+# Install targets of phasar-cli, other executables, and libraries are to be
 # found in the individual subdirectories of tools/
 
 # Install Phasar include directory

Dockerfile

@@ -58,4 +58,4 @@ RUN mkdir -p build && cd build && \
             -G Ninja && \
           cmake --build .
 
-ENTRYPOINT [ "./build/tools/phasar-llvm/phasar-llvm" ]
+ENTRYPOINT [ "./build/tools/phasar-cli/phasar-cli" ]

README.md

@@ -131,12 +131,12 @@ Use them as a reference if you wish to modify PhASAR and recompile it.
 
 After compilation using cmake the following two binaries can be found in the build/ directory:
 
-+ phasar-llvm - the actual PhASAR command-line tool
++ phasar-cli - the actual PhASAR command-line tool (previously called `phasar-llvm`)
 + myphasartool - an example tool that shows how tools can be build on top of PhASAR
 
 Use the command:
 
-`$ ./phasar-llvm --help`
+`$ ./phasar-cli --help`
 
 in order to display the manual and help message.
 
@@ -167,7 +167,7 @@ C++'s long compile times are always a pain. As shown in the above, when using cm
 ### Running a test solver
 To test if everything works as expected please run the following command:
 
-`$ phasar-llvm --module test/build_systems_tests/installation_tests/module.ll -D ifds-solvertest`
+`$ phasar-cli -m test/build_systems_tests/installation_tests/module.ll -D ifds-solvertest`
 
 If you obtain output other than a segmentation fault or an exception terminating the program abnormally everything works as expected.
 

cmake/phasar_macros.cmake

@@ -16,17 +16,21 @@ function(add_phasar_unittest test_name)
     LINK_PUBLIC
     phasar_config
     phasar_controller
+    phasar_llvm_controlflow
     phasar_controlflow
-    phasar_phasarllvm_utils
+    phasar_llvm_utils
     phasar_analysis_strategy
-    phasar_ifdside
+    phasar_llvm_ifdside
     phasar_utils
     phasar_mono
+    phasar_llvm_db
     phasar_db
     # phasar_clang
     phasar_passes
+    phasar_llvm_pointer
     phasar_pointer
-    phasar_typehierarchy
+    phasar_llvm_typehierarchy
+    phasar_llvm
     phasar_taintconfig
     nlohmann_json_schema_validator
     ${SQLITE3_LIBRARY}

examples/llvm-hello-world/main.cpp

@@ -1,6 +1,3 @@
-#include <memory>
-#include <string>
-
 #include "llvm/IR/DebugLoc.h"
 #include "llvm/IR/Function.h"
 #include "llvm/IR/Instruction.h"
@@ -15,6 +12,9 @@
 #include "llvm/Support/SourceMgr.h"
 #include "llvm/Support/raw_ostream.h"
 
+#include <memory>
+#include <string>
+
 int main(int argc, char **argv) {
   if (argc != 2) {
     llvm::errs() << "usage: <prog> <IR file>\n";

include/phasar/PhasarLLVM/AnalysisStrategy/Strategies.h → include/phasar/AnalysisStrategy/Strategies.h

@@ -24,7 +24,7 @@ namespace psr {
 enum class AnalysisStrategy {
   None,
 #define ANALYSIS_STRATEGY_TYPES(NAME, CMDFLAG, DESC) NAME,
-#include "phasar/PhasarLLVM/AnalysisStrategy/Strategies.def"
+#include "phasar/AnalysisStrategy/Strategies.def"
 
 };
 

include/phasar/PhasarLLVM/AnalysisStrategy/VariationalAnalysis.h → include/phasar/AnalysisStrategy/VariationalAnalysis.h

@@ -10,8 +10,7 @@
 #ifndef PHASAR_PHASARLLVM_ANALYSISSTRATEGY_VARIATIONALANALYSIS_H_
 #define PHASAR_PHASARLLVM_ANALYSISSTRATEGY_VARIATIONALANALYSIS_H_
 
-#include "phasar/PhasarLLVM/AnalysisStrategy/AnalysisSetup.h"
-#include "phasar/PhasarLLVM/DataFlowSolver/Mono/Solver/IntraMonoSolver.h"
+#include "phasar/AnalysisStrategy/AnalysisSetup.h"
 
 #include <type_traits>
 

include/phasar/PhasarLLVM/ControlFlow/CFGBase.h → include/phasar/ControlFlow/CFGBase.h

@@ -10,7 +10,7 @@
 #ifndef PHASAR_PHASARLLVM_CONTROLFLOW_CFGBASE_H
 #define PHASAR_PHASARLLVM_CONTROLFLOW_CFGBASE_H
 
-#include "phasar/PhasarLLVM/Utils/ByRef.h"
+#include "phasar/Utils/ByRef.h"
 #include "phasar/Utils/TypeTraits.h"
 
 #include "nlohmann/json.hpp"

include/phasar/PhasarLLVM/ControlFlow/Resolver/CallGraphAnalysisType.h → include/phasar/ControlFlow/CallGraphAnalysisType.h

@@ -18,7 +18,7 @@
 namespace psr {
 enum class CallGraphAnalysisType {
 #define CALL_GRAPH_ANALYSIS_TYPE(NAME, CMDFLAG, DESC) NAME,
-#include "phasar/PhasarLLVM/ControlFlow/Resolver/CallGraphAnalysisType.def"
+#include "phasar/ControlFlow/CallGraphAnalysisType.def"
   Invalid
 };
 

include/phasar/PhasarLLVM/ControlFlow/ICFGBase.h → include/phasar/ControlFlow/ICFGBase.h

@@ -10,7 +10,7 @@
 #ifndef PHASAR_PHASARLLVM_CONTROLFLOW_ICFGBASE_H
 #define PHASAR_PHASARLLVM_CONTROLFLOW_ICFGBASE_H
 
-#include "phasar/PhasarLLVM/ControlFlow/CFGBase.h"
+#include "phasar/ControlFlow/CFGBase.h"
 #include "phasar/Utils/TypeTraits.h"
 
 #include "llvm/ADT/StringRef.h"

include/phasar/PhasarLLVM/ControlFlow/SpecialMemberFunctionType.h → include/phasar/ControlFlow/SpecialMemberFunctionType.h

@@ -29,7 +29,7 @@ namespace psr {
 
 enum class SpecialMemberFunctionType {
 #define SPECIAL_MEMBER_FUNCTION_TYPES(NAME, TYPE) TYPE,
-#include "phasar/PhasarLLVM/ControlFlow/SpecialMemberFunctionType.def"
+#include "phasar/ControlFlow/SpecialMemberFunctionType.def"
 };
 
 std::string toString(SpecialMemberFunctionType SMFT);

include/phasar/Controller/AnalysisController.h

@@ -10,19 +10,18 @@
 #ifndef PHASAR_CONTROLLER_ANALYSISCONTROLLER_H
 #define PHASAR_CONTROLLER_ANALYSISCONTROLLER_H
 
+#include "phasar/AnalysisStrategy/Strategies.h"
 #include "phasar/Controller/AnalysisControllerEmitterOptions.h"
-#include "phasar/DB/LLVMProjectIRDB.h"
-#include "phasar/PhasarLLVM/AnalysisStrategy/HelperAnalyses.h"
-#include "phasar/PhasarLLVM/AnalysisStrategy/Strategies.h"
+#include "phasar/DataFlow/IfdsIde/IFDSIDESolverConfig.h"
+#include "phasar/DataFlow/IfdsIde/Solver/IDESolver.h"
+#include "phasar/DataFlow/IfdsIde/Solver/IFDSSolver.h"
+#include "phasar/DataFlow/IfdsIde/SolverResults.h"
+#include "phasar/DataFlow/Mono/Solver/InterMonoSolver.h"
+#include "phasar/DataFlow/Mono/Solver/IntraMonoSolver.h"
 #include "phasar/PhasarLLVM/ControlFlow/LLVMBasedICFG.h"
-#include "phasar/PhasarLLVM/DataFlowSolver/IfdsIde/IFDSIDESolverConfig.h"
-#include "phasar/PhasarLLVM/DataFlowSolver/IfdsIde/Solver/IDESolver.h"
-#include "phasar/PhasarLLVM/DataFlowSolver/IfdsIde/Solver/IFDSSolver.h"
-#include "phasar/PhasarLLVM/DataFlowSolver/IfdsIde/Solver/SolverResults.h"
-#include "phasar/PhasarLLVM/DataFlowSolver/Mono/Solver/InterMonoSolver.h"
-#include "phasar/PhasarLLVM/DataFlowSolver/Mono/Solver/IntraMonoSolver.h"
+#include "phasar/PhasarLLVM/DB/LLVMProjectIRDB.h"
+#include "phasar/PhasarLLVM/HelperAnalyses.h"
 #include "phasar/PhasarLLVM/Pointer/LLVMAliasSet.h"
-#include "phasar/PhasarLLVM/Pointer/LLVMBasedAliasAnalysis.h"
 #include "phasar/PhasarLLVM/TaintConfig/TaintConfig.h"
 #include "phasar/PhasarLLVM/TypeHierarchy/LLVMTypeHierarchy.h"
 #include "phasar/PhasarLLVM/Utils/DataFlowAnalysisType.h"

include/phasar/PhasarLLVM/DataFlowSolver/IfdsIde/EdgeFunctionComposer.h → include/phasar/DataFlow/IfdsIde/EdgeFunctionComposer.h

@@ -10,8 +10,8 @@
 #ifndef PHASAR_PHASARLLVM_DATAFLOWSOLVER_IFDSIDE_EDGEFUNCTIONCOMPOSER_H
 #define PHASAR_PHASARLLVM_DATAFLOWSOLVER_IFDSIDE_EDGEFUNCTIONCOMPOSER_H
 
-#include "phasar/PhasarLLVM/DataFlowSolver/IfdsIde/EdgeFunctionUtils.h"
-#include "phasar/PhasarLLVM/DataFlowSolver/IfdsIde/EdgeFunctions.h"
+#include "phasar/DataFlow/IfdsIde/EdgeFunctionUtils.h"
+#include "phasar/DataFlow/IfdsIde/EdgeFunctions.h"
 
 #include <memory>
 

include/phasar/PhasarLLVM/DataFlowSolver/IfdsIde/EdgeFunctionUtils.h → include/phasar/DataFlow/IfdsIde/EdgeFunctionUtils.h

@@ -7,12 +7,12 @@
  *     Philipp Schubert, Fabian Schiebel and others
  *****************************************************************************/
 
-#ifndef PHASAR_PHASARLLVM_DATAFLOWSOLVER_IFDSIDE_EDGEFUNCTIONUTILS_H_
-#define PHASAR_PHASARLLVM_DATAFLOWSOLVER_IFDSIDE_EDGEFUNCTIONUTILS_H_
+#ifndef PHASAR_DATAFLOW_IFDSIDE_EDGEFUNCTIONUTILS_H_
+#define PHASAR_DATAFLOW_IFDSIDE_EDGEFUNCTIONUTILS_H_
 
-#include "phasar/PhasarLLVM/DataFlowSolver/IfdsIde/EdgeFunctions.h"
-#include "phasar/PhasarLLVM/DataFlowSolver/IfdsIde/JoinLattice.h"
-#include "phasar/PhasarLLVM/Utils/ByRef.h"
+#include "phasar/DataFlow/IfdsIde/EdgeFunctions.h"
+#include "phasar/Utils/ByRef.h"
+#include "phasar/Utils/JoinLattice.h"
 
 #include <memory>
 

include/phasar/PhasarLLVM/DataFlowSolver/IfdsIde/EdgeFunctions.h → include/phasar/DataFlow/IfdsIde/EdgeFunctions.h

@@ -17,8 +17,8 @@
 #ifndef PHASAR_PHASARLLVM_DATAFLOWSOLVER_IFDSIDE_EDGEFUNCTIONS_H_
 #define PHASAR_PHASARLLVM_DATAFLOWSOLVER_IFDSIDE_EDGEFUNCTIONS_H_
 
-#include "phasar/PhasarLLVM/DataFlowSolver/IfdsIde/JoinLattice.h"
-#include "phasar/PhasarLLVM/Utils/ByRef.h"
+#include "phasar/Utils/ByRef.h"
+#include "phasar/Utils/JoinLattice.h"
 #include "phasar/Utils/TypeTraits.h"
 
 #include "llvm/ADT/ArrayRef.h"

include/phasar/PhasarLLVM/DataFlowSolver/IfdsIde/IDETabulationProblem.h → include/phasar/DataFlow/IfdsIde/IDETabulationProblem.h

@@ -10,15 +10,15 @@
 #ifndef PHASAR_PHASARLLVM_DATAFLOWSOLVER_IFDSIDE_IDETABULATIONPROBLEM_H_
 #define PHASAR_PHASARLLVM_DATAFLOWSOLVER_IFDSIDE_IDETABULATIONPROBLEM_H_
 
+#include "phasar/ControlFlow/ICFGBase.h"
 #include "phasar/DB/ProjectIRDBBase.h"
-#include "phasar/PhasarLLVM/ControlFlow/ICFGBase.h"
-#include "phasar/PhasarLLVM/DataFlowSolver/IfdsIde/EdgeFunctions.h"
-#include "phasar/PhasarLLVM/DataFlowSolver/IfdsIde/FlowFunctions.h"
-#include "phasar/PhasarLLVM/DataFlowSolver/IfdsIde/IFDSIDESolverConfig.h"
-#include "phasar/PhasarLLVM/DataFlowSolver/IfdsIde/InitialSeeds.h"
-#include "phasar/PhasarLLVM/DataFlowSolver/IfdsIde/JoinLattice.h"
-#include "phasar/PhasarLLVM/DataFlowSolver/IfdsIde/Solver/SolverResults.h"
-#include "phasar/PhasarLLVM/Utils/Printer.h"
+#include "phasar/DataFlow/IfdsIde/EdgeFunctions.h"
+#include "phasar/DataFlow/IfdsIde/FlowFunctions.h"
+#include "phasar/DataFlow/IfdsIde/IFDSIDESolverConfig.h"
+#include "phasar/DataFlow/IfdsIde/InitialSeeds.h"
+#include "phasar/DataFlow/IfdsIde/SolverResults.h"
+#include "phasar/Utils/JoinLattice.h"
+#include "phasar/Utils/Printer.h"
 #include "phasar/Utils/Soundness.h"
 
 #include <cassert>
@@ -55,13 +55,11 @@ class IDETabulationProblem : public FlowFunctions<AnalysisDomainTy, Container>,
 
   using ConfigurationTy = HasNoConfigurationType;
 
-  explicit IDETabulationProblem(const db_t *IRDB,
+  explicit IDETabulationProblem(const ProjectIRDBBase<db_t> *IRDB,
                                 std::vector<std::string> EntryPoints,
                                 std::optional<d_t> ZeroValue)
       : IRDB(IRDB), EntryPoints(std::move(EntryPoints)),
         ZeroValue(std::move(ZeroValue)) {
-    static_assert(std::is_base_of_v<ProjectIRDBBase<db_t>, db_t>,
-                  "db_t must implement the ProjectIRDBBase interface!");
     assert(IRDB != nullptr);
   }
 
@@ -128,7 +126,7 @@ class IDETabulationProblem : public FlowFunctions<AnalysisDomainTy, Container>,
     return generateFlow(std::move(FactToGenerate), getZeroValue());
   }
 
-  const db_t *IRDB{};
+  const ProjectIRDBBase<db_t> *IRDB{};
   std::vector<std::string> EntryPoints;
   std::optional<d_t> ZeroValue;
 

include/phasar/PhasarLLVM/DataFlowSolver/IfdsIde/IFDSIDESolverConfig.h → include/phasar/DataFlow/IfdsIde/IFDSIDESolverConfig.h

@@ -42,12 +42,6 @@ enum class SolverConfigOptions : uint32_t {
 struct IFDSIDESolverConfig {
   IFDSIDESolverConfig() noexcept = default;
   IFDSIDESolverConfig(SolverConfigOptions Options) noexcept;
-  ~IFDSIDESolverConfig() = default;
-  IFDSIDESolverConfig(const IFDSIDESolverConfig &) noexcept = default;
-  IFDSIDESolverConfig &
-  operator=(const IFDSIDESolverConfig &) noexcept = default;
-  IFDSIDESolverConfig(IFDSIDESolverConfig &&) noexcept = default;
-  IFDSIDESolverConfig &operator=(IFDSIDESolverConfig &&) noexcept = default;
 
   [[nodiscard]] bool followReturnsPastSeeds() const;
   [[nodiscard]] bool autoAddZero() const;

include/phasar/PhasarLLVM/DataFlowSolver/IfdsIde/IFDSTabulationProblem.h → include/phasar/DataFlow/IfdsIde/IFDSTabulationProblem.h

@@ -10,10 +10,10 @@
 #ifndef PHASAR_PHASARLLVM_DATAFLOWSOLVER_IFDSIDE_IFDSTABULATIONPROBLEM_H
 #define PHASAR_PHASARLLVM_DATAFLOWSOLVER_IFDSIDE_IFDSTABULATIONPROBLEM_H
 
-#include "phasar/PhasarLLVM/DataFlowSolver/IfdsIde/EdgeFunctionUtils.h"
-#include "phasar/PhasarLLVM/DataFlowSolver/IfdsIde/IDETabulationProblem.h"
-#include "phasar/PhasarLLVM/Domain/AnalysisDomain.h"
-#include "phasar/PhasarLLVM/Utils/BinaryDomain.h"
+#include "phasar/DataFlow/IfdsIde/EdgeFunctionUtils.h"
+#include "phasar/DataFlow/IfdsIde/IDETabulationProblem.h"
+#include "phasar/Domain/AnalysisDomain.h"
+#include "phasar/Domain/BinaryDomain.h"
 
 #include <set>
 #include <string>
@@ -40,7 +40,7 @@ class IFDSTabulationProblem
   using typename Base::t_t;
   using typename Base::v_t;
 
-  explicit IFDSTabulationProblem(const db_t *IRDB,
+  explicit IFDSTabulationProblem(const ProjectIRDBBase<db_t> *IRDB,
                                  std::vector<std::string> EntryPoints,
                                  d_t ZeroValue)
       : Base(IRDB, std::move(EntryPoints), std::move(ZeroValue)) {}

include/phasar/PhasarLLVM/DataFlowSolver/IfdsIde/InitialSeeds.h → include/phasar/DataFlow/IfdsIde/InitialSeeds.h

@@ -10,7 +10,7 @@
 #ifndef PHASAR_PHASARLLVM_DATAFLOWSOLVER_IFDSIDE_INITIALSEEDS_H
 #define PHASAR_PHASARLLVM_DATAFLOWSOLVER_IFDSIDE_INITIALSEEDS_H
 
-#include "phasar/PhasarLLVM/Utils/BinaryDomain.h"
+#include "phasar/Domain/BinaryDomain.h"
 #include "phasar/PhasarLLVM/Utils/LLVMShorthands.h"
 
 #include <map>
@@ -72,39 +72,6 @@ template <typename N, typename D, typename L> class InitialSeeds {
   [[nodiscard]] const GeneralizedSeeds &getSeeds() const & { return Seeds; }
   [[nodiscard]] GeneralizedSeeds getSeeds() && { return std::move(Seeds); }
 
-  void dump(llvm::raw_ostream &OS = llvm::errs()) {
-
-    auto printNode = [&](auto &&Node) { // NOLINT
-      if constexpr (std::is_same_v<const llvm::Instruction *, N>) {
-        OS << llvmIRToString(Node);
-      } else {
-        OS << Node;
-      }
-    };
-
-    auto printFact = [&](auto &&Node) { // NOLINT
-      if constexpr (std::is_same_v<const llvm::Value *, D>) {
-        OS << llvmIRToString(Node);
-      } else {
-        OS << Node;
-      }
-    };
-
-    OS << "======================== Initial Seeds ========================\n";
-    for (const auto &[Node, Facts] : Seeds) {
-      OS << "At ";
-      printNode(Node);
-      OS << "\n";
-      for (const auto &[Fact, Value] : Facts) {
-        OS << "> ";
-        printFact(Fact);
-        OS << " --> \\." << Value << "\n";
-      }
-      OS << "\n";
-    }
-    OS << "========================== End Seeds ==========================\n";
-  }
-
 private:
   GeneralizedSeeds Seeds;
 };

include/phasar/PhasarLLVM/DataFlowSolver/IfdsIde/FlowEdgeFunctionCache.h → include/phasar/DataFlow/IfdsIde/Solver/FlowEdgeFunctionCache.h

@@ -10,8 +10,8 @@
 #ifndef PHASAR_PHASARLLVM_DATAFLOWSOLVER_IFDSIDE_FLOWEDGEFUNCTIONCACHE_H_
 #define PHASAR_PHASARLLVM_DATAFLOWSOLVER_IFDSIDE_FLOWEDGEFUNCTIONCACHE_H_
 
-#include "phasar/PhasarLLVM/DataFlowSolver/IfdsIde/EdgeFunctions.h"
-#include "phasar/PhasarLLVM/DataFlowSolver/IfdsIde/IDETabulationProblem.h"
+#include "phasar/DataFlow/IfdsIde/EdgeFunctions.h"
+#include "phasar/DataFlow/IfdsIde/IDETabulationProblem.h"
 #include "phasar/Utils/EquivalenceClassMap.h"
 #include "phasar/Utils/Logger.h"
 #include "phasar/Utils/PAMMMacros.h"
@@ -26,6 +26,10 @@
 #include <type_traits>
 #include <utility>
 
+namespace llvm {
+class Value;
+} // namespace llvm
+
 namespace psr {
 template <typename KeyT> class DefaultMapKeyCompressor {
 public: