Rework Folder Structure (#574)

* Move generic stuff out of PhasarLLVM + add separate libraries for phasar_* and phasar_llvm_*

* Move Mono

* Remove unnecessary stuff + minor

* Make demangling more precise

* Rename phasar_phasarllvm_utils to phasar_llvm_utils + rename phasar-llvm to phasar-cli

* pre-commit

* Changes according to review + get rid of LLVMShorthands in InitialSeeds

* update BreakingChanges.md

* Fixes linking issues

* Update breakingChanges.md with linker-related changes

---------

Co-authored-by: Florian Sattler <vuld3r@gmail.com>

Author: fabianbs96

.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
 

BreakingChanges.md

@@ -2,7 +2,21 @@
 
 ## development HEAD
 
-- `LLVMPointsTo*` has been renamed to `LLVMAlias*`
+- Renamed `phasar/PhasarLLVM/DataFlowSolver/` to either `phasar/DataFlow/` or `phasar/PhasarLLVM/DataFlow/` depending on whether the components need LLVMCore. Analoguous changes in `lib/` and `unittests/`.
+    An incomplete list of moved/renamed files:
+    - `phasar/PhasarLLVM/DataFlowSolver/IfdsIde/Solver/*` => `phasar/DataFlow/IfdsIde/Solver/*`
+    - `phasar/PhasarLLVM/DataFlowSolver/IfdsIde/IDETabulationProblem.h` => `phasar/DataFlow/IfdsIde/IDETabulationProblem.h`
+    - `phasar/DB/LLVMProjectIRDB.h` => `phasar/PhasarLLVM/DB/LLVMProjectIRDB.h`
+    - ...
+- Renamed and split up some libraries:
+    - `phasar_phasarllvm_utils` => `phasar_llvm_utils`
+    - `phasar_typehierarchy` => `phasar_llvm_typehierarchy`
+    - `phasar_ifdside` => `phasar_llvm_ifdside`
+    - `phasar_controlflow` has its LLVM dependent stuff moved to `phasar_llvm_controlflow`
+    - `phasar_db` has its LLVM dependent stuff moved to `phasar_llvm_db`
+    - `phasar_pointer` has its LLVM dependent stuff moved to `phasar_llvm_pointer`
+- Renamed the phasar tool `phasar-llvm` to `phasar-cli`
+- `LLVMPointsTo[.*]` has been renamed to `LLVMAlias[.*]`
 - The ctor of `LLVMAliasSet` now takes the `LLVMProjectIRDB` as pointer instead of a reference to better document that it may capture the IRDB by reference.
 - The `PointsToInfo` interface has been replaced by the CRTP interface `AliasInfoBase`. Introduced two type-erased implementation of that interface: `AliasInfo` and `AliasInfoRef`. In most cases you should replace `PointsToInfo*` and `LLVMPointsToInfo*` by `AliasInfoRef`, bzw. `LLVMAliasInfoRef`.
 - Introduced a new interface `PointsToInfoBase` and type-erased implementations `PointstoInfo` and `PointsToInfoRef`. Don't confuse them with the old `PointsToInfo`!!! (However, they have different APIs, so you should encounter compilation errors then)

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";