fix: ggml: fix vulkan-shaders-gen build #10448

sparkleholic · 2024-11-22T02:42:39Z

The vulkan-shaders-gen target was not being built correctly in case of cross-compilation.
Other outputs need to be built for the cross compile target, but vulkan-shaders-gen needs to be built for the host.

I have read the contributing guidelines
Self-reported review complexity:
- Low
- Medium
- High

sparkleholic · 2024-11-25T16:12:47Z

@jeffbolznv , @0cc4m
This fix is needed for cross-compilation.
vulkan-shaders-gen is needed at build time, so arch should be the same as host pc, but other binaries (libggml, libllama, etc.) are needed at runtime.
Therefore, CMAKE compilation variables that apply when building the llama.cpp project should not apply when building vulkan-shaders-gen in case of cross-compilation.

0cc4m · 2024-11-25T16:52:43Z

@sparkleholic @jeffbolznv I understand, I'm sorry that a few PRs are getting delayed because of me. I'm currently ill, but getting better and I should be able to catch up with all of them later this week.

Maybe you can resolve the merge conflict already?

jeffbolznv · 2024-11-25T17:52:22Z

No rush, get well!

I'm not an expert at cmake or cross compilation, so I don't think I should review the change.

sparkleholic · 2024-11-25T18:52:18Z

@0cc4m
master rebased to resolve conflicts.
I didn't mean to rush you. I sincerely hope you feel better soon. :)

0cc4m · 2024-11-27T06:26:25Z

I can confirm this still works as usual on my system, but I'm also not a CMake expert. Maybe @bandoti can take a look?

bandoti · 2024-11-27T14:27:01Z

I am happy to take a look. The one thing that comes to mind here after initial look through is being able to customize the compiler in this case. In particular, gcc and g++ are hardcoded.

It would be worthwhile to add a default toolchain file for the build and allow one to customize by passing -DGGML_SHADERS_GEN_CROSS_TOOLCHAIN=... (or similar)

This would allow one to use a desire toolchain—maybe clang, etc.

And a lot of those switches passed to ExternalProject_Add() can of course be moved to the toolchain file instead.

sparkleholic · 2024-11-28T03:42:26Z

@bandoti
Thank you for the valuable feedback.

I have updated the code to handle the GGML_SHADERS_GEN_TOOLCHAIN variable. When this variable is provided, the specified file is used. If it is not set, the code generates a temporary host toolchain file by detecting the host environment's compiler.

Please review the updated code once again.

0cc4m · 2024-12-02T12:30:12Z

@bandoti Can you take another look?

ggml/src/ggml-vulkan/CMakeLists.txt

bandoti · 2024-12-02T15:16:50Z

@sparkleholic Sorry for the delay! I had these review comments in but forgot to submit them. 🤦‍♂️

bandoti · 2024-12-15T23:58:06Z

@sparkleholic Just following up on this change. If you need further assistance please let me know I am happy to help.

sparkleholic · 2024-12-24T03:27:20Z

@bandoti < Sorry for the late reply.
Thank you for the comments. I'll follow up this soon.

sparkleholic · 2024-12-24T04:03:59Z

Rebased branch to latest master.

bandoti · 2024-12-28T20:07:55Z

@sparkleholic No worries on the delay! Your contribution is greatly appreciated :)

It appears as though the test failure is unrelated to this. I'm wondering if merging the latest and rerunning the tests will clear the status. I have only one minor question in the review.

ggml/src/ggml-vulkan/vulkan-shaders/CMakeLists.txt

bandoti · 2025-01-08T14:03:04Z

@sparkleholic I have submitted a pull request to your master_fix branch which updates to latest and resolves a minor merge conflict. Please merge it into your branch so we can get the CI fixed here and merge these changes in!

Here's the PR for reference: sparkleholic#2

sparkleholic · 2025-01-09T05:19:48Z

@sparkleholic I have submitted a pull request to your master_fix branch which updates to latest and resolves a minor merge conflict. Please merge it into your branch so we can get the CI fixed here and merge these changes in!

Here's the PR for reference: sparkleholic#2

@bandoti < Thanks a lot!
I'l like to merge your PR into my branch first to proceed this PR.

Could you confirm which option should be selected for this?

bandoti · 2025-01-09T12:53:34Z

@sparkleholic A regular merge commit (the default) should be good. Our changes here will get squashed once they merge it into master. 😊

I just made one change, FYI, which adds NO_CMAKE_FIND_ROOT_PATH to the find_program calls. This will ensure that the cross-compile prefixes will be ignored when searching for the system compilers.

Fix compile error not finding vulkan-shaders-gen

Fix build issues with vulkan-shaders-gen: - Add target dependency for correct build order - Use CMAKE_HOST_SYSTEM_NAME for executable suffix - Fix MSVC output directory in host toolchain - Normalize path handling for cross-compilation

fix: normalize vulkan-shaders-gen output path for MSVC

ggml/src/ggml-vulkan/CMakeLists.txt

