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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
|
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*-
* vim: set ts=8 sts=2 et sw=2 tw=80:
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
/*
* Iterators for various data structures.
*/
#ifndef gc_PublicIterators_h
#define gc_PublicIterators_h
#include "mozilla/Maybe.h"
#include "jstypes.h"
#include "gc/GCRuntime.h"
#include "gc/IteratorUtils.h"
#include "gc/Zone.h"
#include "vm/Compartment.h"
#include "vm/Runtime.h"
struct JSRuntime;
namespace JS {
class JS_PUBLIC_API Realm;
}
namespace js {
// Accessing the atoms zone can be dangerous because helper threads may be
// accessing it concurrently to the main thread, so it's better to skip the
// atoms zone when iterating over zones. If you need to iterate over the atoms
// zone, consider using AutoLockAllAtoms.
enum ZoneSelector { WithAtoms, SkipAtoms };
// Iterate over all zones in the runtime apart from the atoms zone and those
// which may be in use by parse threads.
class NonAtomZonesIter {
gc::AutoEnterIteration iterMarker;
JS::Zone** it;
JS::Zone** end;
public:
explicit NonAtomZonesIter(gc::GCRuntime* gc)
: iterMarker(gc), it(gc->zones().begin()), end(gc->zones().end()) {
skipHelperThreadZones();
}
explicit NonAtomZonesIter(JSRuntime* rt) : NonAtomZonesIter(&rt->gc) {}
bool done() const { return it == end; }
void next() {
MOZ_ASSERT(!done());
it++;
skipHelperThreadZones();
}
void skipHelperThreadZones() {
while (!done() && get()->usedByHelperThread()) {
it++;
}
}
JS::Zone* get() const {
MOZ_ASSERT(!done());
return *it;
}
operator JS::Zone*() const { return get(); }
JS::Zone* operator->() const { return get(); }
};
// Iterate over all zones in the runtime, except those which may be in use by
// parse threads. May or may not include the atoms zone.
class ZonesIter {
JS::Zone* atomsZone;
NonAtomZonesIter otherZones;
public:
ZonesIter(gc::GCRuntime* gc, ZoneSelector selector)
: atomsZone(selector == WithAtoms ? gc->atomsZone.ref() : nullptr),
otherZones(gc) {}
ZonesIter(JSRuntime* rt, ZoneSelector selector)
: ZonesIter(&rt->gc, selector) {}
bool done() const { return !atomsZone && otherZones.done(); }
JS::Zone* get() const {
MOZ_ASSERT(!done());
return atomsZone ? atomsZone : otherZones.get();
}
void next() {
MOZ_ASSERT(!done());
if (atomsZone) {
atomsZone = nullptr;
return;
}
otherZones.next();
}
operator JS::Zone*() const { return get(); }
JS::Zone* operator->() const { return get(); }
};
// Iterate over all zones in the runtime, except those which may be in use by
// parse threads.
class AllZonesIter : public ZonesIter {
public:
explicit AllZonesIter(gc::GCRuntime* gc) : ZonesIter(gc, WithAtoms) {}
explicit AllZonesIter(JSRuntime* rt) : AllZonesIter(&rt->gc) {}
};
struct CompartmentsInZoneIter {
explicit CompartmentsInZoneIter(JS::Zone* zone) : zone(zone) {
it = zone->compartments().begin();
}
bool done() const {
MOZ_ASSERT(it);
return it < zone->compartments().begin() ||
it >= zone->compartments().end();
}
void next() {
MOZ_ASSERT(!done());
it++;
}
JS::Compartment* get() const {
MOZ_ASSERT(it);
return *it;
}
operator JS::Compartment*() const { return get(); }
JS::Compartment* operator->() const { return get(); }
private:
JS::Zone* zone;
JS::Compartment** it;
};
class RealmsInCompartmentIter {
JS::Compartment* comp;
JS::Realm** it;
public:
explicit RealmsInCompartmentIter(JS::Compartment* comp) : comp(comp) {
it = comp->realms().begin();
MOZ_ASSERT(!done(), "Compartments must have at least one realm");
}
bool done() const {
MOZ_ASSERT(it);
return it < comp->realms().begin() || it >= comp->realms().end();
}
void next() {
MOZ_ASSERT(!done());
it++;
}
JS::Realm* get() const {
MOZ_ASSERT(!done());
return *it;
}
operator JS::Realm*() const { return get(); }
JS::Realm* operator->() const { return get(); }
};
using RealmsInZoneIter =
NestedIterator<CompartmentsInZoneIter, RealmsInCompartmentIter>;
// This iterator iterates over all the compartments or realms in a given set of
// zones. The set of zones is determined by iterating ZoneIterT. The set of
// compartments or realms is determined by InnerIterT.
template <class ZonesIterT, class InnerIterT>
class CompartmentsOrRealmsIterT
: public NestedIterator<ZonesIterT, InnerIterT> {
gc::AutoEnterIteration iterMarker;
public:
explicit CompartmentsOrRealmsIterT(gc::GCRuntime* gc)
: NestedIterator<ZonesIterT, InnerIterT>(gc), iterMarker(gc) {}
explicit CompartmentsOrRealmsIterT(JSRuntime* rt)
: CompartmentsOrRealmsIterT(&rt->gc) {}
};
using CompartmentsIter =
CompartmentsOrRealmsIterT<NonAtomZonesIter, CompartmentsInZoneIter>;
using RealmsIter =
CompartmentsOrRealmsIterT<NonAtomZonesIter, RealmsInZoneIter>;
} // namespace js
#endif // gc_PublicIterators_h
|
