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

Clarify and deprecate "execution_capabilities" #625

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Clarify and deprecate "execution_capabilities" #625

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5b8c4bc
Clarify and deprecate "execution_capabilities"
gmlueck Sep 19, 2024
0e41496
Deprecate in SYCL 2020 instead
gmlueck Nov 7, 2024
e49d70c
One more place to change to SYCL 2020
gmlueck Nov 7, 2024
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
36 changes: 33 additions & 3 deletions adoc/chapters/programming_interface.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2748,12 +2748,19 @@ struct execution_capabilities {
} // namespace sycl::info::device
----

Deprecated by SYCL 2020.

_Remarks:_ Template parameter to [api]#device::get_info#.

_Returns:_ A [code]#std::vector# of the [api]#info::execution_capability# values
_Returns:_ Only supported when the backend of this device is OpenCL (see
<<chapter:opencl-backend>>).
Returns a [code]#std::vector# of the [api]#info::execution_capability# values
describing the supported execution capabilities.
Note that this information is intended for OpenCL interoperability only as SYCL
only supports [api]#info::execution_capability::exec_kernel#.
Unless the device type is [api]#info::device_type::custom#, the returned vector
will always include [api]#info::execution_capability::exec_kernel#.

_Throws:_ An [code]#exception# with the [code]#errc::invalid# error code if the
backend of this device is not OpenCL.

'''

Expand Down Expand Up @@ -3658,6 +3665,11 @@ enum class global_mem_cache_type : /* unspecified */ {
[[sec:device-enum-execution-capability]]
===== Execution capability

Deprecated by SYCL 2020.

The [code]#info::execution_capability# enumeration tells the type of kernels
that can be submitted to a device from the OpenCL backend.

[source,role=synopsis]
----
namespace sycl::info {
Expand All @@ -3668,6 +3680,24 @@ enum class execution_capability : /* unspecified */ {
} // namespace sycl::info
----

'''

.[apidef]#info::execution_capability::exec_kernel#
[role=synopsis,id=api:info-execution-capability-exec-kernel]
--
Device can execute SYCL kernels.
--

'''

.[apidef]#info::execution_capability::exec_native_kernel#
[role=synopsis,id=api:info-execution-capability-exec-native-kernel]
--
Device can execute native OpenCL kernels.
--

'''


[[sec:interface.queue.class]]
=== Queue class
Expand Down
1 change: 0 additions & 1 deletion adoc/config/api_xrefs.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
info::device_type::custom=sec:device-enum-device-type \
info::device_type::all=sec:device-enum-device-type \
info::execution_capability=sec:device-enum-execution-capability \
info::execution_capability::exec_kernel=sec:device-enum-execution-capability \
info::fp_config=sec:device-enum-fp-config \
info::global_mem_cache_type=sec:device-enum-global-mem-cache-type \
info::local_mem_type=sec:device-enum-local-mem-type \
Expand Down