cmake full build and VS 19 (#71)

Author: tzaeschke

.bazelignore

@@ -0,0 +1,4 @@
+#ignore typical cmake build folders
+build
+out
+cmake-build-debug

.github/workflows/cmake-windows.yml

@@ -19,7 +19,7 @@ jobs:
 
     - name: Configure CMake
       working-directory: ${{github.workspace}}\out
-      run: cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=$BUILD_TYPE -S ${{github.workspace}} -B ${{github.workspace}}\out
+      run: cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=$BUILD_TYPE -S ${{github.workspace}} -B ${{github.workspace}}\out -DPHTREE_BUILD_EXAMPLES=ON -DPHTREE_BUILD_TESTS=ON
 
     - name: Build
       working-directory: ${{github.workspace}}\out
@@ -30,5 +30,4 @@ jobs:
       working-directory: ${{github.workspace}}\out
       # Execute tests defined by the CMake configuration.
       # See https://cmake.org/cmake/help/latest/manual/ctest.1.html for more detail
-      # TODO Currently tests are run via bazel only.
       run: ctest -C ${env:BUILD_TYPE}

.github/workflows/cmake.yml

@@ -23,7 +23,7 @@ jobs:
       # Note the current convention is to use the -S and -B options here to specify source 
       # and build directories, but this is only available with CMake 3.13 and higher.  
       # The CMake binaries on the Github Actions machines are (as of this writing) 3.12
-      run: cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=$BUILD_TYPE
+      run: cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=$BUILD_TYPE -DPHTREE_BUILD_ALL=ON
 
     - name: Build
       working-directory: ${{github.workspace}}/build
@@ -38,3 +38,8 @@ jobs:
       # See https://cmake.org/cmake/help/latest/manual/ctest.1.html for more detail
       # TODO Currently tests are run via bazel only.
       run: ctest -C $BUILD_TYPE
+
+    - name: Example
+      working-directory: ${{github.workspace}}/build
+      shell: bash
+      run: examples/Example

.gitignore

@@ -10,5 +10,7 @@ bazel-*
 compile_commands.json
 perf.data*
 build
+out
+CMakeSettings.json
 
 /cmake-build-debug/

CHANGELOG.md

@@ -40,6 +40,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
   and function signatures than normal `PhTree` filters. [#26](https://github.com/tzaeschke/phtree-cpp/issues/26)
 
 ### Fixed
+- Fixed cmake to work with Visual Studio 2019. Added tests and benchmarks to cmake.
+  (benchmarks still do not work with VS at the moment).
+  [#62](https://github.com/tzaeschke/phtree-cpp/issues/62)
 - Fixed two compilation problems and a memory leak when compiling with Visual Studio 2019.
   (also added `msan` support). [#64](https://github.com/tzaeschke/phtree-cpp/pull/64)
 

CMakeLists.txt

@@ -1,24 +1,110 @@
 cmake_minimum_required(VERSION 3.14)
 
 # set the project name
-project(PH_Tree_Main VERSION 1.2.0
+project(phtree VERSION 1.2.0
         DESCRIPTION "PH-Tree C++"
         LANGUAGES CXX)
 
-if(NOT CMAKE_BUILD_TYPE)
-    set(CMAKE_BUILD_TYPE Release)
-endif()
+# ---------------------------------------------------------------------------------------
+# Set default build to release
+# ---------------------------------------------------------------------------------------
+if (NOT CMAKE_BUILD_TYPE)
+    set(CMAKE_BUILD_TYPE "Release" CACHE STRING "Choose Release or Debug" FORCE)
+endif ()
+
+# ---------------------------------------------------------------------------------------
+# Build options
+# ---------------------------------------------------------------------------------------
+# example options
+option(PHTREE_BUILD_ALL "Build examples, tests and benchmarks" OFF)
+
+# example options
+option(PHTREE_BUILD_EXAMPLES "Build examples" OFF)
+#option(PHTREE_BUILD_EXAMPLE_HO "Build header only example" OFF)
+
+# testing options
+option(PHTREE_BUILD_TESTS "Build tests" OFF)
+#option(PHTREE_BUILD_TESTS_HO "Build tests using the header only version" OFF)
+
+# bench options
+option(PHTREE_BUILD_BENCHMARKS "Build benchmarks (Requires https://github.com/google/benchmark.git to be installed)" OFF)
+
+# ---------------------------------------------------------------------------------------
+# Compiler config
+# ---------------------------------------------------------------------------------------
+find_program(CCACHE_FOUND ccache)
+if(CCACHE_FOUND)
+    message("CCACHE is found")
+    set_property(GLOBAL PROPERTY RULE_LAUNCH_COMPILE ccache)
+    set_property(GLOBAL PROPERTY RULE_LAUNCH_LINK ccache)
+else(CCACHE_FOUND)
+    message("CCACHE is NOT found")
+endif(CCACHE_FOUND)
 
 # specify the C++ standard
-set(CMAKE_CXX_STANDARD 17)
-set(CMAKE_CXX_STANDARD_REQUIRED True)
-if(WIN32)
-    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /std:c++17 /Wall")
+if (NOT CMAKE_CXX_STANDARD)
+    set(CMAKE_CXX_STANDARD 17)
+    set(CMAKE_CXX_STANDARD_REQUIRED ON)
+endif ()
+
+if (MSVC)
+    #set(CMAKE_CXX_FLAGS_RELEASE "/MT")
+    #set(CMAKE_CXX_FLAGS_DEBUG "/MTd")
+    #set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /std:c++17 /Wall")
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /std:c++17")
     set(CMAKE_CXX_FLAGS_RELEASE "/O2")
-else()
+
+    #    set(CMAKE_CXX_FLAGS "-DNOMINMAX ${CMAKE_CXX_FLAGS}") # exclude M$ min/max macros
+    #    set(CMAKE_CXX_FLAGS "/wd4996 ${CMAKE_CXX_FLAGS}") # don't warn about use of plain C functions without (non-portable) "_s" suffix
+    #    set(CMAKE_EXE_LINKER_FLAGS "/WX:NO ${CMAKE_EXE_LINKER_FLAGS}" ) # don't treat warnings as compile errors--gtest doesn't build
+    #    #set(CMAKE_CXX_FLAGS_DEBUG "/analyze ${CMAKE_CXX_FLAGS_DEBUG}")
+else ()
     set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++17 -Wall -Werror")
-    set(CMAKE_CXX_FLAGS_RELEASE "-O3")
-endif()
+    if (PHTREE_BUILD_BENCHMARKS)
+        set(CMAKE_CXX_FLAGS_RELEASE "-O3 -mavx -pthread")
+    else ()
+        set(CMAKE_CXX_FLAGS_RELEASE "-O3 -mavx")
+    endif ()
+endif ()
 
+# ---------------------------------------------------------------------------------------
+# Build binaries
+# ---------------------------------------------------------------------------------------
 add_subdirectory(phtree)
-add_subdirectory(examples)
+
+if (PHTREE_BUILD_EXAMPLES OR PHTREE_BUILD_ALL)
+    message(STATUS "Generating examples")
+    add_subdirectory(examples)
+endif ()
+
+if (PHTREE_BUILD_BENCHMARKS OR PHTREE_BUILD_ALL)
+    message(STATUS "Generating benchmarks")
+    add_subdirectory(benchmark)
+endif ()
+
+if (PHTREE_BUILD_TESTS OR PHTREE_BUILD_ALL)
+    message(STATUS "Generating tests")
+    if (FALSE)
+        add_compile_definitions(GTEST_HAS_ABSL=0)
+        add_compile_definitions(GTEST_OS_WINDOWS_MOBILE=0)
+        if (MSVC)
+            add_compile_definitions(GTEST_OS_WINDOWS_MINGW=0)
+        endif ()
+        add_compile_definitions(GTEST_OS_LINUX_ANDROID=0)
+        if (LINUX)
+            add_compile_definitions(GTEST_OS_LINUX=1)
+        else ()
+            add_compile_definitions(GTEST_OS_LINUX=0)
+        endif ()
+        add_compile_definitions(
+                GTEST_OS_WINDOWS_MOBILE=0
+                GTEST_OS_WINDOWS_PHONE=0
+                GTEST_OS_WINDOWS_RT=0
+                GTEST_OS_ESP8266=0
+                GTEST_OS_XTENSA=0)
+    endif ()
+
+    enable_testing()
+    include(GoogleTest)
+    add_subdirectory(test)
+endif ()

README.md

@@ -538,67 +538,72 @@ There are numerous ways to improve performance. The following list gives an over
 
 ## Compiling the PH-Tree
 
-This section will guide you through the initial build system and IDE you need to go through in order to build and run
-custom versions of the PH-Tree on your machine.
+The PH-Tree index itself is a *header only* library, it can be used by simply copying all headers in the `phtree` 
+folder. 
+The examples, tests and benchmarks can be build with bazel or cmake.  
 
 <a id="build-system-and-dependencies"></a>
 
 ### Build system & dependencies
 
-PH-Tree can be built with *cmake 3.14* or [Bazel](https://bazel.build) as build system. All code is written in C++
-targeting the C++17 standard. The code has been verified to compile on Linux with Clang 9, 10, 11, 12, and GCC 9, 10,
-11, and on Windows with Visual Studio 2019.
-
-#### Ubuntu Linux
-
-* Installing [clang](https://apt.llvm.org/)
-
-* Installing [bazel](https://docs.bazel.build/versions/main/install-ubuntu.html)
-
-* To install [cmake](https://launchpad.net/~hnakamur/+archive/ubuntu/cmake):
-
+PH-Tree can be built with [Bazel](https://bazel.build) (primary build system) or with 
+[cmake](https://cmake.org/) *3.14*. 
+All code is written in C++ targeting the C++17 standard. 
+The code has been verified to compile on Linux with Clang 11 and GCC 9, and on Windows with Visual Studio 2019
+(except benchmarks, which don't work wi VS).
+The PH-tree makes use of vectorization, so suggested compilation options for clang/gcc are:
 ```
-sudo add-apt-repository ppa:hnakamur/libarchive
-sudo add-apt-repository ppa:hnakamur/libzstd
-sudo add-apt-repository ppa:hnakamur/cmake
-sudo apt update
-sudo apt install cmake
+-O3 -mavx
 ```
 
-#### Windows
-
-To build on Windows, you'll need to have a version of Visual Studio 2019 installed (likely Professional), in addition to
-[Bazel](https://docs.bazel.build/versions/master/windows.html) or
-[cmake](https://cmake.org/download/).
 
 <a id="bazel"></a>
 
 ### Bazel
 
 Once you have set up your dependencies, you should be able to build the PH-Tree repository by running:
-
 ```
 bazel build ...
 ```
 
 Similarly, you can run all unit tests with:
-
 ```
 bazel test ...
 ```
 
+Benchmarks:
+```
+bazel run //benchmark:update_mm_d_benchmark --config=benchmark  -- --benchmark_counters_tabular=true
+```
+
+
 <a id="cmake"></a>
 
 ### cmake
-
+`cmake` uses `ccache` when available.
 ```
 mkdir build
 cd build
 cmake ..
 cmake --build .
+```
+
+Run example:
+```
+cmake .. -DPHTREE_BUILD_EXAMPLES=ON
+cmake --build .
 ./example/Example
 ```
 
+Run tests:
+```
+cmake .. -DPHTREE_BUILD_TESTS=ON
+cmake --build .
+ctest
+```
+Next to example (`PHTREE_BUILD_EXAMPLES`) there are also tests (`PHTREE_BUILD_TESTS`) and 
+benchmarks (`PHTREE_BUILD_BENCHMARKS`). To build all, use `PHTREE_BUILD_ALL`.
+
 ## Further Resources
 
 <a id="theory"></a>

benchmark/BUILD

@@ -3,9 +3,6 @@ package(default_visibility = ["//visibility:private"])
 cc_library(
     name = "benchmark",
     testonly = True,
-    srcs = [
-        "logging.cc",
-    ],
     hdrs = [
         "benchmark_util.h",
         "logging.h",

benchmark/CMakeLists.txt

@@ -0,0 +1,57 @@
+cmake_minimum_required(VERSION 3.14)
+project(phtree-benchmarks)
+
+set(BENCHMARK_ENABLE_TESTING OFF)
+
+include(FetchContent)
+
+FetchContent_Declare(
+        googlebenchmark
+        GIT_REPOSITORY https://github.com/google/benchmark.git
+        GIT_TAG v1.7.0
+)
+FetchContent_MakeAvailable(googlebenchmark)
+
+FetchContent_Declare(
+        spdlog
+        GIT_REPOSITORY https://github.com/gabime/spdlog.git
+        GIT_TAG v1.10.0
+)
+FetchContent_MakeAvailable(spdlog)
+
+set(INCLUDE_DIR ${CMAKE_SOURCE_DIR}/phtree)
+set(INCLUDE_FILES ${INCLUDE_DIR}/phtree.h ${INCLUDE_DIR}/phtree_multimap.h benchmark_util.h logging.h)
+
+macro(package_add_benchmark TESTNAME)
+    add_executable(${TESTNAME} ${ARGN} ${INCLUDE_FILES})
+    target_link_libraries(${TESTNAME} PRIVATE benchmark::benchmark)
+    target_link_libraries(${TESTNAME} PRIVATE spdlog::spdlog)
+    target_include_directories(${TESTNAME} PRIVATE ${PROJECT_SOURCE_DIR}/..)
+endmacro()
+
+add_compile_definitions(RUN_HAVE_STD_REGEX=0 RUN_HAVE_POSIX_REGEX=0 COMPILE_HAVE_GNU_POSIX_REGEX=0)
+
+package_add_benchmark(count_mm_d_benchmark count_mm_d_benchmark.cc)
+package_add_benchmark(erase_benchmark erase_benchmark.cc)
+package_add_benchmark(erase_d_benchmark erase_d_benchmark.cc)
+package_add_benchmark(extent_benchmark extent_benchmark.cc)
+package_add_benchmark(extent_benchmark_weird extent_benchmark_weird.cc)
+package_add_benchmark(find_benchmark find_benchmark.cc)
+package_add_benchmark(hd_erase_d_benchmark hd_erase_d_benchmark.cc)
+package_add_benchmark(hd_insert_d_benchmark hd_insert_d_benchmark.cc)
+package_add_benchmark(hd_knn_d_benchmark hd_knn_d_benchmark.cc)
+package_add_benchmark(hd_query_d_benchmark hd_query_d_benchmark.cc)
+package_add_benchmark(insert_benchmark insert_benchmark.cc)
+package_add_benchmark(insert_box_d_benchmark insert_box_d_benchmark.cc)
+package_add_benchmark(insert_d_benchmark insert_d_benchmark.cc)
+package_add_benchmark(knn_d_benchmark knn_d_benchmark.cc)
+package_add_benchmark(query_benchmark query_benchmark.cc)
+package_add_benchmark(query_box_d_benchmark query_box_d_benchmark.cc)
+package_add_benchmark(query_d_benchmark query_d_benchmark.cc)
+package_add_benchmark(query_mm_box_d_benchmark query_mm_box_d_benchmark.cc)
+package_add_benchmark(query_mm_d_benchmark query_mm_d_benchmark.cc)
+package_add_benchmark(query_mm_d_filter_benchmark query_mm_d_filter_benchmark.cc)
+package_add_benchmark(update_box_d_benchmark update_box_d_benchmark.cc)
+package_add_benchmark(update_d_benchmark update_d_benchmark.cc)
+package_add_benchmark(update_mm_box_d_benchmark update_mm_box_d_benchmark.cc)
+package_add_benchmark(update_mm_d_benchmark update_mm_d_benchmark.cc)