Improve host compiler detection for vulkan shader generation: - Add NO_CMAKE_FIND_ROOT_PATH to all compiler searches - Consolidate compiler detection logic - Fix Windows-specific MSVC detection - Ensure correct compiler search in cross-compilation

bandoti

Everything seems good to me except my one comment on detect_host_compiler. After that (whether the suggestion works or not and we keep it as-is) I am happy to move forward!

ggml/src/ggml-vulkan/CMakeLists.txt

Simplified the CMake function to improve the process of detecting the host compiler.

sparkleholic · 2025-01-13T05:49:23Z

Please hold on merging this patch for a moment. I'm checking my cross-compilation environment one last time.

Since `vulkan-shader-gen.cpp` only requires the `glslc` executable and not the Vulkan headers or libraries, CMakeLists.txt needs to be corrected. (See: ecc93d0)

sparkleholic · 2025-01-13T07:19:31Z

FYI: @jeffbolznv
Added a necessary change for cross-compiling environment.
37d0cb6

sparkleholic · 2025-01-13T07:20:08Z

@bandoti <
Ready to merge.

ggml/src/ggml-vulkan/vulkan-shaders/CMakeLists.txt

bandoti

Looks good to me!

sparkleholic · 2025-01-14T09:37:30Z

@bandoti , @ngxson
This PR is still open...

0cc4m · 2025-01-14T09:41:29Z

@bandoti , @ngxson This PR is still open...

It needs approval from a collaborator. I'll do a quick test that everything runs as intended on a regular setup later today and merge if it's fine.

ngxson · 2025-01-14T09:43:16Z

This change is not related to my part. I was added because you pushed a merge commit or rebase.

Please ask for people who maintains the vulkan backend.

ggml/src/ggml-vulkan/host_toolchain.cmake.in

- Rename host_toolchain.cmake.in to cmake/host-toolchain.cmake.in

ggml/CMakeLists.txt

Rename the macro GGML_SHADERS_GEN_TOOLCHAIN to GGML_VULKAN_SHADERS_GEN_TOOLCHAIN

0cc4m

Thank you for your patience with all the feedback. I tested it and found no issues.

sparkleholic force-pushed the master_fix branch from e9b3777 to bf43351 Compare November 25, 2024 18:47

github-actions bot added Vulkan Issues specific to the Vulkan backend ggml changes relating to the ggml tensor library for machine learning labels Nov 28, 2024

bandoti requested changes Dec 2, 2024

View reviewed changes

ggml/src/ggml-vulkan/CMakeLists.txt Outdated Show resolved Hide resolved

ggml/src/ggml-vulkan/CMakeLists.txt Outdated Show resolved Hide resolved

sparkleholic force-pushed the master_fix branch from 5cb143f to 49c225f Compare December 24, 2024 04:02

sparkleholic force-pushed the master_fix branch from 49c225f to 7c1a685 Compare December 24, 2024 04:06

bandoti reviewed Dec 28, 2024

View reviewed changes

ggml/src/ggml-vulkan/vulkan-shaders/CMakeLists.txt Outdated Show resolved Hide resolved

0cc4m mentioned this pull request Jan 6, 2025

fix: Vulkan shader gen binary path when Cross-compiling #11096

Merged

bandoti mentioned this pull request Jan 9, 2025

fix: Vulkan shader gen binary path when not cross compiling #11149

Closed

sparkleholic requested a review from ngxson as a code owner January 10, 2025 05:00

github-actions bot added documentation Improvements or additions to documentation testing Everything test related examples python python script changes labels Jan 10, 2025

fix: ggml: Fix compile error

b6ebd4f

Fix compile error not finding vulkan-shaders-gen

sparkleholic force-pushed the master_fix branch from d1aec44 to b6ebd4f Compare January 10, 2025 11:30

sparkleholic added 2 commits January 12, 2025 05:42

fix: vulkan-shaders-gen build and path handling

ce14d9b

Fix build issues with vulkan-shaders-gen: - Add target dependency for correct build order - Use CMAKE_HOST_SYSTEM_NAME for executable suffix - Fix MSVC output directory in host toolchain - Normalize path handling for cross-compilation

Merge pull request #3 from sparkleholic/master_fix2

481d57f

fix: normalize vulkan-shaders-gen output path for MSVC

bandoti reviewed Jan 11, 2025

View reviewed changes

ggml/src/ggml-vulkan/CMakeLists.txt Outdated Show resolved Hide resolved

sparkleholic requested a review from bandoti January 12, 2025 13:11

bandoti requested changes Jan 12, 2025

View reviewed changes

ggml/src/ggml-vulkan/CMakeLists.txt Show resolved Hide resolved

refactor: Simplify CMake function for detecting host compiler

efe4b14

Simplified the CMake function to improve the process of detecting the host compiler.

fix: Remove unnecessary Vulkan library linkage in CMakeLists.txt

37d0cb6

