Skip to content

[SYCL] reset enqueue status so that buffer can be used after failure is addressed #17871

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
Apr 10, 2025
Merged

[SYCL] reset enqueue status so that buffer can be used after failure is addressed #17871

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
e1b5fa1
if the EnqueueStatus isn't reset, the Command/Requirement cannot be r…
cperkinsintel Apr 3, 2025
50dcf30
not when host tasking
cperkinsintel Apr 7, 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
7 changes: 7 additions & 0 deletions sycl/source/detail/scheduler/graph_processor.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,13 @@ bool Scheduler::GraphProcessor::enqueueCommand(
return false;
}

// Reset enqueue status if reattempting

if (!Cmd->isHostTask() &&
Cmd->MEnqueueStatus == EnqueueResultT::SyclEnqueueFailed) {
Cmd->MEnqueueStatus = EnqueueResultT::SyclEnqueueReady;
}

// Recursively enqueue all the implicit + explicit backend level dependencies
// first and exit immediately if any of the commands cannot be enqueued.
for (const EventImplPtr &Event : Cmd->getPreparedDepsEvents()) {
Expand Down
15 changes: 8 additions & 7 deletions sycl/unittests/scheduler/FailedCommands.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,14 @@ TEST_F(SchedulerTest, FailedDependency) {
queue Queue(context(Plt), default_selector_v);

detail::Requirement MockReq = getMockRequirement();
MockCommand MDep(detail::getSyclObjImpl(Queue));
MockCommand MDepFail(
false, detail::getSyclObjImpl(Queue)); // <-- will fail to enqueue
MockCommand MUser(detail::getSyclObjImpl(Queue));
MDep.addUser(&MUser);
MDepFail.addUser(&MUser);
std::vector<detail::Command *> ToCleanUp;
(void)MUser.addDep(detail::DepDesc{&MDep, &MockReq, nullptr}, ToCleanUp);
(void)MUser.addDep(detail::DepDesc{&MDepFail, &MockReq, nullptr}, ToCleanUp);
MUser.MEnqueueStatus = detail::EnqueueResultT::SyclEnqueueReady;
MDep.MEnqueueStatus = detail::EnqueueResultT::SyclEnqueueFailed;
MDepFail.MEnqueueStatus = detail::EnqueueResultT::SyclEnqueueReady;

MockScheduler MS;
auto Lock = MS.acquireGraphReadLock();
Expand All @@ -35,13 +36,13 @@ TEST_F(SchedulerTest, FailedDependency) {
MockScheduler::enqueueCommand(&MUser, Res, detail::NON_BLOCKING);

ASSERT_FALSE(Enqueued) << "Enqueue process must fail\n";
ASSERT_EQ(Res.MCmd, &MDep) << "Wrong failed command\n";
ASSERT_EQ(Res.MCmd, &MDepFail) << "Wrong failed command\n";
ASSERT_EQ(Res.MResult, detail::EnqueueResultT::SyclEnqueueFailed)
<< "Enqueue process must fail\n";
ASSERT_EQ(MUser.MEnqueueStatus, detail::EnqueueResultT::SyclEnqueueReady)
<< "MUser shouldn't be marked as failed\n";
ASSERT_EQ(MDep.MEnqueueStatus, detail::EnqueueResultT::SyclEnqueueFailed)
<< "MDep should be marked as failed\n";
ASSERT_EQ(MDepFail.MEnqueueStatus, detail::EnqueueResultT::SyclEnqueueFailed)
<< "MDepFail should be marked as failed\n";
}

void RunWithFailedCommandsAndCheck(bool SyncExceptionExpected,
Expand Down
19 changes: 19 additions & 0 deletions sycl/unittests/scheduler/SchedulerTestUtils.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,17 @@ class MockCommand : public sycl::detail::Command {
EXPECT_CALL(*this, enqueue).Times(AnyNumber());
}

// This Mock will fail to enqueue.
MockCommand(
bool, sycl::detail::QueueImplPtr Queue,
sycl::detail::Command::CommandType Type = sycl::detail::Command::RUN_CG)
: Command{Type, Queue}, MRequirement{std::move(getMockRequirement())} {
using namespace testing;
ON_CALL(*this, enqueue)
.WillByDefault(Invoke(this, &MockCommand::enqueueFail));
EXPECT_CALL(*this, enqueue).Times(AnyNumber());
}

void printDot(std::ostream &) const override {}
void emitInstrumentationData() override {}

Expand All @@ -70,6 +81,14 @@ class MockCommand : public sycl::detail::Command {
std::vector<sycl::detail::Command *> &ToCleanUp) {
return sycl::detail::Command::enqueue(EnqueueResult, Blocking, ToCleanUp);
}
bool enqueueFail(sycl::detail::EnqueueResultT &EnqueueResult,
sycl::detail::BlockingT Blocking,
std::vector<sycl::detail::Command *> &ToCleanUp) {
this->MEnqueueStatus = sycl::detail::EnqueueResultT::SyclEnqueueFailed;
EnqueueResult = {sycl::detail::EnqueueResultT::SyclEnqueueFailed, this};
ToCleanUp.push_back(this);
return false;
}

ur_result_t MRetVal = UR_RESULT_SUCCESS;

Expand Down