Introduce RunLoop::Delegate splitting RunLoop/MessageLoop some more.

base/run_loop.cc

 // Copyright (c) 2012 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/run_loop.h"
 
-#include <stack>
-
 #include "base/bind.h"
 #include "base/lazy_instance.h"
-#include "base/observer_list.h"
-#include "base/threading/thread_local_storage.h"
+#include "base/threading/thread_local.h"
 #include "base/tracked_objects.h"
 #include "build/build_config.h"
 
 namespace base {
 
 namespace {
 
-class ThreadLocalRunLoopState {
- public:
-  // A vector-based stack is more memory efficient than the default deque-based
-  // stack as the active RunLoop stack isn't expected to ever have more than a
-  // few entries.
-  using RunLoopStack = std::stack<RunLoop*, std::vector<RunLoop*>>;
-
-  ThreadLocalRunLoopState()
-      : slot_(&ThreadLocalRunLoopState::OnTLSDestruction) {}
-
-  ~ThreadLocalRunLoopState() = delete;
-
-  RunLoopStack& GetActiveRunLoops() {
-    return GetOrCreateInternalState()->active_run_loops;
-  }
-
-  ObserverList<RunLoop::NestingObserver>& GetNestingObservers() {
-    InternalState* state = GetOrCreateInternalState();
-    CHECK(state->allow_nesting);
-    return state->nesting_observers;
-  }
-
-  bool IsNestingAllowed() { return GetOrCreateInternalState()->allow_nesting; }
-
-  void DisallowNesting() { GetOrCreateInternalState()->allow_nesting = false; }
-
-  void Reset() {
-    InternalState* state = static_cast<InternalState*>(slot_.Get());
-    if (state) {
-      slot_.Set(nullptr);
-      delete state;
-    }
-  }
-
- private:
-  struct InternalState {
-    bool allow_nesting = true;
-    RunLoopStack active_run_loops;
-    ObserverList<RunLoop::NestingObserver> nesting_observers;
-  };
-
-  static void OnTLSDestruction(void* internal_state) {
-    delete static_cast<InternalState*>(internal_state);
-  }
-
-  InternalState* GetOrCreateInternalState() {
-    InternalState* state = static_cast<InternalState*>(slot_.Get());
-    if (!state) {
-      state = new InternalState;
-      slot_.Set(static_cast<void*>(state));
-    }
-    return state;
-  }
-
-  ThreadLocalStorage::Slot slot_;
-
-  DISALLOW_COPY_AND_ASSIGN(ThreadLocalRunLoopState);
-};
-
-LazyInstance<ThreadLocalRunLoopState>::Leaky tls_run_loop_state =
+LazyInstance<ThreadLocalPointer<RunLoop::Delegate>>::Leaky tls_delegate =
     LAZY_INSTANCE_INITIALIZER;
 
 }  // namespace
 
-RunLoop::RunLoop()
-    : loop_(MessageLoop::current()),
-      weak_factory_(this) {
-  DCHECK(loop_);
+RunLoop::Delegate::Delegate() {
+  // The Delegate can be created on another thread. It is only bound in
+  // BindToCurrentThread().
+  DETACH_FROM_THREAD(bound_thread_checker_);
+}
+
+RunLoop::Delegate::~Delegate() {
+  DCHECK_CALLED_ON_VALID_THREAD(bound_thread_checker_);
+  // A RunLoop::Delegate may be destroyed before it is bound, if so it may still
+  // be on its creation thread (e.g. a Thread that fails to start) and
+  // shouldn't disrupt that thread's state.
+  if (bound_)
+    tls_delegate.Get().Set(nullptr);
+}
+
+bool RunLoop::Delegate::IsNested() const {
+  DCHECK_CALLED_ON_VALID_THREAD(bound_thread_checker_);
+  DCHECK(bound_);
+  return active_run_loops_.size() > 1;
+}
+
+RunLoop* RunLoop::Delegate::GetTopMostRunLoop() const {
+  DCHECK_CALLED_ON_VALID_THREAD(bound_thread_checker_);
+  DCHECK(bound_);
+  return active_run_loops_.empty() ? nullptr : active_run_loops_.top();
+}
+
+void RunLoop::Delegate::BindToCurrentThread() {
+  // Bind the checker to this thread.
+  DCHECK_CALLED_ON_VALID_THREAD(bound_thread_checker_);
+
+  // There can only be one RunLoop::Delegate per thread.
+  DCHECK(!tls_delegate.Get().Get());
+  DCHECK(!bound_);
+  tls_delegate.Get().Set(this);
+  bound_ = true;
+}
+
+RunLoop::RunLoop() : delegate_(tls_delegate.Get().Get()), weak_factory_(this) {
+  // A RunLoop::Delegate must be bound to this thread prior to using RunLoop.
+  DCHECK(delegate_);
 }
 
 RunLoop::~RunLoop() {
   // TODO(gab): Fix bad usage and enable this check, http://crbug.com/715235.
   // DCHECK(thread_checker_.CalledOnValidThread());
 }
 
 void RunLoop::Run() {
   DCHECK(thread_checker_.CalledOnValidThread());
 
   if (!BeforeRun())
     return;
 
   // Use task stopwatch to exclude the loop run time from the current task, if
   // any.
   tracked_objects::TaskStopwatch stopwatch;
   stopwatch.Start();
-  loop_->RunHandler();
+  delegate_->Run();
   stopwatch.Stop();
 
   AfterRun();
 }
 
 void RunLoop::RunUntilIdle() {
   DCHECK(thread_checker_.CalledOnValidThread());
 
   quit_when_idle_received_ = true;
   Run();
 }
 
 void RunLoop::Quit() {
   DCHECK(thread_checker_.CalledOnValidThread());
 
   quit_called_ = true;
-  if (running_ && loop_->run_loop_ == this) {
+  if (running_ && delegate_->active_run_loops_.top() == this) {
     // This is the inner-most RunLoop, so quit now.
-    loop_->QuitNow();
+    delegate_->Quit();
   }
 }
 
 void RunLoop::QuitWhenIdle() {
   DCHECK(thread_checker_.CalledOnValidThread());
   quit_when_idle_received_ = true;
 }
 
 base::Closure RunLoop::QuitClosure() {
   // TODO(gab): Fix bad usage and enable this check, http://crbug.com/715235.
   // DCHECK(thread_checker_.CalledOnValidThread());
   return base::Bind(&RunLoop::Quit, weak_factory_.GetWeakPtr());
 }
 
 base::Closure RunLoop::QuitWhenIdleClosure() {
   // TODO(gab): Fix bad usage and enable this check, http://crbug.com/715235.
   // DCHECK(thread_checker_.CalledOnValidThread());
   return base::Bind(&RunLoop::QuitWhenIdle, weak_factory_.GetWeakPtr());
 }
 
 // static
-void RunLoop::ResetTLSState() {
-  tls_run_loop_state.Get().Reset();
-}
-
-// static
 bool RunLoop::IsRunningOnCurrentThread() {
-  return !tls_run_loop_state.Get().GetActiveRunLoops().empty();
+  return !tls_delegate.Get().Get()->active_run_loops_.empty();
 }
 
 // static
 bool RunLoop::IsNestedOnCurrentThread() {
-  return tls_run_loop_state.Get().GetActiveRunLoops().size() > 1;
+  return tls_delegate.Get().Get()->active_run_loops_.size() > 1;
 }
 
 // static
 void RunLoop::AddNestingObserverOnCurrentThread(NestingObserver* observer) {
-  tls_run_loop_state.Get().GetNestingObservers().AddObserver(observer);
+  Delegate* delegate = tls_delegate.Get().Get();
+  CHECK(delegate->allow_nesting_);
+  delegate->nesting_observers_.AddObserver(observer);
 }
 
 // static
 void RunLoop::RemoveNestingObserverOnCurrentThread(NestingObserver* observer) {
-  tls_run_loop_state.Get().GetNestingObservers().RemoveObserver(observer);
+  Delegate* delegate = tls_delegate.Get().Get();
+  CHECK(delegate->allow_nesting_);
+  delegate->nesting_observers_.RemoveObserver(observer);
 }
 
 // static
 bool RunLoop::IsNestingAllowedOnCurrentThread() {
-  return tls_run_loop_state.Get().IsNestingAllowed();
+  return tls_delegate.Get().Get()->allow_nesting_;
 }
 
 // static
 void RunLoop::DisallowNestingOnCurrentThread() {
-  tls_run_loop_state.Get().DisallowNesting();
+  tls_delegate.Get().Get()->allow_nesting_ = false;
 }
 
 bool RunLoop::BeforeRun() {
   DCHECK(thread_checker_.CalledOnValidThread());
 
   DCHECK(!run_called_);
   run_called_ = true;
 
   // Allow Quit to be called before Run.
   if (quit_called_)
     return false;
 
-  auto& active_run_loops = tls_run_loop_state.Get().GetActiveRunLoops();
-  active_run_loops.push(this);
+  auto& active_run_loops_ = delegate_->active_run_loops_;
+  active_run_loops_.push(this);
 
-  const bool is_nested = active_run_loops.size() > 1;
-
-  // TODO(gab): Break the inter-dependency between MessageLoop and RunLoop
-  // further. http://crbug.com/703346
-  loop_->run_loop_ = this;
-  loop_->is_nested_ = is_nested;
+  const bool is_nested = active_run_loops_.size() > 1;
 
   if (is_nested) {
-    CHECK(tls_run_loop_state.Get().IsNestingAllowed());
-    for (auto& observer : tls_run_loop_state.Get().GetNestingObservers())
+    CHECK(delegate_->allow_nesting_);
+    for (auto& observer : delegate_->nesting_observers_)
       observer.OnBeginNestedRunLoop();
   }
 
   running_ = true;
   return true;
 }
 
 void RunLoop::AfterRun() {
   DCHECK(thread_checker_.CalledOnValidThread());
 
   running_ = false;
 
-  auto& active_run_loops = tls_run_loop_state.Get().GetActiveRunLoops();
-  DCHECK_EQ(active_run_loops.top(), this);
-  active_run_loops.pop();
+  auto& active_run_loops_ = delegate_->active_run_loops_;
+  DCHECK_EQ(active_run_loops_.top(), this);
+  active_run_loops_.pop();
 
   RunLoop* previous_run_loop =
-      active_run_loops.empty() ? nullptr : active_run_loops.top();
-  loop_->run_loop_ = previous_run_loop;
-  loop_->is_nested_ = active_run_loops.size() > 1;
+      active_run_loops_.empty() ? nullptr : active_run_loops_.top();
 
   // Execute deferred QuitNow, if any:
   if (previous_run_loop && previous_run_loop->quit_called_)
-    loop_->QuitNow();
+    delegate_->Quit();
 }
 
 }  // namespace base