Skip to content

[SYCL] Make handler.hpp independent from kernel_bundle.hpp #16012

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 19 commits into from
Dec 2, 2024
+150 −52
Merged

[SYCL] Make handler.hpp independent from kernel_bundle.hpp #16012

Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
0ce7118
WIP
AlexeySachkov Nov 7, 2024
8aafb3b
WIP
AlexeySachkov Nov 7, 2024
8471450
Merge remote-tracking branch 'origin/sycl' into private/asachkov/dont…
AlexeySachkov Nov 18, 2024
8e0ab5e
Revert unnecessary changes
AlexeySachkov Nov 18, 2024
41245b0
Rewrite comments
AlexeySachkov Nov 18, 2024
0d07150
Upgrade self-contained-headers test suite
AlexeySachkov Nov 18, 2024
a0d074b
Merge remote-tracking branch 'origin/sycl' into private/asachkov/dont…
AlexeySachkov Nov 21, 2024
867fa67
Post-merge fixes and more cleanup
AlexeySachkov Nov 21, 2024
860b2ec
Fix E2E tests
AlexeySachkov Nov 22, 2024
aa3ca57
Apply clang-format
AlexeySachkov Nov 22, 2024
e8d42ff
Merge remote-tracking branch 'origin' into private/asachkov/dont-incl…
AlexeySachkov Nov 25, 2024
d31288e
Apply clang-format
AlexeySachkov Nov 25, 2024
ab7fa9c
Fix more tests
AlexeySachkov Nov 25, 2024
0728140
Revert unnecessary changes
AlexeySachkov Nov 25, 2024
aef82a7
Address remaining test failures
AlexeySachkov Nov 25, 2024
07e6a20
Merge remote-tracking branch 'origin' into private/asachkov/dont-incl…
AlexeySachkov Nov 27, 2024
023dc0a
Final test fixes
AlexeySachkov Nov 27, 2024
cc59544
Merge remote-tracking branch 'origin' into private/asachkov/dont-incl…
AlexeySachkov Nov 28, 2024
599e989
HIP validation appeared out of nowhere, fixed HIP-specific fails
AlexeySachkov Nov 28, 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
4 changes: 3 additions & 1 deletion sycl/include/sycl/backend.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@
#include <sycl/exception.hpp> // for make_error_code
#include <sycl/feature_test.hpp> // for SYCL_BACKEND_OP...
#include <sycl/image.hpp> // for image, image_al...
#include <sycl/kernel_bundle.hpp> // for kernel_bundle
#include <sycl/kernel_bundle_enums.hpp> // for bundle_state
#include <sycl/platform.hpp> // for platform, get_n...
#include <sycl/queue.hpp> // for queue, get_native
Expand Down Expand Up @@ -56,6 +55,7 @@
namespace sycl {
inline namespace _V1 {

template <bundle_state State> class kernel_bundle;
class property_list;

namespace detail {
Expand Down Expand Up @@ -141,13 +141,15 @@ auto get_native(const queue &Obj) -> backend_return_t<BackendName, queue> {
int32_t IsImmCmdList;
ur_native_handle_t Handle = Obj.getNative(IsImmCmdList);
backend_return_t<BackendName, queue> RetVal;
#if SYCL_EXT_ONEAPI_BACKEND_LEVEL_ZERO
if constexpr (BackendName == backend::ext_oneapi_level_zero)
RetVal = IsImmCmdList
? backend_return_t<BackendName, queue>{reinterpret_cast<
ze_command_list_handle_t>(Handle)}
: backend_return_t<BackendName, queue>{
reinterpret_cast<ze_command_queue_handle_t>(Handle)};
else
#endif
RetVal = reinterpret_cast<backend_return_t<BackendName, queue>>(Handle);

return RetVal;
Expand Down
1 change: 0 additions & 1 deletion sycl/include/sycl/detail/backend_traits_cuda.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@
#include <sycl/detail/backend_traits.hpp>
#include <sycl/device.hpp>
#include <sycl/event.hpp>
#include <sycl/kernel_bundle.hpp>
#include <sycl/queue.hpp>

typedef int CUdevice;
Expand Down
1 change: 0 additions & 1 deletion sycl/include/sycl/detail/backend_traits_hip.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@
#include <sycl/detail/backend_traits.hpp>
#include <sycl/device.hpp>
#include <sycl/event.hpp>
#include <sycl/kernel_bundle.hpp>
#include <sycl/queue.hpp>

typedef int HIPdevice;
Expand Down
4 changes: 2 additions & 2 deletions sycl/include/sycl/detail/backend_traits_level_zero.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,12 @@
#include <sycl/device.hpp> // for device
#include <sycl/event.hpp> // for event
#include <sycl/ext/oneapi/backend/level_zero_ownership.hpp> // for ownership
#include <sycl/handler.hpp> // for buffer
#include <sycl/image.hpp> // for image
#include <sycl/kernel.hpp> // for kernel
#include <sycl/kernel_bundle.hpp> // for kernel_b...
#include <sycl/kernel_bundle_enums.hpp> // for bundle_s...
#include <sycl/platform.hpp> // for platform
#include <sycl/property_list.hpp> // for property...
#include <sycl/queue.hpp> // for queue
#include <sycl/range.hpp> // for range

#include <variant> // for variant
Expand All @@ -46,6 +44,8 @@ typedef struct _ze_module_handle_t *ze_module_handle_t;

namespace sycl {
inline namespace _V1 {
class queue;

namespace detail {

// Forward declarations
Expand Down
19 changes: 12 additions & 7 deletions sycl/include/sycl/detail/backend_traits_opencl.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,20 @@
#include <sycl/detail/ur.hpp> // for assertion and ur handles
#include <sycl/device.hpp> // for device
#include <sycl/event.hpp> // for event
#include <sycl/handler.hpp> // for buffer
#include <sycl/kernel.hpp> // for kernel
#include <sycl/kernel_bundle.hpp> // for kernel_bundle
#include <sycl/kernel_bundle_enums.hpp> // for bundle_state
#include <sycl/platform.hpp> // for platform
#include <sycl/queue.hpp> // for queue

#include <vector> // for vector

namespace sycl {
inline namespace _V1 {

template <bundle_state State> class kernel_bundle;
class queue;
template <typename T, int Dimensions, typename AllocatorT, typename Enable>
class buffer;

namespace detail {

// TODO the interops for context, device, event, platform and program
Expand All @@ -54,13 +57,15 @@ template <> struct interop<backend::opencl, platform> {
using type = cl_platform_id;
};

template <typename DataT, int Dimensions, typename AllocatorT>
struct BackendInput<backend::opencl, buffer<DataT, Dimensions, AllocatorT>> {
template <typename DataT, int Dimensions, typename AllocatorT, typename Enable>
struct BackendInput<backend::opencl,
buffer<DataT, Dimensions, AllocatorT, Enable>> {
using type = cl_mem;
};

template <typename DataT, int Dimensions, typename AllocatorT>
struct BackendReturn<backend::opencl, buffer<DataT, Dimensions, AllocatorT>> {
template <typename DataT, int Dimensions, typename AllocatorT, typename Enable>
struct BackendReturn<backend::opencl,
buffer<DataT, Dimensions, AllocatorT, Enable>> {
using type = std::vector<cl_mem>;
};

Expand Down
5 changes: 4 additions & 1 deletion sycl/include/sycl/ext/oneapi/backend/level_zero.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@
#include <sycl/ext/oneapi/backend/level_zero_ownership.hpp> // for ownership
#include <sycl/image.hpp> // for image
#include <sycl/kernel.hpp> // for kernel
#include <sycl/kernel_bundle.hpp> // for kernel_bu...
#include <sycl/kernel_bundle_enums.hpp> // for bundle_state
#include <sycl/platform.hpp> // for platform
#include <sycl/properties/image_properties.hpp> // for image
Expand All @@ -39,6 +38,10 @@

namespace sycl {
inline namespace _V1 {

template <bundle_state State>
class kernel_bundle;
Copy link
Contributor

@aelovikov-intel aelovikov-intel Nov 7, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've been thinking about providing sycl/[detail/]fwd/<something.hpp> includes for quite some time, but always proceeded without it. Do you find such an idea attractive? My main concern was structure/granularity for such forward declarations.

Copy link
Contributor Author

@AlexeySachkov AlexeySachkov Nov 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As I was working on #16030 and putting even more forward-declarations everywhere, I though that having a dedicated version of every header which only provides forward declarations would actually be cool.

Because some classes are templated, their forward-declaration may not be trivial and it may require more forward-declarations. Having a ready-to-use "canonical" forward-declaration in form of a separate header would shorten the codebase and make it simpler (i.e. that would just be a #include list without any extra lines of code).

There is a thing that some headers provide multiple classes and functions and therefore we could "import" more forward-declarations than we need, but I assume that it would be cheaper anyway that including the original header, so I don't think that it is a strong enough point against the idea.


namespace ext::oneapi::level_zero::detail {
__SYCL_EXPORT device make_device(const platform &Platform,
ur_native_handle_t NativeHandle);
Expand Down
1 change: 0 additions & 1 deletion sycl/include/sycl/ext/oneapi/experimental/backend/backend_traits_cuda.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
#include <sycl/detail/backend_traits.hpp>
#include <sycl/device.hpp>
#include <sycl/event.hpp>
#include <sycl/kernel_bundle.hpp>
#include <sycl/queue.hpp>

#include <vector>
Expand Down
10 changes: 10 additions & 0 deletions sycl/include/sycl/ext/oneapi/get_kernel_info.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,20 @@
#include <sycl/detail/export.hpp>
#include <sycl/detail/info_desc_helpers.hpp>
#include <sycl/device.hpp>
#include <sycl/kernel_bundle_enums.hpp>
#include <sycl/queue.hpp>

#include <vector>

namespace sycl {
inline namespace _V1 {

template <bundle_state State> class kernel_bundle;

template <typename KernelName, bundle_state State>
kernel_bundle<State> get_kernel_bundle(const context &,
const std::vector<device> &);

namespace ext::oneapi {

template <typename KernelName, typename Param>
Expand Down
5 changes: 4 additions & 1 deletion sycl/include/sycl/ext/oneapi/owner_less.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@
#include <sycl/event.hpp> // for event
#include <sycl/ext/oneapi/weak_object.hpp> // for weak_object
#include <sycl/kernel.hpp> // for kernel
#include <sycl/kernel_bundle.hpp> // for kernel_id
#include <sycl/kernel_bundle_enums.hpp> // for bundle_state
#include <sycl/platform.hpp> // for platform
#include <sycl/properties/image_properties.hpp> // for sampled_i...
Expand All @@ -27,6 +26,10 @@ namespace sycl {
inline namespace _V1 {
namespace ext::oneapi {

class kernel_id;
template <bundle_state State> class kernel_bundle;
template <bundle_state State> class device_image;

namespace detail {
template <typename SyclObject> struct owner_less_base {
bool operator()(const SyclObject &lhs, const SyclObject &rhs) const noexcept {
Expand Down
32 changes: 6 additions & 26 deletions sycl/include/sycl/handler.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@
#include <sycl/id.hpp>
#include <sycl/item.hpp>
#include <sycl/kernel.hpp>
#include <sycl/kernel_bundle.hpp>
#include <sycl/kernel_bundle_enums.hpp>
#include <sycl/kernel_handler.hpp>
#include <sycl/nd_item.hpp>
Expand Down Expand Up @@ -152,6 +151,7 @@ inline namespace _V1 {

// Forward declaration

template <bundle_state State> class kernel_bundle;
class handler;
template <typename T, int Dimensions, typename AllocatorT, typename Enable>
class buffer;
Expand All @@ -173,6 +173,7 @@ class graph_impl;
} // namespace ext::oneapi::experimental::detail
namespace detail {

class kernel_bundle_impl;
class work_group_memory_impl;
class handler_impl;
class kernel_impl;
Expand Down Expand Up @@ -1721,36 +1722,15 @@ class __SYCL_EXPORT handler {
handler &operator=(const handler &) = delete;
handler &operator=(handler &&) = delete;

// Out-of-class definition within kernel_bundle.hpp
template <auto &SpecName>
void set_specialization_constant(
typename std::remove_reference_t<decltype(SpecName)>::value_type Value) {

setStateSpecConstSet();

std::shared_ptr<detail::kernel_bundle_impl> KernelBundleImplPtr =
getOrInsertHandlerKernelBundle(/*Insert=*/true);

detail::createSyclObjFromImpl<kernel_bundle<bundle_state::input>>(
KernelBundleImplPtr)
.set_specialization_constant<SpecName>(Value);
}
typename std::remove_reference_t<decltype(SpecName)>::value_type Value);

// Out-of-class definition within kernel_bundle.hpp
template <auto &SpecName>
typename std::remove_reference_t<decltype(SpecName)>::value_type
get_specialization_constant() const {

if (isStateExplicitKernelBundle())
throw sycl::exception(make_error_code(errc::invalid),
"Specialization constants cannot be read after "
"explicitly setting the used kernel bundle");

std::shared_ptr<detail::kernel_bundle_impl> KernelBundleImplPtr =
getOrInsertHandlerKernelBundle(/*Insert=*/true);

return detail::createSyclObjFromImpl<kernel_bundle<bundle_state::input>>(
KernelBundleImplPtr)
.get_specialization_constant<SpecName>();
}
get_specialization_constant() const;

void
use_kernel_bundle(const kernel_bundle<bundle_state::executable> &ExecBundle);
Expand Down
36 changes: 34 additions & 2 deletions sycl/include/sycl/kernel_bundle.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,9 @@
#include <sycl/detail/kernel_desc.hpp> // for get_spec_constant_symboli...
#include <sycl/detail/owner_less_base.hpp> // for OwnerLessBase
#include <sycl/detail/string_view.hpp>
#include <sycl/detail/ur.hpp> // for cast
#include <sycl/device.hpp> // for device
#include <sycl/detail/ur.hpp> // for cast
#include <sycl/device.hpp> // for device
#include <sycl/handler.hpp>
#include <sycl/kernel.hpp> // for kernel, kernel_bundle
#include <sycl/kernel_bundle_enums.hpp> // for bundle_state
#include <sycl/property_list.hpp> // for property_list
Expand Down Expand Up @@ -1139,6 +1140,37 @@ build(kernel_bundle<bundle_state::ext_oneapi_source> &SourceKB,

} // namespace ext::oneapi::experimental

template <auto &SpecName>
void handler::set_specialization_constant(
typename std::remove_reference_t<decltype(SpecName)>::value_type Value) {

setStateSpecConstSet();

std::shared_ptr<detail::kernel_bundle_impl> KernelBundleImplPtr =
getOrInsertHandlerKernelBundle(/*Insert=*/true);

detail::createSyclObjFromImpl<kernel_bundle<bundle_state::input>>(
KernelBundleImplPtr)
.set_specialization_constant<SpecName>(Value);
}

template <auto &SpecName>
typename std::remove_reference_t<decltype(SpecName)>::value_type
handler::get_specialization_constant() const {

if (isStateExplicitKernelBundle())
throw sycl::exception(make_error_code(errc::invalid),
"Specialization constants cannot be read after "
"explicitly setting the used kernel bundle");

std::shared_ptr<detail::kernel_bundle_impl> KernelBundleImplPtr =
getOrInsertHandlerKernelBundle(/*Insert=*/true);

return detail::createSyclObjFromImpl<kernel_bundle<bundle_state::input>>(
KernelBundleImplPtr)
.get_specialization_constant<SpecName>();
}

} // namespace _V1
} // namespace sycl

Expand Down
1 change: 1 addition & 0 deletions sycl/include/syclcompat/util.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@

#include <sycl/atomic_ref.hpp>
#include <sycl/group_barrier.hpp>
#include <sycl/kernel_bundle.hpp>

#include <syclcompat/math.hpp>
#include <syclcompat/memory.hpp>
Expand Down
1 change: 1 addition & 0 deletions sycl/test-e2e/Basic/backend_info.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@

#include <iostream>
#include <sycl/detail/core.hpp>
#include <sycl/kernel_bundle.hpp>

using namespace sycl;

Expand Down
2 changes: 2 additions & 0 deletions sycl/test-e2e/Basic/kernel_info.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@

#include <cassert>
#include <sycl/detail/core.hpp>
#include <sycl/kernel_bundle.hpp>

#include <sycl/ext/oneapi/get_kernel_info.hpp>

using namespace sycl;
Expand Down
6 changes: 3 additions & 3 deletions sycl/test-e2e/Basic/kernel_max_wg_size.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@
// for Intel GPU devices and only when using the Level Zero backend or OpenCL
// backend.

// clang-format off
#include <sycl/detail/core.hpp>
#include <sycl/usm.hpp>

#include <sycl/ext/intel/experimental/grf_size_properties.hpp>
// clang-format on
#include <sycl/kernel_bundle.hpp>
#include <sycl/usm.hpp>

using namespace sycl;

Expand Down
1 change: 1 addition & 0 deletions sycl/test-e2e/Basic/large-range.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
#include <numeric>
#include <sycl/atomic_ref.hpp>
#include <sycl/detail/core.hpp>
#include <sycl/kernel_bundle.hpp>
#include <sycl/specialization_id.hpp>

using namespace sycl;
Expand Down
1 change: 1 addition & 0 deletions sycl/test-e2e/Basic/launch_queries/max_num_work_groups.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
// RUN: %{run} %t.out

#include <sycl/detail/core.hpp>
#include <sycl/kernel_bundle.hpp>

#include <cassert>
#include <cstdint>
Expand Down
1 change: 1 addition & 0 deletions sycl/test-e2e/DeviceCodeSplit/Inputs/split-per-source.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
#include <sycl/detail/core.hpp>
#include <sycl/kernel_bundle.hpp>

class File1Kern1;
class File1Kern2;
Expand Down
1 change: 1 addition & 0 deletions sycl/test-e2e/DeviceCodeSplit/split-per-kernel.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
// XFAIL: hip_nvidia

#include <sycl/detail/core.hpp>
#include <sycl/kernel_bundle.hpp>

class Kern1;
class Kern2;
Expand Down
1 change: 1 addition & 0 deletions sycl/test-e2e/ESIMD/histogram_256_slm_spec_2020.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

#include "esimd_test_utils.hpp"

#include <sycl/kernel_bundle.hpp>
#include <sycl/specialization_id.hpp>

static constexpr int NUM_BINS = 256;
Expand Down
1 change: 1 addition & 0 deletions sycl/test-e2e/ESIMD/mandelbrot/mandelbrot_spec.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
#include "../esimd_test_utils.hpp"

#include <sycl/accessor_image.hpp>
#include <sycl/kernel_bundle.hpp>
#include <sycl/specialization_id.hpp>

#include <array>
Expand Down
1 change: 1 addition & 0 deletions sycl/test-e2e/ESIMD/private_memory/private_memory.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@

#include "../esimd_test_utils.hpp"

#include <sycl/kernel_bundle.hpp>
#include <sycl/specialization_id.hpp>

using namespace sycl;
Expand Down
1 change: 1 addition & 0 deletions sycl/test-e2e/ESIMD/spec_const/Inputs/spec-const-2020-common.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

#include "esimd_test_utils.hpp"

#include <sycl/kernel_bundle.hpp>
#include <sycl/specialization_id.hpp>

using namespace sycl;
Expand Down
Loading
Loading