Use WaitableEvents to wake up sync IPC waiting

ipc/ipc_sync_channel.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 "ipc/ipc_sync_channel.h"
 
 #include <stddef.h>
 #include <stdint.h>
 
 #include <utility>
 
 #include "base/bind.h"
 #include "base/lazy_instance.h"
 #include "base/location.h"
 #include "base/logging.h"
 #include "base/macros.h"
 #include "base/memory/ptr_util.h"
 #include "base/run_loop.h"
 #include "base/synchronization/waitable_event.h"
 #include "base/threading/thread_local.h"
 #include "base/threading/thread_task_runner_handle.h"
 #include "base/trace_event/trace_event.h"
 #include "ipc/ipc_channel_factory.h"
 #include "ipc/ipc_logging.h"
 #include "ipc/ipc_message_macros.h"
 #include "ipc/ipc_sync_message.h"
-#include "ipc/mojo_event.h"
-#include "mojo/public/cpp/bindings/sync_handle_registry.h"
-#include "mojo/public/cpp/bindings/sync_handle_watcher.h"
+#include "mojo/public/cpp/bindings/sync_event_watcher.h"
 
 using base::WaitableEvent;
 
 namespace IPC {
 
 namespace {
 
 // A generic callback used when watching handles synchronously. Sets |*signal|
-// to true. Also sets |*error| to true in case of an error.
-void OnSyncHandleReady(bool* signal, bool* error, MojoResult result) {
+// to true.
+void OnEventReady(bool* signal) {
   *signal = true;
-  *error = result != MOJO_RESULT_OK;
 }
 
-// A ReadyCallback for use with mojo::SimpleWatcher. Ignores the result
-// (DCHECKs, but is only used in cases where failure should be impossible) and
-// runs |callback|.
-void RunOnHandleReady(const base::Closure& callback, MojoResult result) {
-  DCHECK_EQ(result, MOJO_RESULT_OK);
-  callback.Run();
-}
-
-class PumpMessagesEvent {
- public:
-  PumpMessagesEvent() { event_.Signal(); }
-  ~PumpMessagesEvent() {}
-
-  const MojoEvent* event() const { return &event_; }
-
- private:
-  MojoEvent event_;
-
-  DISALLOW_COPY_AND_ASSIGN(PumpMessagesEvent);
-};
-
-base::LazyInstance<PumpMessagesEvent>::Leaky g_pump_messages_event =
-    LAZY_INSTANCE_INITIALIZER;
+base::LazyInstance<std::unique_ptr<base::WaitableEvent>>::Leaky
+    g_pump_messages_event = LAZY_INSTANCE_INITIALIZER;
 
 }  // namespace
 
 // When we're blocked in a Send(), we need to process incoming synchronous
 // messages right away because it could be blocking our reply (either
 // directly from the same object we're calling, or indirectly through one or
 // more other channels).  That means that in SyncContext's OnMessageReceived,
 // we need to process sync message right away if we're blocked.  However a
 // simple check isn't sufficient, because the listener thread can be in the
 // process of calling Send.
@@ skipping 124 matching lines @@
       }
     }
 
     if (--listener_count_ == 0) {
       DCHECK(lazy_tls_ptr_.Pointer()->Get());
       lazy_tls_ptr_.Pointer()->Set(nullptr);
       sync_dispatch_watcher_.reset();
     }
   }
 
-  MojoEvent* dispatch_event() { return &dispatch_event_; }
+  base::WaitableEvent* dispatch_event() { return &dispatch_event_; }
   base::SingleThreadTaskRunner* listener_task_runner() {
     return listener_task_runner_.get();
   }
 
   // Holds a pointer to the per-thread ReceivedSyncMsgQueue object.
   static base::LazyInstance<base::ThreadLocalPointer<ReceivedSyncMsgQueue>>::
       DestructorAtExit lazy_tls_ptr_;
 
   // Called on the ipc thread to check if we can unblock any current Send()
   // calls based on a queued reply.
   void DispatchReplies() {
     for (size_t i = 0; i < received_replies_.size(); ++i) {
       Message* message = received_replies_[i].message;
       if (received_replies_[i].context->TryToUnblockListener(message)) {
         delete message;
         received_replies_.erase(received_replies_.begin() + i);
         return;
       }
     }
   }
 
