Skip to content

[sycl] Added doc for compiling FAT binaries with multiple device archs #22141

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bviyer wants to merge 5 commits into
base: sycl
Choose a base branch
from
+15 −0
Open

[sycl] Added doc for compiling FAT binaries with multiple device archs #22141

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
039bc39
Added documentation for compiling FAT binaries
May 27, 2026
45cb8e2
Fixed a small typo
May 27, 2026
803228c
Update sycl/doc/design/OffloadDesign.md
bviyer May 29, 2026
71bd20a
Update sycl/doc/design/OffloadDesign.md
bviyer May 29, 2026
4ffbce1
Update sycl/doc/design/OffloadDesign.md
bviyer May 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions sycl/doc/design/OffloadDesign.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,6 +251,21 @@ The `--device-compiler` option uses the format `--device-compiler=[<kind>:][<tri

In clang-linker-wrapper, the `<kind>` and `<triple>` are matched against the current compilation target. Only arguments that match both the offloading kind and target triple will be passed to the backend compiler. If `<kind>` is not specified, the arguments will match any offloading kind; if `<triple>` is not specified, the arguments will match any target triple; and if neither is specified, the arguments will be applied to all targets.

To support multiple device architectures, a new `--device-compiler` option must be specified for each device. For example, to compile for Ponte Vecchio (PVC) and Skylake (SKL) architectures and put them in a fat binary, the user must add the following two `--device-compiler` options:

`--device-compiler=sycl:spir64_gen-unknown-unknown=-device pvc -options ...`

`--device-compiler=sycl:spir64_gen-unknown-unknown=-device skl -options ...`

Device specific options for each of the device architectures should be specified after `-device <name>`.

Here is an example of a clang-linker-wrapper invocation where ther user wants to create a fat binary with PVC and SKL architectures to be run on a x86_64 Linux host. In addition, they would like to enable aggressive mathematical optimizations and are tolerant for slightly imprecise floating-point values just for SKL, that is, use the `-cl-unsafe-math-optimizations` flag. For PVC, they would like to enable the multiply and add instruction usage (`-cl-mad-enable`). The source binaries are called host.o and kernel.o and the output should be called out.exe.

`clang-linker-wrapper --host-triple=x86_64-unknown-linux-gnu
--device-compiler=sycl:spir64_gen-unknown-unknown=-device pvc -options "-cl-mad-enable"
--device-compiler=sycl:spir64_gen-unknown-unknown=-device skl -options "-cl-unsafe-math-optimizations" -- /usr/bin/ld
host.o kernel.o -o out.exe`

#### Other Supported Options
To complete the support needed for the various targets using the
`clang-linker-wrapper` as the main interface, a few additional options will
Expand Down
Loading