| /* |
| * Copyright (C) 2012-2019 Apple Inc. All rights reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions |
| * are met: |
| * 1. Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * 2. Redistributions in binary form must reproduce the above copyright |
| * notice, this list of conditions and the following disclaimer in the |
| * documentation and/or other materials provided with the distribution. |
| * |
| * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' |
| * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, |
| * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR |
| * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS |
| * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
| * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
| * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF |
| * THE POSSIBILITY OF SUCH DAMAGE. |
| */ |
| |
| #pragma once |
| |
| #include "Connection.h" |
| #include "MessageReceiverMap.h" |
| #include "ProcessLauncher.h" |
| |
| #include <WebCore/ProcessIdentifier.h> |
| #include <wtf/ProcessID.h> |
| #include <wtf/SystemTracing.h> |
| #include <wtf/ThreadSafeRefCounted.h> |
| |
| namespace WebKit { |
| |
| class AuxiliaryProcessProxy : ProcessLauncher::Client, public IPC::Connection::Client { |
| WTF_MAKE_NONCOPYABLE(AuxiliaryProcessProxy); |
| |
| protected: |
| explicit AuxiliaryProcessProxy(bool alwaysRunsAtBackgroundPriority = false); |
| |
| public: |
| virtual ~AuxiliaryProcessProxy(); |
| |
| void connect(); |
| void terminate(); |
| |
| template<typename T> bool send(T&& message, uint64_t destinationID, OptionSet<IPC::SendOption> sendOptions = { }); |
| template<typename T> bool sendSync(T&& message, typename T::Reply&&, uint64_t destinationID, Seconds timeout = 1_s, OptionSet<IPC::SendSyncOption> sendSyncOptions = { }); |
| template<typename T, typename C> void sendWithAsyncReply(T&&, C&&, uint64_t destinationID = 0, OptionSet<IPC::SendOption> = { }); |
| |
| template<typename T, typename U> |
| bool send(T&& message, ObjectIdentifier<U> destinationID, OptionSet<IPC::SendOption> sendOptions = { }) |
| { |
| return send<T>(WTFMove(message), destinationID.toUInt64(), sendOptions); |
| } |
| |
| template<typename T, typename U> |
| bool sendSync(T&& message, typename T::Reply&& reply, ObjectIdentifier<U> destinationID, Seconds timeout = 1_s, OptionSet<IPC::SendSyncOption> sendSyncOptions = { }) |
| { |
| return sendSync<T>(WTFMove(message), WTFMove(reply), destinationID.toUInt64(), timeout, sendSyncOptions); |
| } |
| |
| IPC::Connection* connection() const |
| { |
| ASSERT(m_connection); |
| return m_connection.get(); |
| } |
| |
| bool hasConnection(const IPC::Connection& connection) const |
| { |
| return m_connection == &connection; |
| } |
| |
| void addMessageReceiver(IPC::StringReference messageReceiverName, IPC::MessageReceiver&); |
| void addMessageReceiver(IPC::StringReference messageReceiverName, uint64_t destinationID, IPC::MessageReceiver&); |
| void removeMessageReceiver(IPC::StringReference messageReceiverName, uint64_t destinationID); |
| void removeMessageReceiver(IPC::StringReference messageReceiverName); |
| |
| template <typename T> |
| void addMessageReceiver(IPC::StringReference messageReceiverName, ObjectIdentifier<T> destinationID, IPC::MessageReceiver& receiver) |
| { |
| addMessageReceiver(messageReceiverName, destinationID.toUInt64(), receiver); |
| } |
| |
| template <typename T> |
| void removeMessageReceiver(IPC::StringReference messageReceiverName, ObjectIdentifier<T> destinationID) |
| { |
| removeMessageReceiver(messageReceiverName, destinationID.toUInt64()); |
| } |
| |
| enum class State { |
| Launching, |
| Running, |
| Terminated, |
| }; |
| State state() const; |
| bool isLaunching() const { return state() == State::Launching; } |
| bool wasTerminated() const; |
| |
| ProcessID processIdentifier() const { return m_processLauncher ? m_processLauncher->processIdentifier() : 0; } |
| |
| bool canSendMessage() const { return state() != State::Terminated;} |
| bool sendMessage(std::unique_ptr<IPC::Encoder>, OptionSet<IPC::SendOption>, Optional<std::pair<CompletionHandler<void(IPC::Decoder*)>, uint64_t>>&& asyncReplyInfo = WTF::nullopt); |
| |
| void shutDownProcess(); |
| |
| WebCore::ProcessIdentifier coreProcessIdentifier() const { return m_processIdentifier; } |
| |
| void setProcessSuppressionEnabled(bool); |
| |
| protected: |
| // ProcessLauncher::Client |
| void didFinishLaunching(ProcessLauncher*, IPC::Connection::Identifier) override; |
| |
| bool dispatchMessage(IPC::Connection&, IPC::Decoder&); |
| bool dispatchSyncMessage(IPC::Connection&, IPC::Decoder&, std::unique_ptr<IPC::Encoder>&); |
| |
| virtual void getLaunchOptions(ProcessLauncher::LaunchOptions&); |
| virtual void platformGetLaunchOptions(ProcessLauncher::LaunchOptions&) { }; |
| |
| struct PendingMessage { |
| std::unique_ptr<IPC::Encoder> encoder; |
| OptionSet<IPC::SendOption> sendOptions; |
| Optional<std::pair<CompletionHandler<void(IPC::Decoder*)>, uint64_t>> asyncReplyInfo; |
| }; |
| |
| virtual bool shouldSendPendingMessage(const PendingMessage&) { return true; } |
| |
| private: |
| virtual void connectionWillOpen(IPC::Connection&); |
| virtual void processWillShutDown(IPC::Connection&) = 0; |
| |
| Vector<PendingMessage> m_pendingMessages; |
| RefPtr<ProcessLauncher> m_processLauncher; |
| RefPtr<IPC::Connection> m_connection; |
| IPC::MessageReceiverMap m_messageReceiverMap; |
| bool m_alwaysRunsAtBackgroundPriority { false }; |
| WebCore::ProcessIdentifier m_processIdentifier { WebCore::ProcessIdentifier::generate() }; |
| }; |
| |
| template<typename T> |
| bool AuxiliaryProcessProxy::send(T&& message, uint64_t destinationID, OptionSet<IPC::SendOption> sendOptions) |
| { |
| COMPILE_ASSERT(!T::isSync, AsyncMessageExpected); |
| |
| auto encoder = makeUnique<IPC::Encoder>(T::receiverName(), T::name(), destinationID); |
| encoder->encode(message.arguments()); |
| |
| return sendMessage(WTFMove(encoder), sendOptions); |
| } |
| |
| template<typename U> |
| bool AuxiliaryProcessProxy::sendSync(U&& message, typename U::Reply&& reply, uint64_t destinationID, Seconds timeout, OptionSet<IPC::SendSyncOption> sendSyncOptions) |
| { |
| COMPILE_ASSERT(U::isSync, SyncMessageExpected); |
| |
| if (!m_connection) |
| return false; |
| |
| TraceScope scope(SyncMessageStart, SyncMessageEnd); |
| |
| return connection()->sendSync(std::forward<U>(message), WTFMove(reply), destinationID, timeout, sendSyncOptions); |
| } |
| |
| template<typename T, typename C> |
| void AuxiliaryProcessProxy::sendWithAsyncReply(T&& message, C&& completionHandler, uint64_t destinationID, OptionSet<IPC::SendOption> sendOptions) |
| { |
| COMPILE_ASSERT(!T::isSync, AsyncMessageExpected); |
| |
| auto encoder = makeUnique<IPC::Encoder>(T::receiverName(), T::name(), destinationID); |
| uint64_t listenerID = IPC::nextAsyncReplyHandlerID(); |
| encoder->encode(listenerID); |
| encoder->encode(message.arguments()); |
| sendMessage(WTFMove(encoder), sendOptions, {{ [completionHandler = WTFMove(completionHandler)] (IPC::Decoder* decoder) mutable { |
| if (decoder && !decoder->isInvalid()) |
| T::callReply(*decoder, WTFMove(completionHandler)); |
| else |
| T::cancelReply(WTFMove(completionHandler)); |
| }, listenerID }}); |
| } |
| |
| } // namespace WebKit |