Merge branch 'master' into temp_place_est_chan_util

Author: soheilshahrouz

.github/workflows/test.yml

@@ -611,19 +611,19 @@ jobs:
       fail-fast: false
       matrix:
         include:
-        - { name: 'GCC 11 (Ubuntu Noble - 24.04)',    eval: 'CC=gcc-11 && CXX=g++-11',       key: 'gcc-11', }
-        - { name: 'GCC 12 (Ubuntu Noble - 24.04)',    eval: 'CC=gcc-12 && CXX=g++-12',       key: 'gcc-12', }
-        - { name: 'GCC 14 (Ubuntu Noble - 24.04)',    eval: 'CC=gcc-14 && CXX=g++-14',       key: 'gcc-14', }
-        - { name: 'Clang 16 (Ubuntu Noble - 24.04)',  eval: 'CC=clang-16 && CXX=clang++-16', key: 'clang-16', }
-        - { name: 'Clang 17 (Ubuntu Noble - 24.04)',  eval: 'CC=clang-17 && CXX=clang++-17', key: 'clang-17', }
-        - { name: 'Clang 18 (Ubuntu Noble - 24.04)',  eval: 'CC=clang-18 && CXX=clang++-18', key: 'clang-18', }
+        - { name: 'GCC 12 (Ubuntu Noble - 24.04)',    CC: 'gcc-12',   CXX: 'g++-12',     }
+        - { name: 'GCC 14 (Ubuntu Noble - 24.04)',    CC: 'gcc-14',   CXX: 'g++-14',     }
+        - { name: 'Clang 16 (Ubuntu Noble - 24.04)',  CC: 'clang-16', CXX: 'clang++-16', }
+        - { name: 'Clang 17 (Ubuntu Noble - 24.04)',  CC: 'clang-17', CXX: 'clang++-17', }
+        - { name: 'Clang 18 (Ubuntu Noble - 24.04)',  CC: 'clang-18', CXX: 'clang++-18', }
         # Note: We do not include GCC-13 since it is the default and is already tested.
+        #       We also do not include GCC-11 since it is tested in the JammyCompatibility test.
     name: 'B: ${{ matrix.name }}'
+    env:
+      CC: ${{ matrix.CC }}
+      CXX: ${{ matrix.CXX }}
     steps:
 
-    - uses: actions/setup-python@v5
-      with:
-        python-version: 3.12.3
     - uses: actions/checkout@v4
       with:
         submodules: 'true'
@@ -637,27 +637,24 @@ jobs:
 
     - uses: hendrikmuhs/[email protected]
       with:
-        key: ${{ github.job }}-${{ matrix.key }}
+        key: ${{ github.job }}-${{ matrix.CC }}
 
-    - name: Test
+    - name: Build
       env:
-        CMAKE_PARAMS: "-DVTR_ASSERT_LEVEL=3 -DWITH_BLIFEXPLORER=on -DWITH_ODIN=on -DVTR_IPO_BUILD=off"
-        MATRIX_EVAL: ${{ matrix.eval }}
-        BUILD_TYPE: debug # Note: We use the debug build here to make the build time faster since we do not care about run time.
-        NUM_PROC: ${{ steps.cpu-cores.outputs.count }}
+        CMAKE_PARAMS: "-DVTR_ASSERT_LEVEL=3 -DVTR_IPO_BUILD=off"
+        BUILD_TYPE: release # Note: Found that release build caches way better than debug build for this test.
       run: |
         export PATH="/usr/lib/ccache:/usr/local/opt/ccache/libexec:$PATH"
-        ./.github/scripts/build.sh
+        make -j${{ steps.cpu-cores.outputs.count}}
 
   JammyCompatibility:
     name: 'Ubuntu Jammy - 22.04 Compatibility Test'
     runs-on: ubuntu-22.04
     needs: [BuildVTR]
+    env:
+      CC: gcc-11
+      CXX: g++-11
     steps:
-    - uses: actions/setup-python@v5
-      with:
-        python-version: 3.10.10
-
     - uses: actions/checkout@v4
       with:
         submodules: 'true'
@@ -671,15 +668,13 @@ jobs:
 
     - uses: hendrikmuhs/[email protected]
       with:
-        key: ${{ github.job }}
+        key: ${{ github.job }}-gcc-11
 
-    - name: Test
+    - name: Build
       env:
         CMAKE_PARAMS: "-DVTR_ASSERT_LEVEL=3 -DCMAKE_COMPILE_WARNING_AS_ERROR=on -DVTR_IPO_BUILD=off"
-        MATRIX_EVAL: 'CC=gcc-11 && CXX=g++-11'
-        BUILD_TYPE: debug # Note: We use the debug build here to make the build time faster since we do not care about run time.
-        NUM_PROC: ${{ steps.cpu-cores.outputs.count }}
+        BUILD_TYPE: release # Note: Found that release build caches way better than debug build for this test.
       run: |
         export PATH="/usr/lib/ccache:/usr/local/opt/ccache/libexec:$PATH"
-        ./.github/scripts/build.sh
+        make -j${{ steps.cpu-cores.outputs.count}}
 

