Skip to content

[SYCL] Restrict nd_range parallel_for to nd_item #11067

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 2 commits into from
Sep 6, 2023
Merged

[SYCL] Restrict nd_range parallel_for to nd_item #11067

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9e0db84
[SYCL] Restrict nd_range parallel_for to nd_item
steffenlarsen Sep 5, 2023
11e5b62
Update sycl/include/sycl/handler.hpp
steffenlarsen Sep 5, 2023
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
9 changes: 9 additions & 0 deletions sycl/include/sycl/handler.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1191,10 +1191,19 @@ class __SYCL_EXPORT handler {
verifyUsedKernelBundle(detail::KernelInfo<NameT>::getName());
using LambdaArgType =
sycl::detail::lambda_arg_type<KernelType, nd_item<Dims>>;
#ifdef SYCL2020_CONFORMANT_APIS
static_assert(
std::is_convertible_v<sycl::nd_item<Dims>, LambdaArgType>,
"Kernel argument of a sycl::parallel_for with sycl::nd_range "
"must be either sycl::nd_item or be convertible from sycl::nd_item");
using TransformedArgType = sycl::nd_item<Dims>;
#else
// If user type is convertible from sycl::item/sycl::nd_item, use
// sycl::item/sycl::nd_item to transport item information
using TransformedArgType =
typename TransformUserItemType<Dims, LambdaArgType>::type;
#endif

(void)ExecutionRange;
kernel_parallel_for_wrapper<NameT, TransformedArgType, KernelType,
PropertiesT>(KernelFunc);
Expand Down
103 changes: 103 additions & 0 deletions sycl/test/basic_tests/handler/parallel_for_arg_restrictions.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
// RUN: %clangxx -fsycl -fsyntax-only -ferror-limit=0 -Xclang -verify -Xclang -verify-ignore-unexpected=note,warning,error %s
// RUN: %clangxx -fsycl -fsyntax-only -ferror-limit=0 -Xclang -verify -Xclang -verify-ignore-unexpected=note,warning,error %s -DSYCL2020_CONFORMANT_APIS

// Tests the requirements on the first argument in a kernel lambda.
// TODO: Some of the behavior is currently guarded behind
// SYCL2020_CONFORMANT_APIS. Remove the definition when this behavior has
// been promoted.

#include <sycl/sycl.hpp>

template <int Dims> struct ConvertibleFromItem {
ConvertibleFromItem(sycl::item<Dims>) {}
};

template <int Dims> struct ConvertibleFromNDItem {
ConvertibleFromNDItem(sycl::nd_item<Dims>) {}
};

int main() {
sycl::queue Q;

// TODO: Remove this when the guarded behavior is promoted.
#ifdef SYCL2020_CONFORMANT_APIS
// ND-range parallel_for with item.
Q.submit([&](sycl::handler &CGH) {
// expected-error@sycl/handler.hpp:* {{Kernel argument of a sycl::parallel_for with sycl::nd_range must be either sycl::nd_item or be convertible from sycl::nd_item}}
CGH.parallel_for(sycl::nd_range{sycl::range{1}, sycl::range{1}},
[=](sycl::item<1>) {});
});
Q.submit([&](sycl::handler &CGH) {
// expected-error@sycl/handler.hpp:* {{Kernel argument of a sycl::parallel_for with sycl::nd_range must be either sycl::nd_item or be convertible from sycl::nd_item}}
CGH.parallel_for(sycl::nd_range{sycl::range{1, 1}, sycl::range{1, 1}},
[=](sycl::item<2>) {});
});
Q.submit([&](sycl::handler &CGH) {
// expected-error@sycl/handler.hpp:* {{Kernel argument of a sycl::parallel_for with sycl::nd_range must be either sycl::nd_item or be convertible from sycl::nd_item}}
CGH.parallel_for(sycl::nd_range{sycl::range{1, 1, 1}, sycl::range{1, 1, 1}},
[=](sycl::item<3>) {});
});

// ND-range parallel_for with id.
Q.submit([&](sycl::handler &CGH) {
// expected-error@sycl/handler.hpp:* {{Kernel argument of a sycl::parallel_for with sycl::nd_range must be either sycl::nd_item or be convertible from sycl::nd_item}}
CGH.parallel_for(sycl::nd_range{sycl::range{1}, sycl::range{1}},
[=](sycl::id<1>) {});
});
Q.submit([&](sycl::handler &CGH) {
// expected-error@sycl/handler.hpp:* {{Kernel argument of a sycl::parallel_for with sycl::nd_range must be either sycl::nd_item or be convertible from sycl::nd_item}}
CGH.parallel_for(sycl::nd_range{sycl::range{1, 1}, sycl::range{1, 1}},
[=](sycl::id<2>) {});
});
Q.submit([&](sycl::handler &CGH) {
// expected-error@sycl/handler.hpp:* {{Kernel argument of a sycl::parallel_for with sycl::nd_range must be either sycl::nd_item or be convertible from sycl::nd_item}}
CGH.parallel_for(sycl::nd_range{sycl::range{1, 1, 1}, sycl::range{1, 1, 1}},
[=](sycl::id<3>) {});
});

// ND-range parallel_for with argument that is convertible from item.
Q.submit([&](sycl::handler &CGH) {
// expected-error@sycl/handler.hpp:* {{Kernel argument of a sycl::parallel_for with sycl::nd_range must be either sycl::nd_item or be convertible from sycl::nd_item}}
CGH.parallel_for(sycl::nd_range{sycl::range{1}, sycl::range{1}},
[=](ConvertibleFromItem<1>) {});
});
Q.submit([&](sycl::handler &CGH) {
// expected-error@sycl/handler.hpp:* {{Kernel argument of a sycl::parallel_for with sycl::nd_range must be either sycl::nd_item or be convertible from sycl::nd_item}}
CGH.parallel_for(sycl::nd_range{sycl::range{1, 1}, sycl::range{1, 1}},
[=](ConvertibleFromItem<2>) {});
});
Q.submit([&](sycl::handler &CGH) {
// expected-error@sycl/handler.hpp:* {{Kernel argument of a sycl::parallel_for with sycl::nd_range must be either sycl::nd_item or be convertible from sycl::nd_item}}
CGH.parallel_for(sycl::nd_range{sycl::range{1, 1, 1}, sycl::range{1, 1, 1}},
[=](ConvertibleFromItem<3>) {});
});
#endif // SYCL2020_CONFORMANT_APIS

// Range parallel_for with nd_item.
Q.submit([&](sycl::handler &CGH) {
// expected-error@sycl/handler.hpp:* {{Kernel argument cannot have a sycl::nd_item type in sycl::parallel_for with sycl::range}}
CGH.parallel_for(sycl::range{1}, [=](sycl::nd_item<1>) {});
});
Q.submit([&](sycl::handler &CGH) {
// expected-error@sycl/handler.hpp:* {{Kernel argument cannot have a sycl::nd_item type in sycl::parallel_for with sycl::range}}
CGH.parallel_for(sycl::range{1, 1}, [=](sycl::nd_item<2>) {});
});
Q.submit([&](sycl::handler &CGH) {
// expected-error@sycl/handler.hpp:* {{Kernel argument cannot have a sycl::nd_item type in sycl::parallel_for with sycl::range}}
CGH.parallel_for(sycl::range{1, 1, 1}, [=](sycl::nd_item<3>) {});
});

// Range parallel_for with argument that is convertible from nd_item.
Q.submit([&](sycl::handler &CGH) {
// expected-error@sycl/handler.hpp:* {{Kernel argument cannot have a sycl::nd_item type in sycl::parallel_for with sycl::range}}
CGH.parallel_for(sycl::range{1}, [=](ConvertibleFromNDItem<1>) {});
});
Q.submit([&](sycl::handler &CGH) {
// expected-error@sycl/handler.hpp:* {{Kernel argument cannot have a sycl::nd_item type in sycl::parallel_for with sycl::range}}
CGH.parallel_for(sycl::range{1, 1}, [=](ConvertibleFromNDItem<2>) {});
});
Q.submit([&](sycl::handler &CGH) {
// expected-error@sycl/handler.hpp:* {{Kernel argument cannot have a sycl::nd_item type in sycl::parallel_for with sycl::range}}
CGH.parallel_for(sycl::range{1, 1, 1}, [=](ConvertibleFromNDItem<3>) {});
});
}