WIP: Build: Shared Libraries Not Included in Buildtime Platform Vars #115790

Jeroen Bakker · 2023-12-05T11:06:36+01:00

Jeroen Bakker commented

2023-12-05 11:06:36 +01:00

When building on Linux Sycl shared libraries could not be found when
using the PLATORM_ENV_BUILD* variables. On Windows Sycl and
OIIO, Embree and cycles shared libraries where not available.

Cause: Sycl library uses a custom way of bundling its
libraries. This updated the PLATFORM_BUNDLED_LIBRARIES, but didn't
update PLATFORM_BUNDLED_LIBRARY_DIRS.

PLATFORM_BUNDLIED_LIBRARY_DIRS is used to populate
PLATFORM_ENV_BUILD_DIRS and PLATFORM_ENV_BUILD.

On Windows the search path is hard coded.

When building on Linux Sycl shared libraries could not be found when using the PLATORM_ENV_BUILD* variables. On Windows Sycl and OIIO, Embree and cycles shared libraries where not available. Cause: Sycl library uses a custom way of bundling its libraries. This updated the PLATFORM_BUNDLED_LIBRARIES, but didn't update PLATFORM_BUNDLED_LIBRARY_DIRS. PLATFORM_BUNDLIED_LIBRARY_DIRS is used to populate PLATFORM_ENV_BUILD_DIRS and PLATFORM_ENV_BUILD. On Windows the search path is hard coded.

Jeroen Bakker added this to the 4.1 milestone 2023-12-05 11:06:36 +01:00

Jeroen Bakker added the

Platform

Linux

label 2023-12-05 11:06:36 +01:00

Jeroen Bakker self-assigned this 2023-12-05 11:06:36 +01:00

Jeroen Bakker added 1 commit 2023-12-05 11:06:41 +01:00

26e8a8cf15 Build: Sycl Not Included in Buildtime Platform Vars

When building on Linux the Sycl libraries could not be found when
using the PLATORM_ENV_BUILD* variables.

Cause: Sycl library under Linux uses a custom way of bundling its
libraries. This updated the PLATFORM_BUNDLED_LIBRARIES, but didn't
update PLATFORM_BUNDLED_LIBRARY_DIRS.

PLATFORM_BUNDLIED_LIBRARY_DIRS is used to populate
PLATFORM_ENV_BUILD_DIRS and PLATFORM_ENV_BUILD.

Jeroen Bakker requested review from Campbell Barton 2023-12-05 11:07:21 +01:00

Jeroen Bakker added this to the Platforms, Builds Tests & Devices project 2023-12-05 11:07:35 +01:00

Jeroen Bakker referenced this pull request

2023-12-05 11:10:03 +01:00

Shader Builder issues. #115748

Jeroen Bakker added 1 commit 2023-12-05 12:41:35 +01:00

19c3e789ac Add windows

Jeroen Bakker added 1 commit 2023-12-05 12:42:44 +01:00

662718acdf Use same style as linux

Jeroen Bakker requested review from Ray molenkamp 2023-12-05 12:43:02 +01:00

Jeroen Bakker added the

Platform

Windows

label 2023-12-05 12:43:10 +01:00

Jeroen Bakker changed title from ~~Build: Sycl Not Included in Buildtime Platform Vars~~ to WIP: Build: Shared Libraries Not Included in Buildtime Platform Vars

2023-12-05 12:46:35 +01:00

Jeroen Bakker reviewed 2023-12-05 12:51:30 +01:00

