[SYCL][Doc] Add spec for "sycl" to kernel compiler #11985

gmlueck · 2023-11-22T18:45:47Z

Update the proposed specification for the kernel compiler to allow
kernels to be written in the SYCL language, using the new proposed
"free function kernel" format.

This PR also adds some more features to the kernel compiler for
parity with cuda's nvrtc.

Update the proposed specification for the kernel compiler to allow kernels to be written in the SYCL language, using the new proposed "free function kernel" format.

sycl/doc/extensions/experimental/sycl_ext_oneapi_kernel_compiler.asciidoc

Require the source string to `#include <sycl/sycl.hpp>` in order to get the content of that header. Clarify that this header and other standard headers are available even without the `include_files` property.

keryell · 2023-11-29T02:40:04Z

sycl/doc/extensions/experimental/sycl_ext_oneapi_kernel_compiler.asciidoc

-These details are provided by other extensions.
+This extension provides support for kernels written in SYCL according to the
+"free function kernel" syntax defined in
+link:../proposed/sycl_ext_oneapi_free_function_kernels.asciidoc[


Is this available somewhere?

No, it's not implemented yet. I expect that we will implement that extension at the same time as the new additions to "sycl_ext_oneapi_kernel_compiler" that are described in this PR.

DongBaiYue · 2023-12-04T17:24:36Z

Runtime compilation is an urgently needed feature of SYCL in project development. Thanks for your specification. Also out of curiosity, may the kernel compiler support using inline PTX assembly in SYCL kernel? opencl example. Inline Assembly makes rich low-level hardware features available to programmers.

The new overload of `create_kernel_bundle_from_source` should also take a property list.

gmlueck · 2023-12-20T22:46:37Z

Runtime compilation is an urgently needed feature of SYCL in project development. Thanks for your specification. Also out of curiosity, may the kernel compiler support using inline PTX assembly in SYCL kernel? opencl example. Inline Assembly makes rich low-level hardware features available to programmers.

Hi @DongBaiYue, I think this is not strongly related to this extension. Runtime compilation should work for kernels that use any of the SYCL features that available in normal kernels. I'm not sure if normal SYCL kernels can contain PTX assembly, but @AerialMantis might know.

In d49df13 we decided that the source code string must contain `#include <sycl/sycl.hpp>`, but that commit forgot to add this include to all the examples.

We decided to switch the syntax for identifying a free function kernel. We now use a compile time property instead of a special macro.

gmlueck · 2024-01-10T22:59:17Z

Attention reviewers: I do not plan any more changes to this PR. If you have more comments, please make them soon.

sycl/doc/extensions/experimental/sycl_ext_oneapi_kernel_compiler.asciidoc

gmlueck · 2024-01-10T23:15:58Z

Marking this PR as "draft" only to prevent it from being merged until after these new APIs have been implemented.

This is a new process I'm trying out for cases where we make proposed changes to an extension specification that is already implemented. When these new changes are implemented, we can merge this PR. That way, the extension specification in the repo will always reflect what is currently implemented.

sycl/doc/extensions/experimental/sycl_ext_oneapi_kernel_compiler.asciidoc

cperkinsintel · 2024-01-19T03:20:41Z

sycl/doc/extensions/experimental/sycl_ext_oneapi_kernel_compiler.asciidoc

+  include_files(const std::string &name, const std::string &content);  (1)
+  include_files(const std::vector<std::string> &names,                 (2)
+                const std::vector<std::string> &contents);
+};


I have some reservations about this include_files struct.

We know for the first implementation that we are likely going to have to write out a temporary .cpp file and invoke clang++ -fsycl on it. So now we have to also write out the include files? What about #include "path/to/file.h" ? Will we then be parsing this and instantiating directories?

I presume we need to disambiguate #include "local/path.h" from #include <system/path.h> ?

Users can't link in libraries ( even if has a header ), and there is only the one TU. Supporting #include suggests the opposite. Maybe a note proscribing it is needed?

I do see the value in that if a user has a simple function that they want to both use in the host application and call from their kernel, this allows them to do so. And, if clang were to ever have an invocation API (like ocloc) then I guess this aligns with that.

One of the reasons we added the include_files property is for parity with CUDA, which has a similar feature in NVRTC. By adding the feature to SYCL, we make it easier to migrate code automatically using the SYCLomatic tool.

I was thinking that our implementation could create a temporary "include" directory and then write out the include_files header files into that directory. When we invoke clang, we can add a -I switch pointing at the temporary include directory.

Note that you don't need to parse any #include strings from the source code to get the file name paths. The include_files properties contains a list of (Name, Content) pairs. Each Name is the relative pathname of an include file, so you can just use this Name string verbatim.

