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
|
// Copyright 2014 Google Inc. 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.annotations.VisibleForTesting;
import com.google.common.base.Preconditions;
import com.google.common.base.Supplier;
import com.google.common.base.Suppliers;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.devtools.build.lib.actions.Action;
import com.google.devtools.build.lib.analysis.BlazeDirectories;
import com.google.devtools.build.lib.analysis.TopLevelArtifactContext;
import com.google.devtools.build.lib.analysis.WorkspaceStatusAction;
import com.google.devtools.build.lib.analysis.buildinfo.BuildInfoFactory;
import com.google.devtools.build.lib.analysis.buildinfo.BuildInfoFactory.BuildInfoKey;
import com.google.devtools.build.lib.packages.RuleVisibility;
import com.google.devtools.build.lib.pkgcache.PathPackageLocator;
import com.google.devtools.build.lib.skyframe.SkyframeActionExecutor.ConflictException;
import com.google.devtools.build.skyframe.Injectable;
import com.google.devtools.build.skyframe.SkyFunction;
import com.google.devtools.build.skyframe.SkyKey;
import com.google.devtools.build.skyframe.SkyValue;
import java.util.Map;
import java.util.UUID;
import javax.annotation.Nullable;
/**
* A value that represents something computed outside of the skyframe framework. These values are
* "precomputed" from skyframe's perspective and so the graph needs to be prepopulated with them
* (e.g. via injection).
*/
public final class PrecomputedValue implements SkyValue {
/**
* An externally-injected precomputed value. Exists so that modules can inject precomputed values
* into Skyframe's graph.
*
* @see com.google.devtools.build.lib.runtime.BlazeModule#getPrecomputedSkyframeValues
*/
public static final class Injected {
private final Precomputed<?> precomputed;
private final Supplier<? extends Object> supplier;
private Injected(Precomputed<?> precomputed, Supplier<? extends Object> supplier) {
this.precomputed = precomputed;
this.supplier = supplier;
}
void inject(Injectable injectable) {
injectable.inject(ImmutableMap.of(precomputed.key, new PrecomputedValue(supplier.get())));
}
}
public static <T> Injected injected(Precomputed<T> precomputed, Supplier<T> value) {
return new Injected(precomputed, value);
}
public static <T> Injected injected(Precomputed<T> precomputed, T value) {
return new Injected(precomputed, Suppliers.ofInstance(value));
}
public static final Precomputed<String> DEFAULTS_PACKAGE_CONTENTS =
new Precomputed<>(new SkyKey(SkyFunctions.PRECOMPUTED, "default_pkg"));
public static final Precomputed<RuleVisibility> DEFAULT_VISIBILITY =
new Precomputed<>(new SkyKey(SkyFunctions.PRECOMPUTED, "default_visibility"));
static final Precomputed<UUID> BUILD_ID =
new Precomputed<>(new SkyKey(SkyFunctions.PRECOMPUTED, "build_id"));
static final Precomputed<WorkspaceStatusAction> WORKSPACE_STATUS_KEY =
new Precomputed<>(new SkyKey(SkyFunctions.PRECOMPUTED, "workspace_status_action"));
static final Precomputed<ImmutableList <Action>> COVERAGE_REPORT_KEY =
new Precomputed<>(new SkyKey(SkyFunctions.PRECOMPUTED, "coverage_report_actions"));
static final Precomputed<TopLevelArtifactContext> TOP_LEVEL_CONTEXT =
new Precomputed<>(new SkyKey(SkyFunctions.PRECOMPUTED, "top_level_context"));
public static final Precomputed<Map<BuildInfoKey, BuildInfoFactory>> BUILD_INFO_FACTORIES =
new Precomputed<>(new SkyKey(SkyFunctions.PRECOMPUTED, "build_info_factories"));
static final Precomputed<BlazeDirectories> BLAZE_DIRECTORIES =
new Precomputed<>(new SkyKey(SkyFunctions.PRECOMPUTED, "blaze_directories"));
static final Precomputed<ImmutableMap<Action, ConflictException>> BAD_ACTIONS =
new Precomputed<>(new SkyKey(SkyFunctions.PRECOMPUTED, "bad_actions"));
public static final Precomputed<PathPackageLocator> PATH_PACKAGE_LOCATOR =
new Precomputed<>(new SkyKey(SkyFunctions.PRECOMPUTED, "path_package_locator"));
private final Object value;
public PrecomputedValue(Object value) {
this.value = Preconditions.checkNotNull(value);
}
/**
* Returns the value of the variable.
*/
public Object get() {
return value;
}
@Override
public int hashCode() {
return value.hashCode();
}
@Override
public boolean equals(Object obj) {
if (!(obj instanceof PrecomputedValue)) {
return false;
}
PrecomputedValue other = (PrecomputedValue) obj;
return value.equals(other.value);
}
@Override
public String toString() {
return "<BuildVariable " + value + ">";
}
public static final void dependOnBuildId(SkyFunction.Environment env) {
BUILD_ID.get(env);
}
/**
* A helper object corresponding to a variable in Skyframe.
*
* <p>Instances do not have internal state.
*/
public static final class Precomputed<T> {
private final SkyKey key;
public Precomputed(SkyKey key) {
this.key = key;
}
@VisibleForTesting
SkyKey getKeyForTesting() {
return key;
}
/**
* Retrieves the value of this variable from Skyframe.
*
* <p>If the value was not set, an exception will be raised.
*/
@Nullable
@SuppressWarnings("unchecked")
public T get(SkyFunction.Environment env) {
PrecomputedValue value = (PrecomputedValue) env.getValue(key);
if (value == null) {
return null;
}
return (T) value.get();
}
/**
* Injects a new variable value.
*/
public void set(Injectable injectable, T value) {
injectable.inject(ImmutableMap.of(key, new PrecomputedValue(value)));
}
}
}
|
