WILL BE MERGED Change Ownership of Sequence to the Single Thread SchedulerWorker Delegate

base/task_scheduler/scheduler_single_thread_task_runner_manager.cc

 // Copyright 2017 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 "base/task_scheduler/scheduler_single_thread_task_runner_manager.h"
 
 #include <algorithm>
 #include <memory>
 #include <string>
 
@@ skipping 46 matching lines @@
       : thread_name_(thread_name) {}
 
   // SchedulerWorker::Delegate:
   void OnMainEntry(SchedulerWorker* worker) override {
     thread_ref_checker_.Set();
     PlatformThread::SetName(thread_name_);
   }
 
   scoped_refptr<Sequence> GetWork(SchedulerWorker* worker) override {
     AutoSchedulerLock auto_lock(sequence_lock_);
-    return std::move(sequence_);
+    bool has_work = has_work_;
+    has_work_ = false;
+    return has_work ? sequence_ : nullptr;
   }
 
   void DidRunTask() override {}
 
   void ReEnqueueSequence(scoped_refptr<Sequence> sequence) override {
     AutoSchedulerLock auto_lock(sequence_lock_);
-    DCHECK(!sequence_);
-    sequence_ = std::move(sequence);
+    // We've shut down, so no-op this work request. Any sequence cleanup will
+    // occur in the caller's context.
+    if (!sequence_)
+      return;
+
+    DCHECK_EQ(sequence, sequence_);
+    has_work_ = true;
   }
 
   TimeDelta GetSleepTimeout() override { return TimeDelta::Max(); }
 
   bool CanDetach(SchedulerWorker* worker) override { return false; }
 
   void OnDetach() override { NOTREACHED(); }
 
   bool RunsTasksOnCurrentThread() {
     // We check the thread ref instead of the sequence for the benefit of COM
     // callbacks which may execute without a sequence context.
     return thread_ref_checker_.IsCurrentThreadSameAsSetThread();
   }
 
+  void OnMainExit() override {
+    // To reclaim skipped tasks on shutdown, we null out the sequence to allow
+    // the tasks to destroy themselves.

[fdoray, 2017/03/03 05:31:13]

Need to grab the lock to clear the pointer. To avoid deleting tasks in the scope
of the lock, you could do:

scoped_refptr<Sequence> sequence;
{
  AutoSchedulerLock auto_lock(sequence_lock_);
  sequence = std::move(sequence_);
}
// Reference released at the end of the scope.

[robliao, 2017/03/03 07:07:14]

Nice. Yes indeed!

+    sequence_ = nullptr;
+  }
+
+  // SchedulerWorkerDelegate:
+
+  // Consumers should release their sequence reference as soon as possible to
+  // ensure timely cleanup for general shutdown.
+  scoped_refptr<Sequence> sequence() {
+    AutoSchedulerLock auto_lock(sequence_lock_);
+    return sequence_.get();

[fdoray, 2017/03/03 05:31:13]

no .get();

[robliao, 2017/03/03 07:07:14]

Done.

+  }
+
  private:
   const std::string thread_name_;
 
-  // Synchronizes access to |sequence_| and handles the fact that
-  // ReEnqueueSequence() is called on both the worker thread for reenqueuing
-  // the sequence and off of the worker thread to seed the sequence for
-  // GetWork().
+  // Synchronizes access to |sequence_| and |has_work_|.
   SchedulerLock sequence_lock_;
