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.actions;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.MoreObjects;
import com.google.common.base.MoreObjects.ToStringHelper;
import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Maps;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.concurrent.ThreadSafety.ThreadSafe;
import com.google.devtools.build.lib.skyframe.serialization.autocodec.AutoCodec.VisibleForSerialization;
import com.google.devtools.build.skyframe.SkyKey;
import com.google.devtools.build.skyframe.SkyValue;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import javax.annotation.Nullable;
/**
* Base class for all values which can provide the generating action of an artifact. The primary
* instance of such lookup values is {@code ConfiguredTargetValue}. Values that hold the generating
* actions of target completion values and build info artifacts also fall into this category.
*/
public class ActionLookupValue implements SkyValue {
protected final List<ActionAnalysisMetadata> actions;
@VisibleForSerialization protected final ImmutableMap<Artifact, Integer> generatingActionIndex;
protected ActionLookupValue(
ActionAnalysisMetadata action,
boolean removeActionAfterEvaluation) {
this(Actions.GeneratingActions.fromSingleAction(action), removeActionAfterEvaluation);
}
@VisibleForTesting
public ActionLookupValue(
Actions.GeneratingActions generatingActions, boolean removeActionsAfterEvaluation) {
this(
removeActionsAfterEvaluation
? new ArrayList<>(generatingActions.getActions())
: ImmutableList.copyOf(generatingActions.getActions()),
generatingActions.getGeneratingActionIndex());
}
protected ActionLookupValue(
List<ActionAnalysisMetadata> actions, ImmutableMap<Artifact, Integer> generatingActionIndex) {
this.actions = actions;
this.generatingActionIndex = generatingActionIndex;
}
/**
* Returns the action that generates {@code artifact}, if known to this value, or null. This
* method should be avoided. Call it only when the action is really needed, and it is known to be
* present, either because the execution phase has not started, or because {@link
* Action#canRemoveAfterExecution} is known to be false for the action being requested.
*/
@Nullable
public ActionAnalysisMetadata getGeneratingActionDangerousReadJavadoc(Artifact artifact) {
Integer actionIndex = getGeneratingActionIndex(artifact);
if (actionIndex == null) {
return null;
}
return getActionAnalysisMetadata(actionIndex);
}
/**
* Returns the index of the action that generates {@code artifact} in this value, or null if this
* value does not have a generating action for this artifact. The index together with the key for
* this {@link ActionLookupValue} uniquely identifies the action.
*
* <p>Unlike {@link #getAction}, this may be called after action execution.
*/
@Nullable
public Integer getGeneratingActionIndex(Artifact artifact) {
return generatingActionIndex.get(artifact);
}
/**
* Returns the {@link Action} with index {@code index} in this value. Never null. Should only be
* called during action execution by {@code ArtifactFunction} and {@code ActionExecutionFunction}
* -- after an action has executed, calling this with its index may crash.
*/
@SuppressWarnings("unchecked") // We test to make sure it's an Action.
public Action getAction(int index) {
ActionAnalysisMetadata result = getActionAnalysisMetadata(index);
Preconditions.checkState(result instanceof Action, "Not action: %s %s %s", result, index, this);
return (Action) result;
}
private ActionAnalysisMetadata getActionAnalysisMetadata(int index) {
return Preconditions.checkNotNull(actions.get(index), "null action: %s %s", index, this);
}
public ActionTemplate<?> getActionTemplate(int index) {
ActionAnalysisMetadata result = getActionAnalysisMetadata(index);
Preconditions.checkState(
result instanceof ActionTemplate, "Not action template: %s %s %s", result, index, this);
return (ActionTemplate<?>) result;
}
/**
* Returns if the action at {@code index} is an {@link ActionTemplate} so that tree artifacts can
* take the proper action.
*/
public boolean isActionTemplate(int index) {
return actions.get(index) instanceof ActionTemplate;
}
/** To be used only when checking consistency of the action graph -- not by other values. */
public Map<Artifact, ActionAnalysisMetadata> getMapForConsistencyCheck() {
return getMapForConsistencyCheck(generatingActionIndex, actions);
}
protected ToStringHelper getStringHelper() {
return MoreObjects.toStringHelper(this)
.add("actions", actions)
.add("generatingActionIndex", generatingActionIndex);
}
@Override
public String toString() {
return getStringHelper().toString();
}
public int getNumActions() {
return actions.size();
}
public static Map<Artifact, ActionAnalysisMetadata> getMapForConsistencyCheck(
Map<Artifact, Integer> generatingActionIndex,
final List<? extends ActionAnalysisMetadata> actions) {
return Maps.transformValues(generatingActionIndex, actions::get);
}
/**
* If this object was initialized with {@code removeActionsAfterEvaluation} and {@link
* Action#canRemoveAfterExecution()} is true for {@code action}, then remove this action from this
* object's index as a memory-saving measure. The {@code artifact -> index} mapping remains
* intact, so this action's execution value can still be addressed by its inputs.
*/
@ThreadSafe
public void actionEvaluated(int actionIndex, Action action) {
if (!action.canRemoveAfterExecution()) {
return;
}
if (actions instanceof ArrayList) {
// This method may concurrently mutate an ArrayList, which is unsafe on its face. However,
// ArrayList mutation on different indices that does not affect the size of the ArrayList is
// safe, and that is what does this code does.
ArrayList<ActionAnalysisMetadata> actionArrayList =
(ArrayList<ActionAnalysisMetadata>) actions;
ActionAnalysisMetadata oldAction = actionArrayList.set(actionIndex, null);
Preconditions.checkState(
action.equals(oldAction), "Not same: %s %s %s %s", action, oldAction, this, actionIndex);
}
}
/**
* All subclasses of ActionLookupValue "own" artifacts with {@link ArtifactOwner}s that are
* subclasses of ActionLookupKey. This allows callers to easily find the value key, while
* remaining agnostic to what ActionLookupValues actually exist.
*/
public abstract static class ActionLookupKey implements ArtifactOwner, SkyKey {
@Override
public Label getLabel() {
return null;
}
}
}
|
