Skip to content

[SYCL] Add fast-link option for SYCLBIN #20174

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

Open
wants to merge 8 commits into
base: sycl
Choose a base branch
from
Open

[SYCL] Add fast-link option for SYCLBIN #20174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
6fe8e6b
[SYCL] Add fast-link option for SYCLBIN
steffenlarsen Aug 25, 2025
7111c47
Merge remote-tracking branch 'intel/sycl' into steffen/dynamic_linking
steffenlarsen Nov 12, 2025
30017be
Switch to passing pointer to bundles
steffenlarsen Nov 12, 2025
cc75ee8
Fix Windows symbol
steffenlarsen Nov 12, 2025
0d62963
Add back unintentionally removed newline
steffenlarsen Nov 12, 2025
1400a6d
Address comments
steffenlarsen Nov 13, 2025
81987ad
Merge remote-tracking branch 'intel/sycl' into steffen/dynamic_linking
steffenlarsen Nov 13, 2025
638aa48
Move from native bins collection
steffenlarsen Nov 13, 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
74 changes: 74 additions & 0 deletions sycl/include/sycl/ext/oneapi/experimental/syclbin_kernel_bundle.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@

#pragma once

#include <sycl/ext/oneapi/experimental/syclbin_properties.hpp>
#include <sycl/ext/oneapi/properties/properties.hpp>
#include <sycl/kernel_bundle.hpp>

Expand All @@ -24,6 +25,39 @@

namespace sycl {
inline namespace _V1 {

namespace detail {
__SYCL_EXPORT std::shared_ptr<detail::kernel_bundle_impl>
link_impl(const kernel_bundle<bundle_state::object> *ObjectBundles,
size_t NumObjectBundles, const std::vector<device> &Devs,
bool FastLink);

template <
typename PropertyListT = ext::oneapi::experimental::empty_properties_t,
typename = std::enable_if_t<
ext::oneapi::experimental::detail::all_are_properties_of_v<
ext::oneapi::experimental::detail::link_props, PropertyListT>>>
kernel_bundle<bundle_state::executable>
link_common(const kernel_bundle<bundle_state::object> *ObjectBundles,
size_t NumObjectBundles, const std::vector<device> &Devs,
Copy link
Contributor

@aelovikov-intel aelovikov-intel Nov 13, 2025

Choose a reason for hiding this comment

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

Do we need to throw an exception if size is zero?

PropertyListT Props = {}) {
std::vector<device> UniqueDevices = removeDuplicateDevices(Devs);

bool UseFastLink = [&]() {
if constexpr (Props.template has_property<
ext::oneapi::experimental::fast_link>())
return Props.template get_property<ext::oneapi::experimental::fast_link>()
.value;
return false;
}();

KernelBundleImplPtr Impl =
link_impl(ObjectBundles, NumObjectBundles, UniqueDevices, UseFastLink);
return createSyclObjFromImpl<kernel_bundle<bundle_state::executable>>(
std::move(Impl));
Comment on lines +56 to +57
Copy link
Contributor

@aelovikov-intel aelovikov-intel Nov 12, 2025

Choose a reason for hiding this comment

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

Any particular reason to do this here instead of inside libsycl.so?

Copy link
Contributor Author

@steffenlarsen steffenlarsen Nov 13, 2025

Choose a reason for hiding this comment

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

The function is templated, so we can't move all of link_common. If you mean change the return type of link_impl, it is currently a parallel (overload) to another link_impl, so it was chosen for consistency's sake.

Copy link
Contributor

@aelovikov-intel aelovikov-intel Nov 13, 2025

Choose a reason for hiding this comment

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

you mean change the return type of link_impl

Yes, I think most of ABI interfaces should operate in terms of real SYCL objects.

}
} // namespace detail

namespace ext::oneapi::experimental {

template <bundle_state State, typename PropertyListT = empty_properties_t>
Expand Down Expand Up @@ -77,6 +111,46 @@ get_kernel_bundle(const context &Ctxt, const std::filesystem::path &Filename,
}
#endif

template <typename PropertyListT = empty_properties_t,
typename = std::enable_if_t<detail::all_are_properties_of_v<
sycl::detail::link_props, PropertyListT>>>
kernel_bundle<bundle_state::executable>
link(const std::vector<kernel_bundle<bundle_state::object>> &ObjectBundles,
const std::vector<device> &Devs, PropertyListT Props = {}) {
return sycl::detail::link_common(ObjectBundles.data(), ObjectBundles.size(),
Devs, Props);
}

template <typename PropertyListT = empty_properties_t,
typename = std::enable_if_t<detail::all_are_properties_of_v<
sycl::detail::link_props, PropertyListT>>>
kernel_bundle<bundle_state::executable>
link(const kernel_bundle<bundle_state::object> &ObjectBundle,
const std::vector<device> &Devs, PropertyListT Props = {}) {
return sycl::detail::link_common(&ObjectBundle, 1, Devs, Props);
}

template <typename PropertyListT = empty_properties_t,
typename = std::enable_if_t<detail::all_are_properties_of_v<
sycl::detail::link_props, PropertyListT>>>
kernel_bundle<bundle_state::executable>
link(const std::vector<kernel_bundle<bundle_state::object>> &ObjectBundles,
PropertyListT Props = {}) {
std::vector<sycl::device> IntersectDevices =
sycl::detail::find_device_intersection(ObjectBundles);
return link(ObjectBundles, IntersectDevices, Props);
}

template <typename PropertyListT = empty_properties_t,
typename = std::enable_if_t<detail::all_are_properties_of_v<
sycl::detail::link_props, PropertyListT>>>
kernel_bundle<bundle_state::executable>
link(const kernel_bundle<bundle_state::object> &ObjectBundle,
PropertyListT Props = {}) {
return link(std::vector<kernel_bundle<bundle_state::object>>{ObjectBundle},
ObjectBundle.get_devices(), Props);
}

} // namespace ext::oneapi::experimental
} // namespace _V1
} // namespace sycl
39 changes: 39 additions & 0 deletions sycl/include/sycl/ext/oneapi/experimental/syclbin_properties.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
//==-------- syclbin_properties.hpp - SYCLBIN and tooling properties -------==//
Copy link
Contributor

