Skip to content

[SYCL] Deprecate single_task() and parallel_for() overloads with properties #16728

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

Merged
merged 3 commits into from
Feb 7, 2025
Merged

[SYCL] Deprecate single_task() and parallel_for() overloads with properties #16728

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
19a629d
[SYCL] Deprecate single_task and parallel_for overloads with properties
HPS-1 Jan 22, 2025
3273f95
[SYCL] Update deprecation warning messages
HPS-1 Jan 28, 2025
a591016
Merge remote-tracking branch 'origin/sycl' into issue-63482-A
HPS-1 Feb 5, 2025
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
126 changes: 87 additions & 39 deletions sycl/include/sycl/handler.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2324,61 +2324,86 @@ class __SYCL_EXPORT handler {

template <typename KernelName = detail::auto_name, typename KernelType,
typename PropertiesT>
std::enable_if_t<
ext::oneapi::experimental::is_property_list<PropertiesT>::value>
single_task(PropertiesT Props, _KERNELFUNCPARAM(KernelFunc)) {
__SYCL_DEPRECATED("To specify properties, use a launch configuration object "
"of type launch_config or a kernel functor with a "
"get(sycl::ext::oneapi::experimental::properties_tag) "
"member function instead.")
std::enable_if_t<ext::oneapi::experimental::is_property_list<
PropertiesT>::value> single_task(PropertiesT Props,
_KERNELFUNCPARAM(KernelFunc)) {
single_task_lambda_impl<KernelName, KernelType, PropertiesT>(Props,
KernelFunc);
}

template <typename KernelName = detail::auto_name, typename KernelType,
typename PropertiesT>
std::enable_if_t<
ext::oneapi::experimental::is_property_list<PropertiesT>::value>
parallel_for(range<1> NumWorkItems, PropertiesT Props,
_KERNELFUNCPARAM(KernelFunc)) {
__SYCL_DEPRECATED("To specify properties, use a launch configuration object "
"of type launch_config or a kernel functor with a "
"get(sycl::ext::oneapi::experimental::properties_tag) "
"member function instead.")
std::enable_if_t<ext::oneapi::experimental::is_property_list<
PropertiesT>::value> parallel_for(range<1> NumWorkItems,
PropertiesT Props,
_KERNELFUNCPARAM(KernelFunc)) {
parallel_for_lambda_impl<KernelName, KernelType, 1, PropertiesT>(
NumWorkItems, Props, std::move(KernelFunc));
}

template <typename KernelName = detail::auto_name, typename KernelType,
typename PropertiesT>
std::enable_if_t<
ext::oneapi::experimental::is_property_list<PropertiesT>::value>
parallel_for(range<2> NumWorkItems, PropertiesT Props,
_KERNELFUNCPARAM(KernelFunc)) {
__SYCL_DEPRECATED("To specify properties, use a launch configuration object "
"of type launch_config or a kernel functor with a "
"get(sycl::ext::oneapi::experimental::properties_tag) "
"member function instead.")
std::enable_if_t<ext::oneapi::experimental::is_property_list<
PropertiesT>::value> parallel_for(range<2> NumWorkItems,
PropertiesT Props,
_KERNELFUNCPARAM(KernelFunc)) {
parallel_for_lambda_impl<KernelName, KernelType, 2, PropertiesT>(
NumWorkItems, Props, std::move(KernelFunc));
}

template <typename KernelName = detail::auto_name, typename KernelType,
typename PropertiesT>
std::enable_if_t<
ext::oneapi::experimental::is_property_list<PropertiesT>::value>
parallel_for(range<3> NumWorkItems, PropertiesT Props,
_KERNELFUNCPARAM(KernelFunc)) {
__SYCL_DEPRECATED("To specify properties, use a launch configuration object "
"of type launch_config or a kernel functor with a "
"get(sycl::ext::oneapi::experimental::properties_tag) "
"member function instead.")
std::enable_if_t<ext::oneapi::experimental::is_property_list<
PropertiesT>::value> parallel_for(range<3> NumWorkItems,
PropertiesT Props,
_KERNELFUNCPARAM(KernelFunc)) {
parallel_for_lambda_impl<KernelName, KernelType, 3, PropertiesT>(
NumWorkItems, Props, std::move(KernelFunc));
}

template <typename KernelName = detail::auto_name, typename KernelType,
typename PropertiesT, int Dims>
std::enable_if_t<
ext::oneapi::experimental::is_property_list<PropertiesT>::value>
parallel_for(nd_range<Dims> Range, PropertiesT Properties,
_KERNELFUNCPARAM(KernelFunc)) {
__SYCL_DEPRECATED("To specify properties, use a launch configuration object "
"of type launch_config or a kernel functor with a "
"get(sycl::ext::oneapi::experimental::properties_tag) "
"member function instead.")
std::enable_if_t<ext::oneapi::experimental::is_property_list<
PropertiesT>::value> parallel_for(nd_range<Dims> Range,
PropertiesT Properties,
_KERNELFUNCPARAM(KernelFunc)) {
parallel_for_impl<KernelName>(Range, Properties, std::move(KernelFunc));
}

/// Reductions @{

template <typename KernelName = detail::auto_name, typename PropertiesT,
typename... RestT>
std::enable_if_t<
(sizeof...(RestT) > 1) &&
detail::AreAllButLastReductions<RestT...>::value &&
ext::oneapi::experimental::is_property_list<PropertiesT>::value>
parallel_for(range<1> Range, PropertiesT Properties, RestT &&...Rest) {
__SYCL_DEPRECATED("To specify properties, use a launch configuration object "
"of type launch_config or a kernel functor with a "
"get(sycl::ext::oneapi::experimental::properties_tag) "
"member function instead.")
std::enable_if_t<(sizeof...(RestT) > 1) &&
detail::AreAllButLastReductions<RestT...>::value &&
ext::oneapi::experimental::is_property_list<
PropertiesT>::value> parallel_for(range<1> Range,
PropertiesT Properties,
RestT &&...Rest) {
#ifndef __SYCL_DEVICE_ONLY__
throwIfGraphAssociated<ext::oneapi::experimental::detail::
UnsupportedGraphFeatures::sycl_reductions>();
Expand All @@ -2389,11 +2414,16 @@ class __SYCL_EXPORT handler {

template <typename KernelName = detail::auto_name, typename PropertiesT,
typename... RestT>
std::enable_if_t<
(sizeof...(RestT) > 1) &&
detail::AreAllButLastReductions<RestT...>::value &&
ext::oneapi::experimental::is_property_list<PropertiesT>::value>
parallel_for(range<2> Range, PropertiesT Properties, RestT &&...Rest) {
__SYCL_DEPRECATED("To specify properties, use a launch configuration object "
"of type launch_config or a kernel functor with a "
"get(sycl::ext::oneapi::experimental::properties_tag) "
"member function instead.")
std::enable_if_t<(sizeof...(RestT) > 1) &&
detail::AreAllButLastReductions<RestT...>::value &&
ext::oneapi::experimental::is_property_list<
PropertiesT>::value> parallel_for(range<2> Range,
PropertiesT Properties,
RestT &&...Rest) {
#ifndef __SYCL_DEVICE_ONLY__
throwIfGraphAssociated<ext::oneapi::experimental::detail::
UnsupportedGraphFeatures::sycl_reductions>();
Expand All @@ -2404,11 +2434,16 @@ class __SYCL_EXPORT handler {

template <typename KernelName = detail::auto_name, typename PropertiesT,
typename... RestT>
std::enable_if_t<
(sizeof...(RestT) > 1) &&
detail::AreAllButLastReductions<RestT...>::value &&
ext::oneapi::experimental::is_property_list<PropertiesT>::value>
parallel_for(range<3> Range, PropertiesT Properties, RestT &&...Rest) {
__SYCL_DEPRECATED("To specify properties, use a launch configuration object "
"of type launch_config or a kernel functor with a "
"get(sycl::ext::oneapi::experimental::properties_tag) "
"member function instead.")
std::enable_if_t<(sizeof...(RestT) > 1) &&
detail::AreAllButLastReductions<RestT...>::value &&
ext::oneapi::experimental::is_property_list<
PropertiesT>::value> parallel_for(range<3> Range,
PropertiesT Properties,
RestT &&...Rest) {
#ifndef __SYCL_DEVICE_ONLY__
throwIfGraphAssociated<ext::oneapi::experimental::detail::
UnsupportedGraphFeatures::sycl_reductions>();
Expand Down Expand Up @@ -2443,11 +2478,16 @@ class __SYCL_EXPORT handler {

template <typename KernelName = detail::auto_name, int Dims,
typename PropertiesT, typename... RestT>
std::enable_if_t<
(sizeof...(RestT) > 1) &&
detail::AreAllButLastReductions<RestT...>::value &&
ext::oneapi::experimental::is_property_list<PropertiesT>::value>
parallel_for(nd_range<Dims> Range, PropertiesT Properties, RestT &&...Rest) {
__SYCL_DEPRECATED("To specify properties, use a launch configuration object "
"of type launch_config or a kernel functor with a "
"get(sycl::ext::oneapi::experimental::properties_tag) "
"member function instead.")
std::enable_if_t<(sizeof...(RestT) > 1) &&
detail::AreAllButLastReductions<RestT...>::value &&
ext::oneapi::experimental::is_property_list<
PropertiesT>::value> parallel_for(nd_range<Dims> Range,
PropertiesT Properties,
RestT &&...Rest) {
#ifndef __SYCL_DEVICE_ONLY__
throwIfGraphAssociated<ext::oneapi::experimental::detail::
UnsupportedGraphFeatures::sycl_reductions>();
Expand All @@ -2469,6 +2509,10 @@ class __SYCL_EXPORT handler {

template <typename KernelName = detail::auto_name, typename KernelType,
int Dims, typename PropertiesT>
__SYCL_DEPRECATED("To specify properties, use a launch configuration object "
"of type launch_config or a kernel functor with a "
"get(sycl::ext::oneapi::experimental::properties_tag) "
"member function instead.")
void parallel_for_work_group(range<Dims> NumWorkGroups, PropertiesT Props,
_KERNELFUNCPARAM(KernelFunc)) {
parallel_for_work_group_lambda_impl<KernelName, KernelType, Dims,
Expand All @@ -2478,6 +2522,10 @@ class __SYCL_EXPORT handler {

template <typename KernelName = detail::auto_name, typename KernelType,
int Dims, typename PropertiesT>
__SYCL_DEPRECATED("To specify properties, use a launch configuration object "
"of type launch_config or a kernel functor with a "
"get(sycl::ext::oneapi::experimental::properties_tag) "
"member function instead.")
void parallel_for_work_group(range<Dims> NumWorkGroups,
range<Dims> WorkGroupSize, PropertiesT Props,
_KERNELFUNCPARAM(KernelFunc)) {
Expand Down
Loading