Reland: Explicitly track the scheduler task enqueueing order in a new field

components/scheduler/child/task_queue_impl.cc

 // Copyright 2015 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "components/scheduler/child/task_queue_impl.h"
 
 #include "components/scheduler/child/task_queue_manager.h"
 
 namespace scheduler {
 namespace internal {
 
 TaskQueueImpl::TaskQueueImpl(
     TaskQueueManager* task_queue_manager,
     const Spec& spec,
     const char* disabled_by_default_tracing_category,
     const char* disabled_by_default_verbose_tracing_category)
     : thread_id_(base::PlatformThread::CurrentId()),
       task_queue_manager_(task_queue_manager),
       pump_policy_(spec.pump_policy),
-      delayed_task_sequence_number_(0),
       name_(spec.name),
       disabled_by_default_tracing_category_(
           disabled_by_default_tracing_category),
       disabled_by_default_verbose_tracing_category_(
           disabled_by_default_verbose_tracing_category),
       wakeup_policy_(spec.wakeup_policy),
       set_index_(0),
       should_monitor_quiescence_(spec.should_monitor_quiescence),
       should_notify_observers_(spec.should_notify_observers) {}
 
 TaskQueueImpl::~TaskQueueImpl() {}
 
+TaskQueueImpl::Task::Task(const tracked_objects::Location& posted_from,
+                             const base::Closure& task,
+                             int sequence_number,
+                             bool nestable)
+    : PendingTask(posted_from, task, base::TimeTicks(), nestable),
+      enqueue_order(0) {
+  sequence_num = sequence_number;
+}
+
 void TaskQueueImpl::WillDeleteTaskQueueManager() {
   base::AutoLock lock(lock_);
   task_queue_manager_ = nullptr;
-  delayed_task_queue_ = base::DelayedTaskQueue();
-  incoming_queue_ = base::TaskQueue();
-  work_queue_ = base::TaskQueue();
+  delayed_task_queue_ = std::priority_queue<Task>();
+  incoming_queue_ = std::queue<Task>();
+  work_queue_ = std::queue<Task>();
 }
 
 bool TaskQueueImpl::RunsTasksOnCurrentThread() const {
   base::AutoLock lock(lock_);
   return base::PlatformThread::CurrentId() == thread_id_;
 }
 
 bool TaskQueueImpl::PostDelayedTask(const tracked_objects::Location& from_here,
                                     const base::Closure& task,
                                     base::TimeDelta delay) {
@@ skipping 36 matching lines @@
 }
 
 bool TaskQueueImpl::PostDelayedTaskLocked(
     LazyNow* lazy_now,
     const tracked_objects::Location& from_here,
     const base::Closure& task,
     base::TimeTicks desired_run_time,
     TaskType task_type) {
   lock_.AssertAcquired();
   DCHECK(task_queue_manager_);
-
-  base::PendingTask pending_task(from_here, task, base::TimeTicks(),
-                                 task_type != TaskType::NON_NESTABLE);
+  Task pending_task(from_here, task,
+                             task_queue_manager_->GetNextSequenceNumber(),

[Sami, 2015/08/05 14:51:15]

Is the indentation right here?

[alex clarke (OOO till 29th), 2015/08/05 15:33:05]

Done.

+                             task_type != TaskType::NON_NESTABLE);
   task_queue_manager_->DidQueueTask(pending_task);
 
   if (!desired_run_time.is_null()) {
     pending_task.delayed_run_time = std::max(lazy_now->Now(), desired_run_time);
-    pending_task.sequence_num = delayed_task_sequence_number_++;
+    // TODO(alexclarke): consider emplace() when C++11 library features allowed.
     delayed_task_queue_.push(pending_task);
     TraceQueueSize(true);
     // If we changed the topmost task, then it is time to reschedule.
     if (delayed_task_queue_.top().task.Equals(pending_task.task))
       ScheduleDelayedWorkLocked(lazy_now);
     return true;
   }
-  EnqueueTaskLocked(pending_task);
+  pending_task.enqueue_order = pending_task.sequence_num;
+  EnqueueTaskLocked(pending_task, EnqueueOrderPolicy::DONT_SET_ENQUEUE_ORDER);
   return true;
 }
 
 void TaskQueueImpl::MoveReadyDelayedTasksToIncomingQueue() {
   DCHECK(main_thread_checker_.CalledOnValidThread());
   base::AutoLock lock(lock_);
   if (!task_queue_manager_)
     return;
 
   LazyNow lazy_now(task_queue_manager_);
   MoveReadyDelayedTasksToIncomingQueueLocked(&lazy_now);
 }
 
 void TaskQueueImpl::MoveReadyDelayedTasksToIncomingQueueLocked(
     LazyNow* lazy_now) {
   lock_.AssertAcquired();
   // Enqueue all delayed tasks that should be running now.
   while (!delayed_task_queue_.empty() &&
          delayed_task_queue_.top().delayed_run_time <= lazy_now->Now()) {
     in_flight_kick_delayed_tasks_.erase(
         delayed_task_queue_.top().delayed_run_time);
-    EnqueueTaskLocked(delayed_task_queue_.top());
+    // TODO(alexclarke): consider std::move() when allowed.
+    EnqueueTaskLocked(delayed_task_queue_.top(),
+                      EnqueueOrderPolicy::SET_ENQUEUE_ORDER);
     delayed_task_queue_.pop();
   }
   TraceQueueSize(true);
   ScheduleDelayedWorkLocked(lazy_now);
 }
 
 void TaskQueueImpl::ScheduleDelayedWorkLocked(LazyNow* lazy_now) {
   lock_.AssertAcquired();
   // Any remaining tasks are in the future, so queue a task to kick them.
   if (!delayed_task_queue_.empty()) {
@@ skipping 43 matching lines @@
   // A null task is passed when UpdateQueue is called before any task is run.
   // In this case we don't want to pump an after_wakeup queue, so return true
   // here.
   if (!task)
     return true;
 
   // Return false if there are no task in the incoming queue.
   if (incoming_queue_.empty())
     return false;
 
-  base::PendingTask oldest_queued_task = incoming_queue_.front();
-  DCHECK(oldest_queued_task.delayed_run_time.is_null());
-  DCHECK(task->delayed_run_time.is_null());
-
-  // Note: the comparison is correct due to the fact that the PendingTask
-  // operator inverts its comparison operation in order to work well in a heap
-  // based priority queue.
-  return oldest_queued_task < *task;
+  const TaskQueueImpl::Task& oldest_queued_task = incoming_queue_.front();
+  return task->sequence_num < oldest_queued_task.sequence_num;

[Sami, 2015/08/05 14:51:14]

Isn't this where we should look at the enqueue_order instead :)

I wonder if in debug builds we should somehow fill sequence_number with garbage
while it isn't needed to make sure we don't accidentally use it?

[alex clarke (OOO till 29th), 2015/08/05 15:33:05]

Done.

 }
 
 bool TaskQueueImpl::ShouldAutoPumpQueueLocked(
     bool should_trigger_wakeup,
     const base::PendingTask* previous_task) {
   lock_.AssertAcquired();
   if (pump_policy_ == PumpPolicy::MANUAL)
     return false;
   if (pump_policy_ == PumpPolicy::AFTER_WAKEUP &&
       (!should_trigger_wakeup || TaskIsOlderThanQueuedTasks(previous_task)))
@@ skipping 13 matching lines @@
 }
 
 void TaskQueueImpl::UpdateWorkQueue(LazyNow* lazy_now,
                                     bool should_trigger_wakeup,
                                     const base::PendingTask* previous_task) {
   DCHECK(work_queue_.empty());
   base::AutoLock lock(lock_);
   if (!ShouldAutoPumpQueueLocked(should_trigger_wakeup, previous_task))
     return;
   MoveReadyDelayedTasksToIncomingQueueLocked(lazy_now);
-  work_queue_.Swap(&incoming_queue_);
+  std::swap(work_queue_, incoming_queue_);
   // |incoming_queue_| is now empty so TaskQueueManager::UpdateQueues no
   // longer needs to consider this queue for reloading.
   task_queue_manager_->UnregisterAsUpdatableTaskQueue(this);
   if (!work_queue_.empty()) {
     DCHECK(task_queue_manager_);
     task_queue_manager_->selector_.GetTaskQueueSets()->OnPushQueue(this);
     TraceQueueSize(true);
   }
 }
 
-base::PendingTask TaskQueueImpl::TakeTaskFromWorkQueue() {
-  base::PendingTask pending_task = work_queue_.front();
+TaskQueueImpl::Task TaskQueueImpl::TakeTaskFromWorkQueue() {
+  // TODO(alexclarke): consider std::move() when allowed.
+  Task pending_task = work_queue_.front();
   work_queue_.pop();
   DCHECK(task_queue_manager_);
   task_queue_manager_->selector_.GetTaskQueueSets()->OnPopQueue(this);
   TraceQueueSize(false);
   return pending_task;
 }
 
 void TaskQueueImpl::TraceQueueSize(bool is_locked) const {
   bool is_tracing;
   TRACE_EVENT_CATEGORY_GROUP_ENABLED(disabled_by_default_tracing_category_,
                                      &is_tracing);
   if (!is_tracing)
     return;
   if (!is_locked)
     lock_.Acquire();
   else
     lock_.AssertAcquired();
   TRACE_COUNTER1(
       disabled_by_default_tracing_category_, GetName(),
       incoming_queue_.size() + work_queue_.size() + delayed_task_queue_.size());
   if (!is_locked)
     lock_.Release();
 }
 
-void TaskQueueImpl::EnqueueTaskLocked(const base::PendingTask& pending_task) {
+void TaskQueueImpl::EnqueueTaskLocked(const Task& pending_task,
+                                      EnqueueOrderPolicy enqueue_order_policy) {
   lock_.AssertAcquired();
   if (!task_queue_manager_)
     return;
   if (incoming_queue_.empty())
     task_queue_manager_->RegisterAsUpdatableTaskQueue(this);
   if (pump_policy_ == PumpPolicy::AUTO && incoming_queue_.empty())
     task_queue_manager_->MaybePostDoWorkOnMainRunner();
+  // TODO(alexclarke): consider std::move() when allowed.
   incoming_queue_.push(pending_task);
-  incoming_queue_.back().sequence_num =
-      task_queue_manager_->GetNextSequenceNumber();
-
-  if (!pending_task.delayed_run_time.is_null()) {
-    // Clear the delayed run time because we've already applied the delay
-    // before getting here.
-    incoming_queue_.back().delayed_run_time = base::TimeTicks();
+  if (enqueue_order_policy == EnqueueOrderPolicy::SET_ENQUEUE_ORDER) {
+    incoming_queue_.back().enqueue_order =
+        task_queue_manager_->GetNextSequenceNumber();
   }
   TraceQueueSize(true);
 }
 
 void TaskQueueImpl::SetPumpPolicy(PumpPolicy pump_policy) {
   base::AutoLock lock(lock_);
   if (pump_policy == PumpPolicy::AUTO && pump_policy_ != PumpPolicy::AUTO) {
     PumpQueueLocked();
   }
   pump_policy_ = pump_policy;
 }
 
 void TaskQueueImpl::PumpQueueLocked() {
   lock_.AssertAcquired();
   if (!task_queue_manager_)
     return;
 
   LazyNow lazy_now(task_queue_manager_);
   MoveReadyDelayedTasksToIncomingQueueLocked(&lazy_now);
 
   bool was_empty = work_queue_.empty();
   while (!incoming_queue_.empty()) {
+    // TODO(alexclarke): consider std::move() when allowed.
     work_queue_.push(incoming_queue_.front());
     incoming_queue_.pop();
   }
   // |incoming_queue_| is now empty so TaskQueueManager::UpdateQueues no longer
   // needs to consider this queue for reloading.
   task_queue_manager_->UnregisterAsUpdatableTaskQueue(this);
   if (!work_queue_.empty()) {
     if (was_empty)
       task_queue_manager_->selector_.GetTaskQueueSets()->OnPushQueue(this);
     task_queue_manager_->MaybePostDoWorkOnMainRunner();
   }
 }
 
 void TaskQueueImpl::PumpQueue() {
   base::AutoLock lock(lock_);
   PumpQueueLocked();
 }
 
 const char* TaskQueueImpl::GetName() const {
   return name_;
 }
 
-bool TaskQueueImpl::GetWorkQueueFrontTaskAge(int* age) const {
+bool TaskQueueImpl::GetWorkQueueFrontTaskEnqueueOrder(
+    int* enqueue_order) const {
   if (work_queue_.empty())
     return false;
-  *age = work_queue_.front().sequence_num;
+  *enqueue_order = work_queue_.front().enqueue_order;
   return true;
 }
 
-void TaskQueueImpl::PushTaskOntoWorkQueueForTest(
-    const base::PendingTask& task) {
+void TaskQueueImpl::PushTaskOntoWorkQueueForTest(const Task& task) {
   work_queue_.push(task);
 }
 
 void TaskQueueImpl::PopTaskFromWorkQueueForTest() {
   work_queue_.pop();
 }
 
 void TaskQueueImpl::SetQueuePriority(QueuePriority priority) {
   DCHECK(main_thread_checker_.CalledOnValidThread());
   if (!task_queue_manager_)
@@ skipping 73 matching lines @@
     state->BeginArray("delayed_task_queue");
     QueueAsValueInto(delayed_task_queue_, state);
     state->EndArray();
   }
   state->SetString("priority",
                    PriorityToString(static_cast<QueuePriority>(set_index_)));
   state->EndDictionary();
 }
 
 // static
-void TaskQueueImpl::QueueAsValueInto(const base::TaskQueue& queue,
+void TaskQueueImpl::QueueAsValueInto(const std::queue<Task>& queue,
                                      base::trace_event::TracedValue* state) {
-  base::TaskQueue queue_copy(queue);
+  std::queue<Task> queue_copy(queue);
   while (!queue_copy.empty()) {
     TaskAsValueInto(queue_copy.front(), state);
     queue_copy.pop();
   }
 }
 
 // static
-void TaskQueueImpl::QueueAsValueInto(const base::DelayedTaskQueue& queue,
-                                     base::trace_event::TracedValue* state) {
-  base::DelayedTaskQueue queue_copy(queue);
+void TaskQueueImpl::QueueAsValueInto(
+    const std::priority_queue<Task>& queue,
+    base::trace_event::TracedValue* state) {
+  std::priority_queue<Task> queue_copy(queue);
   while (!queue_copy.empty()) {
     TaskAsValueInto(queue_copy.top(), state);
     queue_copy.pop();
   }
 }
 
 // static
-void TaskQueueImpl::TaskAsValueInto(const base::PendingTask& task,
+void TaskQueueImpl::TaskAsValueInto(const Task& task,
                                     base::trace_event::TracedValue* state) {
   state->BeginDictionary();
   state->SetString("posted_from", task.posted_from.ToString());
+  state->SetInteger("enqueue_order", task.enqueue_order);
   state->SetInteger("sequence_num", task.sequence_num);
   state->SetBoolean("nestable", task.nestable);
   state->SetBoolean("is_high_res", task.is_high_res);
   state->SetDouble(
       "delayed_run_time",
       (task.delayed_run_time - base::TimeTicks()).InMicroseconds() / 1000.0L);
   state->EndDictionary();
 }
 
 }  // namespace internal
 }  // namespace scheduler