sycl/doc/extensions/experimental/sycl_ext_oneapi_kernel_compiler.asciidoc

gmlueck

Thanks for the careful review! See responses below.

sycl/doc/extensions/experimental/sycl_ext_oneapi_kernel_compiler.asciidoc

victor-eds

Current text looks good to me 👍

We decided to remove support for `range_kernel` from the free function kernel spec, so change all the examples to use `nd_range_kernel` instead. The proposed `this_kernel` namespace was changed to `this_work_item` and it is no longer in the experimental namespace.

sycl/doc/extensions/experimental/sycl_ext_oneapi_kernel_compiler.asciidoc

SYCL language support on the part of the kernel_compiler is specified here: #11985 However, that specification is not presently realizable. We need more support from the FE and post link tool to get the demangled names propagated through. But it is usable before that, with constraints about using extern "C" or knowing the mangled kernel name. We have folk that want to test in the interim. I've refrained from updating the spec, and instead this interim support in our experimental extension will be snuck in until it can be completed in full - then we'll update the spec to release it properly.

Clarify that the _Name_ from an `include_files` entry could contain directory components.

github-actions · 2025-01-06T02:01:58Z

This pull request is stale because it has been open 180 days with no activity. Remove stale label or comment or this will be automatically closed in 30 days.

For the sycl kernel compiler extension, see #11985, #16485 --------- Co-authored-by: Steffen Larsen <steffen.larsen@intel.com>

This PR adds full support for the `registered_kernel_names` property to query kernels by their souce code name (and instantiate template kernels), leveraging the new `[[__sycl_detail__::__registered_kernels__(...)]]` attribute added in #16485 and #16821. Also, `kernel_bundle::ext_oneapi_get_raw_kernel_name` is implemented following the draft spec #11985. --------- Signed-off-by: Julian Oppermann <julian.oppermann@codeplay.com>

sommerlukas · 2025-02-28T13:22:32Z

Merging this extension, as the core functionality is implemented now that #17032 has been merged.

Smaller tweaks to API naming and implementation-specific notes will be added through follow-up PRs.

This PR is based on #17032. It adds runtime tests that match the examples from the spec changes in #11985, showing that the test run successfully using the JIT approach for RTC. This PR also contains a few minor fixes in the example code in the RTC docs.

gmlueck added 4 commits November 22, 2023 12:34

[SYCL][Doc] Add spec for "sycl" to kernel compiler

77b3e86

Update the proposed specification for the kernel compiler to allow kernels to be written in the SYCL language, using the new proposed "free function kernel" format.

Add support for include files

94b08ae

Add API to get mangled kernel name

bc84306

Add open issues

56864a8

gmlueck requested a review from a team as a code owner November 22, 2023 18:45

rolandschulz reviewed Nov 22, 2023

View reviewed changes

sycl/doc/extensions/experimental/sycl_ext_oneapi_kernel_compiler.asciidoc Outdated Show resolved Hide resolved

Change behavior for <sycl/sycl.hpp>

d49df13

Require the source string to `#include <sycl/sycl.hpp>` in order to get the content of that header. Clarify that this header and other standard headers are available even without the `include_files` property.

keryell reviewed Nov 29, 2023

View reviewed changes

Merge branch 'sycl' into gmlueck/kernel-compiler-sycl

44b2c6f

Pennycook approved these changes Dec 19, 2023

View reviewed changes

gmlueck added 3 commits December 20, 2023 17:18

Merge branch 'sycl' into gmlueck/kernel-compiler-sycl

4b10b33

Add statement that "sycl" language is text format

7424d2f

Fix merge mistake

21580c6

The new overload of `create_kernel_bundle_from_source` should also take a property list.

gmlueck mentioned this pull request Jan 10, 2024

[SYCL][Doc] Add free function kernel extension spec #11861

Merged

gmlueck added 2 commits January 10, 2024 17:20

Add include of <sycl/sycl.hpp> to examples

b98714e

In d49df13 we decided that the source code string must contain `#include <sycl/sycl.hpp>`, but that commit forgot to add this include to all the examples.

Use properties instead of macros

1b6f57e

We decided to switch the syntax for identifying a free function kernel. We now use a compile time property instead of a special macro.

Pennycook approved these changes Jan 10, 2024

View reviewed changes

sycl/doc/extensions/experimental/sycl_ext_oneapi_kernel_compiler.asciidoc Outdated Show resolved Hide resolved

gmlueck marked this pull request as draft January 10, 2024 23:12

Use "a std::" instead of "an std::"

019977c

cperkinsintel reviewed Jan 16, 2024

