Autodesk: build_usd.py now installs Vulkan dependencies #3603

erikaharrison-adsk · 2025-04-16T22:43:21Z

Description of Change(s)

Using build_usd.py, build and install:
- Vulkan-Headers
- Vulkan-Utility-Libraries
- Vulkan-Loader
- SPIRV-Reflect
- VulkanMemoryAllocator
- shaderc
Only the required build and runtime files are installed. Tools and debug binaries (like validation layers) are expected to be installed externally (by the Vulkan SDK).
All versions match the ones from Vulkan SDK 1.3.296.0 (last 1.3.x release)
Removed third party files from hgiVulkan, they are now handled by build_usd.py
- We had to do some small code changes in hgiVulkan in order to better use the third party dependencies
Installing the Vulkan ICD loader will prevent load-time link issues if no Vulkan enabled graphics driver is installed
- This is an uncommon situation, but we've had it happen, especially in VMs
- This is an allowed use case for distributing the ICD
Using the Vulkan SDK is still supported
- When using the new argument --use-vulkan-sdk
- When not using build_usd.py
Use BUILD_LOCAL_INTERFACE to keep the hgiVulkan private dependencies out of the pxr target export.
- This makes it simpler for client projects to import the pxr targets. You don't need to link against as many targets.
- It's still possible to manually do find_package (using the USD install path) and link against the installed Vulkan dependencies.
Add the Vulkan dependencies to pxrConfig.cmake.
- Make it even simpler for client projects. It also takes care of the Vulkan SDK and build_usd.py differences.
- Only the public dependencies (not wrapped in BUILD_LOCAL_INTERFACE) need to be found.

Link to proposal (if applicable)

N/A

Fixes Issue(s)

N/A

Checklist

I have created this PR based on the dev branch
I have followed the coding conventions
I have added unit tests that exercise this functionality (Reference:
testing guidelines)
I have verified that all unit tests pass with the proposed changes
I have submitted a signed Contributor License Agreement (Reference:
Contributor License Agreement instructions)

jesschimein · 2025-04-17T17:20:37Z

Filed as internal issue #USD-10914

(This is an automated message. See here for more information.)

jesschimein · 2025-04-17T17:20:40Z

/AzurePipelines run

DarkDefender · 2025-04-22T13:07:54Z

I've tested this out and it works really well besides two issues:

If I build VulkanMemoryAllocator myself using the default build options for it (not using the build_usd.py script), building openUSD will fail. I would change this so that we always use #include <vk_mem_alloc.h>. Then when using the VULKAN_SDK, we add $ENV{VULKAN_SDK}/include/vma to the default include directories. This way people can use the default/standard VulkanMemoryAllocator without any issues.
When building with GCC 14 on my machine, pxr/imaging/hgiVulkan/sampler.cpp fails to compile because of a missing include. Simply adding #include <algorithm> in the file will solve the build issue.

DDoS · 2025-04-22T14:20:19Z

I've tested this out and it works really well besides two issues:

1. If I build VulkanMemoryAllocator myself using the default build options for it (not using the `build_usd.py` script), building openUSD will fail. I would change this so that we always use `#include <vk_mem_alloc.h>`. Then when using the VULKAN_SDK, we add `$ENV{VULKAN_SDK}/include/vma` to the default include directories. This way people can use the default/standard VulkanMemoryAllocator without any issues.

2. When building with GCC 14 on my machine, `pxr/imaging/hgiVulkan/sampler.cpp` fails to compile because of a missing include. Simply adding `#include <algorithm>` in the file will solve the build issue.

Thanks for the feedback, I made some changes, let me know if that fixes your issues.

DarkDefender · 2025-04-22T16:29:37Z

I can confirm that it fixes my issues! Thanks! :)

jesschimein · 2025-04-22T17:31:56Z

/AzurePipelines run

DarkDefender · 2025-04-23T09:33:04Z

@DDoS the new commit breaks compilation for me.
The build now errors out with spirv_reflect not being able to find the spirv headers anymore:

pxr/imaging/hgiVulkan/shaderCompiler.cpp
In file included from pxr/imaging/hgiVulkan/shaderCompiler.cpp:15:
/usr/include/spirv_reflect.h:37:10: fatal error: ./include/spirv/unified1/spirv.h: No such file or directory
   37 | #include "./include/spirv/unified1/spirv.h"
      |          ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
