[SYCL][Docs] Add sycl_ext_oneapi_inter_process_communication #20018
+855
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
steffenlarsen
had a problem deploying
to
WindowsCILock
GitHub Actions
Failure
steffenlarsen
force-pushed
the
ext_oneapi_inter_process_communication
branch
from
cae8ee3 to
14415fe
Compare
steffenlarsen
had a problem deploying
to
WindowsCILock
GitHub Actions
Failure
steffenlarsen
temporarily deployed
to
WindowsCILock
GitHub Actions
Inactive
steffenlarsen
temporarily deployed
to
WindowsCILock
GitHub Actions
Inactive
steffenlarsen
force-pushed
the
ext_oneapi_inter_process_communication
branch
from
14415fe to
89f495c
Compare
steffenlarsen
had a problem deploying
to
WindowsCILock
GitHub Actions
Failure
steffenlarsen
temporarily deployed
to
WindowsCILock
GitHub Actions
Inactive
steffenlarsen
had a problem deploying
to
WindowsCILock
GitHub Actions
Error
steffenlarsen
force-pushed
the
ext_oneapi_inter_process_communication
branch
from
89f495c to
5f443ab
Compare
steffenlarsen
had a problem deploying
to
WindowsCILock
GitHub Actions
Failure
steffenlarsen
had a problem deploying
to
WindowsCILock
GitHub Actions
Failure
steffenlarsen
temporarily deployed
to
WindowsCILock
GitHub Actions
Inactive
steffenlarsen
force-pushed
the
ext_oneapi_inter_process_communication
branch
from
5f443ab to
b7d2052
Compare
steffenlarsen
temporarily deployed
to
WindowsCILock
GitHub Actions
Inactive
steffenlarsen
had a problem deploying
to
WindowsCILock
GitHub Actions
Failure
steffenlarsen
had a problem deploying
to
WindowsCILock
GitHub Actions
Failure
steffenlarsen
force-pushed
the
ext_oneapi_inter_process_communication
branch
from
b7d2052 to
07f4355
Compare
steffenlarsen
temporarily deployed
to
WindowsCILock
GitHub Actions
Inactive
steffenlarsen
had a problem deploying
to
WindowsCILock
GitHub Actions
Failure
steffenlarsen
had a problem deploying
to
WindowsCILock
GitHub Actions
Failure
steffenlarsen
force-pushed
the
ext_oneapi_inter_process_communication
branch
from
07f4355 to
7364b75
Compare
steffenlarsen
temporarily deployed
to
WindowsCILock
GitHub Actions
Inactive
steffenlarsen
had a problem deploying
to
WindowsCILock
GitHub Actions
Failure
steffenlarsen
had a problem deploying
to
WindowsCILock
GitHub Actions
Failure
This commit adds a new extension for inter-process communicable SYCL object handles. As part of the initial version of this extension, only inter-process communicable memory is exposed. Signed-off-by: Larsen, Steffen <[email protected]>
steffenlarsen
force-pushed
the
ext_oneapi_inter_process_communication
branch
from
7364b75 to
eec1fe5
Compare
steffenlarsen
temporarily deployed
to
WindowsCILock
GitHub Actions
Inactive
steffenlarsen
had a problem deploying
to
WindowsCILock
GitHub Actions
Failure
steffenlarsen
had a problem deploying
to
WindowsCILock
GitHub Actions
Failure
Signed-off-by: Larsen, Steffen <[email protected]>
Signed-off-by: Larsen, Steffen <[email protected]>
steffenlarsen
had a problem deploying
to
WindowsCILock
GitHub Actions
Error
Signed-off-by: Larsen, Steffen <[email protected]>
steffenlarsen
had a problem deploying
to
WindowsCILock
GitHub Actions
Error
Signed-off-by: Larsen, Steffen <[email protected]>
steffenlarsen
temporarily deployed
to
WindowsCILock
GitHub Actions
Inactive
steffenlarsen
temporarily deployed
to
WindowsCILock
GitHub Actions
Inactive
steffenlarsen
temporarily deployed
to
WindowsCILock
GitHub Actions
Inactive
gmlueck
reviewed
Oct 17, 2025
sycl/doc/extensions/experimental/sycl_ext_oneapi_inter_process_communication.asciidoc
Outdated
Show resolved
Hide resolved
sycl/doc/extensions/experimental/sycl_ext_oneapi_inter_process_communication.asciidoc
Outdated
Show resolved
Hide resolved
| * An exception with the `errc::feature_not_supported` error code if device | ||
| `dev` does not have `aspect::ext_oneapi_ipc_memory`. | ||
| * An exception with the `errc::invalid` error code if the handle data | ||
| `handle_data` has an unexpected number of bytes. |
There was a problem hiding this comment.
What if the number of bytes is correct, but the content is garbage? Can we broaden this exception like this:
- An exception with the
errc::invaliderror code if the handle datahandle_datadoes not represent a valid IPC handle for USM memory on this host system.
That would also cover the case when the handle had the wrong number of bytes.
There was a problem hiding this comment.
I am reluctant to promise an error code if handle data is corrupt. The byte size is something we can check at a SYCL/UR level, but the validity of the data is up to UMF to decide and the API documentation doesn't specify which error is returned if the data is off. Maybe a precondition?
There was a problem hiding this comment.
I think you should push this requirement down to the UMF and down to Level Zero if necessary. They should be able to define an error code for this.
There was a problem hiding this comment.
I will open an issue against UMF, but I think it might be tricky. What happens if the data looks correct to UMF, but using it causes UB or invalid access in the implementation? I suppose that's something they can look into though.
There was a problem hiding this comment.
UMF shouldn't look at the handle content at all. It should just pass it to the underlying driver API, and that API should return an error code if the handle content is invalid. This assumes that each driver is able to diagnose an error in such a case, but that seems quite reasonable to me. For example, cudaIpcOpenMemHandle is defined to return cudaErrorInvalidResourceHandle in this case. I don't see an error code listed for Level Zero, but that seems like a bug. They should be able to return an error code.
There was a problem hiding this comment.
There may be some wrapper information in the UMF IPC handle, but I don't know the exact details. Maybe @vinser52 has some insight into this?
There was a problem hiding this comment.
Friendly ping, @vinser52 .
sycl/doc/extensions/experimental/sycl_ext_oneapi_inter_process_communication.asciidoc
Outdated
Show resolved
Hide resolved
sycl/doc/extensions/experimental/sycl_ext_oneapi_inter_process_communication.asciidoc
Outdated
Show resolved
Hide resolved
Signed-off-by: Larsen, Steffen <[email protected]>
steffenlarsen
temporarily deployed
to
WindowsCILock
GitHub Actions
Inactive
steffenlarsen
temporarily deployed
to
WindowsCILock
GitHub Actions
Inactive
steffenlarsen
temporarily deployed
to
WindowsCILock
GitHub Actions
Inactive
gmlueck
reviewed
Oct 17, 2025
sycl/doc/extensions/experimental/sycl_ext_oneapi_inter_process_communication.asciidoc
Show resolved
Hide resolved
Signed-off-by: Larsen, Steffen <[email protected]>
steffenlarsen
had a problem deploying
to
WindowsCILock
GitHub Actions
Failure
steffenlarsen
temporarily deployed
to
WindowsCILock
GitHub Actions
Inactive
steffenlarsen
temporarily deployed
to
WindowsCILock
GitHub Actions
Inactive
againull
approved these changes
Oct 17, 2025
Signed-off-by: Larsen, Steffen <[email protected]>
steffenlarsen
had a problem deploying
to
WindowsCILock
GitHub Actions
Failure
steffenlarsen
temporarily deployed
to
WindowsCILock
GitHub Actions
Inactive
steffenlarsen
temporarily deployed
to
WindowsCILock
GitHub Actions
Inactive
Signed-off-by: Larsen, Steffen <[email protected]>
steffenlarsen
temporarily deployed
to
WindowsCILock
GitHub Actions
Inactive
steffenlarsen
had a problem deploying
to
WindowsCILock
GitHub Actions
Failure
steffenlarsen
temporarily deployed
to
WindowsCILock
GitHub Actions
Inactive
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
7 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit adds a new extension for inter-process communicable SYCL object handles. As part of the initial version of this extension, only inter-process communicable memory is exposed.