| Index: ipc/ipc_sync_channel.cc
|
| diff --git a/ipc/ipc_sync_channel.cc b/ipc/ipc_sync_channel.cc
|
| index 570647bd5f58622e6555c51fb531b131bd4846dd..6485139c621f4f633391fda7c9b79084db8633f9 100644
|
| --- a/ipc/ipc_sync_channel.cc
|
| +++ b/ipc/ipc_sync_channel.cc
|
| @@ -13,10 +13,9 @@
|
| #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/synchronization/waitable_event_watcher.h"
|
| #include "base/threading/thread_local.h"
|
| #include "base/threading/thread_task_runner_handle.h"
|
| #include "base/trace_event/trace_event.h"
|
| @@ -24,84 +23,12 @@
|
| #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"
|
|
|
| using base::TimeDelta;
|
| using base::TimeTicks;
|
| using base::WaitableEvent;
|
|
|
| namespace IPC {
|
| -
|
| -namespace {
|
| -
|
| -// A lazy thread-local Mojo Event which is always signaled. Used to wake up the
|
| -// sync waiter when a SyncMessage requires the MessageLoop to be pumped while
|
| -// waiting for a reply. This object is created lazily and ref-counted so it can
|
| -// be cleaned up when no longer in use.
|
| -class PumpMessagesEvent {
|
| - public:
|
| - // Acquires the event for this thread. Creates a new instance if necessary.
|
| - static PumpMessagesEvent* Acquire() {
|
| - PumpMessagesEvent* pump_messages_event = g_event_.Pointer()->Get();
|
| - if (!pump_messages_event) {
|
| - pump_messages_event = new PumpMessagesEvent;
|
| - pump_messages_event->event_.Signal();
|
| - g_event_.Pointer()->Set(pump_messages_event);
|
| - }
|
| - pump_messages_event->ref_count_++;
|
| - return pump_messages_event;
|
| - }
|
| -
|
| - // Releases a handle to this event. There must be a 1:1 correspondence between
|
| - // calls to Acquire() and calls to Release().
|
| - static void Release() {
|
| - PumpMessagesEvent* pump_messages_event = g_event_.Pointer()->Get();
|
| - DCHECK(pump_messages_event);
|
| - DCHECK_GT(pump_messages_event->ref_count_, 0);
|
| - pump_messages_event->ref_count_--;
|
| - if (!pump_messages_event->ref_count_) {
|
| - g_event_.Pointer()->Set(nullptr);
|
| - delete pump_messages_event;
|
| - }
|
| - }
|
| -
|
| - const mojo::Handle& GetHandle() const { return event_.GetHandle(); }
|
| -
|
| - private:
|
| - PumpMessagesEvent() {}
|
| - ~PumpMessagesEvent() {}
|
| -
|
| - int ref_count_ = 0;
|
| - MojoEvent event_;
|
| -
|
| - static base::LazyInstance<base::ThreadLocalPointer<PumpMessagesEvent>>
|
| - g_event_;
|
| -
|
| - DISALLOW_COPY_AND_ASSIGN(PumpMessagesEvent);
|
| -};
|
| -
|
| -// 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) {
|
| - *signal = true;
|
| - *error = result != MOJO_RESULT_OK;
|
| -}
|
| -
|
| -// A ReadyCallback for use with mojo::Watcher. 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(result == MOJO_RESULT_OK || result == MOJO_RESULT_ABORTED);
|
| - if (result == MOJO_RESULT_OK)
|
| - callback.Run();
|
| -}
|
| -
|
| -} // namespace
|
| -
|
| -base::LazyInstance<base::ThreadLocalPointer<PumpMessagesEvent>>
|
| -PumpMessagesEvent::g_event_ = LAZY_INSTANCE_INITIALIZER;
|
| -
|
| // 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
|
| @@ -228,7 +155,7 @@
|
| }
|
| }
|
|
|
| - MojoEvent* dispatch_event() { return &dispatch_event_; }
|
| + WaitableEvent* dispatch_event() { return &dispatch_event_; }
|
| base::SingleThreadTaskRunner* listener_task_runner() {
|
| return listener_task_runner_.get();
|
| }
|
| @@ -250,11 +177,11 @@
|
| }
|
| }
|
|
|
| - mojo::Watcher* top_send_done_watcher() {
|
| + base::WaitableEventWatcher* top_send_done_watcher() {
|
| return top_send_done_watcher_;
|
| }
|
|
|
| - void set_top_send_done_watcher(mojo::Watcher* watcher) {
|
| + void set_top_send_done_watcher(base::WaitableEventWatcher* watcher) {
|
| top_send_done_watcher_ = watcher;
|
| }
|
|
|
| @@ -265,6 +192,8 @@
|
| // 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),
|
| @@ -285,19 +214,19 @@
|
|
|
| std::vector<QueuedMessage> received_replies_;
|
|
|
| - // Signaled when we get a synchronous message that we must respond to, as the
|
| + // Set when we got 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_;
|
| + WaitableEvent dispatch_event_;
|
| scoped_refptr<base::SingleThreadTaskRunner> listener_task_runner_;
|
| base::Lock message_lock_;
|
| bool task_pending_;
|
| int listener_count_;
|
|
|
| - // 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
|
| + // The current send done event watcher for this thread. Used to maintain
|
| + // a local global stack of send done watchers to ensure that nested sync
|
| // message loops complete correctly.
|
| - mojo::Watcher* top_send_done_watcher_;
|
| + base::WaitableEventWatcher* top_send_done_watcher_;
|
| };
|
|
|
| base::LazyInstance<base::ThreadLocalPointer<SyncChannel::ReceivedSyncMsgQueue> >
|
| @@ -333,7 +262,8 @@
|
| // Send completes, so the event will need to remain set.
|
| PendingSyncMsg pending(
|
| SyncMessage::GetMessageId(*sync_msg), sync_msg->GetReplyDeserializer(),
|
| - new MojoEvent);
|
| + new WaitableEvent(base::WaitableEvent::ResetPolicy::MANUAL,
|
| + base::WaitableEvent::InitialState::NOT_SIGNALED));
|
| base::AutoLock auto_lock(deserializers_lock_);
|
| deserializers_.push_back(pending);
|
| }
|
| @@ -345,7 +275,7 @@
|
| PendingSyncMsg msg = deserializers_.back();
|
| delete msg.deserializer;
|
| delete msg.done_event;
|
| - msg.done_event = nullptr;
|
| + msg.done_event = NULL;
|
| deserializers_.pop_back();
|
| result = msg.send_result;
|
| }
|
| @@ -362,12 +292,12 @@
|
| return result;
|
| }
|
|
|
| -MojoEvent* SyncChannel::SyncContext::GetSendDoneEvent() {
|
| +WaitableEvent* SyncChannel::SyncContext::GetSendDoneEvent() {
|
| base::AutoLock auto_lock(deserializers_lock_);
|
| return deserializers_.back().done_event;
|
| }
|
|
|
| -MojoEvent* SyncChannel::SyncContext::GetDispatchEvent() {
|
| +WaitableEvent* SyncChannel::SyncContext::GetDispatchEvent() {
|
| return received_sync_msgs_->dispatch_event();
|
| }
|
|
|
| @@ -391,7 +321,7 @@
|
| 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);
|
| @@ -437,7 +367,7 @@
|
| void SyncChannel::SyncContext::OnChannelOpened() {
|
| shutdown_watcher_.StartWatching(
|
| shutdown_event_,
|
| - base::Bind(&SyncChannel::SyncContext::OnShutdownEventSignaled,
|
| + base::Bind(&SyncChannel::SyncContext::OnWaitableEventSignaled,
|
| base::Unretained(this)));
|
| Context::OnChannelOpened();
|
| }
|
| @@ -460,12 +390,21 @@
|
| }
|
| }
|
|
|
| -void SyncChannel::SyncContext::OnShutdownEventSignaled(WaitableEvent* event) {
|
| - DCHECK_EQ(event, shutdown_event_);
|
| -
|
| - // Process shut down before we can get a reply to a synchronous message.
|
| - // Cancel pending Send calls, which will end up setting the send done event.
|
| - CancelPendingSends();
|
| +void SyncChannel::SyncContext::OnWaitableEventSignaled(WaitableEvent* event) {
|
| + if (event == shutdown_event_) {
|
| + // Process shut down before we can get a reply to a synchronous message.
|
| + // Cancel pending Send calls, which will end up setting the send done event.
|
| + CancelPendingSends();
|
| + } else {
|
| + // We got the reply, timed out or the process shutdown.
|
| + DCHECK_EQ(GetSendDoneEvent(), event);
|
| + base::MessageLoop::current()->QuitNow();
|
| + }
|
| +}
|
| +
|
| +base::WaitableEventWatcher::EventCallback
|
| + SyncChannel::SyncContext::MakeWaitableEventCallback() {
|
| + return base::Bind(&SyncChannel::SyncContext::OnWaitableEventSignaled, this);
|
| }
|
|
|
| // static
|
| @@ -509,10 +448,6 @@
|
| const scoped_refptr<base::SingleThreadTaskRunner>& ipc_task_runner,
|
| WaitableEvent* shutdown_event)
|
| : ChannelProxy(new SyncContext(listener, ipc_task_runner, shutdown_event)) {
|
| - // Keep a thread-local PumpMessagesEvent alive at least as long as any
|
| - // SyncChannel exists. This is balanced in the SyncChannel destructor below.
|
| - PumpMessagesEvent::Acquire();
|
| -
|
| // 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());
|
| @@ -520,7 +455,6 @@
|
| }
|
|
|
| SyncChannel::~SyncChannel() {
|
| - PumpMessagesEvent::Release();
|
| }
|
|
|
| void SyncChannel::SetRestrictDispatchChannelGroup(int group) {
|
| @@ -561,14 +495,14 @@
|
| }
|
|
|
| SyncMessage* sync_msg = static_cast<SyncMessage*>(message);
|
| - bool pump_messages = sync_msg->ShouldPumpMessages();
|
| context->Push(sync_msg);
|
| + WaitableEvent* pump_messages_event = sync_msg->pump_messages_event();
|
|
|
| ChannelProxy::Send(message);
|
|
|
| // Wait for reply, or for any other incoming synchronous messages.
|
| // *this* might get deleted, so only call static functions at this point.
|
| - WaitForReply(context.get(), pump_messages);
|
| + WaitForReply(context.get(), pump_messages_event);
|
|
|
| TRACE_EVENT_FLOW_END0(TRACE_DISABLED_BY_DEFAULT("ipc.flow"),
|
| "SyncChannel::Send", context->GetSendDoneEvent());
|
| @@ -576,45 +510,19 @@
|
| return context->Pop();
|
| }
|
|
|
| -void SyncChannel::WaitForReply(SyncContext* context, bool pump_messages) {
|
| +void SyncChannel::WaitForReply(
|
| + SyncContext* context, WaitableEvent* pump_messages_event) {
|
| context->DispatchMessages();
|
| -
|
| - PumpMessagesEvent* pump_messages_event = nullptr;
|
| - if (pump_messages)
|
| - pump_messages_event = PumpMessagesEvent::Acquire();
|
| -
|
| - scoped_refptr<mojo::SyncHandleRegistry> registry =
|
| - mojo::SyncHandleRegistry::current();
|
| -
|
| while (true) {
|
| - bool dispatch = false;
|
| - bool send_done = false;
|
| - bool should_pump_messages = false;
|
| - bool error = false;
|
| - registry->RegisterHandle(context->GetDispatchEvent()->GetHandle(),
|
| - MOJO_HANDLE_SIGNAL_READABLE,
|
| - base::Bind(&OnSyncHandleReady, &dispatch, &error));
|
| - registry->RegisterHandle(
|
| - context->GetSendDoneEvent()->GetHandle(),
|
| - MOJO_HANDLE_SIGNAL_READABLE,
|
| - base::Bind(&OnSyncHandleReady, &send_done, &error));
|
| - if (pump_messages_event) {
|
| - registry->RegisterHandle(
|
| - pump_messages_event->GetHandle(), MOJO_HANDLE_SIGNAL_READABLE,
|
| - base::Bind(&OnSyncHandleReady, &should_pump_messages, &error));
|
| - }
|
| -
|
| - const bool* stop_flags[] = { &dispatch, &send_done, &should_pump_messages };
|
| - bool result = registry->WatchAllHandles(stop_flags, 3);
|
| - DCHECK(result);
|
| - DCHECK(!error);
|
| -
|
| - registry->UnregisterHandle(context->GetDispatchEvent()->GetHandle());
|
| - registry->UnregisterHandle(context->GetSendDoneEvent()->GetHandle());
|
| - if (pump_messages_event)
|
| - registry->UnregisterHandle(pump_messages_event->GetHandle());
|
| -
|
| - if (dispatch) {
|
| + WaitableEvent* objects[] = {
|
| + context->GetDispatchEvent(),
|
| + context->GetSendDoneEvent(),
|
| + pump_messages_event
|
| + };
|
| +
|
| + unsigned count = pump_messages_event ? 3: 2;
|
| + size_t result = WaitableEvent::WaitMany(objects, count);
|
| + if (result == 0 /* dispatch event */) {
|
| // We're waiting for a reply, but we received a blocking synchronous
|
| // call. We must process it or otherwise a deadlock might occur.
|
| context->GetDispatchEvent()->Reset();
|
| @@ -622,72 +530,72 @@
|
| continue;
|
| }
|
|
|
| - DCHECK(send_done || should_pump_messages);
|
| -
|
| - if (should_pump_messages)
|
| + if (result == 2 /* pump_messages_event */)
|
| WaitForReplyWithNestedMessageLoop(context); // Run a nested message loop.
|
|
|
| break;
|
| }
|
| -
|
| - if (pump_messages_event)
|
| - PumpMessagesEvent::Release();
|
| }
|
|
|
| void SyncChannel::WaitForReplyWithNestedMessageLoop(SyncContext* context) {
|
| - mojo::Watcher send_done_watcher;
|
| + base::WaitableEventWatcher send_done_watcher;
|
|
|
| ReceivedSyncMsgQueue* sync_msg_queue = context->received_sync_msgs();
|
| - DCHECK_NE(sync_msg_queue, nullptr);
|
| -
|
| - mojo::Watcher* old_watcher = sync_msg_queue->top_send_done_watcher();
|
| - mojo::Handle old_handle(mojo::kInvalidHandleValue);
|
| - mojo::Watcher::ReadyCallback old_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();
|
| + DCHECK(sync_msg_queue != NULL);
|
| +
|
| + base::WaitableEventWatcher* old_send_done_event_watcher =
|
| + sync_msg_queue->top_send_done_watcher();
|
| +
|
| + base::WaitableEventWatcher::EventCallback old_callback;
|
| + base::WaitableEvent* old_event = NULL;
|
| +
|
| + // Maintain a local global stack of send done delegates to ensure that
|
| + // nested sync calls complete in the correct sequence, i.e. the
|
| + // outermost call completes first, etc.
|
| + if (old_send_done_event_watcher) {
|
| + old_callback = old_send_done_event_watcher->callback();
|
| + old_event = old_send_done_event_watcher->GetWatchedEvent();
|
| + old_send_done_event_watcher->StopWatching();
|
| }
|
|
|
| sync_msg_queue->set_top_send_done_watcher(&send_done_watcher);
|
|
|
| + send_done_watcher.StartWatching(context->GetSendDoneEvent(),
|
| + context->MakeWaitableEventCallback());
|
| +
|
| {
|
| - base::RunLoop nested_loop;
|
| - send_done_watcher.Start(
|
| - 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->Start(old_handle, MOJO_HANDLE_SIGNAL_READABLE, old_callback);
|
| -}
|
| -
|
| -void SyncChannel::OnDispatchHandleReady(MojoResult result) {
|
| - DCHECK(result == MOJO_RESULT_OK || result == MOJO_RESULT_ABORTED);
|
| - if (result == MOJO_RESULT_OK) {
|
| - sync_context()->GetDispatchEvent()->Reset();
|
| - sync_context()->DispatchMessages();
|
| - }
|
| + base::MessageLoop::current()->Run();
|
| + }
|
| +
|
| + sync_msg_queue->set_top_send_done_watcher(old_send_done_event_watcher);
|
| + if (old_send_done_event_watcher && old_event) {
|
| + old_send_done_event_watcher->StartWatching(old_event, old_callback);
|
| + }
|
| +}
|
| +
|
| +void SyncChannel::OnWaitableEventSignaled(WaitableEvent* event) {
|
| + DCHECK(event == sync_context()->GetDispatchEvent());
|
| + // The call to DispatchMessages might delete this object, so reregister
|
| + // the object watcher first.
|
| + event->Reset();
|
| + dispatch_watcher_.StartWatching(event, dispatch_watcher_callback_);
|
| + sync_context()->DispatchMessages();
|
| }
|
|
|
| void SyncChannel::StartWatching() {
|
| // Ideally we only want to watch this object when running a nested message
|
| // loop. However, we don't know when it exits if there's another nested
|
| // message loop running under it or not, so we wouldn't know whether to
|
| - // stop or keep watching. So we always watch it.
|
| - dispatch_watcher_.Start(sync_context()->GetDispatchEvent()->GetHandle(),
|
| - MOJO_HANDLE_SIGNAL_READABLE,
|
| - base::Bind(&SyncChannel::OnDispatchHandleReady,
|
| - base::Unretained(this)));
|
| + // stop or keep watching. So we always watch it, and create the event as
|
| + // manual reset since the object watcher might otherwise reset the event
|
| + // when we're doing a WaitMany.
|
| + dispatch_watcher_callback_ =
|
| + base::Bind(&SyncChannel::OnWaitableEventSignaled,
|
| + base::Unretained(this));
|
| + dispatch_watcher_.StartWatching(sync_context()->GetDispatchEvent(),
|
| + dispatch_watcher_callback_);
|
| }
|
|
|
| void SyncChannel::OnChannelInit() {
|
|
|