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
|
// 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.lib.skyframe;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Maps;
import com.google.devtools.build.lib.events.Event;
import com.google.devtools.build.lib.events.EventHandler;
import com.google.devtools.build.lib.skyframe.DiffAwareness.View;
import com.google.devtools.build.lib.vfs.ModifiedFileSet;
import com.google.devtools.build.lib.vfs.Root;
import com.google.devtools.common.options.OptionsClassProvider;
import java.util.Map;
import java.util.logging.Logger;
import javax.annotation.Nullable;
/**
* Helper class to make it easier to correctly use the {@link DiffAwareness} interface in a
* sequential manner.
*/
public final class DiffAwarenessManager {
private static final Logger logger = Logger.getLogger(DiffAwarenessManager.class.getName());
// The manager attempts to instantiate these in the order in which they are passed to the
// constructor; this is critical in the case where a factory always succeeds.
private final ImmutableList<? extends DiffAwareness.Factory> diffAwarenessFactories;
private Map<Root, DiffAwarenessState> currentDiffAwarenessStates = Maps.newHashMap();
public DiffAwarenessManager(Iterable<? extends DiffAwareness.Factory> diffAwarenessFactories) {
this.diffAwarenessFactories = ImmutableList.copyOf(diffAwarenessFactories);
}
private static class DiffAwarenessState {
private final DiffAwareness diffAwareness;
/**
* The {@link View} that should be the baseline for the next {@link #getDiff} call, or
* {@code null} if the next {@link #getDiff} will be the first incremental one.
*/
@Nullable
private View baselineView;
private DiffAwarenessState(DiffAwareness diffAwareness, @Nullable View baselineView) {
this.diffAwareness = diffAwareness;
this.baselineView = baselineView;
}
}
/** Reset internal {@link DiffAwareness} state. */
public void reset() {
for (DiffAwarenessState diffAwarenessState : currentDiffAwarenessStates.values()) {
diffAwarenessState.diffAwareness.close();
}
currentDiffAwarenessStates.clear();
}
/** A set of modified files that should be marked as processed. */
public interface ProcessableModifiedFileSet {
ModifiedFileSet getModifiedFileSet();
/**
* This should be called when the changes have been noted. Otherwise, the result from the next
* call to {@link #getDiff} will be from the baseline of the old, unprocessed, diff.
*/
void markProcessed();
}
/**
* Gets the set of changed files since the last call with this path entry, or {@code
* ModifiedFileSet.EVERYTHING_MODIFIED} if this is the first such call.
*/
public ProcessableModifiedFileSet getDiff(
EventHandler eventHandler, Root pathEntry, OptionsClassProvider options) {
DiffAwarenessState diffAwarenessState = maybeGetDiffAwarenessState(pathEntry);
if (diffAwarenessState == null) {
return BrokenProcessableModifiedFileSet.INSTANCE;
}
DiffAwareness diffAwareness = diffAwarenessState.diffAwareness;
View newView;
try {
newView = diffAwareness.getCurrentView(options);
} catch (BrokenDiffAwarenessException e) {
handleBrokenDiffAwareness(eventHandler, pathEntry, e);
return BrokenProcessableModifiedFileSet.INSTANCE;
}
View baselineView = diffAwarenessState.baselineView;
if (baselineView == null) {
logger.info("Initial baseline view for " + pathEntry + " is " + newView);
diffAwarenessState.baselineView = newView;
return BrokenProcessableModifiedFileSet.INSTANCE;
}
ModifiedFileSet diff;
logger.info(
"About to compute diff between " + baselineView + " and " + newView + " for " + pathEntry);
try {
diff = diffAwareness.getDiff(baselineView, newView);
} catch (BrokenDiffAwarenessException e) {
handleBrokenDiffAwareness(eventHandler, pathEntry, e);
return BrokenProcessableModifiedFileSet.INSTANCE;
} catch (IncompatibleViewException e) {
throw new IllegalStateException(pathEntry + " " + baselineView + " " + newView, e);
}
ProcessableModifiedFileSet result = new ProcessableModifiedFileSetImpl(diff, pathEntry,
newView);
return result;
}
private void handleBrokenDiffAwareness(
EventHandler eventHandler, Root pathEntry, BrokenDiffAwarenessException e) {
currentDiffAwarenessStates.remove(pathEntry);
logger.info("Broken diff awareness for " + pathEntry + ": " + e);
eventHandler.handle(Event.warn(e.getMessage() + "... temporarily falling back to manually "
+ "checking files for changes"));
}
/**
* Returns the current diff awareness for the given path entry, or a fresh one if there is no
* current one, or otherwise {@code null} if no factory could make a fresh one.
*/
@Nullable
private DiffAwarenessState maybeGetDiffAwarenessState(Root pathEntry) {
DiffAwarenessState diffAwarenessState = currentDiffAwarenessStates.get(pathEntry);
if (diffAwarenessState != null) {
return diffAwarenessState;
}
for (DiffAwareness.Factory factory : diffAwarenessFactories) {
DiffAwareness newDiffAwareness = factory.maybeCreate(pathEntry);
if (newDiffAwareness != null) {
logger.info(
"Using " + newDiffAwareness.name() + " DiffAwareness strategy for " + pathEntry);
diffAwarenessState = new DiffAwarenessState(newDiffAwareness, /*baselineView=*/null);
currentDiffAwarenessStates.put(pathEntry, diffAwarenessState);
return diffAwarenessState;
}
}
return null;
}
private class ProcessableModifiedFileSetImpl implements ProcessableModifiedFileSet {
private final ModifiedFileSet modifiedFileSet;
private final Root pathEntry;
/**
* The {@link View} that should be the baseline on the next {@link #getDiff} call after
* {@link #markProcessed} is called.
*/
private final View nextView;
private ProcessableModifiedFileSetImpl(
ModifiedFileSet modifiedFileSet, Root pathEntry, View nextView) {
this.modifiedFileSet = modifiedFileSet;
this.pathEntry = pathEntry;
this.nextView = nextView;
}
@Override
public ModifiedFileSet getModifiedFileSet() {
return modifiedFileSet;
}
@Override
public void markProcessed() {
DiffAwarenessState diffAwarenessState = currentDiffAwarenessStates.get(pathEntry);
if (diffAwarenessState != null) {
diffAwarenessState.baselineView = nextView;
}
}
}
private static class BrokenProcessableModifiedFileSet implements ProcessableModifiedFileSet {
private static final BrokenProcessableModifiedFileSet INSTANCE =
new BrokenProcessableModifiedFileSet();
@Override
public ModifiedFileSet getModifiedFileSet() {
return ModifiedFileSet.EVERYTHING_MODIFIED;
}
@Override
public void markProcessed() {
}
}
}
|
