Davidp dr dev 01.devmods

.github/workflows/ci_build.yml

@@ -111,6 +111,61 @@ jobs:
         name: ${{ matrix.config.artifact }}
         path: .\gfxreconstruct-dev
 
+  macOS:
+    name: ${{ matrix.config.name }}
+    runs-on: ${{ matrix.config.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        config:
+        - {
+            name: "macOS Release",
+            os: macos-latest,
+            artifact: "gfxreconstruct-dev-macOS-release",
+            type: "release",
+            build_dir: "build"
+          }
+        - {
+            name: "macOS Debug",
+            os: macos-latest,
+            artifact: "gfxreconstruct-dev-macOS-debug",
+            type: "debug",
+            build_dir: "dbuild"
+          }
+    steps:
+    - name: Clone repository
+      uses: actions/checkout@v1
+    - name: Cache dependencies
+      id: cache-deps
+      uses: actions/cache@v3
+      with:
+        path: ~/deps
+        key: ${{ matrix.config.os }} deps ${{ hashFiles('.github/workflows/scripts/build-dependencies-macos.sh') }}
+    - name: Build dependencies
+      if: steps.cache-deps.outputs.cache-hit != 'true'
+      run: .github/workflows/scripts/build-dependencies-macos.sh
+    - name: Run build script
+      run: |
+        python3 scripts/build.py --skip-check-code-style --skip-tests --config ${{ matrix.config.type }} --cmake-extra "CMAKE_PREFIX_PATH=$HOME/deps" --cmake-extra CMAKE_OSX_DEPLOYMENT_TARGET=11.0
+    - name: Prepare artifacts
+      run: |
+        cp LICENSE.txt ${{ matrix.config.build_dir }}/darwin/universal/output/bin/
+        cp LICENSE_ThirdParty.txt ${{ matrix.config.build_dir }}/darwin/universal/output/bin/
+        cp USAGE_desktop_Vulkan.md ${{ matrix.config.build_dir }}/darwin/universal/output/bin/
+        cp layer/vk_layer_settings.txt ${{ matrix.config.build_dir }}/darwin/universal/output/bin/
+        mv ${{ matrix.config.build_dir }}/darwin/universal/output/bin gfxreconstruct-dev
+        mv ${{ matrix.config.build_dir }}/darwin/universal/output/lib*/*.dylib gfxreconstruct-dev/
+        mv ${{ matrix.config.build_dir }}/darwin/universal/output/share/vulkan/explicit_layer.d/*.json gfxreconstruct-dev/
+        # GitHub's artifact uploader doesn't preserve permissions, so zip everything ourselves
+        # This will result in a zip in a zip, but Finder's unzip will conveniently unzip both at once, so it's not too bad
+        cd gfxreconstruct-dev
+        zip -r9 "../${{ matrix.config.artifact }}.zip" *
+    - name: Upload artifacts
+      uses: actions/upload-artifact@v1
+      with:
+        name: ${{ matrix.config.artifact }}
+        path: ${{ matrix.config.artifact }}.zip
+
   android:
     name: ${{ matrix.config.name }}
     runs-on: ${{ matrix.config.os }}

.github/workflows/scripts/build-dependencies-macos.sh

@@ -0,0 +1,48 @@
+#!/bin/bash
+
+set -e
+
+export MACOSX_DEPLOYMENT_TARGET=11.0
+
+INSTALLDIR="${INSTALLDIR:-"$HOME/deps"}"
+NPROCS="${NPROCS:-$(getconf _NPROCESSORS_ONLN)}"
+ZSTD=1.5.5
+LZ4=1.9.4
+
+mkdir deps-build
+cd deps-build
+
+export PKG_CONFIG_PATH="$INSTALLDIR/lib/pkgconfig:$PKG_CONFIG_PATH"
+export CFLAGS="-I$INSTALLDIR/include -Os $CFLAGS"
+export CXXFLAGS="-I$INSTALLDIR/include -Os $CXXFLAGS"
+
+cat > SHASUMS <<EOF
+9c4396cc829cfae319a6e2615202e82aad41372073482fce286fac78646d3ee4  zstd-$ZSTD.tar.gz
+0b0e3aa07c8c063ddf40b082bdf7e37a1562bda40a0ff5272957f3e987e0e54b  lz4-$LZ4.tar.gz
+EOF
+
+curl -L \
+	-O "https://github.com/facebook/zstd/releases/download/v$ZSTD/zstd-$ZSTD.tar.gz" \
+	-O "https://github.com/lz4/lz4/releases/download/v$LZ4/lz4-$LZ4.tar.gz" \
+
+shasum -a 256 --check SHASUMS
+
+echo "Installing lz4..."
+tar xf "lz4-$LZ4.tar.gz"
+cd "lz4-$LZ4"
+cmake -B build-dir build/cmake -DCMAKE_OSX_ARCHITECTURES="x86_64;arm64" -DCMAKE_PREFIX_PATH="$INSTALLDIR" -DCMAKE_INSTALL_PREFIX="$INSTALLDIR" -DBUILD_SHARED_LIBS=OFF -DBUILD_STATIC_LIBS=ON -DCMAKE_BUILD_TYPE=MinSizeRel
+make -C build-dir "-j$NPROCS"
+make -C build-dir install
+cd ..
+
+echo "Installing zstd..."
+tar xf "zstd-$ZSTD.tar.gz"
+cd "zstd-$ZSTD"
+cmake -B build-dir build/cmake -DCMAKE_OSX_ARCHITECTURES="x86_64;arm64" -DCMAKE_PREFIX_PATH="$INSTALLDIR" -DCMAKE_INSTALL_PREFIX="$INSTALLDIR" -DZSTD_BUILD_SHARED=OFF -DCMAKE_BUILD_TYPE=MinSizeRel
+make -C build-dir "-j$NPROCS"
+make -C build-dir install
+cd ..
+
+echo "Cleaning up..."
+cd ..
+rm -r deps-build

.gitignore

@@ -7,3 +7,6 @@ __pycache__/
 .vscode/
 *.db
 *.pyc
+*.rdbg
+._*
+.DS_Store

CMakeLists.txt

@@ -40,7 +40,7 @@ set(CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake" "${CMAKE_SOURCE_DIR}/external/
 # Version info
 set(GFXRECONSTRUCT_PROJECT_VERSION_MAJOR 1)
 set(GFXRECONSTRUCT_PROJECT_VERSION_MINOR 0)
-set(GFXRECONSTRUCT_PROJECT_VERSION_PATCH 0)
+set(GFXRECONSTRUCT_PROJECT_VERSION_PATCH 3)
 
 set(GFXRECON_PROJECT_VERSION_SHA1 "unknown-build-source")
 
@@ -104,6 +104,7 @@ option(BUILD_WERROR "Build with warnings as errors" ON)
 include("CodeStyle")
 include("Lint")
 include("Test")
+include("FindVulkanVersion")
 
 # Apply misc build directives to the given target
 macro(common_build_directives TARGET)
@@ -202,6 +203,7 @@ if(MSVC)
         endif() # GFXRECON_AGS_SUPPORT
     endif() # D3D12_SUPPORT
 
+
 else(MSVC)
     # Turn off D3D12 support for non MSVC builds.
     set(D3D12_SUPPORT OFF)
@@ -217,6 +219,10 @@ else(MSVC)
     endif()
 endif(MSVC)
 
+if(APPLE)
+    add_link_options(-Wl,-dead_strip -Wl,-dead_strip_dylibs)
+endif()
+
 # GFXReconstruct provided find modules
 if(WIN32)
 find_package(Detours)
@@ -225,7 +231,11 @@ endif() # WIN32
 find_package(LZ4)
 find_package(ZSTD)
 
-if(UNIX)
+if(MSVC)
+find_package(jsoncpp)
+endif() # MSVC
+
+if(UNIX AND NOT APPLE)
     option(BUILD_WSI_XCB_SUPPORT "Build XCB WSI support" ON)
     option(BUILD_WSI_WAYLAND_SUPPORT "Build Wayland WSI support" ON)
     option(BUILD_WSI_DISPLAY_SUPPORT "Build direct-to-display swapchain support" ON)
@@ -237,20 +247,20 @@ if(UNIX)
     if(BUILD_WSI_WAYLAND_SUPPORT)
         find_package(WAYLAND)
     endif()
-endif(UNIX)
+endif(UNIX AND NOT APPLE)
 
 # CMake provided find modules
 if(BUILD_STATIC)
     find_library(ZLIB NAMES libz.a REQUIRED PATH_SUFFIXES lib lib/x86_64-linux-gnu lib64)
 else()
     find_package(ZLIB)
 endif()
-if(UNIX)
+if(UNIX AND NOT APPLE)
     option(BUILD_WSI_XLIB_SUPPORT "Build Xlib WSI support" ON)
     if(BUILD_WSI_XLIB_SUPPORT)
         find_package(X11)
     endif()
-endif(UNIX)
+endif(UNIX AND NOT APPLE)
 
 add_library(windows_specific INTERFACE)
 
@@ -274,25 +284,32 @@ target_compile_definitions(linux_specific INTERFACE _FILE_OFFSET_BITS=64 PAGE_GU
     $<$<BOOL:${BUILD_WSI_DISPLAY_SUPPORT}>:VK_USE_PLATFORM_DISPLAY_KHR>
     $<$<BOOL:${HEADLESS}>:VK_USE_PLATFORM_HEADLESS>)
 
+add_library(macos_specific INTERFACE)
+target_compile_definitions(macos_specific INTERFACE
+    VK_USE_PLATFORM_METAL_EXT
+    $<$<BOOL:${HEADLESS}>:VK_USE_PLATFORM_HEADLESS>)
+
 add_library(platform_specific INTERFACE)
 target_link_libraries(platform_specific INTERFACE
     $<$<BOOL:${WIN32}>:windows_specific>
-    $<$<NOT:$<BOOL:${WIN32}>>:linux_specific>)
+    $<$<BOOL:${APPLE}>:macos_specific>
+    $<$<NOT:$<OR:$<BOOL:${WIN32}>,$<BOOL:${APPLE}>>>:linux_specific>)
 
 if(BUILD_WERROR)
     if(MSVC)
         target_compile_options(platform_specific INTERFACE /WX)
     else()
         target_compile_options(platform_specific INTERFACE -Werror)
+        if(CMAKE_CXX_COMPILER_ID MATCHES "Clang")
+            # TODO: Actually fix these warnings
+            target_compile_options(platform_specific INTERFACE -Wno-error=switch)
+        endif()
     endif()
 endif()
 
-if(NOT EXISTS ${CMAKE_SOURCE_DIR}/external/Vulkan-Headers)
-    message(FATAL_ERROR "The Vulkan-Headers submodule has not been initialized! Please run `git submodule update --init` in the source directory.")
-endif()
-
-add_subdirectory(${CMAKE_SOURCE_DIR}/external/Vulkan-Headers)
-target_compile_definitions(Vulkan-Headers INTERFACE VK_NO_PROTOTYPES VK_ENABLE_BETA_EXTENSIONS)
+add_library(vulkan_registry INTERFACE)
+target_include_directories(vulkan_registry INTERFACE ${CMAKE_SOURCE_DIR}/external/Vulkan-Headers/include)
+target_compile_definitions(vulkan_registry INTERFACE VK_NO_PROTOTYPES VK_ENABLE_BETA_EXTENSIONS)
 
 add_library(vulkan_memory_allocator INTERFACE)
 target_compile_options(vulkan_memory_allocator INTERFACE

HOWTO_android.md

@@ -57,13 +57,48 @@ is to be used in all cases below for `{gfxreconstruct_root}`.
 git clone --recurse-submodules https://github.com/KhronosGroup/Vulkan-Samples.git
 ```
 
+Alternatively, if this is not the first time the tree is cloned, simply enter
+the folder containing the source and update to the latest, but also make sure
+that the submodules are re-inited and updated (because additional submodules may
+have been added).
+
+```bash
+cd Vulkan-Samples
+git pull
+git submodule init
+git submodule update --recursive
+```
+
 ### 3. Enter the Vulkan Samples source directory
 
 ```bash
 cd Vulkan-Samples
 ```
 
-### 4. Build the gradle files
+### 4. Build the necessary Android files
+
+To build/setup the Vulkan-Samples source for Android, follow the instructions in
+[the README](https://github.com/KhronosGroup/Vulkan-Samples/blob/main/docs/build.adoc#android)
+found in that GitHub repo.
+
+Follow these instructions up until the instructions to activate the build using
+Gradle, and then stop until GFXReconstruct has been enabled.
+
+In a nutshell, the following command should be executed to generate the
+necessary files, but it has been known to change:
+
+#### Current Vulkan-Samples Android generation
+
+On a clean tree, the first step is to generate the necessary Android files:
+
+```bash
+python3 scripts/generate.py android
+```
+
+#### Previous Vulkan-Samples Android generation
+
+On some older versions of `Vulkan-Samples` the Android files were
+generated using a different script:
 
 ```bash
 ./bldsys/scripts/generate_android_gradle.sh

USAGE_android.md

@@ -751,7 +751,9 @@ usage: gfxrecon.py replay [-h] [--push-file LOCAL_FILE] [--version] [--pause-fra
                           [--measurement-file DEVICE_FILE] [--quit-after-measurement-range]
                           [--flush-measurement-range] [-m MODE]
                           [--swapchain MODE] [--use-captured-swapchain-indices]
-                          [file]
+                          [--use-colorspace-fallback] [--dump-resources <dump-args>]
+                          [--dump-resources-before-draw] [--dump-resources-scale <scale>]
+                          [--dump-resources-dir <fir>] [file]
 
 Launch the replay tool.
 
@@ -858,17 +860,44 @@ optional arguments:
                         If this is specified the replayer will flush and wait
                         for all current GPU work to finish at the start and end
                         of the measurement range. (forwarded to replay tool)
+  --flush-inside-measurement-range
+                        If this is specified the replayer will flush and wait
+                        for all current GPU work to finish at the end of each
+                        frame inside the measurement range. (forwarded to replay tool)
+  --use-colorspace-fallback
+                        Swap the swapchain color space if unsupported by replay device.
+                        Check if color space is not supported by replay device and swap
+                        to VK_COLOR_SPACE_SRGB_NONLINEAR_KHR. (forwarded to replay tool).
+  --dump-resources <filename>
+              Extract --dump-resources args from the specified file, with each line in the file containing a comma or space separated
+              list of the parameters to --dump-resources. The file can contain multiple lines specifying multiple dumps.
+  --dump-resources <filename>.json
+              Extract --dump-resource args from the specified json file. The format for the json file is documented in detail
+              in the gfxreconstruct documentation.
+  --dump-resources-image-format <format>
+                        Image file format to use for image resource dumping.
+                        Available formats are:
+                            bmp         Bitmap file format.  This is the default format.
+                            png         Png file format.
+  --dump-resources-before-draw
+              In addition to dumping gpu resources after the CmdDraw, CmdDispatch and CmdTraceRays calls specified by the
+              --dump-resources argument, also dump resources before those calls.
+  --dump-resources-scale <scale>
+              Scale images generated by dump resources by the given scale factor. The scale factor must be a floating point number
+              greater than 0. Values greater than 10 are capped at 10. Default value is 1.0.
+  --dump-resources-dir <dir>
+              Directory to write dump resources output files. Default is the current working directory.
 ```
 
 The command will force-stop an active replay process before starting the replay
 activity with the following:
 
 ```bash
 adb shell am force-stop com.lunarg.gfxreconstruct.replay
-adb shell am start -n "com.lunarg.gfxreconstruct.replay/android.app.NativeActivity" \ 
-                   -a android.intent.action.MAIN \ 
-                   -c android.intent.category.LAUNCHER \ 
-                   --es "args" \ 
+adb shell am start -n "com.lunarg.gfxreconstruct.replay/android.app.NativeActivity" \
+                   -a android.intent.action.MAIN \
+                   -c android.intent.category.LAUNCHER \
+                   --es "args" \
                    "<arg-list>"
 ```
 

USAGE_desktop_Vulkan.md

@@ -394,7 +394,10 @@ gfxrecon-replay         [-h | --help] [--version] [--gpu <index>]
                         [--measurement-file <file>] [--quit-after-measurement-range]
                         [--flush-measurement-range]
                         [--log-level <level>] [--log-file <file>] [--log-debugview]
-                        [--api <api>] [--no-debug-popup] <file>
+                        [--api <api>] [--no-debug-popup] [--use-colorspace-fallback]
+                        [--dump-resources <dump-args>] [--dump-resources-before-draw]
+                        [--dump-resources-scale <scale>] [--dump-resources-dir <dir>]
+                        [--dump-resources-image-format <format>] <file>
 
 Required arguments:
   <file>                Path to the capture file to replay.
@@ -531,6 +534,46 @@ Optional arguments:
               If this is specified the replayer will flush
               and wait for all current GPU work to finish at the
               start and end of the measurement range.
+  --flush-inside-measurement-range
+              If this is specified the replayer will flush and wait
+              for all current GPU work to finish at the end of each
+              frame inside the measurement range.
+  --use-colorspace-fallback
+              Swap the swapchain color space if unsupported by replay device.
+              Check if color space is not supported by replay device and
+              fallback to VK_COLOR_SPACE_SRGB_NONLINEAR_KHR.
+  --dump-resources BeginCommandBuffer=<n>,Draw=<n>,BeginRenderPass=<n>,NextSubPass=<n>,EndRenderPass=<n>,Dispatch=<n>,TraceRays=<n>,QueueSubmit=<n>
+              Dump gpu resources after the given vmCmdDraw*, vkCmdDispatch, or vkCmdTraceRaysKHR is replayed. The parameter for
+              each is a block index from the capture file.  The additional parameters are used to identify during which occurence
+              of the vkCmdDraw/VkCmdDispath/VkCmdTrancRaysKHR resources will be dumped.  NextSubPass can be repeated 0 or more times to
+              indicate subpasses withing a render pass.  Note that the minimal set of parameters must be one of:
+                  BeginCmdBuffer, Draw, BeginRenderPass, EndRenderPass, and QueueSubmit
+                  BeginCmdBuffer, Dispatch and QueueSubmit
+                  BeginCmdBuffer, TraceRays and QueueSubmit
+  --dump-resources <filename>
+              Extract --dump-resources args from the specified file, with each line in the file containing a comma or space separated
+              list of the parameters to --dump-resources. The file can contain multiple lines specifying multiple dumps.
+  --dump-resources <filename>.json
+              Extract --dump-resource args from the specified json file. The format for the json file is documented in detail
+              in the gfxreconstruct documentation.
+  --dump-resources-image-format <format>
+                        Image file format to use for image resource dumping.
+                        Available formats are:
+                            bmp         Bitmap file format.  This is the default format.
+                            png         Png file format.
+  --dump-resources-before-draw
+              In addition to dumping gpu resources after the CmdDraw, CmdDispatch and CmdTraceRays calls specified by the
+              --dump-resources argument, also dump resources before those calls.
+  --dump-resources-scale <scale>
+              Scale images generated by dump resources by the given scale factor. The scale factor must be a floating point number
+              greater than 0. Values greater than 10 are capped at 10. Default value is 1.0.
+
+  --dump-resources-dir <dir>
+              Directory to write dump resources output files. Default is the current working directory.
+
+  --dump-resources-image-format <format>
+              Image file format to use when dumping image resources. Available formats are: bmp, png
+
 ```
 
 ### Key Controls