Skip to content

[NFCI] Add handler::setDeviceKernelInfo helpers #19991

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 8, 2025
Merged

[NFCI] Add handler::setDeviceKernelInfo helpers #19991

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
06355e3
[NFCI] Add `handler::setDeviceKernelInfo` helpers
aelovikov-intel Sep 5, 2025
0f50f8d
Update `sycl_symbols_windows.dump`
aelovikov-intel Sep 8, 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
69 changes: 35 additions & 34 deletions sycl/include/sycl/handler.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -491,6 +491,25 @@ class __SYCL_EXPORT handler {
"a single kernel or explicit memory operation.");
}

template <class Kernel> void setDeviceKernelInfo(void *KernelFuncPtr) {
constexpr auto Info = detail::CompileTimeKernelInfo<Kernel>;
MKernelName = Info.Name;
// TODO support ESIMD in no-integration-header case too.
setKernelInfo(KernelFuncPtr, Info.NumParams, Info.ParamDescGetter,
Info.IsESIMD, Info.HasSpecialCaptures);
setDeviceKernelInfoPtr(&detail::getDeviceKernelInfo<Kernel>());
setType(detail::CGType::Kernel);
}

void setDeviceKernelInfo(kernel &&Kernel) {
MKernel = detail::getSyclObjImpl(std::move(Kernel));
MKernelName = getKernelName();
setType(detail::CGType::Kernel);

// If any extra actions are added here make sure that logic around
// `lambdaAndKernelHaveEqualName` calls can handle that.
}

#ifndef __INTEL_PREVIEW_BREAKING_CHANGES
// TODO: Those functions are not used anymore, remove it in the next
// ABI-breaking window.
Expand Down Expand Up @@ -823,7 +842,6 @@ class __SYCL_EXPORT handler {
detail::GetInstantiateKernelOnHostPtr<KernelType, LambdaArgType,
Dims>());
#endif
constexpr auto Info = detail::CompileTimeKernelInfo<KernelName>;

