aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools/build/lib/skyframe/PerBuildSyscallCache.java
blob: b1265b4c96102f179c1be6663ed12cf91e1119e6 (plain)
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
// 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.cache.CacheBuilder;
import com.google.common.cache.CacheLoader;
import com.google.common.cache.LoadingCache;
import com.google.devtools.build.lib.util.Pair;
import com.google.devtools.build.lib.vfs.Dirent;
import com.google.devtools.build.lib.vfs.FileStatus;
import com.google.devtools.build.lib.vfs.Path;
import com.google.devtools.build.lib.vfs.Symlinks;
import com.google.devtools.build.lib.vfs.UnixGlob;

import java.io.IOException;
import java.util.Collection;

/**
 * A per-build cache of filesystem operations for Skyframe invocations of legacy package loading.
 */
public class PerBuildSyscallCache implements UnixGlob.FilesystemCalls {

  private final LoadingCache<Pair<Path, Symlinks>, FileStatus> statCache;
  private final LoadingCache<Pair<Path, Symlinks>, Pair<Collection<Dirent>, IOException>>
      readdirCache;

  private static final FileStatus NO_STATUS = new FakeFileStatus();

  /**
   * Create a new per-build filesystem cache.
   *
   * @param maxStats Max stat results to keep in cache, or -1 for unbounded.
   * @param maxReaddirs Max readdir results to keep in cache, or -1 for unbounded.
   */
  public PerBuildSyscallCache(int maxStats, int maxReaddirs) {
    statCache = newStatMap(maxStats);
    readdirCache = newReaddirMap(maxReaddirs);
  }

  public static PerBuildSyscallCache newUnboundedCache() {
    return new PerBuildSyscallCache(-1, -1);
  }

  @Override
  public Collection<Dirent> readdir(Path path, Symlinks symlinks) throws IOException {
    Pair<Collection<Dirent>, IOException> result =
        readdirCache.getUnchecked(Pair.of(path, symlinks));
    Collection<Dirent> entries = result.getFirst();
    if (entries != null) {
      return entries;
    }
    throw result.getSecond();
  }

  @Override
  public FileStatus statNullable(Path path, Symlinks symlinks) {
    FileStatus status = statCache.getUnchecked(Pair.of(path, symlinks));
    return (status == NO_STATUS) ? null : status;
  }

  // This is used because the cache implementations don't allow null.
  private static final class FakeFileStatus implements FileStatus {
    @Override
    public long getLastChangeTime() {
      throw new UnsupportedOperationException();
    }

    @Override
    public long getNodeId() {
      throw new UnsupportedOperationException();
    }

    @Override
    public long getLastModifiedTime() {
      throw new UnsupportedOperationException();
    }

    @Override
    public long getSize() {
      throw new UnsupportedOperationException();
    }

    @Override
    public boolean isDirectory() {
      throw new UnsupportedOperationException();
    }

    @Override
    public boolean isFile() {
      throw new UnsupportedOperationException();
    }

    @Override
    public boolean isSymbolicLink() {
      throw new UnsupportedOperationException();
    }
  }

  /**
   * A cache of stat calls.
   * Input: (path, following_symlinks)
   * Output: FileStatus
   */
  private static LoadingCache<Pair<Path, Symlinks>, FileStatus> newStatMap(int maxStats) {
    return builderWithOptionalMax(maxStats).build(
        new CacheLoader<Pair<Path, Symlinks>, FileStatus>() {
          @Override
          public FileStatus load(Pair<Path, Symlinks> p) {
            FileStatus f = p.first.statNullable(p.second);
            return (f == null) ? NO_STATUS : f;
          }
        });
  }

  /**
   * A cache of readdir calls.
   * Input: (path, following_symlinks)
   * Output: A union of (Dirents, IOException).
   */
  private static
  LoadingCache<Pair<Path, Symlinks>, Pair<Collection<Dirent>, IOException>> newReaddirMap(
      int maxReaddirs) {
    return builderWithOptionalMax(maxReaddirs).build(
        new CacheLoader<Pair<Path, Symlinks>, Pair<Collection<Dirent>, IOException>>() {
          @Override
          public Pair<Collection<Dirent>, IOException> load(Pair<Path, Symlinks> p) {
            try {
              // TODO(bazel-team): Consider storing the Collection of Dirent values more compactly
              // by reusing DirectoryEntryListingStateValue#CompactSortedDirents.
              return Pair.of(p.first.readdir(p.second), null);
            } catch (IOException e) {
              return Pair.of(null, e);
            }
          }
        });
  }

  private static CacheBuilder<Object, Object> builderWithOptionalMax(int maxEntries) {
    CacheBuilder<Object, Object> builder = CacheBuilder.newBuilder();
    if (maxEntries >= 0) {
      builder = builder.maximumSize(maxEntries);
    }
    return builder;
  }
}