Skip to content
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

Jump to bottom

[SYCL][Doc]Error on recorded event query. #132

Merged
merged 1 commit into from
Apr 12, 2023
Merged

[SYCL][Doc]Error on recorded event query. #132

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 20 additions & 8 deletions sycl/doc/extensions/proposed/sycl_ext_oneapi_graph.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -875,18 +875,17 @@ Table {counter: tableNumber}. Queue info query
Events returned from queue submissions when a queue is in the recording state
may only be used as parameters to `handler::depends_on()` or as dependent
events for queue shortcuts like `queue::parallel_for()` for submissions which
are being recorded to the same modifiable `command_graph`. These events have
status `info::event_command_status::complete`. The event status of an event
returned from an executable graph submission will have
`info::event_command_status::running` once any command group node starts
executing on a device, and status `info::event_command_status::complete`
once all the nodes have finished execution.
are being recorded to the same modifiable `command_graph`.

Calling `event::get_info<info::event::command_execution_status>()` or
`event::get_profiling_info()` on an event returned from a queue submission
recorded to a graph will throw synchronously with error code `invalid`.

Waiting on an event returned from a queue submission recorded to a graph
will throw synchronously with error code `invalid`.

Calling `queue::wait()` on a queue in the recording state is an error and
will throw synchronously with error code `invalid`.
Waiting on a queue in the recording state is an error and will throw
synchronously with error code `invalid`.

==== Queue Properties

Expand Down Expand Up @@ -940,6 +939,10 @@ event queue::ext_oneapi_graph(command_graph<graph_state::executable>& graph)
|Queue shortcut function that is equivalent to submitting a command-group
containing `handler::ext_oneapi_graph(graph)`.

The command status of the event returned will be
`info::event_command_status::running` once any command group node starts
executing on a device, and status `info::event_command_status::complete` once
all the nodes have finished execution.
|
[source,c++]
----
Expand All @@ -951,6 +954,10 @@ event queue::ext_oneapi_graph(command_graph<graph_state::executable>& graph,
containing `handler::depends_on(depEvent)` and
`handler::ext_oneapi_graph(graph)`.

The command status of the event returned will be
`info::event_command_status::running` once any command group node starts
executing on a device, and status `info::event_command_status::complete` once
all the nodes have finished execution.
|
[source,c++]
----
Expand All @@ -961,6 +968,11 @@ event queue::ext_oneapi_graph(command_graph<graph_state::executable>& graph,
|Queue shortcut function that is equivalent to submitting a command-group
containing `handler::depends_on(depEvents)` and
`handler::ext_oneapi_graph(graph)`.

The command status of the event returned will be
`info::event_command_status::running` once any command group node starts
executing on a device, and status `info::event_command_status::complete` once
all the nodes have finished execution.
|===

==== New Handler Member Functions
Expand Down