-
Notifications
You must be signed in to change notification settings - Fork 4k
/
ActionGraphDump.java
280 lines (252 loc) · 12 KB
/
ActionGraphDump.java
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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
// Copyright 2018 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.actiongraph.v2;
import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Iterables;
import com.google.devtools.build.lib.actions.ActionAnalysisMetadata;
import com.google.devtools.build.lib.actions.ActionExecutionMetadata;
import com.google.devtools.build.lib.actions.ActionKeyContext;
import com.google.devtools.build.lib.actions.ActionOwner;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.actions.CommandAction;
import com.google.devtools.build.lib.actions.CommandLineExpansionException;
import com.google.devtools.build.lib.analysis.AnalysisProtosV2;
import com.google.devtools.build.lib.analysis.AspectValue;
import com.google.devtools.build.lib.analysis.ConfiguredTarget;
import com.google.devtools.build.lib.analysis.ConfiguredTargetValue;
import com.google.devtools.build.lib.analysis.actions.ParameterFileWriteAction;
import com.google.devtools.build.lib.analysis.actions.SpawnAction;
import com.google.devtools.build.lib.analysis.actions.Substitution;
import com.google.devtools.build.lib.analysis.actions.TemplateExpansionAction;
import com.google.devtools.build.lib.analysis.configuredtargets.RuleConfiguredTarget;
import com.google.devtools.build.lib.buildeventstream.BuildEvent;
import com.google.devtools.build.lib.collect.nestedset.NestedSet;
import com.google.devtools.build.lib.packages.AspectDescriptor;
import com.google.devtools.build.lib.query2.aquery.AqueryActionFilter;
import com.google.devtools.build.lib.query2.aquery.AqueryUtils;
import com.google.devtools.build.lib.skyframe.RuleConfiguredTargetValue;
import com.google.devtools.build.lib.util.Pair;
import java.io.IOException;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import javax.annotation.Nullable;
/**
* Encapsulates necessary functionality to dump the current skyframe state of the action graph to
* proto format.
*/
public class ActionGraphDump {
private final ActionKeyContext actionKeyContext = new ActionKeyContext();
private final Set<String> actionGraphTargets;
private final KnownArtifacts knownArtifacts;
private final KnownConfigurations knownConfigurations;
private final KnownNestedSets knownNestedSets;
private final KnownAspectDescriptors knownAspectDescriptors;
private final KnownTargets knownTargets;
@Nullable private final AqueryActionFilter actionFilters;
private final boolean includeActionCmdLine;
private final boolean includeArtifacts;
private final boolean includeParamFiles;
private final AqueryOutputHandler aqueryOutputHandler;
private Map<String, Iterable<String>> paramFileNameToContentMap;
public ActionGraphDump(
boolean includeActionCmdLine,
boolean includeArtifacts,
AqueryActionFilter actionFilters,
boolean includeParamFiles,
boolean deduplicateDepsets,
AqueryOutputHandler aqueryOutputHandler) {
this(
/* actionGraphTargets= */ ImmutableList.of("..."),
includeActionCmdLine,
includeArtifacts,
actionFilters,
includeParamFiles,
deduplicateDepsets,
aqueryOutputHandler);
}
public ActionGraphDump(
List<String> actionGraphTargets,
boolean includeActionCmdLine,
boolean includeArtifacts,
AqueryActionFilter actionFilters,
boolean includeParamFiles,
boolean deduplicateDepsets,
AqueryOutputHandler aqueryOutputHandler) {
this.actionGraphTargets = ImmutableSet.copyOf(actionGraphTargets);
this.includeActionCmdLine = includeActionCmdLine;
this.includeArtifacts = includeArtifacts;
this.actionFilters = actionFilters;
this.includeParamFiles = includeParamFiles;
this.aqueryOutputHandler = aqueryOutputHandler;
KnownRuleClassStrings knownRuleClassStrings = new KnownRuleClassStrings(aqueryOutputHandler);
knownArtifacts = new KnownArtifacts(aqueryOutputHandler);
knownConfigurations = new KnownConfigurations(aqueryOutputHandler);
knownNestedSets = new KnownNestedSets(aqueryOutputHandler, knownArtifacts, deduplicateDepsets);
knownAspectDescriptors = new KnownAspectDescriptors(aqueryOutputHandler);
knownTargets = new KnownTargets(aqueryOutputHandler, knownRuleClassStrings);
}
public ActionKeyContext getActionKeyContext() {
return actionKeyContext;
}
private boolean includeInActionGraph(String labelString) {
if (actionGraphTargets.size() == 1
&& Iterables.getOnlyElement(actionGraphTargets).equals("...")) {
return true;
}
return actionGraphTargets.contains(labelString);
}
private void dumpSingleAction(ConfiguredTarget configuredTarget, ActionAnalysisMetadata action)
throws CommandLineExpansionException, InterruptedException, IOException {
// Store the content of param files.
if (includeParamFiles && (action instanceof ParameterFileWriteAction)) {
ParameterFileWriteAction parameterFileWriteAction = (ParameterFileWriteAction) action;
Iterable<String> fileContent = parameterFileWriteAction.getArguments();
String paramFileExecPath = action.getPrimaryOutput().getExecPathString();
getParamFileNameToContentMap().put(paramFileExecPath, fileContent);
}
if (actionFilters != null && !AqueryUtils.matchesAqueryFilters(action, actionFilters)) {
return;
}
// Dereference any aliases that might be present.
configuredTarget = configuredTarget.getActual();
Preconditions.checkState(configuredTarget instanceof RuleConfiguredTarget);
Pair<String, String> targetIdentifier =
new Pair<>(
configuredTarget.getLabel().toString(),
((RuleConfiguredTarget) configuredTarget).getRuleClassString());
AnalysisProtosV2.Action.Builder actionBuilder =
AnalysisProtosV2.Action.newBuilder()
.setMnemonic(action.getMnemonic())
.setTargetId(knownTargets.dataToIdAndStreamOutputProto(targetIdentifier));
if (action instanceof ActionExecutionMetadata) {
ActionExecutionMetadata actionExecutionMetadata = (ActionExecutionMetadata) action;
actionBuilder
.setActionKey(
actionExecutionMetadata.getKey(getActionKeyContext(), /*artifactExpander=*/ null))
.setDiscoversInputs(actionExecutionMetadata.discoversInputs());
}
// store environment
if (action instanceof SpawnAction) {
SpawnAction spawnAction = (SpawnAction) action;
// TODO(twerth): This handles the fixed environment. We probably want to output the inherited
// environment as well.
Map<String, String> fixedEnvironment = spawnAction.getEnvironment().getFixedEnv();
for (Map.Entry<String, String> environmentVariable : fixedEnvironment.entrySet()) {
actionBuilder.addEnvironmentVariables(
AnalysisProtosV2.KeyValuePair.newBuilder()
.setKey(environmentVariable.getKey())
.setValue(environmentVariable.getValue())
.build());
}
}
if (includeActionCmdLine && action instanceof CommandAction) {
CommandAction commandAction = (CommandAction) action;
actionBuilder.addAllArguments(commandAction.getArguments());
}
// Include the content of param files in output.
if (includeParamFiles) {
// Assumption: if an Action takes a params file as an input, it will be used
// to provide params to the command.
for (Artifact input : action.getInputs().toList()) {
String inputFileExecPath = input.getExecPathString();
if (getParamFileNameToContentMap().containsKey(inputFileExecPath)) {
AnalysisProtosV2.ParamFile paramFile =
AnalysisProtosV2.ParamFile.newBuilder()
.setExecPath(inputFileExecPath)
.addAllArguments(getParamFileNameToContentMap().get(inputFileExecPath))
.build();
actionBuilder.addParamFiles(paramFile);
}
}
}
Map<String, String> executionInfo = action.getExecutionInfo();
for (Map.Entry<String, String> info : executionInfo.entrySet()) {
actionBuilder.addExecutionInfo(
AnalysisProtosV2.KeyValuePair.newBuilder()
.setKey(info.getKey())
.setValue(info.getValue()));
}
ActionOwner actionOwner = action.getOwner();
if (actionOwner != null) {
BuildEvent event = actionOwner.getConfiguration();
actionBuilder.setConfigurationId(knownConfigurations.dataToIdAndStreamOutputProto(event));
if (actionOwner.getExecutionPlatform() != null) {
actionBuilder.setExecutionPlatform(actionOwner.getExecutionPlatform().label().toString());
}
// Store aspects.
// Iterate through the aspect path and dump the aspect descriptors.
// In the case of aspect-on-aspect, AspectDescriptors are listed in topological order
// of the configured target graph.
// e.g. [A, B] would imply that aspect A is applied on top of aspect B.
for (AspectDescriptor aspectDescriptor : actionOwner.getAspectDescriptors().reverse()) {
actionBuilder.addAspectDescriptorIds(
knownAspectDescriptors.dataToIdAndStreamOutputProto(aspectDescriptor));
}
}
if (includeArtifacts) {
// Store inputs
NestedSet<Artifact> inputs = action.getInputs();
if (!inputs.isEmpty()) {
actionBuilder.addInputDepSetIds(knownNestedSets.dataToIdAndStreamOutputProto(inputs));
}
// store outputs
for (Artifact artifact : action.getOutputs()) {
actionBuilder.addOutputIds(knownArtifacts.dataToIdAndStreamOutputProto(artifact));
}
actionBuilder.setPrimaryOutputId(
knownArtifacts.dataToIdAndStreamOutputProto(action.getPrimaryOutput()));
}
if (action instanceof TemplateExpansionAction) {
actionBuilder.setTemplateContent(((TemplateExpansionAction) action).getTemplate().toString());
for (Substitution substitution : ((TemplateExpansionAction) action).getSubstitutions()) {
actionBuilder.addSubstitutions(
AnalysisProtosV2.KeyValuePair.newBuilder()
.setKey(substitution.getKey())
.setValue(substitution.getValue()));
}
}
aqueryOutputHandler.outputAction(actionBuilder.build());
}
public void dumpAspect(AspectValue aspectValue, ConfiguredTargetValue configuredTargetValue)
throws CommandLineExpansionException, InterruptedException, IOException {
ConfiguredTarget configuredTarget = configuredTargetValue.getConfiguredTarget();
if (!includeInActionGraph(configuredTarget.getLabel().toString())) {
return;
}
for (ActionAnalysisMetadata action : aspectValue.getActions()) {
dumpSingleAction(configuredTarget, action);
}
}
public void dumpConfiguredTarget(RuleConfiguredTargetValue configuredTargetValue)
throws CommandLineExpansionException, InterruptedException, IOException {
ConfiguredTarget configuredTarget = configuredTargetValue.getConfiguredTarget();
if (!includeInActionGraph(configuredTarget.getLabel().toString())) {
return;
}
for (ActionAnalysisMetadata action : configuredTargetValue.getActions()) {
dumpSingleAction(configuredTarget, action);
}
}
/** Lazy initialization of paramFileNameToContentMap. */
private Map<String, Iterable<String>> getParamFileNameToContentMap() {
if (paramFileNameToContentMap == null) {
paramFileNameToContentMap = new HashMap<>();
}
return paramFileNameToContentMap;
}
}