build_files/cmake/platform/platform_win32.cmake

						
				@ -1195,6 +1195,7 @@ if(WITH_CYCLES AND (WITH_CYCLES_DEVICE_ONEAPI OR (WITH_CYCLES_EMBREE AND EMBREE_

				  unset(_sycl_pi_runtime_libraries_glob)

				  list(APPEND PLATFORM_BUNDLED_LIBRARIES ${_sycl_runtime_libraries})

				  list(APPEND PLATFORM_BUNDLED_LIBRARY_DIRS ${SYCL_ROOT_DIR/bin/})

Jeroen Bakker commented

2023-12-05 12:51:30 +01:00

Windows uses a different approach need to adjust it in PLATFORM_ENV_BUILD_DIRS directly.

Ray molenkamp commented

2023-12-05 18:56:14 +01:00

while i do not mind the changes i do like to understand better what lead to this fix, the only code that uses sycl afaik is loaded on demand and not exercised during any tests. what problem did you run into and how?

Campbell Barton commented

2023-12-06 01:47:50 +01:00

While this seems OK, there should be code-comments (similar to the ones in the PR) explaining why these paths need to be added.

Jeroen Bakker commented

2023-12-06 09:28:05 +01:00

Yes it is related to building shading builder in current form. (related to #115751, bigger picture #115748)

I used make release only enabling WITH_GPU_BUILDTIME_SHADER_BUILDER=On on both platforms. Goal is to get shader builder in its current form to execute correctly and reducing the stubs file. Shader builder doesn't actually require many dependencies, the way how the libraries are setup in Blender with many cyclic dependencies between them it. Shader builder requires blender::Vector, blender::Map
from BLI, being able to create a headless context from GHOST, so GHOST_System and GHOST_Context related classes

When we ditch OpenGL, we can remove the dependency with GHOST as Metal and Vulkan can rely on tools like shaderc/glslc and its MSL counterpart. Experiments executed during #113938 shows the glslc cannot compile OpenGL glsl files due to dialect differences (mostly binding related)

When checking the dependecies with cmake . --graphviz, I detected that bf_python has a direct connection with cycles, which would then try to find the Sycl dependecy at link time. When starting shader builder on windows it only starts when all the associated dll's can be found.
When running shader_builder.exe test.hh popup will appear for all the missing libs, perhaps there is a way that this can be suppressed.

In order to use shader_builder at this moment on Linux, the proposed change in this patch is needed. For windows there is also another change needed as somehow the shader_builder includes GHOST_Types.h which requires vulkan includes. Even when provided it cannot find it. Even when VS Studio shows that the include path is set correct. This can also be fixed by replacing the vulkan structs require for swapchains to our own types.

Yes it is related to building shading builder in current form. (related to #115751, bigger picture #115748) I used `make release` only enabling `WITH_GPU_BUILDTIME_SHADER_BUILDER=On` on both platforms. Goal is to get shader builder in its current form to execute correctly and reducing the stubs file. Shader builder doesn't actually require many dependencies, the way how the libraries are setup in Blender with many cyclic dependencies between them it. Shader builder requires `blender::Vector`, `blender::Map` from BLI, being able to create a headless context from `GHOST`, so `GHOST_System` and `GHOST_Context` related classes When we ditch OpenGL, we can remove the dependency with GHOST as Metal and Vulkan can rely on tools like shaderc/glslc and its MSL counterpart. Experiments executed during #113938 shows the glslc cannot compile OpenGL glsl files due to dialect differences (mostly binding related) When checking the dependecies with `cmake . --graphviz`, I detected that `bf_python` has a direct connection with cycles, which would then try to find the Sycl dependecy at link time. When starting shader builder on windows it only starts when all the associated dll's can be found. When running `shader_builder.exe test.hh` popup will appear for all the missing libs, perhaps there is a way that this can be suppressed. In order to use shader_builder at this moment on Linux, the proposed change in this patch is needed. For windows there is also another change needed as somehow the shader_builder includes GHOST_Types.h which requires vulkan includes. Even when provided it cannot find it. Even when VS Studio shows that the include path is set correct. This can also be fixed by replacing the vulkan structs require for swapchains to our own types.

Ray molenkamp commented

2023-12-06 18:18:38 +01:00

I build main with default settings on windows, with the only exceptions being WITH_GPU_BUILDTIME_SHADER_BUILDER=ON since that's the app you are having issues with, and WITH_VULKAN_BACKEND=OFF since shaderbuilder has a null deref in its vulkan codepath in main.

i build against svn libs r63582 and it ran just fine? not seeing any sycl related issues?

k:\BlenderGit\2019_ninja_tests>ninja --verbose K:/BlenderGit/2019_ninja_tests/source/blender/gpu/shader_baked.hh
[1/1] cmd.exe /C "cd /D K:\BlenderGit\2019_ninja_tests\source\blender\gpu && "C:\Program Files\CMake\bin\cmake.exe" -E env PATH=K:/BlenderGit/blender/../lib/win64_vc15/epoxy/bin;K:/BlenderGit/blender/../lib/win64_vc15/tbb/bin;K:/BlenderGit/blender/../lib/win64_vc15/OpenImageIO/bin;K:/BlenderGit/blender/../lib/win64_vc15/boost/lib;K:/BlenderGit/blender/../lib/win64_vc15/openexr/bin;K:/BlenderGit/blender/../lib/win64_vc15/imath/bin;K:/BlenderGit/blender/../lib/win64_vc15/shaderc/bin; K:/BlenderGit/2019_ninja_tests/bin/shader_builder.exe K:/BlenderGit/2019_ninja_tests/source/blender/gpu/shader_baked.hh"
Shader Test compilation result: 769 / 769 passed (skipped 10 for compatibility reasons)
OpenGL backend shader compilation succeeded.

some peculiar behaviour however: it clearly ran without issues, but it didn't actually generate that K:/BlenderGit/2019_ninja_tests/source/blender/gpu/shader_baked.hh file even though we told cmake that we would.

I build main with default settings on windows, with the only exceptions being `WITH_GPU_BUILDTIME_SHADER_BUILDER=ON` since that's the app you are having issues with, and `WITH_VULKAN_BACKEND=OFF` since shaderbuilder has a null deref in its vulkan codepath in main. i build against svn libs r63582 and it ran just fine? not seeing any sycl related issues? ``` k:\BlenderGit\2019_ninja_tests>ninja --verbose K:/BlenderGit/2019_ninja_tests/source/blender/gpu/shader_baked.hh [1/1] cmd.exe /C "cd /D K:\BlenderGit\2019_ninja_tests\source\blender\gpu && "C:\Program Files\CMake\bin\cmake.exe" -E env PATH=K:/BlenderGit/blender/../lib/win64_vc15/epoxy/bin;K:/BlenderGit/blender/../lib/win64_vc15/tbb/bin;K:/BlenderGit/blender/../lib/win64_vc15/OpenImageIO/bin;K:/BlenderGit/blender/../lib/win64_vc15/boost/lib;K:/BlenderGit/blender/../lib/win64_vc15/openexr/bin;K:/BlenderGit/blender/../lib/win64_vc15/imath/bin;K:/BlenderGit/blender/../lib/win64_vc15/shaderc/bin; K:/BlenderGit/2019_ninja_tests/bin/shader_builder.exe K:/BlenderGit/2019_ninja_tests/source/blender/gpu/shader_baked.hh" Shader Test compilation result: 769 / 769 passed (skipped 10 for compatibility reasons) OpenGL backend shader compilation succeeded. ``` some peculiar behaviour however: it clearly ran without issues, but it didn't actually generate that `K:/BlenderGit/2019_ninja_tests/source/blender/gpu/shader_baked.hh` file even though we told cmake that we would.

Jeroen Bakker commented

2023-12-08 16:19:24 +01:00

Closing this pull request as the error was in a local branch where I removed all stubs. Windows require those stubs and somehow doesn't need these DLLs to be loaded.

Jeroen Bakker closed this pull request

2023-12-08 16:19:25 +01:00

Pull request closed

This pull request cannot be reopened because the branch was deleted.

Sign in to join this conversation.

No reviewers

No Label

Download

What's New

Blender Studio

Manual

Developers Blog

Documentation

Benchmark

Blender Conference

Development Fund

One-time Donations

WIP: Build: Shared Libraries Not Included in Buildtime Platform Vars #115790

Pull request closed