compilation terminated.

If I skip the new commit and just apply the build_usd.py now installs Vulkan dependencies commit, everything compiles fine again.

Seems like your changes somehow broke the logic for passing SPIRV_REFLECT_USE_SYSTEM_SPIRV_H to spirv_reflect

DDoS · 2025-04-23T14:36:25Z

@DarkDefender can you please share your spirv-reflect_* cache variable values?

DarkDefender · 2025-04-23T17:04:15Z

@DDoS if I grep the cmake cache file I get these two:

spirv-reflect_INCLUDE_DIR:PATH=/usr/include
spirv-reflect_LIBRARY:FILEPATH=/usr/lib/libspirv-reflect-static.a

DDoS · 2025-04-23T17:19:57Z

@DarkDefender can you add some debug message() to this condition if (SpirvReflect_FOUND AND NOT EXISTS "${spirv-reflect_INCLUDE_DIR}/include/spirv/unified1/spirv.h") in FindSpirvReflect.cmake to see what the result is?

DarkDefender · 2025-04-23T17:35:59Z

cmake/defaults/Packages.cmake

+
+        # In either case we have custom logic for SPIRV-Reflect
+        find_package(SpirvReflect MODULE REQUIRED)
+        list(APPEND VULKAN_LIBS $<BUILD_LOCAL_INTERFACE:spirv-reflect>)


If I change this back to list(APPEND VULKAN_LIBS spirv-reflect) it seems to work.
I'm guessing that the SpirvReflect_IS_SOURCE_DEP check is needed here.

That's strange, I didn't expect this to make a difference. I'll have to try harder and reproduce this issue locally to debug. Thanks for helping out.

DarkDefender · 2025-04-23T17:47:12Z

@DarkDefender can you add some debug message() to this condition if (SpirvReflect_FOUND AND NOT EXISTS "${spirv-reflect_INCLUDE_DIR}/include/spirv/unified1/spirv.h") in FindSpirvReflect.cmake to see what the result is?

The debug message() gets triggered for me. target_compile_definitions(spirv-reflect INTERFACE SPIRV_REFLECT_USE_SYSTEM_SPIRV_H) should be executed.

jesschimein · 2025-04-23T18:10:29Z

/AzurePipelines run

DDoS · 2025-04-24T16:12:42Z

@DarkDefender Which CMake version are you using? Which build system?

I really can't reproduce this issue. When I build with build_usd.py, SPIRV_REFLECT_USE_SYSTEM_SPIRV_H is enabled, and spirv.h is found.

jesschimein · 2025-04-24T17:00:33Z

/AzurePipelines run

DarkDefender · 2025-04-24T17:35:23Z

@DDoS I'm using cmake 3.31.7 and ninja.

Are you sure that the build_usd.py script doesn't copy in the spirv/unified1/spirv.h header?
The CopyDirectory(context, 'include/spirv', 'include/spirv') line makes me a bit suspicious that this might be the case.
If this is the case you wouldn't really notice that SPIRV_REFLECT_USE_SYSTEM_SPIRV_H doesn't get picked up as it will find the spirv.h header that is bundled with spirv-reflect.

DDoS · 2025-04-24T18:10:51Z

@DarkDefender The relevant build_usd.py include paths are

include
- spirv_reflect.h
- spirv
  - unified1
    - spirv.h

When SPIRV_REFLECT_USE_SYSTEM_SPIRV_H is undefined, the path relative to spirv_reflect.h needs to start with include (./include/spirv/unified1/spirv.h), which here it doesn't. Furthermore I can check the compiler command line in build.ninja and see that -DSPIRV_REFLECT_USE_SYSTEM_SPIRV_H is given when building shaderCompiler.o.

Since it appears you're using a system package manager install of spirv-reflect, can you confirm the header does support this define? It was added three years ago: KhronosGroup/SPIRV-Reflect@f2241d5 (sdk-1.3.216.0).

DarkDefender · 2025-04-24T18:47:32Z

@DDoS I am using the latest git version of https://github.com/KhronosGroup/SPIRV-Reflect
It does have SPIRV_REFLECT_USE_SYSTEM_SPIRV_H as it wouldn't have worked before if that wasn't the case.

