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
|
// Copyright 2014 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_SHARED_BUFFER_DISPATCHER_H_
#define MOJO_EDK_SYSTEM_SHARED_BUFFER_DISPATCHER_H_
#include <stddef.h>
#include <stdint.h>
#include <utility>
#include "base/macros.h"
#include "mojo/edk/embedder/platform_handle_vector.h"
#include "mojo/edk/embedder/platform_shared_buffer.h"
#include "mojo/edk/embedder/scoped_platform_handle.h"
#include "mojo/edk/system/dispatcher.h"
#include "mojo/edk/system/system_impl_export.h"
namespace mojo {
namespace edk {
class NodeController;
class MOJO_SYSTEM_IMPL_EXPORT SharedBufferDispatcher final : public Dispatcher {
public:
// The default options to use for |MojoCreateSharedBuffer()|. (Real uses
// should obtain this via |ValidateCreateOptions()| with a null |in_options|;
// this is exposed directly for testing convenience.)
static const MojoCreateSharedBufferOptions kDefaultCreateOptions;
// Validates and/or sets default options for |MojoCreateSharedBufferOptions|.
// 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)
// |MojoCreateSharedBufferOptions| and will be entirely overwritten on success
// (it may be partly overwritten on failure).
static MojoResult ValidateCreateOptions(
const MojoCreateSharedBufferOptions* in_options,
MojoCreateSharedBufferOptions* out_options);
// Static factory method: |validated_options| must be validated (obviously).
// On failure, |*result| will be left as-is.
// TODO(vtl): This should probably be made to return a scoped_refptr and have
// a MojoResult out parameter instead.
static MojoResult Create(
const MojoCreateSharedBufferOptions& validated_options,
NodeController* node_controller,
uint64_t num_bytes,
scoped_refptr<SharedBufferDispatcher>* result);
// Create a |SharedBufferDispatcher| from |shared_buffer|.
static MojoResult CreateFromPlatformSharedBuffer(
const scoped_refptr<PlatformSharedBuffer>& shared_buffer,
scoped_refptr<SharedBufferDispatcher>* result);
// The "opposite" of SerializeAndClose(). Called by Dispatcher::Deserialize().
static scoped_refptr<SharedBufferDispatcher> Deserialize(
const void* bytes,
size_t num_bytes,
const ports::PortName* ports,
size_t num_ports,
PlatformHandle* platform_handles,
size_t num_platform_handles);
// Passes the underlying platform shared buffer. This dispatcher must be
// closed after calling this function.
scoped_refptr<PlatformSharedBuffer> PassPlatformSharedBuffer();
// Dispatcher:
Type GetType() const override;
MojoResult Close() override;
MojoResult DuplicateBufferHandle(
const MojoDuplicateBufferHandleOptions* options,
scoped_refptr<Dispatcher>* new_dispatcher) override;
MojoResult MapBuffer(
uint64_t offset,
uint64_t num_bytes,
MojoMapBufferFlags flags,
std::unique_ptr<PlatformSharedBufferMapping>* mapping) override;
void StartSerialize(uint32_t* num_bytes,
uint32_t* num_ports,
uint32_t* num_platform_handles) override;
bool EndSerialize(void* destination,
ports::PortName* ports,
PlatformHandle* handles) override;
bool BeginTransit() override;
void CompleteTransitAndClose() override;
void CancelTransit() override;
private:
static scoped_refptr<SharedBufferDispatcher> CreateInternal(
scoped_refptr<PlatformSharedBuffer> shared_buffer) {
return make_scoped_refptr(
new SharedBufferDispatcher(std::move(shared_buffer)));
}
explicit SharedBufferDispatcher(
scoped_refptr<PlatformSharedBuffer> shared_buffer);
~SharedBufferDispatcher() override;
// Validates and/or sets default options for
// |MojoDuplicateBufferHandleOptions|. 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) |MojoDuplicateBufferHandleOptions| and will be
// entirely overwritten on success (it may be partly overwritten on failure).
static MojoResult ValidateDuplicateOptions(
const MojoDuplicateBufferHandleOptions* in_options,
MojoDuplicateBufferHandleOptions* out_options);
// Guards access to |shared_buffer_|.
base::Lock lock_;
bool in_transit_ = false;
// We keep a copy of the buffer's platform handle during transit so we can
// close it if something goes wrong.
ScopedPlatformHandle handle_for_transit_;
scoped_refptr<PlatformSharedBuffer> shared_buffer_;
DISALLOW_COPY_AND_ASSIGN(SharedBufferDispatcher);
};
} // namespace edk
} // namespace mojo
#endif // MOJO_EDK_SYSTEM_SHARED_BUFFER_DISPATCHER_H_
|
