Reduce amount of platform specific code in MessagePortChannel
[WebKit-https.git] / Source / WebCore / dom / default / PlatformMessagePortChannel.cpp
1 /*
2  * Copyright (C) 2009 Google Inc. All rights reserved.
3  * Copyright (C) 2013 Apple Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are
7  * met:
8  *
9  *     * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *     * Redistributions in binary form must reproduce the above
12  * copyright notice, this list of conditions and the following disclaimer
13  * in the documentation and/or other materials provided with the
14  * distribution.
15  *     * Neither the name of Google Inc. nor the names of its
16  * contributors may be used to endorse or promote products derived from
17  * this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 #include "config.h"
33 #include "PlatformMessagePortChannel.h"
34
35 #include "MessagePort.h"
36 #include "ScriptExecutionContext.h"
37
38 namespace WebCore {
39
40 void MessagePortChannel::createChannel(PassRefPtr<MessagePort> port1, PassRefPtr<MessagePort> port2)
41 {
42     RefPtr<PlatformMessagePortChannel::MessagePortQueue> queue1 = PlatformMessagePortChannel::MessagePortQueue::create();
43     RefPtr<PlatformMessagePortChannel::MessagePortQueue> queue2 = PlatformMessagePortChannel::MessagePortQueue::create();
44
45     // Create proxies for each endpoint.
46     RefPtr<PlatformMessagePortChannel> channel1 = PlatformMessagePortChannel::create(queue1, queue2);
47     RefPtr<PlatformMessagePortChannel> channel2 = PlatformMessagePortChannel::create(queue2, queue1);
48
49     // Entangle the two endpoints.
50     channel1->m_entangledChannel = channel2;
51     channel2->m_entangledChannel = channel1;
52
53     // Now entangle the proxies with the appropriate local ports.
54     port1->entangle(MessagePortChannel::create(channel2));
55     port2->entangle(MessagePortChannel::create(channel1));
56 }
57
58 PassOwnPtr<MessagePortChannel> MessagePortChannel::create(PassRefPtr<PlatformMessagePortChannel> channel)
59 {
60     return adoptPtr(new MessagePortChannel(channel));
61 }
62
63 MessagePortChannel::MessagePortChannel(PassRefPtr<PlatformMessagePortChannel> channel)
64     : m_channel(channel)
65 {
66 }
67
68 MessagePortChannel::~MessagePortChannel()
69 {
70     // Make sure we close our platform channel when the base is freed, to keep the channel objects from leaking.
71     close();
72 }
73
74 bool MessagePortChannel::entangleIfOpen(MessagePort* port)
75 {
76     // We can't call member functions on our remote pair while holding our mutex or we'll deadlock,
77     // but we need to guard against the remote port getting closed/freed, so create a standalone reference.
78     RefPtr<PlatformMessagePortChannel> remote = m_channel->entangledChannel();
79     if (!remote)
80         return false;
81     remote->setRemotePort(port);
82     return true;
83 }
84
85 void MessagePortChannel::disentangle()
86 {
87     RefPtr<PlatformMessagePortChannel> remote = m_channel->entangledChannel();
88     if (remote)
89         remote->setRemotePort(0);
90 }
91
92 void MessagePortChannel::postMessageToRemote(PassOwnPtr<MessagePortChannel::EventData> message)
93 {
94     MutexLocker lock(m_channel->m_mutex);
95     if (!m_channel->m_outgoingQueue)
96         return;
97     bool wasEmpty = m_channel->m_outgoingQueue->appendAndCheckEmpty(message);
98     if (wasEmpty && m_channel->m_remotePort)
99         m_channel->m_remotePort->messageAvailable();
100 }
101
102 bool MessagePortChannel::tryGetMessageFromRemote(OwnPtr<MessagePortChannel::EventData>& result)
103 {
104     MutexLocker lock(m_channel->m_mutex);
105     result = m_channel->m_incomingQueue->tryGetMessage();
106     return result;
107 }
108
109 void MessagePortChannel::close()
110 {
111     RefPtr<PlatformMessagePortChannel> remote = m_channel->entangledChannel();
112     if (!remote)
113         return;
114     m_channel->closeInternal();
115     remote->closeInternal();
116 }
117
118 bool MessagePortChannel::isConnectedTo(MessagePort* port)
119 {
120     // FIXME: What guarantees that the result remains the same after we release the lock?
121     MutexLocker lock(m_channel->m_mutex);
122     return m_channel->m_remotePort == port;
123 }
124
125 bool MessagePortChannel::hasPendingActivity()
126 {
127     // FIXME: What guarantees that the result remains the same after we release the lock?
128     MutexLocker lock(m_channel->m_mutex);
129     return !m_channel->m_incomingQueue->isEmpty();
130 }
131
132 MessagePort* MessagePortChannel::locallyEntangledPort(const ScriptExecutionContext* context)
133 {
134     MutexLocker lock(m_channel->m_mutex);
135     // See if both contexts are run by the same thread (are the same context, or are both documents).
136     if (m_channel->m_remotePort) {
137         // The remote port's ScriptExecutionContext is guaranteed not to change here - MessagePort::contextDestroyed()
138         // will close the port before the context goes away, and close() will block because we are holding the mutex.
139         ScriptExecutionContext* remoteContext = m_channel->m_remotePort->scriptExecutionContext();
140         if (remoteContext == context || (remoteContext && remoteContext->isDocument() && context->isDocument()))
141             return m_channel->m_remotePort;
142     }
143     return 0;
144 }
145
146 PassRefPtr<PlatformMessagePortChannel> PlatformMessagePortChannel::create(PassRefPtr<MessagePortQueue> incoming, PassRefPtr<MessagePortQueue> outgoing)
147 {
148     return adoptRef(new PlatformMessagePortChannel(incoming, outgoing));
149 }
150
151 PlatformMessagePortChannel::PlatformMessagePortChannel(PassRefPtr<MessagePortQueue> incoming, PassRefPtr<MessagePortQueue> outgoing)
152     : m_incomingQueue(incoming)
153     , m_outgoingQueue(outgoing)
154     , m_remotePort(0)
155 {
156 }
157
158 PlatformMessagePortChannel::~PlatformMessagePortChannel()
159 {
160 }
161
162 void PlatformMessagePortChannel::setRemotePort(MessagePort* port)
163 {
164     MutexLocker lock(m_mutex);
165     // Should never set port if it is already set.
166     ASSERT(!port || !m_remotePort);
167     m_remotePort = port;
168 }
169
170 PassRefPtr<PlatformMessagePortChannel> PlatformMessagePortChannel::entangledChannel()
171 {
172     // FIXME: What guarantees that the result remains the same after we release the lock?
173     // This lock only guarantees that the returned pointer will not be pointing to released memory,
174     // but not that it will still be pointing to this object's entangled port channel.
175     MutexLocker lock(m_mutex);
176     return m_entangledChannel;
177 }
178
179 void PlatformMessagePortChannel::closeInternal()
180 {
181     MutexLocker lock(m_mutex);
182     // Disentangle ourselves from the other end. We still maintain a reference to our incoming queue, since previously-existing messages should still be delivered.
183     m_remotePort = 0;
184     m_entangledChannel = 0;
185     m_outgoingQueue = 0;
186 }
187
188 } // namespace WebCore