It seems like on my end list(APPEND VULKAN_LIBS $<BUILD_LOCAL_INTERFACE:spirv-reflect>) will ignore that we set SPIRV_REFLECT_USE_SYSTEM_SPIRV_H with target_compile_definitions(spirv-reflect INTERFACE SPIRV_REFLECT_USE_SYSTEM_SPIRV_H) while list(APPEND VULKAN_LIBS spirv-reflect) doesn't.

I'm not sure why though.

DDoS · 2025-04-24T20:29:13Z

@DDoS I am using the latest git version of https://github.com/KhronosGroup/SPIRV-Reflect It does have SPIRV_REFLECT_USE_SYSTEM_SPIRV_H as it wouldn't have worked before if that wasn't the case.

It seems like on my end list(APPEND VULKAN_LIBS $<BUILD_LOCAL_INTERFACE:spirv-reflect>) will ignore that we set SPIRV_REFLECT_USE_SYSTEM_SPIRV_H with target_compile_definitions(spirv-reflect INTERFACE SPIRV_REFLECT_USE_SYSTEM_SPIRV_H) while list(APPEND VULKAN_LIBS spirv-reflect) doesn't.

I'm not sure why though.

This almost feels like a CMake bug. I'm using 3.31.6, we're only one patch version off. Could you downgrade and test again?

DarkDefender · 2025-04-25T09:50:48Z

I tried with the cmake 3.31.6 version, no change.
I also tried to see if I can reproduce the issue with the build_usd.py and I can.
This is the command I use to reproduce the issue:

python build_scripts/build_usd.py --build-monolithic --no-python --vulkan --no-openvdb --no-embree --no-openimageio --no-opencolorio --no-alembic --no-hdf5 --no-draco --no-materialx --no-mayapy-tests --no-animx-tests --no-tutorials --no-docs --no-python-docs --no-examples --no-tests /tmp/usd_build/

@DDoS Can you see if it also triggers on your machine with the same flags to build_usd.py?
If it makes any difference, the build_usd.py uses make as the build system here.

DarkDefender · 2025-04-25T09:52:47Z

build_scripts/build_usd.py

+        ]
+        RunCMake(context, force, extraArgs)
+        CopyFiles(context, 'spirv_reflect.h', 'include')
+        CopyDirectory(context, 'include/spirv', 'include/spirv')


I think we should remove this as the spirv header file is not used and is not supposed to be used.

This header is the one included by spirv_reflect.h. It's needed.

Ah, you are right. Never mind. I somehow got the idea that the build script also installed the spirv headers. But it doesn't. Sorry for the noise.

DarkDefender · 2025-04-25T10:06:10Z

@DDoS Seems like the --build-monolithic is what show cases the issue.
If I build a non monolithic library, it works.

So I'm guessing that there are some flags that doesn't get passed on properly in the monolithic build or something.

DDoS · 2025-04-25T16:34:32Z

@DarkDefender Thanks for digging deeper into this! I never tried a monolithic build before, I'll give it a try, and fingers crossed that will reproduce the issue. I think I already have an idea of what the problem may be.

Update: I can confirm this reproduces the issue!

tallytalwar · 2025-04-25T20:21:31Z

/AzurePipelines run

tallytalwar · 2025-04-25T20:23:01Z

/AzurePipelines run

DDoS · 2025-04-25T21:01:46Z

@DarkDefender this should fix the problem. Let me know if it works now, thanks.

DarkDefender · 2025-04-28T10:15:58Z

Seems to build fine for me now again! :)

I just have one last bit of feedback. (See my review comment)

DarkDefender · 2025-04-28T10:16:38Z

cmake/modules/FindSpirvReflect.cmake

+if (SpirvReflect_FOUND AND NOT EXISTS "${spirv-reflect_INCLUDE_DIR}/include/spirv/unified1/spirv.h")
+    # Most probably not from the Vulkan SDK, so use a "system path."
+    # If installed from build_usd.py this will be found in the USD install path.
+    if (SpirvReflect_IS_SOURCE_DEP)


I don't think this is defined anymore so this will always be false?

Fixed! Good catch, I think this somehow got lost in the cherry-pick.

DarkDefender · 2025-04-28T16:39:11Z

