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
198
199
200
201
202
203
|
// Copyright 2014 The Bazel Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.devtools.build.skyframe;
import com.google.common.truth.Truth;
import com.google.devtools.build.lib.concurrent.ThreadSafety.ThreadSafe;
import java.util.ArrayList;
import java.util.Set;
/**
* Class that allows clients to be notified on each access of the graph. Clients can simply track
* accesses, or they can block to achieve desired synchronization. Clients should call
* {@link #assertNoExceptions} at the end of tests in case exceptions were swallowed in async
* threads.
*/
public class NotifyingInMemoryGraph extends InMemoryGraph {
private final Listener graphListener;
private final ArrayList<Exception> unexpectedExceptions = new ArrayList<>();
public NotifyingInMemoryGraph(Listener graphListener) {
this.graphListener = new ErrorRecordingDelegatingListener(graphListener);
}
@Override
public NodeEntry createIfAbsent(SkyKey key) {
graphListener.accept(key, EventType.CREATE_IF_ABSENT, Order.BEFORE, null);
NodeEntry newval = getEntry(key);
NodeEntry oldval = getNodeMap().putIfAbsent(key, newval);
return oldval == null ? newval : oldval;
}
/**
* Should be called at end of test (ideally in an {@code @After} method) to assert that no
* exceptions were thrown during calls to the listener.
*/
public void assertNoExceptions() {
Truth.assertThat(unexpectedExceptions).isEmpty();
}
// Subclasses should override if they wish to subclass NotifyingNodeEntry.
protected NotifyingNodeEntry getEntry(SkyKey key) {
return new NotifyingNodeEntry(key);
}
/** Receiver to be informed when an event for a given key occurs. */
public interface Listener {
@ThreadSafe
void accept(SkyKey key, EventType type, Order order, Object context);
public static Listener NULL_LISTENER = new Listener() {
@Override
public void accept(SkyKey key, EventType type, Order order, Object context) {}
};
}
private class ErrorRecordingDelegatingListener implements Listener {
private final Listener delegate;
private ErrorRecordingDelegatingListener(Listener delegate) {
this.delegate = delegate;
}
@Override
public void accept(SkyKey key, EventType type, Order order, Object context) {
try {
delegate.accept(key, type, order, context);
} catch (Exception e) {
unexpectedExceptions.add(e);
throw e;
}
}
}
/**
* Graph/value entry events that the receiver can be informed of. When writing tests, feel free to
* add additional events here if needed.
*/
public enum EventType {
CREATE_IF_ABSENT,
ADD_REVERSE_DEP,
REMOVE_REVERSE_DEP,
SIGNAL,
SET_VALUE,
MARK_DIRTY,
MARK_CLEAN,
IS_CHANGED,
GET_VALUE_WITH_METADATA,
IS_DIRTY,
IS_READY,
CHECK_IF_DONE,
GET_ALL_DIRECT_DEPS_FOR_INCOMPLETE_NODE
}
public enum Order {
BEFORE,
AFTER
}
protected class NotifyingNodeEntry extends InMemoryNodeEntry {
private final SkyKey myKey;
protected NotifyingNodeEntry(SkyKey key) {
myKey = key;
}
// Note that these methods are not synchronized. Necessary synchronization happens when calling
// the super() methods.
@Override
public DependencyState addReverseDepAndCheckIfDone(SkyKey reverseDep) {
graphListener.accept(myKey, EventType.ADD_REVERSE_DEP, Order.BEFORE, reverseDep);
DependencyState result = super.addReverseDepAndCheckIfDone(reverseDep);
graphListener.accept(myKey, EventType.ADD_REVERSE_DEP, Order.AFTER, reverseDep);
return result;
}
@Override
public synchronized void removeReverseDep(SkyKey reverseDep) {
graphListener.accept(myKey, EventType.REMOVE_REVERSE_DEP, Order.BEFORE, reverseDep);
super.removeReverseDep(reverseDep);
graphListener.accept(myKey, EventType.REMOVE_REVERSE_DEP, Order.AFTER, reverseDep);
}
@Override
public boolean signalDep(Version childVersion) {
graphListener.accept(myKey, EventType.SIGNAL, Order.BEFORE, childVersion);
boolean result = super.signalDep(childVersion);
graphListener.accept(myKey, EventType.SIGNAL, Order.AFTER, childVersion);
return result;
}
@Override
public Set<SkyKey> setValue(SkyValue value, Version version) {
graphListener.accept(myKey, EventType.SET_VALUE, Order.BEFORE, value);
Set<SkyKey> result = super.setValue(value, version);
graphListener.accept(myKey, EventType.SET_VALUE, Order.AFTER, value);
return result;
}
@Override
public boolean markDirty(boolean isChanged) {
graphListener.accept(myKey, EventType.MARK_DIRTY, Order.BEFORE, isChanged);
boolean result = super.markDirty(isChanged);
graphListener.accept(myKey, EventType.MARK_DIRTY, Order.AFTER, isChanged);
return result;
}
@Override
public Set<SkyKey> markClean() {
graphListener.accept(myKey, EventType.MARK_CLEAN, Order.BEFORE, this);
Set<SkyKey> result = super.markClean();
graphListener.accept(myKey, EventType.MARK_CLEAN, Order.AFTER, this);
return result;
}
@Override
public boolean isChanged() {
graphListener.accept(myKey, EventType.IS_CHANGED, Order.BEFORE, this);
return super.isChanged();
}
@Override
public boolean isDirty() {
graphListener.accept(myKey, EventType.IS_DIRTY, Order.BEFORE, this);
return super.isDirty();
}
@Override
public synchronized boolean isReady() {
graphListener.accept(myKey, EventType.IS_READY, Order.BEFORE, this);
return super.isReady();
}
@Override
public SkyValue getValueMaybeWithMetadata() {
graphListener.accept(myKey, EventType.GET_VALUE_WITH_METADATA, Order.BEFORE, this);
return super.getValueMaybeWithMetadata();
}
@Override
public synchronized DependencyState checkIfDoneForDirtyReverseDep(SkyKey reverseDep) {
graphListener.accept(myKey, EventType.CHECK_IF_DONE, Order.BEFORE, reverseDep);
return super.checkIfDoneForDirtyReverseDep(reverseDep);
}
@Override
public synchronized Iterable<SkyKey> getAllDirectDepsForIncompleteNode() {
graphListener.accept(
myKey, EventType.GET_ALL_DIRECT_DEPS_FOR_INCOMPLETE_NODE, Order.BEFORE, this);
return super.getAllDirectDepsForIncompleteNode();
}
}
}
|
