Change approach for dependency versions to fetch git SHA

Fetch git SHA from build/extern folders

Author: nikosavola

palace/CMakeLists.txt

@@ -265,69 +265,40 @@ if(NOT GIT_COMMIT_ID MATCHES "NOTFOUND")
   )
 endif()
 
-# Add dependency version information
-if(nlohmann_json_VERSION)
-  set_property(
-    SOURCE ${CMAKE_SOURCE_DIR}/main.cpp
-    APPEND PROPERTY COMPILE_DEFINITIONS "PALACE_NLOHMANN_JSON_VERSION=\"${nlohmann_json_VERSION}\""
-  )
-endif()
 
-if(fmt_VERSION)
-  set_property(
-    SOURCE ${CMAKE_SOURCE_DIR}/main.cpp
-    APPEND PROPERTY COMPILE_DEFINITIONS "PALACE_FMT_VERSION=\"${fmt_VERSION}\""
-  )
-endif()
-
-if(scn_VERSION)
-  set_property(
-    SOURCE ${CMAKE_SOURCE_DIR}/main.cpp
-    APPEND PROPERTY COMPILE_DEFINITIONS "PALACE_SCN_VERSION=\"${scn_VERSION}\""
-  )
-endif()
-
-if(Eigen3_VERSION)
-  set_property(
-    SOURCE ${CMAKE_SOURCE_DIR}/main.cpp
-    APPEND PROPERTY COMPILE_DEFINITIONS "PALACE_EIGEN_VERSION=\"${Eigen3_VERSION}\""
-  )
-endif()
-
-if(MFEM_VERSION)
-  set_property(
-    SOURCE ${CMAKE_SOURCE_DIR}/main.cpp
-    APPEND PROPERTY COMPILE_DEFINITIONS "PALACE_MFEM_VERSION=\"${MFEM_VERSION}\""
-  )
-endif()
-
-if(libCEED_VERSION)
-  set_property(
-    SOURCE ${CMAKE_SOURCE_DIR}/main.cpp
-    APPEND PROPERTY COMPILE_DEFINITIONS "PALACE_LIBCEED_VERSION=\"${libCEED_VERSION}\""
-  )
-endif()
-
-if(PALACE_WITH_SLEPC AND PETSc_VERSION)
-  set_property(
-    SOURCE ${CMAKE_SOURCE_DIR}/main.cpp
-    APPEND PROPERTY COMPILE_DEFINITIONS "PALACE_PETSC_VERSION=\"${PETSc_VERSION}\""
-  )
-endif()
-
-if(PALACE_WITH_SLEPC AND SLEPc_VERSION)
-  set_property(
-    SOURCE ${CMAKE_SOURCE_DIR}/main.cpp
-    APPEND PROPERTY COMPILE_DEFINITIONS "PALACE_SLEPC_VERSION=\"${SLEPc_VERSION}\""
-  )
-endif()
-
-if(PALACE_WITH_ARPACK AND arpackng_VERSION)
+# For each dependency with a git SHA, set a compile definition <DEPENDENCY>_COMMIT_SHA
+set(dependency_folders
+  STRUMPACK
+  arpack-ng
+  eigen
+  fmt
+  gslib
+  hypre
+  json
+  libCEED
+  libxsmm
+  magma
+  metis
+  mfem
+  mumps
+  parmetis
+  petsc
+  scalapack
+  scn
+  slepc
+  sundials
+  superlu_dist
+)
+foreach(dep_folder IN LISTS dependency_folders)
+  message(DEBUG "Checking dependency in folder ${dep_folder}")
+  get_dependency_git_sha("${CMAKE_BINARY_DIR}/../extern/${dep_folder}" dep_sha)
+  message(DEBUG "Git SHA for ${dep_folder}: ${dep_sha}")
+  string(REPLACE "-" "_" dep_folder_sanitized "${dep_folder}")
   set_property(
     SOURCE ${CMAKE_SOURCE_DIR}/main.cpp
-    APPEND PROPERTY COMPILE_DEFINITIONS "PALACE_ARPACK_VERSION=\"${arpackng_VERSION}\""
+    APPEND PROPERTY COMPILE_DEFINITIONS "${dep_folder_sanitized}_COMMIT_SHA=\"${dep_sha}\""
   )
-endif()
+endforeach()
 
 # Check C++ compiler support for constexpr std::sqrt and std::filesystem
 include(CheckCompilerFeatureSupport)

palace/cmake/GetGitDescription.cmake

@@ -98,3 +98,30 @@ function(git_describe _var)
     set(${_var} "${out}" PARENT_SCOPE)
   endif()
 endfunction()
