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
|
// 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.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.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.UnixGlob;
import com.google.devtools.build.skyframe.SkyKey;
import com.google.devtools.build.skyframe.SkyValue;
/** A value corresponding to a glob. */
@Immutable
@ThreadSafe
public final class GlobValue implements SkyValue {
public static final GlobValue EMPTY = new GlobValue(
NestedSetBuilder.<PathFragment>emptySet(Order.STABLE_ORDER));
private final NestedSet<PathFragment> matches;
/**
* Create a GlobValue wrapping {@code matches}. {@code matches} must have order
* {@link Order#STABLE_ORDER}.
*/
public GlobValue(NestedSet<PathFragment> matches) {
this.matches = Preconditions.checkNotNull(matches);
Preconditions.checkState(matches.getOrder() == Order.STABLE_ORDER,
"Only STABLE_ORDER is supported, but got %s", matches.getOrder());
}
/**
* Returns glob matches. The matches will be in a deterministic but unspecified order. If a
* particular order is required, the returned iterable should be sorted.
*/
public NestedSet<PathFragment> getMatches() {
return matches;
}
@Override
public boolean equals(Object other) {
if (other == this) {
return true;
}
if (!(other instanceof GlobValue)) {
return false;
}
// shallowEquals() may fail to detect that two equivalent (according to toString())
// NestedSets are equal, but will always detect when two NestedSets are different.
// This makes this implementation of equals() overly strict, but we only call this
// method when doing change pruning, which can accept false negatives.
return getMatches().shallowEquals(((GlobValue) other).getMatches());
}
@Override
public int hashCode() {
return matches.shallowHashCode();
}
/**
* Constructs a {@link SkyKey} for a glob lookup. {@code packageName} is assumed to be an
* existing package. Trying to glob into a non-package is undefined behavior.
*
* @throws InvalidGlobPatternException if the pattern is not valid.
*/
@ThreadSafe
public static SkyKey key(PackageIdentifier packageId, Path packageRoot, String pattern,
boolean excludeDirs, PathFragment subdir) throws InvalidGlobPatternException {
if (pattern.indexOf('?') != -1) {
throw new InvalidGlobPatternException(pattern, "wildcard ? forbidden");
}
String error = UnixGlob.checkPatternForError(pattern);
if (error != null) {
throw new InvalidGlobPatternException(pattern, error);
}
return internalKey(packageId, packageRoot, subdir, pattern, excludeDirs);
}
/**
* Constructs a {@link SkyKey} for a glob lookup.
*
* <p>Do not use outside {@code GlobFunction}.
*/
@ThreadSafe
static SkyKey internalKey(PackageIdentifier packageId, Path packageRoot, PathFragment subdir,
String pattern, boolean excludeDirs) {
return SkyKey.create(
SkyFunctions.GLOB,
new GlobDescriptor(packageId, packageRoot, subdir, pattern, excludeDirs));
}
/**
* Constructs a {@link SkyKey} for a glob lookup.
*
* <p>Do not use outside {@code GlobFunction}.
*/
@ThreadSafe
static SkyKey internalKey(GlobDescriptor glob, String subdirName) {
return internalKey(glob.packageId, glob.packageRoot, glob.subdir.getRelative(subdirName),
glob.pattern, glob.excludeDirs);
}
/**
* An exception that indicates that a glob pattern is syntactically invalid.
*/
@ThreadSafe
public static final class InvalidGlobPatternException extends Exception {
private final String pattern;
InvalidGlobPatternException(String pattern, String error) {
super(error);
this.pattern = pattern;
}
@Override
public String toString() {
return String.format("invalid glob pattern '%s': %s", pattern, getMessage());
}
}
}
|