Since `vulkan-shader-gen.cpp` only requires the `glslc` executable and not the Vulkan headers or libraries, CMakeLists.txt needs to be corrected. (See: ecc93d0)

sparkleholic requested a review from bandoti January 13, 2025 07:20

bandoti requested changes Jan 13, 2025

View reviewed changes

ggml/src/ggml-vulkan/vulkan-shaders/CMakeLists.txt Show resolved Hide resolved

sparkleholic requested a review from bandoti January 13, 2025 14:45

bandoti approved these changes Jan 13, 2025

View reviewed changes

ngxson removed their request for review January 14, 2025 09:43

ggerganov reviewed Jan 14, 2025

View reviewed changes

ggml/src/ggml-vulkan/host_toolchain.cmake.in Outdated Show resolved Hide resolved

refactor: Rename host_toolchain.cmake.in

6fdbf07

- Rename host_toolchain.cmake.in to cmake/host-toolchain.cmake.in

sparkleholic requested a review from ggerganov January 15, 2025 00:54

ggerganov reviewed Jan 15, 2025

View reviewed changes

ggml/CMakeLists.txt Outdated Show resolved Hide resolved

ggerganov approved these changes Jan 15, 2025

View reviewed changes

refactor: GGML_VULKAN_SHADERS_GEN_TOOLCHAIN

f4d1fbc

Rename the macro GGML_SHADERS_GEN_TOOLCHAIN to GGML_VULKAN_SHADERS_GEN_TOOLCHAIN

sparkleholic requested a review from 0cc4m January 15, 2025 10:51

0cc4m approved these changes Jan 15, 2025

View reviewed changes

0cc4m merged commit 1d85043 into ggerganov:master Jan 15, 2025
48 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: ggml: fix vulkan-shaders-gen build #10448

fix: ggml: fix vulkan-shaders-gen build #10448

sparkleholic commented Nov 22, 2024

sparkleholic commented Nov 25, 2024 •

edited

Loading

0cc4m commented Nov 25, 2024

jeffbolznv commented Nov 25, 2024

sparkleholic commented Nov 25, 2024

0cc4m commented Nov 27, 2024

bandoti commented Nov 27, 2024 •

edited

Loading

sparkleholic commented Nov 28, 2024

0cc4m commented Dec 2, 2024

bandoti commented Dec 2, 2024

bandoti commented Dec 15, 2024

sparkleholic commented Dec 24, 2024 •

edited

Loading

sparkleholic commented Dec 24, 2024

bandoti commented Dec 28, 2024

bandoti commented Jan 8, 2025

sparkleholic commented Jan 9, 2025

bandoti commented Jan 9, 2025 •

edited

Loading

bandoti left a comment

sparkleholic commented Jan 13, 2025 •

edited

Loading

sparkleholic commented Jan 13, 2025

sparkleholic commented Jan 13, 2025

bandoti left a comment

sparkleholic commented Jan 14, 2025 •

edited

Loading

0cc4m commented Jan 14, 2025 •

edited

Loading

ngxson commented Jan 14, 2025

0cc4m left a comment

fix: ggml: fix vulkan-shaders-gen build #10448

fix: ggml: fix vulkan-shaders-gen build #10448

Conversation

sparkleholic commented Nov 22, 2024

sparkleholic commented Nov 25, 2024 • edited Loading

0cc4m commented Nov 25, 2024

jeffbolznv commented Nov 25, 2024

sparkleholic commented Nov 25, 2024

0cc4m commented Nov 27, 2024

bandoti commented Nov 27, 2024 • edited Loading

sparkleholic commented Nov 28, 2024

0cc4m commented Dec 2, 2024

bandoti commented Dec 2, 2024

bandoti commented Dec 15, 2024

sparkleholic commented Dec 24, 2024 • edited Loading

sparkleholic commented Dec 24, 2024

bandoti commented Dec 28, 2024

bandoti commented Jan 8, 2025

sparkleholic commented Jan 9, 2025

bandoti commented Jan 9, 2025 • edited Loading

bandoti left a comment

Choose a reason for hiding this comment

sparkleholic commented Jan 13, 2025 • edited Loading

sparkleholic commented Jan 13, 2025

sparkleholic commented Jan 13, 2025

bandoti left a comment

Choose a reason for hiding this comment

sparkleholic commented Jan 14, 2025 • edited Loading

0cc4m commented Jan 14, 2025 • edited Loading

ngxson commented Jan 14, 2025

0cc4m left a comment

Choose a reason for hiding this comment

sparkleholic commented Nov 25, 2024 •

edited

Loading

bandoti commented Nov 27, 2024 •

edited

Loading

sparkleholic commented Dec 24, 2024 •

edited

Loading

bandoti commented Jan 9, 2025 •

edited

Loading

sparkleholic commented Jan 13, 2025 •

edited

Loading

sparkleholic commented Jan 14, 2025 •

edited

Loading

0cc4m commented Jan 14, 2025 •

edited

Loading