1/*
2 * Copyright (C) 2018 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 "MessagePortChannelProvider.h"
29#include "MessagePortIdentifier.h"
30#include "MessageWithMessagePorts.h"
31#include "ProcessIdentifier.h"
32#include <wtf/HashSet.h>
33#include <wtf/RefCounted.h>
34#include <wtf/text/WTFString.h>
35
36namespace WebCore {
37
38class MessagePortChannelRegistry;
39
40class MessagePortChannel : public RefCounted<MessagePortChannel> {
41public:
42 static Ref<MessagePortChannel> create(MessagePortChannelRegistry&, const MessagePortIdentifier& port1, const MessagePortIdentifier& port2);
43
44 ~MessagePortChannel();
45
46 const MessagePortIdentifier& port1() const { return m_ports[0]; }
47 const MessagePortIdentifier& port2() const { return m_ports[1]; }
48
49 WEBCORE_EXPORT Optional<ProcessIdentifier> processForPort(const MessagePortIdentifier&);
50 bool includesPort(const MessagePortIdentifier&);
51 void entanglePortWithProcess(const MessagePortIdentifier&, ProcessIdentifier);
52 void disentanglePort(const MessagePortIdentifier&);
53 void closePort(const MessagePortIdentifier&);
54 bool postMessageToRemote(MessageWithMessagePorts&&, const MessagePortIdentifier& remoteTarget);
55
56 void takeAllMessagesForPort(const MessagePortIdentifier&, Function<void(Vector<MessageWithMessagePorts>&&, Function<void()>&&)>&&);
57 void checkRemotePortForActivity(const MessagePortIdentifier&, CompletionHandler<void(MessagePortChannelProvider::HasActivity)>&& callback);
58
59 WEBCORE_EXPORT bool hasAnyMessagesPendingOrInFlight() const;
60
61 uint64_t beingTransferredCount();
62
63#if !LOG_DISABLED
64 String logString() const { return makeString(m_ports[0].logString(), ":", m_ports[1].logString()); }
65#endif
66
67private:
68 MessagePortChannel(MessagePortChannelRegistry&, const MessagePortIdentifier& port1, const MessagePortIdentifier& port2);
69
70 MessagePortIdentifier m_ports[2];
71 bool m_isClosed[2] { false, false };
72 Optional<ProcessIdentifier> m_processes[2];
73 RefPtr<MessagePortChannel> m_entangledToProcessProtectors[2];
74 Vector<MessageWithMessagePorts> m_pendingMessages[2];
75 HashSet<RefPtr<MessagePortChannel>> m_pendingMessagePortTransfers[2];
76 RefPtr<MessagePortChannel> m_pendingMessageProtectors[2];
77 uint64_t m_messageBatchesInFlight { 0 };
78
79 MessagePortChannelRegistry& m_registry;
80};
81
82} // namespace WebCore
83