[SYCL][DOC] Graph API extensions #5626

reble · 2022-02-22T03:47:38Z

This extension is adding an API that targets separating definition and execution of a SYCL Kernel Graph. This patch contains specification only.

sycl/doc/extensions/experimental/SYCL_EXT_ONEAPI_GRAPH.asciidoc

keryell · 2022-03-05T03:59:22Z

Interesting concepts!
Perhaps the naming could be tweaked to be more SYCL-friendly?
Does the _node suffix really matter? It looks like this is what in SYCL we name a command group. But it could be seen as a task or similar.
add_ looks like submit so why not keeping the same wording? I guess you want to differentiate submit_device from submit_host, so adding _device and _host makes sense. But the host is also a device...
add_empty_node can be just an overload submit_device().

sycl/doc/extensions/experimental/SYCL_EXT_ONEAPI_GRAPH.asciidoc

jbrodman · 2022-03-17T19:45:17Z

But the host is also a device...

...not anymore. ;)

keryell · 2022-03-17T21:56:20Z

But the host is also a device...

...not anymore. ;)

You do not have an extension for this? :-)
It can be an optional feature in all the good implementations when a good CPU is available. ;-)

sycl/doc/extensions/experimental/SYCL_EXT_ONEAPI_GRAPH.asciidoc

This reverts commit ef24789.

Change status to proposal

keryell

This sounds like an interesting feature also for SYCL SC.

sycl/doc/extensions/proposed/sycl_ext_oneapi_graph.asciidoc

Co-authored-by: John Pennycook <[email protected]>

Co-authored-by: Ronan Keryell <[email protected]>

Gordon and Greg left some spec feedback on our upstream PR, address the superficial comments.

gmlueck

Looks good!

sycl/doc/extensions/proposed/sycl_ext_oneapi_graph.asciidoc

