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
|
// 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.concurrent.ThreadSafety.Immutable;
import com.google.devtools.build.lib.concurrent.ThreadSafety.ThreadSafe;
import com.google.devtools.build.lib.vfs.Dirent;
import com.google.devtools.build.lib.vfs.RootedPath;
import com.google.devtools.build.skyframe.SkyKey;
import com.google.devtools.build.skyframe.SkyValue;
import java.util.Objects;
/**
* A value that represents the list of files in a given directory under a given package path root.
* Anything in Skyframe that cares about the contents of a directory should have a dependency
* on the corresponding {@link DirectoryListingValue}.
*
* <p>This value only depends on the FileValue corresponding to the directory. In particular, note
* that it does not depend on any of its child entries.
*
* <p>Note that symlinks in dirents are <b>not</b> expanded. Dependents of the value are responsible
* for expanding the symlink entries by referring to FileValues that correspond to the symlinks.
* This is a little onerous, but correct: we do not need to reread the directory when a symlink
* inside it changes, therefore this value should not be invalidated in that case.
*/
@Immutable
@ThreadSafe
abstract class DirectoryListingValue implements SkyValue {
/**
* Returns the directory entries for this directory, in a stable order.
*
* <p>Symlinks are not expanded.
*/
public abstract Iterable<Dirent> getDirents();
/**
* Returns a {@link SkyKey} for getting the directory entries of the given directory. The
* given path is assumed to be an existing directory (e.g. via {@link FileValue#isDirectory} or
* from a directory listing on its parent directory).
*/
@ThreadSafe
static SkyKey key(RootedPath directoryUnderRoot) {
return new SkyKey(SkyFunctions.DIRECTORY_LISTING, directoryUnderRoot);
}
static DirectoryListingValue value(RootedPath dirRootedPath, FileValue dirFileValue,
DirectoryListingStateValue realDirectoryListingStateValue) {
return dirFileValue.realRootedPath().equals(dirRootedPath)
? new RegularDirectoryListingValue(realDirectoryListingStateValue)
: new DifferentRealPathDirectoryListingValue(dirFileValue.realRootedPath(),
realDirectoryListingStateValue);
}
@ThreadSafe
private static final class RegularDirectoryListingValue extends DirectoryListingValue {
private final DirectoryListingStateValue directoryListingStateValue;
private RegularDirectoryListingValue(DirectoryListingStateValue directoryListingStateValue) {
this.directoryListingStateValue = directoryListingStateValue;
}
@Override
public Iterable<Dirent> getDirents() {
return directoryListingStateValue.getDirents();
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (!(obj instanceof RegularDirectoryListingValue)) {
return false;
}
RegularDirectoryListingValue other = (RegularDirectoryListingValue) obj;
return directoryListingStateValue.equals(other.directoryListingStateValue);
}
@Override
public int hashCode() {
return directoryListingStateValue.hashCode();
}
}
@ThreadSafe
private static final class DifferentRealPathDirectoryListingValue extends DirectoryListingValue {
private final RootedPath realDirRootedPath;
private final DirectoryListingStateValue directoryListingStateValue;
private DifferentRealPathDirectoryListingValue(RootedPath realDirRootedPath,
DirectoryListingStateValue directoryListingStateValue) {
this.realDirRootedPath = realDirRootedPath;
this.directoryListingStateValue = directoryListingStateValue;
}
@Override
public Iterable<Dirent> getDirents() {
return directoryListingStateValue.getDirents();
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (!(obj instanceof DifferentRealPathDirectoryListingValue)) {
return false;
}
DifferentRealPathDirectoryListingValue other = (DifferentRealPathDirectoryListingValue) obj;
return realDirRootedPath.equals(other.realDirRootedPath)
&& directoryListingStateValue.equals(other.directoryListingStateValue);
}
@Override
public int hashCode() {
return Objects.hash(realDirRootedPath, directoryListingStateValue);
}
}
}
|
