1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
|
// Copyright 2013 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef MOJO_EDK_SYSTEM_MESSAGE_PIPE_DISPATCHER_H_
#define MOJO_EDK_SYSTEM_MESSAGE_PIPE_DISPATCHER_H_
#include "base/macros.h"
#include "base/memory/ref_counted.h"
#include "mojo/edk/system/dispatcher.h"
#include "mojo/edk/system/memory.h"
#include "mojo/edk/system/system_impl_export.h"
namespace mojo {
namespace system {
class ChannelEndpoint;
class MessagePipe;
class MessagePipeDispatcherTransport;
// This is the |Dispatcher| implementation for message pipes (created by the
// Mojo primitive |MojoCreateMessagePipe()|). This class is thread-safe.
class MOJO_SYSTEM_IMPL_EXPORT MessagePipeDispatcher : public Dispatcher {
public:
// The default options to use for |MojoCreateMessagePipe()|. (Real uses
// should obtain this via |ValidateCreateOptions()| with a null |in_options|;
// this is exposed directly for testing convenience.)
static const MojoCreateMessagePipeOptions kDefaultCreateOptions;
MessagePipeDispatcher(
const MojoCreateMessagePipeOptions& /*validated_options*/);
// Validates and/or sets default options for |MojoCreateMessagePipeOptions|.
// If non-null, |in_options| must point to a struct of at least
// |in_options->struct_size| bytes. |out_options| must point to a (current)
// |MojoCreateMessagePipeOptions| and will be entirely overwritten on success
// (it may be partly overwritten on failure).
static MojoResult ValidateCreateOptions(
UserPointer<const MojoCreateMessagePipeOptions> in_options,
MojoCreateMessagePipeOptions* out_options);
// Must be called before any other methods. (This method is not thread-safe.)
void Init(scoped_refptr<MessagePipe> message_pipe, unsigned port);
// |Dispatcher| public methods:
Type GetType() const override;
// Creates a |MessagePipe| with a local endpoint (at port 0) and a proxy
// endpoint, and creates/initializes a |MessagePipeDispatcher| (attached to
// the message pipe, port 0).
// TODO(vtl): This currently uses |kDefaultCreateOptions|, which is okay since
// there aren't any options, but eventually options should be plumbed through.
static scoped_refptr<MessagePipeDispatcher> CreateRemoteMessagePipe(
scoped_refptr<ChannelEndpoint>* channel_endpoint);
// The "opposite" of |SerializeAndClose()|. (Typically this is called by
// |Dispatcher::Deserialize()|.)
static scoped_refptr<MessagePipeDispatcher> Deserialize(Channel* channel,
const void* source,
size_t size);
private:
friend class MessagePipeDispatcherTransport;
~MessagePipeDispatcher() override;
// Gets a dumb pointer to |message_pipe_|. This must be called under the
// |Dispatcher| lock (that it's a dumb pointer is okay since it's under lock).
// This is needed when sending handles across processes, where nontrivial,
// invasive work needs to be done.
MessagePipe* GetMessagePipeNoLock() const;
// Similarly for the port.
unsigned GetPortNoLock() const;
// |Dispatcher| protected methods:
void CancelAllAwakablesNoLock() override;
void CloseImplNoLock() override;
scoped_refptr<Dispatcher> CreateEquivalentDispatcherAndCloseImplNoLock()
override;
MojoResult WriteMessageImplNoLock(
UserPointer<const void> bytes,
uint32_t num_bytes,
std::vector<DispatcherTransport>* transports,
MojoWriteMessageFlags flags) override;
MojoResult ReadMessageImplNoLock(UserPointer<void> bytes,
UserPointer<uint32_t> num_bytes,
DispatcherVector* dispatchers,
uint32_t* num_dispatchers,
MojoReadMessageFlags flags) override;
HandleSignalsState GetHandleSignalsStateImplNoLock() const override;
MojoResult AddAwakableImplNoLock(Awakable* awakable,
MojoHandleSignals signals,
uint32_t context,
HandleSignalsState* signals_state) override;
void RemoveAwakableImplNoLock(Awakable* awakable,
HandleSignalsState* signals_state) override;
void StartSerializeImplNoLock(Channel* channel,
size_t* max_size,
size_t* max_platform_handles) override;
bool EndSerializeAndCloseImplNoLock(
Channel* channel,
void* destination,
size_t* actual_size,
embedder::PlatformHandleVector* platform_handles) override;
// Protected by |lock()|:
scoped_refptr<MessagePipe> message_pipe_; // This will be null if closed.
unsigned port_;
DISALLOW_COPY_AND_ASSIGN(MessagePipeDispatcher);
};
class MessagePipeDispatcherTransport : public DispatcherTransport {
public:
explicit MessagePipeDispatcherTransport(DispatcherTransport transport);
MessagePipe* GetMessagePipe() {
return message_pipe_dispatcher()->GetMessagePipeNoLock();
}
unsigned GetPort() { return message_pipe_dispatcher()->GetPortNoLock(); }
private:
MessagePipeDispatcher* message_pipe_dispatcher() {
return static_cast<MessagePipeDispatcher*>(dispatcher());
}
// Copy and assign allowed.
};
} // namespace system
} // namespace mojo
#endif // MOJO_EDK_SYSTEM_MESSAGE_PIPE_DISPATCHER_H_
|
