Pointer map (#123)

* Abseil LTS is default btree map
* Use phmap::btree as alternative
* Remove deprecated btree alternative

Author: ahueck

README.md

@@ -333,12 +333,12 @@ $> cmake --build build --target install --parallel
 
 <!--- @formatter:off --->
 
-| Option | Default | Description |
-| --- | :---: | --- |
-| `TYPEART_ABSEIL` | `ON` | Enable usage of btree-backed map of the [Abseil project](https://abseil.io/) instead of `std::map` |
-| `TYPEART_BTREE` | `OFF` | *Deprecated*. Enable usage of a [btree-backed map](https://github.com/ahueck/cpp-btree) (alternative to Abseil) instead of `std::map` |
-| `TYPEART_SOFTCOUNTERS` | `OFF` | Enable runtime tracking of #tracked addrs. / #distinct checks / etc. |
-| `TYPEART_LOG_LEVEL_RT` | `0` | Granularity of runtime logger. 3 is most verbose, 0 is least |
+| Option                 | Default | Description                                                                                                                           |
+|------------------------|:-------:|---------------------------------------------------------------------------------------------------------------------------------------|
+| `TYPEART_PHMAP`        |  `ON`   | Enable usage of a [btree-backed map](https://github.com/greg7mdp/parallel-hashmap) instead of `std::map` for storing allocation data. |
+| `TYPEART_ABSEIL`       |  `OFF`  | Enable usage of btree-backed map of the [Abseil project](https://abseil.io/) (alternative to TYPEART_PHMAP).                          |
+| `TYPEART_SOFTCOUNTERS` |  `OFF`  | Enable runtime tracking of #tracked addrs. / #distinct checks / etc.                                                                  |
+| `TYPEART_LOG_LEVEL_RT` |   `0`   | Granularity of runtime logger. 3 is most verbose, 0 is least.                                                                         |
 
 <!--- @formatter:on --->
 

cmake/typeartToolchainOptions.cmake

@@ -74,13 +74,13 @@ add_feature_info(UBSAN TYPEART_UBSAN "Build with sanitizer \"ubsan=undefined\"."
 option(TYPEART_MPI_WRAPPER "Generate mpicc and mpic++ wrapper for TypeART" ON)
 add_feature_info(MPI_WRAPPER TYPEART_MPI_WRAPPER "Generate TypeART compiler wrapper for mpicc and mpic++.")
 
-option(TYPEART_ABSEIL "Enable usage of abseil's btree-backed map instead of std::map for the runtime." ON)
+option(TYPEART_ABSEIL "Enable usage of Abseil's btree-backed map instead of std::map for the runtime." ON)
 add_feature_info(ABSEIL TYPEART_ABSEIL "External library \"Abseil\" replaces runtime std::map with btree-backed map.")
 
-cmake_dependent_option(TYPEART_BTREE "Enable usage of btree-backed map instead of std::map for the runtime." ON
+cmake_dependent_option(TYPEART_PHMAP "Enable usage of project \"phmap\" btree-backed map for the runtime." ON
   "NOT TYPEART_ABSEIL" OFF
 )
-add_feature_info(BTREE TYPEART_BTREE "*Deprecated* External library replaces runtime std::map with btree-backed map.")
+add_feature_info(PHMAP TYPEART_PHMAP "External library \"parallel-hashmap\" replaces runtime std::map with btree-backed map.")
 
 option(TYPEART_INSTALL_UTIL_SCRIPTS "Install single file build and run scripts" OFF)
 mark_as_advanced(TYPEART_INSTALL_UTIL_SCRIPTS)

externals/CMakeLists.txt

@@ -8,8 +8,9 @@ mark_as_advanced(
   FETCHCONTENT_UPDATES_DISCONNECTED
 )
 
-if(TYPEART_BTREE)
-  add_subdirectory(btree)
+if(TYPEART_PHMAP)
+  #set(CMAKE_POLICY_DEFAULT_CMP0076 NEW)
+  add_subdirectory(phmap)
 endif()
 
 if(TYPEART_ABSEIL)

externals/abseil/CMakeLists.txt

@@ -3,6 +3,7 @@ set(ABSL_PROPAGATE_CXX_STD ON)
 FetchContent_Declare(
   cpp-abseil
   GIT_REPOSITORY https://github.com/abseil/abseil-cpp.git
+  GIT_TAG 215105818dfde3174fe799600bb0f3cae233d0bf # LTS Nov. 2021
   GIT_SHALLOW 1
 )
 

externals/btree/CMakeLists.txt

@@ -0,0 +1,21 @@
+FetchContent_Declare(
+  phmap_phmap
+  GIT_REPOSITORY https://github.com/greg7mdp/parallel-hashmap.git
+  GIT_SHALLOW 1
+  GIT_TAG 48e86db1f4ebc85145d384ba061c4f615cb3106f
+)
+
+FetchContent_GetProperties(phmap_phmap)
+
+if(NOT phmap_phmap_POPULATED)
+  FetchContent_Populate(phmap_phmap)
+
+  add_library(phmap_phmap INTERFACE IMPORTED GLOBAL)
+  target_include_directories(phmap_phmap SYSTEM INTERFACE ${phmap_phmap_SOURCE_DIR})
+  add_library(phpmap::phpmap ALIAS phmap_phmap)
+endif()
+
+mark_as_advanced(
+  FETCHCONTENT_SOURCE_DIR_PHMAP_PHMAP
+  FETCHCONTENT_UPDATES_DISCONNECTED_PHMAP_PHMAP
+)

externals/phmap/CMakeLists.txt

@@ -46,7 +46,7 @@ target_link_libraries(
           LLVMCore
           LLVMSupport
           $<$<BOOL:${TYPEART_MPI_LOGGER}>:MPI::MPI_CXX>
-          $<$<BOOL:${TYPEART_BTREE}>:google::btree>
+          $<$<BOOL:${TYPEART_PHMAP}>:phpmap::phpmap>
           $<$<BOOL:${TYPEART_ABSEIL}>:absl::btree>
           $<$<BOOL:${TYPEART_SAFEPTR}>:sf::pointer>
           $<$<NOT:$<BOOL:${TYPEART_DISABLE_THREAD_SAFETY}>>:Threads::Threads>
@@ -68,7 +68,7 @@ target_compile_definitions(
   PRIVATE TYPEART_LOG_LEVEL=${TYPEART_LOG_LEVEL_RT}
           $<$<BOOL:${TYPEART_MPI_LOGGER}>:TYPEART_MPI_LOGGER=1>
           $<$<BOOL:${TYPEART_SOFTCOUNTERS}>:ENABLE_SOFTCOUNTER=1>
-          $<$<BOOL:${TYPEART_BTREE}>:TYPEART_BTREE>
+          $<$<BOOL:${TYPEART_PHMAP}>:TYPEART_PHMAP>
           $<$<BOOL:${TYPEART_ABSEIL}>:TYPEART_ABSEIL>
           $<$<BOOL:${TYPEART_SAFEPTR}>:USE_SAFEPTR>
           $<$<BOOL:${TYPEART_DISABLE_THREAD_SAFETY}>:TYPEART_DISABLE_THREAD_SAFETY>

lib/runtime/CMakeLists.txt

@@ -14,23 +14,27 @@
 #define TYPEART_RUNTIMEDATA_H
 
 #ifdef TYPEART_BTREE
-#ifdef TYPEART_ABSEIL
-#error TypeART-RT: Set BTREE and ABSL, mutually exclusive.
-#endif
-#include "btree_map.h"
+#error TypeART-RT: TYPART_BTREE is deprecated.
 #endif
 
 #ifdef TYPEART_ABSEIL
-#ifdef TYPEART_BTREE
-#error TypeART-RT: Set ABSL and BTREE, mutually exclusive.
+#ifdef TYPEART_PHMAP
+#error TypeART-RT: Set ABSL and PHMAP, mutually exclusive.
 #endif
 #pragma GCC diagnostic push
 #pragma GCC diagnostic ignored "-Wpedantic"
 #include "absl/container/btree_map.h"
 #pragma GCC diagnostic pop
 #endif
 
-#if !defined(TYPEART_BTREE) && !defined(TYPEART_ABSEIL)
+#ifdef TYPEART_PHMAP
+#ifdef TYPEART_ABSEIL
+#error TypeART-RT: Set ABSL and PHMAP, mutually exclusive.
+#endif
+#include "parallel_hashmap/btree.h"
+#endif
+
+#if !defined(TYPEART_PHMAP) && !defined(TYPEART_ABSEIL)
 #include <map>
 #endif
 
@@ -58,15 +62,15 @@ struct RuntimeT {
   using Stack = std::vector<MemAddr>;
   static constexpr auto StackReserve{512U};
   static constexpr char StackName[] = "std::vector";
-#ifdef TYPEART_BTREE
-  using PointerMapBaseT           = btree::btree_map<MemAddr, PointerInfo>;
-  static constexpr char MapName[] = "btree::btree_map";
+#ifdef TYPEART_PHMAP
+  using PointerMapBaseT           = phmap::btree_map<MemAddr, PointerInfo>;
+  static constexpr char MapName[] = "phmap::btree_map";
 #endif
 #ifdef TYPEART_ABSEIL
   using PointerMapBaseT           = absl::btree_map<MemAddr, PointerInfo>;
   static constexpr char MapName[] = "absl::btree_map";
 #endif
-#if !defined(TYPEART_BTREE) && !defined(TYPEART_ABSEIL)
+#if !defined(TYPEART_PHMAP) && !defined(TYPEART_ABSEIL)
   using PointerMapBaseT           = std::map<MemAddr, PointerInfo>;
   static constexpr char MapName[] = "std::map";
 #endif