Added c++ 20 modules support

CMakeLists.txt

@@ -78,6 +78,8 @@ string(APPEND CMAKE_CXX_FLAGS_RELEASE "")
 
 option(CMAKE_VISIBILITY_INLINES_HIDDEN "Hide inlined functions from the DSO table (default ON)" ON)
 
+option(PHASAR_BUILD_MODULES "Build C++20 modules for phasar" OFF)
+
 include(CheckCXXCompilerFlag)
 
 # Handle memory issues with linking

Config.cmake.in

@@ -16,6 +16,7 @@ set(PHASAR_USE_LLVM_FAT_LIB @USE_LLVM_FAT_LIB@)
 set(PHASAR_BUILD_DYNLIB @PHASAR_BUILD_DYNLIB@)
 set(PHASAR_USE_Z3 @PHASAR_USE_Z3@)
 set(PHASAR_HAS_SQLITE @PHASAR_HAS_SQLITE@)
+set(PHASAR_BUILD_MODULES @PHASAR_BUILD_MODULES@)
 
 if (PHASAR_USE_Z3)
   find_dependency(Z3 REQUIRED)

README.md

@@ -27,6 +27,8 @@ PhASAR requires at least C++-17.
 However, building in C++20 mode is supported. You may enable this setting the cmake variable `CMAKE_CXX_STANDARD` to `20`.
 Although phasar currently does not make use of C++-20 features (except for some `concept`s behind an #ifdef border), your client application that just *uses* phasar as a library may want to use C++20 earlier.
 
+**NEW**: PhASAR supports C++20 modules as an experimental feature.
+
 ## Currently Supported Version of LLVM
 
 PhASAR is currently set up to support LLVM-15.0.*

cmake/phasar_macros.cmake

@@ -241,7 +241,7 @@ endmacro(add_phasar_executable)
 
 function(add_phasar_library name)
   set(PHASAR_LIB_OPTIONS SHARED STATIC MODULE INTERFACE)
-  set(PHASAR_LIB_MULTIVAL LLVM_LINK_COMPONENTS LINKS LINK_PUBLIC LINK_PRIVATE FILES)
+  set(PHASAR_LIB_MULTIVAL LLVM_LINK_COMPONENTS LINKS LINK_PUBLIC LINK_PRIVATE FILES MODULE_FILES)
   cmake_parse_arguments(PHASAR_LIB "${PHASAR_LIB_OPTIONS}" "" "${PHASAR_LIB_MULTIVAL}" ${ARGN})
   set(srcs ${PHASAR_LIB_UNPARSED_ARGUMENTS})
   list(APPEND srcs ${PHASAR_LIB_FILES})
@@ -277,6 +277,28 @@ function(add_phasar_library name)
 
   target_compile_features(${name} PUBLIC cxx_std_17)
 
+  set(install_module)
+  if(PHASAR_LIB_MODULE_FILES)
+    if(PHASAR_BUILD_MODULES)
+      target_sources(${name} PUBLIC
+        FILE_SET cxx_modules
+        TYPE CXX_MODULES
+        FILES ${PHASAR_LIB_MODULE_FILES}
+      )
+
+      target_compile_features(${name} PUBLIC cxx_std_20)
+
+      set(install_module FILE_SET cxx_modules DESTINATION ${CMAKE_INSTALL_LIBDIR})
+    elseif(NOT srcs)
+      # Add dummy src to prevent cmake error
+      set(dummy_src "${CMAKE_CURRENT_BINARY_DIR}/${name}_dummysrc.cpp")
+      if(NOT EXISTS "${dummy_src}")
+        file(WRITE "${dummy_src}" "")
+      endif()
+      target_sources(${name} PRIVATE "${dummy_src}")
+    endif()
+  endif()
+
   if(LLVM_COMMON_DEPENDS)
     add_dependencies(${name} ${LLVM_COMMON_DEPENDS})
   endif(LLVM_COMMON_DEPENDS)
@@ -316,13 +338,15 @@ function(add_phasar_library name)
       EXPORT LLVMExports
       LIBRARY DESTINATION lib
       ARCHIVE DESTINATION lib${LLVM_LIBDIR_SUFFIX}
+      ${install_module}
     )
   else()
     install(TARGETS ${name}
       EXPORT PhasarExports
-
       # NOTE: Library, archive and runtime destination are automatically set by
       # GNUInstallDirs which is included in the top-level CMakeLists.txt
+
+      ${install_module}
     )
   endif()
 

