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
|
// Copyright 2017 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifdef UNSAFE_BUFFERS_BUILD
// TODO(crbug.com/351564777): Remove this and convert code to safer constructs.
#pragma allow_unsafe_buffers
#endif
#ifndef MOJO_CORE_PORTS_PORT_LOCKER_H_
#define MOJO_CORE_PORTS_PORT_LOCKER_H_
#include <stdint.h>
#include "base/auto_reset.h"
#include "base/memory/stack_allocated.h"
#include "mojo/core/ports/port_ref.h"
namespace mojo {
namespace core {
namespace ports {
class Port;
class PortRef;
// A helper which must be used to acquire individual Port locks. Any given
// thread may have at most one of these alive at any time. This ensures that
// when multiple ports are locked, they're locked in globally consistent order.
//
// Port locks are acquired upon construction of this object and released upon
// destruction.
class PortLocker {
STACK_ALLOCATED();
public:
// Constructs a PortLocker over a sequence of |num_ports| contiguous
// |PortRef*|s. The sequence may be reordered by this constructor, and upon
// return, all referenced ports' locks are held.
PortLocker(const PortRef** port_refs, size_t num_ports);
PortLocker(const PortLocker&) = delete;
PortLocker& operator=(const PortLocker&) = delete;
~PortLocker();
// Provides safe access to a PortRef's Port. Note that in release builds this
// doesn't do anything other than pass through to the private accessor on
// |port_ref|, but it does force callers to go through a PortLocker to get to
// the state, thus minimizing the likelihood that they'll go and do something
// bad.
Port* GetPort(const PortRef& port_ref) const {
#if DCHECK_IS_ON()
// Sanity check when DCHECK is on to ensure this is actually a port whose
// lock is held by this PortLocker.
bool is_port_locked = false;
for (size_t i = 0; i < num_ports_ && !is_port_locked; ++i)
if (port_refs_[i]->port() == port_ref.port())
is_port_locked = true;
DCHECK(is_port_locked);
#endif
return port_ref.port();
}
// A helper which can be used to verify that no Port locks are held on the
// current thread. In non-DCHECK builds this is a no-op.
#if DCHECK_IS_ON()
static void AssertNoPortsLockedOnCurrentThread();
#else
static void AssertNoPortsLockedOnCurrentThread() {}
#endif
private:
#if DCHECK_IS_ON()
const base::AutoReset<const PortLocker*> resetter_;
#endif
const PortRef** const port_refs_;
const size_t num_ports_;
};
// Convenience wrapper for a PortLocker that locks a single port.
class COMPONENT_EXPORT(MOJO_CORE_PORTS) SinglePortLocker {
STACK_ALLOCATED();
public:
explicit SinglePortLocker(const PortRef* port_ref);
SinglePortLocker(const SinglePortLocker&) = delete;
SinglePortLocker& operator=(const SinglePortLocker&) = delete;
~SinglePortLocker();
Port* port() const { return locker_.GetPort(*port_ref_); }
private:
const PortRef* port_ref_;
PortLocker locker_;
};
} // namespace ports
} // namespace core
} // namespace mojo
#endif // MOJO_CORE_PORTS_PORT_LOCKER_H_
|
