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
|
// 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.base.MoreObjects;
import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Iterables;
import com.google.common.collect.Lists;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import javax.annotation.Nullable;
/**
* The result of a Skyframe {@link Evaluator#eval} call. Will contain all the
* successfully evaluated values, retrievable through {@link #get}. As well, the {@link ErrorInfo}
* for the first value that failed to evaluate (in the non-keep-going case), or any remaining values
* that failed to evaluate (in the keep-going case) will be retrievable.
*
* <p>A node can never be successfully evaluated and fail to evaluate. Thus, if {@link #get} returns
* non-null for some key, there is no stored error for that key, and vice versa.
*
* @param <T> The type of the values that the caller has requested.
*/
public class EvaluationResult<T extends SkyValue> {
private final boolean hasError;
private final Map<SkyKey, T> resultMap;
private final Map<SkyKey, ErrorInfo> errorMap;
private final WalkableGraph walkableGraph;
/**
* Constructor for the "completed" case. Used only by {@link Builder}.
*/
private EvaluationResult(Map<SkyKey, T> result, Map<SkyKey, ErrorInfo> errorMap,
boolean hasError, @Nullable WalkableGraph walkableGraph) {
Preconditions.checkState(errorMap.isEmpty() || hasError,
"result=%s, errorMap=%s", result, errorMap);
this.resultMap = Preconditions.checkNotNull(result);
this.errorMap = Preconditions.checkNotNull(errorMap);
this.hasError = hasError;
this.walkableGraph = walkableGraph;
}
/**
* Get a successfully evaluated value.
*/
public T get(SkyKey key) {
Preconditions.checkNotNull(resultMap, key);
return resultMap.get(key);
}
/**
* @return Whether or not the eval successfully evaluated all requested values. Note that this
* may return true even if all values returned are available in get(). This happens if a top-level
* value depends transitively on some value that recovered from a {@link SkyFunctionException}.
*/
public boolean hasError() {
return hasError;
}
/**
* @return All successfully evaluated {@link SkyValue}s.
*/
public Collection<T> values() {
return Collections.unmodifiableCollection(resultMap.values());
}
/**
* Returns {@link Map} of {@link SkyKey}s to {@link ErrorInfo}. Note that currently some
* of the returned SkyKeys may not be the ones requested by the user. Moreover, the SkyKey
* is not necessarily the cause of the error -- it is just the value that was being evaluated
* when the error was discovered. For the cause of the error, use
* {@link ErrorInfo#getRootCauses()} on each ErrorInfo.
*/
public Map<SkyKey, ErrorInfo> errorMap() {
return ImmutableMap.copyOf(errorMap);
}
/**
* @param key {@link SkyKey} to get {@link ErrorInfo} for.
*/
public ErrorInfo getError(SkyKey key) {
return Preconditions.checkNotNull(errorMap, key).get(key);
}
/**
* @return Names of all values that were successfully evaluated. This collection is disjoint from
* the keys in {@link #errorMap}.
*/
public <S> Collection<? extends S> keyNames() {
return this.<S>getNames(resultMap.keySet());
}
@SuppressWarnings("unchecked")
private <S> Collection<? extends S> getNames(Collection<SkyKey> keys) {
Collection<S> names = Lists.newArrayListWithCapacity(keys.size());
for (SkyKey key : keys) {
names.add((S) key.argument());
}
return names;
}
@Nullable
public WalkableGraph getWalkableGraph() {
return walkableGraph;
}
/**
* Returns some error info. Convenience method equivalent to
* Iterables.getFirst({@link #errorMap()}, null).getValue().
*/
public ErrorInfo getError() {
return Iterables.getFirst(errorMap.entrySet(), null).getValue();
}
@Override
public String toString() {
return MoreObjects.toStringHelper(this)
.add("hasError", hasError)
.add("errorMap", errorMap)
.add("resultMap", resultMap)
.toString();
}
public static <T extends SkyValue> Builder<T> builder() {
return new Builder<>();
}
/**
* Builder for {@link EvaluationResult}.
*
* <p>This is intended only for use in alternative {@code MemoizingEvaluator} implementations.
*/
public static class Builder<T extends SkyValue> {
private final Map<SkyKey, T> result = new HashMap<>();
private final Map<SkyKey, ErrorInfo> errors = new HashMap<>();
private boolean hasError = false;
private WalkableGraph walkableGraph = null;
/** Adds a value to the result. An error for this key must not already be present. */
@SuppressWarnings("unchecked")
public Builder<T> addResult(SkyKey key, SkyValue value) {
result.put(key, Preconditions.checkNotNull((T) value, key));
Preconditions.checkState(
!errors.containsKey(key), "%s in both result and errors: %s %s", value, errors);
return this;
}
/** Adds an error to the result. A successful value for this key must not already be present. */
public Builder<T> addError(SkyKey key, ErrorInfo error) {
errors.put(key, Preconditions.checkNotNull(error, key));
Preconditions.checkState(
!result.containsKey(key), "%s in both result and errors: %s %s", error, result);
return this;
}
public Builder<T> setWalkableGraph(WalkableGraph walkableGraph) {
this.walkableGraph = walkableGraph;
return this;
}
public Builder<T> mergeFrom(EvaluationResult<T> otherResult) {
result.putAll(otherResult.resultMap);
errors.putAll(otherResult.errorMap);
hasError |= otherResult.hasError;
return this;
}
public EvaluationResult<T> build() {
return new EvaluationResult<>(result, errors, hasError, walkableGraph);
}
public void setHasError(boolean hasError) {
this.hasError = hasError;
}
}
}
|