@aelovikov-intel aelovikov-intel Nov 12, 2025

Choose a reason for hiding this comment

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

AFAIK, this part of the style guide has been dropped (having file name present in the very first line).

Copy link
Contributor Author

@steffenlarsen steffenlarsen Nov 13, 2025

Choose a reason for hiding this comment

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

Do you mean it should be

Suggested change
//==-------- syclbin_properties.hpp - SYCLBIN and tooling properties -------==//
//==-------------------- SYCLBIN and tooling properties --------------------==//

or should the header be dropped entirely?

Copy link
Contributor

@aelovikov-intel aelovikov-intel Nov 13, 2025

Choose a reason for hiding this comment

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

I think it's usually

//==-----------------------------------------------------------------------==//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
/// \file <Description>
///

or something like that now.

//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//

#pragma once

#include <sycl/ext/oneapi/properties/properties.hpp>
#include <sycl/kernel_bundle.hpp>

namespace sycl {
inline namespace _V1 {

namespace detail {
struct link_props;
} // namespace detail

namespace ext::oneapi::experimental {

/////////////////////////
// PropertyT syclex::fast_link
/////////////////////////
struct fast_link
: detail::run_time_property_key<fast_link, detail::PropKind::FastLink> {
fast_link(bool DoFastLink = true) : value(DoFastLink) {}

bool value;
};
using fast_link_key = fast_link;

template <>
struct is_property_key_of<fast_link_key, sycl::detail::link_props>
: std::true_type {};
} // namespace ext::oneapi::experimental
} // namespace _V1
} // namespace sycl
3 changes: 2 additions & 1 deletion sycl/include/sycl/ext/oneapi/properties/property.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,8 +228,9 @@ enum PropKind : uint32_t {
InitialThreshold = 83,
MaximumSize = 84,
ZeroInit = 85,
FastLink = 86,
// PropKindSize must always be the last value.
PropKindSize = 86,
PropKindSize = 87,
};

template <typename PropertyT> struct PropertyToKind {
Expand Down
1 change: 1 addition & 0 deletions sycl/include/sycl/sycl.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,7 @@ can be disabled by setting SYCL_DISABLE_FSYCL_SYCLHPP_WARNING macro.")
#include <sycl/ext/oneapi/experimental/reduction_properties.hpp>
#include <sycl/ext/oneapi/experimental/root_group.hpp>
#include <sycl/ext/oneapi/experimental/syclbin_kernel_bundle.hpp>
#include <sycl/ext/oneapi/experimental/syclbin_properties.hpp>
#include <sycl/ext/oneapi/experimental/tangle.hpp>
#include <sycl/ext/oneapi/experimental/work_group_memory.hpp>
#include <sycl/ext/oneapi/filter_selector.hpp>
Expand Down
Loading