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
|
// 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.skyframe;
import com.google.common.annotations.VisibleForTesting;
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.actions.Artifact;
import com.google.devtools.build.lib.actions.ArtifactOwner;
import com.google.devtools.build.lib.actions.MutableActionGraph.ActionConflictException;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.skyframe.SkyFunctionName;
import com.google.devtools.build.skyframe.SkyKey;
import com.google.devtools.build.skyframe.SkyValue;
import java.util.Map;
/**
* Base class for all values which can provide the generating action of an artifact. The primary
* instance of such lookup values is {@link 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 ImmutableMap<Artifact, Action> generatingActionMap;
private static Map<Artifact, Action> filterSharedActionsAndThrowRuntimeIfConflict(
Iterable<Action> actions) {
try {
return ConfiguredTargetFunction.filterSharedActionsAndThrowIfConflict(actions);
} catch (ActionConflictException e) {
// Programming bug.
throw new IllegalStateException(e);
}
}
ActionLookupValue(Iterable<Action> actions) {
this(filterSharedActionsAndThrowRuntimeIfConflict(actions));
}
ActionLookupValue(Action action) {
this(ImmutableList.of(action));
}
ActionLookupValue(Map<Artifact, Action> generatingActionMap) {
this.generatingActionMap = ImmutableMap.copyOf(generatingActionMap);
}
public Action getGeneratingAction(Artifact artifact) {
return generatingActionMap.get(artifact);
}
/** To be used only when checking consistency of the action graph -- not by other values. */
ImmutableMap<Artifact, Action> getMapForConsistencyCheck() {
return generatingActionMap;
}
/**
* To be used only when setting the owners of deserialized artifacts whose owners were unknown at
* creation time -- not by other callers or values.
*/
Iterable<Action> getActionsForFindingArtifactOwners() {
return generatingActionMap.values();
}
@VisibleForTesting
public static SkyKey key(ActionLookupKey ownerKey) {
return ownerKey.getSkyKey();
}
/**
* ArtifactOwner is not a SkyKey, but we wish to convert any ArtifactOwner into a SkyKey as
* simply as possible. To that end, all subclasses of ActionLookupValue "own" artifacts with
* ArtifactOwners that are subclasses of ActionLookupKey. This allows callers to easily find the
* value key, while remaining agnostic to what ActionLookupValues actually exist.
*
* <p>The methods of this class should only be called by {@link ActionLookupValue#key}.
*/
public abstract static class ActionLookupKey implements ArtifactOwner {
@Override
public Label getLabel() {
return null;
}
/**
* Subclasses must override this to specify their specific value type, unless they override
* {@link #getSkyKey}, in which case they are free not to implement this method.
*/
abstract SkyFunctionName getType();
/**
* Prefer {@link ActionLookupValue#key} to calling this method directly.
*
* <p>Subclasses may override if the value key contents should not be the key itself.
*/
SkyKey getSkyKey() {
return new SkyKey(getType(), this);
}
}
}
|