Files
nearby/internal/test/fake_task_runner.h
T
Guogang Li 15d81201f8 Fixed data race in FakeTaskRunner
PiperOrigin-RevId: 528627577
2023-05-01 18:06:35 -07:00

102 lines
3.6 KiB
C++

// Copyright 2022-2023 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef THIRD_PARTY_NEARBY_INTERNAL_TEST_FAKE_TASK_RUNNER_H_
#define THIRD_PARTY_NEARBY_INTERNAL_TEST_FAKE_TASK_RUNNER_H_
#include <atomic>
#include <cstdint>
#include <future> //NOLINT
#include <memory>
#include <vector>
#include "absl/base/thread_annotations.h"
#include "absl/container/flat_hash_map.h"
#include "absl/time/time.h"
#include "internal/platform/task_runner.h"
#include "internal/test/fake_clock.h"
#include "internal/test/fake_timer.h"
namespace nearby {
class FakeTaskRunner : public TaskRunner {
public:
enum class Mode { kActive, kPending };
FakeTaskRunner(FakeClock* clock, uint32_t count)
: clock_(clock), count_(count) {}
~FakeTaskRunner() override ABSL_LOCKS_EXCLUDED(mutex_);
bool PostTask(absl::AnyInvocable<void()> task) override
ABSL_LOCKS_EXCLUDED(mutex_);
// No matter the mode is pending or not, always put the task in timer control.
// Caller can move forward time to trigger it.
bool PostDelayedTask(absl::Duration delay,
absl::AnyInvocable<void()> task) override
ABSL_LOCKS_EXCLUDED(mutex_);
// Mocked methods.
void SetMode(Mode mode) ABSL_LOCKS_EXCLUDED(mutex_);
Mode GetMode() const ABSL_LOCKS_EXCLUDED(mutex_);
void RunNextPendingTask() ABSL_LOCKS_EXCLUDED(mutex_);
void RunAllPendingTasks() ABSL_LOCKS_EXCLUDED(mutex_);
void Sync();
const std::vector<absl::AnyInvocable<void()>>& GetAllPendingTasks() const
ABSL_LOCKS_EXCLUDED(mutex_);
const absl::flat_hash_map<uint32_t, std::unique_ptr<Timer>>&
GetAllDelayedTasks() ABSL_LOCKS_EXCLUDED(mutex_);
int GetConcurrentCount() const ABSL_LOCKS_EXCLUDED(mutex_);
// In some test cases, we needs to make sure all running tasks completion
// before go to next task. This method can be used for the purpose.
static bool WaitForRunningTasksWithTimeout(absl::Duration timeout);
static int GetTotalRunningThreadCount() {
return total_running_thread_count_;
}
private:
uint32_t GenerateId();
void CleanThreads() ABSL_SHARED_LOCKS_REQUIRED(mutex_);
void Run(absl::AnyInvocable<void()> task) ABSL_SHARED_LOCKS_REQUIRED(mutex_);
void InternalRunNextPendingTask() ABSL_SHARED_LOCKS_REQUIRED(mutex_);
void RunNextQueueTask() ABSL_LOCKS_EXCLUDED(mutex_);
mutable absl::Mutex mutex_;
mutable absl::Mutex thread_mutex_;
Mode mode_ ABSL_GUARDED_BY(mutex_) = Mode::kActive;
std::atomic_uint current_id_ = 0;
FakeClock* clock_ = nullptr;
uint32_t count_ ABSL_GUARDED_BY(mutex_);
// Used for pending mode
std::vector<absl::AnyInvocable<void()>> pending_tasks_
ABSL_GUARDED_BY(mutex_);
std::vector<absl::AnyInvocable<void()>> queued_tasks_ ABSL_GUARDED_BY(mutex_);
std::vector<uint32_t> completed_delayed_tasks_ ABSL_GUARDED_BY(mutex_);
absl::flat_hash_map<uint32_t, std::unique_ptr<Timer>> queued_delayed_tasks_
ABSL_GUARDED_BY(mutex_);
std::vector<std::future<void>> threads_ ABSL_GUARDED_BY(mutex_);
int running_thread_count_ ABSL_GUARDED_BY(mutex_) = 0;
static std::atomic_uint total_running_thread_count_;
};
} // namespace nearby
#endif // THIRD_PARTY_NEARBY_INTERNAL_TEST_FAKE_TASK_RUNNER_H_