+
+
+# Helper to get git SHA for a dependency
+function(get_dependency_git_sha dep_source_dir _var)
+  find_package(Git QUIET)
+  if(NOT GIT_FOUND)
+    message(WARNING "Git not found, cannot get SHA for ${dep_source_dir}")
+    return()
+  endif()
+
+  # Run git describe in the given source directory
+  # Do not consider parent directories (--git-dir .git)
+  execute_process(
+    COMMAND "${GIT_EXECUTABLE}" --git-dir .git describe --tags --always --dirty
+    WORKING_DIRECTORY "${dep_source_dir}"
+    RESULT_VARIABLE res
+    OUTPUT_VARIABLE out
+    ERROR_QUIET OUTPUT_STRIP_TRAILING_WHITESPACE
+  )
+  if(NOT res EQUAL 0)
+    message(DEBUG "Git SHA for not found in ${dep_source_dir}")
+    set(${_var} "GIT-NOTFOUND" PARENT_SCOPE)
+  else()
+    message(DEBUG "Git SHA for ${dep_name_source_dir}: ${out}")
+    set(${_var} ${out} PARENT_SCOPE)
+  endif()
+endfunction()

palace/main.cpp

@@ -42,54 +42,47 @@ static const char *GetPalaceGitTag()
 
 static void PrintPalaceVersionInfo(MPI_Comm comm)
 {
+
   if (std::strcmp(GetPalaceGitTag(), "UNKNOWN"))
   {
     Mpi::Print(comm, "Git commit: {}\n", GetPalaceGitTag());
   }
 
-  // Print build dependencies
   Mpi::Print(comm, "\nBuild dependencies:\n");
 
-#define PRINT_VERSION(NAME, VERSION_MACRO) \
-  Mpi::Print(comm, "  " NAME ": {}\n", VERSION_MACRO)
-
-#if defined(PALACE_MFEM_VERSION)
-  PRINT_VERSION("MFEM", PALACE_MFEM_VERSION);
-#endif
-
-#if defined(PALACE_LIBCEED_VERSION)
-  PRINT_VERSION("libCEED", PALACE_LIBCEED_VERSION);
-#endif
-
-#if defined(PALACE_WITH_SLEPC) && defined(PALACE_SLEPC_VERSION)
-  PRINT_VERSION("SLEPc", PALACE_SLEPC_VERSION);
-#endif
-
-#if defined(PALACE_WITH_SLEPC) && defined(PALACE_PETSC_VERSION)
-  PRINT_VERSION("PETSc", PALACE_PETSC_VERSION);
-#endif
-
-#if defined(PALACE_WITH_ARPACK) && defined(PALACE_ARPACK_VERSION)
-  PRINT_VERSION("ARPACK", PALACE_ARPACK_VERSION);
-#endif
+// X-macro to check if a dependency macro is defined and print the SHA
+#define X(DEP_NAME) \
+    Mpi::Print(comm, "  " #DEP_NAME ": {}\n", DEP_NAME ## _COMMIT_SHA);
+
+// List of dependencies and their corresponding macros
+#define PRINT_DEP_SHA_LIST \
+  X(STRUMPACK) \
+  X(arpack_ng) \
+  X(eigen) \
+  X(fmt) \
+  X(gslib) \
+  X(hypre) \
+  X(json) \
+  X(libCEED) \
+  X(libxsmm) \
+  X(magma) \
+  X(metis) \
+  X(mfem) \
+  X(mumps) \
+  X(parmetis) \
+  X(petsc) \
+  X(scalapack) \
+  X(scn) \
+  X(slepc) \
+  X(sundials) \
+  X(superlu_dist)
+
+// Iterate over the list and print if macro is defined
+PRINT_DEP_SHA_LIST
+
+#undef X
 
-#if defined(PALACE_NLOHMANN_JSON_VERSION)
-  PRINT_VERSION("nlohmann/json", PALACE_NLOHMANN_JSON_VERSION);
-#endif
-
-#if defined(PALACE_FMT_VERSION)
-  PRINT_VERSION("fmt", PALACE_FMT_VERSION);
-#endif
-
-#if defined(PALACE_SCN_VERSION)
-  PRINT_VERSION("scn", PALACE_SCN_VERSION);
-#endif
-
-#if defined(PALACE_EIGEN_VERSION)
-  PRINT_VERSION("Eigen", PALACE_EIGEN_VERSION);
-#endif
 
-  Mpi::Print(comm, "\n");
 }
 
 static const char *GetPalaceCeedJitSourceDir()