Skip to content
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.

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

Fix scheduler test failure #3145

Merged
merged 4 commits into from
Jan 21, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
25 changes: 9 additions & 16 deletions src/mbgl/actor/scheduler.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -48,29 +48,22 @@ std::shared_ptr<Scheduler> Scheduler::GetBackground() {

// static
std::shared_ptr<Scheduler> Scheduler::GetSequenced() {
const std::size_t kSchedulersCount = 10;
constexpr std::size_t kSchedulersCount = 10;
static std::vector<std::weak_ptr<Scheduler>> weaks(kSchedulersCount);
static std::mutex mtx;
static std::size_t lastUsedIndex = 0u;

std::lock_guard<std::mutex> lock(mtx);
std::lock_guard lock(mtx);

if (++lastUsedIndex == kSchedulersCount) lastUsedIndex = 0u;
lastUsedIndex = (lastUsedIndex + 1) % kSchedulersCount;

std::shared_ptr<Scheduler> result;
for (std::size_t i = 0; i < kSchedulersCount; ++i) {
auto& weak = weaks[i];
if (auto scheduler = weak.lock()) {
if (lastUsedIndex == i) result = scheduler;
continue;
}
result = std::make_shared<SequencedScheduler>();
weak = result;
lastUsedIndex = i;
break;
if (auto scheduler = weaks[lastUsedIndex].lock()) {
return scheduler;
} else {
TimSylvester marked this conversation as resolved.
Show resolved Hide resolved
auto result = std::make_shared<SequencedScheduler>();
weaks[lastUsedIndex] = result;
return result;
}

return result;
}

} // namespace mbgl
25 changes: 17 additions & 8 deletions test/util/async_task.test.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -206,13 +206,22 @@ TEST(AsyncTask, SequencedScheduler) {
}

TEST(AsyncTask, MultipleSequencedSchedulers) {
std::vector<std::shared_ptr<Scheduler>> shedulers;

for (int i = 0; i < 10; ++i) {
std::shared_ptr<Scheduler> scheduler = Scheduler::GetSequenced();
EXPECT_TRUE(std::none_of(
shedulers.begin(), shedulers.end(), [&scheduler](const auto &item) { return item == scheduler; }));
shedulers.emplace_back(std::move(scheduler));
constexpr std::size_t kSchedulersCount = 10; // must match the value in the scheduler

std::vector<std::shared_ptr<Scheduler>> schedulers;

// Regression check, the scheduler assignment was previously sensitive to the state of the weak references.
// If expired weak references followed a still-valid one, both after the last-used index, the index would
// be incremented multiple times.
auto temp = Scheduler::GetSequenced();
temp = Scheduler::GetSequenced();

// Check that exactly N unique schedulers are produced.
// Note that this relies on no other threads requesting schedulers.
for (std::size_t i = 0; i < kSchedulersCount; ++i) {
auto scheduler = Scheduler::GetSequenced();
EXPECT_TRUE(std::ranges::find(schedulers, scheduler) == schedulers.end());
schedulers.emplace_back(std::move(scheduler));
}
EXPECT_EQ(shedulers.front(), std::shared_ptr<Scheduler>(Scheduler::GetSequenced()));
EXPECT_EQ(schedulers.front(), Scheduler::GetSequenced());
}
Loading