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
|
// 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.analysis.extra;
import com.google.common.base.Function;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Sets;
import com.google.devtools.build.lib.actions.AbstractAction;
import com.google.devtools.build.lib.actions.Action;
import com.google.devtools.build.lib.actions.ActionEnvironment;
import com.google.devtools.build.lib.actions.ActionExecutionContext;
import com.google.devtools.build.lib.actions.ActionExecutionException;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.actions.CompositeRunfilesSupplier;
import com.google.devtools.build.lib.actions.RunfilesSupplier;
import com.google.devtools.build.lib.actions.SpawnActionContext;
import com.google.devtools.build.lib.analysis.actions.CommandLine;
import com.google.devtools.build.lib.analysis.actions.SpawnAction;
import com.google.devtools.build.lib.collect.nestedset.NestedSet;
import com.google.devtools.build.lib.collect.nestedset.NestedSetBuilder;
import com.google.devtools.build.lib.collect.nestedset.Order;
import com.google.devtools.build.lib.util.Preconditions;
import com.google.devtools.build.lib.vfs.FileSystemUtils;
import java.io.IOException;
import java.util.Collection;
import java.util.Map;
import javax.annotation.Nullable;
/**
* Action used by extra_action rules to create an action that shadows an existing action. Runs a
* command-line using {@link SpawnActionContext} for executions.
*/
public final class ExtraAction extends SpawnAction {
private final Action shadowedAction;
private final boolean createDummyOutput;
private final ImmutableSet<Artifact> extraActionInputs;
/**
* A long way to say (ExtraAction xa) -> xa.getShadowedAction().
*/
public static final Function<ExtraAction, Action> GET_SHADOWED_ACTION =
new Function<ExtraAction, Action>() {
@Nullable
@Override
public Action apply(@Nullable ExtraAction extraAction) {
return extraAction != null ? extraAction.getShadowedAction() : null;
}
};
ExtraAction(
ImmutableSet<Artifact> extraActionInputs,
RunfilesSupplier runfilesSupplier,
Collection<Artifact> outputs,
Action shadowedAction,
boolean createDummyOutput,
CommandLine argv,
ActionEnvironment env,
Map<String, String> executionInfo,
CharSequence progressMessage,
String mnemonic) {
super(
shadowedAction.getOwner(),
ImmutableList.<Artifact>of(),
createInputs(shadowedAction.getInputs(), ImmutableList.<Artifact>of(), extraActionInputs),
outputs,
AbstractAction.DEFAULT_RESOURCE_SET,
argv,
false,
env,
ImmutableMap.copyOf(executionInfo),
progressMessage,
new CompositeRunfilesSupplier(shadowedAction.getRunfilesSupplier(), runfilesSupplier),
mnemonic,
false,
null);
this.shadowedAction = shadowedAction;
this.createDummyOutput = createDummyOutput;
this.extraActionInputs = extraActionInputs;
if (createDummyOutput) {
// Expecting just a single dummy file in the outputs.
Preconditions.checkArgument(outputs.size() == 1, outputs);
}
}
@Override
public boolean discoversInputs() {
return shadowedAction.discoversInputs();
}
@Nullable
@Override
public Iterable<Artifact> discoverInputs(ActionExecutionContext actionExecutionContext)
throws ActionExecutionException, InterruptedException {
Preconditions.checkState(discoversInputs(), this);
// We depend on the outputs of actions doing input discovery and they should know their inputs
// after having been executed
Preconditions.checkState(shadowedAction.inputsDiscovered());
// We need to update our inputs to take account of any additional
// inputs the shadowed action may need to do its work.
Iterable<Artifact> oldInputs = getInputs();
updateInputs(
createInputs(
shadowedAction.getInputs(),
shadowedAction.getInputFilesForExtraAction(actionExecutionContext),
extraActionInputs));
return Sets.<Artifact>difference(
ImmutableSet.<Artifact>copyOf(getInputs()), ImmutableSet.<Artifact>copyOf(oldInputs));
}
private static NestedSet<Artifact> createInputs(
Iterable<Artifact> shadowedActionInputs,
Iterable<Artifact> inputFilesForExtraAction,
ImmutableSet<Artifact> extraActionInputs) {
NestedSetBuilder<Artifact> result = new NestedSetBuilder<>(Order.STABLE_ORDER);
for (Iterable<Artifact> inputSet : ImmutableList.of(
shadowedActionInputs, inputFilesForExtraAction)) {
if (inputSet instanceof NestedSet) {
result.addTransitive((NestedSet<Artifact>) inputSet);
} else {
result.addAll(inputSet);
}
}
return result.addAll(extraActionInputs).build();
}
@Override
public Iterable<Artifact> getAllowedDerivedInputs() {
return shadowedAction.getAllowedDerivedInputs();
}
/**
* @InheritDoc
*
* This method calls in to {@link AbstractAction#getInputFilesForExtraAction} and
* {@link Action#getExtraActionInfo} of the action being shadowed from the thread executing this
* ExtraAction. It assumes these methods are safe to call from a different thread than the thread
* responsible for the execution of the action being shadowed.
*/
@Override
public void execute(ActionExecutionContext actionExecutionContext)
throws ActionExecutionException, InterruptedException {
// PHASE 2: execution of extra_action.
super.execute(actionExecutionContext);
// PHASE 3: create dummy output.
// If the user didn't specify output, we need to create dummy output
// to make blaze schedule this action.
if (createDummyOutput) {
for (Artifact output : getOutputs()) {
try {
FileSystemUtils.touchFile(output.getPath());
} catch (IOException e) {
throw new ActionExecutionException(e.getMessage(), e, this, false);
}
}
}
}
/**
* Returns the action this extra action is 'shadowing'.
*/
public Action getShadowedAction() {
return shadowedAction;
}
}
|