include/phasar/AnalysisStrategy/AnalysisSetup.h

@@ -10,11 +10,10 @@
 #ifndef PHASAR_ANALYSISSTRATEGY_ANALYSISSETUP_H
 #define PHASAR_ANALYSISSTRATEGY_ANALYSISSETUP_H
 
-#include "phasar/PhasarLLVM/ControlFlow/LLVMBasedICFG.h"
-#include "phasar/PhasarLLVM/Pointer/LLVMAliasSet.h"
-#include "phasar/PhasarLLVM/TypeHierarchy/DIBasedTypeHierarchy.h"
-
 namespace psr {
+class LLVMAliasSet;
+class LLVMBasedICFG;
+class DIBasedTypeHierarchy;
 
 /// Indicates that an analysis does not need a special configuration (file).
 struct HasNoConfigurationType {};

include/phasar/ControlFlow/SparseCFGProvider.h

@@ -48,7 +48,7 @@ struct has_getSparseCFG<
 
 template <typename T, typename D>
 // NOLINTNEXTLINE
-static constexpr bool has_getSparseCFG_v = has_getSparseCFG<T, D>::value;
+constexpr bool has_getSparseCFG_v = has_getSparseCFG<T, D>::value;
 } // namespace psr
 
 #endif // PHASAR_CONTROLFLOW_SPARSECFGPROVIDER_H

include/phasar/DataFlow/IfdsIde/Solver/StaticIDESolverConfig.h

@@ -25,16 +25,15 @@ enum class JumpFunctionGCMode {
 
 struct IDESolverConfigBase {
   template <typename K, typename V>
-  static inline constexpr bool
-      IsSimple1d = sizeof(std::pair<K, V>) <= 32 &&
-                   std::is_nothrow_move_constructible_v<K>
-                       &&std::is_nothrow_move_constructible_v<V>
-                           &&has_llvm_dense_map_info<K>;
+  static inline constexpr bool IsSimple1d =
+      sizeof(std::pair<K, V>) <= 32 &&
+      std::is_nothrow_move_constructible_v<K> &&
+      std::is_nothrow_move_constructible_v<V> && has_llvm_dense_map_info<K>;
 
   template <typename T>
-  static inline constexpr bool
-      IsSimpleVal = sizeof(T) <= 32 && std::is_nothrow_move_constructible_v<T>
-                                           &&has_llvm_dense_map_info<T>;
+  static inline constexpr bool IsSimpleVal =
+      sizeof(T) <= 32 && std::is_nothrow_move_constructible_v<T> &&
+      has_llvm_dense_map_info<T>;
 
   template <typename K, typename V>
   using map_t = std::conditional_t<IsSimple1d<K, V>, DenseTable1d<K, V>,

include/phasar/PhasarLLVM/ControlFlow/SparseLLVMBasedICFGView.h

@@ -7,8 +7,8 @@
  *     Fabian Schiebel and others
  *****************************************************************************/
 
-#ifndef PHASAR_PHASARLLVM_CONTROLFLOW_SPARSELLVMBASEDICFG_H
-#define PHASAR_PHASARLLVM_CONTROLFLOW_SPARSELLVMBASEDICFG_H
+#ifndef PHASAR_PHASARLLVM_CONTROLFLOW_SPARSELLVMBASEDICFG_VIEW_H
+#define PHASAR_PHASARLLVM_CONTROLFLOW_SPARSELLVMBASEDICFG_VIEW_H
 
 #include "phasar/ControlFlow/CallGraph.h"
 #include "phasar/ControlFlow/ICFGBase.h"
@@ -75,4 +75,4 @@ class SparseLLVMBasedICFGView
 };
 } // namespace psr
 
-#endif // PHASAR_PHASARLLVM_CONTROLFLOW_SPARSELLVMBASEDICFG_H
+#endif // PHASAR_PHASARLLVM_CONTROLFLOW_SPARSELLVMBASEDICFG_VIEW_H

include/phasar/TypeHierarchy/TypeHierarchy.h

@@ -42,8 +42,8 @@ template <typename T, typename F> class TypeHierarchy {
 };
 
 template <typename T, typename F>
