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
|
// Copyright 2015 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.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Iterables;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.cmdline.PackageIdentifier;
import com.google.devtools.build.lib.cmdline.RepositoryName;
import com.google.devtools.build.lib.collect.nestedset.NestedSetBuilder;
import com.google.devtools.build.lib.events.Event;
import com.google.devtools.build.lib.events.EventHandler;
import com.google.devtools.build.lib.packages.BuildFileContainsErrorsException;
import com.google.devtools.build.lib.packages.NoSuchPackageException;
import com.google.devtools.build.lib.packages.NoSuchTargetException;
import com.google.devtools.build.lib.packages.Package;
import com.google.devtools.build.lib.packages.Target;
import com.google.devtools.build.lib.pkgcache.PathPackageLocator;
import com.google.devtools.build.lib.pkgcache.RecursivePackageProvider;
import com.google.devtools.build.lib.rules.repository.RepositoryDirectoryValue;
import com.google.devtools.build.lib.util.Preconditions;
import com.google.devtools.build.lib.vfs.Path;
import com.google.devtools.build.lib.vfs.PathFragment;
import com.google.devtools.build.lib.vfs.RootedPath;
import com.google.devtools.build.skyframe.SkyFunction.Environment;
import com.google.devtools.build.skyframe.SkyKey;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
/**
* A {@link RecursivePackageProvider} backed by an {@link Environment}. Its methods
* may throw {@link MissingDepException} if the package values this depends on haven't been
* calculated and added to its environment.
*/
public final class EnvironmentBackedRecursivePackageProvider implements RecursivePackageProvider {
private final Environment env;
public EnvironmentBackedRecursivePackageProvider(Environment env) {
this.env = env;
}
@Override
public Package getPackage(EventHandler eventHandler, PackageIdentifier packageName)
throws NoSuchPackageException, MissingDepException {
SkyKey pkgKey = PackageValue.key(packageName);
PackageValue pkgValue =
(PackageValue) env.getValueOrThrow(pkgKey, NoSuchPackageException.class);
if (pkgValue == null) {
throw new MissingDepException();
}
Package pkg = pkgValue.getPackage();
if (pkg.containsErrors()) {
// If this is a nokeep_going build, we must shut the build down by throwing an exception. To
// do that, we request a node that will throw an exception, and then try to catch it and
// continue. This gives the framework notification to shut down the build if it should.
try {
env.getValueOrThrow(
PackageErrorFunction.key(packageName), BuildFileContainsErrorsException.class);
Preconditions.checkState(env.valuesMissing(), "Should have thrown for %s", packageName);
throw new MissingDepException();
} catch (BuildFileContainsErrorsException e) {
// Expected.
}
}
return pkgValue.getPackage();
}
@Override
public Map<PackageIdentifier, Package> bulkGetPackages(EventHandler eventHandler,
Iterable<PackageIdentifier> pkgIds)
throws NoSuchPackageException, InterruptedException {
ImmutableMap.Builder<PackageIdentifier, Package> builder = ImmutableMap.builder();
for (PackageIdentifier pkgId : pkgIds) {
builder.put(pkgId, getPackage(eventHandler, pkgId));
}
return builder.build();
}
@Override
public boolean isPackage(EventHandler eventHandler, PackageIdentifier packageId)
throws MissingDepException {
SkyKey packageLookupKey = PackageLookupValue.key(packageId);
try {
PackageLookupValue packageLookupValue =
(PackageLookupValue) env.getValueOrThrow(packageLookupKey, NoSuchPackageException.class,
InconsistentFilesystemException.class);
if (packageLookupValue == null) {
throw new MissingDepException();
}
return packageLookupValue.packageExists();
} catch (NoSuchPackageException | InconsistentFilesystemException e) {
eventHandler.handle(Event.error(e.getMessage()));
return false;
}
}
@Override
public Iterable<PathFragment> getPackagesUnderDirectory(
RepositoryName repository, PathFragment directory,
ImmutableSet<PathFragment> excludedSubdirectories)
throws MissingDepException {
PathPackageLocator packageLocator = PrecomputedValue.PATH_PACKAGE_LOCATOR.get(env);
if (packageLocator == null) {
throw new MissingDepException();
}
List<Path> roots = new ArrayList<>();
if (repository.isMain()) {
roots.addAll(packageLocator.getPathEntries());
} else {
RepositoryDirectoryValue repositoryValue =
(RepositoryDirectoryValue) env.getValue(RepositoryDirectoryValue.key(repository));
if (repositoryValue == null) {
throw new MissingDepException();
}
roots.add(repositoryValue.getPath());
}
NestedSetBuilder<String> packageNames = NestedSetBuilder.stableOrder();
for (Path root : roots) {
PathFragment.checkAllPathsAreUnder(excludedSubdirectories, directory);
RecursivePkgValue lookup = (RecursivePkgValue) env.getValue(RecursivePkgValue.key(
repository, RootedPath.toRootedPath(root, directory), excludedSubdirectories));
if (lookup == null) {
// Typically a null value from Environment.getValue(k) means that either the key k is
// missing a dependency or an exception was thrown during evaluation of k. Here, if this
// getValue call returns null in a keep_going build, it can only mean a missing dependency
// because RecursivePkgFunction#compute never throws.
// In a nokeep_going build, a lower-level exception that RecursivePkgFunction ignored may
// bubble up to here, but we ignore it and depend on the top-level caller to be flexible in
// the exception types it can accept.
throw new MissingDepException();
}
packageNames.addTransitive(lookup.getPackages());
}
// TODO(bazel-team): Make RecursivePkgValue return NestedSet<PathFragment> so this transform is
// unnecessary.
return Iterables.transform(packageNames.build(), PathFragment.TO_PATH_FRAGMENT);
}
@Override
public Target getTarget(EventHandler eventHandler, Label label) throws NoSuchPackageException,
NoSuchTargetException, MissingDepException {
return getPackage(eventHandler, label.getPackageIdentifier()).getTarget(label.getName());
}
/**
* Indicates that a missing dependency is needed before target parsing can proceed. Currently
* used only in skyframe to notify the framework of missing dependencies. Caught by the compute
* method in {@link com.google.devtools.build.lib.skyframe.TargetPatternFunction}, which then
* returns null in accordance with the skyframe missing dependency policy.
*/
static class MissingDepException extends RuntimeException {
}
}
|