pxr/imaging/hgiVulkan/sampler.cpp

@@ -12,7 +12,7 @@
 #include "pxr/imaging/hgiVulkan/sampler.h"
 #include "pxr/imaging/hgiVulkan/diagnostic.h"

-#include <float.h>


Just one last thing I noticed.
On older gcc versions (GCC 11), this include or #include <cfloat> is needed because it can't find the definition of FLT_MAX otherwise. Don't know why this isn't needed in newer gcc versions, but I don't think we do any harm by explicitly including <cfloat>

jesschimein · 2025-04-28T20:20:34Z

/AzurePipelines run

DarkDefender · 2025-04-29T09:26:04Z

All seems to be working fine on my side now! Thank you so much for all the back and forth! :)

jesschimein · 2025-04-29T17:25:41Z

/AzurePipelines run

DDoS force-pushed the adsk/feature/vk-install branch from 3808f58 to 901ee01 Compare April 22, 2025 14:19

DarkDefender reviewed Apr 23, 2025

View reviewed changes

DarkDefender reviewed Apr 25, 2025

View reviewed changes

DDoS force-pushed the adsk/feature/vk-install branch from 887d0aa to 2a82301 Compare April 25, 2025 20:55

DarkDefender reviewed Apr 28, 2025

View reviewed changes

DDoS force-pushed the adsk/feature/vk-install branch from 2a82301 to c1663f8 Compare April 28, 2025 15:01

DarkDefender reviewed Apr 28, 2025

View reviewed changes

DDoS added 2 commits April 28, 2025 13:08

build_usd.py now installs Vulkan dependencies

9d89d90

Add Vulkan dependencies to pxrConfig.cmake

b8db3a3

DDoS force-pushed the adsk/feature/vk-install branch from c1663f8 to b8db3a3 Compare April 28, 2025 17:09

erikaharrison-adsk mentioned this pull request Apr 29, 2025

Autodesk: Delay-load vulkan dlls on Windows #3152

Closed

2 tasks

Autodesk: build_usd.py now installs Vulkan dependencies #3603

Are you sure you want to change the base?

Autodesk: build_usd.py now installs Vulkan dependencies #3603

Conversation

erikaharrison-adsk commented Apr 16, 2025 • edited Loading

Description of Change(s)

Link to proposal (if applicable)

Fixes Issue(s)

Checklist

jesschimein commented Apr 17, 2025

jesschimein commented Apr 17, 2025

DarkDefender commented Apr 22, 2025 • edited Loading

DDoS commented Apr 22, 2025

DarkDefender commented Apr 22, 2025

jesschimein commented Apr 22, 2025

DarkDefender commented Apr 23, 2025 • edited Loading

DDoS commented Apr 23, 2025

DarkDefender commented Apr 23, 2025

DDoS commented Apr 23, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DarkDefender commented Apr 23, 2025

jesschimein commented Apr 23, 2025

DDoS commented Apr 24, 2025 • edited Loading

jesschimein commented Apr 24, 2025

DarkDefender commented Apr 24, 2025

DDoS commented Apr 24, 2025 • edited Loading

DarkDefender commented Apr 24, 2025

DDoS commented Apr 24, 2025

DarkDefender commented Apr 25, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DarkDefender commented Apr 25, 2025

DDoS commented Apr 25, 2025 • edited Loading

tallytalwar commented Apr 25, 2025

tallytalwar commented Apr 25, 2025

DDoS commented Apr 25, 2025

DarkDefender commented Apr 28, 2025 • edited Loading

DarkDefender Apr 28, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jesschimein commented Apr 28, 2025

DarkDefender commented Apr 29, 2025

jesschimein commented Apr 29, 2025

erikaharrison-adsk commented Apr 16, 2025 •

edited

Loading

DarkDefender commented Apr 22, 2025 •

edited

Loading

DarkDefender commented Apr 23, 2025 •

edited

Loading

DDoS commented Apr 24, 2025 •

edited

Loading

DDoS commented Apr 24, 2025 •

edited

Loading

DarkDefender commented Apr 25, 2025 •

edited

Loading

DDoS commented Apr 25, 2025 •

edited

Loading

DarkDefender commented Apr 28, 2025 •

edited

Loading

DarkDefender Apr 28, 2025 •

edited

Loading