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
|
// 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.devtools.build.lib.analysis.config.BuildConfiguration;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.cmdline.PackageIdentifier;
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.concurrent.ThreadSafety.Immutable;
import com.google.devtools.build.lib.concurrent.ThreadSafety.ThreadSafe;
import com.google.devtools.build.lib.packages.NoSuchTargetException;
import com.google.devtools.build.skyframe.SkyKey;
import com.google.devtools.build.skyframe.SkyValue;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.util.Set;
import javax.annotation.Nullable;
/**
* A <i>transitive</i> target reference that, when built in skyframe, loads the entire
* transitive closure of a target.
*
* This will probably be unnecessary once other refactorings occur throughout the codebase
* which make loading/analysis interleaving more feasible, or we will migrate "blaze query" to
* use this to evaluate its Target graph.
*/
@Immutable
@ThreadSafe
public class TransitiveTargetValue implements SkyValue {
// Non-final for serialization purposes.
private NestedSet<PackageIdentifier> transitiveSuccessfulPkgs;
private NestedSet<PackageIdentifier> transitiveUnsuccessfulPkgs;
private NestedSet<Label> transitiveTargets;
@Nullable private NestedSet<Label> transitiveRootCauses;
@Nullable private NoSuchTargetException errorLoadingTarget;
private NestedSet<Class<? extends BuildConfiguration.Fragment>> transitiveConfigFragments;
private TransitiveTargetValue(NestedSet<PackageIdentifier> transitiveSuccessfulPkgs,
NestedSet<PackageIdentifier> transitiveUnsuccessfulPkgs, NestedSet<Label> transitiveTargets,
@Nullable NestedSet<Label> transitiveRootCauses,
@Nullable NoSuchTargetException errorLoadingTarget,
NestedSet<Class<? extends BuildConfiguration.Fragment>> transitiveConfigFragments) {
this.transitiveSuccessfulPkgs = transitiveSuccessfulPkgs;
this.transitiveUnsuccessfulPkgs = transitiveUnsuccessfulPkgs;
this.transitiveTargets = transitiveTargets;
this.transitiveRootCauses = transitiveRootCauses;
this.errorLoadingTarget = errorLoadingTarget;
this.transitiveConfigFragments = transitiveConfigFragments;
}
private void writeObject(ObjectOutputStream out) throws IOException {
// It helps to flatten the transitiveSuccessfulPkgs nested set as it has lots of duplicates.
Set<PackageIdentifier> successfulPkgs = transitiveSuccessfulPkgs.toSet();
out.writeInt(successfulPkgs.size());
for (PackageIdentifier pkg : successfulPkgs) {
out.writeObject(pkg);
}
out.writeObject(transitiveUnsuccessfulPkgs);
// Deliberately do not write out transitiveTargets. There is a lot of those and they drive
// serialization costs through the roof, both in terms of space and of time.
// TODO(bazel-team): Deal with this properly once we have efficient serialization of NestedSets.
out.writeObject(transitiveRootCauses);
out.writeObject(errorLoadingTarget);
out.writeObject(transitiveConfigFragments);
}
@SuppressWarnings("unchecked")
private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException {
int successfulPkgCount = in.readInt();
NestedSetBuilder<PackageIdentifier> pkgs = NestedSetBuilder.stableOrder();
for (int i = 0; i < successfulPkgCount; i++) {
pkgs.add((PackageIdentifier) in.readObject());
}
transitiveSuccessfulPkgs = pkgs.build();
transitiveUnsuccessfulPkgs = (NestedSet<PackageIdentifier>) in.readObject();
// TODO(bazel-team): Deal with transitiveTargets properly.
transitiveTargets = NestedSetBuilder.emptySet(Order.STABLE_ORDER);
transitiveRootCauses = (NestedSet<Label>) in.readObject();
errorLoadingTarget = (NoSuchTargetException) in.readObject();
transitiveConfigFragments =
(NestedSet<Class<? extends BuildConfiguration.Fragment>>) in.readObject();
}
static TransitiveTargetValue unsuccessfulTransitiveLoading(
NestedSet<PackageIdentifier> transitiveSuccessfulPkgs,
NestedSet<PackageIdentifier> transitiveUnsuccessfulPkgs, NestedSet<Label> transitiveTargets,
NestedSet<Label> rootCauses, @Nullable NoSuchTargetException errorLoadingTarget,
NestedSet<Class<? extends BuildConfiguration.Fragment>> transitiveConfigFragments) {
return new TransitiveTargetValue(transitiveSuccessfulPkgs, transitiveUnsuccessfulPkgs,
transitiveTargets, rootCauses, errorLoadingTarget, transitiveConfigFragments);
}
static TransitiveTargetValue successfulTransitiveLoading(
NestedSet<PackageIdentifier> transitiveSuccessfulPkgs,
NestedSet<PackageIdentifier> transitiveUnsuccessfulPkgs,
NestedSet<Label> transitiveTargets,
NestedSet<Class<? extends BuildConfiguration.Fragment>> transitiveConfigFragments) {
return new TransitiveTargetValue(transitiveSuccessfulPkgs, transitiveUnsuccessfulPkgs,
transitiveTargets, null, null, transitiveConfigFragments);
}
/** Returns the error, if any, from loading the target. */
@Nullable
public NoSuchTargetException getErrorLoadingTarget() {
return errorLoadingTarget;
}
/** Returns the packages that were transitively successfully loaded. */
public NestedSet<PackageIdentifier> getTransitiveSuccessfulPackages() {
return transitiveSuccessfulPkgs;
}
/** Returns the packages that were transitively successfully loaded. */
public NestedSet<PackageIdentifier> getTransitiveUnsuccessfulPackages() {
return transitiveUnsuccessfulPkgs;
}
/** Returns the targets that were transitively loaded. */
public NestedSet<Label> getTransitiveTargets() {
return transitiveTargets;
}
/** Returns the root causes, if any, of why targets weren't loaded. */
@Nullable
public NestedSet<Label> getTransitiveRootCauses() {
return transitiveRootCauses;
}
/**
* Returns the set of {@link
* com.google.devtools.build.lib.analysis.config.BuildConfiguration.Fragment} classes required to
* configure a rule's transitive closure. These are used to instantiate the right {@link
* ConfigurationFragmentValue} instances for a rule's {@link BuildConfigurationValue}.
*
* <p>This provides the basis for rule-scoped configurations. For example, Java-related build
* flags have nothing to do with C++. So changing a Java flag shouldn't invalidate a C++ rule
* (unless it has transitive dependencies on other Java rules). Likewise, a C++ rule shouldn't
* fail because the Java configuration doesn't recognize the chosen architecture.
*
* <p>The general principle is that a rule can be influenced by the configuration parameters it
* directly uses and the configuration parameters its transitive dependencies use (since it
* reads its dependencies as part of analysis). So we need to 1) determine which configuration
* fragments provide these parameters, 2) load those fragments, then 3) create a configuration
* from them to feed the rule's configured target. This provides the first step.
*
* <p>See
* {@link com.google.devtools.build.lib.packages.RuleClass.Builder#requiresConfigurationFragments}
*/
NestedSet<Class<? extends BuildConfiguration.Fragment>> getTransitiveConfigFragments() {
return transitiveConfigFragments;
}
@ThreadSafe
public static SkyKey key(Label label) {
return new SkyKey(SkyFunctions.TRANSITIVE_TARGET, label);
}
}
|