Address [Steffen's feedback](intel#5626 (comment)) and move the `info::device::graph_support_level` to enum up a namespace level to `info::graph_support_level`. Using `info::device::graph_support` to return a `info::graph_support_level` is analogous with the `info::device::device_type` query in the main spec which returns a `info::device_type`. Or `info::device::local_mem_type` which returns a `info::local_mem_type`.

jandres742 · 2023-07-11T17:39:35Z

sycl/doc/extensions/proposed/sycl_ext_oneapi_graph.asciidoc

+to be inferred.
+
+It is valid to combine these two mechanisms, however it is invalid to modify
+a graph using the explicit API while that graph is currently being recorded to,


is it "... being recorded too". instead of ".. to" ?

I think that "to" rather than "too" is correct, but rephrased this wording to "it is invalid to modify a graph using the explicit API while that graph is currently recording commands" to avoid any confusion over grammar.

* [SYCL][Doc] Change `graph_support_level` namespace Address [Steffen's feedback](intel#5626 (comment)) and move the `info::device::graph_support_level` to enum up a namespace level to `info::graph_support_level`. Using `info::device::graph_support` to return a `info::graph_support_level` is analogous with the `info::device::device_type` query in the main spec which returns a `info::device_type`. Or `info::device::local_mem_type` which returns a `info::local_mem_type`. * Add Steffen as a contributor

Simplify the definition of a node in the Record & Replay API. Move the wording around sub-graphs to the sub-graph section, and use "command" terminology rather than "kernel" to be more generic. Actions Gordon's feedback from: * Lack of clarity over inclusion of queue shortcut functions intel#5626 (comment) * Say "command" rather than "kernel" intel#5626 (comment)

[Review feedback](intel#5626 (comment)) questioned the phrase "graph is currently being recorded to" as to whether "to" should be "too". I don't think it should be "too", but rephrasing to "graph is currently recording any queues" avoids any confusion. Also updated the contributors to add Maxime and Jaime (who made the comment).

steffenlarsen

LGTM!

- Change wording around undefined behaviour when creating a cycle with no checks - UB is created at point of adding the cycle, not at finalize.

…hs (3/4) (#10033) # Backend integration and feature additions for SYCL Graphs This is the third patch of a series that adds support for an [experimental command graph extension](#5626) A snapshot of the complete work can be seen in draft PR #9375 which has support all the specification defined ways of adding nodes and edges to the graph, including both Explicit and Record & Replay graph construction. The two types of nodes currently implemented are kernel execution and memcpy commands. See https://github.com/reble/llvm#implementation-status for the status of our total work. ## Scope This third patch focuses on integrating the graphs runtime with the backend support added in #9992 as well as any remaining runtime features and bug fixes, and should include no ABI-breaking changes: * Graphs runtime changes to use PI/UR command-buffers. * Various improvements to the Graphs runtime classes. * New memory manager methods for appending copies to a command-buffer. * Changes to the Scheduler and related CG classes to enable Graphs. * Device info query for command-graph support. * Minor changes to some runtime classes to enable Graphs. ## Following Split PRs Future follow-up PRs with the remainder of our work on the extension will include: * Add end-to-end tests for SYCL Graph extension. (4/4) * NFC changes - Design doc and codeowner update. ## Authors Co-authored-by: Pablo Reble <[email protected]> Co-authored-by: Julian Miller <[email protected]> Co-authored-by: Ben Tracy <[email protected]> Co-authored-by: Ewan Crawford <[email protected]> Co-authored-by: Maxime France-Pillois <[email protected]>

jandres742

+1

steffenlarsen · 2023-07-19T07:29:37Z

Precommit failure is a known issue (#10380)

After the merge of the [SYCL-Graph extension spec PR](intel#5626) add @intel/sycl-graphs-reviewers as reviewers of the specification [document](https://github.com/intel/llvm/blob/sycl/sycl/doc/extensions/proposed/sycl_ext_oneapi_graph.asciidoc). Used `**` for the extension status directory as the extension is expected to shortly move from proposed to experimental.

# E2E Tests for SYCL Graphs This is the fourth patch of a series that adds support for an [experimental command graph extension](#5626) A snapshot of the complete work can be seen in draft PR #9375 which has support all the specification defined ways of adding nodes and edges to the graph, including both Explicit and Record & Replay graph construction. The two types of nodes currently implemented are kernel execution and memcpy commands. See https://github.com/reble/llvm#implementation-status for the status of our total work. ## Scope This fourth patch focuses on adding E2E tests for SYCL Graphs, covering the following: * Record and Replay API based tests. * Explicit API based tests. * Thread safety tests. * A small amount of miscellaneous tests. ## Following Split PRs Future follow-up PRs with the remainder of our work on the extension will include: * NFC changes - Design doc. ## Authors Co-authored-by: Pablo Reble <[email protected]> Co-authored-by: Julian Miller <[email protected]> Co-authored-by: Ben Tracy <[email protected]> Co-authored-by: Ewan Crawford <[email protected]> Co-authored-by: Maxime France-Pillois <[email protected]>

# Level Zero Backend Support for SYCL Graphs This is the second patch of a series that adds support for an [experimental command graph extension](intel#5626) A snapshot of the complete work can be seen in draft PR intel#9375 which has support all the specification defined ways of adding nodes and edges to the graph, including both Explicit and Record & Replay graph construction. The two types of nodes currently implemented are kernel execution and memcpy commands. See https://github.com/reble/llvm#implementation-status for the status of our total work. ## Scope This second patch focuses on the required PI/UR support for the experimental command-buffer feature in the Level Zero adapter: * PI stubs for all adapters to enable compilation, no functionality. * Command-buffer implementation for the Level Zero UR adapter. * Stubs for the CUDA UR adapter to enable compilation, no functionality. ## Following Split PRs Future follow-up PRs with the remainder of our work on the extension will include: * Hooking up backend to graphs runtime, bugfixes and other feature additions, will add symbols but not break the ABI. (3/4) * Add end-to-end tests for SYCL Graph extension. (4/4) * NFC changes - Design doc and codeowner update. ## Authors Co-authored-by: Pablo Reble <[email protected]> Co-authored-by: Julian Miller <[email protected]> Co-authored-by: Ben Tracy <[email protected]> Co-authored-by: Ewan Crawford <[email protected]> Co-authored-by: Maxime France-Pillois <[email protected]> --------- Co-authored-by: Ewan Crawford <[email protected]> Co-authored-by: Maxime France-Pillois <[email protected]>

…hs (3/4) (intel#10033) # Backend integration and feature additions for SYCL Graphs This is the third patch of a series that adds support for an [experimental command graph extension](intel#5626) A snapshot of the complete work can be seen in draft PR intel#9375 which has support all the specification defined ways of adding nodes and edges to the graph, including both Explicit and Record & Replay graph construction. The two types of nodes currently implemented are kernel execution and memcpy commands. See https://github.com/reble/llvm#implementation-status for the status of our total work. ## Scope This third patch focuses on integrating the graphs runtime with the backend support added in intel#9992 as well as any remaining runtime features and bug fixes, and should include no ABI-breaking changes: * Graphs runtime changes to use PI/UR command-buffers. * Various improvements to the Graphs runtime classes. * New memory manager methods for appending copies to a command-buffer. * Changes to the Scheduler and related CG classes to enable Graphs. * Device info query for command-graph support. * Minor changes to some runtime classes to enable Graphs. ## Following Split PRs Future follow-up PRs with the remainder of our work on the extension will include: * Add end-to-end tests for SYCL Graph extension. (4/4) * NFC changes - Design doc and codeowner update. ## Authors Co-authored-by: Pablo Reble <[email protected]> Co-authored-by: Julian Miller <[email protected]> Co-authored-by: Ben Tracy <[email protected]> Co-authored-by: Ewan Crawford <[email protected]> Co-authored-by: Maxime France-Pillois <[email protected]>

# Level Zero Backend Support for SYCL Graphs This is the second patch of a series that adds support for an [experimental command graph extension](intel#5626) A snapshot of the complete work can be seen in draft PR intel#9375 which has support all the specification defined ways of adding nodes and edges to the graph, including both Explicit and Record & Replay graph construction. The two types of nodes currently implemented are kernel execution and memcpy commands. See https://github.com/reble/llvm#implementation-status for the status of our total work. ## Scope This second patch focuses on the required PI/UR support for the experimental command-buffer feature in the Level Zero adapter: * PI stubs for all adapters to enable compilation, no functionality. * Command-buffer implementation for the Level Zero UR adapter. * Stubs for the CUDA UR adapter to enable compilation, no functionality. ## Following Split PRs Future follow-up PRs with the remainder of our work on the extension will include: * Hooking up backend to graphs runtime, bugfixes and other feature additions, will add symbols but not break the ABI. (3/4) * Add end-to-end tests for SYCL Graph extension. (4/4) * NFC changes - Design doc and codeowner update. ## Authors Co-authored-by: Pablo Reble <[email protected]> Co-authored-by: Julian Miller <[email protected]> Co-authored-by: Ben Tracy <[email protected]> Co-authored-by: Ewan Crawford <[email protected]> Co-authored-by: Maxime France-Pillois <[email protected]> --------- Co-authored-by: Ewan Crawford <[email protected]> Co-authored-by: Maxime France-Pillois <[email protected]>

# Level Zero Backend Support for SYCL Graphs This is the second patch of a series that adds support for an [experimental command graph extension](intel/llvm#5626) A snapshot of the complete work can be seen in draft PR #9375 which has support all the specification defined ways of adding nodes and edges to the graph, including both Explicit and Record & Replay graph construction. The two types of nodes currently implemented are kernel execution and memcpy commands. See https://github.com/reble/llvm#implementation-status for the status of our total work. ## Scope This second patch focuses on the required PI/UR support for the experimental command-buffer feature in the Level Zero adapter: * PI stubs for all adapters to enable compilation, no functionality. * Command-buffer implementation for the Level Zero UR adapter. * Stubs for the CUDA UR adapter to enable compilation, no functionality. ## Following Split PRs Future follow-up PRs with the remainder of our work on the extension will include: * Hooking up backend to graphs runtime, bugfixes and other feature additions, will add symbols but not break the ABI. (3/4) * Add end-to-end tests for SYCL Graph extension. (4/4) * NFC changes - Design doc and codeowner update. ## Authors Co-authored-by: Pablo Reble <[email protected]> Co-authored-by: Julian Miller <[email protected]> Co-authored-by: Ben Tracy <[email protected]> Co-authored-by: Ewan Crawford <[email protected]> Co-authored-by: Maxime France-Pillois <[email protected]> --------- Co-authored-by: Ewan Crawford <[email protected]> Co-authored-by: Maxime France-Pillois <[email protected]>

# E2E Tests for SYCL Graphs This is the fourth patch of a series that adds support for an [experimental command graph extension](intel#5626) A snapshot of the complete work can be seen in draft PR intel#9375 which has support all the specification defined ways of adding nodes and edges to the graph, including both Explicit and Record & Replay graph construction. The two types of nodes currently implemented are kernel execution and memcpy commands. See https://github.com/reble/llvm#implementation-status for the status of our total work. ## Scope This fourth patch focuses on adding E2E tests for SYCL Graphs, covering the following: * Record and Replay API based tests. * Explicit API based tests. * Thread safety tests. * A small amount of miscellaneous tests. ## Following Split PRs Future follow-up PRs with the remainder of our work on the extension will include: * NFC changes - Design doc. ## Authors Co-authored-by: Pablo Reble <[email protected]> Co-authored-by: Julian Miller <[email protected]> Co-authored-by: Ben Tracy <[email protected]> Co-authored-by: Ewan Crawford <[email protected]> Co-authored-by: Maxime France-Pillois <[email protected]>

# Level Zero Backend Support for SYCL Graphs This is the second patch of a series that adds support for an [experimental command graph extension](intel/llvm#5626) A snapshot of the complete work can be seen in draft PR #9375 which has support all the specification defined ways of adding nodes and edges to the graph, including both Explicit and Record & Replay graph construction. The two types of nodes currently implemented are kernel execution and memcpy commands. See https://github.com/reble/llvm#implementation-status for the status of our total work. ## Scope This second patch focuses on the required PI/UR support for the experimental command-buffer feature in the Level Zero adapter: * PI stubs for all adapters to enable compilation, no functionality. * Command-buffer implementation for the Level Zero UR adapter. * Stubs for the CUDA UR adapter to enable compilation, no functionality. ## Following Split PRs Future follow-up PRs with the remainder of our work on the extension will include: * Hooking up backend to graphs runtime, bugfixes and other feature additions, will add symbols but not break the ABI. (3/4) * Add end-to-end tests for SYCL Graph extension. (4/4) * NFC changes - Design doc and codeowner update. ## Authors Co-authored-by: Pablo Reble <[email protected]> Co-authored-by: Julian Miller <[email protected]> Co-authored-by: Ben Tracy <[email protected]> Co-authored-by: Ewan Crawford <[email protected]> Co-authored-by: Maxime France-Pillois <[email protected]> --------- Co-authored-by: Ewan Crawford <[email protected]> Co-authored-by: Maxime France-Pillois <[email protected]>

…hs (3/4) (#10033) # Backend integration and feature additions for SYCL Graphs This is the third patch of a series that adds support for an [experimental command graph extension](intel/llvm#5626) A snapshot of the complete work can be seen in draft PR #9375 which has support all the specification defined ways of adding nodes and edges to the graph, including both Explicit and Record & Replay graph construction. The two types of nodes currently implemented are kernel execution and memcpy commands. See https://github.com/reble/llvm#implementation-status for the status of our total work. ## Scope This third patch focuses on integrating the graphs runtime with the backend support added in #9992 as well as any remaining runtime features and bug fixes, and should include no ABI-breaking changes: * Graphs runtime changes to use PI/UR command-buffers. * Various improvements to the Graphs runtime classes. * New memory manager methods for appending copies to a command-buffer. * Changes to the Scheduler and related CG classes to enable Graphs. * Device info query for command-graph support. * Minor changes to some runtime classes to enable Graphs. ## Following Split PRs Future follow-up PRs with the remainder of our work on the extension will include: * Add end-to-end tests for SYCL Graph extension. (4/4) * NFC changes - Design doc and codeowner update. ## Authors Co-authored-by: Pablo Reble <[email protected]> Co-authored-by: Julian Miller <[email protected]> Co-authored-by: Ben Tracy <[email protected]> Co-authored-by: Ewan Crawford <[email protected]> Co-authored-by: Maxime France-Pillois <[email protected]>

# Level Zero Backend Support for SYCL Graphs This is the second patch of a series that adds support for an [experimental command graph extension](intel/llvm#5626) A snapshot of the complete work can be seen in draft PR #9375 which has support all the specification defined ways of adding nodes and edges to the graph, including both Explicit and Record & Replay graph construction. The two types of nodes currently implemented are kernel execution and memcpy commands. See https://github.com/reble/llvm#implementation-status for the status of our total work. ## Scope This second patch focuses on the required PI/UR support for the experimental command-buffer feature in the Level Zero adapter: * PI stubs for all adapters to enable compilation, no functionality. * Command-buffer implementation for the Level Zero UR adapter. * Stubs for the CUDA UR adapter to enable compilation, no functionality. ## Following Split PRs Future follow-up PRs with the remainder of our work on the extension will include: * Hooking up backend to graphs runtime, bugfixes and other feature additions, will add symbols but not break the ABI. (3/4) * Add end-to-end tests for SYCL Graph extension. (4/4) * NFC changes - Design doc and codeowner update. ## Authors Co-authored-by: Pablo Reble <[email protected]> Co-authored-by: Julian Miller <[email protected]> Co-authored-by: Ben Tracy <[email protected]> Co-authored-by: Ewan Crawford <[email protected]> Co-authored-by: Maxime France-Pillois <[email protected]> --------- Co-authored-by: Ewan Crawford <[email protected]> Co-authored-by: Maxime France-Pillois <[email protected]>

Ruyk reviewed Feb 22, 2022

View reviewed changes

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

Pennycook reviewed Feb 22, 2022

View reviewed changes

keryell reviewed Mar 11, 2022

View reviewed changes

guoyejun reviewed Apr 16, 2022

View reviewed changes

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

guoyejun reviewed Apr 16, 2022

View reviewed changes

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

EwanC mentioned this pull request May 17, 2022

Permissibility of Internal Queues in Command Buffers KhronosGroup/OpenCL-Docs#800

Open

reble requested a review from Pennycook May 25, 2022 16:59

reble added 8 commits August 11, 2022 16:22

Inital version of sycl graph prototype

ef24789

Adding initial sycl graph doc

a786fee

update extension proposal started to incorporate feedback

a6c9b11

typo

da316f5

fix typos and syntax issues

719e3ec

Revert "Inital version of sycl graph prototype"

cb9d49b

This reverts commit ef24789.

move extension doc to proposed folder

86436c3

Rework formatting and introducing USM shortcuts

d410644

reble force-pushed the sycl-graph-update branch from 5956e20 to d410644 Compare August 12, 2022 15:16

reble changed the title ~~[SYCL] Graph API extensions~~ [SYCL][DOC] Graph API extensions Aug 12, 2022

reble added 3 commits August 12, 2022 10:26

Update sycl_ext_oneapi_graph.asciidoc

9207754

Change status to proposal

Update sycl_ext_oneapi_graph.asciidoc

01e06f6

Remove implementation specifics from doc

cc1f315

reble marked this pull request as ready for review August 12, 2022 17:09

reble requested a review from a team as a code owner August 12, 2022 17:09

keryell reviewed Aug 12, 2022

View reviewed changes

Pennycook reviewed Aug 22, 2022

View reviewed changes

reble and others added 3 commits August 22, 2022 14:38

Remove obsolete note

fbccd9a

Co-authored-by: John Pennycook <[email protected]>

wording

e5435e6

Co-authored-by: John Pennycook <[email protected]>

bump target spec rev

54f4f9d

Co-authored-by: Ronan Keryell <[email protected]>

[SYCL][Doc] Address superficial Graphs spec feedback (#253)

1a42a44

Gordon and Greg left some spec feedback on our upstream PR, address the superficial comments.

gmlueck approved these changes Jul 11, 2023

View reviewed changes

steffenlarsen reviewed Jul 11, 2023

View reviewed changes

sycl/doc/extensions/proposed/sycl_ext_oneapi_graph.asciidoc Show resolved Hide resolved

EwanC mentioned this pull request Jul 11, 2023

[SYCL][Doc] Change graph_support_level namespace reble/llvm#255

Merged

jandres742 reviewed Jul 11, 2023

View reviewed changes

EwanC added 2 commits July 11, 2023 18:59

EwanC mentioned this pull request Jul 12, 2023

[SYCL][Doc] Rephrase "recording to" reble/llvm#257

Merged

steffenlarsen approved these changes Jul 12, 2023

View reviewed changes

steffenlarsen requested a review from jandres742 July 12, 2023 13:59

[SYCL][Graph] Revise undefined behaviour with no_cycle_check (#263)

b03b6ad

- Change wording around undefined behaviour when creating a cycle with no checks - UB is created at point of adding the cycle, not at finalize.

jandres742 reviewed Jul 18, 2023

View reviewed changes

steffenlarsen merged commit f9d4830 into intel:sycl Jul 19, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[SYCL][DOC] Graph API extensions #5626

[SYCL][DOC] Graph API extensions #5626

reble commented Feb 22, 2022 •

edited

Loading

keryell commented Mar 5, 2022

jbrodman commented Mar 17, 2022

keryell commented Mar 17, 2022 •

edited

Loading

keryell left a comment

gmlueck left a comment

jandres742 Jul 11, 2023

EwanC Jul 12, 2023

steffenlarsen left a comment

jandres742 left a comment

steffenlarsen commented Jul 19, 2023

[SYCL][DOC] Graph API extensions #5626

[SYCL][DOC] Graph API extensions #5626

Conversation

reble commented Feb 22, 2022 • edited Loading

keryell commented Mar 5, 2022

jbrodman commented Mar 17, 2022

keryell commented Mar 17, 2022 • edited Loading

keryell left a comment

Choose a reason for hiding this comment

gmlueck left a comment

Choose a reason for hiding this comment

jandres742 Jul 11, 2023

Choose a reason for hiding this comment

EwanC Jul 12, 2023

Choose a reason for hiding this comment

steffenlarsen left a comment

Choose a reason for hiding this comment

jandres742 left a comment

Choose a reason for hiding this comment

steffenlarsen commented Jul 19, 2023

reble commented Feb 22, 2022 •

edited

Loading

keryell commented Mar 17, 2022 •

edited

Loading