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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
// 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.base.Preconditions;
import com.google.common.collect.Interner;
import com.google.devtools.build.lib.cmdline.PackageIdentifier;
import com.google.devtools.build.lib.cmdline.PackageIdentifierCodec;
import com.google.devtools.build.lib.concurrent.BlazeInterners;
import com.google.devtools.build.lib.concurrent.ThreadSafety.ThreadSafe;
import com.google.devtools.build.lib.skyframe.serialization.ObjectCodec;
import com.google.devtools.build.lib.skyframe.serialization.SerializationException;
import com.google.devtools.build.lib.skyframe.serialization.strings.StringCodecs;
import com.google.devtools.build.lib.util.StringCanonicalizer;
import com.google.devtools.build.lib.vfs.PathFragment;
import com.google.devtools.build.lib.vfs.Root;
import com.google.devtools.build.skyframe.SkyFunctionName;
import com.google.devtools.build.skyframe.SkyKey;
import com.google.protobuf.CodedInputStream;
import com.google.protobuf.CodedOutputStream;
import java.io.IOException;
/**
* A descriptor for a glob request, used as the {@link SkyKey} for {@link GlobFunction}.
*
* <p>{@code subdir} must be empty or point to an existing directory.</p>
*
* <p>{@code pattern} must be valid, as indicated by {@code UnixGlob#checkPatternForError}.
*/
@ThreadSafe
public final class GlobDescriptor implements SkyKey {
private static final Interner<GlobDescriptor> interner = BlazeInterners.newWeakInterner();
/** Creates and returns a new {@link ObjectCodec} for {@link GlobDescriptor}s. */
public static ObjectCodec<GlobDescriptor> getCodec(ObjectCodec<Root> rootCodec) {
return new GlobDescriptorCodec(rootCodec);
}
/**
* Returns interned instance based on the parameters.
*
* @param packageId the name of the owner package (must be an existing package)
* @param packageRoot the package root of {@code packageId}
* @param subdir the subdirectory being looked at (must exist and must be a directory. It's
* assumed that there are no other packages between {@code packageName} and {@code subdir}.
* @param pattern a valid glob pattern
* @param excludeDirs true if directories should be excluded from results
*/
public static GlobDescriptor create(
PackageIdentifier packageId,
Root packageRoot,
PathFragment subdir,
String pattern,
boolean excludeDirs) {
return interner.intern(
new GlobDescriptor(packageId, packageRoot, subdir, pattern, excludeDirs));
}
private final PackageIdentifier packageId;
private final Root packageRoot;
private final PathFragment subdir;
private final String pattern;
private final boolean excludeDirs;
private GlobDescriptor(
PackageIdentifier packageId,
Root packageRoot,
PathFragment subdir,
String pattern,
boolean excludeDirs) {
this.packageId = Preconditions.checkNotNull(packageId);
this.packageRoot = Preconditions.checkNotNull(packageRoot);
this.subdir = Preconditions.checkNotNull(subdir);
this.pattern = Preconditions.checkNotNull(StringCanonicalizer.intern(pattern));
this.excludeDirs = excludeDirs;
}
@Override
public String toString() {
return String.format(
"<GlobDescriptor packageName=%s packageRoot=%s subdir=%s pattern=%s excludeDirs=%s>",
packageId, packageRoot, subdir, pattern, excludeDirs);
}
/**
* Returns the package that "owns" this glob.
*
* <p>The glob evaluation code ensures that the boundaries of this package are not crossed.
*/
public PackageIdentifier getPackageId() {
return packageId;
}
/** Returns the package root of {@code getPackageId()}. */
public Root getPackageRoot() {
return packageRoot;
}
/**
* Returns the subdirectory of the package under consideration.
*/
public PathFragment getSubdir() {
return subdir;
}
/**
* Returns the glob pattern under consideration. May contain wildcards.
*
* <p>As the glob evaluator traverses deeper into the file tree, components are added at the
* beginning of {@code subdir} and removed from the beginning of {@code pattern}.
*/
public String getPattern() {
return pattern;
}
/**
* Returns true if directories should be excluded from results.
*/
public boolean excludeDirs() {
return excludeDirs;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (!(obj instanceof GlobDescriptor)) {
return false;
}
GlobDescriptor other = (GlobDescriptor) obj;
return packageId.equals(other.packageId) && packageRoot.equals(other.packageRoot)
&& subdir.equals(other.subdir) && pattern.equals(other.pattern)
&& excludeDirs == other.excludeDirs;
}
@Override
public int hashCode() {
// Generated instead of Objects.hashCode to avoid intermediate array required for latter.
final int prime = 31;
int result = 1;
result = prime * result + (excludeDirs ? 1231 : 1237);
result = prime * result + packageId.hashCode();
result = prime * result + packageRoot.hashCode();
result = prime * result + pattern.hashCode();
result = prime * result + subdir.hashCode();
return result;
}
@Override
public SkyFunctionName functionName() {
return SkyFunctions.GLOB;
}
private static class GlobDescriptorCodec implements ObjectCodec<GlobDescriptor> {
private final PackageIdentifierCodec packageIdCodec = new PackageIdentifierCodec();
private final ObjectCodec<Root> rootCodec;
private final ObjectCodec<String> stringCodec = StringCodecs.asciiOptimized();
private GlobDescriptorCodec(ObjectCodec<Root> rootCodec) {
this.rootCodec = rootCodec;
}
@Override
public Class<GlobDescriptor> getEncodedClass() {
return GlobDescriptor.class;
}
@Override
public void serialize(GlobDescriptor globDesc, CodedOutputStream codedOut)
throws IOException, SerializationException {
packageIdCodec.serialize(globDesc.getPackageId(), codedOut);
rootCodec.serialize(globDesc.getPackageRoot(), codedOut);
PathFragment.CODEC.serialize(globDesc.getSubdir(), codedOut);
stringCodec.serialize(globDesc.getPattern(), codedOut);
codedOut.writeBoolNoTag(globDesc.excludeDirs());
}
@Override
public GlobDescriptor deserialize(CodedInputStream codedIn)
throws SerializationException, IOException {
PackageIdentifier packageId = packageIdCodec.deserialize(codedIn);
Root packageRoot = rootCodec.deserialize(codedIn);
PathFragment pathFragment = PathFragment.CODEC.deserialize(codedIn);
String pattern = stringCodec.deserialize(codedIn);
boolean excludeDirs = codedIn.readBool();
return GlobDescriptor.create(packageId, packageRoot, pathFragment, pattern, excludeDirs);
}
}
}
|
