blob: 2276f635c53be62707be34f4fe2693ba607b13a9 [file] [log] [blame]
* Copyright 2016 The WebRTC Project Authors. All rights reserved.
* Use of this source code is governed by a BSD-style license
* that can be found in the LICENSE file in the root of the source
* tree. An additional intellectual property rights grant can be found
* in the file PATENTS. All contributing project authors may
* be found in the AUTHORS file in the root of the source tree.
// This file contains the implementation of TaskQueue for Mac and iOS.
// The implementation uses Grand Central Dispatch queues (GCD) to
// do the actual task queuing.
#include "rtc_base/task_queue_gcd.h"
#include <dispatch/dispatch.h>
#include <string.h>
#include <memory>
#include "absl/strings/string_view.h"
#include "api/task_queue/queued_task.h"
#include "api/task_queue/task_queue_base.h"
#include "rtc_base/checks.h"
#include "rtc_base/logging.h"
#include "rtc_base/system/gcd_helpers.h"
namespace webrtc {
namespace {
int TaskQueuePriorityToGCD(TaskQueueFactory::Priority priority) {
switch (priority) {
case TaskQueueFactory::Priority::NORMAL:
case TaskQueueFactory::Priority::HIGH:
case TaskQueueFactory::Priority::LOW:
class TaskQueueGcd : public TaskQueueBase {
TaskQueueGcd(absl::string_view queue_name, int gcd_priority);
void Delete() override;
void PostTask(std::unique_ptr<QueuedTask> task) override;
void PostDelayedTask(std::unique_ptr<QueuedTask> task,
uint32_t milliseconds) override;
struct TaskContext {
TaskContext(TaskQueueGcd* queue, std::unique_ptr<QueuedTask> task)
: queue(queue), task(std::move(task)) {}
TaskQueueGcd* const queue;
std::unique_ptr<QueuedTask> task;
~TaskQueueGcd() override;
static void RunTask(void* task_context);
static void SetNotActive(void* task_queue);
static void DeleteQueue(void* task_queue);
dispatch_queue_t queue_;
bool is_active_;
TaskQueueGcd::TaskQueueGcd(absl::string_view queue_name, int gcd_priority)
: queue_(RTCDispatchQueueCreateWithTarget(
dispatch_get_global_queue(gcd_priority, 0))),
is_active_(true) {
dispatch_set_context(queue_, this);
// Assign a finalizer that will delete the queue when the last reference
// is released. This may run after the TaskQueue::Delete.
dispatch_set_finalizer_f(queue_, &DeleteQueue);
TaskQueueGcd::~TaskQueueGcd() = default;
void TaskQueueGcd::Delete() {
// Implementation/behavioral note:
// Dispatch queues are reference counted via calls to dispatch_retain and
// dispatch_release. Pending blocks submitted to a queue also hold a
// reference to the queue until they have finished. Once all references to a
// queue have been released, the queue will be deallocated by the system.
// This is why we check the is_active_ before running tasks.
// Use dispatch_sync to set the is_active_ to guarantee that there's not a
// race with checking it from a task.
dispatch_sync_f(queue_, this, &SetNotActive);
void TaskQueueGcd::PostTask(std::unique_ptr<QueuedTask> task) {
auto* context = new TaskContext(this, std::move(task));
dispatch_async_f(queue_, context, &RunTask);
void TaskQueueGcd::PostDelayedTask(std::unique_ptr<QueuedTask> task,
uint32_t milliseconds) {
auto* context = new TaskContext(this, std::move(task));
dispatch_time(DISPATCH_TIME_NOW, milliseconds * NSEC_PER_MSEC), queue_,
context, &RunTask);
// static
void TaskQueueGcd::RunTask(void* task_context) {
std::unique_ptr<TaskContext> tc(static_cast<TaskContext*>(task_context));
if (!tc->queue->is_active_)
CurrentTaskQueueSetter set_current(tc->queue);
auto* task = tc->task.release();
if (task->Run()) {
// Delete the task before CurrentTaskQueueSetter clears state that this code
// is running on the task queue.
delete task;
// static
void TaskQueueGcd::SetNotActive(void* task_queue) {
static_cast<TaskQueueGcd*>(task_queue)->is_active_ = false;
// static
void TaskQueueGcd::DeleteQueue(void* task_queue) {
delete static_cast<TaskQueueGcd*>(task_queue);
class TaskQueueGcdFactory final : public TaskQueueFactory {
std::unique_ptr<TaskQueueBase, TaskQueueDeleter> CreateTaskQueue(
absl::string_view name,
Priority priority) const override {
return std::unique_ptr<TaskQueueBase, TaskQueueDeleter>(
new TaskQueueGcd(name, TaskQueuePriorityToGCD(priority)));
} // namespace
std::unique_ptr<TaskQueueFactory> CreateTaskQueueGcdFactory() {
return std::make_unique<TaskQueueGcdFactory>();
} // namespace webrtc