-  scoped_refptr<Sequence> sequence_;
+  scoped_refptr<Sequence> sequence_ = new Sequence;
+  bool has_work_ = false;
 
   AtomicThreadRefChecker thread_ref_checker_;
 
   DISALLOW_COPY_AND_ASSIGN(SchedulerWorkerDelegate);
 };
 
 }  // namespace
 
 class SchedulerSingleThreadTaskRunnerManager::SchedulerSingleThreadTaskRunner
     : public SingleThreadTaskRunner {
  public:
   // Constructs a SchedulerSingleThreadTaskRunner that indirectly controls the
   // lifetime of a dedicated |worker| for |traits|.
   SchedulerSingleThreadTaskRunner(
       SchedulerSingleThreadTaskRunnerManager* const outer,
       const TaskTraits& traits,
       SchedulerWorker* worker)
       : outer_(outer), traits_(traits), worker_(worker) {
     DCHECK(outer_);
     DCHECK(worker_);
   }
 
   // SingleThreadTaskRunner:
   bool PostDelayedTask(const tracked_objects::Location& from_here,
                        const Closure& closure,
-                       TimeDelta delay) override;
+                       TimeDelta delay) override {
+    auto task = MakeUnique<Task>(from_here, closure, traits_, delay);
+    task->single_thread_task_runner_ref = this;
+
+    if (!outer_->task_tracker_->WillPostTask(task.get()))
+      return false;
+
+    if (task->delayed_run_time.is_null()) {
+      PostTaskNow(std::move(task));
+    } else {
+      outer_->delayed_task_manager_->AddDelayedTask(
+          std::move(task), Bind(&SchedulerSingleThreadTaskRunner::PostTaskNow,
+                                Unretained(this)));
+    }
+    return true;
+  }
 
   bool PostNonNestableDelayedTask(const tracked_objects::Location& from_here,
                                   const Closure& closure,
                                   base::TimeDelta delay) override {
     // Tasks are never nested within the task scheduler.
     return PostDelayedTask(from_here, closure, delay);
   }
 
   bool RunsTasksOnCurrentThread() const override {
-    auto* delegate = static_cast<SchedulerWorkerDelegate*>(worker_->delegate());
-    return delegate->RunsTasksOnCurrentThread();
+    return GetDelegate()->RunsTasksOnCurrentThread();
   }
 
  private:
   ~SchedulerSingleThreadTaskRunner() override {
     outer_->UnregisterSchedulerWorker(worker_);
   }
 
-  void PostTaskNow(std::unique_ptr<Task> task);
+  void PostTaskNow(std::unique_ptr<Task> task) {
+    scoped_refptr<Sequence> sequence = GetDelegate()->sequence();
+    // If |sequence| is null, then the thread is effectively gone (either
+    // shutdonw or joined). We will destroy the task in this context instead.

[fdoray, 2017/03/03 05:31:13]

I don't find "We will destroy the task in this context instead." useful. The
task is always dropped when it can't be posted, no matter the reason.

[fdoray, 2017/03/03 05:31:13]

s/shutdonw/shutdown/

[robliao, 2017/03/03 07:07:13]

Done.

[robliao, 2017/03/03 07:07:14]

Sounds good. Removed.

+    if (!sequence)
+      return;
 
-  // Sequence for all Tasks posted through this TaskRunner.
-  const scoped_refptr<Sequence> sequence_ = new Sequence;
+    const bool sequence_was_empty = sequence->PushTask(std::move(task));
+    if (sequence_was_empty) {
+      GetDelegate()->ReEnqueueSequence(std::move(sequence));
+      worker_->WakeUp();
+    }

[fdoray, 2017/03/03 05:31:13]

The sequence and tasks it contained before the PushTask() may be destroyed here.
To avoid that, you could:

1. Never reset |SchedulerWorkerDelegate::sequence_|;
2. Add Sequence::Terminate() (see below).
3. Call Sequence::Terminate() from OnMainExit().
4. Do not take a strong ref in PostTaskNow().

That would guarantee that a task is destroyed:
- On the thread, or
- In its *own* post task call site.

void Sequence::Terminate() {
  {
    AutoSchedulerLock auto_lock(sequence_lock_);
    // All methods become no-op and queue is never accessed
    // when |terminated_| is true.
    terminated_ = true;
  }
  queue_.clear();
}

[robliao, 2017/03/03 07:07:14]

Offline discussion:
There is still a potential for tasks to get destroyed on the caller thread even
if we implement a way to clear the sequence.
We're going to keep things as is for now and see if this is a real problem in
the field.

In either way, it's likely callers that do encounter this may be doing the wrong
thing.

+  }
+
+  SchedulerWorkerDelegate* GetDelegate() const {
+    return static_cast<SchedulerWorkerDelegate*>(worker_->delegate());
+  }
 
   SchedulerSingleThreadTaskRunnerManager* const outer_;
   const TaskTraits traits_;
   SchedulerWorker* const worker_;
 
   DISALLOW_COPY_AND_ASSIGN(SchedulerSingleThreadTaskRunner);
 };
 
