Skip to content

[SYCL][DOC] Make Reusable Events extension experimental. #22701

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

Merged
KornevNikita merged 5 commits into from
Jul 22, 2026
+41 −8
Merged

[SYCL][DOC] Make Reusable Events extension experimental. #22701

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
245e2a4
[SYCL][DOC] Make Reusable Events extension experimental.
slawekptak Jul 21, 2026
dce442d
Move to existing status section.
slawekptak Jul 21, 2026
5c5bc8f
Bring back the host tasks section.
slawekptak Jul 21, 2026
e6269f3
Move to a new section.
slawekptak Jul 21, 2026
175261a
Add a note about supported host tasks.
slawekptak Jul 21, 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
4 changes: 2 additions & 2 deletions ...oc/extensions/experimental/sycl_ext_oneapi_inter_process_communication.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ This extension also depends on the following other SYCL extensions:

* link:sycl_ext_oneapi_virtual_mem.asciidoc[sycl_ext_oneapi_virtual_mem]
* link:sycl_ext_oneapi_properties.asciidoc[sycl_ext_oneapi_properties]
* link:../proposed/sycl_ext_oneapi_reusable_events.asciidoc[
* link:../experimental/sycl_ext_oneapi_reusable_events.asciidoc[
sycl_ext_oneapi_reusable_events]

== Status
Expand Down Expand Up @@ -1150,7 +1150,7 @@ of events as described in this section.

This feature uses the `enable_ipc` property (defined above for `physical_mem`),
which can be used with `make_event`
(from the link:../proposed/sycl_ext_oneapi_reusable_events.asciidoc[
(from the link:../experimental/sycl_ext_oneapi_reusable_events.asciidoc[
sycl_ext_oneapi_reusable_events] extension):

The `enable_ipc` property controls whether the event can be shared across
Expand Down
45 changes: 39 additions & 6 deletions .../sycl_ext_oneapi_reusable_events.asciidoc → .../sycl_ext_oneapi_reusable_events.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,15 +49,16 @@ This extension also depends on the following other SYCL extensions:

== Status

This is a proposed extension specification, intended to gather community
feedback.
Interfaces defined in this specification may not be implemented yet or may be in
a preliminary state.
The specification itself may also change in incompatible ways before it is
finalized.
This is an experimental extension specification, intended to provide early
access to features and gather community feedback. Interfaces defined in this
specification are implemented in {dpcpp}, but they are not finalized and may
change incompatibly in future versions of {dpcpp} without prior notice.
*Shipping software products should not rely on APIs defined in this
specification.*

This extension has been implemented with temporary limitations, outlined in the
"Implementation limitations" section.

== Backend support status

This extension is not supported with the Level Zero v1 adapter. All of the
Expand Down Expand Up @@ -476,3 +477,35 @@ This will likely cause the handling of events to be less efficient when host
tasks are submitted to the same queue as "native" commands like kernels or
copy operations, or when there are dependencies between host tasks and native
commands.

=== Implementation limitations

This extension has been implemented with the following limitations:

* The `evt` passed to the `enqueue_wait_event` function and all events in
`evts` passed to the `enqueue_wait_events` function need to have the same
context as `q`.
* The `enqueue_signal_event`, `enqueue_wait_event` and `enqueue_wait_events`
functions cannot be dependent on a host task (`enqueue_wait_event` and
`enqueue_wait_events` cannot take an event produced by a host task submission
as an argument and all those functions cannot be enqueued behind a host task
on an in-order queue), which has been submitted using the
`handler::host_task` function. Submitting host tasks using the
`sycl::ext::oneapi::experimental::host_task` function from the
link:../experimental/sycl_ext_oneapi_enqueue_functions.asciidoc[
sycl_ext_oneapi_enqueue_functions] extension is supported.
* The `enqueue_signal_event`, `enqueue_wait_event` and `enqueue_wait_events`
functions cannot be dependent on any commands which use cross-context
event dependencies.
* The `enqueue_signal_event`, `enqueue_wait_event` and `enqueue_wait_events`
function cannot be dependent on any commands using `sycl::stream`.
* The `enqueue_signal_event`, `enqueue_wait_event` and `enqueue_wait_events`
function cannot be dependent on the following methods from the
link:../supported/sycl_ext_oneapi_memcpy2d.asciidoc[
sycl_ext_oneapi_memcpy2d] extension: `queue::ext_oneapi_memcpy2d`,
`queue::ext_oneapi_copy2d`, `handler::ext_oneapi_memcpy2d`,
`handler::ext_oneapi_copy2d`, if the copy is a host-to-host data copy,
and the following methods: `queue::ext_oneapi_fill2d`,
`queue::ext_oneapi_memset2d`, `handler::ext_oneapi_fill2d`,
`handler::ext_oneapi_memset2d`, if the backend does not support 2D fill or
the target memory is on host.
Loading