View reviewed changes

sycl/doc/extensions/experimental/sycl_ext_oneapi_kernel_compiler.asciidoc Outdated Show resolved Hide resolved

cperkinsintel reviewed Jan 16, 2024

View reviewed changes

sycl/doc/extensions/experimental/sycl_ext_oneapi_kernel_compiler.asciidoc Show resolved Hide resolved

cperkinsintel reviewed Jan 16, 2024

View reviewed changes

sycl/doc/extensions/experimental/sycl_ext_oneapi_kernel_compiler.asciidoc Show resolved Hide resolved

cperkinsintel reviewed Jan 19, 2024

View reviewed changes

cperkinsintel approved these changes Jan 19, 2024

View reviewed changes

victor-eds reviewed Feb 16, 2024

View reviewed changes

Merge branch 'sycl' into gmlueck/kernel-compiler-sycl

ab91afe

gmlueck added 2 commits February 29, 2024 09:50

Tweak wording about syntax errors

d40c117

Tighten description of "save_log"

cd36574

gmlueck commented Feb 29, 2024

View reviewed changes

victor-eds approved these changes Feb 29, 2024

View reviewed changes

steffenlarsen mentioned this pull request Mar 19, 2024

[SYCL] DPC++ support runtime compilation? #11011

Open

gmlueck mentioned this pull request Apr 24, 2024

[SYCL] Device code generation for "free functions", a new way to define kernels #13207

Merged

cperkinsintel mentioned this pull request Jun 13, 2024

[SYCL] interim kernel compiler with SYCL support #14172

Merged

maarquitos14 reviewed Jun 28, 2024

View reviewed changes

sycl/doc/extensions/experimental/sycl_ext_oneapi_kernel_compiler.asciidoc Outdated Show resolved Hide resolved

Remove doubled word

e69a5dd

Clarify "include_files"

a6d8758

Clarify that the _Name_ from an `include_files` entry could contain directory components.

AlexeySachkov mentioned this pull request Sep 17, 2024

[SYCL][Doc] Release Notes for Jul'24 release #15138

Merged

sommerlukas mentioned this pull request Oct 29, 2024

[SYCL] Lift restrictions on free-function kernels when compiling at runtime #15892

Merged

sommerlukas mentioned this pull request Nov 6, 2024

Stop generation of integration header in runtime compilation mode #15996

Open

github-actions bot added the Stale label Jan 6, 2025

gmlueck removed the Stale label Jan 6, 2025

jzc mentioned this pull request Jan 28, 2025

[SYCL] Add SYCL registered kernel metadata into property sets #16821

Merged

sommerlukas mentioned this pull request Feb 10, 2025

Add support for work_group_memory extension IntelPython/dpctl#1984

Merged

7 tasks

steffenlarsen added a commit that referenced this pull request Feb 24, 2025

[SYCL] Add SYCL registered kernel metadata into property sets (#16821)

32bc92d

For the sycl kernel compiler extension, see #11985, #16485 --------- Co-authored-by: Steffen Larsen <steffen.larsen@intel.com>

jopperm mentioned this pull request Feb 25, 2025

[SYCL][RTC] Query kernels by source code name #17032

Merged

PietroGhg mentioned this pull request Feb 26, 2025

[SYCL][RTC] Add tests for JIT RTC #17182

Merged

Merge branch 'sycl' into gmlueck/kernel-compiler-sycl

22c0db3

sommerlukas marked this pull request as ready for review February 28, 2025 13:20

sommerlukas merged commit c2c029e into intel:sycl Feb 28, 2025
2 checks passed

[SYCL][Doc] Add spec for "sycl" to kernel compiler #11985

[SYCL][Doc] Add spec for "sycl" to kernel compiler #11985

Uh oh!

Conversation

gmlueck commented Nov 22, 2023

Uh oh!

Uh oh!

keryell Nov 29, 2023

Choose a reason for hiding this comment

Uh oh!

gmlueck Nov 29, 2023

Choose a reason for hiding this comment

Uh oh!

DongBaiYue commented Dec 4, 2023

Uh oh!

gmlueck commented Dec 20, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gmlueck commented Jan 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

gmlueck commented Jan 10, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cperkinsintel Jan 19, 2024

Choose a reason for hiding this comment

Uh oh!

gmlueck Jan 19, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gmlueck left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

victor-eds left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions bot commented Jan 6, 2025

Uh oh!

sommerlukas commented Feb 28, 2025

Uh oh!

Uh oh!

Uh oh!

gmlueck commented Dec 20, 2023 •

edited

Loading

gmlueck commented Jan 10, 2024 •

edited

Loading