third_party dependencies (#523)

* use system gtest if possible * optional tracy support * fix meshid not found situation * try fix CI * fix ubuntu build * disable windows tbb build first * update tbb config * format * fix cmake BUILD_SHARED_LIBS we should make the library type implicit, so users can decide whether or not to build shared libraries. * revert public.h changes * remove version requirement for gtest * update tracy instructions no need to use sudo, and we need some debug flags for good stack capture * fix js build
2023-08-08 01:12:59 +08:00
parent 15399474fa
commit a7eac92087
16 changed files with 174 additions and 79 deletions
@@ -25,7 +25,7 @@ jobs:
    - name: Install dependencies
      run: |
        apt-get -y update
-        DEBIAN_FRONTEND=noninteractive apt install -y libomp-dev libassimp-dev git libtbb-dev pkg-config libpython3-dev python3 python3-distutils python3-pip lcov
+        DEBIAN_FRONTEND=noninteractive apt install -y libgtest-dev libomp-dev libassimp-dev git libtbb-dev pkg-config libpython3-dev python3 python3-distutils python3-pip lcov
        pip install trimesh
    - uses: actions/checkout@v3
      with:
@@ -80,7 +80,7 @@ jobs:
    - name: Install dependencies
      run: |
        apt-get -y update
-        DEBIAN_FRONTEND=noninteractive apt install -y libomp-dev libassimp-dev git libtbb-dev pkg-config libpython3-dev python3 python3-distutils python3-pip
+        DEBIAN_FRONTEND=noninteractive apt install -y libgtest-dev libomp-dev libassimp-dev git libtbb-dev pkg-config libpython3-dev python3 python3-distutils python3-pip
    - uses: actions/checkout@v3
      with:
        submodules: recursive
@@ -144,7 +144,7 @@ jobs:
    timeout-minutes: 30
    strategy:
      matrix:
-        parallel_backend: [NONE]
+        parallel_backend: [NONE, TBB]
        cuda_support: [OFF]
      max-parallel: 1
    runs-on: windows-2019
@@ -194,7 +194,7 @@ jobs:
    steps:
    - name: Install common dependencies
      run: |
-        brew install pkg-config assimp
+        brew install pkg-config googletest assimp
        pip install trimesh
    - name: Install OpenMP
      if: matrix.parallel_backend == 'OMP'
@@ -24,16 +24,30 @@ option(MANIFOLD_DEBUG "Enable debug tracing/timing" OFF)
 option(MANIFOLD_USE_CUDA "Enable GPU support via CUDA" OFF)
 option(MANIFOLD_PYBIND "Build python bindings" ON)
 option(MANIFOLD_CBIND "Build C (FFI) bindings" OFF)
+option(TRACY_ENABLE "Use tracy profiling" OFF) 
+
+if(TRACY_ENABLE)
+  option(CMAKE_BUILD_TYPE "Build type" RelWithDebInfo)
+  if(NOT MSVC)
+  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fno-omit-frame-pointer")
+  endif()
+else()
+  option(CMAKE_BUILD_TYPE "Build type" Release)
+endif()
+
 set(MANIFOLD_PAR "NONE" CACHE STRING "Parallel backend, either \"TBB\" or \"OpenMP\" or \"NONE\"")
 set(MANIFOLD_FLAGS -O3)

 if(EMSCRIPTEN)
  message("Building for Emscripten")
-  set(MANIFOLD_FLAGS -fwasm-exceptions -D_LIBCUDACXX_HAS_THREAD_API_EXTERNAL -D_LIBCUDACXX_HAS_THREAD_API_CUDA)
-  set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -sALLOW_MEMORY_GROWTH=1 -fwasm-exceptions")
+  set(MANIFOLD_FLAGS -fexceptions -D_LIBCUDACXX_HAS_THREAD_API_EXTERNAL -D_LIBCUDACXX_HAS_THREAD_API_CUDA)
+  set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -sALLOW_MEMORY_GROWTH=1 -fexceptions -sDISABLE_EXCEPTION_CATCHING=0")
+  set(MANIFOLD_PYBIND OFF)
 endif()

-option(PYBIND11_FINDPYTHON "Enable PyBind to perform FindPython for you" ON)
+if(MANIFOLD_PYBIND)
+find_package(Python COMPONENTS Interpreter Development.Module REQUIRED)
+endif()

 option(BUILD_TEST_CGAL "Build CGAL performance comparisons" OFF)

@@ -41,13 +55,6 @@ option(BUILD_SHARED_LIBS "Build dynamic/shared libraries" OFF)
 set(PYBIND11_DIR ${PROJECT_SOURCE_DIR}/bindings/python/third_party/pybind11)
 set(THRUST_INC_DIR ${PROJECT_SOURCE_DIR}/src/third_party/thrust)

-if(BUILD_SHARED_LIBS OR MANIFOLD_CBIND)
-  # Allow shared libraries to be relocatable (add Place Independent Code flag).
-  # Also include when statically linking C bindings to avoid issues with bundling
-  # artefacts in host languages using them for FFI.
-  add_compile_options(-fPIC)
-endif()
-
 if(MANIFOLD_USE_CUDA)
  enable_language(CUDA)
  find_package(CUDA REQUIRED)
@@ -65,14 +72,16 @@ endif()

 if(NOT MSVC)
  set(WARNING_FLAGS -Werror -Wall -Wno-sign-compare -Wno-unused)
-  add_compile_options(
+  set(MANIFOLD_FLAGS
+    "${MANIFOLD_FLAGS}"
    "$<$<COMPILE_LANGUAGE:CXX>:${WARNING_FLAGS}>"
    "$<$<COMPILE_LANGUAGE:CUDA>:-Xcompiler=${WARNING_FLAGS}>")
 endif()

 if(CODE_COVERAGE AND NOT MSVC)
  set(COVERAGE_FLAGS -coverage -fno-inline-small-functions -fkeep-inline-functions -fkeep-static-functions)
-  add_compile_options(
+  set(MANIFOLD_FLAGS
+    "${MANIFOLD_FLAGS}"
    "$<$<COMPILE_LANGUAGE:CXX>:${COVERAGE_FLAGS}>"
    "$<$<COMPILE_LANGUAGE:CUDA>:-Xcompiler=-coverage>")
  add_link_options("-coverage")
@@ -122,6 +122,11 @@ For more detailed documentation, please refer to the C++ API.

 Contributions are welcome! A lower barrier contribution is to simply make a PR that adds a test, especially if it repros an issue you've found. Simply name it prepended with DISABLED_, so that it passes the CI. That will be a very strong signal to me to fix your issue. However, if you know how to fix it yourself, then including the fix in your PR would be much appreciated!

+## Profiling
+
+There is now basic support for the [Tracy profiler](https://github.com/wolfpld/tracy) for our tests.
+To enable tracing, compile with `-DTRACY_ENABLE=on` cmake option, and run the test with Tracy server running.
+
 ## About the author

 This library was started by [Emmett Lalish](https://elalish.blogspot.com/). I am currently a Google employee and this is my 20% project, not an official Google project. At my day job I'm the maintainer of [\<model-viewer\>](https://modelviewer.dev/). I was the first employee at a 3D video startup, [Omnivor](https://www.omnivor.io/), and before that I worked on 3D printing at Microsoft, including [3D Builder](https://www.microsoft.com/en-us/p/3d-builder/9wzdncrfj3t6?activetab=pivot%3Aoverviewtab). Originally an aerospace engineer, I started at a small DARPA contractor doing seedling projects, one of which became [Sea Hunter](https://en.wikipedia.org/wiki/Sea_Hunter). I earned my doctorate from the University of Washington in control theory and published some [papers](https://www.researchgate.net/scientific-contributions/75011026_Emmett_Lalish).
@@ -1,12 +1,15 @@
 {
  "nodes": {
    "flake-utils": {
+      "inputs": {
+        "systems": "systems"
+      },
      "locked": {
-        "lastModified": 1649676176,
-        "narHash": "sha256-OWKJratjt2RW151VUlJPRALb7OU2S5s+f0vLj4o1bHM=",
+        "lastModified": 1689068808,
+        "narHash": "sha256-6ixXo3wt24N/melDWjq70UuHQLxGV8jZvooRanIHXw0=",
        "owner": "numtide",
        "repo": "flake-utils",
-        "rev": "a4b154ebbdc88c8498a5c7b01589addc9e9cb678",
+        "rev": "919d646de7be200f3bf08cb76ae1f09402b6f9b4",
        "type": "github"
      },
      "original": {
@@ -15,13 +18,30 @@
        "type": "github"
      }
    },
+    "gtest-src": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1690989893,
+        "narHash": "sha256-t0RchAHTJbuI5YW4uyBPykTvcjy90JW9AOPNjIhwh6U=",
+        "owner": "google",
+        "repo": "googletest",
+        "rev": "f8d7d77c06936315286eb55f8de22cd23c188571",
+        "type": "github"
+      },
+      "original": {
+        "owner": "google",
+        "ref": "v1.14.0",
+        "repo": "googletest",
+        "type": "github"
+      }
+    },
    "nixpkgs": {
      "locked": {
-        "lastModified": 1689008574,
-        "narHash": "sha256-VFMgyHDiqsGDkRg73alv6OdHJAqhybryWHv77bSCGIw=",
+        "lastModified": 1691006197,
+        "narHash": "sha256-DbtxVWPt+ZP5W0Usg7jAyTomIM//c3Jtfa59Ht7AV8s=",
        "owner": "NixOS",
        "repo": "nixpkgs",
-        "rev": "4a729ce4b1fe5ec4fffc71c67c96aa5184ebb462",
+        "rev": "66aedfd010204949cb225cf749be08cb13ce1813",
        "type": "github"
      },
      "original": {
@@ -33,8 +53,24 @@
    "root": {
      "inputs": {
        "flake-utils": "flake-utils",
+        "gtest-src": "gtest-src",
        "nixpkgs": "nixpkgs"
      }
+    },
+    "systems": {
+      "locked": {
+        "lastModified": 1681028828,
+        "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
+        "owner": "nix-systems",
+        "repo": "default",
+        "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-systems",
+        "repo": "default",
+        "type": "github"
+      }
    }
  },
  "root": "root",
@@ -1,8 +1,12 @@
 {
  inputs.flake-utils.url = "github:numtide/flake-utils";
  inputs.nixpkgs.url = "nixpkgs/nixos-unstable";
+  inputs.gtest-src = {
+    url = "github:google/googletest/v1.14.0";
+    flake = false;
+  };

-  outputs = { self, nixpkgs, flake-utils }:
+  outputs = { self, nixpkgs, flake-utils, gtest-src }:
    flake-utils.lib.eachDefaultSystem
      (system:
        let
@@ -25,7 +29,7 @@
                  "manifold-${parallel-backend}";
              version = "beta";
              src = self;
-              nativeBuildInputs = (with pkgs; [ cmake (python39.withPackages (ps: with ps; [ trimesh ])) ]) ++ build-tools ++
+              nativeBuildInputs = (with pkgs; [ cmake (python39.withPackages (ps: with ps; [ trimesh ])) gtest ]) ++ build-tools ++
                (if cuda-support then with pkgs.cudaPackages; [ cuda_nvcc cuda_cudart cuda_cccl pkgs.addOpenGLRunpath ] else [ ]);
              cmakeFlags = [
                "-DMANIFOLD_PYBIND=ON"
@@ -75,6 +79,8 @@
              emscripten
              tbb
              lcov
+              gtest
+              tracy
            ] ++ additional;
          };
        in
@@ -98,9 +104,7 @@
                export EM_CACHE=$(pwd)/.emscriptencache
                mkdir build
                cd build
-                mkdir cache
-                export EM_CACHE=$(pwd)/cache
-                emcmake cmake -DCMAKE_BUILD_TYPE=Release ..
+                emcmake cmake -DCMAKE_BUILD_TYPE=Release -DFETCHCONTENT_SOURCE_DIR_GOOGLETEST=${gtest-src} ..
              '';
              buildPhase = ''
                emmake make -j''${NIX_BUILD_CORES}
@@ -15,7 +15,7 @@
 project (collider)

 file(GLOB_RECURSE SOURCE_FILES CONFIGURE_DEPENDS *.cpp)
-add_library(${PROJECT_NAME} OBJECT ${SOURCE_FILES})
+add_library(${PROJECT_NAME} ${SOURCE_FILES})

 if(MANIFOLD_USE_CUDA)
    set_source_files_properties(${SOURCE_FILES} PROPERTIES LANGUAGE CUDA)
@@ -15,7 +15,7 @@
 project (cross_section)

 file(GLOB_RECURSE SOURCE_FILES CONFIGURE_DEPENDS *.cpp)
-add_library(${PROJECT_NAME} OBJECT ${SOURCE_FILES})
+add_library(${PROJECT_NAME} ${SOURCE_FILES})

 target_include_directories(${PROJECT_NAME}
    PUBLIC ${PROJECT_SOURCE_DIR}/include
@@ -260,7 +260,10 @@ MeshGL Manifold::GetMeshGL(glm::ivec3 normalIdx) const {
      out.triVerts[3 * tri + i] = impl.halfedge_[3 * oldTri + i].startVert;

    if (meshID != lastID) {
-      addRun(out, runNormalTransform, tri, meshIDtransform.at(meshID));
+      Impl::Relation rel;
+      auto it = meshIDtransform.find(meshID);
+      if (it != meshIDtransform.end()) rel = it->second;
+      addRun(out, runNormalTransform, tri, rel);
      meshIDtransform.erase(meshID);
      lastID = meshID;
    }
@@ -15,7 +15,7 @@
 project (polygon)

 file(GLOB_RECURSE SOURCE_FILES CONFIGURE_DEPENDS *.cpp)
-add_library(${PROJECT_NAME} OBJECT ${SOURCE_FILES})
+add_library(${PROJECT_NAME} ${SOURCE_FILES})

 target_include_directories(${PROJECT_NAME}
    PUBLIC ${PROJECT_SOURCE_DIR}/include
@@ -1,6 +1,6 @@
 project (graphlite)

-add_library(${PROJECT_NAME} OBJECT src/connected_components.cpp)
+add_library(${PROJECT_NAME} src/connected_components.cpp)

 target_include_directories(${PROJECT_NAME}
    PUBLIC ${PROJECT_SOURCE_DIR}/include
@@ -15,7 +15,7 @@
 project(utilities)

 file(GLOB_RECURSE SOURCE_FILES CONFIGURE_DEPENDS *.cpp)
-add_library(${PROJECT_NAME} OBJECT ${SOURCE_FILES})
+add_library(${PROJECT_NAME} ${SOURCE_FILES})

 message("CUDA Support: ${MANIFOLD_USE_CUDA}")
 message("Parallel Backend: ${MANIFOLD_PAR}")
@@ -29,11 +29,32 @@ if(MANIFOLD_PAR STREQUAL "OMP")
    target_compile_options(${PROJECT_NAME} PUBLIC -DMANIFOLD_PAR='O' -fopenmp)
    target_link_options(${PROJECT_NAME} PUBLIC -fopenmp)
 elseif(MANIFOLD_PAR STREQUAL "TBB")
-    find_package(PkgConfig REQUIRED)
-    pkg_check_modules(TBB REQUIRED tbb)
-    target_include_directories(${PROJECT_NAME} PUBLIC ${TBB_INCLUDE_DIRS})
+    find_package(PkgConfig)
+    if (PKG_CONFIG_FOUND)
+        pkg_check_modules(TBB tbb)
+    endif()
+    if(NOT TBB_FOUND)
+        message(STATUS "tbb not found, downloading from source")
+        include(FetchContent)
+        set(TBB_TEST OFF CACHE INTERNAL "" FORCE)
+        set(TBB_STRICT OFF CACHE INTERNAL "" FORCE)
+        FetchContent_Declare(TBB
+          GIT_REPOSITORY https://github.com/oneapi-src/oneTBB.git
+          # versions afterward forces -D_FORTIFY_SOURCE=2
+          # which conflicts with defaults with nixos...
+          GIT_TAG        v2021.10.0
+          GIT_SHALLOW    TRUE
+          GIT_PROGRESS   TRUE
+        )
+        FetchContent_MakeAvailable(TBB)
+    endif()
    target_compile_options(${PROJECT_NAME} PUBLIC -DMANIFOLD_PAR='T')
-    target_link_libraries(${PROJECT_NAME} PUBLIC ${TBB_LINK_LIBRARIES})
+    if(TARGET TBB::tbb)
+        target_link_libraries(${PROJECT_NAME} PUBLIC TBB::tbb)
+    else()
+        target_include_directories(${PROJECT_NAME} PUBLIC ${TBB_INCLUDE_DIRS})
+        target_link_libraries(${PROJECT_NAME} PUBLIC ${TBB_LINK_LIBRARIES})
+    endif()
 elseif(MANIFOLD_PAR STREQUAL "NONE")
    set(MANIFOLD_PAR "CPP")
 else()
@@ -63,4 +84,4 @@ if(MANIFOLD_DEBUG)
        PUBLIC -DMANIFOLD_DEBUG)
 endif()

-target_compile_features(${PROJECT_NAME} PUBLIC cxx_std_17)
+target_compile_features(${PROJECT_NAME} PUBLIC cxx_std_17)
@@ -14,8 +14,6 @@

 project(manifold_test)

-add_subdirectory(third_party)
-
 enable_testing()

 set(SOURCE_FILES polygon_test.cpp cross_section_test.cpp manifold_test.cpp boolean_test.cpp sdf_test.cpp samples_test.cpp test_main.cpp)
@@ -24,9 +22,45 @@ if(MANIFOLD_CBIND)
  list(APPEND SOURCE_FILES manifoldc_test.cpp)
 endif()

+set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
+# Prevent installation of GTest with your project
+set(INSTALL_GTEST OFF CACHE BOOL "" FORCE)
+set(INSTALL_GMOCK OFF CACHE BOOL "" FORCE)
+
+find_package(GTest)
+if(NOT GTest_FOUND)
+  message(STATUS "GTest not found, downloading from source")
+  include(FetchContent)
+  FetchContent_Declare(googletest
+    GIT_REPOSITORY https://github.com/google/googletest.git
+    GIT_TAG        v1.14.0
+    GIT_SHALLOW    TRUE
+    GIT_PROGRESS   TRUE
+    OVERRIDE_FIND_PACKAGE
+  )
+  FetchContent_MakeAvailable(googletest)
+endif()
+
+if(NOT TARGET GTest::GTest)
+    add_library(GTest::GTest ALIAS gtest)
+    add_library(GTest::Main ALIAS gtest_main)
+endif()
+
 add_executable(${PROJECT_NAME} ${SOURCE_FILES})
 target_link_libraries(${PROJECT_NAME} polygon GTest::GTest manifold sdf samples samplesGPU cross_section)

+if (TRACY_ENABLE)
+  include(FetchContent)
+  FetchContent_Declare(tracy
+    GIT_REPOSITORY https://github.com/wolfpld/tracy.git
+    GIT_TAG v0.9.1
+    GIT_SHALLOW TRUE
+    GIT_PROGRESS TRUE
+  )
+  FetchContent_MakeAvailable(tracy)
+  target_link_libraries(${PROJECT_NAME} TracyClient)
+endif()
+
 if(MANIFOLD_CBIND)
  target_link_libraries(${PROJECT_NAME} manifoldc)
 endif()
@@ -13,10 +13,19 @@
 // limitations under the License.

 #pragma once
+#include <ostream>
+
 #include "gtest/gtest.h"
 #include "manifold.h"
 #include "public.h"

+// somehow gcc11 + gtest 1.11.0 is unable to print glm::ivec3
+namespace glm {
+inline void PrintTo(const ivec3& point, std::ostream* os) {
+  *os << "(" << point.x << "," << point.y << "," << point.x << ")";
+}
+}  // namespace glm
+
 using namespace manifold;

 struct Options {
@@ -17,6 +17,14 @@
 #include "sdf.h"
 #include "test.h"

+// we need to call some tracy API to establish the connection
+#if __has_include(<tracy/Tracy.hpp>)
+#include <tracy/Tracy.hpp>
+#else
+#define FrameMarkStart(x)
+#define FrameMarkEnd(x)
+#endif
+
 using namespace manifold;

 Options options;
@@ -34,6 +42,9 @@ void print_usage() {
 int main(int argc, char** argv) {
  ::testing::InitGoogleTest(&argc, argv);

+  const char* name = "test setup";
+  FrameMarkStart(name);
+
  for (int i = 1; i < argc; i++) {
    if (argv[i][0] != '-') {
      fprintf(stderr, "Unknown option: %s\n", argv[i]);
@@ -67,6 +78,7 @@ int main(int argc, char** argv) {
  manifold::PolygonParams().intermediateChecks = true;
  manifold::PolygonParams().processOverlaps = false;

+  FrameMarkEnd(name);
  return RUN_ALL_TESTS();
 }

@@ -442,4 +454,4 @@ void CheckGL(const Manifold& manifold) {
    EXPECT_EQ(meshGL.runTransform.size(), 12 * meshGL.runOriginalID.size());
  }
  EXPECT_EQ(meshGL.faceID.size(), meshGL.NumTri());
-}
+}
@@ -1,37 +0,0 @@
-# Copyright 2020 The Manifold Authors.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# https://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# ###########################################################################
-# Build Google Test                              #
-# ###########################################################################
-# Prevent overriding the parent project's compiler/linker
-# settings on Windows
-set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
-
-# Prevent installation of GTest with your project
-set(INSTALL_GTEST OFF CACHE BOOL "" FORCE)
-set(INSTALL_GMOCK OFF CACHE BOOL "" FORCE)
-
-add_subdirectory(google_test)
-
-# Add aliases for GTest and GMock libraries
-if(NOT TARGET GTest::GTest)
-    add_library(GTest::GTest ALIAS gtest)
-    add_library(GTest::Main ALIAS gtest_main)
-endif()
-
-if(NOT TARGET GTest::GMock)
-    add_library(GMock::GMock ALIAS gmock)
-    add_library(GMock::Main ALIAS gmock_main)
-endif()