Skip to content

[SYCL] Cleanup queue's submission ABI entry points #20675

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 4 commits into
base: sycl
Choose a base branch
from
Open

[SYCL] Cleanup queue's submission ABI entry points #20675

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b41aa6d
[SYCL] Remove fallback assertion ABI entry points
againull Nov 17, 2025
1026f0e
Remove submission info and redundant submission entry points
againull Nov 21, 2025
217017e
update symbols
againull Nov 21, 2025
da98eaa
Merge remote-tracking branch 'origin/sycl' into abi/submission_info
againull Nov 21, 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
114 changes: 0 additions & 114 deletions sycl/include/sycl/queue.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,29 +84,6 @@ void __SYCL_EXPORT submit_kernel_direct_without_event_impl(
namespace detail {
class queue_impl;

#ifndef __INTEL_PREVIEW_BREAKING_CHANGES
using SubmitPostProcessF = std::function<void(bool, bool, event &)>;

struct SubmissionInfoImpl;

class __SYCL_EXPORT SubmissionInfo {
public:
SubmissionInfo();

sycl::detail::optional<SubmitPostProcessF> &PostProcessorFunc();
const sycl::detail::optional<SubmitPostProcessF> &PostProcessorFunc() const;

std::shared_ptr<detail::queue_impl> &SecondaryQueue();
const std::shared_ptr<detail::queue_impl> &SecondaryQueue() const;

ext::oneapi::experimental::event_mode_enum &EventMode();
const ext::oneapi::experimental::event_mode_enum &EventMode() const;

private:
std::shared_ptr<SubmissionInfoImpl> impl = nullptr;
};
#endif

namespace v1 {

// This class is a part of the ABI, so it's moved to a separate namespace to
Expand All @@ -126,33 +103,13 @@ class __SYCL_EXPORT SubmissionInfo {
public:
SubmissionInfo() {}

#ifndef __INTEL_PREVIEW_BREAKING_CHANGES
SubmissionInfo(const detail::SubmissionInfo &SI)
: MSecondaryQueue(SI.SecondaryQueue()), MEventMode(SI.EventMode()) {}

sycl::detail::optional<SubmitPostProcessF> &PostProcessorFunc() {
return MPostProcessorFunc;
}
const sycl::detail::optional<SubmitPostProcessF> &PostProcessorFunc() const {
return MPostProcessorFunc;
}

std::shared_ptr<detail::queue_impl> &SecondaryQueue() {
return MSecondaryQueue;
}
const std::shared_ptr<detail::queue_impl> &SecondaryQueue() const {
return MSecondaryQueue;
}
#endif

ext::oneapi::experimental::event_mode_enum &EventMode() { return MEventMode; }
const ext::oneapi::experimental::event_mode_enum &EventMode() const {
return MEventMode;
}

private:
#ifndef __INTEL_PREVIEW_BREAKING_CHANGES
optional<detail::SubmitPostProcessF> MPostProcessorFunc = std::nullopt;
std::shared_ptr<detail::queue_impl> MSecondaryQueue = nullptr;
#endif
ext::oneapi::experimental::event_mode_enum MEventMode =
Expand Down Expand Up @@ -3840,71 +3797,6 @@ class __SYCL_EXPORT queue : public detail::OwnerLessBase<queue> {
}
}

#ifndef __INTEL_PREVIEW_BREAKING_CHANGES
/// TODO: Unused. Remove these when ABI-break window is open.
/// Not using `type_erased_cgfo_ty` on purpose.
event submit_impl(std::function<void(handler &)> CGH,
const detail::code_location &CodeLoc);
event submit_impl(std::function<void(handler &)> CGH,
const detail::code_location &CodeLoc, bool IsTopCodeLoc);
event submit_impl(std::function<void(handler &)> CGH, queue secondQueue,
const detail::code_location &CodeLoc);
event submit_impl(std::function<void(handler &)> CGH, queue secondQueue,
const detail::code_location &CodeLoc, bool IsTopCodeLoc);
void submit_without_event_impl(std::function<void(handler &)> CGH,
const detail::code_location &CodeLoc);
void submit_without_event_impl(std::function<void(handler &)> CGH,
const detail::code_location &CodeLoc,
bool IsTopCodeLoc);
event
submit_impl_and_postprocess(std::function<void(handler &)> CGH,
const detail::code_location &CodeLoc,
const detail::SubmitPostProcessF &PostProcess);
event submit_impl_and_postprocess(
std::function<void(handler &)> CGH, const detail::code_location &CodeLoc,
const detail::SubmitPostProcessF &PostProcess, bool IsTopCodeLoc);
event
submit_impl_and_postprocess(std::function<void(handler &)> CGH,
queue secondQueue,
const detail::code_location &CodeLoc,
const detail::SubmitPostProcessF &PostProcess);
event submit_impl_and_postprocess(
std::function<void(handler &)> CGH, queue secondQueue,
const detail::code_location &CodeLoc,
const detail::SubmitPostProcessF &PostProcess, bool IsTopCodeLoc);

// Old version when `std::function` was used in place of
// `std::function<void(handler &)>`.
event submit_with_event_impl(std::function<void(handler &)> CGH,
const detail::SubmissionInfo &SubmitInfo,
const detail::code_location &CodeLoc,
bool IsTopCodeLoc);

void submit_without_event_impl(std::function<void(handler &)> CGH,
const detail::SubmissionInfo &SubmitInfo,
const detail::code_location &CodeLoc,
bool IsTopCodeLoc);
event submit_with_event_impl(const detail::type_erased_cgfo_ty &CGH,
const detail::SubmissionInfo &SubmitInfo,
const detail::code_location &CodeLoc,
bool IsTopCodeLoc);
void submit_without_event_impl(const detail::type_erased_cgfo_ty &CGH,
const detail::SubmissionInfo &SubmitInfo,
const detail::code_location &CodeLoc,
bool IsTopCodeLoc);

/// A template-free versions of submit.
event submit_with_event_impl(const detail::type_erased_cgfo_ty &CGH,
const detail::v1::SubmissionInfo &SubmitInfo,
const detail::code_location &CodeLoc,
bool IsTopCodeLoc);
/// A template-free version of submit_without_event.
void submit_without_event_impl(const detail::type_erased_cgfo_ty &CGH,
const detail::v1::SubmissionInfo &SubmitInfo,
const detail::code_location &CodeLoc,
bool IsTopCodeLoc);
#endif // __INTEL_PREVIEW_BREAKING_CHANGES

/// A template-free version of submit as const member function.
event submit_with_event_impl(const detail::type_erased_cgfo_ty &CGH,
const detail::v1::SubmissionInfo &SubmitInfo,
Expand All @@ -3925,9 +3817,6 @@ class __SYCL_EXPORT queue : public detail::OwnerLessBase<queue> {
/// \param CodeLoc is the code location of the submit call (default argument)
/// \return a SYCL event object for the submitted command group.
//
// UseFallBackAssert as template param vs `#if` in function body is necessary
// to prevent ODR-violation between TUs built with different fallback assert
// modes.
template <typename PropertiesT>
event submit_with_event(PropertiesT Props,
const detail::type_erased_cgfo_ty &CGF,
Expand All @@ -3947,9 +3836,6 @@ class __SYCL_EXPORT queue : public detail::OwnerLessBase<queue> {
/// \param CGF is a function object containing command group.
/// \param CodeLoc is the code location of the submit call (default argument)
//
// UseFallBackAssert as template param vs `#if` in function body is necessary
// to prevent ODR-violation between TUs built with different fallback assert
// modes.
template <typename PropertiesT>
void submit_without_event(PropertiesT Props,
const detail::type_erased_cgfo_ty &CGF,
Expand Down
149 changes: 0 additions & 149 deletions sycl/source/queue.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,48 +20,6 @@
namespace sycl {
inline namespace _V1 {

#ifndef __INTEL_PREVIEW_BREAKING_CHANGES
namespace detail {
SubmissionInfo::SubmissionInfo()
: impl{std::make_shared<SubmissionInfoImpl>()} {}

optional<SubmitPostProcessF> &SubmissionInfo::PostProcessorFunc() {
// No longer in use, but needs to be exposed for use in SYCL programs built
// with the old headers.
static optional<SubmitPostProcessF> DoNotUsePostProcessorFunc;
return DoNotUsePostProcessorFunc;
}

const optional<SubmitPostProcessF> &SubmissionInfo::PostProcessorFunc() const {
// No longer in use, but needs to be exposed for use in SYCL programs built
// with the old headers.
static optional<SubmitPostProcessF> DoNotUsePostProcessorFunc;
return DoNotUsePostProcessorFunc;
}

#ifndef __INTEL_PREVIEW_BREAKING_CHANGES
std::shared_ptr<detail::queue_impl> &SubmissionInfo::SecondaryQueue() {
return impl->MSecondaryQueue;
}

const std::shared_ptr<detail::queue_impl> &
SubmissionInfo::SecondaryQueue() const {
return impl->MSecondaryQueue;
}
#endif

ext::oneapi::experimental::event_mode_enum &SubmissionInfo::EventMode() {
return impl->MEventMode;
}

const ext::oneapi::experimental::event_mode_enum &
SubmissionInfo::EventMode() const {
return impl->MEventMode;
}
} // namespace detail

#endif // __INTEL_PREVIEW_BREAKING_CHANGES

queue::queue(const context &SyclContext, const device_selector &DeviceSelector,
const async_handler &AsyncHandler, const property_list &PropList) {
const std::vector<device> Devs = SyclContext.get_devices();
Expand Down Expand Up @@ -205,113 +163,6 @@ event queue::mem_advise(const void *Ptr, size_t Length, int Advice,
/*CallerNeedsEvent=*/true);
}

#ifndef __INTEL_PREVIEW_BREAKING_CHANGES
/// TODO: Unused. Remove these when ABI-break window is open.
event queue::submit_impl(std::function<void(handler &)> CGH,
const detail::code_location &CodeLoc) {
return submit_with_event_impl(std::move(CGH), {}, CodeLoc, true);
}
event queue::submit_impl(std::function<void(handler &)> CGH,
const detail::code_location &CodeLoc,
bool IsTopCodeLoc) {
return submit_with_event_impl(std::move(CGH), {}, CodeLoc, IsTopCodeLoc);
}

event queue::submit_impl(std::function<void(handler &)> CGH,
[[maybe_unused]] queue SecondQueue,
const detail::code_location &CodeLoc) {
return impl->submit(CGH, CodeLoc, true);
}
event queue::submit_impl(std::function<void(handler &)> CGH,
[[maybe_unused]] queue SecondQueue,
const detail::code_location &CodeLoc,
bool IsTopCodeLoc) {
return impl->submit(CGH, CodeLoc, IsTopCodeLoc);
}

void queue::submit_without_event_impl(std::function<void(handler &)> CGH,
const detail::code_location &CodeLoc) {
submit_without_event_impl(std::move(CGH), {}, CodeLoc, true);
}
void queue::submit_without_event_impl(std::function<void(handler &)> CGH,
const detail::code_location &CodeLoc,
bool IsTopCodeLoc) {
submit_without_event_impl(std::move(CGH), {}, CodeLoc, IsTopCodeLoc);
}

event queue::submit_impl_and_postprocess(std::function<void(handler &)> CGH,
const detail::code_location &CodeLoc,
const detail::SubmitPostProcessF &) {
return submit_with_event_impl(std::move(CGH), {}, CodeLoc, true);
}
event queue::submit_impl_and_postprocess(std::function<void(handler &)> CGH,
const detail::code_location &CodeLoc,
const detail::SubmitPostProcessF &,
bool IsTopCodeLoc) {
return submit_with_event_impl(std::move(CGH), {}, CodeLoc, IsTopCodeLoc);
}

event queue::submit_impl_and_postprocess(std::function<void(handler &)> CGH,
[[maybe_unused]] queue SecondQueue,
const detail::code_location &CodeLoc,
const detail::SubmitPostProcessF &) {
return impl->submit(CGH, CodeLoc, true);
}
event queue::submit_impl_and_postprocess(std::function<void(handler &)> CGH,
[[maybe_unused]] queue SecondQueue,
const detail::code_location &CodeLoc,
const detail::SubmitPostProcessF &,
bool IsTopCodeLoc) {
return impl->submit(CGH, CodeLoc, IsTopCodeLoc);
}

event queue::submit_with_event_impl(std::function<void(handler &)> CGH,
const detail::SubmissionInfo &SubmitInfo,
const detail::code_location &CodeLoc,
bool IsTopCodeLoc) {
return impl->submit_with_event(CGH, SubmitInfo, CodeLoc, IsTopCodeLoc);
}

void queue::submit_without_event_impl(std::function<void(handler &)> CGH,
const detail::SubmissionInfo &SubmitInfo,
const detail::code_location &CodeLoc,
bool IsTopCodeLoc) {
impl->submit_without_event(CGH, SubmitInfo, CodeLoc, IsTopCodeLoc);
}

event queue::submit_with_event_impl(const detail::type_erased_cgfo_ty &CGH,
const detail::SubmissionInfo &SubmitInfo,
const detail::code_location &CodeLoc,
bool IsTopCodeLoc) {
detail::v1::SubmissionInfo SI{SubmitInfo};
return impl->submit_with_event(CGH, SI, CodeLoc, IsTopCodeLoc);
}

void queue::submit_without_event_impl(const detail::type_erased_cgfo_ty &CGH,
const detail::SubmissionInfo &SubmitInfo,
const detail::code_location &CodeLoc,
bool IsTopCodeLoc) {
detail::v1::SubmissionInfo SI{SubmitInfo};
impl->submit_without_event(CGH, SI, CodeLoc, IsTopCodeLoc);
}

event queue::submit_with_event_impl(
const detail::type_erased_cgfo_ty &CGH,
const detail::v1::SubmissionInfo &SubmitInfo,
const detail::code_location &CodeLoc, bool IsTopCodeLoc) {
return std::as_const(*this).submit_with_event_impl(CGH, SubmitInfo, CodeLoc,
IsTopCodeLoc);
}

void queue::submit_without_event_impl(
const detail::type_erased_cgfo_ty &CGH,
const detail::v1::SubmissionInfo &SubmitInfo,
const detail::code_location &CodeLoc, bool IsTopCodeLoc) {
std::as_const(*this).submit_without_event_impl(CGH, SubmitInfo, CodeLoc,
IsTopCodeLoc);
}
#endif // __INTEL_PREVIEW_BREAKING_CHANGES

event queue::submit_with_event_impl(
const detail::type_erased_cgfo_ty &CGH,
const detail::v1::SubmissionInfo &SubmitInfo,
Expand Down
24 changes: 0 additions & 24 deletions sycl/test/abi/sycl_symbols_linux.dump
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3163,29 +3163,13 @@ _ZN4sycl3_V15queue10mem_adviseEPKvmiNS0_5eventERKNS0_6detail13code_locationE
_ZN4sycl3_V15queue10mem_adviseEPKvmiRKNS0_6detail13code_locationE
_ZN4sycl3_V15queue10mem_adviseEPKvmiRKSt6vectorINS0_5eventESaIS5_EERKNS0_6detail13code_locationE
_ZN4sycl3_V15queue10wait_proxyERKNS0_6detail13code_locationE
_ZN4sycl3_V15queue11submit_implESt8functionIFvRNS0_7handlerEEERKNS0_6detail13code_locationE
_ZN4sycl3_V15queue11submit_implESt8functionIFvRNS0_7handlerEEERKNS0_6detail13code_locationEb
_ZN4sycl3_V15queue11submit_implESt8functionIFvRNS0_7handlerEEES1_RKNS0_6detail13code_locationE
_ZN4sycl3_V15queue11submit_implESt8functionIFvRNS0_7handlerEEES1_RKNS0_6detail13code_locationEb
_ZN4sycl3_V15queue15ext_oneapi_prodEv
_ZN4sycl3_V15queue18throw_asynchronousEv
_ZN4sycl3_V15queue20memcpyToDeviceGlobalEPvPKvbmmRKSt6vectorINS0_5eventESaIS6_EE
_ZN4sycl3_V15queue20wait_and_throw_proxyERKNS0_6detail13code_locationE
_ZN4sycl3_V15queue22memcpyFromDeviceGlobalEPvPKvbmmRKSt6vectorINS0_5eventESaIS6_EE
_ZN4sycl3_V15queue22submit_with_event_implERKNS0_6detail19type_erased_cgfo_tyERKNS2_14SubmissionInfoERKNS2_13code_locationEb
_ZN4sycl3_V15queue22submit_with_event_implERKNS0_6detail19type_erased_cgfo_tyERKNS2_2v114SubmissionInfoERKNS2_13code_locationEb
_ZN4sycl3_V15queue22submit_with_event_implESt8functionIFvRNS0_7handlerEEERKNS0_6detail14SubmissionInfoERKNS7_13code_locationEb
_ZN4sycl3_V15queue25ext_oneapi_submit_barrierERKNS0_6detail13code_locationE
_ZN4sycl3_V15queue25ext_oneapi_submit_barrierERKSt6vectorINS0_5eventESaIS3_EERKNS0_6detail13code_locationE
_ZN4sycl3_V15queue25submit_without_event_implERKNS0_6detail19type_erased_cgfo_tyERKNS2_14SubmissionInfoERKNS2_13code_locationEb
_ZN4sycl3_V15queue25submit_without_event_implERKNS0_6detail19type_erased_cgfo_tyERKNS2_2v114SubmissionInfoERKNS2_13code_locationEb
_ZN4sycl3_V15queue25submit_without_event_implESt8functionIFvRNS0_7handlerEEERKNS0_6detail13code_locationE
_ZN4sycl3_V15queue25submit_without_event_implESt8functionIFvRNS0_7handlerEEERKNS0_6detail13code_locationEb
_ZN4sycl3_V15queue25submit_without_event_implESt8functionIFvRNS0_7handlerEEERKNS0_6detail14SubmissionInfoERKNS7_13code_locationEb
_ZN4sycl3_V15queue27submit_impl_and_postprocessESt8functionIFvRNS0_7handlerEEERKNS0_6detail13code_locationERKS2_IFvbbRNS0_5eventEEE
_ZN4sycl3_V15queue27submit_impl_and_postprocessESt8functionIFvRNS0_7handlerEEERKNS0_6detail13code_locationERKS2_IFvbbRNS0_5eventEEEb
_ZN4sycl3_V15queue27submit_impl_and_postprocessESt8functionIFvRNS0_7handlerEEES1_RKNS0_6detail13code_locationERKS2_IFvbbRNS0_5eventEEE
_ZN4sycl3_V15queue27submit_impl_and_postprocessESt8functionIFvRNS0_7handlerEEES1_RKNS0_6detail13code_locationERKS2_IFvbbRNS0_5eventEEEb
_ZN4sycl3_V15queue29ext_oneapi_set_external_eventERKNS0_5eventE
_ZN4sycl3_V15queue6memcpyEPvPKvmNS0_5eventERKNS0_6detail13code_locationE
_ZN4sycl3_V15queue6memcpyEPvPKvmRKNS0_6detail13code_locationE
Expand Down Expand Up @@ -3287,11 +3271,6 @@ _ZN4sycl3_V16detail13lgamma_r_implEfPi
_ZN4sycl3_V16detail13make_platformEmNS0_7backendE
_ZN4sycl3_V16detail13select_deviceERKSt8functionIFiRKNS0_6deviceEEE
_ZN4sycl3_V16detail13select_deviceERKSt8functionIFiRKNS0_6deviceEEERKNS0_7contextE
_ZN4sycl3_V16detail14SubmissionInfo14SecondaryQueueEv
_ZN4sycl3_V16detail14SubmissionInfo17PostProcessorFuncEv
_ZN4sycl3_V16detail14SubmissionInfo9EventModeEv
_ZN4sycl3_V16detail14SubmissionInfoC1Ev
_ZN4sycl3_V16detail14SubmissionInfoC2Ev
_ZN4sycl3_V16detail14addCounterInitERNS0_7handlerERSt10shared_ptrINS1_10queue_implEERS4_IiE
_ZN4sycl3_V16detail14getBorderColorENS0_19image_channel_orderE
_ZN4sycl3_V16detail14tls_code_loc_t5queryEv
Expand Down Expand Up @@ -3822,9 +3801,6 @@ _ZNK4sycl3_V16detail12buffer_plain13handleReleaseEv
_ZNK4sycl3_V16detail12buffer_plain15getNativeVectorENS0_7backendE
_ZNK4sycl3_V16detail12buffer_plain22get_allocator_internalEv
_ZNK4sycl3_V16detail12buffer_plain7getSizeEv
_ZNK4sycl3_V16detail14SubmissionInfo14SecondaryQueueEv
_ZNK4sycl3_V16detail14SubmissionInfo17PostProcessorFuncEv
_ZNK4sycl3_V16detail14SubmissionInfo9EventModeEv
_ZNK4sycl3_V16detail16AccessorBaseHost11getElemSizeEv
_ZNK4sycl3_V16detail16AccessorBaseHost11getPropListEv
_ZNK4sycl3_V16detail16AccessorBaseHost13isPlaceholderEv
Expand Down
Loading