-static inline llvm::raw_ostream &operator<<(llvm::raw_ostream &OS,
-                                            const TypeHierarchy<T, F> &TH) {
+inline llvm::raw_ostream &operator<<(llvm::raw_ostream &OS,
+                                     const TypeHierarchy<T, F> &TH) {
   TH.print(OS);
   return OS;
 }

include/phasar/TypeHierarchy/VFTable.h

@@ -41,8 +41,8 @@ template <typename F> class VFTable {
 };
 
 template <typename T, typename F>
-static inline llvm::raw_ostream &operator<<(llvm::raw_ostream &OS,
-                                            const VFTable<F> &Table) {
+inline llvm::raw_ostream &operator<<(llvm::raw_ostream &OS,
+                                     const VFTable<F> &Table) {
   Table.print(OS);
   return OS;
 }

include/phasar/Utils/TypeTraits.h

@@ -28,7 +28,9 @@
 namespace psr {
 
 #if __cplusplus < 202002L
-template <typename T> struct type_identity { using type = T; };
+template <typename T> struct type_identity {
+  using type = T;
+};
 #else
 template <typename T> using type_identity = std::type_identity<T>;
 #endif
@@ -275,12 +277,12 @@ PSR_CONCEPT has_isInteresting_v = // NOLINT
     detail::has_isInteresting<ProblemTy>::value;
 
 template <typename T>
-static constexpr bool has_llvm_dense_map_info =
+constexpr bool has_llvm_dense_map_info =
     detail::has_llvm_dense_map_info<T>::value;
 template <typename T> using type_identity_t = typename type_identity<T>::type;
 
 template <typename Var, typename T>
-static constexpr size_t variant_idx = detail::variant_idx<Var, T>::value;
+constexpr size_t variant_idx = detail::variant_idx<Var, T>::value;
 
 template <typename Container>
 using ElementType = typename detail::ElementType<Container>::type;

lib/AnalysisStrategy/CMakeLists.txt

@@ -2,5 +2,10 @@ file(GLOB_RECURSE ANALYSIS_STRATEGY_SRC *.h *.cpp)
 
 add_phasar_library(phasar_analysis_strategy
   ${ANALYSIS_STRATEGY_SRC}
-  LLVM_LINK_COMPONENTS Support
+
+  LLVM_LINK_COMPONENTS
+    Support
+
+  MODULE_FILES
+    Strategies.cppm
 )

lib/AnalysisStrategy/Strategies.cppm

@@ -0,0 +1,19 @@
+module;
+
+#include "phasar/AnalysisStrategy.h"
+
+export module phasar.analysisstrategy;
+
+export namespace psr {
+using psr::AnalysisSetup;
+using psr::AnalysisStrategy;
+using psr::DefaultAnalysisSetup;
+using psr::DemandDrivenAnalysis;
+using psr::HasNoConfigurationType;
+using psr::IncrementalUpdateAnalysis;
+using psr::ModuleWiseAnalysis;
+using psr::toAnalysisStrategy;
+using psr::toString;
+using psr::VariationalAnalysis;
+using psr::operator<<;
+} // namespace psr

lib/CMakeLists.txt

@@ -1,11 +1,15 @@
 add_subdirectory(AnalysisStrategy)
+add_subdirectory(Config)
+add_subdirectory(ControlFlow)
+add_subdirectory(DataFlow)
+add_subdirectory(DB)
+add_subdirectory(Domain)
 add_subdirectory(PhasarLLVM)
 add_subdirectory(PhasarPass)
-add_subdirectory(DB)
-add_subdirectory(Config)
-add_subdirectory(Utils)
 add_subdirectory(Pointer)
-add_subdirectory(ControlFlow)
+add_subdirectory(TypeHierarchy)
+add_subdirectory(Utils)
+
 if(BUILD_PHASAR_CLANG)
     if(PHASAR_IN_TREE)
         add_dependencies(phasar_interface intrinsics_gen)
@@ -18,23 +22,34 @@ if(PHASAR_BUILD_DYNLIB)
 endif()
 
 set(PHASAR_LINK_LIBS
-    phasar_utils
-    phasar_passes
+    phasar_analysis_strategy
     phasar_config
-    phasar_pointer
     phasar_controlflow
+    phasar_dataflow
+    phasar_dataflow_ifdside
+    phasar_dataflow_mono
+    phasar_dataflow_pathsensitivity
+    phasar_db
+    phasar_domain
 
-    phasar_llvm_utils
+    phasar_llvm
+    phasar_llvm_controlflow
+    phasar_llvm_ifdside
+    phasar_llvm_mono
+    phasar_llvm_pathsensitivity
+    phasar_llvm_dataflow
     phasar_llvm_db
+    phasar_llvm_domain
     phasar_llvm_pointer
     phasar_llvm_typehierarchy
-    phasar_llvm_controlflow
+    phasar_llvm_utils
 
+    phasar_pass
+    phasar_passes
+    phasar_pointer
     phasar_taintconfig
-    phasar_mono
-    phasar_llvm
-    phasar_llvm_ifdside
-    phasar_analysis_strategy
+    phasar_typehierarchy
+    phasar_utils
 )
 if(BUILD_PHASAR_CLANG)
     list(APPEND PHASAR_LINK_LIBS phasar_clang)

lib/Config/CMakeLists.txt

@@ -2,7 +2,16 @@ file(GLOB_RECURSE CONFIG_SRC *.h *.cpp)
 
 add_phasar_library(phasar_config
   ${CONFIG_SRC}
-  LINKS phasar_utils
-  LINK_PRIVATE ${Boost_LIBRARIES}
-  LLVM_LINK_COMPONENTS Support
+
+  LINKS
+    phasar_utils
+
+  LINK_PRIVATE
+    ${Boost_LIBRARIES}
+
+  LLVM_LINK_COMPONENTS
+    Support
+
+  MODULE_FILES
+    Config.cppm
 )

lib/Config/Config.cppm

@@ -0,0 +1,9 @@
+module;
+
+#include "phasar/Config.h"
+
+export module phasar.config;
+
+export namespace psr {
+using psr::PhasarConfig;
+} // namespace psr

lib/ControlFlow/CMakeLists.txt

@@ -2,8 +2,16 @@ file(GLOB_RECURSE CONTROLFLOW_SRC *.h *.cpp)
 
 add_phasar_library(phasar_controlflow
   ${CONTROLFLOW_SRC}
+
   LINKS
     phasar_utils
-  LLVM_LINK_COMPONENTS Support
-  LINK_PRIVATE nlohmann_json::nlohmann_json
+
+  LLVM_LINK_COMPONENTS
+    Support
+
+  LINK_PRIVATE
+    nlohmann_json::nlohmann_json
+
+  MODULE_FILES
+    ControlFlow.cppm
 )

lib/ControlFlow/ControlFlow.cppm

@@ -0,0 +1,32 @@
+module;
+
+#include "phasar/ControlFlow.h"
+#include "phasar/ControlFlow/SparseCFGBase.h"
+#include "phasar/ControlFlow/SparseCFGProvider.h"
+
+export module phasar.controlflow;
+
+export namespace psr {
+using psr::CallGraph;
+using psr::CallGraphAnalysisType;
+using psr::CallGraphBuilder;
+using psr::CGTraits;
+using psr::toCallGraphAnalysisType;
+using psr::toString;
+using psr::operator<<;
+using psr::CallGraphBase;
+using psr::CallGraphData;
+using psr::CFGBase;
+using psr::CFGTraits;
+using psr::has_getSparseCFG;
+using psr::has_getSparseCFG_v;
+using psr::ICFGBase;
+using psr::is_cfg_v;
+using psr::is_icfg_v;
+using psr::is_sparse_cfg_v;
+using psr::SparseCFGBase;
+using psr::SparseCFGProvider;
+using psr::SpecialMemberFunctionType;
+using psr::toSpecialMemberFunctionType;
+using psr::valueOf;
+} // namespace psr

lib/DB/CMakeLists.txt

@@ -3,8 +3,17 @@ if(SQLite3_FOUND)
 
   add_phasar_library(phasar_db
     ${DB_SRC}
-    LINKS phasar_passes phasar_utils
-    LLVM_LINK_COMPONENTS Support
-    LINK_PRIVATE SQLite::SQLite3
+
+    LINKS phasar_passes
+      phasar_utils
+
+    LLVM_LINK_COMPONENTS
+      Support
+
+    LINK_PRIVATE
+      SQLite::SQLite3
+
+    MODULE_FILES
+      DB.cppm
   )
 endif()