// SYCL unittests are built without sycl compiler, so "host" information
// about kernels isn't provided (e.g., via integration headers or compiler
Expand All @@ -836,6 +854,8 @@ class __SYCL_EXPORT handler {
// don't actually execute those operation, that's why disabling
// unconditional `static_asserts`s is enough for now.
#ifndef __SYCL_UNITTESTS_BYPASS_KERNEL_NAME_CHECK
constexpr auto Info = detail::CompileTimeKernelInfo<KernelName>;

static_assert(Info.Name != std::string_view{}, "Kernel must have a name!");

// Some host compilers may have different captures from Clang. Currently
Expand All @@ -855,12 +875,7 @@ class __SYCL_EXPORT handler {
"might also help.");
#endif

// Force hasSpecialCaptures to be evaluated at compile-time.
setKernelInfo((void *)MHostKernel->getPtr(), Info.NumParams,
Info.ParamDescGetter, Info.IsESIMD, Info.HasSpecialCaptures);

MKernelName = Info.Name;
setDeviceKernelInfoPtr(&detail::getDeviceKernelInfo<KernelName>());
setDeviceKernelInfo<KernelName>((void *)MHostKernel->getPtr());

// If the kernel lambda is callable with a kernel_handler argument, manifest
// the associated kernel handler.
Expand Down Expand Up @@ -1302,7 +1317,6 @@ class __SYCL_EXPORT handler {
setNDRangeDescriptor(RoundedRange);
StoreLambda<KName, decltype(Wrapper), Dims, TransformedArgType>(
std::move(Wrapper));
setType(detail::CGType::Kernel);
#endif
} else
#endif // !__SYCL_DISABLE_PARALLEL_FOR_RANGE_ROUNDING__ &&
Expand All @@ -1324,7 +1338,6 @@ class __SYCL_EXPORT handler {
setNDRangeDescriptor(std::move(UserRange));
StoreLambda<NameT, KernelType, Dims, TransformedArgType>(
std::move(KernelFunc));
setType(detail::CGType::Kernel);
#endif
#else
(void)KernelFunc;
Expand All @@ -1346,13 +1359,11 @@ class __SYCL_EXPORT handler {
[[maybe_unused]] kernel Kernel) {
#ifndef __SYCL_DEVICE_ONLY__
throwIfActionIsCreated();
MKernel = detail::getSyclObjImpl(std::move(Kernel));
setDeviceKernelInfo(std::move(Kernel));
detail::checkValueRange<Dims>(NumWorkItems);
setNDRangeDescriptor(std::move(NumWorkItems));
processLaunchProperties<PropertiesT>(Props);
setType(detail::CGType::Kernel);
extractArgsAndReqs();
MKernelName = getKernelName();
#endif
}

Expand All @@ -1371,13 +1382,11 @@ class __SYCL_EXPORT handler {
[[maybe_unused]] kernel Kernel) {
#ifndef __SYCL_DEVICE_ONLY__
throwIfActionIsCreated();
MKernel = detail::getSyclObjImpl(std::move(Kernel));
setDeviceKernelInfo(std::move(Kernel));
detail::checkValueRange<Dims>(NDRange);
setNDRangeDescriptor(std::move(NDRange));
processLaunchProperties(Props);
setType(detail::CGType::Kernel);
extractArgsAndReqs();
MKernelName = getKernelName();
#endif
}

Expand All @@ -1404,7 +1413,6 @@ class __SYCL_EXPORT handler {
}
throwIfActionIsCreated();
verifyUsedKernelBundleInternal(Info.Name);
setType(detail::CGType::Kernel);

detail::checkValueRange<Dims>(params...);
if constexpr (SetNumWorkGroups) {
Expand Down Expand Up @@ -1450,7 +1458,6 @@ class __SYCL_EXPORT handler {
// kernel.
setHandlerKernelBundle(Kernel);
verifyUsedKernelBundleInternal(Info.Name);
setType(detail::CGType::Kernel);

detail::checkValueRange<Dims>(params...);
if constexpr (SetNumWorkGroups) {
Expand All @@ -1460,12 +1467,11 @@ class __SYCL_EXPORT handler {
setNDRangeDescriptor(std::move(params)...);
}

MKernel = detail::getSyclObjImpl(std::move(Kernel));
if (!lambdaAndKernelHaveEqualName<NameT>()) {
extractArgsAndReqs();
MKernelName = getKernelName();
} else {
setDeviceKernelInfo(std::move(Kernel));
if (lambdaAndKernelHaveEqualName<NameT>()) {
StoreLambda<NameT, KernelType, Dims, ElementType>(std::move(KernelFunc));
} else {
extractArgsAndReqs();
}
processProperties<Info.IsESIMD, PropertiesT>(Props);
#endif
Expand Down Expand Up @@ -1845,10 +1851,8 @@ class __SYCL_EXPORT handler {
// No need to check if range is out of INT_MAX limits as it's compile-time
// known constant
setNDRangeDescriptor(range<1>{1});
MKernel = detail::getSyclObjImpl(std::move(Kernel));
setType(detail::CGType::Kernel);
setDeviceKernelInfo(std::move(Kernel));
extractArgsAndReqs();
MKernelName = getKernelName();
}

void parallel_for(range<1> NumWorkItems, kernel Kernel) {
Expand Down Expand Up @@ -1881,12 +1885,10 @@ class __SYCL_EXPORT handler {
[[maybe_unused]] kernel Kernel) {
#ifndef __SYCL_DEVICE_ONLY__
throwIfActionIsCreated();
MKernel = detail::getSyclObjImpl(std::move(Kernel));
setDeviceKernelInfo(std::move(Kernel));
detail::checkValueRange<Dims>(NumWorkItems, WorkItemOffset);
setNDRangeDescriptor(std::move(NumWorkItems), std::move(WorkItemOffset));
setType(detail::CGType::Kernel);
extractArgsAndReqs();
MKernelName = getKernelName();
#endif
}

Expand Down Expand Up @@ -1924,13 +1926,12 @@ class __SYCL_EXPORT handler {
// No need to check if range is out of INT_MAX limits as it's compile-time
// known constant
setNDRangeDescriptor(range<1>{1});
MKernel = detail::getSyclObjImpl(std::move(Kernel));
setType(detail::CGType::Kernel);
if (!lambdaAndKernelHaveEqualName<NameT>()) {
extractArgsAndReqs();
MKernelName = getKernelName();
} else
setDeviceKernelInfo(std::move(Kernel));
if (lambdaAndKernelHaveEqualName<NameT>()) {
StoreLambda<NameT, KernelType, /*Dims*/ 1, void>(std::move(KernelFunc));
} else {
extractArgsAndReqs();
}
#else
detail::CheckDeviceCopyable<KernelType>();
#endif
Expand Down
1 change: 1 addition & 0 deletions sycl/test/abi/sycl_symbols_windows.dump
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4409,6 +4409,7 @@
?setArgsHelper@handler@_V1@sycl@@AEAAXH@Z
?setArgsToAssociatedAccessors@handler@_V1@sycl@@AEAAXXZ
?setDevice@HostProfilingInfo@detail@_V1@sycl@@QEAAXPEAVdevice_impl@234@@Z
?setDeviceKernelInfo@handler@_V1@sycl@@AEAAX$$QEAVkernel@23@@Z
?setDeviceKernelInfoPtr@handler@_V1@sycl@@AEAAXPEAVDeviceKernelInfo@detail@23@@Z
?setHandlerKernelBundle@handler@_V1@sycl@@AEAAXAEBV?$shared_ptr@Vkernel_bundle_impl@detail@_V1@sycl@@@std@@@Z
?setHandlerKernelBundle@handler@_V1@sycl@@AEAAXVkernel@23@@Z
Expand Down