-
Couldn't load subscription status.
- Fork 793
[SYCL][Doc] Add spec for device's default context #20469
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.
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
steffenlarsen
merged 2 commits into
intel:sycl
from
gmlueck:gmlueck/device-default-context
Oct 27, 2025
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
125 changes: 125 additions & 0 deletions
125
sycl/doc/extensions/proposed/sycl_ext_oneapi_device_default_context.asciidoc
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,125 @@ | ||
| = sycl_ext_oneapi_device_default_context | ||
|
|
||
| :source-highlighter: coderay | ||
| :coderay-linenums-mode: table | ||
|
|
||
| // This section needs to be after the document title. | ||
| :doctype: book | ||
| :toc2: | ||
| :toc: left | ||
| :encoding: utf-8 | ||
| :lang: en | ||
| :dpcpp: pass:[DPC++] | ||
| :endnote: —{nbsp}end{nbsp}note | ||
|
|
||
| // Set the default source code type in this document to C++, | ||
| // for syntax highlighting purposes. This is needed because | ||
| // docbook uses c++ and html5 uses cpp. | ||
| :language: {basebackend@docbook:c++:cpp} | ||
|
|
||
|
|
||
| == Notice | ||
|
|
||
| [%hardbreaks] | ||
| Copyright (C) 2025 Intel Corporation. All rights reserved. | ||
|
|
||
| Khronos(R) is a registered trademark and SYCL(TM) and SPIR(TM) are trademarks | ||
| of The Khronos Group Inc. OpenCL(TM) is a trademark of Apple Inc. used by | ||
| permission by Khronos. | ||
|
|
||
|
|
||
| == Contact | ||
|
|
||
| To report problems with this extension, please open a new issue at: | ||
|
|
||
| https://github.com/intel/llvm/issues | ||
|
|
||
|
|
||
| == Dependencies | ||
|
|
||
| This extension is written against the SYCL 2020 revision 10 specification. | ||
| All references below to the "core SYCL specification" or to section numbers in | ||
| the SYCL specification refer to that revision. | ||
|
|
||
| [_Note:_ The APIs in this extension depend on the concept of a per-platform | ||
| default context as specified in section 4.6.2 "Platform class" of the core SYCL | ||
| specification. | ||
| As a convenience, this extension specification describes the behavior of its | ||
| APIs by using the `khr_get_default_context` function from {khr-default-context}[ | ||
| sycl_khr_default_context], however there is no true dependency on that | ||
| extension. | ||
| An implementation could still implement sycl_ext_oneapi_device_default_context | ||
| even without implementing sycl_khr_default_context because the core SYCL | ||
| specification still requires there to be a per-platform default context even if | ||
| the core SYCL specification does not provide a convenient way to get it. | ||
| _{endnote}_] | ||
|
|
||
|
|
||
| == 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. | ||
| *Shipping software products should not rely on APIs defined in this | ||
| specification.* | ||
|
|
||
|
|
||
| == Overview | ||
|
|
||
| This extension provides a shortcut to get the platform's default context from a | ||
| `device` object. | ||
|
|
||
|
|
||
| == Specification | ||
|
|
||
| === Feature test macro | ||
|
|
||
| This extension provides a feature-test macro as described in the core SYCL | ||
| specification. | ||
| An implementation supporting this extension must predefine the macro | ||
| `SYCL_EXT_ONEAPI_DEVICE_DEFAULT_CONTEXT` to one of the values defined in the | ||
| table below. | ||
| Applications can test for the existence of this macro to determine if the | ||
| implementation supports this feature, or applications can test the macro's value | ||
| to determine which of the extension's features the implementation supports. | ||
|
|
||
| [%header,cols="1,5"] | ||
| |=== | ||
| |Value | ||
| |Description | ||
|
|
||
| |1 | ||
| |The APIs of this experimental extension are not versioned, so the | ||
| feature-test macro always has this value. | ||
| |=== | ||
|
|
||
| === New member function in the device class | ||
|
|
||
| This extension adds the following new member function to the `device` class. | ||
|
|
||
| [source,c++] | ||
| ---- | ||
| class device { | ||
| // ... | ||
| context ext_oneapi_get_default_context(); | ||
| }; | ||
| ---- | ||
|
|
||
| ''' | ||
|
|
||
| [source,c++] | ||
| ---- | ||
| context ext_oneapi_get_default_context(); | ||
| ---- | ||
|
|
||
| _Effects_: Equivalent to: | ||
|
|
||
| [source,c++,indent=2] | ||
| ---- | ||
| return get_platform().khr_get_default_context(); | ||
| ---- | ||
|
|
||
| ''' | ||
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.
Uh oh!
There was an error while loading. Please reload this page.