Twon · jakeheke75 · Oct 9, 2023 · Oct 9, 2023 · Oct 9, 2023 · Oct 11, 2023
diff --git a/.github/workflows/cmake.yml b/.github/workflows/cmake.yml
@@ -34,7 +34,15 @@ jobs:
           - {
               name: "Ubuntu GCC-12",
               os: ubuntu-latest,
-              compiler: { type: GCC, version: 12, conan: "gcc", cc: "gcc-12", cxx: "g++-12", std: 20 },
+              compiler:
+                {
+                  type: GCC,
+                  version: 12,
+                  conan: "gcc",
+                  cc: "gcc-12",
+                  cxx: "g++-12",
+                  std: 20
+                },
               lib: "libstdc++11"
             }
           - {
@@ -88,7 +96,15 @@ jobs:
           - {
               name: "Visual Studio 2019",
               os: windows-latest,
-              compiler: { type: VISUAL, version: 16, conan: "mscv", cc: "cl", cxx: "cl", std: 20 },
+              compiler:
+                {
+                  type: VISUAL,
+                  version: 16,
+                  conan: "mscv",
+                  cc: "cl",
+                  cxx: "cl",
+                  std: 20
+                },
             }
           - {
               name: "MacOS Apple Clang 14",
@@ -130,9 +146,9 @@ jobs:
           key: ${{ hashFiles('**/conanfile.py') }}-build-${{ matrix.settings.os }}-${{ matrix.configuration }}-${{ matrix.settings.compiler.conan }}-${{ matrix.settings.compiler.version }}-${{ matrix.settings.lib }}
           restore-keys: |
             ${{ hashFiles('**/conanfile.py') }}-build-${{ matrix.settings.os }}-${{ matrix.configuration }}-${{ matrix.settings.compiler.conan }}-${{ matrix.settings.compiler.version }}-
-            ${{ hashFiles('**/conanfile.py') }}-build-${{ matrix.settings.os }}-${{ matrix.configuration }}-${{ matrix.settings.compiler.conan }}-
-            ${{ hashFiles('**/conanfile.py') }}-build-${{ matrix.settings.os }}-${{ matrix.configuration }}-
-            ${{ hashFiles('**/conanfile.py') }}-build-${{ matrix.settings.os }}-
+            #${{ hashFiles('**/conanfile.py') }}-build-${{ matrix.settings.os }}-${{ matrix.configuration }}-${{ matrix.settings.compiler.conan }}-
+            #${{ hashFiles('**/conanfile.py') }}-build-${{ matrix.settings.os }}-${{ matrix.configuration }}-
+            #${{ hashFiles('**/conanfile.py') }}-build-${{ matrix.settings.os }}-
 
 #      - uses: lhotari/action-upterm@v1
 #        with:
@@ -214,10 +230,18 @@ jobs:
           conan profile show -pr default
 
       - name: Configure Install
+        if: matrix.settings.os != 'windows-latest'
+        working-directory: ${{github.workspace}}
+        shell: bash
+        run: |
+          conan install "${{github.workspace}}" --build missing -pr:b default -c tools.cmake.cmaketoolchain:generator="Ninja Multi-Config"  -o boost/*:without_cobalt=True
+
+      - name: Configure Install
+        if: matrix.settings.os == 'windows-latest'
         working-directory: ${{github.workspace}}
         shell: bash
         run: |
-          conan install "${{github.workspace}}" --build missing -pr:b default -o boost/*:without_cobalt=True
+          conan install "${{github.workspace}}" --build missing -pr:b default -o boost/*:without_cobalt=True -c tools.cmake.cmaketoolchain:generator="Ninja Multi-Config"
 
       - name: Configure Conan Build
         if: matrix.settings.os == 'windows-latest'
@@ -241,38 +265,132 @@ jobs:
 #          detached: true
 
       - name: Configure CMake
-        if: matrix.settings.os == 'windows-latest'
+        if: matrix.settings.os == 'windows-latest' && matrix.configuration == 'Release'
         shell: cmd
         run: |
           cmake --version
           call build\generators\conanbuild.bat
-          cmake --preset conan-default -DENABLE_ADDRESS_SANITIZER=ON -DENABLE_UNDEFINED_BEHAVIOUR_SANITIZER=ON
+          cmake --preset conan-default -DENABLE_ADDRESS_SANITIZER=ON -DENABLE_UNDEFINED_BEHAVIOUR_SANITIZER=ON -DCMAKE_CXX_COMPILER_LAUNCHER=ccache -DCMAKE_VS_GLOBALS="UseMultiToolTask=true;EnforceProcessCountAcrossBuilds=true"
 
       - name: Configure CMake
-        if: matrix.settings.os != 'windows-latest'
+        if: matrix.settings.os == 'windows-latest' && matrix.configuration == 'Debug'
+        shell: cmd
+        run: |
+          cmake --version
+          call build\generators\conanbuild.bat
+          cmake --preset conan-default -DENABLE_ADDRESS_SANITIZER=ON -DENABLE_UNDEFINED_BEHAVIOUR_SANITIZER=ON -DCMAKE_CXX_COMPILER_LAUNCHER=ccache -DCMAKE_CXX_FLAGS_DEBUG="/YI;/Z7" -DCMAKE_VS_GLOBALS="UseMultiToolTask=true;EnforceProcessCountAcrossBuilds=true;TrackFileAccess=false;DebugInformationFormat=OldStyle"
+
+      - name: Configure CMake
+        if: matrix.settings.os != 'windows-latest' && matrix.settings.compiler.type == 'GCC'
         shell: bash
         run: |
           source build/generators/conanbuild.sh
-          cmake --preset conan-default -DENABLE_ADDRESS_SANITIZER=ON -DENABLE_UNDEFINED_BEHAVIOUR_SANITIZER=ON
+          cmake --preset conan-default -DENABLE_ADDRESS_SANITIZER=ON -DENABLE_UNDEFINED_BEHAVIOUR_SANITIZER=ON -DCMAKE_CXX_COMPILER_LAUNCHER=ccache
+
+      - name: Configure CMake
+        if: matrix.settings.os != 'windows-latest' && matrix.settings.compiler.type != 'GCC'
+        shell: bash
+        run: |
+          source build/generators/conanbuild.sh
+          cmake --preset conan-default -DENABLE_ADDRESS_SANITIZER=ON -DENABLE_UNDEFINED_BEHAVIOUR_SANITIZER=ON -DCMAKE_CXX_COMPILER_LAUNCHER=ccache -DCMAKE_CXX_FLAGS_DEBUG="-Xclang -fno-pch-timestamp" -DCMAKE_CXX_FLAGS_RELEASE="-Xclang -fno-pch-timestamp"
 
       - name: Conan Preset
         shell: bash
         run: echo "CONAN_PRESET=conan-$(echo ${{matrix.configuration}} | tr '[:upper:]' '[:lower:]')" >> $GITHUB_ENV
 
+      - name: CCache Configure
+        if: matrix.settings.os != 'windows-latest'
+        id: ccache-config-linux
+        shell: bash
+        run: |
+          mkdir $HOME/.ccache
+          echo "CCACHE_HOME=$HOME/.ccache" >> $GITHUB_ENV
+
+      - name: Cache CCache data
+        if: matrix.settings.os == 'windows-latest'
+        uses: actions/cache@v3.3.2
+        with:
+          path: C:\Users\runneradmin\AppData\Local\ccache\
+          key: ccache-${{ matrix.settings.os }}-${{ matrix.configuration }}-${{ matrix.settings.compiler.conan }}-${{ matrix.settings.compiler.version }}-${{ matrix.settings.lib }}-${{ github.run_number }}
+          restore-keys: |
+            ccache-${{ matrix.settings.os }}-${{ matrix.configuration }}-${{ matrix.settings.compiler.conan }}-${{ matrix.settings.compiler.version }}-${{ matrix.settings.lib }}-
+
+      - name: Cache CCache data
+        if: matrix.settings.os != 'windows-latest'
+        uses: actions/cache@v3.3.2
+        with:
+          path: ${{ env.CCACHE_HOME }}
+          key: ccache-${{ matrix.settings.os }}-${{ matrix.configuration }}-${{ matrix.settings.compiler.conan }}-${{ matrix.settings.compiler.version }}-${{ matrix.settings.lib }}-${{ github.run_number }}
+          restore-keys: |
+            ccache-${{ matrix.settings.os }}-${{ matrix.configuration }}-${{ matrix.settings.compiler.conan }}-${{ matrix.settings.compiler.version }}-${{ matrix.settings.lib }}-
+
       - name: Build
         if: matrix.settings.os == 'windows-latest'
         shell: cmd
         run: |
           call build\generators\conanbuild.bat
+          set CCACHE_BASEDIR=${{ github.workspace }}
+          set CCACHE_LOGFILE=D:\\a\\Morpheus\\Morpheus\\build\\CcacheLogFile.log
+          set CCACHE_NOHASHDIR=1
+          set CCACHE_SLOPPINESS=pch_defines,time_macros,include_file_mtime,include_file_ctime
+          REM set CCACHE_DEBUG=1
+          REM set CCACHE_DEBUGDIR=D:\\a\\Morpheus\\Morpheus\\build\\
+          REM set CCACHE_RECACHE=1
+          echo Morpheus ccache show configuration
+          ccache -p
           cmake --build --preset ${{ env.CONAN_PRESET }}
 
       - name: Build
         if: matrix.settings.os != 'windows-latest'
         shell: bash
         run: |
           source build/generators/conanbuild.sh
+          export CCACHE_BASEDIR=${{ github.workspace }}
+          export CCACHE_DIR=$HOME/.ccache
+          export CCACHE_LOGFILE=$HOME/.ccache/CcacheLogFile.log
+          export CCACHE_NOHASHDIR=1
+          export CCACHE_SLOPPINESS=pch_defines,time_macros,include_file_mtime,include_file_ctime
+          #export CCACHE_DEBUG=1
+          #export CCACHE_DEBUGDIR=$HOME/.ccache/
+          #export CCACHE_RECACHE=1
+          echo "Morpheus ccache show configuration"
+          ccache -p
           cmake --build --preset ${{ env.CONAN_PRESET }}
 
+      - name: CCache Stats
+        if: matrix.settings.os == 'windows-latest'
+        shell: cmd
+        run: |
+            call build\generators\conanbuild.bat
+            echo Morpheus ccache show stats
+            ccache -d C:\Users\runneradmin\AppData\Local\ccache\ -svvz
+            echo Morpheus showing ccache log files
+            type D:\a\Morpheus\Morpheus\build\CcacheLogFile.log
+            REM echo Morpheus showing ccache debug input files
+            REM forfiles /M *.ccache-input-text /S /C "cmd /c type @file"
+            REM echo Morpheus showing ccache debug log files
+            REM forfiles /M *.ccache-log /S /C "cmd /c type @file"
+            REM dir D:\a\Morpheus\Morpheus\build
+            REM rm D:\a\Morpheus\Morpheus\build\CcacheLogFile.log
+            REM dir D:\a\Morpheus\Morpheus\build
+
+      - name: CCache Stats
+        if: matrix.settings.os != 'windows-latest'
+        shell: bash
+        run: |
+            source build/generators/conanbuild.sh
+            echo "Morpheus ccache show stats"
+            ccache -d $HOME/.ccache -svvz
+            echo "Morpheus show ccache log files"
+            cat $HOME/.ccache/CcacheLogFile.log
+            #echo "Morpheus showing ccache debug input files"
+            #find . -name "*.ccache-input-text" -exec cat {} +
+            #echo "Morpheus showing ccache debug log files"
+            #find . -name "*.ccache-log" -exec cat {} +
+            #ls -la $HOME/.ccache
+            #rm $HOME/.ccache/CcacheLogFile.log
+            #ls -la $HOME/.ccache
+
       - name: Test
         # Execute tests defined by the CMake configuration.
         # See https://cmake.org/cmake/help/latest/manual/ctest.1.html for more detail

diff --git a/.github/workflows/code_coverage.yml b/.github/workflows/code_coverage.yml
@@ -51,12 +51,9 @@ jobs:
           cache-name: cache-conan-data
         with:
           path: ${{github.workspace}}/.conan2/p
-          key: ${{ hashFiles('**/conanfile.py') }}-build-${{ matrix.settings.os }}-${{ matrix.configuration }}-${{ matrix.settings.compiler.conan }}-${{ matrix.settings.compiler.version }}-${{ matrix.settings.lib }}
+          key: ${{ hashFiles('**/conanfile.py') }}-code-coverage
           restore-keys: |
-            ${{ hashFiles('**/conanfile.py') }}-build-${{ matrix.settings.os }}-${{ matrix.configuration }}-${{ matrix.settings.compiler.conan }}-${{ matrix.settings.compiler.version }}-
-            ${{ hashFiles('**/conanfile.py') }}-build-${{ matrix.settings.os }}-${{ matrix.configuration }}-${{ matrix.settings.compiler.conan }}-
-            ${{ hashFiles('**/conanfile.py') }}-build-${{ matrix.settings.os }}-${{ matrix.configuration }}-
-            ${{ hashFiles('**/conanfile.py') }}-build-${{ matrix.settings.os }}-
+            ${{ hashFiles('**/conanfile.py') }}-code-coverage
 
       # Previously GCC was installed via egor-tensin/setup-gcc@v1 but this does not install gcov with the compiler.
       # By default Ubuntu has Gcov 11 installed. This worked so long as the compiler was gcc 11, but if a later gcc was
@@ -127,7 +124,14 @@ jobs:
         working-directory: ${{github.workspace}}
         shell: bash
         run: |
-          conan install "${{github.workspace}}" --build missing -o boost/*:without_cobalt=True
+          # In order to have ccache working correctly we can't build the catch library every time, otherwise the hash of the built files will
+          # change at every workflow run and then we will get cache misses. Therefore the --build catch2/3.4.0 option must be enabled only the
+          # first time in order to correctly build the cache for Conan packages. After the first build of the Conan cache the option must
+          # be removed for all the subsequent executions.
+          # The same procedure must be followed every time that it changes something in the conanfile.py.
+          # it's a bit tricky but it is what it is, this is what must be done in order to get 100% ccache hit rate.
+          #conan install "${{github.workspace}}" --build missing -c tools.cmake.cmaketoolchain:generator=Ninja --build catch2/3.4.0 --build gtest/1.14.0
+          conan install "${{github.workspace}}" --build missing -c tools.cmake.cmaketoolchain:generator=Ninja -o boost/*:without_cobalt=True
 
       - name: Conan Preset
         shell: bash
@@ -138,14 +142,58 @@ jobs:
         # See https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html?highlight=cmake_build_type
         run: |
            source build/${{env.BUILD_TYPE}}/generators/conanbuild.sh
-           cmake --preset ${{ env.CONAN_PRESET }} -DENABLE_CODE_COVERAGE=1
+           cmake --preset ${{ env.CONAN_PRESET }} -DENABLE_CODE_COVERAGE=1 -DCMAKE_CXX_COMPILER_LAUNCHER=ccache
+
+      - name: CCache Configure
+        shell: bash
+        run: |
+          source build/${{env.BUILD_TYPE}}/generators/conanbuild.sh
+          mkdir $HOME/.ccache
+          echo "CCACHE_HOME=$HOME/.ccache" >> $GITHUB_ENV
+
+      - name: Cache CCache data
+        uses: actions/cache@v3.3.2
+        with:
+          path: ${{ env.CCACHE_HOME }}
+          key: ccache-code-coverage-${{ github.run_number }}
+          restore-keys: |
+            ccache-code-coverage-
 
       - name: Build
         # Build your program with the given configuration
+        shell: bash
         run: |
            source build/${{env.BUILD_TYPE}}/generators/conanbuild.sh
+           export CCACHE_DIR=$HOME/.ccache
+           export CCACHE_SLOPPINESS=pch_defines,time_macros,include_file_mtime,include_file_ctime
+           export CCACHE_NOHASHDIR=1
+           export CCACHE_BASEDIR=${{ github.workspace }}
+           export CCACHE_LOGFILE=$HOME/.ccache/CcacheLogFile.log
+           #export CCACHE_DEBUG=1
+           #export CCACHE_UMASK=002
+           #export CCACHE_NOINODECACHE=1
+           #export CCACHE_RECACHE=1
+           #export CCACHE_DEBUGDIR=$HOME/.ccache/
+           echo "Morpheus ccache show configuration"
+           ccache -p
            cmake --build --preset ${{ env.CONAN_PRESET }}
 
+      - name: CCache Stats
+        shell: bash
+        run: |
+            source build/${{env.BUILD_TYPE}}/generators/conanbuild.sh
+            echo "Morpheus ccache show stats"
+            ccache -d $HOME/.ccache -svvz
+            echo "Morpheus showing ccache log file"
+            cat $HOME/.ccache/CcacheLogFile.log
+            #echo "Morpheus showing ccache debug log files"
+            #find . -name "*.ccache-log" -exec cat {} +
+            #echo "Morpheus showing ccache debug input files"
+            #find . -name "*.ccache-input-text" -exec cat {} +
+            #ls -la $HOME/.ccache
+            #rm $HOME/.ccache/CcacheLogFile.log
+            #ls -la $HOME/.ccache
+
       - name: Test
         working-directory: ${{github.workspace}}
         # Execute tests defined by the CMake configuration.

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -24,6 +24,7 @@ include(GNUInstallDirs)
 include(CMakeDependentOption)
 include(CMakePackageConfigHelpers)
 
+option(MORPHEUS_BUILD_WITH_CCACHE "Enable the CCache compiler caching" ON)
 option(MORPHEUS_RENDER_SYSTEM_DIRECT_X12 "Build with support for the Dirext X 12 render system" ON)
 option(MORPHEUS_RENDER_SYSTEM_METAL "Build with support for the Metal render system" ON)
 option(MORPHEUS_RENDER_SYSTEM_OPENGL "Build with support for the Open GL render system" ON)
@@ -46,6 +47,7 @@ list(APPEND CMAKE_PREFIX_PATH "${CMAKE_BINARY_DIR}" "${CMAKE_BINARY_DIR}/generat
 
 #------------------------------------------------------------------------------------------------------------------------------------------
 # Custom CMake Includes
+include(ccache)
 include(coverage)
 include(compiler)
 include(conformance)
@@ -82,7 +84,7 @@ set(CMAKE_BUILD_WITH_INSTALL_RPATH ON)
 set(CMAKE_SKIP_BUILD_RPATH  FALSE)
 
 get_property(IS_MULTI_CONFIG GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG)
-if(IS_MULTI_CONFIG)
+if (IS_MULTI_CONFIG)
     set(RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin/$<CONFIG>)
     set(LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib/$<CONFIG>)
     file(RELATIVE_PATH MORPHEUS_RELATIVE_BUILD_RPATH ${RUNTIME_OUTPUT_DIRECTORY} ${LIBRARY_OUTPUT_DIRECTORY})
@@ -100,6 +102,23 @@ endif()
 add_subdirectory(libraries)
 add_subdirectory(examples)
 
+#[[
+Ccache / Icecream options management
+In order to add/remove configuration options for ccache call the function enable_ccache with the following parameters:
+DEBUG to enable debugging
+ICECC to enable Icecream build support
+LOGFILE to enable ccache logging to file
+NOHASHDIR to exclude the current working directory from the cache hash
+QUIET Searches for the ccache executable, and if found enables it for supported language with specified options
+RECACHE ccache will not use any previously stored result. New results will overwrite any pre-existing results
+SLOPPINESS ccache to relax some checks in order to increase the hit rate of cache hits
+reference documentation: https://ccache.dev/documentation.html
+]]
+if (MORPHEUS_BUILD_WITH_CCACHE)
+    set(LANGUAGES CXX)
+    enable_ccache(QUIET LANGUAGES ICECC NOHASHDIR SLOPPINESS)
+endif()
+
 if (ENABLE_CODE_COVERAGE)
     enable_code_coverage()
 endif()
diff --git a/README.md b/README.md
@@ -58,10 +58,14 @@ To enable Mold linker usage for gcc and clang with Linux:
 conan install ./ -pr:h .conan2/profiles/gcc/12/x64-libstdc++11-debug -pr:b .conan2/profiles/gcc/12/x64-libstdc++11-debug --build missing
 source build/Debug/generators/conanbuild.sh # Access the environment variables needed to use the Mold linker with gcc and clang
 ```
-To disable Mold linker usage for gcc and clang with Linux:
+To disable Mold linker usage for compilers gcc and clang with Linux:
 ```bash
 conan install ./ -pr:h .conan2/profiles/gcc/12/x64-libstdc++11-debug -pr:b .conan2/profiles/gcc/12/x64-libstdc++11-debug --build missing -o link_with_mold=False
 ```
+To disable CCache usage for compilers gcc and clang with Linux and macOS:
+```bash
+conan install ./ -pr:h .conan2/profiles/gcc/12/x64-libstdc++11-debug -pr:b .conan2/profiles/gcc/12/x64-libstdc++11-debug --build missing -o build_with_ccache=False
+```
 Use the preset generated by Conan
 ```bash
 cmake --preset conan-debug
@@ -75,6 +79,7 @@ cmake --build --preset conan-debug
 ### Multi-Config Build
 
 Multi-config builds allow you to create a build folder containing sub-folders for different build configurations and build them side-by-side. Once again starting with the repository clone and Conan configured run the install stage, but this time we specity the Conan cmake tools use Ninja multi-config to generate `Release, Debug, RelWithDebInfo` configurations.  To generate all 3 configuration we run the `conan-default` preset which configures CMake for these configurations.
+Instructions about how to build the library with Visual Studio and Ninja Multi-Config can be found [here](./WINDOWS.md)
 ```bash
 conan install ./ -pr:h .conan2/profiles/msvc/193/x64-release -pr:b .conan2/profiles/msvc/193/x64-release --build missing -c tools.cmake.cmaketoolchain:generator="Ninja Multi-Config"
 source build/generators/conanbuild.sh # Access the environment variables needed to use the Mold linker with gcc and clang

diff --git a/VisualStudioInstall.png b/VisualStudioInstall.png