[Win] WTF: Add alias for process id to use in place of direct uses of pid_t
[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 <wtf/ProcessID.h>
33 #include <wtf/SystemTracing.h>
34 #include <wtf/ThreadSafeRefCounted.h>
35
36 namespace WebKit {
37
38 class ChildProcessProxy : ProcessLauncher::Client, public IPC::Connection::Client, public ThreadSafeRefCounted<ChildProcessProxy> {
39     WTF_MAKE_NONCOPYABLE(ChildProcessProxy);
40
41 protected:
42     explicit ChildProcessProxy(bool alwaysRunsAtBackgroundPriority = false);
43
44 public:
45     virtual ~ChildProcessProxy();
46
47     void connect();
48     void terminate();
49
50     template<typename T> bool send(T&& message, uint64_t destinationID, OptionSet<IPC::SendOption> sendOptions = { });
51     template<typename T> bool sendSync(T&& message, typename T::Reply&&, uint64_t destinationID, Seconds timeout = 1_s, OptionSet<IPC::SendSyncOption> sendSyncOptions = { });
52
53     IPC::Connection* connection() const
54     {
55         ASSERT(m_connection);
56         return m_connection.get();
57     }
58     
59     bool hasConnection(const IPC::Connection& connection) const
60     {
61         return m_connection == &connection;
62     }
63
64     void addMessageReceiver(IPC::StringReference messageReceiverName, IPC::MessageReceiver&);
65     void addMessageReceiver(IPC::StringReference messageReceiverName, uint64_t destinationID, IPC::MessageReceiver&);
66     void removeMessageReceiver(IPC::StringReference messageReceiverName, uint64_t destinationID);
67     void removeMessageReceiver(IPC::StringReference messageReceiverName);
68
69     enum class State {
70         Launching,
71         Running,
72         Terminated,
73     };
74     State state() const;
75
76     ProcessID processIdentifier() const { return m_processLauncher ? m_processLauncher->processIdentifier() : 0; }
77
78     bool canSendMessage() const { return state() != State::Terminated;}
79     bool sendMessage(std::unique_ptr<IPC::Encoder>, OptionSet<IPC::SendOption>);
80
81     void shutDownProcess();
82
83 protected:
84     // ProcessLauncher::Client
85     void didFinishLaunching(ProcessLauncher*, IPC::Connection::Identifier) override;
86
87     bool dispatchMessage(IPC::Connection&, IPC::Decoder&);
88     bool dispatchSyncMessage(IPC::Connection&, IPC::Decoder&, std::unique_ptr<IPC::Encoder>&);
89     
90     virtual void getLaunchOptions(ProcessLauncher::LaunchOptions&);
91
92 private:
93     virtual void connectionWillOpen(IPC::Connection&);
94     virtual void processWillShutDown(IPC::Connection&) = 0;
95
96     Vector<std::pair<std::unique_ptr<IPC::Encoder>, OptionSet<IPC::SendOption>>> m_pendingMessages;
97     RefPtr<ProcessLauncher> m_processLauncher;
98     RefPtr<IPC::Connection> m_connection;
99     IPC::MessageReceiverMap m_messageReceiverMap;
100     bool m_alwaysRunsAtBackgroundPriority { false };
101 };
102
103 template<typename T>
104 bool ChildProcessProxy::send(T&& message, uint64_t destinationID, OptionSet<IPC::SendOption> sendOptions)
105 {
106     COMPILE_ASSERT(!T::isSync, AsyncMessageExpected);
107
108     auto encoder = std::make_unique<IPC::Encoder>(T::receiverName(), T::name(), destinationID);
109     encoder->encode(message.arguments());
110
111     return sendMessage(WTFMove(encoder), sendOptions);
112 }
113
114 template<typename U> 
115 bool ChildProcessProxy::sendSync(U&& message, typename U::Reply&& reply, uint64_t destinationID, Seconds timeout, OptionSet<IPC::SendSyncOption> sendSyncOptions)
116 {
117     COMPILE_ASSERT(U::isSync, SyncMessageExpected);
118
119     if (!m_connection)
120         return false;
121
122     TraceScope scope(SyncMessageStart, SyncMessageEnd);
123
124     return connection()->sendSync(std::forward<U>(message), WTFMove(reply), destinationID, timeout, sendSyncOptions);
125 }
126
127 } // namespace WebKit