libs/libvtrutil/CMakeLists.txt

@@ -50,35 +50,49 @@ if (VTR_ENABLE_DEBUG_LOGGING)
     set(VTR_BUILD_INFO "${VTR_BUILD_INFO} debug_logging")
 endif()
 
-# We always update the vtr_version.cpp file every time the project is built, 
-# to ensure the git revision and dirty status are up to date.
-#
-# We need to do this in two stages:
-#
-# 1) We a custom target 'version' (which is always out of date) so it will always be run.
-#    It touches the unprocessed version input file so it too will always be out of date.
-#
-# 2) The custom command depends on the touched version input file and generates the processed 
-#    version file, with updated values. The custom command uses the configure_version.cmake 
-#    script to generate the up-to-date vtr_version.cpp
-add_custom_target(version ALL
-    COMMAND ${CMAKE_COMMAND} -E touch ${VTR_VERSION_FILE_IN})
-
-add_custom_command(OUTPUT ${VTR_VERSION_FILE_OUT}
-    COMMAND ${CMAKE_COMMAND} 
-                    -D IN_FILE=${VTR_VERSION_FILE_IN}
-                    -D OUT_FILE=${VTR_VERSION_FILE_OUT}
-                    -D VTR_VERSION_MAJOR=${VTR_VERSION_MAJOR}
-                    -D VTR_VERSION_MINOR=${VTR_VERSION_MINOR}
-                    -D VTR_VERSION_PATCH=${VTR_VERSION_PATCH}
-                    -D VTR_VERSION_PRERELEASE=${VTR_VERSION_PRERELEASE}
-                    -D VTR_COMPILER_INFO=${VTR_COMPILER_INFO}
-                    -D VTR_BUILD_INFO=${VTR_BUILD_INFO}
-                    -P ${CMAKE_CURRENT_SOURCE_DIR}/cmake/modules/configure_version.cmake
-    MAIN_DEPENDENCY ${VTR_VERSION_FILE_IN}
-    WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
-	VERBATIM)
+list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake/modules")
+include(GetGitRevisionDescription)
+
+# Get the VCS revision.
+git_describe_working_tree(VTR_VCS_REVISION --tags --always --long)
+string(FIND ${VTR_VCS_REVISION} "NOTFOUND" GIT_DESCRIBE_VTR_REVISION_NOTFOUND)
+if (NOT ${GIT_DESCRIBE_VTR_REVISION_NOTFOUND} EQUAL -1)
+    # Git describe failed, usually this means we
+    # aren't in a git repo -- so don't set a VCS
+    # revision
+    set(VTR_VCS_REVISION "unknown")
+endif()
+
+# Get the short VCS revision
+git_describe_working_tree(VTR_VCS_REVISION_SHORT --tags --always --long --exclude '*')
+string(FIND "${VTR_VCS_REVISION_SHORT}" "NOTFOUND" GIT_DESCRIBE_VTR_REVISION_SHORT_NOTFOUND)
+if (NOT ${GIT_DESCRIBE_VTR_REVISION_SHORT_NOTFOUND} EQUAL -1)
+    # Git describe failed, usually this means we
+    # aren't in a git repo -- so don't set a VCS
+    # revision
+    set(VTR_VCS_REVISION_SHORT "unknown")
+endif()
 
+# Set the version according to semver.org
+set(VTR_VERSION "${VTR_VERSION_MAJOR}.${VTR_VERSION_MINOR}.${VTR_VERSION_PATCH}")
+if(VTR_VERSION_PRERELEASE)
+    set(VTR_VERSION "${VTR_VERSION}-${VTR_VERSION_PRERELEASE}")
+endif()
+set(VTR_VERSION_SHORT ${VTR_VERSION})
+if(VTR_VCS_REVISION)
+    set(VTR_VERSION "${VTR_VERSION}+${VTR_VCS_REVISION_SHORT}")
+endif()
+
+# Other build meta-data
+string(TIMESTAMP VTR_BUILD_TIMESTAMP)
+set(VTR_BUILD_TIMESTAMP "${VTR_BUILD_TIMESTAMP}")
+set(VTR_BUILD_INFO "${VTR_BUILD_INFO}")
+
+message(STATUS "VTR Version: ${VTR_VERSION}")
+message(STATUS "VTR Revision: ${VTR_VCS_REVISION}")
+message(STATUS "VTR Short Revision: ${VTR_VCS_REVISION_SHORT}")
+
+configure_file(${VTR_VERSION_FILE_IN} ${VTR_VERSION_FILE_OUT})
 
 #
 # Source files and library
@@ -97,9 +111,6 @@ add_library(libvtrutil STATIC
 target_include_directories(libvtrutil PUBLIC ${LIB_INCLUDE_DIRS})
 set_target_properties(libvtrutil PROPERTIES PREFIX "") #Avoid extra 'lib' prefix
 
-#Ensure version is always up to date by requiring version to be run first
-add_dependencies(libvtrutil version)
-
 #Specify link-time dependencies
 target_link_libraries(libvtrutil
                         liblog)