6d4802f60acf071d13dc065fcb7bca502a02e356
[WebKit-https.git] / Source / WebKit / UIProcess / ChildProcessProxy.h
1 /*
2  * Copyright (C) 2012-2016 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "Connection.h"
29 #include "MessageReceiverMap.h"
30 #include "ProcessLauncher.h"
31
32 #include <WebCore/Process.h>
33 #include <wtf/ProcessID.h>
34 #include <wtf/SystemTracing.h>
35 #include <wtf/ThreadSafeRefCounted.h>
36
37 namespace WebKit {
38
39 class ChildProcessProxy : ProcessLauncher::Client, public IPC::Connection::Client, public ThreadSafeRefCounted<ChildProcessProxy> {
40     WTF_MAKE_NONCOPYABLE(ChildProcessProxy);
41
42 protected:
43     explicit ChildProcessProxy(bool alwaysRunsAtBackgroundPriority = false);
44
45 public:
46     virtual ~ChildProcessProxy();
47
48     void connect();
49     void terminate();
50
51     template<typename T> bool send(T&& message, uint64_t destinationID, OptionSet<IPC::SendOption> sendOptions = { });
52     template<typename T> bool sendSync(T&& message, typename T::Reply&&, uint64_t destinationID, Seconds timeout = 1_s, OptionSet<IPC::SendSyncOption> sendSyncOptions = { });
53
54     IPC::Connection* connection() const
55     {
56         ASSERT(m_connection);
57         return m_connection.get();
58     }
59     
60     bool hasConnection(const IPC::Connection& connection) const
61     {
62         return m_connection == &connection;
63     }
64
65     void addMessageReceiver(IPC::StringReference messageReceiverName, IPC::MessageReceiver&);
66     void addMessageReceiver(IPC::StringReference messageReceiverName, uint64_t destinationID, IPC::MessageReceiver&);
67     void removeMessageReceiver(IPC::StringReference messageReceiverName, uint64_t destinationID);
68     void removeMessageReceiver(IPC::StringReference messageReceiverName);
69
70     enum class State {
71         Launching,
72         Running,
73         Terminated,
74     };
75     State state() const;
76
77     ProcessID processIdentifier() const { return m_processLauncher ? m_processLauncher->processIdentifier() : 0; }
78
79     bool canSendMessage() const { return state() != State::Terminated;}
80     bool sendMessage(std::unique_ptr<IPC::Encoder>, OptionSet<IPC::SendOption>);
81
82     void shutDownProcess();
83
84     WebCore::ProcessIdentifier coreProcessIdentifier() const { return m_processIdentifier; }
85
86 protected:
87     // ProcessLauncher::Client
88     void didFinishLaunching(ProcessLauncher*, IPC::Connection::Identifier) override;
89
90     bool dispatchMessage(IPC::Connection&, IPC::Decoder&);
91     bool dispatchSyncMessage(IPC::Connection&, IPC::Decoder&, std::unique_ptr<IPC::Encoder>&);
92     
93     virtual void getLaunchOptions(ProcessLauncher::LaunchOptions&);
94
95 private:
96     virtual void connectionWillOpen(IPC::Connection&);
97     virtual void processWillShutDown(IPC::Connection&) = 0;
98
99     Vector<std::pair<std::unique_ptr<IPC::Encoder>, OptionSet<IPC::SendOption>>> m_pendingMessages;
100     RefPtr<ProcessLauncher> m_processLauncher;
101     RefPtr<IPC::Connection> m_connection;
102     IPC::MessageReceiverMap m_messageReceiverMap;
103     bool m_alwaysRunsAtBackgroundPriority { false };
104     WebCore::ProcessIdentifier m_processIdentifier { generateObjectIdentifier<WebCore::ProcessIdentifierType>() };
105 };
106
107 template<typename T>
108 bool ChildProcessProxy::send(T&& message, uint64_t destinationID, OptionSet<IPC::SendOption> sendOptions)
109 {
110     COMPILE_ASSERT(!T::isSync, AsyncMessageExpected);
111
112     auto encoder = std::make_unique<IPC::Encoder>(T::receiverName(), T::name(), destinationID);
113     encoder->encode(message.arguments());
114
115     return sendMessage(WTFMove(encoder), sendOptions);
116 }
117
118 template<typename U> 
119 bool ChildProcessProxy::sendSync(U&& message, typename U::Reply&& reply, uint64_t destinationID, Seconds timeout, OptionSet<IPC::SendSyncOption> sendSyncOptions)
120 {
121     COMPILE_ASSERT(U::isSync, SyncMessageExpected);
122
123     if (!m_connection)
124         return false;
125
126     TraceScope scope(SyncMessageStart, SyncMessageEnd);
127
128     return connection()->sendSync(std::forward<U>(message), WTFMove(reply), destinationID, timeout, sendSyncOptions);
129 }
130
131 } // namespace WebKit