-bool SchedulerSingleThreadTaskRunnerManager::SchedulerSingleThreadTaskRunner::
-    PostDelayedTask(const tracked_objects::Location& from_here,
-                    const Closure& closure,
-                    TimeDelta delay) {
-  auto task = MakeUnique<Task>(from_here, closure, traits_, delay);
-  task->single_thread_task_runner_ref = this;
-
-  if (!outer_->task_tracker_->WillPostTask(task.get()))
-    return false;
-
-  if (task->delayed_run_time.is_null()) {
-    PostTaskNow(std::move(task));
-  } else {
-    outer_->delayed_task_manager_->AddDelayedTask(
-        std::move(task),
-        Bind(&SchedulerSingleThreadTaskRunner::PostTaskNow, Unretained(this)));
-  }
-  return true;
-}
-
-void SchedulerSingleThreadTaskRunnerManager::SchedulerSingleThreadTaskRunner::
-    PostTaskNow(std::unique_ptr<Task> task) {
-  const bool sequence_was_empty = sequence_->PushTask(std::move(task));
-  if (sequence_was_empty) {
-    auto* delegate = static_cast<SchedulerWorkerDelegate*>(worker_->delegate());
-    delegate->ReEnqueueSequence(sequence_);
-    worker_->WakeUp();
-  }
-}
-
 SchedulerSingleThreadTaskRunnerManager::SchedulerSingleThreadTaskRunnerManager(
     const std::vector<SchedulerWorkerPoolParams>& worker_pool_params_vector,
     const TaskScheduler::WorkerPoolIndexForTraitsCallback&
         worker_pool_index_for_traits_callback,
     TaskTracker* task_tracker,
     DelayedTaskManager* delayed_task_manager)
     : worker_pool_params_vector_(worker_pool_params_vector),
       worker_pool_index_for_traits_callback_(
           worker_pool_index_for_traits_callback),
       task_tracker_(task_tracker),
       delayed_task_manager_(delayed_task_manager) {
   DCHECK_GT(worker_pool_params_vector_.size(), 0U);
   DCHECK(worker_pool_index_for_traits_callback_);
   DCHECK(task_tracker_);
   DCHECK(delayed_task_manager_);
 }
 
 SchedulerSingleThreadTaskRunnerManager::
     ~SchedulerSingleThreadTaskRunnerManager() {
-  DCHECK(workers_.empty()) << "SchedulerSingleThreadTaskRunners must outlive "
-                              "SchedulerSingleThreadTaskRunnerManager";
+#if DCHECK_IS_ON()
+  size_t workers_unregistered_during_join =
+      subtle::NoBarrier_Load(&workers_unregistered_during_join_);
+  DCHECK_EQ(workers_unregistered_during_join, workers_.size())
+      << "There cannot be outstanding SingleThreadTaskRunners upon destruction"
+         "of SchedulerSingleThreadTaskRunnerManager or the Task Scheduler";
+#endif
 }
 
 scoped_refptr<SingleThreadTaskRunner>
 SchedulerSingleThreadTaskRunnerManager::CreateSingleThreadTaskRunnerWithTraits(
     const TaskTraits& traits) {
   size_t index = worker_pool_index_for_traits_callback_.Run(traits);
   DCHECK_LT(index, worker_pool_params_vector_.size());
   return new SchedulerSingleThreadTaskRunner(
       this, traits,
       CreateAndRegisterSchedulerWorker(worker_pool_params_vector_[index]));
@@ skipping 31 matching lines @@
 }
 
 void SchedulerSingleThreadTaskRunnerManager::UnregisterSchedulerWorker(
     SchedulerWorker* worker) {
   // Cleanup uses a SchedulerLock, so call Cleanup() after releasing
   // |workers_lock_|.
   scoped_refptr<SchedulerWorker> worker_to_destroy;
   {
     AutoSchedulerLock auto_lock(workers_lock_);
 
-    // We might be joining, so no-op this if |workers_| is empty.
-    if (workers_.empty())
+    // We might be joining, so record that a worker was unregistered for
+    // verification at destruction.
+    if (workers_.empty()) {
+#if DCHECK_IS_ON()
+      subtle::NoBarrier_AtomicIncrement(&workers_unregistered_during_join_, 1);
+#endif
       return;
+    }
 
     auto worker_iter =
         std::find_if(workers_.begin(), workers_.end(),
                      [worker](const scoped_refptr<SchedulerWorker>& candidate) {
                        return candidate.get() == worker;
                      });
     DCHECK(worker_iter != workers_.end());
     worker_to_destroy = std::move(*worker_iter);
     workers_.erase(worker_iter);
   }
   worker_to_destroy->Cleanup();
 }
 
 }  // namespace internal
 }  // namespace base