-  mojo::SimpleWatcher* top_send_done_watcher() {
-    return top_send_done_watcher_;
-  }
-
-  void set_top_send_done_watcher(mojo::SimpleWatcher* watcher) {
+  // See SyncChannel::WaitForReplyWithNestedMessageLoop for details.
+  void SetTopSendDoneState(
+      base::WaitableEventWatcher* watcher,
+      base::WaitableEvent* event,
+      const base::WaitableEventWatcher::EventCallback& callback,
+      base::WaitableEventWatcher** outer_watcher,
+      base::WaitableEvent** outer_event,
+      base::WaitableEventWatcher::EventCallback* outer_callback) {
+    if (outer_watcher) {
+      DCHECK(outer_event && outer_callback);
+      *outer_watcher = top_send_done_watcher_;
+      *outer_event = top_send_done_event_;
+      *outer_callback = top_send_done_callback_;
+    }
     top_send_done_watcher_ = watcher;
+    top_send_done_event_ = event;
+    top_send_done_callback_ = callback;
   }
 
  private:
   friend class base::RefCountedThreadSafe<ReceivedSyncMsgQueue>;
 
   // See the comment in SyncChannel::SyncChannel for why this event is created
   // as manual reset.
   ReceivedSyncMsgQueue()
       : message_queue_version_(0),
+        dispatch_event_(base::WaitableEvent::ResetPolicy::MANUAL,
+                        base::WaitableEvent::InitialState::NOT_SIGNALED),
         listener_task_runner_(base::ThreadTaskRunnerHandle::Get()),
-        task_pending_(false),
-        listener_count_(0),
-        top_send_done_watcher_(nullptr) {
-    sync_dispatch_watcher_.reset(new mojo::SyncHandleWatcher(
-        dispatch_event_.GetHandle(), MOJO_HANDLE_SIGNAL_READABLE,
-        base::Bind(&ReceivedSyncMsgQueue::OnDispatchHandleReady,
-                   base::Unretained(this))));
+        sync_dispatch_watcher_(base::MakeUnique<mojo::SyncEventWatcher>(
+            &dispatch_event_,
+            base::Bind(&ReceivedSyncMsgQueue::OnDispatchEventReady,
+                       base::Unretained(this)))) {
     sync_dispatch_watcher_->AllowWokenUpBySyncWatchOnSameThread();
   }
 
   ~ReceivedSyncMsgQueue() {}
 
-  void OnDispatchHandleReady(MojoResult result) {
-    if (result != MOJO_RESULT_OK)
-      return;
-
+  void OnDispatchEventReady() {
     if (dispatch_flag_) {
       *dispatch_flag_ = true;
       return;
     }
 
     // We were woken up during a sync wait, but no specific SyncChannel is
     // currently waiting. i.e., some other Mojo interface on this thread is
     // waiting for a response. Since we don't support anything analogous to
     // restricted dispatch on Mojo interfaces, in this case it's safe to
     // dispatch sync messages for any context.
     DispatchMessages(nullptr);
   }
 
   // Holds information about a queued synchronous message or reply.
   struct QueuedMessage {
     QueuedMessage(Message* m, SyncContext* c) : message(m), context(c) { }
     Message* message;
     scoped_refptr<SyncChannel::SyncContext> context;
   };
 
   typedef std::list<QueuedMessage> SyncMessageQueue;
   SyncMessageQueue message_queue_;
-  uint32_t message_queue_version_;  // Used to signal DispatchMessages to rescan
+
+  // Used to signal DispatchMessages to rescan
+  uint32_t message_queue_version_ = 0;
 
   std::vector<QueuedMessage> received_replies_;
 
   // Signaled when we get a synchronous message that we must respond to, as the
   // sender needs its reply before it can reply to our original synchronous
   // message.
-  MojoEvent dispatch_event_;
+  base::WaitableEvent dispatch_event_;
   scoped_refptr<base::SingleThreadTaskRunner> listener_task_runner_;
   base::Lock message_lock_;
-  bool task_pending_;
-  int listener_count_;
+  bool task_pending_ = false;
+  int listener_count_ = 0;
 
-  // The current send done handle watcher for this thread. Used to maintain
-  // a thread-local stack of send done watchers to ensure that nested sync
-  // message loops complete correctly.
-  mojo::SimpleWatcher* top_send_done_watcher_;
+  // The current send-done state for this thread. Used to maintain a thread-
+  // local stack of state to ensure that nested sync message loops complete
+  // correctly.
+  base::WaitableEventWatcher* top_send_done_watcher_ = nullptr;
+  base::WaitableEvent* top_send_done_event_ = nullptr;
+  base::WaitableEventWatcher::EventCallback top_send_done_callback_;
 
   // If not null, the address of a flag to set when the dispatch event signals,
   // in lieu of actually dispatching messages. This is used by
   // SyncChannel::WaitForReply to restrict the scope of queued messages we're
   // allowed to process while it's waiting.
   bool* dispatch_flag_ = nullptr;
 
   // Watches |dispatch_event_| during all sync handle watches on this thread.
-  std::unique_ptr<mojo::SyncHandleWatcher> sync_dispatch_watcher_;
+  std::unique_ptr<mojo::SyncEventWatcher> sync_dispatch_watcher_;
 };
 
 base::LazyInstance<base::ThreadLocalPointer<
     SyncChannel::ReceivedSyncMsgQueue>>::DestructorAtExit
     SyncChannel::ReceivedSyncMsgQueue::lazy_tls_ptr_ =
         LAZY_INSTANCE_INITIALIZER;
 
 SyncChannel::SyncContext::SyncContext(
     Listener* listener,
     const scoped_refptr<base::SingleThreadTaskRunner>& ipc_task_runner,
     WaitableEvent* shutdown_event)
     : ChannelProxy::Context(listener, ipc_task_runner),
       received_sync_msgs_(ReceivedSyncMsgQueue::AddContext()),
       shutdown_event_(shutdown_event),
       restrict_dispatch_group_(kRestrictDispatchGroup_None) {
 }
 
+void SyncChannel::SyncContext::OnSendDoneEventSignaled(
+    base::RunLoop* nested_loop,
+    base::WaitableEvent* event) {
+  DCHECK_EQ(GetSendDoneEvent(), event);
+  nested_loop->Quit();
+}
+
 SyncChannel::SyncContext::~SyncContext() {
   while (!deserializers_.empty())
     Pop();
 }
 
 // Adds information about an outgoing sync message to the context so that
 // we know how to deserialize the reply. Returns |true| if the message was added
 // to the context or |false| if it was rejected (e.g. due to shutdown.)
 bool SyncChannel::SyncContext::Push(SyncMessage* sync_msg) {
   // Create the tracking information for this message. This object is stored
   // by value since all members are pointers that are cheap to copy. These
   // pointers are cleaned up in the Pop() function.
   //
   // The event is created as manual reset because in between Signal and
   // OnObjectSignalled, another Send can happen which would stop the watcher
   // from being called.  The event would get watched later, when the nested
   // Send completes, so the event will need to remain set.
   base::AutoLock auto_lock(deserializers_lock_);
   if (reject_new_deserializers_)
     return false;
   PendingSyncMsg pending(
       SyncMessage::GetMessageId(*sync_msg), sync_msg->GetReplyDeserializer(),
-      new MojoEvent);
+      new base::WaitableEvent(base::WaitableEvent::ResetPolicy::MANUAL,
+                              base::WaitableEvent::InitialState::NOT_SIGNALED));
   deserializers_.push_back(pending);
   return true;
 }
 
 bool SyncChannel::SyncContext::Pop() {
   bool result;
   {
     base::AutoLock auto_lock(deserializers_lock_);
     PendingSyncMsg msg = deserializers_.back();
     delete msg.deserializer;
     delete msg.done_event;
     msg.done_event = nullptr;
     deserializers_.pop_back();
     result = msg.send_result;
   }
 
   // We got a reply to a synchronous Send() call that's blocking the listener
   // thread.  However, further down the call stack there could be another
   // blocking Send() call, whose reply we received after we made this last
   // Send() call.  So check if we have any queued replies available that
   // can now unblock the listener thread.
   ipc_task_runner()->PostTask(
       FROM_HERE, base::Bind(&ReceivedSyncMsgQueue::DispatchReplies,
                             received_sync_msgs_));
 
   return result;
 }
 
-MojoEvent* SyncChannel::SyncContext::GetSendDoneEvent() {
+base::WaitableEvent* SyncChannel::SyncContext::GetSendDoneEvent() {
   base::AutoLock auto_lock(deserializers_lock_);
   return deserializers_.back().done_event;
 }
 
-MojoEvent* SyncChannel::SyncContext::GetDispatchEvent() {
+base::WaitableEvent* SyncChannel::SyncContext::GetDispatchEvent() {
   return received_sync_msgs_->dispatch_event();
 }
 
 void SyncChannel::SyncContext::DispatchMessages() {
   received_sync_msgs_->DispatchMessages(this);
 }
 
 bool SyncChannel::SyncContext::TryToUnblockListener(const Message* msg) {
   base::AutoLock auto_lock(deserializers_lock_);
   if (deserializers_.empty() ||
       !SyncMessage::IsMessageReplyTo(*msg, deserializers_.back().id)) {
     return false;
   }
 
   if (!msg->is_reply_error()) {
     bool send_result = deserializers_.back().deserializer->
         SerializeOutputParameters(*msg);
     deserializers_.back().send_result = send_result;
     DVLOG_IF(1, !send_result) << "Couldn't deserialize reply message";
   } else {
     DVLOG(1) << "Received error reply";
   }
 
-  MojoEvent* done_event = deserializers_.back().done_event;
+  base::WaitableEvent* done_event = deserializers_.back().done_event;
   TRACE_EVENT_FLOW_BEGIN0(
       TRACE_DISABLED_BY_DEFAULT("ipc.flow"),
       "SyncChannel::SyncContext::TryToUnblockListener", done_event);
 
   done_event->Signal();
 
   return true;
 }
 
 void SyncChannel::SyncContext::Clear() {
@@ skipping 98 matching lines @@
     WaitableEvent* shutdown_event) {
   return base::WrapUnique(
       new SyncChannel(listener, ipc_task_runner, shutdown_event));
 }
 
 SyncChannel::SyncChannel(
     Listener* listener,
     const scoped_refptr<base::SingleThreadTaskRunner>& ipc_task_runner,
     WaitableEvent* shutdown_event)
     : ChannelProxy(new SyncContext(listener, ipc_task_runner, shutdown_event)),
-      sync_handle_registry_(mojo::SyncHandleRegistry::current()),
-      dispatch_watcher_(FROM_HERE,
-                        mojo::SimpleWatcher::ArmingPolicy::AUTOMATIC) {
+      sync_handle_registry_(mojo::SyncHandleRegistry::current()) {
   // The current (listener) thread must be distinct from the IPC thread, or else
   // sending synchronous messages will deadlock.
   DCHECK_NE(ipc_task_runner.get(), base::ThreadTaskRunnerHandle::Get().get());
   StartWatching();
 }
 
 SyncChannel::~SyncChannel() {
 }
 
 void SyncChannel::SetRestrictDispatchChannelGroup(int group) {
@@ skipping 47 matching lines @@
                         "SyncChannel::Send", context->GetSendDoneEvent());
 
   return context->Pop();
 }
 
 void SyncChannel::WaitForReply(mojo::SyncHandleRegistry* registry,
                                SyncContext* context,
                                bool pump_messages) {
   context->DispatchMessages();
 
-  const MojoEvent* pump_messages_event = nullptr;
-  if (pump_messages)
-    pump_messages_event = g_pump_messages_event.Get().event();
+  base::WaitableEvent* pump_messages_event = nullptr;
+  if (pump_messages) {
+    if (!g_pump_messages_event.Get()) {
+      g_pump_messages_event.Get() = base::MakeUnique<base::WaitableEvent>(
+          base::WaitableEvent::ResetPolicy::MANUAL,
+          base::WaitableEvent::InitialState::SIGNALED);
+    }
+    pump_messages_event = g_pump_messages_event.Get().get();
+  }
 
   while (true) {
     bool dispatch = false;
     bool send_done = false;
     bool should_pump_messages = false;
-    bool error = false;
-    bool registered = registry->RegisterHandle(
-        context->GetSendDoneEvent()->GetHandle(),
-        MOJO_HANDLE_SIGNAL_READABLE,
-        base::Bind(&OnSyncHandleReady, &send_done, &error));
+    bool registered = registry->RegisterEvent(
+        context->GetSendDoneEvent(), base::Bind(&OnEventReady, &send_done));
     DCHECK(registered);
+
     if (pump_messages_event) {
-      registered = registry->RegisterHandle(
-          pump_messages_event->GetHandle(), MOJO_HANDLE_SIGNAL_READABLE,
-          base::Bind(&OnSyncHandleReady, &should_pump_messages, &error));
+      registered = registry->RegisterEvent(
+          pump_messages_event,
+          base::Bind(&OnEventReady, &should_pump_messages));
       DCHECK(registered);
     }
 
     const bool* stop_flags[] = { &dispatch, &send_done, &should_pump_messages };
     context->received_sync_msgs()->BlockDispatch(&dispatch);
     registry->WatchAllHandles(stop_flags, 3);
     context->received_sync_msgs()->UnblockDispatch();
-    DCHECK(!error);
 
-    registry->UnregisterHandle(context->GetSendDoneEvent()->GetHandle());
+    registry->UnregisterEvent(context->GetSendDoneEvent());
     if (pump_messages_event)
-      registry->UnregisterHandle(pump_messages_event->GetHandle());
+      registry->UnregisterEvent(pump_messages_event);
 
     if (dispatch) {
       // We're waiting for a reply, but we received a blocking synchronous call.
       // We must process it to avoid potential deadlocks.
       context->GetDispatchEvent()->Reset();
       context->DispatchMessages();
       continue;
     }
 
     if (should_pump_messages)
       WaitForReplyWithNestedMessageLoop(context);  // Run a nested message loop.
 
     break;
   }
 }
 
 void SyncChannel::WaitForReplyWithNestedMessageLoop(SyncContext* context) {
-  mojo::SimpleWatcher send_done_watcher(
-      FROM_HERE, mojo::SimpleWatcher::ArmingPolicy::AUTOMATIC);
+  ReceivedSyncMsgQueue* sync_msg_queue = context->received_sync_msgs();
+  DCHECK(sync_msg_queue);
 
-  ReceivedSyncMsgQueue* sync_msg_queue = context->received_sync_msgs();
-  DCHECK_NE(sync_msg_queue, nullptr);
+  base::RunLoop nested_loop;
 
-  mojo::SimpleWatcher* old_watcher = sync_msg_queue->top_send_done_watcher();
-  mojo::Handle old_handle(mojo::kInvalidHandleValue);
-  mojo::SimpleWatcher::ReadyCallback old_callback;
+  // WaitForReplyWithNestedMessageLoop may be re-entered, i.e. we can nest
+  // waiting message loops arbitrarily deep on the SyncChannel's thread. Every
+  // such operation has a corresponding WaitableEvent to be watched which, when
+  // signalled for IPC completion, breaks out of the loop. The innermost (i.e.
+  // topmost) such event is stored in |sync_msg_queue| state.
+  //
+  // Here we preserve the current top-of-stack event state (if any) within the
+  // local stack frame. We then replace the event state in |sync_msg_queue| with
+  // our own and run a nested loop. If a subsequent nested loop is started
+  // therein the process is repeated in that stack frame, and so on.
+  //
+  // Once the innermost nested loop is broken, the locally preserved event state
+  // is swapped back into |sync_msg_queue| before unwinding the stack.
+  base::WaitableEventWatcher* outer_watcher = nullptr;

[yzshen1, 2017/03/23 20:15:50]

Does it make sense to group these three things into a struct, so it is easier to
init or pass around?

[Ken Rockot(use gerrit already), 2017/03/23 22:04:20]

Sure, that sounds nice. In fact I've gone and moved all of this logic into a
helper class and I think it's much easier to understand now.

+  base::WaitableEvent* outer_event = nullptr;
+  base::WaitableEventWatcher::EventCallback outer_callback;
+  base::WaitableEventWatcher send_done_watcher;
+  base::WaitableEvent* event = context->GetSendDoneEvent();
+  const base::WaitableEventWatcher::EventCallback callback =
+      base::Bind(&SyncContext::OnSendDoneEventSignaled, context, &nested_loop);
+  sync_msg_queue->SetTopSendDoneState(&send_done_watcher, event, callback,
+                                      &outer_watcher, &outer_event,
+                                      &outer_callback);
+  if (outer_watcher)
+    outer_watcher->StopWatching();
+  send_done_watcher.StartWatching(event, callback);
 
-  // Maintain a thread-local stack of watchers to ensure nested calls complete
-  // in the correct sequence, i.e. the outermost call completes first, etc.
-  if (old_watcher) {
-    old_callback = old_watcher->ready_callback();
-    old_handle = old_watcher->handle();
-    old_watcher->Cancel();
-  }
+  base::MessageLoop::ScopedNestableTaskAllower allow(
+      base::MessageLoop::current());
+  nested_loop.Run();
 
-  sync_msg_queue->set_top_send_done_watcher(&send_done_watcher);
-
-  {
-    base::RunLoop nested_loop;
-    send_done_watcher.Watch(
-        context->GetSendDoneEvent()->GetHandle(), MOJO_HANDLE_SIGNAL_READABLE,
-        base::Bind(&RunOnHandleReady, nested_loop.QuitClosure()));
-
-    base::MessageLoop::ScopedNestableTaskAllower allow(
-        base::MessageLoop::current());
-    nested_loop.Run();
-    send_done_watcher.Cancel();
-  }
-
-  sync_msg_queue->set_top_send_done_watcher(old_watcher);
-  if (old_watcher)
-    old_watcher->Watch(old_handle, MOJO_HANDLE_SIGNAL_READABLE, old_callback);
+  sync_msg_queue->SetTopSendDoneState(
+      outer_watcher, outer_event, outer_callback, nullptr, nullptr, nullptr);
+  if (outer_watcher)
+    outer_watcher->StartWatching(outer_event, outer_callback);
 }
 
-void SyncChannel::OnDispatchHandleReady(MojoResult result) {
-  DCHECK_EQ(result, MOJO_RESULT_OK);
+void SyncChannel::OnDispatchEventSignaled(base::WaitableEvent* event) {
+  DCHECK_EQ(sync_context()->GetDispatchEvent(), event);
   sync_context()->GetDispatchEvent()->Reset();
+
+  StartWatching();
+
+  // NOTE: May delete |this|.
   sync_context()->DispatchMessages();
 }
 
 void SyncChannel::StartWatching() {
   // |dispatch_watcher_| watches the event asynchronously, only dispatching
   // messages once the listener thread is unblocked and pumping its task queue.
   // The ReceivedSyncMsgQueue also watches this event and may dispatch
   // immediately if woken up by a message which it's allowed to dispatch.
-  dispatch_watcher_.Watch(
-      sync_context()->GetDispatchEvent()->GetHandle(),
-      MOJO_HANDLE_SIGNAL_READABLE,
-      base::Bind(&SyncChannel::OnDispatchHandleReady, base::Unretained(this)));
+  dispatch_watcher_.StartWatching(
+      sync_context()->GetDispatchEvent(),
+      base::Bind(&SyncChannel::OnDispatchEventSignaled,
+                 base::Unretained(this)));
 }
 
 void SyncChannel::OnChannelInit() {
   pre_init_sync_message_filters_.clear();
 }
 
 }  // namespace IPC